[bpt/guile.git] / libguile / snarf.h

/* classes: h_files */

#ifndef SCM_SNARF_H
#define SCM_SNARF_H

/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2009 Free Software Foundation, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

\f

/* Macros for snarfing initialization actions from C source. */

#if defined(__cplusplus) || defined(GUILE_CPLUSPLUS_SNARF)

/* This used to be "SCM (*)(...)" but GCC on RedHat 7.1 doesn't seem
   to like it.
 */
#define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()

#else
#define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()
#endif

#if (defined SCM_ALIGNED) && (SCM_DEBUG_TYPING_STRICTNESS <= 1)
/* We support static allocation of some `SCM' objects.  */
# define SCM_SUPPORT_STATIC_ALLOCATION
#endif

/* C preprocessor token concatenation.  */
#define scm_i_paste(x, y)      x ## y
#define scm_i_paste3(a, b, c)  a ## b ## c


\f
/* Generic macros to be used in user macro definitions.
 *
 * For example, in order to define a macro which creates ints and
 * initializes them to the result of foo (), do:
 *
 *   #define SCM_FOO(NAME) \
 *     SCM_SNARF_HERE (int NAME) \
 *     SCM_SNARF_INIT (NAME = foo ())
 *
 * The SCM_SNARF_INIT text goes into the corresponding .x file
 * up through the first occurrence of SCM_SNARF_DOC_START on that
 * line, if any.
 */

#ifdef SCM_MAGIC_SNARF_INITS
# define SCM_SNARF_HERE(X)
# define SCM_SNARF_INIT(X) ^^ X ^:^
# define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
#else
# ifdef SCM_MAGIC_SNARF_DOCS
#  define SCM_SNARF_HERE(X)
#  define SCM_SNARF_INIT(X)
#  define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING) \
^^ { \
cname CNAME ^^ \
fname FNAME ^^ \
type TYPE ^^ \
location __FILE__ __LINE__ ^^ \
arglist ARGLIST ^^ \
argsig REQ OPT VAR ^^ \
DOCSTRING ^^ }
# else
#  define SCM_SNARF_HERE(X) X
#  define SCM_SNARF_INIT(X)
#  define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
# endif
#endif

#define SCM_DEFINE_GSUBR(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
SCM_SNARF_HERE(\
static const char s_ ## FNAME [] = PRIMNAME; \
SCM FNAME ARGLIST\
)\
SCM_SNARF_INIT(\
scm_c_define_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
                    (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
)\
SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)

#ifdef SCM_SUPPORT_STATIC_ALLOCATION

/* Static subr allocation.  */
#define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING)	\
SCM_SYMBOL (scm_i_paste (FNAME, __name), PRIMNAME);			\
SCM_SNARF_HERE(								\
  static const char scm_i_paste (s_, FNAME) [] = PRIMNAME;		\
  SCM_IMMUTABLE_SUBR (scm_i_paste (FNAME, __subr),			\
		      scm_i_paste (FNAME, __name),			\
		      REQ, OPT, VAR, &FNAME);				\
  SCM FNAME ARGLIST							\
)									\
SCM_SNARF_INIT(								\
  /* Initialize the procedure name (an interned symbol).  */		\
  scm_i_paste (FNAME, __subr_meta_info)[0] = scm_i_paste (FNAME, __name); \
									\
  /* Define the subr.  */						\
  scm_c_define (scm_i_paste (s_, FNAME), scm_i_paste (FNAME, __subr));	\
)									\
SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)

#else /* !SCM_SUPPORT_STATIC_ALLOCATION */

/* Always use the generic subr case.  */
#define SCM_DEFINE SCM_DEFINE_GSUBR

#endif /* !SCM_SUPPORT_STATIC_ALLOCATION */


