context.cpp 48.1 KB
Newer Older
1
2
3
/*
 * This file is part of KDevelop
 * Copyright 2014 Milian Wolff <mail@milianw.de>
Sergey Kalinichev's avatar
Sergey Kalinichev committed
4
 * Copyright 2015 Sergey Kalinichev <kalinichev.so.0@gmail.com>
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 * 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 "context.h"

25
#include <QRegularExpression>
26
#include <QStandardPaths>
27

28
29
30
#include <interfaces/icore.h>
#include <interfaces/idocumentcontroller.h>

31
32
33
#include <language/duchain/duchainlock.h>
#include <language/duchain/ducontext.h>
#include <language/duchain/topducontext.h>
34
#include <language/duchain/declaration.h>
35
#include <language/duchain/classmemberdeclaration.h>
36
#include <language/duchain/classdeclaration.h>
37
#include <language/duchain/duchainutils.h>
38
#include <language/duchain/persistentsymboltable.h>
39
#include <language/duchain/types/integraltype.h>
40
#include <language/duchain/types/functiontype.h>
41
#include <language/duchain/types/pointertype.h>
42
#include <language/duchain/types/typealiastype.h>
43
#include <language/duchain/types/typeutils.h>
44
#include <language/codecompletion/codecompletionmodel.h>
45
#include <language/codecompletion/normaldeclarationcompletionitem.h>
46
#include <util/foregroundlock.h>
47
#include <qtcompat_p.h>
48

49
#include "../util/clangdebug.h"
50
#include "../util/clangtypes.h"
51
#include "../util/clangutils.h"
52
#include "../duchain/clangdiagnosticevaluator.h"
53
#include "../duchain/parsesession.h"
54
#include "../duchain/duchainutils.h"
55
#include "../duchain/navigationwidget.h"
56
#include "../clangsettings/clangsettingsmanager.h"
57

Kevin Funk's avatar
Kevin Funk committed
58
#include <functional>
59
#include <memory>
Kevin Funk's avatar
Kevin Funk committed
60

61
#include <KTextEditor/Document>
62
#include <KTextEditor/View>
63
64
65
66

using namespace KDevelop;

namespace {
Kevin Funk's avatar
Kevin Funk committed
67
68
/// Maximum return-type string length in completion items
const int MAX_RETURN_TYPE_STRING_LENGTH = 20;
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
/// Priority of code-completion results. NOTE: Keep in sync with Clang code base.
enum CodeCompletionPriority {
  /// Priority for the next initialization in a constructor initializer list.
  CCP_NextInitializer = 7,
  /// Priority for an enumeration constant inside a switch whose condition is of the enumeration type.
  CCP_EnumInCase = 7,

  CCP_LocalDeclarationMatch = 8,

  CCP_DeclarationMatch = 12,

  CCP_LocalDeclarationSimiliar = 17,
  /// Priority for a send-to-super completion.
  CCP_SuperCompletion = 20,

  CCP_DeclarationSimiliar = 25,
  /// Priority for a declaration that is in the local scope.
  CCP_LocalDeclaration = 34,
  /// Priority for a member declaration found from the current method or member function.
  CCP_MemberDeclaration = 35,
  /// Priority for a language keyword (that isn't any of the other categories).
  CCP_Keyword = 40,
  /// Priority for a code pattern.
  CCP_CodePattern = 40,
  /// Priority for a non-type declaration.
  CCP_Declaration = 50,
  /// Priority for a type.
  CCP_Type = CCP_Declaration,
  /// Priority for a constant value (e.g., enumerator).
  CCP_Constant = 65,
  /// Priority for a preprocessor macro.
  CCP_Macro = 70,
  /// Priority for a nested-name-specifier.
  CCP_NestedNameSpecifier = 75,
  /// Priority for a result that isn't likely to be what the user wants, but is included for completeness.
  CCP_Unlikely = 80
};

108
109
110
111
112
/**
 * Common base class for Clang code completion items.
 */
template<class Base>
class CompletionItem : public Base
113
114
{
public:
115
    CompletionItem(const QString& display, const QString& prefix)
116
117
118
        : Base()
        , m_display(display)
        , m_prefix(prefix)
119
        , m_unimportant(false)
120
121
    {
    }
122

123
    ~CompletionItem() override = default;
124

125
126
127
128
129
130
131
132
    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* /*model*/) const override
    {
        if (role == Qt::DisplayRole) {
            if (index.column() == CodeCompletionModel::Prefix) {
                return m_prefix;
            } else if (index.column() == CodeCompletionModel::Name) {
                return m_display;
            }
133
        }
134
        return {};
135
    }
136

137
138
139
140
141
    void markAsUnimportant()
    {
        m_unimportant = true;
    }

142
protected:
143
144
    QString m_display;
    QString m_prefix;
145
    bool m_unimportant;
146
147
};

148
149
150
class OverrideItem : public CompletionItem<CompletionTreeItem>
{
public:
Kevin Funk's avatar
Kevin Funk committed
151
    OverrideItem(const QString& nameAndParams, const QString& returnType)
152
        : CompletionItem<CompletionTreeItem>(
153
              nameAndParams,
154
              i18n("Override %1", returnType)
155
          )
156
        , m_returnType(returnType)
157
158
159
160
161
162
163
    {
    }

    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
    {
        if (role == Qt::DecorationRole) {
            if (index.column() == KTextEditor::CodeCompletionModel::Icon) {
164
                static const QIcon icon = QIcon::fromTheme(QStringLiteral("CTparents"));
165
166
167
168
169
                return icon;
            }
        }
        return CompletionItem<CompletionTreeItem>::data(index, role, model);
    }
170
171
172

    void execute(KTextEditor::View* view, const KTextEditor::Range& word) override
    {
173
        view->document()->replaceText(word, m_returnType + QLatin1Char(' ') + m_display.replace(QRegularExpression(QStringLiteral("\\s*=\\s*0")), QString()) + QLatin1String(" override;"));
174
175
176
177
    }

private:
    QString m_returnType;
178
179
};

180
181
182
183
/**
 * Specialized completion item class for items which are represented by a Declaration
 */
class DeclarationItem : public CompletionItem<NormalDeclarationCompletionItem>
184
{
185
186
public:
    DeclarationItem(Declaration* dec, const QString& display, const QString& prefix, const QString& replacement)
187
188
        : CompletionItem<NormalDeclarationCompletionItem>(display, prefix)
        , m_replacement(replacement)
189
190
    {
        m_declaration = dec;
191
    }
192
193
194

    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
    {
Kevin Funk's avatar
Kevin Funk committed
195
196
        if (role == CodeCompletionModel::MatchQuality && m_matchQuality) {
            return m_matchQuality;
197
198
        }

199
200
201
202
203
        auto ret = CompletionItem<NormalDeclarationCompletionItem>::data(index, role, model);
        if (ret.isValid()) {
            return ret;
        }
        return NormalDeclarationCompletionItem::data(index, role, model);
204
    }
205

Kevin Funk's avatar
Kevin Funk committed
206
    void execute(KTextEditor::View* view, const KTextEditor::Range& word) override
207
208
209
210
211
212
213
214
215
    {
        QString repl = m_replacement;
        DUChainReadLocker lock;

        if(!m_declaration){
            return;
        }

        if(m_declaration->isFunctionDeclaration()) {
216
217
218
219
220
221
222
            const auto functionType = m_declaration->type<FunctionType>();

            // protect against buggy code that created the m_declaration,
            // to mark it as a function but not assign a function type
            if (!functionType)
                return;

223
            auto doc = view->document();
224
225
226
227
228
229
230
231
232
233
234
235
236

            // Function pointer?
            bool funcptr = false;
            const auto line = doc->line(word.start().line());
            auto pos = word.end().column() - 1;
            while ( pos > 0 && (line.at(pos).isLetterOrNumber() || line.at(pos) == QLatin1Char(':')) ) {
                pos--;
                if ( line.at(pos) == QLatin1Char('&') ) {
                    funcptr = true;
                    break;
                }
            }

237
238
            auto restEmpty = doc->characterAt(word.end() + KTextEditor::Cursor{0, 1}) == QChar();

239
            bool didAddParentheses = false;
240
            if ( !funcptr && doc->characterAt(word.end()) != QLatin1Char('(') ) {
241
                repl += QLatin1String("()");
242
                didAddParentheses = true;
243
            }
Kevin Funk's avatar
Kevin Funk committed
244
            view->document()->replaceText(word, repl);
245
            if (functionType->indexedArgumentsSize() && didAddParentheses) {
Kevin Funk's avatar
Kevin Funk committed
246
                view->setCursorPosition(word.start() + KTextEditor::Cursor(0, repl.size() - 1));
247
            }
248
            auto returnTypeIntegral = functionType->returnType().cast<IntegralType>();
249
250
            if ( restEmpty && !funcptr && returnTypeIntegral && returnTypeIntegral->dataType() == IntegralType::TypeVoid ) {
                // function returns void and rest of line is empty -- nothing can be done with the result
251
                if (functionType->indexedArgumentsSize() ) {
252
253
254
255
256
257
258
259
260
                    // we placed the cursor inside the ()
                    view->document()->insertText(view->cursorPosition() + KTextEditor::Cursor(0, 1), QStringLiteral(";"));
                }
                else {
                    // we placed the cursor after the ()
                    view->document()->insertText(view->cursorPosition(), QStringLiteral(";"));
                    view->setCursorPosition(view->cursorPosition() + KTextEditor::Cursor{0, 1});
                }
            }
261
        } else {
Kevin Funk's avatar
Kevin Funk committed
262
            view->document()->replaceText(word, repl);
263
264
265
        }
    }

266
267
268
269
270
271
272
    bool createsExpandingWidget() const override
    {
        return true;
    }

    QWidget* createExpandingWidget(const CodeCompletionModel* /*model*/) const override
    {
273
        return new ClangNavigationWidget(m_declaration, AbstractNavigationWidget::EmbeddableWidget);
274
    }
275

Kevin Funk's avatar
Kevin Funk committed
276
277
278
279
280
    int matchQuality() const
    {
        return m_matchQuality;
    }

281
    ///Sets match quality from 0 to 10. 10 is the best fit.
Kevin Funk's avatar
Kevin Funk committed
282
    void setMatchQuality(int value)
283
    {
Kevin Funk's avatar
Kevin Funk committed
284
        m_matchQuality = value;
285
286
    }

287
288
289
290
291
    void setInheritanceDepth(int depth)
    {
        m_inheritanceDepth = depth;
    }

292
293
294
295
296
297
298
299
300
301
    int argumentHintDepth() const override
    {
        return m_depth;
    }

    void setArgumentHintDepth(int depth)
    {
        m_depth = depth;
    }

302
protected:
Kevin Funk's avatar
Kevin Funk committed
303
    int m_matchQuality = 0;
304
    int m_depth = 0;
305
    QString m_replacement;
306
};
307

308
309
310
311
312
313
314
315
316
317
318
319
320
class ImplementsItem : public DeclarationItem
{
public:
    static QString replacement(const FuncImplementInfo& info)
    {
        QString replacement = info.templatePrefix;
        if (!info.isDestructor && !info.isConstructor) {
            replacement += info.returnType + QLatin1Char(' ');
        }
        replacement += info.prototype + QLatin1String("\n{\n}\n");
        return replacement;
    }

321
    explicit ImplementsItem(const FuncImplementInfo& item)
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
        : DeclarationItem(item.declaration.data(), item.prototype,
            i18n("Implement %1", item.isConstructor ? QStringLiteral("<constructor>") :
                                   item.isDestructor ? QStringLiteral("<destructor>") : item.returnType),
            replacement(item)
          )
    {
    }

    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
    {
        if (index.column() == CodeCompletionModel::Arguments) {
            // our display string already contains the arguments
            return {};
        }
        return DeclarationItem::data(index, role, model);
    }

    void execute(KTextEditor::View* view, const KTextEditor::Range& word) override
    {
        view->document()->replaceText(word, m_replacement);
    }
};
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

class ArgumentHintItem : public DeclarationItem
{
public:
    struct CurrentArgumentRange
    {
        int start;
        int end;
    };

    ArgumentHintItem(Declaration* decl,  const QString& prefix, const QString& name, const QString& arguments, const CurrentArgumentRange& range)
        : DeclarationItem(decl, name, prefix, {})
        , m_range(range)
        , m_arguments(arguments)
    {}

Milian Wolff's avatar
Milian Wolff committed
360
    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
361
362
363
364
    {
        if (role == CodeCompletionModel::CustomHighlight && index.column() == CodeCompletionModel::Arguments && argumentHintDepth()) {
            QTextCharFormat boldFormat;
            boldFormat.setFontWeight(QFont::Bold);
365
366
367
368
369
            const QList<QVariant> highlighting {
                QVariant(m_range.start),
                QVariant(m_range.end),
                boldFormat,
            };
370
371
372
373
374
375
376
            return highlighting;
        }

        if (role == CodeCompletionModel::HighlightingMethod && index.column() == CodeCompletionModel::Arguments && argumentHintDepth()) {
            return QVariant(CodeCompletionModel::CustomHighlighting);
        }

377
        if (index.column() == CodeCompletionModel::Arguments) {
378
379
380
381
382
383
384
385
386
387
388
            return m_arguments;
        }

        return DeclarationItem::data(index, role, model);
    }

private:
    CurrentArgumentRange m_range;
    QString m_arguments;
};

389
390
391
/**
 * A minimalistic completion item for macros and such
 */
392
393
394
class SimpleItem : public CompletionItem<CompletionTreeItem>
{
public:
395
    SimpleItem(const QString& display, const QString& prefix, const QString& replacement, const QIcon& icon = QIcon())
396
397
        : CompletionItem<CompletionTreeItem>(display, prefix)
        , m_replacement(replacement)
398
        , m_icon(icon)
399
400
401
402
403
404
405
406
    {
    }

    void execute(KTextEditor::View* view, const KTextEditor::Range& word) override
    {
        view->document()->replaceText(word, m_replacement);
    }

407
408
409
410
411
    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
    {
        if (role == Qt::DecorationRole && index.column() == KTextEditor::CodeCompletionModel::Icon) {
            return m_icon;
        }
412
        if (role == CodeCompletionModel::UnimportantItemRole) {
413
414
            return m_unimportant;
        }
415
416
417
        return CompletionItem<CompletionTreeItem>::data(index, role, model);
    }

418
419
private:
    QString m_replacement;
420
    QIcon m_icon;
421
};
422

423
424
425
/**
 * Return true in case position @p position represents a cursor inside a comment
 */
Kevin Funk's avatar
Kevin Funk committed
426
bool isInsideComment(CXTranslationUnit unit, CXFile file, const KTextEditor::Cursor& position)
427
428
429
430
431
432
433
{
    if (!position.isValid()) {
        return false;
    }

    // TODO: This may get very slow for a large TU, investigate if we can improve this function
    auto begin = clang_getLocation(unit, file, 1, 1);
Kevin Funk's avatar
Kevin Funk committed
434
    auto end = clang_getLocation(unit, file, position.line() + 1, position.column() + 1);
435
436
437
438
    CXSourceRange range = clang_getRange(begin, end);

    // tokenize the whole range from the start until 'position'
    // if we detect a comment token at this position, return true
439
440
    const ClangTokens tokens(unit, range);
    for (CXToken token : tokens) {
441
442
443
444
445
446
        CXTokenKind tokenKind = clang_getTokenKind(token);
        if (tokenKind != CXToken_Comment) {
            continue;
        }

        auto range = ClangRange(clang_getTokenExtent(unit, token));
Kevin Funk's avatar
Kevin Funk committed
447
        if (range.toRange().contains(position)) {
448
449
450
451
452
453
            return true;
        }
    }
    return false;
}

Kevin Funk's avatar
Kevin Funk committed
454
455
456
QString& elideStringRight(QString& str, int length)
{
    if (str.size() > length + 3) {
457
        return str.replace(length, str.size() - length, QStringLiteral("..."));
Kevin Funk's avatar
Kevin Funk committed
458
459
460
461
    }
    return str;
}

Kevin Funk's avatar
Kevin Funk committed
462
/**
463
 * @return Value suited for @ref CodeCompletionModel::MatchQuality in the range [0.0, 10.0] (the higher the better)
Kevin Funk's avatar
Kevin Funk committed
464
465
466
467
468
469
 *
 * See http://clang.llvm.org/doxygen/CodeCompleteConsumer_8h_source.html for list of priorities
 * They (currently) have a range from [-3, 80] (the lower, the better)
 */
int codeCompletionPriorityToMatchQuality(unsigned int completionPriority)
{
470
    return 10u - qBound(0u, completionPriority, 80u) / 8;
Kevin Funk's avatar
Kevin Funk committed
471
472
}

