2 lily-guile.hh encapsulate guile
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
13 #include "flower-proto.hh"
15 #include "drul-array.hh"
16 #include "direction.hh"
18 #if SCM_MINOR_VERSION < 7
19 /* guile-1.6.x compatibility */
20 #define scm_gc_unregister_collectable_memory(a, b, c) scm_done_free (b)
21 #define scm_gc_register_collectable_memory(a, b, c) scm_done_malloc (b)
22 #define SCM_VECTOR_REF(v,i) (SCM_VELTS ((v))[(i)])
23 #define scm_from_int(x) SCM_MAKINUM (x)
24 #define scm_is_integer(x) SCM_INUMP (x)
25 #define scm_is_string(x) SCM_STRINGP(x)
26 #define scm_hash_table_p scm_vector_p
27 #define scm_i_string_chars(x) SCM_STRING_CHARS(x)
28 #define scm_i_string_length(x) SCM_STRING_LENGTH(x)
29 inline bool ly_c_number_p (SCM x) { return SCM_NUMBERP (x); }
30 #define scm_is_number(x) (scm_number_p(x)==SCM_BOOL_T)
31 inline int ly_scm2int (SCM x) { return scm_num2int (x, 0, "ly_scm2int"); }
32 #define scm_to_int(x) (ly_scm2int(x))
33 inline bool ly_c_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
34 #define scm_is_symbol(x) ly_c_symbol_p(x)
35 inline bool ly_c_boolean_p (SCM x) { return SCM_BOOLP (x); }
36 #define scm_is_bool(x) ly_c_boolean_p(x)
37 inline bool ly_c_eq_p (SCM x, SCM y) { return SCM_EQ_P (x, y); }
38 #define scm_is_eq(x,y) (SCM_EQ_P((x), (y)))
40 #define scm_is_pair(x) (SCM_CONSP(x))
43 inline double ly_scm2double (SCM x) { return scm_num2dbl (x, "ly_scm2double"); }
44 #define scm_to_double(x) (ly_scm2double(x))
45 #define scm_from_double(x) (scm_make_real(x))
48 #endif /* SCM_MINOR_VERSION < 7 */
50 #ifndef SMOB_FREE_RETURN_VAL
51 #define SMOB_FREE_RETURN_VAL(CL) 0
55 #define SCM_PACK(x) ((SCM) x)
59 #define SCM_UNPACK(x) (x)
62 /** Conversion functions follow the GUILE naming convention, i.e.
65 SCM ly_last (SCM list);
66 SCM ly_write2scm (SCM s);
67 SCM ly_deep_copy (SCM);
68 SCM ly_truncate_list (int k, SCM lst);
71 /* Unreliable with gcc-2.x
72 FIXME: should add check for x86 as well? */
78 /* Using this trick we cache the value of scm_str2symbol ("fooo") where
79 "fooo" is a constant string. This is done at the cost of one static
80 variable per ly_symbol2scm() use, and one boolean evaluation for
83 The overall speedup of lily is about 5% on a run of wtk1-fugue2. */
84 #define ly_symbol2scm(x) \
87 /* We store this one locally, since G++ -O2 fucks up else */ \
89 if ( __builtin_constant_p ((x))) \
92 value = cached = scm_gc_protect_object (scm_str2symbol ((x))); \
95 value = scm_str2symbol ((char*) (x)); \
99 inline SCM ly_symbol2scm(char const* x) { return scm_str2symbol ((x)); }
102 extern SCM global_lily_module;
105 TODO: rename me to ly_c_lily_module_eval
107 #define ly_scheme_function(x) \
110 /* We store this one locally, since G++ -O2 fucks up else */ \
111 SCM value = cached; \
112 if ( __builtin_constant_p ((x))) \
115 value = cached = scm_gc_protect_object (scm_eval (scm_str2symbol (x), \
116 global_lily_module)); \
119 value = scm_eval (scm_str2symbol (x), global_lily_module); \
124 String ly_scm2string (SCM s);
125 String ly_symbol2string (SCM);
126 SCM ly_offset2scm (Offset);
127 Offset ly_scm2offset (SCM);
128 SCM ly_assoc_chain (SCM key, SCM achain);
129 SCM ly_assoc_cdr (SCM key, SCM alist);
130 SCM ly_assoc_get (SCM key, SCM alist, SCM def);
131 Interval ly_scm2interval (SCM);
132 Drul_array<Real> ly_scm2realdrul (SCM);
133 Slice int_list_to_slice (SCM l);
134 SCM ly_interval2scm (Drul_array<Real>);
135 char *ly_scm2newstr (SCM str, size_t *lenp);
137 Real robust_scm2double (SCM, double);
138 int robust_scm2int (SCM, int);
139 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
140 Interval robust_scm2interval (SCM, Drul_array<Real>);
141 Offset robust_scm2offset (SCM, Offset);
143 SCM ly_quote_scm (SCM s);
144 bool type_check_assignment (SCM val, SCM sym, SCM type_symbol) ;
145 String print_scm_val (SCM val);
146 SCM ly_number2string (SCM s);
148 SCM parse_symbol_list (char const *);
149 SCM robust_list_ref(int i, SCM l);
150 SCM alist_to_hashq (SCM);
153 /* inserts at front, removing dublicates */
154 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
156 return scm_acons(key, val, scm_assoc_remove_x (alist, key));
158 inline bool ly_c_char_p (SCM x) { return SCM_CHARP (x); }
159 inline bool ly_c_vector_p (SCM x) { return SCM_VECTORP (x); }
160 inline bool ly_c_list_p (SCM x) { return SCM_NFALSEP (scm_list_p (x)); }
161 inline bool ly_c_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
162 inline bool ly_c_equal_p (SCM x, SCM y) {
163 return SCM_NFALSEP (scm_equal_p (x, y));
165 inline SCM ly_cdr (SCM x) {
170 inline SCM ly_car (SCM x) {
175 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
176 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
177 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
178 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
179 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
180 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
181 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
182 inline SCM ly_cadar (SCM x) { return SCM_CADAR (x); }
183 inline bool ly_scm2bool (SCM x) { return SCM_NFALSEP (x); }
184 inline char ly_scm2char (SCM x) { return SCM_CHAR(x); }
185 inline unsigned long ly_length (SCM x) {
186 return scm_num2ulong (scm_length (x), 0, "ly_length");
188 inline unsigned long ly_vector_length (SCM x) { return SCM_VECTOR_LENGTH (x); }
190 inline SCM ly_bool2scm (bool x) { return SCM_BOOL (x); }
192 inline SCM ly_append2 (SCM x1, SCM x2) {
193 return scm_append (scm_listify (x1, x2, SCM_UNDEFINED));
195 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3) {
196 return scm_append (scm_listify (x1, x2, x3, SCM_UNDEFINED));
198 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4) {
199 return scm_append (scm_listify (x1, x2, x3, x4, SCM_UNDEFINED));
203 display and print newline.
206 void ly_display_scm (SCM s);
209 void read_lily_scm_file (String);
210 void ly_c_init_guile ();
212 bool is_direction (SCM s);
213 bool is_number_pair (SCM);
217 these conversion functions also do a typecheck on the argument, and
218 return a default value if S has the wrong type.
221 Direction to_dir (SCM s);
222 bool to_boolean (SCM s);
224 void init_ly_protection ();
225 unsigned int ly_scm_hash (SCM s);
227 SCM index_get_cell (SCM cell, Direction d);
228 SCM index_set_cell (SCM cell, Direction d, SCM val);
230 SCM ly_snoc (SCM s, SCM list);
231 SCM ly_split_list (SCM s, SCM lst);
232 SCM ly_unique (SCM lst);
233 SCM ly_list_qsort_uniq_x (SCM lst);
235 SCM ly_output_formats();
236 SCM ly_kpathsea_expand_path (SCM);
241 void add_scm_init_func (void (*) ());
244 typedef SCM (*Scheme_function_unknown) ();
247 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
248 typedef SCM (*Scheme_function_0) ();
249 typedef SCM (*Scheme_function_1) (SCM);
250 typedef SCM (*Scheme_function_2) (SCM,SCM);
251 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
253 typedef SCM (*Scheme_function_0) (...);
254 typedef SCM (*Scheme_function_1) (...);
255 typedef SCM (*Scheme_function_2) (...);
256 typedef SCM (*Scheme_function_3) (...);
261 Adds the NAME as a Scheme function, and a variable to store the SCM
262 version of the function in the static variable NAME_proc
264 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
265 static SCM NAME ARGS; \
266 static SCM NAME ## _proc
269 Make TYPE::FUNC available as a Scheme function.
271 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
272 SCM TYPE :: FUNC ## _proc; \
274 TYPE ## _ ## FUNC ## _init_functions () \
276 TYPE :: FUNC ## _proc = scm_c_define_gsubr (#TYPE "::" #FUNC, \
278 (Scheme_function_unknown)TYPE :: FUNC); \
279 scm_c_export (#TYPE "::" #FUNC, NULL); \
282 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
283 TYPE ## _ ## FUNC ## _init_functions);
287 ly_add_function_documentation (SCM proc, char const *fname,
291 #define ADD_SCM_INIT_FUNC(name, func) \
292 class name ## _scm_initter \
295 name ## _scm_initter () \
297 add_scm_init_func (func); \
299 } _ ## name ## _scm_initter; \
302 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
303 ARGLIST, DOCSTRING) \
304 SCM FNAME ## _proc; \
306 INITPREFIX ## init () \
308 FNAME ## _proc = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, \
309 (Scheme_function_unknown) FNAME); \
310 ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
312 scm_c_export (PRIMNAME, NULL); \
314 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
319 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
321 LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
324 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
325 ARGLIST, DOCSTRING) \
327 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
328 VAR, ARGLIST, DOCSTRING)
330 #define get_property(x) internal_get_property (ly_symbol2scm (x))
331 #define set_property(x,y) internal_set_property (ly_symbol2scm (x), y)
333 #endif /* LILY_GUILE_HH */