cppeditor.cpp 76.9 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>
41
#include <cpptools/cpptoolseditorsupport.h>
Roberto Raggi's avatar
Roberto Raggi committed
42
#include <cpptools/cpptoolsplugin.h>
43
#include <cpptools/cpptoolsconstants.h>
44
#include <cpptools/cppchecksymbols.h>
Christian Kamm's avatar
Christian Kamm committed
45
#include <cpptools/cppcodeformatter.h>
46 47 48
#include <cpptools/cppcompletionsupport.h>
#include <cpptools/cpphighlightingsupport.h>
#include <cpptools/cpplocalsymbols.h>
49
#include <cpptools/cppqtstyleindenter.h>
50
#include <cpptools/cpptoolsreuse.h>
51 52
#include <cpptools/doxygengenerator.h>
#include <cpptools/cpptoolssettings.h>
53
#include <cpptools/symbolfinder.h>
con's avatar
con committed
54
#include <texteditor/basetextdocument.h>
55
#include <texteditor/basetextdocumentlayout.h>
56 57 58
#include <texteditor/codeassist/basicproposalitem.h>
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/genericproposal.h>
con's avatar
con committed
59
#include <texteditor/fontsettings.h>
60
#include <texteditor/refactoroverlay.h>
61 62 63 64 65 66 67

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

protected:
    using SymbolVisitor::visit;

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

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

        return false;
    }
};

218

219
struct CanonicalSymbol
220
{
221
    CPPEditorWidget *editor;
222 223 224
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

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

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

237
    static inline bool isIdentifierChar(const QChar &ch)
238 239 240 241
    {
        return ch.isLetterOrNumber() || ch == QLatin1Char('_');
    }

242 243 244 245 246
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

247
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
248 249
                                        const QTextCursor &cursor,
                                        QString *code)
250 251 252 253 254 255 256 257 258 259 260 261
    {
        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();
262 263 264 265 266 267

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

        while (isIdentifierChar(document->characterAt(pos)))
268 269 270
            ++pos;
        tc.setPosition(pos);

271 272 273 274 275 276 277 278 279 280 281
        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);
282

283 284 285 286 287 288 289 290 291 292
        return 0;
    }

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

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

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

300
            if (! (decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
301 302
                break;

303
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
304 305 306 307 308 309 310 311 312 313 314
                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
315 316 317
        }

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

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

        return 0;
    }
326

327 328
};

329 330
int numberOfClosedEditors = 0;

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
/// 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();

394
    QString comment = QString(doc->characterAt(pos - 3))
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 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 494 495 496 497
            + 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
498 499
} // end of anonymous namespace

500 501
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
502
{
503 504 505
    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
506 507
}

508 509
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

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

con's avatar
con committed
522 523
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
524
    setCodeFoldingSupported(true);
525
    setIndenter(new CppTools::CppQtStyleIndenter);
526
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
527

528
    baseTextDocument()->setSyntaxHighlighter(new CppHighlighter);
con's avatar
con committed
529

530
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
531
    if (m_modelManager) {
532 533 534 535 536
        CppEditorSupport *editorSupport = m_modelManager->cppEditorSupport(editor());
        connect(editorSupport, SIGNAL(documentUpdated()),
                this, SLOT(onDocumentUpdated()));
        connect(editorSupport, SIGNAL(semanticInfoUpdated(CppTools::SemanticInfo)),
                this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
Orgad Shaneh's avatar
Orgad Shaneh committed
537 538
        connect(editorSupport, SIGNAL(highlighterStarted(QFuture<TextEditor::HighlightingResult> *, unsigned)),
                this, SLOT(highlighterStarted(QFuture<TextEditor::HighlightingResult> *, unsigned)));
539

540
        m_completionSupport = m_modelManager->completionSupport(editor());
con's avatar
con committed
541
    }
542

543
    m_highlightRevision = 0;
544 545
    connect(&m_highlightWatcher, SIGNAL(resultsReadyAt(int,int)), SLOT(highlightSymbolUsages(int,int)));
    connect(&m_highlightWatcher, SIGNAL(finished()), SLOT(finishHighlightSymbolUsages()));
546 547 548 549

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
    connect(&m_referencesWatcher, SIGNAL(finished()), SLOT(markSymbolsNow()));
550 551 552 553 554 555 556

    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>)));
557 558 559 560 561

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

