src/settings.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !settings_h
  21 #define settings_h 1
  22
  23 /* Table of mode settings (x=X, w=Windows, p=PC+, f=has relevance for
  24    PSPP):
  25
  26    AUTOMENU: p
  27    BEEP: p
  28    BLANKS: xwpf
  29    BLKSIZE: x (only on SHOW, not on SET)
  30    BLOCK: xwp
  31    BOX/BOXSTRING: xwp
  32    BUFNO: x (only on SHOW, not on SET)
  33    CASE: xw
  34    CCA...CCE: xwf
  35    COLOR: p
  36    COMP/COMPRESSION: xwpf (meaning varies between p and xw)
  37    CPI: xwp
  38    CPROMPT: pf
  39    DECIMAL: wf
  40    DPROMPT: f
  41    ECHO: pf
  42    EJECT: p
  43    EMULATION: f
  44    ENDCMD: xpf
  45    ERRORBREAK: pf
  46    ERRORS: wf
  47    FORMAT: xwf
  48    HEADERS: xwf
  49    HELPWINDOWS: p
  50    HIGHRES: w
  51    HISTOGRAM: xp
  52    INCLUDE: pf
  53    JOURNAL: wf (equivalent to LOG)
  54    LENGTH: xwp
  55    LISTING: xpf
  56    LOG: pf (equivalent to JOURNAL)
  57    LOWRES: w
  58    LPI: xwp
  59    MENUS: p
  60    MESSAGES: wf
  61    MEXPAND: xwf
  62    MITERATE: xwf
  63    MNEST: xwf
  64    MORE: pf
  65    MPRINT: xwf
  66    MXERRS: xf
  67    MXLOOPS: xwf
  68    MXMEMORY: w
  69    MXWARNS: xwf
  70    N: xw (only on SHOW, not on SET)
  71    NULLINE: xpf
  72    NUMBERED: x (only on SHOW, not on SET)
  73    PAGER: f
  74    PRINTBACK: xwf
  75    PRINTER: pf
  76    PROMPT: pf
  77    PTRANSLATE: p
  78    RCOLOR: p
  79    RESULTS: wpf (semantics differ)
  80    RUNREVIEW: p
  81    SCOMP/SCOMPRESSION: xwf
  82    SCREEN: pf
  83    SCRIPTTAB: xw
  84    SEED: xwpf (semantics differ)
  85    SYSMIS: xwf (only on SHOW, not on SET)
  86    TBFONTS: xw
  87    TB1: xw
  88    TB2: x
  89    UNDEFINED: xwf
  90    VIEWLENGTH: pf
  91    VIEWWIDTH: f
  92    WEIGHT: xwf (only on SHOW, not on SET)
  93    WIDTH: xwp
  94    WORKDEV: p
  95    WORKSPACE: w
  96    XSORT: x
  97    $VARS: wf (only on SHOW, not on SET)
  98
  99  */
 100
 101 #include <stddef.h>
 102 #include <float.h>
 103
 104
 105 /* Describes one custom currency specification. */
 106 struct set_cust_currency
 107   {
 108     char buf[32];               /* Buffer for strings. */
 109     char *neg_prefix;           /* Negative prefix. */
 110     char *prefix;               /* Prefix. */
 111     char *suffix;               /* Suffix. */
 112     char *neg_suffix;           /* Negative suffix. */
 113     int decimal;                /* Decimal point. */
 114     int grouping;               /* Grouping character. */
 115   };
 116
 117
 118
 119
 120 /* Types of routing. */
 121 enum
 122   {
 123     SET_ROUTE_SCREEN = 001,     /* Output to screen devices? */
 124     SET_ROUTE_LISTING = 002,    /* Output to listing devices? */
 125     SET_ROUTE_OTHER = 004,      /* Output to other devices? */
 126     SET_ROUTE_DISABLE = 010     /* Disable output--overrides all other bits. */
 127   };
 128
 129
 130 /* Set view width to a very long value, and prevent it from
 131    ever changing */
 132 void force_long_view(void);
 133
 134
 135 /* Requested "view length" in lines. */
 136 int get_viewlength(void);
 137
 138 /* Screen width. */
 139 int get_viewwidth(void);
 140
 141 void init_settings(void) ;
 142 void done_settings(void) ;
 143
 144 /* Whether pspp can erase and overwrite files */
 145 int safer_mode(void);
 146
 147 /* Put into safer mode */
 148 void make_safe(void);
 149
 150 /* The character used for a decimal point: ',' or '.'.  Only respected
 151    for data input and output. */
 152 char get_decimal(void);
 153
 154 /* The character used for grouping in numbers: '.' or ','; the
 155    opposite of set_decimal.  Only used in COMMA data input and
 156    output. */
 157
 158 char get_grouping(void);
 159
 160 char *get_prompt(void);
 161
 162 /* Prompt used for lines between BEGIN DATA and END DATA. */
 163 char *get_dprompt(void);
 164
 165 /* Continuation prompt. */
 166 char *get_cprompt(void);
 167
 168
 169 /* Whether we echo commands to the listing file/printer;*/
 170 int get_echo(void);
 171
 172 /* If echo is on, whether commands from include files are echoed */
 173 int get_include(void);
 174
 175 /* Whether an error stops execution; */
 176 int  get_errorbreak(void);
 177
 178 /* Whether save files should be compressed by default. */
 179 int get_scompression(void);
 180
 181 /* Whether to warn on undefined values in numeric data. */
 182 int get_undefined(void);
 183
 184 /* Maximum number of warnings + errors. */
 185 int get_mxwarns(void);
 186
 187 /* Maximum number of errors. */
 188 int get_mxerrs(void);
 189
 190 /* 0=macro expansion is disabled, 1=macro expansion is enabled. */
 191 int get_mexpand(void);
 192
 193 /* Whether commands are written to the display */
 194 int get_printback(void);
 195
 196 /* Independent of get_printback, controls whether the commands
 197    generated by macro invocations are displayed. */
 198 int get_mprint(void);
 199
 200 /* Implied limit of unbounded loop. */
 201 int get_mxloops(void);
 202
 203 /* Whether a blank line is a command terminator */
 204 int get_nullline(void);
 205
 206 /* The character used to terminate commands. */
 207 unsigned char get_endcmd(void);
 208
 209 /* Approximate maximum amount of memory to use for cases, in
 210    bytes. */
 211 size_t get_max_workspace(void);
 212
 213 /* The value that blank numeric fields are set to when read in;
 214    normally SYSMIS. */
 215 double get_blanks(void);
 216
 217
 218 /* Default format for variables created by transformations and by DATA
 219    LIST {FREE,LIST}. */
 220 struct fmt_spec get_format(void);
 221
 222 /* CCA through CCE. */
 223 const struct set_cust_currency *get_cc(int i);
 224
 225 #if !USE_INTERNAL_PAGER
 226 /* Name of the pager program. */
 227 const char *get_pager(void);
 228 #endif /* !USE_INTERNAL_PAGER */
 229
 230
 231 #include <gsl/gsl_rng.h>
 232 gsl_rng *get_rng (void);
 233
 234
 235 enum {ENHANCED,COMPATIBLE};
 236
 237
 238 /* Set the algorithm option globally */
 239 void set_algorithm(int x);
 240
 241 /* Set the algorithm option for this command only */
 242 void set_cmd_algorithm(int x);
 243
 244 /* Unset the algorithm option for this command */
 245 void unset_cmd_algorithm(void);
 246
 247 /* Return the current algorithm setting */
 248 int get_algorithm(void);
 249
 250 /* Set the syntax option */
 251 void set_syntax(int x);
 252
 253 /* Get the current syntax setting */
 254 int get_syntax(void);
 255
 256
 257 #endif /* !settings_h */