burn 0.1.0

data/lib/burn/cli.rb

@@ -0,0 +1,187 @@
+module Burn
+  class BurnTasks < Thor
+    include Thor::Actions
+    
+    def initialize(*args)
+      super
+      @workspace_root = Dir.getwd
+    end
+    
+    def self.source_root
+      File.dirname(__FILE__) + "/.."
+    end
+
+    default_task :make
+
+    desc "make <filename>", "Compile and build application binary from Burn DSL file"
+    option :preview, :type => :boolean, :aliases => '-p', :desc => "Preview .out application right after compilation"
+    option :debug, :type => :string, :aliases => '-d', :desc => "Debug mode"
+    option :verbose, :type => :boolean, :desc => "Print logs as much as possible", :default => false
+    option :chrome, :type => :boolean, :aliases => '-c',  :desc => "Run emulator on chrome instead of firefox", :default => false
+    def make(mainfile=nil)
+      mainfile="main.rb" if mainfile.nil?
+      
+      if !File.exist?(mainfile) then
+        help
+      
+      else
+        
+        # used a icon from noun project. Thanks Jenny!
+        # http://thenounproject.com/term/fire/24187/
+        say <<-EOS
+                                                                
+             `.::-`                                             
+             :hNMMNNds/.                                        
+               :dMMMMMMNdo.                                     
+                `oNMMMMMMMNh:                                   
+                  /NMMMMMMMMNy.                                 
+                   +MMMMMMMMMMm/                                
+                    dMMMMMMMMMMNo                               
+                    oMMMMMMMMMMMM+                              
+                    +MMMMMMMMMMMMN/                             
+                    sMMMMMMMMMMMMMm.                            
+                   `mMMMMMMMMMMMMMMs        ::`                 
+                   /MMMMMMMMMMMMMMMN.       `hh/`               
+                  `dMMMMMMMMMMMMMMMMo        -NMd/`             
+                  sMMMMMMMMMMMMMMMMMd         yMMMh-            
+                 /MMMMMMMMMMMMMMMMMMN.        /MMMMN+           
+                :NMMMMMMMMMMMMMMMMMMM-        :MMMMMMo`         
+               -mMMMMMMMMMMMMMMMMMMMM/        oMMMMMMMo         
+              .dMMMMMMMMMMMMMMMMMMMMMo       .mMMMMMMMN:        
+             .dMMMMMMMMMMMMMMMMMMMMMMm`     .dMMMMMMMMMm`       
+            `dMMMMMMMMMMMMMMMMMMMMMMMMy.```/mMMMMMMMMMMMo       
+           `hMMMMMMMMMMMMMMMNNNMMMMMMMMNhhmMMMMMMMMMMMMMm`      
+          `hMMMMMMMMMMMMMMMN/`-/yNMMMMMMMMMMMMMMMMMMMMMMM:      
+         `yMMMMMMMMMMMMMMMMMN-   .hMMMMMMMMMMMMMMMMMMMMMMy      
+         sMMMMMMMMMMMMMMMMMMMy     sMMMMMMMMMMMMMMMMMMMMMd      
+        +MMMMMMMMMMMMMMMMMMMMd     `hMMMMMMMMMMMMMMMMMMMMN`     
+       -NMMMMMMMMMMMMMMMMMMMMs      .NMMMMMMMMMMMMMMMMMMMM-     
+      `dMMMMMMMMMMMMMMMMMMMMm.       sMMMMMMMMMMMMMMMMMMMM:     
+      +MMMMMMMMMMMMMMMMMMMMN-        -MMMMMMMMMMMMMMMMMMMM.     
+     `mMMMMMMMMMMMMMMMMMMMm-          NMMMN+NMMMMMMMMMMMMN      
+     /MMMMMMMMMMMMMMMMMMMh.           NMMMM--mMMMMMMMMMMMh      
+     yMMMMMMMMMMMMMMMMMN+`           .MMMMM+ -mMMMMMMMMMM+      
+    `mMMMMMMMMMMMMMMMMh-             +MMMMM:  /MMMMMMMMMN.      
+    -MMMMMMMMMMMMMMMN+`              yMMMMs    hMMMMMMMMy       
+    :MMMMMMMMMMMMMMd-                :hhy:`    /MMMMMMMN.       
+    .NMMMMMMMMMMMMy.                  ``       -MMMMMMMo        
+     dMMMMMMMMMMMs`                            .MMMMMMd`        
+     +MMMMMMMMMMy`                             :MMMMMN-         
+     `dMMMMMMMMN.                              sMMMMN/          
+      :NMMMMMMMh                              `mMMMN+           
+       +MMMMMMMs            burn              oMMMN+            
+        +NMMMMMh                             -NMMm:             
+         /mMMMMN-          v#{VERSION}           .dMNy.              
+          .hNMMMh`                         .dNh:                
+           `/mMMMh.                       -hy:`                 
+             `+mMMm/`                   `:+.                    
+               `/hNMd+.                 ``                      
+                  .+hNNy/.                                      
+                     `-/oo:                                     
+                                                                
+                                                                
+EOS
+        # init
+        say "."
+        remove_dir "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        empty_directory "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        directory File.dirname(__FILE__) + "/workspace_default", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        
+        # compile and build .out
+        say ".."
+        builder = Builder.new(@workspace_root)
+        builder.verbose options[:verbose]
+        builder.load File.read("#{@workspace_root}/#{mainfile}")
+        builder.generate
+        
+        # Prepare compilers
+        say "..."
+        env = Burn::Util::Os.new
+        directory File.dirname(__FILE__) + "/tools/#{env.os_name}", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        
+        # Finally compile
+        say "...."
+        redirect = ""
+        if env.is_win? then
+          command = ""
+          ext = "bat"
+          redirect = " > nul" if !options[:verbose]
+          
+        else
+          command = "/bin/bash "
+          ext = "sh"
+          redirect = " > /dev/null" if !options[:verbose]
+          
+          # Set permissions to execute compilers
+          Dir::glob("#{@workspace_root}/tmp/burn/cc65/bin/*65").each do |f|
+            File.chmod(0777, f)
+          end
+          
+        end
+        run "#{command}#{@workspace_root}/tmp/burn/scripts/compile.#{ext} #{@workspace_root}/tmp/burn #{redirect}", :verbose => options[:verbose]
+        
+        # prepare customized emulator
+        say "....."
+        require 'base64'
+        File.write(
+          "#{@workspace_root}/tmp/burn/release/js/emulator.html", 
+          File.read(File.dirname(__FILE__)+"/workspace_default/release/js/emulator.html")
+            .gsub(/__@__TITLE__@__/, mainfile)
+            .gsub(/__@__ROMDATA__@__/,
+              Base64::strict_encode64(
+                File.binread("#{@workspace_root}/tmp/burn/main.out")
+              )
+            )
+        )
+        copy_file "#{@workspace_root}/tmp/burn/main.out", "#{@workspace_root}/tmp/burn/release/js/main.out", :verbose => options[:verbose]
+        
+        say "Burned."
+        
+        # run simulator
+        play if options[:preview]
+      end
+    end
+    
+    desc "server <document_root>", "Run simple http server for emulator. This is mainly used by burn rubygem itself, not by user."
+    option :debug, :type => :string, :aliases => '-d', :desc => "Debug mode"
+    def server(document_root=nil)
+      raise Exception.new("document_root must be specified when you would like to run http server") if document_root.nil?
+      server = Burn::Util::Server.new(document_root)
+      server.start
+    end
+    
+    desc "play <file>", "Invoke application simulator."
+    def play(mainfile=nil)
+      mainfile="main.out" if mainfile.nil?
+      env = Burn::Util::Os.new
+      
+      # boot up webrick httpserver to download emulator script
+      command = "ruby " + File.dirname(__FILE__) + "/../../bin/burn server #{@workspace_root}/tmp/burn/release/js/ " + (options[:debug] ? "-d" : "")
+      if env.is_win? then
+        run "start #{command}", :verbose => options[:verbose]
+      else
+        run "#{command} &", :verbose => options[:verbose]
+      end
+      
+      # open up browser
+      uri = "http://127.0.0.1:17890/emulator.html"
+      browser = options[:chrome] ? "chrome" : "firefox"
+      if env.is_win? then
+        run "start #{browser} #{uri}", :verbose => options[:verbose]
+      elsif env.is_mac? then
+        run "open -a #{browser} #{uri}", :verbose => options[:verbose]
+      else
+        run "/usr/bin/#{browser} #{uri}", :verbose => options[:verbose]
+      end
+    end
+    
+    desc "version", "Print version"
+    map %w(-v --version) => :version
+    def version
+      say "burn #{Burn::VERSION}"
+    end
+    
+    # desc "release", "To be designed"
+    
+  end
+end

data/lib/burn/debug.rb

@@ -0,0 +1,25 @@
+module Burn
+  module Debug
+    class Logger
+      @@enabled = false
+      
+      def enabled(flag)
+        @@enabled = flag
+      end
+      
+      def enabled?
+        @@enabled
+      end
+      
+      def log(message)
+        puts message if @@enabled
+      end
+    end
+  
+    def log(*messages)
+      messages.each do |message|
+        Debug::Logger.new.log message
+      end
+    end
+  end
+end

data/lib/burn/dsl/channel_stream.rb

@@ -0,0 +1,105 @@
+module Burn
+  module Dsl
+    class ChannelStream
+      # tempo 193 ~ 211 (18 levels, 202 is median)
+      # see: http://ja.wikipedia.org/wiki/%E6%BC%94%E5%A5%8F%E8%A8%98%E5%8F%B7
+      TEMPO_BASE = 192
+      PRESTO = 1 + TEMPO_BASE
+      ALLEGRO = 2 + TEMPO_BASE
+      MODERATO = 3 + TEMPO_BASE
+      ANDANTE = 4 + TEMPO_BASE
+      ADAGIO = 5 + TEMPO_BASE
+      LARGO = 6 + TEMPO_BASE
+      
+      # instrument number 64~126 (62steps) *note* no sound for 64, 65~72 seems working right now
+      BASS = 65
+      PIANO = 66
+      STRING = 67
+      ARPEGGIO = 68
+      STEP = 69
+      BELL = 70
+      ACOUSTIC = 71
+      GUITAR = 72
+      THEREMIN = 73
+      
+      def initialize(index, instrument, tempo)
+        @index = index
+        
+        @duration_list = [:half, :quarter, :eighth, :sixteenth]
+        @duration_numeric_list = {2=>:half, 4=>:quarter, 8=>:eighth, 16=>:sixteenth}
+        @duration_symbol_list = [:dotted, :triplet]
+        @articulation_list = [:tenuto, :staccato, :accent]
+        @instrument_list = [:piano, :bass]
+        
+        @notes = Array.new
+        @notes << ChannelStream.const_get(tempo.upcase)
+        @notes << ChannelStream.const_get(instrument.upcase)  
+        
+        @default_duration = :quarter
+        @default_articulation = nil
+        @default_pitch = :c0
+        
+        @output_buffer = Array.new
+      end
+      
+      def default(*args)
+        args.each{ |option|
+          if @duration_numeric_list.include?(option) then
+            @default_duration = @duration_numeric_list[option]
+          elsif @duration_list.include?(option) then
+            @default_duration = option
+          elsif @articulation_list.include?(option) then 
+            @default_articulation = option
+          end
+        }
+      end
+      
+      def method_missing(method_symbol, *args, &block)
+        case method_symbol
+        when :segno then
+          @output_buffer << __translate
+          @output_buffer << "@chn#{@index.to_s}_segno:"
+          @notes = Array.new
+        when :dal_segno then
+          @output_buffer << __translate
+          @output_buffer << "	.byte $fe" # end of stream
+          @output_buffer << "	.word @chn#{@index.to_s}_segno"
+          @notes = Array.new
+        else
+          note = Note.new(@default_duration, method_symbol, @default_articulation)
+          args.each{ |option|
+            if @duration_numeric_list.include?(option) then
+              note.duration = @duration_numeric_list[option]
+            elsif @duration_list.include?(option) then
+              note.duration = option
+            elsif @articulation_list.include?(option) then 
+              note.articulation = option
+            elsif @duration_symbol_list.include?(option) then
+              note.duration_symbol = option
+            end
+          }
+          @notes.concat note.generate
+        end
+      end
+      
+      def load(&block)
+        self.instance_eval &block
+      end
+      
+      def generate
+        if @notes.count>0 then
+          @output_buffer << __translate
+        end
+        @output_buffer.join("\n")
+        # "	.byte " + @notes.map{|p| "$%02x" % p}.join(",")
+        # "	.byte $c1,$43,$1d,$80,$1f,$80,$21,$82,$1d,$80,$1d,$80,$1f,$92"
+      end
+      
+      private
+      def __translate
+        "	.byte " + @notes.map{|p| "$%02x" % p}.join(",")
+      end
+      
+    end
+  end
+end

data/lib/burn/dsl/declare.rb

@@ -0,0 +1,42 @@
+module Burn
+  module Dsl
+    class Declare < DslBase
+        
+      def initialize(resource_name, context)
+        super(resource_name, context)
+      end
+      
+      def method_missing(method_symbol, *args, &block)
+        log :method_symbol=>method_symbol, :args=>args, block=>block
+        
+        proc = Proc.new{|args|
+          key=args.shift
+          value=args.shift
+          if value.is_a?(String) then
+            patternizer = Burn::Util::Patternizer.new(value)
+            
+            struct_var = "static sprite_schema #{key}={0, 0, {"
+            @pattern_table_index[key.to_sym] = @pattern_table_pointer
+            patternizer.patterns.each_with_index do |p, i|
+              log p, i, patternizer.height, "aaaaaaaaaaaaaaaaaaa"
+              struct_var += sprintf("%d, %d, %#x, 0,", (i % patternizer.width)*8 , (i / (patternizer.patterns.size / patternizer.height) )*8 , @pattern_table_pointer)
+              @pattern_tables << p
+              @pattern_table_pointer+=1
+            end
+            struct_var += "128}};"
+            
+            @global.push sprintf(struct_var, "")
+            
+          else
+            @global.push "static unsigned char #{key};"
+            @code_blocks.push "#{key}="+sprintf("%#x", value)+";"
+            log :key=>key, :value=>value.to_s(16), :value_class=>value.class
+          end
+        }
+
+        @context.instance_exec [method_symbol.to_s, args[0]], &proc
+      end
+    
+    end
+  end
+end

data/lib/burn/dsl/dsl_base.rb

@@ -0,0 +1,31 @@
+module Burn
+  module Dsl
+    class DslBase
+      # blankslate
+      instance_methods.each do |m|
+        undef_method m unless m.to_s =~ /object_id|__|method|instance_eval?/
+      end
+      
+      include Debug
+      
+      def initialize(resource_name, context)
+        @resource_name = resource_name
+        @context = context
+      end
+      
+      def method_missing(method_symbol, *args, &block)
+        log :method_symbol=>method_symbol, :args=>args, :block=>block
+        raise Exception.new "Unknown DSL '#{method_symbol}' is used."
+        
+#        # First argument will be block as always
+#        args.unshift block
+#        if @procs.key? method_symbol then
+#          @context.instance_exec args, &@procs[method_symbol]
+#        else
+#          raise Exception.new "Unknown DSL '#{method_symbol}' is used."
+#        end
+      end
+      
+    end
+  end
+end

data/lib/burn/dsl/music.rb

@@ -0,0 +1,36 @@
+module Burn
+  module Dsl
+    class Music < DslBase
+      def initialize(resource_name, context)
+        super(resource_name, context)
+        
+        @default_tempo = :allegro
+        
+        if resource_name.nil? then
+          raise Exception.new "Resource name for Music class must be provided."
+        else
+          @resource_name = resource_name
+        end
+        
+        @context.instance_exec resource_name, &lambda{|resource_name|
+          @resources["#{resource_name}"] = Array.new
+        }
+        
+      end
+      
+      def channel(instrument, &block)
+        @context.instance_exec(@resource_name,@default_tempo) do |resource_name, default_tempo|
+          stream = ChannelStream.new(@resources["#{resource_name}"].count, instrument, default_tempo)
+          stream.load(&block)
+          @resources["#{resource_name}"] << stream.generate
+          #@resources["#{resource_name}"] << "	.byte $43,$1d,$80,$1f,$80,$21,$82,$1d,$80,$1d,$80,$1f,$92"
+        end
+      end
+      
+      def tempo(speed)
+        @default_tempo = speed
+      end
+      
+    end
+  end
+end

data/lib/burn/dsl/note.rb

