libamxo  4.3.4
Object Definition Language (ODL) parsing
amxo_parser_hooks_priv.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 
55 #if !defined(__AMXO_PARSER_HOOKS_PRIV_H__)
56 #define __AMXO_PARSER_HOOKS_PRIV_H__
57 
58 #ifdef __cplusplus
59 extern "C"
60 {
61 #endif
62 
63 PRIVATE
65  char* comment,
66  uint32_t len);
67 
68 PRIVATE
69 void amxo_hooks_start(amxo_parser_t* parser);
70 
71 PRIVATE
72 void amxo_hooks_end(amxo_parser_t* parser);
73 
74 PRIVATE
76  const char* file);
77 
78 PRIVATE
80  const char* file);
81 
82 PRIVATE
84  int section_id);
85 
86 PRIVATE
88  int section_id);
89 
90 PRIVATE
92  const char* name,
93  amxc_var_t* value);
94 
95 PRIVATE
97  const char* name,
98  int64_t attr_bitmask,
99  amxd_object_type_t type);
100 
101 PRIVATE
103  uint32_t index,
104  const char* name);
105 
106 PRIVATE
108  const char* path);
109 
110 PRIVATE
112 
113 PRIVATE
115  const char* name,
116  int64_t attr_bitmask,
117  uint32_t type);
118 
119 PRIVATE
120 void amxo_hooks_set_param(amxo_parser_t* parser, amxc_var_t* value);
121 
122 PRIVATE
123 void amxo_hooks_end_param(amxo_parser_t* parser);
124 
125 PRIVATE
127  const char* name,
128  int64_t attr_bitmask,
129  uint32_t type);
130 
131 PRIVATE
132 void amxo_hooks_end_func(amxo_parser_t* parser);
133 
134 PRIVATE
136  const char* name,
137  int64_t attr_bitmask,
138  uint32_t type,
139  amxc_var_t* def_value);
140 
141 PRIVATE
142 void amxo_hooks_add_mib(amxo_parser_t* parser,
143  const char* mib);
144 
145 PRIVATE
147  const char* param_name);
148 
149 PRIVATE
151  amxd_object_t* object,
152  amxd_param_t* param,
153  amxd_action_t action_id,
154  const char* action_name,
155  const amxc_var_t* data);
156 
157 #ifdef __cplusplus
158 }
159 #endif
160 
161 #endif // __AMXO_PARSER_PRIV_H__
PRIVATE void amxo_hooks_add_mib(amxo_parser_t *parser, const char *mib)
PRIVATE void amxo_hooks_add_func(amxo_parser_t *parser, const char *name, int64_t attr_bitmask, uint32_t type)
PRIVATE void amxo_hooks_start(amxo_parser_t *parser)
PRIVATE void amxo_hooks_add_param(amxo_parser_t *parser, const char *name, int64_t attr_bitmask, uint32_t type)
PRIVATE void amxo_hooks_set_param(amxo_parser_t *parser, amxc_var_t *value)
PRIVATE void amxo_hooks_set_counter(amxo_parser_t *parser, const char *param_name)
PRIVATE void amxo_hooks_select_object(amxo_parser_t *parser, const char *path)
PRIVATE void amxo_hooks_add_func_arg(amxo_parser_t *parser, const char *name, int64_t attr_bitmask, uint32_t type, amxc_var_t *def_value)
PRIVATE void amxo_hooks_end_section(amxo_parser_t *parser, int section_id)
PRIVATE void amxo_hooks_create_object(amxo_parser_t *parser, const char *name, int64_t attr_bitmask, amxd_object_type_t type)
PRIVATE void amxo_hooks_start_section(amxo_parser_t *parser, int section_id)
PRIVATE void amxo_hooks_set_config(amxo_parser_t *parser, const char *name, amxc_var_t *value)
PRIVATE void amxo_hooks_end_param(amxo_parser_t *parser)
PRIVATE void amxo_hooks_add_instance(amxo_parser_t *parser, uint32_t index, const char *name)
PRIVATE void amxo_hooks_end_include(amxo_parser_t *parser, const char *file)
PRIVATE void amxo_hooks_end(amxo_parser_t *parser)
PRIVATE void amxo_hooks_end_func(amxo_parser_t *parser)
PRIVATE void amxo_hooks_comment(amxo_parser_t *parser, char *comment, uint32_t len)
PRIVATE void amxo_hooks_set_action_cb(amxo_parser_t *parser, amxd_object_t *object, amxd_param_t *param, amxd_action_t action_id, const char *action_name, const amxc_var_t *data)
PRIVATE void amxo_hooks_start_include(amxo_parser_t *parser, const char *file)
PRIVATE void amxo_hooks_end_object(amxo_parser_t *parser)
The ODL parser structure.
Definition: amxo_types.h:245