parse.h

Go to the documentation of this file.

#ifndef REDUCT_PARSE_H
#define REDUCT_PARSE_H 1
 
#include <reduct/core.h>
#include <reduct/handle.h>
 
/**
 * @file parse.h
 * @brief Parser.
 * @defgroup parse Parse
 *
 * @{
 */
 
/**
 * @brief Parse a Reduct string.
 *
 * @warning The jump buffer must have been set using `REDUCT_ERROR_CATCH` before calling this function.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param str The Reduct string to parse. The caller is responsible for the memory of this string, it must not be freed
 * for the lifetime of the parsed items.
 * @param len The length of the input string.
 * @param path The path to the file being parsed (for error reporting).
 * @return The root item of the parsed expression, will be retained by the GC.
 */
REDUCT_API reduct_handle_t reduct_parse(reduct_t* reduct, const char* str, size_t len, const char* path);
 
/**
 * @brief Parse a Reduct file.
 *
 * @warning The jump buffer must have been set using `REDUCT_ERROR_CATCH` before calling this function.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param path The path to the file to parse.
 * @return The root item of the parsed expression, will be retained by the GC.
 */
REDUCT_API reduct_handle_t reduct_parse_file(reduct_t* reduct, const char* path);
 
/** @} */
 
#endif