Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

context.cpp 46.8 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

Olivier JG's avatar
Olivier JG committed
48
#include "../util/clangdebug.h"
49
#include "../util/clangtypes.h"
50
#include "../util/clangutils.h"
51
#include "../duchain/clangdiagnosticevaluator.h"
Olivier JG's avatar
Olivier JG committed
52
#include "../duchain/parsesession.h"
53
#include "../duchain/duchainutils.h"
54
#include "../duchain/navigationwidget.h"
55
#include "../clangsettings/clangsettingsmanager.h"
56

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

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

using namespace KDevelop;

namespace {
Kevin Funk's avatar
Kevin Funk committed
66 67
/// Maximum return-type string length in completion items
const int MAX_RETURN_TYPE_STRING_LENGTH = 20;
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
/// 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
};

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

122
    ~CompletionItem() override = default;
123

124 125 126 127 128 129 130 131
    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;
            }
132
        }
133
        return {};
134
    }
135

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

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

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

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

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

private:
    QString m_returnType;
177 178
};

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

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

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

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

        if(!m_declaration){
            return;
        }

        if(m_declaration->isFunctionDeclaration()) {
215
            auto doc = view->document();
216 217 218 219 220 221 222 223 224 225 226 227 228

            // 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;
                }
            }

229
            bool didAddParentheses = false;
230
            if ( !funcptr && doc->characterAt(word.end()) != QLatin1Char('(') ) {
231
                repl += QLatin1String("()");
232
                didAddParentheses = true;
233
            }
Kevin Funk's avatar
Kevin Funk committed
234
            view->document()->replaceText(word, repl);
235
            auto f = m_declaration->type<FunctionType>();
236
            if (f && f->indexedArgumentsSize() && didAddParentheses) {
Kevin Funk's avatar
Kevin Funk committed
237
                view->setCursorPosition(word.start() + KTextEditor::Cursor(0, repl.size() - 1));
238
            }
239 240 241 242 243 244 245 246 247 248 249 250 251
            auto returnTypeIntegral = f->returnType().cast<IntegralType>();
            if ( !funcptr && returnTypeIntegral && returnTypeIntegral->dataType() == IntegralType::TypeVoid ) {
                // function returns void -- nothing can be done with the result
                if ( f && f->indexedArgumentsSize() ) {
                    // 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});
                }
            }
252
        } else {
Kevin Funk's avatar
Kevin Funk committed
253
            view->document()->replaceText(word, repl);
254 255 256
        }
    }

257 258 259 260 261 262 263
    bool createsExpandingWidget() const override
    {
        return true;
    }

    QWidget* createExpandingWidget(const CodeCompletionModel* /*model*/) const override
    {
264
        return new ClangNavigationWidget(m_declaration, KDevelop::AbstractNavigationWidget::EmbeddableWidget);
265
    }
266

Kevin Funk's avatar
Kevin Funk committed
267 268 269 270 271
    int matchQuality() const
    {
        return m_matchQuality;
    }

272
    ///Sets match quality from 0 to 10. 10 is the best fit.
Kevin Funk's avatar
Kevin Funk committed
273
    void setMatchQuality(int value)
274
    {
Kevin Funk's avatar
Kevin Funk committed
275
        m_matchQuality = value;
276 277
    }

278 279 280 281 282
    void setInheritanceDepth(int depth)
    {
        m_inheritanceDepth = depth;
    }

283 284 285 286 287 288 289 290 291 292
    int argumentHintDepth() const override
    {
        return m_depth;
    }

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

293
protected:
Kevin Funk's avatar
Kevin Funk committed
294
    int m_matchQuality = 0;
295
    int m_depth = 0;
296
    QString m_replacement;
297
};
298

299 300 301 302 303 304 305 306 307 308 309 310 311
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;
    }

312
    explicit ImplementsItem(const FuncImplementInfo& item)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
        : 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);
    }
};
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

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
351
    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
    {
        if (role == CodeCompletionModel::CustomHighlight && index.column() == CodeCompletionModel::Arguments && argumentHintDepth()) {
            QList<QVariant> highlighting;
            highlighting << QVariant(m_range.start);
            highlighting << QVariant(m_range.end);
            QTextCharFormat boldFormat;
            boldFormat.setFontWeight(QFont::Bold);
            highlighting << boldFormat;
            return highlighting;
        }

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

        if (index.column() == CodeCompletionModel::Arguments && !m_declaration) {
            return m_arguments;
        }

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

private:
    CurrentArgumentRange m_range;
    QString m_arguments;
};

