Automatically infer variables' measurement level from format and data.
[pspp] / src / data / settings.c
index 114200cf060d5a4ed0d5adc2c910f2a3e81b0c42..c70635cec03fc06da0dd7c472a8da626e2010fd6 100644 (file)
@@ -20,7 +20,6 @@
 
 #include <assert.h>
 #include <stdlib.h>
-#include <time.h>
 
 #include "data/case.h"
 #include "data/format.h"
@@ -49,11 +48,13 @@ struct settings
   /* Format of reals in output (SET WRB). */
   enum float_format output_float_format;
 
+  /* MATRIX...END MATRIX settings. */
+  enum settings_mdisplay mdisplay;
+
   int viewlength;
   int viewwidth;
   bool safer_mode;
   bool include;
-  int epoch;
   bool route_errors_to_terminal;
   bool route_errors_to_listing;
   bool scompress;
@@ -61,77 +62,92 @@ struct settings
   double blanks;
   int max_messages[MSG_N_SEVERITIES];
   bool printback;
-  bool mprint;
+
+  /* Macro settings. */
+  bool mexpand;                 /* Expand macros? */
+  bool mprint;                  /* Print macro expansions? */
+  int miterate;                 /* Maximum iterations of !FOR. */
+  int mnest;                    /* Maximum nested macro expansion levels. */
+
   int mxloops;
   size_t workspace;
   struct fmt_spec default_format;
   bool testing_mode;
   int fuzzbits;
+  int scalemin;
 
   int cmd_algorithm;
   int global_algorithm;
   int syntax;
 
-  struct fmt_settings *styles;
+  struct fmt_settings styles;
+  double small;
 
   enum settings_output_devices output_routing[SETTINGS_N_OUTPUT_TYPES];
 
-  enum settings_var_style var_output_style;
-  enum settings_value_style value_output_style;
+  enum settings_value_show show_values;
+  enum settings_value_show show_variables;
 };
 
 static struct settings the_settings = {
-  INTEGER_NATIVE,               /* input_integer_format */
-  FLOAT_NATIVE_DOUBLE,          /* input_float_format */
-  INTEGER_NATIVE,               /* output_integer_format */
-  FLOAT_NATIVE_DOUBLE,          /* output_float_format */
-  24,                           /* viewlength */
-  79,                           /* viewwidth */
-  false,                        /* safer_mode */
-  true,                         /* include */
-  -1,                           /* epoch */
-  true,                         /* route_errors_to_terminal */
-  true,                         /* route_errors_to_listing */
-  true,                         /* scompress */
-  true,                         /* undefined */
-  SYSMIS,                       /* blanks */
-
-  /* max_messages */
-  {
-    100,                        /* MSG_S_ERROR */
-    100,                        /* MSG_S_WARNING */
-    100                         /* MSG_S_NOTE */
+  .input_integer_format = INTEGER_NATIVE,
+  .input_float_format = FLOAT_NATIVE_DOUBLE,
+  .output_integer_format = INTEGER_NATIVE,
+  .output_float_format = FLOAT_NATIVE_DOUBLE,
+  .mdisplay = SETTINGS_MDISPLAY_TEXT,
+  .viewlength = 24,
+  .viewwidth = 79,
+  .safer_mode = false,
+  .include = true,
+  .route_errors_to_terminal = true,
+  .route_errors_to_listing = true,
+  .scompress = true,
+  .undefined = true,
+  .blanks = SYSMIS,
+
+  .max_messages = {
+    [MSG_S_ERROR] = 100,
+    [MSG_S_WARNING] = 100,
+    [MSG_S_NOTE] = 100
   },
 
-  true,                         /* printback */
-  true,                         /* mprint */
-  40,                           /* mxloops */
-  64L * 1024 * 1024,            /* workspace */
-  {FMT_F, 8, 2},                /* default_format */
-  false,                        /* testing_mode */
-  6,                            /* fuzzbits */
-  ENHANCED,                     /* cmd_algorithm */
-  ENHANCED,                     /* global_algorithm */
-  ENHANCED,                     /* syntax */
-  NULL,                         /* styles */
+  .printback = true,
+
+  .mexpand = true,
+  .mprint = false,
+  .miterate = 1000,
+  .mnest = 50,
+
+  .mxloops = 40,
+  .workspace = 64L * 1024 * 1024,
+  .default_format = { .type = FMT_F, .w = 8, .d = 2 },
+  .testing_mode = false,
+  .fuzzbits = 6,
+  .scalemin = 24,
+  .cmd_algorithm = ENHANCED,
+  .global_algorithm = ENHANCED,
+  .syntax = ENHANCED,
+  .styles = FMT_SETTINGS_INIT,
+  .small = .0001,
 
   /* output_routing */
-  {SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL,
-   SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL,
-   0,
-   SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL},
+  .output_routing = {
+#define LT (SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL)
+    [SETTINGS_OUTPUT_ERROR] = LT,
+    [SETTINGS_OUTPUT_NOTE] = LT,
+    [SETTINGS_OUTPUT_SYNTAX] = 0,
+    [SETTINGS_OUTPUT_RESULT] = LT
+#undef LT
+  },
 
-  SETTINGS_VAR_STYLE_LABELS,
-  SETTINGS_VAL_STYLE_LABELS
+  .show_values = SETTINGS_VALUE_SHOW_LABEL,
+  .show_variables = SETTINGS_VALUE_SHOW_LABEL,
 };
 
 /* Initializes the settings module. */
 void
 settings_init (void)
 {
-  settings_set_epoch (-1);
-  the_settings.styles = fmt_settings_create ();
-
   settings_set_decimal_char (get_system_decimal ());
 }
 
@@ -146,7 +162,7 @@ static void
 settings_copy (struct settings *dst, const struct settings *src)
 {
   *dst = *src;
-  dst->styles = fmt_settings_clone (src->styles);
+  dst->styles = fmt_settings_copy (&src->styles);
 }
 
 /* Returns a copy of the current settings. */
@@ -173,7 +189,7 @@ settings_destroy (struct settings *s)
 {
   if (s != NULL)
     {
-      fmt_settings_destroy (s->styles);
+      fmt_settings_uninit (&s->styles);
       if (s != &the_settings)
         free (s);
     }
@@ -190,7 +206,7 @@ settings_get_input_float_format (void)
 /* Sets the floating-point format used for RB and RBHEX input to
    FORMAT. */
 void
-settings_set_input_float_format ( enum float_format format)
+settings_set_input_float_format (enum float_format format)
 {
   the_settings.input_float_format = format;
 }
@@ -205,7 +221,7 @@ 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 format)
+settings_set_input_integer_format (enum integer_format format)
 {
   the_settings.input_integer_format = format;
 }
@@ -234,7 +250,7 @@ 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)
+settings_set_output_float_format (enum float_format float_format)
 {
   the_settings.output_float_format = float_format;
 }
@@ -248,7 +264,7 @@ settings_get_viewlength (void)
 
 /* Sets the view length. */
 void
-settings_set_viewlength ( int viewlength_)
+settings_set_viewlength (int viewlength_)
 {
   the_settings.viewlength = viewlength_;
 }
@@ -262,7 +278,7 @@ settings_get_viewwidth(void)
 
 /* Sets the screen width. */
 void
-settings_set_viewwidth ( int viewwidth_)
+settings_set_viewwidth (int viewwidth_)
 {
   the_settings.viewwidth = viewwidth_;
 }
@@ -290,33 +306,23 @@ settings_get_include (void)
 
 /* Set include file echo. */
 void
-settings_set_include ( bool include)
+settings_set_include (bool include)
 {
   the_settings.include = include;
 }
 
-/* What year to use as the start of the epoch. */
+/* Returns the year that starts the epoch. */
 int
 settings_get_epoch (void)
 {
-  assert (the_settings.epoch >= 0);
-
-  return the_settings.epoch;
+  return the_settings.styles.epoch;
 }
 
 /* Sets the year that starts the epoch. */
 void
