bake 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,6 +1,28 @@
 = Bake Changelog
 
-== Version 0.1.1
+== Version 0.1.2 (2007-05-17)
+
+* Implemented Target#products which returns the set of output files generated by the target
+* Using Target#products, implemented Target#stale? and Target#mtime in a general way
+* Moved C++ include file detection into IncludeList class which is now a dependency of all Cpp::Source
+* Created a Runner target class which can be used to run any commands, not just C++ executables
+* Added simple circular dependency detection during build phase
+* Implemented Target#to_s for more consistent error messages
+* Dependency resolution now uses :search_projects property to resolve unqualified target references (which always includes the current project)
+* Libraries and executables no longer re-link to changed dynamic libraries unless they are forced to by an altered header dependency
+* Target subclass initialization is now done via the post_initialization method, making the initialization methods much simpler
+* All target constructors now support a properties hash which initializes the given properties before post_initialization
+* Added Project#map method which maps target names to fully qualified dir:name paths
+* Implemented post-build dependencies which are built after their dependents are built (useful for unit tests)
+* Fixed QT Moc support
+* Trashed Configuration#req and associated "requirements" functionality as it proved not very useful
+* Major overhaul of plugin support, plugins are now searched for in any directories given in :plugin_paths
+* Moved all Ruby core class extensions into the bake/extensions directory
+* Toolsets now use a +SystemUtils+ instance for doing all file and shell operations
+* Introduced --dry-run and --verbose command line parameters
+* Dumped all the old useless unit tests (they will be re-introduced for 2.0)
+
+== Version 0.1.1 (2007-05-02)
 
 * Created a plugin infrastructure whereby missing constants now result in a search of the plugins/ directory
 * Implemented Addon module which enables adding commands to bakefile contexts via the import method

data/CONCEPTS

@@ -30,9 +30,9 @@ Targets are related to each other by two relations. The first is the parent-chil
 
 Before a particular target is built, there are zero or more dependencies that must be built first. If any of the dependencies fails to build, the target will fail to be built.
 
-Dependencies have two roles for a target. First, partially determine the order in which targets will be built as outlined above. Second, their products are used by dependent target to build its products. For example, an executable target may depend on a the functionality available in a library and thus it must link against that library.
+Dependencies have two roles for a target. First, to partially determine the order in which targets will be built as outlined above. Second, their products are used by dependent targets to build its products. For example, an executable target may depend on the functionality available in a library and thus it must link against that library.
 
-=== Options
+=== Properties
 
 === Requirements
 

data/TUTORIAL

@@ -11,6 +11,8 @@ Once you've installed Bake, you should be able to execute it by running the <tt>
       dep 'main.cpp'
   end
 
+  dep 'test'
+
 The <tt>exe</tt> command specifies that we'd like to create an executable <b>target</b>. A target is any product that gets created as a result of the build process. There are many kinds of targets, such as <tt>lib</tt>s, or C++ libraries, etc. To make this example a little more concrete, let's also create <i>main.cpp</i>:
 
   // main.cpp
@@ -27,7 +29,7 @@ Both these files should be in the same directory, call it <i>test/</i>. The layo
     root.bake
     main.cpp
 
-If you run <tt>bake</tt> from the <i>test/</i> directory you should see output resembling "<tt>root.bake:1: undefined symbol 'exe'</tt>". The reason for this is that we have not specified what <b>tooset</b> we will be using to build C++ targets. Bake supports a number of C++ toolsets (consult the Reference for full details) and each toolset should treat our test project identically, so which toolset you use should not matter. For the purposes of this example, I'll use the <tt>gcc</tt> toolset.
+If you run <tt>bake</tt> from the <i>test/</i> directory you should see output resembling "<tt>root.bake:1: unknown command 'exe'</tt>". The reason for this is that we have not specified what <b>tooset</b> we will be using to build C++ targets. Bake supports a number of C++ toolsets (consult the Reference for full details) and each toolset should treat our test project identically, so which toolset you use should not matter. For the purposes of this example, I'll use the <tt>gcc</tt> toolset.
 
 === The <tt>using</tt> Directive
 
@@ -49,6 +51,8 @@ Unfortunately, the <i>test</i> executable will probably be accompanied by a numb
       dep 'main.cpp'
   end
 
+  dep 'test'
+
 Note that property names are <b>symbols</b> preceded by a colon (:) whereas, in this case, the property value is a <b>string</b>. Property values can be any of a number of different types such as strings, booleans, numbers, etc.
 
 Delete all the product files generated by the last build so that your directory structure looks like:
@@ -83,12 +87,12 @@ As a first try at managing this project, let's create a <i>root.bake</i> in the
   end
 
   exe 'test_exe' do
-      dep '.:test_lib', 'test_exe/source1.cpp'
+      dep 'test_lib', 'test_exe/source1.cpp'
   end
 
-Here we have created a <tt>lib</tt> target called <tt>test_lib</tt> containing two source files, and an executable file that depends on the library and another source file. This is pretty simple and will probably seem to work, however, there's an insidious bug waiting to cause trouble when you least expect it. Note that there are two files called <i>source1.cpp</i>. In each case, a C++ object file called <i>source1.o</i> (or <i>source1.obj</i> on Windows) will be created in the <i>test2/</i> directory, the object file from <tt>test_exe</tt> will overwrite the object file from <tt>test_lib</tt>. This will not immediately cause a problem, since the library object file was added to the library before the executable object file was created but it will almost certainly cause problems later on.
+  dep 'test_exe'
 
-Note also the funny way we've referenced the <tt>test_lib</tt> library. Every target reference is composed of two parts: the path to the target's project and the name of the target, separated by a colon. Since the <tt>test_lib</tt> library is in the same directory as the executable the path part of the reference is simply a '.'.
+Here we have created a <tt>lib</tt> target called <tt>test_lib</tt> containing two source files, and an executable file that depends on the library and another source file. This is pretty simple and will probably seem to work, however, there's an insidious bug waiting to cause trouble when you least expect it. Note that there are two files called <i>source1.cpp</i>. In each case, a C++ object file called <i>source1.o</i> (or <i>source1.obj</i> on Windows) will be created in the <i>test2/</i> directory, the object file from <tt>test_exe</tt> will overwrite the object file from <tt>test_lib</tt>. This will not immediately cause a problem, since the library object file was added to the library before the executable object file was created but it will almost certainly cause problems later on.
 
 === More About Properties
 
@@ -103,18 +107,20 @@ The easiest way to avoid conflicts where output files overwrite eachother is to
 
   exe 'test_exe' do
       opt :name => 'test_exe'
-      dep '.:test_lib', 'test_exe/source1.cpp'
+      dep 'test_lib', 'test_exe/source1.cpp'
   end
 
