lily/include/lily-guile.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef LILY_GUILE_HH
  21 #define LILY_GUILE_HH
  22
  23 #if __MINGW32__
  24 #include "mingw-compatibility.hh"
  25 #endif
  26
  27 #include <libguile.h>
  28 #include <string.h>
  29
  30 /*
  31   Hack for various MacOS incarnations.
  32  */
  33 #ifndef GUILE_ELLIPSIS
  34 #define GUILE_ELLIPSIS
  35 #endif
  36
  37 #include "guile-compatibility.hh"
  38 #include "interval.hh"
  39 #include "lily-guile-macros.hh"
  40 #include "std-vector.hh"
  41
  42 /** Conversion functions follow the GUILE naming convention, i.e.
  43     A ly_B2A (B b);  */
  44
  45 SCM ly_last (SCM list);
  46 string ly_scm_write_string (SCM s);
  47 SCM ly_deep_copy (SCM);
  48 SCM ly_truncate_list (int k, SCM lst);
  49
  50 string gulp_file_to_string (const string &fn, bool must_exist, int size);
  51
  52 SCM ly_string2scm (string const &s);
  53 string ly_scm2string (SCM s);
  54 string ly_symbol2string (SCM);
  55 string robust_symbol2string (SCM, const string&);
  56 Rational ly_scm2rational (SCM);
  57 SCM ly_rational2scm (Rational);
  58 SCM ly_offset2scm (Offset);
  59 Offset ly_scm2offset (SCM);
  60 SCM ly_chain_assoc (SCM key, SCM achain);
  61 SCM ly_chain_assoc_get (SCM key, SCM achain, SCM default_value, SCM strict_checking = SCM_BOOL_F);
  62 SCM ly_assoc_cdr (SCM key, SCM alist);
  63 SCM ly_assoc_get (SCM key, SCM alist, SCM default_value, SCM strict_checking = SCM_BOOL_F);
  64 Interval ly_scm2interval (SCM);
  65 Drul_array<Real> ly_scm2realdrul (SCM);
  66 SCM ly_memv (SCM, SCM);
  67 Slice int_list_to_slice (SCM l);
  68 SCM ly_interval2scm (Drul_array<Real>);
  69 char *ly_scm2str0 (SCM str);
  70
  71 Real robust_scm2double (SCM, double);
  72 int robust_scm2int (SCM, int);
  73 vsize robust_scm2vsize (SCM, vsize);
  74 Direction robust_scm2dir (SCM, Direction);
  75 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
  76 Drul_array<bool> robust_scm2booldrul (SCM, Drul_array<bool>);
  77 Interval robust_scm2interval (SCM, Drul_array<Real>);
  78 Offset robust_scm2offset (SCM, Offset);
  79 string robust_scm2string (SCM, const string&);
  80 Rational robust_scm2rational (SCM, Rational);
  81 vector<Real> ly_scm2floatvector (SCM);
  82 SCM ly_floatvector2scm (vector<Real> v);
  83
  84 SCM ly_quote_scm (SCM s);
  85 bool type_check_assignment (SCM val, SCM sym, SCM type_symbol);
  86 string print_scm_val (SCM val);
  87 SCM ly_number2string (SCM s);
  88
  89 SCM parse_symbol_list (char const *);
  90 SCM robust_list_ref (int i, SCM l);
  91 SCM alist_to_hashq (SCM);
  92
  93 SCM ly_alist_vals (SCM alist);
  94 SCM ly_hash2alist (SCM tab);
  95 SCM ly_hash_table_keys (SCM tab);
  96
  97 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val);
  98
  99 inline bool ly_is_list (SCM x) { return scm_is_true (scm_list_p (x)); }
 100 inline bool ly_cheap_is_list (SCM x) { return scm_is_pair (x) || scm_is_null (x); }
 101 inline bool ly_is_module (SCM x) { return SCM_MODULEP (x); }
 102 inline bool ly_is_procedure (SCM x) { return scm_is_true (scm_procedure_p (x)); }
 103 inline bool ly_is_port (SCM x) { return scm_is_true (scm_port_p (x)); }
 104
 105 bool ly_is_rational (SCM);
 106 /*
 107   want to take the address of this function; scm_is_symbol() is a
 108   macro.
 109  */
 110 inline bool ly_is_symbol (SCM x) { return scm_is_symbol (x); }
 111
 112 inline bool ly_is_equal (SCM x, SCM y)
 113 {
 114   return scm_is_true (scm_equal_p (x, y));
 115 }
 116
 117 inline bool ly_scm2bool (SCM x) { return scm_is_true (x); }
 118 inline char ly_scm2char (SCM x) { return (char)SCM_CHAR (x); }
 119 inline SCM ly_bool2scm (bool x) { return scm_from_bool (x); }
 120
 121 inline SCM ly_append2 (SCM x1, SCM x2)
 122 {
 123   return scm_append (scm_list_2 (x1, x2));
 124 }
 125 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3)
 126 {
 127   return scm_append (scm_list_3 (x1, x2, x3));
 128 }
 129 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4)
 130 {
 131   return scm_append (scm_list_4 (x1, x2, x3, x4));
 132 }
 133
 134 /*
 135   display and print newline.
 136 */
 137 extern "C" {
 138   void ly_display_scm (SCM s);
 139 }
 140
 141 void read_lily_scm_file (string);
 142 void ly_c_init_guile ();
 143
 144 bool is_direction (SCM s);
 145 bool is_number_pair (SCM);
 146 bool is_axis (SCM);
 147
 148 /*
 149   these conversion functions also do a typecheck on the argument, and
 150   return a default value if S has the wrong type.
 151 */
 152
 153 Direction to_dir (SCM s);
 154 bool to_boolean (SCM s);
 155
 156 void init_ly_protection ();
 157 unsigned int ly_scm_hash (SCM s);
 158
 159 SCM index_get_cell (SCM cell, Direction d);
 160 SCM index_set_cell (SCM cell, Direction d, SCM val);
 161
 162 SCM ly_snoc (SCM s, SCM list);
 163 SCM ly_split_list (SCM s, SCM lst);
 164 SCM ly_unique (SCM lst);
 165 SCM ly_list_qsort_uniq_x (SCM lst);
 166
 167 SCM ly_output_formats ();
 168
 169 /*
 170   snarfing.
 171 */
 172 void add_scm_init_func (void ( *) ());
 173
 174 extern "C" {
 175   typedef SCM (*Scheme_function_unknown) (GUILE_ELLIPSIS);
 176 }
 177
 178 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 179 typedef SCM (*Scheme_function_0) ();
 180 typedef SCM (*Scheme_function_1) (SCM);
 181 typedef SCM (*Scheme_function_2) (SCM, SCM);
 182 typedef SCM (*Scheme_function_3) (SCM, SCM, SCM);
 183 #else
 184 typedef SCM (*Scheme_function_0) (GUILE_ELLIPSIS);
 185 typedef SCM (*Scheme_function_1) (GUILE_ELLIPSIS);
 186 typedef SCM (*Scheme_function_2) (GUILE_ELLIPSIS);
 187 typedef SCM (*Scheme_function_3) (GUILE_ELLIPSIS);
 188 #endif
 189
 190 /*
 191   Inline these for performance reasons.
 192  */
 193 #define scm_cdr ly_cdr
 194 #define scm_car ly_car
 195
 196 #ifndef scm_is_pair
 197 #define scm_is_pair ly_is_pair
 198 #endif
 199
 200 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 201 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 202 inline bool ly_is_pair (SCM x) { return SCM_I_CONSP (x); }
 203
 204 template<class T>
 205 SCM
 206 ly_cxx_vector_to_list (vector<T> const &src)
 207 {
 208   SCM l = SCM_EOL;
 209   for (vsize i = src.size (); i--;)
 210     l = scm_cons (src[i]->self_scm (), l);
 211
 212   return l;
 213 }
 214
 215 SCM ly_offsets2scm (vector<Offset> os);
 216 vector<Offset> ly_scm2offsets (SCM s);
 217
 218 /* For backward compatability with Guile 1.8 */
 219 #if !HAVE_GUILE_HASH_FUNC
 220 typedef SCM (*scm_t_hash_fold_fn) (GUILE_ELLIPSIS);
 221 typedef SCM (*scm_t_hash_handle_fn) (GUILE_ELLIPSIS);
 222 #endif
 223
 224 #endif /* LILY_GUILE_HH */