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