564
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
565
{
566 567 568 569 570
    ++numberOfClosedEditors;
    if (numberOfClosedEditors == 5) {
        m_modelManager->GC();
        numberOfClosedEditors = 0;
    }
571 572

    delete m_completionSupport;
con's avatar
con committed
573 574
}

575
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
576
{
577
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
578 579 580 581
    createToolBar(editable);
    return editable;
}

582
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
583
{
584
    m_outlineCombo = new OverviewCombo;
Kai Koehne's avatar
Kai Koehne committed
585
    m_outlineCombo->setMinimumContentsLength(22);
586 587

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
588
    QSizePolicy policy = m_outlineCombo->sizePolicy();
589
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
590
    m_outlineCombo->setSizePolicy(policy);
591

Kai Koehne's avatar
Kai Koehne committed
592 593
    QTreeView *outlineView = new OverviewTreeView;
    outlineView->header()->hide();
594
    outlineView->setItemsExpandable(true);
Kai Koehne's avatar
Kai Koehne committed
595
    m_outlineCombo->setView(outlineView);
596
    m_outlineCombo->setMaxVisibleItems(40);
597
    outlineView->viewport()->installEventFilter(m_outlineCombo);
con's avatar
con committed
598

Kai Koehne's avatar
Kai Koehne committed
599 600
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
601
    if (CppEditorPlugin::instance()->sortedOutline())
602 603
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
604
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
605 606
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
607
    m_outlineCombo->setModel(m_proxyModel);
608

Kai Koehne's avatar
Kai Koehne committed
609 610
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
611
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
612
    m_sortAction->setChecked(sortedOutline());
613 614
    connect(m_sortAction, SIGNAL(toggled(bool)),
            CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
Kai Koehne's avatar
Kai Koehne committed
615
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
616

617 618 619 620 621
    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
622 623 624 625
    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
626

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
627 628 629 630 631
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

632 633 634 635 636
    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
637 638 639
    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()));
640
    connect(document(), SIGNAL(contentsChange(int,int,int)), this, SLOT(onContentsChanged(int,int,int)));
con's avatar
con committed
641

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

644 645 646
    // 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
647 648 649 650 651

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

652
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
653 654
}

655
void CPPEditorWidget::paste()
mae's avatar
mae committed
656
{
657
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
658
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
659 660 661 662
        return;
    }

    startRename();
663
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
664 665 666
    finishRename();
}

667
void CPPEditorWidget::cut()
mae's avatar
mae committed
668
{
669
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
670
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
671 672 673 674
        return;
    }

    startRename();
675
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
676 677 678
    finishRename();
}

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
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();
}

700
CppModelManagerInterface *CPPEditorWidget::modelManager() const
701 702 703 704
{
    return m_modelManager;
}

705
void CPPEditorWidget::setMimeType(const QString &mt)
706
{
707
    BaseTextEditorWidget::setMimeType(mt);
708
    setObjCEnabled(mt == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE));
709 710
}

711
void CPPEditorWidget::setObjCEnabled(bool onoff)
712 713 714 715
{
    m_objcEnabled = onoff;
}

716
bool CPPEditorWidget::isObjCEnabled() const
717 718
{ return m_objcEnabled; }

719
void CPPEditorWidget::startRename()
mae's avatar
mae committed
720 721 722 723
{
    m_inRenameChanged = false;
}

724
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
{
    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;
}

755
void CPPEditorWidget::abortRename()
756
{
757
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
758
        return;
759
    m_renameSelections[m_currentRenameSelection].format = m_occurrencesFormat;
760
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
761 762
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
763
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
764

765
    semanticRehighlight(/* force = */ true);
766 767
}

768 769 770
/// \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
771
{
772
    m_updateOutlineTimer->start();
con's avatar
con committed
773 774
}

775
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
776 777 778 779 780 781 782
{
    if (! doc)
        return 0;

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

783 784 785 786 787 788
    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
789
        return &use->macro();
790
    }
Christian Kamm's avatar
Christian Kamm committed
791 792 793

    return 0;
}
794

795
void CPPEditorWidget::findUsages()
796
{
797
    SemanticInfo info = m_lastSemanticInfo;
798
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
799
    info.snapshot.insert(info.doc);
800

801
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
802
        m_modelManager->findMacroUsages(*macro);
803 804 805 806 807
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
808
    }
809 810
}

811

812
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
813 814
{
    SemanticInfo info = m_lastSemanticInfo;
815
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
816 817
    info.snapshot.insert(info.doc);

818 819 820 821 822 823 824 825
    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);
    }
826 827
}

828
void CPPEditorWidget::renameUsages()
829
{
830 831 832
    renameUsagesNow();
}

833
void CPPEditorWidget::markSymbolsNow()
834
{
835 836 837 838 839 840
    if (m_references.isCanceled())
        return;
    else if (m_referencesCursorPosition != position())
        return;
    else if (m_referencesRevision != editorRevision())
        return;
841

842 843 844
    const SemanticInfo info = m_lastSemanticInfo;
    TranslationUnit *unit = info.doc->translationUnit();
    const QList<int> result = m_references.result();
845 846 847

    QList<QTextEdit::ExtraSelection> selections;

848 849 850
    foreach (int index, result) {
        unsigned line, column;
        unit->getTokenPosition(index, &line, &column);
851

852 853
        if (column)
            --column;  // adjust the column position.
854

855
        const int len = unit->tokenAt(index).f.length;
856

857 858 859
        QTextCursor cursor(document()->findBlockByNumber(line - 1));
        cursor.setPosition(cursor.position() + column);
        cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
860

861 862 863 864
        QTextEdit::ExtraSelection sel;
        sel.format = m_occurrencesFormat;
        sel.cursor = cursor;
        selections.append(sel);
865

Roberto Raggi's avatar
Roberto Raggi committed
866
    }
867 868

    setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
869 870
}

871
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc, Snapshot snapshot)
872 873
{
    TypeOfExpression typeOfExpression;
874 875
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
876 877
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
878
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
879
        return CppModelManagerInterface::instance()->references(canonicalSymbol, typeOfExpression.context());
880 881 882
    return QList<int>();
}

883
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
884 885 886 887 888 889
{
    abortRename();

    if (! info.doc)
        return;

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
    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
906
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
            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);
        }
922

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
        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>());
        }
939 940 941
    }
}

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

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
948 949 950 951 952
    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()
953
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
954
            m_currentRenameSelection = i;
mae's avatar
mae committed
955 956 957 958 959
            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());
960
            m_renameSelections[i].format = m_occurrenceRenameFormat;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
961 962 963 964
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
965 966

    if (m_renameSelections.isEmpty())
967
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
968 969
}

970
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
971
{
972 973
    Q_UNUSED(position)

974
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
975 976
        return;

mae's avatar
mae committed
977 978 979 980 981 982 983 984 985 986 987
    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)
988 989 990 991 992 993
        abortRename();

    if (charsRemoved > 0)
        updateUses();
}

994
void CPPEditorWidget::updateFileName()
995
{}
con's avatar
con committed
996

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
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);
con's avatar
con committed
1013 1014 1015
    if (! symbol)
        return;

1016
    openCppEditorAt(linkToSymbol(symbol));
con's avatar
con committed
1017 1018
}

1019
void CPPEditorWidget::setSortedOutline(bool sort)
1020
{
Kai Koehne's avatar
Kai Koehne committed
1021
    if (sort != sortedOutline()) {
1022 1023 1024 1025 1026 1027 1028
        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
1029
        updateOutlineIndexNow();
1030 1031 1032
    }
}

1033
bool CPPEditorWidget::sortedOutline() const
1034 1035 1036 1037
{
    return (m_proxyModel->sortColumn() == 0);
}

1038
void CPPEditorWidget::updateOutlineNow()
1039 1040
{
    const Snapshot snapshot = m_modelManager->snapshot();
1041
    Document::Ptr document = snapshot.document(editorDocument()->fileName());
1042 1043 1044 1045 1046 1047 1048 1049 1050

    if (!document)
        return;

    if (document->editorRevision() != editorRevision()) {
        m_updateOutlineTimer->start();
        return;
    }

Kai Koehne's avatar
Kai Koehne committed
1051
    m_outlineModel->rebuild(document);
1052

Kai Koehne's avatar
Kai Koehne committed
1053
    OverviewTreeView *treeView = static_cast<OverviewTreeView *>(m_outlineCombo->view());
1054
    treeView->sync();
Kai Koehne's avatar
Kai Koehne committed
1055
    updateOutlineIndexNow();
1056 1057
}