blob: 6e1fc095d8b5e7de00878e3915a2d2e3f17979e9 [file] [log] [blame]
/**
* @file schema_compile_node.h
* @author Radek Krejci <rkrejci@cesnet.cz>
* @brief Header for schema compilation of common nodes.
*
* Copyright (c) 2015 - 2020 CESNET, z.s.p.o.
*
* This source code is licensed under BSD 3-Clause License (the "License").
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*/
#ifndef LY_SCHEMA_COMPILE_NODE_H_
#define LY_SCHEMA_COMPILE_NODE_H_
#include <stddef.h>
#include <stdint.h>
#include "log.h"
#include "tree_data.h"
#include "tree_schema.h"
struct ly_ctx;
struct ly_set;
struct lysc_ctx;
/**
* @brief Get the XPath context node for the given schema node.
* @param[in] start The schema node where the XPath expression appears.
* @return The context node to evaluate XPath expression in given schema node.
* @return NULL in case the context node is the root node.
*/
struct lysc_node *lysc_xpath_context(struct lysc_node *start);
/**
* @brief Compile information from the when statement by either standard compilation or by reusing
* another compiled when structure.
*
* @param[in] ctx Compile context.
* @param[in] when_p Parsed when structure.
* @param[in] flags Flags of the parsed node with the when statement.
* @param[in] ctx_node Context node for the when statement.
* @param[in] node Compiled node to which add the compiled when.
* @param[in,out] when_c Optional, pointer to the previously compiled @p when_p to be reused. Set to NULL
* for the first call.
* @return LY_ERR value.
*/
LY_ERR lys_compile_when(struct lysc_ctx *ctx, struct lysp_when *when_p, uint16_t flags, const struct lysc_node *ctx_node,
struct lysc_node *node, struct lysc_when **when_c);
/**
* @brief Checks pattern syntax.
*
* @param[in] ctx Context.
* @param[in] log_path Path for logging errors.
* @param[in] pattern Pattern to check.
* @param[in,out] pcre2_code Compiled PCRE2 pattern. If NULL, the compiled information used to validate pattern are freed.
* @return LY_ERR value - LY_SUCCESS, LY_EMEM, LY_EVALID.
*/
LY_ERR lys_compile_type_pattern_check(struct ly_ctx *ctx, const char *log_path, const char *pattern, pcre2_code **code);
/**
* @brief Compile information about the leaf/leaf-list's type.
*
* @param[in] ctx Compile context.
* @param[in] context_pnode Schema node where the type/typedef is placed to correctly find the base types.
* @param[in] context_flags Flags of the context node or the referencing typedef to correctly check status of referencing and referenced objects.
* @param[in] context_mod Module of the context node or the referencing typedef to correctly check status of referencing and referenced objects.
* @param[in] context_name Name of the context node or referencing typedef for logging.
* @param[in] type_p Parsed type to compile.
* @param[out] type Newly created (or reused with increased refcount) type structure with the filled information about the type.
* @param[out] units Storage for inheriting units value from the typedefs the current type derives from.
* @param[out] dflt Default value for the type.
* @return LY_ERR value.
*/
LY_ERR lys_compile_type(struct lysc_ctx *ctx, struct lysp_node *context_pnode, uint16_t context_flags,
struct lysp_module *context_mod, const char *context_name, struct lysp_type *type_p,
struct lysc_type **type, const char **units, struct lysp_qname **dflt);
/**
* @brief Compile parsed RPC/action schema node information.
*
* @param[in] ctx Compile context
* @param[in] action_p Parsed RPC/action schema node.
* @param[in] parent Parent node of the action, NULL in case of RPC (top-level action)
* @param[in,out] action Prepared (empty) compiled action structure to fill.
* @param[in] uses_status If the RPC/action is being placed instead of uses, here we have the uses's status value (as node's flags).
* Zero means no uses, non-zero value with no status bit set mean the default status.
* @return LY_SUCCESS on success,
* @return LY_EVALID on validation error,
* @return LY_EDENIED on not-supported deviation.
*/
LY_ERR lys_compile_action(struct lysc_ctx *ctx, struct lysp_action *action_p, struct lysc_node *parent,
struct lysc_action *action, uint16_t uses_status);
/**
* @brief Compile parsed Notification schema node information.
*
* @param[in] ctx Compile context
* @param[in] notif_p Parsed Notification schema node.
* @param[in] parent Parent node of the Notification, NULL in case of top-level Notification
* @param[in,out] notif Prepared (empty) compiled notification structure to fill.
* @param[in] uses_status If the Notification is being placed instead of uses, here we have the uses's status value (as node's flags).
* Zero means no uses, non-zero value with no status bit set mean the default status.
* @return LY_SUCCESS on success,
* @return LY_EVALID on validation error,
* @return LY_EDENIED on not-supported deviation.
*/
LY_ERR lys_compile_notif(struct lysc_ctx *ctx, struct lysp_notif *notif_p, struct lysc_node *parent,
struct lysc_notif *notif, uint16_t uses_status);
/**
* @brief Find the node according to the given descendant/absolute schema nodeid.
* Used in unique, refine and augment statements.
*
* @param[in] ctx Compile context
* @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
* @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
* @param[in] ctx_node Context node for a relative nodeid.
* @param[in] cur_mod Current module for the nodeid (where it was "instantiated").
* @param[in] format Format of any prefixes.
* @param[in] prefix_data Format-specific prefix data (see ::ly_resolve_prefix).
* @param[in] nodetype Optional (can be 0) restriction for target's nodetype. If target exists, but does not match
* the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
* The value can be even an ORed value to allow multiple nodetypes.
* @param[out] target Found target node if any.
* @param[out] result_flag Output parameter to announce if the schema nodeid goes through the action's input/output or a Notification.
* The LYSC_OPT_RPC_INPUT, LYSC_OPT_RPC_OUTPUT and LYSC_OPT_NOTIFICATION are used as flags.
* @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
*/
LY_ERR lysc_resolve_schema_nodeid(struct lysc_ctx *ctx, const char *nodeid, size_t nodeid_len,
const struct lysc_node *ctx_node, const struct lys_module *cur_mod, LY_PREFIX_FORMAT format, void *prefix_data,
uint16_t nodetype, const struct lysc_node **target, uint16_t *result_flag);
/**
* @brief Compile choice children.
*
* @param[in] ctx Compile context
* @param[in] child_p Parsed choice children nodes.
* @param[in] node Compiled choice node to compile and add children to.
* @return LY_ERR value - LY_SUCCESS or LY_EVALID.
*/
LY_ERR lys_compile_node_choice_child(struct lysc_ctx *ctx, struct lysp_node *child_p, struct lysc_node *node,
struct ly_set *child_set);
/**
* @brief Set LYS_MAND_TRUE flag for the non-presence container parents.
*
* A non-presence container is mandatory in case it has at least one mandatory children. This function propagate
* the flag to such parents from a mandatory children.
*
* @param[in] parent A schema node to be examined if the mandatory child make it also mandatory.
* @param[in] add Flag to distinguish adding the mandatory flag (new mandatory children appeared) or removing the flag
* (mandatory children was removed).
*/
void lys_compile_mandatory_parents(struct lysc_node *parent, ly_bool add);
/**
* @brief Validate grouping that was defined but not used in the schema itself.
*
* The grouping does not need to be compiled (and it is compiled here, but the result is forgotten immediately),
* but to have the complete result of the schema validity, even such groupings are supposed to be checked.
*
* @param[in] ctx Compile context.
* @param[in] pnode Parsed parent node of the grouping, NULL for top-level.
* @param[in] grp Parsed grouping node to check.
* @return LY_ERR value.
*/
LY_ERR lys_compile_grouping(struct lysc_ctx *ctx, struct lysp_node *pnode, struct lysp_grp *grp);
/**
* @brief Compile parsed schema node information.
*
* @param[in] ctx Compile context
* @param[in] pnode Parsed schema node.
* @param[in] parent Compiled parent node where the current node is supposed to be connected. It is
* NULL for top-level nodes, in such a case the module where the node will be connected is taken from
* the compile context.
* @param[in] uses_status If the node is being placed instead of uses, here we have the uses's status value (as node's flags).
* Zero means no uses, non-zero value with no status bit set mean the default status.
* @param[in,out] child_set Optional set to add all the compiled nodes into (can be more in case of uses).
* @return LY_ERR value - LY_SUCCESS or LY_EVALID.
*/
LY_ERR lys_compile_node(struct lysc_ctx *ctx, struct lysp_node *pnode, struct lysc_node *parent, uint16_t uses_status,
struct ly_set *child_set);
#endif /* LY_SCHEMA_COMPILE_NODE_H_ */