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-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 /* Generic macros to be used in user macro definitions.
  55  *
  56  * For example, the SCM_PROC macro could have been defined by the user:
  57  *
  58  *   #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
  59  *   SCM_INSITU (static const char RANAME[]=STR) \
  60  *   SCM_INIT   (scm_make_gsubr (RANAME, REQ, OPT, VAR, (SCM (*)(...)) CFN))
  61  */
  62
  63 #ifndef SCM_MAGIC_SNARFER
  64 #  define SCM_INSITU(X) X
  65 #  define SCM_INIT(X)
  66 #else
  67 #  define SCM_INSITU(X)
  68 #  define SCM_INIT(X) \
  69 %%%     X \
  70
  71 #endif
  72
  73 #ifndef SCM_MAGIC_SNARFER
  74
  75 #define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
  76 static const char s_ ## FNAME [] = PRIMNAME; \
  77 SCM FNAME ARGLIST
  78 #define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
  79 static const char s_ ## FNAME [] = PRIMNAME; \
  80 SCM FNAME ARGLIST
  81
  82 #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
  83         static const char RANAME[]=STR
  84
  85 #define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
  86         static const char RANAME[]=STR
  87
  88 #define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
  89         static const char RANAME[]=STR; \
  90         static SCM GF = 0
  91
  92 #define SCM_PROC1(RANAME, STR, TYPE, CFN)  \
  93         static const char RANAME[]=STR
  94
  95 #define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF) \
  96         static const char RANAME[]=STR; \
  97         static SCM GF = 0
  98 #else
  99 #if defined(__cplusplus) || defined(GUILE_CPLUSPLUS_SNARF)
 100 /* for C++ snarfing */
 101
 102 #undef SCM_ASSERT
 103 #define SCM_ASSERT(_cond, _arg, _pos, _subr) *&*&*&*SCM_ARG_BETTER_BE_IN_POSITION(_arg,_pos,__LINE__)
 104
 105 #define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 106 %%%     scm_make_gsubr (s_ ## FNAME, REQ, OPT, VAR, (SCM (*)(...)) FNAME); \
 107 $$$P PRIMNAME #ARGLIST | REQ | OPT | VAR | __FILE__:__LINE__ | @@@ DOCSTRING @!!!
 108
 109 #define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
 110 %%%     scm_make_subr (s_ ## FNAME, TYPE, FNAME); \
 111 $$$1 PRIMNAME #ARGLIST | 2 | 0 | 0 | __FILE__:__LINE__ | @@@ DOCSTRING @!!!
 112
 113 #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 114 %%%     scm_make_gsubr (RANAME, REQ, OPT, VAR, (SCM (*)(...)) CFN)
 115
 116 #define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 117 %%%     scm_make_gsubr (RANAME, REQ, OPT, VAR, (SCM (*)(...)) CFN); \
 118 $$$R STR | REQ | OPT | VAR | __FILE__:__LINE__ | @@@ CFN @!!!
 119
 120 #define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
 121 %%%     scm_make_gsubr_with_generic (RANAME, REQ, OPT, VAR, (SCM (*)(...))CFN, &GF)
 122
 123 #define SCM_PROC1(RANAME, STR, TYPE, CFN)  \
 124 %%%     scm_make_subr(RANAME, TYPE, (SCM (*)(...))CFN)
 125
 126 #define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF)  \
 127 %%%     scm_make_subr_with_generic(RANAME, TYPE, (SCM (*)(...))CFN, &GF)
 128
 129 #else
 130 /* for ANSI C snarfing, not C++ */
 131
 132 #undef SCM_ASSERT
 133 #define SCM_ASSERT(_cond, _arg, _pos, _subr) *&*&*&*SCM_ARG_BETTER_BE_IN_POSITION(_arg,_pos,__LINE__)
 134
 135 #define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 136 %%%     scm_make_gsubr (s_ ## FNAME, REQ, OPT, VAR, (SCM (*)()) FNAME); \
 137 $$$P PRIMNAME #ARGLIST | REQ | OPT | VAR | __FILE__:__LINE__ | @@@ DOCSTRING @!!!
 138
 139 #define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
 140 %%%     scm_make_subr (s_ ## FNAME, TYPE, FNAME); \
 141 $$$1 PRIMNAME #ARGLIST | 2 | 0 | 0 | __FILE__:__LINE__ | @@@ DOCSTRING @!!!
 142
 143 #define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 144 %%%     scm_make_gsubr (RANAME, REQ, OPT, VAR, (SCM (*)()) CFN)
 145
 146 #define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
 147 %%%     scm_make_gsubr (RANAME, REQ, OPT, VAR, (SCM (*)()) CFN); \
 148 $$$R STR | REQ | OPT | VAR | __FILE__:__LINE__ | @@@ CFN @!!!
 149
 150 #define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
 151 %%%     scm_make_gsubr_with_generic (RANAME, REQ, OPT, VAR, (SCM (*)()) CFN, &GF)
 152
 153 #define SCM_PROC1(RANAME, STR, TYPE, CFN)  \
 154 %%%     scm_make_subr(RANAME, TYPE, CFN)
 155
 156 #define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF)  \
 157 %%%     scm_make_subr_with_generic(RANAME, TYPE, CFN, &GF)
 158
 159 #endif
 160 #endif
 161
 162 #ifndef SCM_MAGIC_SNARFER
 163 #define SCM_SYNTAX(RANAME, STR, TYPE, CFN)  \
 164         static const char RANAME[]=STR
 165 #else
 166 #define SCM_SYNTAX(RANAME, STR, TYPE, CFN)  \
 167 %%%     scm_make_synt (RANAME, TYPE, CFN)
 168 #endif
 169
 170 #ifndef SCM_MAGIC_SNARFER
 171 #define SCM_SYMBOL(c_name, scheme_name) \
 172         static SCM c_name = SCM_BOOL_F
 173 #else
 174 #define SCM_SYMBOL(C_NAME, SCHEME_NAME) \
 175 %%%     C_NAME = scm_permanent_object (SCM_CAR (scm_intern0 (SCHEME_NAME)))
 176 #endif
 177
 178 #ifndef SCM_MAGIC_SNARFER
 179 #define SCM_GLOBAL_SYMBOL(c_name, scheme_name) \
 180         SCM c_name = SCM_BOOL_F
 181 #else
 182 #define SCM_GLOBAL_SYMBOL(C_NAME, SCHEME_NAME) \
 183 %%%     C_NAME = scm_permanent_object (SCM_CAR (scm_intern0 (SCHEME_NAME)))
 184 #endif
 185
 186 #ifndef SCM_MAGIC_SNARFER
 187 #define SCM_KEYWORD(c_name, scheme_name) \
 188         static SCM c_name = SCM_BOOL_F
 189 #else
 190 #define SCM_KEYWORD(C_NAME, SCHEME_NAME) \
 191 %%%     C_NAME = scm_permanent_object (scm_c_make_keyword (SCHEME_NAME))
 192 #endif
 193
 194 #ifndef SCM_MAGIC_SNARFER
 195 #define SCM_GLOBAL_KEYWORD(c_name, scheme_name) \
 196         SCM c_name = SCM_BOOL_F
 197 #else
 198 #define SCM_GLOBAL_KEYWORD(C_NAME, SCHEME_NAME) \
 199 %%%     C_NAME = scm_permanent_object (scm_c_make_keyword (SCHEME_NAME))
 200 #endif
 201
 202 #ifndef SCM_MAGIC_SNARFER
 203 #define SCM_VCELL(c_name, scheme_name) \
 204         static SCM c_name = SCM_BOOL_F
 205 #else
 206 #define SCM_VCELL(C_NAME, SCHEME_NAME) \
 207 %%%     C_NAME = scm_permanent_object (scm_intern0 (SCHEME_NAME)); SCM_SETCDR (C_NAME, SCM_BOOL_F)
 208 #endif
 209
 210 #ifndef SCM_MAGIC_SNARFER
 211 #define SCM_GLOBAL_VCELL(c_name, scheme_name) \
 212         SCM c_name = SCM_BOOL_F
 213 #else
 214 #define SCM_GLOBAL_VCELL(C_NAME, SCHEME_NAME) \
 215 %%%     C_NAME = scm_permanent_object (scm_intern0 (SCHEME_NAME)); SCM_SETCDR (C_NAME, SCM_BOOL_F)
 216 #endif
 217
 218 #ifndef SCM_MAGIC_SNARFER
 219 #define SCM_VCELL_INIT(c_name, scheme_name, init_val) \
 220         static SCM c_name = SCM_BOOL_F
 221 #else
 222 #define SCM_VCELL_INIT(C_NAME, SCHEME_NAME, init_val) \
 223 %%%     C_NAME = scm_permanent_object (scm_intern0 (SCHEME_NAME)); SCM_SETCDR (C_NAME, init_val)
 224 #endif
 225
 226 #ifndef SCM_MAGIC_SNARFER
 227 #define SCM_GLOBAL_VCELL_INIT(c_name, scheme_name, init_val) \
 228         SCM c_name = SCM_BOOL_F
 229 #else
 230 #define SCM_GLOBAL_VCELL_INIT(C_NAME, SCHEME_NAME, init_val) \
 231 %%%     C_NAME = scm_permanent_object (scm_intern0 (SCHEME_NAME)); SCM_SETCDR (C_NAME, init_val)
 232 #endif
 233
 234 #define SCM_CONST_LONG(C_NAME, SCHEME_NAME,VALUE) SCM_VCELL_INIT(C_NAME, SCHEME_NAME, scm_long2num(VALUE))
 235
 236 #endif /* LIBGUILE_SNARF_H */