2586: Add spouses to the Descendant Tree report

svn: r11671

src/plugins/drawreport/DescendTree.py

@@ -3,6 +3,7 @@
 #
 # Copyright (C) 2000-2007  Donald N. Allingham
 # Copyright (C) 2007-2008  Brian G. Matherly
+# Copyright (C) 2009  Craig J. Anderson
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -50,12 +51,16 @@ cm2pt = ReportUtils.cm2pt
 #
 #------------------------------------------------------------------------
 _BORN = _('short for born|b.')
+_MARR = _('short for married|m.')
 _DIED = _('short for died|d.')
 
 _LINE_HORIZONTAL = 1
 _LINE_VERTICAL   = 2
 _LINE_ANGLE      = 3
 
+_PERSON_DIRECT = 1
+_PERSON_SPOUSE = 2
+
 #------------------------------------------------------------------------
 #
 # Layout class
@@ -68,6 +73,7 @@ class GenChart:
         self.map = {}
         
         self.array = {}
+        self.sparray = {}
         self.max_x = 0
         self.max_y = 0
         
@@ -84,6 +90,18 @@ class GenChart:
             self.array[y] = {}
         self.array[y][x] = value
 
+    def get_sp(self, col_x, row_y):
+        """gets whether person at x,y
+        is a direct descendent or a spouse"""
+        if (col_x, row_y) not in self.sparray:
+            return None
+        return self.sparray[col_x, row_y]
+
+    def set_sp(self, col_x, row_y, value):
+        """sets whether person at x,y
+        is a direct descendent or a spouse"""
+        self.sparray[col_x, row_y] = value
+
     def dimensions(self):
         return (self.max_y+1, self.max_x+1)
 
@@ -127,6 +145,8 @@ class DescendTree(Report):
         pid = menu.get_option_by_name('pid').get_value()
         center_person = database.get_person_from_gramps_id(pid)
         
+        self.showspouse = menu.get_option_by_name('shows').get_value()
+        
         name = name_displayer.display_formal(center_person)
         self.title = _("Descendant Chart for %s") % name
 
@@ -148,19 +168,13 @@ class DescendTree(Report):
         if self.force_fit:
             self.scale_styles()
 
-    def apply_filter(self,person_handle,x,y):
+    def add_person(self, person_handle, col_x, row_y, spouse_level):
-        """traverse the ancestors recursively until either the end
+        """Add a new person into the x,y position
-        of a line is found, or until we reach the maximum number of 
+        also sets wether the person is:
-        generations that we want to deal with"""
+        - a direct descendent or a spouse
-
+        - the max length of the text/box, and number of lines"""
-        if x/2 >= self.max_generations:
+        self.genchart.set_xy(col_x, row_y, person_handle)
-            return 0
+        self.genchart.set_sp(col_x, row_y, spouse_level)
-
-        self.genchart.set_xy(x,y,person_handle)
-        
-        person = self.database.get_person_from_handle(person_handle)
-
-        index = 0
         
         style_sheet = self.doc.get_style_sheet()
         pstyle = style_sheet.get_paragraph_style("DC2-Normal")
@@ -169,27 +183,46 @@ class DescendTree(Report):
         em = self.doc.string_width(font,"m")
 
         subst = SubstKeywords(self.database, person_handle)
-        self.text[(x,y)] = subst.replace_and_clean(self.display)
+        self.text[(col_x, row_y)] = subst.replace_and_clean(self.display)
-        for line in self.text[(x,y)]:
+        for line in self.text[(col_x, row_y)]:
             this_box_width = self.doc.string_width(font, line) + 2*em
             self.box_width = max(self.box_width, this_box_width)
 
-        self.lines = max(self.lines,len(self.text[(x,y)]))    
+        self.lines = max(self.lines, len(self.text[(col_x, row_y)]))    
 
-        new_y = y
+    def apply_filter(self, person_handle, col_x, row_y):
+        """traverse the ancestors recursively until either the end
+        of a line is found, or until we reach the maximum number of 
+        generations that we want to deal with"""
+
+        if col_x/2 >= self.max_generations:
+            return 0
+
+        person = self.database.get_person_from_handle(person_handle)
+        self.add_person(person_handle, col_x, row_y, _PERSON_DIRECT)
+
+        working_col = 1
+        next_col = 0
         for family_handle in person.get_family_handle_list():
             
             family = self.database.get_family_from_handle(family_handle)
 
-            for child_ref in family.get_child_ref_list():
+            if self.showspouse:
-                sub = self.apply_filter(child_ref.ref, x+2, new_y)
+                spouse_handle = ReportUtils.find_spouse(person, family)
-                index += sub
+                self.add_person(spouse_handle, col_x, row_y+working_col,
-                new_y += sub
+                                _PERSON_SPOUSE)
+                working_col += 1
+
+            for child_ref in family.get_child_ref_list():
+                next_col += self.apply_filter(child_ref.ref, col_x+2, 
+                                              row_y+next_col)
+
+            working_col = next_col = max(working_col, next_col)
+
+        return working_col
 
