1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2021 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "language/lexer/macro.h"
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"
33 #define _(msgid) gettext (msgid)
36 macro_token_copy (struct macro_token *dst, const struct macro_token *src)
38 token_copy (&dst->token, &src->token);
39 ss_alloc_substring (&dst->representation, src->representation);
43 macro_token_uninit (struct macro_token *mt)
45 token_uninit (&mt->token);
46 ss_dealloc (&mt->representation);
50 macro_token_to_representation (struct macro_token *mt, struct string *s)
52 ds_put_substring (s, mt->representation);
56 macro_tokens_copy (struct macro_tokens *dst, const struct macro_tokens *src)
58 *dst = (struct macro_tokens) {
59 .mts = xmalloc (src->n * sizeof *dst->mts),
63 for (size_t i = 0; i < src->n; i++)
64 macro_token_copy (&dst->mts[i], &src->mts[i]);
68 macro_tokens_uninit (struct macro_tokens *mts)
70 for (size_t i = 0; i < mts->n; i++)
71 macro_token_uninit (&mts->mts[i]);
76 macro_tokens_add_uninit (struct macro_tokens *mts)
78 if (mts->n >= mts->allocated)
79 mts->mts = x2nrealloc (mts->mts, &mts->allocated, sizeof *mts->mts);
80 return &mts->mts[mts->n++];
84 macro_tokens_add (struct macro_tokens *mts, const struct macro_token *mt)
86 macro_token_copy (macro_tokens_add_uninit (mts), mt);
90 macro_tokens_from_string (struct macro_tokens *mts, const struct substring src,
91 enum segmenter_mode mode)
95 struct segmenter segmenter;
96 struct substring body;
99 struct state state = {
100 .segmenter = SEGMENTER_INIT (mode),
103 struct state saved = state;
105 while (state.body.length > 0)
107 struct macro_token mt = {
108 .token = { .type = T_STOP },
109 .representation = { .string = state.body.string },
111 struct token *token = &mt.token;
113 struct scanner scanner;
114 scanner_init (&scanner, token);
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);
123 struct substring segment = ss_head (state.body, seg_len);
124 ss_advance (&state.body, seg_len);
126 enum scan_result result = scanner_push (&scanner, type, segment, token);
127 if (result == SCAN_SAVE)
129 else if (result == SCAN_BACK)
134 else if (result == SCAN_DONE)
138 /* We have a token in 'token'. */
139 if (is_scan_type (token->type))
141 if (token->type != SCAN_SKIP)
143 /* XXX report error */
148 mt.representation.length = state.body.string - mt.representation.string;
149 macro_tokens_add (mts, &mt);
151 token_uninit (token);
156 macro_tokens_print (const struct macro_tokens *mts, FILE *stream)
158 for (size_t i = 0; i < mts->n; i++)
159 token_print (&mts->mts[i].token, stream);
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. */
172 needs_space (enum token_class prev, enum token_class next)
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)
179 /* Binary operators always have a space on both sides. */
180 if (prev == TC_BINOP || next == TC_BINOP)
183 /* A comma always has a space afterward. */
184 if (prev == TC_COMMA)
187 /* Otherwise, PREV is TC_ID or TC_PUNCT, which only need a space if there are
188 two or them in a row. */
192 static enum token_class
193 classify_token (enum token_type type)
246 macro_tokens_to_representation (struct macro_tokens *mts, struct string *s)
251 macro_token_to_representation (&mts->mts[0], s);
252 for (size_t i = 1; i < mts->n; i++)
254 enum token_type prev = mts->mts[i - 1].token.type;
255 enum token_type next = mts->mts[i].token.type;
257 if (prev == T_ENDCMD)
258 ds_put_byte (s, '\n');
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, ' ');
267 macro_token_to_representation (&mts->mts[i], s);
272 macro_destroy (struct macro *m)
278 for (size_t i = 0; i < m->n_params; i++)
280 struct macro_param *p = &m->params[i];
283 macro_tokens_uninit (&p->def);
291 token_uninit (&p->charend);
295 token_uninit (&p->enclose[0]);
296 token_uninit (&p->enclose[1]);
304 macro_tokens_uninit (&m->body);
309 macro_set_create (void)
311 struct macro_set *set = xmalloc (sizeof *set);
312 *set = (struct macro_set) {
313 .macros = HMAP_INITIALIZER (set->macros),
319 macro_set_destroy (struct macro_set *set)
324 struct macro *macro, *next;
325 HMAP_FOR_EACH_SAFE (macro, next, struct macro, hmap_node, &set->macros)
327 hmap_delete (&set->macros, ¯o->hmap_node);
328 macro_destroy (macro);
330 hmap_destroy (&set->macros);
335 hash_macro_name (const char *name)
337 return utf8_hash_case_string (name, 0);
340 static struct macro *
341 macro_set_find__ (struct macro_set *set, const char *name)
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))
353 macro_set_find (const struct macro_set *set, const char *name)
355 return macro_set_find__ (CONST_CAST (struct macro_set *, set), name);
358 /* Adds M to SET. M replaces any existing macro with the same name. Takes
361 macro_set_add (struct macro_set *set, struct macro *m)
363 struct macro *victim = macro_set_find__ (set, m->name);
366 hmap_delete (&set->macros, &victim->hmap_node);
367 macro_destroy (victim);
370 hmap_insert (&set->macros, &m->hmap_node, hash_macro_name (m->name));
378 /* Accumulating tokens in me->params toward the end of any type of
382 /* Expecting the opening delimiter of an ARG_ENCLOSE argument. */
385 /* Expecting a keyword for a keyword argument. */
388 /* Expecting an equal sign for a keyword argument. */
393 struct macro_expander
395 const struct macro_set *macros;
400 const struct macro *macro;
401 struct macro_tokens **args;
402 const struct macro_param *param;
406 me_finished (struct macro_expander *me)
408 for (size_t i = 0; i < me->macro->n_params; i++)
411 me->args[i] = xmalloc (sizeof *me->args[i]);
412 macro_tokens_copy (me->args[i], &me->macro->params[i].def);
418 me_next_arg (struct macro_expander *me)
422 assert (!me->macro->n_params);
423 return me_finished (me);
425 else if (me->param->positional)
428 if (me->param >= &me->macro->params[me->macro->n_params])
429 return me_finished (me);
432 me->state = me->param->positional ? ME_ARG : ME_KEYWORD;
438 for (size_t i = 0; i < me->macro->n_params; i++)
441 me->state = ME_KEYWORD;
444 return me_finished (me);
449 me_error (struct macro_expander *me)
451 me->state = ME_ERROR;
456 me_add_arg (struct macro_expander *me, const struct macro_token *mt)
458 const struct token *token = &mt->token;
459 if (token->type == T_ENDCMD || token->type == T_STOP)
461 msg (SE, _("Unexpected end of command reading argument %s "
462 "to macro %s."), me->param->name, me->macro->name);
464 return me_error (me);
469 const struct macro_param *p = me->param;
470 struct macro_tokens **argp = &me->args[p - me->macro->params];
472 *argp = xzalloc (sizeof **argp);
473 struct macro_tokens *arg = *argp;
474 if (p->arg_type == ARG_N_TOKENS)
476 macro_tokens_add (arg, mt);
477 if (arg->n >= p->n_tokens)
478 return me_next_arg (me);
481 else if (p->arg_type == ARG_CMDEND)
483 if (token->type == T_ENDCMD || token->type == T_STOP)
484 return me_next_arg (me);
485 macro_tokens_add (arg, mt);
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);
500 me_expected (struct macro_expander *me, const struct macro_token *actual,
501 const struct token *expected)
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 "
509 (int) actual_s.length, actual_s.string, expected_s,
510 me->param->name, me->macro->name);
513 return me_error (me);
517 me_enclose (struct macro_expander *me, const struct macro_token *mt)
519 const struct token *token = &mt->token;
522 if (token_equal (&me->param->enclose[0], token))
528 return me_expected (me, mt, &me->param->enclose[0]);
531 static const struct macro_param *
532 macro_find_parameter_by_name (const struct macro *m, struct substring name)
534 for (size_t i = 0; i < m->n_params; i++)
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))
546 me_keyword (struct macro_expander *me, const struct macro_token *mt)
548 const struct token *token = &mt->token;
549 if (token->type != T_ID)
550 return me_finished (me);
552 const struct macro_param *p = macro_find_parameter_by_name (me->macro,
556 size_t arg_index = p - me->macro->params;
558 if (me->args[arg_index])
561 _("Argument %s multiply specified in call to macro %s."),
562 p->name, me->macro->name);
563 return me_error (me);
567 me->state = ME_EQUALS;
571 return me_finished (me);
575 me_equals (struct macro_expander *me, const struct macro_token *mt)
577 const struct token *token = &mt->token;
580 if (token->type == T_EQUALS)
586 return me_expected (me, mt, &(struct token) { .type = T_EQUALS });
590 macro_expander_create (const struct macro_set *macros,
591 const struct token *token,
592 struct macro_expander **mep)
595 if (macro_set_is_empty (macros))
597 if (token->type != T_ID && token->type != T_MACRO_ID)
600 const struct macro *macro = macro_set_find (macros, token->string.string);
604 struct macro_expander *me = xmalloc (sizeof *me);
605 *me = (struct macro_expander) {
612 if (!macro->n_params)
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;
624 macro_expander_destroy (struct macro_expander *me)
629 for (size_t i = 0; i < me->macro->n_params; i++)
632 macro_tokens_uninit (me->args[i]);
639 /* Adds TOKEN to the collection of tokens in ME that potentially need to be
642 Returns -1 if the tokens added do not actually invoke a macro. The caller
643 should consume the first token without expanding it.
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.
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. */
655 macro_expander_add (struct macro_expander *me, const struct macro_token *mt)
663 return me_add_arg (me, mt);
666 return me_enclose (me, mt);
669 return me_keyword (me, mt);
672 return me_equals (me, mt);
679 /* Each argument to a macro function is one of:
681 - A quoted string or other single literal token.
683 - An argument to the macro being expanded, e.g. !1 or a named argument.
687 - A function invocation.
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.
693 struct parse_macro_function_ctx
695 struct macro_token *input;
697 int nesting_countdown;
698 const struct macro_set *macros;
699 const struct macro_expander *me;
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);
709 expand_macro_function (struct parse_macro_function_ctx *ctx,
710 struct macro_token *output,
711 size_t *input_consumed);
714 parse_function_arg (struct parse_macro_function_ctx *ctx,
715 size_t i, struct macro_token *farg)
717 struct macro_token *tokens = ctx->input;
718 const struct token *token = &tokens[i].token;
719 if (token->type == T_MACRO_ID)
721 const struct macro_param *param = macro_find_parameter_by_name (
722 ctx->me->macro, token->string);
725 size_t param_idx = param - ctx->me->macro->params;
726 const struct macro_tokens *marg = ctx->me->args[param_idx];
728 macro_token_copy (farg, &marg->mts[0]);
731 struct string s = DS_EMPTY_INITIALIZER;
732 for (size_t i = 0; i < marg->n; i++)
735 ds_put_byte (&s, ' ');
736 ds_put_substring (&s, marg->mts[i].representation);
739 struct substring s_copy;
740 ss_alloc_substring (&s_copy, s.ss);
742 *farg = (struct macro_token) {
743 .token = { .type = T_MACRO_ID, .string = s.ss },
744 .representation = s_copy,
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,
756 .expand = ctx->expand,
758 size_t subinput_consumed;
759 if (expand_macro_function (&subctx, farg, &subinput_consumed))
760 return subinput_consumed;
763 macro_token_copy (farg, &tokens[i]);
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)
774 struct macro_token *tokens = ctx->input;
775 size_t n_tokens = ctx->n_input;
778 || tokens[0].token.type != T_MACRO_ID
779 || !ss_equals_case (tokens[0].token.string, function))
782 if (n_tokens < 2 || tokens[1].token.type != T_LPAREN)
784 printf ("`(' expected following %s'\n", function.string);
788 *args = (struct macro_tokens) { .n = 0 };
790 for (size_t i = 2;; )
794 if (tokens[i].token.type == T_RPAREN)
796 *input_consumed = i + 1;
797 if (args->n < min_args || args->n > max_args)
799 printf ("Wrong number of arguments to %s.\n", function.string);
805 i += parse_function_arg (ctx, i, macro_tokens_add_uninit (args));
809 if (tokens[i].token.type == T_COMMA)
811 else if (tokens[i].token.type != T_RPAREN)
813 printf ("Expecting `,' or `)' in %s invocation.", function.string);
819 printf ("Missing closing parenthesis in arguments to %s.\n",
823 macro_tokens_uninit (args);
828 expand_macro_function (struct parse_macro_function_ctx *ctx,
829 struct macro_token *output,
830 size_t *input_consumed)
832 struct macro_tokens args;
834 if (parse_macro_function (ctx, &args, ss_cstr ("!length"), 1, 1,
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)),
843 else if (parse_macro_function (ctx, &args, ss_cstr ("!blanks"), 1, 1,
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)
850 printf ("argument to !BLANKS must be positive integer\n");
851 macro_tokens_uninit (&args);
855 struct string s = DS_EMPTY_INITIALIZER;
856 ds_put_byte_multiple (&s, ' ', args.mts[0].token.number);
858 struct substring s_copy;
859 ss_alloc_substring (&s_copy, s.ss);
861 *output = (struct macro_token) {
862 .token = { .type = T_ID, .string = s.ss },
863 .representation = s_copy,
866 else if (parse_macro_function (ctx, &args, ss_cstr ("!concat"), 1, INT_MAX,
870 bool all_strings = true;
871 for (size_t i = 0; i < args.n; i++)
873 if (args.mts[i].token.type == T_STRING)
874 ds_put_substring (&s, args.mts[i].token.string);
878 ds_put_substring (&s, args.mts[i].representation);
884 *output = (struct macro_token) {
885 .token = { .type = T_STRING, .string = s.ss },
887 output->representation = ss_cstr (token_to_string (&output->token));
891 *output = (struct macro_token) {
892 .token = { .type = T_MACRO_ID /*XXX*/, .string = s.ss },
894 ss_alloc_substring (&output->representation, s.ss);
897 else if (parse_macro_function (ctx, &args, ss_cstr ("!quote"), 1, 1,
900 if (args.mts[0].token.type == T_STRING)
901 macro_token_copy (output, &args.mts[0]);
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));
909 else if (parse_macro_function (ctx, &args, ss_cstr ("!unquote"), 1, 1,
912 if (args.mts[0].token.type == T_STRING)
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));
919 macro_token_copy (output, &args.mts[0]);
924 macro_tokens_uninit (&args);
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)
934 if (nesting_countdown <= 0)
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]);
942 for (size_t i = 0; i < mts->n; i++)
944 const struct macro_token *mt = &mts->mts[i];
945 const struct token *token = &mt->token;
946 if (token->type == T_MACRO_ID && me)
948 const struct macro_param *param = macro_find_parameter_by_name (
949 me->macro, token->string);
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);
957 for (size_t i = 0; i < arg->n; i++)
958 macro_tokens_add (exp, &arg->mts[i]);
965 struct macro_expander *subme;
966 int retval = macro_expander_create (macros, token, &subme);
967 for (size_t j = 1; !retval; j++)
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);
976 macro_expand (&subme->macro->body, nesting_countdown - 1, macros,
978 macro_expander_destroy (subme);
982 macro_expander_destroy (subme);
985 if (token->type != T_MACRO_ID)
987 macro_tokens_add (exp, mt);
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,
1001 struct macro_token function_output;
1002 size_t function_consumed;
1003 if (expand_macro_function (&ctx, &function_output, &function_consumed))
1005 i += function_consumed - 1;
1007 if (function_output.token.type == T_MACRO_ID)
1008 macro_tokens_from_string (exp, function_output.token.string,
1009 SEG_MODE_INTERACTIVE /* XXX */);
1011 macro_tokens_add (exp, &function_output);
1012 macro_token_uninit (&function_output);
1017 if (ss_equals_case (token->string, ss_cstr ("!onexpand")))
1019 else if (ss_equals_case (token->string, ss_cstr ("!offexpand")))
1022 macro_tokens_add (exp, mt);
1027 macro_expander_get_expansion (struct macro_expander *me, struct macro_tokens *exp)
1030 for (size_t i = 0; i < me->macro->n_params; i++)
1032 printf ("%s:\n", me->macro->params[i].name);
1033 macro_tokens_print (me->args[i], stdout);
1038 macro_expand (&me->macro->body, settings_get_mnest (),
1039 me->macros, me, &expand, exp);
1042 printf ("expansion:\n");
1043 macro_tokens_print (exp, stdout);