libyang  2.1.30
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
string.c
Go to the documentation of this file.
1 
15 #include "plugins_types.h"
16 
17 #include <stdint.h>
18 #include <stdlib.h>
19 
20 #include "libyang.h"
21 
22 /* additional internal headers for some useful simple macros */
23 #include "common.h"
24 #include "compat.h"
25 #include "plugins_internal.h" /* LY_TYPE_*_STR */
26 
36 LIBYANG_API_DEF LY_ERR
37 lyplg_type_store_string(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len,
38  uint32_t options, LY_VALUE_FORMAT UNUSED(format), void *UNUSED(prefix_data), uint32_t hints,
39  const struct lysc_node *UNUSED(ctx_node), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres),
40  struct ly_err_item **err)
41 {
42  LY_ERR ret = LY_SUCCESS;
43  struct lysc_type_str *type_str = (struct lysc_type_str *)type;
44 
45  /* init storage */
46  memset(storage, 0, sizeof *storage);
47  storage->realtype = type;
48 
49  /* check hints */
50  ret = lyplg_type_check_hints(hints, value, value_len, type->basetype, NULL, err);
51  LY_CHECK_GOTO(ret, cleanup);
52 
53  /* length restriction of the string */
54  if (type_str->length) {
55  /* value_len is in bytes, but we need number of characters here */
56  ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_len), value, value_len, err);
57  LY_CHECK_GOTO(ret, cleanup);
58  }
59 
60  /* pattern restrictions */
61  ret = lyplg_type_validate_patterns(type_str->patterns, value, value_len, err);
62  LY_CHECK_GOTO(ret, cleanup);
63 
64  /* store canonical value */
65  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
66  ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
67  options &= ~LYPLG_TYPE_STORE_DYNAMIC;
68  LY_CHECK_GOTO(ret, cleanup);
69  } else {
70  ret = lydict_insert(ctx, value_len ? value : "", value_len, &storage->_canonical);
71  LY_CHECK_GOTO(ret, cleanup);
72  }
73 
74 cleanup:
75  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
76  free((void *)value);
77  }
78 
79  if (ret) {
80  lyplg_type_free_simple(ctx, storage);
81  }
82  return ret;
83 }
84 
93  {
94  .module = "",
95  .revision = NULL,
96  .name = LY_TYPE_STRING_STR,
97 
98  .plugin.id = "libyang 2 - string, version 1",
99  .plugin.store = lyplg_type_store_string,
100  .plugin.validate = NULL,
101  .plugin.compare = lyplg_type_compare_simple,
102  .plugin.sort = NULL,
103  .plugin.print = lyplg_type_print_simple,
104  .plugin.duplicate = lyplg_type_dup_simple,
105  .plugin.free = lyplg_type_free_simple,
106  .plugin.lyb_data_len = -1,
107  },
108  {0}
109 };
struct lysc_type * realtype
Definition: tree_data.h:564
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_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:299
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 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 format, void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node, struct lyd_value *storage, struct lys_glob_unres *unres, struct ly_err_item **err)
Implementation of lyplg_type_store_clb for the built-in string type.
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
struct lyplg_type_record plugins_string[]
Plugin information for string type implementation.
Definition: string.c:92
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:254
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.
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.