fakevimhandler.cpp 153 KB
Newer Older
1
/**************************************************************************
hjk's avatar
hjk 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).
hjk's avatar
hjk committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
hjk's avatar
hjk committed
8
**
9
** Commercial Usage
hjk's avatar
hjk committed
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.
hjk's avatar
hjk committed
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
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.
hjk's avatar
hjk committed
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.
hjk's avatar
hjk committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

30
//
31
32
33
34
35
36
37
38
39
40
41
// ATTENTION:
//
// 1 Please do not add any direct dependencies to other Qt Creator code here.
//   Instead emit signals and let the FakeVimPlugin channel the information to
//   Qt Creator. The idea is to keep this file here in a "clean" state that
//   allows easy reuse with any QTextEdit or QPlainTextEdit derived class.
//
// 2 There are a few auto tests located in ../../../tests/auto/fakevim.
//   Commands that are covered there are marked as "// tested" below.
//
// 3 Some conventions:
42
//
43
44
45
//   Use 1 based line numbers and 0 based column numbers. Even though
//   the 1 based line are not nice it matches vim's and QTextEdit's 'line'
//   concepts.
46
//
47
48
49
//   Do not pass QTextCursor etc around unless really needed. Convert
//   early to  line/column.
//
50
51
52
53
//   A QTextCursor is always between characters, whereas vi's cursor is always
//   over a character. FakeVim interprets the QTextCursor to be over the character
//   to the right of the QTextCursor's position().
//
54
//   There is always a "current" cursor (m_tc). A current "region of interest"
55
56
57
//   spans between m_anchor (== anchor()), i.e. the character below anchor()), and
//   m_tc.position() (== position()). The character below position() is not included
//   if the last movement command was exclusive (MoveExclusive).
58
//   The value of m_tc.anchor() is not used.
hjk's avatar
hjk committed
59
//
60

61
62
63
#include "fakevimhandler.h"
#include "fakevimsyntax.h"

hjk's avatar
hjk committed
64
#include <utils/qtcassert.h>
65

hjk's avatar
hjk committed
66
#include <QtCore/QDebug>
67
#include <QtCore/QFile>
hjk's avatar
hjk committed
68
#include <QtCore/QObject>
69
#include <QtCore/QPointer>
hjk's avatar
hjk committed
70
#include <QtCore/QProcess>
hjk's avatar
hjk committed
71
#include <QtCore/QRegExp>
72
#include <QtCore/QTextStream>
hjk's avatar
hjk committed
73
#include <QtCore/QTimer>
hjk's avatar
hjk committed
74
#include <QtCore/QtAlgorithms>
hjk's avatar
hjk committed
75
76
#include <QtCore/QStack>

hjk's avatar
hjk committed
77
#include <QtGui/QApplication>
hjk's avatar
hjk committed
78
#include <QtGui/QInputMethodEvent>
hjk's avatar
hjk committed
79
80
81
82
83
84
#include <QtGui/QKeyEvent>
#include <QtGui/QLineEdit>
#include <QtGui/QPlainTextEdit>
#include <QtGui/QScrollBar>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
hjk's avatar
hjk committed
85
#include <QtGui/QTextDocumentFragment>
hjk's avatar
hjk committed
86
#include <QtGui/QTextEdit>
hjk's avatar
hjk committed
87

88
#include <algorithm>
89
#include <climits>
90
#include <ctype.h>
91

92
93
94
95
96
97
98
//#define DEBUG_KEY  1
#if DEBUG_KEY
#   define KEY_DEBUG(s) qDebug() << s
#else
#   define KEY_DEBUG(s)
#endif

99
100
//#define DEBUG_UNDO  1
#if DEBUG_UNDO
101
#   define UNDO_DEBUG(s) qDebug() << << m_tc.document()->availableUndoSteps() << s
102
103
104
105
#else
#   define UNDO_DEBUG(s)
#endif

106
using namespace Utils;
hjk's avatar
hjk committed
107
108
109
110

namespace FakeVim {
namespace Internal {

hjk's avatar
hjk committed
111
112
113
114
115
116
///////////////////////////////////////////////////////////////////////
//
// FakeVimHandler
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
117
118
119
120
121
122
123
124
125
126
#define StartOfLine     QTextCursor::StartOfLine
#define EndOfLine       QTextCursor::EndOfLine
#define MoveAnchor      QTextCursor::MoveAnchor
#define KeepAnchor      QTextCursor::KeepAnchor
#define Up              QTextCursor::Up
#define Down            QTextCursor::Down
#define Right           QTextCursor::Right
#define Left            QTextCursor::Left
#define EndOfDocument   QTextCursor::End
#define StartOfDocument QTextCursor::Start
hjk's avatar
hjk committed
127

128
129
#define EDITOR(s) (m_textedit ? m_textedit->s : m_plaintextedit->s)

hjk's avatar
hjk committed
130
const int ParagraphSeparator = 0x00002029;
hjk's avatar
hjk committed
131
typedef QLatin1String _;
hjk's avatar
hjk committed
132
133
134

using namespace Qt;

hjk's avatar
hjk committed
135
136
/*! A \e Mode represents one of the basic modes of operation of FakeVim.
*/
137

hjk's avatar
hjk committed
138
139
140
enum Mode
{
    InsertMode,
hjk's avatar
hjk committed
141
    ReplaceMode,
hjk's avatar
hjk committed
142
    CommandMode,
143
    ExMode,
hjk's avatar
hjk committed
144
};
hjk's avatar
hjk committed
145

