vile (editor)

From Wikipedia, the free encyclopedia

vile
Developed by Thomas Dickey
Latest release 9.6 / December 27, 2007
OS Cross-platform
Genre Text editor
License GNU General Public License
Website invisible-island.net/vile/

vile is a text editor that attempts to combine the best aspects of the popular Emacs and vi editors. These editors are traditionally located on opposing sides of the editor wars, as users of Emacs and vi tend to have strong sentiments against the editor they do not use; however, vile at least attempts to reconcile these positions.

vile is an acronym which stands for "VI Like Emacs". vile is featured in Chapter 12 of the O'Reilly book "Learning the vi Editor".[1] The program is also known as xvile[2] for the X Window System, and winvile for Microsoft Windows.

vile is maintained by Thomas Dickey, who took over from original author Paul Fox in 1996[3], after years of major contributions to the codebase.

Contents

[edit] Learning to use vile

Historically, vile's documentation has focused on differences from vi. This is in contrast to the other common vi-clones (elvis, nvi and vim) which have vi documentation combined with their respective extensions.

Vile's documentation is three parts:

  • the online help file (type :h)
winvile and online help focusing on differences from vi.
winvile and online help focusing on differences from vi.
  • specialized topics such as the macro language (text files)
  • built-in documentation.
    • tables of commands and other data
    • dynamic windows showing register contents, mode-settings, etc.
Example of [Buffer List], a dynamic window updated as a buffer is modified.
Example of [Buffer List], a dynamic window updated as a buffer is modified.

vile is built from a combination of hand-crafted code and tables processed by a special-purpose program. The predefined information from the tables can be rendered in various ways, including showing the available commands, providing name-completion, etc. In other flavors of vi, the analogous tables are not distinct from the hand-crafted code.

In other vi flavors the information shown dynamically in vile is static, requiring interaction from the user to make it update. vile updates these special windows as changes are made to the features they render, e.g., the list of all buffers in memory, the mode-settings corresponding to the buffer which has focus, etc.

While many (not all) of vile's features are now found in other vi-compatible editors, some of the most powerful were implemented before widespread adoption in the others. For example, multiple windows were early features in vile (and xvi) from the start. The same applies to reading from pipes, complex fences. Some of this is brought out in the O'Reilly book, though no careful study has been made of the way in which features are adopted and adapted across the vi and emacs variants.

[edit] Features and improvements over vi

  • Multi-window/multi-buffer editing
  • Multi-level undo/redo
  • Multi-platform with native features rather than in a Unix-compatible environment
  • Reads a buffer from standard input or from piped external commands
  • Error-expression parsing jumps to the line producing compile-errors, grep matches, etc.
  • Dynamic window updates
  • Scripting language
  • Many mode settings, globally, per-buffer, per-window
  • Color-syntax highlighting for each majormode (84 as of 2007).
  • Command-completion
  • Selection-highlighting using keyboard or mouse.
  • Complex fence feature enables the user to step through if/then/else statements
  • Extended regular expressions using both POSIX and Perl features.

[edit] Differences from vi

  • No real ex mode, though most ex commands are recognized
  • Command-completion and underlying long command-names make it impossibile to be 100% vi-compatible.

[edit] Features, in More Detail

[edit] Command Completion

Vile supports command completion at several phases of the command: the command-name, mode values, file- and directory-names.

[edit] Majormodes

Both vi and emacs have modes, which are settings which affect the behavior of the program. Vile extends the vi modes such as list, number, etc., by providing three levels of mode: global, buffer and window. The buffer modes are associated with the buffer contents, e.g., line-terminators, read-only attributes. All of those modes are predefined. Vile can be customized by defining majormodes, which combine specific settings of the buffer modes with an association to the file type. These majormodes have as well special modes such as the association with a specific syntax filter.

[edit] Syntax Highlighting

Vile performs syntax highlighting by running a syntax filter program which parses the buffer contents. Initially this was a separate program. However, to improve performance and avoid display problems, these syntax filters usually are compiled into the editor. Most of the syntax filters are implemented with lex (preferably flex), with the remainder in C to address irregular grammars such as Perl and Ruby. All of the syntax filters follow the same design:

  • read from an external file the color- and video-attribute information into a chained hash table,
  • parse the file according to the lexical rules,
  • find the corresponding color- and video-attribute information for each lexical element, and
  • write a marked-up copy of the file which is read by vile (via a pipe if the syntax filters are external programs, or via a function call if they are internal).

Vile paints the markup information on top of the buffer contents using in regions delimited by line and column numbers. The markup is not attached to the underlying buffer contents. To update the markup as the buffer is changed requires reanalysis. This is done automatically when the user pauses.

[edit] History

vile has been under continuous development since 1990. Some highlights:

  • 1990 port to MS-DOS
  • 1991 xvile, an X11 client
  • 1992 Step through C-preprocessor #if/.../#endif statements.
  • 1993 port to OpenVMS
  • 1994
  • 1995
    • C syntax highlighting using video attributes attached to buffer
  • 1996
    • convert to ANSI C
  • 1997 Perl interface
  • 1998
    • winvile, a Windows GUI client
    • majormodes combine buffer attributes based on file type
  • 1999
    • combine majormodes and syntax highlighting for more than 30 languages
    • relicense as GPLv2
  • 2000 Syntax filters can be built-in or external
  • 2001 Error-stepping generalized.
  • 2002 Character-classes in regular expressions
  • 2003 Minibuffer (prompt-line) generalized as one-line editor
  • 2004 Locale support
  • 2005 Syntax filters can be dynamically loaded
  • 2006 Multiple scripts can be invoked via the command-line options
  • 2007 Basic Unicode support.

[edit] See also

Wikibooks
Wikibooks Learning the vi editor has a page on the topic of

[edit] References

  1. ^ Linda Lamb & Arnold Robbins: "Learning the vi Editor (6th Edition)", O'Reilly & Associates, Inc., 1998
  2. ^ Dan Wilder, "At Last, An X-Based vi", Linux Journal, February 1997
  3. ^ Larry Ayers, "Updates to My Past Reviews", Linux Gazette, November 1996

[edit] External links

Languages