[packages,*] Fixes #519. BREAKING CHANGE. Split out preprocessor settings from compiler.

In order to better support standalone preprocessor invocations, the preprocessor has been split out from the compiler into a separate settings interface, C.ICommonPreprocessorSettings. Compilers still implement this, but a new tool C.PreprocessorTool also implements this on each toolchain.

This will break a great number of existing settings patches, that use the PreprocessorDefinition and IncludePath properties, since the interface will need to change.

Added a new test, PreprocessFile1, in order to exercise the preprocessor.

Author: markfinal

.appveyor.yml

@@ -17,7 +17,7 @@ for:
     environment:
       GCC_VERSION: 7
 install:
-  - cmd: powershell choco install doxygen.install
+  - cmd: powershell choco install doxygen.portable --version 1.8.11 || exit 0
   - sh: ./codingtools/install_ubuntu_dependencies.sh
 before_build:
   - dotnet --version
@@ -28,7 +28,7 @@ build_script:
   - sh: python codingtools/dotnetcore_make_release.py --local
 after_build:
   - cmd: 7z a bam.zip %APPVEYOR_BUILD_FOLDER%\bam_publish
-  - cmd: 7z a bam_docs.zip %APPVEYOR_BUILD_FOLDER%\docs
+  - cmd: 7z a bam_docs.zip %APPVEYOR_BUILD_FOLDER%\docs || exit 0
 artifacts:
   - path: bam.zip
     name: Bam

Bam.Core/Bam.Core.csproj

@@ -37,6 +37,9 @@
     <PackageReference Include="Mono.Posix.NETStandard" Version="1.0.0" />
   </ItemGroup>
   <ItemGroup>
+    <None Update="licenseheader.txt">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="Schema\BamPackageDefinitionV1.xsd">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

Changelog.txt

@@ -1,3 +1,8 @@
+29-Dec-2018 Fixes #519. BREAKING CHANGE. Split out preprocessor settings from compiler.
+In order to better support standalone preprocessor invocations, the preprocessor has been split out from the compiler into a separate settings interface, C.ICommonPreprocessorSettings. Compilers still implement this, but a new tool C.PreprocessorTool also implements this on each toolchain.
+This will break a great number of settings patches, that use the PreprocessorDefinition and IncludePath properties, since the interface will need to change.
+Added a new test, PreprocessFile1, in order to exercise the preprocessor.
+
 22-Dec-2018 Fixes #518. Added ICommonLinkerSettings.ExportedSymbolList to provide a path to a list of symbols to export from a dynamic library.
 
 29-Nov-2018 Added XcodeBuilder.FileReference.EFileType.GLSLShaderSource.

codingtools/assign_license.py

@@ -3,16 +3,30 @@
 from distutils.spawn import find_executable
 from convert_line_endings import convert_line_endings
 import os
+import platform
+import subprocess
 import sys
 
 licenseText = []
 
 
+def check_bam_available():
+    """
+    Check if BAM is available on the PATH, and return its root directory.
+    """
+    system = platform.system()
+    if system == 'Windows':
+        bam_shell = 'bam.bat'
+    else:
+        bam_shell = 'bam'
+    try:
+        return subprocess.check_output([bam_shell, '--installdir']).rstrip()
+    except WindowsError:
+        raise RuntimeError('Unable to locate BAM on the PATH')
+
+
 def read_license_text():
-    bam_path = find_executable('bam')
-    if not bam_path:
-        raise RuntimeError('Unable to locate bam')
-    bam_dir = os.path.dirname(bam_path)
+    bam_dir = check_bam_available()
     license_header_file = os.path.join(bam_dir, 'licenseheader.txt')
     with open(license_header_file, 'rt') as licenseFile:
         original_license_text = licenseFile.readlines()

codingtools/dotnetcore_make_release.py

@@ -1,6 +1,7 @@
 #!/usr/bin/python
 
 from generate_docs import build_documentation
+from generate_docs import NoDoxygenError
 from optparse import OptionParser
 import os
 import platform
@@ -172,10 +173,13 @@ def main(options, build_dir, source_dir):
     if options.doxygen:
         generated_docs_dir = os.path.join(source_dir, 'docs')
         delete_directory(generated_docs_dir)
