cppeditor.cpp 64.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

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

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

#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
69

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

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

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

con's avatar
con committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
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();
107 108 109 110
    }

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

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

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

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

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

private:
    bool m_skipNextHide;
con's avatar
con committed
150 151
};

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
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;
};

177 178
class FindFunctionDefinitions: protected SymbolVisitor
{
Roberto Raggi's avatar
Roberto Raggi committed
179
    const Name *_declarationName;
180 181 182 183 184 185 186 187
    QList<Function *> *_functions;

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

Roberto Raggi's avatar
Roberto Raggi committed
188
    void operator()(const Name *declarationName, Scope *globals,
189 190 191 192 193
                    QList<Function *> *functions)
    {
        _declarationName = declarationName;
        _functions = functions;

Roberto Raggi's avatar
Roberto Raggi committed
194 195
        for (unsigned i = 0; i < globals->memberCount(); ++i) {
            accept(globals->memberAt(i));
196 197 198 199 200 201 202 203
        }
    }

protected:
    using SymbolVisitor::visit;

    virtual bool visit(Function *function)
    {
Roberto Raggi's avatar
Roberto Raggi committed
204 205
        const Name *name = function->name();
        if (const QualifiedNameId *q = name->asQualifiedNameId())
206
            name = q->name();
207 208 209 210 211 212 213 214

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

        return false;
    }
};

215
struct CanonicalSymbol
216
{
217
    CPPEditorWidget *editor;
218 219 220
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

221
    CanonicalSymbol(CPPEditorWidget *editor, const SemanticInfo &info)
Erik Verbruggen's avatar
Erik Verbruggen committed
222
        : editor(editor), info(info)
223 224
    {
        typeOfExpression.init(info.doc, info.snapshot);
225
        typeOfExpression.setExpandTemplates(true);
226 227 228 229 230 231 232
    }

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

233
    static inline bool isIdentifierChar(const QChar &ch)
234 235 236 237
    {
        return ch.isLetterOrNumber() || ch == QLatin1Char('_');
    }

238 239 240 241 242
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

243
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
244 245
                                        const QTextCursor &cursor,
                                        QString *code)
246
    {
247
        if (!info.doc)
248 249 250 251 252 253 254 255 256 257
            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();
258

259 260
        if (!isIdentifierChar(document->characterAt(pos)))
            if (!(pos > 0 && isIdentifierChar(document->characterAt(pos - 1))))
261 262 263
                return 0;

        while (isIdentifierChar(document->characterAt(pos)))
264 265 266
            ++pos;
        tc.setPosition(pos);

267 268 269 270 271 272 273 274 275 276 277
        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);
278

279 280 281 282 283 284 285 286
        return 0;
    }

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
287 288
    static Symbol *canonicalSymbol(Scope *scope, const QString &code,
                                   TypeOfExpression &typeOfExpression)
289
    {
290 291
        const QList<LookupItem> results =
                typeOfExpression(code.toUtf8(), scope, TypeOfExpression::Preprocess);
292

Roberto Raggi's avatar
Roberto Raggi committed
293 294
        for (int i = results.size() - 1; i != -1; --i) {
            const LookupItem &r = results.at(i);
295
            Symbol *decl = r.declaration();
Roberto Raggi's avatar
Roberto Raggi committed
296

297
            if (!(decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
298 299
                break;

300
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
301 302 303 304 305 306
                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.

307
                if (Function *funTy = r.declaration()->type()->asFunctionType()) {
308 309 310 311
                    if (funTy->isVirtual())
                        return r.declaration();
                }
            }
Roberto Raggi's avatar
Roberto Raggi committed
312 313 314
        }

        for (int i = 0; i < results.size(); ++i) {
315 316 317 318 319 320 321 322
            const LookupItem &r = results.at(i);

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

        return 0;
    }
323

324 325
};

326 327 328
/// Check if previous line is a CppStyle Doxygen Comment
bool isPreviousLineCppStyleComment(const QTextCursor &cursor)
{
Orgad Shaneh's avatar
Orgad Shaneh committed
329 330 331
    const QTextBlock &currentBlock = cursor.block();
    if (!currentBlock.isValid())
        return false;
332

Orgad Shaneh's avatar
Orgad Shaneh committed
333 334 335
    const QTextBlock &actual = currentBlock.previous();
    if (!actual.isValid())
        return false;
336

Orgad Shaneh's avatar
Orgad Shaneh committed
337 338 339
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
340

Orgad Shaneh's avatar
Orgad Shaneh committed
341
    return false;
342 343 344 345 346
}

/// Check if next line is a CppStyle Doxygen Comment
bool isNextLineCppStyleComment(const QTextCursor &cursor)
{
Orgad Shaneh's avatar
Orgad Shaneh committed
347 348 349
    const QTextBlock &currentBlock = cursor.block();
    if (!currentBlock.isValid())
        return false;
350

Orgad Shaneh's avatar
Orgad Shaneh committed
351 352 353
    const QTextBlock &actual = currentBlock.next();
    if (!actual.isValid())
        return false;
354

Orgad Shaneh's avatar
Orgad Shaneh committed
355 356 357
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
358

Orgad Shaneh's avatar
Orgad Shaneh committed
359
    return false;
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
}

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

389
    QString comment = QString(doc->characterAt(pos - 3))
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
            + 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("///"))
Orgad Shaneh's avatar
Orgad Shaneh committed
418 419 420
          || text.startsWith(QLatin1String("//!")))) {
        return false;
    }
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 451 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

    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
494 495
} // end of anonymous namespace

496 497
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
498
{
499 500 501
    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
502 503
}

504 505
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

506 507
CPPEditorWidget::CPPEditorWidget(QWidget *parent)
    : TextEditor::BaseTextEditorWidget(parent)
508
    , m_currentRenameSelection(NoCurrentRenameSelection)
509
    , m_inRename(false)
mae's avatar
mae committed
510 511
    , m_inRenameChanged(false)
    , m_firstRenameChange(false)
512
    , m_objcEnabled(false)
513
    , m_commentsSettings(CppTools::CppToolsSettings::instance()->commentsSettings())
con's avatar
con committed
514
{
515
    qRegisterMetaType<SemanticInfo>("CppTools::SemanticInfo");
Roberto Raggi's avatar
Roberto Raggi committed
516

con's avatar
con committed
517 518
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
519
    setCodeFoldingSupported(true);
520
    setIndenter(new CppTools::CppQtStyleIndenter);
521
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
522

523
    baseTextDocument()->setSyntaxHighlighter(new CppHighlighter);
con's avatar
con committed
524

525
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
526
    if (m_modelManager) {
527 528 529 530 531
        CppEditorSupport *editorSupport = m_modelManager->cppEditorSupport(editor());
        connect(editorSupport, SIGNAL(documentUpdated()),
                this, SLOT(onDocumentUpdated()));
        connect(editorSupport, SIGNAL(semanticInfoUpdated(CppTools::SemanticInfo)),
                this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
Robert Loehning's avatar
Robert Loehning committed
532 533
        connect(editorSupport, SIGNAL(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)),
                this, SLOT(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)));
con's avatar
con committed
534
    }
535

536
    m_highlightRevision = 0;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
537 538 539 540
    connect(&m_highlightWatcher, SIGNAL(resultsReadyAt(int,int)),
            SLOT(highlightSymbolUsages(int,int)));
    connect(&m_highlightWatcher, SIGNAL(finished()),
            SLOT(finishHighlightSymbolUsages()));
541 542 543 544

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
    connect(&m_referencesWatcher, SIGNAL(finished()), SLOT(markSymbolsNow()));
545 546 547 548 549 550 551

    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>)));
552 553 554 555 556

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

559
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
560
{
561
    if (m_modelManager)
562
        m_modelManager->deleteCppEditorSupport(editor());
con's avatar
con committed
563 564
}