-If you run Bake now, the outputs from <tt>test_lib</tt> will end up in <i>test2/bin/test_lib/</i> and the outputs from <tt>test_exe</tt> will end up in <i>test2/bin/test_exe</i>. If you're confused, don't worry, we've taken two steps forward here. Not only is the value of the <tt>:outdir</tt> property not explicitly set on either target, but it's out in no-man's land, what gives? Furthermore, what's up with the <tt>${projname}</tt> business?
+  dep 'test_exe'
+
+If you run Bake now, the outputs from <tt>test_lib</tt> will end up in <i>test2/bin/test_lib/</i> and the outputs from <tt>test_exe</tt> will end up in <i>test2/bin/test_exe</i>. If you're confused, don't worry, we've taken two steps forward here. Not only is the value of the <tt>:outdir</tt> property not explicitly set on either target, but it's out in no-man's land, what gives? Furthermore, what's up with the <tt>${name}</tt> business?
 
 The answer to the first question is related to an important fact about targets: they are tree-like. Every target (except the root target, which we'll get into later) has a single parent target, and many targets have child targets. So what target is the parent of <tt>test_lib</tt> and <tt>test_exe</tt>? An implicit <b>project</b> target that is created when <i>root.bake</i> is processed. Therefore, the <tt>opt</tt> command is being executed on the implicit project target and so <tt>:outdir</tt> is set for the project.
 
 Furthermore, properties are inherited. So if a property is explicitly defined for a parent target but is not explicitly defined for the child, then the property for the child is the same as that for the parent. Properties can be overridden by explicitly using the <tt>opt</tt> command on the child, in which case the parent's property value will be ignored.
 
-So in the example above, the <tt>:outdir</tt> property is inherited by the <tt>test_lib</tt> and <tt>test_exe</tt> targets as <tt>'bin/${projname}'</tt>.
+So in the example above, the <tt>:outdir</tt> property is inherited by the <tt>test_lib</tt> and <tt>test_exe</tt> targets as <tt>'bin/${name}'</tt>.
 
-The answer to the second question is even simpler. String property values are dynamic. Any <tt>${...}</tt> tokens found in the string will be evaluated when the property is queried. In addition, it will be queried in the context of the target being queried, not the target where the property was originally defined. So when the GCC toolset builds <tt>test_lib</tt> and <tt>test_exe</tt>, it will query the <tt>:outdir</tt> property on each target and it will evaluate to <tt>'bin/test_lib'</tt> and <tt>'bin/test_exe'</tt> respectively.
+The answer to the second question is even simpler. String property values are dynamic. Any <tt>${...}</tt> tokens found in the string will be evaluated when the property is queried. In addition, it will be queried in the context of the target being queried, not the target where the property was originally defined. So when the GCC toolset builds <tt>test_lib</tt> and <tt>test_exe</tt>, it will query the <tt>:outdir</tt> property on each target and it will evaluate to <tt>'bin/test_lib'</tt> and <tt>'bin/test_exe'</tt> respectively since we've defined the <tt>:name</tt> property for each appropriately.
 
 === Modular Bakefiles
 

data/lib/bake.rb

@@ -1,7 +1,8 @@
+require 'bake/extensions'
 require 'bake/context'
 require 'bake/project_loader'
-require 'bake/string_utils'
 require 'bake/plugin'
+require 'bake/system_utils'
 require 'bake_version'
 require 'optparse'
 
@@ -22,8 +23,6 @@ module Bake
         def initialize
             raise "App instance already created" if @@instance
             @@instance = self
-            @context = Context.new
-            @context.import(Plugins::System, Plugins::Macro)
         end
 
         def run(*args)
@@ -31,9 +30,14 @@ module Bake
             props, targets = process_excess_args(*args)
             props[:platform] = determine_platform
 
+            sys = SystemUtils.new(:verbose => options[:verbose],
+                :dry_run => options[:dry_run])
+            @context = Context.new(sys)
+            # must execute this in context so that plugins are loaded properly
+            @context.context_eval(nil, 'import System, Macro')
             @project_loader = ProjectLoader.new(@context, Dir.pwd, props)
             targets = targets.collect do |name|
-                target = @project_loader.invok_project.find(name)
+                target = @project_loader.invok_project.resolve(name)
                 if !target
                     raise CommandLineParseError,
                         "could not find target '#{name}'"
@@ -41,7 +45,7 @@ module Bake
                 target
             end
 
-            method = options[:clean] ? :clean : :build
+            method = options[:clean] ? :clean_r : :build_r
             if targets.empty?
                 @project_loader.invok_project.send(method)
             else
@@ -68,7 +72,13 @@ module Bake
                 opts.on('--clean', 'Clean the given targets') do |clean|
                     options[:clean] = clean
                 end
-                opts.on_tail('-h', '--help', 'Show usage') do
+                opts.on('-n', '--dry-run', 'Do not update targets') do |dr|
+                    options[:dry_run] = dr
+                end
+                opts.on('--verbose', 'Verbose output') do |verbose|
+                    options[:verbose] = verbose
+                end
+                opts.on_tail('-h', '--help', 'Display usage message') do
                     raise ProgramInfoRequested, opts
                 end
                 opts.on_tail('--version', 'Show version information') do
@@ -114,6 +124,7 @@ exit_code = 1
 begin
     app = Bake::App.new
     app.run(*ARGV)
+    puts 'build successful'
     exit_code = 0
 rescue Bake::ProgramInfoRequested => e
     puts e.message
@@ -122,6 +133,7 @@ rescue Bake::CommandLineParseError => e
     puts e.message
 rescue Exception => e
     puts parse_backtrace(e.backtrace) + ': ' + e.message
+    puts 'build failed'
 end
 
 exit(exit_code)

data/lib/bake/configuration.rb

@@ -1,9 +1,6 @@
 module Bake
-    class PropertyNotFoundException < RuntimeError
-    end
-
-    class TemplateEvaluationException < RuntimeError
-    end
+    class PropertyNotFoundException < RuntimeError; end
+    class TemplateEvaluationException < RuntimeError; end
 
     module Configuration
         def has_prop?(key)
@@ -24,34 +21,29 @@ module Bake
                 cfg = self
                 opts = []
                 while cfg
-                    vals = cfg.options[key]
-                    opts.concat(vals.collect { |val| value_of(val) }) if vals
+                    if cfg.options.has_key?(key)
+                        cfg.options[key].each { |val| opts << value_of(val) }
+                    end
                     cfg = cfg.parent
                 end
                 return opts
             else
                 cfg = self
-                opt = default = nil
-                found_opt = found_default = false
+                default = nil
+                found_default = false
                 while cfg
-                    if cfg.requirements.has_key?(key)
-                        return value_of(cfg.requirements[key])
+                    if cfg.options.has_key?(key)
+                        return value_of(cfg.options[key])
                     end
-                    if !found_opt
-                        if cfg.options.has_key?(key)
-                            opt = cfg.options[key]
-                            found_opt = true
-                        elsif !found_default && cfg.defaults.has_key?(key)
-                            default = cfg.defaults[key]
-                            found_default = true
-                        end
+                    if !found_default && cfg.defaults.has_key?(key)
+                        default = cfg.defaults[key]
+                        found_default = true
                     end
                     cfg = cfg.parent
                 end
-                if found_opt
-                    return value_of(opt)
-                elsif found_default
-                    return value_of(default)
+                if found_default
+                    val = value_of(default)
+                    return val
                 end
                 raise PropertyNotFoundException, "no such property '#{key}'"
             end
@@ -81,21 +73,6 @@ module Bake
             end
         end
 
-        def req(prop)
-            key, val = key_val(prop)
-            raise 'no multivalue requirements' if multival(key)
-            cfg = self
-            while cfg
-                req = cfg.requirements[key]
-                if req
-                    raise 'conflicting requirements' if req != val
-                    break
-                end
-                cfg = cfg.parent
-            end
-            requirements[key] = val
-        end
-
         def default(prop)
             key, val = key_val(prop)
             raise 'no multivalue defaults' if multival(key)
@@ -107,17 +84,12 @@ module Bake
             return @options ||= {}
         end
 
-        def requirements
-            return @requirements ||= {}
-        end
-
         def defaults
             return @defaults ||= {}
         end
 
         def has_prop_impl(key)
-            return requirements.has_key?(key) ||
-                options.has_key?(key) ||
+            return options.has_key?(key) ||
                 defaults.has_key?(key)
         end
 

data/lib/bake/context.rb

@@ -1,18 +1,28 @@
-require 'bake/string_utils.rb'
-require 'bake/addon.rb'
+require 'bake/addon'
+require 'bake/plugin'
 
 module Bake
     class Context
-        attr_reader :current
+        include PluginManager
 
-        def initialize
+        DEFAULT_SEARCH_DIR = File.join(File.dirname(__FILE__), '..')
+
+        attr_reader :current, :default_toolset
+
+        def initialize(sys)
+            @sys = sys
             @current = nil
-            @commands = { }
+            @commands = {}
+            @default_toolset = Toolset.new(@sys)
         end
 
         def import(*addon_classes)
             addon_classes.each do |addon_class|
-                addon = addon_class.new
+                if addon_class.inherits?(Toolset)
+                    addon = addon_class.new(@sys)
+                else
+                    addon = addon_class.new
+                end
                 addon.commands.each_pair do |name, block|
                     register(name, &block)
                 end
@@ -21,8 +31,12 @@ module Bake
 
         def using(*addon_classes)
             addon_classes.each do |addon_class|
-                addon = addon_class.new
-                @current.opt(:addons => addon_class.new)
+                if addon_class.inherits?(Toolset)
+                    addon = addon_class.new(@sys)
+                else
+                    addon = addon_class.new
+                end
+                @current.opt(:addons => addon)
             end
         end
 
@@ -31,6 +45,11 @@ module Bake
         end
 
         def context_eval(target, str = nil, file = nil, &block)
+            context = Thread.current[:bake_context]
+            if !context.nil? && !context.equal?(self)
+                raise 'multiple overlapping contexts detected'
+            end
+            Thread.current[:bake_context] = self
             old = @current
             begin
                 @current = target
@@ -41,9 +60,16 @@ module Bake
                 end
             ensure
                 @current = old
+                Thread.current[:bake_context] = nil
             end
         end
 
+        def search_dirs
+            search_dirs = [ DEFAULT_SEARCH_DIR ]
+            return search_dirs if !@current
+            return search_dirs + @current[:plugin_paths]
+        end
+
         def method_missing(name, *args, &block)
             command = @commands[name]
             return call(command, *args, &block) if command
@@ -51,7 +77,7 @@ module Bake
                 if @current.respond_to?(name)
                     return @current.send(name, *args, &block)
                 end
-                @current.get(:addons).each do |addon|
+                @current[:addons].each do |addon|
                     command = addon.commands[name]
                     return call(command, *args, &block) if command
                 end
@@ -59,6 +85,12 @@ module Bake
             raise "unknown command '#{name}'"
         end
 
+        def self.const_missing(name)
+            context = Thread.current[:bake_context]
+            return super if !context
+            context.load_plugin("Bake::Plugins::#{name}")
+        end
+
     private
         def call(command, *args, &block)
             args << block if block

data/lib/bake/extensions.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), 'extensions', '*.rb')].each do |file|
+    require 'bake/extensions/' + File.basename(file, '.rb')
+end

