cppeditor.cpp 86.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 31 32 33
#include "cppeditor.h"
#include "cppeditorconstants.h"
#include "cppplugin.h"
#include "cpphighlighter.h"
34
#include "cppautocompleter.h"
Leandro Melo's avatar
Leandro Melo committed
35
#include "cppquickfixassistant.h"
Roberto Raggi's avatar
Roberto Raggi committed
36

con's avatar
con committed
37
#include <AST.h>
38
#include <Control.h>
con's avatar
con committed
39 40 41 42 43 44
#include <Token.h>
#include <Scope.h>
#include <Symbols.h>
#include <Names.h>
#include <CoreTypes.h>
#include <Literals.h>
45
#include <ASTVisitor.h>
46
#include <SymbolVisitor.h>
47
#include <TranslationUnit.h>
48
#include <cplusplus/ASTPath.h>
49
#include <cpptools/ModelManagerInterface.h>
con's avatar
con committed
50
#include <cplusplus/ExpressionUnderCursor.h>
Roberto Raggi's avatar
Roberto Raggi committed
51
#include <cplusplus/TypeOfExpression.h>
con's avatar
con committed
52 53 54
#include <cplusplus/Overview.h>
#include <cplusplus/OverviewModel.h>
#include <cplusplus/SimpleLexer.h>
55
#include <cplusplus/MatchingText.h>
56
#include <cplusplus/BackwardsScanner.h>
57 58
#include <cplusplus/FastPreprocessor.h>

Roberto Raggi's avatar
Roberto Raggi committed
59
#include <cpptools/cpptoolsplugin.h>
60
#include <cpptools/cpptoolsconstants.h>
61
#include <cpptools/cppchecksymbols.h>
Christian Kamm's avatar
Christian Kamm committed
62
#include <cpptools/cppcodeformatter.h>
63 64 65
#include <cpptools/cppcompletionsupport.h>
#include <cpptools/cpphighlightingsupport.h>
#include <cpptools/cpplocalsymbols.h>
66 67
#include <cpptools/cppqtstyleindenter.h>
#include <cpptools/cppcodestylesettings.h>
68
#include <cpptools/cpprefactoringchanges.h>
69
#include <cpptools/cpptoolsreuse.h>
70 71
#include <cpptools/doxygengenerator.h>
#include <cpptools/cpptoolssettings.h>
72
#include <cpptools/symbolfinder.h>
con's avatar
con committed
73 74

#include <coreplugin/icore.h>
75
#include <coreplugin/actionmanager/actionmanager.h>
76
#include <coreplugin/actionmanager/actioncontainer.h>
77
#include <coreplugin/actionmanager/command.h>
78
#include <coreplugin/id.h>
con's avatar
con committed
79 80
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/editormanager/editormanager.h>
dt's avatar
dt committed
81
#include <coreplugin/mimedatabase.h>
82
#include <utils/qtcassert.h>
83
#include <extensionsystem/pluginmanager.h>
con's avatar
con committed
84 85
#include <projectexplorer/projectexplorerconstants.h>
#include <texteditor/basetextdocument.h>
86
#include <texteditor/basetextdocumentlayout.h>
con's avatar
con committed
87
#include <texteditor/fontsettings.h>
88
#include <texteditor/tabsettings.h>
con's avatar
con committed
89
#include <texteditor/texteditorconstants.h>
90
#include <texteditor/refactoroverlay.h>
91
#include <texteditor/semantichighlighter.h>
Leandro Melo's avatar
Leandro Melo committed
92 93 94
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/basicproposalitem.h>
#include <texteditor/codeassist/genericproposal.h>
con's avatar
con committed
95

96 97 98
#include <QDebug>
#include <QTime>
#include <QTimer>
99
#include <QPointer>
100 101 102 103 104 105 106 107 108 109 110 111 112 113
#include <QStack>
#include <QSettings>
#include <QSignalMapper>
#include <QAction>
#include <QApplication>
#include <QHeaderView>
#include <QLayout>
#include <QMenu>
#include <QShortcut>
#include <QTextEdit>
#include <QComboBox>
#include <QToolBar>
#include <QTreeView>
#include <QSortFilterProxyModel>
con's avatar
con committed
114

115 116
#include <sstream>

Roberto Raggi's avatar
Roberto Raggi committed
117
enum {
118
    UPDATE_OUTLINE_INTERVAL = 500,
119 120
    UPDATE_USES_INTERVAL = 500,
    UPDATE_FUNCTION_DECL_DEF_LINK_INTERVAL = 200
Roberto Raggi's avatar
Roberto Raggi committed
121 122
};

