diff options
author | Dave Barach <dave@barachs.net> | 2019-05-29 09:59:51 -0400 |
---|---|---|
committer | Dave Barach <dave@barachs.net> | 2019-05-29 10:00:21 -0400 |
commit | 913f4c9a8824c1bd167d3a103aec902a14c08697 (patch) | |
tree | d4a5c894e524c245abd74e8b8a33875be40ed139 /extras/emacs/plugin-test-skel.el | |
parent | 02d576b754191a6dbffb7829db7cb18567b9b97f (diff) |
emacs-skeleton: improve generated .api files
Type cleanups:
s/u8/bool/ for "enable_disable"
s/u32/vl_api_interface_index_t/ for "sw_if_index"
Add an API version stamp.
Add a doxygen tag for the binary API.
Add Apache-2 licence text.
Change-Id: I2fa168336efb0f1d9b9b6dec945589cbc5fd5595
Signed-off-by: Dave Barach <dave@barachs.net>
Diffstat (limited to 'extras/emacs/plugin-test-skel.el')
-rw-r--r-- | extras/emacs/plugin-test-skel.el | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/extras/emacs/plugin-test-skel.el b/extras/emacs/plugin-test-skel.el index 1de1b9861af..6357a3d7d4d 100644 --- a/extras/emacs/plugin-test-skel.el +++ b/extras/emacs/plugin-test-skel.el @@ -24,7 +24,7 @@ nil '(setq capital-oh-en "ON") '(setq main-p (concat (substring plugin-name 0 1) "tmp")) "/* - * " plugin-name ".c - skeleton vpp-api-test plug-in + * " plugin-name ".c - skeleton vpp-api-test plug-in * * Copyright (c) <current-year> <your-organization> * Licensed under the Apache License, Version 2.0 (the \"License\"); @@ -43,6 +43,7 @@ nil #include <vlibapi/api.h> #include <vlibmemory/api.h> #include <vppinfra/error.h> +#include <stdbool.h> uword unformat_sw_if_index (unformat_input_t * input, va_list * args); @@ -51,19 +52,19 @@ uword unformat_sw_if_index (unformat_input_t * input, va_list * args); /* define message structures */ #define vl_typedefs -#include <" plugin-name "/" plugin-name "_all_api_h.h> +#include <" plugin-name "/" plugin-name "_all_api_h.h> #undef vl_typedefs /* declare message handlers for each api */ #define vl_endianfun /* define message structures */ -#include <" plugin-name "/" plugin-name "_all_api_h.h> +#include <" plugin-name "/" plugin-name "_all_api_h.h> #undef vl_endianfun /* instantiate all the print functions we know about */ #define vl_print(handle, ...) #define vl_printfun -#include <" plugin-name "/" plugin-name "_all_api_h.h> +#include <" plugin-name "/" plugin-name "_all_api_h.h> #undef vl_printfun /* Get the API version number. */ @@ -72,7 +73,7 @@ uword unformat_sw_if_index (unformat_input_t * input, va_list * args); #undef vl_api_version -typedef struct +typedef struct { /* API message ID base */ u16 msg_id_base; @@ -103,7 +104,7 @@ _(" plugin-name "_enable_disable_reply) foreach_standard_reply_retval_handler; #undef _ -/* +/* * Table of message reply handlers, must include boilerplate handlers * we just generated */ @@ -120,7 +121,7 @@ static int api_" plugin-name "_enable_disable (vat_main_t * vam) int ret; /* Parse args required to build the message */ - while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT) + while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT) { if (unformat (i, \"%U\", unformat_sw_if_index, vam, &sw_if_index)) ; @@ -131,13 +132,13 @@ static int api_" plugin-name "_enable_disable (vat_main_t * vam) else break; } - - if (sw_if_index == ~0) + + if (sw_if_index == ~0) { errmsg (\"missing interface name / explicit sw_if_index number \\n\"); return -99; } - + /* Construct the API message */ M(" PLUGIN-NAME "_ENABLE_DISABLE, mp); mp->sw_if_index = ntohl (sw_if_index); @@ -151,7 +152,7 @@ static int api_" plugin-name "_enable_disable (vat_main_t * vam) return ret; } -/* +/* * List of messages that the api test plugin sends, * and that the data plane plugin processes */ @@ -169,15 +170,15 @@ static void " plugin-name "_api_hookup (vat_main_t *vam) vl_noop_handler, \\ vl_api_##n##_t_endian, \\ vl_api_##n##_t_print, \\ - sizeof(vl_api_##n##_t), 1); + sizeof(vl_api_##n##_t), 1); foreach_vpe_api_reply_msg; #undef _ /* API messages we can send */ #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n); foreach_vpe_api_msg; -#undef _ - +#undef _ + /* Help strings */ #define _(n,h) hash_set_mem (vam->help_by_name, #n, h); foreach_vpe_api_msg; @@ -197,9 +198,9 @@ clib_error_t * vat_plugin_register (vat_main_t *vam) if (" main-p "->msg_id_base != (u16) ~0) " plugin-name "_api_hookup (vam); - + vec_free(name); - + return 0; } /* |