diff options
Diffstat (limited to 'src/plugins_internal.h')
| -rw-r--r-- | src/plugins_internal.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/src/plugins_internal.h b/src/plugins_internal.h new file mode 100644 index 0000000..d13db16 --- /dev/null +++ b/src/plugins_internal.h @@ -0,0 +1,85 @@ +/** + * @file plugins_internal.h + * @author Radek Krejci <rkrejci@cesnet.cz> + * @author Michal Vasko <mvasko@cesnet.cz> + * @brief internal functions to support extension and type plugins. + * + * Copyright (c) 2019-2022 CESNET, z.s.p.o. + * + * This source code is licensed under BSD 3-Clause License (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + */ + +#ifndef LY_PLUGINS_INTERNAL_H_ +#define LY_PLUGINS_INTERNAL_H_ + +#include <stdint.h> + +#include "plugins.h" +#include "plugins_exts.h" +#include "plugins_types.h" + +#define LY_TYPE_UNKNOWN_STR "unknown" /**< text representation of ::LY_TYPE_UNKNOWN */ +#define LY_TYPE_BINARY_STR "binary" /**< text representation of ::LY_TYPE_BINARY */ +#define LY_TYPE_UINT8_STR "8bit unsigned integer" /**< text representation of ::LY_TYPE_UINT8 */ +#define LY_TYPE_UINT16_STR "16bit unsigned integer" /**< text representation of ::LY_TYPE_UINT16 */ +#define LY_TYPE_UINT32_STR "32bit unsigned integer" /**< text representation of ::LY_TYPE_UINT32 */ +#define LY_TYPE_UINT64_STR "64bit unsigned integer" /**< text representation of ::LY_TYPE_UINT64 */ +#define LY_TYPE_STRING_STR "string" /**< text representation of ::LY_TYPE_STRING */ +#define LY_TYPE_BITS_STR "bits" /**< text representation of ::LY_TYPE_BITS */ +#define LY_TYPE_BOOL_STR "boolean" /**< text representation of ::LY_TYPE_BOOL */ +#define LY_TYPE_DEC64_STR "decimal64" /**< text representation of ::LY_TYPE_DEC64 */ +#define LY_TYPE_EMPTY_STR "empty" /**< text representation of ::LY_TYPE_EMPTY */ +#define LY_TYPE_ENUM_STR "enumeration" /**< text representation of ::LY_TYPE_ENUM */ +#define LY_TYPE_IDENT_STR "identityref" /**< text representation of ::LY_TYPE_IDENT */ +#define LY_TYPE_INST_STR "instance-identifier" /**< text representation of ::LY_TYPE_INST */ +#define LY_TYPE_LEAFREF_STR "leafref" /**< text representation of ::LY_TYPE_LEAFREF */ +#define LY_TYPE_UNION_STR "union" /**< text representation of ::LY_TYPE_UNION */ +#define LY_TYPE_INT8_STR "8bit integer" /**< text representation of ::LY_TYPE_INT8 */ +#define LY_TYPE_INT16_STR "16bit integer" /**< text representation of ::LY_TYPE_INT16 */ +#define LY_TYPE_INT32_STR "32bit integer" /**< text representation of ::LY_TYPE_INT32 */ +#define LY_TYPE_INT64_STR "64bit integer" /**< text representation of ::LY_TYPE_INT64 */ + +/** + * @brief Initiate libyang plugins. + * + * Covers both the types and extensions plugins. + * + * @return LY_SUCCESS in case of success + * @return LY_EINT in case of internal error + * @return LY_EMEM in case of memory allocation failure. + */ +LY_ERR lyplg_init(void); + +/** + * @brief Remove (unload) all the plugins currently available. + */ +void lyplg_clean(void); + +/** + * @brief Find a type plugin. + * + * @param[in] module Name of the module where the type is defined. Must not be NULL, in case of plugins for + * built-in types, the module is "". + * @param[in] revision Revision of the module for which the plugin is implemented. NULL is not a wildcard, it matches + * only the plugins with NULL revision specified. + * @param[in] name Name of the type which the plugin implements. + * @return Found type plugin, NULL if none found. + */ +struct lyplg_type *lyplg_type_plugin_find(const char *module, const char *revision, const char *name); + +/** + * @brief Find an extension plugin. + * + * @param[in] module Name of the module where the extension is defined. + * @param[in] revision Revision of the module for which the plugin is implemented. NULL is not a wildcard, it matches + * only the plugins with NULL revision specified. + * @param[in] name Name of the extension which the plugin implements. + * @return Found extension record, NULL if none found. + */ +struct lyplg_ext_record *lyplg_ext_record_find(const char *module, const char *revision, const char *name); + +#endif /* LY_PLUGINS_INTERNAL_H_ */ |