libguile/expand.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_EXPAND_H
   4 #define SCM_EXPAND_H
   5
   6 /* Copyright (C) 2010, 2011
   7  * Free Software Foundation, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 3 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  */
  24
  25 \f
  26
  27 #include "libguile/__scm.h"
  28
  29
  30 \f
  31
  32 #ifdef BUILDING_LIBGUILE
  33
  34 /* All private for now. Ask if you want to use this. Surely this should be
  35    auto-generated by something; for now I wrangle it with keyboard macros. */
  36
  37 typedef enum
  38   {
  39     SCM_EXPANDED_VOID,
  40     SCM_EXPANDED_CONST,
  41     SCM_EXPANDED_PRIMITIVE_REF,
  42     SCM_EXPANDED_LEXICAL_REF,
  43     SCM_EXPANDED_LEXICAL_SET,
  44     SCM_EXPANDED_MODULE_REF,
  45     SCM_EXPANDED_MODULE_SET,
  46     SCM_EXPANDED_TOPLEVEL_REF,
  47     SCM_EXPANDED_TOPLEVEL_SET,
  48     SCM_EXPANDED_TOPLEVEL_DEFINE,
  49     SCM_EXPANDED_CONDITIONAL,
  50     SCM_EXPANDED_CALL,
  51     SCM_EXPANDED_PRIMCALL,
  52     SCM_EXPANDED_SEQ,
  53     SCM_EXPANDED_LAMBDA,
  54     SCM_EXPANDED_LAMBDA_CASE,
  55     SCM_EXPANDED_LET,
  56     SCM_EXPANDED_LETREC,
  57     SCM_EXPANDED_DYNLET,
  58     SCM_NUM_EXPANDED_TYPES,
  59   } scm_t_expanded_type;
  60
  61
  62 \f
  63
  64
  65 /* {Expanded Source}
  66  */
  67
  68 SCM_INTERNAL SCM scm_exp_vtable_vtable;
  69
  70 enum
  71   {
  72     SCM_EXPANDED_TYPE_NAME = scm_vtable_offset_user,
  73     SCM_EXPANDED_TYPE_CODE,
  74     SCM_EXPANDED_TYPE_FIELDS,
  75   };
  76
  77 #define SCM_EXPANDED_P(x)                                               \
  78   (SCM_STRUCTP (x)                                                      \
  79    && (scm_is_eq (SCM_STRUCT_VTABLE (SCM_STRUCT_VTABLE (x)), scm_exp_vtable_vtable)))
  80 #define SCM_EXPANDED_REF(x,type,field) \
  81   (scm_struct_ref (x, SCM_I_MAKINUM (SCM_EXPANDED_##type##_##field)))
  82 #define SCM_EXPANDED_TYPE(x) \
  83   SCM_STRUCT_DATA_REF (SCM_STRUCT_VTABLE (x), SCM_EXPANDED_TYPE_CODE)
  84
  85
  86 \f
  87
  88
  89 #define SCM_EXPANDED_VOID_TYPE_NAME "void"
  90 #define SCM_EXPANDED_VOID_FIELD_NAMES \
  91   { "src" }
  92 enum
  93   {
  94     SCM_EXPANDED_VOID_SRC,
  95     SCM_NUM_EXPANDED_VOID_FIELDS,
  96   };
  97 #define SCM_MAKE_EXPANDED_VOID(src) \
  98   scm_c_make_struct (exp_vtables[SCM_EXPANDED_VOID], 0, SCM_NUM_EXPANDED_VOID_FIELDS, SCM_UNPACK (src))
  99
 100 #define SCM_EXPANDED_CONST_TYPE_NAME "const"
 101 #define SCM_EXPANDED_CONST_FIELD_NAMES          \
 102   { "src", "exp", }
 103 enum
 104   {
 105     SCM_EXPANDED_CONST_SRC,
 106     SCM_EXPANDED_CONST_EXP,
 107     SCM_NUM_EXPANDED_CONST_FIELDS,
 108   };
 109 #define SCM_MAKE_EXPANDED_CONST(src, exp) \
 110   scm_c_make_struct (exp_vtables[SCM_EXPANDED_CONST], 0, SCM_NUM_EXPANDED_CONST_FIELDS, SCM_UNPACK (src), SCM_UNPACK (exp))
 111
 112 #define SCM_EXPANDED_PRIMITIVE_REF_TYPE_NAME "primitive-ref"
 113 #define SCM_EXPANDED_PRIMITIVE_REF_FIELD_NAMES  \
 114   { "src", "name", }
 115 enum
 116   {
 117     SCM_EXPANDED_PRIMITIVE_REF_SRC,
 118     SCM_EXPANDED_PRIMITIVE_REF_NAME,
 119     SCM_NUM_EXPANDED_PRIMITIVE_REF_FIELDS,
 120   };
 121 #define SCM_MAKE_EXPANDED_PRIMITIVE_REF(src, name) \
 122   scm_c_make_struct (exp_vtables[SCM_EXPANDED_PRIMITIVE_REF], 0, SCM_NUM_EXPANDED_PRIMITIVE_REF_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name))
 123
 124 #define SCM_EXPANDED_LEXICAL_REF_TYPE_NAME "lexical-ref"
 125 #define SCM_EXPANDED_LEXICAL_REF_FIELD_NAMES    \
 126   { "src", "name", "gensym", }
 127 enum
 128   {
 129     SCM_EXPANDED_LEXICAL_REF_SRC,
 130     SCM_EXPANDED_LEXICAL_REF_NAME,
 131     SCM_EXPANDED_LEXICAL_REF_GENSYM,
 132     SCM_NUM_EXPANDED_LEXICAL_REF_FIELDS,
 133   };
 134 #define SCM_MAKE_EXPANDED_LEXICAL_REF(src, name, gensym) \
 135   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LEXICAL_REF], 0, SCM_NUM_EXPANDED_LEXICAL_REF_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name), SCM_UNPACK (gensym))
 136
 137 #define SCM_EXPANDED_LEXICAL_SET_TYPE_NAME "lexical-set"
 138 #define SCM_EXPANDED_LEXICAL_SET_FIELD_NAMES    \
 139   { "src", "name", "gensym", "exp", }
 140 enum
 141   {
 142     SCM_EXPANDED_LEXICAL_SET_SRC,
 143     SCM_EXPANDED_LEXICAL_SET_NAME,
 144     SCM_EXPANDED_LEXICAL_SET_GENSYM,
 145     SCM_EXPANDED_LEXICAL_SET_EXP,
 146     SCM_NUM_EXPANDED_LEXICAL_SET_FIELDS,
 147   };
 148 #define SCM_MAKE_EXPANDED_LEXICAL_SET(src, name, gensym, exp) \
 149   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LEXICAL_SET], 0, SCM_NUM_EXPANDED_LEXICAL_SET_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name), SCM_UNPACK (gensym), SCM_UNPACK (exp))
 150
 151 #define SCM_EXPANDED_MODULE_REF_TYPE_NAME "module-ref"
 152 #define SCM_EXPANDED_MODULE_REF_FIELD_NAMES     \
 153   { "src", "mod", "name", "public?", }
 154 enum
 155   {
 156     SCM_EXPANDED_MODULE_REF_SRC,
 157     SCM_EXPANDED_MODULE_REF_MOD,
 158     SCM_EXPANDED_MODULE_REF_NAME,
 159     SCM_EXPANDED_MODULE_REF_PUBLIC,
 160     SCM_NUM_EXPANDED_MODULE_REF_FIELDS,
 161   };
 162 #define SCM_MAKE_EXPANDED_MODULE_REF(src, mod, name, public) \
 163   scm_c_make_struct (exp_vtables[SCM_EXPANDED_MODULE_REF], 0, SCM_NUM_EXPANDED_MODULE_REF_FIELDS, SCM_UNPACK (src), SCM_UNPACK (mod), SCM_UNPACK (name), SCM_UNPACK (public))
 164
 165 #define SCM_EXPANDED_MODULE_SET_TYPE_NAME "module-set"
 166 #define SCM_EXPANDED_MODULE_SET_FIELD_NAMES     \
 167   { "src", "mod", "name", "public?", "exp", }
 168 enum
 169   {
 170     SCM_EXPANDED_MODULE_SET_SRC,
 171     SCM_EXPANDED_MODULE_SET_MOD,
 172     SCM_EXPANDED_MODULE_SET_NAME,
 173     SCM_EXPANDED_MODULE_SET_PUBLIC,
 174     SCM_EXPANDED_MODULE_SET_EXP,
 175     SCM_NUM_EXPANDED_MODULE_SET_FIELDS,
 176   };
 177 #define SCM_MAKE_EXPANDED_MODULE_SET(src, mod, name, public, exp) \
 178   scm_c_make_struct (exp_vtables[SCM_EXPANDED_MODULE_SET], 0, SCM_NUM_EXPANDED_MODULE_SET_FIELDS, SCM_UNPACK (src), SCM_UNPACK (mod), SCM_UNPACK (name), SCM_UNPACK (public), SCM_UNPACK (exp))
 179
 180 #define SCM_EXPANDED_TOPLEVEL_REF_TYPE_NAME "toplevel-ref"
 181 #define SCM_EXPANDED_TOPLEVEL_REF_FIELD_NAMES   \
 182   { "src", "name", }
 183 enum
 184   {
 185     SCM_EXPANDED_TOPLEVEL_REF_SRC,
 186     SCM_EXPANDED_TOPLEVEL_REF_NAME,
 187     SCM_NUM_EXPANDED_TOPLEVEL_REF_FIELDS,
 188   };
 189 #define SCM_MAKE_EXPANDED_TOPLEVEL_REF(src, name) \
 190   scm_c_make_struct (exp_vtables[SCM_EXPANDED_TOPLEVEL_REF], 0, SCM_NUM_EXPANDED_TOPLEVEL_REF_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name))
 191
 192 #define SCM_EXPANDED_TOPLEVEL_SET_TYPE_NAME "toplevel-set"
 193 #define SCM_EXPANDED_TOPLEVEL_SET_FIELD_NAMES   \
 194   { "src", "name", "exp", }
 195 enum
 196   {
 197     SCM_EXPANDED_TOPLEVEL_SET_SRC,
 198     SCM_EXPANDED_TOPLEVEL_SET_NAME,
 199     SCM_EXPANDED_TOPLEVEL_SET_EXP,
 200     SCM_NUM_EXPANDED_TOPLEVEL_SET_FIELDS,
 201   };
 202 #define SCM_MAKE_EXPANDED_TOPLEVEL_SET(src, name, exp) \
 203   scm_c_make_struct (exp_vtables[SCM_EXPANDED_TOPLEVEL_SET], 0, SCM_NUM_EXPANDED_TOPLEVEL_SET_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name), SCM_UNPACK (exp))
 204
 205 #define SCM_EXPANDED_TOPLEVEL_DEFINE_TYPE_NAME "toplevel-define"
 206 #define SCM_EXPANDED_TOPLEVEL_DEFINE_FIELD_NAMES        \
 207   { "src", "name", "exp", }
 208 enum
 209   {
 210     SCM_EXPANDED_TOPLEVEL_DEFINE_SRC,
 211     SCM_EXPANDED_TOPLEVEL_DEFINE_NAME,
 212     SCM_EXPANDED_TOPLEVEL_DEFINE_EXP,
 213     SCM_NUM_EXPANDED_TOPLEVEL_DEFINE_FIELDS,
 214   };
 215 #define SCM_MAKE_EXPANDED_TOPLEVEL_DEFINE(src, name, exp) \
 216   scm_c_make_struct (exp_vtables[SCM_EXPANDED_TOPLEVEL_DEFINE], 0, SCM_NUM_EXPANDED_TOPLEVEL_DEFINE_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name), SCM_UNPACK (exp))
 217
 218 #define SCM_EXPANDED_CONDITIONAL_TYPE_NAME "conditional"
 219 #define SCM_EXPANDED_CONDITIONAL_FIELD_NAMES    \
 220   { "src", "test", "consequent", "alternate", }
 221 enum
 222   {
 223     SCM_EXPANDED_CONDITIONAL_SRC,
 224     SCM_EXPANDED_CONDITIONAL_TEST,
 225     SCM_EXPANDED_CONDITIONAL_CONSEQUENT,
 226     SCM_EXPANDED_CONDITIONAL_ALTERNATE,
 227     SCM_NUM_EXPANDED_CONDITIONAL_FIELDS,
 228   };
 229 #define SCM_MAKE_EXPANDED_CONDITIONAL(src, test, consequent, alternate) \
 230   scm_c_make_struct (exp_vtables[SCM_EXPANDED_CONDITIONAL], 0, SCM_NUM_EXPANDED_CONDITIONAL_FIELDS, SCM_UNPACK (src), SCM_UNPACK (test), SCM_UNPACK (consequent), SCM_UNPACK (alternate))
 231
 232 #define SCM_EXPANDED_CALL_TYPE_NAME "call"
 233 #define SCM_EXPANDED_CALL_FIELD_NAMES    \
 234   { "src", "proc", "args", }
 235 enum
 236   {
 237     SCM_EXPANDED_CALL_SRC,
 238     SCM_EXPANDED_CALL_PROC,
 239     SCM_EXPANDED_CALL_ARGS,
 240     SCM_NUM_EXPANDED_CALL_FIELDS,
 241   };
 242 #define SCM_MAKE_EXPANDED_CALL(src, proc, args) \
 243   scm_c_make_struct (exp_vtables[SCM_EXPANDED_CALL], 0, SCM_NUM_EXPANDED_CALL_FIELDS, SCM_UNPACK (src), SCM_UNPACK (proc), SCM_UNPACK (args))
 244
 245 #define SCM_EXPANDED_PRIMCALL_TYPE_NAME "primcall"
 246 #define SCM_EXPANDED_PRIMCALL_FIELD_NAMES    \
 247   { "src", "name", "args", }
 248 enum
 249   {
 250     SCM_EXPANDED_PRIMCALL_SRC,
 251     SCM_EXPANDED_PRIMCALL_NAME,
 252     SCM_EXPANDED_PRIMCALL_ARGS,
 253     SCM_NUM_EXPANDED_PRIMCALL_FIELDS,
 254   };
 255 #define SCM_MAKE_EXPANDED_PRIMCALL(src, name, args) \
 256   scm_c_make_struct (exp_vtables[SCM_EXPANDED_PRIMCALL], 0, SCM_NUM_EXPANDED_PRIMCALL_FIELDS, SCM_UNPACK (src), SCM_UNPACK (name), SCM_UNPACK (args))
 257
 258 #define SCM_EXPANDED_SEQ_TYPE_NAME "seq"
 259 #define SCM_EXPANDED_SEQ_FIELD_NAMES       \
 260   {  "src", "head", "tail", }
 261 enum
 262   {
 263     SCM_EXPANDED_SEQ_SRC,
 264     SCM_EXPANDED_SEQ_HEAD,
 265     SCM_EXPANDED_SEQ_TAIL,
 266     SCM_NUM_EXPANDED_SEQ_FIELDS,
 267   };
 268 #define SCM_MAKE_EXPANDED_SEQ(src, head, tail)                          \
 269   scm_c_make_struct (exp_vtables[SCM_EXPANDED_SEQ], 0, SCM_NUM_EXPANDED_SEQ_FIELDS, SCM_UNPACK (src), SCM_UNPACK (head), SCM_UNPACK (tail))
 270
 271 #define SCM_EXPANDED_LAMBDA_TYPE_NAME "lambda"
 272 #define SCM_EXPANDED_LAMBDA_FIELD_NAMES         \
 273   { "src", "meta", "body", }
 274 enum
 275   {
 276     SCM_EXPANDED_LAMBDA_SRC,
 277     SCM_EXPANDED_LAMBDA_META,
 278     SCM_EXPANDED_LAMBDA_BODY,
 279     SCM_NUM_EXPANDED_LAMBDA_FIELDS,
 280   };
 281 #define SCM_MAKE_EXPANDED_LAMBDA(src, meta, body) \
 282   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LAMBDA], 0, SCM_NUM_EXPANDED_LAMBDA_FIELDS, SCM_UNPACK (src), SCM_UNPACK (meta), SCM_UNPACK (body))
 283
 284 #define SCM_EXPANDED_LAMBDA_CASE_TYPE_NAME "lambda-case"
 285 #define SCM_EXPANDED_LAMBDA_CASE_FIELD_NAMES    \
 286   { "src", "req", "opt", "rest", "kw", "inits", "gensyms", "body", "alternate", }
 287 enum
 288   {
 289     SCM_EXPANDED_LAMBDA_CASE_SRC,
 290     SCM_EXPANDED_LAMBDA_CASE_REQ,
 291     SCM_EXPANDED_LAMBDA_CASE_OPT,
 292     SCM_EXPANDED_LAMBDA_CASE_REST,
 293     SCM_EXPANDED_LAMBDA_CASE_KW,
 294     SCM_EXPANDED_LAMBDA_CASE_INITS,
 295     SCM_EXPANDED_LAMBDA_CASE_GENSYMS,
 296     SCM_EXPANDED_LAMBDA_CASE_BODY,
 297     SCM_EXPANDED_LAMBDA_CASE_ALTERNATE,
 298     SCM_NUM_EXPANDED_LAMBDA_CASE_FIELDS,
 299   };
 300 #define SCM_MAKE_EXPANDED_LAMBDA_CASE(src, req, opt, rest, kw, inits, gensyms, body, alternate) \
 301   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LAMBDA_CASE], 0, SCM_NUM_EXPANDED_LAMBDA_CASE_FIELDS, SCM_UNPACK (src), SCM_UNPACK (req), SCM_UNPACK (opt), SCM_UNPACK (rest), SCM_UNPACK (kw), SCM_UNPACK (inits), SCM_UNPACK (gensyms), SCM_UNPACK (body), SCM_UNPACK (alternate))
 302
 303 #define SCM_EXPANDED_LET_TYPE_NAME "let"
 304 #define SCM_EXPANDED_LET_FIELD_NAMES            \
 305   { "src", "names", "gensyms", "vals", "body", }
 306 enum
 307   {
 308     SCM_EXPANDED_LET_SRC,
 309     SCM_EXPANDED_LET_NAMES,
 310     SCM_EXPANDED_LET_GENSYMS,
 311     SCM_EXPANDED_LET_VALS,
 312     SCM_EXPANDED_LET_BODY,
 313     SCM_NUM_EXPANDED_LET_FIELDS,
 314   };
 315 #define SCM_MAKE_EXPANDED_LET(src, names, gensyms, vals, body) \
 316   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LET], 0, SCM_NUM_EXPANDED_LET_FIELDS, SCM_UNPACK (src), SCM_UNPACK (names), SCM_UNPACK (gensyms), SCM_UNPACK (vals), SCM_UNPACK (body))
 317
 318 #define SCM_EXPANDED_LETREC_TYPE_NAME "letrec"
 319 #define SCM_EXPANDED_LETREC_FIELD_NAMES         \
 320   { "src", "in-order?", "names", "gensyms", "vals", "body", }
 321 enum
 322   {
 323     SCM_EXPANDED_LETREC_SRC,
 324     SCM_EXPANDED_LETREC_IN_ORDER_P,
 325     SCM_EXPANDED_LETREC_NAMES,
 326     SCM_EXPANDED_LETREC_GENSYMS,
 327     SCM_EXPANDED_LETREC_VALS,
 328     SCM_EXPANDED_LETREC_BODY,
 329     SCM_NUM_EXPANDED_LETREC_FIELDS,
 330   };
 331 #define SCM_MAKE_EXPANDED_LETREC(src, in_order_p, names, gensyms, vals, body) \
 332   scm_c_make_struct (exp_vtables[SCM_EXPANDED_LETREC], 0, SCM_NUM_EXPANDED_LETREC_FIELDS, SCM_UNPACK (src), SCM_UNPACK (in_order_p), SCM_UNPACK (names), SCM_UNPACK (gensyms), SCM_UNPACK (vals), SCM_UNPACK (body))
 333
 334 #define SCM_EXPANDED_DYNLET_TYPE_NAME "dynlet"
 335 #define SCM_EXPANDED_DYNLET_FIELD_NAMES         \
 336   { "src", "fluids", "vals", "body", }
 337 enum
 338   {
 339     SCM_EXPANDED_DYNLET_SRC,
 340     SCM_EXPANDED_DYNLET_FLUIDS,
 341     SCM_EXPANDED_DYNLET_VALS,
 342     SCM_EXPANDED_DYNLET_BODY,
 343     SCM_NUM_EXPANDED_DYNLET_FIELDS,
 344   };
 345 #define SCM_MAKE_EXPANDED_DYNLET(src, fluids, vals, body) \
 346   scm_c_make_struct (exp_vtables[SCM_EXPANDED_DYNLET], 0, SCM_NUM_EXPANDED_DYNLET_FIELDS, SCM_UNPACK (src), SCM_UNPACK (fluids), SCM_UNPACK (vals), SCM_UNPACK (body))
 347
 348 #endif /* BUILDING_LIBGUILE */
 349
 350 \f
 351
 352 SCM_INTERNAL SCM scm_macroexpand (SCM exp);
 353 SCM_INTERNAL SCM scm_macroexpanded_p (SCM exp);
 354
 355 SCM_INTERNAL void scm_init_expand (void);
 356
 357
 358 #endif  /* SCM_EXPAND_H */
 359
 360 /*
 361   Local Variables:
 362   c-file-style: "gnu"
 363   End:
 364 */