include/babeltrace/graph/component-const.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2015 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 /* For bt_component_class_type */
  28 #include <babeltrace/graph/component-class-const.h>
  29
  30 /*
  31  * For bt_bool, bt_component_class, bt_component_graph, bt_component,
  32  * bt_value, bt_port
  33  */
  34 #include <babeltrace/types.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /**
  41  * Get component's name.
  42  *
  43  * @param component     Component instance of which to get the name
  44  * @returns             Returns a pointer to the component's name
  45  */
  46 extern const char *bt_component_get_name(const bt_component *component);
  47
  48 /**
  49  * Get component's class.
  50  *
  51  * @param component     Component instance of which to get the class
  52  * @returns             The component's class
  53  */
  54 extern const bt_component_class *bt_component_borrow_class_const(
  55                 const bt_component *component);
  56
  57 extern bt_component_class_type bt_component_get_class_type(
  58                 const bt_component *component);
  59
  60 static inline
  61 bt_bool bt_component_is_source(const bt_component *component)
  62 {
  63         return bt_component_get_class_type(component) ==
  64                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  65 }
  66
  67 static inline
  68 bt_bool bt_component_is_filter(const bt_component *component)
  69 {
  70         return bt_component_get_class_type(component) ==
  71                 BT_COMPONENT_CLASS_TYPE_FILTER;
  72 }
  73
  74 static inline
  75 bt_bool bt_component_is_sink(const bt_component *component)
  76 {
  77         return bt_component_get_class_type(component) ==
  78                 BT_COMPONENT_CLASS_TYPE_SINK;
  79 }
  80
  81 extern bt_bool bt_component_graph_is_canceled(
  82                 const bt_component *component);
  83
  84 extern void bt_component_get_ref(const bt_component *component);
  85
  86 extern void bt_component_put_ref(const bt_component *component);
  87
  88 #define BT_COMPONENT_PUT_REF_AND_RESET(_var)            \
  89         do {                                            \
  90                 bt_component_put_ref(_var);             \
  91                 (_var) = NULL;                          \
  92         } while (0)
  93
  94 #define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)       \
  95         do {                                            \
  96                 bt_component_put_ref(_var_dst);         \
  97                 (_var_dst) = (_var_src);                \
  98                 (_var_src) = NULL;                      \
  99         } while (0)
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */