lily/lily-guile.cc

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