mirror of
https://github.com/RGBCube/serenity
synced 2025-05-31 06:18:14 +00:00

When using the VimEditingEngine in the TextEditor, vim's mode and the previous key are shown in the editor's statusbar.
123 lines
3.6 KiB
C++
123 lines
3.6 KiB
C++
/*
|
|
* Copyright (c) 2021, the SerenityOS developers.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <LibGUI/EditingEngine.h>
|
|
|
|
namespace GUI {
|
|
|
|
enum VimMode {
|
|
Normal,
|
|
Insert,
|
|
Visual
|
|
};
|
|
|
|
class VimEditingEngine final : public EditingEngine {
|
|
|
|
public:
|
|
VimEditingEngine();
|
|
|
|
virtual CursorWidth cursor_width() const override;
|
|
|
|
virtual bool on_key(const KeyEvent& event) override;
|
|
|
|
class PreviousKey {
|
|
public:
|
|
PreviousKey() = default;
|
|
PreviousKey(const KeyEvent& event)
|
|
: key(event.key())
|
|
, code_point(event.code_point())
|
|
{
|
|
}
|
|
|
|
bool operator==(const KeyCode& key) const
|
|
{
|
|
return this->key == key;
|
|
}
|
|
|
|
bool operator==(const u32& code_point) const
|
|
{
|
|
return this->code_point == code_point;
|
|
}
|
|
|
|
KeyCode key {};
|
|
u32 code_point {};
|
|
};
|
|
|
|
Function<void(VimMode)> on_mode_change;
|
|
Function<void(const PreviousKey&, bool has_previous_key)> on_previous_keys_change;
|
|
|
|
private:
|
|
enum YankType {
|
|
Line,
|
|
Selection
|
|
};
|
|
|
|
VimMode m_vim_mode { VimMode::Normal };
|
|
|
|
YankType m_yank_type {};
|
|
String m_yank_buffer {};
|
|
void yank(YankType);
|
|
void yank(TextRange);
|
|
void put(const GUI::KeyEvent&);
|
|
|
|
TextPosition m_selection_start_position {};
|
|
void update_selection_on_cursor_move();
|
|
void clear_visual_mode_data();
|
|
|
|
// FIXME Support multiple previous keys, this is a temporary measure.
|
|
PreviousKey m_previous_key {};
|
|
bool has_previous_key { false };
|
|
|
|
void set_previous_key(PreviousKey event)
|
|
{
|
|
m_previous_key = event;
|
|
has_previous_key = true;
|
|
if (on_previous_keys_change)
|
|
on_previous_keys_change(m_previous_key, has_previous_key);
|
|
}
|
|
|
|
void clear_previous_key()
|
|
{
|
|
m_previous_key = {};
|
|
has_previous_key = false;
|
|
if (on_previous_keys_change)
|
|
on_previous_keys_change(m_previous_key, has_previous_key);
|
|
}
|
|
|
|
void switch_to_normal_mode();
|
|
void switch_to_insert_mode();
|
|
void switch_to_visual_mode();
|
|
void move_half_page_up(const KeyEvent& event);
|
|
void move_half_page_down(const KeyEvent& event);
|
|
|
|
bool on_key_in_insert_mode(const KeyEvent& event);
|
|
bool on_key_in_normal_mode(const KeyEvent& event);
|
|
bool on_key_in_visual_mode(const KeyEvent& event);
|
|
};
|
|
|
|
}
|