Roberto Raggi's avatar
Roberto Raggi committed
123
using namespace CPlusPlus;
124
using namespace CppTools;
Roberto Raggi's avatar
Roberto Raggi committed
125 126
using namespace CppEditor::Internal;

127 128 129 130
namespace {
bool semanticHighlighterDisabled = qstrcmp(qVersion(), "4.7.0") == 0;
}

con's avatar
con committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
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();
146 147 148 149
    }

    void adjustWidth()
    {
hjk's avatar
hjk committed
150
        const int w = Core::ICore::mainWindow()->geometry().width();
151 152 153 154 155 156 157 158
        setMaximumWidth(w);
        setMinimumWidth(qMin(qMax(sizeHintForColumn(0), minimumSizeHint().width()), w));
    }
};

class OverviewCombo : public QComboBox
{
public:
159
    OverviewCombo(QWidget *parent = 0) : QComboBox(parent), m_skipNextHide(false)
160 161
    {}

162 163 164 165 166 167 168 169 170 171 172
    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;
    }

173 174 175 176
    void showPopup()
    {
        static_cast<OverviewTreeView *>(view())->adjustWidth();
        QComboBox::showPopup();
con's avatar
con committed
177
    }
178 179 180 181 182 183 184 185 186 187 188

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

private:
    bool m_skipNextHide;
con's avatar
con committed
189 190
};

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
class OverviewProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
public:
    OverviewProxyModel(CPlusPlus::OverviewModel *sourceModel, QObject *parent) :
        QSortFilterProxyModel(parent),
        m_sourceModel(sourceModel)
    {
        setSourceModel(m_sourceModel);
    }

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

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

Roberto Raggi's avatar
Roberto Raggi committed
216 217 218 219
class FunctionDefinitionUnderCursor: protected ASTVisitor
{
    unsigned _line;
    unsigned _column;
220
    DeclarationAST *_functionDefinition;
Roberto Raggi's avatar
Roberto Raggi committed
221 222

public:
Roberto Raggi's avatar
Roberto Raggi committed
223 224
    FunctionDefinitionUnderCursor(TranslationUnit *translationUnit)
        : ASTVisitor(translationUnit),
Roberto Raggi's avatar
Roberto Raggi committed
225
          _line(0), _column(0)
Roberto Raggi's avatar
Roberto Raggi committed
226 227
    { }

228
    DeclarationAST *operator()(AST *ast, unsigned line, unsigned column)
Roberto Raggi's avatar
Roberto Raggi committed
229 230
    {
        _functionDefinition = 0;
Roberto Raggi's avatar
Roberto Raggi committed
231 232
        _line = line;
        _column = column;
Roberto Raggi's avatar
Roberto Raggi committed
233 234 235 236 237 238 239 240 241 242 243
        accept(ast);
        return _functionDefinition;
    }

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

        else if (FunctionDefinitionAST *def = ast->asFunctionDefinition()) {
244 245 246 247 248 249
            return checkDeclaration(def);
        }

        else if (ObjCMethodDeclarationAST *method = ast->asObjCMethodDeclaration()) {
            if (method->function_body)
                return checkDeclaration(method);
Roberto Raggi's avatar
Roberto Raggi committed
250 251 252 253 254
        }

        return true;
    }

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
private:
    bool checkDeclaration(DeclarationAST *ast)
    {
        unsigned startLine, startColumn;
        unsigned endLine, endColumn;
        getTokenStartPosition(ast->firstToken(), &startLine, &startColumn);
        getTokenEndPosition(ast->lastToken() - 1, &endLine, &endColumn);

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

        return true;
    }
Roberto Raggi's avatar
Roberto Raggi committed
272 273
};

274 275
class FindFunctionDefinitions: protected SymbolVisitor
{
Roberto Raggi's avatar
Roberto Raggi committed
276
    const Name *_declarationName;
277 278 279 280 281 282 283 284
    QList<Function *> *_functions;

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

Roberto Raggi's avatar
Roberto Raggi committed
285
    void operator()(const Name *declarationName, Scope *globals,
286 287 288 289 290
                    QList<Function *> *functions)
    {
        _declarationName = declarationName;
        _functions = functions;

Roberto Raggi's avatar
Roberto Raggi committed
291 292
        for (unsigned i = 0; i < globals->memberCount(); ++i) {
            accept(globals->memberAt(i));
293 294 295 296 297 298 299 300
        }
    }

protected:
    using SymbolVisitor::visit;

