Merge lp:~spud/spud/group-view into lp:spud

[Fraser Waters]

Allows nodes to be grouped together in the LHS hiding all other nodes.

[Patrick Farrell (pefarrell)]

Fraser and I went through several debugging iterations, and I've read the code. Time to push it out to the users for more thorough testing, I think ...

review: Approve

=== modified file 'diamond/diamond/choice.py'
--- diamond/diamond/choice.py	2011-07-25 13:41:47 +0000
+++ diamond/diamond/choice.py	2011-07-26 16:19:41 +0000
@@ -196,5 +196,11 @@
 
   def is_sliceable(self):
     return self.get_current_tree().is_sliceable()
+ 
+  def __str__(self):
+    """
+    Returns the display name of the selected tree.
+    """
+    return self.get_display_name()
 
 gobject.type_register(Choice)

=== modified file 'diamond/diamond/interface.py'
--- diamond/diamond/interface.py	2011-07-25 13:51:34 +0000
+++ diamond/diamond/interface.py	2011-07-26 16:19:41 +0000
@@ -90,7 +90,7 @@
   treeview: the LHS tree widget
 
 Important routines:
-  cellcombo_edited: called when a choice is selected on the left-hand pane
+  cellcombo_changed: called when a choice is selected on the left-hand pane
   init_treemodel: set up the treemodel and treeview
   on_treeview_clicked: when a row is clicked, process the consequences (e.g. activate inactive instance)
   set_treestore: stuff the treestore with a given tree.Tree
@@ -139,7 +139,10 @@
                     "on_copy_spud_path": self.on_copy_spud_path,
                     "on_copy": self.on_copy,
                     "on_paste": self.on_paste,
-                    "on_slice": self.on_slice}
+                    "on_slice": self.on_slice,
+                    "on_group": self.on_group,
+                    "on_ungroup": self.on_ungroup}
+
     self.gui.signal_autoconnect(signals)
 
     self.main_window = self.gui.get_widget("mainWindow")
@@ -157,6 +160,7 @@
     self.suffix = suffix
 
     self.selected_node = None
+    self.selected_iter = None
     self.update_options_frame()
 
     self.file_path = os.getcwd()
@@ -668,7 +672,7 @@
     ios = StringIO.StringIO(clipboard.wait_for_text())
     
     if self.selected_iter is not None:    
-      node = self.treestore.get_value(self.selected_iter, 3)
+      node = self.treestore.get_value(self.selected_iter, 1)
 
     if node != None:
 
@@ -729,6 +733,80 @@
   def _slice_destroy(self, widget):
     self.on_select_row()
 
+
+  groupmode = False
+
+  def on_group(self, widget = None):
+    """
+    Clears the treeview and then fills it with nodes 
+    with the same type as the selected node.
+    """
+
+    if self.selected_node == self.tree or not self.selected_iter:
+      self.statusbar.set_statusbar("Cannot group on this element.")
+      return #Group on the entire tree... ie don't group or nothing selected
+
+    self.gui.get_widget("menuitemUngroup").show()
+    self.gui.get_widget("popupmenuitemUngroup").show()
+
+    self.groupmode = True
+    node, tree = self.treestore.get(self.selected_iter, 0, 1)
+    
+    self.treeview.freeze_child_notify()
+    self.treeview.set_model(None)
+
+    def get_nodes(node, tree):
+      nodes = []
+
+      if isinstance(tree, choice.Choice):
+        child = tree.get_current_tree()
+        if child.name == node.name:
+          nodes.append(tree)
+        nodes += get_nodes(node, child)
+      else:
+        for child in tree.get_children():
+          if child.name == node.name:
+            nodes.append(child)
+          nodes += get_nodes(node, child)
+
+      return nodes
+    
+    self.set_treestore(None, get_nodes(tree, self.tree), True)
+
+    self.treeview.set_model(self.treestore)
+    self.treeview.thaw_child_notify()
+
+    path = self.get_treestore_path_from_node(node)
+    self.treeview.get_selection().select_path(path)
+
+    return
+
+  def on_ungroup(self, widget = None):
+    """
+    Restores the treeview to normal.
+    """
+
+    self.gui.get_widget("menuitemUngroup").hide()
+    self.gui.get_widget("popupmenuitemUngroup").hide()
+
+    self.groupmode = False
+    node = self.treestore.get_value(self.selected_iter, 0)
+
+    self.treeview.freeze_child_notify()
+    self.treeview.set_model(None)
+
+    self.set_treestore(None, [self.tree], True)
+
+    self.treeview.set_model(self.treestore)
+    self.treeview.thaw_child_notify()
+
+    path = self.get_treestore_path_from_node(node)
+    self.treeview.expand_to_path(path)
+    self.treeview.scroll_to_cell(path)
+    self.treeview.get_selection().select_path(path)
+ 
+    return
+
   ## LHS ###
 
   def init_datatree(self):
