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