summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/componentsortfilterproxymodel.cpp
blob: 9308d23567ec9f1d2054ca39bcc66037f7932bd1 (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/**************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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.
**
** $QT_END_LICENSE$
**
**************************************************************************/

#include "componentsortfilterproxymodel.h"

namespace QInstaller {

/*!
    \class QInstaller::ComponentSortFilterProxyModel
    \inmodule QtInstallerFramework
    \brief The ComponentSortFilterProxyModel provides support for sorting and
           filtering data passed between another model and a view.

           The class subclasses QSortFilterProxyModel. Compared to the base class,
           filters affect also child indexes in the base model, meaning if a
           certain row has a parent that is accepted by filter, it is also accepted.
           A distinction is made betweed directly and indirectly accepted indexes.
*/

/*!
    \enum ComponentSortFilterProxyModel::AcceptType

    This enum holds the possible values for filter acception type for model indexes.

    \value Direct
           Index was accepted directly by filter.
    \value Descendant
           Index is a descendant of an accepted index.
    \value Rejected
           Index was not accepted by filter.
*/

/*!
    Constructs object with \a parent.
*/
ComponentSortFilterProxyModel::ComponentSortFilterProxyModel(QObject *parent)
    : QSortFilterProxyModel(parent)
{
}

/*!
    Returns a list of source model indexes that were accepted directly by the filter.
*/
QVector<QModelIndex> ComponentSortFilterProxyModel::directlyAcceptedIndexes() const
{
    QVector<QModelIndex> indexes;
    for (int i = 0; i < rowCount(); i++) {
        QModelIndex childIndex = index(i, 0, QModelIndex());
        findDirectlyAcceptedIndexes(childIndex, indexes);
    }
    return indexes;
}

/*!
    Returns \c true if the item in the row indicated by the given \a sourceRow and
    \a sourceParent should be included in the model; otherwise returns \c false.
*/
bool ComponentSortFilterProxyModel::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
{
    return acceptsRow(sourceRow, sourceParent);
}

/*!
    Returns \c true if the item in the row indicated by the given \a sourceRow and
    \a sourceParent should be included in the model; otherwise returns \c false. The
    acception type can be retrieved with \a type.
*/
bool ComponentSortFilterProxyModel::acceptsRow(int sourceRow, const QModelIndex &sourceParent,
                                               AcceptType *type) const
{
    if (type)
        *type = AcceptType::Rejected;

    if (QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent)) {
        if (type)
            *type = AcceptType::Direct;
        return true;
    }

    if (!isRecursiveFilteringEnabled()) // filter not applied for children
        return false;

    if (!sourceParent.isValid()) // already root
        return false;

    int currentRow = sourceParent.row();
    QModelIndex currentParent = sourceParent.parent();
    // Ascend and check if any parent is accepted
    forever {
        if (QSortFilterProxyModel::filterAcceptsRow(currentRow, currentParent)) {
            if (type)
                *type = AcceptType::Descendant;
            return true;
        }
        if (!currentParent.isValid()) // we hit a root node
            break;

        currentRow = currentParent.row();
        currentParent = currentParent.parent();
    }
    return false;
}

/*!
    Finds directly accepted child \a indexes for parent index \a in. Returns \c true
    if at least one accepted index was found, \c false otherwise.
*/
bool ComponentSortFilterProxyModel::findDirectlyAcceptedIndexes(const QModelIndex &in, QVector<QModelIndex> &indexes) const
{
    bool found = false;
    for (int i = 0; i < rowCount(in); i++) {
        if (findDirectlyAcceptedIndexes(index(i, 0, in), indexes))
            found = true;
    }
    if (!hasChildren(in) || !found) { // No need to check current if any child matched
        AcceptType acceptType;
        const QModelIndex sourceIndex = mapToSource(in);
        acceptsRow(sourceIndex.row(), sourceIndex.parent(), &acceptType);
        if (acceptType == AcceptType::Direct) {
            indexes.append(in);
            found = true;
        }
    }
    return found;
}

} // namespace QInstaller