hjk's avatar
hjk committed
146
147
148
/*! A \e SubMode is used for things that require one more data item
    and are 'nested' behind a \l Mode.
*/
hjk's avatar
hjk committed
149
150
151
enum SubMode
{
    NoSubMode,
hjk's avatar
hjk committed
152
153
154
155
156
157
158
159
160
161
162
163
164
    ChangeSubMode,     // Used for c
    DeleteSubMode,     // Used for d
    FilterSubMode,     // Used for !
    IndentSubMode,     // Used for =
    RegisterSubMode,   // Used for "
    ShiftLeftSubMode,  // Used for <
    ShiftRightSubMode, // Used for >
    TransformSubMode,  // Used for ~/gu/gU
    WindowSubMode,     // Used for Ctrl-w
    YankSubMode,       // Used for y
    ZSubMode,          // Used for z
    CapitalZSubMode,   // Used for Z
    ReplaceSubMode,    // Used for r
hjk's avatar
hjk committed
165
};
hjk's avatar
hjk committed
166

hjk's avatar
hjk committed
167
168
169
/*! A \e SubSubMode is used for things that require one more data item
    and are 'nested' behind a \l SubMode.
*/
hjk's avatar
hjk committed
170
171
172
enum SubSubMode
{
    NoSubSubMode,
hjk's avatar
hjk committed
173
174
175
176
177
178
179
180
181
    FtSubSubMode,         // Used for f, F, t, T.
    MarkSubSubMode,       // Used for m.
    BackTickSubSubMode,   // Used for `.
    TickSubSubMode,       // Used for '.
    InvertCaseSubSubMode, // Used for ~.
    DownCaseSubSubMode,   // Used for gu.
    UpCaseSubSubMode,     // Used for gU.
    TextObjectSubSubMode, // Used for thing like iw, aW, as etc.
    SearchSubSubMode,
hjk's avatar
hjk committed
182
183
};

184
185
186
187
188
189
190
191
enum VisualMode
{
    NoVisualMode,
    VisualCharMode,
    VisualLineMode,
    VisualBlockMode,
};

hjk's avatar
hjk committed
192
193
194
195
enum MoveType
{
    MoveExclusive,
    MoveInclusive,
hjk's avatar
hjk committed
196
    MoveLineWise,
hjk's avatar
hjk committed
197
198
};

hjk's avatar
hjk committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*!
    \enum RangeMode

    The \e RangeMode serves as a means to define how the "Range" between
    the \l cursor and the \l anchor position is to be interpreted.

    \value RangeCharMode   Entered by pressing \key v. The range includes
                           all characters between cursor and anchor.
    \value RangeLineMode   Entered by pressing \key V. The range includes
                           all lines between the line of the cursor and
                           the line of the anchor.
    \value RangeLineModeExclusice Like \l RangeLineMode, but keeps one
                           newline when deleting.
    \value RangeBlockMode  Entered by pressing \key Ctrl-v. The range includes
                           all characters with line and column coordinates
                           between line and columns coordinates of cursor and
                           anchor.
    \value RangeBlockAndTailMode Like \l RangeBlockMode, but also includes
                           all characters in the affected lines up to the end
                           of these lines.
*/
220
221
222
223
224
225
226
227

enum EventResult
{
    EventHandled,
    EventUnhandled,
    EventPassedToCore
};

228
struct Column
229
{
230
    Column(int p, int l) : physical(p), logical(l) {}
hjk's avatar
hjk committed
231
232
    int physical; // Number of characters in the data.
    int logical; // Column on screen.
233
234
};

235
236
237
238
239
240
241
242
243
244
245
246
struct CursorPosition
{
    // for jump history
    CursorPosition() : position(-1), scrollLine(-1) {}
    CursorPosition(int pos, int line) : position(pos), scrollLine(line) {}
    int position; // Position in document
    int scrollLine; // First visible line
};

struct Register
{
    Register() : rangemode(RangeCharMode) {}
hjk's avatar
hjk committed
247
    Register(const QString &c) : contents(c), rangemode(RangeCharMode) {}
248
249
250
251
252
    Register(const QString &c, RangeMode m) : contents(c), rangemode(m) {}
    QString contents;
    RangeMode rangemode;
};

hjk's avatar
hjk committed
253
QDebug operator<<(QDebug ts, const Register &reg)
254
{
hjk's avatar
hjk committed
255
256
    return ts << reg.contents;
}
257

hjk's avatar
hjk committed
258
259
260
struct SearchData
{
    SearchData() { init(); }
261

hjk's avatar
hjk committed
262
263
    void init() { forward = true; mustMove = true; highlightMatches = true;
        highlightCursor = true; }
264

hjk's avatar
hjk committed
265
266
267
268
269
    QString needle;
    bool forward;
    bool mustMove;
    bool highlightMatches;
    bool highlightCursor;
270
271
};

hjk's avatar
hjk committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

Range::Range()
    : beginPos(-1), endPos(-1), rangemode(RangeCharMode)
{}

Range::Range(int b, int e, RangeMode m)
    : beginPos(qMin(b, e)), endPos(qMax(b, e)), rangemode(m)
{}

QString Range::toString() const
{
    return QString("%1-%2 (mode: %3)").arg(beginPos).arg(endPos)
        .arg(rangemode);
}

QDebug operator<<(QDebug ts, const Range &range)
{
    return ts << '[' << range.beginPos << ',' << range.endPos << ']';
}



ExCommand::ExCommand(const QString &c, const QString &a, const Range &r)
    : cmd(c), hasBang(false), args(a), range(r)
{}

QDebug operator<<(QDebug ts, const ExCommand &cmd)
{
    return ts << cmd.cmd << ' ' << cmd.args << ' ' << cmd.range;
}

QDebug operator<<(QDebug ts, const QList<QTextEdit::ExtraSelection> &sels)
304
{
305
    foreach (const QTextEdit::ExtraSelection &sel, sels)
306
        ts << "SEL: " << sel.cursor.anchor() << sel.cursor.position();
307
308
    return ts;
}
309

hjk's avatar
hjk committed
310
QString quoteUnprintable(const QString &ba)
hjk's avatar
hjk committed
311
{
hjk's avatar
hjk committed
312
313
    QString res;
    for (int i = 0, n = ba.size(); i != n; ++i) {
hjk's avatar
hjk committed
314
315
        const QChar c = ba.at(i);
        const int cc = c.unicode();
hjk's avatar
hjk committed
316
317
        if (c.isPrint())
            res += c;
hjk's avatar
hjk committed
318
319
        else if (cc == '\n')
            res += _("<CR>");
hjk's avatar
hjk committed
320
        else
hjk's avatar
hjk committed
321
            res += QString("\\x%1").arg(c.unicode(), 2, 16, QLatin1Char('0'));
hjk's avatar
hjk committed
322
323
    }
    return res;
hjk's avatar
hjk committed
324
325
}

326
327
328
329
330
331
332
333
334
335
336
static bool startsWithWhitespace(const QString &str, int col)
{
    QTC_ASSERT(str.size() >= col, return false);
    for (int i = 0; i < col; ++i) {
        uint u = str.at(i).unicode();
        if (u != ' ' && u != '\t')
            return false;
    }
    return true;
}

hjk's avatar
hjk committed
337
inline QString msgMarkNotSet(const QString &text)
338
{
hjk's avatar
hjk committed
339
    return FakeVimHandler::tr("Mark '%1' not set").arg(text);
340
341
}

hjk's avatar
hjk committed
342
class Input
hjk's avatar
hjk committed
343
{
hjk's avatar
hjk committed
344
public:
345
346
    Input()
        : m_key(0), m_xkey(0), m_modifiers(0) {}
hjk's avatar
hjk committed
347

348
349
    explicit Input(QChar x)
        : m_key(x.unicode()), m_xkey(x.unicode()), m_modifiers(0), m_text(x) {}
hjk's avatar
hjk committed
350

hjk's avatar
hjk committed
351
    Input(int k, int m, const QString &t)
352
353
        : m_key(k), m_modifiers(m), m_text(t)
    {
hjk's avatar
hjk committed
354
355
356
357
358
359
        // On Mac, QKeyEvent::text() returns non-empty strings for
        // cursor keys. This breaks some of the logic later on
        // relying on text() being empty for "special" keys.
        // FIXME: Check the real conditions.
        if (m_text.size() == 1 && m_text.at(0).unicode() < ' ')
            m_text.clear();
360
361
362
363
364
365
366
367
        // m_xkey is only a cache.
        m_xkey = (m_text.size() == 1 ? m_text.at(0).unicode() : m_key);
    }

    bool isDigit() const
    {
        return m_xkey >= '0' && m_xkey <= '9';
    }
hjk's avatar
hjk committed
368

369
370
371
372
373
    bool isKey(int c) const
    {
        return !m_modifiers && m_key == c;
    }

hjk's avatar
hjk committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
    bool isBackspace() const
    {
        return m_key == Key_Backspace || isControl('h');
    }

    bool isReturn() const
    {
        return m_key == Key_Return;
    }

    bool isEscape() const
    {
        return isKey(Key_Escape) || isKey(27) || isControl('c')
            || isControl(Key_BracketLeft);
    }

390
391
    bool is(int c) const
    {
392
393
394
        return m_xkey == c && (m_modifiers == 0
                || m_modifiers == Qt::ShiftModifier
                || m_modifiers == Qt::GroupSwitchModifier);
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
    }

    bool isControl(int c) const
    {
        return m_modifiers == Qt::ControlModifier &&
            (m_xkey == c || m_xkey + 32 == c || m_xkey + 64 == c || m_xkey + 96 == c);
    }

    bool isShift(int c) const
    {
        return m_modifiers == Qt::ShiftModifier && m_xkey == c;
    }

    bool operator==(const Input &a) const
    {
hjk's avatar
hjk committed
410
411
        return a.m_key == m_key && a.m_modifiers == m_modifiers
            && m_text == a.m_text;
412
413
    }

hjk's avatar
hjk committed
414
415
    bool operator!=(const Input &a) const { return !operator==(a); }

416
417
    QString text() const { return m_text; }

hjk's avatar
hjk committed
418
419
420
421
422
    QChar asChar() const
    {
        return (m_text.size() == 1 ? m_text.at(0) : QChar());
    }

423
424
    int key() const { return m_key; }

425
426
427
428
429
430
431
432
433
    QChar raw() const
    {
        if (m_key == Key_Tab)
            return '\t';
        if (m_key == Key_Return)
            return '\n';
        return m_key;
    }

hjk's avatar
hjk committed
434
435
436
437
438
    QDebug dump(QDebug ts) const
    {
        return ts << m_key << '-' << m_modifiers << '-'
            << quoteUnprintable(m_text);
    }
439
440
441
442
443
444
private:
    int m_key;
    int m_xkey;
    int m_modifiers;
    QString m_text;
};
hjk's avatar
hjk committed
445

hjk's avatar
hjk committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
QDebug operator<<(QDebug ts, const Input &input) { return input.dump(ts); }

class Inputs : public QVector<Input>
{
public:
    Inputs() {}
    explicit Inputs(const QString &str) { parseFrom(str); }
    void parseFrom(const QString &str);
};


void Inputs::parseFrom(const QString &str)
{
    const int n = str.size();
    for (int i = 0; i < n; ++i) {
        uint c0 = str.at(i).unicode(), c1 = 0, c2 = 0, c3 = 0, c4 = 0, c5 = 0;
        if (i + 1 < n)
            c1 = str.at(i + 1).unicode();
        if (i + 2 < n)
            c2 = str.at(i + 2).unicode();
        if (i + 3 < n)
            c3 = str.at(i + 3).unicode();
        if (i + 4 < n)
            c4 = str.at(i + 4).unicode();
        if (i + 5 < n)
            c5 = str.at(i + 5).unicode();
        if (c0 == '<') {
            if ((c1 == 'C' || c1 == 'c') && c2 == '-' && c4 == '>') {
                uint c = (c3 < 90 ? c3 : c3 - 32);
                append(Input(c, Qt::ControlModifier, QString(QChar(c - 64))));
                i += 4;
            } else {
                append(Input(QLatin1Char(c0)));
            }
        } else {
            append(Input(QLatin1Char(c0)));
        }
    }
}

class History
{
public:
    History() : m_index(0) {}
    void append(const QString &item)
        { //qDebug() << "APP: " << item << m_items;
            m_items.removeAll(item);
            m_items.append(item); m_index = m_items.size() - 1;  }
    void down() { m_index = qMin(m_index + 1, m_items.size()); }
    void up() { m_index = qMax(m_index - 1, 0); }
    //void clear() { m_items.clear(); m_index = 0; }
    void restart() { m_index = m_items.size(); }
    QString current() const { return m_items.value(m_index, QString()); }
    QStringList items() const { return m_items; }
private:
    QStringList m_items;
    int m_index;
};

hjk's avatar
hjk committed
505
506

// Mappings for a specific mode.
hjk's avatar
hjk committed
507
class ModeMapping : public QList<QPair<Inputs, Inputs> >
hjk's avatar
hjk committed
508
509
510
511
512
513
{
public:
    ModeMapping() { test(); }

    void test()
    {
hjk's avatar
hjk committed
514
515
        //insert(Inputs() << Input('A') << Input('A'),
        //       Inputs() << Input('x') << Input('x'));
hjk's avatar
hjk committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
    }

    void insert(const Inputs &from, const Inputs &to)
    {
        for (int i = 0; i != size(); ++i)
            if (at(i).first == from) {
                (*this)[i].second = to;
                return;
            }
        append(QPair<Inputs, Inputs>(from, to));
    }

    void remove(const Inputs &from)
    {
        for (int i = 0; i != size(); ++i)
            if (at(i).first == from) {
                removeAt(i);
                return;
            }
    }

hjk's avatar
hjk committed
537
538
    // Returns 'false' if more input is needed to decide whether a mapping
    // needs to be applied. If a decision can be made, return 'true',
hjk's avatar
hjk committed
539
    // and replace *input with the mapped data.
hjk's avatar
hjk committed
540
    bool mappingDone(Inputs *inputs) const
hjk's avatar
hjk committed
541
542
543
    {
        // FIXME: inefficient.
        for (int i = 0; i != size(); ++i) {
hjk's avatar
hjk committed
544
            const Inputs &haystack = at(i).first;
545
            // A mapping
hjk's avatar
hjk committed
546
547
            if (startsWith(haystack, *inputs)) {
                if (haystack.size() != inputs->size())
hjk's avatar
hjk committed
548
549
                    return false; // This can be extended.
                // Actual mapping.
hjk's avatar
hjk committed
550
                *inputs = at(i).second;
hjk's avatar
hjk committed
551
552
553
                return true;
            }
        }
hjk's avatar
hjk committed
554
        // No extensible mapping found. Use inputs as-is.
hjk's avatar
hjk committed
555
556
557
558
559
560
561
562
563
564
        return true;
    }

private:
    static bool startsWith(const Inputs &haystack, const Inputs &needle)
    {
        // Input is already too long.
        if (needle.size() > haystack.size())
            return false;
        for (int i = 0; i != needle.size(); ++i) {
hjk's avatar
hjk committed
565
            if (needle.at(i) != haystack.at(i))
hjk's avatar
hjk committed
566
567
568
569
570
571
                return false;
        }
        return true;
    }
};

hjk's avatar
hjk committed
572

hjk's avatar
hjk committed
573
574
575
576
class FakeVimHandler::Private : public QObject
{
    Q_OBJECT

hjk's avatar
hjk committed
577
public:
578
    Private(FakeVimHandler *parent, QWidget *widget);
hjk's avatar
hjk committed
579

580
581
    EventResult handleEvent(QKeyEvent *ev);
    bool wantsOverride(QKeyEvent *ev);
582
    void handleCommand(const QString &cmd); // Sets m_tc + handleExCommand
583
    void handleExCommand(const QString &cmd);
584

hjk's avatar
hjk committed
585
    // Updates marks positions by the difference in positionChange.
586
    void fixMarks(int positionAction, int positionChange);
hjk's avatar
hjk committed
587

588
    void installEventFilter();
589
    void passShortcuts(bool enable);
590
    void setupWidget();
591
    void restoreWidget(int tabSize);
592

593
    friend class FakeVimHandler;
hjk's avatar
hjk committed
594
595

    void init();
hjk's avatar
hjk committed
596
597
598
    EventResult handleKey(const Input &);
    Q_SLOT EventResult handleKey2();
    EventResult handleInsertMode(const Input &);
hjk's avatar
hjk committed
599
    EventResult handleReplaceMode(const Input &);
hjk's avatar
hjk committed
600
601
    EventResult handleCommandMode(const Input &);
    EventResult handleRegisterMode(const Input &);
hjk's avatar
hjk committed
602
603
    EventResult handleExMode(const Input &);
    EventResult handleSearchSubSubMode(const Input &);
hjk's avatar
hjk committed
604
    EventResult handleCommandSubSubMode(const Input &);
605
606
    void finishMovement(const QString &dotCommand = QString());
    void finishMovement(const QString &dotCommand, int count);
607
    void resetCommandMode();
hjk's avatar
hjk committed
608
    void search(const SearchData &sd);
hjk's avatar
hjk committed
609
    void highlightMatches(const QString &needle);
610
    void stopIncrementalFind();
hjk's avatar
hjk committed
611

hjk's avatar
hjk committed
612
613
614
    int mvCount() const { return m_mvcount.isEmpty() ? 1 : m_mvcount.toInt(); }
    int opCount() const { return m_opcount.isEmpty() ? 1 : m_opcount.toInt(); }
    int count() const { return mvCount() * opCount(); }
hjk's avatar
hjk committed
615
616
    int leftDist() const { return m_tc.position() - m_tc.block().position(); }
    int rightDist() const { return m_tc.block().length() - leftDist() - 1; }
617
618
    bool atEndOfLine() const
        { return m_tc.atBlockEnd() && m_tc.block().length() > 1; }
hjk's avatar
hjk committed
619

hjk's avatar
hjk committed
620
    int lastPositionInDocument() const; // Returns last valid position in doc.
621
622
    int firstPositionInLine(int line) const; // 1 based line, 0 based pos
    int lastPositionInLine(int line) const; // 1 based line, 0 based pos
hjk's avatar
hjk committed
623
    int lineForPosition(int pos) const;  // 1 based line, 0 based pos
624
    QString lineContents(int line) const; // 1 based line
hjk's avatar
hjk committed
625
    void setLineContents(int line, const QString &contents); // 1 based line
hjk's avatar
hjk committed
626

hjk's avatar
hjk committed
627
628
    int linesOnScreen() const;
    int columnsOnScreen() const;
629
630
    int linesInDocument() const;

hjk's avatar
hjk committed
631
    // The following use all zero-based counting.
632
    int cursorLineOnScreen() const;
633
634
635
636
637
638
639
640
    int cursorLine() const;
    int physicalCursorColumn() const; // as stored in the data
    int logicalCursorColumn() const; // as visible on screen
    int physicalToLogicalColumn(int physical, const QString &text) const;
    int logicalToPhysicalColumn(int logical, const QString &text) const;
    Column cursorColumn() const; // as visible on screen
    int firstVisibleLine() const;
    void scrollToLine(int line);
hjk's avatar
hjk committed
641
642
    void scrollUp(int count);
    void scrollDown(int count) { scrollUp(-count); }
hjk's avatar
hjk committed
643

644
    CursorPosition cursorPosition() const
645
        { return CursorPosition(position(), firstVisibleLine()); }
646
    void setCursorPosition(const CursorPosition &p)
647
        { setPosition(p.position); scrollToLine(p.scrollLine); }
648

hjk's avatar
hjk committed
649
    // Helper functions for indenting/
650
    bool isElectricCharacter(QChar c) const;
651
652
    void indentSelectedText(QChar lastTyped = QChar());
    int indentText(const Range &range, QChar lastTyped = QChar());
hjk's avatar
hjk committed
653
654
    void shiftRegionLeft(int repeat = 1);
    void shiftRegionRight(int repeat = 1);
655

hjk's avatar
hjk committed
656
    void moveToFirstNonBlankOnLine();
657
    void moveToTargetColumn();
658
    void setTargetColumn() {
659
        m_targetColumn = logicalCursorColumn();
660
        m_visualTargetColumn = m_targetColumn;
661
662
        //qDebug() << "TARGET: " << m_targetColumn;
    }
663
    void moveToNextWord(bool simple, bool deleteWord = false);
664
    void moveToMatchingParanthesis();
665
    void moveToWordBoundary(bool simple, bool forward, bool changeWord = false);
hjk's avatar
hjk committed
666

hjk's avatar
hjk committed
667
    // Convenience wrappers to reduce line noise.
hjk's avatar
hjk committed
668
    void moveToEndOfDocument() { m_tc.movePosition(EndOfDocument, MoveAnchor); }
669
    void moveToStartOfLine();
hjk's avatar
hjk committed
670
    void moveToEndOfLine();
hjk's avatar
hjk committed
671
    void moveBehindEndOfLine();
hjk's avatar
hjk committed
672
673
    void moveUp(int n = 1) { moveDown(-n); }
    void moveDown(int n = 1); // { m_tc.movePosition(Down, MoveAnchor, n); }
hjk's avatar
hjk committed
674
675
    void moveRight(int n = 1) { m_tc.movePosition(Right, MoveAnchor, n); }
    void moveLeft(int n = 1) { m_tc.movePosition(Left, MoveAnchor, n); }
hjk's avatar
hjk committed
676
    void setAnchor();
677
    void setAnchor(int position) { if (!isVisualMode()) m_anchor = position; }
678
    void setPosition(int position) { m_tc.setPosition(position, MoveAnchor); }
hjk's avatar
hjk committed
679

680
    bool handleFfTt(QString key);
hjk's avatar
hjk committed
681

hjk's avatar
hjk committed
682
    // Helper function for handleExCommand returning 1 based line index.
hjk's avatar
hjk committed
683
684
    int readLineCode(QString &cmd);

685
    void enterInsertMode();
hjk's avatar
hjk committed
686
    void enterReplaceMode();
687
    void enterCommandMode();
688
    void enterExMode();
hjk's avatar
hjk committed
689
690
    void showRedMessage(const QString &msg);
    void showBlackMessage(const QString &msg);
691
    void notImplementedYet();
692
693
    void updateMiniBuffer();
    void updateSelection();
hjk's avatar
hjk committed
694
    void updateCursor();
695
    QWidget *editor() const;
696
697
    QChar characterAtCursor() const
        { return m_tc.document()->characterAt(m_tc.position()); }
hjk's avatar
hjk committed
698
    void beginEditBlock() { UNDO_DEBUG("BEGIN EDIT BLOCK"); m_tc.beginEditBlock(); }
699
    void beginEditBlock(int pos) { setUndoPosition(pos); beginEditBlock(); }
hjk's avatar
hjk committed
700
    void endEditBlock() { UNDO_DEBUG("END EDIT BLOCK"); m_tc.endEditBlock(); }
hjk's avatar
hjk committed
701
702
703
704
    void joinPreviousEditBlock() { UNDO_DEBUG("JOIN"); m_tc.joinPreviousEditBlock(); }
    void breakEditBlock()
        { m_tc.beginEditBlock(); m_tc.insertText("x");
          m_tc.deletePreviousChar(); m_tc.endEditBlock(); }
705

706
707
708
709
710
    bool isVisualMode() const { return m_visualMode != NoVisualMode; }
    bool isNoVisualMode() const { return m_visualMode == NoVisualMode; }
    bool isVisualCharMode() const { return m_visualMode == VisualCharMode; }
    bool isVisualLineMode() const { return m_visualMode == VisualLineMode; }
    bool isVisualBlockMode() const { return m_visualMode == VisualBlockMode; }
hjk's avatar
hjk committed
711
    void updateEditor();
712

713
714
715
716
717
718
719
    void selectWordTextObject(bool inner);
    void selectWORDTextObject(bool inner);
    void selectSentenceTextObject(bool inner);
    void selectParagraphTextObject(bool inner);
    void selectBlockTextObject(bool inner, char left, char right);
    void selectQuotedStringTextObject(bool inner, int type);

hjk's avatar
hjk committed
720
    Q_SLOT void importSelection();
721
    void insertInInsertMode(const QString &text);
hjk's avatar
hjk committed
722

723
724
725
public:
    QTextEdit *m_textedit;
    QPlainTextEdit *m_plaintextedit;
726
    bool m_wasReadOnly; // saves read-only state of document
727

hjk's avatar
hjk committed
728
729
    FakeVimHandler *q;
    Mode m_mode;
730
    bool m_passing; // let the core see the next event
hjk's avatar
hjk committed
731
    SubMode m_submode;
hjk's avatar
hjk committed
732
    SubSubMode m_subsubmode;
733
    Input m_subsubdata;
hjk's avatar
hjk committed
734
    QTextCursor m_tc;
735
    int m_oldPosition; // copy from last event to check for external changes
736
    int m_anchor;
hjk's avatar
hjk committed
737
    int m_register;
hjk's avatar
hjk committed
738
739
    QString m_mvcount;
    QString m_opcount;
740
741
    MoveType m_movetype;
    RangeMode m_rangemode;
742
    int m_visualInsertCount;
hjk's avatar
hjk committed
743
744

    bool m_fakeEnd;
hjk's avatar
hjk committed
745
746
    bool m_anchorPastEnd;
    bool m_positionPastEnd; // '$' & 'l' in visual mode can move past eol
hjk's avatar
hjk committed
747

hjk's avatar
hjk committed
748
    int m_gflag;  // whether current command started with 'g'
749

hjk's avatar
hjk committed
750
    QString m_commandPrefix;
hjk's avatar
hjk committed
751
    QString m_commandBuffer;
752
753
    QString m_currentFileName;
    QString m_currentMessage;
hjk's avatar
hjk committed
754

755
    bool m_lastSearchForward;
756
    bool m_findPending;
hjk's avatar
hjk committed
757
    QString m_lastInsertion;
hjk's avatar
hjk committed
758
    QString m_lastDeletion;
hjk's avatar
hjk committed
759

hjk's avatar
hjk committed
760
761
    int anchor() const { return m_anchor; }
    int position() const { return m_tc.position(); }
762

hjk's avatar
hjk committed
763
764
765
766
767
768
769
770
771
772
773
774
775
    struct TransformationData
    {
        TransformationData(const QString &s, const QVariant &d)
            : from(s), extraData(d) {}
        QString from;
        QString to;
        QVariant extraData;
    };
    typedef void (Private::*Transformation)(TransformationData *td);
    void transformText(const Range &range, Transformation transformation,
        const QVariant &extraData = QVariant());

    void insertText(const Register &reg);
776
    void removeText(const Range &range);
hjk's avatar
hjk committed
777
    void removeTransform(TransformationData *td);
778

hjk's avatar
hjk committed
779
780
    void invertCase(const Range &range);
    void invertCaseTransform(TransformationData *td);
781

hjk's avatar
hjk committed
782
783
    void upCase(const Range &range);
    void upCaseTransform(TransformationData *td);
784

hjk's avatar
hjk committed
785
786
    void downCase(const Range &range);
    void downCaseTransform(TransformationData *td);
787

hjk's avatar
hjk committed
788
789
790
    void replaceText(const Range &range, const QString &str);
    void replaceByStringTransform(TransformationData *td);
    void replaceByCharTransform(TransformationData *td);
791

hjk's avatar
hjk committed
792
793
794
    QString selectText(const Range &range) const;
    void setCurrentRange(const Range &range);
    Range currentRange() const { return Range(position(), anchor(), m_rangemode); }
795
796
797
798

    void yankText(const Range &range, int toregister = '"');

    void pasteText(bool afterCursor);
799

800
    // undo handling
801
802
    void undo();
    void redo();
803
    void setUndoPosition(int pos);
804
    QMap<int, int> m_undoCursorPosition; // revision -> position
805

hjk's avatar
hjk committed
806
    // extra data for '.'
hjk's avatar
hjk committed
807
    void replay(const QString &text, int count);
hjk's avatar
hjk committed
808
809
    void setDotCommand(const QString &cmd) { g.dotCommand = cmd; }
    void setDotCommand(const QString &cmd, int n) { g.dotCommand = cmd.arg(n); }
hjk's avatar
hjk committed
810

hjk's avatar
hjk committed
811
812
    // extra data for ';'
    QString m_semicolonCount;
813
814
    Input m_semicolonType;  // 'f', 'F', 't', 'T'
    QString m_semicolonKey;
hjk's avatar
hjk committed
815

hjk's avatar
hjk committed
816
    // visual line mode
817
818
819
    void enterVisualMode(VisualMode visualMode);
    void leaveVisualMode();
    VisualMode m_visualMode;
hjk's avatar
hjk committed
820

821
    // marks as lines
hjk's avatar
hjk committed
822
823
    int mark(int code) const;
    void setMark(int code, int position);
824
825
    QHash<int, int> m_marks;

hjk's avatar
hjk committed
826
    // vi style configuration
hjk's avatar
hjk committed
827
828
829
830
    QVariant config(int code) const { return theFakeVimSetting(code)->value(); }
    bool hasConfig(int code) const { return config(code).toBool(); }
    bool hasConfig(int code, const char *value) const // FIXME
        { return config(code).toString().contains(value); }
831

832
833
    int m_targetColumn; // -1 if past end of line
    int m_visualTargetColumn; // 'l' can move past eol in visual mode only
834
    int m_cursorWidth;
835

hjk's avatar
hjk committed
836
    // auto-indent
837
    QString tabExpand(int len) const;
838
    Column indentation(const QString &line) const;
hjk's avatar
hjk committed
839
840
841
842
    void insertAutomaticIndentation(bool goingDown);
    bool removeAutomaticIndentation(); // true if something removed
    // number of autoindented characters
    int m_justAutoIndented;
843
    void handleStartOfLine();
hjk's avatar
hjk committed
844

845
    void recordJump();
846
847
    QVector<CursorPosition> m_jumpListUndo;
    QVector<CursorPosition> m_jumpListRedo;
hjk's avatar
hjk committed
848
849

    QList<QTextEdit::ExtraSelection> m_searchSelections;
hjk's avatar
hjk committed
850
851
    QTextCursor m_searchCursor;
    QString m_oldNeedle;
hjk's avatar
hjk committed
852

hjk's avatar
hjk committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
    bool handleExCommandHelper(const ExCommand &cmd); // Returns success.
    bool handleExPluginCommand(const ExCommand &cmd); // Handled by plugin?
    bool handleExBangCommand(const ExCommand &cmd);
    bool handleExDeleteCommand(const ExCommand &cmd);
    bool handleExGotoCommand(const ExCommand &cmd);
    bool handleExHistoryCommand(const ExCommand &cmd);
    bool handleExRegisterCommand(const ExCommand &cmd);
    bool handleExMapCommand(const ExCommand &cmd);
    bool handleExNormalCommand(const ExCommand &cmd);
    bool handleExReadCommand(const ExCommand &cmd);
    bool handleExRedoCommand(const ExCommand &cmd);
    bool handleExSetCommand(const ExCommand &cmd);
    bool handleExShiftCommand(const ExCommand &cmd);
    bool handleExSourceCommand(const ExCommand &cmd);
    bool handleExSubstituteCommand(const ExCommand &cmd);
    bool handleExWriteCommand(const ExCommand &cmd);
hjk's avatar
hjk committed
869
870

    void timerEvent(QTimerEvent *ev);
hjk's avatar
hjk committed
871
872
873
874

    void setupCharClass();
    int charClass(QChar c, bool simple) const;
    signed char m_charClass[256];
875
    bool m_ctrlVActive;
hjk's avatar
hjk committed
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904

    static struct GlobalData
    {
        GlobalData()
        {
            inReplay = false;
            inputTimer = -1;
        }

        // Input.
        Inputs pendingInput;
        int inputTimer;

        // Repetition.
        QString dotCommand;
        bool inReplay; // true if we are executing a '.'

        // History for searches.
        History searchHistory;

        // History for :ex commands.
        History commandHistory;

        QHash<int, Register> registers;

        // All mappings.
        typedef QHash<char, ModeMapping> Mappings;
        Mappings mappings;
    } g;
hjk's avatar
hjk committed
905
906
};

hjk's avatar
hjk committed
907
FakeVimHandler::Private::GlobalData FakeVimHandler::Private::g;
908

909
FakeVimHandler::Private::Private(FakeVimHandler *parent, QWidget *widget)
hjk's avatar
hjk committed
910
{
hjk's avatar
hjk committed
911
    //static PythonHighlighterRules pythonRules;
hjk's avatar
hjk committed
912
    q = parent;
913
914
    m_textedit = qobject_cast<QTextEdit *>(widget);
    m_plaintextedit = qobject_cast<QPlainTextEdit *>(widget);
915
    //new Highlighter(EDITOR(document()), &pythonRules);
hjk's avatar
hjk committed
916
917
    init();
}
918

hjk's avatar
hjk committed
919
920
void FakeVimHandler::Private::init()
{
hjk's avatar
hjk committed
921
    m_mode = CommandMode;
hjk's avatar
hjk committed
922
923
    m_submode = NoSubMode;
    m_subsubmode = NoSubSubMode;
924
    m_passing = false;
925
    m_findPending = false;
hjk's avatar
hjk committed
926
    m_fakeEnd = false;
927
    m_positionPastEnd = m_anchorPastEnd = false;
928
    m_lastSearchForward = true;
hjk's avatar
hjk committed
929
    m_register = '"';
hjk's avatar
hjk committed
930
    m_gflag = false;
931
    m_visualMode = NoVisualMode;
932
    m_targetColumn = 0;
933
    m_visualTargetColumn = 0;
934
    m_movetype = MoveInclusive;
hjk's avatar
hjk committed
935
    m_anchor = 0;
936
    m_cursorWidth = EDITOR(cursorWidth());
hjk's avatar
hjk committed
937
    m_justAutoIndented = 0;
938
    m_rangemode = RangeCharMode;
939
    m_ctrlVActive = false;
hjk's avatar
hjk committed
940
941

    setupCharClass();
hjk's avatar
hjk committed
942
943
}

944
bool FakeVimHandler::Private::wantsOverride(QKeyEvent *ev)
hjk's avatar
hjk committed
945
{
946
947
948
    const int key = ev->key();
    const int mods = ev->modifiers();
    KEY_DEBUG("SHORTCUT OVERRIDE" << key << "  PASSING: " << m_passing);
949

950
    if (key == Key_Escape) {
hjk's avatar
hjk committed
951
952
        if (m_subsubmode == SearchSubSubMode)
            return true;
hjk's avatar
hjk committed
953
        // Not sure this feels good. People often hit Esc several times
954
955
        if (isNoVisualMode() && m_mode == CommandMode
               && m_opcount.isEmpty() && m_mvcount.isEmpty())
956
957
            return false;
        return true;
958
959
960
    }

    // We are interested in overriding  most Ctrl key combinations
961
962
963
    if (mods == Qt::ControlModifier
            && ((key >= Key_A && key <= Key_Z && key != Key_K)
                || key == Key_BracketLeft || key == Key_BracketRight)) {
con's avatar
con committed
964
        // Ctrl-K is special as it is the Core's default notion of Locator
965
966
967
968
969
        if (m_passing) {
            KEY_DEBUG(" PASSING CTRL KEY");
            // We get called twice on the same key
            //m_passing = false;
            return false;
970
        }
971
972
973
        KEY_DEBUG(" NOT PASSING CTRL KEY");
        //updateMiniBuffer();
        return true;
974
975
    }

976
977
978
979
980
981
    // Let other shortcuts trigger
    return false;
}

EventResult FakeVimHandler::Private::handleEvent(QKeyEvent *ev)
{
982
    const int key = ev->key();
983
984
    const int mods = ev->modifiers();

hjk's avatar
hjk committed
985
    if (key == Key_Shift || key == Key_Alt || key == Key_Control
986
987
988
989
990
991
992
            || key == Key_Alt || key == Key_AltGr || key == Key_Meta)
    {
        KEY_DEBUG("PLAIN MODIFIER");
        return EventUnhandled;
    }

    if (m_passing) {
993
        passShortcuts(false);
994
        KEY_DEBUG("PASSING PLAIN KEY..." << ev->key() << ev->text());
995
        //if (input.is(',')) { // use ',,' to leave, too.
996
997
998
999
1000
1001
1002
1003
        //    qDebug() << "FINISHED...";
        //    return EventHandled;
        //}
        m_passing = false;
        updateMiniBuffer();
        KEY_DEBUG("   PASS TO CORE");
        return EventPassedToCore;
    }
hjk's avatar
hjk committed
1004
1005

    // Fake "End of line"
1006
1007
    m_tc = EDITOR(textCursor());

1008
1009
    // Position changed externally
    if (m_tc.position() != m_oldPosition) {
1010
        setTargetColumn();
1011
1012
1013
        if (m_mode == InsertMode) {
            int dist = m_tc.position() - m_oldPosition;
            // Try to compensate for code completion
1014
            if (dist > 0 && dist <= physicalCursorColumn()) {
1015
                Range range(m_oldPosition, m_tc.position());
hjk's avatar
hjk committed
1016
                m_lastInsertion.append(selectText(range));
1017
            }
1018
1019
1020
        } else if (!isVisualMode()) {
            if (atEndOfLine())
                moveLeft();
1021
1022
        }
    }
1023
1024

    m_tc.setVisualNavigation(true);