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--2002 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #ifndef LILY_GUILE_HH
  10 #define LILY_GUILE_HH
  11
  12
  13 /*
  14   TODO: the  GH interface is deprecated as of GUILE 1.6
  15
  16   Remove all gh_XXX functions.
  17  */
  18 #include <guile/gh.h>
  19
  20
  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.
  23
  24    Not including config.h here, saves a lot of unnecessary
  25    recompiles. */
  26 #include <libguile.h>
  27
  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
  33 #else
  34 #include "config.h"
  35 #endif
  36 #endif
  37
  38 #include "drul-array.hh"
  39
  40 /* Guile 1.4.x compatibility */
  41 #if GUILE_MINOR_VERSION < 5
  42
  43 #define scm_t_bits scm_bits_t
  44
  45 #define fix_guile_1_4_gh_scm2newstr(str, lenp) gh_scm2newstr (str, (int*)lenp)
  46 #define gh_scm2newstr(str, lenp) fix_guile_1_4_gh_scm2newstr (str, lenp)
  47
  48 #define fix_guile_1_4_scm_primitive_eval(form) scm_eval_3 (form, 1, SCM_EOL)
  49 #define scm_primitive_eval(form) fix_guile_1_4_scm_primitive_eval (form)
  50
  51 #define scm_int2num(x) scm_long2num (x)
  52 #define scm_current_module() (SCM)0
  53 #define scm_set_current_module(x) (void)x
  54 #define scm_c_resolve_module(x) (SCM)0
  55
  56 inline SCM scm_c_make_vector  (int k, SCM val) {
  57   return scm_make_vector (SCM_MAKINUM (k), val);
  58 }
  59 #define scm_c_define_gsubr scm_make_gsubr
  60 #define scm_c_eval_string(str) gh_eval_str ((char*)str)
  61
  62 #define scm_gc_protect_object scm_protect_object
  63 #define scm_gc_unprotect_object scm_unprotect_object
  64 #define scm_list_n scm_listify
  65 #define SCM_STRING_CHARS SCM_CHARS
  66 #define SCM_STRING_LENGTH SCM_LENGTH
  67 #define SCM_SYMBOL_CHARS SCM_CHARS
  68 #define SCM_SYMBOL_LENGTH SCM_LENGTH
  69 #define SCM_VECTOR_LENGTH SCM_LENGTH
  70
  71 #define SMOB_FREE_RETURN_VAL(CL) sizeof(CL)
  72 #define scm_done_free(x)
  73 #endif
  74
  75 #ifndef SMOB_FREE_RETURN_VAL
  76 #define SMOB_FREE_RETURN_VAL(CL) 0
  77 #endif
  78
  79
  80 #if GUILE_MINOR_VERSION < 7
  81 #define scm_gc_unregister_collectable_memory(a,b,c) scm_done_free(b)
  82 #define scm_gc_register_collectable_memory(a,b,c) scm_done_malloc(b)
  83 #endif
  84
  85 #include "direction.hh"
  86 #include "flower-proto.hh"
  87
  88 #ifndef SCM_PACK
  89 #define SCM_PACK(x) ((SCM) x)
  90
  91 #endif
  92 #ifndef SCM_UNPACK
  93 #define SCM_UNPACK(x) ( x)
  94 #endif
  95
  96 /*
  97   conversion functions follow the GUILE naming convention, i.e.
  98
  99     A ly_B2A (B b);
 100  */
 101
 102 SCM ly_last (SCM list);
 103 SCM ly_write2scm (SCM s);
 104 SCM ly_deep_copy (SCM);
 105 SCM ly_truncate_list (int k, SCM l );
 106
 107
 108 #if (__GNUC__ > 2)
 109 /*
 110   todo: should add check for x86 as well
 111  */
 112 #define CACHE_SYMBOLS
 113 #endif
 114
 115
 116 #ifdef CACHE_SYMBOLS
 117
 118
 119 /*
 120   Using this trick we cache the value of gh_symbol2scm ("fooo") where
 121   "fooo" is a constant string. This is done at the cost of one static
 122   variable per ly_symbol2scm() use, and one boolean evaluation for
 123   every call.
 124
 125   The overall speedup of lily is about 5% on a run of wtk1-fugue2
 126
 127 */
 128 #define ly_symbol2scm(x) ({ static SCM cached;  \
 129  SCM value = cached;  /* We store this one locally, since G++ -O2 fucks up else */   \
 130  if ( __builtin_constant_p ((x)))\
 131  {  if (!cached)\
 132      value = cached =  scm_gc_protect_object (gh_symbol2scm((x)));\
 133  } else\
 134   value = gh_symbol2scm ((char*) (x)); \
 135   value; })
 136 #else
 137 inline SCM ly_symbol2scm(char const* x) { return gh_symbol2scm((x)); }
 138 #endif
 139
 140
 141
 142 String ly_scm2string (SCM s);
 143 String ly_symbol2string (SCM);
 144 SCM ly_offset2scm (Offset);
 145 Offset ly_scm2offset (SCM);
 146 SCM ly_assoc_chain (SCM key, SCM achain);
 147 SCM ly_assoc_cdr (SCM key, SCM alist);
 148 Interval ly_scm2interval (SCM);
 149 Slice int_list_to_slice (SCM l);
 150 SCM ly_interval2scm (Drul_array<Real>);
 151
 152
 153
 154 SCM ly_quote_scm (SCM s);
 155 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 156 String print_scm_val (SCM val);
 157 SCM ly_number2string (SCM s);
 158
 159 SCM parse_symbol_list (char const *);
 160 SCM robust_list_ref(int i, SCM l);
 161
 162
 163 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 164 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 165 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
 166 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
 167 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
 168 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
 169 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
 170 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
 171 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
 172 /* inserts at front, removing dublicates */
 173 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
 174 {
 175   return scm_acons(key, val, scm_assoc_remove_x (alist, key));
 176 }
 177 #ifdef PARANOID
 178 #define gh_pair_p ly_pair_p
 179 bool ly_pair_p (SCM x);
 180 #else
 181 inline bool ly_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
 182 #endif
 183 inline bool ly_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
 184 inline bool ly_number_p (SCM x) { return SCM_NUMBERP (x); }
 185 inline bool ly_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
 186
 187 /*
 188   display and print newline.
 189  */
 190 extern "C" {
 191 void ly_display_scm (SCM s);
 192 }
 193
 194 #include "array.hh"
 195
 196 void read_lily_scm_file (String);
 197 void ly_init_guile ();
 198
 199 bool ly_dir_p (SCM s);
 200 bool ly_number_pair_p (SCM);
 201 bool ly_axis_p (SCM);
 202
 203 /*
 204   these conversion functions also do a typecheck on the argument, and
 205   return a default value if S has the wrong type.
 206 */
 207
 208 Direction to_dir (SCM s);
 209 bool to_boolean (SCM s);
 210
 211 void init_ly_protection ();
 212 unsigned int ly_scm_hash (SCM s);
 213
 214 SCM index_get_cell (SCM cell, Direction d);
 215 SCM index_set_cell (SCM cell, Direction d, SCM val);
 216
 217
 218
 219 SCM ly_snoc (SCM s, SCM list);
 220 SCM ly_split_list (SCM s, SCM list);
 221 SCM ly_unique (SCM list);
 222 /*
 223   snarfing.
 224  */
 225 void add_scm_init_func (void (*) ());
 226
 227
 228 typedef SCM (*Scheme_function_unknown) ();
 229
 230 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 231 typedef SCM (*Scheme_function_0) ();
 232 typedef SCM (*Scheme_function_1) (SCM);
 233 typedef SCM (*Scheme_function_2) (SCM,SCM);
 234 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
 235 #else
 236 typedef SCM (*Scheme_function_0) (...);
 237 typedef SCM (*Scheme_function_1) (...);
 238 typedef SCM (*Scheme_function_2) (...);
 239 typedef SCM (*Scheme_function_3) (...);
 240 #endif
 241
 242 #define DECLARE_SCHEME_CALLBACK(NAME,ARGS) \
 243         static SCM NAME ARGS; \
 244         static SCM NAME ## _proc
 245
 246 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 247 SCM TYPE :: FUNC ## _proc;\
 248 void                                                            \
 249 TYPE ## _ ## FUNC ## _init_functions ()                                 \
 250 {                                                               \
 251   TYPE :: FUNC ## _proc = gh_new_procedure ## ARGCOUNT  ## _0 (#TYPE "::" #FUNC, \
 252  ((Scheme_function_ ## ARGCOUNT)TYPE :: FUNC));                                 \
 253 }                                                               \
 254                                                                 \
 255 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, TYPE ## _ ## FUNC ## _init_functions);       \
 256
 257
 258 void ly_add_function_documentation (char const * fname,
 259                                     char const * varlist,
 260                                     char const * doc);
 261
 262 #define ADD_SCM_INIT_FUNC(name, func)\
 263 class name ## _scm_initter {                    \
 264 public:\
 265   name ## _scm_initter ()                       \
 266   {                                             \
 267     add_scm_init_func (func);           \
 268   }                                             \
 269 } _ ## name ## _scm_initter;                    \
 270 /* end define */
 271
 272 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 273 SCM FNAME ARGLIST ; \
 274 SCM FNAME ## _proc;\
 275 void \
 276 FNAME ## init ()\
 277 {\
 278  FNAME ## _proc \
 279     = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, (Scheme_function_unknown) FNAME);\
 280   ly_add_function_documentation (PRIMNAME, #ARGLIST,  DOCSTRING);\
 281 }\
 282 ADD_SCM_INIT_FUNC (FNAME ## init_unique_prefix, FNAME ## init);\
 283 SCM \
 284 FNAME ARGLIST\
 285
 286
 287 #define LY_DEFINE_NOARGS(FNAME, PRIMNAME, REQ, OPT, VAR, DOCSTRING) \
 288 SCM FNAME ## _proc;\
 289 void \
 290 FNAME ## init_noargs ()\
 291 {\
 292  FNAME ## _proc \
 293     = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, (Scheme_function_unknown) FNAME);\
 294   ly_add_function_documentation (PRIMNAME, "", DOCSTRING);\
 295 }\
 296 ADD_SCM_INIT_FUNC (FNAME ## init_unique_prefix_noargs, FNAME ## init_noargs);\
 297 SCM \
 298 FNAME
 299
 300
 301
 302
 303
 304 #endif // LILY_GUILE_HH