semantichighlighter.h 3.02 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** 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.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
30

31 32
#ifndef SEMANTICHIGHLIGHTER_H
#define SEMANTICHIGHLIGHTER_H
33 34

#include "cpptools_global.h"
35

36 37
#include <QFutureWatcher>
#include <QScopedPointer>
38
#include <QTextCharFormat>
39

40
#include <functional>
41

42 43 44 45 46
namespace TextEditor {
class HighlightingResult;
class TextDocument;
}

47 48
namespace CppTools {

49
class CPPTOOLS_EXPORT SemanticHighlighter : public QObject
50
{
51 52 53
    Q_OBJECT
    Q_DISABLE_COPY(SemanticHighlighter)

54
public:
Erik Verbruggen's avatar
Erik Verbruggen committed
55 56 57 58 59 60 61 62 63 64
    enum Kind {
        Unknown = 0,
        TypeUse,
        LocalUse,
        FieldUse,
        EnumerationUse,
        VirtualMethodUse,
        LabelUse,
        MacroUse,
        FunctionUse,
65 66
        PseudoKeywordUse,
        StringUse
Erik Verbruggen's avatar
Erik Verbruggen committed
67
    };
68

69 70
    typedef std::function<QFuture<TextEditor::HighlightingResult> ()> HighlightingRunner;

71
public:
72
    explicit SemanticHighlighter(TextEditor::TextDocument *baseTextDocument);
73 74 75
    ~SemanticHighlighter();

    void setHighlightingRunner(HighlightingRunner highlightingRunner);
76

77
    void run();
78

79 80
private slots:
    void onDocumentFontSettingsChanged();
81

82 83
    void onHighlighterResultAvailable(int from, int to);
    void onHighlighterFinished();
84

85 86 87 88 89 90
private:
    void connectWatcher();
    void disconnectWatcher();

    unsigned documentRevision() const;
    void updateFormatMapFromFontSettings();
91 92

private:
93
    TextEditor::TextDocument *m_baseTextDocument;
94 95 96 97 98 99

    unsigned m_revision;
    QScopedPointer<QFutureWatcher<TextEditor::HighlightingResult>> m_watcher;
    QHash<int, QTextCharFormat> m_formatMap;

    HighlightingRunner m_highlightingRunner;
100 101
};

102
} // namespace CppTools
103

104
#endif // SEMANTICHIGHLIGHTER_H