[packages,C|MakeFileBuilder|Publisher] Fixes #335. MakeFileBuilder.MakeFileCommonMetaData.Directories and Environment properties are no longer public. Instead, accessors called AddDirectory has been added (ExtendEnvironmentVariables already existed), and utility functions to export both of these to a StringBuilder have been added to the class (ExportEnvironment and ExportDirectories).

Author: markfinal

Changelog.txt

@@ -1,3 +1,5 @@
+15-May-2017 Fixes #335. MakeFileBuilder.MakeFileCommonMetaData.Directories and Environment properties are no longer public. Instead, accessors called AddDirectory has been added (ExtendEnvironmentVariables already existed), and utility functions to export both of these to a StringBuilder have been added to the class (ExportEnvironment and ExportDirectories).
+
 15-May-2017 Fixes #334. Following tests are now tested in Linux with additional build modes: ObjectiveCTest1 (Native,MakeFile); ProceduralHeaderTest1 (MakeFile); DeltaSettingsTest1 (MakeFile); EmbedStaticIntoDynamicLibrary (MakeFile); PublishingTest1 (MakeFile) and PublishingTest2 (MakeFile).
 
 14-May-2017 Fixes #331. Added C.PatchUtilities static utility class, with the helper functions GetCompiler and GetBitDepth. These are useful in static patch functions, that only have the Module property on the settings input to determine compiler versions and the architecture built for. When patch lambdas are inlined into the Init() function of a module, access to module's properties are immediately available, but in static patch functions, these utilities are recommended. Test8 has been updated to illustrate using the PatchUtilities functions.

packages/C/bam/MakeFileBuilder/MakeFileArchiving.cs

@@ -64,7 +64,7 @@ public sealed class MakeFileLibrarian :
             rule.AddShellCommand(command.ToString());
 
             var libraryFileDir = System.IO.Path.GetDirectoryName(libraryPath.ToString());
-            meta.CommonMetaData.Directories.AddUnique(libraryFileDir);
+            meta.CommonMetaData.AddDirectory(libraryFileDir);
             meta.CommonMetaData.ExtendEnvironmentVariables(tool.EnvironmentVariables);
         }
     }

packages/C/bam/MakeFileBuilder/MakeFileAssembly.cs

@@ -57,7 +57,7 @@ public sealed class MakeFileAssembly :
             args.Add("$<");
             rule.AddShellCommand(args.ToString(' '));
 
-            meta.CommonMetaData.Directories.AddUnique(System.IO.Path.GetDirectoryName(outputPath));
+            meta.CommonMetaData.AddDirectory(System.IO.Path.GetDirectoryName(outputPath));
         }
     }
 }

packages/C/bam/MakeFileBuilder/MakeFileCompilation.cs

@@ -61,7 +61,7 @@ public sealed class MakeFileCompilation :
             rule.AddShellCommand(command.ToString());
 
             var objectFileDir = System.IO.Path.GetDirectoryName(objectFilePath.ToString());
-            meta.CommonMetaData.Directories.AddUnique(objectFileDir);
+            meta.CommonMetaData.AddDirectory(objectFileDir);
             meta.CommonMetaData.ExtendEnvironmentVariables(tool.EnvironmentVariables);
 
             // add dependencies, such as procedurally generated headers

packages/C/bam/MakeFileBuilder/MakeFileLinker.cs

@@ -120,7 +120,7 @@ public sealed class MakeFileLinker :
             rule.AddShellCommand(commands.ToString());
 
             var executableDir = System.IO.Path.GetDirectoryName(executablePath.ToString());
-            meta.CommonMetaData.Directories.AddUnique(executableDir);
+            meta.CommonMetaData.AddDirectory(executableDir);
             meta.CommonMetaData.ExtendEnvironmentVariables(tool.EnvironmentVariables);
         }
     }

packages/C/bam/MakeFileBuilder/MakeFileProceduralHeaderFromToolOutput.cs

@@ -51,7 +51,7 @@ public sealed class MakeFileProceduralHeaderFromToolOutput :
             rule.AddShellCommand(args.ToString(' '));
 
             var outputDir = System.IO.Path.GetDirectoryName(outputPath.Parse());
-            meta.CommonMetaData.Directories.AddUnique(outputDir);
+            meta.CommonMetaData.AddDirectory(outputDir);
         }
     }
 

packages/MakeFileBuilder/bam/Scripts/MakeFileCommonMetaData.cs

@@ -27,6 +27,7 @@
 // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #endregion // License
+using System.Linq;
 namespace MakeFileBuilder
 {
     // Notes:
@@ -47,18 +48,25 @@ public MakeFileCommonMetaData()
             }
         }
 
