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

   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 #ifndef MACRO_H
  18 #define MACRO_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22
  23 #include "libpspp/hmap.h"
  24 #include "libpspp/str.h"
  25 #include "language/lexer/token.h"
  26
  27 struct macro_expander;
  28
  29 struct macro_param
  30   {
  31     char *name;                 /* NULL for a positional parameter. */
  32     struct tokens def;          /* Default expansion. */
  33     bool expand_arg;            /* Macro-expand the argument? */
  34
  35     enum
  36       {
  37         ARG_N_TOKENS,
  38         ARG_CHAREND,
  39         ARG_ENCLOSE,
  40         ARG_CMDEND
  41       }
  42     arg_type;
  43     union
  44       {
  45         int n_tokens;
  46         struct token charend;
  47         struct token enclose[2];
  48       };
  49   };
  50
  51 struct macro
  52   {
  53     struct hmap_node hmap_node; /* Indexed by 'name'. */
  54     char *name;
  55
  56     struct macro_param *params;
  57     size_t n_params;
  58
  59     struct substring body;
  60   };
  61
  62 void macro_destroy (struct macro *);
  63
  64 struct macro_set
  65   {
  66     struct hmap macros;
  67   };
  68
  69 struct macro_set *macro_set_create (void);
  70 void macro_set_destroy (struct macro_set *);
  71 const struct macro *macro_set_find (const struct macro_set *,
  72                                     const char *);
  73 void macro_set_add (struct macro_set *, struct macro *);
  74
  75 static inline bool
  76 macro_set_is_empty (const struct macro_set *set)
  77 {
  78   return hmap_is_empty (&set->macros);
  79 }
  80 \f
  81 /* Macro expansion. */
  82
  83 int macro_expander_create (const struct macro_set *,
  84                            const struct token *,
  85                            struct macro_expander **);
  86 void macro_expander_destroy (struct macro_expander *);
  87
  88 int macro_expander_add (struct macro_expander *, const struct token *);
  89
  90 void macro_expander_get_expansion (struct macro_expander *, struct tokens *);
  91
  92 #endif /* macro.h */