cppeditor.cpp 63.7 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/cppchecksymbols.h>
Christian Kamm's avatar
Christian Kamm committed
45
#include <cpptools/cppcodeformatter.h>
46
#include <cpptools/cppcompletionassistprovider.h>
47 48
#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>
54 55 56 57
#include <cpptools/cppmodelmanager.h>
#include <projectexplorer/session.h>
#include <projectexplorer/projectnodes.h>
#include <projectexplorer/nodesvisitor.h>
con's avatar
con committed
58
#include <texteditor/basetextdocument.h>
59
#include <texteditor/basetextdocumentlayout.h>
60 61 62
#include <texteditor/codeassist/basicproposalitem.h>
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/genericproposal.h>
con's avatar
con committed
63
#include <texteditor/fontsettings.h>
64
#include <texteditor/refactoroverlay.h>
65 66

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

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

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

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

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

con's avatar
con committed
93 94
namespace {

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

120
class CanonicalSymbol
121 122
{
public:
123
    CPPEditorWidget *editor;
124 125 126
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

127
    CanonicalSymbol(CPPEditorWidget *editor, const SemanticInfo &info)
Erik Verbruggen's avatar
Erik Verbruggen committed
128
        : editor(editor), info(info)
129 130
    {
        typeOfExpression.init(info.doc, info.snapshot);
131
        typeOfExpression.setExpandTemplates(true);
132 133 134 135 136 137 138
    }

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

139 140 141 142 143
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

144
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
145 146
                                        const QTextCursor &cursor,
                                        QString *code)
147
    {
148
        if (!info.doc)
149 150 151 152 153 154 155 156 157 158
            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();
159

160 161
        if (!isValidIdentifierChar(document->characterAt(pos)))
            if (!(pos > 0 && isValidIdentifierChar(document->characterAt(pos - 1))))
162 163
                return 0;

164
        while (isValidIdentifierChar(document->characterAt(pos)))
165 166 167
            ++pos;
        tc.setPosition(pos);

168 169 170 171 172 173 174 175 176 177 178
        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);
179

180 181 182 183 184 185 186 187
        return 0;
    }

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
188 189
    static Symbol *canonicalSymbol(Scope *scope, const QString &code,
                                   TypeOfExpression &typeOfExpression)
190
    {
191 192
        const QList<LookupItem> results =
                typeOfExpression(code.toUtf8(), scope, TypeOfExpression::Preprocess);
193

Roberto Raggi's avatar
Roberto Raggi committed
194 195
        for (int i = results.size() - 1; i != -1; --i) {
            const LookupItem &r = results.at(i);
196
            Symbol *decl = r.declaration();
Roberto Raggi's avatar
Roberto Raggi committed
197

198
            if (!(decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
199 200
                break;

201
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
202 203 204
                const Identifier *declId = decl->identifier();
                const Identifier *classId = classScope->identifier();

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

208
                if (Function *funTy = r.declaration()->type()->asFunctionType()) {
209 210 211 212
                    if (funTy->isVirtual())
                        return r.declaration();
                }
            }
Roberto Raggi's avatar
Roberto Raggi committed
213 214 215
        }

        for (int i = 0; i < results.size(); ++i) {
216 217 218 219 220 221 222 223
            const LookupItem &r = results.at(i);

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

        return 0;
    }
224

225 226
};

227 228 229
/// Check if previous line is a CppStyle Doxygen Comment
bool isPreviousLineCppStyleComment(const QTextCursor &cursor)
{
Orgad Shaneh's avatar
Orgad Shaneh committed
230 231 232
    const QTextBlock &currentBlock = cursor.block();
    if (!currentBlock.isValid())
        return false;
233

Orgad Shaneh's avatar
Orgad Shaneh committed
234 235 236
    const QTextBlock &actual = currentBlock.previous();
    if (!actual.isValid())
        return false;
237

Orgad Shaneh's avatar
Orgad Shaneh committed
238 239 240
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
241

Orgad Shaneh's avatar
Orgad Shaneh committed
242
    return false;
243 244 245 246 247
}

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

Orgad Shaneh's avatar
Orgad Shaneh committed
252 253 254
    const QTextBlock &actual = currentBlock.next();
    if (!actual.isValid())
        return false;
255

Orgad Shaneh's avatar
Orgad Shaneh committed
256 257 258
    const QString text = actual.text().trimmed();
    if (text.startsWith(QLatin1String("///")) || text.startsWith(QLatin1String("//!")))
        return true;
259

Orgad Shaneh's avatar
Orgad Shaneh committed
260
    return false;
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
}

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

