Style and debug.

Cleaned up some code and added a way to enable debug from the settings
panel. That is off by default.

Author: techfreek

AutoLineColor/AutoLineColorMod.cs

@@ -18,8 +18,10 @@ public string Description
             get { return Constants.Description; }
         }
 
-        public void OnSettingsUI(UIHelperBase helper) {
+        public void OnSettingsUI(UIHelperBase helper)
+        {
             Config = Configuration.Instance;
+            Config.FlushStagedChanges(); //make sure no prior changes are still around
             //Generate arrays of colors and naming strategies
             String[] ColorStrategies = Enum.GetNames(typeof(ColorStrategy));
             String[] NamingStrategies = Enum.GetNames(typeof(NamingStrategy));
@@ -31,6 +33,7 @@ public void OnSettingsUI(UIHelperBase helper) {
             group.AddGroup("Advanced Settings");
             group.AddSlider("Max Different Color Picks", 1f, 20f, 1f, (float)Config.MaxDiffColorPickAttempt, Config.MaxDiffColorPickChange);
             group.AddSlider("MinColorDifference", 1f, 100f, 5f, (float)Config.MinColorDiffPercentage, Config.MinColorDiffChange);
+            group.AddCheckbox("Debug", logger.debug, logger.SetDebug);
             group.AddButton("Save", Config.Save);
         }
     }

AutoLineColor/Configuration.cs

@@ -70,30 +70,44 @@ public static Configuration LoadConfig()
                 config = GetDefaultConfig();
             }
 
-            if (isDirty) {
+            if (isDirty)
+            {
                 config.Save();
             }
 
             return config;
         }
 
-        public void ColorStrategyChange(int Strategy) {
+        public void ColorStrategyChange(int Strategy)
+        {
             this.StagedColorStrategy = (ColorStrategy)Strategy;
         }
 
-        public void NamingStrategyChange(int Strategy) {
+        public void NamingStrategyChange(int Strategy)
+        {
             this.StagedNamingStrategy = (NamingStrategy)Strategy;
         }
 
-        public void MinColorDiffChange(float MinDiff) {
+        public void MinColorDiffChange(float MinDiff)
+        {
             this.StagedMinColorDiffPercentage = (int)MinDiff;
         }
 
-        public void MaxDiffColorPickChange(float MaxColorPicks) {
+        public void MaxDiffColorPickChange(float MaxColorPicks)
+        {
             this.StagedMaxDiffColorPickAttempt = (int)MaxColorPicks;
         }
 
-        public void Save() {
+        public void FlushStagedChanges()
+        {
+            StagedColorStrategy = null;
+            StagedNamingStrategy = null;
+            StagedMaxDiffColorPickAttempt = null;
+            StagedMinColorDiffPercentage = null;
+        }
+
+        public void Save()
+        {
             var serializer = new XmlSerializer(typeof(Configuration));
 
             logger.Message("Saving changes to config file");
@@ -115,26 +129,28 @@ public void Save() {
                     : this.MinColorDiffPercentage;
 
             //clear changes and log
-            if (this.StagedColorStrategy.HasValue) {
+            if (this.StagedColorStrategy.HasValue)
+            {
                 logger.Message("ColorStrategy changed to " + this.StagedColorStrategy.Value.ToString());
-                this.StagedColorStrategy = null;
             }
 
-            if (this.StagedNamingStrategy.HasValue) {
+            if (this.StagedNamingStrategy.HasValue)
+            {
                 logger.Message("NamingStrategy changed to " + this.StagedNamingStrategy.Value.ToString());
-                this.StagedNamingStrategy = null;
             }
 
-            if (this.StagedMaxDiffColorPickAttempt.HasValue) {
+            if (this.StagedMaxDiffColorPickAttempt.HasValue)
+            {
                 logger.Message("MaxDiffColorPickAttempt changed to " + this.StagedMaxDiffColorPickAttempt.Value.ToString());
-                this.StagedMaxDiffColorPickAttempt = null;
             }
 
-            if (this.StagedMinColorDiffPercentage.HasValue) {
+            if (this.StagedMinColorDiffPercentage.HasValue)
+            {
                 logger.Message("MinColorDiffPercentage changed to " + this.StagedMinColorDiffPercentage.Value.ToString());
-                this.StagedMinColorDiffPercentage = null;
             }
 
+            FlushStagedChanges();
+
             //How we let the ColorMonitor thread know to update the strategies
             logger.Message("Marking undigested changes");
             this.UndigestedChanges = true;

AutoLineColor/Console.cs

@@ -10,22 +10,26 @@ namespace AutoLineColor
 {
     public class Console
     {
-#if DEBUG
-        private bool debug = true;
-#else
-        private bool debug = false;
-#endif
         private static Console _instance;
+        private bool _debug = false;
 
         private StreamWriter log;
         private bool log_opened;
 
-        private Console() {
-            try {
+        private Console()
+        {
+#if DEBUG
+            _debug = true;
+#endif
+            try
+            {
                 log = new StreamWriter(new FileStream(Constants.LogFileName, FileMode.Append | FileMode.Create, FileAccess.Write, FileShare.ReadWrite));
-            } catch (Exception e) {
+            }
+            catch (Exception e)
+            {
                 WriteMessage("Could not open log file", PluginManager.MessageType.Warning);
             }
+
             log_opened = true;
         }
 
@@ -41,18 +45,39 @@ public static Console Instance
             }
         }
 
+        public bool debug
+        {
+            get
+            {
+                return _debug;
+            }
+        }
+
         private static string FormatMessage(string msg, PluginManager.MessageType Type)
         {
             string formatted;
-            try {
+            try
+            {
                 formatted = string.Format("{0}({1}) {2}", "[AutoLineColor]", Type.ToString(), msg);
-            } catch (Exception e) {
+            }
+            catch (Exception e)
+            {
                 DebugOutputPanel.AddMessage(PluginManager.MessageType.Error, e.ToString());
                 formatted = msg;
             }
             return formatted;
         }
 
+        public void ToggleDebug()
+        {
+            _debug = !_debug;
+        }
+
+        public void SetDebug(bool should_debug)
+        {
+            _debug = should_debug;
+        }
+
         public void Message(string p, PluginManager.MessageType messageType)
         {
             this.WriteMessage(p, messageType);
@@ -72,8 +97,9 @@ public void Error(string p)
             this.WriteMessage(p, PluginManager.MessageType.Error);
         }
 
-        private void WriteMessage(string p, PluginManager.MessageType Type) {
-            if(!this.debug)
+        private void WriteMessage(string p, PluginManager.MessageType Type)
+        {
+            if(!this._debug)
             {
                 return;
             }
@@ -83,7 +109,7 @@ private void WriteMessage(string p, PluginManager.MessageType Type) {
                 log.WriteLine(msg);
                 log.Flush();
             }
-            
+
             //Unity engine logger
             switch(Type)
             {
@@ -100,7 +126,6 @@ private void WriteMessage(string p, PluginManager.MessageType Type) {
                     Debug.Log(msg);
                     break;
             }
-            
         }
     }
 }