* src/DisplayModels/_BaseModel.py: Refactor out node/path maps

* various: remove sets import


svn: r8011

gramps2/ChangeLog

@@ -1,4 +1,6 @@
 2007-01-29  Don Allingham  <don@gramps-project.org>
+	* src/DisplayModels/_BaseModel.py: Refactor out node/path maps
+	* various: remove sets import
 	* NEWS: update
 	* configure.in: update to 2.2.6
 	* src/ReportBase/_ReportOptions.py: fix landscape saving.

gramps2/src/DataViews/_PersonView.py

@@ -36,11 +36,6 @@ __revision__ = "$Revision$"
 from gettext import gettext as _
 import cPickle as pickle
 
-try:
-    set()
-except NameError:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # gtk

gramps2/src/DataViews/_RelationView.py

@@ -34,11 +34,6 @@ __revision__ = "$Revision$"
 from gettext import gettext as _
 import cgi
 
-try:
-    set()
-except NameError:
-    from sets import Set as set
-    
 #-------------------------------------------------------------------------
 #
 # GTK/Gnome modules

gramps2/src/DisplayModels/_BaseModel.py

@@ -25,10 +25,6 @@
 #
 #-------------------------------------------------------------------------
 import locale
-try:
-    set()
-except:
-    from sets import Set as set
     
 #-------------------------------------------------------------------------
 #
@@ -44,6 +40,94 @@ import gtk
 #-------------------------------------------------------------------------
 from Filters import SearchFilter
 
+#-------------------------------------------------------------------------
+#
+# NodeMap
+#
+#-------------------------------------------------------------------------
+class NodeMap:
+    """
+    Provides the Path to Iter mappings for a TreeView model. The implementation
+    provides a list of nodes and a dictionary of handles. The datalist provides
+    the path (index) to iter (handle) mapping, while the the indexmap provides
+    the handle to index mappings
+    """
+
+    def __init__(self):
+        """
+        Create a new instance, clearing the datalist and indexmap
+        """
+        self.data_list = []
+        self.index_map = {}
+
+    def set_path_map(self, dlist):
+        """
+        Takes a list of handles and builds the index map from it.
+        """
+        self.data_list = dlist
+        i = 0
+        self.index_map = {}
+        for key in self.data_list:
+            self.index_map[key] = i
+            i +=1
+
+    def clear_map(self):
+        """
+        Clears out the data_list and the index_map
+        """
+        self.data_list = []
+        self.index_map = {}
+
+    def get_path(self, handle):
+        """
+        Returns the path from the passed handle. This is accomplished by
+        indexing into the index_map to get the index (path)
+        """
+        return self.index_map.get(handle)
+
+    def get_handle(self, path):
+        """
+        Returns the handle from the path. The path is assumed to be an integer.
+        This is accomplished by indexing into the data_list
+        """
+        return self.data_list[path]
+
+    def delete_by_index(self, index):
+        """
+        Deletes the item at the specified path, then rebuilds the index_map,
+        subtracting one from each item greater than the deleted index.
+        """
+        handle = self.data_list[index]
+        del self.data_list[index]
+        del self.index_map[handle]
+
+        for key in self.index_map:
+            if self.index_map[key] > index:
+                self.index_map[key] -= 1
+
+    def find_next_handle(self, handle):
+        """
+        Finds the next handle based off the passed handle. This is accomplished
+        by finding the index of associated with the handle, adding one to find
+        the next index, then finding the handle associated with the next index.
+        """
+        try:
+            return self.data_list[self.index_map.get(handle)+1]
+        except IndexError:
+            return None
+        
+    def __len__(self):
+        """
+        Returns the number of entries in the map.
+        """
+        return len(self.data_list)
+
+    def get_first_handle(self):
+        """
+        Returns the first handle in the map.
+        """
+        return self.data_list[0]
+
 #-------------------------------------------------------------------------
 #
 # BaseModel
@@ -68,6 +152,8 @@ class BaseModel(gtk.GenericTreeModel):
         self.sort_col = scol
         self.skip = skip
 
+        self.node_map = NodeMap()
+
         if search:
             if search[0]:
                 self.search = search[1]
@@ -95,98 +181,76 @@ class BaseModel(gtk.GenericTreeModel):
 
     def sort_keys(self):
         cursor = self.gen_cursor()
-        self.sarray = []
+        self.sort_data = []
         data = cursor.next()
 
         while data:
             key = locale.strxfrm(self.sort_func(data[1]))
-            self.sarray.append((key,data[0]))
+            self.sort_data.append((key,data[0]))
             data = cursor.next()
         cursor.close()
 
-        self.sarray.sort(reverse=self.reverse)
+        self.sort_data.sort(reverse=self.reverse)
 
