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