blob: fecccf5bfcfeee7aa2ac7a62e054210a3458963d [file] [log] [blame]
Radek Krejci70853c52018-10-15 14:46:16 +02001/**
2 * @file tree_schema_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
Michal Vasko87cfdba2022-02-22 14:13:45 +01006 * Copyright (c) 2015 - 2022 CESNET, z.s.p.o.
Radek Krejci70853c52018-10-15 14:46:16 +02007 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_SCHEMA_INTERNAL_H_
16#define LY_TREE_SCHEMA_INTERNAL_H_
17
Radek Krejci2d7a47b2019-05-16 13:34:10 +020018#include <stdint.h>
19
Michal Vasko8f702ee2024-02-20 15:44:24 +010020#include "ly_common.h"
Radek Krejci2d7a47b2019-05-16 13:34:10 +020021#include "set.h"
22#include "tree_schema.h"
23
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020024struct lysc_ctx;
Michal Vasko405cc9e2020-12-01 12:01:27 +010025struct lys_glob_unres;
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020026
Radek Krejcif13b87b2020-12-01 22:02:17 +010027#define LY_YANG_SUFFIX ".yang"
28#define LY_YANG_SUFFIX_LEN 5
29#define LY_YIN_SUFFIX ".yin"
30#define LY_YIN_SUFFIX_LEN 4
31
FredGand944bdc2019-11-05 21:57:07 +080032#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
33
Radek Krejcif13b87b2020-12-01 22:02:17 +010034#define LY_PCRE2_MSG_LIMIT 256
35
Radek Krejci335332a2019-09-05 13:03:35 +020036/**
aPiecek93582ed2021-05-25 14:49:06 +020037 * @brief The maximum depth at which the last nested block is located.
38 * Designed to protect against corrupted input that causes a stack-overflow error.
39 * For yang language and json format, the block is bounded by "{ }".
40 * For the xml format, the opening and closing element tag is considered as the block.
41 */
42#define LY_MAX_BLOCK_DEPTH 500
43
Radek Krejcieccf6602021-02-05 19:42:54 +010044/* list of the deviate modifications strings */
45extern const char * const ly_devmod_list[];
46#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
47
48/**
Radek Krejci335332a2019-09-05 13:03:35 +020049 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
50 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
51 * @param[in] CTX yang parser context to get current module and for logging.
52 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
53 * @param[in] PARENT parent statement where the KW is present - for logging.
54 */
55#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
Michal Vasko8a67eff2021-12-07 14:04:47 +010056 if (PARSER_CUR_PMOD(CTX)->version < LYS_VERSION_1_1) {LOGVAL_PARSER((CTX), LY_VCODE_INCHILDSTMT2, KW, PARENT); return LY_EVALID;}
Radek Krejcid33273d2018-10-25 14:55:52 +020057
Radek Krejcia9026eb2018-12-12 16:04:47 +010058/* These 2 macros checks YANG's identifier grammar rule */
59#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
60#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020061 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010062
David Sedlák4a650532019-07-10 11:55:18 +020063/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020064#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020065 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
66 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
67 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
68 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
69 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
70 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
71 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
72 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
73 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
74
Radek Krejci70853c52018-10-15 14:46:16 +020075/**
David Sedlákca36c422019-07-12 12:47:55 +020076 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
77 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
78 *
79 * @param[in] CTX yang parser context for logging.
80 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
81 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
82 * @param[in] STMT Name of the compared YANG statements for logging.
83 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
84 */
85#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
86 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +020087 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +020088 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +020089 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
90 return LY_EVALID; \
91 } \
92 } \
93 }
94
Michal Vaskob36053d2020-03-26 15:49:30 +010095#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +020096 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +010097 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +020098 }
Radek Krejci70853c52018-10-15 14:46:16 +020099
Radek Krejcif13b87b2020-12-01 22:02:17 +0100100/*
101 * Additional YANG constants
102 */
103#define Y_TAB_SPACES 8 /**< number of spaces instead of tab character */
104#define LY_TYPE_DEC64_FD_MAX 18 /**< Maximal value of decimal64's fraction-digits */
105
Radek Krejci70853c52018-10-15 14:46:16 +0200106/**
Radek Krejcie3846472018-10-15 15:24:51 +0200107 * @brief List of YANG statement groups - the (sub)module's substatements
108 */
109enum yang_module_stmt {
110 Y_MOD_MODULE_HEADER,
111 Y_MOD_LINKAGE,
112 Y_MOD_META,
113 Y_MOD_REVISION,
114 Y_MOD_BODY
115};
116
117/**
118 * @brief Types of arguments of YANG statements
119 */
120enum yang_arg {
121 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +0100122 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +0200123 Y_STR_ARG, /**< YANG "string" rule */
124 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
125};
126
Michal Vasko8a67eff2021-12-07 14:04:47 +0100127#define PARSER_CUR_PMOD(CTX) ((struct lysp_module *)(CTX)->parsed_mods->objs[(CTX)->parsed_mods->count - 1])
Michal Vaskob425bb32022-11-08 10:49:36 +0100128#define PARSER_CTX(CTX) ((CTX) ? PARSER_CUR_PMOD(CTX)->mod->ctx : NULL)
129#define LOGVAL_PARSER(CTX, ...) LOGVAL(PARSER_CTX(CTX), __VA_ARGS__)
Michal Vaskob36053d2020-03-26 15:49:30 +0100130
Michal Vaskod0625d72022-10-06 15:02:50 +0200131struct lysp_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200132 LYS_INFORMAT format; /**< parser format */
133 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200134 submodule, use ::lysp_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200135 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200136 submodule, use ::lysp_ctx.main_ctx instead. */
Michal Vaskoc0c64ae2022-10-06 10:15:23 +0200137 struct ly_set ext_inst; /**< parsed extension instances to finish parsing */
Michal Vasko193dacd2022-10-13 08:43:05 +0200138
Michal Vasko8a67eff2021-12-07 14:04:47 +0100139 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
Michal Vaskod0625d72022-10-06 15:02:50 +0200140 struct lysp_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
aPiecek8d4e75d2021-06-24 14:47:06 +0200141 then should be set to the context of the module to which it belongs,
142 otherwise it points to the beginning of this 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 Vaskod0625d72022-10-06 15:02:50 +0200148struct lysp_yang_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200149 LYS_INFORMAT format; /**< parser format */
150 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200151 submodule, use ::lysp_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200152 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200153 submodule, use ::lysp_ctx.main_ctx instead. */
Michal Vaskoc0c64ae2022-10-06 10:15:23 +0200154 struct ly_set ext_inst; /**< parsed extension instances to finish parsing */
Michal Vasko193dacd2022-10-13 08:43:05 +0200155
Michal Vasko8a67eff2021-12-07 14:04:47 +0100156 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
Michal Vaskod0625d72022-10-06 15:02:50 +0200157 struct lysp_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
aPiecek8d4e75d2021-06-24 14:47:06 +0200158 then should be set to the context of the module to which it belongs,
159 otherwise it points to the beginning of this structure. */
160 struct ly_in *in; /**< input handler for the parser */
161 uint64_t indent; /**< current position on the line for YANG indentation */
162 uint32_t depth; /**< current number of nested blocks, see ::LY_MAX_BLOCK_DEPTH */
Radek Krejci70853c52018-10-15 14:46:16 +0200163};
164
David Sedlákebd3acf2019-07-26 15:04:32 +0200165/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200166 * @brief Internal context for yin schema parser.
167 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200168struct lysp_yin_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200169 LYS_INFORMAT format; /**< parser format */
170 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200171 submodule, use ::lysp_ctx.main_ctx instead. */
aPiecek8d4e75d2021-06-24 14:47:06 +0200172 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
Michal Vaskod0625d72022-10-06 15:02:50 +0200173 submodule, use ::lysp_ctx.main_ctx instead. */
Michal Vaskoc0c64ae2022-10-06 10:15:23 +0200174 struct ly_set ext_inst; /**< parsed extension instances to finish parsing */
Michal Vasko193dacd2022-10-13 08:43:05 +0200175
Michal Vasko8a67eff2021-12-07 14:04:47 +0100176 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
Michal Vaskod0625d72022-10-06 15:02:50 +0200177 struct lysp_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
aPiecek8d4e75d2021-06-24 14:47:06 +0200178 then should be set to the context of the module to which it belongs,
179 otherwise it points to the beginning of this structure. */
180 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200181};
182
183/**
Michal Vasko193dacd2022-10-13 08:43:05 +0200184 * @brief Check that @p c is valid UTF8 code point for YANG string.
David Sedlák4a650532019-07-10 11:55:18 +0200185 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100186 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200187 * @param[in] c UTF8 code point of a character to check.
188 * @return LY_ERR values.
189 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200190LY_ERR lysp_check_stringchar(struct lysp_ctx *ctx, uint32_t c);
David Sedlák4a650532019-07-10 11:55:18 +0200191
192/**
Michal Vasko193dacd2022-10-13 08:43:05 +0200193 * @brief Check that @p c is valid UTF8 code point for YANG identifier.
David Sedlák4a650532019-07-10 11:55:18 +0200194 *
Michal Vasko9ff8d2d2022-09-29 13:41:14 +0200195 * @param[in] ctx parser context for logging. If NULL, does not log.
David Sedlák4a650532019-07-10 11:55:18 +0200196 * @param[in] c UTF8 code point of a character to check.
197 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
198 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
199 * 0 - colon not yet found (no prefix)
Michal Vasko193dacd2022-10-13 08:43:05 +0200200 * 1 - @p c is the colon character
David Sedlák4a650532019-07-10 11:55:18 +0200201 * 2 - prefix already processed, now processing the identifier
202 *
203 * If the identifier cannot be prefixed, NULL is expected.
204 * @return LY_ERR values.
205 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200206LY_ERR lysp_check_identifierchar(struct lysp_ctx *ctx, uint32_t c, ly_bool first, uint8_t *prefix);
David Sedlák4a650532019-07-10 11:55:18 +0200207
208/**
Radek Krejci70853c52018-10-15 14:46:16 +0200209 * @brief Check the currently present prefixes in the module for collision with the new one.
210 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100211 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100212 * @param[in] imports List of current imports of the module to check prefix collision.
213 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200214 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
215 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
216 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200217LY_ERR lysp_check_prefix(struct lysp_ctx *ctx, struct lysp_import *imports, const char *module_prefix, const char **value);
Radek Krejci70853c52018-10-15 14:46:16 +0200218
Radek Krejci86d106e2018-10-18 09:53:19 +0200219/**
220 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
221 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100222 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200223 * @param[in] date Date string to check (non-necessarily terminated by \0)
224 * @param[in] date_len Length of the date string, 10 expected.
225 * @param[in] stmt Statement name for error message.
226 * @return LY_ERR value.
227 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200228LY_ERR lysp_check_date(struct lysp_ctx *ctx, const char *date, size_t date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100229
230/**
Michal Vaskoedb0fa52022-10-04 10:36:00 +0200231 * @brief Find type specified type definition.
232 *
233 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
234 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
235 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
236 * @param[in] ext Extension where the type is being instantiated, if any.
237 * @param[out] type Built-in type identifier of the id. If #LY_TYPE_UNKNOWN, tpdf is expected to contain found YANG schema typedef statement.
238 * @param[out] tpdf Found type definition.
239 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
240 * @return LY_ERR value.
241 */
242LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, const struct lysp_module *start_module,
243 const struct lysc_ext_instance *ext, LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node);
244
245/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100246 * @brief Check names of typedefs in the parsed module to detect collisions.
247 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100248 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
249 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100250 * @return LY_ERR value.
251 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200252LY_ERR lysp_check_dup_typedefs(struct lysp_ctx *ctx, struct lysp_module *mod);
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100253
254/**
aPiecek63e080d2021-06-29 13:53:28 +0200255 * @brief Check names of groupings in the parsed module to detect collisions.
256 *
257 * @param[in] ctx Parser context for logging and to maintain grps_nodes.
258 * @param[in] mod Module where the type is being defined.
259 * @return LY_ERR value.
260 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200261LY_ERR lysp_check_dup_groupings(struct lysp_ctx *ctx, struct lysp_module *mod);
aPiecek63e080d2021-06-29 13:53:28 +0200262
263/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100264 * @brief Check names of features in the parsed module and submodules to detect collisions.
265 *
266 * @param[in] ctx Parser context.
267 * @param[in] mod Module where the type is being defined.
268 * @return LY_ERR value.
269 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200270LY_ERR lysp_check_dup_features(struct lysp_ctx *ctx, struct lysp_module *mod);
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100271
272/**
273 * @brief Check names of identities in the parsed module and submodules to detect collisions.
274 *
275 * @param[in] ctx Parser context.
276 * @param[in] mod Module where the type is being defined.
277 * @return LY_ERR value.
278 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200279LY_ERR lysp_check_dup_identities(struct lysp_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200280
281/**
282 * @brief Just move the newest revision into the first position, does not sort the rest
283 * @param[in] revs Sized-array of the revisions in a printable schema tree.
284 */
285void lysp_sort_revisions(struct lysp_revision *revs);
286
287/**
David Sedlák6544c182019-07-12 13:17:33 +0200288 * @brief Validate enum name.
289 *
290 * @param[in] ctx yang parser context for logging.
291 * @param[in] name String to check.
292 * @param[in] name_len Length of name.
293 *
294 * @return LY_ERR values
295 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200296LY_ERR lysp_check_enum_name(struct lysp_ctx *ctx, const char *name, size_t name_len);
David Sedlák6544c182019-07-12 13:17:33 +0200297
298/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200299 * @brief Find source data for a specific module, parse it, and add into the context.
Radek Krejci086c7132018-10-26 15:29:04 +0200300 *
301 * @param[in] ctx libyang context.
302 * @param[in] name Name of the module to load.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200303 * @param[in] revision Optional revision of the module to load. If NULL, the newest revision is loaded.
Michal Vaskodd992582021-06-10 14:34:57 +0200304 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko18a86e52021-04-16 11:50:13 +0200305 * @param[out] mod Created module structure.
Michal Vasko4e205e82021-06-08 14:01:47 +0200306 * @return LY_SUCCESS on success.
307 * @return LY_ERR on error.
Radek Krejci086c7132018-10-26 15:29:04 +0200308 */
Michal Vaskodd992582021-06-10 14:34:57 +0200309LY_ERR lys_parse_load(struct ly_ctx *ctx, const char *name, const char *revision, struct ly_set *new_mods,
Michal Vasko4e205e82021-06-08 14:01:47 +0200310 struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200311
312/**
Radek Krejci771928a2021-01-19 13:42:36 +0100313 * @brief Parse included submodules into the simply parsed YANG module.
314 *
315 * YANG 1.0 does not require the main module to include all the submodules. Therefore, parsing submodules can cause
316 * reallocating and extending the includes array in the main module by the submodules included only in submodules.
Radek Krejcid33273d2018-10-25 14:55:52 +0200317 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200318 * @param[in] pctx main parser context
Radek Krejci771928a2021-01-19 13:42:36 +0100319 * @param[in] pmod Parsed module with the includes array to be processed.
aPiecekc3e26142021-06-22 14:25:49 +0200320 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Radek Krejcid33273d2018-10-25 14:55:52 +0200321 * @return LY_ERR value.
322 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200323LY_ERR lysp_load_submodules(struct lysp_ctx *pctx, struct lysp_module *pmod, struct ly_set *new_mods);
Radek Krejcid33273d2018-10-25 14:55:52 +0200324
325/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100326 * @brief Get address of a node's actions list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100327 * Decides the node's type and in case it has an actions list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100328 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100329 * @param[in] node Node to check.
330 * @return Address of the node's actions member if any, NULL otherwise.
331 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100332struct lysp_node_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100333
334/**
335 * @brief Get address of a node's notifications list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100336 * Decides the node's type and in case it has a notifications list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100337 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100338 * @param[in] node Node to check.
339 * @return Address of the node's notifs member if any, NULL otherwise.
340 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100341struct lysp_node_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100342
343/**
344 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100345 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100346 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100347 * @param[in] node Node to check.
348 * @return Address of the node's child member if any, NULL otherwise.
349 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100350struct lysp_node **lysp_node_child_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100351
352/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100353 * @brief Get the address of the node's musts member, if any.
354 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100355 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100356 * @param[in] node Node to examine.
357 * @return The address of the node's musts member if any, NULL otherwise.
358 */
359struct lysp_restr **lysp_node_musts_p(const struct lysp_node *node);
360
361/**
362 * @brief Get the node's musts member, if any.
363 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100364 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100365 * @param[in] node Node to examine.
366 * @return The node's musts member if any, NULL otherwise.
367 */
368struct lysp_restr *lysp_node_musts(const struct lysp_node *node);
369
370/**
371 * @brief Get the address of the node's when member, if any.
372 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100373 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100374 * @param[in] node Node to examine.
375 * @return The address of the node's when member if any, NULL otherwise.
376 */
377struct lysp_when **lysp_node_when_p(const struct lysp_node *node);
378
379/**
380 * @brief Get the node's when member, if any.
381 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100382 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100383 * @param[in] node Node to examine.
384 * @return The node's when member if any, NULL otherwise.
385 */
386struct lysp_when *lysp_node_when(const struct lysp_node *node);
387
388/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100389 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100390 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100391 *
392 * Do not use for RPC and action nodes.
393 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100394 * @param[in] node Node to check.
395 * @return Address of the node's child member if any, NULL otherwise.
396 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100397struct lysc_node **lysc_node_child_p(const struct lysc_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100398
399/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200400 * @brief Get address of a node's notifs pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200401 * Decides the node's type and in case it has a notifs array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100402 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200403 * @param[in] node Node to check.
404 * @return Address of the node's notifs member if any, NULL otherwise.
405 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100406struct lysc_node_notif **lysc_node_notifs_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200407
408/**
409 * @brief Get address of a node's actions pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200410 * Decides the node's type and in case it has a actions array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100411 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200412 * @param[in] node Node to check.
413 * @return Address of the node's actions member if any, NULL otherwise.
414 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100415struct lysc_node_action **lysc_node_actions_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200416
417/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100418 * @brief Get address of a node's when member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100419 * Decides the node's type and in case it has a when member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100420 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100421 * @param[in] node Node to check.
422 * @return Address of the node's when member if any, NULL otherwise.
423 */
424struct lysc_when ***lysc_node_when_p(const struct lysc_node *node);
425
426/**
427 * @brief Get address of a node's musts member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100428 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100429 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100430 * @param[in] node Node to check.
431 * @return Address of the node's musts member if any, NULL otherwise.
432 */
433struct lysc_must **lysc_node_musts_p(const struct lysc_node *node);
434
435/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100436 * @brief Find parsed extension definition for the given extension instance.
437 *
438 * @param[in] ctx libyang context.
439 * @param[in] ext Extension instance for which the definition will be searched.
Michal Vasko193dacd2022-10-13 08:43:05 +0200440 * @param[out] ext_mod Module of the extension definition of @p ext.
441 * @param[out] ext_def Optional found extension definition.
Radek Krejci85ac8312021-03-03 20:21:33 +0100442 * @return LY_SUCCESS when the definition was found.
443 * @return LY_EVALID when the extension instance is invalid and/or the definition not found.
444 */
445LY_ERR lysp_ext_find_definition(const struct ly_ctx *ctx, const struct lysp_ext_instance *ext, const struct lys_module **ext_mod,
446 struct lysp_ext **ext_def);
447
448/**
Radek Krejciba05eab2021-03-10 13:19:29 +0100449 * @brief Get schema node in extension instance according to the given parameters.
450 *
451 * Wraps ::lys_getnext_ext() and match according to the given arguments.
452 *
453 * @param[in] ext Extension instance which top-level schema node is being searched.
454 * @param[in] module Optional parameter to match the extension instance's (and its data) module.
455 * @param[in] name Name of the schema node to find, if the string is not NULL-terminated, the @p name_len must be set.
456 * @param[in] name_len Length of the @p name string, use in case the @p name is not NULL-terminated string.
457 * @param[in] nodetype Allowed [type of the node](@ref schemanodetypes).
458 * @param[in] options ORed [lys_getnext options](@ref sgetnextflags).
459 * @return Found schema node if there is some satisfy the provided requirements.
460 */
461const struct lysc_node *lysc_ext_find_node(const struct lysc_ext_instance *ext, const struct lys_module *module,
462 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
463
464/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100465 * @brief When the module comes from YIN format, the argument name is unknown because of missing extension definition
466 * (it might come from import modules which is not yet parsed at that time). Therefore, all the attributes are stored
467 * as substatements and resolving argument is postponed.
468 *
Radek Krejci85ac8312021-03-03 20:21:33 +0100469 * @param[in] ctx libyang context
470 * @param[in] ext_p Parsed extension to be updated.
Radek Krejci85ac8312021-03-03 20:21:33 +0100471 * @return LY_ERR value.
472 */
Michal Vasko193dacd2022-10-13 08:43:05 +0200473LY_ERR lysp_ext_instance_resolve_argument(struct ly_ctx *ctx, struct lysp_ext_instance *ext_p);
Radek Krejci85ac8312021-03-03 20:21:33 +0100474
475/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200476 * @brief Iterate over the specified type of the extension instances
477 *
478 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
Michal Vasko193dacd2022-10-13 08:43:05 +0200479 * @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 +0200480 * 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 +0100481 * @param[in] substmt The statement the extension is supposed to belong to.
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200482 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200483 */
Radek Krejcifc596f92021-02-26 22:40:26 +0100484LY_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 +0200485
486/**
Radek Krejci693262f2019-04-29 15:23:20 +0200487 * @brief Stringify YANG built-in type.
Michal Vaskoedb0fa52022-10-04 10:36:00 +0200488 *
Michal Vasko1bf09392020-03-27 12:38:10 +0100489 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200490 * @return Constant string with the name of the built-in type.
491 */
492const char *lys_datatype2str(LY_DATA_TYPE basetype);
493
Michal Vasko405cc9e2020-12-01 12:01:27 +0100494/**
Michal Vasko65333882021-06-10 14:12:16 +0200495 * @brief Implement a module and resolve all global unres.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100496 *
497 * @param[in] mod Module to implement.
Michal Vasko4e205e82021-06-08 14:01:47 +0200498 * @param[in] features Features to set, see ::lys_set_features().
Michal Vasko65333882021-06-10 14:12:16 +0200499 * @param[in] unres Global unres with all the created modules.
500 * @return LY_SUCCESS on success.
Michal Vasko4e205e82021-06-08 14:01:47 +0200501 * @return LY_ERR on error.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100502 */
Michal Vasko65333882021-06-10 14:12:16 +0200503LY_ERR _lys_set_implemented(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
Michal Vasko405cc9e2020-12-01 12:01:27 +0100504
Michal Vaskof4258e12021-06-15 12:11:42 +0200505/**
506 * @brief Create dependency sets for all modules in a context.
Michal Vasko50bc09a2021-06-17 17:31:56 +0200507 * Also sets to_compile flags for all the modules that should be (re)compiled.
Michal Vaskof4258e12021-06-15 12:11:42 +0200508 *
509 * @param[in] ctx Context to use.
510 * @param[in,out] main_set Set of dependency module sets.
511 * @param[in] mod Optional only module whose dependency set is needed, otherwise all sets are created.
512 * @return LY_ERR value.
513 */
Michal Vasko50bc09a2021-06-17 17:31:56 +0200514LY_ERR lys_unres_dep_sets_create(struct ly_ctx *ctx, struct ly_set *main_set, struct lys_module *mod);
Michal Vaskof4258e12021-06-15 12:11:42 +0200515
516/**
517 * @brief Revert changes stored in global compile context after a failed compilation.
518 *
519 * @param[in] ctx libyang context.
520 * @param[in] unres Global unres to use.
521 */
522void lys_unres_glob_revert(struct ly_ctx *ctx, struct lys_glob_unres *unres);
523
524/**
525 * @brief Erase the global compile context.
526 *
527 * @param[in] unres Global unres to erase.
528 */
529void lys_unres_glob_erase(struct lys_glob_unres *unres);
530
Michal Vasko3a41dff2020-07-15 14:30:28 +0200531typedef 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 +0200532 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100533
Radek Krejci693262f2019-04-29 15:23:20 +0200534/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200535 * @brief Parse a module and add it into the context.
Radek Krejcid33273d2018-10-25 14:55:52 +0200536 *
537 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200538 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200539 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejci9ed7a192018-10-31 16:23:51 +0100540 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
541 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vaskodd992582021-06-10 14:34:57 +0200542 * @param[in,out] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko7a0b0762020-09-02 16:37:01 +0200543 * @param[out] module Created module.
Michal Vaskodd992582021-06-10 14:34:57 +0200544 * @return LY_SUCCESS on success.
545 * @return LY_ERR on error, @p new_mods may be modified.
Radek Krejcid33273d2018-10-25 14:55:52 +0200546 */
Michal Vasko4e205e82021-06-08 14:01:47 +0200547LY_ERR lys_parse_in(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, lys_custom_check custom_check,
Michal Vaskodd992582021-06-10 14:34:57 +0200548 void *check_data, struct ly_set *new_mods, struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200549
550/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200551 * @brief Parse submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200552 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100553 * The latest_revision flag of submodule is updated.
554 *
555 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200556 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100557 * @param[in] format Format of the input data (YANG or YIN).
558 * @param[in] main_ctx Parser context of the main module.
559 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
560 * @param[in] check_data Caller's data to pass to the custom_check callback.
aPiecekc3e26142021-06-22 14:25:49 +0200561 * @param[in] new_mods Set of all the new mods added to the context. Includes this module and all of its imports.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200562 * @param[out] submodule Parsed submodule.
563 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100564 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200565LY_ERR lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, struct lysp_ctx *main_ctx,
aPiecekc3e26142021-06-22 14:25:49 +0200566 lys_custom_check custom_check, void *check_data, struct ly_set *new_mods, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100567
568/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200569 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100570 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200571 * @param[in] ctx Context with dictionary where the filepath value will be stored.
572 * @param[in] in Input handler to examine (filepath is not available for all the input types).
573 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200574 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200575void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200576
577/**
Radek Krejci693262f2019-04-29 15:23:20 +0200578 * @brief Get the @ref ifftokens from the given position in the 2bits array
579 * (libyang format of the if-feature expression).
580 * @param[in] list The 2bits array with the compiled if-feature expression.
581 * @param[in] pos Position (0-based) to specify from which position get the operator.
582 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200583uint8_t lysc_iff_getop(uint8_t *list, size_t pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100584
585/**
David Sedlák18e494b2018-12-17 03:58:39 +0100586 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200587 *
Michal Vasko63f3d842020-07-08 10:10:14 +0200588 * @param[in,out] in Input structure, is updated.
Radek Krejcid54412f2020-12-17 20:25:35 +0100589 * @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 +0100590 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100591 */
Radek Krejcid54412f2020-12-17 20:25:35 +0100592enum ly_stmt lysp_match_kw(struct ly_in *in, uint64_t *indent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200593
Michal Vasko14654712020-02-06 08:35:21 +0100594/**
595 * @brief Generate path of the given node in the requested format.
596 *
597 * @param[in] node Schema path of this node will be generated.
598 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
599 * @param[in] pathtype Format of the path to generate.
600 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
601 * If NULL, memory for the complete path is allocated.
602 * @param[in] buflen Size of the provided @p buffer.
603 * @return NULL in case of memory allocation error, path of the node otherwise.
604 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
605 */
606char *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 +0200607 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100608
Michal Vasko62ed12d2020-05-21 10:08:25 +0200609/**
Radek Krejci239c38a2020-10-19 10:58:25 +0200610 * @brief Get format-specific prefix for a module.
611 *
Radek Krejci84d7fd72021-07-14 18:32:21 +0200612 * This function is available for type plugins via ::lyplg_type_get_prefix() API function.
Radek Krejci239c38a2020-10-19 10:58:25 +0200613 *
614 * @param[in] mod Module whose prefix to get.
615 * @param[in] format Format of the prefix.
Radek Krejci8df109d2021-04-23 12:19:08 +0200616 * @param[in] prefix_data Format-specific data based on @p format:
Radek Krejci224d4b42021-04-23 13:54:59 +0200617 * LY_VALUE_CANON - NULL
Radek Krejci84d7fd72021-07-14 18:32:21 +0200618 * LY_VALUE_SCHEMA - const struct ::lysp_module* (module used for resolving imports to prefixes)
619 * LY_VALUE_SCHEMA_RESOLVED - struct ::lysc_prefix* (sized array of pairs: prefix - module)
620 * LY_VALUE_XML - struct ::ly_set* (set of all returned modules as struct ::lys_module)
Radek Krejci8df109d2021-04-23 12:19:08 +0200621 * LY_VALUE_JSON - NULL
Radek Krejcif9943642021-04-26 10:18:21 +0200622 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200623 * @return Module prefix to print.
624 * @return NULL on error.
625 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200626const char *ly_get_prefix(const struct lys_module *mod, LY_VALUE_FORMAT format, void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200627
628/**
629 * @brief Resolve format-specific prefixes to modules.
630 *
Radek Krejci239c38a2020-10-19 10:58:25 +0200631 * @param[in] ctx libyang context.
632 * @param[in] prefix Prefix to resolve.
633 * @param[in] prefix_len Length of @p prefix.
634 * @param[in] format Format of the prefix.
Radek Krejcif9943642021-04-26 10:18:21 +0200635 * @param[in] prefix_data Format-specific data based on @p format:
636 * LY_VALUE_CANON - NULL
637 * LY_VALUE_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
638 * LY_VALUE_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
639 * LY_VALUE_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
640 * LY_VALUE_JSON - NULL
641 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200642 * @return Resolved prefix module,
643 * @return NULL otherwise.
644 */
Radek Krejcif9943642021-04-26 10:18:21 +0200645const 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 +0200646 LY_VALUE_FORMAT format, const void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200647
Michal Vaskof4258e12021-06-15 12:11:42 +0200648/**
649 * @brief Learn whether @p PMOD needs to be recompiled if it is implemented.
650 *
651 * @param[in] PMOD Parsed module or submodule.
652 * @return Whether it has statements that are recompiled or not.
653 */
654#define LYSP_HAS_RECOMPILED(PMOD) \
655 (PMOD->data || PMOD->rpcs || PMOD->notifs || PMOD->exts)
656
657/**
658 * @brief Learn whether the module has statements that need to be recompiled or not.
659 *
660 * @param[in] mod Module to examine.
661 * @return Whether it has statements that are recompiled or not.
662 */
663ly_bool lys_has_recompiled(const struct lys_module *mod);
664
665/**
666 * @brief Learn whether @p PMOD needs to be compiled if it is implemented.
667 *
668 * @param[in] PMOD Parsed module or submodule.
669 * @return Whether it needs (has) a compiled module or not.
670 */
671#define LYSP_HAS_COMPILED(PMOD) \
aPiecek6b3d5422021-07-30 15:55:43 +0200672 (LYSP_HAS_RECOMPILED(PMOD) || PMOD->augments || PMOD->deviations)
Michal Vaskof4258e12021-06-15 12:11:42 +0200673
674/**
675 * @brief Learn whether the module has statements that need to be compiled or not.
676 *
677 * @param[in] mod Module to examine.
678 * @return Whether it needs compiled module or not.
679 */
680ly_bool lys_has_compiled(const struct lys_module *mod);
681
Michal Vasko7ee5be22021-06-16 17:03:34 +0200682/**
683 * @brief Learn whether the module has any grouping statements or not.
684 *
685 * @param[in] mod Module to examine.
686 * @return Whether it has groupings or not.
687 */
Michal Vasko87cfdba2022-02-22 14:13:45 +0100688ly_bool lys_has_dep_mods(const struct lys_module *mod);
Michal Vasko7ee5be22021-06-16 17:03:34 +0200689
Michal Vasko0bccbf12021-11-22 09:59:57 +0100690/**
Michal Vaskob872d0f2022-12-08 09:36:54 +0100691 * @brief Get YANG string keyword of a statement.
692 *
693 * @return YANG string keyword of the statement.
694 */
695const char *lys_stmt_str(enum ly_stmt stmt);
696
697/**
698 * @brief Get YIN argument (attribute) name of a statement.
699 *
700 * @return YIN argument name, if any.
701 */
702const char *lys_stmt_arg(enum ly_stmt stmt);
703
704#define LY_STMT_FLAG_YIN 0x1 /**< has YIN element */
705#define LY_STMT_FLAG_ID 0x2 /**< the value is identifier -> no quotes */
706
707/**
708 * @brief Get statement printer flags.
709 *
710 * @return Additional statement information as LY_STMT_FLAG_* flags.
711 */
712uint8_t lys_stmt_flags(enum ly_stmt stmt);
713
714/**
Michal Vasko0bccbf12021-11-22 09:59:57 +0100715 * @brief Learn whether the module qualifies for a single dep set with only this module or not.
716 *
717 * @param[in] mod Module to examine.
718 * @return Whether it qualifies as a single dep set or not.
719 */
720#define LYS_IS_SINGLE_DEP_SET(mod) \
721 (!(mod)->parsed->features && (!lys_has_compiled(mod) || ((mod)->compiled && !lys_has_recompiled(mod))))
722
Michal Vasko193dacd2022-10-13 08:43:05 +0200723/**
724 * @brief Get pointer to a compiled ext instance storage for a specific statement.
725 *
726 * @param[in] ext Compiled ext instance.
727 * @param[in] stmt Compiled statement. Can be a mask when the first match is returned, it is expected the storage is
728 * the same for all the masked statements.
729 * @param[out] storage_p Pointer to a compiled ext instance substatement storage, NULL if was not compiled.
730 * @return LY_SUCCESS on success.
731 * @return LY_ENOT if the substatement is not supported.
732 */
733LY_ERR lyplg_ext_get_storage_p(const struct lysc_ext_instance *ext, int stmt, const void ***storage_p);
734
Jan Kundrát026737b2023-09-05 13:03:30 +0200735/**
736 * @brief Warning if the filename does not match the expected module name and version
737 *
738 * @param[in] ctx Context for logging
739 * @param[in] name Expected module name
740 * @param[in] revision Expected module revision, or NULL if not to be checked
741 * @param[in] filename File path to be checked
742 */
743void ly_check_module_filename(const struct ly_ctx *ctx, const char *name, const char *revision, const char *filename);
744
Radek Krejci70853c52018-10-15 14:46:16 +0200745#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */