amxo.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(__AMXO_H__)
#define __AMXO_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if !defined(USE_DOXYGEN)
#define AMXO_INLINE static inline
#else
#define AMXO_INLINE
#endif
 
#include <amxo/amxo_types.h>
#include <amxo/amxo_resolvers.h>
#include <amxo/amxo_hooks.h>
#include <amxo/amxo_mibs.h>
#include <amxo/amxo_save.h>
#include <amxs/amxs.h>
 
const char* amxo_lib_version(void);
 
int amxo_parser_init(amxo_parser_t* parser);
 
void amxo_parser_clean(amxo_parser_t* parser);
 
int amxo_parser_new(amxo_parser_t** parser);
 
void amxo_parser_delete(amxo_parser_t** parser);
 
int amxo_parser_parse_fd(amxo_parser_t* parser,
                         int fd,
                         amxd_object_t* object);
 
int amxo_parser_parse_file(amxo_parser_t* parser,
                           const char* file_path,
                           amxd_object_t* object);
 
int amxo_parser_parse_string(amxo_parser_t* parser,
                             const char* text,
                             amxd_object_t* object);
 
AMXO_INLINE
amxd_status_t amxo_parser_get_status(amxo_parser_t* parser) {
    return parser == NULL ? amxd_status_ok : parser->status;
}
 
AMXO_INLINE
const char* amxo_parser_get_message(amxo_parser_t* parser) {
    return parser == NULL ? NULL : amxc_string_get(&parser->msg, 0);
}
 
AMXO_INLINE
const char* amxo_parser_get_file(amxo_parser_t* parser) {
    return parser == NULL ? NULL : parser->file;
}
 
AMXO_INLINE
uint32_t amxo_parser_get_line(amxo_parser_t* parser) {
    return parser == NULL ? 0 : parser->line;
}
 
int amxo_parser_add_entry_point(amxo_parser_t* parser,
                                amxo_entry_point_t fn);
 
int amxo_parser_invoke_entry_points(amxo_parser_t* parser,
                                    amxd_dm_t* dm,
                                    int reason);
 
int amxo_parser_rinvoke_entry_points(amxo_parser_t* parser,
                                     amxd_dm_t* dm,
                                     int reason);
 
int amxo_parser_start_synchronize(amxo_parser_t* parser);
 
void amxo_parser_stop_synchronize(amxo_parser_t* parser);
 
amxs_sync_ctx_t* amxo_parser_new_sync_ctx(const char* sync_template,
                                          const char* object_a,
                                          const char* object_b);
amxc_var_t* amxo_parser_get_config(amxo_parser_t* parser,
                                   const char* path);
 
amxc_var_t* amxo_parser_claim_config(amxo_parser_t* parser,
                                     const char* path);
 
int amxo_parser_set_config(amxo_parser_t* parser,
                           const char* path,
                           amxc_var_t* value);
 
int amxo_connection_add(amxo_parser_t* parser,
                        int fd,
                        amxo_fd_cb_t reader,
                        const char* uri,
                        amxo_con_type_t type,
                        void* priv);
 
int amxo_connection_wait_write(amxo_parser_t* parser,
                               int fd,
                               amxo_fd_cb_t writer);
 
int amxo_connection_remove(amxo_parser_t* parser,
                           int fd);
 
amxo_connection_t* amxo_connection_get(amxo_parser_t* parser,
                                       int fd);
 
int amxo_connection_set_el_data(amxo_parser_t* parser,
                                int fd,
                                void* el_data);
 
amxo_connection_t* amxo_connection_get_first(amxo_parser_t* parser,
                                             amxo_con_type_t type);
 
amxo_connection_t* amxo_connection_get_next(amxo_parser_t* parser,
                                            amxo_connection_t* con,
                                            amxo_con_type_t type);
 
amxc_llist_t* amxo_parser_get_connections(amxo_parser_t* parser);
 
amxc_llist_t* amxo_parser_get_listeners(amxo_parser_t* parser);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXO_H__