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