290
    QString comment = QString(doc->characterAt(pos - 3))
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
            + 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
319 320 321
          || text.startsWith(QLatin1String("//!")))) {
        return false;
    }
322 323 324 325 326 327

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

    const QString commentMarker = text.mid(offset, 3);
    newLine.append(commentMarker);
328
    newLine.append(QLatin1Char(' '));
329 330 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

    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('/')) {
380
                newLine.append(QLatin1String(" * "));
381 382 383 384 385
            } else {
                int start = offset;
                while (offset < blockPos && text.at(offset) == QLatin1Char('*'))
                    ++offset;
                newLine.append(QString(offset - start, QLatin1Char('*')));
386
                newLine.append(QLatin1Char(' '));
387 388 389 390 391 392 393 394 395 396
            }
            cursor.insertText(newLine);
            e->accept();
            return true;
        }
    }

    return false;
}

con's avatar
con committed
397 398
} // end of anonymous namespace

399 400
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
401
{
402 403 404
    m_context.add(CppEditor::Constants::C_CPPEDITOR);
    m_context.add(ProjectExplorer::Constants::LANG_CXX);
    m_context.add(TextEditor::Constants::C_TEXTEDITOR);
405
    setDuplicateSupported(true);
con's avatar
con committed
406 407
}

408 409
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

410
CPPEditorWidget::CPPEditorWidget(QWidget *parent)
411
    : TextEditor::BaseTextEditorWidget(new CPPEditorDocument(), parent)
con's avatar
con committed
412
{
413
    baseTextDocument()->setIndenter(new CppTools::CppQtStyleIndenter);
414 415 416 417 418 419 420 421 422 423 424
    ctor();
}

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

void CPPEditorWidget::ctor()
{
425
    m_cppEditorDocument = qobject_cast<CPPEditorDocument *>(baseTextDocument());
426 427 428 429 430 431 432 433
    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;

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

con's avatar
con committed
436 437
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
438
    setCodeFoldingSupported(true);
439
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
440

441
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
442
    if (m_modelManager) {
443 444 445 446 447
        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
448 449
        connect(editorSupport, SIGNAL(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)),
                this, SLOT(highlighterStarted(QFuture<TextEditor::HighlightingResult>*,uint)));
con's avatar
con committed
450
    }
451

452
    m_highlightRevision = 0;
453 454 455

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
456 457 458 459 460 461 462

    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>)));
463 464 465 466 467

    connect(CppTools::CppToolsSettings::instance(),
            SIGNAL(commentsSettingsChanged(CppTools::CommentsSettings)),
            this,
            SLOT(onCommentsSettingsChanged(CppTools::CommentsSettings)));
468 469 470 471

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

474
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
475
{
476
    if (m_modelManager)
477
        m_modelManager->deleteCppEditorSupport(editor());
con's avatar
con committed
478 479
}

480 481 482 483 484
CPPEditorDocument *CPPEditorWidget::cppEditorDocument() const
{
    return m_cppEditorDocument;
}

485
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
486
{
487
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
488 489 490 491
    createToolBar(editable);
    return editable;
}

