koi-vm-ruby 0.0.4

data/.gitignore

@@ -0,0 +1,2 @@
+test.txt
+test.html

data/README.rdoc

@@ -0,0 +1,64 @@
+= koi-vm-ruby
+
+Koi-vm-ruby is a simple proof-of-concept Virtual Machine for the {Koi}[http://github.com/aarongough/koi] programming language written in Ruby. It was created with learning in mind and is written so that it is easy to understand and play with. This virtual machine implements an instruction set specifically designed for running the Koi programming language. A compiler for producing compatible bytecode can be found at the {koi-reference-compiler}[http://github.com/aarongough/koi-reference-compiler].
+
+=== Examples
+
+The standard 'Hello world!', KoiVM style:
+  
+  require 'koi'
+  include KoiVMRuby
+  
+  VM.new.run [
+    PUSH_STRING, "Hello World!\n",
+    PRINT
+  ]
+  
+  #=> Hello world!
+  
+And an old-school 'Blast off' example:
+
+  require 'koi'
+  include KoiVMRuby
+  
+  VM.new.run [
+    PUSH_INT, 11,
+    PUSH_INT, 1,
+    SUBTRACT,
+    DUP,
+    TO_STRING,
+    PRINT,
+    PUSH_STRING, ", ",
+    PRINT,
+    DUP,
+    PUSH_INT, 0,
+    EQUAL,
+    JUMP_UNLESS, -13,
+    PUSH_STRING, "Blast Off!\n",
+    PRINT
+  ]
+  
+  #=> 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0, Blast off!
+  
+=== Installation
+
+This VM is normally installed as part of Koi's default toolchain. However if you would like to install it on it's own you can do so by installing the gem like so:
+
+  gem install koi-vm-ruby
+  
+=== Usage
+
+  require 'rubygems'
+  require 'koi-vm-ruby'
+  
+  include KoiVMRuby
+  
+  vm = VM.new
+  
+  vm.run( bytecode )
+  
+=== Author & Credits
+
+Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
+
+Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "koi-vm-ruby"
+    gemspec.summary = "A Koi Virtual Machine written in Ruby"
+    gemspec.description = "A Virtual Machine for the Koi programming language written in Ruby."
+    gemspec.email = "aaron@aarongough.com"
+    gemspec.homepage = "http://github.com/aarongough/koi-vm-ruby"
+    gemspec.authors = ["Aaron Gough"]
+    gemspec.rdoc_options << '--line-numbers' << '--inline-source'
+    gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Test koi-vm-ruby.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib/*.rb'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+desc 'Generate documentation for koi-vm-ruby.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Koi'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/architecture.rdoc

@@ -0,0 +1,112 @@
+= Koi Architecture
+
+This document is a general overview of the Koi VM architecture. It is used internally as a design document and to keep track of what work still needs to be done.
+
+=== Datatypes
+
+* Integer
+* Float
+* String
+* Array (coming later)
+* Hash (coming later)
+
+=== Operations
+
+* Stack
+      PUSH_NIL
+      PUSH_BOOL   boolean
+      PUSH_INT    integer
+      PUSH_FLOAT  float
+      PUSH_STRING string
+      PUSH_ARRAY  array
+      PUSH_HASH   hash
+    x POP
+    x SWAP
+    x DUP
+    x TOP   number_of_stack_items
+
+* Variables
+    x SET_LOCAL   index
+    x GET_LOCAL   index
+    x SET_GLOBAL  index
+    x GET_GLOBAL  index
+    
+* Instruction Pointer
+    x ABS_JUMP
+    x REL_JUMP      destination_offset
+    x JUMP_IF       destination_offset
+    x JUMP_UNLESS   destination_offset
+
+* Integers / Floats
+    x ADD
+    x SUBTRACT
+    x MULTIPLY
+    x DIVIDE
+      MODULO
+    x INCREMENT
+    x DECREMENT
+      EQUAL
+      NOT_EQUAL
+      LESS_THAN
+      GREATER_THAN
+      EQUAL_LESS_THAN
+      EQUAL_GREATER_THAN
+    
+* Strings
+      CONCATENATE
+      LENGTH
+      
+* Arrays
+    x ARRAY_NEW
+    x ARRAY_GET_INDEX
+    x ARRAY_PUT_INDEX
+      ARRAY_PUSH
+      ARRAY_SIZE
+      ARRAY_INCLUDE
+      ARRAY_EXPLODE
+      
+* Hashes
+    x HASH_NEW
+    x HASH_GET_KEY
+    x HASH_PUT_KEY
+      HASH_SIZE
+      HASH_HAS_KEY
+      HASH_EXPLODE
+    
+* Socket I/O    
+      NEW_SOCKET_IO
+
+* File I/O
+    x FILE_OPEN
+    x FILE_PUT
+      FILE_GET
+      FILE_FLUSH
+      FILE_CLOSE
+      
+* Anonymous Functions
+      FUNCTION_PUSH
+      FUNCTION_END
+      FUNCTION_CALL
+      FUNCTION_RETURN
+    
+* Fibers
+    x FIBER_ID
+      FIBER_LENGTH
+    x FIBER_NEW
+    x FIBER_DELETE
+      FIBER_YIELD
+      
+* Misc
+      TYPE_OF
+    x TO_STRING
+    x EXIT
+         
+    
+
+=== Exceptions
+
+* StackError
+    Denotes that an error occurred when accessing items on the stack. The most likely cases are that there were not enough items on the stack for an opcode to work, or that the items were not of the correct type.
+    
+* OperandError
+    Denotes that an error occurred when reading an operand for an opcode. This may be because an operand was not supplied, or because it was not of the correct type.

data/examples/blastoff.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'koi.rb'))
+
+include KoiVMRuby
+
+VM.new.run [
+  PUSH_INT, 11,
+  PUSH_INT, 1,
+  SUBTRACT,
+  DUP,
+  TO_STRING,
+  PRINT,
+  PUSH_STRING, ", ",
+  PRINT,
+  DUP,
+  PUSH_INT, 0,
+  EQUAL,
+  JUMP_UNLESS, -13,
+  PUSH_STRING, "Blast Off!\n",
+  PRINT
+]

data/examples/hello_world.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'koi.rb'))
+
+include KoiVMRuby
+
+VM.new.run [
+  PUSH_STRING, "Hello World!\n",
+  PRINT
+]

data/koi-vm.gemspec

@@ -0,0 +1,198 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{koi-vm}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Gough"]
+  s.date = %q{2010-08-27}
+  s.description = %q{A prototype Virtual Machine written in Ruby. Why would anyone write such a thing? Because it's fun, and it's a great learning tool.}
+  s.email = %q{aaron@aarongough.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "architecture.rdoc",
+     "examples/blastoff.rb",
+     "examples/hello_world.rb",
+     "koi-vm.gemspec",
+     "lib/.gitkeep",
+     "lib/koi-vm.rb",
+     "lib/koi-vm/accessors.rb",
+     "lib/koi-vm/core.rb",
+     "lib/koi-vm/exceptions.rb",
+     "lib/koi-vm/helpers.rb",
+     "lib/koi-vm/opcodes/_opcode_constants.rb",
+     "lib/koi-vm/opcodes/_value_constants.rb",
+     "lib/koi-vm/opcodes/comparative_operations/equal.rb",
+     "lib/koi-vm/opcodes/comparative_operations/greater_than.rb",
+     "lib/koi-vm/opcodes/comparative_operations/invert.rb",
+     "lib/koi-vm/opcodes/comparative_operations/less_than.rb",
+     "lib/koi-vm/opcodes/control_operations/exit.rb",
+     "lib/koi-vm/opcodes/control_operations/no_op.rb",
+     "lib/koi-vm/opcodes/flow_control_operations/jump.rb",
+     "lib/koi-vm/opcodes/flow_control_operations/jump_if.rb",
+     "lib/koi-vm/opcodes/flow_control_operations/jump_unless.rb",
+     "lib/koi-vm/opcodes/function_operations/call.rb",
+     "lib/koi-vm/opcodes/function_operations/push_function.rb",
+     "lib/koi-vm/opcodes/function_operations/return.rb",
+     "lib/koi-vm/opcodes/function_operations/tailcall.rb",
+     "lib/koi-vm/opcodes/hash_operations/get_key.rb",
+     "lib/koi-vm/opcodes/hash_operations/has_key.rb",
+     "lib/koi-vm/opcodes/hash_operations/length.rb",
+     "lib/koi-vm/opcodes/hash_operations/num_pairs.rb",
+     "lib/koi-vm/opcodes/hash_operations/pairs.rb",
+     "lib/koi-vm/opcodes/hash_operations/push_hash.rb",
+     "lib/koi-vm/opcodes/hash_operations/set_key.rb",
+     "lib/koi-vm/opcodes/io_operations/gets.rb",
+     "lib/koi-vm/opcodes/io_operations/print.rb",
+     "lib/koi-vm/opcodes/math_operations/add.rb",
+     "lib/koi-vm/opcodes/math_operations/divide.rb",
+     "lib/koi-vm/opcodes/math_operations/multiply.rb",
+     "lib/koi-vm/opcodes/math_operations/subtract.rb",
+     "lib/koi-vm/opcodes/push_operations/push_bool.rb",
+     "lib/koi-vm/opcodes/push_operations/push_float.rb",
+     "lib/koi-vm/opcodes/push_operations/push_int.rb",
+     "lib/koi-vm/opcodes/push_operations/push_nil.rb",
+     "lib/koi-vm/opcodes/push_operations/push_string.rb",
+     "lib/koi-vm/opcodes/stack_operations/dup.rb",
+     "lib/koi-vm/opcodes/stack_operations/pop.rb",
+     "lib/koi-vm/opcodes/stack_operations/stksize.rb",
+     "lib/koi-vm/opcodes/stack_operations/swap.rb",
+     "lib/koi-vm/opcodes/stack_operations/top.rb",
+     "lib/koi-vm/opcodes/stack_operations/typeof.rb",
+     "lib/koi-vm/opcodes/string_operations/concat.rb",
+     "lib/koi-vm/opcodes/string_operations/strlen.rb",
+     "lib/koi-vm/opcodes/string_operations/to_string.rb",
+     "lib/koi-vm/opcodes/variable_operations/get_global.rb",
+     "lib/koi-vm/opcodes/variable_operations/get_local.rb",
+     "lib/koi-vm/opcodes/variable_operations/set_global.rb",
+     "lib/koi-vm/opcodes/variable_operations/set_local.rb",
+     "test/.gitkeep",
+     "test/performance/.gitignore",
+     "test/performance/simple_benchmark.rb",
+     "test/setup/test_unit_extensions.rb",
+     "test/test_helper.rb",
+     "test/unit/opcodes/comparative_operations/equal_test.rb",
+     "test/unit/opcodes/comparative_operations/greater_than_test.rb",
+     "test/unit/opcodes/comparative_operations/invert_test.rb",
+     "test/unit/opcodes/comparative_operations/less_than_test.rb",
+     "test/unit/opcodes/control_operations/exit_test.rb",
+     "test/unit/opcodes/control_operations/no_op_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_if_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_unless_test.rb",
+     "test/unit/opcodes/function_operations/call_test.rb",
+     "test/unit/opcodes/function_operations/push_function_test.rb",
+     "test/unit/opcodes/function_operations/return_test.rb",
+     "test/unit/opcodes/function_operations/tailcall_test.rb",
+     "test/unit/opcodes/hash_operations/get_key_test.rb",
+     "test/unit/opcodes/hash_operations/has_key_test.rb",
+     "test/unit/opcodes/hash_operations/length_test.rb",
+     "test/unit/opcodes/hash_operations/num_pairs_test.rb",
+     "test/unit/opcodes/hash_operations/pairs_test.rb",
+     "test/unit/opcodes/hash_operations/push_hash_test.rb",
+     "test/unit/opcodes/hash_operations/set_key_test.rb",
+     "test/unit/opcodes/io_operations/gets_test.rb",
+     "test/unit/opcodes/io_operations/print_test.rb",
+     "test/unit/opcodes/math_operations/add_test.rb",
+     "test/unit/opcodes/math_operations/divide_test.rb",
+     "test/unit/opcodes/math_operations/multiply_test.rb",
+     "test/unit/opcodes/math_operations/subtract_test.rb",
+     "test/unit/opcodes/push_operations/push_bool_test.rb",
+     "test/unit/opcodes/push_operations/push_float_test.rb",
+     "test/unit/opcodes/push_operations/push_int_test.rb",
+     "test/unit/opcodes/push_operations/push_nil_test.rb",
+     "test/unit/opcodes/push_operations/push_string_test.rb",
+     "test/unit/opcodes/stack_operations/dup_test.rb",
+     "test/unit/opcodes/stack_operations/pop_test.rb",
+     "test/unit/opcodes/stack_operations/stksize_test.rb",
+     "test/unit/opcodes/stack_operations/swap_test.rb",
+     "test/unit/opcodes/stack_operations/top_test.rb",
+     "test/unit/opcodes/stack_operations/typeof_test.rb",
+     "test/unit/opcodes/string_operations/concat_test.rb",
+     "test/unit/opcodes/string_operations/strlen_test.rb",
+     "test/unit/opcodes/string_operations/to_string_test.rb",
+     "test/unit/opcodes/variable_operations/get_global_test.rb",
+     "test/unit/opcodes/variable_operations/get_local_test.rb",
+     "test/unit/opcodes/variable_operations/set_global_test.rb",
+     "test/unit/opcodes/variable_operations/set_local_test.rb",
+     "test/unit/vm_initialization_test.rb"
+  ]
+  s.homepage = %q{https://github.com/aarongough/koi}
+  s.rdoc_options = ["--charset=UTF-8", "--line-numbers", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A prototype Virtual Machine written in Ruby}
+  s.test_files = [
+    "test/performance/simple_benchmark.rb",
+     "test/setup/test_unit_extensions.rb",
+     "test/test_helper.rb",
+     "test/unit/opcodes/comparative_operations/equal_test.rb",
+     "test/unit/opcodes/comparative_operations/greater_than_test.rb",
+     "test/unit/opcodes/comparative_operations/invert_test.rb",
+     "test/unit/opcodes/comparative_operations/less_than_test.rb",
+     "test/unit/opcodes/control_operations/exit_test.rb",
+     "test/unit/opcodes/control_operations/no_op_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_if_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_test.rb",
+     "test/unit/opcodes/flow_control_operations/jump_unless_test.rb",
+     "test/unit/opcodes/function_operations/call_test.rb",
+     "test/unit/opcodes/function_operations/push_function_test.rb",
+     "test/unit/opcodes/function_operations/return_test.rb",
+     "test/unit/opcodes/function_operations/tailcall_test.rb",
+     "test/unit/opcodes/hash_operations/get_key_test.rb",
+     "test/unit/opcodes/hash_operations/has_key_test.rb",
+     "test/unit/opcodes/hash_operations/length_test.rb",
+     "test/unit/opcodes/hash_operations/num_pairs_test.rb",
+     "test/unit/opcodes/hash_operations/pairs_test.rb",
+     "test/unit/opcodes/hash_operations/push_hash_test.rb",
+     "test/unit/opcodes/hash_operations/set_key_test.rb",
+     "test/unit/opcodes/io_operations/gets_test.rb",
+     "test/unit/opcodes/io_operations/print_test.rb",
+     "test/unit/opcodes/math_operations/add_test.rb",
+     "test/unit/opcodes/math_operations/divide_test.rb",
+     "test/unit/opcodes/math_operations/multiply_test.rb",
+     "test/unit/opcodes/math_operations/subtract_test.rb",
+     "test/unit/opcodes/push_operations/push_bool_test.rb",
+     "test/unit/opcodes/push_operations/push_float_test.rb",
+     "test/unit/opcodes/push_operations/push_int_test.rb",
+     "test/unit/opcodes/push_operations/push_nil_test.rb",
+     "test/unit/opcodes/push_operations/push_string_test.rb",
+     "test/unit/opcodes/stack_operations/dup_test.rb",
+     "test/unit/opcodes/stack_operations/pop_test.rb",
+     "test/unit/opcodes/stack_operations/stksize_test.rb",
+     "test/unit/opcodes/stack_operations/swap_test.rb",
+     "test/unit/opcodes/stack_operations/top_test.rb",
+     "test/unit/opcodes/stack_operations/typeof_test.rb",
+     "test/unit/opcodes/string_operations/concat_test.rb",
+     "test/unit/opcodes/string_operations/strlen_test.rb",
+     "test/unit/opcodes/string_operations/to_string_test.rb",
+     "test/unit/opcodes/variable_operations/get_global_test.rb",
+     "test/unit/opcodes/variable_operations/get_local_test.rb",
+     "test/unit/opcodes/variable_operations/set_global_test.rb",
+     "test/unit/opcodes/variable_operations/set_local_test.rb",
+     "test/unit/vm_initialization_test.rb",
+     "examples/blastoff.rb",
+     "examples/hello_world.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+