blob: 94205d6cfadac313ae4b1757ac0bd4b8ccd7f2d4 [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
Radek Krejci535ea9f2020-05-29 16:01:05 +020020#include "common.h"
Radek Krejci2d7a47b2019-05-16 13:34:10 +020021#include "set.h"
22#include "tree_schema.h"
23
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020024struct lysc_ctx;
Michal Vasko405cc9e2020-12-01 12:01:27 +010025struct lys_glob_unres;
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020026
Radek Krejcif13b87b2020-12-01 22:02:17 +010027#define LY_YANG_SUFFIX ".yang"
28#define LY_YANG_SUFFIX_LEN 5
29#define LY_YIN_SUFFIX ".yin"
30#define LY_YIN_SUFFIX_LEN 4
31
FredGand944bdc2019-11-05 21:57:07 +080032#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
33
Radek Krejcif13b87b2020-12-01 22:02:17 +010034#define LY_PCRE2_MSG_LIMIT 256
35
Radek Krejci335332a2019-09-05 13:03:35 +020036/**
aPiecek93582ed2021-05-25 14:49:06 +020037 * @brief The maximum depth at which the last nested block is located.
38 * Designed to protect against corrupted input that causes a stack-overflow error.
39 * For yang language and json format, the block is bounded by "{ }".
40 * For the xml format, the opening and closing element tag is considered as the block.
41 */
42#define LY_MAX_BLOCK_DEPTH 500
43
44/**
Radek Krejcieccf6602021-02-05 19:42:54 +010045 * @brief Informational structure for YANG statements
46 */
47struct stmt_info_s {
48 const char *name; /**< name of the statement */
49 const char *arg; /**< name of YIN's attribute to present the statement */
50 uint8_t flags; /**< various flags to clarify printing of the statement */
Michal Vasko26bbb272022-08-02 14:54:33 +020051
Radek Krejcieccf6602021-02-05 19:42:54 +010052#define STMT_FLAG_YIN 0x1 /**< has YIN element */
53#define STMT_FLAG_ID 0x2 /**< the value is identifier -> no quotes */
54};
55
56/* statements informations filled in tree_schema.c */
57extern struct stmt_info_s stmt_attr_info[];
58
Radek Krejcieccf6602021-02-05 19:42:54 +010059/* list of the deviate modifications strings */
60extern const char * const ly_devmod_list[];
61#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
62
63/**
Radek Krejci335332a2019-09-05 13:03:35 +020064 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
65 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
66 * @param[in] CTX yang parser context to get current module and for logging.
67 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
68 * @param[in] PARENT parent statement where the KW is present - for logging.
69 */
70#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
Michal Vasko8a67eff2021-12-07 14:04:47 +010071 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 +020072
Radek Krejcia9026eb2018-12-12 16:04:47 +010073/* These 2 macros checks YANG's identifier grammar rule */
74#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
75#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020076 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010077
David Sedlák4a650532019-07-10 11:55:18 +020078/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020079#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020080 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
81 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
82 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
83 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
84 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
85 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
86 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
87 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
88 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
89
Radek Krejci70853c52018-10-15 14:46:16 +020090/**
David Sedlákca36c422019-07-12 12:47:55 +020091 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
92 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
93 *
94 * @param[in] CTX yang parser context for logging.
95 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
96 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
97 * @param[in] STMT Name of the compared YANG statements for logging.
98 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
99 */
100#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
101 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200102 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +0200103 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +0200104 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
105 return LY_EVALID; \
106 } \
107 } \
108 }
109
Michal Vaskob36053d2020-03-26 15:49:30 +0100110#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +0200111 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +0100112 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +0200113 }
Radek Krejci70853c52018-10-15 14:46:16 +0200114
Radek Krejcif13b87b2020-12-01 22:02:17 +0100115/*
116 * Additional YANG constants
117 */
118#define Y_TAB_SPACES 8 /**< number of spaces instead of tab character */
119#define LY_TYPE_DEC64_FD_MAX 18 /**< Maximal value of decimal64's fraction-digits */
120
Radek Krejci70853c52018-10-15 14:46:16 +0200121/**
Radek Krejcie3846472018-10-15 15:24:51 +0200122 * @brief List of YANG statement groups - the (sub)module's substatements
123 */
124enum yang_module_stmt {
125 Y_MOD_MODULE_HEADER,
126 Y_MOD_LINKAGE,
127 Y_MOD_META,
128 Y_MOD_REVISION,
129 Y_MOD_BODY
130};
131
132/**
133 * @brief Types of arguments of YANG statements
134 */
135enum yang_arg {
136 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +0100137 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +0200138 Y_STR_ARG, /**< YANG "string" rule */
139 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
140};
141
Michal Vasko8a67eff2021-12-07 14:04:47 +0100142#define PARSER_CUR_PMOD(CTX) ((struct lysp_module *)(CTX)->parsed_mods->objs[(CTX)->parsed_mods->count - 1])
143#define PARSER_CTX(CTX) (PARSER_CUR_PMOD(CTX)->mod->ctx)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100144#define LOGVAL_PARSER(CTX, ...) LOGVAL((CTX) ? PARSER_CTX(CTX) : NULL, __VA_ARGS__)
Michal Vaskob36053d2020-03-26 15:49:30 +0100145
146struct lys_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200147 LYS_INFORMAT format; /**< parser format */
148 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
149 submodule, use ::lys_parser_ctx.main_ctx instead. */
150 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200151 submodule, use ::lys_parser_ctx.main_ctx instead. */
Michal Vasko8a67eff2021-12-07 14:04:47 +0100152 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
aPiecek8d4e75d2021-06-24 14:47:06 +0200153 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
154 then should be set to the context of the module to which it belongs,
155 otherwise it points to the beginning of this structure. */
Michal Vaskob36053d2020-03-26 15:49:30 +0100156};
157
Radek Krejcie3846472018-10-15 15:24:51 +0200158/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200159 * @brief Internal context for yang schema parser.
Radek Krejci70853c52018-10-15 14:46:16 +0200160 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100161struct lys_yang_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200162 LYS_INFORMAT format; /**< parser format */
163 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
164 submodule, use ::lys_parser_ctx.main_ctx instead. */
165 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200166 submodule, use ::lys_parser_ctx.main_ctx instead. */
Michal Vasko8a67eff2021-12-07 14:04:47 +0100167 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
aPiecek8d4e75d2021-06-24 14:47:06 +0200168 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
169 then should be set to the context of the module to which it belongs,
170 otherwise it points to the beginning of this structure. */
171 struct ly_in *in; /**< input handler for the parser */
172 uint64_t indent; /**< current position on the line for YANG indentation */
173 uint32_t depth; /**< current number of nested blocks, see ::LY_MAX_BLOCK_DEPTH */
Radek Krejci70853c52018-10-15 14:46:16 +0200174};
175
David Sedlákebd3acf2019-07-26 15:04:32 +0200176/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200177 * @brief Internal context for yin schema parser.
178 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100179struct lys_yin_parser_ctx {
aPiecek8d4e75d2021-06-24 14:47:06 +0200180 LYS_INFORMAT format; /**< parser format */
181 struct ly_set tpdfs_nodes; /**< Set of nodes that contain typedef(s). Invalid in case of
182 submodule, use ::lys_parser_ctx.main_ctx instead. */
183 struct ly_set grps_nodes; /**< Set of nodes that contain grouping(s). Invalid in case of
aPiecek63e080d2021-06-29 13:53:28 +0200184 submodule, use ::lys_parser_ctx.main_ctx instead. */
Michal Vasko8a67eff2021-12-07 14:04:47 +0100185 struct ly_set *parsed_mods; /**< (sub)modules being parsed, the last one is the current */
aPiecek8d4e75d2021-06-24 14:47:06 +0200186 struct lys_parser_ctx *main_ctx; /**< This pointer must not be NULL. If this context deals with the submodule,
187 then should be set to the context of the module to which it belongs,
188 otherwise it points to the beginning of this structure. */
189 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200190};
191
192/**
David Sedlák4a650532019-07-10 11:55:18 +0200193 * @brief Check that \p c is valid UTF8 code point for YANG string.
194 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100195 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200196 * @param[in] c UTF8 code point of a character to check.
197 * @return LY_ERR values.
198 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200199LY_ERR lysp_check_stringchar(struct lys_parser_ctx *ctx, uint32_t c);
David Sedlák4a650532019-07-10 11:55:18 +0200200
201/**
202 * @brief Check that \p c is valid UTF8 code point for YANG identifier.
203 *
Michal Vasko9ff8d2d2022-09-29 13:41:14 +0200204 * @param[in] ctx parser context for logging. If NULL, does not log.
David Sedlák4a650532019-07-10 11:55:18 +0200205 * @param[in] c UTF8 code point of a character to check.
206 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
207 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
208 * 0 - colon not yet found (no prefix)
209 * 1 - \p c is the colon character
210 * 2 - prefix already processed, now processing the identifier
211 *
212 * If the identifier cannot be prefixed, NULL is expected.
213 * @return LY_ERR values.
214 */
Radek Krejci857189e2020-09-01 13:26:36 +0200215LY_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 +0200216
217/**
Radek Krejci70853c52018-10-15 14:46:16 +0200218 * @brief Check the currently present prefixes in the module for collision with the new one.
219 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100220 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100221 * @param[in] imports List of current imports of the module to check prefix collision.
222 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200223 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
224 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
225 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200226LY_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 +0200227
Radek Krejci86d106e2018-10-18 09:53:19 +0200228/**
229 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
230 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100231 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200232 * @param[in] date Date string to check (non-necessarily terminated by \0)
233 * @param[in] date_len Length of the date string, 10 expected.
234 * @param[in] stmt Statement name for error message.
235 * @return LY_ERR value.
236 */
Juraj Vijtiuk74dad9e2021-05-26 12:42:14 +0200237LY_ERR lysp_check_date(struct lys_parser_ctx *ctx, const char *date, size_t date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100238
239/**
240 * @brief Check names of typedefs in the parsed module to detect collisions.
241 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100242 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
243 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100244 * @return LY_ERR value.
245 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100246LY_ERR lysp_check_dup_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
247
248/**
aPiecek63e080d2021-06-29 13:53:28 +0200249 * @brief Check names of groupings in the parsed module to detect collisions.
250 *
251 * @param[in] ctx Parser context for logging and to maintain grps_nodes.
252 * @param[in] mod Module where the type is being defined.
253 * @return LY_ERR value.
254 */
255LY_ERR lysp_check_dup_groupings(struct lys_parser_ctx *ctx, struct lysp_module *mod);
256
257/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100258 * @brief Check names of features in the parsed module and submodules to detect collisions.
259 *
260 * @param[in] ctx Parser context.
261 * @param[in] mod Module where the type is being defined.
262 * @return LY_ERR value.
263 */
264LY_ERR lysp_check_dup_features(struct lys_parser_ctx *ctx, struct lysp_module *mod);
265
266/**
267 * @brief Check names of identities in the parsed module and submodules to detect collisions.
268 *
269 * @param[in] ctx Parser context.
270 * @param[in] mod Module where the type is being defined.
271 * @return LY_ERR value.
272 */
273LY_ERR lysp_check_dup_identities(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200274
275/**
276 * @brief Just move the newest revision into the first position, does not sort the rest
277 * @param[in] revs Sized-array of the revisions in a printable schema tree.
278 */
279void lysp_sort_revisions(struct lysp_revision *revs);
280
281/**
David Sedlák6544c182019-07-12 13:17:33 +0200282 * @brief Find type specified type definition.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100283 *
284 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
285 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
286 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100287 * @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 +0100288 * @param[out] tpdf Found type definition.
289 * @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 +0100290 */
Michal Vaskoa99b3572021-02-01 11:54:58 +0100291LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, const struct lysp_module *start_module,
292 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100293
294/**
David Sedlák6544c182019-07-12 13:17:33 +0200295 * @brief Validate enum name.
296 *
297 * @param[in] ctx yang parser context for logging.
298 * @param[in] name String to check.
299 * @param[in] name_len Length of name.
300 *
301 * @return LY_ERR values
302 */
David Sedlák07869a52019-07-12 14:28:19 +0200303LY_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 +0200304
305/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200306 * @brief Find source data for a specific module, parse it, and add into the context.
Radek Krejci086c7132018-10-26 15:29:04 +0200307 *
308 * @param[in] ctx libyang context.
309 * @param[in] name Name of the module to load.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200310 * @param[in] revision Optional revision of the module to load. If NULL, the newest revision is loaded.
Michal Vaskodd992582021-06-10 14:34:57 +0200311 * @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 +0200312 * @param[out] mod Created module structure.
Michal Vasko4e205e82021-06-08 14:01:47 +0200313 * @return LY_SUCCESS on success.
314 * @return LY_ERR on error.
Radek Krejci086c7132018-10-26 15:29:04 +0200315 */
Michal Vaskodd992582021-06-10 14:34:57 +0200316LY_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 +0200317 struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200318
319/**
Radek Krejci771928a2021-01-19 13:42:36 +0100320 * @brief Parse included submodules into the simply parsed YANG module.
321 *
322 * YANG 1.0 does not require the main module to include all the submodules. Therefore, parsing submodules can cause
323 * reallocating and extending the includes array in the main module by the submodules included only in submodules.
Radek Krejcid33273d2018-10-25 14:55:52 +0200324 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200325 * @param[in] pctx main parser context
Radek Krejci771928a2021-01-19 13:42:36 +0100326 * @param[in] pmod Parsed module with the includes array to be processed.
aPiecekc3e26142021-06-22 14:25:49 +0200327 * @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 +0200328 * @return LY_ERR value.
329 */
aPiecekc3e26142021-06-22 14:25:49 +0200330LY_ERR lysp_load_submodules(struct lys_parser_ctx *pctx, struct lysp_module *pmod, struct ly_set *new_mods);
Radek Krejcid33273d2018-10-25 14:55:52 +0200331
332/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100333 * @brief Get address of a node's actions list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100334 * Decides the node's type and in case it has an actions list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100335 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100336 * @param[in] node Node to check.
337 * @return Address of the node's actions member if any, NULL otherwise.
338 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100339struct lysp_node_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100340
341/**
342 * @brief Get address of a node's notifications list if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100343 * Decides the node's type and in case it has a notifications list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100344 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100345 * @param[in] node Node to check.
346 * @return Address of the node's notifs member if any, NULL otherwise.
347 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100348struct lysp_node_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100349
350/**
351 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100352 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100353 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100354 * @param[in] node Node to check.
355 * @return Address of the node's child member if any, NULL otherwise.
356 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100357struct lysp_node **lysp_node_child_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100358
359/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100360 * @brief Get the address of the node's musts member, if any.
361 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100362 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100363 * @param[in] node Node to examine.
364 * @return The address of the node's musts member if any, NULL otherwise.
365 */
366struct lysp_restr **lysp_node_musts_p(const struct lysp_node *node);
367
368/**
369 * @brief Get the node's musts member, if any.
370 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100371 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100372 * @param[in] node Node to examine.
373 * @return The node's musts member if any, NULL otherwise.
374 */
375struct lysp_restr *lysp_node_musts(const struct lysp_node *node);
376
377/**
378 * @brief Get the address of the node's when member, if any.
379 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100380 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100381 * @param[in] node Node to examine.
382 * @return The address of the node's when member if any, NULL otherwise.
383 */
384struct lysp_when **lysp_node_when_p(const struct lysp_node *node);
385
386/**
387 * @brief Get the node's when member, if any.
388 * Decides the node's type and in case it has a when, returns it.
Michal Vasko544e58a2021-01-28 14:33:41 +0100389 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100390 * @param[in] node Node to examine.
391 * @return The node's when member if any, NULL otherwise.
392 */
393struct lysp_when *lysp_node_when(const struct lysp_node *node);
394
395/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100396 * @brief Get address of a node's child pointer if any.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100397 * Decides the node's type and in case it has a children list, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100398 *
399 * Do not use for RPC and action nodes.
400 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100401 * @param[in] node Node to check.
402 * @return Address of the node's child member if any, NULL otherwise.
403 */
Michal Vasko544e58a2021-01-28 14:33:41 +0100404struct lysc_node **lysc_node_child_p(const struct lysc_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100405
406/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200407 * @brief Get address of a node's notifs pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200408 * Decides the node's type and in case it has a notifs array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100409 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200410 * @param[in] node Node to check.
411 * @return Address of the node's notifs member if any, NULL otherwise.
412 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100413struct lysc_node_notif **lysc_node_notifs_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200414
415/**
416 * @brief Get address of a node's actions pointer if any.
Radek Krejcifc11bd72019-04-11 16:00:05 +0200417 * Decides the node's type and in case it has a actions array, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100418 *
Radek Krejcifc11bd72019-04-11 16:00:05 +0200419 * @param[in] node Node to check.
420 * @return Address of the node's actions member if any, NULL otherwise.
421 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100422struct lysc_node_action **lysc_node_actions_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200423
424/**
Radek Krejci9a3823e2021-01-27 20:26:46 +0100425 * @brief Get address of a node's when member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100426 * Decides the node's type and in case it has a when member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100427 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100428 * @param[in] node Node to check.
429 * @return Address of the node's when member if any, NULL otherwise.
430 */
431struct lysc_when ***lysc_node_when_p(const struct lysc_node *node);
432
433/**
434 * @brief Get address of a node's musts member if any.
Radek Krejci9a3823e2021-01-27 20:26:46 +0100435 * Decides the node's type and in case it has a musts member, returns its address.
Michal Vasko544e58a2021-01-28 14:33:41 +0100436 *
Radek Krejci9a3823e2021-01-27 20:26:46 +0100437 * @param[in] node Node to check.
438 * @return Address of the node's musts member if any, NULL otherwise.
439 */
440struct lysc_must **lysc_node_musts_p(const struct lysc_node *node);
441
442/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100443 * @brief Find parsed extension definition for the given extension instance.
444 *
445 * @param[in] ctx libyang context.
446 * @param[in] ext Extension instance for which the definition will be searched.
447 * @param[in, out] ext_mod Pointer to the module where the extension definition of the @p ext to correctly resolve prefixes.
448 * @param[out] ext_def Pointer to return found extension definition.
449 * @return LY_SUCCESS when the definition was found.
450 * @return LY_EVALID when the extension instance is invalid and/or the definition not found.
451 */
452LY_ERR lysp_ext_find_definition(const struct ly_ctx *ctx, const struct lysp_ext_instance *ext, const struct lys_module **ext_mod,
453 struct lysp_ext **ext_def);
454
455/**
Radek Krejciba05eab2021-03-10 13:19:29 +0100456 * @brief Get schema node in extension instance according to the given parameters.
457 *
458 * Wraps ::lys_getnext_ext() and match according to the given arguments.
459 *
460 * @param[in] ext Extension instance which top-level schema node is being searched.
461 * @param[in] module Optional parameter to match the extension instance's (and its data) module.
462 * @param[in] name Name of the schema node to find, if the string is not NULL-terminated, the @p name_len must be set.
463 * @param[in] name_len Length of the @p name string, use in case the @p name is not NULL-terminated string.
464 * @param[in] nodetype Allowed [type of the node](@ref schemanodetypes).
465 * @param[in] options ORed [lys_getnext options](@ref sgetnextflags).
466 * @return Found schema node if there is some satisfy the provided requirements.
467 */
468const struct lysc_node *lysc_ext_find_node(const struct lysc_ext_instance *ext, const struct lys_module *module,
469 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
470
471/**
Radek Krejci85ac8312021-03-03 20:21:33 +0100472 * @brief When the module comes from YIN format, the argument name is unknown because of missing extension definition
473 * (it might come from import modules which is not yet parsed at that time). Therefore, all the attributes are stored
474 * as substatements and resolving argument is postponed.
475 *
476 * There are 3 places which need the argument, so they resolve it when missing - YIN and YANG printers and extension instance
477 * compiler.
478 *
479 * @param[in] ctx libyang context
480 * @param[in] ext_p Parsed extension to be updated.
481 * @param[in] ext_def Extension definition, found with ::lysp_ext_find_definition().
482 * @return LY_ERR value.
483 */
484LY_ERR lysp_ext_instance_resolve_argument(struct ly_ctx *ctx, struct lysp_ext_instance *ext_p, struct lysp_ext *ext_def);
485
486/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200487 * @brief Iterate over the specified type of the extension instances
488 *
489 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
490 * @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 +0200491 * 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 +0100492 * @param[in] substmt The statement the extension is supposed to belong to.
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200493 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200494 */
Radek Krejcifc596f92021-02-26 22:40:26 +0100495LY_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 +0200496
497/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100498 * @brief Get the covering schema module structure for the given parsed module structure.
Michal Vasko544e58a2021-01-28 14:33:41 +0100499 *
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100500 * @param[in] ctx libyang context to search.
501 * @param[in] mod Parsed schema structure.
502 * @return Corresponding lys_module structure for the given parsed schema structure.
503 */
504struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
505
506/**
Radek Krejci693262f2019-04-29 15:23:20 +0200507 * @brief Stringify YANG built-in type.
Michal Vasko1bf09392020-03-27 12:38:10 +0100508 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200509 * @return Constant string with the name of the built-in type.
510 */
511const char *lys_datatype2str(LY_DATA_TYPE basetype);
512
Michal Vasko405cc9e2020-12-01 12:01:27 +0100513/**
Michal Vasko65333882021-06-10 14:12:16 +0200514 * @brief Implement a module and resolve all global unres.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100515 *
516 * @param[in] mod Module to implement.
Michal Vasko4e205e82021-06-08 14:01:47 +0200517 * @param[in] features Features to set, see ::lys_set_features().
Michal Vasko65333882021-06-10 14:12:16 +0200518 * @param[in] unres Global unres with all the created modules.
519 * @return LY_SUCCESS on success.
Michal Vasko4e205e82021-06-08 14:01:47 +0200520 * @return LY_ERR on error.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100521 */
Michal Vasko65333882021-06-10 14:12:16 +0200522LY_ERR _lys_set_implemented(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
Michal Vasko405cc9e2020-12-01 12:01:27 +0100523
Michal Vaskof4258e12021-06-15 12:11:42 +0200524/**
525 * @brief Create dependency sets for all modules in a context.
Michal Vasko50bc09a2021-06-17 17:31:56 +0200526 * Also sets to_compile flags for all the modules that should be (re)compiled.
Michal Vaskof4258e12021-06-15 12:11:42 +0200527 *
528 * @param[in] ctx Context to use.
529 * @param[in,out] main_set Set of dependency module sets.
530 * @param[in] mod Optional only module whose dependency set is needed, otherwise all sets are created.
531 * @return LY_ERR value.
532 */
Michal Vasko50bc09a2021-06-17 17:31:56 +0200533LY_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 +0200534
535/**
536 * @brief Revert changes stored in global compile context after a failed compilation.
537 *
538 * @param[in] ctx libyang context.
539 * @param[in] unres Global unres to use.
540 */
541void lys_unres_glob_revert(struct ly_ctx *ctx, struct lys_glob_unres *unres);
542
543/**
544 * @brief Erase the global compile context.
545 *
546 * @param[in] unres Global unres to erase.
547 */
548void lys_unres_glob_erase(struct lys_glob_unres *unres);
549
Michal Vasko3a41dff2020-07-15 14:30:28 +0200550typedef 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 +0200551 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100552
Radek Krejci693262f2019-04-29 15:23:20 +0200553/**
Michal Vasko4e205e82021-06-08 14:01:47 +0200554 * @brief Parse a module and add it into the context.
Radek Krejcid33273d2018-10-25 14:55:52 +0200555 *
556 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200557 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200558 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejci9ed7a192018-10-31 16:23:51 +0100559 * @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.
Michal Vaskodd992582021-06-10 14:34:57 +0200561 * @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 +0200562 * @param[out] module Created module.
Michal Vaskodd992582021-06-10 14:34:57 +0200563 * @return LY_SUCCESS on success.
564 * @return LY_ERR on error, @p new_mods may be modified.
Radek Krejcid33273d2018-10-25 14:55:52 +0200565 */
Michal Vasko4e205e82021-06-08 14:01:47 +0200566LY_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 +0200567 void *check_data, struct ly_set *new_mods, struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200568
569/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200570 * @brief Parse submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200571 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100572 * The latest_revision flag of submodule is updated.
573 *
574 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200575 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100576 * @param[in] format Format of the input data (YANG or YIN).
577 * @param[in] main_ctx Parser context of the main module.
578 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
579 * @param[in] check_data Caller's data to pass to the custom_check callback.
aPiecekc3e26142021-06-22 14:25:49 +0200580 * @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 +0200581 * @param[out] submodule Parsed submodule.
582 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100583 */
Michal Vasko87f1cf02021-06-08 14:02:47 +0200584LY_ERR lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, struct lys_parser_ctx *main_ctx,
aPiecekc3e26142021-06-22 14:25:49 +0200585 lys_custom_check custom_check, void *check_data, struct ly_set *new_mods, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100586
587/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200588 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100589 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200590 * @param[in] ctx Context with dictionary where the filepath value will be stored.
591 * @param[in] in Input handler to examine (filepath is not available for all the input types).
592 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200593 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200594void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200595
596/**
Radek Krejci693262f2019-04-29 15:23:20 +0200597 * @brief Get the @ref ifftokens from the given position in the 2bits array
598 * (libyang format of the if-feature expression).
599 * @param[in] list The 2bits array with the compiled if-feature expression.
600 * @param[in] pos Position (0-based) to specify from which position get the operator.
601 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200602uint8_t lysc_iff_getop(uint8_t *list, size_t pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100603
604/**
Radek Krejci84d7fd72021-07-14 18:32:21 +0200605 * @brief Parse generic statement structure into a specific parsed-schema structure.
606 *
607 * @param[in] ctx The compilation context of the @p stmt being processed
608 * @param[in] stmt Generic statement structure to process.
609 * @param[out] result Specific parsed-schema structure for the given statement. For the specific type for the particular statement, check the function code.
Radek Krejciad5963b2019-09-06 16:03:05 +0200610 * @param[in,out] exts [sized array](@ref sizedarrays) For extension instances in case of statements that do not store extension instances in their own list.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200611 * @return LY_ERR value.
Radek Krejciad5963b2019-09-06 16:03:05 +0200612 */
Radek Krejci76c8c4e2021-02-17 10:16:48 +0100613LY_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 +0200614
Radek Krejci86d106e2018-10-18 09:53:19 +0200615/**
David Sedlák18e494b2018-12-17 03:58:39 +0100616 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200617 *
Michal Vasko63f3d842020-07-08 10:10:14 +0200618 * @param[in,out] in Input structure, is updated.
Radek Krejcid54412f2020-12-17 20:25:35 +0100619 * @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 +0100620 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100621 */
Radek Krejcid54412f2020-12-17 20:25:35 +0100622enum ly_stmt lysp_match_kw(struct ly_in *in, uint64_t *indent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200623
Michal Vasko14654712020-02-06 08:35:21 +0100624/**
625 * @brief Generate path of the given node in the requested format.
626 *
627 * @param[in] node Schema path of this node will be generated.
628 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
629 * @param[in] pathtype Format of the path to generate.
630 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
631 * If NULL, memory for the complete path is allocated.
632 * @param[in] buflen Size of the provided @p buffer.
633 * @return NULL in case of memory allocation error, path of the node otherwise.
634 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
635 */
636char *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 +0200637 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100638
Michal Vasko62ed12d2020-05-21 10:08:25 +0200639/**
Radek Krejci239c38a2020-10-19 10:58:25 +0200640 * @brief Get format-specific prefix for a module.
641 *
Radek Krejci84d7fd72021-07-14 18:32:21 +0200642 * This function is available for type plugins via ::lyplg_type_get_prefix() API function.
Radek Krejci239c38a2020-10-19 10:58:25 +0200643 *
644 * @param[in] mod Module whose prefix to get.
645 * @param[in] format Format of the prefix.
Radek Krejci8df109d2021-04-23 12:19:08 +0200646 * @param[in] prefix_data Format-specific data based on @p format:
Radek Krejci224d4b42021-04-23 13:54:59 +0200647 * LY_VALUE_CANON - NULL
Radek Krejci84d7fd72021-07-14 18:32:21 +0200648 * LY_VALUE_SCHEMA - const struct ::lysp_module* (module used for resolving imports to prefixes)
649 * LY_VALUE_SCHEMA_RESOLVED - struct ::lysc_prefix* (sized array of pairs: prefix - module)
650 * LY_VALUE_XML - struct ::ly_set* (set of all returned modules as struct ::lys_module)
Radek Krejci8df109d2021-04-23 12:19:08 +0200651 * LY_VALUE_JSON - NULL
Radek Krejcif9943642021-04-26 10:18:21 +0200652 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200653 * @return Module prefix to print.
654 * @return NULL on error.
655 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200656const char *ly_get_prefix(const struct lys_module *mod, LY_VALUE_FORMAT format, void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200657
658/**
659 * @brief Resolve format-specific prefixes to modules.
660 *
Radek Krejci239c38a2020-10-19 10:58:25 +0200661 * @param[in] ctx libyang context.
662 * @param[in] prefix Prefix to resolve.
663 * @param[in] prefix_len Length of @p prefix.
664 * @param[in] format Format of the prefix.
Radek Krejcif9943642021-04-26 10:18:21 +0200665 * @param[in] prefix_data Format-specific data based on @p format:
666 * LY_VALUE_CANON - NULL
667 * LY_VALUE_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
668 * LY_VALUE_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
669 * LY_VALUE_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
670 * LY_VALUE_JSON - NULL
671 * LY_VALUE_LYB - NULL
Radek Krejci239c38a2020-10-19 10:58:25 +0200672 * @return Resolved prefix module,
673 * @return NULL otherwise.
674 */
Radek Krejcif9943642021-04-26 10:18:21 +0200675const 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 +0200676 LY_VALUE_FORMAT format, const void *prefix_data);
Radek Krejci239c38a2020-10-19 10:58:25 +0200677
Michal Vaskof4258e12021-06-15 12:11:42 +0200678/**
679 * @brief Learn whether @p PMOD needs to be recompiled if it is implemented.
680 *
681 * @param[in] PMOD Parsed module or submodule.
682 * @return Whether it has statements that are recompiled or not.
683 */
684#define LYSP_HAS_RECOMPILED(PMOD) \
685 (PMOD->data || PMOD->rpcs || PMOD->notifs || PMOD->exts)
686
687/**
688 * @brief Learn whether the module has statements that need to be recompiled or not.
689 *
690 * @param[in] mod Module to examine.
691 * @return Whether it has statements that are recompiled or not.
692 */
693ly_bool lys_has_recompiled(const struct lys_module *mod);
694
695/**
696 * @brief Learn whether @p PMOD needs to be compiled if it is implemented.
697 *
698 * @param[in] PMOD Parsed module or submodule.
699 * @return Whether it needs (has) a compiled module or not.
700 */
701#define LYSP_HAS_COMPILED(PMOD) \
aPiecek6b3d5422021-07-30 15:55:43 +0200702 (LYSP_HAS_RECOMPILED(PMOD) || PMOD->augments || PMOD->deviations)
Michal Vaskof4258e12021-06-15 12:11:42 +0200703
704/**
705 * @brief Learn whether the module has statements that need to be compiled or not.
706 *
707 * @param[in] mod Module to examine.
708 * @return Whether it needs compiled module or not.
709 */
710ly_bool lys_has_compiled(const struct lys_module *mod);
711
Michal Vasko7ee5be22021-06-16 17:03:34 +0200712/**
713 * @brief Learn whether the module has any grouping statements or not.
714 *
715 * @param[in] mod Module to examine.
716 * @return Whether it has groupings or not.
717 */
Michal Vasko87cfdba2022-02-22 14:13:45 +0100718ly_bool lys_has_dep_mods(const struct lys_module *mod);
Michal Vasko7ee5be22021-06-16 17:03:34 +0200719
Michal Vasko0bccbf12021-11-22 09:59:57 +0100720/**
721 * @brief Learn whether the module qualifies for a single dep set with only this module or not.
722 *
723 * @param[in] mod Module to examine.
724 * @return Whether it qualifies as a single dep set or not.
725 */
726#define LYS_IS_SINGLE_DEP_SET(mod) \
727 (!(mod)->parsed->features && (!lys_has_compiled(mod) || ((mod)->compiled && !lys_has_recompiled(mod))))
728
Radek Krejci70853c52018-10-15 14:46:16 +0200729#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */