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

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
   2 #define BABELTRACE_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 /* For bt_bool */
  28 #include <babeltrace/types.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct bt_component_class;
  35
  36 enum bt_component_class_type {
  37         BT_COMPONENT_CLASS_TYPE_SOURCE =        0,
  38         BT_COMPONENT_CLASS_TYPE_FILTER =        1,
  39         BT_COMPONENT_CLASS_TYPE_SINK =          2,
  40 };
  41
  42 extern const char *bt_component_class_get_name(
  43                 const struct bt_component_class *component_class);
  44
  45 extern const char *bt_component_class_get_description(
  46                 const struct bt_component_class *component_class);
  47
  48 extern const char *bt_component_class_get_help(
  49                 const struct bt_component_class *component_class);
  50
  51 extern enum bt_component_class_type bt_component_class_get_type(
  52                 const struct bt_component_class *component_class);
  53
  54 static inline
  55 bt_bool bt_component_class_is_source(
  56                 const struct bt_component_class *component_class)
  57 {
  58         return bt_component_class_get_type(component_class) ==
  59                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  60 }
  61
  62 static inline
  63 bt_bool bt_component_class_is_filter(
  64                 const struct bt_component_class *component_class)
  65 {
  66         return bt_component_class_get_type(component_class) ==
  67                 BT_COMPONENT_CLASS_TYPE_FILTER;
  68 }
  69
  70 static inline
  71 bt_bool bt_component_class_is_sink(
  72                 const struct bt_component_class *component_class)
  73 {
  74         return bt_component_class_get_type(component_class) ==
  75                 BT_COMPONENT_CLASS_TYPE_SINK;
  76 }
  77
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */