format: Optimize fmt_from_io().
[pspp] / src / data / format.c
index c90ff95b6f5fc51a486b58cd1f10c6ce2ce07220..3907016cf4dac66ba021694b175e96ef67b2761a 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2006, 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
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-static bool is_fmt_type (enum fmt_type);
 
-static int min_width (enum fmt_type, bool for_input);
-static int max_width (enum fmt_type);
+
+bool is_fmt_type (enum fmt_type);
+
 static bool valid_width (enum fmt_type, int width, bool for_input);
-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,
@@ -126,7 +133,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;
@@ -244,8 +253,8 @@ fmt_check (const struct fmt_spec *spec, bool for_input)
       return false;
     }
 
-  min_w = min_width (spec->type, for_input);
-  max_w = max_width (spec->type);
+  min_w = fmt_min_width (spec->type, for_input);
+  max_w = fmt_max_width (spec->type, for_input);
   if (spec->w < min_w || spec->w > max_w)
     {
       msg (SE, _("%s %s specifies width %d, but "
@@ -254,7 +263,7 @@ fmt_check (const struct fmt_spec *spec, bool for_input)
       return false;
     }
 
-  max_d = max_decimals (spec->type, spec->w, for_input);
+  max_d = fmt_max_decimals (spec->type, spec->w, for_input);
   if (!fmt_takes_decimals (spec->type) && spec->d != 0)
     {
       msg (SE, ngettext ("%s %s specifies %d decimal place, but "
@@ -380,7 +389,7 @@ fmt_equal (const struct fmt_spec *a, const struct fmt_spec *b)
 
 /* Adjusts FMT to be valid for a value of the given WIDTH. */
 void
-fmt_resize (struct fmt_spec *fmt, int width) 
+fmt_resize (struct fmt_spec *fmt, int width)
 {
   if ((width > 0) != fmt_is_string (fmt->type))
     {
@@ -394,11 +403,66 @@ fmt_resize (struct fmt_spec *fmt, int width)
          width. */
       fmt->w = fmt->type == FMT_AHEX ? width * 2 : width;
     }
-  else 
+  else
     {
       /* Still numeric. */
     }
 }
+
+/* Adjusts FMT's width and decimal places to be valid for an
+   input format (if FOR_INPUT) or an output format (if
+   !FOR_INPUT).  */
+void
+fmt_fix (struct fmt_spec *fmt, bool for_input)
+{
+  int min_w, max_w;
+  int max_d;
+
+  /* Clamp width to those allowed by format. */
+  min_w = fmt_min_width (fmt->type, for_input);
+  max_w = fmt_max_width (fmt->type, for_input);
+  if (fmt->w < min_w)
+    fmt->w = min_w;
+  else if (fmt->w > max_w)
+    fmt->w = max_w;
+
+  /* First, if FMT has more decimal places than allowed, attempt
+     to increase FMT's width until that number of decimal places
+     can be achieved. */
+  if (fmt->d > fmt_max_decimals (fmt->type, fmt->w, for_input))
+    {
+      int w;
+      for (w = fmt->w; w <= max_w; w++)
+        if (fmt_max_decimals (fmt->type, w, for_input) >= fmt->d)
+          {
+            fmt->w = w;
+            break;
+          }
+    }
+
+  /* Clamp decimals to those allowed by format and width. */
+  max_d = fmt_max_decimals (fmt->type, fmt->w, for_input);
+  if (fmt->d < 0)
+    fmt->d = 0;
+  else if (fmt->d > max_d)
+    fmt->d = max_d;
+}
+
+/* Adjusts FMT's width and decimal places to be valid for an
+   input format.  */
+void
+fmt_fix_input (struct fmt_spec *fmt)
+{
+  fmt_fix (fmt, true);
+}
+
+/* Adjusts FMT's width and decimal places to be valid for an
+   output format.  */
+void
+fmt_fix_output (struct fmt_spec *fmt)
+{
+  fmt_fix (fmt, false);
+}
 \f
 /* Describes a display format. */
 struct fmt_desc
@@ -443,6 +507,151 @@ fmt_takes_decimals (enum fmt_type type)
   return fmt_max_output_decimals (type, fmt_max_output_width (type)) > 0;
 }
 
+/* Returns the minimum width of the given format TYPE,
+   for input if FOR_INPUT is true,
+   for output otherwise. */
+int
+fmt_min_width (enum fmt_type type, bool for_input)
+{
+  return for_input ? fmt_min_input_width (type) : fmt_min_output_width (type);
+}
+
+/* Returns the maximum width of the given format TYPE,
+   for input if FOR_INPUT is true,
+   for output otherwise. */
+int
+fmt_max_width (enum fmt_type type, bool for_input UNUSED)
+{
+  /* Maximum width is actually invariant of whether the format is
+     for input or output, so FOR_INPUT is unused. */
+  assert (is_fmt_type (type));
+  switch (type)
+    {
+    case FMT_P:
+    case FMT_PK:
+    case FMT_PIBHEX:
+    case FMT_RBHEX:
+      return 16;
+
+    case FMT_IB:
+    case FMT_PIB:
+    case FMT_RB:
+      return 8;
+
+    case FMT_A:
+      return MAX_STRING;
+
+    case FMT_AHEX:
+      return 2 * MAX_STRING;
+
+    default:
+      return 40;
+    }
+}
+
+/* Returns the maximum number of decimal places allowed for the
+   given format TYPE with a width of WIDTH places,
+   for input if FOR_INPUT is true,
+   for output otherwise. */
+int
+fmt_max_decimals (enum fmt_type type, int width, bool for_input)
+{
+  int max_d;
+
+  switch (type)
+    {
+    case FMT_F:
+    case FMT_COMMA:
+    case FMT_DOT:
+      max_d = for_input ? width : width - 1;
+      break;
+
+    case FMT_DOLLAR:
+    case FMT_PCT:
+      max_d = for_input ? width : width - 2;
+      break;
+
+    case FMT_E:
+      max_d = for_input ? width : width - 7;
+      break;
+
+    case FMT_CCA:
+    case FMT_CCB:
+    case FMT_CCC:
+    case FMT_CCD:
+    case FMT_CCE:
+      assert (!for_input);
+      max_d = width - 1;
+      break;
+
+    case FMT_N:
+    case FMT_Z:
+      max_d = width;
+      break;
+
+    case FMT_P:
+      max_d = width * 2 - 1;
+      break;
+
+    case FMT_PK:
+      max_d = width * 2;
+      break;
+
+    case FMT_IB:
+    case FMT_PIB:
+      max_d = max_digits_for_bytes (width);
+      break;
+
+    case FMT_PIBHEX:
+      max_d = 0;
+      break;
+
+    case FMT_RB:
+    case FMT_RBHEX:
+      max_d = 16;
+      break;
+
+    case FMT_DATE:
+    case FMT_ADATE:
+    case FMT_EDATE:
+    case FMT_JDATE:
+    case FMT_SDATE:
+    case FMT_QYR:
+    case FMT_MOYR:
+    case FMT_WKYR:
+      max_d = 0;
+      break;
+
+    case FMT_DATETIME:
+      max_d = width - 21;
+      break;
+
+    case FMT_TIME:
+      max_d = width - 9;
+      break;
+
+    case FMT_DTIME:
+      max_d = width - 12;
+      break;
+
+    case FMT_WKDAY:
+    case FMT_MONTH:
+    case FMT_A:
+    case FMT_AHEX:
+      max_d = 0;
+      break;
+
+    default:
+      NOT_REACHED ();
+    }
+
+  if (max_d < 0)
+    max_d = 0;
+  else if (max_d > 16)
+    max_d = 16;
+  return max_d;
+}
+
 /* Returns the minimum acceptable width for an input field
    formatted with the given TYPE. */
 int
@@ -456,7 +665,7 @@ fmt_min_input_width (enum fmt_type type)
 int
 fmt_max_input_width (enum fmt_type type)
 {
-  return max_width (type);
+  return fmt_max_width (type, true);
 }
 
 /* Returns the maximum number of decimal places allowed in an
@@ -465,7 +674,7 @@ int
 fmt_max_input_decimals (enum fmt_type type, int width)
 {
   assert (valid_width (type, width, true));
-  return max_decimals (type, width, true);
+  return fmt_max_decimals (type, width, true);
 }
 
 /* Returns the minimum acceptable width for an output field
@@ -481,7 +690,7 @@ fmt_min_output_width (enum fmt_type type)
 int
 fmt_max_output_width (enum fmt_type type)
 {
-  return max_width (type);
+  return fmt_max_width (type, false);
 }
 
 /* Returns the maximum number of decimal places allowed in an
@@ -490,7 +699,7 @@ int
 fmt_max_output_decimals (enum fmt_type type, int width)
 {
   assert (valid_width (type, width, false));
-  return max_decimals (type, width, false);
+  return fmt_max_decimals (type, width, false);
 }
 
 /* Returns the width step for a field formatted with the given
@@ -563,15 +772,16 @@ fmt_to_io (enum fmt_type type)
 bool
 fmt_from_io (int io, enum fmt_type *fmt_type)
 {
-  enum fmt_type type;
-
-  for (type = 0; type < FMT_NUMBER_OF_FORMATS; type++)
-    if (get_fmt_desc (type)->io == io)
-      {
-        *fmt_type = type;
-        return true;
-      }
-  return false;
+  switch (io)
+    {
+#define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY)     \
+    case IO:                                          \
+      *fmt_type = FMT_##NAME;                           \
+      return true;
+#include "format.def"
+    default:
+      return false;
+    }
 }
 
 /* Returns true if TYPE may be used as an input format,
@@ -617,83 +827,15 @@ fmt_date_template (enum fmt_type type)
     }
 }
 
-/* Returns a string of the form "$#,###.##" according to FMT,
-   which must be of type FMT_DOLLAR.  The caller must free the
-   string. */
-char *
-fmt_dollar_template (const struct fmt_spec *fmt)
-{
-  struct string s = DS_EMPTY_INITIALIZER;
-  int c;
-
-  assert (fmt->type == FMT_DOLLAR);
-
-  ds_put_char (&s, '$');
-  for (c = MAX (fmt->w - fmt->d - 1, 0); c > 0; )
-    {
-      ds_put_char (&s, '#');
-      if (--c % 4 == 0 && c > 0)
-        {
-          ds_put_char (&s, fmt_grouping_char (fmt->type));
-          --c;
-        }
-    }
-  if (fmt->d > 0)
-    {
-      ds_put_char (&s, fmt_decimal_char (fmt->type));
-      ds_put_char_multiple (&s, '#', fmt->d);
-    }
-
-  return ds_cstr (&s);
-}
 \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;
 }
 
-/* Returns the minimum width of the given format TYPE,
-   for input if FOR_INPUT is true,
-   for output otherwise. */
-static int
-min_width (enum fmt_type type, bool for_input)
-{
-  return for_input ? fmt_min_input_width (type) : fmt_min_output_width (type);
-}
-
-/* Returns the maximum width of the given format TYPE,
-   which is invariant between input and output. */
-static int
-max_width (enum fmt_type type)
-{
-  assert (is_fmt_type (type));
-  switch (type)
-    {
-    case FMT_P:
-    case FMT_PK:
-    case FMT_PIBHEX:
-    case FMT_RBHEX:
-      return 16;
-
-    case FMT_IB:
-    case FMT_PIB:
-    case FMT_RB:
-      return 8;
-
-    case FMT_A:
-      return MAX_STRING;
-
-    case FMT_AHEX:
-      return 2 * MAX_STRING;
-
-    default:
-      return 40;
-    }
-}
-
 /* Returns true if WIDTH is a valid width for the given format
    TYPE,
    for input if FOR_INPUT is true,
@@ -701,111 +843,8 @@ max_width (enum fmt_type type)
 static bool
 valid_width (enum fmt_type type, int width, bool for_input)
 {
-  return (width >= min_width (type, for_input)
-          && width <= max_width (type));
-}
-
-/* Returns the maximum number of decimal places allowed for the
-   given format TYPE with a width of WIDTH places,
-   for input if FOR_INPUT is true,
-   for output otherwise. */
-static int
-max_decimals (enum fmt_type type, int width, bool for_input)
-{
-  int max_d;
-
-  switch (type)
-    {
-    case FMT_F:
-    case FMT_COMMA:
-    case FMT_DOT:
-      max_d = for_input ? width : width - 1;
-      break;
-
-    case FMT_DOLLAR:
-    case FMT_PCT:
-      max_d = for_input ? width : width - 2;
-      break;
-
-    case FMT_E:
-      max_d = for_input ? width : width - 7;
-      break;
-
-    case FMT_CCA:
-    case FMT_CCB:
-    case FMT_CCC:
-    case FMT_CCD:
-    case FMT_CCE:
-      assert (!for_input);
-      max_d = width - 1;
-      break;
-
-    case FMT_N:
-    case FMT_Z:
-      max_d = width;
-      break;
-
-    case FMT_P:
-      max_d = width * 2 - 1;
-      break;
-
-    case FMT_PK:
-      max_d = width * 2;
-      break;
-
-    case FMT_IB:
-    case FMT_PIB:
-      max_d = max_digits_for_bytes (width);
-      break;
-
-    case FMT_PIBHEX:
-      max_d = 0;
-      break;
-
-    case FMT_RB:
-    case FMT_RBHEX:
-      max_d = 16;
-      break;
-
-    case FMT_DATE:
-    case FMT_ADATE:
-    case FMT_EDATE:
-    case FMT_JDATE:
-    case FMT_SDATE:
-    case FMT_QYR:
-    case FMT_MOYR:
-    case FMT_WKYR:
-      max_d = 0;
-      break;
-
-    case FMT_DATETIME:
-      max_d = width - 21;
-      break;
-
-    case FMT_TIME:
-      max_d = width - 9;
-      break;
-
-    case FMT_DTIME:
-      max_d = width - 12;
-      break;
-
-    case FMT_WKDAY:
-    case FMT_MONTH:
-    case FMT_A:
-    case FMT_AHEX:
-      max_d = 0;
-      break;
-
-    default:
-      NOT_REACHED ();
-    }
-
-  if (max_d < 0)
-    max_d = 0;
-  else if (max_d > 16)
-    max_d = 16;
-  return max_d;
+  return (width >= fmt_min_width (type, for_input)
+          && width <= fmt_max_width (type, for_input));
 }
 
 /* Returns the maximum number of decimal digits in an unsigned
@@ -819,21 +858,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)
@@ -844,24 +881,22 @@ 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);
@@ -871,14 +906,9 @@ fmt_set_style (enum fmt_type type, struct fmt_number_style *style)
   assert (style->grouping == '.' || style->grouping == ','
           || style->grouping == 0);
   assert (style->grouping != style->decimal);
-
-  assert (fmt_get_category (type) == FMT_CAT_CUSTOM);
-  assert (styles[type] != NULL);
-
-  fmt_number_style_destroy (styles[type]);
-  styles[type] = style;
 }
 
+
 /* Returns the total width of the standard prefix and suffix for
    STYLE. */
 int
@@ -895,28 +925,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)
 {
@@ -924,9 +939,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));
@@ -934,37 +950,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);
+  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. */
@@ -981,3 +979,5 @@ get_fmt_desc (enum fmt_type type)
   assert (is_fmt_type (type));
   return &formats[type];
 }
+
+const struct fmt_spec F_8_0 = {FMT_F, 8, 0};