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