    virtual bool visit(Function *function)
    {
Roberto Raggi's avatar
Roberto Raggi committed
301 302
        const Name *name = function->name();
        if (const QualifiedNameId *q = name->asQualifiedNameId())
303
            name = q->name();
304 305 306 307 308 309 310 311

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

        return false;
    }
};

312

313
struct CanonicalSymbol
314
{
315
    CPPEditorWidget *editor;
316 317 318
    TypeOfExpression typeOfExpression;
    SemanticInfo info;

319
    CanonicalSymbol(CPPEditorWidget *editor, const SemanticInfo &info)
Erik Verbruggen's avatar
Erik Verbruggen committed
320
        : editor(editor), info(info)
321 322 323 324 325 326 327 328 329
    {
        typeOfExpression.init(info.doc, info.snapshot);
    }

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

330
    static inline bool isIdentifierChar(const QChar &ch)
331 332 333 334
    {
        return ch.isLetterOrNumber() || ch == QLatin1Char('_');
    }

335 336 337 338 339
    Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code)
    {
        return getScopeAndExpression(editor, info, cursor, code);
    }

340
    static Scope *getScopeAndExpression(CPPEditorWidget *editor, const SemanticInfo &info,
341 342
                                        const QTextCursor &cursor,
                                        QString *code)
343 344 345 346 347 348 349 350 351 352 353 354
    {
        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();
355 356 357 358 359 360

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

        while (isIdentifierChar(document->characterAt(pos)))
361 362 363
            ++pos;
        tc.setPosition(pos);

364 365 366 367 368 369 370 371 372 373 374
        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);
375

376 377 378 379 380 381 382 383 384 385
        return 0;
    }

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

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

Roberto Raggi's avatar
Roberto Raggi committed
389 390
        for (int i = results.size() - 1; i != -1; --i) {
            const LookupItem &r = results.at(i);
391
            Symbol *decl = r.declaration();
Roberto Raggi's avatar
Roberto Raggi committed
392

393
            if (! (decl && decl->enclosingScope()))
Roberto Raggi's avatar
Roberto Raggi committed
394 395
                break;

396
            if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
397 398 399 400 401 402 403 404 405 406 407
                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
408 409 410
        }

        for (int i = 0; i < results.size(); ++i) {
411 412 413 414 415 416 417 418
            const LookupItem &r = results.at(i);

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

        return 0;
    }
419

420 421
};

422 423
int numberOfClosedEditors = 0;

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

487
    QString comment = QString(doc->characterAt(pos - 3))
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
            + 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
591 592
} // end of anonymous namespace

593 594
CPPEditor::CPPEditor(CPPEditorWidget *editor)
    : BaseTextEditor(editor)
con's avatar
con committed
595
{
596 597 598
    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
599 600
}

601 602
Q_GLOBAL_STATIC(CppTools::SymbolFinder, symbolFinder)

603 604
CPPEditorWidget::CPPEditorWidget(QWidget *parent)
    : TextEditor::BaseTextEditorWidget(parent)
605
    , m_currentRenameSelection(NoCurrentRenameSelection)
606
    , m_inRename(false)
mae's avatar
mae committed
607 608
    , m_inRenameChanged(false)
    , m_firstRenameChange(false)
609
    , m_objcEnabled(false)
610
    , m_commentsSettings(CppTools::CppToolsSettings::instance()->commentsSettings())
611 612
    , m_completionSupport(0)
    , m_highlightingSupport(0)
con's avatar
con committed
613
{
Roberto Raggi's avatar
Roberto Raggi committed
614
    m_initialized = false;
615
    qRegisterMetaType<SemanticInfo>("CppTools::SemanticInfo");
Roberto Raggi's avatar
Roberto Raggi committed
616 617 618 619

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

con's avatar
con committed
620 621
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
622
    setCodeFoldingSupported(true);
623
    setIndenter(new CppTools::CppQtStyleIndenter);
624
    setAutoCompleter(new CppAutoCompleter);
dt's avatar
dt committed
625

626
    baseTextDocument()->setSyntaxHighlighter(new CppHighlighter);
con's avatar
con committed
627

628
    m_modelManager = CppModelManagerInterface::instance();
con's avatar
con committed
629 630 631
    if (m_modelManager) {
        connect(m_modelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
                this, SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)));
