Reworked settings so as to use one large struct instead of lots of static
[pspp-builds.git] / src / data / format.c
index e236aa310019030b29c4e0aafaedaef300eff894..d7368fe23e4c46d96d7ab08c0e40863a0b382518 100644 (file)
@@ -1,21 +1,18 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
 
-   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/>. */
 
 #include <config.h>
 
@@ -26,6 +23,7 @@
 
 #include <data/identifier.h>
 #include <data/settings.h>
+#include <data/value.h>
 #include <data/variable.h>
 #include <libpspp/assertion.h>
 #include <libpspp/compiler.h>
@@ -39,7 +37,9 @@
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-static bool is_fmt_type (enum fmt_type);
+
+
+bool is_fmt_type (enum fmt_type);
 
 static int min_width (enum fmt_type, bool for_input);
 static int max_width (enum fmt_type);
@@ -48,27 +48,35 @@ static int max_decimals (enum fmt_type, int width, bool for_input);
 
 static int max_digits_for_bytes (int bytes);
 
+void fmt_number_style_init (struct fmt_number_style *style);
+
+
 /* Initialize the format module. */
-void
-fmt_init (void)
+struct fmt_number_style *
+fmt_create (void)
 {
-  static bool inited = false;
-  if (!inited)
-    {
-      inited = true;
-      fmt_set_decimal ('.');
-    }
+  struct fmt_number_style *styles =
+    xcalloc (FMT_NUMBER_OF_FORMATS, sizeof (*styles));
+
+  int t;
+  for (t = 0 ; t < FMT_NUMBER_OF_FORMATS ; ++t )
+    fmt_number_style_init (&styles[t]);
+
+  fmt_set_decimal (styles, '.');
+
+  return styles;
 }
 
-static struct fmt_number_style *styles[FMT_NUMBER_OF_FORMATS];
 
 /* Deinitialize the format module. */
 void
-fmt_done (void)
+fmt_done (struct fmt_number_style *styles)
 {
   int t;
   for (t = 0 ; t < FMT_NUMBER_OF_FORMATS ; ++t )
-         fmt_number_style_destroy (styles[t]);
+    fmt_number_style_destroy (&styles[t]);
+
+  free (styles);
 }
 
 /* Returns an input format specification with type TYPE, width W,
@@ -128,7 +136,9 @@ fmt_for_output_from_input (const struct fmt_spec *input)
     case FMT_DOLLAR:
     case FMT_PCT:
       {
-        const struct fmt_number_style *style = fmt_get_style (input->type);
+        const struct fmt_number_style *style =
+         settings_get_style (input->type);
+
         output.w += fmt_affix_width (style);
         if (style->grouping != 0 && input->w - input->d >= 3)
           output.w += (input->w - input->d - 1) / 3;
@@ -209,6 +219,16 @@ fmt_for_output_from_input (const struct fmt_spec *input)
   return output;
 }
 
+/* Returns the default format for the given WIDTH: F8.2 format
+   for a numeric value, A format for a string value. */
+struct fmt_spec
+fmt_default_for_width (int width)
+{
+  return (width == 0
+          ? fmt_for_output (FMT_F, 8, 2)
+          : fmt_for_output (FMT_A, width, 0));
+}
+
 /* Checks whether SPEC is valid as an input format (if FOR_INPUT)
    or an output format (otherwise) and returns nonzero if so.
    Otherwise, emits an error message and returns zero. */
@@ -297,18 +317,18 @@ fmt_check_output (const struct fmt_spec *spec)
 }
 
 /* Checks that FORMAT is appropriate for a variable of the given
-   TYPE and returns true if so.  Otherwise returns false and
+   VAR_TYPE and returns true if so.  Otherwise returns false and
    emits an error message. */
 bool