492
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
493
{
Daniel Teske's avatar
Daniel Teske committed
494
    m_outlineCombo = new Utils::TreeViewComboBox;
Kai Koehne's avatar
Kai Koehne committed
495
    m_outlineCombo->setMinimumContentsLength(22);
496 497

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
498
    QSizePolicy policy = m_outlineCombo->sizePolicy();
499
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
500
    m_outlineCombo->setSizePolicy(policy);
501
    m_outlineCombo->setMaxVisibleItems(40);
con's avatar
con committed
502

Kai Koehne's avatar
Kai Koehne committed
503 504
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
505
    if (CppEditorPlugin::instance()->sortedOutline())
506 507
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
508
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
509 510
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
511
    m_outlineCombo->setModel(m_proxyModel);
512

Kai Koehne's avatar
Kai Koehne committed
513 514
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
515
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
516
    m_sortAction->setChecked(sortedOutline());
517 518
    connect(m_sortAction, SIGNAL(toggled(bool)),
            CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
Kai Koehne's avatar
Kai Koehne committed
519
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
520

521 522 523 524 525
    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
526 527 528 529
    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
530

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
531 532 533 534 535
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

536 537 538
    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
539 540
    connect(m_updateFunctionDeclDefLinkTimer, SIGNAL(timeout()),
            this, SLOT(updateFunctionDeclDefLinkNow()));
541

542
    connect(m_outlineCombo, SIGNAL(activated(int)), this, SLOT(jumpToOutlineElement()));
Kai Koehne's avatar
Kai Koehne committed
543 544
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateOutlineIndex()));
    connect(m_outlineCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(updateOutlineToolTip()));
con's avatar
con committed
545

546
    // set up slots to document changes
547 548
    connect(document(), SIGNAL(contentsChange(int,int,int)),
            this, SLOT(onContentsChanged(int,int,int)));
con's avatar
con committed
549

550 551 552
    // 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
553 554 555 556 557

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

558 559 560 561 562 563 564
    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);
565
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
566 567
}

568
void CPPEditorWidget::paste()
mae's avatar
mae committed
569
{
570
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
571
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
572 573 574 575
        return;
    }

    startRename();
576
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
577 578 579
    finishRename();
}

580
void CPPEditorWidget::cut()
mae's avatar
mae committed
581
{
582
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
583
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
584 585 586 587
        return;
    }

    startRename();
588
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
589 590 591
    finishRename();
}

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
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();
}

613
void CPPEditorWidget::startRename()
mae's avatar
mae committed
614 615 616 617
{
    m_inRenameChanged = false;
}

618
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
{
    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;
}

649
void CPPEditorWidget::abortRename()
650
{
651
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
652
        return;
653 654
    m_renameSelections[m_currentRenameSelection].format
            = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES);
655
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
656 657
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
658
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
659

660
    semanticRehighlight(/* force = */ true);
661 662
}

663 664 665
/// \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
666
{
667
    m_updateOutlineTimer->start();
con's avatar
con committed
668 669
}

670
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
671
{
672
    if (!doc)
Christian Kamm's avatar
Christian Kamm committed
673 674 675 676 677
        return 0;

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

678 679
    if (const Macro *macro = doc->findMacroDefinitionAt(line)) {
        QTextCursor macroCursor = cursor;
680
        const QByteArray name = identifierUnderCursor(&macroCursor).toUtf8();
681
        if (macro->name() == name)
682 683
            return macro;
    } else if (const Document::MacroUse *use = doc->findMacroUseAt(cursor.position())) {
684
        return &use->macro();
685
    }
Christian Kamm's avatar
Christian Kamm committed
686 687 688

    return 0;
}
689

690
void CPPEditorWidget::findUsages()
691
{
692 693 694
    if (!m_modelManager)
        return;

695
    SemanticInfo info = m_lastSemanticInfo;
696
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
697
    info.snapshot.insert(info.doc);
698

699
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
700
        m_modelManager->findMacroUsages(*macro);
701 702 703 704 705
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
706
    }
707 708
}

709

710
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
711
{
712 713 714
    if (!m_modelManager)
        return;

715
    SemanticInfo info = m_lastSemanticInfo;
716
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
717 718
    info.snapshot.insert(info.doc);

719 720 721 722 723 724 725 726
    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);
    }
727 728
}

729
void CPPEditorWidget::renameUsages()
730
{
731 732 733
    renameUsagesNow();
}

