Implement the PRESERVE and RESTORE commands.
[pspp] / src / data / settings.h
index 61e64e0f135d06247a48381ecedd13e42db498fb..e68325f7f2bca21aed2ef100420a170b15c2522a 100644 (file)
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2006, 2009, 2010 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #if !settings_h
 #define settings_h 1
 #include <stdbool.h>
 #include <stddef.h>
 
+#include "data/format.h"
+#include "libpspp/float-format.h"
+#include "libpspp/integer-format.h"
+#include "libpspp/message.h"
+
+struct caseproto;
+struct settings;
+
 void settings_init (void);
 void settings_done (void);
 
-void force_long_view (void);
-int get_viewlength (void);
-void set_viewlength (int);
+struct settings *settings_get (void);
+void settings_set (const struct settings *);
+void settings_destroy (struct settings *);
+
+enum float_format settings_get_input_float_format (void);
+void settings_set_input_float_format ( enum float_format);
+
+/* Returns the integer format used for IB and PIB input. */
+enum integer_format settings_get_input_integer_format (void);
+
+/* Sets the integer format used for IB and PIB input to
+   FORMAT. */
+void settings_set_input_integer_format ( enum integer_format);
+
+
+/* Returns the current output integer format. */
+enum integer_format settings_get_output_integer_format (void);
+
+/* Sets the output integer format to INTEGER_FORMAT. */
+void settings_set_output_integer_format (enum integer_format integer_format);
+
+/* Returns the current output float format. */
+enum float_format settings_get_output_float_format (void);
+
+/* Sets the output float format to FLOAT_FORMAT. */
+void settings_set_output_float_format (enum float_format float_format);
 
-int get_viewwidth (void);
-void set_viewwidth (int);
 
-bool get_safer_mode (void);
-void set_safer_mode (void);
 
-bool get_echo (void);
-void set_echo (bool);
-bool get_include (void);
-void set_include (bool);
+int settings_get_viewlength (void);
+void settings_set_viewlength ( int);
 
-int get_epoch (void);
-void set_epoch (int);
+int settings_get_viewwidth (void);
+void settings_set_viewwidth ( int);
 
-bool get_errorbreak (void);
-void set_errorbreak (bool);
+bool settings_get_safer_mode (void);
+void settings_set_safer_mode (void);
 
-bool get_error_routing_to_terminal (void);
-void set_error_routing_to_terminal (bool);
-bool get_error_routing_to_listing (void);
-void set_error_routing_to_listing (bool);
+bool settings_get_include (void);
+void settings_set_include ( bool);
 
-bool get_scompression (void);
-void set_scompression (bool);
+int settings_get_epoch (void);
+void settings_set_epoch ( int);
 
-bool get_undefined (void);
-void set_undefined (bool);
-double get_blanks (void);
-void set_blanks (double);
+bool settings_get_scompression (void);
+void settings_set_scompression (bool);
 
-int get_mxwarns (void);
-void set_mxwarns (int);
-int get_mxerrs (void);
-void set_mxerrs (int);
+bool settings_get_undefined (void);
+void settings_set_undefined (bool);
+double settings_get_blanks (void);
+void settings_set_blanks (double);
 
-bool get_printback (void);
-void set_printback (bool);
-bool get_mprint (void);
-void set_mprint (bool);
+int settings_get_max_messages (enum msg_severity);
+void settings_set_max_messages (enum msg_severity, int max);
 
-int get_mxloops (void);
-void set_mxloops (int);
+bool settings_get_mprint (void);
+void settings_set_mprint (bool);
 
-bool get_nulline (void);
-void set_nulline (bool);
+int settings_get_mxloops (void);
+void settings_set_mxloops ( int);
 
-char get_endcmd (void);
-void set_endcmd (char);
+bool settings_get_nulline (void);
+void settings_set_nulline (bool);
 
-size_t get_workspace (void);
-void set_workspace (size_t);
+char settings_get_endcmd (void);
+void settings_set_endcmd (char);
 
-const struct fmt_spec *get_format (void);
-void set_format (const struct fmt_spec *);
+size_t settings_get_workspace (void);
+size_t settings_get_workspace_cases (const struct caseproto *);
+void settings_set_workspace (size_t);
 
-bool get_testing_mode (void);
-void set_testing_mode (bool);
+const struct fmt_spec *settings_get_format (void);
+void settings_set_format ( const struct fmt_spec *);
+
+bool settings_get_testing_mode (void);
+void settings_set_testing_mode (bool);
 
 enum behavior_mode {
   ENHANCED,             /* Use improved PSPP behavior. */
   COMPATIBLE            /* Be as compatible as possible. */
 };
 
-enum behavior_mode get_algorithm (void);
-void set_algorithm (enum behavior_mode);
-enum behavior_mode get_syntax (void);
-void set_syntax(enum behavior_mode);
-void set_cmd_algorithm (enum behavior_mode);
+enum behavior_mode settings_get_algorithm (void);
+void settings_set_algorithm (enum behavior_mode);
+enum behavior_mode settings_get_syntax (void);
+void settings_set_syntax (enum behavior_mode);
+
+void settings_set_cmd_algorithm (enum behavior_mode);
 void unset_cmd_algorithm (void);
 
+enum fmt_type;
+bool settings_set_cc (const char *cc_string, enum fmt_type type);
+
+int settings_get_decimal_char (enum fmt_type type);
+void settings_set_decimal_char (char decimal);
+
+
+const struct fmt_number_style * settings_get_style (enum fmt_type type);
+
+char * settings_dollar_template (const struct fmt_spec *fmt);
+
+/* Routing of different kinds of output. */
+enum settings_output_devices
+  {
+    SETTINGS_DEVICE_LISTING = 1 << 0,  /* File or device. */
+    SETTINGS_DEVICE_TERMINAL = 1 << 1, /* Screen. */
+    SETTINGS_DEVICE_UNFILTERED = 1 << 2 /* Gets all output, no filtering. */
+  };
+
+enum settings_output_type
+  {
+    SETTINGS_OUTPUT_ERROR,      /* Errors and warnings. */
+    SETTINGS_OUTPUT_NOTE,       /* Notes. */
+    SETTINGS_OUTPUT_SYNTAX,     /* Syntax. */
+    SETTINGS_OUTPUT_RESULT,     /* Everything else. */
+    SETTINGS_N_OUTPUT_TYPES
+  };
+
+void settings_set_output_routing (enum settings_output_type,
+                                  enum settings_output_devices);
+enum settings_output_devices settings_get_output_routing (
+  enum settings_output_type);
+
 #endif /* !settings_h */