rscons 1.9.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dbbb85ee44633f0af254208d3babe2415b70a37
-  data.tar.gz: 5f360f841852afe46237d5f26984a38f155704da
+  metadata.gz: 8ceb5baf09b2d108fcb231a024434805e133d3fa
+  data.tar.gz: c38980efedd1fca10de580afa672a8fe5ad444cd
 SHA512:
-  metadata.gz: 13333e94ec23446f681ad30a5d219e2e5658bc50f244d55788d7407541480d2a631394a6b42ec02f73767876969085bc7f09b92173661ed844bf6e236b28119d
-  data.tar.gz: ac8cb2130e604b31c2de4901cb074538cb75288b85ea8a2e7ad606c03f454a42b4e911270f7c045d5e7def59984b1753c8e261186a6056f6a3bf3db122866b76
+  metadata.gz: f58839f1655e17599d94cc7e694cda950c61ed224520fa9a1b38e3c9d5171b9b978571f5554f8c73854557a9c714f3de98b274204a073ac91f07da734a73c60c
+  data.tar.gz: 858a9dbdb7d95ec61e24eac775a22532c55a2482bf1df57420bd18b31b034893c52210f1e436d1f5ca16940f2da9df99c9e455872c8dedc6dbb6fb6a0ff69cde

data/lib/rscons.rb

@@ -2,6 +2,8 @@ require_relative "rscons/build_target"
 require_relative "rscons/builder"
 require_relative "rscons/cache"
 require_relative "rscons/environment"
+require_relative "rscons/job_set"
+require_relative "rscons/threaded_command"
 require_relative "rscons/varset"
 require_relative "rscons/version"
 
@@ -15,6 +17,8 @@ require_relative "rscons/builders/library"
 require_relative "rscons/builders/object"
 require_relative "rscons/builders/preprocess"
 require_relative "rscons/builders/program"
+require_relative "rscons/builders/shared_library"
+require_relative "rscons/builders/shared_object"
 require_relative "rscons/builders/simple_builder"
 
 # Namespace module for rscons classes
@@ -33,6 +37,8 @@ module Rscons
     :Object,
     :Preprocess,
     :Program,
+    :SharedLibrary,
+    :SharedObject,
   ]
 
   # Class to represent a fatal error while building a target.
@@ -40,6 +46,10 @@ module Rscons
 
   class << self
 
+    # @return [Integer]
+    #   The number of threads to use when scheduling subprocesses.
+    attr_accessor :n_threads
+
     # Remove all generated files.
     #
     # @return [void]
@@ -65,7 +75,11 @@ module Rscons
     #
     # @return [Boolean] Whether the given path is an absolute filesystem path.
     def absolute_path?(path)
-      path =~ %r{^(/|\w:[\\/])}
+      if RUBY_PLATFORM =~ /mingw/
+        path =~ %r{^(?:\w:)?[\\/]}
+      else
+        path.start_with?("/")
+      end
     end
 
     # Return whether the given target is a phony target.
@@ -146,7 +160,45 @@ module Rscons
       @command_executer = val
     end
 
+    private
+
+    # Determine the number of threads to use by default.
+    #
+    # @return [Integer]
+    #   The number of threads to use by default.
+    def determine_n_threads
+      # If the user specifies the number of threads in the environment, then
+      # respect that.
+      if ENV["RSCONS_NTHREADS"] =~ /^(\d+)$/
+        return $1.to_i
+      end
+
+      # Otherwise try to figure out how many threads are available on the
+      # host hardware.
+      begin
+        case RbConfig::CONFIG["host_os"]
+        when /linux/
+          return File.read("/proc/cpuinfo").scan(/^processor\s*:/).size
+        when /mswin|mingw/
+          if `wmic cpu get NumberOfLogicalProcessors /value` =~ /NumberOfLogicalProcessors=(\d+)/
+            return $1.to_i
+          end
+        when /darwin/
+          if `sysctl -n hw.ncpu` =~ /(\d+)/
+            return $1.to_i
+          end
+        end
+      rescue
+      end
+
+      # If we can't figure it out, default to 1.
+      1
+    end
+
   end
