lily/lily-lexer.cc

   1 /*
   2   lily-lexer.cc -- implement Lily_lexer
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "lily-lexer.hh"
  10
  11 #include <cctype>
  12 #include <sstream>
  13
  14 #include "scm-hash.hh"
  15 #include "interval.hh"
  16 #include "parser.hh"
  17 #include "keyword.hh"
  18 #include "warn.hh"
  19 #include "source-file.hh"
  20 #include "main.hh"
  21 #include "moment.hh"
  22
  23 static Keyword_ent the_key_tab[]
  24 = {
  25   {"accepts", ACCEPTS},
  26   {"addlyrics", ADDLYRICS},
  27   {"addquote", ADDQUOTE},
  28   {"alias", ALIAS},
  29   {"alternative", ALTERNATIVE},
  30   {"bar", BAR},
  31   {"book", BOOK},
  32   {"change", CHANGE},
  33   {"chordmode", CHORDMODE},
  34   {"chords", CHORDS},
  35   {"clef", CLEF},
  36   {"consists", CONSISTS},
  37   {"context", CONTEXT},
  38   {"default", DEFAULT},
  39   {"defaultchild", DEFAULTCHILD},
  40   {"denies", DENIES},
  41   {"description", DESCRIPTION},
  42   {"drummode", DRUMMODE},
  43   {"drums", DRUMS},
  44   {"figuremode", FIGUREMODE},
  45   {"figures", FIGURES},
  46   {"grobdescriptions", GROBDESCRIPTIONS},
  47   {"header", HEADER},
  48   {"key", KEY},
  49   {"layout", LAYOUT},
  50   {"lyricmode", LYRICMODE},
  51   {"lyrics", LYRICS},
  52   {"lyricsto", LYRICSTO},
  53   {"mark", MARK},
  54   {"markup", MARKUP},
  55   {"midi", MIDI},
  56   {"name", NAME},
  57   {"new", NEWCONTEXT},
  58   {"notemode", NOTEMODE},
  59   {"objectid", OBJECTID},
  60   {"octave", OCTAVE},
  61   {"once", ONCE},
  62   {"override", OVERRIDE},
  63   {"paper", PAPER},
  64   {"partial", PARTIAL},
  65   {"relative", RELATIVE},
  66   {"remove", REMOVE},
  67   {"repeat", REPEAT},
  68   {"rest", REST},
  69   {"revert", REVERT},
  70   {"score", SCORE},
  71   {"sequential", SEQUENTIAL},
  72   {"set", SET},
  73   {"simultaneous", SIMULTANEOUS},
  74   {"skip", SKIP},
  75   {"tag", TAG},
  76   {"tempo", TEMPO},
  77   {"time", TIME_T},
  78   {"times", TIMES},
  79   {"transpose", TRANSPOSE},
  80   {"transposition", TRANSPOSITION},
  81   {"type", TYPE},
  82   {"unset", UNSET},
  83   {"with", WITH},
  84   {0, 0}
  85 };
  86
  87 Lily_lexer::Lily_lexer (Sources *sources)
  88 {
  89   keytable_ = new Keyword_table (the_key_tab);
  90   chordmodifier_tab_ = SCM_EOL;
  91   pitchname_tab_stack_ = SCM_EOL;
  92   sources_ = sources;
  93   scopes_ = SCM_EOL;
  94   error_level_ = 0;
  95   is_main_input_ = false;
  96   start_module_ = SCM_EOL;
  97   smobify_self ();
  98
  99   add_scope (ly_make_anonymous_module (false));
 100   push_note_state (scm_c_make_hash_table (0));
 101   chordmodifier_tab_ = scm_make_vector (scm_from_int (1), SCM_EOL);
 102 }
 103
 104 Lily_lexer::Lily_lexer (Lily_lexer const &src)
 105   : Includable_lexer ()
 106 {
 107   keytable_ = (src.keytable_) ? new Keyword_table (*src.keytable_) : 0;
 108   chordmodifier_tab_ = src.chordmodifier_tab_;
 109   pitchname_tab_stack_ = src.pitchname_tab_stack_;
 110   sources_ = src.sources_;
 111   start_module_ = SCM_EOL;
 112
 113   error_level_ = src.error_level_;
 114   is_main_input_ = src.is_main_input_;
 115
 116   scopes_ = SCM_EOL;
 117
 118   smobify_self ();
 119
 120   SCM scopes = SCM_EOL;
 121   SCM *tail = &scopes;
 122   for (SCM s = src.scopes_; scm_is_pair (s); s = scm_cdr (s))
 123     {
 124       SCM newmod = ly_make_anonymous_module (false);
 125       ly_module_copy (newmod, scm_car (s));
 126       *tail = scm_cons (newmod, SCM_EOL);
 127       tail = SCM_CDRLOC (*tail);
 128     }
 129
 130   scopes_ = scopes;
 131   push_note_state (scm_c_make_hash_table (0));
 132 }
 133
 134 Lily_lexer::~Lily_lexer ()
 135 {
 136   delete keytable_;
 137 }
 138
 139 void
 140 Lily_lexer::add_scope (SCM module)
 141 {
 142   ly_reexport_module (scm_current_module ());
 143   if (!scm_is_pair (scopes_))
 144     start_module_ = scm_current_module ();
 145
 146   for (SCM s = scopes_; scm_is_pair (s); s = scm_cdr (s))
 147     ly_use_module (module, scm_car (s));
 148   scopes_ = scm_cons (module, scopes_);
 149
 150   set_current_scope ();
 151 }
 152
 153 SCM
 154 Lily_lexer::remove_scope ()
 155 {
 156   SCM sc = scm_car (scopes_);
 157   scopes_ = scm_cdr (scopes_);
 158   set_current_scope ();
 159   return sc;
 160 }
 161
 162 SCM
 163 Lily_lexer::set_current_scope ()
 164 {
 165   SCM old = scm_current_module ();
 166
 167   if (scm_is_pair (scopes_))
 168     scm_set_current_module (scm_car (scopes_));
 169   else
 170     scm_set_current_module (start_module_);
 171
 172   return old;
 173 }
 174
 175 int
 176 Lily_lexer::lookup_keyword (String s)
 177 {
 178   return keytable_->lookup (s.to_str0 ());
 179 }
 180
 181 SCM
 182 Lily_lexer::lookup_identifier_symbol (SCM sym)
 183 {
 184   for (SCM s = scopes_; scm_is_pair (s); s = scm_cdr (s))
 185     {
 186       SCM var = ly_module_lookup (scm_car (s), sym);
 187       if (var != SCM_BOOL_F)
 188         return scm_variable_ref (var);
 189     }
 190
 191   return SCM_UNDEFINED;
 192 }
 193
 194 SCM
 195 Lily_lexer::lookup_identifier (String name)
 196 {
 197   return lookup_identifier_symbol (ly_symbol2scm (name.to_str0 ()));
 198 }
 199
 200 void
 201 Lily_lexer::start_main_input ()
 202 {
 203   // yy_flex_debug = 1;
 204   new_input (main_input_name_, sources_);
 205
 206   /* Do not allow \include in --safe-mode */
 207   allow_includes_b_ = allow_includes_b_ && !be_safe_global;
 208
 209   scm_module_define (scm_car (scopes_),
 210                      ly_symbol2scm ("input-file-name"),
 211                      scm_makfrom0str (main_input_name_.to_str0 ()));
 212 }
 213
 214 void
 215 Lily_lexer::set_identifier (SCM name, SCM s)
 216 {
 217   SCM sym = name;
 218   if (scm_is_string (name))
 219     sym = scm_string_to_symbol (name);
 220
 221   if (scm_is_symbol (sym))
 222     {
 223       if (lookup_keyword (ly_symbol2string (sym)) >= 0)
 224         {
 225           String symstr = ly_symbol2string (sym);
 226           warning (_f ("identifier name is a keyword: `%s'", symstr.to_str0 ()));
 227         }
 228
 229       SCM mod = scm_car (scopes_);
 230
 231       scm_module_define (mod, sym, s);
 232     }
 233   else
 234     programming_error ("identifier is not a symbol");
 235 }
 236
 237 void
 238 Lily_lexer::LexerError (char const *s)
 239 {
 240   if (include_stack_.is_empty ())
 241     message (_f ("error at EOF: %s", s) + "\n");
 242   else
 243     {
 244       error_level_ |= 1;
 245       Input spot (*lexloc);
 246       spot.error (s);
 247     }
 248 }
 249
 250 char
 251 Lily_lexer::escaped_char (char c) const
 252 {
 253   switch (c)
 254     {
 255     case 'n':
 256       return '\n';
 257     case 't':
 258       return '\t';
 259     case '\'':
 260     case '\"':
 261     case '\\':
 262       return c;
 263     }
 264   return 0;
 265 }
 266
 267 Input
 268 Lily_lexer::here_input () const
 269 {
 270   return Input (*lexloc);
 271 }
 272
 273 void
 274 Lily_lexer::prepare_for_next_token ()
 275 {
 276   last_input_ = here_input ();
 277 }
 278
 279 /**
 280    Since we don't create the buffer state from the bytes directly, we
 281    don't know about the location of the lexer. Add this as a
 282    YY_USER_ACTION */
 283 void
 284 Lily_lexer::add_lexed_char (int count)
 285 {
 286   char const *start = here_str0 ();
 287   lexloc->set (get_source_file (),
 288                start, start + count);
 289   char_count_stack_.top () += count;
 290 }
 291
 292 #include "ly-smobs.icc"
 293
 294 IMPLEMENT_SMOBS (Lily_lexer);
 295 IMPLEMENT_TYPE_P (Lily_lexer, "ly:lily-lexer?");
 296 IMPLEMENT_DEFAULT_EQUAL_P (Lily_lexer);
 297
 298 SCM
 299 Lily_lexer::mark_smob (SCM s)
 300 {
 301   Lily_lexer *lexer = (Lily_lexer *) SCM_CELL_WORD_1 (s);
 302
 303   scm_gc_mark (lexer->chordmodifier_tab_);
 304   scm_gc_mark (lexer->pitchname_tab_stack_);
 305   scm_gc_mark (lexer->start_module_);
 306   return lexer->scopes_;
 307 }
 308
 309 int
 310 Lily_lexer::print_smob (SCM s, SCM port, scm_print_state*)
 311 {
 312   Lily_lexer *lexer = Lily_lexer::unsmob (s);
 313
 314   scm_puts ("#<Lily_lexer ", port);
 315   scm_display (lexer->scopes_, port);
 316   scm_puts (" >", port);
 317   return 1;
 318 }