blob: 3703ad0015c3a0068341ffac30f4174aba962c0c [file] [log] [blame]
/**
* @file printer_internal.h
* @author Radek Krejci <rkrejci@cesnet.cz>
* @brief Internal structures and functions for libyang
*
* Copyright (c) 2015-2019 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_PRINTER_INTERNAL_H_
#define LY_PRINTER_INTERNAL_H_
#include "printer.h"
#include "printer_schema.h"
#include "printer_data.h"
struct lysp_module;
struct lysp_submodule;
/**
* @brief Printer output structure specifying where the data are printed.
*/
struct ly_out {
LY_OUT_TYPE type; /**< type of the output to select the output method */
union {
int fd; /**< file descriptor for LY_OUT_FD type */
FILE *f; /**< file structure for LY_OUT_FILE, LY_OUT_FDSTREAM and LY_OUT_FILEPATH types */
struct {
FILE *f; /**< file stream from the original file descriptor, variable is mapped to the LY_OUT_FILE's f */
int fd; /**< original file descriptor, which was not used directly because of missing vdprintf() */
} fdstream; /**< structure for LY_OUT_FDSTREAM type, which is LY_OUT_FD when vdprintf() is missing */
struct {
FILE *f; /**< file structure for LY_OUT_FILEPATH, variable is mapped to the LY_OUT_FILE's f */
char *filepath; /**< stored original filepath */
} fpath; /**< filepath structure for LY_OUT_FILEPATH */
struct {
char **buf; /**< storage for the pointer to the memory buffer to store the output */
size_t len; /**< number of used bytes in the buffer */
size_t size; /**< allocated size of the buffer */
} mem; /**< memory buffer information for LY_OUT_MEMORY type */
struct {
ssize_t (*func)(void *arg, const void *buf, size_t count); /**< callback function */
void *arg; /**< optional argument for the callback function */
} clb; /**< printer callback for LY_OUT_CALLBACK type */
} method; /**< type-specific information about the output */
/* LYB only */
char *buffered; /**< additional buffer for holes */
size_t buf_len; /**< number of used bytes in the additional buffer for holes */
size_t buf_size; /**< allocated size of the buffer for holes */
size_t hole_count; /**< hole counter */
size_t printed; /**< Total number of printed bytes */
size_t func_printed; /**< Number of bytes printed by the last function */
};
/**
* @brief Informational structure for YANG statements
*/
struct ext_substmt_info_s {
const char *name; /**< name of the statement */
const char *arg; /**< name of YIN's attribute to present the statement */
uint8_t flags; /**< various flags to clarify printing of the statement */
#define SUBST_FLAG_YIN 0x1 /**< has YIN element */
#define SUBST_FLAG_ID 0x2 /**< the value is identifier -> no quotes */
};
/* filled in printer.c */
extern struct ext_substmt_info_s ext_substmt_info[];
/**
* @brief YANG printer of the parsed module. Full YANG printer.
*
* @param[in] out Output specification.
* @param[in] module Main module.
* @param[in] modp Parsed module to print.
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yang_print_parsed_module(struct ly_out *out, const struct lys_module *module, const struct lysp_module *modp, uint32_t options);
/**
* @brief Helper macros for data printers
*/
#define DO_FORMAT (ctx->options & LYD_PRINT_FORMAT)
#define LEVEL ctx->level /**< current level */
#define INDENT (DO_FORMAT ? (LEVEL)*2 : 0),"" /**< indentation parameters for printer functions */
#define LEVEL_INC LEVEL++ /**< increase indentation level */
#define LEVEL_DEC LEVEL-- /**< decrease indentation level */
/**
* @brief YANG printer of the parsed submodule. Full YANG printer.
*
* @param[in] out Output specification.
* @param[in] module Main module.
* @param[in] submodp Parsed submodule to print.
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yang_print_parsed_submodule(struct ly_out *out, const struct lys_module *module, const struct lysp_submodule *submodp, uint32_t options);
/**
* @brief YANG printer of the compiled schemas.
*
* This printer provides information about modules how they are understood by libyang.
* Despite the format is inspired by YANG, it is not fully compatible and should not be
* used as a standard YANG format.
*
* @param[in] out Output specification.
* @param[in] module Schema to be printed (the compiled member is used).
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yang_print_compiled(struct ly_out *out, const struct lys_module *module, uint32_t options);
/**
* @brief YANG printer of the compiled schema node
*
* This printer provides information about modules how they are understood by libyang.
* Despite the format is inspired by YANG, it is not fully compatible and should not be
* used as a standard YANG format.
*
* @param[in] out Output specification.
* @param[in] node Schema node to be printed including all its substatements.
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yang_print_compiled_node(struct ly_out *out, const struct lysc_node *node, uint32_t options);
/**
* @brief YIN printer of the parsed module. Full YIN printer.
*
* @param[in] out Output specification.
* @param[in] module Main module.
* @param[in] modp Parsed module to print.
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yin_print_parsed_module(struct ly_out *out, const struct lys_module *module, const struct lysp_module *modp, uint32_t options);
/**
* @brief YIN printer of the parsed submodule. Full YIN printer.
*
* @param[in] out Output specification.
* @param[in] module Main module.
* @param[in] submodp Parsed submodule to print.
* @param[in] options Schema output options (see @ref schemaprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR yin_print_parsed_submodule(struct ly_out *out, const struct lys_module *module, const struct lysp_submodule *submodp, uint32_t options);
/**
* @brief XML printer of YANG data.
*
* @param[in] out Output specification.
* @param[in] root The root element of the (sub)tree to print.
* @param[in] options [Data printer flags](@ref dataprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options);
/**
* @brief JSON printer of YANG data.
*
* @param[in] out Output specification.
* @param[in] root The root element of the (sub)tree to print.
* @param[in] options [Data printer flags](@ref dataprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR json_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options);
/**
* @brief LYB printer of YANG data.
*
* @param[in] out Output structure.
* @param[in] root The root element of the (sub)tree to print.
* @param[in] options [Data printer flags](@ref dataprinterflags).
* @return LY_ERR value, number of the printed bytes is updated in lyout::printed.
*/
LY_ERR lyb_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options);
/**
* @brief Check whether a node value equals to its default one.
*
* @param[in] node Term node to test.
* @return 0 if no,
* @return 1 if yes.
*/
uint8_t ly_is_default(const struct lyd_node *node);
/**
* @brief Check whether the node should even be printed.
*
* @param[in] node Node to check.
* @param[in] options Printer options.
* @return 0 if no.
* @return 1 if yes.
*/
uint8_t ly_should_print(const struct lyd_node *node, uint32_t options);
/**
* @brief Generic printer of the given format string into the specified output.
*
* Does not reset printed bytes. Adds to printed bytes.
*
* @param[in] out Output specification.
* @param[in] format Format string to be printed.
* @return LY_ERR value.
*/
LY_ERR ly_print_(struct ly_out *out, const char *format, ...);
/**
* @brief Generic printer of the given string buffer into the specified output.
*
* Does not reset printed bytes. Adds to printed bytes.
*
* @param[in] out Output specification.
* @param[in] buf Memory buffer with the data to print.
* @param[in] len Length of the data to print in the @p buf.
* @return LY_ERR value.
*/
LY_ERR ly_write_(struct ly_out *out, const char *buf, size_t len);
/**
* @brief Create a hole in the output data that will be filled later.
*
* Adds printed bytes.
*
* @param[in] out Output specification.
* @param[in] len Length of the created hole.
* @param[out] position Position of the hole, value must be later provided to the ly_write_skipped() call.
* @return LY_ERR value.
*/
LY_ERR ly_write_skip(struct ly_out *out, size_t len, size_t *position);
/**
* @brief Write data into the hole at given position.
*
* Does not change printed bytes.
*
* @param[in] out Output specification.
* @param[in] position Position of the hole to fill, the value was provided by ly_write_skip().
* @param[in] buf Memory buffer with the data to print.
* @param[in] len Length of the data to print in the @p buf. Not that the length must correspond
* to the len value specified in the corresponding ly_write_skip() call.
* @return LY_ERR value.
*/
LY_ERR ly_write_skipped(struct ly_out *out, size_t position, const char *buf, size_t len);
#endif /* LY_PRINTER_INTERNAL_H_ */