[Core] Fixes #228. Added Bam.Core.Module.ClosingPatch. This is a patch using the same delegate as a private patch, but is guaranteed to be executed after all other patches, i.e. so that the Module's Settings object is in its final state (i.e. just before the settings are converted to a command line or project file). Only a single closing patch is possible per module. This allows some logic on the final settings to be evaluated, such as to set a macro to be used in other TokenizedStrings (since they are expanded after patches are evaluated), or to modify a setting (e.g. add a preprocessor define based on other settings).

Author: markfinal

Bam.Core/Module.cs

@@ -421,14 +421,32 @@ public PackageDefinition PackageDefinition
         /// <summary>
         /// Add a private patch to the current module. Usually this takes the form of a lambda function.
         /// </summary>
-        /// <param name="dlg">Dlg.</param>
+        /// <param name="dlg">The delegate to execute privately on the module.</param>
         public void
         PrivatePatch(
             PrivatePatchDelegate dlg)
         {
             this.PrivatePatches.Add(dlg);
         }
 
+        /// <summary>
+        /// Add a closing patch to the current module, using the same delegate as a private patch.
+        /// There can only be one closing patch on a module.
+        /// It is always executed after all other patches, and thus can assume that the module's Settings object has all of its
+        /// properties in their final state just prior to execution.
+        /// </summary>
+        /// <param name="dlg">The delegate to execute as a closing patch on the module.</param>
+        public void
+        ClosingPatch(
+            PrivatePatchDelegate dlg)
+        {
+            if (null != this.TheClosingPatch)
+            {
+                throw new Exception("Module {0} already has a closing patch", this);
+            }
+            this.TheClosingPatch = dlg;
+        }
+
         /// <summary>
         /// Delegate used for public-scope patching of Settings. Note that appliedTo is the module on which
         /// this delegate is being applied.
@@ -438,7 +456,7 @@ public void
         /// <summary>
         /// Add a public patch to the current module. Usually this takes the form of a lambda function.
         /// </summary>
-        /// <param name="dlg">Dlg.</param>
+        /// <param name="dlg">The delegate to execute on the module, and on its dependees.</param>
         public void
         PublicPatch(
             PublicPatchDelegate dlg)
@@ -482,7 +500,8 @@ public bool HasPatches
             {
                 return (this.PrivatePatches.Count() > 0) ||
                        (this.PublicPatches.Count() > 0) ||
-                       (this.PublicInheritedPatches.Count() > 0);
+                       (this.PublicInheritedPatches.Count() > 0) ||
+                       (null != this.TheClosingPatch);
             }
         }
 
@@ -556,6 +575,7 @@ public System.Collections.ObjectModel.ReadOnlyCollection<Module> Children
         private System.Collections.Generic.List<PublicPatchDelegate> PublicPatches = new System.Collections.Generic.List<PublicPatchDelegate>();
         private System.Collections.Generic.List<System.Collections.Generic.List<PublicPatchDelegate>> PublicInheritedPatches = new System.Collections.Generic.List<System.Collections.Generic.List<PublicPatchDelegate>>();
         private System.Collections.Generic.List<System.Collections.Generic.List<PublicPatchDelegate>> PrivateInheritedPatches = new System.Collections.Generic.List<System.Collections.Generic.List<PublicPatchDelegate>>();
+        private PrivatePatchDelegate TheClosingPatch = null;
 
         /// <summary>
         /// Get the dictionary of keys and strings for all registered generated paths with the module.
@@ -687,6 +707,7 @@ public void
         /// 6. Apply public patches of this.
         /// 7. If this is a child module, and honourParents is true, apply any inherited patches from the parent.
         /// 8. Apply inherited public patches of this.
+        /// Once all patches have been evaluated, if the module has a closing patch, this is now evaluated.
         /// Inherited patches are the mechanism for transient dependencies, where dependencies filter up the module hierarchy.
         /// See UsePublicPatches and UsePublicPatchesPrivately.
         /// </summary>
@@ -761,6 +782,10 @@ public void
                     patch(settings, this);
                 }
             }
+            if (null != TheClosingPatch)
+            {
+                TheClosingPatch(settings);
+            }
         }
 
         /// <summary>

Changelog.txt

@@ -1,3 +1,5 @@
+18-Apr-2016 Fixes #228. Added Bam.Core.Module.ClosingPatch. This is a patch using the same delegate as a private patch, but is guaranteed to be executed after all other patches, i.e. so that the Module's Settings object is in its final state (i.e. just before the settings are converted to a command line or project file). Only a single closing patch is possible per module. This allows some logic on the final settings to be evaluated, such as to set a macro to be used in other TokenizedStrings (since they are expanded after patches are evaluated), or to modify a setting (e.g. add a preprocessor define based on other settings).
+
 16-Apr-2016 Fixes #227. Added Bam.Core.PackageDirectoryRedirectAttribute, an attribute associated with an assembly, requiring a package name, an optional package version, and a redirected path. By default, the macro $(packagedir) is the directory containing the 'bam' folder. Should the source code for a package reside in a different location to that directory, this attribute can be placed anywhere in the compiled code for your packages, and the macro $(packagedir) is redirected to the specified path for that package. The redirect path can either be an absolute path, or a path relative to the directory containing the 'bam' folder. Such attributes could be placed in project specific locations, independent of package definitions. Modified the ProxyTest test package to demonstrate.
 
 15-Apr-2016 Fixes #225. Specifying a package version override on the command line, which does not match the unique package version contained in all the definition files, will now report an error, rather than using the unique package version. For example, if VisualC-12.0 is the only version of the package in all definition files, but --VisualC.version=14.0 was on the command line, this now causes an error rather than just using 12.0.