libguile/snarf.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_SNARF_H
   4 #define SCM_SNARF_H
   5
   6 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2009 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 /* Macros for snarfing initialization actions from C source. */
  27
  28 #if defined(__cplusplus) || defined(GUILE_CPLUSPLUS_SNARF)
  29
  30 /* This used to be "SCM (*)(...)" but GCC on RedHat 7.1 doesn't seem
  31    to like it.
  32  */
  33 #define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()
  34
  35 #else
  36 #define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()
  37 #endif
  38
  39 #if (defined SCM_ALIGNED) && (SCM_DEBUG_TYPING_STRICTNESS <= 1)
  40 /* We support static allocation of some `SCM' objects.  */
  41 # define SCM_SUPPORT_STATIC_ALLOCATION
  42 #endif
  43
  44 /* C preprocessor token concatenation.  */
  45 #define scm_i_paste(x, y)      x ## y
  46 #define scm_i_paste3(a, b, c)  a ## b ## c
  47
  48
  49 \f
  50 /* Generic macros to be used in user macro definitions.
  51  *
  52  * For example, in order to define a macro which creates ints and
  53  * initializes them to the result of foo (), do:
  54  *
  55  *   #define SCM_FOO(NAME) \
  56  *     SCM_SNARF_HERE (int NAME) \
  57  *     SCM_SNARF_INIT (NAME = foo ())
  58  *
  59  * The SCM_SNARF_INIT text goes into the corresponding .x file
  60  * up through the first occurrence of SCM_SNARF_DOC_START on that
  61  * line, if any.
  62  */
  63
  64 #ifdef SCM_MAGIC_SNARF_INITS
  65 # define SCM_SNARF_HERE(X)
  66 # define SCM_SNARF_INIT(X) ^^ X ^:^
  67 # define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
  68 #else
  69 # ifdef SCM_MAGIC_SNARF_DOCS
  70 #  define SCM_SNARF_HERE(X)
  71 #  define SCM_SNARF_INIT(X)
  72 #  define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING) \
  73 ^^ { \
  74 cname CNAME ^^ \
  75 fname FNAME ^^ \
  76 type TYPE ^^ \
  77 location __FILE__ __LINE__ ^^ \
  78 arglist ARGLIST ^^ \
  79 argsig REQ OPT VAR ^^ \
  80 DOCSTRING ^^ }
  81 # else
  82 #  define SCM_SNARF_HERE(X) X
  83 #  define SCM_SNARF_INIT(X)
  84 #  define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
  85 # endif
  86 #endif
  87
  88 #define SCM_DEFINE_GSUBR(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
  89 SCM_SNARF_HERE(\
  90 static const char s_ ## FNAME [] = PRIMNAME; \
  91 SCM FNAME ARGLIST\
  92 )\
  93 SCM_SNARF_INIT(\
  94 scm_c_define_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
  95                     (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
  96 )\
  97 SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
  98
  99 #ifdef SCM_SUPPORT_STATIC_ALLOCATION
 100
 101 /* Static subr allocation.  */
 102 #define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING)  \
 103 SCM_SYMBOL (scm_i_paste (FNAME, __name), PRIMNAME);                     \
 104 SCM_SNARF_HERE(                                                         \
 105   static const char scm_i_paste (s_, FNAME) [] = PRIMNAME;              \
 106   SCM_IMMUTABLE_SUBR (scm_i_paste (FNAME, __subr),                      \
 107                       scm_i_paste (FNAME, __name),                      \
 108                       REQ, OPT, VAR, &FNAME);                           \
 109   SCM FNAME ARGLIST                                                     \
 110 )                                                                       \
 111 SCM_SNARF_INIT(                                                         \
 112   /* Initialize the procedure name (an interned symbol).  */            \
 113   scm_i_paste (FNAME, __subr_meta_info)[0] = scm_i_paste (FNAME, __name); \
 114                                                                         \
 115   /* Define the subr.  */                                               \
 116   scm_c_define (scm_i_paste (s_, FNAME), scm_i_paste (FNAME, __subr));  \
 117 )                                                                       \
 118 SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
 119
 120 #else /* !SCM_SUPPORT_STATIC_ALLOCATION */
 121
 122 /* Always use the generic subr case.  */
 123 #define SCM_DEFINE SCM_DEFINE_GSUBR
 124
 125 #endif /* !SCM_SUPPORT_STATIC_ALLOCATION */
 126
 127
 128 #define SCM_PRIMITIVE_GENERIC(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 129 SCM_SNARF_HERE(\
 130 static const char s_ ## FNAME [] = PRIMNAME; \
 131 static SCM g_ ## FNAME; \
 132 SCM FNAME ARGLIST\
 133 )\
 134 SCM_SNARF_INIT(\
 135 g_ ## FNAME = SCM_PACK (0); \
 136 scm_c_define_gsubr_with_generic (s_ ## FNAME, REQ, OPT, VAR, \
 137                                  (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME, \
 138                                  &g_ ## FNAME); \
 139 )\
 140 SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
 141
 142 #define SCM_DEFINE_PUBLIC(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 143 SCM_SNARF_HERE(\
 144 static const char s_ ## FNAME [] = PRIMNAME; \
 145 SCM FNAME ARGLIST\
 146 )\
 147 SCM_SNARF_INIT(\
 148 scm_c_define_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
 149                     (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
 150 scm_c_export (s_ ## FNAME, NULL); \
 151 )\
 152 SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
 153
 154 #define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
 155 SCM_SNARF_HERE(\
 156 static const char s_ ## FNAME [] = PRIMNAME; \
 157 SCM FNAME ARGLIST\
 158 )\
 159 SCM_SNARF_INIT(scm_c_define_subr (s_ ## FNAME, TYPE, FNAME); ) \
 160 SCM_SNARF_DOCS(1, FNAME, PRIMNAME, ARGLIST, 2, 0, 0, DOCSTRING)
 161
 162 #define SCM_PRIMITIVE_GENERIC_1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
 163 SCM_SNARF_HERE(\
 164 static const char s_ ## FNAME [] = PRIMNAME; \
 165 static SCM g_ ## FNAME; \
 166 SCM FNAME ARGLIST\
 167 )\
 168 SCM_SNARF_INIT(\
 169 g_ ## FNAME = SCM_PACK (0); \
 170 scm_c_define_subr_with_generic (s_ ## FNAME, TYPE, FNAME, &g_ ## FNAME); \
 171 )\
 172 SCM_SNARF_DOCS(1, FNAME, PRIMNAME, ARGLIST, 2, 0, 0, DOCSTRING)
 173
 174 #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 175 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 176 SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
 177                                    (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN))
 178
 179 #define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 180 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 181 SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
 182                                    (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN);) \
 183 SCM_SNARF_DOCS(register, CFN, STR, (), REQ, OPT, VAR, \
 184                "implemented by the C function \"" #CFN "\"")
 185
 186 #define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
 187 SCM_SNARF_HERE(\
 188 static const char RANAME[]=STR;\
 189 static SCM GF \
 190 )SCM_SNARF_INIT(\
 191 GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
 192 scm_c_define_gsubr_with_generic (RANAME, REQ, OPT, VAR, \
 193                                  (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
 194 )
 195
 196 #define SCM_PROC1(RANAME, STR, TYPE, CFN) \
 197 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 198 SCM_SNARF_INIT(\
 199 scm_c_define_subr (RANAME, TYPE, (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN) \
 200 )
 201
 202
 203 #define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF) \
 204 SCM_SNARF_HERE(\
 205 static const char RANAME[]=STR; \
 206 static SCM GF \
 207 )SCM_SNARF_INIT(\
 208 GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
 209 scm_c_define_subr_with_generic (RANAME, TYPE, \
 210                                 (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
 211 )
 212
 213 #define SCM_SYNTAX(RANAME, STR, TYPE, CFN)  \
 214 SCM_SNARF_HERE(static const char RANAME[]=STR)\
 215 SCM_SNARF_INIT(scm_make_synt (RANAME, TYPE, CFN))
 216
 217 #ifdef SCM_SUPPORT_STATIC_ALLOCATION
 218
 219 # define SCM_SYMBOL(c_name, scheme_name)                                \
 220 SCM_SNARF_HERE(                                                         \
 221   SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name);    \
 222   static SCM c_name)                                                    \
 223 SCM_SNARF_INIT(                                                         \
 224   c_name = scm_string_to_symbol (scm_i_paste (c_name, _string))         \
 225 )
 226
 227 # define SCM_GLOBAL_SYMBOL(c_name, scheme_name)                         \
 228 SCM_SNARF_HERE(                                                         \
 229   SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name);    \
 230   SCM c_name)                                                           \
 231 SCM_SNARF_INIT(                                                         \
 232   c_name = scm_string_to_symbol (scm_i_paste (c_name, _string))         \
 233 )
 234
 235 #else /* !SCM_SUPPORT_STATIC_ALLOCATION */
 236
 237 # define SCM_SYMBOL(c_name, scheme_name)                                \
 238 SCM_SNARF_HERE(static SCM c_name)                                       \
 239 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))
 240
 241 # define SCM_GLOBAL_SYMBOL(c_name, scheme_name)                         \
 242 SCM_SNARF_HERE(SCM c_name)                                              \
 243 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))
 244
 245 #endif /* !SCM_SUPPORT_STATIC_ALLOCATION */
 246
 247 #define SCM_KEYWORD(c_name, scheme_name) \
 248 SCM_SNARF_HERE(static SCM c_name) \
 249 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))
 250
 251 #define SCM_GLOBAL_KEYWORD(c_name, scheme_name) \
 252 SCM_SNARF_HERE(SCM c_name) \
 253 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))
 254
 255 #define SCM_VARIABLE(c_name, scheme_name) \
 256 SCM_SNARF_HERE(static SCM c_name) \
 257 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, SCM_BOOL_F));)
 258
 259 #define SCM_GLOBAL_VARIABLE(c_name, scheme_name) \
 260 SCM_SNARF_HERE(SCM c_name) \
 261 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, SCM_BOOL_F));)
 262
 263 #define SCM_VARIABLE_INIT(c_name, scheme_name, init_val) \
 264 SCM_SNARF_HERE(static SCM c_name) \
 265 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, init_val));)
 266
 267 #define SCM_GLOBAL_VARIABLE_INIT(c_name, scheme_name, init_val) \
 268 SCM_SNARF_HERE(SCM c_name) \
 269 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, init_val));)
 270
 271 #define SCM_MUTEX(c_name) \
 272 SCM_SNARF_HERE(static scm_t_mutex c_name) \
 273 SCM_SNARF_INIT(scm_i_plugin_mutex_init (&c_name, &scm_i_plugin_mutex))
 274
 275 #define SCM_GLOBAL_MUTEX(c_name) \
 276 SCM_SNARF_HERE(scm_t_mutex c_name) \
 277 SCM_SNARF_INIT(scm_i_plugin_mutex_init (&c_name, &scm_i_plugin_mutex))
 278
 279 #define SCM_REC_MUTEX(c_name) \
 280 SCM_SNARF_HERE(static scm_t_rec_mutex c_name) \
 281 SCM_SNARF_INIT(scm_i_plugin_rec_mutex_init (&c_name, &scm_i_plugin_rec_mutex))
 282
 283 #define SCM_GLOBAL_REC_MUTEX(c_name) \
 284 SCM_SNARF_HERE(scm_t_rec_mutex c_name) \
 285 SCM_SNARF_INIT(scm_i_plugin_rec_mutex_init (&c_name, &scm_i_plugin_rec_mutex))
 286
 287 #define SCM_SMOB(tag, scheme_name, size) \
 288 SCM_SNARF_HERE(static scm_t_bits tag) \
 289 SCM_SNARF_INIT((tag)=scm_make_smob_type((scheme_name), (size));)
 290
 291 #define SCM_GLOBAL_SMOB(tag, scheme_name, size) \
 292 SCM_SNARF_HERE(scm_t_bits tag) \
 293 SCM_SNARF_INIT((tag)=scm_make_smob_type((scheme_name), (size));)
 294
 295 #define SCM_SMOB_MARK(tag, c_name, arg) \
 296 SCM_SNARF_HERE(static SCM c_name(SCM arg)) \
 297 SCM_SNARF_INIT(scm_set_smob_mark((tag), (c_name));)
 298
 299 #define SCM_GLOBAL_SMOB_MARK(tag, c_name, arg) \
 300 SCM_SNARF_HERE(SCM c_name(SCM arg)) \
 301 SCM_SNARF_INIT(scm_set_smob_mark((tag), (c_name));)
 302
 303 #define SCM_SMOB_FREE(tag, c_name, arg) \
 304 SCM_SNARF_HERE(static size_t c_name(SCM arg)) \
 305 SCM_SNARF_INIT(scm_set_smob_free((tag), (c_name));)
 306
 307 #define SCM_GLOBAL_SMOB_FREE(tag, c_name, arg) \
 308 SCM_SNARF_HERE(size_t c_name(SCM arg)) \
 309 SCM_SNARF_INIT(scm_set_smob_free((tag), (c_name));)
 310
 311 #define SCM_SMOB_PRINT(tag, c_name, obj, port, pstate) \
 312 SCM_SNARF_HERE(static int c_name(SCM obj, SCM port, scm_print_state* pstate)) \
 313 SCM_SNARF_INIT(scm_set_smob_print((tag), (c_name));)
 314
 315 #define SCM_GLOBAL_SMOB_PRINT(tag, c_name, obj, port, pstate) \
 316 SCM_SNARF_HERE(int c_name(SCM obj, SCM port, scm_print_state* pstate)) \
 317 SCM_SNARF_INIT(scm_set_smob_print((tag), (c_name));)
 318
 319 #define SCM_SMOB_EQUALP(tag, c_name, obj1, obj2) \
 320 SCM_SNARF_HERE(static SCM c_name(SCM obj1, SCM obj2)) \
 321 SCM_SNARF_INIT(scm_set_smob_equalp((tag), (c_name));)
 322
 323 #define SCM_GLOBAL_SMOB_EQUALP(tag, c_name, obj1, obj2) \
 324 SCM_SNARF_HERE(SCM c_name(SCM obj1, SCM obj2)) \
 325 SCM_SNARF_INIT(scm_set_smob_equalp((tag), (c_name));)
 326
 327 #define SCM_SMOB_APPLY(tag, c_name, req, opt, rest, arglist) \
 328 SCM_SNARF_HERE(static SCM c_name arglist) \
 329 SCM_SNARF_INIT(scm_set_smob_apply((tag), (c_name), (req), (opt), (rest));)
 330
 331 #define SCM_GLOBAL_SMOB_APPLY(tag, c_name, req, opt, rest, arglist) \
 332 SCM_SNARF_HERE(SCM c_name arglist) \
 333 SCM_SNARF_INIT(scm_set_smob_apply((tag), (c_name), (req), (opt), (rest));)
 334
 335 \f
 336 /* Low-level snarfing for static memory allocation.  */
 337
 338 #ifdef SCM_SUPPORT_STATIC_ALLOCATION
 339
 340 #define SCM_IMMUTABLE_DOUBLE_CELL(c_name, car, cbr, ccr, cdr)           \
 341   static SCM_ALIGNED (8) SCM_UNUSED const scm_t_cell                    \
 342   c_name ## _raw_cell [2] =                                             \
 343     {                                                                   \
 344       { SCM_PACK (car), SCM_PACK (cbr) },                               \
 345       { SCM_PACK (ccr), SCM_PACK (cdr) }                                \
 346     };                                                                  \
 347   static SCM_UNUSED const SCM c_name = SCM_PACK (& c_name ## _raw_cell)
 348
 349 #define SCM_IMMUTABLE_STRINGBUF(c_name, contents)       \
 350   static SCM_UNUSED const                               \
 351   struct                                                \
 352   {                                                     \
 353     scm_t_bits word_0;                                  \
 354     scm_t_bits word_1;                                  \
 355     const char buffer[sizeof (contents)];               \
 356   }                                                     \
 357   c_name =                                              \
 358     {                                                   \
 359       scm_tc7_stringbuf | SCM_I_STRINGBUF_F_SHARED,     \
 360       sizeof (contents) - 1,                            \
 361       contents                                          \
 362     }
 363
 364 #define SCM_IMMUTABLE_STRING(c_name, contents)                          \
 365   SCM_IMMUTABLE_STRINGBUF (scm_i_paste (c_name, _stringbuf), contents); \
 366   SCM_IMMUTABLE_DOUBLE_CELL (c_name,                                    \
 367                              scm_tc7_ro_string,                         \
 368                              (scm_t_bits) &scm_i_paste (c_name,         \
 369                                                         _stringbuf),    \
 370                              (scm_t_bits) 0,                            \
 371                              (scm_t_bits) sizeof (contents) - 1)
 372
 373 #define SCM_IMMUTABLE_SUBR(c_name, name, req, opt, rest, fcn)           \
 374   static SCM_UNUSED SCM scm_i_paste (c_name, _meta_info)[2] =           \
 375     {                                                                   \
 376       SCM_BOOL_F,  /* The name, initialized at run-time.  */            \
 377       SCM_EOL      /* The procedure properties.  */                     \
 378     };                                                                  \
 379   SCM_IMMUTABLE_DOUBLE_CELL (c_name,                                    \
 380                              SCM_SUBR_ARITY_TO_TYPE (req, opt, rest),   \
 381                              (scm_t_bits) fcn,                          \
 382                              (scm_t_bits) 0 /* no generic */,           \
 383                              (scm_t_bits) & scm_i_paste (c_name, _meta_info));
 384
 385 #endif /* SCM_SUPPORT_STATIC_ALLOCATION */
 386
 387 \f
 388 /* Documentation.  */
 389
 390 #ifdef SCM_MAGIC_SNARF_DOCS
 391 #undef SCM_ASSERT
 392 #define SCM_ASSERT(_cond, _arg, _pos, _subr) ^^ argpos _arg _pos __LINE__ ^^
 393 #endif /* SCM_MAGIC_SNARF_DOCS */
 394
 395 #endif  /* SCM_SNARF_H */
 396
 397 /*
 398   Local Variables:
 399   c-file-style: "gnu"
 400   End:
 401 */