Peter Szilagyi  committed 93fcc8d

Elisp-only micro-branch with Evil from 6a947d722881 (2012-10-03-roll-test).

  • Participants
  • Parent commits c50e542

Comments (0)

Files changed (27)

File elisp/contrib/evil-surround/

+This package emulates [surround.vim by Tim Pope](
+The functionality is wrapped into a minor mode.
+To enable it globally, add the following lines to ~/.emacs:
+    (require 'surround)
+    (global-surround-mode 1)
+Alternatively, you can enable surround-mode along a major mode by adding
+`turn-on-surround-mode' to the mode hook.
+This package uses [Evil](surround.vim by Tim Pope) as its vi layer.
+## Add surrounding ##
+You can surround in visual-state with `s<textobject><trigger>`
+or in normal-state with `ys<textobject><trigger>`.
+## Change surrounding ##
+You can change a surrounding with `cs<old-trigger><new-trigger>`.
+## Delete surrounding ##
+You can delete a surrounding with `cd<old-trigger><new-trigger>`.
+## Add new surround pairs ##
+A surround pair is this (trigger char with textual left and right strings):
+    (?> . ("<" . ">"))
+or this (trigger char and calling a function):
+    (?< . surround-read-tag)
+You can add new by adding them to `surround-pairs-alist`.
+For more information do: `C-h v surround-pairs-alist`.
+`surround-pairs-alist` is a buffer local variable, which means that you can have
+different surround pairs in different modes.
+By default `<` is used to insert a tag, in C++ this may not be useful - but
+inserting angle brackets is, so you can add this:
+    (add-hook 'c++-mode-hook (lambda ()
+                               (push '(?< . ("< " . " >")) surround-pairs-alist)))
+Don't worry about having two entries for `<` surround will take the first.
+Or in Emacs Lisp modes using \` to enter \` ' is quite useful, but not adding a
+pair of ` (the default behavior if no entry in `surround-pairs-alist` is
+present), so you can do this:
+    (add-hook 'emacs-lisp-mode-hook (lambda ()
+                                      (push '(?` . ("`" . "'")) surround-pairs-alist)))
+without affecting your Markdown surround pairs, where the default is useful.
+To change the default `surround-pairs-alist` you have to use `setq-default`, for
+example to remove all default pairs:
+    (setq-default surround-pairs-alist '())
+or to add a pair that surrounds with two ` if you enter ~:
+    (setq-default surround-pairs-alist (cons '(?~ ("``" . "``"))
+                                             surround-pairs-alist))
+## Usage examples ##
+Here are some usage examples (taken from
+Press `cs"'` inside
+    "Hello world!"
+to change it to
+    'Hello world!'
+Now press `cs'<q>` to change it to
+    <q>Hello world!</q>
+To go full circle, press `cst"` to get
+    "Hello world!"
+To remove the delimiters entirely, press `ds"`.
+    Hello world!
+Now with the cursor on "Hello", press `ysiw]` (`iw` is a text object).
+    [Hello] world!
+Let's make that braces and add some space (use `}` instead of `{` for no
+space): `cs]{`
+    { Hello } world!
+Now wrap the entire line in parentheses with `yssb` or `yss)` (wrapping the line
+is currently broken see [issue #5](
+    ({ Hello } world!)
+Revert to the original text: `ds{ds)`
+    Hello world!
+Emphasize hello: `ysiw<em>`
+    <em>Hello</em> world!
+Finally, let's try out visual mode. Press a capital V (for linewise
+visual mode) followed by `S<p class="important">`.
+    <p class="important">
+      <em>Hello</em> world!
+    </p>

File elisp/contrib/evil-surround/surround.el

+;;; surround.el --- emulate surround.vim from Vim
+;; Copyright (C) 2010, 2011 Tim Harper
+;; Author: Tim Harper <timcharper at gmail dot com>
+;;      Vegard Øye <vegard_oye at hotmail dot com>
+;; Maintainer: Please send bug reports to the mailing list (below).
+;; Created: July 23 2011
+;; Version: 0.1
+;; Keywords: emulation, vi, evil
+;; Mailing list: <implementations-list at>
+;;      Subscribe:
+;;      Newsgroup: nntp://
+;;      Archives:
+;; This file is not part of GNU Emacs.
+;;; Commentary:
+;; This package emulates surround.vim by Tim Pope.
+;; The functionality is wrapped into a minor mode. To enable
+;; it globally, add the following lines to ~/.emacs:
+;;     (require 'surround)
+;;     (global-surround-mode 1)
+;; Alternatively, you can enable surround-mode along a major mode
+;; by adding `turn-on-surround-mode' to the mode hook.
+;; This package uses Evil as its vi layer. It is available from:
+;;; Code:
+(require 'evil)
+(defgroup surround nil
+  "surround.vim for Emacs"
+  :prefix "surround-"
+  :group 'evil)
+(defcustom surround-pairs-alist
+  '((?\( . ("( " . " )"))
+    (?\[ . ("[ " . " ]"))
+    (?\{ . ("{ " . " }"))
+    (?\) . ("(" . ")"))
+    (?\] . ("[" . "]"))
+    (?\} . ("{" . "}"))
+    (?# . ("#{" . "}"))
+    (?b . ("(" . ")"))
+    (?B . ("{" . "}"))
+    (?> . ("<" . ">"))
+    (?t . surround-read-tag)
+    (?< . surround-read-tag))
+  "Association list of surround items.
+Each item is of the form (TRIGGER . (LEFT . RIGHT)), all strings.
+Alternatively, a function can be put in place of (LEFT . RIGHT).
+This only affects inserting pairs, not deleting or changing them."
+  :group 'surround
+  :type '(repeat (cons (regexp :tag "Key")
+                       (symbol :tag "Surround pair"))))
+(make-variable-buffer-local 'surround-pairs-alist)
+(defvar surround-read-tag-map
+  (let ((map (copy-keymap minibuffer-local-map)))
+    (define-key map ">" 'exit-minibuffer)
+    map)
+  "Keymap used by `surround-read-tag'.")
+(defun surround-read-tag ()
+  "Read a XML tag from the minibuffer."
+  (let* ((input (read-from-minibuffer "<" "" surround-read-tag-map))
+         (match (string-match "\\([0-9a-z-]+\\)\\(.*?\\)[>]*$" input))
+         (tag  (match-string 1 input))
+         (rest (match-string 2 input)))
+    (cons (format "<%s%s>" (or tag "") (or rest ""))
+          (format "</%s>" (or tag "")))))
+(defun surround-pair (char)
+  "Return the surround pair of char.
+This is a cons cell (LEFT . RIGHT), both strings."
+  (let ((pair (assoc-default char surround-pairs-alist)))
+    (cond
+     ((functionp pair)
+      (funcall pair))
+     ((consp pair)
+      pair)
+     (t
+      (cons (format "%c" char) (format "%c" char))))))
+(defun surround-outer-overlay (char)
+  "Return outer overlay for the delimited range represented by CHAR.
+This overlay includes the delimiters.
+See also `surround-inner-overlay'."
+  (let ((outer (lookup-key evil-outer-text-objects-map (string char))))
+    (when (functionp outer)
+      (setq outer (funcall outer))
+      (when (evil-range-p outer)
+        (surround-trim-whitespace-from-range outer "[ \t]")
+        (setq outer (make-overlay (evil-range-beginning outer)
+                                  (evil-range-end outer)
+                                  nil nil t))))))
+(defun surround-trim-whitespace-from-range (range &optional regexp)
+  "Given an evil-range, trim whitespace around range by shrinking the range such that it neither begins nor ends with whitespace. Does not modify the buffer."
+  (let ((regexp (or regexp "[ \f\t\n\r\v]")))
+    (save-excursion
+      (save-match-data
+        (goto-char (evil-range-beginning range))
+        (while (looking-at regexp) (forward-char))
+        (evil-set-range-beginning range (point))
+        (goto-char (evil-range-end range))
+        (while (looking-back regexp) (backward-char))
+        (evil-set-range-end range (point))))))
+(defun surround-inner-overlay (char)
+  "Return inner overlay for the delimited range represented by CHAR.
+This overlay excludes the delimiters.
+See also `surround-outer-overlay'."
+  (let ((inner (lookup-key evil-inner-text-objects-map (string char))))
+    (when (functionp inner)
+      (setq inner (funcall inner))
+      (when (evil-range-p inner)
+        (when (eq (char-syntax char) ?\()
+          (surround-trim-whitespace-from-range inner "[ \t]"))
+        (setq inner (make-overlay (evil-range-beginning inner)
+                                  (evil-range-end inner)
+                                  nil nil t))))))
+(defun surround-delete (char &optional outer inner)
+  "Delete the surrounding delimiters represented by CHAR.
+Alternatively, the text to delete can be represented with
+the overlays OUTER and INNER, where OUTER includes the delimiters
+and INNER excludes them. The intersection (i.e., difference)
+between these overlays is what is deleted."
+  (interactive "c")
+  (cond
+   ((and outer inner)
+    (delete-region (overlay-start outer) (overlay-start inner))
+    (delete-region (overlay-end inner) (overlay-end outer))
+    (goto-char (overlay-start outer)))
+   (t
+    ;; no overlays specified: create them on the basis of CHAR
+    ;; and delete after use
+    (let* ((outer (surround-outer-overlay char))
+           (inner (surround-inner-overlay char)))
+      (unwind-protect
+          (when (and outer inner)
+            (surround-delete char outer inner))
+        (when outer (delete-overlay outer))
+        (when inner (delete-overlay inner)))))))
+(defun surround-change (char &optional outer inner)
+  "Change the surrounding delimiters represented by CHAR.
+Alternatively, the text to delete can be represented with the
+overlays OUTER and INNER, which are passed to `surround-delete'."
+  (interactive "c")
+  (cond
+   ((and outer inner)
+    (surround-delete char outer inner)
+    (surround-region (overlay-start outer)
+                     (overlay-end outer)
+                     nil (read-char)))
+   (t
+    (let* ((outer (surround-outer-overlay char))
+           (inner (surround-inner-overlay char)))
+      (unwind-protect
+          (when (and outer inner)
+            (surround-change char outer inner))
+        (when outer (delete-overlay outer))
+        (when inner (delete-overlay inner)))))))
+;; Dispatcher function in Operator-Pending state.
+;; "cs" calls `surround-change', "ds" calls `surround-delete',
+;; and "ys" calls `surround-region'.
+(evil-define-command surround-edit (operation)
+  "Edit the surrounding delimiters represented by CHAR.
+If OPERATION is `change', call `surround-change'.
+if OPERATION is `surround', call `surround-region'.
+Otherwise call `surround-delete'."
+  (interactive
+   (progn
+     ;; abort the calling operator
+     (setq evil-inhibit-operator t)
+     (list (assoc-default evil-this-operator
+                          '((evil-change . change)
+                            (evil-delete . delete))))))
+  (cond
+   ((eq operation 'change)
+    (call-interactively 'surround-change))
+   ((eq operation 'delete)
+    (call-interactively 'surround-delete))
+   (t
+    (define-key evil-operator-shortcut-map "s" 'evil-line)
+    (call-interactively 'surround-region))))
+(evil-define-operator surround-region (beg end type char &optional force-new-line)
+  "Surround BEG and END with CHAR.
+When force-new-line is true, and region type is not line, the
+following: (vertical bars indicate region start/end points)
+   do |:thing|
+Becomes this:
+   do {
+     :thing
+   }"
+  (interactive "<R>c")
+  (let* ((overlay (make-overlay beg end nil nil t))
+         (pair (surround-pair char))
+         (open (car pair))
+         (close (cdr pair)))
+    (unwind-protect
+        (progn
+          (goto-char (overlay-start overlay))
+          (cond ((eq type 'line)
+                 (insert open)
+                 (indent-according-to-mode)
+                 (newline-and-indent)
+                 (goto-char (overlay-end overlay))
+                 (insert close)
+                 (indent-according-to-mode)
+                 (newline))
+                (force-new-line
+                 (insert open)
+                 (indent-according-to-mode)
+                 (newline-and-indent)
+                 (goto-char (overlay-end overlay))
+                 (newline-and-indent)
+                 (insert close))
+                (t
+                 (insert open)
+                 (goto-char (overlay-end overlay))
+                 (insert close)))
+          (goto-char (overlay-start overlay)))
+      (delete-overlay overlay))))
+(evil-define-operator Surround-region (beg end type char)
+  "Call surround-region, toggling force-new-line"
+  (interactive "<R>c")
+  (surround-region beg end type char t))
+(define-minor-mode surround-mode
+  "Buffer-local minor mode to emulate surround.vim."
+  :keymap (make-sparse-keymap)
+  (evil-normalize-keymaps))
+(defun turn-on-surround-mode ()
+  "Enable surround-mode in the current buffer."
+  (surround-mode 1))
+(defun turn-off-surround-mode ()
+  "Disable surround-mode in the current buffer."
+  (surround-mode -1))
+(define-globalized-minor-mode global-surround-mode
+  surround-mode turn-on-surround-mode
+  "Global minor mode to emulate surround.vim.")
+(evil-define-key 'operator surround-mode-map "s" 'surround-edit)
+(evil-define-key 'visual surround-mode-map "s" 'surround-region)
+(evil-define-key 'visual surround-mode-map "S" 'Surround-region)
+(provide 'surround)
+;;; surround.el ends here

File elisp/contrib/evil/COPYING

+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+ Copyright (C) 2007 Free Software Foundation, Inc. <>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+                            Preamble
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+  The precise terms and conditions for copying, distribution and
+modification follow.
+                       TERMS AND CONDITIONS
+  0. Definitions.
+  "This License" refers to version 3 of the GNU General Public License.
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+  1. Source Code.
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+  The Corresponding Source for a work in source code form is that
+same work.
+  2. Basic Permissions.
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+  4. Conveying Verbatim Copies.
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+  5. Conveying Modified Source Versions.
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+  6. Conveying Non-Source Forms.
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+  7. Additional Terms.
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+  8. Termination.
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+  9. Acceptance Not Required for Having Copies.
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+  10. Automatic Licensing of Downstream Recipients.
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+  11. Patents.
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+  12. No Surrender of Others' Freedom.
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+  13. Use with the GNU Affero General Public License.
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+  14. Revised Versions of this License.
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+  15. Disclaimer of Warranty.
+  16. Limitation of Liability.
+  17. Interpretation of Sections 15 and 16.
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+                     END OF TERMS AND CONDITIONS
+            How to Apply These Terms to Your New Programs
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    GNU General Public License for more details.
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <>.
+Also add information on how to contact you by electronic and paper mail.
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read

File elisp/contrib/evil/Makefile

+SHELL = /bin/sh
+EMACS = emacs
+FILES = $(filter-out evil-tests.el,$(filter-out evil-pkg.el,$(wildcard evil*.el)))
+VERSION := $(shell sed -n '3s/.*"\(.*\)".*/\1/p' evil-pkg.el)
+DOC = doc
+TAG =
+LIBS = -L lib
+ELCFILES = $(FILES:.el=.elc)
+.PHONY: all compile compile-batch info pdf clean tests test emacs term terminal profiler indent elpa version
+# Byte-compile Evil.
+all: compile
+compile: $(ELCFILES)
+.depend: $(FILES)
+	@echo Compute dependencies
+	@rm -f .depend
+	@for f in $(FILES); do \
+	    sed -n "s/(require '\(evil-.*\))/$${f}c: \1.elc/p" $$f >> .depend;\
+	done
+-include .depend
+$(ELCFILES): %.elc: %.el
+	$(EMACS) --batch -Q -L . $(LIBS) -f batch-byte-compile $<
+# Byte-compile all files in one batch. This is faster than
+# compiling each file in isolation, but also less stringent.
+compile-batch: clean
+	$(EMACS) --batch -Q -L . $(LIBS) -f batch-byte-compile ${FILES}
+# Documentation.
+info: clean pdf
+	cd $(DOC) && makeinfo evil.texi
+pdf: clean
+	cd $(DOC) && texi2pdf evil.texi
+# Delete byte-compiled files etc.
+	rm -f *~
+	rm -f \#*\#
+	rm -f *.elc
+	rm -f .depend
+	cd $(DOC) && rm -f *.aux *.cp *.fn *.fns *.info *.ky *.log *.pg *.toc *.tp *.vr *.vrs
+# Run tests.
+# The TAG variable may specify a test tag or a test name:
+#       make test TAG=repeat
+# This will only run tests pertaining to the repeat system.
+	$(EMACS) --batch -Q -L . $(LIBS) -l evil-tests.el \
+--eval "(evil-tests-initialize '(${TAG}) '(${PROFILER}))"
+# Byte-compile Evil and run all tests.
+tests: compile
+	$(EMACS) --batch -Q -L . $(LIBS) -l evil-tests.el \
+--eval "(evil-tests-initialize '(${TAG}) '(${PROFILER}))"
+	rm -f *.elc
+# Load Evil in a fresh instance of Emacs and run all tests.
+	$(EMACS) -Q -L . $(LIBS) -l goto-chg.el -l evil-tests.el \
+--eval "(evil-mode 1)" \
+--eval "(evil-tests-initialize '(${TAG}) '(${PROFILER}) t)" &
+# Load Evil in a terminal Emacs and run all tests.
+term: terminal
+	$(EMACS) -nw -Q -L . $(LIBS) -l goto-chg.el -l evil-tests.el \
+--eval "(evil-mode 1)" \
+--eval "(evil-tests-initialize '(${TAG}) '(${PROFILER}) t)"
+# Run all tests with profiler.
+	$(EMACS) --batch -Q -L . $(LIBS) -l goto-chg.el -l evil-tests.el \
+--eval "(evil-tests-initialize '(${TAG}) (or '(${PROFILER}) t))"
+# Re-indent all Evil code.
+# Loads Evil into memory in order to indent macros properly.
+# Also removes trailing whitespace, tabs and extraneous blank lines.
+indent: clean
+	$(EMACS) --batch --eval '(setq vc-handled-backends nil)' ${FILES} evil-tests.el -Q -L . $(LIBS) -l evil-tests.el \
+--eval "(dolist (buffer (reverse (buffer-list))) \
+(when (buffer-file-name buffer) \
+(set-buffer buffer) \
+(message \"Indenting %s\" (current-buffer)) \
+(setq-default indent-tabs-mode nil) \
+(untabify (point-min) (point-max)) \
+(indent-region (point-min) (point-max)) \
+(delete-trailing-whitespace) \
+(untabify (point-min) (point-max)) \
+(goto-char (point-min)) \
+(while (re-search-forward \"\\n\\\\{3,\\\\}\" nil t) \
+(replace-match \"\\n\\n\")) \
+(when (buffer-modified-p) (save-buffer 0))))"
+# Create an ELPA package.
+	@echo "Creating ELPA package $(ELPAPKG).tar"
+	@rm -rf ${ELPAPKG}
+	@mkdir ${ELPAPKG}
+	@cp $(FILES) evil-pkg.el ${ELPAPKG}
+	@tar cf ${ELPAPKG}.tar ${ELPAPKG}
+	@rm -rf ${ELPAPKG}
+# Change the version using make VERSION=x.y.z
+	cat evil-pkg.el | sed "3s/\".*\"/\"${VERSION}\"/" > && mv evil-pkg.el

File elisp/contrib/evil/doc/evil.texi

+\input texinfo @c -*-texinfo-*-
+@documentencoding ISO-8859-1
+@include version.texi
+@settitle Evil-mode manual
+@include macros.texi
+This manual is for Evil (version @value{VERSION} of @value{UPDATED}),
+an extensible vi layer for Emacs.
+Copyright @copyright{} 2011 @authors{}.
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled
+``GNU Free Documentation License''.
+@end quotation
+The Evil team thanks everyone at gmane.emacs.vim-emulation for
+their feedback and contributions.
+@end copying
+@dircategory Emacs
+* Evil: (evil). Extensible vi layer for Emacs.
+@end direntry
+@title Evil
+@subtitle Extensible vi layer for Emacs
+@author @authors{}
+@end titlepage
+@node Top, Overview, (dir), (dir)
+@top Evil
+This is the manual for Evil, an extensible vi layer for Emacs.
+@end ifnottex
+* Overview::
+* Settings::
+* Keymaps::
+* Hooks::
+* Macros::
+* Other internals::
+* GNU Free Documentation License::
+@end menu
+@node Overview
+@chapter Overview
+Evil is an extensible vi layer for Emacs.  It emulates the main features
+of Vim,@footnote{Vim is the most popular version of @dfn{vi}, a modal
+text editor with many implementations.  Vim also adds some functions of
+its own, like Visual selection and text objects.  For more information,
+see: @uref{}} turning Emacs into a modal editor.
+Like Emacs in general, Evil is extensible in Emacs Lisp.
+* Installation::
+* Modes and states::
+@end menu
+@node Installation
+@section Installation
+Evil lives in a Git repository.  To download Evil, do:
+git clone git://
+@end example
+@noindent Move Evil to @code{~/.emacs.d/evil}.  Then add the following
+lines to @code{~/.emacs}:
+(add-to-list 'load-path "~/.emacs.d/evil")
+(require 'evil)
+(evil-mode 1)
+@end lisp
+@noindent Evil requires @code{undo-tree.el} to provide linear undo
+and undo branches.  It is available from
+(A copy of @code{undo-tree.el} is also included in the Git repository.)
+@node Modes and states
+@section Modes and states
+The next time Emacs is started, it will come up in @dfn{Normal state},
+denoted by @code{<N>} on the mode line.  This is where the main vi
+bindings are defined.  Note that you can always disable Normal state
+with @kbd{C-z}, which switches to an ``Emacs state'' (denoted by
+@code{<E>}) in which vi keys are completely disabled.  Press @kbd{C-z}
+again to switch back to Normal state.
+Evil uses the term @dfn{state} for what is called a ``mode'' in vi,
+since ``mode'' already has its own meaning in Emacs.  Evil defines a
+number of states, such as Normal state (@code{<N>}), Insert state
+(@code{<I>}), Visual state (@code{<V>}), Replace state (@code{<R>}),
+Operator-Pending state (@code{<O>}), Motion state (@code{<M>}) and Emacs
+state (@code{<E>}).  Each state has its own keymaps and customization
+Meanwhile, a @dfn{mode} in Emacs is a set of key bindings for editing a
+certain sort of text, like @code{emacs-lisp-mode} for Emacs Lisp.  Modes
+may include custom bindings for Evil states.
+@node Settings
+@chapter Settings
+Evil's behavior can be adjusted by setting various variables.
+The current values may be inspected by doing
+@kbd{M-x customize-group RET evil RET}.
+To change the value of a variable, add a @samp{setq} form to
+@code{~/.emacs}, preferably before Evil is loaded:@footnote{Strictly
+speaking, the order only matters if the variable affects the way Evil is
+loaded.  This is the case with some of the @samp{evil-want-} variables.}
+(setq evil-shift-width 8)
+;; @r{Load Evil}
+(require 'evil) @r{@dots{}}
+@end lisp
+@noindent Note that if a variable is buffer-local, you must use
+@samp{setq-default} instead of @samp{setq} to change its global value.
+@defvar evil-auto-indent
+Whether the current line is indented when entering Insert state.
+If @code{t} (the default), then the line is indented.  If @code{nil},
+then the line is not indented.  Buffer-local.
+@end defvar
+@defvar evil-shift-width
+The number of columns a line is shifted by the commands
+@kbd{>} and @kbd{<}.
+@end defvar
+@defvar evil-repeat-move-cursor
+If @code{t} (the default), then repeating a command with @kbd{.} may
+change the position of the cursor.  If @code{nil}, then the original
+position is preserved.
+@end defvar
+@defvar evil-find-skip-newlines
+If @code{t}, then @kbd{f}, @kbd{F}, @kbd{t} and @kbd{T} may skip over
+newlines to find a character.  If @code{nil} (the default), then they
+are restricted to the current line.
+@end defvar
+@defvar evil-move-cursor-back
+If @code{t} (the default), then the cursor moves backwards when exiting
+Insert state.  If @code{nil}, then the cursor does not move.
+@end defvar
+@defvar evil-want-fine-undo
+If @code{t}, then a change-based action like @kbd{cw} may be undone
+in several steps.  If @code{nil} (the default), then it is undone in
+one step.
+@end defvar
+@defvar evil-regexp-search
+If @code{t} (the default), then @kbd{/} and @kbd{?} use regular
+expressions for searching.  If @code{nil}, they use plain text.
+@end defvar
+@defvar evil-search-wrap
+If @code{t} (the default), then @kbd{/} and @kbd{?} wrap the search
+around the buffer.  If @code{nil}, then they stop at buffer boundaries.
+@end defvar
+@defvar evil-flash-delay
+The number of seconds to flash search matches when pressing @kbd{n}
+and @kbd{N}.
+@end defvar
+@defvar evil-want-C-i-jump
+If @code{t} (the default), then @kbd{C-i} jumps forwards in the jump
+list.  If @code{nil}, then @kbd{C-i} inserts a tab.
+@end defvar
+@defvar evil-want-C-u-scroll
+If @code{t}, then @kbd{C-u} scrolls the buffer.  If @code{nil} (the
+default), then @kbd{C-u} begins a numeric prefix argument.
+@end defvar
+* The cursor::
+* The initial state::
+@end menu
+@node The cursor
+@section The cursor
+A state may change the cursor's appearance.  The cursor settings are
+stored in the variables below, which may contain a cursor type as per
+the @samp{cursor-type} variable, a color string as passed to the
+@samp{set-cursor-color} function, a zero-argument function for changing
+the cursor, or a list of the above.  For example, the following changes
+the cursor in Replace state to a red box:
+(setq evil-replace-state-cursor '("red" box))
+@end lisp
+@noindent If the state does not specify a cursor,
+@samp{evil-default-cursor} is used.
+@defvar evil-default-cursor
+The default cursor.
+@end defvar
+@defvar evil-normal-state-cursor
+The cursor for Normal state.
+@end defvar
+@defvar evil-insert-state-cursor
+The cursor for Insert state.
+@end defvar
+@defvar evil-visual-state-cursor
+The cursor for Visual state.
+@end defvar
+@defvar evil-replace-state-cursor
+The cursor for Replace state.
+@end defvar
+@defvar evil-operator-state-cursor
+The cursor for Operator-Pending state.
+@end defvar
+@defvar evil-motion-state-cursor
+The cursor for Motion state.
+@end defvar
+@defvar evil-emacs-state-cursor
+The cursor for Emacs state.
+@end defvar
+@node The initial state
+@section The initial state
+By default, a new buffer comes up in Normal state.  This can be changed
+with the function @samp{evil-set-initial-state}.
+@defun evil-set-initial-state mode state
+Set the initial state for a buffer in which @var{mode} is active to
+@var{state}.  @var{mode} should be a major mode such as
+@code{text-mode}, although minor modes work as well.
+@end defun
+@node Keymaps
+@chapter Keymaps
+Evil's key bindings are stored in a number of keymaps.  Each state has a
+@dfn{global keymap}, where the default key bindings for the state are
+stored.  For example, the global keymap for Normal state is
+@samp{evil-normal-state-map}, and the key bindings in this map are seen
+in all buffers that are currently in Normal state.
+Keymaps are modified with the Emacs function @samp{define-key}:
+(define-key evil-normal-state-map "w" 'foo)
+@end lisp
+@noindent This binds the key @kbd{w} to the command @samp{foo}
+in Normal state.  The file @code{evil-maps.el} contains all the
+key bindings.
+@defvar evil-normal-state-map
+The global keymap for Normal state.
+@end defvar
+@defvar evil-insert-state-map
+The global keymap for Insert state.
+@end defvar
+@defvar evil-visual-state-map
+The global keymap for Visual state.
+@end defvar
+@defvar evil-replace-state-map
+The global keymap for Replace state.
+@end defvar
+@defvar evil-operator-state-map
+The global keymap for Operator-Pending state.
+@end defvar
+@defvar evil-motion-state-map
+The global keymap for Motion state.
+@end defvar
+@noindent Each state also has a @dfn{buffer-local keymap},
+which is specific to the current buffer and has precedence over
+the global keymap.  These maps may be changed from a mode hook.
+@defvar evil-normal-state-local-map
+Buffer-local keymap for Normal state.
+@end defvar
+@defvar evil-insert-state-local-map
+Buffer-local keymap for Insert state.
+@end defvar
+@defvar evil-visual-state-local-map
+Buffer-local keymap for Visual state.
+@end defvar
+@defvar evil-replace-state-local-map
+Buffer-local keymap for Replace state.
+@end defvar
+@defvar evil-operator-state-local-map
+Buffer-local keymap for Operator-Pending state.
+@end defvar
+@defvar evil-motion-state-local-map
+Buffer-local keymap for Motion state.
+@end defvar
+* @samp{evil-define-key}::
+@end menu
+@node @samp{evil-define-key}
+@section @samp{evil-define-key}
+Finally, Evil provides the function @samp{evil-define-key} for adding
+state bindings to a regular keymap.
+@defun evil-define-key state keymap key def
+In @var{keymap}, create a binding from @var{key} to @var{def} in
+@var{state}.  @var{state} is one of @samp{normal}, @samp{insert},
+@samp{visual}, @samp{replace}, @samp{operator} and @samp{motion}.
+The other parameters are like those of @samp{define-key}.
+@end defun
+@noindent @samp{evil-define-key} can be used to augment existing
+modes with state bindings, as well as create packages for custom
+bindings.  For example, the following will create a minor mode
+@code{foo-mode} with Normal state bindings for the keys @kbd{w}
+and @kbd{e}:
+(define-minor-mode foo-mode
+  "Foo mode."
+  :keymap (make-sparse-keymap))
+(evil-define-key 'normal foo-mode-map "w" 'bar)
+(evil-define-key 'normal foo-mode-map "e" 'baz)
+@end lisp
+@noindent This minor mode can then be enabled in any buffers where
+the custom bindings are desired:
+(add-hook 'text-mode-hook 'foo-mode) ; @r{enable alongside @code{text-mode}}
+@end lisp
+@noindent If the minor mode is put into its own file @code{foo.el}
+with a @code{(provide 'foo)} statement, it becomes an Emacs package.
+@node Hooks
+@chapter Hooks
+A @dfn{hook} is a list of functions to execute.  Hooks are modified with
+the Emacs function @samp{add-hook}.  Evil provides entry and exit hooks
+for all of its states.
+@defvar evil-normal-state-entry-hook
+Run when entering Normal state.
+@end defvar
+@defvar evil-normal-state-exit-hook
+Run when exiting Normal state.
+@end defvar
+@defvar evil-insert-state-entry-hook
+Run when entering Insert state.
+@end defvar
+@defvar evil-insert-state-exit-hook
+Run when exiting Insert state.
+@end defvar
+@defvar evil-visual-state-entry-hook
+Run when entering Visual state.
+@end defvar
+@defvar evil-visual-state-exit-hook
+Run when exiting Visual state.
+@end defvar
+@defvar evil-replace-state-entry-hook
+Run when entering Replace state.
+@end defvar
+@defvar evil-replace-state-exit-hook
+Run when exiting Replace state.
+@end defvar
+@defvar evil-operator-state-entry-hook
+Run when entering Operator-Pending state.
+@end defvar
+@defvar evil-operator-state-exit-hook
+Run when exiting Operator-Pending state.
+@end defvar
+@defvar evil-motion-state-entry-hook
+Run when entering Motion state.
+@end defvar
+@defvar evil-motion-state-exit-hook
+Run when exiting Motion state.
+@end defvar
+@noindent When these hooks are run, the variables @samp{evil-next-state}
+and @samp{evil-previous-state} hold information about the states being
+switched to and from.
+@defvar evil-next-state
+The state being switched to.
+@end defvar
+@defvar evil-previous-state
+The state being switched from.
+@end defvar
+@node Macros
+@chapter Macros
+Evil is implemented in terms of reusable macros.  Package writers can
+use these to define new commands.
+* Motions::
+* Operators::
+* Text objects::
+* Types::
+* States::
+@end menu
+@node Motions
+@section Motions
+A @dfn{motion} is a command which moves the cursor, such as @kbd{w} and
+@kbd{e}.  Motions are defined with the macro @samp{evil-define-motion}.
+Motions not defined in this way should be declared with
+@defun evil-declare-motion command
+Declare @var{command} to be a motion.  This ensures that it works
+properly in Visual state.
+@end defun
+@defmac evil-define-motion motion (count args@dots{}) doc keyword-args@dots{} body@dots{}
+Define a movement command @var{motion}.  A motion can have any number of
+arguments, but the first argument, if any, has a predefined meaning as
+the @var{count}. It is a positive or negative number, or @code{nil}.
+The argument list is followed by the documentation string @var{doc},
+which is followed by optional keyword arguments:
+@table @code
+@item :type @var{type}
+The @var{type} determines how the motion works after an operator.  If
+@var{type} is @samp{inclusive}, then the ending position is included in
+the motion range.  If @var{type} is @samp{line}, then the range is
+expanded to linewise positions.  If @var{type} is @samp{block}, then the
+range is blockwise.  The default is @samp{exclusive}, which means that
+the range is used as-is.
+@item :jump @var{jump}
+If @var{jump} is @code{t}, then the previous position is stored in the
+jump list so it can be restored with @kbd{C-o}.  The default is
+@end table
+The keyword arguments are followed by the @var{body}, which is where
+the motion's behavior is defined.  For instance:
+(evil-define-motion foo-forward (count)
+  "Move to the right by COUNT characters."
+  :type inclusive
+  (forward-char (or count 1)))
+@end lisp
+For more examples, you can view the source code for any command with
+@kbd{C-h k}.  For instance, @samp{evil-goto-line} may be viewed by
+typing @kbd{C-h k G} and following the file link.
+@end defmac
+@node Operators
+@section Operators
+An @dfn{operator} is a command which acts on the text moved over by a
+motion, such as @kbd{c}, @kbd{d} and @kbd{y}.  Operators are defined
+with the macro @samp{evil-define-operator}.
+@defmac evil-define-operator operator (beg end type args@dots{}) doc keyword-args@dots{} body@dots{}
+Define an operator command @var{operator}.  An operator must have at
+least two or three arguments, which have predefined meanings.
+@var{beg} is the beginning position, @var{end} is the ending position,
+and @var{type}, if given, is the type of the motion range.  The argument
+list is followed by the documentation string @var{doc}, which is
+followed by optional keyword arguments:
+@table @code
+@item :type @var{type}
+Make the input range be a certain @var{type}.  For example, an operator
+which only works with whole lines may set @var{type} to @samp{line}.
+@item :motion @var{motion}
+Use the motion @var{motion} instead of reading one from the keyboard.
+This does not affect the behavior in Visual state, where the selection
+boundaries are used instead.
+@item :repeat @var{repeat}
+If @var{repeat} is @code{t} (the default), then @kbd{.} will repeat the
+operator.  If @var{repeat} is @code{nil}, then the operator will not be
+@item :move-point @var{move-point}
+If @var{move-point} is @code{t} (the default), then the cursor is
+positioned at the beginning of the range.  If @var{move-point} is
+@code{nil}, then the original position is preserved.
+@item :keep-visual @var{keep-visual}
+If @var{keep-visual} is @code{t}, then the selection is not disabled
+when the operator is run in Visual state; it is up to the operator to do
+this.  The default is @code{nil}, which means that Visual state is
+exited automatically.
+@end table
+The keyword arguments are followed by the @var{body}, which is where the
+operator's actions on @var{beg} and @var{end} are defined.  For example,
+@samp{evil-rot13}, which is bound to @kbd{g?} and performs ROT13
+encryption on the text, may be defined as:
+(evil-define-operator evil-rot13 (beg end)
+  "ROT13 encrypt text."
+  (rot13-region beg end))
+@end lisp
+Pressing @kbd{g?w} will encrypt a word by calling @samp{rot13-region}
+on the text moved over by the @kbd{w} motion.
+@end defmac
+@node Text objects
+@section Text objects
+A @dfn{text object} is a special kind of motion which sets a beginning
+position as well as an ending position, such as @kbd{iw} and @kbd{a(}.
+In Visual state, text objects alter both ends of the selection.  Text
+objects are defined with the macro @samp{evil-define-text-object}.
+@defmac evil-define-text-object object (count args@dots{}) doc keyword-args@dots{} body@dots{}
+Define a text object @var{object}.  The first argument has a predefined
+meaning as the @var{count}: it is a positive or negative number.  The
+argument list is followed by the documentation string @var{doc}, which
+is followed by optional keyword arguments:
+@table @code
+@item :type @var{type}
+Use the type @var{type} after an operator.  In Visual state, this is the
+type of the selection.
+@item :extend-selection @var{extend-selection}
+If @var{extend-selection} is @code{t} (the default), then the text
+object always enlarges the current selection.  If @code{nil}, then the
+object replaces the selection.
+@end table
+The keyword arguments are followed by the @var{body}, which should
+evaluate to a list @code{(@var{beg} @var{end})} of two positions in the
+buffer.  For example, a text object which selects three characters
+following the current position could be defined as:
+(evil-define-text-object foo (count)
+  "Select three characters."
+  (list (point) (+ (point) 3)))
+@end lisp
+@end defmac
+@noindent Evil provides several functions which return a list of
+positions, for use in the definition of a text object.  These functions
+follow the rule that a positive @var{count} selects text after the
+current position, while a negative @var{count} selects text before it.
+@defun evil-inner-object-range count forward backward
+Return a text range @code{(@var{beg} @var{end})} of @var{count}
+``inner'' text objects (e.g., @kbd{iw}, @kbd{is}).  @var{forward} is a
+function which moves to the end of an object, and @var{backward} is a
+function which moves to the beginning.
+@end defun
+@defun evil-an-object-range count forward backward
+Return a text range @code{(@var{beg} @var{end})} of @var{count} text
+objects with whitespace (e.g., @kbd{aw}, @kbd{as}).  @var{forward} is a
+function which moves to the end of an object, and @var{backward} is a
+function which moves to the beginning.
+@end defun
+@defun evil-paren-range count open close &optional exclusive
+Return a text range @code{(@var{beg} @var{end})} of @var{count}
+delimited blocks (e.g., @kbd{i(}, @kbd{a(}). @var{open} and @var{close}
+are characters.  If @var{exclusive} is non-nil, then the delimiters are
+excluded from the range.  This function uses Emacs' syntax table and is
+only applicable for single-character delimiters; use
+@samp{evil-regexp-range} to match multiple characters.
+@end defun
+@defun evil-regexp-range count open close &optional exclusive
+Return a text range @code{(@var{beg} @var{end})} of @var{count}
+delimited blocks (e.g., @kbd{it}, @kbd{at}). @var{open} and @var{close}
+are regular expressions.  If @var{exclusive} is non-nil, then the
+delimiters are excluded from the range.
+@end defun
+@node Types
+@section Types
+A @dfn{type} is a transformation on a pair of buffer positions.  Evil
+defines the types @samp{exclusive}, @samp{inclusive}, @samp{line} and
+@samp{block}, which are used for motion ranges and Visual selection.
+Types are defined with the macro @samp{evil-define-type}.
+@defmac evil-define-type type doc keyword-args@dots{}
+Define a type @var{type}, described by the documentation string
+@var{doc}.  Then follows keyword arguments:
+@table @code
+@item :expand @var{expand}
+A function which takes two buffer positions and returns a list
+@code{(@var{beg} @var{end})} of expanded positions.
+@item :contract @var{contract}
+A function which takes two expanded buffer positions and returns a list
+@code{(@var{beg} @var{end})} of unexpanded positions.  Optional.
+@item :normalize @var{normalize}
+A function which takes two unexpanded buffer positions and returns a
+list @code{(@var{beg} @var{end})} of adjusted positions.  Optional.
+@item :injective @var{injective}
+If @code{t} (the default), then expansion is one-to-one -- i.e.,
+@var{expand} followed by @var{contract} always returns the original
+positions.  If @code{nil}, then several positions may expand to the same
+(for example, the @samp{line} type is one-to-many as it expands to the
+containing lines).
+@end table
+Further keywords and functions may be specified.  These are understood
+to be transformations on buffer positions, like @var{expand} and
+@end defmac
+@node States
+@section States
+States are defined with the macro @samp{evil-define-state}.  The macro
+defines the necessary hooks, keymaps and variables for a state, as well
+as a toggle function @samp{evil-@var{state}-state} for entering the
+state, and a predicate function @samp{evil-@var{state}-state-p} which
+returns @code{t} when the state is active, and @code{nil} otherwise.
+@defmac evil-define-state state doc keyword-args@dots{} body@dots{}
+Define an Evil state @var{state}, described by the documentation string
+@var{doc}.  Then follows optional keyword arguments:
+@table @code
+@item :tag @var{tag}
+Mode line indicitor, e.g., @code{"<T>"}.
+@item :message @var{message}
+String shown in the echo area.
+@item :cursor @var{cursor}
+Cursor specification.
+@item :enable @var{enable}
+List of other modes and states to enable.  A state may enable another
+state's keymaps in addition to its own.
+@end table
+This is followed the @var{body}, which is executed whenever the state is
+enabled or disabled.  The state's predicate function may be used to
+distinguish between the two.
+@end defmac
+@node Other internals
+@chapter Other internals
+* Command properties::
+@end menu
+@node Command properties
+@section Command properties
+Evil defines @dfn{command properties} to store information about
+commands, such as whether they should be repeated.  A command property
+is a @code{@var{:keyword}} with an associated value, e.g., @code{:repeat
+@defun evil-add-command-properties command &rest properties
+Add @var{properties} to @var{command}.  The properties should be
+specified as a list of keywords and values:
+(evil-add-command-properties 'my-command :repeat t)
+@end lisp
+@end defun
+@defun evil-set-command-properties command &rest properties
+Like @samp{evil-add-command-properties}, but resets all
+previous properties.
+@end defun
+@defun evil-get-command-property command property
+Return the value of a command property.
+@end defun
+@defmac evil-define-command command (args@dots{}) doc keyword-args@dots{} body@dots{}
+Define a command with command properties @var{keyword-args}.
+@end defmac
+@noindent For setting repeat properties, Evil provides the
+following functions:
+@defun evil-declare-repeat command
+Declare @var{command} to be repeatable.
+@end defun
+@defun evil-declare-not-repeat command
+Declare @var{command} to be nonrepeatable.
+@end defun
+@defun evil-declare-change-repeat command
+Declare @var{command} to be repeatable by buffer changes rather than
+@end defun
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+@include fdl-1.3.texi
+@c Local Variables:
+@c mode: texinfo
+@c TeX-master: t
+@c sentence-end-double-space: t
+@c End:

File elisp/contrib/evil/doc/fdl-1.3.texi

+@c The GNU Free Documentation License.
+@center Version 1.3, 3 November 2008
+@c This file is intended to be included within another document,
+@c hence no sectioning command or @node.
+Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+@end display
+@enumerate 0
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document @dfn{free} in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+This License is a kind of ``copyleft'', which means that derivative
+works of the document must themselves be free in the same sense.  It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does.  But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book.  We recommend this License
+principally for works whose purpose is instruction or reference.