@@ -773,16 +851,14 @@
     self.treeview.get_selection().set_select_function(self.options_tree_select_func)
     self.options_tree_select_func_enabled = True
 
-    model = gtk.ListStore(str, str, gobject.TYPE_PYOBJECT)
     self.cellcombo = cellCombo = gtk.CellRendererCombo()
-    cellCombo.set_property("model", model)
     cellCombo.set_property("text-column", 0)
     cellCombo.set_property("editable", True)
     cellCombo.set_property("has-entry", False)
-    cellCombo.connect("edited", self.cellcombo_edited)
+    cellCombo.connect("changed", self.cellcombo_changed)
 
     # Node column
-    column = gtk.TreeViewColumn("Node", cellCombo, text=0)
+    column = gtk.TreeViewColumn("Node", cellCombo)
     column.set_property("expand", True)
     column.set_resizable(True)
     column.set_cell_data_func(cellCombo, self.set_combobox_liststore)
@@ -800,12 +876,11 @@
     imgcolumn.set_cell_data_func(cellPicture, self.set_cellpicture_cardinality)
     optionsTree.append_column(imgcolumn)
 
-    # 0: display name, 
-    # 1: gtk.ListStore containing the display names of possible choices
-    # 2: pointer to node in self.tree -- a choice or a tree
-    # 3: pointer to currently active tree
+    # 0: pointer to node in self.tree -- a choice or a tree
+    # 1: pointer to currently active tree
+    # 2: gtk.ListStore containing the display names of possible choices
 
-    self.treestore = gtk.TreeStore(str, gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT)
+    self.treestore = gtk.TreeStore(gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT)
     self.treeview.set_model(self.treestore)
     self.treeview.set_enable_search(False)
 
@@ -820,8 +895,7 @@
     liststore = gtk.ListStore(str, gobject.TYPE_PYOBJECT)
 
     for t in choice_or_tree.get_choices():
-      name = t.get_display_name()
-      liststore.append([name, t])
+      liststore.append([str(t), t])
 
     return liststore
   
@@ -851,9 +925,9 @@
         liststore = self.create_liststore(t)
 
         if replace:
-          child_iter = self.treestore.insert_before(iter, replacediter, [t.get_display_name(), liststore, t, t])
+          child_iter = self.treestore.insert_before(iter, replacediter, [t, t, liststore])
         else:
-          child_iter = self.treestore.append(iter, [t.get_display_name(), liststore, t, t])
+          child_iter = self.treestore.append(iter, [t, t, liststore])
 
         attrid = t.connect("on-set-attr", self.on_set_attr, self.treestore.get_path(child_iter))
         dataid = t.connect("on-set-data", self.on_set_data, self.treestore.get_path(child_iter))
@@ -871,9 +945,9 @@
           continue
 
         if replace:
-          child_iter = self.treestore.insert_before(iter, replacediter, [ts_choice.get_display_name(), liststore, t, ts_choice])
+          child_iter = self.treestore.insert_before(iter, replacediter, [t, ts_choice, liststore])
         else:
-          child_iter = self.treestore.append(iter, [ts_choice.get_display_name(), liststore, t, ts_choice])
+          child_iter = self.treestore.append(iter, [t, ts_choice, liststore])
 
         attrid = t.connect("on-set-attr", self.on_set_attr, self.treestore.get_path(child_iter))
         dataid = t.connect("on-set-data", self.on_set_data, self.treestore.get_path(child_iter))
@@ -916,7 +990,7 @@
         self.set_treestore(iter, [])
         return
 
-    choice_or_tree, active_tree = self.treestore.get(iter, 2, 3)
+    choice_or_tree, active_tree = self.treestore.get(iter, 0, 1)
     if active_tree.active is False or choice_or_tree.active is False:
       return
 
@@ -927,7 +1001,7 @@
     child_iter = self.treestore.iter_children(iter)
     while child_iter is not None:
       # fix for recursive schemata!
-      child_active_tree = self.treestore.get_value(child_iter, 3)
+      child_active_tree = self.treestore.get_value(child_iter, 1)
       if child_active_tree.schemaname == active_tree.schemaname:
         debug.deprint("Warning: recursive schema elements not supported: %s" % active_tree.name)
         child_iter = self.treestore.iter_next(child_iter)
@@ -961,15 +1035,20 @@
     foreground colour.
     """
 
-    liststore, choice_or_tree, active_tree = self.treestore.get(iter, 1, 2, 3)
-
-    # set the model for the cellcombo, where it gets the possible choices for the name
+    choice_or_tree, active_tree, liststore = self.treestore.get(iter, 0, 1, 2)
+
+    if self.groupmode and self.treestore.iter_parent(iter) is None:
+      cellCombo.set_property("text", choice_or_tree.get_name_path())
+    else:
+      cellCombo.set_property("text", str(choice_or_tree))
+
+
     cellCombo.set_property("model", liststore)
 
     # set the properties: colour, etc.
-    if choice_or_tree.__class__ is tree.Tree:
+    if isinstance(choice_or_tree, tree.Tree):
       cellCombo.set_property("editable", False)
-    elif choice_or_tree.__class__ is choice.Choice:
+    elif isinstance(choice_or_tree, choice.Choice):
       cellCombo.set_property("editable", True)
 
     if self.treestore_iter_is_active(iter):
@@ -987,8 +1066,8 @@
     This hook function sets up the other gtk.CellRendererPixbuf, the one that gives
     the clue to the user whether this is a choice or not.
     """
-
-    choice_or_tree = self.treestore.get_value(iter, 2)
+    
+    choice_or_tree = self.treestore.get_value(iter, 0)
     if isinstance(choice_or_tree, tree.Tree):
       cell.set_property("stock-id", None)
     elif isinstance(choice_or_tree, choice.Choice):
@@ -1003,7 +1082,7 @@
     something can be added or removed or has to be there.
     """
 
-    choice_or_tree = self.treestore.get_value(iter, 2)
+    choice_or_tree = self.treestore.get_value(iter, 0)
     if choice_or_tree.cardinality == "":
       cell.set_property("stock-id", None)
     elif choice_or_tree.cardinality == "?" or choice_or_tree.cardinality == "*":
@@ -1029,7 +1108,7 @@
     Toggles the state of part of the tree.
     """
 
-    choice_or_tree = self.treestore.get_value(iter, 2)
+    choice_or_tree = self.treestore.get_value(iter, 0)
 
     if choice_or_tree.active:
       self.collapse_tree(iter)
@@ -1045,13 +1124,8 @@
     Collapses part of the tree.
     """
 
-    choice_or_tree, = self.treestore.get(iter, 2)
-    parent_iter = self.treestore.iter_parent(iter)
-
-    if parent_iter == None:
-      parent_tree = None
-    else:
-      parent_tree = self.treestore.get_value(parent_iter, 3)
+    choice_or_tree, = self.treestore.get(iter, 0)
+    parent_tree = choice_or_tree.parent
 
     if not choice_or_tree.active:
       return
@@ -1088,16 +1162,11 @@
     return
 
   def delete_tree(self, iter):
-    choice_or_tree, = self.treestore.get(iter, 2)
-    parent_iter = self.treestore.iter_parent(iter)
+    choice_or_tree, = self.treestore.get(iter, 0)
+    parent_tree = choice_or_tree.parent
     isSelected = self.treeview.get_selection().iter_is_selected(iter)
     sibling = self.treestore.iter_next(iter)
 
-    if parent_iter == None:
-      parent_tree = None
-    else:
-      parent_tree = self.treestore.get_value(parent_iter, 3)
-
     confirm = dialogs.prompt(self.main_window, "Are you sure you want to delete this node?")
     if confirm == gtk.RESPONSE_YES:
       parent_tree.delete_child_by_ref(choice_or_tree)
@@ -1114,13 +1183,8 @@
     Expands part of the tree.
     """
 
-    choice_or_tree, active_tree = self.treestore.get(iter, 2, 3)
-    parent_iter = self.treestore.iter_parent(iter)
-
-    if parent_iter == None:
-      parent_tree = None
-    else:
-      parent_tree = self.treestore.get_value(parent_iter, 3)
+    choice_or_tree, active_tree = self.treestore.get(iter, 0, 1)
+    parent_tree = choice_or_tree.parent
 
     if choice_or_tree.active:
       return
@@ -1140,8 +1204,7 @@
       liststore = self.create_liststore(new_tree)
       self.expand_treestore(iter)
       iter = self.treestore.insert_after(
-        parent=parent_iter, sibling=iter, 
-        row=[new_tree.get_display_name(), liststore, new_tree, new_tree.get_current_tree()])
+        None, iter, [new_tree, new_tree.get_current_tree(), liststore])
       attrid = new_tree.connect("on-set-attr", self.on_set_attr, self.treestore.get_path(iter))
       dataid = new_tree.connect("on-set-data", self.on_set_data, self.treestore.get_path(iter))
       self.signals[new_tree] = (attrid, dataid)
@@ -1243,7 +1306,7 @@
       return  
 
     self.selected_iter = iter = self.treestore.get_iter(path)
-    choice_or_tree, active_tree = self.treestore.get(iter, 2, 3)
+    choice_or_tree, active_tree = self.treestore.get(iter, 0, 1)
 
     debug.dprint(active_tree)
 
@@ -1367,26 +1430,18 @@
 
     return
 
-  def cellcombo_edited(self, cellrenderertext, path, new_text):
+  def cellcombo_changed(self, combo, tree_path, combo_iter):
     """
     This is called when a cellcombo on the left-hand treeview is edited,
     i.e. the user chooses between more than one possible choice.
     """
 
-    iter = self.treestore.get_iter(path)
-    self.treestore.set(iter, 0, new_text)
-    choice = self.treestore.get_value(iter, 2)
+    tree_iter = self.treestore.get_iter(tree_path)
+    choice = self.treestore.get_value(tree_iter, 0)
 
     # get the ref to the new active choice
-    liststore = self.treestore.get_value(iter, 1)
-    list_iter = liststore.get_iter_first()
-    ref = None
-    while list_iter is not None:
-      list_text = liststore.get_value(list_iter, 0)
-      if list_text == new_text:
-        ref = liststore.get_value(list_iter, 1)
-        break
-      list_iter = liststore.iter_next(list_iter)
+    liststore = self.treestore.get_value(tree_iter, 2)
+    ref = liststore.get_value(combo_iter, 1)
 
     # record the choice in the datatree
     choice.set_active_choice_by_ref(ref)
@@ -1394,7 +1449,7 @@
 
     name = self.get_spudpath(new_active_tree)
     self.statusbar.set_statusbar(name)
-    self.treestore.set(iter, 3, new_active_tree)
+    self.treestore.set(tree_iter, 1, new_active_tree)
     self.current_spudpath = name
     xpath = self.get_xpath(new_active_tree)
     self.current_xpath = xpath
@@ -1405,12 +1460,12 @@
       if plugin.matches(xpath):
         self.add_plugin_button(plugin)
 
-    self.remove_children(iter)
-    self.expand_treestore(iter)
-    self.treeview.expand_row(path, False)
+    self.remove_children(tree_iter)
+    self.expand_treestore(tree_iter)
+    self.treeview.expand_row(tree_path, False)
 
     self.set_saved(False)
-    self.selected_node = self.get_painted_tree(iter)
+    self.selected_node = self.get_painted_tree(tree_iter)
     self.update_options_frame()
 
     return
@@ -1435,20 +1490,7 @@
     if attr != "name":
       return
 
-    iter = self.treestore.get_iter(path)
-    liststore = self.treestore.get_value(iter, 1)
-    active_tree = self.treestore.get_value(iter, 3)
-    new_name = active_tree.get_display_name()
-    self.treestore.set_value(iter, 0, new_name)
-
-    # find the liststore iter corresponding to the painted choice
-    list_iter = liststore.get_iter_first()
-    while list_iter is not None:
-      liststore_tree = liststore.get_value(list_iter, 1)
-      if liststore_tree is active_tree:
-        liststore.set_value(list_iter, 0, new_name)
-      list_iter = liststore.iter_next(list_iter)
-
+    self.treeview.queue_draw()
     self.treeview.queue_resize()
 
   def get_painted_tree(self, iter_or_tree, lock_geometry_dim = True):
@@ -1465,7 +1507,7 @@
     if isinstance(iter_or_tree, tree.Tree):
       active_tree = iter_or_tree
     else:
-      active_tree = self.treestore.get_value(iter_or_tree, 3)
+      active_tree = self.treestore.get_value(iter_or_tree, 1)
 
     painted_tree = active_tree.get_mixed_data()
 
@@ -1505,7 +1547,26 @@
         return None
 
     return iter
+
+  def get_treestore_path_from_node(self, node):
+    """
+    Look for the path for the given node.
+    """
     
+    def search(iter, node, indent=""):
+      while iter:
+        if self.treestore.get_value(iter, 0) is node:
+          return iter
+        else:
+          child = search(self.treestore.iter_children(iter), node, indent + "  ")
+          if child: return child
+
+          iter = self.treestore.iter_next(iter)      
+      return iter
+
+    iter = search(self.treestore.get_iter_first(), node)
+    return self.treestore.get_path(iter) if iter else None
+ 
   def set_geometry_dim_tree(self):
     """
     Find the iter into the treestore corresponding to the geometry dimension, and
@@ -1567,8 +1628,8 @@
     """
 
     while iter is not None:
