blob: 32060a593e0b26fc9bf3ca2f84cfcc4ba031755c [file] [log] [blame]
David Sedlákb1ce3f82019-06-05 14:37:26 +02001/**
2 * @file parser_yin.h
3 * @author David Sedlák <xsedla1d@stud.fit.vutbr.cz>
4 * @brief YIN parser.
5 *
6 * Copyright (c) 2015 - 2019 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 */
David Sedlák2b626ee2019-06-03 16:40:18 +020014
15#ifndef LY_PARSER_YIN_H_
16#define LY_PARSER_YIN_H_
17
18#include <stdio.h>
David Sedlákb1ce3f82019-06-05 14:37:26 +020019#include <stdlib.h>
20
David Sedlák2b626ee2019-06-03 16:40:18 +020021#include "log.h"
22#include "xml.h"
David Sedlák2b626ee2019-06-03 16:40:18 +020023
David Sedlákf6251182019-06-06 10:22:13 +020024/* list of yin attribute strings */
25extern const char *const yin_attr_list[];
26#define yin_attr2str(STMT) yin_attr_list[STMT]
27
David Sedlák2b214ac2019-06-06 16:11:03 +020028#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
David Sedlákd6e56892019-07-01 15:40:24 +020029#define name2fullname(name, prefix_len) (prefix_len != 0 ? name - (prefix_len + 1) : name)
David Sedlákf250ecf2019-07-01 11:02:05 +020030#define namelen2fulllen(name_len, prefix_len) (prefix_len != 0 ? name_len + prefix_len + 1 : name_len)
David Sedlák2b214ac2019-06-06 16:11:03 +020031
David Sedlák2b626ee2019-06-03 16:40:18 +020032enum YIN_ARGUMENT {
David Sedlák1bccdfa2019-06-17 15:55:27 +020033 YIN_ARG_UNKNOWN = 0, /**< parsed argument can not be matched with any supported yin argument keyword */
David Sedlák2b626ee2019-06-03 16:40:18 +020034 YIN_ARG_NAME, /**< argument name */
35 YIN_ARG_TARGET_NODE, /**< argument target-node */
36 YIN_ARG_MODULE, /**< argument module */
37 YIN_ARG_VALUE, /**< argument value */
38 YIN_ARG_TEXT, /**< argument text */
39 YIN_ARG_CONDITION, /**< argument condition */
40 YIN_ARG_URI, /**< argument uri */
41 YIN_ARG_DATE, /**< argument data */
42 YIN_ARG_TAG, /**< argument tag */
David Sedlák1bccdfa2019-06-17 15:55:27 +020043 YIN_ARG_NONE, /**< empty (special value) */
David Sedlák7ff55a92019-06-17 11:11:41 +020044};
45
David Sedlák1bccdfa2019-06-17 15:55:27 +020046/**
47 * @brief structure to store instance of xml attribute
48 */
David Sedlák7ff55a92019-06-17 11:11:41 +020049struct yin_arg_record {
David Sedlák1bccdfa2019-06-17 15:55:27 +020050 const char *prefix; /**< start of prefix */
51 size_t prefix_len; /**< length of prefix */
52 const char *name; /**< start of name */
53 size_t name_len; /**< length of name */
54 char *content; /**< start of content */
55 size_t content_len; /**< length of content */
56 int dynamic_content; /**< is set to 1 iff content is dynamically allocated 0 otherwise */
David Sedlák2b626ee2019-06-03 16:40:18 +020057};
58
David Sedlákda8ffa32019-07-08 14:17:10 +020059struct yin_parser_ctx {
60 struct lyxml_context xml_ctx; /**< context for xml parser */
61 uint8_t mod_version; /**< module's version */
62};
63
David Sedlák3ffbc522019-07-02 17:49:28 +020064/* flags to encode cardinality of subelement */
65#define YIN_SUBELEM_MANDATORY 0x01 /**< is set when subelement is mandatory */
66#define YIN_SUBELEM_UNIQUE 0x02 /**< is set when subelement is unique */
David Sedlák21f87cd2019-07-03 16:53:23 +020067#define YIN_SUBELEM_FIRST 0x08 /**< is set when subelement is actually yang argument mapped to yin element */
68
69#define YIN_SUBELEM_PARSED 0x80 /**< is set during parsing when given subelement is encountered for the first
David Sedlák3ffbc522019-07-02 17:49:28 +020070 time to simply check validity of given constraints */
71
72struct yin_subelement {
73 enum yang_keyword type; /**< type of keyword */
74 void *dest; /**< meta infromation passed to responsible function (information about where parsed subelement should be stored) */
David Sedlákb4e44562019-07-04 15:42:12 +020075 uint8_t flags; /**< describes cardianlity of subelement can be set to YIN_SUBELEM_MANDATORY and YIN_SUBELEM_UNIQUE and YIN_SUBELEM_FIRST */
David Sedlák3ffbc522019-07-02 17:49:28 +020076};
77
David Sedlákb4e44562019-07-04 15:42:12 +020078/* helper structure just to make code look simpler */
David Sedlák3ffbc522019-07-02 17:49:28 +020079struct sized_string {
80 const char *value;
81 size_t len;
82};
83
David Sedlákb4e44562019-07-04 15:42:12 +020084/* Meta information passed to yin_parse_argument function,
85 holds information about where content of argument element will be stored. */
David Sedlák3ffbc522019-07-02 17:49:28 +020086struct yin_argument_meta {
David Sedlákb4e44562019-07-04 15:42:12 +020087 uint16_t *flags; /**< Argument flags */
88 const char **argument; /**< Argument value */
David Sedlák3ffbc522019-07-02 17:49:28 +020089};
90
David Sedlák2b626ee2019-06-03 16:40:18 +020091/**
92 * @brief Match argument name.
93 *
94 * @param[in] name String representing name.
95 * @param[in] len Lenght of the name.
96 *
David Sedlákb1ce3f82019-06-05 14:37:26 +020097 * @return YIN_ARGUMENT value.
David Sedlák2b626ee2019-06-03 16:40:18 +020098 */
David Sedlák060b00e2019-06-19 11:12:06 +020099enum YIN_ARGUMENT yin_match_argument_name(const char *name, size_t len);
David Sedlák2b626ee2019-06-03 16:40:18 +0200100
101/**
David Sedlák555c7202019-07-04 12:14:12 +0200102 * @brief Generic function for content parsing
David Sedlák2b626ee2019-06-03 16:40:18 +0200103 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200104 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlák555c7202019-07-04 12:14:12 +0200105 * @param[in] subelem_info array of valid subelement types and meta information,
106 * array must be ordered by subelem_info->type in ascending order.
107 * @param[in] subelem_info_size Size of subelem_info array.
108 * @param[in,out] data Data to read from, always moved to currently handled character.
109 * @param[in] current_element Type of current element.
David Sedlákb4e44562019-07-04 15:42:12 +0200110 * @param[out] text_content Where the text content of element should be stored if any. Text content is ignored if set to NULL.
David Sedlákda8ffa32019-07-08 14:17:10 +0200111 * @param[in,out] exts Extension instance to add to. Can be se to null if element cannot have extension as subelements.
David Sedlákb4e44562019-07-04 15:42:12 +0200112
David Sedlák2b214ac2019-06-06 16:11:03 +0200113 * @return LY_ERR values.
David Sedlák2b626ee2019-06-03 16:40:18 +0200114 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200115LY_ERR yin_parse_content(struct yin_parser_ctx *ctx, struct yin_subelement *subelem_info, signed char subelem_info_size,
David Sedlák555c7202019-07-04 12:14:12 +0200116 const char **data, enum yang_keyword current_element, const char **text_content,
117 struct lysp_ext_instance **exts);
David Sedlák2b626ee2019-06-03 16:40:18 +0200118
David Sedlákd9d3a312019-06-04 09:47:10 +0200119/**
David Sedlák92147b02019-07-09 14:01:01 +0200120 * @brief Parse yang-version element.
121 *
122 * @param[in,out] ctx Yin parser context for logging and to store current state.
123 * @param[in] attrs Attributes of when element.
124 * @param[in] data Data to read from, always moved to currently handled character.
125 * @param[out] version Storage for the parsed information.
126 * @param[in,out] exts Extension instance to add to.
127 *
128 * @return LY_ERR values.
129 */
130LY_ERR yin_parse_yangversion(struct yin_parser_ctx *ctx, struct yin_arg_record *attrs, const char **data, uint8_t *version,
131 struct lysp_ext_instance **exts);
132
133/**
David Sedlák2b214ac2019-06-06 16:11:03 +0200134 * @brief Parse import element.
David Sedlákda63c082019-06-04 13:52:23 +0200135 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200136 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200137 * @param[in] attrs Sized array of attributes of import element.
David Sedlákda8ffa32019-07-08 14:17:10 +0200138 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlákb4e44562019-07-04 15:42:12 +0200139 * @param[in,out] mod Structure of module that is being parsed.
David Sedlákda63c082019-06-04 13:52:23 +0200140 *
David Sedlák2b214ac2019-06-06 16:11:03 +0200141 * @return LY_ERR values.
David Sedlákda63c082019-06-04 13:52:23 +0200142 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200143LY_ERR yin_parse_import(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs,
David Sedlák619db942019-07-03 14:47:30 +0200144 const char **data, struct lysp_module *mod);
David Sedlák2b626ee2019-06-03 16:40:18 +0200145
David Sedlák1bccdfa2019-06-17 15:55:27 +0200146/**
David Sedlákb4e44562019-07-04 15:42:12 +0200147 * @brief Match yang keyword from yin data.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200148 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200149 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200150 * @param[in] name Start of keyword name
David Sedlák8f7a1172019-06-20 14:42:18 +0200151 * @param[in] name_len Lenght of keyword name.
152 * @param[in] prefix Start of keyword prefix.
153 * @param[in] prefix_len lenght of prefix.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200154 *
155 * @return yang_keyword values.
156 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200157enum yang_keyword yin_match_keyword(struct yin_parser_ctx *ctx, const char *name, size_t name_len,
David Sedlák554e36d2019-06-20 16:00:04 +0200158 const char *prefix, size_t prefix_len);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200159
David Sedlákb6e65972019-06-19 10:44:13 +0200160/**
David Sedlákb4e44562019-07-04 15:42:12 +0200161 * @brief Parse status element.
David Sedlákb6e65972019-06-19 10:44:13 +0200162 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200163 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200164 * @param[in] attrs Atributes of status element.
David Sedlákda8ffa32019-07-08 14:17:10 +0200165 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlákb6e65972019-06-19 10:44:13 +0200166 * @param[in,out] flags Flags to add to.
167 * @param[in,out] exts Extension instances to add to.
168 *
169 * @return LY_ERR values.
170 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200171LY_ERR yin_parse_status(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs, const char **data,
David Sedlák554e36d2019-06-20 16:00:04 +0200172 uint16_t *flags, struct lysp_ext_instance **exts);
David Sedlák8f7a1172019-06-20 14:42:18 +0200173
174/**
David Sedlák32eee7b2019-07-09 12:38:44 +0200175 * @brief Parse when element.
176 *
177 * @param[in,out] ctx Yin parser context for logging and to store current state.
178 * @param[in] attrs Attributes of when element.
179 * @param[in,out] data Data to read from, always moved to currently handled character.
180 * @param[out] when_p When pointer to parse to.
181 */
182LY_ERR yin_parse_when(struct yin_parser_ctx *ctx, struct yin_arg_record *attrs, const char **data, struct lysp_when **when_p);
183
184/**
David Sedlákb4e44562019-07-04 15:42:12 +0200185 * @brief Parse revision date element.
David Sedlák3ffbc522019-07-02 17:49:28 +0200186 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200187 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200188 * @param[in] attrs Sized array of attributes of revision-date element.
David Sedlákda8ffa32019-07-08 14:17:10 +0200189 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlák3ffbc522019-07-02 17:49:28 +0200190 * @param[in,out] rev Array to store the parsed value in.
191 * @param[in,out] exts Extension instances to add to.
192 *
193 * @return LY_ERR values.
194 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200195LY_ERR yin_parse_revision_date(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs, const char **data,
David Sedlák3ffbc522019-07-02 17:49:28 +0200196 char *rev, struct lysp_ext_instance **exts);
197
198/**
David Sedlákda8ffa32019-07-08 14:17:10 +0200199 * @brief Load all attributes from current element. Caller is supposed to free attrs array.
David Sedlák8f7a1172019-06-20 14:42:18 +0200200 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200201 * @param[in,out] ctx Yin parser context for logging and to store current state.
202 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlákb4e44562019-07-04 15:42:12 +0200203 * @param[out] attrs Sized array of attributes.
David Sedlák8f7a1172019-06-20 14:42:18 +0200204 *
205 * @return LY_ERR values.
206 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200207LY_ERR yin_load_attributes(struct yin_parser_ctx *ctx, const char **data, struct yin_arg_record **attrs);
David Sedlákb6e65972019-06-19 10:44:13 +0200208
David Sedlák554e36d2019-06-20 16:00:04 +0200209/**
David Sedlák2721d3d2019-06-21 15:37:41 +0200210 * @brief Parse yin-elemenet element.
211 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200212 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlák2721d3d2019-06-21 15:37:41 +0200213 * @param[in] attrs Sized array of element attributes.
214 * @param[in,out] data Data to read from, always moved to currently handled position.
215 * @param[in,out] flags Flags to add to.
David Sedlák3ffbc522019-07-02 17:49:28 +0200216 * @prama[in,out] exts Extension instance to add to.
David Sedlák2721d3d2019-06-21 15:37:41 +0200217 *
218 * @return LY_ERR values.
219 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200220LY_ERR yin_parse_yin_element_element(struct yin_parser_ctx *ctx, struct yin_arg_record *attrs, const char **data,
David Sedlák3ffbc522019-07-02 17:49:28 +0200221 uint16_t *flags, struct lysp_ext_instance **exts);
222
223/**
224 * @brief Parse argument element.
225 *
226 * @param[in,out] xml_ctx Xml context.
227 * @param[in] attrs Attributes of this element.
228 * @param[in,out] data Data to read from, always moved to currently handled character.
229 * @param[in,out] arg_meta Meta information about destionation af prased data.
230 * @param[in,out] exts Extension instance to add to.
231 *
232 * @return LY_ERR values.
233 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200234LY_ERR yin_parse_argument_element(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs, const char **data,
David Sedlák3ffbc522019-07-02 17:49:28 +0200235 struct yin_argument_meta *arg_meta, struct lysp_ext_instance **exts);
David Sedlák2721d3d2019-06-21 15:37:41 +0200236
237/**
David Sedlák554e36d2019-06-20 16:00:04 +0200238 * @brief Parse the extension statement.
239 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200240 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200241 * @param[in] attrs Attributes of extension element.
David Sedlák554e36d2019-06-20 16:00:04 +0200242 * @param[in,out] data Data to read from.
243 * @param[in,out] extensions Extensions to add to.
244 *
245 * @return LY_ERR values.
246 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200247LY_ERR yin_parse_extension(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs,
David Sedlák554e36d2019-06-20 16:00:04 +0200248 const char **data, struct lysp_ext **extensions);
249
David Sedlákb1a78352019-06-28 16:16:29 +0200250/**
251 * @brief Parse instance of extension.
252 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200253 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb1a78352019-06-28 16:16:29 +0200254 * @param[in] attrs Sized array of attributes.
255 * @param[in,out] data Data to read from, always moved to currently handled character.
256 * @param[in] ext_name Name of the extension element.
257 * @param[in] ext_name_len Length of extension name.
David Sedlákb4e44562019-07-04 15:42:12 +0200258 * @param[in] subelem Type of the keyword this extension instance is a subelement of.
259 * @param[in] subelem_index Index of the keyword instance this extension instance is a subelement of
260 * @param[in,out] exts Extension instance to add to.
David Sedlákb1a78352019-06-28 16:16:29 +0200261 *
262 * @return LY_ERR values.
263 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200264LY_ERR yin_parse_extension_instance(struct yin_parser_ctx *ctx, struct yin_arg_record **attrs, const char **data,
David Sedlák619db942019-07-03 14:47:30 +0200265 const char *ext_name, int ext_name_len, LYEXT_SUBSTMT subelem,
266 uint32_t subelem_index, struct lysp_ext_instance **exts);
David Sedlákb1a78352019-06-28 16:16:29 +0200267
268/**
269 * @brief Parse yin element into generic structure.
270 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200271 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb1a78352019-06-28 16:16:29 +0200272 * @param[in] name Name of element.
273 * @param[in] name_len Length of elements Name.
David Sedlákb4e44562019-07-04 15:42:12 +0200274 * @param[in] prefix Element prefix.
275 * @param[in] prefix_len Length of element prefix.
David Sedlákb1a78352019-06-28 16:16:29 +0200276 * @param[in,out] data Data to read from, always moved to currently handled character.
277 * @param[out] element Where the element structure should be stored.
278 *
279 * @return LY_ERR values.
280 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200281LY_ERR yin_parse_element_generic(struct yin_parser_ctx *ctx, const char *name, size_t name_len, const char *prefix,
282 size_t prefix_len, const char **data, struct lysp_stmt **element);
David Sedlákb1a78352019-06-28 16:16:29 +0200283
David Sedlák2b626ee2019-06-03 16:40:18 +0200284#endif /* LY_PARSER_YIN_H_*/