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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
|
/*
* This file is part of KDevelop
* Copyright 2014 Milian Wolff <mail@milianw.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) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* 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, see <http://www.gnu.org/licenses/>.
*/
#include "model.h"
#include "util/clangdebug.h"
#include "context.h"
#include "includepathcompletioncontext.h"
#include "duchain/parsesession.h"
#include "duchain/clangindex.h"
#include "duchain/duchainutils.h"
#include <language/codecompletion/codecompletionworker.h>
#include <language/duchain/topducontext.h>
#include <language/duchain/duchainutils.h>
#include <language/duchain/duchainlock.h>
#include <KTextEditor/View>
#include <KTextEditor/Document>
#include <QTimer>
using namespace KDevelop;
namespace {
bool isSpaceOnly(const QString& string)
{
return std::find_if(string.begin(), string.end(), [] (const QChar c) { return !c.isSpace(); }) == string.end();
}
bool includePathCompletionRequired(const QString& text)
{
const auto properties = IncludePathProperties::parseText(text);
return properties.valid;
}
QSharedPointer<CodeCompletionContext> createCompletionContext(const DUContextPointer& context,
const ParseSessionData::Ptr& session,
const QUrl& url,
const KTextEditor::Cursor& position,
const QString& text,
const QString& followingText)
{
if (includePathCompletionRequired(text)) {
return QSharedPointer<IncludePathCompletionContext>::create(context, session, url, position, text);
} else {
return QSharedPointer<ClangCodeCompletionContext>::create(context, session, url, position, text, followingText);
}
}
class ClangCodeCompletionWorker : public CodeCompletionWorker
{
Q_OBJECT
public:
ClangCodeCompletionWorker(ClangIndex* index, CodeCompletionModel* model)
: CodeCompletionWorker(model)
, m_index(index)
{}
~ClangCodeCompletionWorker() override = default;
public Q_SLOTS:
void completionRequested(const QUrl &url, const KTextEditor::Cursor& position, const QString& text, const QString& followingText)
{
// group requests and only handle the latest one
m_url = url;
m_position = position;
m_text = text;
m_followingText = followingText;
if (!m_timer) {
// lazy-load the timer to initialize it in the background thread
m_timer = new QTimer(this);
m_timer->setInterval(0);
m_timer->setSingleShot(true);
connect(m_timer, &QTimer::timeout, this, &ClangCodeCompletionWorker::run);
}
m_timer->start();
}
private:
void run()
{
aborting() = false;
DUChainReadLocker lock;
if (aborting()) {
failed();
return;
}
auto top = DUChainUtils::standardContextForUrl(m_url);
if (!top) {
qCWarning(KDEV_CLANG) << "No context found for" << m_url;
return;
}
ParseSessionData::Ptr sessionData(ClangIntegration::DUChainUtils::findParseSessionData(top->url(), m_index->translationUnitForUrl(top->url())));
if (!sessionData) {
// TODO: trigger reparse and re-request code completion
qCWarning(KDEV_CLANG) << "No parse session / AST attached to context for url" << m_url;
return;
}
if (aborting()) {
failed();
return;
}
// We hold DUChain lock, and ask for ParseSession, but TUDUChain indirectly holds ParseSession lock.
lock.unlock();
auto completionContext = ::createCompletionContext(DUContextPointer(top), sessionData, m_url,
m_position, m_text, m_followingText);
lock.lock();
if (aborting()) {
failed();
return;
}
bool abort = false;
// NOTE: cursor might be wrong here, but shouldn't matter much I hope...
// when the document changed significantly, then the cache is off anyways and we don't get anything sensible
// the position here is just a "optimization" to only search up to that position
const auto& items = completionContext->completionItems(abort);
if (aborting()) {
failed();
return;
}
auto tree = computeGroups( items, {} );
if (aborting()) {
failed();
return;
}
tree += completionContext->ungroupedElements();
foundDeclarations( tree, {} );
}
private:
ClangIndex* m_index;
QTimer* m_timer = nullptr;
QUrl m_url;
KTextEditor::Cursor m_position;
QString m_text;
QString m_followingText;
};
}
ClangCodeCompletionModel::ClangCodeCompletionModel(ClangIndex* index, QObject* parent)
: CodeCompletionModel(parent)
, m_index(index)
{
qRegisterMetaType<KTextEditor::Cursor>();
}
ClangCodeCompletionModel::~ClangCodeCompletionModel()
{
}
bool ClangCodeCompletionModel::shouldStartCompletion(KTextEditor::View* view, const QString& inserted,
bool userInsertion, const KTextEditor::Cursor& position)
{
const QString noCompletionAfter = QStringLiteral(";{}]) ");
if (inserted.isEmpty() || isSpaceOnly(inserted)) {
return false;
}
const auto lastChar = inserted.at(inserted.size() - 1);
if (noCompletionAfter.contains(lastChar)) {
return false;
}
const auto wordAtPosition = view->document()->wordAt(position);
if (!wordAtPosition.isEmpty() && wordAtPosition.at(0).isDigit()) {
return false;
}
// also show include path completion after dashes
if (userInsertion && lastChar == QLatin1Char('-') && includePathCompletionRequired(view->document()->line(position.line()))) {
return true;
}
if (userInsertion && inserted.endsWith(QLatin1String("::"))) {
return true;
}
return KDevelop::CodeCompletionModel::shouldStartCompletion(view, inserted, userInsertion, position);
}
KTextEditor::Range ClangCodeCompletionModel::completionRange(KTextEditor::View* view, const KTextEditor::Cursor& position)
{
auto range = KDevelop::CodeCompletionModel::completionRange(view, position);
const auto includeProperties = IncludePathProperties::parseText(view->document()->line(position.line()), position.column());
if (includeProperties.valid && includeProperties.inputFrom != -1) {
// expand include path range to include e.g. dashes
range.setStart({position.line(), includeProperties.inputFrom});
}
return range;
}
bool ClangCodeCompletionModel::shouldAbortCompletion(KTextEditor::View* view, const KTextEditor::Range& range, const QString& currentCompletion)
{
const auto shouldAbort = KDevelop::CodeCompletionModel::shouldAbortCompletion(view, range, currentCompletion);
if (shouldAbort && includePathCompletionRequired(view->document()->line(range.end().line()))) {
// don't abort include path completion which can contain dashes
return false;
}
return shouldAbort;
}
CodeCompletionWorker* ClangCodeCompletionModel::createCompletionWorker()
{
auto worker = new ClangCodeCompletionWorker(m_index, this);
connect(this, &ClangCodeCompletionModel::requestCompletion,
worker, &ClangCodeCompletionWorker::completionRequested);
return worker;
}
void ClangCodeCompletionModel::completionInvokedInternal(KTextEditor::View* view, const KTextEditor::Range& range,
CodeCompletionModel::InvocationType /*invocationType*/, const QUrl &url)
{
auto text = view->document()->text({0, 0, range.start().line(), range.start().column()});
auto followingText = view->document()->text({{range.start().line(), range.start().column()}, view->document()->documentEnd()});
emit requestCompletion(url, KTextEditor::Cursor(range.start()), text, followingText);
}
#include "model.moc"
#include "moc_model.cpp"
|