basetexteditor.h 18.4 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34 35 36
#ifndef BASETEXTEDITOR_H
#define BASETEXTEDITOR_H

37
#include "itexteditor.h"
38
#include "icompletioncollector.h"
con's avatar
con committed
39

40 41
#include <find/ifindsupport.h>

42 43
#include <coreplugin/editormanager/editormanager.h>

con's avatar
con committed
44 45 46 47
#include <QtGui/QPlainTextEdit>

QT_BEGIN_NAMESPACE
class QToolBar;
48
class QTimeLine;
con's avatar
con committed
49 50
QT_END_NAMESPACE

51 52
namespace Utils {
    class LineColumnLabel;
53
    class ChangeSet;
con's avatar
con committed
54 55 56
}

namespace TextEditor {
57
class TabSettings;
58 59
class RefactorOverlay;
struct RefactorMarker;
con's avatar
con committed
60 61 62

namespace Internal {
    class BaseTextEditorPrivate;
63
    class TextEditorOverlay;
64
    typedef QList<RefactorMarker> RefactorMarkers;
65
    typedef QString (QString::*TransformationMethod)() const;
con's avatar
con committed
66 67 68 69 70
}

class ITextMarkable;

class BaseTextDocument;
71
class BaseTextEditor;
con's avatar
con committed
72
class FontSettings;
73 74 75 76
class BehaviorSettings;
class CompletionSettings;
class DisplaySettings;
class StorageSettings;
77
class Indenter;
78
class AutoCompleter;
79
class ExtraEncodingSettings;
con's avatar
con committed
80

81 82 83 84 85 86 87
class TEXTEDITOR_EXPORT BaseTextEditorAnimator : public QObject
{
    Q_OBJECT

public:
    BaseTextEditorAnimator(QObject *parent);

88 89
    inline void setPosition(int position) { m_position = position; }
    inline int position() const { return m_position; }
90 91 92 93 94 95

    void setData(QFont f, QPalette pal, const QString &text);

    void draw(QPainter *p, const QPointF &pos);
    QRectF rect() const;

96 97
    inline qreal value() const { return m_value; }
    inline QPointF lastDrawPos() const { return m_lastDrawPos; }
98 99 100