632 633
        m_completionSupport = m_modelManager->completionSupport(editor());
        m_highlightingSupport = m_modelManager->highlightingSupport(editor());
con's avatar
con committed
634
    }
635

636
    m_highlightRevision = 0;
637 638
    connect(&m_highlightWatcher, SIGNAL(resultsReadyAt(int,int)), SLOT(highlightSymbolUsages(int,int)));
    connect(&m_highlightWatcher, SIGNAL(finished()), SLOT(finishHighlightSymbolUsages()));
639 640 641 642

    m_referencesRevision = 0;
    m_referencesCursorPosition = 0;
    connect(&m_referencesWatcher, SIGNAL(finished()), SLOT(markSymbolsNow()));
643 644 645 646 647 648 649

    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>)));
650 651 652 653 654

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

657
CPPEditorWidget::~CPPEditorWidget()
con's avatar
con committed
658
{
Roberto Raggi's avatar
Roberto Raggi committed
659 660
    m_semanticHighlighter->abort();
    m_semanticHighlighter->wait();
661 662 663 664 665 666

    ++numberOfClosedEditors;
    if (numberOfClosedEditors == 5) {
        m_modelManager->GC();
        numberOfClosedEditors = 0;
    }
667 668 669

    delete m_highlightingSupport;
    delete m_completionSupport;
con's avatar
con committed
670 671
}

672
TextEditor::BaseTextEditor *CPPEditorWidget::createEditor()
con's avatar
con committed
673
{
674
    CPPEditor *editable = new CPPEditor(this);
con's avatar
con committed
675 676 677 678
    createToolBar(editable);
    return editable;
}

679
void CPPEditorWidget::createToolBar(CPPEditor *editor)
con's avatar
con committed
680
{
681
    m_outlineCombo = new OverviewCombo;
Kai Koehne's avatar
Kai Koehne committed
682
    m_outlineCombo->setMinimumContentsLength(22);
683 684

    // Make the combo box prefer to expand
Kai Koehne's avatar
Kai Koehne committed
685
    QSizePolicy policy = m_outlineCombo->sizePolicy();
686
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
Kai Koehne's avatar
Kai Koehne committed
687
    m_outlineCombo->setSizePolicy(policy);
688

Kai Koehne's avatar
Kai Koehne committed
689 690
    QTreeView *outlineView = new OverviewTreeView;
    outlineView->header()->hide();
691
    outlineView->setItemsExpandable(true);
Kai Koehne's avatar
Kai Koehne committed
692
    m_outlineCombo->setView(outlineView);
693
    m_outlineCombo->setMaxVisibleItems(40);
694
    outlineView->viewport()->installEventFilter(m_outlineCombo);
con's avatar
con committed
695

Kai Koehne's avatar
Kai Koehne committed
696 697 698
    m_outlineModel = new OverviewModel(this);
    m_proxyModel = new OverviewProxyModel(m_outlineModel, this);
    if (CppPlugin::instance()->sortedOutline())
699 700
        m_proxyModel->sort(0, Qt::AscendingOrder);
    else
Kai Koehne's avatar
Kai Koehne committed
701
        m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
702 703
    m_proxyModel->setDynamicSortFilter(true);
    m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
Kai Koehne's avatar
Kai Koehne committed
704
    m_outlineCombo->setModel(m_proxyModel);
705

Kai Koehne's avatar
Kai Koehne committed
706 707
    m_outlineCombo->setContextMenuPolicy(Qt::ActionsContextMenu);
    m_sortAction = new QAction(tr("Sort Alphabetically"), m_outlineCombo);
708
    m_sortAction->setCheckable(true);
Kai Koehne's avatar
Kai Koehne committed
709 710 711
    m_sortAction->setChecked(sortedOutline());
    connect(m_sortAction, SIGNAL(toggled(bool)), CppPlugin::instance(), SLOT(setSortedOutline(bool)));
    m_outlineCombo->addAction(m_sortAction);
con's avatar
con committed
712

713 714 715 716 717
    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
718 719 720 721
    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
722

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
723 724 725 726 727
    m_updateUsesTimer = new QTimer(this);
    m_updateUsesTimer->setSingleShot(true);
    m_updateUsesTimer->setInterval(UPDATE_USES_INTERVAL);
    connect(m_updateUsesTimer, SIGNAL(timeout()), this, SLOT(updateUsesNow()));

728 729 730 731 732
    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
733 734 735
    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()));
