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

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_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 /* For bt_bool, bt_component_class */
  32 #include <babeltrace2/types.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 typedef enum bt_component_class_type {
  39         BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
  40         BT_COMPONENT_CLASS_TYPE_FILTER = 1,
  41         BT_COMPONENT_CLASS_TYPE_SINK = 2,
  42 } bt_component_class_type;
  43
  44 extern const char *bt_component_class_get_name(
  45                 const bt_component_class *component_class);
  46
  47 extern const char *bt_component_class_get_description(
  48                 const bt_component_class *component_class);
  49
  50 extern const char *bt_component_class_get_help(
  51                 const bt_component_class *component_class);
  52
  53 extern bt_component_class_type bt_component_class_get_type(
  54                 const bt_component_class *component_class);
  55
  56 static inline
  57 bt_bool bt_component_class_is_source(
  58                 const bt_component_class *component_class)
  59 {
  60         return bt_component_class_get_type(component_class) ==
  61                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  62 }
  63
  64 static inline
  65 bt_bool bt_component_class_is_filter(
  66                 const bt_component_class *component_class)
  67 {
  68         return bt_component_class_get_type(component_class) ==
  69                 BT_COMPONENT_CLASS_TYPE_FILTER;
  70 }
  71
  72 static inline
  73 bt_bool bt_component_class_is_sink(
  74                 const bt_component_class *component_class)
  75 {
  76         return bt_component_class_get_type(component_class) ==
  77                 BT_COMPONENT_CLASS_TYPE_SINK;
  78 }
  79
  80 extern void bt_component_class_get_ref(
  81                 const bt_component_class *component_class);
  82
  83 extern void bt_component_class_put_ref(
  84                 const bt_component_class *component_class);
  85
  86 #define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var)      \
  87         do {                                            \
  88                 bt_component_class_put_ref(_var);       \
  89                 (_var) = NULL;                          \
  90         } while (0)
  91
  92 #define BT_COMPONENT_CLASS_MOVE_REF(_var_dst, _var_src) \
  93         do {                                            \
  94                 bt_component_class_put_ref(_var_dst);   \
  95                 (_var_dst) = (_var_src);                \
  96                 (_var_src) = NULL;                      \
  97         } while (0)
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H */