1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Input matching routines for CLI backend.
*
* --
* Copyright (C) 2016 Cumulus Networks, Inc.
*/
#ifndef _ZEBRA_COMMAND_MATCH_H
#define _ZEBRA_COMMAND_MATCH_H
#include "graph.h"
#include "linklist.h"
#include "command.h"
#ifdef __cplusplus
extern "C" {
#endif
/* matcher result value */
enum matcher_rv {
MATCHER_NO_MATCH,
MATCHER_INCOMPLETE,
MATCHER_AMBIGUOUS,
MATCHER_OK,
};
/* completion match types */
enum match_type {
trivial_match, // the input is null
no_match, // the input does not match
partly_match, // the input matches but is incomplete
exact_match // the input matches and is complete
};
/* Defines which matcher_rv values constitute an error. Should be used with
* matcher_rv return values to do basic error checking.
*/
#define MATCHER_ERROR(matcher_rv) \
((matcher_rv) == MATCHER_INCOMPLETE \
|| (matcher_rv) == MATCHER_NO_MATCH \
|| (matcher_rv) == MATCHER_AMBIGUOUS)
/**
* Attempt to find an exact command match for a line of user input.
*
* @param[in] cmdgraph command graph to match against
* @param[in] vline vectorized input string
* @param[out] argv pointer to argument list if successful match, NULL
* otherwise. The elements of this list are pointers to struct cmd_token
* and represent the sequence of tokens matched by the input. The ->arg
* field of each token points to a copy of the input matched on it. These
* may be safely deleted or modified.
* @param[out] element pointer to matched cmd_element if successful match,
* or NULL when MATCHER_ERROR(rv) is true. The cmd_element may *not* be
* safely deleted or modified; it is the instance initialized on startup.
* @return matcher status
*/
enum matcher_rv command_match(struct graph *cmdgraph, vector vline,
struct list **argv,
const struct cmd_element **element);
/**
* Compiles possible completions for a given line of user input.
*
* @param[in] start the start node of the DFA to match against
* @param[in] vline vectorized input string
* @param[out] completions pointer to list of cmd_token representing
* acceptable next inputs, or NULL when MATCHER_ERROR(rv) is true.
* The elements of this list are pointers to struct cmd_token and take on a
* variety of forms depending on the passed vline. If the last element in vline
* is NULL, all previous elements are considered to be complete words (the case
* when a space is the last token of the line) and completions are generated
* based on what could follow that input. If the last element in vline is not
* NULL and each sequential element matches the corresponding tokens of one or
* more commands exactly (e.g. 'encapv4' and not 'en') the same result is
* generated. If the last element is not NULL and the best possible match is a
* partial match, then the result generated will be all possible continuations
* of that element (e.g. 'encapv4', 'encapv6', etc for input 'en').
* @return matcher status
*/
enum matcher_rv command_complete(struct graph *cmdgraph, vector vline,
struct list **completions);
#ifdef __cplusplus
}
#endif
#endif /* _ZEBRA_COMMAND_MATCH_H */
|
