]>
git.proxmox.com Git - mirror_frr.git/blob - lib/command_match.h
2 * Input matching routines for CLI backend.
5 * Copyright (C) 2016 Cumulus Networks, Inc.
7 * This file is part of GNU Zebra.
9 * GNU Zebra is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2, or (at your option) any
14 * GNU Zebra is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with GNU Zebra; see the file COPYING. If not, write to the Free
21 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 #ifndef _ZEBRA_COMMAND_MATCH_H
26 #define _ZEBRA_COMMAND_MATCH_H
29 #include "command_graph.h"
33 /* These definitions exist in command.c in the current engine but should be
34 * relocated here in the new engine
42 /* matcher result value */
51 /* completion match types */
59 /* Defines which matcher_rv values constitute an error. Should be used with
60 * matcher_rv return values to do basic error checking.
62 #define MATCHER_ERROR(matcher_rv) \
63 ( (matcher_rv) == MATCHER_INCOMPLETE \
64 || (matcher_rv) == MATCHER_NO_MATCH \
65 || (matcher_rv) == MATCHER_AMBIGUOUS \
69 * Attempt to find an exact command match for a line of user input.
71 * @param[in] start start node of command graph to match against
72 * @param[in] vline vectorized input string
73 * @param[out] argv pointer to argument list if successful match
74 * @param[out] element pointer to matched cmd_element if successful match
75 * @return matcher status
78 match_command (struct graph_node
*start
,
81 struct cmd_element
**element
);
84 * Compiles possible completions for a given line of user input.
86 * @param[in] start the start node of the DFA to match against
87 * @param[in] vline vectorized input string
88 * @param[in] completions pointer to possible completions
89 * @return matcher status
92 match_command_complete (struct graph_node
*start
,
94 struct list
**completions
);
96 #endif /* _ZEBRA_COMMAND_MATCH_H */