basetexteditor.h 24.1 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
#include <QtGui/QPlainTextEdit>
38
#include <QtGui/QTextBlockUserData>
con's avatar
con committed
39 40

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

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

namespace TextEditor {

namespace Internal {
    class BaseTextEditorPrivate;
55
    class TextEditorOverlay;
con's avatar
con committed
56 57 58 59 60 61 62 63
}

class ITextMark;
class ITextMarkable;

class TextEditorActionHandler;
class BaseTextDocument;
class FontSettings;
64
struct BehaviorSettings;
65
struct DisplaySettings;
con's avatar
con committed
66
struct StorageSettings;
67
struct TabSettings;
con's avatar
con committed
68 69 70

struct Parenthesis;
typedef QVector<Parenthesis> Parentheses;
71

con's avatar
con committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
struct TEXTEDITOR_EXPORT Parenthesis
{
    enum Type { Opened, Closed };

    inline Parenthesis() : type(Opened), pos(-1) {}
    inline Parenthesis(Type t, QChar c, int position)
        : type(t), chr(c), pos(position) {}
    Type type;
    QChar chr;
    int pos;
    static int collapseAtPos(const Parentheses &parentheses, QChar *character = 0);
    static int closeCollapseAtPos(const Parentheses &parentheses);
    static bool hasClosingCollapse(const Parentheses &parentheses);
};


88 89
class TEXTEDITOR_EXPORT TextBlockUserData : public QTextBlockUserData
{
con's avatar
con committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
public:

    enum CollapseMode { NoCollapse , CollapseThis, CollapseAfter };
    enum ClosingCollapseMode { NoClosingCollapse, ClosingCollapse, ClosingCollapseAtEnd };

    inline TextBlockUserData()
        : m_collapseIncludesClosure(false),
          m_collapseMode(NoCollapse),
          m_closingCollapseMode(NoClosingCollapse),
          m_collapsed(false),
          m_ifdefedOut(false) {}
    ~TextBlockUserData();

    inline TextMarks marks() const { return m_marks; }
    inline void addMark(ITextMark *mark) { m_marks += mark; }
    inline bool removeMark(ITextMark *mark) { return m_marks.removeAll(mark); }
    inline bool hasMark(ITextMark *mark) const { return m_marks.contains(mark); }
    inline void clearMarks() { m_marks.clear(); }
    inline void documentClosing() { Q_FOREACH(ITextMark *tm, m_marks) { tm->documentClosing(); } m_marks.clear();}

    inline CollapseMode collapseMode() const { return (CollapseMode)m_collapseMode; }
    inline void setCollapseMode(CollapseMode c) { m_collapseMode = c; }

    inline void setClosingCollapseMode(ClosingCollapseMode c) { m_closingCollapseMode = c; }
    inline ClosingCollapseMode closingCollapseMode() const { return (ClosingCollapseMode) m_closingCollapseMode; }

    inline bool hasClosingCollapse() const { return closingCollapseMode() != NoClosingCollapse; }
    inline bool hasClosingCollapseAtEnd() const { return closingCollapseMode() == ClosingCollapseAtEnd; }
    inline bool hasClosingCollapseInside() const { return closingCollapseMode() == ClosingCollapse; }

    inline void setCollapsed(bool b) { m_collapsed = b; }
    inline bool collapsed() const { return m_collapsed; }

    inline void setCollapseIncludesClosure(bool b) { m_collapseIncludesClosure = b; }
    inline bool collapseIncludesClosure() const { return m_collapseIncludesClosure; }

    inline void setParentheses(const Parentheses &parentheses) { m_parentheses = parentheses; }
    inline void clearParentheses() { m_parentheses.clear(); }
    inline const Parentheses &parentheses() const { return m_parentheses; }
    inline bool hasParentheses() const { return !m_parentheses.isEmpty(); }
130
    int braceDepthDelta() const;
con's avatar
con committed
131 132 133 134 135

    inline bool setIfdefedOut() { bool result = m_ifdefedOut; m_ifdefedOut = true; return !result; }
    inline bool clearIfdefedOut() { bool result = m_ifdefedOut; m_ifdefedOut = false; return result;}
    inline bool ifdefedOut() const { return m_ifdefedOut; }

136
    inline static TextBlockUserData *canCollapse(const QTextBlock &block) {
con's avatar
con committed
137 138 139
        TextBlockUserData *data = static_cast<TextBlockUserData*>(block.userData());
        if (!data || data->collapseMode() != CollapseAfter) {
            data = static_cast<TextBlockUserData*>(block.next().userData());
mae's avatar
mae committed
140
            if (!data || data->collapseMode() != TextBlockUserData::CollapseThis)
con's avatar
con committed
141 142
                data = 0;
        }
mae's avatar
mae committed
143 144
        if (data && data->m_ifdefedOut)
            data = 0;
con's avatar
con committed
145 146 147
        return data;
    }

148 149
    inline static bool hasCollapseAfter(const QTextBlock & block)
    {
150
        if (!block.isValid()) {
mae's avatar
mae committed
151 152
            return false;
        } else if (block.next().isValid()) {
153
            TextBlockUserData *data = static_cast<TextBlockUserData*>(block.next().userData());
154 155 156 157 158 159
            if (data && data->collapseMode() == TextBlockUserData::CollapseThis &&  !data->m_ifdefedOut)
                return true;
        }
        return false;
    }

con's avatar
con committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
    inline static bool hasClosingCollapse(const QTextBlock &block) {
        TextBlockUserData *data = static_cast<TextBlockUserData*>(block.userData());
        return (data && data->hasClosingCollapse());
    }

    inline static bool hasClosingCollapseAtEnd(const QTextBlock &block) {
        TextBlockUserData *data = static_cast<TextBlockUserData*>(block.userData());
        return (data && data->hasClosingCollapseAtEnd());
    }

    inline static bool hasClosingCollapseInside(const QTextBlock &block) {
        TextBlockUserData *data = static_cast<TextBlockUserData*>(block.userData());
        return (data && data->hasClosingCollapseInside());
    }

    static QTextBlock testCollapse(const QTextBlock& block);
    static void doCollapse(const QTextBlock& block, bool visible);

178
    int collapseAtPos(QChar *character = 0) const;
con's avatar
con committed
179 180 181 182 183 184

    enum MatchType { NoMatch, Match, Mismatch  };
    static MatchType checkOpenParenthesis(QTextCursor *cursor, QChar c);
    static MatchType checkClosedParenthesis(QTextCursor *cursor, QChar c);
    static MatchType matchCursorBackward(QTextCursor *cursor);
    static MatchType matchCursorForward(QTextCursor *cursor);
185 186
    static bool findPreviousOpenParenthesis(QTextCursor *cursor, bool select = false);
    static bool findNextClosingParenthesis(QTextCursor *cursor, bool select = false);
con's avatar
con committed
187

mae's avatar
mae committed
188
    static bool findPreviousBlockOpenParenthesis(QTextCursor *cursor, bool checkStartPosition = false);
189 190
    static bool findNextBlockClosingParenthesis(QTextCursor *cursor);

con's avatar
con committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

private:
    TextMarks m_marks;
    uint m_collapseIncludesClosure : 1;
    uint m_collapseMode : 4;
    uint m_closingCollapseMode : 4;
    uint m_collapsed : 1;
    uint m_ifdefedOut : 1;
    Parentheses m_parentheses;
};


class TEXTEDITOR_EXPORT TextEditDocumentLayout : public QPlainTextDocumentLayout
{
    Q_OBJECT

public:
    TextEditDocumentLayout(QTextDocument *doc);
    ~TextEditDocumentLayout();

    QRectF blockBoundingRect(const QTextBlock &block) const;

    static void setParentheses(const QTextBlock &block, const Parentheses &parentheses);
    static void clearParentheses(const QTextBlock &block) { setParentheses(block, Parentheses());}
    static Parentheses parentheses(const QTextBlock &block);
    static bool hasParentheses(const QTextBlock &block);
    static bool setIfdefedOut(const QTextBlock &block);
    static bool clearIfdefedOut(const QTextBlock &block);
    static bool ifdefedOut(const QTextBlock &block);
220 221 222 223
    static int braceDepthDelta(const QTextBlock &block);
    static int braceDepth(const QTextBlock &block);
    static void setBraceDepth(QTextBlock &block, int depth);
    static void changeBraceDepth(QTextBlock &block, int delta);
con's avatar
con committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

