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"
14 #include "string-convert.hh"
15 #include "protected-scm.hh"
16 #include "parse-scm.hh"
20 /* Write midi as formatted ascii stream? */
21 bool do_midi_debugging_global;
25 Backwards compatibility.
27 bool lily_1_8_relative = false;
28 bool lily_1_8_compatibility_used = false;
29 bool profile_property_accesses = false;
31 crash if internally the wrong type is used for a grob property.
33 bool do_internal_type_checking_global;
35 Protected_scm option_hash_;
37 void internal_set_option (SCM var, SCM val)
39 scm_hashq_set_x (option_hash_, var, val);
43 else if (var == ly_symbol2scm ("profile-property-accesses"))
45 profile_property_accesses = to_boolean (val);
46 val = scm_from_bool (to_boolean (val));
48 else if (var == ly_symbol2scm ("midi-debug"))
50 do_midi_debugging_global = to_boolean (val);
51 val = scm_from_bool (to_boolean (val));
53 else if (var == ly_symbol2scm ("point-and-click"))
55 point_and_click_global = to_boolean (val);
56 val = scm_from_bool (to_boolean (val));
58 else if (var == ly_symbol2scm ("parse-protect"))
60 parse_protect_global = to_boolean (val);
61 val = scm_from_bool (to_boolean (val));
63 else if (var == ly_symbol2scm ("internal-type-checking"))
65 do_internal_type_checking_global = to_boolean (val);
66 val = scm_from_bool (to_boolean (val));
68 else if (var == ly_symbol2scm ("old-relative"))
70 lily_1_8_relative = to_boolean (val);
71 /* Needs to be reset for each file that uses this option. */
72 lily_1_8_compatibility_used = to_boolean (val);
73 val = scm_from_bool (to_boolean (val));
75 else if (var == ly_symbol2scm ("object-keys"))
77 use_object_keys = to_boolean (val);
78 val = scm_from_bool (to_boolean (val));
82 const int HELP_INDENT = 30;
84 const int SEPARATION = 5;
87 Hmmm. should do in SCM / C++ ?
92 SCM alist = ly_hash2alist (option_hash_);
93 SCM convertor = ly_lily_module_constant ("scm->string");
97 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
99 SCM sym = scm_caar (s);
100 SCM val = scm_cdar (s);
102 = String_convert::char_string (' ', INDENT)
103 + ly_symbol2string (sym)
105 + ly_scm2string (scm_call_1 (convertor, val))
108 if (opt_spec.length () + SEPARATION > HELP_INDENT)
111 + String_convert::char_string (' ', HELP_INDENT);
114 opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
117 = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
118 String opt_help = ly_scm2string (opt_help_scm);
119 opt_help.substitute (String ("\n"),
121 + String_convert::char_string (' ', HELP_INDENT));
123 opts.push (opt_spec + opt_help + "\n");
126 String help ("Options supported by ly:set-option\n\n");
127 opts.sort (String::compare);
128 for (int i = 0; i < opts.size (); i++)
131 help += String ("\n");
135 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
136 "Print ly:set-option usage")
138 String help = get_help_string ();
139 fputs (help.to_str0 (), stdout);
142 return SCM_UNSPECIFIED;
145 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
146 (SCM sym, SCM val, SCM description),
147 "Add a program option @var{sym} with default @var{val}.")
149 if (scm_hash_table_p (option_hash_) == SCM_BOOL_F)
150 option_hash_ = scm_c_make_hash_table (11);
152 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG1, __FUNCTION__, "symbol");
153 SCM_ASSERT_TYPE (scm_is_string (description), description,
154 SCM_ARG3, __FUNCTION__, "string");
156 internal_set_option (sym, val);
158 scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
161 return SCM_UNSPECIFIED;
164 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
165 "Set a program option. Try setting 'help for a help string.")
167 SCM_ASSERT_TYPE (scm_is_symbol (var), var, SCM_ARG1,
168 __FUNCTION__, "symbol");
170 if (ly_symbol2scm ("help") == var)
175 if (val == SCM_UNDEFINED)
178 String varstr = ly_scm2string (scm_symbol_to_string (var));
179 if (varstr.left_string (3) == String ("no-"))
181 var = ly_symbol2scm (varstr.nomid_string (0, 3).to_str0 ());
182 val = scm_from_bool (!to_boolean (val));
185 SCM handle = scm_hashq_get_handle (option_hash_, var);
186 if (handle == SCM_BOOL_F)
188 warning (_f ("no such internal option: %s", varstr.to_str0 ()));
191 internal_set_option (var, val);
192 return SCM_UNSPECIFIED;
195 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
196 "Get a global option setting.")
198 SCM_ASSERT_TYPE (scm_is_symbol (var), var,
199 SCM_ARG1, __FUNCTION__, "symbol");
200 return scm_hashq_ref (option_hash_, var, SCM_BOOL_F);