more work
[pspp] / src / language / stats / ctables.c
index 69ed11df7099f78c0249f998c70ce45f50276f2e..624331ba5d108429fcd220aca672eef66de6be65 100644 (file)
@@ -216,12 +216,7 @@ struct ctables_postcompute_expr
         /* CTPO_CAT_RANGE.
 
            XXX what about string ranges? */
-        struct
-          {
-            double low;         /* -DBL_MAX for LO. */
-            double high;        /* DBL_MAX for HIGH. */
-          }
-        range;
+        double range[2];
 
         /* CTPO_ADD, CTPO_SUB, CTPO_MUL, CTPO_DIV, CTPO_POW. */
         struct ctables_postcompute_expr *subs[2];
@@ -277,6 +272,12 @@ ctables_var_get_print_format (const struct ctables_var *var)
           : var_get_print_format (var->var));
 }
 
+static const char *
+ctables_var_name (const struct ctables_var *var)
+{
+  return var->is_mrset ? var->mrset->name : var_get_name (var->var);
+}
+
 struct ctables_categories
   {
     size_t n_refs;
@@ -410,11 +411,14 @@ struct ctables_axis
             bool scale;
             struct ctables_summary *summaries;
             size_t n_summaries;
+            size_t allocated_summaries;
           };
 
         /* Nonterminals. */
         struct ctables_axis *subs[2];
       };
+
+    struct msg_location *loc;
   };
 
 static void ctables_axis_destroy (struct ctables_axis *);
@@ -524,6 +528,7 @@ parse_ctables_summary_function (struct lexer *lexer,
     if (ss_equals_case (names[i].name, lex_tokss (lexer)))
       {
         *f = names[i].function;
+        lex_get (lexer);
         return true;
       }
 
@@ -551,16 +556,22 @@ ctables_axis_destroy (struct ctables_axis *axis)
       ctables_axis_destroy (axis->subs[1]);
       break;
     }
+  msg_location_destroy (axis->loc);
   free (axis);
 }
 
 static struct ctables_axis *
 ctables_axis_new_nonterminal (enum ctables_axis_op op,
                               struct ctables_axis *sub0,
-                              struct ctables_axis *sub1)
+                              struct ctables_axis *sub1,
+                              struct lexer *lexer, int start_ofs)
 {
   struct ctables_axis *axis = xmalloc (sizeof *axis);
-  *axis = (struct ctables_axis) { .op = op, .subs = { sub0, sub1 } };
+  *axis = (struct ctables_axis) {
+    .op = op,
+    .subs = { sub0, sub1 },
+    .loc = lex_ofs_location (lexer, start_ofs, lex_ofs (lexer) - 1),
+  };
   return axis;
 }
 
@@ -572,55 +583,104 @@ struct ctables_axis_parse_ctx
     struct ctables_table *t;
   };
 
-static struct ctables_summary *
-add_summary (struct ctables_axis *axis, enum ctables_summary_function function,
-             double percentile, size_t *allocated_summaries)
+static struct fmt_spec
+ctables_summary_default_format (enum ctables_summary_function function,
+                                const struct ctables_var *var)
 {
-  if (axis->n_summaries >= *allocated_summaries)
-    axis->summaries = x2nrealloc (axis->summaries, allocated_summaries,
-                                  sizeof *axis->summaries);
-
-  static const char *default_labels[] = {
-#define S(ENUM, NAME, LABEL, FORMAT, AVAILABILITY) [ENUM] = LABEL,
-    SUMMARIES
-#undef S
-  };
-  char *label = (function == CTSF_PTILE
-                 ? xasprintf (_("Percentile %.2f"), percentile)
-                 : xstrdup (gettext (default_labels[function])));
-
   static const enum ctables_format default_formats[] = {
 #define S(ENUM, NAME, LABEL, FORMAT, AVAILABILITY) [ENUM] = FORMAT,
     SUMMARIES
 #undef S
   };
-  struct fmt_spec format;
   switch (default_formats[function])
     {
     case CTF_COUNT:
-      format = (struct fmt_spec) { .type = FMT_F, .w = 40 };
-      break;
+      return (struct fmt_spec) { .type = FMT_F, .w = 40 };
 
     case CTF_PERCENT:
-      format = (struct fmt_spec) { .type = FMT_PCT, .w = 40, .d = 1 };
-      break;
+      return (struct fmt_spec) { .type = FMT_PCT, .w = 40, .d = 1 };
 
     case CTF_GENERAL:
-      format = *ctables_var_get_print_format (&axis->var);
-      break;
+      return *ctables_var_get_print_format (var);
 
     default:
       NOT_REACHED ();
     }
+}
 
