aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/objectpool.h
blob: 7c705e52b8e135458fa51475e7071d7eedcc94c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "utils_global.h"

#include <QPointer>
#include <QList>

/*!
    \class ObjectPool

    The ObjectPool class template provides parts of the functionality of the
    global PluginManager object pool but is intented to be used with smaller
    set of objects, typically with same base type (e.g. factories) only.

    The ObjectPool takes ownership of add items if and only if the item
    does not have a QObject parent.

    Items owned by the ObjectPool are destructed when the pool is destructed,
    the other items are taken care of by their QObject parent according to
    the usual parent/child behavior.

*/

namespace Utils {

template <typename T>
class ObjectPool
{
public:
    ObjectPool() {}

    ~ObjectPool()
    {
        for (const QPointer<T> &ptr : m_objects) {
            if (!ptr.isNull() && !ptr->parent())
                delete ptr.data();
        }
    }

    int size() const
    {
        int res = 0;
        for (const QPointer<T> &ptr : m_objects)
            res += ptr.data() != nullptr;
        return res;
    }

    void addObject(T *t)
    {
        m_objects.append(t);
    }

    template <typename Func>
    void forEachObject(const Func &func) const
    {
        for (const QPointer<T> &ptr : m_objects) {
            if (!ptr.isNull())
                func(ptr.data());
        }
    }

    template <typename Func>
    T *findObject(const Func &func) const
    {
        for (const QPointer<T> &ptr : m_objects) {
            if (!ptr.isNull() && func(ptr.data()))
                return ptr.data();
        }
        return nullptr;
    }

private:
    ObjectPool(const ObjectPool &) = delete;
    ObjectPool &operator=(const ObjectPool &) = delete;

    QList<QPointer<T>> m_objects;
};

} // namespace Utils