1 ;;; viper-util.el --- Utilities used by viper.el
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (defvar viper-overriding-map)
30 (defvar pm-color-alist)
31 (defvar zmacs-region-stays)
32 (defvar viper-minibuffer-current-face)
33 (defvar viper-minibuffer-insert-face)
34 (defvar viper-minibuffer-vi-face)
35 (defvar viper-minibuffer-emacs-face)
36 (defvar viper-replace-overlay-face)
37 (defvar viper-fast-keyseq-timeout)
38 (defvar ex-unix-type-shell)
39 (defvar ex-unix-type-shell-options)
40 (defvar viper-ex-tmp-buf-name)
41 (defvar viper-syntax-preference)
48 (let ((load-path (cons (expand-file-name ".") load-path)))
49 (or (featurep 'viper-init)
50 (load "viper-init.el" nil nil 'nosuffix))
57 ;; A fix for NeXT Step
58 ;; Should go away, when NS people fix the design flaw, which leaves the
59 ;; two x-* functions undefined.
60 (if (and (not (fboundp 'x-display-color-p)) (fboundp 'ns-display-color-p))
61 (fset 'x-display-color-p (symbol-function 'ns-display-color-p)))
62 (if (and (not (fboundp 'x-color-defined-p)) (fboundp 'ns-color-defined-p))
63 (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p)))
71 (fset 'viper-read-event (symbol-function 'next-command-event))
72 (fset 'viper-make-overlay (symbol-function 'make-extent))
73 (fset 'viper-overlay-start (symbol-function 'extent-start-position))
74 (fset 'viper-overlay-end (symbol-function 'extent-end-position))
75 (fset 'viper-overlay-put (symbol-function 'set-extent-property))
76 (fset 'viper-overlay-p (symbol-function 'extentp))
77 (fset 'viper-overlay-get (symbol-function 'extent-property))
78 (fset 'viper-move-overlay (symbol-function 'set-extent-endpoints))
79 (fset 'viper-overlay-live-p (symbol-function 'extent-live-p))
80 (if (viper-window-display-p)
81 (fset 'viper-iconify (symbol-function 'iconify-frame)))
82 (cond ((viper-has-face-support-p)
83 (fset 'viper-get-face (symbol-function 'get-face))
84 (fset 'viper-color-defined-p
85 (symbol-function 'valid-color-name-p))
87 (fset 'viper-read-event (symbol-function 'read-event))
88 (fset 'viper-make-overlay (symbol-function 'make-overlay))
89 (fset 'viper-overlay-start (symbol-function 'overlay-start))
90 (fset 'viper-overlay-end (symbol-function 'overlay-end))
91 (fset 'viper-overlay-put (symbol-function 'overlay-put))
92 (fset 'viper-overlay-p (symbol-function 'overlayp))
93 (fset 'viper-overlay-get (symbol-function 'overlay-get))
94 (fset 'viper-move-overlay (symbol-function 'move-overlay))
95 (fset 'viper-overlay-live-p (symbol-function 'overlayp))
96 (if (viper-window-display-p)
97 (fset 'viper-iconify (symbol-function 'iconify-or-deiconify-frame)))
98 (cond ((viper-has-face-support-p)
99 (fset 'viper-get-face (symbol-function 'internal-get-face))
100 (fset 'viper-color-defined-p (symbol-function 'x-color-defined-p))
104 (fset 'viper-characterp
106 (if viper-xemacs-p 'characterp 'integerp)))
108 (fset 'viper-int-to-char
110 (if viper-xemacs-p 'int-to-char 'identity)))
112 ;; CHAR is supposed to be a char or an integer (positive or negative)
113 ;; LIST is a list of chars, nil, and negative numbers
114 ;; Check if CHAR is a member by trying to convert in characters, if necessary.
115 ;; Introduced for compatibility with XEmacs, where integers are not the same as
117 (defun viper-memq-char (char list)
118 (cond ((and (integerp char) (>= char 0))
119 (memq (viper-int-to-char char) list))
122 ;; Check if char-or-int and char are the same as characters
123 (defun viper-char-equal (char-or-int char)
124 (cond ((and (integerp char-or-int) (>= char-or-int 0))
125 (= (viper-int-to-char char-or-int) char))
126 ((eq char-or-int char))))
128 ;; Like =, but accommodates null and also is t for eq-objects
129 (defun viper= (char char1)
130 (cond ((eq char char1) t)
131 ((and (viper-characterp char) (viper-characterp char1))
135 (defsubst viper-color-display-p ()
138 (eq (device-class (selected-device)) 'color)))
140 (defsubst viper-get-cursor-color ()
142 (cdr (assoc 'cursor-color (frame-parameters)))
143 (color-instance-name (frame-property (selected-frame) 'cursor-color))))
147 (cond ((eq (viper-device-type) 'pm)
148 (fset 'viper-color-defined-p
149 (lambda (color) (assoc color pm-color-alist)))))
153 (defun viper-change-cursor-color (new-color)
154 (if (and (viper-window-display-p) (viper-color-display-p)
155 (stringp new-color) (viper-color-defined-p new-color)
156 (not (string= new-color (viper-get-cursor-color))))
158 (modify-frame-parameters
159 (selected-frame) (list (cons 'cursor-color new-color)))
161 (selected-frame) 'cursor-color (make-color-instance new-color)))
164 ;; By default, saves current frame cursor color in the
165 ;; viper-saved-cursor-color-in-replace-mode property of viper-replace-overlay
166 (defun viper-save-cursor-color (before-which-mode)
167 (if (and (viper-window-display-p) (viper-color-display-p))
168 (let ((color (viper-get-cursor-color)))
169 (if (and (stringp color) (viper-color-defined-p color)
170 (not (string= color viper-replace-overlay-cursor-color)))
171 (modify-frame-parameters
175 (if (eq before-which-mode 'before-replace-mode)
176 'viper-saved-cursor-color-in-replace-mode
177 'viper-saved-cursor-color-in-insert-mode)
182 (defsubst viper-get-saved-cursor-color-in-replace-mode ()
185 (if viper-emacs-p 'frame-parameter 'frame-property)
187 'viper-saved-cursor-color-in-replace-mode)
188 viper-vi-state-cursor-color))
190 (defsubst viper-get-saved-cursor-color-in-insert-mode ()
193 (if viper-emacs-p 'frame-parameter 'frame-property)
195 'viper-saved-cursor-color-in-insert-mode)
196 viper-vi-state-cursor-color))
198 ;; restore cursor color from replace overlay
199 (defun viper-restore-cursor-color(after-which-mode)
200 (if (viper-overlay-p viper-replace-overlay)
201 (viper-change-cursor-color
202 (if (eq after-which-mode 'after-replace-mode)
203 (viper-get-saved-cursor-color-in-replace-mode)
204 (viper-get-saved-cursor-color-in-insert-mode))
208 ;; Check the current version against the major and minor version numbers
209 ;; using op: cur-vers op major.minor If emacs-major-version or
210 ;; emacs-minor-version are not defined, we assume that the current version
211 ;; is hopelessly outdated. We assume that emacs-major-version and
212 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
213 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
214 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
215 ;; incorrect. However, this gives correct result in our cases, since we are
216 ;; testing for sufficiently high Emacs versions.
217 (defun viper-check-version (op major minor &optional type-of-emacs)
218 (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
219 (and (cond ((eq type-of-emacs 'xemacs) viper-xemacs-p)
220 ((eq type-of-emacs 'emacs) viper-emacs-p)
222 (cond ((eq op '=) (and (= emacs-minor-version minor)
223 (= emacs-major-version major)))
224 ((memq op '(> >= < <=))
225 (and (or (funcall op emacs-major-version major)
226 (= emacs-major-version major))
227 (if (= emacs-major-version major)
228 (funcall op emacs-minor-version minor)
231 (error "%S: Invalid op in viper-check-version" op))))
232 (cond ((memq op '(= > >=)) nil)
233 ((memq op '(< <=)) t))))
236 (defun viper-get-visible-buffer-window (wind)
238 (get-buffer-window wind t)
239 (get-buffer-window wind 'visible)))
242 ;; Return line position.
243 ;; If pos is 'start then returns position of line start.
244 ;; If pos is 'end, returns line end. If pos is 'mid, returns line center.
245 ;; Pos = 'indent returns beginning of indentation.
246 ;; Otherwise, returns point. Current point is not moved in any case."
247 (defun viper-line-pos (pos)
248 (let ((cur-pos (point))
256 (goto-char (+ (viper-line-pos 'start) (viper-line-pos 'end) 2)))
258 (back-to-indentation))
260 (setq result (point))
264 ;; Emacs counts each multibyte character as several positions in the buffer, so
265 ;; we use Emacs' chars-in-region. XEmacs is counting each char as just one pos,
266 ;; so we can simply subtract.
267 (defun viper-chars-in-region (beg end &optional preserve-sign)
268 (let ((count (abs (if (fboundp 'chars-in-region)
269 (chars-in-region beg end)
271 (if (and (< end beg) preserve-sign)
275 ;; Test if POS is between BEG and END
276 (defsubst viper-pos-within-region (pos beg end)
277 (and (>= pos (min beg end)) (>= (max beg end) pos)))
280 ;; Like move-marker but creates a virgin marker if arg isn't already a marker.
281 ;; The first argument must eval to a variable name.
282 ;; Arguments: (var-name position &optional buffer).
284 ;; This is useful for moving markers that are supposed to be local.
285 ;; For this, VAR-NAME should be made buffer-local with nil as a default.
286 ;; Then, each time this var is used in `viper-move-marker-locally' in a new
287 ;; buffer, a new marker will be created.
288 (defun viper-move-marker-locally (var pos &optional buffer)
289 (if (markerp (eval var))
291 (set var (make-marker)))
292 (move-marker (eval var) pos buffer))
295 ;; Print CONDITIONS as a message.
296 (defun viper-message-conditions (conditions)
297 (let ((case (car conditions)) (msg (cdr conditions)))
300 (message "%s: %s" case (mapconcat 'prin1-to-string msg " ")))
305 ;;; List/alist utilities
307 ;; Convert LIST to an alist
308 (defun viper-list-to-alist (lst)
311 (setq alist (cons (list (car lst)) alist))
312 (setq lst (cdr lst)))
315 ;; Convert ALIST to a list.
316 (defun viper-alist-to-list (alst)
319 (setq lst (cons (car (car alst)) lst))
320 (setq alst (cdr alst)))
323 ;; Filter ALIST using REGEXP. Return alist whose elements match the regexp.
324 (defun viper-filter-alist (regexp alst)
326 (let ((outalst) (inalst alst))
328 (if (string-match regexp (car (car inalst)))
329 (setq outalst (cons (car inalst) outalst)))
330 (setq inalst (cdr inalst)))
333 ;; Filter LIST using REGEXP. Return list whose elements match the regexp.
334 (defun viper-filter-list (regexp lst)
336 (let ((outlst) (inlst lst))
338 (if (string-match regexp (car inlst))
339 (setq outlst (cons (car inlst) outlst)))
340 (setq inlst (cdr inlst)))
344 ;; Append LIS2 to LIS1, both alists, by side-effect and returns LIS1
345 ;; LIS2 is modified by filtering it: deleting its members of the form
346 ;; \(car elt\) such that (car elt') is in LIS1.
347 (defun viper-append-filter-alist (lis1 lis2)
350 ;;filter-append the second list
352 ;; delete all occurrences
353 (while (setq elt (assoc (car (car temp)) lis2))
354 (setq lis2 (delq elt lis2)))
355 (setq temp (cdr temp)))
361 ;;; Support for :e, :r, :w file globbing
363 ;; Glob the file spec.
364 ;; This function is designed to work under Unix. It might also work under VMS.
365 (defun viper-glob-unix-files (filespec)
367 (cond (ex-unix-type-shell shell-file-name)
368 ((memq system-type '(vax-vms axp-vms)) "*dcl*") ; VAX VMS
369 (t "sh"))) ; probably Unix anyway
371 ;; using cond in anticipation of further additions
372 (cond (ex-unix-type-shell-options)
374 (command (cond (viper-ms-style-os-p (format "\"ls -1 -d %s\"" filespec))
375 (t (format "ls -1 -d %s" filespec))))
378 (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
382 (call-process gshell nil t nil
386 (call-process gshell nil t nil
389 (goto-char (point-min))
390 ;; Issue an error, if no match.
393 (skip-chars-forward " \t\n\j")
394 (if (looking-at "ls:")
395 (viper-forward-Word 1))
400 (buffer-substring (point) (viper-line-pos 'end)))
402 (goto-char (point-min))
403 (viper-get-filenames-from-buffer 'one-per-line))
407 ;; Interpret the stuff in the buffer as a list of file names
408 ;; return a list of file names listed in the buffer beginning at point
409 ;; If optional arg is supplied, assume each filename is listed on a separate
411 (defun viper-get-filenames-from-buffer (&optional one-per-line)
412 (let ((skip-chars (if one-per-line "\t\n" " \t\n"))
414 (skip-chars-forward skip-chars)
416 (if (cond ((looking-at "\"")
418 (re-search-forward "[^\"]+" nil t)) ; noerror
421 (re-search-forward "[^']+" nil t)) ; noerror
424 (concat "[^" skip-chars "]+") nil t))) ;noerror
426 (buffer-substring (match-beginning 0) (match-end 0))))
429 (skip-chars-forward " \t\n")
430 (setq result (cons fname result)))
433 ;; convert MS-DOS wildcards to regexp
434 (defun viper-wildcard-to-regexp (wcard)
436 (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
439 (goto-char (point-min))
441 (skip-chars-forward "^*?.\\\\")
442 (cond ((eq (char-after (point)) ?*) (insert ".")(forward-char 1))
443 ((eq (char-after (point)) ?.) (insert "\\")(forward-char 1))
444 ((eq (char-after (point)) ?\\) (insert "\\")(forward-char 1))
445 ((eq (char-after (point)) ??) (delete-char 1)(insert ".")))
451 ;; glob windows files
452 ;; LIST is expected to be in reverse order
453 (defun viper-glob-mswindows-files (filespec)
454 (let ((case-fold-search t)
457 (set-buffer (get-buffer-create viper-ex-tmp-buf-name))
460 (goto-char (point-min))
461 (setq tmp (viper-get-filenames-from-buffer))
463 (setq tmp2 (cons (directory-files
464 ;; the directory part
465 (or (file-name-directory (car tmp))
467 t ; return full names
468 ;; the regexp part: globs the file names
470 (viper-wildcard-to-regexp
471 (file-name-nondirectory (car tmp)))
474 (setq tmp (cdr tmp)))
475 (reverse (apply 'append tmp2)))))
480 ;; Rotate RING's index. DIRection can be positive or negative.
481 (defun viper-ring-rotate1 (ring dir)
482 (if (and (ring-p ring) (> (ring-length ring) 0))
484 (setcar ring (cond ((> dir 0)
485 (ring-plus1 (car ring) (ring-length ring)))
487 (ring-minus1 (car ring) (ring-length ring)))
488 ;; don't rotate if dir = 0
490 (viper-current-ring-item ring)
493 (defun viper-special-ring-rotate1 (ring dir)
494 (if (memq viper-intermediate-command
495 '(repeating-display-destructive-command
496 repeating-insertion-from-ring))
497 (viper-ring-rotate1 ring dir)
498 ;; don't rotate otherwise
499 (viper-ring-rotate1 ring 0)))
501 ;; current ring item; if N is given, then so many items back from the
503 (defun viper-current-ring-item (ring &optional n)
505 (if (and (ring-p ring) (> (ring-length ring) 0))
506 (aref (cdr (cdr ring)) (mod (- (car ring) 1 n) (ring-length ring)))))
508 ;; Push item onto ring. The second argument is a ring-variable, not value.
509 (defun viper-push-onto-ring (item ring-var)
510 (or (ring-p (eval ring-var))
511 (set ring-var (make-ring (eval (intern (format "%S-size" ring-var))))))
512 (or (null item) ; don't push nil
513 (and (stringp item) (string= item "")) ; or empty strings
514 (equal item (viper-current-ring-item (eval ring-var))) ; or old stuff
515 ;; Since viper-set-destructive-command checks if we are inside
516 ;; viper-repeat, we don't check whether this-command-keys is a `.'. The
517 ;; cmd viper-repeat makes a call to the current function only if `.' is
518 ;; executing a command from the command history. It doesn't call the
519 ;; push-onto-ring function if `.' is simply repeating the last
520 ;; destructive command. We only check for ESC (which happens when we do
521 ;; insert with a prefix argument, or if this-command-keys doesn't give
522 ;; anything meaningful (in that case we don't know what to show to the
524 (and (eq ring-var 'viper-command-ring)
525 (string-match "\\([0-9]*\e\\|^[ \t]*$\\|escape\\)"
526 (viper-array-to-string (this-command-keys))))
527 (viper-ring-insert (eval ring-var) item))
531 ;; removing elts from ring seems to break it
532 (defun viper-cleanup-ring (ring)
533 (or (< (ring-length ring) 2)
534 (null (viper-current-ring-item ring))
535 ;; last and previous equal
536 (if (equal (viper-current-ring-item ring)
537 (viper-current-ring-item ring 1))
538 (viper-ring-pop ring))))
540 ;; ring-remove seems to be buggy, so we concocted this for our purposes.
541 (defun viper-ring-pop (ring)
542 (let* ((ln (ring-length ring))
543 (vec (cdr (cdr ring)))
544 (veclen (length vec))
546 (idx (max 0 (ring-minus1 hd ln)))
547 (top-elt (aref vec idx)))
550 (while (< (1+ idx) veclen)
551 (aset vec idx (aref vec (1+ idx)))
555 (setq hd (max 0 (ring-minus1 hd ln)))
556 (if (= hd (1- ln)) (setq hd 0))
557 (setcar ring hd) ; move head
558 (setcar (cdr ring) (max 0 (1- ln))) ; adjust length
562 (defun viper-ring-insert (ring item)
563 (let* ((ln (ring-length ring))
564 (vec (cdr (cdr ring)))
565 (veclen (length vec))
567 (vecpos-after-hd (if (= hd 0) ln hd))
572 (aset vec hd item) ; hd is always 1+ the actual head index in vec
573 (setcar ring (ring-plus1 hd ln)))
574 (setcar (cdr ring) (1+ ln))
575 (setcar ring (ring-plus1 vecpos-after-hd (1+ ln)))
576 (while (and (>= idx vecpos-after-hd) (> ln 0))
577 (aset vec idx (aref vec (1- idx)))
579 (aset vec vecpos-after-hd item))
585 ;; If STRING is longer than MAX-LEN, truncate it and print ...... instead
586 ;; PRE-STRING is a string to prepend to the abbrev string.
587 ;; POST-STRING is a string to append to the abbrev string.
588 ;; ABBREV_SIGN is a string to be inserted before POST-STRING
589 ;; if the orig string was truncated.
590 (defun viper-abbreviate-string (string max-len
591 pre-string post-string abbrev-sign)
595 (substring string 0 (min max-len (length string)))))
596 (cond ((null truncated-str) "")
597 ((> (length string) max-len)
599 pre-string truncated-str abbrev-sign post-string))
600 (t (format "%s%s%s" pre-string truncated-str post-string)))))
602 ;; tells if we are over a whitespace-only line
603 (defsubst viper-over-whitespace-line ()
606 (looking-at "^[ \t]*$")))
609 ;;; Saving settings in custom file
611 ;; Save the current setting of VAR in CUSTOM-FILE.
612 ;; If given, MESSAGE is a message to be displayed after that.
613 ;; This message is erased after 2 secs, if erase-msg is non-nil.
614 ;; Arguments: var message custom-file &optional erase-message
615 (defun viper-save-setting (var message custom-file &optional erase-msg)
616 (let* ((var-name (symbol-name var))
617 (var-val (if (boundp var) (eval var)))
618 (regexp (format "^[^;]*%s[ \t\n]*[a-zA-Z---_']*[ \t\n)]" var-name))
619 (buf (find-file-noselect (substitute-in-file-name custom-file)))
624 (goto-char (point-min))
625 (if (re-search-forward regexp nil t)
626 (let ((reg-end (1- (match-end 0))))
627 (search-backward var-name)
628 (delete-region (match-beginning 0) reg-end)
629 (goto-char (match-beginning 0))
630 (insert (format "%s '%S" var-name var-val)))
631 (goto-char (point-max))
632 (if (not (bolp)) (insert "\n"))
633 (insert (format "(setq %s '%S)\n" var-name var-val)))
642 ;; Save STRING in CUSTOM-FILE. If PATTERN is non-nil, remove strings that
643 ;; match this pattern.
644 (defun viper-save-string-in-file (string custom-file &optional pattern)
645 (let ((buf (find-file-noselect (substitute-in-file-name custom-file))))
648 (let (buffer-read-only)
649 (goto-char (point-min))
650 (if pattern (delete-matching-lines pattern))
651 (goto-char (point-max))
652 (if string (insert string))
658 ;; define remote file test
659 (or (fboundp 'viper-file-remote-p) ; user supplied his own function: use it
660 (defun viper-file-remote-p (file-name)
661 (car (cond ((featurep 'efs-auto) (efs-ftp-path file-name))
662 ((fboundp 'file-remote-p) (file-remote-p file-name))
663 (t (require 'ange-ftp)
664 ;; Can happen only in Emacs, since XEmacs has file-remote-p
665 (ange-ftp-ftp-name file-name))))))
669 ;; This is a simple-minded check for whether a file is under version control.
670 ;; If file,v exists but file doesn't, this file is considered to be not checked
671 ;; in and not checked out for the purpose of patching (since patch won't be
672 ;; able to read such a file anyway).
673 ;; FILE is a string representing file name
674 ;;(defun viper-file-under-version-control (file)
675 ;; (let* ((filedir (file-name-directory file))
676 ;; (file-nondir (file-name-nondirectory file))
677 ;; (trial (concat file-nondir ",v"))
678 ;; (full-trial (concat filedir trial))
679 ;; (full-rcs-trial (concat filedir "RCS/" trial)))
680 ;; (and (stringp file)
681 ;; (file-exists-p file)
684 ;; (file-exists-p full-trial)
685 ;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
686 ;; ;; don't be fooled by this!
687 ;; (not (equal (file-attributes file)
688 ;; (file-attributes full-trial))))
689 ;; ;; check if a version is in RCS/ directory
690 ;; (file-exists-p full-rcs-trial)))
694 (defsubst viper-file-checked-in-p (file)
695 (and (featurep 'vc-hooks)
696 ;; CVS files are considered not checked in
697 (not (memq (vc-backend file) '(nil CVS)))
698 (if (fboundp 'vc-state)
700 (not (memq (vc-state file) '(edited needs-merge)))
701 (not (stringp (vc-state file))))
702 ;; XEmacs has no vc-state
703 (not (vc-locking-user file)))
706 ;; checkout if visited file is checked in
707 (defun viper-maybe-checkout (buf)
708 (let ((file (expand-file-name (buffer-file-name buf)))
709 (checkout-function (key-binding "\C-x\C-q")))
710 (if (and (viper-file-checked-in-p file)
714 "File %s is checked in. Check it out? "
715 (viper-abbreviate-file-name file))))
716 (with-current-buffer buf
717 (command-execute checkout-function)))))
723 (defun viper-put-on-search-overlay (beg end)
724 (if (viper-overlay-p viper-search-overlay)
725 (viper-move-overlay viper-search-overlay beg end)
726 (setq viper-search-overlay (viper-make-overlay beg end (current-buffer)))
728 viper-search-overlay 'priority viper-search-overlay-priority))
729 (viper-overlay-put viper-search-overlay 'face viper-search-face))
733 (defun viper-flash-search-pattern ()
734 (if (not (viper-has-face-support-p))
736 (viper-put-on-search-overlay (match-beginning 0) (match-end 0))
738 (viper-overlay-put viper-search-overlay 'face nil)))
740 (defun viper-hide-search-overlay ()
741 (if (not (viper-overlay-p viper-search-overlay))
743 (setq viper-search-overlay
744 (viper-make-overlay (point-min) (point-min) (current-buffer)))
746 viper-search-overlay 'priority viper-search-overlay-priority)))
747 (viper-overlay-put viper-search-overlay 'face nil))
751 (defsubst viper-move-replace-overlay (beg end)
752 (viper-move-overlay viper-replace-overlay beg end))
754 (defun viper-set-replace-overlay (beg end)
755 (if (viper-overlay-live-p viper-replace-overlay)
756 (viper-move-replace-overlay beg end)
757 (setq viper-replace-overlay (viper-make-overlay beg end (current-buffer)))
760 viper-replace-overlay (if viper-emacs-p 'evaporate 'detachable) nil)
762 viper-replace-overlay 'priority viper-replace-overlay-priority)
763 ;; If Emacs will start supporting overlay maps, as it currently supports
764 ;; text-property maps, we could do away with viper-replace-minor-mode and
765 ;; just have keymap attached to replace overlay.
767 ;; viper-replace-overlay
768 ;; (if viper-xemacs-p 'keymap 'local-map)
769 ;; viper-replace-map)
771 (if (viper-has-face-support-p)
773 viper-replace-overlay 'face viper-replace-overlay-face))
774 (viper-save-cursor-color 'before-replace-mode)
775 (viper-change-cursor-color viper-replace-overlay-cursor-color)
779 (defun viper-set-replace-overlay-glyphs (before-glyph after-glyph)
780 (or (viper-overlay-live-p viper-replace-overlay)
781 (viper-set-replace-overlay (point-min) (point-min)))
782 (if (or (not (viper-has-face-support-p))
783 viper-use-replace-region-delimiters)
784 (let ((before-name (if viper-xemacs-p 'begin-glyph 'before-string))
785 (after-name (if viper-xemacs-p 'end-glyph 'after-string)))
786 (viper-overlay-put viper-replace-overlay before-name before-glyph)
787 (viper-overlay-put viper-replace-overlay after-name after-glyph))))
789 (defun viper-hide-replace-overlay ()
790 (viper-set-replace-overlay-glyphs nil nil)
791 (viper-restore-cursor-color 'after-replace-mode)
792 (viper-restore-cursor-color 'after-insert-mode)
793 (if (viper-has-face-support-p)
794 (viper-overlay-put viper-replace-overlay 'face nil)))
797 (defsubst viper-replace-start ()
798 (viper-overlay-start viper-replace-overlay))
799 (defsubst viper-replace-end ()
800 (viper-overlay-end viper-replace-overlay))
805 (defun viper-set-minibuffer-overlay ()
806 (viper-check-minibuffer-overlay)
807 (if (viper-has-face-support-p)
810 viper-minibuffer-overlay 'face viper-minibuffer-current-face)
812 viper-minibuffer-overlay 'priority viper-minibuffer-overlay-priority)
815 viper-minibuffer-overlay
816 (if viper-emacs-p 'evaporate 'detachable)
818 ;; make viper-minibuffer-overlay open-ended
819 ;; In emacs, it is made open ended at creation time
822 (viper-overlay-put viper-minibuffer-overlay 'start-open nil)
823 (viper-overlay-put viper-minibuffer-overlay 'end-open nil)))
826 (defun viper-check-minibuffer-overlay ()
827 (or (viper-overlay-p viper-minibuffer-overlay)
828 (setq viper-minibuffer-overlay
830 (viper-make-overlay 1 (1+ (buffer-size)) (current-buffer))
831 ;; make overlay open-ended
833 1 (1+ (buffer-size)) (current-buffer) nil 'rear-advance)))
837 (defsubst viper-is-in-minibuffer ()
839 (string-match "\*Minibuf-" (buffer-name))))
843 ;;; XEmacs compatibility
845 (defun viper-abbreviate-file-name (file)
847 (abbreviate-file-name file)
848 ;; XEmacs requires addl argument
849 (abbreviate-file-name file t)))
851 ;; Sit for VAL milliseconds. XEmacs doesn't support the millisecond arg
852 ;; in sit-for, so this function smoothes out the differences.
853 (defsubst viper-sit-for-short (val &optional nodisp)
855 (sit-for (/ val 1000.0) nodisp)
856 (sit-for 0 val nodisp)))
858 ;; EVENT may be a single event of a sequence of events
859 (defsubst viper-ESC-event-p (event)
860 (let ((ESC-keys '(?\e (control \[) escape))
861 (key (viper-event-key event)))
862 (member key ESC-keys)))
864 ;; checks if object is a marker, has a buffer, and points to within that buffer
865 (defun viper-valid-marker (marker)
866 (if (and (markerp marker) (marker-buffer marker))
867 (let ((buf (marker-buffer marker))
868 (pos (marker-position marker)))
871 (and (<= pos (point-max)) (<= (point-min) pos))))))
873 (defsubst viper-mark-marker ()
878 ;; like (set-mark-command nil) but doesn't push twice, if (car mark-ring)
879 ;; is the same as (mark t).
880 (defsubst viper-set-mark-if-necessary ()
881 (setq mark-ring (delete (viper-mark-marker) mark-ring))
882 (set-mark-command nil)
883 (setq viper-saved-mark (point)))
885 ;; In transient mark mode (zmacs mode), it is annoying when regions become
886 ;; highlighted due to Viper's pushing marks. So, we deactivate marks, unless
887 ;; the user explicitly wants highlighting, e.g., by hitting '' or ``
888 (defun viper-deactivate-mark ()
890 (zmacs-deactivate-region)
893 (defsubst viper-leave-region-active ()
895 (setq zmacs-region-stays t)))
897 ;; Check if arg is a valid character for register
898 ;; TYPE is a list that can contain `letter', `Letter', and `digit'.
899 ;; Letter means lowercase letters, Letter means uppercase letters, and
900 ;; digit means digits from 1 to 9.
901 ;; If TYPE is nil, then down/uppercase letters and digits are allowed.
902 (defun viper-valid-register (reg &optional type)
903 (or type (setq type '(letter Letter digit)))
904 (or (if (memq 'letter type)
905 (and (<= ?a reg) (<= reg ?z)))
906 (if (memq 'digit type)
907 (and (<= ?1 reg) (<= reg ?9)))
908 (if (memq 'Letter type)
909 (and (<= ?A reg) (<= reg ?Z)))
913 (defsubst viper-events-to-keys (events)
914 (cond (viper-xemacs-p (events-to-keys events))
918 ;; it is suggested that an event must be copied before it is assigned to
919 ;; last-command-event in XEmacs
920 (defun viper-copy-event (event)
925 ;; like read-event, but in XEmacs also try to convert to char, if possible
926 (defun viper-read-event-convert-to-char ()
930 (setq event (next-command-event))
931 (or (event-to-character event)
935 ;; This function lets function-key-map convert key sequences into logical
936 ;; keys. This does a better job than viper-read-event when it comes to kbd
937 ;; macros, since it enables certain macros to be shared between X and TTY modes
938 ;; by correctly mapping key sequences for Left/Right/... (one an ascii
939 ;; terminal) into logical keys left, right, etc.
940 (defun viper-read-key ()
941 (let ((overriding-local-map viper-overriding-map)
944 (use-global-map viper-overriding-map)
946 (setq key (elt (viper-read-key-sequence nil) 0))
947 (use-global-map global-map))
951 ;; Emacs has a bug in eventp, which causes (eventp nil) to return (nil)
952 ;; instead of nil, if '(nil) was previously inadvertently assigned to
953 ;; unread-command-events
954 (defun viper-event-key (event)
955 (or (and event (eventp event))
956 (error "viper-event-key: Wrong type argument, eventp, %S" event))
957 (when (cond (viper-xemacs-p (or (key-press-event-p event)
958 (mouse-event-p event)))
960 (let ((mod (event-modifiers event))
965 (cond ((key-press-event-p event)
967 ((button-event-p event)
968 (concat "mouse-" (prin1-to-string (event-button event))))
970 (error "viper-event-key: Unknown event, %S" event))))
972 ;; Emacs doesn't handle capital letters correctly, since
973 ;; \S-a isn't considered the same as A (it behaves as
974 ;; plain `a' instead). So we take care of this here
975 (cond ((and (viper-characterp event) (<= ?A event) (<= event ?Z))
978 ;; Emacs has the oddity whereby characters 128+char
979 ;; represent M-char *if* this appears inside a string.
980 ;; So, we convert them manually to (meta char).
981 ((and (viper-characterp event)
982 (< ?\C-? event) (<= event 255))
984 event (- event ?\C-? 1)))
985 ((and (null mod) (eq event 'return))
987 ((and (null mod) (eq event 'space))
989 ((and (null mod) (eq event 'delete))
991 ((and (null mod) (eq event 'backspace))
993 (t (event-basic-type event)))
995 (if (viper-characterp basis)
997 (if (viper= basis ?\C-?)
998 (list 'control '\?) ; taking care of an emacs bug
999 (intern (char-to-string basis)))))
1001 (append mod (list basis))
1004 (defun viper-key-to-emacs-key (key)
1005 (let (key-name char-p modifiers mod-char-list base-key base-key-name)
1006 (cond (viper-xemacs-p key)
1009 (setq key-name (symbol-name key))
1010 (cond ((= (length key-name) 1) ; character event
1011 (string-to-char key-name))
1012 ;; Emacs doesn't recognize `return' and `escape' as events on
1013 ;; dumb terminals, so we translate them into characters
1014 ((and viper-emacs-p (not (viper-window-display-p))
1015 (string= key-name "return"))
1017 ((and viper-emacs-p (not (viper-window-display-p))
1018 (string= key-name "escape"))
1020 ;; pass symbol-event as is
1024 (setq modifiers (subseq key 0 (1- (length key)))
1025 base-key (viper-seq-last-elt key)
1026 base-key-name (symbol-name base-key)
1027 char-p (= (length base-key-name) 1))
1030 '(lambda (elt) (upcase (substring (symbol-name elt) 0 1)))
1034 (car (read-from-string
1037 (mapconcat 'identity mod-char-list "-\\")
1043 (mapconcat 'identity mod-char-list "-")
1049 ;; Args can be a sequence of events, a string, or a Viper macro. Will try to
1050 ;; convert events to keys and, if all keys are regular printable
1051 ;; characters, will return a string. Otherwise, will return a string
1052 ;; representing a vector of converted events. If the input was a Viper macro,
1053 ;; will return a string that represents this macro as a vector.
1054 (defun viper-array-to-string (event-seq)
1056 (cond ((stringp event-seq) event-seq)
1057 ((viper-event-vector-p event-seq)
1058 (setq temp (mapcar 'viper-event-key event-seq))
1059 (cond ((viper-char-symbol-sequence-p temp)
1060 (mapconcat 'symbol-name temp ""))
1061 ((and (viper-char-array-p
1062 (setq temp2 (mapcar 'viper-key-to-character temp))))
1063 (mapconcat 'char-to-string temp2 ""))
1064 (t (prin1-to-string (vconcat temp)))))
1065 ((viper-char-symbol-sequence-p event-seq)
1066 (mapconcat 'symbol-name event-seq ""))
1067 ((and (vectorp event-seq)
1069 (setq temp (mapcar 'viper-key-to-character event-seq))))
1070 (mapconcat 'char-to-string temp ""))
1071 (t (prin1-to-string event-seq)))))
1073 (defun viper-key-press-events-to-chars (events)
1074 (mapconcat (if viper-emacs-p
1076 (lambda (elt) (char-to-string (event-to-character elt))))
1081 ;; Uses different timeouts for ESC-sequences and others
1082 (defsubst viper-fast-keysequence-p ()
1083 (not (viper-sit-for-short
1084 (if (viper-ESC-event-p last-input-event)
1085 viper-ESC-keyseq-timeout
1086 viper-fast-keyseq-timeout)
1089 (defun viper-read-char-exclusive ()
1091 (echo-keystrokes 1))
1094 (setq char (read-char))
1096 ;; skip event if not char
1097 (viper-read-event))))
1100 ;; key is supposed to be in viper's representation, e.g., (control l), a
1102 (defun viper-key-to-character (key)
1103 (cond ((eq key 'space) ?\ )
1104 ((eq key 'delete) ?\C-?)
1105 ((eq key 'return) ?\C-m)
1106 ((eq key 'backspace) ?\C-h)
1108 (= 1 (length (symbol-name key))))
1109 (string-to-char (symbol-name key)))
1111 (eq (car key) 'control)
1112 (symbol-name (nth 1 key))
1113 (= 1 (length (symbol-name (nth 1 key)))))
1114 (read (format "?\\C-%s" (symbol-name (nth 1 key)))))
1118 (defun viper-setup-master-buffer (&rest other-files-or-buffers)
1119 "Set up the current buffer as a master buffer.
1120 Arguments become related buffers. This function should normally be used in
1121 the `Local variables' section of a file."
1122 (setq viper-related-files-and-buffers-ring
1123 (make-ring (1+ (length other-files-or-buffers))))
1124 (mapcar '(lambda (elt)
1125 (viper-ring-insert viper-related-files-and-buffers-ring elt))
1126 other-files-or-buffers)
1127 (viper-ring-insert viper-related-files-and-buffers-ring (buffer-name))
1130 ;;; Movement utilities
1132 ;; Characters that should not be considered as part of the word, in reformed-vi
1134 (defconst viper-non-word-characters-reformed-vi
1135 "!@#$%^&*()-+=|\\~`{}[];:'\",<.>/?")
1136 ;; These are characters that are not to be considered as parts of a word in
1138 ;; Set each time state changes and at loading time
1139 (viper-deflocalvar viper-non-word-characters nil)
1141 ;; must be buffer-local
1142 (viper-deflocalvar viper-ALPHA-char-class "w"
1143 "String of syntax classes characterizing Viper's alphanumeric symbols.
1144 In addition, the symbol `_' may be considered alphanumeric if
1145 `viper-syntax-preference' is `strict-vi' or `reformed-vi'.")
1147 (defconst viper-strict-ALPHA-chars "a-zA-Z0-9_"
1148 "Regexp matching the set of alphanumeric characters acceptable to strict
1150 (defconst viper-strict-SEP-chars " \t\n"
1151 "Regexp matching the set of alphanumeric characters acceptable to strict
1153 (defconst viper-strict-SEP-chars-sans-newline " \t"
1154 "Regexp matching the set of alphanumeric characters acceptable to strict
1157 (defconst viper-SEP-char-class " -"
1158 "String of syntax classes for Vi separators.
1159 Usually contains ` ', linefeed, TAB or formfeed.")
1162 ;; Set Viper syntax classes and related variables according to
1163 ;; `viper-syntax-preference'.
1164 (defun viper-update-syntax-classes (&optional set-default)
1165 (let ((preference (cond ((eq viper-syntax-preference 'emacs)
1166 "w") ; Viper words have only Emacs word chars
1167 ((eq viper-syntax-preference 'extended)
1168 "w_") ; Viper words have Emacs word & symbol chars
1169 (t "w"))) ; Viper words are Emacs words plus `_'
1170 (non-word-chars (cond ((eq viper-syntax-preference 'reformed-vi)
1171 (viper-string-to-list
1172 viper-non-word-characters-reformed-vi))
1175 (setq-default viper-ALPHA-char-class preference
1176 viper-non-word-characters non-word-chars)
1177 (setq viper-ALPHA-char-class preference
1178 viper-non-word-characters non-word-chars))
1181 ;; SYMBOL is used because customize requires it, but it is ignored, unless it
1182 ;; is `nil'. If nil, use setq.
1183 (defun viper-set-syntax-preference (&optional symbol value)
1184 "Set Viper syntax preference.
1185 If called interactively or if SYMBOL is nil, sets syntax preference in current
1186 buffer. If called non-interactively, preferably via the customization widget,
1187 sets the default value."
1192 "Viper syntax preference: "
1193 '(("strict-vi") ("reformed-vi") ("extended") ("emacs"))
1194 nil 'require-match)))
1195 (if (stringp value) (setq value (intern value)))
1196 (or (memq value '(strict-vi reformed-vi extended emacs))
1197 (error "Invalid Viper syntax preference, %S" value))
1199 (setq-default viper-syntax-preference value)
1200 (setq viper-syntax-preference value))
1201 (viper-update-syntax-classes))
1203 (defcustom viper-syntax-preference 'reformed-vi
1204 "*Syntax type characterizing Viper's alphanumeric symbols.
1205 Affects movement and change commands that deal with Vi-style words.
1206 Works best when set in the hooks to various major modes.
1208 `strict-vi' means Viper words are (hopefully) exactly as in Vi.
1210 `reformed-vi' means Viper words are like Emacs words \(as determined using
1211 Emacs syntax tables, which are different for different major modes\) with two
1212 exceptions: the symbol `_' is always part of a word and typical Vi non-word
1213 symbols, such as `,',:,\",),{, etc., are excluded.
1214 This behaves very close to `strict-vi', but also works well with non-ASCII
1215 characters from various alphabets.
1217 `extended' means Viper word constituents are symbols that are marked as being
1218 parts of words OR symbols in Emacs syntax tables.
1219 This is most appropriate for major modes intended for editing programs.
1221 `emacs' means Viper words are the same as Emacs words as specified by Emacs
1223 This option is appropriate if you like Emacs-style words."
1224 :type '(radio (const strict-vi) (const reformed-vi)
1225 (const extended) (const emacs))
1226 :set 'viper-set-syntax-preference
1228 (make-variable-buffer-local 'viper-syntax-preference)
1231 ;; addl-chars are characters to be temporarily considered as alphanumerical
1232 (defun viper-looking-at-alpha (&optional addl-chars)
1233 (or (stringp addl-chars) (setq addl-chars ""))
1234 (if (eq viper-syntax-preference 'reformed-vi)
1235 (setq addl-chars (concat addl-chars "_")))
1236 (let ((char (char-after (point))))
1238 (if (eq viper-syntax-preference 'strict-vi)
1239 (looking-at (concat "[" viper-strict-ALPHA-chars addl-chars "]"))
1241 ;; or one of the additional chars being asked to include
1242 (viper-memq-char char (viper-string-to-list addl-chars))
1244 ;; not one of the excluded word chars (note:
1245 ;; viper-non-word-characters is a list)
1246 (not (viper-memq-char char viper-non-word-characters))
1247 ;; char of the Viper-word syntax class
1248 (viper-memq-char (char-syntax char)
1249 (viper-string-to-list viper-ALPHA-char-class))))))
1252 (defun viper-looking-at-separator ()
1253 (let ((char (char-after (point))))
1255 (if (eq viper-syntax-preference 'strict-vi)
1256 (viper-memq-char char (viper-string-to-list viper-strict-SEP-chars))
1257 (or (eq char ?\n) ; RET is always a separator in Vi
1258 (viper-memq-char (char-syntax char)
1259 (viper-string-to-list viper-SEP-char-class)))))
1262 (defsubst viper-looking-at-alphasep (&optional addl-chars)
1263 (or (viper-looking-at-separator) (viper-looking-at-alpha addl-chars)))
1265 (defun viper-skip-alpha-forward (&optional addl-chars)
1266 (or (stringp addl-chars) (setq addl-chars ""))
1269 (cond ((eq viper-syntax-preference 'strict-vi)
1271 (t viper-ALPHA-char-class))
1272 (cond ((eq viper-syntax-preference 'strict-vi)
1273 (concat viper-strict-ALPHA-chars addl-chars))
1276 (defun viper-skip-alpha-backward (&optional addl-chars)
1277 (or (stringp addl-chars) (setq addl-chars ""))
1280 (cond ((eq viper-syntax-preference 'strict-vi)
1282 (t viper-ALPHA-char-class))
1283 (cond ((eq viper-syntax-preference 'strict-vi)
1284 (concat viper-strict-ALPHA-chars addl-chars))
1287 ;; weird syntax tables may confuse strict-vi style
1288 (defsubst viper-skip-all-separators-forward (&optional within-line)
1289 (if (eq viper-syntax-preference 'strict-vi)
1291 (skip-chars-forward viper-strict-SEP-chars-sans-newline)
1292 (skip-chars-forward viper-strict-SEP-chars))
1293 (viper-skip-syntax 'forward
1294 viper-SEP-char-class
1295 (or within-line "\n")
1296 (if within-line (viper-line-pos 'end)))))
1297 (defsubst viper-skip-all-separators-backward (&optional within-line)
1298 (if (eq viper-syntax-preference 'strict-vi)
1300 (skip-chars-backward viper-strict-SEP-chars-sans-newline)
1301 (skip-chars-backward viper-strict-SEP-chars))
1302 (viper-skip-syntax 'backward
1303 viper-SEP-char-class
1304 (or within-line "\n")
1305 (if within-line (viper-line-pos 'start)))))
1306 (defun viper-skip-nonseparators (direction)
1309 (concat "^" viper-SEP-char-class)
1311 (viper-line-pos (if (eq direction 'forward) 'end 'start))))
1314 ;; skip over non-word constituents and non-separators
1315 (defun viper-skip-nonalphasep-forward ()
1316 (if (eq viper-syntax-preference 'strict-vi)
1318 (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars))
1321 (concat "^" viper-ALPHA-char-class viper-SEP-char-class)
1322 ;; Emacs may consider some of these as words, but we don't want them
1323 viper-non-word-characters
1324 (viper-line-pos 'end))))
1325 (defun viper-skip-nonalphasep-backward ()
1326 (if (eq viper-syntax-preference 'strict-vi)
1327 (skip-chars-backward
1328 (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars))
1331 (concat "^" viper-ALPHA-char-class viper-SEP-char-class)
1332 ;; Emacs may consider some of these as words, but we don't want them
1333 viper-non-word-characters
1334 (viper-line-pos 'start))))
1336 ;; Skip SYNTAX like skip-syntax-* and ADDL-CHARS like skip-chars-*
1337 ;; Return the number of chars traveled.
1338 ;; Both SYNTAX or ADDL-CHARS can be strings or lists of characters.
1339 ;; When SYNTAX is "w", then viper-non-word-characters are not considered to be
1340 ;; words, even if Emacs syntax table says they are.
1341 (defun viper-skip-syntax (direction syntax addl-chars &optional limit)
1345 (if (eq direction 'forward)
1346 'skip-chars-forward 'skip-chars-backward))
1348 (if (eq direction 'forward)
1349 'viper-forward-char-carefully 'viper-backward-char-carefully))
1350 char-looked-at syntax-of-char-looked-at negated-syntax)
1352 (cond ((listp addl-chars) (viper-charlist-to-string addl-chars))
1353 ((stringp addl-chars) addl-chars)
1356 (cond ((listp syntax) syntax)
1357 ((stringp syntax) (viper-string-to-list syntax))
1359 (if (memq ?^ syntax) (setq negated-syntax t))
1361 (while (and (not (= local 0))
1362 (cond ((eq direction 'forward)
1365 (setq char-looked-at (viper-char-at-pos direction)
1366 ;; if outside the range, set to nil
1367 syntax-of-char-looked-at (if char-looked-at
1368 (char-syntax char-looked-at)))
1371 (cond ((and limit (eq direction 'forward))
1373 (limit ; backward & limit
1376 ;; char under/before cursor has appropriate syntax
1378 (not (memq syntax-of-char-looked-at syntax))
1379 (memq syntax-of-char-looked-at syntax))
1380 ;; if char-syntax class is "word", make sure it is not one
1381 ;; of the excluded characters
1382 (if (and (eq syntax-of-char-looked-at ?w)
1383 (not negated-syntax))
1384 (not (viper-memq-char
1385 char-looked-at viper-non-word-characters))
1387 (funcall skip-syntax-func 1)
1389 (funcall skip-chars-func addl-chars limit)))
1390 (setq total (+ total local)))
1396 (provide 'viper-util)
1399 ;;; Local Variables:
1400 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1403 ;;; viper-util.el ends here