--- loncom/xml/lontable.pm	2008/12/09 11:50:08	1.5
+++ loncom/xml/lontable.pm	2008/12/29 11:57:37	1.7
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 #  Generating TeX tables.
 #
-# $Id: lontable.pm,v 1.5 2008/12/09 11:50:08 foxr Exp $
+# $Id: lontable.pm,v 1.7 2008/12/29 11:57:37 foxr Exp $
 # 
 #
 # Copyright Michigan State University Board of Trustees
@@ -108,6 +108,7 @@ modified by this.  These configuration i
 
 =over3
 
+
 =item alignment
 
 Table alignment.  Some table styles support this but not all.
@@ -132,6 +133,12 @@ to the LaTeX::Table package, and they wi
 not error checked.  Any use of a non-existent theme is reported by the LaTeX::Table package
 when the table text is generated.
 
+=item width
+
+The width of the table.  This can be expressed as fractions of full width, or in any
+TeX unit measure e.g. 0.75 for 75% of the width, or 10.8cm  This forces the table to the
+tabularx environment.
+
 =back
 
 =head3 Member data
@@ -164,6 +171,11 @@ Table caption (configurable).
 
 Theme desired (configurable).
 
+=item width
+
+If defined, the width of the table (should be supplied
+in fraction of column width e.g. .75 for 75%.
+
 =item row_open 
 
 True if a row is open and not yet closed.
@@ -189,6 +201,11 @@ Default horizontal alignment for cells i
 
 Default vertical alignment for cells in this row (may be ignored).
 
+=item cell_width
+ 
+The width of the row in cells.  This is the sum of the column spans 
+of the cells in the row.
+
 =item cells
 
 Array of hashes where each element represents the data for a cell.
@@ -218,6 +235,10 @@ If present, indicates the number of rows
 If present indicates the number of columns this cell spans.
 Note that a cell can span both rows and columns.
 
+=item start_col
+
+The starting column of the cell in the table grid.
+
 =item contents
 
 The contents of the cell.
@@ -385,6 +406,26 @@ sub theme {
 
 =pod
 
+=head 2 width
+
+Gets and optionally sets the width of the table.
+
+=head 3 Examples:
+
+ $table->width("0.8");    # 80% of the column width.
+ my $newwidth = $table->width("10cm");   # 10cm width returns "10cm".
+
+=cut
+sub width {
+    my ($self, $new_value) = @_;
+    if (defined($new_value)) {
+	$self->{'width'} = $new_value;
+    }
+    return $self->{'width'}; 	# Could be undef.
+}
+
+=pod
+
 =head2 start_row
 
 Begins a new row in the table.  If a row is already open, that row is
@@ -420,6 +461,7 @@ sub start_row {
     my $row_hash = {
 	default_halign => "left",
 	default_valign => "top",
+	cell_width     =>  0,
 	cells          => []
     };
 
@@ -459,19 +501,11 @@ sub end_row {
 	# Mostly we need to determine if this row has the maximum
 	# cell count of any row in existence in the table:
 
-	my $row        = $self->{'rows'}[-1];
+	my $row        = $self->{'rows'}->[-1];
 	my $cells      = $row->{'cells'};
-	my $raw_cell_count = scalar(@$cells);
 
-	# Need to iterate through the columns as 
-	# colspans affect the count:
-	#
-	my $cell_count = 0;
-	for (my $i =0; $i < $raw_cell_count; $i++) {
-	    $cell_count = $cell_count + $cells->[$i]->{'colspan'};
-	}
-	if ($cell_count > $self->{'column_count'}) {
-	    $self->{'column_count'} = $cell_count;
+	if ($row->{'cell_width'} > $self->{'column_count'}) {
+	    $self->{'column_count'} = $row->{'cell_width'};
 	}
 
 	$self->{'row_open'} = 0;;
@@ -572,44 +606,55 @@ sub add_cell {
     if (!$self->{'row_open'}) {
 	$self->start_row();
     }
-
-    my $current_row   = $self->{'rows'}->[-1];
+    my $rows          = $self->{'rows'};
+    my $current_row   = $rows->[-1];
     my $current_cells = $current_row->{'cells'}; 
+    my $last_coord    = $current_row->{'cell_width'};
 
-    # The way we handle row spans is to insert additional
-    # blank cells as needed to reach this column.  Each
-    # cell that is inserted is empty, but has a row span decreased by one
-    # from the row above.  Column spans are propagated down from the row above
-    # and handled when the table's LaTeX is generated.
-    # There must be at least two rows in the row table to need to do this:
+    #  We have to worry about row spans if there is a prior row:
 
-    my $rows = $self->{'rows'};
-    my $row_count = scalar(@$rows);
-    if ($row_count > 1) {
-	my $prior_row      = $rows->[-2];
-	my $cells          = $current_row->{'cells'};
-	my $prior_cells    = $prior_row->{'cells'};
-	my $curr_colcount  = scalar(@$cells);
-	
-	my $prior_colcount = scalar(@$prior_cells);
+    if (scalar(@$rows) > 1) {
 
-	while (($curr_colcount < $prior_colcount) &&
-	       $prior_cells->[$curr_colcount]->{'rowspan'} > 1) {
-	    my %cell;
-	    my $prior_cell = $prior_cells->[$curr_colcount];
-	    %cell = %$prior_cell;
-	    $cell{'rowspan'}--;
-	    $cell{'contents'} = "";
-	    push(@$current_cells, \%cell);
-	    $curr_colcount += $prior_cells->[$curr_colcount]->{'colspan'}; # could be a colspan too.
+	my $last_row = $rows->[-2];
+	if ($last_coord < $last_row->{'cell_width'}) {
+	    my $prior_coord       = 0;
+	    my $prior_cell_index  = 0;
+	    while ($prior_coord <= $last_coord) {
+		
+		# Pull a cell down if it's coord matches our start coord
+		# And there's a row span > 1.
+		# Having done so, we adjust our $last_coord to match the
+		# end point of the pulled down cell.
+
+		my $prior_cell = $last_row->{'cells'}->[$prior_cell_index];
+		if (($prior_cell->{'start_col'} == $last_coord) &&
+		    ($prior_cell->{'rowspan'}  > 1)) {
+		    
+		    #  Need to drop the cell down
+
+		    my %dropped_down_cell = %$prior_cell;
+		    $dropped_down_cell{'rowspan'}--;
+		    $dropped_down_cell{'contents'} = '';
+
+		    push(@$current_cells, \%dropped_down_cell);
+		    $last_coord += $dropped_down_cell{'colspan'};
+		    $current_row->{'cell_width'} = $last_coord;
+		    
+		}
+		$prior_coord += $prior_cell->{'colspan'};
+		$prior_cell_index++;
+	    }
 	}
+
     }
+
     #
     # Now we're ready to build up our cell:
 
     my $cell = {
 	rowspan    => 1,
 	colspan    => 1,
+	start_col  => $last_coord,
 	contents   => $text
     };
     
@@ -618,9 +663,133 @@ sub add_cell {
 	    $cell->{$key} = $config->{$key};
 	}
     }
+    $current_row->{'cell_width'} += $cell->{'colspan'};
+
     push(@$current_cells, $cell);
 }
 
+=pod
+
+=head2 generate
+
+Call this when the structures for the table have been built.
+This will generate and return the table object that can be used
+to generate the table.  Returning the table object allows for
+a certain amount of testing to be done on the generated table.
+The caller can then ask the table object to generate LaTeX.
+
+=cut
+sub generate {
+    my ($this) = @_;
+
+    my $table = LaTeX::Table->new();
+
+    # Add the caption if supplied.
+
+    if ($this->{'caption'} ne "") {
+	$table->set_caption($this->caption);
+    }
+
+    
+    # Set the width if defined:
+
+    if (defined ($this->{'width'})) {
+	$table->set_width($this->{'width'});
+	$table->set_width_environment('tabularx');
+    }
+
+    # Build up the data:
+
+    my @data;
+    my $rows      = $this->{'rows'};
+    my $row_count = scalar(@$rows);
+    my $inner_border = $this->{'inner_border'};
+    my $outer_border = $this->{'outer_border'};
+    my $column_count = $this->{'column_count'};
+
+    for (my $row = 0; $row < $row_count; $row++) {
+	my @row;
+	my $cells      = $rows->[$row]->{'cells'};
+	my $def_halign = $rows->[$row]->{'default_halign'};
+	my $cell_count = scalar(@$cells);
+	my $startcol   = 1;
+	my @underlines;		# Array of \cline cells if cellborder on.
+
+	for (my $cell  = 0; $cell < $cell_count; $cell++) {
+	    my $contents = $cells->[$cell]->{'contents'};
+
+	    #
+	    #  Cell alignment is the default alignment unless
+	    #  explicitly specified in the cell.
+	    #  NOTE: at this point I don't know how to do vert alignment.
+	    #
+
+	    my $halign   = $def_halign;
+	    if (defined ($cells->[$cell]->{'halign'})) {
+		$halign = $cells->[$cell]->{'halign'};
+	    }
+
+	    # Create the horizontal alignment character:
+
+	    my $col_align = 'l';
+	    if ($halign eq 'right') {
+		$col_align = 'r';
+	    }
+	    if ($halign eq 'center') {
+		$col_align = 'c';
+	    }
+	    if ($inner_border || ($outer_border && ($cell == 0))) {
+		$col_align = '|'.$col_align;
+	    }
+	    if ($inner_border || ($outer_border && ($cell == ($cell_count -1)))) {
+		$col_align = $col_align.'|';
+	    }
+
+	    #factor in spans:
+
+	    my $cspan    = $cells->[$cell]->{'colspan'};
+	    my $nextcol  = $startcol + $cspan;
+	    $contents = '\multicolumn{'.$cspan.'}{'.$col_align.'}{'.$contents.'}';
+	    if ($inner_border && ($cells->[$cell]->{'rowspan'} == 1)) {
+		my $lastcol = $nextcol -1;
+		push(@underlines, "\\cline{$startcol-$lastcol}");
+	    }
+	    $startcol = $nextcol;
+	    # Rowspans should take care of themselves.
+	    
+
+	    push(@row, $contents);
+
+	}
+	push(@data, \@row);
+	if ($inner_border) {
+	    for (my $i =0; $i < scalar(@underlines); $i++) {
+		push(@data, [$underlines[$i]]);
+	    }
+	}
+
+    }
+    $table->set_data(\@data);
+    
+    my $coldef = "";
+    if ($outer_border || $inner_border) {
+	$coldef .= '|';
+    }
+    for (my $i =0; $i < $column_count; $i++) {
+	$coldef .= 'l';
+	if ($inner_border || 
+	    ($outer_border && ($i == $column_count-1))) {
+	    $coldef .= '|';
+	}
+    }
+    $table->{'coldef'} = $coldef;
+
+    # Return the table:
+
+    return $table;
+
+}
+#----------------------------------------------------------------------------
 # The following methods allow for testability.