blob: 5adeac9b96913f8353f19a1b59f9b32fa482c798 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
6 * Copyright (c) 2015 - 2019 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_DATA_INTERNAL_H_
16#define LY_TREE_DATA_INTERNAL_H_
17
18#include "tree_data.h"
Radek Krejciaca74032019-06-04 08:53:06 +020019#include "plugins_types.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020020
21/**
22 * @brief Get address of a node's child pointer if any.
23 *
24 * Decides the node's type and in case it has a children list, returns its address.
25 * @param[in] node Node to check.
26 * @return Address of the node's child member if any, NULL otherwise.
27 */
28struct lyd_node **lyd_node_children_p(struct lyd_node *node);
29
30/**
31 * @brief Check validity of data parser options.
32 *
33 * @param ctx libyang context
34 * @param options Data parser options to check
35 * @param func name of the function where called
36 * @return LY_SUCCESS when options are ok
37 * @return LY_EINVAL when multiple data types bits are set, or incompatible options are used together.
38 */
39LY_ERR lyd_parse_check_options(struct ly_ctx *ctx, int options, const char *func);
40
41/**
Radek Krejci5819f7c2019-05-31 14:53:29 +020042 * @brief Validate, canonize and store the given @p value into the node according to the node's type's rules.
Radek Krejcie7b95092019-05-15 11:03:07 +020043 *
Radek Krejci5819f7c2019-05-31 14:53:29 +020044 * @param[in] node Data node for with the @p value.
Radek Krejci084289f2019-07-09 17:35:30 +020045 * @param[in] value String value to be parsed, must not be NULL.
Radek Krejci5819f7c2019-05-31 14:53:29 +020046 * @param[in] value_len Length of the give @p value (mandatory).
47 * @param[in] dynamic Flag if @p value is a dynamically allocated memory and should be directly consumed/freed inside the function.
Radek Krejci3c9758d2019-07-11 16:49:10 +020048 * @param[in] second Flag for the second call after returning LY_EINCOMPLETE
Radek Krejci084289f2019-07-09 17:35:30 +020049 * @param[in] get_prefix Parser-specific getter to resolve prefixes used in the @p value string.
Radek Krejciaca74032019-06-04 08:53:06 +020050 * @param[in] parser Parser's data for @p get_prefix
Radek Krejci084289f2019-07-09 17:35:30 +020051 * @param[in] format Input format of the data.
Radek Krejcie553e6d2019-06-07 15:33:18 +020052 * @param[in] trees ([Sized array](@ref sizedarrays)) of data trees (e.g. when validating RPC/Notification) where the required
53 * data instance (leafref target, instance-identifier) can be placed. NULL in case the data tree are not yet complete,
54 * then LY_EINCOMPLETE can be returned.
55 * @return LY_SUCCESS on success
56 * @return LY_EINCOMPLETE in case the @p trees is not provided and it was needed to finish the validation.
57 * @return LY_ERR value if an error occurred.
Radek Krejcie7b95092019-05-15 11:03:07 +020058 */
Radek Krejci3c9758d2019-07-11 16:49:10 +020059LY_ERR lyd_value_parse(struct lyd_node_term *node, const char *value, size_t value_len, int dynamic, int second,
Radek Krejci576b23f2019-07-12 14:06:32 +020060 ly_clb_resolve_prefix get_prefix, void *parser, LYD_FORMAT format, const struct lyd_node **trees);
Radek Krejcie7b95092019-05-15 11:03:07 +020061
62/**
63 * @brief Parse XML string as YANG data tree.
64 *
65 * @param[in] ctx libyang context
66 * @param[in] data Pointer to the XML string representation of the YANG data to parse.
67 * @param[in] options @ref dataparseroptions
68 * @param[out] result Resulting list of the parsed data trees. Note that NULL can be a valid result.
69 * @reutn LY_ERR value.
70 */
71LY_ERR lyd_parse_xml(struct ly_ctx *ctx, const char *data, int options, struct lyd_node **result);
72
73/**
74 * @defgroup datahash Data nodes hash manipulation
75 * @ingroup datatree
76 */
77
78/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +020079 * @brief Generate hash for the node.
80 *
81 * @param[in] node Data node to (re)generate hash value.
82 * @return LY_ERR value.
83 */
84LY_ERR lyd_hash(struct lyd_node *node);
85
86/**
87 * @brief Insert hash of the node into the hash table of its parent.
88 *
89 * @param[in] node Data node which hash will be inserted into the lyd_node_inner::children_hash hash table of its parent.
90 * @return LY_ERR value.
91 */
92LY_ERR lyd_insert_hash(struct lyd_node *node);
93
94/**
Radek Krejcie7b95092019-05-15 11:03:07 +020095 * @brief Maintain node's parent's children hash table when unlinking the node.
96 *
97 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
98 *
99 * @param[in] node The data node being unlinked from its parent.
100 */
101void lyd_unlink_hash(struct lyd_node *node);
102
103/** @} datahash */
104
Radek Krejci084289f2019-07-09 17:35:30 +0200105/**
106 * @brief Free path (target) structure of the lyd_value.
107 *
108 * @param[in] ctx libyang context.
109 * @param[in] path The structure ([sized array](@ref sizedarrays)) to free.
110 */
111void lyd_value_free_path(struct ly_ctx *ctx, struct lyd_value_path *path);
112
Radek Krejcie7b95092019-05-15 11:03:07 +0200113#endif /* LY_TREE_DATA_INTERNAL_H_ */