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