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