4 X evaluate expression tree in ec_tk_expr
12 - ec_completed_item_update()
13 - ec_completed_item_set_display_value()
18 - properly manage quotes in shlex
19 X remove the _new() functions
20 - iterate children nodes without chaining them
21 - add a tk vector type: will be used in several nodes (ex: or, seq, ...)
22 - check allocation model everywhere
24 - use linux style (update .emacs)
27 - use errno when returning pointers
28 - missing static / const
29 - license: "s/neither the name...may/the names of its contributors may not/"
30 - check all completion nodes
32 - cache results when appropriate?
33 - size_t or unsigned int?
36 X ec_parsed_tk -> ec_parsed
37 X ec_completed_tk -> ec_completed
38 X tk, gen_tk, token, ... -> node
39 X tokens -> input_str / input_strvec ?
40 - use is_err() or errno for funcs returning ptrs, or use errno for all funcs
41 - save node path in completion to fix help string
43 - try to hide structures
44 - anything better than weakref?
45 - add get_max_parse_len() for all relevant nodes
46 - add ec_node_defaults.[ch] providing usual implementations of node methods
52 X pass the current parsed state when parsing/completing
54 - new node "condition"
64 X register nodes by name
65 - interface to add attributes: all nodes must be configurable through a
73 - yaml interface to create nodes
79 - example which parses arguments (argc/argv)
80 - example that acts as bash completion (ip link ?)
81 - calculator example (var assignation, expression evaluation)
82 - example with libedit
83 - mini script language
85 - mini shell: cd, ls, cat, stat
86 - mini network console based on ip
93 - generate automatic api doc
95 - coding rules, process
98 - say that it stops at first match (no ambigous support)
99 - say that completion must be exhaustive
105 - split libs, tests and examples
113 - complete automatic tests with "make test"
119 - node which always matches
120 - file + partial completion
122 - fusion node: need to match several children, same for completion
129 - support utf-8 and other encodings
136 - demonstration example that parses yang file and generate cli
140 -----------------------
144 [tab] list possible completions (matches/partial only)
145 [?] list what is expected, example:
147 "command [foo] toto|titi|<int>"
163 - ec_node: a node that can be parsed/completed
164 - ec_parse: a tree describing the result of parse(node, input)
165 - ec_comp: a list describing the result of complete(node, input)
185 parse() returns a tree
188 - each node of the tree refers to a ec_node
189 - each node points to the strvec that matches
190 - parse returns the first matching solution
191 - usually try to match as many str in the vecs (seq node)
199 The parse cb of the node is:
201 parse_cb(node, current_parse_state, strvec, *nmatch)
204 - 0: success, child->strvec is set by node (NULL = no_match)
205 - -1: error (errno is set)
206 maybe complex to use:
207 - the node must set the match (ex: "return ec_parsed_node_match()")
208 - the caller must use accessor to check if it matches or not
210 alternative idea for return values:
211 - >= 0: match, ret == nb_tk
212 - -1: error (errno is set)
213 - -2 or MAX_INT: success, but no match
214 This is strange to have a specific value for no match
215 With MAX_INT, this is the best (less bad) alternative
217 alternative idea for return values:
218 - ec_parse_result_match(n_tokens >= 0)
219 - ec_parse_result_nomatch()
220 - ec_parse_result_error(errno)
222 A node always try to consume the maximum number of tokens.
230 [foo, foo, bar] matches
231 [foo, bar] does *not* match
233 complete() returns a list of possible completions
237 - partial completion: in a path dir/file, completion stops once
239 - displayed value is not the completion token: when completing a
240 file in several subdirectories, the full path is not displayed
241 - any parent node can modify the completions, ex: add missing quotes
242 in ec_node_sh_lex(), filter completions in case of a ec_node_filter()
243 - a command line may want to display the help from the most specific
245 - some specific nodes can complete several tokens
249 type: full, partial, unknown
252 full: the completion item matches token
253 partial: beginning of a completion, does not match the token
254 (good example is a directory in a path)
255 unknown: could complete, but the node does not know how
257 struct completion_item {
262 struct completed_elt {
263 ec_parsed *parse_tree; // current tree state
264 ec_node *last; // last node of the tree
265 list of items; // list of items for this parse tree
274 complete_cb(node, current_complete_state, current_parse_state, strvec)
276 - 0 = success, the current complete state is updated
277 - -1 = error (set errno?)
280 a node can filter the completions
317 - a completion item should contain a strvec for the value
318 (the display string remains a string)
319 - there is maybe no good reason to split in:
320 - ec_completed_item()
321 - ec_completed_item_set()
322 - ec_completed_item_set_display()
323 - ec_completed_item_add()
333 complete(sh_lex, ["'fo"])
334 complete(sh_lex, ["fo"]) -> ["foo", "foo2"]
347 static inline bool is_success(struct res r)
355 static inline struct res res(int a)
370 printf("success: %d\n", r.a);
376 printf("success: %d\n", r.a);