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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2018 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_GROUP_ITEM_H
  18 #define OUTPUT_GROUP_ITEM_H 1
  19
  20 /* Grouping items.
  21
  22    A group-open item marks the beginning of a group of related output items.  A
  23    later group-close item ends the group.  Groups can nest. */
  24
  25 #include <stdbool.h>
  26 #include "output/output-item.h"
  27
  28 /* A group_open item. */
  29 struct group_open_item
  30   {
  31     struct output_item output_item;
  32     char *command_name;
  33   };
  34
  35 struct group_open_item *group_open_item_create (const char *command_name);
  36 struct group_open_item *group_open_item_create_nocopy (char *command_name);
  37
  38 /* A group_close item. */
  39 struct group_close_item
  40   {
  41     struct output_item output_item;
  42   };
  43 struct group_close_item *group_close_item_create (void);
  44 \f
  45 /* This boilerplate for group_open_item, a subclass of output_item, was
  46    autogenerated by mk-class-boilerplate. */
  47
  48 #include <assert.h>
  49 #include "libpspp/cast.h"
  50
  51 extern const struct output_item_class group_open_item_class;
  52
  53 /* Returns true if SUPER is a group_open_item, otherwise false. */
  54 static inline bool
  55 is_group_open_item (const struct output_item *super)
  56 {
  57   return super->class == &group_open_item_class;
  58 }
  59
  60 /* Returns SUPER converted to group_open_item.  SUPER must be a
  61    group_open_item, as reported by is_group_open_item. */
  62 static inline struct group_open_item *
  63 to_group_open_item (const struct output_item *super)
  64 {
  65   assert (is_group_open_item (super));
  66   return UP_CAST (super, struct group_open_item, output_item);
  67 }
  68
  69 /* Returns INSTANCE converted to output_item. */
  70 static inline struct output_item *
  71 group_open_item_super (const struct group_open_item *instance)
  72 {
  73   return CONST_CAST (struct output_item *, &instance->output_item);
  74 }
  75
  76 /* Increments INSTANCE's reference count and returns INSTANCE. */
  77 static inline struct group_open_item *
  78 group_open_item_ref (const struct group_open_item *instance)
  79 {
  80   return to_group_open_item (output_item_ref (&instance->output_item));
  81 }
  82
  83 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
  84    the reference count is now zero. */
  85 static inline void
  86 group_open_item_unref (struct group_open_item *instance)
  87 {
  88   output_item_unref (&instance->output_item);
  89 }
  90
  91 /* Returns true if INSTANCE's reference count is greater than 1,
  92    false otherwise. */
  93 static inline bool
  94 group_open_item_is_shared (const struct group_open_item *instance)
  95 {
  96   return output_item_is_shared (&instance->output_item);
  97 }
  98
  99 void group_open_item_submit (struct group_open_item *);
 100 \f
 101 /* This boilerplate for group_close_item, a subclass of output_item, was
 102    autogenerated by mk-class-boilerplate. */
 103
 104 #include <assert.h>
 105 #include "libpspp/cast.h"
 106
 107 extern const struct output_item_class group_close_item_class;
 108
 109 /* Returns true if SUPER is a group_close_item, otherwise false. */
 110 static inline bool
 111 is_group_close_item (const struct output_item *super)
 112 {
 113   return super->class == &group_close_item_class;
 114 }
 115
 116 /* Returns SUPER converted to group_close_item.  SUPER must be a
 117    group_close_item, as reported by is_group_close_item. */
 118 static inline struct group_close_item *
 119 to_group_close_item (const struct output_item *super)
 120 {
 121   assert (is_group_close_item (super));
 122   return UP_CAST (super, struct group_close_item, output_item);
 123 }
 124
 125 /* Returns INSTANCE converted to output_item. */
 126 static inline struct output_item *
 127 group_close_item_super (const struct group_close_item *instance)
 128 {
 129   return CONST_CAST (struct output_item *, &instance->output_item);
 130 }
 131
 132 /* Increments INSTANCE's reference count and returns INSTANCE. */
 133 static inline struct group_close_item *
 134 group_close_item_ref (const struct group_close_item *instance)
 135 {
 136   return to_group_close_item (output_item_ref (&instance->output_item));
 137 }
 138
 139 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
 140    the reference count is now zero. */
 141 static inline void
 142 group_close_item_unref (struct group_close_item *instance)
 143 {
 144   output_item_unref (&instance->output_item);
 145 }
 146
 147 /* Returns true if INSTANCE's reference count is greater than 1,
 148    false otherwise. */
 149 static inline bool
 150 group_close_item_is_shared (const struct group_close_item *instance)
 151 {
 152   return output_item_is_shared (&instance->output_item);
 153 }
 154
 155 void group_close_item_submit (struct group_close_item *);
 156 \f
 157 #endif /* output/group-item.h */