#define SCM_PRIMITIVE_GENERIC(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
SCM_SNARF_HERE(\
static const char s_ ## FNAME [] = PRIMNAME; \
static SCM g_ ## FNAME; \
SCM FNAME ARGLIST\
)\
SCM_SNARF_INIT(\
g_ ## FNAME = SCM_PACK (0); \
scm_c_define_gsubr_with_generic (s_ ## FNAME, REQ, OPT, VAR, \
                    		 (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME, \
				 &g_ ## FNAME); \
)\
SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)

#define SCM_DEFINE_PUBLIC(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
SCM_SNARF_HERE(\
static const char s_ ## FNAME [] = PRIMNAME; \
SCM FNAME ARGLIST\
)\
SCM_SNARF_INIT(\
scm_c_define_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
                    (SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
scm_c_export (s_ ## FNAME, NULL); \
)\
SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)

#define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
SCM_SNARF_HERE(\
static const char s_ ## FNAME [] = PRIMNAME; \
SCM FNAME ARGLIST\
)\
SCM_SNARF_INIT(scm_c_define_subr (s_ ## FNAME, TYPE, FNAME); ) \
SCM_SNARF_DOCS(1, FNAME, PRIMNAME, ARGLIST, 2, 0, 0, DOCSTRING)

#define SCM_PRIMITIVE_GENERIC_1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
SCM_SNARF_HERE(\
static const char s_ ## FNAME [] = PRIMNAME; \
static SCM g_ ## FNAME; \
SCM FNAME ARGLIST\
)\
SCM_SNARF_INIT(\
g_ ## FNAME = SCM_PACK (0); \
scm_c_define_subr_with_generic (s_ ## FNAME, TYPE, FNAME, &g_ ## FNAME); \
)\
SCM_SNARF_DOCS(1, FNAME, PRIMNAME, ARGLIST, 2, 0, 0, DOCSTRING)

#define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
SCM_SNARF_HERE(static const char RANAME[]=STR) \
SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
                                   (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN))

#define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN)  \
SCM_SNARF_HERE(static const char RANAME[]=STR) \
SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
                                   (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN);) \
SCM_SNARF_DOCS(register, CFN, STR, (), REQ, OPT, VAR, \
               "implemented by the C function \"" #CFN "\"")

#define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF)  \
SCM_SNARF_HERE(\
static const char RANAME[]=STR;\
static SCM GF \
)SCM_SNARF_INIT(\
GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
scm_c_define_gsubr_with_generic (RANAME, REQ, OPT, VAR, \
                                 (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
)

#define SCM_PROC1(RANAME, STR, TYPE, CFN) \
SCM_SNARF_HERE(static const char RANAME[]=STR) \
SCM_SNARF_INIT(\
scm_c_define_subr (RANAME, TYPE, (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN) \
)


#define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF) \
SCM_SNARF_HERE(\
static const char RANAME[]=STR; \
static SCM GF \
)SCM_SNARF_INIT(\
GF = SCM_PACK (0);  /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
scm_c_define_subr_with_generic (RANAME, TYPE, \
                                (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
)

#define SCM_SYNTAX(RANAME, STR, TYPE, CFN)  \
SCM_SNARF_HERE(static const char RANAME[]=STR)\
SCM_SNARF_INIT(scm_make_synt (RANAME, TYPE, CFN))

#ifdef SCM_SUPPORT_STATIC_ALLOCATION

# define SCM_SYMBOL(c_name, scheme_name)				\
SCM_SNARF_HERE(								\
  SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name);	\
  static SCM c_name)							\
SCM_SNARF_INIT(								\
  c_name = scm_string_to_symbol (scm_i_paste (c_name, _string))		\
)

# define SCM_GLOBAL_SYMBOL(c_name, scheme_name)				\
SCM_SNARF_HERE(								\
  SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name);	\
  SCM c_name)								\
SCM_SNARF_INIT(								\
  c_name = scm_string_to_symbol (scm_i_paste (c_name, _string))		\
)

#else /* !SCM_SUPPORT_STATIC_ALLOCATION */

# define SCM_SYMBOL(c_name, scheme_name)				\
SCM_SNARF_HERE(static SCM c_name)					\
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))

# define SCM_GLOBAL_SYMBOL(c_name, scheme_name)				\
SCM_SNARF_HERE(SCM c_name)						\
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))

#endif /* !SCM_SUPPORT_STATIC_ALLOCATION */

#define SCM_KEYWORD(c_name, scheme_name) \
SCM_SNARF_HERE(static SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))

#define SCM_GLOBAL_KEYWORD(c_name, scheme_name) \
SCM_SNARF_HERE(SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))

#define SCM_VARIABLE(c_name, scheme_name) \
SCM_SNARF_HERE(static SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, SCM_BOOL_F));)

