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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2011 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_ITEM_PROVIDER_H
  18 #define OUTPUT_ITEM_PROVIDER_H 1
  19
  20 #include "libpspp/str.h"
  21 #include "output/output-item.h"
  22
  23 /* Class structure for an output item.
  24
  25    This structure must be provided by an output_item subclass to initialize an
  26    instance of output_item. */
  27 struct output_item_class
  28   {
  29     /* Returns the localized label to use for ITEM.  This is only called when
  30        ITEM does not have an explicitly set label, that is, when 'item->label'
  31        is NULL. */
  32     const char *(*get_label) (const struct output_item *item);
  33
  34     /* Destroys and frees ITEM.  Called when output_item_unref() drops ITEM's
  35        reference count to 0. */
  36     void (*destroy) (struct output_item *item);
  37   };
  38
  39 #define OUTPUT_ITEM_INITIALIZER(CLASS) { .class = CLASS, .ref_cnt = 1 }
  40 #define OUTPUT_ITEM_CLONE_INITIALIZER(SRC)                      \
  41   {                                                             \
  42     .class = (SRC)->class,                                      \
  43     .ref_cnt = 1,                                               \
  44     .label = xstrdup_if_nonnull ((SRC)->label),                 \
  45     .command_name = xstrdup_if_nonnull ((SRC)->command_name),   \
  46   }
  47
  48 #endif /* output/output-item-provider.h */