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 std::string ly_scm_write_string (SCM s);
  47 SCM ly_deep_copy (SCM);
  48 SCM ly_truncate_list (int k, SCM lst);
  49
  50 std::string gulp_file_to_string (const std::string &fn, bool must_exist, int size);
  51
  52 SCM ly_string2scm (std::string const &s);
  53 std::string ly_scm2string (SCM s);
  54 std::string ly_symbol2string (SCM);
  55 std::string robust_symbol2string (SCM, const std::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 Slice int_list_to_slice (SCM l);
  67 SCM ly_interval2scm (Drul_array<Real>);
  68 char *ly_scm2str0 (SCM str);
  69
  70 Real robust_scm2double (SCM, double);
  71 int robust_scm2int (SCM, int);
  72 vsize robust_scm2vsize (SCM, vsize);
  73 Direction robust_scm2dir (SCM, Direction);
  74 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
  75 Drul_array<bool> robust_scm2booldrul (SCM, Drul_array<bool>);
  76 Interval robust_scm2interval (SCM, Drul_array<Real>);
  77 Offset robust_scm2offset (SCM, Offset);
  78 std::string robust_scm2string (SCM, const std::string&);
  79 Rational robust_scm2rational (SCM, Rational);
  80 std::vector<Real> ly_scm2floatvector (SCM);
  81 SCM ly_floatvector2scm (std::vector<Real> v);
  82
  83 SCM ly_quote_scm (SCM s);
  84 bool type_check_assignment (SCM val, SCM sym, SCM type_symbol);
  85 std::string print_scm_val (SCM val);
  86 SCM ly_number2string (SCM s);
  87
  88 SCM parse_symbol_list (char const *);
  89 SCM robust_list_ref (int i, SCM l);
  90 SCM alist_to_hashq (SCM);
  91
  92 SCM ly_alist_vals (SCM alist);
  93 SCM ly_hash2alist (SCM tab);
  94 SCM ly_hash_table_keys (SCM tab);
  95
  96 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val);
  97
  98 inline bool ly_is_list (SCM x) { return scm_is_true (scm_list_p (x)); }
  99 inline bool ly_cheap_is_list (SCM x) { return scm_is_pair (x) || scm_is_null (x); }
 100 inline bool ly_is_module (SCM x) { return SCM_MODULEP (x); }
 101 inline bool ly_is_procedure (SCM x) { return scm_is_true (scm_procedure_p (x)); }
 102 inline bool ly_is_port (SCM x) { return scm_is_true (scm_port_p (x)); }
 103
 104 bool ly_is_rational (SCM);
 105 /*
 106   want to take the address of this function; scm_is_symbol() is a
 107   macro.
 108  */
 109 inline bool ly_is_symbol (SCM x) { return scm_is_symbol (x); }
 110
 111 inline bool ly_is_equal (SCM x, SCM y)
 112 {
 113   return scm_is_true (scm_equal_p (x, y));
 114 }
 115
 116 inline bool ly_scm2bool (SCM x) { return scm_is_true (x); }
 117 inline char ly_scm2char (SCM x) { return (char)SCM_CHAR (x); }
 118 inline SCM ly_bool2scm (bool x) { return scm_from_bool (x); }
 119
 120 inline SCM ly_append2 (SCM x1, SCM x2)
 121 {
 122   return scm_append (scm_list_2 (x1, x2));
 123 }
 124 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3)
 125 {
 126   return scm_append (scm_list_3 (x1, x2, x3));
 127 }
 128 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4)
 129 {
 130   return scm_append (scm_list_4 (x1, x2, x3, x4));
 131 }
 132
 133 /*
 134   display and print newline.
 135 */
 136 extern "C" {
 137   void ly_display_scm (SCM s);
 138 }
 139
 140 void read_lily_scm_file (std::string);
 141 void ly_c_init_guile ();
 142
 143 bool is_direction (SCM s);
 144 bool is_number_pair (SCM);
 145 bool is_axis (SCM);
 146
 147 /*
 148   these conversion functions also do a typecheck on the argument, and
 149   return a default value if S has the wrong type.
 150 */
 151
 152 Direction to_dir (SCM s);
 153 bool to_boolean (SCM s);
 154
 155 void init_ly_protection ();
 156 unsigned int ly_scm_hash (SCM s);
 157
 158 SCM index_get_cell (SCM cell, Direction d);
 159 SCM index_set_cell (SCM cell, Direction d, SCM val);
 160
 161 SCM ly_snoc (SCM s, SCM list);
 162 SCM ly_split_list (SCM s, SCM lst);
 163 SCM ly_unique (SCM lst);
 164 SCM ly_list_qsort_uniq_x (SCM lst);
 165
 166 SCM ly_output_formats ();
 167
 168 /*
 169   snarfing.
 170 */
 171 void add_scm_init_func (void ( *) ());
 172
 173 extern "C" {
 174   typedef SCM (*Scheme_function_unknown) (GUILE_ELLIPSIS);
 175 }
 176
 177 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 178 typedef SCM (*Scheme_function_0) ();
 179 typedef SCM (*Scheme_function_1) (SCM);
 180 typedef SCM (*Scheme_function_2) (SCM, SCM);
 181 typedef SCM (*Scheme_function_3) (SCM, SCM, SCM);
 182 #else
 183 typedef SCM (*Scheme_function_0) (GUILE_ELLIPSIS);
 184 typedef SCM (*Scheme_function_1) (GUILE_ELLIPSIS);
 185 typedef SCM (*Scheme_function_2) (GUILE_ELLIPSIS);
 186 typedef SCM (*Scheme_function_3) (GUILE_ELLIPSIS);
 187 #endif
 188
 189 /*
 190   Inline these for performance reasons.
 191  */
 192 #define scm_cdr ly_cdr
 193 #define scm_car ly_car
 194
 195 #ifndef scm_is_pair
 196 #define scm_is_pair ly_is_pair
 197 #endif
 198
 199 inline SCM ly_car (SCM x) { return SCM_CAR (x); }
 200 inline SCM ly_cdr (SCM x) { return SCM_CDR (x); }
 201 inline bool ly_is_pair (SCM x) { return SCM_I_CONSP (x); }
 202
 203 template<class T>
 204 SCM
 205 ly_cxx_vector_to_list (std::vector<T> const &src)
 206 {
 207   SCM l = SCM_EOL;
 208   for (vsize i = src.size (); i--;)
 209     l = scm_cons (src[i]->self_scm (), l);
 210
 211   return l;
 212 }
 213
 214 SCM ly_offsets2scm (std::vector<Offset> os);
 215 std::vector<Offset> ly_scm2offsets (SCM s);
 216
 217 /* For backward compatability with Guile 1.8 */
 218 #if !HAVE_GUILE_HASH_FUNC
 219 typedef SCM (*scm_t_hash_fold_fn) (GUILE_ELLIPSIS);
 220 typedef SCM (*scm_t_hash_handle_fn) (GUILE_ELLIPSIS);
 221 #endif
 222
 223 #endif /* LILY_GUILE_HH */