Overview
ZepMode_Vim implements Vim-style modal editing in Zep, providing familiar keyboard navigation and editing commands for Vim users. This mode supports Normal, Insert, Visual, and Ex modes with traditional Vim key bindings.
Class Definition
class ZepMode_Vim : public ZepMode
Constructor
ZepMode_Vim(ZepEditor& editor)
Reference to the parent ZepEditor instance
Core Methods
Init
virtual void Init() override
Begin
virtual void Begin(ZepWindow* pWindow) override
The window to activate Vim mode in
Name
virtual const char* Name() const override
static const char* StaticName()
"Vim"
DefaultMode
virtual EditorMode DefaultMode() const override
EditorMode::Normal
PreDisplay
virtual void PreDisplay(ZepWindow& win) override
The window being prepared for display
UsesRelativeLines
virtual bool UsesRelativeLines() const override
relativenumber option).
Returns: true
Relative line numbering displays distances from the current line, making it easier to use motion commands like 5j or 3k.
Key Mapping Methods
These methods set up various categories of Vim key bindings:
SetupKeyMaps
virtual void SetupKeyMaps()
AddNavigationKeyMaps
virtual void AddNavigationKeyMaps(bool allowInVisualMode = true)
Whether to enable these mappings in Visual mode
AddSearchKeyMaps
virtual void AddSearchKeyMaps()
AddGlobalKeyMaps
virtual void AddGlobalKeyMaps()
AddCopyMaps
virtual void AddCopyMaps()
AddPasteMaps
virtual void AddPasteMaps()
AddOverStrikeMaps
virtual void AddOverStrikeMaps()
Vim Motions
The mode supports various motion types:
enum class VimMotion
{
LineBegin, // ^ - First non-whitespace character
LineEnd, // $ - End of line
NonWhiteSpaceBegin, // ^ - First non-whitespace
NonWhiteSpaceEnd // g_ - Last non-whitespace
}
These motions can be combined with operators like delete (d), change (c), and yank (y) to form complex commands.
Supported Vim Commands
Normal Mode
- Navigation: h, j, k, l, w, b, e, ge, W, B, E, 0, ^, $, gg, G
- Editing: x, X, dd, D, C, s, S, i, I, a, A, o, O
- Copy/Paste: y, yy, Y, p, P
- Undo/Redo: u, Ctrl+R
- Search: /, ?, n, N, *, #
- Visual: v, V
Insert Mode
- Exit: Escape, Ctrl+[
- Standard text input
Visual Mode
- Selection: v (character), V (line)
- Operations: d, c, y, >, <
- All navigation commands
Ex Mode
- Commands: :w, :q, :wq, :e, and more
- Accessed via
: from Normal mode
Usage Example
#include <zep/mode_vim.h>
#include <zep/editor.h>
// Create editor
auto editor = std::make_unique<ZepEditor>(display);
// Create and register Vim mode
auto vimMode = std::make_shared<ZepMode_Vim>(*editor);
vimMode->Init();
editor->RegisterMode(vimMode);
// Set Vim as the active mode
editor->SetMode(ZepMode_Vim::StaticName());
// The editor now responds to Vim commands
// For example, pressing 'i' enters Insert mode
// Pressing Escape returns to Normal mode
// Get current window and start using Vim mode
auto window = editor->GetActiveWindow();
vimMode->Begin(window);
// Mode automatically handles key presses
vimMode->AddKeyPress('i'); // Enter insert mode
vimMode->AddKeyPress('H'); // Type 'H'
vimMode->AddKeyPress('i'); // Type 'i'
vimMode->AddKeyPress(ExtKeys::ESCAPE); // Back to normal mode
vimMode->AddKeyPress('d'); // Start delete operation
vimMode->AddKeyPress('d'); // Complete: delete line
Configuration Example
// Custom Vim mode with additional key mappings
class MyVimMode : public ZepMode_Vim
{
public:
MyVimMode(ZepEditor& editor) : ZepMode_Vim(editor) {}
void Init() override
{
// Initialize base Vim mappings
ZepMode_Vim::Init();
// Add custom mappings
// Example: map 'jk' to escape in insert mode
m_insertMap.AddKeyMapSequence("jk",
{ExtKeys::ESCAPE},
StringId("ExitInsert"));
}
};
Vim mode maintains separate key maps for Normal, Insert, and Visual modes, allowing mode-specific key bindings.
Editor Modes in Vim
Vim mode cycles through different EditorMode states:
- EditorMode::Normal - Command mode (default)
- EditorMode::Insert - Text insertion mode
- EditorMode::Visual - Visual selection mode
- EditorMode::Ex - Colon command mode
See ZepMode for the complete EditorMode enum definition.
See Also
