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/>. */
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 #include "libpspp/message.h"
28 #include "gl/xalloc.h"
31 #define _(msgid) gettext (msgid)
34 force_macro_id (struct lexer *lexer)
36 return lex_token (lexer) == T_MACRO_ID || lex_force_id (lexer);
40 match_macro_id (struct lexer *lexer, const char *keyword)
42 if (keyword[0] != '!')
43 return lex_match_id (lexer, keyword);
44 else if (lex_token (lexer) == T_MACRO_ID
45 && lex_id_match_n (ss_cstr (keyword), lex_tokss (lexer), 4))
54 /* Obtains a quoted string from LEXER and then tokenizes the quoted string's
55 content to obtain a single TOKEN. Returns true if successful, false
56 otherwise. The caller takes ownership of TOKEN on success, otherwise TOKEN
59 parse_quoted_token (struct lexer *lexer, struct token *token)
61 if (!lex_force_string (lexer))
64 struct substring s = lex_tokss (lexer);
65 struct string_lexer slex;
66 string_lexer_init (&slex, s.string, s.length, SEG_MODE_INTERACTIVE, true);
67 struct token another_token = { .type = T_STOP };
68 if (!string_lexer_next (&slex, token)
69 || string_lexer_next (&slex, &another_token))
72 token_uninit (&another_token);
73 lex_error (lexer, _("String must contain exactly one token."));
81 cmd_define (struct lexer *lexer, struct dataset *ds UNUSED)
83 if (!force_macro_id (lexer))
86 /* Parse macro name. */
87 struct macro *m = xmalloc (sizeof *m);
89 .name = ss_xstrdup (lex_tokss (lexer)),
90 .file_name = xstrdup_if_nonnull (lex_get_file_name (lexer)),
91 .first_line = lex_get_first_line_number (lexer, 0),
95 if (!lex_force_match (lexer, T_LPAREN))
98 size_t allocated_params = 0;
99 while (!lex_match (lexer, T_RPAREN))
101 if (m->n_params >= allocated_params)
102 m->params = x2nrealloc (m->params, &allocated_params,
105 size_t param_index = m->n_params++;
106 struct macro_param *p = &m->params[param_index];
107 *p = (struct macro_param) { .expand_arg = true };
109 /* Parse parameter name. */
110 if (match_macro_id (lexer, "!POSITIONAL"))
112 if (param_index > 0 && !m->params[param_index - 1].positional)
114 lex_error (lexer, _("Positional parameters must precede "
115 "keyword parameters."));
119 p->positional = true;
120 p->name = xasprintf ("!%zu", param_index + 1);
124 if (lex_token (lexer) == T_MACRO_ID)
126 lex_error (lexer, _("Keyword macro parameter must be named in "
127 "definition without \"!\" prefix."));
130 if (!lex_force_id (lexer))
133 if (is_macro_keyword (lex_tokss (lexer)))
135 lex_error (lexer, _("Cannot use macro keyword \"%s\" "
136 "as an argument name."),
137 lex_tokcstr (lexer));
141 p->positional = false;
142 p->name = xasprintf ("!%s", lex_tokcstr (lexer));
145 if (!lex_force_match (lexer, T_EQUALS))
149 /* Parse default value. */
150 if (match_macro_id (lexer, "!DEFAULT"))
152 if (!lex_force_match (lexer, T_LPAREN))
155 /* XXX Should this handle balanced inner parentheses? */
156 while (!lex_match (lexer, T_RPAREN))
158 if (lex_token (lexer) == T_ENDCMD)
160 lex_error_expecting (lexer, ")");
163 char *syntax = lex_next_representation (lexer, 0, 0);
164 const struct macro_token mt = {
165 .token = *lex_next (lexer, 0),
166 .syntax = ss_cstr (syntax),
168 macro_tokens_add (&p->def, &mt);
175 if (match_macro_id (lexer, "!NOEXPAND"))
176 p->expand_arg = false;
178 if (match_macro_id (lexer, "!TOKENS"))
180 if (!lex_force_match (lexer, T_LPAREN)
181 || !lex_force_int_range (lexer, "!TOKENS", 1, INT_MAX))
183 p->arg_type = ARG_N_TOKENS;
184 p->n_tokens = lex_integer (lexer);
186 if (!lex_force_match (lexer, T_RPAREN))
189 else if (match_macro_id (lexer, "!CHAREND"))
191 p->arg_type = ARG_CHAREND;
192 p->charend = (struct token) { .type = T_STOP };
194 if (!lex_force_match (lexer, T_LPAREN)
195 || !parse_quoted_token (lexer, &p->charend)
196 || !lex_force_match (lexer, T_RPAREN))
199 else if (match_macro_id (lexer, "!ENCLOSE"))
201 p->arg_type = ARG_ENCLOSE;
202 p->enclose[0] = p->enclose[1] = (struct token) { .type = T_STOP };
204 if (!lex_force_match (lexer, T_LPAREN)
205 || !parse_quoted_token (lexer, &p->enclose[0])
206 || !lex_force_match (lexer, T_COMMA)
207 || !parse_quoted_token (lexer, &p->enclose[1])
208 || !lex_force_match (lexer, T_RPAREN))
211 else if (match_macro_id (lexer, "!CMDEND"))
212 p->arg_type = ARG_CMDEND;
215 lex_error_expecting (lexer, "!TOKENS", "!CHAREND",
216 "!ENCLOSE", "!CMDEND");
220 if (lex_token (lexer) != T_RPAREN && !lex_force_match (lexer, T_SLASH))
224 struct string body = DS_EMPTY_INITIALIZER;
225 while (!match_macro_id (lexer, "!ENDDEFINE"))
227 if (lex_token (lexer) != T_STRING)
229 lex_error (lexer, _("Expecting macro body or !ENDDEFINE"));
234 ds_put_substring (&body, lex_tokss (lexer));
235 ds_put_byte (&body, '\n');
238 m->last_line = lex_get_last_line_number (lexer, 0);
240 macro_tokens_from_string (&m->body, body.ss, lex_get_syntax_mode (lexer));
243 lex_define_macro (lexer, m);
253 cmd_debug_expand (struct lexer *lexer, struct dataset *ds UNUSED)
255 settings_set_mprint (true);
257 while (lex_token (lexer) != T_STOP)
259 if (!lex_next_is_from_macro (lexer, 0) && lex_token (lexer) != T_ENDCMD)
261 char *rep = lex_next_representation (lexer, 0, 0);
262 msg (MN, "unexpanded token \"%s\"", rep);