amxc_variant_type.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(__AMXC_VARIANT_TYPE_H__)
#define __AMXC_VARIANT_TYPE_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxc/amxc_htable.h>
#include <amxc/amxc_variant.h>
#include <amxc/amxc_common.h>
 
typedef int (* amxc_var_new_fn_t) (amxc_var_t* const var);
 
typedef void (* amxc_var_free_fn_t) (amxc_var_t* const var);
 
typedef int (* amxc_var_copy_fn_t) (amxc_var_t* const dst,
                                    const amxc_var_t* const src);
 
typedef int (* amxc_var_move_fn_t) (amxc_var_t* const dst,
                                    amxc_var_t* const src);
 
typedef int (* amxc_var_convert_fn_t) (amxc_var_t* const dest,
                                       const amxc_var_t* const src);
 
typedef int (* amxc_var_compare_fn_t) (const amxc_var_t* const var1,
                                       const amxc_var_t* const var2,
                                       int* const result);
 
typedef amxc_var_t*(* amxc_var_get_key_fn_t) (const amxc_var_t* const src,
                                              const char* const key,
                                              int flags);
 
typedef int (* amxc_var_set_key_fn_t) (amxc_var_t* const dest,
                                       amxc_var_t* const src,
                                       const char* const key,
                                       int flags);
 
typedef amxc_var_t*(* amxc_var_get_index_fn_t) (const amxc_var_t* const src,
                                                const int64_t index,
                                                int flags);
 
typedef int (* amxc_var_set_index_fn_t) (amxc_var_t* const dest,
                                         amxc_var_t* const src,
                                         const int64_t index,
                                         int flags);
 
typedef struct _amxc_var_type {
    amxc_var_new_fn_t init;              
    amxc_var_free_fn_t del;              
    amxc_var_copy_fn_t copy;             
    amxc_var_move_fn_t move;             
    amxc_var_convert_fn_t convert_from;  
    amxc_var_convert_fn_t convert_to;    
    amxc_var_compare_fn_t compare;       
    amxc_var_get_key_fn_t get_key;       
    amxc_var_set_key_fn_t set_key;       
    amxc_var_get_index_fn_t get_index;   
    amxc_var_set_index_fn_t set_index;   
    uint32_t type_id;                    
    amxc_htable_it_t hit;                
    const char* name;                    
} amxc_var_type_t;
 
uint32_t amxc_var_register_type(amxc_var_type_t* const type);
 
int amxc_var_unregister_type(amxc_var_type_t* const type);
 
const char* amxc_var_get_type_name_from_id(const uint32_t type_id);
 
uint32_t amxc_var_get_type_id_from_name(const char* const name);
 
amxc_var_type_t* amxc_var_get_type(unsigned int type_id);
 
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_VARIANT_TYPE_H__