473
int adjustPriorityForType(const AbstractType::Ptr& type, int completionPriority)
474
{
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
    const auto modifier = 4;
    if (type) {
        const auto whichType = type->whichType();
        if (whichType == AbstractType::TypePointer || whichType == AbstractType::TypeReference) {
            // Clang considers all pointers as similar, this is not what we want.
            completionPriority += modifier;
        } else if (whichType == AbstractType::TypeStructure) {
            // Clang considers all classes as similar too...
            completionPriority += modifier;
        } else if (whichType == AbstractType::TypeDelayed) {
            completionPriority += modifier;
        } else if (whichType == AbstractType::TypeAlias) {
            auto aliasedType = type.cast<TypeAliasType>();
            return adjustPriorityForType(aliasedType ? aliasedType->type() : AbstractType::Ptr(), completionPriority);
        } else if (whichType == AbstractType::TypeFunction) {
            auto functionType = type.cast<FunctionType>();
            return adjustPriorityForType(functionType ? functionType->returnType() : AbstractType::Ptr(), completionPriority);
492
        }
493
494
    } else {
        completionPriority += modifier;
495
496
497
498
499
    }

    return completionPriority;
}

500
501
502
503
504
505
506
507
508
509
/// Adjusts priority for the @p decl
int adjustPriorityForDeclaration(Declaration* decl, unsigned int completionPriority)
{
    if(completionPriority < CCP_LocalDeclarationSimiliar || completionPriority > CCP_SuperCompletion){
        return completionPriority;
    }

    return adjustPriorityForType(decl->abstractType(), completionPriority);
}

510
511
512
/**
 * @return Whether the declaration represented by identifier @p identifier qualifies as completion result
 *
Kevin Funk's avatar
Kevin Funk committed
513
514
 * For example, we don't want to offer SomeClass::SomeClass as completion item to the user
 * (otherwise we'd end up generating code such as 's.SomeClass();')
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 */
bool isValidCompletionIdentifier(const QualifiedIdentifier& identifier)
{
    const int count = identifier.count();
    if (identifier.count() < 2) {
        return true;
    }

    const Identifier scope = identifier.at(count-2);
    const Identifier id = identifier.last();
    if (scope == id) {
        return false; // is constructor
    }
    const QString idString = id.toString();
529
    if (idString.startsWith(QLatin1Char('~')) && scope.toString() == idString.midRef(1)) {
530
531
532
533
534
        return false; // is destructor
    }
    return true;
}

535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
/**
 * @return Whether the declaration represented by identifier @p identifier qualifies as "special" completion result
 *
 * "Special" completion results are items that are likely not regularly used.
 *
 * Examples:
 * - 'SomeClass::operator=(const SomeClass&)'
 */
bool isValidSpecialCompletionIdentifier(const QualifiedIdentifier& identifier)
{
    if (identifier.count() < 2) {
        return false;
    }

    const Identifier id = identifier.last();
    const QString idString = id.toString();
551
    if (idString.startsWith(QLatin1String("operator="))) {
552
553
554
555
556
        return true; // is assignment operator
    }
    return false;
}

557
Declaration* findDeclaration(const QualifiedIdentifier& qid, const DUContextPointer& ctx, const CursorInRevision& position, QSet<Declaration*>& handled)
558
{
559
    PersistentSymbolTable::Declarations decl = PersistentSymbolTable::self().declarations(qid);
560

561
562
563
    const auto top = ctx->topContext();
    const auto& importedContexts = top->importedParentContexts();

564
    for (auto it = decl.iterator(); it; ++it) {
565
566
567
568
569
570
571
572
573
574
575
576
        // if the context is not included, then this match is not correct for our consideration
        // this fixes issues where we used to include matches from files that did not have
        // anything to do with the current TU, e.g. the main from a different file or stuff like that
        // it also reduces the chance of us picking up a function of the same name from somewhere else
        // also, this makes sure the context has the correct language and we don't get confused by stuff
        // from other language plugins
        if (std::none_of(importedContexts.begin(), importedContexts.end(), [it] (const DUContext::Import& import) {
            return import.topContextIndex() == it->indexedTopContext().index();
        })) {
            continue;
        }

577
        auto declaration = it->declaration();
578
579
580
581
582
583
584
        if (!declaration) {
            // Mitigate problems such as: Cannot load a top-context from file "/home/kfunk/.cache/kdevduchain/kdevelop-{foo}/topcontexts/6085"
            //  - the required language-support for handling ID 55 is probably not loaded
            qCWarning(KDEV_CLANG) << "Detected an invalid declaration for" << qid;
            continue;
        }

585
        if (declaration->kind() == Declaration::Instance && !declaration->isFunctionDeclaration()) {
586
587
            break;
        }
588
589
        if (!handled.contains(declaration)) {
            handled.insert(declaration);
590
            return declaration;
591
592
593
594
595
596
597
        }
    }

    const auto foundDeclarations = ctx->findDeclarations(qid, position);
    for (auto dec : foundDeclarations) {
        if (!handled.contains(dec)) {
            handled.insert(dec);
598
            return dec;
599
600
601
        }
    }

602
    return nullptr;
603
604
}

605
/// If any parent of this context is a class, the closest class declaration is returned, nullptr otherwise
606
Declaration* classDeclarationForContext(const DUContextPointer& context, const CursorInRevision& position)
607
608
609
610
611
612
{
    auto parent = context;
    while (parent) {
        if (parent->type() == DUContext::Class) {
            break;
        }
613
614
615
616
617
618
619
620

        if (auto owner = parent->owner()) {
            // Work-around for out-of-line methods. They have Helper context instead of Class context
            if (owner->context() && owner->context()->type() == DUContext::Helper) {
                auto qid = owner->qualifiedIdentifier();
                qid.pop();

                QSet<Declaration*> tmp;
621
                auto decl = findDeclaration(qid, context, position, tmp);
622
623
624
625
626
627
628

                if (decl && decl->internalContext() && decl->internalContext()->type() == DUContext::Class) {
                    parent = decl->internalContext();
                    break;
                }
            }
        }
629
630
631
632
633
634
        parent = parent->parentContext();
    }

    return parent ? parent->owner() : nullptr;
}