379 380 381
/**
 * A minimalistic completion item for macros and such
 */
382 383 384
class SimpleItem : public CompletionItem<CompletionTreeItem>
{
public:
385
    SimpleItem(const QString& display, const QString& prefix, const QString& replacement, const QIcon& icon = QIcon())
386 387
        : CompletionItem<CompletionTreeItem>(display, prefix)
        , m_replacement(replacement)
388
        , m_icon(icon)
389 390 391 392 393 394 395 396
    {
    }

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

397 398 399 400 401
    QVariant data(const QModelIndex& index, int role, const CodeCompletionModel* model) const override
    {
        if (role == Qt::DecorationRole && index.column() == KTextEditor::CodeCompletionModel::Icon) {
            return m_icon;
        }
402 403 404
        if (role == KDevelop::CodeCompletionModel::UnimportantItemRole) {
            return m_unimportant;
        }
405 406 407
        return CompletionItem<CompletionTreeItem>::data(index, role, model);
    }

408 409
private:
    QString m_replacement;
410
    QIcon m_icon;
411
};
412

413 414 415
/**
 * Return true in case position @p position represents a cursor inside a comment
 */
Kevin Funk's avatar
Kevin Funk committed
416
bool isInsideComment(CXTranslationUnit unit, CXFile file, const KTextEditor::Cursor& position)
417 418 419 420 421 422 423
{
    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
424
    auto end = clang_getLocation(unit, file, position.line() + 1, position.column() + 1);
425 426 427 428
    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
429 430
    const ClangTokens tokens(unit, range);
    for (CXToken token : tokens) {
431 432 433 434 435 436
        CXTokenKind tokenKind = clang_getTokenKind(token);
        if (tokenKind != CXToken_Comment) {
            continue;
        }

        auto range = ClangRange(clang_getTokenExtent(unit, token));
Kevin Funk's avatar
Kevin Funk committed
437
        if (range.toRange().contains(position)) {
438 439 440 441 442 443
            return true;
        }
    }
    return false;
}

Kevin Funk's avatar
Kevin Funk committed
444 445 446
QString& elideStringRight(QString& str, int length)
{
    if (str.size() > length + 3) {
447
        return str.replace(length, str.size() - length, QStringLiteral("..."));
Kevin Funk's avatar
Kevin Funk committed
448 449 450 451
    }
    return str;
}

Kevin Funk's avatar
Kevin Funk committed
452
/**
453
 * @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
454 455 456 457 458 459
 *
 * 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)
{
460
    return 10u - qBound(0u, completionPriority, 80u) / 8;
Kevin Funk's avatar
Kevin Funk committed
461 462
}

463
int adjustPriorityForType(const AbstractType::Ptr& type, int completionPriority)
464
{
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
    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);
482
        }
483 484
    } else {
        completionPriority += modifier;
485 486 487 488 489
    }

    return completionPriority;
}

490 491 492 493 494 495 496 497 498 499
/// 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);
}

500 501 502
/**
 * @return Whether the declaration represented by identifier @p identifier qualifies as completion result
 *
Kevin Funk's avatar
Kevin Funk committed
503 504
 * 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();')
505 506 507 508 509 510 511 512 513 514 515 516 517 518
 */
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();
519
    if (idString.startsWith(QLatin1Char('~')) && scope.toString() == idString.midRef(1)) {
520 521 522 523 524
        return false; // is destructor
    }
    return true;
}

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
/**
 * @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();
541
    if (idString.startsWith(QLatin1String("operator="))) {
542 543 544 545 546
        return true; // is assignment operator
    }
    return false;
}

547
Declaration* findDeclaration(const QualifiedIdentifier& qid, const DUContextPointer& ctx, const CursorInRevision& position, QSet<Declaration*>& handled)
548
{
549
    PersistentSymbolTable::Declarations decl = PersistentSymbolTable::self().getDeclarations(qid);
550

551 552 553
    const auto top = ctx->topContext();
    const auto& importedContexts = top->importedParentContexts();

554
    for (auto it = decl.iterator(); it; ++it) {
555 556 557 558 559 560 561 562 563 564 565 566
        // 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;
        }

567
        auto declaration = it->declaration();
568 569 570 571 572 573 574
        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;
        }

575
        if (declaration->kind() == Declaration::Instance && !declaration->isFunctionDeclaration()) {
576 577
            break;
        }
578 579
        if (!handled.contains(declaration)) {
            handled.insert(declaration);
580
            return declaration;
581 582 583 584 585 586 587
        }
    }

    const auto foundDeclarations = ctx->findDeclarations(qid, position);
    for (auto dec : foundDeclarations) {
        if (!handled.contains(dec)) {
            handled.insert(dec);
588
            return dec;
589 590 591
        }
    }

592
    return nullptr;
593 594
}

595
/// If any parent of this context is a class, the closest class declaration is returned, nullptr otherwise
596
Declaration* classDeclarationForContext(const DUContextPointer& context, const CursorInRevision& position)
597 598 599 600 601 602
{
    auto parent = context;
    while (parent) {
        if (parent->type() == DUContext::Class) {
            break;
        }
603 604 605 606 607 608 609 610

        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;
611
                auto decl = findDeclaration(qid, context, position, tmp);
612 613 614 615 616 617 618

                if (decl && decl->internalContext() && decl->internalContext()->type() == DUContext::Class) {
                    parent = decl->internalContext();
                    break;
                }
            }
        }
619 620 621 622 623 624
        parent = parent->parentContext();
    }

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

625 626 627
class LookAheadItemMatcher
{
public:
628
    explicit LookAheadItemMatcher(const TopDUContextPointer& ctx)
629 630 631 632 633 634 635 636 637 638 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
        : 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;
664 665
        for (const auto& pair: possibleLookAheadDeclarations) {
            auto decl = pair.first;
666
            if (matchedTypes.contains(decl->indexedType())) {
667 668 669 670
                auto parent = pair.second;
                const QString access = parent->abstractType()->whichType() == AbstractType::TypePointer
                                 ? QStringLiteral("->") : QStringLiteral(".");
                const QString text = parent->identifier().toString() + access + decl->identifier().toString();
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
                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;
                }

                for (auto localDecl : typeDecl->internalContext()->localDeclarations()) {
                    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;
                            }
                        }
                    }

718
                    possibleLookAheadDeclarations.insert({localDecl, declaration});
719 720 721 722 723 724 725 726 727 728 729 730
                }
            }
        }
    }

    // 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
731 732
    // Second declaration represents context
    QSet<DeclarationContext> possibleLookAheadDeclarations;
733 734 735 736 737 738

    TopDUContextPointer m_topContext;

    bool m_enabled;
};

739 740 741 742 743 744 745 746 747 748 749
struct MemberAccessReplacer : public QObject
{
    Q_OBJECT

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

750
public Q_SLOTS:
751 752 753 754 755 756 757 758 759 760 761 762
    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;
763
                if (type == ArrowToDot) {
764 765 766 767 768 769 770 771
                    oldAccess = QStringLiteral("->");
                    newAccess = QStringLiteral(".");
                } else {
                    oldAccess = QStringLiteral(".");
                    newAccess = QStringLiteral("->");
                }

                auto oldRange = KTextEditor::Range(cursor - KTextEditor::Cursor(0, oldAccess.length()), cursor);
772 773 774 775 776 777 778 779

                // 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});
                }

780 781 782 783 784 785 786 787 788
                if (oldRange.start().column() >= 0 && textDocument->text(oldRange) == oldAccess) {
                    textDocument->replaceText(oldRange, newAccess);
                }
            }
        }
    }
};
static MemberAccessReplacer s_memberAccessReplacer;

789 790
}

791 792
Q_DECLARE_METATYPE(MemberAccessReplacer::Type)

793
ClangCodeCompletionContext::ClangCodeCompletionContext(const DUContextPointer& context,
Kevin Funk's avatar
Kevin Funk committed
794
                                                       const ParseSessionData::Ptr& sessionData,
795
                                                       const QUrl& url,
Kevin Funk's avatar
Kevin Funk committed
796
                                                       const KTextEditor::Cursor& position,
797 798
                                                       const QString& text,
                                                       const QString& followingText
799
                                                      )
800
    : CodeCompletionContext(context, text + followingText, CursorInRevision::castFromSimpleCursor(position), 0)
801
    , m_results(nullptr, clang_disposeCodeCompleteResults)
Kevin Funk's avatar
Kevin Funk committed
802
    , m_parseSessionData(sessionData)
803
{
804
    qRegisterMetaType<MemberAccessReplacer::Type>();
805 806
    const QByteArray file = url.toLocalFile().toUtf8();
    ParseSession session(m_parseSessionData);
807 808 809 810 811 812 813 814

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

Kevin Funk's avatar
Kevin Funk committed
815 816 817
    {
        const unsigned int completeOptions = clang_defaultCodeCompleteOptions();

818 819 820 821
        CXUnsavedFile unsaved;
        unsaved.Filename = file.constData();
        const QByteArray content = m_text.toUtf8();
        unsaved.Contents = content.constData();
822 823 824 825 826 827
        unsaved.Length = content.size();

        for ( const auto& f : otherUnsavedFiles ) {
            allUnsaved.append(f.toClangApi());
        }
        allUnsaved.append(unsaved);
828

829 830
        m_results.reset(clang_codeCompleteAt(session.unit(), file.constData(),
                        position.line() + 1, position.column() + 1,
831
                        allUnsaved.data(), allUnsaved.size(),
832
                        completeOptions));
Kevin Funk's avatar
Kevin Funk committed
833 834

        if (!m_results) {
835
            qCWarning(KDEV_CLANG) << "Something went wrong during 'clang_codeCompleteAt' for file" << file;
836
            return;
Kevin Funk's avatar
Kevin Funk committed
837
        }
838

839 840 841 842 843 844 845 846 847
        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;
848 849
                } else {
                    replacementType = MemberAccessReplacer::DotToArrow;
850 851 852 853 854 855 856 857 858 859
                }

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

                m_valid = false;
                return;
            }
        }

860 861 862 863
        auto addMacros = ClangSettingsManager::self()->codeCompletionSettings().macros;
        if (!addMacros) {
            m_filters |= NoMacros;
        }
864
    }
865

866 867 868 869 870 871 872 873 874 875 876 877
    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 '->'
            m_text = trimmedText.left(trimmedText.size() - 1);
            m_text += QStringLiteral("->");

            CXUnsavedFile unsaved;
            unsaved.Filename = file.constData();
            const QByteArray content = m_text.toUtf8();
            unsaved.Contents = content.constData();
878 879
            unsaved.Length = content.size();
            allUnsaved[allUnsaved.size() - 1] = unsaved;
880 881

            m_results.reset(clang_codeCompleteAt(session.unit(), file.constData(),
882
                                                 position.line() + 1, position.column() + 1 + 1,
883
                                                 allUnsaved.data(), allUnsaved.size(),
884 885 886 887 888 889 890 891 892 893 894 895
                                                 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;
        }
    }

896
    // check 'isValidPosition' after parsing the new content
897 898
    auto clangFile = session.file(file);
    if (!isValidPosition(session.unit(), clangFile)) {
899 900 901
        m_valid = false;
        return;
    }
902

903
    m_completionHelper.computeCompletions(session, clangFile, position);
904 905 906 907 908
}

ClangCodeCompletionContext::~ClangCodeCompletionContext()
{
}
909

910
bool ClangCodeCompletionContext::isValidPosition(CXTranslationUnit unit, CXFile file) const
911
{
912
    if (isInsideComment(unit, file, m_position.castToSimpleCursor())) {
Olivier JG's avatar
Olivier JG committed
913
        clangDebug() << "Invalid completion context: Inside comment";
914 915 916
        return false;
    }
    return true;
917 918
}

919
QList<CompletionTreeItemPointer> ClangCodeCompletionContext::completionItems(bool& abort, bool /*fullCompletion*/)
920
{
921 922 923 924
    if (!m_valid || !m_duContext || !m_results) {
        return {};
    }

925 926
    const auto ctx = DUContextPointer(m_duContext->findContextAt(m_position));

Kevin Funk's avatar
Kevin Funk committed
927
    /// Normal completion items, such as 'void Foo::foo()'
928
    QList<CompletionTreeItemPointer> items;
Kevin Funk's avatar
Kevin Funk committed
929 930 931
    /// Stuff like 'Foo& Foo::operator=(const Foo&)', etc. Not regularly used by our users.
    QList<CompletionTreeItemPointer> specialItems;
    /// Macros from the current context
932
    QList<CompletionTreeItemPointer> macros;
Kevin Funk's avatar
Kevin Funk committed
933
    /// Builtins reported by Clang
934
    QList<CompletionTreeItemPointer> builtin;
935

936
    QSet<Declaration*> handled;
937

938 939
    LookAheadItemMatcher lookAheadMatcher(TopDUContextPointer(ctx->topContext()));

940 941 942
    // If ctx is/inside the Class context, this represents that context.
    const auto currentClassContext = classDeclarationForContext(ctx, m_position);

Olivier JG's avatar
Olivier JG committed
943
    clangDebug() << "Clang found" << m_results->NumResults << "completion results";
944

945
    for (uint i = 0; i < m_results->NumResults; ++i) {
946 947 948 949
        if (abort) {
            return {};
        }

950
        auto result = m_results->Results[i];
951 952

        const auto availability = clang_getCompletionAvailability(result.CompletionString);
953
        if (availability == CXAvailability_NotAvailable) {
954 955 956
            continue;
        }

Kevin Funk's avatar
Kevin Funk committed
957 958 959 960 961
        const bool isMacroDefinition = result.CursorKind == CXCursor_MacroDefinition;
        if (isMacroDefinition && m_filters & NoMacros) {
            continue;
        }

962 963 964 965 966 967 968 969 970 971
        const bool isBuiltin = (result.CursorKind == CXCursor_NotImplemented);
        if (isBuiltin && m_filters & NoBuiltins) {
            continue;
        }

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

972
        if (availability == CXAvailability_NotAccessible && (!isDeclaration || !currentClassContext)) {
973 974 975
            continue;
        }

976
        // the string that would be needed to type, usually the identifier of something. Also we use it as name for code completion declaration items.
977
        QString typed;
Milian Wolff's avatar
Milian Wolff committed
978
        // the return type of a function e.g.
979
        QString resultType;
Milian Wolff's avatar
Milian Wolff committed
980
        // the replacement text when an item gets executed
981
        QString replacement;
982 983 984 985

        QString arguments;

        ArgumentHintItem::CurrentArgumentRange argumentRange;
Milian Wolff's avatar
Milian Wolff committed
986 987
        //BEGIN function signature parsing
        // nesting depth of parentheses
988 989
        int parenDepth = 0;
        enum FunctionSignatureState {
Milian Wolff's avatar
Milian Wolff committed
990
            // not yet inside the function signature
991
            Before,
Milian Wolff's avatar
Milian Wolff committed
992
            // any token is part of the function signature now
993
            Inside,
Milian Wolff's avatar
Milian Wolff committed
994
            // finished parsing the function signature
995 996
            After
        };
Milian Wolff's avatar
Milian Wolff committed
997
        // current state
998
        FunctionSignatureState signatureState = Before;
Milian Wolff's avatar
Milian Wolff committed
999
        //END function signature parsing
Kevin Funk's avatar
Kevin Funk committed
1000

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
        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;
1011
                }
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1012 1013 1014 1015 1016 1017 1018 1019

                // 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()) {
#if CINDEX_VERSION_MINOR >= 30
                    // TODO: When parent context for CXCursor_OverloadCandidate is fixed remove this check
                    if (result.CursorKind != CXCursor_OverloadCandidate) {
                        break;
                    }
1020
#else
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1021
                    break;
1022
#endif
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1023
                }
1024

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

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1027
                switch (kind) {
1028 1029
                case CXCompletionChunk_TypedText:
                    typed = string;
1030
                    replacement = string;
1031 1032 1033 1034 1035
                    break;
                case CXCompletionChunk_ResultType:
                    resultType = string;
                    continue;
                case CXCompletionChunk_Placeholder:
1036
                    if (signatureState == Inside) {
1037
                        arguments += string;
1038
                    }
1039
                    continue;
1040 1041 1042 1043 1044 1045 1046 1047 1048
                case CXCompletionChunk_LeftParen:
                    if (signatureState == Before && !parenDepth) {
                        signatureState = Inside;
                    }
                    parenDepth++;
                    break;
                case CXCompletionChunk_RightParen:
                    --parenDepth;
                    if (signatureState == Inside && !parenDepth) {
1049
                        arguments += QLatin1Char(')');
1050 1051 1052
                        signatureState = After;
                    }
                    break;
1053 1054 1055 1056 1057 1058 1059
                case CXCompletionChunk_Text:
#if CINDEX_VERSION_MINOR >= 30
                    if (result.CursorKind == CXCursor_OverloadCandidate) {
                        typed += string;
                    }
#endif
                    break;
1060 1061 1062 1063
                case CXCompletionChunk_CurrentParameter:
                    argumentRange.start = arguments.size();
                    argumentRange.end = string.size();
                    break;
1064 1065
                default:
                    break;
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1066 1067 1068 1069
                }
                if (signatureState == Inside) {
                    arguments += string;
                }
