mtbuild 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b0c1036197b946ec76fce626e6318b9ce62c6b5
-  data.tar.gz: f0abf5f39b31506c0a855919937147348540f246
+  metadata.gz: 77ba725a664618bcc037519e8c8181b2560427f6
+  data.tar.gz: b6414488ebf9691a4a0a523b2d116571049a1039
 SHA512:
-  metadata.gz: b88fcc23e4ffc42f9abc717eec9fc2d66381fa1f98815a168a25589afa2d9d14caa7f010f3305edfccaa3689010c17673687ef6bdbb6fd1fb72a8ae774987eaf
-  data.tar.gz: a270534effc8dc2d446beb07b638e55eca8a1e8ef56519458aacf4f3f90224ec53a1bfb8de9bd2c53297a075f33ba9f51b30488903438f46cf2ad142907e76fc
+  metadata.gz: 347ca6affd9f88b736f20e190d9d59a191f5251fe5b431ab0ffb1b062bf6c9bf26a21abfc4643e6f07378aafce2dbc6acd8c53408a77f3efcddfca031c26f8e2
+  data.tar.gz: 9abc4e0a9a2b7dd6f6d8af1029d79a37cd730b604b74fc228e85054979922ac315e0550582dd549931fafadb0af9e515765a03ea84aab4428bc53260125f8b91

data/CHANGES.md

@@ -0,0 +1,23 @@
+# Release Notes #
+
+## MTBuild 0.0.3 ##
+
+### Changes ###
+
+* MTBuild now supports configuration headers in static library and framework projects.
+
+
+## MTBuild 0.0.2 ##
+
+### Changes ###
+
+* MTBuild now supports Frameworks.
+
+* MTBuild can now create applications packages and can build framework packages from static library projects.
+
+
+## MTBuild 0.0.1 ##
+
+### Changes ###
+
+None. This is the first release.

data/README.md

@@ -241,10 +241,16 @@ Configurations can list dependencies that will be built before the configuration
 
 #### Automatic Library Dependencies ####
 
-MTBuild library projects allow you to specify API header locations for framework and static library project configurations. If you list a framework or a static library project as a dependency of an application project, MTbuild will automatically include the framework or library's API header paths when compiling the application. Additionally, it will automatically link the application with the framework or library. This is intended to facilitate the scenario where you're building both a library and an application from a Workspace. To use the library from the application, you simply need to list the library as a dependency and MTBuild will make sure the application can use it.
+MTBuild allows you to specify API header locations for framework and static library project configurations. If you list a framework or a static library project as a dependency of an application project, MTbuild will automatically include the framework or library's API header paths when compiling the application. Additionally, it will automatically link the application with the framework or library. This is intended to facilitate the scenario where you're building both a library and an application from a Workspace. To use the library from the application, you simply need to list the library as a dependency and MTBuild will make sure the application can use it.
 
 Note that this does not work with non-MTBuild libraries. If you list a non-MTBuild Rake library task as a dependency of a MTBuild project, you will need to manually add the library's headers and library file to the project. If you have a precompiled 3rd-party library, you might consider wrapping it in a framework project so that you can use the Automatic Library Dependencies mechanism.
 
+###### Configuration Headers #####
+
+In addition to the per-project API header location, MTBuild allows you to specify per-configuration header locations. These are intended for headers that "configure" a library--typically via ```#define```. Note that this is a terrible pattern. If you're creating your own library, try very hard not to do this. For example, instead of using a ```#define``` to configure a library resource such as a buffer size, consider structuring the library such that the caller passes in buffer storage.
+
+Using configuration headers to configure libraries is such a bad idea that MTBuild almost didn't support them. Unfortunately, the pattern is so common that we felt we needed to support them in order to work properly with many 3rd-party libraries. Again, if you're writing a library, avoid using them.
+
 ###### Automatic Library Dependencies Example #####
 
 Top-level Rakefile.rb:
@@ -260,14 +266,15 @@ end
 
 MyLibrary/Rakefile.rb
 
-This defines a library with one configuration called "Debug". The library's API headers are in a folder called "include".
+This defines a library with one configuration called "Debug". The library's API headers are in a folder called "include". This library is foul and therefore has configuration headers for the Debug configuration in a folder called "config/Debug".
 
 ```Ruby
 static_library_project :MyLibrary, File.dirname(__FILE__) do |lib|
   lib.add_api_headers 'include'
   lib.add_configuration :Debug,
     sources: ['src/**/*.c'],
-    toolchain: toolchain(:gcc)
+    toolchain: toolchain(:gcc),
+    configuration_headers: ['config/Debug']
 end
 ```
 
