blob: afeefacf7bc168c5b4b3472faac37360b5d5c6f5 [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/**
38 * @brief Check module version is at least 2 (YANG 1.1) because of the keyword presence.
39 * Logs error message and returns LY_EVALID in case of module in YANG version 1.0.
40 * @param[in] CTX yang parser context to get current module and for logging.
41 * @param[in] KW keyword allowed only in YANG version 1.1 (or later) - for logging.
42 * @param[in] PARENT parent statement where the KW is present - for logging.
43 */
44#define PARSER_CHECK_STMTVER2_RET(CTX, KW, PARENT) \
Michal Vasko5d24f6c2020-10-13 13:49:06 +020045 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 +020046
Radek Krejcia9026eb2018-12-12 16:04:47 +010047/* These 2 macros checks YANG's identifier grammar rule */
48#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
49#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
David Sedlákebd3acf2019-07-26 15:04:32 +020050 c == '_' || c == '-' || c == '.')
Radek Krejcia9026eb2018-12-12 16:04:47 +010051
David Sedlák4a650532019-07-10 11:55:18 +020052/* Macro to check YANG's yang-char grammar rule */
David Sedlák2c0d5ef2019-08-14 11:40:44 +020053#define is_yangutf8char(c) ((c >= 0x20 && c <= 0xd7ff) || c == 0x09 || c == 0x0a || c == 0x0d || \
David Sedlák4a650532019-07-10 11:55:18 +020054 (c >= 0xe000 && c <= 0xfdcf) || (c >= 0xfdf0 && c <= 0xfffd) || \
55 (c >= 0x10000 && c <= 0x1fffd) || (c >= 0x20000 && c <= 0x2fffd) || \
56 (c >= 0x30000 && c <= 0x3fffd) || (c >= 0x40000 && c <= 0x2fffd) || \
57 (c >= 0x50000 && c <= 0x5fffd) || (c >= 0x60000 && c <= 0x6fffd) || \
58 (c >= 0x70000 && c <= 0x7fffd) || (c >= 0x80000 && c <= 0x8fffd) || \
59 (c >= 0x90000 && c <= 0x9fffd) || (c >= 0xa0000 && c <= 0xafffd) || \
60 (c >= 0xb0000 && c <= 0xbfffd) || (c >= 0xc0000 && c <= 0xcfffd) || \
61 (c >= 0xd0000 && c <= 0xdfffd) || (c >= 0xe0000 && c <= 0xefffd) || \
62 (c >= 0xf0000 && c <= 0xffffd) || (c >= 0x100000 && c <= 0x10fffd))
63
Radek Krejci70853c52018-10-15 14:46:16 +020064/**
David Sedlákca36c422019-07-12 12:47:55 +020065 * @brief Try to find object with MEMBER string matching the IDENT in the given ARRAY.
66 * Macro logs an error message and returns LY_EVALID in case of existence of a matching object.
67 *
68 * @param[in] CTX yang parser context for logging.
69 * @param[in] ARRAY [sized array](@ref sizedarrays) of a generic objects with member named MEMBER to search.
70 * @param[in] MEMBER Name of the member of the objects in the ARRAY to compare.
71 * @param[in] STMT Name of the compared YANG statements for logging.
72 * @param[in] IDENT String trying to find in the ARRAY's objects inside the MEMBER member.
73 */
74#define CHECK_UNIQUENESS(CTX, ARRAY, MEMBER, STMT, IDENT) \
75 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +020076 for (LY_ARRAY_COUNT_TYPE u_ = 0; u_ < LY_ARRAY_COUNT(ARRAY) - 1; ++u_) { \
Radek Krejci7eb54ba2020-05-18 16:30:04 +020077 if (!strcmp((ARRAY)[u_].MEMBER, IDENT)) { \
David Sedlákca36c422019-07-12 12:47:55 +020078 LOGVAL_PARSER(CTX, LY_VCODE_DUPIDENT, IDENT, STMT); \
79 return LY_EVALID; \
80 } \
81 } \
82 }
83
Michal Vaskob36053d2020-03-26 15:49:30 +010084#define CHECK_NONEMPTY(CTX, VALUE_LEN, STMT) \
David Sedlák129a09c2019-07-12 14:08:34 +020085 if (!VALUE_LEN) { \
Michal Vaskob36053d2020-03-26 15:49:30 +010086 LOGWRN(PARSER_CTX(CTX), "Empty argument of %s statement does not make sense.", STMT); \
David Sedlák129a09c2019-07-12 14:08:34 +020087 }
Radek Krejci70853c52018-10-15 14:46:16 +020088
Radek Krejcif13b87b2020-12-01 22:02:17 +010089/*
90 * Additional YANG constants
91 */
92#define Y_TAB_SPACES 8 /**< number of spaces instead of tab character */
93#define LY_TYPE_DEC64_FD_MAX 18 /**< Maximal value of decimal64's fraction-digits */
94
Radek Krejci70853c52018-10-15 14:46:16 +020095/**
Radek Krejcie3846472018-10-15 15:24:51 +020096 * @brief List of YANG statement groups - the (sub)module's substatements
97 */
98enum yang_module_stmt {
99 Y_MOD_MODULE_HEADER,
100 Y_MOD_LINKAGE,
101 Y_MOD_META,
102 Y_MOD_REVISION,
103 Y_MOD_BODY
104};
105
106/**
107 * @brief Types of arguments of YANG statements
108 */
109enum yang_arg {
110 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +0100111 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +0200112 Y_STR_ARG, /**< YANG "string" rule */
113 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
114};
115
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200116#define PARSER_CTX(CTX) ((CTX)->parsed_mod->mod->ctx)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100117#define LOGVAL_PARSER(CTX, ...) LOGVAL((CTX) ? PARSER_CTX(CTX) : NULL, __VA_ARGS__)
Michal Vaskob36053d2020-03-26 15:49:30 +0100118
119struct lys_parser_ctx {
Michal Vasko7c8439f2020-08-05 13:25:19 +0200120 LYS_INFORMAT format; /**< parser format */
121 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
122 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200123 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100124 struct lys_glob_unres *unres; /**< global unres structure */
Michal Vaskob36053d2020-03-26 15:49:30 +0100125};
126
Radek Krejcie3846472018-10-15 15:24:51 +0200127/**
David Sedlákebd3acf2019-07-26 15:04:32 +0200128 * @brief Internal context for yang schema parser.
Radek Krejci70853c52018-10-15 14:46:16 +0200129 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100130struct lys_yang_parser_ctx {
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200131 LYS_INFORMAT format; /**< parser format */
132 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
133 struct ly_set grps_nodes; /**< set of grouping nodes */
134 struct lysp_module *parsed_mod; /**< (sub)module being parsed */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100135 struct lys_glob_unres *unres; /**< global unres structure */
Radek Krejci33090f92020-12-17 20:12:46 +0100136 struct ly_in *in; /**< input handler for the parser */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200137 uint64_t indent; /**< current position on the line for YANG indentation */
Radek Krejci70853c52018-10-15 14:46:16 +0200138};
139
David Sedlákebd3acf2019-07-26 15:04:32 +0200140/**
141 * @brief free lys parser context.
142 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100143void yang_parser_ctx_free(struct lys_yang_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200144
145/**
146 * @brief Internal context for yin schema parser.
147 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100148struct lys_yin_parser_ctx {
149 LYS_INFORMAT format; /**< parser format */
David Sedlákebd3acf2019-07-26 15:04:32 +0200150 struct ly_set tpdfs_nodes; /**< set of typedef nodes */
151 struct ly_set grps_nodes; /**< set of grouping nodes */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200152 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 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100154 struct lyxml_ctx *xmlctx; /**< context for xml parser */
David Sedlákebd3acf2019-07-26 15:04:32 +0200155};
156
157/**
158 * @brief free yin parser context
159 *
160 * @param[in] ctx Context to free.
161 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100162void yin_parser_ctx_free(struct lys_yin_parser_ctx *ctx);
David Sedlákebd3acf2019-07-26 15:04:32 +0200163
Michal Vasko7f45cf22020-10-01 12:49:44 +0200164/**
David Sedlák4a650532019-07-10 11:55:18 +0200165 * @brief Check that \p c is valid UTF8 code point for YANG string.
166 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100167 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200168 * @param[in] c UTF8 code point of a character to check.
169 * @return LY_ERR values.
170 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200171LY_ERR lysp_check_stringchar(struct lys_parser_ctx *ctx, uint32_t c);
David Sedlák4a650532019-07-10 11:55:18 +0200172
173/**
174 * @brief Check that \p c is valid UTF8 code point for YANG identifier.
175 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100176 * @param[in] ctx parser context for logging.
David Sedlák4a650532019-07-10 11:55:18 +0200177 * @param[in] c UTF8 code point of a character to check.
178 * @param[in] first Flag to check the first character of an identifier, which is more restricted.
179 * @param[in,out] prefix Storage for internally used flag in case of possible prefixed identifiers:
180 * 0 - colon not yet found (no prefix)
181 * 1 - \p c is the colon character
182 * 2 - prefix already processed, now processing the identifier
183 *
184 * If the identifier cannot be prefixed, NULL is expected.
185 * @return LY_ERR values.
186 */
Radek Krejci857189e2020-09-01 13:26:36 +0200187LY_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 +0200188
189/**
Radek Krejci70853c52018-10-15 14:46:16 +0200190 * @brief Check the currently present prefixes in the module for collision with the new one.
191 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100192 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100193 * @param[in] imports List of current imports of the module to check prefix collision.
194 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +0200195 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
196 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
197 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200198LY_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 +0200199
Radek Krejci86d106e2018-10-18 09:53:19 +0200200/**
201 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
202 *
Radek Krejcibbe09a92018-11-08 09:36:54 +0100203 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +0200204 * @param[in] date Date string to check (non-necessarily terminated by \0)
205 * @param[in] date_len Length of the date string, 10 expected.
206 * @param[in] stmt Statement name for error message.
207 * @return LY_ERR value.
208 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200209LY_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 +0100210
211/**
212 * @brief Check names of typedefs in the parsed module to detect collisions.
213 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100214 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
215 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100216 * @return LY_ERR value.
217 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100218LY_ERR lysp_check_dup_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
219
220/**
221 * @brief Check names of features in the parsed module and submodules to detect collisions.
222 *
223 * @param[in] ctx Parser context.
224 * @param[in] mod Module where the type is being defined.
225 * @return LY_ERR value.
226 */
227LY_ERR lysp_check_dup_features(struct lys_parser_ctx *ctx, struct lysp_module *mod);
228
229/**
230 * @brief Check names of identities in the parsed module and submodules to detect collisions.
231 *
232 * @param[in] ctx Parser context.
233 * @param[in] mod Module where the type is being defined.
234 * @return LY_ERR value.
235 */
236LY_ERR lysp_check_dup_identities(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200237
238/**
239 * @brief Just move the newest revision into the first position, does not sort the rest
240 * @param[in] revs Sized-array of the revisions in a printable schema tree.
241 */
242void lysp_sort_revisions(struct lysp_revision *revs);
243
244/**
David Sedlák6544c182019-07-12 13:17:33 +0200245 * @brief Find type specified type definition.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100246 *
247 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
248 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
249 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100250 * @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 +0100251 * @param[out] tpdf Found type definition.
252 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
253 * @param[out] module Module where the found typedef is being defined, NULL in case of built-in YANG types.
254 */
255LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, struct lysp_module *start_module,
Radek Krejci0f969882020-08-21 16:56:47 +0200256 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node, struct lysp_module **module);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100257
258/**
David Sedlák6544c182019-07-12 13:17:33 +0200259 * @brief Validate enum name.
260 *
261 * @param[in] ctx yang parser context for logging.
262 * @param[in] name String to check.
263 * @param[in] name_len Length of name.
264 *
265 * @return LY_ERR values
266 */
David Sedlák07869a52019-07-12 14:28:19 +0200267LY_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 +0200268
269/**
Radek Krejci086c7132018-10-26 15:29:04 +0200270 * @brief Find and parse module of the given name.
271 *
272 * @param[in] ctx libyang context.
273 * @param[in] name Name of the module to load.
274 * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
Michal Vasko34e334d2021-01-25 16:12:31 +0100275 * @param[in] need_implemented Whether the module should be implemented. If revision is NULL and this flag is set,
276 * the implemented module in the context is returned despite it might not be of the latest revision, because in this
277 * case the module of the latest revision can not be made implemented.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100278 * @param[in] features All the features to enable if implementing the module.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100279 * @param[in] unres Global unres structure for all newly implemented modules.
Radek Krejci086c7132018-10-26 15:29:04 +0200280 * @param[out] mod Parsed module structure.
281 * @return LY_ERR value.
282 */
Michal Vasko34e334d2021-01-25 16:12:31 +0100283LY_ERR lysp_load_module(struct ly_ctx *ctx, const char *name, const char *revision, ly_bool need_implemented,
Michal Vasko405cc9e2020-12-01 12:01:27 +0100284 const char **features, struct lys_glob_unres *unres, struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200285
286/**
Radek Krejci771928a2021-01-19 13:42:36 +0100287 * @brief Parse included submodules into the simply parsed YANG module.
288 *
289 * YANG 1.0 does not require the main module to include all the submodules. Therefore, parsing submodules can cause
290 * reallocating and extending the includes array in the main module by the submodules included only in submodules.
Radek Krejcid33273d2018-10-25 14:55:52 +0200291 *
Michal Vasko7c8439f2020-08-05 13:25:19 +0200292 * @param[in] pctx main parser context
Radek Krejci771928a2021-01-19 13:42:36 +0100293 * @param[in] pmod Parsed module with the includes array to be processed.
Radek Krejcid33273d2018-10-25 14:55:52 +0200294 * @return LY_ERR value.
295 */
Radek Krejci771928a2021-01-19 13:42:36 +0100296LY_ERR lysp_load_submodules(struct lys_parser_ctx *pctx, struct lysp_module *pmod);
Radek Krejcid33273d2018-10-25 14:55:52 +0200297
298/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200299 * @brief Free a parsed restriction.
300 *
301 * @param[in] ctx libyang context.
302 * @param[in] restr Restriction to free.
303 */
304void lysp_restr_free(struct ly_ctx *ctx, struct lysp_restr *restr);
305
306/**
307 * @brief Free a parsed qualified name.
308 *
309 * @param[in] ctx libyang context.
310 * @param[in] qname Qualified name to free.
311 */
312void lysp_qname_free(struct ly_ctx *ctx, struct lysp_qname *qname);
313
314/**
315 * @brief Free a parsed node.
316 *
317 * @param[in] ctx libyang context.
318 * @param[in] node Node to free.
319 */
320void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
321
322/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100323 * @brief Get address of a node's actions list if any.
324 *
325 * Decides the node's type and in case it has an actions list, returns its address.
326 * @param[in] node Node to check.
327 * @return Address of the node's actions member if any, NULL otherwise.
328 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100329struct lysp_node_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100330
331/**
332 * @brief Get address of a node's notifications list if any.
333 *
334 * Decides the node's type and in case it has a notifications list, returns its address.
335 * @param[in] node Node to check.
336 * @return Address of the node's notifs member if any, NULL otherwise.
337 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100338struct lysp_node_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100339
340/**
341 * @brief Get address of a node's child pointer if any.
342 *
343 * Decides the node's type and in case it has a children list, returns its address.
344 * @param[in] node Node to check.
345 * @return Address of the node's child member if any, NULL otherwise.
346 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100347struct lysp_node **lysp_node_children_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100348
349/**
350 * @brief Get address of a node's child pointer if any.
351 *
352 * Decides the node's type and in case it has a children list, returns its address.
353 * @param[in] node Node to check.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100354 * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) data in case of RPC/action node.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100355 * @return Address of the node's child member if any, NULL otherwise.
356 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100357struct lysc_node **lysc_node_children_p(const struct lysc_node *node, uint16_t flags);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100358
359/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200360 * @brief Get address of a node's notifs pointer if any.
361 *
362 * Decides the node's type and in case it has a notifs array, returns its address.
363 * @param[in] node Node to check.
364 * @return Address of the node's notifs member if any, NULL otherwise.
365 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100366struct lysc_node_notif **lysc_node_notifs_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200367
368/**
369 * @brief Get address of a node's actions pointer if any.
370 *
371 * Decides the node's type and in case it has a actions array, returns its address.
372 * @param[in] node Node to check.
373 * @return Address of the node's actions member if any, NULL otherwise.
374 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100375struct lysc_node_action **lysc_node_actions_p(struct lysc_node *node);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200376
377/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200378 * @brief Iterate over the specified type of the extension instances
379 *
380 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
381 * @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 +0200382 * the returned index increased by 1 (until the iteration is not terminated by returning LY_ARRAY_COUNT(ext).
Radek Krejcid3ca0632019-04-16 16:54:54 +0200383 * @param[in] substmt Type of the extension (its belongins to the specific substatement) to iterate, use
384 * #LYEXT_SUBSTMT_ALL to go through all the extensions in the array
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200385 * @result index in the ext array, LY_ARRAY_COUNT(ext) value if not present.
Radek Krejcid3ca0632019-04-16 16:54:54 +0200386 */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200387LY_ARRAY_COUNT_TYPE lysp_ext_instance_iter(struct lysp_ext_instance *ext, LY_ARRAY_COUNT_TYPE index, LYEXT_SUBSTMT substmt);
Radek Krejcid3ca0632019-04-16 16:54:54 +0200388
389/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100390 * @brief Get the covering schema module structure for the given parsed module structure.
391 * @param[in] ctx libyang context to search.
392 * @param[in] mod Parsed schema structure.
393 * @return Corresponding lys_module structure for the given parsed schema structure.
394 */
395struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
396
397/**
Radek Krejci693262f2019-04-29 15:23:20 +0200398 * @brief Stringify YANG built-in type.
Michal Vasko1bf09392020-03-27 12:38:10 +0100399 * @param[in] basetype Built-in type ID to stringify.
Radek Krejci693262f2019-04-29 15:23:20 +0200400 * @return Constant string with the name of the built-in type.
401 */
402const char *lys_datatype2str(LY_DATA_TYPE basetype);
403
Michal Vasko405cc9e2020-12-01 12:01:27 +0100404/**
405 * @brief Implement a module (just like ::lys_set_implemented()), can be called recursively.
406 *
407 * @param[in] mod Module to implement.
408 * @param[in] features Array of features to enable.
409 * @param[in,out] unres Global unres to add to.
410 * @return LY_ERR value.
411 */
412LY_ERR lys_set_implemented_r(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
413
Michal Vasko3a41dff2020-07-15 14:30:28 +0200414typedef 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 +0200415 void *check_data);
Michal Vaskob36053d2020-03-26 15:49:30 +0100416
Radek Krejci693262f2019-04-29 15:23:20 +0200417/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200418 * @brief Create a new module.
Radek Krejcid33273d2018-10-25 14:55:52 +0200419 *
Michal Vasko7a0b0762020-09-02 16:37:01 +0200420 * It is parsed, opionally compiled, added into the context, and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200421 *
422 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200423 * @param[in] in Input structure.
Radek Krejcid33273d2018-10-25 14:55:52 +0200424 * @param[in] format Format of the input data (YANG or YIN).
Michal Vasko34e334d2021-01-25 16:12:31 +0100425 * @param[in] need_implemented Whether module needs to be implemented and compiled.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100426 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
427 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100428 * @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 +0100429 * @param[in,out] unres Global unres structure for newly implemented modules.
Michal Vasko7a0b0762020-09-02 16:37:01 +0200430 * @param[out] module Created module.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200431 * @return LY_ERR value.
Radek Krejcid33273d2018-10-25 14:55:52 +0200432 */
Michal Vasko34e334d2021-01-25 16:12:31 +0100433LY_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 +0100434 lys_custom_check custom_check, void *check_data, const char **features, struct lys_glob_unres *unres,
435 struct lys_module **module);
Radek Krejcid33273d2018-10-25 14:55:52 +0200436
437/**
Michal Vasko7a0b0762020-09-02 16:37:01 +0200438 * @brief Parse submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200439 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100440 * The latest_revision flag of submodule is updated.
441 *
442 * @param[in] ctx libyang context where to process the data model.
Michal Vasko63f3d842020-07-08 10:10:14 +0200443 * @param[in] in Input structure.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100444 * @param[in] format Format of the input data (YANG or YIN).
445 * @param[in] main_ctx Parser context of the main module.
446 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
447 * @param[in] check_data Caller's data to pass to the custom_check callback.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200448 * @param[out] submodule Parsed submodule.
449 * @return LY_ERR value.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100450 */
Michal Vasko7a0b0762020-09-02 16:37:01 +0200451LY_ERR lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format,
Radek Krejci0f969882020-08-21 16:56:47 +0200452 struct lys_parser_ctx *main_ctx, lys_custom_check custom_check,
453 void *check_data, struct lysp_submodule **submodule);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100454
455/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200456 * @brief Fill filepath value if available in input handler @p in
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100457 *
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200458 * @param[in] ctx Context with dictionary where the filepath value will be stored.
459 * @param[in] in Input handler to examine (filepath is not available for all the input types).
460 * @param[out] filepath Address of the variable where the filepath is stored.
Radek Krejcid33273d2018-10-25 14:55:52 +0200461 */
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200462void lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath);
Radek Krejcid33273d2018-10-25 14:55:52 +0200463
464/**
465 * @brief Load the (sub)module into the context.
466 *
467 * This function does not check the presence of the (sub)module in context, it should be done before calling this function.
468 *
469 * module_name and submodule_name are alternatives - only one of the
470 *
471 * @param[in] ctx libyang context where to work.
472 * @param[in] name Name of the (sub)module to load.
473 * @param[in] revision Optional revision of the (sub)module to load, if NULL the newest revision is being loaded.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100474 * @param[in] features Array of enabled features ended with NULL.
Michal Vasko34e334d2021-01-25 16:12:31 +0100475 * @param[in] need_implemented Whether the (sub)module is needed implemented or not.
Radek Krejci3b1f9292018-11-08 10:58:35 +0100476 * @param[in] main_ctx Parser context of the main module in case of loading submodule.
fredgancd485b82019-10-18 15:00:17 +0800477 * @param[in] main_name Main module name in case of loading submodule.
Radek Krejci78f06822019-10-30 12:54:05 +0100478 * @param[in] required Module is required so error (even if the input file not found) are important. If 0, there is some
479 * backup and it is actually ok if the input data are not found. However, parser reports errors even in this case.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100480 * @param[in,out] unres Global unres structure for newly implemented modules.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100481 * @param[out] result Parsed YANG schema tree of the requested module (struct lys_module*) or submodule (struct lysp_submodule*).
482 * If it is a module, it is already in the context!
Radek Krejcid33273d2018-10-25 14:55:52 +0200483 * @return LY_ERR value, in case of LY_SUCCESS, the \arg result is always provided.
484 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100485LY_ERR lys_module_localfile(struct ly_ctx *ctx, const char *name, const char *revision, const char **features,
Michal Vasko34e334d2021-01-25 16:12:31 +0100486 ly_bool need_implemented, struct lys_parser_ctx *main_ctx, const char *main_name, ly_bool required,
Michal Vasko405cc9e2020-12-01 12:01:27 +0100487 struct lys_glob_unres *unres, void **result);
Radek Krejci086c7132018-10-26 15:29:04 +0200488
489/**
Radek Krejci693262f2019-04-29 15:23:20 +0200490 * @brief Get the @ref ifftokens from the given position in the 2bits array
491 * (libyang format of the if-feature expression).
492 * @param[in] list The 2bits array with the compiled if-feature expression.
493 * @param[in] pos Position (0-based) to specify from which position get the operator.
494 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200495uint8_t lysc_iff_getop(uint8_t *list, size_t pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100496
497/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200498 * @brief Macro to free [sized array](@ref sizedarrays) of items using the provided free function. The ARRAY itself is also freed,
499 * but the memory is not sanitized.
500 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100501#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 +0200502
503/**
504 * @brief Macro to free the specified MEMBER of a structure using the provided free function. The memory is not sanitized.
505 */
Radek Krejci0a03a342021-01-19 13:39:28 +0100506#define FREE_MEMBER(CTX, MEMBER, FUNC) if (MEMBER) {(FUNC)(CTX, MEMBER);free(MEMBER);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200507
508/**
509 * @brief Macro to free [sized array](@ref sizedarrays) of strings stored in the context's dictionary. The ARRAY itself is also freed,
510 * but the memory is not sanitized.
511 */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200512#define FREE_STRINGS(CTX, ARRAY) {LY_ARRAY_COUNT_TYPE c__; LY_ARRAY_FOR(ARRAY, c__){FREE_STRING(CTX, ARRAY[c__]);}LY_ARRAY_FREE(ARRAY);}
Radek Krejcifc11bd72019-04-11 16:00:05 +0200513
514/**
Radek Krejci15f10ab2020-11-03 14:14:14 +0100515 * @brief Free the printable YANG schema tree structure. Works for both modules and submodules.
516 *
517 * @param[in] module Printable YANG schema tree structure to free.
518 */
519void lysp_module_free(struct lysp_module *module);
520
521/**
Radek Krejci38d85362019-09-05 16:26:38 +0200522 * @brief Free the parsed type structure.
523 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko8d544252020-03-02 10:19:52 +0100524 * @param[in] type Parsed schema type structure to free. Note that the type itself is not freed.
Radek Krejci38d85362019-09-05 16:26:38 +0200525 */
526void lysp_type_free(struct ly_ctx *ctx, struct lysp_type *type);
Radek Krejci335332a2019-09-05 13:03:35 +0200527
Radek Krejciad5963b2019-09-06 16:03:05 +0200528/**
Michal Vasko8d544252020-03-02 10:19:52 +0100529 * @brief Free the parsed extension instance structure.
530 * @param[in] ctx libyang context where the string data resides in a dictionary.
531 * @param[in] type Parsed extension instance structure to free. Note that the instance itself is not freed.
532 */
533void lysp_ext_instance_free(struct ly_ctx *ctx, struct lysp_ext_instance *ext);
534
535/**
Radek Krejciad5963b2019-09-06 16:03:05 +0200536 * @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.
537 */
538LY_ERR lysp_stmt_parse(struct lysc_ctx *ctx, const struct lysp_stmt *stmt, enum ly_stmt kw, void **result, struct lysp_ext_instance **exts);
Radek Krejci335332a2019-09-05 13:03:35 +0200539
Radek Krejcid33273d2018-10-25 14:55:52 +0200540/**
Michal Vasko20424b42020-08-31 12:29:38 +0200541 * @brief Free a parsed node.
542 *
543 * @param[in] ctx libyang context.
544 * @param[in] node Node to free.
545 */
546void lysp_node_free(struct ly_ctx *ctx, struct lysp_node *node);
547
548/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100549 * @brief Free the compiled type structure.
550 * @param[in] ctx libyang context where the string data resides in a dictionary.
551 * @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.
552 */
553void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
554
555/**
Radek Krejci0af46292019-01-11 16:02:31 +0100556 * @brief Free the compiled if-feature structure.
557 * @param[in] ctx libyang context where the string data resides in a dictionary.
558 * @param[in,out] iff Compiled if-feature structure to be cleaned.
559 * Since the structure is typically part of the sized array, the structure itself is not freed.
560 */
561void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
562
563/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100564 * @brief Free the compiled identity structure.
565 * @param[in] ctx libyang context where the string data resides in a dictionary.
566 * @param[in,out] ident Compiled identity structure to be cleaned.
567 * Since the structure is typically part of the sized array, the structure itself is not freed.
568 */
569void lysc_ident_free(struct ly_ctx *ctx, struct lysc_ident *ident);
570
571/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100572 * @brief Free the compiled must structure.
573 * @param[in] ctx libyang context where the string data resides in a dictionary.
574 * @param[in,out] must Compiled must structure to be cleaned.
575 * Since the structure is typically part of the sized array, the structure itself is not freed.
576 */
577void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
578
579/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100580 * @brief Free the data inside compiled input/output structure.
581 * @param[in] ctx libyang context where the string data resides in a dictionary.
582 * @param[in,out] inout Compiled inout structure to be cleaned.
583 * Since the structure is part of the RPC/action structure, it is not freed itself.
584 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100585void lysc_node_action_inout_free(struct ly_ctx *ctx, struct lysc_node_action_inout *inout);
Radek Krejcif538ce52019-03-05 10:46:14 +0100586
587/**
588 * @brief Free the data inside compiled RPC/action structure.
589 * @param[in] ctx libyang context where the string data resides in a dictionary.
590 * @param[in,out] action Compiled action structure to be cleaned.
591 * Since the structure is typically part of the sized array, the structure itself is not freed.
592 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100593void lysc_node_action_free(struct ly_ctx *ctx, struct lysc_node_action *action);
Radek Krejcif538ce52019-03-05 10:46:14 +0100594
595/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200596 * @brief Free the items inside the compiled Notification structure.
597 * @param[in] ctx libyang context where the string data resides in a dictionary.
598 * @param[in,out] action Compiled Notification structure to be cleaned.
599 * Since the structure is typically part of the sized array, the structure itself is not freed.
600 */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100601void lysc_node_notif_free(struct ly_ctx *ctx, struct lysc_node_notif *notif);
Radek Krejcifc11bd72019-04-11 16:00:05 +0200602
603/**
Radek Krejci0af46292019-01-11 16:02:31 +0100604 * @brief Free the compiled extension instance structure.
605 * @param[in] ctx libyang context where the string data resides in a dictionary.
606 * @param[in,out] ext Compiled extension instance structure to be cleaned.
607 * Since the structure is typically part of the sized array, the structure itself is not freed.
608 */
609void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
610
611/**
Radek Krejci19a96102018-11-15 13:38:09 +0100612 * @brief Free the compiled node structure.
613 * @param[in] ctx libyang context where the string data resides in a dictionary.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100614 * @param[in] node Compiled node structure to be freed.
615 * @param[in] unlink Whether to first unlink the node before freeing.
Radek Krejci19a96102018-11-15 13:38:09 +0100616 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100617void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node, ly_bool unlink);
Radek Krejci19a96102018-11-15 13:38:09 +0100618
619/**
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200620 * @brief Free the compiled container node structure.
621 *
622 * Only the container-specific members are freed, for generic node free function,
Radek Krejci8678fa42020-08-18 16:07:28 +0200623 * use ::lysc_node_free().
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200624 *
625 * @param[in] ctx libyang context where the string data resides in a dictionary.
626 * @param[in,out] node Compiled container node structure to be freed.
627 */
628void lysc_node_container_free(struct ly_ctx *ctx, struct lysc_node_container *node);
629
630/**
Radek Krejci19a96102018-11-15 13:38:09 +0100631 * @brief Free the compiled schema structure.
632 * @param[in,out] module Compiled schema module structure to free.
633 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
634 */
635void lysc_module_free(struct lysc_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
636
637/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200638 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
639 * @param[in,out] module Schema module structure to free.
640 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
641 */
642void lys_module_free(struct lys_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
643
644/**
David Sedlák18e494b2018-12-17 03:58:39 +0100645 * @brief match yang keyword
David Sedlák1bccdfa2019-06-17 15:55:27 +0200646 *
Michal Vasko63f3d842020-07-08 10:10:14 +0200647 * @param[in,out] in Input structure, is updated.
Radek Krejcid54412f2020-12-17 20:25:35 +0100648 * @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 +0100649 * @return yang_keyword values.
David Sedlák18e494b2018-12-17 03:58:39 +0100650 */
Radek Krejcid54412f2020-12-17 20:25:35 +0100651enum ly_stmt lysp_match_kw(struct ly_in *in, uint64_t *indent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200652
Michal Vasko14654712020-02-06 08:35:21 +0100653/**
654 * @brief Generate path of the given node in the requested format.
655 *
656 * @param[in] node Schema path of this node will be generated.
657 * @param[in] parent Build relative path only until this parent is found. If NULL, the full absolute path is printed.
658 * @param[in] pathtype Format of the path to generate.
659 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
660 * If NULL, memory for the complete path is allocated.
661 * @param[in] buflen Size of the provided @p buffer.
662 * @return NULL in case of memory allocation error, path of the node otherwise.
663 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
664 */
665char *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 +0200666 size_t buflen);
Michal Vasko14654712020-02-06 08:35:21 +0100667
Michal Vasko62ed12d2020-05-21 10:08:25 +0200668/**
Michal Vasko72244882021-01-12 15:21:05 +0100669 * @brief Get nearest @p schema parent (including the node itself) that can be instantiated in data.
Michal Vasko62ed12d2020-05-21 10:08:25 +0200670 *
Michal Vasko72244882021-01-12 15:21:05 +0100671 * @param[in] schema Schema node to get the nearest data node for.
672 * @return Schema data node, NULL if top-level (in data).
Michal Vasko62ed12d2020-05-21 10:08:25 +0200673 */
Michal Vasko72244882021-01-12 15:21:05 +0100674const struct lysc_node *lysc_data_node(const struct lysc_node *schema);
675
676/**
677 * @brief Same as ::lysc_data_node() but never returns the node itself.
678 */
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100679#define lysc_data_parent(SCHEMA) lysc_data_node((SCHEMA)->parent)
Michal Vasko62ed12d2020-05-21 10:08:25 +0200680
Michal Vasko00cbf532020-06-15 13:58:47 +0200681/**
Radek Krejci1deb5be2020-08-26 16:43:36 +0200682 * @brief Learn whether a node is inside an operation output.
Michal Vasko00cbf532020-06-15 13:58:47 +0200683 *
684 * @param[in] schema Schema node to examine.
Radek Krejci857189e2020-09-01 13:26:36 +0200685 * @return Boolean value whether the node is under an operation output or not.
Michal Vasko00cbf532020-06-15 13:58:47 +0200686 */
Radek Krejci857189e2020-09-01 13:26:36 +0200687ly_bool lysc_is_output(const struct lysc_node *schema);
Michal Vasko00cbf532020-06-15 13:58:47 +0200688
Radek Krejci239c38a2020-10-19 10:58:25 +0200689/**
690 * @brief Get format-specific prefix for a module.
691 *
692 * For type plugins available as ::ly_type_print_get_prefix().
693 *
694 * @param[in] mod Module whose prefix to get.
695 * @param[in] format Format of the prefix.
696 * @param[in] prefix_data Format-specific data:
697 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving imports to prefixes)
698 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
699 * LY_PREF_XML - struct ly_set * (set of all returned modules as ::struct lys_module)
700 * LY_PREF_JSON - NULL
701 * @return Module prefix to print.
702 * @return NULL on error.
703 */
704const char *ly_get_prefix(const struct lys_module *mod, LY_PREFIX_FORMAT format, void *prefix_data);
705
706/**
707 * @brief Resolve format-specific prefixes to modules.
708 *
709 * For type plugins available as ::ly_type_store_resolve_prefix().
710 *
711 * @param[in] ctx libyang context.
712 * @param[in] prefix Prefix to resolve.
713 * @param[in] prefix_len Length of @p prefix.
714 * @param[in] format Format of the prefix.
715 * @param[in] prefix_data Format-specific data:
716 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
717 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
718 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
719 * LY_PREF_JSON - NULL
720 * @return Resolved prefix module,
721 * @return NULL otherwise.
722 */
723const struct lys_module *ly_resolve_prefix(const struct ly_ctx *ctx, const char *prefix, size_t prefix_len,
724 LY_PREFIX_FORMAT format, void *prefix_data);
725
Radek Krejci70853c52018-10-15 14:46:16 +0200726#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */