lily/lily-guile.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2011 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   symbols/strings.
  46  */
  47 string
  48 ly_scm_write_string (SCM s)
  49 {
  50   SCM port = scm_mkstrport (SCM_INUM0,
  51                             scm_make_string (SCM_INUM0, SCM_UNDEFINED),
  52                             SCM_OPN | SCM_WRTNG,
  53                             "ly_write2string");
  54   //  SCM write = scm_eval_3 (ly_symbol2scm ("write"), s, SCM_EOL);
  55   SCM write = scm_primitive_eval (ly_symbol2scm ("write"));
  56
  57   // scm_apply (write, port, SCM_EOL);
  58   scm_call_2 (write, s, port);
  59   return ly_scm2string (scm_strport_to_string (port));
  60 }
  61
  62 SCM
  63 ly_quote_scm (SCM s)
  64 {
  65   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
  66 }
  67
  68 string
  69 ly_symbol2string (SCM s)
  70 {
  71   /*
  72     Ugh. this is not very efficient.
  73   */
  74   return ly_scm2string (scm_symbol_to_string (s));
  75 }
  76
  77 string
  78 robust_symbol2string (SCM sym, string str)
  79 {
  80   return scm_is_symbol (sym) ? ly_symbol2string (sym) : str;
  81 }
  82
  83 string
  84 gulp_file_to_string (string fn, bool must_exist, int size)
  85 {
  86   string s = global_path.find (fn);
  87   if (s == "")
  88     {
  89       if (must_exist)
  90         {
  91           string e = _f ("cannot find file: `%s'", fn);
  92           e += " ";
  93           e += _f ("(load path: `%s')", global_path.to_string ());
  94           error (e);
  95           /* unreachable */
  96         }
  97       return s;
  98     }
  99
 100   debug_output ("[" + s, true);
 101
 102   vector<char> chars = gulp_file (s, size);
 103   string result (&chars[0], chars.size ());
 104
 105   debug_output ("]\n", false);
 106
 107   return result;
 108 }
 109
 110 extern "C" {
 111   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 112   void
 113   ly_display_scm (SCM s)
 114   {
 115     scm_display (s, scm_current_output_port ());
 116     scm_newline (scm_current_output_port ());
 117   }
 118 };
 119
 120 /*
 121   STRINGS
 122  */
 123 string
 124 ly_scm2string (SCM str)
 125 {
 126   assert (scm_is_string (str));
 127   string result;
 128   size_t len = scm_c_string_length (str);
 129   if (len)
 130     {
 131       result.resize (len);
 132       scm_to_locale_stringbuf (str, &result.at (0), len);
 133     }
 134   return result;
 135 }
 136
 137 SCM
 138 ly_string2scm (string const &str)
 139 {
 140   return scm_from_locale_stringn (str.c_str (),
 141                                   str.length ());
 142 }
 143
 144 char *
 145 ly_scm2str0 (SCM str)
 146 {
 147   return scm_to_locale_string (str);
 148 }
 149
 150 /*
 151   PAIRS
 152 */
 153 SCM
 154 index_get_cell (SCM s, Direction d)
 155 {
 156   assert (d);
 157   return (d == LEFT) ? scm_car (s) : scm_cdr (s);
 158 }
 159
 160 SCM
 161 index_set_cell (SCM s, Direction d, SCM v)
 162 {
 163   if (d == LEFT)
 164     scm_set_car_x (s, v);
 165   else if (d == RIGHT)
 166     scm_set_cdr_x (s, v);
 167   return s;
 168 }
 169
 170 bool
 171 is_number_pair (SCM p)
 172 {
 173   return scm_is_pair (p)
 174          && scm_is_number (scm_car (p)) && scm_is_number (scm_cdr (p));
 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_integer (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)),
 235                    scm_to_double (scm_cdr (p)));
 236 }
 237
 238 Drul_array<Real>
 239 ly_scm2realdrul (SCM p)
 240 {
 241   return Drul_array<Real> (scm_to_double (scm_car (p)),
 242                            scm_to_double (scm_cdr (p)));
 243 }
 244
 245 SCM
 246 ly_interval2scm (Drul_array<Real> i)
 247 {
 248   return scm_cons (scm_from_double (i[LEFT]), scm_from_double (i[RIGHT]));
 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   ALIST
 328 */
 329
 330 // This one is used nowhere.
 331 bool
 332 ly_is_alist_equal (SCM a, SCM b)
 333 {
 334   if (!scm_is_pair (a) || !scm_is_pair (b))
 335     return false;
 336   for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
 337     {
 338       SCM key = scm_caar (s);
 339       SCM val = scm_cdar (s);
 340       SCM l = scm_assoc (key, b);
 341
 342       if (scm_is_false (l) || !ly_is_equal (scm_cdr (l), val))
 343         return false;
 344     }
 345   return true;
 346 }
 347
 348 SCM
 349 ly_alist_vals (SCM alist)
 350 {
 351   SCM x = SCM_EOL;
 352   for (SCM p = alist; scm_is_pair (p); p = scm_cdr (p))
 353     x = scm_cons (scm_cdar (p), x);
 354   return x;
 355 }
 356
 357 /*
 358   LISTS
 359  */
 360
 361 /* Return I-th element, or last elt L. If I < 0, then we take the first
 362    element.
 363
 364    PRE: length (L) > 0  */
 365 SCM
 366 robust_list_ref (int i, SCM l)
 367 {
 368   while (i-- > 0 && scm_is_pair (scm_cdr (l)))
 369     l = scm_cdr (l);
 370   return scm_car (l);
 371 }
 372
 373 SCM
 374 ly_deep_copy (SCM src)
 375 {
 376   if (scm_is_pair (src))
 377     return scm_cons (ly_deep_copy (scm_car (src)), ly_deep_copy (scm_cdr (src)));
 378   else if (scm_is_vector (src))
 379     {
 380       int len = scm_c_vector_length (src);
 381       SCM nv = scm_c_make_vector (len, SCM_UNDEFINED);
 382       for (int i = 0; i < len; i++)
 383         {
 384           SCM si = scm_from_int (i);
 385           scm_vector_set_x (nv, si, ly_deep_copy (scm_vector_ref (src, si)));
 386         }
 387     }
 388   return src;
 389 }
 390
 391 string
 392 print_scm_val (SCM val)
 393 {
 394   string realval = ly_scm_write_string (val);
 395   if (realval.length () > 200)
 396     realval = realval.substr (0, 100)
 397               + "\n :\n :\n"
 398               + realval.substr (realval.length () - 100);
 399   return realval;
 400 }
 401
 402 bool
 403 type_check_assignment (SCM sym, SCM val, SCM type_symbol)
 404 {
 405   bool ok = true;
 406
 407   /*
 408     Always succeeds.
 409
 410
 411     TODO: should remove #f from allowed vals?
 412   */
 413   if (val == SCM_EOL || val == SCM_BOOL_F)
 414     return ok;
 415
 416   if (!scm_is_symbol (sym))
 417 #if 0
 418     return false;
 419 #else
 420     /*
 421       This is used for autoBeamSettings.
 422
 423       TODO: deprecate the use of \override and \revert for
 424       autoBeamSettings?
 425
 426       or use a symbol autoBeamSettingS?
 427     */
 428     return true;
 429 #endif
 430
 431   SCM type = scm_object_property (sym, type_symbol);
 432
 433   if (type != SCM_EOL && !ly_is_procedure (type))
 434     {
 435       warning (_f ("cannot find property type-check for `%s' (%s).",
 436                    ly_symbol2string (sym).c_str (),
 437                    ly_symbol2string (type_symbol).c_str ())
 438                + "  " + _ ("perhaps a typing error?"));
 439
 440       /* Be strict when being anal :) */
 441       if (do_internal_type_checking_global)
 442         scm_throw (ly_symbol2scm ("ly-file-failed"), scm_list_3 (ly_symbol2scm ("typecheck"),
 443                                                                  sym, val));
 444
 445       warning (_ ("doing assignment anyway"));
 446     }
 447   else
 448     {
 449       if (val != SCM_EOL
 450           && ly_is_procedure (type)
 451           && scm_call_1 (type, val) == SCM_BOOL_F)
 452         {
 453           ok = false;
 454           SCM typefunc = ly_lily_module_constant ("type-name");
 455           SCM type_name = scm_call_1 (typefunc, type);
 456
 457           warning (_f ("type check for `%s' failed; value `%s' must be of type `%s'",
 458                        ly_symbol2string (sym).c_str (),
 459                        print_scm_val (val),
 460                        ly_scm2string (type_name).c_str ()));
 461           progress_indication ("\n");
 462         }
 463     }
 464   return ok;
 465 }
 466
 467 /* some SCM abbrevs
 468
 469 zijn deze nou handig?
 470 zijn ze er al in scheme, maar heten ze anders? */
 471
 472 /* Remove doubles from (sorted) list */
 473 SCM
 474 ly_unique (SCM list)
 475 {
 476   SCM unique = SCM_EOL;
 477   for (SCM i = list; scm_is_pair (i); i = scm_cdr (i))
 478     {
 479       if (!scm_is_pair (scm_cdr (i))
 480           || !ly_is_equal (scm_car (i), scm_cadr (i)))
 481         unique = scm_cons (scm_car (i), unique);
 482     }
 483   return scm_reverse_x (unique, SCM_EOL);
 484 }
 485
 486 /* Split list at member s, removing s.
 487    Return (BEFORE . AFTER)  */
 488 SCM
 489 ly_split_list (SCM s, SCM list)
 490 {
 491   SCM before = SCM_EOL;
 492   SCM after = list;
 493   for (; scm_is_pair (after);)
 494     {
 495       SCM i = scm_car (after);
 496       after = scm_cdr (after);
 497       if (ly_is_equal (i, s))
 498         break;
 499       before = scm_cons (i, before);
 500     }
 501   return scm_cons (scm_reverse_x (before, SCM_EOL), after);
 502 }
 503
 504 void
 505 taint (SCM *)
 506 {
 507   /*
 508     nop.
 509   */
 510 }
 511
 512 /*
 513   display stuff without using stack
 514 */
 515 SCM
 516 display_list (SCM s)
 517 {
 518   SCM p = scm_current_output_port ();
 519
 520   scm_puts ("(", p);
 521   for (; scm_is_pair (s); s = scm_cdr (s))
 522     {
 523       scm_display (scm_car (s), p);
 524       scm_puts (" ", p);
 525     }
 526   scm_puts (")", p);
 527   return SCM_UNSPECIFIED;
 528 }
 529
 530 Slice
 531 int_list_to_slice (SCM l)
 532 {
 533   Slice s;
 534   s.set_empty ();
 535   for (; scm_is_pair (l); l = scm_cdr (l))
 536     if (scm_is_number (scm_car (l)))
 537       s.add_point (scm_to_int (scm_car (l)));
 538   return s;
 539 }
 540
 541 Real
 542 robust_scm2double (SCM k, double x)
 543 {
 544   if (scm_is_number (k))
 545     x = scm_to_double (k);
 546   return x;
 547 }
 548
 549 string
 550 robust_scm2string (SCM k, string s)
 551 {
 552   if (scm_is_string (k))
 553     s = ly_scm2string (k);
 554   return s;
 555 }
 556
 557 int
 558 robust_scm2int (SCM k, int o)
 559 {
 560   if (scm_integer_p (k) == SCM_BOOL_T)
 561     o = scm_to_int (k);
 562   return o;
 563 }
 564
 565 SCM
 566 ly_rational2scm (Rational r)
 567 {
 568   return scm_divide (scm_from_int64 (r.numerator ()),
 569                      scm_from_int64 (r.denominator ()));
 570 }
 571
 572 Rational
 573 ly_scm2rational (SCM r)
 574 {
 575   return Rational (scm_to_int64 (scm_numerator (r)),
 576                    scm_to_int64 (scm_denominator (r)));
 577 }
 578
 579 Rational
 580 robust_scm2rational (SCM n, Rational rat)
 581 {
 582   if (ly_is_fraction (n))
 583     return ly_scm2rational (n);
 584   else
 585     return rat;
 586 }
 587
 588 SCM
 589 alist_to_hashq (SCM alist)
 590 {
 591   int i = scm_ilength (alist);
 592   if (i < 0)
 593     return scm_c_make_hash_table (0);
 594
 595   SCM tab = scm_c_make_hash_table (i);
 596   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 597     {
 598       SCM pt = scm_cdar (s);
 599       scm_hashq_set_x (tab, scm_caar (s), pt);
 600     }
 601   return tab;
 602 }
 603
 604 SCM
 605 ly_hash2alist (SCM tab)
 606 {
 607   SCM func = ly_lily_module_constant ("hash-table->alist");
 608   return scm_call_1 (func, tab);
 609 }
 610
 611 /*
 612   C++ interfacing.
 613  */
 614
 615 string
 616 mangle_cxx_identifier (string cxx_id)
 617 {
 618   if (cxx_id.substr (0, 3) == "ly_")
 619     cxx_id = cxx_id.replace (0, 3, "ly:");
 620   else
 621     {
 622       cxx_id = String_convert::to_lower (cxx_id);
 623       cxx_id = "ly:" + cxx_id;
 624     }
 625   if (cxx_id.substr (cxx_id.length () - 2) == "_p")
 626     cxx_id = cxx_id.replace (cxx_id.length () - 2, 2, "?");
 627   else if (cxx_id.substr (cxx_id.length () - 2) == "_x")
 628     cxx_id = cxx_id.replace (cxx_id.length () - 2, 2, "!");
 629
 630   replace_all (&cxx_id, "_less?", "<?");
 631   replace_all (&cxx_id, "_2_", "->");
 632   replace_all (&cxx_id, "__", "::");
 633   replace_all (&cxx_id, '_', '-');
 634
 635   return cxx_id;
 636 }
 637
 638 SCM
 639 ly_string_array_to_scm (vector<string> a)
 640 {
 641   SCM s = SCM_EOL;
 642   for (vsize i = a.size (); i; i--)
 643     s = scm_cons (ly_symbol2scm (a[i - 1].c_str ()), s);
 644   return s;
 645 }
 646
 647 /* SYMBOLS is a whitespace separated list.  */
 648 SCM
 649 parse_symbol_list (char const *symbols)
 650 {
 651   while (isspace (*symbols))
 652     symbols++;
 653   string s = symbols;
 654   replace_all (&s, '\n', ' ');
 655   replace_all (&s, '\t', ' ');
 656   replace_all (&s, "  ", " ");
 657   return ly_string_array_to_scm (string_split (s, ' '));
 658 }
 659
 660 /* GDB debugging. */
 661 struct ly_t_double_cell
 662 {
 663   SCM a;
 664   SCM b;
 665   SCM c;
 666   SCM d;
 667 };
 668
 669 /* inserts at front, removing duplicates */
 670 SCM ly_assoc_prepend_x (SCM alist, SCM key, SCM val)
 671 {
 672   return scm_acons (key, val, scm_assoc_remove_x (alist, key));
 673 }
 674