-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Introduce "parented_ptr" wrapper class #1142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| #ifndef UTIL_PARENTED_POINTER_H | ||
| #define UTIL_PARENTED_POINTER_H | ||
|
|
||
| #include <memory> | ||
| #include "util/assert.h" | ||
|
|
||
|
|
||
| /** | ||
| * Use this wrapper class to clearly represent a pointer that is owned by the QT object tree. | ||
| * Objects which both derive from QObject AND have a parent object, have their lifetime governed by the QT object tree, | ||
| * and thus pointers to such objects do not need to be deleted when they go out of scope. | ||
| **/ | ||
| template <typename T> | ||
| class parented_ptr { | ||
| public: | ||
| explicit parented_ptr(T* t) : m_pObject(t) { | ||
| DEBUG_ASSERT(t->parent() != nullptr); | ||
| } | ||
|
|
||
| /* If U* is convertible to T* then we also want parented_ptr<U> convertible to parented_ptr<T> */ | ||
| template <typename U> | ||
| parented_ptr(const parented_ptr<U>& u, typename std::enable_if<std::is_convertible<U*, T*>::value, void>::type * = 0) | ||
| : m_pObject(u.get()) { | ||
| DEBUG_ASSERT(u->parent() != nullptr); | ||
| } | ||
|
|
||
| parented_ptr() : m_pObject(nullptr) {} | ||
|
|
||
| ~parented_ptr() = default; | ||
|
|
||
| T* get() const { | ||
| return m_pObject; | ||
| } | ||
|
|
||
| T& operator* () const { | ||
| return *m_pObject; | ||
| } | ||
|
|
||
| T* operator-> () const { | ||
| return m_pObject; | ||
| } | ||
|
|
||
| bool operator== (const parented_ptr& other) const { | ||
| return m_pObject == other.m_ptr; | ||
| } | ||
|
|
||
| bool operator== (const T* other) const { | ||
| return m_pObject == other; | ||
| } | ||
|
|
||
| bool operator!= (const parented_ptr& other) const { | ||
| return m_pObject != other.m_pObject; | ||
| } | ||
|
|
||
| bool operator!= (const T* other) const { | ||
| return m_pObject != other; | ||
| } | ||
|
|
||
| operator bool() const { | ||
| return m_pObject != nullptr; | ||
| } | ||
|
|
||
| /* | ||
| * If U* is convertible to T* then we also want parented_ptr<U> assignable to parented_ptr<T> | ||
| * E.g. parented_ptr<Base> base = make_parented<Derived>(); should work as expected. | ||
| */ | ||
| template <typename U> | ||
| typename std::enable_if<std::is_convertible<U*, T*>::value, parented_ptr<T>&>::type | ||
| operator=(const parented_ptr<U>& p) { | ||
| m_pObject = p.get(); | ||
| return *this; | ||
| } | ||
|
|
||
| private: | ||
| T* m_pObject; | ||
| }; | ||
|
|
||
| namespace { | ||
|
|
||
| template<typename T, typename... Args> | ||
| inline parented_ptr<T> make_parented(Args&&... args) { | ||
| return parented_ptr<T>(new T(std::forward<Args>(args)...)); | ||
| } | ||
|
|
||
|
|
||
| } // namespace | ||
|
|
||
| #endif /* UTIL_PARENTED_POINTER_H */ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Compare operators with the raw pointer can also be handy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done