#define SCM_GLOBAL_VARIABLE(c_name, scheme_name) \
SCM_SNARF_HERE(SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, SCM_BOOL_F));)

#define SCM_VARIABLE_INIT(c_name, scheme_name, init_val) \
SCM_SNARF_HERE(static SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, init_val));)

#define SCM_GLOBAL_VARIABLE_INIT(c_name, scheme_name, init_val) \
SCM_SNARF_HERE(SCM c_name) \
SCM_SNARF_INIT(c_name = scm_permanent_object (scm_c_define (scheme_name, init_val));)

#define SCM_MUTEX(c_name) \
SCM_SNARF_HERE(static scm_t_mutex c_name) \
SCM_SNARF_INIT(scm_i_plugin_mutex_init (&c_name, &scm_i_plugin_mutex))

#define SCM_GLOBAL_MUTEX(c_name) \
SCM_SNARF_HERE(scm_t_mutex c_name) \
SCM_SNARF_INIT(scm_i_plugin_mutex_init (&c_name, &scm_i_plugin_mutex))

#define SCM_REC_MUTEX(c_name) \
SCM_SNARF_HERE(static scm_t_rec_mutex c_name) \
SCM_SNARF_INIT(scm_i_plugin_rec_mutex_init (&c_name, &scm_i_plugin_rec_mutex))

#define SCM_GLOBAL_REC_MUTEX(c_name) \
SCM_SNARF_HERE(scm_t_rec_mutex c_name) \
SCM_SNARF_INIT(scm_i_plugin_rec_mutex_init (&c_name, &scm_i_plugin_rec_mutex))

#define SCM_SMOB(tag, scheme_name, size) \
SCM_SNARF_HERE(static scm_t_bits tag) \
SCM_SNARF_INIT((tag)=scm_make_smob_type((scheme_name), (size));)

#define SCM_GLOBAL_SMOB(tag, scheme_name, size) \
SCM_SNARF_HERE(scm_t_bits tag) \
SCM_SNARF_INIT((tag)=scm_make_smob_type((scheme_name), (size));)

#define SCM_SMOB_MARK(tag, c_name, arg) \
SCM_SNARF_HERE(static SCM c_name(SCM arg)) \
SCM_SNARF_INIT(scm_set_smob_mark((tag), (c_name));)

#define SCM_GLOBAL_SMOB_MARK(tag, c_name, arg) \
SCM_SNARF_HERE(SCM c_name(SCM arg)) \
SCM_SNARF_INIT(scm_set_smob_mark((tag), (c_name));)

#define SCM_SMOB_FREE(tag, c_name, arg) \
SCM_SNARF_HERE(static size_t c_name(SCM arg)) \
SCM_SNARF_INIT(scm_set_smob_free((tag), (c_name));)

#define SCM_GLOBAL_SMOB_FREE(tag, c_name, arg) \
SCM_SNARF_HERE(size_t c_name(SCM arg)) \
SCM_SNARF_INIT(scm_set_smob_free((tag), (c_name));)

#define SCM_SMOB_PRINT(tag, c_name, obj, port, pstate) \
SCM_SNARF_HERE(static int c_name(SCM obj, SCM port, scm_print_state* pstate)) \
SCM_SNARF_INIT(scm_set_smob_print((tag), (c_name));)

#define SCM_GLOBAL_SMOB_PRINT(tag, c_name, obj, port, pstate) \
SCM_SNARF_HERE(int c_name(SCM obj, SCM port, scm_print_state* pstate)) \
SCM_SNARF_INIT(scm_set_smob_print((tag), (c_name));)

#define SCM_SMOB_EQUALP(tag, c_name, obj1, obj2) \
SCM_SNARF_HERE(static SCM c_name(SCM obj1, SCM obj2)) \
SCM_SNARF_INIT(scm_set_smob_equalp((tag), (c_name));)

