1 ;;; viper-util.el --- Utilities used by viper.el
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 (defvar viper-overriding-map
)
34 (defvar pm-color-alist
)
35 (defvar viper-minibuffer-current-face
)
36 (defvar viper-minibuffer-insert-face
)
37 (defvar viper-minibuffer-vi-face
)
38 (defvar viper-minibuffer-emacs-face
)
39 (defvar viper-replace-overlay-face
)
40 (defvar viper-fast-keyseq-timeout
)
41 (defvar ex-unix-type-shell
)
42 (defvar ex-unix-type-shell-options
)
43 (defvar viper-ex-tmp-buf-name
)
44 (defvar viper-syntax-preference
)
45 (defvar viper-saved-mark
)
50 (unless (fboundp 'declare-function
) (defmacro declare-function
(&rest r
))))
58 (defalias 'viper-overlay-p
59 (if (featurep 'xemacs
) 'extentp
'overlayp
))
60 (defalias 'viper-make-overlay
61 (if (featurep 'xemacs
) 'make-extent
'make-overlay
))
62 (defalias 'viper-overlay-live-p
63 (if (featurep 'xemacs
) 'extent-live-p
'overlayp
))
64 (defalias 'viper-move-overlay
65 (if (featurep 'xemacs
) 'set-extent-endpoints
'move-overlay
))
66 (defalias 'viper-overlay-start
67 (if (featurep 'xemacs
) 'extent-start-position
'overlay-start
))
68 (defalias 'viper-overlay-end
69 (if (featurep 'xemacs
) 'extent-end-position
'overlay-end
))
70 (defalias 'viper-overlay-get
71 (if (featurep 'xemacs
) 'extent-property
'overlay-get
))
72 (defalias 'viper-overlay-put
73 (if (featurep 'xemacs
) 'set-extent-property
'overlay-put
))
74 (defalias 'viper-read-event
75 (if (featurep 'xemacs
) 'next-command-event
'read-event
))
76 (defalias 'viper-characterp
77 (if (featurep 'xemacs
) 'characterp
'integerp
))
78 (defalias 'viper-int-to-char
79 (if (featurep 'xemacs
) 'int-to-char
'identity
))
80 (defalias 'viper-get-face
81 (if (featurep 'xemacs
) 'get-face
'facep
))
82 (defalias 'viper-color-defined-p
83 (if (featurep 'xemacs
) 'valid-color-name-p
'x-color-defined-p
))
84 (defalias 'viper-iconify
85 (if (featurep 'xemacs
) 'iconify-frame
'iconify-or-deiconify-frame
))
88 ;; CHAR is supposed to be a char or an integer (positive or negative)
89 ;; LIST is a list of chars, nil, and negative numbers
90 ;; Check if CHAR is a member by trying to convert in characters, if necessary.
91 ;; Introduced for compatibility with XEmacs, where integers are not the same as
93 (defun viper-memq-char (char list
)
94 (cond ((and (integerp char
) (>= char
0))
95 (memq (viper-int-to-char char
) list
))
98 ;; Check if char-or-int and char are the same as characters
99 (defun viper-char-equal (char-or-int char
)
100 (cond ((and (integerp char-or-int
) (>= char-or-int
0))
101 (= (viper-int-to-char char-or-int
) char
))
102 ((eq char-or-int char
))))
104 ;; Like =, but accommodates null and also is t for eq-objects
105 (defun viper= (char char1
)
106 (cond ((eq char char1
) t
)
107 ((and (viper-characterp char
) (viper-characterp char1
))
111 (defsubst viper-color-display-p
()
112 (if (featurep 'xemacs
) (eq (device-class (selected-device)) 'color
)
113 (x-display-color-p)))
115 (defun viper-get-cursor-color (&optional frame
)
116 (if (featurep 'xemacs
)
118 (frame-property (or frame
(selected-frame)) 'cursor-color
))
119 (cdr (assoc 'cursor-color
(frame-parameters)))))
121 (defmacro viper-frame-value
(variable)
122 "Return the value of VARIABLE local to the current frame, if there is one.
123 Otherwise return the normal value."
124 `(if (featurep 'xemacs
)
126 ;; Frame-local variables are obsolete from Emacs 22.2 onwards,
127 ;; so we do it by hand instead.
128 ;; Buffer-local values take precedence over frame-local ones.
129 (if (local-variable-p ',variable
)
131 ;; Distinguish between no frame parameter and a frame parameter
132 ;; with a value of nil.
133 (let ((fp (assoc ',variable
(frame-parameters))))
138 (cond ((eq (viper-device-type) 'pm
)
139 (fset 'viper-color-defined-p
140 (lambda (color) (assoc color pm-color-alist
)))))
144 (defun viper-change-cursor-color (new-color &optional frame
)
145 (if (and (viper-window-display-p) (viper-color-display-p)
146 (stringp new-color
) (viper-color-defined-p new-color
)
147 (not (string= new-color
(viper-get-cursor-color))))
148 (if (featurep 'xemacs
)
150 (or frame
(selected-frame))
151 'cursor-color
(make-color-instance new-color
))
152 (modify-frame-parameters
153 (or frame
(selected-frame))
154 (list (cons 'cursor-color new-color
))))))
156 ;; Note that the colors this function uses might not be those
157 ;; associated with FRAME, if there are frame-local values.
158 ;; This was equally true before the advent of viper-frame-value.
159 ;; Now it could be changed by passing frame to v-f-v.
160 (defun viper-set-cursor-color-according-to-state (&optional frame
)
161 (cond ((eq viper-current-state
'replace-state
)
162 (viper-change-cursor-color
163 (viper-frame-value viper-replace-overlay-cursor-color
)
165 ((and (eq viper-current-state
'emacs-state
)
166 (viper-frame-value viper-emacs-state-cursor-color
))
167 (viper-change-cursor-color
168 (viper-frame-value viper-emacs-state-cursor-color
)
170 ((eq viper-current-state
'insert-state
)
171 (viper-change-cursor-color
172 (viper-frame-value viper-insert-state-cursor-color
)
175 (viper-change-cursor-color
176 (viper-frame-value viper-vi-state-cursor-color
)
179 ;; By default, saves current frame cursor color before changing viper state
180 (defun viper-save-cursor-color (before-which-mode)
181 (if (and (viper-window-display-p) (viper-color-display-p))
182 (let ((color (viper-get-cursor-color)))
183 (if (and (stringp color
) (viper-color-defined-p color
)
184 ;; there is something fishy in that the color is not saved if
185 ;; it is the same as frames default cursor color. need to be
189 viper-replace-overlay-cursor-color
))))
190 (modify-frame-parameters
194 (cond ((eq before-which-mode
'before-replace-mode
)
195 'viper-saved-cursor-color-in-replace-mode
)
196 ((eq before-which-mode
'before-emacs-mode
)
197 'viper-saved-cursor-color-in-emacs-mode
)
199 'viper-saved-cursor-color-in-insert-mode
))
203 (defun viper-get-saved-cursor-color-in-replace-mode ()
206 (if (featurep 'emacs
) 'frame-parameter
'frame-property
)
208 'viper-saved-cursor-color-in-replace-mode
)
209 (or (and (eq viper-current-state
'emacs-mode
)
210 (viper-frame-value viper-emacs-state-cursor-color
))
211 (viper-frame-value viper-vi-state-cursor-color
))))
213 (defun viper-get-saved-cursor-color-in-insert-mode ()
216 (if (featurep 'emacs
) 'frame-parameter
'frame-property
)
218 'viper-saved-cursor-color-in-insert-mode
)
219 (or (and (eq viper-current-state
'emacs-mode
)
220 (viper-frame-value viper-emacs-state-cursor-color
))
221 (viper-frame-value viper-vi-state-cursor-color
))))
223 (defun viper-get-saved-cursor-color-in-emacs-mode ()
226 (if (featurep 'emacs
) 'frame-parameter
'frame-property
)
228 'viper-saved-cursor-color-in-emacs-mode
)
229 (viper-frame-value viper-vi-state-cursor-color
)))
231 ;; restore cursor color from replace overlay
232 (defun viper-restore-cursor-color(after-which-mode)
233 (if (viper-overlay-p viper-replace-overlay
)
234 (viper-change-cursor-color
235 (cond ((eq after-which-mode
'after-replace-mode
)
236 (viper-get-saved-cursor-color-in-replace-mode))
237 ((eq after-which-mode
'after-emacs-mode
)
238 (viper-get-saved-cursor-color-in-emacs-mode))
239 (t (viper-get-saved-cursor-color-in-insert-mode)))
243 ;; Check the current version against the major and minor version numbers
244 ;; using op: cur-vers op major.minor If emacs-major-version or
245 ;; emacs-minor-version are not defined, we assume that the current version
246 ;; is hopelessly outdated. We assume that emacs-major-version and
247 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
248 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
249 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
250 ;; incorrect. However, this gives correct result in our cases, since we are
251 ;; testing for sufficiently high Emacs versions.
252 (defun viper-check-version (op major minor
&optional type-of-emacs
)
253 (if (and (boundp 'emacs-major-version
) (boundp 'emacs-minor-version
))
254 (and (cond ((eq type-of-emacs
'xemacs
) (featurep 'xemacs
))
255 ((eq type-of-emacs
'emacs
) (featurep 'emacs
))
257 (cond ((eq op
'=) (and (= emacs-minor-version minor
)
258 (= emacs-major-version major
)))
259 ((memq op
'(> >= < <=))
260 (and (or (funcall op emacs-major-version major
)
261 (= emacs-major-version major
))
262 (if (= emacs-major-version major
)
263 (funcall op emacs-minor-version minor
)
266 (error "%S: Invalid op in viper-check-version" op
))))
267 (cond ((memq op
'(= > >=)) nil
)
268 ((memq op
'(< <=)) t
))))
271 (defun viper-get-visible-buffer-window (wind)
272 (if (featurep 'xemacs
)
273 (get-buffer-window wind t
)
274 (get-buffer-window wind
'visible
)))
277 ;; Return line position.
278 ;; If pos is 'start then returns position of line start.
279 ;; If pos is 'end, returns line end. If pos is 'mid, returns line center.
280 ;; Pos = 'indent returns beginning of indentation.
281 ;; Otherwise, returns point. Current point is not moved in any case."
282 (defun viper-line-pos (pos)
283 (let ((cur-pos (point))
291 (goto-char (+ (viper-line-pos 'start
) (viper-line-pos 'end
) 2)))
293 (back-to-indentation))
295 (setq result
(point))
299 ;; Emacs used to count each multibyte character as several positions in the buffer,
300 ;; so we had to use Emacs' chars-in-region to count characters. Since 20.3,
301 ;; Emacs counts multibyte characters as 1 position. XEmacs has always been
302 ;; counting each char as just one pos. So, now we can simply subtract beg from
303 ;; end to determine the number of characters in a region.
304 (defun viper-chars-in-region (beg end
&optional preserve-sign
)
305 ;;(let ((count (abs (if (fboundp 'chars-in-region)
306 ;; (chars-in-region beg end)
308 (let ((count (abs (- end beg
))))
309 (if (and (< end beg
) preserve-sign
)
313 ;; Test if POS is between BEG and END
314 (defsubst viper-pos-within-region
(pos beg end
)
315 (and (>= pos
(min beg end
)) (>= (max beg end
) pos
)))
318 ;; Like move-marker but creates a virgin marker if arg isn't already a marker.
319 ;; The first argument must eval to a variable name.
320 ;; Arguments: (var-name position &optional buffer).
322 ;; This is useful for moving markers that are supposed to be local.
323 ;; For this, VAR-NAME should be made buffer-local with nil as a default.
324 ;; Then, each time this var is used in `viper-move-marker-locally' in a new
325 ;; buffer, a new marker will be created.
326 (defun viper-move-marker-locally (var pos
&optional buffer
)
327 (if (markerp (eval var
))
329 (set var
(make-marker)))
330 (move-marker (eval var
) pos buffer
))
333 ;; Print CONDITIONS as a message.
334 (defun viper-message-conditions (conditions)
335 (let ((case (car conditions
)) (msg (cdr conditions
)))
338 (message "%s: %s" case
(mapconcat 'prin1-to-string msg
" ")))
343 ;;; List/alist utilities
345 ;; Convert LIST to an alist
346 (defun viper-list-to-alist (lst)
349 (setq alist
(cons (list (car lst
)) alist
))
350 (setq lst
(cdr lst
)))
353 ;; Convert ALIST to a list.
354 (defun viper-alist-to-list (alst)
357 (setq lst
(cons (car (car alst
)) lst
))
358 (setq alst
(cdr alst
)))
361 ;; Filter ALIST using REGEXP. Return alist whose elements match the regexp.
362 (defun viper-filter-alist (regexp alst
)
364 (let ((outalst) (inalst alst
))
366 (if (string-match regexp
(car (car inalst
)))
367 (setq outalst
(cons (car inalst
) outalst
)))
368 (setq inalst
(cdr inalst
)))
371 ;; Filter LIST using REGEXP. Return list whose elements match the regexp.
372 (defun viper-filter-list (regexp lst
)
374 (let ((outlst) (inlst lst
))
376 (if (string-match regexp
(car inlst
))
377 (setq outlst
(cons (car inlst
) outlst
)))
378 (setq inlst
(cdr inlst
)))
382 ;; Append LIS2 to LIS1, both alists, by side-effect and returns LIS1
383 ;; LIS2 is modified by filtering it: deleting its members of the form
384 ;; \(car elt\) such that (car elt') is in LIS1.
385 (defun viper-append-filter-alist (lis1 lis2
)
388 ;;filter-append the second list
390 ;; delete all occurrences
391 (while (setq elt
(assoc (car (car temp
)) lis2
))
392 (setq lis2
(delq elt lis2
)))
393 (setq temp
(cdr temp
)))
399 (declare-function viper-forward-Word
"viper-cmd" (arg))
401 ;;; Support for :e, :r, :w file globbing
403 ;; Glob the file spec.
404 ;; This function is designed to work under Unix.
405 (defun viper-glob-unix-files (filespec)
407 (cond (ex-unix-type-shell shell-file-name
)
408 (t "sh"))) ; probably Unix anyway
410 ;; using cond in anticipation of further additions
411 (cond (ex-unix-type-shell-options)
413 (command (cond (viper-ms-style-os-p (format "\"ls -1 -d %s\"" filespec
))
414 (t (format "ls -1 -d %s" filespec
))))
416 (with-current-buffer (get-buffer-create viper-ex-tmp-buf-name
)
420 (call-process gshell nil t nil
424 (call-process gshell nil t nil
427 (goto-char (point-min))
428 ;; Issue an error, if no match.
429 (unless (eq 0 status
)
431 (skip-chars-forward " \t\n\j")
432 (if (looking-at "ls:")
433 (viper-forward-Word 1))
438 (buffer-substring (point) (viper-line-pos 'end
)))
440 (goto-char (point-min))
441 (viper-get-filenames-from-buffer 'one-per-line
))
445 ;; Interpret the stuff in the buffer as a list of file names
446 ;; return a list of file names listed in the buffer beginning at point
447 ;; If optional arg is supplied, assume each filename is listed on a separate
449 (defun viper-get-filenames-from-buffer (&optional one-per-line
)
450 (let ((skip-chars (if one-per-line
"\t\n" " \t\n"))
452 (skip-chars-forward skip-chars
)
454 (if (cond ((looking-at "\"")
456 (re-search-forward "[^\"]+" nil t
)) ; noerror
459 (re-search-forward "[^']+" nil t
)) ; noerror
462 (concat "[^" skip-chars
"]+") nil t
))) ;noerror
464 (buffer-substring (match-beginning 0) (match-end 0))))
467 (skip-chars-forward " \t\n")
468 (setq result
(cons fname result
)))
471 ;; convert MS-DOS wildcards to regexp
472 (defun viper-wildcard-to-regexp (wcard)
473 (with-current-buffer (get-buffer-create viper-ex-tmp-buf-name
)
476 (goto-char (point-min))
478 (skip-chars-forward "^*?.\\\\")
479 (cond ((eq (char-after (point)) ?
*) (insert ".")(forward-char 1))
480 ((eq (char-after (point)) ?.
) (insert "\\")(forward-char 1))
481 ((eq (char-after (point)) ?
\\) (insert "\\")(forward-char 1))
482 ((eq (char-after (point)) ??
) (delete-char 1)(insert ".")))
488 ;; glob windows files
489 ;; LIST is expected to be in reverse order
490 (defun viper-glob-mswindows-files (filespec)
491 (let ((case-fold-search t
)
493 (with-current-buffer (get-buffer-create viper-ex-tmp-buf-name
)
496 (goto-char (point-min))
497 (setq tmp
(viper-get-filenames-from-buffer))
499 (setq tmp2
(cons (directory-files
500 ;; the directory part
501 (or (file-name-directory (car tmp
))
503 t
; return full names
504 ;; the regexp part: globs the file names
506 (viper-wildcard-to-regexp
507 (file-name-nondirectory (car tmp
)))
510 (setq tmp
(cdr tmp
)))
511 (reverse (apply 'append tmp2
)))))
516 ;; Rotate RING's index. DIRection can be positive or negative.
517 (defun viper-ring-rotate1 (ring dir
)
518 (if (and (ring-p ring
) (> (ring-length ring
) 0))
520 (setcar ring
(cond ((> dir
0)
521 (ring-plus1 (car ring
) (ring-length ring
)))
523 (ring-minus1 (car ring
) (ring-length ring
)))
524 ;; don't rotate if dir = 0
526 (viper-current-ring-item ring
)
529 (defun viper-special-ring-rotate1 (ring dir
)
530 (if (memq viper-intermediate-command
531 '(repeating-display-destructive-command
532 repeating-insertion-from-ring
))
533 (viper-ring-rotate1 ring dir
)
534 ;; don't rotate otherwise
535 (viper-ring-rotate1 ring
0)))
537 ;; current ring item; if N is given, then so many items back from the
539 (defun viper-current-ring-item (ring &optional n
)
541 (if (and (ring-p ring
) (> (ring-length ring
) 0))
542 (aref (cdr (cdr ring
)) (mod (- (car ring
) 1 n
) (ring-length ring
)))))
544 ;; Push item onto ring. The second argument is a ring-variable, not value.
545 (defun viper-push-onto-ring (item ring-var
)
546 (or (ring-p (eval ring-var
))
547 (set ring-var
(make-ring (eval (intern (format "%S-size" ring-var
))))))
548 (or (null item
) ; don't push nil
549 (and (stringp item
) (string= item
"")) ; or empty strings
550 (equal item
(viper-current-ring-item (eval ring-var
))) ; or old stuff
551 ;; Since viper-set-destructive-command checks if we are inside
552 ;; viper-repeat, we don't check whether this-command-keys is a `.'. The
553 ;; cmd viper-repeat makes a call to the current function only if `.' is
554 ;; executing a command from the command history. It doesn't call the
555 ;; push-onto-ring function if `.' is simply repeating the last
556 ;; destructive command. We only check for ESC (which happens when we do
557 ;; insert with a prefix argument, or if this-command-keys doesn't give
558 ;; anything meaningful (in that case we don't know what to show to the
560 (and (eq ring-var
'viper-command-ring
)
561 (string-match "\\([0-9]*\e\\|^[ \t]*$\\|escape\\)"
562 (viper-array-to-string (this-command-keys))))
563 (viper-ring-insert (eval ring-var
) item
))
567 ;; removing elts from ring seems to break it
568 (defun viper-cleanup-ring (ring)
569 (or (< (ring-length ring
) 2)
570 (null (viper-current-ring-item ring
))
571 ;; last and previous equal
572 (if (equal (viper-current-ring-item ring
)
573 (viper-current-ring-item ring
1))
574 (viper-ring-pop ring
))))
576 ;; ring-remove seems to be buggy, so we concocted this for our purposes.
577 (defun viper-ring-pop (ring)
578 (let* ((ln (ring-length ring
))
579 (vec (cdr (cdr ring
)))
580 (veclen (length vec
))
582 (idx (max 0 (ring-minus1 hd ln
)))
583 (top-elt (aref vec idx
)))
586 (while (< (1+ idx
) veclen
)
587 (aset vec idx
(aref vec
(1+ idx
)))
591 (setq hd
(max 0 (ring-minus1 hd ln
)))
592 (if (= hd
(1- ln
)) (setq hd
0))
593 (setcar ring hd
) ; move head
594 (setcar (cdr ring
) (max 0 (1- ln
))) ; adjust length
598 (defun viper-ring-insert (ring item
)
599 (let* ((ln (ring-length ring
))
600 (vec (cdr (cdr ring
)))
601 (veclen (length vec
))
603 (vecpos-after-hd (if (= hd
0) ln hd
))
608 (aset vec hd item
) ; hd is always 1+ the actual head index in vec
609 (setcar ring
(ring-plus1 hd ln
)))
610 (setcar (cdr ring
) (1+ ln
))
611 (setcar ring
(ring-plus1 vecpos-after-hd
(1+ ln
)))
612 (while (and (>= idx vecpos-after-hd
) (> ln
0))
613 (aset vec idx
(aref vec
(1- idx
)))
615 (aset vec vecpos-after-hd item
))
621 ;; If STRING is longer than MAX-LEN, truncate it and print ...... instead
622 ;; PRE-STRING is a string to prepend to the abbrev string.
623 ;; POST-STRING is a string to append to the abbrev string.
624 ;; ABBREV_SIGN is a string to be inserted before POST-STRING
625 ;; if the orig string was truncated.
626 (defun viper-abbreviate-string (string max-len
627 pre-string post-string abbrev-sign
)
631 (substring string
0 (min max-len
(length string
)))))
632 (cond ((null truncated-str
) "")
633 ((> (length string
) max-len
)
635 pre-string truncated-str abbrev-sign post-string
))
636 (t (format "%s%s%s" pre-string truncated-str post-string
)))))
638 ;; tells if we are over a whitespace-only line
639 (defsubst viper-over-whitespace-line
()
642 (looking-at "^[ \t]*$")))
645 ;;; Saving settings in custom file
647 ;; Save the current setting of VAR in CUSTOM-FILE.
648 ;; If given, MESSAGE is a message to be displayed after that.
649 ;; This message is erased after 2 secs, if erase-msg is non-nil.
650 ;; Arguments: var message custom-file &optional erase-message
651 (defun viper-save-setting (var message custom-file
&optional erase-msg
)
652 (let* ((var-name (symbol-name var
))
653 (var-val (if (boundp var
) (eval var
)))
654 (regexp (format "^[^;]*%s[ \t\n]*[a-zA-Z---_']*[ \t\n)]" var-name
))
655 (buf (find-file-noselect (substitute-in-file-name custom-file
)))
657 (message "%s" (or message
""))
658 (with-current-buffer buf
659 (goto-char (point-min))
660 (if (re-search-forward regexp nil t
)
661 (let ((reg-end (1- (match-end 0))))
662 (search-backward var-name
)
663 (delete-region (match-beginning 0) reg-end
)
664 (goto-char (match-beginning 0))
665 (insert (format "%s '%S" var-name var-val
)))
666 (goto-char (point-max))
667 (if (not (bolp)) (insert "\n"))
668 (insert (format "(setq %s '%S)\n" var-name var-val
)))
677 ;; Save STRING in CUSTOM-FILE. If PATTERN is non-nil, remove strings that
678 ;; match this pattern.
679 (defun viper-save-string-in-file (string custom-file
&optional pattern
)
680 (let ((buf (find-file-noselect (substitute-in-file-name custom-file
))))
681 (with-current-buffer buf
682 (let (buffer-read-only)
683 (goto-char (point-min))
684 (if pattern
(delete-matching-lines pattern
))
685 (goto-char (point-max))
686 (if string
(insert string
))
692 ;; This is a simple-minded check for whether a file is under version control.
693 ;; If file,v exists but file doesn't, this file is considered to be not checked
694 ;; in and not checked out for the purpose of patching (since patch won't be
695 ;; able to read such a file anyway).
696 ;; FILE is a string representing file name
697 ;;(defun viper-file-under-version-control (file)
698 ;; (let* ((filedir (file-name-directory file))
699 ;; (file-nondir (file-name-nondirectory file))
700 ;; (trial (concat file-nondir ",v"))
701 ;; (full-trial (concat filedir trial))
702 ;; (full-rcs-trial (concat filedir "RCS/" trial)))
703 ;; (and (stringp file)
704 ;; (file-exists-p file)
707 ;; (file-exists-p full-trial)
708 ;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
709 ;; ;; don't be fooled by this!
710 ;; (not (equal (file-attributes file)
711 ;; (file-attributes full-trial))))
712 ;; ;; check if a version is in RCS/ directory
713 ;; (file-exists-p full-rcs-trial)))
717 (defsubst viper-file-checked-in-p
(file)
718 (and (featurep 'vc-hooks
)
719 ;; CVS files are considered not checked in
720 ;; FIXME: Should this deal with more than CVS?
721 (not (memq (vc-backend file
) '(nil CVS
)))
722 (if (fboundp 'vc-state
)
724 (not (memq (vc-state file
) '(edited needs-merge
)))
725 (not (stringp (vc-state file
))))
726 ;; XEmacs has no vc-state
727 (if (featurep 'xemacs
) (not (vc-locking-user file
))))))
729 ;; checkout if visited file is checked in
730 (defun viper-maybe-checkout (buf)
731 (let ((file (expand-file-name (buffer-file-name buf
)))
732 (checkout-function (key-binding "\C-x\C-q")))
733 (if (and (viper-file-checked-in-p file
)
737 "File %s is checked in. Check it out? "
738 (viper-abbreviate-file-name file
))))
739 (with-current-buffer buf
740 (command-execute checkout-function
)))))
746 (defun viper-put-on-search-overlay (beg end
)
747 (if (viper-overlay-p viper-search-overlay
)
748 (viper-move-overlay viper-search-overlay beg end
)
749 (setq viper-search-overlay
(viper-make-overlay beg end
(current-buffer)))
751 viper-search-overlay
'priority viper-search-overlay-priority
))
752 (viper-overlay-put viper-search-overlay
'face viper-search-face
))
756 (defun viper-flash-search-pattern ()
757 (if (not (viper-has-face-support-p))
759 (viper-put-on-search-overlay (match-beginning 0) (match-end 0))
761 (viper-overlay-put viper-search-overlay
'face nil
)))
763 (defun viper-hide-search-overlay ()
764 (if (not (viper-overlay-p viper-search-overlay
))
766 (setq viper-search-overlay
767 (viper-make-overlay (point-min) (point-min) (current-buffer)))
769 viper-search-overlay
'priority viper-search-overlay-priority
)))
770 (viper-overlay-put viper-search-overlay
'face nil
))
774 (defsubst viper-move-replace-overlay
(beg end
)
775 (viper-move-overlay viper-replace-overlay beg end
))
777 (defun viper-set-replace-overlay (beg end
)
778 (if (viper-overlay-live-p viper-replace-overlay
)
779 (viper-move-replace-overlay beg end
)
780 (setq viper-replace-overlay
(viper-make-overlay beg end
(current-buffer)))
783 viper-replace-overlay
(if (featurep 'emacs
) 'evaporate
'detachable
) nil
)
785 viper-replace-overlay
'priority viper-replace-overlay-priority
)
786 ;; If Emacs will start supporting overlay maps, as it currently supports
787 ;; text-property maps, we could do away with viper-replace-minor-mode and
788 ;; just have keymap attached to replace overlay.
790 ;; viper-replace-overlay
791 ;; (if (featurep 'xemacs) 'keymap 'local-map)
792 ;; viper-replace-map)
794 (if (viper-has-face-support-p)
796 viper-replace-overlay
'face viper-replace-overlay-face
))
797 (viper-save-cursor-color 'before-replace-mode
)
798 (viper-change-cursor-color
799 (viper-frame-value viper-replace-overlay-cursor-color
)))
802 (defun viper-set-replace-overlay-glyphs (before-glyph after-glyph
)
803 (or (viper-overlay-live-p viper-replace-overlay
)
804 (viper-set-replace-overlay (point-min) (point-min)))
805 (if (or (not (viper-has-face-support-p))
806 viper-use-replace-region-delimiters
)
807 (let ((before-name (if (featurep 'xemacs
) 'begin-glyph
'before-string
))
808 (after-name (if (featurep 'xemacs
) 'end-glyph
'after-string
)))
809 (viper-overlay-put viper-replace-overlay before-name before-glyph
)
810 (viper-overlay-put viper-replace-overlay after-name after-glyph
))))
812 (defun viper-hide-replace-overlay ()
813 (viper-set-replace-overlay-glyphs nil nil
)
814 (viper-restore-cursor-color 'after-replace-mode
)
815 (viper-restore-cursor-color 'after-insert-mode
)
816 (if (viper-has-face-support-p)
817 (viper-overlay-put viper-replace-overlay
'face nil
)))
820 (defsubst viper-replace-start
()
821 (viper-overlay-start viper-replace-overlay
))
822 (defsubst viper-replace-end
()
823 (viper-overlay-end viper-replace-overlay
))
828 (defun viper-set-minibuffer-overlay ()
829 (viper-check-minibuffer-overlay)
830 (when (viper-has-face-support-p)
832 viper-minibuffer-overlay
'face viper-minibuffer-current-face
)
834 viper-minibuffer-overlay
'priority viper-minibuffer-overlay-priority
)
837 viper-minibuffer-overlay
838 (if (featurep 'emacs
) 'evaporate
'detachable
)
840 ;; make viper-minibuffer-overlay open-ended
841 ;; In emacs, it is made open ended at creation time
842 (when (featurep 'xemacs
)
843 (viper-overlay-put viper-minibuffer-overlay
'start-open nil
)
844 (viper-overlay-put viper-minibuffer-overlay
'end-open nil
))))
846 (defun viper-check-minibuffer-overlay ()
847 (if (viper-overlay-live-p viper-minibuffer-overlay
)
849 viper-minibuffer-overlay
850 (if (fboundp 'minibuffer-prompt-end
) (minibuffer-prompt-end) 1)
852 (setq viper-minibuffer-overlay
853 (if (featurep 'xemacs
)
854 (viper-make-overlay 1 (1+ (buffer-size)) (current-buffer))
855 ;; make overlay open-ended
857 (if (fboundp 'minibuffer-prompt-end
) (minibuffer-prompt-end) 1)
859 (current-buffer) nil
'rear-advance
)))))
862 (defsubst viper-is-in-minibuffer
()
864 (string-match "\*Minibuf-" (buffer-name))))
868 ;;; XEmacs compatibility
870 (defun viper-abbreviate-file-name (file)
871 (if (featurep 'xemacs
)
872 (abbreviate-file-name file t
) ; XEmacs requires addl argument
873 (abbreviate-file-name file
)))
875 ;; Sit for VAL milliseconds. XEmacs doesn't support the millisecond arg
876 ;; in sit-for, so this function smoothes out the differences.
877 (defsubst viper-sit-for-short
(val &optional nodisp
)
878 (sit-for (/ val
1000.0) nodisp
))
880 ;; EVENT may be a single event of a sequence of events
881 (defsubst viper-ESC-event-p
(event)
882 (let ((ESC-keys '(?\e
(control \
[) escape
))
883 (key (viper-event-key event
)))
884 (member key ESC-keys
)))
886 ;; checks if object is a marker, has a buffer, and points to within that buffer
887 (defun viper-valid-marker (marker)
888 (if (and (markerp marker
) (marker-buffer marker
))
889 (let ((buf (marker-buffer marker
))
890 (pos (marker-position marker
)))
891 (with-current-buffer buf
892 (and (<= pos
(point-max)) (<= (point-min) pos
))))))
894 (defsubst viper-mark-marker
()
895 (if (featurep 'xemacs
) (mark-marker t
)
898 ;; like (set-mark-command nil) but doesn't push twice, if (car mark-ring)
899 ;; is the same as (mark t).
900 (defsubst viper-set-mark-if-necessary
()
901 (setq mark-ring
(delete (viper-mark-marker) mark-ring
))
902 (set-mark-command nil
)
903 (setq viper-saved-mark
(point)))
905 ;; In transient mark mode (zmacs mode), it is annoying when regions become
906 ;; highlighted due to Viper's pushing marks. So, we deactivate marks, unless
907 ;; the user explicitly wants highlighting, e.g., by hitting '' or ``
908 (defun viper-deactivate-mark ()
909 (if (featurep 'xemacs
)
910 (zmacs-deactivate-region)
913 (defsubst viper-leave-region-active
()
914 (if (featurep 'xemacs
) (setq zmacs-region-stays t
)))
916 ;; Check if arg is a valid character for register
917 ;; TYPE is a list that can contain `letter', `Letter', and `digit'.
918 ;; Letter means lowercase letters, Letter means uppercase letters, and
919 ;; digit means digits from 1 to 9.
920 ;; If TYPE is nil, then down/uppercase letters and digits are allowed.
921 (defun viper-valid-register (reg &optional type
)
922 (or type
(setq type
'(letter Letter digit
)))
923 (or (if (memq 'letter type
)
924 (and (<= ?a reg
) (<= reg ?z
)))
925 (if (memq 'digit type
)
926 (and (<= ?
1 reg
) (<= reg ?
9)))
927 (if (memq 'Letter type
)
928 (and (<= ?A reg
) (<= reg ?Z
)))
933 ;; it is suggested that an event must be copied before it is assigned to
934 ;; last-command-event in XEmacs
935 (defun viper-copy-event (event)
936 (if (featurep 'xemacs
) (copy-event event
)
939 ;; Uses different timeouts for ESC-sequences and others
940 (defun viper-fast-keysequence-p ()
941 (not (viper-sit-for-short
942 (if (viper-ESC-event-p last-input-event
)
943 (viper-ESC-keyseq-timeout)
944 viper-fast-keyseq-timeout
)
947 ;; like read-event, but in XEmacs also try to convert to char, if possible
948 (defun viper-read-event-convert-to-char ()
950 (if (featurep 'xemacs
)
952 (setq event
(next-command-event))
953 (or (event-to-character event
)
957 ;; Viperized read-key-sequence
958 (defun viper-read-key-sequence (prompt &optional continue-echo
)
959 (let (inhibit-quit event keyseq
)
960 (setq keyseq
(read-key-sequence prompt continue-echo
))
961 (setq event
(if (featurep 'xemacs
)
962 (elt keyseq
0) ; XEmacs returns vector of events
963 (elt (listify-key-sequence keyseq
) 0)))
964 (if (viper-ESC-event-p event
)
965 (let (unread-command-events)
966 (if (viper-fast-keysequence-p)
967 (let ((viper-vi-global-user-minor-mode nil
)
968 (viper-vi-local-user-minor-mode nil
)
969 (viper-vi-intercept-minor-mode nil
)
970 (viper-insert-intercept-minor-mode nil
)
971 (viper-replace-minor-mode nil
) ; actually unnecessary
972 (viper-insert-global-user-minor-mode nil
)
973 (viper-insert-local-user-minor-mode nil
))
974 ;; Note: set unread-command-events only after testing for fast
975 ;; keysequence. Otherwise, viper-fast-keysequence-p will be
976 ;; always t -- whether there is anything after ESC or not
977 (viper-set-unread-command-events keyseq
)
978 (setq keyseq
(read-key-sequence nil
)))
979 (viper-set-unread-command-events keyseq
)
980 (setq keyseq
(read-key-sequence nil
)))))
984 ;; This function lets function-key-map convert key sequences into logical
985 ;; keys. This does a better job than viper-read-event when it comes to kbd
986 ;; macros, since it enables certain macros to be shared between X and TTY modes
987 ;; by correctly mapping key sequences for Left/Right/... (on an ascii
988 ;; terminal) into logical keys left, right, etc.
989 (defun viper-read-key ()
990 (let ((overriding-local-map viper-overriding-map
)
993 (use-global-map viper-overriding-map
)
995 (setq key
(elt (viper-read-key-sequence nil
) 0))
996 (use-global-map global-map
))
1000 ;; Emacs has a bug in eventp, which causes (eventp nil) to return (nil)
1001 ;; instead of nil, if '(nil) was previously inadvertently assigned to
1002 ;; unread-command-events
1003 (defun viper-event-key (event)
1004 (or (and event
(eventp event
))
1005 (error "viper-event-key: Wrong type argument, eventp, %S" event
))
1006 (when (if (featurep 'xemacs
)
1007 (or (key-press-event-p event
) (mouse-event-p event
)) ; xemacs
1010 (let ((mod (event-modifiers event
))
1013 (if (featurep 'xemacs
)
1015 (cond ((key-press-event-p event
)
1017 ((button-event-p event
)
1018 (concat "mouse-" (prin1-to-string (event-button event
))))
1020 (error "viper-event-key: Unknown event, %S" event
)))
1021 ;; Emacs doesn't handle capital letters correctly, since
1022 ;; \S-a isn't considered the same as A (it behaves as
1023 ;; plain `a' instead). So we take care of this here
1024 (cond ((and (viper-characterp event
) (<= ?A event
) (<= event ?Z
))
1027 ;; Emacs has the oddity whereby characters 128+char
1028 ;; represent M-char *if* this appears inside a string.
1029 ;; So, we convert them manually to (meta char).
1030 ((and (viper-characterp event
)
1031 (< ?\C-? event
) (<= event
255))
1033 event
(- event ?\C-?
1)))
1034 ((and (null mod
) (eq event
'return
))
1036 ((and (null mod
) (eq event
'space
))
1038 ((and (null mod
) (eq event
'delete
))
1040 ((and (null mod
) (eq event
'backspace
))
1042 (t (event-basic-type event
)))
1043 ) ; (featurep 'xemacs)
1045 (if (viper-characterp basis
)
1047 (if (viper= basis ?\C-?
)
1048 (list 'control
'\?) ; taking care of an emacs bug
1049 (intern (char-to-string basis
)))))
1051 (append mod
(list basis
))
1054 (defun viper-last-command-char ()
1055 (if (featurep 'xemacs
)
1056 (event-to-character last-command-event
)
1057 last-command-event
))
1059 (defun viper-key-to-emacs-key (key)
1060 (let (key-name char-p modifiers mod-char-list base-key base-key-name
)
1061 (cond ((featurep 'xemacs
) key
)
1064 (setq key-name
(symbol-name key
))
1065 (cond ((= (length key-name
) 1) ; character event
1066 (string-to-char key-name
))
1067 ;; Emacs doesn't recognize `return' and `escape' as events on
1068 ;; dumb terminals, so we translate them into characters
1069 ((and (featurep 'emacs
) (not (viper-window-display-p))
1070 (string= key-name
"return"))
1072 ((and (featurep 'emacs
) (not (viper-window-display-p))
1073 (string= key-name
"escape"))
1075 ;; pass symbol-event as is
1079 (setq modifiers
(viper-subseq key
0 (1- (length key
)))
1080 base-key
(viper-seq-last-elt key
)
1081 base-key-name
(symbol-name base-key
)
1082 char-p
(= (length base-key-name
) 1))
1085 '(lambda (elt) (upcase (substring (symbol-name elt
) 0 1)))
1089 (car (read-from-string
1092 (mapconcat 'identity mod-char-list
"-\\")
1098 (mapconcat 'identity mod-char-list
"-")
1104 ;; LIS is assumed to be a list of events of characters
1105 (defun viper-eventify-list-xemacs (lis)
1106 (if (featurep 'xemacs
)
1109 (cond ((viper-characterp elt
) (character-to-event elt
))
1112 "viper-eventify-list-xemacs: can't convert to event, %S"
1117 ;; Smoothes out the difference between Emacs' unread-command-events
1118 ;; and XEmacs unread-command-event. Arg is a character, an event, a list of
1119 ;; events or a sequence of keys.
1121 ;; Due to the way unread-command-events in Emacs (not XEmacs), a non-event
1122 ;; symbol in unread-command-events list may cause Emacs to turn this symbol
1123 ;; into an event. Below, we delete nil from event lists, since nil is the most
1124 ;; common symbol that might appear in this wrong context.
1125 (defun viper-set-unread-command-events (arg)
1126 (if (featurep 'emacs
)
1128 unread-command-events
1130 (cond ((eventp arg
) (list arg
))
1133 (listify-key-sequence arg
))
1135 "viper-set-unread-command-events: Invalid argument, %S"
1137 (if (not (eventp nil
))
1138 (setq new-events
(delq nil new-events
)))
1139 (append new-events unread-command-events
)))
1142 unread-command-events
1144 (cond ((viper-characterp arg
) (list (character-to-event arg
)))
1145 ((eventp arg
) (list arg
))
1146 ((stringp arg
) (mapcar 'character-to-event arg
))
1147 ((vectorp arg
) (append arg nil
)) ; turn into list
1148 ((listp arg
) (viper-eventify-list-xemacs arg
))
1150 "viper-set-unread-command-events: Invalid argument, %S" arg
)))
1151 unread-command-events
))))
1154 ;; Check if vec is a vector of key-press events representing characters
1156 (defun viper-event-vector-p (vec)
1158 (eval (cons 'and
(mapcar '(lambda (elt) (if (eventp elt
) t
)) vec
)))))
1161 ;; check if vec is a vector of character symbols
1162 (defun viper-char-symbol-sequence-p (vec)
1167 (mapcar (lambda (elt)
1168 (and (symbolp elt
) (= (length (symbol-name elt
)) 1)))
1172 (defun viper-char-array-p (array)
1173 (eval (cons 'and
(mapcar 'viper-characterp array
))))
1176 ;; Args can be a sequence of events, a string, or a Viper macro. Will try to
1177 ;; convert events to keys and, if all keys are regular printable
1178 ;; characters, will return a string. Otherwise, will return a string
1179 ;; representing a vector of converted events. If the input was a Viper macro,
1180 ;; will return a string that represents this macro as a vector.
1181 (defun viper-array-to-string (event-seq)
1183 (cond ((stringp event-seq
) event-seq
)
1184 ((viper-event-vector-p event-seq
)
1185 (setq temp
(mapcar 'viper-event-key event-seq
))
1186 (cond ((viper-char-symbol-sequence-p temp
)
1187 (mapconcat 'symbol-name temp
""))
1188 ((and (viper-char-array-p
1189 (setq temp2
(mapcar 'viper-key-to-character temp
))))
1190 (mapconcat 'char-to-string temp2
""))
1191 (t (prin1-to-string (vconcat temp
)))))
1192 ((viper-char-symbol-sequence-p event-seq
)
1193 (mapconcat 'symbol-name event-seq
""))
1194 ((and (vectorp event-seq
)
1196 (setq temp
(mapcar 'viper-key-to-character event-seq
))))
1197 (mapconcat 'char-to-string temp
""))
1198 (t (prin1-to-string event-seq
)))))
1200 (defun viper-key-press-events-to-chars (events)
1201 (mapconcat (if (featurep 'xemacs
)
1202 (lambda (elt) (char-to-string (event-to-character elt
))) ; xemacs
1203 'char-to-string
; emacs
1209 (defun viper-read-char-exclusive ()
1211 (echo-keystrokes 1))
1214 (setq char
(read-char))
1216 ;; skip event if not char
1217 (viper-read-event))))
1220 ;; key is supposed to be in viper's representation, e.g., (control l), a
1222 (defun viper-key-to-character (key)
1223 (cond ((eq key
'space
) ?\
)
1224 ((eq key
'delete
) ?\C-?
)
1225 ((eq key
'return
) ?\C-m
)
1226 ((eq key
'backspace
) ?\C-h
)
1228 (= 1 (length (symbol-name key
))))
1229 (string-to-char (symbol-name key
)))
1231 (eq (car key
) 'control
)
1232 (symbol-name (nth 1 key
))
1233 (= 1 (length (symbol-name (nth 1 key
)))))
1234 (read (format "?\\C-%s" (symbol-name (nth 1 key
)))))
1238 (defun viper-setup-master-buffer (&rest other-files-or-buffers
)
1239 "Set up the current buffer as a master buffer.
1240 Arguments become related buffers. This function should normally be used in
1241 the `Local variables' section of a file."
1242 (setq viper-related-files-and-buffers-ring
1243 (make-ring (1+ (length other-files-or-buffers
))))
1244 (mapc '(lambda (elt)
1245 (viper-ring-insert viper-related-files-and-buffers-ring elt
))
1246 other-files-or-buffers
)
1247 (viper-ring-insert viper-related-files-and-buffers-ring
(buffer-name))
1250 ;;; Movement utilities
1252 ;; Characters that should not be considered as part of the word, in reformed-vi
1254 ;; Note: \\ (quoted \) must appear before `-' because this string is listified
1255 ;; into characters at some point and then put back to string. The result is
1256 ;; used in skip-chars-forward, which treats - specially. Here we achieve the
1257 ;; effect of quoting - and preventing it from being special.
1258 (defconst viper-non-word-characters-reformed-vi
1259 "!@#$%^&*()\\-+=|\\~`{}[];:'\",<.>/?")
1260 ;; These are characters that are not to be considered as parts of a word in
1262 ;; Set each time state changes and at loading time
1263 (viper-deflocalvar viper-non-word-characters nil
)
1265 ;; must be buffer-local
1266 (viper-deflocalvar viper-ALPHA-char-class
"w"
1267 "String of syntax classes characterizing Viper's alphanumeric symbols.
1268 In addition, the symbol `_' may be considered alphanumeric if
1269 `viper-syntax-preference' is `strict-vi' or `reformed-vi'.")
1271 (defconst viper-strict-ALPHA-chars
"a-zA-Z0-9_"
1272 "Regexp matching the set of alphanumeric characters acceptable to strict
1274 (defconst viper-strict-SEP-chars
" \t\n"
1275 "Regexp matching the set of alphanumeric characters acceptable to strict
1277 (defconst viper-strict-SEP-chars-sans-newline
" \t"
1278 "Regexp matching the set of alphanumeric characters acceptable to strict
1281 (defconst viper-SEP-char-class
" -"
1282 "String of syntax classes for Vi separators.
1283 Usually contains ` ', linefeed, TAB or formfeed.")
1286 ;; Set Viper syntax classes and related variables according to
1287 ;; `viper-syntax-preference'.
1288 (defun viper-update-syntax-classes (&optional set-default
)
1289 (let ((preference (cond ((eq viper-syntax-preference
'emacs
)
1290 "w") ; Viper words have only Emacs word chars
1291 ((eq viper-syntax-preference
'extended
)
1292 "w_") ; Viper words have Emacs word & symbol chars
1293 (t "w"))) ; Viper words are Emacs words plus `_'
1294 (non-word-chars (cond ((eq viper-syntax-preference
'reformed-vi
)
1295 (viper-string-to-list
1296 viper-non-word-characters-reformed-vi
))
1299 (setq-default viper-ALPHA-char-class preference
1300 viper-non-word-characters non-word-chars
)
1301 (setq viper-ALPHA-char-class preference
1302 viper-non-word-characters non-word-chars
))
1305 ;; SYMBOL is used because customize requires it, but it is ignored, unless it
1306 ;; is `nil'. If nil, use setq.
1307 (defun viper-set-syntax-preference (&optional symbol value
)
1308 "Set Viper syntax preference.
1309 If called interactively or if SYMBOL is nil, sets syntax preference in current
1310 buffer. If called non-interactively, preferably via the customization widget,
1311 sets the default value."
1316 "Viper syntax preference: "
1317 '(("strict-vi") ("reformed-vi") ("extended") ("emacs"))
1318 nil
'require-match
)))
1319 (if (stringp value
) (setq value
(intern value
)))
1320 (or (memq value
'(strict-vi reformed-vi extended emacs
))
1321 (error "Invalid Viper syntax preference, %S" value
))
1323 (setq-default viper-syntax-preference value
)
1324 (setq viper-syntax-preference value
))
1325 (viper-update-syntax-classes))
1327 (defcustom viper-syntax-preference
'reformed-vi
1328 "*Syntax type characterizing Viper's alphanumeric symbols.
1329 Affects movement and change commands that deal with Vi-style words.
1330 Works best when set in the hooks to various major modes.
1332 `strict-vi' means Viper words are (hopefully) exactly as in Vi.
1334 `reformed-vi' means Viper words are like Emacs words \(as determined using
1335 Emacs syntax tables, which are different for different major modes\) with two
1336 exceptions: the symbol `_' is always part of a word and typical Vi non-word
1337 symbols, such as `,',:,\",),{, etc., are excluded.
1338 This behaves very close to `strict-vi', but also works well with non-ASCII
1339 characters from various alphabets.
1341 `extended' means Viper word constituents are symbols that are marked as being
1342 parts of words OR symbols in Emacs syntax tables.
1343 This is most appropriate for major modes intended for editing programs.
1345 `emacs' means Viper words are the same as Emacs words as specified by Emacs
1347 This option is appropriate if you like Emacs-style words."
1348 :type
'(radio (const strict-vi
) (const reformed-vi
)
1349 (const extended
) (const emacs
))
1350 :set
'viper-set-syntax-preference
1352 (make-variable-buffer-local 'viper-syntax-preference
)
1355 ;; addl-chars are characters to be temporarily considered as alphanumerical
1356 (defun viper-looking-at-alpha (&optional addl-chars
)
1357 (or (stringp addl-chars
) (setq addl-chars
""))
1358 (if (eq viper-syntax-preference
'reformed-vi
)
1359 (setq addl-chars
(concat addl-chars
"_")))
1360 (let ((char (char-after (point))))
1362 (if (eq viper-syntax-preference
'strict-vi
)
1363 (looking-at (concat "[" viper-strict-ALPHA-chars addl-chars
"]"))
1365 ;; or one of the additional chars being asked to include
1366 (viper-memq-char char
(viper-string-to-list addl-chars
))
1368 ;; not one of the excluded word chars (note:
1369 ;; viper-non-word-characters is a list)
1370 (not (viper-memq-char char viper-non-word-characters
))
1371 ;; char of the Viper-word syntax class
1372 (viper-memq-char (char-syntax char
)
1373 (viper-string-to-list viper-ALPHA-char-class
))))))
1376 (defun viper-looking-at-separator ()
1377 (let ((char (char-after (point))))
1379 (if (eq viper-syntax-preference
'strict-vi
)
1380 (viper-memq-char char
(viper-string-to-list viper-strict-SEP-chars
))
1381 (or (eq char ?
\n) ; RET is always a separator in Vi
1382 (viper-memq-char (char-syntax char
)
1383 (viper-string-to-list viper-SEP-char-class
)))))
1386 (defsubst viper-looking-at-alphasep
(&optional addl-chars
)
1387 (or (viper-looking-at-separator) (viper-looking-at-alpha addl-chars
)))
1389 (defun viper-skip-alpha-forward (&optional addl-chars
)
1390 (or (stringp addl-chars
) (setq addl-chars
""))
1393 (cond ((eq viper-syntax-preference
'strict-vi
)
1395 (t viper-ALPHA-char-class
))
1396 (cond ((eq viper-syntax-preference
'strict-vi
)
1397 (concat viper-strict-ALPHA-chars addl-chars
))
1400 (defun viper-skip-alpha-backward (&optional addl-chars
)
1401 (or (stringp addl-chars
) (setq addl-chars
""))
1404 (cond ((eq viper-syntax-preference
'strict-vi
)
1406 (t viper-ALPHA-char-class
))
1407 (cond ((eq viper-syntax-preference
'strict-vi
)
1408 (concat viper-strict-ALPHA-chars addl-chars
))
1411 ;; weird syntax tables may confuse strict-vi style
1412 (defsubst viper-skip-all-separators-forward
(&optional within-line
)
1413 (if (eq viper-syntax-preference
'strict-vi
)
1415 (skip-chars-forward viper-strict-SEP-chars-sans-newline
)
1416 (skip-chars-forward viper-strict-SEP-chars
))
1417 (viper-skip-syntax 'forward
1418 viper-SEP-char-class
1419 (or within-line
"\n")
1420 (if within-line
(viper-line-pos 'end
)))))
1422 (defsubst viper-skip-all-separators-backward
(&optional within-line
)
1423 (if (eq viper-syntax-preference
'strict-vi
)
1425 (skip-chars-backward viper-strict-SEP-chars-sans-newline
)
1426 (skip-chars-backward viper-strict-SEP-chars
))
1427 (viper-skip-syntax 'backward
1428 viper-SEP-char-class
1429 (or within-line
"\n")
1430 (if within-line
(viper-line-pos 'start
)))))
1431 (defun viper-skip-nonseparators (direction)
1434 (concat "^" viper-SEP-char-class
)
1436 (viper-line-pos (if (eq direction
'forward
) 'end
'start
))))
1439 ;; skip over non-word constituents and non-separators
1440 (defun viper-skip-nonalphasep-forward ()
1441 (if (eq viper-syntax-preference
'strict-vi
)
1443 (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars
))
1446 (concat "^" viper-ALPHA-char-class viper-SEP-char-class
)
1447 ;; Emacs may consider some of these as words, but we don't want them
1448 viper-non-word-characters
1449 (viper-line-pos 'end
))))
1451 (defun viper-skip-nonalphasep-backward ()
1452 (if (eq viper-syntax-preference
'strict-vi
)
1453 (skip-chars-backward
1454 (concat "^" viper-strict-SEP-chars viper-strict-ALPHA-chars
))
1457 (concat "^" viper-ALPHA-char-class viper-SEP-char-class
)
1458 ;; Emacs may consider some of these as words, but we don't want them
1459 viper-non-word-characters
1460 (viper-line-pos 'start
))))
1462 ;; Skip SYNTAX like skip-syntax-* and ADDL-CHARS like skip-chars-*
1463 ;; Return the number of chars traveled.
1464 ;; Both SYNTAX or ADDL-CHARS can be strings or lists of characters.
1465 ;; When SYNTAX is "w", then viper-non-word-characters are not considered to be
1466 ;; words, even if Emacs syntax table says they are.
1467 (defun viper-skip-syntax (direction syntax addl-chars
&optional limit
)
1471 (if (eq direction
'forward
)
1472 'skip-chars-forward
'skip-chars-backward
))
1474 (if (eq direction
'forward
)
1475 'viper-forward-char-carefully
'viper-backward-char-carefully
))
1476 char-looked-at syntax-of-char-looked-at negated-syntax
)
1478 (cond ((listp addl-chars
) (viper-charlist-to-string addl-chars
))
1479 ((stringp addl-chars
) addl-chars
)
1482 (cond ((listp syntax
) syntax
)
1483 ((stringp syntax
) (viper-string-to-list syntax
))
1485 (if (memq ?^ syntax
) (setq negated-syntax t
))
1487 (while (and (not (= local
0))
1488 (cond ((eq direction
'forward
)
1491 (setq char-looked-at
(viper-char-at-pos direction
)
1492 ;; if outside the range, set to nil
1493 syntax-of-char-looked-at
(if char-looked-at
1494 (char-syntax char-looked-at
)))
1497 (cond ((and limit
(eq direction
'forward
))
1499 (limit ; backward & limit
1502 ;; char under/before cursor has appropriate syntax
1504 (not (memq syntax-of-char-looked-at syntax
))
1505 (memq syntax-of-char-looked-at syntax
))
1506 ;; if char-syntax class is "word", make sure it is not one
1507 ;; of the excluded characters
1508 (if (and (eq syntax-of-char-looked-at ?w
)
1509 (not negated-syntax
))
1510 (not (viper-memq-char
1511 char-looked-at viper-non-word-characters
))
1513 (funcall skip-syntax-func
1)
1515 (funcall skip-chars-func addl-chars limit
)))
1516 (setq total
(+ total local
)))
1520 ;; tells when point is at the beginning of field
1521 (defun viper-beginning-of-field ()
1523 (not (eq (get-char-property (point) 'field
)
1524 (get-char-property (1- (point)) 'field
)))))
1527 ;; this is copied from cl-extra.el
1528 ;; Return the subsequence of SEQ from START to END.
1529 ;; If END is omitted, it defaults to the length of the sequence.
1530 ;; If START or END is negative, it counts from the end.
1531 (defun viper-subseq (seq start
&optional end
)
1532 (if (stringp seq
) (substring seq start end
)
1534 (and end
(< end
0) (setq end
(+ end
(setq len
(length seq
)))))
1535 (if (< start
0) (setq start
(+ start
(or len
(setq len
(length seq
))))))
1537 (if (> start
0) (setq seq
(nthcdr start seq
)))
1540 (while (>= (setq end
(1- end
)) start
)
1541 (push (pop seq
) res
))
1543 (copy-sequence seq
)))
1545 (or end
(setq end
(or len
(length seq
))))
1546 (let ((res (make-vector (max (- end start
) 0) nil
))
1548 (while (< start end
)
1549 (aset res i
(aref seq start
))
1550 (setq i
(1+ i
) start
(1+ start
)))
1556 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1559 ;;; viper-util.el ends here