/*********************************************************************************************************
 *  ------------------------------------------------------------------------------------------------------
 *  file description
 *  ------------------------------------------------------------------------------------------------------
 *         \file  calculate.h
 *         \unit  calculate
 *        \brief  This is a simple math expression calculation module for C language
 *       \author  Lamdonn
 *      \version  v1.1.0
 *      \license  GPL-2.0
 *    \copyright  Copyright (C) 2023 Lamdonn.
 ********************************************************************************************************/
#ifndef __calculate_H
#define __calculate_H

/* Version infomation */
#define CALCULATE_V_MAJOR                   1
#define CALCULATE_V_MINOR                   1
#define CALCULATE_V_PATCH                   0

/* Configuration information */
#define CALCULATE_EXFUNC_MAX                32                      /**< The maximum extern function count supported */
#define CALCULATE_CONSTV_MAX                16                      /**< The maximum const value count supported, include Pi and E */

/**
 *  \brief enter a calculation expression to calculate the result, support 'in_function_table[]' table operation function
 *  \param[in] *expression: expression
 *  \return calculation result or NAN fail
 */
double calculate(const char *expression);

/**
 *  \brief Export external functions
 *  \param[in] *name: function name
 *  \param[in] func: function handle
 *  \param[in] argc: count of arguments
 *  \return 1 success or 0 fail
 */
int calculate_function(const char *name, double (*func)(), int argc);

/**
 *  \brief Export const value
 *  \param[in] *name: function name
 *  \param[in] value: const value
 *  \return 1 success or 0 fail
 */
int calculate_constant(const char *name, double value);

/**
 *  \brief The iteration outputs the currently supported calculateion functions
 *  \param[out] argc: address that output the function argc
 *  \return function name, or NULL iteration end
 */
const char* calculate_ls_func(int *argc);

/**
 *  \brief The iteration outputs the currently supported constant
 *  \param[out] value: address that output the constant
 *  \return constant name, or NULL iteration end
 */
const char* calculate_ls_const(double *value);

#endif