#define SCM_GLOBAL_SMOB_EQUALP(tag, c_name, obj1, obj2) \
SCM_SNARF_HERE(SCM c_name(SCM obj1, SCM obj2)) \
SCM_SNARF_INIT(scm_set_smob_equalp((tag), (c_name));)

#define SCM_SMOB_APPLY(tag, c_name, req, opt, rest, arglist) \
SCM_SNARF_HERE(static SCM c_name arglist) \
SCM_SNARF_INIT(scm_set_smob_apply((tag), (c_name), (req), (opt), (rest));)

#define SCM_GLOBAL_SMOB_APPLY(tag, c_name, req, opt, rest, arglist) \
SCM_SNARF_HERE(SCM c_name arglist) \
SCM_SNARF_INIT(scm_set_smob_apply((tag), (c_name), (req), (opt), (rest));)

\f
/* Low-level snarfing for static memory allocation.  */

#ifdef SCM_SUPPORT_STATIC_ALLOCATION

#define SCM_IMMUTABLE_DOUBLE_CELL(c_name, car, cbr, ccr, cdr)		\
  static SCM_ALIGNED (8) SCM_UNUSED const scm_t_cell			\
  c_name ## _raw_cell [2] =						\
    {									\
      { SCM_PACK (car), SCM_PACK (cbr) },				\
      { SCM_PACK (ccr), SCM_PACK (cdr) }				\
    };									\
  static SCM_UNUSED const SCM c_name = SCM_PACK (& c_name ## _raw_cell)

#define SCM_IMMUTABLE_STRINGBUF(c_name, contents)	\
  static SCM_UNUSED const				\
  struct						\
  {							\
    scm_t_bits word_0;					\
    scm_t_bits word_1;					\
    const char buffer[sizeof (contents)];		\
  }							\
  c_name =						\
    {							\
      scm_tc7_stringbuf | SCM_I_STRINGBUF_F_SHARED,	\
      sizeof (contents) - 1,				\
      contents						\
    }

#define SCM_IMMUTABLE_STRING(c_name, contents)				\
  SCM_IMMUTABLE_STRINGBUF (scm_i_paste (c_name, _stringbuf), contents);	\
  SCM_IMMUTABLE_DOUBLE_CELL (c_name,					\
			     scm_tc7_ro_string,				\
			     (scm_t_bits) &scm_i_paste (c_name,		\
							_stringbuf),	\
			     (scm_t_bits) 0,				\
			     (scm_t_bits) sizeof (contents) - 1)

#define SCM_IMMUTABLE_SUBR(c_name, name, req, opt, rest, fcn)		\
  static SCM_UNUSED SCM scm_i_paste (c_name, _meta_info)[2] =		\
    {									\
      SCM_BOOL_F,  /* The name, initialized at run-time.  */		\
      SCM_EOL      /* The procedure properties.  */			\
    };									\
  SCM_IMMUTABLE_DOUBLE_CELL (c_name,					\
			     SCM_SUBR_ARITY_TO_TYPE (req, opt, rest),	\
			     (scm_t_bits) fcn,				\
			     (scm_t_bits) 0 /* no generic */,		\
			     (scm_t_bits) & scm_i_paste (c_name, _meta_info));

#endif /* SCM_SUPPORT_STATIC_ALLOCATION */

\f
/* Documentation.  */

#ifdef SCM_MAGIC_SNARF_DOCS
#undef SCM_ASSERT
#define SCM_ASSERT(_cond, _arg, _pos, _subr) ^^ argpos _arg _pos __LINE__ ^^
#endif /* SCM_MAGIC_SNARF_DOCS */

#endif  /* SCM_SNARF_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
5b4215a8 JB	1	/* classes: h_files */
5b4215a8 JB	2
b29058ff DH	3	#ifndef SCM_SNARF_H
b29058ff DH	4	#define SCM_SNARF_H
5b4215a8	5
c6054fea	6	/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2009 Free Software Foundation, Inc.
b29058ff	7	*
73be1d9e	8	* This library is free software; you can redistribute it and/or
53befeb7 NJ	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.
b29058ff	12	*
53befeb7 NJ	13	* This library is distributed in the hope that it will be useful, but
53befeb7 NJ	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e MV	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73be1d9e MV	16	* Lesser General Public License for more details.
b29058ff	17	*
73be1d9e MV	18	* You should have received a copy of the GNU Lesser General Public
73be1d9e MV	19	* License along with this library; if not, write to the Free Software
53befeb7 NJ	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
53befeb7 NJ	21	* 02110-1301 USA
73be1d9e	22	*/
1bbd0b84	23
5b4215a8 JB	24	\f
5b4215a8 JB	25
b29058ff DH	26	/* Macros for snarfing initialization actions from C source. */
b29058ff DH	27
4b4d0898	28	#if defined(__cplusplus) \|\| defined(GUILE_CPLUSPLUS_SNARF)
e1fbffa9 MV	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
bfe19b46	35	#else
4b4d0898	36	#define SCM_FUNC_CAST_ARBITRARY_ARGS SCM (*)()
bfe19b46 MD	37	#endif
bfe19b46 MD	38
c6054fea LC	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
b68095f0 LC	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
c6054fea LC	48
c6054fea LC	49	\f
73d8385e MD	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) \
94a70859 MD	56	* SCM_SNARF_HERE (int NAME) \
94a70859 MD	57	* SCM_SNARF_INIT (NAME = foo ())
1e76143f	58	*
94a70859	59	* The SCM_SNARF_INIT text goes into the corresponding .x file
3c6d9d71 DH	60	* up through the first occurrence of SCM_SNARF_DOC_START on that
3c6d9d71 DH	61	* line, if any.
73d8385e MD	62	*/
73d8385e MD	63
c99f9605 ML	64	#ifdef SCM_MAGIC_SNARF_INITS
c99f9605 ML	65	# define SCM_SNARF_HERE(X)
09e804ff	66	# define SCM_SNARF_INIT(X) ^^ X ^:^
cecb4a5e	67	# define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
1e76143f	68	#else
c99f9605	69	# ifdef SCM_MAGIC_SNARF_DOCS
94a70859	70	# define SCM_SNARF_HERE(X)
c99f9605	71	# define SCM_SNARF_INIT(X)
cecb4a5e	72	# define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING) \
ac13d9d2	73	^^ { \
cecb4a5e	74	cname CNAME ^^ \
ac13d9d2 ML	75	fname FNAME ^^ \
	76	type TYPE ^^ \
	77	location __FILE__ __LINE__ ^^ \
	78	arglist ARGLIST ^^ \
	79	argsig REQ OPT VAR ^^ \
	80	DOCSTRING ^^ }
