basetexteditor.cpp 229 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

30 31
#include "basetexteditor.h"
#include "basetexteditor_p.h"
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "basetextdocument.h"
34
#include "basetextdocumentlayout.h"
35
#include "behaviorsettings.h"
con's avatar
con committed
36
#include "codecselector.h"
37
#include "completionsettings.h"
38
#include "tabsettings.h"
Jarek Kobus's avatar
Jarek Kobus committed
39 40
#include "typingsettings.h"
#include "icodestylepreferences.h"
41
#include "syntaxhighlighter.h"
42
#include "indenter.h"
43
#include "autocompleter.h"
44
#include "snippet.h"
Leandro Melo's avatar
Leandro Melo committed
45 46 47
#include "codeassistant.h"
#include "defaultassistinterface.h"
#include "convenience.h"
48
#include "texteditorsettings.h"
49
#include "texteditoroverlay.h"
50
#include "circularclipboard.h"
51
#include "circularclipboardassist.h"
con's avatar
con committed
52

53
#include <aggregation/aggregate.h>
54
#include <coreplugin/actionmanager/actionmanager.h>
55
#include <coreplugin/actionmanager/actioncontainer.h>
con's avatar
con committed
56
#include <coreplugin/coreconstants.h>
57
#include <coreplugin/editormanager/editormanager.h>
58
#include <coreplugin/infobar.h>
59
#include <coreplugin/manhattanstyle.h>
con's avatar
con committed
60 61
#include <find/basetextfind.h>
#include <utils/linecolumnlabel.h>
62
#include <utils/hostosinfo.h>
hjk's avatar
hjk committed
63
#include <utils/qtcassert.h>
64
#include <utils/stylehelper.h>
65 66
#include <utils/tooltip/tooltip.h>
#include <utils/tooltip/tipcontents.h>
67
#include <utils/uncommentselection.h>
con's avatar
con committed
68

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
#include <QCoreApplication>
#include <QTextCodec>
#include <QDebug>
#include <QTimer>
#include <QTimeLine>
#include <QMimeData>
#include <QAbstractTextDocumentLayout>
#include <QApplication>
#include <QKeyEvent>
#include <QPainter>
#include <QPrinter>
#include <QPrintDialog>
#include <QScrollBar>
#include <QShortcut>
#include <QStyle>
#include <QTextCursor>
#include <QTextDocumentFragment>
#include <QTextBlock>
#include <QTextLayout>
#include <QToolBar>
#include <QMenu>
#include <QMessageBox>
#include <QClipboard>
con's avatar
con committed
92

93 94
//#define DO_FOO

Leandro Melo's avatar
Leandro Melo committed
95 96 97 98 99 100 101 102 103 104 105 106
/*!
    \namespace TextEditor
    \brief The TextEditor namespace contains the base text editor and several classes which
    provide supporting functionality like snippets, highlighting, \l{CodeAssist}{code assist},
    indentation and style, and others.
*/

/*!
    \namespace TextEditor::Internal
    \internal
*/

107
using namespace Utils;
con's avatar
con committed
108 109

namespace TextEditor {
110
namespace Internal {
con's avatar
con committed
111

hjk's avatar
hjk committed
112 113
class TextEditExtraArea : public QWidget
{
con's avatar
con committed
114
public:
hjk's avatar
hjk committed
115 116 117
    TextEditExtraArea(BaseTextEditorWidget *edit)
        : QWidget(edit)
    {
con's avatar
con committed
118 119 120 121
        textEdit = edit;
        setAutoFillBackground(true);
    }

hjk's avatar
hjk committed
122
protected:
con's avatar
con committed
123 124 125
    QSize sizeHint() const {
        return QSize(textEdit->extraAreaWidth(), 0);
    }
hjk's avatar
hjk committed
126
    void paintEvent(QPaintEvent *event) {
con's avatar
con committed
127 128
        textEdit->extraAreaPaintEvent(event);
    }
hjk's avatar
hjk committed
129
    void mousePressEvent(QMouseEvent *event) {
con's avatar
con committed
130 131
        textEdit->extraAreaMouseEvent(event);
    }
hjk's avatar
hjk committed
132
    void mouseMoveEvent(QMouseEvent *event) {
con's avatar
con committed
133 134
        textEdit->extraAreaMouseEvent(event);
    }
hjk's avatar
hjk committed
135
    void mouseReleaseEvent(QMouseEvent *event) {
con's avatar
con committed
136 137
        textEdit->extraAreaMouseEvent(event);
    }
hjk's avatar
hjk committed
138
    void leaveEvent(QEvent *event) {
con's avatar
con committed
139 140
        textEdit->extraAreaLeaveEvent(event);
    }
141 142 143
    void contextMenuEvent(QContextMenuEvent *event) {
        textEdit->extraAreaContextMenuEvent(event);
    }
con's avatar
con committed
144 145 146 147

