cpp-common/bt2/internal/utils.hpp \
cpp-common/bt2/logging.hpp \
cpp-common/bt2/message.hpp \
- cpp-common/bt2/shared-obj.hpp \
+ cpp-common/bt2/shared-object.hpp \
cpp-common/bt2/trace-ir.hpp \
cpp-common/bt2/type-traits.hpp \
cpp-common/bt2/value.hpp \
#include "borrowed-object.hpp"
#include "exc.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
#include "value.hpp"
namespace bt2 {
using _ThisCommonClockClass = CommonClockClass<LibObjT>;
public:
- using Shared = SharedObj<_ThisCommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
+ using Shared = SharedObject<_ThisCommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
using UserAttributes =
typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
#include "field-path.hpp"
#include "integer-range-set.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
#include "value.hpp"
namespace bt2 {
} /* namespace internal */
template <typename ObjT, typename LibObjT>
-using SharedFieldClass = SharedObj<ObjT, LibObjT, internal::FieldClassRefFuncs>;
+using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
template <typename LibObjT>
class CommonBitArrayFieldClass;
#include "borrowed-object.hpp"
#include "common-iter.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
namespace bt2 {
class ConstFieldPath final : public BorrowedObject<const bt_field_path>
{
public:
- using Shared = SharedObj<ConstFieldPath, const bt_field_path, internal::FieldPathRefFuncs>;
+ using Shared = SharedObject<ConstFieldPath, const bt_field_path, internal::FieldPathRefFuncs>;
using Iterator = CommonIterator<ConstFieldPath, ConstFieldPathItem>;
#include "exc.hpp"
#include "integer-range.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
namespace bt2 {
using _ThisCommonIntegerRangeSet = CommonIntegerRangeSet<LibObjT>;
public:
- using Shared = SharedObj<_ThisCommonIntegerRangeSet, LibObjT, _RefFuncs>;
+ using Shared = SharedObject<_ThisCommonIntegerRangeSet, LibObjT, _RefFuncs>;
using Range = typename std::conditional<
std::is_same<_ConstLibObjT, const bt_integer_range_set_unsigned>::value,
#include "borrowed-object.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
namespace bt2 {
namespace internal {
} /* namespace internal */
template <typename ObjT, typename LibObjT>
-using SharedMessage = SharedObj<ObjT, LibObjT, internal::MessageRefFuncs>;
+using SharedMessage = SharedObject<ObjT, LibObjT, internal::MessageRefFuncs>;
template <typename LibObjT>
class CommonStreamBeginningMessage;
+++ /dev/null
-/*
- * Copyright (c) 2019-2020 Philippe Proulx <pproulx@efficios.com>
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef BABELTRACE_CPP_COMMON_BT2_SHARED_OBJ_HPP
-#define BABELTRACE_CPP_COMMON_BT2_SHARED_OBJ_HPP
-
-#include "common/assert.h"
-#include "cpp-common/optional.hpp"
-
-namespace bt2 {
-
-/*
- * An instance of this class wraps an optional instance of `ObjT` and
- * manages the reference counting of the underlying libbabeltrace2
- * object.
- *
- * When you move a shared object, it becomes invalid, in that
- * operator*() and operator->() will either fail to assert in debug mode
- * or trigger a segmentation fault.
- *
- * `LibObjT` is the direct libbabeltrace2 object type, for example
- * `bt_stream_class` or `const bt_value`.
- *
- * RefFuncsT::get() must accept a `const LibObjT *` value and increment
- * its reference count.
- *
- * RefFuncsT::put() must accept a `const LibObjT *` value and decrement
- * its reference count.
- */
-template <typename ObjT, typename LibObjT, typename RefFuncsT>
-class SharedObj final
-{
- /*
- * This makes it possible for a
- * `SharedObj<Something, bt_something, ...>` instance to get
- * assigned an instance of
- * `SharedObj<SpecificSomething, bt_something, ...>` (copy/move
- * constructors and assignment operators), given that
- * `SpecificSomething` inherits `Something`.
- */
- template <typename, typename, typename>
- friend class SharedObj;
-
-private:
- /*
- * Builds a shared object from `obj` without getting a reference.
- */
- explicit SharedObj(const ObjT& obj) noexcept : _mObj {obj}
- {
- }
-
- /*
- * Common generic "copy" constructor.
- *
- * This constructor is meant to be delegated to by the copy
- * constructor and the generic "copy" constructor.
- *
- * The second parameter, of type `int`, makes it possible to
- * delegate by deduction as you can't explicit the template
- * parameters when delegating to a constructor template.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj(const SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>& other, int) noexcept :
- _mObj {other._mObj}
- {
- this->_getRef();
- }
-
- /*
- * Common generic "move" constructor.
- *
- * See the comment of the common generic "copy" constructor above.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj(SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>&& other, int) noexcept :
- _mObj {other._mObj}
- {
- /* Reset moved-from object */
- other._reset();
- }
-
-public:
- /*
- * Builds a shared object from `obj` without getting a reference.
- */
- static SharedObj createWithoutRef(const ObjT& obj) noexcept
- {
- return SharedObj {obj};
- }
-
- /*
- * Builds a shared object from `libObjPtr` without getting a
- * reference.
- */
- static SharedObj createWithoutRef(LibObjT * const libObjPtr) noexcept
- {
- return SharedObj::createWithoutRef(ObjT {libObjPtr});
- }
-
- /*
- * Builds a shared object from `obj`, immediately getting a new
- * reference.
- */
- static SharedObj createWithRef(const ObjT& obj) noexcept
- {
- SharedObj sharedObj {obj};
-
- sharedObj._getRef();
- return sharedObj;
- }
-
- /*
- * Builds a shared object from `libObjPtr`, immediately getting a new
- * reference.
- */
- static SharedObj createWithRef(LibObjT * const libObjPtr) noexcept
- {
- return SharedObj::createWithRef(ObjT {libObjPtr});
- }
-
- /*
- * Copy constructor.
- */
- SharedObj(const SharedObj& other) noexcept : SharedObj {other, 0}
- {
- }
-
- /*
- * Move constructor.
- */
- SharedObj(SharedObj&& other) noexcept : SharedObj {std::move(other), 0}
- {
- }
-
- /*
- * Copy assignment operator.
- */
- SharedObj& operator=(const SharedObj& other) noexcept
- {
- /* Use generic "copy" assignment operator */
- return this->operator=<ObjT, LibObjT>(other);
- }
-
- /*
- * Move assignment operator.
- */
- SharedObj& operator=(SharedObj&& other) noexcept
- {
- /* Use generic "move" assignment operator */
- return this->operator=<ObjT, LibObjT>(std::move(other));
- }
-
- /*
- * Generic "copy" constructor.
- *
- * See the `friend class SharedObj` comment above.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj(const SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>& other) noexcept :
- SharedObj {other, 0}
- {
- }
-
- /*
- * Generic "move" constructor.
- *
- * See the `friend class SharedObj` comment above.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj(SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>&& other) noexcept :
- SharedObj {std::move(other), 0}
- {
- }
-
- /*
- * Generic "copy" assignment operator.
- *
- * See the `friend class SharedObj` comment above.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj& operator=(const SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>& other) noexcept
- {
- /* Put current object's reference */
- this->_putRef();
-
- /* Set new current object and get a reference */
- _mObj = other._mObj;
- this->_getRef();
-
- return *this;
- }
-
- /*
- * Generic "move" assignment operator.
- *
- * See the `friend class SharedObj` comment above.
- */
- template <typename OtherObjT, typename OtherLibObjT>
- SharedObj& operator=(SharedObj<OtherObjT, OtherLibObjT, RefFuncsT>&& other) noexcept
- {
- /* Put current object's reference */
- this->_putRef();
-
- /* Set new current object */
- _mObj = other._mObj;
-
- /* Reset moved-from object */
- other._reset();
-
- return *this;
- }
-
- ~SharedObj()
- {
- this->_putRef();
- }
-
- ObjT& operator*() noexcept
- {
- BT_ASSERT_DBG(_mObj);
- return *_mObj;
- }
-
- const ObjT& operator*() const noexcept
- {
- BT_ASSERT_DBG(_mObj);
- return *_mObj;
- }
-
- ObjT *operator->() noexcept
- {
- BT_ASSERT_DBG(_mObj);
- return &*_mObj;
- }
-
- const ObjT *operator->() const noexcept
- {
- BT_ASSERT_DBG(_mObj);
- return &*_mObj;
- }
-
- /*
- * Transfers the reference of the object which this shared object
- * wrapper manages and returns it, making the caller become an active
- * owner.
- *
- * This method makes this object invalid.
- */
- ObjT release() noexcept
- {
- BT_ASSERT_DBG(_mObj);
- const auto obj = *_mObj;
- this->_reset();
- return obj;
- }
-
-private:
- /*
- * Resets this shared object.
- *
- * To be used when moving it.
- */
- void _reset() noexcept
- {
- _mObj.reset();
- }
-
- /*
- * Gets a new reference using the configured libbabeltrace2
- * reference incrementation function.
- */
- void _getRef() const noexcept
- {
- if (_mObj) {
- RefFuncsT::get(_mObj->libObjPtr());
- }
- }
-
- /*
- * Puts a reference using the configured libbabeltrace2 reference
- * decrementation function.
- */
- void _putRef() const noexcept
- {
- if (_mObj) {
- RefFuncsT::put(_mObj->libObjPtr());
- }
- }
-
- nonstd::optional<ObjT> _mObj;
-};
-
-} /* namespace bt2 */
-
-#endif /* BABELTRACE_CPP_COMMON_BT2_SHARED_OBJ_HPP */
--- /dev/null
+/*
+ * Copyright (c) 2019-2020 Philippe Proulx <pproulx@efficios.com>
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef BABELTRACE_CPP_COMMON_BT2_SHARED_OBJECT_HPP
+#define BABELTRACE_CPP_COMMON_BT2_SHARED_OBJECT_HPP
+
+#include "common/assert.h"
+#include "cpp-common/optional.hpp"
+
+namespace bt2 {
+
+/*
+ * An instance of this class wraps an optional instance of `ObjT` and
+ * manages the reference counting of the underlying libbabeltrace2
+ * object.
+ *
+ * When you move a shared object, it becomes invalid, in that
+ * operator*() and operator->() will either fail to assert in debug mode
+ * or trigger a segmentation fault.
+ *
+ * `LibObjT` is the direct libbabeltrace2 object type, for example
+ * `bt_stream_class` or `const bt_value`.
+ *
+ * RefFuncsT::get() must accept a `const LibObjT *` value and increment
+ * its reference count.
+ *
+ * RefFuncsT::put() must accept a `const LibObjT *` value and decrement
+ * its reference count.
+ */
+template <typename ObjT, typename LibObjT, typename RefFuncsT>
+class SharedObject final
+{
+ /*
+ * This makes it possible for a
+ * `SharedObject<Something, bt_something, ...>` instance to get
+ * assigned an instance of
+ * `SharedObject<SpecificSomething, bt_something, ...>` (copy/move
+ * constructors and assignment operators), given that
+ * `SpecificSomething` inherits `Something`.
+ */
+ template <typename, typename, typename>
+ friend class SharedObject;
+
+private:
+ /*
+ * Builds a shared object from `obj` without getting a reference.
+ */
+ explicit SharedObject(const ObjT& obj) noexcept : _mObj {obj}
+ {
+ }
+
+ /*
+ * Common generic "copy" constructor.
+ *
+ * This constructor is meant to be delegated to by the copy
+ * constructor and the generic "copy" constructor.
+ *
+ * The second parameter, of type `int`, makes it possible to
+ * delegate by deduction as you can't explicit the template
+ * parameters when delegating to a constructor template.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject(const SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>& other, int) noexcept :
+ _mObj {other._mObj}
+ {
+ this->_getRef();
+ }
+
+ /*
+ * Common generic "move" constructor.
+ *
+ * See the comment of the common generic "copy" constructor above.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject(SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>&& other, int) noexcept :
+ _mObj {other._mObj}
+ {
+ /* Reset moved-from object */
+ other._reset();
+ }
+
+public:
+ /*
+ * Builds a shared object from `obj` without getting a reference.
+ */
+ static SharedObject createWithoutRef(const ObjT& obj) noexcept
+ {
+ return SharedObject {obj};
+ }
+
+ /*
+ * Builds a shared object from `libObjPtr` without getting a
+ * reference.
+ */
+ static SharedObject createWithoutRef(LibObjT * const libObjPtr) noexcept
+ {
+ return SharedObject::createWithoutRef(ObjT {libObjPtr});
+ }
+
+ /*
+ * Builds a shared object from `obj`, immediately getting a new
+ * reference.
+ */
+ static SharedObject createWithRef(const ObjT& obj) noexcept
+ {
+ SharedObject sharedObj {obj};
+
+ sharedObj._getRef();
+ return sharedObj;
+ }
+
+ /*
+ * Builds a shared object from `libObjPtr`, immediately getting a
+ * new reference.
+ */
+ static SharedObject createWithRef(LibObjT * const libObjPtr) noexcept
+ {
+ return SharedObject::createWithRef(ObjT {libObjPtr});
+ }
+
+ /*
+ * Copy constructor.
+ */
+ SharedObject(const SharedObject& other) noexcept : SharedObject {other, 0}
+ {
+ }
+
+ /*
+ * Move constructor.
+ */
+ SharedObject(SharedObject&& other) noexcept : SharedObject {std::move(other), 0}
+ {
+ }
+
+ /*
+ * Copy assignment operator.
+ */
+ SharedObject& operator=(const SharedObject& other) noexcept
+ {
+ /* Use generic "copy" assignment operator */
+ return this->operator=<ObjT, LibObjT>(other);
+ }
+
+ /*
+ * Move assignment operator.
+ */
+ SharedObject& operator=(SharedObject&& other) noexcept
+ {
+ /* Use generic "move" assignment operator */
+ return this->operator=<ObjT, LibObjT>(std::move(other));
+ }
+
+ /*
+ * Generic "copy" constructor.
+ *
+ * See the `friend class SharedObject` comment above.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject(const SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>& other) noexcept :
+ SharedObject {other, 0}
+ {
+ }
+
+ /*
+ * Generic "move" constructor.
+ *
+ * See the `friend class SharedObject` comment above.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject(SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>&& other) noexcept :
+ SharedObject {std::move(other), 0}
+ {
+ }
+
+ /*
+ * Generic "copy" assignment operator.
+ *
+ * See the `friend class SharedObject` comment above.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject& operator=(const SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>& other) noexcept
+ {
+ /* Put current object's reference */
+ this->_putRef();
+
+ /* Set new current object and get a reference */
+ _mObj = other._mObj;
+ this->_getRef();
+
+ return *this;
+ }
+
+ /*
+ * Generic "move" assignment operator.
+ *
+ * See the `friend class SharedObject` comment above.
+ */
+ template <typename OtherObjT, typename OtherLibObjT>
+ SharedObject& operator=(SharedObject<OtherObjT, OtherLibObjT, RefFuncsT>&& other) noexcept
+ {
+ /* Put current object's reference */
+ this->_putRef();
+
+ /* Set new current object */
+ _mObj = other._mObj;
+
+ /* Reset moved-from object */
+ other._reset();
+
+ return *this;
+ }
+
+ ~SharedObject()
+ {
+ this->_putRef();
+ }
+
+ ObjT& operator*() noexcept
+ {
+ BT_ASSERT_DBG(_mObj);
+ return *_mObj;
+ }
+
+ const ObjT& operator*() const noexcept
+ {
+ BT_ASSERT_DBG(_mObj);
+ return *_mObj;
+ }
+
+ ObjT *operator->() noexcept
+ {
+ BT_ASSERT_DBG(_mObj);
+ return &*_mObj;
+ }
+
+ const ObjT *operator->() const noexcept
+ {
+ BT_ASSERT_DBG(_mObj);
+ return &*_mObj;
+ }
+
+ /*
+ * Transfers the reference of the object which this shared object
+ * wrapper manages and returns it, making the caller become an
+ * active owner.
+ *
+ * This method makes this object invalid.
+ */
+ ObjT release() noexcept
+ {
+ BT_ASSERT_DBG(_mObj);
+ const auto obj = *_mObj;
+ this->_reset();
+ return obj;
+ }
+
+private:
+ /*
+ * Resets this shared object.
+ *
+ * To be used when moving it.
+ */
+ void _reset() noexcept
+ {
+ _mObj.reset();
+ }
+
+ /*
+ * Gets a new reference using the configured libbabeltrace2
+ * reference incrementation function.
+ */
+ void _getRef() const noexcept
+ {
+ if (_mObj) {
+ RefFuncsT::get(_mObj->libObjPtr());
+ }
+ }
+
+ /*
+ * Puts a reference using the configured libbabeltrace2 reference
+ * decrementation function.
+ */
+ void _putRef() const noexcept
+ {
+ if (_mObj) {
+ RefFuncsT::put(_mObj->libObjPtr());
+ }
+ }
+
+ nonstd::optional<ObjT> _mObj;
+};
+
+} /* namespace bt2 */
+
+#endif /* BABELTRACE_CPP_COMMON_BT2_SHARED_OBJECT_HPP */
#include "field-class.hpp"
#include "field.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
#include "value.hpp"
namespace bt2 {
ConstStructureField, StructureField>::type;
public:
- using Shared = SharedObj<_ThisCommonPacket, LibObjT, internal::PacketRefFuncs>;
+ using Shared = SharedObject<_ThisCommonPacket, LibObjT, internal::PacketRefFuncs>;
explicit CommonPacket(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
{
CommonTrace<bt_trace>>::type;
public:
- using Shared = SharedObj<_ThisCommonStream, LibObjT, internal::StreamRefFuncs>;
+ using Shared = SharedObject<_ThisCommonStream, LibObjT, internal::StreamRefFuncs>;
using Class = typename std::conditional<std::is_const<LibObjT>::value,
CommonStreamClass<const bt_stream_class>,
CommonStream<bt_stream>>::type;
public:
- using Shared = SharedObj<_ThisCommonTrace, LibObjT, internal::TraceRefFuncs>;
+ using Shared = SharedObject<_ThisCommonTrace, LibObjT, internal::TraceRefFuncs>;
using Class = typename std::conditional<std::is_const<LibObjT>::value,
CommonTraceClass<const bt_trace_class>,
StructureFieldClass>::type;
public:
- using Shared = SharedObj<_ThisCommonEventClass, LibObjT, internal::EventClassRefFuncs>;
+ using Shared = SharedObject<_ThisCommonEventClass, LibObjT, internal::EventClassRefFuncs>;
using UserAttributes =
typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
typename std::conditional<std::is_const<LibObjT>::value, ConstClockClass, ClockClass>::type;
public:
- using Shared = SharedObj<_ThisCommonStreamClass, LibObjT, internal::StreamClassRefFuncs>;
+ using Shared = SharedObject<_ThisCommonStreamClass, LibObjT, internal::StreamClassRefFuncs>;
using UserAttributes =
typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
CommonStreamClass<bt_stream_class>>::type;
public:
- using Shared = SharedObj<_ThisCommonTraceClass, LibObjT, internal::TraceClassRefFuncs>;
+ using Shared = SharedObject<_ThisCommonTraceClass, LibObjT, internal::TraceClassRefFuncs>;
using UserAttributes =
typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
#include "common-iter.hpp"
#include "exc.hpp"
#include "internal/utils.hpp"
-#include "shared-obj.hpp"
+#include "shared-object.hpp"
namespace bt2 {
namespace internal {
} /* namespace internal */
template <typename ObjT, typename LibObjT>
-using SharedValue = SharedObj<ObjT, LibObjT, internal::ValueRefFuncs>;
+using SharedValue = SharedObject<ObjT, LibObjT, internal::ValueRefFuncs>;
template <typename LibObjT>
class CommonNullValue;
projects / babeltrace.git / commitdiff
