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--2003 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
  17
  18 #include "lily-proto.hh"
  19
  20 /* macosx fix:
  21
  22
  23  source-file.hh includes cmath which undefines isinf and isnan
  24 */
  25 inline int my_isinf(Real r) { return isinf(r); }
  26 inline int my_isnan(Real r) { return isnan(r); }
  27
  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", 1,0, 0,
 106           (SCM name),
 107           "Read the file named @var{name}, and return its contents in a string. The "
 108 " file is looked up using the lilypond 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   warning ("lily-guile: " + ly_scm2string (str));
 157   return SCM_BOOL_T;
 158 }
 159
 160 LY_DEFINE(ly_dir_p,  "ly:dir?", 1,0, 0,  (SCM s),
 161           "type predicate. A direction is a -1, 0 or 1, where -1 represents "
 162           "left or down and 1 represents right or up. ")
 163 {
 164   if (gh_number_p (s))
 165     {
 166       int i = gh_scm2int (s);
 167       return (i>= -1 && i <= 1)  ? SCM_BOOL_T : SCM_BOOL_F;
 168     }
 169   return SCM_BOOL_F;
 170 }
 171
 172 bool
 173 is_number_pair (SCM p)
 174 {
 175   return gh_pair_p (p) && gh_number_p (ly_car (p)) && gh_number_p (ly_cdr (p));
 176 }
 177
 178 typedef void (*Void_fptr) ();
 179 Array<Void_fptr> *scm_init_funcs_;
 180
 181 void add_scm_init_func (void (*f) ())
 182 {
 183   if (!scm_init_funcs_)
 184     scm_init_funcs_ = new Array<Void_fptr>;
 185
 186   scm_init_funcs_->push (f);
 187 }
 188
 189
 190 void
 191 ly_init_ly_module (void *data)
 192 {
 193   for (int i=scm_init_funcs_->size () ; i--;)
 194     (scm_init_funcs_->elem (i)) ();
 195
 196   if (verbose_global_b)
 197     progress_indication ("\n");
 198
 199   scm_primitive_load_path (scm_makfrom0str ("lily.scm"));
 200 }
 201
 202
 203 SCM lily_module ;
 204
 205 void
 206 ly_init_guile ()
 207 {
 208   lily_module = scm_c_define_module ("lily", ly_init_ly_module, 0);
 209   scm_c_use_module ("lily");
 210 }
 211
 212 unsigned int ly_scm_hash (SCM s)
 213 {
 214   return scm_ihashv (s, ~1u);
 215 }
 216
 217
 218
 219 bool
 220 is_direction (SCM s)
 221 {
 222   if (gh_number_p (s))
 223     {
 224       int i = gh_scm2int (s);
 225       return i>= -1 && i <= 1;
 226     }
 227   return false;
 228 }
 229
 230
 231 bool
 232 is_axis (SCM s)
 233 {
 234   if (gh_number_p (s))
 235     {
 236       int i = gh_scm2int (s);
 237       return i== 0 || i == 1;
 238     }
 239   return false;
 240 }
 241
 242
 243 Direction
 244 to_dir (SCM s)
 245 {
 246   return SCM_INUMP (s) ?  (Direction) gh_scm2int (s) : CENTER;
 247 }
 248
 249 Interval
 250 ly_scm2interval (SCM p)
 251 {
 252   return  Interval (gh_scm2double (ly_car (p)),
 253                     gh_scm2double (ly_cdr (p)));
 254 }
 255
 256 SCM
 257 ly_interval2scm (Drul_array<Real> i)
 258 {
 259   return gh_cons (gh_double2scm (i[LEFT]),
 260                   gh_double2scm (i[RIGHT]));
 261 }
 262
 263
 264
 265
 266 bool
 267 to_boolean (SCM s)
 268 {
 269   return gh_boolean_p (s) && gh_scm2bool (s);
 270 }
 271
 272 /*
 273   Appendable list L: the cdr contains the list, the car the last cons
 274   in the list.
 275  */
 276 SCM
 277 appendable_list ()
 278 {
 279   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 280   gh_set_car_x (s, s);
 281
 282   return s;
 283 }
 284
 285 void
 286 appendable_list_append (SCM l, SCM elt)
 287 {
 288   SCM newcons = gh_cons (elt, SCM_EOL);
 289
 290   gh_set_cdr_x (ly_car (l), newcons);
 291   gh_set_car_x (l, newcons);
 292 }
 293
 294
 295 SCM
 296 ly_offset2scm (Offset o)
 297 {
 298   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 299 }
 300
 301 Offset
 302 ly_scm2offset (SCM s)
 303 {
 304   return Offset (gh_scm2double (ly_car (s)),
 305                  gh_scm2double (ly_cdr (s)));
 306 }
 307
 308
 309 LY_DEFINE(ly_number2string,  "ly:number->string", 1, 0,0,
 310           (SCM s),
 311           " converts @var{num} to a string without generating many decimals. It "
 312 "leaves a space at the end.")
 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, "%8.4f ", r);
 329     }
 330   else
 331     {
 332       sprintf (str, "%d ", gh_scm2int (s));
 333     }
 334
 335   return scm_makfrom0str (str);
 336 }
 337
 338 /*
 339   Undef this to see if GUILE GC is causing too many swaps.
 340  */
 341
 342 //#define TEST_GC
 343
 344 #ifdef TEST_GC
 345 #include <libguile/gc.h>
 346
 347 static void *
 348 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 349 {
 350    fprintf (stderr, "entering sweep\n");
 351 }
 352
 353 static void *
 354 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 355 {
 356    fprintf (stderr, "leaving sweep\n");
 357 }
 358 #endif
 359
 360
 361 #include "version.hh"
 362 LY_DEFINE(ly_version,  "ly:version", 0, 0, 0, (),
 363           "Return the current lilypond version as a list, e.g. @code{(1 3 127 uu1)}. ")
 364 {
 365   char const* vs =  "\'(" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 366
 367   return gh_eval_str ((char*)vs);
 368 }
 369
 370 LY_DEFINE(ly_unit,  "ly:unit", 0, 0, 0, (),
 371           "Return the unit used for lengths as a string.")
 372 {
 373   return scm_makfrom0str (INTERNAL_UNIT);
 374 }
 375
 376
 377
 378 LY_DEFINE(ly_dimension_p,  "ly:dimension?", 1, 0, 0, (SCM d),
 379           "Return @var{d} is a number. Used to distinguish length "
 380           "variables from normal numbers.")
 381 {
 382   return scm_number_p (d);
 383 }
 384
 385 static void
 386 init_functions ()
 387 {
 388 #ifdef TEST_GC
 389   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 390   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 391 #endif
 392 }
 393
 394 ADD_SCM_INIT_FUNC (funcs, init_functions);
 395
 396 SCM
 397 ly_deep_copy (SCM src)
 398 {
 399   if (gh_pair_p (src))
 400     {
 401       return gh_cons (ly_deep_copy (ly_car (src)), ly_deep_copy (ly_cdr (src)));
 402     }
 403   else if (gh_vector_p (src))
 404     {
 405       int  l = SCM_VECTOR_LENGTH (src);
 406       SCM nv = scm_c_make_vector (l, SCM_UNDEFINED);
 407       for (int i  =0 ; i< l ; i++)
 408         {
 409           SCM si = gh_int2scm (i);
 410           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 411         }
 412     }
 413   else
 414     return src;
 415
 416   return src;
 417 }
 418
 419
 420
 421
 422 SCM
 423 ly_assoc_chain (SCM key, SCM achain)
 424 {
 425   if (gh_pair_p (achain))
 426     {
 427       SCM handle = scm_assoc (key, ly_car (achain));
 428       if (gh_pair_p (handle))
 429         return handle;
 430       else
 431         return ly_assoc_chain (key, ly_cdr (achain));
 432     }
 433   else
 434     return SCM_BOOL_F;
 435 }
 436
 437 /* looks the key up in the cdrs of the alist-keys
 438    - ignoring the car and ignoring non-pair keys.
 439    Returns first match found, i.e.
 440
 441    alist = ((1 . 10)
 442                    ((1 . 2) . 11)
 443                    ((2 . 1) . 12)
 444                    ((3 . 0) . 13)
 445                    ((4 . 1) . 14) )
 446
 447 I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 448 element with the cdr of the key = 1.  In other words (alloc_cdr key)
 449 corresponds to call
 450
 451 (alloc (anything . key))
 452
 453
 454
 455 */
 456 SCM
 457 ly_assoc_cdr (SCM key, SCM alist)
 458 {
 459   if (gh_pair_p (alist)) {
 460     SCM trykey = ly_caar(alist);
 461     if(gh_pair_p(trykey) && to_boolean(scm_equal_p(key,ly_cdr(trykey))))
 462       return ly_car(alist);
 463     else
 464       return ly_assoc_cdr (key, ly_cdr (alist));
 465   }
 466   else
 467     return SCM_BOOL_F;
 468 }
 469
 470 /*
 471   LIST has the form "sym1 sym2 sym3\nsym4\nsym5"
 472
 473   i.e. \n and ' ' can be used interchangeably as separators.
 474  */
 475 SCM
 476 parse_symbol_list (const char * list)
 477 {
 478   char * s = strdup (list);
 479   char *orig = s;
 480   SCM create_list = SCM_EOL;
 481
 482   for (char * p = s; *p; p++)
 483     {
 484       if (*p == '\n')
 485         *p = ' ' ;
 486     }
 487
 488   if (!s[0] )
 489     s = 0;
 490
 491
 492
 493   while (s)
 494     {
 495       char *next = strchr (s, ' ');
 496       if (next)
 497         *next++ = 0;
 498
 499       create_list = gh_cons (ly_symbol2scm (s), create_list);
 500       s = next;
 501     }
 502
 503   free (orig);
 504   return create_list;
 505 }
 506
 507
 508 SCM
 509 ly_truncate_list (int k, SCM l )
 510 {
 511   if (k == 0)
 512     {
 513       l = SCM_EOL;
 514     }
 515   else
 516     {
 517       SCM s = l;
 518       k--;
 519       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 520         ;
 521
 522       if (gh_pair_p (s))
 523         {
 524           gh_set_cdr_x (s, SCM_EOL);
 525         }
 526     }
 527   return l;
 528 }
 529
 530
 531 String
 532 print_scm_val (SCM val)
 533 {
 534   String realval = ly_scm2string (ly_write2scm (val));
 535   if (realval.length () > 200)
 536     realval = realval.left_string (100) + "\n :\n :\n" + realval.right_string (100);
 537
 538   return realval;
 539 }
 540
 541 bool
 542 type_check_assignment (SCM sym, SCM val,  SCM type_symbol)
 543 {
 544   bool ok = true;
 545
 546   /*
 547     Always succeeds.
 548
 549
 550     TODO: should remove #f from allowed vals?
 551    */
 552   if (val == SCM_EOL || val == SCM_BOOL_F)
 553     return ok;
 554
 555   if (!gh_symbol_p (sym))
 556 #if 0
 557     return false;
 558 #else
 559   /*
 560     This is used for autoBeamSettings.
 561
 562     TODO: deprecate the use of \override and \revert for
 563     autoBeamSettings?
 564    */
 565   return true;
 566 #endif
 567
 568   SCM type = scm_object_property (sym, type_symbol);
 569
 570   if (type != SCM_EOL && !gh_procedure_p (type))
 571       {
 572         warning (_f ("Can't find property type-check for `%s' (%s).",
 573                      ly_symbol2string (sym).to_str0 (),
 574                      ly_symbol2string (type_symbol).to_str0 ())
 575                  + "  " + _ ("Perhaps you made a typing error?"));
 576
 577         /* Be strict when being anal :) */
 578         if (internal_type_checking_global_b)
 579           abort ();
 580
 581         warning (_ ("Doing assignment anyway."));
 582       }
 583   else
 584     {
 585       if (val != SCM_EOL
 586           && gh_procedure_p (type)
 587           && gh_call1 (type, val) == SCM_BOOL_F)
 588         {
 589           SCM errport = scm_current_error_port ();
 590           ok = false;
 591           SCM typefunc = scm_primitive_eval (ly_symbol2scm ("type-name"));
 592           SCM type_name = gh_call1 (typefunc, type);
 593
 594
 595           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 596                         ly_symbol2string (sym).to_str0 (),
 597                         print_scm_val (val),
 598                         ly_scm2string (type_name).to_str0 ()).to_str0 (),
 599                     errport);
 600           scm_puts ("\n", errport);
 601         }
 602     }
 603   return ok;
 604 }
 605
 606
 607 /* some SCM abbrevs
 608
 609    zijn deze nou handig?
 610    zijn ze er al in scheme, maar heten ze anders? */
 611
 612
 613 /* Remove doubles from (sorted) list */
 614 SCM
 615 ly_unique (SCM list)
 616 {
 617   SCM unique = SCM_EOL;
 618   for (SCM i = list; gh_pair_p (i); i = ly_cdr (i))
 619     {
 620       if (!gh_pair_p (ly_cdr (i))
 621           || !gh_equal_p (ly_car (i), ly_cadr (i)))
 622         unique = gh_cons (ly_car (i), unique);
 623     }
 624   return scm_reverse_x (unique, SCM_EOL);
 625 }
 626
 627 /* tail add */
 628 SCM
 629 ly_snoc (SCM s, SCM list)
 630 {
 631   return gh_append2 (list, scm_list_n (s, SCM_UNDEFINED));
 632 }
 633
 634
 635 /* Split list at member s, removing s.
 636    Return (BEFORE . AFTER) */
 637 SCM
 638 ly_split_list (SCM s, SCM list)
 639 {
 640   SCM before = SCM_EOL;
 641   SCM after = list;
 642   for (; gh_pair_p (after);)
 643     {
 644       SCM i = ly_car (after);
 645       after = ly_cdr (after);
 646       if (gh_equal_p (i, s))
 647         break;
 648       before = gh_cons (i, before);
 649     }
 650   return gh_cons ( scm_reverse_x (before, SCM_EOL),  after);
 651
 652 }
 653
 654
 655 void
 656 taint (SCM *)
 657 {
 658   /*
 659     nop.
 660    */
 661 }
 662
 663 /*
 664   display stuff without using stack
 665  */
 666 SCM
 667 display_list (SCM s)
 668 {
 669   SCM p = scm_current_output_port();
 670
 671   scm_puts ("(", p);
 672   for (; gh_pair_p(s); s =gh_cdr(s))
 673     {
 674       scm_display (gh_car(s), p);
 675       scm_puts (" ", p);
 676     }
 677   scm_puts (")", p);
 678   return SCM_UNSPECIFIED;
 679 }
 680
 681 Slice
 682 int_list_to_slice (SCM l)
 683 {
 684   Slice s;
 685   s.set_empty ();
 686   for (; gh_pair_p (l); l = gh_cdr (l))
 687     {
 688       if (gh_number_p (gh_car (l)))
 689         s.add_point (gh_scm2int (gh_car (l)));
 690     }
 691
 692   return s;
 693 }
 694
 695
 696
 697
 698 /*
 699   Return I-th element, or last elt L. If I < 0, then we take the first
 700   element.
 701
 702   PRE: length (L) > 0
 703  */
 704 SCM
 705 robust_list_ref(int i, SCM l)
 706 {
 707   while (i-- > 0 && gh_pair_p (gh_cdr(l)))
 708     l = gh_cdr (l);
 709
 710   return gh_car(l);
 711 }
 712