remian 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+log/
+tmp/
+.sass-cache/
+.DS_Store

data/AUTHORS.md

@@ -0,0 +1,2 @@
+# Authors
+* [Michael Mokrysz](https://46bit.com)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spotigit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    remian (0.1.0)
+      term-ansicolor (~> 1.0.7)
+      thor (~> 0.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    term-ansicolor (1.0.7)
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  remian!

data/LICENSE.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to http://unlicense.org.

data/README.md

@@ -0,0 +1,5 @@
+# Remian
+A baby virtual machine built in Ruby. Designed to a Von Neumann architecture and a RISC mindset.
+
+## Why the name?
+I decided to build Remian just after waking up, so it seemed apt to name it after a phase of sleeping. I picked [REM](http://en.wikipedia.org/wiki/Rapid_eye_movement_sleep) because `Non-REMian` or `Phase 3ian` would be a terrible name.

data/bin/remian

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "remian"
+
+module Remian
+  class Thorian < Thor
+    desc "execute FILEPATH", "Runs given .rem file."
+
+    method_option :clock_speed, default: 30, aliases: "-c", desc: "Machine clock speed in Hz (default 50)."
+    method_option :memory_size, default: 1024, aliases: "-m", desc: "Size of machine memory (default 1024)."
+
+    def execute filepath
+      if File.exist? filepath
+        data = File.read filepath
+      else
+        Remian.say "Provided file #{filepath} does not exist."
+        exit
+      end
+
+      control = Remian::Control.new data, {clock_speed: options[:clock_speed].to_i, memory_size: options[:memory_size].to_i}
+      control.start
+    end
+  end
+
+  Remian::Thorian.start
+end
+class ThorExample < Thor
+  desc "start", "start server"
+  method_option :environment,:default => "development", :aliases => "-e",
+:desc => "which environment you want server run."
+  method_option :daemon, :type => :boolean, :default => false, :aliases => "-d",
+:desc => "running on daemon mode?"
+  def start
+    puts "start #{options.inspect}"
+  end
+
+  desc "stop" ,"stop server"
+  method_option :delay,  :default => 0, :aliases => "-w",
+:desc => "wait server finish it's job"
+  def stop
+    puts "stop"
+  end
+end

data/lib/remian.rb

@@ -0,0 +1,12 @@
+require "term/ansicolor"
+require "./lib/remian/control"
+
+module Remian
+  def self.say message, colour_hash
+    unless colour_hash.nil? || !Term::ANSIColor.respond_to?(colour_hash)
+      extend Term::ANSIColor
+      message = Term::ANSIColor.method(colour_hash.to_s).call(message)
+    end
+    puts message
+  end
+end

data/lib/remian/clock.rb

@@ -0,0 +1,14 @@
+module Remian
+  class Clock
+    attr_accessor :speed, :delay
+
+    def initialize speed
+      @speed = speed.to_f
+      @delay = 1.0 / @speed
+    end
+
+    def tick_delay
+      sleep @delay
+    end
+  end
+end

data/lib/remian/control.rb

@@ -0,0 +1,59 @@
+# load initial instructions + data
+# run initial instruction
+# handle instruction register changes
+# fetch + execute instruction register memory location
+
+require "remian/clock"
+require "remian/memory"
+require "remian/decoder"
+require "remian/instruction_set"
+
+module Remian
+  class Control
+    attr_accessor :options
+    attr_accessor :clock
+    attr_accessor :memory
+    attr_accessor :decoder
+    attr_accessor :registers
+    attr_accessor :instruction_set
+
+    def initialize data, options = {}
+      @options = option_defaults.merge options
+
+      @registers = {address: nil}
+      @clock = Clock.new @options[:clock_speed]
+      @decoder = Decoder.new
+
+      @memory = Memory.new @options[:memory_size]
+      @memory.write_data data
+
+      @instruction_set = InstructionSet.new @memory, @registers
+    end
+
+    def start start_address = 1
+      @registers[:address] = start_address
+
+      while @clock.tick_delay
+        cycle
+      end
+    end
+
+    protected
+      def option_defaults
+        {clock_speed: 30, memory_size: 1024}
+      end
+
+      def cycle
+        address_contents = @memory.read @registers[:address]
+        @registers[:address] = @registers[:address] + 1
+
+        instruction = @decoder.parse address_contents
+        if not instruction[:opcode].nil? and @instruction_set.respond_to? instruction[:opcode]
+          Remian.say "> #{address_contents}", :green
+          @instruction_set.send(instruction[:opcode], instruction[:data])
+        else
+          Remian.say "Instruction '#{instruction[:opcode]}' is not defined.", :red
+        end
+      end
+  end
+end

data/lib/remian/decoder.rb

@@ -0,0 +1,10 @@
+class Decoder
+  def parse instruction
+    components = instruction.to_s.split " "
+
+    return {
+      opcode: components.shift,
+      data: components
+    }
+  end
+end

data/lib/remian/instruction_set.rb

@@ -0,0 +1,27 @@
+# These solve problems with Ruby boolean types vs 1/0 integer booleans
+class TrueClass
+  def to_i
+    1
+  end
+end
+class FalseClass
+  def to_i
+    0
+  end
+end
+
+module Remian
+  class InstructionSet
+    attr_accessor :memory
+    attr_accessor :registers
+
+    def initialize memory, registers
+      @memory = memory
+      @registers = registers
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/instruction_set/*.rb"].each do |file|
+  require "#{file[0..-4]}"
+end

data/lib/remian/instruction_set/add_i.rb

@@ -0,0 +1,9 @@
+module Remian
+  class InstructionSet
+    def add_i addresses
+      operands = addresses.map {|address| @memory.read(address.to_i).to_i}
+      sum = operands.inject :+
+      @memory.write addresses[0].to_i, sum
+    end
+  end
+end

data/lib/remian/instruction_set/and.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def and addresses
+      operands = addresses.map {|address| @memory.read(address.to_i).to_i}
+      @memory.write(addresses[0].to_i, operands.inject(:*))
+    end
+  end
+end

data/lib/remian/instruction_set/branch.rb

@@ -0,0 +1,11 @@
+module Remian
+  class InstructionSet
+    def branch addresses
+      if @memory.read(addresses[0].to_i).to_i != 0
+        destination = @memory.read(addresses[1].to_i).to_i
+        Remian.say "Branching to address #{destination}.", :magenta
+        @registers[:address] = destination
+      end
+    end
+  end
+end

data/lib/remian/instruction_set/cp.rb

@@ -0,0 +1,7 @@
+module Remian
+  class InstructionSet
+    def cp addresses
+      @memory.write(addresses[1].to_i, @memory.read(addresses[0].to_i))
+    end
+  end
+end

data/lib/remian/instruction_set/exit.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def exit addresses
+      Remian.say "Told to exit.", :magenta
+      Process.exit
+    end
+  end
+end

data/lib/remian/instruction_set/jump.rb

@@ -0,0 +1,9 @@
+module Remian
+  class InstructionSet
+    def jump addresses
+      destination = @memory.read(addresses[0].to_i).to_i
+      Remian.say "Jumping to address #{destination}.", :magenta
+      @registers[:address] = destination
+    end
+  end
+end

data/lib/remian/instruction_set/mv.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def mv addresses
+      @memory.write(addresses[1].to_i, @memory.read(addresses[0].to_i))
+      @memory.write(addresses[0].to_i, "")
+    end
+  end
+end

data/lib/remian/instruction_set/not.rb

@@ -0,0 +1,7 @@
+module Remian
+  class InstructionSet
+    def not addresses
+      @memory.write(addresses[0].to_i, @memory.read(addresses[0].to_i) == 0)
+    end
+  end
+end

data/lib/remian/instruction_set/or.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def or addresses
+      operands = addresses.map {|address| @memory.read(address.to_i).to_i}
+      @memory.write(addresses[0].to_i, operands.inject(:+) != 0)
+    end
+  end
+end

data/lib/remian/instruction_set/put.rb

@@ -0,0 +1,7 @@
+module Remian
+  class InstructionSet
+    def put data
+      puts data
+    end
+  end
+end

data/lib/remian/instruction_set/put_a.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def put_a addresses
+      operands = addresses.map {|address| @memory.read(address.to_i)}
+      puts operands
+    end
+  end
+end

data/lib/remian/instruction_set/set.rb

@@ -0,0 +1,7 @@
+module Remian
+  class InstructionSet
+    def set addresses
+      @memory.write(operand[0], operand[1])
+    end
+  end
+end

data/lib/remian/instruction_set/zero.rb

@@ -0,0 +1,8 @@
+module Remian
+  class InstructionSet
+    def zero addresses
+      operands = addresses.map {|address| @memory.read(address.to_i).to_i}
+      @memory.write(addresses[0].to_i, operands[0].to_i == 0)
+    end
+  end
+end

data/lib/remian/memory.rb

@@ -0,0 +1,35 @@
+# Addresses start at 1, despite underlying 0-based array implementation
+# This makes assembly programming easier, since line numbers correspond to addresses.
+module Remian
+  class Memory
+    attr_accessor :store, :size
+
+    def initialize size
+      @size = size
+      @store = Array.new @size, ""
+    end
+
+    def read address
+      memory_key = convert_address_to_memory_key address
+      @store[memory_key]
+    end
+
+    def write address, value
+      memory_key = convert_address_to_memory_key address
+      if memory_key >= 0 && memory_key < @store.length
+        @store[memory_key] = value
+      end
+    end
+
+    def write_data data
+      data.split("\n").each_with_index do |instruction, i|
+        write i + 1, instruction
+      end
+    end
+
+    protected
+      def convert_address_to_memory_key address
+        address - 1
+      end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: remian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Mokrysz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+description: A baby virtual machine built in Ruby.
+email:
+- hi@46bit.com
+executables:
+- remian
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitkeep
+- AUTHORS.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- bin/.gitkeep
+- bin/remian
+- lib/.gitkeep
+- lib/remian.rb
+- lib/remian/.gitkeep
+- lib/remian/clock.rb
+- lib/remian/control.rb
+- lib/remian/decoder.rb
+- lib/remian/instruction_set.rb
+- lib/remian/instruction_set/add_i.rb
+- lib/remian/instruction_set/and.rb
+- lib/remian/instruction_set/branch.rb
+- lib/remian/instruction_set/cp.rb
+- lib/remian/instruction_set/exit.rb
+- lib/remian/instruction_set/jump.rb
+- lib/remian/instruction_set/mv.rb
+- lib/remian/instruction_set/not.rb
+- lib/remian/instruction_set/or.rb
+- lib/remian/instruction_set/put.rb
+- lib/remian/instruction_set/put_a.rb
+- lib/remian/instruction_set/set.rb
+- lib/remian/instruction_set/zero.rb
+- lib/remian/memory.rb
+homepage: https://github.com/46Bit/remian
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Remian is a small virtual machine, designed to a Von Neumann architecture
+  with a RISC mindset.
+test_files: []