libyang  3.13.6
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
string.c
Go to the documentation of this file.
1 
16 #include "plugins_types.h"
17 
18 #include <stdint.h>
19 #include <stdlib.h>
20 
21 #include "libyang.h"
22 
23 /* additional internal headers for some useful simple macros */
24 #include "compat.h"
25 #include "ly_common.h"
26 #include "plugins_internal.h" /* LY_TYPE_*_STR */
27 
37 static LY_ERR lyplg_type_validate_string(const struct ly_ctx *UNUSED(ctx), const struct lysc_type *type, const struct lyd_node *UNUSED(ctx_node), const struct lyd_node *UNUSED(tree), struct lyd_value *storage, struct ly_err_item **err);
38 
47 static LY_ERR
48 string_check_chars(const char *value, size_t value_len, struct ly_err_item **err)
49 {
50  size_t len, parsed = 0;
51 
52  while (value_len - parsed) {
53  if (ly_checkutf8(value + parsed, value_len - parsed, &len)) {
54  return ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Invalid character 0x%hhx.", value[parsed]);
55  }
56  parsed += len;
57  }
58 
59  return LY_SUCCESS;
60 }
61 
62 LIBYANG_API_DEF LY_ERR
63 lyplg_type_store_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len,
64  uint32_t options, LY_VALUE_FORMAT UNUSED(format), void *UNUSED(prefix_data), uint32_t hints,
65  const struct lysc_node *UNUSED(ctx_node), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres),
66  struct ly_err_item **err)
67 {
68  LY_ERR ret = LY_SUCCESS;
69 
70  /* init storage */
71  memset(storage, 0, sizeof *storage);
72  storage->realtype = type;
73 
74  if (!(options & LYPLG_TYPE_STORE_IS_UTF8)) {
75  /* check the UTF-8 encoding */
76  ret = string_check_chars(value, value_len, err);
77  LY_CHECK_GOTO(ret, cleanup);
78  }
79 
80  /* check hints */
81  ret = lyplg_type_check_hints(hints, value, value_len, type->basetype, NULL, err);
82  LY_CHECK_GOTO(ret, cleanup);
83 
84  /* store canonical value */
85  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
86  ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
87  options &= ~LYPLG_TYPE_STORE_DYNAMIC;
88  LY_CHECK_GOTO(ret, cleanup);
89 
90  /* value may have been freed */
91  value = storage->_canonical;
92  } else {
93  ret = lydict_insert(ctx, value_len ? value : "", value_len, &storage->_canonical);
94  LY_CHECK_GOTO(ret, cleanup);
95  }
96 
97  if (!(options & LYPLG_TYPE_STORE_ONLY)) {
98  /* validate value */
99  ret = lyplg_type_validate_string(ctx, type, NULL, NULL, storage, err);
100  LY_CHECK_GOTO(ret, cleanup);
101  }
102 
103 cleanup:
104  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
105  free((void *)value);
106  }
107 
108  if (ret) {
109  lyplg_type_free_simple(ctx, storage);
110  }
111  return ret;
112 }
113 
117 static LY_ERR
118 lyplg_type_validate_string(const struct ly_ctx *ctx, const struct lysc_type *type, const struct lyd_node *UNUSED(ctx_node),
119  const struct lyd_node *UNUSED(tree), struct lyd_value *storage, struct ly_err_item **err)
120 {
121  LY_ERR ret;
122  struct lysc_type_str *type_str = (struct lysc_type_str *)type;
123  const void *value;
124  size_t value_len;
125 
126  LY_CHECK_ARG_RET(NULL, type, storage, err, LY_EINVAL);
127  value = lyd_value_get_canonical(ctx, storage);
128  value_len = strlen(value);
129  *err = NULL;
130 
131  /* length restriction of the string */
132  if (type_str->length) {
133  /* value_len is in bytes, but we need number of characters here */
134  ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_len), value, value_len, err);
135  LY_CHECK_RET(ret);
136  }
137 
138  /* pattern restrictions */
139  ret = lyplg_type_validate_patterns(type_str->patterns, value, value_len, err);
140  LY_CHECK_RET(ret);
141 
142  return LY_SUCCESS;
143 }
144 
152 const struct lyplg_type_record plugins_string[] = {
153  {
154  .module = "",
155  .revision = NULL,
156  .name = LY_TYPE_STRING_STR,
157 
158  .plugin.id = "libyang 2 - string, version 1",
159  .plugin.store = lyplg_type_store_string,
160  .plugin.validate = lyplg_type_validate_string,
161  .plugin.compare = lyplg_type_compare_simple,
162  .plugin.sort = lyplg_type_sort_simple,
163  .plugin.print = lyplg_type_print_simple,
164  .plugin.duplicate = lyplg_type_dup_simple,
165  .plugin.free = lyplg_type_free_simple,
166  .plugin.lyb_data_len = -1,
167  },
168  {0}
169 };
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
@ LYVE_DATA
Definition: log.h:274
@ LY_EINVAL
Definition: log.h:241
@ LY_EVALID
Definition: log.h:245
@ LY_SUCCESS
Definition: log.h:238
Libyang full error structure.
Definition: log.h:282
const char * module
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 LY_ERR ly_err_new(struct ly_err_item **err, LY_ERR ecode, LY_VECODE vecode, char *data_path, char *apptag, const char *err_format,...) _FORMAT_PRINTF(6
Create and fill error structure.
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_IS_UTF8
#define LYPLG_TYPE_STORE_ONLY
LY_DATA_TYPE basetype
Definition: tree_schema.h:1287
struct lysc_pattern ** patterns
Definition: tree_schema.h:1321
struct lysc_range * length
Definition: tree_schema.h:1320
Compiled YANG data node.
Definition: tree_schema.h:1421
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
The main libyang public header.
API for (user) types plugins.
const struct lyplg_type_record plugins_string[]
Plugin information for string type implementation.
Definition: string.c:152
LIBYANG_API_DEF LY_ERR lyplg_type_store_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len, uint32_t options, LY_VALUE_FORMAT UNUSED(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: string.c:63
const struct lysc_type * realtype
Definition: tree_data.h:571
LIBYANG_API_DECL const char * lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value)
Get the (canonical) value of a lyd_value.
const char * _canonical
Definition: tree_data.h:568
Generic structure for a data node.
Definition: tree_data.h:795
YANG data representation.
Definition: tree_data.h:567