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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
****************************************************************************/
#include "assistinterface.h"
using namespace TextEditor;
/*!
\class TextEditor::AssistInterface
\brief The AssistInterface class acts as an interface for providing access
to the document from which a proposal is computed.
\ingroup CodeAssist
This interface existis in order to avoid a direct dependency on the text editor. This is
particularly important and safer for asynchronous providers, since in such cases computation
of the proposal is not done in the GUI thread.
In general this API tries to be as decoupled as possible from the base text editor.
This is in order to make the design a bit more generic and allow code assist to be
pluggable into different types of documents (there are still issues to be treated).
This class is part of the CodeAssist API.
\sa IAssistProposal, IAssistProvider, IAssistProcessor
*/
/*!
\fn int TextEditor::AssistInterface::position() const
Returns the cursor position.
*/
/*!
\fn QChar TextEditor::AssistInterface::characterAt(int position) const
Returns the character at \a position.
*/
/*!
\fn QString TextEditor::AssistInterface::textAt(int position, int length) const
Returns the text at \a position with the given \a length.
*/
/*!
\fn QString TextEditor::AssistInterface::fileName() const
Returns the file associated.
*/
/*!
\fn QTextDocument *TextEditor::AssistInterface::textDocument() const
Returns the document.
*/
/*!
\fn void TextEditor::AssistInterface::detach(QThread *destination)
Detaches the interface. If it is necessary to take any special care in order to allow
this interface to be run in a separate thread \a destination this needs to be done
in this function.
*/
/*!
\fn AssistReason TextEditor::AssistInterface::reason() const
The reason which triggered the assist.
*/
#include "assistinterface.h"
#include <utils/textutils.h>
#include <QTextBlock>
#include <QTextDocument>
#include <QTextCursor>
#include <utils/qtcassert.h>
namespace TextEditor {
AssistInterface::AssistInterface(const QTextCursor &cursor,
const Utils::FilePath &filePath,
AssistReason reason)
: m_textDocument(cursor.document())
, m_cursor(cursor)
, m_isAsync(false)
, m_position(cursor.position())
, m_anchor(cursor.anchor())
, m_filePath(filePath)
, m_reason(reason)
{}
AssistInterface::~AssistInterface()
{
if (m_isAsync)
delete m_textDocument;
}
QChar AssistInterface::characterAt(int position) const
{
return m_textDocument->characterAt(position);
}
QString AssistInterface::textAt(int pos, int length) const
{
return Utils::Text::textAt(QTextCursor(m_textDocument), pos, length);
}
void AssistInterface::prepareForAsyncUse()
{
m_text = m_textDocument->toPlainText();
m_userStates.reserve(m_textDocument->blockCount());
for (QTextBlock block = m_textDocument->firstBlock(); block.isValid(); block = block.next())
m_userStates.append(block.userState());
m_textDocument = nullptr;
m_isAsync = true;
}
void AssistInterface::recreateTextDocument()
{
m_textDocument = new QTextDocument(m_text);
m_cursor = QTextCursor(m_textDocument);
m_cursor.setPosition(m_anchor);
m_cursor.setPosition(m_position, QTextCursor::KeepAnchor);
m_text.clear();
QTC_CHECK(m_textDocument->blockCount() == m_userStates.count());
QTextBlock block = m_textDocument->firstBlock();
for (int i = 0; i < m_userStates.count() && block.isValid(); ++i, block = block.next())
block.setUserState(m_userStates[i]);
}
AssistReason AssistInterface::reason() const
{
return m_reason;
}
} // namespace TextEditor
|