@@ -0,0 +1,125 @@
+module Burn
+  module Dsl
+    class Note
+      # For music
+      # (0..59 are octaves 1-5, 63 note stop)
+      C = 0
+      D = 2
+      E = 4
+      F = 5
+      G = 7
+      A = 9
+      B = 11
+      
+      CS = 11
+      DS = 1
+      ES = 3
+      FS = 4
+      GS = 6
+      AS = 8
+      BS = 10
+      
+      REST = -1
+      
+      
+      # Empty Rows 128~191 (63steps)
+      DURATION_BASE = 127
+      SIXTEENTH = 4 + DURATION_BASE
+      EIGHTH = 10 + DURATION_BASE
+      QUARTER = 22 + DURATION_BASE
+      HALF = 46 + DURATION_BASE
+      DOTTED_SIXTEENTH = 7 + DURATION_BASE
+      DOTTED_EIGHTH = 16 + DURATION_BASE
+      DOTTED_QUARTER = 34 + DURATION_BASE
+      DOTTED_HALF = 70 + DURATION_BASE
+      TRIPLET_SIXTEENTH = 1 + DURATION_BASE
+      TRIPLET_EIGHTH = 4 + DURATION_BASE
+      TRIPLET_QUARTER = 10 + DURATION_BASE
+      TRIPLET_HALF = 22 + DURATION_BASE
+      
+      TENUTO = 1.0
+      ACCENT = 0.7
+      STACCATO = 0.2
+      
+      attr_accessor :duration, :articulation, :duration_symbol
+      
+      def initialize(duration=:quarter, pitch=:c0, articulation=nil, duration_symbol=nil)
+        @pitch_list = {c:C, bsharp:C,
+                       ds:DS, dflat:DS, csharp:DS,
+                       d:D, 
+                       es:ES, eflat:ES, dsharp:DS,
+                       e:E, fs:FS, fflat:FS,
+                       f:F, esharp:F,
+                       gs:GS, gflat:GS, fsharp:GS,
+                       g:G, 
+                       as:AS, aflat:AS, gsharp:AS,
+                       a:A, 
+                       bs:BS, bflat:BS, asharp:BS,
+                       b:B, cs:CS, cflat:CS,
+                       rest:REST,
+                       }
+
+        # Fix pitch first at this early timing
+        if !pitch.to_s.match(/(.+)(\d)/).nil? then
+          raise Exception.new "pitch #{pitch.to_s} is not defined." if !@pitch_list.keys.include?(Regexp.last_match(1).to_sym)
+          @pitch = @pitch_list[Regexp.last_match(1).to_sym]
+          if Regexp.last_match(2).to_i <= 4 then
+            @octave = Regexp.last_match(2).to_i
+          else
+            raise Exception.new "Sorry only 0-4 octave range is supported."
+          end
+        else
+          raise Exception.new "pitch #{pitch.to_s} is not defined." if !@pitch_list.keys.include?(pitch)
+          @pitch = @pitch_list[pitch]
+          @octave = 0
+        end
+        
+        @duration = duration
+        @articulation = articulation
+        @duration_symbol = duration_symbol
+      end
+      
+      def generate
+        duration = get_actual_duration
+        
+        result = Array.new
+        if @pitch==REST then
+          @articuulation = 0
+        else
+          result << @pitch + 12 * @octave
+        end
+        
+        articulation = Note.const_get(@articulation.upcase) if !@articulation.nil?
+        if articulation.nil? then
+          result << duration
+          result << 63 # note stop
+        elsif articulation == TENUTO then
+          result << duration + 1
+        else
+          if (len(duration)*articulation).ceil > 0 then
+            result << DURATION_BASE + (len(duration)*articulation).ceil
+            result << 63 # note stop
+          end
+          if (len(duration)*(1.0 - articulation)).floor > 0 then
+            result << DURATION_BASE + (len(duration)*(1.0-articulation)).floor
+          end
+        end
+        result
+      end
+      
+      private
+      def len(duration)
+        duration - DURATION_BASE
+      end
+      
+      def get_actual_duration
+        if !@duration_symbol.nil? then
+          Note.const_get(@duration_symbol.upcase.to_s + "_" + @duration.upcase.to_s)
+        else
+          Note.const_get(@duration.upcase.to_s)
+        end
+      end
+      
+    end
+  end
+end