work on macro calls
[pspp] / src / language / control / define.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 <limits.h>
20
21 #include "language/command.h"
22 #include "language/lexer/lexer.h"
23 #include "language/lexer/macro.h"
24 #include "language/lexer/scan.h"
25 #include "language/lexer/token.h"
26
27 #include "gl/xalloc.h"
28
29 #include "gettext.h"
30 #define _(msgid) gettext (msgid)
31
32 static bool
33 force_macro_id (struct lexer *lexer)
34 {
35   return lex_token (lexer) == T_MACRO_ID || lex_force_id (lexer);
36 }
37
38 static bool
39 match_macro_id (struct lexer *lexer, const char *id)
40 {
41   if (id[0] != '!')
42     return lex_match_id (lexer, id);
43   else if (lex_token (lexer) == T_MACRO_ID
44            && ss_equals_case (lex_tokss (lexer), ss_cstr (id)))
45     {
46       lex_get (lexer);
47       return true;
48     }
49   else
50     return false;
51 }
52
53 static bool
54 parse_quoted_token (struct lexer *lexer, struct token *token)
55 {
56   if (!lex_force_string (lexer))
57     return false;
58
59   struct substring s = lex_tokss (lexer);
60   struct string_lexer slex;
61   string_lexer_init (&slex, s.string, s.length, SEG_MODE_INTERACTIVE);
62   struct token another_token;
63   if (!string_lexer_next (&slex, token)
64       || string_lexer_next (&slex, &another_token))
65     {
66       token_destroy (token);
67       token_destroy (&another_token);
68       lex_error (lexer, _("String must contain exactly one token."));
69       return false;
70     }
71   return true;
72 }
73
74 int
75 cmd_define (struct lexer *lexer, struct dataset *ds UNUSED)
76 {
77   if (!force_macro_id (lexer))
78     return CMD_FAILURE;
79
80   /* Parse macro name. */
81   struct macro *m = xmalloc (sizeof *m);
82   *m = (struct macro) { .name = ss_xstrdup (lex_tokss (lexer)) };
83   lex_get (lexer);
84
85   if (!lex_force_match (lexer, T_LPAREN))
86     goto error;
87
88   size_t allocated_params = 0;
89   size_t n_keywords = 0;
90   while (!lex_match (lexer, T_RPAREN))
91     {
92       if (m->n_params >= allocated_params)
93         m->params = x2nrealloc (m->params, &allocated_params,
94                                 sizeof *m->params);
95
96       struct macro_param *p = &m->params[m->n_params++];
97       *p = (struct macro_param) { .expand_arg = true };
98
99       /* Parse parameter name. */
100       if (match_macro_id (lexer, "!POSITIONAL"))
101         {
102           if (n_keywords)
103             {
104               lex_error (lexer, _("Positional parameters must precede "
105                                   "keyword parameters."));
106               goto error;
107             }
108           p->name = NULL;
109         }
110       else
111         {
112           n_keywords++;
113
114           if (!lex_force_id (lexer) || !lex_force_match (lexer, T_EQUALS))
115             goto error;
116
117           p->name = ss_xstrdup (lex_tokss (lexer));
118           lex_get (lexer);
119         }
120
121       /* Parse default value. */
122       if (match_macro_id (lexer, "!DEFAULT"))
123         {
124           if (!lex_force_match (lexer, T_LPAREN))
125             goto error;
126
127           /* XXX Should this handle balanced inner parentheses? */
128           while (!lex_match (lexer, T_RPAREN))
129             {
130               if (lex_token (lexer) == T_ENDCMD)
131                 {
132                   lex_error_expecting (lexer, ")");
133                   goto error;
134                 }
135               tokens_add (&p->def, lex_next (lexer, 0));
136               lex_get (lexer);
137             }
138         }
139
140       if (match_macro_id (lexer, "!NOEXPAND"))
141         p->expand_arg = false;
142
143       if (match_macro_id (lexer, "!TOKENS"))
144         {
145           if (!lex_force_match (lexer, T_LPAREN)
146               || !lex_force_int_range (lexer, "!TOKENS", 1, INT_MAX))
147             goto error;
148           p->arg_type = ARG_N_TOKENS;
149           p->n_tokens = lex_integer (lexer);
150           lex_get (lexer);
151           if (!lex_force_match (lexer, T_RPAREN))
152             goto error;
153         }
154       else if (match_macro_id (lexer, "!CHAREND"))
155         {
156           p->arg_type = ARG_CHAREND;
157           p->charend = (struct token) { .type = T_STOP };
158
159           if (!lex_force_match (lexer, T_LPAREN)
160               || !parse_quoted_token (lexer, &p->charend)
161               || !lex_force_match (lexer, T_RPAREN))
162             goto error;
163         }
164       else if (match_macro_id (lexer, "!ENCLOSE"))
165         {
166           p->arg_type = ARG_ENCLOSE;
167           p->enclose[0] = p->enclose[1] = (struct token) { .type = T_STOP };
168
169           if (!lex_force_match (lexer, T_LPAREN)
170               || !parse_quoted_token (lexer, &p->enclose[0])
171               || !lex_force_match (lexer, T_COMMA)
172               || !parse_quoted_token (lexer, &p->enclose[1])
173               || !lex_force_match (lexer, T_RPAREN))
174             goto error;
175         }
176       else if (match_macro_id (lexer, "!CMDEND"))
177         p->arg_type = ARG_CMDEND;
178       else
179         {
180           lex_error_expecting (lexer, "!TOKENS", "!CHAREND",
181                                "!ENCLOSE", "!CMDEND");
182           goto error;
183         }
184
185       if (lex_token (lexer) != T_RPAREN && !lex_force_match (lexer, T_SLASH))
186         goto error;
187     }
188
189   size_t allocated_body = 0;
190   while (!match_macro_id (lexer, "!ENDDEFINE"))
191     {
192       if (lex_token (lexer) != T_STRING)
193         {
194           lex_error (lexer, _("Expecting macro body or !ENDDEFINE"));
195           goto error;
196         }
197
198       if (allocated_body >= m->n_body)
199         m->body = x2nrealloc (m->body, &allocated_body, sizeof *m->body);
200       m->body[m->n_body] = ss_xstrdup (lex_tokss (lexer));
201       lex_get (lexer);
202     }
203
204   return CMD_SUCCESS;
205
206 error:
207   macro_destroy (m);
208   return CMD_FAILURE;
209 }