amxd_function.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(__AMXD_FUNCTION_H__)
#define __AMXD_FUNCTION_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <amxd/amxd_types.h>
 
 
typedef void (* amxd_deferred_cancel_t) (uint64_t call_id, void* const priv);
 
amxd_status_t amxd_function_new(amxd_function_t** func,
                                const char* name,
                                const uint32_t ret_type,
                                amxd_object_fn_t impl);
 
void amxd_function_delete(amxd_function_t** func);
 
amxd_status_t amxd_function_copy(amxd_function_t** dest,
                                 const amxd_function_t* const source);
 
amxd_object_t* amxd_function_get_owner(const amxd_function_t* const func);
 
 
amxd_function_t* amxd_function_get_base(const amxd_function_t* const func);
 
amxd_status_t amxd_function_call_base(const amxd_function_t* const func,
                                      amxd_object_t* const object,
                                      amxc_var_t* const args,
                                      amxc_var_t* const ret);
 
const char* amxd_function_get_name(const amxd_function_t* const func);
 
static inline
uint32_t amxd_function_get_type(const amxd_function_t* const func) {
    return func == NULL ? AMXC_VAR_ID_NULL : func->ret_type;
}
 
amxd_status_t amxd_function_set_attr(amxd_function_t* func,
                                     const amxd_fattr_id_t attr,
                                     const bool enable);
 
amxd_status_t amxd_function_set_attrs(amxd_function_t* func,
                                      const uint32_t bitmask,
                                      bool enable);
 
uint32_t amxd_function_get_attrs(const amxd_function_t* const func);
 
bool amxd_function_is_attr_set(const amxd_function_t* const func,
                               const amxd_fattr_id_t attr);
 
void amxd_function_set_flag(amxd_function_t* func, const char* flag);
 
void amxd_function_unset_flag(amxd_function_t* func, const char* flag);
 
bool amxd_function_has_flag(const amxd_function_t* const func, const char* flag);
 
amxd_status_t amxd_function_set_impl(amxd_function_t* const func,
                                     amxd_object_fn_t impl);
 
amxd_status_t amxd_function_describe(amxd_function_t* const func,
                                     amxc_var_t* const value);
 
amxd_status_t amxd_function_defer(const amxd_function_t* const func,
                                  uint64_t* call_id,
                                  amxc_var_t* const ret,
                                  amxd_deferred_cancel_t cancel_fn,
                                  void* priv);
 
void amxd_function_deferred_remove(uint64_t call_id);
 
void* amxd_function_deferred_get_priv(uint64_t call_id);
 
amxd_status_t amxd_function_set_deferred_cb(uint64_t call_id,
                                            amxp_deferred_fn_t cb,
                                            void* priv);
 
amxd_status_t amxd_function_deferred_done(uint64_t call_id,
                                          amxd_status_t status,
                                          amxc_var_t* out_args,
                                          amxc_var_t* ret);
 
amxd_status_t amxd_function_deferred_call_done(uint64_t call_id,
                                               amxd_status_t status,
                                               amxc_var_t* out_args,
                                               amxc_var_t* ret);
amxd_status_t amxd_function_new_arg(amxd_function_t* func,
                                    const char* name,
                                    const uint32_t type,
                                    amxc_var_t* default_value);
 
void amxd_function_del_arg(amxd_function_t* func, const char* name);
 
amxd_func_arg_t* amxd_function_get_arg(const amxd_function_t* const func,
                                       const char* name);
 
amxd_status_t amxd_function_arg_set_attr(amxd_function_t* const func,
                                         const char* name,
                                         const amxd_aattr_id_t attr,
                                         const bool enable);
 
amxd_status_t amxd_function_arg_set_attrs(amxd_function_t* func,
                                          const char* name,
                                          const uint32_t bitmask,
                                          bool enable);
 
bool amxd_function_arg_is_attr_set(const amxd_function_t* const func,
                                   const char* name,
                                   const amxd_aattr_id_t attr);
 
amxd_status_t amxd_function_arg_describe(amxd_func_arg_t* const arg,
                                         amxc_var_t* const value);
 
bool amxd_function_are_args_valid(amxd_function_t* func,
                                  amxc_var_t* args);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_FUNCTION_H__