blob: 9ed3b3fbd9ad09f035a27d03ff14e4785c4dc199 [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 *
6 * Copyright (c) 2015 - 2018 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_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"
David Sedlákebd3acf2019-07-26 15:04:32 +020023#include "xml.h"
Radek Krejci2d7a47b2019-05-16 13:34:10 +020024
FredGand944bdc2019-11-05 21:57:07 +080025#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
26
Radek Krejci335332a2019-09-05 13:03:35 +020027/**
28 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
29 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
30 * @param[in] CTX yang parser context to get current module and for logging.
31 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
32 * @param[in] PARENT parent statement where the KW is present - for logging.
33 */
34#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
35 if ((CTX)->mod_version < 2) {LOGVAL_PARSER((CTX), LY_VCODE_INCHILDSTMT2, KW, PARENT); return LY_EVALID;}
Radek Krejcid33273d2018-10-25 14:55:52 +020036
Radek Krejcia9026eb2018-12-12 16:04:47 +010037/* These 2 macros checks YANG's identifier grammar rule */
38#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
39#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020040 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010041
David Sedlák4a650532019-07-10 11:55:18 +020042/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020043#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020044 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
45 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
46 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
47 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
48 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
49 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
50 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
51 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
52 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
53
Radek Krejci70853c52018-10-15 14:46:16 +020054/**
David Sedlákca36c422019-07-12 12:47:55 +020055 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
56 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
57 *
58 * @param[in] CTX yang parser context for logging.
59 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
60 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
61 * @param[in] STMT Name of the compared YANG statements for logging.
62 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
63 */
64#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
65 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +020066 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +020067 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +020068 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
69 return LY_EVALID; \
70 } \
71 } \
72 }
73
Michal Vaskob36053d2020-03-26 15:49:30 +010074#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +020075 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +010076 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +020077 }
Radek Krejci70853c52018-10-15 14:46:16 +020078
79/**
Radek Krejcie3846472018-10-15 15:24:51 +020080 * @brief List of YANG statement groups - the (sub)module's substatements
81 */
82enum yang_module_stmt {
83 Y_MOD_MODULE_HEADER,
84 Y_MOD_LINKAGE,
85 Y_MOD_META,
86 Y_MOD_REVISION,
87 Y_MOD_BODY
88};
89
90/**
91 * @brief Types of arguments of YANG statements
92 */
93enum yang_arg {
94 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +010095 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +020096 Y_STR_ARG, /**< YANG "string" rule */
97 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
98};
99
Michal Vasko7c8439f2020-08-05 13:25:19 +0200100#define PARSER_CTX(CTX) (CTX)->format == LYS_IN_YANG ? ((struct lys_yang_parser_ctx *)CTX)->ctx : ((struct ly_ctx *)((struct lys_yin_parser_ctx *)CTX)->xmlctx->ctx)
Michal Vaskob36053d2020-03-26 15:49:30 +0100101
102#define LOGVAL_PARSER(CTX, ...) (CTX)->format == LYS_IN_YANG ? LOGVAL_YANG(CTX, __VA_ARGS__) : LOGVAL_YIN(CTX, __VA_ARGS__)
103
104#define LOGVAL_YANG(CTX, ...) LOGVAL(PARSER_CTX(CTX), ((struct lys_yang_parser_ctx *)CTX)->pos_type, \
105 ((struct lys_yang_parser_ctx *)CTX)->pos_type == LY_VLOG_LINE ? \
106 (void *)&((struct lys_yang_parser_ctx *)CTX)->line : \
107 (void *)((struct lys_yang_parser_ctx *)CTX)->path, __VA_ARGS__)
108
109#define LOGVAL_YIN(CTX, ...) LOGVAL(PARSER_CTX(CTX), LY_VLOG_LINE, \
110 &((struct lys_yin_parser_ctx *)CTX)->xmlctx->line, __VA_ARGS__)
111
112struct lys_parser_ctx {
Michal Vasko7c8439f2020-08-05 13:25:19 +0200113 LYS_INFORMAT format; /**< parser format */
114 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
115 struct ly_set grps_nodes; /**< set of grouping nodes */
116 struct lys_module *main_mod; /**< main module (belongs-to module for submodules) */
117 uint8_t mod_version; /**< module's version */
Michal Vaskob36053d2020-03-26 15:49:30 +0100118};
119
Radek Krejcie3846472018-10-15 15:24:51 +0200120/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200121 * @brief Internal context for yang schema parser.
Radek Krejci70853c52018-10-15 14:46:16 +0200122 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100123struct lys_yang_parser_ctx {
124 LYS_INFORMAT format; /**< parser format */
David Sedlákebd3acf2019-07-26 15:04:32 +0200125 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
126 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200127 struct lys_module *main_mod; /**< main module (belongs-to module for submodules) */
David Sedlákebd3acf2019-07-26 15:04:32 +0200128 uint8_t mod_version; /**< module's version */
Radek Krejci335332a2019-09-05 13:03:35 +0200129 enum LY_VLOG_ELEM pos_type; /**< */
David Sedlákebd3acf2019-07-26 15:04:32 +0200130 struct ly_ctx *ctx; /**< context of then yang schemas */
Radek Krejci335332a2019-09-05 13:03:35 +0200131 union {
132 uint64_t line; /**< line number */
133 const char *path; /**< path */
134 };
David Sedlákebd3acf2019-07-26 15:04:32 +0200135 uint64_t indent; /**< current position on the line for YANG indentation */
Radek Krejci70853c52018-10-15 14:46:16 +0200136};
137
David Sedlákebd3acf2019-07-26 15:04:32 +0200138/**
139 * @brief free lys parser context.
140 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100141void yang_parser_ctx_free(struct lys_yang_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200142
143/**
144 * @brief Internal context for yin schema parser.
145 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100146struct lys_yin_parser_ctx {
147 LYS_INFORMAT format; /**< parser format */
David Sedlákebd3acf2019-07-26 15:04:32 +0200148 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
149 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200150 struct lys_module *main_mod; /**< main module (belongs-to module for submodules) */
David Sedlákebd3acf2019-07-26 15:04:32 +0200151 uint8_t mod_version; /**< module's version */
Michal Vaskob36053d2020-03-26 15:49:30 +0100152 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200153};
154
155/**
156 * @brief free yin parser context
157 *
158 * @param[in] ctx Context to free.
159 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100160void yin_parser_ctx_free(struct lys_yin_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200161
Radek Krejci1c0c3442019-07-23 16:08:47 +0200162struct lysc_incomplete_dflt {
Michal Vaskoba99a3e2020-08-18 15:50:05 +0200163 union {
164 struct lysc_node_leaf *leaf;
165 struct lysc_node_leaflist *llist;
166 };
167 const char *dflt;
168 const char **dflts;
Radek Krejci1c0c3442019-07-23 16:08:47 +0200169 struct lys_module *dflt_mod;
Radek Krejci1c0c3442019-07-23 16:08:47 +0200170};
171
Radek Krejci70853c52018-10-15 14:46:16 +0200172/**
Radek Krejci535ea9f2020-05-29 16:01:05 +0200173 * @brief internal context for compilation
174 */
175struct lysc_ctx {
176 struct ly_ctx *ctx;
177 struct lys_module *mod;
178 struct lys_module *mod_def; /**< context module for the definitions of the nodes being currently
179 processed - groupings are supposed to be evaluated in place where
180 defined, but its content instances are supposed to be placed into
181 the target module (mod) */
182 struct ly_set groupings; /**< stack for groupings circular check */
Michal Vasko004d3152020-06-11 19:59:22 +0200183 struct ly_set xpath; /**< to validate leafref's targets */
184 struct ly_set leafrefs; /**< when/must to check */
Radek Krejci535ea9f2020-05-29 16:01:05 +0200185 struct ly_set dflts; /**< set of incomplete default values */
186 struct ly_set tpdf_chain;
187 uint16_t path_len;
188 int options; /**< various @ref scflags. */
189#define LYSC_CTX_BUFSIZE 4078
190 char path[LYSC_CTX_BUFSIZE];
191};
192
193/**
David Sedlák4a650532019-07-10 11:55:18 +0200194 * @brief Check that \p c is valid UTF8 code point for YANG string.
195 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100196 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200197 * @param[in] c UTF8 code point of a character to check.
198 * @return LY_ERR values.
199 */
200LY_ERR lysp_check_stringchar(struct lys_parser_ctx *ctx, unsigned int c);
201
202/**
203 * @brief Check that \p c is valid UTF8 code point for YANG identifier.
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 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
208 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
209 * 0 - colon not yet found (no prefix)
210 * 1 - \p c is the colon character
211 * 2 - prefix already processed, now processing the identifier
212 *
213 * If the identifier cannot be prefixed, NULL is expected.
214 * @return LY_ERR values.
215 */
216LY_ERR lysp_check_identifierchar(struct lys_parser_ctx *ctx, unsigned int c, int first, int *prefix);
217
218/**
Radek Krejci70853c52018-10-15 14:46:16 +0200219 * @brief Check the currently present prefixes in the module for collision with the new one.
220 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100221 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100222 * @param[in] imports List of current imports of the module to check prefix collision.
223 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200224 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
225 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
226 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200227LY_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 +0200228
Radek Krejci86d106e2018-10-18 09:53:19 +0200229/**
230 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
231 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100232 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200233 * @param[in] date Date string to check (non-necessarily terminated by \0)
234 * @param[in] date_len Length of the date string, 10 expected.
235 * @param[in] stmt Statement name for error message.
236 * @return LY_ERR value.
237 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200238LY_ERR lysp_check_date(struct lys_parser_ctx *ctx, const char *date, int date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100239
240/**
241 * @brief Check names of typedefs in the parsed module to detect collisions.
242 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100243 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
244 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100245 * @return LY_ERR value.
246 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200247LY_ERR lysp_check_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200248
249/**
David Sedlákd2ebe572019-07-22 12:53:14 +0200250 * @brief Finalize some of the structures in case they are stored in sized array,
251 * which can be possibly reallocated and some other data may point to them.
252 *
253 * Update parent pointers in the nodes inside grouping/augment/RPC/Notification, which could be reallocated.
254 *
255 * @param[in] mod Parsed module to be updated.
256 * @return LY_ERR value (currently only LY_SUCCESS, but it can change in future).
257 */
258LY_ERR
259lysp_parse_finalize_reallocated(struct lys_parser_ctx *ctx, struct lysp_grp *groupings, struct lysp_augment *augments,
260 struct lysp_action *actions, struct lysp_notif *notifs);
261
262/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200263 * @brief Just move the newest revision into the first position, does not sort the rest
264 * @param[in] revs Sized-array of the revisions in a printable schema tree.
265 */
266void lysp_sort_revisions(struct lysp_revision *revs);
267
268/**
David Sedlák6544c182019-07-12 13:17:33 +0200269 * @brief Find type specified type definition.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100270 *
271 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
272 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
273 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100274 * @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 +0100275 * @param[out] tpdf Found type definition.
276 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
277 * @param[out] module Module where the found typedef is being defined, NULL in case of built-in YANG types.
278 */
279LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, struct lysp_module *start_module,
Radek Krejci4f28eda2018-11-12 11:46:16 +0100280 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node, struct lysp_module **module);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100281
282/**
David Sedlák6544c182019-07-12 13:17:33 +0200283 * @brief Validate enum name.
284 *
285 * @param[in] ctx yang parser context for logging.
286 * @param[in] name String to check.
287 * @param[in] name_len Length of name.
288 *
289 * @return LY_ERR values
290 */
David Sedlák07869a52019-07-12 14:28:19 +0200291LY_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 +0200292
293/**
Radek Krejci086c7132018-10-26 15:29:04 +0200294 * @brief Find and parse module of the given name.
295 *
296 * @param[in] ctx libyang context.
297 * @param[in] name Name of the module to load.
298 * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
Radek Krejcied5acc52019-04-25 15:57:04 +0200299 * @param[in] implement Flag if the loaded module is supposed to be marked as implemented. If revision is NULL and implement flag set,
300 * the implemented module in the context is returned despite it might not be of the latest revision, because in this case the module
301 * of the latest revision can not be made implemented.
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100302 * @param[in] require_parsed Flag to require parsed module structure in case the module is already in the context,
303 * but only the compiled structure is available.
Radek Krejci086c7132018-10-26 15:29:04 +0200304 * @param[out] mod Parsed module structure.
305 * @return LY_ERR value.
306 */
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100307LY_ERR lysp_load_module(struct ly_ctx *ctx, const char *name, const char *revision, int implement, int require_parsed, struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200308
309/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200310 * @brief Parse included submodule into the simply parsed YANG module.
311 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200312 * @param[in] pctx main parser context
Radek Krejcid33273d2018-10-25 14:55:52 +0200313 * @param[in,out] inc Include structure holding all available information about the include statement, the parsed
314 * submodule is stored into this structure.
315 * @return LY_ERR value.
316 */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200317LY_ERR lysp_load_submodule(struct lys_parser_ctx *pctx, struct lysp_include *inc);
Radek Krejcid33273d2018-10-25 14:55:52 +0200318
319/**
Radek Krejci096235c2019-01-11 11:12:19 +0100320 * @brief Compile printable schema into a validated schema linking all the references.
321 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200322 * @param[in, out] mod Pointer to the schema structure holding pointers to both schema structure types. The ::lys_module#parsed
Radek Krejci096235c2019-01-11 11:12:19 +0100323 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200324 * If the compilation fails, the whole module is removed from context, freed and @p mod is set to NULL!
Radek Krejci096235c2019-01-11 11:12:19 +0100325 * @param[in] options Various options to modify compiler behavior, see [compile flags](@ref scflags).
326 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
327 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200328LY_ERR lys_compile(struct lys_module **mod, int options);
Radek Krejci096235c2019-01-11 11:12:19 +0100329
330/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100331 * @brief Get address of a node's actions list if any.
332 *
333 * Decides the node's type and in case it has an actions list, returns its address.
334 * @param[in] node Node to check.
335 * @return Address of the node's actions member if any, NULL otherwise.
336 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100337struct lysp_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100338
339/**
340 * @brief Get address of a node's notifications list if any.
341 *
342 * Decides the node's type and in case it has a notifications list, returns its address.
343 * @param[in] node Node to check.
344 * @return Address of the node's notifs member if any, NULL otherwise.
345 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100346struct lysp_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100347
348/**
349 * @brief Get address of a node's child pointer if any.
350 *
351 * Decides the node's type and in case it has a children list, returns its address.
352 * @param[in] node Node to check.
353 * @return Address of the node's child member if any, NULL otherwise.
354 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100355struct lysp_node **lysp_node_children_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100356
357/**
358 * @brief Get address of a node's child pointer if any.
359 *
360 * Decides the node's type and in case it has a children list, returns its address.
361 * @param[in] node Node to check.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100362 * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) data in case of RPC/action node.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100363 * @return Address of the node's child member if any, NULL otherwise.
364 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100365struct lysc_node **lysc_node_children_p(const struct lysc_node *node, uint16_t flags);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100366
367/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200368 * @brief Get address of a node's notifs pointer if any.
369 *
370 * Decides the node's type and in case it has a notifs array, returns its address.
371 * @param[in] node Node to check.
372 * @return Address of the node's notifs member if any, NULL otherwise.
373 */
374struct lysc_notif **lysc_node_notifs_p(struct lysc_node *node);
375
376/**
377 * @brief Get address of a node's actions pointer if any.
378 *
379 * Decides the node's type and in case it has a actions array, returns its address.
380 * @param[in] node Node to check.
381 * @return Address of the node's actions member if any, NULL otherwise.
382 */
383struct lysc_action **lysc_node_actions_p(struct lysc_node *node);
384
385/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200386 * @brief Iterate over the specified type of the extension instances
387 *
388 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
389 * @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 +0200390 * the returned index increased by 1 (until the iteration is not terminated by returning LY_ARRAY_COUNT(ext).
Radek Krejcid3ca0632019-04-16 16:54:54 +0200391 * @param[in] substmt Type of the extension (its belongins to the specific substatement) to iterate, use
392 * #LYEXT_SUBSTMT_ALL to go through all the extensions in the array
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200393 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200394 */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200395LY_ARRAY_COUNT_TYPE lysp_ext_instance_iter(struct lysp_ext_instance *ext, LY_ARRAY_COUNT_TYPE index, LYEXT_SUBSTMT substmt);
Radek Krejcid3ca0632019-04-16 16:54:54 +0200396
397/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100398 * @brief Get the covering schema module structure for the given parsed module structure.
399 * @param[in] ctx libyang context to search.
400 * @param[in] mod Parsed schema structure.
401 * @return Corresponding lys_module structure for the given parsed schema structure.
402 */
403struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
404
405/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100406 * @brief Check statement's status for invalid combination.
407 *
408 * The modX parameters are used just to determine if both flags are in the same module,
409 * so any of the schema module structure can be used, but both modules must be provided
410 * in the same type.
411 *
412 * @param[in] ctx Compile context for logging.
413 * @param[in] flags1 Flags of the referencing node.
414 * @param[in] mod1 Module of the referencing node,
415 * @param[in] name1 Schema node name of the referencing node.
416 * @param[in] flags2 Flags of the referenced node.
417 * @param[in] mod2 Module of the referenced node,
418 * @param[in] name2 Schema node name of the referenced node.
419 * @return LY_ERR value
420 */
421LY_ERR lysc_check_status(struct lysc_ctx *ctx,
422 uint16_t flags1, void *mod1, const char *name1,
423 uint16_t flags2, void *mod2, const char *name2);
424
425/**
Radek Krejci95710c92019-02-11 15:49:55 +0100426 * @brief Find the node according to the given descendant/absolute schema nodeid.
427 * Used in unique, refine and augment statements.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100428 *
429 * @param[in] ctx Compile context
430 * @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
431 * @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
432 * @param[in] context_node Node where the nodeid is specified to correctly resolve prefixes and to start searching.
Radek Krejci7af64242019-02-18 13:07:53 +0100433 * If no context node is provided, the nodeid is actually expected to be the absolute schema node .
434 * @param[in] context_module Explicit module to resolve prefixes in @nodeid.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100435 * @param[in] nodetype Optional (can be 0) restriction for target's nodetype. If target exists, but does not match
Radek Krejci95710c92019-02-11 15:49:55 +0100436 * the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
437 * The value can be even an ORed value to allow multiple nodetypes.
438 * @param[in] implement Flag if the modules mentioned in the nodeid are supposed to be made implemented.
Michal Vasko1bf09392020-03-27 12:38:10 +0100439 * @param[out] target Found target node if any. In case of RPC/action input/output node, LYS_RPC or LYS_ACTION node is actually returned
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100440 * since the input/output has not a standalone node structure and it is part of ::lysc_action which is better compatible with ::lysc_node.
441 * @param[out] result_flag Output parameter to announce if the schema nodeid goes through the action's input/output or a Notification.
442 * The LYSC_OPT_RPC_INPUT, LYSC_OPT_RPC_OUTPUT and LYSC_OPT_NOTIFICATION are used as flags.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100443 * @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
444 */
Radek Krejci95710c92019-02-11 15:49:55 +0100445LY_ERR lys_resolve_schema_nodeid(struct lysc_ctx *ctx, const char *nodeid, size_t nodeid_len, const struct lysc_node *context_node,
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100446 const struct lys_module *context_module, int nodetype, int implement,
447 const struct lysc_node **target, uint16_t *result_flag);
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100448
449/**
Radek Krejci151a5b72018-10-19 14:21:44 +0200450 * @brief Find the module referenced by prefix in the provided mod.
451 *
Radek Krejci693262f2019-04-29 15:23:20 +0200452 * Reverse function to lys_prefix_find_module().
453 *
Radek Krejci151a5b72018-10-19 14:21:44 +0200454 * @param[in] mod Schema module where the prefix was used.
455 * @param[in] prefix Prefix used to reference a module.
456 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
457 * @return Pointer to the module or NULL if the module is not found.
458 */
Radek Krejcia3045382018-11-22 14:30:31 +0100459struct lys_module *lys_module_find_prefix(const struct lys_module *mod, const char *prefix, size_t len);
460
461/**
Radek Krejci693262f2019-04-29 15:23:20 +0200462 * @brief Find the prefix used to referenced the import module in the provided mod.
463 *
464 * Reverse function to lys_module_find_prefix().
465 *
466 * Note that original prefixes are present only in the parsed schema. In case it is not available
467 * (only compiled schema available), the own prefix of the import module is returned instead.
468 *
469 * @param[in] mod Schema module where the import module was used.
470 * @param[in] import Module referenced in mod.
471 * @return Prefix of the import module.
472 */
473const char *lys_prefix_find_module(const struct lys_module *mod, const struct lys_module *import);
474
475/**
Radek Krejci693262f2019-04-29 15:23:20 +0200476 * @brief Stringify YANG built-in type.
Michal Vasko1bf09392020-03-27 12:38:10 +0100477 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200478 * @return Constant string with the name of the built-in type.
479 */
480const char *lys_datatype2str(LY_DATA_TYPE basetype);
481
Michal Vasko3a41dff2020-07-15 14:30:28 +0200482typedef LY_ERR (*lys_custom_check)(const struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod,
483 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100484
Radek Krejci693262f2019-04-29 15:23:20 +0200485/**
Michal Vaskob36053d2020-03-26 15:49:30 +0100486 * @brief Parse module from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200487 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100488 * The modules are added into the context and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200489 *
490 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200491 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200492 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200493 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100494 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
495 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200496 * @param[out] module Parsed module.
497 * @return LY_ERR value.
Radek Krejcid33273d2018-10-25 14:55:52 +0200498 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200499LY_ERR lys_parse_mem_module(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, int implement,
500 lys_custom_check custom_check, void *check_data, struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200501
502/**
Michal Vaskob36053d2020-03-26 15:49:30 +0100503 * @brief Parse submodule from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200504 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100505 * The latest_revision flag of submodule is updated.
506 *
507 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200508 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100509 * @param[in] format Format of the input data (YANG or YIN).
510 * @param[in] main_ctx Parser context of the main module.
511 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
512 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200513 * @param[out] submodule Parsed submodule.
514 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100515 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200516LY_ERR lys_parse_mem_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format,
517 struct lys_parser_ctx *main_ctx, lys_custom_check custom_check,
518 void *check_data, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100519
520/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200521 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100522 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200523 * @param[in] ctx Context with dictionary where the filepath value will be stored.
524 * @param[in] in Input handler to examine (filepath is not available for all the input types).
525 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200526 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200527void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200528
529/**
530 * @brief Load the (sub)module into the context.
531 *
532 * This function does not check the presence of the (sub)module in context, it should be done before calling this function.
533 *
534 * module_name and submodule_name are alternatives - only one of the
535 *
536 * @param[in] ctx libyang context where to work.
537 * @param[in] name Name of the (sub)module to load.
538 * @param[in] revision Optional revision of the (sub)module to load, if NULL the newest revision is being loaded.
539 * @param[in] implement Flag if the (sub)module is supposed to be marked as implemented.
Radek Krejci3b1f9292018-11-08 10:58:35 +0100540 * @param[in] main_ctx Parser context of the main module in case of loading submodule.
fredgancd485b82019-10-18 15:00:17 +0800541 * @param[in] main_name Main module name in case of loading submodule.
Radek Krejci78f06822019-10-30 12:54:05 +0100542 * @param[in] required Module is required so error (even if the input file not found) are important. If 0, there is some
543 * backup and it is actually ok if the input data are not found. However, parser reports errors even in this case.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100544 * @param[out] result Parsed YANG schema tree of the requested module (struct lys_module*) or submodule (struct lysp_submodule*).
545 * If it is a module, it is already in the context!
Radek Krejcid33273d2018-10-25 14:55:52 +0200546 * @return LY_ERR value, in case of LY_SUCCESS, the \arg result is always provided.
547 */
fredgancd485b82019-10-18 15:00:17 +0800548LY_ERR lys_module_localfile(struct ly_ctx *ctx, const char *name, const char *revision, int implement,
Radek Krejci78f06822019-10-30 12:54:05 +0100549 struct lys_parser_ctx *main_ctx, const char *main_name, int required, void **result);
Radek Krejci086c7132018-10-26 15:29:04 +0200550
551/**
Michal Vasko33ff9422020-07-03 09:50:39 +0200552 * @brief Compile information from the identity statement
553 *
554 * The backlinks to the identities derived from this one are supposed to be filled later via lys_compile_identity_bases().
555 *
556 * @param[in] ctx_sc Compile context - alternative to the combination of @p ctx and @p module.
557 * @param[in] ctx libyang context.
558 * @param[in] module Module of the features.
559 * @param[in] identities_p Array of the parsed identity definitions to precompile.
560 * @param[in,out] identities Pointer to the storage of the (pre)compiled identities array where the new identities are
561 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed identities are going
562 * to be processed.
563 * @return LY_ERR value.
564 */
565LY_ERR lys_identity_precompile(struct lysc_ctx *ctx_sc, struct ly_ctx *ctx, struct lys_module *module,
566 struct lysp_ident *identities_p, struct lysc_ident **identities);
567
568/**
Radek Krejci0af46292019-01-11 16:02:31 +0100569 * @brief Create pre-compiled features array.
570 *
571 * Features are compiled in two steps to allow forward references between them via their if-feature statements.
572 * In case of not implemented schemas, the precompiled list of features is stored in lys_module structure and
573 * the compilation is not finished (if-feature and extensions are missing) and all the features are permanently
574 * disabled without a chance to change it. The list is used as target for any if-feature statement in any
575 * implemented module to get valid data to evaluate its result. The compilation is finished via
576 * lys_feature_precompile_finish() in implemented modules. In case a not implemented module becomes implemented,
577 * the precompiled list is reused to finish the compilation to preserve pointers already used in various compiled
578 * if-feature structures.
579 *
Radek Krejci327de162019-06-14 12:52:07 +0200580 * @param[in] ctx_sc Compile context - alternative to the combination of @p ctx and @p module.
Radek Krejci0af46292019-01-11 16:02:31 +0100581 * @param[in] ctx libyang context.
Radek Krejci693262f2019-04-29 15:23:20 +0200582 * @param[in] module Module of the features.
Radek Krejci0935f412019-08-20 16:15:18 +0200583 * @param[in] features_p Array of the parsed features definitions to precompile.
Radek Krejci0af46292019-01-11 16:02:31 +0100584 * @param[in,out] features Pointer to the storage of the (pre)compiled features array where the new features are
585 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed features are going
586 * to be processed.
587 * @return LY_ERR value.
588 */
Radek Krejci0935f412019-08-20 16:15:18 +0200589LY_ERR lys_feature_precompile(struct lysc_ctx *ctx_sc, struct ly_ctx *ctx, struct lys_module *module,
590 struct lysp_feature *features_p, struct lysc_feature **features);
Radek Krejci693262f2019-04-29 15:23:20 +0200591
592/**
593 * @brief Get the @ref ifftokens from the given position in the 2bits array
594 * (libyang format of the if-feature expression).
595 * @param[in] list The 2bits array with the compiled if-feature expression.
596 * @param[in] pos Position (0-based) to specify from which position get the operator.
597 */
598uint8_t lysc_iff_getop(uint8_t *list, int pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100599
600/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200601 * @brief Checks pattern syntax.
602 *
603 * @param[in] ctx Context.
604 * @param[in] log_path Path for logging errors.
605 * @param[in] pattern Pattern to check.
606 * @param[in,out] pcre2_code Compiled PCRE2 pattern. If NULL, the compiled information used to validate pattern are freed.
607 * @return LY_ERR value - LY_SUCCESS, LY_EMEM, LY_EVALID.
608 */
609LY_ERR lys_compile_type_pattern_check(struct ly_ctx *ctx, const char *log_path, const char *pattern, pcre2_code **code);
610
611/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200612 * @brief Macro to free [sized array](@ref sizedarrays) of items using the provided free function. The ARRAY itself is also freed,
613 * but the memory is not sanitized.
614 */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200615#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 +0200616
617/**
618 * @brief Macro to free the specified MEMBER of a structure using the provided free function. The memory is not sanitized.
619 */
620#define FREE_MEMBER(CTX, MEMBER, FUNC) if (MEMBER) {FUNC(CTX, MEMBER);free(MEMBER);}
621
622/**
623 * @brief Macro to free [sized array](@ref sizedarrays) of strings stored in the context's dictionary. The ARRAY itself is also freed,
624 * but the memory is not sanitized.
625 */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200626#define FREE_STRINGS(CTX, ARRAY) {LY_ARRAY_COUNT_TYPE c__; LY_ARRAY_FOR(ARRAY, c__){FREE_STRING(CTX, ARRAY[c__]);}LY_ARRAY_FREE(ARRAY);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200627
628/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100629 * @brief Free the parsed submodule structure.
630 * @param[in] ctx libyang context where the string data resides in a dictionary.
631 * @param[in,out] submod Parsed schema submodule structure to free.
Radek Krejci086c7132018-10-26 15:29:04 +0200632 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100633void lysp_submodule_free(struct ly_ctx *ctx, struct lysp_submodule *submod);
Radek Krejci086c7132018-10-26 15:29:04 +0200634
Radek Krejci38d85362019-09-05 16:26:38 +0200635/**
636 * @brief Free the parsed type structure.
637 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko8d544252020-03-02 10:19:52 +0100638 * @param[in] type Parsed schema type structure to free. Note that the type itself is not freed.
Radek Krejci38d85362019-09-05 16:26:38 +0200639 */
640void lysp_type_free(struct ly_ctx *ctx, struct lysp_type *type);
Radek Krejci335332a2019-09-05 13:03:35 +0200641
Radek Krejciad5963b2019-09-06 16:03:05 +0200642/**
Michal Vasko8d544252020-03-02 10:19:52 +0100643 * @brief Free the parsed extension instance structure.
644 * @param[in] ctx libyang context where the string data resides in a dictionary.
645 * @param[in] type Parsed extension instance structure to free. Note that the instance itself is not freed.
646 */
647void lysp_ext_instance_free(struct ly_ctx *ctx, struct lysp_ext_instance *ext);
648
649/**
Radek Krejciad5963b2019-09-06 16:03:05 +0200650 * @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.
651 */
652LY_ERR lysp_stmt_parse(struct lysc_ctx *ctx, const struct lysp_stmt *stmt, enum ly_stmt kw, void **result, struct lysp_ext_instance **exts);
Radek Krejci335332a2019-09-05 13:03:35 +0200653
Radek Krejcid33273d2018-10-25 14:55:52 +0200654/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100655 * @brief Free the compiled type structure.
656 * @param[in] ctx libyang context where the string data resides in a dictionary.
657 * @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.
658 */
659void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
660
661/**
Radek Krejci0af46292019-01-11 16:02:31 +0100662 * @brief Free the compiled if-feature structure.
663 * @param[in] ctx libyang context where the string data resides in a dictionary.
664 * @param[in,out] iff Compiled if-feature structure to be cleaned.
665 * Since the structure is typically part of the sized array, the structure itself is not freed.
666 */
667void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
668
669/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100670 * @brief Free the compiled must structure.
671 * @param[in] ctx libyang context where the string data resides in a dictionary.
672 * @param[in,out] must Compiled must structure to be cleaned.
673 * Since the structure is typically part of the sized array, the structure itself is not freed.
674 */
675void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
676
677/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100678 * @brief Free the data inside compiled input/output structure.
679 * @param[in] ctx libyang context where the string data resides in a dictionary.
680 * @param[in,out] inout Compiled inout structure to be cleaned.
681 * Since the structure is part of the RPC/action structure, it is not freed itself.
682 */
683void lysc_action_inout_free(struct ly_ctx *ctx, struct lysc_action_inout *inout);
684
685/**
686 * @brief Free the data inside compiled RPC/action structure.
687 * @param[in] ctx libyang context where the string data resides in a dictionary.
688 * @param[in,out] action Compiled action structure to be cleaned.
689 * Since the structure is typically part of the sized array, the structure itself is not freed.
690 */
691void lysc_action_free(struct ly_ctx *ctx, struct lysc_action *action);
692
693/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200694 * @brief Free the items inside the compiled Notification structure.
695 * @param[in] ctx libyang context where the string data resides in a dictionary.
696 * @param[in,out] action Compiled Notification structure to be cleaned.
697 * Since the structure is typically part of the sized array, the structure itself is not freed.
698 */
699void lysc_notif_free(struct ly_ctx *ctx, struct lysc_notif *notif);
700
701/**
Radek Krejci0af46292019-01-11 16:02:31 +0100702 * @brief Free the compiled extension instance structure.
703 * @param[in] ctx libyang context where the string data resides in a dictionary.
704 * @param[in,out] ext Compiled extension instance structure to be cleaned.
705 * Since the structure is typically part of the sized array, the structure itself is not freed.
706 */
707void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
708
709/**
Radek Krejci19a96102018-11-15 13:38:09 +0100710 * @brief Free the compiled node structure.
711 * @param[in] ctx libyang context where the string data resides in a dictionary.
712 * @param[in,out] node Compiled node structure to be freed.
713 */
714void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node);
715
716/**
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200717 * @brief Free the compiled container node structure.
718 *
719 * Only the container-specific members are freed, for generic node free function,
720 * use lysc_node_free().
721 *
722 * @param[in] ctx libyang context where the string data resides in a dictionary.
723 * @param[in,out] node Compiled container node structure to be freed.
724 */
725void lysc_node_container_free(struct ly_ctx *ctx, struct lysc_node_container *node);
726
727/**
Radek Krejci19a96102018-11-15 13:38:09 +0100728 * @brief Free the compiled schema structure.
729 * @param[in,out] module Compiled schema module structure to free.
730 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
731 */
732void lysc_module_free(struct lysc_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
733
734/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200735 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
736 * @param[in,out] module Schema module structure to free.
737 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
738 */
739void lys_module_free(struct lys_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
740
741/**
Radek Krejci95710c92019-02-11 15:49:55 +0100742 * @brief Make the specific module implemented, use the provided value as flag.
743 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +0200744 * @param[in] mod Module to make implemented. It is not an error to provide already implemented module, it just does nothing.
Radek Krejci95710c92019-02-11 15:49:55 +0100745 * @param[in] implemented Flag value for the ::lys_module#implemented item.
746 * @return LY_SUCCESS or LY_EDENIED in case the context contains some other revision of the
747 * same module which is already implemented.
748 */
Radek Krejci77a8bcd2019-09-11 11:20:02 +0200749LY_ERR lys_set_implemented_internal(struct lys_module *mod, uint8_t implemented);
Radek Krejci95710c92019-02-11 15:49:55 +0100750
David Sedlák18e494b2018-12-17 03:58:39 +0100751/**
752 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200753 *
Michal Vasko14654712020-02-06 08:35:21 +0100754 * @param[in] ctx yang parser context for logging, can be NULL if keyword is from YIN data.
Michal Vasko63f3d842020-07-08 10:10:14 +0200755 * @param[in,out] in Input structure, is updated.
Michal Vasko14654712020-02-06 08:35:21 +0100756 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100757 */
Michal Vasko63f3d842020-07-08 10:10:14 +0200758enum ly_stmt lysp_match_kw(struct lys_yang_parser_ctx *ctx, struct ly_in *in);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200759
Michal Vasko14654712020-02-06 08:35:21 +0100760/**
761 * @brief Generate path of the given node in the requested format.
762 *
763 * @param[in] node Schema path of this node will be generated.
764 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
765 * @param[in] pathtype Format of the path to generate.
766 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
767 * If NULL, memory for the complete path is allocated.
768 * @param[in] buflen Size of the provided @p buffer.
769 * @return NULL in case of memory allocation error, path of the node otherwise.
770 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
771 */
772char *lysc_path_until(const struct lysc_node *node, const struct lysc_node *parent, LYSC_PATH_TYPE pathtype, char *buffer,
Michal Vasko90932a92020-02-12 14:33:03 +0100773 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100774
Michal Vasko62ed12d2020-05-21 10:08:25 +0200775/**
776 * @brief Get schema parent that can be instantiated in data. In other words, skip any choice or case nodes.
777 *
778 * @param[in] schema Schema node to get the parent for.
779 * @return Parent, NULL if top-level (in data).
780 */
781const struct lysc_node *lysc_data_parent(const struct lysc_node *schema);
782
Michal Vasko00cbf532020-06-15 13:58:47 +0200783/**
784 * @brief Learn whether a node is in an operation output.
785 *
786 * @param[in] schema Schema node to examine.
787 * @return non-zero is the node is in output,
788 * @return 0 if it is not.
789 */
790int lysc_is_output(const struct lysc_node *schema);
791
Radek Krejci70853c52018-10-15 14:46:16 +0200792#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */