lily/program-option-scheme.cc

   1 /*
   2   program-option-scheme.cc -- implement option setting from Scheme
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2007  Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "program-option.hh"
  10
  11 #include <cstdio>
  12 #include <cstring>
  13 using namespace std;
  14
  15 #include "profile.hh"
  16 #include "international.hh"
  17 #include "main.hh"
  18 #include "parse-scm.hh"
  19 #include "string-convert.hh"
  20 #include "warn.hh"
  21
  22 bool debug_skylines;
  23
  24 /*
  25   Backwards compatibility.
  26 */
  27 bool lily_1_8_relative = false;
  28 bool lily_1_8_compatibility_used = false;
  29 bool profile_property_accesses = false;
  30 /*
  31   crash if internally the wrong type is used for a grob property.
  32 */
  33 bool do_internal_type_checking_global;
  34 bool strict_infinity_checking = false;
  35
  36 static SCM option_hash;
  37
  38 void internal_set_option (SCM var, SCM val)
  39 {
  40   scm_hashq_set_x (option_hash, var, val);
  41
  42   if (0)
  43     ;
  44   else if (var == ly_symbol2scm ("profile-property-accesses"))
  45     {
  46       profile_property_accesses = to_boolean (val);
  47       val = scm_from_bool (to_boolean (val));
  48     }
  49   else if (var == ly_symbol2scm ("point-and-click"))
  50     {
  51       point_and_click_global = to_boolean (val);
  52       val = scm_from_bool (to_boolean (val));
  53     }
  54   else if (var == ly_symbol2scm ("protected-scheme-parsing"))
  55     {
  56       parse_protect_global = to_boolean (val);
  57       val = scm_from_bool (to_boolean (val));
  58     }
  59   else if (var == ly_symbol2scm ("check-internal-types"))
  60     {
  61       do_internal_type_checking_global = to_boolean (val);
  62       val = scm_from_bool (to_boolean (val));
  63     }
  64   else if (var == ly_symbol2scm ("debug-gc-assert-parsed-dead"))
  65     {
  66       parsed_objects_should_be_dead = to_boolean (val);
  67       val = scm_from_bool (parsed_objects_should_be_dead);
  68     }
  69   else if (var == ly_symbol2scm ("safe"))
  70     {
  71       be_safe_global = to_boolean (val);
  72       val = scm_from_bool (be_safe_global);
  73     }
  74   else if (var == ly_symbol2scm ("old-relative"))
  75     {
  76       lily_1_8_relative = to_boolean (val);
  77       /*  Needs to be reset for each file that uses this option.  */
  78       lily_1_8_compatibility_used = to_boolean (val);
  79       val = scm_from_bool (to_boolean (val));
  80     }
  81   else if (var == ly_symbol2scm ("strict-infinity-checking"))
  82     {
  83       strict_infinity_checking = to_boolean (val);
  84       val = scm_from_bool (to_boolean (val));
  85     }
  86   else if (var == ly_symbol2scm ("debug-skylines"))
  87     {
  88       debug_skylines = to_boolean (val);
  89       val = scm_from_bool (to_boolean (val));
  90     }
  91 }
  92
  93
  94
  95
  96 bool
  97 get_program_option (const char *s)
  98 {
  99   SCM sym = ly_symbol2scm (s);
 100
 101   return to_boolean (ly_get_option (sym));
 102 }
 103
 104
 105 ssize const HELP_INDENT = 30;
 106 ssize const INDENT = 2;
 107 ssize const SEPARATION = 5;
 108
 109 /*
 110   Hmmm. should do in SCM / C++  ?
 111 */
 112 static string
 113 get_help_string ()
 114 {
 115   SCM alist = ly_hash2alist (option_hash);
 116   SCM convertor = ly_lily_module_constant ("scm->string");
 117
 118   vector<string> opts;
 119
 120   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 121     {
 122       SCM sym = scm_caar (s);
 123       SCM val = scm_cdar (s);
 124       string opt_spec
 125         = String_convert::char_string (' ', INDENT)
 126         + ly_symbol2string (sym)
 127         + " ("
 128         + ly_scm2string (scm_call_1 (convertor, val))
 129         + ")";
 130
 131       if (opt_spec.length () + SEPARATION > HELP_INDENT)
 132         {
 133           opt_spec += "\n"
 134             + String_convert::char_string (' ', HELP_INDENT);
 135         }
 136       else
 137         opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
 138
 139       SCM opt_help_scm
 140         = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
 141       string opt_help = ly_scm2string (opt_help_scm);
 142       replace_all (opt_help,
 143                    string ("\n"),
 144                    string ("\n")
 145                    + String_convert::char_string (' ', HELP_INDENT));
 146
 147       opts.push_back (opt_spec + opt_help + "\n");
 148     }
 149
 150   string help ("Options supported by ly:set-option\n\n");
 151   vector_sort (opts, less<string> ());
 152   for (vsize i = 0; i < opts.size (); i++)
 153     help += opts[i];
 154
 155   help += string ("\n");
 156   return help;
 157 }
 158
 159
 160 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
 161            "Print @code{ly:set-option} usage")
 162 {
 163   string help = get_help_string ();
 164   progress_indication (help);
 165
 166   return SCM_UNSPECIFIED;
 167 }
 168
 169 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
 170            (SCM sym, SCM val, SCM description),
 171            "Add a program option @var{sym} with default @var{val}.")
 172 {
 173   if (!option_hash)
 174     {
 175       option_hash = scm_permanent_object (scm_c_make_hash_table (11));
 176     }
 177   LY_ASSERT_TYPE (ly_is_symbol, sym, 1);
 178   LY_ASSERT_TYPE (scm_is_string, description, 3);
 179
 180   internal_set_option (sym, val);
 181
 182   scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
 183                              description);
 184
 185   return SCM_UNSPECIFIED;
 186 }
 187
 188 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
 189            "Set a program option.")
 190 {
 191   LY_ASSERT_TYPE (ly_is_symbol, var, 1);
 192
 193   if (val == SCM_UNDEFINED)
 194     val = SCM_BOOL_T;
 195
 196   string varstr = ly_scm2string (scm_symbol_to_string (var));
 197   if (varstr.substr (0, 3) == string ("no-"))
 198     {
 199       var = ly_symbol2scm (varstr.substr (3, varstr.length () -3).c_str ());
 200       val = scm_from_bool (!to_boolean (val));
 201     }
 202
 203   SCM handle = scm_hashq_get_handle (option_hash, var);
 204   if (handle == SCM_BOOL_F)
 205     warning (_f ("no such internal option: %s", varstr.c_str ()));
 206
 207   internal_set_option (var, val);
 208   return SCM_UNSPECIFIED;
 209 }
 210
 211 LY_DEFINE (ly_command_line_options, "ly:command-line-options", 0, 0, 0, (),
 212            "The Scheme specified on command-line with @samp{-d}.")
 213 {
 214   return ly_string2scm (init_scheme_variables_global);
 215 }
 216
 217 LY_DEFINE (ly_command_line_code, "ly:command-line-code", 0, 0, 0, (),
 218            "The Scheme specified on command-line with @samp{-e}.")
 219 {
 220   return ly_string2scm (init_scheme_code_global);
 221 }
 222
 223 LY_DEFINE (ly_command_line_verbose_p, "ly:command-line-verbose?", 0, 0, 0, (),
 224            "Was be_verbose_global set?")
 225 {
 226   return scm_from_bool (be_verbose_global);
 227 }
 228
 229
 230
 231 LY_DEFINE (ly_all_options, "ly:all-options",
 232            0, 0, 0, (),
 233            "Get all option settings in an alist.")
 234 {
 235   return ly_hash2alist (option_hash);
 236 }
 237
 238
 239 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
 240            "Get a global option setting.")
 241 {
 242   LY_ASSERT_TYPE (ly_is_symbol, var, 1);
 243   return scm_hashq_ref (option_hash, var, SCM_BOOL_F);
 244 }