1070
            }
Sergey Kalinichev's avatar
Sergey Kalinichev committed
1071 1072 1073
        };

        processChunks(result.CompletionString);
1074

Sergey Kalinichev's avatar
Sergey Kalinichev committed
1075 1076 1077 1078 1079 1080
#if CINDEX_VERSION_MINOR >= 30
        // TODO: No closing paren if default parameters present
        if (result.CursorKind == CXCursor_OverloadCandidate && !arguments.endsWith(QLatin1Char(')'))) {
            arguments += QLatin1Char(')');
        }
#endif
Kevin Funk's avatar
Kevin Funk committed
1081 1082
        // ellide text to the right for overly long result types (templates especially)
        elideStringRight(resultType, MAX_RETURN_TYPE_STRING_LENGTH);
1083

1084 1085 1086
        static const auto noIcon = QIcon(QStandardPaths::locate(QStandardPaths::GenericDataLocation,
                                                                QStringLiteral("kdevelop/pics/namespace.png")));

Kevin Funk's avatar
Kevin Funk committed
1087
        if (isDeclaration) {
1088 1089 1090 1091 1092 1093 1094 1095
            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);

1096 1097 1098 1099
            if (!isValidCompletionIdentifier(qid)) {
                continue;
            }

1100
            auto found = findDeclaration(qid, ctx, m_position, handled);
