lib: add aliases for Babeltrace structure types

[babeltrace.git] / include / babeltrace / graph / component-const.h

diff --git a/include/babeltrace/graph/component-const.h b/include/babeltrace/graph/component-const.h
index 3f6182e6db6a2e0c9fac68a4f6c7a551b50a3e19..8a3f2add55a068507ffc7c05bf7fcb3d890f01b8 100644 (file)
--- a/include/babeltrace/graph/component-const.h
+++ b/include/babeltrace/graph/component-const.h
@@ -2,10 +2,9 @@
 #define BABELTRACE_GRAPH_COMPONENT_CONST_H
 
 /*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -28,26 +27,23 @@
 /* For enum bt_component_class_type */
 #include <babeltrace/graph/component-class-const.h>
 
-/* For bt_bool */
+/*
+ * For bt_bool, bt_component_class, bt_component_graph, bt_component,
+ * bt_value, bt_port
+ */
 #include <babeltrace/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_component_class;
-struct bt_component_graph;
-struct bt_component;
-struct bt_value;
-struct bt_port;
-
 /**
  * Get component's name.
  *
  * @param component    Component instance of which to get the name
  * @returns            Returns a pointer to the component's name
  */
-extern const char *bt_component_get_name(const struct bt_component *component);
+extern const char *bt_component_get_name(const bt_component *component);
 
 /**
  * Get component's class.
@@ -55,35 +51,52 @@ extern const char *bt_component_get_name(const struct bt_component *component);
  * @param component    Component instance of which to get the class
  * @returns            The component's class
  */
-extern const struct bt_component_class *bt_component_borrow_class_const(
-               const struct bt_component *component);
+extern const bt_component_class *bt_component_borrow_class_const(
+               const bt_component *component);
 
 extern enum bt_component_class_type bt_component_get_class_type(
-               const struct bt_component *component);
+               const bt_component *component);
 
 static inline
-bt_bool bt_component_is_source(const struct bt_component *component)
+bt_bool bt_component_is_source(const bt_component *component)
 {
        return bt_component_get_class_type(component) ==
                BT_COMPONENT_CLASS_TYPE_SOURCE;
 }
 
 static inline
-bt_bool bt_component_is_filter(const struct bt_component *component)
+bt_bool bt_component_is_filter(const bt_component *component)
 {
        return bt_component_get_class_type(component) ==
                BT_COMPONENT_CLASS_TYPE_FILTER;
 }
 
 static inline
-bt_bool bt_component_is_sink(const struct bt_component *component)
+bt_bool bt_component_is_sink(const bt_component *component)
 {
        return bt_component_get_class_type(component) ==
                BT_COMPONENT_CLASS_TYPE_SINK;
 }
 
 extern bt_bool bt_component_graph_is_canceled(
-               const struct bt_component *component);
+               const bt_component *component);
+
+extern void bt_component_get_ref(const bt_component *component);
+
+extern void bt_component_put_ref(const bt_component *component);
+
+#define BT_COMPONENT_PUT_REF_AND_RESET(_var)           \
+       do {                                            \
+               bt_component_put_ref(_var);             \
+               (_var) = NULL;                          \
+       } while (0)
+
+#define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)      \
+       do {                                            \
+               bt_component_put_ref(_var_dst);         \
+               (_var_dst) = (_var_src);                \
+               (_var_src) = NULL;                      \
+       } while (0)
 
 #ifdef __cplusplus
 }