-        public Bam.Core.StringArray Directories
+        private Bam.Core.StringArray Directories
         {
             get;
-            private set;
+            set;
         }
 
-        public System.Collections.Generic.Dictionary<string, Bam.Core.StringArray> Environment
+        private System.Collections.Generic.Dictionary<string, Bam.Core.StringArray> Environment
         {
             get;
-            private set;
+            set;
         }
 
+        /// <summary>
+        /// Add key-value pairs (using strings and TokenizedStringArrays) which represent
+        /// an environment variable name, and its value (usually multiple paths), to be used
+        /// when the MakeFile is executed.
+        /// Duplicates values are not added.
+        /// </summary>
+        /// <param name="import">The dictionary of key-value pairs to add.</param>
         public void
         ExtendEnvironmentVariables(
             System.Collections.Generic.Dictionary<string, Bam.Core.TokenizedStringArray> import)
@@ -78,5 +86,55 @@ public void
                 }
             }
         }
+
+        /// <summary>
+        /// Add a directory to those to be created when running the MakeFile.
+        /// Duplicates are not added.
+        /// </summary>
+        /// <param name="path">Path to the directory to be added.</param>
+        public void
+        AddDirectory(
+            string path)
+        {
+            lock (this)
+            {
+                this.Directories.AddUnique(path);
+            }
+        }
+
+        /// <summary>
+        /// Write the environment variables to be exported to the MakeFile.
+        /// </summary>
+        /// <param name="output">Where to write the environment variables to.</param>
+        public void
+        ExportEnvironment(
+            System.Text.StringBuilder output)
+        {
+            foreach (var env in this.Environment)
+            {
+                output.AppendFormat("{0}:={1}", env.Key, env.Value.ToString(System.IO.Path.PathSeparator));
+                output.AppendLine();
+            }
+        }
+
+        /// <summary>
+        /// Write the directories to be created when running the MakeFile.
+        /// </summary>
+        /// <param name="output">Where to write the directories to.</param>
+        public void
+        ExportDirectories(
+            System.Text.StringBuilder output)
+        {
+            if (!this.Directories.Any())
+            {
+                return;
+            }
+            output.Append("DIRS:=");
+            foreach (var dir in this.Directories)
+            {
+                output.AppendFormat("{0} ", dir);
+            }
+            output.AppendLine();
+        }
     }
 }

packages/MakeFileBuilder/bam/Scripts/MakeFileMeta.cs

@@ -88,21 +88,9 @@ public static void PostExecution()
 
             // delete suffix rules
             makeEnvironment.AppendLine(".SUFFIXES:");
-            foreach (var env in commonMeta.Environment)
-            {
-                makeEnvironment.AppendFormat("{0}:={1}", env.Key, env.Value.ToString(System.IO.Path.PathSeparator));
-                makeEnvironment.AppendLine();
-            }
 
-            if (commonMeta.Directories.Count > 0)
-            {
-                makeVariables.Append("DIRS:=");
-                foreach (var dir in commonMeta.Directories)
-                {
-                    makeVariables.AppendFormat("{0} ", dir);
-                }
-                makeVariables.AppendLine();
-            }
+            commonMeta.ExportEnvironment(makeEnvironment);
+            commonMeta.ExportDirectories(makeVariables);
 
             // all rule
             makeRules.Append("all:");

packages/Publisher/bam/MakeFileBuilder/MakeFileCollatedObject.cs

@@ -76,7 +76,7 @@ public sealed class MakeFileCollatedObject :
                 }
             }
 
-            meta.CommonMetaData.Directories.AddUnique(sender.Macros["CopyDir"].Parse());
+            meta.CommonMetaData.AddDirectory(sender.Macros["CopyDir"].Parse());
 
             var commandLine = new Bam.Core.StringArray();
             (sender.Settings as CommandLineProcessor.IConvertToCommandLine).Convert(commandLine);

packages/Publisher/bam/MakeFileBuilder/MakeFileDSymUtil.cs

@@ -44,7 +44,7 @@ public sealed class MakeFileDSymUtil :
 
             var sourceFilename = System.IO.Path.GetFileName(originalPath.Parse());
 
-            meta.CommonMetaData.Directories.AddUnique(sender.CreateTokenizedString("@dir($(0))", copiedPath).Parse());
+            meta.CommonMetaData.AddDirectory(sender.CreateTokenizedString("@dir($(0))", copiedPath).Parse());
             rule.AddTarget(copiedPath, variableName: "dSYM" + sourceFilename, isPhony: true);
 
             var commandLine = new Bam.Core.StringArray();