;;; viper-util.el --- Utilities used by viper.el
-;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
+
+;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+
+;; Code
+;; Compiler pacifier
+(defvar viper-overriding-map)
+(defvar pm-color-alist)
+(defvar zmacs-region-stays)
+(defvar viper-minibuffer-current-face)
+(defvar viper-minibuffer-insert-face)
+(defvar viper-minibuffer-vi-face)
+(defvar viper-minibuffer-emacs-face)
+(defvar viper-replace-overlay-face)
+(defvar viper-fast-keyseq-timeout)
+(defvar ex-unix-type-shell)
+(defvar ex-unix-type-shell-options)
+(defvar viper-ex-tmp-buf-name)
+(defvar viper-syntax-preference)
+
+(require 'cl)
(require 'ring)
-;; Whether it is XEmacs or not
-(defconst vip-xemacs-p (string-match "\\(Lucid\\|XEmacs\\)" emacs-version))
-;; Whether it is Emacs or not
-(defconst vip-emacs-p (not vip-xemacs-p))
-;; Tell whether we are running as a window application or on a TTY
-(defsubst vip-device-type ()
- (if vip-emacs-p
- window-system
- (device-type (selected-device))))
-;; in XEmacs: device-type is tty on tty and stream in batch.
-(defsubst vip-window-display-p ()
- (and (vip-device-type) (not (memq (vip-device-type) '(tty stream)))))
+(if noninteractive
+ (eval-when-compile
+ (let ((load-path (cons (expand-file-name ".") load-path)))
+ (or (featurep 'viper-init)
+ (load "viper-init.el" nil nil 'nosuffix))
+ )))
+;; end pacifier
-\f
-;;; Macros
-
-(defmacro vip-deflocalvar (var default-value &optional documentation)
- (` (progn
- (defvar (, var) (, default-value)
- (, (format "%s\n\(buffer local\)" documentation)))
- (make-variable-buffer-local '(, var))
- )))
-
-(defmacro vip-loop (count body)
- "(vip-loop COUNT BODY) Execute BODY COUNT times."
- (list 'let (list (list 'count count))
- (list 'while '(> count 0)
- body
- '(setq count (1- count))
- )))
+(require 'viper-init)
+
+
+;; A fix for NeXT Step
+;; Should go away, when NS people fix the design flaw, which leaves the
+;; two x-* functions undefined.
+(if (and (not (fboundp 'x-display-color-p)) (fboundp 'ns-display-color-p))
+ (fset 'x-display-color-p (symbol-function 'ns-display-color-p)))
+(if (and (not (fboundp 'x-color-defined-p)) (fboundp 'ns-color-defined-p))
+ (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p)))
-(defmacro vip-buffer-live-p (buf)
- (` (and (, buf) (get-buffer (, buf)) (buffer-name (get-buffer (, buf))))))
-
-;; return buffer-specific macro definition, given a full macro definition
-(defmacro vip-kbd-buf-alist (macro-elt)
- (` (nth 1 (, macro-elt))))
-;; get a pair: (curr-buffer . macro-definition)
-(defmacro vip-kbd-buf-pair (macro-elt)
- (` (assoc (buffer-name) (vip-kbd-buf-alist (, macro-elt)))))
-;; get macro definition for current buffer
-(defmacro vip-kbd-buf-definition (macro-elt)
- (` (cdr (vip-kbd-buf-pair (, macro-elt)))))
-
-;; return mode-specific macro definitions, given a full macro definition
-(defmacro vip-kbd-mode-alist (macro-elt)
- (` (nth 2 (, macro-elt))))
-;; get a pair: (major-mode . macro-definition)
-(defmacro vip-kbd-mode-pair (macro-elt)
- (` (assoc major-mode (vip-kbd-mode-alist (, macro-elt)))))
-;; get macro definition for the current major mode
-(defmacro vip-kbd-mode-definition (macro-elt)
- (` (cdr (vip-kbd-mode-pair (, macro-elt)))))
-
-;; return global macro definition, given a full macro definition
-(defmacro vip-kbd-global-pair (macro-elt)
- (` (nth 3 (, macro-elt))))
-;; get global macro definition from an elt of macro-alist
-(defmacro vip-kbd-global-definition (macro-elt)
- (` (cdr (vip-kbd-global-pair (, macro-elt)))))
-
-;; last elt of a sequence
-(defsubst vip-seq-last-elt (seq)
- (elt seq (1- (length seq))))
-
-;; Check if arg is a valid character for register
-;; TYPE is a list that can contain `letter', `Letter', and `digit'.
-;; Letter means lowercase letters, Letter means uppercase letters, and
-;; digit means digits from 1 to 9.
-;; If TYPE is nil, then down/uppercase letters and digits are allowed.
-(defun vip-valid-register (reg &optional type)
- (or type (setq type '(letter Letter digit)))
- (or (if (memq 'letter type)
- (and (<= ?a reg) (<= reg ?z)))
- (if (memq 'digit type)
- (and (<= ?1 reg) (<= reg ?9)))
- (if (memq 'Letter type)
- (and (<= ?A reg) (<= reg ?Z)))
- ))
-
-;; checks if object is a marker, has a buffer, and points to within that buffer
-(defun vip-valid-marker (marker)
- (if (and (markerp marker) (marker-buffer marker))
- (let ((buf (marker-buffer marker))
- (pos (marker-position marker)))
- (save-excursion
- (set-buffer buf)
- (and (<= pos (point-max)) (<= (point-min) pos))))))
-
-\f
-(defvar vip-minibuffer-overlay-priority 300)
-(defvar vip-replace-overlay-priority 400)
-(defvar vip-search-overlay-priority 500)
-
\f
;;; XEmacs support
-(if vip-xemacs-p
+
+(if viper-xemacs-p
(progn
- (fset 'vip-read-event (symbol-function 'next-command-event))
- (fset 'vip-make-overlay (symbol-function 'make-extent))
- (fset 'vip-overlay-start (symbol-function 'extent-start-position))
- (fset 'vip-overlay-end (symbol-function 'extent-end-position))
- (fset 'vip-overlay-put (symbol-function 'set-extent-property))
- (fset 'vip-overlay-p (symbol-function 'extentp))
- (fset 'vip-overlay-get (symbol-function 'extent-property))
- (fset 'vip-move-overlay (symbol-function 'set-extent-endpoints))
- (if (vip-window-display-p)
- (fset 'vip-iconify (symbol-function 'iconify-frame)))
- (cond ((vip-window-display-p)
- (fset 'vip-get-face (symbol-function 'get-face))
- (fset 'vip-color-defined-p
+ (fset 'viper-read-event (symbol-function 'next-command-event))
+ (fset 'viper-make-overlay (symbol-function 'make-extent))
+ (fset 'viper-overlay-start (symbol-function 'extent-start-position))
+ (fset 'viper-overlay-end (symbol-function 'extent-end-position))
+ (fset 'viper-overlay-put (symbol-function 'set-extent-property))
+ (fset 'viper-overlay-p (symbol-function 'extentp))
+ (fset 'viper-overlay-get (symbol-function 'extent-property))
+ (fset 'viper-move-overlay (symbol-function 'set-extent-endpoints))
+ (if (viper-window-display-p)
+ (fset 'viper-iconify (symbol-function 'iconify-frame)))
+ (cond ((viper-has-face-support-p)
+ (fset 'viper-get-face (symbol-function 'get-face))
+ (fset 'viper-color-defined-p
(symbol-function 'valid-color-name-p))
)))
- (fset 'vip-read-event (symbol-function 'read-event))
- (fset 'vip-make-overlay (symbol-function 'make-overlay))
- (fset 'vip-overlay-start (symbol-function 'overlay-start))
- (fset 'vip-overlay-end (symbol-function 'overlay-end))
- (fset 'vip-overlay-put (symbol-function 'overlay-put))
- (fset 'vip-overlay-p (symbol-function 'overlayp))
- (fset 'vip-overlay-get (symbol-function 'overlay-get))
- (fset 'vip-move-overlay (symbol-function 'move-overlay))
- (if (vip-window-display-p)
- (fset 'vip-iconify (symbol-function 'iconify-or-deiconify-frame)))
- (cond ((vip-window-display-p)
- (fset 'vip-get-face (symbol-function 'internal-get-face))
- (fset 'vip-color-defined-p (symbol-function 'x-color-defined-p))
+ (fset 'viper-read-event (symbol-function 'read-event))
+ (fset 'viper-make-overlay (symbol-function 'make-overlay))
+ (fset 'viper-overlay-start (symbol-function 'overlay-start))
+ (fset 'viper-overlay-end (symbol-function 'overlay-end))
+ (fset 'viper-overlay-put (symbol-function 'overlay-put))
+ (fset 'viper-overlay-p (symbol-function 'overlayp))
+ (fset 'viper-overlay-get (symbol-function 'overlay-get))
+ (fset 'viper-move-overlay (symbol-function 'move-overlay))
+ (if (viper-window-display-p)
+ (fset 'viper-iconify (symbol-function 'iconify-or-deiconify-frame)))
+ (cond ((viper-has-face-support-p)
+ (fset 'viper-get-face (symbol-function 'internal-get-face))
+ (fset 'viper-color-defined-p (symbol-function 'x-color-defined-p))
)))
-(defsubst vip-color-display-p ()
- (if vip-emacs-p
+
+(fset 'viper-characterp
+ (symbol-function
+ (if viper-xemacs-p 'characterp 'integerp)))
+
+(defsubst viper-color-display-p ()
+ (if viper-emacs-p
(x-display-color-p)
(eq (device-class (selected-device)) 'color)))
+
+(defsubst viper-get-cursor-color ()
+ (if viper-emacs-p
+ (cdr (assoc 'cursor-color (frame-parameters)))
+ (color-instance-name (frame-property (selected-frame) 'cursor-color))))
+
;; OS/2
-(cond ((eq (vip-device-type) 'pm)
- (fset 'vip-color-defined-p
+(cond ((eq (viper-device-type) 'pm)
+ (fset 'viper-color-defined-p
(function (lambda (color) (assoc color pm-color-alist))))))
-;; needed to smooth out the difference between Emacs and XEmacs
-(defsubst vip-italicize-face (face)
- (if vip-xemacs-p
- (make-face-italic face)
- (make-face-italic face nil 'noerror)))
-
-;; test if display is color and the colors are defined
-(defsubst vip-can-use-colors (&rest colors)
- (if (vip-color-display-p)
- (not (memq nil (mapcar 'vip-color-defined-p colors)))
- ))
-;; currently doesn't work for XEmacs
-(defun vip-change-cursor-color (new-color)
- (if (and (vip-window-display-p) (vip-color-display-p)
- (stringp new-color) (vip-color-defined-p new-color)
- (not (string= new-color (vip-get-cursor-color))))
+;; cursor colors
+(defun viper-change-cursor-color (new-color)
+ (if (and (viper-window-display-p) (viper-color-display-p)
+ (stringp new-color) (viper-color-defined-p new-color)
+ (not (string= new-color (viper-get-cursor-color))))
(modify-frame-parameters
(selected-frame) (list (cons 'cursor-color new-color)))))
-(defsubst vip-save-cursor-color ()
- (if (and (vip-window-display-p) (vip-color-display-p))
- (let ((color (vip-get-cursor-color)))
- (if (and (stringp color) (vip-color-defined-p color)
- (not (string= color vip-replace-overlay-cursor-color)))
- (vip-overlay-put vip-replace-overlay 'vip-cursor-color color)))))
+(defun viper-save-cursor-color ()
+ (if (and (viper-window-display-p) (viper-color-display-p))
+ (let ((color (viper-get-cursor-color)))
+ (if (and (stringp color) (viper-color-defined-p color)
+ (not (string= color viper-replace-overlay-cursor-color)))
+ (viper-overlay-put viper-replace-overlay 'viper-cursor-color color)))))
-(defsubst vip-restore-cursor-color ()
- (vip-change-cursor-color
- (vip-overlay-get vip-replace-overlay 'vip-cursor-color)))
-
-(defsubst vip-get-cursor-color ()
- (cdr (assoc 'cursor-color (frame-parameters))))
+;; restore cursor color from replace overlay
+(defsubst viper-restore-cursor-color-after-replace ()
+ (viper-change-cursor-color
+ (viper-overlay-get viper-replace-overlay 'viper-cursor-color)))
+(defsubst viper-restore-cursor-color-after-insert ()
+ (viper-change-cursor-color viper-saved-cursor-color))
+
\f
;; Check the current version against the major and minor version numbers
;; using op: cur-vers op major.minor If emacs-major-version or
;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
;; incorrect. However, this gives correct result in our cases, since we are
;; testing for sufficiently high Emacs versions.
-(defun vip-check-version (op major minor &optional type-of-emacs)
+(defun viper-check-version (op major minor &optional type-of-emacs)
(if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
- (and (cond ((eq type-of-emacs 'xemacs) vip-xemacs-p)
- ((eq type-of-emacs 'emacs) vip-emacs-p)
+ (and (cond ((eq type-of-emacs 'xemacs) viper-xemacs-p)
+ ((eq type-of-emacs 'emacs) viper-emacs-p)
(t t))
(cond ((eq op '=) (and (= emacs-minor-version minor)
(= emacs-major-version major)))
(funcall op emacs-minor-version minor)
t)))
(t
- (error "%S: Invalid op in vip-check-version" op))))
+ (error "%S: Invalid op in viper-check-version" op))))
(cond ((memq op '(= > >=)) nil)
((memq op '(< <=)) t))))
-
+
-(defun vip-get-visible-buffer-window (wind)
- (if vip-xemacs-p
+(defun viper-get-visible-buffer-window (wind)
+ (if viper-xemacs-p
(get-buffer-window wind t)
(get-buffer-window wind 'visible)))
;; If pos is 'end, returns line end. If pos is 'mid, returns line center.
;; Pos = 'indent returns beginning of indentation.
;; Otherwise, returns point. Current point is not moved in any case."
-(defun vip-line-pos (pos)
+(defun viper-line-pos (pos)
(let ((cur-pos (point))
(result))
(cond
((equal pos 'end)
(end-of-line))
((equal pos 'mid)
- (goto-char (+ (vip-line-pos 'start) (vip-line-pos 'end) 2)))
+ (goto-char (+ (viper-line-pos 'start) (viper-line-pos 'end) 2)))
((equal pos 'indent)
(back-to-indentation))
(t nil))
(goto-char cur-pos)
result))
+;; Emacs counts each multibyte character as several positions in the buffer, so
+;; we use Emacs' chars-in-region. XEmacs is counting each char as just one pos,
+;; so we can simply subtract.
+(defun viper-chars-in-region (beg end &optional preserve-sign)
+ (let ((count (abs (if (fboundp 'chars-in-region)
+ (chars-in-region beg end)
+ (- end beg)))))
+ (if (and (< end beg) preserve-sign)
+ (- count)
+ count)))
+
+;; Test if POS is between BEG and END
+(defsubst viper-pos-within-region (pos beg end)
+ (and (>= pos (min beg end)) (>= (max beg end) pos)))
+
;; Like move-marker but creates a virgin marker if arg isn't already a marker.
;; The first argument must eval to a variable name.
;;
;; This is useful for moving markers that are supposed to be local.
;; For this, VAR-NAME should be made buffer-local with nil as a default.
-;; Then, each time this var is used in `vip-move-marker-locally' in a new
+;; Then, each time this var is used in `viper-move-marker-locally' in a new
;; buffer, a new marker will be created.
-(defun vip-move-marker-locally (var pos &optional buffer)
+(defun viper-move-marker-locally (var pos &optional buffer)
(if (markerp (eval var))
()
(set var (make-marker)))
;; Print CONDITIONS as a message.
-(defun vip-message-conditions (conditions)
+(defun viper-message-conditions (conditions)
(let ((case (car conditions)) (msg (cdr conditions)))
(if (null msg)
(message "%s" case)
;;; List/alist utilities
;; Convert LIST to an alist
-(defun vip-list-to-alist (lst)
+(defun viper-list-to-alist (lst)
(let ((alist))
(while lst
(setq alist (cons (list (car lst)) alist))
alist))
;; Convert ALIST to a list.
-(defun vip-alist-to-list (alst)
+(defun viper-alist-to-list (alst)
(let ((lst))
(while alst
(setq lst (cons (car (car alst)) lst))
lst))
;; Filter ALIST using REGEXP. Return alist whose elements match the regexp.
-(defun vip-filter-alist (regexp alst)
+(defun viper-filter-alist (regexp alst)
(interactive "s x")
(let ((outalst) (inalst alst))
(while (car inalst)
outalst))
;; Filter LIST using REGEXP. Return list whose elements match the regexp.
-(defun vip-filter-list (regexp lst)
+(defun viper-filter-list (regexp lst)
(interactive "s x")
(let ((outlst) (inlst lst))
(while (car inlst)
;; Append LIS2 to LIS1, both alists, by side-effect and returns LIS1
;; LIS2 is modified by filtering it: deleting its members of the form
;; \(car elt\) such that (car elt') is in LIS1.
-(defun vip-append-filter-alist (lis1 lis2)
+(defun viper-append-filter-alist (lis1 lis2)
(let ((temp lis1)
elt)
(setq temp (cdr temp)))
(nconc lis1 lis2)))
-
+
+\f
+;;; Support for :e and file globbing
+
+(defun viper-ex-nontrivial-find-file-unix (filespec)
+ "Glob the file spec and visit all files matching the spec.
+This function is designed to work under Unix. It may also work under VMS.
+
+Users who prefer other types of shells should write their own version of this
+function and set the variable `ex-nontrivial-find-file-function'
+appropriately."
+ (let ((gshell
+ (cond (ex-unix-type-shell shell-file-name)
+ ((memq system-type '(vax-vms axp-vms)) "*dcl*") ; VAX VMS
+ (t "sh"))) ; probably Unix anyway
+ (gshell-options
+ ;; using cond in anticipation of further additions
+ (cond (ex-unix-type-shell-options)
+ ))
+ (command (cond (viper-ms-style-os-p (format "\"ls -1 -d %s\"" filespec))
+ (t (format "ls -1 -d %s" filespec))))
+ file-list status)
+ (save-excursion
+ (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
+ (erase-buffer)
+ (setq status
+ (if gshell-options
+ (call-process gshell nil t nil
+ gshell-options
+ "-c"
+ command)
+ (call-process gshell nil t nil
+ "-c"
+ command)))
+ (goto-char (point-min))
+ ;; Issue an error, if no match.
+ (if (> status 0)
+ (save-excursion
+ (skip-chars-forward " \t\n\j")
+ (if (looking-at "ls:")
+ (viper-forward-Word 1))
+ (error "%s: %s"
+ (if (stringp gshell)
+ gshell
+ "shell")
+ (buffer-substring (point) (viper-line-pos 'end)))
+ ))
+ (goto-char (point-min))
+ (setq file-list (viper-get-filenames-from-buffer 'one-per-line)))
+
+ (mapcar 'find-file file-list)
+ ))
+
+(defun viper-ex-nontrivial-find-file-ms (filespec)
+ "Glob the file spec and visit all files matching the spec.
+This function is designed to work under MS type systems, such as NT, W95, and
+DOS. It may also work under OS/2.
+
+The users of Unix-type shells should be able to use
+`viper-ex-nontrivial-find-file-unix', making it into the value of the variable
+`ex-nontrivial-find-file-function'. If this doesn't work, the user may have
+to write a custom function, similar to `viper-ex-nontrivial-find-file-unix'."
+ (save-excursion
+ (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
+ (erase-buffer)
+ (insert filespec)
+ (goto-char (point-min))
+ (mapcar 'find-file
+ (viper-glob-ms-windows-files (viper-get-filenames-from-buffer)))
+ ))
+;; Interpret the stuff in the buffer as a list of file names
+;; return a list of file names listed in the buffer beginning at point
+;; If optional arg is supplied, assume each filename is listed on a separate
+;; line
+(defun viper-get-filenames-from-buffer (&optional one-per-line)
+ (let ((skip-chars (if one-per-line "\t\n" " \t\n"))
+ result fname delim)
+ (skip-chars-forward skip-chars)
+ (while (not (eobp))
+ (if (cond ((looking-at "\"")
+ (setq delim ?\")
+ (re-search-forward "[^\"]+" nil t)) ; noerror
+ ((looking-at "'")
+ (setq delim ?')
+ (re-search-forward "[^']+" nil t)) ; noerror
+ (t
+ (re-search-forward
+ (concat "[^" skip-chars "]+") nil t))) ;noerror
+ (setq fname
+ (buffer-substring (match-beginning 0) (match-end 0))))
+ (if delim
+ (forward-char 1))
+ (skip-chars-forward " \t\n")
+ (setq result (cons fname result)))
+ result))
+
+;; convert MS-DOS wildcards to regexp
+(defun viper-wildcard-to-regexp (wcard)
+ (save-excursion
+ (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
+ (erase-buffer)
+ (insert wcard)
+ (goto-char (point-min))
+ (while (not (eobp))
+ (skip-chars-forward "^*?.\\\\")
+ (cond ((eq (char-after (point)) ?*) (insert ".")(forward-char 1))
+ ((eq (char-after (point)) ?.) (insert "\\")(forward-char 1))
+ ((eq (char-after (point)) ?\\) (insert "\\")(forward-char 1))
+ ((eq (char-after (point)) ??) (delete-char 1)(insert ".")))
+ )
+ (buffer-string)
+ ))
+
+
+;; glob windows files
+;; LIST is expected to be in reverse order
+(defun viper-glob-ms-windows-files (list)
+ (let ((tmp list)
+ (case-fold-search t)
+ tmp2)
+ (while tmp
+ (setq tmp2 (cons (directory-files
+ ;; the directory part
+ (or (file-name-directory (car tmp))
+ "")
+ t ; return full names
+ ;; the regexp part: globs the file names
+ (concat "^"
+ (viper-wildcard-to-regexp
+ (file-name-nondirectory (car tmp)))
+ "$"))
+ tmp2))
+ (setq tmp (cdr tmp)))
+ (reverse (apply 'append tmp2))))
+
\f
;;; Insertion ring
;; Rotate RING's index. DIRection can be positive or negative.
-(defun vip-ring-rotate1 (ring dir)
+(defun viper-ring-rotate1 (ring dir)
(if (and (ring-p ring) (> (ring-length ring) 0))
(progn
(setcar ring (cond ((> dir 0)
(ring-minus1 (car ring) (ring-length ring)))
;; don't rotate if dir = 0
(t (car ring))))
- (vip-current-ring-item ring)
+ (viper-current-ring-item ring)
)))
-(defun vip-special-ring-rotate1 (ring dir)
- (if (memq vip-intermediate-command
+(defun viper-special-ring-rotate1 (ring dir)
+ (if (memq viper-intermediate-command
'(repeating-display-destructive-command
repeating-insertion-from-ring))
- (vip-ring-rotate1 ring dir)
+ (viper-ring-rotate1 ring dir)
;; don't rotate otherwise
- (vip-ring-rotate1 ring 0)))
+ (viper-ring-rotate1 ring 0)))
;; current ring item; if N is given, then so many items back from the
;; current
-(defun vip-current-ring-item (ring &optional n)
+(defun viper-current-ring-item (ring &optional n)
(setq n (or n 0))
(if (and (ring-p ring) (> (ring-length ring) 0))
(aref (cdr (cdr ring)) (mod (- (car ring) 1 n) (ring-length ring)))))
;; push item onto ring. the second argument is a ring-variable, not value.
-(defun vip-push-onto-ring (item ring-var)
+(defun viper-push-onto-ring (item ring-var)
(or (ring-p (eval ring-var))
(set ring-var (make-ring (eval (intern (format "%S-size" ring-var))))))
(or (null item) ; don't push nil
(and (stringp item) (string= item "")) ; or empty strings
- (equal item (vip-current-ring-item (eval ring-var))) ; or old stuff
- ;; Since vip-set-destructive-command checks if we are inside vip-repeat,
- ;; we don't check whether this-command-keys is a `.'.
- ;; The cmd vip-repeat makes a call to the current function only if
- ;; `.' is executing a command from the command history. It doesn't
- ;; call the push-onto-ring function if `.' is simply repeating the
- ;; last destructive command.
- ;; We only check for ESC (which happens when we do insert with a
- ;; prefix argument, or if this-command-keys doesn't give anything
- ;; meaningful (in that case we don't know what to show to the user).
- (and (eq ring-var 'vip-command-ring)
+ (equal item (viper-current-ring-item (eval ring-var))) ; or old stuff
+ ;; Since viper-set-destructive-command checks if we are inside
+ ;; viper-repeat, we don't check whether this-command-keys is a `.'. The
+ ;; cmd viper-repeat makes a call to the current function only if `.' is
+ ;; executing a command from the command history. It doesn't call the
+ ;; push-onto-ring function if `.' is simply repeating the last
+ ;; destructive command. We only check for ESC (which happens when we do
+ ;; insert with a prefix argument, or if this-command-keys doesn't give
+ ;; anything meaningful (in that case we don't know what to show to the
+ ;; user).
+ (and (eq ring-var 'viper-command-ring)
(string-match "\\([0-9]*\e\\|^[ \t]*$\\|escape\\)"
- (vip-array-to-string (this-command-keys))))
- (vip-ring-insert (eval ring-var) item))
+ (viper-array-to-string (this-command-keys))))
+ (viper-ring-insert (eval ring-var) item))
)
;; removing elts from ring seems to break it
-(defun vip-cleanup-ring (ring)
+(defun viper-cleanup-ring (ring)
(or (< (ring-length ring) 2)
- (null (vip-current-ring-item ring))
+ (null (viper-current-ring-item ring))
;; last and previous equal
- (if (equal (vip-current-ring-item ring) (vip-current-ring-item ring 1))
- (vip-ring-pop ring))))
+ (if (equal (viper-current-ring-item ring)
+ (viper-current-ring-item ring 1))
+ (viper-ring-pop ring))))
;; ring-remove seems to be buggy, so we concocted this for our purposes.
-(defun vip-ring-pop (ring)
+(defun viper-ring-pop (ring)
(let* ((ln (ring-length ring))
(vec (cdr (cdr ring)))
(veclen (length vec))
top-elt
))
-(defun vip-ring-insert (ring item)
+(defun viper-ring-insert (ring item)
(let* ((ln (ring-length ring))
(vec (cdr (cdr ring)))
(veclen (length vec))
;; POST-STRING is a string to append to the abbrev string.
;; ABBREV_SIGN is a string to be inserted before POST-STRING
;; if the orig string was truncated.
-(defun vip-abbreviate-string (string max-len
+(defun viper-abbreviate-string (string max-len
pre-string post-string abbrev-sign)
(let (truncated-str)
(setq truncated-str
(t (format "%s%s%s" pre-string truncated-str post-string)))))
;; tells if we are over a whitespace-only line
-(defsubst vip-over-whitespace-line ()
+(defsubst viper-over-whitespace-line ()
(save-excursion
(beginning-of-line)
(looking-at "^[ \t]*$")))
;; If given, MESSAGE is a message to be displayed after that.
;; This message is erased after 2 secs, if erase-msg is non-nil.
;; Arguments: var message custom-file &optional erase-message
-(defun vip-save-setting (var message custom-file &optional erase-msg)
+(defun viper-save-setting (var message custom-file &optional erase-msg)
(let* ((var-name (symbol-name var))
(var-val (if (boundp var) (eval var)))
(regexp (format "^[^;]*%s[ \t\n]*[a-zA-Z---_']*[ \t\n)]" var-name))
;; Save STRING in CUSTOM-FILE. If PATTERN is non-nil, remove strings that
;; match this pattern.
-(defun vip-save-string-in-file (string custom-file &optional pattern)
+(defun viper-save-string-in-file (string custom-file &optional pattern)
(let ((buf (find-file-noselect (substitute-in-file-name custom-file))))
(save-excursion
(set-buffer buf)
- (goto-char (point-min))
- (if pattern (delete-matching-lines pattern))
- (goto-char (point-max))
- (if string (insert string))
- (save-buffer))
+ (let (buffer-read-only)
+ (goto-char (point-min))
+ (if pattern (delete-matching-lines pattern))
+ (goto-char (point-max))
+ (if string (insert string))
+ (save-buffer)))
(kill-buffer buf)
))
+
+
+;; define remote file test
+(or (fboundp 'viper-file-remote-p) ; user supplied his own function: use it
+ (defun viper-file-remote-p (file-name)
+ (car (cond ((featurep 'efs-auto) (efs-ftp-path file-name))
+ ((fboundp 'file-remote-p) (file-remote-p file-name))
+ (t (require 'ange-ftp)
+ ;; Can happen only in Emacs, since XEmacs has file-remote-p
+ (ange-ftp-ftp-name file-name))))))
+
+
+
+;; This is a simple-minded check for whether a file is under version control.
+;; If file,v exists but file doesn't, this file is considered to be not checked
+;; in and not checked out for the purpose of patching (since patch won't be
+;; able to read such a file anyway).
+;; FILE is a string representing file name
+;;(defun viper-file-under-version-control (file)
+;; (let* ((filedir (file-name-directory file))
+;; (file-nondir (file-name-nondirectory file))
+;; (trial (concat file-nondir ",v"))
+;; (full-trial (concat filedir trial))
+;; (full-rcs-trial (concat filedir "RCS/" trial)))
+;; (and (stringp file)
+;; (file-exists-p file)
+;; (or
+;; (and
+;; (file-exists-p full-trial)
+;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
+;; ;; don't be fooled by this!
+;; (not (equal (file-attributes file)
+;; (file-attributes full-trial))))
+;; ;; check if a version is in RCS/ directory
+;; (file-exists-p full-rcs-trial)))
+;; ))
+
+
+(defsubst viper-file-checked-in-p (file)
+ (and (vc-backend file)
+ (not (vc-locking-user file))))
+;; checkout if visited file is checked in
+(defun viper-maybe-checkout (buf)
+ (let ((file (expand-file-name (buffer-file-name buf)))
+ (checkout-function (key-binding "\C-x\C-q")))
+ (if (and (viper-file-checked-in-p file)
+ (or (beep 1) t)
+ (y-or-n-p
+ (format
+ "File %s is checked in. Check it out? "
+ (viper-abbreviate-file-name file))))
+ (with-current-buffer buf
+ (command-execute checkout-function)))))
+
+
\f
;;; Overlays
;; Search
-(defun vip-flash-search-pattern ()
- (if (vip-overlay-p vip-search-overlay)
- (vip-move-overlay vip-search-overlay (match-beginning 0) (match-end 0))
- (setq vip-search-overlay
- (vip-make-overlay
+(defun viper-flash-search-pattern ()
+ (if (viper-overlay-p viper-search-overlay)
+ (viper-move-overlay
+ viper-search-overlay (match-beginning 0) (match-end 0))
+ (setq viper-search-overlay
+ (viper-make-overlay
(match-beginning 0) (match-end 0) (current-buffer))))
- (vip-overlay-put vip-search-overlay 'priority vip-search-overlay-priority)
- (if (vip-window-display-p)
+ (viper-overlay-put
+ viper-search-overlay 'priority viper-search-overlay-priority)
+ (if (viper-has-face-support-p)
(progn
- (vip-overlay-put vip-search-overlay 'face vip-search-face)
+ (viper-overlay-put viper-search-overlay 'face viper-search-face)
(sit-for 2)
- (vip-overlay-put vip-search-overlay 'face nil))))
+ (viper-overlay-put viper-search-overlay 'face nil))))
+
;; Replace state
-(defun vip-set-replace-overlay (beg end)
- (if (vip-overlay-p vip-replace-overlay)
- (vip-move-replace-overlay beg end)
- (setq vip-replace-overlay (vip-make-overlay beg end (current-buffer)))
- (vip-overlay-put vip-replace-overlay
- 'vip-start
- (move-marker (make-marker)
- (vip-overlay-start vip-replace-overlay)))
- (vip-overlay-put vip-replace-overlay
- 'vip-end
- (move-marker (make-marker)
- (vip-overlay-end vip-replace-overlay)))
- (vip-overlay-put
- vip-replace-overlay 'priority vip-replace-overlay-priority))
- (if (vip-window-display-p)
- (vip-overlay-put vip-replace-overlay 'face vip-replace-overlay-face))
- (vip-save-cursor-color)
- (vip-change-cursor-color vip-replace-overlay-cursor-color)
- )
+(defsubst viper-move-replace-overlay (beg end)
+ (viper-move-overlay viper-replace-overlay beg end))
+(defun viper-set-replace-overlay (beg end)
+ (if (viper-overlay-p viper-replace-overlay)
+ (viper-move-replace-overlay beg end)
+ (setq viper-replace-overlay (viper-make-overlay beg end (current-buffer)))
+ ;; never detach
+ (viper-overlay-put
+ viper-replace-overlay (if viper-emacs-p 'evaporate 'detachable) nil)
+ (viper-overlay-put
+ viper-replace-overlay 'priority viper-replace-overlay-priority)
+ ;; If Emacs will start supporting overlay maps, as it currently supports
+ ;; text-property maps, we could do away with viper-replace-minor-mode and
+ ;; just have keymap attached to replace overlay.
+ ;;(viper-overlay-put
+ ;; viper-replace-overlay
+ ;; (if viper-xemacs-p 'keymap 'local-map)
+ ;; viper-replace-map)
+ )
+ (if (viper-has-face-support-p)
+ (viper-overlay-put
+ viper-replace-overlay 'face viper-replace-overlay-face))
+ (viper-save-cursor-color)
+ (viper-change-cursor-color viper-replace-overlay-cursor-color)
+ )
-(defsubst vip-hide-replace-overlay ()
- (vip-set-replace-overlay-glyphs nil nil)
- (vip-restore-cursor-color)
- (if (vip-window-display-p)
- (vip-overlay-put vip-replace-overlay 'face nil)))
-(defsubst vip-set-replace-overlay-glyphs (before-glyph after-glyph)
- (if (or (not (vip-window-display-p))
- vip-use-replace-region-delimiters)
- (let ((before-name (if vip-xemacs-p 'begin-glyph 'before-string))
- (after-name (if vip-xemacs-p 'end-glyph 'after-string)))
- (vip-overlay-put vip-replace-overlay before-name before-glyph)
- (vip-overlay-put vip-replace-overlay after-name after-glyph))))
+(defun viper-set-replace-overlay-glyphs (before-glyph after-glyph)
+ (if (or (not (viper-has-face-support-p))
+ viper-use-replace-region-delimiters)
+ (let ((before-name (if viper-xemacs-p 'begin-glyph 'before-string))
+ (after-name (if viper-xemacs-p 'end-glyph 'after-string)))
+ (viper-overlay-put viper-replace-overlay before-name before-glyph)
+ (viper-overlay-put viper-replace-overlay after-name after-glyph))))
+
+(defun viper-hide-replace-overlay ()
+ (viper-set-replace-overlay-glyphs nil nil)
+ (viper-restore-cursor-color-after-replace)
+ (viper-restore-cursor-color-after-insert)
+ (if (viper-has-face-support-p)
+ (viper-overlay-put viper-replace-overlay 'face nil)))
-(defsubst vip-replace-start ()
- (vip-overlay-get vip-replace-overlay 'vip-start))
-(defsubst vip-replace-end ()
- (vip-overlay-get vip-replace-overlay 'vip-end))
-
-(defsubst vip-move-replace-overlay (beg end)
- (vip-move-overlay vip-replace-overlay beg end)
- (move-marker (vip-replace-start) (vip-overlay-start vip-replace-overlay))
- (move-marker (vip-replace-end) (vip-overlay-end vip-replace-overlay)))
+(defsubst viper-replace-start ()
+ (viper-overlay-start viper-replace-overlay))
+(defsubst viper-replace-end ()
+ (viper-overlay-end viper-replace-overlay))
;; Minibuffer
-(defun vip-set-minibuffer-overlay ()
- (vip-check-minibuffer-overlay)
- ;; We always move the minibuffer overlay, since in XEmacs
- ;; this overlay may get detached. Moving will reattach it.
- ;; This overlay is also moved via the vip-post-command-hook,
- ;; to insure that it covers the whole minibuffer.
- (vip-move-minibuffer-overlay)
- (if (vip-window-display-p)
+(defun viper-set-minibuffer-overlay ()
+ (viper-check-minibuffer-overlay)
+ (if (viper-has-face-support-p)
(progn
- (vip-overlay-put
- vip-minibuffer-overlay 'face vip-minibuffer-current-face)
- (vip-overlay-put
- vip-minibuffer-overlay 'priority vip-minibuffer-overlay-priority))
- ))
+ (viper-overlay-put
+ viper-minibuffer-overlay 'face viper-minibuffer-current-face)
+ (viper-overlay-put
+ viper-minibuffer-overlay 'priority viper-minibuffer-overlay-priority)
+ ;; never detach
+ (viper-overlay-put
+ viper-minibuffer-overlay
+ (if viper-emacs-p 'evaporate 'detachable)
+ nil)
+ ;; make viper-minibuffer-overlay open-ended
+ ;; In emacs, it is made open ended at creation time
+ (if viper-xemacs-p
+ (progn
+ (viper-overlay-put viper-minibuffer-overlay 'start-open nil)
+ (viper-overlay-put viper-minibuffer-overlay 'end-open nil)))
+ )))
-(defun vip-check-minibuffer-overlay ()
- (if (vip-overlay-p vip-minibuffer-overlay)
- ()
- (setq vip-minibuffer-overlay
- (vip-make-overlay 1 (1+ (buffer-size)) (current-buffer)))))
-
-;; arguments to this function are dummies. they are needed just because
-;; it is used as a insert-in-front-hook to vip-minibuffer-overlay, and such
-;; hooks require 3 arguments.
-(defun vip-move-minibuffer-overlay (&optional overl beg end)
- (if (vip-is-in-minibuffer)
- (progn
- (vip-check-minibuffer-overlay)
- (vip-move-overlay vip-minibuffer-overlay 1 (1+ (buffer-size))))))
+(defun viper-check-minibuffer-overlay ()
+ (or (viper-overlay-p viper-minibuffer-overlay)
+ (setq viper-minibuffer-overlay
+ (if viper-xemacs-p
+ (viper-make-overlay 1 (1+ (buffer-size)) (current-buffer))
+ ;; make overlay open-ended
+ (viper-make-overlay
+ 1 (1+ (buffer-size)) (current-buffer) nil 'rear-advance)))
+ ))
+
-(defsubst vip-is-in-minibuffer ()
- (string-match "\*Minibuf-" (buffer-name)))
+(defsubst viper-is-in-minibuffer ()
+ (save-match-data
+ (string-match "\*Minibuf-" (buffer-name))))
\f
;;; XEmacs compatibility
+
+(defun viper-abbreviate-file-name (file)
+ (if viper-emacs-p
+ (abbreviate-file-name file)
+ ;; XEmacs requires addl argument
+ (abbreviate-file-name file t)))
-;; Sit for VAL miliseconds. XEmacs doesn't support the millisecond arg
+;; Sit for VAL milliseconds. XEmacs doesn't support the millisecond arg
;; in sit-for, so this function smoothes out the differences.
-(defsubst vip-sit-for-short (val &optional nodisp)
- (if vip-xemacs-p
+(defsubst viper-sit-for-short (val &optional nodisp)
+ (if viper-xemacs-p
(sit-for (/ val 1000.0) nodisp)
(sit-for 0 val nodisp)))
;; EVENT may be a single event of a sequence of events
-(defsubst vip-ESC-event-p (event)
+(defsubst viper-ESC-event-p (event)
(let ((ESC-keys '(?\e (control \[) escape))
- (key (vip-event-key event)))
+ (key (viper-event-key event)))
(member key ESC-keys)))
-
-;; like (set-mark-command nil) but doesn't push twice, if (car mark-ring)
-;; is the same as (mark t).
-(defsubst vip-set-mark-if-necessary ()
- (setq mark-ring (delete (vip-mark-marker) mark-ring))
- (set-mark-command nil))
+
+;; checks if object is a marker, has a buffer, and points to within that buffer
+(defun viper-valid-marker (marker)
+ (if (and (markerp marker) (marker-buffer marker))
+ (let ((buf (marker-buffer marker))
+ (pos (marker-position marker)))
+ (save-excursion
+ (set-buffer buf)
+ (and (<= pos (point-max)) (<= (point-min) pos))))))
-(defsubst vip-mark-marker ()
- (if vip-xemacs-p
+(defsubst viper-mark-marker ()
+ (if viper-xemacs-p
(mark-marker t)
(mark-marker)))
+
+;; like (set-mark-command nil) but doesn't push twice, if (car mark-ring)
+;; is the same as (mark t).
+(defsubst viper-set-mark-if-necessary ()
+ (setq mark-ring (delete (viper-mark-marker) mark-ring))
+ (set-mark-command nil))
;; In transient mark mode (zmacs mode), it is annoying when regions become
;; highlighted due to Viper's pushing marks. So, we deactivate marks, unless
;; the user explicitly wants highlighting, e.g., by hitting '' or ``
-(defun vip-deactivate-mark ()
- (if vip-xemacs-p
+(defun viper-deactivate-mark ()
+ (if viper-xemacs-p
(zmacs-deactivate-region)
(deactivate-mark)))
+(defsubst viper-leave-region-active ()
+ (if viper-xemacs-p
+ (setq zmacs-region-stays t)))
+
+;; Check if arg is a valid character for register
+;; TYPE is a list that can contain `letter', `Letter', and `digit'.
+;; Letter means lowercase letters, Letter means uppercase letters, and
+;; digit means digits from 1 to 9.
+;; If TYPE is nil, then down/uppercase letters and digits are allowed.
+(defun viper-valid-register (reg &optional type)
+ (or type (setq type '(letter Letter digit)))
+ (or (if (memq 'letter type)
+ (and (<= ?a reg) (<= reg ?z)))
+ (if (memq 'digit type)
+ (and (<= ?1 reg) (<= reg ?9)))
+ (if (memq 'Letter type)
+ (and (<= ?A reg) (<= reg ?Z)))
+ ))
+
-(defsubst vip-events-to-keys (events)
- (cond (vip-xemacs-p (events-to-keys events))
+(defsubst viper-events-to-keys (events)
+ (cond (viper-xemacs-p (events-to-keys events))
(t events)))
-
-(defun vip-eval-after-load (file form)
- (if vip-emacs-p
- (eval-after-load file form)
- (or (assoc file after-load-alist)
- (setq after-load-alist (cons (list file) after-load-alist)))
- (let ((elt (assoc file after-load-alist)))
- (or (member form (cdr elt))
- (setq elt (nconc elt (list form)))))
- form
- ))
+;; it is suggested that an event must be copied before it is assigned to
+;; last-command-event in XEmacs
+(defun viper-copy-event (event)
+ (if viper-xemacs-p
+ (copy-event event)
+ event))
;; like read-event, but in XEmacs also try to convert to char, if possible
-(defun vip-read-event-convert-to-char ()
+(defun viper-read-event-convert-to-char ()
(let (event)
- (if vip-emacs-p
+ (if viper-emacs-p
(read-event)
(setq event (next-command-event))
(or (event-to-character event)
event))
))
+;; This function lets function-key-map convert key sequences into logical
+;; keys. This does a better job than viper-read-event when it comes to kbd
+;; macros, since it enables certain macros to be shared between X and TTY modes
+;; by correctly mapping key sequences for Left/Right/... (one an ascii
+;; terminal) into logical keys left, right, etc.
+(defun viper-read-key ()
+ (let ((overriding-local-map viper-overriding-map)
+ (inhibit-quit t)
+ help-char key)
+ (use-global-map viper-overriding-map)
+ (unwind-protect
+ (setq key (elt (read-key-sequence nil) 0))
+ (use-global-map global-map))
+ key))
+
;; Emacs has a bug in eventp, which causes (eventp nil) to return (nil)
-;; instead of nil, if '(nil) was previously inadvertantly assigned to
+;; instead of nil, if '(nil) was previously inadvertently assigned to
;; unread-command-events
-(defun vip-event-key (event)
+(defun viper-event-key (event)
(or (and event (eventp event))
- (error "vip-event-key: Wrong type argument, eventp, %S" event))
- (let ((mod (event-modifiers event))
- basis)
- (setq basis
- (cond
- (vip-xemacs-p
- (cond ((key-press-event-p event)
- (event-key event))
- ((button-event-p event)
- (concat "mouse-" (prin1-to-string (event-button event))))
- (t
- (error "vip-event-key: Unknown event, %S" event))))
- (t
- ;; Emacs doesn't handle capital letters correctly, since
- ;; \S-a isn't considered the same as A (it behaves as
- ;; plain `a' instead). So we take care of this here
- (cond ((and (numberp event) (<= ?A event) (<= event ?Z))
- (setq mod nil
- event event))
- ;; Emacs has the oddity whereby characters 128+char
- ;; represent M-char *if* this appears inside a string.
- ;; So, we convert them manually into (mata char).
- ((and (numberp event) (< ?\C-? event) (<= event 255))
- (setq mod '(meta)
- event (- event ?\C-? 1)))
- (t (event-basic-type event)))
- )))
-
- (if (numberp basis)
- (setq basis
- (if (= basis ?\C-?)
- (list 'control '\?) ; taking care of an emacs bug
- (intern (char-to-string basis)))))
-
- (if mod
- (append mod (list basis))
- basis)
- ))
+ (error "viper-event-key: Wrong type argument, eventp, %S" event))
+ (when (cond (viper-xemacs-p (or (key-press-event-p event)
+ (mouse-event-p event)))
+ (t t))
+ (let ((mod (event-modifiers event))
+ basis)
+ (setq basis
+ (cond
+ (viper-xemacs-p
+ (cond ((key-press-event-p event)
+ (event-key event))
+ ((button-event-p event)
+ (concat "mouse-" (prin1-to-string (event-button event))))
+ (t
+ (error "viper-event-key: Unknown event, %S" event))))
+ (t
+ ;; Emacs doesn't handle capital letters correctly, since
+ ;; \S-a isn't considered the same as A (it behaves as
+ ;; plain `a' instead). So we take care of this here
+ (cond ((and (viper-characterp event) (<= ?A event) (<= event ?Z))
+ (setq mod nil
+ event event))
+ ;; Emacs has the oddity whereby characters 128+char
+ ;; represent M-char *if* this appears inside a string.
+ ;; So, we convert them manually to (meta char).
+ ((and (viper-characterp event)
+ (< ?\C-? event) (<= event 255))
+ (setq mod '(meta)
+ event (- event ?\C-? 1)))
+ ((and (null mod) (eq event 'return))
+ (setq event ?\C-m))
+ ((and (null mod) (eq event 'space))
+ (setq event ?\ ))
+ ((and (null mod) (eq event 'delete))
+ (setq event ?\C-?))
+ ((and (null mod) (eq event 'backspace))
+ (setq event ?\C-h))
+ (t (event-basic-type event)))
+ )))
+ (if (viper-characterp basis)
+ (setq basis
+ (if (= basis ?\C-?)
+ (list 'control '\?) ; taking care of an emacs bug
+ (intern (char-to-string basis)))))
+ (if mod
+ (append mod (list basis))
+ basis))))
-(defun vip-key-to-emacs-key (key)
+(defun viper-key-to-emacs-key (key)
(let (key-name char-p modifiers mod-char-list base-key base-key-name)
- (cond (vip-xemacs-p key)
+ (cond (viper-xemacs-p key)
+
((symbolp key)
(setq key-name (symbol-name key))
- (if (= (length key-name) 1) ; character event
- (string-to-char key-name)
- key))
+ (cond ((= (length key-name) 1) ; character event
+ (string-to-char key-name))
+ ;; Emacs doesn't recognize `return' and `escape' as events on
+ ;; dumb terminals, so we translate them into characters
+ ((and viper-emacs-p (not (viper-window-display-p))
+ (string= key-name "return"))
+ ?\C-m)
+ ((and viper-emacs-p (not (viper-window-display-p))
+ (string= key-name "escape"))
+ ?\e)
+ ;; pass symbol-event as is
+ (t key)))
+
((listp key)
(setq modifiers (subseq key 0 (1- (length key)))
- base-key (vip-seq-last-elt key)
+ base-key (viper-seq-last-elt key)
base-key-name (symbol-name base-key)
char-p (= (length base-key-name) 1))
(setq mod-char-list
;; characters, will return a string. Otherwise, will return a string
;; representing a vector of converted events. If the input was a Viper macro,
;; will return a string that represents this macro as a vector.
-(defun vip-array-to-string (event-seq &optional representation)
- (let (temp)
+(defun viper-array-to-string (event-seq)
+ (let (temp temp2)
(cond ((stringp event-seq) event-seq)
- ((vip-event-vector-p event-seq)
- (setq temp (mapcar 'vip-event-key event-seq))
- (if (vip-char-symbol-sequence-p temp)
- (mapconcat 'symbol-name temp "")
- (prin1-to-string (vconcat temp))))
- ((vip-char-symbol-sequence-p event-seq)
+ ((viper-event-vector-p event-seq)
+ (setq temp (mapcar 'viper-event-key event-seq))
+ (cond ((viper-char-symbol-sequence-p temp)
+ (mapconcat 'symbol-name temp ""))
+ ((and (viper-char-array-p
+ (setq temp2 (mapcar 'viper-key-to-character temp))))
+ (mapconcat 'char-to-string temp2 ""))
+ (t (prin1-to-string (vconcat temp)))))
+ ((viper-char-symbol-sequence-p event-seq)
(mapconcat 'symbol-name event-seq ""))
+ ((and (vectorp event-seq)
+ (viper-char-array-p
+ (setq temp (mapcar 'viper-key-to-character event-seq))))
+ (mapconcat 'char-to-string temp ""))
(t (prin1-to-string event-seq)))))
+
+(defun viper-key-press-events-to-chars (events)
+ (mapconcat (if viper-emacs-p
+ 'char-to-string
+ (function
+ (lambda (elt) (char-to-string (event-to-character elt)))))
+ events
+ ""))
-(defsubst vip-fast-keysequence-p ()
- (not (vip-sit-for-short vip-fast-keyseq-timeout t)))
+;; Uses different timeouts for ESC-sequences and others
+(defsubst viper-fast-keysequence-p ()
+ (not (viper-sit-for-short
+ (if (viper-ESC-event-p last-input-event)
+ viper-ESC-keyseq-timeout
+ viper-fast-keyseq-timeout)
+ t)))
-(defun vip-read-char-exclusive ()
+(defun viper-read-char-exclusive ()
(let (char
(echo-keystrokes 1))
(while (null char)
(setq char (read-char))
(error
;; skip event if not char
- (vip-read-event))))
+ (viper-read-event))))
char))
+;; key is supposed to be in viper's representation, e.g., (control l), a
+;; character, etc.
+(defun viper-key-to-character (key)
+ (cond ((eq key 'space) ?\ )
+ ((eq key 'delete) ?\C-?)
+ ((eq key 'return) ?\C-m)
+ ((eq key 'backspace) ?\C-h)
+ ((and (symbolp key)
+ (= 1 (length (symbol-name key))))
+ (string-to-char (symbol-name key)))
+ ((and (listp key)
+ (eq (car key) 'control)
+ (symbol-name (nth 1 key))
+ (= 1 (length (symbol-name (nth 1 key)))))
+ (read (format "?\\C-%s" (symbol-name (nth 1 key)))))
+ (t key)))
-(defun vip-setup-master-buffer (&rest other-files-or-buffers)
+(defun viper-setup-master-buffer (&rest other-files-or-buffers)
"Set up the current buffer as a master buffer.
Arguments become related buffers. This function should normally be used in
the `Local variables' section of a file."
- (setq vip-related-files-and-buffers-ring
+ (setq viper-related-files-and-buffers-ring
(make-ring (1+ (length other-files-or-buffers))))
(mapcar '(lambda (elt)
- (vip-ring-insert vip-related-files-and-buffers-ring elt))
+ (viper-ring-insert viper-related-files-and-buffers-ring elt))
other-files-or-buffers)
- (vip-ring-insert vip-related-files-and-buffers-ring (buffer-name))
+ (viper-ring-insert viper-related-files-and-buffers-ring (buffer-name))
)
+
+;;; Movement utilities
+
+;; Characters that should not be considered as part of the word, in reformed-vi
+;; syntax mode.
+(defconst viper-non-word-characters-reformed-vi
+ "!@#$%^&*()-+=|\\~`{}[];:'\",<.>/?")
+;; These are characters that are not to be considered as parts of a word in
+;; Viper.
+;; Set each time state changes and at loading time
+(viper-deflocalvar viper-non-word-characters nil)
+
+;; must be buffer-local
+(viper-deflocalvar viper-ALPHA-char-class "w"
+ "String of syntax classes characterizing Viper's alphanumeric symbols.
+In addition, the symbol `_' may be considered alphanumeric if
+`viper-syntax-preference' is `strict-vi' or `reformed-vi'.")
+
+(defconst viper-strict-ALPHA-chars "a-zA-Z0-9_"
+ "Regexp matching the set of alphanumeric characters acceptable to strict
+Vi.")
+(defconst viper-strict-SEP-chars " \t\n"
+ "Regexp matching the set of alphanumeric characters acceptable to strict
+Vi.")
+(defconst viper-strict-SEP-chars-sans-newline " \t"
+ "Regexp matching the set of alphanumeric characters acceptable to strict
+Vi.")
+
+(defconst viper-SEP-char-class " -"
+ "String of syntax classes for Vi separators.
+Usually contains ` ', linefeed, TAB or formfeed.")
+
+
+;; Set Viper syntax classes and related variables according to
+;; `viper-syntax-preference'.
+(defun viper-update-syntax-classes (&optional set-default)
+ (let ((preference (cond ((eq viper-syntax-preference 'emacs)
+ "w") ; Viper words have only Emacs word chars
+ ((eq viper-syntax-preference 'extended)
+ "w_") ; Viper words have Emacs word & symbol chars
+ (t "w"))) ; Viper words are Emacs words plus `_'
+ (non-word-chars (cond ((eq viper-syntax-preference 'reformed-vi)
+ (viper-string-to-list
+ viper-non-word-characters-reformed-vi))
+ (t nil))))
+ (if set-default
+ (setq-default viper-ALPHA-char-class preference
+ viper-non-word-characters non-word-chars)
+ (setq viper-ALPHA-char-class preference
+ viper-non-word-characters non-word-chars))
+ ))
+
+;; SYMBOL is used because customize requires it, but it is ignored, unless it
+;; is `nil'. If nil, use setq.
+(defun viper-set-syntax-preference (&optional symbol value)
+ "Set Viper syntax preference.
+If called interactively or if SYMBOL is nil, sets syntax preference in current
+buffer. If called non-interactively, preferably via the customization widget,
+sets the default value."
+ (interactive)
+ (or value
+ (setq value
+ (completing-read
+ "Viper syntax preference: "
+ '(("strict-vi") ("reformed-vi") ("extended") ("emacs"))
+ nil 'require-match)))
+ (if (stringp value) (setq value (intern value)))
+ (or (memq value '(strict-vi reformed-vi extended emacs))
+ (error "Invalid Viper syntax preference, %S" value))
+ (if symbol
+ (setq-default viper-syntax-preference value)
+ (setq viper-syntax-preference value))
+ (viper-update-syntax-classes))
+
+(defcustom viper-syntax-preference 'reformed-vi
+ "*Syntax type characterizing Viper's alphanumeric symbols.
+Affects movement and change commands that deal with Vi-style words.
+Works best when set in the hooks to various major modes.
+
+`strict-vi' means Viper words are (hopefully) exactly as in Vi.
+
+`reformed-vi' means Viper words are like Emacs words \(as determined using
+Emacs syntax tables, which are different for different major modes\) with two
+exceptions: the symbol `_' is always part of a word and typical Vi non-word
+symbols, such as `,',:,\",),{, etc., are excluded.
+This behaves very close to `strict-vi', but also works well with non-ASCII
+characters from various alphabets.
+
+`extended' means Viper word constituents are symbols that are marked as being
+parts of words OR symbols in Emacs syntax tables.
+This is most appropriate for major modes intended for editing programs.
+
+`emacs' means Viper words are the same as Emacs words as specified by Emacs
+syntax tables.
+This option is appropriate if you like Emacs-style words."
+ :type '(radio (const strict-vi) (const reformed-vi)
+ (const extended) (const emacs))
+ :set 'viper-set-syntax-preference
+ :group 'viper)
+(make-variable-buffer-local 'viper-syntax-preference)
+
+
+;; addl-chars are characters to be temporarily considered as alphanumerical
+(defun viper-looking-at-alpha (&optional addl-chars)
+ (or (stringp addl-chars) (setq addl-chars ""))
+ (if (eq viper-syntax-preference 'reformed-vi)
+ (setq addl-chars (concat addl-chars "_")))
+ (let ((char (char-after (point))))
+ (if char
+ (if (eq viper-syntax-preference 'strict-vi)
+ (looking-at (concat "[" viper-strict-ALPHA-chars addl-chars "]"))
+ (or
+ ;; or one of the additional chars being asked to include
+ (memq char (viper-string-to-list addl-chars))
+ (and
+ ;; not one of the excluded word chars
+ (not (memq char viper-non-word-characters))
+ ;; char of the Viper-word syntax class
+ (memq (char-syntax char)
+ (viper-string-to-list viper-ALPHA-char-class))))))
+ ))
+
+(defun viper-looking-at-separator ()
+ (let ((char (char-after (point))))
+ (if char
+ (if (eq viper-syntax-preference 'strict-vi)
+ (memq char (viper-string-to-list viper-strict-SEP-chars))
+ (or (eq char ?\n) ; RET is always a separator in Vi
+ (memq (char-syntax char)
+ (viper-string-to-list viper-SEP-char-class)))))
+ ))
+
+(defsubst viper-looking-at-alphasep (&optional addl-chars)
+ (or (viper-looking-at-separator) (viper-looking-at-alpha addl-chars)))
+
+(defun viper-skip-alpha-forward (&optional addl-chars)
+ (or (stringp addl-chars) (setq addl-chars ""))
+ (viper-skip-syntax
+ 'forward
+ (cond ((eq viper-syntax-preference 'strict-vi)
+ "")
+ (t viper-ALPHA-char-class))
+ (cond ((eq viper-syntax-preference 'strict-vi)
+ (concat viper-strict-ALPHA-chars addl-chars))
+ (t addl-chars))))
+
+(defun viper-skip-alpha-backward (&optional addl-chars)
+ (or (stringp addl-chars) (setq addl-chars ""))
+ (viper-skip-syntax
+ 'backward
+ (cond ((eq viper-syntax-preference 'strict-vi)
+ "")
+ (t viper-ALPHA-char-class))
+ (cond ((eq viper-syntax-preference 'strict-vi)
+ (concat viper-strict-ALPHA-chars addl-chars))
+ (t addl-chars))))
+
+;; weird syntax tables may confuse strict-vi style
+(defsubst viper-skip-all-separators-forward (&optional within-line)
+ (if (eq viper-syntax-preference 'strict-vi)
+ (if within-line
+ (skip-chars-forward viper-strict-SEP-chars-sans-newline)
+ (skip-chars-forward viper-strict-SEP-chars))
+ (viper-skip-syntax 'forward
+ viper-SEP-char-class
+ (or within-line "\n")
+ (if within-line (viper-line-pos 'end)))))
+(defsubst viper-skip-all-separators-backward (&optional within-line)
+ (if (eq viper-syntax-preference 'strict-vi)
+ (if within-line
+ (skip-chars-backward viper-strict-SEP-chars-sans-newline)
+ (skip-chars-backward viper-strict-SEP-chars))
+ (viper-skip-syntax 'backward
+ viper-SEP-char-class
+ (or within-line "\n")
+ (if within-line (viper-line-pos 'start)))))
+(defun viper-skip-nonseparators (direction)
+ (viper-skip-syntax
+ direction
+ (concat "^" viper-SEP-char-class)
+ nil
+ (viper-line-pos (if (eq direction 'forward) 'end 'start))))
+
+
+;; skip over non-word constituents and non-separators
+(defun viper-skip-nonalphasep-forward ()
+ (if (eq viper-syntax-preference 'strict-vi)
+ (skip-chars-forward
+ (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars))
+ (viper-skip-syntax
+ 'forward
+ (concat "^" viper-ALPHA-char-class viper-SEP-char-class)
+ ;; Emacs may consider some of these as words, but we don't want them
+ viper-non-word-characters
+ (viper-line-pos 'end))))
+(defun viper-skip-nonalphasep-backward ()
+ (if (eq viper-syntax-preference 'strict-vi)
+ (skip-chars-backward
+ (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars))
+ (viper-skip-syntax
+ 'backward
+ (concat "^" viper-ALPHA-char-class viper-SEP-char-class)
+ ;; Emacs may consider some of these as words, but we don't want them
+ viper-non-word-characters
+ (viper-line-pos 'start))))
+
+;; Skip SYNTAX like skip-syntax-* and ADDL-CHARS like skip-chars-*
+;; Return the number of chars traveled.
+;; Both SYNTAX or ADDL-CHARS can be strings or lists of characters.
+;; When SYNTAX is "w", then viper-non-word-characters are not considered to be
+;; words, even if Emacs syntax table says they are.
+(defun viper-skip-syntax (direction syntax addl-chars &optional limit)
+ (let ((total 0)
+ (local 1)
+ (skip-chars-func
+ (if (eq direction 'forward)
+ 'skip-chars-forward 'skip-chars-backward))
+ (skip-syntax-func
+ (if (eq direction 'forward)
+ 'viper-forward-char-carefully 'viper-backward-char-carefully))
+ char-looked-at syntax-of-char-looked-at negated-syntax)
+ (setq addl-chars
+ (cond ((listp addl-chars) (viper-charlist-to-string addl-chars))
+ ((stringp addl-chars) addl-chars)
+ (t "")))
+ (setq syntax
+ (cond ((listp syntax) syntax)
+ ((stringp syntax) (viper-string-to-list syntax))
+ (t nil)))
+ (if (memq ?^ syntax) (setq negated-syntax t))
+
+ (while (and (not (= local 0))
+ (cond ((eq direction 'forward)
+ (not (eobp)))
+ (t (not (bobp)))))
+ (setq char-looked-at (viper-char-at-pos direction)
+ ;; if outside the range, set to nil
+ syntax-of-char-looked-at (if char-looked-at
+ (char-syntax char-looked-at)))
+ (setq local
+ (+ (if (and
+ (cond ((and limit (eq direction 'forward))
+ (< (point) limit))
+ (limit ; backward & limit
+ (> (point) limit))
+ (t t)) ; no limit
+ ;; char under/before cursor has appropriate syntax
+ (if negated-syntax
+ (not (memq syntax-of-char-looked-at syntax))
+ (memq syntax-of-char-looked-at syntax))
+ ;; if char-syntax class is "word", make sure it is not one
+ ;; of the excluded characters
+ (if (and (eq syntax-of-char-looked-at ?w)
+ (not negated-syntax))
+ (not (memq char-looked-at viper-non-word-characters))
+ t))
+ (funcall skip-syntax-func 1)
+ 0)
+ (funcall skip-chars-func addl-chars limit)))
+ (setq total (+ total local)))
+ total
+ ))
+
(provide 'viper-util)
+
+
+;;; Local Variables:
+;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
+;;; End:
;;; viper-util.el ends here