lily/general-scheme.cc

   1 /*
   2   lily-guile.cc -- implement assorted Guile bindings
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>
   8 */
   9
  10 #include "config.hh"
  11
  12 #include <cstdio>
  13 #include <ctype.h>
  14 #include <cstring>  /* memset */
  15 using namespace std;
  16
  17 #include "international.hh"
  18 #include "libc-extension.hh"
  19 #include "lily-guile.hh"
  20 #include "misc.hh"
  21 #include "warn.hh"
  22 #include "version.hh"
  23 #include "dimensions.hh"
  24 #include "main.hh"
  25 #include "file-path.hh"
  26 #include "relocate.hh"
  27 #include "file-name.hh"
  28 #include "string-convert.hh"
  29
  30 LY_DEFINE (ly_start_environment, "ly:start-environment",
  31            0, 0, 0, (),
  32            "Return the environment (a list of strings) that was in"
  33            " effect at program start.")
  34 {
  35   SCM l = SCM_EOL;
  36   SCM *tail = &l;
  37
  38   for (vsize i = 0; i < start_environment_global.size (); i++)
  39     {
  40       *tail = scm_cons (ly_string2scm (start_environment_global[i]),
  41                         SCM_EOL);
  42       tail = SCM_CDRLOC(*tail);
  43     }
  44
  45   return l;
  46 }
  47
  48
  49 LY_DEFINE (ly_find_file, "ly:find-file",
  50            1, 0, 0, (SCM name),
  51            "Return the absolute file name of @var{name},"
  52            " or @code{#f} if not found.")
  53 {
  54   LY_ASSERT_TYPE (scm_is_string, name, 1);
  55
  56   string nm = ly_scm2string (name);
  57   string file_name = global_path.find (nm);
  58   if (file_name.empty ())
  59     return SCM_BOOL_F;
  60
  61   return ly_string2scm (file_name);
  62 }
  63
  64 /*
  65   Ugh. Gulped file is copied twice. (maybe thrice if you count stdio
  66   buffering.)
  67 */
  68 LY_DEFINE (ly_gulp_file, "ly:gulp-file",
  69            1, 1, 0, (SCM name, SCM size),
  70            "Read the file @var{name}, and return its contents in a string."
  71            "  The file is looked up using the search path.")
  72 {
  73   LY_ASSERT_TYPE (scm_is_string, name, 1);
  74   int sz = INT_MAX;
  75   if (size != SCM_UNDEFINED)
  76     {
  77       LY_ASSERT_TYPE (scm_is_number, size, 2);
  78       sz = scm_to_int (size);
  79     }
  80
  81   string contents = gulp_file_to_string (ly_scm2string (name), true, sz);
  82   return scm_from_locale_stringn (contents.c_str (), contents.length ());
  83 }
  84
  85 LY_DEFINE (ly_error, "ly:error",
  86            1, 0, 1, (SCM str, SCM rest),
  87            "A Scheme callable function to issue the error @var{str}."
  88            "  The error is formatted with @code{format} and @var{rest}.")
  89 {
  90   LY_ASSERT_TYPE (scm_is_string, str, 1);
  91   str = scm_simple_format (SCM_BOOL_F, str, rest);
  92   error (ly_scm2string (str));
  93   return SCM_UNSPECIFIED;
  94 }
  95
  96 LY_DEFINE (ly_message, "ly:message",
  97            1, 0, 1, (SCM str, SCM rest),
  98            "A Scheme callable function to issue the message @var{str}."
  99            "  The message is formatted with @code{format} and @var{rest}.")
 100 {
 101   LY_ASSERT_TYPE (scm_is_string, str, 1);
 102   str = scm_simple_format (SCM_BOOL_F, str, rest);
 103   message (ly_scm2string (str));
 104   return SCM_UNSPECIFIED;
 105 }
 106
 107 LY_DEFINE (ly_progress, "ly:progress",
 108            1, 0, 1, (SCM str, SCM rest),
 109            "A Scheme callable function to print progress @var{str}."
 110            "  The message is formatted with @code{format} and @var{rest}.")
 111 {
 112   LY_ASSERT_TYPE (scm_is_string, str, 1);
 113   str = scm_simple_format (SCM_BOOL_F, str, rest);
 114   progress_indication (ly_scm2string (str));
 115   return SCM_UNSPECIFIED;
 116 }
 117
 118 LY_DEFINE (ly_programming_error, "ly:programming-error",
 119            1, 0, 1, (SCM str, SCM rest),
 120            "A Scheme callable function to issue the internal warning"
 121            "  @var{str}.  The message is formatted with @code{format}"
 122            " and @var{rest}.")
 123 {
 124   LY_ASSERT_TYPE (scm_is_string, str, 1);
 125   str = scm_simple_format (SCM_BOOL_F, str, rest);
 126   programming_error (ly_scm2string (str));
 127   return SCM_UNSPECIFIED;
 128 }
 129
 130 LY_DEFINE (ly_warning, "ly:warning",
 131            1, 0, 1, (SCM str, SCM rest),
 132            "A Scheme callable function to issue the warning @code{str}."
 133            "  The message is formatted with @code{format} and @code{rest}.")
 134 {
 135   LY_ASSERT_TYPE (scm_is_string, str, 1);
 136   str = scm_simple_format (SCM_BOOL_F, str, rest);
 137   warning (ly_scm2string (str));
 138   return SCM_UNSPECIFIED;
 139 }
 140
 141 LY_DEFINE (ly_dir_p, "ly:dir?",
 142            1, 0, 0, (SCM s),
 143            "Is @var{s} a direction?  Valid directions are @code{-1},"
 144            " @code{0}, or@tie{}@code{1}, where @code{-1} represents"
 145            " left or down, @code{1}@tie{}represents right or up, and @code{0}"
 146            " represents a neutral direction.")
 147 {
 148   if (scm_is_number (s))
 149     {
 150       int i = scm_to_int (s);
 151       return (i >= -1 && i <= 1) ? SCM_BOOL_T : SCM_BOOL_F;
 152     }
 153   return SCM_BOOL_F;
 154 }
 155
 156 LY_DEFINE (ly_assoc_get, "ly:assoc-get",
 157            2, 1, 0,
 158            (SCM key, SCM alist, SCM default_value),
 159            "Return value if @var{key} in @var{alist}, else @code{default-value}"
 160            " (or @code{#f} if not specified).")
 161 {
 162   LY_ASSERT_TYPE(ly_cheap_is_list, alist, 2);
 163
 164   SCM handle = scm_assoc (key, alist);
 165   if (scm_is_pair (handle))
 166     return scm_cdr (handle);
 167
 168   if (default_value == SCM_UNDEFINED)
 169     default_value = SCM_BOOL_F;
 170
 171   return default_value;
 172 }
 173
 174 LY_DEFINE (ly_string_substitute, "ly:string-substitute",
 175            3, 0, 0, (SCM a, SCM b, SCM s),
 176            "Replace string@tie{}@var{a} by string@tie{}@var{b} in"
 177            " string@tie{}@var{s}.")
 178 {
 179   LY_ASSERT_TYPE (scm_is_string, s, 1);
 180   LY_ASSERT_TYPE (scm_is_string, b, 2);
 181   LY_ASSERT_TYPE (scm_is_string, s, 3);
 182
 183   string ss = ly_scm2string (s);
 184   replace_all (&ss, ly_scm2string (a),
 185                ly_scm2string (b));
 186
 187   return ly_string2scm (ss);
 188 }
 189
 190 LY_DEFINE (ly_number_2_string, "ly:number->string",
 191            1, 0, 0, (SCM s),
 192            "Convert @var{num} to a string without generating many decimals.")
 193 {
 194   LY_ASSERT_TYPE (scm_is_number, s, 1);
 195
 196   char str[400];                        // ugh.
 197
 198   if (scm_exact_p (s) == SCM_BOOL_F)
 199     {
 200       Real r (scm_to_double (s));
 201         if (isinf (r) || isnan (r))
 202           {
 203             programming_error (_ ("infinity or NaN encountered while converting Real number"));
 204             programming_error (_ ("setting to zero"));
 205
 206             r = 0.0;
 207           }
 208
 209       snprintf (str, sizeof (str), "%.4f", r);
 210     }
 211   else
 212     snprintf (str, sizeof (str), "%d", int (scm_to_int (s)));
 213
 214   return scm_from_locale_string (str);
 215 }
 216
 217 LY_DEFINE (ly_version, "ly:version", 0, 0, 0, (),
 218            "Return the current lilypond version as a list, e.g.,"
 219            " @code{(1 3 127 uu1)}.")
 220 {
 221   char const *vs = "\'(" MAJOR_VERSION " " MINOR_VERSION " " PATCH_LEVEL " " MY_PATCH_LEVEL ")";
 222
 223   return scm_c_eval_string ((char *)vs);
 224 }
 225
 226 LY_DEFINE (ly_unit, "ly:unit", 0, 0, 0, (),
 227            "Return the unit used for lengths as a string.")
 228 {
 229   return scm_from_locale_string (INTERNAL_UNIT);
 230 }
 231
 232 LY_DEFINE (ly_dimension_p, "ly:dimension?", 1, 0, 0, (SCM d),
 233            "Return @var{d} as a number.  Used to distinguish length"
 234            " variables from normal numbers.")
 235 {
 236   return scm_number_p (d);
 237 }
 238
 239 /*
 240   Debugging mem leaks:
 241 */
 242 LY_DEFINE (ly_protects, "ly:protects",
 243            0, 0, 0, (),
 244            "Return hash of protected objects.")
 245 {
 246   return scm_protects;
 247 }
 248
 249 LY_DEFINE (ly_gettext, "ly:gettext",
 250            1, 0, 0, (SCM original),
 251            "A Scheme wrapper function for @code{gettext}.")
 252 {
 253   LY_ASSERT_TYPE (scm_is_string, original, 1);
 254   return ly_string2scm (_ (ly_scm2string (original).c_str ()));
 255 }
 256
 257 LY_DEFINE (ly_output_formats, "ly:output-formats",
 258            0, 0, 0, (),
 259            "Formats passed to @option{--format} as a list of strings,"
 260            " used for the output.")
 261 {
 262   vector<string> output_formats = string_split (output_format_global, ',');
 263
 264   SCM lst = SCM_EOL;
 265   int output_formats_count = output_formats.size ();
 266   for (int i = 0; i < output_formats_count; i++)
 267     lst = scm_cons (ly_string2scm (output_formats[i]), lst);
 268
 269   return lst;
 270 }
 271
 272 LY_DEFINE (ly_wide_char_2_utf_8, "ly:wide-char->utf-8",
 273            1, 0, 0, (SCM wc),
 274            "Encode the Unicode codepoint @var{wc}, an integer, as UTF-8.")
 275 {
 276   char buf[5];
 277
 278   LY_ASSERT_TYPE (scm_is_integer, wc, 1);
 279   unsigned wide_char = (unsigned) scm_to_int (wc);
 280   char *p = buf;
 281
 282   if (wide_char < 0x0080)
 283     *p++ = (char)wide_char;
 284   else if (wide_char < 0x0800)
 285     {
 286       *p++ = (char) (((wide_char >> 6)) | 0xC0);
 287       *p++ = (char) (((wide_char) & 0x3F) | 0x80);
 288     }
 289   else if (wide_char < 0x10000)
 290     {
 291       *p++ = (char) (((wide_char >> 12)) | 0xE0);
 292       *p++ = (char) (((wide_char >> 6) & 0x3F) | 0x80);
 293       *p++ = (char) (((wide_char) & 0x3F) | 0x80);
 294     }
 295   else
 296     {
 297       *p++ = (char) (((wide_char >> 18)) | 0xF0);
 298       *p++ = (char) (((wide_char >> 12) & 0x3F) | 0x80);
 299       *p++ = (char) (((wide_char >> 6) & 0x3F) | 0x80);
 300       *p++ = (char) (((wide_char) & 0x3F) | 0x80);
 301     }
 302   *p = 0;
 303
 304   return scm_from_locale_string (buf);
 305 }
 306
 307 LY_DEFINE (ly_effective_prefix, "ly:effective-prefix",
 308            0, 0, 0, (),
 309            "Return effective prefix.")
 310 {
 311   return ly_string2scm (lilypond_datadir);
 312 }
 313
 314 LY_DEFINE (ly_chain_assoc_get, "ly:chain-assoc-get",
 315            2, 1, 0, (SCM key, SCM achain, SCM val),
 316            "Return value for @var{key} from a list of alists @var{achain}."
 317            "  If no entry is found, return @var{val} or @code{#f} if"
 318            " @var{val} is not specified.")
 319 {
 320   if (scm_is_pair (achain))
 321     {
 322       SCM handle = scm_assoc (key, scm_car (achain));
 323       if (scm_is_pair (handle))
 324         return scm_cdr (handle);
 325       else
 326         return ly_chain_assoc_get (key, scm_cdr (achain), val);
 327     }
 328   return val == SCM_UNDEFINED ? SCM_BOOL_F : val;
 329 }
 330
 331
 332 LY_DEFINE (ly_stderr_redirect, "ly:stderr-redirect",
 333            1, 1, 0, (SCM file_name, SCM mode),
 334            "Redirect stderr to @var{file-name}, opened with @var{mode}.")
 335 {
 336   LY_ASSERT_TYPE (scm_is_string, file_name, 1);
 337
 338   string m = "w";
 339   if (mode != SCM_UNDEFINED && scm_string_p (mode))
 340     m = ly_scm2string (mode);
 341   /* dup2 and (fileno (current-error-port)) do not work with mingw'c
 342      gcc -mwindows.  */
 343   fflush (stderr);
 344   freopen (ly_scm2string (file_name).c_str (), m.c_str (), stderr);
 345   return SCM_UNSPECIFIED;
 346 }
 347
 348 static SCM
 349 accumulate_symbol (void * /* closure */,
 350                    SCM key,
 351                    SCM /* val */,
 352                    SCM result)
 353 {
 354   return scm_cons (key, result);
 355 }
 356
 357 LY_DEFINE (ly_hash_table_keys, "ly:hash-table-keys",
 358           1,0,0, (SCM tab),
 359           "Return a list of keys in @var{tab}.")
 360 {
 361   return scm_internal_hash_fold ((Hash_closure_function) & accumulate_symbol,
 362                                  NULL, SCM_EOL, tab);
 363 }
 364
 365 LY_DEFINE (ly_camel_case_2_lisp_identifier, "ly:camel-case->lisp-identifier",
 366            1, 0, 0, (SCM name_sym),
 367            "Convert @code{FooBar_Bla} to @code{foo-bar-bla} style symbol.")
 368 {
 369   LY_ASSERT_TYPE (ly_is_symbol, name_sym, 1);
 370
 371   /*
 372     TODO: should use strings instead?
 373   */
 374
 375   const string in = ly_symbol2string (name_sym);
 376   string result = camel_case_to_lisp_identifier (in);
 377
 378   return ly_symbol2scm (result.c_str ());
 379 }
 380
 381 LY_DEFINE (ly_expand_environment, "ly:expand-environment",
 382            1, 0, 0, (SCM str),
 383            "Expand @code{$VAR} and @code{$@{VAR@}} in @var{str}.")
 384 {
 385   LY_ASSERT_TYPE (scm_is_string, str, 1);
 386
 387   return ly_string2scm (expand_environment_variables (ly_scm2string (str)));
 388 }
 389
 390
 391 LY_DEFINE (ly_truncate_list_x, "ly:truncate-list!",
 392            2, 0, 0, (SCM lst, SCM i),
 393            "Take at most the first @var{i} of list @var{lst}.")
 394 {
 395   LY_ASSERT_TYPE (scm_is_integer, i, 1);
 396
 397   int k = scm_to_int (i);
 398   if (k == 0)
 399     lst = SCM_EOL;
 400   else
 401     {
 402       SCM s = lst;
 403       k--;
 404       for (; scm_is_pair (s) && k--; s = scm_cdr (s))
 405         ;
 406
 407       if (scm_is_pair (s))
 408         scm_set_cdr_x (s, SCM_EOL);
 409     }
 410   return lst;
 411 }
 412
 413 string
 414 format_single_argument (SCM arg, int precision)
 415 {
 416   if (scm_is_integer (arg) && scm_exact_p (arg) == SCM_BOOL_T)
 417     return (String_convert::int_string (scm_to_int (arg)));
 418   else if (scm_is_number (arg))
 419     {
 420       Real val = scm_to_double (arg);
 421
 422       if (isnan (val) || isinf (val))
 423         {
 424           warning (_ ("Found infinity or nan in output. Substituting 0.0"));
 425           return ("0.0");
 426           if (strict_infinity_checking)
 427             abort ();
 428         }
 429       else
 430         return (String_convert::form_string ("%.*lf", precision, val));
 431     }
 432   else if (scm_is_string (arg))
 433     return (ly_scm2string (arg));
 434   else if (scm_is_symbol (arg))
 435     return (ly_symbol2string (arg));
 436   else
 437     {
 438       ly_progress (scm_from_locale_string ("Unsupported SCM value for format: ~a"),
 439                    scm_list_1 (arg));
 440     }
 441
 442
 443   return "";
 444 }
 445
 446 LY_DEFINE (ly_format, "ly:format",
 447            1, 0, 1, (SCM str, SCM rest),
 448            "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}.")
 449 {
 450   LY_ASSERT_TYPE (scm_is_string, str, 1);
 451
 452   string format = ly_scm2string (str);
 453   vector<string> results;
 454
 455   vsize i = 0;
 456   while (i < format.size ())
 457     {
 458       vsize tilde = format.find ('~', i);
 459
 460       results.push_back (format.substr (i, (tilde-i)));
 461
 462       if (tilde == NPOS)
 463         break ;
 464
 465       tilde ++;
 466
 467       char spec = format.at (tilde ++);
 468       if (spec == '~')
 469         results.push_back ("~");
 470       else
 471         {
 472           if (!scm_is_pair (rest))
 473             {
 474               programming_error (string (__FUNCTION__)
 475                                  + ": not enough arguments for format.");
 476               return ly_string2scm ("");
 477             }
 478
 479           SCM arg = scm_car (rest);
 480           rest = scm_cdr (rest);
 481
 482           int precision = 8;
 483
 484           if (spec == '$')
 485             precision = 2;
 486           else if (isdigit (spec))
 487             {
 488               precision = spec - '0';
 489               spec = format.at (tilde ++);
 490             }
 491
 492           if (spec == 'a' || spec == 'A' || spec == 'f' || spec == '$')
 493             results.push_back (format_single_argument (arg, precision));
 494           else if (spec == 'l')
 495             {
 496               SCM s = arg;
 497               for (; scm_is_pair (s); s = scm_cdr (s))
 498                 {
 499                   results.push_back (format_single_argument (scm_car (s), precision));
 500                   if (scm_cdr (s) != SCM_EOL)
 501                     results.push_back (" ");
 502                 }
 503
 504               if (s != SCM_EOL)
 505                 results.push_back (format_single_argument (s, precision));
 506
 507             }
 508         }
 509
 510       i = tilde;
 511     }
 512
 513   if (scm_is_pair (rest))
 514     programming_error (string (__FUNCTION__)
 515                        + ": too many  arguments");
 516
 517   vsize len = 0;
 518   for (vsize i = 0; i < results.size (); i++)
 519     len += results[i].size ();
 520
 521   char *result = (char*) scm_malloc (len + 1);
 522   char *ptr = result;
 523   for (vsize i = 0; i < results.size (); i++)
 524     {
 525       strncpy (ptr, results[i].c_str (), results[i].size ());
 526       ptr += results[i].size ();
 527     }
 528   *ptr = '\0';
 529
 530   return scm_take_locale_stringn (result, len);
 531 }