cppeditor.cpp 82.6 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "cppeditor.h"
31

con's avatar
con committed
32
#include "cppeditorconstants.h"
33
#include "cppeditorplugin.h"
con's avatar
con committed
34
#include "cpphighlighter.h"
35
#include "cppautocompleter.h"
Leandro Melo's avatar
Leandro Melo committed
36
#include "cppquickfixassistant.h"
Roberto Raggi's avatar
Roberto Raggi committed
37

38 39 40
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/icore.h>
Roberto Raggi's avatar
Roberto Raggi committed
41
#include <cpptools/cpptoolsplugin.h>
42
#include <cpptools/cpptoolsconstants.h>
43
#include <cpptools/cppchecksymbols.h>
Christian Kamm's avatar
Christian Kamm committed
44
#include <cpptools/cppcodeformatter.h>
45 46 47
#include <cpptools/cppcompletionsupport.h>
#include <cpptools/cpphighlightingsupport.h>
#include <cpptools/cpplocalsymbols.h>
48
#include <cpptools/cppqtstyleindenter.h>
49
#include <cpptools/cpptoolsreuse.h>
50 51
#include <cpptools/doxygengenerator.h>
#include <cpptools/cpptoolssettings.h>
52
#include <cpptools/symbolfinder.h>
con's avatar
con committed
53
#include <texteditor/basetextdocument.h>
54
#include <texteditor/basetextdocumentlayout.h>
55 56 57
#include <texteditor/codeassist/basicproposalitem.h>
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/genericproposal.h>
con's avatar
con committed
58
#include <texteditor/fontsettings.h>
59
#include <texteditor/refactoroverlay.h>
60 61 62 63 64 65 66

#include <utils/qtcassert.h>

#include <cplusplus/ASTPath.h>
#include <cplusplus/ExpressionUnderCursor.h>
#include <cplusplus/OverviewModel.h>
#include <cplusplus/BackwardsScanner.h>
con's avatar
con committed
67

68 69
#include <QDebug>
#include <QTimer>
70
#include <QPointer>
71 72 73 74 75 76 77 78
#include <QSignalMapper>
#include <QAction>
#include <QHeaderView>
#include <QMenu>
#include <QTextEdit>
#include <QComboBox>
#include <QTreeView>
#include <QSortFilterProxyModel>
con's avatar
con committed
79

Roberto Raggi's avatar
Roberto Raggi committed
80
enum {
81
    UPDATE_OUTLINE_INTERVAL = 500,
82 83
    UPDATE_USES_INTERVAL = 500,
    UPDATE_FUNCTION_DECL_DEF_LINK_INTERVAL = 200
Roberto Raggi's avatar
Roberto Raggi committed
84 85
};

Roberto Raggi's avatar
Roberto Raggi committed
86
using namespace CPlusPlus;
87
using namespace CppTools;
Roberto Raggi's avatar
Roberto Raggi committed
88 89
using namespace CppEditor::Internal;

90 91 92 93
namespace {
bool semanticHighlighterDisabled = qstrcmp(qVersion(), "4.7.0") == 0;
}

con's avatar
con committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
namespace {

class OverviewTreeView : public QTreeView
{
public:
    OverviewTreeView(QWidget *parent = 0)
        : QTreeView(parent)
    {
        // TODO: Disable the root for all items (with a custom delegate?)
        setRootIsDecorated(false);
    }

    void sync()
    {
        expandAll();
109 110 111 112
    }

    void adjustWidth()
    {
hjk's avatar
hjk committed
113
        const int w = Core::ICore::mainWindow()->geometry().width();
114 115 116 117 118 119 120 121
        setMaximumWidth(w);
        setMinimumWidth(qMin(qMax(sizeHintForColumn(0), minimumSizeHint().width()), w));
    }
};

class OverviewCombo : public QComboBox
{
public:
122
    OverviewCombo(QWidget *parent = 0) : QComboBox(parent), m_skipNextHide(false)
123 124
    {}

125 126 127 128 129 130 131 132 133 134 135
    bool eventFilter(QObject* object, QEvent* event)
    {
        if (event->type() == QEvent::MouseButtonPress && object == view()->viewport()) {
            QMouseEvent* mouseEvent = static_cast<QMouseEvent*>(event);
            QModelIndex index = view()->indexAt(mouseEvent->pos());
            if (!view()->visualRect(index).contains(mouseEvent->pos()))
                m_skipNextHide = true;
        }
        return false;
    }

136 137 138 139
    void showPopup()
    {
        static_cast<OverviewTreeView *>(view())->adjustWidth();
        QComboBox::showPopup();
con's avatar
con committed
140
    }
141 142 143 144 145 146 147 148 149 150 151

    virtual void hidePopup()
    {
        if (m_skipNextHide)
            m_skipNextHide = false;
        else
            QComboBox::hidePopup();
    }

private:
    bool m_skipNextHide;
con's avatar
con committed
152 153
};

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
class OverviewProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
public:
    OverviewProxyModel(CPlusPlus::OverviewModel *sourceModel, QObject *parent) :
        QSortFilterProxyModel(parent),
        m_sourceModel(sourceModel)
    {
        setSourceModel(m_sourceModel);
    }

    bool filterAcceptsRow(int sourceRow,const QModelIndex &sourceParent) const
    {
        // ignore generated symbols, e.g. by macro expansion (Q_OBJECT)
        const QModelIndex sourceIndex = m_sourceModel->index(sourceRow, 0, sourceParent);
        CPlusPlus::Symbol *symbol = m_sourceModel->symbolFromIndex(sourceIndex);
        if (symbol && symbol->isGenerated())
            return false;

        return QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
    }
private:
    CPlusPlus::OverviewModel *m_sourceModel;
};

Roberto Raggi's avatar
Roberto Raggi committed
179 180 181 182
class FunctionDefinitionUnderCursor: protected ASTVisitor
{
    unsigned _line;
    unsigned _column;
183
    DeclarationAST *_functionDefinition;
Roberto Raggi's avatar
Roberto Raggi committed
184 185

public:
Roberto Raggi's avatar
Roberto Raggi committed
186 187
    FunctionDefinitionUnderCursor(TranslationUnit *translationUnit)
        : ASTVisitor(translationUnit),
Roberto Raggi's avatar
Roberto Raggi committed
188
          _line(0), _column(0)
Roberto Raggi's avatar
Roberto Raggi committed
189 190
    { }

191
    DeclarationAST *operator()(AST *ast, unsigned line, unsigned column)
Roberto Raggi's avatar
Roberto Raggi committed
192 193
    {
        _functionDefinition = 0;
Roberto Raggi's avatar
Roberto Raggi committed
194 195
        _line = line;
        _column = column;
Roberto Raggi's avatar
Roberto Raggi committed
196 197 198 199 200 201 202 203 204 205 206
        accept(ast);
        return _functionDefinition;
    }

protected:
    virtual bool preVisit(AST *ast)
    {
        if (_functionDefinition)
            return false;

        else if (FunctionDefinitionAST *def = ast->asFunctionDefinition()) {
207 208 209 210 211 212
            return checkDeclaration(def);
        }

        else if (ObjCMethodDeclarationAST *method = ast->asObjCMethodDeclaration()) {
            if (method->function_body)
                return checkDeclaration(method);
Roberto Raggi's avatar
Roberto Raggi committed
213 214 215 216 217
        }

        return true;
    }

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
private:
    bool checkDeclaration(DeclarationAST *ast)
    {
        unsigned startLine, startColumn;
        unsigned endLine, endColumn;
        getTokenStartPosition(ast->firstToken(), &startLine, &startColumn);
        getTokenEndPosition(ast->lastToken() - 1, &endLine, &endColumn);

        if (_line > startLine || (_line == startLine && _column >= startColumn)) {
            if (_line < endLine || (_line == endLine && _column < endColumn)) {
                _functionDefinition = ast;
                return false;
            }
        }

        return true;
    }
Roberto Raggi's avatar
Roberto Raggi committed
235 236
};

237 238
class FindFunctionDefinitions: protected SymbolVisitor
{
Roberto Raggi's avatar
Roberto Raggi committed
239
    const Name *_declarationName;
240 241 242 243 244 245 246 247
    QList<Function *> *_functions;

public:
    FindFunctionDefinitions()
        : _declarationName(0),
          _functions(0)
    { }

Roberto Raggi's avatar
Roberto Raggi committed
248
    void operator()(const Name *declarationName, Scope *globals,
249 250 251 252 253
                    QList<Function *> *functions)
    {
        _declarationName = declarationName;
        _functions = functions;

Roberto Raggi's avatar
Roberto Raggi committed
254 255
        for (unsigned i = 0; i < globals->memberCount(); ++i) {
            accept(globals->memberAt(i));
256 257 258 259 260 261 262 263
        }
    }

protected:
    using SymbolVisitor::visit;

    virtual bool visit(Function *function)
    {
Roberto Raggi's avatar
Roberto Raggi committed
264 265
        const Name *name = function->name();
        if (const QualifiedNameId *q = name->asQualifiedNameId())
266
            name = q->name();
267 268 269 270 271 272 273 274

        if (_declarationName->isEqualTo(name))
            _functions->append(function);

        return false;
    }
};

