pintos-os.org Git - pspp/blob - src/output/table-item.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2011, 2014 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "output/table-provider.h"
  20
  21 #include <assert.h>
  22
  23 #include "libpspp/assertion.h"
  24 #include "libpspp/cast.h"
  25 #include "output/driver.h"
  26 #include "output/output-item-provider.h"
  27 #include "output/table-item.h"
  28
  29 #include "gl/xalloc.h"
  30
  31 struct table_item_text *
  32 table_item_text_create (const char *content)
  33 {
  34   if (!content)
  35     return NULL;
  36
  37   struct table_item_text *text = xmalloc (sizeof *text);
  38   *text = (struct table_item_text) { .content = xstrdup (content),
  39                                      .halign = TAB_LEFT };
  40   return text;
  41 }
  42
  43 struct table_item_text *
  44 table_item_text_clone (const struct table_item_text *old)
  45 {
  46   if (!old)
  47     return NULL;
  48
  49   struct table_item_text *new = xmalloc (sizeof *new);
  50   *new = (struct table_item_text) {
  51     .content = xstrdup (old->content),
  52     .footnotes = xmemdup (old->footnotes,
  53                           old->n_footnotes * sizeof *old->footnotes),
  54     .n_footnotes = old->n_footnotes,
  55     .style = cell_style_clone (NULL, old->style),
  56     .halign = old->halign,
  57   };
  58   return new;
  59 }
  60
  61 void
  62 table_item_text_destroy (struct table_item_text *text)
  63 {
  64   if (text)
  65     {
  66       free (text->content);
  67       free (text->footnotes);
  68       cell_style_free (text->style);
  69       free (text);
  70     }
  71 }
  72
  73 /* Initializes ITEM as a table item for rendering TABLE.  The new table item
  74    initially has the specified TITLE and CAPTION, which may each be NULL.  The
  75    caller retains ownership of TITLE and CAPTION. */
  76 struct table_item *
  77 table_item_create (struct table *table, const char *title, const char *caption)
  78 {
  79   struct table_item *item = xmalloc (sizeof *item);
  80   output_item_init (&item->output_item, &table_item_class);
  81   item->table = table;
  82   item->title = table_item_text_create (title);
  83   item->caption = table_item_text_create (caption);
  84   return item;
  85 }
  86
  87 /* Returns the table contained by TABLE_ITEM.  The caller must not modify or
  88    unref the returned table. */
  89 const struct table *
  90 table_item_get_table (const struct table_item *table_item)
  91 {
  92   return table_item->table;
  93 }
  94
  95 /* Returns ITEM's title, which is a null pointer if no title has been
  96    set. */
  97 const struct table_item_text *
  98 table_item_get_title (const struct table_item *item)
  99 {
 100   return item->title;
 101 }
 102
 103 /* Sets ITEM's title to TITLE, replacing any previous title.  Specify NULL for
 104    TITLE to clear any title from ITEM.  The caller retains ownership of TITLE.
 105
 106    This function may only be used on a table_item that is unshared. */
 107 void
 108 table_item_set_title (struct table_item *item,
 109                       const struct table_item_text *title)
 110 {
 111   assert (!table_item_is_shared (item));
 112   table_item_text_destroy (item->title);
 113   item->title = table_item_text_clone (title);
 114 }
 115
 116 /* Returns ITEM's caption, which is a null pointer if no caption has been
 117    set. */
 118 const struct table_item_text *
 119 table_item_get_caption (const struct table_item *item)
 120 {
 121   return item->caption;
 122 }
 123
 124 /* Sets ITEM's caption to CAPTION, replacing any previous caption.  Specify
 125    NULL for CAPTION to clear any caption from ITEM.  The caller retains
 126    ownership of CAPTION.
 127
 128    This function may only be used on a table_item that is unshared. */
 129 void
 130 table_item_set_caption (struct table_item *item,
 131                         const struct table_item_text *caption)
 132 {
 133   assert (!table_item_is_shared (item));
 134   table_item_text_destroy (item->caption);
 135   item->caption = table_item_text_clone (caption);
 136 }
 137
 138 /* Submits TABLE_ITEM to the configured output drivers, and transfers ownership
 139    to the output subsystem. */
 140 void
 141 table_item_submit (struct table_item *table_item)
 142 {
 143   output_submit (&table_item->output_item);
 144 }
 145 \f
 146 static void
 147 table_item_destroy (struct output_item *output_item)
 148 {
 149   struct table_item *item = to_table_item (output_item);
 150   free (item->title);
 151   free (item->caption);
 152   table_unref (item->table);
 153   free (item);
 154 }
 155
 156 const struct output_item_class table_item_class =
 157   {
 158     table_item_destroy,
 159   };