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     char *typeface;
  54     int size;
  55     bool bold, italic, underline, markup;
  56   };
  57
  58 struct text_item *text_item_create (enum text_item_type, const char *text);
  59 struct text_item *text_item_create_nocopy (enum text_item_type, char *text);
  60 struct text_item *text_item_create_format (enum text_item_type,
  61                                            const char *format, ...)
  62   PRINTF_FORMAT (2, 3);
  63
  64 enum text_item_type text_item_get_type (const struct text_item *);
  65 const char *text_item_get_text (const struct text_item *);
  66
  67 struct table_item *text_item_to_table_item (struct text_item *);
  68 \f
  69 /* This boilerplate for text_item, a subclass of output_item, was
  70    autogenerated by mk-class-boilerplate. */
  71
  72 #include <assert.h>
  73 #include "libpspp/cast.h"
  74
  75 extern const struct output_item_class text_item_class;
  76
  77 /* Returns true if SUPER is a text_item, otherwise false. */
  78 static inline bool
  79 is_text_item (const struct output_item *super)
  80 {
  81   return super->class == &text_item_class;
  82 }
  83
  84 /* Returns SUPER converted to text_item.  SUPER must be a text_item, as
  85    reported by is_text_item. */
  86 static inline struct text_item *
  87 to_text_item (const struct output_item *super)
  88 {
  89   assert (is_text_item (super));
  90   return UP_CAST (super, struct text_item, output_item);
  91 }
  92
  93 /* Returns INSTANCE converted to output_item. */
  94 static inline struct output_item *
  95 text_item_super (const struct text_item *instance)
  96 {
  97   return CONST_CAST (struct output_item *, &instance->output_item);
  98 }
  99
 100 /* Increments INSTANCE's reference count and returns INSTANCE. */
 101 static inline struct text_item *
 102 text_item_ref (const struct text_item *instance)
 103 {
 104   return to_text_item (output_item_ref (&instance->output_item));
 105 }
 106
 107 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
 108    the reference count is now zero. */
 109 static inline void
 110 text_item_unref (struct text_item *instance)
 111 {
 112   output_item_unref (&instance->output_item);
 113 }
 114
 115 /* Returns true if INSTANCE's reference count is greater than 1,
 116    false otherwise. */
 117 static inline bool
 118 text_item_is_shared (const struct text_item *instance)
 119 {
 120   return output_item_is_shared (&instance->output_item);
 121 }
 122
 123 void text_item_submit (struct text_item *);
 124 \f
 125 #endif /* output/text-item.h */