275

276
struct CanonicalSymbol
277
{
278
    CPPEditorWidget *editor;
279 280 281
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

282
    CanonicalSymbol(CPPEditorWidget *editor, const SemanticInfo &info)
Erik Verbruggen's avatar
Erik Verbruggen committed
283
        : editor(editor), info(info)
284 285
    {
        typeOfExpression.init(info.doc, info.snapshot);
286
        typeOfExpression.setExpandTemplates(true);
287 288 289 290 291 292 293
    }

    const LookupContext &context() const
    {
        return typeOfExpression.context();
    }

294
    static inline bool isIdentifierChar(const QChar &ch)
295 296 297 298
    {
        return ch.isLetterOrNumber() || ch == QLatin1Char('_');
    }

299 300 301 302 303
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

304
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
305 306
                                        const QTextCursor &cursor,
                                        QString *code)
307 308 309 310 311 312 313 314 315 316 317 318
    {
        if (! info.doc)
            return 0;

        QTextCursor tc = cursor;
        int line, col;
        editor->convertPosition(tc.position(), &line, &col);
        ++col; // 1-based line and 1-based column

        QTextDocument *document = editor->document();

        int pos = tc.position();
319 320 321 322 323 324

        if (! isIdentifierChar(document->characterAt(pos)))
            if (! (pos > 0 && isIdentifierChar(document->characterAt(pos - 1))))
                return 0;

        while (isIdentifierChar(document->characterAt(pos)))
325 326 327
            ++pos;
        tc.setPosition(pos);

328 329 330 331 332 333 334 335 336 337 338
        ExpressionUnderCursor expressionUnderCursor;
        *code = expressionUnderCursor(tc);
        return info.doc->scopeAt(line, col);
    }

    Symbol *operator()(const QTextCursor &cursor)
    {
        QString code;

        if (Scope *scope = getScopeAndExpression(cursor, &code))
            return operator()(scope, code);
339

340 341 342 343 344 345 346 347 348 349
        return 0;
    }

    Symbol *operator()(Scope *scope, const QString &code)
    {
        return canonicalSymbol(scope, code, typeOfExpression);
    }

    static Symbol *canonicalSymbol(Scope *scope, const QString &code, TypeOfExpression &typeOfExpression)
    {
350 351
        const QList<LookupItem> results =
                typeOfExpression(code.toUtf8(), scope, TypeOfExpression::Preprocess);
352

Roberto Raggi's avatar
Roberto Raggi committed
353 354
        for (int i = results.size() - 1; i != -1; --i) {
            const LookupItem &r = results.at(i);
355
            Symbol *decl = r.declaration();
Roberto Raggi's avatar
Roberto Raggi committed
356

357
            if (! (decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
358 359
                break;

360
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
361 362 363 364 365 366 367 368 369 370 371
                const Identifier *declId = decl->identifier();
                const Identifier *classId = classScope->identifier();

                if (classId && classId->isEqualTo(declId))
                    continue; // skip it, it's a ctor or a dtor.

                else if (Function *funTy = r.declaration()->type()->asFunctionType()) {
                    if (funTy->isVirtual())
                        return r.declaration();
                }
            }
Roberto Raggi's avatar
Roberto Raggi committed
372 373 374
        }

        for (int i = 0; i < results.size(); ++i) {
375 376 377 378 379 380 381 382
            const LookupItem &r = results.at(i);

            if (r.declaration())
                return r.declaration();
        }

        return 0;
    }
383

384 385
};

386 387
int numberOfClosedEditors = 0;

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
/// Check if previous line is a CppStyle Doxygen Comment
bool isPreviousLineCppStyleComment(const QTextCursor &cursor)
{
   const QTextBlock &currentBlock = cursor.block();
   if (!currentBlock.isValid())
      return false;

   const QTextBlock &actual = currentBlock.previous();
   if (!actual.isValid())
      return false;

   const QString text = actual.text().trimmed();
   if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
      return true;

   return false;
}

/// Check if next line is a CppStyle Doxygen Comment
bool isNextLineCppStyleComment(const QTextCursor &cursor)
{
   const QTextBlock &currentBlock = cursor.block();
   if (!currentBlock.isValid())
      return false;

   const QTextBlock &actual = currentBlock.next();
   if (!actual.isValid())
      return false;

   const QString text = actual.text().trimmed();
   if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
      return true;

   return false;
}