    void finish();

mae's avatar
mae committed
101 102
    bool isRunning() const;

103
signals:
104
    void updateRequest(int position, QPointF lastPos, QRectF rect);
105 106 107 108 109 110 111 112 113


private slots:
    void step(qreal v);

private:
    QTimeLine *m_timeline;
    qreal m_value;
    int m_position;
114
    QPointF m_lastDrawPos;
115 116 117 118 119 120 121
    QFont m_font;
    QPalette m_palette;
    QString m_text;
    QSizeF m_size;
};


122
class TEXTEDITOR_EXPORT BaseTextEditorWidget : public QPlainTextEdit
con's avatar
con committed
123 124
{
    Q_OBJECT
mae's avatar
mae committed
125 126
    Q_PROPERTY(int verticalBlockSelectionFirstColumn READ verticalBlockSelectionFirstColumn)
    Q_PROPERTY(int verticalBlockSelectionLastColumn READ verticalBlockSelectionLastColumn)
con's avatar
con committed
127
public:
128 129
    BaseTextEditorWidget(QWidget *parent);
    ~BaseTextEditorWidget();
con's avatar
con committed
130

131
    static ITextEditor *openEditorAt(const QString &fileName, int line, int column = 0,
132 133
                                     const QString &editorId =  QString(),
                                     Core::EditorManager::OpenEditorFlags flags = Core::EditorManager::IgnoreNavigationHistory,
134
                                     bool *newEditor = 0);
con's avatar
con committed
135

136 137 138
    const Utils::ChangeSet &changeSet() const;
    void setChangeSet(const Utils::ChangeSet &changeSet);

con's avatar
con committed
139 140 141
    // EditorInterface
    Core::IFile * file();
    bool createNew(const QString &contents);
Lasse Holmstedt's avatar
Lasse Holmstedt committed
142
    virtual bool open(const QString &fileName = QString());
con's avatar
con committed
143 144 145 146 147 148
    QByteArray saveState() const;
    bool restoreState(const QByteArray &state);
    QString displayName() const;

    // ITextEditor

149
    void gotoLine(int line, int column = 0);
con's avatar
con committed
150 151 152 153 154 155

    int position(
        ITextEditor::PositionOperation posOp = ITextEditor::Current
        , int at = -1) const;
    void convertPosition(int pos, int *line, int *column) const;

156
    BaseTextEditor *editor() const;
con's avatar
con committed
157 158 159 160 161 162 163 164
    ITextMarkable *markableInterface() const;

    QChar characterAt(int pos) const;

    void print(QPrinter *);

    void setSuggestedFileName(const QString &suggestedFileName);
    QString mimeType() const;
Erik Verbruggen's avatar
Erik Verbruggen committed
165
    virtual void setMimeType(const QString &mt);
con's avatar
con committed
166 167


168 169
    void appendStandardContextMenuActions(QMenu *menu);

con's avatar
con committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
    // Works only in conjunction with a syntax highlighter that puts
    // parentheses into text block user data
    void setParenthesesMatchingEnabled(bool b);
    bool isParenthesesMatchingEnabled() const;

    void setHighlightCurrentLine(bool b);
    bool highlightCurrentLine() const;

    void setLineNumbersVisible(bool b);
    bool lineNumbersVisible() const;

    void setMarksVisible(bool b);
    bool marksVisible() const;

    void setRequestMarkEnabled(bool b);
    bool requestMarkEnabled() const;

    void setLineSeparatorsAllowed(bool b);
    bool lineSeparatorsAllowed() const;

190
    void updateCodeFoldingVisible();
con's avatar
con committed
191 192
    bool codeFoldingVisible() const;

193 194 195
    void setCodeFoldingSupported(bool b);
    bool codeFoldingSupported() const;

196 197 198
    void setMouseNavigationEnabled(bool b);
    bool mouseNavigationEnabled() const;

199 200 201
    void setScrollWheelZoomingEnabled(bool b);
    bool scrollWheelZoomingEnabled() const;

con's avatar
con committed
202 203 204 205 206 207
    void setRevisionsVisible(bool b);
    bool revisionsVisible() const;

    void setVisibleWrapColumn(int column);
    int visibleWrapColumn() const;

208 209 210
    int columnCount() const;
    int rowCount() const;

con's avatar
con committed
211 212 213 214 215 216 217 218
    void setActionHack(QObject *);
    QObject *actionHack() const;

    void setTextCodec(QTextCodec *codec);
    QTextCodec *textCodec() const;

    void setReadOnly(bool b);

219 220
    void setTextCursor(const QTextCursor &cursor);

mae's avatar
mae committed
221
    void insertCodeSnippet(const QTextCursor &cursor, const QString &snippet);
222

223 224
    void setBlockSelection(bool on);
    bool hasBlockSelection() const;
225

mae's avatar
mae committed
226 227
    int verticalBlockSelectionFirstColumn() const;
    int verticalBlockSelectionLastColumn() const;
228

229 230
    QRegion translatedLineRegion(int lineStart, int lineEnd) const;

231
    void setIndenter(Indenter *indenter);
232
    Indenter *indenter() const;
233

234 235 236
    void setAutoCompleter(AutoCompleter *autoCompleter);
    AutoCompleter *autoCompleter() const;

237 238
    QPoint toolTipPosition(const QTextCursor &c) const;

con's avatar
con committed
239 240 241
public slots:
    void setDisplayName(const QString &title);

mae's avatar
mae committed
242 243
    virtual void paste();
    virtual void cut();
con's avatar
con committed
244 245 246

    void zoomIn(int range = 1);
    void zoomOut(int range = 1);
mae's avatar
mae committed
247
    void zoomReset();
con's avatar
con committed
248

249
    void cutLine();
con's avatar
con committed
250
    void deleteLine();
mae's avatar
mae committed
251 252 253
    void unfoldAll();
    void fold();
    void unfold();
con's avatar
con committed
254 255
    void selectEncoding();

256 257 258 259 260
    void gotoBlockStart();
    void gotoBlockEnd();
    void gotoBlockStartWithSelection();
    void gotoBlockEndWithSelection();

mae's avatar
mae committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    void gotoLineStart();
    void gotoLineStartWithSelection();
    void gotoLineEnd();
    void gotoLineEndWithSelection();
    void gotoNextLine();
    void gotoNextLineWithSelection();
    void gotoPreviousLine();
    void gotoPreviousLineWithSelection();
    void gotoPreviousCharacter();
    void gotoPreviousCharacterWithSelection();
    void gotoNextCharacter();
    void gotoNextCharacterWithSelection();
    void gotoPreviousWord();
    void gotoPreviousWordWithSelection();
    void gotoNextWord();
    void gotoNextWordWithSelection();
mae's avatar
mae committed
277 278 279 280
    void gotoPreviousWordCamelCase();
    void gotoPreviousWordCamelCaseWithSelection();
    void gotoNextWordCamelCase();
    void gotoNextWordCamelCaseWithSelection();
281

282 283 284
    void selectBlockUp();
    void selectBlockDown();

285 286 287
    void moveLineUp();
    void moveLineDown();

288 289 290
    void copyLineUp();
    void copyLineDown();

291
    void joinLines();
292

293 294 295
    void insertLineAbove();
    void insertLineBelow();

296 297 298
    void uppercaseSelection();
    void lowercaseSelection();

299 300
    void cleanWhitespace();

con's avatar
con committed
301 302 303 304 305 306 307 308 309 310 311
signals:
    void changed();

    // ITextEditor
    void contentsChanged();

protected:
    bool event(QEvent *e);
    void keyPressEvent(QKeyEvent *e);
    void wheelEvent(QWheelEvent *e);
    void changeEvent(QEvent *e);
312
    void focusInEvent(QFocusEvent *e);
mae's avatar
mae committed
313
    void focusOutEvent(QFocusEvent *e);
con's avatar
con committed
314

mae's avatar
mae committed
315 316
    void showEvent(QShowEvent *);

con's avatar
con committed
317 318 319 320 321
    // reimplemented to support block selection
    QMimeData *createMimeDataFromSelection() const;
    bool canInsertFromMimeData(const QMimeData *source) const;
    void insertFromMimeData(const QMimeData *source);

322 323
    static QString msgTextTooLarge(quint64 size);

324 325 326
private:
    void maybeSelectLine();

con's avatar
con committed
327
public:
328
    void duplicateFrom(BaseTextEditorWidget *editor);
329

con's avatar
con committed
330 331 332 333 334 335
protected:
    BaseTextDocument *baseTextDocument() const;
    void setBaseTextDocument(BaseTextDocument *doc);

    void setDefaultPath(const QString &defaultPath);

336
    virtual BaseTextEditor *createEditor() = 0;
con's avatar
con committed
337 338 339

private slots:
    void editorContentsChange(int position, int charsRemoved, int charsAdded);
mae's avatar
mae committed
340 341
    void documentAboutToBeReloaded();
    void documentReloaded();
342
    void highlightSearchResults(const QString &txt, Find::FindFlags findFlags);
mae's avatar
mae committed
343 344 345
    void setFindScope(const QTextCursor &start, const QTextCursor &end, int, int);
    bool inFindScope(const QTextCursor &cursor);
    bool inFindScope(int selectionStart, int selectionEnd);
con's avatar
con committed
346 347 348 349 350
    void currentEditorChanged(Core::IEditor *editor);

private:
    Internal::BaseTextEditorPrivate *d;
    friend class Internal::BaseTextEditorPrivate;
351
    friend class Internal::TextEditorOverlay;
352
    friend class RefactorOverlay;
con's avatar
con committed
353 354 355 356 357 358

public:
    QWidget *extraArea() const;
    virtual int extraAreaWidth(int *markWidthPtr = 0) const;
    virtual void extraAreaPaintEvent(QPaintEvent *);
    virtual void extraAreaLeaveEvent(QEvent *);
359
    virtual void extraAreaMouseEvent(QMouseEvent *);
con's avatar
con committed
360 361 362 363 364 365 366 367

    const TabSettings &tabSettings() const;
    const DisplaySettings &displaySettings() const;

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

368 369 370 371 372
    enum ExtraSelectionKind {
        CurrentLineSelection,
        ParenthesesMatchingSelection,
        CodeWarningsSelection,
        CodeSemanticsSelection,
373
        UndefinedSymbolSelection,
Roberto Raggi's avatar
Roberto Raggi committed
374
        UnusedSymbolSelection,
hjk's avatar
hjk committed
375
        FakeVimSelection,
Roberto Raggi's avatar
Roberto Raggi committed
376
        OtherSelection,
377
        SnippetPlaceholderSelection,
Erik Verbruggen's avatar
Erik Verbruggen committed
378
        ObjCSelection,
379 380 381 382
        NExtraSelectionKinds
    };
    void setExtraSelections(ExtraSelectionKind kind, const QList<QTextEdit::ExtraSelection> &selections);
    QList<QTextEdit::ExtraSelection> extraSelections(ExtraSelectionKind kind) const;
383
    QString extraSelectionTooltip(int pos) const;
con's avatar
con committed
384

385 386 387

    void setRefactorMarkers(const Internal::RefactorMarkers &markers);
signals:
388
    void refactorMarkerClicked(const TextEditor::RefactorMarker &marker);
389 390 391

public:

392 393 394 395 396 397
    struct BlockRange
    {
        BlockRange() : first(0), last(-1) {}
        BlockRange(int first_position, int last_position)
          : first(first_position), last(last_position)
        {}
con's avatar
con committed
398 399 400 401 402 403
        int first;
        int last;
        inline bool isNull() const { return last < first; }
    };

    // the blocks list must be sorted
404
    void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
con's avatar
con committed
405 406

public slots:
407
    virtual void format();
408
    virtual void rewrapParagraph();
409 410
    virtual void unCommentSelection();
    virtual void setFontSettings(const TextEditor::FontSettings &);
mae's avatar
mae committed
411
    void setFontSettingsIfVisible(const TextEditor::FontSettings &);
con's avatar
con committed
412 413
    virtual void setTabSettings(const TextEditor::TabSettings &);
    virtual void setDisplaySettings(const TextEditor::DisplaySettings &);
414
    virtual void setBehaviorSettings(const TextEditor::BehaviorSettings &);
415
    virtual void setStorageSettings(const TextEditor::StorageSettings &);
416
    virtual void setCompletionSettings(const TextEditor::CompletionSettings &);
417
    virtual void setExtraEncodingSettings(const TextEditor::ExtraEncodingSettings &);
con's avatar
con committed
418 419 420 421 422 423 424 425 426

protected:
    bool viewportEvent(QEvent *event);

    void resizeEvent(QResizeEvent *);
    void paintEvent(QPaintEvent *);
    void timerEvent(QTimerEvent *);
    void mouseMoveEvent(QMouseEvent *);
    void mousePressEvent(QMouseEvent *);
427 428 429
    void mouseReleaseEvent(QMouseEvent *);
    void leaveEvent(QEvent *);
    void keyReleaseEvent(QKeyEvent *);
con's avatar
con committed
430

431 432
    void dragEnterEvent(QDragEnterEvent *e);

433
public:
434
    void indentInsertedText(const QTextCursor &tc);
435 436
    void indent(QTextDocument *doc, const QTextCursor &cursor, QChar typedChar);
    void reindent(QTextDocument *doc, const QTextCursor &cursor);
con's avatar
con committed
437

438 439 440 441 442
    struct Link
    {
        Link(const QString &fileName = QString(),
             int line = 0,
             int column = 0)
443 444
            : begin(-1)
            , end(-1)
445 446 447 448 449 450
            , fileName(fileName)
            , line(line)
            , column(column)
        {}

        bool isValid() const
451
        { return begin != end; }
452

453
        bool operator==(const Link &other) const
454
        { return begin == other.begin && end == other.end; }
455

456 457
        int begin;           // Link position
        int end;           // Link end position
458 459 460 461 462 463

        QString fileName;  // Target file
        int line;          // Target line
        int column;        // Target column
    };

464
protected:
465 466 467 468 469 470 471 472 473 474
    /*!
       Reimplement this function to enable code navigation.

       \a resolveTarget is set to true when the target of the link is relevant
       (it isn't until the link is used).
     */
    virtual Link findLinkAt(const QTextCursor &, bool resolveTarget = true);

    /*!
       Reimplement this function if you want to customize the way a link is
Tobias Hunger's avatar
Tobias Hunger committed
475
       opened. Returns whether the link was opened successfully.
476 477 478
     */
    virtual bool openLink(const Link &link);

479 480
    void maybeClearSomeExtraSelections(const QTextCursor &cursor);

con's avatar
con committed
481 482 483 484 485 486 487 488
protected slots:
    virtual void slotUpdateExtraAreaWidth();
    virtual void slotModificationChanged(bool);
    virtual void slotUpdateRequest(const QRect &r, int dy);
    virtual void slotCursorPositionChanged();
    virtual void slotUpdateBlockNotify(const QTextBlock &);

signals:
mae's avatar
mae committed
489 490
    void requestFontZoom(int zoom);
    void requestZoomReset();
con's avatar
con committed
491 492 493
    void requestBlockUpdate(const QTextBlock &);

private:
494
    void maybeRequestAutoCompletion(const QChar &ch);
con's avatar
con committed
495 496 497
    void indentOrUnindent(bool doIndent);
    void handleHomeKey(bool anchor);
    void handleBackspaceKey();
498
    void moveLineUpDown(bool up);
499
    void copyLineUpDown(bool up);
500
    void saveCurrentCursorPositionForNavigation();
con's avatar
con committed
501
    void updateHighlights();
502
    void updateCurrentLineHighlight();
con's avatar
con committed
503

504 505 506 507 508
    void drawFoldingMarker(QPainter *painter, const QPalette &pal,
                           const QRect &rect,
                           bool expanded,
                           bool active,
                           bool hovered) const;
509

510 511 512 513 514
    void drawCollapsedBlockPopup(QPainter &painter,
                                 const QTextBlock &block,
                                 QPointF offset,
                                 const QRect &clip);

con's avatar
con committed
515
    void toggleBlockVisible(const QTextBlock &block);
mae's avatar
mae committed
516
    QRect foldBox();
con's avatar
con committed
517

mae's avatar
mae committed
518
    QTextBlock foldedBlockAt(const QPoint &pos, QRect *box = 0) const;
con's avatar
con committed
519

520
    void updateLink(QMouseEvent *e);
521 522
    void showLink(const Link &);
    void clearLink();
mae's avatar
mae committed
523

524 525
    void universalHelper(); // test function for development

526 527 528 529
    bool cursorMoveKeyEvent(QKeyEvent *e);
    bool camelCaseRight(QTextCursor &cursor, QTextCursor::MoveMode mode);
    bool camelCaseLeft(QTextCursor &cursor, QTextCursor::MoveMode mode);

530
    void transformSelection(Internal::TransformationMethod method);
531

con's avatar
con committed
532
private slots:
533 534 535
    // auto completion
    void _q_requestAutoCompletion();

mae's avatar
mae committed
536 537
    void handleBlockSelection(int diff_row, int diff_col);

538
    // parentheses matcher
con's avatar
con committed
539
    void _q_matchParentheses();
540
    void _q_highlightBlocks();
con's avatar
con committed
541
    void slotSelectionChanged();
542
    void _q_animateUpdate(int position, QPointF lastPos, QRectF rect);
543
    void doFoo();
con's avatar
con committed
544 545 546
};


547
class TEXTEDITOR_EXPORT BaseTextEditor : public ITextEditor
con's avatar
con committed
548 549
{
    Q_OBJECT
550

con's avatar
con committed
551
public:
552 553
    BaseTextEditor(BaseTextEditorWidget *editorWidget);
    ~BaseTextEditor();
con's avatar
con committed
554

555 556
    friend class BaseTextEditorWidget;
    BaseTextEditorWidget *editorWidget() const { return e; }
con's avatar
con committed
557 558

    // EditorInterface
559 560 561 562 563 564
    QWidget *widget() { return e; }
    Core::IFile * file() { return e->file(); }
    bool createNew(const QString &contents) { return e->createNew(contents); }
    bool open(const QString &fileName = QString()) { return e->open(fileName); }
    QString displayName() const { return e->displayName(); }
    void setDisplayName(const QString &title) { e->setDisplayName(title); emit changed(); }
con's avatar
con committed
565

566 567 568
    QByteArray saveState() const { return e->saveState(); }
    bool restoreState(const QByteArray &state) { return e->restoreState(state); }
    QWidget *toolBar();
con's avatar
con committed
569

570 571 572
    enum Side { Left, Right };
    void insertExtraToolBarWidget(Side side, QWidget *widget);

con's avatar
con committed
573 574 575 576
    // ITextEditor
    int find(const QString &string) const;
    int currentLine() const;
    int currentColumn() const;
577
    void gotoLine(int line, int column = 0) { e->gotoLine(line, column); }
578 579
    int columnCount() const;
    int rowCount() const;
con's avatar
con committed
580

581 582 583 584
    int position(PositionOperation posOp = Current, int at = -1) const
    { return e->position(posOp, at); }
    void convertPosition(int pos, int *line, int *column) const
    { e->convertPosition(pos, line, column); }
con's avatar
con committed
585 586 587 588 589 590 591 592 593 594 595 596
    QRect cursorRect(int pos = -1) const;

    QString contents() const;
    QString selectedText() const;
    QString textAt(int pos, int length) const;
    inline QChar characterAt(int pos) const { return e->characterAt(pos); }

    inline ITextMarkable *markableInterface() { return e->markableInterface(); }

    void setContextHelpId(const QString &id) { m_contextHelpId = id; }
    QString contextHelpId() const; // from IContext

597
    inline void setTextCodec(QTextCodec *codec, TextCodecReason = TextCodecOtherReason) { e->setTextCodec(codec); }
con's avatar
con committed
598 599 600
    inline QTextCodec *textCodec() const { return e->textCodec(); }


601
    // ITextEditor
con's avatar
con committed
602 603 604
    void remove(int length);
    void insert(const QString &string);
    void replace(int length, const QString &string);
605
    void setCursorPosition(int pos);
con's avatar
con committed
606 607 608 609 610 611
    void select(int toPos);

private slots:
    void updateCursorPosition();

private:
612
    BaseTextEditorWidget *e;
con's avatar
con committed
613 614
    mutable QString m_contextHelpId;
    QToolBar *m_toolBar;
615 616
    QWidget *m_stretchWidget;
    QAction *m_cursorPositionLabelAction;
617
    Utils::LineColumnLabel *m_cursorPositionLabel;
con's avatar
con committed
618 619 620 621
};

} // namespace TextEditor

622
Q_DECLARE_METATYPE(TextEditor::BaseTextEditorWidget::Link)
623

con's avatar
con committed
624
#endif // BASETEXTEDITOR_H