1101

1102
            CompletionTreeItemPointer item;
1103
            if (found) {
1104 1105 1106 1107 1108 1109 1110
                // 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;
                        }

1111
                        auto declarationClassContext = classDeclarationForContext(DUContextPointer(found->context()), m_position);
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122

                        uint steps = 10;
                        auto inheriters = DUChainUtils::getInheriters(declarationClassContext, steps);
                        if(!inheriters.contains(currentClassContext)){
                            continue;
                        }
                    } else {
                        continue;
                    }
                }

1123
                auto declarationItem = new DeclarationItem(found, typed, resultType, replacement);
1124

1125 1126
                const unsigned int completionPriority = adjustPriorityForDeclaration(found, clang_getCompletionPriority(result.CompletionString));
                const bool bestMatch = completionPriority <= CCP_SuperCompletion;
1127 1128

                //don't set best match property for internal identifiers, also prefer declarations from current file
1129 1130
                const auto isInternal = found->indexedIdentifier().identifier().toString().startsWith(QLatin1String("__"));
                if (bestMatch && !isInternal ) {
Kevin Funk's avatar
Kevin Funk committed
1131
                    const int matchQuality = codeCompletionPriorityToMatchQuality(completionPriority);
1132
                    declarationItem->setMatchQuality(matchQuality);
1133 1134 1135

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

1139 1140
                    lookAheadMatcher.addDeclarations(found);
                }
1141 1142 1143
                if ( isInternal ) {
                    declarationItem->markAsUnimportant();
                }
1144 1145 1146 1147 1148 1149
#if CINDEX_VERSION_MINOR >= 30
                if (result.CursorKind == CXCursor_OverloadCandidate) {
                    declarationItem->setArgumentHintDepth(1);
                }
#endif

1150
                item = declarationItem;