/// Check if line is a CppStyle Doxygen comment and the cursor is after the comment
bool isCursorAfterCppComment(const QTextCursor &cursor, const QTextDocument *doc)
{
    QTextCursor cursorFirstNonBlank(cursor);
    cursorFirstNonBlank.movePosition(QTextCursor::StartOfLine);
    while (doc->characterAt(cursorFirstNonBlank.position()).isSpace()
           && cursorFirstNonBlank.movePosition(QTextCursor::NextCharacter)) {
    }

    const QTextBlock& block = cursorFirstNonBlank.block();
    const QString text = block.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return (cursor.position() >= cursorFirstNonBlank.position() + 3);

    return false;
}

bool isCppStyleContinuation(const QTextCursor& cursor)
{
    return (isPreviousLineCppStyleComment(cursor) || isNextLineCppStyleComment(cursor));
}

DoxygenGenerator::DocumentationStyle doxygenStyle(const QTextCursor &cursor,
                                                  const QTextDocument *doc)
{
    const int pos = cursor.position();

451
    QString comment = QString(doc->characterAt(pos - 3))
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
            + doc->characterAt(pos - 2)
            + doc->characterAt(pos - 1);

    if (comment == QLatin1String("/**"))
        return CppTools::DoxygenGenerator::JavaStyle;
    else if (comment == QLatin1String("/*!"))
        return CppTools::DoxygenGenerator::QtStyle;
    else if (comment == QLatin1String("///"))
        return CppTools::DoxygenGenerator::CppStyleA;
    else
        return CppTools::DoxygenGenerator::CppStyleB;
}

bool handleDoxygenCppStyleContinuation(QTextCursor &cursor,
                                       QKeyEvent *e)
{
    const int blockPos = cursor.positionInBlock();
    const QString &text = cursor.block().text();
    int offset = 0;
    for (; offset < blockPos; ++offset) {
        if (!text.at(offset).isSpace())
            break;
    }

    // If the line does not start with the comment we don't
    // consider it as a continuation. Handles situations like:
    // void d(); ///<enter>
    if (!(text.trimmed().startsWith(QLatin1String("///"))
        || text.startsWith(QLatin1String("//!"))))
       return false;

    QString newLine(QLatin1Char('\n'));
    newLine.append(QString(offset, QLatin1Char(' '))); // indent correctly

    const QString commentMarker = text.mid(offset, 3);
    newLine.append(commentMarker);

    cursor.insertText(newLine);
    e->accept();
    return true;
}

bool handleDoxygenContinuation(QTextCursor &cursor,
                               QKeyEvent *e,
                               const QTextDocument *doc,
                               const bool enableDoxygen,
                               const bool leadingAsterisks)
{
    // It might be a continuation if:
    // a) current line starts with /// or //! and cursor is positioned after the comment
    // b) current line is in the middle of a multi-line Qt or Java style comment

    if (enableDoxygen && !cursor.atEnd() && isCursorAfterCppComment(cursor, doc))
        return handleDoxygenCppStyleContinuation(cursor, e);

    if (!leadingAsterisks)
        return false;

    // We continue the comment if the cursor is after a comment's line asterisk and if
    // there's no asterisk immediately after the cursor (that would already be considered
    // a leading asterisk).
    int offset = 0;
    const int blockPos = cursor.positionInBlock();
    const QString &text = cursor.block().text();
    for (; offset < blockPos; ++offset) {
        if (!text.at(offset).isSpace())
            break;
    }

    if (offset < blockPos
            && (text.at(offset) == QLatin1Char('*')
                || (offset < blockPos - 1
                    && text.at(offset) == QLatin1Char('/')
                    && text.at(offset + 1) == QLatin1Char('*')))) {
        int followinPos = blockPos;
        for (; followinPos < text.length(); ++followinPos) {
            if (!text.at(followinPos).isSpace())
                break;
        }
        if (followinPos == text.length()
                || text.at(followinPos) != QLatin1Char('*')) {
            QString newLine(QLatin1Char('\n'));
            QTextCursor c(cursor);
            c.movePosition(QTextCursor::StartOfBlock);
            c.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, offset);
            newLine.append(c.selectedText());
            if (text.at(offset) == QLatin1Char('/')) {
                newLine.append(QLatin1String(" *"));
            } else {
                int start = offset;
                while (offset < blockPos && text.at(offset) == QLatin1Char('*'))
                    ++offset;
                newLine.append(QString(offset - start, QLatin1Char('*')));
            }
            cursor.insertText(newLine);
            e->accept();
            return true;
        }
    }

    return false;
}

con's avatar
con committed
555 556
} // end of anonymous namespace

557 558
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
559
{
560 561 562
    m_context.add(CppEditor::Constants::C_CPPEDITOR);
    m_context.add(ProjectExplorer::Constants::LANG_CXX);
    m_context.add(TextEditor::Constants::C_TEXTEDITOR);
con's avatar
con committed
563 564
}

