begin transitioning builders to using instance variables instead of #run options Hash fields

lib/rscons/builder.rb

@@ -44,7 +44,23 @@ module Rscons
 
     # @return [String, Symbol]
     #   Target file name.
-    attr_reader :target
+    attr_accessor :target
+
+    # @return [Array<String>]
+    #   Source file name(s).
+    attr_accessor :sources
+
+    # @return [Cache]
+    #   Cache instance.
+    attr_accessor :cache
+
+    # @return [Environment]
+    #   The {Environment} performing the build operation.
+    attr_accessor :env
+
+    # @return [Hash, VarSet]
+    #   Construction variables used to perform the build operation.
+    attr_accessor :vars
 
     # Create an instance of the Builder to build a target.
     #
@@ -54,6 +70,8 @@ module Rscons
     #   Target file name.
     # @option options [Array<String>] :sources
     #   Source file name(s).
+    # @option options [Cache] :cache
+    #   The Cache object.
     # @option options [Environment] :env
     #   The Environment executing the builder.
     # @option options [Hash,VarSet] :vars
@@ -61,6 +79,7 @@ module Rscons
     def initialize(options)
       @target = options[:target]
       @sources = options[:sources]
+      @cache = options[:cache]
       @env = options[:env]
       @vars = options[:vars]
     end
@@ -88,16 +107,6 @@ module Rscons
     #
     # @param options [Hash]
     #   Run options.
-    # @option options [String] :target
-    #   Target file name.
-    # @option options [Array<String>] :sources
-    #   Source file name(s).
-    # @option options [Cache] :cache
-    #   The Cache object.
-    # @option options [Environment] :env
-    #   The Environment executing the builder.
-    # @option options [Hash,VarSet] :vars
-    #   Extra construction variables.
     #
     # @return [ThreadedCommand,String,false]
     #   Name of the target file on success or false on failure.

lib/rscons/builders/cfile.rb

@@ -21,22 +21,19 @@ module Rscons
 
       # Run the builder to produce a build target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge({
-          "_TARGET" => target,
-          "_SOURCES" => sources,
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @sources
         cmd =
           case
-          when sources.first.end_with?(*env.expand_varref("${LEXSUFFIX}"))
+          when @sources.first.end_with?(*@env.expand_varref("${LEXSUFFIX}"))
             "LEX"
-          when sources.first.end_with?(*env.expand_varref("${YACCSUFFIX}"))
+          when @sources.first.end_with?(*@env.expand_varref("${YACCSUFFIX}"))
             "YACC"
           else
-            raise "Unknown source file #{sources.first.inspect} for CFile builder"
+            raise "Unknown source file #{@sources.first.inspect} for CFile builder"
           end
-        command = env.build_command("${#{cmd}_CMD}", vars)
-        standard_threaded_build("#{cmd} #{target}", target, command, sources, env, cache)
+        command = @env.build_command("${#{cmd}_CMD}", @vars)
+        standard_threaded_build("#{cmd} #{@target}", @target, command, @sources, @env, @cache)
       end
 
       # Finalize a build.

lib/rscons/builders/command.rb

@@ -18,18 +18,15 @@ module Rscons
       #   Target file name if target is up to date or a {ThreadedCommand}
       #   to execute to build the target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge({
-          "_TARGET" => target,
-          "_SOURCES" => sources,
-        })
-        command = env.build_command("${CMD}", vars)
-        cmd_desc = vars["CMD_DESC"] || "Command"
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @sources
+        command = @env.build_command("${CMD}", @vars)
+        cmd_desc = @vars["CMD_DESC"] || "Command"
         options = {}
-        if vars["CMD_STDOUT"]
-          options[:stdout] = env.expand_varref("${CMD_STDOUT}", vars)
+        if @vars["CMD_STDOUT"]
+          options[:stdout] = @env.expand_varref("${CMD_STDOUT}", @vars)
         end
-        standard_threaded_build("#{cmd_desc} #{target}", target, command, sources, env, cache, options)
+        standard_threaded_build("#{cmd_desc} #{@target}", @target, command, @sources, @env, @cache, options)
       end
 
       # Finalize a build.

lib/rscons/builders/directory.rb

@@ -5,16 +5,15 @@ module Rscons
 
       # Run the builder to produce a build target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        if File.directory?(target)
-          target
-        elsif File.exists?(target)
-          Ansi.write($stderr, :red, "Error: `#{target}' already exists and is not a directory", :reset, "\n")
+        if File.directory?(@target)
+          @target
+        elsif File.exists?(@target)
+          Ansi.write($stderr, :red, "Error: `#{@target}' already exists and is not a directory", :reset, "\n")
           false
         else
-          env.print_builder_run_message("Directory #{target}", nil)
-          cache.mkdir_p(target)
-          target
+          @env.print_builder_run_message("Directory #{@target}", nil)
+          @cache.mkdir_p(@target)
+          @target
         end
       end
 

lib/rscons/builders/disassemble.rb

@@ -11,17 +11,16 @@ module Rscons
 
       # Run the builder to produce a build target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge("_SOURCES" => sources)
-        command = env.build_command("${DISASM_CMD}", vars)
-        if cache.up_to_date?(target, command, sources, env)
-          target
+        @vars["_SOURCES"] = sources
+        command = @env.build_command("${DISASM_CMD}", @vars)
+        if @cache.up_to_date?(@target, command, @sources, @env)
+          @target
         else
-          cache.mkdir_p(File.dirname(target))
+          @cache.mkdir_p(File.dirname(@target))
           ThreadedCommand.new(
             command,
-            short_description: "Disassemble #{target}",
-            system_options: {out: target})
+            short_description: "Disassemble #{@target}",
+            system_options: {out: @target})
         end
       end
 

lib/rscons/builders/install.rb

@@ -7,15 +7,14 @@ module Rscons
 
       # Run the builder to produce a build target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        target_is_dir = (sources.length > 1) ||
-                        Dir.exists?(sources.first) ||
-                        Dir.exists?(target)
-        outdir = target_is_dir ? target : File.dirname(target)
+        target_is_dir = (@sources.length > 1) ||
+                        Dir.exists?(@sources.first) ||
+                        Dir.exists?(@target)
+        outdir = target_is_dir ? @target : File.dirname(@target)
         # Collect the list of files to copy over.
         file_map = {}
         if target_is_dir
-          sources.each do |src|
+          @sources.each do |src|
             if Dir.exists? src
               Dir.glob("#{src}/**/*", File::FNM_DOTMATCH).select do |f|
                 File.file?(f)
@@ -33,20 +32,19 @@ module Rscons
         printed_message = false
         file_map.each do |src, dest|
           # Check the cache and copy if necessary
-          unless cache.up_to_date?(dest, :Copy, [src], env)
+          unless @cache.up_to_date?(dest, :Copy, [src], @env)
             unless printed_message
-              env.print_builder_run_message("#{self.class.name} #{target}", nil)
+              @env.print_builder_run_message("#{name} #{@target}", nil)
               printed_message = true
             end
-            cache.mkdir_p(File.dirname(dest))
+            @cache.mkdir_p(File.dirname(dest))
             FileUtils.cp(src, dest, :preserve => true)
           end
-          cache.register_build(dest, :Copy, [src], env)
+          @cache.register_build(dest, :Copy, [src], @env)
         end
-        target if (target_is_dir ? Dir.exists?(target) : File.exists?(target))
+        @target if (target_is_dir ? Dir.exists?(@target) : File.exists?(@target))
       end
 
-
     end
 
     # The Copy builder is identical to the Install builder.

lib/rscons/builders/library.rb

@@ -36,14 +36,11 @@ module Rscons
       # @return [String,false]
       #   Name of the target file on success or false on failure.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge({
-          '_TARGET' => target,
-          '_SOURCES' => @objects,
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @objects
         options[:sources] = @objects
-        command = env.build_command("${ARCMD}", vars)
-        standard_threaded_build("AR #{target}", target, command, @objects, env, cache)
+        command = @env.build_command("${ARCMD}", @vars)
+        standard_threaded_build("AR #{@target}", @target, command, @objects, @env, @cache)
       end
 
       # Finalize a build.

lib/rscons/builders/object.rb

@@ -83,22 +83,19 @@ module Rscons
       #   Target file name if target is up to date or a {ThreadedCommand}
       #   to execute to build the target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge({
-          '_TARGET' => target,
-          '_SOURCES' => sources,
-          '_DEPFILE' => Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars)),
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @sources
+        @vars["_DEPFILE"] = Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars))
         com_prefix = KNOWN_SUFFIXES.find do |compiler, suffix_var|
-          sources.first.end_with?(*env.expand_varref("${#{suffix_var}}", vars))
+          @sources.first.end_with?(*@env.expand_varref("${#{suffix_var}}", @vars))
         end.tap do |v|
-          v.nil? and raise "Error: unknown input file type: #{sources.first.inspect}"
+          v.nil? and raise "Error: unknown input file type: #{@sources.first.inspect}"
         end.first
-        command = env.build_command("${#{com_prefix}CMD}", vars)
-        env.produces(target, vars['_DEPFILE'])
+        command = @env.build_command("${#{com_prefix}CMD}", @vars)
+        @env.produces(@target, @vars["_DEPFILE"])
         # Store vars back into options so new keys are accessible in #finalize.
         options[:vars] = vars
-        standard_threaded_build("#{com_prefix} #{target}", target, command, sources, env, cache)
+        standard_threaded_build("#{com_prefix} #{@target}", @target, command, @sources, @env, @cache)
       end
 
       # Finalize the build operation.

lib/rscons/builders/preprocess.rb

@@ -19,24 +19,23 @@ module Rscons
       #   Target file name if target is up to date or a {ThreadedCommand}
       #   to execute to build the target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        if sources.find {|s| s.end_with?(*env.expand_varref("${CXXSUFFIX}", vars))}
+        if @sources.find {|s| s.end_with?(*@env.expand_varref("${CXXSUFFIX}", @vars))}
           pp_cc = "${CXX}"
           depgen = "${CXXDEPGEN}"
         else
           pp_cc = "${CC}"
           depgen = "${CCDEPGEN}"
         end
-        vars = vars.merge("_PREPROCESS_CC" => pp_cc,
-                          "_PREPROCESS_DEPGEN" => depgen,
-                          "_TARGET" => target,
-                          "_SOURCES" => sources,
-                          "_DEPFILE" => Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars)))
-        command = env.build_command("${CPP_CMD}", vars)
-        env.produces(target, vars['_DEPFILE'])
+        @vars["_PREPROCESS_CC"] = pp_cc
+        @vars["_PREPROCESS_DEPGEN"] = depgen
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @sources
+        @vars["_DEPFILE"] = Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars))
+        command = @env.build_command("${CPP_CMD}", @vars)
+        @env.produces(@target, @vars["_DEPFILE"])
         # Store vars back into options so new keys are accessible in #finalize.
         options[:vars] = vars
-        standard_threaded_build("#{self.class.name} #{target}", target, command, sources, env, cache)
+        standard_threaded_build("#{name} #{@target}", @target, command, @sources, @env, @cache)
       end
 
       # Finalize the build operation.

lib/rscons/builders/program.rb

@@ -46,25 +46,22 @@ module Rscons
       # @return [String,false]
       #   Name of the target file on success or false on failure.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        ld = env.expand_varref("${LD}", vars)
+        ld = @env.expand_varref("${LD}", @vars)
         ld = if ld != ""
                ld
-             elsif sources.find {|s| s.end_with?(*env.expand_varref("${DSUFFIX}", vars))}
+             elsif @sources.find {|s| s.end_with?(*@env.expand_varref("${DSUFFIX}", @vars))}
                "${DC}"
-             elsif sources.find {|s| s.end_with?(*env.expand_varref("${CXXSUFFIX}", vars))}
+             elsif @sources.find {|s| s.end_with?(*@env.expand_varref("${CXXSUFFIX}", @vars))}
                "${CXX}"
              else
                "${CC}"
              end
-        vars = vars.merge({
-          '_TARGET' => target,
-          '_SOURCES' => @objects,
-          'LD' => ld,
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @objects
+        @vars["LD"] = ld
         options[:sources] = @objects
-        command = env.build_command("${LDCMD}", vars)
-        standard_threaded_build("LD #{target}", target, command, @objects, env, cache)
+        command = @env.build_command("${LDCMD}", @vars)
+        standard_threaded_build("LD #{@target}", @target, command, @objects, @env, @cache)
       end
 
       # Finalize a build.

lib/rscons/builders/shared_library.rb

@@ -58,25 +58,22 @@ module Rscons
       # @return [String,false]
       #   Name of the target file on success or false on failure.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        ld = env.expand_varref("${SHLD}", vars)
+        ld = @env.expand_varref("${SHLD}", @vars)
         ld = if ld != ""
                ld
-             elsif sources.find {|s| s.end_with?(*env.expand_varref("${DSUFFIX}", vars))}
+             elsif @sources.find {|s| s.end_with?(*@env.expand_varref("${DSUFFIX}", @vars))}
                "${SHDC}"
-             elsif sources.find {|s| s.end_with?(*env.expand_varref("${CXXSUFFIX}", vars))}
+             elsif @sources.find {|s| s.end_with?(*@env.expand_varref("${CXXSUFFIX}", @vars))}
                "${SHCXX}"
              else
                "${SHCC}"
              end
-        vars = vars.merge({
-          '_TARGET' => target,
-          '_SOURCES' => @objects,
-          'SHLD' => ld,
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @objects
+        @vars["SHLD"] = ld
         options[:sources] = @objects
-        command = env.build_command("${SHLDCMD}", vars)
-        standard_threaded_build("SHLD #{target}", target, command, @objects, env, cache)
+        command = @env.build_command("${SHLDCMD}", @vars)
+        standard_threaded_build("SHLD #{@target}", @target, command, @objects, @env, @cache)
       end
 
       # Finalize a build.

lib/rscons/builders/shared_object.rb

@@ -68,22 +68,19 @@ module Rscons
       #   Target file name if target is up to date or a {ThreadedCommand}
       #   to execute to build the target.
       def run(options)
-        target, sources, cache, env, vars = options.values_at(:target, :sources, :cache, :env, :vars)
-        vars = vars.merge({
-          '_TARGET' => target,
-          '_SOURCES' => sources,
-          '_DEPFILE' => Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars)),
-        })
+        @vars["_TARGET"] = @target
+        @vars["_SOURCES"] = @sources
+        @vars["_DEPFILE"] = Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars))
         com_prefix = KNOWN_SUFFIXES.find do |compiler, suffix_var|
-          sources.first.end_with?(*env.expand_varref("${#{suffix_var}}", vars))
+          @sources.first.end_with?(*@env.expand_varref("${#{suffix_var}}", @vars))
         end.tap do |v|
-          v.nil? and raise "Error: unknown input file type: #{sources.first.inspect}"
+          v.nil? and raise "Error: unknown input file type: #{@sources.first.inspect}"
         end.first
-        command = env.build_command("${#{com_prefix}CMD}", vars)
-        env.produces(target, vars['_DEPFILE'])
+        command = @env.build_command("${#{com_prefix}CMD}", @vars)
+        @env.produces(@target, @vars["_DEPFILE"])
         # Store vars back into options so new keys are accessible in #finalize.
-        options[:vars] = vars
-        standard_threaded_build("#{com_prefix} #{target}", target, command, sources, env, cache)
+        options[:vars] = @vars
+        standard_threaded_build("#{com_prefix} #{@target}", @target, command, @sources, @env, @cache)
       end
 
       # Finalize the build operation.

lib/rscons/builders/simple_builder.rb

@@ -29,7 +29,7 @@ module Rscons
       #
       # Method signature described by {Builder#run}.
       def run(*args)
-        @run_proc.call(*args)
+        instance_exec(*args, &@run_proc)
       end
 
     end

lib/rscons/environment.rb

@@ -354,7 +354,12 @@ module Rscons
         sources = Array(sources).map do |source|
           expand_path(expand_varref(source))
         end.flatten
-        builder = @builders[method.to_s].new(env: self, target: target, sources: sources, vars: vars)
+        builder = @builders[method.to_s].new(
+          target: target,
+          sources: sources,
+          cache: Cache.instance,
+          env: self,
+          vars: vars)
         add_target(builder.target, builder, sources, vars)
         builder
       else
@@ -535,6 +540,10 @@ module Rscons
       # Invoke pre-build hooks.
       call_build_hooks[:pre]
 
+      # TODO: remove build_operation fields and just pass in the Builder.
+      builder.sources = build_operation[:sources]
+      builder.vars = build_operation[:vars]
+
       # Call the builder's #run method.
       rv = builder.run(build_operation)