pintos-os.org Git - pspp/blob - src/data/settings.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2015 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 #if !settings_h
  18 #define settings_h 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22
  23 #include "data/format.h"
  24 #include "libpspp/compiler.h"
  25 #include "libpspp/float-format.h"
  26 #include "libpspp/integer-format.h"
  27 #include "libpspp/message.h"
  28
  29 struct caseproto;
  30 struct settings;
  31
  32 void settings_init (void);
  33 void settings_done (void);
  34
  35 struct settings *settings_get (void);
  36 void settings_set (const struct settings *);
  37 void settings_destroy (struct settings *);
  38
  39 enum float_format settings_get_input_float_format (void);
  40 void settings_set_input_float_format (enum float_format);
  41
  42 /* Returns the integer format used for IB and PIB input. */
  43 enum integer_format settings_get_input_integer_format (void);
  44
  45 /* Sets the integer format used for IB and PIB input to
  46    FORMAT. */
  47 void settings_set_input_integer_format (enum integer_format);
  48
  49
  50 /* Returns the current output integer format. */
  51 enum integer_format settings_get_output_integer_format (void);
  52
  53 /* Sets the output integer format to INTEGER_FORMAT. */
  54 void settings_set_output_integer_format (enum integer_format integer_format);
  55
  56 /* Returns the current output float format. */
  57 enum float_format settings_get_output_float_format (void);
  58
  59 /* Sets the output float format to FLOAT_FORMAT. */
  60 void settings_set_output_float_format (enum float_format float_format);
  61
  62
  63
  64 int settings_get_viewlength (void);
  65 void settings_set_viewlength (int);
  66
  67 int settings_get_viewwidth (void);
  68 void settings_set_viewwidth (int);
  69
  70 bool settings_get_safer_mode (void);
  71 void settings_set_safer_mode (void);
  72
  73 bool settings_get_include (void);
  74 void settings_set_include (bool);
  75
  76 void settings_set_epoch (int);
  77
  78 bool settings_get_scompression (void);
  79 void settings_set_scompression (bool);
  80
  81 bool settings_get_undefined (void);
  82 void settings_set_undefined (bool);
  83 double settings_get_blanks (void);
  84 void settings_set_blanks (double);
  85
  86 int settings_get_max_messages (enum msg_severity);
  87 void settings_set_max_messages (enum msg_severity, int max);
  88
  89 /* Macro settings. */
  90 bool settings_get_mexpand (void);
  91 void settings_set_mexpand (bool);
  92
  93 bool settings_get_mprint (void);
  94 void settings_set_mprint (bool);
  95
  96 int settings_get_miterate (void);
  97 void settings_set_miterate (int);
  98
  99 int settings_get_mnest (void);
 100 void settings_set_mnest (int);
 101
 102 int settings_get_mxloops (void);
 103 void settings_set_mxloops (int);
 104
 105 size_t settings_get_workspace (void);
 106 size_t settings_get_workspace_cases (const struct caseproto *);
 107 void settings_set_workspace (size_t);
 108
 109 const struct fmt_spec *settings_get_format (void);
 110 void settings_set_format (const struct fmt_spec *);
 111
 112 bool settings_get_testing_mode (void);
 113 void settings_set_testing_mode (bool);
 114
 115 int settings_get_fuzzbits (void);
 116 void settings_set_fuzzbits (int);
 117
 118 /* Whether to show variable or value labels or the underlying value or variable
 119    name. */
 120 enum ATTRIBUTE ((packed)) settings_value_show
 121   {
 122     /* Use higher-level default.
 123        In a pivot_value, the default is taken from the pivot_table.
 124        In a pivot_table, the default is a global default.
 125        As a global default, this is invalid. */
 126     SETTINGS_VALUE_SHOW_DEFAULT = 0,
 127
 128     SETTINGS_VALUE_SHOW_VALUE = 1, /* Show value or variable name only. */
 129     SETTINGS_VALUE_SHOW_LABEL = 2, /* Show label only. */
 130     SETTINGS_VALUE_SHOW_BOTH = 3,  /* Show both value/name and label. */
 131   };
 132
 133 enum settings_value_show settings_get_show_values (void);
 134 enum settings_value_show settings_get_show_variables (void);
 135
 136 void settings_set_show_values (enum settings_value_show);
 137 void settings_set_show_variables (enum settings_value_show);
 138
 139
 140 enum behavior_mode {
 141   ENHANCED,             /* Use improved PSPP behavior. */
 142   COMPATIBLE            /* Be as compatible as possible. */
 143 };
 144
 145 enum behavior_mode settings_get_algorithm (void);
 146 void settings_set_algorithm (enum behavior_mode);
 147 enum behavior_mode settings_get_syntax (void);
 148 void settings_set_syntax (enum behavior_mode);
 149
 150 void settings_set_cmd_algorithm (enum behavior_mode);
 151 void unset_cmd_algorithm (void);
 152
 153 enum fmt_type;
 154 bool settings_set_cc (const char *cc_string, enum fmt_type type);
 155
 156 void settings_set_decimal_char (char decimal);
 157
 158 const struct fmt_settings *settings_get_fmt_settings (void);
 159
 160 double settings_get_small (void);
 161 void settings_set_small (double);
 162
 163 char * settings_dollar_template (const struct fmt_spec *fmt);
 164
 165 /* Routing of different kinds of output. */
 166 enum settings_output_devices
 167   {
 168     SETTINGS_DEVICE_LISTING = 1 << 0,  /* File or device. */
 169     SETTINGS_DEVICE_TERMINAL = 1 << 1, /* Screen. */
 170     SETTINGS_DEVICE_UNFILTERED = 1 << 2 /* Gets all output, no filtering. */
 171   };
 172
 173 enum settings_output_type
 174   {
 175     SETTINGS_OUTPUT_ERROR,      /* Errors and warnings. */
 176     SETTINGS_OUTPUT_NOTE,       /* Notes. */
 177     SETTINGS_OUTPUT_SYNTAX,     /* Syntax. */
 178     SETTINGS_OUTPUT_RESULT,     /* Everything else. */
 179     SETTINGS_N_OUTPUT_TYPES
 180   };
 181
 182
 183
 184 void settings_set_output_routing (enum settings_output_type,
 185                                   enum settings_output_devices);
 186 enum settings_output_devices settings_get_output_routing (
 187   enum settings_output_type);
 188
 189 #endif /* !settings_h */