736
    connect(document(), SIGNAL(contentsChange(int,int,int)), this, SLOT(onContentsChanged(int,int,int)));
con's avatar
con committed
737

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

740 741 742
    // 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
743 744 745 746 747

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

748 749
    connect(m_semanticHighlighter, SIGNAL(changed(CppTools::SemanticInfo)),
            this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
Roberto Raggi's avatar
Roberto Raggi committed
750

751
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
con's avatar
con committed
752 753
}

754
void CPPEditorWidget::paste()
mae's avatar
mae committed
755
{
756
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
757
        BaseTextEditorWidget::paste();
mae's avatar
mae committed
758 759 760 761
        return;
    }

    startRename();
762
    BaseTextEditorWidget::paste();
mae's avatar
mae committed
763 764 765
    finishRename();
}

766
void CPPEditorWidget::cut()
mae's avatar
mae committed
767
{
768
    if (m_currentRenameSelection == NoCurrentRenameSelection) {
769
        BaseTextEditorWidget::cut();
mae's avatar
mae committed
770 771 772 773
        return;
    }

    startRename();
774
    BaseTextEditorWidget::cut();
mae's avatar
mae committed
775 776 777
    finishRename();
}

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
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();
}

799
CppModelManagerInterface *CPPEditorWidget::modelManager() const
800 801 802 803
{
    return m_modelManager;
}

804
void CPPEditorWidget::setMimeType(const QString &mt)
805
{
806
    BaseTextEditorWidget::setMimeType(mt);
807
    setObjCEnabled(mt == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE));
808 809
}

810
void CPPEditorWidget::setObjCEnabled(bool onoff)
811 812 813 814
{
    m_objcEnabled = onoff;
}

815
bool CPPEditorWidget::isObjCEnabled() const
816 817
{ return m_objcEnabled; }

818
void CPPEditorWidget::startRename()
mae's avatar
mae committed
819 820 821 822
{
    m_inRenameChanged = false;
}

823
void CPPEditorWidget::finishRename()
mae's avatar
mae committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
{
    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;
}

854
void CPPEditorWidget::abortRename()
855
{
856
    if (m_currentRenameSelection <= NoCurrentRenameSelection)
mae's avatar
mae committed
857
        return;
858
    m_renameSelections[m_currentRenameSelection].format = m_occurrencesFormat;
859
    m_currentRenameSelection = NoCurrentRenameSelection;
mae's avatar
mae committed
860 861
    m_currentRenameSelectionBegin = QTextCursor();
    m_currentRenameSelectionEnd = QTextCursor();
862
    setExtraSelections(CodeSemanticsSelection, m_renameSelections);
863

864
    semanticRehighlight(/* force = */ true);
865 866
}

867
void CPPEditorWidget::onDocumentUpdated(Document::Ptr doc)
con's avatar
con committed
868
{
869
    if (doc->fileName() != editorDocument()->fileName())
con's avatar
con committed
870 871
        return;

872 873 874
    if (doc->editorRevision() != editorRevision())
        return;

875
    if (! m_initialized ||
hjk's avatar
hjk committed
876
            (Core::EditorManager::currentEditor() == editor()
877 878
             && (!m_lastSemanticInfo.doc
                 || !m_lastSemanticInfo.doc->translationUnit()->ast()
879
                 || m_lastSemanticInfo.doc->fileName() != editorDocument()->fileName()))) {
Roberto Raggi's avatar
Roberto Raggi committed
880
        m_initialized = true;
881
        semanticRehighlight(/* force = */ true);
Roberto Raggi's avatar
Roberto Raggi committed
882 883
    }

884
    m_updateOutlineTimer->start();
con's avatar
con committed
885 886
}

887
const Macro *CPPEditorWidget::findCanonicalMacro(const QTextCursor &cursor, Document::Ptr doc) const
Christian Kamm's avatar
Christian Kamm committed
888 889 890 891 892 893 894
{
    if (! doc)
        return 0;

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

895 896 897 898 899 900
    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
901
        return &use->macro();
902
    }
Christian Kamm's avatar
Christian Kamm committed
903 904 905

    return 0;
}
906

907
void CPPEditorWidget::findUsages()
908
{
909
    SemanticInfo info = m_lastSemanticInfo;
910
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
911
    info.snapshot.insert(info.doc);
912

913
    if (const Macro *macro = findCanonicalMacro(textCursor(), info.doc)) {
Christian Kamm's avatar
Christian Kamm committed
914
        m_modelManager->findMacroUsages(*macro);
915 916 917 918 919
    } else {
        CanonicalSymbol cs(this, info);
        Symbol *canonicalSymbol = cs(textCursor());
        if (canonicalSymbol)
            m_modelManager->findUsages(canonicalSymbol, cs.context());
920
    }
921 922
}