635
636
637
class LookAheadItemMatcher
{
public:
638
    explicit LookAheadItemMatcher(const TopDUContextPointer& ctx)
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
        : m_topContext(ctx)
        , m_enabled(ClangSettingsManager::self()->codeCompletionSettings().lookAhead)
    {}

    /// Adds all local declarations for @p declaration into possible look-ahead items.
    void addDeclarations(Declaration* declaration)
    {
        if (!m_enabled) {
            return;
        }

        if (declaration->kind() != Declaration::Instance) {
            return;
        }

        auto type = typeForDeclaration(declaration);
        auto identifiedType = dynamic_cast<const IdentifiedType*>(type.data());
        if (!identifiedType) {
            return;
        }

        addDeclarationsForType(identifiedType, declaration);
    }

    /// Add type for matching. This type'll be used for filtering look-ahead items
    /// Only items with @p type will be returned through @sa matchedItems
    void addMatchedType(const IndexedType& type)
    {
        matchedTypes.insert(type);
    }

    /// @return look-ahead items that math given types. @sa addMatchedType
    QList<CompletionTreeItemPointer> matchedItems()
    {
        QList<CompletionTreeItemPointer> lookAheadItems;
674
        for (const auto& pair: qAsConst(possibleLookAheadDeclarations)) {
675
            auto decl = pair.first;
676
            if (matchedTypes.contains(decl->indexedType())) {
677
678
679
680
                auto parent = pair.second;
                const QString access = parent->abstractType()->whichType() == AbstractType::TypePointer
                                 ? QStringLiteral("->") : QStringLiteral(".");
                const QString text = parent->identifier().toString() + access + decl->identifier().toString();
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
                auto item = new DeclarationItem(decl, text, {}, text);
                item->setMatchQuality(8);
                lookAheadItems.append(CompletionTreeItemPointer(item));
            }
        }

        return lookAheadItems;
    }

private:
    AbstractType::Ptr typeForDeclaration(const Declaration* decl)
    {
        return TypeUtils::targetType(decl->abstractType(), m_topContext.data());
    }

    void addDeclarationsForType(const IdentifiedType* identifiedType, Declaration* declaration)
    {
        if (auto typeDecl = identifiedType->declaration(m_topContext.data())) {
            if (dynamic_cast<ClassDeclaration*>(typeDecl->logicalDeclaration(m_topContext.data()))) {
                if (!typeDecl->internalContext()) {
                    return;
                }

704
705
                const auto& localDeclarations = typeDecl->internalContext()->localDeclarations();
                for (auto localDecl : localDeclarations) {
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
                    if(localDecl->identifier().isEmpty()){
                        continue;
                    }

                    if(auto classMember = dynamic_cast<ClassMemberDeclaration*>(localDecl)){
                        // TODO: Also add protected/private members if completion is inside this class context.
                        if(classMember->accessPolicy() != Declaration::Public){
                            continue;
                        }
                    }

                    if(!declaration->abstractType()){
                        continue;
                    }

                    if (declaration->abstractType()->whichType() == AbstractType::TypeIntegral) {
                        if (auto integralType = declaration->abstractType().cast<IntegralType>()) {
                            if (integralType->dataType() == IntegralType::TypeVoid) {
                                continue;
                            }
                        }
                    }

729
                    possibleLookAheadDeclarations.insert({localDecl, declaration});
730
731
732
733
734
735
736
737
738
739
740
741
                }
            }
        }
    }

    // Declaration and it's context
    typedef QPair<Declaration*, Declaration*> DeclarationContext;

    /// Types of declarations that look-ahead completion items can have
    QSet<IndexedType> matchedTypes;

    // List of declarations that can be added to the Look Ahead group
742
743
    // Second declaration represents context
    QSet<DeclarationContext> possibleLookAheadDeclarations;
744
745
746
747
748
749

    TopDUContextPointer m_topContext;

    bool m_enabled;
};

750
751
752
753
754
755
756
757
758
759
760
struct MemberAccessReplacer : public QObject
{
    Q_OBJECT

public:
    enum Type {
        None,
        DotToArrow,
        ArrowToDot
    };

761
public Q_SLOTS:
762
763
764
765
766
767
768
769
770
771
772
773
    void replaceCurrentAccess(MemberAccessReplacer::Type type)
    {
        if (auto document = ICore::self()->documentController()->activeDocument()) {
            if (auto textDocument = document->textDocument()) {
                auto activeView = document->activeTextView();
                if (!activeView) {
                    return;
                }

                auto cursor = activeView->cursorPosition();

                QString oldAccess, newAccess;
774
                if (type == ArrowToDot) {
775
776
777
778
779
780
781
782
                    oldAccess = QStringLiteral("->");
                    newAccess = QStringLiteral(".");
                } else {
                    oldAccess = QStringLiteral(".");
                    newAccess = QStringLiteral("->");
                }

                auto oldRange = KTextEditor::Range(cursor - KTextEditor::Cursor(0, oldAccess.length()), cursor);
783
784
785
786
787
788
789
790

                // This code needed for testReplaceMemberAccess test
                // Maybe we should do a similar thing for '->' to '.' direction, but this is not so important
                while (textDocument->text(oldRange) == QLatin1String(" ") && oldRange.start().column() >= 0) {
                    oldRange = KTextEditor::Range({oldRange.start().line(), oldRange.start().column() - 1},
                                                  {oldRange.end().line(), oldRange.end().column() - 1});
                }

791
792
793
794
795
796
797
798
799
                if (oldRange.start().column() >= 0 && textDocument->text(oldRange) == oldAccess) {
                    textDocument->replaceText(oldRange, newAccess);
                }
            }
        }
    }
};
static MemberAccessReplacer s_memberAccessReplacer;

