lily/program-option.cc

   1 /*
   2   scm-option.cc -- implement option setting from Scheme
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "program-option.hh"
  10
  11 #include <cstdio>
  12 #include <string.h>
  13
  14 #include "string-convert.hh"
  15 #include "protected-scm.hh"
  16 #include "parse-scm.hh"
  17 #include "warn.hh"
  18 #include "main.hh"
  19
  20
  21 /* Write midi as formatted ascii stream? */
  22 bool do_midi_debugging_global;
  23 bool use_object_keys;
  24
  25 /*
  26   Backwards compatibility.
  27 */
  28 bool lily_1_8_relative = false;
  29 bool lily_1_8_compatibility_used = false;
  30
  31 /*
  32   crash if internally the wrong type is used for a grob property.
  33 */
  34 bool do_internal_type_checking_global;
  35
  36 Protected_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 (var == ly_symbol2scm ("midi-debug"))
  43     {
  44       do_midi_debugging_global = to_boolean (val);
  45       val = scm_from_bool (to_boolean (val));
  46     }
  47   else if (var == ly_symbol2scm ("point-and-click"))
  48     {
  49       point_and_click_global = to_boolean (val);
  50       val = scm_from_bool (to_boolean (val));
  51     }
  52   else if (var == ly_symbol2scm ("parse-protect"))
  53     {
  54       parse_protect_global = to_boolean (val);
  55       val = scm_from_bool (to_boolean (val));
  56     }
  57   else if (var == ly_symbol2scm ("internal-type-checking"))
  58     {
  59       do_internal_type_checking_global = to_boolean (val);
  60       val = scm_from_bool (to_boolean (val));
  61     }
  62   else if (var == ly_symbol2scm ("old-relative"))
  63     {
  64       lily_1_8_relative = to_boolean (val);
  65       /*  Needs to be reset for each file that uses this option.  */
  66       lily_1_8_compatibility_used = to_boolean (val);
  67       val = scm_from_bool (to_boolean (val));
  68     }
  69   else if (var == ly_symbol2scm ("object-keys"))
  70     {
  71       use_object_keys = to_boolean (val);
  72       val = scm_from_bool (to_boolean (val));
  73     }
  74 }
  75
  76 const int HELP_INDENT = 30;
  77 const int INDENT = 2;
  78 const int SEPARATION = 5;
  79
  80 /*
  81   Hmmm. should do in SCM / C++  ?
  82  */
  83 static String
  84 get_help_string ()
  85 {
  86   SCM alist = ly_hash2alist (option_hash_);
  87   SCM convertor = ly_lily_module_constant ("scm->string");
  88
  89
  90   Array<String> opts;
  91
  92   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
  93     {
  94       SCM sym = scm_caar (s);
  95       SCM val = scm_cdar (s);
  96       String opt_spec =
  97         String_convert::char_string (' ', INDENT)
  98         + ly_symbol2string (sym)
  99         + " ("
 100         + ly_scm2string (scm_call_1 (convertor, val))
 101         + ")";
 102
 103       if (opt_spec.length () + SEPARATION > HELP_INDENT)
 104         {
 105           opt_spec += "\n"
 106             + String_convert::char_string (' ', HELP_INDENT);
 107         }
 108       else
 109         opt_spec += String_convert::char_string (' ', HELP_INDENT - opt_spec.length ());
 110
 111       SCM opt_help_scm
 112         = scm_object_property (sym, ly_symbol2scm ("program-option-documentation"));
 113       String opt_help = ly_scm2string (opt_help_scm);
 114       opt_help.substitute (String ("\n"),
 115                            String ("\n")
 116                            + String_convert::char_string (' ', HELP_INDENT));
 117
 118       opts.push (opt_spec + opt_help + "\n");
 119     }
 120
 121   String help ("Options supported by ly:set-option\n\n");
 122   opts.sort (String::compare);
 123   for (int  i = 0; i < opts.size (); i++)
 124     help += opts[i];
 125
 126   help += String ("\n");
 127   return help;
 128 }
 129
 130 LY_DEFINE (ly_option_usage, "ly:option-usage", 0, 0, 0, (),
 131            "Print ly:set-option usage")
 132 {
 133   String help = get_help_string ();
 134   fputs (help.to_str0 (), stdout);
 135
 136   exit (0);
 137   return SCM_UNSPECIFIED;
 138 }
 139
 140 LY_DEFINE (ly_add_option, "ly:add-option", 3, 0, 0,
 141            (SCM sym, SCM val,  SCM description),
 142            "Add a program option @var{sym} with default @var{val}.")
 143 {
 144   if (scm_hash_table_p (option_hash_) == SCM_BOOL_F)
 145     option_hash_ = scm_c_make_hash_table (11);
 146
 147   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG1, __FUNCTION__, "symbol");
 148   SCM_ASSERT_TYPE (scm_is_string (description), description,
 149                    SCM_ARG3, __FUNCTION__, "string");
 150
 151   internal_set_option (sym, val);
 152
 153   scm_set_object_property_x (sym, ly_symbol2scm ("program-option-documentation"),
 154                              description);
 155
 156   return SCM_UNSPECIFIED;
 157 }
 158
 159 LY_DEFINE (ly_set_option, "ly:set-option", 1, 1, 0, (SCM var, SCM val),
 160            "Set a program option. Try setting 'help for a help string.")
 161 {
 162   SCM_ASSERT_TYPE (scm_is_symbol (var), var, SCM_ARG1,
 163                    __FUNCTION__,  "symbol");
 164
 165   if (ly_symbol2scm ("help") == var)
 166     {
 167       ly_option_usage ();
 168     }
 169
 170   if (val == SCM_UNDEFINED)
 171     val = SCM_BOOL_T;
 172
 173   String  varstr = ly_scm2string (scm_symbol_to_string (var));
 174   if (varstr.left_string (3) == String ("no-"))
 175     {
 176       var = ly_symbol2scm (varstr.nomid_string (0, 3).to_str0 ());
 177       val = scm_from_bool (!to_boolean (val));
 178     }
 179
 180   SCM handle = scm_hashq_get_handle (option_hash_, var);
 181   if (handle == SCM_BOOL_F)
 182     {
 183       warning (_f ("no such internal option: %s", varstr.to_str0 ()));
 184     }
 185
 186   internal_set_option (var, val);
 187   return SCM_UNSPECIFIED;
 188 }
 189
 190 LY_DEFINE (ly_get_option, "ly:get-option", 1, 0, 0, (SCM var),
 191            "Get a global option setting.")
 192 {
 193   SCM_ASSERT_TYPE (scm_is_symbol (var), var,
 194                    SCM_ARG1, __FUNCTION__,  "symbol");
 195   return scm_hashq_ref (option_hash_, var, SCM_BOOL_F);
 196 }