-fmt_check_type_compat (const struct fmt_spec *format, int var_type)
+fmt_check_type_compat (const struct fmt_spec *format, enum val_type var_type)
 {
-  assert (var_type == NUMERIC || var_type == ALPHA);
-  if ((var_type == ALPHA) != (fmt_is_string (format->type) != 0))
+  assert (val_type_is_valid (var_type));
+  if ((var_type == VAL_STRING) != (fmt_is_string (format->type) != 0))
     {
       char str[FMT_STRING_LEN_MAX + 1];
       msg (SE, _("%s variables are not compatible with %s format %s."),
-           var_type == ALPHA ? _("String") : _("Numeric"),
-           var_type == ALPHA ? _("numeric") : _("string"),
+           var_type == VAL_STRING ? _("String") : _("Numeric"),
+           var_type == VAL_STRING ? _("numeric") : _("string"),
            fmt_to_string (format, str));
       return false;
     }
@@ -321,7 +341,7 @@ fmt_check_type_compat (const struct fmt_spec *format, int var_type)
 bool
 fmt_check_width_compat (const struct fmt_spec *format, int width)
 {
-  if (!fmt_check_type_compat (format, width != 0 ? ALPHA : NUMERIC))
+  if (!fmt_check_type_compat (format, val_type_from_width (width)))
     return false;
   if (fmt_var_width (format) != width)
     {
@@ -334,14 +354,13 @@ fmt_check_width_compat (const struct fmt_spec *format, int width)
   return true;
 }
 
-/* Returns the width corresponding to the format specifier.  The
-   return value is the value of the `width' member of a `struct
-   variable' for such an input format. */
+/* Returns the width corresponding to FORMAT.  The return value
+   is the width of the `union value's required by FORMAT. */
 int
-fmt_var_width (const struct fmt_spec *spec)
+fmt_var_width (const struct fmt_spec *format)
 {
-  return (spec->type == FMT_AHEX ? spec->w / 2
-          : spec->type == FMT_A ? spec->w
+  return (format->type == FMT_AHEX ? format->w / 2
+          : format->type == FMT_A ? format->w
           : 0);
 }
 
@@ -362,6 +381,36 @@ fmt_to_string (const struct fmt_spec *f, char buffer[FMT_STRING_LEN_MAX + 1])
               "%s%d", fmt_name (f->type), f->w);
   return buffer;
 }
+
+/* Returns true if A and B are identical formats,
+   false otherwise. */
+bool
+fmt_equal (const struct fmt_spec *a, const struct fmt_spec *b)
+{
+  return a->type == b->type && a->w == b->w && a->d == b->d;
+}
+
+/* Adjusts FMT to be valid for a value of the given WIDTH. */
+void
+fmt_resize (struct fmt_spec *fmt, int width)
+{
+  if ((width > 0) != fmt_is_string (fmt->type))
+    {
+      /* Changed from numeric to string or vice versa.  Set to
+         default format for new width. */
+      *fmt = fmt_default_for_width (width);
+    }
+  else if (width > 0)
+    {
+      /* Changed width of string.  Preserve format type, adjust
+         width. */
+      fmt->w = fmt->type == FMT_AHEX ? width * 2 : width;
+    }
+  else
+    {
+      /* Still numeric. */
+    }
+}
 \f
 /* Describes a display format. */
 struct fmt_desc
@@ -461,7 +510,8 @@ fmt_max_output_decimals (enum fmt_type type, int width)
 int
 fmt_step_width (enum fmt_type type)
 {
-  return fmt_get_category (type) == FMT_CAT_HEXADECIMAL ? 2 : 1;
+  return (fmt_get_category (type) == FMT_CAT_HEXADECIMAL || type == FMT_AHEX
+          ? 2 : 1);
 }
 
 /* Returns true if TYPE is used for string fields,
@@ -486,7 +536,7 @@ fmt_is_numeric (enum fmt_type type)
    category.  Thus, the return value may be tested for equality
    or compared bitwise against a mask of FMT_CAT_* values. */
 enum fmt_category
-fmt_get_category (enum fmt_type type) 
+fmt_get_category (enum fmt_type type)
 {
   return get_fmt_desc (type)->category;
 }
@@ -496,7 +546,7 @@ fmt_get_category (enum fmt_type type)
 enum fmt_type
 fmt_input_to_output (enum fmt_type type)
 {
-  switch (fmt_get_category (type)) 
+  switch (fmt_get_category (type))
     {
     case FMT_CAT_STRING:
       return FMT_A;
@@ -565,23 +615,24 @@ fmt_date_template (enum fmt_type type)
     case FMT_QYR:
       return "q Q yy";
     case FMT_MOYR:
-      return "mmm yy";
+      return "mmmXyy";
     case FMT_WKYR:
       return "ww WK yy";
     case FMT_DATETIME:
       return "dd-mmm-yyyy HH:MM";
     case FMT_TIME:
-      return "h:MM";
+      return "H:MM";
     case FMT_DTIME:
       return "D HH:MM";
     default:
       NOT_REACHED ();
     }
 }
+
 \f
 /* Returns true if TYPE is a valid format type,
    false otherwise. */
-static bool
+bool
 is_fmt_type (enum fmt_type type)
 {
   return type < FMT_NUMBER_OF_FORMATS;
@@ -751,21 +802,19 @@ max_digits_for_bytes (int bytes)
 }
 \f
 
-/* Creates and returns a new struct fmt_number_style,
-   initializing all affixes to empty strings. */
-struct fmt_number_style *
-fmt_number_style_create (void)
+
+void
+fmt_number_style_init (struct fmt_number_style *style)
 {
-  struct fmt_number_style *style = xmalloc (sizeof *style);
   style->neg_prefix = ss_empty ();
   style->prefix = ss_empty ();
   style->suffix = ss_empty ();
   style->neg_suffix = ss_empty ();
   style->decimal = '.';
   style->grouping = 0;
-  return style;
 }
 
+
 /* Destroys a struct fmt_number_style. */
 void
 fmt_number_style_destroy (struct fmt_number_style *style)
@@ -776,41 +825,34 @@ fmt_number_style_destroy (struct fmt_number_style *style)
       ss_dealloc (&style->prefix);
       ss_dealloc (&style->suffix);
       ss_dealloc (&style->neg_suffix);
-      free (style);
     }
 }
 
 /* Returns the number formatting style associated with the given
    format TYPE. */
 const struct fmt_number_style *
