blob: 26d15993c2447e192217004c7d3fb1665709d978 [file] [log] [blame]
Radek Krejci70853c52018-10-15 14:46:16 +02001/**
2 * @file tree_schema_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
Michal Vaskodd992582021-06-10 14:34:57 +02006 * Copyright (c) 2015 - 2021 CESNET, z.s.p.o.
Radek Krejci70853c52018-10-15 14:46:16 +02007 *
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_SCHEMA_INTERNAL_H_
16#define LY_TREE_SCHEMA_INTERNAL_H_
17
Radek Krejci2d7a47b2019-05-16 13:34:10 +020018#include <stdint.h>
19
Radek Krejci535ea9f2020-05-29 16:01:05 +020020#include "common.h"
Radek Krejci2d7a47b2019-05-16 13:34:10 +020021#include "set.h"
22#include "tree_schema.h"
23
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020024struct lysc_ctx;
Michal Vasko405cc9e2020-12-01 12:01:27 +010025struct lys_glob_unres;
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020026
Radek Krejcif13b87b2020-12-01 22:02:17 +010027#define LY_YANG_SUFFIX ".yang"
28#define LY_YANG_SUFFIX_LEN 5
29#define LY_YIN_SUFFIX ".yin"
30#define LY_YIN_SUFFIX_LEN 4
31
FredGand944bdc2019-11-05 21:57:07 +080032#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
33
Radek Krejcif13b87b2020-12-01 22:02:17 +010034#define LY_PCRE2_MSG_LIMIT 256
35
Radek Krejci335332a2019-09-05 13:03:35 +020036/**
aPiecek93582ed2021-05-25 14:49:06 +020037 * @brief The maximum depth at which the last nested block is located.
38 * Designed to protect against corrupted input that causes a stack-overflow error.
39 * For yang language and json format, the block is bounded by "{ }".
40 * For the xml format, the opening and closing element tag is considered as the block.
41 */
42#define LY_MAX_BLOCK_DEPTH 500
43
44/**
Radek Krejcieccf6602021-02-05 19:42:54 +010045 * @brief Informational structure for YANG statements
46 */
47struct stmt_info_s {
48 const char *name; /**< name of the statement */
49 const char *arg; /**< name of YIN's attribute to present the statement */
50 uint8_t flags; /**< various flags to clarify printing of the statement */
51#define STMT_FLAG_YIN 0x1 /**< has YIN element */
52#define STMT_FLAG_ID 0x2 /**< the value is identifier -> no quotes */
53};
54
55/* statements informations filled in tree_schema.c */
56extern struct stmt_info_s stmt_attr_info[];
57
Radek Krejcieccf6602021-02-05 19:42:54 +010058/* list of the deviate modifications strings */
59extern const char * const ly_devmod_list[];
60#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
61
62/**
Radek Krejci335332a2019-09-05 13:03:35 +020063 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
64 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
65 * @param[in] CTX yang parser context to get current module and for logging.
66 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
67 * @param[in] PARENT parent statement where the KW is present - for logging.
68 */
69#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
Michal Vasko5d24f6c2020-10-13 13:49:06 +020070 if ((CTX)->parsed_mod->version < LYS_VERSION_1_1) {LOGVAL_PARSER((CTX), LY_VCODE_INCHILDSTMT2, KW, PARENT); return LY_EVALID;}
Radek Krejcid33273d2018-10-25 14:55:52 +020071
Radek Krejcia9026eb2018-12-12 16:04:47 +010072/* These 2 macros checks YANG's identifier grammar rule */
73#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
74#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020075 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010076
David Sedlák4a650532019-07-10 11:55:18 +020077/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020078#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020079 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
80 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
81 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
82 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
83 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
84 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
85 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
86 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
87 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
88
Radek Krejci70853c52018-10-15 14:46:16 +020089/**
David Sedlákca36c422019-07-12 12:47:55 +020090 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
91 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
92 *
93 * @param[in] CTX yang parser context for logging.
94 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
95 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
96 * @param[in] STMT Name of the compared YANG statements for logging.
97 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
98 */
99#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
100 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200101 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +0200102 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +0200103 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
104 return LY_EVALID; \
105 } \
106 } \
107 }
108
Michal Vaskob36053d2020-03-26 15:49:30 +0100109#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +0200110 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +0100111 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +0200112 }
Radek Krejci70853c52018-10-15 14:46:16 +0200113
Radek Krejcif13b87b2020-12-01 22:02:17 +0100114/*
115 * Additional YANG constants
116 */
117#define Y_TAB_SPACES 8 /**< number of spaces instead of tab character */
118#define LY_TYPE_DEC64_FD_MAX 18 /**< Maximal value of decimal64's fraction-digits */
119
Radek Krejci70853c52018-10-15 14:46:16 +0200120/**
Radek Krejcie3846472018-10-15 15:24:51 +0200121 * @brief List of YANG statement groups - the (sub)module's substatements
122 */
123enum yang_module_stmt {
124 Y_MOD_MODULE_HEADER,
125 Y_MOD_LINKAGE,
126 Y_MOD_META,
127 Y_MOD_REVISION,
128 Y_MOD_BODY
129};
130
131/**
132 * @brief Types of arguments of YANG statements
133 */
134enum yang_arg {
135 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +0100136 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +0200137 Y_STR_ARG, /**< YANG "string" rule */
138 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
139};
140
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200141#define PARSER_CTX(CTX) ((CTX)->parsed_mod->mod->ctx)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100142#define LOGVAL_PARSER(CTX, ...) LOGVAL((CTX) ? PARSER_CTX(CTX) : NULL, __VA_ARGS__)
Michal Vaskob36053d2020-03-26 15:49:30 +0100143
144struct lys_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200145 LYS_INFORMAT format; /**< parser format */
146 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
147 submodule, use ::lys_parser_ctx.main_ctx instead. */
148 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200149 submodule, use ::lys_parser_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200150 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
151 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
152 then should be set to the context of the module to which it belongs,
153 otherwise it points to the beginning of this structure. */
Michal Vaskob36053d2020-03-26 15:49:30 +0100154};
155
Radek Krejcie3846472018-10-15 15:24:51 +0200156/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200157 * @brief Internal context for yang schema parser.
Radek Krejci70853c52018-10-15 14:46:16 +0200158 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100159struct lys_yang_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200160 LYS_INFORMAT format; /**< parser format */
161 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
162 submodule, use ::lys_parser_ctx.main_ctx instead. */
163 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200164 submodule, use ::lys_parser_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200165 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
166 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
167 then should be set to the context of the module to which it belongs,
168 otherwise it points to the beginning of this structure. */
169 struct ly_in *in; /**< input handler for the parser */
170 uint64_t indent; /**< current position on the line for YANG indentation */
171 uint32_t depth; /**< current number of nested blocks, see ::LY_MAX_BLOCK_DEPTH */
Radek Krejci70853c52018-10-15 14:46:16 +0200172};
173
David Sedlákebd3acf2019-07-26 15:04:32 +0200174/**
175 * @brief free lys parser context.
176 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100177void yang_parser_ctx_free(struct lys_yang_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200178
179/**
180 * @brief Internal context for yin schema parser.
181 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100182struct lys_yin_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200183 LYS_INFORMAT format; /**< parser format */
184 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
185 submodule, use ::lys_parser_ctx.main_ctx instead. */
186 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200187 submodule, use ::lys_parser_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200188 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
189 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
190 then should be set to the context of the module to which it belongs,
191 otherwise it points to the beginning of this structure. */
192 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200193};
194
195/**
196 * @brief free yin parser context
197 *
198 * @param[in] ctx Context to free.
199 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100200void yin_parser_ctx_free(struct lys_yin_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200201
Michal Vasko7f45cf22020-10-01 12:49:44 +0200202/**
David Sedlák4a650532019-07-10 11:55:18 +0200203 * @brief Check that \p c is valid UTF8 code point for YANG string.
204 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100205 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200206 * @param[in] c UTF8 code point of a character to check.
207 * @return LY_ERR values.
208 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200209LY_ERR lysp_check_stringchar(struct lys_parser_ctx *ctx, uint32_t c);
David Sedlák4a650532019-07-10 11:55:18 +0200210
211/**
212 * @brief Check that \p c is valid UTF8 code point for YANG identifier.
213 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100214 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200215 * @param[in] c UTF8 code point of a character to check.
216 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
217 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
218 * 0 - colon not yet found (no prefix)
219 * 1 - \p c is the colon character
220 * 2 - prefix already processed, now processing the identifier
221 *
222 * If the identifier cannot be prefixed, NULL is expected.
223 * @return LY_ERR values.
224 */
Radek Krejci857189e2020-09-01 13:26:36 +0200225LY_ERR lysp_check_identifierchar(struct lys_parser_ctx *ctx, uint32_t c, ly_bool first, uint8_t *prefix);
David Sedlák4a650532019-07-10 11:55:18 +0200226
227/**
Radek Krejci70853c52018-10-15 14:46:16 +0200228 * @brief Check the currently present prefixes in the module for collision with the new one.
229 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100230 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100231 * @param[in] imports List of current imports of the module to check prefix collision.
232 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200233 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
234 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
235 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200236LY_ERR lysp_check_prefix(struct lys_parser_ctx *ctx, struct lysp_import *imports, const char *module_prefix, const char **value);
Radek Krejci70853c52018-10-15 14:46:16 +0200237
Radek Krejci86d106e2018-10-18 09:53:19 +0200238/**
239 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
240 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100241 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200242 * @param[in] date Date string to check (non-necessarily terminated by \0)
243 * @param[in] date_len Length of the date string, 10 expected.
244 * @param[in] stmt Statement name for error message.
245 * @return LY_ERR value.
246 */
Juraj Vijtiuk74dad9e2021-05-26 12:42:14 +0200247LY_ERR lysp_check_date(struct lys_parser_ctx *ctx, const char *date, size_t date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100248
249/**
250 * @brief Check names of typedefs in the parsed module to detect collisions.
251 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100252 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
253 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100254 * @return LY_ERR value.
255 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100256LY_ERR lysp_check_dup_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
257
258/**
aPiecek63e080d2021-06-29 13:53:28 +0200259 * @brief Check names of groupings in the parsed module to detect collisions.
260 *
261 * @param[in] ctx Parser context for logging and to maintain grps_nodes.
262 * @param[in] mod Module where the type is being defined.
263 * @return LY_ERR value.
264 */
265LY_ERR lysp_check_dup_groupings(struct lys_parser_ctx *ctx, struct lysp_module *mod);
266
267/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100268 * @brief Check names of features in the parsed module and submodules to detect collisions.
269 *
270 * @param[in] ctx Parser context.
271 * @param[in] mod Module where the type is being defined.
272 * @return LY_ERR value.
273 */
274LY_ERR lysp_check_dup_features(struct lys_parser_ctx *ctx, struct lysp_module *mod);
275
276/**
277 * @brief Check names of identities in the parsed module and submodules to detect collisions.
278 *
279 * @param[in] ctx Parser context.
280 * @param[in] mod Module where the type is being defined.
281 * @return LY_ERR value.
282 */
283LY_ERR lysp_check_dup_identities(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200284
285/**
286 * @brief Just move the newest revision into the first position, does not sort the rest
287 * @param[in] revs Sized-array of the revisions in a printable schema tree.
288 */
289void lysp_sort_revisions(struct lysp_revision *revs);
290
291/**
David Sedlák6544c182019-07-12 13:17:33 +0200292 * @brief Find type specified type definition.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100293 *
294 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
295 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
296 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100297 * @param[out] type Built-in type identifier of the id. If #LY_TYPE_UNKNOWN, tpdf is expected to contain found YANG schema typedef statement.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100298 * @param[out] tpdf Found type definition.
299 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100300 */
Michal Vaskoa99b3572021-02-01 11:54:58 +0100301LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, const struct lysp_module *start_module,
302 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100303
304/**
David Sedlák6544c182019-07-12 13:17:33 +0200305 * @brief Validate enum name.
306 *
307 * @param[in] ctx yang parser context for logging.
308 * @param[in] name String to check.
309 * @param[in] name_len Length of name.
310 *
311 * @return LY_ERR values
312 */
David Sedlák07869a52019-07-12 14:28:19 +0200313LY_ERR lysp_check_enum_name(struct lys_parser_ctx *ctx, const char *name, size_t name_len);
David Sedlák6544c182019-07-12 13:17:33 +0200314
315/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200316 * @brief Find source data for a specific module, parse it, and add into the context.
Radek Krejci086c7132018-10-26 15:29:04 +0200317 *
318 * @param[in] ctx libyang context.
319 * @param[in] name Name of the module to load.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200320 * @param[in] revision Optional revision of the module to load. If NULL, the newest revision is loaded.
Michal Vaskodd992582021-06-10 14:34:57 +0200321 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko18a86e52021-04-16 11:50:13 +0200322 * @param[out] mod Created module structure.
Michal Vasko4e205e82021-06-08 14:01:47 +0200323 * @return LY_SUCCESS on success.
324 * @return LY_ERR on error.
Radek Krejci086c7132018-10-26 15:29:04 +0200325 */
Michal Vaskodd992582021-06-10 14:34:57 +0200326LY_ERR lys_parse_load(struct ly_ctx *ctx, const char *name, const char *revision, struct ly_set *new_mods,
Michal Vasko4e205e82021-06-08 14:01:47 +0200327 struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200328
329/**
Radek Krejci771928a2021-01-19 13:42:36 +0100330 * @brief Parse included submodules into the simply parsed YANG module.
331 *
332 * YANG 1.0 does not require the main module to include all the submodules. Therefore, parsing submodules can cause
333 * reallocating and extending the includes array in the main module by the submodules included only in submodules.
Radek Krejcid33273d2018-10-25 14:55:52 +0200334 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200335 * @param[in] pctx main parser context
Radek Krejci771928a2021-01-19 13:42:36 +0100336 * @param[in] pmod Parsed module with the includes array to be processed.
aPiecekc3e26142021-06-22 14:25:49 +0200337 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Radek Krejcid33273d2018-10-25 14:55:52 +0200338 * @return LY_ERR value.
339 */
aPiecekc3e26142021-06-22 14:25:49 +0200340LY_ERR lysp_load_submodules(struct lys_parser_ctx *pctx, struct lysp_module *pmod, struct ly_set *new_mods);
Radek Krejcid33273d2018-10-25 14:55:52 +0200341
342/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200343 * @brief Free a parsed restriction.
344 *
345 * @param[in] ctx libyang context.
346 * @param[in] restr Restriction to free.
347 */
348void lysp_restr_free(struct ly_ctx *ctx, struct lysp_restr *restr);
349
350/**
351 * @brief Free a parsed qualified name.
352 *
353 * @param[in] ctx libyang context.
354 * @param[in] qname Qualified name to free.
355 */
356void lysp_qname_free(struct ly_ctx *ctx, struct lysp_qname *qname);
357
358/**
359 * @brief Free a parsed node.
360 *
361 * @param[in] ctx libyang context.
362 * @param[in] node Node to free.
363 */
364void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
365
366/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100367 * @brief Get address of a node's actions list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100368 * Decides the node's type and in case it has an actions list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100369 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100370 * @param[in] node Node to check.
371 * @return Address of the node's actions member if any, NULL otherwise.
372 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100373struct lysp_node_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100374
375/**
376 * @brief Get address of a node's notifications list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100377 * Decides the node's type and in case it has a notifications list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100378 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100379 * @param[in] node Node to check.
380 * @return Address of the node's notifs member if any, NULL otherwise.
381 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100382struct lysp_node_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100383
384/**
385 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100386 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100387 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100388 * @param[in] node Node to check.
389 * @return Address of the node's child member if any, NULL otherwise.
390 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100391struct lysp_node **lysp_node_child_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100392
393/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100394 * @brief Get the address of the node's musts member, if any.
395 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100396 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100397 * @param[in] node Node to examine.
398 * @return The address of the node's musts member if any, NULL otherwise.
399 */
400struct lysp_restr **lysp_node_musts_p(const struct lysp_node *node);
401
402/**
403 * @brief Get the node's musts member, if any.
404 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100405 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100406 * @param[in] node Node to examine.
407 * @return The node's musts member if any, NULL otherwise.
408 */
409struct lysp_restr *lysp_node_musts(const struct lysp_node *node);
410
411/**
412 * @brief Get the address of the node's when member, if any.
413 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100414 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100415 * @param[in] node Node to examine.
416 * @return The address of the node's when member if any, NULL otherwise.
417 */
418struct lysp_when **lysp_node_when_p(const struct lysp_node *node);
419
420/**
421 * @brief Get the node's when member, if any.
422 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100423 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100424 * @param[in] node Node to examine.
425 * @return The node's when member if any, NULL otherwise.
426 */
427struct lysp_when *lysp_node_when(const struct lysp_node *node);
428
429/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100430 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100431 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100432 *
433 * Do not use for RPC and action nodes.
434 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100435 * @param[in] node Node to check.
436 * @return Address of the node's child member if any, NULL otherwise.
437 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100438struct lysc_node **lysc_node_child_p(const struct lysc_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100439
440/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200441 * @brief Get address of a node's notifs pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200442 * Decides the node's type and in case it has a notifs array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100443 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200444 * @param[in] node Node to check.
445 * @return Address of the node's notifs member if any, NULL otherwise.
446 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100447struct lysc_node_notif **lysc_node_notifs_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200448
449/**
450 * @brief Get address of a node's actions pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200451 * Decides the node's type and in case it has a actions array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100452 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200453 * @param[in] node Node to check.
454 * @return Address of the node's actions member if any, NULL otherwise.
455 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100456struct lysc_node_action **lysc_node_actions_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200457
458/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100459 * @brief Get address of a node's when member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100460 * Decides the node's type and in case it has a when member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100461 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100462 * @param[in] node Node to check.
463 * @return Address of the node's when member if any, NULL otherwise.
464 */
465struct lysc_when ***lysc_node_when_p(const struct lysc_node *node);
466
467/**
468 * @brief Get address of a node's musts member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100469 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100470 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100471 * @param[in] node Node to check.
472 * @return Address of the node's musts member if any, NULL otherwise.
473 */
474struct lysc_must **lysc_node_musts_p(const struct lysc_node *node);
475
476/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100477 * @brief Find parsed extension definition for the given extension instance.
478 *
479 * @param[in] ctx libyang context.
480 * @param[in] ext Extension instance for which the definition will be searched.
481 * @param[in, out] ext_mod Pointer to the module where the extension definition of the @p ext to correctly resolve prefixes.
482 * @param[out] ext_def Pointer to return found extension definition.
483 * @return LY_SUCCESS when the definition was found.
484 * @return LY_EVALID when the extension instance is invalid and/or the definition not found.
485 */
486LY_ERR lysp_ext_find_definition(const struct ly_ctx *ctx, const struct lysp_ext_instance *ext, const struct lys_module **ext_mod,
487 struct lysp_ext **ext_def);
488
489/**
Radek Krejciba05eab2021-03-10 13:19:29 +0100490 * @brief Get schema node in extension instance according to the given parameters.
491 *
492 * Wraps ::lys_getnext_ext() and match according to the given arguments.
493 *
494 * @param[in] ext Extension instance which top-level schema node is being searched.
495 * @param[in] module Optional parameter to match the extension instance's (and its data) module.
496 * @param[in] name Name of the schema node to find, if the string is not NULL-terminated, the @p name_len must be set.
497 * @param[in] name_len Length of the @p name string, use in case the @p name is not NULL-terminated string.
498 * @param[in] nodetype Allowed [type of the node](@ref schemanodetypes).
499 * @param[in] options ORed [lys_getnext options](@ref sgetnextflags).
500 * @return Found schema node if there is some satisfy the provided requirements.
501 */
502const struct lysc_node *lysc_ext_find_node(const struct lysc_ext_instance *ext, const struct lys_module *module,
503 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
504
505/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100506 * @brief When the module comes from YIN format, the argument name is unknown because of missing extension definition
507 * (it might come from import modules which is not yet parsed at that time). Therefore, all the attributes are stored
508 * as substatements and resolving argument is postponed.
509 *
510 * There are 3 places which need the argument, so they resolve it when missing - YIN and YANG printers and extension instance
511 * compiler.
512 *
513 * @param[in] ctx libyang context
514 * @param[in] ext_p Parsed extension to be updated.
515 * @param[in] ext_def Extension definition, found with ::lysp_ext_find_definition().
516 * @return LY_ERR value.
517 */
518LY_ERR lysp_ext_instance_resolve_argument(struct ly_ctx *ctx, struct lysp_ext_instance *ext_p, struct lysp_ext *ext_def);
519
520/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200521 * @brief Iterate over the specified type of the extension instances
522 *
523 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
524 * @param[in] index Index in the \p ext array where to start searching (first call with 0, the consequent calls with
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200525 * the returned index increased by 1 (until the iteration is not terminated by returning LY_ARRAY_COUNT(ext).
Radek Krejcifc596f92021-02-26 22:40:26 +0100526 * @param[in] substmt The statement the extension is supposed to belong to.
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200527 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200528 */
Radek Krejcifc596f92021-02-26 22:40:26 +0100529LY_ARRAY_COUNT_TYPE lysp_ext_instance_iter(struct lysp_ext_instance *ext, LY_ARRAY_COUNT_TYPE index, enum ly_stmt substmt);
Radek Krejcid3ca0632019-04-16 16:54:54 +0200530
531/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100532 * @brief Get the covering schema module structure for the given parsed module structure.
Michal Vasko544e58a2021-01-28 14:33:41 +0100533 *
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100534 * @param[in] ctx libyang context to search.
535 * @param[in] mod Parsed schema structure.
536 * @return Corresponding lys_module structure for the given parsed schema structure.
537 */
538struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
539
540/**
Radek Krejci693262f2019-04-29 15:23:20 +0200541 * @brief Stringify YANG built-in type.
Michal Vasko1bf09392020-03-27 12:38:10 +0100542 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200543 * @return Constant string with the name of the built-in type.
544 */
545const char *lys_datatype2str(LY_DATA_TYPE basetype);
546
Michal Vasko405cc9e2020-12-01 12:01:27 +0100547/**
Michal Vasko65333882021-06-10 14:12:16 +0200548 * @brief Implement a module and resolve all global unres.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100549 *
550 * @param[in] mod Module to implement.
Michal Vasko4e205e82021-06-08 14:01:47 +0200551 * @param[in] features Features to set, see ::lys_set_features().
Michal Vasko65333882021-06-10 14:12:16 +0200552 * @param[in] unres Global unres with all the created modules.
553 * @return LY_SUCCESS on success.
Michal Vasko4e205e82021-06-08 14:01:47 +0200554 * @return LY_ERR on error.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100555 */
Michal Vasko65333882021-06-10 14:12:16 +0200556LY_ERR _lys_set_implemented(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
Michal Vasko405cc9e2020-12-01 12:01:27 +0100557
Michal Vaskof4258e12021-06-15 12:11:42 +0200558/**
559 * @brief Create dependency sets for all modules in a context.
Michal Vasko50bc09a2021-06-17 17:31:56 +0200560 * Also sets to_compile flags for all the modules that should be (re)compiled.
Michal Vaskof4258e12021-06-15 12:11:42 +0200561 *
562 * @param[in] ctx Context to use.
563 * @param[in,out] main_set Set of dependency module sets.
564 * @param[in] mod Optional only module whose dependency set is needed, otherwise all sets are created.
565 * @return LY_ERR value.
566 */
Michal Vasko50bc09a2021-06-17 17:31:56 +0200567LY_ERR lys_unres_dep_sets_create(struct ly_ctx *ctx, struct ly_set *main_set, struct lys_module *mod);
Michal Vaskof4258e12021-06-15 12:11:42 +0200568
569/**
570 * @brief Revert changes stored in global compile context after a failed compilation.
571 *
572 * @param[in] ctx libyang context.
573 * @param[in] unres Global unres to use.
574 */
575void lys_unres_glob_revert(struct ly_ctx *ctx, struct lys_glob_unres *unres);
576
577/**
578 * @brief Erase the global compile context.
579 *
580 * @param[in] unres Global unres to erase.
581 */
582void lys_unres_glob_erase(struct lys_glob_unres *unres);
583
Michal Vasko3a41dff2020-07-15 14:30:28 +0200584typedef LY_ERR (*lys_custom_check)(const struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod,
Radek Krejci0f969882020-08-21 16:56:47 +0200585 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100586
Radek Krejci693262f2019-04-29 15:23:20 +0200587/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200588 * @brief Parse a module and add it into the context.
Radek Krejcid33273d2018-10-25 14:55:52 +0200589 *
590 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200591 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200592 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejci9ed7a192018-10-31 16:23:51 +0100593 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
594 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vaskodd992582021-06-10 14:34:57 +0200595 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko7a0b0762020-09-02 16:37:01 +0200596 * @param[out] module Created module.
Michal Vaskodd992582021-06-10 14:34:57 +0200597 * @return LY_SUCCESS on success.
598 * @return LY_ERR on error, @p new_mods may be modified.
Radek Krejcid33273d2018-10-25 14:55:52 +0200599 */
Michal Vasko4e205e82021-06-08 14:01:47 +0200600LY_ERR lys_parse_in(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, lys_custom_check custom_check,
Michal Vaskodd992582021-06-10 14:34:57 +0200601 void *check_data, struct ly_set *new_mods, struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200602
603/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200604 * @brief Parse submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200605 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100606 * The latest_revision flag of submodule is updated.
607 *
608 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200609 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100610 * @param[in] format Format of the input data (YANG or YIN).
611 * @param[in] main_ctx Parser context of the main module.
612 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
613 * @param[in] check_data Caller's data to pass to the custom_check callback.
aPiecekc3e26142021-06-22 14:25:49 +0200614 * @param[in] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200615 * @param[out] submodule Parsed submodule.
616 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100617 */
Michal Vasko87f1cf02021-06-08 14:02:47 +0200618LY_ERR lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, struct lys_parser_ctx *main_ctx,
aPiecekc3e26142021-06-22 14:25:49 +0200619 lys_custom_check custom_check, void *check_data, struct ly_set *new_mods, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100620
621/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200622 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100623 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200624 * @param[in] ctx Context with dictionary where the filepath value will be stored.
625 * @param[in] in Input handler to examine (filepath is not available for all the input types).
626 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200627 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200628void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200629
630/**
Radek Krejci693262f2019-04-29 15:23:20 +0200631 * @brief Get the @ref ifftokens from the given position in the 2bits array
632 * (libyang format of the if-feature expression).
633 * @param[in] list The 2bits array with the compiled if-feature expression.
634 * @param[in] pos Position (0-based) to specify from which position get the operator.
635 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200636uint8_t lysc_iff_getop(uint8_t *list, size_t pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100637
638/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200639 * @brief Macro to free [sized array](@ref sizedarrays) of items using the provided free function. The ARRAY itself is also freed,
640 * but the memory is not sanitized.
641 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100642#define FREE_ARRAY(CTX, ARRAY, FUNC) {LY_ARRAY_COUNT_TYPE c__; LY_ARRAY_FOR(ARRAY, c__){(FUNC)(CTX, &(ARRAY)[c__]);}LY_ARRAY_FREE(ARRAY);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200643
644/**
645 * @brief Macro to free the specified MEMBER of a structure using the provided free function. The memory is not sanitized.
646 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100647#define FREE_MEMBER(CTX, MEMBER, FUNC) if (MEMBER) {(FUNC)(CTX, MEMBER);free(MEMBER);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200648
649/**
650 * @brief Macro to free [sized array](@ref sizedarrays) of strings stored in the context's dictionary. The ARRAY itself is also freed,
651 * but the memory is not sanitized.
652 */
Michal Vaskoe180ed02021-02-05 16:31:20 +0100653#define FREE_STRINGS(CTX, ARRAY) {LY_ARRAY_COUNT_TYPE c__; LY_ARRAY_FOR(ARRAY, c__){lydict_remove(CTX, ARRAY[c__]);}LY_ARRAY_FREE(ARRAY);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200654
655/**
Radek Krejci15f10ab2020-11-03 14:14:14 +0100656 * @brief Free the printable YANG schema tree structure. Works for both modules and submodules.
657 *
658 * @param[in] module Printable YANG schema tree structure to free.
659 */
660void lysp_module_free(struct lysp_module *module);
661
662/**
Radek Krejci38d85362019-09-05 16:26:38 +0200663 * @brief Free the parsed type structure.
664 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko8d544252020-03-02 10:19:52 +0100665 * @param[in] type Parsed schema type structure to free. Note that the type itself is not freed.
Radek Krejci38d85362019-09-05 16:26:38 +0200666 */
667void lysp_type_free(struct ly_ctx *ctx, struct lysp_type *type);
Radek Krejci335332a2019-09-05 13:03:35 +0200668
Radek Krejciad5963b2019-09-06 16:03:05 +0200669/**
Michal Vasko8d544252020-03-02 10:19:52 +0100670 * @brief Free the parsed extension instance structure.
671 * @param[in] ctx libyang context where the string data resides in a dictionary.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200672 * @param[in] ext Parsed extension instance structure to free. Note that the instance itself is not freed.
Michal Vasko8d544252020-03-02 10:19:52 +0100673 */
674void lysp_ext_instance_free(struct ly_ctx *ctx, struct lysp_ext_instance *ext);
675
676/**
Radek Krejci84d7fd72021-07-14 18:32:21 +0200677 * @brief Parse generic statement structure into a specific parsed-schema structure.
678 *
679 * @param[in] ctx The compilation context of the @p stmt being processed
680 * @param[in] stmt Generic statement structure to process.
681 * @param[out] result Specific parsed-schema structure for the given statement. For the specific type for the particular statement, check the function code.
Radek Krejciad5963b2019-09-06 16:03:05 +0200682 * @param[in,out] exts [sized array](@ref sizedarrays) For extension instances in case of statements that do not store extension instances in their own list.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200683 * @return LY_ERR value.
Radek Krejciad5963b2019-09-06 16:03:05 +0200684 */
Radek Krejci76c8c4e2021-02-17 10:16:48 +0100685LY_ERR lysp_stmt_parse(struct lysc_ctx *ctx, const struct lysp_stmt *stmt, void **result, struct lysp_ext_instance **exts);
Radek Krejci335332a2019-09-05 13:03:35 +0200686
Radek Krejcid33273d2018-10-25 14:55:52 +0200687/**
Michal Vasko20424b42020-08-31 12:29:38 +0200688 * @brief Free a parsed node.
689 *
690 * @param[in] ctx libyang context.
691 * @param[in] node Node to free.
692 */
693void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
694
695/**
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100696 * @brief Free a bit/enum item.
697 *
698 * @param[in] ctx libyang context.
699 * @param[in] item Bit/enum item to free.
700 */
701void lysc_enum_item_free(struct ly_ctx *ctx, struct lysc_type_bitenum_item *item);
702
703/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100704 * @brief Free the compiled type structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100705 *
Radek Krejcicdfecd92018-11-26 11:27:32 +0100706 * @param[in] ctx libyang context where the string data resides in a dictionary.
707 * @param[in,out] type Compiled type structure to be freed. The structure has refcount, so it is freed only in case the value is decreased to 0.
708 */
709void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
710
711/**
Radek Krejci0af46292019-01-11 16:02:31 +0100712 * @brief Free the compiled if-feature structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100713 *
Radek Krejci0af46292019-01-11 16:02:31 +0100714 * @param[in] ctx libyang context where the string data resides in a dictionary.
715 * @param[in,out] iff Compiled if-feature structure to be cleaned.
716 * Since the structure is typically part of the sized array, the structure itself is not freed.
717 */
718void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
719
720/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100721 * @brief Free the compiled identity structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100722 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100723 * @param[in] ctx libyang context where the string data resides in a dictionary.
724 * @param[in,out] ident Compiled identity structure to be cleaned.
725 * Since the structure is typically part of the sized array, the structure itself is not freed.
726 */
727void lysc_ident_free(struct ly_ctx *ctx, struct lysc_ident *ident);
728
729/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100730 * @brief Free the compiled must structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100731 *
Radek Krejciccd20f12019-02-15 14:12:27 +0100732 * @param[in] ctx libyang context where the string data resides in a dictionary.
733 * @param[in,out] must Compiled must structure to be cleaned.
734 * Since the structure is typically part of the sized array, the structure itself is not freed.
735 */
736void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
737
738/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100739 * @brief Free the data inside compiled input/output structure.
740 * @param[in] ctx libyang context where the string data resides in a dictionary.
741 * @param[in,out] inout Compiled inout structure to be cleaned.
742 * Since the structure is part of the RPC/action structure, it is not freed itself.
743 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100744void lysc_node_action_inout_free(struct ly_ctx *ctx, struct lysc_node_action_inout *inout);
Radek Krejcif538ce52019-03-05 10:46:14 +0100745
746/**
747 * @brief Free the data inside compiled RPC/action structure.
748 * @param[in] ctx libyang context where the string data resides in a dictionary.
749 * @param[in,out] action Compiled action structure to be cleaned.
750 * Since the structure is typically part of the sized array, the structure itself is not freed.
751 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100752void lysc_node_action_free(struct ly_ctx *ctx, struct lysc_node_action *action);
Radek Krejcif538ce52019-03-05 10:46:14 +0100753
754/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200755 * @brief Free the items inside the compiled Notification structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100756 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200757 * @param[in] ctx libyang context where the string data resides in a dictionary.
Radek Krejci720d2612021-03-03 19:44:22 +0100758 * @param[in,out] notif Compiled Notification structure to be cleaned.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200759 * Since the structure is typically part of the sized array, the structure itself is not freed.
760 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100761void lysc_node_notif_free(struct ly_ctx *ctx, struct lysc_node_notif *notif);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200762
763/**
Radek Krejci720d2612021-03-03 19:44:22 +0100764 * @brief Free the compiled extension definition and NULL the provided pointer.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100765 *
Radek Krejci720d2612021-03-03 19:44:22 +0100766 * @param[in] ctx libyang context where the string data resides in a dictionary.
aPiecekb0445f22021-06-24 11:34:07 +0200767 * @param[in,out] ext Compiled extension definition to be freed.
Radek Krejci720d2612021-03-03 19:44:22 +0100768 */
769void lysc_extension_free(struct ly_ctx *ctx, struct lysc_ext **ext);
770
771/**
Radek Krejci0af46292019-01-11 16:02:31 +0100772 * @brief Free the compiled extension instance structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100773 *
Radek Krejci0af46292019-01-11 16:02:31 +0100774 * @param[in] ctx libyang context where the string data resides in a dictionary.
775 * @param[in,out] ext Compiled extension instance structure to be cleaned.
776 * Since the structure is typically part of the sized array, the structure itself is not freed.
777 */
778void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
779
780/**
Radek Krejci19a96102018-11-15 13:38:09 +0100781 * @brief Free the compiled node structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100782 *
Radek Krejci19a96102018-11-15 13:38:09 +0100783 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100784 * @param[in] node Compiled node structure to be freed.
785 * @param[in] unlink Whether to first unlink the node before freeing.
Radek Krejci19a96102018-11-15 13:38:09 +0100786 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100787void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node, ly_bool unlink);
Radek Krejci19a96102018-11-15 13:38:09 +0100788
789/**
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200790 * @brief Free the compiled container node structure.
791 *
792 * Only the container-specific members are freed, for generic node free function,
Radek Krejci8678fa42020-08-18 16:07:28 +0200793 * use ::lysc_node_free().
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200794 *
795 * @param[in] ctx libyang context where the string data resides in a dictionary.
796 * @param[in,out] node Compiled container node structure to be freed.
797 */
798void lysc_node_container_free(struct ly_ctx *ctx, struct lysc_node_container *node);
799
800/**
Radek Krejci19a96102018-11-15 13:38:09 +0100801 * @brief Free the compiled schema structure.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100802 *
Radek Krejci19a96102018-11-15 13:38:09 +0100803 * @param[in,out] module Compiled schema module structure to free.
Radek Krejci19a96102018-11-15 13:38:09 +0100804 */
Radek Krejci90ed21e2021-04-12 14:47:46 +0200805void lysc_module_free(struct lysc_module *module);
Radek Krejci19a96102018-11-15 13:38:09 +0100806
807/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200808 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
Michal Vaskof4fa90d2021-11-11 15:05:19 +0100809 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200810 * @param[in,out] module Schema module structure to free.
Radek Krejci86d106e2018-10-18 09:53:19 +0200811 */
Radek Krejci90ed21e2021-04-12 14:47:46 +0200812void lys_module_free(struct lys_module *module);
Radek Krejci86d106e2018-10-18 09:53:19 +0200813
814/**
David Sedlák18e494b2018-12-17 03:58:39 +0100815 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200816 *
Michal Vasko63f3d842020-07-08 10:10:14 +0200817 * @param[in,out] in Input structure, is updated.
Radek Krejcid54412f2020-12-17 20:25:35 +0100818 * @param[in,out] indent Pointer to the counter of current position on the line for YANG indentation (optional).
Michal Vasko14654712020-02-06 08:35:21 +0100819 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100820 */
Radek Krejcid54412f2020-12-17 20:25:35 +0100821enum ly_stmt lysp_match_kw(struct ly_in *in, uint64_t *indent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200822
Michal Vasko14654712020-02-06 08:35:21 +0100823/**
824 * @brief Generate path of the given node in the requested format.
825 *
826 * @param[in] node Schema path of this node will be generated.
827 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
828 * @param[in] pathtype Format of the path to generate.
829 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
830 * If NULL, memory for the complete path is allocated.
831 * @param[in] buflen Size of the provided @p buffer.
832 * @return NULL in case of memory allocation error, path of the node otherwise.
833 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
834 */
835char *lysc_path_until(const struct lysc_node *node, const struct lysc_node *parent, LYSC_PATH_TYPE pathtype, char *buffer,
Radek Krejci0f969882020-08-21 16:56:47 +0200836 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100837
Michal Vasko62ed12d2020-05-21 10:08:25 +0200838/**
Michal Vasko72244882021-01-12 15:21:05 +0100839 * @brief Get nearest @p schema parent (including the node itself) that can be instantiated in data.
Michal Vasko62ed12d2020-05-21 10:08:25 +0200840 *
Michal Vasko72244882021-01-12 15:21:05 +0100841 * @param[in] schema Schema node to get the nearest data node for.
842 * @return Schema data node, NULL if top-level (in data).
Michal Vasko62ed12d2020-05-21 10:08:25 +0200843 */
Michal Vasko72244882021-01-12 15:21:05 +0100844const struct lysc_node *lysc_data_node(const struct lysc_node *schema);
845
846/**
847 * @brief Same as ::lysc_data_node() but never returns the node itself.
848 */
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100849#define lysc_data_parent(SCHEMA) lysc_data_node((SCHEMA)->parent)
Michal Vasko62ed12d2020-05-21 10:08:25 +0200850
Michal Vasko00cbf532020-06-15 13:58:47 +0200851/**
Radek Krejci239c38a2020-10-19 10:58:25 +0200852 * @brief Get format-specific prefix for a module.
853 *
Radek Krejci84d7fd72021-07-14 18:32:21 +0200854 * This function is available for type plugins via ::lyplg_type_get_prefix() API function.
Radek Krejci239c38a2020-10-19 10:58:25 +0200855 *
856 * @param[in] mod Module whose prefix to get.
857 * @param[in] format Format of the prefix.
Radek Krejci8df109d2021-04-23 12:19:08 +0200858 * @param[in] prefix_data Format-specific data based on @p format:
Radek Krejci224d4b42021-04-23 13:54:59 +0200859 * LY_VALUE_CANON - NULL
Radek Krejci84d7fd72021-07-14 18:32:21 +0200860 * LY_VALUE_SCHEMA - const struct ::lysp_module* (module used for resolving imports to prefixes)
861 * LY_VALUE_SCHEMA_RESOLVED - struct ::lysc_prefix* (sized array of pairs: prefix - module)
862 * LY_VALUE_XML - struct ::ly_set* (set of all returned modules as struct ::lys_module)
Radek Krejci8df109d2021-04-23 12:19:08 +0200863 * LY_VALUE_JSON - NULL
Radek Krejcif9943642021-04-26 10:18:21 +0200864 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200865 * @return Module prefix to print.
866 * @return NULL on error.
867 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200868const char *ly_get_prefix(const struct lys_module *mod, LY_VALUE_FORMAT format, void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200869
870/**
871 * @brief Resolve format-specific prefixes to modules.
872 *
Radek Krejci239c38a2020-10-19 10:58:25 +0200873 * @param[in] ctx libyang context.
874 * @param[in] prefix Prefix to resolve.
875 * @param[in] prefix_len Length of @p prefix.
876 * @param[in] format Format of the prefix.
Radek Krejcif9943642021-04-26 10:18:21 +0200877 * @param[in] prefix_data Format-specific data based on @p format:
878 * LY_VALUE_CANON - NULL
879 * LY_VALUE_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
880 * LY_VALUE_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
881 * LY_VALUE_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
882 * LY_VALUE_JSON - NULL
883 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200884 * @return Resolved prefix module,
885 * @return NULL otherwise.
886 */
Radek Krejcif9943642021-04-26 10:18:21 +0200887const struct lys_module *ly_resolve_prefix(const struct ly_ctx *ctx, const void *prefix, size_t prefix_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200888 LY_VALUE_FORMAT format, const void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200889
Michal Vaskof4258e12021-06-15 12:11:42 +0200890/**
891 * @brief Learn whether @p PMOD needs to be recompiled if it is implemented.
892 *
893 * @param[in] PMOD Parsed module or submodule.
894 * @return Whether it has statements that are recompiled or not.
895 */
896#define LYSP_HAS_RECOMPILED(PMOD) \
897 (PMOD->data || PMOD->rpcs || PMOD->notifs || PMOD->exts)
898
899/**
900 * @brief Learn whether the module has statements that need to be recompiled or not.
901 *
902 * @param[in] mod Module to examine.
903 * @return Whether it has statements that are recompiled or not.
904 */
905ly_bool lys_has_recompiled(const struct lys_module *mod);
906
907/**
908 * @brief Learn whether @p PMOD needs to be compiled if it is implemented.
909 *
910 * @param[in] PMOD Parsed module or submodule.
911 * @return Whether it needs (has) a compiled module or not.
912 */
913#define LYSP_HAS_COMPILED(PMOD) \
aPiecek6b3d5422021-07-30 15:55:43 +0200914 (LYSP_HAS_RECOMPILED(PMOD) || PMOD->augments || PMOD->deviations)
Michal Vaskof4258e12021-06-15 12:11:42 +0200915
916/**
917 * @brief Learn whether the module has statements that need to be compiled or not.
918 *
919 * @param[in] mod Module to examine.
920 * @return Whether it needs compiled module or not.
921 */
922ly_bool lys_has_compiled(const struct lys_module *mod);
923
Michal Vasko7ee5be22021-06-16 17:03:34 +0200924/**
925 * @brief Learn whether the module has any grouping statements or not.
926 *
927 * @param[in] mod Module to examine.
928 * @return Whether it has groupings or not.
929 */
930ly_bool lys_has_groupings(const struct lys_module *mod);
931
Michal Vaskof8b1b0d2021-11-22 09:59:57 +0100932/**
933 * @brief Learn whether the module qualifies for a single dep set with only this module or not.
934 *
935 * @param[in] mod Module to examine.
936 * @return Whether it qualifies as a single dep set or not.
937 */
938#define LYS_IS_SINGLE_DEP_SET(mod) \
939 (!(mod)->parsed->features && (!lys_has_compiled(mod) || ((mod)->compiled && !lys_has_recompiled(mod))))
940
Radek Krejci70853c52018-10-15 14:46:16 +0200941#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */