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 #define SCM_VOIDP_TEST
  13
  14 #include <libguile.h>
  15
  16 /*
  17   TODO: the  GH interface is deprecated as of GUILE 1.6
  18
  19   Remove all gh_XXX functions.
  20  */
  21 #include <guile/gh.h>
  22
  23 #include "config.h"
  24 #include "drul-array.hh"
  25
  26 /* Guile 1.3.4 compatibility */
  27 #if GUILE_MINOR_VERSION < 4
  28
  29
  30 #ifndef SCM_CELL_TYPE
  31 #define SCM_CELL_TYPE(X) SCM_CAR (X)
  32 #endif
  33
  34 #ifndef SCM_CELL_WORD_1
  35 #define SCM_CELL_WORD_1(X) SCM_CDR (X)
  36 #endif
  37
  38 #define scm_bits_t SCM
  39
  40 #define fix_guile_1_3_4_scm_puts(scm_data, port) scm_puts ((char*)scm_data, port)
  41 #define scm_puts(scm_data, port) fix_guile_1_3_4_scm_puts (scm_data, port)
  42 #endif
  43
  44 /* Guile 1.4.x compatibility */
  45 #if GUILE_MINOR_VERSION < 5
  46
  47 #define scm_t_bits scm_bits_t
  48
  49 #define fix_guile_1_4_gh_scm2newstr(str, lenp) gh_scm2newstr (str, (int*)lenp)
  50 #define gh_scm2newstr(str, lenp) fix_guile_1_4_gh_scm2newstr (str, lenp)
  51
  52 #define fix_guile_1_4_scm_primitive_eval(form) scm_eval_3 (form, 1, SCM_EOL)
  53 #define scm_primitive_eval(form) fix_guile_1_4_scm_primitive_eval (form)
  54
  55 #define scm_current_module() (SCM)0
  56 #define scm_set_current_module(x) (void)x
  57 #define scm_c_resolve_module(x) (SCM)0
  58
  59 #define scm_c_define_gsubr scm_make_gsubr
  60 #define scm_c_eval_string(str) gh_eval_str ((char*)str)
  61 #define scm_c_memq scm_sloppy_memq
  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 #endif
  70
  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
 148 SCM ly_parse_scm (char const* s, int* n);
 149 SCM ly_quote_scm (SCM s);
 150 SCM ly_type (SCM);
 151 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 152 String print_scm_val (SCM val);
 153 SCM ly_number2string (SCM s);
 154
 155 SCM parse_symbol_list (char const *);
 156
 157 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 158 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 159 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
 160 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
 161 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
 162 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
 163 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
 164 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
 165 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
 166 /* inserts at front, removing dublicates */
 167 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
 168 {
 169   return scm_acons(key, val, scm_assoc_remove_x (alist, key));
 170 }
 171 inline bool ly_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
 172 inline bool ly_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
 173 inline bool ly_number_p (SCM x) { return SCM_NUMBERP (x); }
 174 inline bool ly_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p(x)); }
 175
 176 /*
 177   display and print newline.
 178  */
 179 extern "C" {
 180 void ly_display_scm (SCM s);
 181 }
 182
 183 #include "array.hh"
 184
 185 void read_lily_scm_file (String);
 186 void init_lily_guile (String dir);
 187
 188 bool ly_dir_p (SCM s);
 189 bool ly_number_pair_p (SCM);
 190 bool ly_axis_p (SCM);
 191
 192 /*
 193   these conversion functions also do a typecheck on the argument, and
 194   return a default value if S has the wrong type.
 195 */
 196
 197 Direction to_dir (SCM s);
 198 bool to_boolean (SCM s);
 199
 200 void init_ly_protection ();
 201 unsigned int ly_scm_hash (SCM s);
 202
 203 SCM index_cell (SCM cellp, Direction d);
 204 SCM index_set_cell (SCM cellp, Direction d, SCM val);
 205
 206
 207
 208 SCM ly_snoc (SCM s, SCM list);
 209 SCM ly_split_list (SCM s, SCM list);
 210 SCM ly_unique (SCM list);
 211 /*
 212   snarfing.
 213  */
 214 void add_scm_init_func (void (*) ());
 215
 216
 217 typedef SCM (*Scheme_function_unknown) ();
 218
 219 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 220 typedef SCM (*Scheme_function_0) ();
 221 typedef SCM (*Scheme_function_1) (SCM);
 222 typedef SCM (*Scheme_function_2) (SCM,SCM);
 223 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
 224 #else
 225 typedef SCM (*Scheme_function_0) (...);
 226 typedef SCM (*Scheme_function_1) (...);
 227 typedef SCM (*Scheme_function_2) (...);
 228 typedef SCM (*Scheme_function_3) (...);
 229 #endif
 230
 231 #define DECLARE_SCHEME_CALLBACK(NAME,ARGS) \
 232         static SCM NAME ARGS; \
 233         static SCM NAME ## _proc
 234
 235 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 236 SCM TYPE :: FUNC ## _proc;\
 237 void                                                            \
 238 TYPE ## _ ## FUNC ## _init_functions ()                                 \
 239 {                                                               \
 240   TYPE :: FUNC ## _proc = gh_new_procedure ## ARGCOUNT  ## _0 (#TYPE "::" #FUNC, \
 241  ((Scheme_function_ ## ARGCOUNT)TYPE :: FUNC));                                 \
 242 }                                                               \
 243                                                                 \
 244 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, TYPE ## _ ## FUNC ## _init_functions);       \
 245
 246
 247 void ly_add_function_documentation (char const * fname,
 248                                     char const * varlist,
 249                                     char const * doc);
 250
 251 #define ADD_SCM_INIT_FUNC(name, func)\
 252 class name ## _scm_initter {                    \
 253 public:\
 254   name ## _scm_initter ()                       \
 255   {                                             \
 256     add_scm_init_func (func);           \
 257   }                                             \
 258 } _ ## name ## _scm_initter;                    \
 259 /* end define */
 260
 261 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 262 SCM FNAME ARGLIST ; \
 263 SCM FNAME ## _proc;\
 264 void \
 265 FNAME ## init ()\
 266 {\
 267  FNAME ## _proc \
 268     = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, (Scheme_function_unknown) FNAME);\
 269   ly_add_function_documentation (PRIMNAME, #ARGLIST,  DOCSTRING);\
 270 }\
 271 ADD_SCM_INIT_FUNC (FNAME ## init_unique_prefix, FNAME ## init);\
 272 SCM \
 273 FNAME ARGLIST\
 274
 275
 276
 277 #endif // LILY_GUILE_HH