Merge pull request #13649 from donaldsharp/unlock_the_node_or_else

[mirror_frr.git] / lib / command_match.h

diff --git a/lib/command_match.h b/lib/command_match.h
index a04f60f0d8d89b49d1166f6f34967d175c24f062..db2a8535e00706e36c042e4cbb87f99c583230c8 100644 (file)
--- a/lib/command_match.h
+++ b/lib/command_match.h
@@ -1,24 +1,9 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
 /*
  * Input matching routines for CLI backend.
  *
  * --
  * Copyright (C) 2016 Cumulus Networks, Inc.
- *
- * This file is part of GNU Zebra.
- *
- * GNU Zebra is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2, or (at your option) any
- * later version.
- *
- * GNU Zebra is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; see the file COPYING; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef _ZEBRA_COMMAND_MATCH_H
@@ -28,41 +13,38 @@
 #include "linklist.h"
 #include "command.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* These definitions exist in command.c in the current engine but should be
  * relocated here in the new engine
  */
-enum filter_type
-{
-  FILTER_RELAXED,
-  FILTER_STRICT
-};
+enum cmd_filter_type { FILTER_RELAXED, FILTER_STRICT };
 
 /* matcher result value */
-enum matcher_rv
-{
-  MATCHER_NO_MATCH,
-  MATCHER_INCOMPLETE,
-  MATCHER_AMBIGUOUS,
-  MATCHER_OK,
+enum matcher_rv {
+       MATCHER_NO_MATCH,
+       MATCHER_INCOMPLETE,
+       MATCHER_AMBIGUOUS,
+       MATCHER_OK,
 };
 
 /* completion match types */
-enum match_type
-{
-  trivial_match,  // the input is null
-  no_match,       // the input does not match
-  partly_match,   // the input matches but is incomplete
-  exact_match     // the input matches and is complete
+enum match_type {
+       trivial_match, // the input is null
+       no_match,      // the input does not match
+       partly_match,  // the input matches but is incomplete
+       exact_match    // the input matches and is complete
 };
 
 /* Defines which matcher_rv values constitute an error. Should be used with
  * matcher_rv return values to do basic error checking.
  */
-#define MATCHER_ERROR(matcher_rv) \
-  (   (matcher_rv) == MATCHER_INCOMPLETE \
-   || (matcher_rv) == MATCHER_NO_MATCH \
-   || (matcher_rv) == MATCHER_AMBIGUOUS \
-  )
+#define MATCHER_ERROR(matcher_rv)                                              \
+       ((matcher_rv) == MATCHER_INCOMPLETE                                    \
+        || (matcher_rv) == MATCHER_NO_MATCH                                   \
+        || (matcher_rv) == MATCHER_AMBIGUOUS)
 
 /**
  * Attempt to find an exact command match for a line of user input.
@@ -71,7 +53,7 @@ enum match_type
  * @param[in] vline vectorized input string
  * @param[out] argv pointer to argument list if successful match, NULL
  * otherwise. The elements of this list are pointers to struct cmd_token
- * and represent the sequence of tokens matched by the inpu. The ->arg
+ * and represent the sequence of tokens matched by the input. The ->arg
  * field of each token points to a copy of the input matched on it. These
  * may be safely deleted or modified.
  * @param[out] element pointer to matched cmd_element if successful match,
@@ -79,11 +61,9 @@ enum match_type
  * safely deleted or modified; it is the instance initialized on startup.
  * @return matcher status
  */
-enum matcher_rv
-command_match (struct graph *cmdgraph,
-               vector vline,
-               struct list **argv,
-               const struct cmd_element **element);
+enum matcher_rv command_match(struct graph *cmdgraph, vector vline,
+                             struct list **argv,
+                             const struct cmd_element **element);
 
 /**
  * Compiles possible completions for a given line of user input.
@@ -104,9 +84,11 @@ command_match (struct graph *cmdgraph,
  * of that element (e.g. 'encapv4', 'encapv6', etc for input 'en').
  * @return matcher status
  */
-enum matcher_rv
-command_complete (struct graph *cmdgraph,
-                  vector vline,
-                  struct list **completions);
+enum matcher_rv command_complete(struct graph *cmdgraph, vector vline,
+                                struct list **completions);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* _ZEBRA_COMMAND_MATCH_H */