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
|
/*
SPDX-FileCopyrightText: 2007 Piyush verma <piyush.verma@gmail.com>
SPDX-FileCopyrightText: 2010-2013 Sven Brauch <svenbrauch@googlemail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "usebuilder.h"
#include <QDebug>
#include "duchaindebug.h"
#include <language/duchain/declaration.h>
#include <language/duchain/use.h>
#include <language/duchain/topducontext.h>
#include <language/duchain/duchain.h>
#include <language/duchain/duchainlock.h>
#include <language/duchain/types/structuretype.h>
#include "parsesession.h"
#include "pythoneditorintegrator.h"
#include "ast.h"
#include "expressionvisitor.h"
#include "helpers.h"
using namespace KTextEditor;
using namespace KDevelop;
namespace Python {
UseBuilder::UseBuilder(PythonEditorIntegrator* editor, QVector<IndexedString> ignoreVariables)
: UseBuilderBase()
, m_errorReportingEnabled(true)
, m_ignoreVariables(ignoreVariables)
{
setEditor(editor);
}
DUContext* UseBuilder::contextAtOrCurrent(const CursorInRevision& pos)
{
DUContext* context = nullptr;
{
DUChainReadLocker lock;
context = topContext()->findContextAt(pos, true);
}
if ( ! context ) {
context = currentContext();
}
return context;
}
void UseBuilder::useHiddenMethod(ExpressionAst* value, Declaration* function) {
if ( !function || function->topContext() == Helper::getDocumentationFileContext() ) {
// Don't add a use for e.g. `list.__getitem__` in `foo[0]`, no-one cares.
return;
}
RangeInRevision useRange;
// TODO fixme! this does not necessarily use the opening bracket as it should
useRange.start = CursorInRevision(value->endLine, value->endCol + 1);
useRange.end = CursorInRevision(value->endLine, value->endCol + 2);
if ( function && function->isFunctionDeclaration() ) {
UseBuilderBase::newUse(useRange, DeclarationPointer(function));
}
}
void UseBuilder::visitName(NameAst* node)
{
DUContext* context = contextAtOrCurrent(editorFindPositionSafe(node));
Declaration* declaration = Helper::declarationForName(node, editorFindPositionSafe(node),
DUChainPointer<const DUContext>(context));
Q_ASSERT(node->identifier);
RangeInRevision useRange = rangeForNode(node->identifier, true);
if ( declaration && declaration->range() == useRange ) return;
if ( ! declaration && m_errorReportingEnabled ) {
if ( ! m_ignoreVariables.contains(IndexedString(node->identifier->value)) ) {
KDevelop::Problem *p = new KDevelop::Problem();
p->setFinalLocation(DocumentRange(currentlyParsedDocument(), useRange.castToSimpleRange())); // TODO ok?
p->setSource(KDevelop::IProblem::SemanticAnalysis);
p->setSeverity(KDevelop::IProblem::Hint);
p->setDescription(i18n("Undefined variable: %1", node->identifier->value));
{
DUChainWriteLocker wlock(DUChain::lock());
ProblemPointer ptr(p);
topContext()->addProblem(ptr);
}
}
}
UseBuilderBase::newUse(useRange, DeclarationPointer(declaration));
}
void UseBuilder::visitCall(CallAst* node)
{
UseBuilderBase::visitCall(node);
DUContext* context = contextAtOrCurrent(editorFindPositionSafe(node->function));
ExpressionVisitor v(context);
v.visitNode(node->function);
if ( auto classType = v.lastType().dynamicCast<StructureType>() ) {
DUChainReadLocker lock;
// This is either __init__() or __call__(): `a = Foo()` or `b = a()`.
auto function = Helper::functionForCalled(classType->declaration(topContext()), v.isAlias());
lock.unlock();
useHiddenMethod(node->function, function.declaration);
}
}
void UseBuilder::visitAttribute(AttributeAst* node)
{
UseBuilderBase::visitAttribute(node);
DUContext* context = contextAtOrCurrent(editorFindPositionSafe(node));
ExpressionVisitor v(context);
v.visitNode(node);
RangeInRevision useRange(node->attribute->startLine, node->attribute->startCol,
node->attribute->endLine, node->attribute->endCol + 1);
DeclarationPointer declaration = v.lastDeclaration();
DUChainWriteLocker wlock;
if ( declaration && declaration->range() == useRange ) {
// this is the declaration, don't build a use for it
return;
}
if ( ! declaration && v.isConfident() && ( ! v.lastType() || Helper::isUsefulType(v.lastType()) ) ) {
KDevelop::Problem *p = new KDevelop::Problem();
p->setFinalLocation(DocumentRange(currentlyParsedDocument(), useRange.castToSimpleRange()));
p->setSource(KDevelop::IProblem::SemanticAnalysis);
p->setSeverity(KDevelop::IProblem::Hint);
p->setDescription(i18n("Attribute \"%1\" not found on accessed object", node->attribute->value));
ProblemPointer ptr(p);
topContext()->addProblem(ptr);
}
UseBuilderBase::newUse(useRange, declaration);
}
void UseBuilder::visitSubscript(SubscriptAst* node) {
UseBuilderBase::visitSubscript(node);
DUContext* context = contextAtOrCurrent(editorFindPositionSafe(node->value));
ExpressionVisitor v(context);
v.visitNode(node->value);
static const IndexedIdentifier getitemIdentifier(KDevelop::Identifier(QStringLiteral("__getitem__")));
static const IndexedIdentifier setitemIdentifier(KDevelop::Identifier(QStringLiteral("__setitem__")));
bool isAugTarget = (node->parent->astType == Ast::AugmentedAssignmentAstType &&
static_cast<AugmentedAssignmentAst*>(node->parent)->target == node);
// e.g `a[0] += 2` uses both __getitem__ and __setitem__.
if (isAugTarget || node->context == ExpressionAst::Context::Load) {
DUChainReadLocker lock;
auto getItemFunc = Helper::accessAttribute(v.lastType(), getitemIdentifier, context->topContext());
lock.unlock();
useHiddenMethod(node->value, getItemFunc);
}
if ( node->context == ExpressionAst::Context::Store ) {
DUChainReadLocker lock;
auto setItemFunc = Helper::accessAttribute(v.lastType(), setitemIdentifier, context->topContext());
lock.unlock();
useHiddenMethod(node->value, setItemFunc);
}
}
void UseBuilder::visitMatchAs(MatchAsAst* node)
{
DUContext* context = contextAtOrCurrent(editorFindPositionSafe(node));
if (!node->name) {
return;
}
Declaration* declaration = Helper::declarationForName(node->name->value, editorFindPositionSafe(node),
DUChainPointer<const DUContext>(context));
RangeInRevision useRange = rangeForNode(node->name, true);
if ( declaration && declaration->range() == useRange )
return;
UseBuilderBase::newUse(useRange, DeclarationPointer(declaration));
}
ParseSession *UseBuilder::parseSession() const
{
return m_session;
}
}
// kate: space-indent on; indent-width 4; tab-width 4; replace-tabs on; auto-insert-doxygen on
|
