scasm 0.0.1 → 0.1.0

data/README.md

@@ -18,10 +18,14 @@ Installation
 Example
 -------
 
-    foo = A
-    bar = B
-    offset = 42
-    add [foo, offset], bar
+````ruby
+foo = A
+bar = B
+offset = 42
+label "loop"
+add [foo, offset], bar
+set pc, "loop"
+````
 
 See the examples directory for more sample code.
 
@@ -32,6 +36,32 @@ SCASM input is Ruby code, but you won't need a deep understanding of Ruby to
 get started. Simple statements like `add A, 1` work just like you expect. This
 section will cover the SCASM-specific syntax.
 
+### Instructions
+
+To emit an instruction just write its lower-case name followed by the values:
+
+````ruby
+add A, 1
+jsr X
+````
+
+The one exception is the `and` instruction, which must be written as `and_`
+because `and` is a reserved word in Ruby.
+
+### Pseudoinstructions
+
+* `jmp label` - Equivalent to `set pc, label`.
+* `ret` - Equivalent to `set pc, pop`.
+
+To make your own pseudoinstructions/macros just define a Ruby method. For
+example, here's how `jmp` is implemented:
+
+````ruby
+def jmp label
+  set pc, label
+end
+````
+
 ### Registers
 
 Ruby variables named `A`, `B`, `C`, `X`, `Y`, `Z`, `I`, and `J` are provided to refer to the
@@ -52,6 +82,25 @@ Examples:
 
 Literal values are just given as integers. Example: `42` or `0x200`.
 
+### Labels
+
+Labels are defined by the `label` statement. To refer to a label, just use its name. For example:
+
+````ruby
+label "loop"
+add A, 1
+set pc, "loop"
+````
+
+### Data
+
+Use the `data` statement to put arbitrary words into the binary.
+
+````ruby
+label "sin_lookup_table"
+data 0, 0x38f6, 0x6f12, 0x9f9c, 0xc825, 0xe6a4, 0xf993, 0xffff
+````
+
 ### Miscellaneous
 
 These values have the same meaning as in the spec:

data/lib/scasm/assembler.rb

@@ -82,6 +82,10 @@ class Assembler < BasicObject
     ImmediateLabel.new(name).tap { |x| @relocations << x }
   end
 
+  def data *words
+    @stmts << Data.new(words)
+  end
+
   # Add a method for each instruction
   BASIC_OPCODES.each do |opsym,opcode|
     define_method(opsym) { |a,b| inst opsym, a, b }
@@ -96,6 +100,16 @@ class Assembler < BasicObject
     const_set regsym, regsym
   end
 
+  ## Pseudoinstructions
+
+  def jmp label
+    set pc, label
+  end
+
+  def ret
+    set pc, pop
+  end
+
 private
   
   def resolve_labels

data/lib/scasm/statement.rb

@@ -53,6 +53,17 @@ class Instruction < Statement
 end
 
 class Data < Statement
+  def initialize words
+    @words = words
+  end
+
+  def assemble io
+    io.write @words.pack('v*')
+  end
+
+  def to_s
+    "data #{@words * ', '}"
+  end
 end
 
 class Label < Statement

data/lib/scasm/version.rb

@@ -1,3 +1,3 @@
 module Scasm
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/test_assembler.rb

@@ -130,4 +130,30 @@ class AssemblerTest < Test::Unit::TestCase
     expect [0x7c10, 0x0020]
     check 'jsr 32'
   end
+
+  def test_data
+    expect [1, 2, 3, 4, 65535]
+    check 'data 1, 2, 3, 4, 65535'
+  end
+
+  def test_jmp
+    expect [
+      0x7dc1, 0x0000,
+    ]
+
+    check <<-EOS
+      label 'loop'
+      jmp 'loop'
+    EOS
+  end
+
+  def test_ret
+    expect [
+      0x61c1
+    ]
+
+    check <<-EOS
+      ret
+    EOS
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scasm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &15992680 !ruby/object:Gem::Requirement
+  requirement: &8467060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15992680
+  version_requirements: *8467060
 description: ''
 email:
 - rlane@club.cc.cmu.edu