blob: 8e78a10a932c51ba5daa4a320416e08685c77f5d [file] [log] [blame]
Radek Krejcie9f13b12020-11-09 17:42:04 +01001/**
2 * @file common.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang's yanglint tool - common functions and definitions for both interactive and non-interactive mode.
5 *
6 * Copyright (c) 2020 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 COMMON_H_
16#define COMMON_H_
17
18#include <stdint.h>
19#include <stdio.h>
20
21#include "libyang.h"
22
23#define PROMPT "> "
24
25/**
26 * @brief log error message
27 */
28#define YLMSG_E(MSG, ...) \
Radek Krejci0d7809b2020-11-26 12:50:12 +010029 fprintf(stderr, "YANGLINT[E]: " MSG, ##__VA_ARGS__)
Radek Krejcie9f13b12020-11-09 17:42:04 +010030
31/**
32 * @brief log warning message
33 */
34#define YLMSG_W(MSG, ...) \
35 fprintf(stderr, "YANGLINT[W]: " MSG, ##__VA_ARGS__)
36
37/**
38 * @brief Storage for the list of the features (their names) in a specific YANG module.
39 */
40struct schema_features {
41 char *module;
42 char **features;
43};
44
45/**
46 * @brief Data connected with a file provided on a command line as a file path.
47 */
48struct cmdline_file {
49 struct ly_in *in;
50 const char *path;
51 LYD_FORMAT format;
52};
53
54/**
55 * @brief Free the schema features list (struct schema_features *)
56 * @param[in,out] flist The (struct schema_features *) to free.
57 */
58void free_features(void *flist);
59
60/**
61 * @brief Get the list of features connected with the specific YANG module.
62 *
63 * @param[in] fset The set of features information (struct schema_features *).
64 * @param[in] module Name of the YANG module which features should be found.
65 * @param[out] features Pointer to the list of features being returned.
66 */
67void get_features(struct ly_set *fset, const char *module, const char ***features);
68
69/**
70 * @brief Parse features being specified for the specific YANG module.
71 *
72 * Format of the input @p fstring is as follows: <module_name>:[<feature>,]*
73 *
74 * @param[in] fstring Input string to be parsed.
75 * @param[in, out] fset Features information set (of struct schema_features *). The set is being filled.
76 */
77int parse_features(const char *fstring, struct ly_set *fset);
78
79/**
80 * @brief Parse path of a schema module file into the directory and module name.
81 *
82 * @param[in] path Schema module file path to be parsed.
83 * @param[out] dir Pointer to the directory path where the file resides. Caller is expected to free the returned string.
84 * @param[out] module Pointer to the name of the module (without file suffixes or revision information) specified by the
85 * @path. Caller is expected to free the returned string.
86 * @return 0 on success
87 * @return -1 on error
88 */
89int parse_schema_path(const char *path, char **dir, char **module);
90
91/**
92 * @brief Get input handler for the specified path.
93 *
94 * Using the @p format_schema and @p format_data the type of the file can be limited (by providing NULL) or it can be
95 * got known if both types are possible.
96 *
97 * @param[in] filepath Path of the file to open.
98 * @param[out] format_schema Format of the schema detected from the file name. If NULL specified, the schema formats are
99 * prohibited and such files are refused.
100 * @param[out] format_data Format of the data detected from the file name. If NULL specified, the data formats are
101 * prohibited and such files are refused.
102 * @param[out] in Created input handler referring the file behind the @p filepath.
103 * @return 0 on success.
104 * @return -1 on failure.
105 */
106int get_input(const char *filepath, LYS_INFORMAT *format_schema, LYD_FORMAT *format_data, struct ly_in **in);
107
108/**
109 * @brief Free the command line file data (struct cmdline_file *)
110 * @param[in,out] cmdline_file The (struct cmdline_file *) to free.
111 */
112void free_cmdline_file(void *cmdline_file);
113
114/**
115 * @brief Create and fill the command line file data (struct cmdline_file *).
116 * @param[in] set Optional parameter in case the record is supposed to be added into a set.
117 * @param[in] in Input file handler.
118 * @param[in] path Filepath of the file.
119 * @param[in] format Format of the data file.
120 * @return The created command line file structure.
121 * @return NULL on failure
122 */
123struct cmdline_file *fill_cmdline_file(struct ly_set *set, struct ly_in *in, const char *path, LYD_FORMAT format);
124
125/**
126 * @brief Helper function to prepare argc, argv pair from a command line string.
127 *
128 * @param[in] cmdline Complete command line string.
129 * @param[out] argc_p Pointer to store argc value.
130 * @param[out] argv_p Pointer to store argv vector.
131 * @return 0 on success, non-zero on failure.
132 */
133int parse_cmdline(const char *cmdline, int *argc_p, char **argv_p[]);
134
135/**
136 * @brief Destructor for the argument vector prepared by ::parse_cmdline().
137 *
138 * @param[in,out] argv Argument vector to destroy.
139 */
140void free_cmdline(char *argv[]);
141
142/**
143 * @brief Get expected format of the @p filename's content according to the @p filename's suffix.
144 * @param[in] filename Name of the file to examine.
145 * @param[out] schema Pointer to a variable to store the expected input schema format. Do not provide the pointer in case a
146 * schema format is not expected.
147 * @param[out] data Pointer to a variable to store the expected input data format. Do not provide the pointer in case a data
148 * format is not expected.
149 * @return zero in case a format was successfully detected.
150 * @return nonzero in case it is not possible to get valid format from the @p filename.
151 */
152int get_format(const char *filename, LYS_INFORMAT *schema, LYD_FORMAT *data);
153
154/**
155 * @brief Print list of schemas in the context.
156 *
157 * @param[in] out Output handler where to print.
158 * @param[in] ctx Context to print.
159 * @param[in] outformat Optional output format. If not specified (:LYD_UNKNOWN), a simple list with single module per line
160 * is printed. Otherwise, the ietf-yang-library data are printed in the specified format.
161 * @return zero in case the data successfully printed.
162 * @return nonzero in case of error.
163 */
164int print_list(struct ly_out *out, struct ly_ctx *ctx, LYD_FORMAT outformat);
165
166/**
167 * @brief Check correctness of the specified Request XPaths for the input data files representing RPCs/Actions.
168 *
169 * If the requests specified as XPath(s) of the RPC/Action, there must be only a single path applying to all the replies
170 * or their number must correspond to the number of replies in input data files.
171 *
172 * @param[in] ctx libyang context with the schema modules to check the correctness of the paths.
173 * @param[in] request_paths The set of Requests' XPaths to check.
174 * @param[in] data_inputs The set of data file inputs with the replies to be parsed.
175 * @return 0 on success
176 * @return -1 on error
177 */
178int check_request_paths(struct ly_ctx *ctx, struct ly_set *request_paths, struct ly_set *data_inputs);
179
180/**
181 * @brief Process the input data files - parse, validate and print according to provided options.
182 *
183 * @param[in] ctx libyang context with schema.
184 * @param[in] data_type The type of data in the input files, can be 0 for standard data tree and ::LYD_VALIDATE_OP values for
185 * the operations.
186 * @param[in] merge Flag if the data should be merged before validation.
187 * @param[in] format Data format for printing.
188 * @param[in] out The output handler for printing.
189 * @param[in] options_parse Parser options.
190 * @param[in] options_validate Validation options.
191 * @param[in] options_print Printer options.
192 * @param[in] operational_f Optional operational datastore file information for the case of an extended validation of
193 * operation(s).
194 * @param[in] inputs Set of file informations of input data files.
195 * @param[in] request_paths Set of xpaths refering to the request RPCs/Actions for the replies being processed.
196 * @param[in] requests The set of input data files containing request RPCs/Actions for the replies being processed.
197 * Alternative to @p request_paths.
198 * @param[in] xpath The set of XPaths to be evaluated on the processed data tree, basic information about the resulting set
199 * is printed. Alternative to data printing.
200 * return LY_ERR value.
201 */
202LY_ERR process_data(struct ly_ctx *ctx, uint8_t data_type, uint8_t merge, LYD_FORMAT format, struct ly_out *out,
203 uint32_t options_parse, uint32_t options_validate, uint32_t options_print,
204 struct cmdline_file *operational_f, struct ly_set *inputs, struct ly_set *request_paths, struct ly_set *requests,
205 struct ly_set *xpaths);
206
207#endif /* COMMON_H_ */