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" |
| 29 | |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 30 | enum YIN_ARGUMENT { |
| 31 | YIN_ARG_UNKNOWN = 0, /**< parsed argument can not be matched with any known yin argument keyword */ |
| 32 | YIN_ARG_NAME, /**< argument name */ |
| 33 | YIN_ARG_TARGET_NODE, /**< argument target-node */ |
| 34 | YIN_ARG_MODULE, /**< argument module */ |
| 35 | YIN_ARG_VALUE, /**< argument value */ |
| 36 | YIN_ARG_TEXT, /**< argument text */ |
| 37 | YIN_ARG_CONDITION, /**< argument condition */ |
| 38 | YIN_ARG_URI, /**< argument uri */ |
| 39 | YIN_ARG_DATE, /**< argument data */ |
| 40 | YIN_ARG_TAG, /**< argument tag */ |
| 41 | YIN_ARG_XMLNS, /**< argument xmlns */ |
David Sedlák | 6882673 | 2019-06-05 10:50:58 +0200 | [diff] [blame] | 42 | YIN_ARG_NONE, /**< special value to specify no valid argument except xmlns, do not confuse with YIN_ARG_UNKNOWN */ |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 43 | }; |
| 44 | |
| 45 | /** |
| 46 | * @brief Match argument name. |
| 47 | * |
| 48 | * @param[in] name String representing name. |
| 49 | * @param[in] len Lenght of the name. |
| 50 | * |
David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 51 | * @return YIN_ARGUMENT value. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 52 | */ |
| 53 | enum YIN_ARGUMENT match_argument_name(const char *name, size_t len); |
| 54 | |
| 55 | /** |
| 56 | * @brief Parse content of whole element as text. |
| 57 | * |
| 58 | * @param[in] xml_ctx Xml context. |
David Sedlák | b666bcc | 2019-06-05 15:00:05 +0200 | [diff] [blame] | 59 | * @param[in,out] data Data to read from. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 60 | * @param[out] value Where content of element should be stored. |
David Sedlák | b1ce3f8 | 2019-06-05 14:37:26 +0200 | [diff] [blame] | 61 | * |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame^] | 62 | * @return LY_ERR values. |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 63 | */ |
| 64 | LY_ERR parse_text_element(struct lyxml_context *xml_ctx, const char **data, const char **value); |
| 65 | |
David Sedlák | d9d3a31 | 2019-06-04 09:47:10 +0200 | [diff] [blame] | 66 | /** |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame^] | 67 | * @brief Parse import element. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 68 | * |
| 69 | * @param[in] xml_ctx Xml context. |
| 70 | * @param[in] module_prefix Prefix of the module to check prefix collisions. |
David Sedlák | b666bcc | 2019-06-05 15:00:05 +0200 | [diff] [blame] | 71 | * @param[in,out] data Dta to read from. |
| 72 | * @param[in,out] imports Parsed imports to add to. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 73 | * |
David Sedlák | 2b214ac | 2019-06-06 16:11:03 +0200 | [diff] [blame^] | 74 | * @return LY_ERR values. |
David Sedlák | da63c08 | 2019-06-04 13:52:23 +0200 | [diff] [blame] | 75 | */ |
| 76 | LY_ERR yin_parse_import(struct lyxml_context *xml_ctx, const char *module_prefix, const char **data, struct lysp_import **imports); |
David Sedlák | 2b626ee | 2019-06-03 16:40:18 +0200 | [diff] [blame] | 77 | |
| 78 | #endif /* LY_PARSER_YIN_H_*/ |