Re-organize sources

[babeltrace.git] / src / lib / graph / component.h

diff --git a/src/lib/graph/component.h b/src/lib/graph/component.h
new file mode 100644 (file)
index 0000000..2753cfe
--- /dev/null
+++ b/src/lib/graph/component.h
@@ -0,0 +1,163 @@
+#ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
+#define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
+
+/*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2015 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
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include "common/babeltrace.h"
+#include <babeltrace2/graph/component-const.h>
+#include "lib/object.h"
+#include <babeltrace2/types.h>
+#include "common/assert.h"
+#include <glib.h>
+#include <stdio.h>
+
+#include "component-class.h"
+#include "port.h"
+
+typedef void (*bt_component_destroy_listener_func)(
+               struct bt_component *class, void *data);
+
+struct bt_component_destroy_listener {
+       bt_component_destroy_listener_func func;
+       void *data;
+};
+
+struct bt_graph;
+
+struct bt_component {
+       struct bt_object base;
+       struct bt_component_class *class;
+       GString *name;
+
+       /*
+        * Internal destroy function specific to a source, filter, or
+        * sink component object.
+        */
+       void (*destroy)(struct bt_component *);
+
+       /* User-defined data */
+       void *user_data;
+
+       /* Input and output ports (weak references) */
+       GPtrArray *input_ports;
+       GPtrArray *output_ports;
+
+       /* Array of struct bt_component_destroy_listener */
+       GArray *destroy_listeners;
+
+       bool initialized;
+};
+
+static inline
+struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
+{
+       BT_ASSERT(comp);
+       return (void *) bt_object_borrow_parent(&comp->base);
+}
+
+BT_HIDDEN
+int bt_component_create(struct bt_component_class *component_class,
+               const char *name, struct bt_component **component);
+
+BT_HIDDEN
+enum bt_self_component_status bt_component_accept_port_connection(
+               struct bt_component *component, struct bt_port *self_port,
+               struct bt_port *other_port);
+
+BT_HIDDEN
+enum bt_self_component_status bt_component_port_connected(
+               struct bt_component *comp,
+               struct bt_port *self_port, struct bt_port *other_port);
+
+BT_HIDDEN
+void bt_component_set_graph(struct bt_component *component,
+               struct bt_graph *graph);
+
+BT_HIDDEN
+uint64_t bt_component_get_input_port_count(const struct bt_component *comp);
+
+BT_HIDDEN
+uint64_t bt_component_get_output_port_count(const struct bt_component *comp);
+
+BT_HIDDEN
+struct bt_port_input *bt_component_borrow_input_port_by_index(
+               struct bt_component *comp, uint64_t index);
+
+BT_HIDDEN
+struct bt_port_output *bt_component_borrow_output_port_by_index(
+               struct bt_component *comp, uint64_t index);
+
+BT_HIDDEN
+struct bt_port_input *bt_component_borrow_input_port_by_name(
+               struct bt_component *comp, const char *name);
+
+BT_HIDDEN
+struct bt_port_output *bt_component_borrow_output_port_by_name(
+               struct bt_component *comp, const char *name);
+
+BT_HIDDEN
+enum bt_self_component_status bt_component_add_input_port(
+               struct bt_component *component, const char *name,
+               void *user_data, struct bt_port **port);
+
+BT_HIDDEN
+enum bt_self_component_status bt_component_add_output_port(
+               struct bt_component *component, const char *name,
+               void *user_data, struct bt_port **port);
+
+BT_HIDDEN
+void bt_component_remove_port(struct bt_component *component,
+               struct bt_port *port);
+
+BT_HIDDEN
+void bt_component_add_destroy_listener(struct bt_component *component,
+               bt_component_destroy_listener_func func, void *data);
+
+BT_HIDDEN
+void bt_component_remove_destroy_listener(struct bt_component *component,
+               bt_component_destroy_listener_func func, void *data);
+
+static inline
+const char *bt_self_component_status_string(
+               enum bt_self_component_status status)
+{
+       switch (status) {
+       case BT_SELF_COMPONENT_STATUS_OK:
+               return "BT_SELF_COMPONENT_STATUS_OK";
+       case BT_SELF_COMPONENT_STATUS_END:
+               return "BT_SELF_COMPONENT_STATUS_END";
+       case BT_SELF_COMPONENT_STATUS_AGAIN:
+               return "BT_SELF_COMPONENT_STATUS_AGAIN";
+       case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
+               return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
+       case BT_SELF_COMPONENT_STATUS_ERROR:
+               return "BT_SELF_COMPONENT_STATUS_ERROR";
+       case BT_SELF_COMPONENT_STATUS_NOMEM:
+               return "BT_SELF_COMPONENT_STATUS_NOMEM";
+       default:
+               return "(unknown)";
+       }
+}
+
+#endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */