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
|
/*
<one line to give the program's name and a brief idea of what it does.>
Copyright 2010 David Nolden <david.nolden.kdevelop@art-master.de>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef KDEVPLATFORM_PERSISTENTMOVINGRANGE_H
#define KDEVPLATFORM_PERSISTENTMOVINGRANGE_H
#include <language/languageexport.h>
#include <KTextEditor/Attribute>
#include <KTextEditor/Range>
#include <QExplicitlySharedDataPointer>
namespace KDevelop {
class IndexedString;
class PersistentMovingRangePrivate;
/**
* A range object that is automatically adapted to all changes a user does to a document. The object
* also survives when the document is opened or closed, as long as the document is only edited from within
* the application.
*
* This object must only be used from within the foreground, or with the foreground lock held.
*
* @todo The implementation of this object is not finished yet, the range is only persistent until the
* document is closed/reloaded/cleared.
* */
class KDEVPLATFORMLANGUAGE_EXPORT PersistentMovingRange
: public QSharedData
{
public:
using Ptr = QExplicitlySharedDataPointer<PersistentMovingRange>;
/**
* Creates a new persistent moving range based on the current revision of the given document
* */
PersistentMovingRange(const KTextEditor::Range& range, const IndexedString& document, bool shouldExpand = false);
~PersistentMovingRange();
PersistentMovingRange(const PersistentMovingRange&) = delete;
PersistentMovingRange& operator=(const PersistentMovingRange& rhs) = delete;
IndexedString document() const;
/**
* Returns the range in the current revision of the document
*/
KTextEditor::Range range() const;
/**
* Changes the z-depth for highlighting (see KTextEditor::MovingRange)
* */
void setZDepth(float depth) const;
/**
* Returns the text contained by the range. Currently only works when the range is open in the editor.
* */
QString text() const;
/**
* Change the highlighting attribute.
* */
void setAttribute(const KTextEditor::Attribute::Ptr& attribute);
/**
* Whether this range is still valid. The range is invalidated if the document is changed externally,
* as such a change can not be tracked correctly.
* */
bool valid() const;
private:
PersistentMovingRangePrivate* m_p;
};
}
#endif // KDEVPLATFORM_PERSISTENTMOVINGRANGE_H
|