-  struct ctables_summary *s = &axis->summaries[axis->n_summaries++];
-  *s = (struct ctables_summary) {
-    .function = function,
-    .percentile = percentile,
-    .label = label,
-    .format = format,
+static const char *
+ctables_summary_function_name (enum ctables_summary_function function)
+{
+  static const char *names[] = {
+#define S(ENUM, NAME, LABEL, FORMAT, AVAILABILITY) [ENUM] = NAME,
+    SUMMARIES
+#undef S
   };
-  return s;
+  return names[function];
+}
+
+static bool
+add_summary (struct ctables_axis *axis,
+             enum ctables_summary_function function, double percentile,
+             const char *label, const struct fmt_spec *format,
+             const struct msg_location *loc)
+{
+  if (axis->op == CTAO_VAR)
+    {
+      if (axis->n_summaries >= axis->allocated_summaries)
+        axis->summaries = x2nrealloc (axis->summaries,
+                                      &axis->allocated_summaries,
+                                      sizeof *axis->summaries);
+
+      const char *function_name = ctables_summary_function_name (function);
+      const char *var_name = ctables_var_name (&axis->var);
+      switch (ctables_function_availability (function))
+        {
+        case CTFA_MRSETS:
+          if (!axis->var.is_mrset)
+            {
+              msg_at (SE, loc, _("Summary function %s applies only to multiple "
+                                 "response sets."), function_name);
+              msg_at (SN, axis->loc, _("'%s' is not a multiple response set."),
+                      var_name);
+              return false;
+            }
+          break;
+
+        case CTFA_SCALE:
+          if (!axis->scale)
+            {
+              msg_at (SE, loc,
+                      _("Summary function %s applies only to scale variables."),
+                      function_name);
+              msg_at (SN, axis->loc, _("'%s' is not a scale variable."),
+                      var_name);
+              return false;
+            }
+          break;
+
+        case CTFA_ALL:
+          break;
+        }
+
+      struct ctables_summary *dst = &axis->summaries[axis->n_summaries++];
+      *dst = (struct ctables_summary) {
+        .function = function,
+        .percentile = percentile,
+        .label = xstrdup (label),
+        .format = (format ? *format
+                   : ctables_summary_default_format (function, &axis->var)),
+      };
+      return true;
+    }
+  else
+    {
+      for (size_t i = 0; i < 2; i++)
+        if (!add_summary (axis->subs[i], function, percentile, label, format,
+                          loc))
+          return false;
+      return true;
+    }
 }
 
 static struct ctables_axis *ctables_axis_parse_stack (
@@ -673,6 +733,7 @@ ctables_axis_parse_primary (struct ctables_axis_parse_ctx *ctx)
   if (!lex_force_id (ctx->lexer))
     return NULL;
 
+  int start_ofs = lex_ofs (ctx->lexer);
   struct ctables_var var;
   if (!ctables_var_parse (ctx->lexer, ctx->dict, &var))
     return NULL;
@@ -685,68 +746,178 @@ ctables_axis_parse_primary (struct ctables_axis_parse_ctx *ctx)
                  : lex_match_phrase (ctx->lexer, "[S]") ? true
                  : lex_match_phrase (ctx->lexer, "[C]") ? false
                  : var_get_measure (var.var) == MEASURE_SCALE);
+  axis->loc = lex_ofs_location (ctx->lexer, start_ofs,
+                                lex_ofs (ctx->lexer) - 1);
+  return axis;
+}
+
+static struct ctables_axis *
+ctables_axis_parse_postfix (struct ctables_axis_parse_ctx *ctx)
+{
+  struct ctables_axis *sub = ctables_axis_parse_primary (ctx);
+  if (!sub || !lex_match (ctx->lexer, T_LBRACK))
+    return sub;
 
-  size_t allocated_summaries = 0;
-  if (lex_match (ctx->lexer, T_LBRACK))
+  do
     {
-      do
+      int start_ofs = lex_ofs (ctx->lexer);
+
+      /* Parse function. */
+      enum ctables_summary_function function;
+      if (!parse_ctables_summary_function (ctx->lexer, &function))
+        goto error;
+
+      /* Parse percentile. */
+      double percentile = 0;
+      if (function == CTSF_PTILE)
         {
-          enum ctables_summary_function function;
-          if (!parse_ctables_summary_function (ctx->lexer, &function))
+          if (!lex_force_num_range_closed (ctx->lexer, "PTILE", 0, 100))
             goto error;
+          percentile = lex_number (ctx->lexer);
+          lex_get (ctx->lexer);
+        }
 
-          double percentile = 0;
-          if (function == CTSF_PTILE)
-            {
-              if (!lex_force_num_range_closed (ctx->lexer, "PTILE", 0, 100))
-                goto error;
-              percentile = lex_number (ctx->lexer);
-              lex_get (ctx->lexer);
-            }
+      /* Parse label. */
+      char *label;
+      if (lex_is_string (ctx->lexer))
+        {
+          label = ss_xstrdup (lex_tokss (ctx->lexer));
+          lex_get (ctx->lexer);
+        }
+      else if (function == CTSF_PTILE)
+        label = xasprintf (_("Percentile %.2f"), percentile);
+      else
+        {
+          static const char *default_labels[] = {
+#define S(ENUM, NAME, LABEL, FORMAT, AVAILABILITY) [ENUM] = LABEL,
+            SUMMARIES
+#undef S
+          };
+          label = xstrdup (gettext (default_labels[function]));
+        }
 
-          struct ctables_summary *s = add_summary (axis, function, percentile,
-                                                   &allocated_summaries);
-          if (lex_is_string (ctx->lexer))
-            {
-              free (s->label);
-              s->label = ss_xstrdup (lex_tokss (ctx->lexer));
-              lex_get (ctx->lexer);
-            }
-          if (lex_token (ctx->lexer) == T_ID)
+      /* Parse format. */
+      struct fmt_spec format;
+      const struct fmt_spec *formatp;
+      if (lex_token (ctx->lexer) == T_ID)
+        {
+          if (!parse_format_specifier (ctx->lexer, &format)
+              || !fmt_check_output (&format)
+              || !fmt_check_type_compat (&format, VAL_NUMERIC))
             {
-              if (!parse_format_specifier (ctx->lexer, &s->format)
-                  || !fmt_check_output (&s->format)
-                  || !fmt_check_type_compat (&s->format, VAL_NUMERIC))
-                goto error;
+              free (label);
+              goto error;
             }
-          lex_match (ctx->lexer, T_COMMA);
+          formatp = &format;
         }
-      while (!lex_match (ctx->lexer, T_RBRACK));
+      else
+        formatp = NULL;
+
+      struct msg_location *loc = lex_ofs_location (ctx->lexer, start_ofs,
+                                                   lex_ofs (ctx->lexer) - 1);
+      add_summary (sub, function, percentile, label, formatp, loc);
+      free (label);
+      msg_location_destroy (loc);
+
+      lex_match (ctx->lexer, T_COMMA);
     }
-  else
-    add_summary (axis, axis->scale ? CTSF_MEAN : CTSF_COUNT, 0,
-                 &allocated_summaries);
-  return axis;
+  while (!lex_match (ctx->lexer, T_RBRACK));
+
+  return sub;
 
 error:
-  ctables_axis_destroy (axis);
+  ctables_axis_destroy (sub);
   return NULL;
 }
 
