basetexteditor.h 17.8 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
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
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
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
33
34
#ifndef BASETEXTEDITOR_H
#define BASETEXTEDITOR_H

#include "itexteditable.h"

35
36
#include <find/ifindsupport.h>

con's avatar
con committed
37
38
39
40
#include <QtGui/QPlainTextEdit>

QT_BEGIN_NAMESPACE
class QToolBar;
41
class QTimeLine;
con's avatar
con committed
42
43
QT_END_NAMESPACE

44
45
namespace Utils {
    class LineColumnLabel;
46
    class ChangeSet;
con's avatar
con committed
47
48
49
50
51
52
}

namespace TextEditor {

namespace Internal {
    class BaseTextEditorPrivate;
53
    class TextEditorOverlay;
con's avatar
con committed
54
55
56
57
58
}

class ITextMarkable;

class BaseTextDocument;
59
class BaseTextEditorEditable;
con's avatar
con committed
60
class FontSettings;
61
struct BehaviorSettings;
62
struct CompletionSettings;
63
struct DisplaySettings;
con's avatar
con committed
64
struct StorageSettings;
65
struct TabSettings;
con's avatar
con committed
66
67


68
69
70
71
72
73
74
class TEXTEDITOR_EXPORT BaseTextEditorAnimator : public QObject
{
    Q_OBJECT

public:
    BaseTextEditorAnimator(QObject *parent);

75
76
    inline void setPosition(int position) { m_position = position; }
    inline int position() const { return m_position; }
77
78
79
80
81
82

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

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

83
84
    inline qreal value() const { return m_value; }
    inline QPointF lastDrawPos() const { return m_lastDrawPos; }
85
86
87

    void finish();

mae's avatar
mae committed
88
89
    bool isRunning() const;

90
signals:
91
    void updateRequest(int position, QPointF lastPos, QRectF rect);
92
93
94
95
96
97
98
99
100


private slots:
    void step(qreal v);

private:
    QTimeLine *m_timeline;
    qreal m_value;
    int m_position;
101
    QPointF m_lastDrawPos;
102
103
104
105
106
107
108
    QFont m_font;
    QPalette m_palette;
    QString m_text;
    QSizeF m_size;
};


109
class TEXTEDITOR_EXPORT BaseTextEditor : public QPlainTextEdit
con's avatar
con committed
110
111
{
    Q_OBJECT
112
    Q_PROPERTY(int verticalBlockSelection READ verticalBlockSelection)
con's avatar
con committed
113
114
115
116
117

public:
    BaseTextEditor(QWidget *parent);
    ~BaseTextEditor();

118
    static ITextEditor *openEditorAt(const QString &fileName, int line, int column = 0,
119
120
                                     const QString &editorId = QString(),
                                     bool *newEditor = 0);
con's avatar
con committed
121

122
123
124
    const Utils::ChangeSet &changeSet() const;
    void setChangeSet(const Utils::ChangeSet &changeSet);

con's avatar
con committed
125
126
127
    // EditorInterface
    Core::IFile * file();
    bool createNew(const QString &contents);
Lasse Holmstedt's avatar
Lasse Holmstedt committed
128
    virtual bool open(const QString &fileName = QString());
con's avatar
con committed
129
130
131
132
133
134
    QByteArray saveState() const;
    bool restoreState(const QByteArray &state);
    QString displayName() const;

    // ITextEditor

135
    void gotoLine(int line, int column = 0);
con's avatar
con committed
136
137
138
139
140
141

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

142
    BaseTextEditorEditable *editableInterface() const;
con's avatar
con committed
143
144
145
    ITextMarkable *markableInterface() const;

    virtual void triggerCompletions();
Roberto Raggi's avatar
Roberto Raggi committed
146
    virtual void triggerQuickFix();
con's avatar
con committed
147
148
149
150
151
152
153
154
155
156

    QChar characterAt(int pos) const;

    void print(QPrinter *);

    void setSuggestedFileName(const QString &suggestedFileName);
    QString mimeType() const;
    void setMimeType(const QString &mt);


157
158
    void appendStandardContextMenuActions(QMenu *menu);

con's avatar
con committed
159
160
161
162
163
    // Works only in conjunction with a syntax highlighter that puts
    // parentheses into text block user data
    void setParenthesesMatchingEnabled(bool b);
    bool isParenthesesMatchingEnabled() const;

164
165
166
    void setAutoParenthesesEnabled(bool b);
    bool isAutoParenthesesEnabled() const;

con's avatar
con committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    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;

    void setCodeFoldingVisible(bool b);
    bool codeFoldingVisible() const;

185
186
187
    void setCodeFoldingSupported(bool b);
    bool codeFoldingSupported() const;

188
189
190
    void setMouseNavigationEnabled(bool b);
    bool mouseNavigationEnabled() const;

191
192
193
    void setScrollWheelZoomingEnabled(bool b);
    bool scrollWheelZoomingEnabled() const;

con's avatar
con committed
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    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);

208
209
    void setTextCursor(const QTextCursor &cursor);

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

212
213
214

    int verticalBlockSelection() const;

con's avatar
con committed
215
216
217
public slots:
    void setDisplayName(const QString &title);

mae's avatar
mae committed
218
219
    virtual void paste();
    virtual void cut();
con's avatar
con committed
220
221
222

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

225
    void cutLine();
con's avatar
con committed
226
    void deleteLine();
mae's avatar
mae committed
227
228
229
    void unfoldAll();
    void fold();
    void unfold();
con's avatar
con committed
230
231
    void selectEncoding();

232
233
234
235
236
    void gotoBlockStart();
    void gotoBlockEnd();
    void gotoBlockStartWithSelection();
    void gotoBlockEndWithSelection();

mae's avatar
mae committed
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    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();
253

254
255
256
    void selectBlockUp();
    void selectBlockDown();

257
258
259
    void moveLineUp();
    void moveLineDown();

260
261
262
    void copyLineUp();
    void copyLineDown();

263
    void joinLines();
264

265
266
267
    void insertLineAbove();
    void insertLineBelow();

268
269
    void cleanWhitespace();

con's avatar
con committed
270
271
272
273
274
275
276
277
278
279
280
signals:
    void changed();

    // ITextEditor
    void contentsChanged();

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

mae's avatar
mae committed
284
285
    void showEvent(QShowEvent *);

con's avatar
con committed
286
287
288
289
290
    // reimplemented to support block selection
    QMimeData *createMimeDataFromSelection() const;
    bool canInsertFromMimeData(const QMimeData *source) const;
    void insertFromMimeData(const QMimeData *source);

291
292
293
private:
    void maybeSelectLine();

con's avatar
con committed
294
295
public:
    void duplicateFrom(BaseTextEditor *editor);
296

con's avatar
con committed
297
298
299
300
301
302
303
304
305
306
307
308
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);
    void memorizeCursorPosition();
    void restoreCursorPosition();
309
    void highlightSearchResults(const QString &txt, Find::IFindSupport::FindFlags findFlags);
mae's avatar
mae committed
310
    void setFindScope(const QTextCursor &start, const QTextCursor &end, int);
con's avatar
con committed
311
    void currentEditorChanged(Core::IEditor *editor);
312
    void maybeEmitContentsChangedBecauseOfUndo();
con's avatar
con committed
313
314
315
316

private:
    Internal::BaseTextEditorPrivate *d;
    friend class Internal::BaseTextEditorPrivate;
317
    friend class Internal::TextEditorOverlay;
con's avatar
con committed
318
319
320
321
322
323

public:
    QWidget *extraArea() const;
    virtual int extraAreaWidth(int *markWidthPtr = 0) const;
    virtual void extraAreaPaintEvent(QPaintEvent *);
    virtual void extraAreaLeaveEvent(QEvent *);
324
    virtual void extraAreaMouseEvent(QMouseEvent *);
con's avatar
con committed
325
326
327
328
329
330
331
332

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

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

333
334
335
336
337
    enum ExtraSelectionKind {
        CurrentLineSelection,
        ParenthesesMatchingSelection,
        CodeWarningsSelection,
        CodeSemanticsSelection,
338
        UndefinedSymbolSelection,
Roberto Raggi's avatar
Roberto Raggi committed
339
        UnusedSymbolSelection,
hjk's avatar
hjk committed
340
        FakeVimSelection,
Roberto Raggi's avatar
Roberto Raggi committed
341
        OtherSelection,
342
        SnippetPlaceholderSelection,
Roberto Raggi's avatar
Roberto Raggi committed
343
        TypeSelection,
344
345
346
347
        NExtraSelectionKinds
    };
    void setExtraSelections(ExtraSelectionKind kind, const QList<QTextEdit::ExtraSelection> &selections);
    QList<QTextEdit::ExtraSelection> extraSelections(ExtraSelectionKind kind) const;
348
    QString extraSelectionTooltip(int pos) const;
con's avatar
con committed
349

350
351
352
353
354
355
    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
356
357
358
359
360
361
        int first;
        int last;
        inline bool isNull() const { return last < first; }
    };

    // the blocks list must be sorted
362
    void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
con's avatar
con committed
363
364

public slots:
365
    virtual void format();
366
    virtual void rewrapParagraph();
367
368
    virtual void unCommentSelection();
    virtual void setFontSettings(const TextEditor::FontSettings &);
mae's avatar
mae committed
369
    void setFontSettingsIfVisible(const TextEditor::FontSettings &);
con's avatar
con committed
370
371
    virtual void setTabSettings(const TextEditor::TabSettings &);
    virtual void setDisplaySettings(const TextEditor::DisplaySettings &);
372
    virtual void setBehaviorSettings(const TextEditor::BehaviorSettings &);
373
    virtual void setStorageSettings(const TextEditor::StorageSettings &);
374
    virtual void setCompletionSettings(const TextEditor::CompletionSettings &);
con's avatar
con committed
375
376
377
378
379
380
381
382
383

protected:
    bool viewportEvent(QEvent *event);

    void resizeEvent(QResizeEvent *);
    void paintEvent(QPaintEvent *);
    void timerEvent(QTimerEvent *);
    void mouseMoveEvent(QMouseEvent *);
    void mousePressEvent(QMouseEvent *);
384
385
386
    void mouseReleaseEvent(QMouseEvent *);
    void leaveEvent(QEvent *);
    void keyReleaseEvent(QKeyEvent *);
con's avatar
con committed
387

388
389
    void dragEnterEvent(QDragEnterEvent *e);

390
public:
391
    // Returns true if key triggers an indent.
con's avatar
con committed
392
    virtual bool isElectricCharacter(const QChar &ch) const;
393
394
395

    void indentInsertedText(const QTextCursor &tc);

396
protected:
397
398
399
400
    // Returns the text to complete at the cursor position, or an empty string
    virtual QString autoComplete(QTextCursor &cursor, const QString &text) const;
    // Handles backspace. When returning true, backspace processing is stopped
    virtual bool autoBackspace(QTextCursor &cursor);
401
402
    // Hook to insert special characters on enter. Returns the number of extra blocks inserted.
    virtual int paragraphSeparatorAboutToBeInserted(QTextCursor &cursor);
con's avatar
con committed
403
404
405
406
    // Indent a text block based on previous line. Default does nothing
    virtual void indentBlock(QTextDocument *doc, QTextBlock block, QChar typedChar);
    // Indent at cursor. Calls indentBlock for selection or current line.
    virtual void indent(QTextDocument *doc, const QTextCursor &cursor, QChar typedChar);