-fmt_get_style (enum fmt_type type)
+fmt_get_style (const struct fmt_number_style *styles, enum fmt_type type)
 {
   assert (is_fmt_type (type));
-  assert (styles[type] != NULL);
-  return styles[type];
+  return &styles[type];
 }
 
-/* Sets STYLE as the number formatting style associated with the
-   given format TYPE, transferring ownership of STYLE.  */
+
+/* Checks that style is STYLE sane */
 void
-fmt_set_style (enum fmt_type type, struct fmt_number_style *style)
+fmt_check_style (const struct fmt_number_style *style)
 {
   assert (ss_length (style->neg_prefix) <= FMT_STYLE_AFFIX_MAX);
   assert (ss_length (style->prefix) <= FMT_STYLE_AFFIX_MAX);
   assert (ss_length (style->suffix) <= FMT_STYLE_AFFIX_MAX);
   assert (ss_length (style->neg_suffix) <= FMT_STYLE_AFFIX_MAX);
   assert (style->decimal == '.' || style->decimal == ',');
-  assert (style->grouping != style->decimal
-          && (style->grouping == '.' || style->grouping == ','
-              || style->grouping == 0));
-
-  assert (fmt_get_category (type) == FMT_CAT_CUSTOM);
-  assert (styles[type] != NULL);
-
-  fmt_number_style_destroy (styles[type]);
-  styles[type] = style;
+  assert (style->grouping == '.' || style->grouping == ','
+          || style->grouping == 0);
+  assert (style->grouping != style->decimal);
 }
 
+
 /* Returns the total width of the standard prefix and suffix for
    STYLE. */
 int
