tests: add framework to run code in comp cls / comp / msg iter context

[babeltrace.git] / tests / lib / utils / run-in.hpp

diff --git a/tests/lib/utils/run-in.hpp b/tests/lib/utils/run-in.hpp
new file mode 100644 (file)
index 0000000..2220b97
--- /dev/null
+++ b/tests/lib/utils/run-in.hpp
@@ -0,0 +1,47 @@
+/*
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ * Copyright (C) 2020-2023 EfficiOS, inc.
+ */
+
+#ifndef TESTS_LIB_UTILS_H
+#define TESTS_LIB_UTILS_H
+
+#include <babeltrace2/babeltrace.h>
+#include <functional>
+
+using RunInCompClsQueryFunc = std::function<void(bt_self_component_class *)>;
+using RunInCompClsInitFunc = std::function<void(bt_self_component *)>;
+using RunInMsgIterClsInitFunc = std::function<void(bt_self_message_iterator *)>;
+
+/*
+ * Runs:
+ *
+ * • `compClsCtxFunc` in the context of a component class method,
+ *   if not `nullptr`.
+ *
+ * • `compCtxFunc` in the context of a component method, if not
+ *   `nullptr`.
+ *
+ * • `msgIterCtxFunc` in the context of a message iterator method, if
+ *   not `nullptr`.
+ */
+void runIn(RunInCompClsQueryFunc compClsCtxFunc, RunInCompClsInitFunc compCtxFunc,
+           RunInMsgIterClsInitFunc msgIterCtxFunc);
+
+/*
+ * Runs `func` in the context of a component class method.
+ */
+void runInCompClsQuery(RunInCompClsQueryFunc func);
+
+/*
+ * Runs `func` in the context of a component method.
+ */
+void runInCompClsInit(RunInCompClsInitFunc func);
+
+/*
+ * Runs `func` in the context of a message iterator method.
+ */
+void runInMsgIterClsInit(RunInMsgIterClsInitFunc func);
+
+#endif /* TESTS_LIB_UTILS_H */