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