mtbuild 0.0.1

data/bin/mtbuild

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+lib_path_expanded = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+if File.directory?(lib_path_expanded)
+  $:.unshift(lib_path_expanded) unless $:.include?(lib_path_expanded)
+end
+
+require 'mtbuild'
+
+Rake.application.run

data/lib/mtbuild.rb

@@ -0,0 +1,13 @@
+require 'rake'
+
+require "mtbuild/application"
+require "mtbuild/application_project"
+require "mtbuild/application_task"
+require "mtbuild/dsl"
+require "mtbuild/mtbuild"
+require "mtbuild/staticlibrary_project"
+require "mtbuild/staticlibrary_task"
+require "mtbuild/test_application_project"
+require "mtbuild/test_application_task"
+require "mtbuild/version"
+require "mtbuild/workspace"

data/lib/mtbuild/application.rb

@@ -0,0 +1,39 @@
+module Rake
+  class << self
+    # Singleton MTBuild application instance
+    def application
+      @application ||= MTBuild::Application.new
+    end
+  end
+end
+
+module MTBuild
+
+  require 'rake'
+
+  # This subclasses the Rake::Application class only only to inject the MTBuild
+  # version number for display when mtbuild is invoked with the --version flag.
+  class Application < Rake::Application
+
+    # This hijacks the "--version" flag and displays the MTBuild version along
+    # with the Rake version. All other options/flags are returned unmodified.
+    def standard_rake_options
+      return super.map do |opt|
+        if opt.first == '--version'
+          ['--version', '-V',
+            "Display the program version.",
+            lambda { |value|
+              puts "mtbuild, version #{MTBuild::VERSION}"
+              puts "rake, version #{RAKEVERSION}"
+              exit
+            }
+          ]
+        else
+          opt
+        end
+      end
+    end
+
+  end
+
+end

data/lib/mtbuild/application_configuration.rb

@@ -0,0 +1,38 @@
+module MTBuild
+  require 'mtbuild/compiled_configuration'
+
+  # Use this class to create application configurations. You won't typically
+  # instantiate this directly. Instead, the ApplicationProject.add_configuration
+  # method will create this for you.
+	class ApplicationConfiguration < CompiledConfiguration
+
+    # Create the actual Rake tasks that will perform the configuration's work
+    def configure_tasks
+      super
+      all_object_files = []
+      all_object_folders = []
+      @toolchains.each do |toolchain, sources|
+        object_files, object_folders = toolchain.create_compile_tasks(sources)
+        all_object_files |= object_files
+        all_object_folders |= object_folders
+      end
+
+      application_binaries, application_files, application_folders = @default_toolchain.create_application_tasks(all_object_files, @project_name)
+      dependencies = @dependencies+all_object_folders+application_folders+application_files+application_binaries
+
+      desc "Build application '#{@project_name}' with configuration '#{@configuration_name}'"
+      new_task = application_task @configuration_name => dependencies do |t|
+        puts "built application #{t.name}."
+        @tests.each do |test|
+          if Rake::Task.task_defined? test
+            Rake::Task[test].invoke
+          else
+            $stderr.puts "warning: Skipping unknown test '#{test}'"
+          end
+        end
+      end
+    end
+
+	end
+
+end

data/lib/mtbuild/application_project.rb

@@ -0,0 +1,21 @@
+module MTBuild
+  require "mtbuild/application_configuration"
+  require 'mtbuild/project'
+
+  # This class is used to build applications. An application has compilation
+  # and link phases that produce a binary executable.
+	class ApplicationProject < Project
+
+    # Adds a named ApplicationConfiguration to the project.
+    def add_configuration(configuration_name, configuration)
+      super
+      default_configuration = Workspace.configuration_defaults.fetch(configuration_name, {})
+      merged_configuration = Utils.merge_configurations(default_configuration, configuration)
+      cfg = ApplicationConfiguration.new(@project_name, @project_folder, effective_output_folder, configuration_name, merged_configuration)
+      @configurations << cfg
+      return cfg
+    end
+
+	end
+
+end

data/lib/mtbuild/application_task.rb

@@ -0,0 +1,23 @@
+module Rake
+
+  require 'rake'
+
+  # This is a top-level Rake task for creating an application
+  class ApplicationTask < Task
+
+    def initialize(task_name, app)
+      super
+    end
+
+  end
+
+  module DSL
+
+    # DSL method to create an application task.
+    def application_task(*args, &block)
+      new_task = Rake::ApplicationTask.define_task(*args, &block)
+    end
+
+  end
+
+end

data/lib/mtbuild/compiled_configuration.rb

