Fix: headers: make static inline upcasts compatible with C++
[deliverable/babeltrace.git] / include / babeltrace / graph / component-class-filter.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
2#define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
d3e4dcd8
PP
3
4/*
0554db57 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
d3e4dcd8
PP
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
96ffdc46
PP
27#include <stdint.h>
28
b7c5b62e 29/* For bt_self_component_status */
96ffdc46
PP
30#include <babeltrace/graph/self-component.h>
31
b7c5b62e 32/* For bt_self_message_iterator_status */
c14831f0 33#include <babeltrace/graph/self-message-iterator.h>
96ffdc46 34
b7c5b62e 35/* For bt_query_status */
96ffdc46
PP
36#include <babeltrace/graph/component-class.h>
37
3f7f8234
PP
38/* For bt_component_class_status */
39#include <babeltrace/graph/component-class-const.h>
40
b9879703
PP
41/*
42 * For bt_component_class, bt_component_class_filter, bt_port_input,
43 * bt_port_output, bt_query_executor, bt_self_component_class_filter,
44 * bt_self_component_filter, bt_self_component_port_input,
9599065d 45 * bt_self_component_port_output, bt_value, bt_message_array_const,
9f7a7546 46 * bt_bool, bt_self_message_iterator, __BT_UPCAST
b9879703
PP
47 */
48#include <babeltrace/types.h>
49
d3e4dcd8
PP
50#ifdef __cplusplus
51extern "C" {
52#endif
53
b7c5b62e 54typedef bt_self_component_status
96ffdc46 55(*bt_component_class_filter_init_method)(
b9879703
PP
56 bt_self_component_filter *self_component,
57 const bt_value *params, void *init_method_data);
96ffdc46
PP
58
59typedef void (*bt_component_class_filter_finalize_method)(
b9879703 60 bt_self_component_filter *self_component);
96ffdc46 61
b7c5b62e 62typedef bt_self_message_iterator_status
c14831f0
PP
63(*bt_component_class_filter_message_iterator_init_method)(
64 bt_self_message_iterator *message_iterator,
b9879703
PP
65 bt_self_component_filter *self_component,
66 bt_self_component_port_output *port);
96ffdc46
PP
67
68typedef void
c14831f0
PP
69(*bt_component_class_filter_message_iterator_finalize_method)(
70 bt_self_message_iterator *message_iterator);
96ffdc46 71
b7c5b62e 72typedef bt_self_message_iterator_status
c14831f0
PP
73(*bt_component_class_filter_message_iterator_next_method)(
74 bt_self_message_iterator *message_iterator,
75 bt_message_array_const msgs, uint64_t capacity,
96ffdc46
PP
76 uint64_t *count);
77
9599065d
PP
78typedef bt_self_message_iterator_status
79(*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
80 bt_self_message_iterator *message_iterator,
81 int64_t ns_from_origin);
82
83typedef bt_self_message_iterator_status
84(*bt_component_class_filter_message_iterator_seek_beginning_method)(
85 bt_self_message_iterator *message_iterator);
86
87typedef bt_bool
88(*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
89 bt_self_message_iterator *message_iterator,
90 int64_t ns_from_origin);
91
92typedef bt_bool
93(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
94 bt_self_message_iterator *message_iterator);
95
b7c5b62e 96typedef bt_query_status
96ffdc46 97(*bt_component_class_filter_query_method)(
b9879703
PP
98 bt_self_component_class_filter *comp_class,
99 const bt_query_executor *query_executor,
100 const char *object, const bt_value *params,
101 const bt_value **result);
96ffdc46 102
b7c5b62e 103typedef bt_self_component_status
96ffdc46 104(*bt_component_class_filter_accept_input_port_connection_method)(
b9879703
PP
105 bt_self_component_filter *self_component,
106 bt_self_component_port_input *self_port,
107 const bt_port_output *other_port);
96ffdc46 108
b7c5b62e 109typedef bt_self_component_status
96ffdc46 110(*bt_component_class_filter_accept_output_port_connection_method)(
b9879703
PP
111 bt_self_component_filter *self_component,
112 bt_self_component_port_output *self_port,
113 const bt_port_input *other_port);
96ffdc46 114
b7c5b62e 115typedef bt_self_component_status
96ffdc46 116(*bt_component_class_filter_input_port_connected_method)(
b9879703
PP
117 bt_self_component_filter *self_component,
118 bt_self_component_port_input *self_port,
119 const bt_port_output *other_port);
96ffdc46 120
b7c5b62e 121typedef bt_self_component_status
96ffdc46 122(*bt_component_class_filter_output_port_connected_method)(
b9879703
PP
123 bt_self_component_filter *self_component,
124 bt_self_component_port_output *self_port,
125 const bt_port_input *other_port);
96ffdc46 126
d27a81b2 127static inline
b9879703
PP
128bt_component_class *bt_component_class_filter_as_component_class(
129 bt_component_class_filter *comp_cls_filter)
d27a81b2 130{
9f7a7546 131 return __BT_UPCAST(bt_component_class, comp_cls_filter);
d27a81b2 132}
d3eb6e8f 133
96ffdc46 134extern
b9879703 135bt_component_class_filter *bt_component_class_filter_create(
96ffdc46 136 const char *name,
c14831f0 137 bt_component_class_filter_message_iterator_next_method method);
96ffdc46 138
3f7f8234
PP
139extern bt_component_class_status
140bt_component_class_filter_set_init_method(
b9879703 141 bt_component_class_filter *comp_class,
96ffdc46
PP
142 bt_component_class_filter_init_method method);
143
3f7f8234
PP
144extern bt_component_class_status
145bt_component_class_filter_set_finalize_method(
b9879703 146 bt_component_class_filter *comp_class,
96ffdc46
PP
147 bt_component_class_filter_finalize_method method);
148
3f7f8234
PP
149extern bt_component_class_status
150bt_component_class_filter_set_accept_input_port_connection_method(
b9879703 151 bt_component_class_filter *comp_class,
96ffdc46
PP
152 bt_component_class_filter_accept_input_port_connection_method method);
153
3f7f8234
PP
154extern bt_component_class_status
155bt_component_class_filter_set_accept_output_port_connection_method(
b9879703 156 bt_component_class_filter *comp_class,
96ffdc46
PP
157 bt_component_class_filter_accept_output_port_connection_method method);
158
3f7f8234
PP
159extern bt_component_class_status
160bt_component_class_filter_set_input_port_connected_method(
b9879703 161 bt_component_class_filter *comp_class,
96ffdc46
PP
162 bt_component_class_filter_input_port_connected_method method);
163
3f7f8234
PP
164extern bt_component_class_status
165bt_component_class_filter_set_output_port_connected_method(
b9879703 166 bt_component_class_filter *comp_class,
96ffdc46
PP
167 bt_component_class_filter_output_port_connected_method method);
168
3f7f8234
PP
169extern bt_component_class_status
170bt_component_class_filter_set_query_method(
b9879703 171 bt_component_class_filter *comp_class,
96ffdc46
PP
172 bt_component_class_filter_query_method method);
173
3f7f8234
PP
174extern bt_component_class_status
175bt_component_class_filter_set_message_iterator_init_method(
b9879703 176 bt_component_class_filter *comp_class,
c14831f0 177 bt_component_class_filter_message_iterator_init_method method);
96ffdc46 178
3f7f8234
PP
179extern bt_component_class_status
180bt_component_class_filter_set_message_iterator_finalize_method(
b9879703 181 bt_component_class_filter *comp_class,
c14831f0 182 bt_component_class_filter_message_iterator_finalize_method method);
96ffdc46 183
9599065d
PP
184extern bt_component_class_status
185bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
186 bt_component_class_filter *comp_class,
187 bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);
188
189extern bt_component_class_status
190bt_component_class_filter_set_message_iterator_seek_beginning_method(
191 bt_component_class_filter *comp_class,
192 bt_component_class_filter_message_iterator_seek_beginning_method method);
193
194extern bt_bool
195bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
196 bt_component_class_filter *comp_class,
197 bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);
198
199extern bt_bool
200bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
201 bt_component_class_filter *comp_class,
202 bt_component_class_filter_message_iterator_can_seek_beginning_method method);
203
d3eb6e8f
PP
204#ifdef __cplusplus
205}
206#endif
207
90157d89 208#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */
This page took 0.047401 seconds and 5 git commands to generate.