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