1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include <debugger/analyzer/diagnosticlocation.h>
29 
30 #include <QMetaType>
31 #include <QString>
32 #include <QVector>
33 
34 namespace ClangTools {
35 namespace Internal {
36 
37 class ExplainingStep
38 {
39 public:
40     bool isValid() const;
41     bool operator<(const ExplainingStep &other) const {
42         return std::tie(location, ranges, message)
43                < std::tie(other.location, other.ranges, other.message);
44     }
45 
46     QString message;
47     Debugger::DiagnosticLocation location;
48     QVector<Debugger::DiagnosticLocation> ranges;
49     bool isFixIt = false;
50 };
51 
52 class Diagnostic
53 {
54 public:
55     bool isValid() const;
56     QIcon icon() const;
57 
58     QString name;
59     QString description;
60     QString category;
61     QString type;
62     Debugger::DiagnosticLocation location;
63     QVector<ExplainingStep> explainingSteps;
64     bool hasFixits = false;
65 };
66 
67 bool operator==(const Diagnostic &lhs, const Diagnostic &rhs);
68 
69 using Diagnostics = QList<Diagnostic>;
70 
71 quint32 qHash(const Diagnostic &diagnostic);
72 
73 } // namespace Internal
74 } // namespace ClangTools
75 
76 Q_DECLARE_METATYPE(ClangTools::Internal::Diagnostic)
77