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 void
 197 ly_init_ly_module (void *data)
 198 {
 199   for (int i=scm_init_funcs_->size () ; i--;)
 200     (scm_init_funcs_->elem (i)) ();
 201
 202   if (verbose_global_b)
 203     progress_indication ("\n");
 204   scm_primitive_load_path (scm_makfrom0str ("lily.scm"));
 205 }
 206
 207 SCM lily_module ;
 208
 209 void
 210 ly_init_guile ()
 211 {
 212   lily_module = scm_c_define_module ("lily", ly_init_ly_module, 0);
 213   scm_c_use_module ("lily");
 214 }
 215
 216 unsigned int ly_scm_hash (SCM s)
 217 {
 218   return scm_ihashv (s, ~1u);
 219 }
 220
 221
 222
 223 bool
 224 ly_dir_p (SCM s)
 225 {
 226   if (gh_number_p (s))
 227     {
 228       int i = gh_scm2int (s);
 229       return i>= -1 && i <= 1;
 230     }
 231   return false;
 232 }
 233
 234
 235 bool
 236 ly_axis_p (SCM s)
 237 {
 238   if (gh_number_p (s))
 239     {
 240       int i = gh_scm2int (s);
 241       return i== 0 || i == 1;
 242     }
 243   return false;
 244 }
 245
 246
 247 Direction
 248 to_dir (SCM s)
 249 {
 250   return SCM_INUMP (s) ?  (Direction) gh_scm2int (s) : CENTER;
 251 }
 252
 253 Interval
 254 ly_scm2interval (SCM p)
 255 {
 256   return  Interval (gh_scm2double (ly_car (p)),
 257                     gh_scm2double (ly_cdr (p)));
 258 }
 259
 260 SCM
 261 ly_interval2scm (Drul_array<Real> i)
 262 {
 263   return gh_cons (gh_double2scm (i[LEFT]),
 264                   gh_double2scm (i[RIGHT]));
 265 }
 266
 267
 268
 269
 270 bool
 271 to_boolean (SCM s)
 272 {
 273   return gh_boolean_p (s) && gh_scm2bool (s);
 274 }
 275
 276 /*
 277   Appendable list L: the cdr contains the list, the car the last cons
 278   in the list.
 279  */
 280 SCM
 281 appendable_list ()
 282 {
 283   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 284   gh_set_car_x (s, s);
 285
 286   return s;
 287 }
 288
 289 void
 290 appendable_list_append (SCM l, SCM elt)
 291 {
 292   SCM newcons = gh_cons (elt, SCM_EOL);
 293
 294   gh_set_cdr_x (ly_car (l), newcons);
 295   gh_set_car_x (l, newcons);
 296 }
 297
 298
 299 SCM
 300 ly_offset2scm (Offset o)
 301 {
 302   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 303 }
 304
 305 Offset
 306 ly_scm2offset (SCM s)
 307 {
 308   return Offset (gh_scm2double (ly_car (s)),
 309                  gh_scm2double (ly_cdr (s)));
 310 }
 311
 312
 313 LY_DEFINE(ly_number2string,  "ly-number->string", 1, 0,0,
 314           (SCM s),
 315           " converts @var{num} to a string without generating many decimals. It
 316 leaves a space at the end.
 317 ")
 318 {
 319   SCM_ASSERT_TYPE (gh_number_p (s), s, SCM_ARG1, __FUNCTION__, "number");
 320
 321   char str[400];                        // ugh.
 322
 323   if (scm_exact_p (s) == SCM_BOOL_F)
 324     {
 325       Real r (gh_scm2double (s));
 326
 327       if (my_isinf (r) || my_isnan (r))
 328         {
 329           programming_error ("Infinity or NaN encountered while converting Real number; setting to zero.");
 330           r = 0.0;
 331         }
 332
 333       sprintf (str, "%8.4f ", r);
 334     }
 335   else
 336     {
 337       sprintf (str, "%d ", gh_scm2int (s));
 338     }
 339
 340   return scm_makfrom0str (str);
 341 }
 342
 343 /*
 344   Undef this to see if GUILE GC is causing too many swaps.
 345  */
 346
 347 //#define TEST_GC
 348
 349 #ifdef TEST_GC
 350 #include <libguile/gc.h>
 351
 352 static void *
 353 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 354 {
 355    fprintf (stderr, "entering sweep\n");
 356 }
 357
 358 static void *
 359 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 360 {
 361    fprintf (stderr, "leaving sweep\n");
 362 }
 363 #endif
 364
 365
 366 #include "version.hh"
 367 LY_DEFINE(ly_version,  "ly-version", 0, 0, 0, (),
 368           "Return the current lilypond version as a list, e.g.
 369 @code{(1 3 127 uu1)}.
 370 ")
 371 {
 372   char const* vs =  "\' (" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 373
 374   return gh_eval_str ((char*)vs);
 375 }
 376
 377 LY_DEFINE(ly_unit,  "ly-unit", 0, 0, 0, (),
 378           "Return the unit used for lengths as a string.")
 379 {
 380   return scm_makfrom0str (INTERNAL_UNIT);
 381 }
 382
 383 LY_DEFINE(ly_verbose,  "ly-verbose", 0, 0, 0, (),
 384   "Return whether lilypond is being run in verbose mode.")
 385 {
 386   return gh_bool2scm (verbose_global_b);
 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
 560   SCM type = SCM_EOL;
 561
 562   if (gh_symbol_p (sym))
 563     type = scm_object_property (sym, type_symbol);
 564
 565   if (type != SCM_EOL && !gh_procedure_p (type))
 566       {
 567         warning (_f ("Can't find property type-check for `%s' (%s).",
 568                      ly_symbol2string (sym).to_str0 (),
 569                      ly_symbol2string (type_symbol).to_str0 ())
 570                  + "  " + _ ("Perhaps you made a typing error?"));
 571
 572         /* Be strict when being anal :) */
 573         if (internal_type_checking_global_b)
 574           abort ();
 575
 576         warning (_ ("Doing assignment anyway."));
 577       }
 578   else
 579     {
 580       if (val != SCM_EOL
 581           && gh_procedure_p (type)
 582           && gh_call1 (type, val) == SCM_BOOL_F)
 583         {
 584           SCM errport = scm_current_error_port ();
 585           ok = false;
 586           SCM typefunc = scm_primitive_eval (ly_symbol2scm ("type-name"));
 587           SCM type_name = gh_call1 (typefunc, type);
 588
 589
 590           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 591                         ly_symbol2string (sym).to_str0 (),
 592                         print_scm_val (val),
 593                         ly_scm2string (type_name).to_str0 ()).to_str0 (),
 594                     errport);
 595           scm_puts ("\n", errport);
 596         }
 597     }
 598   return ok;
 599 }
 600
 601
 602 /* some SCM abbrevs
 603
 604    zijn deze nou handig?
 605    zijn ze er al in scheme, maar heten ze anders? */
 606
 607
 608 /* Remove doubles from (sorted) list */
 609 SCM
 610 ly_unique (SCM list)
 611 {
 612   SCM unique = SCM_EOL;
 613   for (SCM i = list; gh_pair_p (i); i = ly_cdr (i))
 614     {
 615       if (!gh_pair_p (ly_cdr (i))
 616           || !gh_equal_p (ly_car (i), ly_cadr (i)))
 617         unique = gh_cons (ly_car (i), unique);
 618     }
 619   return scm_reverse_x (unique, SCM_EOL);
 620 }
 621
 622 /* tail add */
 623 SCM
 624 ly_snoc (SCM s, SCM list)
 625 {
 626   return gh_append2 (list, scm_list_n (s, SCM_UNDEFINED));
 627 }
 628
 629
 630 /* Split list at member s, removing s.
 631    Return (BEFORE . AFTER) */
 632 SCM
 633 ly_split_list (SCM s, SCM list)
 634 {
 635   SCM before = SCM_EOL;
 636   SCM after = list;
 637   for (; gh_pair_p (after);)
 638     {
 639       SCM i = ly_car (after);
 640       after = ly_cdr (after);
 641       if (gh_equal_p (i, s))
 642         break;
 643       before = gh_cons (i, before);
 644     }
 645   return gh_cons ( scm_reverse_x (before, SCM_EOL),  after);
 646
 647 }
 648
 649
 650 void
 651 taint (SCM *)
 652 {
 653   /*
 654     nop.
 655    */
 656 }
 657
 658 /*
 659   display stuff without using stack
 660  */
 661 SCM
 662 display_list (SCM s)
 663 {
 664   SCM p = scm_current_output_port();
 665
 666   scm_puts ("(", p);
 667   for (; gh_pair_p(s); s =gh_cdr(s))
 668     {
 669       scm_display (gh_car(s), p);
 670       scm_puts (" ", p);
 671     }
 672   scm_puts (")", p);
 673   return SCM_UNSPECIFIED;
 674 }
 675
 676 Slice
 677 int_list_to_slice (SCM l)
 678 {
 679   Slice s;
 680   s.set_empty ();
 681   for (; gh_pair_p (l); l = gh_cdr (l))
 682     {
 683       if (gh_number_p (gh_car (l)))
 684         s.add_point (gh_scm2int (gh_car (l)));
 685     }
 686
 687   return s;
 688 }
 689
 690
 691
 692
 693 /*
 694   Return I-th element, or last elt L. If I < 0, then we take the first
 695   element.
 696
 697   PRE: length (L) > 0
 698  */
 699 SCM
 700 robust_list_ref(int i, SCM l)
 701 {
 702   while (i-- > 0 && gh_pair_p (gh_cdr(l)))
 703     l = gh_cdr (l);
 704
 705   return gh_car(l);
 706 }
 707