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