2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 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
26 // if Guile's internal representation switches to utf8, this should be
27 // changed accordingly for efficiency's sake. This is used for
28 // strings known to be in ASCII entirely, including any string
29 // constants in the C code.
30 #define scm_from_ascii_string scm_from_latin1_string
31 #define scm_from_ascii_stringn scm_from_latin1_stringn
32 #define scm_from_ascii_symbol scm_from_latin1_symbol
34 #define scm_from_ascii_string scm_from_locale_string
35 #define scm_from_ascii_stringn scm_from_locale_stringn
36 #define scm_from_ascii_symbol scm_from_locale_symbol
37 #define scm_from_latin1_string scm_from_locale_string
38 #define scm_from_latin1_stringn scm_from_locale_stringn
39 #define scm_from_utf8_string scm_from_locale_string
40 #define scm_from_utf8_symbol scm_from_locale_symbol
41 #define scm_to_utf8_string scm_to_locale_string
44 #ifndef SMOB_FREE_RETURN_VAL
45 #define SMOB_FREE_RETURN_VAL(CL) 0
49 #define SCM_PACK(x) ((SCM) x)
53 #define SCM_UNPACK(x) (x)
56 /* For backward compatability with Guile 1.8 */
57 #if !HAVE_GUILE_SUBR_TYPE
58 typedef SCM (*scm_t_subr) (GUILE_ELLIPSIS);
61 /* Unreliable with gcc-2.x
62 FIXME: should add check for x86 as well? */
67 /* this lets us "overload" macros such as get_property to take
68 symbols as well as strings */
70 scm_or_str2symbol (char const *c) { return scm_from_utf8_symbol (c); }
73 scm_or_str2symbol (SCM s)
75 assert (scm_is_symbol (s));
79 /* Using this trick we cache the value of scm_from_locale_symbol ("fooo") where
80 "fooo" is a constant string. This is done at the cost of one static
81 variable per ly_symbol2scm() use, and one boolean evaluation for
84 #define ly_symbol2scm(x) \
87 /* We store this one locally, since G++ -O2 fucks up else */ \
89 if (__builtin_constant_p ((x))) \
91 if (!SCM_UNPACK (cached)) \
92 value = cached = scm_gc_protect_object (scm_or_str2symbol (x)); \
95 value = scm_or_str2symbol (x); \
99 inline SCM ly_symbol2scm (char const *x) { return scm_from_utf8_symbol ((x)); }
103 Adds the NAME as a Scheme function, and a variable to store the SCM
104 version of the function in the static variable NAME_proc
106 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
107 static SCM NAME ARGS; \
108 static SCM NAME ## _proc
110 string mangle_cxx_identifier (string);
112 void ly_add_type_predicate (void *ptr, const string &name);
113 string predicate_to_typename (void *ptr);
116 Make TYPE::FUNC available as a Scheme function.
118 #define MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, OPTIONAL_COUNT, DOC) \
119 SCM TYPE ::FUNC ## _proc; \
121 TYPE ## _ ## FUNC ## _init_functions () \
123 string cxx = string (#TYPE) + "::" + string (#FUNC); \
124 string id = mangle_cxx_identifier (cxx); \
125 TYPE ::FUNC ## _proc = scm_c_define_gsubr (id.c_str(), \
126 (ARGCOUNT-OPTIONAL_COUNT), OPTIONAL_COUNT, 0, \
127 (scm_t_subr) TYPE::FUNC); \
128 ly_add_function_documentation (TYPE :: FUNC ## _proc, id.c_str(), "", \
130 scm_c_export (id.c_str (), NULL); \
133 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
134 TYPE ## _ ## FUNC ## _init_functions);
136 #define MAKE_DOCUMENTED_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT, DOC) \
137 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, 0, DOC);
139 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
140 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE,FUNC,ARGCOUNT, 0, "");
142 void ly_add_function_documentation (SCM proc, const string &fname, const string &varlist, const string &doc);
143 void ly_check_name (const string &cxx, const string &fname);
145 #define ADD_SCM_INIT_FUNC(name, func) \
146 class name ## _scm_initter \
149 name ## _scm_initter () \
151 add_scm_init_func (func); \
154 _ ## name ## _scm_initter;
158 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
159 ARGLIST, DOCSTRING) \
160 SCM FNAME ## _proc; \
162 INITPREFIX ## init () \
164 FNAME ## _proc = scm_c_define_gsubr (PRIMNAME, REQ, OPT, VAR, \
165 (scm_t_subr) FNAME); \
166 ly_check_name (#FNAME, PRIMNAME);\
167 ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
169 scm_c_export (PRIMNAME, NULL); \
171 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
175 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
177 LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
180 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
181 ARGLIST, DOCSTRING) \
183 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
184 VAR, ARGLIST, DOCSTRING)
186 #define get_property(x) internal_get_property (ly_symbol2scm (x))
187 #define get_pure_property(x,y,z) \
188 internal_get_pure_property (ly_symbol2scm (x), y, z)
189 #define get_maybe_pure_property(w,x,y,z) \
190 internal_get_maybe_pure_property (ly_symbol2scm (w), x, y, z)
191 #define get_property_data(x) internal_get_property_data (ly_symbol2scm (x))
192 #define get_object(x) internal_get_object (ly_symbol2scm (x))
193 #define set_object(x, y) internal_set_object (ly_symbol2scm (x), y)
194 #define del_property(x) internal_del_property (ly_symbol2scm (x))
198 TODO: include modification callback support here, perhaps
199 through intermediate Grob::instrumented_set_property( .. __LINE__ ).
201 #define set_property(x, y) instrumented_set_property (ly_symbol2scm (x), y, __FILE__, __LINE__, __FUNCTION__)
203 #define set_property(x, y) internal_set_property (ly_symbol2scm (x), y)
206 #define LY_ASSERT_TYPE(pred, var, number) \
210 scm_wrong_type_arg_msg(mangle_cxx_identifier (__FUNCTION__).c_str(), \
212 predicate_to_typename ((void*) &pred).c_str()); \
219 void ly_wrong_smob_arg (bool pred (SCM), SCM var, int number, const char *fun);
221 // Do not call this directly.
222 // Use LY_ASSERT_SMOB() which supplies the function name automatically.
224 inline T *ly_assert_smob (SCM var, int number, const char *fun)
226 T *smob = unsmob<T> (var);
230 ly_wrong_smob_arg (T::is_smob, var, number, fun);
234 // Could be just implemented using LY_ASSERT_TYPE, but this variant
235 // saves a slight amount of code
237 #define LY_ASSERT_SMOB(klass, var, number) \
238 ly_assert_smob<klass> (var, number, __FUNCTION__)
240 #endif /* LILY_GUILE_MACROS_HH */