amxd_path.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_PATH_H__)
#define __AMXD_PATH_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
amxd_status_t amxd_path_init(amxd_path_t* path,
                             const char* object_path);
 
void amxd_path_clean(amxd_path_t* path);
 
amxd_status_t amxd_path_new(amxd_path_t** path,
                            const char* object_path);
 
void amxd_path_delete(amxd_path_t** path);
 
void amxd_path_reset(amxd_path_t* path);
 
amxd_status_t amxd_path_vsetf(amxd_path_t* path,
                              bool add_dot,
                              const char* obj_path,
                              va_list args);
 
amxd_status_t amxd_path_setf(amxd_path_t* path,
                             bool add_dot,
                             const char* obj_path, ...) \
    __attribute__ ((format(printf, 3, 4)));
 
amxd_status_t amxd_path_append(amxd_path_t* path, const char* extension, bool add_dot);
 
amxd_status_t amxd_path_prepend(amxd_path_t* path, const char* extension);
 
const char* amxd_path_get(amxd_path_t* path, int flags);
 
const char* amxd_path_get_param(amxd_path_t* path);
 
char* amxd_path_get_first(amxd_path_t* path, bool remove);
 
char* amxd_path_get_last(amxd_path_t* path, bool remove);
 
char* amxd_path_get_fixed_part(amxd_path_t* path, bool remove);
 
char* amxd_path_get_supported_path(amxd_path_t* path);
 
char* amxd_path_get_reference_part(amxd_path_t* path, bool remove);
 
uint32_t amxd_path_get_reference_index(amxd_path_t* path);
 
char* amxd_path_build_supported_path(amxd_path_t* path);
 
uint32_t amxd_path_get_depth(const amxd_path_t* const path);
 
static inline
amxd_path_type_t amxd_path_get_type(amxd_path_t* path) {
    return path == NULL ? amxd_path_invalid : path->type;
}
 
static inline
bool amxd_path_is_valid(amxd_path_t* path) {
    return path == NULL ? false : (path->type != amxd_path_invalid);
}
 
static inline
bool amxd_path_is_search_path(amxd_path_t* path) {
    return path == NULL ? false : (path->type == amxd_path_search);
}
 
static inline
bool amxd_path_is_supported_path(amxd_path_t* path) {
    return path == NULL ? false : (path->type == amxd_path_supported);
}
 
static inline
bool amxd_path_is_object_path(amxd_path_t* path) {
    return path == NULL ? false : (path->type == amxd_path_object);
}
 
bool amxd_path_is_instance_path(const amxd_path_t* const path);
 
char* amxd_path_get_param_path(amxd_path_t* path);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_PATH_H__