libguile/snarf.h

   1 /* classes: h_files */
   2
   3 /* Macros for snarfing initialization actions from C source. */
   4
   5 #ifndef LIBGUILE_SNARF_H
   6 #define LIBGUILE_SNARF_H
   7
   8 /* Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2, or (at your option)
  13  * any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this software; see the file COPYING.  If not, write to
  22  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  23  * Boston, MA 02111-1307 USA
  24  *
  25  * As a special exception, the Free Software Foundation gives permission
  26  * for additional uses of the text contained in its release of GUILE.
  27  *
  28  * The exception is that, if you link the GUILE library with other files
  29  * to produce an executable, this does not by itself cause the
  30  * resulting executable to be covered by the GNU General Public License.
  31  * Your use of that executable is in no way restricted on account of
  32  * linking the GUILE library code into it.
  33  *
  34  * This exception does not however invalidate any other reasons why
  35  * the executable file might be covered by the GNU General Public License.
  36  *
  37  * This exception applies only to the code released by the
  38  * Free Software Foundation under the name GUILE.  If you copy
  39  * code from other Free Software Foundation releases into a copy of
  40  * GUILE, as the General Public License permits, the exception does
  41  * not apply to the code that you add in this way.  To avoid misleading
  42  * anyone as to the status of such modified files, you must delete
  43  * this exception notice from them.
  44  *
  45  * If you write modifications of your own for GUILE, it is your choice
  46  * whether to permit this exception to apply to your modifications.
  47  * If you do not wish that, delete this exception notice.  */
  48
  49 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  50    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  51
  52 \f
  53
  54 #if defined(__cplusplus) || defined(GUILE_CPLUSPLUS_SNARF)
  55 #define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)(...)
  56 #else
  57 #define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()
  58 #endif
  59
  60 /* Generic macros to be used in user macro definitions.
  61  *
  62  * For example, in order to define a macro which creates ints and
  63  * initializes them to the result of foo (), do:
  64  *
  65  *   #define SCM_FOO(NAME) \
  66  *     SCM_SNARF_HERE (int NAME) \
  67  *     SCM_SNARF_INIT (NAME = foo ())
  68  *
  69  * The SCM_SNARF_INIT text goes into the corresponding .x file
  70  * up through the first occurrence of SCM_SNARF_DOC_START on that
  71  * line, if any.
  72  */
  73
  74 #ifndef SCM_MAGIC_SNARFER
  75 #  define SCM_SNARF_HERE(X) X
  76 #  define SCM_SNARF_INIT(X)
  77 #  define SCM_SNARF_DOCS(X)
  78 #else
  79 #  define SCM_SNARF_HERE(X)
  80 #  define SCM_SNARF_INIT(X) SCM_SNARF_INIT_START X
  81 #  define SCM_SNARF_DOCS(X) X
  82 #endif
  83
  84 #define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
  85 SCM_SNARF_HERE(\
  86 static const char s_ ## FNAME [] = PRIMNAME; \
  87 SCM FNAME ARGLIST\
  88 )\
  89 SCM_SNARF_INIT(\
  90 scm_make_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
  91                 (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
  92 )\
  93 SCM_SNARF_DOCS(\
  94 SCM_SNARF_DOC_STARTP PRIMNAME #ARGLIST | REQ | OPT | VAR | __FILE__:__LINE__ | \
  95  SCM_SNARF_DOCSTRING_START DOCSTRING SCM_SNARF_DOCSTRING_END \
  96 )
  97
  98 #define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
  99 SCM_SNARF_HERE(\
 100 static const char s_ ## FNAME [] = PRIMNAME; \
 101 SCM FNAME ARGLIST\
 102 )\
 103 SCM_SNARF_INIT(scm_make_subr (s_ ## FNAME, TYPE, FNAME); ) \
 104 SCM_SNARF_DOCS(\
 105 SCM_SNARF_DOC_START1 PRIMNAME #ARGLIST | 2 | 0 | 0 | __FILE__:__LINE__ | \
 106  SCM_SNARF_DOCSTRING_START DOCSTRING SCM_SNARF_DOCSTRING_END \
 107 )
 108
 109 #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 110 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 111 SCM_SNARF_INIT(scm_make_gsubr (RANAME, REQ, OPT, VAR, \
 112                                (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN))
 113
 114 #define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 115 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 116 SCM_SNARF_INIT(scm_make_gsubr (RANAME, REQ, OPT, VAR, \
 117                                (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN);) \
 118 SCM_SNARF_DOCS(\
 119 SCM_SNARF_DOC_STARTR STR | REQ | OPT | VAR | __FILE__:__LINE__ | \
 120  SCM_SNARF_DOCSTRING_START CFN SCM_SNARF_DOCSTRING_END \
 121 )
 122
 123 #define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
 124 SCM_SNARF_HERE(\
 125 static const char RANAME[]=STR;\
 126 static SCM GF \
 127 )SCM_SNARF_INIT(\
 128 GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
 129 scm_make_gsubr_with_generic (RANAME, REQ, OPT, VAR, \
 130                              (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
 131 )
 132
 133 #define SCM_PROC1(RANAME, STR, TYPE, CFN) \
 134 SCM_SNARF_HERE(static const char RANAME[]=STR) \
 135 SCM_SNARF_INIT(\
 136 scm_make_subr (RANAME, TYPE, (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN) \
 137 )
 138
 139
 140 #define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF) \
 141 SCM_SNARF_HERE(\
 142 static const char RANAME[]=STR; \
 143 static SCM GF \
 144 )SCM_SNARF_INIT(\
 145 GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
 146 scm_make_subr_with_generic (RANAME, TYPE, \
 147                             (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
 148 )
 149
 150 #define SCM_SYNTAX(RANAME, STR, TYPE, CFN)  \
 151 SCM_SNARF_HERE(static const char RANAME[]=STR)\
 152 SCM_SNARF_INIT(scm_make_synt (RANAME, TYPE, CFN))
 153
 154 #define SCM_SYMBOL(c_name, scheme_name) \
 155 SCM_SNARF_HERE(static SCM c_name) \
 156 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_str2symbol (scheme_name)))
 157
 158 #define SCM_GLOBAL_SYMBOL(c_name, scheme_name) \
 159 SCM_SNARF_HERE(SCM c_name) \
 160 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_str2symbol (scheme_name)))
 161
 162 #define SCM_KEYWORD(c_name, scheme_name) \
 163 SCM_SNARF_HERE(static SCM c_name) \
 164 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_make_keyword (scheme_name)))
 165
 166 #define SCM_GLOBAL_KEYWORD(c_name, scheme_name) \
 167 SCM_SNARF_HERE(SCM c_name) \
 168 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_make_keyword (scheme_name)))
 169
 170 #define SCM_VCELL(c_name, scheme_name) \
 171 SCM_SNARF_HERE(static SCM c_name) \
 172 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_sysintern (scheme_name, SCM_BOOL_F));)
 173
 174 #define SCM_GLOBAL_VCELL(c_name, scheme_name) \
 175 SCM_SNARF_HERE(SCM c_name) \
 176 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_sysintern (scheme_name, SCM_BOOL_F));)
 177
 178 #define SCM_VCELL_INIT(c_name, scheme_name, init_val) \
 179 SCM_SNARF_HERE(static SCM c_name) \
 180 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_sysintern (scheme_name, init_val));)
 181
 182 #define SCM_GLOBAL_VCELL_INIT(c_name, scheme_name, init_val) \
 183 SCM_SNARF_HERE(SCM c_name) \
 184 SCM_SNARF_INIT(c_name = scm_permanent_object (scm_sysintern (scheme_name, init_val));)
 185
 186 #if (SCM_DEBUG_DEPRECATED == 0)
 187
 188 #define SCM_CONST_LONG(c_name, scheme_name,value) \
 189 SCM_VCELL_INIT(c_name, scheme_name, scm_long2num(value))
 190
 191 #endif /* (SCM_DEBUG_DEPRECATED == 0) */
 192
 193 #ifdef SCM_MAGIC_SNARFER
 194 #undef SCM_ASSERT
 195 #define SCM_ASSERT(_cond, _arg, _pos, _subr) *&*&*&*SCM_ARG_BETTER_BE_IN_POSITION(_arg,_pos,__LINE__)
 196 #endif /* SCM_MAGIC_SNARFER */
 197
 198 #endif /* LIBGUILE_SNARF_H */
 199
 200
 201 /*
 202   Local Variables:
 203   c-file-style: "gnu"
 204   End:
 205 */