Organized ideas for 6.0.
[external/ragel.git] / TODO
1 Ragel 6.0 Features
2 ==================
3
4 Expressions of the form: ( expr1 <: expr2 . expr3 ) sometimes don't behave as
5 expected. If expr2 contains the empty string then it's possible for the machine
6 to escape to expr3. This is somewhat unexpected.  The empty string does count
7 as moving through the right machine so there should not be an exception for
8 this case. Using the stronger implementation: ( expr1 $1 %0 . expr2 ) will
9 solve the problem.
10
11 Also, there is potential for nondeterminism to persist via the empty string
12 with the :> and :>> operators. Should also guard against this using leaving
13 priorities.
14
15 fbreak should advance the current char. Depreciate fbreak and add
16     fctl_break;
17     fctl_return <expr>;
18     fctl_goto <label>;
19
20 fbreak should execute the to-state actions of the target state. The semantics
21 of fbreak should be identical to reaching the end of a buffer block.
22
23 Introduce a new variable "eof" which is a pointer like pe. It gets set to pe
24 when the input has ended. This would enable eof actions to go into the main
25 loop, granting them the ability to manipulate p and cs. This would free us from
26 requiring some eof character to be sent to scanners to 'flush out' the last
27 token.  Instead an eof action can now execute scanner pattern actions and
28 backtrack if necessary.
29
30 The tokstart/tokend variable should be shortened to ts/te.
31
32 ================
33 END 6.0 Features
34
35 Should be possible to include scanner definitions in another scanner.
36
37 Need a "write entry name;" feature.
38
39 Should be possible to embed the negative sense of a condition.
40
41 Possibly bring back the old semantics of > in a new operator, or allow it to be
42 defined somehow.
43
44 When priorities are embedded without a name, the name of the current machine is
45 used. Perhaps a unique name for each instance of the current machine should be
46 used instead. This idea could work well if applied to user-defined embeddings. 
47
48 User defined embeddings <-name(a1,a2,...).
49 User defined operators expr1 <name> expr2.
50
51 Doesn't make make sense for [] to be the lambda (zero-length) machine. This
52 should be the empty set (the empty machine). But then would it be invalid in a
53 regular expression?
54
55 The |> guarded operator and the <| guarded operator need to be added.
56
57 The fixed size stack is a problem for manual recursion of unlimited depth.
58
59 An option to turn off the removal of duplicate actions might be useful for
60 analyzing unintentional nondeterminism.
61
62 Might be a good idea to add in some protection against using up all of a
63 system's memory. This protection could then be removed by people when someone
64 is sure they want to use a lot of memory.
65
66
67 If a scanner can be optimized into a pure state machine, maybe permit it to be
68 referenced as a machine definition. Alternately: inline scanners with an
69 explicit exit pattern.
70
71 The split codegen needs a profiler connected to a graph partitioning algorithm.
72
73 Die a graceful death when rlcodegen -F receives large alphabets.
74
75 It's not currently possible to have more than one machine in a single function
76 because of label conflicts. Labels should have a unique prefix.
77
78 Emit a warning when a subtraction has no effect.
79
80 Emit a warning when unnamed priorities are used in longest match machines.
81 These priorities may unexpectedly interact across longest-match items. Changing
82 the language such that unwated interaction cannot happen would require naming
83 longest-match items.
84
85 Testing facilities: Quick easy way to query which strings are accepted.
86 Enumerate all accepted strings. From Nicholas Maxwell Lester.
87
88 Add more examples, add more tests and write more documentation.
89
90 A debugger would be nice. Ragel could emit a special debug version that
91 prompted for debug commands that allowed the user to step through the machine
92 and get details about where they are in their RL.
93
94 A quick and easy alternative would be a trace code generation option. This
95 would open a trace file and list all the active machines at each step of the
96 input.
97
98 Frontend should allow the redefinition of fsm section delimiters.
99
100 Do more to obscure ragel's private variables. Just a leading underscore is not
101 enough. Maybe something more like __ri__.
102
103 Some talk about capturing data:
104
105 Separate tokstart/tokend from the backtracking.  One var for preservation,
106 called preserve.  Write delcarations;  produces the necessary variables used by
107 ragel.  Move pattern start pattern end concepts into the general?  The
108 variables which may need to influence the preserve is dependent on the state.
109 States have a concept of which variables are in use.  Can be used for length
110 restrictions.  If there is an exit pattern, it is the explicit way out,
111 otherwise the start state and all final states are a way out.