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;
con's avatar
con committed
65 66 67 68 69
}

class ITextMarkable;

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

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

public:
    BaseTextEditorAnimator(QObject *parent);

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

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

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

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

    void finish();

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

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


private slots:
    void step(qreal v);

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


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

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

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

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

    // ITextEditor

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

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

155
    BaseTextEditor *editor() const;
con's avatar
con committed
156 157 158
    ITextMarkable *markableInterface() const;

    virtual void triggerCompletions();
Roberto Raggi's avatar
Roberto Raggi committed
159
    virtual void triggerQuickFix();
con's avatar
con committed
160 161 162 163 164 165 166

    QChar characterAt(int pos) const;

    void print(QPrinter *);

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


170 171
    void appendStandardContextMenuActions(QMenu *menu);

con's avatar
con committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    // 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;

192
    void updateCodeFoldingVisible();
con's avatar
con committed
193 194
    bool codeFoldingVisible() const;

195 196 197
    void setCodeFoldingSupported(bool b);
    bool codeFoldingSupported() const;

198 199 200
    void setMouseNavigationEnabled(bool b);
    bool mouseNavigationEnabled() const;

201 202 203
    void setScrollWheelZoomingEnabled(bool b);
    bool scrollWheelZoomingEnabled() const;

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

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

210 211 212
    int columnCount() const;
    int rowCount() const;

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

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

    void setReadOnly(bool b);

221 222
    void setTextCursor(const QTextCursor &cursor);

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

225 226
    void setBlockSelection(bool on);
    bool hasBlockSelection() const;
227

mae's avatar
mae committed
228 229
    int verticalBlockSelectionFirstColumn() const;
    int verticalBlockSelectionLastColumn() const;
230

231 232
    QRegion translatedLineRegion(int lineStart, int lineEnd) const;

233
    void setIndenter(Indenter *indenter);
234
    Indenter *indenter() const;
235

236 237 238
    void setAutoCompleter(AutoCompleter *autoCompleter);
    AutoCompleter *autoCompleter() const;

239 240
    QPoint toolTipPosition(const QTextCursor &c) const;

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

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

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

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

258 259 260 261 262
    void gotoBlockStart();
    void gotoBlockEnd();
    void gotoBlockStartWithSelection();
    void gotoBlockEndWithSelection();

mae's avatar
mae committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
    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
279 280 281 282
    void gotoPreviousWordCamelCase();
    void gotoPreviousWordCamelCaseWithSelection();
    void gotoNextWordCamelCase();
    void gotoNextWordCamelCaseWithSelection();
283

284 285 286
    void selectBlockUp();
    void selectBlockDown();

287 288 289
    void moveLineUp();
    void moveLineDown();

290 291 292
    void copyLineUp();
    void copyLineDown();

293
    void joinLines();
294

295 296 297
    void insertLineAbove();
    void insertLineBelow();

298 299
    void cleanWhitespace();

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

    // ITextEditor
    void contentsChanged();

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

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

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

321 322
    static QString msgTextTooLarge(quint64 size);

323 324 325
private:
    void maybeSelectLine();

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

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

    void setDefaultPath(const QString &defaultPath);

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

private slots:
    void editorContentsChange(int position, int charsRemoved, int charsAdded);
mae's avatar
mae committed
339 340
    void documentAboutToBeReloaded();
    void documentReloaded();
341
    void highlightSearchResults(const QString &txt, Find::FindFlags findFlags);
mae's avatar
mae committed
342 343 344
    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
345 346 347 348 349
    void currentEditorChanged(Core::IEditor *editor);

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

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

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

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

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

384 385 386

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

public:

391 392 393 394 395 396
    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
397 398 399 400 401 402
        int first;
        int last;
        inline bool isNull() const { return last < first; }
    };

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

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

protected:
    bool viewportEvent(QEvent *event);

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

430 431
    void dragEnterEvent(QDragEnterEvent *e);

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

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

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

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

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

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

463
protected:
464 465 466 467 468 469 470 471 472 473
    /*!
       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
474
       opened. Returns whether the link was opened successfully.
475 476 477
     */
    virtual bool openLink(const Link &link);

478 479
    void maybeClearSomeExtraSelections(const QTextCursor &cursor);

con's avatar
con committed
480 481 482 483 484 485 486 487
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
488 489
    void requestFontZoom(int zoom);
    void requestZoomReset();
con's avatar
con committed
490 491 492
    void requestBlockUpdate(const QTextBlock &);

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

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

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

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

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

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

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

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


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

mae's avatar
mae committed
534 535
    void handleBlockSelection(int diff_row, int diff_col);

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


545
class TEXTEDITOR_EXPORT BaseTextEditor : public ITextEditor
con's avatar
con committed
546 547
{
    Q_OBJECT
548
    friend class BaseTextEditorWidget;
con's avatar
con committed
549
public:
550 551
    BaseTextEditor(BaseTextEditorWidget *editorWidget);
    ~BaseTextEditor();
con's avatar
con committed
552

553
    inline BaseTextEditorWidget *editorWidget() const { return e; }
con's avatar
con committed
554 555 556 557 558 559 560 561 562 563

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

    inline QByteArray saveState() const { return e->saveState(); }
    inline bool restoreState(const QByteArray &state) { return e->restoreState(state); }
568
    virtual QWidget *toolBar();
con's avatar
con committed
569 570 571 572 573 574

    // ITextEditor
    int find(const QString &string) const;

    int currentLine() const;
    int currentColumn() const;
575
    void gotoLine(int line, int column = 0) { e->gotoLine(line, column); }
576 577
    int columnCount() const;
    int rowCount() const;
con's avatar
con committed
578 579 580 581 582 583 584 585 586 587 588 589 590

    inline int position(
        ITextEditor::PositionOperation posOp = ITextEditor::Current
        , int at = -1) const { return e->position(posOp, at); }
    inline void convertPosition(int pos, int *line, int *column) const { e->convertPosition(pos, line, column); }
    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 void triggerCompletions() { e->triggerCompletions(); } // slot?
Roberto Raggi's avatar
Roberto Raggi committed
591 592
    inline void triggerQuickFix() { e->triggerQuickFix(); } // slot?

con's avatar
con committed
593 594 595 596 597
    inline ITextMarkable *markableInterface() { return e->markableInterface(); }

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

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


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

private slots:
    void updateCursorPosition();

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

} // namespace TextEditor

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

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