+static const struct ctables_axis *
+find_scale (const struct ctables_axis *axis)
+{
+  if (!axis)
+    return NULL;
+  else if (axis->op == CTAO_VAR)
+    {
+      if (axis->scale)
+        {
+          assert (!axis->var.is_mrset);
+          return axis;
+        }
+      else
+        return NULL;
+    }
+  else
+    {
+      for (size_t i = 0; i < 2; i++)
+        {
+          const struct ctables_axis *scale = find_scale (axis->subs[i]);
+          if (scale)
+            return scale;
+        }
+      return NULL;
+    }
+}
+
+static const struct ctables_axis *
+find_categorical_summary (const struct ctables_axis *axis)
+{
+  if (!axis)
+    return NULL;
+  else if (axis->op == CTAO_VAR)
+    return !axis->scale && axis->n_summaries ? axis : NULL;
+  else
+    {
+      for (size_t i = 0; i < 2; i++)
+        {
+          const struct ctables_axis *sum
+            = find_categorical_summary (axis->subs[i]);
+          if (sum)
+            return sum;
+        }
+      return NULL;
+    }
+}
+
 static struct ctables_axis *
 ctables_axis_parse_nest (struct ctables_axis_parse_ctx *ctx)
 {
-  struct ctables_axis *lhs = ctables_axis_parse_primary (ctx);
+  int start_ofs = lex_ofs (ctx->lexer);
+  struct ctables_axis *lhs = ctables_axis_parse_postfix (ctx);
   if (!lhs)
     return NULL;
 
   while (lex_match (ctx->lexer, T_GT))
     {
-      struct ctables_axis *rhs = ctables_axis_parse_primary (ctx);
+      struct ctables_axis *rhs = ctables_axis_parse_postfix (ctx);
       if (!rhs)
         return NULL;
 
-      lhs = ctables_axis_new_nonterminal (CTAO_NEST, lhs, rhs);
+      struct ctables_axis *nest = ctables_axis_new_nonterminal (
+        CTAO_NEST, lhs, rhs, ctx->lexer, start_ofs);
+
+      const struct ctables_axis *outer_scale = find_scale (lhs);
+      const struct ctables_axis *inner_scale = find_scale (rhs);
+      if (outer_scale && inner_scale)
+        {
+          msg_at (SE, nest->loc, _("Cannot nest scale variables."));
+          msg_at (SN, outer_scale->loc, _("This is an outer scale variable."));
+          msg_at (SN, inner_scale->loc, _("This is an inner scale variable."));
+          ctables_axis_destroy (nest);
+          return NULL;
+        }
+
+      const struct ctables_axis *outer_sum = find_categorical_summary (lhs);
+      if (outer_sum)
+        {
+          msg_at (SE, nest->loc,
+                  _("Summaries may only be requested for categorical variables "
+                    "at the innermost nesting level."));
+          msg_at (SN, outer_sum->loc,
+                  _("This outer categorical variable has a summary."));
+          ctables_axis_destroy (nest);
+          return NULL;
+        }
+
+      lhs = nest;
     }
 
   return lhs;
@@ -755,6 +926,7 @@ ctables_axis_parse_nest (struct ctables_axis_parse_ctx *ctx)
 static struct ctables_axis *
 ctables_axis_parse_stack (struct ctables_axis_parse_ctx *ctx)
 {
+  int start_ofs = lex_ofs (ctx->lexer);
   struct ctables_axis *lhs = ctables_axis_parse_nest (ctx);
   if (!lhs)
     return NULL;
@@ -765,7 +937,8 @@ ctables_axis_parse_stack (struct ctables_axis_parse_ctx *ctx)
       if (!rhs)
         return NULL;
 
-      lhs = ctables_axis_new_nonterminal (CTAO_STACK, lhs, rhs);
+      lhs = ctables_axis_new_nonterminal (CTAO_STACK, lhs, rhs,
+                                          ctx->lexer, start_ofs);
     }
 
   return lhs;
@@ -1299,7 +1472,6 @@ cmd_ctables (struct lexer *lexer, struct dataset *ds)
       lex_match (lexer, T_EQUALS);
       if (!ctables_axis_parse (lexer, dataset_dict (ds), ct, t, PIVOT_AXIS_ROW))
         goto error;
-
       if (lex_match (lexer, T_BY))
         {
           if (!ctables_axis_parse (lexer, dataset_dict (ds),
@@ -1313,12 +1485,42 @@ cmd_ctables (struct lexer *lexer, struct dataset *ds)
                 goto error;
             }
         }
+
+      if (!t->axes[PIVOT_AXIS_ROW] && !t->axes[PIVOT_AXIS_COLUMN]
+          && !t->axes[PIVOT_AXIS_LAYER])
+        {
+          lex_error (lexer, _("At least one variable must be specified."));
+          goto error;
+        }
+
+      const struct ctables_axis *scales[PIVOT_N_AXES];
+      size_t n_scales = 0;
+      for (size_t i = 0; i < 3; i++)
+        {
+          scales[i] = find_scale (t->axes[i]);
+          if (scales[i])
+            n_scales++;
+        }
+      if (n_scales > 1)
+        {
+          msg (SE, _("Scale variables may appear only on one dimension."));
+          if (scales[PIVOT_AXIS_ROW])
+            msg_at (SN, scales[PIVOT_AXIS_ROW]->loc,
+                    _("This scale variable appears in the rows dimension."));
+          if (scales[PIVOT_AXIS_COLUMN])
+            msg_at (SN, scales[PIVOT_AXIS_COLUMN]->loc,
+                    _("This scale variable appears in the columns dimension."));
+          if (scales[PIVOT_AXIS_LAYER])
+            msg_at (SN, scales[PIVOT_AXIS_LAYER]->loc,
+                    _("This scale variable appears in the layer dimension."));
+          goto error;
+        }
+
       if (lex_token (lexer) == T_ENDCMD)
         break;
       if (!lex_force_match (lexer, T_SLASH))
         break;
 
-      /* XXX Validate axes. */
       while (!lex_match_id (lexer, "TABLE") && lex_token (lexer) != T_ENDCMD)
         {
           if (lex_match_id (lexer, "SLABELS"))
@@ -1336,8 +1538,7 @@ cmd_ctables (struct lexer *lexer, struct dataset *ds)
                         t->slabels_position = PIVOT_AXIS_LAYER;
                       else
                         {
-                          lex_error_expecting (lexer, "COLUMN", "ROW",
-                                               "LAYER");
+                          lex_error_expecting (lexer, "COLUMN", "ROW", "LAYER");
                           goto error;
                         }
                     }
@@ -1650,6 +1851,13 @@ cmd_ctables (struct lexer *lexer, struct dataset *ds)
               goto error;
             }
         }
+
+      if (t->row_labels != CTLP_NORMAL && t->col_labels != CTLP_NORMAL)
+        {
+          msg (SE, _("ROWLABELS and COLLABELS may not both be specified."));
+          goto error;
+        }
+
     }
   while (lex_token (lexer) != T_ENDCMD);
   ctables_destroy (ct);