mVim

A MICRO copy of Vim

Features

• Tiny, single-filed, no dependency
• Vim-like commands
• Support UTF-8 and wide characters
• Copy, cut and paste
• History Tracing
• Keyword highlighting
• Position Stack

Compilation and Installation

Make sure you have c99 on your system, which should refer to a C99-compatible compiler. This project uses POSIX features and VT100 control sequences to draw the screen, so please check that your terminal supports it.

$ cd src && make install

The installation path is specified through variable DIR_INSTALL, which could be alternated on commandline, e.g.,

$ make install DIR_INSTALL="$HOME/.local/bin"

Configuration

Default configuration is specified at compile time. Some options could be modified at runtime with :set command.

Here is a list of configuration options:

• tabsize: int, Width of a TAB character.
• outputBuffersize (Compile time only): int, the size of stdout's buffer
• historySize (Compile time only): int, how many changes could be traced.
• highlightTrailingSpace: bool, whether to highlight trailing spaces.
• highlightKeywordColor: int, color used to highlight keywords (See Color List)
• positionStackSize (Compile time only): int, the size of Position Stack (See Position Stack)

Color List

• COLOR_BLACK: 0
• COLOR_RED: 1
• COLOR_GREEN: 2
• COLOR_YELLOW: 3
• COLOR_BLUE: 4
• COLOR_MAGENTA: 5
• COLOR_CYAN: 6
• COLOR_WHITE: 7

Position Stack

A stack is provided to ease browsing long files. Two commands are provided for for manipulate it,

• push (or pu for short): Push current position of cursor onto the position stack
• pop (or po for short): Pop a position from the stack and move cursor to it

Keyword Highlight

Keywords to be highlighted are listed in src/keywords.h and divided into groups. mVim selects a group at startup by matching the file extension.

mVim already ships keywords for following languages,

• C/C++
• Lua
• POSIX Shell
• Golang
• Elm
• Haskell
• M4 Macro Language

They were added since I'm using them in my daily basis.

Contribution

This project is tailored for my own usage, but I have make some efforts to adapt it to wider requirements. Pull requests and patches will not be accepted. If you want a feature to be added, make sure it isn't in the unsupported list (UNSUPPORTED_LIST), then give me an issue.

LICENSE

This project is distributed under BSD-2-Clause License.

This project is derived from kilo project, see src/mvim.c for details. LICENSE_KILO contains the original copyright.

Sponsor

Help poor children in Uganda!

Consider donating to ICCF.