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_token
  30   {
  31     struct token token;
  32     struct substring representation;
  33   };
  34
  35 void macro_token_copy (struct macro_token *, const struct macro_token *);
  36 void macro_token_uninit (struct macro_token *);
  37
  38 struct macro_tokens
  39   {
  40     struct macro_token *mts;
  41     size_t n;
  42     size_t allocated;
  43   };
  44
  45 void macro_tokens_copy (struct macro_tokens *, const struct macro_tokens *);
  46 void macro_tokens_uninit (struct macro_tokens *);
  47 void macro_tokens_add (struct macro_tokens *, const struct macro_token *);
  48
  49 void macro_tokens_print (const struct macro_tokens *, FILE *);
  50
  51 struct macro_param
  52   {
  53     bool positional;            /* Is this a positional parameter? */
  54     char *name;                 /* "!1" or "!name". */
  55     struct macro_tokens def;    /* Default expansion. */
  56     bool expand_arg;            /* Macro-expand the argument? */
  57
  58     enum
  59       {
  60         ARG_N_TOKENS,
  61         ARG_CHAREND,
  62         ARG_ENCLOSE,
  63         ARG_CMDEND
  64       }
  65     arg_type;
  66     union
  67       {
  68         int n_tokens;
  69         struct token charend;
  70         struct token enclose[2];
  71       };
  72   };
  73
  74 struct macro
  75   {
  76     struct hmap_node hmap_node; /* Indexed by 'name'. */
  77     char *name;
  78
  79     struct macro_param *params;
  80     size_t n_params;
  81
  82     struct macro_tokens body;
  83   };
  84
  85 void macro_destroy (struct macro *);
  86
  87 struct macro_set
  88   {
  89     struct hmap macros;
  90   };
  91
  92 struct macro_set *macro_set_create (void);
  93 void macro_set_destroy (struct macro_set *);
  94 const struct macro *macro_set_find (const struct macro_set *,
  95                                     const char *);
  96 void macro_set_add (struct macro_set *, struct macro *);
  97
  98 static inline bool
  99 macro_set_is_empty (const struct macro_set *set)
 100 {
 101   return hmap_is_empty (&set->macros);
 102 }
 103 \f
 104 /* Macro expansion. */
 105
 106 int macro_expander_create (const struct macro_set *,
 107                            const struct token *,
 108                            struct macro_expander **);
 109 void macro_expander_destroy (struct macro_expander *);
 110
 111 int macro_expander_add (struct macro_expander *, const struct macro_token *);
 112
 113 void macro_expander_get_expansion (struct macro_expander *, struct macro_tokens *);
 114
 115 #endif /* macro.h */