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--2002 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 "warn.hh"
  22 #include "direction.hh"
  23 #include "offset.hh"
  24 #include "interval.hh"
  25 #include "pitch.hh"
  26 #include "dimensions.hh"
  27
  28
  29 // #define TEST_GC
  30
  31 #ifdef PARANOID
  32 #include <libguile/gc.h>
  33 #undef gh_pair_p
  34 bool
  35 ly_pair_p (SCM x)
  36 {
  37 #if 0
  38   assert (!SCM_CONSP (x) || (*(scm_t_bits*) SCM2PTR (SCM_CAR (x))) != scm_tc_free_cell);
  39   assert (!SCM_CONSP (x) || (*(scm_t_bits*) SCM2PTR (SCM_CDR (x))) != scm_tc_free_cell);
  40 #elif GUILE_MINOR_VERSION < 5
  41   assert (!SCM_CONSP (x) || !SCM_FREEP (SCM_CAR (x)));
  42   assert (!SCM_CONSP (x) || !SCM_FREEP (SCM_CDR (x)));
  43 #else
  44   assert (!SCM_CONSP (x) || !SCM_FREE_CELL_P (SCM_CAR (x)));
  45   assert (!SCM_CONSP (x) || !SCM_FREE_CELL_P (SCM_CDR (x)));
  46 #endif
  47   //return SCM_NFALSEP (scm_pair_p (x));
  48   return gh_pair_p (x);
  49 }
  50 #define gh_pair_p ly_pair_p
  51 #endif
  52
  53 SCM
  54 ly_last (SCM list)
  55 {
  56   return ly_car (scm_last_pair (list));
  57 }
  58
  59 SCM
  60 ly_str02scm (char const*c)
  61 {
  62   // this all really sucks, guile should take char const* arguments!
  63   return gh_str02scm ((char*)c);
  64 }
  65
  66
  67 SCM
  68 ly_write2scm (SCM s)
  69 {
  70   SCM port = scm_mkstrport (SCM_INUM0,
  71                             scm_make_string (SCM_INUM0, SCM_UNDEFINED),
  72                             SCM_OPN | SCM_WRTNG,
  73                             "ly_write2string");
  74   //  SCM write = scm_eval_3 (ly_symbol2scm ("write"), s, SCM_EOL);
  75   SCM write = scm_primitive_eval (ly_symbol2scm ("write"));
  76
  77   // scm_apply (write, port, SCM_EOL);
  78   gh_call2 (write, s, port);
  79   return scm_strport_to_string (port);
  80 }
  81
  82
  83 /*
  84   Pass string to scm parser, evaluate one expression.
  85   Return result value and #chars read.
  86
  87   Thanks to Gary Houston <ghouston@freewire.co.uk>
  88
  89   Need guile-1.3.4 (>1.3 anyway) for ftell on str ports -- jcn
  90 */
  91 SCM
  92 ly_parse_scm (char const* s, int* n)
  93 {
  94   SCM str = ly_str02scm (s);
  95   SCM port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_RDNG,
  96                             "ly_eval_scm_0str");
  97   SCM from = scm_ftell (port);
  98
  99   SCM form;
 100   SCM answer = SCM_UNSPECIFIED;
 101
 102   /* Read expression from port */
 103   if (!SCM_EOF_OBJECT_P (form = scm_read (port)))
 104     answer = scm_primitive_eval (form);
 105
 106   /*
 107    After parsing
 108
 109  (begin (foo 1 2))
 110
 111    all seems fine, but after parsing
 112
 113  (foo 1 2)
 114
 115    read_buf has been advanced to read_pos - 1,
 116    so that scm_ftell returns 1, instead of #parsed chars
 117    */
 118
 119   /*
 120     urg: reset read_buf for scm_ftell
 121     shouldn't scm_read () do this for us?
 122   */
 123   scm_fill_input (port);
 124   SCM to = scm_ftell (port);
 125   *n = gh_scm2int (to) - gh_scm2int (from);
 126
 127   /* Don't close the port here; if we re-enter this function via a
 128      continuation, then the next time we enter it, we'll get an error.
 129      It's a string port anyway, so there's no advantage to closing it
 130      early.
 131
 132      scm_close_port (port);
 133   */
 134
 135   return answer;
 136 }
 137
 138 SCM
 139 ly_quote_scm (SCM s)
 140 {
 141   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
 142 }
 143
 144
 145
 146 String
 147 ly_symbol2string (SCM s)
 148 {
 149   assert (gh_symbol_p (s));
 150   return String ((Byte*)SCM_STRING_CHARS (s), (int) SCM_STRING_LENGTH (s));
 151 }
 152
 153
 154 String
 155 gulp_file_to_string (String fn)
 156 {
 157   String s = global_path.find (fn);
 158   if (s == "")
 159     {
 160       String e = _f ("can't find file: `%s'", fn);
 161       e += " ";
 162       e += _f ("(load path: `%s')", global_path.str ());
 163       error (e);
 164     }
 165   else if (verbose_global_b)
 166     progress_indication ("[" + s);
 167
 168
 169   Simple_file_storage f (s);
 170   String result (f.ch_C ());
 171   if (verbose_global_b)
 172     progress_indication ("]");
 173   return result;
 174 }
 175
 176 LY_DEFINE(ly_gulp_file, "ly-gulp-file", 1,0, 0,
 177           (SCM name),
 178           "Read the file named @var{name}, and return its contents in a string. The
 179 file is looked up using the lilypond search path.
 180
 181 ")
 182 {
 183   return ly_str02scm (gulp_file_to_string (ly_scm2string (name)).ch_C ());
 184 }
 185
 186
 187 /**
 188    Read a file, and shove it down GUILE.  GUILE also has file read
 189    functions, but you can't fiddle with the path of those.
 190
 191
 192    TODO: JUNKME.
 193 */
 194 void
 195 read_lily_scm_file (String fn)
 196 {
 197   gh_eval_str ((char *) gulp_file_to_string (fn).ch_C ());
 198 }
 199
 200 extern "C" {
 201   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 202 void
 203 ly_display_scm (SCM s)
 204 {
 205   gh_display (s);
 206   gh_newline ();
 207 }
 208 };
 209
 210 String
 211 ly_scm2string (SCM s)
 212 {
 213   assert (gh_string_p (s));
 214
 215   char *p = SCM_STRING_CHARS(s);
 216   String r (p);
 217   return r;
 218 }
 219
 220 SCM
 221 index_get_cell (SCM s, Direction d)
 222 {
 223   assert (d);
 224   return (d == LEFT) ? ly_car (s) : ly_cdr (s);
 225 }
 226
 227 SCM
 228 index_set_cell (SCM s, Direction d, SCM v)
 229 {
 230   if (d == LEFT)
 231     gh_set_car_x (s, v);
 232   else if (d == RIGHT)
 233     gh_set_cdr_x (s, v);
 234   return s;
 235 }
 236
 237 LY_DEFINE(ly_warning,"ly-warn", 1, 0, 0,
 238   (SCM str),"Scheme callable function to issue the warning @code{msg}.
 239 ")
 240 {
 241   assert (gh_string_p (str));
 242   warning ("lily-guile: " + ly_scm2string (str));
 243   return SCM_BOOL_T;
 244 }
 245
 246 LY_DEFINE(ly_isdir_p,  "dir?", 1,0, 0,  (SCM s),
 247           "type predicate. A direction is a -1, 0 or 1, where -1 represents left or
 248 down and 1 represents right or up.
 249 ")
 250 {
 251   if (gh_number_p (s))
 252     {
 253       int i = gh_scm2int (s);
 254       return (i>= -1 && i <= 1)  ? SCM_BOOL_T : SCM_BOOL_F;
 255     }
 256   return SCM_BOOL_F;
 257 }
 258
 259 bool
 260 ly_number_pair_p (SCM p)
 261 {
 262   return gh_pair_p (p) && gh_number_p (ly_car (p)) && gh_number_p (ly_cdr (p));
 263 }
 264
 265 typedef void (*Void_fptr) ();
 266 Array<Void_fptr> *scm_init_funcs_;
 267
 268 void add_scm_init_func (void (*f) ())
 269 {
 270   if (!scm_init_funcs_)
 271     scm_init_funcs_ = new Array<Void_fptr>;
 272
 273   scm_init_funcs_->push (f);
 274 }
 275
 276 extern  void init_cxx_function_smobs ();
 277
 278 void
 279 prepend_load_path (String p )
 280 {
 281   char s[1024];
 282   sprintf (s,
 283            "(set! %%load-path (cons \"%s\" %%load-path))", p.ch_C());
 284
 285   scm_c_eval_string (s);
 286 }
 287
 288 void
 289 init_lily_guile (String p )
 290 {
 291   prepend_load_path (p);
 292
 293   // todo: junk this. We should make real modules iso. just loading files.
 294   prepend_load_path (p + "/scm/");
 295
 296   SCM last_mod = scm_current_module ();
 297   scm_set_current_module (scm_c_resolve_module ("guile"));
 298
 299   init_cxx_function_smobs ();
 300   for (int i=scm_init_funcs_->size () ; i--;)
 301     (scm_init_funcs_->elem (i)) ();
 302
 303   if (verbose_global_b)
 304     progress_indication ("\n");
 305   read_lily_scm_file ("lily.scm");
 306
 307   scm_set_current_module (last_mod);
 308 }
 309
 310 unsigned int ly_scm_hash (SCM s)
 311 {
 312   return scm_ihashv (s, ~1u);
 313 }
 314
 315
 316
 317 bool
 318 ly_dir_p (SCM s)
 319 {
 320   if (gh_number_p (s))
 321     {
 322       int i = gh_scm2int (s);
 323       return i>= -1 && i <= 1;
 324     }
 325   return false;
 326 }
 327
 328
 329 bool
 330 ly_axis_p (SCM s)
 331 {
 332   if (gh_number_p (s))
 333     {
 334       int i = gh_scm2int (s);
 335       return i== 0 || i == 1;
 336     }
 337   return false;
 338 }
 339
 340
 341 Direction
 342 to_dir (SCM s)
 343 {
 344   return (Direction) gh_scm2int (s);
 345 }
 346
 347 Interval
 348 ly_scm2interval (SCM p)
 349 {
 350   return  Interval (gh_scm2double (ly_car (p)),
 351                     gh_scm2double (ly_cdr (p)));
 352 }
 353
 354 SCM
 355 ly_interval2scm (Drul_array<Real> i)
 356 {
 357   return gh_cons (gh_double2scm (i[LEFT]),
 358                   gh_double2scm (i[RIGHT]));
 359 }
 360
 361
 362
 363
 364 bool
 365 to_boolean (SCM s)
 366 {
 367   return gh_boolean_p (s) && gh_scm2bool (s);
 368 }
 369
 370 /*
 371   Appendable list L: the cdr contains the list, the car the last cons
 372   in the list.
 373  */
 374 SCM
 375 appendable_list ()
 376 {
 377   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 378   gh_set_car_x (s, s);
 379
 380   return s;
 381 }
 382
 383 void
 384 appendable_list_append (SCM l, SCM elt)
 385 {
 386   SCM newcons = gh_cons (elt, SCM_EOL);
 387
 388   gh_set_cdr_x (ly_car (l), newcons);
 389   gh_set_car_x (l, newcons);
 390 }
 391
 392
 393 SCM
 394 ly_offset2scm (Offset o)
 395 {
 396   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 397 }
 398
 399 Offset
 400 ly_scm2offset (SCM s)
 401 {
 402   return Offset (gh_scm2double (ly_car (s)),
 403                  gh_scm2double (ly_cdr (s)));
 404 }
 405
 406 SCM
 407 ly_type (SCM exp)
 408 {
 409   char const  * cp = "unknown";
 410   if (gh_number_p (exp))
 411     {
 412       cp = "number";
 413     }
 414   else if (gh_string_p (exp))
 415     {
 416       cp = "string";
 417     }
 418   else if (gh_procedure_p (exp))
 419     {
 420       cp = "procedure";
 421     }
 422   else if (gh_boolean_p (exp))
 423     {
 424       cp = "boolean";
 425     }
 426   else if (gh_pair_p (exp))
 427     {
 428       cp = "list";
 429     }
 430
 431   return ly_str02scm (cp);
 432 }
 433
 434 /*
 435   convert without too many decimals, and leave  a space at the end.
 436  */
 437
 438
 439 LY_DEFINE(ly_number2string,  "ly-number->string", 1, 0,0,
 440           (SCM s),
 441           " converts @var{num} to a string without generating many decimals. It
 442 leaves a space at the end.
 443 ")
 444 {
 445   assert (gh_number_p (s));
 446
 447   char str[400];                        // ugh.
 448
 449   if (scm_exact_p (s) == SCM_BOOL_F)
 450     {
 451       Real r (gh_scm2double (s));
 452
 453       if (isinf (r) || isnan (r))
 454         {
 455           programming_error ("Infinity or NaN encountered while converting Real number; setting to zero.");
 456           r = 0.0;
 457         }
 458
 459       sprintf (str, "%8.4f ", r);
 460     }
 461   else
 462     {
 463       sprintf (str, "%d ", gh_scm2int (s));
 464     }
 465
 466   return ly_str02scm (str);
 467 }
 468
 469 /*
 470   Undef this to see if GUILE GC is causing too many swaps.
 471  */
 472
 473 // #define TEST_GC
 474
 475 #ifdef TEST_GC
 476 #include <libguile/gc.h>
 477
 478 static void *
 479 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 480 {
 481    fprintf (stderr, "entering sweep\n");
 482 }
 483
 484 static void *
 485 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 486 {
 487    fprintf (stderr, "leaving sweep\n");
 488 }
 489 #endif
 490
 491
 492 #include "version.hh"
 493 LY_DEFINE(ly_version,  "ly-version", 0, 0, 0, (),
 494           "Return the current lilypond version as a list, e.g.
 495 @code{(1 3 127 uu1)}.
 496 ")
 497 {
 498   char const* vs =  "\' (" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 499
 500   return gh_eval_str ((char*)vs);
 501 }
 502
 503 LY_DEFINE(ly_unit,  "ly-unit", 0, 0, 0, (),
 504           "Return the unit used for lengths as a string.")
 505 {
 506   return ly_str02scm (INTERNAL_UNIT);
 507 }
 508
 509 LY_DEFINE(ly_verbose,  "ly-verbose", 0, 0, 0, (),
 510   "Return whether lilypond is being run in verbose mode.")
 511 {
 512   return gh_bool2scm (verbose_global_b);
 513 }
 514
 515 static void
 516 init_functions ()
 517 {
 518 #ifdef TEST_GC
 519   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 520   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 521 #endif
 522 }
 523
 524 ADD_SCM_INIT_FUNC (funcs, init_functions);
 525
 526 SCM
 527 ly_deep_copy (SCM src)
 528 {
 529   if (gh_pair_p (src))
 530     {
 531       return gh_cons (ly_deep_copy (ly_car (src)), ly_deep_copy (ly_cdr (src)));
 532     }
 533   else if (gh_vector_p (src))
 534     {
 535       int  l = SCM_VECTOR_LENGTH (src);
 536       SCM nv = scm_c_make_vector (l, SCM_UNDEFINED);
 537       for (int i  =0 ; i< l ; i++)
 538         {
 539           SCM si = gh_int2scm (i);
 540           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 541         }
 542     }
 543   else
 544     return src;
 545
 546   return src;
 547 }
 548
 549
 550
 551
 552 SCM
 553 ly_assoc_chain (SCM key, SCM achain)
 554 {
 555   if (gh_pair_p (achain))
 556     {
 557       SCM handle = scm_assoc (key, ly_car (achain));
 558       if (gh_pair_p (handle))
 559         return handle;
 560       else
 561         return ly_assoc_chain (key, ly_cdr (achain));
 562     }
 563   else
 564     return SCM_BOOL_F;
 565 }
 566
 567 /* looks the key up in the cdrs of the alist-keys
 568    - ignoring the car and ignoring non-pair keys.
 569    Returns first match found, i.e.
 570
 571    alist = ((1 . 10)
 572                    ((1 . 2) . 11)
 573                    ((2 . 1) . 12)
 574                    ((3 . 0) . 13)
 575                    ((4 . 1) . 14) )
 576
 577 I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 578 element with the cdr of the key = 1.  In other words (alloc_cdr key)
 579 corresponds to call
 580
 581 (alloc (anything . key))
 582
 583
 584
 585 */
 586 SCM
 587 ly_assoc_cdr (SCM key, SCM alist)
 588 {
 589   if (gh_pair_p (alist)) {
 590     SCM trykey = ly_caar(alist);
 591     if(gh_pair_p(trykey) && to_boolean(scm_equal_p(key,ly_cdr(trykey))))
 592       return ly_car(alist);
 593     else
 594       return ly_assoc_cdr (key, ly_cdr (alist));
 595   }
 596   else
 597     return SCM_BOOL_F;
 598 }
 599
 600 /*
 601   LIST has the form "sym1 sym2 sym3\nsym4\nsym5"
 602
 603   i.e. \n and ' ' can be used interchangeably as separators.
 604  */
 605 SCM
 606 parse_symbol_list (const char * list)
 607 {
 608   char * s = strdup (list);
 609   char *orig = s;
 610   SCM create_list = SCM_EOL;
 611
 612   for (char * p = s; *p; p++)
 613     {
 614       if (*p == '\n')
 615         *p = ' ' ;
 616     }
 617
 618   if (!s[0] )
 619     s = 0;
 620
 621
 622
 623   while (s)
 624     {
 625       char *next = strchr (s, ' ');
 626       if (next)
 627         *next++ = 0;
 628
 629       create_list = gh_cons (ly_symbol2scm (s), create_list);
 630       s = next;
 631     }
 632
 633   free (orig);
 634   return create_list;
 635 }
 636
 637
 638 SCM
 639 ly_truncate_list (int k, SCM l )
 640 {
 641   if (k == 0)
 642     {
 643       l = SCM_EOL;
 644     }
 645   else
 646     {
 647       SCM s = l;
 648       k--;
 649       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 650         ;
 651
 652       if (gh_pair_p (s))
 653         {
 654           gh_set_cdr_x (s, SCM_EOL);
 655         }
 656     }
 657   return l;
 658 }
 659
 660 SCM my_gh_symbol2scm (const char* x)
 661 {
 662   return gh_symbol2scm ((char*)x);
 663 }
 664
 665 String
 666 print_scm_val (SCM val)
 667 {
 668   String realval = ly_scm2string (ly_write2scm (val));
 669   if (realval.length_i () > 200)
 670     realval = realval.left_str (100) + "\n :\n :\n" + realval.right_str (100);
 671
 672   return realval;
 673 }
 674
 675 bool
 676 type_check_assignment (SCM sym, SCM val,  SCM type_symbol)
 677 {
 678   bool ok = true;
 679
 680   /*
 681     Always succeeds.
 682
 683
 684     TODO: should remove #f from allowed vals?
 685    */
 686   if (val == SCM_EOL || val == SCM_BOOL_F)
 687     return ok;
 688
 689
 690   SCM type_p = SCM_EOL;
 691
 692   if (gh_symbol_p (sym))
 693     type_p = scm_object_property (sym, type_symbol);
 694
 695   if (type_p != SCM_EOL && !gh_procedure_p (type_p))
 696       {
 697         warning (_f ("Can't find property type-check for `%s' (%s).  Perhaps you made a typing error? Doing assignment anyway.",
 698                      ly_symbol2string (sym).ch_C (),
 699                      ly_symbol2string (type_symbol).ch_C ()
 700
 701                      ));
 702       }
 703   else
 704     {
 705       if (val != SCM_EOL
 706           && gh_procedure_p (type_p)
 707           && gh_call1 (type_p, val) == SCM_BOOL_F)
 708         {
 709           SCM errport = scm_current_error_port ();
 710           ok = false;
 711           SCM typefunc = scm_primitive_eval (ly_symbol2scm ("type-name"));
 712           SCM type_name = gh_call1 (typefunc, type_p);
 713
 714
 715           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 716                         ly_symbol2string (sym).ch_C (),
 717                         print_scm_val (val),
 718                         ly_scm2string (type_name).ch_C ()).ch_C (),
 719                     errport);
 720           scm_puts ("\n", errport);
 721         }
 722     }
 723   return ok;
 724 }
 725
 726
 727 /* some SCM abbrevs
 728
 729    zijn deze nou handig?
 730    zijn ze er al in scheme, maar heten ze anders? */
 731
 732
 733 /* Remove doubles from (sorted) list */
 734 SCM
 735 ly_unique (SCM list)
 736 {
 737   SCM unique = SCM_EOL;
 738   for (SCM i = list; gh_pair_p (i); i = ly_cdr (i))
 739     {
 740       if (!gh_pair_p (ly_cdr (i))
 741           || !gh_equal_p (ly_car (i), ly_cadr (i)))
 742         unique = gh_cons (ly_car (i), unique);
 743     }
 744   return scm_reverse_x (unique, SCM_EOL);
 745 }
 746
 747 /* tail add */
 748 SCM
 749 ly_snoc (SCM s, SCM list)
 750 {
 751   return gh_append2 (list, scm_list_n (s, SCM_UNDEFINED));
 752 }
 753
 754
 755 /* Split list at member s, removing s.
 756    Return (BEFORE . AFTER) */
 757 SCM
 758 ly_split_list (SCM s, SCM list)
 759 {
 760   SCM before = SCM_EOL;
 761   SCM after = list;
 762   for (; gh_pair_p (after);)
 763     {
 764       SCM i = ly_car (after);
 765       after = ly_cdr (after);
 766       if (gh_equal_p (i, s))
 767         break;
 768       before = gh_cons (i, before);
 769     }
 770   return gh_cons ( scm_reverse_x (before, SCM_EOL),  after);
 771
 772 }
 773
 774
 775 void
 776 taint (SCM * foo)
 777 {
 778   /*
 779     nop.
 780    */
 781 }
 782
 783 /*
 784   display stuff without using stack
 785  */
 786 SCM
 787 display_list (SCM s)
 788 {
 789   SCM p = scm_current_output_port();
 790
 791   scm_puts ("(", p);
 792   for (; gh_pair_p(s); s =gh_cdr(s))
 793     {
 794       scm_display (gh_car(s), p);
 795       scm_puts (" ", p);
 796     }
 797   scm_puts (")", p);
 798   return SCM_UNSPECIFIED;
 799 }