release commit
[lilypond.git] / lily / lexer.ll
blobc658e7bf8acfe3de6b2fe13fa4292239840dfe8b
1 %{ // -*-Fundamental-*-
2 /*
3   lexer.ll -- implement the Flex lexer
5   source file of the LilyPond music typesetter
7   (c) 1996--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8            Jan Nieuwenhuizen <janneke@gnu.org>
9 */
13   backup rules
15   after making a change to the lexer rules, run 
16       flex -b <this lexer file>
17   and make sure that 
18       lex.backup
19   contains no backup states, but only the reminder
20       Compressed tables always back up.
21  (don-t forget to rm lex.yy.cc :-)
22  */
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <errno.h>
29 /* Flex >= 2.5.29 fix; FlexLexer.h's multiple include bracing breaks
30    when building the actual lexer.  */
31 #define LEXER_CC
33 #include <iostream>
34 using namespace std;
36 #include "source-file.hh"
37 #include "parse-scm.hh"
38 #include "lily-guile.hh"
39 #include "string.hh"
40 #include "string-convert.hh"
41 #include "my-lily-lexer.hh"
42 #include "input-file-results.hh"
43 #include "interval.hh"
44 #include "lily-guile.hh"
45 #include "parser.hh"
46 #include "warn.hh"
47 #include "main.hh"
48 #include "version.hh"
49 #include "lilypond-input-version.hh"
50 #include "translator-def.hh"
51 #include "identifier-smob.hh"
54 RH 7 fix (?)
56 #define isatty HORRIBLEKLUDGE
58 void strip_trailing_white (String&);
59 void strip_leading_white (String&);
60 String lyric_fudge (String s);
62 SCM
63 lookup_markup_command (String s);
65 bool
66 valid_version_b (String s);
70 #define start_quote()   \
71         yy_push_state (quote);\
72         yylval.string = new String
74 #define yylval \
75         (*(YYSTYPE*)lexval)
77 #define YY_USER_ACTION  add_lexed_char (YYLeng ());
80 LYRICS          ({AA}|{TEX})[^0-9 \t\n\f]*
85 SCM scan_fraction (String);
86 SCM (* scm_parse_error_handler) (void *);
92 %option c++
93 %option noyywrap
94 %option nodefault
95 %option debug
96 %option yyclass="My_lily_lexer"
97 %option stack
98 %option never-interactive 
99 %option warn
101 %x renameinput
102 %x version
103 %x chords
104 %x incl
105 %x lyrics
106 %x notes
107 %x figures
108 %x quote
109 %x longcomment
110 %x markup 
112 A               [a-zA-Z]
113 AA              {A}|_
114 N               [0-9]
115 AN              {AA}|{N}
116 PUNCT           [?!:'`]
117 ACCENT          \\[`'"^]
118 NATIONAL        [\001-\006\021-\027\031\036\200-\377]
119 TEX             {AA}|-|{PUNCT}|{ACCENT}|{NATIONAL}
120 WORD            {A}{AN}*
121 ALPHAWORD       {A}+
122 DIGIT           {N}
123 UNSIGNED        {N}+
124 E_UNSIGNED      \\{N}+
125 FRACTION        {N}+\/{N}+
126 INT             -?{UNSIGNED}
127 REAL            ({INT}\.{N}*)|(-?\.{N}+)
128 KEYWORD         \\{WORD}
129 WHITE           [ \n\t\f\r]
130 HORIZONTALWHITE         [ \t]
131 BLACK           [^ \n\t\f\r]
132 RESTNAME        [rs]
133 NOTECOMMAND     \\{A}+
134 MARKUPCOMMAND   \\({A}|[-_])+
135 LYRICS          ({AA}|{TEX})[^0-9 \t\n\r\f]*
136 ESCAPED         [nt\\'"]
137 EXTENDER        __
138 HYPHEN          --
142 <*>\r           {
143         // windows-suck-suck-suck
146 <INITIAL,chords,incl,markup,lyrics,notes,figures>{
147   "%{"  {
148         yy_push_state (longcomment);
149   }
150   %[^{\n\r].*[\n\r]     {
151   }
152   %[^{\n\r]     { // backup rule
153   }
154   %[\n\r]       {
155   }
156   %[^{\n\r].*   {
157   }
158   {WHITE}+      {
160   }
163 <INITIAL,chords,lyrics,notes,figures>\\version{WHITE}*  {
164         yy_push_state (version);
166 <INITIAL,chords,lyrics,notes,figures>\\renameinput{WHITE}*      {
167         yy_push_state (renameinput);
169 <version>\"[^"]*\"     { /* got the version number */
170         String s (YYText ()+1);
171         s = s.left_string (s.index_last ('\"'));
173         yy_pop_state();
174          if (!valid_version_b (s))
175                 return INVALID;
177 <renameinput>\"[^"]*\"     { /* got the version number */
178         String s (YYText ()+1);
179         s = s.left_string (s.index_last ('\"'));
181         yy_pop_state();
182         this->here_input().source_file_->name_ = s;
183         scm_module_define (gh_car (scopes_),
184                      ly_symbol2scm ("input-file-name"),
185                      scm_makfrom0str (s.to_str0()));
189 <version>.      {
190         LexerError ("No quoted string found after \\version");
191         yy_pop_state ();
193 <renameinput>.  {
194         LexerError ("No quoted string found after \\renameinput");
195         yy_pop_state ();
197 <longcomment>{
198         [^\%]*          {
199         }
200         \%*[^}%]*               {
202         }
203         "%"+"}"         {
204                 yy_pop_state ();
205         }
206         <<EOF>>         {
207                 LexerError (_ ("EOF found inside a comment").to_str0 ());
208                 if (! close_input ()) 
209                   yyterminate (); // can't move this, since it actually rets a YY_NULL
210         }
214 <INITIAL,chords,lyrics,notes,figures>\\maininput           {
215         if (!main_input_b_)
216         {
217                 start_main_input ();
218                 main_input_b_ = true;
219         }
220         else
221                 error (_ ("\\maininput disallowed outside init files"));
224 <INITIAL,chords,lyrics,figures,notes>\\include           {
225         yy_push_state (incl);
227 <incl>\"[^"]*\";?   { /* got the include file name */
228         String s (YYText ()+1);
229         s = s.left_string (s.index_last ('"'));
231         new_input (s, &global_input_file->sources_ );
232         yy_pop_state ();
234 <incl>\\{BLACK}*;?{WHITE} { /* got the include identifier */
235         String s = YYText () + 1;
236         strip_trailing_white (s);
237         if (s.length () && (s[s.length () - 1] == ';'))
238           s = s.left_string (s.length () - 1);
240         SCM sid = lookup_identifier (s);
241         if (gh_string_p (sid)) {
242                 new_input (ly_scm2string (sid), &global_input_file->sources_);
243                 yy_pop_state ();
244         } else { 
245             String msg (_f ("wrong or undefined identifier: `%s'", s ));
247             LexerError (msg.to_str0 ());
248             SCM err = scm_current_error_port ();
249             scm_puts ("This value was found in the table: ", err);
250             scm_display (sid, err);
251           }
253 <incl>\"[^"]*   { // backup rule
254         error (_ ("Missing end quote"));
255         exit (1);
257 <chords,notes,figures>{RESTNAME}        {
258         const char *s = YYText ();
259         yylval.scm = scm_makfrom0str (s);
260         return RESTNAME;
262 <chords,notes,figures>R         {
263         return MULTI_MEASURE_REST;
265 <INITIAL,chords,lyrics,notes,figures>\\\${BLACK}*{WHITE}        {
266         String s=YYText () + 2;
267         s=s.left_string (s.length () - 1);
268         return scan_escaped_word (s); 
270 <INITIAL,chords,lyrics,notes,figures>\${BLACK}*{WHITE}          {
271         String s=YYText () + 1;
272         s=s.left_string (s.length () - 1);
273         return scan_bare_word (s);
275 <INITIAL,chords,lyrics,notes,figures>\\\${BLACK}*               { // backup rule
276         error (_("white expected"));
277         exit (1);
279 <INITIAL,chords,lyrics,notes,figures>\${BLACK}*         { // backup rule
280         error (_("white expected"));
281         exit (1);
284 <INITIAL,markup,chords,lyrics,notes,figures>#   { //embedded scm
285         //char const* s = YYText () + 1;
286         char const* s = here_str0 ();
287         int n = 0;
288         if (main_input_b_ && safe_global_b) {
289                 error (_ ("Can't evaluate Scheme in safe mode"));
290                 yylval.scm =  SCM_EOL;
291                 return SCM_T;
292         }
293         SCM sval = ly_parse_scm (s, &n, here_input());
294         if (sval == SCM_UNDEFINED)
295                 {
296                 sval = SCM_UNSPECIFIED;
297                 errorlevel_ = 1;
298                 }
300         for (int i=0; i < n; i++)
301         {
302                 yyinput ();
303         }
304         char_count_stack_.top () += n;
306         if (unpack_identifier (sval) != SCM_UNDEFINED)
307         {
308                 yylval.scm = unpack_identifier(sval);
309                 return identifier_type (yylval.scm);
310         }
311                 
312         yylval.scm = sval;
313         return SCM_T;
315 <INITIAL,notes,lyrics>{ 
316         \<\<   {
317                 return LESSLESS;
318         }
319         \>\>   {
320                 return MOREMORE;
321         }
323 <figures>{
324         _       {
325                 return FIGURE_SPACE;
326         }
327         \>              {
328                 return FIGURE_CLOSE;
329         }
330         \<      {
331                 return FIGURE_OPEN;
332         }
335 <notes,figures>{
336         {ALPHAWORD}     {
337                 return scan_bare_word (YYText ());
338         }
340         {NOTECOMMAND}   {
341                 return scan_escaped_word (YYText () + 1); 
342         }
343         {FRACTION}      {
344                 yylval.scm =  scan_fraction (YYText ());
345                 return FRACTION;
346         }
348         {DIGIT}         {
349                 yylval.i = String_convert::dec2int (String (YYText ()));
350                 return DIGIT;
351         }
352         {UNSIGNED}              {
353                 yylval.i = String_convert::dec2int (String (YYText ()));
354                 return UNSIGNED;
355         }
356         {E_UNSIGNED}    {
357                 yylval.i = String_convert::dec2int (String (YYText () +1));
358                 return E_UNSIGNED;
359         }
361         \" {
362                 start_quote ();
363         }
366 \"              {
367         start_quote ();
369 <quote>{
370         \\{ESCAPED}     {
371                 *yylval.string += to_string (escaped_char (YYText ()[1]));
372         }
373         [^\\"]+ {
374                 *yylval.string += YYText ();
375         }
376         \"      {
378                 yy_pop_state ();
380                 /* yylval is union. Must remember STRING before setting SCM*/
381                 String *sp = yylval.string;
382                 yylval.scm = scm_makfrom0str (sp->to_str0 ());
383                 delete sp;
384                 return STRING;
385         }
386         .       {
387                 *yylval.string += YYText ();
388         }
391 <lyrics>{
392         \" {
393                 start_quote ();
394         }
395         {FRACTION}      {
396                 yylval.scm =  scan_fraction (YYText ());
397                 return FRACTION;
398         }
399         {UNSIGNED}              {
400                 yylval.i = String_convert::dec2int (String (YYText ()));
401                 return UNSIGNED;
402         }
403         {NOTECOMMAND}   {
404                 return scan_escaped_word (YYText () + 1);
405         }
406         {LYRICS} {
407                 /* ugr. This sux. */
408                 String s (YYText ()); 
409                 if (s == "__")
410                         return yylval.i = EXTENDER;
411                 if (s == "--")
412                         return yylval.i = HYPHEN;
413                 s = lyric_fudge (s);
415                 char c = s[s.length () - 1];
416                 if (c == '{' ||  c == '}') // brace open is for not confusing dumb tools.
417                         here_input ().warning (
418                                 _ ("Brace found at end of lyric.  Did you forget a space?"));
419                 yylval.scm = scm_makfrom0str (s.to_str0 ());
422                 return STRING;
423         }
424         . {
425                 return YYText ()[0];
426         }
428 <chords>{
429         {ALPHAWORD}     {
430                 return scan_bare_word (YYText ());
431         }
432         {NOTECOMMAND}   {
433                 return scan_escaped_word (YYText () + 1);
434         }
435         {FRACTION}      {
436                 yylval.scm =  scan_fraction (YYText ());
437                 return FRACTION;
438         }
439         {UNSIGNED}              {
440                 yylval.i = String_convert::dec2int (String (YYText ()));
441                 return UNSIGNED;
442         }
443         \" {
444                 start_quote ();
445         }
446         -  {
447                 return CHORD_MINUS;
448         }
449         :  {
450                 return CHORD_COLON;
451         }
452         \/\+ {
453                 return CHORD_BASS;
454         }
455         \/  {
456                 return CHORD_SLASH;
457         }
458         \^  {
459                 return CHORD_CARET;
460         }
461         . {
462                 return YYText ()[0];
463         }
467 <markup>{
468         \" {
469                 start_quote ();
470         }
471         \< {
472                 return '<';
473         }
474         \> {
475                 return '>';
476         }
477         {MARKUPCOMMAND} {
478                 String str (YYText() + 1);
479                 SCM s = lookup_markup_command (str);
481                 if (gh_pair_p (s) && gh_symbol_p (gh_cdr (s)) ) {
482                         yylval.scm = gh_car(s);
483                         SCM tag = gh_cdr(s);
484                         if (tag == ly_symbol2scm("markup0"))
485                                 return MARKUP_HEAD_MARKUP0;
486                         else if (tag == ly_symbol2scm ("markup0-markup1"))
487                                 return MARKUP_HEAD_MARKUP0_MARKUP1;
488                         else if (tag == ly_symbol2scm ("markup-list0"))
489                                 return MARKUP_HEAD_LIST0;
490                         else if (tag == ly_symbol2scm ("scheme0"))
491                                 return MARKUP_HEAD_SCM0;
492                         else if (tag == ly_symbol2scm ("scheme0-scheme1"))
493                                 return MARKUP_HEAD_SCM0_SCM1;
494                         else if (tag == ly_symbol2scm ("scheme0-markup1"))
495                                 return MARKUP_HEAD_SCM0_MARKUP1;
496                         else if (tag == ly_symbol2scm ("scheme0-scheme1-markup2"))
497                                 return MARKUP_HEAD_SCM0_SCM1_MARKUP2;
498                         else if (tag == ly_symbol2scm ("scheme0-scheme1-scheme2"))
499                                 return MARKUP_HEAD_SCM0_SCM1_SCM2;
500                         else {
501                                 programming_error ("No parser tag defined for this signature. Abort"); 
502                                 ly_display_scm (s);
503                                 assert(false);
504                         }
505                 } else
506                         return scan_escaped_word (str);
507         }
508         [{}]    {
509                 return YYText()[0];
510         }
511         [^#{}"\\ \t\n\r\f]+ {
512                 String s (YYText ()); 
514                 char c = s[s.length () - 1];
515                 if (c == '{' ||  c == '}') // brace open is for not confusing dumb tools.
516                         here_input ().warning (
517                                 _ ("Brace found at end of markup.  Did you forget a space?"));
518                 yylval.scm = scm_makfrom0str (s.to_str0 ());
521                 return STRING;
522         }
523         .  {
524                 return YYText()[0];
525         }
528 <<EOF>> {
531         if (! close_input ()) { 
532           yyterminate (); // can't move this, since it actually rets a YY_NULL
533         }
537 {WORD}  {
538         return scan_bare_word (YYText ());
540 {KEYWORD}       {
541         return scan_escaped_word (YYText () + 1);
543 {REAL}          {
544         Real r;
545         int cnv=sscanf (YYText (), "%lf", &r);
546         assert (cnv == 1);
548         yylval.scm = gh_double2scm (r);
549         return REAL;
552 {UNSIGNED}      {
553         yylval.i = String_convert::dec2int (String (YYText ()));
554         return UNSIGNED;
558 [{}]    {
560         return YYText ()[0];
562 [*:=]           {
563         char c = YYText ()[0];
565         return c;
568 <INITIAL,notes,figures>.        {
569         return YYText ()[0];
572 <INITIAL,lyrics,notes,figures>\\. {
573     char c= YYText ()[1];
575     switch (c) {
576     case '>':
577         return E_BIGGER;
578     case '<':
579         return E_SMALLER;
580     case '!':
581         return E_EXCLAMATION;
582     case '(':
583         return E_OPEN;
584     case ')':
585         return E_CLOSE;
586     case '[':
587         return E_LEFTSQUARE;
588     case ']':
589         return E_RIGHTSQUARE;
590     case '~':
591         return E_TILDE;
592     case '\\':
593         return E_BACKSLASH;
595     default:
596         return E_CHAR;
597     }
600 <*>.            {
601         String msg = _f ("invalid character: `%c'", YYText ()[0]);
602         LexerError (msg.to_str0 ());
603         return YYText ()[0];
608 void
609 My_lily_lexer::push_note_state ()
611         yy_push_state (notes);
614 void
615 My_lily_lexer::push_figuredbass_state()
617         yy_push_state (figures);
619 void
620 My_lily_lexer::push_chord_state ()
622         yy_push_state (chords);
625 void
626 My_lily_lexer::push_lyric_state ()
628         yy_push_state (lyrics);
631 void
632 My_lily_lexer::push_markup_state ()
634         yy_push_state (markup);
637 void
638 My_lily_lexer::pop_state ()
640         yy_pop_state ();
644 My_lily_lexer::identifier_type(SCM sid)
646         int k = try_special_identifiers(&yylval.scm , sid);
647         return k >= 0  ? k : SCM_IDENTIFIER;
652 My_lily_lexer::scan_escaped_word (String str)
654         // use more SCM for this.
656         SCM sym = ly_symbol2scm (str.to_str0 ());
658         int l = lookup_keyword (str);
659         if (l != -1) {
660                 return l;
661         }
662         SCM sid = lookup_identifier (str);
663         if (sid != SCM_UNDEFINED)
664         {
665                 yylval.scm = sid;
666                 return identifier_type (sid);
667         }
669         if ((YYSTATE != notes) && (YYSTATE != chords)) {
670                 SCM pitch = scm_hashq_get_handle (pitchname_tab_, sym);
671                 
672                 if (gh_pair_p (pitch))
673                 {
674                         yylval.scm = ly_cdr (pitch);
675                         return NOTENAME_PITCH;
676                 }
677         }
678         String msg (_f ("unknown escaped string: `\\%s'", str));        
679         LexerError (msg.to_str0 ());
681         yylval.scm = scm_makfrom0str (str.to_str0 ());
683         return STRING;
687 My_lily_lexer::scan_bare_word (String str)
689         SCM sym = ly_symbol2scm (str.to_str0 ());
690         if ((YYSTATE == notes) || (YYSTATE == chords)) {
691                 SCM pitch = scm_hashq_get_handle (pitchname_tab_, sym);
692                 if (gh_pair_p (pitch)) {
693                     yylval.scm = ly_cdr (pitch);
694                     return (YYSTATE == notes) ? NOTENAME_PITCH : TONICNAME_PITCH;
695                 } else if ((pitch = scm_hashq_get_handle (chordmodifier_tab_, sym))!= SCM_BOOL_F)
696                 {
697                     yylval.scm = ly_cdr (pitch);
698                     return CHORD_MODIFIER;
699                 }
700         }
702         yylval.scm = scm_makfrom0str (str.to_str0 ());
703         return STRING;
706 bool
707 My_lily_lexer::note_state_b () const
709         return YY_START == notes;
712 bool
713 My_lily_lexer::chord_state_b () const
715         return YY_START == chords;
718 bool
719 My_lily_lexer::lyric_state_b () const
721         return YY_START == lyrics;
724 bool
725 My_lily_lexer::figure_state_b () const
727         return YY_START == figures;
731  urg, belong to String (_convert)
732  and should be generalised 
733  */
734 void
735 strip_leading_white (String&s)
737         int i=0;
738         for (;  i < s.length (); i++) 
739                 if (!isspace (s[i]))
740                         break;
742         s = s.nomid_string (0, i);
745 void
746 strip_trailing_white (String&s)
748         int i=s.length ();      
749         while (i--) 
750                 if (!isspace (s[i]))
751                         break;
753         s = s.left_string (i+1);
758 /* 1.9.0 == postfix articulations */ 
759 Lilypond_version oldest_version ("1.9.0");
762 bool
763 valid_version_b (String s)
765   Lilypond_version current ( MAJOR_VERSION "." MINOR_VERSION "." PATCH_LEVEL );
766   Lilypond_version ver (s);
767   if (! ((ver >= oldest_version) && (ver <= current)))
768         {       
769                 non_fatal_error (_f ("Incorrect lilypond version: %s (%s, %s)", ver.to_string (), oldest_version.to_string (), current.to_string ()));
770                 non_fatal_error (_ ("Consider updating the input with the convert-ly script")); 
771                 return false;
772     }
773   return true;
775         
778   substittute _ adn \,
780 String
781 lyric_fudge (String s)
783   char  * chars  =s.get_copy_str0 ();
785   for (char * p = chars; *p ; p++)
786     {
787       if (*p == '_' && (p == chars || *(p-1) != '\\'))
788         *p = ' ';
789     }
790   
791   s = String (chars);
792   delete[] chars;
794   int i =0;     
795   if ((i=s.index ("\\,")) != -1)   // change "\," to TeX's "\c "
796     {
797       * (s.get_str0 () + i + 1) = 'c';
798       s = s.left_string (i+2) + " " + s.right_string (s.length ()-i-2);
799     }
801   return s;
805 Convert "NUM/DEN" into a '(NUM . DEN) cons.
808 scan_fraction (String frac)
810         int i = frac.index ('/');
811         int l = frac.length ();
812         String left = frac.left_string (i);
813         String right = frac.right_string (l - i - 1);
815         int n = String_convert::dec2int (left);
816         int d = String_convert::dec2int (right);
817         return gh_cons (gh_int2scm (n), gh_int2scm (d));
820 // Breaks for flex 2.5.31
821 #if 0
822 /* avoid silly flex induced gcc warnings */
823 static void yy_push_state (int) {;}
824 static void yy_pop_state () {;}
825 static int yy_top_state () { return 0; }
827 static void
828 avoid_silly_flex_induced_gcc_warnings ()
830         (void)yy_start_stack_ptr;
831         (void)yy_start_stack_depth;
832         (void)yy_start_stack;
833         yy_push_state (0);
834         yy_pop_state ();
835         yy_top_state ();
836         avoid_silly_flex_induced_gcc_warnings ();
838 #endif
841 lookup_markup_command (String s)
843         static SCM proc ;
844         if (!proc)
845                 proc = scm_c_eval_string ("lookup-markup-command");
847         return scm_call_1 (proc, scm_makfrom0str (s.to_str0 ()));