Changeset 8935 for branches/HeuristicLab.TreeSimplifier/HeuristicLab.Problems.DataAnalysis.Symbolic.Views/3.4/InteractiveSymbolicExpressionTreeChart.cs

Timestamp:

11/22/12 15:03:32 (11 years ago)

Author:

bburlacu

Message:

#1763: Bugfixes and refactoring as suggested in the comments above.

File:

• branches/HeuristicLab.TreeSimplifier/HeuristicLab.Problems.DataAnalysis.Symbolic.Views/3.4/InteractiveSymbolicExpressionTreeChart.cs (modified) (15 diffs)

branches/HeuristicLab.TreeSimplifier/HeuristicLab.Problems.DataAnalysis.Symbolic.Views/3.4/InteractiveSymbolicExpressionTreeChart.cs

@@ -40 +40 @@
       InitializeComponent();
       // add extra actions in the context menu strips
-      this.contextMenuStrip.Opened += this.contextMenuStrip_Opened;
-      this.contextMenuStrip.Items.AddRange(new ToolStripItem[] {
-                                               insertNodeToolStripMenuItem,
-                                               changeValueToolStripMenuItem, 
-                                               copyToolStripMenuItem, 
-                                               cutToolStripMenuItem, 
-                                               deleteToolStripMenuItem, 
-                                               pasteToolStripMenuItem });
+
+
       lastSelected = null;
       currSelected = null;
@@ -53 +47 @@
     }
 
-    public bool TreeValid {
-      get { return TreeState.Valid == treeState; }
-    }
-
+    public bool TreeValid { get { return TreeState.Valid == treeState; } }
     // expose an additional event for signaling to the parent view when the tree structure was modified
     // the emitting of the signal is conditional on the tree being valid, otherwise only a Repaint is issued
@@ -66 +57 @@
         treeState = TreeState.Valid;
         var changed = SymbolicExpressionTreeChanged;
-        if (changed != null) {
+        if (changed != null)
           changed(sender, e);
-        }
       } else {
         treeStatusValue.Text = "Invalid";
@@ -80 +70 @@
       var menu = sender as ContextMenuStrip;
       if (menu == null) return;
-      var point = menu.SourceControl.PointToClient(Cursor.Position);
-      var visualNode = FindVisualSymbolicExpressionTreeNodeAt(point.X, point.Y);
-      if (visualNode != null) {
-        lastSelected = currSelected;
-        if (lastSelected != null) lastSelected.LineColor = Color.Black;
-        currSelected = visualNode;
-        currSelected.LineColor = Color.LightGreen;
-        EnableTreeEditingMenuItems();
-        OnSymbolicExpressionTreeNodeClicked(currSelected, new MouseEventArgs(MouseButtons.Right, 1, point.X, point.Y, 0));
+      if (currSelected == null) {
+        insertNodeToolStripMenuItem.Visible = false;
+        changeValueToolStripMenuItem.Visible = false;
+        copyToolStripMenuItem.Visible = false;
+        cutToolStripMenuItem.Visible = false;
+        deleteToolStripMenuItem.Visible = false;
+        pasteToolStripMenuItem.Visible = false;
       } else {
-        DisableTreeEditingMenuItems();
-      }
-    }
-
-    private void DisableTreeEditingMenuItems() {
-      insertNodeToolStripMenuItem.Visible = false;
-      changeValueToolStripMenuItem.Visible = false;
-      copyToolStripMenuItem.Visible = false;
-      cutToolStripMenuItem.Visible = false;
-      deleteToolStripMenuItem.Visible = false;
-      pasteToolStripMenuItem.Visible = false;
-    }
-
-    private void EnableTreeEditingMenuItems() {
-
-      var node = currSelected.SymbolicExpressionTreeNode;
-      changeValueToolStripMenuItem.Visible = (node is SymbolicExpressionTreeTerminalNode);
-      insertNodeToolStripMenuItem.Visible = !changeValueToolStripMenuItem.Visible;
-      copyToolStripMenuItem.Visible = true;
-      cutToolStripMenuItem.Visible = true;
-      deleteToolStripMenuItem.Visible = true;
-      pasteToolStripMenuItem.Visible = (lastOp == EditOp.CopyNode || lastOp == EditOp.CopySubtree || lastOp == EditOp.CutNode || lastOp == EditOp.CutSubtree) && insertNodeToolStripMenuItem.Visible;
-    }
-
-
-    protected override void SymbolicExpressionTreeChart_MouseClick(object sender, MouseEventArgs e) {
-      VisualSymbolicExpressionTreeNode visualTreeNode = FindVisualSymbolicExpressionTreeNodeAt(e.X, e.Y);
-      if (visualTreeNode != null) {
-        lastSelected = currSelected;
-        if (lastSelected != null) lastSelected.LineColor = Color.Black;
-        currSelected = visualTreeNode;
-        currSelected.LineColor = Color.LightGreen;
-      }
-      Repaint();
-      base.SymbolicExpressionTreeChart_MouseClick(sender, e);
+        var node = currSelected.SymbolicExpressionTreeNode;
+        changeValueToolStripMenuItem.Visible = (node is SymbolicExpressionTreeTerminalNode);
+        insertNodeToolStripMenuItem.Visible = !changeValueToolStripMenuItem.Visible;
+        copyToolStripMenuItem.Visible = true;
+        cutToolStripMenuItem.Visible = true;
+        deleteToolStripMenuItem.Visible = true;
+        pasteToolStripMenuItem.Visible = tempNode != null && insertNodeToolStripMenuItem.Visible;
+      }
+    }
+
+    protected override void OnSymbolicExpressionTreeNodeClicked(object sender, MouseEventArgs e) {
+      var visualTreeNode = FindVisualSymbolicExpressionTreeNodeAt(e.X, e.Y);
+      if (visualTreeNode == null || visualTreeNode == currSelected) return;
+      lastSelected = currSelected;
+      if (lastSelected != null)
+        lastSelected.LineColor = Color.Black;
+      currSelected = visualTreeNode;
+      currSelected.LineColor = Color.LightGreen;
+      Repaint();
+      base.OnSymbolicExpressionTreeNodeClicked(sender, e);
     }
 
@@ -131 +104 @@
       var node = currSelected.SymbolicExpressionTreeNode;
 
-      var dialog = new InsertNodeDialog();
-      dialog.SetAllowedSymbols(node.Grammar.AllowedSymbols.Where(s => s.Enabled && s.InitialFrequency > 0.0 && !(s is ProgramRootSymbol || s is StartSymbol || s is Defun)));
-      dialog.DialogValidated += OnInsertNodeDialogValidated;
-      dialog.ShowDialog(this);
+      using (var dialog = new InsertNodeDialog()) {
+        dialog.SetAllowedSymbols(node.Grammar.AllowedSymbols.Where(s => s.Enabled && s.InitialFrequency > 0.0 && !(s is ProgramRootSymbol || s is StartSymbol || s is Defun)));
+        dialog.DialogValidated += InsertNodeDialog_Validated;
+        dialog.ShowDialog(this);
+      }
     }
 
@@ -140 +114 @@
       if (currSelected == null) return;
       var node = currSelected.SymbolicExpressionTreeNode;
-      var dialog = new ValueChangeDialog();
-      dialog.SetContent(node);
-      dialog.DialogValidated += OnChangeValueDialogValidated;
-      dialog.ShowDialog(this);
+      using (var dialog = new ValueChangeDialog()) {
+        dialog.SetContent(node);
+        dialog.DialogValidated += ChangeValueDialog_Validated;
+        dialog.ShowDialog(this);
+      }
     }
 
     public event EventHandler SymbolicExpressionTreeNodeChanged;
-
-    private void OnChangeValueDialogValidated(object sender, EventArgs e) {
-      SymbolicExpressionTreeNodeChanged(sender, e);
-    }
-
-    private void OnInsertNodeDialogValidated(object sender, EventArgs e) {
+    private void OnSymbolicExpressionTreeNodeChanged(object sender, EventArgs e) {
+      var changed = SymbolicExpressionTreeNodeChanged;
+      if (changed != null)
+        SymbolicExpressionTreeNodeChanged(sender, e);
+    }
+
+    private void ChangeValueDialog_Validated(object sender, EventArgs e) {
+      OnSymbolicExpressionTreeNodeChanged(sender, e);
+    }
+
+    private void InsertNodeDialog_Validated(object sender, EventArgs e) {
       var dialog = (InsertNodeDialog)sender;
       var symbol = dialog.SelectedSymbol();
@@ -172 +152 @@
           }
         }
-        // we assume that there is no case in which the parents subtrees get transferred to node, but node doesn't get added as a subtree of parent
       }
       if (parent.Symbol.MaximumArity > parent.SubtreeCount) {
@@ -210 +189 @@
       lastOp = EditOp.CopyNode;
       tempNode = currSelected.SymbolicExpressionTreeNode;
-      var visualNode = visualTreeNodes[tempNode];
-      visualNode.LineColor = Color.LightGray;
-      visualNode.TextColor = Color.LightGray;
+      currSelected.LineColor = Color.LightGray;
+      currSelected.TextColor = Color.LightGray;
       Repaint();
     }
@@ -223 +201 @@
         visualNode.LineColor = Color.LightGray;
         visualNode.TextColor = Color.LightGray;
