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