amxd_object_hierarchy.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_HIERARCHY_H__)
#define __AMXD_OBJECT_HIERARCHY_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <amxd/amxd_types.h>
 
typedef bool (* amxd_object_filter_fn_t) (amxd_object_t* const object,
                                          int32_t depth,
                                          void* priv);
typedef void (* amxd_object_cb_fn_t) (amxd_object_t* const object,
                                      int32_t depth,
                                      void* priv);
 
typedef int (* amxd_mobject_cb_t) (amxd_object_t* object,
                                   amxd_object_t* mobject,
                                   void* priv);
 
typedef int (* amxd_instance_cb_t) (amxd_object_t* templ,
                                    amxd_object_t* instance,
                                    void* priv);
amxd_status_t amxd_object_add_object(amxd_object_t* const parent,
                                     amxd_object_t* const child);
 
amxd_object_t* amxd_object_get_parent(const amxd_object_t* const object);
 
amxd_object_t* amxd_object_get_root(const amxd_object_t* const object);
 
amxd_dm_t* amxd_object_get_dm(const amxd_object_t* const object);
 
amxd_object_t* amxd_object_get_child(const amxd_object_t* object,
                                     const char* name);
 
amxd_object_t* amxd_object_get_instance(const amxd_object_t* object,
                                        const char* name,
                                        uint32_t index);
 
amxd_object_t* amxd_object_get(const amxd_object_t* object,
                               const char* name);
 
amxd_object_t* amxd_object_findf(amxd_object_t* object,
                                 const char* rel_path,
                                 ...) __attribute__ ((format(printf, 2, 3)));
 
amxd_status_t amxd_object_resolve_pathf(amxd_object_t* object,
                                        amxc_llist_t* paths,
                                        const char* rel_path,
                                        ...)  __attribute__ ((format(printf, 3, 4)));
 
amxd_status_t amxd_object_resolve_pathf_ext(amxd_object_t* object,
                                            bool* key_path,
                                            amxc_llist_t* paths,
                                            const char* rel_path,
                                            ...) __attribute__ ((format(printf, 4, 5)));
 
char* amxd_object_get_path(const amxd_object_t* object, const uint32_t flags);
 
char* amxd_object_get_rel_path(const amxd_object_t* child,
                               const amxd_object_t* parent,
                               const uint32_t flags);
 
bool amxd_object_is_child_of(const amxd_object_t* const child,
                             const amxd_object_t* const parent);
 
void amxd_object_hierarchy_walk(amxd_object_t* const object,
                                const amxd_direction_t direction,
                                amxd_object_filter_fn_t filter,
                                amxd_object_cb_fn_t cb,
                                int32_t depth,
                                void* priv);
 
void amxd_object_for_all(amxd_object_t* object,
                         const char* rel_spath,
                         amxd_mobject_cb_t fn,
                         void* priv);
 
bool amxd_object_is_supported(amxd_object_t* object,
                              const char* rel_path);
static inline
amxc_llist_it_t* amxd_object_first_instance(const amxd_object_t* const object) {
    return object == NULL ? NULL : amxc_llist_get_first(&object->instances);
}
 
static inline
amxc_llist_it_t* amxd_object_first_child(const amxd_object_t* const object) {
    return object == NULL ? NULL : amxc_llist_get_first(&object->objects);
}
 
static inline
uint32_t amxd_object_get_instance_count(const amxd_object_t* object) {
    return object == NULL ? 0 : amxc_llist_size(&object->instances);
}
 
static inline
uint32_t amxd_object_get_child_count(const amxd_object_t* object) {
    return object == NULL ? 0 : amxc_llist_size(&object->objects);
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_OBJECT_HIERARCHY_H__