--- loncom/xml/lontable.pm 2008/12/23 11:49:32 1.6 +++ loncom/xml/lontable.pm 2010/11/01 10:52:09 1.14 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Generating TeX tables. # -# $Id: lontable.pm,v 1.6 2008/12/23 11:49:32 foxr Exp $ +# $Id: lontable.pm,v 1.14 2010/11/01 10:52:09 foxr Exp $ # # # Copyright Michigan State University Board of Trustees @@ -38,7 +38,7 @@ # # This module is a support packkage that helps londefdef generate -# LaTeX tables using the LaTeX::Table package. A prerequisite is that +# LaTeX tables using the Apache::lonlatextable package. A prerequisite is that # the print generator must have added the following to the LaTeX # # \usepackage{xtab} @@ -55,15 +55,17 @@ package Apache::lontable; use strict; -use LaTeX::Table; +use Apache::lonlatextable; +use Apache::lonnet; # for trace logging. +my $tracing = 0; # Set to 1 to enable log tracing. 2 for local sub tracing. =pod =head1 lontable Table generation assistant for the LaTeX target This module contains support software for generating tables in LaTeX output mode -In this implementation, we use the LaTeX::Table package to do the actual final formatting. +In this implementation, we use the Apache::lonlatextable package to do the actual final formatting. Each table creates a new object. Table objects can have global properties configured. The main operations on a table object are: @@ -108,6 +110,7 @@ modified by this. These configuration i =over3 + =item alignment Table alignment. Some table styles support this but not all. @@ -128,10 +131,17 @@ The table caption text. The theme of the table to use. Defaults to Zurich. Themes we know about are: NYC, NYC2, Zurich, Berlin, Dresden, Houston, Miami, plain, Paris. Other themes can be added -to the LaTeX::Table package, and they will become supported automatically, as theme names are -not error checked. Any use of a non-existent theme is reported by the LaTeX::Table package +to the Apache::lonlatextable package, and they will become supported automatically, as theme names are +not error checked. Any use of a non-existent theme is reported by the Apache::lonlatextable package when the table text is generated. +=item width + +The width of the table. in any +TeX unit measure e.g. 10.8cm This forces the table to the +tabularx environment. It also forces the declarations for +cells to be paragraph mode which supports more internal formatting. + =back =head3 Member data @@ -245,6 +255,7 @@ The contents of the cell. sub new { my ($class, $configuration) = @_; + # Initialize the object member data with the default values # then override with any stuff in $configuration. @@ -253,10 +264,11 @@ sub new { outer_border => 0, inner_border => 0, caption => "", - theme => "Zurich", + theme => "plain", column_count => 0, row_open => 0, rows => [], + col_widths => {} }; foreach my $key (keys %$configuration) { @@ -291,6 +303,8 @@ Regardless, the current alignment is use sub alignment { my ($self, $new_value) = @_; + if ($tracing) {&Apache::lonnet::logthis("alignment = $new_value");} + if (defined($new_value)) { $self->{'alignment'} = $new_value; } @@ -316,6 +330,8 @@ the final value of the outer_border requ sub table_border { my ($self, $new_value) = @_; + if ($tracing) {&Apache::lonnet::logthis("table_border $new_value");} + if (defined($new_value)) { $self->{'outer_border'} = $new_value; } @@ -341,7 +357,7 @@ value of that configuration parameter is sub cell_border { my ($self, $new_value) = @_; - + if($tracing) {&Apache::lonnet::logthis("cell_border: $new_value"); } if (defined($new_value)) { $self->{'inner_border'} = $new_value; } @@ -366,6 +382,7 @@ the table. If a parameter is supplied i sub caption { my ($self, $new_value) = @_; + if($tracing) {&Apache::lonnet::logthis("caption: $new_value"); } if (defined($new_value)) { $self->{'caption'} = $new_value; } @@ -390,7 +407,7 @@ will be the new theme selection. sub theme { my ($self, $new_value) = @_; - + if($tracing) {&Apache::lonnet::logthis("theme $new_value"); } if (defined($new_value)) { $self->{'theme'} = $new_value; } @@ -399,6 +416,27 @@ sub theme { =pod +=head 2 width + +Gets and optionally sets the width of the table. + +=head 3 Examples: + + my $newwidth = $table->width("10cm"); # 10cm width returns "10cm". + +=cut +sub width { + my ($self, $new_value) = @_; + if($tracing) {&Apache::lonnet::logthis("width = $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 @@ -427,7 +465,7 @@ The default vertical alignment of the ro sub start_row { my ($self, $config) = @_; - + if($tracing) {&Apache::lonnet::logthis("start_row"); } if ($self->{'row_open'}) { $self->end_row(); } @@ -468,7 +506,7 @@ Closes off a row. Once closed, cells ca sub end_row { my ($self) = @_; - + if($tracing) {&Apache::lonnet::logthis("end_row"); } if ($self->{'row_open'}) { # Mostly we need to determine if this row has the maximum @@ -510,13 +548,14 @@ The default vertical alignment for text "top", "bottom" or "center" + =back =cut sub configure_row { my ($self, $config) = @_; - + if($tracing) {&Apache::lonnet::logthis("configure_row");} if (!$self->{'row_open'}) { $self->start_row(); } @@ -567,6 +606,13 @@ Number of rows the cell spans. Number of columns the cell spans. +=item width + +LaTeX specification of the width of the cell. +Note that if there is a colspan this width is going to be equally divided +over the widths of the columnsn in the span. +Note as well that if width specification conflict, the last one specified wins...silently. + =back =cut @@ -574,6 +620,8 @@ Number of columns the cell spans. sub add_cell { my ($self, $text, $config) = @_; + if($tracing) {&Apache::lonnet::logthis("add_cell : $text"); } + # If a row is not open, we must open it: if (!$self->{'row_open'}) { @@ -600,6 +648,9 @@ sub add_cell { # end point of the pulled down cell. my $prior_cell = $last_row->{'cells'}->[$prior_cell_index]; + if (!defined($prior_cell)) { + last; + } if (($prior_cell->{'start_col'} == $last_coord) && ($prior_cell->{'rowspan'} > 1)) { @@ -636,11 +687,65 @@ sub add_cell { $cell->{$key} = $config->{$key}; } } + $current_row->{'cell_width'} += $cell->{'colspan'}; + + # + # Process the width if it exists. If supplied it must be of the form: + # float units + # Where units can be in, cm or mm. + # Regardless of the supplied units we will normalize to cm. + # This allows computation on units at final table generation time. + # + + if (exists($cell->{'width'})) { + my $width; + my $widthcm; + $width = $config->{'width'}; + $widthcm = $self->size_to_cm($width); + + # If there's a column span, the actual width is divided by the span + # and applied to each of the columns in the span. + + $widthcm = $widthcm / $cell->{'colspan'}; + for (my $i = $last_coord; $i < $last_coord + $cell->{'colspan'}; $i++) { + $self->{'col_widths'}->{$i} = $widthcm; + } + + } + push(@$current_cells, $cell); + + if ($tracing) { &Apache::lonnet::logthis("add_cell done"); } +} + + +=pod + +=head2 append_cell_text + +Sometimes it's necessary to create/configure the cell and then later add text to it. +This sub allows text to be appended to the most recently created cell. + +=head3 Parameters + +The text to add to the cell. + +=cut +sub append_cell_text { + my ($this, $text) = @_; + + if($tracing) {&Apache::lonnet::logthis("append_cell_text: $text"); } + my $rows = $this->{'rows'}; + my $current_row = $rows->[-1]; + my $cells = $current_row->{'cells'}; + my $current_cell = $cells->[-1]; + $current_cell->{'contents'} .= $text; + } + =pod =head2 generate @@ -654,8 +759,80 @@ The caller can then ask the table object =cut sub generate { my ($this) = @_; + my $useP = 0; + + my $colunits = 'cm'; # All widths get normalized to cm. + my $tablewidth; + + if($tracing) {&Apache::lonnet::logthis("generate"); } + my $table = Apache::lonlatextable->new(); + + + # Add the caption if supplied. + + if ($this->{'caption'} ne "") { + $table->set_caption($this->caption); + } + + # Set the width if defined: + + my $default_width; + my $colwidths = $this->{'col_widths'}; + if (defined ($this->{'width'})) { + $tablewidth = $this->{'width'}; + $tablewidth = $this->size_to_cm($tablewidth); + + $useP = 1; + + # Figure out the default width for a column with unspecified + # We take the initially specified widths and sum them up. + # This is subtracted from total width above. + # If the result is negative we're going to allow a minimum of 2.54cm for + # each column and make the table spill appropriately. + # This (like a riot) is an ugly thing but I'm open to suggestions about + # how to handle it better (e.g. scaling down requested widths?). + + my $specified_width = 0.0; + my $specified_cols = 0; + foreach my $col (keys %$colwidths) { + $specified_width = $specified_width + $colwidths->{$col}; + $specified_cols++; + } + my $unspecified_cols = $this->{'column_count'} - $specified_cols; + + # If zero unspecified cols, we are pretty much done... just have to + # adjust the total width to be specified width. Otherwise we + # must figure out the default width and total width: + # + my $total_width; + if($unspecified_cols == 0) { + $total_width = $specified_width; + } else { + $default_width = ($tablewidth - $specified_width)/$unspecified_cols; # Could be negative.... + $total_width = $default_width * $unspecified_cols + $specified_width; + } + + # if the default_width is < 0.0 the user has oversubscribed the width of the table with the individual + # column. In this case, we're going to maintain the desired proportions of the user's columns, but + # ensure that the unspecified columns get a fair share of the width..where a fair share is defined as + # the total width of the table / unspecified column count. + # We figure out what this means in terms of reducing the specified widths by dividing by a constant proportionality. + # Note that this cannot happen if the user hasn't specified anywidths as the computation above would then + # just make all columns equal fractions of the total table width. + + if ($default_width < 0) { + $default_width = ($tablewidth/$unspecified_cols); # 'fair' default width. + my $width_remaining = $tablewidth - $default_width*$unspecified_cols; # What's left for the specified cols. + my $reduction = $tablewidth/$width_remaining; # Reduction fraction for specified cols + foreach my $col (keys %$colwidths) { + $colwidths->{$col} = $colwidths->{$col}/$reduction; + } + + } + } + + - my $table = LaTeX::Table->new(); # Build up the data: @@ -666,19 +843,94 @@ sub generate { my $outer_border = $this->{'outer_border'}; my $column_count = $this->{'column_count'}; + # Add a top line if the outer or inner border is enabled: + + if ($outer_border || $inner_border) { + push(@data, ["\\cline{1-$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'; + my $embeddedAlignStart = ""; + my $embeddedAlignEnd = ""; + + if ($halign eq 'right') { + $col_align = 'r'; + $embeddedAlignStart = '\raggedleft'; + } + if ($halign eq 'center') { + $col_align = 'c'; + $embeddedAlignStart = '\begin{center}'; + $embeddedAlignEnd = '\end{center}'; + } + + # If the width has been specified, turn these into + # para mode; and wrap the contents in the start/stop stuff: + + if ($useP) { + my $cw; + if (defined($colwidths->{$cell})) { + $cw = $colwidths->{$cell}; + } else { + $cw = $default_width; + } + my $cw = $cw * $cells->[$cell]->{'colspan'}; + $col_align = "p{$cw $colunits}"; + $contents = $embeddedAlignStart . $contents . $embeddedAlignEnd; + } + + 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; - if ($cspan > 1) { - $contents = '\multicolumn{'.$cspan.'}{|l|}{'.$contents.'}'; + + # If we can avoid the \multicolumn directive that's best as + # that makes some things like \parpic invalid in LaTeX which + # screws everything up. + + if (($cspan > 1) || !($col_align =~ /l/)) { + + $contents = '\multicolumn{'.$cspan.'}{'.$col_align.'}{'.$contents.'}'; + + # A nasty edge case. If there's only one cell, the software will assume + # we're in complete control of the row so we need to end the row ourselves. + + if ($cell_count == 1) { + $contents .= ' \\\\'; + } } if ($inner_border && ($cells->[$cell]->{'rowspan'} == 1)) { my $lastcol = $nextcol -1; @@ -687,7 +939,6 @@ sub generate { $startcol = $nextcol; # Rowspans should take care of themselves. - push(@row, $contents); } @@ -699,6 +950,14 @@ sub generate { } } + # + # Add bottom border if necessary: if the inner border was on, the loops above + # will have done a bottom line under the last cell. + # + if ($outer_border && !$inner_border) { + push(@data, ["\\cline{1-$column_count}"]); + + } $table->set_data(\@data); my $coldef = ""; @@ -706,7 +965,11 @@ sub generate { $coldef .= '|'; } for (my $i =0; $i < $column_count; $i++) { - $coldef .= 'l'; + if ($useP) { + $coldef .= "p{$default_width $colunits}"; + } else { + $coldef .= 'l'; + } if ($inner_border || ($outer_border && ($i == $column_count-1))) { $coldef .= '|'; @@ -716,26 +979,57 @@ sub generate { # Return the table: + if ($tracing) { &Apache::lonnet::logthis("Leaving generate"); } + + return $table; } +#--------------------------------------------------------------------------- +# +# Private methods: +# + +# +# Convert size with units -> size in cm. +# The resulting size is floating point with no units so that it can be used in +# computation. Note that an illegal or missing unit is treated silently as +# cm for now. +# +sub size_to_cm { + my ($this, $size_spec) = @_; + my ($size, $units) = split(/ /, $size_spec); + if (lc($units) eq 'mm') { + return $size / 10.0; + } + if (lc($units) eq 'in') { + return $size * 2.54; + } + + return $size; # Default is cm. +} #---------------------------------------------------------------------------- # The following methods allow for testability. sub get_object_attribute { my ($self, $attribute) = @_; + if ($tracing > 1) { &Apache::lonnet::logthis("get_object_attribute: $attribute"); } return $self->{$attribute}; } sub get_row { my ($self, $row) = @_; + if ($tracing > 1) { &Apache::lonnet::logthis("get_row"); } + my $rows = $self->{'rows'}; # ref to an array.... return $rows->[$row]; # ref to the row hash for the selected row. } + # Mandatory initialization. BEGIN{ } 1; __END__ +