Configure logging (#1563)

* clean up file statements (fixes #1487)

* consider members in supertypes as members of enclosing module (fixes #1489)

* remove temp fix (should be fixed with #1489)

* add support for Circle and Scale special forms (fixes #1498)

* fix foreign names (#1521)

* speed up all parsers by using the "two-stage parsing" approach

* reenable "function return value not used" inspection

* clean up

* fix typeof expression resolver

* configure logging

* make rollover size 5MB

Author: Andrin Meier

RetailCoder.VBE/App.cs

@@ -23,6 +23,7 @@ namespace Rubberduck
 {
     public sealed class App : IDisposable
     {
+        private const string FILE_TARGET_NAME = "file";
         private readonly VBE _vbe;
         private readonly IMessageBox _messageBox;
         private readonly IRubberduckParser _parser;
@@ -41,7 +42,7 @@ public sealed class App : IDisposable
         private readonly IConnectionPoint _projectsEventsConnectionPoint;
         private readonly int _projectsEventsCookie;
 
-        private readonly IDictionary<string, Tuple<IConnectionPoint, int>>  _componentsEventsConnectionPoints = 
+        private readonly IDictionary<string, Tuple<IConnectionPoint, int>> _componentsEventsConnectionPoints =
             new Dictionary<string, Tuple<IConnectionPoint, int>>();
         private readonly IDictionary<string, Tuple<IConnectionPoint, int>> _referencesEventsConnectionPoints =
             new Dictionary<string, Tuple<IConnectionPoint, int>>();
@@ -74,7 +75,7 @@ public App(VBE vbe, IMessageBox messageBox,
 
             _sink = new VBProjectsEventsSink();
             var connectionPointContainer = (IConnectionPointContainer)_vbe.VBProjects;
-            var interfaceId = typeof (_dispVBProjectsEvents).GUID;
+            var interfaceId = typeof(_dispVBProjectsEvents).GUID;
             connectionPointContainer.FindConnectionPoint(ref interfaceId, out _projectsEventsConnectionPoint);
 
             _sink.ProjectAdded += sink_ProjectAdded;
@@ -130,9 +131,32 @@ private bool ShouldEvaluateCanExecute(Declaration selectedDeclaration, ParserSta
 
         private void _configService_SettingsChanged(object sender, EventArgs e)
         {
+            _config = _configService.LoadConfiguration();
             // also updates the ShortcutKey text
             _appMenus.Localize();
             _hooks.HookHotkeys();
+            UpdateLoggingLevel();
+        }
+
+        private void UpdateLoggingLevel()
+        {
+            var fileRule = LogManager.Configuration.LoggingRules.Where(rule => rule.Targets.Any(t => t.Name == FILE_TARGET_NAME)).FirstOrDefault();
+            if (fileRule == null)
+            {
+                return;
+            }
+            if (_config.UserSettings.GeneralSettings.DetailedLoggingEnabled)
+            {
+                // "Enable" should have been called "Add" perhaps?
+                fileRule.EnableLoggingForLevel(LogLevel.Trace);
+                fileRule.EnableLoggingForLevel(LogLevel.Debug);
+            }
+            else
+            {
+                fileRule.DisableLoggingForLevel(LogLevel.Trace);
+                fileRule.DisableLoggingForLevel(LogLevel.Debug);
+            }
+            LogManager.ReconfigExistingLoggers();
         }
 
         public void Startup()
@@ -142,6 +166,7 @@ public void Startup()
             _appMenus.Localize();
             Task.Delay(1000).ContinueWith(t => UiDispatcher.Invoke(() => _parser.State.OnParseRequested(this))).ConfigureAwait(false);
             _hooks.HookHotkeys();
+            UpdateLoggingLevel();
         }
 
         public void Shutdown()
@@ -186,10 +211,10 @@ async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
             }
         }
 
-        private readonly IDictionary<string,VBComponentsEventsSink> _componentsEventsSinks =
-            new Dictionary<string,VBComponentsEventsSink>();
+        private readonly IDictionary<string, VBComponentsEventsSink> _componentsEventsSinks =
+            new Dictionary<string, VBComponentsEventsSink>();
 
-        private readonly IDictionary<string,ReferencesEventsSink> _referencesEventsSinks = 
+        private readonly IDictionary<string, ReferencesEventsSink> _referencesEventsSinks =
             new Dictionary<string, ReferencesEventsSink>();
 
         async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
@@ -226,7 +251,7 @@ private void RegisterComponentsEventSink(VBComponents components, string project
             }
 
             var connectionPointContainer = (IConnectionPointContainer)components;
-            var interfaceId = typeof (_dispVBComponentsEvents).GUID;
+            var interfaceId = typeof(_dispVBComponentsEvents).GUID;
 
             IConnectionPoint connectionPoint;
             connectionPointContainer.FindConnectionPoint(ref interfaceId, out connectionPoint);
@@ -436,7 +461,7 @@ public void Dispose()
             }
 
             if (_autoSave != null)
-            { 
+            {
                 _autoSave.Dispose();
                 _autoSave = null;
             }

RetailCoder.VBE/NLog.dll.nlog

@@ -2,25 +2,32 @@
 <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       autoReload="true">
-
-  <!-- define various log targets -->
   <targets>
-    <!-- write logs to file -->
-    <target xsi:type="File" name="file"
-        fileName="${specialfolder:folder=ApplicationData}/Rubberduck/logs/${logger}.log"
-        layout="${longdate} ${processid} ${uppercase:${level}} ${message} ${exception:format=tostring}" />
-
-    <!-- log message to event log -->
-    <target xsi:type="EventLog" name="eventLog" source="RubberDuck.VBE" eventId="${event-properties:EventID}"
-            layout="${message}${newline}Call site: ${callsite:className=true:methodName=true}${newline}Logger: ${logger}${newline}${exception:format=tostring}">
+    <target 
+      xsi:type="File" 
+      name="file"
+      fileName="${specialfolder:folder=ApplicationData}/Rubberduck/logs/rubberduck.log"
+      layout="${longdate};${uppercase:${level}};${logger};${message};${exception:format=tostring}"
+      archiveFileName="${specialfolder:folder=ApplicationData}/Rubberduck/logs/archives/log.{#####}.log"
+      archiveAboveSize="5242880"
+      archiveNumbering="Sequence"
+      concurrentWrites="true"
+      keepFileOpen="false"
+      encoding="UTF-8"/>
+    <target 
+      xsi:type="EventLog"
+      name="eventlog" 
+      source="Rubberduck-VBA"
+      layout="${message}${newline}Call site: ${callsite:className=true:methodName=true}${newline}Logger: ${logger}${newline}${exception:format=tostring}">
     </target>
-
-    <!-- increase the performance counter -->
-    <!--target xsi:type="PerfCounter" name="pc1" categoryName="My Log" counterName="My Counter">
-    </target-->
+    <target
+      xsi:type="Debugger"
+      name="debuglog"
+      layout="${longdate};${uppercase:${level}};${logger};${message};${exception:format=tostring}"/>
   </targets>
   <rules>
-    <logger name="*" minlevel="Trace" writeTo="file" />
+    <logger name="*" minlevel="Info" writeTo="file" />
     <logger name="*" minlevel="Error"  writeTo="eventlog"/>
+    <logger name="*" minlevel="Trace" writeTo="debuglog" />
   </rules>
 </nlog>

RetailCoder.VBE/Rubberduck.csproj

@@ -1547,10 +1547,10 @@
   </Target>
   <Import Project="..\packages\Antlr4.4.3.0\build\Antlr4.targets" Condition="Exists('..\packages\Antlr4.4.3.0\build\Antlr4.targets')" />
   <PropertyGroup>
-    <PostBuildEvent>eventcreate /ID 1 /L APPLICATION /T INFORMATION  /SO RubberDuck.VBE /D "Successfully deployed Rubberduck from Visual Studio Build"</PostBuildEvent>
+    <PostBuildEvent>eventcreate /ID 1 /L APPLICATION /T INFORMATION  /SO "Rubberduck-VBA" /D "Successfully deployed Rubberduck from Visual Studio Build"</PostBuildEvent>
   </PropertyGroup>
   <PropertyGroup>
-    <PreBuildEvent>eventcreate /ID 1 /L APPLICATION /T INFORMATION  /SO RubberDuck.VBE /D "Deploying Rubberduck from Visual Studio Build"</PreBuildEvent>
+    <PreBuildEvent>eventcreate /ID 1 /L APPLICATION /T INFORMATION  /SO "Rubberduck-VBA" /D "Deploying Rubberduck from Visual Studio Build"</PreBuildEvent>
   </PropertyGroup>
   <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

RetailCoder.VBE/Settings/GeneralSettings.cs

@@ -8,6 +8,7 @@ public interface IGeneralSettings
         bool AutoSaveEnabled { get; set; }
         int AutoSavePeriod { get; set; }
         char Delimiter { get; set; }
+        bool DetailedLoggingEnabled { get; set; }
     }
 
     [XmlType(AnonymousType = true)]
@@ -17,21 +18,28 @@ public class GeneralSettings : IGeneralSettings
         public bool AutoSaveEnabled { get; set; }
         public int AutoSavePeriod { get; set; }
         public char Delimiter { get; set; }
+        public bool DetailedLoggingEnabled { get; set; }
 
         public GeneralSettings()
         {
             Language = new DisplayLanguageSetting("en-US");
             AutoSaveEnabled = false;
             AutoSavePeriod = 10;
             Delimiter = '.';
+            DetailedLoggingEnabled = false;
         }
 
-        public GeneralSettings(DisplayLanguageSetting language, bool autoSaveEnabled, int autoSavePeriod)
+        public GeneralSettings(
+            DisplayLanguageSetting language, 
+            bool autoSaveEnabled, 
+            int autoSavePeriod, 
+            bool detailedLoggingEnabled)
         {
             Language = language;
             AutoSaveEnabled = autoSaveEnabled;
             AutoSavePeriod = autoSavePeriod;
             Delimiter = '.';
+            DetailedLoggingEnabled = detailedLoggingEnabled;
         }
     }
 }