mae's avatar
mae committed
407
408
    // Reindent at cursor. Selection will be adjusted according to the indentation change of the first block
    virtual void reindent(QTextDocument *doc, const QTextCursor &cursor);
con's avatar
con committed
409

410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
    virtual bool contextAllowsAutoParentheses(const QTextCursor &cursor, const QString &textToInsert = QString()) const;

    // Returns true if the cursor is inside a comment.
    virtual bool isInComment(const QTextCursor &cursor) const;

    virtual QString insertMatchingBrace(const QTextCursor &tc, const QString &text, const QChar &la, int *skippedChars) const;

    // Returns the text that needs to be inserted
    virtual QString insertParagraphSeparator(const QTextCursor &tc) const;

    static void countBracket(QChar open, QChar close, QChar c, int *errors, int *stillopen);

    static void countBrackets(QTextCursor cursor, int from, int end, QChar open, QChar close,
                              int *errors, int *stillopen);

425
426
427
428
429
    struct Link
    {
        Link(const QString &fileName = QString(),
             int line = 0,
             int column = 0)
430
431
            : begin(-1)
            , end(-1)
432
433
434
435
436
437
            , fileName(fileName)
            , line(line)
            , column(column)
        {}

        bool isValid() const
438
        { return begin != end; }
439

440
        bool operator==(const Link &other) const
441
        { return begin == other.begin && end == other.end; }
442

443
444
        int begin;           // Link position
        int end;           // Link end position
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460

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

    /*!
       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
461
       opened. Returns whether the link was opened successfully.
462
463
464
     */
    virtual bool openLink(const Link &link);

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

private:
    void indentOrUnindent(bool doIndent);
    void handleHomeKey(bool anchor);
    void handleBackspaceKey();
483
    void moveLineUpDown(bool up);
484
    void copyLineUpDown(bool up);
485
    void saveCurrentCursorPositionForNavigation();
con's avatar
con committed
486
    void updateHighlights();
487
    void updateCurrentLineHighlight();
con's avatar
con committed
488

489
490
491
492
493
    void drawFoldingMarker(QPainter *painter, const QPalette &pal,
                           const QRect &rect,
                           bool expanded,
                           bool active,
                           bool hovered) const;
494

con's avatar
con committed
495
    void toggleBlockVisible(const QTextBlock &block);
mae's avatar
mae committed
496
    QRect foldBox();
con's avatar
con committed
497

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

500
    void updateLink(QMouseEvent *e);
501
502
    void showLink(const Link &);
    void clearLink();
mae's avatar
mae committed
503

504
505
    void universalHelper(); // test function for development

con's avatar
con committed
506
507
508
    // parentheses matcher
private slots:
    void _q_matchParentheses();
509
    void _q_highlightBlocks();
con's avatar
con committed
510
    void slotSelectionChanged();
511
    void _q_animateUpdate(int position, QPointF lastPos, QRectF rect);
con's avatar
con committed
512
513
514
};


515
class TEXTEDITOR_EXPORT BaseTextEditorEditable : public ITextEditable
con's avatar
con committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
{
    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(); }
    inline void setDisplayName(const QString &title) { e->setDisplayName(title); }

    inline QByteArray saveState() const { return e->saveState(); }
    inline bool restoreState(const QByteArray &state) { return e->restoreState(state); }
con's avatar
con committed
538
    QWidget *toolBar();
con's avatar
con committed
539
540
541
542
543
544

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

    int currentLine() const;
    int currentColumn() const;
545
    void gotoLine(int line, int column = 0) { e->gotoLine(line, column); }
con's avatar
con committed
546
547
548
549
550
551
552
553
554
555
556
557
558

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

con's avatar
con committed
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
    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;
584
    Utils::LineColumnLabel *m_cursorPositionLabel;
con's avatar
con committed
585
586
587
588
589
};

} // namespace TextEditor

#endif // BASETEXTEDITOR_H