1 ;;; viper-mous.el --- mouse support for Viper
3 ;; Copyright (C) 1994, 95, 96, 97, 2001, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.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.
31 (defvar double-click-time)
32 (defvar mouse-track-multi-click-time)
33 (defvar viper-search-start-marker)
34 (defvar viper-local-search-start-marker)
35 (defvar viper-search-history)
36 (defvar viper-s-string)
37 (defvar viper-re-search)
39 ;; loading happens only in non-interactive compilation
40 ;; in order to spare non-viperized emacs from being viperized
43 (let ((load-path (cons (expand-file-name ".") load-path)))
44 (or (featurep 'viper-util)
45 (load "viper-util.el" nil nil 'nosuffix))
46 (or (featurep 'viper-cmd)
47 (load "viper-cmd.el" nil nil 'nosuffix))
54 (defgroup viper-mouse nil
55 "Support for Viper special mouse-bound commands"
62 ;; Variable used for catching the switch-frame event.
63 ;; If non-nil, indicates that previous-frame should be the selected
64 ;; one. Used by viper-mouse-click-get-word. Not a user option.
65 (defvar viper-frame-of-focus nil)
67 ;; Frame that was selected before the switch-frame event.
68 (defconst viper-current-frame-saved (selected-frame))
70 (defcustom viper-surrounding-word-function 'viper-surrounding-word
71 "*Function that determines what constitutes a word for clicking events.
72 Takes two parameters: a COUNT, indicating how many words to return,
73 and CLICK-COUNT, telling whether this is the first click, a double-click,
78 ;; time interval in millisecond within which successive clicks are
80 (defcustom viper-multiclick-timeout (if (viper-window-display-p)
82 mouse-track-multi-click-time
85 "*Time interval in millisecond within which successive mouse clicks are
90 ;; current event click count; XEmacs only
91 (defvar viper-current-click-count 0)
92 ;; time stamp of the last click event; XEmacs only
93 (defvar viper-last-click-event-timestamp 0)
95 ;; Local variable used to toggle wraparound search on click.
96 (viper-deflocalvar viper-mouse-click-search-noerror t)
98 ;; Local variable used to delimit search after wraparound.
99 (viper-deflocalvar viper-mouse-click-search-limit nil)
101 ;; remembers prefix argument to pass along to commands invoked by second
103 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
104 ;; causes Emacs to count the second click as if it was a single click
105 (defvar viper-global-prefix-argument nil)
108 ;; same keys, but parsed
109 (defvar viper-mouse-up-search-key-parsed nil)
110 (defvar viper-mouse-down-search-key-parsed nil)
111 (defvar viper-mouse-up-insert-key-parsed nil)
112 (defvar viper-mouse-down-insert-key-parsed nil)
119 (defsubst viper-multiclick-p ()
120 (not (viper-sit-for-short viper-multiclick-timeout t)))
122 ;; Returns window where click occurs
123 (defun viper-mouse-click-window (click)
124 (let ((win (viper-cond-compile-for-xemacs-or-emacs
125 (event-window click) ; xemacs
126 (posn-window (event-start click)) ; emacs
128 (if (window-live-p win)
130 (error "Click was not over a live window"))))
132 ;; Returns window where click occurs
133 (defsubst viper-mouse-click-frame (click)
134 (window-frame (viper-mouse-click-window click)))
136 ;; Returns the buffer of the window where click occurs
137 (defsubst viper-mouse-click-window-buffer (click)
138 (window-buffer (viper-mouse-click-window click)))
140 ;; Returns the name of the buffer in the window where click occurs
141 (defsubst viper-mouse-click-window-buffer-name (click)
142 (buffer-name (viper-mouse-click-window-buffer click)))
144 ;; Returns position of a click
145 (defsubst viper-mouse-click-posn (click)
146 (viper-cond-compile-for-xemacs-or-emacs
147 (event-point click) ; xemacs
148 (posn-point (event-start click)) ; emacs
152 (defun viper-surrounding-word (count click-count)
153 "Returns word surrounding point according to a heuristic.
154 COUNT indicates how many regions to return.
155 If CLICK-COUNT is 1, `word' is a word in Vi sense.
156 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
157 If the character clicked on is a non-separator and is non-alphanumeric but
158 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
159 for the purpose of this command. If this character has a matching
160 character, such as `\(' is a match for `\)', then the matching character is
161 also considered alphanumeric.
162 For convenience, in Lisp modes, `-' is considered alphanumeric.
164 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
165 trailing space and tabs removed. In that case, the first argument, COUNT,
167 (let ((modifiers "_")
170 (if (> click-count 2)
173 (viper-skip-all-separators-forward 'within-line)
176 (setq result (buffer-substring beg (point))))
178 (if (and (not (viper-looking-at-alphasep))
179 (or (save-excursion (viper-backward-char-carefully)
180 (viper-looking-at-alpha))
181 (save-excursion (viper-forward-char-carefully)
182 (viper-looking-at-alpha))))
185 (cond ((looking-at "\\\\") "\\\\")
186 ((looking-at "-") "C-C-")
187 ((looking-at "[][]") "][")
188 ((looking-at "[()]") ")(")
189 ((looking-at "[{}]") "{}")
190 ((looking-at "[<>]") "<>")
191 ((looking-at "[`']") "`'")
192 ((looking-at "\\^") "\\^")
193 ((viper-looking-at-separator) "")
194 (t (char-to-string (following-char))))
198 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
200 (not (string-match "lisp" (symbol-name major-mode)))
201 (setq modifiers (concat modifiers "C-C-")))
205 (cond ((> click-count 1) (viper-skip-nonseparators 'backward))
206 ((viper-looking-at-alpha modifiers)
207 (viper-skip-alpha-backward modifiers))
208 ((not (viper-looking-at-alphasep modifiers))
209 (viper-skip-nonalphasep-backward))
210 (t (if (> click-count 1)
211 (viper-skip-nonseparators 'backward)
212 (viper-skip-alpha-backward modifiers))))
214 (setq word-beg (point))
216 (setq skip-flag nil) ; don't move 1 char forw the first time
218 (if skip-flag (viper-forward-char-carefully 1))
219 (setq skip-flag t) ; now always move 1 char forward
220 (if (> click-count 1)
221 (viper-skip-nonseparators 'forward)
222 (viper-skip-alpha-forward modifiers))
223 (setq count (1- count)))
225 (setq result (buffer-substring word-beg (point))))
227 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
228 ;; doesn't return properties together with the string, so it's not needed.
230 (set-text-properties 0 (length result) nil result))
235 (defun viper-mouse-click-get-word (click count click-count)
236 "Returns word surrounding the position of a mouse click.
237 Click may be in another window. Current window and buffer isn't changed.
238 On single or double click, returns the word as determined by
239 `viper-surrounding-word-function'."
241 (let ((click-word "")
242 (click-pos (viper-mouse-click-posn click))
243 (click-buf (viper-mouse-click-window-buffer click)))
244 (or (natnump count) (setq count 1))
245 (or (natnump click-count) (setq click-count 1))
248 (save-window-excursion
251 (set-buffer click-buf)
253 (goto-char click-pos)
255 (funcall viper-surrounding-word-function count click-count)))
256 (error "Click must be over a window"))
260 (defun viper-mouse-click-insert-word (click arg)
261 "Insert word clicked or double-clicked on.
262 With prefix argument, N, insert that many words.
263 This command must be bound to a mouse click.
264 The double-click action of the same mouse button must not be bound
265 \(or it must be bound to the same function\).
266 See `viper-surrounding-word' for the definition of a word in this case."
268 (if viper-frame-of-focus ;; to handle clicks in another frame
269 (select-frame viper-frame-of-focus))
271 (or (not (eq (key-binding viper-mouse-down-insert-key-parsed)
272 'viper-mouse-catch-frame-switch))
273 (not (eq (key-binding viper-mouse-up-insert-key-parsed)
274 'viper-mouse-click-insert-word))
275 (and viper-xemacs-p (not (event-over-text-area-p click)))))
276 () ; do nothing, if binding isn't right or not over text
277 ;; turn arg into a number
278 (cond ((integerp arg) nil)
279 ;; prefix arg is a list when one hits C-u then command
280 ((and (listp arg) (integerp (car arg)))
281 (setq arg (car arg)))
284 (if (not (eq (key-binding viper-mouse-down-insert-key-parsed)
285 'viper-mouse-catch-frame-switch))
287 (let (click-count interrupting-event)
290 ;; This trick checks if there is a pending mouse event if so, we
291 ;; use this latter event and discard the current mouse click If
292 ;; the next pending event is not a mouse event, we execute the
293 ;; current mouse event
295 (setq interrupting-event (viper-read-event))
296 (viper-mouse-event-p last-input-event)))
297 (progn ; interrupted wait
298 (setq viper-global-prefix-argument arg)
299 ;; count this click for XEmacs
300 (viper-event-click-count click))
301 ;; uninterrupted wait or the interrupting event wasn't a mouse event
302 (setq click-count (viper-event-click-count click))
303 (if (> click-count 1)
304 (setq arg viper-global-prefix-argument
305 viper-global-prefix-argument nil))
306 (insert (viper-mouse-click-get-word click arg click-count))
307 (if (and interrupting-event
308 (eventp interrupting-event)
309 (not (viper-mouse-event-p interrupting-event)))
310 (viper-set-unread-command-events interrupting-event))
313 ;; Arg is an event. Accepts symbols and numbers, too
314 (defun viper-mouse-event-p (event)
316 (string-match "\\(mouse-\\|frame\\|screen\\|track\\)"
317 (prin1-to-string (viper-event-key event)))))
319 ;; XEmacs has no double-click events. So, we must simulate.
320 ;; So, we have to simulate event-click-count.
321 (defun viper-event-click-count (click)
322 (viper-cond-compile-for-xemacs-or-emacs
323 (viper-event-click-count-xemacs click) ; xemacs
324 (event-click-count click) ; emacs
327 ;; kind of semaphore for updating viper-current-click-count
328 (defvar viper-counting-clicks-p nil)
329 (viper-cond-compile-for-xemacs-or-emacs
330 (defun viper-event-click-count-xemacs (click)
331 (let ((time-delta (- (event-timestamp click)
332 viper-last-click-event-timestamp))
334 (while viper-counting-clicks-p
336 (setq viper-counting-clicks-p t)
337 (if (> time-delta viper-multiclick-timeout)
338 (setq viper-current-click-count 0))
340 (setq viper-current-click-count (1+ viper-current-click-count)
341 viper-last-click-event-timestamp (event-timestamp click))
342 (setq viper-counting-clicks-p nil)
343 (if (viper-sit-for-short viper-multiclick-timeout t)
344 viper-current-click-count
351 (defun viper-mouse-click-search-word (click arg)
352 "Find the word clicked or double-clicked on. Word may be in another window.
353 With prefix argument, N, search for N-th occurrence.
354 This command must be bound to a mouse click. The double-click action of the
355 same button must not be bound \(or it must be bound to the same function\).
356 See `viper-surrounding-word' for the details on what constitutes a word for
359 (if viper-frame-of-focus ;; to handle clicks in another frame
360 (select-frame viper-frame-of-focus))
362 (or (not (eq (key-binding viper-mouse-down-search-key-parsed)
363 'viper-mouse-catch-frame-switch))
364 (not (eq (key-binding viper-mouse-up-search-key-parsed)
365 'viper-mouse-click-search-word))
366 (and viper-xemacs-p (not (event-over-text-area-p click)))))
367 () ; do nothing, if binding isn't right or not over text
368 (let ((previous-search-string viper-s-string)
369 click-word click-count)
373 ;; This trick checks if there is a pending mouse event if so, we use
374 ;; this latter event and discard the current mouse click If the next
375 ;; pending event is not a mouse event, we execute the current mouse
379 (viper-mouse-event-p last-input-event)))
380 (progn ; interrupted wait
381 (setq viper-global-prefix-argument (or viper-global-prefix-argument
383 ;; remember command that was before the multiclick
384 this-command last-command)
385 ;; make sure we counted this event---needed for XEmacs only
386 (viper-event-click-count click))
387 ;; uninterrupted wait
388 (setq click-count (viper-event-click-count click))
389 (setq click-word (viper-mouse-click-get-word click nil click-count))
391 (if (> click-count 1)
392 (setq arg viper-global-prefix-argument
393 viper-global-prefix-argument nil))
394 (setq arg (or arg 1))
396 (viper-deactivate-mark)
397 (if (or (not (string= click-word viper-s-string))
398 (not (markerp viper-search-start-marker))
399 (not (equal (marker-buffer viper-search-start-marker)
401 (not (eq last-command 'viper-mouse-click-search-word)))
403 (setq viper-search-start-marker (point-marker)
404 viper-local-search-start-marker viper-search-start-marker
405 viper-mouse-click-search-noerror t
406 viper-mouse-click-search-limit nil)
408 ;; make search string known to Viper
409 (setq viper-s-string (if viper-re-search
410 (regexp-quote click-word)
412 (if (not (string= viper-s-string (car viper-search-history)))
413 (setq viper-search-history
414 (cons viper-s-string viper-search-history)))
419 (viper-forward-word 1)
422 (if (not (search-forward
423 click-word viper-mouse-click-search-limit
424 viper-mouse-click-search-noerror))
426 (setq viper-mouse-click-search-noerror nil)
427 (setq viper-mouse-click-search-limit
430 (markerp viper-local-search-start-marker)
431 (marker-buffer viper-local-search-start-marker))
432 (goto-char viper-local-search-start-marker))
433 (viper-line-pos 'end)))
435 (goto-char (point-min))
436 (search-forward click-word
437 viper-mouse-click-search-limit nil)))
438 (goto-char (match-beginning 0))
439 (message "Searching for: %s" viper-s-string)
440 (if (<= arg 1) ; found the right occurrence of the pattern
442 (viper-adjust-window)
443 (viper-flash-search-pattern)))
446 (if (or (not (string= click-word previous-search-string))
447 (not (eq last-command 'viper-mouse-click-search-word)))
448 (message "`%s': String not found in %s"
449 viper-s-string (buffer-name (current-buffer)))
451 "`%s': Last occurrence in %s. Back to beginning of search"
452 click-word (buffer-name (current-buffer)))
453 (setq arg 1) ;; to terminate the loop
455 (setq viper-mouse-click-search-noerror t)
456 (setq viper-mouse-click-search-limit nil)
457 (if (and (markerp viper-local-search-start-marker)
458 (marker-buffer viper-local-search-start-marker))
459 (goto-char viper-local-search-start-marker))))
463 (defun viper-mouse-catch-frame-switch (event arg)
464 "Catch the event of switching frame.
465 Usually is bound to a `down-mouse' event to work properly. See sample
466 bindings in the Viper manual."
468 (setq viper-frame-of-focus nil)
469 ;; pass prefix arg along to viper-mouse-click-search/insert-word
470 (setq prefix-arg arg)
471 (if (eq last-command 'handle-switch-frame)
472 (setq viper-frame-of-focus viper-current-frame-saved))
473 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
474 (setq this-command last-command))
476 ;; Called just before switching frames. Saves the old selected frame.
477 ;; Sets last-command to handle-switch-frame (this is done automatically in
479 ;; The semantics of switching frames is different in Emacs and XEmacs.
480 ;; In Emacs, if you select-frame A while mouse is over frame B and then
481 ;; start typing, input goes to frame B, which becomes selected.
482 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
483 ;; Emacsen, but also may be a design decision.
484 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
485 ;; event, while in XEmacs it doesn't.
486 ;; All this accounts for the difference in the behavior of
487 ;; viper-mouse-click-* commands when you click in a frame other than the one
488 ;; that was the last to receive input. In Emacs, focus will be in frame A
489 ;; until you do something other than viper-mouse-click-* command.
490 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
491 ;; order to shift focus to frame B.
492 (defsubst viper-remember-current-frame (frame)
493 (setq last-command 'handle-switch-frame
494 viper-current-frame-saved (selected-frame)))
497 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
498 ;; Converts into a valid mouse button spec for the appropriate version of
499 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
500 ;; returns button-down key.
501 (defun viper-parse-mouse-key (key-var event-type)
502 (let ((key (eval key-var))
503 button-spec meta-spec shift-spec control-spec key-spec)
510 (if (eq 'up event-type)
511 "mouse-1" "down-mouse-1")
512 (if (eq 'up event-type)
513 'button1up 'button1)))
516 (if (eq 'up event-type)
517 "mouse-2" "down-mouse-2")
518 (if (eq 'up event-type)
519 'button2up 'button2)))
522 (if (eq 'up event-type)
523 "mouse-3" "down-mouse-3")
524 (if (eq 'up event-type)
525 'button3up 'button3)))
527 "%S: invalid button number, %S" key-var key)))
530 (if viper-emacs-p "M-" 'meta)
531 (if viper-emacs-p "" nil))
533 (if (memq 'shift key)
534 (if viper-emacs-p "S-" 'shift)
535 (if viper-emacs-p "" nil))
537 (if (memq 'control key)
538 (if viper-emacs-p "C-" 'control)
539 (if viper-emacs-p "" nil)))
541 (setq key-spec (if viper-emacs-p
545 control-spec meta-spec shift-spec button-spec)))
550 control-spec meta-spec shift-spec button-spec)))))
553 (defun viper-unbind-mouse-search-key ()
554 (if viper-mouse-up-search-key-parsed
555 (global-unset-key viper-mouse-up-search-key-parsed))
556 (if viper-mouse-down-search-key-parsed
557 (global-unset-key viper-mouse-down-search-key-parsed))
558 (setq viper-mouse-up-search-key-parsed nil
559 viper-mouse-down-search-key-parsed nil))
561 (defun viper-unbind-mouse-insert-key ()
562 (if viper-mouse-up-insert-key-parsed
563 (global-unset-key viper-mouse-up-insert-key-parsed))
564 (if viper-mouse-down-insert-key-parsed
565 (global-unset-key viper-mouse-down-insert-key-parsed))
566 (setq viper-mouse-up-insert-key-parsed nil
567 viper-mouse-down-insert-key-parsed nil))
569 ;; If FORCE, bind even if this mouse action is already bound to something else
570 (defun viper-bind-mouse-search-key (&optional force)
571 (setq viper-mouse-up-search-key-parsed
572 (viper-parse-mouse-key 'viper-mouse-search-key 'up)
573 viper-mouse-down-search-key-parsed
574 (viper-parse-mouse-key 'viper-mouse-search-key 'down))
575 (cond ((or (null viper-mouse-up-search-key-parsed)
576 (null viper-mouse-down-search-key-parsed))
579 (key-binding viper-mouse-up-search-key-parsed)
580 (not (eq (key-binding viper-mouse-up-search-key-parsed)
581 'viper-mouse-click-search-word)))
583 "%S already bound to a mouse event. Viper mouse-search feature disabled"
584 viper-mouse-up-search-key-parsed))
586 (key-binding viper-mouse-down-search-key-parsed)
587 (not (eq (key-binding viper-mouse-down-search-key-parsed)
588 'viper-mouse-catch-frame-switch)))
590 "%S already bound to a mouse event. Viper mouse-search feature disabled"
591 viper-mouse-down-search-key-parsed))
593 (global-set-key viper-mouse-up-search-key-parsed
594 'viper-mouse-click-search-word)
595 (global-set-key viper-mouse-down-search-key-parsed
596 'viper-mouse-catch-frame-switch))))
598 ;; If FORCE, bind even if this mouse action is already bound to something else
599 (defun viper-bind-mouse-insert-key (&optional force)
600 (setq viper-mouse-up-insert-key-parsed
601 (viper-parse-mouse-key 'viper-mouse-insert-key 'up)
602 viper-mouse-down-insert-key-parsed
603 (viper-parse-mouse-key 'viper-mouse-insert-key 'down))
604 (cond ((or (null viper-mouse-up-insert-key-parsed)
605 (null viper-mouse-down-insert-key-parsed))
608 (key-binding viper-mouse-up-insert-key-parsed)
609 (not (eq (key-binding viper-mouse-up-insert-key-parsed)
610 'viper-mouse-click-insert-word)))
612 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
613 viper-mouse-up-insert-key-parsed))
615 (key-binding viper-mouse-down-insert-key-parsed)
616 (not (eq (key-binding viper-mouse-down-insert-key-parsed)
617 'viper-mouse-catch-frame-switch)))
619 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
620 viper-mouse-down-insert-key-parsed))
622 (global-set-key viper-mouse-up-insert-key-parsed
623 'viper-mouse-click-insert-word)
624 (global-set-key viper-mouse-down-insert-key-parsed
625 'viper-mouse-catch-frame-switch))))
627 (defun viper-reset-mouse-search-key (symb val)
628 (viper-unbind-mouse-search-key)
630 (viper-bind-mouse-search-key 'force))
632 (defun viper-reset-mouse-insert-key (symb val)
633 (viper-unbind-mouse-insert-key)
635 (viper-bind-mouse-insert-key 'force))
638 (defcustom viper-mouse-search-key '(meta shift 1)
639 "*Key used to click-search in Viper.
640 This must be a list that specifies the mouse button and modifiers.
641 The supported modifiers are `meta', `shift', and `control'.
642 For instance, `(meta shift 1)' means that holding the meta and shift
643 keys down and clicking on a word with mouse button 1
644 will search for that word in the buffer that was current before the click.
645 This buffer may be different from the one where the click occurred."
646 :type '(list (set :inline t :tag "Modifiers" :format "%t: %v"
647 (const :format "%v " meta)
648 (const :format "%v " shift)
650 (integer :tag "Button"))
651 :set 'viper-reset-mouse-search-key
654 (defcustom viper-mouse-insert-key '(meta shift 2)
655 "*Key used to click-insert in Viper.
656 Must be a list that specifies the mouse button and modifiers.
657 The supported modifiers are `meta', `shift', and `control'.
658 For instance, `(meta shift 2)' means that holding the meta and shift keys
659 down, and clicking on a word with mouse button 2, will insert that word
660 at the cursor in the buffer that was current just before the click.
661 This buffer may be different from the one where the click occurred."
662 :type '(list (set :inline t :tag "Modifiers" :format "%t: %v"
663 (const :format "%v " meta)
664 (const :format "%v " shift)
666 (integer :tag "Button"))
667 :set 'viper-reset-mouse-insert-key
673 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
677 ;;; viper-mous.el ends here