Move all command implementations into a single 'commands' directory.
[pspp] / src / language / commands / repeat.c
diff --git a/src/language/commands/repeat.c b/src/language/commands/repeat.c
new file mode 100644 (file)
index 0000000..f714091
--- /dev/null
@@ -0,0 +1,418 @@
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2007, 2009-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
+   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.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+
+#include <config.h>
+
+#include <stdlib.h>
+
+#include "data/dataset.h"
+#include "data/dictionary.h"
+#include "data/settings.h"
+#include "language/command.h"
+#include "language/lexer/lexer.h"
+#include "language/lexer/segment.h"
+#include "language/lexer/token.h"
+#include "language/lexer/variable-parser.h"
+#include "libpspp/assertion.h"
+#include "libpspp/cast.h"
+#include "libpspp/hash-functions.h"
+#include "libpspp/hmap.h"
+#include "libpspp/i18n.h"
+#include "libpspp/message.h"
+#include "libpspp/str.h"
+#include "libpspp/misc.h"
+#include "output/output-item.h"
+
+#include "gl/ftoastr.h"
+#include "gl/minmax.h"
+#include "gl/xalloc.h"
+#include "gl/xmemdup0.h"
+
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
+
+struct dummy_var
+  {
+    struct hmap_node hmap_node;
+    struct substring name;
+    char **values;
+    size_t n_values;
+    int start_ofs, end_ofs;
+  };
+
+static bool parse_specification (struct lexer *, struct dictionary *,
+                                 struct hmap *dummies);
+static bool parse_commands (struct lexer *, struct hmap *dummies);
+static void destroy_dummies (struct hmap *dummies);
+
+static bool parse_ids (struct lexer *, const struct dictionary *,
+                       struct dummy_var *);
+static bool parse_numbers (struct lexer *, struct dummy_var *);
+static bool parse_strings (struct lexer *, struct dummy_var *);
+
+int
+cmd_do_repeat (struct lexer *lexer, struct dataset *ds)
+{
+  struct hmap dummies = HMAP_INITIALIZER (dummies);
+  bool ok = parse_specification (lexer, dataset_dict (ds), &dummies);
+  ok = parse_commands (lexer, &dummies) && ok;
+  destroy_dummies (&dummies);
+
+  return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
+}
+
+static const struct dummy_var *
+find_dummy_var (struct hmap *hmap, struct substring name)
+{
+  const struct dummy_var *dv;
+
+  HMAP_FOR_EACH_WITH_HASH (dv, struct dummy_var, hmap_node,
+                           utf8_hash_case_substring (name, 0), hmap)
+    if (!utf8_sscasecmp (dv->name, name))
+      return dv;
+
+  return NULL;
+}
+
+/* Parses the whole DO REPEAT command specification.
+   Returns success. */
+static bool
+parse_specification (struct lexer *lexer, struct dictionary *dict,
+                     struct hmap *dummies)
+{
+  struct dummy_var *first_dv = NULL;
+
+  do
+    {
+      int start_ofs = lex_ofs (lexer);
+
+      /* Get a stand-in variable name and make sure it's unique. */
+      if (!lex_force_id (lexer))
+       goto error;
+      struct substring name = lex_tokss (lexer);
+      if (dict_lookup_var (dict, name.string))
+        lex_msg (lexer, SW,
+                 _("Dummy variable name `%s' hides dictionary variable `%s'."),
+                 name.string, name.string);
+      if (find_dummy_var (dummies, name))
+        {
+          lex_error (lexer, _("Dummy variable name `%s' is given twice."),
+                     name.string);
+          goto error;
+        }
+
+      /* Make a new macro. */
+      struct dummy_var *dv = xmalloc (sizeof *dv);
+      *dv = (struct dummy_var) {
+        .name = ss_clone (name),
+        .start_ofs = start_ofs,
+      };
+      hmap_insert (dummies, &dv->hmap_node, utf8_hash_case_substring (name, 0));
+
+      /* Skip equals sign. */
+      lex_get (lexer);
+      if (!lex_force_match (lexer, T_EQUALS))
+       goto error;
+
+      /* Get the details of the variable's possible values. */
+      bool ok;
+      if (lex_token (lexer) == T_ID || lex_token (lexer) == T_ALL)
+       ok = parse_ids (lexer, dict, dv);
+      else if (lex_is_number (lexer))
+       ok = parse_numbers (lexer, dv);
+      else if (lex_is_string (lexer))
+       ok = parse_strings (lexer, dv);
+      else
+       {
+         lex_error (lexer, _("Syntax error expecting substitution values."));
+         goto error;
+       }
+      if (!ok)
+       goto error;
+      assert (dv->n_values > 0);
+      if (lex_token (lexer) != T_SLASH && lex_token (lexer) != T_ENDCMD)
+        {
+          lex_error (lexer, _("Syntax error expecting `/' or end of command."));
+          goto error;
+        }
+      dv->end_ofs = lex_ofs (lexer) - 1;
+
+      /* If this is the first variable then it defines how many replacements
+        there must be; otherwise enforce this number of replacements. */
+      if (first_dv == NULL)
+        first_dv = dv;
+      else if (first_dv->n_values != dv->n_values)
+       {
+          msg (SE, _("Each dummy variable must have the same number of "
+                     "substitutions."));
+
+          lex_ofs_msg (lexer, SN, first_dv->start_ofs, first_dv->end_ofs,
+                       ngettext ("Dummy variable %s had %zu substitution.",
+                                 "Dummy variable %s had %zu substitutions.",
+                                 first_dv->n_values),
+                       first_dv->name.string, first_dv->n_values);
+          lex_ofs_msg (lexer, SN, dv->start_ofs, dv->end_ofs,
+                       ngettext ("Dummy variable %s had %zu substitution.",
+                                 "Dummy variable %s had %zu substitutions.",
+                                 dv->n_values),
+                       dv->name.string, dv->n_values);
+         goto error;
+       }
+
+      lex_match (lexer, T_SLASH);
+    }
+  while (!lex_match (lexer, T_ENDCMD));
+
+  while (lex_match (lexer, T_ENDCMD))
+    continue;
+
+  return true;
+
+error:
+  lex_discard_rest_of_command (lexer);
+  while (lex_match (lexer, T_ENDCMD))
+    continue;
+  destroy_dummies (dummies);
+  hmap_init (dummies);
+  return false;
+}
+
+static size_t
+count_values (struct hmap *dummies)
+{
+  if (hmap_is_empty (dummies))
+    return 0;
+  const struct dummy_var *dv = HMAP_FIRST (struct dummy_var, hmap_node, dummies);
+  return dv->n_values;
+}
+
+static void
+do_parse_commands (struct substring s, enum segmenter_mode mode,
+                   struct hmap *dummies,
+                   struct string *outputs, size_t n_outputs)
+{
+  struct segmenter segmenter = segmenter_init (mode, false);
+  while (!ss_is_empty (s))
+    {
+      enum segment_type type;
+      int n = segmenter_push (&segmenter, s.string, s.length, true, &type);
+      assert (n >= 0);
+
+      if (type == SEG_DO_REPEAT_COMMAND)
+        {
+          for (;;)
+            {
+              int k = segmenter_push (&segmenter, s.string + n, s.length - n,
+                                      true, &type);
+              if (type != SEG_NEWLINE && type != SEG_DO_REPEAT_COMMAND)
+                break;
+
+              n += k;
+            }
+
+          do_parse_commands (ss_head (s, n), mode, dummies,
+                             outputs, n_outputs);
+        }
+      else if (type != SEG_END)
+        {
+          const struct dummy_var *dv
+            = (type == SEG_IDENTIFIER ? find_dummy_var (dummies, ss_head (s, n))
+               : NULL);
+          for (size_t i = 0; i < n_outputs; i++)
+            if (dv != NULL)
+              ds_put_cstr (&outputs[i], dv->values[i]);
+            else
+              ds_put_substring (&outputs[i], ss_head (s, n));
+        }
+
+      ss_advance (&s, n);
+    }
+}
+
+static bool
+parse_commands (struct lexer *lexer, struct hmap *dummies)
+{
+  char *file_name = xstrdup_if_nonnull (lex_get_file_name (lexer));
+  int line_number = lex_ofs_start_point (lexer, lex_ofs (lexer)).line;
+
+  struct string input = DS_EMPTY_INITIALIZER;
+  while (lex_is_string (lexer))
+    {
+      ds_put_substring (&input, lex_tokss (lexer));
+      ds_put_byte (&input, '\n');
+      lex_get (lexer);
+    }
+
+  size_t n_values = count_values (dummies);
+  struct string *outputs = xmalloc (n_values * sizeof *outputs);
+  for (size_t i = 0; i < n_values; i++)
+    ds_init_empty (&outputs[i]);
+
+  do_parse_commands (ds_ss (&input), lex_get_syntax_mode (lexer),
+                     dummies, outputs, n_values);
+
+  ds_destroy (&input);
+
+  while (lex_match (lexer, T_ENDCMD))
+    continue;
+
+  bool ok = lex_match_phrase (lexer, "END REPEAT");
+  if (!ok)
+    lex_error (lexer, _("Syntax error expecting END REPEAT."));
+  bool print = ok && lex_match_id (lexer, "PRINT");
+  lex_discard_rest_of_command (lexer);
+
+  for (size_t i = 0; i < n_values; i++)
+    {
+      struct string *output = &outputs[n_values - i - 1];
+      if (print)
+        {
+          struct substring s = output->ss;
+          ss_chomp_byte (&s, '\n');
+          char *label = xasprintf (_("Expansion %zu of %zu"), i + 1, n_values);
+          output_item_submit (
+            text_item_create_nocopy (TEXT_ITEM_LOG, ss_xstrdup (s), label));
+        }
+      const char *encoding = lex_get_encoding (lexer);
+      struct lex_reader *reader = lex_reader_for_substring_nocopy (ds_ss (output), encoding);
+      lex_reader_set_file_name (reader, file_name);
+      reader->line_number = line_number;
+      lex_include (lexer, reader);
+    }
+  free (file_name);
+  free (outputs);
+
+  return ok;
+}
+
+static void
+destroy_dummies (struct hmap *dummies)
+{
+  struct dummy_var *dv, *next;
+
+  HMAP_FOR_EACH_SAFE (dv, next, struct dummy_var, hmap_node, dummies)
+    {
+      hmap_delete (dummies, &dv->hmap_node);
+
+      ss_dealloc (&dv->name);
+      for (size_t i = 0; i < dv->n_values; i++)
+        free (dv->values[i]);
+      free (dv->values);
+      free (dv);
+    }
+  hmap_destroy (dummies);
+}
+
+/* Parses a set of ids for DO REPEAT. */
+static bool
+parse_ids (struct lexer *lexer, const struct dictionary *dict,
+          struct dummy_var *dv)
+{
+  return parse_mixed_vars (lexer, dict, &dv->values, &dv->n_values, PV_NONE);
+}
+
+/* Adds REPLACEMENT to MACRO's list of replacements, which has
+   *USED elements and has room for *ALLOCATED.  Allocates memory
+   from POOL. */
+static void
+add_replacement (struct dummy_var *dv, char *value, size_t *allocated)
+{
+  if (dv->n_values == *allocated)
+    dv->values = x2nrealloc (dv->values, allocated, sizeof *dv->values);
+  dv->values[dv->n_values++] = value;
+}
+
+/* Parses a list or range of numbers for DO REPEAT. */
+static bool
+parse_numbers (struct lexer *lexer, struct dummy_var *dv)
+{
+  size_t allocated = 0;
+
+  do
+    {
+      if (!lex_force_num (lexer))
+       return false;
+
+      if (lex_next_token (lexer, 1) == T_TO)
+        {
+          if (!lex_is_integer (lexer))
+           {
+             lex_error (lexer, _("Ranges may only have integer bounds."));
+             return false;
+           }
+
+          long a = lex_integer (lexer);
+          lex_get (lexer);
+          lex_get (lexer);
+
+          if (!lex_force_int_range (lexer, NULL, a, LONG_MAX))
+            return false;
+
+         long b = lex_integer (lexer);
+          if (b < a)
+            {
+              lex_next_error (lexer, -2, 0,
+                              _("%ld TO %ld is an invalid range."), a, b);
+              return false;
+            }
+         lex_get (lexer);
+
+          for (long i = a; i <= b; i++)
+            add_replacement (dv, xasprintf ("%ld", i), &allocated);
+        }
+      else
+        {
+          char s[DBL_BUFSIZE_BOUND];
+
+          c_dtoastr (s, sizeof s, 0, 0, lex_number (lexer));
+          add_replacement (dv, xstrdup (s), &allocated);
+          lex_get (lexer);
+        }
+
+      lex_match (lexer, T_COMMA);
+    }
+  while (lex_token (lexer) != T_SLASH && lex_token (lexer) != T_ENDCMD);
+
+  return true;
+}
+
+/* Parses a list of strings for DO REPEAT. */
+static bool
+parse_strings (struct lexer *lexer, struct dummy_var *dv)
+{
+  size_t allocated = 0;
+
+  do
+    {
+      if (!lex_force_string (lexer))
+        return false;
+
+      add_replacement (dv, token_to_string (lex_next (lexer, 0)), &allocated);
+
+      lex_get (lexer);
+      lex_match (lexer, T_COMMA);
+    }
+  while (lex_token (lexer) != T_SLASH && lex_token (lexer) != T_ENDCMD);
+
+  return true;
+}
+\f
+int
+cmd_end_repeat (struct lexer *lexer, struct dataset *ds UNUSED)
+{
+  lex_ofs_error (lexer, 0, 1, _("No matching %s."), "DO REPEAT");
+  return CMD_CASCADING_FAILURE;
+}