2 lily-guile.hh encapsulate guile
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2003 Jan Nieuwenhuizen <janneke@gnu.org>
14 TODO: the GH interface is deprecated as of GUILE 1.6
16 Remove all gh_XXX functions.
21 /* GUILE only includes version in headers (libguile/version.h) as of
22 1.5.x. For some strange reason, they call it SCM.*VERSION.
24 Not including config.h here, saves a lot of unnecessary
28 #ifndef GUILE_MAJOR_VERSION
29 #ifdef SCM_MAJOR_VERSION
30 #define GUILE_MAJOR_VERSION SCM_MAJOR_VERSION
31 #define GUILE_MINOR_VERSION SCM_MINOR_VERSION
32 #define GUILE_PATCH_LEVEL SCM_MICRO_VERSION
38 #include "drul-array.hh"
41 /* Guile 1.4.x compatibility */
42 #if GUILE_MINOR_VERSION < 5
44 #define scm_t_bits scm_bits_t
46 #define fix_guile_1_4_gh_scm2newstr(str, lenp) gh_scm2newstr (str, (int*)lenp)
47 #define gh_scm2newstr(str, lenp) fix_guile_1_4_gh_scm2newstr (str, lenp)
49 #define fix_guile_1_4_scm_primitive_eval(form) scm_eval_3 (form, 1, SCM_EOL)
50 #define scm_primitive_eval(form) fix_guile_1_4_scm_primitive_eval (form)
52 #define scm_int2num(x) scm_long2num (x)
53 #define scm_current_module() (SCM)0
54 #define scm_set_current_module(x) (void)x
55 #define scm_c_resolve_module(x) (SCM)0
57 inline SCM scm_c_make_vector (int k, SCM val) {
58 return scm_make_vector (SCM_MAKINUM (k), val);
60 #define scm_c_define_gsubr scm_make_gsubr
61 #define scm_c_eval_string(str) gh_eval_str ((char*)str)
62 #define scm_remember_upto_here_1(s) scm_remember (&s)
63 #define scm_gc_protect_object scm_protect_object
64 #define scm_gc_unprotect_object scm_unprotect_object
65 #define scm_list_n scm_listify
66 #define SCM_STRING_CHARS SCM_CHARS
67 #define SCM_STRING_LENGTH SCM_LENGTH
68 #define SCM_SYMBOL_CHARS SCM_CHARS
69 #define SCM_SYMBOL_LENGTH SCM_LENGTH
70 #define SCM_VECTOR_LENGTH SCM_LENGTH
72 #define SMOB_FREE_RETURN_VAL(CL) sizeof(CL)
73 #define scm_done_free(x)
76 #ifndef SMOB_FREE_RETURN_VAL
77 #define SMOB_FREE_RETURN_VAL(CL) 0
81 #if GUILE_MINOR_VERSION < 7
82 #define scm_gc_unregister_collectable_memory(a,b,c) scm_done_free(b)
83 #define scm_gc_register_collectable_memory(a,b,c) scm_done_malloc(b)
84 #define SCM_VECTOR_REF(v,i) (SCM_VELTS((v))[(i)])
89 #include "direction.hh"
90 #include "flower-proto.hh"
93 #define SCM_PACK(x) ((SCM) x)
97 #define SCM_UNPACK(x) ( x)
101 conversion functions follow the GUILE naming convention, i.e.
106 SCM ly_last (SCM list);
107 SCM ly_write2scm (SCM s);
108 SCM ly_deep_copy (SCM);
109 SCM ly_truncate_list (int k, SCM l );
115 // #define CACHE_SYMBOLS
120 todo: should add check for x86 as well
122 #define CACHE_SYMBOLS
130 Using this trick we cache the value of gh_symbol2scm ("fooo") where
131 "fooo" is a constant string. This is done at the cost of one static
132 variable per ly_symbol2scm() use, and one boolean evaluation for
135 The overall speedup of lily is about 5% on a run of wtk1-fugue2
138 #define ly_symbol2scm(x) ({ static SCM cached; \
139 SCM value = cached; /* We store this one locally, since G++ -O2 fucks up else */ \
140 if ( __builtin_constant_p ((x)))\
142 value = cached = scm_gc_protect_object (gh_symbol2scm((x)));\
144 value = gh_symbol2scm ((char*) (x)); \
147 inline SCM ly_symbol2scm(char const* x) { return gh_symbol2scm((x)); }
152 String ly_scm2string (SCM s);
153 String ly_symbol2string (SCM);
154 SCM ly_offset2scm (Offset);
155 Offset ly_scm2offset (SCM);
156 SCM ly_assoc_chain (SCM key, SCM achain);
157 SCM ly_assoc_cdr (SCM key, SCM alist);
158 Interval ly_scm2interval (SCM);
159 Slice int_list_to_slice (SCM l);
160 SCM ly_interval2scm (Drul_array<Real>);
164 SCM ly_quote_scm (SCM s);
165 bool type_check_assignment (SCM val, SCM sym, SCM type_symbol) ;
166 String print_scm_val (SCM val);
167 SCM ly_number2string (SCM s);
169 SCM parse_symbol_list (char const *);
170 SCM robust_list_ref(int i, SCM l);
173 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
174 inline SCM ly_car (SCM x) { return SCM_CAR (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 /* inserts at front, removing dublicates */
183 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
185 return scm_acons(key, val, scm_assoc_remove_x (alist, key));
188 #define gh_pair_p ly_pair_p
189 bool ly_pair_p (SCM x);
191 inline bool ly_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
193 inline bool ly_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
194 inline bool ly_number_p (SCM x) { return SCM_NUMBERP (x); }
195 inline bool ly_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
198 display and print newline.
201 void ly_display_scm (SCM s);
206 void read_lily_scm_file (String);
207 void ly_init_guile ();
209 bool is_direction (SCM s);
210 bool is_number_pair (SCM);
214 these conversion functions also do a typecheck on the argument, and
215 return a default value if S has the wrong type.
218 Direction to_dir (SCM s);
219 bool to_boolean (SCM s);
221 void init_ly_protection ();
222 unsigned int ly_scm_hash (SCM s);
224 SCM index_get_cell (SCM cell, Direction d);
225 SCM index_set_cell (SCM cell, Direction d, SCM val);
227 SCM ly_snoc (SCM s, SCM list);
228 SCM ly_split_list (SCM s, SCM list);
229 SCM ly_unique (SCM list);
236 void add_scm_init_func (void (*) ());
239 typedef SCM (*Scheme_function_unknown) ();
242 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
243 typedef SCM (*Scheme_function_0) ();
244 typedef SCM (*Scheme_function_1) (SCM);
245 typedef SCM (*Scheme_function_2) (SCM,SCM);
246 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
248 typedef SCM (*Scheme_function_0) (...);
249 typedef SCM (*Scheme_function_1) (...);
250 typedef SCM (*Scheme_function_2) (...);
251 typedef SCM (*Scheme_function_3) (...);
254 #define DECLARE_SCHEME_CALLBACK(NAME,ARGS) \
255 static SCM NAME ARGS; \
256 static SCM NAME ## _proc
258 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
259 SCM TYPE :: FUNC ## _proc;\
261 TYPE ## _ ## FUNC ## _init_functions () \
263 TYPE :: FUNC ## _proc = gh_new_procedure ## ARGCOUNT ## _0 (#TYPE "::" #FUNC, \
264 ((Scheme_function_ ## ARGCOUNT)TYPE :: FUNC)); \
265 scm_c_export (#TYPE "::" #FUNC, NULL);\
268 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, TYPE ## _ ## FUNC ## _init_functions); \
271 void ly_add_function_documentation (SCM proc, char const * fname,
272 char const * varlist,
275 #define ADD_SCM_INIT_FUNC(name, func)\
276 class name ## _scm_initter { \
278 name ## _scm_initter () \
280 add_scm_init_func (func); \
282 } _ ## name ## _scm_initter; \
285 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
288 INITPREFIX ## init ()\
291 = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, (Scheme_function_unknown) FNAME);\
292 ly_add_function_documentation ( FNAME ## _proc ,PRIMNAME, #ARGLIST, DOCSTRING);\
293 scm_c_export (PRIMNAME,NULL);\
295 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init);\
300 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
301 SCM FNAME ARGLIST ; \
302 LY_DEFINE_WITHOUT_DECL(FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING)
305 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
306 SCM FNAME ARGLIST ; \
307 LY_DEFINE_WITHOUT_DECL(CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING)
310 #endif /* LILY_GUILE_HH */