2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2001--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "program-option.hh"
27 #include "international.hh"
29 #include "parse-scm.hh"
30 #include "string-convert.hh"
32 #include "lily-imports.hh"
35 bool debug_property_callbacks;
36 bool debug_page_breaking_scoring;
38 bool music_strings_to_paths;
39 bool relative_includes;
41 bool profile_property_accesses = false;
43 crash if internally the wrong type is used for a grob property.
45 bool do_internal_type_checking_global;
46 bool strict_infinity_checking = false;
48 static SCM option_hash;
51 internal_set_option (SCM var,
54 string varstr = robust_symbol2string (var, "");
55 bool valbool = to_boolean (val);
56 SCM val_scm_bool = scm_from_bool (valbool);
59 else if (varstr == "profile-property-accesses")
61 profile_property_accesses = valbool;
64 else if (varstr == "protected-scheme-parsing")
66 parse_protect_global = valbool;
69 else if (varstr == "check-internal-types")
71 do_internal_type_checking_global = valbool;
74 else if (varstr == "debug-gc-assert-parsed-dead")
76 parsed_objects_should_be_dead = valbool;
79 else if (varstr == "safe")
81 be_safe_global = valbool;
84 else if (varstr == "strict-infinity-checking")
86 strict_infinity_checking = valbool;
89 else if (varstr == "debug-skylines")
91 debug_skylines = valbool;
94 else if (varstr == "debug-property-callbacks")
96 debug_property_callbacks = valbool;
99 else if (varstr == "debug-page-breaking-scoring")
101 debug_page_breaking_scoring = valbool;
104 else if (varstr == "datadir")
106 /* ignore input value. */
107 val = ly_string2scm (lilypond_datadir);
109 else if (varstr == "relative-includes")
111 relative_includes = valbool;
114 else if (varstr == "warning-as-error")
116 /* warning_as_error is defined in flower/warn.cc */
117 warning_as_error = valbool;
120 else if (varstr == "music-strings-to-paths")
122 music_strings_to_paths = valbool;
126 scm_hashq_set_x (option_hash, var, val);
129 ssize const HELP_INDENT = 30;
130 ssize const INDENT = 2;
131 ssize const SEPARATION = 5;
134 Hmmm. should do in SCM / C++ ?
139 SCM alist = ly_hash2alist (option_hash);
143 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
145 SCM sym = scm_caar (s);
146 SCM val = scm_cdar (s);
147 string opt_spec = String_convert::char_string (' ', INDENT)
148 + ly_symbol2string (sym)
150 + ly_scm2string (Lily::scm_to_string (val))
153 if (opt_spec.length () + SEPARATION > HELP_INDENT)
154 opt_spec += "\n" + String_convert::char_string (' ', HELP_INDENT);
156 opt_spec += String_convert::char_string (' ', HELP_INDENT
157 - opt_spec.length ());
160 = scm_object_property (sym,
161 ly_symbol2scm ("program-option-documentation"));
162 string opt_help = ly_scm2string (opt_help_scm);
163 replace_all (&opt_help,
166 + String_convert::char_string (' ', HELP_INDENT));
168 opts.push_back (opt_spec + opt_help + "\n");
171 string help ("Options supported by `ly:set-option':\n\n");
172 vector_sort (opts, less<string> ());
173 for (vsize i = 0; i < opts.size (); i++)
178 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 1, 0, (SCM port),
179 "Print @code{ly:set-option} usage. Optional @var{port} argument"
180 "for the destination defaults to current output port.")
182 SCM str = scm_from_locale_string (get_help_string ().c_str ());
183 scm_write_line (str, port);
185 return SCM_UNSPECIFIED;
188 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
189 (SCM sym, SCM val, SCM description),
190 "Add a program option @var{sym}. @var{val} is the default"
191 " value and @var{description} is a string description.")
194 option_hash = scm_permanent_object (scm_c_make_hash_table (11));
195 LY_ASSERT_TYPE (ly_is_symbol, sym, 1);
196 LY_ASSERT_TYPE (scm_is_string, description, 3);
198 internal_set_option (sym, val);
200 scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
203 return SCM_UNSPECIFIED;
206 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
207 "Set a program option.")
209 LY_ASSERT_TYPE (ly_is_symbol, var, 1);
211 if (SCM_UNBNDP (val))
214 string varstr = robust_symbol2string (var, "");
215 if (varstr.substr (0, 3) == string ("no-"))
217 var = ly_symbol2scm (varstr.substr (3, varstr.length () - 3).c_str ());
218 val = scm_from_bool (!to_boolean (val));
221 SCM handle = scm_hashq_get_handle (option_hash, var);
222 if (scm_is_false (handle))
223 warning (_f ("no such internal option: %s", varstr.c_str ()));
225 internal_set_option (var, val);
226 return SCM_UNSPECIFIED;
229 LY_DEFINE (ly_command_line_options, "ly:command-line-options", 0, 0, 0, (),
230 "The Scheme options specified on command-line with @option{-d}.")
232 return ly_string2scm (init_scheme_variables_global);
235 LY_DEFINE (ly_command_line_code, "ly:command-line-code", 0, 0, 0, (),
236 "The Scheme code specified on command-line with @option{-e}.")
238 return ly_string2scm (init_scheme_code_global);
241 LY_DEFINE (ly_verbose_output_p, "ly:verbose-output?", 0, 0, 0, (),
242 "Was verbose output requested, i.e. loglevel at least @code{DEBUG}?")
244 return scm_from_bool (is_loglevel (LOG_DEBUG));
247 LY_DEFINE (ly_all_options, "ly:all-options",
249 "Get all option settings in an alist.")
251 return ly_hash2alist (option_hash);
254 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
255 "Get a global option setting.")
257 LY_ASSERT_TYPE (ly_is_symbol, var, 1);
258 return scm_hashq_ref (option_hash, var, SCM_BOOL_F);