adbb683329
* All uses of `api_path2xpath_cvv()` should be replaced by `api_path2xpath()` * `api_path2xpath()` added an `xerr` argument.
97 lines
4.2 KiB
C
97 lines
4.2 KiB
C
/*
|
|
*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
|
|
Copyright (C) 2017-2019 Olof Hagsand
|
|
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC
|
|
|
|
This file is part of CLIXON.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
Alternatively, the contents of this file may be used under the terms of
|
|
the GNU General Public License Version 3 or later (the "GPL"),
|
|
in which case the provisions of the GPL are applicable instead
|
|
of those above. If you wish to allow use of your version of this file only
|
|
under the terms of the GPL, and not to allow others to
|
|
use your version of this file under the terms of Apache License version 2,
|
|
indicate your decision by deleting the provisions above and replace them with
|
|
the notice and other provisions required by the GPL. If you do not delete
|
|
the provisions above, a recipient may use your version of this file under
|
|
the terms of any one of the Apache License version 2 or the GPL.
|
|
|
|
***** END LICENSE BLOCK *****
|
|
|
|
* "Instance-identifier" is a subset of XML Xpaths and defined in Yang, used in NACM for example.
|
|
* and defined in RF7950 Sections 9.13 and 14.
|
|
*
|
|
* "api-path" is "URI-encoded path expression" definition in RFC8040 3.5.3
|
|
* BNF:
|
|
* <api-path> := <root> ("/" (<api-identifier> | <list-instance>))*
|
|
* <root> := <string>
|
|
* <api-identifier> := [<module-name> ":"] <identifier>
|
|
* <module-name> := <identifier>
|
|
* <list-instance> := <api-identifier> "=" key-value *("," key-value)
|
|
* <key-value> := <string>
|
|
* <string> := <an unquoted string>
|
|
* <identifier> := (<ALPHA> | "_") (<ALPHA> | <DIGIT> | "_" | "-" | ".")
|
|
*/
|
|
|
|
#ifndef _CLIXON_PATH_H_
|
|
#define _CLIXON_PATH_H_
|
|
|
|
/*
|
|
* Types
|
|
*/
|
|
/* Internal path structure. Somewhat more general than api-path, much less than xpath
|
|
* about the same as yang instance-identifier
|
|
* Not that cp_cvk api-paths do not specifiy key-names, so cp_cvk is just a list of
|
|
* (NULL:value)*, which means that names must be added using api_path_check() based on
|
|
* yang.
|
|
* Other formats (eg xpath) have the names given in the format.
|
|
*/
|
|
typedef struct {
|
|
qelem_t cp_qelem; /* List header */
|
|
char *cp_prefix; /* Prefix or module name, should be resolved + id to cp_yang */
|
|
char *cp_id; /* Identifier */
|
|
cvec *cp_cvk; /* Key values: list of (name:value) pairs alt (NULL:value)
|
|
* Can also be single uint32, if so positional eg x/y[42]
|
|
* This seems kludgy but follows RFC 7950 Sec 9.13
|
|
*/
|
|
yang_stmt *cp_yang; /* Corresponding yang spec (after XML match - ie resolved) */
|
|
} clixon_path;
|
|
|
|
/*
|
|
* Prototypes
|
|
*/
|
|
int xml_yang_root(cxobj *x, cxobj **xr);
|
|
int yang2api_path_fmt(yang_stmt *ys, int inclkey, char **api_path_fmt);
|
|
int api_path_fmt2api_path(char *api_path_fmt, cvec *cvv, char **api_path);
|
|
int api_path_fmt2xpath(char *api_path_fmt, cvec *cvv, char **xpath);
|
|
int api_path2xpath(char *api_path, yang_stmt *yspec, char **xpath, cvec **nsc, cxobj **xerr);
|
|
int api_path2xml(char *api_path, yang_stmt *yspec, cxobj *xtop,
|
|
yang_class nodeclass, int strict,
|
|
cxobj **xpathp, yang_stmt **ypathp, cxobj **xerr);
|
|
int xml2api_path_1(cxobj *x, cbuf *cb);
|
|
#if defined(__GNUC__) && __GNUC__ >= 3
|
|
int clixon_xml_find_api_path(cxobj *xt, yang_stmt *yt, cxobj ***xvec, size_t *xlen, char *format,
|
|
...) __attribute__ ((format (printf, 5, 6)));;
|
|
int clixon_xml_find_instance_id(cxobj *xt, yang_stmt *yt, cxobj ***xvec, size_t *xlen, char *format,
|
|
...) __attribute__ ((format (printf, 5, 6)));;
|
|
#else
|
|
int clixon_xml_find_api_path(cxobj *xt, yang_stmt *yt, clixon_xvec **xvec, char *format, ...);
|
|
int clixon_xml_find_instance_id(cxobj *xt, yang_stmt *yt, clixon_xvec **xvec, char *format, ...);
|
|
#endif
|
|
|
|
#endif /* _CLIXON_PATH_H_ */
|