lib: Reset libbabeltrace2 to SONANE 0
[babeltrace.git] / include / babeltrace / graph / component-internal.h
index 1e7b547aef911b56b6f5b9076e8c6bb750737522..452e6c5aa5c9bbb735ed22a86b44d8cf65dfa530 100644 (file)
@@ -1,13 +1,10 @@
-#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
-#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
+#ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
+#define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
 
 /*
- * BabelTrace - Component internal
- *
+ * 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
  */
 
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/graph/component.h>
+#include <babeltrace/graph/component-const.h>
 #include <babeltrace/graph/component-class-internal.h>
 #include <babeltrace/graph/port-internal.h>
 #include <babeltrace/object-internal.h>
+#include <babeltrace/types.h>
+#include <babeltrace/assert-internal.h>
 #include <glib.h>
 #include <stdio.h>
 
-#define DEFAULT_INPUT_PORT_NAME                "default"
-#define DEFAULT_OUTPUT_PORT_NAME       "default"
+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;
@@ -52,80 +58,105 @@ struct bt_component {
        /* User-defined data */
        void *user_data;
 
-       /*
-        * Used to protect operations which may only be used during
-        * a component's initialization.
-        */
-       bool initializing;
-
        /* 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_component *bt_component_from_private(
-               struct bt_private_component *private_component)
+struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
 {
-       return (void *) private_component;
+       BT_ASSERT(comp);
+       return (void *) bt_object_borrow_parent(&comp->base);
 }
 
-static inline
-struct bt_private_component *bt_private_component_from_component(
-               struct bt_component *component)
-{
-       return (void *) component;
-}
+BT_HIDDEN
+int bt_component_create(struct bt_component_class *component_class,
+               const char *name, struct bt_component **component);
 
 BT_HIDDEN
-enum bt_component_status bt_component_accept_port_connection(
+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
-void bt_component_port_connected(struct bt_component *comp,
+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_port_disconnected(struct bt_component *comp,
-               struct bt_port *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(struct bt_component *comp);
+uint64_t bt_component_get_input_port_count(const struct bt_component *comp);
 
 BT_HIDDEN
-uint64_t bt_component_get_output_port_count(struct bt_component *comp);
+uint64_t bt_component_get_output_port_count(const struct bt_component *comp);
 
 BT_HIDDEN
-struct bt_port *bt_component_get_input_port_at_index(struct bt_component *comp,
-               int index);
+struct bt_port_input *bt_component_borrow_input_port_by_index(
+               struct bt_component *comp, uint64_t index);
 
 BT_HIDDEN
-struct bt_port *bt_component_get_output_port_at_index(struct bt_component *comp,
-               int index);
+struct bt_port_output *bt_component_borrow_output_port_by_index(
+               struct bt_component *comp, uint64_t index);
 
 BT_HIDDEN
-struct bt_port *bt_component_get_input_port(struct bt_component *comp,
-               const char *name);
+struct bt_port_input *bt_component_borrow_input_port_by_name(
+               struct bt_component *comp, const char *name);
 
 BT_HIDDEN
-struct bt_port *bt_component_get_output_port(struct bt_component *comp,
-               const char *name);
+struct bt_port_output *bt_component_borrow_output_port_by_name(
+               struct bt_component *comp, const char *name);
 
 BT_HIDDEN
-struct bt_port *bt_component_add_input_port(
-               struct bt_component *component, const char *name);
+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
-struct bt_port *bt_component_add_output_port(
-               struct bt_component *component, const char *name);
+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
-enum bt_component_status bt_component_remove_port(
-               struct bt_component *component, struct bt_port *port);
+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_COMPONENT_COMPONENT_INTERNAL_H */
+#endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */
This page took 0.024707 seconds and 4 git commands to generate.