800
801
}

802
803
Q_DECLARE_METATYPE(MemberAccessReplacer::Type)

804
ClangCodeCompletionContext::ClangCodeCompletionContext(const DUContextPointer& context,
Kevin Funk's avatar
Kevin Funk committed
805
                                                       const ParseSessionData::Ptr& sessionData,
806
                                                       const QUrl& url,
Kevin Funk's avatar
Kevin Funk committed
807
                                                       const KTextEditor::Cursor& position,
808
809
                                                       const QString& text,
                                                       const QString& followingText
810
                                                      )
811
    : CodeCompletionContext(context, text + followingText, CursorInRevision::castFromSimpleCursor(position), 0)
812
    , m_results(nullptr, clang_disposeCodeCompleteResults)
Kevin Funk's avatar
Kevin Funk committed
813
    , m_parseSessionData(sessionData)
814
{
815
    qRegisterMetaType<MemberAccessReplacer::Type>();
816
817
    const QByteArray file = url.toLocalFile().toUtf8();
    ParseSession session(m_parseSessionData);
818
819
820
821
822
823
824
825

    QVector<UnsavedFile> otherUnsavedFiles;
    {
        ForegroundLock lock;
        otherUnsavedFiles = ClangUtils::unsavedFiles();
    }
    QVector<CXUnsavedFile> allUnsaved;

Kevin Funk's avatar
Kevin Funk committed
826
827
828
    {
        const unsigned int completeOptions = clang_defaultCodeCompleteOptions();

829
830
831
832
        CXUnsavedFile unsaved;
        unsaved.Filename = file.constData();
        const QByteArray content = m_text.toUtf8();
        unsaved.Contents = content.constData();
833
834
        unsaved.Length = content.size();

835
        allUnsaved.reserve(otherUnsavedFiles.size() + 1);
836
        for (const auto& f : qAsConst(otherUnsavedFiles)) {
837
838
839
            allUnsaved.append(f.toClangApi());
        }
        allUnsaved.append(unsaved);
840

841
842
        m_results.reset(clang_codeCompleteAt(session.unit(), file.constData(),
                        position.line() + 1, position.column() + 1,
843
                        allUnsaved.data(), allUnsaved.size(),
844
                        completeOptions));
Kevin Funk's avatar
Kevin Funk committed
845
846

        if (!m_results) {
847
            qCWarning(KDEV_CLANG) << "Something went wrong during 'clang_codeCompleteAt' for file" << file;
848
            return;
Kevin Funk's avatar
Kevin Funk committed
849
        }
850

851
852
853
854
855
856
857
858
859
        auto numDiagnostics = clang_codeCompleteGetNumDiagnostics(m_results.get());
        for (uint i = 0; i < numDiagnostics; i++) {
            auto diagnostic = clang_codeCompleteGetDiagnostic(m_results.get(), i);
            auto diagnosticType = ClangDiagnosticEvaluator::diagnosticType(diagnostic);
            clang_disposeDiagnostic(diagnostic);
            if (diagnosticType == ClangDiagnosticEvaluator::ReplaceWithArrowProblem || diagnosticType == ClangDiagnosticEvaluator::ReplaceWithDotProblem) {
                MemberAccessReplacer::Type replacementType;
                if (diagnosticType == ClangDiagnosticEvaluator::ReplaceWithDotProblem) {
                    replacementType = MemberAccessReplacer::ArrowToDot;
860
861
                } else {
                    replacementType = MemberAccessReplacer::DotToArrow;
862
863
864
865
866
867
868
869
870
871
                }

                QMetaObject::invokeMethod(&s_memberAccessReplacer, "replaceCurrentAccess", Qt::QueuedConnection,
                                          Q_ARG(MemberAccessReplacer::Type, replacementType));

                m_valid = false;
                return;
            }
        }

872
873
874
875
        auto addMacros = ClangSettingsManager::self()->codeCompletionSettings().macros;
        if (!addMacros) {
            m_filters |= NoMacros;
        }
876
    }
877

878
879
880
881
882
    if (!m_results->NumResults) {
        const auto trimmedText = text.trimmed();
        if (trimmedText.endsWith(QLatin1Char('.'))) {
            // TODO: This shouldn't be needed if Clang provided diagnostic.
            // But it doesn't always do it, so let's try to manually determine whether '.' is used instead of '->'
883
            m_text = trimmedText.leftRef(trimmedText.size() - 1) + QStringLiteral("->");
884
885
886
887
888

            CXUnsavedFile unsaved;
            unsaved.Filename = file.constData();
            const QByteArray content = m_text.toUtf8();
            unsaved.Contents = content.constData();
889
890
            unsaved.Length = content.size();
            allUnsaved[allUnsaved.size() - 1] = unsaved;
891
892

            m_results.reset(clang_codeCompleteAt(session.unit(), file.constData(),
893
                                                 position.line() + 1, position.column() + 1 + 1,
894
                                                 allUnsaved.data(), allUnsaved.size(),
895
896
897
898
899
900
901
902
903
904
905
906
                                                 clang_defaultCodeCompleteOptions()));

            if (m_results && m_results->NumResults) {
                QMetaObject::invokeMethod(&s_memberAccessReplacer, "replaceCurrentAccess", Qt::QueuedConnection,
                                          Q_ARG(MemberAccessReplacer::Type, MemberAccessReplacer::DotToArrow));
            }

            m_valid = false;
            return;
        }
    }

907
    // check 'isValidPosition' after parsing the new content
908
909
    auto clangFile = session.file(file);
    if (!isValidPosition(session.unit(), clangFile)) {
910
911
912
        m_valid = false;
        return;
    }
913

914
    m_completionHelper.computeCompletions(session, clangFile, position);
915
916
917
918
919
}

