libyang  2.1.148
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 "common.h"
25 #include "compat.h"
26 #include "plugins_internal.h" /* LY_TYPE_*_STR */
27 
45 static LY_ERR
46 string_check_chars(const char *value, size_t value_len, struct ly_err_item **err)
47 {
48  size_t len, parsed = 0;
49 
50  while (value_len - parsed) {
51  if (ly_checkutf8(value + parsed, value_len - parsed, &len)) {
52  return ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Invalid character 0x%hhx.", value[parsed]);
53  }
54  parsed += len;
55  }
56 
57  return LY_SUCCESS;
58 }
59 
60 LIBYANG_API_DEF LY_ERR
61 lyplg_type_store_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len,
62  uint32_t options, LY_VALUE_FORMAT UNUSED(format), void *UNUSED(prefix_data), uint32_t hints,
63  const struct lysc_node *UNUSED(ctx_node), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres),
64  struct ly_err_item **err)
65 {
66  LY_ERR ret = LY_SUCCESS;
67  struct lysc_type_str *type_str = (struct lysc_type_str *)type;
68 
69  /* init storage */
70  memset(storage, 0, sizeof *storage);
71  storage->realtype = type;
72 
73  if (!(options & LYPLG_TYPE_STORE_IS_UTF8)) {
74  /* check the UTF-8 encoding */
75  ret = string_check_chars(value, value_len, err);
76  LY_CHECK_GOTO(ret, cleanup);
77  }
78 
79  /* check hints */
80  ret = lyplg_type_check_hints(hints, value, value_len, type->basetype, NULL, err);
81  LY_CHECK_GOTO(ret, cleanup);
82 
83  /* length restriction of the string */
84  if (type_str->length) {
85  /* value_len is in bytes, but we need number of characters here */
86  ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_len), value, value_len, err);
87  LY_CHECK_GOTO(ret, cleanup);
88  }
89 
90  /* pattern restrictions */
91  ret = lyplg_type_validate_patterns(type_str->patterns, value, value_len, err);
92  LY_CHECK_GOTO(ret, cleanup);
93 
94  /* store canonical value */
95  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
96  ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
97  options &= ~LYPLG_TYPE_STORE_DYNAMIC;
98  LY_CHECK_GOTO(ret, cleanup);
99  } else {
100  ret = lydict_insert(ctx, value_len ? value : "", value_len, &storage->_canonical);
101  LY_CHECK_GOTO(ret, cleanup);
102  }
103 
104 cleanup:
105  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
106  free((void *)value);
107  }
108 
109  if (ret) {
110  lyplg_type_free_simple(ctx, storage);
111  }
112  return ret;
113 }
114 
123  {
124  .module = "",
125  .revision = NULL,
126  .name = LY_TYPE_STRING_STR,
127 
128  .plugin.id = "libyang 2 - string, version 1",
129  .plugin.store = lyplg_type_store_string,
130  .plugin.validate = NULL,
131  .plugin.compare = lyplg_type_compare_simple,
132  .plugin.sort = NULL,
133  .plugin.print = lyplg_type_print_simple,
134  .plugin.duplicate = lyplg_type_dup_simple,
135  .plugin.free = lyplg_type_free_simple,
136  .plugin.lyb_data_len = -1,
137  },
138  {0}
139 };
LIBYANG_API_DECL LY_ERR lyplg_type_compare_simple(const struct lyd_value *val1, const struct lyd_value *val2)
Implementation of lyplg_type_compare_clb for a generic simple type.
Compiled YANG data node.
Definition: tree_schema.h:1414
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:61
LIBYANG_API_DECL LY_ERR ly_err_new(struct ly_err_item **err, LY_ERR ecode, LY_VECODE vecode, char *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.
#define LYPLG_TYPE_STORE_DYNAMIC
The main libyang public header.
struct lysc_pattern ** patterns
Definition: tree_schema.h:1327
struct lysc_range * length
Definition: tree_schema.h:1326
YANG data representation.
Definition: tree_data.h:560
const char * _canonical
Definition: tree_data.h:561
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 full error structure.
Definition: log.h:296
const struct lysc_type * realtype
Definition: tree_data.h:564
Definition: log.h:288
Definition: log.h:259
#define LYPLG_TYPE_STORE_IS_UTF8
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 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&#39;s hints (if any) in the specified format.
const char * module
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, only a reference counter is incremented and no memory allocation is performed. This insert function variant avoids duplication of specified value - it is inserted into the dictionary directly.
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition: tree.h:234
LY_DATA_TYPE basetype
Definition: tree_schema.h:1299
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.
LY_ERR
libyang&#39;s error codes returned by the libyang functions.
Definition: log.h:251
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.
const struct lyplg_type_record plugins_string[]
Plugin information for string type implementation.
Definition: string.c:122
API for (user) types plugins.
libyang context handler.
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.