amxp_expression.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** Redistribution and use in source and binary forms, with or without modification,
** are permitted provided that the following conditions are met:
**
** 1. Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
**
** 2. Redistributions in binary form must reproduce the above copyright notice,
** this list of conditions and the following disclaimer in the documentation
** and/or other materials provided with the distribution.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
****************************************************************************/
 
#if !defined(__AMXP_EXPR_H__)
#define __AMXP_EXPR_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct _amxp_expr amxp_expr_t;
 
typedef enum _expr_status {
    amxp_expr_status_ok,                 
    amxp_expr_status_unknown_error,      
    amxp_expr_status_syntax_error,       
    amxp_expr_status_field_not_found,    
    amxp_expr_status_invalid_regexp,     
    amxp_expr_status_invalid_value,      
    amxp_expr_status_function_not_found, 
} amxp_expr_status_t;
 
 
typedef ssize_t (* amxp_expr_reader_t) (amxp_expr_t* expr,
                                        void* buf,
                                        size_t max_size);
 
typedef  amxp_expr_status_t (* amxp_expr_get_field_t) (amxp_expr_t* expr,
                                                       amxc_var_t* value,
                                                       const char* path,
                                                       void* priv);
 
typedef  amxp_expr_status_t (* amxp_expr_value_func_t) (amxp_expr_t* expr,
                                                        amxc_var_t* args,
                                                        amxc_var_t* ret);
 
typedef  bool (* amxp_expr_bool_func_t) (amxp_expr_t* expr,
                                         amxc_var_t* args);
 
typedef struct _amxp_expr_node amxp_expr_node_t;
 
struct _amxp_expr {
    void* scanner;                   
    char* expression;                
    amxc_rbuffer_t rbuffer;          
    bool verify;                     
    amxp_expr_status_t status;       
    amxc_string_t msg;               
    amxp_expr_reader_t reader;       
    amxc_lstack_t nodes;             
    amxp_expr_get_field_t get_field; 
    void* priv;                      
};
 
amxp_expr_status_t amxp_expr_new(amxp_expr_t** expr, const char* expression);
 
amxp_expr_status_t amxp_expr_buildf_new(amxp_expr_t** expr,
                                        const char* expr_fmt,
                                        ...) \
    __attribute__ ((format(printf, 2, 3)));
 
amxp_expr_status_t amxp_expr_vbuildf_new(amxp_expr_t** expr,
                                         const char* expr_fmt,
                                         va_list args);
 
void amxp_expr_delete(amxp_expr_t** expr);
 
amxp_expr_status_t amxp_expr_buildf(amxp_expr_t* expr,
                                    const char* expr_fmt,
                                    ...) \
    __attribute__ ((format(printf, 2, 3)));
 
amxp_expr_status_t amxp_expr_vbuildf(amxp_expr_t* expr,
                                     const char* expr_fmt,
                                     va_list args);
 
amxp_expr_status_t amxp_expr_init(amxp_expr_t* expr, const char* expression);
 
void amxp_expr_clean(amxp_expr_t* expr);
 
void amxp_expr_dump_tree(amxp_expr_t* expr);
 
bool amxp_expr_evaluate(amxp_expr_t* expr,
                        amxp_expr_get_field_t fn,
                        void* priv,
                        amxp_expr_status_t* status);
 
bool amxp_expr_eval(amxp_expr_t* expr, amxp_expr_status_t* status);
 
bool amxp_expr_eval_var(amxp_expr_t* expr,
                        const amxc_var_t* const data,
                        amxp_expr_status_t* status);
 
int amxp_expr_find_var_paths(const amxc_var_t* const var,
                             amxc_llist_t* paths,
                             const char* path);
 
int amxp_expr_find_var_values(const amxc_var_t* const var,
                              amxc_htable_t* values,
                              const char* path);
 
amxc_var_t* amxp_expr_find_var(const amxc_var_t* const var,
                               const char* path);
amxp_expr_status_t amxp_expr_get_field_var(amxp_expr_t* expr,
                                           amxc_var_t* value,
                                           const char* path,
                                           void* priv);
 
bool amxp_expr_eval_set(amxp_expr_t* expr,
                        const amxc_set_t* const data,
                        amxp_expr_status_t* status);
 
amxp_expr_status_t amxp_expr_get_field_set(amxp_expr_t* expr,
                                           amxc_var_t* value,
                                           const char* path,
                                           void* priv);
 
int amxp_expr_add_value_fn(const char* fn_name,
                           amxp_expr_value_func_t fn);
 
int amxp_expr_add_bool_fn(const char* fn_name,
                          amxp_expr_bool_func_t fn);
 
const char* amxp_expr_get_string(amxp_expr_t* expr);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXP_EXPR_H__