include/babeltrace/graph/component-class-filter.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   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
  27 #include <stdint.h>
  28
  29 /* For enum bt_notification_array_const */
  30 #include <babeltrace/graph/notification-const.h>
  31
  32 /* For enum bt_self_component_status */
  33 #include <babeltrace/graph/self-component.h>
  34
  35 /* For enum bt_self_notification_iterator_status */
  36 #include <babeltrace/graph/self-notification-iterator.h>
  37
  38 /* For enum bt_query_status */
  39 #include <babeltrace/graph/component-class.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 struct bt_component_class;
  46 struct bt_component_class_filter;
  47 struct bt_port_input;
  48 struct bt_port_output;
  49 struct bt_query_executor;
  50 struct bt_self_component_class_filter;
  51 struct bt_self_component_filter;
  52 struct bt_self_component_port_input;
  53 struct bt_self_component_port_output;
  54 struct bt_value;
  55
  56 typedef enum bt_self_component_status
  57 (*bt_component_class_filter_init_method)(
  58                 struct bt_self_component_filter *self_component,
  59                 const struct bt_value *params, void *init_method_data);
  60
  61 typedef void (*bt_component_class_filter_finalize_method)(
  62                 struct bt_self_component_filter *self_component);
  63
  64 typedef enum bt_self_notification_iterator_status
  65 (*bt_component_class_filter_notification_iterator_init_method)(
  66                 struct bt_self_notification_iterator *notification_iterator,
  67                 struct bt_self_component_filter *self_component,
  68                 struct bt_self_component_port_output *port);
  69
  70 typedef void
  71 (*bt_component_class_filter_notification_iterator_finalize_method)(
  72                 struct bt_self_notification_iterator *notification_iterator);
  73
  74 typedef enum bt_self_notification_iterator_status
  75 (*bt_component_class_filter_notification_iterator_next_method)(
  76                 struct bt_self_notification_iterator *notification_iterator,
  77                 bt_notification_array_const notifs, uint64_t capacity,
  78                 uint64_t *count);
  79
  80 typedef enum bt_query_status
  81 (*bt_component_class_filter_query_method)(
  82                 struct bt_self_component_class_filter *comp_class,
  83                 const struct bt_query_executor *query_executor,
  84                 const char *object, const struct bt_value *params,
  85                 const struct bt_value **result);
  86
  87 typedef enum bt_self_component_status
  88 (*bt_component_class_filter_accept_input_port_connection_method)(
  89                 struct bt_self_component_filter *self_component,
  90                 struct bt_self_component_port_input *self_port,
  91                 const struct bt_port_output *other_port);
  92
  93 typedef enum bt_self_component_status
  94 (*bt_component_class_filter_accept_output_port_connection_method)(
  95                 struct bt_self_component_filter *self_component,
  96                 struct bt_self_component_port_output *self_port,
  97                 const struct bt_port_input *other_port);
  98
  99 typedef enum bt_self_component_status
 100 (*bt_component_class_filter_input_port_connected_method)(
 101                 struct bt_self_component_filter *self_component,
 102                 struct bt_self_component_port_input *self_port,
 103                 const struct bt_port_output *other_port);
 104
 105 typedef enum bt_self_component_status
 106 (*bt_component_class_filter_output_port_connected_method)(
 107                 struct bt_self_component_filter *self_component,
 108                 struct bt_self_component_port_output *self_port,
 109                 const struct bt_port_input *other_port);
 110
 111 typedef void
 112 (*bt_component_class_filter_input_port_disconnected_method)(
 113                 struct bt_self_component_filter *self_component,
 114                 struct bt_self_component_port_input *self_port);
 115
 116 typedef void
 117 (*bt_component_class_filter_output_port_disconnected_method)(
 118                 struct bt_self_component_filter *self_component,
 119                 struct bt_self_component_port_output *self_port);
 120
 121 static inline
 122 struct bt_component_class *bt_component_class_filter_as_component_class(
 123                 struct bt_component_class_filter *comp_cls_filter)
 124 {
 125         return (void *) comp_cls_filter;
 126 }
 127
 128 extern
 129 struct bt_component_class_filter *bt_component_class_filter_create(
 130                 const char *name,
 131                 bt_component_class_filter_notification_iterator_next_method method);
 132
 133 extern int bt_component_class_filter_set_init_method(
 134                 struct bt_component_class_filter *comp_class,
 135                 bt_component_class_filter_init_method method);
 136
 137 extern int bt_component_class_filter_set_finalize_method(
 138                 struct bt_component_class_filter *comp_class,
 139                 bt_component_class_filter_finalize_method method);
 140
 141 extern int bt_component_class_filter_set_accept_input_port_connection_method(
 142                 struct bt_component_class_filter *comp_class,
 143                 bt_component_class_filter_accept_input_port_connection_method method);
 144
 145 extern int bt_component_class_filter_set_accept_output_port_connection_method(
 146                 struct bt_component_class_filter *comp_class,
 147                 bt_component_class_filter_accept_output_port_connection_method method);
 148
 149 extern int bt_component_class_filter_set_input_port_connected_method(
 150                 struct bt_component_class_filter *comp_class,
 151                 bt_component_class_filter_input_port_connected_method method);
 152
 153 extern int bt_component_class_filter_set_output_port_connected_method(
 154                 struct bt_component_class_filter *comp_class,
 155                 bt_component_class_filter_output_port_connected_method method);
 156
 157 extern int bt_component_class_filter_set_input_port_disconnected_method(
 158                 struct bt_component_class_filter *comp_class,
 159                 bt_component_class_filter_input_port_disconnected_method method);
 160
 161 extern int bt_component_class_filter_set_output_port_disconnected_method(
 162                 struct bt_component_class_filter *comp_class,
 163                 bt_component_class_filter_output_port_disconnected_method method);
 164
 165 extern int bt_component_class_filter_set_query_method(
 166                 struct bt_component_class_filter *comp_class,
 167                 bt_component_class_filter_query_method method);
 168
 169 extern int bt_component_class_filter_set_notification_iterator_init_method(
 170                 struct bt_component_class_filter *comp_class,
 171                 bt_component_class_filter_notification_iterator_init_method method);
 172
 173 extern int bt_component_class_filter_set_notification_iterator_finalize_method(
 174                 struct bt_component_class_filter *comp_class,
 175                 bt_component_class_filter_notification_iterator_finalize_method method);
 176
 177 #ifdef __cplusplus
 178 }
 179 #endif
 180
 181 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */