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