    void wheelEvent(QWheelEvent *event) {
        QCoreApplication::sendEvent(textEdit->viewport(), event);
    }
hjk's avatar
hjk committed
148 149 150

private:
    BaseTextEditorWidget *textEdit;
con's avatar
con committed
151 152
};

153
} // namespace Internal
hjk's avatar
hjk committed
154 155

using namespace Internal;
con's avatar
con committed
156

157
QString BaseTextEditorWidget::plainTextFromSelection(const QTextCursor &cursor) const
158
{
159 160 161 162 163 164 165 166 167 168
    // Copy the selected text as plain text
    QString text = cursor.selectedText();
    return convertToPlainText(text);
}

QString BaseTextEditorWidget::convertToPlainText(const QString &txt)
{
    QString ret = txt;
    QChar *uc = ret.data();
    QChar *e = uc + ret.size();
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184

    for (; uc != e; ++uc) {
        switch (uc->unicode()) {
        case 0xfdd0: // QTextBeginningOfFrame
        case 0xfdd1: // QTextEndOfFrame
        case QChar::ParagraphSeparator:
        case QChar::LineSeparator:
            *uc = QLatin1Char('\n');
            break;
        case QChar::Nbsp:
            *uc = QLatin1Char(' ');
            break;
        default:
            ;
        }
    }
185
    return ret;
186 187
}

Orgad Shaneh's avatar
Orgad Shaneh committed
188 189
static const char kTextBlockMimeType[] = "application/vnd.qtcreator.blocktext";
static const char kVerticalTextBlockMimeType[] = "application/vnd.qtcreator.vblocktext";
190 191


192
BaseTextEditorWidget::BaseTextEditorWidget(QWidget *parent)
con's avatar
con committed
193 194
    : QPlainTextEdit(parent)
{
195
    d = new BaseTextEditorWidgetPrivate;
con's avatar
con committed
196 197 198 199 200
    d->q = this;
    d->m_extraArea = new TextEditExtraArea(this);
    d->m_extraArea->setMouseTracking(true);
    setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);

201
    d->m_overlay = new TextEditorOverlay(this);
202
    d->m_snippetOverlay = new TextEditorOverlay(this);
203
    d->m_searchResultOverlay = new TextEditorOverlay(this);
204
    d->m_refactorOverlay = new RefactorOverlay(this);
205

con's avatar
con committed
206 207 208 209 210 211 212 213 214 215
    d->setupDocumentSignals(d->m_document);

    d->m_lastScrollPos = -1;

    // from RESEARCH

    setLayoutDirection(Qt::LeftToRight);
    viewport()->setMouseTracking(true);
    d->extraAreaSelectionAnchorBlockNumber
        = d->extraAreaToggleMarkBlockNumber
mae's avatar
mae committed
216
        = d->extraAreaHighlightFoldedBlockNumber
con's avatar
con committed
217 218
        = -1;

mae's avatar
mae committed
219
    d->visibleFoldedBlockNumber = d->suggestedVisibleFoldedBlockNumber = -1;
con's avatar
con committed
220

221 222
    connect(d->m_codeAssistant.data(), SIGNAL(finished()), this, SIGNAL(assistFinished()));

con's avatar
con committed
223 224 225
    connect(this, SIGNAL(blockCountChanged(int)), this, SLOT(slotUpdateExtraAreaWidth()));
    connect(this, SIGNAL(modificationChanged(bool)), this, SLOT(slotModificationChanged(bool)));
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(slotCursorPositionChanged()));
Robert Loehning's avatar
Robert Loehning committed
226
    connect(this, SIGNAL(updateRequest(QRect,int)), this, SLOT(slotUpdateRequest(QRect,int)));
con's avatar
con committed
227 228 229 230 231 232
    connect(this, SIGNAL(selectionChanged()), this, SLOT(slotSelectionChanged()));

//     (void) new QShortcut(tr("CTRL+L"), this, SLOT(centerCursor()), 0, Qt::WidgetShortcut);
//     (void) new QShortcut(tr("F9"), this, SLOT(slotToggleMark()), 0, Qt::WidgetShortcut);
//     (void) new QShortcut(tr("F11"), this, SLOT(slotToggleBlockVisible()));

233 234 235 236
#ifdef DO_FOO
    (void) new QShortcut(tr("CTRL+D"), this, SLOT(doFoo()));
#endif

con's avatar
con committed
237 238 239 240

    // parentheses matcher
    d->m_formatRange = true;
    d->m_matchFormat.setForeground(Qt::red);
241
    d->m_matchFormat.setBackground(QColor(0xb4, 0xee, 0xb4));
242 243
    d->m_mismatchFormat.setBackground(palette().color(QPalette::Base).value() < 128
                                      ? Qt::darkMagenta : Qt::magenta);
244 245
    d->m_parenthesesMatchingTimer.setSingleShot(true);
    connect(&d->m_parenthesesMatchingTimer, SIGNAL(timeout()), this, SLOT(_q_matchParentheses()));
con's avatar
con committed
246

247 248
    d->m_highlightBlocksTimer.setSingleShot(true);
    connect(&d->m_highlightBlocksTimer, SIGNAL(timeout()), this, SLOT(_q_highlightBlocks()));
249

250
    d->m_animator = 0;