-settings_set_epoch ( int epoch)
+settings_set_epoch (int epoch)
 {
-  if (epoch < 0)
-    {
-      time_t t = time (0);
-      struct tm *tm = localtime (&t);
-      epoch = (tm != NULL ? tm->tm_year + 1900 : 2000) - 69;
-    }
-
-  the_settings.epoch = epoch;
-  assert (the_settings.epoch >= 0);
+  the_settings.styles.epoch = epoch;
 }
 
 /* Compress system files by default? */
@@ -328,7 +334,7 @@ settings_get_scompression (void)
 
 /* Set system file default compression. */
 void
-settings_set_scompression ( bool scompress)
+settings_set_scompression (bool scompress)
 {
   the_settings.scompress = scompress;
 }
@@ -342,7 +348,7 @@ settings_get_undefined (void)
 
 /* Set whether to warn on undefined values. */
 void
-settings_set_undefined ( bool undefined)
+settings_set_undefined (bool undefined)
 {
   the_settings.undefined = undefined;
 }
@@ -357,7 +363,7 @@ settings_get_blanks (void)
 /* Set the value that blank numeric fields are set to when read
    in. */
 void
-settings_set_blanks ( double blanks)
+settings_set_blanks (double blanks)
 {
   the_settings.blanks = blanks;
 }
@@ -385,13 +391,13 @@ settings_set_max_messages (enum msg_severity severity, int max)
 
   if (severity == MSG_S_WARNING)
     {
-      if ( max == 0)
+      if (max == 0)
        {
          msg (MW,
               _("MXWARNS set to zero.  No further warnings will be given even when potentially problematic situations are encountered."));
          msg_ui_disable_warnings (true);
        }
-      else if ( the_settings.max_messages [MSG_S_WARNING] == 0)
+      else if (the_settings.max_messages [MSG_S_WARNING] == 0)
        {
          msg_ui_disable_warnings (false);
          the_settings.max_messages[MSG_S_WARNING] = max;
@@ -402,6 +408,20 @@ settings_set_max_messages (enum msg_severity severity, int max)
   the_settings.max_messages[severity] = max;
 }
 
+/* Returns whether to expand macro invocations. */
+bool
+settings_get_mexpand (void)
+{
+  return the_settings.mexpand;
+}
+
+/* Sets whether to expand macro invocations. */
+void
+settings_set_mexpand (bool mexpand)
+{
+  the_settings.mexpand = mexpand;
+}
+
 /* Independent of get_printback, controls whether the commands
    generated by macro invocations are displayed. */
 bool
@@ -413,11 +433,40 @@ settings_get_mprint (void)
 /* Sets whether the commands generated by macro invocations are
    displayed. */
 void
-settings_set_mprint ( bool mprint)
+settings_set_mprint (bool mprint)
 {
   the_settings.mprint = mprint;
 }
 
+/* Returns the limit for loop iterations within a macro. */
+int
+settings_get_miterate (void)
+{
+  return the_settings.miterate;
+}
+
+/* Sets the limit for loop iterations within a macro. */
+void
+settings_set_miterate (int miterate)
+{
+  the_settings.miterate = miterate;
+}
+
+/* Returns the limit for recursion macro expansions. */
+int settings_get_mnest (void)
+{
+  return the_settings.mnest;
+}
+
+/* Sets the limit for recursion macro expansions. */
+void
+settings_set_mnest (int mnest)
+{
+  the_settings.mnest = mnest;
+}
+
+int settings_get_mxloops (void);
+void settings_set_mxloops (int);
 /* Implied limit of unbounded loop. */
 int
 settings_get_mxloops (void)
@@ -427,7 +476,7 @@ settings_get_mxloops (void)
 
 /* Set implied limit of unbounded loop. */
 void
-settings_set_mxloops ( int mxloops)
+settings_set_mxloops (int mxloops)
 {
   the_settings.mxloops = mxloops;
 }
@@ -469,7 +518,7 @@ settings_get_format (void)
 /* Set default format for variables created by transformations
    and by DATA LIST {FREE,LIST}. */
 void
-settings_set_format ( const struct fmt_spec *default_format)
+settings_set_format (const struct fmt_spec *default_format)
 {
   the_settings.default_format = *default_format;
 }
@@ -484,7 +533,7 @@ settings_get_testing_mode (void)
 
 /* Set testing mode. */
 void
-settings_set_testing_mode ( bool testing_mode)
+settings_set_testing_mode (bool testing_mode)
 {
   the_settings.testing_mode = testing_mode;
 }
@@ -501,6 +550,18 @@ settings_set_fuzzbits (int fuzzbits)
   the_settings.fuzzbits = fuzzbits;
 }
 