565 566
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

567 568
CPPEditorWidget::CPPEditorWidget(QWidget *parent)
    : TextEditor::BaseTextEditorWidget(parent)
569
    , m_currentRenameSelection(NoCurrentRenameSelection)
570
    , m_inRename(false)
mae's avatar
mae committed
571 572
    , m_inRenameChanged(false)
    , m_firstRenameChange(false)
573
    , m_objcEnabled(false)
574
    , m_commentsSettings(CppTools::CppToolsSettings::instance()->commentsSettings())
575 576
    , m_completionSupport(0)
    , m_highlightingSupport(0)
con's avatar
con committed
577
{
Roberto Raggi's avatar
Roberto Raggi committed
578
    m_initialized = false;
579
    qRegisterMetaType<SemanticInfo>("CppTools::SemanticInfo");
Roberto Raggi's avatar
Roberto Raggi committed
580 581 582 583

    m_semanticHighlighter = new SemanticHighlighter(this);
    m_semanticHighlighter->start();

con's avatar
con committed
584 585
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
586
    setCodeFoldingSupported(true);
587
    setIndenter(new CppTools::CppQtStyleIndenter);
588
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
589

590
    baseTextDocument()->setSyntaxHighlighter(new CppHighlighter);
con's avatar
con committed
591

592
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
593 594 595
    if (m_modelManager) {
        connect(m_modelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
                this, SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)));
596 597
        m_completionSupport = m_modelManager->completionSupport(editor());
        m_highlightingSupport = m_modelManager->highlightingSupport(editor());
con's avatar
con committed
598
    }
599

600
    m_highlightRevision = 0;
601 602
    connect(&m_highlightWatcher, SIGNAL(resultsReadyAt(int,int)), SLOT(highlightSymbolUsages(int,int)));
    connect(&m_highlightWatcher, SIGNAL(finished()), SLOT(finishHighlightSymbolUsages()));
603 604 605 606

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
    connect(&m_referencesWatcher, SIGNAL(finished()), SLOT(markSymbolsNow()));
607 608 609 610 611 612 613

    connect(this, SIGNAL(refactorMarkerClicked(TextEditor::RefactorMarker)),
            this, SLOT(onRefactorMarkerClicked(TextEditor::RefactorMarker)));

    m_declDefLinkFinder = new FunctionDeclDefLinkFinder(this);
    connect(m_declDefLinkFinder, SIGNAL(foundLink(QSharedPointer<FunctionDeclDefLink>)),
            this, SLOT(onFunctionDeclDefLinkFound(QSharedPointer<FunctionDeclDefLink>)));
614 615 616 617 618

    connect(CppTools::CppToolsSettings::instance(),
            SIGNAL(commentsSettingsChanged(CppTools::CommentsSettings)),
            this,
            SLOT(onCommentsSettingsChanged(CppTools::CommentsSettings)));
con's avatar
con committed
619 620
}

621
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
622
{
Roberto Raggi's avatar
Roberto Raggi committed
623 624
    m_semanticHighlighter->abort();
    m_semanticHighlighter->wait();
625 626 627 628 629 630

    ++numberOfClosedEditors;
    if (numberOfClosedEditors == 5) {
        m_modelManager->GC();
        numberOfClosedEditors = 0;
    }
631 632 633

    delete m_highlightingSupport;
    delete m_completionSupport;
con's avatar
con committed
634 635
}

636
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
637
{
638
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
639 640 641 642
    createToolBar(editable);
    return editable;
}

