[Bam|Core] Fixes #182. When the C# assembly for all the packages in a build fails to compile, an improved error message is now displayed, hinting at using the command line option in bam for enabling debug symbols, and the option to generate a debuggable project in one of the applicable IDEs (VisualStudio/Xamarin Studio/MonoDevelop).

Author: markfinal

Bam.Core/EntryPoint.cs

@@ -99,11 +99,7 @@ public static void
             }
             else
             {
-                var compiledSuccessfully = PackageUtilities.CompilePackageAssembly();
-                if (!compiledSuccessfully)
-                {
-                    throw new Exception("Package compilation failed");
-                }
+                PackageUtilities.CompilePackageAssembly();
                 PackageUtilities.LoadPackageAssembly();
             }
 

Bam.Core/Package/PackageUtilities.cs

@@ -487,11 +487,11 @@ private static string
 
         /// <summary>
         /// Compile the package assembly, using all the source files from the dependent packages.
+        /// Throws Bam.Core.Exceptions if package compilation fails.
         /// </summary>
-        /// <returns><c>true</c>, if package assembly was compiled, <c>false</c> otherwise.</returns>
         /// <param name="enforceBamAssemblyVersions">If set to <c>true</c> enforce bam assembly versions. Default is true.</param>
         /// <param name="enableClean">If set to <c>true</c> cleaning the build root is allowed. Default is true.</param>
-        public static bool
+        public static void
         CompilePackageAssembly(
             bool enforceBamAssemblyVersions = true,
             bool enableClean = true)
@@ -616,8 +616,7 @@ public static bool
                                 Graph.Instance.ScriptAssemblyPathname = cachedAssemblyPathname;
 
                                 assemblyCompileProfile.StopProfile();
-
-                                return true;
+                                return;
                             }
                             else
                             {
@@ -723,12 +722,26 @@ public static bool
 
                 if (results.Errors.HasErrors || results.Errors.HasWarnings)
                 {
-                    Log.ErrorMessage("Failed to compile package '{0}'. There are {1} errors.", Graph.Instance.MasterPackage.FullName, results.Errors.Count);
+                    var message = new System.Text.StringBuilder();
+                    message.AppendFormat("Failed to compile package '{0}'. There are {1} errors.", Graph.Instance.MasterPackage.FullName, results.Errors.Count);
+                    message.AppendLine();
                     foreach (System.CodeDom.Compiler.CompilerError error in results.Errors)
                     {
-                        Log.ErrorMessage("\t{0}({1}): {2} {3}", error.FileName, error.Line, error.ErrorNumber, error.ErrorText);
+                        message.AppendFormat("\t{0}({1}): {2} {3}", error.FileName, error.Line, error.ErrorNumber, error.ErrorText);
+                        message.AppendLine();
+                    }
+                    if (!Graph.Instance.CompileWithDebugSymbols)
+                    {
+                        message.AppendLine();
+                        ICommandLineArgument debugOption = new Options.UseDebugSymbols();
+                        message.AppendFormat("Use the {0}/{1} command line option with bam for more accurate error messages.", debugOption.LongName, debugOption.ShortName);
+                        message.AppendLine();
                     }
-                    return false;
+                    message.AppendLine();
+                    ICommandLineArgument createDebugProjectOption = new Options.CreateDebugProject();
+                    message.AppendFormat("Use the {0}/{1} command line option with bam to create an editable IDE project containing the build scripts.", createDebugProjectOption.LongName, createDebugProjectOption.ShortName);
+                    message.AppendLine();
+                    throw new Exception(message.ToString());
                 }
 
                 if (!Graph.Instance.CompileWithDebugSymbols)
@@ -752,8 +765,6 @@ public static bool
             }
 
             assemblyCompileProfile.StopProfile();
-
-            return true;
         }
 
         /// <summary>

Bam/CommandLineArgumentHelper.cs

@@ -88,10 +88,8 @@ public static void
                 if (Core.PackageUtilities.IsPackageDirectory(Core.Graph.Instance.ProcessState.WorkingDirectory))
                 {
                     Core.Graph.Instance.BuildRoot = System.IO.Path.GetTempPath();
-                    if (Core.PackageUtilities.CompilePackageAssembly(enforceBamAssemblyVersions: false, enableClean: false))
-                    {
-                        Core.PackageUtilities.LoadPackageAssembly();
-                    }
+                    Core.PackageUtilities.CompilePackageAssembly(enforceBamAssemblyVersions: false, enableClean: false);
+                    Core.PackageUtilities.LoadPackageAssembly();
                 }
             }
             catch (Core.Exception)

Changelog.txt

@@ -1,3 +1,5 @@
+25-Mar-2016 Fixes #182. When the C# assembly for all the packages in a build fails to compile, an improved error message is now displayed, hinting at using the command line option in bam for enabling debug symbols, and the option to generate a debuggable project in one of the applicable IDEs (VisualStudio/Xamarin Studio/MonoDevelop).
+
 25-Mar-2016 Fixes #180. C.DynamicLibrary and C.Cxx.DynamicLibrary that identify dynamic library dependencies with CompilePubliclyAndLinkAgainst now forward those dependencies on, just like how StaticLibraries already do. If the public API in dynamic library D is exposed in the public API of dynamic library E, then it is legal for a compilation step dependent on D to invoke calls in E that were not resolved during D's link. This change simplifies writing build scripts in that transient dynamic dependencies no longer need to be manually specified.
 
 24-Mar-2016 Fixes #179. Removed the 'frameworks' argument from the C.ILinkingPolicy.Link function, as it is never used. Passing OSX frameworks to the linker is performed via the setting in C.ICommonLinkerSettingsOSX.