aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/corelib/tools/codelocation.h
blob: afcd2e07598cf12c9391c851e65cf2bab1a2e1b7 (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
153
154
155
156
157
158
159
160
161
162
163
164
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QBS_SOURCELOCATION_H
#define QBS_SOURCELOCATION_H

#include "qbs_export.h"

#include <QtCore/qdebug.h>
#include <QtCore/qshareddata.h>

QT_BEGIN_NAMESPACE
class QDataStream;
class QJsonObject;
class QString;
QT_END_NAMESPACE

namespace qbs {
namespace Internal { class PersistentPool; }

class QBS_EXPORT CodeLocation
{
    friend QBS_EXPORT bool operator==(const CodeLocation &cl1, const CodeLocation &cl2);
public:
    CodeLocation();
    explicit CodeLocation(const QString &aFilePath, int aLine = -1, int aColumn = -1,
                          bool checkPath = true);
    CodeLocation(const CodeLocation &other);
    CodeLocation(CodeLocation &&other) noexcept;
    CodeLocation &operator=(const CodeLocation &other);
    CodeLocation &operator=(CodeLocation &&other) noexcept;
    ~CodeLocation();

    QString filePath() const;
    int line() const;
    int column() const;

    bool isValid() const;
    QString toString() const;
    QJsonObject toJson() const;

    void load(Internal::PersistentPool &pool);
    void store(Internal::PersistentPool &pool) const;

private:
    class CodeLocationPrivate;
    QExplicitlySharedDataPointer<CodeLocationPrivate> d;
};

QBS_EXPORT bool operator==(const CodeLocation &cl1, const CodeLocation &cl2);
QBS_EXPORT bool operator!=(const CodeLocation &cl1, const CodeLocation &cl2);
QBS_EXPORT bool operator<(const CodeLocation &cl1, const CodeLocation &cl2);
inline auto qHash(const CodeLocation &cl) { return qHash(cl.toString()); }
QDebug operator<<(QDebug debug, const CodeLocation &location);

class QBS_EXPORT CodePosition
{
public:
    CodePosition(int line, int column) : m_line(line), m_column(column) {}

    CodePosition() = default;
    CodePosition(const CodePosition &other) = default;
    CodePosition(CodePosition &&other) = default;
    CodePosition &operator=(const CodePosition &other) = default;
    CodePosition &operator=(CodePosition &&other) = default;

    int line() const { return m_line; }
    void setLine(int newLine) { m_line = newLine; }

    int column() const { return m_column; }
    void setColumn(int newColumn) { m_column = newColumn; }

    void load(Internal::PersistentPool &pool);
    void store(Internal::PersistentPool &pool) const;

private:
    int m_line = 0;
    int m_column = 0;
};

QBS_EXPORT bool operator==(const CodePosition &pos1, const CodePosition &pos2);
QBS_EXPORT bool operator!=(const CodePosition &pos1, const CodePosition &pos2);
QBS_EXPORT bool operator<(const CodePosition &pos1, const CodePosition &pos2);
QBS_EXPORT bool operator>(const CodePosition &pos1, const CodePosition &pos2);
QBS_EXPORT bool operator<=(const CodePosition &pos1, const CodePosition &pos2);
QBS_EXPORT bool operator>=(const CodePosition &pos1, const CodePosition &pos2);
inline auto qHash(const CodePosition &pos)
{
    return QT_PREPEND_NAMESPACE(qHash)(pos.line()) ^ QT_PREPEND_NAMESPACE(qHash)(pos.column());
}

class QBS_EXPORT CodeRange
{
public:
    CodeRange(const CodePosition &start, const CodePosition &end);

    CodeRange() = default;
    CodeRange(const CodeRange &other) = default;
    CodeRange(CodeRange &&other) = default;
    CodeRange &operator=(const CodeRange &other) = default;
    CodeRange &operator=(CodeRange &&other) = default;

    const CodePosition &start() const & { return m_start; }
    const CodePosition &end() const & { return m_end; }
    CodePosition start() && { return std::move(m_start); }
    CodePosition end() && { return std::move(m_end); }

    bool contains(const CodePosition &pos) const;

    void load(Internal::PersistentPool &pool);
    void store(Internal::PersistentPool &pool) const;

private:
    CodePosition m_start;
    CodePosition m_end;
};

QBS_EXPORT bool operator==(const CodeRange &r1, const CodeRange &r2);
QBS_EXPORT bool operator!=(const CodeRange &r1, const CodeRange &r2);
QBS_EXPORT bool operator<(const CodeRange &r1, const CodeRange &r2);
inline auto qHash(const CodeRange &range) { return qHash(range.start()) ^ qHash(range.end()); }

using CodeLinksInFile = QHash<CodeRange, QList<CodeLocation>>;
using CodeLinks = QHash<QString, CodeLinksInFile>;

} // namespace qbs

#endif // QBS_SOURCELOCATION_H