643
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
644
{
645
    m_outlineCombo = new OverviewCombo;
Kai Koehne's avatar
Kai Koehne committed
646
    m_outlineCombo->setMinimumContentsLength(22);
647 648

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
649
    QSizePolicy policy = m_outlineCombo->sizePolicy();
650
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
651
    m_outlineCombo->setSizePolicy(policy);
652

Kai Koehne's avatar
Kai Koehne committed
653 654
    QTreeView *outlineView = new OverviewTreeView;
    outlineView->header()->hide();
655
    outlineView->setItemsExpandable(true);
Kai Koehne's avatar
Kai Koehne committed
656
    m_outlineCombo->setView(outlineView);
657
    m_outlineCombo->setMaxVisibleItems(40);
658
    outlineView->viewport()->installEventFilter(m_outlineCombo);
con's avatar
con committed
659

Kai Koehne's avatar
Kai Koehne committed
660 661
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
662
    if (CppEditorPlugin::instance()->sortedOutline())
663 664
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
665
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
666 667
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
668
    m_outlineCombo->setModel(m_proxyModel);
669

Kai Koehne's avatar
Kai Koehne committed
670 671
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
672
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
673
    m_sortAction->setChecked(sortedOutline());
674 675
    connect(m_sortAction, SIGNAL(toggled(bool)),
            CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
Kai Koehne's avatar
Kai Koehne committed
676
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
677

678 679 680 681 682
    m_updateOutlineTimer = new QTimer(this);
    m_updateOutlineTimer->setSingleShot(true);
    m_updateOutlineTimer->setInterval(UPDATE_OUTLINE_INTERVAL);
    connect(m_updateOutlineTimer, SIGNAL(timeout()), this, SLOT(updateOutlineNow()));

Kai Koehne's avatar
Kai Koehne committed
683 684 685 686
    m_updateOutlineIndexTimer = new QTimer(this);
    m_updateOutlineIndexTimer->setSingleShot(true);
    m_updateOutlineIndexTimer->setInterval(UPDATE_OUTLINE_INTERVAL);
    connect(m_updateOutlineIndexTimer, SIGNAL(timeout()), this, SLOT(updateOutlineIndexNow()));
Roberto Raggi's avatar
Roberto Raggi committed
687

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
688 689 690 691 692
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

693 694 695 696 697
    m_updateFunctionDeclDefLinkTimer = new QTimer(this);
    m_updateFunctionDeclDefLinkTimer->setSingleShot(true);
    m_updateFunctionDeclDefLinkTimer->setInterval(UPDATE_FUNCTION_DECL_DEF_LINK_INTERVAL);
    connect(m_updateFunctionDeclDefLinkTimer, SIGNAL(timeout()), this, SLOT(updateFunctionDeclDefLinkNow()));

Kai Koehne's avatar
Kai Koehne committed
698 699 700
    connect(m_outlineCombo, SIGNAL(activated(int)), this, SLOT(jumpToOutlineElement(int)));
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateOutlineIndex()));
    connect(m_outlineCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(updateOutlineToolTip()));
701
    connect(document(), SIGNAL(contentsChange(int,int,int)), this, SLOT(onContentsChanged(int,int,int)));
con's avatar
con committed
702

703
    connect(editorDocument(), SIGNAL(changed()), this, SLOT(updateFileName()));
con's avatar
con committed
704

705 706 707
    // set up function declaration - definition link
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateFunctionDeclDefLink()));
    connect(this, SIGNAL(textChanged()), this, SLOT(updateFunctionDeclDefLink()));
Roberto Raggi's avatar
Roberto Raggi committed
708 709 710 711 712

    // set up the semantic highlighter
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateUses()));
    connect(this, SIGNAL(textChanged()), this, SLOT(updateUses()));

713 714
    connect(m_semanticHighlighter, SIGNAL(changed(CppTools::SemanticInfo)),
            this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
Roberto Raggi's avatar
Roberto Raggi committed
715

716
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
717 718
}

719
void CPPEditorWidget::paste()
mae's avatar
mae committed
720
{
721
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
722
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
723 724 725 726
        return;
    }

    startRename();
727
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
728 729 730
    finishRename();
}

731
void CPPEditorWidget::cut()
mae's avatar
mae committed
732
{
733
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
734
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
735 736 737 738
        return;
    }

    startRename();
739
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
740 741 742
    finishRename();
}

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
void CPPEditorWidget::selectAll()
{
    // if we are currently renaming a symbol
    // and the cursor is over that symbol, select just that symbol
    if (m_currentRenameSelection != NoCurrentRenameSelection) {
        QTextCursor cursor = textCursor();
        int selectionBegin = m_currentRenameSelectionBegin.position();
        int selectionEnd = m_currentRenameSelectionEnd.position();

        if (cursor.position() >= selectionBegin
                && cursor.position() <= selectionEnd) {
            cursor.setPosition(selectionBegin);
            cursor.setPosition(selectionEnd, QTextCursor::KeepAnchor);
            setTextCursor(cursor);
            return;
        }
    }

    BaseTextEditorWidget::selectAll();
}

764
CppModelManagerInterface *CPPEditorWidget::modelManager() const
765 766 767 768
{
    return m_modelManager;
}

769
void CPPEditorWidget::setMimeType(const QString &mt)
770
{
771
    BaseTextEditorWidget::setMimeType(mt);
772
    setObjCEnabled(mt == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE));
773 774
}

775
void CPPEditorWidget::setObjCEnabled(bool onoff)
776 777 778 779
{
    m_objcEnabled = onoff;
}

780
bool CPPEditorWidget::isObjCEnabled() const
781 782
{ return m_objcEnabled; }

783
void CPPEditorWidget::startRename()
mae's avatar
mae committed
784 785 786 787
{
    m_inRenameChanged = false;
}

788
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
{
    if (!m_inRenameChanged)
        return;

    m_inRename = true;

    QTextCursor cursor = textCursor();
    cursor.joinPreviousEditBlock();

    cursor.setPosition(m_currentRenameSelectionEnd.position());
    cursor.setPosition(m_currentRenameSelectionBegin.position(), QTextCursor::KeepAnchor);
    m_renameSelections[m_currentRenameSelection].cursor = cursor;
    QString text = cursor.selectedText();

    for (int i = 0; i < m_renameSelections.size(); ++i) {
        if (i == m_currentRenameSelection)
            continue;
        QTextEdit::ExtraSelection &s = m_renameSelections[i];
        int pos = s.cursor.selectionStart();
        s.cursor.removeSelectedText();
        s.cursor.insertText(text);
        s.cursor.setPosition(pos, QTextCursor::KeepAnchor);
    }

    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
    cursor.endEditBlock();

    m_inRename = false;
}

819
void CPPEditorWidget::abortRename()
820
{
821
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
822
        return;
823
    m_renameSelections[m_currentRenameSelection].format = m_occurrencesFormat;
824
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
825 826
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
827
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
828

829
    semanticRehighlight(/* force = */ true);
830 831
}

832
void CPPEditorWidget::onDocumentUpdated(Document::Ptr doc)
con's avatar
con committed
833
{
834
    if (doc->fileName() != editorDocument()->fileName())
con's avatar
con committed
835 836
        return;

837 838 839
    if (doc->editorRevision() != editorRevision())
        return;

840
    if (! m_initialized ||
hjk's avatar
hjk committed
841
            (Core::EditorManager::currentEditor() == editor()
842 843
             && (!m_lastSemanticInfo.doc
                 || !m_lastSemanticInfo.doc->translationUnit()->ast()
844
                 || m_lastSemanticInfo.doc->fileName() != editorDocument()->fileName()))) {
Roberto Raggi's avatar
Roberto Raggi committed
845
        m_initialized = true;
846
        semanticRehighlight(/* force = */ true);
Roberto Raggi's avatar
Roberto Raggi committed
847 848
    }

849
    m_updateOutlineTimer->start();
con's avatar
con committed
850 851
}

852
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
853 854 855 856 857 858 859
{
    if (! doc)
        return 0;

    int line, col;
    convertPosition(cursor.position(), &line, &col);

860 861 862 863 864 865
    if (const Macro *macro = doc->findMacroDefinitionAt(line)) {
        QTextCursor macroCursor = cursor;
        const QByteArray name = identifierUnderCursor(&macroCursor).toLatin1();
        if (macro->name() == name)
            return macro;
    } else if (const Document::MacroUse *use = doc->findMacroUseAt(cursor.position())) {
Christian Kamm's avatar
Christian Kamm committed
866
        return &use->macro();
867
    }
Christian Kamm's avatar
Christian Kamm committed
868 869 870

    return 0;
}
871

872
void CPPEditorWidget::findUsages()
873
{
874
    SemanticInfo info = m_lastSemanticInfo;
875
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
876
    info.snapshot.insert(info.doc);
877

878
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
879
        m_modelManager->findMacroUsages(*macro);
880 881 882 883 884
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
885
    }
886 887
}

888

889
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
890 891
{
    SemanticInfo info = m_lastSemanticInfo;
892
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
893 894
    info.snapshot.insert(info.doc);

895 896 897 898 899 900 901 902
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
        m_modelManager->renameMacroUsages(*macro, replacement);
    } else {
        CanonicalSymbol cs(this, info);
        if (Symbol *canonicalSymbol = cs(textCursor()))
            if (canonicalSymbol->identifier() != 0)
                m_modelManager->renameUsages(canonicalSymbol, cs.context(), replacement);
    }
903 904
}

905
void CPPEditorWidget::renameUsages()
906
{
907 908 909
    renameUsagesNow();
}

910
void CPPEditorWidget::markSymbolsNow()
911
{
912 913 914 915 916 917
    if (m_references.isCanceled())
        return;
    else if (m_referencesCursorPosition != position())
        return;
    else if (m_referencesRevision != editorRevision())
        return;
918

919 920 921
    const SemanticInfo info = m_lastSemanticInfo;
    TranslationUnit *unit = info.doc->translationUnit();
    const QList<int> result = m_references.result();
922 923 924

    QList<QTextEdit::ExtraSelection> selections;

925 926 927
    foreach (int index, result) {
        unsigned line, column;
        unit->getTokenPosition(index, &line, &column);
928

929 930
        if (column)
            --column;  // adjust the column position.
931

932
        const int len = unit->tokenAt(index).f.length;
933

934 935 936
        QTextCursor cursor(document()->findBlockByNumber(line - 1));
        cursor.setPosition(cursor.position() + column);
        cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
937

938 939 940 941
        QTextEdit::ExtraSelection sel;
        sel.format = m_occurrencesFormat;
        sel.cursor = cursor;
        selections.append(sel);
942

Roberto Raggi's avatar
Roberto Raggi committed
943
    }
944 945

    setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
946 947
}