734
void CPPEditorWidget::markSymbolsNow()
735
{
Erik Verbruggen's avatar
Erik Verbruggen committed
736 737 738 739 740 741 742
    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();
743

Erik Verbruggen's avatar
Erik Verbruggen committed
744
        QList<QTextEdit::ExtraSelection> selections;
745

Erik Verbruggen's avatar
Erik Verbruggen committed
746 747 748
        foreach (int index, result) {
            unsigned line, column;
            unit->getTokenPosition(index, &line, &column);
749

Erik Verbruggen's avatar
Erik Verbruggen committed
750 751
            if (column)
                --column;  // adjust the column position.
752

753
            const int len = unit->tokenAt(index).utf16chars();
754

Erik Verbruggen's avatar
Erik Verbruggen committed
755 756 757
            QTextCursor cursor(document()->findBlockByNumber(line - 1));
            cursor.setPosition(cursor.position() + column);
            cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
758

Erik Verbruggen's avatar
Erik Verbruggen committed
759 760 761 762 763 764
            QTextEdit::ExtraSelection sel;
            sel.format = baseTextDocument()->fontSettings()
                         .toTextCharFormat(TextEditor::C_OCCURRENCES);
            sel.cursor = cursor;
            selections.append(sel);
        }
765

Erik Verbruggen's avatar
Erik Verbruggen committed
766
        setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
767
    }
Erik Verbruggen's avatar
Erik Verbruggen committed
768
    m_referencesWatcher.reset();
Roberto Raggi's avatar
Roberto Raggi committed
769 770
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
771 772
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc,
                                     Snapshot snapshot)
773 774
{
    TypeOfExpression typeOfExpression;
775 776
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
777 778
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
779
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
Nikolai Kosjar's avatar
Nikolai Kosjar committed
780 781
        return CppModelManagerInterface::instance()->references(canonicalSymbol,
                                                                typeOfExpression.context());
782 783 784
    return QList<int>();
}

785
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
786 787 788
{
    abortRename();

789
    if (!info.doc)
790
        return;
791 792
    const QTextCharFormat &occurrencesFormat
            = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES);
793 794 795 796 797 798
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
        QList<QTextEdit::ExtraSelection> selections;

        //Macro definition
        if (macro->fileName() == info.doc->fileName()) {
            QTextCursor cursor(document());
799
            cursor.setPosition(macro->utf16CharOffset());
Nikolai Kosjar's avatar
Nikolai Kosjar committed
800
            cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor,
801
                                macro->nameToQString().size());
802 803

            QTextEdit::ExtraSelection sel;
804
            sel.format = occurrencesFormat;
805 806 807 808 809
            sel.cursor = cursor;
            selections.append(sel);
        }

        //Other macro uses
810
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
811 812
            const Macro &useMacro = use.macro();
            if (useMacro.line() != macro->line()
813
                    || useMacro.utf16CharOffset() != macro->utf16CharOffset()
814 815
                    || useMacro.length() != macro->length()
                    || useMacro.fileName() != macro->fileName())
816 817 818
                continue;

            QTextCursor cursor(document());
819 820
            cursor.setPosition(use.utf16charsBegin());
            cursor.setPosition(use.utf16charsEnd(), QTextCursor::KeepAnchor);
821 822

            QTextEdit::ExtraSelection sel;
823
            sel.format = occurrencesFormat;
824 825 826
            sel.cursor = cursor;
            selections.append(sel);
        }
827

828 829 830 831 832
        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
833 834 835 836 837
            if (m_referencesWatcher)
                m_referencesWatcher->cancel();
            m_referencesWatcher.reset(new QFutureWatcher<QList<int> >);
            connect(m_referencesWatcher.data(), SIGNAL(finished()), SLOT(markSymbolsNow()));

838 839
            m_referencesRevision = info.revision;
            m_referencesCursorPosition = position();
Erik Verbruggen's avatar
Erik Verbruggen committed
840 841
            m_referencesWatcher->setFuture(QtConcurrent::run(&lazyFindReferences, scope, expression,
                                                             info.doc, info.snapshot));
