blob: 3003a9b7cbf771e7c548eaced157679e9f235e98 (
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
|
/*
SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>
SPDX-License-Identifier: MIT
*/
#ifndef KSYNTAXHIGHLIGHTING_STATE_H
#define KSYNTAXHIGHLIGHTING_STATE_H
#include "ksyntaxhighlighting_export.h"
#include <QExplicitlySharedDataPointer>
#include <QHash>
namespace KSyntaxHighlighting
{
class State;
class StateData;
KSYNTAXHIGHLIGHTING_EXPORT std::size_t qHash(const State &state, std::size_t seed = 0);
/** Opaque handle to the state of the highlighting engine.
* This needs to be fed into AbstractHighlighter for every line of text
* and allows concrete highlighter implementations to store state per
* line for fast re-highlighting of specific lines (e.g. during editing).
*
* @since 5.28
*/
class KSYNTAXHIGHLIGHTING_EXPORT State
{
public:
/** Creates an initial state, ie. what should be used for the first line
* in a document.
*/
State();
State(State &&other) noexcept;
State(const State &other) noexcept;
~State();
State &operator=(State &&rhs) noexcept;
State &operator=(const State &rhs) noexcept;
/** Compares two states for equality.
* For two equal states and identical text input, AbstractHighlighter
* guarantees to produce equal results. This can be used to only
* re-highlight as many lines as necessary during editing.
*/
bool operator==(const State &other) const;
/** Compares two states for inequality.
* This is the opposite of operator==().
*/
bool operator!=(const State &other) const;
/**
* Returns whether or not indentation-based folding is enabled in this state.
* When using a Definition with indentation-based folding, use
* this method to check if indentation-based folding has been
* suspended in the current line.
*
* @see Definition::indentationBasedFoldingEnabled()
*/
bool indentationBasedFoldingEnabled() const;
private:
friend class StateData;
KSYNTAXHIGHLIGHTING_EXPORT friend std::size_t qHash(const State &, std::size_t);
QExplicitlySharedDataPointer<StateData> d;
};
}
QT_BEGIN_NAMESPACE
Q_DECLARE_TYPEINFO(KSyntaxHighlighting::State, Q_RELOCATABLE_TYPE);
QT_END_NAMESPACE
#endif // KSYNTAXHIGHLIGHTING_STATE_H
|
