2 program-option-scheme.cc -- implement option setting from Scheme
4 source file of the GNU LilyPond music typesetter
6 (c) 2001--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "program-option.hh"
16 #include "international.hh"
18 #include "parse-scm.hh"
19 #include "string-convert.hh"
23 bool debug_property_callbacks;
24 bool debug_page_breaking_scoring;
26 bool relative_includes;
29 Backwards compatibility.
31 bool lily_1_8_relative = false;
32 bool lily_1_8_compatibility_used = false;
33 bool profile_property_accesses = false;
35 crash if internally the wrong type is used for a grob property.
37 bool do_internal_type_checking_global;
38 bool strict_infinity_checking = false;
40 static SCM option_hash;
42 void internal_set_option (SCM var, SCM val)
46 else if (var == ly_symbol2scm ("profile-property-accesses"))
48 profile_property_accesses = to_boolean (val);
49 val = scm_from_bool (to_boolean (val));
51 else if (var == ly_symbol2scm ("point-and-click"))
53 point_and_click_global = to_boolean (val);
54 val = scm_from_bool (to_boolean (val));
56 else if (var == ly_symbol2scm ("protected-scheme-parsing"))
58 parse_protect_global = to_boolean (val);
59 val = scm_from_bool (to_boolean (val));
61 else if (var == ly_symbol2scm ("check-internal-types"))
63 do_internal_type_checking_global = to_boolean (val);
64 val = scm_from_bool (to_boolean (val));
66 else if (var == ly_symbol2scm ("debug-gc-assert-parsed-dead"))
68 parsed_objects_should_be_dead = to_boolean (val);
69 val = scm_from_bool (parsed_objects_should_be_dead);
71 else if (var == ly_symbol2scm ("safe"))
73 be_safe_global = to_boolean (val);
74 val = scm_from_bool (be_safe_global);
76 else if (var == ly_symbol2scm ("old-relative"))
78 lily_1_8_relative = to_boolean (val);
79 /* Needs to be reset for each file that uses this option. */
80 lily_1_8_compatibility_used = to_boolean (val);
81 val = scm_from_bool (to_boolean (val));
83 else if (var == ly_symbol2scm ("strict-infinity-checking"))
85 strict_infinity_checking = to_boolean (val);
86 val = scm_from_bool (to_boolean (val));
88 else if (var == ly_symbol2scm ("debug-skylines"))
90 debug_skylines = to_boolean (val);
91 val = scm_from_bool (to_boolean (val));
93 else if (var == ly_symbol2scm ("debug-property-callbacks"))
95 debug_property_callbacks = to_boolean (val);
96 val = scm_from_bool (to_boolean (val));
98 else if (var == ly_symbol2scm ("debug-page-breaking-scoring"))
100 debug_page_breaking_scoring = to_boolean (val);
101 val = scm_from_bool (to_boolean (val));
103 else if (var == ly_symbol2scm ("datadir"))
105 /* ignore input value. */
106 val = ly_string2scm (lilypond_datadir);
108 else if (var == ly_symbol2scm ("relative-includes"))
110 relative_includes = to_boolean (val);
111 val = scm_from_bool (to_boolean (val));
115 scm_hashq_set_x (option_hash, var, val);
122 ssize const HELP_INDENT = 30;
123 ssize const INDENT = 2;
124 ssize const SEPARATION = 5;
127 Hmmm. should do in SCM / C++ ?
132 SCM alist = ly_hash2alist (option_hash);
133 SCM convertor = ly_lily_module_constant ("scm->string");
137 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
139 SCM sym = scm_caar (s);
140 SCM val = scm_cdar (s);
142 = String_convert::char_string (' ', INDENT)
143 + ly_symbol2string (sym)
145 + ly_scm2string (scm_call_1 (convertor, val))
148 if (opt_spec.length () + SEPARATION > HELP_INDENT)
151 + String_convert::char_string (' ', HELP_INDENT);
154 opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
157 = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
158 string opt_help = ly_scm2string (opt_help_scm);
159 replace_all (&opt_help,
162 + String_convert::char_string (' ', HELP_INDENT));
164 opts.push_back (opt_spec + opt_help + "\n");
167 string help ("Options supported by ly:set-option\n\n");
168 vector_sort (opts, less<string> ());
169 for (vsize i = 0; i < opts.size (); i++)
172 help += string ("\n");
177 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
178 "Print @code{ly:set-option} usage.")
180 string help = get_help_string ();
181 progress_indication (help);
183 return SCM_UNSPECIFIED;
186 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
187 (SCM sym, SCM val, SCM description),
188 "Add a program option @var{sym} with default @var{val}.")
192 option_hash = scm_permanent_object (scm_c_make_hash_table (11));
194 LY_ASSERT_TYPE (ly_is_symbol, sym, 1);
195 LY_ASSERT_TYPE (scm_is_string, description, 3);
197 internal_set_option (sym, val);
199 scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
202 return SCM_UNSPECIFIED;
205 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
206 "Set a program option.")
208 LY_ASSERT_TYPE (ly_is_symbol, var, 1);
210 if (val == SCM_UNDEFINED)
213 string varstr = ly_scm2string (scm_symbol_to_string (var));
214 if (varstr.substr (0, 3) == string ("no-"))
216 var = ly_symbol2scm (varstr.substr (3, varstr.length () -3).c_str ());
217 val = scm_from_bool (!to_boolean (val));
220 SCM handle = scm_hashq_get_handle (option_hash, var);
221 if (handle == SCM_BOOL_F)
222 warning (_f ("no such internal option: %s", varstr.c_str ()));
224 internal_set_option (var, val);
225 return SCM_UNSPECIFIED;
228 LY_DEFINE (ly_command_line_options, "ly:command-line-options", 0, 0, 0, (),
229 "The Scheme options specified on command-line with @option{-d}.")
231 return ly_string2scm (init_scheme_variables_global);
234 LY_DEFINE (ly_command_line_code, "ly:command-line-code", 0, 0, 0, (),
235 "The Scheme code specified on command-line with @option{-e}.")
237 return ly_string2scm (init_scheme_code_global);
240 LY_DEFINE (ly_command_line_verbose_p, "ly:command-line-verbose?", 0, 0, 0, (),
241 "Was @code{be_verbose_global} set?")
243 return scm_from_bool (be_verbose_global);
248 LY_DEFINE (ly_all_options, "ly:all-options",
250 "Get all option settings in an alist.")
252 return ly_hash2alist (option_hash);
256 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
257 "Get a global option setting.")
259 LY_ASSERT_TYPE (ly_is_symbol, var, 1);
260 return scm_hashq_ref (option_hash, var, SCM_BOOL_F);