948
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc, Snapshot snapshot)
949 950
{
    TypeOfExpression typeOfExpression;
951 952
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
953 954
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
955
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
956
        return CppModelManagerInterface::instance()->references(canonicalSymbol, typeOfExpression.context());
957 958 959
    return QList<int>();
}

960
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
961 962 963 964 965 966
{
    abortRename();

    if (! info.doc)
        return;

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
        QList<QTextEdit::ExtraSelection> selections;

        //Macro definition
        if (macro->fileName() == info.doc->fileName()) {
            QTextCursor cursor(document());
            cursor.setPosition(macro->offset());
            cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, macro->name().length());

            QTextEdit::ExtraSelection sel;
            sel.format = m_occurrencesFormat;
            sel.cursor = cursor;
            selections.append(sel);
        }

        //Other macro uses
983
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
            if (use.macro().line() != macro->line()
                    || use.macro().offset() != macro->offset()
                    || use.macro().length() != macro->length()
                    || use.macro().fileName() != macro->fileName())
                continue;

            QTextCursor cursor(document());
            cursor.setPosition(use.begin());
            cursor.setPosition(use.end(), QTextCursor::KeepAnchor);

            QTextEdit::ExtraSelection sel;
            sel.format = m_occurrencesFormat;
            sel.cursor = cursor;
            selections.append(sel);
        }
999

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
        setExtraSelections(CodeSemanticsSelection, selections);
    } else {
        CanonicalSymbol cs(this, info);
        QString expression;
        if (Scope *scope = cs.getScopeAndExpression(this, info, tc, &expression)) {
            m_references.cancel();
            m_referencesRevision = info.revision;
            m_referencesCursorPosition = position();
            m_references = QtConcurrent::run(&lazyFindReferences, scope, expression, info.doc, info.snapshot);
            m_referencesWatcher.setFuture(m_references);
        } else {
            const QList<QTextEdit::ExtraSelection> selections = extraSelections(CodeSemanticsSelection);

            if (! selections.isEmpty())
                setExtraSelections(CodeSemanticsSelection, QList<QTextEdit::ExtraSelection>());
        }
1016 1017 1018
    }
}

1019
void CPPEditorWidget::renameSymbolUnderCursor()
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1020
{
Roberto Raggi's avatar
Roberto Raggi committed
1021
    updateSemanticInfo(m_semanticHighlighter->semanticInfo(currentSource()));
mae's avatar
mae committed
1022
    abortRename();
1023

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1024 1025 1026 1027 1028
    QTextCursor c = textCursor();

    for (int i = 0; i < m_renameSelections.size(); ++i) {
        QTextEdit::ExtraSelection s = m_renameSelections.at(i);
        if (c.position() >= s.cursor.anchor()
1029
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1030
            m_currentRenameSelection = i;
mae's avatar
mae committed
1031 1032 1033 1034 1035
            m_firstRenameChange = true;
            m_currentRenameSelectionBegin = QTextCursor(c.document()->docHandle(),
                                                        m_renameSelections[i].cursor.selectionStart());
            m_currentRenameSelectionEnd = QTextCursor(c.document()->docHandle(),
                                                        m_renameSelections[i].cursor.selectionEnd());
1036
            m_renameSelections[i].format = m_occurrenceRenameFormat;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1037 1038 1039 1040
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
1041 1042

    if (m_renameSelections.isEmpty())
1043
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1044 1045
}

1046
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
1047
{
1048 1049
    Q_UNUSED(position)

1050
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
1051 1052
        return;

mae's avatar
mae committed
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
    if (position + charsAdded == m_currentRenameSelectionBegin.position()) {
        // we are inserting at the beginning of the rename selection => expand
        m_currentRenameSelectionBegin.setPosition(position);
        m_renameSelections[m_currentRenameSelection].cursor.setPosition(position, QTextCursor::KeepAnchor);
    }

    // the condition looks odd, but keep in mind that the begin and end cursors do move automatically
    m_inRenameChanged = (position >= m_currentRenameSelectionBegin.position()
                         && position + charsAdded <= m_currentRenameSelectionEnd.position());

    if (!m_inRenameChanged)