+
+  @n_threads = determine_n_threads
+
 end
 
 # Unbuffer $stdout

data/lib/rscons/builder.rb

@@ -24,6 +24,14 @@ module Rscons
       {}
     end
 
+    # Return a set of build features that this builder provides.
+    #
+    # @return [Array<String>]
+    #   Set of build features that this builder provides.
+    def features
+      []
+    end
+
     # Create a BuildTarget object for this build target.
     #
     # Builder sub-classes can override this method to manipulate parameters
@@ -36,6 +44,8 @@ module Rscons
     #   The user-supplied target name.
     # @option options [Array<String>] :sources
     #   The user-supplied source file name(s).
+    # @option options [Hash,VarSet] :vars
+    #   Extra construction variables.
     #
     # @return [BuildTarget]
     def create_build_target(options)
@@ -45,9 +55,12 @@ module Rscons
     # Return whether this builder object is capable of producing a given target
     # file name from a given source file name.
     #
-    # @param target [String] The target file name.
-    # @param source [String] The source file name.
-    # @param env [Environment] The Environment.
+    # @param target [String]
+    #   The target file name.
+    # @param source [String]
+    #   The source file name.
+    # @param env [Environment]
+    #   The Environment.
     #
     # @return [Boolean]
     #   Whether this builder object is capable of producing a given target
@@ -56,22 +69,128 @@ module Rscons
       false
     end
 
+    # Set up a build operation using this builder.
+    #
+    # This method is called when a build target is registered using this
+    # builder. This method should not do any building, but should perform any
+    # setup needed and register any prerequisite build targets that need to be
+    # built before the target being requested here.
+    #
+    # If the builder needs no special setup, it does not need to override this
+    # method. If there is any information produced in this method that will be
+    # needed later in the build, it can be stored in the return value from this
+    # method, which will be passed to the {#run} method.
+    #
+    # @since 1.10.0
+    #
+    # @param options [Hash]
+    #   Options.
+    # @option options [String] :target
+    #   Target file name.
+    # @option options [Array<String>] :sources
+    #   Source file name(s).
+    # @option options [Environment] :env
+    #   The Environment executing the builder.
+    # @option options [Hash,VarSet] :vars
+    #   Extra construction variables.
+    #
+    # @return [Object]
+    #   Any object that the builder author wishes to be saved and passed back
+    #   in to the {#run} method.
+    def setup(options)
+    end
+
     # Run the builder to produce a build target.
     #
-    # @param target [String] Target file name.
-    # @param sources [Array<String>] Source file name(s).
-    # @param cache [Cache] The Cache object.
-    # @param env [Environment] The Environment executing the builder.
-    # @param vars [Hash,VarSet] Extra construction variables.
+    # The run method supports two different signatures - an older signature
+    # with five separate arguments, and a newer one with one Hash argument. A
+    # builder author can use either signature, and Rscons will automatically
+    # determine which arguments to pass when invoking the run method based on
+    # the method's arity.
     #
-    # @return [String,false]
+    # @overload run(target, sources, cache, env, vars)
+    #
+    #   @param target [String]
+    #     Target file name.
+    #   @param sources [Array<String>]
+    #     Source file name(s).
+    #   @param cache [Cache]
+    #     The Cache object.
+    #   @param env [Environment]
+    #     The Environment executing the builder.
+    #   @param vars [Hash,VarSet]
+    #     Extra construction variables.
+    #
+    # @overload run(options)
+    #
+    #   @since 1.10.0
+    #
+    #   @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.
+    #   @option options [Object] :setup_info
+    #     Whatever value was returned from this builder's {#setup} method call.
+    #
+    # @return [ThreadedCommand,String,false]
     #   Name of the target file on success or false on failure.