-        return [ x[1] for x in self.sarray ]
+        return [ x[1] for x in self.sort_data ]
 
     def _rebuild_search(self,ignore=None):
         if self.db.is_open():
             if self.search and self.search.text:
-                self.datalist = [h for h in self.sort_keys()\
+                dlist = [h for h in self.sort_keys()\
                              if self.search.match(h) and \
                              h not in self.skip and h != ignore]
             else:
-                self.datalist = [h for h in self.sort_keys() \
+                dlist = [h for h in self.sort_keys() \
                              if h not in self.skip and h != ignore]
-            i = 0
-            self.indexlist = {}
-            for key in self.datalist:
-		self.indexlist[key] = i
-		i += 1
+            self.node_map.set_path_map(dlist)
         else:
-            self.datalist = []
-            self.indexlist = {}
+            self.node_map.clear_map()
 
     def _rebuild_filter(self, ignore=None):
         if self.db.is_open():
             if self.search:
-                self.datalist = self.search.apply(self.db, 
+                dlist = self.search.apply(self.db, 
                 [ k for k in self.sort_keys()\
                       if k != ignore])
             else:
-                self.datalist = [ k for k in self.sort_keys() \
+                dlist = [ k for k in self.sort_keys() \
                               if k != ignore ]
 
-            i = 0
-            self.indexlist = {}
-            for key in self.datalist:
-                if key not in self.skip:
-                    self.indexlist[key] = i
-                    i += 1
+            self.node_map.set_path_map(dlist)
         else:
-            self.datalist = []
-            self.indexlist = {}
+            self.node_map.clear_map()
         
     def add_row_by_handle(self,handle):
 	if self.search and self.search.match(handle):
 
 	    data = self.map(handle)
             key = locale.strxfrm(self.sort_func(data))
-            self.sarray.append((key,handle))
-	    self.sarray.sort(reverse=self.reverse)
-	    self.datalist = [ x[1] for x in self.sarray ]
+            self.sort_data.append((key,handle))
+	    self.sort_data.sort(reverse=self.reverse)
+	    self.node_map.set_path_map([ x[1] for x in self.sort_data ])
 
-            i = 0
-            self.indexlist = {}
-            for key in self.datalist:
-		self.indexlist[key] = i
-		i += 1
-
-	    index = self.indexlist.get(handle)
+	    index = self.node_map.get_path(handle)
 	    if index != None:
 		node = self.get_iter(index)
 		self.row_inserted(index, node)
 
     def delete_row_by_handle(self,handle):
-        index = self.indexlist[handle]
+        index = self.node_map.get_path(handle)
 
         # remove from sort array
         i = 0
-        for (key, node) in self.sarray:
+        for (key, node) in self.sort_data:
             if handle == node:
-                del self.sarray[i]
+                del self.sort_data[i]
                 break
             i += 1
 
-	del self.datalist[index]
-	del self.indexlist[handle]
-
-	for key in self.indexlist:
-	    if self.indexlist[key] > index:
-		self.indexlist[key] -= 1
+        self.node_map.delete_by_index(index)
         self.row_deleted(index)
 
     def update_row_by_handle(self,handle):
-        index = self.indexlist[handle]
+        index = self.node_map.get_path(handle)
         node = self.get_iter(index)
         self.row_changed(index,node)
 
@@ -200,7 +264,7 @@ class BaseModel(gtk.GenericTreeModel):
     def on_get_path(self, node):
 	'''returns the tree path (a tuple of indices at the various
 	levels) for a particular node.'''
-        return self.indexlist[node]
+        return self.node_map.get_path(node)
 
     def on_get_column_type(self,index):
         if index == self.tooltip_column:
@@ -209,8 +273,8 @@ class BaseModel(gtk.GenericTreeModel):
 
     def on_get_iter(self, path):
         try:
-            return self.datalist[path[0]]
-        except IndexError:
+            return self.node_map.get_handle(path[0])
+        except:
             return None
 
     def on_get_value(self,node,col):
@@ -224,31 +288,28 @@ class BaseModel(gtk.GenericTreeModel):
 
     def on_iter_next(self, node):
 	'''returns the next node at this level of the tree'''
-        try:
-            return self.datalist[self.indexlist[node]+1]
-        except IndexError:
-            return None
+        return self.node_map.find_next_handle(node)
 
     def on_iter_children(self,node):
         """Return the first child of the node"""
-        if node == None and self.datalist:
-            return self.datalist[0]
+        if node == None and len(self.node_map):
+            return self.node_map.get_first_handle()
         return None
 
     def on_iter_has_child(self, node):
 	'''returns true if this node has children'''
         if node == None:
-            return len(self.datalist) > 0
+            return len(self.node_map) > 0
         return False
 
     def on_iter_n_children(self,node):
         if node == None:
-            return len(self.datalist)
+            return len(self.node_map)
         return 0
 
     def on_iter_nth_child(self,node,n):
         if node == None:
-            return self.datalist[n]
+            return self.node_map.get_handle(n)
         return None
 
     def on_iter_parent(self, node):

gramps2/src/DisplayModels/_EventModel.py

@@ -28,11 +28,6 @@ import time
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/DisplayModels/_FamilyModel.py

@@ -28,11 +28,6 @@ import time
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/DisplayModels/_MediaModel.py

@@ -29,11 +29,6 @@ from gettext import gettext as _
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/DisplayModels/_PlaceModel.py

@@ -28,11 +28,6 @@ import time
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/DisplayModels/_RepositoryModel.py

@@ -27,11 +27,6 @@
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/DisplayModels/_SourceModel.py

@@ -28,11 +28,6 @@ import time
 import logging
 log = logging.getLogger(".")
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK modules

gramps2/src/Editors/_EditFamily.py

@@ -28,17 +28,6 @@
 from gettext import gettext as _
 import cPickle as pickle
 
-#-------------------------------------------------------------------------
-#
-# 2.4 provides a built in set. We want to use this, but need to handle 
-# older versions of python as well
-#
-#-------------------------------------------------------------------------
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # enable logging for error handling

gramps2/src/Editors/_EditPerson.py

@@ -43,11 +43,6 @@ from gettext import gettext as _
 #-------------------------------------------------------------------------
 import gtk
 
-try:
-    set()
-except NameError:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # gramps modules

gramps2/src/GrampsDb/_GrampsBSDDB.py

@@ -39,13 +39,6 @@ from bsddb import dbshelve, db
 import logging
 log = logging.getLogger(".GrampsDb")
 
-# hack to use native set for python2.4
-# and module sets for earlier pythons
-try:
-    set()
-except NameError:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # Gramps modules

gramps2/src/GrampsDb/_GrampsDbBase.py

@@ -42,11 +42,6 @@ from sys import maxint
 from bsddb import db
 from gettext import gettext as _
 
-try:
-    set()
-except NameError:
-    from sets import Set as set
-
 import logging
 log = logging.getLogger(".GrampsDb")
 

gramps2/src/GrampsDb/_ReadGedcom.py

@@ -34,12 +34,6 @@ import time
 from bsddb import db
 from gettext import gettext as _
 
-# and module sets for earlier pythons
-try:
-    set()
-except NameError:
-    from sets import Set as set
-
 #------------------------------------------------------------------------
 #
 # Set up logging

gramps2/src/GrampsDb/_WriteGedcom.py

@@ -31,10 +31,6 @@ import os
 import time
 import re
 import shutil
-try:
-    set()
-except:
-    from sets import Set as set
 
 import logging
 log = logging.getLogger(".WriteGedcom")

gramps2/src/Selectors/_BaseSelector.py

@@ -20,16 +20,6 @@
 
 # $Id$
 
-#-------------------------------------------------------------------------
-#
-# Python modules
-#
-#-------------------------------------------------------------------------
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GTK/Gnome modules

gramps2/src/Utils.py

@@ -33,11 +33,6 @@ import time
 
 from gettext import gettext as _
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #-------------------------------------------------------------------------
 #
 # GNOME/GTK

gramps2/src/plugins/Check.py

@@ -30,10 +30,6 @@
 import os
 import sys
 import cStringIO
-try:
-    set()
-except:
-    from sets import Set as set
 
 from gettext import gettext as _
 

gramps2/src/plugins/CountAncestors.py

@@ -31,10 +31,6 @@
 import os
 from gettext import gettext as _
 from math import pow
-try:
-    set()
-except NameError:
-    from sets import Set as set
 
 #------------------------------------------------------------------------
 #

gramps2/src/plugins/NarrativeWeb.py

@@ -40,11 +40,6 @@ from gettext import gettext as _
 from cStringIO import StringIO
 from textwrap import TextWrapper
 
-try:
-    set()
-except:
-    from sets import Set as set
-
 #------------------------------------------------------------------------
 #
 # Set up logging

gramps2/src/plugins/RelCalc.py

@@ -29,10 +29,6 @@
 #-------------------------------------------------------------------------
 import os
 from gettext import gettext as _
-try:
-    set()
-except NameError:
-    from sets import Set as set
 
 #-------------------------------------------------------------------------
 #

gramps2/src/plugins/Verify.py

@@ -34,10 +34,6 @@ import os
 from gettext import gettext as _
 import cPickle
 import md5
-try:
-    set()
-except NameError:
-    from sets import Set as set
 import Errors
 
 #------------------------------------------------------------------------