]>
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" | |
34 | ||
35 | DECLARE_MTYPE(CMD_ARG) | |
36 | ||
37 | struct vty; | |
38 | ||
39 | /** | |
40 | * Types for tokens. | |
41 | * | |
42 | * The type determines what kind of data the token can match (in the | |
43 | * matching use case) or hold (in the argv use case). | |
44 | */ | |
45 | enum cmd_token_type | |
46 | { | |
47 | WORD_TKN, // words | |
48 | VARIABLE_TKN, // almost anything | |
49 | RANGE_TKN, // integer range | |
50 | IPV4_TKN, // IPV4 addresses | |
51 | IPV4_PREFIX_TKN, // IPV4 network prefixes | |
52 | IPV6_TKN, // IPV6 prefixes | |
53 | IPV6_PREFIX_TKN, // IPV6 network prefixes | |
54 | ||
55 | /* plumbing types */ | |
56 | FORK_TKN, // marks subgraph beginning | |
57 | JOIN_TKN, // marks subgraph end | |
58 | START_TKN, // first token in line | |
59 | END_TKN, // last token in line | |
60 | ||
61 | SPECIAL_TKN = FORK_TKN, | |
62 | }; | |
63 | ||
70d44c5c DL |
64 | #define IS_VARYING_TOKEN(x) ((x) >= VARIABLE_TKN && (x) < FORK_TKN) |
65 | ||
5894e76d DL |
66 | /* Command attributes */ |
67 | enum | |
68 | { | |
69 | CMD_ATTR_NORMAL, | |
70 | CMD_ATTR_DEPRECATED, | |
71 | CMD_ATTR_HIDDEN, | |
72 | }; | |
73 | ||
74 | /* Comamand token struct. */ | |
75 | struct cmd_token | |
76 | { | |
77 | enum cmd_token_type type; // token type | |
78 | uint8_t attr; // token attributes | |
79 | bool allowrepeat; // matcher allowed to match token repetively? | |
80 | uint32_t refcnt; | |
81 | ||
82 | char *text; // token text | |
83 | char *desc; // token description | |
84 | long long min, max; // for ranges | |
85 | char *arg; // user input that matches this token | |
86 | char *varname; | |
87 | ||
88 | struct graph_node *forkjoin; // paired FORK/JOIN for JOIN/FORK | |
89 | }; | |
90 | ||
91 | /* Structure of command element. */ | |
92 | struct cmd_element | |
93 | { | |
94 | const char *string; /* Command specification by string. */ | |
95 | const char *doc; /* Documentation of this command. */ | |
96 | int daemon; /* Daemon to which this command belong. */ | |
97 | uint8_t attr; /* Command attributes */ | |
98 | ||
99 | /* handler function for command */ | |
100 | int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); | |
101 | ||
102 | const char *name; /* symbol name for debugging */ | |
103 | }; | |
104 | ||
105 | /* text for <cr> command */ | |
106 | #define CMD_CR_TEXT "<cr>" | |
107 | ||
108 | /* memory management for cmd_token */ | |
109 | extern struct cmd_token *cmd_token_new (enum cmd_token_type, uint8_t attr, | |
110 | const char *text, const char *desc); | |
111 | extern struct cmd_token *cmd_token_dup (struct cmd_token *); | |
112 | extern void cmd_token_del (struct cmd_token *); | |
113 | extern void cmd_token_varname_set(struct cmd_token *token, const char *varname); | |
114 | ||
115 | extern void cmd_graph_parse (struct graph *graph, struct cmd_element *cmd); | |
c09c46ae | 116 | extern void cmd_graph_names (struct graph *graph); |
5894e76d DL |
117 | extern void cmd_graph_merge (struct graph *old, struct graph *new, int direction); |
118 | ||
119 | #endif /* _FRR_COMMAND_GRAPH_H */ |