David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 1 | /** |
| 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ák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 14 | |
| 15 | #ifndef LY_PARSER_YIN_H_ |
| 16 | #define LY_PARSER_YIN_H_ |
| 17 | |
| 18 | #include <stdio.h> |
David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 19 | #include <stdlib.h> |
| 20 | |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 21 | #include "log.h" |
| 22 | #include "xml.h" |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 23 | |
David Sedlák | f625118 | 2019-06-06 10:22:13 +0200 | [diff] [blame] | 24 | /* list of yin attribute strings */ |
| 25 | extern const char *const yin_attr_list[]; |
| 26 | #define yin_attr2str(STMT) yin_attr_list[STMT] |
| 27 | |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame] | 28 | #define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1" |
David Sedlák | d6e5689 | 2019-07-01 15:40:24 +0200 | [diff] [blame] | 29 | #define name2fullname(name, prefix_len) (prefix_len != 0 ? name - (prefix_len + 1) : name) |
David Sedlák | f250ecf | 2019-07-01 11:02:05 +0200 | [diff] [blame] | 30 | #define namelen2fulllen(name_len, prefix_len) (prefix_len != 0 ? name_len + prefix_len + 1 : name_len) |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame] | 31 | |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 32 | enum YIN_ARGUMENT { |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 33 | YIN_ARG_UNKNOWN = 0, /**< parsed argument can not be matched with any supported yin argument keyword */ |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 34 | 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 */ |
| 43 | YIN_ARG_XMLNS, /**< argument xmlns */ |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 44 | YIN_ARG_NONE, /**< empty (special value) */ |
David Sedlák | 7ff55a9 | 2019-06-17 11:11:41 +0200 | [diff] [blame] | 45 | }; |
| 46 | |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 47 | /** |
| 48 | * @brief structure to store instance of xml attribute |
| 49 | */ |
David Sedlák | 7ff55a9 | 2019-06-17 11:11:41 +0200 | [diff] [blame] | 50 | struct yin_arg_record { |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 51 | const char *prefix; /**< start of prefix */ |
| 52 | size_t prefix_len; /**< length of prefix */ |
| 53 | const char *name; /**< start of name */ |
| 54 | size_t name_len; /**< length of name */ |
| 55 | char *content; /**< start of content */ |
| 56 | size_t content_len; /**< length of content */ |
| 57 | int dynamic_content; /**< is set to 1 iff content is dynamically allocated 0 otherwise */ |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 58 | }; |
| 59 | |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 60 | /* flags to encode cardinality of subelement */ |
| 61 | #define YIN_SUBELEM_MANDATORY 0x01 /**< is set when subelement is mandatory */ |
| 62 | #define YIN_SUBELEM_UNIQUE 0x02 /**< is set when subelement is unique */ |
| 63 | #define YIN_SUBELEM_PARSED 0x04 /**< is set during parsing when given subelement is encountered for the first |
| 64 | time to simply check validity of given constraints */ |
| 65 | |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 66 | #define YIN_ARG_MANDATORY 0x01 /**< is set when attribute is mandatory */ |
| 67 | #define YIN_ARG_IDENTIFIER 0x02 /**< is set when argument value is supposed to be identifier */ |
| 68 | |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 69 | struct yin_subelement { |
| 70 | enum yang_keyword type; /**< type of keyword */ |
| 71 | void *dest; /**< meta infromation passed to responsible function (information about where parsed subelement should be stored) */ |
| 72 | uint8_t flags; /**< describes carianlity of subelement can be set to YIN_SUBELEM_MANDATORY and YIN_SUBELEM_UNIQUE */ |
| 73 | }; |
| 74 | |
| 75 | struct sized_string { |
| 76 | const char *value; |
| 77 | size_t len; |
| 78 | }; |
| 79 | |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 80 | struct yin_argument_meta { |
| 81 | uint16_t *flags; /**< */ |
| 82 | const char **argument; /**< */ |
| 83 | }; |
| 84 | |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 85 | /** |
| 86 | * @brief Match argument name. |
| 87 | * |
| 88 | * @param[in] name String representing name. |
| 89 | * @param[in] len Lenght of the name. |
| 90 | * |
David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 91 | * @return YIN_ARGUMENT value. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 92 | */ |
David Sedlák | 060b00e | 2019-06-19 11:12:06 +0200 | [diff] [blame] | 93 | enum YIN_ARGUMENT yin_match_argument_name(const char *name, size_t len); |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 94 | |
| 95 | /** |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 96 | * @brief function to parse meta tags eg. elements with text element as child |
| 97 | * |
| 98 | * @param[in] xml_ctx Xml context. |
| 99 | * @param[in] args Sized array of arguments of current element. |
| 100 | * @param[in,out] data Data to read from. |
| 101 | * @param[out] value Where the content of meta tag should be stored. |
| 102 | * |
| 103 | * @return LY_ERR values. |
| 104 | */ |
| 105 | LY_ERR yin_parse_meta_element(struct lyxml_context *xml_ctx, const char **data, enum yang_keyword elem_type, |
| 106 | const char **value, struct lysp_ext_instance **exts); |
| 107 | |
| 108 | /** |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 109 | * @brief Map keyword type to substatement info. |
| 110 | * |
| 111 | * @param[in] kw Keyword type. |
| 112 | * |
| 113 | * @return correct LYEXT_SUBSTMT information. |
| 114 | */ |
| 115 | LYEXT_SUBSTMT kw2lyext_substmt(enum yang_keyword kw); |
| 116 | |
| 117 | /** |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 118 | * @brief Parse content of whole element as text. |
| 119 | * |
| 120 | * @param[in] xml_ctx Xml context. |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 121 | * @param[in] args Sized array of arguments of current element. |
David Sedlák | b666bcc | 2019-06-05 15:00:05 +0200 | [diff] [blame] | 122 | * @param[in,out] data Data to read from. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 123 | * @param[out] value Where content of element should be stored. |
David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 124 | * |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame] | 125 | * @return LY_ERR values. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 126 | */ |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 127 | LY_ERR yin_parse_text_element(struct lyxml_context *xml_ctx, const char **data, const char **value); |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 128 | |
David Sedlák | d9d3a31 | 2019-06-04 09:47:10 +0200 | [diff] [blame] | 129 | /** |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 130 | * @brief Parse simple element without any special constaints and argument mapped to yin attribute. |
| 131 | * |
| 132 | * @param[in] xml_ctx Xml context. |
| 133 | * @param[in,out] data Data to read from, always moved to currently handled character. |
| 134 | * @param[out] value Where value of attribute should be stored. |
| 135 | * |
| 136 | * @return LY_ERR values. |
| 137 | */ |
| 138 | LY_ERR yin_parse_simple_element(struct lyxml_context *xml_ctx, struct yin_arg_record *attrs, const char **data, |
| 139 | enum yang_keyword kw, const char **value, enum YIN_ARGUMENT arg_type, |
| 140 | uint8_t argument_flags, struct lysp_ext_instance **exts); |
| 141 | |
| 142 | /** |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame] | 143 | * @brief Parse import element. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 144 | * |
| 145 | * @param[in] xml_ctx Xml context. |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 146 | * @param[in] args Sized array of arguments of current element. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 147 | * @param[in] module_prefix Prefix of the module to check prefix collisions. |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 148 | * @param[in,out] data Data to read from. |
David Sedlák | b666bcc | 2019-06-05 15:00:05 +0200 | [diff] [blame] | 149 | * @param[in,out] imports Parsed imports to add to. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 150 | * |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame] | 151 | * @return LY_ERR values. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 152 | */ |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 153 | LY_ERR yin_parse_import(struct lyxml_context *xml_ctx, struct yin_arg_record **args, |
| 154 | const char **data, struct lysp_module *mod); |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 155 | |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 156 | /** |
| 157 | * @brief match yang keyword from yin data |
| 158 | * |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 159 | * @param[in] xml_ctx Xml context. |
| 160 | * @param[in] name Name Start of keyword name |
| 161 | * @param[in] name_len Lenght of keyword name. |
| 162 | * @param[in] prefix Start of keyword prefix. |
| 163 | * @param[in] prefix_len lenght of prefix. |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 164 | * |
| 165 | * @return yang_keyword values. |
| 166 | */ |
David Sedlák | 554e36d | 2019-06-20 16:00:04 +0200 | [diff] [blame] | 167 | enum yang_keyword yin_match_keyword(struct lyxml_context *xml_ctx, const char *name, size_t name_len, |
| 168 | const char *prefix, size_t prefix_len); |
David Sedlák | 1bccdfa | 2019-06-17 15:55:27 +0200 | [diff] [blame] | 169 | |
David Sedlák | b6e6597 | 2019-06-19 10:44:13 +0200 | [diff] [blame] | 170 | /** |
| 171 | * @brief Parse status statement. |
| 172 | * |
| 173 | * @param[in] xml_ctx Xml context. |
| 174 | * @param[in,out] data Data to read from. |
| 175 | * @param[in,out] flags Flags to add to. |
| 176 | * @param[in,out] exts Extension instances to add to. |
| 177 | * |
| 178 | * @return LY_ERR values. |
| 179 | */ |
David Sedlák | 554e36d | 2019-06-20 16:00:04 +0200 | [diff] [blame] | 180 | LY_ERR yin_parse_status(struct lyxml_context *xml_ctx, struct yin_arg_record **status_args, const char **data, |
| 181 | uint16_t *flags, struct lysp_ext_instance **exts); |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 182 | |
| 183 | /** |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 184 | * @brief Parse yin argument, arg_val is unchanged if argument arg_type wasn't found. |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 185 | * |
| 186 | * @param[in] xml_ctx XML parser context. |
| 187 | * @param[in,out] data Data to read from. |
| 188 | * @param[in] arg_type Type of argument that is expected in parsed element (use YIN_ARG_NONE for elements without special arguments). |
| 189 | * @param[out] arg_val Where value of argument should be stored. Can be NULL if arg_type is specified as YIN_ARG_NONE. |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 190 | * @param[in] flags Used to define constraints like mandatory of given attribute can be set to YIN_ATTR_MANDATORY. |
| 191 | * @param[in] current_element Identification of current element, used for logging. |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 192 | * |
| 193 | * @return LY_ERR values. |
| 194 | */ |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 195 | LY_ERR yin_parse_attribute(struct lyxml_context *xml_ctx, struct yin_arg_record **args, enum YIN_ARGUMENT arg_type, |
| 196 | const char **arg_val, uint8_t flags, enum yang_keyword current_element); |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 197 | |
| 198 | /** |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 199 | * @brief Parse prefix element. |
| 200 | * |
| 201 | * @param[in] xml_ctx Xml parser context. |
| 202 | * @param[in] attrs Attributes of prefix element. |
| 203 | * @param[in,out] prefix Where the value of prefix should be stored. |
| 204 | * @param[in,out] data Data to read from, always moved to currently handled character. |
| 205 | * @param[in] exts Extension instance to add to. |
| 206 | * |
| 207 | * @return LY_ERR values. |
| 208 | */ |
| 209 | LY_ERR yin_parse_prefix(struct lyxml_context *xml_ctx, struct yin_arg_record *attrs, const char **prefix, |
| 210 | const char **data, struct lysp_ext_instance **exts); |
| 211 | |
| 212 | /** |
| 213 | * @brief Parse revision date. |
| 214 | * |
| 215 | * @param[in] xml_ctx Xml context. |
| 216 | * @param[in] args Sized array of arguments of current element. |
| 217 | * @param[in,out] data Data to read from. |
| 218 | * @param[in,out] rev Array to store the parsed value in. |
| 219 | * @param[in,out] exts Extension instances to add to. |
| 220 | * |
| 221 | * @return LY_ERR values. |
| 222 | */ |
| 223 | LY_ERR yin_parse_revision_date(struct lyxml_context *xml_ctx, struct yin_arg_record **args, const char **data, |
| 224 | char *rev, struct lysp_ext_instance **exts); |
| 225 | |
| 226 | /** |
David Sedlák | 2721d3d | 2019-06-21 15:37:41 +0200 | [diff] [blame] | 227 | * @brief Load all attributes from current element. Caller is supposed to free args array. |
David Sedlák | 8f7a117 | 2019-06-20 14:42:18 +0200 | [diff] [blame] | 228 | * |
| 229 | * @param[in,out] xml_ctx Xml context. |
| 230 | * @param[in,out] data Data to read from, always moved to currently handled position. |
| 231 | * @param[out] args Sized array of attributes. |
| 232 | * |
| 233 | * @return LY_ERR values. |
| 234 | */ |
| 235 | LY_ERR yin_load_attributes(struct lyxml_context *xml_ctx, const char **data, struct yin_arg_record **args); |
David Sedlák | b6e6597 | 2019-06-19 10:44:13 +0200 | [diff] [blame] | 236 | |
David Sedlák | 554e36d | 2019-06-20 16:00:04 +0200 | [diff] [blame] | 237 | /** |
David Sedlák | 2721d3d | 2019-06-21 15:37:41 +0200 | [diff] [blame] | 238 | * @brief Parse yin-elemenet element. |
| 239 | * |
| 240 | * @param[in,out] xml_ctx Xml context. |
| 241 | * @param[in] attrs Sized array of element attributes. |
| 242 | * @param[in,out] data Data to read from, always moved to currently handled position. |
| 243 | * @param[in,out] flags Flags to add to. |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 244 | * @prama[in,out] exts Extension instance to add to. |
David Sedlák | 2721d3d | 2019-06-21 15:37:41 +0200 | [diff] [blame] | 245 | * |
| 246 | * @return LY_ERR values. |
| 247 | */ |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 248 | LY_ERR yin_parse_yin_element_element(struct lyxml_context *xml_ctx, struct yin_arg_record *attrs, const char **data, |
| 249 | uint16_t *flags, struct lysp_ext_instance **exts); |
| 250 | |
| 251 | /** |
| 252 | * @brief Parse argument element. |
| 253 | * |
| 254 | * @param[in,out] xml_ctx Xml context. |
| 255 | * @param[in] attrs Attributes of this element. |
| 256 | * @param[in,out] data Data to read from, always moved to currently handled character. |
| 257 | * @param[in,out] arg_meta Meta information about destionation af prased data. |
| 258 | * @param[in,out] exts Extension instance to add to. |
| 259 | * |
| 260 | * @return LY_ERR values. |
| 261 | */ |
| 262 | LY_ERR yin_parse_argument_element(struct lyxml_context *xml_ctx, struct yin_arg_record **attrs, const char **data, |
| 263 | struct yin_argument_meta *arg_meta, struct lysp_ext_instance **exts); |
David Sedlák | 2721d3d | 2019-06-21 15:37:41 +0200 | [diff] [blame] | 264 | |
| 265 | /** |
David Sedlák | 554e36d | 2019-06-20 16:00:04 +0200 | [diff] [blame] | 266 | * @brief Parse the extension statement. |
| 267 | * |
| 268 | * @param[in] xml_ctx Xml context. |
| 269 | * @param[in] extension_args Arguments of extension element. |
| 270 | * @param[in,out] data Data to read from. |
| 271 | * @param[in,out] extensions Extensions to add to. |
| 272 | * |
| 273 | * @return LY_ERR values. |
| 274 | */ |
| 275 | LY_ERR yin_parse_extension(struct lyxml_context *xml_ctx, struct yin_arg_record **extension_args, |
| 276 | const char **data, struct lysp_ext **extensions); |
| 277 | |
David Sedlák | b1a7835 | 2019-06-28 16:16:29 +0200 | [diff] [blame] | 278 | /** |
| 279 | * @brief Parse instance of extension. |
| 280 | * |
| 281 | * @param[in,out] xml_ctx Xml context. |
| 282 | * @param[in] attrs Sized array of attributes. |
| 283 | * @param[in,out] data Data to read from, always moved to currently handled character. |
| 284 | * @param[in] ext_name Name of the extension element. |
| 285 | * @param[in] ext_name_len Length of extension name. |
David Sedlák | 3ffbc52 | 2019-07-02 17:49:28 +0200 | [diff] [blame] | 286 | * @param[in,out] metadata Meta information about extension instance passed from caller function. |
David Sedlák | b1a7835 | 2019-06-28 16:16:29 +0200 | [diff] [blame] | 287 | * |
| 288 | * @return LY_ERR values. |
| 289 | */ |
| 290 | LY_ERR yin_parse_extension_instance(struct lyxml_context *xml_ctx, struct yin_arg_record **attrs, const char **data, |
David Sedlák | 619db94 | 2019-07-03 14:47:30 +0200 | [diff] [blame^] | 291 | const char *ext_name, int ext_name_len, LYEXT_SUBSTMT subelem, |
| 292 | uint32_t subelem_index, struct lysp_ext_instance **exts); |
David Sedlák | b1a7835 | 2019-06-28 16:16:29 +0200 | [diff] [blame] | 293 | |
| 294 | /** |
| 295 | * @brief Parse yin element into generic structure. |
| 296 | * |
| 297 | * @param[in,out] xml_ctx Xml context. |
| 298 | * @param[in] name Name of element. |
| 299 | * @param[in] name_len Length of elements Name. |
| 300 | * @param[in,out] data Data to read from, always moved to currently handled character. |
| 301 | * @param[out] element Where the element structure should be stored. |
| 302 | * |
| 303 | * @return LY_ERR values. |
| 304 | */ |
David Sedlák | f250ecf | 2019-07-01 11:02:05 +0200 | [diff] [blame] | 305 | LY_ERR yin_parse_element_generic(struct lyxml_context *xml_ctx, const char *name, size_t name_len, const char *prefix, |
| 306 | size_t prefix_len, const char **data, struct lysp_stmt **element); |
David Sedlák | b1a7835 | 2019-06-28 16:16:29 +0200 | [diff] [blame] | 307 | |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 308 | #endif /* LY_PARSER_YIN_H_*/ |