blob: 8e6e0a591e1bfa81316b81f9818f29bbbaebce23 [file] [log] [blame]
Michal Vasko1a7a7bd2020-10-16 14:39:15 +02001/**
2 * @file schema_compile_node.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief Header for schema compilation of common nodes.
5 *
6 * Copyright (c) 2015 - 2020 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_SCHEMA_COMPILE_NODE_H_
16#define LY_SCHEMA_COMPILE_NODE_H_
17
18#include <stddef.h>
Radek Krejci47fab892020-11-05 17:02:41 +010019#include <stdint.h>
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020020
21#include "log.h"
Radek Krejci77114102021-03-10 15:21:57 +010022#include "tree.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020023#include "tree_schema.h"
24
Radek Krejci47fab892020-11-05 17:02:41 +010025struct ly_ctx;
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020026struct ly_set;
27struct lysc_ctx;
28
29/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020030 * @brief Compile information from the when statement by either standard compilation or by reusing
31 * another compiled when structure.
32 *
33 * @param[in] ctx Compile context.
34 * @param[in] when_p Parsed when structure.
35 * @param[in] flags Flags of the parsed node with the when statement.
36 * @param[in] ctx_node Context node for the when statement.
37 * @param[in] node Compiled node to which add the compiled when.
38 * @param[in,out] when_c Optional, pointer to the previously compiled @p when_p to be reused. Set to NULL
39 * for the first call.
40 * @return LY_ERR value.
41 */
42LY_ERR lys_compile_when(struct lysc_ctx *ctx, struct lysp_when *when_p, uint16_t flags, const struct lysc_node *ctx_node,
43 struct lysc_node *node, struct lysc_when **when_c);
44
45/**
46 * @brief Checks pattern syntax.
47 *
48 * @param[in] ctx Context.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020049 * @param[in] pattern Pattern to check.
50 * @param[in,out] pcre2_code Compiled PCRE2 pattern. If NULL, the compiled information used to validate pattern are freed.
51 * @return LY_ERR value - LY_SUCCESS, LY_EMEM, LY_EVALID.
52 */
Radek Krejci2efc45b2020-12-22 16:25:44 +010053LY_ERR lys_compile_type_pattern_check(struct ly_ctx *ctx, const char *pattern, pcre2_code **code);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020054
55/**
56 * @brief Compile information about the leaf/leaf-list's type.
57 *
58 * @param[in] ctx Compile context.
59 * @param[in] context_pnode Schema node where the type/typedef is placed to correctly find the base types.
60 * @param[in] context_flags Flags of the context node or the referencing typedef to correctly check status of referencing and referenced objects.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020061 * @param[in] context_name Name of the context node or referencing typedef for logging.
62 * @param[in] type_p Parsed type to compile.
63 * @param[out] type Newly created (or reused with increased refcount) type structure with the filled information about the type.
64 * @param[out] units Storage for inheriting units value from the typedefs the current type derives from.
65 * @param[out] dflt Default value for the type.
66 * @return LY_ERR value.
67 */
68LY_ERR lys_compile_type(struct lysc_ctx *ctx, struct lysp_node *context_pnode, uint16_t context_flags,
Michal Vaskoa99b3572021-02-01 11:54:58 +010069 const char *context_name, struct lysp_type *type_p, struct lysc_type **type, const char **units,
70 struct lysp_qname **dflt);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020071
72/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020073 * @brief Find the node according to the given descendant/absolute schema nodeid.
74 * Used in unique, refine and augment statements.
75 *
76 * @param[in] ctx Compile context
77 * @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
78 * @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
79 * @param[in] ctx_node Context node for a relative nodeid.
80 * @param[in] cur_mod Current module for the nodeid (where it was "instantiated").
81 * @param[in] format Format of any prefixes.
82 * @param[in] prefix_data Format-specific prefix data (see ::ly_resolve_prefix).
83 * @param[in] nodetype Optional (can be 0) restriction for target's nodetype. If target exists, but does not match
84 * the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
85 * The value can be even an ORed value to allow multiple nodetypes.
86 * @param[out] target Found target node if any.
87 * @param[out] result_flag Output parameter to announce if the schema nodeid goes through the action's input/output or a Notification.
88 * The LYSC_OPT_RPC_INPUT, LYSC_OPT_RPC_OUTPUT and LYSC_OPT_NOTIFICATION are used as flags.
89 * @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
90 */
91LY_ERR lysc_resolve_schema_nodeid(struct lysc_ctx *ctx, const char *nodeid, size_t nodeid_len,
Radek Krejci8df109d2021-04-23 12:19:08 +020092 const struct lysc_node *ctx_node, const struct lys_module *cur_mod, LY_VALUE_FORMAT format, void *prefix_data,
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020093 uint16_t nodetype, const struct lysc_node **target, uint16_t *result_flag);
94
95/**
96 * @brief Compile choice children.
97 *
98 * @param[in] ctx Compile context
99 * @param[in] child_p Parsed choice children nodes.
100 * @param[in] node Compiled choice node to compile and add children to.
101 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
102 */
103LY_ERR lys_compile_node_choice_child(struct lysc_ctx *ctx, struct lysp_node *child_p, struct lysc_node *node,
104 struct ly_set *child_set);
105
106/**
107 * @brief Set LYS_MAND_TRUE flag for the non-presence container parents.
108 *
109 * A non-presence container is mandatory in case it has at least one mandatory children. This function propagate
110 * the flag to such parents from a mandatory children.
111 *
112 * @param[in] parent A schema node to be examined if the mandatory child make it also mandatory.
113 * @param[in] add Flag to distinguish adding the mandatory flag (new mandatory children appeared) or removing the flag
114 * (mandatory children was removed).
115 */
116void lys_compile_mandatory_parents(struct lysc_node *parent, ly_bool add);
117
118/**
119 * @brief Validate grouping that was defined but not used in the schema itself.
120 *
121 * The grouping does not need to be compiled (and it is compiled here, but the result is forgotten immediately),
122 * but to have the complete result of the schema validity, even such groupings are supposed to be checked.
123 *
124 * @param[in] ctx Compile context.
125 * @param[in] pnode Parsed parent node of the grouping, NULL for top-level.
126 * @param[in] grp Parsed grouping node to check.
127 * @return LY_ERR value.
128 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100129LY_ERR lys_compile_grouping(struct lysc_ctx *ctx, struct lysp_node *pnode, struct lysp_node_grp *grp);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200130
131/**
132 * @brief Compile parsed schema node information.
133 *
134 * @param[in] ctx Compile context
135 * @param[in] pnode Parsed schema node.
136 * @param[in] parent Compiled parent node where the current node is supposed to be connected. It is
137 * NULL for top-level nodes, in such a case the module where the node will be connected is taken from
138 * the compile context.
139 * @param[in] uses_status If the node is being placed instead of uses, here we have the uses's status value (as node's flags).
140 * Zero means no uses, non-zero value with no status bit set mean the default status.
141 * @param[in,out] child_set Optional set to add all the compiled nodes into (can be more in case of uses).
142 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
143 */
144LY_ERR lys_compile_node(struct lysc_ctx *ctx, struct lysp_node *pnode, struct lysc_node *parent, uint16_t uses_status,
145 struct ly_set *child_set);
146
147#endif /* LY_SCHEMA_COMPILE_NODE_H_ */