summaryrefslogtreecommitdiff
path: root/src/plugins/cpptools/cppfileiterationorder.h
blob: aecd17d0360578cf1c65e935579fa55168a6e4f3 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef FILEITERATIONORDER_H
#define FILEITERATIONORDER_H

#include "cpptools_global.h"

#include <QStringList>

#include <set>

namespace CppTools {

class CPPTOOLS_EXPORT FileIterationOrder {
public:
    struct Entry {
        Entry(const QString &filePath,
              const QString &projectPartId = QString(),
              int commonFilePathPrefixLength = 0,
              int commonProjectPartPrefixLength = 0);

        friend CPPTOOLS_EXPORT bool operator<(const Entry &first, const Entry &second);

        const QString filePath;
        const QString projectPartId;
        int commonFilePathPrefixLength = 0;
        int commonProjectPartPrefixLength = 0;
    };

    FileIterationOrder();
    FileIterationOrder(const QString &referenceFilePath,
                       const QString &referenceProjectPartId);

    void setReference(const QString &filePath, const QString &projectPartId);
    bool isValid() const;

    void insert(const QString &filePath, const QString &projectPartId = QString());
    void remove(const QString &filePath, const QString &projectPartId);
    QStringList toStringList() const;

private:
    Entry createEntryFromFilePath(const QString &filePath,
                                  const QString &projectPartId) const;

private:
    QString m_referenceFilePath;
    QString m_referenceProjectPartId;
    std::multiset<Entry> m_set;
};

CPPTOOLS_EXPORT bool operator<(const FileIterationOrder::Entry &first,
                               const FileIterationOrder::Entry &second);

} // namespace CppTools

#endif // FILEITERATIONORDER_H