amxd_object.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_OBJECT_H__)
#define __AMXD_OBJECT_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <amxd/amxd_types.h>
#include <amxd/amxd_common.h>
#include <amxd/amxd_object_hierarchy.h>
#include <amxd/amxd_object_function.h>
#include <amxd/amxd_object_parameter.h>
#include <amxd/amxd_object_action.h>
 
#define amxd_object_for_each(type, it, object) \
    for(amxc_llist_it_t* it = amxd_object_first_ ## type(object), \
        * _next = amxc_llist_it_get_next(it); \
        it; \
        it = _next, \
        _next = amxc_llist_it_get_next(it))
 
 
#define amxd_object_iterate(type, it, object) \
    for(amxc_llist_it_t* it = amxd_object_first_ ## type(object); \
        it; \
        it = amxc_llist_it_get_next(it))
 
#define AMXD_OBJECT_NAMED           0x00
 
#define AMXD_OBJECT_INDEXED         0x01
 
#define AMXD_OBJECT_EXTENDED        0x02
 
#define AMXD_OBJECT_REGEXP          0x04
 
#define AMXD_OBJECT_TERMINATE       0x08
 
#define AMXD_OBJECT_SUPPORTED       0x10
 
#define AMXD_OBJECT_AUTO_PATH       0x20
 
#define AMXD_OBJECT_PARAM            0x01
 
#define AMXD_OBJECT_FUNC             0x02
 
#define AMXD_OBJECT_CHILD            0x04
 
#define AMXD_OBJECT_INSTANCE         0x08
 
#define AMXD_OBJECT_NO_BASE          0x10
 
#define AMXD_TEMPLATE_INFO           0x20
 
#define AMXD_OBJECT_KEY_PARAM        0x40
 
#define AMXD_OBJECT_EVENT            0x80
 
#define AMXD_OBJECT_ALL \
    AMXD_OBJECT_PARAM | \
    AMXD_OBJECT_FUNC | \
    AMXD_OBJECT_CHILD | \
    AMXD_OBJECT_INSTANCE
 
amxd_status_t amxd_object_new(amxd_object_t** object,
                              const amxd_object_type_t type,
                              const char* name);
 
void amxd_object_free(amxd_object_t** object);
 
amxd_status_t amxd_object_new_instance(amxd_object_t** object,
                                       amxd_object_t* templ,
                                       const char* name,
                                       uint32_t index,
                                       amxc_var_t* values);
 
amxd_status_t amxd_object_add_instance(amxd_object_t** object,
                                       amxd_object_t* templ,
                                       const char* name,
                                       uint32_t index,
                                       amxc_var_t* values);
 
void amxd_object_delete(amxd_object_t** object);
 
const char* amxd_object_get_name(const amxd_object_t* const object,
                                 const uint32_t flags);
 
uint32_t amxd_object_get_index(const amxd_object_t* const object);
 
static inline
amxd_object_type_t amxd_object_get_type(const amxd_object_t* const object) {
    return object == NULL ? amxd_object_invalid : object->type;
}
 
amxd_status_t amxd_object_set_attr(amxd_object_t* const object,
                                   const amxd_oattr_id_t attr,
                                   const bool enable);
 
 
amxd_status_t amxd_object_set_attrs(amxd_object_t* const object,
                                    const uint32_t bitmask,
                                    bool enable);
 
uint32_t amxd_object_get_attrs(const amxd_object_t* const object);
 
bool amxd_object_is_attr_set(const amxd_object_t* const object,
                             const amxd_oattr_id_t attr);
 
char* amxd_object_get_mibs(amxd_object_t* object);
 
bool amxd_object_has_mib(amxd_object_t* object,
                         const char* mib_name);
 
amxd_status_t amxd_object_add_mib(amxd_object_t* const object,
                                  const char* mib_name);
 
amxd_status_t amxd_object_remove_mib(amxd_object_t* const object,
                                     const char* mib_name);
 
amxd_status_t amxd_object_validate(amxd_object_t* const object,
                                   int32_t depth);
 
amxd_status_t amxd_object_set_counter(amxd_object_t* const object,
                                      const char* name);
 
amxd_status_t amxd_object_set_max_instances(amxd_object_t* object,
                                            uint32_t max);
 
amxd_status_t amxd_object_list(amxd_object_t* const object,
                               amxc_var_t* const list,
                               uint32_t flags,
                               amxd_dm_access_t access);
 
amxd_status_t amxd_object_describe(amxd_object_t* const object,
                                   amxc_var_t* const value,
                                   uint32_t flags,
                                   amxd_dm_access_t access);
 
amxd_object_t* amxd_object_get_base(const amxd_object_t* const object);
 
static inline
amxc_llist_it_t* amxd_object_first_function(const amxd_object_t* const object) {
    return object == NULL ? NULL : amxc_llist_get_first(&object->functions);
}
 
static inline
amxc_llist_it_t* amxd_object_first_parameter(const amxd_object_t* const object) {
    return object == NULL ? NULL : amxc_llist_get_first(&object->parameters);
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_OBJECT_H__