923

924
void CPPEditorWidget::renameUsagesNow(const QString &replacement)
925 926
{
    SemanticInfo info = m_lastSemanticInfo;
927
    info.snapshot = CppModelManagerInterface::instance()->snapshot();
928 929
    info.snapshot.insert(info.doc);

930 931 932 933 934 935 936 937
    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);
    }
938 939
}

940
void CPPEditorWidget::renameUsages()
941
{
942 943 944
    renameUsagesNow();
}

945
void CPPEditorWidget::markSymbolsNow()
946
{
947 948 949 950 951 952
    if (m_references.isCanceled())
        return;
    else if (m_referencesCursorPosition != position())
        return;
    else if (m_referencesRevision != editorRevision())
        return;
953

954 955 956
    const SemanticInfo info = m_lastSemanticInfo;
    TranslationUnit *unit = info.doc->translationUnit();
    const QList<int> result = m_references.result();
957 958 959

    QList<QTextEdit::ExtraSelection> selections;

960 961 962
    foreach (int index, result) {
        unsigned line, column;
        unit->getTokenPosition(index, &line, &column);
963

964 965
        if (column)
            --column;  // adjust the column position.
966

967
        const int len = unit->tokenAt(index).f.length;
968

969 970 971
        QTextCursor cursor(document()->findBlockByNumber(line - 1));
        cursor.setPosition(cursor.position() + column);
        cursor.setPosition(cursor.position() + len, QTextCursor::KeepAnchor);
972

973 974 975 976
        QTextEdit::ExtraSelection sel;
        sel.format = m_occurrencesFormat;
        sel.cursor = cursor;
        selections.append(sel);
977

Roberto Raggi's avatar
Roberto Raggi committed
978
    }
979 980

    setExtraSelections(CodeSemanticsSelection, selections);
Roberto Raggi's avatar
Roberto Raggi committed
981 982
}

983
static QList<int> lazyFindReferences(Scope *scope, QString code, Document::Ptr doc, Snapshot snapshot)
984 985
{
    TypeOfExpression typeOfExpression;
986 987
    snapshot.insert(doc);
    typeOfExpression.init(doc, snapshot);
988 989
    // make possible to instantiate templates
    typeOfExpression.setExpandTemplates(true);
990
    if (Symbol *canonicalSymbol = CanonicalSymbol::canonicalSymbol(scope, code, typeOfExpression))
991
        return CppModelManagerInterface::instance()->references(canonicalSymbol, typeOfExpression.context());
992 993 994
    return QList<int>();
}

995
void CPPEditorWidget::markSymbols(const QTextCursor &tc, const SemanticInfo &info)
996 997 998 999 1000 1001
{
    abortRename();

    if (! info.doc)
        return;

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
    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
1018
        foreach (const Document::MacroUse &use, info.doc->macroUses()) {
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
            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);
        }
1034

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
        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>());
        }
1051 1052 1053
    }
}

1054
void CPPEditorWidget::renameSymbolUnderCursor()
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1055
{
Roberto Raggi's avatar
Roberto Raggi committed
1056
    updateSemanticInfo(m_semanticHighlighter->semanticInfo(currentSource()));
mae's avatar
mae committed
1057
    abortRename();
1058

Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1059 1060 1061 1062 1063
    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()
1064
                && c.position() <= s.cursor.position()) {
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1065
            m_currentRenameSelection = i;
mae's avatar
mae committed
1066 1067 1068 1069 1070
            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());
1071
            m_renameSelections[i].format = m_occurrenceRenameFormat;
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1072 1073 1074 1075
            setExtraSelections(CodeSemanticsSelection, m_renameSelections);
            break;
        }
    }
1076 1077

    if (m_renameSelections.isEmpty())
1078
        renameUsages();
Thorbjørn Lindeijer's avatar
Thorbjørn Lindeijer committed
1079 1080
}

1081
void CPPEditorWidget::onContentsChanged(int position, int charsRemoved, int charsAdded)
1082
{
1083 1084
    Q_UNUSED(position)

1085
    if (m_currentRenameSelection == NoCurrentRenameSelection || m_inRename)
1086 1087
        return;

mae's avatar
mae committed
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
    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