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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2021 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/macro.h"
  20
  21 #include <limits.h>
  22 #include <stdlib.h>
  23
  24 #include "data/settings.h"
  25 #include "language/lexer/segment.h"
  26 #include "language/lexer/scan.h"
  27 #include "libpspp/assertion.h"
  28 #include "libpspp/i18n.h"
  29 #include "libpspp/message.h"
  30 #include "libpspp/str.h"
  31
  32 #include "gettext.h"
  33 #define _(msgid) gettext (msgid)
  34
  35 void
  36 macro_token_copy (struct macro_token *dst, const struct macro_token *src)
  37 {
  38   token_copy (&dst->token, &src->token);
  39   ss_alloc_substring (&dst->representation, src->representation);
  40 }
  41
  42 void
  43 macro_token_uninit (struct macro_token *mt)
  44 {
  45   token_uninit (&mt->token);
  46   ss_dealloc (&mt->representation);
  47 }
  48
  49 void
  50 macro_token_to_representation (struct macro_token *mt, struct string *s)
  51 {
  52   ds_put_substring (s, mt->representation);
  53 }
  54
  55 void
  56 macro_tokens_copy (struct macro_tokens *dst, const struct macro_tokens *src)
  57 {
  58   *dst = (struct macro_tokens) {
  59     .mts = xmalloc (src->n * sizeof *dst->mts),
  60     .n = src->n,
  61     .allocated = src->n,
  62   };
  63   for (size_t i = 0; i < src->n; i++)
  64     macro_token_copy (&dst->mts[i], &src->mts[i]);
  65 }
  66
  67 void
  68 macro_tokens_uninit (struct macro_tokens *mts)
  69 {
  70   for (size_t i = 0; i < mts->n; i++)
  71     macro_token_uninit (&mts->mts[i]);
  72   free (mts->mts);
  73 }
  74
  75 struct macro_token *
  76 macro_tokens_add_uninit (struct macro_tokens *mts)
  77 {
  78   if (mts->n >= mts->allocated)
  79     mts->mts = x2nrealloc (mts->mts, &mts->allocated, sizeof *mts->mts);
  80   return &mts->mts[mts->n++];
  81 }
  82
  83 void
  84 macro_tokens_add (struct macro_tokens *mts, const struct macro_token *mt)
  85 {
  86   macro_token_copy (macro_tokens_add_uninit (mts), mt);
  87 }
  88
  89 void
  90 macro_tokens_from_string (struct macro_tokens *mts, const struct substring src,
  91                           enum segmenter_mode mode)
  92 {
  93   struct state
  94     {
  95       struct segmenter segmenter;
  96       struct substring body;
  97     };
  98
  99   struct state state = {
 100     .segmenter = SEGMENTER_INIT (mode),
 101     .body = src,
 102   };
 103   struct state saved = state;
 104
 105   while (state.body.length > 0)
 106     {
 107       struct macro_token mt = {
 108         .token = { .type = T_STOP },
 109         .representation = { .string = state.body.string },
 110       };
 111       struct token *token = &mt.token;
 112
 113       struct scanner scanner;
 114       scanner_init (&scanner, token);
 115
 116       for (;;)
 117         {
 118           enum segment_type type;
 119           int seg_len = segmenter_push (&state.segmenter, state.body.string,
 120                                         state.body.length, true, &type);
 121           assert (seg_len >= 0);
 122
 123           struct substring segment = ss_head (state.body, seg_len);
 124           ss_advance (&state.body, seg_len);
 125
 126           enum scan_result result = scanner_push (&scanner, type, segment, token);
 127           if (result == SCAN_SAVE)
 128             saved = state;
 129           else if (result == SCAN_BACK)
 130             {
 131               state = saved;
 132               break;
 133             }
 134           else if (result == SCAN_DONE)
 135             break;
 136         }
 137
 138       /* We have a token in 'token'. */
 139       if (is_scan_type (token->type))
 140         {
 141           if (token->type != SCAN_SKIP)
 142             {
 143               /* XXX report error */
 144             }
 145         }
 146       else
 147         {
 148           mt.representation.length = state.body.string - mt.representation.string;
 149           macro_tokens_add (mts, &mt);
 150         }
 151       token_uninit (token);
 152     }
 153 }
 154
 155 void
 156 macro_tokens_print (const struct macro_tokens *mts, FILE *stream)
 157 {
 158   for (size_t i = 0; i < mts->n; i++)
 159     token_print (&mts->mts[i].token, stream);
 160 }
 161
 162 enum token_class
 163   {
 164     TC_ENDCMD,                  /* No space before or after (new-line after). */
 165     TC_BINOP,                   /* Space on both sides. */
 166     TC_COMMA,                   /* Space afterward. */
 167     TC_ID,                      /* Don't need spaces except sequentially. */
 168     TC_PUNCT,                   /* Don't need spaces except sequentially. */
 169   };
 170
 171 static bool
 172 needs_space (enum token_class prev, enum token_class next)
 173 {
 174   /* Don't need a space before or after the end of a command.
 175      (A new-line is needed afterward as a special case.) */
 176   if (prev == TC_ENDCMD || next == TC_ENDCMD)
 177     return false;
 178
 179   /* Binary operators always have a space on both sides. */
 180   if (prev == TC_BINOP || next == TC_BINOP)
 181     return true;
 182
 183   /* A comma always has a space afterward. */
 184   if (prev == TC_COMMA)
 185     return true;
 186
 187   /* Otherwise, PREV is TC_ID or TC_PUNCT, which only need a space if there are
 188      two or them in a row. */
 189   return prev == next;
 190 }
 191
 192 static enum token_class
 193 classify_token (enum token_type type)
 194 {
 195   switch (type)
 196     {
 197     case T_ID:
 198     case T_MACRO_ID:
 199     case T_POS_NUM:
 200     case T_NEG_NUM:
 201     case T_STRING:
 202       return TC_ID;
 203
 204     case T_STOP:
 205       return TC_PUNCT;
 206
 207     case T_ENDCMD:
 208       return TC_ENDCMD;
 209
 210     case T_LPAREN:
 211     case T_RPAREN:
 212     case T_LBRACK:
 213     case T_RBRACK:
 214       return TC_PUNCT;
 215
 216     case T_PLUS:
 217     case T_DASH:
 218     case T_ASTERISK:
 219     case T_SLASH:
 220     case T_EQUALS:
 221     case T_AND:
 222     case T_OR:
 223     case T_NOT:
 224     case T_EQ:
 225     case T_GE:
 226     case T_GT:
 227     case T_LE:
 228     case T_LT:
 229     case T_NE:
 230     case T_ALL:
 231     case T_BY:
 232     case T_TO:
 233     case T_WITH:
 234     case T_EXP:
 235     case T_MACRO_PUNCT:
 236       return TC_BINOP;
 237
 238     case T_COMMA:
 239       return TC_COMMA;
 240     }
 241
 242   NOT_REACHED ();
 243 }
 244
 245 void
 246 macro_tokens_to_representation (struct macro_tokens *mts, struct string *s)
 247 {
 248   if (!mts->n)
 249     return;
 250
 251   macro_token_to_representation (&mts->mts[0], s);
 252   for (size_t i = 1; i < mts->n; i++)
 253     {
 254       enum token_type prev = mts->mts[i - 1].token.type;
 255       enum token_type next = mts->mts[i].token.type;
 256
 257       if (prev == T_ENDCMD)
 258         ds_put_byte (s, '\n');
 259       else
 260         {
 261           enum token_class pc = classify_token (prev);
 262           enum token_class nc = classify_token (next);
 263           if (needs_space (pc, nc))
 264             ds_put_byte (s, ' ');
 265         }
 266
 267       macro_token_to_representation (&mts->mts[i], s);
 268     }
 269 }
 270
 271 void
 272 macro_destroy (struct macro *m)
 273 {
 274   if (!m)
 275     return;
 276
 277   free (m->name);
 278   for (size_t i = 0; i < m->n_params; i++)
 279     {
 280       struct macro_param *p = &m->params[i];
 281       free (p->name);
 282
 283       macro_tokens_uninit (&p->def);
 284
 285       switch (p->arg_type)
 286         {
 287         case ARG_N_TOKENS:
 288           break;
 289
 290         case ARG_CHAREND:
 291           token_uninit (&p->charend);
 292           break;
 293
 294         case ARG_ENCLOSE:
 295           token_uninit (&p->enclose[0]);
 296           token_uninit (&p->enclose[1]);
 297           break;
 298
 299         case ARG_CMDEND:
 300           break;
 301         }
 302     }
 303   free (m->params);
 304   macro_tokens_uninit (&m->body);
 305   free (m);
 306 }
 307 \f
 308 struct macro_set *
 309 macro_set_create (void)
 310 {
 311   struct macro_set *set = xmalloc (sizeof *set);
 312   *set = (struct macro_set) {
 313     .macros = HMAP_INITIALIZER (set->macros),
 314   };
 315   return set;
 316 }
 317
 318 void
 319 macro_set_destroy (struct macro_set *set)
 320 {
 321   if (!set)
 322     return;
 323
 324   struct macro *macro, *next;
 325   HMAP_FOR_EACH_SAFE (macro, next, struct macro, hmap_node, &set->macros)
 326     {
 327       hmap_delete (&set->macros, &macro->hmap_node);
 328       macro_destroy (macro);
 329     }
 330   hmap_destroy (&set->macros);
 331   free (set);
 332 }
 333
 334 static unsigned int
 335 hash_macro_name (const char *name)
 336 {
 337   return utf8_hash_case_string (name, 0);
 338 }
 339
 340 static struct macro *
 341 macro_set_find__ (struct macro_set *set, const char *name)
 342 {
 343   struct macro *macro;
 344   HMAP_FOR_EACH_WITH_HASH (macro, struct macro, hmap_node,
 345                            hash_macro_name (name), &set->macros)
 346     if (!utf8_strcasecmp (macro->name, name))
 347       return macro;
 348
 349   return NULL;
 350 }
 351
 352 const struct macro *
 353 macro_set_find (const struct macro_set *set, const char *name)
 354 {
 355   return macro_set_find__ (CONST_CAST (struct macro_set *, set), name);
 356 }
 357
 358 /* Adds M to SET.  M replaces any existing macro with the same name.  Takes
 359    ownership of M. */
 360 void
 361 macro_set_add (struct macro_set *set, struct macro *m)
 362 {
 363   struct macro *victim = macro_set_find__ (set, m->name);
 364   if (victim)
 365     {
 366       hmap_delete (&set->macros, &victim->hmap_node);
 367       macro_destroy (victim);
 368     }
 369
 370   hmap_insert (&set->macros, &m->hmap_node, hash_macro_name (m->name));
 371 }
 372 \f
 373 enum me_state
 374   {
 375     /* Error state. */
 376     ME_ERROR,
 377
 378     /* Accumulating tokens in me->params toward the end of any type of
 379        argument. */
 380     ME_ARG,
 381
 382     /* Expecting the opening delimiter of an ARG_ENCLOSE argument. */
 383     ME_ENCLOSE,
 384
 385     /* Expecting a keyword for a keyword argument. */
 386     ME_KEYWORD,
 387
 388     /* Expecting an equal sign for a keyword argument. */
 389     ME_EQUALS,
 390   };
 391
 392
 393 struct macro_expander
 394   {
 395     const struct macro_set *macros;
 396
 397     enum me_state state;
 398     size_t n_tokens;
 399
 400     const struct macro *macro;
 401     struct macro_tokens **args;
 402     const struct macro_param *param;
 403   };
 404
 405 static int
 406 me_finished (struct macro_expander *me)
 407 {
 408   for (size_t i = 0; i < me->macro->n_params; i++)
 409     if (!me->args[i])
 410       {
 411         me->args[i] = xmalloc (sizeof *me->args[i]);
 412         macro_tokens_copy (me->args[i], &me->macro->params[i].def);
 413       }
 414   return me->n_tokens;
 415 }
 416
 417 static int
 418 me_next_arg (struct macro_expander *me)
 419 {
 420   if (!me->param)
 421     {
 422       assert (!me->macro->n_params);
 423       return me_finished (me);
 424     }
 425   else if (me->param->positional)
 426     {
 427       me->param++;
 428       if (me->param >= &me->macro->params[me->macro->n_params])
 429         return me_finished (me);
 430       else
 431         {
 432           me->state = me->param->positional ? ME_ARG : ME_KEYWORD;
 433           return 0;
 434         }
 435     }
 436   else
 437     {
 438       for (size_t i = 0; i < me->macro->n_params; i++)
 439         if (!me->args[i])
 440           {
 441             me->state = ME_KEYWORD;
 442             return 0;
 443           }
 444       return me_finished (me);
 445     }
 446 }
 447
 448 static int
 449 me_error (struct macro_expander *me)
 450 {
 451   me->state = ME_ERROR;
 452   return -1;
 453 }
 454
 455 static int
 456 me_add_arg (struct macro_expander *me, const struct macro_token *mt)
 457 {
 458   const struct token *token = &mt->token;
 459   if (token->type == T_ENDCMD || token->type == T_STOP)
 460     {
 461       msg (SE, _("Unexpected end of command reading argument %s "
 462                  "to macro %s."), me->param->name, me->macro->name);
 463
 464       return me_error (me);
 465     }
 466
 467   me->n_tokens++;
 468
 469   const struct macro_param *p = me->param;
 470   struct macro_tokens **argp = &me->args[p - me->macro->params];
 471   if (!*argp)
 472     *argp = xzalloc (sizeof **argp);
 473   struct macro_tokens *arg = *argp;
 474   if (p->arg_type == ARG_N_TOKENS)
 475     {
 476       macro_tokens_add (arg, mt);
 477       if (arg->n >= p->n_tokens)
 478         return me_next_arg (me);
 479       return 0;
 480     }
 481   else if (p->arg_type == ARG_CMDEND)
 482     {
 483       if (token->type == T_ENDCMD || token->type == T_STOP)
 484         return me_next_arg (me);
 485       macro_tokens_add (arg, mt);
 486       return 0;
 487     }
 488   else
 489     {
 490       const struct token *end
 491         = p->arg_type == ARG_CHAREND ? &p->charend : &p->enclose[1];
 492       if (token_equal (token, end))
 493         return me_next_arg (me);
 494       macro_tokens_add (arg, mt);
 495       return 0;
 496     }
 497 }
 498
 499 static int
 500 me_expected (struct macro_expander *me, const struct macro_token *actual,
 501              const struct token *expected)
 502 {
 503   const struct substring actual_s
 504     = (actual->representation.length ? actual->representation
 505        : ss_cstr (_("<end of input>")));
 506   char *expected_s = token_to_string (expected);
 507   msg (SE, _("Found `%.*s' while expecting `%s' reading argument %s "
 508              "to macro %s."),
 509        (int) actual_s.length, actual_s.string, expected_s,
 510        me->param->name, me->macro->name);
 511   free (expected_s);
 512
 513   return me_error (me);
 514 }
 515
 516 static int
 517 me_enclose (struct macro_expander *me, const struct macro_token *mt)
 518 {
 519   const struct token *token = &mt->token;
 520   me->n_tokens++;
 521
 522   if (token_equal (&me->param->enclose[0], token))
 523     {
 524       me->state = ME_ARG;
 525       return 0;
 526     }
 527
 528   return me_expected (me, mt, &me->param->enclose[0]);
 529 }
 530
 531 static const struct macro_param *
 532 macro_find_parameter_by_name (const struct macro *m, struct substring name)
 533 {
 534   for (size_t i = 0; i < m->n_params; i++)
 535     {
 536       const struct macro_param *p = &m->params[i];
 537       struct substring p_name = ss_cstr (p->name);
 538       if (!utf8_strncasecmp (p_name.string, p_name.length,
 539                              name.string, name.length))
 540         return p;
 541     }
 542   return NULL;
 543 }
 544
 545 static int
 546 me_keyword (struct macro_expander *me, const struct macro_token *mt)
 547 {
 548   const struct token *token = &mt->token;
 549   if (token->type != T_ID)
 550     return me_finished (me);
 551
 552   const struct macro_param *p = macro_find_parameter_by_name (me->macro,
 553                                                               token->string);
 554   if (p)
 555     {
 556       size_t arg_index = p - me->macro->params;
 557       me->param = p;
 558       if (me->args[arg_index])
 559         {
 560           msg (SE,
 561                _("Argument %s multiply specified in call to macro %s."),
 562                p->name, me->macro->name);
 563           return me_error (me);
 564         }
 565
 566       me->n_tokens++;
 567       me->state = ME_EQUALS;
 568       return 0;
 569     }
 570
 571   return me_finished (me);
 572 }
 573
 574 static int
 575 me_equals (struct macro_expander *me, const struct macro_token *mt)
 576 {
 577   const struct token *token = &mt->token;
 578   me->n_tokens++;
 579
 580   if (token->type == T_EQUALS)
 581     {
 582       me->state = ME_ARG;
 583       return 0;
 584     }
 585
 586   return me_expected (me, mt, &(struct token) { .type = T_EQUALS });
 587 }
 588
 589 int
 590 macro_expander_create (const struct macro_set *macros,
 591                        const struct token *token,
 592                        struct macro_expander **mep)
 593 {
 594   *mep = NULL;
 595   if (macro_set_is_empty (macros))
 596     return -1;
 597   if (token->type != T_ID && token->type != T_MACRO_ID)
 598     return -1;
 599
 600   const struct macro *macro = macro_set_find (macros, token->string.string);
 601   if (!macro)
 602     return -1;
 603
 604   struct macro_expander *me = xmalloc (sizeof *me);
 605   *me = (struct macro_expander) {
 606     .macros = macros,
 607     .n_tokens = 1,
 608     .macro = macro,
 609   };
 610   *mep = me;
 611
 612   if (!macro->n_params)
 613     return 1;
 614   else
 615     {
 616       me->state = macro->params[0].positional ? ME_ARG : ME_KEYWORD;
 617       me->args = xcalloc (macro->n_params, sizeof *me->args);
 618       me->param = macro->params;
 619       return 0;
 620     }
 621 }
 622
 623 void
 624 macro_expander_destroy (struct macro_expander *me)
 625 {
 626   if (!me)
 627     return;
 628
 629   for (size_t i = 0; i < me->macro->n_params; i++)
 630     if (me->args[i])
 631       {
 632         macro_tokens_uninit (me->args[i]);
 633         free (me->args[i]);
 634       }
 635   free (me->args);
 636   free (me);
 637 }
 638
 639 /* Adds TOKEN to the collection of tokens in ME that potentially need to be
 640    macro expanded.
 641
 642    Returns -1 if the tokens added do not actually invoke a macro.  The caller
 643    should consume the first token without expanding it.
 644
 645    Returns 0 if the macro expander needs more tokens, for macro arguments or to
 646    decide whether this is actually a macro invocation.  The caller should call
 647    macro_expander_add() again with the next token.
 648
 649    Returns a positive number to indicate that the returned number of tokens
 650    invoke a macro.  The number returned might be less than the number of tokens
 651    added because it can take a few tokens of lookahead to determine whether the
 652    macro invocation is finished.  The caller should call
 653    macro_expander_get_expansion() to obtain the expansion. */
 654 int
 655 macro_expander_add (struct macro_expander *me, const struct macro_token *mt)
 656 {
 657   switch (me->state)
 658     {
 659     case ME_ERROR:
 660       return -1;
 661
 662     case ME_ARG:
 663       return me_add_arg (me, mt);
 664
 665     case ME_ENCLOSE:
 666       return me_enclose (me, mt);
 667
 668     case ME_KEYWORD:
 669       return me_keyword (me, mt);
 670
 671     case ME_EQUALS:
 672       return me_equals (me, mt);
 673
 674     default:
 675       NOT_REACHED ();
 676     }
 677 }
 678
 679 /* Each argument to a macro function is one of:
 680
 681        - A quoted string or other single literal token.
 682
 683        - An argument to the macro being expanded, e.g. !1 or a named argument.
 684
 685        - !*.
 686
 687        - A function invocation.
 688
 689    Each function invocation yields a character sequence to be turned into a
 690    sequence of tokens.  The case where that character sequence is a single
 691    quoted string is an important special case.
 692 */
 693 struct parse_macro_function_ctx
 694   {
 695     struct macro_token *input;
 696     size_t n_input;
 697     int nesting_countdown;
 698     const struct macro_set *macros;
 699     const struct macro_expander *me;
 700     bool *expand;
 701   };
 702
 703 static void
 704 macro_expand (const struct macro_tokens *,
 705               int nesting_countdown, const struct macro_set *,
 706               const struct macro_expander *, bool *expand, struct macro_tokens *exp);
 707
 708 static bool
 709 expand_macro_function (struct parse_macro_function_ctx *ctx,
 710                        struct macro_token *output,
 711                        size_t *input_consumed);
 712
 713 static size_t
 714 parse_function_arg (struct parse_macro_function_ctx *ctx,
 715                     size_t i, struct macro_token *farg)
 716 {
 717   struct macro_token *tokens = ctx->input;
 718   const struct token *token = &tokens[i].token;
 719   if (token->type == T_MACRO_ID)
 720     {
 721       const struct macro_param *param = macro_find_parameter_by_name (
 722         ctx->me->macro, token->string);
 723       if (param)
 724         {
 725           size_t param_idx = param - ctx->me->macro->params;
 726           const struct macro_tokens *marg = ctx->me->args[param_idx];
 727           if (marg->n == 1)
 728             macro_token_copy (farg, &marg->mts[0]);
 729           else
 730             {
 731               struct string s = DS_EMPTY_INITIALIZER;
 732               for (size_t i = 0; i < marg->n; i++)
 733                 {
 734                   if (i)
 735                     ds_put_byte (&s, ' ');
 736                   ds_put_substring (&s, marg->mts[i].representation);
 737                 }
 738
 739               struct substring s_copy;
 740               ss_alloc_substring (&s_copy, s.ss);
 741
 742               *farg = (struct macro_token) {
 743                 .token = { .type = T_MACRO_ID, .string = s.ss },
 744                 .representation = s_copy,
 745               };
 746             }
 747           return 1;
 748         }
 749
 750       struct parse_macro_function_ctx subctx = {
 751         .input = &ctx->input[i],
 752         .n_input = ctx->n_input - i,
 753         .nesting_countdown = ctx->nesting_countdown,
 754         .macros = ctx->macros,
 755         .me = ctx->me,
 756         .expand = ctx->expand,
 757       };
 758       size_t subinput_consumed;
 759       if (expand_macro_function (&subctx, farg, &subinput_consumed))
 760         return subinput_consumed;
 761     }
 762
 763   macro_token_copy (farg, &tokens[i]);
 764   return 1;
 765 }
 766
 767 static bool
 768 parse_macro_function (struct parse_macro_function_ctx *ctx,
 769                       struct macro_tokens *args,
 770                       struct substring function,
 771                       int min_args, int max_args,
 772                       size_t *input_consumed)
 773 {
 774   struct macro_token *tokens = ctx->input;
 775   size_t n_tokens = ctx->n_input;
 776
 777   if (!n_tokens
 778       || tokens[0].token.type != T_MACRO_ID
 779       || !ss_equals_case (tokens[0].token.string, function))
 780     return false;
 781
 782   if (n_tokens < 2 || tokens[1].token.type != T_LPAREN)
 783     {
 784       printf ("`(' expected following %s'\n", function.string);
 785       return false;
 786     }
 787
 788   *args = (struct macro_tokens) { .n = 0 };
 789
 790   for (size_t i = 2;; )
 791     {
 792       if (i >= n_tokens)
 793         goto unexpected_end;
 794       if (tokens[i].token.type == T_RPAREN)
 795         {
 796           *input_consumed = i + 1;
 797           if (args->n < min_args || args->n > max_args)
 798             {
 799               printf ("Wrong number of arguments to %s.\n", function.string);
 800               goto error;
 801             }
 802           return true;
 803         }
 804
 805       i += parse_function_arg (ctx, i, macro_tokens_add_uninit (args));
 806       if (i >= n_tokens)
 807         goto unexpected_end;
 808
 809       if (tokens[i].token.type == T_COMMA)
 810         i++;
 811       else if (tokens[i].token.type != T_RPAREN)
 812         {
 813           printf ("Expecting `,' or `)' in %s invocation.", function.string);
 814           goto error;
 815         }
 816     }
 817
 818 unexpected_end:
 819   printf ("Missing closing parenthesis in arguments to %s.\n",
 820           function.string);
 821   /* Fall through. */
 822 error:
 823   macro_tokens_uninit (args);
 824   return false;
 825 }
 826
 827 static bool
 828 expand_macro_function (struct parse_macro_function_ctx *ctx,
 829                        struct macro_token *output,
 830                        size_t *input_consumed)
 831 {
 832   struct macro_tokens args;
 833
 834   if (parse_macro_function (ctx, &args, ss_cstr ("!length"), 1, 1,
 835                             input_consumed))
 836     {
 837       size_t length = args.mts[0].representation.length;
 838       *output = (struct macro_token) {
 839         .token = { .type = T_POS_NUM, .number = length },
 840         .representation = ss_cstr (xasprintf ("%zu", length)),
 841       };
 842     }
 843   else if (parse_macro_function (ctx, &args, ss_cstr ("!blanks"), 1, 1,
 844                                  input_consumed))
 845     {
 846       /* XXX this isn't right, it might be a character string containing a
 847          positive integer, e.g. via !CONCAT. */
 848       if (args.mts[0].token.type != T_POS_NUM)
 849         {
 850           printf ("argument to !BLANKS must be positive integer\n");
 851           macro_tokens_uninit (&args);
 852           return false;
 853         }
 854
 855       struct string s = DS_EMPTY_INITIALIZER;
 856       ds_put_byte_multiple (&s, ' ', args.mts[0].token.number);
 857
 858       struct substring s_copy;
 859       ss_alloc_substring (&s_copy, s.ss);
 860
 861       *output = (struct macro_token) {
 862         .token = { .type = T_ID, .string = s.ss },
 863         .representation = s_copy,
 864       };
 865     }
 866   else if (parse_macro_function (ctx, &args, ss_cstr ("!concat"), 1, INT_MAX,
 867                                  input_consumed))
 868     {
 869       struct string s;
 870       bool all_strings = true;
 871       for (size_t i = 0; i < args.n; i++)
 872         {
 873           if (args.mts[i].token.type == T_STRING)
 874             ds_put_substring (&s, args.mts[i].token.string);
 875           else
 876             {
 877               all_strings = false;
 878               ds_put_substring (&s, args.mts[i].representation);
 879             }
 880         }
 881
 882       if (all_strings)
 883         {
 884           *output = (struct macro_token) {
 885             .token = { .type = T_STRING, .string = s.ss },
 886           };
 887           output->representation = ss_cstr (token_to_string (&output->token));
 888         }
 889       else
 890         {
 891           *output = (struct macro_token) {
 892             .token = { .type = T_MACRO_ID /*XXX*/, .string = s.ss },
 893           };
 894           ss_alloc_substring (&output->representation, s.ss);
 895         }
 896     }
 897   else if (parse_macro_function (ctx, &args, ss_cstr ("!quote"), 1, 1,
 898                                  input_consumed))
 899     {
 900       if (args.mts[0].token.type == T_STRING)
 901         macro_token_copy (output, &args.mts[0]);
 902       else
 903         {
 904           *output = (struct macro_token) { .token = { .type = T_STRING } };
 905           ss_alloc_substring (&output->token.string, args.mts[0].representation);
 906           output->representation = ss_cstr (token_to_string (&output->token));
 907         }
 908     }
 909   else if (parse_macro_function (ctx, &args, ss_cstr ("!unquote"), 1, 1,
 910                                  input_consumed))
 911     {
 912       if (args.mts[0].token.type == T_STRING)
 913         {
 914           *output = (struct macro_token) { .token = { .type = T_MACRO_ID } };
 915           ss_alloc_substring (&output->token.string, args.mts[0].token.string);
 916           output->representation = ss_cstr (token_to_string (&output->token));
 917         }
 918       else
 919         macro_token_copy (output, &args.mts[0]);
 920     }
 921   else
 922     return false;
 923
 924   macro_tokens_uninit (&args);
 925   return true;
 926 }
 927
 928 static void
 929 macro_expand (const struct macro_tokens *mts,
 930               int nesting_countdown, const struct macro_set *macros,
 931               const struct macro_expander *me, bool *expand,
 932               struct macro_tokens *exp)
 933 {
 934   if (nesting_countdown <= 0)
 935     {
 936       printf ("maximum nesting level exceeded\n");
 937       for (size_t i = 0; i < mts->n; i++)
 938         macro_tokens_add (exp, &mts->mts[i]);
 939       return;
 940     }
 941
 942   for (size_t i = 0; i < mts->n; i++)
 943     {
 944       const struct macro_token *mt = &mts->mts[i];
 945       const struct token *token = &mt->token;
 946       if (token->type == T_MACRO_ID && me)
 947         {
 948           const struct macro_param *param = macro_find_parameter_by_name (
 949             me->macro, token->string);
 950           if (param)
 951             {
 952               const struct macro_tokens *arg = me->args[param - me->macro->params];
 953               //macro_tokens_print (arg, stdout);
 954               if (*expand && param->expand_arg)
 955                 macro_expand (arg, nesting_countdown, macros, NULL, expand, exp);
 956               else
 957                 for (size_t i = 0; i < arg->n; i++)
 958                   macro_tokens_add (exp, &arg->mts[i]);
 959               continue;
 960             }
 961         }
 962
 963       if (*expand)
 964         {
 965           struct macro_expander *subme;
 966           int retval = macro_expander_create (macros, token, &subme);
 967           for (size_t j = 1; !retval; j++)
 968             {
 969               const struct macro_token endcmd = { .token = { .type = T_ENDCMD } };
 970               retval = macro_expander_add (
 971                 subme, i + j < mts->n ? &mts->mts[i + j] : &endcmd);
 972             }
 973           if (retval > 0)
 974             {
 975               i += retval - 1;
 976               macro_expand (&subme->macro->body, nesting_countdown - 1, macros,
 977                             subme, expand, exp);
 978               macro_expander_destroy (subme);
 979               continue;
 980             }
 981
 982           macro_expander_destroy (subme);
 983         }
 984
 985       if (token->type != T_MACRO_ID)
 986         {
 987           macro_tokens_add (exp, mt);
 988           continue;
 989         }
 990
 991       /* Maybe each arg should just be a string, either a quoted string or a
 992          non-quoted string containing tokens. */
 993       struct parse_macro_function_ctx ctx = {
 994         .input = &mts->mts[i],
 995         .n_input = mts->n - i,
 996         .nesting_countdown = nesting_countdown,
 997         .macros = macros,
 998         .me = me,
 999         .expand = expand,
1000       };
1001       struct macro_token function_output;
1002       size_t function_consumed;
1003       if (expand_macro_function (&ctx, &function_output, &function_consumed))
1004         {
1005           i += function_consumed - 1;
1006
1007           if (function_output.token.type == T_MACRO_ID)
1008             macro_tokens_from_string (exp, function_output.token.string,
1009                                       SEG_MODE_INTERACTIVE /* XXX */);
1010           else
1011             macro_tokens_add (exp, &function_output);
1012           macro_token_uninit (&function_output);
1013
1014           continue;
1015         }
1016
1017       if (ss_equals_case (token->string, ss_cstr ("!onexpand")))
1018         *expand = true;
1019       else if (ss_equals_case (token->string, ss_cstr ("!offexpand")))
1020         *expand = false;
1021       else
1022         macro_tokens_add (exp, mt);
1023     }
1024 }
1025
1026 void
1027 macro_expander_get_expansion (struct macro_expander *me, struct macro_tokens *exp)
1028 {
1029 #if 0
1030   for (size_t i = 0; i < me->macro->n_params; i++)
1031     {
1032       printf ("%s:\n", me->macro->params[i].name);
1033       macro_tokens_print (me->args[i], stdout);
1034     }
1035 #endif
1036
1037   bool expand = true;
1038   macro_expand (&me->macro->body, settings_get_mnest (),
1039                 me->macros, me, &expand, exp);
1040
1041 #if 0
1042   printf ("expansion:\n");
1043   macro_tokens_print (exp, stdout);
1044 #endif
1045 }
1046