8#ifndef META_OCEAN_BASE_SCOPED_OBJECT_H
9#define META_OCEAN_BASE_SCOPED_OBJECT_H
26template <
typename T,
typename TReleaseValue = T,
typename TReleaseFunction =
void(*)(TReleaseValue)>
47 ScopedObjectT(T&&
object, TReleaseFunction&& releaseFunction)
noexcept;
56 ScopedObjectT(T&&
object, TReleaseFunction&& releaseFunction,
const bool useReleaseFunction)
noexcept;
63 ScopedObjectT(
const T&
object, TReleaseFunction&& releaseFunction)
noexcept;
72 ScopedObjectT(
const T&
object, TReleaseFunction&& releaseFunction,
const bool useReleaseFunction)
noexcept;
154template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue = NotVo
idTyper<TReleaseReturn>::defaultValue(),
bool tCheckReturnValue = true, T tInval
idValue = T()>
248 ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>&
operator=(
ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>&& scopedObject)
noexcept;
279template <
typename T,
void (*tReleaseFunction)(T)>
282template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
285 *
this = std::move(scopedObject);
288template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
296template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
300 if (useReleaseFunction)
306template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
314template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
318 if (useReleaseFunction)
324template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
330template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
336template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
342template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
350template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
358template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
370template <
typename T,
typename TReleaseValue,
typename TReleaseFunction>
373 if (
this != &scopedObject)
377 object_ = std::move(scopedObject.object_);
378 scopedObject.object_ = T();
381 scopedObject.releaseFunction_ = TReleaseFunction();
387template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
388ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>::ScopedObjectCompileTimeT(
ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>&& scopedObject)
noexcept
390 *
this = std::move(scopedObject);
393template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
400template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
408template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
415template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
423template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
429template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
432 return object_ != tInvalidValue;
435template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
441template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
449template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
457template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
468template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
473 if constexpr (std::is_same<TReleaseReturn, void>::value)
475 tReleaseFunction(TReleaseValue(
object_));
479 if constexpr (tCheckReturnValue)
481 const TReleaseReturn returnValue = tReleaseFunction(TReleaseValue(
object_));
482 ocean_assert_and_suppress_unused(returnValue == tExpectedReturnValue, returnValue);
486 const TReleaseReturn returnValue = tReleaseFunction(TReleaseValue(
object_));
487 OCEAN_SUPPRESS_UNUSED_WARNING(returnValue);
496template <
typename T,
typename TReleaseValue,
typename TReleaseReturn, TReleaseReturn (*tReleaseFunction)(TReleaseValue),
typename NotVo
idTyper<TReleaseReturn>::Type tExpectedReturnValue,
bool tCheckReturnValue, T tInval
idValue>
497ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>&
ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>::operator=(
ScopedObjectCompileTimeT<T, TReleaseValue, TReleaseReturn, tReleaseFunction, tExpectedReturnValue, tCheckReturnValue, tInvalidValue>&& scopedObject)
noexcept
499 if (
this != &scopedObject)
503 object_ = std::move(scopedObject.object_);
504 scopedObject.object_ = tInvalidValue;
507 scopedObject.needsRelease_ =
false;
This class wraps an unmanaged object (or reference) which needs to be released after usage.
Definition ScopedObject.h:156
ScopedObjectCompileTimeT & operator=(const ScopedObjectCompileTimeT< T, T, void, tReleaseFunction, NotVoidTyper< void >::defaultValue(), true, T() > &)=delete
bool needsRelease_
Definition ScopedObject.h:269
ScopedObjectCompileTimeT(T &&object, const bool needsRelease) noexcept
ScopedObjectCompileTimeT(T &&object) noexcept
ScopedObjectCompileTimeT(const T &object, const bool needsRelease)
ScopedObjectCompileTimeT()=default
Default constructor creating an object with invalid object.
ScopedObjectCompileTimeT(const ScopedObjectCompileTimeT< T, T, void, tReleaseFunction, NotVoidTyper< void >::defaultValue(), true, T() > &)=delete
ScopedObjectCompileTimeT< T, T, void, tReleaseFunction, NotVoidTyper< void >::defaultValue(), true, T() > & operator=(ScopedObjectCompileTimeT< T, T, void, tReleaseFunction, NotVoidTyper< void >::defaultValue(), true, T() > &&scopedObject) noexcept
T object_
Definition ScopedObject.h:266
const T & operator*() const
ScopedObjectCompileTimeT(ScopedObjectCompileTimeT< T, T, void, tReleaseFunction, NotVoidTyper< void >::defaultValue(), true, T() > &&scopedObject) noexcept
~ScopedObjectCompileTimeT()
ScopedObjectCompileTimeT(const T &object)
T & resetObject(const bool needsRelease=true)
const T & operator->() const
ScopedObjectT< T, TReleaseValue, TReleaseFunction > & operator=(const ScopedObjectT< T, TReleaseValue, TReleaseFunction > &)=delete
Disabled assign operator.
T object_
The wrapped reference.
Definition ScopedObject.h:135
const T & operator*() const
De-reference operator returning the wrapped object.
Definition ScopedObject.h:351
void release()
Explicitly releases the wrapped object.
Definition ScopedObject.h:359
~ScopedObjectT()
Destructs this scoped object and releases the internal wrapped object.
Definition ScopedObject.h:325
TReleaseFunction releaseFunction_
The function used to release the wrapped object.
Definition ScopedObject.h:138
ScopedObjectT()=default
Default constructor creating an object with invalid object.
const T & operator->() const
Arrow operator returning the wrapped object.
Definition ScopedObject.h:343
ScopedObjectT< T, TReleaseValue, TReleaseFunction > & operator=(ScopedObjectT< T, TReleaseValue, TReleaseFunction > &&scopedObject) noexcept
Move operator.
Definition ScopedObject.h:371
ScopedObjectT(const ScopedObjectT< T, TReleaseValue, TReleaseFunction > &)=delete
Disabled copy constructor.
bool isValid() const
Returns whether this scoped object holds a valid release function (which will be invoked once the obj...
Definition ScopedObject.h:331
const T & object() const
Returns the wrapped object.
Definition ScopedObject.h:337
ScopedObjectCompileTimeT< T, T, void, tReleaseFunction > ScopedObjectCompileTimeVoidT
Template specialization for ScopedObjectCompileTimeT with void return value.
Definition ScopedObject.h:280
The namespace covering the entire Ocean framework.
Definition Accessor.h:15