]>
Commit | Line | Data |
---|---|---|
5894e76d DL |
1 | /* |
2 | * CLI graph handling | |
3 | * | |
4 | * -- | |
5 | * Copyright (C) 2016 Cumulus Networks, Inc. | |
6 | * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro | |
7 | * Copyright (C) 2013 by Open Source Routing. | |
8 | * Copyright (C) 2013 by Internet Systems Consortium, Inc. ("ISC") | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify it | |
11 | * under the terms of the GNU General Public License as published by the Free | |
12 | * Software Foundation; either version 2 of the License, or (at your option) | |
13 | * any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
16 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
17 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
18 | * more details. | |
19 | * | |
896014f4 DL |
20 | * You should have received a copy of the GNU General Public License along |
21 | * with this program; see the file COPYING; if not, write to the Free Software | |
22 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
5894e76d DL |
23 | */ |
24 | ||
25 | #ifndef _FRR_COMMAND_GRAPH_H | |
26 | #define _FRR_COMMAND_GRAPH_H | |
27 | ||
28 | #include <stdbool.h> | |
29 | #include <stdint.h> | |
30 | ||
31 | #include "memory.h" | |
32 | #include "vector.h" | |
33 | #include "graph.h" | |
feb06e7a | 34 | #include "xref.h" |
5894e76d | 35 | |
5e244469 RW |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
39 | ||
bf8d3d6a | 40 | DECLARE_MTYPE(CMD_ARG); |
5894e76d DL |
41 | |
42 | struct vty; | |
43 | ||
44 | /** | |
45 | * Types for tokens. | |
46 | * | |
47 | * The type determines what kind of data the token can match (in the | |
48 | * matching use case) or hold (in the argv use case). | |
49 | */ | |
9779e3f1 | 50 | /* clang-format off */ |
d62a17ae | 51 | enum cmd_token_type { |
9779e3f1 | 52 | WORD_TKN, // words |
d62a17ae | 53 | VARIABLE_TKN, // almost anything |
54 | RANGE_TKN, // integer range | |
9779e3f1 | 55 | IPV4_TKN, // IPV4 addresses |
d62a17ae | 56 | IPV4_PREFIX_TKN, // IPV4 network prefixes |
9779e3f1 | 57 | IPV6_TKN, // IPV6 prefixes |
d62a17ae | 58 | IPV6_PREFIX_TKN, // IPV6 network prefixes |
9779e3f1 QY |
59 | MAC_TKN, // Ethernet address |
60 | MAC_PREFIX_TKN, // Ethernet address w/ CIDR mask | |
d62a17ae | 61 | |
62 | /* plumbing types */ | |
63 | FORK_TKN, // marks subgraph beginning | |
64 | JOIN_TKN, // marks subgraph end | |
65 | START_TKN, // first token in line | |
66 | END_TKN, // last token in line | |
90c8406c | 67 | NEG_ONLY_TKN, // filter token, match if "no ..." command |
d62a17ae | 68 | |
69 | SPECIAL_TKN = FORK_TKN, | |
5894e76d | 70 | }; |
9779e3f1 | 71 | /* clang-format on */ |
5894e76d | 72 | |
70d44c5c DL |
73 | #define IS_VARYING_TOKEN(x) ((x) >= VARIABLE_TKN && (x) < FORK_TKN) |
74 | ||
5894e76d | 75 | /* Command attributes */ |
d62a17ae | 76 | enum { CMD_ATTR_NORMAL, |
77 | CMD_ATTR_DEPRECATED, | |
78 | CMD_ATTR_HIDDEN, | |
ca77b518 | 79 | CMD_ATTR_YANG, |
5894e76d DL |
80 | }; |
81 | ||
81eb8fc7 | 82 | /* Command token struct. */ |
d62a17ae | 83 | struct cmd_token { |
84 | enum cmd_token_type type; // token type | |
85 | uint8_t attr; // token attributes | |
81eb8fc7 | 86 | bool allowrepeat; // matcher allowed to match token repetitively? |
d62a17ae | 87 | uint32_t refcnt; |
88 | ||
89 | char *text; // token text | |
90 | char *desc; // token description | |
91 | long long min, max; // for ranges | |
92 | char *arg; // user input that matches this token | |
93 | char *varname; | |
94 | ||
95 | struct graph_node *forkjoin; // paired FORK/JOIN for JOIN/FORK | |
5894e76d DL |
96 | }; |
97 | ||
98 | /* Structure of command element. */ | |
d62a17ae | 99 | struct cmd_element { |
100 | const char *string; /* Command specification by string. */ | |
101 | const char *doc; /* Documentation of this command. */ | |
102 | int daemon; /* Daemon to which this command belong. */ | |
5e085e52 | 103 | uint32_t attr; /* Command attributes */ |
5894e76d | 104 | |
d62a17ae | 105 | /* handler function for command */ |
106 | int (*func)(const struct cmd_element *, struct vty *, int, | |
107 | struct cmd_token *[]); | |
5894e76d | 108 | |
d62a17ae | 109 | const char *name; /* symbol name for debugging */ |
feb06e7a | 110 | struct xref xref; |
5894e76d DL |
111 | }; |
112 | ||
113 | /* text for <cr> command */ | |
114 | #define CMD_CR_TEXT "<cr>" | |
115 | ||
116 | /* memory management for cmd_token */ | |
d62a17ae | 117 | extern struct cmd_token *cmd_token_new(enum cmd_token_type, uint8_t attr, |
118 | const char *text, const char *desc); | |
119 | extern struct cmd_token *cmd_token_dup(struct cmd_token *); | |
120 | extern void cmd_token_del(struct cmd_token *); | |
5894e76d DL |
121 | extern void cmd_token_varname_set(struct cmd_token *token, const char *varname); |
122 | ||
154e9ca1 | 123 | extern void cmd_graph_parse(struct graph *graph, const struct cmd_element *cmd); |
d62a17ae | 124 | extern void cmd_graph_names(struct graph *graph); |
7f04943d | 125 | extern void cmd_graph_merge(struct graph *old, struct graph *n, |
d62a17ae | 126 | int direction); |
26fbe472 QY |
127 | /* |
128 | * Print callback for DOT dumping. | |
129 | * | |
130 | * See graph.h for more details. | |
131 | */ | |
132 | extern void cmd_graph_node_print_cb(struct graph_node *gn, struct buffer *buf); | |
133 | /* | |
134 | * Dump command graph to DOT. | |
135 | * | |
136 | * cmdgraph | |
137 | * A command graph to dump | |
138 | * | |
139 | * Returns: | |
140 | * String allocated with MTYPE_TMP representing this graph | |
141 | */ | |
142 | char *cmd_graph_dump_dot(struct graph *cmdgraph); | |
5894e76d | 143 | |
5e244469 RW |
144 | #ifdef __cplusplus |
145 | } | |
146 | #endif | |
147 | ||
5894e76d | 148 | #endif /* _FRR_COMMAND_GRAPH_H */ |