lily/include/lily-guile.hh

   1 /*
   2   lily-guile.hh encapsulate guile
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #ifndef LILY_GUILE_HH
  10 #define LILY_GUILE_HH
  11
  12 #include <libguile.h>
  13 #include "flower-proto.hh"
  14
  15 #include "drul-array.hh"
  16 #include "direction.hh"
  17
  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 #define scm_is_number(x) (scm_number_p(x)==SCM_BOOL_T)
  30 #endif /* SCM_MINOR_VERSION < 7 */
  31
  32 #ifndef SMOB_FREE_RETURN_VAL
  33 #define SMOB_FREE_RETURN_VAL(CL) 0
  34 #endif
  35
  36 #ifndef SCM_PACK
  37 #define SCM_PACK(x) ((SCM) x)
  38 #endif
  39
  40 #ifndef SCM_UNPACK
  41 #define SCM_UNPACK(x) (x)
  42 #endif
  43
  44 /** Conversion functions follow the GUILE naming convention, i.e.
  45     A ly_B2A (B b);  */
  46
  47 SCM ly_last (SCM list);
  48 SCM ly_write2scm (SCM s);
  49 SCM ly_deep_copy (SCM);
  50 SCM ly_truncate_list (int k, SCM lst);
  51
  52 #if (__GNUC__ > 2)
  53 /* Unreliable with gcc-2.x
  54    FIXME: should add check for x86 as well?  */
  55 #define CACHE_SYMBOLS
  56 #endif
  57
  58 #ifdef CACHE_SYMBOLS
  59
  60 /* Using this trick we cache the value of scm_str2symbol ("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
  63   every call.
  64
  65   The overall speedup of lily is about 5% on a run of wtk1-fugue2.  */
  66 #define ly_symbol2scm(x) \
  67 ({ \
  68   static SCM cached; \
  69   /* We store this one locally, since G++ -O2 fucks up else */ \
  70   SCM value = cached; \
  71   if ( __builtin_constant_p ((x))) \
  72     { \
  73       if (!cached) \
  74         value = cached =  scm_gc_protect_object (scm_str2symbol ((x))); \
  75     } \
  76   else \
  77     value = scm_str2symbol ((char*) (x)); \
  78   value; \
  79 })
  80 #else
  81 inline SCM ly_symbol2scm(char const* x) { return scm_str2symbol ((x)); }
  82 #endif
  83
  84 extern SCM global_lily_module;
  85
  86 /*
  87   TODO: rename me to ly_c_lily_module_eval
  88  */
  89 #define ly_scheme_function(x) \
  90 ({ \
  91   static SCM cached; \
  92   /* We store this one locally, since G++ -O2 fucks up else */ \
  93   SCM value = cached; \
  94   if ( __builtin_constant_p ((x))) \
  95     { \
  96       if (!cached) \
  97         value = cached = scm_gc_protect_object (scm_eval (scm_str2symbol (x), \
  98                                                 global_lily_module)); \
  99     } \
 100   else \
 101     value = scm_eval (scm_str2symbol (x), global_lily_module); \
 102   value; \
 103 })
 104
 105
 106 String ly_scm2string (SCM s);
 107 String ly_symbol2string (SCM);
 108 SCM ly_offset2scm (Offset);
 109 Offset ly_scm2offset (SCM);
 110 SCM ly_assoc_chain (SCM key, SCM achain);
 111 SCM ly_assoc_cdr (SCM key, SCM alist);
 112 Interval ly_scm2interval (SCM);
 113 Drul_array<Real> ly_scm2realdrul (SCM);
 114 Slice int_list_to_slice (SCM l);
 115 SCM ly_interval2scm (Drul_array<Real>);
 116 char *ly_scm2newstr (SCM str, size_t *lenp);
 117
 118 Real robust_scm2double (SCM, double);
 119 int robust_scm2int (SCM, int);
 120 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
 121 Interval robust_scm2interval (SCM, Drul_array<Real>);
 122 Offset robust_scm2offset (SCM, Offset);
 123
 124 SCM ly_quote_scm (SCM s);
 125 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 126 String print_scm_val (SCM val);
 127 SCM ly_number2string (SCM s);
 128
 129 SCM parse_symbol_list (char const *);
 130 SCM robust_list_ref(int i, SCM l);
 131 SCM alist_to_hashq (SCM);
 132
 133 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 134 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 135 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
 136 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
 137 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
 138 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
 139 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
 140 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
 141 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
 142 inline SCM ly_cadar (SCM x) { return SCM_CADAR (x); }
 143 /* inserts at front, removing dublicates */
 144 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
 145 {
 146   return scm_acons(key, val, scm_assoc_remove_x (alist, key));
 147 }
 148 inline bool ly_c_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
 149 inline bool ly_c_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
 150 inline bool ly_c_boolean_p (SCM x) { return SCM_BOOLP (x); }
 151 inline bool ly_c_char_p (SCM x) { return SCM_CHARP (x); }
 152 inline bool ly_c_number_p (SCM x) { return SCM_NUMBERP (x); }
 153 inline bool ly_c_string_p (SCM x) { return scm_is_string (x); }
 154 inline bool ly_c_vector_p (SCM x) { return SCM_VECTORP (x); }
 155 inline bool ly_c_list_p (SCM x) { return SCM_NFALSEP (scm_list_p (x)); }
 156 inline bool ly_c_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
 157 inline bool ly_c_eq_p (SCM x, SCM y) { return SCM_EQ_P (x, y); }
 158 inline bool ly_c_equal_p (SCM x, SCM y) {
 159   return SCM_NFALSEP (scm_equal_p (x, y));
 160 }
 161
 162 inline bool ly_scm2bool (SCM x) { return SCM_NFALSEP (x); }
 163 inline char ly_scm2char (SCM x) { return SCM_CHAR(x); }
 164 inline int ly_scm2int (SCM x) { return scm_num2int (x, 0, "ly_scm2int"); }
 165 inline double ly_scm2double (SCM x) { return scm_num2dbl (x, "ly_scm2double"); }
 166 inline unsigned long ly_length (SCM x) {
 167   return scm_num2ulong (scm_length (x), 0, "ly_length");
 168 }
 169 inline unsigned long ly_vector_length (SCM x) { return SCM_VECTOR_LENGTH (x); }
 170
 171 inline SCM ly_bool2scm (bool x) { return SCM_BOOL (x); }
 172
 173 inline SCM ly_append2 (SCM x1, SCM x2) {
 174   return scm_append (scm_listify (x1, x2, SCM_UNDEFINED));
 175 }
 176 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3) {
 177   return scm_append (scm_listify (x1, x2, x3, SCM_UNDEFINED));
 178 }
 179 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4) {
 180   return scm_append (scm_listify (x1, x2, x3, x4, SCM_UNDEFINED));
 181 }
 182
 183 /*
 184   display and print newline.
 185  */
 186 extern "C" {
 187 void ly_display_scm (SCM s);
 188 }
 189
 190 void read_lily_scm_file (String);
 191 void ly_c_init_guile ();
 192
 193 bool is_direction (SCM s);
 194 bool is_number_pair (SCM);
 195 bool is_axis (SCM);
 196
 197 /*
 198   these conversion functions also do a typecheck on the argument, and
 199   return a default value if S has the wrong type.
 200 */
 201
 202 Direction to_dir (SCM s);
 203 bool to_boolean (SCM s);
 204
 205 void init_ly_protection ();
 206 unsigned int ly_scm_hash (SCM s);
 207
 208 SCM index_get_cell (SCM cell, Direction d);
 209 SCM index_set_cell (SCM cell, Direction d, SCM val);
 210
 211 SCM ly_snoc (SCM s, SCM list);
 212 SCM ly_split_list (SCM s, SCM lst);
 213 SCM ly_unique (SCM lst);
 214 SCM ly_list_qsort_uniq_x (SCM lst);
 215
 216 SCM ly_output_formats();
 217 SCM ly_kpathsea_expand_path (SCM);
 218
 219 /*
 220   snarfing.
 221  */
 222 void add_scm_init_func (void (*) ());
 223
 224 extern "C" {
 225 typedef SCM (*Scheme_function_unknown) ();
 226 }
 227
 228 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 229 typedef SCM (*Scheme_function_0) ();
 230 typedef SCM (*Scheme_function_1) (SCM);
 231 typedef SCM (*Scheme_function_2) (SCM,SCM);
 232 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
 233 #else
 234 typedef SCM (*Scheme_function_0) (...);
 235 typedef SCM (*Scheme_function_1) (...);
 236 typedef SCM (*Scheme_function_2) (...);
 237 typedef SCM (*Scheme_function_3) (...);
 238 #endif
 239
 240
 241 /*
 242   Adds the NAME as a Scheme function, and a variable to store the SCM
 243   version of the function in the static variable NAME_proc
 244  */
 245 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
 246         static SCM NAME ARGS; \
 247         static SCM NAME ## _proc
 248
 249 /*
 250   Make TYPE::FUNC available as a Scheme function.
 251  */
 252 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 253 SCM TYPE :: FUNC ## _proc; \
 254 void \
 255 TYPE ## _ ## FUNC ## _init_functions () \
 256 { \
 257   TYPE :: FUNC ## _proc = scm_c_define_gsubr (#TYPE "::" #FUNC, \
 258                                               (ARGCOUNT), 0, 0, \
 259                           (Scheme_function_unknown)TYPE :: FUNC); \
 260   scm_c_export (#TYPE "::" #FUNC, NULL); \
 261 } \
 262  \
 263 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
 264                    TYPE ## _ ## FUNC ## _init_functions);
 265
 266
 267 void
 268 ly_add_function_documentation (SCM proc, char const *fname,
 269                                char const *varlist,
 270                                char const *doc);
 271
 272 #define ADD_SCM_INIT_FUNC(name, func) \
 273 class name ## _scm_initter \
 274 { \
 275 public: \
 276   name ## _scm_initter () \
 277   { \
 278     add_scm_init_func (func); \
 279   } \
 280 } _ ## name ## _scm_initter; \
 281 /* end define */
 282
 283 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
 284                                ARGLIST, DOCSTRING) \
 285 SCM FNAME ## _proc; \
 286 void \
 287 INITPREFIX ## init () \
 288 { \
 289   FNAME ## _proc = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, \
 290                                        (Scheme_function_unknown) FNAME); \
 291   ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
 292                                  DOCSTRING); \
 293   scm_c_export (PRIMNAME, NULL); \
 294 } \
 295 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
 296 SCM \
 297 FNAME ARGLIST
 298
 299
 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, \
 303                         DOCSTRING)
 304
 305 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
 306                                   ARGLIST, DOCSTRING) \
 307 SCM FNAME ARGLIST; \
 308 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
 309                         VAR, ARGLIST, DOCSTRING)
 310
 311 #define get_property(x) internal_get_property (ly_symbol2scm (x))
 312 #define set_property(x,y) internal_set_property (ly_symbol2scm (x), y)
 313
 314 #endif /* LILY_GUILE_HH */