src/data/dict-class.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007 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 /* Dictionary classes.
  18
  19    Occasionally it is useful to classify variables into three
  20    groups: system variables (those whose names begin with $),
  21    scratch variables (those whose names begin with #), and
  22    ordinary variables (all others).  This header provides a
  23    little bit of support for this. */
  24
  25 #ifndef DATA_DICT_CLASS_H
  26 #define DATA_DICT_CLASS_H 1
  27
  28 /* Classes of variables.
  29    These values are bitwise disjoint so that they can be used in
  30    masks. */
  31 enum dict_class
  32   {
  33     DC_ORDINARY = 0x0001,       /* Ordinary identifier. */
  34     DC_SYSTEM = 0x0002,         /* System variable. */
  35     DC_SCRATCH = 0x0004,        /* Scratch variable. */
  36     DC_ALL = 0x0007             /* All of the above. */
  37   };
  38
  39 enum dict_class dict_class_from_id (const char *name);
  40 const char *dict_class_to_name (enum dict_class);
  41
  42 #endif /* data/dict-class.h */