#include "cpp-common/vendor/fmt/core.h"
#include "exc.hpp"
-#include "wrap.hpp"
+#include "internal/comp-cls-bridge.hpp" /* IWYU pragma: keep */
namespace bt2 {
-namespace internal {
-
-constexpr const char *unhandledExcLogStr() noexcept
-{
- return "Unhandled exception.";
-}
-
-constexpr const char *unhandledExcLogTag() noexcept
-{
- return "PLUGIN-DEV-HPP";
-}
-
-/*
- * Base class of any component class bridge.
- *
- * `UserCompClsT` is the actual C++ user component class and `LibTypesT`
- * is a structure offering the following specific library types:
- *
- * `SelfCompCls`:
- * Self component class.
- *
- * `SelfComp`:
- * Self component.
- *
- * `SelfCompCfg`:
- * Self component configuration.
- */
-template <typename UserCompClsT, typename LibTypesT>
-class CompClsBridge
-{
-private:
- using _LibSelfCompPtr = typename LibTypesT::SelfComp *;
-
-public:
- static UserCompClsT& userCompFromLibSelfCompPtr(const _LibSelfCompPtr libSelfCompPtr) noexcept
- {
- return wrap(libSelfCompPtr).template data<UserCompClsT>();
- }
-
- static bt_component_class_initialize_method_status init(const _LibSelfCompPtr libSelfCompPtr,
- typename LibTypesT::SelfCompCfg *,
- const bt_value * const libParamsPtr,
- void *) noexcept
- {
- const auto selfComp = wrap(libSelfCompPtr);
-
- try {
- const auto comp = new UserCompClsT {selfComp, wrap(libParamsPtr).asMap()};
-
- selfComp.data(*comp);
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, static_cast<int>(selfComp.loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- }
-
- return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
- }
-
- static void finalize(const _LibSelfCompPtr libSelfCompPtr) noexcept
- {
- delete &userCompFromLibSelfCompPtr(libSelfCompPtr);
- }
-
- static bt_component_class_get_supported_mip_versions_method_status
- getSupportedMipVersions(typename LibTypesT::SelfCompCls * const libSelfCompClsPtr,
- const bt_value * const libParamsPtr, void *,
- const bt_logging_level logLevel,
- bt_integer_range_set_unsigned * const libSupportedVersionsPtr) noexcept
- {
- try {
- UserCompClsT::getSupportedMipVersions(wrap(libSelfCompClsPtr), wrap(libParamsPtr),
- static_cast<LoggingLevel>(logLevel),
- wrap(libSupportedVersionsPtr));
- return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK;
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, static_cast<int>(logLevel), unhandledExcLogTag(),
- unhandledExcLogStr());
- return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_ERROR;
- }
- }
-
- static bt_component_class_query_method_status
- query(typename LibTypesT::SelfCompCls * const libSelfCompClsPtr,
- bt_private_query_executor * const libPrivQueryExecPtr, const char * const object,
- const bt_value * const libParamsPtr, void *,
- const bt_value ** const libResultPtr) noexcept
- {
- const auto privQueryExec = wrap(libPrivQueryExecPtr);
-
- try {
- auto result = UserCompClsT::query(wrap(libSelfCompClsPtr), privQueryExec, object,
- wrap(libParamsPtr));
-
- *libResultPtr = result.release().libObjPtr();
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
- } catch (const TryAgain&) {
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
- } catch (const UnknownObject&) {
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT;
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, static_cast<int>(privQueryExec.loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- }
- }
-};
-
-template <typename SpecCompClsBridgeT, typename LibTypesT>
-struct CompClsBridgeWithInputPorts
-{
- static bt_component_class_port_connected_method_status
- inputPortConnected(typename LibTypesT::SelfComp * const libSelfCompPtr,
- bt_self_component_port_input * const libSelfCompPortPtr,
- const bt_port_output * const libOtherPortPtr) noexcept
- {
- try {
- SpecCompClsBridgeT::userCompFromLibSelfCompPtr(libSelfCompPtr)
- .inputPortConnected(wrap(libSelfCompPortPtr), wrap(libOtherPortPtr));
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfCompPtr).loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR;
- }
-
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK;
- }
-};
-
-template <typename SpecCompClsBridgeT, typename LibTypesT>
-struct CompClsBridgeWithOutputPorts
-{
- static bt_component_class_port_connected_method_status
- outputPortConnected(typename LibTypesT::SelfComp * const libSelfCompPtr,
- bt_self_component_port_output * const libSelfCompPortPtr,
- const bt_port_input * const libOtherPortPtr) noexcept
- {
- try {
- SpecCompClsBridgeT::userCompFromLibSelfCompPtr(libSelfCompPtr)
- .outputPortConnected(wrap(libSelfCompPortPtr), wrap(libOtherPortPtr));
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfCompPtr).loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR;
- }
-
- return BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK;
- }
-};
-
-struct SrcCompClsLibTypes final
-{
- using SelfCompCls = bt_self_component_class_source;
- using SelfComp = bt_self_component_source;
- using SelfCompCfg = bt_self_component_source_configuration;
-};
-
-template <typename UserCompClsT>
-class SrcCompClsBridge final :
- public CompClsBridge<UserCompClsT, SrcCompClsLibTypes>,
- public CompClsBridgeWithOutputPorts<SrcCompClsBridge<UserCompClsT>, SrcCompClsLibTypes>
-{
-};
-
-struct FltCompClsLibTypes final
-{
- using SelfCompCls = bt_self_component_class_filter;
- using SelfComp = bt_self_component_filter;
- using SelfCompCfg = bt_self_component_filter_configuration;
-};
-
-template <typename UserCompClsT>
-class FltCompClsBridge final :
- public CompClsBridge<UserCompClsT, FltCompClsLibTypes>,
- public CompClsBridgeWithInputPorts<FltCompClsBridge<UserCompClsT>, FltCompClsLibTypes>,
- public CompClsBridgeWithOutputPorts<FltCompClsBridge<UserCompClsT>, FltCompClsLibTypes>
-{
-};
-
-struct SinkCompClsLibTypes final
-{
- using SelfCompCls = bt_self_component_class_sink;
- using SelfComp = bt_self_component_sink;
- using SelfCompCfg = bt_self_component_sink_configuration;
-};
-
-template <typename UserCompClsT>
-class SinkCompClsBridge final :
- CompClsBridge<UserCompClsT, SinkCompClsLibTypes>,
- CompClsBridgeWithInputPorts<SinkCompClsBridge<UserCompClsT>, SinkCompClsLibTypes>
-{
-private:
- using CompClsBridge<UserCompClsT, SinkCompClsLibTypes>::userCompFromLibSelfCompPtr;
-
-public:
- static bt_component_class_sink_consume_method_status
- consume(bt_self_component_sink * const libSelfCompPtr) noexcept
- {
- try {
- if (userCompFromLibSelfCompPtr(libSelfCompPtr).consume()) {
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
- } else {
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
- }
- } catch (const TryAgain&) {
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfCompPtr).loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
- }
- }
-
- static bt_component_class_sink_graph_is_configured_method_status
- graphIsConfigured(bt_self_component_sink * const libSelfCompPtr) noexcept
- {
- try {
- userCompFromLibSelfCompPtr(libSelfCompPtr).graphIsConfigured();
- } catch (const std::bad_alloc&) {
- return BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR;
- } catch (const Error&) {
- return BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfCompPtr).loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR;
- }
- }
-};
-
-template <typename UserMsgIterT>
-class MsgIterClsBridge final
-{
-public:
- static UserMsgIterT&
- userMsgIterFromLibSelfMsgIterPtr(bt_self_message_iterator * const libSelfMsgIterPtr) noexcept
- {
- return bt2::wrap(libSelfMsgIterPtr).data<UserMsgIterT>();
- }
-
- static bt_message_iterator_class_initialize_method_status
- init(bt_self_message_iterator * const libSelfMsgIterPtr,
- bt_self_message_iterator_configuration * const libSelfMsgIterConfigPtr,
- bt_self_component_port_output * const libSelfCompPortPtr) noexcept
- {
- const auto selfMsgIter = bt2::wrap(libSelfMsgIterPtr);
-
- try {
- const auto msgIter = new UserMsgIterT {selfMsgIter, bt2::wrap(libSelfMsgIterConfigPtr),
- bt2::wrap(libSelfCompPortPtr)};
-
- selfMsgIter.data(*msgIter);
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- }
-
- return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
- }
-
- static void finalize(bt_self_message_iterator * const libSelfMsgIterPtr) noexcept
- {
- delete &userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr);
- }
-
- static bt_message_iterator_class_next_method_status
- next(bt_self_message_iterator * const libSelfMsgIterPtr, bt_message_array_const libMsgsPtr,
- const uint64_t capacity, uint64_t * const count) noexcept
- {
- try {
- auto msgArray = bt2::ConstMessageArray::wrapEmpty(libMsgsPtr, capacity);
- auto& msgIter = userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr);
-
- msgIter.next(msgArray);
- *count = msgArray.release();
-
- if (G_LIKELY(*count > 0)) {
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
- } else {
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
- }
- } catch (const bt2::TryAgain&) {
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
- }
- }
-
- static bt_message_iterator_class_can_seek_beginning_method_status
- canSeekBeginning(bt_self_message_iterator * const libSelfMsgIterPtr,
- bt_bool * const canSeek) noexcept
- {
- try {
- *canSeek = static_cast<bt_bool>(
- userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr).canSeekBeginning());
- } catch (const bt2::TryAgain&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_ERROR;
- }
-
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_OK;
- }
-
- static bt_message_iterator_class_seek_beginning_method_status
- seekBeginning(bt_self_message_iterator * const libSelfMsgIterPtr) noexcept
- {
- try {
- userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr).seekBeginning();
- } catch (const bt2::TryAgain&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR;
- }
-
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK;
- }
-
- static bt_message_iterator_class_can_seek_ns_from_origin_method_status
- canSeekNsFromOrigin(bt_self_message_iterator * const libSelfMsgIterPtr,
- const std::int64_t nsFromOrigin, bt_bool * const canSeek) noexcept
- {
- try {
- *canSeek = static_cast<bt_bool>(userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr)
- .canSeekNsFromOrigin(nsFromOrigin));
- } catch (const bt2::TryAgain&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR;
- }
-
- return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK;
- }
-
- static bt_message_iterator_class_seek_ns_from_origin_method_status
- seekNsFromOrigin(bt_self_message_iterator * const libSelfMsgIterPtr,
- const std::int64_t nsFromOrigin) noexcept
- {
- try {
- userMsgIterFromLibSelfMsgIterPtr(libSelfMsgIterPtr).seekNsFromOrigin(nsFromOrigin);
- } catch (const bt2::TryAgain&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN;
- } catch (const std::bad_alloc&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR;
- } catch (const bt2::Error&) {
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR;
- } catch (...) {
- BT_LOG_WRITE_CUR_LVL(
- BT_LOG_WARNING,
- static_cast<int>(wrap(libSelfMsgIterPtr).component().loggingLevel()),
- unhandledExcLogTag(), unhandledExcLogStr());
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR;
- }
-
- return BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK;
- }
-};
-
-} /* namespace internal */
template <typename UserMessageIteratorT, typename UserComponentT>
class UserMessageIterator;
* See the specific `bt2::UserSourceComponent`,
* `bt2::UserFilterComponent`, and `bt2::UserSinkComponent`.
*/
-template <typename SelfCompT>
+template <typename SelfCompT, typename InitDataT, typename QueryDataT>
class UserComponent
{
/* Give a related message iterator access to this logger */
template <typename, typename>
friend class UserMessageIterator;
+public:
+ using InitData = InitDataT;
+ using QueryData = QueryDataT;
+
protected:
explicit UserComponent(const SelfCompT selfComp, const std::string& logTag) :
_mLogger {selfComp, fmt::format("{}/[{}]", logTag, selfComp.name())}, _mSelfComp {selfComp}
/*
* Base class of a user source component `UserComponentT` (CRTP).
*
- * `UserComponentT::UserComponentT()` must accept a
- * `bt2::SelfSourceComponent` parameter, which it needs to forward to
- * bt2::UserSourceComponent::UserSourceComponent(), and a
- * `bt2::ConstValue` parameter (initialization parameters).
+ * UserComponentT::UserComponentT() must accept, in this order:
+ *
+ * 1. A `bt2::SelfSourceComponent` parameter, which it needs to forward
+ * to bt2::UserSourceComponent::UserSourceComponent().
+ *
+ * 2. A `bt2::ConstValue` parameter (the initialization parameters).
+ *
+ * 3. An `InitDataT *` parameter (the initialization method data).
+ *
+ * `UserMessageIteratorT`, the message iterator class to use, must inherit
+ * `UserMessageIterator`.
+ *
+ * UserComponentT::_query() receives a query method data pointer of type
+ * `QueryDataT *` as its last parameter.
*/
-template <typename UserComponentT>
-class UserSourceComponent : public UserComponent<SelfSourceComponent>
+template <typename UserComponentT, typename UserMessageIteratorT, typename InitDataT = void,
+ typename QueryDataT = void>
+class UserSourceComponent : public UserComponent<SelfSourceComponent, InitDataT, QueryDataT>
{
+ static_assert(std::is_base_of<UserMessageIterator<UserMessageIteratorT, UserComponentT>,
+ UserMessageIteratorT>::value,
+ "`UserMessageIteratorT` inherits `UserMessageIterator`");
+
+public:
+ using MessageIterator = UserMessageIteratorT;
+
protected:
using _OutputPorts = SelfSourceComponent::OutputPorts;
explicit UserSourceComponent(const SelfSourceComponent selfComp, const std::string& logTag) :
- UserComponent<SelfSourceComponent> {selfComp, logTag}
+ UserComponent<SelfSourceComponent, InitDataT, QueryDataT> {selfComp, logTag}
{
}
public:
static Value::Shared query(const SelfComponentClass selfCompCls,
- const PrivateQueryExecutor privQueryExec, const char * const obj,
- const ConstValue params)
+ const PrivateQueryExecutor privQueryExec,
+ const bt2c::CStringView obj, const ConstValue params,
+ QueryDataT * const data)
{
- return UserComponentT::_query(selfCompCls, privQueryExec, obj, params);
+ return UserComponentT::_query(selfCompCls, privQueryExec, obj, params, data);
}
static void getSupportedMipVersions(const SelfComponentClass selfCompCls,
void outputPortConnected(const SelfComponentOutputPort outputPort,
const ConstInputPort inputPort)
{
- static_cast<UserComponentT&>(*this).outputPortConnected(outputPort, inputPort);
+ static_cast<UserComponentT&>(*this)._outputPortConnected(outputPort, inputPort);
}
protected:
/* Overloadable */
- static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, const char *, ConstValue)
+ static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, bt2c::CStringView,
+ ConstValue, QueryDataT *)
{
throw UnknownObject {};
}
}
template <typename DataT>
- _OutputPorts::Port _addOutputPort(const char * const name, DataT * const data)
- {
- return this->_selfComp().addOutputPort(name, data);
- }
-
- _OutputPorts::Port _addOutputPort(const char *name)
- {
- return this->_selfComp().addOutputPort(name);
- }
-
- template <typename DataT>
- _OutputPorts::Port _addOutputPort(const std::string& name, DataT * const data)
+ _OutputPorts::Port _addOutputPort(const bt2c::CStringView name, DataT& data)
{
return this->_selfComp().addOutputPort(name, data);
}
- _OutputPorts::Port _addOutputPort(const std::string& name)
+ _OutputPorts::Port _addOutputPort(const bt2c::CStringView name)
{
return this->_selfComp().addOutputPort(name);
}
/*
* Base class of a user filter component `UserComponentT` (CRTP).
*
- * `UserComponentT::UserComponentT()` must accept a
- * `bt2::SelfFilterComponent` parameter, which it needs to forward to
- * bt2::UserFilterComponent::UserFilterComponent(), and a
- * `bt2::ConstValue` parameter (initialization parameters).
+ * UserComponentT::UserComponentT() must accept, in this order:
+ *
+ * 1. A `bt2::SelfFilterComponent` parameter, which it needs to forward
+ * to bt2::UserFilterComponent::UserFilterComponent().
+ *
+ * 2. A `bt2::ConstValue` parameter (the initialization parameters).
+ *
+ * 3. An `InitDataT *` parameter (the initialization method data).
+ *
+ * `UserMessageIteratorT`, the message iterator class to use, must inherit
+ * `UserMessageIterator`.
+ *
+ * UserComponentT::_query() receives a query method data pointer of type
+ * `QueryDataT *` as its last parameter.
*/
-template <typename UserComponentT>
-class UserFilterComponent : public UserComponent<SelfFilterComponent>
+template <typename UserComponentT, typename UserMessageIteratorT, typename InitDataT = void,
+ typename QueryDataT = void>
+class UserFilterComponent : public UserComponent<SelfFilterComponent, InitDataT, QueryDataT>
{
+ static_assert(std::is_base_of<UserMessageIterator<UserMessageIteratorT, UserComponentT>,
+ UserMessageIteratorT>::value,
+ "`UserMessageIteratorT` inherits `UserMessageIterator`");
+
+public:
+ using MessageIterator = UserMessageIteratorT;
+
protected:
using _InputPorts = SelfFilterComponent::InputPorts;
using _OutputPorts = SelfFilterComponent::OutputPorts;
explicit UserFilterComponent(const SelfFilterComponent selfComp, const std::string& logTag) :
- UserComponent<SelfFilterComponent> {selfComp, logTag}
+ UserComponent<SelfFilterComponent, InitDataT, QueryDataT> {selfComp, logTag}
{
}
public:
static Value::Shared query(const SelfComponentClass selfCompCls,
- const PrivateQueryExecutor privQueryExec, const char * const obj,
- const ConstValue params)
+ const PrivateQueryExecutor privQueryExec,
+ const bt2c::CStringView obj, const ConstValue params,
+ QueryDataT * const data)
{
- return UserComponentT::_query(selfCompCls, privQueryExec, obj, params);
+ return UserComponentT::_query(selfCompCls, privQueryExec, obj, params, data);
}
static void getSupportedMipVersions(const SelfComponentClass selfCompCls,
protected:
/* Overloadable */
- static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, const char *, ConstValue)
+ static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, bt2c::CStringView,
+ ConstValue, QueryDataT *)
{
throw UnknownObject {};
}
}
template <typename DataT>
- _OutputPorts::Port _addInputPort(const char * const name, DataT * const data)
+ _OutputPorts::Port _addInputPort(const bt2c::CStringView name, DataT& data)
{
return this->_selfComp().addInputPort(name, data);
}
- _InputPorts::Port _addInputPort(const char *name)
- {
- return this->_selfComp().addInputPort(name);
- }
-
- template <typename DataT>
- _InputPorts::Port _addInputPort(const std::string& name, DataT * const data)
- {
- return this->_selfComp().addInputPort(name, data);
- }
-
- _InputPorts::Port _addInputPort(const std::string& name)
+ _InputPorts::Port _addInputPort(const bt2c::CStringView name)
{
return this->_selfComp().addInputPort(name);
}
}
template <typename DataT>
- _OutputPorts::Port _addOutputPort(const char * const name, DataT * const data)
- {
- return this->_selfComp().addOutputPort(name, data);
- }
-
- _OutputPorts::Port _addOutputPort(const char *name)
- {
- return this->_selfComp().addOutputPort(name);
- }
-
- template <typename DataT>
- _OutputPorts::Port _addOutputPort(const std::string& name, DataT * const data)
+ _OutputPorts::Port _addOutputPort(const bt2c::CStringView name, DataT& data)
{
return this->_selfComp().addOutputPort(name, data);
}
- _OutputPorts::Port _addOutputPort(const std::string& name)
+ _OutputPorts::Port _addOutputPort(const bt2c::CStringView name)
{
return this->_selfComp().addOutputPort(name);
}
/*
* Base class of a user sink component `UserComponentT` (CRTP).
*
- * `UserComponentT::UserComponentT()` must accept a
- * `bt2::SelfSinkComponent` parameter, which it needs to forward to
- * bt2::UserSinkComponent::UserSinkComponent(), and a `bt2::ConstValue`
- * parameter (initialization parameters).
+ * UserComponentT::UserComponentT() must accept, in this order:
+ *
+ * 1. A `bt2::SelfSinkComponent` parameter, which it needs to forward
+ * to bt2::UserSinkComponent::UserSinkComponent().
+ *
+ * 2. A `bt2::ConstValue` parameter (the initialization parameters).
+ *
+ * 3. An `InitDataT *` parameter (the initialization method data).
*
* `UserComponentT` must implement:
*
*
* This method returns `true` if the sink component still needs to
* consume, or `false` if it's finished.
+ *
+ * UserComponentT::_query() receives a query method data pointer of type
+ * `QueryDataT *` as its last parameter.
+
*/
-template <typename UserComponentT>
-class UserSinkComponent : public UserComponent<SelfSinkComponent>
+template <typename UserComponentT, typename InitDataT = void, typename QueryDataT = void>
+class UserSinkComponent : public UserComponent<SelfSinkComponent, InitDataT, QueryDataT>
{
protected:
using _InputPorts = SelfSinkComponent::InputPorts;
explicit UserSinkComponent(const SelfSinkComponent selfComp, const std::string& logTag) :
- UserComponent<SelfSinkComponent> {selfComp, logTag}
+ UserComponent<SelfSinkComponent, InitDataT, QueryDataT> {selfComp, logTag}
{
}
public:
static Value::Shared query(const SelfComponentClass selfCompCls,
- const PrivateQueryExecutor privQueryExec, const char * const obj,
- const ConstValue params)
+ const PrivateQueryExecutor privQueryExec,
+ const bt2c::CStringView obj, const ConstValue params,
+ QueryDataT * const data)
{
- return UserComponentT::_query(selfCompCls, privQueryExec, obj, params);
+ return UserComponentT::_query(selfCompCls, privQueryExec, obj, params, data);
}
static void getSupportedMipVersions(const SelfComponentClass selfCompCls,
protected:
/* Overloadable */
- static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, const char *, ConstValue)
+ static Value::Shared _query(SelfComponentClass, PrivateQueryExecutor, bt2c::CStringView,
+ ConstValue, QueryDataT *)
{
throw UnknownObject {};
}
}
template <typename DataT>
- _InputPorts::Port _addInputPort(const char * const name, DataT * const data)
- {
- return this->_selfComp().addInputPort(name, data);
- }
-
- _InputPorts::Port _addInputPort(const char *name)
- {
- return this->_selfComp().addInputPort(name);
- }
-
- template <typename DataT>
- _InputPorts::Port _addInputPort(const std::string& name, DataT * const data)
+ _InputPorts::Port _addInputPort(const bt2c::CStringView name, DataT& data)
{
return this->_selfComp().addInputPort(name, data);
}
- _InputPorts::Port _addInputPort(const std::string& name)
+ _InputPorts::Port _addInputPort(const bt2c::CStringView name)
{
return this->_selfComp().addInputPort(name);
}
} /* namespace bt2 */
-#define BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS_WITH_ID( \
- _pluginId, _componentClassId, _name, _userComponentClass, _userMessageIteratorClass) \
+#define BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS_WITH_ID(_pluginId, _componentClassId, _name, \
+ _userComponentClass) \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_WITH_ID( \
_pluginId, _componentClassId, _name, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::next); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::next); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_INITIALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, bt2::internal::SrcCompClsBridge<_userComponentClass>::init); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_FINALIZE_METHOD_WITH_ID( \
bt2::internal::SrcCompClsBridge<_userComponentClass>::query); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::init); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::init); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_FINALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::finalize); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::finalize); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHODS_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::seekBeginning, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::canSeekBeginning); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::seekBeginning, \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::canSeekBeginning); \
BT_PLUGIN_SOURCE_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHODS_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::seekNsFromOrigin, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::canSeekNsFromOrigin);
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::seekNsFromOrigin, \
+ bt2::internal::MsgIterClsBridge< \
+ _userComponentClass::MessageIterator>::canSeekNsFromOrigin);
-#define BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID( \
- _pluginId, _componentClassId, _name, _userComponentClass, _userMessageIteratorClass) \
+#define BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID(_pluginId, _componentClassId, _name, \
+ _userComponentClass) \
BT_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID( \
_pluginId, _componentClassId, _name, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::next); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::next); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_INITIALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, bt2::internal::FltCompClsBridge<_userComponentClass>::init); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD_WITH_ID( \
bt2::internal::FltCompClsBridge<_userComponentClass>::query); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::init); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::init); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_FINALIZE_METHOD_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::finalize); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::finalize); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHODS_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::seekBeginning, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::canSeekBeginning); \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::seekBeginning, \
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::canSeekBeginning); \
BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHODS_WITH_ID( \
_pluginId, _componentClassId, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::seekNsFromOrigin, \
- bt2::internal::MsgIterClsBridge<_userMessageIteratorClass>::canSeekNsFromOrigin);
+ bt2::internal::MsgIterClsBridge<_userComponentClass::MessageIterator>::seekNsFromOrigin, \
+ bt2::internal::MsgIterClsBridge< \
+ _userComponentClass::MessageIterator>::canSeekNsFromOrigin);
#define BT_CPP_PLUGIN_SINK_COMPONENT_CLASS_WITH_ID(_pluginId, _componentClassId, _name, \
_userComponentClass) \
_pluginId, _componentClassId, \
bt2::internal::SinkCompClsBridge<_userComponentClass>::query);
-#define BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS(_name, _userComponentClass, \
- _userMessageIteratorClass) \
- BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS_WITH_ID(auto, _name, #_name, _userComponentClass, \
- _userMessageIteratorClass)
+#define BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS(_name, _userComponentClass) \
+ BT_CPP_PLUGIN_SOURCE_COMPONENT_CLASS_WITH_ID(auto, _name, #_name, _userComponentClass)
-#define BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS(_name, _userComponentClass, \
- _userMessageIteratorClass) \
- BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID(auto, _name, #_name, _userComponentClass, \
- _userMessageIteratorClass)
+#define BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS(_name, _userComponentClass) \
+ BT_CPP_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID(auto, _name, #_name, _userComponentClass)
#define BT_CPP_PLUGIN_SINK_COMPONENT_CLASS(_name, _userComponentClass) \
BT_CPP_PLUGIN_SINK_COMPONENT_CLASS_WITH_ID(auto, _name, #_name, _userComponentClass)
projects / babeltrace.git / blobdiff