    static TextBlockUserData *testUserData(const QTextBlock &block) {
        return static_cast<TextBlockUserData*>(block.userData());
    }
    static TextBlockUserData *userData(const QTextBlock &block) {
        TextBlockUserData *data = static_cast<TextBlockUserData*>(block.userData());
        if (!data && block.isValid())
            const_cast<QTextBlock &>(block).setUserData((data = new TextBlockUserData));
        return data;
    }


    void emitDocumentSizeChanged() { emit documentSizeChanged(documentSize()); }
    int lastSaveRevision;
    bool hasMarks;
};


class BaseTextEditorEditable;

244 245 246 247 248 249 250
class TEXTEDITOR_EXPORT BaseTextEditorAnimator : public QObject
{
    Q_OBJECT

public:
    BaseTextEditorAnimator(QObject *parent);

251 252
    inline void setPosition(int position) { m_position = position; }
    inline int position() const { return m_position; }
253 254 255 256 257 258

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

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

259 260
    inline qreal value() const { return m_value; }
    inline QPointF lastDrawPos() const { return m_lastDrawPos; }
261 262 263

    void finish();

mae's avatar
mae committed
264 265
    bool isRunning() const;

266
signals:
267
    void updateRequest(int position, QPointF lastPos, QRectF rect);
268 269 270 271 272 273 274 275 276


private slots:
    void step(qreal v);

private:
    QTimeLine *m_timeline;
    qreal m_value;
    int m_position;
277
    QPointF m_lastDrawPos;
278 279 280 281 282 283 284
    QFont m_font;
    QPalette m_palette;
    QString m_text;
    QSizeF m_size;
};


285
class TEXTEDITOR_EXPORT BaseTextEditor : public QPlainTextEdit
con's avatar
con committed
286 287
{
    Q_OBJECT
288
    Q_PROPERTY(int verticalBlockSelection READ verticalBlockSelection)
con's avatar
con committed
289 290 291 292 293

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

294
    static ITextEditor *openEditorAt(const QString &fileName, int line, int column = 0,
295 296
                                     const QString &editorId = QString(),
                                     bool *newEditor = 0);
con's avatar
con committed
297

298 299 300
    const Utils::ChangeSet &changeSet() const;
    void setChangeSet(const Utils::ChangeSet &changeSet);

con's avatar
con committed
301 302 303
    // EditorInterface
    Core::IFile * file();
    bool createNew(const QString &contents);
Lasse Holmstedt's avatar
Lasse Holmstedt committed
304
    virtual bool open(const QString &fileName = QString());
con's avatar
con committed
305 306 307 308 309 310
    QByteArray saveState() const;
    bool restoreState(const QByteArray &state);
    QString displayName() const;

    // ITextEditor

311
    void gotoLine(int line, int column = 0);
con's avatar
con committed
312 313 314 315 316 317 318 319 320 321

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

    ITextEditable *editableInterface() const;
    ITextMarkable *markableInterface() const;

    virtual void triggerCompletions();
Roberto Raggi's avatar
Roberto Raggi committed
322
    virtual void triggerQuickFix();
con's avatar
con committed
323 324 325 326 327 328 329 330 331 332

    QChar characterAt(int pos) const;

    void print(QPrinter *);

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


333 334
    void appendStandardContextMenuActions(QMenu *menu);

con's avatar
con committed
335 336 337 338 339 340 341 342 343 344 345
    // 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;

346

con's avatar
con committed
347 348 349 350 351 352 353 354 355 356 357 358
    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;

359 360 361
    void setCodeFoldingSupported(bool b);
    bool codeFoldingSupported() const;

362 363 364
    void setMouseNavigationEnabled(bool b);
    bool mouseNavigationEnabled() const;

365 366 367
    void setScrollWheelZoomingEnabled(bool b);
    bool scrollWheelZoomingEnabled() const;

con's avatar
con committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381
    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);

382 383
    void setTextCursor(const QTextCursor &cursor);

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

386 387 388

    int verticalBlockSelection() const;

con's avatar
con committed
389 390 391
public slots:
    void setDisplayName(const QString &title);

mae's avatar
mae committed
392 393
    virtual void paste();
    virtual void cut();
con's avatar
con committed
394 395 396

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

399
    void cutLine();
con's avatar
con committed
400 401 402 403 404 405
    void deleteLine();
    void unCollapseAll();
    void collapse();
    void expand();
    void selectEncoding();

406 407 408 409 410
    void gotoBlockStart();
    void gotoBlockEnd();
    void gotoBlockStartWithSelection();
    void gotoBlockEndWithSelection();

411 412 413
    void selectBlockUp();
    void selectBlockDown();

414 415 416
    void moveLineUp();
    void moveLineDown();

417 418 419
    void copyLineUp();
    void copyLineDown();

420
    void joinLines();
421

422 423
    void cleanWhitespace();

con's avatar
con committed
424 425 426 427 428 429 430 431 432 433 434
signals:
    void changed();

    // ITextEditor
    void contentsChanged();

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

mae's avatar
mae committed
438 439
    void showEvent(QShowEvent *);

con's avatar
con committed
440 441 442 443 444
    // reimplemented to support block selection
    QMimeData *createMimeDataFromSelection() const;
    bool canInsertFromMimeData(const QMimeData *source) const;
    void insertFromMimeData(const QMimeData *source);

445 446 447
private:
    void maybeSelectLine();

con's avatar
con committed
448 449
public:
    void duplicateFrom(BaseTextEditor *editor);
450

con's avatar
con committed
451 452 453 454 455 456 457 458 459 460 461 462
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();
463
    void highlightSearchResults(const QString &txt, Find::IFindSupport::FindFlags findFlags);
464
    void setFindScope(const QTextCursor &, int);
con's avatar
con committed
465
    void currentEditorChanged(Core::IEditor *editor);
466
    void maybeEmitContentsChangedBecauseOfUndo();
con's avatar
con committed
467 468 469 470

private:
    Internal::BaseTextEditorPrivate *d;
    friend class Internal::BaseTextEditorPrivate;
471
    friend class Internal::TextEditorOverlay;
con's avatar
con committed
472 473 474 475 476 477

public:
    QWidget *extraArea() const;
    virtual int extraAreaWidth(int *markWidthPtr = 0) const;
    virtual void extraAreaPaintEvent(QPaintEvent *);
    virtual void extraAreaLeaveEvent(QEvent *);
478
    virtual void extraAreaMouseEvent(QMouseEvent *);
con's avatar
con committed
479 480 481 482 483 484 485 486

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

    void markBlocksAsChanged(QList<int> blockNumbers);

    void ensureCursorVisible();

487 488 489 490 491
    enum ExtraSelectionKind {
        CurrentLineSelection,
        ParenthesesMatchingSelection,
        CodeWarningsSelection,
        CodeSemanticsSelection,
Roberto Raggi's avatar
Roberto Raggi committed
492
        UnusedSymbolSelection,
hjk's avatar
hjk committed
493
        FakeVimSelection,
Roberto Raggi's avatar
Roberto Raggi committed
494
        OtherSelection,
495
        SnippetPlaceholderSelection,
496 497 498 499
        NExtraSelectionKinds
    };
    void setExtraSelections(ExtraSelectionKind kind, const QList<QTextEdit::ExtraSelection> &selections);
    QList<QTextEdit::ExtraSelection> extraSelections(ExtraSelectionKind kind) const;
500
    QString extraSelectionTooltip(int pos) const;
con's avatar
con committed
501

502 503 504 505 506 507
    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
508 509 510 511 512 513
        int first;
        int last;
        inline bool isNull() const { return last < first; }
    };

    // the blocks list must be sorted
514
    void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
con's avatar
con committed
515 516

public slots:
517
    virtual void format();
518
    virtual void rewrapParagraph();
519 520
    virtual void unCommentSelection();
    virtual void setFontSettings(const TextEditor::FontSettings &);
mae's avatar
mae committed
521
    void setFontSettingsIfVisible(const TextEditor::FontSettings &);
con's avatar
con committed
522 523
    virtual void setTabSettings(const TextEditor::TabSettings &);
    virtual void setDisplaySettings(const TextEditor::DisplaySettings &);
524
    virtual void setBehaviorSettings(const TextEditor::BehaviorSettings &);
525
    virtual void setStorageSettings(const TextEditor::StorageSettings &);
con's avatar
con committed
526 527 528 529 530 531 532 533 534

protected:
    bool viewportEvent(QEvent *event);

    void resizeEvent(QResizeEvent *);
    void paintEvent(QPaintEvent *);
    void timerEvent(QTimerEvent *);
    void mouseMoveEvent(QMouseEvent *);
    void mousePressEvent(QMouseEvent *);
535 536 537
    void mouseReleaseEvent(QMouseEvent *);
    void leaveEvent(QEvent *);
    void keyReleaseEvent(QKeyEvent *);
con's avatar
con committed
538

539 540
    void dragEnterEvent(QDragEnterEvent *e);

541
public:
542
    // Returns true if key triggers an indent.
con's avatar
con committed
543
    virtual bool isElectricCharacter(const QChar &ch) const;
544 545 546

    void indentInsertedText(const QTextCursor &tc);

547
protected:
548 549 550 551
    // 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);
552 553
    // Hook to insert special characters on enter. Returns the number of extra blocks inserted.
    virtual int paragraphSeparatorAboutToBeInserted(QTextCursor &cursor);
con's avatar
con committed
554 555 556 557
    // 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
558 559
    // 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
560

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    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);

576 577 578 579 580
    struct Link
    {
        Link(const QString &fileName = QString(),
             int line = 0,
             int column = 0)
581 582
            : begin(-1)
            , end(-1)
583 584 585 586 587 588
            , fileName(fileName)
            , line(line)
            , column(column)
        {}

        bool isValid() const
589
        { return begin != end; }
590

591
        bool operator==(const Link &other) const
592
        { return begin == other.begin && end == other.end; }
593

594 595
        int begin;           // Link position
        int end;           // Link end position
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

        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
612
       opened. Returns whether the link was opened successfully.
613 614 615
     */
    virtual bool openLink(const Link &link);

con's avatar
con committed
616 617 618 619 620 621 622 623
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
624 625
    void requestFontZoom(int zoom);
    void requestZoomReset();
con's avatar
con committed
626
    void requestBlockUpdate(const QTextBlock &);
627 628
    void requestAutoCompletion(TextEditor::ITextEditable *editor, bool forced);
    void requestQuickFix(TextEditor::ITextEditable *editor);
con's avatar
con committed
629 630 631 632 633

private:
    void indentOrUnindent(bool doIndent);
    void handleHomeKey(bool anchor);
    void handleBackspaceKey();
634
    void moveLineUpDown(bool up);
635
    void copyLineUpDown(bool up);
636
    void saveCurrentCursorPositionForNavigation();
con's avatar
con committed
637
    void updateHighlights();
638
    void updateCurrentLineHighlight();
con's avatar
con committed
639

640 641 642 643 644
    void drawFoldingMarker(QPainter *painter, const QPalette &pal,
                           const QRect &rect,
                           bool expanded,
                           bool active,
                           bool hovered) const;
645

con's avatar
con committed
646
    void toggleBlockVisible(const QTextBlock &block);
647
    QRect collapseBox();
con's avatar
con committed
648 649 650

    QTextBlock collapsedBlockAt(const QPoint &pos, QRect *box = 0) const;

651
    void updateLink(QMouseEvent *e);
652 653
    void showLink(const Link &);
    void clearLink();
mae's avatar
mae committed
654

655 656
    void universalHelper(); // test function for development

con's avatar
con committed
657 658 659
    // parentheses matcher
private slots:
    void _q_matchParentheses();
660
    void _q_highlightBlocks();
con's avatar
con committed
661
    void slotSelectionChanged();
662
    void _q_animateUpdate(int position, QPointF lastPos, QRectF rect);
con's avatar
con committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
};


class TEXTEDITOR_EXPORT BaseTextEditorEditable
  : public ITextEditable
{
    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
690
    QWidget *toolBar();
con's avatar
con committed
691 692 693 694 695 696

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

    int currentLine() const;
    int currentColumn() const;
697
    void gotoLine(int line, int column = 0) { e->gotoLine(line, column); }
con's avatar
con committed
698 699 700 701 702 703 704 705 706 707 708 709 710

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

con's avatar
con committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    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;
736
    Utils::LineColumnLabel *m_cursorPositionLabel;
con's avatar
con committed
737 738 739 740 741
};

} // namespace TextEditor

#endif // BASETEXTEDITOR_H