@@ -390,7 +397,7 @@ Application Project configurations require the following settings:
 
 Application Project configurations offer the following optional settings:
 
-* ```:dependencies``` - The Rake task names of one or more dependencies. For example, For example, ```'MyLibrary:Debug'``` or ```['MyLibrary1:Debug', 'MyLibrary2:Debug']```
+* ```:dependencies``` - The Rake task names of one or more dependencies. For example, ```'MyLibrary:Debug'``` or ```['MyLibrary1:Debug', 'MyLibrary2:Debug']```
 
 * ```:sources``` - One or more source file names or source file glob patterns. For example, ```'main.c'``` or ```['main.c', 'startup.c']``` or ```['src/main.c', 'src/*.cpp']```. Note that the source file paths should be relative to the project folder.
 
@@ -434,6 +441,10 @@ Use ```build_framework_package(configuration_names)``` inside of a static librar
 ##### Static Library Project configuration settings #####
 Static Library Project configurations use the same settings as Application Project configurations.
 
+Additionally, Static Library Project configurations offer the following optional settings:
+
+* ```:configuration_headers``` - One or more configuration header paths. For example, ```'config/Debug'``` or ```['config/Debug', 'config/common']```.
+
 ### MTBuild::TestApplicationProject ###
 Define a Test Application Project with the following DSL method:
 
@@ -474,12 +485,14 @@ Use ```add_configuration(configuration_name, configuration)``` inside of a frame
 Use ```add_api_headers(api_headers)``` inside of a framework project configuration block--before adding configurations--to set the location(s) of the framework's API headers. The ```api_headers``` parameter should be one or more API header paths. For example, ```'include'``` or ```['include', 'plugins']```. Note that the API header paths should be relative to the project folder. API header paths should NOT contain one another. For example, do not do this: ```['include', 'include/things']```. You can have subfolders inside of an API header location, but you should only add the topmost folder.
 
 ##### Framework Project configuration settings #####
-Framework Project configurations use the same settings as Application Project configurations.
-
-Additionally, Framework Project configurations require the following settings:
+Framework Project configurations require the following settings:
 
 * ```:objects``` - One or more framework object files. For example, ```'MyLibrary.a'```
 
+Framework Project configurations offer the following optional settings:
+
+* ```:configuration_headers``` - One or more configuration header paths. For example, ```'config/Debug'``` or ```['config/Debug', 'config/common']```.
+
 ### MTBuild::Toolchain ###
 Define a Toolchain with the following DSL method:
 

data/lib/mtbuild/compiled_configuration.rb

@@ -62,6 +62,7 @@ module MTBuild
           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_paths(task_dependency.configuration_headers) if task_dependency.respond_to? :configuration_headers
           toolchain.add_include_objects(task_dependency.library_files) if task_dependency.respond_to? :library_files
         end
       end

data/lib/mtbuild/framework_configuration.rb

@@ -9,8 +9,9 @@ module MTBuild
     def initialize(project_name, project_folder, output_folder, configuration_name, configuration, api_headers)
       super project_name, project_folder, output_folder, configuration_name, configuration
       check_configuration(configuration)
-      @object_files = Utils.expand_file_list(configuration[:objects], [], @project_folder)
       @api_headers = api_headers
+      @configuration_headers = Utils.expand_folder_list(configuration.fetch(:configuration_headers, []), @project_folder)
+      @object_files = Utils.expand_file_list(configuration[:objects], [], @project_folder)
     end
 
     # Create the actual Rake tasks that will perform the configuration's work
@@ -21,6 +22,7 @@ module MTBuild
         puts "found framework #{t.name}."
       end
       new_task.api_headers = @api_headers
+      new_task.configuration_headers = @configuration_headers
       new_task.library_files = @object_files
     end
 

data/lib/mtbuild/framework_task.rb

@@ -8,13 +8,17 @@ module Rake
     # API header location for the framework
     attr_accessor :api_headers
 
+    # Configuration header location for the framework
+    attr_accessor :configuration_headers
+
     # The framework objects
     attr_accessor :library_files
 
     def initialize(task_name, app)
       super
