lily/lily-guile.cc

   1 /*
   2   lily-guile.cc -- implement assorted guile functions
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2001 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8   Han-Wen Nienhuys <hanwen@cs.uu.nl>
   9 */
  10
  11
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <math.h>   /* isinf */
  15 #include <string.h> /* strdup, strchr */
  16 #include "libc-extension.hh"
  17 #include "lily-guile.hh"
  18 #include "main.hh"
  19 #include "simple-file-storage.hh"
  20 #include "file-path.hh"
  21 #include "debug.hh"
  22 #include "direction.hh"
  23 #include "offset.hh"
  24 #include "interval.hh"
  25
  26 SCM
  27 ly_last (SCM list)
  28 {
  29   return ly_car (scm_last_pair (list));
  30 }
  31
  32 SCM
  33 ly_str02scm (char const*c)
  34 {
  35   // this all really sucks, guile should take char const* arguments!
  36   return gh_str02scm ((char*)c);
  37 }
  38
  39
  40 SCM
  41 ly_write2scm (SCM s)
  42 {
  43   SCM port = scm_mkstrport (SCM_INUM0,
  44                             scm_make_string (SCM_INUM0, SCM_UNDEFINED),
  45                             SCM_OPN | SCM_WRTNG,
  46                             "ly_write2string");
  47   //  SCM write = scm_eval_3 (ly_symbol2scm ("write"), s, SCM_EOL);
  48   SCM write = scm_primitive_eval (ly_symbol2scm ("write"));
  49
  50   // scm_apply (write, port, SCM_EOL);
  51   gh_call2 (write, s, port);
  52   return scm_strport_to_string (port);
  53 }
  54
  55
  56 /*
  57   Pass string to scm parser, evaluate one expression.
  58   Return result value and #chars read.
  59
  60   Thanks to Gary Houston <ghouston@freewire.co.uk>
  61
  62   Need guile-1.3.4 (>1.3 anyway) for ftell on str ports -- jcn
  63 */
  64 SCM
  65 ly_parse_scm (char const* s, int* n)
  66 {
  67   SCM str = ly_str02scm (s);
  68   SCM port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_RDNG,
  69                             "ly_eval_scm_0str");
  70   SCM from = scm_ftell (port);
  71
  72   SCM form;
  73   SCM answer = SCM_UNSPECIFIED;
  74
  75   /* Read expression from port */
  76   if (!SCM_EOF_OBJECT_P (form = scm_read (port)))
  77     answer = scm_primitive_eval (form);
  78
  79   /*
  80    After parsing
  81
  82  (begin (foo 1 2))
  83
  84    all seems fine, but after parsing
  85
  86  (foo 1 2)
  87
  88    read_buf has been advanced to read_pos - 1,
  89    so that scm_ftell returns 1, instead of #parsed chars
  90    */
  91
  92   /*
  93     urg: reset read_buf for scm_ftell
  94     shouldn't scm_read () do this for us?
  95   */
  96   scm_fill_input (port);
  97   SCM to = scm_ftell (port);
  98   *n = gh_scm2int (to) - gh_scm2int (from);
  99
 100   /* Don't close the port here; if we re-enter this function via a
 101      continuation, then the next time we enter it, we'll get an error.
 102      It's a string port anyway, so there's no advantage to closing it
 103      early.
 104
 105      scm_close_port (port);
 106   */
 107
 108   return answer;
 109 }
 110
 111 SCM
 112 ly_quote_scm (SCM s)
 113 {
 114   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
 115 }
 116
 117
 118
 119 String
 120 ly_symbol2string (SCM s)
 121 {
 122   assert (gh_symbol_p (s));
 123   return String ((Byte*)SCM_STRING_CHARS (s), (int) SCM_STRING_LENGTH (s));
 124 }
 125
 126
 127 String
 128 gulp_file_to_string (String fn)
 129 {
 130   String s = global_path.find (fn);
 131   if (s == "")
 132     {
 133       String e = _f ("can't find file: `%s'", fn);
 134       e += " ";
 135       e += _f ("(load path: `%s')", global_path.str ());
 136       error (e);
 137     }
 138   else if (verbose_global_b)
 139     progress_indication ("[" + s);
 140
 141
 142   Simple_file_storage f (s);
 143   String result (f.ch_C ());
 144   if (verbose_global_b)
 145     progress_indication ("]");
 146   return result;
 147 }
 148
 149 SCM
 150 ly_gulp_file (SCM fn)
 151 {
 152   return ly_str02scm (gulp_file_to_string (ly_scm2string (fn)).ch_C ());
 153 }
 154
 155
 156 /**
 157    Read a file, and shove it down GUILE.  GUILE also has file read
 158    functions, but you can't fiddle with the path of those.
 159  */
 160 void
 161 read_lily_scm_file (String fn)
 162 {
 163   gh_eval_str ((char *) gulp_file_to_string (fn).ch_C ());
 164 }
 165
 166 extern "C" {
 167   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 168 void
 169 ly_display_scm (SCM s)
 170 {
 171   gh_display (s);
 172   gh_newline ();
 173 }
 174 };
 175
 176 String
 177 ly_scm2string (SCM s)
 178 {
 179   assert (gh_string_p (s));
 180
 181   size_t len;
 182   char *p = gh_scm2newstr (s , &len);
 183
 184   String r (p);
 185
 186   free (p);
 187   return r;
 188 }
 189
 190 SCM
 191 index_cell (SCM s, Direction d)
 192 {
 193   assert (d);
 194   return (d == LEFT) ? ly_car (s) : ly_cdr (s);
 195 }
 196
 197 SCM
 198 index_set_cell (SCM s, Direction d, SCM v)
 199 {
 200   if (d == LEFT)
 201     gh_set_car_x (s, v);
 202   else if (d == RIGHT)
 203     gh_set_cdr_x (s, v);
 204   return s;
 205 }
 206
 207 SCM
 208 ly_warning (SCM str)
 209 {
 210   assert (gh_string_p (str));
 211   warning ("lily-guile: " + ly_scm2string (str));
 212   return SCM_BOOL_T;
 213 }
 214
 215 SCM
 216 ly_isdir_p (SCM s)
 217 {
 218   if (gh_number_p (s))
 219     {
 220       int i = gh_scm2int (s);
 221       return (i>= -1 && i <= 1)  ? SCM_BOOL_T : SCM_BOOL_F;
 222     }
 223   return SCM_BOOL_F;
 224 }
 225
 226 bool
 227 ly_number_pair_p (SCM p)
 228 {
 229   return gh_pair_p (p) && gh_number_p (ly_car (p)) && gh_number_p (ly_cdr (p));
 230 }
 231
 232 bool
 233 ly_axis_p (SCM a)
 234 {
 235   return gh_number_p (a) && (gh_scm2int (a) == 0 || gh_scm2int (a) == 1);
 236 }
 237
 238 typedef void (*Void_fptr) ();
 239 Array<Void_fptr> *scm_init_funcs_;
 240
 241 void add_scm_init_func (void (*f) ())
 242 {
 243   if (!scm_init_funcs_)
 244     scm_init_funcs_ = new Array<Void_fptr>;
 245
 246   scm_init_funcs_->push (f);
 247 }
 248
 249 extern  void init_cxx_function_smobs ();
 250
 251 void
 252 prepend_load_path (String p )
 253 {
 254   char s[1024];
 255   sprintf (s,
 256            "(set! %%load-path (cons \"%s\" %%load-path))", p.ch_C());
 257
 258   scm_c_eval_string (s);
 259 }
 260
 261 void
 262 init_lily_guile (String p )
 263 {
 264   // very very ugh: LILYPONDPREFIX (a hack), if set, overrules DATADIR.
 265   // DATADIR (the default) should work too!
 266   prepend_load_path (DIR_DATADIR);
 267   prepend_load_path (DIR_DATADIR "/scm");
 268
 269   prepend_load_path (p);
 270
 271   // todo: junk this. We should make real modules iso. just loading files.
 272   prepend_load_path (p + "/scm/");
 273
 274   SCM last_mod = scm_current_module ();
 275   scm_set_current_module (scm_c_resolve_module ("guile"));
 276
 277   init_cxx_function_smobs ();
 278   for (int i=scm_init_funcs_->size () ; i--;)
 279     (scm_init_funcs_->elem (i)) ();
 280
 281   if (verbose_global_b)
 282     progress_indication ("\n");
 283   read_lily_scm_file ("lily.scm");
 284   scm_set_current_module (last_mod);
 285 }
 286
 287 unsigned int ly_scm_hash (SCM s)
 288 {
 289   return scm_ihashv (s, ~1u);
 290 }
 291
 292
 293
 294 bool
 295 isdir_b (SCM s)
 296 {
 297   if (gh_number_p (s))
 298     {
 299       int i = gh_scm2int (s);
 300       return i>= -1 && i <= 1;
 301     }
 302   return false;
 303 }
 304
 305
 306 bool
 307 isaxis_b (SCM s)
 308 {
 309   if (gh_number_p (s))
 310     {
 311       int i = gh_scm2int (s);
 312       return i== 0 || i == 1;
 313     }
 314   return false;
 315 }
 316
 317
 318 Direction
 319 to_dir (SCM s)
 320 {
 321   return (Direction) gh_scm2int (s);
 322 }
 323
 324 Interval
 325 ly_scm2interval (SCM p)
 326 {
 327   return  Interval (gh_scm2double (ly_car (p)),
 328                     gh_scm2double (ly_cdr (p)));
 329 }
 330
 331 SCM
 332 ly_interval2scm (Interval i)
 333 {
 334   return gh_cons (gh_double2scm (i[LEFT]),
 335                   gh_double2scm (i[RIGHT]));
 336 }
 337
 338
 339
 340
 341 bool
 342 to_boolean (SCM s)
 343 {
 344   return gh_boolean_p (s) && gh_scm2bool (s);
 345 }
 346
 347 /*
 348   Appendable list L: the cdr contains the list, the car the last cons
 349   in the list.
 350  */
 351 SCM
 352 appendable_list ()
 353 {
 354   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 355   gh_set_car_x (s, s);
 356
 357   return s;
 358 }
 359
 360 void
 361 appendable_list_append (SCM l, SCM elt)
 362 {
 363   SCM newcons = gh_cons (elt, SCM_EOL);
 364
 365   gh_set_cdr_x (ly_car (l), newcons);
 366   gh_set_car_x (l, newcons);
 367 }
 368
 369
 370 SCM
 371 ly_offset2scm (Offset o)
 372 {
 373   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 374 }
 375
 376 Offset
 377 ly_scm2offset (SCM s)
 378 {
 379   return Offset (gh_scm2double (ly_car (s)),
 380                  gh_scm2double (ly_cdr (s)));
 381 }
 382
 383 SCM
 384 ly_type (SCM exp)
 385 {
 386   char const  * cp = "unknown";
 387   if (gh_number_p (exp))
 388     {
 389       cp = "number";
 390     }
 391   else if (gh_string_p (exp))
 392     {
 393       cp = "string";
 394     }
 395   else if (gh_procedure_p (exp))
 396     {
 397       cp = "procedure";
 398     }
 399   else if (gh_boolean_p (exp))
 400     {
 401       cp = "boolean";
 402     }
 403   else if (gh_pair_p (exp))
 404     {
 405       cp = "list";
 406     }
 407
 408   return ly_str02scm (cp);
 409 }
 410
 411 /*
 412   convert without too many decimals, and leave  a space at the end.
 413  */
 414
 415
 416 SCM
 417 ly_number2string (SCM s)
 418 {
 419   assert (gh_number_p (s));
 420
 421   char str[400];                        // ugh.
 422
 423   if (scm_exact_p (s) == SCM_BOOL_F)
 424     {
 425       Real r (gh_scm2double (s));
 426
 427       if (isinf (r) || isnan (r))
 428         {
 429           programming_error ("Infinity or NaN encountered while converting Real number; setting to zero.");
 430           r = 0.0;
 431         }
 432
 433       sprintf (str, "%8.4f ", r);
 434     }
 435   else
 436     {
 437       sprintf (str, "%d ", gh_scm2int (s));
 438     }
 439
 440   return ly_str02scm (str);
 441 }
 442
 443 /*
 444   Undef this to see if GUILE GC is causing too many swaps.
 445  */
 446
 447 // #define TEST_GC
 448
 449 #ifdef TEST_GC
 450 #include <libguile/gc.h>
 451
 452 static void *
 453 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 454 {
 455    fprintf (stderr, "entering sweep\n");
 456 }
 457
 458 static void *
 459 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 460 {
 461    fprintf (stderr, "leaving sweep\n");
 462 }
 463 #endif
 464
 465
 466 #include "version.hh"
 467 SCM
 468 ly_version ()
 469 {
 470   char const* vs =  "\' (" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 471
 472   return gh_eval_str ((char*)vs);
 473 }
 474
 475 static void
 476 init_functions ()
 477 {
 478   scm_c_define_gsubr ("ly-warn", 1, 0, 0,
 479                       (Scheme_function_unknown)ly_warning);
 480   scm_c_define_gsubr ("ly-version", 0, 0, 0,
 481                       (Scheme_function_unknown)ly_version);
 482   scm_c_define_gsubr ("ly-gulp-file", 1,0, 0,
 483                       (Scheme_function_unknown)ly_gulp_file);
 484   scm_c_define_gsubr ("dir?", 1,0, 0, (Scheme_function_unknown)ly_isdir_p);
 485   scm_c_define_gsubr ("ly-number->string", 1, 0,0,
 486                       (Scheme_function_unknown) ly_number2string);
 487
 488
 489 #ifdef TEST_GC
 490   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 491   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 492 #endif
 493 }
 494
 495 ADD_SCM_INIT_FUNC (funcs, init_functions);
 496
 497 SCM
 498 ly_deep_copy (SCM l)
 499 {
 500   if (gh_pair_p (l))
 501     {
 502       return gh_cons (ly_deep_copy (ly_car (l)), ly_deep_copy (ly_cdr (l)));
 503     }
 504   else
 505     return l;
 506 }
 507
 508
 509
 510
 511 SCM
 512 ly_assoc_chain (SCM key, SCM achain)
 513 {
 514   if (gh_pair_p (achain))
 515     {
 516       SCM handle = scm_assoc (key, ly_car (achain));
 517       if (gh_pair_p (handle))
 518         return handle;
 519       else
 520         return ly_assoc_chain (key, ly_cdr (achain));
 521     }
 522   else
 523     return SCM_BOOL_F;
 524 }
 525
 526 /*
 527   LIST has the form "sym1 sym2 sym3"
 528  */
 529 SCM
 530 parse_symbol_list (const char * list)
 531 {
 532   char * s = strdup (list);
 533   char *orig = s;
 534   SCM create_list = SCM_EOL;
 535   if (!s[0] )
 536     s = 0;
 537
 538   while (s)
 539     {
 540       char *next = strchr (s, ' ');
 541       if (next)
 542         *next++ = 0;
 543
 544       create_list = gh_cons (ly_symbol2scm (s), create_list);
 545       s = next;
 546     }
 547
 548   free (orig);
 549   return create_list;
 550 }
 551
 552
 553 SCM
 554 ly_truncate_list (int k, SCM l )
 555 {
 556   if (k == 0)
 557     {
 558       l = SCM_EOL;
 559     }
 560   else
 561     {
 562       SCM s = l;
 563       k--;
 564       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 565         ;
 566
 567       if (gh_pair_p (s))
 568         {
 569           gh_set_cdr_x (s, SCM_EOL);
 570         }
 571     }
 572   return l;
 573 }
 574
 575 SCM my_gh_symbol2scm (const char* x)
 576 {
 577   return gh_symbol2scm ((char*)x);
 578 }