]> git.proxmox.com Git - mirror_frr.git/blame - lib/command_graph.h
*: require ISO C11 (or C++11)
[mirror_frr.git] / lib / command_graph.h
CommitLineData
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
37extern "C" {
38#endif
39
5894e76d
DL
40DECLARE_MTYPE(CMD_ARG)
41
42struct 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 51enum 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
67
68 SPECIAL_TKN = FORK_TKN,
5894e76d 69};
9779e3f1 70/* clang-format on */
5894e76d 71
70d44c5c
DL
72#define IS_VARYING_TOKEN(x) ((x) >= VARIABLE_TKN && (x) < FORK_TKN)
73
5894e76d 74/* Command attributes */
d62a17ae 75enum { CMD_ATTR_NORMAL,
76 CMD_ATTR_DEPRECATED,
77 CMD_ATTR_HIDDEN,
ca77b518 78 CMD_ATTR_YANG,
5894e76d
DL
79};
80
81/* Comamand token struct. */
d62a17ae 82struct cmd_token {
83 enum cmd_token_type type; // token type
84 uint8_t attr; // token attributes
85 bool allowrepeat; // matcher allowed to match token repetively?
86 uint32_t refcnt;
87
88 char *text; // token text
89 char *desc; // token description
90 long long min, max; // for ranges
91 char *arg; // user input that matches this token
92 char *varname;
93
94 struct graph_node *forkjoin; // paired FORK/JOIN for JOIN/FORK
5894e76d
DL
95};
96
97/* Structure of command element. */
d62a17ae 98struct cmd_element {
99 const char *string; /* Command specification by string. */
100 const char *doc; /* Documentation of this command. */
101 int daemon; /* Daemon to which this command belong. */
5e085e52 102 uint32_t attr; /* Command attributes */
5894e76d 103
d62a17ae 104 /* handler function for command */
105 int (*func)(const struct cmd_element *, struct vty *, int,
106 struct cmd_token *[]);
5894e76d 107
d62a17ae 108 const char *name; /* symbol name for debugging */
feb06e7a 109 struct xref xref;
5894e76d
DL
110};
111
112/* text for <cr> command */
113#define CMD_CR_TEXT "<cr>"
114
115/* memory management for cmd_token */
d62a17ae 116extern struct cmd_token *cmd_token_new(enum cmd_token_type, uint8_t attr,
117 const char *text, const char *desc);
118extern struct cmd_token *cmd_token_dup(struct cmd_token *);
119extern void cmd_token_del(struct cmd_token *);
5894e76d
DL
120extern void cmd_token_varname_set(struct cmd_token *token, const char *varname);
121
154e9ca1 122extern void cmd_graph_parse(struct graph *graph, const struct cmd_element *cmd);
d62a17ae 123extern void cmd_graph_names(struct graph *graph);
7f04943d 124extern void cmd_graph_merge(struct graph *old, struct graph *n,
d62a17ae 125 int direction);
26fbe472
QY
126/*
127 * Print callback for DOT dumping.
128 *
129 * See graph.h for more details.
130 */
131extern void cmd_graph_node_print_cb(struct graph_node *gn, struct buffer *buf);
132/*
133 * Dump command graph to DOT.
134 *
135 * cmdgraph
136 * A command graph to dump
137 *
138 * Returns:
139 * String allocated with MTYPE_TMP representing this graph
140 */
141char *cmd_graph_dump_dot(struct graph *cmdgraph);
5894e76d 142
5e244469
RW
143#ifdef __cplusplus
144}
145#endif
146
5894e76d 147#endif /* _FRR_COMMAND_GRAPH_H */