basetexteditor.h 18.2 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 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 37 38
#ifndef BASETEXTEDITOR_H
#define BASETEXTEDITOR_H

#include "itexteditable.h"

39 40
#include <find/ifindsupport.h>

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

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

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

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

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

namespace Internal {
    class BaseTextEditorPrivate;
62
    class TextEditorOverlay;
63
    typedef QList<RefactorMarker> RefactorMarkers;
con's avatar
con committed
64 65 66 67 68
}

class ITextMarkable;

class BaseTextDocument;
69
class BaseTextEditorEditable;
con's avatar
con committed
70
class FontSettings;
71 72 73 74
class BehaviorSettings;
class CompletionSettings;
class DisplaySettings;
class StorageSettings;
75
class Indenter;
76
class AutoCompleter;
con's avatar
con committed
77

78 79 80 81 82 83 84
class TEXTEDITOR_EXPORT BaseTextEditorAnimator : public QObject
{
    Q_OBJECT

public:
    BaseTextEditorAnimator(QObject *parent);

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

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

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

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

    void finish();

mae's avatar
mae committed
98 99
    bool isRunning() const;

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


private slots:
    void step(qreal v);

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


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

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

133 134 135
    const Utils::ChangeSet &changeSet() const;
    void setChangeSet(const Utils::ChangeSet &changeSet);

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

    // ITextEditor

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

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

153
    BaseTextEditorEditable *editableInterface() const;
con's avatar
con committed
154 155 156
    ITextMarkable *markableInterface() const;

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

    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 208 209 210 211 212 213 214 215
    void setRevisionsVisible(bool b);
    bool revisionsVisible() const;

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

    void setActionHack(QObject *);
    QObject *actionHack() const;

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

    void setReadOnly(bool b);

216 217
    void setTextCursor(const QTextCursor &cursor);

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

220 221
    void setBlockSelection(bool on);
    bool hasBlockSelection() const;
222

mae's avatar
mae committed
223 224
    int verticalBlockSelectionFirstColumn() const;
    int verticalBlockSelectionLastColumn() const;
225

226 227
    QRegion translatedLineRegion(int lineStart, int lineEnd) const;

228
    void setIndenter(Indenter *indenter);
229
    Indenter *indenter() const;
230

231 232 233
    void setAutoCompleter(AutoCompleter *autoCompleter);
    AutoCompleter *autoCompleter() const;

con's avatar
con committed
234 235 236
public slots:
    void setDisplayName(const QString &title);

mae's avatar
mae committed
237 238
    virtual void paste();
    virtual void cut();
con's avatar
con committed
239 240 241

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

244
    void cutLine();
con's avatar
con committed
245
    void deleteLine();
mae's avatar
mae committed
246 247 248
    void unfoldAll();
    void fold();
    void unfold();
con's avatar
con committed
249 250
    void selectEncoding();

251 252 253 254 255
    void gotoBlockStart();
    void gotoBlockEnd();
    void gotoBlockStartWithSelection();
    void gotoBlockEndWithSelection();

mae's avatar
mae committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
    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
272 273 274 275
    void gotoPreviousWordCamelCase();
    void gotoPreviousWordCamelCaseWithSelection();
    void gotoNextWordCamelCase();
    void gotoNextWordCamelCaseWithSelection();
276

277 278 279
    void selectBlockUp();
    void selectBlockDown();

280 281 282
    void moveLineUp();
    void moveLineDown();

283 284 285
    void copyLineUp();
    void copyLineDown();

286
    void joinLines();
287

288 289 290
    void insertLineAbove();
    void insertLineBelow();

291 292
    void cleanWhitespace();

con's avatar
con committed
293 294 295 296 297 298 299 300 301 302 303
signals:
    void changed();

    // ITextEditor
    void contentsChanged();

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

mae's avatar
mae committed
307 308
    void showEvent(QShowEvent *);

con's avatar
con committed
309 310 311 312 313
    // reimplemented to support block selection
    QMimeData *createMimeDataFromSelection() const;
    bool canInsertFromMimeData(const QMimeData *source) const;
    void insertFromMimeData(const QMimeData *source);

314 315
    static QString msgTextTooLarge(quint64 size);

316 317 318
private:
    void maybeSelectLine();

con's avatar
con committed
319 320
public:
    void duplicateFrom(BaseTextEditor *editor);
321

con's avatar
con committed
322 323 324 325 326 327 328 329 330 331
protected:
    BaseTextDocument *baseTextDocument() const;
    void setBaseTextDocument(BaseTextDocument *doc);

