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