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         if (YYSTATE == markup && ly_is_procedure (sval))
 421         {
 422                 SCM sig = Lily::markup_command_signature (sval);
 423                 if (scm_is_true (sig))
 424                 {
 425                         yylval = sval;
 426                         int token = MARKUP_FUNCTION;
 427                         if (scm_is_true (scm_object_property
 428                                          (sval, ly_symbol2scm ("markup-list-command"))))
 429                                 token = MARKUP_LIST_FUNCTION;
 430                         push_markup_predicates (sig);
 431                         return token;
 432                 }
 433         }
 434         int token = scan_scm_id (sval);
 435         if (!scm_is_eq (yylval, SCM_UNSPECIFIED))
 436                 return token;
 437 }
 438
 439 <INITIAL,notes,lyrics,chords>{
 440         \<\<    {
 441                 yylval = SCM_UNSPECIFIED;
 442                 return DOUBLE_ANGLE_OPEN;
 443         }
 444         \>\>    {
 445                 yylval = SCM_UNSPECIFIED;
 446                 return DOUBLE_ANGLE_CLOSE;
 447         }
 448 }
 449
 450 <INITIAL,notes,chords>{
 451         \<      {
 452                 yylval = SCM_UNSPECIFIED;
 453                 return ANGLE_OPEN;
 454         }
 455         \>      {
 456                 yylval = SCM_UNSPECIFIED;
 457                 return ANGLE_CLOSE;
 458         }
 459 }
 460
 461 <figures>{
 462         _       {
 463                 yylval = SCM_UNSPECIFIED;
 464                 return FIGURE_SPACE;
 465         }
 466         \>              {
 467                 yylval = SCM_UNSPECIFIED;
 468                 return FIGURE_CLOSE;
 469         }
 470         \<      {
 471                 yylval = SCM_UNSPECIFIED;
 472                 return FIGURE_OPEN;
 473         }
 474         \\\+    {
 475                 yylval = SCM_UNSPECIFIED;
 476                 return E_PLUS;
 477         }
 478         \\!     {
 479                 yylval = SCM_UNSPECIFIED;
 480                 return E_EXCLAMATION;
 481         }
 482         \\\\    {
 483                 yylval = SCM_UNSPECIFIED;
 484                 return E_BACKSLASH;
 485         }
 486         [][]    {
 487                 yylval = SCM_UNSPECIFIED;
 488                 return  YYText ()[0];
 489         }
 490 }
 491
 492 <notes,figures>{
 493         {SYMBOL}/[-_]   | // backup rule
 494         {SYMBOL}        {
 495                 return scan_bare_word (YYText_utf8 ());
 496         }
 497         \\\"    {
 498                 start_command_quote ();
 499         }
 500         {COMMAND}/[-_]  | // backup rule
 501         {COMMAND}       {
 502                 return scan_escaped_word (YYText_utf8 () + 1);
 503         }
 504         {FRACTION}      {
 505                 yylval =  scan_fraction (YYText ());
 506                 return FRACTION;
 507         }
 508         {STRICTREAL}    {
 509                 yylval = scm_c_read_string (YYText ());
 510                 return REAL;
 511         }
 512         {UNSIGNED}/[/.] | // backup rule
 513         {UNSIGNED}      {
 514                 yylval = scm_c_read_string (YYText ());
 515                 return UNSIGNED;
 516         }
 517         {E_UNSIGNED}    {
 518                 yylval = scm_c_read_string (YYText () + 1);
 519                 return E_UNSIGNED;
 520         }
 521 }
 522
 523 <quote,commandquote>{
 524         \\{ESCAPED}     {
 525                 char c = escaped_char (YYText ()[1]);
 526                 yylval = scm_cons (scm_from_ascii_stringn (&c, 1),
 527                                    yylval);
 528         }
 529         [^\\""]+        {
 530                 yylval = scm_cons (scm_from_utf8_string (YYText_utf8 ()),
 531                                    yylval);
 532         }
 533         \"      {
 534
 535                 /* yylval is union. Must remember STRING before setting SCM*/
 536
 537                 yylval = scm_string_concatenate_reverse (yylval,
 538                                                          SCM_UNDEFINED,
 539                                                          SCM_UNDEFINED);
 540
 541                 if (get_state () == commandquote) {
 542                         yy_pop_state ();
 543                         return scan_escaped_word (ly_scm2string (yylval));
 544                 }
 545
 546                 yy_pop_state ();
 547
 548                 return STRING;
 549         }
 550         \\      {
 551                 yylval = scm_cons (scm_from_ascii_string (YYText ()),
 552                                    yylval);
 553         }
 554 }
 555
 556 <lyrics>{
 557         \" {
 558                 start_quote ();
 559         }
 560         {FRACTION}      {
 561                 yylval =  scan_fraction (YYText ());
 562                 return FRACTION;
 563         }
 564         {STRICTREAL}    {
 565                 yylval = scm_c_read_string (YYText ());
 566                 return REAL;
 567         }
 568         {UNSIGNED}/[/.] | // backup rule
 569         {UNSIGNED}              {
 570                 yylval = scm_c_read_string (YYText ());
 571                 return UNSIGNED;
 572         }
 573         \\\"    {
 574                 start_command_quote ();
 575         }
 576         {COMMAND}/[-_]  | // backup rule
 577         {COMMAND}       {
 578                 return scan_escaped_word (YYText_utf8 () + 1);
 579         }
 580         \\.|\|  {
 581                 // UTF-8 already covered by COMMAND
 582                 return scan_shorthand (YYText ());
 583         }
 584         /* Characters needed to express durations, assignments */
 585         [*.=]   {
 586                 yylval = SCM_UNSPECIFIED;
 587                 return YYText ()[0];
 588         }
 589         [^|*.=$#{}\"\\ \t\n\r\f0-9][^$#{}\"\\ \t\n\r\f0-9]* {
 590                 /* ugr. This sux. */
 591                 string s (YYText_utf8 ());
 592                 yylval = SCM_UNSPECIFIED;
 593                 if (s == "__")
 594                         return EXTENDER;
 595                 if (s == "--")
 596                         return HYPHEN;
 597                 s = lyric_fudge (s);
 598                 yylval = ly_string2scm (s);
 599
 600                 return SYMBOL;
 601         }
 602         /* This should really just cover {} */
 603         [{}] {
 604                 yylval = SCM_UNSPECIFIED;
 605                 return YYText ()[0];
 606         }
 607 }
 608 <chords>{
 609         {SYMBOL}/[-_]   | // backup rule
 610         {SYMBOL}        {
 611                 return scan_bare_word (YYText_utf8 ());
 612         }
 613         \\\"    {
 614                 start_command_quote ();
 615         }
 616         {COMMAND}/[-_]  | // backup rule
 617         {COMMAND}       {
 618                 return scan_escaped_word (YYText_utf8 () + 1);
 619         }
 620         {FRACTION}      {
 621                 yylval =  scan_fraction (YYText ());
 622                 return FRACTION;
 623         }
 624         {UNSIGNED}/\/   | // backup rule
 625         {UNSIGNED}              {
 626                 yylval = scm_c_read_string (YYText ());
 627                 return UNSIGNED;
 628         }
 629         -  {
 630                 yylval = SCM_UNSPECIFIED;
 631                 return CHORD_MINUS;
 632         }
 633         :  {
 634                 yylval = SCM_UNSPECIFIED;
 635                 return CHORD_COLON;
 636         }
 637         \/\+ {
 638                 yylval = SCM_UNSPECIFIED;
 639                 return CHORD_BASS;
 640         }
 641         \/  {
 642                 yylval = SCM_UNSPECIFIED;
 643                 return CHORD_SLASH;
 644         }
 645         \^  {
 646                 yylval = SCM_UNSPECIFIED;
 647                 return CHORD_CARET;
 648         }
 649 }
 650
 651
 652 <markup>{
 653         \\score {
 654                 yylval = SCM_UNSPECIFIED;
 655                 return SCORE;
 656         }
 657         \\score-lines {
 658                 yylval = SCM_UNSPECIFIED;
 659                 return SCORELINES;
 660         }
 661         \\\"    {
 662                 start_command_quote ();
 663         }
 664         {COMMAND}/[-_]  | // backup rule
 665         {COMMAND} {
 666                 string str (YYText_utf8 () + 1);
 667
 668                 int token_type = MARKUP_FUNCTION;
 669                 SCM s = lookup_markup_command (str);
 670
 671                 // lookup-markup-command returns a pair with the car
 672                 // being the function to call, and the cdr being the
 673                 // call signature specified to define-markup-command,
 674                 // a list of predicates.
 675
 676                 if (!scm_is_pair (s)) {
 677                   // If lookup-markup-command was not successful, we
 678                   // try lookup-markup-list-command instead.
 679                   // If this fails as well, we just scan and return
 680                   // the escaped word.
 681                   s = lookup_markup_list_command (str);
 682                   if (scm_is_pair (s))
 683                     token_type = MARKUP_LIST_FUNCTION;
 684                   else
 685                     return scan_escaped_word (str);
 686                 }
 687
 688                 // If the list of predicates is, say,
 689                 // (number? number? markup?), then tokens
 690                 // EXPECT_MARKUP EXPECT_SCM EXPECT_SCM EXPECT_NO_MORE_ARGS
 691                 // will be generated.  Note that we have to push them
 692                 // in reverse order, so the first token pushed in the
 693                 // loop will be EXPECT_NO_MORE_ARGS.
 694
 695                 yylval = scm_car(s);
 696
 697                 // yylval now contains the function to call as token
 698                 // value (for token type MARKUP_FUNCTION or
 699                 // MARKUP_LIST_FUNCTION).
 700
 701                 push_markup_predicates (scm_cdr (s));
 702
 703                 return token_type;
 704         }
 705         [^$#{}\"\\ \t\n\r\f]+ {
 706                 string s (YYText_utf8 ());
 707
 708                 yylval = ly_string2scm (s);
 709                 return SYMBOL;
 710         }
 711         [{}]  {
 712                 yylval = SCM_UNSPECIFIED;
 713                 return YYText ()[0];
 714         }
 715 }
 716
 717 <longcomment><<EOF>> {
 718                 LexerError (_ ("EOF found inside a comment").c_str ());
 719                 yy_pop_state ();
 720         }
 721
 722 <quote,commandquote><<EOF>> {
 723         LexerError (_ ("EOF found inside string").c_str ());
 724         yy_pop_state ();
 725 }
 726
 727 <<EOF>> {
 728         yylval = SCM_UNSPECIFIED;
 729         if (is_main_input_)
 730         {
 731                 is_main_input_ = include_stack_.size () > main_input_level_;
 732                 if (!is_main_input_)
 733                 {
 734                         main_input_level_ = 0;
 735                         pop_state ();
 736                         if (YYSTATE != maininput)
 737                         {
 738                                 LexerError (_ ("Unfinished main input").c_str ());
 739                                 do {
 740                                         yy_pop_state ();
 741                                 } while (YYSTATE != maininput);
 742                         }
 743                         extra_tokens_ = SCM_EOL;
 744                         yy_pop_state ();
 745                 }
 746                 if (!close_input () || !is_main_input_)
 747                 /* Returns YY_NULL */
 748                         yyterminate ();
 749         }
 750         else if (!close_input ())
 751                 /* Returns YY_NULL */
 752                 yyterminate ();
 753 }
 754
 755 <maininput>{ANY_CHAR} {
 756         while (include_stack_.size () > main_input_level_
 757                && close_input ())
 758                 ;
 759         yyterminate ();
 760 }
 761
 762 <INITIAL>{
 763         {SYMBOL}/[-_]   | // backup rule
 764         {SYMBOL}        {
 765                 return scan_bare_word (YYText_utf8 ());
 766         }
 767         \\\"    {
 768                 start_command_quote ();
 769         }
 770         {COMMAND}/[-_]  | // backup rule
 771         {COMMAND}       {
 772                 return scan_escaped_word (YYText_utf8 () + 1);
 773         }
 774 }
 775
 776 {FRACTION}      {
 777         yylval =  scan_fraction (YYText ());
 778         return FRACTION;
 779 }
 780
 781 -{UNSIGNED}     | // backup rule
 782 {REAL}          {
 783         yylval = scm_c_read_string (YYText ());
 784         return REAL;
 785 }
 786
 787 {UNSIGNED}/\/   | // backup rule
 788 {UNSIGNED}      {
 789         yylval = scm_c_read_string (YYText ());
 790         return UNSIGNED;
 791 }
 792
 793
 794 -/\.    { // backup rule
 795         yylval = SCM_UNSPECIFIED;
 796         return YYText ()[0];
 797 }
 798
 799 <INITIAL,chords,lyrics,figures,notes>{SPECIAL}  {
 800         yylval = SCM_UNSPECIFIED;
 801         return YYText ()[0];
 802 }
 803
 804 <INITIAL,chords,lyrics,figures,notes>{SHORTHAND}        {
 805         return scan_shorthand (YYText_utf8 ()); // should not be utf-8
 806 }
 807
 808 <*>.[\200-\277]*        {
 809         string msg = _f ("invalid character: `%s'", YYText_utf8 ());
 810         LexerError (msg.c_str ());
 811         yylval = SCM_UNSPECIFIED;
 812         return '%';  // Better not return half a utf8 character.
 813 }
 814
 815 %%
 816
 817 /* Make the lexer generate a token of the given type as the next token.
 818  TODO: make it possible to define a value for the token as well */
 819 void
 820 Lily_lexer::push_extra_token (Input const &where, int token_type, SCM scm)
 821 {
 822         extra_tokens_ = scm_cons (scm_cons2 (where.smobbed_copy (),
 823                                              scm_from_int (token_type),
 824                                              scm), extra_tokens_);
 825 }
 826
 827 int
 828 Lily_lexer::pop_extra_token ()
 829 {
 830         if (scm_is_null (extra_tokens_))
 831                 return -1;
 832
 833   /* produce requested token */
 834         yylloc = *unsmob<Input> (scm_caar (extra_tokens_));
 835         int type = scm_to_int (scm_cadar (extra_tokens_));
 836         yylval = scm_cddar (extra_tokens_);
 837         extra_tokens_ = scm_cdr (extra_tokens_);
 838         return type;
 839 }
 840
 841 void
 842 Lily_lexer::push_chord_state (SCM alist)
 843 {
 844         SCM p = scm_assq (alist, pitchname_tab_stack_);
 845
 846         if (scm_is_false (p))
 847                 p = scm_cons (alist, alist_to_hashq (alist));
 848         pitchname_tab_stack_ = scm_cons (p, pitchname_tab_stack_);
 849         yy_push_state (chords);
 850 }
 851
 852 void
 853 Lily_lexer::push_figuredbass_state ()
 854 {
 855         yy_push_state (figures);
 856 }
 857
 858 void
 859 Lily_lexer::push_initial_state ()
 860 {
 861         yy_push_state (INITIAL);
 862 }
 863
 864 void
 865 Lily_lexer::push_lyric_state ()
 866 {
 867         yy_push_state (lyrics);
 868 }
 869
 870 void
 871 Lily_lexer::push_markup_state ()
 872 {
 873         yy_push_state (markup);
 874 }
 875
 876 void
 877 Lily_lexer::push_note_state (SCM alist)
 878 {
 879         SCM p = scm_assq (alist, pitchname_tab_stack_);
 880
 881         if (scm_is_false (p))
 882                 p = scm_cons (alist, alist_to_hashq (alist));
 883         pitchname_tab_stack_ = scm_cons (p, pitchname_tab_stack_);
 884         yy_push_state (notes);
 885 }
 886
 887 void
 888 Lily_lexer::pop_state ()
 889 {
 890         if (YYSTATE == notes || YYSTATE == chords)
 891                 pitchname_tab_stack_ = scm_cdr (pitchname_tab_stack_);
 892
 893         // don't cross the maininput threshold
 894         if (YYSTATE != maininput)
 895                 yy_pop_state ();
 896
 897 }
 898
 899 void
 900 Lily_lexer::push_markup_predicates (SCM sig)
 901 {
 902         push_extra_token (here_input (), EXPECT_NO_MORE_ARGS);
 903         for (SCM s = sig; scm_is_pair(s); s = scm_cdr(s)) {
 904                 SCM predicate = scm_car(s);
 905
 906                 if (scm_is_eq (predicate, SCM (Lily::markup_list_p)))
 907                         push_extra_token (here_input (), EXPECT_MARKUP_LIST);
 908                 else if (scm_is_eq (predicate, SCM (Lily::markup_p)))
 909                         push_extra_token (here_input (), EXPECT_MARKUP);
 910                 else
 911                         push_extra_token (here_input (), EXPECT_SCM, predicate);
 912         }
 913 }
 914
 915
 916 int
 917 Lily_lexer::identifier_type (SCM sid)
 918 {
 919         int k = try_special_identifiers (&yylval , sid);
 920         return k >= 0  ? k : SCM_IDENTIFIER;
 921 }
 922
 923
 924 int
 925 Lily_lexer::scan_escaped_word (const string &str)
 926 {
 927         // use more SCM for this.
 928
 929 //      SCM sym = ly_symbol2scm (str.c_str ());
 930
 931         yylval = SCM_UNSPECIFIED;
 932         int i = lookup_keyword (str);
 933
 934         if (i != -1)
 935                 return i;
 936
 937         SCM sid = lookup_identifier (str);
 938         if (Music *m = unsmob<Music> (sid))
 939         {
 940                 m->set_spot (override_input (here_input ()));
 941         }
 942
 943         if (!SCM_UNBNDP (sid))
 944                 return scan_scm_id (sid);
 945
 946         string msg (_f ("unknown escaped string: `\\%s'", str));
 947         LexerError (msg.c_str ());
 948
 949         yylval = ly_string2scm (str);
 950
 951         return STRING; // SYMBOL would cause additional processing
 952 }
 953
 954 int
 955 Lily_lexer::scan_shorthand (const string &str)
 956 {
 957         SCM sid = lookup_identifier (str);
 958         if (Music *m = unsmob<Music> (sid))
 959         {
 960                 m->set_spot (override_input (here_input ()));
 961         }
 962
 963         if (!SCM_UNBNDP (sid))
 964                 return scan_scm_id (sid);
 965
 966         string msg (_f ("undefined character or shorthand: %s", str));
 967         LexerError (msg.c_str ());
 968
 969         yylval = ly_string2scm (str);
 970
 971         return STRING;
 972 }
 973
 974 int
 975 Lily_lexer::scan_scm_id (SCM sid)
 976 {
 977         if (Music_function *fun = unsmob<Music_function> (sid))
 978         {
 979                 int funtype = SCM_FUNCTION;
 980
 981                 yylval = sid;
 982
 983                 SCM s = fun->get_signature ();
 984                 SCM cs = scm_car (s);
 985
 986                 if (scm_is_pair (cs))
 987                 {
 988                         cs = SCM_CAR (cs);
 989                 }
 990
 991                 if (scm_is_eq (cs, SCM (Lily::ly_music_p)))
 992                         funtype = MUSIC_FUNCTION;
 993                 else if (scm_is_eq (cs, SCM (Lily::ly_event_p)))
 994                         funtype = EVENT_FUNCTION;
 995                 else if (ly_is_procedure (cs))
 996                         funtype = SCM_FUNCTION;
 997                 else programming_error ("Bad syntax function predicate");
 998
 999                 push_extra_token (here_input (), EXPECT_NO_MORE_ARGS);
1000                 for (s = scm_cdr (s); scm_is_pair (s); s = scm_cdr (s))
1001                 {
1002                         SCM optional = SCM_UNDEFINED;
1003                         cs = scm_car (s);
1004
1005                         if (scm_is_pair (cs))
1006                         {
1007                                 optional = SCM_CDR (cs);
1008                                 cs = SCM_CAR (cs);
1009                         }
1010
1011                         if (ly_is_procedure (cs))
1012                                 push_extra_token (here_input (), EXPECT_SCM, cs);
1013                         else
1014                         {
1015                                 programming_error ("Function parameter without type-checking predicate");
1016                                 continue;
1017                         }
1018                         if (!scm_is_eq (optional, SCM_UNDEFINED))
1019                                 push_extra_token (here_input (), EXPECT_OPTIONAL, optional);
1020                 }
1021                 return funtype;
1022         }
1023         yylval = sid;
1024         return identifier_type (sid);
1025 }
1026
1027 int
1028 Lily_lexer::scan_word (SCM & output, SCM sym)
1029 {
1030         if ((YYSTATE == notes) || (YYSTATE == chords)) {
1031                 SCM handle = SCM_BOOL_F;
1032                 if (scm_is_pair (pitchname_tab_stack_))
1033                         handle = scm_hashq_get_handle (scm_cdar (pitchname_tab_stack_), sym);
1034
1035                 if (scm_is_pair (handle)) {
1036                         output = scm_cdr (handle);
1037                         if (unsmob<Pitch> (yylval))
1038                             return (YYSTATE == notes) ? NOTENAME_PITCH : TONICNAME_PITCH;
1039                         else if (scm_is_symbol (yylval))
1040                             return DRUM_PITCH;
1041                 }
1042                 else if ((YYSTATE == chords)
1043                         && scm_is_true (handle = scm_hashq_get_handle (chordmodifier_tab_, sym)))
1044                 {
1045                     output = scm_cdr (handle);
1046                     return CHORD_MODIFIER;
1047                 }
1048         }
1049         output = SCM_UNDEFINED;
1050         return -1;
1051 }
1052
1053 int
1054 Lily_lexer::scan_bare_word (const string &str)
1055 {
1056         int state = scan_word (yylval, ly_symbol2scm (str.c_str ()));
1057         if (state >= 0)
1058         {
1059                 return state;
1060         }
1061         yylval = ly_string2scm (str);
1062         return SYMBOL;
1063 }
1064
1065 int
1066 Lily_lexer::get_state () const
1067 {
1068         return YY_START;
1069 }
1070
1071 bool
1072 Lily_lexer::is_note_state () const
1073 {
1074         return get_state () == notes;
1075 }
1076
1077 bool
1078 Lily_lexer::is_chord_state () const
1079 {
1080         return get_state () == chords;
1081 }
1082
1083 bool
1084 Lily_lexer::is_lyric_state () const
1085 {
1086         return get_state () == lyrics;
1087 }
1088
1089 bool
1090 Lily_lexer::is_figure_state () const
1091 {
1092         return get_state () == figures;
1093 }
1094
1095 // The extra_token parameter specifies how to convert multiple values
1096 // into additional tokens.  For '#', additional values get pushed as
1097 // SCM_IDENTIFIER.  For '$', they get checked for their type and get
1098 // pushed as a corresponding *_IDENTIFIER token.  Since the latter
1099 // tampers with yylval, it can only be done from the lexer itself, so
1100 // this function is private.
1101
1102 SCM
1103 Lily_lexer::eval_scm (SCM readerdata, Input hi, char extra_token)
1104 {
1105         SCM sval = SCM_UNDEFINED;
1106
1107         if (!SCM_UNBNDP (readerdata))
1108         {
1109                 sval = ly_eval_scm (readerdata,
1110                                     hi,
1111                                     be_safe_global && is_main_input_,
1112                                     parser_);
1113         }
1114
1115         if (SCM_UNBNDP (sval))
1116         {
1117                 error_level_ = 1;
1118                 return SCM_UNSPECIFIED;
1119         }
1120
1121         if (extra_token && SCM_VALUESP (sval))
1122         {
1123                 sval = scm_struct_ref (sval, SCM_INUM0);
1124
1125                 if (scm_is_pair (sval)) {
1126                         for (SCM p = scm_reverse (scm_cdr (sval));
1127                              scm_is_pair (p);
1128                              p = scm_cdr (p))
1129                         {
1130                                 SCM v = scm_car (p);
1131                                 if (Music *m = unsmob<Music> (v))
1132                                 {
1133                                         if (!unsmob<Input> (m->get_property ("origin")))
1134                                                 m->set_spot (override_input (here_input ()));
1135                                 }
1136
1137                                 int token;
1138                                 switch (extra_token) {
1139                                 case '$':
1140                                         token = scan_scm_id (v);
1141                                         if (!scm_is_eq (yylval, SCM_UNSPECIFIED))
1142                                                 push_extra_token (here_input (),
1143                                                                   token, yylval);
1144                                         break;
1145                                 case '#':
1146                                         push_extra_token (here_input (),
1147                                                           SCM_IDENTIFIER, v);
1148                                         break;
1149                                 }
1150                         }
1151                         sval = scm_car (sval);
1152                 } else
1153                         sval = SCM_UNSPECIFIED;
1154         }
1155
1156         if (Music *m = unsmob<Music> (sval))
1157         {
1158                 if (!unsmob<Input> (m->get_property ("origin")))
1159                         m->set_spot (override_input (here_input ()));
1160         }
1161
1162         return sval;
1163 }
1164
1165 /* Check for valid UTF-8 that has no overlong or surrogate codes and
1166    is in the range 0-0x10ffff */
1167
1168 const char *
1169 Lily_lexer::YYText_utf8 ()
1170 {
1171         const char * const p =  YYText ();
1172         for (int i=0; p[i];) {
1173                 if ((p[i] & 0xff) < 0x80) {
1174                         ++i;
1175                         continue;
1176                 }
1177                 int oldi = i; // start of character
1178                 int more = 0; // # of followup bytes, 0 if bad
1179                 switch (p[i++] & 0xff) {
1180                         // 0xc0 and 0xc1 are overlong prefixes for
1181                         // 0x00-0x3f and 0x40-0x7f respectively, bad.
1182                 case 0xc2:      // 0x80-0xbf
1183                 case 0xc3:      // 0xc0-0xff
1184                 case 0xc4:      // 0x100-0x13f
1185                 case 0xc5:      // 0x140-0x17f
1186                 case 0xc6:      // 0x180-0x1bf
1187                 case 0xc7:      // 0x1c0-0x1ff
1188                 case 0xc8:      // 0x200-0x23f
1189                 case 0xc9:      // 0x240-0x27f
1190                 case 0xca:      // 0x280-0x2bf
1191                 case 0xcb:      // 0x2c0-0x2ff
1192                 case 0xcc:      // 0x300-0x33f
1193                 case 0xcd:      // 0x340-0x37f
1194                 case 0xce:      // 0x380-0x3bf
1195                 case 0xcf:      // 0x3c0-0x3ff
1196                 case 0xd0:      // 0x400-0x43f
1197                 case 0xd1:      // 0x440-0x47f
1198                 case 0xd2:      // 0x480-0x4bf
1199                 case 0xd3:      // 0x4c0-0x4ff
1200                 case 0xd4:      // 0x500-0x53f
1201                 case 0xd5:      // 0x540-0x57f
1202                 case 0xd6:      // 0x580-0x5bf
1203                 case 0xd7:      // 0x5c0-0x5ff
1204                 case 0xd8:      // 0x600-0x63f
1205                 case 0xd9:      // 0x640-0x67f
1206                 case 0xda:      // 0x680-0x6bf
1207                 case 0xdb:      // 0x6c0-0x6ff
1208                 case 0xdc:      // 0x700-0x73f
1209                 case 0xdd:      // 0x740-0x77f
1210                 case 0xde:      // 0x780-0x7bf
1211                 case 0xdf:      // 0x7c0-0x7ff
1212                         more = 1; // 2-byte sequences, 0x80-0x7ff
1213                         break;
1214                 case 0xe0:
1215                         // don't allow overlong sequences for 0-0x7ff
1216                         if ((p[i] & 0xff) < 0xa0)
1217                                 break;
1218                 case 0xe1:      // 0x1000-0x1fff
1219                 case 0xe2:      // 0x2000-0x2fff
1220                 case 0xe3:      // 0x3000-0x3fff
1221                 case 0xe4:      // 0x4000-0x4fff
1222                 case 0xe5:      // 0x5000-0x5fff
1223                 case 0xe6:      // 0x6000-0x6fff
1224                 case 0xe7:      // 0x7000-0x7fff
1225                 case 0xe8:      // 0x8000-0x8fff
1226                 case 0xe9:      // 0x9000-0x9fff
1227                 case 0xea:      // 0xa000-0xafff
1228                 case 0xeb:      // 0xb000-0xbfff
1229                 case 0xec:      // 0xc000-0xcfff
1230                         more = 2; // 3-byte sequences, 0x7ff-0xcfff
1231                         break;
1232                 case 0xed:      // 0xd000-0xdfff
1233                         // Don't allow surrogate codes 0xd800-0xdfff
1234                         if ((p[i] & 0xff) >= 0xa0)
1235                                 break;
1236                 case 0xee:      // 0xe000-0xefff
1237                 case 0xef:      // 0xf000-0xffff
1238                         more = 2; // 3-byte sequences,
1239                                   // 0xd000-0xd7ff, 0xe000-0xffff
1240                         break;
1241                 case 0xf0:
1242                         // don't allow overlong sequences for 0-0xffff
1243                         if ((p[i] & 0xff) < 0x90)
1244                                 break;
1245                 case 0xf1:      // 0x40000-0x7ffff
1246                 case 0xf2:      // 0x80000-0xbffff
1247                 case 0xf3:      // 0xc0000-0xfffff
1248                         more = 3; // 4-byte sequences, 0x10000-0xfffff
1249                         break;
1250                 case 0xf4:
1251                         // don't allow more than 0x10ffff
1252                         if ((p[i] & 0xff) >= 0x90)
1253                                 break;
1254                         more = 3; // 4-byte sequence, 0x100000-0x10ffff
1255                         break;
1256                 }
1257                 if (more) {
1258                         // check that all continuation bytes are valid
1259                         do {
1260                                 if ((p[i++] & 0xc0) != 0x80)
1261                                         break;
1262                         } while (--more);
1263                         if (!more)
1264                                 continue;
1265                 }
1266                 Input h = here_input ();
1267                 h.set (h.get_source_file (), h.start () + oldi, h.start () + i);
1268                 h.warning (_ ("non-UTF-8 input").c_str ());
1269         }
1270         return p;
1271 }
1272
1273
1274 /*
1275  urg, belong to string (_convert)
1276  and should be generalised
1277  */
1278 void
1279 strip_leading_white (string&s)
1280 {
1281         ssize i = 0;
1282         for (;  i < s.length (); i++)
1283                 if (!isspace (s[i]))
1284                         break;
1285
1286         s = s.substr (i);
1287 }
1288
1289 void
1290 strip_trailing_white (string&s)
1291 {
1292         ssize i = s.length ();
1293         while (i--)
1294                 if (!isspace (s[i]))
1295                         break;
1296
1297         s = s.substr (0, i + 1);
1298 }
1299
1300
1301
1302 Lilypond_version oldest_version ("2.7.38");
1303
1304
1305 bool
1306 is_valid_version (string s)
1307 {
1308   Lilypond_version current ( MAJOR_VERSION "." MINOR_VERSION "." PATCH_LEVEL );
1309   Lilypond_version ver (s);
1310   if (!ver)
1311   {
1312           non_fatal_error (_f ("Invalid version string \"%s\"", s));
1313           return false;
1314   }
1315   if (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         return scm_cons (scm_c_read_string (left.c_str ()),
1357                          scm_c_read_string (right.c_str ()));
1358 }
1359
1360 SCM
1361 lookup_markup_command (string s)
1362 {
1363         return Lily::lookup_markup_command (ly_string2scm (s));
1364 }
1365
1366 SCM
1367 lookup_markup_list_command (string s)
1368 {
1369         return Lily::lookup_markup_list_command (ly_string2scm (s));
1370 }
1371
1372 /* Shut up lexer warnings.  */
1373 #if YY_STACK_USED
1374
1375 static void
1376 yy_push_state (int)
1377 {
1378 }
1379
1380 static void
1381 yy_pop_state ()
1382 {
1383 }
1384
1385 static int
1386 yy_top_state ()
1387 {
1388   return 0;
1389 }
1390
1391 static void
1392 silence_lexer_warnings ()
1393 {
1394    (void) yy_start_stack_ptr;
1395    (void) yy_start_stack_depth;
1396    (void) yy_start_stack;
1397    (void) yy_push_state;
1398    (void) yy_pop_state;
1399    (void) yy_top_state;
1400    (void) silence_lexer_warnings;
1401 }
1402 #endif