Merge pull request #911 from Hosch250/AutoSave

Auto save

Author: retailcoder

RetailCoder.VBE/App.cs

@@ -1,12 +1,11 @@
 using System;
-using System.Collections.Concurrent;
 using System.Globalization;
 using System.Linq;
-using System.Threading;
 using System.Threading.Tasks;
 using System.Windows.Forms;
 using Microsoft.Vbe.Interop;
 using NLog;
+using Rubberduck.AutoSave;
 using Rubberduck.Common;
 using Rubberduck.Inspections;
 using Rubberduck.Parsing;
@@ -26,6 +25,7 @@ public class App : IDisposable
         private readonly IParserErrorsPresenterFactory _parserErrorsPresenterFactory;
         private readonly IRubberduckParser _parser;
         private readonly IInspectorFactory _inspectorFactory;
+        private readonly AutoSave.AutoSave _autoSave;
         private readonly IGeneralConfigService _configService;
         private readonly IAppMenu _appMenus;
         private readonly ParserStateCommandBar _stateBar;
@@ -39,7 +39,7 @@ public class App : IDisposable
         public App(VBE vbe, IMessageBox messageBox,
             IParserErrorsPresenterFactory parserErrorsPresenterFactory,
             IRubberduckParser parser,
-            IInspectorFactory inspectorFactory, 
+            IInspectorFactory inspectorFactory,
             IGeneralConfigService configService,
             IAppMenu appMenus,
             ParserStateCommandBar stateBar,
@@ -51,6 +51,7 @@ public App(VBE vbe, IMessageBox messageBox,
             _parserErrorsPresenterFactory = parserErrorsPresenterFactory;
             _parser = parser;
             _inspectorFactory = inspectorFactory;
+            _autoSave = new AutoSave.AutoSave(_vbe, new AutoSaveSettings());
             _configService = configService;
             _appMenus = appMenus;
             _stateBar = stateBar;
@@ -208,6 +209,7 @@ public void Dispose()
             _hooks.MessageReceived -= hooks_MessageReceived;
             _configService.SettingsChanged -= _configService_SettingsChanged;
             _parser.State.StateChanged -= Parser_StateChanged;
+            _autoSave.Dispose();
 
             _hooks.Dispose();
         }

RetailCoder.VBE/AutoSave/AutoSave.cs

@@ -0,0 +1,80 @@
+using System;
+using System.IO;
+using System.Linq;
+using System.Timers;
+using Microsoft.Vbe.Interop;
+
+namespace Rubberduck.AutoSave
+{
+    public class AutoSave : IDisposable
+    {
+        private readonly VBE _vbe;
+        private readonly IAutoSaveSettings _settings;
+        // ReSharper disable once InconsistentNaming
+        private readonly Timer _timer = new Timer();
+
+        public bool IsEnabled
+        {
+            get { return _timer.Enabled; }
+            set { _timer.Enabled = value; }
+        }
+
+        public double TimerDelay
+        {
+            get { return _timer.Interval; }
+            set { _timer.Interval = value; }
+        }
+
+        public AutoSave(VBE vbe, IAutoSaveSettings settings)
+        {
+            _vbe = vbe;
+            _settings = settings;
+
+            _settings.PropertyChanged += _settings_PropertyChanged;
+
+            _timer.Enabled = _settings.IsEnabled;
+            _timer.Interval = _settings.TimerDelay;
+
+            _timer.Elapsed += _timer_Elapsed;
+        }
+
+        void _settings_PropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
+        {
+            if (e.PropertyName == "IsEnabled")
+            {
+                _timer.Enabled = _settings.IsEnabled;
+            }
+            if (e.PropertyName == "TimerDelay")
+            {
+                _timer.Interval = _settings.TimerDelay;
+            }
+        }
+
+        private void _timer_Elapsed(object sender, ElapsedEventArgs e)
+        {
+            if (_vbe.VBProjects.OfType<VBProject>().Any(p => !p.Saved))
+            {
+                try
+                {
+                    // iterate to find if a file exists for each open project
+                    // I do hope the compiler doesn't optimize this out
+                    _vbe.VBProjects.OfType<VBProject>().Select(p => p.FileName).ToList();
+                }
+                catch (DirectoryNotFoundException)
+                {
+                    return;
+                }
+
+                _vbe.CommandBars.FindControl(Id: 3).Execute();
+            }
+        }
+
+        public void Dispose()
+        {
+            _settings.PropertyChanged -= _settings_PropertyChanged;
+            _timer.Elapsed -= _timer_Elapsed;
+
+            _timer.Dispose();
+        }
+    }
+}

RetailCoder.VBE/AutoSave/AutoSaveSettings.cs

@@ -0,0 +1,59 @@
+using System;
+using System.ComponentModel;
+using System.Runtime.CompilerServices;
+
+namespace Rubberduck.AutoSave
+{
+    public interface IAutoSaveSettings : INotifyPropertyChanged
+    {
+        bool IsEnabled { get; set; }
+        double TimerDelay { get; set; }
+    }
+
+    public class AutoSaveSettings : IAutoSaveSettings
+    {
+        public AutoSaveSettings(bool isEnabled = true, int timerDelay = 600000)
+        {
+            IsEnabled = isEnabled;
+            TimerDelay = timerDelay;
+        }
+
+        private bool _isEnabled;
+        public bool IsEnabled
+        {
+            get { return _isEnabled; }
+            set
+            {
+                if (_isEnabled != value)
+                {
+                    _isEnabled = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
+
+        private double _timerDelay;
+        public double TimerDelay
+        {
+            get { return _timerDelay; }
+            set
+            {
+                if (Math.Abs(_timerDelay - value) > .1)
+                {
+                    _timerDelay = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
+
+        public event PropertyChangedEventHandler PropertyChanged;
+        protected virtual void OnPropertyChanged([CallerMemberName] string propertyName = null)
+        {
+            var handler = PropertyChanged;
+            if (handler != null)
+            {
+                handler(this, new PropertyChangedEventArgs(propertyName));
+            }
+        }
+    }
+}

RetailCoder.VBE/Rubberduck.csproj

@@ -268,6 +268,8 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="AppMenu.cs" />
+    <Compile Include="AutoSave\AutoSave.cs" />
+    <Compile Include="AutoSave\AutoSaveSettings.cs" />
     <Compile Include="Common\ClipboardWriter.cs" />
     <Compile Include="Common\DeclarationExtensions.cs" />
     <Compile Include="Common\HookEventArgs.cs" />

Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

@@ -30,6 +30,7 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Microsoft.CSharp" />
     <Reference Include="Microsoft.Office.Interop.Access, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c">
       <SpecificVersion>False</SpecificVersion>
       <EmbedInteropTypes>True</EmbedInteropTypes>

Rubberduck.VBEEditor/VBEHost/AccessApp.cs

@@ -1,3 +1,4 @@
+using System.Reflection;
 using Microsoft.Office.Interop.Access;
 
 namespace Rubberduck.VBEditor.VBEHost

Rubberduck.VBEEditor/VBEHost/HostApplicationBase.cs

@@ -26,10 +26,7 @@ protected HostApplicationBase(string applicationName)
 
         ~HostApplicationBase()
         {
-            if (Application != null)
-            {
-                Marshal.ReleaseComObject(Application);
-            }
+			Dispose(false);
         }
 
         public string ApplicationName
@@ -41,12 +38,42 @@ public string ApplicationName
 
         public TimeSpan TimedMethodCall(QualifiedMemberName qualifiedMemberName)
         {
+			if (_disposed)
+			{
+				throw new ObjectDisposedException(GetType().Name);
+			}
+		
             var stopwatch = Stopwatch.StartNew();
 
             Run(qualifiedMemberName);
 
             stopwatch.Stop();
             return stopwatch.Elapsed;
         }
+
+        public void Dispose()
+        {
+            Dispose(true);
+			GC.SuppressFinalize(this);
+        }
+
+		private bool _disposed;
+        protected virtual void Dispose(bool disposing)
+        {
+			if (_disposed) { return; }
+			
+			// clean up managed resources
+			if (Application != null)
+            {
+                Marshal.ReleaseComObject(Application);
+            }
+		
+            if (disposing) 
+			{ 
+				// we don't have any managed resources to clean up right now.
+			}
+
+			_disposed = true;
+        }
     }
 }

Rubberduck.VBEEditor/VBEHost/IHostApplication.cs

@@ -2,7 +2,7 @@
 
 namespace Rubberduck.VBEditor.VBEHost
 {
-    public interface IHostApplication
+    public interface IHostApplication : IDisposable
     {
         /// <summary>
         /// Runs VBA procedure specified by name.