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--2004 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 <ctype.h>
  17
  18 #include "lily-proto.hh"
  19 #include "version.hh"
  20
  21 /* MacOS S fix:
  22    source-file.hh includes cmath which undefines isinf and isnan
  23
  24    FIXME: #ifdef MACOS_X?
  25 */
  26 inline int my_isinf (Real r) { return isinf (r); }
  27 inline int my_isnan (Real r) { return isnan (r); }
  28
  29
  30 #include "libc-extension.hh"
  31 #include "lily-guile.hh"
  32 #include "main.hh"
  33 #include "file-path.hh"
  34 #include "warn.hh"
  35 #include "direction.hh"
  36 #include "offset.hh"
  37 #include "interval.hh"
  38 #include "pitch.hh"
  39 #include "dimensions.hh"
  40 #include "source-file.hh"
  41
  42 // #define TEST_GC
  43
  44 SCM
  45 ly_last (SCM list)
  46 {
  47   return ly_car (scm_last_pair (list));
  48 }
  49
  50
  51 SCM
  52 ly_write2scm (SCM s)
  53 {
  54   SCM port = scm_mkstrport (SCM_INUM0,
  55                             scm_make_string (SCM_INUM0, SCM_UNDEFINED),
  56                             SCM_OPN | SCM_WRTNG,
  57                             "ly_write2string");
  58   //  SCM write = scm_eval_3 (ly_symbol2scm ("write"), s, SCM_EOL);
  59   SCM write = scm_primitive_eval (ly_symbol2scm ("write"));
  60
  61   // scm_apply (write, port, SCM_EOL);
  62   gh_call2 (write, s, port);
  63   return scm_strport_to_string (port);
  64 }
  65
  66
  67 SCM
  68 ly_quote_scm (SCM s)
  69 {
  70   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
  71 }
  72
  73 String
  74 ly_symbol2string (SCM s)
  75 {
  76   assert (gh_symbol_p (s));
  77   return String ((Byte*)SCM_STRING_CHARS (s), (int) SCM_STRING_LENGTH (s));
  78 }
  79
  80 String
  81 gulp_file_to_string (String fn)
  82 {
  83   String s = global_path.find (fn);
  84   if (s == "")
  85     {
  86       String e = _f ("can't find file: `%s'", fn);
  87       e += " ";
  88       e += _f ("(load path: `%s')", global_path.to_string ());
  89       error (e);
  90     }
  91   else if (verbose_global_b)
  92     progress_indication ("[" + s);
  93
  94   int n;
  95   char * str = gulp_file (s, &n);
  96   String result (str);
  97   delete[] str;
  98
  99   if (verbose_global_b)
 100     progress_indication ("]");
 101
 102   return result;
 103 }
 104
 105 LY_DEFINE (ly_gulp_file, "ly:gulp-file",
 106            1, 0, 0, (SCM name),
 107            "Read the file @var{name}, and return its contents in a string.  "
 108            "The file is looked up using the search path.")
 109 {
 110   return scm_makfrom0str (gulp_file_to_string (ly_scm2string (name)).to_str0 ());
 111 }
 112
 113
 114 extern "C" {
 115   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 116 void
 117 ly_display_scm (SCM s)
 118 {
 119   gh_display (s);
 120   gh_newline ();
 121 }
 122 };
 123
 124 String
 125 ly_scm2string (SCM s)
 126 {
 127   assert (gh_string_p (s));
 128
 129   char *p = SCM_STRING_CHARS (s);
 130   String r (p);
 131   return r;
 132 }
 133
 134 SCM
 135 index_get_cell (SCM s, Direction d)
 136 {
 137
 138   assert (d);
 139   return (d == LEFT) ? ly_car (s) : ly_cdr (s);
 140 }
 141
 142 SCM
 143 index_set_cell (SCM s, Direction d, SCM v)
 144 {
 145   if (d == LEFT)
 146     gh_set_car_x (s, v);
 147   else if (d == RIGHT)
 148     gh_set_cdr_x (s, v);
 149   return s;
 150 }
 151
 152 LY_DEFINE (ly_warning,"ly:warn", 1, 0, 0,
 153   (SCM str), "Scheme callable function to issue the warning @code{msg}.")
 154 {
 155   SCM_ASSERT_TYPE (gh_string_p (str), str, SCM_ARG1, __FUNCTION__, "string");
 156   progress_indication ("\n");
 157   warning ("lily-guile: " + ly_scm2string (str));
 158   return SCM_BOOL_T;
 159 }
 160
 161 LY_DEFINE (ly_dir_p,  "ly:dir?", 1,0, 0,  (SCM s),
 162           "type predicate. A direction is @code{-1}, @code{0} or "
 163            "@code{1}, where @code{-1} represents "
 164           "left or down and @code{1} represents right or up.")
 165 {
 166   if (gh_number_p (s))
 167     {
 168       int i = gh_scm2int (s);
 169       return (i>= -1 && i <= 1)  ? SCM_BOOL_T : SCM_BOOL_F;
 170     }
 171   return SCM_BOOL_F;
 172 }
 173
 174 bool
 175 is_number_pair (SCM p)
 176 {
 177   return gh_pair_p (p) && gh_number_p (ly_car (p)) && gh_number_p (ly_cdr (p));
 178 }
 179
 180 typedef void (*Void_fptr) ();
 181 Array<Void_fptr> *scm_init_funcs_;
 182
 183 void add_scm_init_func (void (*f) ())
 184 {
 185   if (!scm_init_funcs_)
 186     scm_init_funcs_ = new Array<Void_fptr>;
 187
 188   scm_init_funcs_->push (f);
 189 }
 190
 191
 192 void
 193 ly_init_ly_module (void *)
 194 {
 195   for (int i=scm_init_funcs_->size () ; i--;)
 196     (scm_init_funcs_->elem (i)) ();
 197
 198   if (verbose_global_b)
 199     progress_indication ("\n");
 200
 201   scm_primitive_load_path (scm_makfrom0str ("lily.scm"));
 202 }
 203
 204
 205 SCM global_lily_module;
 206
 207 void
 208 ly_init_guile ()
 209 {
 210   global_lily_module = scm_c_define_module ("lily", ly_init_ly_module, 0);
 211   scm_c_use_module ("lily");
 212 }
 213
 214 unsigned int ly_scm_hash (SCM s)
 215 {
 216   return scm_ihashv (s, ~1u);
 217 }
 218
 219
 220
 221 bool
 222 is_direction (SCM s)
 223 {
 224   if (gh_number_p (s))
 225     {
 226       int i = gh_scm2int (s);
 227       return i>= -1 && i <= 1;
 228     }
 229   return false;
 230 }
 231
 232
 233 bool
 234 is_axis (SCM s)
 235 {
 236   if (gh_number_p (s))
 237     {
 238       int i = gh_scm2int (s);
 239       return i== 0 || i == 1;
 240     }
 241   return false;
 242 }
 243
 244 Direction
 245 to_dir (SCM s)
 246 {
 247   return SCM_INUMP (s) ? (Direction) gh_scm2int (s) : CENTER;
 248 }
 249
 250 Interval
 251 ly_scm2interval (SCM p)
 252 {
 253   return Interval (gh_scm2double (ly_car (p)), gh_scm2double (ly_cdr (p)));
 254 }
 255
 256 Drul_array<Real>
 257 ly_scm2realdrul (SCM p)
 258 {
 259   return Drul_array<Real> (gh_scm2double (ly_car (p)),
 260                            gh_scm2double (ly_cdr (p)));
 261 }
 262
 263 SCM
 264 ly_interval2scm (Drul_array<Real> i)
 265 {
 266   return gh_cons (gh_double2scm (i[LEFT]), gh_double2scm (i[RIGHT]));
 267 }
 268
 269 bool
 270 to_boolean (SCM s)
 271 {
 272   return gh_boolean_p (s) && gh_scm2bool (s);
 273 }
 274
 275 /* Appendable list L: the cdr contains the list, the car the last cons
 276    in the list.  */
 277 SCM
 278 appendable_list ()
 279 {
 280   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 281   gh_set_car_x (s, s);
 282
 283   return s;
 284 }
 285
 286 void
 287 appendable_list_append (SCM l, SCM elt)
 288 {
 289   SCM newcons = gh_cons (elt, SCM_EOL);
 290
 291   gh_set_cdr_x (ly_car (l), newcons);
 292   gh_set_car_x (l, newcons);
 293 }
 294
 295
 296 SCM
 297 ly_offset2scm (Offset o)
 298 {
 299   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 300 }
 301
 302 Offset
 303 ly_scm2offset (SCM s)
 304 {
 305   return Offset (gh_scm2double (ly_car (s)),
 306                  gh_scm2double (ly_cdr (s)));
 307 }
 308
 309
 310 LY_DEFINE (ly_number2string, "ly:number->string",
 311            1, 0, 0, (SCM s),
 312            "Convert @var{num} to a string without generating many decimals.")
 313 {
 314   SCM_ASSERT_TYPE (gh_number_p (s), s, SCM_ARG1, __FUNCTION__, "number");
 315
 316   char str[400];                        // ugh.
 317
 318   if (scm_exact_p (s) == SCM_BOOL_F)
 319     {
 320       Real r (gh_scm2double (s));
 321
 322       if (my_isinf (r) || my_isnan (r))
 323         {
 324           programming_error ("Infinity or NaN encountered while converting Real number; setting to zero.");
 325           r = 0.0;
 326         }
 327
 328       sprintf (str, "%08.4f", r);
 329     }
 330   else
 331     sprintf (str, "%d", gh_scm2int (s));
 332
 333   return scm_makfrom0str (str);
 334 }
 335
 336 /*
 337   Undef this to see if GUILE GC is causing too many swaps.
 338  */
 339
 340 //#define TEST_GC
 341
 342 #ifdef TEST_GC
 343 #include <libguile/gc.h>
 344
 345 static void *
 346 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 347 {
 348   fprintf (stderr, "entering sweep\n");
 349 }
 350
 351 static void *
 352 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 353 {
 354   fprintf (stderr, "leaving sweep\n");
 355 }
 356 #endif
 357
 358
 359 LY_DEFINE (ly_version,  "ly:version", 0, 0, 0, (),
 360           "Return the current lilypond version as a list, e.g. @code{(1 3 127 uu1)}. ")
 361 {
 362   char const* vs = "\'(" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 363
 364   return gh_eval_str ((char*)vs);
 365 }
 366
 367 LY_DEFINE (ly_unit,  "ly:unit", 0, 0, 0, (),
 368           "Return the unit used for lengths as a string.")
 369 {
 370   return scm_makfrom0str (INTERNAL_UNIT);
 371 }
 372
 373
 374
 375 LY_DEFINE (ly_dimension_p,  "ly:dimension?", 1, 0, 0, (SCM d),
 376           "Return @var{d} is a number. Used to distinguish length "
 377           "variables from normal numbers.")
 378 {
 379   return scm_number_p (d);
 380 }
 381
 382 static void
 383 init_functions ()
 384 {
 385 #ifdef TEST_GC
 386   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 387   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 388 #endif
 389 }
 390
 391 ADD_SCM_INIT_FUNC (funcs, init_functions);
 392
 393 SCM
 394 ly_deep_copy (SCM src)
 395 {
 396   if (gh_pair_p (src))
 397     return gh_cons (ly_deep_copy (ly_car (src)), ly_deep_copy (ly_cdr (src)));
 398   else if (gh_vector_p (src))
 399     {
 400       int len = SCM_VECTOR_LENGTH (src);
 401       SCM nv = scm_c_make_vector (len, SCM_UNDEFINED);
 402       for (int i  =0 ; i < len ; i++)
 403         {
 404           SCM si = gh_int2scm (i);
 405           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 406         }
 407     }
 408   return src;
 409 }
 410
 411
 412
 413
 414 SCM
 415 ly_assoc_chain (SCM key, SCM achain)
 416 {
 417   if (gh_pair_p (achain))
 418     {
 419       SCM handle = scm_assoc (key, ly_car (achain));
 420       if (gh_pair_p (handle))
 421         return handle;
 422       else
 423         return ly_assoc_chain (key, ly_cdr (achain));
 424     }
 425   else
 426     return SCM_BOOL_F;
 427 }
 428
 429 /* looks the key up in the cdrs of the alist-keys
 430    - ignoring the car and ignoring non-pair keys.
 431    Returns first match found, i.e.
 432
 433    alist = ((1 . 10)
 434                    ((1 . 2) . 11)
 435                    ((2 . 1) . 12)
 436                    ((3 . 0) . 13)
 437                    ((4 . 1) . 14) )
 438
 439 I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 440 element with the cdr of the key = 1.  In other words (alloc_cdr key)
 441 corresponds to call
 442
 443 (alloc (anything . key))
 444
 445
 446
 447 */
 448 SCM
 449 ly_assoc_cdr (SCM key, SCM alist)
 450 {
 451   if (gh_pair_p (alist))
 452   {
 453     SCM trykey = ly_caar (alist);
 454     if (gh_pair_p (trykey) && to_boolean (scm_equal_p (key, ly_cdr (trykey))))
 455     return ly_car (alist);
 456     else
 457     return ly_assoc_cdr (key, ly_cdr (alist));
 458   }
 459   return SCM_BOOL_F;
 460 }
 461
 462 /* LST has the form "sym1 sym2 sym3\nsym4\nsym5"
 463    i.e. \n and ' ' can be used interchangeably as separators.  */
 464 SCM
 465 parse_symbol_list (char const *lst)
 466 {
 467   char *s = strdup (lst);
 468   char *orig = s;
 469   SCM create_list = SCM_EOL;
 470
 471   char * e = s + strlen (s) - 1;
 472   while (e >= s && isspace (*e))
 473     *e-- = 0;
 474
 475   for (char * p = s; *p; p++)
 476     if (*p == '\n')
 477       *p = ' ';
 478
 479   if (!s[0])
 480     s = 0;
 481
 482   while (s)
 483     {
 484       char *next = strchr (s, ' ');
 485       if (next)
 486         *next++ = 0;
 487
 488       create_list = gh_cons (ly_symbol2scm (s), create_list);
 489       s = next;
 490     }
 491
 492   free (orig);
 493   return create_list;
 494 }
 495
 496 SCM
 497 ly_truncate_list (int k, SCM lst)
 498 {
 499   if (k == 0)
 500     lst = SCM_EOL;
 501   else
 502     {
 503       SCM s = lst;
 504       k--;
 505       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 506         ;
 507
 508       if (gh_pair_p (s))
 509         gh_set_cdr_x (s, SCM_EOL);
 510     }
 511   return lst;
 512 }
 513
 514 String
 515 print_scm_val (SCM val)
 516 {
 517   String realval = ly_scm2string (ly_write2scm (val));
 518   if (realval.length () > 200)
 519     realval = realval.left_string (100)
 520       + "\n :\n :\n"
 521       + realval.right_string (100);
 522   return realval;
 523 }
 524
 525 bool
 526 type_check_assignment (SCM sym, SCM val,  SCM type_symbol)
 527 {
 528   bool ok = true;
 529
 530   /*
 531     Always succeeds.
 532
 533
 534     TODO: should remove #f from allowed vals?
 535    */
 536   if (val == SCM_EOL || val == SCM_BOOL_F)
 537     return ok;
 538
 539   if (!gh_symbol_p (sym))
 540 #if 0
 541     return false;
 542 #else
 543   /*
 544     This is used for autoBeamSettings.
 545
 546     TODO: deprecate the use of \override and \revert for
 547     autoBeamSettings?
 548
 549     or use a symbol autoBeamSettingS?
 550    */
 551   return true;
 552 #endif
 553
 554   SCM type = scm_object_property (sym, type_symbol);
 555
 556   if (type != SCM_EOL && !gh_procedure_p (type))
 557       {
 558         warning (_f ("Can't find property type-check for `%s' (%s).",
 559                      ly_symbol2string (sym).to_str0 (),
 560                      ly_symbol2string (type_symbol).to_str0 ())
 561                  + "  " + _ ("Perhaps you made a typing error?"));
 562
 563         /* Be strict when being anal :) */
 564         if (internal_type_checking_global_b)
 565           abort ();
 566
 567         warning (_ ("Doing assignment anyway."));
 568       }
 569   else
 570     {
 571       if (val != SCM_EOL
 572           && gh_procedure_p (type)
 573           && gh_call1 (type, val) == SCM_BOOL_F)
 574         {
 575           SCM errport = scm_current_error_port ();
 576           ok = false;
 577           SCM typefunc = ly_scheme_function ("type-name");
 578           SCM type_name = gh_call1 (typefunc, type);
 579
 580
 581           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 582                         ly_symbol2string (sym).to_str0 (),
 583                         print_scm_val (val),
 584                         ly_scm2string (type_name).to_str0 ()).to_str0 (),
 585                     errport);
 586           scm_puts ("\n", errport);
 587         }
 588     }
 589   return ok;
 590 }
 591
 592
 593 /* some SCM abbrevs
 594
 595    zijn deze nou handig?
 596    zijn ze er al in scheme, maar heten ze anders? */
 597
 598
 599 /* Remove doubles from (sorted) list */
 600 SCM
 601 ly_unique (SCM list)
 602 {
 603   SCM unique = SCM_EOL;
 604   for (SCM i = list; gh_pair_p (i); i = ly_cdr (i))
 605     {
 606       if (!gh_pair_p (ly_cdr (i))
 607           || !gh_equal_p (ly_car (i), ly_cadr (i)))
 608         unique = gh_cons (ly_car (i), unique);
 609     }
 610   return scm_reverse_x (unique, SCM_EOL);
 611 }
 612
 613 /* tail add */
 614 SCM
 615 ly_snoc (SCM s, SCM list)
 616 {
 617   return gh_append2 (list, scm_list_n (s, SCM_UNDEFINED));
 618 }
 619
 620 /* Split list at member s, removing s.
 621    Return (BEFORE . AFTER)  */
 622 SCM
 623 ly_split_list (SCM s, SCM list)
 624 {
 625   SCM before = SCM_EOL;
 626   SCM after = list;
 627   for (; gh_pair_p (after);)
 628     {
 629       SCM i = ly_car (after);
 630       after = ly_cdr (after);
 631       if (gh_equal_p (i, s))
 632         break;
 633       before = gh_cons (i, before);
 634     }
 635   return gh_cons ( scm_reverse_x (before, SCM_EOL),  after);
 636
 637 }
 638
 639
 640 void
 641 taint (SCM *)
 642 {
 643   /*
 644     nop.
 645    */
 646 }
 647
 648 /*
 649   display stuff without using stack
 650  */
 651 SCM
 652 display_list (SCM s)
 653 {
 654   SCM p = scm_current_output_port ();
 655
 656   scm_puts ("(", p);
 657   for (; gh_pair_p (s); s =gh_cdr (s))
 658     {
 659       scm_display (gh_car (s), p);
 660       scm_puts (" ", p);
 661     }
 662   scm_puts (")", p);
 663   return SCM_UNSPECIFIED;
 664 }
 665
 666 Slice
 667 int_list_to_slice (SCM l)
 668 {
 669   Slice s;
 670   s.set_empty ();
 671   for (; gh_pair_p (l); l = gh_cdr (l))
 672     if (gh_number_p (gh_car (l)))
 673       s.add_point (gh_scm2int (gh_car (l)));
 674   return s;
 675 }
 676
 677 /* Return I-th element, or last elt L. If I < 0, then we take the first
 678    element.
 679
 680    PRE: length (L) > 0  */
 681 SCM
 682 robust_list_ref (int i, SCM l)
 683 {
 684   while (i-- > 0 && gh_pair_p (gh_cdr (l)))
 685     l = gh_cdr (l);
 686   return gh_car (l);
 687 }
 688
 689 Real
 690 robust_scm2double (SCM k, double x)
 691 {
 692   if (gh_number_p (k))
 693     x = gh_scm2double (k);
 694   return x;
 695 }
 696
 697 Interval
 698 robust_scm2interval (SCM k, Drul_array<Real> v)
 699 {
 700   Interval i;
 701   i[LEFT]= v[LEFT];
 702   i[RIGHT]= v[RIGHT];
 703   if (is_number_pair (k))
 704     i = ly_scm2interval (k);
 705   return i;
 706 }
 707
 708 Drul_array<Real>
 709 robust_scm2drul (SCM k, Drul_array<Real> v)
 710 {
 711   if (is_number_pair (k))
 712     v = ly_scm2interval (k);
 713   return v;
 714 }
 715
 716 Offset
 717 robust_scm2offset (SCM k, Offset o)
 718 {
 719   if (is_number_pair (k))
 720     o = ly_scm2offset (k);
 721   return o;
 722 }
 723
 724 int
 725 robust_scm2int (SCM k, int o)
 726 {
 727   if (scm_integer_p (k) == SCM_BOOL_T)
 728     o = gh_scm2int (k);
 729   return o;
 730 }
 731
 732 SCM
 733 alist_to_hashq (SCM alist)
 734 {
 735   int i = scm_ilength (alist);
 736   if (i < 0)
 737     return scm_make_vector (gh_int2scm (0), SCM_EOL);
 738
 739   SCM tab = scm_make_vector (gh_int2scm (i), SCM_EOL);
 740   for (SCM s = alist; gh_pair_p (s); s = ly_cdr (s))
 741     {
 742       SCM pt = ly_cdar (s);
 743       scm_hashq_set_x (tab, ly_caar (s), pt);
 744     }
 745   return tab;
 746 }
 747
 748 #if 1
 749 /*
 750   Debugging mem leaks:
 751  */
 752 LY_DEFINE (ly_protects, "ly:protects", 0, 0, 0, (),
 753           "Return hash of protected objects.")
 754 {
 755   return scm_protects;
 756 }
 757 #endif