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/>. */
23 #include "libpspp/hmap.h"
24 #include "libpspp/str.h"
25 #include "language/lexer/segment.h"
26 #include "language/lexer/token.h"
30 /* A token along with the syntax that was tokenized to produce it. The syntax
31 allows the token to be turned back into syntax accurately. */
35 struct substring syntax;
38 void macro_token_copy (struct macro_token *, const struct macro_token *);
39 void macro_token_uninit (struct macro_token *);
41 void macro_token_to_syntax (struct macro_token *, struct string *);
43 bool is_macro_keyword (struct substring);
45 /* A dynamic array of macro tokens.
47 The syntax for the tokens doesn't include white space, etc. between them. */
50 struct macro_token *mts;
55 void macro_tokens_copy (struct macro_tokens *, const struct macro_tokens *);
56 void macro_tokens_uninit (struct macro_tokens *);
57 struct macro_token *macro_tokens_add_uninit (struct macro_tokens *);
58 void macro_tokens_add (struct macro_tokens *, const struct macro_token *);
60 void macro_tokens_from_string (struct macro_tokens *, const struct substring,
63 void macro_tokens_to_syntax (struct macro_tokens *, struct string *,
64 size_t *ofs, size_t *len);
66 void macro_tokens_print (const struct macro_tokens *, FILE *);
68 /* A parameter to a macro. */
71 bool positional; /* Is this a positional parameter? */
72 char *name; /* "!1" or "!name". */
73 struct macro_tokens def; /* Default expansion. */
74 bool expand_arg; /* Macro-expand the argument? */
85 int n_tokens; /* ARG_N_TOKENS only. */
86 struct token start; /* ARG_ENCLOSE only. */
87 struct token end; /* ARG_ENCLOSE and ARG_CHAREND only. */
93 struct hmap_node hmap_node; /* Indexed by 'name'. */
96 /* Source code location of macro definition, for error reporting. */
97 struct msg_location *location;
100 struct macro_param *params;
104 struct macro_tokens body;
107 void macro_destroy (struct macro *);
109 /* A collection of macros. */
115 struct macro_set *macro_set_create (void);
116 void macro_set_destroy (struct macro_set *);
117 const struct macro *macro_set_find (const struct macro_set *,
119 void macro_set_add (struct macro_set *, struct macro *);
122 macro_set_is_empty (const struct macro_set *set)
124 return hmap_is_empty (&set->macros);
127 /* Parsing and expanding macro calls. */
131 int macro_call_create (const struct macro_set *, const struct token *,
132 struct macro_call **);
133 int macro_call_add (struct macro_call *, const struct macro_token *,
134 const struct msg_location *);
136 void macro_call_expand (struct macro_call *, enum segmenter_mode segmenter_mode,
137 const struct msg_location *call_loc, struct macro_tokens *);
139 void macro_call_destroy (struct macro_call *);