-    def run(target, sources, cache, env, vars)
+    #   Since 1.10.0, this method may return an instance of {ThreadedCommand}.
+    #   In that case, the build operation has not actually been completed yet
+    #   but the command to do so will be executed by Rscons in a separate
+    #   thread. This allows for build parallelization. If a {ThreadedCommand}
+    #   object is returned, the {#finalize} method will be called after the
+    #   command has completed. The {#finalize} method should then be used to
+    #   record cache info, if needed, and to return the true result of the
+    #   build operation. The builder can store information to be passed in to
+    #   the {#finalize} method by populating the :builder_info field of the
+    #   {ThreadedCommand} object returned here.
+    def run(options)
       raise "This method must be overridden in a subclass"
     end
 
+    # Finalize a build operation.
+    #
+    # This method is called after the {#run} method if the {#run} method
+    # returns a {ThreadedCommand} object.
+    #
+    # @since 1.10.0
+    #
+    # @param options [Hash]
+    #   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.
+    # @option options [Object] :setup_info
+    #   Whatever value was returned from this builder's {#setup} method call.
+    # @option options [true,false,nil] :command_status
+    #   If the {#run} method returns a {ThreadedCommand}, this field will
+    #   contain the return value from executing the command with
+    #   Kernel.system().
+    # @option options [ThreadedCommand] :tc
+    #   The {ThreadedCommand} object that was returned by the #run method.
+    #
+    # @return [String,false]
+    #   Name of the target file on success or false on failure.
+    def finalize(options)
+    end
+
     # Check if the cache is up to date for the target and if not execute the
-    # build command.
+    # build command. This method does not support parallelization.
     #
     # @param short_cmd_string [String]
     #   Short description of build action to be printed when env.echo ==
@@ -96,5 +215,59 @@ module Rscons
       end
       target
     end
+
+    # Check if the cache is up to date for the target and if not create a
+    # {ThreadedCommand} object to execute the build command in a thread.
+    #
+    # @since 1.10.0
+    #
+    # @param short_cmd_string [String]
+    #   Short description of build action to be printed when env.echo ==
+    #   :short.
+    # @param target [String] Name of the target file.
+    # @param command [Array<String>]
+    #   The command to execute to build the target.
+    # @param sources [Array<String>] Source file name(s).
+    # @param env [Environment] The Environment executing the builder.
+    # @param cache [Cache] The Cache object.
+    # @param options [Hash] Options.
+    # @options options [String] :stdout
+    #   File name to redirect standard output to.
+    #
+    # @return [String,ThreadedCommand]
+    #   The name of the target if it is already up to date or the
+    #   {ThreadedCommand} object created to update it.
+    def standard_threaded_build(short_cmd_string, target, command, sources, env, cache, options = {})
+      if cache.up_to_date?(target, command, sources, env)
+        target
+      else
+        unless Rscons.phony_target?(target)
+          cache.mkdir_p(File.dirname(target))
+          FileUtils.rm_f(target)
+        end
+        tc_options = {short_description: short_cmd_string}
+        if options[:stdout]
+          tc_options[:system_options] = {out: options[:stdout]}
+        end
+        ThreadedCommand.new(command, tc_options)
+      end
+    end
+
+    # Register build results from a {ThreadedCommand} with the cache.
+    #
+    # @since 1.10.0
+    #
+    # @param options [Hash]
+    #   Builder finalize options.
+    #
+    # @return [String, nil]
+    #   The target name on success or nil on failure.
+    def standard_finalize(options)
+      if options[:command_status]
+        target, sources, cache, env = options.values_at(:target, :sources, :cache, :env)
+        cache.register_build(target, options[:tc].command, sources, env)
+        target
+      end
+    end
   end
 end

data/lib/rscons/builders/cfile.rb

@@ -7,6 +7,7 @@ module Rscons
     #   env.CFile("parser.tab.cc", "parser.yy")
     #   env.CFile("lex.yy.cc", "parser.ll")
     class CFile < Builder
+
       # Return default construction variables for the builder.
       #
       # @param env [Environment] The Environment using the builder.
@@ -17,9 +18,11 @@ module Rscons
           "YACC" => "bison",
           "YACC_FLAGS" => ["-d"],
           "YACC_CMD" => ["${YACC}", "${YACC_FLAGS}", "-o", "${_TARGET}", "${_SOURCES}"],