565
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
566
{
567
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
568 569 570 571
    createToolBar(editable);
    return editable;
}

572
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
573
{
574
    m_outlineCombo = new OverviewCombo;
Kai Koehne's avatar
Kai Koehne committed
575
    m_outlineCombo->setMinimumContentsLength(22);
576 577

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
578
    QSizePolicy policy = m_outlineCombo->sizePolicy();
579
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
580
    m_outlineCombo->setSizePolicy(policy);
581

Kai Koehne's avatar
Kai Koehne committed
582 583
    QTreeView *outlineView = new OverviewTreeView;
    outlineView->header()->hide();
584
    outlineView->setItemsExpandable(true);
Kai Koehne's avatar
Kai Koehne committed
585
    m_outlineCombo->setView(outlineView);
586
    m_outlineCombo->setMaxVisibleItems(40);
587
    outlineView->viewport()->installEventFilter(m_outlineCombo);
con's avatar
con committed
588

Kai Koehne's avatar
Kai Koehne committed
589 590
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
591
    if (CppEditorPlugin::instance()->sortedOutline())
592 593
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
594
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
595 596
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
597
    m_outlineCombo->setModel(m_proxyModel);
598

Kai Koehne's avatar
Kai Koehne committed
599 600
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
601
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
602
    m_sortAction->setChecked(sortedOutline());
603 604
    connect(m_sortAction, SIGNAL(toggled(bool)),
            CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
Kai Koehne's avatar
Kai Koehne committed
605
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
606

607 608 609 610 611
    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
612 613 614 615
    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
616

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
617 618 619 620 621
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

622 623 624
    m_updateFunctionDeclDefLinkTimer = new QTimer(this);
    m_updateFunctionDeclDefLinkTimer->setSingleShot(true);
    m_updateFunctionDeclDefLinkTimer->setInterval(UPDATE_FUNCTION_DECL_DEF_LINK_INTERVAL);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
625 626
    connect(m_updateFunctionDeclDefLinkTimer, SIGNAL(timeout()),
            this, SLOT(updateFunctionDeclDefLinkNow()));
627

Kai Koehne's avatar
Kai Koehne committed
628 629 630
    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()));
con's avatar
con committed
631

632 633
    // set up slots to document changes
    updateContentsChangedSignal();
con's avatar
con committed
634

635 636 637
    // 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
638 639 640 641 642

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

643
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
644 645
}

646
void CPPEditorWidget::paste()
mae's avatar
mae committed
647
{
648
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
649
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
650 651 652 653
        return;
    }

    startRename();
654
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
655 656 657
    finishRename();
}

658
void CPPEditorWidget::cut()
mae's avatar
mae committed
659
{
660
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
661
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
662 663 664 665
        return;
    }

    startRename();
666
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
667 668 669
    finishRename();
}

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
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();
}

691
CppModelManagerInterface *CPPEditorWidget::modelManager() const
692 693 694 695
{
    return m_modelManager;
}

696
void CPPEditorWidget::setMimeType(const QString &mt)
697
{
698
    BaseTextEditorWidget::setMimeType(mt);
699 700
    setObjCEnabled(mt == QLatin1String(CppTools::Constants::OBJECTIVE_C_SOURCE_MIMETYPE)
                   || mt == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE));
701 702
}

703
void CPPEditorWidget::setObjCEnabled(bool onoff)
704 705 706 707
{
    m_objcEnabled = onoff;
}

708
bool CPPEditorWidget::isObjCEnabled() const
709 710
{ return m_objcEnabled; }

711
void CPPEditorWidget::startRename()
mae's avatar
mae committed
712 713 714 715
{
    m_inRenameChanged = false;
}

716
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
{
    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;
}

747
void CPPEditorWidget::abortRename()
748
{
749
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
750
        return;
751
    m_renameSelections[m_currentRenameSelection].format = m_occurrencesFormat;
752
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
753 754
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
755
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
756

757
    semanticRehighlight(/* force = */ true);
758 759
}