con's avatar
con committed
251 252 253 254

    d->m_searchResultFormat.setBackground(QColor(0xffef0b));

    slotUpdateExtraAreaWidth();
con's avatar
con committed
255
    updateHighlights();
con's avatar
con committed
256 257
    setFrameStyle(QFrame::NoFrame);

258 259
    d->m_delayedUpdateTimer.setSingleShot(true);
    connect(&d->m_delayedUpdateTimer, SIGNAL(timeout()), viewport(), SLOT(update()));
260

mae's avatar
mae committed
261
    d->m_moveLineUndoHack = false;
con's avatar
con committed
262 263
}

264
BaseTextEditorWidget::~BaseTextEditorWidget()
con's avatar
con committed
265 266 267 268 269
{
    delete d;
    d = 0;
}

270
QString BaseTextEditorWidget::mimeType() const
con's avatar
con committed
271 272 273 274
{
    return d->m_document->mimeType();
}

275
void BaseTextEditorWidget::setMimeType(const QString &mt)
con's avatar
con committed
276 277 278 279
{
    d->m_document->setMimeType(mt);
}

280
void BaseTextEditorWidget::print(QPrinter *printer)
con's avatar
con committed
281
{
hjk's avatar
hjk committed
282
    const bool oldFullPage = printer->fullPage();
con's avatar
con committed
283 284 285
    printer->setFullPage(true);
    QPrintDialog *dlg = new QPrintDialog(printer, this);
    dlg->setWindowTitle(tr("Print Document"));
286
    if (dlg->exec() == QDialog::Accepted)
con's avatar
con committed
287 288 289 290 291
        d->print(printer);
    printer->setFullPage(oldFullPage);
    delete dlg;
}

mae's avatar
mae committed
292
static int foldBoxWidth(const QFontMetrics &fm)
293 294
{
    const int lineSpacing = fm.lineSpacing();
hjk's avatar
hjk committed
295
    return lineSpacing + lineSpacing % 2 + 1;
296 297
}

con's avatar
con committed
298 299 300 301 302 303 304 305 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
static void printPage(int index, QPainter *painter, const QTextDocument *doc,
                      const QRectF &body, const QRectF &titleBox,
                      const QString &title)
{
    painter->save();

    painter->translate(body.left(), body.top() - (index - 1) * body.height());
    QRectF view(0, (index - 1) * body.height(), body.width(), body.height());

    QAbstractTextDocumentLayout *layout = doc->documentLayout();
    QAbstractTextDocumentLayout::PaintContext ctx;

    painter->setFont(QFont(doc->defaultFont()));
    QRectF box = titleBox.translated(0, view.top());
    int dpix = painter->device()->logicalDpiX();
    int dpiy = painter->device()->logicalDpiY();
    int mx = 5 * dpix / 72.0;
    int my = 2 * dpiy / 72.0;
    painter->fillRect(box.adjusted(-mx, -my, mx, my), QColor(210, 210, 210));
    if (!title.isEmpty())
        painter->drawText(box, Qt::AlignCenter, title);
    const QString pageString = QString::number(index);
    painter->drawText(box, Qt::AlignRight, pageString);

    painter->setClipRect(view);
    ctx.clip = view;
    // don't use the system palette text as default text color, on HP/UX
    // for example that's white, and white text on white paper doesn't
    // look that nice
    ctx.palette.setColor(QPalette::Text, Qt::black);

    layout->draw(painter, ctx);

    painter->restore();
}