+          "YACCSUFFIX" => [".y", ".yy"],
           "LEX" => "flex",
           "LEX_FLAGS" => [],
           "LEX_CMD" => ["${LEX}", "${LEX_FLAGS}", "-o", "${_TARGET}", "${_SOURCES}"],
+          "LEXSUFFIX" => [".l", ".ll"],
         }
       end
 
@@ -40,16 +43,28 @@ module Rscons
         })
         cmd =
           case
-          when sources.first.end_with?(".l", ".ll")
+          when sources.first.end_with?(*env.expand_varref("${LEXSUFFIX}"))
             "LEX"
-          when sources.first.end_with?(".y", ".yy")
+          when sources.first.end_with?(*env.expand_varref("${YACCSUFFIX}"))
             "YACC"
           else
             raise "Unknown source file #{sources.first.inspect} for CFile builder"
           end
         command = env.build_command("${#{cmd}_CMD}", vars)
-        standard_build("#{cmd} #{target}", target, command, sources, env, cache)
+        standard_threaded_build("#{cmd} #{target}", target, command, sources, env, cache)
+      end
+
+      # Finalize a build.
+      #
+      # @param options [Hash]
+      #   Finalize options.
+      #
+      # @return [String, nil]
+      #   The target name on success or nil on failure.
+      def finalize(options)
+        standard_finalize(options)
       end
+
     end
   end
 end

data/lib/rscons/builders/command.rb

@@ -9,25 +9,40 @@ module Rscons
     #   env.Command("docs.html", "docs.md",
     #               CMD => %w[pandoc -fmarkdown -thtml -o${_TARGET} ${_SOURCES}])
     class Command < Builder
+
       # Run the builder to produce a build target.
       #
-      # @param target [String] Target file name.
-      # @param sources [Array<String>] Source file name(s).
-      # @param cache [Cache] The Cache object.
-      # @param env [Environment] The Environment executing the builder.
-      # @param vars [Hash,VarSet] Extra construction variables.
+      # @param options [Hash] Builder run options.
       #
-      # @return [String,false]
-      #   Name of the target file on success or false on failure.
-      def run(target, sources, cache, env, vars)
+      # @return [String, ThreadedCommand]
+      #   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"
-        standard_build("#{cmd_desc} #{target}", target, command, sources, env, cache)
+        options = {}
+        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)
       end
+
+      # Finalize a build.
+      #
+      # @param options [Hash]
+      #   Finalize options.
+      #
+      # @return [String, nil]
+      #   The target name on success or nil on failure.
+      def finalize(options)
+        standard_finalize(options)
+      end
+
     end
   end
 end

data/lib/rscons/builders/disassemble.rb

@@ -2,6 +2,7 @@ module Rscons
   module Builders
     # The Disassemble builder produces a disassembly listing of a source file.
     class Disassemble < Builder
+
       # Return default construction variables for the builder.
       #
       # @param env [Environment] The Environment using the builder.
@@ -28,13 +29,28 @@ module Rscons
       def run(target, sources, cache, env, vars)
         vars = vars.merge("_SOURCES" => sources)
         command = env.build_command("${DISASM_CMD}", vars)
-        unless cache.up_to_date?(target, command, sources, env)
+        if cache.up_to_date?(target, command, sources, env)
+          target
+        else
           cache.mkdir_p(File.dirname(target))
-          return false unless env.execute("Disassemble #{target}", command, options: {out: target})
-          cache.register_build(target, command, sources, env)
+          ThreadedCommand.new(
+            command,
+            short_description: "Disassemble #{target}",
+            system_options: {out: target})
         end
-        target
       end
+
+      # Finalize a build.
+      #
+      # @param options [Hash]
+      #   Finalize options.
+      #
+      # @return [String, nil]
+      #   The target name on success or nil on failure.
+      def finalize(options)
+        standard_finalize(options)
+      end
+
     end
   end
 end