1151
            } else {
1152 1153 1154
#if CINDEX_VERSION_MINOR >= 30
                if (result.CursorKind == CXCursor_OverloadCandidate) {
                    // TODO: No parent context for CXCursor_OverloadCandidate items, hence qid is broken -> no declaration found
1155 1156 1157
                    auto ahi = new ArgumentHintItem({}, resultType, typed, arguments, argumentRange);
                    ahi->setArgumentHintDepth(1);
                    item = ahi;
1158 1159 1160 1161
                } else {
#endif
                    // still, let's trust that Clang found something useful and put it into the completion result list
                    clangDebug() << "Could not find declaration for" << qid;
1162
                    auto instance = new SimpleItem(typed + arguments, resultType, replacement, noIcon);
1163 1164
                    instance->markAsUnimportant();
                    item = CompletionTreeItemPointer(instance);
1165 1166 1167
#if CINDEX_VERSION_MINOR >= 30
                }
#endif
1168
            }
1169 1170

            if (isValidSpecialCompletionIdentifier(qid)) {
1171 1172 1173 1174 1175
                // If it's a special completion identifier e.g. "operator=(const&)" and we don't have a declaration for it, don't add it into completion list, as this item is completely useless and pollutes the test case.
                // This happens e.g. for "class A{}; a.|".  At | we have "operator=(const A&)" as a special completion identifier without a declaration.
                if(item->declaration()){
                    specialItems.append(item);
                }
1176 1177 1178 1179
            } else {
                items.append(item);
            }
            continue;
1180 1181
        }

1182 1183
        if (result.CursorKind == CXCursor_MacroDefinition) {
            // TODO: grouping of macros and built-in stuff
1184 1185 1186 1187 1188 1189
            const auto text = QString(typed + arguments);
            auto instance = new SimpleItem(text, resultType, replacement, noIcon);
            auto item = CompletionTreeItemPointer(instance);
            if ( text.startsWith(QLatin1String("_")) ) {
                instance->markAsUnimportant();
            }
1190
            macros.append(item);
Kevin Funk's avatar
Kevin Funk committed
1191
        } else if (result.CursorKind == CXCursor_NotImplemented) {
1192
            auto instance = new SimpleItem(typed, resultType, replacement, noIcon);
1193
            auto item = CompletionTreeItemPointer(instance);
1194 1195 1196 1197
            builtin.append(item);
        }
    }

1198 1199 1200 1201
    if (abort) {
        return {};
    }

1202
    addImplementationHelperItems();
1203 1204
    addOverwritableItems();

Kevin Funk's avatar
Kevin Funk committed
1205
    eventuallyAddGroup(i18n("Special"), 700, specialItems);
1206 1207 1208
    eventuallyAddGroup(i18n("Look-ahead Matches"), 800, lookAheadMatcher.matchedItems());
    eventuallyAddGroup(i18n("Builtin"), 900, builtin);
    eventuallyAddGroup(i18n("Macros"), 1000, macros);
Kevin Funk's avatar
Kevin Funk committed
1209 1210
    return items;
}
1211

Kevin Funk's avatar
Kevin Funk committed
1212 1213
void ClangCodeCompletionContext::eventuallyAddGroup(const QString& name, int priority,
                                                    const QList<CompletionTreeItemPointer>& items)
Kevin Funk's avatar
Kevin Funk committed
1214 1215 1216
{
    if (items.isEmpty()) {
        return;
1217
    }
Kevin Funk's avatar
Kevin Funk committed
1218 1219 1220 1221

    KDevelop::CompletionCustomGroupNode* node = new KDevelop::CompletionCustomGroupNode(name, priority);
    node->appendChildren(items);
    m_ungrouped << CompletionTreeElementPointer(node);
1222
}
1223

1224 1225 1226 1227 1228 1229 1230 1231
void ClangCodeCompletionContext::addOverwritableItems()
{
    auto overrideList = m_completionHelper.overrides();
    if (overrideList.isEmpty()) {
        return;
    }

    QList<CompletionTreeItemPointer> overrides;
1232
    QList<CompletionTreeItemPointer> overridesAbstract;
1233 1234 1235 1236 1237 1238
    for (const auto& info : overrideList) {
        QStringList params;
        for (const auto& param : info.params) {
            params << param.type + QLatin1Char(' ') + param.id;
        }
        QString nameAndParams = info.name + QLatin1Char('(') + params.join(QStringLiteral(", ")) + QLatin1Char(')');
1239
        if(info.isConst)
1240
            nameAndParams = nameAndParams + QLatin1String(" const");
1241
        if(info.isPureVirtual)
1242
            nameAndParams = nameAndParams + QLatin1String(" = 0");
1243 1244