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