X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgeneral-scheme.cc;h=8b5766387e0de808afe9c81d567c5cd9dfc16844;hb=840936be1b28526ef292b5dae8ae031b4fa587f9;hp=cbc3b605ed13c9be41229f04db1119f952b772f4;hpb=d1f044d19e0e3c163374973ee8a6c61611c3408e;p=lilypond.git diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc index cbc3b605ed..8b5766387e 100644 --- a/lily/general-scheme.cc +++ b/lily/general-scheme.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1998--2007 Jan Nieuwenhuizen + (c) 1998--2009 Jan Nieuwenhuizen Han-Wen Nienhuys */ @@ -27,12 +27,31 @@ using namespace std; #include "file-name.hh" #include "string-convert.hh" +LY_DEFINE (ly_start_environment, "ly:start-environment", + 0, 0, 0, (), + "Return the environment (a list of strings) that was in" + " effect at program start.") +{ + SCM l = SCM_EOL; + SCM *tail = &l; + + for (vsize i = 0; i < start_environment_global.size (); i++) + { + *tail = scm_cons (ly_string2scm (start_environment_global[i]), + SCM_EOL); + tail = SCM_CDRLOC(*tail); + } + + return l; +} + + LY_DEFINE (ly_find_file, "ly:find-file", 1, 0, 0, (SCM name), - "Return the absolute file name of @var{name}, " - "or @code{#f} if not found.") + "Return the absolute file name of @var{name}," + " or @code{#f} if not found.") { - SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, name, 1); string nm = ly_scm2string (name); string file_name = global_path.find (nm); @@ -48,14 +67,14 @@ LY_DEFINE (ly_find_file, "ly:find-file", */ LY_DEFINE (ly_gulp_file, "ly:gulp-file", 1, 1, 0, (SCM name, SCM size), - "Read the file @var{name}, and return its contents in a string. " - "The file is looked up using the search path. ") + "Read the file @var{name}, and return its contents in a string." + " The file is looked up using the search path.") { - SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, name, 1); int sz = INT_MAX; if (size != SCM_UNDEFINED) { - SCM_ASSERT_TYPE (scm_is_number (size), size, SCM_ARG2, __FUNCTION__, "number"); + LY_ASSERT_TYPE (scm_is_number, size, 2); sz = scm_to_int (size); } @@ -65,10 +84,10 @@ LY_DEFINE (ly_gulp_file, "ly:gulp-file", LY_DEFINE (ly_error, "ly:error", 1, 0, 1, (SCM str, SCM rest), - "Scheme callable function to issue the error @code{msg}. " - "The error is formatted with @code{format} and @code{rest}.") + "A Scheme callable function to issue the error @var{str}." + " The error is formatted with @code{format} and @var{rest}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); str = scm_simple_format (SCM_BOOL_F, str, rest); error (ly_scm2string (str)); return SCM_UNSPECIFIED; @@ -76,10 +95,10 @@ LY_DEFINE (ly_error, "ly:error", LY_DEFINE (ly_message, "ly:message", 1, 0, 1, (SCM str, SCM rest), - "Scheme callable function to issue the message @code{msg}. " - "The message is formatted with @code{format} and @code{rest}.") + "A Scheme callable function to issue the message @var{str}." + " The message is formatted with @code{format} and @var{rest}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); str = scm_simple_format (SCM_BOOL_F, str, rest); message (ly_scm2string (str)); return SCM_UNSPECIFIED; @@ -87,10 +106,10 @@ LY_DEFINE (ly_message, "ly:message", LY_DEFINE (ly_progress, "ly:progress", 1, 0, 1, (SCM str, SCM rest), - "Scheme callable function to print progress @code{str}. " - "The message is formatted with @code{format} and @code{rest}.") + "A Scheme callable function to print progress @var{str}." + " The message is formatted with @code{format} and @var{rest}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); str = scm_simple_format (SCM_BOOL_F, str, rest); progress_indication (ly_scm2string (str)); return SCM_UNSPECIFIED; @@ -98,10 +117,11 @@ LY_DEFINE (ly_progress, "ly:progress", LY_DEFINE (ly_programming_error, "ly:programming-error", 1, 0, 1, (SCM str, SCM rest), - "Scheme callable function to issue the warning @code{msg}. " - "The message is formatted with @code{format} and @code{rest}.") + "A Scheme callable function to issue the internal warning" + " @var{str}. The message is formatted with @code{format}" + " and @var{rest}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); str = scm_simple_format (SCM_BOOL_F, str, rest); programming_error (ly_scm2string (str)); return SCM_UNSPECIFIED; @@ -109,10 +129,10 @@ LY_DEFINE (ly_programming_error, "ly:programming-error", LY_DEFINE (ly_warning, "ly:warning", 1, 0, 1, (SCM str, SCM rest), - "Scheme callable function to issue the warning @code{str}. " - "The message is formatted with @code{format} and @code{rest}.") + "A Scheme callable function to issue the warning @code{str}." + " The message is formatted with @code{format} and @code{rest}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); str = scm_simple_format (SCM_BOOL_F, str, rest); warning (ly_scm2string (str)); return SCM_UNSPECIFIED; @@ -120,9 +140,9 @@ LY_DEFINE (ly_warning, "ly:warning", LY_DEFINE (ly_dir_p, "ly:dir?", 1, 0, 0, (SCM s), - "type predicate. A direction is @code{-1}, @code{0} or " - "@code{1}, where @code{-1} represents " - "left or down and @code{1} represents right or up.") + "A type predicate. The direction@tie{}@code{s} is @code{-1}," + " @code{0} or@tie{}@code{1}, where @code{-1} represents" + " left or down and @code{1} represents right or up.") { if (scm_is_number (s)) { @@ -135,9 +155,11 @@ LY_DEFINE (ly_dir_p, "ly:dir?", LY_DEFINE (ly_assoc_get, "ly:assoc-get", 2, 1, 0, (SCM key, SCM alist, SCM default_value), - "Return value if KEY in ALIST, else DEFAULT-VALUE " - "(or #f if not specified).") + "Return value if @var{key} in @var{alist}, else @code{default-value}" + " (or @code{#f} if not specified).") { + LY_ASSERT_TYPE(ly_cheap_is_list, alist, 2); + SCM handle = scm_assoc (key, alist); if (scm_is_pair (handle)) return scm_cdr (handle); @@ -150,23 +172,25 @@ LY_DEFINE (ly_assoc_get, "ly:assoc-get", LY_DEFINE (ly_string_substitute, "ly:string-substitute", 3, 0, 0, (SCM a, SCM b, SCM s), - "Replace @var{a} by @var{b} in @var{s}.") + "Replace string@tie{}@var{a} by string@tie{}@var{b} in" + " string@tie{}@var{s}.") { - SCM_ASSERT_TYPE (scm_is_string (a), s, SCM_ARG1, __FUNCTION__, "string"); - SCM_ASSERT_TYPE (scm_is_string (b), s, SCM_ARG2, __FUNCTION__, "string"); - SCM_ASSERT_TYPE (scm_is_string (s), s, SCM_ARG3, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, s, 1); + LY_ASSERT_TYPE (scm_is_string, b, 2); + LY_ASSERT_TYPE (scm_is_string, s, 3); string ss = ly_scm2string (s); - replace_all (ss, string (scm_i_string_chars (a)), - string (scm_i_string_chars (b))); + replace_all (&ss, ly_scm2string (a), + ly_scm2string (b)); + return ly_string2scm (ss); } -LY_DEFINE (ly_number2string, "ly:number->string", +LY_DEFINE (ly_number_2_string, "ly:number->string", 1, 0, 0, (SCM s), "Convert @var{num} to a string without generating many decimals.") { - SCM_ASSERT_TYPE (scm_is_number (s), s, SCM_ARG1, __FUNCTION__, "number"); + LY_ASSERT_TYPE (scm_is_number, s, 1); char str[400]; // ugh. @@ -190,7 +214,8 @@ LY_DEFINE (ly_number2string, "ly:number->string", } LY_DEFINE (ly_version, "ly:version", 0, 0, 0, (), - "Return the current lilypond version as a list, e.g. @code{(1 3 127 uu1)}. ") + "Return the current lilypond version as a list, e.g.," + " @code{(1 3 127 uu1)}.") { char const *vs = "\'(" MAJOR_VERSION " " MINOR_VERSION " " PATCH_LEVEL " " MY_PATCH_LEVEL ")"; @@ -204,8 +229,8 @@ LY_DEFINE (ly_unit, "ly:unit", 0, 0, 0, (), } LY_DEFINE (ly_dimension_p, "ly:dimension?", 1, 0, 0, (SCM d), - "Return @var{d} is a number. Used to distinguish length " - "variables from normal numbers.") + "Return @var{d} as a number. Used to distinguish length" + " variables from normal numbers.") { return scm_number_p (d); } @@ -221,25 +246,17 @@ LY_DEFINE (ly_protects, "ly:protects", } LY_DEFINE (ly_gettext, "ly:gettext", - 1, 0, 0, (SCM string), - "Gettext wrapper.") -{ - SCM_ASSERT_TYPE (scm_is_string (string), string, SCM_ARG1, - __FUNCTION__, "string"); - return ly_string2scm (_ (scm_i_string_chars (string))); -} - -LY_DEFINE (ly_output_backend, "ly:output-backend", - 0, 0, 0, (), - "Return name of output backend.") + 1, 0, 0, (SCM original), + "A Scheme wrapper function for @code{gettext}.") { - return ly_string2scm (output_backend_global); + LY_ASSERT_TYPE (scm_is_string, original, 1); + return ly_string2scm (_ (ly_scm2string (original).c_str ())); } LY_DEFINE (ly_output_formats, "ly:output-formats", 0, 0, 0, (), - "Formats passed to --format as a list of strings, " - "used for the output.") + "Formats passed to @option{--format} as a list of strings," + " used for the output.") { vector output_formats = string_split (output_format_global, ','); @@ -251,13 +268,13 @@ LY_DEFINE (ly_output_formats, "ly:output-formats", return lst; } -LY_DEFINE (ly_wchar_to_utf_8, "ly:wide-char->utf-8", +LY_DEFINE (ly_wide_char_2_utf_8, "ly:wide-char->utf-8", 1, 0, 0, (SCM wc), - "Encode the Unicode codepoint @var{wc}, an integer, as UTF-8") + "Encode the Unicode codepoint @var{wc}, an integer, as UTF-8.") { char buf[5]; - SCM_ASSERT_TYPE (scm_is_integer (wc), wc, SCM_ARG1, __FUNCTION__, "integer"); + LY_ASSERT_TYPE (scm_is_integer, wc, 1); unsigned wide_char = (unsigned) scm_to_int (wc); char *p = buf; @@ -290,14 +307,14 @@ LY_DEFINE (ly_effective_prefix, "ly:effective-prefix", 0, 0, 0, (), "Return effective prefix.") { - return ly_string2scm (prefix_directory); + return ly_string2scm (lilypond_datadir); } LY_DEFINE (ly_chain_assoc_get, "ly:chain-assoc-get", 2, 1, 0, (SCM key, SCM achain, SCM dfault), - "Return value for @var{key} from a list of alists @var{achain}. " - "If no if no entry is found, return DFAULT, " - "or #f if no DFAULT not specified.") + "Return value for @var{key} from a list of alists @var{achain}." + " If no entry is found, return @var{dfault} or @code{#f} if no" + " @var{dfault} is specified.") { if (scm_is_pair (achain)) { @@ -313,10 +330,9 @@ LY_DEFINE (ly_chain_assoc_get, "ly:chain-assoc-get", LY_DEFINE (ly_stderr_redirect, "ly:stderr-redirect", 1, 1, 0, (SCM file_name, SCM mode), - "Redirect stderr to FILE-NAME, opened with MODE.") + "Redirect stderr to @var{file-name}, opened with @var{mode}.") { - SCM_ASSERT_TYPE (scm_is_string (file_name), file_name, SCM_ARG1, - __FUNCTION__, "file_name"); + LY_ASSERT_TYPE (scm_is_string, file_name, 1); string m = "w"; if (mode != SCM_UNDEFINED && scm_string_p (mode)) @@ -329,27 +345,27 @@ LY_DEFINE (ly_stderr_redirect, "ly:stderr-redirect", } static SCM -accumulate_symbol (void *closure, SCM key, SCM val, SCM result) +accumulate_symbol (void * /* closure */, + SCM key, + SCM /* val */, + SCM result) { - (void) closure; - (void) val; return scm_cons (key, result); } -LY_DEFINE(ly_hash_table_keys, "ly:hash-table-keys", +LY_DEFINE (ly_hash_table_keys, "ly:hash-table-keys", 1,0,0, (SCM tab), - "return a list of keys in @var{tab}") + "Return a list of keys in @var{tab}.") { return scm_internal_hash_fold ((Hash_closure_function) & accumulate_symbol, NULL, SCM_EOL, tab); } -LY_DEFINE (ly_camel_case_to_lisp_identifier, "ly:camel-case->lisp-identifier", +LY_DEFINE (ly_camel_case_2_lisp_identifier, "ly:camel-case->lisp-identifier", 1, 0, 0, (SCM name_sym), - "Convert FooBar_Bla to foo-bar-bla style symbol.") + "Convert @code{FooBar_Bla} to @code{foo-bar-bla} style symbol.") { - SCM_ASSERT_TYPE(scm_is_symbol (name_sym), name_sym, - SCM_ARG1, __FUNCTION__, "symbol"); + LY_ASSERT_TYPE (ly_is_symbol, name_sym, 1); /* TODO: should use strings instead? @@ -363,10 +379,9 @@ LY_DEFINE (ly_camel_case_to_lisp_identifier, "ly:camel-case->lisp-identifier", LY_DEFINE (ly_expand_environment, "ly:expand-environment", 1, 0, 0, (SCM str), - "Expand $VAR and $@{VAR@} in @var{str}.") + "Expand @code{$VAR} and @code{$@{VAR@}} in @var{str}.") { - SCM_ASSERT_TYPE(scm_is_string (str), str, - SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); return ly_string2scm (expand_environment_variables (ly_scm2string (str))); } @@ -374,10 +389,9 @@ LY_DEFINE (ly_expand_environment, "ly:expand-environment", LY_DEFINE (ly_truncate_list_x, "ly:truncate-list!", 2, 0, 0, (SCM lst, SCM i), - "Take at most the first @var{i} of list @var{lst}") + "Take at most the first @var{i} of list @var{lst}.") { - SCM_ASSERT_TYPE(scm_is_integer (i), i, - SCM_ARG1, __FUNCTION__, "integer"); + LY_ASSERT_TYPE (scm_is_integer, i, 1); int k = scm_to_int (i); if (k == 0) @@ -409,7 +423,7 @@ format_single_argument (SCM arg, int precision) warning (_ ("Found infinity or nan in output. Substituting 0.0")); return ("0.0"); if (strict_infinity_checking) - abort(); + abort (); } else return (String_convert::form_string ("%.*lf", precision, val)); @@ -430,15 +444,15 @@ format_single_argument (SCM arg, int precision) LY_DEFINE (ly_format, "ly:format", 1, 0, 1, (SCM str, SCM rest), - "LilyPond specific format, supporting ~a ~[0-9]f.") + "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}.") { - SCM_ASSERT_TYPE (scm_is_string (str), str, SCM_ARG1, __FUNCTION__, "string"); + LY_ASSERT_TYPE (scm_is_string, str, 1); string format = ly_scm2string (str); vector results; vsize i = 0; - while (i < format.size()) + while (i < format.size ()) { vsize tilde = format.find ('~', i); @@ -467,14 +481,14 @@ LY_DEFINE (ly_format, "ly:format", int precision = 8; if (spec == '$') - precision = '2'; + precision = 2; else if (isdigit (spec)) { precision = spec - '0'; spec = format.at (tilde ++); } - if (spec == 'a' || spec == 'f') + if (spec == 'a' || spec == 'A' || spec == 'f' || spec == '$') results.push_back (format_single_argument (arg, precision)); else if (spec == 'l') { @@ -500,15 +514,15 @@ LY_DEFINE (ly_format, "ly:format", + ": too many arguments"); vsize len = 0; - for (vsize i = 0; i < results.size(); i++) - len += results[i].size(); + for (vsize i = 0; i < results.size (); i++) + len += results[i].size (); char *result = (char*) scm_malloc (len + 1); char *ptr = result; - for (vsize i = 0; i < results.size(); i++) + for (vsize i = 0; i < results.size (); i++) { - strncpy (ptr, results[i].c_str (), results[i].size()); - ptr += results[i].size(); + strncpy (ptr, results[i].c_str (), results[i].size ()); + ptr += results[i].size (); } *ptr = '\0';