-        return max(1,index)
 
     def add_lines(self):
-
         (maxy, maxx) = self.genchart.dimensions()
 
         for y in range(0, maxy+1):
@@ -198,30 +231,32 @@ class DescendTree(Report):
                 if x%2:
                     continue
 
-                # if we have a person directly next to a person, that
+                # if we have a direct child to the right of a person
-                # person must be a child of the first person
+                # check to see if the child is a descendant of the person
-                
+                if self.genchart.get_sp(x+2, y) == _PERSON_DIRECT:
-                if self.genchart.get_xy(x,y) and self.genchart.get_xy(x+2,y):
+                    if self.genchart.get_sp(x, y) == _PERSON_DIRECT:
                         self.genchart.set_xy(x+1, y , _LINE_HORIZONTAL)
+                        continue
+                    elif self.genchart.get_sp(x, y) == _PERSON_SPOUSE and \
+                    self.genchart.get_sp(x, y-1) != _PERSON_DIRECT:
+                        self.genchart.set_xy(x+1, y , _LINE_HORIZONTAL)
+                        continue
                 else:
                     continue
 
-                # look through the entries below this one. All people in the
+                self.genchart.set_xy(x+1, y, _LINE_ANGLE)
-                # next column are descendants until we hit a person in our own
-                # column.
 
-                last = y
+                # look through the entries ABOVE this one. All direct people
-                for newy in range(y+1,maxy+1):
+                # in the next column are descendants until we hit the first
-                    if self.genchart.get_xy(x, newy):
+                #  direct person (marked with _LINE_HORIZONTAL)
+                last = y-1
+                while last > 0:
+                    if self.genchart.get_xy(x+1, last) == 0:
+                        self.genchart.set_xy(x+1, last, _LINE_VERTICAL)
+                    else:
                         break
+                    last -= 1
 
-                    # if the next position is occupied, we need an
-                    # angle, otherwise, we may need a vertical line.
-                    if self.genchart.get_xy(x+2, newy):
-                        self.genchart.set_xy(x+1, newy,_LINE_ANGLE)
-                        for tempy in range(last+1, newy):
-                            self.genchart.set_xy(x+1,tempy,_LINE_VERTICAL)
-                        last = newy
 
     def write_report(self):
 
@@ -308,7 +343,8 @@ class DescendTree(Report):
         self.delta = pt2cm(self.box_pad_pts) + self.box_width + self.box_gap
         if not self.force_fit:
             calc_width = self.box_width + pt2cm(self.box_pad_pts)
-            remain = self.doc.get_usable_width() - ((self.generations_per_page)*calc_width)
+            remain = self.doc.get_usable_width() - \
+                     ((self.generations_per_page)*calc_width)
             self.delta += remain/float(self.generations_per_page)
 
     def scale_styles(self):
@@ -331,7 +367,6 @@ class DescendTree(Report):
         self.doc.set_style_sheet(style_sheet)
 
     def print_page(self, startx, stopx, starty, stopy, colx, coly):
-
         if not self.incblank:
             blank = True
             for y in range(starty, stopy):
@@ -344,7 +379,8 @@ class DescendTree(Report):
 
         self.doc.start_page()
         if self.title and self.force_fit:
-            self.doc.center_text('DC2-title',self.title,self.doc.get_usable_width()/2,0)
+            self.doc.center_text('DC2-title', self.title,
+                                 self.doc.get_usable_width()/2,0)
         phys_y = 1
         bh = self.box_height * 1.25
         for y in range(starty, stopy):
@@ -366,7 +402,8 @@ class DescendTree(Report):
                     ystart = (phys_y*bh + self.box_height/2.0) + self.offset
                     xstart = xbegin + self.box_width
                     xstop  = (phys_x+1)*self.delta
-                    self.doc.draw_line('DC2-line', xstart, ystart, xstop, ystart)
+                    self.doc.draw_line('DC2-line', xstart, ystart, xstop, 
+                                       ystart)
                 elif value == _LINE_VERTICAL:
                     ystart = ((phys_y-1)*bh + self.box_height/2.0) + self.offset
                     ystop  = (phys_y*bh + self.box_height/2.0) + self.offset
@@ -432,9 +469,9 @@ class DescendTreeOptions(MenuReportOptions):
         blank.set_help(_("Whether to include pages that are blank."))
         menu.add_option(category_name, "incblank", blank)
         
-        compress = BooleanOption(_('Co_mpress tree'),True)
+        shows = BooleanOption(_('Show Sp_ouses'), True)
-        compress.set_help(_("Whether to compress tree."))
+        shows.set_help(_("Whether to show spouses in the tree."))
-        menu.add_option(category_name, "compress", compress)
+        menu.add_option(category_name, "shows", shows)
 
     def make_default_style(self,default_style):
         """Make the default output style for the Ancestor Tree."""