cppeditor.cpp 66 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 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"
37
#include "cpppreprocessordialog.h"
Leandro Melo's avatar
Leandro Melo committed
38
#include "cppquickfixassistant.h"
Roberto Raggi's avatar
Roberto Raggi committed
39

40 41
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.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>
55 56 57 58
#include <cpptools/cppmodelmanager.h>
#include <projectexplorer/session.h>
#include <projectexplorer/projectnodes.h>
#include <projectexplorer/nodesvisitor.h>
con's avatar
con committed
59
#include <texteditor/basetextdocument.h>
60
#include <texteditor/basetextdocumentlayout.h>
61 62 63
#include <texteditor/codeassist/basicproposalitem.h>
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/genericproposal.h>
con's avatar
con committed
64
#include <texteditor/fontsettings.h>
65
#include <texteditor/refactoroverlay.h>
66 67

#include <utils/qtcassert.h>
Daniel Teske's avatar
Daniel Teske committed
68
#include <utils/treeviewcombobox.h>
69 70 71 72 73

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

75 76
#include <QDebug>
#include <QTimer>
77
#include <QPointer>
78 79 80 81 82 83
#include <QSignalMapper>
#include <QAction>
#include <QHeaderView>
#include <QMenu>
#include <QTextEdit>
#include <QSortFilterProxyModel>
84
#include <QToolButton>
con's avatar
con committed
85

Roberto Raggi's avatar
Roberto Raggi committed
86
enum {
87
    UPDATE_OUTLINE_INTERVAL = 500,
88 89
    UPDATE_USES_INTERVAL = 500,
    UPDATE_FUNCTION_DECL_DEF_LINK_INTERVAL = 200
Roberto Raggi's avatar
Roberto Raggi committed
90 91
};

Roberto Raggi's avatar
Roberto Raggi committed
92
using namespace CPlusPlus;
93
using namespace CppTools;
Roberto Raggi's avatar
Roberto Raggi committed
94 95
using namespace CppEditor::Internal;

con's avatar
con committed
96 97
namespace {

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
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;
};

123 124
class FindFunctionDefinitions: protected SymbolVisitor
{
Roberto Raggi's avatar
Roberto Raggi committed
125
    const Name *_declarationName;
126 127 128 129 130 131 132 133
    QList<Function *> *_functions;

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

Roberto Raggi's avatar
Roberto Raggi committed
134
    void operator()(const Name *declarationName, Scope *globals,
135 136 137 138 139
                    QList<Function *> *functions)
    {
        _declarationName = declarationName;
        _functions = functions;

Roberto Raggi's avatar
Roberto Raggi committed
140 141
        for (unsigned i = 0; i < globals->memberCount(); ++i) {
            accept(globals->memberAt(i));
142 143 144 145 146 147 148 149
        }
    }

protected:
    using SymbolVisitor::visit;

    virtual bool visit(Function *function)
    {
Roberto Raggi's avatar
Roberto Raggi committed
150 151
        const Name *name = function->name();
        if (const QualifiedNameId *q = name->asQualifiedNameId())
152
            name = q->name();
153 154 155 156 157 158 159 160

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

        return false;
    }
};

161
struct CanonicalSymbol
162
{
163
    CPPEditorWidget *editor;
164 165 166
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

167
    CanonicalSymbol(CPPEditorWidget *editor, const SemanticInfo &info)
Erik Verbruggen's avatar
Erik Verbruggen committed
168
        : editor(editor), info(info)
169 170
    {
        typeOfExpression.init(info.doc, info.snapshot);
171
        typeOfExpression.setExpandTemplates(true);
172 173 174 175 176 177 178
    }

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

179
    static inline bool isIdentifierChar(const QChar &ch)
180 181 182 183
    {
        return ch.isLetterOrNumber() || ch == QLatin1Char('_');
    }

184 185 186 187 188
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

189
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
190 191
                                        const QTextCursor &cursor,
                                        QString *code)
192
    {
193
        if (!info.doc)
194 195 196 197 198 199 200 201 202 203
            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();
204

205 206
        if (!isIdentifierChar(document->characterAt(pos)))
            if (!(pos > 0 && isIdentifierChar(document->characterAt(pos - 1))))
207 208 209
                return 0;

        while (isIdentifierChar(document->characterAt(pos)))
210 211 212
            ++pos;
        tc.setPosition(pos);

213 214 215 216 217 218 219 220 221 222 223
        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);
224

225 226 227 228 229 230 231 232
        return 0;
    }

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
233 234
    static Symbol *canonicalSymbol(Scope *scope, const QString &code,
                                   TypeOfExpression &typeOfExpression)
