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--2001 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
  25 /* Guile 1.3.4 compatibility */
  26 #if GUILE_MINOR_VERSION < 4
  27
  28
  29 #ifndef SCM_CELL_TYPE
  30 #define SCM_CELL_TYPE(X) SCM_CAR (X)
  31 #endif
  32
  33 #ifndef SCM_CELL_WORD_1
  34 #define SCM_CELL_WORD_1(X) SCM_CDR (X)
  35 #endif
  36
  37 #define scm_bits_t SCM
  38
  39 #define fix_guile_1_3_4_scm_puts(scm_data, port) scm_puts ((char*)scm_data, port)
  40 #define scm_puts(scm_data, port) fix_guile_1_3_4_scm_puts (scm_data, port)
  41 #endif
  42
  43 /* Guile 1.4.x compatibility */
  44 #if GUILE_MINOR_VERSION < 5
  45
  46 #define scm_t_bits scm_bits_t
  47
  48 #define fix_guile_1_4_gh_scm2newstr(str, lenp) gh_scm2newstr (str, (int*)lenp)
  49 #define gh_scm2newstr(str, lenp) fix_guile_1_4_gh_scm2newstr (str, lenp)
  50
  51 #define fix_guile_1_4_scm_primitive_eval(form) scm_eval_3 (form, 1, SCM_EOL)
  52 #define scm_primitive_eval(form) fix_guile_1_4_scm_primitive_eval (form)
  53
  54 #define scm_c_define_gsubr scm_make_gsubr
  55 #define scm_c_eval_string(str) gh_eval_str ((char*)str)
  56 #define scm_c_memq scm_sloppy_memq
  57 #define scm_gc_protect_object scm_protect_object
  58 #define scm_gc_unprotect_object scm_unprotect_object
  59 #define scm_list_n scm_listify
  60 #define SCM_STRING_CHARS SCM_CHARS
  61 #define SCM_STRING_LENGTH SCM_LENGTH
  62 #define SCM_SYMBOL_CHARS SCM_CHARS
  63 #define SCM_SYMBOL_LENGTH SCM_LENGTH
  64 #endif
  65
  66
  67
  68 #include "direction.hh"
  69 #include "flower-proto.hh"
  70
  71 #ifndef SCM_PACK
  72 #define SCM_PACK(x) ((SCM) x)
  73
  74 #endif
  75 #ifndef SCM_UNPACK
  76 #define SCM_UNPACK(x) ( x)
  77 #endif
  78
  79 /*
  80   conversion functions follow the GUILE naming convention, i.e.
  81
  82     A ly_B2A (B b);
  83  */
  84
  85 SCM ly_last (SCM list);
  86 SCM ly_str02scm (char const*c);
  87 SCM ly_write2scm (SCM s);
  88 SCM ly_deep_copy (SCM);
  89 SCM ly_truncate_list (int k, SCM l );
  90
  91 #define CACHE_SYMBOLS
  92 #ifdef CACHE_SYMBOLS
  93
  94
  95 /*
  96   We don't use gh_symbol2scm directly, since it has const-correctness
  97   problems in GUILE 1.3.4
  98
  99  */
 100 SCM my_gh_symbol2scm (const char* x);
 101
 102 // #warning: CACHE_SYMBOLS
 103
 104 /*
 105   Using this trick we cache the value of gh_symbol2scm ("fooo") where
 106   "fooo" is a constant string. This is done at the cost of one static
 107   variable per ly_symbol2scm() use, and one boolean evaluation for
 108   every call.
 109
 110   The overall speedup of lily is about 5% on a run of wtk1-fugue2
 111
 112 */
 113 #define ly_symbol2scm(x) ({ static SCM cached;  \
 114  SCM value = cached;  /* We store this one locally, since G++ -O2 fucks up else */   \
 115  if ( __builtin_constant_p ((x)))\
 116  {  if (!cached)\
 117      value = cached =  scm_gc_protect_object (my_gh_symbol2scm((x)));\
 118  } else\
 119   value = gh_symbol2scm ((char*) (x)); \
 120   value; })
 121 #else
 122 inline SCM ly_symbol2scm(char const* x) { return gh_symbol2scm((x)); }
 123 #endif
 124
 125
 126
 127 String ly_scm2string (SCM s);
 128 String ly_symbol2string (SCM);
 129 SCM ly_offset2scm (Offset);
 130 Offset ly_scm2offset (SCM);
 131 SCM ly_assoc_chain (SCM key, SCM achain);
 132 Interval ly_scm2interval (SCM);
 133 SCM ly_interval2scm (Interval);
 134
 135 SCM ly_parse_scm (char const* s, int* n);
 136 SCM ly_quote_scm (SCM s);
 137 SCM ly_type (SCM);
 138 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 139 SCM ly_number2string (SCM s);
 140
 141 SCM parse_symbol_list (char const *);
 142
 143 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 144 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 145 inline SCM ly_caar (SCM x) { return SCM_CAAR (x); }
 146 inline SCM ly_cdar (SCM x) { return SCM_CDAR (x); }
 147 inline SCM ly_cadr (SCM x) { return SCM_CADR (x); }
 148 inline SCM ly_cddr (SCM x) { return SCM_CDDR (x); }
 149 inline SCM ly_caddr (SCM x) { return SCM_CADDR (x); }
 150 inline SCM ly_cdadr (SCM x) { return SCM_CDADR (x); }
 151 inline SCM ly_caadr (SCM x) { return SCM_CAADR (x); }
 152 inline bool ly_pair_p (SCM x) { return SCM_NFALSEP (scm_pair_p (x)); }
 153 inline bool ly_symbol_p (SCM x) { return SCM_SYMBOLP (x); }
 154 inline bool ly_number_p (SCM x) { return SCM_NUMBERP (x); }
 155 inline bool ly_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p(x)); }
 156
 157 /*
 158   display and print newline.
 159  */
 160 extern "C" {
 161 void ly_display_scm (SCM s);
 162 }
 163
 164 #include "array.hh"
 165
 166 void read_lily_scm_file (String);
 167 void init_lily_guile ();
 168
 169 bool isdir_b (SCM s);
 170 bool isaxis_b (SCM s);
 171 bool ly_number_pair_p (SCM);
 172 bool ly_axis_p (SCM);
 173
 174 /*
 175   these conversion functions also do a typecheck on the argument, and
 176   return a default value if S has the wrong type.
 177 */
 178
 179 Direction to_dir (SCM s);
 180 bool to_boolean (SCM s);
 181
 182 void init_ly_protection ();
 183 unsigned int ly_scm_hash (SCM s);
 184
 185 SCM index_cell (SCM cellp, Direction d);
 186 SCM index_set_cell (SCM cellp, Direction d, SCM val);
 187
 188
 189 /*
 190   snarfing.
 191  */
 192 void add_scm_init_func (void (*) ());
 193
 194
 195 typedef SCM (*Scheme_function_unknown) ();
 196
 197 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 198 typedef SCM (*Scheme_function_0) ();
 199 typedef SCM (*Scheme_function_1) (SCM);
 200 typedef SCM (*Scheme_function_2) (SCM,SCM);
 201 #else
 202 typedef SCM (*Scheme_function_0) (...);
 203 typedef SCM (*Scheme_function_1) (...);
 204 typedef SCM (*Scheme_function_2) (...);
 205 #endif
 206
 207 #define DECLARE_SCHEME_CALLBACK(NAME,ARGS) \
 208         static SCM NAME ARGS; \
 209         static SCM NAME ## _proc
 210
 211 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 212 SCM TYPE :: FUNC ## _proc;\
 213 void                                                            \
 214 TYPE ## _ ## FUNC ## _init_functions ()                                 \
 215 {                                                               \
 216   TYPE :: FUNC ## _proc = gh_new_procedure ## ARGCOUNT  ## _0 (#TYPE "::" #FUNC, \
 217  ((Scheme_function_ ## ARGCOUNT)TYPE :: FUNC));                                 \
 218 }                                                               \
 219                                                                 \
 220 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, TYPE ## _ ## FUNC ## _init_functions);       \
 221
 222
 223 #define ADD_SCM_INIT_FUNC(name, func)\
 224 class name ## _scm_initter {                    \
 225 public:\
 226   name ## _scm_initter ()                       \
 227   {                                             \
 228     add_scm_init_func (func);           \
 229   }                                             \
 230 } _ ## name ## _scm_initter;                    \
 231 /* end define */
 232
 233 #endif // LILY_GUILE_HH