lib/command_graph.h

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