ClangCodeCompletionContext::~ClangCodeCompletionContext()
{
}
920

921
bool ClangCodeCompletionContext::isValidPosition(CXTranslationUnit unit, CXFile file) const
922
{
923
    if (isInsideComment(unit, file, m_position.castToSimpleCursor())) {
924
        clangDebug() << "Invalid completion context: Inside comment";
925
926
927
        return false;
    }
    return true;
928
929
}

930
QList<CompletionTreeItemPointer> ClangCodeCompletionContext::completionItems(bool& abort, bool /*fullCompletion*/)
931
{
932
933
934
935
    if (!m_valid || !m_duContext || !m_results) {
        return {};
    }

936
937
    const auto ctx = DUContextPointer(m_duContext->findContextAt(m_position));

Kevin Funk's avatar
Kevin Funk committed
938
    /// Normal completion items, such as 'void Foo::foo()'
939
    QList<CompletionTreeItemPointer> items;
Kevin Funk's avatar
Kevin Funk committed
940
941
942
    /// Stuff like 'Foo& Foo::operator=(const Foo&)', etc. Not regularly used by our users.
    QList<CompletionTreeItemPointer> specialItems;
    /// Macros from the current context
943
    QList<CompletionTreeItemPointer> macros;
Kevin Funk's avatar
Kevin Funk committed
944
    /// Builtins reported by Clang
945
    QList<CompletionTreeItemPointer> builtin;
946

947
948
    // two sets of handled declarations to prevent duplicates and make sure we show
    // all available overloads
949
    QSet<Declaration*> handled;
950
951
    // this is only used for the CXCursor_OverloadCandidate completion items
    QSet<Declaration*> overloadsHandled;
952

953
954
    LookAheadItemMatcher lookAheadMatcher(TopDUContextPointer(ctx->topContext()));

955
956
957
    // If ctx is/inside the Class context, this represents that context.
    const auto currentClassContext = classDeclarationForContext(ctx, m_position);

958
    clangDebug() << "Clang found" << m_results->NumResults << "completion results";
959

960
    for (uint i = 0; i < m_results->NumResults; ++i) {
961
962
963
964
        if (abort) {
            return {};
        }

965
        auto result = m_results->Results[i];
966
967
968
969
970
        #if CINDEX_VERSION_MINOR >= 30
        const bool isOverloadCandidate = result.CursorKind == CXCursor_OverloadCandidate;
        #else
        const bool isOverloadCandidate = false;
        #endif
971
972

        const auto availability = clang_getCompletionAvailability(result.CompletionString);
973
        if (availability == CXAvailability_NotAvailable) {
974
975
976
            continue;
        }

Kevin Funk's avatar
Kevin Funk committed
977
978
979
980
981
        const bool isMacroDefinition = result.CursorKind == CXCursor_MacroDefinition;
        if (isMacroDefinition && m_filters & NoMacros) {
            continue;
        }

982
983
984
985
986
987
988
989
990
991
        const bool isBuiltin = (result.CursorKind == CXCursor_NotImplemented);
        if (isBuiltin && m_filters & NoBuiltins) {
            continue;
        }

        const bool isDeclaration = !isMacroDefinition && !isBuiltin;
        if (isDeclaration && m_filters & NoDeclarations) {
            continue;
        }

992
        if (availability == CXAvailability_NotAccessible && (!isDeclaration || !currentClassContext)) {
993
994
995
            continue;
        }

996
        // the string that would be needed to type, usually the identifier of something. Also we use it as name for code completion declaration items.
997
        QString typed;
Milian Wolff's avatar
Milian Wolff committed
998
        // the return type of a function e.g.
999
        QString resultType;
Milian Wolff's avatar
Milian Wolff committed
1000
        // the replacement text when an item gets executed
1001
        QString replacement;
1002
1003
1004
1005

        QString arguments;

        ArgumentHintItem::CurrentArgumentRange argumentRange;
Milian Wolff's avatar
Milian Wolff committed
1006
1007
        //BEGIN function signature parsing
        // nesting depth of parentheses
1008
1009
        int parenDepth = 0;
        enum FunctionSignatureState {
Milian Wolff's avatar
Milian Wolff committed
1010
            // not yet inside the function signature
1011
            Before,
Milian Wolff's avatar
Milian Wolff committed
1012
            // any token is part of the function signature now
1013
            Inside,
Milian Wolff's avatar
Milian Wolff committed
1014
            // finished parsing the function signature
1015
1016
            After
        };
Milian Wolff's avatar
Milian Wolff committed
1017
        // current state
1018
        FunctionSignatureState signatureState = Before;
Milian Wolff's avatar
Milian Wolff committed
1019
        //END function signature parsing
Kevin Funk's avatar
Kevin Funk committed
1020

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
        std::function<void (CXCompletionString)> processChunks = [&] (CXCompletionString completionString) {
            const uint chunks = clang_getNumCompletionChunks(completionString);
            for (uint j = 0; j < chunks; ++j) {
                const auto kind = clang_getCompletionChunkKind(completionString, j);
                if (kind == CXCompletionChunk_Optional) {
                    completionString = clang_getCompletionChunkCompletionString(completionString, j);
                    if (completionString) {
                        processChunks(completionString);
                    }
                    continue;
1031
                }
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1032
1033
1034
1035

                // We don't need function signature for declaration items, we can get it directly from the declaration. Also adding the function signature to the "display" would break the "Detailed completion" option.
                if (isDeclaration && !typed.isEmpty()) {
                    // TODO: When parent context for CXCursor_OverloadCandidate is fixed remove this check
1036
                    if (!isOverloadCandidate) {
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1037
1038
1039
                        break;
                    }
                }
1040

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1041
                const QString string = ClangString(clang_getCompletionChunkText(completionString, j)).toString();
1042

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1043
                switch (kind) {
1044
1045
                case CXCompletionChunk_TypedText:
                    typed = string;
1046
                    replacement += string;
1047
1048
1049
1050
1051
                    break;
                case CXCompletionChunk_ResultType:
                    resultType = string;
                    continue;
                case CXCompletionChunk_Placeholder:
1052
                    if (signatureState == Inside) {
1053
                        arguments += string;
1054
                    }
1055
                    continue;
1056
1057
1058
1059
1060
1061
1062
1063
1064
                case CXCompletionChunk_LeftParen:
                    if (signatureState == Before && !parenDepth) {
                        signatureState = Inside;
                    }
                    parenDepth++;
                    break;
                case CXCompletionChunk_RightParen:
                    --parenDepth;
                    if (signatureState == Inside && !parenDepth) {
1065
                        arguments += QLatin1Char(')');
1066
1067
1068
                        signatureState = After;
                    }
                    break;
1069
                case CXCompletionChunk_Text:
1070
                    if (isOverloadCandidate) {
1071
1072
                        typed += string;
                    }
1073
1074
1075
                    else if (result.CursorKind == CXCursor_EnumConstantDecl) {
                        replacement += string;
                    }
1076
1077
1078
                    else if (result.CursorKind == CXCursor_EnumConstantDecl) {
                        replacement += string;
                    }
1079
                    break;
1080
1081
1082
1083
                case CXCompletionChunk_CurrentParameter:
                    argumentRange.start = arguments.size();
                    argumentRange.end = string.size();
                    break;
1084
1085
                default:
                    break;
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1086
1087
1088
1089
                }
                if (signatureState == Inside) {
                    arguments += string;
                }
1090
            }
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1091
1092
1093
        };

        processChunks(result.CompletionString);
1094

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1095
        // TODO: No closing paren if default parameters present
1096
        if (isOverloadCandidate && !arguments.endsWith(QLatin1Char(')'))) {
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1097
1098
            arguments += QLatin1Char(')');
        }
Kevin Funk's avatar
Kevin Funk committed
1099
1100
        // ellide text to the right for overly long result types (templates especially)
        elideStringRight(resultType, MAX_RETURN_TYPE_STRING_LENGTH);
1101

1102
1103
1104
        static const auto noIcon = QIcon(QStandardPaths::locate(QStandardPaths::GenericDataLocation,
                                                                QStringLiteral("kdevelop/pics/namespace.png")));

Kevin Funk's avatar
Kevin Funk committed
1105
        if (isDeclaration) {
1106
1107
1108
1109
1110
1111
1112
1113
            const Identifier id(typed);
            QualifiedIdentifier qid;
            ClangString parent(clang_getCompletionParent(result.CompletionString, nullptr));
            if (parent.c_str() != nullptr) {
                qid = QualifiedIdentifier(parent.toString());
            }
            qid.push(id);

1114
1115
1116
1117
            if (!isValidCompletionIdentifier(qid)) {
                continue;
            }

1118
1119
1120
1121
1122
1123
            if (isOverloadCandidate && resultType.isEmpty() && parent.isEmpty()) {
                // workaround: find constructor calls for non-namespaced classes
                // TODO: return the namespaced class as parent in libclang
                qid.push(id);
            }

1124
            auto found = findDeclaration(qid, ctx, m_position, isOverloadCandidate ? overloadsHandled : handled);
1125

1126
            CompletionTreeItemPointer item;
1127
            if (found) {
1128
1129
1130
1131
1132
1133
1134
                // TODO: Bug in Clang: protected members from base classes not accessible in derived classes.
                if (availability == CXAvailability_NotAccessible) {
                    if (auto cl = dynamic_cast<ClassMemberDeclaration*>(found)) {
                        if (cl->accessPolicy() != Declaration::Protected) {
                            continue;
                        }

1135
                        auto declarationClassContext = classDeclarationForContext(DUContextPointer(found->context()), m_position);
1136
1137

                        uint steps = 10;
1138
                        auto inheriters = DUChainUtils::inheriters(declarationClassContext, steps);
1139
1140
1141
1142
1143
1144
1145
1146
                        if(!inheriters.contains(currentClassContext)){
                            continue;
                        }
                    } else {
                        continue;
                    }
                }

1147
1148
1149
1150
1151
1152
1153
                DeclarationItem* declarationItem = nullptr;
                if (isOverloadCandidate) {
                    declarationItem = new ArgumentHintItem(found, resultType, typed, arguments, argumentRange);
                    declarationItem->setArgumentHintDepth(1);
                } else {
                    declarationItem = new DeclarationItem(found, typed, resultType, replacement);
                }
1154

1155
1156
                const unsigned int completionPriority = adjustPriorityForDeclaration(found, clang_getCompletionPriority(result.CompletionString));
                const bool bestMatch = completionPriority <= CCP_SuperCompletion;
1157
1158

                //don't set best match property for internal identifiers, also prefer declarations from current file
1159
1160
                const auto isInternal = found->indexedIdentifier().identifier().toString().startsWith(QLatin1String("__"));
                if (bestMatch && !isInternal ) {
Kevin Funk's avatar
Kevin Funk committed
1161
                    const int matchQuality = codeCompletionPriorityToMatchQuality(completionPriority);
1162
                    declarationItem->setMatchQuality(matchQuality);
1163
1164
1165

                    // TODO: LibClang missing API to determine expected code completion type.
                    lookAheadMatcher.addMatchedType(found->indexedType());
1166
1167
                } else {
                    declarationItem->setInheritanceDepth(completionPriority);
1168

1169
1170
                    lookAheadMatcher.addDeclarations(found);
                }
1171
1172
1173
                if ( isInternal ) {
                    declarationItem->markAsUnimportant();
                }
1174

1175
                item = declarationItem;