-      @api_headers = ''
-      @library_files = ''
+      @api_headers = []
+      @configuration_headers = []
+      @library_files = []
     end
 
   end

data/lib/mtbuild/organized_package_task.rb

@@ -52,9 +52,10 @@ module MTBuild
     end
 
     # Add folder to a folder in the package
-    def add_folders_to_folder(package_folder, folders, excluded_files=[])
+    def add_folders_to_folder(package_folder, folders, included_files=['*'], excluded_files=[])
       folders.each do |folder|
-        file_list = Utils.expand_file_list('/**/*', excluded_files, folder)
+        included_files = Utils.ensure_array(included_files).collect{|f| File.join('**',f)}
+        file_list = Utils.expand_file_list(included_files, excluded_files, folder)
         package_file_list = file_list.collect{ |f| File.join(package_dir_path, package_folder, get_relative_path(folder,f)) }
         @origin_files += file_list
         @destination_files += package_file_list

data/lib/mtbuild/staticlibrary_configuration.rb

@@ -9,6 +9,7 @@ module MTBuild
     def initialize(project_name, project_folder, output_folder, configuration_name, configuration, api_headers)
       @api_headers = api_headers
       super project_name, project_folder, output_folder, configuration_name, configuration
+      @configuration_headers = Utils.expand_folder_list(configuration.fetch(:configuration_headers, []), @project_folder)
     end
 
     # Create the actual Rake tasks that will perform the configuration's work
@@ -17,7 +18,7 @@ module MTBuild
       all_object_files = []
       all_object_folders = []
       @toolchains.each do |toolchain, sources|
-        toolchain.add_include_paths(@api_headers)
+        toolchain.add_include_paths(@api_headers+@configuration_headers)
         object_files, object_folders = toolchain.create_compile_tasks(sources)
         all_object_files |= object_files
         all_object_folders |= object_folders
@@ -38,6 +39,7 @@ module MTBuild
         end
       end
       new_task.api_headers = @api_headers
+      new_task.configuration_headers = @configuration_headers
       new_task.library_files = library_files
     end
 

data/lib/mtbuild/staticlibrary_project.rb

@@ -47,9 +47,10 @@ module MTBuild
             configuration_name = "#{@project_name}:#{framework_configuration}"
             configuration_task = Rake.application.lookup(configuration_name)
             fail "Unable to locate configuration: #{configuration_name}" if configuration_task.nil?
-            fail "Configuration is not a library configuration: #{configuration_name}" unless configuration_task.respond_to? :library_files
+            fail "Configuration is not a library configuration: #{configuration_name}" unless configuration_task.respond_to? :library_files and configuration_task.respond_to? :configuration_headers
 
             t.add_files_to_folder("Libraries/#{framework_configuration}", configuration_task.library_files)
+            t.add_folders_to_folder("Config/#{framework_configuration}", configuration_task.configuration_headers) unless configuration_task.configuration_headers.empty?
           end
         end
 
@@ -65,6 +66,7 @@ module MTBuild
               configuration_name = "#{@project_name}:#{framework_configuration}"
               configuration_task = Rake.application.lookup(configuration_name)
               f.puts("  lib.add_configuration :#{framework_configuration},")
+              f.puts("    configuration_headers: ['Config/#{framework_configuration}'],") unless configuration_task.configuration_headers.empty?
               f.puts("    objects: ['Libraries/#{framework_configuration}/*']")
             end
             f.puts("end")

data/lib/mtbuild/staticlibrary_task.rb

@@ -8,13 +8,17 @@ module Rake
     # API header location for the static library
     attr_accessor :api_headers
 
+    # Configuration header location for the static library
+    attr_accessor :configuration_headers
+
     # The static library output file(s)
     attr_accessor :library_files
 
     def initialize(task_name, app)
       super
-      @api_headers = ''
-      @library_files = ''
+      @api_headers = []
+      @configuration_headers = []
+      @library_files = []
     end
 
   end

data/lib/mtbuild/version.rb

@@ -1,4 +1,4 @@
 module MTBuild
   # The current MTBuild version.
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtbuild
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jerry Ryle
@@ -128,6 +128,7 @@ files:
 - lib/mtbuild/versioners/mt_std_version.rb
 - lib/mtbuild/workspace.rb
 - lib/mtbuild.rb
+- CHANGES.md
 - LICENSE.md
 - README.md
 homepage: https://github.com/MindTribe/MTBuild