pintos-os.org Git - pspp/blob - src/language/lexer/format-parser.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2012 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "language/lexer/format-parser.h"
  20
  21 #include <ctype.h>
  22 #include <stdint.h>
  23 #include <stdlib.h>
  24
  25 #include "data/format.h"
  26 #include "data/variable.h"
  27 #include "language/lexer/lexer.h"
  28 #include "libpspp/message.h"
  29 #include "libpspp/misc.h"
  30 #include "libpspp/str.h"
  31
  32 #include "gettext.h"
  33 #define _(msgid) gettext (msgid)
  34
  35 /* Parses a token taking the form of a format specifier and
  36    returns true only if successful.  Emits an error message on
  37    failure.  Stores a null-terminated string representing the
  38    format type in TYPE, and the width and number of decimal
  39    places in *WIDTH and *DECIMALS.
  40
  41    TYPE is not checked as to whether it is really the name of a
  42    format.  Both width and decimals are considered optional.  If
  43    missing, *WIDTH or *DECIMALS or both will be set to 0. */
  44 bool
  45 parse_abstract_format_specifier__ (struct lexer *lexer,
  46                                    char type[FMT_TYPE_LEN_MAX + 1],
  47                                    uint16_t *width, uint8_t *decimals)
  48 {
  49   struct substring s;
  50   struct substring type_ss, width_ss, decimals_ss;
  51   bool has_decimals;
  52
  53   if (lex_token (lexer) != T_ID && lex_token (lexer) != T_STRING)
  54     goto error;
  55
  56   /* Extract pieces. */
  57   s = ss_cstr (lex_tokcstr (lexer));
  58   ss_get_bytes (&s, ss_span (s, ss_cstr (CC_LETTERS)), &type_ss);
  59   ss_get_bytes (&s, ss_span (s, ss_cstr (CC_DIGITS)), &width_ss);
  60   if (ss_match_byte (&s, '.'))
  61     {
  62       has_decimals = true;
  63       ss_get_bytes (&s, ss_span (s, ss_cstr (CC_DIGITS)), &decimals_ss);
  64     }
  65   else
  66     has_decimals = false;
  67
  68   /* Check pieces. */
  69   if (ss_is_empty (type_ss) || ss_length (type_ss) > FMT_TYPE_LEN_MAX)
  70     goto error;
  71   if (has_decimals && ss_is_empty (decimals_ss))
  72     goto error;
  73   if (!ss_is_empty (s))
  74     goto error;
  75
  76   /* Return pieces.
  77      These uses of strtol are valid only because we know that
  78      their substrings are followed by non-digit characters. */
  79   str_copy_buf_trunc (type, FMT_TYPE_LEN_MAX + 1,
  80                       ss_data (type_ss), ss_length (type_ss));
  81   *width = strtol (ss_data (width_ss), NULL, 10);
  82   *decimals = has_decimals ? strtol (ss_data (decimals_ss), NULL, 10) : 0;
  83
  84   return true;
  85
  86 error:
  87   lex_error (lexer, _("expecting valid format specifier"));
  88   return false;
  89 }
  90
  91 /* Like parse_abstract_format_specifier__(), but additionally advanced past
  92    the token if successful. */
  93 bool
  94 parse_abstract_format_specifier (struct lexer *lexer,
  95                                  char type[FMT_TYPE_LEN_MAX + 1],
  96                                  uint16_t *width, uint8_t *decimals)
  97 {
  98   bool ok = parse_abstract_format_specifier__ (lexer, type, width, decimals);
  99   if (ok)
 100     lex_get (lexer);
 101   return ok;
 102 }
 103
 104 /* Parses a format specifier from the token stream and returns true only if
 105    successful.  Emits an error message on failure.  The caller should call
 106    fmt_check_input() or fmt_check_output() on the parsed format as
 107    necessary.  */
 108 bool
 109 parse_format_specifier (struct lexer *lexer, struct fmt_spec *format)
 110 {
 111   char type[FMT_TYPE_LEN_MAX + 1];
 112
 113   if (!parse_abstract_format_specifier__ (lexer, type, &format->w, &format->d))
 114     return false;
 115
 116   if (!fmt_from_name (type, &format->type))
 117     {
 118       msg (SE, _("Unknown format type `%s'."), type);
 119       return false;
 120     }
 121
 122   if (format->w == 0 && !strchr (lex_tokcstr (lexer), '0'))
 123     {
 124       msg (SE, _("Format specifier `%s' lacks required width."),
 125            lex_tokcstr (lexer));
 126       return false;
 127     }
 128
 129   lex_get (lexer);
 130   return true;
 131 }
 132
 133 /* Parses a token containing just the name of a format type and
 134    returns true if successful. */
 135 bool
 136 parse_format_specifier_name (struct lexer *lexer, enum fmt_type *type)
 137 {
 138   if (lex_token (lexer) != T_ID)
 139     {
 140       lex_error (lexer, _("expecting format type"));
 141       return false;
 142     }
 143   if (!fmt_from_name (lex_tokcstr (lexer), type))
 144     {
 145       msg (SE, _("Unknown format type `%s'."), lex_tokcstr (lexer));
 146       return false;
 147     }
 148   lex_get (lexer);
 149   return true;
 150 }