placement-parser: Improve error messages for format assignment.
[pspp] / src / language / data-io / placement-parser.c
index 820560df187d347e16d32d51a69b24cf307b1b4c..983bec84929b62fbace8791592ce4ca36d011670 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2006, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2006, 2010, 2011, 2012 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 <config.h>
 
-#include <language/data-io/placement-parser.h>
+#include "language/data-io/placement-parser.h"
 
 #include <assert.h>
 
-#include <language/lexer/format-parser.h>
-#include <language/lexer/lexer.h>
-#include <libpspp/message.h>
-#include <libpspp/pool.h>
-#include <libpspp/str.h>
+#include "data/format.h"
+#include "language/lexer/format-parser.h"
+#include "language/lexer/lexer.h"
+#include "libpspp/message.h"
+#include "libpspp/pool.h"
+#include "libpspp/str.h"
 
-#include <data/format.h>
-
-#include "xalloc.h"
-#include "xsize.h"
+#include "gl/c-strcase.h"
+#include "gl/xalloc.h"
+#include "gl/xsize.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
@@ -43,9 +43,9 @@ enum
     PRS_TYPE_NEW_REC            /* Next record. */
   };
 
-static bool fixed_parse_columns (struct lexer *, struct pool *, size_t var_cnt, bool for_input,
-                                 struct fmt_spec **, size_t *);
-static bool fixed_parse_fortran (struct lexer *l, struct pool *, bool for_input,
+static bool fixed_parse_columns (struct lexer *, struct pool *, size_t n_vars,
+                                 enum fmt_use, struct fmt_spec **, size_t *);
+static bool fixed_parse_fortran (struct lexer *l, struct pool *, enum fmt_use,
                                  struct fmt_spec **, size_t *);
 
 /* Parses Fortran-like or column-based specifications for placing
@@ -53,40 +53,49 @@ static bool fixed_parse_fortran (struct lexer *l, struct pool *, bool for_input,
    formats like those parsed by DATA LIST or PRINT.  Returns true
    only if successful.
 
-   If successful, formats for VAR_CNT variables are stored in
+   The formats parsed are either input or output formats, according
+   to USE.
+
+   If USE is FMT_FOR_INPUT, then T, X, and / "formats" are parsed,
+   in addition to regular formats.  If USE is FMT_FOR_OUTPUT, then
+   T and X "formats" are parsed but not /.
+
+   If successful, formats for N_VARS variables are stored in
    *FORMATS, and the number of formats required is stored in
-   *FORMAT_CNT.  *FORMAT_CNT may be greater than VAR_CNT because
+   *FORMAT_CNT.  *FORMAT_CNT may be greater than N_VARS because
    of T, X, and / "formats", but success guarantees that exactly
-   VAR_CNT variables will be placed by the output formats.  The
+   N_VARS variables will be placed by the output formats.  The
    caller should call execute_placement_format to process those
    "formats" in interpreting the output.
 
    Uses POOL for allocation.  When the caller is finished
    interpreting *FORMATS, POOL may be destroyed. */
 bool
-parse_var_placements (struct lexer *lexer, struct pool *pool, size_t var_cnt, bool for_input,
-                      struct fmt_spec **formats, size_t *format_cnt)
+parse_var_placements (struct lexer *lexer, struct pool *pool, size_t n_vars,
+                      enum fmt_use use,
+                      struct fmt_spec **formats, size_t *n_formats)
 {
-  assert (var_cnt > 0);
+  assert (n_vars > 0);
   if (lex_is_number (lexer))
-    return fixed_parse_columns (lexer, pool, var_cnt, for_input, formats, format_cnt);
+    return fixed_parse_columns (lexer, pool, n_vars, use,
+                                formats, n_formats);
   else if (lex_match (lexer, T_LPAREN))
     {
-      size_t assignment_cnt;
-      size_t i;
-
-      if (!fixed_parse_fortran (lexer, pool, for_input, formats, format_cnt))
+      int start_ofs = lex_ofs (lexer);
+      if (!fixed_parse_fortran (lexer, pool, use, formats, n_formats))
         return false;
+      int end_ofs = lex_ofs (lexer) - 1;
 
-      assignment_cnt = 0;
-      for (i = 0; i < *format_cnt; i++)
-        assignment_cnt += (*formats)[i].type < FMT_NUMBER_OF_FORMATS;
+      size_t n_assignments = 0;
+      for (size_t i = 0; i < *n_formats; i++)
+        n_assignments += (*formats)[i].type < FMT_NUMBER_OF_FORMATS;
 
-      if (assignment_cnt != var_cnt)
+      if (n_assignments != n_vars)
         {
-          msg (SE, _("Number of variables specified (%zu) "
-                     "differs from number of variable formats (%zu)."),
-               var_cnt, assignment_cnt);
+          lex_ofs_error (lexer, start_ofs, end_ofs,
+                         _("Number of variables specified (%zu) "
+                           "differs from number of variable formats (%zu)."),
+                         n_vars, n_assignments);
           return false;
         }
 
@@ -94,80 +103,91 @@ parse_var_placements (struct lexer *lexer, struct pool *pool, size_t var_cnt, bo
     }
   else
     {
-      msg (SE, _("SPSS-like or Fortran-like format "
-                 "specification expected after variable names."));
+      lex_error (lexer, _("SPSS-like or Fortran-like format "
+                          "specification expected after variable names."));
       return false;
     }
 }
 
 /* Implements parse_var_placements for column-based formats. */
 static bool
-fixed_parse_columns (struct lexer *lexer, struct pool *pool, size_t var_cnt, bool for_input,
-                     struct fmt_spec **formats, size_t *format_cnt)
+fixed_parse_columns (struct lexer *lexer, struct pool *pool, size_t n_vars,
+                     enum fmt_use use,
+                     struct fmt_spec **formats, size_t *n_formats)
 {
-  struct fmt_spec format;
-  int fc, lc;
-  size_t i;
+  int start_ofs = lex_ofs (lexer);
 
-  if ( !parse_column_range (lexer, 1, &fc, &lc, NULL) )
+  int fc, lc;
+  if (!parse_column_range (lexer, 1, &fc, &lc, NULL))
     return false;
 
   /* Divide columns evenly. */
-  format.w = (lc - fc + 1) / var_cnt;
-  if ((lc - fc + 1) % var_cnt)
+  int w = (lc - fc + 1) / n_vars;
+  if ((lc - fc + 1) % n_vars)
     {
-      msg (SE, _("The %d columns %d-%d "
-                "can't be evenly divided into %zu fields."),
-          lc - fc + 1, fc, lc, var_cnt);
+      lex_ofs_error (lexer, start_ofs, lex_ofs (lexer) - 1,
+                     _("The %d columns %d-%d "
+                       "can't be evenly divided into %zu fields."),
+                     lc - fc + 1, fc, lc, n_vars);
       return false;
     }
 
   /* Format specifier. */
+  enum fmt_type type;
+  int d;
   if (lex_match (lexer, T_LPAREN))
     {
       /* Get format type. */
       if (lex_token (lexer) == T_ID)
        {
-         if (!parse_format_specifier_name (lexer, &format.type))
+         if (!parse_format_specifier_name (lexer, &type))
             return false;
          lex_match (lexer, T_COMMA);
        }
       else
-       format.type = FMT_F;
+       type = FMT_F;
 
       /* Get decimal places. */
       if (lex_is_integer (lexer))
        {
-         format.d = lex_integer (lexer);
+         d = lex_integer (lexer);
          lex_get (lexer);
        }
       else
-       format.d = 0;
+       d = 0;
 
       if (!lex_force_match (lexer, T_RPAREN))
        return false;
     }
   else
     {
-      format.type = FMT_F;
-      format.d = 0;
+      type = FMT_F;
+      d = 0;
+    }
+  int end_ofs = lex_ofs (lexer) - 1;
+
+  struct fmt_spec format = { .type = type, .w = w, .d = d };
+  char *error = fmt_check__ (&format, use);
+  if (error)
+    {
+      lex_ofs_error (lexer, start_ofs, end_ofs, "%s", error);
+      free (error);
+      return false;
     }
-  if (!fmt_check (&format, for_input))
-    return false;
 
-  *formats = pool_nalloc (pool, var_cnt + 1, sizeof **formats);
-  *format_cnt = var_cnt + 1;
-  (*formats)[0].type = PRS_TYPE_T;
+  *formats = pool_nalloc (pool, n_vars + 1, sizeof **formats);
+  *n_formats = n_vars + 1;
+  (*formats)[0].type = (enum fmt_type) PRS_TYPE_T;
   (*formats)[0].w = fc;
-  for (i = 1; i <= var_cnt; i++)
+  for (size_t i = 1; i <= n_vars; i++)
     (*formats)[i] = format;
   return true;
 }
 
 /* Implements parse_var_placements for Fortran-like formats. */
 static bool
-fixed_parse_fortran (struct lexer *lexer, struct pool *pool, bool for_input,
-                     struct fmt_spec **formats, size_t *format_cnt)
+fixed_parse_fortran (struct lexer *lexer, struct pool *pool, enum fmt_use use,
+                     struct fmt_spec **formats, size_t *n_formats)
 {
   size_t formats_allocated = 0;
   size_t formats_used = 0;
@@ -177,7 +197,7 @@ fixed_parse_fortran (struct lexer *lexer, struct pool *pool, bool for_input,
     {
       struct fmt_spec f;
       struct fmt_spec *new_formats;
-      size_t new_format_cnt;
+      size_t n_new_formats;
       size_t count;
       size_t formats_needed;
 
@@ -194,28 +214,28 @@ fixed_parse_fortran (struct lexer *lexer, struct pool *pool, bool for_input,
       if (lex_match (lexer, T_LPAREN))
         {
           /* Call ourselves recursively to handle parentheses. */
-          if (!fixed_parse_fortran (lexer, pool, for_input,
-                                    &new_formats, &new_format_cnt))
+          if (!fixed_parse_fortran (lexer, pool, use,
+                                    &new_formats, &n_new_formats))
             return false;
         }
       else
         {
           new_formats = &f;
-          new_format_cnt = 1;
-          if (lex_match (lexer, T_SLASH))
-            f.type = PRS_TYPE_NEW_REC;
+          n_new_formats = 1;
+          if (use == FMT_FOR_INPUT && lex_match (lexer, T_SLASH))
+            f.type = (enum fmt_type) PRS_TYPE_NEW_REC;
           else
             {
+              int ofs = lex_ofs (lexer);
               char type[FMT_TYPE_LEN_MAX + 1];
-
               if (!parse_abstract_format_specifier (lexer, type, &f.w, &f.d))
                 return false;
 
-              if (!strcasecmp (type, "T"))
-                f.type = PRS_TYPE_T;
-              else if (!strcasecmp (type, "X"))
+              if (!c_strcasecmp (type, "T"))
+                f.type = (enum fmt_type) PRS_TYPE_T;
+              else if (!c_strcasecmp (type, "X"))
                 {
-                  f.type = PRS_TYPE_X;
+                  f.type = (enum fmt_type) PRS_TYPE_X;
                   f.w = count;
                   count = 1;
                 }
@@ -223,23 +243,29 @@ fixed_parse_fortran (struct lexer *lexer, struct pool *pool, bool for_input,
                 {
                   if (!fmt_from_name (type, &f.type))
                     {
-                      msg (SE, _("Unknown format type `%s'."), type);
+                      lex_ofs_error (lexer, ofs, ofs,
+                                     _("Unknown format type `%s'."), type);
+                      return false;
+                    }
+                  char *error = fmt_check__ (&f, use);
+                  if (error)
+                    {
+                      lex_ofs_error (lexer, ofs, ofs, "%s", error);
+                      free (error);
                       return false;
                     }
-                  if (!fmt_check (&f, for_input))
-                    return false;
                 }
             }
         }
 
       /* Add COUNT copies of the NEW_FORMAT_CNT formats in
          NEW_FORMATS to FORMATS. */
-      if (new_format_cnt != 0
+      if (n_new_formats != 0
           && size_overflow_p (xtimes (xsum (formats_used,
-                                            xtimes (count, new_format_cnt)),
+                                            xtimes (count, n_new_formats)),
                                       sizeof *formats)))
         xalloc_die ();
-      formats_needed = count * new_format_cnt;
+      formats_needed = count * n_new_formats;
       if (formats_used + formats_needed > formats_allocated)
         {
           formats_allocated = formats_used + formats_needed;
@@ -249,14 +275,14 @@ fixed_parse_fortran (struct lexer *lexer, struct pool *pool, bool for_input,
       for (; count > 0; count--)
         {
           memcpy (&(*formats)[formats_used], new_formats,
-                  sizeof **formats * new_format_cnt);
-          formats_used += new_format_cnt;
+                  sizeof **formats * n_new_formats);
+          formats_used += n_new_formats;
         }
 
       lex_match (lexer, T_COMMA);
     }
 
-  *format_cnt = formats_used;
+  *n_formats = formats_used;
   return true;
 }
 
@@ -268,7 +294,7 @@ bool
 execute_placement_format (const struct fmt_spec *format,
                           int *record, int *column)
 {
-  switch (format->type)
+  switch ((int) format->type)
     {
     case PRS_TYPE_X:
       *column += format->w;
@@ -289,25 +315,46 @@ execute_placement_format (const struct fmt_spec *format,
     }
 }
 
-/* Parses a BASE-based column using LEXER.  Returns true and
-   stores a 1-based column number into *COLUMN if successful,
-   otherwise emits an error message and returns false. */
 static bool
-parse_column (int value, int base, int *column)
+parse_column__ (struct lexer *lexer, bool negative, int base, int *column)
 {
   assert (base == 0 || base == 1);
+
+  if (!lex_force_int (lexer))
+    return false;
+  long int value = lex_integer (lexer);
+  if (negative)
+    value = -value;
+  lex_get (lexer);
+
   *column = value - base + 1;
   if (*column < 1)
     {
       if (base == 1)
-        msg (SE, _("Column positions for fields must be positive."));
+        lex_next_error (lexer, -1, -1,
+                        _("Column positions for fields must be positive."));
       else
-        msg (SE, _("Column positions for fields must not be negative."));
+        lex_next_error (lexer, -1, -1,
+                        _("Column positions for fields must not be negative."));
       return false;
     }
   return true;
 }
 
+/* Parses a BASE-based column using LEXER.  Returns true and
+   stores a 1-based column number into *COLUMN if successful,
+   otherwise emits an error message and returns false.
+
+   If BASE is 0, zero-based column numbers are parsed; if BASE is
+   1, 1-based column numbers are parsed.  Regardless of BASE, the
+   values stored in *FIRST_COLUMN and *LAST_COLUMN are
+   1-based. */
+bool
+parse_column (struct lexer *lexer, int base, int *column)
+{
+  return parse_column__ (lexer, false, base, column);
+}
+
 /* Parse a column or a range of columns, specified as a single
    integer or two integers delimited by a dash.  Stores the range
    in *FIRST_COLUMN and *LAST_COLUMN.  (If only a single integer
@@ -326,23 +373,23 @@ parse_column_range (struct lexer *lexer, int base,
                     int *first_column, int *last_column,
                     bool *range_specified)
 {
+  int start_ofs = lex_ofs (lexer);
+
   /* First column. */
-  if (!lex_force_int (lexer)
-      || !parse_column (lex_integer (lexer), base, first_column))
+  if (!parse_column__ (lexer, false, base, first_column))
     return false;
-  lex_get (lexer);
 
   /* Last column. */
   if (lex_is_integer (lexer) && lex_integer (lexer) < 0)
     {
-      if (!parse_column (-lex_integer (lexer), base, last_column))
+      if (!parse_column__ (lexer, true, base, last_column))
         return false;
-      lex_get (lexer);
 
       if (*last_column < *first_column)
        {
-         msg (SE, _("The ending column for a field must be "
-                    "greater than the starting column."));
+         lex_ofs_error (lexer, start_ofs, lex_ofs (lexer) - 1,
+                         _("The ending column for a field must be "
+                           "greater than the starting column."));
          return false;
        }
 
@@ -371,17 +418,10 @@ parse_record_placement (struct lexer *lexer, int *record, int *column)
 {
   while (lex_match (lexer, T_SLASH))
     {
-      if (lex_is_integer (lexer))
+      if (lex_is_number (lexer))
         {
-          if (lex_integer (lexer) <= *record)
-            {
-              msg (SE, _("The record number specified, %ld, is at or "
-                         "before the previous record, %d.  Data "
-                         "fields must be listed in order of "
-                         "increasing record number."),
-                   lex_integer (lexer), *record);
-              return false;
-            }
+          if (!lex_force_int_range (lexer, NULL, *record + 1, INT_MAX))
+            return false;
           *record = lex_integer (lexer);
           lex_get (lexer);
         }