2 * Copyright 2006 Adrian Thurston <thurston@cs.queensu.ca>
5 /* This file is part of Ragel.
7 * Ragel is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * Ragel is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Ragel; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include "parsedata.h"
40 /* This is used for tracking the current stack of include file/machine pairs. It is
41 * is used to detect and recursive include structure. */
42 struct IncludeStackItem
44 IncludeStackItem( char *fileName, char *sectionName )
45 : fileName(fileName), sectionName(sectionName) {}
51 typedef Vector<IncludeStackItem> IncludeStack;
61 Scanner( char *fileName, istream &input, ostream &output,
62 Parser *inclToParser, char *inclSectionTarg,
65 fileName(fileName), input(input), output(output),
66 inclToParser(inclToParser),
67 inclSectionTarg(inclSectionTarg),
68 includeDepth(includeDepth),
69 line(1), column(1), lastnl(0),
70 parser(0), active(false),
71 parserExistsError(false),
75 bool recursiveInclude( char *inclFileName, char *inclSectionName );
77 char *prepareFileName( char *fileName, int len )
80 Token tokenFnStr, tokenRes;
81 tokenFnStr.data = fileName;
82 tokenFnStr.length = len;
83 tokenFnStr.prepareLitString( tokenRes, caseInsensitive );
88 void token( int type, char *start, char *end );
89 void token( int type, char c );
90 void token( int type );
96 ostream &scan_error();
101 Parser *inclToParser;
102 char *inclSectionTarg;
108 int word_len, lit_len;
110 char *tokstart, *tokend;
114 /* Set by machine statements, these persist from section to section
115 * allowing for unnamed sections. */
118 IncludeStack includeStack;
120 /* This is set if ragel has already emitted an error stating that
121 * no section name has been seen and thus no parser exists. */
122 bool parserExistsError;
124 /* This is for inline code. By default it is on. It goes off for
125 * statements and values in inline blocks which are parsed. */
130 machine section_parse;
135 void Scanner::init( )
140 bool Scanner::parserExists()
145 if ( ! parserExistsError ) {
146 scan_error() << "include: there is no previous specification name" << endl;
147 parserExistsError = true;
152 ostream &Scanner::scan_error()
154 /* Maintain the error count. */
156 cerr << fileName << ":" << line << ":" << column << ": ";
160 bool Scanner::recursiveInclude( char *inclFileName, char *inclSectionName )
162 for ( IncludeStack::Iter si = includeStack; si.lte(); si++ ) {
163 if ( strcmp( si->fileName, inclFileName ) == 0 &&
164 strcmp( si->sectionName, inclSectionName ) == 0 )
172 void Scanner::updateCol()
177 //cerr << "adding " << tokend - from << " to column" << endl;
178 column += tokend - from;
182 void Scanner::token( int type, char c )
184 token( type, &c, &c + 1 );
187 void Scanner::token( int type )
193 machine section_parse;
195 # This relies on the the kelbt implementation and the order
196 # that tokens are declared.
203 action clear_words { word = lit = 0; word_len = lit_len = 0; }
204 action store_word { word = tokdata; word_len = toklen; }
205 action store_lit { lit = tokdata; lit_len = toklen; }
207 action mach_err { scan_error() << "bad machine statement" << endl; }
208 action incl_err { scan_error() << "bad include statement" << endl; }
209 action write_err { scan_error() << "bad write statement" << endl; }
211 action handle_machine
213 /* Assign a name to the machine. */
214 char *machine = word;
216 if ( inclSectionTarg == 0 ) {
219 ParserDictEl *pdEl = parserDict.find( machine );
221 pdEl = new ParserDictEl( machine );
222 pdEl->value = new Parser( fileName, machine, sectionLoc );
224 parserDict.insert( pdEl );
227 parser = pdEl->value;
229 else if ( strcmp( inclSectionTarg, machine ) == 0 ) {
230 /* found include target */
232 parser = inclToParser;
235 /* ignoring section */
242 ( KW_Machine TK_Word @store_word ';' ) @handle_machine
243 <>err mach_err <>eof mach_err;
245 action handle_include
247 if ( active && parserExists() ) {
248 char *inclSectionName = word;
249 char *inclFileName = 0;
251 /* Implement defaults for the input file and section name. */
252 if ( inclSectionName == 0 )
253 inclSectionName = parser->sectionName;
256 inclFileName = prepareFileName( lit, lit_len );
258 inclFileName = fileName;
260 /* Check for a recursive include structure. Add the current file/section
261 * name then check if what we are including is already in the stack. */
262 includeStack.append( IncludeStackItem( fileName, parser->sectionName ) );
264 if ( recursiveInclude( inclFileName, inclSectionName ) )
265 scan_error() << "include: this is a recursive include operation" << endl;
267 /* Open the input file for reading. */
268 ifstream *inFile = new ifstream( inclFileName );
269 if ( ! inFile->is_open() ) {
270 scan_error() << "include: could not open " <<
271 inclFileName << " for reading" << endl;
274 Scanner scanner( inclFileName, *inFile, output, parser,
275 inclSectionName, includeDepth+1 );
281 /* Remove the last element (len-1) */
282 includeStack.remove( -1 );
287 TK_Word @store_word ( TK_Literal @store_lit )? |
288 TK_Literal @store_lit
292 ( KW_Include include_names ';' ) @handle_include
293 <>err incl_err <>eof incl_err;
298 if ( strcmp( tokdata, "data" ) != 0 &&
299 strcmp( tokdata, "init" ) != 0 &&
300 strcmp( tokdata, "exec" ) != 0 &&
301 strcmp( tokdata, "eof" ) != 0 )
303 scan_error() << "unknown write command" << endl;
305 output << "<write def_name=\"" << parser->sectionName <<
306 "\" what=\"" << tokdata << "\">";
313 output << "<option>" << tokdata << "</option>";
318 output << "</write>\n";
322 ( KW_Write TK_Word @write_command
323 ( TK_Word @write_option )* ';' @write_close )
324 <>err write_err <>eof write_err;
328 /* Send the token off to the parser. */
329 if ( active && parserExists() ) {
333 cerr << "scanner:" << line << ":" << column <<
334 ": sending token to the parser " << lelNames[*p];
335 cerr << " " << toklen;
337 cerr << " " << tokdata;
341 loc.fileName = fileName;
345 parser->token( loc, type, tokdata, toklen );
349 # Catch everything else.
350 everything_else = ^( KW_Machine | KW_Include | KW_Write ) @handle_token;
360 void Scanner::token( int type, char *start, char *end )
369 tokdata = new char[toklen+1];
370 memcpy( tokdata, start, toklen );
375 machine section_parse;
382 void Scanner::startSection( )
384 parserExistsError = false;
386 if ( includeDepth == 0 ) {
387 if ( machineSpec == 0 && machineName == 0 )
388 output << "</host>\n";
391 sectionLoc.fileName = fileName;
392 sectionLoc.line = line;
396 void Scanner::endSection( )
398 /* Execute the eof actions for the section parser. */
400 machine section_parse;
404 /* Close off the section with the parser. */
405 if ( active && parserExists() ) {
407 loc.fileName = fileName;
411 parser->token( loc, TK_EndSection, 0, 0 );
414 if ( includeDepth == 0 ) {
415 if ( machineSpec == 0 && machineName == 0 ) {
416 /* The end section may include a newline on the end, so
417 * we use the last line, which will count the newline. */
418 output << "<host line=\"" << line << "\">";
426 # This is sent by the driver code.
436 # Identifiers, numbers, commetns, and other common things.
437 ident = ( alpha | '_' ) ( alpha |digit |'_' )*;
439 hex_number = '0x' [0-9a-fA-F]+;
442 '/*' ( any | NL )* :>> '*/';
447 c_cpp_comment = c_comment | cpp_comment;
449 # These literal forms are common to C-like host code and ragel.
450 s_literal = "'" ([^'\\] | NL | '\\' (any | NL))* "'";
451 d_literal = '"' ([^"\\] | NL | '\\' (any | NL))* '"';
453 whitespace = [ \t] | NL;
454 pound_comment = '#' [^\n]* NL;
456 # An inline block of code. This is specified as a scanned, but is sent to
457 # the parser as one long block. The inline_block pointer is used to handle
458 # the preservation of the data.
460 # Inline expression keywords.
461 "fpc" => { token( KW_PChar ); };
462 "fc" => { token( KW_Char ); };
463 "fcurs" => { token( KW_CurState ); };
464 "ftargs" => { token( KW_TargState ); };
466 whitespaceOn = false;
470 # Inline statement keywords.
472 whitespaceOn = false;
475 "fexec" => { token( KW_Exec, 0, 0 ); };
477 whitespaceOn = false;
481 whitespaceOn = false;
485 whitespaceOn = false;
489 whitespaceOn = false;
493 whitespaceOn = false;
497 ident => { token( TK_Word, tokstart, tokend ); };
499 number => { token( TK_UInt, tokstart, tokend ); };
500 hex_number => { token( TK_Hex, tokstart, tokend ); };
502 ( s_literal | d_literal )
503 => { token( IL_Literal, tokstart, tokend ); };
507 token( IL_WhiteSpace, tokstart, tokend );
509 c_cpp_comment => { token( IL_Comment, tokstart, tokend ); };
511 "::" => { token( TK_NameSep, tokstart, tokend ); };
513 # Some symbols need to go to the parser as with their cardinal value as
514 # the token type (as opposed to being sent as anonymous symbols)
515 # because they are part of the sequences which we interpret. The * ) ;
516 # symbols cause whitespace parsing to come back on. This gets turned
517 # off by some keywords.
521 token( *tokstart, tokstart, tokend );
522 if ( inlineBlockType == SemiTerminated )
528 token( *tokstart, tokstart, tokend );
531 [,(] => { token( *tokstart, tokstart, tokend ); };
534 token( IL_Symbol, tokstart, tokend );
539 if ( --curly_count == 0 && inlineBlockType == CurlyDelimited ) {
540 /* Inline code block ends. */
545 /* Either a semi terminated inline block or only the closing
546 * brace of some inner scope, not the block's closing brace. */
547 token( IL_Symbol, tokstart, tokend );
552 scan_error() << "unterminated code block" << endl;
555 # Send every other character as a symbol.
556 any => { token( IL_Symbol, tokstart, tokend ); };
560 # Escape sequences in OR expressions.
561 '\\0' => { token( RE_Char, '\0' ); };
562 '\\a' => { token( RE_Char, '\a' ); };
563 '\\b' => { token( RE_Char, '\b' ); };
564 '\\t' => { token( RE_Char, '\t' ); };
565 '\\n' => { token( RE_Char, '\n' ); };
566 '\\v' => { token( RE_Char, '\v' ); };
567 '\\f' => { token( RE_Char, '\f' ); };
568 '\\r' => { token( RE_Char, '\r' ); };
569 '\\\n' => { updateCol(); };
570 '\\' any => { token( RE_Char, tokstart+1, tokend ); };
572 # Range dash in an OR expression.
573 '-' => { token( RE_Dash, 0, 0 ); };
575 # Terminate an OR expression.
576 ']' => { token( RE_SqClose ); fret; };
579 scan_error() << "unterminated OR literal" << endl;
582 # Characters in an OR expression.
583 [^\]] => { token( RE_Char, tokstart, tokend ); };
588 # Escape sequences in regular expressions.
589 '\\0' => { token( RE_Char, '\0' ); };
590 '\\a' => { token( RE_Char, '\a' ); };
591 '\\b' => { token( RE_Char, '\b' ); };
592 '\\t' => { token( RE_Char, '\t' ); };
593 '\\n' => { token( RE_Char, '\n' ); };
594 '\\v' => { token( RE_Char, '\v' ); };
595 '\\f' => { token( RE_Char, '\f' ); };
596 '\\r' => { token( RE_Char, '\r' ); };
597 '\\\n' => { updateCol(); };
598 '\\' any => { token( RE_Char, tokstart+1, tokend ); };
600 # Terminate an OR expression.
602 token( RE_Slash, tokstart, tokend );
606 # Special characters.
607 '.' => { token( RE_Dot ); };
608 '*' => { token( RE_Star ); };
610 '[' => { token( RE_SqOpen ); fcall or_literal; };
611 '[^' => { token( RE_SqOpenNeg ); fcall or_literal; };
614 scan_error() << "unterminated regular expression" << endl;
617 # Characters in an OR expression.
618 [^\/] => { token( RE_Char, tokstart, tokend ); };
621 # We need a separate token space here to avoid the ragel keywords.
622 write_statement := |*
623 ident => { token( TK_Word, tokstart, tokend ); } ;
624 [ \t\n]+ => { updateCol(); };
625 ';' => { token( ';' ); fgoto parser_def; };
628 scan_error() << "unterminated write statement" << endl;
632 # Parser definitions.
634 'machine' => { token( KW_Machine ); };
635 'include' => { token( KW_Include ); };
638 fgoto write_statement;
640 'action' => { token( KW_Action ); };
641 'alphtype' => { token( KW_AlphType ); };
643 # FIXME: Enable this post 5.17.
644 # 'range' => { token( KW_Range ); };
648 inlineBlockType = SemiTerminated;
653 inlineBlockType = SemiTerminated;
657 token( KW_Variable );
658 inlineBlockType = SemiTerminated;
661 'when' => { token( KW_When ); };
662 'eof' => { token( KW_Eof ); };
663 'err' => { token( KW_Err ); };
664 'lerr' => { token( KW_Lerr ); };
665 'to' => { token( KW_To ); };
666 'from' => { token( KW_From ); };
669 ident => { token( TK_Word, tokstart, tokend ); } ;
672 number => { token( TK_UInt, tokstart, tokend ); };
673 hex_number => { token( TK_Hex, tokstart, tokend ); };
675 # Literals, with optionals.
676 ( s_literal | d_literal ) [i]?
677 => { token( TK_Literal, tokstart, tokend ); };
679 '[' => { token( RE_SqOpen ); fcall or_literal; };
680 '[^' => { token( RE_SqOpenNeg ); fcall or_literal; };
682 '/' => { token( RE_Slash ); fgoto re_literal; };
685 pound_comment => { updateCol(); };
687 ':=' => { token( TK_ColonEquals ); };
690 ">~" => { token( TK_StartToState ); };
691 "$~" => { token( TK_AllToState ); };
692 "%~" => { token( TK_FinalToState ); };
693 "<~" => { token( TK_NotStartToState ); };
694 "@~" => { token( TK_NotFinalToState ); };
695 "<>~" => { token( TK_MiddleToState ); };
698 ">*" => { token( TK_StartFromState ); };
699 "$*" => { token( TK_AllFromState ); };
700 "%*" => { token( TK_FinalFromState ); };
701 "<*" => { token( TK_NotStartFromState ); };
702 "@*" => { token( TK_NotFinalFromState ); };
703 "<>*" => { token( TK_MiddleFromState ); };
706 ">/" => { token( TK_StartEOF ); };
707 "$/" => { token( TK_AllEOF ); };
708 "%/" => { token( TK_FinalEOF ); };
709 "</" => { token( TK_NotStartEOF ); };
710 "@/" => { token( TK_NotFinalEOF ); };
711 "<>/" => { token( TK_MiddleEOF ); };
713 # Global Error actions.
714 ">!" => { token( TK_StartGblError ); };
715 "$!" => { token( TK_AllGblError ); };
716 "%!" => { token( TK_FinalGblError ); };
717 "<!" => { token( TK_NotStartGblError ); };
718 "@!" => { token( TK_NotFinalGblError ); };
719 "<>!" => { token( TK_MiddleGblError ); };
721 # Local error actions.
722 ">^" => { token( TK_StartLocalError ); };
723 "$^" => { token( TK_AllLocalError ); };
724 "%^" => { token( TK_FinalLocalError ); };
725 "<^" => { token( TK_NotStartLocalError ); };
726 "@^" => { token( TK_NotFinalLocalError ); };
727 "<>^" => { token( TK_MiddleLocalError ); };
730 "<>" => { token( TK_Middle ); };
733 '>?' => { token( TK_StartCond ); };
734 '$?' => { token( TK_AllCond ); };
735 '%?' => { token( TK_LeavingCond ); };
737 '..' => { token( TK_DotDot ); };
738 '**' => { token( TK_StarStar ); };
739 '--' => { token( TK_DashDash ); };
740 '->' => { token( TK_Arrow ); };
741 '=>' => { token( TK_DoubleArrow ); };
743 ":>" => { token( TK_ColonGt ); };
744 ":>>" => { token( TK_ColonGtGt ); };
745 "<:" => { token( TK_LtColon ); };
747 # Opening of longest match.
748 "|*" => { token( TK_BarStar ); };
756 [ \t]+ => { updateCol(); };
758 # If we are in a single line machine then newline may end the spec.
761 if ( singleLineSpec ) {
770 inlineBlockType = CurlyDelimited;
775 scan_error() << "unterminated ragel section" << endl;
778 any => { token( *tokstart ); } ;
784 /* If no errors and we are at the bottom of the include stack (the
785 * source file listed on the command line) then write out the data. */
786 if ( includeDepth == 0 && machineSpec == 0 && machineName == 0 )
787 xmlEscapeHost( output, tokstart, tokend-tokstart );
790 # Outside code scanner. These tokens get passed through.
794 c_cpp_comment => pass;
795 s_literal | d_literal => pass;
798 singleLineSpec = false;
804 singleLineSpec = true;
817 void Scanner::do_scan()
820 char *buf = new char[bufsize];
821 const char last_char = 0;
822 int cs, act, have = 0;
826 bool singleLineSpec = false;
827 InlineBlockType inlineBlockType;
832 char *p = buf + have;
833 int space = bufsize - have;
836 /* We filled up the buffer trying to scan a token. Grow it. */
837 bufsize = bufsize * 2;
838 char *newbuf = new char[bufsize];
840 /* Recompute p and space. */
842 space = bufsize - have;
844 /* Patch up pointers possibly in use. */
846 tokstart = newbuf + ( tokstart - buf );
847 tokend = newbuf + ( tokend - buf );
849 /* Copy the new buffer in. */
850 memcpy( newbuf, buf, have );
855 input.read( p, space );
856 int len = input.gcount();
858 /* If we see eof then append the EOF char. */
860 p[0] = last_char, len = 1;
867 /* Check if we failed. */
868 if ( cs == rlscan_error ) {
869 /* Machine failed before finding a token. I'm not yet sure if this
871 scan_error() << "scanner error" << endl;
875 /* Decide if we need to preserve anything. */
876 char *preserve = tokstart;
878 /* Now set up the prefix. */
882 /* There is data that needs to be shifted over. */
883 have = pe - preserve;
884 memmove( buf, preserve, have );
885 unsigned int shiftback = preserve - buf;
887 tokstart -= shiftback;
897 void scan( char *fileName, istream &input, ostream &output )
899 Scanner scanner( fileName, input, output, 0, 0, 0 );
904 eofLoc.fileName = fileName;
906 eofLoc.line = scanner.line;