2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2010 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
23 #ifndef SMOB_FREE_RETURN_VAL
24 #define SMOB_FREE_RETURN_VAL(CL) 0
28 #define SCM_PACK(x) ((SCM) x)
32 #define SCM_UNPACK(x) (x)
35 /* Unreliable with gcc-2.x
36 FIXME: should add check for x86 as well? */
41 /* this lets us "overload" macros such as get_property to take
42 symbols as well as strings */
44 scm_or_str2symbol (char const *c) { return scm_str2symbol (c); }
47 scm_or_str2symbol (SCM s) {
48 assert (scm_is_symbol (s));
52 /* Using this trick we cache the value of scm_str2symbol ("fooo") where
53 "fooo" is a constant string. This is done at the cost of one static
54 variable per ly_symbol2scm() use, and one boolean evaluation for
57 #define ly_symbol2scm(x) \
60 /* We store this one locally, since G++ -O2 fucks up else */ \
62 if (__builtin_constant_p ((x))) \
65 value = cached = scm_gc_protect_object (scm_or_str2symbol (x)); \
68 value = scm_or_str2symbol (x); \
72 inline SCM ly_symbol2scm (char const *x) { return scm_str2symbol ((x)); }
76 TODO: rename me to ly_c_lily_module_eval
78 we don't have to protect the result; it's already part of the
79 exports list of the module.
82 #define ly_lily_module_constant(x) \
85 /* We store this one locally, since G++ -O2 fucks up else */ \
87 if (__builtin_constant_p ((x))) \
90 value = cached = scm_eval (scm_str2symbol (x), \
91 global_lily_module); \
94 value = scm_eval (scm_str2symbol (x), global_lily_module); \
99 Adds the NAME as a Scheme function, and a variable to store the SCM
100 version of the function in the static variable NAME_proc
102 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
103 static SCM NAME ARGS; \
104 static SCM NAME ## _proc
105 #define ADD_TYPE_PREDICATE(func, type_name) \
107 func ## _type_adder () \
109 ly_add_type_predicate ((Type_predicate_ptr)func, type_name); \
111 ADD_SCM_INIT_FUNC(func ## _type_adder_ctor, \
112 func ## _type_adder);
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);
122 string mangle_cxx_identifier (string);
124 void ly_add_type_predicate (void *ptr, string name);
125 string predicate_to_typename (void *ptr);
128 Make TYPE::FUNC available as a Scheme function.
130 #define MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, OPTIONAL_COUNT, DOC) \
131 SCM TYPE ::FUNC ## _proc; \
133 TYPE ## _ ## FUNC ## _init_functions () \
135 string cxx = string (#TYPE) + "::" + string (#FUNC); \
136 string id = mangle_cxx_identifier (cxx); \
137 TYPE ::FUNC ## _proc = scm_c_define_gsubr (id.c_str(), \
138 (ARGCOUNT-OPTIONAL_COUNT), OPTIONAL_COUNT, 0, \
139 (Scheme_function_unknown) TYPE::FUNC); \
140 ly_add_function_documentation (TYPE :: FUNC ## _proc, id.c_str(), "", \
142 scm_c_export (id.c_str (), NULL); \
145 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
146 TYPE ## _ ## FUNC ## _init_functions);
148 #define MAKE_DOCUMENTED_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT, DOC) \
149 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, 0, DOC);
151 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
152 MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE,FUNC,ARGCOUNT, 0, "");
154 void ly_add_function_documentation (SCM proc, string fname, string varlist, string doc);
155 void ly_check_name (string cxx, string fname);
157 #define ADD_SCM_INIT_FUNC(name, func) \
158 class name ## _scm_initter \
161 name ## _scm_initter () \
163 add_scm_init_func (func); \
166 _ ## name ## _scm_initter;
170 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
171 ARGLIST, DOCSTRING) \
172 SCM FNAME ## _proc; \
174 INITPREFIX ## init () \
176 FNAME ## _proc = scm_c_define_gsubr (PRIMNAME, REQ, OPT, VAR, \
177 (Scheme_function_unknown) FNAME); \
178 ly_check_name (#FNAME, PRIMNAME);\
179 ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
181 scm_c_export (PRIMNAME, NULL); \
183 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
187 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
189 LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
192 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
193 ARGLIST, DOCSTRING) \
195 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
196 VAR, ARGLIST, DOCSTRING)
198 #define get_property(x) internal_get_property (ly_symbol2scm (x))
199 #define get_property_data(x) internal_get_property_data (ly_symbol2scm (x))
200 #define get_object(x) internal_get_object (ly_symbol2scm (x))
201 #define set_object(x, y) internal_set_object (ly_symbol2scm (x), y)
202 #define del_property(x) internal_del_property (ly_symbol2scm (x))
206 TODO: include modification callback support here, perhaps
207 through intermediate Grob::instrumented_set_property( .. __LINE__ ).
209 #define set_property(x, y) instrumented_set_property (ly_symbol2scm (x), y, __FILE__, __LINE__, __FUNCTION__)
211 #define set_property(x, y) internal_set_property (ly_symbol2scm (x), y)
216 #define LY_ASSERT_TYPE(pred, var, number) \
220 scm_wrong_type_arg_msg(mangle_cxx_identifier (__FUNCTION__).c_str(), \
222 predicate_to_typename ((void*) &pred).c_str()); \
226 #define LY_ASSERT_SMOB(klass, var, number) LY_ASSERT_TYPE(klass::unsmob, var, number)
230 #endif /* LILY_GUILE_MACROS_HH */