aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/fakevim/fakevimhandler.h
blob: 2809cb229181a32da751a6c14e729e27ab4865b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include <QObject>
#include <QTextEdit>

#include <functional>
#include <vector>

namespace FakeVim {
namespace Internal {

enum RangeMode
{
    // Reordering first three enum items here will break
    // compatibility with clipboard format stored by Vim.
    RangeCharMode,         // v
    RangeLineMode,         // V
    RangeBlockMode,        // Ctrl-v
    RangeLineModeExclusive,
    RangeBlockAndTailMode // Ctrl-v for D and X
};

struct Range
{
    Range() = default;
    Range(int b, int e, RangeMode m = RangeCharMode);

    bool isValid() const;

    int beginPos = -1;
    int endPos = -1;
    RangeMode rangemode = RangeCharMode;
};

struct ExCommand
{
    ExCommand() = default;

    bool matches(const QString &min, const QString &full) const;

    QString cmd;
    bool hasBang = false;
    QString args;
    Range range;
    int count = 1;
};

// message levels sorted by severity
enum MessageLevel
{
    MessageMode,    // show current mode (format "-- %1 --")
    MessageCommand, // show last Ex command or search
    MessageInfo,    // result of a command
    MessageWarning, // warning
    MessageError,   // error
    MessageShowCmd  // partial command
};

template<typename>
class Callback;

template<typename R, typename... Params>
class Callback<R(Params...)>
{
public:
    static constexpr auto IsVoidReturnType = std::is_same_v<R, void>;
    using Function = std::function<R(Params...)>;
    void set(const Function &callable) { m_callable = callable; }

    R operator()(Params... params)
    {
        if (!m_callable)
            return R();

        if constexpr (IsVoidReturnType)
            m_callable(std::forward<Params>(params)...);
        else
            return m_callable(std::forward<Params>(params)...);
    }

private:
    Function m_callable;
};

class FakeVimHandler : public QObject
{
    Q_OBJECT

public:
    explicit FakeVimHandler(QWidget *widget, QObject *parent = nullptr);
    ~FakeVimHandler() override;

    QWidget *widget();

    // call before widget is deleted
    void disconnectFromEditor();

    static void updateGlobalMarksFilenames(const QString &oldFileName, const QString &newFileName);

public:
    void setCurrentFileName(const QString &fileName);
    QString currentFileName() const;

    void showMessage(MessageLevel level, const QString &msg);

    // This executes an "ex" style command taking context
    // information from the current widget.
    void handleCommand(const QString &cmd);
    void handleReplay(const QString &keys);
    void handleInput(const QString &keys);
    void enterCommandMode();

    void installEventFilter();

    // Convenience
    void setupWidget();
    void restoreWidget(int tabSize);

    // Test only
    int physicalIndentation(const QString &line) const;
    int logicalIndentation(const QString &line) const;
    QString tabExpand(int n) const;

    void miniBufferTextEdited(const QString &text, int cursorPos, int anchorPos);

    // Set text cursor position. Keeps anchor if in visual mode.
    void setTextCursorPosition(int position);

    QTextCursor textCursor() const;
    void setTextCursor(const QTextCursor &cursor);

    bool jumpToLocalMark(QChar mark, bool backTickMode);

    bool inFakeVimMode();

    bool eventFilter(QObject *ob, QEvent *ev) override;

    Callback<void(const QString &msg, int cursorPos, int anchorPos, int messageLevel)>
        commandBufferChanged;
    Callback<void(const QString &msg)> statusDataChanged;
    Callback<void(const QString &msg)> extraInformationChanged;
    Callback<void(const QList<QTextEdit::ExtraSelection> &selection)> selectionChanged;
    Callback<void(const QString &needle)> highlightMatches;
    Callback<void(bool *moved, bool *forward, QTextCursor *cursor)> moveToMatchingParenthesis;
    Callback<void(bool *result, QChar c)> checkForElectricCharacter;
    Callback<void(int beginLine, int endLine, QChar typedChar)> indentRegion;
    Callback<void(const QString &needle, bool forward)> simpleCompletionRequested;
    Callback<void(const QString &key, int count)> windowCommandRequested;
    Callback<void(bool reverse)> findRequested;
    Callback<void(bool reverse)> findNextRequested;
    Callback<void(bool *handled, const ExCommand &cmd)> handleExCommandRequested;
    Callback<void()> requestDisableBlockSelection;
    Callback<void(const QTextCursor &cursor)> requestSetBlockSelection;
    Callback<void(QTextCursor *cursor)> requestBlockSelection;
    Callback<void(bool *on)> requestHasBlockSelection;
    Callback<void(int depth)> foldToggle;
    Callback<void(bool fold)> foldAll;
    Callback<void(int depth, bool dofold)> fold;
    Callback<void(int count, bool current)> foldGoTo;
    Callback<void(QChar mark, bool backTickMode, const QString &fileName)> requestJumpToLocalMark;
    Callback<void(QChar mark, bool backTickMode, const QString &fileName)> requestJumpToGlobalMark;
    Callback<void()> completionRequested;
    Callback<void()> tabPreviousRequested;
    Callback<void()> tabNextRequested;
    Callback<void(bool insertMode)> modeChanged;
    Callback<bool()> tabPressedInInsertMode;
    Callback<void(const QString &, const QString &, QString *)> processOutput;

public:
    class Private;

private:
    Private *d;
};

} // namespace Internal
} // namespace FakeVim

Q_DECLARE_METATYPE(FakeVim::Internal::ExCommand)