-      choice_or_tree = self.treestore.get_value(iter, 2)
-      active_tree = self.treestore.get_value(iter, 3)
+      choice_or_tree = self.treestore.get_value(iter, 0)
+      active_tree = self.treestore.get_value(iter, 1)
       if not choice_or_tree.active or not active_tree.active:
         return False
       iter = self.treestore.iter_parent(iter)
@@ -1629,7 +1690,7 @@
       iter = self.treestore.get_iter_first()
     if iter is None:
       yield None
-    choice_or_tree = self.treestore.get_value(iter, 2)
+    choice_or_tree = self.treestore.get_value(iter, 0)
 
     if self.choice_or_tree_matches(text, choice_or_tree, isinstance(choice_or_tree, choice.Choice)):
       yield iter

=== modified file 'diamond/diamond/tree.py'
--- diamond/diamond/tree.py	2011-07-25 13:41:47 +0000
+++ diamond/diamond/tree.py	2011-07-26 16:19:41 +0000
@@ -301,7 +301,7 @@
   def unpickle(self, pick):
     return pickle.loads(bz2.decompress(base64.b64decode(pick)))
 
-  def __str__(self):
+  def print_str(self):
     s = "name: %s at %s\n" % (self.name, hex(id(self)))
     s = s + "schemaname: %s\n" % self.schemaname
     s = s + "attrs: %s\n" % self.attrs
@@ -538,6 +538,9 @@
       return True
     
     return (self.datatype is not None and self.datatype != "fixed") or self.attrs
+
+  def __str__(self):
+    return self.get_display_name()
    
 gobject.type_register(Tree)
 

=== modified file 'diamond/gui/gui.glade'
--- diamond/gui/gui.glade	2011-07-22 15:46:25 +0000
+++ diamond/gui/gui.glade	2011-07-26 16:19:41 +0000
@@ -132,6 +132,20 @@
                         <accelerator key="V" signal="activate" modifiers="GDK_CONTROL_MASK"/>
                       </widget>
                     </child>
+                    <child>
+                      <widget class="GtkMenuItem" id="menuitemGroup">
+                        <property name="visible">True</property>
+                        <property name="label" translatable="yes">Group</property>
+                        <signal name="activate" handler="on_group"/>
+                      </widget>
+                    </child>
+                    <child>
+                      <widget class="GtkMenuItem" id="menuitemUngroup">
+                        <property name="visible">False</property>
+                        <property name="label" translatable="yes">Ungroup</property>
+                        <signal name="activate" handler="on_ungroup"/>
+                      </widget>
+                    </child>
                   </widget>
                 </child>
               </widget>
@@ -488,7 +502,7 @@
   <widget class="GtkMenu" id="popupmenu">
     <property name="visible">True</property>
     <child>
-      <widget class="GtkMenuItem" id="menuitemCopy">
+      <widget class="GtkMenuItem" id="popupmenuitemCopy">
         <property name="visible">True</property>
         <property name="label" translatable="yes">Copy</property>
         <property name="use_underline">True</property>
@@ -496,7 +510,7 @@
       </widget>
     </child>
     <child>
-      <widget class="GtkMenuItem" id="menuitemPaste">
+      <widget class="GtkMenuItem" id="popupmenuitemPaste">
         <property name="visible">True</property>
         <property name="label" translatable="yes">Paste</property>
         <property name="use_underline">True</property>
@@ -504,12 +518,26 @@
       </widget>
     </child>
     <child>
-      <widget class="GtkMenuItem" id="menuitemSlice">
+      <widget class="GtkMenuItem" id="popupmenuitemSlice">
         <property name="visible">True</property>
         <property name="label" translatable="yes">Slice</property>
         <property name="use_underline">True</property>
         <signal name="activate" handler="on_slice"/>
       </widget>
     </child>
+    <child>
+      <widget class="GtkMenuItem" id="popupmenuitemGroup">
+        <property name="visible">True</property>
+        <property name="label" translatable="yes">Group</property>
+        <signal name="activate" handler="on_group"/>
+      </widget>
+    </child>
+    <child>
+      <widget class="GtkMenuItem" id="popupmenuitemUngroup">
+        <property name="visible">False</property>
+        <property name="label" translatable="yes">Ungroup</property>
+        <signal name="activate" handler="on_ungroup"/>
+      </widget>
+    </child>
   </widget>
 </glade-interface>