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

   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 #ifndef OUTPUT_TABLE_ITEM_H
  18 #define OUTPUT_TABLE_ITEM_H 1
  19
  20 /* Table items.
  21
  22    A table item is a subclass of an output item (see output-item.h) that
  23    contains a table (see table.h) and some formatting properties.  Currently
  24    the formatting properties are an optional title (a brief description
  25    typically displayed above the table) and an optional caption (a more verbose
  26    description typically displayed below the table). */
  27
  28 #include "libpspp/compiler.h"
  29 #include "output/output-item.h"
  30 #include "output/table.h"
  31
  32 /* Title or caption in a table item. */
  33 struct table_item_text
  34   {
  35     char *content;
  36     const struct footnote **footnotes;
  37     size_t n_footnotes;
  38     struct area_style *style;
  39   };
  40
  41 struct table_item_text *table_item_text_create (const char *);
  42 struct table_item_text *table_item_text_clone (const struct table_item_text *);
  43 void table_item_text_destroy (struct table_item_text *);
  44
  45 struct table_item_layer
  46   {
  47     char *content;
  48     const struct footnote **footnotes;
  49     size_t n_footnotes;
  50   };
  51
  52 void table_item_layer_copy (struct table_item_layer *,
  53                             const struct table_item_layer *);
  54 void table_item_layer_uninit (struct table_item_layer *);
  55
  56 struct table_item_layers
  57   {
  58     struct table_item_layer *layers;
  59     size_t n_layers;
  60     struct area_style *style;
  61   };
  62
  63 struct table_item_layers *table_item_layers_clone (
  64   const struct table_item_layers *);
  65 void table_item_layers_destroy (struct table_item_layers *);
  66
  67 /* A table item.
  68
  69    The members of struct table_item should not be accessed directly.  Use one
  70    of the accessor functions defined below. */
  71 struct table_item
  72   {
  73     struct output_item output_item;  /* Superclass. */
  74     struct table *table;             /* The table to be rendered. */
  75     struct table_item_text *title;   /* Null if there is no title. */
  76     struct table_item_text *caption; /* Null if there is no caption. */
  77     struct table_item_layers *layers; /* Null if there is no layer info. */
  78   };
  79
  80 struct table_item *table_item_create (struct table *, const char *title,
  81                                       const char *caption);
  82
  83 const struct table *table_item_get_table (const struct table_item *);
  84
  85 const struct table_item_text *table_item_get_title (const struct table_item *);
  86 void table_item_set_title (struct table_item *,
  87                            const struct table_item_text *);
  88
  89 const struct table_item_layers *table_item_get_layers (
  90   const struct table_item *);
  91 void table_item_set_layers (struct table_item *,
  92                            const struct table_item_layers *);
  93
  94 const struct table_item_text *table_item_get_caption (
  95   const struct table_item *);
  96 void table_item_set_caption (struct table_item *,
  97                              const struct table_item_text *);
  98 \f
  99 /* This boilerplate for table_item, a subclass of output_item, was
 100    autogenerated by mk-class-boilerplate. */
 101
 102 #include <assert.h>
 103 #include "libpspp/cast.h"
 104
 105 extern const struct output_item_class table_item_class;
 106
 107 /* Returns true if SUPER is a table_item, otherwise false. */
 108 static inline bool
 109 is_table_item (const struct output_item *super)
 110 {
 111   return super->class == &table_item_class;
 112 }
 113
 114 /* Returns SUPER converted to table_item.  SUPER must be a table_item, as
 115    reported by is_table_item. */
 116 static inline struct table_item *
 117 to_table_item (const struct output_item *super)
 118 {
 119   assert (is_table_item (super));
 120   return UP_CAST (super, struct table_item, output_item);
 121 }
 122
 123 /* Returns INSTANCE converted to output_item. */
 124 static inline struct output_item *
 125 table_item_super (const struct table_item *instance)
 126 {
 127   return CONST_CAST (struct output_item *, &instance->output_item);
 128 }
 129
 130 /* Increments INSTANCE's reference count and returns INSTANCE. */
 131 static inline struct table_item *
 132 table_item_ref (const struct table_item *instance)
 133 {
 134   return to_table_item (output_item_ref (&instance->output_item));
 135 }
 136
 137 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
 138    the reference count is now zero. */
 139 static inline void
 140 table_item_unref (struct table_item *instance)
 141 {
 142   output_item_unref (&instance->output_item);
 143 }
 144
 145 /* Returns true if INSTANCE's reference count is greater than 1,
 146    false otherwise. */
 147 static inline bool
 148 table_item_is_shared (const struct table_item *instance)
 149 {
 150   return output_item_is_shared (&instance->output_item);
 151 }
 152
 153 void table_item_submit (struct table_item *);
 154 \f
 155 #endif /* output/table-item.h */