    void setDefaultPath(const QString &defaultPath);

    virtual BaseTextEditorEditable *createEditableInterface() = 0;

private slots:
    void editorContentsChange(int position, int charsRemoved, int charsAdded);
mae's avatar
mae committed
332 333
    void documentAboutToBeReloaded();
    void documentReloaded();
334
    void highlightSearchResults(const QString &txt, Find::FindFlags findFlags);
mae's avatar
mae committed
335 336 337
    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
338 339 340 341 342
    void currentEditorChanged(Core::IEditor *editor);

private:
    Internal::BaseTextEditorPrivate *d;
    friend class Internal::BaseTextEditorPrivate;
343
    friend class Internal::TextEditorOverlay;
344
    friend class RefactorOverlay;
con's avatar
con committed
345 346 347 348 349 350

public:
    QWidget *extraArea() const;
    virtual int extraAreaWidth(int *markWidthPtr = 0) const;
    virtual void extraAreaPaintEvent(QPaintEvent *);
    virtual void extraAreaLeaveEvent(QEvent *);
351
    virtual void extraAreaMouseEvent(QMouseEvent *);
con's avatar
con committed
352 353 354 355 356 357 358 359

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

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

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

377 378 379

    void setRefactorMarkers(const Internal::RefactorMarkers &markers);
signals:
380
    void refactorMarkerClicked(const TextEditor::RefactorMarker &marker);
381 382 383

public:

384 385 386 387 388 389
    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
390 391 392 393 394 395
        int first;
        int last;
        inline bool isNull() const { return last < first; }
    };

    // the blocks list must be sorted
396
    void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
con's avatar
con committed
397 398

public slots:
399
    virtual void format();
400
    virtual void rewrapParagraph();
401 402
    virtual void unCommentSelection();
    virtual void setFontSettings(const TextEditor::FontSettings &);
mae's avatar
mae committed
403
    void setFontSettingsIfVisible(const TextEditor::FontSettings &);
con's avatar
con committed
404 405
    virtual void setTabSettings(const TextEditor::TabSettings &);
    virtual void setDisplaySettings(const TextEditor::DisplaySettings &);
406
    virtual void setBehaviorSettings(const TextEditor::BehaviorSettings &);
407
    virtual void setStorageSettings(const TextEditor::StorageSettings &);
408
    virtual void setCompletionSettings(const TextEditor::CompletionSettings &);
con's avatar
con committed
409 410 411 412 413 414 415 416 417

protected:
    bool viewportEvent(QEvent *event);

    void resizeEvent(QResizeEvent *);
    void paintEvent(QPaintEvent *);
    void timerEvent(QTimerEvent *);
    void mouseMoveEvent(QMouseEvent *);
    void mousePressEvent(QMouseEvent *);
418 419 420
    void mouseReleaseEvent(QMouseEvent *);
    void leaveEvent(QEvent *);
    void keyReleaseEvent(QKeyEvent *);
con's avatar
con committed
421

422 423
    void dragEnterEvent(QDragEnterEvent *e);

424
public:
425
    void indentInsertedText(const QTextCursor &tc);
426 427
    void indent(QTextDocument *doc, const QTextCursor &cursor, QChar typedChar);
    void reindent(QTextDocument *doc, const QTextCursor &cursor);
con's avatar
con committed
428

