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

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_FILTER_CONST_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_FILTER_CONST_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 #ifndef __BT_IN_BABELTRACE_H
  28 # error "Please include <babeltrace2/babeltrace.h> instead."
  29 #endif
  30
  31 #include <stdint.h>
  32
  33 /*
  34  * For bt_component, bt_component_filter, bt_port_input, bt_port_output,
  35  * __BT_UPCAST_CONST, bt_component_class_filter
  36  */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 static inline
  44 const bt_component *bt_component_filter_as_component_const(
  45                 const bt_component_filter *component)
  46 {
  47         return __BT_UPCAST_CONST(bt_component, component);
  48 }
  49
  50 extern const bt_component_class_filter *
  51 bt_component_filter_borrow_class_const(
  52                 const bt_component_filter *component);
  53
  54 extern uint64_t bt_component_filter_get_input_port_count(
  55                 const bt_component_filter *component);
  56
  57 extern const bt_port_input *
  58 bt_component_filter_borrow_input_port_by_name_const(
  59                 const bt_component_filter *component, const char *name);
  60
  61 extern const bt_port_input *
  62 bt_component_filter_borrow_input_port_by_index_const(
  63                 const bt_component_filter *component, uint64_t index);
  64
  65 extern uint64_t bt_component_filter_get_output_port_count(
  66                 const bt_component_filter *component);
  67
  68 extern const bt_port_output *
  69 bt_component_filter_borrow_output_port_by_name_const(
  70                 const bt_component_filter *component, const char *name);
  71
  72 extern const bt_port_output *
  73 bt_component_filter_borrow_output_port_by_index_const(
  74                 const bt_component_filter *component, uint64_t index);
  75
  76 extern void bt_component_filter_get_ref(
  77                 const bt_component_filter *component_filter);
  78
  79 extern void bt_component_filter_put_ref(
  80                 const bt_component_filter *component_filter);
  81
  82 #define BT_COMPONENT_FILTER_PUT_REF_AND_RESET(_var)             \
  83         do {                                                    \
  84                 bt_component_filter_put_ref(_var);              \
  85                 (_var) = NULL;                                  \
  86         } while (0)
  87
  88 #define BT_COMPONENT_FILTER_MOVE_REF(_var_dst, _var_src)        \
  89         do {                                                    \
  90                 bt_component_filter_put_ref(_var_dst);          \
  91                 (_var_dst) = (_var_src);                        \
  92                 (_var_src) = NULL;                              \
  93         } while (0)
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* BABELTRACE2_GRAPH_COMPONENT_FILTER_CONST_H */