1 Ragel 6.3 - Aug 29, 2008
2 ========================
3 -Fixed an assertion that is too strong. In the condition code we need to copy
4 transitions that have non-empty lmActionTable arrays so we don't assert
5 emptiness in the constructor. Lift out the assertion and copy the array in
7 -Fixed and improved multiple include prevention. We now track the entire
8 include history of a parser state to prevent duplicates.
9 -Fixed crash on failed lookup of goto/call/etc target.
11 Ragel 6.2 - May 9, 2008
12 =======================
13 -Bug fix: The lm_switch actions needs to set p from tokend when there is no
15 -Bug fix: when not using indicies we can't use a transitions's id to identify
16 the eof transition to take. Instead add the transition to the end of the
17 transition list and store its position in a new var called pos. The pos var
18 is then used as the index.
19 -Bug fix: an fnext followed by an fbreak in -G2 was not working. The fbreak
20 was not aware that the fnext causes the cs variable to be forced active. In
21 this case fbreak does not need to save cs because it is already current.
22 -Bug fix: need to compute the low and high character-space keys from the
23 condition-trans overlap when computing an expansion. Can't use the range
24 supplied from the condition overlap since they may not match. An incorrect
25 machine that accepted 1(!cond1, !cond2) was generated for the following
26 grammar. This bug was reported by Tim Chklovski.
28 sc1 = 1..2 when cond1;
29 sc2 = 1..2 when cond2;
30 main := sc1 | c | sc2;
31 -Bug fix: error messages in start label analysis of join operations were
32 causing assertion failures because location info was not set. Fixed by
34 -Include and import file searching now searches for the file name given based
35 on the location of the current file, not ragel's current path.
36 Additional search locations can be given using the -I option.
37 -Rubinius code generation was updated to the latest Rubinius. Patch from Evan
39 -Switched from strcasecmp to strcmp for testing long arguments.
40 -Applied a patch from Andrei Polushin for setting the error message format.
41 --error-format=gnu (default)
43 -Now using the _WIN32 define instead of _WIN32. Other MSVC compilation
44 improvments from Andrei Polushin.
45 -Added the hyperref package to the manual.
47 Ragel 6.1 - Mar 26, 2008
48 ========================
49 -Scanners now ensure that any leaving actions at the end of a pattern are
50 executed. They are always executed before the pattern action.
51 -Added an option -d for turning off the removal of duplicate actions from
53 -Need to unset the final state status of the start state in kleene star if it
54 is set. It is possible to crash ragel when the warning is ignored.
55 -In the dot file generation we need to print any actions that are in
56 State::eofTrans. These come from scanners only.
57 -Use @docdir@ for the docdir Makefile variable.
58 -Check for ar and ranlib in the configure script.
60 Ragel 6.0 - Jan 12, 2008
61 ========================
62 -Removed the 'noend' write option from examples/atoi.rl. This example is
63 referenced a lot as a first example and as such it shouldn't contain a
64 special purpose write option like 'noend'.
65 -Introcuded the "eof" variable for indicating the end of file. The p variable
66 is checked against eof when the processing loop reaches the end of a block.
67 If p == eof at this time then the EOF actions are executed. The variable is
68 required only when EOF actions have been emebedded.
69 -The "write eof" command is no longer needed and was removed.
70 -Scanners now use EOF actions to generate tokens. This eliminates the need to
72 -Restructured the Java driver; a switch statement with fallthrough cases are
73 now used to emulate gotos.
74 -Ruby code generation was also restructured. Gotos are elmulated using a
76 -Went back to 3.X semantics for >, % and error actions. The > operator also
77 embeds a leaving action/priority into the start state if it is final. If EOF
78 happens in a state with a leaving operator then the leaving action is
79 executed. If EOF happens in a non-final state that has an error action, the
80 error action is executed.
81 -The "ragel" program now executes frontend and backend processes separately,
82 connecting them with a temporary file in the current directory. Without the
83 -x option the "ragel" program marshals arguments and calls the frontend and
84 backend. With the -x option the "ragel" program acts as the frontend only.
85 -Added name finding for executables. If any forward slash is found in argv0
86 then it is assumed that the path is explicit and the path to the backend
87 executable should be derived from that. Whe check that location and also go
88 up one then inside a directory of the same name in case we are executing
89 from the source tree. If no forward slash is found it is assumed the file is
90 being run from the installed location. The PREFIX supplied during
91 configuration is used.
92 -On windows GetModuleFileNameEx is used to find out where the the current
93 process's binary is. That location is searched first. If that fails then we
94 go up one directory and look for the executable inside a directory of the
95 same name in case we are executing from the source tree.
96 -Changed the -l option in rlgen-cd to -L because it is covered in the
97 frontend. Added a passthrough in the frontend for the backend options.
98 -Dot file generation can now be invoked using the -V option to ragel. We
99 now require an input file. If standard in is used then we don't have a file
100 name on which to base the output.
101 -Able to build native windows executables using Cygwin+MinGW.
102 -Patch from David Waite: Large arrays are now created by copying in the data
103 from smaller arrays using System.arraycopy(). This eliminates the debug data
104 associated with explicit initialization statements. It is also much easier
105 on the java compiler which can run out of memory compiling very large
106 machines. The downside is that it takes slightly longer to initialize static
108 -The fbreak statement now advances p.
109 -In the :> :>> and <: operators it was possible for the priority assignment
110 to be bypassed via the zero length string. In :> this was fixed
111 automatically with the semantics change to the entering priority operator.
112 If the start state is final it now embeds a leaving action into it,
113 preventing persistance through the zero length string. In :>> and <: this
114 was fixed explicitly. With <: the entering priority operator was used and
115 with :> a special exception was added. Since it uses the finishing
116 transition operator it also adds a leaving priority to the start state if it
118 -Ranlib is now run on the archives. Patch from Kenny MacDermid.
119 -The case statement syntax in ruby code generation used a form depreciated in
120 Ruby 1.9. Updated it.
121 -Made a number of fixes that eliminate warnings in GCC 4.3. Mostly concern
122 the now depreciate automatic conversion of string contsants to "char*" type.
123 Other fixes include adding parenthesis around && within ||.
124 -The "tokstart" and "tokend" variables were changed to "ts" and "te".
126 Ragel 5.25 - Dec 24, 2007
127 =========================
128 -Fixed segfault reported by Ryan Phelps. Affected Java and Ruby code
129 generation. The dataExpr variable was not initialized.
130 -Fixed incorrect case label in test/runtests. Caused Objective-C tests to be
132 -Added missing include to common.cpp.
134 Ragel 5.24 - Sep 16, 2007
135 =========================
136 -Applied patch from Victor Hugo Borja <vic@rubyforge.org>. This patch
137 implements -T1 -F0 -F1 and -G0 in the ruby code generator. Goto-driven code
138 generation is experimental and requires rubinius asm directives (specify
139 with --rbx option). These code generators pass all the ruby tests.
140 -If the condition embedding code runs out of available characters in the
141 keyspace an error message is emitted.
142 -The first example that appeared in the manual used the special-purpose
143 'noend' write option. This caused confusion. Now a basic example appears
145 -Added two new statements: prepush and postpop. These are code blocks that
146 are written out during call and return statements. The prepush code is
147 written immediately before pushing the current state to the state stack
148 during a call. The postpop code is written immediately after popping the
149 current state during return. These can be used to implement a dynamically
152 Ragel 5.23 - Jul 24, 2007
153 =========================
154 -Eliminated the use of callcc as an alternative to goto. Instead, the named
155 breaks implementation used in the Java code generator is imitated using
156 control flow variables.
157 -Improved the error message given when there is a write statement but no
158 machine instantiations and hence no state machine.
159 -Documentation improvements: updates to "Machine Instantiation", "Write Init"
160 and "Write Exports" sectons. Added the "Variables Used by Ragel" section.
161 -Renamed "Entering Actions" to "Starting Actions."
162 -Other documentation updates.
164 Ragel 5.22 - June 14, 2007
165 ==========================
166 -Bug fix: need to isolate the start state of a scanner before setting the
167 to-state and from-state actions which clear and set tokstart. This affected
168 very simple scanners only. Most scanners have an isolated start state due to
169 the pattern structure.
170 -Bug fix: when -S or -M was given the ragel version number was not emitted,
171 causing the backend to reject the intermediate format. From Tim Potter.
172 -The p varialbe is now set up at the beginning of a scanner action, rather
173 than at the end. This leaves scanner actions free to manipulate p and
174 removes the need for the special holdTE and execTE (TE for tokend) versions
175 of hold and exec. It also removes the need to set p = tokend-1 immediately
176 before any control flow. We loose the ability to determine where in the
177 input stream a scanner action is executed, however this information is of
178 little use because it is primarily an artifact of the scanner implementation
179 (sometimes the last char, other times later on). The gains of this change
180 are consistency and simplicity.
181 -The "data" variable (used in Java and Ruby code generation only) can now be
182 overridden using the variable statement.
184 Ragel 5.21 - May 9, 2007
185 ========================
186 -Fixed an inconsistency in the value of p following an error. In the C
187 directly executable code (rlgen-cd -G2) p is left at the character where
188 the error occurred, which is correct. In all other code generators it was
189 left at the following character. This was fixed. Now in all code generators
190 p is left at the character where the error occurred.
191 -Bug fix: when fhold was used in scanner pattern actions which get executed
192 on the last character of the pattern (pattern matches which do not require
193 any lookahead), fhold was modifying p instead of tokend. This was fixed and
194 the patact.rl test was modified to cover the case.
195 -Fixed typos in the guide, improved the state action embedding operator
196 section and added subsections on the variable, import, and export
198 -Implemented a better solution than the pri hack for resolving the '-'
199 ambiguity: force a shortest match of term.
200 -Fixed bugs in the binary searching for condition keys in both the Ruby and
201 Java code generation.
202 -Can now embed the negative sense of a condition. Added a language-
203 independent test case for this feature and the necessary transformation
205 -Added new condition embedding syntax:
206 expr inwhen cond - The transitions into the machine (starting transitions).
207 expr outwhen cond - The pending transitions out of the machine.
208 -The argument to the variable statement which affects the name of the current
209 state variable was changed from "curstate" to "cs" (the default name used
210 for the current state)
211 -Implemented the other variables names in the variable statement. Now all
212 variables (p, pe, cs, top, stack, act, tokstart, tokend) can be renamed.
213 -Parse errors in the intermediate XML file now cause the backend to exit
214 immediately rather then forge on. The recovery infrastructure isn't there
215 and segfaults are likely.
216 -When no input is given to the backend program, it should not print an error
217 message, it should just return a non-zero exit status. The assumption is
218 that the frontend printed an error.
219 -The version number is now included in the intermediate file. An error is
220 emitted if there is a mismatch.
221 -The alphabet type is now communicated from the frontend to the backend using
222 a one-word internal name instead of an array offset.
223 -The Ruby host language types had been just copied from Java. Reduced them to
224 two basic types: char and int, both signed with the usual C sizes.
226 Ragel 5.20 - Apr 7, 2007
227 ========================
228 -The cs variable is now always initialized, unless the "nocs" option is given
229 to the write init command. If there is no main machine, cs is initialized to
230 the entry point defined by the last machine instantiation.
231 -A number of fixes were made to the Ruby code generator.
232 -The frontend now scans ruby comments and regular expressions.
233 -A transformation for Ruby was added to the language-independent test suite.
234 The Ruby code generator passes on all the language-independent tests.
235 -A new Ruby test and two language-independent tests were added.
236 -Some portability fixes were made (Patches from Josef Goettgens and Aaron
238 -Fixed a make dependency bug which caused a problem for parallel building
239 (Patch from Jeremy Hinegardner).
241 Ragel 5.19 - Mar 14, 2007
242 =========================
243 -Added an import statement to ragel. This statement takes a literal string as
244 an argument, interprets it as a file name, then scrapes the file for
245 sequences of tokens that match the following forms. Tokens inside ragel
246 sections are ignored. An example is in test/import1.rl
250 "define" name lit_string
251 -Added an export mechanism which writes defines for single character machines
252 that have been tagged with the export keyword in their definition. Defines
253 are used for C, ints for D, Java and Ruby. Examples of the export feature
254 are in test/export*.rl.
255 -All machine instantiations are now always generated, even if they are not
256 referenced. In the backend, entry points for all instantiations are written
257 out alongside start, error and first final states.
258 -If the main machine is not present then do not emit an error. Generate the
259 machine without a start state and do not initialize cs in the write init
261 -Added an option -l to rlgen-cd which inhibits the writing of #line
263 -Added a new syntax for verbose embeddings. This adds parentheses:
265 Verbose embeddings without parentheses can make code difficult to read
266 because they force a space in the middle of an action embedding. There is a
267 tendency to associtate spaces with concatenation. Without syntax
268 highlighting to make it clear that the embedding type is a keyword, the
269 problem is especially bad. The danger is that a verbose embedding could be
270 read as an embedding of the keyword representing the empbedding type. With
271 parentheses, verbose embeddings read much more clearly.
272 -Conditions now have a forced order when more than one is executed on a
273 single character. Previously ordering relied on pointers, which caused
274 results to vary by compiler. Ordering is now done using conditon action
275 declaration order. This fixes the failure of cond4.rl which occured with
276 g++ 4.1 and other compiler versions.
277 -In the port from flex to ragel, the name separator :: in Ragel code was
279 -In the examples directory switched from rlcodegen to rlgen-cd. Silenced a
280 warning in statechart.rl.
281 -In the root makefile the distclean target was fixed. It was calling clean in
282 the subdirs. In docs, the clean target was not deleting the new manpages for
283 the rlgen-* programs. Fixed.
284 -Portability and other fixes from Josef Goettgens were applied.
285 -The @datadir@ and @mandir@ variables are made use of in doc/Makefile.in for
286 specifying where documentation should be installed. Patch from Marcus
289 Ragel 5.18 - Feb 13, 2007
290 =========================
291 -There is now a 100% correspondence between state id numbers in the
292 intermediate XML file, Graphviz dot files and generated code. This was
293 achieved by moving code which determines if the error state is necessary
294 into the frontend, and then assigning state numbers before writing out the
296 -Backened class structure was reorganized to make it easier to add new code
297 generators without having to also modify the existing code generators.
298 -The C and D code generation executable was changed to rlgen-cd.
299 -The Java code generation was split out into it's own exectuable (rlgen-java)
300 to allow it to freely diverge from the C/D-based code generation.
301 -The graphviz dot file generation was also split out to it's own executable
303 -The Ruby code generation patch from Victor Hugo Borja was added. This is
304 highly experimental code and is not yet completely functional. It is in the
305 executable rlgen-ruby.
306 -The problem with large state machine machines in Java was fixed. This
307 problem was discovered by Colin Fleming, who also contributed a patch.
308 Rather than specify arrays as comma-separated lists of literals, array
309 initialization is now done in a static function. This is the approach used
310 by the Java compiler. Unlike the compiler Ragel is careful split large
311 initilization functions.
312 -The manual was expanded and reorganized somewhat.
313 -Eliminated per-example directories in examples/.
314 -Made some fixes to the pullscan.rl example.
315 -In the frontend CR characters are now treated as whitespace.
316 -Updated to the latest aapl. This completely eliminates the shallowCopy
317 function. With that, a definitive memory leak is fixed.
318 -Control codes with escape sequences are now printable characters (-p
319 option). Also, the space character is now printed as SP.
320 -Fixed the null dereference and consequential segfault which occurred when
321 trying to create empty machines with [] and // and /a[]b/.
322 -Fixed the segfault which occured when a machine reference failed.
323 -Discontinuing ragel.spec. It is more appropriate for this to be written by
324 package maintenance developers.
326 Ragel 5.17 - Jan 28, 2007
327 =========================
328 -The scanners and parsers in both the frontend and backend programs were
329 completely rewritten using Ragel and Kelbt.
330 -The '%when condition' syntax was functioning like '$when condition'. This
332 -In the Vim syntax file fixes to the matching of embedding operators were
333 made. Also, improvements to the sync patterns were made.
334 -Added pullscan.rl to the examples directory. It is an example of doing
335 pull-based scanning. Also, xmlscan.rl in rlcodegen is a pull scanner.
336 -The introduction chapter of the manual was improved. The manually-drawn
337 figures for the examples were replaced with graphviz-drawn figures.
339 Ragel 5.16 - Nov 20, 2006
340 =========================
341 -Policy change: the fhold and fexec directives did not function correctly in
342 scanner pattern actions. In this context manipulations of p may be lost or
343 made invalid. In the previous version of Ragel they were banned because of
344 this. Instead of banning these directives they have been fixed. The fexec
345 and fhold directives now manipulate tokend, which is now always used to
346 update p when the action terminates.
348 Ragel 5.15 - Oct 31, 2006
349 =========================
350 -A language independent test harness was introduced. Test cases can be
351 written using a custom mini-language in the embedded actions. This
352 mini-language is then translated to C, D and Java when generating the
353 language-specific test cases.
354 -Several existing tests have been ported to the language-independent format
355 and a number of new language-independent test cases have been added.
356 -The state-based embedding operators which access states that are not the
357 start state and are not final (the 'middle' states) have changed. They
359 <@/ eof action into middle states
360 <@! error action into middle states
361 <@^ local error action into middle states
362 <@~ to-state action into middle states
363 <@* from-state action into middle states
365 <>/ eof action into middle states
366 <>! error action into middle states
367 <>^ local error action into middle states
368 <>~ to-state action into middle states
369 <>* from-state action into middle states
370 -The verbose form of embeddings using the <- operator have been removed.
371 This syntax was difficult to remember.
372 -A new verbose form of state-based embedding operators have been added.
373 These are like the symbol versions, except they replace the symbols:
375 with literal keywords:
377 -The following words have been promoted to keywords:
378 when eof err lerr to from
379 -The write statment now gets its own lexical scope in the scanner to ensure
380 that commands are passed through as is (not affected by keywords).
381 -Bug fix: in the code generation of fret in scanner actions the adjustment to
382 p that is needed in some cases (dependent on content of patterns) was not
384 -The fhold directive, which decrements p, cannot be permitted in the pattern
385 action of a scanner item because it will not behave consistently. At the end
386 of a pattern action p could be decremented, set to a new value or left
387 alone. This depends on the contents of the scanner's patterns. The user
388 cannot be expected to predict what will happen to p.
389 -Conditions in D code require a cast to the widec type when computing widec.
390 -Like Java, D code also needs if (true) branches for control flow in actions
391 in order to fool the unreachable code detector. This is now abstracted in
392 all code generators using the CTRL_FLOW() function.
393 -The NULL_ITEM value in java code should be -1. This is needed for
394 maintaining tokstart.
396 Ragel 5.14 - Oct 1, 2006
397 ========================
398 -Fixed the check for use of fcall in actions embedded within longest match
399 items. It was emitting an error if an item's longest-match action had an
400 fcall, which is allowed. This bug was introduced while fixing a segfault in
402 -A new minimization option was added: MinimizeMostOps (-l). This option
403 minimizes at every operation except on chains of expressions and chains of
404 terms (eg, union and concat). On these chains it minimizes only at the last
405 operation. This makes test cases with many states compile faster, without
406 killing the performance on grammars like strings2.rl.
407 -The -l minimiziation option was made the default.
408 -Fixes to Java code: Use of the fc value did not work, now fixed. Static data
409 is now declared with the final keyword. Patch from Colin Fleming. Conditions
410 now work when generating Java code.
411 -The option -p was added to rlcodegen which causes printable characters to be
412 printed in GraphViz output. Patch from Colin Fleming.
413 -The "element" keyword no longer exists, removed from vim syntax file.
414 Updated keyword highlighting.
415 -The host language selection is now made in the frontend.
416 -Native host language types are now used when specifying the alphtype.
417 Previously all languages used the set defined by C, and these were mapped to
418 the appropriate type in the backend.
420 Ragel 5.13 - Sep 7, 2006
421 ========================
422 -Fixed a careless error which broke Java code generation.
424 Ragel 5.12 - Sep 7, 2006
425 ========================
426 -The -o flag did not work in combination with -V. This was fixed.
427 -The split code generation format uses only the required number of digits
428 when writing out the number in the file name of each part.
429 -The -T0, -F0 and -G0 codegens should write out the action list iteration
430 variables only when there are regular, to state or from state actions. The
431 code gens should not use anyActions().
432 -If two states have the same EOF actions, they are written out in the finish
434 -The split and in-place goto formats would sometimes generate _out when it is
435 not needed. This was fixed.
436 -Improved the basic partitioning in the split code gen. The last partition
437 would sometimes be empty. This was fixed.
438 -Use of 'fcall *' was not causing top to be initialized. Fixed.
439 -Implemented a Java backend, specified with -J. Only the table-based format
441 -Implemented range compression in the frontend. This has no effect on the
442 generated code, however it reduces the work of the backend and any programs
443 that read the intermediate format.
445 Ragel 5.11 - Aug 10, 2006
446 =========================
447 -Added a variable to the configure.in script which allows the building of
448 the parsers to be turned off (BUILD_PARSERS). Parser building is off by
449 default for released versions.
450 -Removed configure tests for bison defines header file. Use --defines=file
452 -Configure script doesn't test for bison, flex and gperf when building of the
453 parsers is turned off.
454 -Removed check for YYLTYPE structure from configure script. Since shipped
455 code will not build parsers by default, we don't need to be as accomodating
456 of other versions of bison.
457 -Added a missing include that showed up with g++ 2.95.3.
458 -Failed configure test for Objective-C compiler is now silent.
460 Ragel 5.10 - Jul 31, 2006
461 =========================
462 -Moved the check for error state higher in the table-based processing loop.
463 -Replaced naive implementations of condition searching with proper ones. In
464 the table-based formats the searching is also table-based. In the directly
465 executed formats the searching is also directly executable.
466 -The minimization process was made aware of conditions.
467 -A problem with the condition implementation was fixed. Previously we were
468 taking pointers to transitions and then using them after a call to
469 outTransCopy, which was a bad idea because they may be changed by the call.
470 -Added test mailbox3.rl which is based on mailbox2.rl but includes conditions
471 for restricting header and message body lengths.
472 -Eliminated the initial one-character backup of p just before resuming
474 -Added the -s option to the frontend for printing statistics. This currently
475 includes just the number of states.
476 -Sped up the generation of the in-place goto-driven (-G2) code style.
477 -Implemented a split version of in-place goto-driven code style. This code
478 generation style is suitable for producing fast implementations of very
479 large machines. Partitioning is currently naive. In the future a
480 high-quality partitioning program will be employed. The flag for accessing
481 this feature is -Pn, where n is the number of partitions.
482 -Converted mailbox1.rl, strings2.rl and cppscan1.rl tests to support the
483 split code generation.
484 -Fixes and updates were made to the runtests script: added -c for compiling
485 only, changed the -me option to -e, and added support for testing the split
488 Ragel 5.9 - Jul 19, 2006
489 ========================
490 -Fixed a bug in the include system which caused malformed output from the
491 frontend when the include was made from a multi-line machine spec and the
492 included file ended in a single line spec (or vice versa).
493 -Static data is now const.
494 -Actions which referenced states but were not embedded caused the frontend to
496 -Manual now built with pdflatex.
497 -The manual was reorganized and expanded. Chapter sequence is now:
498 Introduction, Constructing Machines, Embedding Actions, Controlling
499 Nondeterminism and Interfacing to the Host program.
501 Ragel 5.8 - Jun 17, 2006
502 ========================
503 -The internal representation of the alphabet type has been encapsulated
504 into a class and all operations on it have been defined as C++ operators.
505 -The condition implementation now supports range transitions. This allows
506 conditions to be embedded into arbitrary machines. Conditions are still
508 -More condition embedding operators were added
509 1. Isolate the start state and embed a condition into all transitions
512 2. Embed a condition into all transitions:
513 when cond OR $when cond OR $?cond
514 3. Embed a condition into pending out transitions:
516 -Improvements were made to the determinization process to support pending out
518 -The Vim sytax file was fixed so that :> doesn't cause the match of a label.
519 -The test suite was converted to a single-file format which uses less disk
520 space than the old directory-per-test format.
522 Ragel 5.7 - May 14, 2006
523 ========================
524 -Conditions will not be embedded like actions because they involve a
525 manipulation of the state machine they are specified in. They have therefore
526 been taken out of the verbose action embedding form (using the <- compound
527 symbol). A new syntax for specifying conditions has been created:
528 m = '\n' when {i==4};
529 -Fixed a bug which prevented state machine commands like fcurs, fcall, fret,
530 etc, from being accounted for in from-state actions and to-state actions.
531 This prevented some necessary support code from being generated.
532 -Implemented condition testing in remaining code generators.
533 -Configure script now checks for gperf, which is required for building.
534 -Added support for case-insensitive literal strings (in addition to regexes).
535 A case-insensitive string is made by appending an 'i' to the literal, as in
537 -Fixed a bug which caused all or expressions inside of all regular
538 expressions to be case-insensitive. For example /[fo]o bar/ would make the
539 [fo] part case-insensitive even though no 'i' was given following the
542 Ragel 5.6 - Apr 1, 2006
543 =======================
544 -Added a left-guarded concatenation operator. This operator <: is equivalent
545 to ( expr1 $1 . expr2 >0 ). It is useful if you want to prefix a sequence
546 with a sequence of a subset of the characters it matches. For example, one
547 can consume leading whitespace before tokenizing a sequence of whitespace
548 separated words: ( ' '* <: ( ' '+ | [a-z]+ )** )
549 -Removed context embedding code, which has been dead since 5.0.
551 Ragel 5.5 - Mar 28, 2006
552 ========================
553 -Implemented a case-insensitive option for regular expressions: /get/i.
554 -If no input file is given to the ragel program it reads from standard input.
555 -The label of the start state has been changed from START to IN to save on
556 required screen space.
557 -Bug fix: \0 was not working in literal strings, due to a change that reduced
558 memory usage by concatenating components of literal strings. Token data
559 length is now passed from the scanner to the paser so that we do not need to
560 rely on null termination.
562 Ragel 5.4 - Mar 12, 2006
563 ========================
564 -Eliminated the default transition from the frontend implementation. This
565 default transition was a space-saving optimization that at best could reduce
566 the number of allocated transitions by one half. Unfortunately it
567 complicated the implementation and this stood in the way of introducing
568 conditionals. The default transition may be reintroduced in the future.
569 -Added entry-guarded concatenation. This operator :>, is syntactic sugar
570 for expr1 $0 . expr >1. This operator terminates the matching of the first
571 machine when a first character of the second machine is matched. For
572 example in any* . ';' we never leave the any* machine. If we use any* :> ';'
573 then the any* machine is terminiated upon matching the semi-colon.
574 -Added finish-guarded concatenation. This operator :>>, is syntactic sugar
575 for expr1 $0 . expr @1. This operator is like entry guarded concatenation
576 except the first machine is terminated when the second machine enters a
577 final state. This is useful for delaying the guard until a full pattern is
578 matched. For example as in '/*' any* :>> '*/'.
579 -Added strong subtraction. Where regular subtraction removes from the first
580 machine any strings that are matched by the second machine, strong
581 subtraction removes any strings from the first that contain any strings of
582 the second as a substring. Strong subtraction is syntactic sugar for
583 expr1 - ( any* expr2 any* ).
584 -Eliminated the use of priorities from the examples. Replaced with
585 subtraction, guarded concatenation and longest-match kleene star.
586 -Did some initial work on supporting conditional transitions. Far from
587 complete and very buggy. This code will only be active when conditionals are
590 Ragel 5.3 - Jan 27, 2006
591 ========================
592 -Added missing semi-colons that cause the build to fail when using older
594 -Fix for D code: if the contents of an fexec is a single word, the generated
595 code will get interpreted as a C-style cast. Adding two brackets prevents
596 this. Can now turn eliminate the "access this.;" in cppscan5 that was used to
597 get around this problem.
598 -Improved some of the tag names in the intermediate format.
599 -Added unsigned long to the list of supported alphabet types.
600 -Added ids of actions and action lists to XML intermediate format. Makes it
602 -Updated to latest Aapl package.
604 Ragel 5.2 - Jan 6, 2006
605 ========================
606 -Ragel emits an error if the target of fentry, fcall, fgoto or fnext is inside
607 a longest match operator, or if an action embedding in a longest match
608 machine uses fcall. The fcall command can still be used in pattern actions.
609 -Made improvements to the clang, rlscan, awkemu and cppscan examples.
610 -Some fixes to generated label names: they should all be prefixed with _.
611 -A fix to the Vim syntax highlighting script was made
612 -Many fixes and updates to the documentation. All important features and
613 concepts are now documented. A second chapter describing Ragel's use
616 Ragel 5.1 - Dec 22, 2005
617 ========================
618 -Fixes to the matching of section delimiters in Vim syntax file.
619 -If there is a longest match machine, the tokend var is now initialized by
620 write init. This is not necessary for correct functionality, however
621 prevents compiler warnings.
622 -The rlscan example was ported to the longest match operator and changed to
624 -Fix to the error handling in the frontend: if there are errors in the lookup
625 of names at machine generation time then do not emit anything.
626 -If not compiling the full machine in the frontend (by using -M), avoid
627 errors and segfaults caused by names that are not part of the compiled
629 -Longest match bug fix: need to init tokstart when returing from fsm calls
630 that are inside longest match actions.
631 -In Graphviz drawing, the arrow into the start state is not a real
632 transition, do not draw to-state actions on the label.
633 -A bug fix to the handling of non-tag data within an XML tag was made.
634 -Backend exit value fixed: since the parser now accepts nothing so as to
635 avoid a redundant parse error when the frontend dies, we must force an
636 error. The backend should now be properly reporting errors.
637 -The longest match machine now has it's start state set final. An LM machine
638 is in a final state when it has not matched anything, when it has matched
639 and accepted a token and is ready for another, and when it has matched a
640 token but is waiting for some lookahead before determining what to do about
641 it (similar to kleene star).
642 -Element statement removed from some tests.
643 -Entry point names are propagated to the backend and used to label the entry
644 point arrows in Graphviz output.
646 Ragel 5.0 - Dec 17, 2005
647 ========================
648 (additional details in V5 release notes)
649 -Ragel has been split into two executables: A frontend which compiles
650 machines and emits them in an XML format, and a backend which generates code
651 or a Graphviz dot file from the XML input. The purpose of this split is to
652 allow Ragel to interface with other tools by means of the XML intermediate
653 format and to reduce complexity by strictly separating the previously
654 entangled phases. The intermediate format will provide a better platform
655 inspecting compiled machines and for extending Ragel to support other host
657 -The host language interface has been reduced significantly. Ragel no longer
658 expects the machine to be implemented as a structure or class and does not
659 generate functions corresponding to initialization, execution and EOF.
660 Instead, Ragel just generates the code of these components, allowing all of
661 them to be placed in a single function if desired. The user specifies a
662 machine in the usual manner, then indicates at which place in the program
663 text the state machine code is to be generated. This is done using the write
664 statement. It is possible to specify to Ragel how it should access the
665 variables it needs (such as the current state) using the access statement.
666 -The host language embedding delimiters have been changed. Single line
667 machines start with '%%' and end at newline. Multiline machines start with
668 '%%{' and end with '}%%'. The machine name is given with the machine
669 statement at the very beginning of the specification. This purpose of this
670 change is to make it easier separate Ragel code from the host language. This
671 will ease the addition of supported host languages.
672 -The structure and class parsing which was previously able to extract a
673 machine's name has been removed since this feature is dependent on the host
674 language and inhibits the move towards a more language-independent frontend.
675 -The init, element and interface statements have been made obsolete by the
676 new host language interface and have been removed.
677 -The fexec action statement has been changed to take only the new position to
678 move to. This statement is more useful for moving backwards and reparsing
679 input than for specifying a whole new buffer entirely and has been shifted
680 to this new use. Giving it only one argument also simplifies the parsing of
681 host code embedded in a Ragel specification. This will ease the addition of
682 supported host languages.
683 -Introduced the fbreak statement, which allows one to stop processing data
684 immediately. The machine ends up in the state that the current transition
685 was to go to. The current character is not changed.
686 -Introduced the noend option for writing the execute code. This inhibits
687 checking if we have reached pe. The machine will run until it goes into the
688 error state or fbreak is hit. This allows one to parse null-terminate
689 strings without first computing the length.
690 -The execute code now breaks out of the processing loop when it moves into
691 the error state. Previously it would run until pe was hit. Breaking out
692 makes the noend option useful when an error is encountered and allows
693 user code to determine where in the input the error occured. It also
694 eliminates needlessly iterating the input buffer.
695 -Introduced the noerror, nofinal and noprefix options for writing the machine
696 data. The first two inhibit the writing of the error state and the
697 first-final state should they not be needed. The noprefix eliminates the
698 prefixing of the data items with the machine name.
699 -Support for the D language has been added. This is specified in the backend
701 -Since the new host language interface has been reduced considerably, Ragel
702 no longer needs to distinguish between C-based languages. Support for C, C++
703 and Objective-C has been folded into one option in the backend: -C
704 -The code generator has been made independent of the languages that it
705 supports by pushing the language dependent apsects down into the lower
706 levels of the code generator.
707 -Many improvements to the longest match construction were made. It is no
708 longer considered experimental. A longest match machine must appear at the
709 top level of a machine instantiation. Since it does not generate a pure
710 state machine (it may need to backtrack), it cannot be used as an operand to
712 -References to the current character and current state are now completely
713 banned in EOF actions.
715 Ragel 4.2 - Sep 16, 2005
716 ========================
717 (additional details in V4 release notes)
718 -Fixed a bug in the longest match operator. In some states it's possible that
719 we either match a token or match nothing at all. In these states we need to
720 consult the LmSwitch on error so it must be prepared to execute an error
721 handler. We therefore need to init act to this error value (which is zero).
722 We can compute if we need to do this and the code generator emits the
723 initialization only if necessary.
724 -Changed the definition of the token end of longest match actions. It now
725 points to one past the last token. This makes computing the token length
726 easier because you don't have to add one. The longest match variables token
727 start, action identifier and token end are now properly initialized in
728 generated code. They don't need to be initialized in the user's code.
729 -Implemented to-state and from-state actions. These actions are executed on
730 transitions into the state (after the in transition's actions) and on
731 transitions out of the state (before the out transition's actions). See V4
732 release notes for more information.
733 -Since there are no longer any action embedding operators that embed both on
734 transitions and on EOF, any actions that exist in both places will be there
735 because the user has explicitly done so. Presuming this case is rare, and
736 with code duplication in the hands of the user, we therefore give the EOF
737 actions their own action switch in the finish() function. This is further
738 motivated by the fact that the best solution is to do the same for to-state
739 and from-state actions in the main loop.
740 -Longest match actions can now be specified using a named action. Since a
741 word following a longest match item conflicts with the concatenation of a
742 named machine, the => symbol must come immediately before a named action.
743 -The longest match operator permits action and machine definitions in the
744 middle of a longest match construction. These are parsed as if they came
745 before the machine definition they are contained in. Permitting action and
746 machine definitions in a longest match construction allows objects to be
747 defined closer to their use.
748 -The longest match operator can now handle longest match items with no
749 action, where previously Ragel segfaulted.
750 -Updated to Aapl post 2.12.
751 -Fixed a bug in epsilon transition name lookups. After doing a name lookup
752 the result was stored in the parse tree. This is wrong because if a machine
753 is used more than once, each time it may resolve to different targets,
754 however it will be stored in the same place. We now store name resolutions
755 in a separated data structure so that each walk of a parse tree uses the
756 name resolved during the corresponding walk in the name lookup pass.
757 -The operators used to embed context and actions into states have been
758 modified. The V4 release notes contain the full details.
759 -Added zlen builtin machine to represent the zero length machine. Eventually
760 the name "null" will be phased out in favour of zlen because it is unclear
761 whether null matches the zero length string or if it does not match any
762 string at all (as does the empty builtin).
763 -Added verbose versions of action, context and priority embedding. See the V4
764 release notes for the full details. A small example:
765 machine <- all exec { foo(); } <- final eof act1
766 -Bugfix for machines with epsilon ops, but no join operations. I had
767 wrongfully assumed that because epsilon ops can only increase connectivity,
768 that no states are ever merged and therefore a call to fillInStates() is not
769 necessary. In reality, epsilon transitions within one machine can induce the
770 merging of states. In the following, state 2 follows two paths on 'i':
771 main := 'h' -> i 'i h' i: 'i';
772 -Changed the license of the guide from a custom "do not propagate modified
773 versions of this document" license to the GPL.
775 Ragel 4.1 - Jun 26, 2005
776 ========================
777 (additional details in V4 release notes)
778 -A bug in include processing was fixed. Surrounding code in an include file
779 was being passed through to the output when it should be ignored. Includes
780 are only for including portions of another machine into he current. This
781 went unnoticed because all tested includes were wrapped in #ifndef ...
782 #endif directives and so did not affect the compilation of the file making
784 -Fixes were made to Vim syntax highlighting file.
785 -Duplicate actions are now removed from action lists.
786 -The character-level negation operator ^ was added. This operator produces a
787 machine that matches single characters that are not matched by the machine
788 it is applied to. This unary prefix operator has the same precedence level
790 -The use of + to specify the a positive literal number was discontinued.
791 -The parser now assigns the subtraction operator a higher precedence than
792 the negation of literal number.
794 Ragel 4.0 - May 26, 2005
795 ========================
796 (additional details in V4 release notes)
797 -Operators now strictly embed into a machine either on a specific class of
798 characters or on EOF, but never both. This gives a cleaner association
799 between the operators and the physical state machine entitites they operate
800 on. This change is made up of several parts:
801 1. '%' operator embeds only into leaving characters.
802 2. All global and local error operators only embed on error character
803 transitions, their action will not be triggerend on EOF in non-final
805 3. EOF action embedding operators have been added for all classes of states
806 to make up for functionality removed from other operators. These are
808 4. Start transition operator '>' no longer implicitly embeds into leaving
809 transtions when start state is final.
810 -Ragel now emits warnings about the improper use of statements and values in
811 action code that is embedded as an EOF action. Warnings are emitted for fpc,
812 fc, fexec, fbuf and fblen.
813 -Added a longest match construction operator |* machine opt-action; ... *|.
814 This is for repetition where an ability to revert to a shorter, previously
815 matched item is required. This is the same behaviour as flex and re2c. The
816 longest match operator is not a pure FSM construction, it introduces
817 transitions that implicitly hold the current character or reset execution to
818 a previous location in the input. Use of this operator requires the caller
819 of the machine to occasionally hold onto data after a call to the exectute
820 routine. Use of machines generated with this operator as the input to other
821 operators may have undefined results. See examples/cppscan for an example.
822 This is very experimental code.
823 -Action ids are only assigned to actions that are referenced in the final
824 constructed machine, preventing gaps in the action id sequence. Previously
825 an action id was assigned if the action was referenced during parsing.
826 -Machine specifications now begin with %% and are followed with an optional
827 name and either a single Ragel statement or a sequence of statements
829 -Ragel no longer generates the FSM's structure or class. It is up to the user
830 to declare the structure and to give it a variable named curs of type
831 integer. If the machine uses the call stack the user must also declare a
832 array of integers named stack and an integer variable named top.
833 -In the case of Objective-C, Ragel no longer generates the interface or
834 implementation directives, allowing the user to declare additional methods.
835 -If a machine specification does not have a name then Ragel tries to find a
836 name for it by first checking if the specification is inside a struct, class
837 or interface. If it is not then it uses the name of the previous machine
838 specification. If still no name is found then this is an error.
839 -Fsm specifications now persist in memory and statements accumulate.
840 -Ragel now has an include statement for including the statements of a machine
841 spec in another file (perhaps because it is the corresponding header file).
842 The include statement can also be used to draw in the statements of another
843 fsm spec in the current file.
844 -The fstack statement is now obsolete and has been removed.
845 -A new statement, simply 'interface;', indicates that ragel should generate
846 the machine's interface. If Ragel sees the main machine it generates the
847 code sections of the machine. Previously, the header portion was generated
848 if the (now removed) struct statement was found and code was generated if
849 any machine definition was found.
850 -Fixed a bug in the resolution of fsm name references in actions. The name
851 resolution code did not recurse into inline code items with children
852 (fgoto*, fcall*, fnext*, and fexec), causing a segfault at code generation
854 -Cleaned up the code generators. FsmCodeGen was made into a virtual base
855 class allowing for the language/output-style specific classes to inherit
856 both a language specific and style-specific base class while retaining only
857 one copy of FsmCodeGen. Language specific output can now be moved into the
858 language specific code generators, requiring less duplication of code in the
859 language/output-style specific leaf classes.
860 -Fixed bugs in fcall* implementation of IpgGoto code generation.
861 -If the element type has not been defined Ragel now uses a constant version
862 of the alphtype, not the exact alphtype. In most cases the data pointer of
863 the execute routine should be const. A non-const element type can still be
864 defined with the element statement.
865 -The fc special value now uses getkey for retrieving the current char rather
866 than *_p, which is wrong if the element type is a structure.
867 -User guide converted to TeX and updated for new 4.0 syntax and semantics.
869 Ragel 3.7 - Oct 31, 2004
870 ========================
871 -Bug fix: unreferenced machine instantiations causing segfault due to name
872 tree and parse tree walk becomming out of syncronization.
873 -Rewrote representation of inline code blocks using a tree data structure.
874 This allows special keywords such as fbuf to be used as the operatands of
876 -Documentation updates.
877 -When deciding whether or not to generate machine instantiations, search the
878 entire name tree beneath the instantiation for references, not just the
880 -Removed stray ';' in keller2.rl
881 -Added fexec for restarting the machine with new buffer data (state stays the
882 same), fbuf for retrieving the the start of the buf, and fblen for
883 retrieving the orig buffer length.
884 -Implemented test/cppscan2 using fexec. This allows token emitting and restart
885 to stay inside the execute routine, instead of leaving and re-entering on
887 -Changed examples/cppscan to use fexec and thereby go much faster.
888 -Implemented flex and re2c versions of examples/cppscan. Ragel version
889 goes faster than flex version but not as fast as re2c version.
890 -Merged in Objective-C patch from Erich Ocean.
891 -Turned off syncing with stdio in C++ tests to make them go faster.
892 -Renamed C++ code generaion classes with the Cpp Prefix instead of CC to make
894 -In the finish function emit fbuf as 0 cast to a pointer to the element type
895 so it's type is not interpreted as an integer.
896 -The number -128 underflows char alphabets on some architectures. Removed
898 -Disabled the keller2 test because it causes problems on many architectures
899 due to its large size and compilation requirements.
901 Ragel 3.6 - Jul 10, 2004
902 ========================
903 -Many documentation updates.
904 -When resolving names, return a set of values so that a reference in an
905 action block that is embedded more than once won't report distinct entry
906 points that are actually the same.
907 -Implemented flat tables. Stores a linear array of indicies into the
908 transition array and only a low and high key value. Faster than binary
909 searching for keys but not usable for large alphabets.
910 -Fixed bug in deleting of transitions leftover from converstion from bst to
911 list implementation of transitions. Other code cleanup.
912 -In table based output calculate the cost of using an index. Don't use if
914 -Changed fstate() value available in init and action code to to fentry() to
915 reflect the fact that the values returned are intended to be used as targets
916 in fgoto, fnext and fcall statements. The returned state is not a unique
917 state representing the label. There can be any number of states representing
919 -Added keller2 test, C++ scanning tests and C++ scanning example.
920 -In table based output split up transitions into targets and actions. This
921 allows actions to be omitted.
922 -Broke the components of the state array into separate arrays. Requires
923 adding some fields where they could previously be omitted, however allows
924 finer grained control over the sizes of items and an overal size reduction.
925 Also means that state numbers are not an offset into the state array but
926 instead a sequence of numbers, meaning the context array does not have any
928 -Action lists and transition also have their types chosen to be the smallest
929 possible for accomodating the contained values.
930 -Changed curs state stored in fsm struct from _cs to curs. Keep fsm->curs ==
931 -1 while in machine. Added tests curs1 and curs2.
932 -Implemented the notion of context. Context can be embedded in states using
933 >:, $:, @: and %: operators. These embed a named context into start states,
934 all states, non-start/non-final and final states. If the context is declared
935 using a context statment
937 then the context can be quered for any state using fsm_name_ctx_name(state)
938 in C code and fsm_name::ctx_name(state) in C++ code. This feature makes it
939 possible to determine what "part" of the machine is currently active.
940 -Fixed crash on machine generation of graphs with no final state. If there
941 is no reference to a final state in a join operation, don't generate one.
942 -Updated Vim sytax: added labels to inline code, added various C++ keywords.
943 Don't highlight name separations as labels. Added switch labels, improved
944 alphtype, element and getkey.
945 -Fixed line info in error reporting of bad epsilon trans.
946 -Fixed fstate() for tab code gen.
947 -Removed references to malloc.h.
949 Ragel 3.5 - May 29, 2004
950 ========================
951 -When parse errors occur, the partially generated output file is deleted and
952 an non-zero exit status is returned.
953 -Updated Vim syntax file.
954 -Implemented the setting of the element type that is passed to the execute
955 routine as well as method for specifying how ragel should retrive the key
956 from the element type. This lets ragel process arbitrary structures inside
957 of which is the key that is parsed.
958 element struct Element;
959 getkey fpc->character;
960 -The current state is now implemented with an int across all machines. This
961 simplifies working with current state variables. For example this allows a
962 call stack to be implemented in user code.
963 -Implemented a method for retrieving the current state, the target state, and
965 fcurs -retrieve the current state
966 ftargs -retrieve the target state
967 fstate(name) -retrieve a named state.
968 -Implemented a mechanism for jumping to and calling to a state stored in a
970 fgoto *<expr>; -goto the state returned by the C/C++ expression.
971 fcall *<expr>; -call the state returned by the C/C++ expression.
972 -Implemented a mechanism for specifying the next state without immediately
973 transfering control there (any code following statement is executed).
974 fnext label; -set the state pointed to by label as the next state.
975 fnext *<expr>; -set the state returned by the C/C++ expression as the
977 -Action references are determined from the final machine instead of during
978 the parse tree walk. Some actions can be referenced in the parse tree but not
979 show up in the final machine. Machine analysis is now done based on this new
981 -Named state lookup now employs a breadth-first search in the lookup and
982 allows the user to fully qualify names, making it possible to specify
983 jumps/calls into parts of the machine deep in the name hierarchy. Each part
984 of name (separated by ::) employs a breadth first search from it's starting
986 -Name references now must always refer to a single state. Since references to
987 multiple states is not normally intended, it no longer happens
988 automatically. This frees the programmer from thinking about whether or not
989 a state reference is unique. It also avoids the added complexity of
990 determining when to merge the targets of multiple references. The effect of
991 references to multiple states can be explicitly created using the join
992 operator and epsilon transitions.
993 -M option was split into -S and -M. -S specifies the machine spec to generate
994 for graphviz output and dumping. -M specifies the machine definition or
996 -Machine function parameters are now prefixed with and underscore to
997 avoid the hiding of class members.
999 Ragel 3.4 - May 8, 2004
1000 =======================
1001 -Added the longest match kleene star operator **, which is synonymous
1002 with ( ( <machine> ) $0 %1 ) *.
1003 -Epsilon operators distinguish between leaving transitions (going to an
1004 another expression in a comma separated list) and non-leaving transitions.
1005 Leaving actions and priorities are appropriately transferred.
1006 -Relative priority of following ops changed to:
1010 If label is done first then the isolation of the start state in > operators
1011 will cause the label to point to the old start state that doesn't have the
1012 new action/priority.
1013 -Merged >! and >~, @! and @~, %! and %~, and $! and $~ operators to have one
1014 set of global error action operators (>!, @!, %! and $!) that are invoked on
1015 error by unexpected characters as well as by unexepected EOF.
1016 -Added the fpc keyword for use in action code. This is a pointer to the
1017 current character. *fpc == fc. If an action is invoked on EOF then fpc == 0.
1018 -Added >^, @^, %^, and $^ local error operators. Global error operators (>!,
1019 @!, $!, and %!) cause actions to be invoked if the final machine fails.
1020 Local error actions cause actions to be invoked if if the current machine
1022 -Changed error operators to mean embed global/local error actions in:
1023 >! and !^ -the start state.
1024 @! and @^ -states that are not the start state and are not final.
1025 %! and %^ -final states.
1026 $! and $^ -all states.
1027 -Added >@! which is synonymous >! then @!
1028 -Added >@^ which is synonymous >^ then @^
1029 -Added @%! which is synonymous @! then %!
1030 -Added @%^ which is synonymous >^ then @^
1031 -FsmGraph representation of transition lists was changed from a mapping of
1032 alphabet key -> transition objects using a BST to simply a list of
1033 transition objects. Since the transitions are no longer divided by
1034 single/range, the fast finding of transition objects by key is no longer
1035 required functionality and can be eliminated. This new implementation uses
1036 the same amount of memory however causes less allocations. It also make more
1037 sense for supporting error transitions with actions. Previously an error
1038 transition was represented by a null value in the BST.
1039 -Regular expression ranges are checked to ensure that lower <= upper.
1040 -Added printf-like example.
1041 -Added atoi2, erract2, and gotcallret to the test suite.
1042 -Improved build test to support make -jN and simplified the compiling and
1045 Ragel 3.3 - Mar 7, 2004
1046 =======================
1047 -Portability bug fixes were made. Minimum and maximum integer values are
1048 now taken from the system. An alignment problem on 64bit systems
1051 Ragel 3.2 - Feb 28, 2004
1052 ========================
1053 -Added a Vim syntax file.
1054 -Eliminated length var from generated execute code in favour of an end
1055 pointer. Using length requires two variables be read and written. Using an
1056 end pointer requires one variable read and written and one read. Results in
1057 more optimizable code.
1058 -Minimization is now on by default.
1059 -States are ordered in output by depth first search.
1060 -Bug in minimization fixed. States were not being distinguished based on
1062 -Added null and empty builtin machines.
1063 -Added EOF error action operators. These are >~, >@, $~, and %~. EOF error
1064 operators embed actions to take if the EOF is seen and interpreted as an
1065 error. The operators correspond to the following states:
1067 -any state with a transition to a final state
1068 -any state with a transiion out
1070 -Fixed bug in generation of unreference machine vars using -M. Unreferenced
1071 vars don't have a name tree built underneath when starting from
1072 instantiations. Need to instead build the name tree starting at the var.
1073 -Calls, returns, holds and references to fc in out action code are now
1074 handled for ipgoto output.
1075 -Only actions referenced by an instantiated machine expression are put into
1076 the action index and written out.
1077 -Added rlscan, an example that lexes Ragel input.
1079 Ragel 3.1 - Feb 18, 2004
1080 ========================
1081 -Duplicates in OR literals are removed and no longer cause an assertion
1083 -Duplicate entry points used in goto and call statements are made into
1084 deterministic entry points.
1085 -Base FsmGraph code moved from aapl into ragel, as an increasing amount
1086 of specialization is required. Too much time was spent attempting to
1087 keep it as a general purpose template.
1088 -FsmGraph code de-templatized and heirarchy squashed to a single class.
1089 -Single transitions taken out of FsmGraph code. In the machine construction
1090 stage, transitions are now implemented only with ranges and default
1091 transtions. This reduces memory consumption, simplifies code and prevents
1092 covered transitions. However it requires the automated selection of single
1093 transitions to keep goto-driven code lean.
1094 -Machine reduction completely rewritten to be in-place. As duplicate
1095 transitions and actions are found and the machine is converted to a format
1096 suitable for writing as C code or as GraphViz input, the memory allocated
1097 for states and transitions is reused, instead of newly allocated.
1098 -New reduction code consolodates ranges, selects a default transition, and
1099 selects single transitions with the goal of joining ranges that are split by
1100 any number of single characters.
1101 -Line directive changed from "# <num> <file>" to the more common format
1102 "#line <num> <file>".
1103 -Operator :! changed to @!. This should have happened in last release.
1104 -Added params example.
1106 Ragel 3.0 - Jan 22, 2004
1107 ========================
1108 -Ragel now parses the contents of struct statements and action code.
1109 -The keyword fc replaces the use of *p to reference the current character in
1111 -Machine instantiations other than main are allowed.
1112 -Call, jump and return statements are now available in action code. This
1113 facility makes it possible to jump to an error handling machine, call a
1114 sub-machine for parsing a field or to follow paths through a machine as
1115 determined by arbitrary C code.
1116 -Added labels to the language. Labels can be used anywhere in a machine
1117 expression to define an entry point. Also references to machine definitions
1118 cause the implicit creation of a label.
1119 -Added epsilon transitions to the language. Epsilon operators may reference
1120 labels in the current name scope resolved when join operators are evaluated
1121 and at the root of the expression tree of machine assignment/instantiation.
1122 -Added the comma operator, which joins machines together without drawing any
1123 transitions between them. This operator is useful in combination with
1124 labels, the epsilon operator and user code transitions for defining machines
1125 using the named state and transition list paradigm. It is also useful for
1126 invoking transitions based on some analysis of the input or on the
1128 -Added >!, :!, $!, %! operators for specifying actions to take should the
1129 machine fail. These operators embed actions to execute if the machine
1132 -any state with a transition to a final state
1133 -any state with a transiion out
1135 The general rule is that if an action embedding operator embeds an action
1136 into a set of transitions T, then the error-counterpart with a ! embeds an
1137 action into the error transition taken when any transition T is a candidate,
1138 but does not match the input.
1139 -The finishing augmentation operator ':' has been changed to '@'. This
1140 frees the ':' symbol for machine labels and avoids hacks to the parser to
1141 allow the use of ':' for both labels and finishing augmentations. The best
1142 hack required that label names be distinct from machine definition names as
1143 in main := word : word; This restriction is not good because labels are
1144 local to the machine that they are used in whereas machine names are global
1145 entities. Label name choices should not be restricted by the set of names
1146 that are in use for machines.
1147 -Named priority syntax now requires parenthesis surrounding the name and
1148 value pair. This avoids grammar ambiguities now that the ',' operator has
1149 been introduced and makes it more clear that the name and value are an
1151 -Backslashes are escaped in line directive paths.
1153 Ragel 2.2 - Oct 6, 2003
1154 =======================
1155 -Added {n}, {,n}, {n,} {n,m} repetition operators.
1156 <expr> {n} -- exactly n repetitions
1157 <expr> {,n} -- zero to n repetitions
1158 <expr> {n,} -- n or more repetitions
1159 <expr> {n,m} -- n to m repetitions
1160 -Bug in binary search table in Aapl fixed. Fixes crashing on machines that
1161 add to action tables that are implicitly shared among transitions.
1162 -Tests using obsolete minimization algorithms are no longer built and run by
1164 -Added atoi and concurrent from examples to the test suite.
1166 Ragel 2.1 - Sep 22, 2003
1167 ========================
1168 -Bug in priority comparison code fixed. Segfaulted on some input with many
1169 embedded priorities.
1170 -Added two new examples.
1172 Ragel 2.0 - Sep 7, 2003
1173 =======================
1174 -Optional (?), One or More (+) and Kleene Star (*) operators changed from
1175 prefix to postfix. Rationale is that postfix version is far more common in
1176 regular expression implementations and will be more readily understood.
1177 -All priority values attached to transitions are now accompanied by a name.
1178 Transitions no longer have default priority values of zero assigned
1179 to them. Only transitions that have different priority values assigned
1180 to the same name influence the NFA-DFA conversion. This scheme reduces
1181 side-effects of priorities.
1182 -Removed the %! statement for unsetting pending out priorities. With
1183 named priorities, it is not necessary to clear the priorities of a
1184 machine with $0 %! because non-colliding names can be used to avoid
1186 -Removed the clear keyword, which was for removing actions from a machine.
1187 Not required functionality and it is non-intuitive to have a language
1188 feature that undoes previous definitions.
1189 -Removed the ^ modifier to repetition and concatenation operators. This
1190 undocumented feature prevented out transitions and out priorities from being
1191 transfered from final states to transitions leaving machines. Not required
1192 functionality and complicates the language unnecessarily.
1193 -Keyword 'func' changed to 'action' as a part of the phasing out of the term
1194 'function' in favour of 'action'. Rationale is that the term 'function'
1195 implies that the code is called like a C function, which is not necessarily
1196 the case. The term 'action' is far more common in state machine compiler
1198 -Added the instantiation statement, which looks like a standard variable
1199 assignment except := is used instead of =. Instantiations go into the
1200 same graph dictionary as definitions. In the the future, instantiations
1201 will be used as the target for gotos and calls in action code.
1202 -The main graph should now be explicitly instantiated. If it is not,
1203 a warning is issued.
1204 -Or literal basic machines ([] outside of regular expressions) now support
1205 negation and ranges.
1206 -C and C++ interfaces lowercased. In the C interface an underscore now
1207 separates the fsm machine and the function name. Rationale is that lowercased
1208 library and generated routines are more common.
1210 int fsm_init( struct clang *fsm );
1211 int fsm_execute( struct clang *fsm, char *data, int dlen );
1212 int fsm_finish( struct clang *fsm );
1215 int fsm::execute( char *data, int dlen );
1217 -Init, execute and finish all return -1 if the machine is in the error state
1218 and can never accept, 0 if the machine is in a non-accepting state that has a
1219 path to a final state and 1 if the machine is in an accepting state.
1220 -Accept routine eliminated. Determining whether or not the machine accepts is
1221 done by examining the return value of the finish routine.
1222 -In C output, fsm structure is no longer a typedef, so referencing requires
1223 the struct keyword. This is to stay in line with C language conventions.
1224 -In C++ output, constructor is no longer written by ragel. As a consequence,
1225 init routine is not called automatically. Allows constructor to be supplied
1226 by user as well as the return value of init to be examined without calling it
1228 -Static start state and private structures are taken out of C++ classes.
1230 Ragel 1.5.4 - Jul 14, 2003
1231 ==========================
1232 -Workaround for building with bison 1.875, which produces an
1233 optimization that doesn't build with newer version gcc.
1235 Ragel 1.5.3 - Jul 10, 2003
1236 ==========================
1237 -Fixed building with versions of flex that recognize YY_NO_UNPUT.
1238 -Fixed version numbers in ragel.spec file.
1240 Ragel 1.5.2 - Jul 7, 2003
1241 =========================
1242 -Transition actions and out actions displayed in the graphviz output.
1243 -Transitions on negative numbers handled in graphviz output.
1244 -Warning generated when using bison 1.875 now squashed.
1246 Ragel 1.5.1 - Jun 21, 2003
1247 ==========================
1248 -Bugs fixed: Don't delete the output objects when writing to standard out.
1249 Copy mem into parser buffer with memcpy, not strcpy. Fixes buffer mem errror.
1250 -Fixes for compiling with Sun WorkShop 6 compilers.
1252 Ragel 1.5.0 - Jun 10, 2003
1253 ==========================
1254 -Line directives written to the output so that errors in the action code
1255 are properly reported in the ragel input file.
1256 -Simple graphviz dot file output format is supported. Shows states and
1257 transitions. Does not yet show actions.
1258 -Options -p and -f dropped in favour of -d output format.
1259 -Added option -M for specifying the machine to dump with -d or the graph to
1261 -Error recovery implemented.
1262 -Proper line and column number tracking implemented in the scanner.
1263 -All action/function code is now embedded in the main Execute routine. Avoids
1264 duplication of action code in the Finish routine and the need to call
1265 ExecFuncs which resulted in huge code bloat. Will also allow actions to
1266 modify cs when fsm goto, call and return is supported in action code.
1267 -Fsm spec can have no statements, nothing will be generated.
1268 -Bug fix: Don't accept ] as the opening of a .-. range a reg exp.
1269 -Regular expression or set ranges (ie /[0-9]/) are now handled by the parser
1270 and consequently must be well-formed. The following now generates a parser
1271 error: /[+-]/ and must be rewritten as /[+\-]/. Also fixes a bug whereby ]
1272 might be accepted as the opening of a .-. range causing /[0-9]-[0-9]/ to
1274 -\v, \f, and \r are now treated as whitespace in an fsm spec.
1276 Ragel 1.4.1 - Nov 19, 2002
1277 ==========================
1278 -Compile fixes. The last release (integer alphabets) was so exciting
1279 that usual portability checks got bypassed.
1281 Ragel 1.4.0 - Nov 19, 2002
1282 ==========================
1283 -Arbitrary integer alphabets are now fully supported! A new language
1285 'alphtype <type>' added for specifying the type of the alphabet. Default
1286 is 'char'. Possible alphabet types are:
1287 char, unsigned char, short, unsigned short, int, unsigned int
1288 -Literal machines specified in decimal format can now be negative when the
1289 alphabet is a signed type.
1290 -Literal machines (strings, decimal and hex) have their values checked for
1291 overflow/underflow against the size of the alphabet type.
1292 -Table driven and goto driven output redesigned to support ranges. Table
1293 driven uses a binary search for locating single characters and ranges. Goto
1294 driven uses a switch statement for single characters and nested if blocks for
1296 -Switch driven output removed due to a lack of consistent advantages. Most of
1297 the time the switch driven FSM is of no use because the goto FSM makes
1298 smaller and faster code. Under certain circumstances it can produce smaller
1299 code than a goto driven fsm and be almost as fast, but some sporadic case
1300 does not warrant maintaining it.
1301 -Many warnings changed to errors.
1302 -Added option -p for printing the final fsm before minimization. This lets
1303 priorities be seen. Priorties are all reset to 0 before minimization. The
1304 exiting option -f prints the final fsm after minimization.
1305 -Fixed a bug in the clang test and example that resulted in redundant actions
1308 Ragel 1.3.4 - Nov 6, 2002
1309 =========================
1310 -Fixes to Chapter 1 of the guide.
1311 -Brought back the examples and made them current.
1312 -MSVC is no longer supported for compiling windows binaries because its
1313 support for the C++ standard is frustratingly inadequate, it will cost money
1314 to upgrade if it ever gets better, and MinGW is a much better alternative.
1315 -The build system now supports the --host= option for building ragel
1316 for another system (used for cross compiling a windows binary with MinGW).
1317 -Various design changes and fixes towards the goal of arbitrary integer
1318 alphabets and the handling of larger state machines were made.
1319 -The new shared vector class is now used for action lists in transitions and
1320 states to reduce memory allocations.
1321 -An avl tree is now used for the reduction of transitions and functions of an
1322 fsm graph before making the final machine. The tree allows better scalability
1323 and performance by not requiring consecutively larger heap allocations.
1324 -Final stages in the separation of fsm graph code from action embedding and
1325 priority assignment is complete. Makes the base graph leaner and easier to reuse
1326 in other projects (like Keller).
1328 Ragel 1.3.3 - Oct 22, 2002
1329 ==========================
1330 -More diagrams were added to section 1.7.1 of the user guide.
1331 -FSM Graph code was reworked to spearate the regex/nfa/minimizaion graph
1332 algorithms from the manipulation of state and transition properties.
1333 -An rpm spec file from Cris Bailiff was added. This allows an rpm for ragel
1334 to be built with the command 'rpm -ta ragel-x.x.x.tar.gz'
1335 -Fixes to the build system and corresponding doc updates in the README.
1336 -Removed autil and included the one needed source file directly in the top
1337 level ragel directory.
1338 -Fixed a bug that nullified the 20 times speedup in large compilations
1339 claimed by the last version.
1340 -Removed awk from the doc build (it was added with the last release -- though
1341 not mentioned in the changelog).
1342 -Install of man page was moved to the doc dir. The install also installs the
1343 user guide to $(PREFIX)/share/doc/ragel/
1345 Ragel 1.3.2 - Oct 16, 2002
1346 ==========================
1347 -Added option -v (or --version) to show version information.
1348 -The subtract operator no longer removes transition data from the machine
1349 being subtracted. This is left up to the user for the purpose of making it
1350 possible to transfer transitions using subtract and also for speeding up the
1351 subtract routine. Note that it is possible to explicitly clear transition
1352 data before a doing a subtract.
1353 -Rather severe typo bug fixed. Bug was related to transitions with higher
1354 priorities taking precedence. A wrong ptr was being returned. It appears to
1355 have worked most of the time becuase the old ptr was deleted and the new one
1356 allocated immediatly after so the old ptr often pointed to the same space.
1358 -Bug in the removing of dead end paths was fixed. If the start state
1359 has in transitions then those paths were not followed when finding states to
1360 keep. Would result in non-dead end states being removed from the graph.
1361 -In lists and in ranges are no longer maintained as a bst with the key as the
1362 alphabet character and the value as a list of transitions coming in on that
1363 char. There is one list for each of inList, inRange and inDefault. Now that
1364 the required functionality of the graph is well known it is safe to remove
1365 these lists to gain in speed and footprint. They shouldn't be needed.
1366 -IsolateStartState() runs on modification of start data only if the start
1367 state is not already isolated, which is now possible with the new in list
1369 -Concat, Or and Star operators now use an approximation to
1370 removeUnreachableStates that does not require a traversal of the entire
1371 graph. This combined with an 'on-the-fly' management of final bits and final
1372 state status results is a dramatic speed increase when compiling machines
1373 that use those operators heavily. The strings2 test goes 20 times faster.
1374 -Before the final minimization, after all fsm operations are complete,
1375 priority data is reset which enables better minimization in cases where
1376 priorities would otherwise separate similar states.
1378 Ragel 1.3.1 - Oct 2, 2002
1379 =========================
1380 -Range transitions are now used to implement machines made with /[a-z]/ and
1381 the .. operator as well as most of the builtin machines. The ranges are not
1382 yet reflected in the output code, they are expanded as if they came from the
1383 regular single transitions. This is one step closer to arbitrary integer
1385 -The builtin machine 'any' was added. It is equiv to the builtin extend,
1386 matching any characters.
1387 -The builtin machine 'cntrl' now includes newline.
1388 -The builtin machine 'space' now includes newline.
1389 -The builtin machine 'ascii' is now the range 0-127, not all characters.
1390 -A man page was written.
1391 -A proper user guide was started. Chapter 1: Specifying Ragel Programs
1392 was written. It even has some diagrams :)
1394 Ragel 1.3.0 - Sep 4, 2002
1395 =========================
1396 -NULL keyword no longer used in table output.
1397 -Though not yet in use, underlying graph structure changed to support range
1398 transitions. As a result, most of the code that walks transition lists is now
1399 implemented with an iterator that hides the complexity of the transition
1400 lists and ranges. Range transitions will be used to implement /[a-z]/ style
1401 machines and machines made with the .. operator. Previously a single
1402 transition would be used for each char in the range, which is very costly.
1403 Ranges eliminate much of the space complexity and allow for the .. operator
1404 to be used with very large (integer) alphabets.
1405 -New minimization similar to Hopcroft's alg. It does not require n^2 space and
1406 runs close to O(n*log(n)) (an exact analysis of the alg is very hard). It is
1407 much better than the stable and approx minimization and obsoletes them both.
1408 An exact implementation of Hopcroft's alg is desirable but not possible
1409 because the ragel implementation does not assume a finite alphabet, which
1410 Hopcroft's requires. Ragel will support arbitrary integer alphabets which
1411 must be treated as an infinite set for implementation considerations.
1412 -New option -m using above described minimization to replace all previous
1413 minimization options. Old options sill work but are obsolete and not
1415 -Bug fixed in goto style output. The error exit set the current state to 0,
1416 which is actually a valid state. If the machine was entered again it would go
1417 into the first state, very wrong. If the first state happened to be final then
1418 an immediate finish would accept when in fact it should fail.
1419 -Slightly better fsm minimization now capable due to clearing of the
1420 transition ordering numbers just prior to minimization.
1422 Ragel 1.2.2 - May 25, 2002
1423 ==========================
1424 -Configuration option --prefix now works when installing.
1425 -cc file extension changed to cpp for better portability.
1426 -Unlink of output file upon error no longer happens, removes dependency on
1427 unlink system command.
1428 -All multiline strings removed: not standard c++.
1429 -Awk build dependency removed.
1430 -MSVC 6.0 added to the list of supported compilers (with some tweaking of
1431 bison and flex output).
1433 Ragel 1.2.1 - May 13, 2002
1434 ==========================
1435 -Automatic dependencies were fixed, they were not working correctly.
1436 -Updated AUTHORS file to reflect contributors.
1437 -Code is more C++ standards compliant: compiles with g++ 3.0
1438 -Fixed bugs that only showed up in g++ 3.0
1439 -Latest (unreleased) Aapl.
1440 -Configuration script bails out if bison++ is installed. Ragel will not
1441 compile with bison++ because it is coded in c++ and bison++ automatically
1442 generates a c++ parser. Ragel uses a c-style bison parser.
1444 Ragel 1.2.0 - May 3, 2002
1445 =========================
1446 -Underlying graph structure now supports default transitions. The result is
1447 that a transition does not need to be made for each char of the alphabet
1448 when making 'extend' or '/./' machines. Ragel compiles machines that
1449 use the aforementioned primitives WAY faster.
1450 -The ugly hacks needed to pick default transitions now go away due to
1451 the graph supporting default transitions directly.
1452 -If -e is given, but minimization is not turned on, print a warning.
1453 -Makefiles use automatic dependencies.
1455 Ragel 1.1.0 - Apr 15, 2002
1456 ==========================
1457 -Added goto fsm: much faster than any other fsm style.
1458 -Default operator (if two machines are side by side with no operator
1459 between them) is concatenation. First showed up in 1.0.4.
1460 -The fsm machine no longer auotmatically builds the flat table for
1461 transition indicies. Instead it keeps the key,ptr pair. In tabcodegen
1462 the flat table is produced. This way very large alphabets with sparse
1463 transitions will not consume large amounts of mem. This is also in prep
1464 for fsm graph getting a default transition.
1465 -Generated code contains a statement explicitly stating that ragel fsms
1466 are NOT covered by the GPL. Technically, Ragel copies part of itself
1467 to the output to make the generic fsm execution routine (for table driven
1468 fsms only) and so the output could be considered under the GPL. But this
1469 code is very trivial and could easlily be rewritten. The actual fsm data
1470 is subject to the copyright of the source. To promote the use of Ragel,
1471 a special exception is made for the part of the output copied from Ragel:
1472 it may be used without restriction.
1473 -Much more elegant code generation scheme is employed. Code generation
1474 class members need only put the 'codegen' keyword after their 'void' type
1475 in order to be automatically registerd to handle macros of the same name.
1476 An awk script recognises this keyword and generates an appropriate driver.
1477 -Ragel gets a test suite.
1478 -Postfunc and prefunc go away because they are not supported by non
1479 loop-driven fsms (goto, switch) and present duplicate functionality.
1480 Universal funcs can be implemented by using $ operator.
1481 -Automatic dependencies used in build system, no more make depend target.
1482 -Code generation section in docs.
1483 -Uses the latests aapl.
1485 Ragel 1.0.5 - Mar 3, 2002
1486 =========================
1487 -Bugfix in SetErrorState that caused an assertion failure when compiling
1488 simple machines that did not have full transition tables (and thus did
1489 not show up on any example machines). Assertion failure did not occur
1490 when using the switch statement code as ragel does not call SetErrorState
1492 -Fixed some missing includes, now compiles on redhat.
1493 -Moved the FsmMachTrans Compare class out of FsmMachTrans. Some compilers
1494 don't deal with nested classes in templates too well.
1495 -Removed old unused BASEREF in fsmgraph and ragel now compiles using
1496 egcs-2.91.66 and presumably SUNWspro. The baseref is no longer needed
1497 because states do not support being elements in multiple lists. I would
1498 rather be able to support more compilers than have this feature.
1499 -Started a README with compilation notes. Started an AUTHORS file.
1500 -Started the user documentation. Describes basic machines and operators.
1502 Ragel 1.0.4 - Mar 1, 2002
1503 =========================
1504 -Ported to the version of Aapl just after 2.2.0 release. See
1505 http://www.ragel.ca/aapl/ for details on aapl.
1506 -Fixed a bug in the clang example: the newline machine was not stared.
1507 -Added explanations to the clang and mailbox examples. This should
1508 help people that want to learn the lanuage as the manual is far from
1511 Ragel 1.0.3 - Feb 2, 2002
1512 =========================
1513 -Added aapl to the ragel tree. No longer requires you to download
1514 and build aapl separately. Should avoid discouraging impatient users
1515 from compiling ragel.
1516 -Added the examples to the ragel tree.
1517 -Added configure script checks for bison and flex.
1518 -Fixed makefile so as not to die with newer versions of bison that
1519 write the header of the parser to a .hh file.
1520 -Started ChangeLog file.
1522 Ragel 1.0.2 - Jan 30, 2002
1523 ==========================
1524 -Bug fix in calculating highIndex for table based code. Was using
1525 the length of out tranisition table rather than the value at the
1527 -If high/low index are at the limits, output a define in their place,
1528 not the high/low values themselves so as not to cause compiler warnings.
1529 -If the resulting machines don't have any indicies or functions, then
1530 omit the empty unrefereced static arrays so as not to cause compiler
1531 warnings about unused static vars.
1532 -Fixed variable sized indicies support. The header cannot have any
1533 reference to INDEX_TYPE as that info is not known at the time the header
1534 data is written. Forces us to use a void * for pointers to indicies. In
1535 the c++ versions we are forced to make much of the data non-member
1536 static data in the code portion for the same reason.
1538 Ragel 1.0.1 - Jan 28, 2002
1539 ==========================
1540 -Exe name change from reglang to ragel.
1541 -Added ftabcodegen output code style which uses a table for states and
1542 transitions but uses a switch statement for the function execution.
1543 -Reformatted options in usage dump to look better.
1544 -Support escape sequences in [] sections of regular expressions.
1546 Ragel 1.0 - Jan 25, 2002
1547 ========================