lily/lily-guile.cc

   1 /*
   2   lily-guile.cc -- implement assorted SCM interface functions
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>
   8 */
   9
  10 #include "lily-guile.hh"
  11
  12 #include <cstdio>
  13 #include <cstdlib>
  14 #include <cstring> /* strdup, strchr */
  15 #include <cctype>
  16
  17 using namespace std;
  18
  19 #include "dimensions.hh"
  20 #include "direction.hh"
  21 #include "file-path.hh"
  22 #include "international.hh"
  23 #include "libc-extension.hh"
  24 #include "main.hh"
  25 #include "misc.hh"
  26 #include "offset.hh"
  27 #include "pitch.hh"
  28 #include "string-convert.hh"
  29 #include "source-file.hh"
  30 #include "version.hh"
  31 #include "warn.hh"
  32
  33
  34 /*
  35   symbols/strings.
  36  */
  37 SCM
  38 ly_to_symbol (SCM scm)
  39 {
  40   return scm_string_to_symbol (ly_to_string (scm));
  41 }
  42
  43 SCM
  44 ly_to_string (SCM scm)
  45 {
  46   return scm_call_3 (ly_lily_module_constant ("format"), SCM_BOOL_F,
  47
  48                      scm_makfrom0str ("~S"), scm);
  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   scm_call_2 (write, s, port);
  63   return scm_strport_to_string (port);
  64 }
  65
  66 SCM
  67 ly_quote_scm (SCM s)
  68 {
  69   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
  70 }
  71
  72 string
  73 ly_symbol2string (SCM s)
  74 {
  75   /*
  76     Ugh. this is not very efficient.
  77   */
  78   SCM str = scm_symbol_to_string (s);
  79   return ly_scm2string (str);
  80 }
  81
  82 string
  83 gulp_file_to_string (string fn, bool must_exist, int size)
  84 {
  85   string s = global_path.find (fn);
  86   if (s == "")
  87     {
  88       if (must_exist)
  89         {
  90           string e = _f ("cannot find file: `%s'", fn);
  91           e += " ";
  92           e += _f ("(load path: `%s')", global_path.to_string ());
  93           error (e);
  94           /* unreachable */
  95         }
  96       return s;
  97     }
  98
  99   if (be_verbose_global)
 100     progress_indication ("[" + s);
 101
 102   vector<char> chars = gulp_file (s, size);
 103   string result (&chars[0], chars.size ());
 104
 105   if (be_verbose_global)
 106     progress_indication ("]");
 107
 108   return result;
 109 }
 110
 111 extern "C" {
 112   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 113   void
 114   ly_display_scm (SCM s)
 115   {
 116     scm_display (s, scm_current_output_port ());
 117     scm_newline (scm_current_output_port ());
 118   }
 119 };
 120
 121 /*
 122   STRINGS
 123  */
 124 string
 125 ly_scm2string (SCM str)
 126 {
 127   assert (scm_is_string (str));
 128   return string (scm_i_string_chars (str),
 129                  (int) scm_i_string_length (str));
 130 }
 131
 132 char *
 133 ly_scm2newstr (SCM str, size_t *lenp)
 134 {
 135   SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
 136
 137   size_t len = scm_i_string_length (str);
 138   if (char *new_str = (char *) malloc ((len + 1) * sizeof (char)))
 139     {
 140       memcpy (new_str, scm_i_string_chars (str), len);
 141       new_str[len] = '\0';
 142
 143       if (lenp)
 144         *lenp = len;
 145
 146       return new_str;
 147     }
 148   return 0;
 149 }
 150
 151
 152 /*
 153   PAIRS
 154 */
 155 SCM
 156 index_get_cell (SCM s, Direction d)
 157 {
 158
 159   assert (d);
 160   return (d == LEFT) ? scm_car (s) : scm_cdr (s);
 161 }
 162
 163 SCM
 164 index_set_cell (SCM s, Direction d, SCM v)
 165 {
 166   if (d == LEFT)
 167     scm_set_car_x (s, v);
 168   else if (d == RIGHT)
 169     scm_set_cdr_x (s, v);
 170   return s;
 171 }
 172
 173 bool
 174 is_number_pair (SCM p)
 175 {
 176   return scm_is_pair (p)
 177     && scm_is_number (scm_car (p)) && scm_is_number (scm_cdr (p));
 178 }
 179
 180
 181 unsigned int
 182 ly_scm_hash (SCM s)
 183 {
 184   return scm_ihashv (s, ~1u);
 185 }
 186
 187
 188 bool
 189 is_axis (SCM s)
 190 {
 191   if (scm_is_number (s))
 192     {
 193       int i = scm_to_int (s);
 194       return i == 0 || i == 1;
 195     }
 196   return false;
 197 }
 198
 199 bool
 200 to_boolean (SCM s)
 201 {
 202   return scm_is_bool (s) && ly_scm2bool (s);
 203 }
 204
 205 /*
 206   DIRECTIONS
 207  */
 208 Direction
 209 to_dir (SCM s)
 210 {
 211   return scm_is_integer (s) ? (Direction) scm_to_int (s) : CENTER;
 212 }
 213
 214 Direction
 215 robust_scm2dir (SCM d, Direction def)
 216 {
 217   if (is_direction (d))
 218     def = to_dir (d);
 219   return def;
 220 }
 221
 222 bool
 223 is_direction (SCM s)
 224 {
 225   if (scm_is_number (s))
 226     {
 227       int i = scm_to_int (s);
 228       return i >= -1 && i <= 1;
 229     }
 230   return false;
 231 }
 232
 233 /*
 234   INTERVALS
 235  */
 236 Interval
 237 ly_scm2interval (SCM p)
 238 {
 239   return Interval (scm_to_double (scm_car (p)), scm_to_double (scm_cdr (p)));
 240 }
 241
 242 Drul_array<Real>
 243 ly_scm2realdrul (SCM p)
 244 {
 245   return Drul_array<Real> (scm_to_double (scm_car (p)),
 246                            scm_to_double (scm_cdr (p)));
 247 }
 248
 249 SCM
 250 ly_interval2scm (Drul_array<Real> i)
 251 {
 252   return scm_cons (scm_from_double (i[LEFT]), scm_from_double (i[RIGHT]));
 253 }
 254
 255
 256 Interval
 257 robust_scm2interval (SCM k, Drul_array<Real> v)
 258 {
 259   Interval i;
 260   i[LEFT] = v[LEFT];
 261   i[RIGHT] = v[RIGHT];
 262   if (is_number_pair (k))
 263     i = ly_scm2interval (k);
 264   return i;
 265 }
 266
 267 Drul_array<Real>
 268 robust_scm2drul (SCM k, Drul_array<Real> v)
 269 {
 270   if (is_number_pair (k))
 271     v = ly_scm2interval (k);
 272   return v;
 273 }
 274
 275 Drul_array<bool>
 276 robust_scm2booldrul (SCM k, Drul_array<bool> def)
 277 {
 278   if (scm_is_pair (k))
 279     {
 280       def[LEFT] = to_boolean (scm_car (k));
 281       def[RIGHT] = to_boolean (scm_cdr (k));
 282     }
 283   return def;
 284 }
 285
 286 /*
 287   OFFSET
 288 */
 289 SCM
 290 ly_offset2scm (Offset o)
 291 {
 292   return scm_cons (scm_from_double (o[X_AXIS]), scm_from_double (o[Y_AXIS]));
 293 }
 294
 295 Offset
 296 ly_scm2offset (SCM s)
 297 {
 298   return Offset (scm_to_double (scm_car (s)),
 299                  scm_to_double (scm_cdr (s)));
 300 }
 301
 302 Offset
 303 robust_scm2offset (SCM k, Offset o)
 304 {
 305   if (is_number_pair (k))
 306     o = ly_scm2offset (k);
 307   return o;
 308 }
 309 SCM
 310 ly_offsets2scm (vector<Offset> os)
 311 {
 312   SCM l = SCM_EOL;
 313   SCM *tail = &l;
 314   for (vsize i = 0; i < os.size (); i++)
 315     {
 316       *tail = scm_cons (ly_offset2scm (os[i]), SCM_EOL);
 317       tail = SCM_CDRLOC(*tail);
 318     }
 319   return l;
 320 }
 321
 322 vector<Offset>
 323 ly_scm2offsets (SCM s)
 324 {
 325   vector<Offset> os;
 326   for (; scm_is_pair (s); s = scm_cdr (s))
 327     os.push_back (ly_scm2offset (scm_car (s)));
 328   return os;
 329 }
 330
 331
 332
 333
 334 /*
 335   ALIST
 336 */
 337
 338 /* looks the key up in the cdrs of the alist-keys
 339    - ignoring the car and ignoring non-pair keys.
 340    Returns first match found, i.e.
 341
 342    alist = ((1 . 10)
 343    ((1 . 2) . 11)
 344    ((2 . 1) . 12)
 345    ((3 . 0) . 13)
 346    ((4 . 1) . 14) )
 347
 348    I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 349    element with the cdr of the key = 1.  In other words (alloc_cdr key)
 350    corresponds to call
 351
 352    (alloc (anything . key))
 353 */
 354 SCM
 355 ly_assoc_cdr (SCM key, SCM alist)
 356 {
 357   if (scm_is_pair (alist))
 358     {
 359       SCM trykey = scm_caar (alist);
 360       if (scm_is_pair (trykey)
 361           && to_boolean (scm_equal_p (key, scm_cdr (trykey))))
 362         return scm_car (alist);
 363       return ly_assoc_cdr (key, scm_cdr (alist));
 364     }
 365   return SCM_BOOL_F;
 366 }
 367
 368
 369 bool
 370 alist_equal_p (SCM a, SCM b)
 371 {
 372   for (SCM s = a;
 373        scm_is_pair (s); s = scm_cdr (s))
 374     {
 375       SCM key = scm_caar (s);
 376       SCM val = scm_cdar (s);
 377       SCM l = scm_assoc (key, b);
 378
 379       if (l == SCM_BOOL_F
 380           || !ly_is_equal (scm_cdr (l), val))
 381
 382         return false;
 383     }
 384   return true;
 385 }
 386
 387 SCM
 388 ly_alist_vals (SCM alist)
 389 {
 390   SCM x = SCM_EOL;
 391   for (SCM p = alist; scm_is_pair (p); p = scm_cdr (p))
 392     x = scm_cons (scm_cdar (p), x);
 393   return x;
 394 }
 395
 396 /*
 397   LISTS
 398  */
 399
 400 /* Return I-th element, or last elt L. If I < 0, then we take the first
 401    element.
 402
 403    PRE: length (L) > 0  */
 404 SCM
 405 robust_list_ref (int i, SCM l)
 406 {
 407   while (i-- > 0 && scm_is_pair (scm_cdr (l)))
 408     l = scm_cdr (l);
 409   return scm_car (l);
 410 }
 411
 412
 413 SCM
 414 ly_deep_copy (SCM src)
 415 {
 416   if (scm_is_pair (src))
 417     return scm_cons (ly_deep_copy (scm_car (src)), ly_deep_copy (scm_cdr (src)));
 418   else if (scm_is_vector (src))
 419     {
 420       int len = scm_c_vector_length (src);
 421       SCM nv = scm_c_make_vector (len, SCM_UNDEFINED);
 422       for (int i = 0;i < len; i++)
 423         {
 424           SCM si = scm_from_int (i);
 425           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 426         }
 427     }
 428   return src;
 429 }
 430
 431
 432 SCM
 433 ly_truncate_list (int k, SCM lst)
 434 {
 435   if (k == 0)
 436     lst = SCM_EOL;
 437   else
 438     {
 439       SCM s = lst;
 440       k--;
 441       for (; scm_is_pair (s) && k--; s = scm_cdr (s))
 442         ;
 443
 444       if (scm_is_pair (s))
 445         scm_set_cdr_x (s, SCM_EOL);
 446     }
 447   return lst;
 448 }
 449
 450
 451
 452
 453
 454 string
 455 print_scm_val (SCM val)
 456 {
 457   string realval = ly_scm2string (ly_write2scm (val));
 458   if (realval.length () > 200)
 459     realval = realval.substr (0, 100)
 460       + "\n :\n :\n"
 461       + realval.substr (realval.length () - 100);
 462   return realval;
 463 }
 464
 465 bool
 466 type_check_assignment (SCM sym, SCM val, SCM type_symbol)
 467 {
 468   bool ok = true;
 469
 470   /*
 471     Always succeeds.
 472
 473
 474     TODO: should remove #f from allowed vals?
 475   */
 476   if (val == SCM_EOL || val == SCM_BOOL_F)
 477     return ok;
 478
 479   if (!scm_is_symbol (sym))
 480 #if 0
 481     return false;
 482 #else
 483   /*
 484     This is used for autoBeamSettings.
 485
 486     TODO: deprecate the use of \override and \revert for
 487     autoBeamSettings?
 488
 489     or use a symbol autoBeamSettingS?
 490   */
 491   return true;
 492 #endif
 493
 494   SCM type = scm_object_property (sym, type_symbol);
 495
 496   if (type != SCM_EOL && !ly_is_procedure (type))
 497     {
 498       warning (_f ("cannot find property type-check for `%s' (%s).",
 499                    ly_symbol2string (sym).c_str (),
 500                    ly_symbol2string (type_symbol).c_str ())
 501                + "  " + _ ("perhaps a typing error?"));
 502
 503       /* Be strict when being anal :) */
 504       if (do_internal_type_checking_global)
 505         abort ();
 506
 507       warning (_ ("doing assignment anyway"));
 508     }
 509   else
 510     {
 511       if (val != SCM_EOL
 512           && ly_is_procedure (type)
 513           && scm_call_1 (type, val) == SCM_BOOL_F)
 514         {
 515           ok = false;
 516           SCM typefunc = ly_lily_module_constant ("type-name");
 517           SCM type_name = scm_call_1 (typefunc, type);
 518
 519           warning (_f ("type check for `%s' failed; value `%s' must be of type `%s'",
 520                        ly_symbol2string (sym).c_str (),
 521                        print_scm_val (val),
 522                        ly_scm2string (type_name).c_str ()));
 523           progress_indication ("\n");
 524         }
 525     }
 526   return ok;
 527 }
 528
 529 /* some SCM abbrevs
 530
 531 zijn deze nou handig?
 532 zijn ze er al in scheme, maar heten ze anders? */
 533
 534 /* Remove doubles from (sorted) list */
 535 SCM
 536 ly_unique (SCM list)
 537 {
 538   SCM unique = SCM_EOL;
 539   for (SCM i = list; scm_is_pair (i); i = scm_cdr (i))
 540     {
 541       if (!scm_is_pair (scm_cdr (i))
 542           || !ly_is_equal (scm_car (i), scm_cadr (i)))
 543         unique = scm_cons (scm_car (i), unique);
 544     }
 545   return scm_reverse_x (unique, SCM_EOL);
 546 }
 547
 548
 549 /* Split list at member s, removing s.
 550    Return (BEFORE . AFTER)  */
 551 SCM
 552 ly_split_list (SCM s, SCM list)
 553 {
 554   SCM before = SCM_EOL;
 555   SCM after = list;
 556   for (; scm_is_pair (after);)
 557     {
 558       SCM i = scm_car (after);
 559       after = scm_cdr (after);
 560       if (ly_is_equal (i, s))
 561         break;
 562       before = scm_cons (i, before);
 563     }
 564   return scm_cons (scm_reverse_x (before, SCM_EOL), after);
 565 }
 566
 567 void
 568 taint (SCM *)
 569 {
 570   /*
 571     nop.
 572   */
 573 }
 574
 575 /*
 576   display stuff without using stack
 577 */
 578 SCM
 579 display_list (SCM s)
 580 {
 581   SCM p = scm_current_output_port ();
 582
 583   scm_puts ("(", p);
 584   for (; scm_is_pair (s); s = scm_cdr (s))
 585     {
 586       scm_display (scm_car (s), p);
 587       scm_puts (" ", p);
 588     }
 589   scm_puts (")", p);
 590   return SCM_UNSPECIFIED;
 591 }
 592
 593 Slice
 594 int_list_to_slice (SCM l)
 595 {
 596   Slice s;
 597   s.set_empty ();
 598   for (; scm_is_pair (l); l = scm_cdr (l))
 599     if (scm_is_number (scm_car (l)))
 600       s.add_point (scm_to_int (scm_car (l)));
 601   return s;
 602 }
 603
 604 Real
 605 robust_scm2double (SCM k, double x)
 606 {
 607   if (scm_is_number (k))
 608     x = scm_to_double (k);
 609   return x;
 610 }
 611
 612
 613 string
 614 robust_scm2string (SCM k, string s)
 615 {
 616   if (scm_is_string (k))
 617     s = ly_scm2string (k);
 618   return s;
 619 }
 620
 621 int
 622 robust_scm2int (SCM k, int o)
 623 {
 624   if (scm_integer_p (k) == SCM_BOOL_T)
 625     o = scm_to_int (k);
 626   return o;
 627 }
 628
 629
 630 SCM
 631 ly_rational2scm (Rational r)
 632 {
 633   return scm_divide (scm_from_int (r.numerator ()), scm_from_int (r.denominator ()));
 634 }
 635
 636
 637 Rational
 638 ly_scm2rational (SCM r)
 639 {
 640   return Rational (scm_to_int (scm_numerator (r)),
 641                    scm_to_int (scm_denominator (r)));
 642 }
 643
 644
 645 SCM
 646 alist_to_hashq (SCM alist)
 647 {
 648   int i = scm_ilength (alist);
 649   if (i < 0)
 650     return scm_c_make_hash_table (0);
 651
 652   SCM tab = scm_c_make_hash_table (i);
 653   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 654     {
 655       SCM pt = scm_cdar (s);
 656       scm_hashq_set_x (tab, scm_caar (s), pt);
 657     }
 658   return tab;
 659 }
 660
 661 SCM
 662 ly_hash2alist (SCM tab)
 663 {
 664   SCM func = ly_lily_module_constant ("hash-table->alist");
 665   return scm_call_1 (func, tab);
 666 }
 667
 668 int
 669 procedure_arity (SCM proc)
 670 {
 671   assert (ly_is_procedure (proc));
 672   SCM arity = scm_procedure_property (proc,
 673                                       ly_symbol2scm ("arity"));
 674
 675   SCM fixed = scm_car (arity);
 676   return scm_to_int (fixed);
 677 }
 678
 679 /*
 680   C++ interfacing.
 681  */
 682
 683 string
 684 mangle_cxx_identifier (string cxx_id)
 685 {
 686   if (cxx_id.substr (0, 3) == "ly_")
 687     cxx_id = cxx_id.replace (0, 3, "ly:");
 688   else
 689     {
 690       cxx_id = String_convert::to_lower (cxx_id);
 691       cxx_id = "ly:" + cxx_id;
 692     }
 693   if (cxx_id.substr (cxx_id.length () - 2) == "_p")
 694     cxx_id = cxx_id.replace (cxx_id.length () - 2, 1, "?");
 695   else if (cxx_id.substr (cxx_id.length () - 2) == "_x")
 696     cxx_id = cxx_id.replace (cxx_id.length () - 2, 1, "!");
 697
 698   cxx_id = replace_all (cxx_id, '_', '-');
 699   return cxx_id;
 700 }
 701
 702
 703
 704 SCM
 705 ly_string_array_to_scm (vector<string> a)
 706 {
 707   SCM s = SCM_EOL;
 708   for (vsize i = a.size (); i ; i--)
 709     s = scm_cons (ly_symbol2scm (a[i - 1].c_str ()), s);
 710   return s;
 711 }
 712
 713 /* SYMBOLS is a whitespace separated list.  */
 714 SCM
 715 parse_symbol_list (char const *symbols)
 716 {
 717   while (isspace (*symbols))
 718     *symbols++;
 719   string s = symbols;
 720   replace_all (s, '\n', ' ');
 721   replace_all (s, '\t', ' ');
 722   return ly_string_array_to_scm (string_split (s, ' '));
 723 }
 724
 725
 726 bool
 727 ly_is_fraction (SCM x)
 728 {
 729   return SCM_FRACTIONP(x);
 730 }
 731
 732 struct ly_t_double_cell
 733 {
 734   SCM a;
 735   SCM b;
 736   SCM c;
 737   SCM d;
 738 };
 739
 740 /* inserts at front, removing duplicates */
 741 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val)
 742 {
 743   return scm_acons (key, val, scm_assoc_remove_x (alist, key));
 744 }
 745