2 lily-guile.cc -- implement assorted Guile bindings
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
14 #include <cstring> /* memset */
17 #include "international.hh"
18 #include "libc-extension.hh"
19 #include "lily-guile.hh"
23 #include "dimensions.hh"
25 #include "file-path.hh"
26 #include "relocate.hh"
27 #include "file-name.hh"
28 #include "string-convert.hh"
30 LY_DEFINE (ly_find_file, "ly:find-file",
32 "Return the absolute file name of @var{name}, "
33 "or @code{#f} if not found.")
35 SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
37 string nm = ly_scm2string (name);
38 string file_name = global_path.find (nm);
39 if (file_name.empty ())
42 return ly_string2scm (file_name);
46 Ugh. Gulped file is copied twice. (maybe thrice if you count stdio
49 LY_DEFINE (ly_gulp_file, "ly:gulp-file",
50 1, 1, 0, (SCM name, SCM size),
51 "Read the file @var{name}, and return its contents in a string. "
52 "The file is looked up using the search path. ")
54 SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
56 if (size != SCM_UNDEFINED)
58 SCM_ASSERT_TYPE (scm_is_number (size), size, SCM_ARG2, __FUNCTION__, "number");
59 sz = scm_to_int (size);
62 string contents = gulp_file_to_string (ly_scm2string (name), true, sz);
63 return scm_from_locale_stringn (contents.c_str (), contents.length ());
66 LY_DEFINE (ly_error, "ly:error",
67 1, 0, 1, (SCM str, SCM rest),
68 "Scheme callable function to issue the error @code{msg}. "
69 "The error is formatted with @code{format} and @code{rest}.")
71 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
72 str = scm_simple_format (SCM_BOOL_F, str, rest);
73 error (ly_scm2string (str));
74 return SCM_UNSPECIFIED;
77 LY_DEFINE (ly_message, "ly:message",
78 1, 0, 1, (SCM str, SCM rest),
79 "Scheme callable function to issue the message @code{msg}. "
80 "The message is formatted with @code{format} and @code{rest}.")
82 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
83 str = scm_simple_format (SCM_BOOL_F, str, rest);
84 message (ly_scm2string (str));
85 return SCM_UNSPECIFIED;
88 LY_DEFINE (ly_progress, "ly:progress",
89 1, 0, 1, (SCM str, SCM rest),
90 "Scheme callable function to print progress @code{str}. "
91 "The message is formatted with @code{format} and @code{rest}.")
93 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
94 str = scm_simple_format (SCM_BOOL_F, str, rest);
95 progress_indication (ly_scm2string (str));
96 return SCM_UNSPECIFIED;
99 LY_DEFINE (ly_programming_error, "ly:programming-error",
100 1, 0, 1, (SCM str, SCM rest),
101 "Scheme callable function to issue the warning @code{msg}. "
102 "The message is formatted with @code{format} and @code{rest}.")
104 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
105 str = scm_simple_format (SCM_BOOL_F, str, rest);
106 programming_error (ly_scm2string (str));
107 return SCM_UNSPECIFIED;
110 LY_DEFINE (ly_warning, "ly:warning",
111 1, 0, 1, (SCM str, SCM rest),
112 "Scheme callable function to issue the warning @code{str}. "
113 "The message is formatted with @code{format} and @code{rest}.")
115 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
116 str = scm_simple_format (SCM_BOOL_F, str, rest);
117 warning (ly_scm2string (str));
118 return SCM_UNSPECIFIED;
121 LY_DEFINE (ly_dir_p, "ly:dir?",
123 "type predicate. A direction is @code{-1}, @code{0} or "
124 "@code{1}, where @code{-1} represents "
125 "left or down and @code{1} represents right or up.")
127 if (scm_is_number (s))
129 int i = scm_to_int (s);
130 return (i >= -1 && i <= 1) ? SCM_BOOL_T : SCM_BOOL_F;
135 LY_DEFINE (ly_assoc_get, "ly:assoc-get",
137 (SCM key, SCM alist, SCM default_value),
138 "Return value if KEY in ALIST, else DEFAULT-VALUE "
139 "(or #f if not specified).")
141 SCM handle = scm_assoc (key, alist);
142 if (scm_is_pair (handle))
143 return scm_cdr (handle);
145 if (default_value == SCM_UNDEFINED)
146 default_value = SCM_BOOL_F;
148 return default_value;
151 LY_DEFINE (ly_string_substitute, "ly:string-substitute",
152 3, 0, 0, (SCM a, SCM b, SCM s),
153 "Replace @var{a} by @var{b} in @var{s}.")
155 SCM_ASSERT_TYPE (scm_is_string (a), s, SCM_ARG1, __FUNCTION__, "string");
156 SCM_ASSERT_TYPE (scm_is_string (b), s, SCM_ARG2, __FUNCTION__, "string");
157 SCM_ASSERT_TYPE (scm_is_string (s), s, SCM_ARG3, __FUNCTION__, "string");
159 string ss = ly_scm2string (s);
160 replace_all (ss, string (scm_i_string_chars (a)),
161 string (scm_i_string_chars (b)));
162 return ly_string2scm (ss);
165 LY_DEFINE (ly_number2string, "ly:number->string",
167 "Convert @var{num} to a string without generating many decimals.")
169 SCM_ASSERT_TYPE (scm_is_number (s), s, SCM_ARG1, __FUNCTION__, "number");
171 char str[400]; // ugh.
173 if (scm_exact_p (s) == SCM_BOOL_F)
175 Real r (scm_to_double (s));
176 if (isinf (r) || isnan (r))
178 programming_error (_ ("infinity or NaN encountered while converting Real number"));
179 programming_error (_ ("setting to zero"));
184 snprintf (str, sizeof (str), "%.4f", r);
187 snprintf (str, sizeof (str), "%d", int (scm_to_int (s)));
189 return scm_from_locale_string (str);
192 LY_DEFINE (ly_version, "ly:version", 0, 0, 0, (),
193 "Return the current lilypond version as a list, e.g. @code{(1 3 127 uu1)}. ")
195 char const *vs = "\'(" MAJOR_VERSION " " MINOR_VERSION " " PATCH_LEVEL " " MY_PATCH_LEVEL ")";
197 return scm_c_eval_string ((char *)vs);
200 LY_DEFINE (ly_unit, "ly:unit", 0, 0, 0, (),
201 "Return the unit used for lengths as a string.")
203 return scm_from_locale_string (INTERNAL_UNIT);
206 LY_DEFINE (ly_dimension_p, "ly:dimension?", 1, 0, 0, (SCM d),
207 "Return @var{d} is a number. Used to distinguish length "
208 "variables from normal numbers.")
210 return scm_number_p (d);
216 LY_DEFINE (ly_protects, "ly:protects",
218 "Return hash of protected objects.")
223 LY_DEFINE (ly_gettext, "ly:gettext",
224 1, 0, 0, (SCM string),
227 SCM_ASSERT_TYPE (scm_is_string (string), string, SCM_ARG1,
228 __FUNCTION__, "string");
229 return ly_string2scm (_ (scm_i_string_chars (string)));
232 LY_DEFINE (ly_output_backend, "ly:output-backend",
234 "Return name of output backend.")
236 return ly_string2scm (output_backend_global);
239 LY_DEFINE (ly_output_formats, "ly:output-formats",
241 "Formats passed to --format as a list of strings, "
242 "used for the output.")
244 vector<string> output_formats = string_split (output_format_global, ',');
247 int output_formats_count = output_formats.size ();
248 for (int i = 0; i < output_formats_count; i++)
249 lst = scm_cons (ly_string2scm (output_formats[i]), lst);
254 LY_DEFINE (ly_wchar_to_utf_8, "ly:wide-char->utf-8",
256 "Encode the Unicode codepoint @var{wc}, an integer, as UTF-8")
260 SCM_ASSERT_TYPE (scm_is_integer (wc), wc, SCM_ARG1, __FUNCTION__, "integer");
261 unsigned wide_char = (unsigned) scm_to_int (wc);
264 if (wide_char < 0x0080)
265 *p++ = (char)wide_char;
266 else if (wide_char < 0x0800)
268 *p++ = (char) (((wide_char >> 6)) | 0xC0);
269 *p++ = (char) (((wide_char) & 0x3F) | 0x80);
271 else if (wide_char < 0x10000)
273 *p++ = (char) (((wide_char >> 12)) | 0xE0);
274 *p++ = (char) (((wide_char >> 6) & 0x3F) | 0x80);
275 *p++ = (char) (((wide_char) & 0x3F) | 0x80);
279 *p++ = (char) (((wide_char >> 18)) | 0xF0);
280 *p++ = (char) (((wide_char >> 12) & 0x3F) | 0x80);
281 *p++ = (char) (((wide_char >> 6) & 0x3F) | 0x80);
282 *p++ = (char) (((wide_char) & 0x3F) | 0x80);
286 return scm_from_locale_string (buf);
289 LY_DEFINE (ly_effective_prefix, "ly:effective-prefix",
291 "Return effective prefix.")
293 return ly_string2scm (prefix_directory);
296 LY_DEFINE (ly_chain_assoc_get, "ly:chain-assoc-get",
297 2, 1, 0, (SCM key, SCM achain, SCM dfault),
298 "Return value for @var{key} from a list of alists @var{achain}. "
299 "If no if no entry is found, return DFAULT, "
300 "or #f if no DFAULT not specified.")
302 if (scm_is_pair (achain))
304 SCM handle = scm_assoc (key, scm_car (achain));
305 if (scm_is_pair (handle))
306 return scm_cdr (handle);
308 return ly_chain_assoc_get (key, scm_cdr (achain), dfault);
310 return dfault == SCM_UNDEFINED ? SCM_BOOL_F : dfault;
314 LY_DEFINE (ly_stderr_redirect, "ly:stderr-redirect",
315 1, 1, 0, (SCM file_name, SCM mode),
316 "Redirect stderr to FILE-NAME, opened with MODE.")
318 SCM_ASSERT_TYPE (scm_is_string (file_name), file_name, SCM_ARG1,
319 __FUNCTION__, "file_name");
322 if (mode != SCM_UNDEFINED && scm_string_p (mode))
323 m = ly_scm2string (mode);
324 /* dup2 and (fileno (current-error-port)) do not work with mingw'c
327 freopen (ly_scm2string (file_name).c_str (), m.c_str (), stderr);
328 return SCM_UNSPECIFIED;
332 accumulate_symbol (void *closure, SCM key, SCM val, SCM result)
336 return scm_cons (key, result);
339 LY_DEFINE(ly_hash_table_keys, "ly:hash-table-keys",
341 "return a list of keys in @var{tab}")
343 return scm_internal_hash_fold ((Hash_closure_function) & accumulate_symbol,
347 LY_DEFINE (ly_camel_case_to_lisp_identifier, "ly:camel-case->lisp-identifier",
348 1, 0, 0, (SCM name_sym),
349 "Convert FooBar_Bla to foo-bar-bla style symbol.")
351 SCM_ASSERT_TYPE(scm_is_symbol (name_sym), name_sym,
352 SCM_ARG1, __FUNCTION__, "symbol");
355 TODO: should use strings instead?
358 const string in = ly_symbol2string (name_sym);
359 string result = camel_case_to_lisp_identifier (in);
361 return ly_symbol2scm (result.c_str ());
364 LY_DEFINE (ly_expand_environment, "ly:expand-environment",
366 "Expand $VAR and $@{VAR@} in @var{str}.")
368 SCM_ASSERT_TYPE(scm_is_string (str), str,
369 SCM_ARG1, __FUNCTION__, "string");
371 return ly_string2scm (expand_environment_variables (ly_scm2string (str)));
375 LY_DEFINE (ly_truncate_list_x, "ly:truncate-list!",
376 2, 0, 0, (SCM lst, SCM i),
377 "Take at most the first @var{i} of list @var{lst}")
379 SCM_ASSERT_TYPE(scm_is_integer (i), i,
380 SCM_ARG1, __FUNCTION__, "integer");
382 int k = scm_to_int (i);
389 for (; scm_is_pair (s) && k--; s = scm_cdr (s))
393 scm_set_cdr_x (s, SCM_EOL);
399 format_single_argument (SCM arg, int precision)
401 if (scm_is_integer (arg) && scm_exact_p (arg) == SCM_BOOL_T)
402 return (String_convert::int_string (scm_to_int (arg)));
403 else if (scm_is_number (arg))
405 Real val = scm_to_double (arg);
407 if (isnan (val) || isinf (val))
409 warning (_ ("Found infinity or nan in output. Substituting 0.0"));
411 if (strict_infinity_checking)
415 return (String_convert::form_string ("%.*lf", precision, val));
417 else if (scm_is_string (arg))
418 return (ly_scm2string (arg));
419 else if (scm_is_symbol (arg))
420 return (ly_symbol2string (arg));
423 ly_progress (scm_from_locale_string ("Unsupported SCM value for format: ~a"),
431 LY_DEFINE (ly_format, "ly:format",
432 1, 0, 1, (SCM str, SCM rest),
433 "LilyPond specific format, supporting ~a ~[0-9]f.")
435 SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string");
437 string format = ly_scm2string (str);
438 vector<string> results;
441 while (i < format.size())
443 vsize tilde = format.find ('~', i);
445 results.push_back (format.substr (i, (tilde-i)));
452 char spec = format.at (tilde ++);
454 results.push_back ("~");
457 if (!scm_is_pair (rest))
459 programming_error (string (__FUNCTION__)
460 + ": not enough arguments for format.");
461 return ly_string2scm ("");
464 SCM arg = scm_car (rest);
465 rest = scm_cdr (rest);
471 else if (isdigit (spec))
473 precision = spec - '0';
474 spec = format.at (tilde ++);
477 if (spec == 'a' || spec == 'f')
478 results.push_back (format_single_argument (arg, precision));
479 else if (spec == 'l')
482 for (; scm_is_pair (s); s = scm_cdr (s))
484 results.push_back (format_single_argument (scm_car (s), precision));
485 if (scm_cdr (s) != SCM_EOL)
486 results.push_back (" ");
490 results.push_back (format_single_argument (s, precision));
498 if (scm_is_pair (rest))
499 programming_error (string (__FUNCTION__)
500 + ": too many arguments");
503 for (vsize i = 0; i < results.size(); i++)
504 len += results[i].size();
506 char *result = (char*) scm_malloc (len + 1);
508 for (vsize i = 0; i < results.size(); i++)
510 strncpy (ptr, results[i].c_str (), results[i].size());
511 ptr += results[i].size();
515 return scm_take_locale_stringn (result, len);