include/babeltrace/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 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdint.h>
  27
  28 /* For enum bt_self_component_status */
  29 #include <babeltrace/graph/self-component.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct bt_component_filter;
  36 struct bt_self_component;
  37 struct bt_self_component_filter;
  38 struct bt_self_component_port_input;
  39 struct bt_self_component_port_output;
  40
  41 static inline
  42 struct bt_self_component *bt_self_component_filter_as_self_component(
  43                 struct bt_self_component_filter *self_comp_filter)
  44 {
  45         return (void *) self_comp_filter;
  46 }
  47
  48 static inline
  49 const struct bt_component_filter *
  50 bt_self_component_filter_as_component_filter(
  51                 struct bt_self_component_filter *self_comp_filter)
  52 {
  53         return (const void *) self_comp_filter;
  54 }
  55
  56 extern struct bt_component_filter *bt_component_filter_borrow_from_self(
  57                 struct bt_self_component_filter *self_component);
  58
  59 extern struct bt_self_component_port_output *
  60 bt_self_component_filter_borrow_output_port_by_name(
  61                 struct bt_self_component_filter *self_component,
  62                 const char *name);
  63
  64 extern struct bt_self_component_port_output *
  65 bt_self_component_filter_borrow_output_port_by_index(
  66                 struct bt_self_component_filter *self_component,
  67                 uint64_t index);
  68
  69 extern enum bt_self_component_status
  70 bt_self_component_filter_add_output_port(
  71                 struct bt_self_component_filter *self_component,
  72                 const char *name, void *data,
  73                 struct bt_self_component_port_output **self_component_port);
  74
  75 extern struct bt_self_component_port_input *
  76 bt_self_component_filter_borrow_input_port_by_name(
  77                 struct bt_self_component_filter *self_component,
  78                 const char *name);
  79
  80 extern struct bt_self_component_port_input *
  81 bt_self_component_filter_borrow_input_port_by_index(
  82                 struct bt_self_component_filter *self_component,
  83                 uint64_t index);
  84
  85 extern enum bt_self_component_status
  86 bt_self_component_filter_add_input_port(
  87                 struct bt_self_component_filter *self_component,
  88                 const char *name, void *data,
  89                 struct bt_self_component_port_input **self_component_port);
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H */