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--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #ifndef LILY_GUILE_HH
  10 #define LILY_GUILE_HH
  11
  12 #include <libguile.h>
  13
  14 #include "interval.hh"
  15 #include "guile-compatibility.hh"
  16
  17 #ifndef SMOB_FREE_RETURN_VAL
  18 #define SMOB_FREE_RETURN_VAL(CL) 0
  19 #endif
  20
  21 #ifndef SCM_PACK
  22 #define SCM_PACK(x) ((SCM) x)
  23 #endif
  24
  25 #ifndef SCM_UNPACK
  26 #define SCM_UNPACK(x) (x)
  27 #endif
  28
  29 /** Conversion functions follow the GUILE naming convention, i.e.
  30     A ly_B2A (B b);  */
  31
  32 SCM ly_last (SCM list);
  33 SCM ly_write2scm (SCM s);
  34 SCM ly_deep_copy (SCM);
  35 SCM ly_truncate_list (int k, SCM lst);
  36
  37 SCM ly_to_string (SCM scm);
  38 SCM ly_to_symbol (SCM scm);
  39
  40 #if (__GNUC__ > 2)
  41 /* Unreliable with gcc-2.x
  42    FIXME: should add check for x86 as well?  */
  43 #define CACHE_SYMBOLS
  44 #endif
  45
  46 #ifdef CACHE_SYMBOLS
  47
  48 /* Using this trick we cache the value of scm_str2symbol ("fooo") where
  49   "fooo" is a constant string. This is done at the cost of one static
  50   variable per ly_symbol2scm() use, and one boolean evaluation for
  51   every call.
  52
  53   The overall speedup of lily is about 5% on a run of wtk1-fugue2.  */
  54 #define ly_symbol2scm(x) \
  55 ({ \
  56   static SCM cached; \
  57   /* We store this one locally, since G++ -O2 fucks up else */ \
  58   SCM value = cached; \
  59   if ( __builtin_constant_p ((x))) \
  60     { \
  61       if (!cached) \
  62         value = cached =  scm_gc_protect_object (scm_str2symbol ((x))); \
  63     } \
  64   else \
  65     value = scm_str2symbol ((char*) (x)); \
  66   value; \
  67 })
  68 #else
  69 inline SCM ly_symbol2scm(char const* x) { return scm_str2symbol ((x)); }
  70 #endif
  71
  72 extern SCM global_lily_module;
  73
  74 /*
  75   TODO: rename me to ly_c_lily_module_eval
  76  */
  77 #define ly_scheme_function(x) \
  78 ({ \
  79   static SCM cached; \
  80   /* We store this one locally, since G++ -O2 fucks up else */ \
  81   SCM value = cached; \
  82   if ( __builtin_constant_p ((x))) \
  83     { \
  84       if (!cached) \
  85         value = cached = scm_gc_protect_object (scm_eval (scm_str2symbol (x), \
  86                                                 global_lily_module)); \
  87     } \
  88   else \
  89     value = scm_eval (scm_str2symbol (x), global_lily_module); \
  90   value; \
  91 })
  92
  93 String gulp_file_to_string (String fn, bool must_exist);
  94
  95 String ly_scm2string (SCM s);
  96 String ly_symbol2string (SCM);
  97 SCM ly_offset2scm (Offset);
  98 Offset ly_scm2offset (SCM);
  99 SCM ly_chain_assoc (SCM key, SCM achain);
 100 SCM ly_chain_assoc_get (SCM key, SCM achain, SCM dfault);
 101 SCM ly_assoc_cdr (SCM key, SCM alist);
 102 SCM ly_assoc_get (SCM key, SCM alist, SCM def);
 103 Interval ly_scm2interval (SCM);
 104 Drul_array<Real> ly_scm2realdrul (SCM);
 105 Slice int_list_to_slice (SCM l);
 106 SCM ly_interval2scm (Drul_array<Real>);
 107 char *ly_scm2newstr (SCM str, size_t *lenp);
 108
 109 Real robust_scm2double (SCM, double);
 110 int robust_scm2int (SCM, int);
 111 Drul_array<Real> robust_scm2drul (SCM, Drul_array<Real>);
 112 Interval robust_scm2interval (SCM, Drul_array<Real>);
 113 Offset robust_scm2offset (SCM, Offset);
 114
 115 SCM ly_quote_scm (SCM s);
 116 bool type_check_assignment (SCM val, SCM sym,  SCM type_symbol) ;
 117 String print_scm_val (SCM val);
 118 SCM ly_number2string (SCM s);
 119
 120 SCM parse_symbol_list (char const *);
 121 SCM robust_list_ref(int i, SCM l);
 122 SCM alist_to_hashq (SCM);
 123
 124
 125 /* inserts at front, removing dublicates */
 126 inline SCM ly_assoc_front_x(SCM alist, SCM key, SCM val)
 127 {
 128   return scm_acons(key, val, scm_assoc_remove_x (alist, key));
 129 }
 130 inline bool ly_c_char_p (SCM x) { return SCM_CHARP (x); }
 131 inline bool ly_c_vector_p (SCM x) { return SCM_VECTORP (x); }
 132 inline bool ly_c_list_p (SCM x) { return SCM_NFALSEP (scm_list_p (x)); }
 133 inline bool ly_c_procedure_p (SCM x) { return SCM_NFALSEP (scm_procedure_p (x)); }
 134 inline bool ly_c_equal_p (SCM x, SCM y) {
 135   return SCM_NFALSEP (scm_equal_p (x, y));
 136 }
 137
 138
 139 inline bool ly_scm2bool (SCM x) { return SCM_NFALSEP (x); }
 140 inline char ly_scm2char (SCM x) { return SCM_CHAR(x); }
 141 inline unsigned long ly_length (SCM x) {
 142   return scm_num2ulong (scm_length (x), 0, "ly_length");
 143 }
 144 inline unsigned long ly_vector_length (SCM x) { return SCM_VECTOR_LENGTH (x); }
 145
 146 inline SCM ly_bool2scm (bool x) { return SCM_BOOL (x); }
 147
 148 inline SCM ly_append2 (SCM x1, SCM x2) {
 149   return scm_append (scm_listify (x1, x2, SCM_UNDEFINED));
 150 }
 151 inline SCM ly_append3 (SCM x1, SCM x2, SCM x3) {
 152   return scm_append (scm_listify (x1, x2, x3, SCM_UNDEFINED));
 153 }
 154 inline SCM ly_append4 (SCM x1, SCM x2, SCM x3, SCM x4) {
 155   return scm_append (scm_listify (x1, x2, x3, x4, SCM_UNDEFINED));
 156 }
 157
 158 /*
 159   display and print newline.
 160  */
 161 extern "C" {
 162 void ly_display_scm (SCM s);
 163 }
 164
 165 void read_lily_scm_file (String);
 166 void ly_c_init_guile ();
 167
 168 bool is_direction (SCM s);
 169 bool is_number_pair (SCM);
 170 bool is_axis (SCM);
 171
 172 /*
 173   these conversion functions also do a typecheck on the argument, and
 174   return a default value if S has the wrong type.
 175 */
 176
 177 Direction to_dir (SCM s);
 178 bool to_boolean (SCM s);
 179
 180 void init_ly_protection ();
 181 unsigned int ly_scm_hash (SCM s);
 182
 183 SCM index_get_cell (SCM cell, Direction d);
 184 SCM index_set_cell (SCM cell, Direction d, SCM val);
 185
 186 SCM ly_snoc (SCM s, SCM list);
 187 SCM ly_split_list (SCM s, SCM lst);
 188 SCM ly_unique (SCM lst);
 189 SCM ly_list_qsort_uniq_x (SCM lst);
 190
 191 SCM ly_output_formats();
 192 SCM ly_kpathsea_find_file (SCM);
 193
 194 /*
 195   snarfing.
 196  */
 197 void add_scm_init_func (void (*) ());
 198
 199 extern "C" {
 200 typedef SCM (*Scheme_function_unknown) ();
 201 }
 202
 203 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 96
 204 typedef SCM (*Scheme_function_0) ();
 205 typedef SCM (*Scheme_function_1) (SCM);
 206 typedef SCM (*Scheme_function_2) (SCM,SCM);
 207 typedef SCM (*Scheme_function_3) (SCM,SCM, SCM);
 208 #else
 209 typedef SCM (*Scheme_function_0) (...);
 210 typedef SCM (*Scheme_function_1) (...);
 211 typedef SCM (*Scheme_function_2) (...);
 212 typedef SCM (*Scheme_function_3) (...);
 213 #endif
 214
 215
 216 /*
 217   Adds the NAME as a Scheme function, and a variable to store the SCM
 218   version of the function in the static variable NAME_proc
 219  */
 220 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS) \
 221         static SCM NAME ARGS; \
 222         static SCM NAME ## _proc
 223
 224 /*
 225   Make TYPE::FUNC available as a Scheme function.
 226  */
 227 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT) \
 228 SCM TYPE :: FUNC ## _proc; \
 229 void \
 230 TYPE ## _ ## FUNC ## _init_functions () \
 231 { \
 232   TYPE :: FUNC ## _proc = scm_c_define_gsubr (#TYPE "::" #FUNC, \
 233                                               (ARGCOUNT), 0, 0, \
 234                           (Scheme_function_unknown)TYPE :: FUNC); \
 235   scm_c_export (#TYPE "::" #FUNC, NULL); \
 236 } \
 237  \
 238 ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback, \
 239                    TYPE ## _ ## FUNC ## _init_functions);
 240
 241
 242 void
 243 ly_add_function_documentation (SCM proc, char const *fname,
 244                                char const *varlist,
 245                                char const *doc);
 246
 247 #define ADD_SCM_INIT_FUNC(name, func) \
 248 class name ## _scm_initter \
 249 { \
 250 public: \
 251   name ## _scm_initter () \
 252   { \
 253     add_scm_init_func (func); \
 254   } \
 255 } _ ## name ## _scm_initter; \
 256 /* end define */
 257
 258 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
 259                                ARGLIST, DOCSTRING) \
 260 SCM FNAME ## _proc; \
 261 void \
 262 INITPREFIX ## init () \
 263 { \
 264   FNAME ## _proc = scm_c_define_gsubr (PRIMNAME,REQ, OPT, VAR, \
 265                                        (Scheme_function_unknown) FNAME); \
 266   ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST, \
 267                                  DOCSTRING); \
 268   scm_c_export (PRIMNAME, NULL); \
 269 } \
 270 ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
 271 SCM \
 272 FNAME ARGLIST
 273
 274
 275 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING) \
 276 SCM FNAME ARGLIST; \
 277 LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
 278                         DOCSTRING)
 279
 280 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
 281                                   ARGLIST, DOCSTRING) \
 282 SCM FNAME ARGLIST; \
 283 LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
 284                         VAR, ARGLIST, DOCSTRING)
 285
 286 #define get_property(x) internal_get_property (ly_symbol2scm (x))
 287 #define set_property(x, y) internal_set_property (ly_symbol2scm (x), y)
 288
 289 #endif /* LILY_GUILE_HH */