235
    {
236 237
        const QList<LookupItem> results =
                typeOfExpression(code.toUtf8(), scope, TypeOfExpression::Preprocess);
238

Roberto Raggi's avatar
Roberto Raggi committed
239 240
        for (int i = results.size() - 1; i != -1; --i) {
            const LookupItem &r = results.at(i);
241
            Symbol *decl = r.declaration();
Roberto Raggi's avatar
Roberto Raggi committed
242

243
            if (!(decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
244 245
                break;

246
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
247 248 249 250 251 252
                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.

253
                if (Function *funTy = r.declaration()->type()->asFunctionType()) {
254 255 256 257
                    if (funTy->isVirtual())
                        return r.declaration();
                }
            }
Roberto Raggi's avatar
Roberto Raggi committed
258 259 260
        }

        for (int i = 0; i < results.size(); ++i) {
261 262 263 264 265 266 267 268
            const LookupItem &r = results.at(i);

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

        return 0;
    }
269

270 271
};

272 273 274
/// Check if previous line is a CppStyle Doxygen Comment
bool isPreviousLineCppStyleComment(const QTextCursor &cursor)
{
Orgad Shaneh's avatar
Orgad Shaneh committed
275 276 277
    const QTextBlock &currentBlock = cursor.block();
    if (!currentBlock.isValid())
        return false;
278

Orgad Shaneh's avatar
Orgad Shaneh committed
279 280 281
    const QTextBlock &actual = currentBlock.previous();
    if (!actual.isValid())
        return false;
282

Orgad Shaneh's avatar
Orgad Shaneh committed
283 284 285
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
286

Orgad Shaneh's avatar
Orgad Shaneh committed
287
    return false;
288 289 290 291 292
}

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

Orgad Shaneh's avatar
Orgad Shaneh committed
297 298 299
    const QTextBlock &actual = currentBlock.next();
    if (!actual.isValid())
        return false;
300

Orgad Shaneh's avatar
Orgad Shaneh committed
301 302 303
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
304

Orgad Shaneh's avatar
Orgad Shaneh committed
305
    return false;
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
}

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

335
    QString comment = QString(doc->characterAt(pos - 3))
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
            + 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
364 365 366
          || text.startsWith(QLatin1String("//!")))) {
        return false;
    }
367 368 369 370 371 372

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

    const QString commentMarker = text.mid(offset, 3);
    newLine.append(commentMarker);
373
    newLine.append(QLatin1Char(' '));
374 375 376 377 378 379 380 381 382 383 384 385 386 387 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

    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('/')) {
425
                newLine.append(QLatin1String(" * "));
426 427 428 429 430
            } else {
                int start = offset;
                while (offset < blockPos && text.at(offset) == QLatin1Char('*'))
                    ++offset;
                newLine.append(QString(offset - start, QLatin1Char('*')));
431
                newLine.append(QLatin1Char(' '));
432 433 434 435 436 437 438 439 440 441
            }
            cursor.insertText(newLine);
            e->accept();
            return true;
        }
    }

    return false;
}

con's avatar
con committed
442 443
} // end of anonymous namespace

444 445
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
446
{
447 448 449
    m_context.add(CppEditor::Constants::C_CPPEDITOR);
    m_context.add(ProjectExplorer::Constants::LANG_CXX);
    m_context.add(TextEditor::Constants::C_TEXTEDITOR);
450
    setDuplicateSupported(true);
con's avatar
con committed
451 452
}

453 454
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

455
CPPEditorWidget::CPPEditorWidget(QWidget *parent)
456
    : TextEditor::BaseTextEditorWidget(new CPPEditorDocument(), parent)
con's avatar
con committed
457
{
458
    baseTextDocument()->setIndenter(new CppTools::CppQtStyleIndenter);
459 460 461 462 463 464 465 466 467 468 469
    ctor();
}

CPPEditorWidget::CPPEditorWidget(CPPEditorWidget *other)
    : TextEditor::BaseTextEditorWidget(other)
{
    ctor();
}

void CPPEditorWidget::ctor()
{
470
    m_cppEditorDocument = qobject_cast<CPPEditorDocument *>(baseTextDocument());
471 472 473 474 475 476 477 478
    m_currentRenameSelection = NoCurrentRenameSelection;
    m_inRename = false;
    m_inRenameChanged = false;
    m_firstRenameChange = false;
    m_commentsSettings = CppTools::CppToolsSettings::instance()->commentsSettings();
    m_followSymbolUnderCursor.reset(new FollowSymbolUnderCursor(this));
    m_preprocessorButton = 0;

479
    qRegisterMetaType<SemanticInfo>("CppTools::SemanticInfo");
Roberto Raggi's avatar
Roberto Raggi committed
480

con's avatar
con committed
481 482
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
483
    setCodeFoldingSupported(true);
484
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
485

486
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
487
    if (m_modelManager) {
488 489 490 491 492
        CppEditorSupport *editorSupport = m_modelManager->cppEditorSupport(editor());
        connect(editorSupport, SIGNAL(documentUpdated()),
                this, SLOT(onDocumentUpdated()));
        connect(editorSupport, SIGNAL(semanticInfoUpdated(CppTools::SemanticInfo)),
                this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
Eike Ziller's avatar
Eike Ziller committed
493 494
        connect(editorSupport, SIGNAL(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)),
                this, SLOT(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)));
con's avatar
con committed
495
    }
496

497
    m_highlightRevision = 0;
498 499 500

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
501 502 503 504 505 506 507

    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>)));
508 509 510 511 512

    connect(CppTools::CppToolsSettings::instance(),
            SIGNAL(commentsSettingsChanged(CppTools::CommentsSettings)),
            this,
            SLOT(onCommentsSettingsChanged(CppTools::CommentsSettings)));
513 514 515 516

    connect(baseTextDocument(), SIGNAL(filePathChanged(QString,QString)),
            this, SLOT(onFilePathChanged()));
    onFilePathChanged();
con's avatar
con committed
517 518
}

519
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
520
{
521
    if (m_modelManager)
522
        m_modelManager->deleteCppEditorSupport(editor());
con's avatar
con committed
523 524
}

525 526 527 528 529
CPPEditorDocument *CPPEditorWidget::cppEditorDocument() const
{
    return m_cppEditorDocument;
}

530
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
531
{
532
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
533 534 535 536
    createToolBar(editable);
    return editable;
}

537
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
538
{
Daniel Teske's avatar
Daniel Teske committed
539
    m_outlineCombo = new Utils::TreeViewComboBox;
Kai Koehne's avatar
Kai Koehne committed
540
    m_outlineCombo->setMinimumContentsLength(22);
541 542

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
543
    QSizePolicy policy = m_outlineCombo->sizePolicy();
544
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
545
    m_outlineCombo->setSizePolicy(policy);
546
    m_outlineCombo->setMaxVisibleItems(40);
con's avatar
con committed
547

Kai Koehne's avatar
Kai Koehne committed
548 549
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
550
    if (CppEditorPlugin::instance()->sortedOutline())
551 552
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
553
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
554 555
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
556
    m_outlineCombo->setModel(m_proxyModel);
557

Kai Koehne's avatar
Kai Koehne committed
558 559
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
560
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
561
    m_sortAction->setChecked(sortedOutline());
562 563
    connect(m_sortAction, SIGNAL(toggled(bool)),
            CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
Kai Koehne's avatar
Kai Koehne committed
564
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
565

566 567 568 569 570
    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
571 572 573 574
    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
575

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
576 577 578 579 580
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

581 582 583
    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
584 585
    connect(m_updateFunctionDeclDefLinkTimer, SIGNAL(timeout()),
            this, SLOT(updateFunctionDeclDefLinkNow()));
586

587
    connect(m_outlineCombo, SIGNAL(activated(int)), this, SLOT(jumpToOutlineElement()));
Kai Koehne's avatar
Kai Koehne committed
588 589
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateOutlineIndex()));
    connect(m_outlineCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(updateOutlineToolTip()));
con's avatar
con committed
590

591
    // set up slots to document changes
592 593
    connect(document(), SIGNAL(contentsChange(int,int,int)),
            this, SLOT(onContentsChanged(int,int,int)));
con's avatar
con committed
594

595 596 597
    // 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
598 599 600 601 602

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

603 604 605 606 607 608 609
    m_preprocessorButton = new QToolButton(this);
    m_preprocessorButton->setText(QLatin1String("#"));
    Core::Command *cmd = Core::ActionManager::command(Constants::OPEN_PREPROCESSOR_DIALOG);
    connect(cmd, SIGNAL(keySequenceChanged()), this, SLOT(updatePreprocessorButtonTooltip()));
    updatePreprocessorButtonTooltip();
    connect(m_preprocessorButton, SIGNAL(clicked()), this, SLOT(showPreProcessorWidget()));
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_preprocessorButton);
610
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
611 612
}

613
void CPPEditorWidget::paste()
mae's avatar
mae committed
614
{
615
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
616
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
617 618 619 620
        return;
    }

    startRename();
621
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
622 623 624
    finishRename();
}

625
void CPPEditorWidget::cut()
mae's avatar
mae committed
626
{
627
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
628
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
629 630 631 632
        return;
    }

    startRename();
633
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
634 635 636
    finishRename();
}

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
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();
}

658
void CPPEditorWidget::startRename()
mae's avatar
mae committed
659 660 661 662
{
    m_inRenameChanged = false;
}

663
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
{
    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;
}

694
void CPPEditorWidget::abortRename()
695
{
696
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
697
        return;
698 699
    m_renameSelections[m_currentRenameSelection].format
            = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES);
700
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
701 702
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
703
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
704

705
    semanticRehighlight(/* force = */ true);
706 707
}

708 709 710
/// \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
711
{
712
    m_updateOutlineTimer->start();
con's avatar
con committed
713 714
}

715
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
716
{
717
    if (!doc)
Christian Kamm's avatar
Christian Kamm committed
718 719 720 721 722
        return 0;

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

723 724 725
    if (const Macro *macro = doc->findMacroDefinitionAt(line)) {
        QTextCursor macroCursor = cursor;
        const QByteArray name = identifierUnderCursor(&macroCursor).toLatin1();
726
        if (macro->name() == name)
727 728
            return macro;
    } else if (const Document::MacroUse *use = doc->findMacroUseAt(cursor.position())) {
729
        return &use->macro();
730
    }
Christian Kamm's avatar
Christian Kamm committed
731 732 733

    return 0;
}
734

735
void CPPEditorWidget::findUsages()
736
{
737 738 739
    if (!m_modelManager)
        return;

740
    SemanticInfo info = m_lastSemanticInfo;
741
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
742
    info.snapshot.insert(info.doc);
743

744
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
745
        m_modelManager->findMacroUsages(*macro);
746 747 748 749 750
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
751
    }
752 753
}

754

755
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
756
{
757 758 759
    if (!m_modelManager)
        return;

760
    SemanticInfo info = m_lastSemanticInfo;
761
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
762 763
    info.snapshot.insert(info.doc);

764 765 766 767 768 769 770 771
    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);
    }
772 773
}

774
void CPPEditorWidget::renameUsages()
775
{
776 777 778
    renameUsagesNow();
}

779
void CPPEditorWidget::markSymbolsNow()
780
{
Erik Verbruggen's avatar
Erik Verbruggen committed
781 782 783 784 785 786 787
    QTC_ASSERT(m_referencesWatcher, return);
    if (!m_referencesWatcher->isCanceled()
            && m_referencesCursorPosition == position()
            && m_referencesRevision == editorRevision()) {
        const SemanticInfo info = m_lastSemanticInfo;
        TranslationUnit *unit = info.doc->translationUnit();
        const QList<int> result = m_referencesWatcher->result();
788

Erik Verbruggen's avatar
Erik Verbruggen committed
789
        QList<QTextEdit::ExtraSelection> selections;
790

Erik Verbruggen's avatar
Erik Verbruggen committed
791 792 793
        foreach (int index, result) {
            unsigned line, column;
            unit->getTokenPosition(index, &line, &column);
794

Erik Verbruggen's avatar
Erik Verbruggen committed
795 796
            if (column)
                --column;  // adjust the column position.
797

Nikolai Kosjar's avatar
Nikolai Kosjar committed
798
            const int len = unit->tokenAt(index).bytes();
799

Erik Verbruggen's avatar
Erik Verbruggen committed
800 801 802
            QTextCursor cursor(document()->findBlockByNumber(line - 1));
            cursor.setPosition(cursor.position() + column);
            cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
803

Erik Verbruggen's avatar
Erik Verbruggen committed
804 805 806 807 808 809
            QTextEdit::ExtraSelection sel;
            sel.format = baseTextDocument()->fontSettings()
                         .toTextCharFormat(TextEditor::C_OCCURRENCES);
            sel.cursor = cursor;
            selections.append(sel);
        }
810

Erik Verbruggen's avatar
Erik Verbruggen committed
811
        setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
812
    }
Erik Verbruggen's avatar
Erik Verbruggen committed
813
    m_referencesWatcher.reset();
Roberto Raggi's avatar
Roberto Raggi committed
814 815
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
816 817
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc,
                                     Snapshot snapshot)
818 819
{
    TypeOfExpression typeOfExpression;
820 821
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
822 823
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
824
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
Nikolai Kosjar's avatar
Nikolai Kosjar committed
825 826
        return CppModelManagerInterface::instance()->references(canonicalSymbol,
                                                                typeOfExpression.context());
827 828 829
    return QList<int>();
}

830
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
831 832 833
{
    abortRename();

834
    if (!info.doc)
835
        return;
836 837
    const QTextCharFormat &occurrencesFormat
            = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES);
838 839 840 841 842 843 844
    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
845 846
            cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor,
                                macro->name().length());
847 848

            QTextEdit::ExtraSelection sel;
849
            sel.format = occurrencesFormat;
850 851 852 853 854
            sel.cursor = cursor;
            selections.append(sel);
        }

        //Other macro uses
855
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
856 857 858 859 860
            const Macro &useMacro = use.macro();
            if (useMacro.line() != macro->line()
                    || useMacro.offset() != macro->offset()
                    || useMacro.length() != macro->length()
                    || useMacro.fileName() != macro->fileName())
861 862 863 864 865 866 867
                continue;

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

            QTextEdit::ExtraSelection sel;
868
            sel.format = occurrencesFormat;
869 870 871
            sel.cursor = cursor;
            selections.append(sel);
        }
872

873 874 875 876 877
        setExtraSelections(CodeSemanticsSelection, selections);
    } else {
        CanonicalSymbol cs(this, info);
        QString expression;
        if (Scope *scope = cs.getScopeAndExpression(this, info, tc, &expression)) {
Erik Verbruggen's avatar
Erik Verbruggen committed
878 879 880 881 882
            if (m_referencesWatcher)
                m_referencesWatcher->cancel();
            m_referencesWatcher.reset(new QFutureWatcher<QList<int> >);
            connect(m_referencesWatcher.data(), SIGNAL(finished()), SLOT(markSymbolsNow()));

883 884
            m_referencesRevision = info.revision;
            m_referencesCursorPosition = position();
Erik Verbruggen's avatar
Erik Verbruggen committed
885 886
            m_referencesWatcher->setFuture(QtConcurrent::run(&lazyFindReferences, scope, expression,
                                                             info.doc, info.snapshot));
887 888 889
        } else {
            const QList<QTextEdit::ExtraSelection> selections = extraSelections(CodeSemanticsSelection);

890
            if (!selections.isEmpty())
891 892
                setExtraSelections(CodeSemanticsSelection, QList<QTextEdit::ExtraSelection>());
        }
893 894 895
    }
}

896
void CPPEditorWidget::renameSymbolUnderCursor()
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
897
{
898 899 900
    if (!m_modelManager)
        return;

901
    CppEditorSupport *edSup = m_modelManager->cppEditorSupport(editor());
902
    updateSemanticInfo(edSup->recalculateSemanticInfo());
mae's avatar
mae committed
903
    abortRename();
904

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
905 906 907 908 909
    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()
910
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
911
            m_currentRenameSelection = i;
mae's avatar
mae committed
912 913 914 915
            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
916
                                                      m_renameSelections[i].cursor.selectionEnd());
917 918
            m_renameSelections[i].format
                    = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES_RENAME);;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
919 920 921 922
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
923 924

    if (m_renameSelections.isEmpty())
925
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
926 927
}

928
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
929
{
930
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
931 932
        return;

mae's avatar
mae committed
933 934 935
    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
936 937
        m_renameSelections[m_currentRenameSelection].cursor.setPosition(position,
                                                                        QTextCursor::KeepAnchor);
mae's avatar
mae committed
938 939
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
940 941
    // the condition looks odd, but keep in mind that the begin
    // and end cursors do move automatically
mae's avatar
mae committed
942 943 944 945
    m_inRenameChanged = (position >= m_currentRenameSelectionBegin.position()
                         && position + charsAdded <= m_currentRenameSelectionEnd.position());

    if (!m_inRenameChanged)
946 947 948 949 950 951
        abortRename();

    if (charsRemoved > 0)
        updateUses();
}

952 953 954 955 956 957 958 959
void CPPEditorWidget::updatePreprocessorButtonTooltip()
{
    QTC_ASSERT(m_preprocessorButton, return);
    Core::Command *cmd = Core::ActionManager::command(Constants::OPEN_PREPROCESSOR_DIALOG);
    QTC_ASSERT(cmd, return);
    m_preprocessorButton->setToolTip(cmd->action()->toolTip());
}

960
void CPPEditorWidget::jumpToOutlineElement()
961 962 963 964
{
    QModelIndex modelIndex = m_outlineCombo->view()->currentIndex();
    QModelIndex sourceIndex = m_proxyModel->mapToSource(modelIndex);
    Symbol *symbol = m_outlineModel->symbolFromIndex(sourceIndex);
965
    if (!symbol)
con's avatar
con committed
966 967
        return;

968 969 970
    const Link &link = linkToSymbol(symbol);
    gotoLine(link.targetLine, link.targetColumn);
    Core::EditorManager::activateEditor(editor());