2 * Copyright (c) 2024 EfficiOS, Inc.
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_PLUGIN_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_PLUGIN_HPP
12 #include <babeltrace2/babeltrace.h>
14 #include "cpp-common/bt2c/c-string-view.hpp"
15 #include "cpp-common/bt2s/optional.hpp"
17 #include "borrowed-object-iterator.hpp"
18 #include "borrowed-object.hpp"
19 #include "component-class.hpp"
20 #include "shared-object.hpp"
24 template <typename PluginSpecCompClsT>
25 class ConstPluginComponentClasses final : public BorrowedObject<const bt_plugin>
28 using Iterator = BorrowedObjectIterator<ConstPluginComponentClasses<PluginSpecCompClsT>>;
30 explicit ConstPluginComponentClasses(const LibObjPtr libPluginPtr) noexcept :
31 _ThisBorrowedObject {libPluginPtr}
35 std::uint64_t length() const noexcept
37 return PluginSpecCompClsT::getCompClsCount(this->libObjPtr());
40 Iterator begin() const noexcept
42 return Iterator {*this, 0};
45 Iterator end() const noexcept
47 return Iterator {*this, this->length()};
50 typename PluginSpecCompClsT::CompCls operator[](const std::uint64_t index) const noexcept
52 return PluginSpecCompClsT::borrowCompClsByIndex(this->libObjPtr(), index);
55 OptionalBorrowedObject<typename PluginSpecCompClsT::CompCls>
56 operator[](const bt2c::CStringView name) const noexcept
58 return PluginSpecCompClsT::borrowCompClsByName(this->libObjPtr(), name);
64 struct PluginRefFuncs final
66 static void get(const bt_plugin * const libObjPtr) noexcept
68 bt_plugin_get_ref(libObjPtr);
71 static void put(const bt_plugin * const libObjPtr) noexcept
73 bt_plugin_put_ref(libObjPtr);
77 struct PluginSourceCompClsFuncs final
79 using CompCls = ConstSourceComponentClass;
81 static std::uint64_t getCompClsCount(const bt_plugin * const plugin) noexcept
83 return bt_plugin_get_source_component_class_count(plugin);
86 static const bt_component_class_source *borrowCompClsByIndex(const bt_plugin * const plugin,
87 const std::uint64_t index) noexcept
89 return bt_plugin_borrow_source_component_class_by_index_const(plugin, index);
92 static const bt_component_class_source *borrowCompClsByName(const bt_plugin * const plugin,
93 const char *name) noexcept
95 return bt_plugin_borrow_source_component_class_by_name_const(plugin, name);
99 struct PluginFilterCompClsFuncs final
101 using CompCls = ConstFilterComponentClass;
103 static std::uint64_t getCompClsCount(const bt_plugin * const plugin) noexcept
105 return bt_plugin_get_filter_component_class_count(plugin);
108 static const bt_component_class_filter *borrowCompClsByIndex(const bt_plugin * const plugin,
109 const std::uint64_t index) noexcept
111 return bt_plugin_borrow_filter_component_class_by_index_const(plugin, index);
114 static const bt_component_class_filter *borrowCompClsByName(const bt_plugin * const plugin,
115 const char *name) noexcept
117 return bt_plugin_borrow_filter_component_class_by_name_const(plugin, name);
121 struct PluginSinkCompClsFuncs final
123 using CompCls = ConstSinkComponentClass;
125 static std::uint64_t getCompClsCount(const bt_plugin * const plugin) noexcept
127 return bt_plugin_get_sink_component_class_count(plugin);
130 static const bt_component_class_sink *borrowCompClsByIndex(const bt_plugin * const plugin,
131 const std::uint64_t index) noexcept
133 return bt_plugin_borrow_sink_component_class_by_index_const(plugin, index);
136 static const bt_component_class_sink *borrowCompClsByName(const bt_plugin * const plugin,
137 const char *name) noexcept
139 return bt_plugin_borrow_sink_component_class_by_name_const(plugin, name);
143 } /* namespace internal */
145 class ConstPlugin final : public BorrowedObject<const bt_plugin>
148 using SourceComponementClasses =
149 ConstPluginComponentClasses<internal::PluginSourceCompClsFuncs>;
150 using FilterComponementClasses =
151 ConstPluginComponentClasses<internal::PluginFilterCompClsFuncs>;
152 using SinkComponementClasses = ConstPluginComponentClasses<internal::PluginSinkCompClsFuncs>;
157 explicit Version(const unsigned int major, const unsigned int minor,
158 const unsigned int patch, const bt2c::CStringView extra) noexcept :
160 _mMinor {minor}, _mPatch {patch}, _mExtra {extra}
164 unsigned int major() const noexcept
169 unsigned int minor() const noexcept
174 unsigned int patch() const noexcept
179 bt2c::CStringView extra() const noexcept
185 unsigned int _mMajor, _mMinor, _mPatch;
186 bt2c::CStringView _mExtra;
189 using Shared = SharedObject<ConstPlugin, const bt_plugin, internal::PluginRefFuncs>;
191 explicit ConstPlugin(const LibObjPtr plugin) : _ThisBorrowedObject {plugin}
195 bt2c::CStringView name() const noexcept
197 return bt_plugin_get_name(this->libObjPtr());
200 bt2c::CStringView description() const noexcept
202 return bt_plugin_get_description(this->libObjPtr());
205 bt2c::CStringView author() const noexcept
207 return bt_plugin_get_author(this->libObjPtr());
210 bt2c::CStringView license() const noexcept
212 return bt_plugin_get_license(this->libObjPtr());
215 bt2c::CStringView path() const noexcept
217 return bt_plugin_get_path(this->libObjPtr());
220 bt2s::optional<Version> version() const noexcept
222 unsigned int major, minor, patch;
225 if (bt_plugin_get_version(this->libObjPtr(), &major, &minor, &patch, &extra) ==
226 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
227 return bt2s::nullopt;
230 return Version {major, minor, patch, extra};
233 SourceComponementClasses sourceComponentClasses() const noexcept
235 return SourceComponementClasses {this->libObjPtr()};
238 FilterComponementClasses filterComponentClasses() const noexcept
240 return FilterComponementClasses {this->libObjPtr()};
243 SinkComponementClasses sinkComponentClasses() const noexcept
245 return SinkComponementClasses {this->libObjPtr()};
249 } /* namespace bt2 */
251 #endif /* BABELTRACE_CPP_COMMON_BT2_PLUGIN_HPP */