2 scm-option.cc -- implement option setting from Scheme
4 source file of the GNU LilyPond music typesetter
6 (c) 2001--2007 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"
22 /* Write midi as formatted ascii stream? */
23 bool do_midi_debugging_global;
27 Backwards compatibility.
29 bool lily_1_8_relative = false;
30 bool lily_1_8_compatibility_used = false;
31 bool profile_property_accesses = false;
33 crash if internally the wrong type is used for a grob property.
35 bool do_internal_type_checking_global;
36 bool strict_infinity_checking = false;
38 static SCM option_hash;
40 void internal_set_option (SCM var, SCM val)
42 scm_hashq_set_x (option_hash, var, 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 ("debug-midi"))
53 do_midi_debugging_global = to_boolean (val);
54 val = scm_from_bool (to_boolean (val));
56 else if (var == ly_symbol2scm ("point-and-click"))
58 point_and_click_global = to_boolean (val);
59 val = scm_from_bool (to_boolean (val));
61 else if (var == ly_symbol2scm ("protected-scheme-parsing"))
63 parse_protect_global = to_boolean (val);
64 val = scm_from_bool (to_boolean (val));
66 else if (var == ly_symbol2scm ("check-internal-types"))
68 do_internal_type_checking_global = to_boolean (val);
69 val = scm_from_bool (to_boolean (val));
71 else if (var == ly_symbol2scm ("debug-gc-assert-parsed-dead"))
73 parsed_objects_should_be_dead = to_boolean (val);
74 val = scm_from_bool (parsed_objects_should_be_dead);
76 else if (var == ly_symbol2scm ("safe"))
78 be_safe_global = to_boolean (val);
79 val = scm_from_bool (be_safe_global);
81 else if (var == ly_symbol2scm ("old-relative"))
83 lily_1_8_relative = to_boolean (val);
84 /* Needs to be reset for each file that uses this option. */
85 lily_1_8_compatibility_used = to_boolean (val);
86 val = scm_from_bool (to_boolean (val));
88 else if (var == ly_symbol2scm ("strict-infinity-checking"))
90 strict_infinity_checking = to_boolean (val);
91 val = scm_from_bool (to_boolean (val));
93 else if (var == ly_symbol2scm ("debug-skylines"))
95 debug_skylines = to_boolean (val);
96 val = scm_from_bool (to_boolean (val));
100 ssize const HELP_INDENT = 30;
101 ssize const INDENT = 2;
102 ssize const SEPARATION = 5;
105 Hmmm. should do in SCM / C++ ?
110 SCM alist = ly_hash2alist (option_hash);
111 SCM convertor = ly_lily_module_constant ("scm->string");
115 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
117 SCM sym = scm_caar (s);
118 SCM val = scm_cdar (s);
120 = String_convert::char_string (' ', INDENT)
121 + ly_symbol2string (sym)
123 + ly_scm2string (scm_call_1 (convertor, val))
126 if (opt_spec.length () + SEPARATION > HELP_INDENT)
129 + String_convert::char_string (' ', HELP_INDENT);
132 opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
135 = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
136 string opt_help = ly_scm2string (opt_help_scm);
137 replace_all (opt_help,
140 + String_convert::char_string (' ', HELP_INDENT));
142 opts.push_back (opt_spec + opt_help + "\n");
145 string help ("Options supported by ly:set-option\n\n");
146 vector_sort (opts, less<string> ());
147 for (vsize i = 0; i < opts.size (); i++)
150 help += string ("\n");
154 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
155 "Print @code{ly:set-option} usage")
157 string help = get_help_string ();
158 progress_indication (help);
160 return SCM_UNSPECIFIED;
163 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
164 (SCM sym, SCM val, SCM description),
165 "Add a program option @var{sym} with default @var{val}.")
169 option_hash = scm_permanent_object (scm_c_make_hash_table (11));
171 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG1, __FUNCTION__, "symbol");
172 SCM_ASSERT_TYPE (scm_is_string (description), description,
173 SCM_ARG3, __FUNCTION__, "string");
175 internal_set_option (sym, val);
177 scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
180 return SCM_UNSPECIFIED;
183 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
184 "Set a program option. Try setting 'help for a help string.")
186 SCM_ASSERT_TYPE (scm_is_symbol (var), var, SCM_ARG1,
187 __FUNCTION__, "symbol");
189 if (ly_symbol2scm ("help") == var)
195 if (val == SCM_UNDEFINED)
198 string varstr = ly_scm2string (scm_symbol_to_string (var));
199 if (varstr.substr (0, 3) == string ("no-"))
201 var = ly_symbol2scm (varstr.substr (3, varstr.length () -3).c_str ());
202 val = scm_from_bool (!to_boolean (val));
205 SCM handle = scm_hashq_get_handle (option_hash, var);
206 if (handle == SCM_BOOL_F)
207 warning (_f ("no such internal option: %s", varstr.c_str ()));
209 internal_set_option (var, val);
210 return SCM_UNSPECIFIED;
213 LY_DEFINE (ly_command_line_options, "ly:command-line-options", 0, 0, 0, (),
214 "The Scheme specified on command-line with @samp{-d}.")
216 return ly_string2scm (init_scheme_variables_global);
219 LY_DEFINE (ly_command_line_code, "ly:command-line-code", 0, 0, 0, (),
220 "The Scheme specified on command-line with @samp{-e}.")
222 return ly_string2scm (init_scheme_code_string_global);
225 LY_DEFINE (ly_command_line_verbose_p, "ly:command-line-verbose?", 0, 0, 0, (),
226 "Was be_verbose_global set?")
228 return scm_from_bool (be_verbose_global);
233 LY_DEFINE (ly_all_option, "ly:all-options",
235 "Get all option settings in an alist.")
237 return ly_hash2alist (option_hash);
241 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
242 "Get a global option setting.")
244 SCM_ASSERT_TYPE (scm_is_symbol (var), var,
245 SCM_ARG1, __FUNCTION__, "symbol");
246 return scm_hashq_ref (option_hash, var, SCM_BOOL_F);
252 get_program_option (const char *s)
254 SCM sym = ly_symbol2scm (s);
256 return to_boolean (ly_get_option (sym));