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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2011 Free Sonftware 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_TEXT_ITEM_H
  18 #define OUTPUT_TEXT_ITEM_H 1
  19
  20 /* Text items.
  21
  22    A text item is a subclass of an output item (see
  23    output/output-item.h).
  24
  25    A text item is just a text string. */
  26
  27 #include <stdbool.h>
  28 #include "libpspp/compiler.h"
  29 #include "output/output-item.h"
  30
  31 enum text_item_type
  32   {
  33     TEXT_ITEM_PAGE_TITLE,       /* TITLE and SUBTITLE commands. */
  34     TEXT_ITEM_TITLE,            /* Title. */
  35     TEXT_ITEM_PARAGRAPH,        /* Normal paragraph of text. */
  36
  37     /* Log items. */
  38     TEXT_ITEM_SYNTAX,           /* A single line of PSPP syntax. */
  39     TEXT_ITEM_LOG,              /* Other logging. */
  40
  41     /* Spacing.  Some output drivers that are not based on lines and pages
  42        (e.g. CSV, HTML) may ignore these. */
  43     TEXT_ITEM_BLANK_LINE,       /* Blank line. */
  44     TEXT_ITEM_EJECT_PAGE        /* Eject page. */
  45   };
  46
  47 /* A text item. */
  48 struct text_item
  49   {
  50     struct output_item output_item;
  51     char *text;                 /* The content. */
  52     enum text_item_type type;   /* Type. */
  53
  54     bool bold, italic, underline, markup;
  55     char *typeface;
  56     int size;
  57   };
  58
  59 struct text_item *text_item_create (enum text_item_type, const char *text);
  60 struct text_item *text_item_create_nocopy (enum text_item_type, char *text);
  61 struct text_item *text_item_create_format (enum text_item_type,
  62                                            const char *format, ...)
  63   PRINTF_FORMAT (2, 3);
  64
  65 enum text_item_type text_item_get_type (const struct text_item *);
  66 const char *text_item_get_text (const struct text_item *);
  67
  68 struct table_item *text_item_to_table_item (struct text_item *);
  69 \f
  70 /* This boilerplate for text_item, a subclass of output_item, was
  71    autogenerated by mk-class-boilerplate. */
  72
  73 #include <assert.h>
  74 #include "libpspp/cast.h"
  75
  76 extern const struct output_item_class text_item_class;
  77
  78 /* Returns true if SUPER is a text_item, otherwise false. */
  79 static inline bool
  80 is_text_item (const struct output_item *super)
  81 {
  82   return super->class == &text_item_class;
  83 }
  84
  85 /* Returns SUPER converted to text_item.  SUPER must be a text_item, as
  86    reported by is_text_item. */
  87 static inline struct text_item *
  88 to_text_item (const struct output_item *super)
  89 {
  90   assert (is_text_item (super));
  91   return UP_CAST (super, struct text_item, output_item);
  92 }
  93
  94 /* Returns INSTANCE converted to output_item. */
  95 static inline struct output_item *
  96 text_item_super (const struct text_item *instance)
  97 {
  98   return CONST_CAST (struct output_item *, &instance->output_item);
  99 }
 100
 101 /* Increments INSTANCE's reference count and returns INSTANCE. */
 102 static inline struct text_item *
 103 text_item_ref (const struct text_item *instance)
 104 {
 105   return to_text_item (output_item_ref (&instance->output_item));
 106 }
 107
 108 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
 109    the reference count is now zero. */
 110 static inline void
 111 text_item_unref (struct text_item *instance)
 112 {
 113   output_item_unref (&instance->output_item);
 114 }
 115
 116 /* Returns true if INSTANCE's reference count is greater than 1,
 117    false otherwise. */
 118 static inline bool
 119 text_item_is_shared (const struct text_item *instance)
 120 {
 121   return output_item_is_shared (&instance->output_item);
 122 }
 123
 124 void text_item_submit (struct text_item *);
 125 \f
 126 #endif /* output/text-item.h */