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_from_locale_string ("~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 SCM
 133 ly_string2scm (string const &str)
 134 {
 135   return scm_from_locale_stringn (str.c_str(),
 136                                   str.length ());
 137 }
 138
 139
 140 char *
 141 ly_scm2newstr (SCM str, size_t *lenp)
 142 {
 143   SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
 144
 145   size_t len = scm_i_string_length (str);
 146   if (char *new_str = (char *) malloc ((len + 1) * sizeof (char)))
 147     {
 148       memcpy (new_str, scm_i_string_chars (str), len);
 149       new_str[len] = '\0';
 150
 151       if (lenp)
 152         *lenp = len;
 153
 154       return new_str;
 155     }
 156   return 0;
 157 }
 158
 159
 160 /*
 161   PAIRS
 162 */
 163 SCM
 164 index_get_cell (SCM s, Direction d)
 165 {
 166
 167   assert (d);
 168   return (d == LEFT) ? scm_car (s) : scm_cdr (s);
 169 }
 170
 171 SCM
 172 index_set_cell (SCM s, Direction d, SCM v)
 173 {
 174   if (d == LEFT)
 175     scm_set_car_x (s, v);
 176   else if (d == RIGHT)
 177     scm_set_cdr_x (s, v);
 178   return s;
 179 }
 180
 181 bool
 182 is_number_pair (SCM p)
 183 {
 184   return scm_is_pair (p)
 185     && scm_is_number (scm_car (p)) && scm_is_number (scm_cdr (p));
 186 }
 187
 188
 189 unsigned int
 190 ly_scm_hash (SCM s)
 191 {
 192   return scm_ihashv (s, ~1u);
 193 }
 194
 195
 196 bool
 197 is_axis (SCM s)
 198 {
 199   if (scm_is_number (s))
 200     {
 201       int i = scm_to_int (s);
 202       return i == 0 || i == 1;
 203     }
 204   return false;
 205 }
 206
 207 bool
 208 to_boolean (SCM s)
 209 {
 210   return scm_is_bool (s) && ly_scm2bool (s);
 211 }
 212
 213 /*
 214   DIRECTIONS
 215  */
 216 Direction
 217 to_dir (SCM s)
 218 {
 219   return scm_is_integer (s) ? (Direction) scm_to_int (s) : CENTER;
 220 }
 221
 222 Direction
 223 robust_scm2dir (SCM d, Direction def)
 224 {
 225   if (is_direction (d))
 226     def = to_dir (d);
 227   return def;
 228 }
 229
 230 bool
 231 is_direction (SCM s)
 232 {
 233   if (scm_is_number (s))
 234     {
 235       int i = scm_to_int (s);
 236       return i >= -1 && i <= 1;
 237     }
 238   return false;
 239 }
 240
 241 /*
 242   INTERVALS
 243  */
 244 Interval
 245 ly_scm2interval (SCM p)
 246 {
 247   return Interval (scm_to_double (scm_car (p)), scm_to_double (scm_cdr (p)));
 248 }
 249
 250 Drul_array<Real>
 251 ly_scm2realdrul (SCM p)
 252 {
 253   return Drul_array<Real> (scm_to_double (scm_car (p)),
 254                            scm_to_double (scm_cdr (p)));
 255 }
 256
 257 SCM
 258 ly_interval2scm (Drul_array<Real> i)
 259 {
 260   return scm_cons (scm_from_double (i[LEFT]), scm_from_double (i[RIGHT]));
 261 }
 262
 263
 264 Interval
 265 robust_scm2interval (SCM k, Drul_array<Real> v)
 266 {
 267   Interval i;
 268   i[LEFT] = v[LEFT];
 269   i[RIGHT] = v[RIGHT];
 270   if (is_number_pair (k))
 271     i = ly_scm2interval (k);
 272   return i;
 273 }
 274
 275 Drul_array<Real>
 276 robust_scm2drul (SCM k, Drul_array<Real> v)
 277 {
 278   if (is_number_pair (k))
 279     v = ly_scm2interval (k);
 280   return v;
 281 }
 282
 283 Drul_array<bool>
 284 robust_scm2booldrul (SCM k, Drul_array<bool> def)
 285 {
 286   if (scm_is_pair (k))
 287     {
 288       def[LEFT] = to_boolean (scm_car (k));
 289       def[RIGHT] = to_boolean (scm_cdr (k));
 290     }
 291   return def;
 292 }
 293
 294 /*
 295   OFFSET
 296 */
 297 SCM
 298 ly_offset2scm (Offset o)
 299 {
 300   return scm_cons (scm_from_double (o[X_AXIS]), scm_from_double (o[Y_AXIS]));
 301 }
 302
 303 Offset
 304 ly_scm2offset (SCM s)
 305 {
 306   return Offset (scm_to_double (scm_car (s)),
 307                  scm_to_double (scm_cdr (s)));
 308 }
 309
 310 Offset
 311 robust_scm2offset (SCM k, Offset o)
 312 {
 313   if (is_number_pair (k))
 314     o = ly_scm2offset (k);
 315   return o;
 316 }
 317 SCM
 318 ly_offsets2scm (vector<Offset> os)
 319 {
 320   SCM l = SCM_EOL;
 321   SCM *tail = &l;
 322   for (vsize i = 0; i < os.size (); i++)
 323     {
 324       *tail = scm_cons (ly_offset2scm (os[i]), SCM_EOL);
 325       tail = SCM_CDRLOC(*tail);
 326     }
 327   return l;
 328 }
 329
 330 vector<Offset>
 331 ly_scm2offsets (SCM s)
 332 {
 333   vector<Offset> os;
 334   for (; scm_is_pair (s); s = scm_cdr (s))
 335     os.push_back (ly_scm2offset (scm_car (s)));
 336   return os;
 337 }
 338
 339
 340
 341
 342 /*
 343   ALIST
 344 */
 345
 346 bool
 347 alist_equal_p (SCM a, SCM b)
 348 {
 349   for (SCM s = a;
 350        scm_is_pair (s); s = scm_cdr (s))
 351     {
 352       SCM key = scm_caar (s);
 353       SCM val = scm_cdar (s);
 354       SCM l = scm_assoc (key, b);
 355
 356       if (l == SCM_BOOL_F
 357           || !ly_is_equal (scm_cdr (l), val))
 358
 359         return false;
 360     }
 361   return true;
 362 }
 363
 364 SCM
 365 ly_alist_vals (SCM alist)
 366 {
 367   SCM x = SCM_EOL;
 368   for (SCM p = alist; scm_is_pair (p); p = scm_cdr (p))
 369     x = scm_cons (scm_cdar (p), x);
 370   return x;
 371 }
 372
 373 /*
 374   LISTS
 375  */
 376
 377 /* Return I-th element, or last elt L. If I < 0, then we take the first
 378    element.
 379
 380    PRE: length (L) > 0  */
 381 SCM
 382 robust_list_ref (int i, SCM l)
 383 {
 384   while (i-- > 0 && scm_is_pair (scm_cdr (l)))
 385     l = scm_cdr (l);
 386   return scm_car (l);
 387 }
 388
 389
 390 SCM
 391 ly_deep_copy (SCM src)
 392 {
 393   if (scm_is_pair (src))
 394     return scm_cons (ly_deep_copy (scm_car (src)), ly_deep_copy (scm_cdr (src)));
 395   else if (scm_is_vector (src))
 396     {
 397       int len = scm_c_vector_length (src);
 398       SCM nv = scm_c_make_vector (len, SCM_UNDEFINED);
 399       for (int i = 0;i < len; i++)
 400         {
 401           SCM si = scm_from_int (i);
 402           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 403         }
 404     }
 405   return src;
 406 }
 407
 408
 409
 410
 411
 412 string
 413 print_scm_val (SCM val)
 414 {
 415   string realval = ly_scm2string (ly_write2scm (val));
 416   if (realval.length () > 200)
 417     realval = realval.substr (0, 100)
 418       + "\n :\n :\n"
 419       + realval.substr (realval.length () - 100);
 420   return realval;
 421 }
 422
 423 bool
 424 type_check_assignment (SCM sym, SCM val, SCM type_symbol)
 425 {
 426   bool ok = true;
 427
 428   /*
 429     Always succeeds.
 430
 431
 432     TODO: should remove #f from allowed vals?
 433   */
 434   if (val == SCM_EOL || val == SCM_BOOL_F)
 435     return ok;
 436
 437   if (!scm_is_symbol (sym))
 438 #if 0
 439     return false;
 440 #else
 441   /*
 442     This is used for autoBeamSettings.
 443
 444     TODO: deprecate the use of \override and \revert for
 445     autoBeamSettings?
 446
 447     or use a symbol autoBeamSettingS?
 448   */
 449   return true;
 450 #endif
 451
 452   SCM type = scm_object_property (sym, type_symbol);
 453
 454   if (type != SCM_EOL && !ly_is_procedure (type))
 455     {
 456       warning (_f ("cannot find property type-check for `%s' (%s).",
 457                    ly_symbol2string (sym).c_str (),
 458                    ly_symbol2string (type_symbol).c_str ())
 459                + "  " + _ ("perhaps a typing error?"));
 460
 461       /* Be strict when being anal :) */
 462       if (do_internal_type_checking_global)
 463         abort ();
 464
 465       warning (_ ("doing assignment anyway"));
 466     }
 467   else
 468     {
 469       if (val != SCM_EOL
 470           && ly_is_procedure (type)
 471           && scm_call_1 (type, val) == SCM_BOOL_F)
 472         {
 473           ok = false;
 474           SCM typefunc = ly_lily_module_constant ("type-name");
 475           SCM type_name = scm_call_1 (typefunc, type);
 476
 477           warning (_f ("type check for `%s' failed; value `%s' must be of type `%s'",
 478                        ly_symbol2string (sym).c_str (),
 479                        print_scm_val (val),
 480                        ly_scm2string (type_name).c_str ()));
 481           progress_indication ("\n");
 482         }
 483     }
 484   return ok;
 485 }
 486
 487 /* some SCM abbrevs
 488
 489 zijn deze nou handig?
 490 zijn ze er al in scheme, maar heten ze anders? */
 491
 492 /* Remove doubles from (sorted) list */
 493 SCM
 494 ly_unique (SCM list)
 495 {
 496   SCM unique = SCM_EOL;
 497   for (SCM i = list; scm_is_pair (i); i = scm_cdr (i))
 498     {
 499       if (!scm_is_pair (scm_cdr (i))
 500           || !ly_is_equal (scm_car (i), scm_cadr (i)))
 501         unique = scm_cons (scm_car (i), unique);
 502     }
 503   return scm_reverse_x (unique, SCM_EOL);
 504 }
 505
 506
 507 /* Split list at member s, removing s.
 508    Return (BEFORE . AFTER)  */
 509 SCM
 510 ly_split_list (SCM s, SCM list)
 511 {
 512   SCM before = SCM_EOL;
 513   SCM after = list;
 514   for (; scm_is_pair (after);)
 515     {
 516       SCM i = scm_car (after);
 517       after = scm_cdr (after);
 518       if (ly_is_equal (i, s))
 519         break;
 520       before = scm_cons (i, before);
 521     }
 522   return scm_cons (scm_reverse_x (before, SCM_EOL), after);
 523 }
 524
 525 void
 526 taint (SCM *)
 527 {
 528   /*
 529     nop.
 530   */
 531 }
 532
 533 /*
 534   display stuff without using stack
 535 */
 536 SCM
 537 display_list (SCM s)
 538 {
 539   SCM p = scm_current_output_port ();
 540
 541   scm_puts ("(", p);
 542   for (; scm_is_pair (s); s = scm_cdr (s))
 543     {
 544       scm_display (scm_car (s), p);
 545       scm_puts (" ", p);
 546     }
 547   scm_puts (")", p);
 548   return SCM_UNSPECIFIED;
 549 }
 550
 551 Slice
 552 int_list_to_slice (SCM l)
 553 {
 554   Slice s;
 555   s.set_empty ();
 556   for (; scm_is_pair (l); l = scm_cdr (l))
 557     if (scm_is_number (scm_car (l)))
 558       s.add_point (scm_to_int (scm_car (l)));
 559   return s;
 560 }
 561
 562 Real
 563 robust_scm2double (SCM k, double x)
 564 {
 565   if (scm_is_number (k))
 566     x = scm_to_double (k);
 567   return x;
 568 }
 569
 570
 571 string
 572 robust_scm2string (SCM k, string s)
 573 {
 574   if (scm_is_string (k))
 575     s = ly_scm2string (k);
 576   return s;
 577 }
 578
 579 int
 580 robust_scm2int (SCM k, int o)
 581 {
 582   if (scm_integer_p (k) == SCM_BOOL_T)
 583     o = scm_to_int (k);
 584   return o;
 585 }
 586
 587
 588 SCM
 589 ly_rational2scm (Rational r)
 590 {
 591   return scm_divide (scm_from_int (r.numerator ()), scm_from_int (r.denominator ()));
 592 }
 593
 594
 595 Rational
 596 ly_scm2rational (SCM r)
 597 {
 598   return Rational (scm_to_int (scm_numerator (r)),
 599                    scm_to_int (scm_denominator (r)));
 600 }
 601
 602
 603 SCM
 604 alist_to_hashq (SCM alist)
 605 {
 606   int i = scm_ilength (alist);
 607   if (i < 0)
 608     return scm_c_make_hash_table (0);
 609
 610   SCM tab = scm_c_make_hash_table (i);
 611   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 612     {
 613       SCM pt = scm_cdar (s);
 614       scm_hashq_set_x (tab, scm_caar (s), pt);
 615     }
 616   return tab;
 617 }
 618
 619 SCM
 620 ly_hash2alist (SCM tab)
 621 {
 622   SCM func = ly_lily_module_constant ("hash-table->alist");
 623   return scm_call_1 (func, tab);
 624 }
 625
 626 int
 627 procedure_arity (SCM proc)
 628 {
 629   assert (ly_is_procedure (proc));
 630   SCM arity = scm_procedure_property (proc,
 631                                       ly_symbol2scm ("arity"));
 632
 633   SCM fixed = scm_car (arity);
 634   return scm_to_int (fixed);
 635 }
 636
 637 /*
 638   C++ interfacing.
 639  */
 640
 641 string
 642 mangle_cxx_identifier (string cxx_id)
 643 {
 644   if (cxx_id.substr (0, 3) == "ly_")
 645     cxx_id = cxx_id.replace (0, 3, "ly:");
 646   else
 647     {
 648       cxx_id = String_convert::to_lower (cxx_id);
 649       cxx_id = "ly:" + cxx_id;
 650     }
 651   if (cxx_id.substr (cxx_id.length () - 2) == "_p")
 652     cxx_id = cxx_id.replace (cxx_id.length () - 2, 1, "?");
 653   else if (cxx_id.substr (cxx_id.length () - 2) == "_x")
 654     cxx_id = cxx_id.replace (cxx_id.length () - 2, 1, "!");
 655
 656   cxx_id = replace_all (cxx_id, '_', '-');
 657   return cxx_id;
 658 }
 659
 660
 661
 662 SCM
 663 ly_string_array_to_scm (vector<string> a)
 664 {
 665   SCM s = SCM_EOL;
 666   for (vsize i = a.size (); i ; i--)
 667     s = scm_cons (ly_symbol2scm (a[i - 1].c_str ()), s);
 668   return s;
 669 }
 670
 671 /* SYMBOLS is a whitespace separated list.  */
 672 SCM
 673 parse_symbol_list (char const *symbols)
 674 {
 675   while (isspace (*symbols))
 676     *symbols++;
 677   string s = symbols;
 678   replace_all (s, '\n', ' ');
 679   replace_all (s, '\t', ' ');
 680   return ly_string_array_to_scm (string_split (s, ' '));
 681 }
 682
 683
 684 bool
 685 ly_is_fraction (SCM x)
 686 {
 687   return SCM_FRACTIONP(x);
 688 }
 689
 690 struct ly_t_double_cell
 691 {
 692   SCM a;
 693   SCM b;
 694   SCM c;
 695   SCM d;
 696 };
 697
 698 /* inserts at front, removing duplicates */
 699 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val)
 700 {
 701   return scm_acons (key, val, scm_assoc_remove_x (alist, key));
 702 }
 703