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