842 843 844
        } else {
            const QList<QTextEdit::ExtraSelection> selections = extraSelections(CodeSemanticsSelection);

845
            if (!selections.isEmpty())
846 847
                setExtraSelections(CodeSemanticsSelection, QList<QTextEdit::ExtraSelection>());
        }
848 849 850
    }
}

851
void CPPEditorWidget::renameSymbolUnderCursor()
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
852
{
853 854 855
    if (!m_modelManager)
        return;

856
    CppEditorSupport *edSup = m_modelManager->cppEditorSupport(editor());
857
    updateSemanticInfo(edSup->recalculateSemanticInfo());
mae's avatar
mae committed
858
    abortRename();
859

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
860 861 862 863 864
    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()
865
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
866
            m_currentRenameSelection = i;
mae's avatar
mae committed
867 868 869 870
            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
871
                                                      m_renameSelections[i].cursor.selectionEnd());
872 873
            m_renameSelections[i].format
                    = baseTextDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES_RENAME);;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
874 875 876 877
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
878 879

    if (m_renameSelections.isEmpty())
880
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
881 882
}

883
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
884
{
885
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
886 887
        return;

mae's avatar
mae committed
888 889 890
    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
891 892
        m_renameSelections[m_currentRenameSelection].cursor.setPosition(position,
                                                                        QTextCursor::KeepAnchor);
mae's avatar
mae committed
893 894
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
895 896
    // the condition looks odd, but keep in mind that the begin
    // and end cursors do move automatically
mae's avatar
mae committed
897 898 899 900
    m_inRenameChanged = (position >= m_currentRenameSelectionBegin.position()
                         && position + charsAdded <= m_currentRenameSelectionEnd.position());

    if (!m_inRenameChanged)
901 902 903 904 905 906
        abortRename();

    if (charsRemoved > 0)
        updateUses();
}

907 908 909 910 911 912 913 914
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());
}

915
void CPPEditorWidget::jumpToOutlineElement()
916 917 918 919
{
    QModelIndex modelIndex = m_outlineCombo->view()->currentIndex();
    QModelIndex sourceIndex = m_proxyModel->mapToSource(modelIndex);
    Symbol *symbol = m_outlineModel->symbolFromIndex(sourceIndex);
920
    if (!symbol)
con's avatar
con committed
921 922
        return;

923 924 925
    const Link &link = linkToSymbol(symbol);
    gotoLine(link.targetLine, link.targetColumn);
    Core::EditorManager::activateEditor(editor());
con's avatar
con committed
926 927
}

928
void CPPEditorWidget::setSortedOutline(bool sort)
929
{
Kai Koehne's avatar
Kai Koehne committed
930
    if (sort != sortedOutline()) {
931 932 933 934 935 936 937
        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
938
        updateOutlineIndexNow();
939 940 941
    }
}

942
bool CPPEditorWidget::sortedOutline() const
943 944 945 946
{
    return (m_proxyModel->sortColumn() == 0);
}

947
void CPPEditorWidget::updateOutlineNow()
948
{
949 950 951
    if (!m_modelManager)
        return;

952
    const Snapshot snapshot = m_modelManager->snapshot();
953
    Document::Ptr document = snapshot.document(baseTextDocument()->filePath());
954 955 956 957 958 959 960 961 962

    if (!document)
        return;

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

Kai Koehne's avatar
Kai Koehne committed
963
    m_outlineModel->rebuild(document);
964

Daniel Teske's avatar
Daniel Teske committed
965
    m_outlineCombo->view()->expandAll();
Kai Koehne's avatar
Kai Koehne committed
966
    updateOutlineIndexNow();
967 968
}

969
void CPPEditorWidget::updateOutlineIndex()
con's avatar
con committed
970
{
Kai Koehne's avatar
Kai Koehne committed
971
    m_updateOutlineIndexTimer->start();
Roberto Raggi's avatar
Roberto Raggi committed
972 973
}

974
void CPPEditorWidget::highlightUses(const QList<SemanticInfo::Use> &uses,