Initial commit

hluk · Mar 23, 2013 · 02c75cd · 02c75cd
commit 02c75cd
Show file tree

Hide file tree

Showing 15 changed files with 8,931 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,85 @@
+FakeVim
+=======
+
+FakeVim is library to emulate Vim in QTextEdit, QPlainTextEdit and possibly other Qt widgets.
+
+Supported Features
+------------------
+
+Most of supported commands can be followed by motion command or executed in visual mode, work with registers or can be prefixed with number of repetitions.
+
+Here is list of emulated commands with description where it can diverge from Vim in functionality.
+
+### Modes
+* normal
+* insert and replace
+* visual
+* command line (`:`)
+
+### Normal and Visual Modes
+* basic movement -- `h`/`j`/`k`/`l`, `<C-U>`, `<C-D>`, `<C-F>`, `<C-B>` etc.
+* word movement -- `w`, `e`, `b` etc.
+* "inner/a" movement -- `ciw`, `3daw`, `ya{` etc.
+* `f`, `t` movement
+* `{`, `}` -- paragraph movement
+* delete/change/yank/paste with register
+* undo/redo
+* `.` -- repeat last change
+* `/search`, `?search`, `*`, `#`, `n`, `N` -- most of regular expression syntax used in Vim except `\<` and `\>` just is the same as `\b` in QRegExp
+* `@`, `q` (macro recording, execution) -- special keys are saved as `<S-Left>`
+* marks
+* gv -- last visual selection; can differ if text is edited around it
+* indentation -- `=`, `<<`, `>>` etc. with movement, count and in visual mode
+* "to upper/lower" -- `~`, `gU`, `gu` etc.
+* `i`, `a`, `o`, `I`, `A`, `O` -- enter insert mode
+* scroll window -- `zt`, `zb`, `zz` etc.
+
+### Command Line Mode
+* `:map`, `:unmap`, `:inoremap` etc.
+* `:source` -- very basic line-by-line sourcing of vimrc files
+* `:substitute` -- substitute expression in range
+* `:'<,'>!cmd` -- filter through an external command (e.g. sort lines in file with `:%!sort`)
+* `:.!cmd` -- insert standard output of an external command
+* `:read`
+* `:yank`, `:delete`, `:change`
+* `:move`, `:join`
+* `:20` -- go to address
+* `:history`
+* `:registers`, `:display`
+* `:nohlsearch`
+* `:undo`, `:redo`
+* `:normal`
+* `:<`, `:>`
+
+### Insert Mode
+* `<C-O>` -- execute single command and return to insert mode
+* `<C-V>` -- insert raw character
+* `<insert>` -- toggle replace mode
+
+### Options (:set ...)
+* `autoindent`
+* `clipboard`
+* `configbackspace`
+* `expandtab`
+* `hlsearch`
+* `ignorecase`
+* `incsearch`
+* `indent`
+* `iskeyword`
+* `scrolloff`
+* `shiftwidth`
+* `showcmd`
+* `smartcase`
+* `smartindent`
+* `smarttab`
+* `startofline`
+* `tabstop`
+* `tildeop`
+* `wrapscan`
+
+Implementation
+--------------
+
+There are appropriate signals emitted for command which has to be processed by the underlying editor widget (folds, windows, tabs, command line, messages etc.).
+See example in `test/` directory or implementation of FakeVim plugin in Qt Creator IDE.
+
diff --git a/fakevim.pro b/fakevim.pro
@@ -0,0 +1,3 @@
+TEMPLATE = subdirs
+SUBDIRS += fakevim \
+           test
diff --git a/fakevim/fakevim.pri b/fakevim/fakevim.pri
@@ -0,0 +1,13 @@
+include($$PWD/utils/utils.pri)
+
+DEFINES += FAKEVIM_STANDALONE
+
+INCLUDEPATH += $$PWD
+
+SOURCES += $$PWD/fakevimhandler.cpp \
+           $$PWD/fakevimactions.cpp
+
+HEADERS += $$PWD/fakevimhandler.h \
+           $$PWD/fakevimactions.h
+
+CONFIG += qt
diff --git a/fakevim/fakevim.pro b/fakevim/fakevim.pro
@@ -0,0 +1,3 @@
+TEMPLATE = lib
+
+include(fakevim.pri)
diff --git a/fakevim/fakevimactions.cpp b/fakevim/fakevimactions.cpp
@@ -0,0 +1,215 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "fakevimactions.h"
+#include "fakevimhandler.h"
+
+// 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.
+
+
+#include <utils/qtcassert.h>
+
+#include <QDebug>
+#include <QObject>
+#include <QCoreApplication>
+
+#ifdef FAKEVIM_STANDALONE
+using namespace FakeVim::Internal::Utils;
+#else
+using namespace Utils;
+#endif
+
+///////////////////////////////////////////////////////////////////////
+//
+// FakeVimSettings
+//
+///////////////////////////////////////////////////////////////////////
+
+namespace FakeVim {
+namespace Internal {
+
+typedef QLatin1String _;
+
+#ifdef FAKEVIM_STANDALONE
+namespace Utils {
+
+SavedAction::SavedAction(QObject *parent)
+    : QObject(parent)
+{
+}
+
+void SavedAction::setValue(const QVariant &value)
+{
+    m_value = value;
+}
+
+QVariant SavedAction::value() const
+{
+    return m_value;
+}
+
+} // namespace Utils
+#endif // FAKEVIM_STANDALONE
+
+FakeVimSettings::FakeVimSettings()
+{}
+
+FakeVimSettings::~FakeVimSettings()
+{
+    qDeleteAll(m_items);
+}
+
+void FakeVimSettings::insertItem(int code, SavedAction *item,
+    const QString &longName, const QString &shortName)
+{
+    QTC_ASSERT(!m_items.contains(code), qDebug() << code; return);
+    m_items[code] = item;
+    if (!longName.isEmpty()) {
+        m_nameToCode[longName] = code;
+        m_codeToName[code] = longName;
+    }
+    if (!shortName.isEmpty())
+        m_nameToCode[shortName] = code;
+}
+
+#ifndef FAKEVIM_STANDALONE
+void FakeVimSettings::readSettings(QSettings *settings)
+{
+    foreach (SavedAction *item, m_items)
+        item->readSettings(settings);
+}
+
+void FakeVimSettings::writeSettings(QSettings *settings)
+{
+    foreach (SavedAction *item, m_items)
+        item->writeSettings(settings);
+}
+#endif // FAKEVIM_STANDALONE
+
+SavedAction *FakeVimSettings::item(int code)
+{
+    QTC_ASSERT(m_items.value(code, 0), qDebug() << "CODE: " << code; return 0);
+    return m_items.value(code, 0);
+}
+
+SavedAction *FakeVimSettings::item(const QString &name)
+{
+    return m_items.value(m_nameToCode.value(name, -1), 0);
+}
+
+QString FakeVimSettings::trySetValue(const QString &name, const QString &value)
+{
+    int code = m_nameToCode.value(name, -1);
+    if (code == -1)
+        return FakeVimHandler::tr("Unknown option: %1").arg(name);
+    if (code == ConfigTabStop || code == ConfigShiftWidth) {
+        if (value.toInt() <= 0)
+            return FakeVimHandler::tr("Argument must be positive: %1=%2")
+                    .arg(name).arg(value);
+    }
+    SavedAction *act = item(code);
+    if (!act)
+        return FakeVimHandler::tr("Unknown option: %1").arg(name);
+    act->setValue(value);
+    return QString();
+}
+
+SavedAction *createAction(FakeVimSettings *instance, int code, const QVariant &value,
+                          const QString &settingsKey = QString(),
+                          const QString &shortKey = QString())
+{
+    SavedAction *item = new SavedAction(instance);
+    item->setValue(value);
+#ifndef FAKEVIM_STANDALONE
+    item->setSettingsKey(_("FakeVim"), settingsKey);
+    item->setDefaultValue(value);
+    item->setCheckable( value.canConvert<bool>() );
+#endif
+    instance->insertItem(code, item, settingsKey.toLower(), shortKey);
+    return item;
+}
+
+FakeVimSettings *theFakeVimSettings()
+{
+    static FakeVimSettings *s = 0;
+    if (s)
+        return s;
+
+    s = new FakeVimSettings;
+
+    // Specific FakeVim settings
+    createAction(s, ConfigReadVimRc,  false,     _("ReadVimRc"));
+    createAction(s, ConfigVimRcPath,  QString(), _("VimRcPath"));
+#ifndef FAKEVIM_STANDALONE
+    createAction(s, ConfigUseFakeVim, false,     _("UseFakeVim"));
+    s->item(ConfigUseFakeVim)->setText(QCoreApplication::translate("FakeVim::Internal",
+        "Use Vim-style Editing"));
+    s->item(ConfigReadVimRc)->setText(QCoreApplication::translate("FakeVim::Internal",
+        "Read .vimrc"));
+    s->item(ConfigVimRcPath)->setText(QCoreApplication::translate("FakeVim::Internal",
+        "Path to .vimrc"));
+#endif
+    createAction(s, ConfigShowMarks,      false, _("ShowMarks"),      _("sm"));
+    createAction(s, ConfigPassControlKey, false, _("PassControlKey"), _("pck"));
+    createAction(s, ConfigPassNewLine,    false, _("PassNewLine"),    _("pnl"));
+
+    // Emulated Vim setting
+    createAction(s, ConfigStartOfLine,    true,  _("StartOfLine"),   _("sol"));
+    createAction(s, ConfigTabStop,        8,     _("TabStop"),       _("ts"));
+    createAction(s, ConfigSmartTab,       false, _("SmartTab"),      _("sta"));
+    createAction(s, ConfigHlSearch,       true,  _("HlSearch"),      _("hls"));
+    createAction(s, ConfigShiftWidth,     8,     _("ShiftWidth"),    _("sw"));
+    createAction(s, ConfigExpandTab,      false, _("ExpandTab"),     _("et"));
+    createAction(s, ConfigAutoIndent,     false, _("AutoIndent"),    _("ai"));
+    createAction(s, ConfigSmartIndent,    false, _("SmartIndent"),   _("si"));
+    createAction(s, ConfigIncSearch,      true,  _("IncSearch"),     _("is"));
+    createAction(s, ConfigUseCoreSearch,  false, _("UseCoreSearch"), _("ucs"));
+    createAction(s, ConfigSmartCase,      false, _("SmartCase"),     _("scs"));
+    createAction(s, ConfigIgnoreCase,     false, _("IgnoreCase"),    _("ic"));
+    createAction(s, ConfigWrapScan,       true,  _("WrapScan"),      _("ws"));
+    createAction(s, ConfigTildeOp,        false, _("TildeOp"),       _("top"));
+    createAction(s, ConfigShowCmd,        true,  _("ShowCmd"),       _("sc"));
+    createAction(s, ConfigScrollOff,      0,     _("ScrollOff"),     _("so"));
+    createAction(s, ConfigBackspace,      _("indent,eol,start"), _("ConfigBackspace"), _("bs"));
+    createAction(s, ConfigIsKeyword,      _("@,48-57,_,192-255,a-z,A-Z"), _("IsKeyword"), _("isk"));
+    createAction(s, ConfigClipboard,      QString(), _("Clipboard"), _("cb"));
+
+    return s;
+}
+
+SavedAction *theFakeVimSetting(int code)
+{
+    return theFakeVimSettings()->item(code);
+}
+
+} // namespace Internal
+} // namespace FakeVim