hiding source categories
[pspp] / src / language / stats / ctables.c
index 9dd1fd55a6b43346250bb43b8ed13f7ada6002dc..9b51538a4c877a872be66b56ea30313719e562bc 100644 (file)
@@ -242,6 +242,9 @@ struct ctables
     size_t n_tables;
   };
 
+static struct ctables_postcompute *ctables_find_postcompute (struct ctables *,
+                                                             const char *name);
+
 struct ctables_postcompute
   {
     struct hmap_node hmap_node; /* In struct ctables's 'pcompute' hmap. */
@@ -306,7 +309,6 @@ struct ctables_pcexpr
       };
 
     /* Source location. */
-    int ofs[2];
     struct msg_location *location;
   };
 
@@ -455,10 +457,10 @@ struct ctables_category
         CCT_RANGE,
         CCT_MISSING,
         CCT_OTHERNM,
+        CCT_POSTCOMPUTE,
 
         /* Totals and subtotals. */
         CCT_SUBTOTAL,
-        CCT_HSUBTOTAL,
         CCT_TOTAL,
 
         /* Implicit category lists. */
@@ -470,12 +472,21 @@ struct ctables_category
 
     struct ctables_category *subtotal;
 
+    bool hide;
+
     union
       {
         double number;          /* CCT_NUMBER. */
         char *string;           /* CCT_STRING. */
         double range[2];        /* CCT_RANGE. */
-        char *total_label;   /* CCT_SUBTOTAL, CCT_HSUBTOTAL, CCT_TOTAL. */
+
+        struct
+          {
+            char *total_label;      /* CCT_SUBTOTAL, CCT_TOTAL. */
+            bool hide_subcategories; /* CCT_SUBTOTAL. */
+          };
+
+        const struct ctables_postcompute *pc; /* CCT_POSTCOMPUTE. */
 
         /* CCT_VALUE, CCT_LABEL, CCT_FUNCTION. */
         struct
@@ -489,6 +500,10 @@ struct ctables_category
             double percentile;
           };
       };
+
+    /* Source location.  This is null for CCT_TOTAL, CCT_VALUE, CCT_LABEL,
+       CCT_FUNCTION. */
+    struct msg_location *location;
   };
 
 static void
@@ -503,6 +518,7 @@ ctables_category_uninit (struct ctables_category *cat)
     case CCT_RANGE:
     case CCT_MISSING:
     case CCT_OTHERNM:
+    case CCT_POSTCOMPUTE:
       break;
 
     case CCT_STRING:
@@ -510,7 +526,6 @@ ctables_category_uninit (struct ctables_category *cat)
       break;
 
     case CCT_SUBTOTAL:
-    case CCT_HSUBTOTAL:
     case CCT_TOTAL:
       free (cat->total_label);
       break;
@@ -544,8 +559,10 @@ ctables_category_equal (const struct ctables_category *a,
     case CCT_OTHERNM:
       return true;
 
+    case CCT_POSTCOMPUTE:
+      return a->pc == b->pc;
+
     case CCT_SUBTOTAL:
-    case CCT_HSUBTOTAL:
     case CCT_TOTAL:
       return !strcmp (a->total_label, b->total_label);
 
@@ -1300,9 +1317,257 @@ cct_range (double low, double high)
   };
 }
 
+static bool
+ctables_table_parse_subtotal (struct lexer *lexer, bool hide_subcategories,
+                              struct ctables_category *cat)
+{
+  char *total_label;
+  if (lex_match (lexer, T_EQUALS))
+    {
+      if (!lex_force_string (lexer))
+        return false;
+
+      total_label = ss_xstrdup (lex_tokss (lexer));
+      lex_get (lexer);
+    }
+  else
+    total_label = xstrdup (_("Subtotal"));
+
+  *cat = (struct ctables_category) {
+    .type = CCT_SUBTOTAL,
+    .hide_subcategories = hide_subcategories,
+    .total_label = total_label
+  };
+  return true;
+}
+
+static bool
+ctables_table_parse_explicit_category (struct lexer *lexer, struct ctables *ct,
+                                       struct ctables_category *cat)
+{
+  if (lex_match_id (lexer, "OTHERNM"))
+    *cat = (struct ctables_category) { .type = CCT_OTHERNM };
+  else if (lex_match_id (lexer, "MISSING"))
+    *cat = (struct ctables_category) { .type = CCT_MISSING };
+  else if (lex_match_id (lexer, "SUBTOTAL"))
+    return ctables_table_parse_subtotal (lexer, false, cat);
+  else if (lex_match_id (lexer, "HSUBTOTAL"))
+    return ctables_table_parse_subtotal (lexer, true, cat);
+  else if (lex_match_id (lexer, "LO"))
+    {
+      if (!lex_force_match_id (lexer, "THRU") || lex_force_num (lexer))
+        return false;
+      *cat = cct_range (-DBL_MAX, lex_number (lexer));
+      lex_get (lexer);
+    }
+  else if (lex_is_number (lexer))
+    {
+      double number = lex_number (lexer);
+      lex_get (lexer);
+      if (lex_match_id (lexer, "THRU"))
+        {
+          if (lex_match_id (lexer, "HI"))
+            *cat = cct_range (number, DBL_MAX);
+          else
+            {
+              if (!lex_force_num (lexer))
+                return false;
+              *cat = cct_range (number, lex_number (lexer));
+              lex_get (lexer);
+            }
+        }
+      else
+        *cat = (struct ctables_category) {
+          .type = CCT_NUMBER,
+          .number = number
+        };
+    }
+  else if (lex_is_string (lexer))
+    {
+      *cat = (struct ctables_category) {
+        .type = CCT_STRING,
+        .string = ss_xstrdup (lex_tokss (lexer)),
+      };
+      lex_get (lexer);
+    }
+  else if (lex_match (lexer, T_AND))
+    {
+      if (!lex_force_id (lexer))
+        return false;
+      struct ctables_postcompute *pc = ctables_find_postcompute (
+        ct, lex_tokcstr (lexer));
+      if (!pc)
+        {
+          struct msg_location *loc = lex_get_location (lexer, -1, 0);
+          msg_at (SE, loc, _("Unknown postcompute &%s."),
+                  lex_tokcstr (lexer));
+          msg_location_destroy (loc);
+          return false;
+        }
+      lex_get (lexer);
+
+      *cat = (struct ctables_category) { .type = CCT_POSTCOMPUTE, .pc = pc };
+    }
+  else
+    {
+      lex_error (lexer, NULL);
+      return false;
+    }
+
+  return true;
+}
+
+static struct ctables_category *
+ctables_find_category_for_postcompute (const struct ctables_categories *cats,
+                                       const struct ctables_pcexpr *e)
+{
+  struct ctables_category *best = NULL;
+  size_t n_subtotals = 0;
+  for (size_t i = 0; i < cats->n_cats; i++)
+    {
+      struct ctables_category *cat = &cats->cats[i];
+      switch (e->op)
+        {
+        case CTPO_CAT_NUMBER:
+          if (cat->type == CCT_NUMBER && cat->number == e->number)
+            best = cat;
+          break;
+
+        case CTPO_CAT_STRING:
+          if (cat->type == CCT_STRING && !strcmp (cat->string, e->string))
+            best = cat;
+          break;
+
+        case CTPO_CAT_RANGE:
+          if (cat->type == CCT_RANGE
+              && cat->range[0] == e->range[0]
+              && cat->range[1] == e->range[1])
+            best = cat;
+          break;
+
+        case CTPO_CAT_MISSING:
+          if (cat->type == CCT_MISSING)
+            best = cat;
+          break;
+
+        case CTPO_CAT_OTHERNM:
+          if (cat->type == CCT_OTHERNM)
+            best = cat;
+          break;
+
+        case CTPO_CAT_SUBTOTAL:
+          if (cat->type == CCT_SUBTOTAL)
+            {
+              n_subtotals++;
+              if (e->subtotal_index == n_subtotals)
+                return cat;
+              else if (e->subtotal_index == 0)
+                best = cat;
+            }
+          break;
+
+        case CTPO_CAT_TOTAL:
+          if (cat->type == CCT_TOTAL)
+            return cat;
+          break;
+
+        case CTPO_CONSTANT:
+        case CTPO_ADD:
+        case CTPO_SUB:
+        case CTPO_MUL:
+        case CTPO_DIV:
+        case CTPO_POW:
+        case CTPO_NEG:
+          NOT_REACHED ();
+        }
+    }
+  if (e->op == CTPO_CAT_SUBTOTAL && e->subtotal_index == 0 && n_subtotals > 1)
+    return NULL;
+  return best;
+}
+
+static bool
+ctables_recursive_check_postcompute (const struct ctables_pcexpr *e,
+                                     struct ctables_category *pc_cat,
+                                     const struct ctables_categories *cats,
+                                     const struct msg_location *cats_location)
+{
+  switch (e->op)
+    {
+    case CTPO_CAT_NUMBER:
+    case CTPO_CAT_STRING:
+    case CTPO_CAT_RANGE:
+    case CTPO_CAT_MISSING:
+    case CTPO_CAT_OTHERNM:
+    case CTPO_CAT_SUBTOTAL:
+    case CTPO_CAT_TOTAL:
+      {
+        struct ctables_category *cat = ctables_find_category_for_postcompute (
+          cats, e);
+        if (!cat)
+          {
+            if (e->op == CTPO_CAT_SUBTOTAL && e->subtotal_index == 0)
+              {
+                size_t n_subtotals = 0;
+                for (size_t i = 0; i < cats->n_cats; i++)
+                  n_subtotals += cats->cats[i].type == CCT_SUBTOTAL;
+                if (n_subtotals > 1)
+                  {
+                    msg_at (SE, cats_location,
+                            ngettext ("These categories include %zu instance "
+                                      "of SUBTOTAL or HSUBTOTAL, so references "
+                                      "from computed categories must refer to "
+                                      "subtotals by position.",
+                                      "These categories include %zu instances "
+                                      "of SUBTOTAL or HSUBTOTAL, so references "
+                                      "from computed categories must refer to "
+                                      "subtotals by position.",
+                                      n_subtotals),
+                            n_subtotals);
+                    msg_at (SN, e->location,
+                            _("This is the reference that lacks a position."));
+                    return NULL;
+                  }
+              }
+
+            msg_at (SE, pc_cat->location,
+                    _("Computed category &%s references a category not included "
+                      "in the category list."),
+                    cat->pc->name);
+            msg_at (SN, e->location, _("This is the missing category."));
+            msg_at (SN, cats_location,
+                    _("To fix the problem, add the missing category to the "
+                      "list of categories here."));
+            return false;
+          }
+        if (pc_cat->pc->hide_source_cats)
+          cat->hide = true;
+        return true;
+      }
+
+    case CTPO_CONSTANT:
+      return true;
+
+    case CTPO_ADD:
+    case CTPO_SUB:
+    case CTPO_MUL:
+    case CTPO_DIV:
+    case CTPO_POW:
+    case CTPO_NEG:
+      for (size_t i = 0; i < 2; i++)
+        if (e->subs[i] && !ctables_recursive_check_postcompute (
+              e->subs[i], pc_cat, cats, cats_location))
+          return false;
+      return true;
+
+    default:
+      NOT_REACHED ();
+    }
+}
+
 static bool
 ctables_table_parse_categories (struct lexer *lexer, struct dictionary *dict,
-                                struct ctables_table *t)
+                                struct ctables *ct, struct ctables_table *t)
 {
   if (!lex_match_id (lexer, "VARIABLES"))
     return false;
@@ -1327,83 +1592,33 @@ ctables_table_parse_categories (struct lexer *lexer, struct dictionary *dict,
   size_t allocated_cats = 0;
   if (lex_match (lexer, T_LBRACK))
     {
+      int cats_start_ofs = lex_ofs (lexer);
       do
         {
           if (c->n_cats >= allocated_cats)
             c->cats = x2nrealloc (c->cats, &allocated_cats, sizeof *c->cats);
 
+          int start_ofs = lex_ofs (lexer);
           struct ctables_category *cat = &c->cats[c->n_cats];
-          if (lex_match_id (lexer, "OTHERNM"))
-            cat->type = CCT_OTHERNM;
-          else if (lex_match_id (lexer, "MISSING"))
-            cat->type = CCT_MISSING;
-          else if (lex_match_id (lexer, "SUBTOTAL"))
-            *cat = (struct ctables_category)
-              { .type = CCT_SUBTOTAL, .total_label = NULL };
-          else if (lex_match_id (lexer, "HSUBTOTAL"))
-            *cat = (struct ctables_category)
-              { .type = CCT_HSUBTOTAL, .total_label = NULL };
-          else if (lex_match_id (lexer, "LO"))
-            {
-              if (!lex_force_match_id (lexer, "THRU") || lex_force_num (lexer))
-                return false;
-              *cat = cct_range (-DBL_MAX, lex_number (lexer));
-              lex_get (lexer);
-            }
-          else if (lex_is_number (lexer))
-            {
-              double number = lex_number (lexer);
-              lex_get (lexer);
-              if (lex_match_id (lexer, "THRU"))
-                {
-                  if (lex_match_id (lexer, "HI"))
-                    *cat = cct_range (number, DBL_MAX);
-                  else
-                    {
-                      if (!lex_force_num (lexer))
-                        return false;
-                      *cat = cct_range (number, lex_number (lexer));
-                      lex_get (lexer);
-                    }
-                }
-              else
-                *cat = (struct ctables_category) {
-                  .type = CCT_NUMBER,
-                  .number = number
-                };
-            }
-          else if (lex_is_string (lexer))
-            {
-              *cat = (struct ctables_category) {
-                .type = CCT_STRING,
-                .string = ss_xstrdup (lex_tokss (lexer)),
-              };
-              lex_get (lexer);
-            }
-          else
-            {
-              lex_error (lexer, NULL);
-              return false;
-            }
-
-          if (cat->type == CCT_SUBTOTAL || cat->type == CCT_HSUBTOTAL)
-            {
-              if (lex_match (lexer, T_EQUALS))
-                {
-                  if (!lex_force_string (lexer))
-                    return false;
-
-                  cat->total_label = ss_xstrdup (lex_tokss (lexer));
-                  lex_get (lexer);
-                }
-              else
-                cat->total_label = xstrdup (_("Subtotal"));
-            }
-
+          if (!ctables_table_parse_explicit_category (lexer, ct, cat))
+            return false;
+          cat->location = lex_ofs_location (lexer, start_ofs, lex_ofs (lexer) - 1);
           c->n_cats++;
+
           lex_match (lexer, T_COMMA);
         }
       while (!lex_match (lexer, T_RBRACK));
+
+      struct msg_location *cats_location
+        = lex_ofs_location (lexer, cats_start_ofs, lex_ofs (lexer) - 1);
+      for (size_t i = 0; i < c->n_cats; i++)
+        {
+          struct ctables_category *cat = &c->cats[i];
+          if (cat->type == CCT_POSTCOMPUTE
+              && !ctables_recursive_check_postcompute (cat->pc->expr, cat,
+                                                       c, cats_location))
+            return false;
+        }
     }
 
   struct ctables_category cat = {
@@ -1536,8 +1751,7 @@ ctables_table_parse_categories (struct lexer *lexer, struct dictionary *dict,
   if (!c->n_cats)
     {
       if (c->n_cats >= allocated_cats)
-        c->cats = x2nrealloc (c->cats, &allocated_cats,
-                                sizeof *c->cats);
+        c->cats = x2nrealloc (c->cats, &allocated_cats, sizeof *c->cats);
       c->cats[c->n_cats++] = cat;
     }
 
@@ -1578,8 +1792,10 @@ ctables_table_parse_categories (struct lexer *lexer, struct dictionary *dict,
           cat->subtotal = subtotal;
           break;
 
+        case CCT_POSTCOMPUTE:
+          break;
+
         case CCT_SUBTOTAL:
-        case CCT_HSUBTOTAL:
           subtotal = cat;
           break;
 
@@ -2341,8 +2557,8 @@ ctables_cell_compare_3way (const void *a_, const void *b_, const void *aux_)
           case CCT_NUMBER:
           case CCT_STRING:
           case CCT_SUBTOTAL:
-          case CCT_HSUBTOTAL:
           case CCT_TOTAL:
+          case CCT_POSTCOMPUTE:
             /* Must be equal. */
             continue;
 
@@ -2474,13 +2690,15 @@ ctables_categories_match (const struct ctables_categories *c,
             return cat;
           break;
 
+        case CCT_POSTCOMPUTE:
+          break;
+
         case CCT_OTHERNM:
           if (!othernm)
             othernm = cat;
           break;
 
         case CCT_SUBTOTAL:
-        case CCT_HSUBTOTAL:
         case CCT_TOTAL:
           break;
 
@@ -2521,8 +2739,7 @@ ctables_cell_insert__ (struct ctables_section *s, const struct ccase *c,
           {
             hash = hash_pointer (cats[a][i], hash);
             if (cats[a][i]->type != CCT_TOTAL
-                && cats[a][i]->type != CCT_SUBTOTAL
-                && cats[a][i]->type != CCT_HSUBTOTAL)
+                && cats[a][i]->type != CCT_SUBTOTAL)
               hash = value_hash (case_data (c, nest->vars[i]),
                                  var_get_width (nest->vars[i]), hash);
             else
@@ -2541,7 +2758,6 @@ ctables_cell_insert__ (struct ctables_section *s, const struct ccase *c,
                 && (cats[a][i] != cell->axes[a].cvs[i].category
                     || (cats[a][i]->type != CCT_TOTAL
                         && cats[a][i]->type != CCT_SUBTOTAL
-                        && cats[a][i]->type != CCT_HSUBTOTAL
                         && !value_equal (case_data (c, nest->vars[i]),
                                          &cell->axes[a].cvs[i].value,
                                          var_get_width (nest->vars[i])))))
@@ -2566,14 +2782,13 @@ ctables_cell_insert__ (struct ctables_section *s, const struct ccase *c,
       for (size_t i = 0; i < nest->n; i++)
         {
           const struct ctables_category *cat = cats[a][i];
-
           if (i != nest->scale_idx)
             {
               const struct ctables_category *subtotal = cat->subtotal;
-              if (subtotal && subtotal->type == CCT_HSUBTOTAL)
+              if (cat->hide || (subtotal && subtotal->hide_subcategories))
                 cell->hide = true;
 
-              if (cat->type == CCT_TOTAL || cat->type == CCT_SUBTOTAL || cat->type == CCT_HSUBTOTAL)
+              if (cat->type == CCT_TOTAL || cat->type == CCT_SUBTOTAL)
                 cell->contributes_to_domains = false;
             }
 
@@ -2760,7 +2975,7 @@ ctables_category_create_label (const struct ctables_category *cat,
                                const struct variable *var,
                                const union value *value)
 {
-  return (cat->type == CCT_TOTAL || cat->type == CCT_SUBTOTAL || cat->type == CCT_HSUBTOTAL
+  return (cat->type == CCT_TOTAL || cat->type == CCT_SUBTOTAL
           ? pivot_value_new_user_text (cat->total_label, SIZE_MAX)
           : pivot_value_new_var_value (var, value));
 }
@@ -3005,7 +3220,6 @@ ctables_table_output (struct ctables *ct, struct ctables_table *t)
                           if (prev->axes[a].cvs[var_idx].category != c)
                             break;
                           else if (c->type != CCT_SUBTOTAL
-                                   && c->type != CCT_HSUBTOTAL
                                    && c->type != CCT_TOTAL
                                    && !value_equal (&prev->axes[a].cvs[var_idx].value,
                                                     &cell->axes[a].cvs[var_idx].value,
@@ -3462,8 +3676,10 @@ ctables_add_category_occurrences (const struct variable *var,
             ctables_add_occurrence (var, &vl->value, occurrences);
           break;
 
+        case CCT_POSTCOMPUTE:
+          break;
+
         case CCT_SUBTOTAL:
-        case CCT_HSUBTOTAL:
         case CCT_TOTAL:
           break;
 
@@ -3640,22 +3856,11 @@ ctables_pcexpr_allocate_binary (enum ctables_postcompute_op op,
   *e = (struct ctables_pcexpr) {
     .op = op,
     .subs = { sub0, sub1 },
-    .ofs = { sub0->ofs[0], sub1->ofs[1] }
+    .location = msg_location_merged (sub0->location, sub1->location),
   };
   return e;
 }
 
-static struct msg_location *
-ctables_pcexpr_location (struct lexer *lexer, const struct ctables_pcexpr *e_)
-{
-  if (!e_->location)
-    {
-      struct ctables_pcexpr *e = CONST_CAST (struct ctables_pcexpr *, e_);
-      e->location = lex_ofs_location (lexer, e->ofs[0], e->ofs[1]);
-    }
-  return e_->location;
-}
-
 /* How to parse an operator. */
 struct operator
   {
@@ -3691,8 +3896,7 @@ parse_binary_operators__ (struct lexer *lexer,
       if (!op)
         {
           if (op_count > 1 && chain_warning)
-            msg_at (SW, ctables_pcexpr_location (lexer, lhs),
-                    "%s", chain_warning);
+            msg_at (SW, lhs->location, "%s", chain_warning);
 
           return lhs;
         }
@@ -3833,8 +4037,7 @@ parse_primary (struct lexer *lexer)
       return NULL;
     }
 
-  e.ofs[0] = start_ofs;
-  e.ofs[1] = lex_ofs (lexer) - 1;
+  e.location = lex_ofs_location (lexer, start_ofs, lex_ofs (lexer) - 1);
   return xmemdup (&e, sizeof e);
 }
 
@@ -3846,7 +4049,7 @@ ctables_pcexpr_allocate_neg (struct ctables_pcexpr *sub,
   *e = (struct ctables_pcexpr) {
     .op = CTPO_NEG,
     .subs = { sub },
-    .ofs = { start_ofs, lex_ofs (lexer) - 1 },
+    .location = lex_ofs_location (lexer, start_ofs, lex_ofs (lexer) - 1),
   };
   return e;
 }
@@ -3873,7 +4076,7 @@ parse_exp (struct lexer *lexer)
   *lhs = (struct ctables_pcexpr) {
     .op = CTPO_CONSTANT,
     .number = -lex_tokval (lexer),
-    .ofs = { start_ofs, lex_ofs (lexer) },
+    .location = lex_ofs_location (lexer, start_ofs, lex_ofs (lexer)),
   };
   lex_get (lexer);
 
@@ -4564,7 +4767,8 @@ cmd_ctables (struct lexer *lexer, struct dataset *ds)
             }
           else if (lex_match_id (lexer, "CATEGORIES"))
             {
-              if (!ctables_table_parse_categories (lexer, dataset_dict (ds), t))
+              if (!ctables_table_parse_categories (lexer, dataset_dict (ds),
+                                                   ct, t))
                 goto error;
             }
           else if (lex_match_id (lexer, "TITLES"))