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--2007 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #ifndef LILY_GUILE_HH
  10 #define LILY_GUILE_HH
  11
  12 #if __MINGW32__
  13 #include "mingw-compatibility.hh"
  14 #endif
  15
  16 #include <libguile.h>
  17 #include <string.h>
  18
  19 /*
  20   Hack for various MacOS incarnations.
  21  */
  22 #ifndef GUILE_ELLIPSIS
  23 #define GUILE_ELLIPSIS
  24 #endif
  25
  26 #include "guile-compatibility.hh"
  27 #include "interval.hh"
  28 #include "lily-guile-macros.hh"
  29 #include "ly-module.hh"
  30
  31 /** Conversion functions follow the GUILE naming convention, i.e.
  32     A ly_B2A (B b);  */
  33
  34 SCM ly_last (SCM list);
  35 string ly_scm_write_string (SCM s);
  36 SCM ly_deep_copy (SCM);
  37 SCM ly_truncate_list (int k, SCM lst);
  38
  39 extern SCM global_lily_module;
  40
  41 string gulp_file_to_string (string fn, bool must_exist, int size);
  42
  43 SCM ly_string2scm (string const &s);
  44 string ly_scm2string (SCM s);
  45 string ly_symbol2string (SCM);
  46 Rational ly_scm2rational (SCM);
  47 SCM ly_rational2scm (Rational);
  48 SCM ly_offset2scm (Offset);
  49 Offset ly_scm2offset (SCM);
  50 SCM ly_chain_assoc (SCM key, SCM achain);
  51 SCM ly_chain_assoc_get (SCM key, SCM achain, SCM dfault);
  52 SCM ly_assoc_cdr (SCM key, SCM alist);
  53 SCM ly_assoc_get (SCM key, SCM alist, SCM def);
  54 Interval ly_scm2interval (SCM);
  55 Drul_array<Real> ly_scm2realdrul (SCM);
  56 Slice int_list_to_slice (SCM l);
  57 SCM ly_interval2scm (Drul_array<Real>);
  58 char *ly_scm2newstr (SCM str, size_t *lenp);
  59
  60 Real robust_scm2double (SCM, double);
  61 int robust_scm2int (SCM, int);
  62 Direction robust_scm2dir (SCM, Direction);
  63 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
  64 Drul_array<bool> robust_scm2booldrul (SCM, Drul_array<bool>);
  65 Interval robust_scm2interval (SCM, Drul_array<Real>);
  66 Offset robust_scm2offset (SCM, Offset);
  67 string robust_scm2string (SCM, string);
  68 Rational robust_scm2rational (SCM, Rational);
  69
  70
  71 SCM ly_quote_scm (SCM s);
  72 bool type_check_assignment (SCM val, SCM sym, SCM type_symbol);
  73 string print_scm_val (SCM val);
  74 SCM ly_number2string (SCM s);
  75
  76 SCM parse_symbol_list (char const *);
  77 SCM robust_list_ref (int i, SCM l);
  78 SCM alist_to_hashq (SCM);
  79
  80 SCM ly_alist_vals (SCM alist);
  81 SCM ly_hash2alist (SCM tab);
  82 SCM ly_hash_table_keys (SCM tab);
  83
  84 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val);
  85 inline bool ly_is_fraction (SCM x) { return SCM_FRACTIONP(x) || scm_is_integer (x); }
  86
  87 inline bool ly_is_list (SCM x) { return SCM_NFALSEP (scm_list_p (x)); }
  88 inline bool ly_cheap_is_list (SCM x) { return scm_is_pair (x) || x == SCM_EOL; }
  89 inline bool ly_is_procedure (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
  90 inline bool ly_is_port (SCM x) { return SCM_NFALSEP (scm_port_p (x)); }
  91
  92 /*
  93   want to take the address of this function; scm_is_symbol() is a
  94   macro.
  95  */
  96 inline bool ly_is_symbol (SCM x) { return scm_is_symbol (x); }
  97
  98 inline bool ly_is_equal (SCM x, SCM y)
  99 {
 100   return SCM_NFALSEP (scm_equal_p (x, y));
 101 }
 102
 103 inline bool ly_scm2bool (SCM x) { return SCM_NFALSEP (x); }
 104 inline char ly_scm2char (SCM x) { return (char)SCM_CHAR (x); }
 105 inline SCM ly_bool2scm (bool x) { return SCM_BOOL (x); }
 106
 107 inline SCM ly_append2 (SCM x1, SCM x2)
 108 {
 109   return scm_append (scm_listify (x1, x2, SCM_UNDEFINED));
 110 }
 111 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3)
 112 {
 113   return scm_append (scm_listify (x1, x2, x3, SCM_UNDEFINED));
 114 }
 115 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4)
 116 {
 117   return scm_append (scm_listify (x1, x2, x3, x4, SCM_UNDEFINED));
 118 }
 119
 120 /*
 121   display and print newline.
 122 */
 123 extern "C" {
 124   void ly_display_scm (SCM s);
 125 }
 126
 127 void read_lily_scm_file (string);
 128 void ly_c_init_guile ();
 129
 130 bool is_direction (SCM s);
 131 bool is_number_pair (SCM);
 132 bool is_axis (SCM);
 133
 134 /*
 135   these conversion functions also do a typecheck on the argument, and
 136   return a default value if S has the wrong type.
 137 */
 138
 139 Direction to_dir (SCM s);
 140 bool to_boolean (SCM s);
 141
 142 void init_ly_protection ();
 143 unsigned int ly_scm_hash (SCM s);
 144
 145 SCM index_get_cell (SCM cell, Direction d);
 146 SCM index_set_cell (SCM cell, Direction d, SCM val);
 147
 148 SCM ly_snoc (SCM s, SCM list);
 149 SCM ly_split_list (SCM s, SCM lst);
 150 SCM ly_unique (SCM lst);
 151 SCM ly_list_qsort_uniq_x (SCM lst);
 152
 153 SCM ly_output_formats ();
 154 SCM ly_kpathsea_find_file (SCM);
 155
 156 /*
 157   snarfing.
 158 */
 159 void add_scm_init_func (void (*) ());
 160
 161 extern "C" {
 162   typedef SCM (*Scheme_function_unknown) (GUILE_ELLIPSIS);
 163 }
 164
 165 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 166 typedef SCM (*Scheme_function_0) ();
 167 typedef SCM (*Scheme_function_1) (SCM);
 168 typedef SCM (*Scheme_function_2) (SCM, SCM);
 169 typedef SCM (*Scheme_function_3) (SCM, SCM, SCM);
 170 #else
 171 typedef SCM (*Scheme_function_0) (GUILE_ELLIPSIS);
 172 typedef SCM (*Scheme_function_1) (GUILE_ELLIPSIS);
 173 typedef SCM (*Scheme_function_2) (GUILE_ELLIPSIS);
 174 typedef SCM (*Scheme_function_3) (GUILE_ELLIPSIS);
 175 #endif
 176
 177
 178 /*
 179   Inline these for performance reasons.
 180  */
 181 #define scm_cdr ly_cdr
 182 #define scm_car ly_car
 183
 184 #ifndef scm_is_pair
 185 #define scm_is_pair ly_is_pair
 186 #endif
 187
 188 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 189 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 190 inline bool ly_is_pair (SCM x) { return SCM_I_CONSP (x); }
 191
 192
 193
 194 #include  "std-vector.hh"
 195
 196 template<class T>
 197 SCM
 198 ly_cxx_vector_to_list  (vector<T> const &src)
 199 {
 200   SCM l = SCM_EOL;
 201   for (vsize i = src.size (); i --; )
 202     l = scm_cons (src[i]->self_scm (), l);
 203
 204   return l;
 205 }
 206
 207
 208 SCM ly_offsets2scm (vector<Offset> os);
 209 vector<Offset> ly_scm2offsets (SCM s);
 210
 211 #endif /* LILY_GUILE_HH */