include/babeltrace2/graph/self-component-filter.h

   1 #ifndef BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H
   2 #define BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2017 Philippe Proulx <pproulx@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 bt_self_component_*_status */
  30 #include <babeltrace2/graph/self-component.h>
  31
  32 /*
  33  * For bt_component_filter, bt_self_component, bt_self_component_filter,
  34  * bt_self_component_port_input, bt_self_component_port_output,
  35  * __BT_UPCAST, __BT_UPCAST_CONST
  36  */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 static inline
  44 bt_self_component *bt_self_component_filter_as_self_component(
  45                 bt_self_component_filter *self_comp_filter)
  46 {
  47         return __BT_UPCAST(bt_self_component, self_comp_filter);
  48 }
  49
  50 static inline
  51 const bt_component_filter *
  52 bt_self_component_filter_as_component_filter(
  53                 bt_self_component_filter *self_comp_filter)
  54 {
  55         return __BT_UPCAST_CONST(bt_component_filter, self_comp_filter);
  56 }
  57
  58 extern bt_self_component_port_output *
  59 bt_self_component_filter_borrow_output_port_by_name(
  60                 bt_self_component_filter *self_component,
  61                 const char *name);
  62
  63 extern bt_self_component_port_output *
  64 bt_self_component_filter_borrow_output_port_by_index(
  65                 bt_self_component_filter *self_component,
  66                 uint64_t index);
  67
  68 extern bt_self_component_add_port_status
  69 bt_self_component_filter_add_output_port(
  70                 bt_self_component_filter *self_component,
  71                 const char *name, void *user_data,
  72                 bt_self_component_port_output **self_component_port);
  73
  74 extern bt_self_component_port_input *
  75 bt_self_component_filter_borrow_input_port_by_name(
  76                 bt_self_component_filter *self_component,
  77                 const char *name);
  78
  79 extern bt_self_component_port_input *
  80 bt_self_component_filter_borrow_input_port_by_index(
  81                 bt_self_component_filter *self_component,
  82                 uint64_t index);
  83
  84 extern bt_self_component_add_port_status
  85 bt_self_component_filter_add_input_port(
  86                 bt_self_component_filter *self_component,
  87                 const char *name, void *user_data,
  88                 bt_self_component_port_input **self_component_port);
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #endif /* BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H */