334
void BaseTextEditorWidgetPrivate::print(QPrinter *printer)
con's avatar
con committed
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
{
    QTextDocument *doc = q->document();

    QString title = q->displayName();
    if (title.isEmpty())
        printer->setDocName(title);


    QPainter p(printer);

    // Check that there is a valid device to print to.
    if (!p.isActive())
        return;

    doc = doc->clone(doc);

    QTextOption opt = doc->defaultTextOption();
    opt.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
    doc->setDefaultTextOption(opt);

    (void)doc->documentLayout(); // make sure that there is a layout


    QColor background = q->palette().color(QPalette::Base);
    bool backgroundIsDark = background.value() < 128;

    for (QTextBlock srcBlock = q->document()->firstBlock(), dstBlock = doc->firstBlock();
         srcBlock.isValid() && dstBlock.isValid();
         srcBlock = srcBlock.next(), dstBlock = dstBlock.next()) {


        QList<QTextLayout::FormatRange> formatList = srcBlock.layout()->additionalFormats();
        if (backgroundIsDark) {
            // adjust syntax highlighting colors for better contrast
hjk's avatar
hjk committed
369
            for (int i = formatList.count() - 1; i >= 0; --i) {
con's avatar
con committed
370 371 372 373 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
                QTextCharFormat &format = formatList[i].format;
                if (format.background().color() == background) {
                    QBrush brush = format.foreground();
                    QColor color = brush.color();
                    int h,s,v,a;
                    color.getHsv(&h, &s, &v, &a);
                    color.setHsv(h, s, qMin(128, v), a);
                    brush.setColor(color);
                    format.setForeground(brush);
                }
                format.setBackground(Qt::white);
            }
        }

        dstBlock.layout()->setAdditionalFormats(formatList);
    }

    QAbstractTextDocumentLayout *layout = doc->documentLayout();
    layout->setPaintDevice(p.device());

    int dpiy = p.device()->logicalDpiY();
    int margin = (int) ((2/2.54)*dpiy); // 2 cm margins

    QTextFrameFormat fmt = doc->rootFrame()->frameFormat();
    fmt.setMargin(margin);
    doc->rootFrame()->setFrameFormat(fmt);

    QRectF pageRect(printer->pageRect());
    QRectF body = QRectF(0, 0, pageRect.width(), pageRect.height());
    QFontMetrics fontMetrics(doc->defaultFont(), p.device());

    QRectF titleBox(margin,
                    body.top() + margin
                    - fontMetrics.height()
                    - 6 * dpiy / 72.0,
                    body.width() - 2*margin,
                    fontMetrics.height());
    doc->setPageSize(body.size());

    int docCopies;
    int pageCopies;
hjk's avatar
hjk committed
411
    if (printer->collateCopies() == true) {
con's avatar
con committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
        docCopies = 1;
        pageCopies = printer->numCopies();
    } else {
        docCopies = printer->numCopies();
        pageCopies = 1;
    }

    int fromPage = printer->fromPage();
    int toPage = printer->toPage();
    bool ascending = true;

    if (fromPage == 0 && toPage == 0) {
        fromPage = 1;
        toPage = doc->pageCount();
    }
    // paranoia check
    fromPage = qMax(1, fromPage);
    toPage = qMin(doc->pageCount(), toPage);

    if (printer->pageOrder() == QPrinter::LastPageFirst) {
        int tmp = fromPage;
        fromPage = toPage;
        toPage = tmp;
        ascending = false;
    }

    for (int i = 0; i < docCopies; ++i) {

        int page = fromPage;
        while (true) {
            for (int j = 0; j < pageCopies; ++j) {
                if (printer->printerState() == QPrinter::Aborted
                    || printer->printerState() == QPrinter::Error)
                    goto UserCanceled;
                printPage(page, &p, doc, body, titleBox, title);
                if (j < pageCopies - 1)
                    printer->newPage();
            }

            if (page == toPage)
                break;

            if (ascending)
                ++page;
            else
                --page;

            printer->newPage();
        }

        if ( i < docCopies - 1)
            printer->newPage();
    }

UserCanceled:
    delete doc;
}


471
int BaseTextEditorWidgetPrivate::visualIndent(const QTextBlock &block) const
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
{
    if (!block.isValid())
        return 0;
    const QTextDocument *document = block.document();
    int i = 0;
    while (i < block.length()) {
        if (!document->characterAt(block.position() + i).isSpace()) {
            QTextCursor cursor(block);
            cursor.setPosition(block.position() + i);
            return q->cursorRect(cursor).x();
        }
        ++i;
    }

    return 0;
}
con's avatar
con committed
488

489
ITextMarkable *BaseTextEditorWidget::markableInterface() const
con's avatar
con committed
490 491 492 493
{
    return baseTextDocument()->documentMarker();
}

494
BaseTextEditor *BaseTextEditorWidget::editor() const
con's avatar
con committed
495
{
496
    if (!d->m_editor) {
Leandro Melo's avatar
Leandro Melo committed
497 498
        d->m_editor = const_cast<BaseTextEditorWidget *>(this)->createEditor();
        d->m_codeAssistant->configure(d->m_editor);
con's avatar
con committed
499
        connect(this, SIGNAL(textChanged()),
500
                d->m_editor, SIGNAL(contentsChanged()));
con's avatar
con committed
501
        connect(this, SIGNAL(changed()),
502
                d->m_editor, SIGNAL(changed()));
con's avatar
con committed
503
    }
504
    return d->m_editor;
con's avatar
con committed
505 506 507
}


508
void BaseTextEditorWidget::selectEncoding()
con's avatar
con committed
509
{
510
    BaseTextDocument *doc = d->m_document.data();
con's avatar
con committed
511 512 513
    CodecSelector codecSelector(this, doc);

    switch (codecSelector.exec()) {
514 515 516 517 518 519 520
    case CodecSelector::Reload: {
        QString errorString;
        if (!doc->reload(&errorString, codecSelector.selectedCodec())) {
            QMessageBox::critical(this, tr("File Error"), errorString);
            break;
        }
        break; }
con's avatar
con committed
521 522
    case CodecSelector::Save:
        doc->setCodec(codecSelector.selectedCodec());
523
        Core::EditorManager::instance()->saveEditor(editor());
524
        updateTextCodecLabel();
con's avatar
con committed
525 526 527 528 529 530
        break;
    case CodecSelector::Cancel:
        break;
    }
}

531 532 533 534 535
void BaseTextEditorWidget::updateTextCodecLabel()
{
    editor()->setFileEncodingLabelText(QString::fromLatin1(d->m_document->codec()->name()));
}

536
QString BaseTextEditorWidget::msgTextTooLarge(quint64 size)
537 538 539 540 541
{
    return tr("The text is too large to be displayed (%1 MB).").
           arg(size >> 20);
}

542
bool BaseTextEditorWidget::createNew(const QString &contents)
con's avatar
con committed
543
{
544 545 546 547 548
    if (contents.size() > Core::EditorManager::maxTextFileSize()) {
        setPlainText(msgTextTooLarge(contents.size()));
        document()->setModified(false);
        return false;
    }
con's avatar
con committed
549 550 551 552 553
    setPlainText(contents);
    document()->setModified(false);
    return true;
}

554 555 556 557
void BaseTextEditorWidget::updateCannotDecodeInfo()
{
    setReadOnly(d->m_document->hasDecodingError());
    if (d->m_document->hasDecodingError()) {
Orgad Shaneh's avatar
Orgad Shaneh committed
558
        Core::InfoBarEntry info(Core::Id(Constants::SELECT_ENCODING),
559 560 561 562 563
            tr("<b>Error:</b> Could not decode \"%1\" with \"%2\"-encoding. Editing not possible.")
            .arg(displayName()).arg(QString::fromLatin1(d->m_document->codec()->name())));
        info.setCustomButtonInfo(tr("Select Encoding"), this, SLOT(selectEncoding()));
        d->m_document->infoBar()->addInfo(info);
    } else {
Orgad Shaneh's avatar
Orgad Shaneh committed
564
        d->m_document->infoBar()->removeInfo(Core::Id(Constants::SELECT_ENCODING));
565 566 567
    }
}

568
bool BaseTextEditorWidget::open(QString *errorString, const QString &fileName, const QString &realFileName)
con's avatar
con committed
569
{
570
    if (d->m_document->open(errorString, fileName, realFileName)) {
con's avatar
con committed
571
        moveCursor(QTextCursor::Start);
572
        updateCannotDecodeInfo();
573 574 575 576 577 578 579
        if (editor()->m_fileEncodingLabel) {
            connect(editor()->m_fileEncodingLabel, SIGNAL(clicked()), this,
                    SLOT(selectEncoding()), Qt::UniqueConnection);
            connect(d->m_document->document(), SIGNAL(modificationChanged(bool)), this,
                    SLOT(updateTextCodecLabel()), Qt::UniqueConnection);
            updateTextCodecLabel();
        }
con's avatar
con committed
580 581 582 583 584
        return true;
    }
    return false;
}

585 586 587
/*
  Collapses the first comment in a file, if there is only whitespace above
  */
588
void BaseTextEditorWidgetPrivate::foldLicenseHeader()
589 590
{
    QTextDocument *doc = q->document();
591
    BaseTextDocumentLayout *documentLayout = qobject_cast<BaseTextDocumentLayout*>(doc->documentLayout());
592 593 594
    QTC_ASSERT(documentLayout, return);
    QTextBlock block = doc->firstBlock();
    const TabSettings &ts = m_document->tabSettings();
595
    while (block.isValid() && block.isVisible()) {
596
        QString text = block.text();
mae's avatar
mae committed
597 598 599 600 601 602 603 604 605
        if (BaseTextDocumentLayout::canFold(block) && block.next().isVisible()) {
            if (text.trimmed().startsWith(QLatin1String("/*"))) {
                BaseTextDocumentLayout::doFoldOrUnfold(block, false);
                moveCursorVisible();
                documentLayout->requestUpdate();
                documentLayout->emitDocumentSizeChanged();
                break;
            }
        }
606 607 608 609 610 611
        if (ts.firstNonSpace(text) < text.size())
            break;
        block = block.next();
    }
}

612
const Utils::ChangeSet &BaseTextEditorWidget::changeSet() const
613 614 615 616
{
    return d->m_changeSet;
}

617
void BaseTextEditorWidget::setChangeSet(const Utils::ChangeSet &changeSet)
618 619
{
    d->m_changeSet = changeSet;
Roberto Raggi's avatar
Roberto Raggi committed
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

    foreach (const ChangeSet::EditOp &op, changeSet.operationList()) {
        // ### TODO: process the edit operation

        switch (op.type) {
        case ChangeSet::EditOp::Replace:
            break;

        case ChangeSet::EditOp::Move:
            break;

        case ChangeSet::EditOp::Insert:
            break;

        case ChangeSet::EditOp::Remove:
            break;

        case ChangeSet::EditOp::Flip:
            break;

        case ChangeSet::EditOp::Copy:
            break;

        default:
            break;
        } // switch
    }
647 648
}

649
Core::IDocument *BaseTextEditorWidget::editorDocument() const
con's avatar
con committed
650
{
651
    return d->m_document.data();
con's avatar
con committed
652 653
}

654
void BaseTextEditorWidget::editorContentsChange(int position, int charsRemoved, int charsAdded)
con's avatar
con committed
655
{
656 657 658
    if (d->m_animator)
        d->m_animator->finish();

con's avatar
con committed
659
    d->m_contentsChanged = true;
660
    QTextDocument *doc = document();
661
    BaseTextDocumentLayout *documentLayout = static_cast<BaseTextDocumentLayout*>(doc->documentLayout());
con's avatar
con committed
662 663 664

    // Keep the line numbers and the block information for the text marks updated
    if (charsRemoved != 0) {
665 666
        documentLayout->updateMarksLineNumber();
        documentLayout->updateMarksBlock(document()->findBlock(position));
con's avatar
con committed
667
    } else {
668 669
        const QTextBlock posBlock = doc->findBlock(position);
        const QTextBlock nextBlock = doc->findBlock(position + charsAdded);
con's avatar
con committed
670
        if (posBlock != nextBlock) {
671 672 673
            documentLayout->updateMarksLineNumber();
            documentLayout->updateMarksBlock(posBlock);
            documentLayout->updateMarksBlock(nextBlock);
con's avatar
con committed
674
        } else {
675
            documentLayout->updateMarksBlock(posBlock);
con's avatar
con committed
676 677
        }
    }
678

679 680 681
    if (d->m_snippetOverlay->isVisible()) {
        QTextCursor cursor = textCursor();
        cursor.setPosition(position);
682
        d->snippetCheckCursor(cursor);
683 684
    }

685
    if (doc->isRedoAvailable())
686
        emit editor()->contentsChangedBecauseOfUndo();
Leandro Melo's avatar
Leandro Melo committed
687

688
    if (charsAdded != 0 && document()->characterAt(position + charsAdded - 1).isPrint())
Leandro Melo's avatar
Leandro Melo committed
689
        d->m_assistRelevantContentAdded = true;
con's avatar
con committed
690 691
}

692
void BaseTextEditorWidget::slotSelectionChanged()
con's avatar
con committed
693
{
mae's avatar
mae committed
694 695 696
    if (d->m_inBlockSelectionMode && !textCursor().hasSelection()) {
        d->m_inBlockSelectionMode = false;
        d->m_blockSelection.clear();
con's avatar
con committed
697
        viewport()->update();
mae's avatar
mae committed
698 699
    }

700 701
    if (!d->m_selectBlockAnchor.isNull() && !textCursor().hasSelection())
        d->m_selectBlockAnchor = QTextCursor();
702 703 704

    // Clear any link which might be showing when the selection changes
    clearLink();
con's avatar
con committed
705 706
}

707
void BaseTextEditorWidget::gotoBlockStart()
708 709
{
    QTextCursor cursor = textCursor();
710
    if (TextBlockUserData::findPreviousOpenParenthesis(&cursor, false)) {
711
        setTextCursor(cursor);
712 713
        _q_matchParentheses();
    }
714 715
}

716
void BaseTextEditorWidget::gotoBlockEnd()
717 718
{
    QTextCursor cursor = textCursor();
719
    if (TextBlockUserData::findNextClosingParenthesis(&cursor, false)) {
720
        setTextCursor(cursor);
721 722
        _q_matchParentheses();
    }
723 724
}

725
void BaseTextEditorWidget::gotoBlockStartWithSelection()
726 727
{
    QTextCursor cursor = textCursor();
728
    if (TextBlockUserData::findPreviousOpenParenthesis(&cursor, true)) {
729
        setTextCursor(cursor);
730 731
        _q_matchParentheses();
    }
732 733
}

734
void BaseTextEditorWidget::gotoBlockEndWithSelection()
735 736
{
    QTextCursor cursor = textCursor();
737
    if (TextBlockUserData::findNextClosingParenthesis(&cursor, true)) {
738
        setTextCursor(cursor);
739 740 741 742
        _q_matchParentheses();
    }
}

mae's avatar
mae committed
743

744
void BaseTextEditorWidget::gotoLineStart()
mae's avatar
mae committed
745 746 747 748
{
    handleHomeKey(false);
}

749
void BaseTextEditorWidget::gotoLineStartWithSelection()
mae's avatar
mae committed
750 751 752 753
{
    handleHomeKey(true);
}

754
void BaseTextEditorWidget::gotoLineEnd()
mae's avatar
mae committed
755 756 757 758
{
    moveCursor(QTextCursor::EndOfLine);
}

759
void BaseTextEditorWidget::gotoLineEndWithSelection()
mae's avatar
mae committed
760 761 762 763
{
    moveCursor(QTextCursor::EndOfLine, QTextCursor::KeepAnchor);
}

764
void BaseTextEditorWidget::gotoNextLine()
mae's avatar
mae committed
765
{
766
    moveCursor(QTextCursor::Down);
mae's avatar
mae committed
767 768
}

769
void BaseTextEditorWidget::gotoNextLineWithSelection()
mae's avatar
mae committed
770
{
771
    moveCursor(QTextCursor::Down, QTextCursor::KeepAnchor);
mae's avatar
mae committed
772 773
}

774
void BaseTextEditorWidget::gotoPreviousLine()
mae's avatar
mae committed
775
{
776
    moveCursor(QTextCursor::Up);
mae's avatar
mae committed
777 778
}

779
void BaseTextEditorWidget::gotoPreviousLineWithSelection()
mae's avatar
mae committed
780
{
781
    moveCursor(QTextCursor::Up, QTextCursor::KeepAnchor);
mae's avatar
mae committed
782 783
}

784
void BaseTextEditorWidget::gotoPreviousCharacter()
mae's avatar
mae committed
785 786 787 788
{
    moveCursor(QTextCursor::PreviousCharacter);
}

789
void BaseTextEditorWidget::gotoPreviousCharacterWithSelection()
mae's avatar
mae committed
790 791 792 793
{
    moveCursor(QTextCursor::PreviousCharacter, QTextCursor::KeepAnchor);
}

794
void BaseTextEditorWidget::gotoNextCharacter()
mae's avatar
mae committed
795 796 797 798
{
    moveCursor(QTextCursor::NextCharacter);
}

799
void BaseTextEditorWidget::gotoNextCharacterWithSelection()
mae's avatar
mae committed
800 801 802 803
{
    moveCursor(QTextCursor::NextCharacter, QTextCursor::KeepAnchor);
}

804
void BaseTextEditorWidget::gotoPreviousWord()
mae's avatar
mae committed
805 806
{
    moveCursor(QTextCursor::PreviousWord);
807
    setTextCursor(textCursor());
mae's avatar
mae committed
808 809
}

810
void BaseTextEditorWidget::gotoPreviousWordWithSelection()
mae's avatar
mae committed
811 812
{
    moveCursor(QTextCursor::PreviousWord, QTextCursor::KeepAnchor);
813
    setTextCursor(textCursor());
mae's avatar
mae committed
814 815
}

816
void BaseTextEditorWidget::gotoNextWord()
mae's avatar
mae committed
817 818
{
    moveCursor(QTextCursor::NextWord);
819
    setTextCursor(textCursor());
mae's avatar
mae committed
820 821
}

822
void BaseTextEditorWidget::gotoNextWordWithSelection()
mae's avatar
mae committed
823 824
{
    moveCursor(QTextCursor::NextWord, QTextCursor::KeepAnchor);
825
    setTextCursor(textCursor());
mae's avatar
mae committed
826 827
}

828
void BaseTextEditorWidget::gotoPreviousWordCamelCase()
mae's avatar
mae committed
829 830 831 832 833 834
{
    QTextCursor c = textCursor();
    camelCaseLeft(c, QTextCursor::MoveAnchor);
    setTextCursor(c);
}

835
void BaseTextEditorWidget::gotoPreviousWordCamelCaseWithSelection()
mae's avatar
mae committed
836 837 838 839 840 841
{
    QTextCursor c = textCursor();
    camelCaseLeft(c, QTextCursor::KeepAnchor);
    setTextCursor(c);
}

842
void BaseTextEditorWidget::gotoNextWordCamelCase()
mae's avatar
mae committed
843 844 845 846 847 848
{
    QTextCursor c = textCursor();
    camelCaseRight(c, QTextCursor::MoveAnchor);
    setTextCursor(c);
}

849
void BaseTextEditorWidget::gotoNextWordCamelCaseWithSelection()
mae's avatar
mae committed
850 851 852 853 854 855
{
    QTextCursor c = textCursor();
    camelCaseRight(c, QTextCursor::KeepAnchor);
    setTextCursor(c);
}

856 857
static QTextCursor flippedCursor(const QTextCursor &cursor)
{
858 859 860 861
    QTextCursor flipped = cursor;
    flipped.clearSelection();
    flipped.setPosition(cursor.anchor(), QTextCursor::KeepAnchor);
    return flipped;
862 863
}

864
bool BaseTextEditorWidget::selectBlockUp()
865 866 867 868 869 870 871 872
{
    QTextCursor cursor = textCursor();
    if (!cursor.hasSelection())
        d->m_selectBlockAnchor = cursor;
    else
        cursor.setPosition(cursor.selectionStart());

    if (!TextBlockUserData::findPreviousOpenParenthesis(&cursor, false))
873
        return false;
874
    if (!TextBlockUserData::findNextClosingParenthesis(&cursor, true))
875 876
        return false;

877 878
    setTextCursor(flippedCursor(cursor));
    _q_matchParentheses();
879
    return true;
880 881
}

882
bool BaseTextEditorWidget::selectBlockDown()
883 884 885 886 887
{
    QTextCursor tc = textCursor();
    QTextCursor cursor = d->m_selectBlockAnchor;

    if (!tc.hasSelection() || cursor.isNull())
888
        return false;
889 890 891 892 893 894 895 896 897 898 899 900 901
    tc.setPosition(tc.selectionStart());

    forever {
        QTextCursor ahead = cursor;
        if (!TextBlockUserData::findPreviousOpenParenthesis(&ahead, false))
            break;
        if (ahead.position() <= tc.position())
            break;
        cursor = ahead;
    }
    if ( cursor != d->m_selectBlockAnchor)
        TextBlockUserData::findNextClosingParenthesis(&cursor, true);

902 903
    setTextCursor(flippedCursor(cursor));
    _q_matchParentheses();
904
    return true;
905 906
}

907
void BaseTextEditorWidget::copyLineUp()
908 909 910 911
{
    copyLineUpDown(true);
}

912
void BaseTextEditorWidget::copyLineDown()
913 914 915 916
{
    copyLineUpDown(false);
}

917
// @todo: Potential reuse of some code around the following functions...
918
void BaseTextEditorWidget::copyLineUpDown(bool up)
919 920 921 922 923 924 925 926 927 928 929
{
    QTextCursor cursor = textCursor();
    QTextCursor move = cursor;
    move.beginEditBlock();

    bool hasSelection = cursor.hasSelection();

    if (hasSelection) {
        move.setPosition(cursor.selectionStart());
        move.movePosition(QTextCursor::StartOfBlock);
        move.setPosition(cursor.selectionEnd(), QTextCursor::KeepAnchor);
930 931
        move.movePosition(move.atBlockStart() ? QTextCursor::Left: QTextCursor::EndOfBlock,
                          QTextCursor::KeepAnchor);
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
    } else {
        move.movePosition(QTextCursor::StartOfBlock);
        move.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);
    }

    QString text = move.selectedText();

    if (up) {
        move.setPosition(cursor.selectionStart());
        move.movePosition(QTextCursor::StartOfBlock);
        move.insertBlock();
        move.movePosition(QTextCursor::Left);
    } else {
        move.movePosition(QTextCursor::EndOfBlock);
        if (move.atBlockStart()) {
            move.movePosition(QTextCursor::NextBlock);
            move.insertBlock();
            move.movePosition(QTextCursor::Left);
        } else {
            move.insertBlock();
        }
    }

    int start = move.position();
    move.clearSelection();
    move.insertText(text);
    int end = move.position();

    move.setPosition(start);
    move.setPosition(end, QTextCursor::KeepAnchor);

    indent(document(), move, QChar::Null);
    move.endEditBlock();

    setTextCursor(move);
}

969
void BaseTextEditorWidget::joinLines()
970
{
971 972 973
    QTextCursor cursor = textCursor();
    QTextCursor start = cursor;
    QTextCursor end = cursor;
974

975 976
    start.setPosition(cursor.selectionStart());
    end.setPosition(cursor.selectionEnd() - 1);
977

978
    int lineCount = qMax(1, end.blockNumber() - start.blockNumber());
979

980 981 982 983 984 985 986
    cursor.beginEditBlock();
    cursor.setPosition(cursor.selectionStart());
    while (lineCount--) {
        cursor.movePosition(QTextCursor::NextBlock);
        cursor.movePosition(QTextCursor::StartOfBlock);
        cursor.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);
        QString cutLine = cursor.selectedText();
987

988
        // Collapse leading whitespaces to one or insert whitespace
989
        cutLine.replace(QRegExp(QLatin1String("^\\s*")), QLatin1String(" "));
990 991 992 993 994 995 996 997 998 999 1000
        cursor.movePosition(QTextCursor::Right, QTextCursor::KeepAnchor);
        cursor.removeSelectedText();

        cursor.movePosition(QTextCursor::PreviousBlock);
        cursor.movePosition(QTextCursor::EndOfBlock);

        cursor.insertText(cutLine);
    }
    cursor.endEditBlock();

    setTextCursor(cursor);
1001 1002
}

1003
void BaseTextEditorWidget::insertLineAbove()
1004 1005 1006
{
    QTextCursor cursor = textCursor();
    cursor.beginEditBlock();
1007 1008 1009
    // If the cursor is at the beginning of the document,
    // it should still insert a line above the current line.
    cursor.movePosition(QTextCursor::StartOfBlock, QTextCursor::MoveAnchor);
1010
    cursor.insertBlock();
1011
    cursor.movePosition(QTextCursor::PreviousBlock, QTextCursor::MoveAnchor);
1012 1013 1014 1015 1016
    indent(document(), cursor, QChar::Null);
    cursor.endEditBlock();
    setTextCursor(cursor);
}

1017
void BaseTextEditorWidget::insertLineBelow()
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
{
    QTextCursor cursor = textCursor();
    cursor.beginEditBlock();
    cursor.movePosition(QTextCursor::EndOfBlock, QTextCursor::MoveAnchor);
    cursor.insertBlock();
    indent(document(), cursor, QChar::Null);
    cursor.endEditBlock();
    setTextCursor(cursor);
}

1028
void BaseTextEditorWidget::moveLineUp()
1029 1030 1031 1032
{
    moveLineUpDown(true);
}

1033
void BaseTextEditorWidget::moveLineDown()
1034 1035 1036 1037
{
    moveLineUpDown(false);
}

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
void BaseTextEditorWidget::uppercaseSelection()
{
    transformSelection(&QString::toUpper);
}

void BaseTextEditorWidget::lowercaseSelection()
{
    transformSelection(&QString::toLower);
}

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
void BaseTextEditorWidget::indent()
{
    indentOrUnindent(true);
}

void BaseTextEditorWidget::unindent()
{
    indentOrUnindent(false);
}

1058 1059
void BaseTextEditorWidget::openLinkUnderCursor()
{
1060 1061
    Link symbolLink = findLinkAt