libyang 3.4.2
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
Loading...
Searching...
No Matches
hex_string.c
Go to the documentation of this file.
1
15#define _GNU_SOURCE
16
17#include "plugins_types.h"
18
19#include <ctype.h>
20#include <stdint.h>
21#include <stdlib.h>
22#include <string.h>
23
24#include "libyang.h"
25
26/* additional internal headers for some useful simple macros */
27#include "compat.h"
28#include "ly_common.h"
29#include "plugins_internal.h" /* LY_TYPE_*_STR */
30
40LIBYANG_API_DEF LY_ERR
41lyplg_type_store_hex_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len,
42 uint32_t options, LY_VALUE_FORMAT format, void *UNUSED(prefix_data), uint32_t hints,
43 const struct lysc_node *UNUSED(ctx_node), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres),
44 struct ly_err_item **err)
45{
46 LY_ERR ret = LY_SUCCESS;
47 struct lysc_type_str *type_str = (struct lysc_type_str *)type;
48 uint32_t i;
49
50 /* init storage */
51 memset(storage, 0, sizeof *storage);
52 storage->realtype = type;
53
54 /* check hints */
55 ret = lyplg_type_check_hints(hints, value, value_len, type->basetype, NULL, err);
56 LY_CHECK_GOTO(ret, cleanup);
57
58 /* make a copy, it is needed for canonization */
59 if ((format != LY_VALUE_CANON) && !(options & LYPLG_TYPE_STORE_DYNAMIC)) {
60 value = strndup(value, value_len);
61 LY_CHECK_ERR_GOTO(!value, ret = LY_EMEM, cleanup);
62 options |= LYPLG_TYPE_STORE_DYNAMIC;
63 }
64
65 /* store canonical value */
66 if (format != LY_VALUE_CANON) {
67 /* make lowercase and store, the value must be dynamic */
68 for (i = 0; i < value_len; ++i) {
69 ((char *)value)[i] = tolower(((char *)value)[i]);
70 }
71
72 ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
73 options &= ~LYPLG_TYPE_STORE_DYNAMIC;
74 LY_CHECK_GOTO(ret, cleanup);
75
76 /* value may have been freed */
77 value = storage->_canonical;
78 } else {
79 /* store directly */
80 ret = lydict_insert(ctx, value_len ? value : "", value_len, &storage->_canonical);
81 LY_CHECK_GOTO(ret, cleanup);
82 }
83
84 if (!(options & LYPLG_TYPE_STORE_ONLY)) {
85 /* validate length restriction of the string */
86 if (type_str->length) {
87 /* value_len is in bytes, but we need number of characters here */
88 ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_len), value, value_len, err);
89 LY_CHECK_GOTO(ret, cleanup);
90 }
91
92 /* validate pattern restrictions */
93 ret = lyplg_type_validate_patterns(type_str->patterns, value, value_len, err);
94 LY_CHECK_GOTO(ret, cleanup);
95 }
96
97cleanup:
98 if (options & LYPLG_TYPE_STORE_DYNAMIC) {
99 free((void *)value);
100 }
101
102 if (ret) {
103 lyplg_type_free_simple(ctx, storage);
104 }
105 return ret;
106}
107
116 {
117 .module = "ietf-yang-types",
118 .revision = "2013-07-15",
119 .name = "phys-address",
120
121 .plugin.id = "libyang 2 - hex-string, version 1",
122 .plugin.store = lyplg_type_store_hex_string,
123 .plugin.validate = NULL,
124 .plugin.compare = lyplg_type_compare_simple,
125 .plugin.sort = lyplg_type_sort_simple,
126 .plugin.print = lyplg_type_print_simple,
127 .plugin.duplicate = lyplg_type_dup_simple,
128 .plugin.free = lyplg_type_free_simple,
129 .plugin.lyb_data_len = -1,
130 },
131 {
132 .module = "ietf-yang-types",
133 .revision = "2013-07-15",
134 .name = "mac-address",
135
136 .plugin.id = "libyang 2 - hex-string, version 1",
137 .plugin.store = lyplg_type_store_hex_string,
138 .plugin.validate = NULL,
139 .plugin.compare = lyplg_type_compare_simple,
140 .plugin.sort = lyplg_type_sort_simple,
141 .plugin.print = lyplg_type_print_simple,
142 .plugin.duplicate = lyplg_type_dup_simple,
143 .plugin.free = lyplg_type_free_simple,
144 .plugin.lyb_data_len = -1,
145 },
146 {
147 .module = "ietf-yang-types",
148 .revision = "2013-07-15",
149 .name = "hex-string",
150
151 .plugin.id = "libyang 2 - hex-string, version 1",
152 .plugin.store = lyplg_type_store_hex_string,
153 .plugin.validate = NULL,
154 .plugin.compare = lyplg_type_compare_simple,
155 .plugin.sort = lyplg_type_sort_simple,
156 .plugin.print = lyplg_type_print_simple,
157 .plugin.duplicate = lyplg_type_dup_simple,
158 .plugin.free = lyplg_type_free_simple,
159 .plugin.lyb_data_len = -1,
160 },
161 {
162 .module = "ietf-yang-types",
163 .revision = "2013-07-15",
164 .name = "uuid",
165
166 .plugin.id = "libyang 2 - hex-string, version 1",
167 .plugin.store = lyplg_type_store_hex_string,
168 .plugin.validate = NULL,
169 .plugin.compare = lyplg_type_compare_simple,
170 .plugin.sort = lyplg_type_sort_simple,
171 .plugin.print = lyplg_type_print_simple,
172 .plugin.duplicate = lyplg_type_dup_simple,
173 .plugin.free = lyplg_type_free_simple,
174 .plugin.lyb_data_len = -1,
175 },
176 {0}
177};
libyang context handler.
LIBYANG_API_DECL LY_ERR lydict_insert(const struct ly_ctx *ctx, const char *value, size_t len, const char **str_p)
Insert string into dictionary. If the string is already present, only a reference counter is incremen...
LIBYANG_API_DECL LY_ERR lydict_insert_zc(const struct ly_ctx *ctx, char *value, const char **str_p)
Insert string into dictionary - zerocopy version. If the string is already present,...
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:237
@ LY_EMEM
Definition log.h:239
@ LY_SUCCESS
Definition log.h:238
Libyang full error structure.
Definition log.h:282
const char *const char * revision
LIBYANG_API_DECL LY_ERR lyplg_type_validate_patterns(struct lysc_pattern **patterns, const char *str, size_t str_len, struct ly_err_item **err)
Data type validator for pattern-restricted string values.
LIBYANG_API_DECL LY_ERR lyplg_type_validate_range(LY_DATA_TYPE basetype, struct lysc_range *range, int64_t value, const char *strval, size_t strval_len, struct ly_err_item **err)
Data type validator for a range/length-restricted values.
LIBYANG_API_DECL LY_ERR lyplg_type_check_hints(uint32_t hints, const char *value, size_t value_len, LY_DATA_TYPE type, int *base, struct ly_err_item **err)
Check that the type is suitable for the parser's hints (if any) in the specified format.
LIBYANG_API_DECL const void * lyplg_type_print_simple(const struct ly_ctx *ctx, const struct lyd_value *value, LY_VALUE_FORMAT format, void *prefix_data, ly_bool *dynamic, size_t *value_len)
Implementation of lyplg_type_print_clb for a generic simple type.
LIBYANG_API_DEF int lyplg_type_sort_simple(const struct ly_ctx *ctx, const struct lyd_value *val1, const struct lyd_value *val2)
Implementation of lyplg_type_sort_clb for a generic simple type.
LIBYANG_API_DECL LY_ERR lyplg_type_dup_simple(const struct ly_ctx *ctx, const struct lyd_value *original, struct lyd_value *dup)
Implementation of lyplg_type_dup_clb for a generic simple type.
LIBYANG_API_DECL void lyplg_type_free_simple(const struct ly_ctx *ctx, struct lyd_value *value)
Implementation of lyplg_type_free_clb for a generic simple type.
LIBYANG_API_DECL LY_ERR lyplg_type_compare_simple(const struct ly_ctx *ctx, const struct lyd_value *val1, const struct lyd_value *val2)
Implementation of lyplg_type_compare_clb for a generic simple type.
#define LYPLG_TYPE_STORE_DYNAMIC
#define LYPLG_TYPE_STORE_ONLY
LY_DATA_TYPE basetype
struct lysc_pattern ** patterns
struct lysc_range * length
Compiled YANG data node.
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition tree.h:234
@ LY_TYPE_STRING
Definition tree.h:209
@ LY_VALUE_CANON
Definition tree.h:235
LIBYANG_API_DEF LY_ERR lyplg_type_store_hex_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len, uint32_t options, LY_VALUE_FORMAT format, void *UNUSED(prefix_data), uint32_t hints, const struct lysc_node *UNUSED(ctx_node), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres), struct ly_err_item **err)
Definition hex_string.c:41
const struct lyplg_type_record plugins_hex_string[]
Plugin information for string type implementation.
Definition hex_string.c:115
The main libyang public header.
API for (user) types plugins.
const struct lysc_type * realtype
Definition tree_data.h:575
const char * _canonical
Definition tree_data.h:572
YANG data representation.
Definition tree_data.h:571