1 %{ // -*-Fundamental-*-
3 This file is part of LilyPond, the GNU music typesetter.
5 Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 Jan Nieuwenhuizen <janneke@gnu.org>
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.
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.
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/>.
25 after making a change to the lexer rules, run
26 flex -b <this lexer file>
29 contains no backup states, but only the reminder
30 Compressed tables always back up.
31 (don-t forget to rm lex.yy.cc :-)
40 /* Flex >= 2.5.29 fix; FlexLexer.h's multiple include bracing breaks
41 when building the actual lexer. */
48 #include "context-def.hh"
49 #include "duration.hh"
50 #include "international.hh"
51 #include "interval.hh"
52 #include "lily-guile.hh"
53 #include "lily-lexer.hh"
54 #include "lily-parser.hh"
55 #include "lilypond-version.hh"
58 #include "music-function.hh"
59 #include "parse-scm.hh"
62 #include "source-file.hh"
63 #include "std-string.hh"
64 #include "string-convert.hh"
71 #define isatty HORRIBLEKLUDGE
73 void strip_trailing_white (string&);
74 void strip_leading_white (string&);
75 string lyric_fudge (string s);
76 SCM lookup_markup_command (string s);
77 SCM lookup_markup_list_command (string s);
78 bool is_valid_version (string s);
81 #define start_quote() \
82 yy_push_state (quote);\
83 yylval.string = new string
85 #define start_lyric_quote() \
86 yy_push_state (lyric_quote);\
87 yylval.string = new string
95 #define YY_USER_ACTION add_lexed_char (YYLeng ());
98 SCM scan_fraction (string);
99 SCM (* scm_parse_error_handler) (void *);
109 %option yyclass="Lily_lexer"
111 %option never-interactive
136 NATIONAL [\001-\006\021-\027\031\036]
137 TEX {AA}|-|{PUNCT}|{ACCENT}|{NATIONAL}|{SPECIAL_CHAR}
138 DASHED_WORD {A}({AN}|-)*
139 DASHED_KEY_WORD \\{DASHED_WORD}
148 REAL ({INT}\.{N}*)|(-?\.{N}+)
150 HORIZONTALWHITE [ \t]
154 MARKUPCOMMAND \\({A}|[-_])+
155 LYRICS ({AA}|{TEX})[^0-9 \t\n\r\f]*
159 BOM_UTF8 \357\273\277
165 // swallow and ignore carriage returns
168 <extratoken>{ANY_CHAR} {
169 /* Generate a token without swallowing anything */
171 /* First unswallow the eaten character */
172 add_lexed_char (-YYLeng ());
175 /* produce requested token */
176 int type = scm_to_int (scm_caar (extra_tokens_));
177 yylval.scm = scm_cdar (extra_tokens_);
178 extra_tokens_ = scm_cdr (extra_tokens_);
179 if (scm_is_null (extra_tokens_))
185 <extratoken><<EOF>> {
186 /* Generate a token without swallowing anything */
188 /* produce requested token */
189 int type = scm_to_int (scm_caar (extra_tokens_));
190 yylval.scm = scm_cdar (extra_tokens_);
191 extra_tokens_ = scm_cdr (extra_tokens_);
192 if (scm_is_null (extra_tokens_))
198 /* Use the trailing context feature. Otherwise, the BOM will not be
199 found if the file starts with an identifier definition. */
200 <INITIAL,chords,lyrics,figures,notes>{BOM_UTF8}/.* {
201 if (this->lexloc_->line_number () != 1 || this->lexloc_->column_number () != 0)
203 LexerWarning (_ ("stray UTF-8 BOM encountered").c_str ());
206 debug_output (_ ("Skipping UTF-8 BOM"));
209 <INITIAL,chords,figures,incl,lyrics,markup,notes>{
211 yy_push_state (longcomment);
213 %[^{\n\r][^\n\r]*[\n\r] {
215 %[^{\n\r] { // backup rule
226 <INITIAL,notes,figures,chords,markup>{
232 <INITIAL,chords,lyrics,notes,figures>\\version{WHITE}* {
233 yy_push_state (version);
235 <INITIAL,chords,lyrics,notes,figures>\\sourcefilename{WHITE}* {
236 yy_push_state (sourcefilename);
238 <INITIAL,chords,lyrics,notes,figures>\\sourcefileline{WHITE}* {
239 yy_push_state (sourcefileline);
241 <version>\"[^"]*\" { /* got the version number */
242 string s (YYText () + 1);
243 s = s.substr (0, s.rfind ('\"'));
247 SCM top_scope = scm_car (scm_last_pair (scopes_));
248 scm_module_define (top_scope, ly_symbol2scm ("version-seen"), SCM_BOOL_T);
250 if (!is_valid_version (s))
255 <sourcefilename>\"[^"]*\" {
256 string s (YYText () + 1);
257 s = s.substr (0, s.rfind ('\"'));
260 this->here_input().get_source_file ()->name_ = s;
261 message (_f ("Renaming input to: `%s'", s.c_str ()));
262 progress_indication ("\n");
263 scm_module_define (scm_car (scopes_),
264 ly_symbol2scm ("input-file-name"),
269 <sourcefileline>{INT} {
271 sscanf (YYText (), "%d", &i);
274 this->here_input ().get_source_file ()->set_line (here_input ().start (), i);
277 <version>{ANY_CHAR} {
278 LexerError (_ ("quoted string expected after \\version").c_str ());
281 <sourcefilename>{ANY_CHAR} {
282 LexerError (_ ("quoted string expected after \\sourcefilename").c_str ());
285 <sourcefileline>{ANY_CHAR} {
286 LexerError (_ ("integer expected after \\sourcefileline").c_str ());
301 <INITIAL,chords,lyrics,notes,figures>\\maininput {
305 is_main_input_ = true;
308 error (_ ("\\maininput not allowed outside init files"));
311 <INITIAL,chords,lyrics,figures,notes>\\include {
312 yy_push_state (incl);
314 <incl>\"[^""]*\" { /* got the include file name */
315 string s (YYText ()+1);
316 s = s.substr (0, s.rfind ('"'));
318 new_input (s, sources_);
321 <incl>\\{BLACK}*{WHITE}? { /* got the include identifier */
322 string s = YYText () + 1;
323 strip_trailing_white (s);
324 if (s.length () && (s[s.length () - 1] == ';'))
325 s = s.substr (0, s.length () - 1);
327 SCM sid = lookup_identifier (s);
328 if (scm_is_string (sid)) {
329 new_input (ly_scm2string (sid), sources_);
332 string msg (_f ("wrong or undefined identifier: `%s'", s ));
334 LexerError (msg.c_str ());
335 SCM err = scm_current_error_port ();
336 scm_puts ("This value was found in the table: ", err);
337 scm_display (sid, err);
340 <incl>(\$|#) { // scm for the filename
342 Input hi = here_input();
344 SCM sval = ly_parse_scm (hi.start (), &n, hi,
345 be_safe_global && is_main_input_, parser_);
346 sval = eval_scm (sval);
348 for (int i = 0; i < n; i++)
352 char_count_stack_.back () += n;
354 if (scm_is_string (sval)) {
355 new_input (ly_scm2string (sval), sources_);
358 LexerError (_ ("string expected after \\include").c_str ());
359 if (sval != SCM_UNDEFINED) {
360 SCM err = scm_current_error_port ();
361 scm_puts ("This value was found instead: ", err);
362 scm_display (sval, err);
367 <incl,version,sourcefilename>\"[^""]* { // backup rule
368 error (_ ("end quote missing"));
371 <chords,notes,figures>{RESTNAME} {
372 char const *s = YYText ();
373 yylval.scm = scm_from_locale_string (s);
376 <chords,notes,figures>R {
377 return MULTI_MEASURE_REST;
379 <INITIAL,chords,figures,lyrics,markup,notes># { //embedded scm
381 Input hi = here_input();
383 SCM sval = ly_parse_scm (hi.start (), &n, hi,
384 be_safe_global && is_main_input_, parser_);
386 if (sval == SCM_UNDEFINED)
389 for (int i = 0; i < n; i++)
393 char_count_stack_.back () += n;
399 <INITIAL,chords,figures,lyrics,markup,notes>\$ { //immediate scm
401 Input hi = here_input();
403 SCM sval = ly_parse_scm (hi.start (), &n, hi,
404 be_safe_global && is_main_input_, parser_);
406 for (int i = 0; i < n; i++)
410 char_count_stack_.back () += n;
412 sval = eval_scm (sval);
414 int token = scan_scm_id (sval);
415 if (!scm_is_eq (yylval.scm, SCM_UNSPECIFIED))
419 <INITIAL,notes,lyrics>{
421 return DOUBLE_ANGLE_OPEN;
424 return DOUBLE_ANGLE_CLOSE;
451 return scan_bare_word (YYText ());
455 return scan_escaped_word (YYText () + 1);
458 yylval.scm = scan_fraction (YYText ());
461 {UNSIGNED}/\/ | // backup rule
463 yylval.scm = scm_c_read_string (YYText ());
467 yylval.i = String_convert::dec2int (string (YYText () +1));
474 *yylval.string += to_string (escaped_char (YYText ()[1]));
477 *yylval.string += YYText ();
483 /* yylval is union. Must remember STRING before setting SCM*/
484 string *sp = yylval.string;
485 yylval.scm = ly_string2scm (*sp);
487 return is_lyric_state () ? LYRICS_STRING : STRING;
490 *yylval.string += YYText ();
496 start_lyric_quote ();
499 yylval.scm = scan_fraction (YYText ());
502 {UNSIGNED}/\/[^0-9] { // backup rule
503 yylval.scm = scm_c_read_string (YYText ());
506 {UNSIGNED}/\/ | // backup rule
508 yylval.scm = scm_c_read_string (YYText ());
512 return scan_escaped_word (YYText () + 1);
516 string s (YYText ());
518 return yylval.i = EXTENDER;
520 return yylval.i = HYPHEN;
523 char c = s[s.length () - 1];
524 if (c == '{' || c == '}') // brace open is for not confusing dumb tools.
525 here_input ().warning (
526 _ ("Brace found at end of lyric. Did you forget a space?"));
527 yylval.scm = ly_string2scm (s);
530 return LYRICS_STRING;
538 return scan_bare_word (YYText ());
541 return scan_escaped_word (YYText () + 1);
544 yylval.scm = scan_fraction (YYText ());
547 {UNSIGNED}/\/[^0-9] { // backup rule
548 yylval.scm = scm_c_read_string (YYText ());
551 {UNSIGNED}/\/ | // backup rule
553 yylval.scm = scm_c_read_string (YYText ());
582 string str (YYText () + 1);
584 int token_type = MARKUP_FUNCTION;
585 SCM s = lookup_markup_command (str);
587 // lookup-markup-command returns a pair with the car
588 // being the function to call, and the cdr being the
589 // call signature specified to define-markup-command,
590 // a list of predicates.
592 if (!scm_is_pair (s)) {
593 // If lookup-markup-command was not successful, we
594 // try lookup-markup-list-command instead.
595 // If this fails as well, we just scan and return
597 s = lookup_markup_list_command (str);
599 token_type = MARKUP_LIST_FUNCTION;
601 return scan_escaped_word (str);
604 // If the list of predicates is, say,
605 // (number? number? markup?), then tokens
606 // EXPECT_MARKUP EXPECT_SCM EXPECT_SCM EXPECT_NO_MORE_ARGS
607 // will be generated. Note that we have to push them
608 // in reverse order, so the first token pushed in the
609 // loop will be EXPECT_NO_MORE_ARGS.
611 yylval.scm = scm_car(s);
613 // yylval now contains the function to call as token
614 // value (for token type MARKUP_FUNCTION or
615 // MARKUP_LIST_FUNCTION).
617 push_extra_token(EXPECT_NO_MORE_ARGS);
619 for (; scm_is_pair(s); s = scm_cdr(s)) {
620 SCM predicate = scm_car(s);
622 if (predicate == ly_lily_module_constant ("markup-list?"))
623 push_extra_token(EXPECT_MARKUP_LIST);
624 else if (predicate == ly_lily_module_constant ("markup?"))
625 push_extra_token(EXPECT_MARKUP);
627 push_extra_token(EXPECT_SCM, predicate);
634 [^$#{}\"\\ \t\n\r\f]+ {
635 string s (YYText ());
637 char c = s[s.length () - 1];
638 /* brace open is for not confusing dumb tools. */
639 if (c == '{' || c == '}')
640 here_input ().warning (
641 _ ("Brace found at end of markup. Did you forget a space?"));
642 yylval.scm = ly_string2scm (s);
652 <longcomment><<EOF>> {
653 LexerError (_ ("EOF found inside a comment").c_str ());
654 is_main_input_ = false; // should be safe , can't have \include in --safe.
656 yyterminate (); // can't move this, since it actually rets a YY_NULL
659 <<EOF>> { if (is_main_input_)
661 /* 2 = init.ly + current file.
662 > because we're before closing, but is_main_input_ should
665 is_main_input_ = include_stack_.size () > 2;
667 /* Returns YY_NULL */
670 else if (!close_input ())
671 /* Returns YY_NULL */
677 return scan_bare_word (YYText ());
680 return scan_escaped_word (YYText () + 1);
684 -{UNSIGNED} | // backup rule
686 yylval.scm = scm_c_read_string (YYText ());
690 yylval.scm = scm_from_double (0.0);
695 yylval.scm = scm_c_read_string (YYText ());
705 char c = YYText ()[0];
710 <INITIAL,notes,figures>. {
714 <INITIAL,lyrics,notes,figures>\\. {
715 char c = YYText ()[1];
719 return E_ANGLE_CLOSE;
723 return E_EXCLAMATION;
729 return E_BRACKET_OPEN;
733 return E_BRACKET_CLOSE;
745 string msg = _f ("invalid character: `%c'", YYText ()[0]);
746 LexerError (msg.c_str ());
752 /* Make the lexer generate a token of the given type as the next token.
753 TODO: make it possible to define a value for the token as well */
755 Lily_lexer::push_extra_token (int token_type, SCM scm)
757 if (scm_is_null (extra_tokens_))
759 if (YY_START != extratoken)
760 hidden_state_ = YY_START;
761 yy_push_state (extratoken);
763 extra_tokens_ = scm_acons (scm_from_int (token_type), scm, extra_tokens_);
767 Lily_lexer::push_chord_state (SCM tab)
769 pitchname_tab_stack_ = scm_cons (tab, pitchname_tab_stack_);
770 yy_push_state (chords);
774 Lily_lexer::push_figuredbass_state ()
776 yy_push_state (figures);
780 Lily_lexer::push_initial_state ()
782 yy_push_state (INITIAL);
786 Lily_lexer::push_lyric_state ()
788 yy_push_state (lyrics);
792 Lily_lexer::push_markup_state ()
794 yy_push_state (markup);
798 Lily_lexer::push_note_state (SCM tab)
800 pitchname_tab_stack_ = scm_cons (tab, pitchname_tab_stack_);
801 yy_push_state (notes);
805 Lily_lexer::pop_state ()
807 if (YYSTATE == notes || YYSTATE == chords)
808 pitchname_tab_stack_ = scm_cdr (pitchname_tab_stack_);
814 Lily_lexer::identifier_type (SCM sid)
816 int k = try_special_identifiers (&yylval.scm , sid);
817 return k >= 0 ? k : SCM_IDENTIFIER;
822 Lily_lexer::scan_escaped_word (string str)
824 // use more SCM for this.
826 // SCM sym = ly_symbol2scm (str.c_str ());
828 int i = lookup_keyword (str);
829 if (i == MARKUP && is_lyric_state ())
834 SCM sid = lookup_identifier (str);
835 if (sid != SCM_UNDEFINED)
836 return scan_scm_id (sid);
838 string msg (_f ("unknown escaped string: `\\%s'", str));
839 LexerError (msg.c_str ());
841 yylval.scm = ly_string2scm (str);
847 Lily_lexer::scan_scm_id (SCM sid)
849 if (is_music_function (sid))
851 int funtype = SCM_FUNCTION;
853 yylval.scm = get_music_function_transform (sid);
855 SCM s = scm_object_property (yylval.scm, ly_symbol2scm ("music-function-signature"));
856 SCM cs = scm_car (s);
858 if (scm_is_pair (cs))
863 if (scm_is_eq (cs, ly_lily_module_constant ("ly:music?")))
864 funtype = MUSIC_FUNCTION;
865 else if (scm_is_eq (cs, ly_lily_module_constant ("ly:event?")))
866 funtype = EVENT_FUNCTION;
867 else if (ly_is_procedure (cs))
868 funtype = SCM_FUNCTION;
869 else programming_error ("Bad syntax function predicate");
871 push_extra_token (EXPECT_NO_MORE_ARGS);
872 for (s = scm_cdr (s); scm_is_pair (s); s = scm_cdr (s))
874 SCM optional = SCM_UNDEFINED;
877 if (scm_is_pair (cs))
879 optional = SCM_CDR (cs);
883 if (cs == Pitch_type_p_proc)
884 push_extra_token (EXPECT_PITCH);
885 else if (cs == Duration_type_p_proc)
886 push_extra_token (EXPECT_DURATION);
887 else if (ly_is_procedure (cs))
888 push_extra_token (EXPECT_SCM, cs);
891 programming_error ("Function parameter without type-checking predicate");
894 if (!scm_is_eq (optional, SCM_UNDEFINED))
895 push_extra_token (EXPECT_OPTIONAL, optional);
900 return identifier_type (sid);
904 Lily_lexer::scan_bare_word (string str)
906 SCM sym = ly_symbol2scm (str.c_str ());
907 if ((YYSTATE == notes) || (YYSTATE == chords)) {
908 SCM handle = SCM_BOOL_F;
909 if (scm_is_pair (pitchname_tab_stack_))
910 handle = scm_hashq_get_handle (scm_car (pitchname_tab_stack_), sym);
912 if (scm_is_pair (handle)) {
913 yylval.scm = scm_cdr (handle);
914 if (unsmob_pitch (yylval.scm))
915 return (YYSTATE == notes) ? NOTENAME_PITCH : TONICNAME_PITCH;
916 else if (scm_is_symbol (yylval.scm))
919 else if ((YYSTATE == chords)
920 && (handle = scm_hashq_get_handle (chordmodifier_tab_, sym))!= SCM_BOOL_F)
922 yylval.scm = scm_cdr (handle);
923 return CHORD_MODIFIER;
925 if ((chord_repetition_.repetition_symbol_ != SCM_EOL)
926 && to_boolean (scm_equal_p (chord_repetition_.repetition_symbol_, sym)))
927 return CHORD_REPETITION;
930 yylval.scm = ly_string2scm (str);
935 Lily_lexer::get_state () const
937 if (YY_START == extratoken)
938 return hidden_state_;
944 Lily_lexer::is_note_state () const
946 return get_state () == notes;
950 Lily_lexer::is_chord_state () const
952 return get_state () == chords;
956 Lily_lexer::is_lyric_state () const
958 return get_state () == lyrics;
962 Lily_lexer::is_figure_state () const
964 return get_state () == figures;
968 Lily_lexer::eval_scm (SCM readerdata)
970 SCM sval = SCM_UNDEFINED;
972 if (!SCM_UNBNDP (readerdata))
974 sval = ly_eval_scm (scm_car (readerdata),
975 *unsmob_input (scm_cdr (readerdata)),
976 be_safe_global && is_main_input_,
980 if (SCM_UNBNDP (sval))
983 return SCM_UNSPECIFIED;
991 urg, belong to string (_convert)
992 and should be generalised
995 strip_leading_white (string&s)
998 for (; i < s.length (); i++)
1006 strip_trailing_white (string&s)
1008 ssize i = s.length ();
1010 if (!isspace (s[i]))
1013 s = s.substr (0, i + 1);
1018 Lilypond_version oldest_version ("2.7.38");
1022 is_valid_version (string s)
1024 Lilypond_version current ( MAJOR_VERSION "." MINOR_VERSION "." PATCH_LEVEL );
1025 Lilypond_version ver (s);
1026 if (int (ver) < oldest_version)
1028 non_fatal_error (_f ("file too old: %s (oldest supported: %s)", ver.to_string (), oldest_version.to_string ()));
1029 non_fatal_error (_ ("consider updating the input with the convert-ly script"));
1035 non_fatal_error (_f ("program too old: %s (file requires: %s)", current.to_string (), ver.to_string ()));
1046 lyric_fudge (string s)
1048 char *chars = string_copy (s);
1050 for (char *p = chars; *p ; p++)
1052 if (*p == '_' && (p == chars || *(p-1) != '\\'))
1060 if ((i = s.find ("\\,")) != NPOS) // change "\," to TeX's "\c "
1062 * (((char*)s.c_str ()) + i + 1) = 'c';
1063 s = s.substr (0, i + 2) + " " + s.substr (i - 2);
1070 Convert "NUM/DEN" into a '(NUM . DEN) cons.
1073 scan_fraction (string frac)
1075 ssize i = frac.find ('/');
1076 string left = frac.substr (0, i);
1077 string right = frac.substr (i + 1, (frac.length () - i + 1));
1079 int n = String_convert::dec2int (left);
1080 int d = String_convert::dec2int (right);
1081 return scm_cons (scm_from_int (n), scm_from_int (d));
1085 lookup_markup_command (string s)
1087 SCM proc = ly_lily_module_constant ("lookup-markup-command");
1088 return scm_call_1 (proc, ly_string2scm (s));
1092 lookup_markup_list_command (string s)
1094 SCM proc = ly_lily_module_constant ("lookup-markup-list-command");
1095 return scm_call_1 (proc, ly_string2scm (s));
1098 /* Shut up lexer warnings. */
1118 silence_lexer_warnings ()
1120 (void) yy_start_stack_ptr;
1121 (void) yy_start_stack_depth;
1122 (void) yy_start_stack;
1123 (void) yy_push_state;
1124 (void) yy_pop_state;
1125 (void) yy_top_state;
1126 (void) silence_lexer_warnings;