basetexteditor.h 18.2 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 37
#ifndef BASETEXTEDITOR_H
#define BASETEXTEDITOR_H

#include "itexteditable.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 BaseTextEditorEditable;
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;
con's avatar
con committed
78

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

public:
    BaseTextEditorAnimator(QObject *parent);

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

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

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

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

    void finish();

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

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


private slots:
    void step(qreal v);

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


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

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

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

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

    // ITextEditor

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

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

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

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

    QChar characterAt(int pos) const;

    void print(QPrinter *);

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


169 170
    void appendStandardContextMenuActions(QMenu *menu);

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

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

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

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

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

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

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

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

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

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

    void setReadOnly(bool b);

220 221
    void setTextCursor(const QTextCursor &cursor);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

290
    void joinLines();
291

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

295 296
    void cleanWhitespace();

con's avatar
con committed
297 298 299 300 301 302 303 304 305 306 307
signals:
    void changed();

    // ITextEditor
    void contentsChanged();

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

mae's avatar
mae committed
311 312
    void showEvent(QShowEvent *);

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

318 319
    static QString msgTextTooLarge(quint64 size);

320 321 322
private:
    void maybeSelectLine();

con's avatar
con committed
323 324
public:
    void duplicateFrom(BaseTextEditor *editor);
325

con's avatar
con committed
326 327 328 329 330 331 332 333 334 335
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
336 337
    void documentAboutToBeReloaded();
    void documentReloaded();
338
    void highlightSearchResults(const QString &txt, Find::FindFlags findFlags);
mae's avatar
mae committed
339 340 341
    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
342 343 344 345 346
    void currentEditorChanged(Core::IEditor *editor);

private:
    Internal::BaseTextEditorPrivate *d;
    friend class Internal::BaseTextEditorPrivate;
347
    friend class Internal::TextEditorOverlay;
348
    friend class RefactorOverlay;
con's avatar
con committed
349 350 351 352 353 354

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

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

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

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

381 382 383

    void setRefactorMarkers(const Internal::RefactorMarkers &markers);
signals:
384
    void refactorMarkerClicked(const TextEditor::RefactorMarker &marker);
385 386 387

public:

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

    // the blocks list must be sorted
400
    void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
con's avatar
con committed
401 402

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

protected:
    bool viewportEvent(QEvent *event);

    void resizeEvent(QResizeEvent *);
    void paintEvent(QPaintEvent *);
    void timerEvent(QTimerEvent *);
    void mouseMoveEvent(QMouseEvent *);
    void mousePressEvent(QMouseEvent *);
422 423 424
    void mouseReleaseEvent(QMouseEvent *);
    void leaveEvent(QEvent *);
    void keyReleaseEvent(QKeyEvent *);
con's avatar
con committed
425

426 427
    void dragEnterEvent(QDragEnterEvent *e);

428
public:
429
    void indentInsertedText(const QTextCursor &tc);
430 431
    void indent(QTextDocument *doc, const QTextCursor &cursor, QChar typedChar);
    void reindent(QTextDocument *doc, const QTextCursor &cursor);
con's avatar
con committed
432

433 434 435 436 437
    struct Link
    {
        Link(const QString &fileName = QString(),
             int line = 0,
             int column = 0)
438 439
            : begin(-1)
            , end(-1)
440 441 442 443 444 445
            , fileName(fileName)
            , line(line)
            , column(column)
        {}

        bool isValid() const
446
        { return begin != end; }
447

448
        bool operator==(const Link &other) const
449
        { return begin == other.begin && end == other.end; }
450

451 452
        int begin;           // Link position
        int end;           // Link end position
453 454 455 456 457 458

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

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

474 475
    void maybeClearSomeExtraSelections(const QTextCursor &cursor);

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

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

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

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

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

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

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

519 520
    void universalHelper(); // test function for development

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


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

mae's avatar
mae committed
530 531
    void handleBlockSelection(int diff_row, int diff_col);

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

con's avatar
con committed
539 540 541
};


542
class TEXTEDITOR_EXPORT BaseTextEditorEditable : public ITextEditable
con's avatar
con committed
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
{
    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(); }
561
    inline void setDisplayName(const QString &title) { e->setDisplayName(title); emit changed(); }
con's avatar
con committed
562 563 564

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

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

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

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

con's avatar
con committed
590 591 592 593 594
    inline ITextMarkable *markableInterface() { return e->markableInterface(); }

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

595
    inline void setTextCodec(QTextCodec *codec, TextCodecReason = TextCodecOtherReason) { e->setTextCodec(codec); }
con's avatar
con committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    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;
613
    Utils::LineColumnLabel *m_cursorPositionLabel;
con's avatar
con committed
614 615 616 617
};

} // namespace TextEditor

618
Q_DECLARE_METATYPE(TextEditor::BaseTextEditor::Link)
619

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