760 761 762
/// \brief Called by \c CppEditorSupport when the document corresponding to the
///        file in this editor is updated.
void CPPEditorWidget::onDocumentUpdated()
con's avatar
con committed
763
{
764
    m_updateOutlineTimer->start();
con's avatar
con committed
765 766
}

767
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
768
{
769
    if (!doc)
Christian Kamm's avatar
Christian Kamm committed
770 771 772 773 774
        return 0;

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

775 776 777 778 779 780
    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
781
        return &use->macro();
782
    }
Christian Kamm's avatar
Christian Kamm committed
783 784 785

    return 0;
}
786

787
void CPPEditorWidget::findUsages()
788
{
789
    SemanticInfo info = m_lastSemanticInfo;
790
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
791
    info.snapshot.insert(info.doc);
792

793
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
794
        m_modelManager->findMacroUsages(*macro);
795 796 797 798 799
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
800
    }
801 802
}

803

804
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
805 806
{
    SemanticInfo info = m_lastSemanticInfo;
807
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
808 809
    info.snapshot.insert(info.doc);

810 811 812 813 814 815 816 817
    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);
    }
818 819
}

820
void CPPEditorWidget::renameUsages()
821
{
822 823 824
    renameUsagesNow();
}

825
void CPPEditorWidget::markSymbolsNow()
826
{
827 828 829 830 831 832
    if (m_references.isCanceled())
        return;
    else if (m_referencesCursorPosition != position())
        return;
    else if (m_referencesRevision != editorRevision())
        return;
833

834 835 836
    const SemanticInfo info = m_lastSemanticInfo;
    TranslationUnit *unit = info.doc->translationUnit();
    const QList<int> result = m_references.result();
837 838 839

    QList<QTextEdit::ExtraSelection> selections;

840 841 842
    foreach (int index, result) {
        unsigned line, column;
        unit->getTokenPosition(index, &line, &column);
843

844 845
        if (column)
            --column;  // adjust the column position.
846

847
        const int len = unit->tokenAt(index).f.length;
848

849 850 851
        QTextCursor cursor(document()->findBlockByNumber(line - 1));
        cursor.setPosition(cursor.position() + column);
        cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
852

853 854 855 856
        QTextEdit::ExtraSelection sel;
        sel.format = m_occurrencesFormat;
        sel.cursor = cursor;
        selections.append(sel);
857

Roberto Raggi's avatar
Roberto Raggi committed
858
    }
859 860

    setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
861 862
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
863 864
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc,
                                     Snapshot snapshot)
865 866
{
    TypeOfExpression typeOfExpression;
867 868
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
869 870
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
871
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
Nikolai Kosjar's avatar
Nikolai Kosjar committed
872 873
        return CppModelManagerInterface::instance()->references(canonicalSymbol,
                                                                typeOfExpression.context());
874 875 876
    return QList<int>();
}

877
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
878 879 880
{
    abortRename();

881
    if (!info.doc)
882 883
        return;

884 885 886 887 888 889 890
    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());
Nikolai Kosjar's avatar
Nikolai Kosjar committed
891 892
            cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor,
                                macro->name().length());
893 894 895 896 897 898 899 900

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

        //Other macro uses
901
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
            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);
        }
917

918 919 920 921 922 923 924 925
        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();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
926 927
            m_references = QtConcurrent::run(&lazyFindReferences, scope, expression, info.doc,
                                             info.snapshot);
928 929 930 931
            m_referencesWatcher.setFuture(m_references);
        } else {
            const QList<QTextEdit::ExtraSelection> selections = extraSelections(CodeSemanticsSelection);

932
            if (!selections.isEmpty())
933 934
                setExtraSelections(CodeSemanticsSelection, QList<QTextEdit::ExtraSelection>());
        }
935 936 937
    }
}

