2 scm-option.cc -- implement option setting from Scheme
4 source file of the GNU LilyPond music typesetter
6 (c) 2001--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "program-option.hh"
15 #include "string-convert.hh"
16 #include "protected-scm.hh"
17 #include "parse-scm.hh"
21 /* Write midi as formatted ascii stream? */
22 bool do_midi_debugging_global;
26 Backwards compatibility.
28 bool lily_1_8_relative = false;
29 bool lily_1_8_compatibility_used = false;
30 bool profile_property_accesses = false;
32 crash if internally the wrong type is used for a grob property.
34 bool do_internal_type_checking_global;
36 Protected_scm option_hash_;
38 void internal_set_option (SCM var, SCM val)
40 scm_hashq_set_x (option_hash_, var, val);
44 else if (var == ly_symbol2scm ("profile-property-accesses"))
46 profile_property_accesses = to_boolean (val);
47 val = scm_from_bool (to_boolean (val));
49 else if (var == ly_symbol2scm ("midi-debug"))
51 do_midi_debugging_global = to_boolean (val);
52 val = scm_from_bool (to_boolean (val));
54 else if (var == ly_symbol2scm ("point-and-click"))
56 point_and_click_global = to_boolean (val);
57 val = scm_from_bool (to_boolean (val));
59 else if (var == ly_symbol2scm ("parse-protect"))
61 parse_protect_global = to_boolean (val);
62 val = scm_from_bool (to_boolean (val));
64 else if (var == ly_symbol2scm ("internal-type-checking"))
66 do_internal_type_checking_global = to_boolean (val);
67 val = scm_from_bool (to_boolean (val));
69 else if (var == ly_symbol2scm ("old-relative"))
71 lily_1_8_relative = to_boolean (val);
72 /* Needs to be reset for each file that uses this option. */
73 lily_1_8_compatibility_used = to_boolean (val);
74 val = scm_from_bool (to_boolean (val));
76 else if (var == ly_symbol2scm ("object-keys"))
78 use_object_keys = to_boolean (val);
79 val = scm_from_bool (to_boolean (val));
83 const int HELP_INDENT = 30;
85 const int SEPARATION = 5;
88 Hmmm. should do in SCM / C++ ?
93 SCM alist = ly_hash2alist (option_hash_);
94 SCM convertor = ly_lily_module_constant ("scm->string");
98 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
100 SCM sym = scm_caar (s);
101 SCM val = scm_cdar (s);
103 = String_convert::char_string (' ', INDENT)
104 + ly_symbol2string (sym)
106 + ly_scm2string (scm_call_1 (convertor, val))
109 if (opt_spec.length () + SEPARATION > HELP_INDENT)
112 + String_convert::char_string (' ', HELP_INDENT);
115 opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
118 = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
119 String opt_help = ly_scm2string (opt_help_scm);
120 opt_help.substitute (String ("\n"),
122 + String_convert::char_string (' ', HELP_INDENT));
124 opts.push (opt_spec + opt_help + "\n");
127 String help ("Options supported by ly:set-option\n\n");
128 opts.sort (String::compare);
129 for (int i = 0; i < opts.size (); i++)
132 help += String ("\n");
136 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
137 "Print ly:set-option usage")
139 String help = get_help_string ();
140 fputs (help.to_str0 (), stdout);
143 return SCM_UNSPECIFIED;
146 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
147 (SCM sym, SCM val, SCM description),
148 "Add a program option @var{sym} with default @var{val}.")
150 if (scm_hash_table_p (option_hash_) == SCM_BOOL_F)
151 option_hash_ = scm_c_make_hash_table (11);
153 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG1, __FUNCTION__, "symbol");
154 SCM_ASSERT_TYPE (scm_is_string (description), description,
155 SCM_ARG3, __FUNCTION__, "string");
157 internal_set_option (sym, val);
159 scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
162 return SCM_UNSPECIFIED;
165 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
166 "Set a program option. Try setting 'help for a help string.")
168 SCM_ASSERT_TYPE (scm_is_symbol (var), var, SCM_ARG1,
169 __FUNCTION__, "symbol");
171 if (ly_symbol2scm ("help") == var)
174 if (val == SCM_UNDEFINED)
177 String varstr = ly_scm2string (scm_symbol_to_string (var));
178 if (varstr.left_string (3) == String ("no-"))
180 var = ly_symbol2scm (varstr.nomid_string (0, 3).to_str0 ());
181 val = scm_from_bool (!to_boolean (val));
184 SCM handle = scm_hashq_get_handle (option_hash_, var);
185 if (handle == SCM_BOOL_F)
186 warning (_f ("no such internal option: %s", varstr.to_str0 ()));
188 internal_set_option (var, val);
189 return SCM_UNSPECIFIED;
192 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
193 "Get a global option setting.")
195 SCM_ASSERT_TYPE (scm_is_symbol (var), var,
196 SCM_ARG1, __FUNCTION__, "symbol");
197 return scm_hashq_ref (option_hash_, var, SCM_BOOL_F);