c99f9605 ML	81	# else
	82	# define SCM_SNARF_HERE(X) X
	83	# define SCM_SNARF_INIT(X)
cecb4a5e	84	# define SCM_SNARF_DOCS(TYPE, CNAME, FNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
c99f9605	85	# endif
1e76143f	86	#endif
73d8385e	87
46f9baf4	88	#define SCM_DEFINE_GSUBR(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
94a70859	89	SCM_SNARF_HERE(\
4b4d0898 GB	90	static const char s_ ## FNAME [] = PRIMNAME; \
	91	SCM FNAME ARGLIST\
	92	)\
94a70859	93	SCM_SNARF_INIT(\
9a441ddb MV	94	scm_c_define_gsubr (s_ ## FNAME, REQ, OPT, VAR, \
9a441ddb MV	95	(SCM_FUNC_CAST_ARBITRARY_ARGS) FNAME); \
2fdcf8bd	96	)\
cecb4a5e	97	SCM_SNARF_DOCS(primitive, FNAME, PRIMNAME, ARGLIST, REQ, OPT, VAR, DOCSTRING)
1bbd0b84	98
46f9baf4 LC	99	#ifdef SCM_SUPPORT_STATIC_ALLOCATION
46f9baf4 LC	100
f0eb5ae6 LC	101	/* Static subr allocation. */
f0eb5ae6 LC	102	#define SCM_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
46f9baf4 LC	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
46f9baf4 LC	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
a48d60b1 MD	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
5527702a MV	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
c3ee7520	154	#define SCM_DEFINE1(FNAME, PRIMNAME, TYPE, ARGLIST, DOCSTRING) \
94a70859	155	SCM_SNARF_HERE(\
4b4d0898 GB	156	static const char s_ ## FNAME [] = PRIMNAME; \
4b4d0898 GB	157	SCM FNAME ARGLIST\
2fdcf8bd	158	)\
9a441ddb	159	SCM_SNARF_INIT(scm_c_define_subr (s_ ## FNAME, TYPE, FNAME); ) \
cecb4a5e	160	SCM_SNARF_DOCS(1, FNAME, PRIMNAME, ARGLIST, 2, 0, 0, DOCSTRING)
1bbd0b84	161
a48d60b1 MD	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
9b1594fd	174	#define SCM_PROC(RANAME, STR, REQ, OPT, VAR, CFN) \
94a70859	175	SCM_SNARF_HERE(static const char RANAME[]=STR) \
9a441ddb MV	176	SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
9a441ddb MV	177	(SCM_FUNC_CAST_ARBITRARY_ARGS) CFN))
9b1594fd	178
1bbd0b84	179	#define SCM_REGISTER_PROC(RANAME, STR, REQ, OPT, VAR, CFN) \
94a70859	180	SCM_SNARF_HERE(static const char RANAME[]=STR) \
9a441ddb MV	181	SCM_SNARF_INIT(scm_c_define_gsubr (RANAME, REQ, OPT, VAR, \
9a441ddb MV	182	(SCM_FUNC_CAST_ARBITRARY_ARGS) CFN);) \
cecb4a5e	183	SCM_SNARF_DOCS(register, CFN, STR, (), REQ, OPT, VAR, \
c99f9605	184	"implemented by the C function \"" #CFN "\"")
3dc81fba	185
9de33deb	186	#define SCM_GPROC(RANAME, STR, REQ, OPT, VAR, CFN, GF) \
94a70859	187	SCM_SNARF_HERE(\
4b4d0898	188	static const char RANAME[]=STR;\
54778cd3	189	static SCM GF \
94a70859	190	)SCM_SNARF_INIT(\
54778cd3	191	GF = SCM_PACK (0); /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
9a441ddb MV	192	scm_c_define_gsubr_with_generic (RANAME, REQ, OPT, VAR, \
9a441ddb MV	193	(SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
4b4d0898	194	)
3dc81fba	195
4b4d0898	196	#define SCM_PROC1(RANAME, STR, TYPE, CFN) \
94a70859 MD	197	SCM_SNARF_HERE(static const char RANAME[]=STR) \
94a70859 MD	198	SCM_SNARF_INIT(\
9a441ddb	199	scm_c_define_subr (RANAME, TYPE, (SCM_FUNC_CAST_ARBITRARY_ARGS) CFN) \
4b4d0898	200	)
9b1594fd	201
9b1594fd	202
4b4d0898	203	#define SCM_GPROC1(RANAME, STR, TYPE, CFN, GF) \
94a70859	204	SCM_SNARF_HERE(\
4b4d0898	205	static const char RANAME[]=STR; \
54778cd3	206	static SCM GF \
94a70859	207	)SCM_SNARF_INIT(\
54778cd3	208	GF = SCM_PACK (0); /* Dirk:FIXME:: Can we safely use #f instead of 0? */ \
9a441ddb MV	209	scm_c_define_subr_with_generic (RANAME, TYPE, \
9a441ddb MV	210	(SCM_FUNC_CAST_ARBITRARY_ARGS) CFN, &GF) \
4b4d0898	211	)
5b4215a8	212
b8229a3b	213	#define SCM_SYNTAX(RANAME, STR, TYPE, CFN) \
94a70859 MD	214	SCM_SNARF_HERE(static const char RANAME[]=STR)\
94a70859 MD	215	SCM_SNARF_INIT(scm_make_synt (RANAME, TYPE, CFN))
b8229a3b	216
c6054fea LC	217	#ifdef SCM_SUPPORT_STATIC_ALLOCATION
	218
	219	# define SCM_SYMBOL(c_name, scheme_name) \
	220	SCM_SNARF_HERE( \
b68095f0	221	SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name); \
c6054fea	222	static SCM c_name) \
b68095f0 LC	223	SCM_SNARF_INIT( \
	224	c_name = scm_string_to_symbol (scm_i_paste (c_name, _string)) \
	225	)
c6054fea LC	226
	227	# define SCM_GLOBAL_SYMBOL(c_name, scheme_name) \
	228	SCM_SNARF_HERE( \
b68095f0	229	SCM_IMMUTABLE_STRING (scm_i_paste (c_name, _string), scheme_name); \
c6054fea	230	SCM c_name) \
b68095f0 LC	231	SCM_SNARF_INIT( \
	232	c_name = scm_string_to_symbol (scm_i_paste (c_name, _string)) \
	233	)
c6054fea LC	234
	235	#else /* !SCM_SUPPORT_STATIC_ALLOCATION */
	236
	237	# define SCM_SYMBOL(c_name, scheme_name) \
	238	SCM_SNARF_HERE(static SCM c_name) \
cc95e00a	239	SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))
5b4215a8	240
c6054fea LC	241	# define SCM_GLOBAL_SYMBOL(c_name, scheme_name) \
c6054fea LC	242	SCM_SNARF_HERE(SCM c_name) \
cc95e00a	243	SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_symbol (scheme_name)))
78f9f47b	244
c6054fea LC	245	#endif /* !SCM_SUPPORT_STATIC_ALLOCATION */
c6054fea LC	246
37b83f68	247	#define SCM_KEYWORD(c_name, scheme_name) \
94a70859	248	SCM_SNARF_HERE(static SCM c_name) \
ee4140fb	249	SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))
37b83f68	250
37b83f68	251	#define SCM_GLOBAL_KEYWORD(c_name, scheme_name) \
94a70859	252	SCM_SNARF_HERE(SCM c_name) \
ee4140fb	253	SCM_SNARF_INIT(c_name = scm_permanent_object (scm_from_locale_keyword (scheme_name)))
5b4215a8	254
86d31dfe MV	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
28d52ebb MD	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))
9bc4701c	274
28d52ebb MD	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))
9bc4701c	278
28d52ebb MD	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))
9bc4701c	282
28d52ebb MD	283	#define SCM_GLOBAL_REC_MUTEX(c_name) \
28d52ebb MD	284	SCM_SNARF_HERE(scm_t_rec_mutex c_name) \
0b6843b1	285	SCM_SNARF_INIT(scm_i_plugin_rec_mutex_init (&c_name, &scm_i_plugin_rec_mutex))
9bc4701c	286
94e38a65 MV	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
c6054fea LC	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
5f236208 LC	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	}
c6054fea LC	363
c6054fea LC	364	#define SCM_IMMUTABLE_STRING(c_name, contents) \
b68095f0	365	SCM_IMMUTABLE_STRINGBUF (scm_i_paste (c_name, _stringbuf), contents); \
c6054fea LC	366	SCM_IMMUTABLE_DOUBLE_CELL (c_name, \
c6054fea LC	367	scm_tc7_ro_string, \
b68095f0	368	(scm_t_bits) &scm_i_paste (c_name, \
5f236208	369	_stringbuf), \
c6054fea LC	370	(scm_t_bits) 0, \
	371	(scm_t_bits) sizeof (contents) - 1)
	372
46f9baf4 LC	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
c6054fea LC	385	#endif /* SCM_SUPPORT_STATIC_ALLOCATION */
	386
	387	\f
	388	/* Documentation. */
94e38a65	389
c99f9605	390	#ifdef SCM_MAGIC_SNARF_DOCS
4b4d0898	391	#undef SCM_ASSERT
ac13d9d2	392	#define SCM_ASSERT(_cond, _arg, _pos, _subr) ^^ argpos _arg _pos __LINE__ ^^
c99f9605	393	#endif /* SCM_MAGIC_SNARF_DOCS */
2e07d033	394
b29058ff	395	#endif /* SCM_SNARF_H */
89e00824 ML	396
	397	/*
	398	Local Variables:
	399	c-file-style: "gnu"
	400	End:
	401	*/