@@ -0,0 +1,73 @@
+module MTBuild
+  require 'mtbuild/configuration'
+  require 'mtbuild/toolchain'
+
+  # This is the base class for configurations representing compiled objects
+  # (libraries, applications, etc.)
+	class CompiledConfiguration < Configuration
+
+    # A list of Rake tasks that this configuration depends upon
+    attr_reader :dependencies
+
+    # A list of source files that will be compiled
+    attr_reader :source_files
+
+    # A list of Rake test tasks that will execute after this configuration builds
+    attr_reader :tests
+
+		def initialize(project_name, project_folder, output_folder, configuration_name, configuration)
+      super
+      check_configuration(configuration)
+
+      @dependencies = configuration.fetch(:dependencies, [])
+      @default_toolchain_config = configuration[:toolchain]
+      @default_toolchain = Toolchain.create_toolchain(@default_toolchain_config)
+
+      source_files = Utils.expand_file_list(configuration.fetch(:sources, []), configuration.fetch(:excludes, []), @project_folder)
+      @toolchains = {@default_toolchain => source_files}
+
+      @tests = Utils.ensure_array(configuration.fetch(:tests, []))
+		end
+
+    # This method adds source files with their own toolchains. Use this method
+    # to add any source files that need special toolchain settings.
+    def add_sources(sources, excludes=[], toolchain_configuration)
+      merged_configuration = Utils.merge_configurations(@default_toolchain_config, toolchain_configuration)
+      toolchain = Toolchain.create_toolchain(merged_configuration)
+      @toolchains[toolchain] = Utils.expand_file_list(sources, excludes, @project_folder)
+    end
+
+    # Create the actual Rake tasks that will perform the configuration's work
+    def configure_tasks
+      super
+      @toolchains.each do |toolchain, sources|
+        toolchain.output_folder = @output_folder
+        toolchain.project_folder = @project_folder
+        toolchain.output_decorator = "-#{@configuration_name}"
+        CompiledConfiguration.add_framework_dependencies_to_toolchain(toolchain, @dependencies)
+      end
+    end
+
+    private
+
+    def check_configuration(configuration)
+      fail "No toolchain specified for #{@project_name}:#{@configuration_name}" if configuration.fetch(:toolchain, nil).nil?
+    end
+
+    def self.add_framework_dependencies_to_toolchain(toolchain, *dependencies)
+      dependencies.each do |dependency|
+        if dependency.respond_to? :to_ary
+          CompiledConfiguration.add_framework_dependencies_to_toolchain(toolchain, *dependency.to_ary)
+        else
+          task_dependency = Rake.application.lookup(dependency)
+          fail "Unable to locate task for dependency: #{dependency}" if task_dependency.nil?
+          toolchain.add_include_paths(task_dependency.api_headers) if task_dependency.respond_to? :api_headers
+          toolchain.add_include_objects(task_dependency.library_files) if task_dependency.respond_to? :library_files
+        end
+      end
+    end
+
+    include Rake::DSL
+	end
+
+end

data/lib/mtbuild/configuration.rb

@@ -0,0 +1,46 @@
+module MTBuild
+
+  require 'mtbuild/versioner'
+
+  # This is the base class for all configuration types.
+	class Configuration
+
+    # The configuration's name
+    attr_reader :configuration_name
+
+    # The name of the project that owns this configuration
+    attr_reader :project_name
+
+    # The project's folder. Relative path references are interpreted as
+    # relative to this folder.
+    attr_reader :project_folder
+
+    # The project's output folder. Project output goes here.
+    attr_reader :output_folder
+
+		def initialize(project_name, project_folder, output_folder, configuration_name, configuration)
+      check_configuration(configuration)
+      @project_name = project_name
+      @project_folder = File.expand_path(project_folder)
+      @configuration_name = configuration_name
+      @output_folder = File.expand_path(File.join(output_folder, @project_name.to_s, @configuration_name.to_s))
+
+      @versioner = nil
+      @versioner_config = configuration.fetch(:versioner, nil)
+      @versioner = Versioner.create_versioner(@project_name, @project_folder, @output_folder, @configuration_name, @versioner_config) unless @versioner_config.nil?
+		end
+
+    # Create the actual Rake tasks that will perform the configuration's work
+    def configure_tasks
+      @versioner.create_version_tasks unless @versioner.nil?
+    end
+
+    private
+
+    def check_configuration(configuration)
+    end
+
+    include Rake::DSL
+	end
+
+end

data/lib/mtbuild/dsl.rb

@@ -0,0 +1,46 @@
+module MTBuild
+
+  module DSL
+
+    # Defines a Workspace
+    def workspace(workspace_name, workspace_folder, &configuration_block)
+      MTBuild::Workspace.new(workspace_name, workspace_folder, &configuration_block)
+    end
+
+    # Defines an ApplicationProject
+    def application_project(application_name, project_folder, &configuration_block)
+      MTBuild::ApplicationProject.new(application_name, project_folder, &configuration_block)
+    end
+
+    # Defines a StaticLibraryProject
+    def static_library_project(library_name, project_folder, &configuration_block)
+      MTBuild::StaticLibraryProject.new(library_name, project_folder, &configuration_block)
+    end
+
+    # Defines a TestApplicationProject
+    def test_application_project(application_name, project_folder, &configuration_block)
+      MTBuild::TestApplicationProject.new(application_name, project_folder, &configuration_block)
+    end
+
+    # Defines a Toolchain
+    def toolchain(toolchain_name, toolchain_configuration={})
+      fail "error: the toolchain configuration is expected to be a hash." unless toolchain_configuration.is_a? Hash
+      toolchain_configuration[:name] = toolchain_name
+      return toolchain_configuration
+    end
+
+    # Defines a Versioner
+    def versioner(versioner_name, versioner_configuration={})
+      fail "error: the version file configuration is expected to be a hash." unless versioner_configuration.is_a? Hash
+      versioner_configuration[:name] = versioner_name
+      return versioner_configuration
+    end
+
+  end
+
+end
+
+# Extend the main object with the DSL commands. This allows top-level calls to
+# workspace, application_project, etc. to work from a Rakefile without
+# polluting the object inheritance tree.
+self.extend MTBuild::DSL

