lily/lily-lexer.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "lily-lexer.hh"
  21
  22 #include <cctype>
  23 #include <sstream>
  24 using namespace std;
  25
  26 #include "context.hh" // for nested_property_alist
  27 #include "international.hh"
  28 #include "interval.hh"
  29 #include "keyword.hh"
  30 #include "main.hh"
  31 #include "moment.hh"
  32 #include "parser.hh"
  33 #include "scm-hash.hh"
  34 #include "source-file.hh"
  35 #include "warn.hh"
  36 #include "program-option.hh"
  37 #include "lily-parser.hh"
  38
  39 static Keyword_ent the_key_tab[]
  40 =
  41 {
  42   {"accepts", ACCEPTS},
  43   {"addlyrics", ADDLYRICS},
  44   {"alias", ALIAS},
  45   {"alternative", ALTERNATIVE},
  46   {"book", BOOK},
  47   {"bookpart", BOOKPART},
  48   {"change", CHANGE},
  49   {"chordmode", CHORDMODE},
  50   {"chords", CHORDS},
  51   {"consists", CONSISTS},
  52   {"context", CONTEXT},
  53   {"default", DEFAULT},
  54   {"defaultchild", DEFAULTCHILD},
  55   {"denies", DENIES},
  56   {"description", DESCRIPTION},
  57   {"drummode", DRUMMODE},
  58   {"drums", DRUMS},
  59   {"figuremode", FIGUREMODE},
  60   {"figures", FIGURES},
  61   {"grobdescriptions", GROBDESCRIPTIONS},
  62   {"header", HEADER},
  63   {"key", KEY},
  64   {"layout", LAYOUT},
  65   {"lyricmode", LYRICMODE},
  66   {"lyrics", LYRICS},
  67   {"lyricsto", LYRICSTO},
  68   {"mark", MARK},
  69   {"markup", MARKUP},
  70   {"markuplines", MARKUPLINES},
  71   {"midi", MIDI},
  72   {"name", NAME},
  73   {"new", NEWCONTEXT},
  74   {"notemode", NOTEMODE},
  75   {"once", ONCE},
  76   {"override", OVERRIDE},
  77   {"paper", PAPER},
  78   {"remove", REMOVE},
  79   {"repeat", REPEAT},
  80   {"rest", REST},
  81   {"revert", REVERT},
  82   {"score", SCORE},
  83   {"sequential", SEQUENTIAL},
  84   {"set", SET},
  85   {"simultaneous", SIMULTANEOUS},
  86   {"tempo", TEMPO},
  87   {"time", TIME_T},
  88   {"times", TIMES},
  89   {"type", TYPE},
  90   {"unset", UNSET},
  91   {"with", WITH},
  92   {0, 0}
  93 };
  94
  95 Lily_lexer::Lily_lexer (Sources *sources, Lily_parser *parser)
  96 {
  97   parser_ = parser;
  98   keytable_ = new Keyword_table (the_key_tab);
  99   chordmodifier_tab_ = SCM_EOL;
 100   pitchname_tab_stack_ = SCM_EOL;
 101   sources_ = sources;
 102   scopes_ = SCM_EOL;
 103   error_level_ = 0;
 104   is_main_input_ = false;
 105   start_module_ = SCM_EOL;
 106   chord_repetition_ = Chord_repetition ();
 107   extra_tokens_ = SCM_EOL;
 108   smobify_self ();
 109
 110   add_scope (ly_make_module (false));
 111   push_note_state (scm_c_make_hash_table (0));
 112   chordmodifier_tab_ = scm_make_vector (scm_from_int (1), SCM_EOL);
 113 }
 114
 115 Lily_lexer::Lily_lexer (Lily_lexer const &src, Lily_parser *parser)
 116   : Includable_lexer ()
 117 {
 118   parser_ = parser;
 119   keytable_ = (src.keytable_) ? new Keyword_table (*src.keytable_) : 0;
 120   chordmodifier_tab_ = src.chordmodifier_tab_;
 121   pitchname_tab_stack_ = src.pitchname_tab_stack_;
 122   sources_ = src.sources_;
 123   start_module_ = SCM_EOL;
 124   chord_repetition_ = src.chord_repetition_;
 125
 126   error_level_ = src.error_level_;
 127   is_main_input_ = src.is_main_input_;
 128
 129   scopes_ = SCM_EOL;
 130   extra_tokens_ = SCM_EOL;
 131
 132   smobify_self ();
 133
 134   SCM scopes = SCM_EOL;
 135   SCM *tail = &scopes;
 136   for (SCM s = src.scopes_; scm_is_pair (s); s = scm_cdr (s))
 137     {
 138       SCM newmod = ly_make_module (false);
 139       ly_module_copy (newmod, scm_car (s));
 140       *tail = scm_cons (newmod, SCM_EOL);
 141       tail = SCM_CDRLOC (*tail);
 142     }
 143
 144   scopes_ = scopes;
 145   push_note_state (scm_c_make_hash_table (0));
 146 }
 147
 148 Lily_lexer::~Lily_lexer ()
 149 {
 150   delete keytable_;
 151 }
 152
 153 void
 154 Lily_lexer::add_scope (SCM module)
 155 {
 156   ly_reexport_module (scm_current_module ());
 157   if (!scm_is_pair (scopes_))
 158     start_module_ = scm_current_module ();
 159
 160   for (SCM s = scopes_; scm_is_pair (s); s = scm_cdr (s))
 161     ly_use_module (module, scm_car (s));
 162   scopes_ = scm_cons (module, scopes_);
 163
 164   set_current_scope ();
 165 }
 166 bool
 167 Lily_lexer::has_scope () const
 168 {
 169   return scm_is_pair (scopes_);
 170 }
 171
 172 SCM
 173 Lily_lexer::remove_scope ()
 174 {
 175   SCM sc = scm_car (scopes_);
 176   scopes_ = scm_cdr (scopes_);
 177   set_current_scope ();
 178   return sc;
 179 }
 180
 181 SCM
 182 Lily_lexer::set_current_scope ()
 183 {
 184   SCM old = scm_current_module ();
 185
 186   if (scm_is_pair (scopes_))
 187     scm_set_current_module (scm_car (scopes_));
 188   else
 189     scm_set_current_module (start_module_);
 190
 191   return old;
 192 }
 193
 194 int
 195 Lily_lexer::lookup_keyword (string s)
 196 {
 197   return keytable_->lookup (s.c_str ());
 198 }
 199
 200 SCM
 201 Lily_lexer::keyword_list () const
 202 {
 203   if (!keytable_)
 204     return SCM_EOL;
 205
 206   SCM l = SCM_EOL;
 207   SCM *tail = &l;
 208   for (vsize i = 0; i < keytable_->table_.size (); i++)
 209     {
 210       *tail = scm_acons (scm_from_locale_string (keytable_->table_[i].name_),
 211                          scm_from_int (keytable_->table_[i].tokcode_),
 212                          SCM_EOL);
 213
 214       tail = SCM_CDRLOC (*tail);
 215     }
 216
 217   return l;
 218 }
 219
 220 SCM
 221 Lily_lexer::lookup_identifier_symbol (SCM sym)
 222 {
 223   for (SCM s = scopes_; scm_is_pair (s); s = scm_cdr (s))
 224     {
 225       SCM var = ly_module_lookup (scm_car (s), sym);
 226       if (var != SCM_BOOL_F)
 227         return scm_variable_ref (var);
 228     }
 229
 230   return SCM_UNDEFINED;
 231 }
 232
 233 SCM
 234 Lily_lexer::lookup_identifier (string name)
 235 {
 236   return lookup_identifier_symbol (ly_symbol2scm (name.c_str ()));
 237 }
 238
 239 void
 240 Lily_lexer::start_main_input ()
 241 {
 242   yy_flex_debug = get_program_option ("debug-lexer");
 243   parser_->set_yydebug (get_program_option ("debug-parser"));
 244
 245   new_input (main_input_name_, sources_);
 246
 247   scm_module_define (scm_car (scopes_),
 248                      ly_symbol2scm ("input-file-name"),
 249                      ly_string2scm (main_input_name_));
 250 }
 251
 252 void
 253 Lily_lexer::new_input (string str, string d, Sources *ss)
 254 {
 255   Includable_lexer::new_input (str, d, ss);
 256 }
 257
 258 void
 259 Lily_lexer::new_input (string str, Sources *ss)
 260 {
 261   if (is_main_input_ && be_safe_global)
 262     {
 263       LexerError (_ ("include files are not allowed in safe mode").c_str ());
 264       return;
 265     }
 266
 267   Includable_lexer::new_input (str, ss);
 268 }
 269
 270 // PATH is either a single symbol (or string) or a list of symbols
 271 // giving the path to a nested property.  A symbol is treated the same
 272 // as a list of length 1.
 273 void
 274 Lily_lexer::set_identifier (SCM path, SCM val)
 275 {
 276   SCM sym = path;
 277   if (scm_is_string (path))
 278     sym = scm_string_to_symbol (path);
 279   else if (scm_is_pair (path))
 280     {
 281       sym = scm_car (path);
 282       path = scm_cdr (path);
 283     }
 284
 285   if (scm_is_symbol (sym))
 286     {
 287       if (lookup_keyword (ly_symbol2string (sym)) >= 0)
 288         {
 289           string symstr = ly_symbol2string (sym);
 290           warning (_f ("identifier name is a keyword: `%s'", symstr.c_str ()));
 291         }
 292
 293       SCM mod = scm_car (scopes_);
 294
 295       if (scm_is_pair (path))
 296         {
 297           SCM prev = ly_module_lookup (mod, sym);
 298           if (prev != SCM_BOOL_F)
 299             val = nested_property_alist (scm_variable_ref (prev), path, val);
 300         }
 301       scm_module_define (mod, sym, val);
 302     }
 303   else
 304     programming_error ("identifier is not a symbol");
 305 }
 306
 307 void
 308 Lily_lexer::LexerError (char const *s)
 309 {
 310   if (include_stack_.empty ())
 311     non_fatal_error (s, _f ("%s:EOF", s));
 312   else
 313     {
 314       error_level_ |= 1;
 315       Input spot (*lexloc_);
 316       spot.error (s);
 317     }
 318 }
 319
 320 void
 321 Lily_lexer::LexerWarning (char const *s)
 322 {
 323   if (include_stack_.empty ())
 324     warning (s, _f ("%s:EOF", s));
 325   else
 326     {
 327       Input spot (*lexloc_);
 328       spot.warning (s);
 329     }
 330 }
 331
 332 char
 333 Lily_lexer::escaped_char (char c) const
 334 {
 335   switch (c)
 336     {
 337     case 'n':
 338       return '\n';
 339     case 't':
 340       return '\t';
 341     case '\'':
 342     case '\"':
 343     case '\\':
 344       return c;
 345     }
 346   return 0;
 347 }
 348
 349 Input
 350 Lily_lexer::here_input () const
 351 {
 352   return Input (*lexloc_);
 353 }
 354
 355 void
 356 Lily_lexer::prepare_for_next_token ()
 357 {
 358   last_input_ = here_input ();
 359 }
 360
 361 /**
 362    Since we don't create the buffer state from the bytes directly, we
 363    don't know about the location of the lexer. Add this as a
 364    YY_USER_ACTION */
 365 void
 366 Lily_lexer::add_lexed_char (int count)
 367 {
 368   char const *start = here_str0 ();
 369   lexloc_->set (get_source_file (),
 370                 start, start + count);
 371   char_count_stack_.back () += count;
 372 }
 373
 374 #include "ly-smobs.icc"
 375
 376 IMPLEMENT_SMOBS (Lily_lexer);
 377 IMPLEMENT_TYPE_P (Lily_lexer, "ly:lily-lexer?");
 378 IMPLEMENT_DEFAULT_EQUAL_P (Lily_lexer);
 379
 380 SCM
 381 Lily_lexer::mark_smob (SCM s)
 382 {
 383   ASSERT_LIVE_IS_ALLOWED ();
 384
 385   Lily_lexer *lexer = (Lily_lexer *) SCM_CELL_WORD_1 (s);
 386
 387   scm_gc_mark (lexer->chordmodifier_tab_);
 388   if (lexer->parser_)
 389     scm_gc_mark (lexer->parser_->self_scm ());
 390   scm_gc_mark (lexer->pitchname_tab_stack_);
 391   scm_gc_mark (lexer->start_module_);
 392   scm_gc_mark (lexer->extra_tokens_);
 393   return lexer->scopes_;
 394 }
 395
 396 int
 397 Lily_lexer::print_smob (SCM s, SCM port, scm_print_state *)
 398 {
 399   Lily_lexer *lexer = Lily_lexer::unsmob (s);
 400
 401   scm_puts ("#<Lily_lexer ", port);
 402   scm_display (lexer->scopes_, port);
 403   scm_puts (" >", port);
 404   return 1;
 405 }
 406
 407 bool
 408 Lily_lexer::is_clean () const
 409 {
 410   return include_stack_.empty ();
 411 }