2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef LILY_GUILE_MACROS_HH
21 #define LILY_GUILE_MACROS_HH
25 #ifndef SMOB_FREE_RETURN_VAL
26 #define SMOB_FREE_RETURN_VAL(CL) 0
30 #define SCM_PACK(x) ((SCM) x)
34 #define SCM_UNPACK(x) (x)
37 /* For backward compatability with Guile 1.8 */
38 #if !HAVE_GUILE_SUBR_TYPE
39 typedef SCM (*scm_t_subr) (GUILE_ELLIPSIS);
42 /* Unreliable with gcc-2.x
43 FIXME: should add check for x86 as well? */
48 /* this lets us "overload" macros such as get_property to take
49 symbols as well as strings */
51 scm_or_str2symbol (char const *c) { return scm_from_locale_symbol (c); }
54 scm_or_str2symbol (SCM s)
56 assert (scm_is_symbol (s));
60 /* Using this trick we cache the value of scm_from_locale_symbol ("fooo") where
61 "fooo" is a constant string. This is done at the cost of one static
62 variable per ly_symbol2scm() use, and one boolean evaluation for
65 #define ly_symbol2scm(x) \
68 /* We store this one locally, since G++ -O2 fucks up else */ \
70 if (__builtin_constant_p ((x))) \
73 value = cached = scm_gc_protect_object (scm_or_str2symbol (x)); \
76 value = scm_or_str2symbol (x); \
80 inline SCM ly_symbol2scm (char const *x) { return scm_from_locale_symbol ((x)); }
84 TODO: rename me to ly_c_lily_module_eval
86 we don't have to protect the result; it's already part of the
87 exports list of the module.
90 #define ly_lily_module_constant(x) \
93 /* We store this one locally, since G++ -O2 fucks up else */ \
95 if (__builtin_constant_p ((x))) \
98 value = cached = scm_eval (scm_from_locale_symbol (x), \
99 global_lily_module); \
102 value = scm_eval (scm_from_locale_symbol (x), global_lily_module); \
107 Adds the NAME as a Scheme function, and a variable to store the SCM
108 version of the function in the static variable NAME_proc
110 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
111 static SCM NAME ARGS; \
112 static SCM NAME ## _proc
113 #define ADD_TYPE_PREDICATE(func, type_name) \
115 func ## _type_adder () \
117 ly_add_type_predicate ((Type_predicate_ptr)func, type_name); \
119 ADD_SCM_INIT_FUNC(func ## _type_adder_ctor, \
120 func ## _type_adder);
121 #define ADD_TYPE_PREDICATE(func, type_name) \
123 func ## _type_adder () \
125 ly_add_type_predicate ((Type_predicate_ptr)func, type_name); \
127 ADD_SCM_INIT_FUNC(func ## _type_adder_ctor, \
128 func ## _type_adder);
130 string mangle_cxx_identifier (string);
132 void ly_add_type_predicate (void *ptr, string name);
133 string predicate_to_typename (void *ptr);
136 Make TYPE::FUNC available as a Scheme function.
138 #define MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, OPTIONAL_COUNT, DOC) \
139 SCM TYPE ::FUNC ## _proc; \
141 TYPE ## _ ## FUNC ## _init_functions () \
143 string cxx = string (#TYPE) + "::" + string (#FUNC); \
144 string id = mangle_cxx_identifier (cxx); \
145 TYPE ::FUNC ## _proc = scm_c_define_gsubr (id.c_str(), \
146 (ARGCOUNT-OPTIONAL_COUNT), OPTIONAL_COUNT, 0, \
147 (scm_t_subr) TYPE::FUNC); \
148 ly_add_function_documentation (TYPE :: FUNC ## _proc, id.c_str(), "", \
150 scm_c_export (id.c_str (), NULL); \
153 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
154 TYPE ## _ ## FUNC ## _init_functions);
156 #define MAKE_DOCUMENTED_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT, DOC) \
157 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, 0, DOC);
159 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
160 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE,FUNC,ARGCOUNT, 0, "");
162 void ly_add_function_documentation (SCM proc, string fname, string varlist, string doc);
163 void ly_check_name (string cxx, string fname);
165 #define ADD_SCM_INIT_FUNC(name, func) \
166 class name ## _scm_initter \
169 name ## _scm_initter () \
171 add_scm_init_func (func); \
174 _ ## name ## _scm_initter;
178 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
179 ARGLIST, DOCSTRING) \
180 SCM FNAME ## _proc; \
182 INITPREFIX ## init () \
184 FNAME ## _proc = scm_c_define_gsubr (PRIMNAME, REQ, OPT, VAR, \
185 (scm_t_subr) FNAME); \
186 ly_check_name (#FNAME, PRIMNAME);\
187 ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
189 scm_c_export (PRIMNAME, NULL); \
191 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
195 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
197 LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
200 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
201 ARGLIST, DOCSTRING) \
203 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
204 VAR, ARGLIST, DOCSTRING)
206 #define get_property(x) internal_get_property (ly_symbol2scm (x))
207 #define get_pure_property(x,y,z) \
208 internal_get_pure_property (ly_symbol2scm (x), y, z)
209 #define get_maybe_pure_property(w,x,y,z) \
210 internal_get_maybe_pure_property (ly_symbol2scm (w), x, y, z)
211 #define get_property_data(x) internal_get_property_data (ly_symbol2scm (x))
212 #define get_object(x) internal_get_object (ly_symbol2scm (x))
213 #define set_object(x, y) internal_set_object (ly_symbol2scm (x), y)
214 #define del_property(x) internal_del_property (ly_symbol2scm (x))
218 TODO: include modification callback support here, perhaps
219 through intermediate Grob::instrumented_set_property( .. __LINE__ ).
221 #define set_property(x, y) instrumented_set_property (ly_symbol2scm (x), y, __FILE__, __LINE__, __FUNCTION__)
223 #define set_property(x, y) internal_set_property (ly_symbol2scm (x), y)
226 #define LY_ASSERT_TYPE(pred, var, number) \
230 scm_wrong_type_arg_msg(mangle_cxx_identifier (__FUNCTION__).c_str(), \
232 predicate_to_typename ((void*) &pred).c_str()); \
236 #define LY_ASSERT_SMOB(klass, var, number) LY_ASSERT_TYPE(klass::unsmob, var, number)
238 #endif /* LILY_GUILE_MACROS_HH */