ruby-yasm 0.1.0 → 0.3.0

data/Manifest.txt

@@ -1,17 +0,0 @@
-History.rdoc
-Manifest.txt
-README.rdoc
-Rakefile
-lib/yasm.rb
-lib/yasm/task.rb
-lib/yasm/program.rb
-lib/yasm/yasm.rb
-lib/yasm/version.rb
-tasks/spec.rb
-tasks/yard.rb
-spec/spec_helper.rb
-spec/helpers/files.rb
-spec/helpers/files/gas.S
-spec/task_spec.rb
-spec/program_spec.rb
-spec/yasm_spec.rb

data/README.rdoc

@@ -1,85 +0,0 @@
-= ruby-yasm
-
-* http://www.tortall.net/projects/yasm/
-* http://www.sophsec.com/
-* Postmodern (postmodern.mod3 at gmail.com)
-
-== DESCRIPTION:
-
-A Ruby interface to YASM.
-
-YASM is a complete rewrite of the NASM assembler, YASM currently supports
-the x86 and AMD64 instruction sets, accepts NASM and GAS assembler syntaxes,
-outputs binary, ELF32, ELF64, 32 and 64-bit Mach-O, RDOFF2, COFF, Win32,
-and Win64 object formats, and generates source debugging information in
-STABS, DWARF 2, and CodeView 8 formats.
-
-== FEATURES:
-
-* Supports all of the +yasm+ command-line options.
-
-== EXAMPLES:
-
-* Assemble a binary file:
-
-    YASM::Program.assemble do |yasm|
-      yasm.syntax = :gas
-      yasm.file = 'hello_world.S'
-      yasm.output = 'hello_world.o'
-    end
-
-* Assemble a binary file, and write the output to a temporary file:
-
-    YASM::Program.assemble_temp do |yasm|
-      yasm.syntax = :gas
-      yasm.file = 'hello_world.S'
-    end
-    # => "/tmp/yasm.3386.0"
-
-* Assemble amd64 assembly, in GAS syntax, into an ELF64 file with
-  debugging information:
-
-    YASM::Program.assemble do |yasm|
-      yasm.target! :amd64
-
-      yasm.syntax = :gas
-      yasm.file = 'hello_world.S'
-
-      yasm.output = 'hello_world.o'
-      yasm.output_format = :elf64
-      yasm.debug_format = :stabs
-    end
-
-== REQUIREMENTS:
-
-* {yasm}[http://www.tortall.net/projects/yasm/] >= 0.8.0.
-* {rprogram}[http://rprogram.rubyforge.org/] >= 0.1.8.
-
-== INSTALL:
-
-  $ sudo gem install ruby-yasm
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 Hal Brodigan
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-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 OR COPYRIGHT HOLDERS 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.

data/lib/yasm/task.rb

@@ -1,161 +0,0 @@
-require 'yasm/yasm'
-
-require 'rprogram/task'
-
-module YASM
-  #
-  # == YASM options:
-  #
-  # <tt>--version</tt>:: <tt>yasm.version</tt>
-  # <tt>--license</tt>:: <tt>yasm.license</tt>
-  # <tt>--help</tt>:: <tt>yasm.help</tt>
-  #
-  # <tt>--arch</tt>:: <tt>yasm.arch</tt>
-  # <tt>--parser</tt>:: <tt>yasm.parser</tt>
-  # <tt>--preproc</tt>:: <tt>yasm.preprocessor</tt>
-  # <tt>--oformat</tt>:: <tt>yasm.output_format</tt>
-  # <tt>--dformat</tt>:: <tt>yasm.debug_format</tt>
-  # <tt>--lformat</tt>:: <tt>yasm.list_format</tt>
-  #
-  # <tt>--list</tt>:: <tt>yasm.list_file</tt>
-  # <tt>--objfile</tt>:: <tt>yasm.output</tt>
-  # <tt>--mapfile</tt>:: <tt>yasm.map_file</tt>
-  #
-  # <tt>--machine</tt>:: <tt>yasm.machine</tt>
-  # <tt>--force-strict</tt>:: <tt>yasm.force_strict</tt>
-  # <tt>-w</tt>:: <tt>yasm.inhibit_warnings</tt>
-  # <tt>-W</tt>:: <tt>yasm.toggle_warnings</tt>
-  # <tt>-M</tt>:: <tt>yasm.gen_makefile_deps</tt>
-  # <tt>-E</tt>:: <tt>yasm.redirect_errors_to</tt>
-  # <tt>-e</tt>:: <tt>yasm.redirect_errors</tt>
-  # <tt>--preproc-only</tt>:: <tt>yasm.preprocessor_only</tt>
-  # <tt>-I</tt>:: <tt>yasm.include</tt>
-  # <tt>-P</tt>:: <tt>yasm.pre_include</tt>
-  # <tt>-D</tt>:: <tt>yasm.define</tt>
-  # <tt>-U</tt>:: <tt>yasm.undefine</tt>
-  # <tt>-X</tt>:: <tt>yasm.message_style</tt>
-  # <tt>--prefix</tt>:: <tt>yasm.prefix</tt>
-  # <tt>--suffix</tt>:: <tt>yasm.suffix</tt>
-  #
-  # <tt>file</tt>:: <tt>yasm.file</tt>
-  #
-  class Task < RProgram::Task
-
-    # The known YASM targets
-    TARGETS = {
-      :x86 => {:arch => :x86, :machine => :x86},
-      :amd64 => {:arch => :x86, :machine => :amd64},
-      :lc3b => {:arch => :lc3b, :machine => :lc3b}
-    }
-
-    long_option :flag => '--version'
-    long_option :flag => '--license'
-    long_option :flag => '--help'
-
-    long_option :flag => '--arch', :equals => true
-    long_option :flag => '--parser', :equals => true
-    long_option :flag => '--preproc',
-                :equals => true,
-                :name => :preprocessor
-    long_option :flag => '--oformat',
-                :equals => true,
-                :name => :output_format
-    long_option :flag => '--dformat',
-                :equals => true,
-                :name => :debug_format
-    long_option :flag => '--lformat',
-                :equals => true,
-                :name => :list_format
-
-    long_option :flag => '--list',
-                :equals => true,
-                :name => :list_file
-    long_option :flag => '--objfile',
-                :equals => true,
-                :name => :output
-    long_option :flag => '--mapfile',
-                :equals => true,
-                :name => :map_file
-
-    long_option :flag => '--machine', :equals => true
-    long_option :flag => '--force-strict'
-    short_option :flag => '-w', :name => :inhibit_warnings
-    short_option :flag => '-W', :name => :toggle_warnings
-    short_option :flag => '-M', :name => :gen_makefile_deps
-    short_option :flag => '-E', :name => :redirect_errors_to
-    short_option :flag => '-s', :name => :redirect_errors
-    long_option :flag => '--preproc-only', :name => :preprocessor_only
-    short_option :flag => '-I', :name => :include, :multiple => true
-    short_option :flag => '-P', :name => :pre_include, :multiple => true
-    short_option :flag => '-D', :name => :define, :multiple => true
-    short_option :flag => '-U', :name => :undefine, :multiple => true
-    short_option :flag => '-X', :name => :message_style
-    long_option :flag => '--prefix'
-    long_option :flag => '--suffix'
-
-    non_option :tailing => true, :name => :file
-
-    #
-    # Creates a new Task object.
-    #
-    # @param [Hash{Symbol => Object}] options
-    #   Additional options for the task.
-    #
-    # @option options [String, Symbol] :target
-    #   The arch/machine to target.
-    #
-    # @yield [task]
-    #   If a block is given, it will be passed the newly created task
-    #   object.
-    #
-    # @yieldparam [Task] task
-    #   The new task object.
-    #
-    # @see Task#target!
-    #
-    def initialize(options={},&block)
-      target = options.delete(:target)
-
-      super(options,&block)
-
-      self.target!(target) if target
-
-      self.parser ||= YASM.parser
-      self.arch ||= YASM.arch
-      self.machine ||= YASM.machine
-      self.debug_format ||= YASM.debug_format
-      self.output_format ||= YASM.output_format
-    end
-
-    #
-    # Sets the YASM +arch+ and +machine+.
-    #
-    # @param [String, Symbol] name
-    #   The target name.
-    #
-    # @raise [RuntimeError]
-    #   The specified target is unknown.
-    #
-    # @return [true]
-    #   The YASM +arch+ and +machine+ options were set successfully.
-    #
-    # @example
-    #   yasm.target! :amd64
-    #
-    def target!(name)
-      target = TARGETS[name.to_sym]
-
-      unless target
-        raise(RuntimeError,"unknown YASM target #{name.inspect}",caller)
-      end
-
-      self.arch = target[:arch]
-      self.machine = target[:machine]
-      return true
-    end
-
-    alias syntax parser
-    alias syntax= parser=
-
-  end
-end

data/lib/yasm/yasm.rb

@@ -1,142 +0,0 @@
-module YASM
-  @@yasm_parser = nil
-  @@yasm_arch = nil
-  @@yasm_machine = nil
-  @@yasm_debug_format = nil
-  @@yasm_output_format = nil
-
-  #
-  # The default YASM parser to use.
-  #
-  # @return [Symbol]
-  #   The YASM parser.
-  #
-  def YASM.parser
-    @@yasm_parser
-  end
-
-  #
-  # Sets the default YASM parser to use.
-  #
-  # @param [Symbol, String] new_parser
-  #   The new YASM parser to use.
-  #
-  # @return [Symbol]
-  #   The new YASM parser to use.
-  #
-  def YASM.parser=(new_parser)
-    @@yasm_parser = if new_parser.nil?
-                      nil
-                    else
-                      new_parser.to_sym
-                    end
-  end
-
-  #
-  # The default YASM architecture to assemble for.
-  #
-  # @return [Symbol]
-  #   The YASM architecture.
-  #
-  def YASM.arch
-    @@yasm_arch
-  end
-
-  #
-  # Sets the default YASM architecture to assemble for.
-  #
-  # @param [Symbol, String] new_arch
-  #   The new YASM architecture to assemble for.
-  #
-  # @return [Symbol]
-  #   The new YASM architecture to assemble for.
-  #
-  def YASM.arch=(new_arch)
-    if new_arch.nil?
-      @@yasm_arch = nil
-    else
-      @@yasm_arch = new_arch.to_sym
-    end
-  end
-
-  #
-  # The default YASM machine to assemble for.
-  #
-  # @return [Symbol]
-  #   The YASM machine.
-  #
-  def YASM.machine
-    @@yasm_machine ||= nil
-  end
-
-  #
-  # Sets the default YASM machine to assemble for.
-  #
-  # @param [Symbol, String] new_machine
-  #   The new YASM machine to assemble for.
-  #
-  # @return [Symbol]
-  #   The new YASM machine to assemble for.
-  #
-  def YASM.machine=(new_machine)
-    @@yasm_machine = if new_machine.nil?
-                       nil
-                     else
-                       new_machine.to_sym
-                     end
-  end
-
-  #
-  # The default YASM debugging format to use.
-  #
-  # @return [Symbol]
-  #   The YASM debugging format.
-  #
-  def YASM.debug_format
-    @@yasm_debug_format
-  end
-
-  #
-  # Sets the default YASM debugging format to use.
-  #
-  # @param [Symbol, String] new_format
-  #   The new YASM debugging format to use.
-  #
-  # @return [Symbol]
-  #   The new YASM debugging format to use.
-  #
-  def YASM.debug_format=(new_format)
-    @@yasm_debug_format = if new_format.nil?
-                            nil
-                          else
-                            new_format.to_sym
-                          end
-  end
-
-  #
-  # The default YASM output format to use.
-  #
-  # @return [Symbol]
-  #   The YASM output format.
-  #
-  def YASM.output_format
-    @@yasm_output_format
-  end
-
-  #
-  # Sets the default YASM output format to use.
-  #
-  # @param [Symbol, String] new_format
-  #   The new YASM output format to use.
-  #
-  # @return [Symbol]
-  #   The new YASM output format to use.
-  #
-  def YASM.output_format=(new_format)
-    @@yasm_output_format = if new_format.nil?
-                             nil
-                           else
-                             new_format.to_sym
-                           end
-  end
-end

data/spec/task_spec.rb

@@ -1,182 +0,0 @@
-require 'yasm/task'
-
-require 'spec_helper'
-
-describe Task do
-  it "should support a :target option" do
-    task = Task.new(:target => :amd64)
-
-    task.arch.should == :x86
-    task.machine.should == :amd64
-  end
-
-  describe "default" do
-    describe "parser" do
-      before(:all) do
-        @old_parser = YASM.parser
-
-        YASM.parser = :tasm
-      end
-
-      it "should have a default parser value" do
-        task = Task.new
-        task.parser.should == :tasm
-      end
-
-      it "should allow overriding the default parser" do
-        task = Task.new(:parser => :gas)
-        task.parser.should == :gas
-      end
-
-      after(:all) do
-        YASM.parser = @old_parser
-      end
-    end
-
-    describe "arch" do
-      before(:all) do
-        @old_arch = YASM.arch
-
-        YASM.arch = :lc3b
-      end
-
-      it "should have a default arch value" do
-        task = Task.new
-        task.arch.should == :lc3b
-      end
-
-      it "should allow overriding the default arch" do
-        task = Task.new(:arch => :x86)
-        task.arch.should == :x86
-      end
-
-      after(:all) do
-        YASM.arch = @old_arch
-      end
-    end
-
-    describe "machine" do
-      before(:all) do
-        @old_machine = YASM.machine
-
-        YASM.machine = :amd64
-      end
-
-      it "should have a default machine value" do
-        task = Task.new
-        task.machine.should == :amd64
-      end
-
-      it "should allow overriding the default machine" do
-        task = Task.new(:machine => :x86)
-        task.machine.should == :x86
-      end
-
-      after(:all) do
-        YASM.machine = @old_machine
-      end
-    end
-
-    describe "debug_format" do
-      before(:all) do
-        @old_debug_format = YASM.debug_format
-
-        YASM.debug_format = :stabs
-      end
-
-      it "should have a default debug_format value" do
-        task = Task.new
-        task.debug_format.should == :stabs
-      end
-
-      it "should allow overriding the default debug_format" do
-        task = Task.new(:debug_format => :null)
-        task.debug_format.should == :null
-      end
-
-      after(:all) do
-        YASM.debug_format = @old_debug_format
-      end
-    end
-
-    describe "output_format" do
-      before(:all) do
-        @old_output_format = YASM.output_format
-
-        YASM.output_format = :elf64
-      end
-
-      it "should have a default output_format value" do
-        task = Task.new
-        task.output_format.should == :elf64
-      end
-
-      it "should allow overriding the default output_format" do
-        task = Task.new(:output_format => :bin)
-        task.output_format.should == :bin
-      end
-
-      after(:all) do
-        YASM.output_format = @old_output_format
-      end
-    end
-  end
-
-  describe "target!" do
-    it "should return true for valid targets" do
-      task = Task.new
-
-      task.target!(:amd64).should == true
-    end
-
-    it "should raise RuntimeError when passed unknown targets" do
-      task = Task.new
-
-      lambda {
-        task.target! :lol
-      }.should raise_error(RuntimeError)
-    end
-
-    describe "x86" do
-      before(:all) do
-        @task = Task.new { |task| task.target! :x86 }
-      end
-
-      it "should set the arch value" do
-        @task.arch.should == :x86
-      end
-
-      it "should set the machine value" do
-        @task.machine.should == :x86
-      end
-    end
-
-    describe "amd64" do
-      before(:all) do
-        @task = Task.new { |task| task.target! :amd64 }
-      end
-
-      it "should set the arch value" do
-        @task.arch.should == :x86
-      end
-
-      it "should set the machine value" do
-        @task.machine.should == :amd64
-      end
-    end
-
-    describe "lc3b" do
-      before(:all) do
-        @task = Task.new { |task| task.target! :lc3b }
-      end
-
-      it "should set the arch value" do
-        @task.arch.should == :lc3b
-      end
-
-      it "should set the machine value" do
-        @task.machine.should == :lc3b
-      end
-    end
-  end
-end

data/tasks/spec.rb

@@ -1,10 +0,0 @@
-require 'spec/rake/spectask'
-
-desc "Run all specifications"
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.libs += ['lib', 'spec']
-  t.spec_opts = ['--colour', '--format', 'specdoc']
-end
-
-task :test => :spec
-task :default => :spec

data/tasks/yard.rb

@@ -1,13 +0,0 @@
-require 'yard'
-
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
-  t.options = [
-    '--protected',
-    '--files', 'History.rdoc',
-    '--title', 'Ruby YASM',
-    '--quiet'
-  ]
-end
-
-task :docs => :yard