File indexing completed on 2024-05-05 03:58:02

 /*
     SPDX-FileCopyrightText: KDE Developers
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include "kateviinputmode.h"
 #include "kateconfig.h"
 #include "katedocument.h"
 #include "katerenderer.h"
 #include "kateview.h"
 #include "kateviewinternal.h"
 #include <vimode/emulatedcommandbar/emulatedcommandbar.h>
 #include <vimode/macrorecorder.h>
 #include <vimode/marks.h>
 #include <vimode/modes/replacevimode.h>
 #include <vimode/modes/visualvimode.h>
 #include <vimode/searcher.h>
 
 #include <KLocalizedString>
 
 #include <QCoreApplication>
 
 namespace
 {
 QString viModeToString(KateVi::ViMode mode)
 {
     QString modeStr;
     switch (mode) {
     case KateVi::InsertMode:
         modeStr = i18n("VI: INSERT MODE");
         break;
     case KateVi::NormalMode:
         modeStr = i18n("VI: NORMAL MODE");
         break;
     case KateVi::VisualMode:
         modeStr = i18n("VI: VISUAL");
         break;
     case KateVi::VisualBlockMode:
         modeStr = i18n("VI: VISUAL BLOCK");
         break;
     case KateVi::VisualLineMode:
         modeStr = i18n("VI: VISUAL LINE");
         break;
     case KateVi::ReplaceMode:
         modeStr = i18n("VI: REPLACE");
         break;
     }
 
     return modeStr;
 }
 }
 
 KateViInputMode::KateViInputMode(KateViewInternal *viewInternal, KateVi::GlobalState *global)
     : KateAbstractInputMode(viewInternal)
     , m_viModeEmulatedCommandBar(nullptr)
     , m_viGlobal(global)
     , m_caret(KTextEditor::caretStyles::Block)
     , m_nextKeypressIsOverriddenShortCut(false)
     , m_relLineNumbers(KateViewConfig::global()->viRelativeLineNumbers())
     , m_activated(false)
     , m_viModeManager(new KateVi::InputModeManager(this, view(), viewInternal))
 {
 }
 
 void KateViInputMode::activate()
 {
     m_activated = true;
     setCaretStyle(KTextEditor::caretStyles::Block); // TODO: can we end up in insert mode?
     reset(); // TODO: is this necessary? (well, not anymore I guess)
 
     if (view()->selection()) {
         m_viModeManager->changeViMode(KateVi::VisualMode);
         view()->setCursorPosition(KTextEditor::Cursor(view()->selectionRange().end().line(), view()->selectionRange().end().column() - 1));
         m_viModeManager->m_viVisualMode->updateSelection();
     }
     viewInternal()->iconBorder()->setRelLineNumbersOn(m_relLineNumbers);
 }
 
 void KateViInputMode::deactivate()
 {
     if (m_viModeEmulatedCommandBar) {
         m_viModeEmulatedCommandBar->hideMe();
     }
 
     // make sure to turn off edits merging when leaving vi input mode
     view()->doc()->setUndoMergeAllEdits(false);
     m_activated = false;
     viewInternal()->iconBorder()->setRelLineNumbersOn(false);
     m_viModeManager->searcher()->enableHighlightSearch(false);
 }
 
 void KateViInputMode::reset()
 {
     if (m_viModeEmulatedCommandBar) {
         m_viModeEmulatedCommandBar->hideMe();
     }
 
     // ensure first the old stuff is deleted and then the new manager is constructed
     m_viModeManager.reset();
     m_viModeManager.reset(new KateVi::InputModeManager(this, view(), viewInternal()));
 
     if (m_viModeEmulatedCommandBar) {
         m_viModeEmulatedCommandBar->setViInputModeManager(m_viModeManager.get());
     }
 }
 
 bool KateViInputMode::overwrite() const
 {
     return m_viModeManager->getCurrentViMode() == KateVi::ViMode::ReplaceMode;
 }
 
 void KateViInputMode::overwrittenChar(const QChar &c)
 {
     m_viModeManager->getViReplaceMode()->overwrittenChar(c);
 }
 
 void KateViInputMode::clearSelection()
 {
     // do nothing, handled elsewhere
 }
 
 bool KateViInputMode::stealKey(QKeyEvent *k)
 {
     if (!KateViewConfig::global()->viInputModeStealKeys()) {
         return false;
     }
 
     // Actually see if we can make use of this key - if so, we've stolen it; if not,
     // let Qt's shortcut handling system deal with it.
     const bool stolen = keyPress(k);
     if (stolen) {
         // Qt will replay this QKeyEvent, next time as an ordinary KeyPress.
         m_nextKeypressIsOverriddenShortCut = true;
     }
     return stolen;
 }
 
 KTextEditor::View::InputMode KateViInputMode::viewInputMode() const
 {
     return KTextEditor::View::ViInputMode;
 }
 
 QString KateViInputMode::viewInputModeHuman() const
 {
     return i18n("vi-mode");
 }
 
 KTextEditor::View::ViewMode KateViInputMode::viewMode() const
 {
     return m_viModeManager->getCurrentViewMode();
 }
 
 QString KateViInputMode::viewModeHuman() const
 {
     QString currentMode = viModeToString(m_viModeManager->getCurrentViMode());
 
     if (m_viModeManager->macroRecorder()->isRecording()) {
         currentMode.prepend(QLatin1Char('(') + i18n("recording") + QLatin1String(") "));
     }
 
     QString cmd = m_viModeManager->getVerbatimKeys();
     if (!cmd.isEmpty()) {
         currentMode.prepend(QStringLiteral("%1 ").arg(cmd));
     }
 
     return currentMode;
 }
 
 void KateViInputMode::gotFocus()
 {
     // nothing to do
 }
 
 void KateViInputMode::lostFocus()
 {
     // nothing to do
 }
 
 void KateViInputMode::readSessionConfig(const KConfigGroup &config)
 {
     // restore vi registers and jump list
     m_viModeManager->readSessionConfig(config);
 }
 
 void KateViInputMode::writeSessionConfig(KConfigGroup &config)
 {
     // save vi registers and jump list
     m_viModeManager->writeSessionConfig(config);
 }
 
 void KateViInputMode::updateConfig()
 {
     KateViewConfig *cfg = view()->config();
 
     // whether relative line numbers should be used or not.
     m_relLineNumbers = cfg->viRelativeLineNumbers();
 
     if (m_activated) {
         viewInternal()->iconBorder()->setRelLineNumbersOn(m_relLineNumbers);
     }
 }
 
 void KateViInputMode::readWriteChanged(bool)
 {
     // nothing todo
 }
 
 void KateViInputMode::find()
 {
     showViModeEmulatedCommandBar();
     viModeEmulatedCommandBar()->init(KateVi::EmulatedCommandBar::SearchForward);
 }
 
 void KateViInputMode::findSelectedForwards()
 {
     m_viModeManager->searcher()->findNext();
 }
 
 void KateViInputMode::findSelectedBackwards()
 {
     m_viModeManager->searcher()->findPrevious();
 }
 
 void KateViInputMode::findReplace()
 {
     showViModeEmulatedCommandBar();
     viModeEmulatedCommandBar()->init(KateVi::EmulatedCommandBar::SearchForward);
 }
 
 void KateViInputMode::findNext()
 {
     m_viModeManager->searcher()->findNext();
 }
 
 void KateViInputMode::findPrevious()
 {
     m_viModeManager->searcher()->findPrevious();
 }
 
 void KateViInputMode::activateCommandLine()
 {
     showViModeEmulatedCommandBar();
     viModeEmulatedCommandBar()->init(KateVi::EmulatedCommandBar::Command);
 }
 
 void KateViInputMode::showViModeEmulatedCommandBar()
 {
     view()->bottomViewBar()->addBarWidget(viModeEmulatedCommandBar());
     view()->bottomViewBar()->showBarWidget(viModeEmulatedCommandBar());
 }
 
 KateVi::EmulatedCommandBar *KateViInputMode::viModeEmulatedCommandBar()
 {
     if (!m_viModeEmulatedCommandBar) {
         m_viModeEmulatedCommandBar = new KateVi::EmulatedCommandBar(this, m_viModeManager.get(), view());
         m_viModeEmulatedCommandBar->hide();
     }
 
     return m_viModeEmulatedCommandBar;
 }
 
 void KateViInputMode::updateRendererConfig()
 {
     m_viModeManager->searcher()->updateHighlightColors();
 }
 
 bool KateViInputMode::keyPress(QKeyEvent *e)
 {
     if (m_nextKeypressIsOverriddenShortCut) {
         // This is just the replay of a shortcut that we stole, this time as a QKeyEvent.
         // Ignore it, as we'll have already handled it via stealKey()!
         m_nextKeypressIsOverriddenShortCut = false;
         return true;
     }
 
     if (m_viModeManager->handleKeypress(e)) {
         Q_EMIT view()->viewModeChanged(view(), viewMode());
         return true;
     }
 
     return false;
 }
 
 bool KateViInputMode::blinkCaret() const
 {
     return false;
 }
 
 KTextEditor::caretStyles KateViInputMode::caretStyle() const
 {
     return m_caret;
 }
 
 void KateViInputMode::toggleInsert()
 {
     // do nothing
 }
 
 void KateViInputMode::launchInteractiveCommand(const QString &)
 {
     // do nothing so far
 }
 
 QString KateViInputMode::bookmarkLabel(int line) const
 {
     return m_viModeManager->marks()->getMarksOnTheLine(line);
 }
 
 void KateViInputMode::setCaretStyle(const KTextEditor::caretStyles caret)
 {
     if (m_caret != caret) {
         m_caret = caret;
 
         view()->renderer()->setCaretStyle(m_caret);
         view()->renderer()->setDrawCaret(true);
         viewInternal()->paintCursor();
     }
 }