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