429 430 431 432 433
    struct Link
    {
        Link(const QString &fileName = QString(),
             int line = 0,
             int column = 0)
434 435
            : begin(-1)
            , end(-1)
436 437 438 439 440 441
            , fileName(fileName)
            , line(line)
            , column(column)
        {}

        bool isValid() const
442
        { return begin != end; }
443

444
        bool operator==(const Link &other) const
445
        { return begin == other.begin && end == other.end; }
446

447 448
        int begin;           // Link position
        int end;           // Link end position
449 450 451 452 453 454

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

455
protected:
456 457 458 459 460 461 462 463 464 465
    /*!
       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
466
       opened. Returns whether the link was opened successfully.
467 468 469
     */
    virtual bool openLink(const Link &link);

470 471
    void maybeClearSomeExtraSelections(const QTextCursor &cursor);

con's avatar
con committed
472 473 474 475 476 477 478 479
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
480 481
    void requestFontZoom(int zoom);
    void requestZoomReset();
con's avatar
con committed
482
    void requestBlockUpdate(const QTextBlock &);
483 484
    void requestAutoCompletion(TextEditor::ITextEditable *editor, bool forced);
    void requestQuickFix(TextEditor::ITextEditable *editor);
con's avatar
con committed
485 486

private:
487
    void maybeRequestAutoCompletion(const QChar &ch);
con's avatar
con committed
488 489 490
    void indentOrUnindent(bool doIndent);
    void handleHomeKey(bool anchor);
    void handleBackspaceKey();
491
    void moveLineUpDown(bool up);
492
    void copyLineUpDown(bool up);
493
    void saveCurrentCursorPositionForNavigation();
con's avatar
con committed
494
    void updateHighlights();
495
    void updateCurrentLineHighlight();
con's avatar
con committed
496

497 498 499 500 501
    void drawFoldingMarker(QPainter *painter, const QPalette &pal,
                           const QRect &rect,
                           bool expanded,
                           bool active,
                           bool hovered) const;
502

503 504 505 506 507
    void drawCollapsedBlockPopup(QPainter &painter,
                                 const QTextBlock &block,
                                 QPointF offset,
                                 const QRect &clip);

con's avatar
con committed
508
    void toggleBlockVisible(const QTextBlock &block);
mae's avatar
mae committed
509
    QRect foldBox();
con's avatar
con committed
510

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

513
    void updateLink(QMouseEvent *e);
514 515
    void showLink(const Link &);
    void clearLink();
mae's avatar
mae committed
516

517 518
    void universalHelper(); // test function for development

519 520 521 522 523
    bool cursorMoveKeyEvent(QKeyEvent *e);
    bool camelCaseRight(QTextCursor &cursor, QTextCursor::MoveMode mode);
    bool camelCaseLeft(QTextCursor &cursor, QTextCursor::MoveMode mode);


con's avatar
con committed
524
private slots:
525 526 527
    // auto completion
    void _q_requestAutoCompletion();

mae's avatar
mae committed
528 529
    void handleBlockSelection(int diff_row, int diff_col);

530
    // parentheses matcher
con's avatar
con committed
531
    void _q_matchParentheses();
532
    void _q_highlightBlocks();
con's avatar
con committed
533
    void slotSelectionChanged();
534
    void _q_animateUpdate(int position, QPointF lastPos, QRectF rect);
535
    void doFoo();
536

con's avatar
con committed
537 538 539
};


540
class TEXTEDITOR_EXPORT BaseTextEditorEditable : public ITextEditable
con's avatar
con committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
{
    Q_OBJECT
    friend class BaseTextEditor;
public:
    BaseTextEditorEditable(BaseTextEditor *editor);
    ~BaseTextEditorEditable();

    inline BaseTextEditor *editor() const { return e; }

    // 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(); }
559
    inline void setDisplayName(const QString &title) { e->setDisplayName(title); emit changed(); }
con's avatar
con committed
560 561 562

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

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

    int currentLine() const;
    int currentColumn() const;
570
    void gotoLine(int line, int column = 0) { e->gotoLine(line, column); }
con's avatar
con committed
571 572 573 574 575 576 577 578 579 580 581 582 583

    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
584 585
    inline void triggerQuickFix() { e->triggerQuickFix(); } // slot?

con's avatar
con committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
    inline ITextMarkable *markableInterface() { return e->markableInterface(); }

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

    inline void setTextCodec(QTextCodec *codec) { e->setTextCodec(codec); }
    inline QTextCodec *textCodec() const { return e->textCodec(); }


    // ITextEditable
    void remove(int length);
    void insert(const QString &string);
    void replace(int length, const QString &string);
    void setCurPos(int pos);
    void select(int toPos);

private slots:
    void updateCursorPosition();

private:
    BaseTextEditor *e;
    mutable QString m_contextHelpId;
    QToolBar *m_toolBar;
609
    Utils::LineColumnLabel *m_cursorPositionLabel;
con's avatar
con committed
610 611 612 613
};

} // namespace TextEditor

614
Q_DECLARE_METATYPE(TextEditor::BaseTextEditor::Link)
615

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