-        build_documentation(source_dir, options.doxygen)
-        if options.make_distribution:
-            zip_dir(os.path.realpath(os.path.join(build_dir, '..', '%s-docs' % bam_version_dir) + '.zip'), generated_docs_dir)
-            tar_dir(os.path.realpath(os.path.join(build_dir, '..', '%s-docs' % bam_version_dir) + '.tgz'), generated_docs_dir)
+        try:
+            build_documentation(source_dir, options.doxygen)
+            if options.make_distribution:
+                zip_dir(os.path.realpath(os.path.join(build_dir, '..', '%s-docs' % bam_version_dir) + '.zip'), generated_docs_dir)
+                tar_dir(os.path.realpath(os.path.join(build_dir, '..', '%s-docs' % bam_version_dir) + '.tgz'), generated_docs_dir)
+        except NoDoxygenError, e:
+            log(str(e)) # not fatal, but do complain
 
     run_dotnet_publish(
         source_dir,

codingtools/generate_docs.py

@@ -5,6 +5,11 @@
 import subprocess
 import sys
 
+
+class NoDoxygenError(Exception):
+    pass
+
+
 def build_documentation(source_dir, doxygenpath):
     if not doxygenpath:
         raise RuntimeError("Path to doxygen is required")
@@ -15,7 +20,7 @@ def build_documentation(source_dir, doxygenpath):
         os.chdir(source_dir)
         subprocess.check_call(args)
     except OSError:
-        raise RuntimeError('Unable to run doxygen executable "%s"' % doxygenpath)
+        raise NoDoxygenError('Unable to run doxygen executable "%s"' % doxygenpath)
     finally:
         os.chdir(current_dir)
 

packages/C/bam/VSSolutionBuilder/VSSolutionProceduralHeaderFromToolOutput.cs renamed to packages/C/bam/Scripts/Attributes/RegisterPreprocessor.cs

@@ -29,29 +29,15 @@
 #endregion // License
 namespace C
 {
-    public static partial class VSSolutionSupport
+    public sealed class RegisterPreprocessorAttribute :
+        ToolRegistrationAttribute
     {
-        public static void
-        GenerateHeader(
-            ProceduralHeaderFileFromToolOutput module)
-        {
-            var tool = module.Tool as Bam.Core.ICommandLineTool;
-            var toolProject = (tool as Bam.Core.Module).MetaData as VSSolutionBuilder.VSProject;
-            var toolConfig = toolProject.GetConfiguration(tool as Bam.Core.Module);
-
-            var commands = new Bam.Core.StringArray();
-            commands.Add(
-                $"{CommandLineProcessor.Processor.StringifyTool(tool)} > {module.GeneratedPaths[ProceduralHeaderFileFromToolOutput.HeaderFileKey].ToString()}"
-            );
-
-            VSSolutionBuilder.Support.AddCustomPostBuildStep(
-                toolConfig,
-                module,
-                commands
-            );
-
-            // alias the tool's project so that inter-project dependencies can be set up
-            module.MetaData = toolProject;
-        }
+        public RegisterPreprocessorAttribute(
+            string toolsetName,
+            Bam.Core.EPlatform platform,
+            EBit bitDepth)
+            :
+            base(toolsetName, platform, bitDepth)
+        {}
     }
 }

packages/C/bam/Scripts/ConsoleApplication.cs

@@ -160,8 +160,8 @@ public System.Collections.Generic.IEnumerable<Bam.Core.Module>
 
         protected Bam.Core.Module.PrivatePatchDelegate ConsolePreprocessor = settings =>
             {
-                var compiler = settings as C.ICommonCompilerSettings;
-                compiler.PreprocessorDefines.Add("_CONSOLE");
+                var preprocessor = settings as C.ICommonPreprocessorSettings;
+                preprocessor.PreprocessorDefines.Add("_CONSOLE");
             };
 
         /// <summary>

packages/C/bam/Scripts/CxxDynamicLibrary.cs

@@ -115,8 +115,8 @@ public sealed override CObjectFileCollection
             var collection = base.CreateCSourceContainer(wildcardPath, macroModuleOverride, filter);
             collection.PrivatePatch(settings =>
             {
-                var compiler = settings as C.ICommonCompilerSettings;
-                compiler.PreprocessorDefines.Add("D_BAM_DYNAMICLIBRARY_BUILD");
+                var preprocessor = settings as C.ICommonPreprocessorSettings;
+                preprocessor.PreprocessorDefines.Add("D_BAM_DYNAMICLIBRARY_BUILD");
                 (collection.Tool as C.CompilerTool).CompileAsShared(settings);
             });
             return collection;
@@ -138,8 +138,8 @@ public sealed override Cxx.ObjectFileCollection
             var collection = base.CreateCxxSourceContainer(wildcardPath, macroModuleOverride, filter);
             collection.PrivatePatch(settings =>
             {
-                var compiler = settings as C.ICommonCompilerSettings;
-                compiler.PreprocessorDefines.Add("D_BAM_DYNAMICLIBRARY_BUILD");
+                var preprocessor = settings as C.ICommonPreprocessorSettings;
+                preprocessor.PreprocessorDefines.Add("D_BAM_DYNAMICLIBRARY_BUILD");
                 (collection.Tool as C.CompilerTool).CompileAsShared(settings);
             });
             return collection;

packages/C/bam/Scripts/CxxGUIApplication.cs

@@ -54,9 +54,9 @@ protected override void
 
         protected Bam.Core.Module.PrivatePatchDelegate WindowsPreprocessor = settings =>
         {
-            var compiler = settings as C.ICommonCompilerSettings;
-            compiler.PreprocessorDefines.Remove("_CONSOLE");
-            compiler.PreprocessorDefines.Add("_WINDOWS");
+            var preprocessor = settings as C.ICommonPreprocessorSettings;
+            preprocessor.PreprocessorDefines.Remove("_CONSOLE");
+            preprocessor.PreprocessorDefines.Add("_WINDOWS");
         };
 
         /// <summary>