lily/lexer.ll

   1 %{ // -*- mode: c++; c-file-style: "linux"; indent-tabs-mode: t -*-
   2 /*
   3   This file is part of LilyPond, the GNU music typesetter.
   4
   5   Copyright (C) 1996--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6                  Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8   LilyPond is free software: you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation, either version 3 of the License, or
  11   (at your option) any later version.
  12
  13   LilyPond is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 /* Mode and indentation are at best a rough approximation based on TAB
  23  * formatting (reasonable for compatibility with unspecific editor
  24  * modes as Flex modes are hard to find) and need manual correction
  25  * frequently.  Without a reasonably dependable way of formatting a
  26  * Flex file sensibly, there is little point in trying to fix the
  27  * inconsistent state of indentation.
  28  */
  29
  30 /*
  31   backup rules
  32
  33   after making a change to the lexer rules, run
  34       flex -b <this lexer file>
  35   and make sure that
  36       lex.backup
  37   contains no backup states, but only the reminder
  38       Compressed tables always back up.
  39  (don-t forget to rm lex.yy.cc :-)
  40  */
  41
  42
  43
  44 #include <cstdio>
  45 #include <cctype>
  46 #include <cerrno>
  47
  48 /* Flex >= 2.5.29 fix; FlexLexer.h's multiple include bracing breaks
  49    when building the actual lexer.  */
  50
  51 #define LEXER_CC
  52
  53 #include <iostream>
  54 using namespace std;
  55
  56 #include "context-def.hh"
  57 #include "duration.hh"
  58 #include "international.hh"
  59 #include "interval.hh"
  60 #include "lily-guile.hh"
  61 #include "lily-lexer.hh"
  62 #include "lily-parser.hh"
  63 #include "lilypond-version.hh"
  64 #include "main.hh"
  65 #include "music.hh"
  66 #include "music-function.hh"
  67 #include "parse-scm.hh"
  68 #include "parser.hh"
  69 #include "pitch.hh"
  70 #include "source-file.hh"
  71 #include "std-string.hh"
  72 #include "version.hh"
  73 #include "warn.hh"
  74 #include "lily-imports.hh"
  75
  76 /*
  77 RH 7 fix (?)
  78 */
  79 #define isatty HORRIBLEKLUDGE
  80
  81 void strip_trailing_white (string&);
  82 void strip_leading_white (string&);
  83 string lyric_fudge (string s);
  84 SCM lookup_markup_command (string s);
  85 SCM lookup_markup_list_command (string s);
  86 bool is_valid_version (string s);
  87
  88
  89 #define start_quote() do {                      \
  90                 yy_push_state (quote);          \
  91                 yylval = SCM_EOL;               \
  92         } while (0)
  93
  94 /*
  95   The inside of \"violin1" is marked by commandquote mode
  96 */
  97
  98 #define start_command_quote() do {              \
  99                 yy_push_state (commandquote);   \
 100                 yylval = SCM_EOL;               \
 101         } while (0)
 102
 103 #define yylval (*lexval_)
 104
 105 #define yylloc (*lexloc_)
 106
 107 #define YY_USER_ACTION  add_lexed_char (YYLeng ());
 108
 109
 110 SCM scan_fraction (string);
 111 SCM (* scm_parse_error_handler) (void *);
 112
 113
 114
 115 %}
 116
 117 %option c++
 118 %option noyywrap
 119 %option nodefault
 120 %option debug
 121 %option yyclass="Lily_lexer"
 122 %option stack
 123 %option never-interactive
 124 %option warn
 125
 126 %x chords
 127 %x figures
 128 %x incl
 129 %x lyrics
 130 %x longcomment
 131 %x maininput
 132 %x markup
 133 %x notes
 134 %x quote
 135 %x commandquote
 136 %x sourcefileline
 137 %x sourcefilename
 138 %x version
 139
 140 /* The strategy concerning multibyte characters is to accept them but
 141  * call YYText_utf8 for patterns that might contain them, in order to
 142  * get a single code path responsible for flagging non-UTF-8 input:
 143  * Patterns for accepting only valid UTF-8 without backing up are
 144  * really hard to do and complex, and if nice error messages are
 145  * wanted, one would need patterns catching the invalid input as well.
 146  *
 147  * Since editors and operating environments don't necessarily behave
 148  * reasonably in the presence of mixed encodings, we flag encoding
 149  * errors also in identifiers, comments, and strings where it would be
 150  * conceivable to just transparently work with the byte string.  But
 151  * the whole point of caring about UTF-8 in here at all is too avoid
 152  * stranger errors later when input passes into backends or log files
 153  * or console output or error messages.
 154  */
 155
 156 A               [a-zA-Z\200-\377]
 157 AA              {A}|_
 158 N               [0-9]
 159 ANY_CHAR        (.|\n)
 160 SYMBOL          {A}([-_]{A}|{A})*
 161 COMMAND         \\{SYMBOL}
 162 /* SPECIAL category is for every letter that needs to get passed to
 163  * the parser rather than being redefinable by the user */
 164 SPECIAL         [-+*/=<>{}!?_^'',.:]
 165 SHORTHAND       (.|\\.)
 166 UNSIGNED        {N}+
 167 E_UNSIGNED      \\{N}+
 168 FRACTION        {N}+\/{N}+
 169 INT             -?{UNSIGNED}
 170 REAL            ({INT}\.{N}*)|(-?\.{N}+)
 171 STRICTREAL      {UNSIGNED}\.{UNSIGNED}
 172 WHITE           [ \n\t\f\r]
 173 HORIZONTALWHITE         [ \t]
 174 BLACK           [^ \n\t\f\r]
 175 RESTNAME        [rs]
 176 ESCAPED         [nt\\''""]
 177 EXTENDER        __
 178 HYPHEN          --
 179 BOM_UTF8        \357\273\277
 180
 181 %%
 182
 183
 184 <*>\r           {
 185         // swallow and ignore carriage returns
 186 }
 187
 188    /* Use the trailing context feature. Otherwise, the BOM will not be
 189       found if the file starts with an identifier definition. */
 190 <INITIAL,chords,lyrics,figures,notes>{BOM_UTF8}/.* {
 191   if (lexloc_->line_number () != 1 || lexloc_->column_number () != 0)
 192     {
 193       LexerWarning (_ ("stray UTF-8 BOM encountered").c_str ());
 194       // exit (1);
 195     }
 196   debug_output (_ ("Skipping UTF-8 BOM"));
 197 }
 198
 199 <INITIAL,chords,figures,incl,lyrics,markup,notes>{
 200   "%{"  {
 201         yy_push_state (longcomment);
 202   }
 203   %[^{\n\r][^\n\r]*[\n\r]?      {
 204           (void) YYText_utf8 ();
 205   }
 206   %[\n\r]?      {
 207   }
 208   {WHITE}+      {
 209
 210   }
 211 }
 212
 213 <INITIAL,notes,figures,chords,markup>{
 214         \"              {
 215                 start_quote ();
 216         }
 217 }
 218
 219 <INITIAL,chords,lyrics,notes,figures>\\version{WHITE}*  {
 220         yy_push_state (version);
 221 }
 222 <INITIAL,chords,lyrics,notes,figures>\\sourcefilename{WHITE}*   {
 223         yy_push_state (sourcefilename);
 224 }
 225 <INITIAL,chords,lyrics,notes,figures>\\sourcefileline{WHITE}*   {
 226         yy_push_state (sourcefileline);
 227 }
 228 <version>\"[^""]*\"     { /* got the version number */
 229         string s (YYText_utf8 () + 1);
 230         s = s.substr (0, s.rfind ('\"'));
 231
 232         yy_pop_state ();
 233
 234         SCM top_scope = scm_car (scm_last_pair (scopes_));
 235         scm_module_define (top_scope, ly_symbol2scm ("version-seen"), SCM_BOOL_T);
 236
 237         if (!is_valid_version (s)) {
 238                 yylval = SCM_UNSPECIFIED;
 239                 return INVALID;
 240         }
 241 }
 242 <sourcefilename>\"[^""]*\"     {
 243         string s (YYText_utf8 () + 1);
 244         s = s.substr (0, s.rfind ('\"'));
 245
 246         yy_pop_state ();
 247         here_input().get_source_file ()->name_ = s;
 248         message (_f ("Renaming input to: `%s'", s.c_str ()));
 249         progress_indication ("\n");
 250         scm_module_define (scm_car (scopes_),
 251                      ly_symbol2scm ("input-file-name"),
 252                      ly_string2scm (s));
 253
 254 }
 255
 256 <sourcefileline>{INT}   {
 257         int i;
 258         sscanf (YYText (), "%d", &i);
 259
 260         yy_pop_state ();
 261         here_input ().get_source_file ()->set_line (here_input ().start (), i);
 262 }
 263
 264 <version>{ANY_CHAR}     {
 265         LexerError (_ ("quoted string expected after \\version").c_str ());
 266         yy_pop_state ();
 267 }
 268 <sourcefilename>{ANY_CHAR}      {
 269         LexerError (_ ("quoted string expected after \\sourcefilename").c_str ());
 270         yy_pop_state ();
 271 }
 272 <sourcefileline>{ANY_CHAR}      {
 273         LexerError (_ ("integer expected after \\sourcefileline").c_str ());
 274         yy_pop_state ();
 275 }
 276 <longcomment>{
 277         [^\%]*          {
 278                 (void) YYText_utf8 ();
 279         }
 280         \%*[^}%]*               {
 281                 (void) YYText_utf8 ();
 282         }
 283         "%"+"}"         {
 284                 yy_pop_state ();
 285         }
 286 }
 287
 288
 289 <INITIAL,chords,lyrics,notes,figures>\\maininput           {
 290         if (!is_main_input_)
 291         {
 292                 start_main_input ();
 293                 main_input_level_ = include_stack_.size ();
 294                 is_main_input_ = true;
 295                 int state = YYSTATE;
 296                 yy_push_state (maininput);
 297                 yy_push_state (state);
 298         }
 299         else
 300                 LexerError (_ ("\\maininput not allowed outside init files").c_str ());
 301 }
 302
 303 <INITIAL,chords,lyrics,figures,notes>\\include           {
 304         yy_push_state (incl);
 305 }
 306 <incl>\"[^""]*\"   { /* got the include file name */
 307         string s (YYText_utf8 ()+1);
 308         s = s.substr (0, s.rfind ('"'));
 309
 310         new_input (s, sources_);
 311         yy_pop_state ();
 312 }
 313 <incl>\\{BLACK}*{WHITE}? { /* got the include identifier */
 314         string s = YYText_utf8 () + 1;
 315         strip_trailing_white (s);
 316         if (s.length () && (s[s.length () - 1] == ';'))
 317           s = s.substr (0, s.length () - 1);
 318
 319         SCM sid = lookup_identifier (s);
 320         if (scm_is_string (sid)) {
 321                 new_input (ly_scm2string (sid), sources_);
 322                 yy_pop_state ();
 323         } else {
 324             string msg (_f ("wrong or undefined identifier: `%s'", s ));
 325
 326             LexerError (msg.c_str ());
 327             SCM err = scm_current_error_port ();
 328             scm_puts ("This value was found in the table: ", err);
 329             scm_display (sid, err);
 330           }
 331 }
 332 <incl>(\$|#) { // scm for the filename
 333         Input hi = here_input();
 334         hi.step_forward ();
 335         SCM sval = ly_parse_scm (hi, be_safe_global && is_main_input_, parser_);
 336         sval = eval_scm (sval, hi);
 337         int n = hi.end () - hi.start ();
 338
 339         for (int i = 0; i < n; i++)
 340         {
 341                 yyinput ();
 342         }
 343         char_count_stack_.back () += n;
 344
 345         if (scm_is_string (sval)) {
 346                 new_input (ly_scm2string (sval), sources_);
 347                 yy_pop_state ();
 348         } else {
 349                 LexerError (_ ("string expected after \\include").c_str ());
 350                 if (!SCM_UNBNDP (sval)) {
 351                         SCM err = scm_current_error_port ();
 352                         scm_puts ("This value was found instead: ", err);
 353                         scm_display (sval, err);
 354                 }
 355         }
 356 }
 357
 358 <incl,version,sourcefilename>\"[^""]*   { // backup rule
 359         LexerError (_ ("end quote missing").c_str ());
 360         yy_pop_state ();
 361 }
 362
 363     /* Flex picks the longest matching pattern including trailing
 364      * contexts.  Without the backup pattern, r-. does not trigger the
 365      * {RESTNAME} rule but rather the {SYMBOL}/[-_] rule coming later,
 366      * needed for avoiding backup states.
 367      */
 368
 369 <chords,notes,figures>{RESTNAME}/[-_]   |  // pseudo backup rule
 370 <chords,notes,figures>{RESTNAME}        {
 371         char const *s = YYText ();
 372         yylval = scm_from_ascii_string (s);
 373         return RESTNAME;
 374 }
 375 <chords,notes,figures>q/[-_]    | // pseudo backup rule
 376 <chords,notes,figures>q {
 377         yylval = SCM_UNSPECIFIED;
 378         return CHORD_REPETITION;
 379 }
 380
 381 <chords,notes,figures>R/[-_]    | // pseudo backup rule
 382 <chords,notes,figures>R         {
 383         yylval = SCM_UNSPECIFIED;
 384         return MULTI_MEASURE_REST;
 385 }
 386 <INITIAL,chords,figures,lyrics,markup,notes>#   { //embedded scm
 387         Input hi = here_input();
 388         hi.step_forward ();
 389         SCM sval = ly_parse_scm (hi, be_safe_global && is_main_input_, parser_);
 390
 391         if (SCM_UNBNDP (sval))
 392                 error_level_ = 1;
 393
 394         int n = hi.end () - hi.start ();
 395         for (int i = 0; i < n; i++)
 396         {
 397                 yyinput ();
 398         }
 399         char_count_stack_.back () += n;
 400
 401         yylval = sval;
 402         return SCM_TOKEN;
 403 }
 404
 405 <INITIAL,chords,figures,lyrics,markup,notes>\$  { //immediate scm
 406         Input hi = here_input();
 407         hi.step_forward ();
 408         SCM sval = ly_parse_scm (hi, be_safe_global && is_main_input_, parser_);
 409
 410         int n = hi.end () - hi.start ();
 411
 412         for (int i = 0; i < n; i++)
 413         {
 414                 yyinput ();
 415         }
 416         char_count_stack_.back () += n;
 417
 418         sval = eval_scm (sval, hi, '$');
 419
 420         int token = scan_scm_id (sval);
 421         if (!scm_is_eq (yylval, SCM_UNSPECIFIED))
 422                 return token;
 423 }
 424
 425 <INITIAL,notes,lyrics,chords>{
 426         \<\<    {
 427                 yylval = SCM_UNSPECIFIED;
 428                 return DOUBLE_ANGLE_OPEN;
 429         }
 430         \>\>    {
 431                 yylval = SCM_UNSPECIFIED;
 432                 return DOUBLE_ANGLE_CLOSE;
 433         }
 434 }
 435
 436 <INITIAL,notes,chords>{
 437         \<      {
 438                 yylval = SCM_UNSPECIFIED;
 439                 return ANGLE_OPEN;
 440         }
 441         \>      {
 442                 yylval = SCM_UNSPECIFIED;
 443                 return ANGLE_CLOSE;
 444         }
 445 }
 446
 447 <figures>{
 448         _       {
 449                 yylval = SCM_UNSPECIFIED;
 450                 return FIGURE_SPACE;
 451         }
 452         \>              {
 453                 yylval = SCM_UNSPECIFIED;
 454                 return FIGURE_CLOSE;
 455         }
 456         \<      {
 457                 yylval = SCM_UNSPECIFIED;
 458                 return FIGURE_OPEN;
 459         }
 460         \\\+    {
 461                 yylval = SCM_UNSPECIFIED;
 462                 return E_PLUS;
 463         }
 464         \\!     {
 465                 yylval = SCM_UNSPECIFIED;
 466                 return E_EXCLAMATION;
 467         }
 468         \\\\    {
 469                 yylval = SCM_UNSPECIFIED;
 470                 return E_BACKSLASH;
 471         }
 472         [][]    {
 473                 yylval = SCM_UNSPECIFIED;
 474                 return  YYText ()[0];
 475         }
 476 }
 477
 478 <notes,figures>{
 479         {SYMBOL}/[-_]   | // backup rule
 480         {SYMBOL}        {
 481                 return scan_bare_word (YYText_utf8 ());
 482         }
 483         \\\"    {
 484                 start_command_quote ();
 485         }
 486         {COMMAND}/[-_]  | // backup rule
 487         {COMMAND}       {
 488                 return scan_escaped_word (YYText_utf8 () + 1);
 489         }
 490         {FRACTION}      {
 491                 yylval =  scan_fraction (YYText ());
 492                 return FRACTION;
 493         }
 494         {STRICTREAL}    {
 495                 yylval = scm_c_read_string (YYText ());
 496                 return REAL;
 497         }
 498         {UNSIGNED}/[/.] | // backup rule
 499         {UNSIGNED}      {
 500                 yylval = scm_c_read_string (YYText ());
 501                 return UNSIGNED;
 502         }
 503         {E_UNSIGNED}    {
 504                 yylval = scm_c_read_string (YYText () + 1);
 505                 return E_UNSIGNED;
 506         }
 507 }
 508
 509 <quote,commandquote>{
 510         \\{ESCAPED}     {
 511                 char c = escaped_char (YYText ()[1]);
 512                 yylval = scm_cons (scm_from_ascii_stringn (&c, 1),
 513                                    yylval);
 514         }
 515         [^\\""]+        {
 516                 yylval = scm_cons (scm_from_utf8_string (YYText_utf8 ()),
 517                                    yylval);
 518         }
 519         \"      {
 520
 521                 /* yylval is union. Must remember STRING before setting SCM*/
 522
 523                 yylval = scm_string_concatenate_reverse (yylval,
 524                                                          SCM_UNDEFINED,
 525                                                          SCM_UNDEFINED);
 526
 527                 if (get_state () == commandquote) {
 528                         yy_pop_state ();
 529                         return scan_escaped_word (ly_scm2string (yylval));
 530                 }
 531
 532                 yy_pop_state ();
 533
 534                 return STRING;
 535         }
 536         \\      {
 537                 yylval = scm_cons (scm_from_ascii_string (YYText ()),
 538                                    yylval);
 539         }
 540 }
 541
 542 <lyrics>{
 543         \" {
 544                 start_quote ();
 545         }
 546         {FRACTION}      {
 547                 yylval =  scan_fraction (YYText ());
 548                 return FRACTION;
 549         }
 550         {STRICTREAL}    {
 551                 yylval = scm_c_read_string (YYText ());
 552                 return REAL;
 553         }
 554         {UNSIGNED}/[/.] | // backup rule
 555         {UNSIGNED}              {
 556                 yylval = scm_c_read_string (YYText ());
 557                 return UNSIGNED;
 558         }
 559         \\\"    {
 560                 start_command_quote ();
 561         }
 562         {COMMAND}/[-_]  | // backup rule
 563         {COMMAND}       {
 564                 return scan_escaped_word (YYText_utf8 () + 1);
 565         }
 566         \\.|\|  {
 567                 // UTF-8 already covered by COMMAND
 568                 return scan_shorthand (YYText ());
 569         }
 570         /* Characters needed to express durations, assignments */
 571         [*.=]   {
 572                 yylval = SCM_UNSPECIFIED;
 573                 return YYText ()[0];
 574         }
 575         [^|*.=$#{}\"\\ \t\n\r\f0-9][^$#{}\"\\ \t\n\r\f0-9]* {
 576                 /* ugr. This sux. */
 577                 string s (YYText_utf8 ());
 578                 yylval = SCM_UNSPECIFIED;
 579                 if (s == "__")
 580                         return EXTENDER;
 581                 if (s == "--")
 582                         return HYPHEN;
 583                 s = lyric_fudge (s);
 584                 yylval = ly_string2scm (s);
 585
 586                 return SYMBOL;
 587         }
 588         /* This should really just cover {} */
 589         [{}] {
 590                 yylval = SCM_UNSPECIFIED;
 591                 return YYText ()[0];
 592         }
 593 }
 594 <chords>{
 595         {SYMBOL}/[-_]   | // backup rule
 596         {SYMBOL}        {
 597                 return scan_bare_word (YYText_utf8 ());
 598         }
 599         \\\"    {
 600                 start_command_quote ();
 601         }
 602         {COMMAND}/[-_]  | // backup rule
 603         {COMMAND}       {
 604                 return scan_escaped_word (YYText_utf8 () + 1);
 605         }
 606         {FRACTION}      {
 607                 yylval =  scan_fraction (YYText ());
 608                 return FRACTION;
 609         }
 610         {UNSIGNED}/\/   | // backup rule
 611         {UNSIGNED}              {
 612                 yylval = scm_c_read_string (YYText ());
 613                 return UNSIGNED;
 614         }
 615         -  {
 616                 yylval = SCM_UNSPECIFIED;
 617                 return CHORD_MINUS;
 618         }
 619         :  {
 620                 yylval = SCM_UNSPECIFIED;
 621                 return CHORD_COLON;
 622         }
 623         \/\+ {
 624                 yylval = SCM_UNSPECIFIED;
 625                 return CHORD_BASS;
 626         }
 627         \/  {
 628                 yylval = SCM_UNSPECIFIED;
 629                 return CHORD_SLASH;
 630         }
 631         \^  {
 632                 yylval = SCM_UNSPECIFIED;
 633                 return CHORD_CARET;
 634         }
 635 }
 636
 637
 638 <markup>{
 639         \\score {
 640                 yylval = SCM_UNSPECIFIED;
 641                 return SCORE;
 642         }
 643         \\score-lines {
 644                 yylval = SCM_UNSPECIFIED;
 645                 return SCORELINES;
 646         }
 647         \\\"    {
 648                 start_command_quote ();
 649         }
 650         {COMMAND}/[-_]  | // backup rule
 651         {COMMAND} {
 652                 string str (YYText_utf8 () + 1);
 653
 654                 int token_type = MARKUP_FUNCTION;
 655                 SCM s = lookup_markup_command (str);
 656
 657                 // lookup-markup-command returns a pair with the car
 658                 // being the function to call, and the cdr being the
 659                 // call signature specified to define-markup-command,
 660                 // a list of predicates.
 661
 662                 if (!scm_is_pair (s)) {
 663                   // If lookup-markup-command was not successful, we
 664                   // try lookup-markup-list-command instead.
 665                   // If this fails as well, we just scan and return
 666                   // the escaped word.
 667                   s = lookup_markup_list_command (str);
 668                   if (scm_is_pair (s))
 669                     token_type = MARKUP_LIST_FUNCTION;
 670                   else
 671                     return scan_escaped_word (str);
 672                 }
 673
 674                 // If the list of predicates is, say,
 675                 // (number? number? markup?), then tokens
 676                 // EXPECT_MARKUP EXPECT_SCM EXPECT_SCM EXPECT_NO_MORE_ARGS
 677                 // will be generated.  Note that we have to push them
 678                 // in reverse order, so the first token pushed in the
 679                 // loop will be EXPECT_NO_MORE_ARGS.
 680
 681                 yylval = scm_car(s);
 682
 683                 // yylval now contains the function to call as token
 684                 // value (for token type MARKUP_FUNCTION or
 685                 // MARKUP_LIST_FUNCTION).
 686
 687                 push_markup_predicates (scm_cdr (s));
 688
 689                 return token_type;
 690         }
 691         [^$#{}\"\\ \t\n\r\f]+ {
 692                 string s (YYText_utf8 ());
 693
 694                 yylval = ly_string2scm (s);
 695                 return SYMBOL;
 696         }
 697         [{}]  {
 698                 yylval = SCM_UNSPECIFIED;
 699                 return YYText ()[0];
 700         }
 701 }
 702
 703 <longcomment><<EOF>> {
 704                 LexerError (_ ("EOF found inside a comment").c_str ());
 705                 yy_pop_state ();
 706         }
 707
 708 <quote,commandquote><<EOF>> {
 709         LexerError (_ ("EOF found inside string").c_str ());
 710         yy_pop_state ();
 711 }
 712
 713 <<EOF>> {
 714         yylval = SCM_UNSPECIFIED;
 715         if (is_main_input_)
 716         {
 717                 is_main_input_ = include_stack_.size () > main_input_level_;
 718                 if (!is_main_input_)
 719                 {
 720                         main_input_level_ = 0;
 721                         pop_state ();
 722                         if (YYSTATE != maininput)
 723                         {
 724                                 LexerError (_ ("Unfinished main input").c_str ());
 725                                 do {
 726                                         yy_pop_state ();
 727                                 } while (YYSTATE != maininput);
 728                         }
 729                         extra_tokens_ = SCM_EOL;
 730                         yy_pop_state ();
 731                 }
 732                 if (!close_input () || !is_main_input_)
 733                 /* Returns YY_NULL */
 734                         yyterminate ();
 735         }
 736         else if (!close_input ())
 737                 /* Returns YY_NULL */
 738                 yyterminate ();
 739 }
 740
 741 <maininput>{ANY_CHAR} {
 742         while (include_stack_.size () > main_input_level_
 743                && close_input ())
 744                 ;
 745         yyterminate ();
 746 }
 747
 748 <INITIAL>{
 749         {SYMBOL}/[-_]   | // backup rule
 750         {SYMBOL}        {
 751                 return scan_bare_word (YYText_utf8 ());
 752         }
 753         \\\"    {
 754                 start_command_quote ();
 755         }
 756         {COMMAND}/[-_]  | // backup rule
 757         {COMMAND}       {
 758                 return scan_escaped_word (YYText_utf8 () + 1);
 759         }
 760 }
 761
 762 {FRACTION}      {
 763         yylval =  scan_fraction (YYText ());
 764         return FRACTION;
 765 }
 766
 767 -{UNSIGNED}     | // backup rule
 768 {REAL}          {
 769         yylval = scm_c_read_string (YYText ());
 770         return REAL;
 771 }
 772
 773 {UNSIGNED}/\/   | // backup rule
 774 {UNSIGNED}      {
 775         yylval = scm_c_read_string (YYText ());
 776         return UNSIGNED;
 777 }
 778
 779
 780 -/\.    { // backup rule
 781         yylval = SCM_UNSPECIFIED;
 782         return YYText ()[0];
 783 }
 784
 785 <INITIAL,chords,lyrics,figures,notes>{SPECIAL}  {
 786         yylval = SCM_UNSPECIFIED;
 787         return YYText ()[0];
 788 }
 789
 790 <INITIAL,chords,lyrics,figures,notes>{SHORTHAND}        {
 791         return scan_shorthand (YYText_utf8 ()); // should not be utf-8
 792 }
 793
 794 <*>.[\200-\277]*        {
 795         string msg = _f ("invalid character: `%s'", YYText_utf8 ());
 796         LexerError (msg.c_str ());
 797         yylval = SCM_UNSPECIFIED;
 798         return '%';  // Better not return half a utf8 character.
 799 }
 800
 801 %%
 802
 803 /* Make the lexer generate a token of the given type as the next token.
 804  TODO: make it possible to define a value for the token as well */
 805 void
 806 Lily_lexer::push_extra_token (Input const &where, int token_type, SCM scm)
 807 {
 808         extra_tokens_ = scm_cons (scm_cons2 (where.smobbed_copy (),
 809                                              scm_from_int (token_type),
 810                                              scm), extra_tokens_);
 811 }
 812
 813 int
 814 Lily_lexer::pop_extra_token ()
 815 {
 816         if (scm_is_null (extra_tokens_))
 817                 return -1;
 818
 819   /* produce requested token */
 820         yylloc = *unsmob<Input> (scm_caar (extra_tokens_));
 821         int type = scm_to_int (scm_cadar (extra_tokens_));
 822         yylval = scm_cddar (extra_tokens_);
 823         extra_tokens_ = scm_cdr (extra_tokens_);
 824         return type;
 825 }
 826
 827 void
 828 Lily_lexer::push_chord_state (SCM alist)
 829 {
 830         SCM p = scm_assq (alist, pitchname_tab_stack_);
 831
 832         if (scm_is_false (p))
 833                 p = scm_cons (alist, alist_to_hashq (alist));
 834         pitchname_tab_stack_ = scm_cons (p, pitchname_tab_stack_);
 835         yy_push_state (chords);
 836 }
 837
 838 void
 839 Lily_lexer::push_figuredbass_state ()
 840 {
 841         yy_push_state (figures);
 842 }
 843
 844 void
 845 Lily_lexer::push_initial_state ()
 846 {
 847         yy_push_state (INITIAL);
 848 }
 849
 850 void
 851 Lily_lexer::push_lyric_state ()
 852 {
 853         yy_push_state (lyrics);
 854 }
 855
 856 void
 857 Lily_lexer::push_markup_state ()
 858 {
 859         yy_push_state (markup);
 860 }
 861
 862 void
 863 Lily_lexer::push_note_state (SCM alist)
 864 {
 865         SCM p = scm_assq (alist, pitchname_tab_stack_);
 866
 867         if (scm_is_false (p))
 868                 p = scm_cons (alist, alist_to_hashq (alist));
 869         pitchname_tab_stack_ = scm_cons (p, pitchname_tab_stack_);
 870         yy_push_state (notes);
 871 }
 872
 873 void
 874 Lily_lexer::pop_state ()
 875 {
 876         if (YYSTATE == notes || YYSTATE == chords)
 877                 pitchname_tab_stack_ = scm_cdr (pitchname_tab_stack_);
 878
 879         // don't cross the maininput threshold
 880         if (YYSTATE != maininput)
 881                 yy_pop_state ();
 882
 883 }
 884
 885 void
 886 Lily_lexer::push_markup_predicates (SCM sig)
 887 {
 888         push_extra_token (here_input (), EXPECT_NO_MORE_ARGS);
 889         for (SCM s = sig; scm_is_pair(s); s = scm_cdr(s)) {
 890                 SCM predicate = scm_car(s);
 891
 892                 if (scm_is_eq (predicate, SCM (Lily::markup_list_p)))
 893                         push_extra_token (here_input (), EXPECT_MARKUP_LIST);
 894                 else if (scm_is_eq (predicate, SCM (Lily::markup_p)))
 895                         push_extra_token (here_input (), EXPECT_MARKUP);
 896                 else
 897                         push_extra_token (here_input (), EXPECT_SCM, predicate);
 898         }
 899 }
 900
 901
 902 int
 903 Lily_lexer::identifier_type (SCM sid)
 904 {
 905         int k = try_special_identifiers (&yylval , sid);
 906         return k >= 0  ? k : SCM_IDENTIFIER;
 907 }
 908
 909
 910 int
 911 Lily_lexer::scan_escaped_word (const string &str)
 912 {
 913         // use more SCM for this.
 914
 915 //      SCM sym = ly_symbol2scm (str.c_str ());
 916
 917         yylval = SCM_UNSPECIFIED;
 918         int i = lookup_keyword (str);
 919
 920         if (i != -1)
 921                 return i;
 922
 923         SCM sid = lookup_identifier (str);
 924         if (Music *m = unsmob<Music> (sid))
 925         {
 926                 m->set_spot (override_input (here_input ()));
 927         }
 928
 929         if (!SCM_UNBNDP (sid))
 930                 return scan_scm_id (sid);
 931
 932         string msg (_f ("unknown escaped string: `\\%s'", str));
 933         LexerError (msg.c_str ());
 934
 935         yylval = ly_string2scm (str);
 936
 937         return STRING; // SYMBOL would cause additional processing
 938 }
 939
 940 int
 941 Lily_lexer::scan_shorthand (const string &str)
 942 {
 943         SCM sid = lookup_identifier (str);
 944         if (Music *m = unsmob<Music> (sid))
 945         {
 946                 m->set_spot (override_input (here_input ()));
 947         }
 948
 949         if (!SCM_UNBNDP (sid))
 950                 return scan_scm_id (sid);
 951
 952         string msg (_f ("undefined character or shorthand: %s", str));
 953         LexerError (msg.c_str ());
 954
 955         yylval = ly_string2scm (str);
 956
 957         return STRING;
 958 }
 959
 960 int
 961 Lily_lexer::scan_scm_id (SCM sid)
 962 {
 963         if (Music_function *fun = unsmob<Music_function> (sid))
 964         {
 965                 int funtype = SCM_FUNCTION;
 966
 967                 yylval = sid;
 968
 969                 SCM s = fun->get_signature ();
 970                 SCM cs = scm_car (s);
 971
 972                 if (scm_is_pair (cs))
 973                 {
 974                         cs = SCM_CAR (cs);
 975                 }
 976
 977                 if (scm_is_eq (cs, SCM (Lily::ly_music_p)))
 978                         funtype = MUSIC_FUNCTION;
 979                 else if (scm_is_eq (cs, SCM (Lily::ly_event_p)))
 980                         funtype = EVENT_FUNCTION;
 981                 else if (ly_is_procedure (cs))
 982                         funtype = SCM_FUNCTION;
 983                 else programming_error ("Bad syntax function predicate");
 984
 985                 push_extra_token (here_input (), EXPECT_NO_MORE_ARGS);
 986                 for (s = scm_cdr (s); scm_is_pair (s); s = scm_cdr (s))
 987                 {
 988                         SCM optional = SCM_UNDEFINED;
 989                         cs = scm_car (s);
 990
 991                         if (scm_is_pair (cs))
 992                         {
 993                                 optional = SCM_CDR (cs);
 994                                 cs = SCM_CAR (cs);
 995                         }
 996
 997                         if (ly_is_procedure (cs))
 998                                 push_extra_token (here_input (), EXPECT_SCM, cs);
 999                         else
1000                         {
1001                                 programming_error ("Function parameter without type-checking predicate");
1002                                 continue;
1003                         }
1004                         if (!scm_is_eq (optional, SCM_UNDEFINED))
1005                                 push_extra_token (here_input (), EXPECT_OPTIONAL, optional);
1006                 }
1007                 return funtype;
1008         }
1009         yylval = sid;
1010         return identifier_type (sid);
1011 }
1012
1013 int
1014 Lily_lexer::scan_word (SCM & output, SCM sym)
1015 {
1016         if ((YYSTATE == notes) || (YYSTATE == chords)) {
1017                 SCM handle = SCM_BOOL_F;
1018                 if (scm_is_pair (pitchname_tab_stack_))
1019                         handle = scm_hashq_get_handle (scm_cdar (pitchname_tab_stack_), sym);
1020
1021                 if (scm_is_pair (handle)) {
1022                         output = scm_cdr (handle);
1023                         if (unsmob<Pitch> (yylval))
1024                             return (YYSTATE == notes) ? NOTENAME_PITCH : TONICNAME_PITCH;
1025                         else if (scm_is_symbol (yylval))
1026                             return DRUM_PITCH;
1027                 }
1028                 else if ((YYSTATE == chords)
1029                         && scm_is_true (handle = scm_hashq_get_handle (chordmodifier_tab_, sym)))
1030                 {
1031                     output = scm_cdr (handle);
1032                     return CHORD_MODIFIER;
1033                 }
1034         }
1035         output = SCM_UNDEFINED;
1036         return -1;
1037 }
1038
1039 int
1040 Lily_lexer::scan_bare_word (const string &str)
1041 {
1042         int state = scan_word (yylval, ly_symbol2scm (str.c_str ()));
1043         if (state >= 0)
1044         {
1045                 return state;
1046         }
1047         yylval = ly_string2scm (str);
1048         return SYMBOL;
1049 }
1050
1051 int
1052 Lily_lexer::get_state () const
1053 {
1054         return YY_START;
1055 }
1056
1057 bool
1058 Lily_lexer::is_note_state () const
1059 {
1060         return get_state () == notes;
1061 }
1062
1063 bool
1064 Lily_lexer::is_chord_state () const
1065 {
1066         return get_state () == chords;
1067 }
1068
1069 bool
1070 Lily_lexer::is_lyric_state () const
1071 {
1072         return get_state () == lyrics;
1073 }
1074
1075 bool
1076 Lily_lexer::is_figure_state () const
1077 {
1078         return get_state () == figures;
1079 }
1080
1081 // The extra_token parameter specifies how to convert multiple values
1082 // into additional tokens.  For '#', additional values get pushed as
1083 // SCM_IDENTIFIER.  For '$', they get checked for their type and get
1084 // pushed as a corresponding *_IDENTIFIER token.  Since the latter
1085 // tampers with yylval, it can only be done from the lexer itself, so
1086 // this function is private.
1087
1088 SCM
1089 Lily_lexer::eval_scm (SCM readerdata, Input hi, char extra_token)
1090 {
1091         SCM sval = SCM_UNDEFINED;
1092
1093         if (!SCM_UNBNDP (readerdata))
1094         {
1095                 sval = ly_eval_scm (readerdata,
1096                                     hi,
1097                                     be_safe_global && is_main_input_,
1098                                     parser_);
1099         }
1100
1101         if (SCM_UNBNDP (sval))
1102         {
1103                 error_level_ = 1;
1104                 return SCM_UNSPECIFIED;
1105         }
1106
1107         if (extra_token && SCM_VALUESP (sval))
1108         {
1109                 sval = scm_struct_ref (sval, SCM_INUM0);
1110
1111                 if (scm_is_pair (sval)) {
1112                         for (SCM p = scm_reverse (scm_cdr (sval));
1113                              scm_is_pair (p);
1114                              p = scm_cdr (p))
1115                         {
1116                                 SCM v = scm_car (p);
1117                                 if (Music *m = unsmob<Music> (v))
1118                                 {
1119                                         if (!unsmob<Input> (m->get_property ("origin")))
1120                                                 m->set_spot (override_input (here_input ()));
1121                                 }
1122
1123                                 int token;
1124                                 switch (extra_token) {
1125                                 case '$':
1126                                         token = scan_scm_id (v);
1127                                         if (!scm_is_eq (yylval, SCM_UNSPECIFIED))
1128                                                 push_extra_token (here_input (),
1129                                                                   token, yylval);
1130                                         break;
1131                                 case '#':
1132                                         push_extra_token (here_input (),
1133                                                           SCM_IDENTIFIER, v);
1134                                         break;
1135                                 }
1136                         }
1137                         sval = scm_car (sval);
1138                 } else
1139                         sval = SCM_UNSPECIFIED;
1140         }
1141
1142         if (Music *m = unsmob<Music> (sval))
1143         {
1144                 if (!unsmob<Input> (m->get_property ("origin")))
1145                         m->set_spot (override_input (here_input ()));
1146         }
1147
1148         return sval;
1149 }
1150
1151 /* Check for valid UTF-8 that has no overlong or surrogate codes and
1152    is in the range 0-0x10ffff */
1153
1154 const char *
1155 Lily_lexer::YYText_utf8 ()
1156 {
1157         const char * const p =  YYText ();
1158         for (int i=0; p[i];) {
1159                 if ((p[i] & 0xff) < 0x80) {
1160                         ++i;
1161                         continue;
1162                 }
1163                 int oldi = i; // start of character
1164                 int more = 0; // # of followup bytes, 0 if bad
1165                 switch (p[i++] & 0xff) {
1166                         // 0xc0 and 0xc1 are overlong prefixes for
1167                         // 0x00-0x3f and 0x40-0x7f respectively, bad.
1168                 case 0xc2:      // 0x80-0xbf
1169                 case 0xc3:      // 0xc0-0xff
1170                 case 0xc4:      // 0x100-0x13f
1171                 case 0xc5:      // 0x140-0x17f
1172                 case 0xc6:      // 0x180-0x1bf
1173                 case 0xc7:      // 0x1c0-0x1ff
1174                 case 0xc8:      // 0x200-0x23f
1175                 case 0xc9:      // 0x240-0x27f
1176                 case 0xca:      // 0x280-0x2bf
1177                 case 0xcb:      // 0x2c0-0x2ff
1178                 case 0xcc:      // 0x300-0x33f
1179                 case 0xcd:      // 0x340-0x37f
1180                 case 0xce:      // 0x380-0x3bf
1181                 case 0xcf:      // 0x3c0-0x3ff
1182                 case 0xd0:      // 0x400-0x43f
1183                 case 0xd1:      // 0x440-0x47f
1184                 case 0xd2:      // 0x480-0x4bf
1185                 case 0xd3:      // 0x4c0-0x4ff
1186                 case 0xd4:      // 0x500-0x53f
1187                 case 0xd5:      // 0x540-0x57f
1188                 case 0xd6:      // 0x580-0x5bf
1189                 case 0xd7:      // 0x5c0-0x5ff
1190                 case 0xd8:      // 0x600-0x63f
1191                 case 0xd9:      // 0x640-0x67f
1192                 case 0xda:      // 0x680-0x6bf
1193                 case 0xdb:      // 0x6c0-0x6ff
1194                 case 0xdc:      // 0x700-0x73f
1195                 case 0xdd:      // 0x740-0x77f
1196                 case 0xde:      // 0x780-0x7bf
1197                 case 0xdf:      // 0x7c0-0x7ff
1198                         more = 1; // 2-byte sequences, 0x80-0x7ff
1199                         break;
1200                 case 0xe0:
1201                         // don't allow overlong sequences for 0-0x7ff
1202                         if ((p[i] & 0xff) < 0xa0)
1203                                 break;
1204                 case 0xe1:      // 0x1000-0x1fff
1205                 case 0xe2:      // 0x2000-0x2fff
1206                 case 0xe3:      // 0x3000-0x3fff
1207                 case 0xe4:      // 0x4000-0x4fff
1208                 case 0xe5:      // 0x5000-0x5fff
1209                 case 0xe6:      // 0x6000-0x6fff
1210                 case 0xe7:      // 0x7000-0x7fff
1211                 case 0xe8:      // 0x8000-0x8fff
1212                 case 0xe9:      // 0x9000-0x9fff
1213                 case 0xea:      // 0xa000-0xafff
1214                 case 0xeb:      // 0xb000-0xbfff
1215                 case 0xec:      // 0xc000-0xcfff
1216                         more = 2; // 3-byte sequences, 0x7ff-0xcfff
1217                         break;
1218                 case 0xed:      // 0xd000-0xdfff
1219                         // Don't allow surrogate codes 0xd800-0xdfff
1220                         if ((p[i] & 0xff) >= 0xa0)
1221                                 break;
1222                 case 0xee:      // 0xe000-0xefff
1223                 case 0xef:      // 0xf000-0xffff
1224                         more = 2; // 3-byte sequences,
1225                                   // 0xd000-0xd7ff, 0xe000-0xffff
1226                         break;
1227                 case 0xf0:
1228                         // don't allow overlong sequences for 0-0xffff
1229                         if ((p[i] & 0xff) < 0x90)
1230                                 break;
1231                 case 0xf1:      // 0x40000-0x7ffff
1232                 case 0xf2:      // 0x80000-0xbffff
1233                 case 0xf3:      // 0xc0000-0xfffff
1234                         more = 3; // 4-byte sequences, 0x10000-0xfffff
1235                         break;
1236                 case 0xf4:
1237                         // don't allow more than 0x10ffff
1238                         if ((p[i] & 0xff) >= 0x90)
1239                                 break;
1240                         more = 3; // 4-byte sequence, 0x100000-0x10ffff
1241                         break;
1242                 }
1243                 if (more) {
1244                         // check that all continuation bytes are valid
1245                         do {
1246                                 if ((p[i++] & 0xc0) != 0x80)
1247                                         break;
1248                         } while (--more);
1249                         if (!more)
1250                                 continue;
1251                 }
1252                 Input h = here_input ();
1253                 h.set (h.get_source_file (), h.start () + oldi, h.start () + i);
1254                 h.warning (_ ("non-UTF-8 input").c_str ());
1255         }
1256         return p;
1257 }
1258
1259
1260 /*
1261  urg, belong to string (_convert)
1262  and should be generalised
1263  */
1264 void
1265 strip_leading_white (string&s)
1266 {
1267         ssize i = 0;
1268         for (;  i < s.length (); i++)
1269                 if (!isspace (s[i]))
1270                         break;
1271
1272         s = s.substr (i);
1273 }
1274
1275 void
1276 strip_trailing_white (string&s)
1277 {
1278         ssize i = s.length ();
1279         while (i--)
1280                 if (!isspace (s[i]))
1281                         break;
1282
1283         s = s.substr (0, i + 1);
1284 }
1285
1286
1287
1288 Lilypond_version oldest_version ("2.7.38");
1289
1290
1291 bool
1292 is_valid_version (string s)
1293 {
1294   Lilypond_version current ( MAJOR_VERSION "." MINOR_VERSION "." PATCH_LEVEL );
1295   Lilypond_version ver (s);
1296   if (!ver)
1297   {
1298           non_fatal_error (_f ("Invalid version string \"%s\"", s));
1299           return false;
1300   }
1301   if (ver < oldest_version)
1302         {
1303                 non_fatal_error (_f ("file too old: %s (oldest supported: %s)", ver.to_string (), oldest_version.to_string ()));
1304                 non_fatal_error (_ ("consider updating the input with the convert-ly script"));
1305                 return false;
1306         }
1307
1308   if (ver > current)
1309         {
1310                 non_fatal_error (_f ("program too old: %s (file requires: %s)",  current.to_string (), ver.to_string ()));
1311                 return false;
1312         }
1313   return true;
1314 }
1315
1316
1317 /*
1318   substitute _
1319 */
1320 string
1321 lyric_fudge (string s)
1322 {
1323         size_t i=0;
1324
1325         while ((i = s.find ('_', i)) != string::npos)
1326         {
1327                 s[i++] = ' ';
1328         }
1329         return s;
1330 }
1331
1332 /*
1333 Convert "NUM/DEN" into a '(NUM . DEN) cons.
1334 */
1335 SCM
1336 scan_fraction (string frac)
1337 {
1338         ssize i = frac.find ('/');
1339         string left = frac.substr (0, i);
1340         string right = frac.substr (i + 1, (frac.length () - i + 1));
1341
1342         return scm_cons (scm_c_read_string (left.c_str ()),
1343                          scm_c_read_string (right.c_str ()));
1344 }
1345
1346 SCM
1347 lookup_markup_command (string s)
1348 {
1349         return Lily::lookup_markup_command (ly_string2scm (s));
1350 }
1351
1352 SCM
1353 lookup_markup_list_command (string s)
1354 {
1355         return Lily::lookup_markup_list_command (ly_string2scm (s));
1356 }
1357
1358 /* Shut up lexer warnings.  */
1359 #if YY_STACK_USED
1360
1361 static void
1362 yy_push_state (int)
1363 {
1364 }
1365
1366 static void
1367 yy_pop_state ()
1368 {
1369 }
1370
1371 static int
1372 yy_top_state ()
1373 {
1374   return 0;
1375 }
1376
1377 static void
1378 silence_lexer_warnings ()
1379 {
1380    (void) yy_start_stack_ptr;
1381    (void) yy_start_stack_depth;
1382    (void) yy_start_stack;
1383    (void) yy_push_state;
1384    (void) yy_pop_state;
1385    (void) yy_top_state;
1386    (void) silence_lexer_warnings;
1387 }
1388 #endif