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 #include "libc-extension.hh"
  17 #include "lily-guile.hh"
  18 #include "main.hh"
  19 #include "simple-file-storage.hh"
  20 #include "file-path.hh"
  21 #include "debug.hh"
  22 #include "direction.hh"
  23 #include "offset.hh"
  24 #include "interval.hh"
  25 #include "pitch.hh"
  26
  27 SCM
  28 ly_last (SCM list)
  29 {
  30   return ly_car (scm_last_pair (list));
  31 }
  32
  33 SCM
  34 ly_str02scm (char const*c)
  35 {
  36   // this all really sucks, guile should take char const* arguments!
  37   return gh_str02scm ((char*)c);
  38 }
  39
  40
  41 SCM
  42 ly_write2scm (SCM s)
  43 {
  44   SCM port = scm_mkstrport (SCM_INUM0,
  45                             scm_make_string (SCM_INUM0, SCM_UNDEFINED),
  46                             SCM_OPN | SCM_WRTNG,
  47                             "ly_write2string");
  48   //  SCM write = scm_eval_3 (ly_symbol2scm ("write"), s, SCM_EOL);
  49   SCM write = scm_primitive_eval (ly_symbol2scm ("write"));
  50
  51   // scm_apply (write, port, SCM_EOL);
  52   gh_call2 (write, s, port);
  53   return scm_strport_to_string (port);
  54 }
  55
  56
  57 /*
  58   Pass string to scm parser, evaluate one expression.
  59   Return result value and #chars read.
  60
  61   Thanks to Gary Houston <ghouston@freewire.co.uk>
  62
  63   Need guile-1.3.4 (>1.3 anyway) for ftell on str ports -- jcn
  64 */
  65 SCM
  66 ly_parse_scm (char const* s, int* n)
  67 {
  68   SCM str = ly_str02scm (s);
  69   SCM port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_RDNG,
  70                             "ly_eval_scm_0str");
  71   SCM from = scm_ftell (port);
  72
  73   SCM form;
  74   SCM answer = SCM_UNSPECIFIED;
  75
  76   /* Read expression from port */
  77   if (!SCM_EOF_OBJECT_P (form = scm_read (port)))
  78     answer = scm_primitive_eval (form);
  79
  80   /*
  81    After parsing
  82
  83  (begin (foo 1 2))
  84
  85    all seems fine, but after parsing
  86
  87  (foo 1 2)
  88
  89    read_buf has been advanced to read_pos - 1,
  90    so that scm_ftell returns 1, instead of #parsed chars
  91    */
  92
  93   /*
  94     urg: reset read_buf for scm_ftell
  95     shouldn't scm_read () do this for us?
  96   */
  97   scm_fill_input (port);
  98   SCM to = scm_ftell (port);
  99   *n = gh_scm2int (to) - gh_scm2int (from);
 100
 101   /* Don't close the port here; if we re-enter this function via a
 102      continuation, then the next time we enter it, we'll get an error.
 103      It's a string port anyway, so there's no advantage to closing it
 104      early.
 105
 106      scm_close_port (port);
 107   */
 108
 109   return answer;
 110 }
 111
 112 SCM
 113 ly_quote_scm (SCM s)
 114 {
 115   return scm_list_n (ly_symbol2scm ("quote"), s, SCM_UNDEFINED);
 116 }
 117
 118
 119
 120 String
 121 ly_symbol2string (SCM s)
 122 {
 123   assert (gh_symbol_p (s));
 124   return String ((Byte*)SCM_STRING_CHARS (s), (int) SCM_STRING_LENGTH (s));
 125 }
 126
 127
 128 String
 129 gulp_file_to_string (String fn)
 130 {
 131   String s = global_path.find (fn);
 132   if (s == "")
 133     {
 134       String e = _f ("can't find file: `%s'", fn);
 135       e += " ";
 136       e += _f ("(load path: `%s')", global_path.str ());
 137       error (e);
 138     }
 139   else if (verbose_global_b)
 140     progress_indication ("[" + s);
 141
 142
 143   Simple_file_storage f (s);
 144   String result (f.ch_C ());
 145   if (verbose_global_b)
 146     progress_indication ("]");
 147   return result;
 148 }
 149
 150 SCM
 151 ly_gulp_file (SCM fn)
 152 {
 153   return ly_str02scm (gulp_file_to_string (ly_scm2string (fn)).ch_C ());
 154 }
 155
 156
 157 /**
 158    Read a file, and shove it down GUILE.  GUILE also has file read
 159    functions, but you can't fiddle with the path of those.
 160  */
 161 void
 162 read_lily_scm_file (String fn)
 163 {
 164   gh_eval_str ((char *) gulp_file_to_string (fn).ch_C ());
 165 }
 166
 167 extern "C" {
 168   // maybe gdb 5.0 becomes quicker if it doesn't do fancy C++ typing?
 169 void
 170 ly_display_scm (SCM s)
 171 {
 172   gh_display (s);
 173   gh_newline ();
 174 }
 175 };
 176
 177 String
 178 ly_scm2string (SCM s)
 179 {
 180   assert (gh_string_p (s));
 181
 182   size_t len;
 183   char *p = gh_scm2newstr (s , &len);
 184
 185   String r (p);
 186
 187   free (p);
 188   return r;
 189 }
 190
 191 SCM
 192 index_cell (SCM s, Direction d)
 193 {
 194   assert (d);
 195   return (d == LEFT) ? ly_car (s) : ly_cdr (s);
 196 }
 197
 198 SCM
 199 index_set_cell (SCM s, Direction d, SCM v)
 200 {
 201   if (d == LEFT)
 202     gh_set_car_x (s, v);
 203   else if (d == RIGHT)
 204     gh_set_cdr_x (s, v);
 205   return s;
 206 }
 207
 208 SCM
 209 ly_warning (SCM str)
 210 {
 211   assert (gh_string_p (str));
 212   warning ("lily-guile: " + ly_scm2string (str));
 213   return SCM_BOOL_T;
 214 }
 215
 216 SCM
 217 ly_isdir_p (SCM s)
 218 {
 219   if (gh_number_p (s))
 220     {
 221       int i = gh_scm2int (s);
 222       return (i>= -1 && i <= 1)  ? SCM_BOOL_T : SCM_BOOL_F;
 223     }
 224   return SCM_BOOL_F;
 225 }
 226
 227 bool
 228 ly_number_pair_p (SCM p)
 229 {
 230   return gh_pair_p (p) && gh_number_p (ly_car (p)) && gh_number_p (ly_cdr (p));
 231 }
 232
 233 bool
 234 ly_axis_p (SCM a)
 235 {
 236   return gh_number_p (a) && (gh_scm2int (a) == 0 || gh_scm2int (a) == 1);
 237 }
 238
 239 typedef void (*Void_fptr) ();
 240 Array<Void_fptr> *scm_init_funcs_;
 241
 242 void add_scm_init_func (void (*f) ())
 243 {
 244   if (!scm_init_funcs_)
 245     scm_init_funcs_ = new Array<Void_fptr>;
 246
 247   scm_init_funcs_->push (f);
 248 }
 249
 250 extern  void init_cxx_function_smobs ();
 251
 252 void
 253 prepend_load_path (String p )
 254 {
 255   char s[1024];
 256   sprintf (s,
 257            "(set! %%load-path (cons \"%s\" %%load-path))", p.ch_C());
 258
 259   scm_c_eval_string (s);
 260 }
 261
 262 void
 263 init_lily_guile (String p )
 264 {
 265   prepend_load_path (p);
 266
 267   // todo: junk this. We should make real modules iso. just loading files.
 268   prepend_load_path (p + "/scm/");
 269
 270   SCM last_mod = scm_current_module ();
 271   scm_set_current_module (scm_c_resolve_module ("guile"));
 272
 273   init_cxx_function_smobs ();
 274   for (int i=scm_init_funcs_->size () ; i--;)
 275     (scm_init_funcs_->elem (i)) ();
 276
 277   if (verbose_global_b)
 278     progress_indication ("\n");
 279   read_lily_scm_file ("lily.scm");
 280
 281   scm_set_current_module (last_mod);
 282 }
 283
 284 unsigned int ly_scm_hash (SCM s)
 285 {
 286   return scm_ihashv (s, ~1u);
 287 }
 288
 289
 290
 291 bool
 292 isdir_b (SCM s)
 293 {
 294   if (gh_number_p (s))
 295     {
 296       int i = gh_scm2int (s);
 297       return i>= -1 && i <= 1;
 298     }
 299   return false;
 300 }
 301
 302
 303 bool
 304 isaxis_b (SCM s)
 305 {
 306   if (gh_number_p (s))
 307     {
 308       int i = gh_scm2int (s);
 309       return i== 0 || i == 1;
 310     }
 311   return false;
 312 }
 313
 314
 315 Direction
 316 to_dir (SCM s)
 317 {
 318   return (Direction) gh_scm2int (s);
 319 }
 320
 321 Interval
 322 ly_scm2interval (SCM p)
 323 {
 324   return  Interval (gh_scm2double (ly_car (p)),
 325                     gh_scm2double (ly_cdr (p)));
 326 }
 327
 328 SCM
 329 ly_interval2scm (Interval i)
 330 {
 331   return gh_cons (gh_double2scm (i[LEFT]),
 332                   gh_double2scm (i[RIGHT]));
 333 }
 334
 335
 336
 337
 338 bool
 339 to_boolean (SCM s)
 340 {
 341   return gh_boolean_p (s) && gh_scm2bool (s);
 342 }
 343
 344 /*
 345   Appendable list L: the cdr contains the list, the car the last cons
 346   in the list.
 347  */
 348 SCM
 349 appendable_list ()
 350 {
 351   SCM s = gh_cons (SCM_EOL, SCM_EOL);
 352   gh_set_car_x (s, s);
 353
 354   return s;
 355 }
 356
 357 void
 358 appendable_list_append (SCM l, SCM elt)
 359 {
 360   SCM newcons = gh_cons (elt, SCM_EOL);
 361
 362   gh_set_cdr_x (ly_car (l), newcons);
 363   gh_set_car_x (l, newcons);
 364 }
 365
 366
 367 SCM
 368 ly_offset2scm (Offset o)
 369 {
 370   return gh_cons (gh_double2scm (o[X_AXIS]), gh_double2scm (o[Y_AXIS]));
 371 }
 372
 373 Offset
 374 ly_scm2offset (SCM s)
 375 {
 376   return Offset (gh_scm2double (ly_car (s)),
 377                  gh_scm2double (ly_cdr (s)));
 378 }
 379
 380 SCM
 381 ly_type (SCM exp)
 382 {
 383   char const  * cp = "unknown";
 384   if (gh_number_p (exp))
 385     {
 386       cp = "number";
 387     }
 388   else if (gh_string_p (exp))
 389     {
 390       cp = "string";
 391     }
 392   else if (gh_procedure_p (exp))
 393     {
 394       cp = "procedure";
 395     }
 396   else if (gh_boolean_p (exp))
 397     {
 398       cp = "boolean";
 399     }
 400   else if (gh_pair_p (exp))
 401     {
 402       cp = "list";
 403     }
 404
 405   return ly_str02scm (cp);
 406 }
 407
 408 /*
 409   convert without too many decimals, and leave  a space at the end.
 410  */
 411
 412
 413 SCM
 414 ly_number2string (SCM s)
 415 {
 416   assert (gh_number_p (s));
 417
 418   char str[400];                        // ugh.
 419
 420   if (scm_exact_p (s) == SCM_BOOL_F)
 421     {
 422       Real r (gh_scm2double (s));
 423
 424       if (isinf (r) || isnan (r))
 425         {
 426           programming_error ("Infinity or NaN encountered while converting Real number; setting to zero.");
 427           r = 0.0;
 428         }
 429
 430       sprintf (str, "%8.4f ", r);
 431     }
 432   else
 433     {
 434       sprintf (str, "%d ", gh_scm2int (s));
 435     }
 436
 437   return ly_str02scm (str);
 438 }
 439
 440 /*
 441   Undef this to see if GUILE GC is causing too many swaps.
 442  */
 443
 444 // #define TEST_GC
 445
 446 #ifdef TEST_GC
 447 #include <libguile/gc.h>
 448
 449 static void *
 450 greet_sweep (void *dummy1, void *dummy2, void *dummy3)
 451 {
 452    fprintf (stderr, "entering sweep\n");
 453 }
 454
 455 static void *
 456 wave_sweep_goodbye (void *dummy1, void *dummy2, void *dummy3)
 457 {
 458    fprintf (stderr, "leaving sweep\n");
 459 }
 460 #endif
 461
 462
 463 #include "version.hh"
 464 SCM
 465 ly_version ()
 466 {
 467   char const* vs =  "\' (" MAJOR_VERSION " " MINOR_VERSION " "  PATCH_LEVEL " " MY_PATCH_LEVEL ")" ;
 468
 469   return gh_eval_str ((char*)vs);
 470 }
 471
 472 static void
 473 init_functions ()
 474 {
 475   scm_c_define_gsubr ("ly-warn", 1, 0, 0,
 476                       (Scheme_function_unknown)ly_warning);
 477   scm_c_define_gsubr ("ly-version", 0, 0, 0,
 478                       (Scheme_function_unknown)ly_version);
 479   scm_c_define_gsubr ("ly-gulp-file", 1,0, 0,
 480                       (Scheme_function_unknown)ly_gulp_file);
 481   scm_c_define_gsubr ("dir?", 1,0, 0, (Scheme_function_unknown)ly_isdir_p);
 482   scm_c_define_gsubr ("ly-number->string", 1, 0,0,
 483                       (Scheme_function_unknown) ly_number2string);
 484
 485
 486 #ifdef TEST_GC
 487   scm_c_hook_add (&scm_before_mark_c_hook, greet_sweep, 0, 0);
 488   scm_c_hook_add (&scm_before_sweep_c_hook, wave_sweep_goodbye, 0, 0);
 489 #endif
 490 }
 491
 492 ADD_SCM_INIT_FUNC (funcs, init_functions);
 493
 494 SCM
 495 ly_deep_copy (SCM l)
 496 {
 497   if (gh_pair_p (l))
 498     {
 499       return gh_cons (ly_deep_copy (ly_car (l)), ly_deep_copy (ly_cdr (l)));
 500     }
 501   else
 502     return l;
 503 }
 504
 505
 506
 507
 508 SCM
 509 ly_assoc_chain (SCM key, SCM achain)
 510 {
 511   if (gh_pair_p (achain))
 512     {
 513       SCM handle = scm_assoc (key, ly_car (achain));
 514       if (gh_pair_p (handle))
 515         return handle;
 516       else
 517         return ly_assoc_chain (key, ly_cdr (achain));
 518     }
 519   else
 520     return SCM_BOOL_F;
 521 }
 522
 523 /* looks the key up in the cdrs of the alist-keys
 524    - ignoring the car and ignoring non-pair keys.
 525    Returns first match found, i.e.
 526
 527    alist = ((1 . 10)
 528                    ((1 . 2) . 11)
 529                    ((2 . 1) . 12)
 530                    ((3 . 0) . 13)
 531                    ((4 . 1) . 14) )
 532
 533 I would like (ly_assoc_cdr 1) to return 12 - because it's the first
 534 element with the cdr of the key = 1.  In other words (alloc_cdr key)
 535 corresponds to call
 536
 537 (alloc (anything . key))
 538
 539
 540
 541 */
 542 SCM
 543 ly_assoc_cdr (SCM key, SCM alist)
 544 {
 545   if (gh_pair_p (alist)) {
 546     SCM trykey = ly_caar(alist);
 547     if(gh_pair_p(trykey) && to_boolean(scm_equal_p(key,ly_cdr(trykey))))
 548       return ly_car(alist);
 549     else
 550       return ly_assoc_cdr (key, ly_cdr (alist));
 551   }
 552   else
 553     return SCM_BOOL_F;
 554 }
 555
 556 /*
 557   LIST has the form "sym1 sym2 sym3"
 558  */
 559 SCM
 560 parse_symbol_list (const char * list)
 561 {
 562   char * s = strdup (list);
 563   char *orig = s;
 564   SCM create_list = SCM_EOL;
 565   if (!s[0] )
 566     s = 0;
 567
 568   while (s)
 569     {
 570       char *next = strchr (s, ' ');
 571       if (next)
 572         *next++ = 0;
 573
 574       create_list = gh_cons (ly_symbol2scm (s), create_list);
 575       s = next;
 576     }
 577
 578   free (orig);
 579   return create_list;
 580 }
 581
 582
 583 SCM
 584 ly_truncate_list (int k, SCM l )
 585 {
 586   if (k == 0)
 587     {
 588       l = SCM_EOL;
 589     }
 590   else
 591     {
 592       SCM s = l;
 593       k--;
 594       for (; gh_pair_p (s) && k--; s = ly_cdr (s))
 595         ;
 596
 597       if (gh_pair_p (s))
 598         {
 599           gh_set_cdr_x (s, SCM_EOL);
 600         }
 601     }
 602   return l;
 603 }
 604
 605 SCM my_gh_symbol2scm (const char* x)
 606 {
 607   return gh_symbol2scm ((char*)x);
 608 }