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