+int
+settings_get_scalemin (void)
+{
+  return the_settings.scalemin;
+}
+
+void
+settings_set_scalemin (int scalemin)
+{
+  the_settings.scalemin = scalemin;
+}
+
 /* Return the current algorithm setting */
 enum behavior_mode
 settings_get_algorithm (void)
@@ -517,7 +578,7 @@ settings_set_algorithm (enum behavior_mode mode)
 
 /* Set the algorithm option for this command only */
 void
-settings_set_cmd_algorithm ( enum behavior_mode mode)
+settings_set_cmd_algorithm (enum behavior_mode mode)
 {
   the_settings.cmd_algorithm = mode;
 }
@@ -538,82 +599,19 @@ settings_get_syntax (void)
 
 /* Set the syntax option */
 void
-settings_set_syntax ( enum behavior_mode mode)
+settings_set_syntax (enum behavior_mode mode)
 {
   the_settings.syntax = mode;
 }
 
 \f
-
-/* Find the grouping characters in CC_STRING and sets *GROUPING and *DECIMAL
-   appropriately.  Returns true if successful, false otherwise. */
-static bool
-find_cc_separators (const char *cc_string, char *decimal, char *grouping)
-{
-  const char *sp;
-  int comma_cnt, dot_cnt;
-
-  /* Count commas and periods.  There must be exactly three of
-     one or the other, except that an apostrophe escapes a
-     following comma or period. */
-  comma_cnt = dot_cnt = 0;
-  for (sp = cc_string; *sp; sp++)
-    if (*sp == ',')
-      comma_cnt++;
-    else if (*sp == '.')
-      dot_cnt++;
-    else if (*sp == '\'' && (sp[1] == '.' || sp[1] == ',' || sp[1] == '\''))
-      sp++;
-
-  if ((comma_cnt == 3) == (dot_cnt == 3))
-    return false;
-
-  if (comma_cnt == 3)
-    {
-      *decimal = '.';
-      *grouping = ',';
-    }
-  else
-    {
-      *decimal = ',';
-      *grouping = '.';
-    }
-  return true;
-}
-
-/* Extracts a token from IN into a newly allocated string AFFIXP.  Tokens are
-   delimited by GROUPING.  Returns the first character following the token. */
-static const char *
-extract_cc_token (const char *in, int grouping, char **affixp)
-{
-  char *out;
-
-  out = *affixp = xmalloc (strlen (in) + 1);
-  for (; *in != '\0' && *in != grouping; in++)
-    {
-      if (*in == '\'' && in[1] == grouping)
-        in++;
-      *out++ = *in;
-    }
-  *out = '\0';
-
-  if (*in == grouping)
-    in++;
-  return in;
-}
-
 /* Sets custom currency specifier CC having name CC_NAME ('A' through
    'E') to correspond to the settings in CC_STRING. */
 bool
 settings_set_cc (const char *cc_string, enum fmt_type type)
 {
-  char *neg_prefix, *prefix, *suffix, *neg_suffix;
-  char decimal, grouping;
-
-  assert (fmt_get_category (type) == FMT_CAT_CUSTOM);
-
-  /* Determine separators. */
-  if (!find_cc_separators (cc_string, &decimal, &grouping))
+  struct fmt_number_style *style = fmt_number_style_from_string (cc_string);
+  if (!style)
     {
       msg (SE, _("%s: Custom currency string `%s' does not contain "
                  "exactly three periods or commas (or it contains both)."),
@@ -621,42 +619,38 @@ settings_set_cc (const char *cc_string, enum fmt_type type)
       return false;
     }
 
-  cc_string = extract_cc_token (cc_string, grouping, &neg_prefix);
-  cc_string = extract_cc_token (cc_string, grouping, &prefix);
-  cc_string = extract_cc_token (cc_string, grouping, &suffix);
-  cc_string = extract_cc_token (cc_string, grouping, &neg_suffix);
-
-  fmt_settings_set_style (the_settings.styles, type, decimal, grouping,
-                          neg_prefix, prefix, suffix, neg_suffix);
-
-  free (neg_suffix);
-  free (suffix);
-  free (prefix);
-  free (neg_prefix);
-
+  fmt_settings_set_cc (&the_settings.styles, type, style);
   return true;
 }
 
-/* Returns the decimal point character for TYPE. */
-int
-settings_get_decimal_char (enum fmt_type type)
+void
+settings_set_decimal_char (char decimal)
 {
-  return fmt_settings_get_style (the_settings.styles, type)->decimal;
+  the_settings.styles.decimal = decimal;
 }
 
 void
-settings_set_decimal_char (char decimal)
+settings_set_include_leading_zero (bool include_leading_zero)
 {
-  fmt_settings_set_decimal (the_settings.styles, decimal);
+  the_settings.styles.include_leading_zero = include_leading_zero;
 }
 
-/* Returns the number formatting style associated with the given
-   format TYPE. */
-const struct fmt_number_style *
-settings_get_style (enum fmt_type type)
+const struct fmt_settings *
+settings_get_fmt_settings (void)
+{
+  return &the_settings.styles;
+}
+
+double
+settings_get_small (void)
 {
-  assert (is_fmt_type (type));
-  return fmt_settings_get_style (the_settings.styles, type);
+  return the_settings.small;
+}
+
+void
+settings_set_small (double small)
+{
+  the_settings.small = small;
 }
 
 /* Returns a string of the form "$#,###.##" according to FMT,
@@ -671,10 +665,10 @@ settings_dollar_template (const struct fmt_spec *fmt)
 
   assert (fmt->type == FMT_DOLLAR);
 
-  fns = fmt_settings_get_style (the_settings.styles, fmt->type);
+  fns = fmt_settings_get_style (&the_settings.styles, fmt->type);
 
   ds_put_byte (&str, '$');
-  for (c = MAX (fmt->w - fmt->d - 1, 0); c > 0; )
+  for (c = MAX (fmt->w - fmt->d - 1, 0); c > 0;)
     {
       ds_put_byte (&str, '#');
       if (--c % 4 == 0 && c > 0)
@@ -707,29 +701,39 @@ settings_get_output_routing (enum settings_output_type type)
   return the_settings.output_routing[type] | SETTINGS_DEVICE_UNFILTERED;
 }
 
-enum settings_value_style
-settings_get_value_style (void)
+enum settings_value_show
+settings_get_show_values (void)
 {
-  return the_settings.value_output_style;
+  return the_settings.show_values;
 }
 
 void
-settings_set_value_style (enum settings_value_style s)
+settings_set_show_values (enum settings_value_show s)
 {
-  the_settings.value_output_style = s;
+  the_settings.show_values = s;
 }
 
 
+enum settings_value_show
+settings_get_show_variables (void)
+{
+  return the_settings.show_variables;
+}
 
-enum settings_var_style
-settings_get_var_style (void)
+void
+settings_set_show_variables (enum settings_value_show s)
 {
-  return the_settings.var_output_style;
+  the_settings.show_variables = s;
 }
 
+enum settings_mdisplay
+settings_get_mdisplay (void)
+{
+  return the_settings.mdisplay;
+}
 
 void
-settings_set_var_style (enum settings_var_style s)
+settings_set_mdisplay (enum settings_mdisplay mdisplay)
 {
-  the_settings.var_output_style = s;
+  the_settings.mdisplay = mdisplay;
 }