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

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