Merge pull request #944 from Neverbirth/watches_saving

Store watch expressions between sessions

Author: elsassph

External/Plugins/FlashDebugger/Controls/DataTree/ValueNode.cs

@@ -1,6 +1,7 @@
 using System;
 using flash.tools.debugger;
 using Double = java.lang.Double;
+using System.Text;
 
 namespace FlashDebugger.Controls.DataTree
 {
@@ -34,20 +35,18 @@ public override string Value
                 string temp = null;
                 if (type == VariableType_.MOVIECLIP || type == VariableType_.OBJECT)
                 {
-                    string typeStr = "";
+                    string typeStr = m_Value.getTypeName().ToString();
+                    // rename vector
+                    typeStr = typeStr.Replace("__AS3__.vec::Vector.<", "Vector.<");
                     if (HideFullClasspath)
                     {
                         // return class type without classpath
-                        string typeName = m_Value.getTypeName().ToString();
-                        if (typeName.StartsWith("__AS3__.vec::Vector.<") || typeName.StartsWith("Vector.<"))
-                            typeStr = "Vector.<" + typeName.AfterLast("::", true);
-                        else
-                            typeStr = typeName.After("::", 0, true).Replace("::", ".");
+                        typeStr = CleanTypeClassPaths(typeStr);
                     }
                     else
                     {
                         // return class type with classpath
-                        typeStr = m_Value.getTypeName().ToString().Replace("::", ".");
+                        typeStr = typeStr.Replace("::", ".");
                     }
 
                     // show / hide IDs
@@ -59,12 +58,6 @@ public override string Value
                         typeStr = typeStr.Replace("[]", "Array");
                     }
 
-                    // rename vector
-                    else if (typeStr.StartsWith("__AS3__.vec.Vector.<"))
-                    {
-                        typeStr = typeStr.Replace("__AS3__.vec.Vector.<", "Vector.<");
-                    }
-
                     return typeStr;
                 }
                 else if (type == VariableType_.NUMBER)
@@ -206,24 +199,6 @@ public bool IsPrimitive
             }
         }
 
-        
-        private string Escape(string text)
-        {
-            text = text.Replace("\\", "\\\\");
-            text = text.Replace("\"", "\\\"");
-            text = text.Replace("\0", "\\0");
-            text = text.Replace("\a", "\\a");
-            text = text.Replace("\b", "\\b");
-            text = text.Replace("\f", "\\f");
-            text = text.Replace("\n", "\\n");
-            text = text.Replace("\r", "\\r");
-            text = text.Replace("\t", "\\t");
-            text = text.Replace("\v", "\\v");
-            if (text.Length > 65533)
-                text = text.Substring(0, 65533 - 5) + "[...]";
-            return text;
-        }
-
         public Value PlayerValue
         {
             get
@@ -274,6 +249,67 @@ public ValueNode(string text, Value value)
             m_Value = value;
         }
 
+        internal static string Escape(string text)
+        {
+            text = text.Replace("\\", "\\\\");
+            text = text.Replace("\"", "\\\"");
+            text = text.Replace("\0", "\\0");
+            text = text.Replace("\a", "\\a");
+            text = text.Replace("\b", "\\b");
+            text = text.Replace("\f", "\\f");
+            text = text.Replace("\n", "\\n");
+            text = text.Replace("\r", "\\r");
+            text = text.Replace("\t", "\\t");
+            text = text.Replace("\v", "\\v");
+            if (text.Length > 65533)
+                text = text.Substring(0, 65533 - 5) + "[...]";
+            return text;
+        }
+
+        /// <summary>
+        /// Removes any class path from a fully qualified name. Eg.: flash.display::Sprite becomes Sprite
+        /// </summary>
+        /// <param name="qualifiedName">The fully qualified name to clean</param>
+        /// <returns>The class name with no class paths</returns>
+        internal static string CleanTypeClassPaths(string qualifiedName)
+        {
+            char[] delims = { ',', ' ', '<', '>' };
+            var buffer = new StringBuilder();
+            bool inPackage = false;
+
+            /**
+               In order to strip the class-path we are going to traverse the class type in 
+                 reverse so we don't need to keep extra buffers or use complex splitting or regexes.
+               Packages are always separated by colons or dots, so the first time we found one we
+                 are on the package (watch out with Vector.<> notation), and the whole type is always
+                 together, so any delim means that we finished with the type, and since this comes
+                 from the debugger we know that we are not going to find any other type delimiter,
+                 or incomplete/wrong case. We could check for Char.IsWhiteSpace for other uses.
+               In resume, with this method we could support without much problem even complex cases like:
+                 Collections.Generic.Dictionary<Collections.Generic.Dictionary<String, Test.CustomClassKey>, Collections.Generic.List<Test.CustomClass>>
+            */
+            for (int i = qualifiedName.Length - 1; i >= 0; i--)
+            {
+                char c = qualifiedName[i];
+
+                if (inPackage)
+                {
+                    if (Array.IndexOf(delims, c) < 0)
+                        continue;
+
+                    inPackage = false;
+                }
+                else if ((c == '.' && qualifiedName[i + 1] != '<') || c == ':')
+                {
+                    inPackage = true;
+                    continue;
+                }
+
+                buffer.Insert(0, c);
+            }
+
+            return buffer.ToString();
+        }
     }
 
 }

External/Plugins/FlashDebugger/Controls/WatchUI.cs

@@ -1,7 +1,7 @@
 using System;
-using System.Collections.Generic;
 using System.Windows.Forms;
 using FlashDebugger.Controls.DataTree;
+using FlashDebugger.Debugger;
 using PluginCore;
 using PluginCore.Localization;
 using flash.tools.debugger;
@@ -12,20 +12,26 @@ namespace FlashDebugger.Controls
     public class WatchUI : DockPanelControl
     {
         private DataTreeControl treeControl;
-        private List<string> watches;
+        private WatchManager watchManager;
 
-        public WatchUI()
+        public WatchUI(WatchManager watchManager)
         {
             this.AutoKeyHandling = true;
-            watches = new List<string>();
-            treeControl = new DataTreeControl(true);
+            this.treeControl = new DataTreeControl(true);
             this.treeControl.Tree.BorderStyle = BorderStyle.None;
             this.treeControl.Resize += new EventHandler(this.TreeControlResize);
             this.treeControl.Tree.Font = PluginBase.Settings.DefaultFont;
             this.treeControl.Dock = DockStyle.Fill;
             this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
             this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
             this.Controls.Add(this.treeControl);
+
+            this.watchManager = watchManager;
+            this.watchManager.ExpressionAdded += WatchManager_ExpressionAdded;
+            this.watchManager.ExpressionRemoved += WatchManager_ExpressionRemoved;
+            this.watchManager.ExpressionReplaced += WatchManager_ExpressionReplaced;
+            this.watchManager.ExpressionsCleared += WatchManager_ExpressionsCleared;
+            this.watchManager.ExpressionsLoaded += WatchManager_ExpressionsLoaded;
         }
 
         private void TreeControlResize(Object sender, EventArgs e)
@@ -35,50 +41,63 @@ private void TreeControlResize(Object sender, EventArgs e)
             this.treeControl.Tree.Columns[1].Width = w - 8;
         }
 
-        public bool AddElement(string item)
+        private void WatchManager_ExpressionAdded(Object sender, WatchExpressionArgs e)
         {
-            if (watches.Contains(item)) return false;
-            watches.Add(item);
-            treeControl.Nodes.Insert(watches.Count - 1, GetExpressionNode(item));
+            treeControl.Nodes.Insert(e.Position, GetExpressionNode(e.Expression));
             UpdateElements();
-            return true;
+        }
+
+        private void WatchManager_ExpressionRemoved(Object sender, WatchExpressionArgs e)
+        {
+            UpdateElements();
+        }
+
+        private void WatchManager_ExpressionReplaced(Object sender, WatchExpressionReplaceArgs e)
+        {
+            treeControl.Nodes[e.Position] = GetExpressionNode(e.NewExpression);
+        }
+
+        private void WatchManager_ExpressionsCleared(Object sender, EventArgs e)
+        {
+            treeControl.Nodes.Clear();
+        }
+
+        private void WatchManager_ExpressionsLoaded(Object sender, EventArgs e)
+        {
+            UpdateElements();
+        }
+
+        public bool AddElement(string item)
+        {
+            return watchManager.Add(item);
         }
 
         public void RemoveElement(string item)
         {
-            if (watches.Remove(item)) UpdateElements();
+            watchManager.Remove(item);
         }
 
         public void RemoveElement(int itemN)
         {
-            if (itemN < watches.Count) watches.RemoveAt(itemN);
-            treeControl.Nodes.RemoveAt(itemN);
+            watchManager.RemoveAt(itemN);
         }
 
         public bool ReplaceElement(string oldItem, string newItem)
         {
-            if (watches.Contains(newItem)) return false;
-            int itemN = watches.IndexOf(oldItem);
-            if (itemN == -1) AddElement(newItem);
-            else
-            {
-                watches[itemN] = newItem;
-                treeControl.Nodes[itemN] = GetExpressionNode(newItem);
-            }
-            return true;
+            return watchManager.Replace(oldItem, newItem);
         }
 
         public void Clear()
         {
-            watches.Clear();
-            treeControl.Nodes.Clear();
+            watchManager.ClearAll();
         }
 
         public void UpdateElements()
         {
             treeControl.Tree.BeginUpdate();
             treeControl.SaveState();
             treeControl.Nodes.Clear();
+            var watches = watchManager.Watches;
             foreach (string item in watches)
             {
                 treeControl.AddNode(GetExpressionNode(item));
@@ -94,6 +113,11 @@ private DataNode GetExpressionNode(string item)
             DataNode node;
             try
             {
+                if (!PluginMain.debugManager.FlashInterface.isDebuggerStarted || !PluginMain.debugManager.FlashInterface.isDebuggerSuspended )
+                {
+                    return new ErrorNode(item, new Exception(""));
+                }
+
                 IASTBuilder builder = new ASTBuilder(false);
                 ValueExp exp = builder.parse(new java.io.StringReader(item));
                 var ctx = new ExpressionContext(PluginMain.debugManager.FlashInterface.Session, PluginMain.debugManager.FlashInterface.GetFrames()[PluginMain.debugManager.CurrentFrame]);

External/Plugins/FlashDebugger/Debugger/DebuggerManager.cs

@@ -384,7 +384,7 @@ private void flashInterface_DisconnectedEvent(object sender)
             }
             PanelsHelper.localsUI.TreeControl.Nodes.Clear();
             PanelsHelper.stackframeUI.ClearItem();
-            PanelsHelper.watchUI.Clear();
+            PanelsHelper.watchUI.UpdateElements();
             PanelsHelper.threadsUI.ClearItem();
             PluginMain.breakPointManager.ResetAll();
             PluginBase.MainForm.ProgressBar.Visible = false;