Change license from GPLv2+ to GPLv3+.
[pspp-builds.git] / src / output / table.c
index a8624488e7775cc4aac93025ae0d05ddf0ae2ec8..36e9ca28ea55d116f1e03449dc105097fbefb045 100644 (file)
@@ -1,21 +1,18 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
 
-   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 the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
 
@@ -31,7 +28,7 @@
 
 #include <data/data-out.h>
 #include <data/format.h>
-#include <data/variable.h>
+#include <data/value.h>
 #include <libpspp/alloc.h>
 #include <libpspp/assertion.h>
 #include <libpspp/compiler.h>
@@ -49,7 +46,7 @@ static char *command_name;
 
 /* Returns the font to use for a cell with the given OPTIONS. */
 static enum outp_font
-options_to_font (unsigned options) 
+options_to_font (unsigned options)
 {
   return (options & TAB_FIX ? OUTP_FIXED
           : options & TAB_EMPH ? OUTP_EMPHASIS
@@ -126,7 +123,7 @@ void
 tab_realloc (struct tab_table *t, int nc, int nr)
 {
   int ro, co;
-  
+
   assert (t != NULL);
   ro = t->row_ofs;
   co = t->col_ofs;
@@ -137,14 +134,14 @@ tab_realloc (struct tab_table *t, int nc, int nr)
     nc = t->nc;
   if (nr == -1)
     nr = t->nr;
-  
+
   assert (nc == t->nc);
-  
+
   if (nc > t->cf)
     {
       int mr1 = MIN (nr, t->nr);
       int mc1 = MIN (nc, t->nc);
-      
+
       struct substring *new_cc;
       unsigned char *new_ct;
       int r;
@@ -170,7 +167,7 @@ tab_realloc (struct tab_table *t, int nc, int nr)
 
       t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
       t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
-      
+
       if (nr > t->nr)
        {
          memset (&t->rh[nc * (t->nr + 1)], TAL_0, (nr - t->nr) * nc);
@@ -180,7 +177,7 @@ tab_realloc (struct tab_table *t, int nc, int nr)
     }
 
   memset (&t->ct[nc * t->nr], TAB_EMPTY, nc * (nr - t->nr));
-  
+
   t->nr = nr;
   t->nc = nc;
 
@@ -275,7 +272,7 @@ tab_hline (struct tab_table * t, int style, int x1, int x2, int y)
   y += t->row_ofs;
 
   assert (y >= 0);
-  assert (y < t->nr);
+  assert (y <= t->nr);
   assert (x2 >= x1 );
   assert (x1 >= 0 );
   assert (x2 < t->nc);
@@ -301,9 +298,9 @@ tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
   assert (t != NULL);
 
 #if DEBUGGING
-  if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= t->nc 
+  if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= t->nc
       || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= t->nc
-      || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= t->nr 
+      || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= t->nr
       || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= t->nr)
     {
       printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
@@ -351,7 +348,7 @@ tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
   if (i_h != -1)
     {
       int y;
-      
+
       for (y = y1 + 1; y <= y2; y++)
        {
          int x;
@@ -363,11 +360,11 @@ tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
   if (i_v != -1)
     {
       int x;
-      
+
       for (x = x1 + 1; x <= x2; x++)
        {
          int y;
-         
+
           for (y = y1; y <= y2; y++)
             t->rv[x + (t->cf + 1) * y] = i_v;
        }
@@ -425,7 +422,7 @@ tab_natural_width (struct tab_table *t, struct outp_driver *d, int c)
        struct outp_text text;
        unsigned char opt = t->ct[c + r * t->cf];
         int w;
-               
+
        if (opt & (TAB_JOIN | TAB_EMPTY))
          continue;
 
@@ -445,12 +442,12 @@ tab_natural_width (struct tab_table *t, struct outp_driver *d, int c)
       /* FIXME: This is an ugly kluge to compensate for the fact
          that we don't let joined cells contribute to column
          widths. */
-      width = d->prop_em_width * 8; 
+      width = d->prop_em_width * 8;
     }
-  
+
   {
     const int clamp = d->width - t->wrv[0] - t->wrv[t->nc];
-    
+
     if (width > clamp)
       width = clamp;
   }
@@ -467,10 +464,10 @@ tab_natural_height (struct tab_table *t, struct outp_driver *d, int r)
   int height;
 
   assert (t != NULL && r >= 0 && r < t->nr);
-  
+
   {
     int c;
-    
+
     for (height = d->font_height, c = 0; c < t->nc; c++)
       {
        struct outp_text text;
@@ -504,10 +501,10 @@ tab_natural_dimensions (struct tab_table *t, struct outp_driver *d)
   int i;
 
   assert (t != NULL);
-  
+
   for (i = 0; i < t->nc; i++)
     t->w[i] = tab_natural_width (t, d, i);
-  
+
   for (i = 0; i < t->nr; i++)
     t->h[i] = tab_natural_height (t, d, i);
 }
@@ -541,7 +538,7 @@ tab_value (struct tab_table *table, int c, int r, unsigned char opt,
   contents = pool_alloc (table->container, f->w);
   table->cc[c + r * table->cf] = ss_buffer (contents, f->w);
   table->ct[c + r * table->cf] = opt;
-  
+
   data_out (v, f, contents);
 }
 
@@ -553,19 +550,19 @@ tab_float (struct tab_table *table, int c, int r, unsigned char opt,
 {
   char *contents;
   char buf[40], *cp;
-  
+
   struct fmt_spec f;
   union value double_value;
 
   assert (table != NULL && w <= 40);
-  
+
   assert (c >= 0);
   assert (c < table->nc);
   assert (r >= 0);
   assert (r < table->nr);
 
   f = fmt_for_output (FMT_F, w, d);
-  
+
 #if DEBUGGING
   if (c + table->col_ofs < 0 || r + table->row_ofs < 0
       || c + table->col_ofs >= table->nc
@@ -607,7 +604,7 @@ tab_text (struct tab_table *table, int c, int r, unsigned opt, const char *text,
   assert (r >= 0 );
   assert (c < table->nc);
   assert (r < table->nr);
-  
+
 
 #if DEBUGGING
   if (c + table->col_ofs < 0 || r + table->row_ofs < 0
@@ -664,41 +661,41 @@ tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
 #endif
 
   tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
-  
+
   j = pool_alloc (table->container, sizeof *j);
   j->hit = 0;
   j->x1 = x1 + table->col_ofs;
   j->y1 = y1 + table->row_ofs;
   j->x2 = ++x2 + table->col_ofs;
   j->y2 = ++y2 + table->row_ofs;
-  
+
   {
     va_list args;
-    
+
     va_start (args, text);
     j->contents = text_format (table, opt, text, args);
     va_end (args);
   }
-  
+
   opt |= TAB_JOIN;
-  
+
   {
     struct substring *cc = &table->cc[x1 + y1 * table->cf];
     unsigned char *ct = &table->ct[x1 + y1 * table->cf];
     const int ofs = table->cf - (x2 - x1);
 
     int y;
-    
+
     for (y = y1; y < y2; y++)
       {
        int x;
-       
+
        for (x = x1; x < x2; x++)
          {
            *cc++ = ss_buffer ((char *) j, 0);
            *ct++ = opt;
          }
-       
+
        cc += ofs;
        ct += ofs;
       }
@@ -711,7 +708,7 @@ tab_raw (struct tab_table *table, int c, int r, unsigned opt,
         struct substring *string)
 {
   assert (table != NULL && string != NULL);
-  
+
 #if DEBUGGING
   if (c + table->col_ofs < 0 || r + table->row_ofs < 0
       || c + table->col_ofs >= table->nc
@@ -762,17 +759,17 @@ tab_output_text (int options, const char *buf, ...)
   if (options & TAT_PRINTF)
     {
       va_list args;
-      
+
       va_start (args, buf);
       buf = tmp_buf = xvasprintf (buf, args);
       va_end (args);
     }
-  
+
   tab_text (t, 0, 0, options & ~TAT_PRINTF, buf);
   tab_flags (t, SOMF_NO_TITLE | SOMF_NO_SPACING);
   tab_dim (t, options & TAT_NOWRAP ? nowrap_dim : wrap_dim);
   tab_submit (t);
-  
+
   free (tmp_buf);
 }
 
@@ -855,7 +852,7 @@ tabi_table (struct som_entity *table)
 
   t = table->ext;
   tab_offset (t, 0, 0);
-  
+
   assert (t->w == NULL && t->h == NULL);
   t->w = pool_nalloc (t->container, t->nc, sizeof *t->w);
   t->h = pool_nalloc (t->container, t->nr, sizeof *t->h);
@@ -866,9 +863,9 @@ tabi_table (struct som_entity *table)
 /* Returns the line style to use for spacing purposes for a rule
    of the given TYPE. */
 static enum outp_line_style
-rule_to_spacing_type (unsigned char type) 
+rule_to_spacing_type (unsigned char type)
 {
-  switch (type) 
+  switch (type)
     {
     case TAL_0:
       return OUTP_L_NONE;
@@ -888,28 +885,28 @@ tabi_driver (struct outp_driver *driver)
 {
   int c, r;
   int i;
-  
+
   assert (driver != NULL);
   d = driver;
-  
+
   /* Figure out sizes of rules. */
-  for (r = 0; r <= t->nr; r++) 
+  for (r = 0; r <= t->nr; r++)
     {
       int width = 0;
-      for (c = 0; c < t->nc; c++) 
+      for (c = 0; c < t->nc; c++)
         {
           unsigned char rh = t->rh[c + r * t->cf];
           int w = driver->horiz_line_width[rule_to_spacing_type (rh)];
           if (w > width)
-            width = w; 
+            width = w;
         }
-      t->hrh[r] = width; 
+      t->hrh[r] = width;
     }
 
-  for (c = 0; c <= t->nc; c++) 
+  for (c = 0; c <= t->nc; c++)
     {
       int width = 0;
-      for (r = 0; r < t->nr; r++) 
+      for (r = 0; r < t->nr; r++)
         {
           unsigned char *rv = &t->rv[c + r * (t->cf + 1)];
           int w;
@@ -919,7 +916,7 @@ tabi_driver (struct outp_driver *driver)
           if (w > width)
             width = w;
         }
-      t->wrv[c] = width; 
+      t->wrv[c] = width;
     }
 
 #if DEBUGGING
@@ -945,7 +942,7 @@ tabi_driver (struct outp_driver *driver)
          }
        assert (t->h[i] > 0);
       }
-    
+
     for (i = 0; i < t->nc; i++)
       {
        if (t->w[i] == -1)
@@ -957,7 +954,7 @@ tabi_driver (struct outp_driver *driver)
       }
   }
 #endif
-    
+
   /* Add up header sizes. */
   for (i = 0, t->wl = t->wrv[0]; i < t->l; i++)
     t->wl += t->w[i] + t->wrv[i + 1];
@@ -967,7 +964,7 @@ tabi_driver (struct outp_driver *driver)
     t->wr += t->w[i] + t->wrv[i + 1];
   for (i = t->nr - t->b, t->hb = t->hrh[i]; i < t->nr; i++)
     t->hb += t->h[i] + t->hrh[i + 1];
-  
+
   /* Title. */
   if (!(t->flags & SOMF_NO_TITLE))
     t->ht += d->font_height;
@@ -992,16 +989,16 @@ static void
 tabi_area (int *horiz, int *vert)
 {
   assert (horiz != NULL && vert != NULL);
-  
+
   {
     int w, c;
-    
+
     for (c = t->l + 1, w = t->wl + t->wr + t->w[t->l];
         c < t->nc - t->r; c++)
       w += t->w[c] + t->wrv[c];
     *horiz = w;
   }
-  
+
   {
     int h, r;
     for (r = t->t + 1, h = t->ht + t->hb + t->h[t->t];
@@ -1045,7 +1042,7 @@ tabi_cumulate (int cumtype, int start, int *end, int max, int *actual)
   int *d;
   int *r;
   int total;
-  
+
   assert (end != NULL && (cumtype == SOM_ROWS || cumtype == SOM_COLUMNS));
   if (cumtype == SOM_ROWS)
     {
@@ -1063,7 +1060,7 @@ tabi_cumulate (int cumtype, int start, int *end, int max, int *actual)
       r = &t->wrv[start + 1];
       total = t->wl + t->wr;
     }
-  
+
   total += *d++;
   if (total > max)
     {
@@ -1073,14 +1070,14 @@ tabi_cumulate (int cumtype, int start, int *end, int max, int *actual)
        *actual = 0;
       return;
     }
-    
+
   {
     int x;
-      
+
     for (x = start + 1; x < n; x++)
       {
        int amt = *d++ + *r++;
-       
+
        total += amt;
        if (total > max)
          {
@@ -1091,7 +1088,7 @@ tabi_cumulate (int cumtype, int start, int *end, int max, int *actual)
 
     if (end)
       *end = x;
-    
+
     if (actual)
       *actual = total;
   }
@@ -1108,7 +1105,7 @@ tabi_flags (unsigned *flags)
 /* Returns true if the table will fit in the given page WIDTH,
    false otherwise. */
 static bool
-tabi_fits_width (int width) 
+tabi_fits_width (int width)
 {
   int i;
 
@@ -1122,7 +1119,7 @@ tabi_fits_width (int width)
 /* Returns true if the table will fit in the given page LENGTH,
    false otherwise. */
 static bool
-tabi_fits_length (int length) 
+tabi_fits_length (int length)
 {
   int i;
 
@@ -1155,7 +1152,7 @@ tabi_title (int x, int y)
 
   if (t->flags & SOMF_NO_TITLE)
     return;
-  
+
   cp = spprintf (buf, "%d.%d", table_num, subtable_num);
   if (x && y)
     cp = spprintf (cp, "(%d:%d)", x, y);
@@ -1171,7 +1168,7 @@ tabi_title (int x, int y)
       cp += length;
     }
   *cp = 0;
-  
+
   {
     struct outp_text text;
 
@@ -1197,13 +1194,13 @@ static int
 render_rows (int y, int c0, int c1, int r0, int r1)
 {
   int r;
-  for (r = r0; r < r1; r++) 
+  for (r = r0; r < r1; r++)
     {
       int x = d->cp_x;
       x = render_strip (x, y, r, 0, t->l * 2 + 1, r0, r1);
       x = render_strip (x, y, r, c0 * 2 + 1, c1 * 2, r0, r1);
       x = render_strip (x, y, r, (t->nc - t->r) * 2, t->nc * 2 + 1, r0, r1);
-      y += (r & 1) ? t->h[r / 2] : t->hrh[r / 2]; 
+      y += (r & 1) ? t->h[r / 2] : t->hrh[r / 2];
     }
   return y;
 }
@@ -1214,7 +1211,7 @@ static void
 tabi_render (int c0, int r0, int c1, int r1)
 {
   int y;
-  
+
   tab_hit++;
 
   y = d->cp_y;
@@ -1230,7 +1227,7 @@ const struct som_table_class tab_table_class =
   {
     tabi_table,
     tabi_driver,
-    
+
     tabi_count,
     tabi_area,
     NULL,
@@ -1243,7 +1240,7 @@ const struct som_table_class tab_table_class =
     tabi_flags,
     tabi_fits_width,
     tabi_fits_length,
-    
+
     NULL,
     NULL,
     tabi_set_headers,
@@ -1255,7 +1252,7 @@ const struct som_table_class tab_table_class =
 static enum outp_justification
 translate_justification (unsigned int opt)
 {
-  switch (opt & TAB_ALIGN_MASK) 
+  switch (opt & TAB_ALIGN_MASK)
     {
     case TAB_RIGHT:
       return OUTP_RIGHT;
@@ -1271,9 +1268,9 @@ translate_justification (unsigned int opt)
 /* Returns the line style to use for drawing a rule of the given
    TYPE. */
 static enum outp_line_style
-rule_to_draw_type (unsigned char type) 
+rule_to_draw_type (unsigned char type)
 {
-  switch (type) 
+  switch (type)
     {
     case TAL_0:
     case TAL_GAP:
@@ -1289,14 +1286,14 @@ rule_to_draw_type (unsigned char type)
 
 /* Returns the horizontal rule at the given column and row. */
 static int
-get_hrule (int c, int r) 
+get_hrule (int c, int r)
 {
   return t->rh[c + r * t->cf];
 }
 
 /* Returns the vertical rule at the given column and row. */
 static int
-get_vrule (int c, int r) 
+get_vrule (int c, int r)
 {
   return t->rv[c + r * (t->cf + 1)];
 }
@@ -1359,7 +1356,7 @@ strip_width (int c1, int c2)
   int width = 0;
   int c;
 
-  for (c = c1; c < c2; c++) 
+  for (c = c1; c < c2; c++)
     width += t->w[c] + t->wrv[c + 1];
   if (c1 < c2)
     width -= t->wrv[c2];
@@ -1374,7 +1371,7 @@ strip_height (int r1, int r2)
   int height = 0;
   int r;
 
-  for (r = r1; r < r2; r++) 
+  for (r = r1; r < r2; r++)
     height += t->h[r] + t->hrh[r + 1];
   if (r1 < r2)
     height -= t->hrh[r2];
@@ -1390,7 +1387,7 @@ render_cell (int x, int y, int c, int r, int c1, int r1)
   const int index = c + (r * t->cf);
   unsigned char type = t->ct[index];
   struct substring *content = &t->cc[index];
-  
+
   if (!(type & TAB_JOIN))
     {
       if (!(type & TAB_EMPTY))
@@ -1443,7 +1440,7 @@ render_strip (int x, int y, int r, int c0, int c1, int r0 UNUSED, int r1)
   int c;
 
   for (c = c0; c < c1; c++)
-    if (c & 1) 
+    if (c & 1)
       {
         if (r & 1)
           render_cell (x, y, c / 2, r / 2, c1 / 2, r1);
@@ -1459,14 +1456,14 @@ render_strip (int x, int y, int r, int c0, int c1, int r0 UNUSED, int r1)
           render_rule_intersection (x, y, c / 2, r / 2);
         x += t->wrv[c / 2];
       }
-  
+
   return x;
 }
 
 /* Sets COMMAND_NAME as the name of the current command,
    for embedding in output. */
 void
-tab_set_command_name (const char *command_name_) 
+tab_set_command_name (const char *command_name_)
 {
   free (command_name);
   command_name = command_name_ ? xstrdup (command_name_) : NULL;