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_isdir,  "ly:dir?", 1,0, 0,  (SCM s),
 161           "type predicate. A direction is a -1, 0 or 1, where -1 represents left or "
 162 "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 ly_number_pair_p (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 ly_dir_p (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 ly_axis_p (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 LY_DEFINE(ly_verbose,  "ly:verbose", 0, 0, 0, (),
 377   "Return whether lilypond is being run in verbose mode.")
 378 {
 379   return gh_bool2scm (verbose_global_b);
 380 }
 381
 382 LY_DEFINE(ly_dimension_p,  "ly:dimension?", 1, 0, 0, (SCM d),
 383           "Return @var{d} is a number. Used to distinguish length "
 384           "variables from normal numbers.")
 385 {
 386   return scm_number_p (d);
 387 }
 388
 389 static void
 390 init_functions ()
 391 {
 392 #ifdef TEST_GC
 393   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 394   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 395 #endif
 396 }
 397
 398 ADD_SCM_INIT_FUNC (funcs, init_functions);
 399
 400 SCM
 401 ly_deep_copy (SCM src)
 402 {
 403   if (gh_pair_p (src))
 404     {
 405       return gh_cons (ly_deep_copy (ly_car (src)), ly_deep_copy (ly_cdr (src)));
 406     }
 407   else if (gh_vector_p (src))
 408     {
 409       int  l = SCM_VECTOR_LENGTH (src);
 410       SCM nv = scm_c_make_vector (l, SCM_UNDEFINED);
 411       for (int i  =0 ; i< l ; i++)
 412         {
 413           SCM si = gh_int2scm (i);
 414           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 415         }
 416     }
 417   else
 418     return src;
 419
 420   return src;
 421 }
 422
 423
 424
 425
 426 SCM
 427 ly_assoc_chain (SCM key, SCM achain)
 428 {
 429   if (gh_pair_p (achain))
 430     {
 431       SCM handle = scm_assoc (key, ly_car (achain));
 432       if (gh_pair_p (handle))
 433         return handle;
 434       else
 435         return ly_assoc_chain (key, ly_cdr (achain));
 436     }
 437   else
 438     return SCM_BOOL_F;
 439 }
 440
 441 /* looks the key up in the cdrs of the alist-keys
 442    - ignoring the car and ignoring non-pair keys.
 443    Returns first match found, i.e.
 444
 445    alist = ((1 . 10)
 446                    ((1 . 2) . 11)
 447                    ((2 . 1) . 12)
 448                    ((3 . 0) . 13)
 449                    ((4 . 1) . 14) )
 450
 451 I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 452 element with the cdr of the key = 1.  In other words (alloc_cdr key)
 453 corresponds to call
 454
 455 (alloc (anything . key))
 456
 457
 458
 459 */
 460 SCM
 461 ly_assoc_cdr (SCM key, SCM alist)
 462 {
 463   if (gh_pair_p (alist)) {
 464     SCM trykey = ly_caar(alist);
 465     if(gh_pair_p(trykey) && to_boolean(scm_equal_p(key,ly_cdr(trykey))))
 466       return ly_car(alist);
 467     else
 468       return ly_assoc_cdr (key, ly_cdr (alist));
 469   }
 470   else
 471     return SCM_BOOL_F;
 472 }
 473
 474 /*
 475   LIST has the form "sym1 sym2 sym3\nsym4\nsym5"
 476
 477   i.e. \n and ' ' can be used interchangeably as separators.
 478  */
 479 SCM
 480 parse_symbol_list (const char * list)
 481 {
 482   char * s = strdup (list);
 483   char *orig = s;
 484   SCM create_list = SCM_EOL;
 485
 486   for (char * p = s; *p; p++)
 487     {
 488       if (*p == '\n')
 489         *p = ' ' ;
 490     }
 491
 492   if (!s[0] )
 493     s = 0;
 494
 495
 496
 497   while (s)
 498     {
 499       char *next = strchr (s, ' ');
 500       if (next)
 501         *next++ = 0;
 502
 503       create_list = gh_cons (ly_symbol2scm (s), create_list);
 504       s = next;
 505     }
 506
 507   free (orig);
 508   return create_list;
 509 }
 510
 511
 512 SCM
 513 ly_truncate_list (int k, SCM l )
 514 {
 515   if (k == 0)
 516     {
 517       l = SCM_EOL;
 518     }
 519   else
 520     {
 521       SCM s = l;
 522       k--;
 523       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 524         ;
 525
 526       if (gh_pair_p (s))
 527         {
 528           gh_set_cdr_x (s, SCM_EOL);
 529         }
 530     }
 531   return l;
 532 }
 533
 534
 535 String
 536 print_scm_val (SCM val)
 537 {
 538   String realval = ly_scm2string (ly_write2scm (val));
 539   if (realval.length () > 200)
 540     realval = realval.left_string (100) + "\n :\n :\n" + realval.right_string (100);
 541
 542   return realval;
 543 }
 544
 545 bool
 546 type_check_assignment (SCM sym, SCM val,  SCM type_symbol)
 547 {
 548   bool ok = true;
 549
 550   /*
 551     Always succeeds.
 552
 553
 554     TODO: should remove #f from allowed vals?
 555    */
 556   if (val == SCM_EOL || val == SCM_BOOL_F)
 557     return ok;
 558
 559   if (!gh_symbol_p (sym))
 560 #if 0
 561     return false;
 562 #else
 563   /*
 564     This is used for autoBeamSettings.
 565
 566     TODO: deprecate the use of \override and \revert for
 567     autoBeamSettings?
 568    */
 569   return true;
 570 #endif
 571
 572   SCM type = scm_object_property (sym, type_symbol);
 573
 574   if (type != SCM_EOL && !gh_procedure_p (type))
 575       {
 576         warning (_f ("Can't find property type-check for `%s' (%s).",
 577                      ly_symbol2string (sym).to_str0 (),
 578                      ly_symbol2string (type_symbol).to_str0 ())
 579                  + "  " + _ ("Perhaps you made a typing error?"));
 580
 581         /* Be strict when being anal :) */
 582         if (internal_type_checking_global_b)
 583           abort ();
 584
 585         warning (_ ("Doing assignment anyway."));
 586       }
 587   else
 588     {
 589       if (val != SCM_EOL
 590           && gh_procedure_p (type)
 591           && gh_call1 (type, val) == SCM_BOOL_F)
 592         {
 593           SCM errport = scm_current_error_port ();
 594           ok = false;
 595           SCM typefunc = scm_primitive_eval (ly_symbol2scm ("type-name"));
 596           SCM type_name = gh_call1 (typefunc, type);
 597
 598
 599           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 600                         ly_symbol2string (sym).to_str0 (),
 601                         print_scm_val (val),
 602                         ly_scm2string (type_name).to_str0 ()).to_str0 (),
 603                     errport);
 604           scm_puts ("\n", errport);
 605         }
 606     }
 607   return ok;
 608 }
 609
 610
 611 /* some SCM abbrevs
 612
 613    zijn deze nou handig?
 614    zijn ze er al in scheme, maar heten ze anders? */
 615
 616
 617 /* Remove doubles from (sorted) list */
 618 SCM
 619 ly_unique (SCM list)
 620 {
 621   SCM unique = SCM_EOL;
 622   for (SCM i = list; gh_pair_p (i); i = ly_cdr (i))
 623     {
 624       if (!gh_pair_p (ly_cdr (i))
 625           || !gh_equal_p (ly_car (i), ly_cadr (i)))
 626         unique = gh_cons (ly_car (i), unique);
 627     }
 628   return scm_reverse_x (unique, SCM_EOL);
 629 }
 630
 631 /* tail add */
 632 SCM
 633 ly_snoc (SCM s, SCM list)
 634 {
 635   return gh_append2 (list, scm_list_n (s, SCM_UNDEFINED));
 636 }
 637
 638
 639 /* Split list at member s, removing s.
 640    Return (BEFORE . AFTER) */
 641 SCM
 642 ly_split_list (SCM s, SCM list)
 643 {
 644   SCM before = SCM_EOL;
 645   SCM after = list;
 646   for (; gh_pair_p (after);)
 647     {
 648       SCM i = ly_car (after);
 649       after = ly_cdr (after);
 650       if (gh_equal_p (i, s))
 651         break;
 652       before = gh_cons (i, before);
 653     }
 654   return gh_cons ( scm_reverse_x (before, SCM_EOL),  after);
 655
 656 }
 657
 658
 659 void
 660 taint (SCM *)
 661 {
 662   /*
 663     nop.
 664    */
 665 }
 666
 667 /*
 668   display stuff without using stack
 669  */
 670 SCM
 671 display_list (SCM s)
 672 {
 673   SCM p = scm_current_output_port();
 674
 675   scm_puts ("(", p);
 676   for (; gh_pair_p(s); s =gh_cdr(s))
 677     {
 678       scm_display (gh_car(s), p);
 679       scm_puts (" ", p);
 680     }
 681   scm_puts (")", p);
 682   return SCM_UNSPECIFIED;
 683 }
 684
 685 Slice
 686 int_list_to_slice (SCM l)
 687 {
 688   Slice s;
 689   s.set_empty ();
 690   for (; gh_pair_p (l); l = gh_cdr (l))
 691     {
 692       if (gh_number_p (gh_car (l)))
 693         s.add_point (gh_scm2int (gh_car (l)));
 694     }
 695
 696   return s;
 697 }
 698
 699
 700
 701
 702 /*
 703   Return I-th element, or last elt L. If I < 0, then we take the first
 704   element.
 705
 706   PRE: length (L) > 0
 707  */
 708 SCM
 709 robust_list_ref(int i, SCM l)
 710 {
 711   while (i-- > 0 && gh_pair_p (gh_cdr(l)))
 712     l = gh_cdr (l);
 713
 714   return gh_car(l);
 715 }
 716