blob: 984709961b73272c290300c55f7db01b15a23d9c [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
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020025struct lysc_ctx;
Michal Vasko405cc9e2020-12-01 12:01:27 +010026struct lys_glob_unres;
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020027
Radek Krejcif13b87b2020-12-01 22:02:17 +010028#define LY_YANG_SUFFIX ".yang"
29#define LY_YANG_SUFFIX_LEN 5
30#define LY_YIN_SUFFIX ".yin"
31#define LY_YIN_SUFFIX_LEN 4
32
FredGand944bdc2019-11-05 21:57:07 +080033#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
34
Radek Krejcif13b87b2020-12-01 22:02:17 +010035#define LY_PCRE2_MSG_LIMIT 256
36
Radek Krejci335332a2019-09-05 13:03:35 +020037/**
Radek Krejcieccf6602021-02-05 19:42:54 +010038 * @brief Informational structure for YANG statements
39 */
40struct stmt_info_s {
41 const char *name; /**< name of the statement */
42 const char *arg; /**< name of YIN's attribute to present the statement */
43 uint8_t flags; /**< various flags to clarify printing of the statement */
44#define STMT_FLAG_YIN 0x1 /**< has YIN element */
45#define STMT_FLAG_ID 0x2 /**< the value is identifier -> no quotes */
46};
47
48/* statements informations filled in tree_schema.c */
49extern struct stmt_info_s stmt_attr_info[];
50
Radek Krejcieccf6602021-02-05 19:42:54 +010051/* list of the deviate modifications strings */
52extern const char * const ly_devmod_list[];
53#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
54
55/**
Radek Krejci335332a2019-09-05 13:03:35 +020056 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
57 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
58 * @param[in] CTX yang parser context to get current module and for logging.
59 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
60 * @param[in] PARENT parent statement where the KW is present - for logging.
61 */
62#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
Michal Vasko5d24f6c2020-10-13 13:49:06 +020063 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 +020064
Radek Krejcia9026eb2018-12-12 16:04:47 +010065/* These 2 macros checks YANG's identifier grammar rule */
66#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
67#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020068 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010069
David Sedlák4a650532019-07-10 11:55:18 +020070/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020071#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020072 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
73 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
74 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
75 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
76 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
77 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
78 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
79 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
80 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
81
Radek Krejci70853c52018-10-15 14:46:16 +020082/**
David Sedlákca36c422019-07-12 12:47:55 +020083 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
84 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
85 *
86 * @param[in] CTX yang parser context for logging.
87 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
88 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
89 * @param[in] STMT Name of the compared YANG statements for logging.
90 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
91 */
92#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
93 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +020094 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +020095 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +020096 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
97 return LY_EVALID; \
98 } \
99 } \
100 }
101
Michal Vaskob36053d2020-03-26 15:49:30 +0100102#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +0200103 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +0100104 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +0200105 }
Radek Krejci70853c52018-10-15 14:46:16 +0200106
Radek Krejcif13b87b2020-12-01 22:02:17 +0100107/*
108 * Additional YANG constants
109 */
110#define Y_TAB_SPACES 8 /**< number of spaces instead of tab character */
111#define LY_TYPE_DEC64_FD_MAX 18 /**< Maximal value of decimal64's fraction-digits */
112
Radek Krejci70853c52018-10-15 14:46:16 +0200113/**
Radek Krejcie3846472018-10-15 15:24:51 +0200114 * @brief List of YANG statement groups - the (sub)module's substatements
115 */
116enum yang_module_stmt {
117 Y_MOD_MODULE_HEADER,
118 Y_MOD_LINKAGE,
119 Y_MOD_META,
120 Y_MOD_REVISION,
121 Y_MOD_BODY
122};
123
124/**
125 * @brief Types of arguments of YANG statements
126 */
127enum yang_arg {
128 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +0100129 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +0200130 Y_STR_ARG, /**< YANG "string" rule */
131 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
132};
133
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200134#define PARSER_CTX(CTX) ((CTX)->parsed_mod->mod->ctx)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100135#define LOGVAL_PARSER(CTX, ...) LOGVAL((CTX) ? PARSER_CTX(CTX) : NULL, __VA_ARGS__)
Michal Vaskob36053d2020-03-26 15:49:30 +0100136
137struct lys_parser_ctx {
Michal Vasko7c8439f2020-08-05 13:25:19 +0200138 LYS_INFORMAT format; /**< parser format */
139 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
140 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200141 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100142 struct lys_glob_unres *unres; /**< global unres structure */
Michal Vaskob36053d2020-03-26 15:49:30 +0100143};
144
Radek Krejcie3846472018-10-15 15:24:51 +0200145/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200146 * @brief Internal context for yang schema parser.
Radek Krejci70853c52018-10-15 14:46:16 +0200147 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100148struct lys_yang_parser_ctx {
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200149 LYS_INFORMAT format; /**< parser format */
150 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
151 struct ly_set grps_nodes; /**< set of grouping nodes */
152 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100153 struct lys_glob_unres *unres; /**< global unres structure */
Radek Krejci33090f92020-12-17 20:12:46 +0100154 struct ly_in *in; /**< input handler for the parser */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200155 uint64_t indent; /**< current position on the line for YANG indentation */
Radek Krejci70853c52018-10-15 14:46:16 +0200156};
157
David Sedlákebd3acf2019-07-26 15:04:32 +0200158/**
159 * @brief free lys parser context.
160 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100161void yang_parser_ctx_free(struct lys_yang_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200162
163/**
164 * @brief Internal context for yin schema parser.
165 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100166struct lys_yin_parser_ctx {
167 LYS_INFORMAT format; /**< parser format */
David Sedlákebd3acf2019-07-26 15:04:32 +0200168 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
169 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200170 struct lysp_module *parsed_mod;/**< (sub)module being parsed */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100171 struct lys_glob_unres *unres; /**< global unres structure */
Michal Vaskob36053d2020-03-26 15:49:30 +0100172 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200173};
174
175/**
176 * @brief free yin parser context
177 *
178 * @param[in] ctx Context to free.
179 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100180void yin_parser_ctx_free(struct lys_yin_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200181
Michal Vasko7f45cf22020-10-01 12:49:44 +0200182/**
David Sedlák4a650532019-07-10 11:55:18 +0200183 * @brief Check that \p c is valid UTF8 code point for YANG string.
184 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100185 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200186 * @param[in] c UTF8 code point of a character to check.
187 * @return LY_ERR values.
188 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200189LY_ERR lysp_check_stringchar(struct lys_parser_ctx *ctx, uint32_t c);
David Sedlák4a650532019-07-10 11:55:18 +0200190
191/**
192 * @brief Check that \p c is valid UTF8 code point for YANG identifier.
193 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100194 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200195 * @param[in] c UTF8 code point of a character to check.
196 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
197 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
198 * 0 - colon not yet found (no prefix)
199 * 1 - \p c is the colon character
200 * 2 - prefix already processed, now processing the identifier
201 *
202 * If the identifier cannot be prefixed, NULL is expected.
203 * @return LY_ERR values.
204 */
Radek Krejci857189e2020-09-01 13:26:36 +0200205LY_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 +0200206
207/**
Radek Krejci70853c52018-10-15 14:46:16 +0200208 * @brief Check the currently present prefixes in the module for collision with the new one.
209 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100210 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100211 * @param[in] imports List of current imports of the module to check prefix collision.
212 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200213 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
214 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
215 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200216LY_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 +0200217
Radek Krejci86d106e2018-10-18 09:53:19 +0200218/**
219 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
220 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100221 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200222 * @param[in] date Date string to check (non-necessarily terminated by \0)
223 * @param[in] date_len Length of the date string, 10 expected.
224 * @param[in] stmt Statement name for error message.
225 * @return LY_ERR value.
226 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200227LY_ERR lysp_check_date(struct lys_parser_ctx *ctx, const char *date, uint8_t date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100228
229/**
230 * @brief Check names of typedefs in the parsed module to detect collisions.
231 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100232 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
233 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100234 * @return LY_ERR value.
235 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100236LY_ERR lysp_check_dup_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
237
238/**
239 * @brief Check names of features in the parsed module and submodules to detect collisions.
240 *
241 * @param[in] ctx Parser context.
242 * @param[in] mod Module where the type is being defined.
243 * @return LY_ERR value.
244 */
245LY_ERR lysp_check_dup_features(struct lys_parser_ctx *ctx, struct lysp_module *mod);
246
247/**
248 * @brief Check names of identities in the parsed module and submodules to detect collisions.
249 *
250 * @param[in] ctx Parser context.
251 * @param[in] mod Module where the type is being defined.
252 * @return LY_ERR value.
253 */
254LY_ERR lysp_check_dup_identities(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200255
256/**
257 * @brief Just move the newest revision into the first position, does not sort the rest
258 * @param[in] revs Sized-array of the revisions in a printable schema tree.
259 */
260void lysp_sort_revisions(struct lysp_revision *revs);
261
262/**
David Sedlák6544c182019-07-12 13:17:33 +0200263 * @brief Find type specified type definition.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100264 *
265 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
266 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
267 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100268 * @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 +0100269 * @param[out] tpdf Found type definition.
270 * @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 +0100271 */
Michal Vaskoa99b3572021-02-01 11:54:58 +0100272LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, const struct lysp_module *start_module,
273 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100274
275/**
David Sedlák6544c182019-07-12 13:17:33 +0200276 * @brief Validate enum name.
277 *
278 * @param[in] ctx yang parser context for logging.
279 * @param[in] name String to check.
280 * @param[in] name_len Length of name.
281 *
282 * @return LY_ERR values
283 */
David Sedlák07869a52019-07-12 14:28:19 +0200284LY_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 +0200285
286/**
Michal Vasko18a86e52021-04-16 11:50:13 +0200287 * @brief Find and load a module of the given name.
Radek Krejci086c7132018-10-26 15:29:04 +0200288 *
289 * @param[in] ctx libyang context.
290 * @param[in] name Name of the module to load.
291 * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
Michal Vasko34e334d2021-01-25 16:12:31 +0100292 * @param[in] need_implemented Whether the module should be implemented. If revision is NULL and this flag is set,
293 * the implemented module in the context is returned despite it might not be of the latest revision, because in this
294 * case the module of the latest revision can not be made implemented.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100295 * @param[in] features All the features to enable if implementing the module.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100296 * @param[in] unres Global unres structure for all newly implemented modules.
Michal Vasko18a86e52021-04-16 11:50:13 +0200297 * @param[out] mod Created module structure.
Radek Krejci086c7132018-10-26 15:29:04 +0200298 * @return LY_ERR value.
299 */
Michal Vasko18a86e52021-04-16 11:50:13 +0200300LY_ERR lys_load_module(struct ly_ctx *ctx, const char *name, const char *revision, ly_bool need_implemented,
Michal Vasko405cc9e2020-12-01 12:01:27 +0100301 const char **features, struct lys_glob_unres *unres, struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200302
303/**
Radek Krejci771928a2021-01-19 13:42:36 +0100304 * @brief Parse included submodules into the simply parsed YANG module.
305 *
306 * YANG 1.0 does not require the main module to include all the submodules. Therefore, parsing submodules can cause
307 * reallocating and extending the includes array in the main module by the submodules included only in submodules.
Radek Krejcid33273d2018-10-25 14:55:52 +0200308 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200309 * @param[in] pctx main parser context
Radek Krejci771928a2021-01-19 13:42:36 +0100310 * @param[in] pmod Parsed module with the includes array to be processed.
Radek Krejcid33273d2018-10-25 14:55:52 +0200311 * @return LY_ERR value.
312 */
Radek Krejci771928a2021-01-19 13:42:36 +0100313LY_ERR lysp_load_submodules(struct lys_parser_ctx *pctx, struct lysp_module *pmod);
Radek Krejcid33273d2018-10-25 14:55:52 +0200314
315/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200316 * @brief Free a parsed restriction.
317 *
318 * @param[in] ctx libyang context.
319 * @param[in] restr Restriction to free.
320 */
321void lysp_restr_free(struct ly_ctx *ctx, struct lysp_restr *restr);
322
323/**
324 * @brief Free a parsed qualified name.
325 *
326 * @param[in] ctx libyang context.
327 * @param[in] qname Qualified name to free.
328 */
329void lysp_qname_free(struct ly_ctx *ctx, struct lysp_qname *qname);
330
331/**
332 * @brief Free a parsed node.
333 *
334 * @param[in] ctx libyang context.
335 * @param[in] node Node to free.
336 */
337void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
338
339/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100340 * @brief Get address of a node's actions list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100341 * Decides the node's type and in case it has an actions list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100342 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100343 * @param[in] node Node to check.
344 * @return Address of the node's actions member if any, NULL otherwise.
345 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100346struct lysp_node_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100347
348/**
349 * @brief Get address of a node's notifications list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100350 * Decides the node's type and in case it has a notifications list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100351 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100352 * @param[in] node Node to check.
353 * @return Address of the node's notifs member if any, NULL otherwise.
354 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100355struct lysp_node_notif **lysp_node_notifs_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.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100359 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100360 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100361 * @param[in] node Node to check.
362 * @return Address of the node's child member if any, NULL otherwise.
363 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100364struct lysp_node **lysp_node_child_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100365
366/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100367 * @brief Get the address of the node's musts member, if any.
368 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100369 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100370 * @param[in] node Node to examine.
371 * @return The address of the node's musts member if any, NULL otherwise.
372 */
373struct lysp_restr **lysp_node_musts_p(const struct lysp_node *node);
374
375/**
376 * @brief Get the node's musts member, if any.
377 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100378 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100379 * @param[in] node Node to examine.
380 * @return The node's musts member if any, NULL otherwise.
381 */
382struct lysp_restr *lysp_node_musts(const struct lysp_node *node);
383
384/**
385 * @brief Get the address of the node's when member, if any.
386 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100387 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100388 * @param[in] node Node to examine.
389 * @return The address of the node's when member if any, NULL otherwise.
390 */
391struct lysp_when **lysp_node_when_p(const struct lysp_node *node);
392
393/**
394 * @brief Get the node's when member, if any.
395 * Decides the node's type and in case it has a when, returns it.
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 node's when member if any, NULL otherwise.
399 */
400struct lysp_when *lysp_node_when(const struct lysp_node *node);
401
402/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100403 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100404 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100405 *
406 * Do not use for RPC and action nodes.
407 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100408 * @param[in] node Node to check.
409 * @return Address of the node's child member if any, NULL otherwise.
410 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100411struct lysc_node **lysc_node_child_p(const struct lysc_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100412
413/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200414 * @brief Get address of a node's notifs pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200415 * Decides the node's type and in case it has a notifs array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100416 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200417 * @param[in] node Node to check.
418 * @return Address of the node's notifs member if any, NULL otherwise.
419 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100420struct lysc_node_notif **lysc_node_notifs_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200421
422/**
423 * @brief Get address of a node's actions pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200424 * Decides the node's type and in case it has a actions array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100425 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200426 * @param[in] node Node to check.
427 * @return Address of the node's actions member if any, NULL otherwise.
428 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100429struct lysc_node_action **lysc_node_actions_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200430
431/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100432 * @brief Get address of a node's when member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100433 * Decides the node's type and in case it has a when member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100434 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100435 * @param[in] node Node to check.
436 * @return Address of the node's when member if any, NULL otherwise.
437 */
438struct lysc_when ***lysc_node_when_p(const struct lysc_node *node);
439
440/**
441 * @brief Get address of a node's musts member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100442 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100443 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100444 * @param[in] node Node to check.
445 * @return Address of the node's musts member if any, NULL otherwise.
446 */
447struct lysc_must **lysc_node_musts_p(const struct lysc_node *node);
448
449/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100450 * @brief Find parsed extension definition for the given extension instance.
451 *
452 * @param[in] ctx libyang context.
453 * @param[in] ext Extension instance for which the definition will be searched.
454 * @param[in, out] ext_mod Pointer to the module where the extension definition of the @p ext to correctly resolve prefixes.
455 * @param[out] ext_def Pointer to return found extension definition.
456 * @return LY_SUCCESS when the definition was found.
457 * @return LY_EVALID when the extension instance is invalid and/or the definition not found.
458 */
459LY_ERR lysp_ext_find_definition(const struct ly_ctx *ctx, const struct lysp_ext_instance *ext, const struct lys_module **ext_mod,
460 struct lysp_ext **ext_def);
461
462/**
Radek Krejciba05eab2021-03-10 13:19:29 +0100463 * @brief Get schema node in extension instance according to the given parameters.
464 *
465 * Wraps ::lys_getnext_ext() and match according to the given arguments.
466 *
467 * @param[in] ext Extension instance which top-level schema node is being searched.
468 * @param[in] module Optional parameter to match the extension instance's (and its data) module.
469 * @param[in] name Name of the schema node to find, if the string is not NULL-terminated, the @p name_len must be set.
470 * @param[in] name_len Length of the @p name string, use in case the @p name is not NULL-terminated string.
471 * @param[in] nodetype Allowed [type of the node](@ref schemanodetypes).
472 * @param[in] options ORed [lys_getnext options](@ref sgetnextflags).
473 * @return Found schema node if there is some satisfy the provided requirements.
474 */
475const struct lysc_node *lysc_ext_find_node(const struct lysc_ext_instance *ext, const struct lys_module *module,
476 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
477
478/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100479 * @brief When the module comes from YIN format, the argument name is unknown because of missing extension definition
480 * (it might come from import modules which is not yet parsed at that time). Therefore, all the attributes are stored
481 * as substatements and resolving argument is postponed.
482 *
483 * There are 3 places which need the argument, so they resolve it when missing - YIN and YANG printers and extension instance
484 * compiler.
485 *
486 * @param[in] ctx libyang context
487 * @param[in] ext_p Parsed extension to be updated.
488 * @param[in] ext_def Extension definition, found with ::lysp_ext_find_definition().
489 * @return LY_ERR value.
490 */
491LY_ERR lysp_ext_instance_resolve_argument(struct ly_ctx *ctx, struct lysp_ext_instance *ext_p, struct lysp_ext *ext_def);
492
493/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200494 * @brief Iterate over the specified type of the extension instances
495 *
496 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
497 * @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 +0200498 * 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 +0100499 * @param[in] substmt The statement the extension is supposed to belong to.
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200500 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200501 */
Radek Krejcifc596f92021-02-26 22:40:26 +0100502LY_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 +0200503
504/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100505 * @brief Get the covering schema module structure for the given parsed module structure.
Michal Vasko544e58a2021-01-28 14:33:41 +0100506 *
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100507 * @param[in] ctx libyang context to search.
508 * @param[in] mod Parsed schema structure.
509 * @return Corresponding lys_module structure for the given parsed schema structure.
510 */
511struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
512
513/**
Radek Krejci693262f2019-04-29 15:23:20 +0200514 * @brief Stringify YANG built-in type.
Michal Vasko1bf09392020-03-27 12:38:10 +0100515 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200516 * @return Constant string with the name of the built-in type.
517 */
518const char *lys_datatype2str(LY_DATA_TYPE basetype);
519
Michal Vasko405cc9e2020-12-01 12:01:27 +0100520/**
521 * @brief Implement a module (just like ::lys_set_implemented()), can be called recursively.
522 *
523 * @param[in] mod Module to implement.
524 * @param[in] features Array of features to enable.
525 * @param[in,out] unres Global unres to add to.
526 * @return LY_ERR value.
527 */
528LY_ERR lys_set_implemented_r(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
529
Michal Vasko3a41dff2020-07-15 14:30:28 +0200530typedef 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 +0200531 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100532
Radek Krejci693262f2019-04-29 15:23:20 +0200533/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200534 * @brief Create a new module.
Radek Krejcid33273d2018-10-25 14:55:52 +0200535 *
Michal Vasko7a0b0762020-09-02 16:37:01 +0200536 * It is parsed, opionally compiled, added into the context, and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200537 *
538 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200539 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200540 * @param[in] format Format of the input data (YANG or YIN).
Michal Vasko34e334d2021-01-25 16:12:31 +0100541 * @param[in] need_implemented Whether module needs to be implemented and compiled.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100542 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
543 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100544 * @param[in] features Array of features to enable ended with NULL. NULL for all features disabled and '*' for all enabled.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100545 * @param[in,out] unres Global unres structure for newly implemented modules.
Michal Vasko7a0b0762020-09-02 16:37:01 +0200546 * @param[out] module Created module.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200547 * @return LY_ERR value.
Radek Krejcid33273d2018-10-25 14:55:52 +0200548 */
Michal Vasko34e334d2021-01-25 16:12:31 +0100549LY_ERR lys_create_module(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, ly_bool need_implemented,
Michal Vasko405cc9e2020-12-01 12:01:27 +0100550 lys_custom_check custom_check, void *check_data, const char **features, struct lys_glob_unres *unres,
551 struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200552
553/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200554 * @brief Parse submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200555 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100556 * The latest_revision flag of submodule is updated.
557 *
558 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200559 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100560 * @param[in] format Format of the input data (YANG or YIN).
561 * @param[in] main_ctx Parser context of the main module.
562 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
563 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200564 * @param[out] submodule Parsed submodule.
565 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100566 */
Michal Vasko7a0b0762020-09-02 16:37:01 +0200567LY_ERR lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format,
Radek Krejci0f969882020-08-21 16:56:47 +0200568 struct lys_parser_ctx *main_ctx, lys_custom_check custom_check,
569 void *check_data, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100570
571/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200572 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100573 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200574 * @param[in] ctx Context with dictionary where the filepath value will be stored.
575 * @param[in] in Input handler to examine (filepath is not available for all the input types).
576 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200577 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200578void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200579
580/**
Radek Krejci693262f2019-04-29 15:23:20 +0200581 * @brief Get the @ref ifftokens from the given position in the 2bits array
582 * (libyang format of the if-feature expression).
583 * @param[in] list The 2bits array with the compiled if-feature expression.
584 * @param[in] pos Position (0-based) to specify from which position get the operator.
585 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200586uint8_t lysc_iff_getop(uint8_t *list, size_t pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100587
588/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200589 * @brief Macro to free [sized array](@ref sizedarrays) of items using the provided free function. The ARRAY itself is also freed,
590 * but the memory is not sanitized.
591 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100592#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 +0200593
594/**
595 * @brief Macro to free the specified MEMBER of a structure using the provided free function. The memory is not sanitized.
596 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100597#define FREE_MEMBER(CTX, MEMBER, FUNC) if (MEMBER) {(FUNC)(CTX, MEMBER);free(MEMBER);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200598
599/**
600 * @brief Macro to free [sized array](@ref sizedarrays) of strings stored in the context's dictionary. The ARRAY itself is also freed,
601 * but the memory is not sanitized.
602 */
Michal Vaskoe180ed02021-02-05 16:31:20 +0100603#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 +0200604
605/**
Radek Krejci15f10ab2020-11-03 14:14:14 +0100606 * @brief Free the printable YANG schema tree structure. Works for both modules and submodules.
607 *
608 * @param[in] module Printable YANG schema tree structure to free.
609 */
610void lysp_module_free(struct lysp_module *module);
611
612/**
Radek Krejci38d85362019-09-05 16:26:38 +0200613 * @brief Free the parsed type structure.
614 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko8d544252020-03-02 10:19:52 +0100615 * @param[in] type Parsed schema type structure to free. Note that the type itself is not freed.
Radek Krejci38d85362019-09-05 16:26:38 +0200616 */
617void lysp_type_free(struct ly_ctx *ctx, struct lysp_type *type);
Radek Krejci335332a2019-09-05 13:03:35 +0200618
Radek Krejciad5963b2019-09-06 16:03:05 +0200619/**
Michal Vasko8d544252020-03-02 10:19:52 +0100620 * @brief Free the parsed extension instance structure.
621 * @param[in] ctx libyang context where the string data resides in a dictionary.
622 * @param[in] type Parsed extension instance structure to free. Note that the instance itself is not freed.
623 */
624void lysp_ext_instance_free(struct ly_ctx *ctx, struct lysp_ext_instance *ext);
625
626/**
Radek Krejciad5963b2019-09-06 16:03:05 +0200627 * @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.
628 */
Radek Krejci76c8c4e2021-02-17 10:16:48 +0100629LY_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 +0200630
Radek Krejcid33273d2018-10-25 14:55:52 +0200631/**
Michal Vasko20424b42020-08-31 12:29:38 +0200632 * @brief Free a parsed node.
633 *
634 * @param[in] ctx libyang context.
635 * @param[in] node Node to free.
636 */
637void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
638
639/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100640 * @brief Free the compiled type structure.
641 * @param[in] ctx libyang context where the string data resides in a dictionary.
642 * @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.
643 */
644void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
645
646/**
Radek Krejci0af46292019-01-11 16:02:31 +0100647 * @brief Free the compiled if-feature structure.
648 * @param[in] ctx libyang context where the string data resides in a dictionary.
649 * @param[in,out] iff Compiled if-feature structure to be cleaned.
650 * Since the structure is typically part of the sized array, the structure itself is not freed.
651 */
652void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
653
654/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100655 * @brief Free the compiled identity structure.
656 * @param[in] ctx libyang context where the string data resides in a dictionary.
657 * @param[in,out] ident Compiled identity structure to be cleaned.
658 * Since the structure is typically part of the sized array, the structure itself is not freed.
659 */
660void lysc_ident_free(struct ly_ctx *ctx, struct lysc_ident *ident);
661
662/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100663 * @brief Free the compiled must structure.
664 * @param[in] ctx libyang context where the string data resides in a dictionary.
665 * @param[in,out] must Compiled must structure to be cleaned.
666 * Since the structure is typically part of the sized array, the structure itself is not freed.
667 */
668void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
669
670/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100671 * @brief Free the data inside compiled input/output structure.
672 * @param[in] ctx libyang context where the string data resides in a dictionary.
673 * @param[in,out] inout Compiled inout structure to be cleaned.
674 * Since the structure is part of the RPC/action structure, it is not freed itself.
675 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100676void lysc_node_action_inout_free(struct ly_ctx *ctx, struct lysc_node_action_inout *inout);
Radek Krejcif538ce52019-03-05 10:46:14 +0100677
678/**
679 * @brief Free the data inside compiled RPC/action structure.
680 * @param[in] ctx libyang context where the string data resides in a dictionary.
681 * @param[in,out] action Compiled action structure to be cleaned.
682 * Since the structure is typically part of the sized array, the structure itself is not freed.
683 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100684void lysc_node_action_free(struct ly_ctx *ctx, struct lysc_node_action *action);
Radek Krejcif538ce52019-03-05 10:46:14 +0100685
686/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200687 * @brief Free the items inside the compiled Notification structure.
688 * @param[in] ctx libyang context where the string data resides in a dictionary.
Radek Krejci720d2612021-03-03 19:44:22 +0100689 * @param[in,out] notif Compiled Notification structure to be cleaned.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200690 * Since the structure is typically part of the sized array, the structure itself is not freed.
691 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100692void lysc_node_notif_free(struct ly_ctx *ctx, struct lysc_node_notif *notif);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200693
694/**
Radek Krejci720d2612021-03-03 19:44:22 +0100695 * @brief Free the compiled extension definition and NULL the provided pointer.
696 * @param[in] ctx libyang context where the string data resides in a dictionary.
697 * @param[in,out] ext Compiled extendion definition to be freed.
698 */
699void lysc_extension_free(struct ly_ctx *ctx, struct lysc_ext **ext);
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.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100712 * @param[in] node Compiled node structure to be freed.
713 * @param[in] unlink Whether to first unlink the node before freeing.
Radek Krejci19a96102018-11-15 13:38:09 +0100714 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100715void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node, ly_bool unlink);
Radek Krejci19a96102018-11-15 13:38:09 +0100716
717/**
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200718 * @brief Free the compiled container node structure.
719 *
720 * Only the container-specific members are freed, for generic node free function,
Radek Krejci8678fa42020-08-18 16:07:28 +0200721 * use ::lysc_node_free().
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200722 *
723 * @param[in] ctx libyang context where the string data resides in a dictionary.
724 * @param[in,out] node Compiled container node structure to be freed.
725 */
726void lysc_node_container_free(struct ly_ctx *ctx, struct lysc_node_container *node);
727
728/**
Radek Krejci19a96102018-11-15 13:38:09 +0100729 * @brief Free the compiled schema structure.
730 * @param[in,out] module Compiled schema module structure to free.
Radek Krejci19a96102018-11-15 13:38:09 +0100731 */
Radek Krejci90ed21e2021-04-12 14:47:46 +0200732void lysc_module_free(struct lysc_module *module);
Radek Krejci19a96102018-11-15 13:38:09 +0100733
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.
Radek Krejci86d106e2018-10-18 09:53:19 +0200737 */
Radek Krejci90ed21e2021-04-12 14:47:46 +0200738void lys_module_free(struct lys_module *module);
Radek Krejci86d106e2018-10-18 09:53:19 +0200739
740/**
David Sedlák18e494b2018-12-17 03:58:39 +0100741 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200742 *
Michal Vasko63f3d842020-07-08 10:10:14 +0200743 * @param[in,out] in Input structure, is updated.
Radek Krejcid54412f2020-12-17 20:25:35 +0100744 * @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 +0100745 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100746 */
Radek Krejcid54412f2020-12-17 20:25:35 +0100747enum ly_stmt lysp_match_kw(struct ly_in *in, uint64_t *indent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200748
Michal Vasko14654712020-02-06 08:35:21 +0100749/**
750 * @brief Generate path of the given node in the requested format.
751 *
752 * @param[in] node Schema path of this node will be generated.
753 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
754 * @param[in] pathtype Format of the path to generate.
755 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
756 * If NULL, memory for the complete path is allocated.
757 * @param[in] buflen Size of the provided @p buffer.
758 * @return NULL in case of memory allocation error, path of the node otherwise.
759 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
760 */
761char *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 +0200762 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100763
Michal Vasko62ed12d2020-05-21 10:08:25 +0200764/**
Michal Vasko72244882021-01-12 15:21:05 +0100765 * @brief Get nearest @p schema parent (including the node itself) that can be instantiated in data.
Michal Vasko62ed12d2020-05-21 10:08:25 +0200766 *
Michal Vasko72244882021-01-12 15:21:05 +0100767 * @param[in] schema Schema node to get the nearest data node for.
768 * @return Schema data node, NULL if top-level (in data).
Michal Vasko62ed12d2020-05-21 10:08:25 +0200769 */
Michal Vasko72244882021-01-12 15:21:05 +0100770const struct lysc_node *lysc_data_node(const struct lysc_node *schema);
771
772/**
773 * @brief Same as ::lysc_data_node() but never returns the node itself.
774 */
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100775#define lysc_data_parent(SCHEMA) lysc_data_node((SCHEMA)->parent)
Michal Vasko62ed12d2020-05-21 10:08:25 +0200776
Michal Vasko00cbf532020-06-15 13:58:47 +0200777/**
Radek Krejci239c38a2020-10-19 10:58:25 +0200778 * @brief Get format-specific prefix for a module.
779 *
780 * For type plugins available as ::ly_type_print_get_prefix().
781 *
782 * @param[in] mod Module whose prefix to get.
783 * @param[in] format Format of the prefix.
Radek Krejci8df109d2021-04-23 12:19:08 +0200784 * @param[in] prefix_data Format-specific data based on @p format:
Radek Krejci224d4b42021-04-23 13:54:59 +0200785 * LY_VALUE_CANON - NULL
Radek Krejci8df109d2021-04-23 12:19:08 +0200786 * LY_VALUE_SCHEMA - const struct lysp_module * (module used for resolving imports to prefixes)
787 * LY_VALUE_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
788 * LY_VALUE_XML - struct ly_set * (set of all returned modules as ::struct lys_module)
789 * LY_VALUE_JSON - NULL
Radek Krejcif9943642021-04-26 10:18:21 +0200790 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200791 * @return Module prefix to print.
792 * @return NULL on error.
793 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200794const char *ly_get_prefix(const struct lys_module *mod, LY_VALUE_FORMAT format, void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200795
796/**
797 * @brief Resolve format-specific prefixes to modules.
798 *
799 * For type plugins available as ::ly_type_store_resolve_prefix().
800 *
801 * @param[in] ctx libyang context.
802 * @param[in] prefix Prefix to resolve.
803 * @param[in] prefix_len Length of @p prefix.
804 * @param[in] format Format of the prefix.
Radek Krejcif9943642021-04-26 10:18:21 +0200805 * @param[in] prefix_data Format-specific data based on @p format:
806 * LY_VALUE_CANON - NULL
807 * LY_VALUE_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
808 * LY_VALUE_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
809 * LY_VALUE_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
810 * LY_VALUE_JSON - NULL
811 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200812 * @return Resolved prefix module,
813 * @return NULL otherwise.
814 */
Radek Krejcif9943642021-04-26 10:18:21 +0200815const 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 +0200816 LY_VALUE_FORMAT format, const void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200817
Radek Krejci70853c52018-10-15 14:46:16 +0200818#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */