Further trace logging & update Distribution

Author: govert

Distribution/ChangeLog.txt

@@ -13,6 +13,7 @@ Version 0.33 (???)
 * Fix integer return type with IsExceptionSafe=true crashes in marshaling.
 * Update ExcelReference to allow immutable use, mark AddRectangle mutator Obsolete. Add operator== to AsyncCallInfo.
 * Increase number of exports to 10,000.
+* Implement logging mechanism based on System.Diagnostics.Trace.
 
 Version 0.32 (3 May 2014)
 -------------------------

Distribution/ExcelDna.Integration.dll

@@ -117,7 +117,7 @@ static void GetExcelMethods(Type t, bool explicitExports, List<MethodInfo> excel
                 t.Namespace == "My")
             {
                 // Ignored cases
-                RegistrationLogger.Info("Type ignored: {0}", t.FullName);
+                Logger.Registration.Info("Type ignored: {0}", t.FullName);
                 return;
             }
 
@@ -161,12 +161,12 @@ static bool IsMethodSupported(MethodInfo mi, bool explicitExports)
             // We want to log methods that are marked for export, but have unsupported types.
             if (!isSupported && IsMethodMarkedForExport(mi))
             {
-                RegistrationLogger.Error("Method not registered - unsupported types: '{0}.{1}'", mi.DeclaringType.Name, mi.Name);
+                Logger.Registration.Error("Method not registered - unsupported types: '{0}.{1}'", mi.DeclaringType.Name, mi.Name);
             }
             else if (!isSupported)
             {
                 // CONSIDER: More detailed logging
-                RegistrationLogger.Info("Method not registered - unsupported types: '{0}.{1}'", mi.DeclaringType.Name, mi.Name);
+                Logger.Registration.Info("Method not registered - unsupported types: '{0}.{1}'", mi.DeclaringType.Name, mi.Name);
             }
 
             return isSupported;

Distribution/ExcelDna.xll

@@ -23,7 +23,6 @@ Govert van Drimmelen
 */
 
 using System;
-using System.Diagnostics;
 using System.Runtime.InteropServices;
 using System.Security;
 using Microsoft.Win32;
@@ -35,6 +34,7 @@ Govert van Drimmelen
 using DWORD     = System.Int32;
 using HRESULT   = System.Int32;
 using IID       = System.Guid;
+using ExcelDna.Logging;
 
 namespace ExcelDna.ComInterop.ComRegistration
 {
@@ -193,7 +193,7 @@ static bool CanWriteMachineHive()
                 RegistryKey testKey = Registry.ClassesRoot.CreateSubKey(testKeyName, RegistryKeyPermissionCheck.ReadWriteSubTree);
                 if (testKey == null)
                 {
-                    Debug.Print("Unexpected failure in CanWriteMachineHive check");
+                    Logger.ComAddIn.Error("Unexpected failure in CanWriteMachineHive check");
                     return false;
                 }
                 else
@@ -215,7 +215,7 @@ static bool CanWriteMachineHive()
             }
             catch (Exception e)
             {
-                Debug.Print("Unexpected exception in CanWriteMachineHive check: " + e);
+                Logger.ComAddIn.Error(e, "Unexpected exception in CanWriteMachineHive check");
                 return false;
             }
         }

Distribution/ExcelDna64.xll

@@ -24,7 +24,6 @@ Govert van Drimmelen
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
 using System.Reflection;
 using System.Runtime.InteropServices;
@@ -37,6 +36,7 @@ Govert van Drimmelen
 using ExcelDna.Integration.CustomUI;
 using ExcelDna.Integration.Rtd;
 using ExcelDna.ComInterop;
+using ExcelDna.Logging;
 
 namespace ExcelDna.Integration
 {
@@ -222,8 +222,8 @@ internal List<ExportedAssembly> GetAssemblies(string pathResolveRoot)
             }
             catch (Exception e)
             {
-                Logging.LogDisplay.WriteLine("There was an error in loading the add-in " + DnaLibrary.CurrentLibraryName + " (" + DnaLibrary.XllPath + "):");
-                Logging.LogDisplay.WriteLine("Error in loading assemblies. Exception: " + e.ToString());
+                Logger.Initialization.Error("There was an error in loading the add-in " + DnaLibrary.CurrentLibraryName + " (" + DnaLibrary.XllPath + "):");
+                Logger.Initialization.Error(e, "Error in loading assemblies");
             }
             return assemblies;
         }
@@ -296,7 +296,7 @@ internal void AutoOpen()
                 catch (Exception e)
                 {
                     // TODO: What to do here?
-                    Debug.Print(e.Message);
+                    Logger.Initialization.Error(e, "DnaLibrary AutoOpen Error");
                 }
             }
 
@@ -318,8 +318,7 @@ internal void AutoClose()
                 }
                 catch (Exception e)
                 {
-                    // TODO: What to do here?
-                    Debug.WriteLine(e.Message);
+                    Logger.Initialization.Warn("DnaLibrary AutoClose Error: {0}", e.Message);
                 }
             }
             // This is safe, even if never registered
@@ -414,20 +413,21 @@ internal static void InitializeRootLibrary(string xllPath)
             // 1. Look for a packed .dna file named "__MAIN__" in the .xll.
             // 2. Look for the .dna file in the same directory as the .xll file, with the same name and extension .dna.
 
-            Debug.WriteLine("Enter DnaLibrary.InitializeRootLibrary");
+            // CAREFUL: Sequence here is fragile - this is the first place where we start logging
             _XllPath = xllPath;
             Logging.LogDisplay.CreateInstance();
+            Logger.Initialization.Verbose("Enter DnaLibrary.InitializeRootLibrary");
             byte[] dnaBytes = ExcelIntegration.GetDnaFileBytes("__MAIN__");
             if (dnaBytes != null)
             {
-                Debug.WriteLine("Got Dna file from resources.");
+                Logger.Initialization.Verbose("Got Dna file from resources.");
                 string pathResolveRoot = Path.GetDirectoryName(DnaLibrary.XllPath);
                 rootLibrary = LoadFrom(dnaBytes, pathResolveRoot);
                 // ... would have displayed error and returned null if there was an error.
             }
             else
             {
-                Debug.WriteLine("No Dna file in resources - looking for file.");
+                Logger.Initialization.Verbose("No Dna file in resources - looking for file.");
                 // No packed .dna file found - load from a .dna file.
                 string dnaFileName = Path.ChangeExtension(XllPath, ".dna");
                 rootLibrary = LoadFrom(dnaFileName);
@@ -437,12 +437,12 @@ internal static void InitializeRootLibrary(string xllPath)
             // If there have been problems, ensure that there is at lease some current library.
             if (rootLibrary == null)
             {
-                Debug.WriteLine("No Dna Library found.");
+                Logger.Initialization.Error("No Dna Library found.");
                 rootLibrary = new DnaLibrary();
             }
 
             rootLibrary.Initialize();
-            Debug.WriteLine("Exit DnaLibrary.Initialize");
+            Logger.Initialization.Verbose("Exit DnaLibrary.Initialize");
         }
 
         internal static void DeInitialize()
@@ -467,9 +467,7 @@ public static DnaLibrary LoadFrom(Uri uri)
             }
             catch (Exception e)
             {
-                string errorMessage = string.Format("There was an error in loading the .dna file from a Uri:\r\n{0}\r\n{1}\r\nUri:{2}", e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty, uri.ToString());
-                Debug.WriteLine(errorMessage);
-                ExcelDna.Logging.LogDisplay.WriteLine(errorMessage);
+                Logger.Initialization.Error("There was an error in loading the .dna file from a Uri:\r\n{0}\r\n{1}\r\nUri:{2}", e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty, uri.ToString());
                 return null;
             }
 
@@ -492,9 +490,7 @@ public static DnaLibrary LoadFrom(byte[] bytes, string pathResolveRoot)
             }
             catch (Exception e)
             {
-                string errorMessage = string.Format("There was an error in processing .dna file bytes:\r\n{0}\r\n{1}", e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty);
-                Debug.WriteLine(errorMessage);
-                //ExcelDna.Logging.LogDisplay.SetText(errorMessage);
+                Logger.Initialization.Error("There was an error in processing .dna file bytes:\r\n{0}\r\n{1}", e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty);
                 return null;
             }
             dnaLibrary.dnaResolveRoot = pathResolveRoot;
@@ -507,7 +503,7 @@ public static DnaLibrary LoadFrom(string fileName)
 
             if (!File.Exists(fileName))
             {
-                ExcelDna.Logging.LogDisplay.WriteLine("The required .dna script file {0} does not exist.", fileName);
+                Logger.Initialization.Error("The required .dna script file {0} does not exist.", fileName);
                 return null;
             }
 
@@ -521,7 +517,7 @@ public static DnaLibrary LoadFrom(string fileName)
             }
             catch (Exception e)
             {
-                ExcelDna.Logging.LogDisplay.WriteLine("There was an error during processing of {0}:\r\n{1}\r\n{2}", fileName, e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty);
+                Logger.Initialization.Error("There was an error during processing of {0}:\r\n{1}\r\n{2}", fileName, e.Message, e.InnerException != null ? e.InnerException.Message : string.Empty);
                 return null;
             }
             dnaLibrary.dnaResolveRoot = Path.GetDirectoryName(fileName);
@@ -602,11 +598,11 @@ public string ResolvePath(string path)
         public static string ResolvePath(string path, string dnaDirectory)
         {
 
-            Debug.Print("ResolvePath: Resolving {0} from DnaDirectory: {1}", path, dnaDirectory);
+            Logger.Initialization.Info("ResolvePath: Resolving {0} from DnaDirectory: {1}", path, dnaDirectory);
             if (File.Exists(path))
             {
                 string fullPath = Path.GetFullPath(path);
-                Debug.Print("ResolvePath: Found at {0}", fullPath);
+                Logger.Initialization.Info("ResolvePath: Found at {0}", fullPath);
                 return fullPath;
             }
 
@@ -625,10 +621,10 @@ public static string ResolvePath(string path, string dnaDirectory)
                     // Not rooted - try a path relative to local directory
                     dnaPath = System.IO.Path.Combine(dnaDirectory, path);
                 }
-                Debug.Print("ResolvePath: Checking at {0}", dnaPath);
+                Logger.Initialization.Verbose("ResolvePath: Checking at {0}", dnaPath);
                 if (File.Exists(dnaPath))
                 {
-                    Debug.Print("ResolvePath: Found at {0}", dnaPath);
+                    Logger.Initialization.Info("ResolvePath: Found at {0}", dnaPath);
                     return dnaPath;
                 }
             }
@@ -646,10 +642,10 @@ public static string ResolvePath(string path, string dnaDirectory)
                     basePath = System.IO.Path.Combine(baseDirectory, path);
                 }
                 // ... and check again
-                Debug.Print("ResolvePath: Checking at {0}", basePath);
+                Logger.Initialization.Verbose("ResolvePath: Checking at {0}", basePath);
                 if (File.Exists(basePath))
                 {
-                    Debug.Print("ResolvePath: Found at {0}", basePath);
+                    Logger.Initialization.Info("ResolvePath: Found at {0}", basePath);
                     return basePath;
                 }
             }
@@ -662,12 +658,12 @@ public static string ResolvePath(string path, string dnaDirectory)
             string frameworkPath = Path.Combine(frameworkBase, fileName);
             if (File.Exists(frameworkPath))
             {
-                Debug.Print("ResolvePath: Found at {0}", frameworkPath);
+                Logger.Initialization.Info("ResolvePath: Found at {0}", frameworkPath);
                 return frameworkPath;
             }
 
             // Else give up (maybe try load from GAC for assemblies?)
-            Debug.Print("ResolvePath: Could not find {0} from DnaDirectory {1}", path, dnaDirectory);
+            Logger.Initialization.Error("ResolvePath: Could not find {0} from DnaDirectory {1}", path, dnaDirectory);
             return null;
         }
 
@@ -694,7 +690,7 @@ public Bitmap GetImage(string imageId)
                         if (imagePath == null)
                         {
                             // This is the image but we could not find it !?
-                            Debug.Print("DnaLibrary.LoadImage - For image {0} the path resolution failed: {1}", image.Name, image.Path);
+                            Logger.Initialization.Warn("DnaLibrary.GetImage - For image {0} the path resolution failed: {1}", image.Name, image.Path);
                             return null;
                         }
                         imageBytes = File.ReadAllBytes(imagePath);
@@ -706,7 +702,7 @@ public Bitmap GetImage(string imageId)
                         {
                             return (Bitmap)imageLoaded;
                         }
-                        Debug.Print("Image {0} read from {1} was not a bitmap!?", image.Name, image.Path);
+                        Logger.Initialization.Warn("DnaLibrary.GetImage - Image {0} read from {1} was not a bitmap!?", image.Name, image.Path);
                     }
                 }
             }

Distribution/ExcelDnaPack.exe

@@ -1,12 +1,12 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Globalization;
 using System.Reflection;
 using System.Runtime.InteropServices;
 using ExcelDna.ComInterop.ComRegistration;
 using ExcelDna.Integration.CustomUI;
 using ExcelDna.Integration.Extensibility;
+using ExcelDna.Logging;
 
 namespace ExcelDna.Integration
 {
@@ -29,27 +29,27 @@ internal void SetProgId(string progId)
         #region IDTExtensibility2 interface
         public virtual void OnConnection(object Application, ext_ConnectMode ConnectMode, object AddInInst, ref Array custom)
         {
-            Debug.Print("ExcelComAddIn.OnConnection");
+            Logger.ComAddIn.Verbose("ExcelComAddIn.OnConnection");
         }
 
         public virtual void OnDisconnection(ext_DisconnectMode RemoveMode, ref Array custom)
         {
-            Debug.Print("ExcelComAddIn.OnDisconnection");
+            Logger.ComAddIn.Verbose("ExcelComAddIn.OnDisconnection");
         }
 
         public virtual void OnAddInsUpdate(ref Array custom)
         {
-            Debug.Print("ExcelComAddIn.OnAddInsUpdate");
+            Logger.ComAddIn.Verbose("ExcelComAddIn.OnAddInsUpdate");
         }
 
         public virtual void OnStartupComplete(ref Array custom)
         {
-            Debug.Print("ExcelComAddIn.OnStartupComplete");
+            Logger.ComAddIn.Verbose("ExcelComAddIn.OnStartupComplete");
         }
 
         public virtual void OnBeginShutdown(ref Array custom)
         {
-            Debug.Print("ExcelComAddIn.OnBeginShutdown");
+            Logger.ComAddIn.Verbose("ExcelComAddIn.OnBeginShutdown");
         }
         #endregion
     }
@@ -100,10 +100,10 @@ public static void LoadComAddIn(ExcelComAddIn addIn)
             string description = string.Format("Dynamically created COM Add-in to load custom UI for the Excel Add-in {0}, located at {1}.", addIn.DnaLibrary.Name, DnaLibrary.XllPath);
 
 
-            Debug.Print("Getting Application object");
+            Logger.ComAddIn.Verbose("Getting Application object");
             object app = ExcelDnaUtil.Application;
             Type appType = app.GetType();
-            Debug.Print("Got Application object: " + app.GetType().ToString());
+            Logger.ComAddIn.Verbose("Got Application object: " + app.GetType().ToString());
 
             CultureInfo ci = new CultureInfo(1033);
             object excelComAddIns;
@@ -134,8 +134,7 @@ public static void LoadComAddIn(ExcelComAddIn addIn)
             }
             catch (UnauthorizedAccessException secex)
             {
-                Logging.LogDisplay.WriteLine("The Ribbon/COM Add-in helper required by add-in {0} could not be registered.\r\nThis may be due to restricted permissions on the user's HKCU\\Software\\Classes key.\r\nError message: {1}", DnaLibrary.CurrentLibrary.Name, secex.Message);
-                Debug.Print("LoadComAddIn exception: " + secex.ToString());
+                Logger.ComAddIn.Error(secex, "The Ribbon/COM add-in helper required by add-in {0} could not be registered.\r\nThis may be due to restricted permissions on the user's HKCU\\Software\\Classes key.", DnaLibrary.CurrentLibrary.Name);
             }
             catch (Exception ex)
             {
@@ -145,9 +144,9 @@ public static void LoadComAddIn(ExcelComAddIn addIn)
                 // CONSIDER: How would an add-in know that its COM AddIn load failed in this case?
                 if (!Environment.CommandLine.Contains(" /K"))
                 {
-                    Logging.LogDisplay.WriteLine("The Ribbon/COM Add-in helper required by add-in {0} could not be registered.\r\nThis is an unexpected error.\r\nError message: {1}", DnaLibrary.CurrentLibrary.Name, ex.Message);
+                    Logger.ComAddIn.Error("The Ribbon/COM add-in helper required by add-in {0} could not be registered.\r\nThis is an unexpected error.", DnaLibrary.CurrentLibrary.Name);
                 }
-                Debug.Print("LoadComAddIn exception: " + ex.ToString());
+                Logger.ComAddIn.Info("LoadComAddIn exception: {0} with /K in CommandLine", ex.ToString());
             }
         }
 
@@ -157,7 +156,7 @@ internal static void UnloadComAddIns()
             foreach (object comAddIn in loadedComAddIns)
             {
                 comAddIn.GetType().InvokeMember("Connect", System.Reflection.BindingFlags.SetProperty, null, comAddIn, new object[] { false }, ci);
-                Debug.Print("COMAddin is unloaded.");
+                Logger.ComAddIn.Info("COMAddin is unloaded.");
             }
         }
     }

Source/ExcelDna.Integration/AssemblyLoader.cs

@@ -30,6 +30,7 @@ Govert van Drimmelen
 namespace ExcelDna.Integration
 {
     using ExcelDna.ComInterop;
+    using ExcelDna.Logging;
     using HRESULT = Int32;
 
     // CAUTION: These functions are called _via reflection_ by
@@ -233,16 +234,16 @@ internal static void DeInitialize()
 
         internal static void DnaLibraryAutoOpen()
         {
-			Debug.WriteLine("Enter Integration.DnaLibraryAutoOpen");
+			Logger.Initialization.Verbose("Enter Integration.DnaLibraryAutoOpen");
 			try
 			{
 				DnaLibrary.CurrentLibrary.AutoOpen();
             }
 			catch (Exception e)
 			{
-				Debug.WriteLine("Integration.DnaLibraryAutoOpen Exception: " + e);
+                Logger.Initialization.Error(e, "Integration.DnaLibraryAutoOpen Error");
 			}
-			Debug.WriteLine("Exit Integration.DnaLibraryAutoOpen");
+            Logger.Initialization.Verbose("Exit Integration.DnaLibraryAutoOpen");
 		}
 
         internal static void DnaLibraryAutoClose()