@@ -827,28 +869,13 @@ fmt_neg_affix_width (const struct fmt_number_style *style)
   return ss_length (style->neg_prefix) + ss_length (style->neg_suffix);
 }
 
-/* Returns the decimal point character for the given format
-   TYPE. */
-int
-fmt_decimal_char (enum fmt_type type)
-{
-  return fmt_get_style (type)->decimal;
-}
-
-/* Returns the grouping character for the given format TYPE, or 0
-   if the format type does not group digits. */
-int
-fmt_grouping_char (enum fmt_type type)
-{
-  return fmt_get_style (type)->grouping;
-}
 
 /* Sets the number style for TYPE to have the given standard
    PREFIX and SUFFIX, "-" as prefix suffix, an empty negative
    suffix, DECIMAL as the decimal point character, and GROUPING
    as the grouping character. */
 static void
-set_style (enum fmt_type type,
+set_style (struct fmt_number_style *styles, enum fmt_type type,
            const char *prefix, const char *suffix,
            char decimal, char grouping)
 {
@@ -856,9 +883,10 @@ set_style (enum fmt_type type,
 
   assert (is_fmt_type (type));
 
-  fmt_number_style_destroy (styles[type]);
+  style = &styles[type] ;
+
+  fmt_number_style_destroy (style);
 
-  style = styles[type] = fmt_number_style_create ();
   ss_alloc_substring (&style->neg_prefix, ss_cstr ("-"));
   ss_alloc_substring (&style->prefix, ss_cstr (prefix));
   ss_alloc_substring (&style->suffix, ss_cstr (suffix));
@@ -866,53 +894,19 @@ set_style (enum fmt_type type,
   style->grouping = grouping;
 }
 
-/* Sets the number style for TYPE as with set_style, but only if
-   TYPE has not already been initialized. */
-static void
-init_style (enum fmt_type type,
-            const char *prefix, const char *suffix,
-            char decimal, char grouping)
-{
-  assert (is_fmt_type (type));
-  if (styles[type] == NULL)
-    set_style (type, prefix, suffix, decimal, grouping);
-}
-
 /* Sets the decimal point character to DECIMAL. */
 void
-fmt_set_decimal (char decimal)
+fmt_set_decimal (struct fmt_number_style *styles, char decimal)
 {
   int grouping = decimal == '.' ? ',' : '.';
   assert (decimal == '.' || decimal == ',');
 
-  set_style (FMT_F, "", "", decimal, 0);
-  set_style (FMT_E, "", "", decimal, 0);
-  set_style (FMT_COMMA, "", "", decimal, grouping);
-  set_style (FMT_DOT, "", "", grouping, decimal);
-  set_style (FMT_DOLLAR, "$", "", decimal, grouping);
-  set_style (FMT_PCT, "", "%", decimal, 0);
-
-  init_style (FMT_CCA, "", "", decimal, grouping);
-  init_style (FMT_CCB, "", "", decimal, grouping);
-  init_style (FMT_CCC, "", "", decimal, grouping);
-  init_style (FMT_CCD, "", "", decimal, grouping);
-  init_style (FMT_CCE, "", "", decimal, grouping);
-}
-\f
-/* Returns true if M is a valid variable measurement level,
-   false otherwise. */
-bool
-measure_is_valid (enum measure m)
-{
-  return m > 0 && m < n_MEASURES;
-}
-
-/* Returns true if A is a valid alignment,
-   false otherwise. */
-bool
-alignment_is_valid (enum alignment a)
-{
-  return a < n_ALIGN;
+  set_style (styles, FMT_F, "", "", decimal, 0);
+  set_style (styles, FMT_E, "", "", decimal, 0);
+  set_style (styles, FMT_COMMA, "", "", decimal, grouping);
+  set_style (styles, FMT_DOT, "", "", grouping, decimal);
+  set_style (styles, FMT_DOLLAR, "$", "", decimal, grouping);
+  set_style (styles, FMT_PCT, "", "%", decimal, 0);
 }
 \f
 /* Returns the struct fmt_desc for the given format TYPE. */