938
void CPPEditorWidget::renameSymbolUnderCursor()
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
939
{
940 941
    CppEditorSupport *edSup = m_modelManager->cppEditorSupport(editor());
    updateSemanticInfo(edSup->recalculateSemanticInfo(/* emitSignalWhenFinished = */ false));
mae's avatar
mae committed
942
    abortRename();
943

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
944 945 946 947 948
    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()
949
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
950
            m_currentRenameSelection = i;
mae's avatar
mae committed
951 952 953 954
            m_firstRenameChange = true;
            m_currentRenameSelectionBegin = QTextCursor(c.document()->docHandle(),
                                                        m_renameSelections[i].cursor.selectionStart());
            m_currentRenameSelectionEnd = QTextCursor(c.document()->docHandle(),
Nikolai Kosjar's avatar
Nikolai Kosjar committed
955
                                                      m_renameSelections[i].cursor.selectionEnd());
956
            m_renameSelections[i].format = m_occurrenceRenameFormat;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
957 958 959 960
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
961 962

    if (m_renameSelections.isEmpty())
963
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
964 965
}

966
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
967
{
968
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
969 970
        return;

mae's avatar
mae committed
971 972 973
    if (position + charsAdded == m_currentRenameSelectionBegin.position()) {
        // we are inserting at the beginning of the rename selection => expand
        m_currentRenameSelectionBegin.setPosition(position);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
974 975
        m_renameSelections[m_currentRenameSelection].cursor.setPosition(position,
                                                                        QTextCursor::KeepAnchor);
mae's avatar
mae committed
976 977
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
978 979
    // the condition looks odd, but keep in mind that the begin
    // and end cursors do move automatically
mae's avatar
mae committed
980 981 982 983
    m_inRenameChanged = (position >= m_currentRenameSelectionBegin.position()
                         && position + charsAdded <= m_currentRenameSelectionEnd.position());

    if (!m_inRenameChanged)
984 985 986 987 988 989
        abortRename();

    if (charsRemoved > 0)
        updateUses();
}

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
void CPPEditorWidget::jumpToOutlineElement(int index)
{
    QModelIndex modelIndex = m_outlineCombo->view()->currentIndex();
    // When the user clicks on an item in the combo box,
    // the view's currentIndex is updated, so we want to use that.
    // When the scroll wheel was used on the combo box,
    // the view's currentIndex is not updated,
    // but the passed index to this method is correct.
    // So, if the view has a current index, we reset it, to be able
    // to distinguish wheel events later
    if (modelIndex.isValid())
        m_outlineCombo->view()->setCurrentIndex(QModelIndex());
    else
        modelIndex = m_proxyModel->index(index, 0); // toplevel index
    QModelIndex sourceIndex = m_proxyModel->mapToSource(modelIndex);
    Symbol *symbol = m_outlineModel->symbolFromIndex(sourceIndex);
1006
    if (!symbol)
con's avatar
con committed
1007 1008
        return;

1009
    openCppEditorAt(linkToSymbol(symbol));
con's avatar
con committed
1010 1011
}

1012
void CPPEditorWidget::setSortedOutline(bool sort)
1013
{
Kai Koehne's avatar
Kai Koehne committed
1014
    if (sort != sortedOutline()) {
1015 1016 1017 1018 1019 1020 1021
        if (sort)
            m_proxyModel->sort(0, Qt::AscendingOrder);
        else
            m_proxyModel->sort(-1, Qt::AscendingOrder);
        bool block = m_sortAction->blockSignals(true);
        m_sortAction->setChecked(m_proxyModel->sortColumn() == 0);
        m_sortAction->blockSignals(block);
Kai Koehne's avatar
Kai Koehne committed
1022
        updateOutlineIndexNow();
1023 1024 1025
    }
}

1026
bool CPPEditorWidget::sortedOutline() const
1027 1028 1029 1030
{
    return (m_proxyModel->sortColumn() == 0);
}

1031
void CPPEditorWidget::updateOutlineNow()
1032 1033
{
    const Snapshot snapshot = m_modelManager->snapshot();
1034
    Document::Ptr document = snapshot.document(editorDocument()->filePath());
1035 1036 1037 1038 1039 1040