-        if (node.SubtreeCount > 0) {
-          foreach (var subtree in node.Subtrees) {
-            var visualLine = visualLines[new Tuple<ISymbolicExpressionTreeNode, ISymbolicExpressionTreeNode>(node, subtree)];
-            visualLine.LineColor = Color.LightGray;
-          }
+        if (node.SubtreeCount <= 0) continue;
+        foreach (var subtree in node.Subtrees) {
+          var visualLine = visualLines[new Tuple<ISymbolicExpressionTreeNode, ISymbolicExpressionTreeNode>(node, subtree)];
+          visualLine.LineColor = Color.LightGray;
         }
       }
@@ -237 +214 @@
       var node = currSelected.SymbolicExpressionTreeNode;
       var parent = node.Parent;
+      if (parent == null || parent.Symbol is StartSymbol || parent.Symbol is ProgramRootSymbol)
+        return; // the operation would result in the deletion of the entire tree
       if (parent.Symbol.MaximumArity >= node.SubtreeCount + parent.SubtreeCount - 1) { // -1 because tempNode will be removed
         parent.RemoveSubtree(parent.IndexOfSubtree(node));
@@ -244 +223 @@
           parent.AddSubtree(child);
         }
-      } else {
-        // if the node cannot be deleted without breaking the tree, do nothing
-        // TODO: decide what to do
-      }
+      }
+      currSelected = null; // because the currently selected node was just deleted
       OnSymbolicExpressionTreeChanged(sender, e);
     }
@@ -255 +232 @@
       var node = currSelected.SymbolicExpressionTreeNode;
       var parent = node.Parent;
+      if (parent == null || parent.Symbol is StartSymbol || parent.Symbol is ProgramRootSymbol)
+        return; // the operation makes no sense as it would result in the deletion of the entire tree
       parent.RemoveSubtree(parent.IndexOfSubtree(node));
+      currSelected = null; // because the currently selected node was just deleted
       OnSymbolicExpressionTreeChanged(sender, e);
     }
@@ -270 +250 @@
         switch (lastOp) {
           case (EditOp.CutNode): {
-              // cut node
+              // when cutting a node from the tree, it's children become children of it's parent
               var parent = tempNode.Parent;
               // arity checks to see if parent can accept node's children (we assume the grammar is already ok with that)
+              // (otherise, the 'cut' part of the operation will just not do anything)
               if (parent.Symbol.MaximumArity >= tempNode.SubtreeCount + parent.SubtreeCount - 1) {
                 // -1 because tempNode will be removed
@@ -282 +263 @@
                 }
                 lastOp = EditOp.CopyNode;
+                currSelected = null;
               }
               break;
@@ -287 +269 @@
           case (EditOp.CutSubtree): {
               // cut subtree
-              tempNode.Parent.RemoveSubtree(tempNode.Parent.IndexOfSubtree(tempNode));
-              lastOp = EditOp.CopySubtree; // do this so the next paste will actually perform a copy
+              var parent = tempNode.Parent;
+              parent.RemoveSubtree(parent.IndexOfSubtree(tempNode));
+              lastOp = EditOp.CopySubtree; // do this so the next paste will actually perform a copy   
+              currSelected = null;
               break;
             }
           case (EditOp.CopyNode): {
               // copy node
-              var clone = tempNode.Clone() as ISymbolicExpressionTreeNode; // should never be null
+              var clone = (SymbolicExpressionTreeNode)tempNode.Clone(); // should never be null
               clone.Parent = tempNode.Parent;
               tempNode = clone;
-              if (tempNode != null && tempNode.SubtreeCount > 0) {
-                for (int i = tempNode.SubtreeCount - 1; i >= 0; --i)
-                  tempNode.RemoveSubtree(i);
-              }
+              for (int i = tempNode.SubtreeCount - 1; i >= 0; --i) tempNode.RemoveSubtree(i);
               break;
             }
           case (EditOp.CopySubtree): {
               // copy subtree
-              var clone = tempNode.Clone() as ISymbolicExpressionTreeNode;
-              if (clone != null) {
-                clone.Parent = tempNode.Parent;
-                tempNode = clone;
-              }
+              var clone = (SymbolicExpressionTreeNode)tempNode.Clone();
+              clone.Parent = tempNode.Parent;
+              tempNode = clone;
               break;
             }
         }
         node.AddSubtree(tempNode);
-        Tree = Tree;
-        // hack in order to trigger the reinitialization of the dictionaries after new nodes appeared in the graph
+        Tree = Tree; // hack in order to trigger the reinitialization of the dictionaries after new nodes appeared in the graph
         OnSymbolicExpressionTreeChanged(sender, e);
-      } else {
-        // throw exception or show a warning to the user about invalid arity
       }
     }