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_current_module() (SCM)0
  52 #define scm_set_current_module(x) (void)x
  53 #define scm_c_resolve_module(x) (SCM)0
  54
  55 inline SCM scm_c_make_vector  (int k, SCM val) {
  56   return scm_make_vector (SCM_MAKINUM (k), val);
  57 }
  58 #define scm_c_define_gsubr scm_make_gsubr
  59 #define scm_c_eval_string(str) gh_eval_str ((char*)str)
  60
  61 #define scm_gc_protect_object scm_protect_object
  62 #define scm_gc_unprotect_object scm_unprotect_object
  63 #define scm_list_n scm_listify
  64 #define SCM_STRING_CHARS SCM_CHARS
  65 #define SCM_STRING_LENGTH SCM_LENGTH
  66 #define SCM_SYMBOL_CHARS SCM_CHARS
  67 #define SCM_SYMBOL_LENGTH SCM_LENGTH
  68 #define SCM_VECTOR_LENGTH SCM_LENGTH
  69
  70 #endif
  71
  72
  73 #include "direction.hh"
  74 #include "flower-proto.hh"
  75
  76 #ifndef SCM_PACK
  77 #define SCM_PACK(x) ((SCM) x)
  78
  79 #endif
  80 #ifndef SCM_UNPACK
  81 #define SCM_UNPACK(x) ( x)
  82 #endif
  83
  84 /*
  85   conversion functions follow the GUILE naming convention, i.e.
  86
  87     A ly_B2A (B b);
  88  */
  89
  90 SCM ly_last (SCM list);
  91 SCM ly_str02scm (char const*c);
  92 SCM ly_write2scm (SCM s);
  93 SCM ly_deep_copy (SCM);
  94 SCM ly_truncate_list (int k, SCM l );
  95
  96
  97 #if (__GNUC__ > 2)
  98 /*
  99   todo: should add check for x86 as well
 100  */
 101 #define CACHE_SYMBOLS
 102 #endif
 103
 104
 105 /*
 106   We don't use gh_symbol2scm directly, since it has const-correctness
 107   problems in GUILE 1.3.4
 108
 109  */
 110 SCM my_gh_symbol2scm (const char* x);
 111
 112 #ifdef CACHE_SYMBOLS
 113
 114
 115 /*
 116   Using this trick we cache the value of gh_symbol2scm ("fooo") where
 117   "fooo" is a constant string. This is done at the cost of one static
 118   variable per ly_symbol2scm() use, and one boolean evaluation for
 119   every call.
 120
 121   The overall speedup of lily is about 5% on a run of wtk1-fugue2
 122
 123 */
 124 #define ly_symbol2scm(x) ({ static SCM cached;  \
 125  SCM value = cached;  /* We store this one locally, since G++ -O2 fucks up else */   \
 126  if ( __builtin_constant_p ((x)))\
 127  {  if (!cached)\
 128      value = cached =  scm_gc_protect_object (my_gh_symbol2scm((x)));\
 129  } else\
 130   value = gh_symbol2scm ((char*) (x)); \
 131   value; })
 132 #else
 133 inline SCM ly_symbol2scm(char const* x) { return my_gh_symbol2scm((x)); }
 134 #endif
 135
 136
 137
 138 String ly_scm2string (SCM s);
 139 String ly_symbol2string (SCM);
 140 SCM ly_offset2scm (Offset);
 141 Offset ly_scm2offset (SCM);
 142 SCM ly_assoc_chain (SCM key, SCM achain);
 143 SCM ly_assoc_cdr (SCM key, SCM alist);
 144 Interval ly_scm2interval (SCM);
 145 SCM ly_interval2scm (Drul_array<Real>);
 146
 147 void taint (SCM *);
 148
 149
 150 SCM ly_parse_scm (char const* s, int* n);
 151 SCM ly_quote_scm (SCM s);
 152 SCM ly_type (SCM);
 153 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 154 String print_scm_val (SCM val);
 155 SCM ly_number2string (SCM s);
 156
 157 SCM parse_symbol_list (char const *);
 158
 159 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 160 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 161 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
 162 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
 163 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
 164 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
 165 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
 166 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
 167 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
 168 /* inserts at front, removing dublicates */
 169 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
 170 {
 171   return scm_acons(key, val, scm_assoc_remove_x (alist, key));
 172 }
 173 #ifdef PARANOID
 174 #define gh_pair_p ly_pair_p
 175 bool ly_pair_p (SCM x);
 176 #else
 177 inline bool ly_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
 178 #endif
 179 inline bool ly_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
 180 inline bool ly_number_p (SCM x) { return SCM_NUMBERP (x); }
 181 inline bool ly_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p(x)); }
 182
 183 /*
 184   display and print newline.
 185  */
 186 extern "C" {
 187 void ly_display_scm (SCM s);
 188 }
 189
 190 #include "array.hh"
 191
 192 void read_lily_scm_file (String);
 193 void init_lily_guile (String dir);
 194
 195 bool ly_dir_p (SCM s);
 196 bool ly_number_pair_p (SCM);
 197 bool ly_axis_p (SCM);
 198
 199 /*
 200   these conversion functions also do a typecheck on the argument, and
 201   return a default value if S has the wrong type.
 202 */
 203
 204 Direction to_dir (SCM s);
 205 bool to_boolean (SCM s);
 206
 207 void init_ly_protection ();
 208 unsigned int ly_scm_hash (SCM s);
 209
 210 SCM index_get_cell (SCM cell, Direction d);
 211 SCM index_set_cell (SCM cell, Direction d, SCM val);
 212
 213
 214
 215 SCM ly_snoc (SCM s, SCM list);
 216 SCM ly_split_list (SCM s, SCM list);
 217 SCM ly_unique (SCM list);
 218 /*
 219   snarfing.
 220  */
 221 void add_scm_init_func (void (*) ());
 222
 223
 224 typedef SCM (*Scheme_function_unknown) ();
 225
 226 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 227 typedef SCM (*Scheme_function_0) ();
 228 typedef SCM (*Scheme_function_1) (SCM);
 229 typedef SCM (*Scheme_function_2) (SCM,SCM);
 230 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
 231 #else
 232 typedef SCM (*Scheme_function_0) (...);
 233 typedef SCM (*Scheme_function_1) (...);
 234 typedef SCM (*Scheme_function_2) (...);
 235 typedef SCM (*Scheme_function_3) (...);
 236 #endif
 237
 238 #define DECLARE_SCHEME_CALLBACK(NAME,ARGS) \
 239         static SCM NAME ARGS; \
 240         static SCM NAME ## _proc
 241
 242 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 243 SCM TYPE :: FUNC ## _proc;\
 244 void                                                            \
 245 TYPE ## _ ## FUNC ## _init_functions ()                                 \
 246 {                                                               \
 247   TYPE :: FUNC ## _proc = gh_new_procedure ## ARGCOUNT  ## _0 (#TYPE "::" #FUNC, \
 248  ((Scheme_function_ ## ARGCOUNT)TYPE :: FUNC));                                 \
 249 }                                                               \
 250                                                                 \
 251 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, TYPE ## _ ## FUNC ## _init_functions);       \
 252
 253
 254 void ly_add_function_documentation (char const * fname,
 255                                     char const * varlist,
 256                                     char const * doc);
 257
 258 #define ADD_SCM_INIT_FUNC(name, func)\
 259 class name ## _scm_initter {                    \
 260 public:\
 261   name ## _scm_initter ()                       \
 262   {                                             \
 263     add_scm_init_func (func);           \
 264   }                                             \
 265 } _ ## name ## _scm_initter;                    \
 266 /* end define */
 267
 268 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 269 SCM FNAME ARGLIST ; \
 270 SCM FNAME ## _proc;\
 271 void \
 272 FNAME ## init ()\
 273 {\
 274  FNAME ## _proc \
 275     = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, (Scheme_function_unknown) FNAME);\
 276   ly_add_function_documentation (PRIMNAME, #ARGLIST,  DOCSTRING);\
 277 }\
 278 ADD_SCM_INIT_FUNC (FNAME ## init_unique_prefix, FNAME ## init);\
 279 SCM \
 280 FNAME ARGLIST\
 281
 282
 283
 284
 285
 286 #endif // LILY_GUILE_HH