data/lib/bake/extensions/class.rb

@@ -0,0 +1,11 @@
+class Class
+    # Returns true if +self+ inherits from +ancestor+
+    def inherits?(ancestor)
+        sup = self
+        while sup
+            return true if sup.equal?(ancestor)
+            sup = sup.superclass
+        end
+        return false
+    end
+end

data/lib/bake/extensions/object.rb

@@ -0,0 +1,22 @@
+class Object
+    # If +self+ is nil, returns a zero-length array, otherwise, if +self+
+    # responds to the +to_ary+ method, returns +to_ary+. Otherwise, returns
+    # an array of length one containing +self+.
+    def make_array
+        if nil?
+            return []
+        elsif respond_to?(:to_ary)
+            return to_ary
+        end
+        return [ self ]
+    end
+
+    # Returns the singleton class for this object's class.
+    def metaclass
+        return class << self; self; end
+    end
+end
+
+main = self
+Object.metaclass.send(:define_method, :main_object) { main }
+Object.metaclass.send(:public, :main_object)

data/lib/bake/{string_utils.rb → extensions/string.rb}

@@ -20,4 +20,3 @@ class String
         return gsub(/([a-z0-9])([A-Z])/) { |val| $1 + '_' + $2 }.downcase
     end
 end
-

data/lib/bake/file_target.rb

@@ -4,11 +4,16 @@ module Bake
     class FileTarget < Target
         attr_reader :path
 
-        def initialize(parent, path)
-            super(parent, nil)
+        def post_initialize(path)
             @path = path
             @built = true
         end
+
+        def mtimes
+            raise "file no longer exists '#{path}'" if !File.exists?(path)
+            return [ File.mtime(path) ]
+        end
+
+        alias :id :path
     end
 end
-