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
|
/*
SPDX-FileCopyrightText: 2011 Sven Brauch <svenbrauch@googlemail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "functiondeclaration.h"
#include <language/codecompletion/normaldeclarationcompletionitem.h>
#include <language/codecompletion/codecompletionmodel.h>
#include <language/duchain/types/functiontype.h>
#include <language/duchain/aliasdeclaration.h>
#include <language/duchain/types/containertypes.h>
#include <KTextEditor/View>
#include <KTextEditor/Document>
#include <KLocalizedString>
#include "duchain/navigation/navigationwidget.h"
#include "codecompletion/helpers.h"
#include "declaration.h"
#include "declarations/functiondeclaration.h"
#include "duchain/helpers.h"
#include <QDebug>
#include <codecompletiondebug.h>
using namespace KDevelop;
using namespace KTextEditor;
namespace Python {
FunctionDeclarationCompletionItem::FunctionDeclarationCompletionItem(DeclarationPointer decl, CodeCompletionContext::Ptr context)
: PythonDeclarationCompletionItem(decl, context)
, m_atArgument(-1)
, m_depth(0)
, m_doNotCall(false)
{
}
int FunctionDeclarationCompletionItem::atArgument() const
{
return m_atArgument;
}
void FunctionDeclarationCompletionItem::setDepth(int d)
{
m_depth = d;
}
void FunctionDeclarationCompletionItem::setAtArgument(int d)
{
m_atArgument = d;
}
int FunctionDeclarationCompletionItem::argumentHintDepth() const
{
return m_depth;
}
QVariant FunctionDeclarationCompletionItem::data(const QModelIndex& index, int role, const KDevelop::CodeCompletionModel* model) const
{
DUChainReadLocker lock;
FunctionDeclaration* dec = dynamic_cast<FunctionDeclaration*>(m_declaration.data());
switch ( role ) {
case Qt::DisplayRole: {
if ( ! dec ) {
break; // use the default
}
if ( index.column() == KDevelop::CodeCompletionModel::Arguments ) {
if (FunctionType::Ptr functionType = dec->type<FunctionType>()) {
QString ret;
createArgumentList(dec, ret, nullptr, 0, false);
return ret;
}
}
if ( index.column() == KDevelop::CodeCompletionModel::Prefix ) {
FunctionType::Ptr type = dec->type<FunctionType>();
if ( type && type->returnType() ) {
return QVariant(i18n("function") + QStringLiteral(" -> ") + type->returnType()->toString());
}
}
break;
}
case KDevelop::CodeCompletionModel::HighlightingMethod: {
if ( index.column() == KDevelop::CodeCompletionModel::Arguments )
return QVariant(KDevelop::CodeCompletionModel::CustomHighlighting);
break;
}
case KDevelop::CodeCompletionModel::CustomHighlight: {
if ( index.column() == KDevelop::CodeCompletionModel::Arguments ) {
if ( ! dec ) return QVariant();
QString ret;
QList<QVariant> highlight;
if ( atArgument() ) {
createArgumentList(dec, ret, &highlight, atArgument(), false);
}
else {
createArgumentList(dec, ret, nullptr, false);
}
return QVariant(highlight);
}
break;
}
case KDevelop::CodeCompletionModel::MatchQuality: {
if ( m_typeHint == PythonCodeCompletionContext::IterableRequested
&& dec && dec->type<FunctionType>()
&& dynamic_cast<ListType*>(dec->type<FunctionType>()->returnType().data()) )
{
return 2 + PythonDeclarationCompletionItem::data(index, role, model).toInt();
}
return PythonDeclarationCompletionItem::data(index, role, model);
}
}
return Python::PythonDeclarationCompletionItem::data(index, role, model);
}
void FunctionDeclarationCompletionItem::setDoNotCall(bool doNotCall)
{
m_doNotCall = doNotCall;
}
void FunctionDeclarationCompletionItem::executed(KTextEditor::View* view, const KTextEditor::Range& word)
{
qCDebug(KDEV_PYTHON_CODECOMPLETION) << "FunctionDeclarationCompletionItem executed";
KTextEditor::Document* document = view->document();
auto resolvedDecl = Helper::resolveAliasDeclaration(declaration().data());
DUChainReadLocker lock;
auto functionDecl = Helper::functionForCalled(resolvedDecl).declaration;
lock.unlock();
if ( ! functionDecl && (! resolvedDecl || ! resolvedDecl->abstractType()
|| resolvedDecl->abstractType()->whichType() != AbstractType::TypeStructure) ) {
qCritical(KDEV_PYTHON_CODECOMPLETION) << "ERROR: could not get declaration data, not executing completion item!";
return;
}
QString suffix = QStringLiteral("()");
KTextEditor::Range checkPrefix(word.start().line(), 0, word.start().line(), word.start().column());
KTextEditor::Range checkSuffix(word.end().line(), word.end().column(), word.end().line(), document->lineLength(word.end().line()));
if ( m_doNotCall || document->text(checkSuffix).trimmed().startsWith(QLatin1Char('('))
|| document->text(checkPrefix).trimmed().endsWith(QLatin1Char('@'))
|| (functionDecl && functionDecl->isProperty()) )
{
// don't insert brackets if they're already there,
// the item is a decorator, or if it's an import item.
suffix.clear();
}
// place cursor behind bracktes by default
int skip = 2;
if ( functionDecl ) {
bool needsArguments = false;
int argumentCount = functionDecl->type<FunctionType>()->arguments().length();
if ( functionDecl->context()->type() == KDevelop::DUContext::Class ) {
// it's a member function, so it has the implicit self
// TODO static methods
needsArguments = argumentCount > 1;
}
else {
// it's a free function
needsArguments = argumentCount > 0;
}
if ( needsArguments ) {
// place cursor in brackets if there's parameters
skip = 1;
}
}
document->replaceText(word, declaration()->identifier().toString() + suffix);
view->setCursorPosition( Cursor(word.end().line(), word.end().column() + skip) );
}
FunctionDeclarationCompletionItem::~FunctionDeclarationCompletionItem() { }
}
|