data/lib/mtbuild/mtbuild.rb

@@ -0,0 +1,10 @@
+module MTBuild
+
+  @default_output_folder = 'build'
+
+  # This returns the default name that MTBuild uses for the build output folder
+  def self.default_output_folder
+    return @default_output_folder
+  end
+
+end

data/lib/mtbuild/project.rb

@@ -0,0 +1,71 @@
+module MTBuild
+
+  # This is the base class for all project types.
+	class Project
+
+    # The project's name
+    attr_reader :project_name
+
+    # The project's folder. Relative path references are interpreted as
+    # relative to this folder.
+    attr_reader :project_folder
+
+    # The project's output folder. Project output goes here.
+    attr_reader :output_folder
+
+    # If supplied, the configuration_block will be passed the
+    # newly-constructed Project object.
+		def initialize(project_name, project_folder, &configuration_block)
+      @configurations = []
+      @default_tasks = []
+      @project_name = project_name
+      @project_folder = File.expand_path(project_folder)
+      @output_folder = File.expand_path(File.join(@project_folder, MTBuild.default_output_folder))
+			configuration_block.call(self) if configuration_block
+
+      namespace @project_name do
+        @configurations.each do |configuration|
+          configuration.configure_tasks()
+        end
+      end
+
+      # If there is no active workspace, set up any registered default project tasks
+      task :default => @default_tasks unless Workspace.have_workspace?
+		end
+
+    # Add tasks to be built by default if MTBuild is invoked with no arguments
+    def add_default_tasks(default_tasks)
+      @default_tasks |= Utils.ensure_array(default_tasks).flatten
+    end
+
+    # Set the project's output folder.
+    def set_output_folder(output_folder)
+      @output_folder = File.expand_path(File.join(@project_folder, output_folder))
+    end
+
+    # Returns the effective output folder. If a workspace exists, this will
+    # return the workspace's output folder. If not, it will return the
+    # project's output folder.
+    def effective_output_folder
+      if Workspace.have_workspace?
+        relative_project_location = Utils::path_difference(Workspace.workspace.workspace_folder, @project_folder)
+        fail "Project folder '#{@project_folder}' must be within workspace folder '#{Workspace.workspace.workspace_folder}'." if relative_project_location.nil?
+        return File.join(Workspace.workspace.output_folder, relative_project_location)
+      else
+        return @output_folder
+      end
+    end
+
+    private
+
+    def add_configuration(configuration_name, configuration)
+    end
+
+    def create_configuration_tasks(configuration_name, configuration)
+      check_configuration(configuration_name, configuration)
+    end
+
+    include Rake::DSL
+	end
+
+end

data/lib/mtbuild/staticlibrary_configuration.rb

@@ -0,0 +1,49 @@
+module MTBuild
+  require 'mtbuild/compiled_configuration'
+
+  # Use this class to create static library configurations. You won't typically
+  # instantiate this directly. Instead, the StaticLibraryProject.add_configuration
+  # method will create this for you.
+	class StaticLibraryConfiguration < CompiledConfiguration
+
+    # API header location for the static library
+    attr_reader :api_headers
+
+    def initialize(project_name, project_folder, output_folder, configuration_name, configuration)
+      super
+      @api_headers = Utils.expand_folder_list(configuration.fetch(:api_headers, []), @project_folder)
+    end
+
+    # Create the actual Rake tasks that will perform the configuration's work
+    def configure_tasks
+      super
+      all_object_files = []
+      all_object_folders = []
+      @toolchains.each do |toolchain, sources|
+        toolchain.add_include_paths(@api_headers)
+        object_files, object_folders = toolchain.create_compile_tasks(sources)
+        all_object_files |= object_files
+        all_object_folders |= object_folders
+      end
+
+      library_files, library_folders = @default_toolchain.create_static_library_tasks(all_object_files, @project_name)
+      dependencies = @dependencies+all_object_folders+library_folders+library_files
+
+      desc "Build library '#{@project_name}' with configuration '#{@configuration_name}'"
+      new_task = static_library_task @configuration_name => dependencies do |t|
+        puts "built library #{t.name}."
+        @tests.each do |test|
+          if Rake::Task.task_defined? test
+            Rake::Task[test].invoke
+          else
+            $stderr.puts "warning: Skipping unknown test '#{test}'"
+          end
+        end
+      end
+      new_task.api_headers = @api_headers
+      new_task.library_files = library_files
+    end
+
+	end
+
+end