| blob | 8d54571b3f4797651f7007d2c59fe55ab5c349f1 |
1 ;;; viper-mous.el --- mouse support for Viper
3 ;; Copyright (C) 1994-1997, 2001-2013 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
6 ;; Package: viper
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
29 ;; compiler pacifier
39 ;; end pacifier
43 "Support for Viper special mouse-bound commands."
47 \f
48 ;;; Variables
50 ;; Variable used for catching the switch-frame event.
51 ;; If non-nil, indicates that previous-frame should be the selected
52 ;; one. Used by viper-mouse-click-get-word. Not a user option.
55 ;; Frame that was selected before the switch-frame event.
59 "Function that determines what constitutes a word for clicking events.
60 Takes two parameters: a COUNT, indicating how many words to return,
61 and CLICK-COUNT, telling whether this is the first click, a double-click,
62 or a triple-click."
66 ;; time interval in millisecond within which successive clicks are
67 ;; considered related
70 mouse-track-multi-click-time
71 double-click-time)
73 "Time interval in millisecond within which successive mouse clicks are
74 considered related."
78 ;; current event click count; XEmacs only
80 ;; time stamp of the last click event; XEmacs only
83 ;; Local variable used to toggle wraparound search on click.
86 ;; Local variable used to delimit search after wraparound.
89 ;; remembers prefix argument to pass along to commands invoked by second
90 ;; click.
91 ;; This is needed because in Emacs (not XEmacs), assigning to prefix-arg
92 ;; causes Emacs to count the second click as if it was a single click
96 ;; same keys, but parsed
104 \f
105 ;;; Code
110 ;; Returns window where click occurs
115 win
118 ;; Returns window where click occurs
122 ;; Returns the buffer of the window where click occurs
126 ;; Returns the name of the buffer in the window where click occurs
130 ;; Returns position of a click
141 "Returns word surrounding point according to a heuristic.
142 COUNT indicates how many regions to return.
143 If CLICK-COUNT is 1, `word' is a word in Vi sense.
144 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
145 If the character clicked on is a non-separator and is non-alphanumeric but
146 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
147 for the purpose of this command. If this character has a matching
148 character, such as `\(' is a match for `\)', then the matching character is
149 also considered alphanumeric.
150 For convenience, in Lisp modes, `-' is considered alphanumeric.
152 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
153 trailing space and tabs removed. In that case, the first argument, COUNT,
154 is ignored."
156 beg skip-flag result
157 word-beg)
183 )
184 ))
186 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
215 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
216 ;; doesn't return properties together with the string, so it's not needed.
219 result
220 ))
224 "Returns word surrounding the position of a mouse click.
225 Click may be in another window. Current window and buffer isn't changed.
226 On single or double click, returns the word as determined by
227 `viper-surrounding-word-function'."
245 click-word))))
249 "Insert word clicked or double-clicked on.
250 With prefix argument, N, insert that many words.
251 This command must be bound to a mouse click.
252 The double-click action of the same mouse button must not be bound
253 \(or it must be bound to the same function\).
254 See `viper-surrounding-word' for the definition of a word in this case."
265 ;; turn arg into a number
267 ;; prefix arg is a list when one hits C-u then command
278 ;; This trick checks if there is a pending mouse event if so, we
279 ;; use this latter event and discard the current mouse click If
280 ;; the next pending event is not a mouse event, we execute the
281 ;; current mouse event
287 ;; count this click for XEmacs
289 ;; uninterrupted wait or the interrupting event wasn't a mouse event
293 viper-global-prefix-argument nil))
299 )))))
301 ;; Arg is an event. Accepts symbols and numbers, too
307 ;; XEmacs has no double-click events. So, we must simulate.
308 ;; So, we have to simulate event-click-count.
315 ;; kind of semaphore for updating viper-current-click-count
320 viper-last-click-event-timestamp))
321 inhibit-quit)
332 viper-current-click-count
339 "Find the word clicked or double-clicked on. Word may be in another window.
340 With prefix argument, N, search for N-th occurrence.
341 This command must be bound to a mouse click. The double-click action of the
342 same button must not be bound \(or it must be bound to the same function\).
343 See `viper-surrounding-word' for the details on what constitutes a word for
344 this command."
356 click-word click-count)
360 ;; This trick checks if there is a pending mouse event if so, we use
361 ;; this latter event and discard the current mouse click If the next
362 ;; pending event is not a mouse event, we execute the current mouse
363 ;; event
369 arg)
370 ;; remember command that was before the multiclick
371 this-command last-command)
372 ;; make sure we counted this event---needed for XEmacs only
374 ;; uninterrupted wait
380 viper-global-prefix-argument nil))
391 viper-local-search-start-marker viper-search-start-marker
392 viper-mouse-click-search-noerror t
393 viper-mouse-click-search-limit nil)
395 ;; make search string known to Viper
398 click-word))
402 ))
410 click-word viper-mouse-click-search-limit
411 viper-mouse-click-search-noerror))
424 viper-mouse-click-search-limit nil)))
431 )
438 "`%s': Last occurrence in %s. Back to beginning of search"
448 ))))
451 "Catch the event of switching frame.
452 Usually is bound to a `down-mouse' event to work properly. See sample
453 bindings in the Viper manual."
456 ;; pass prefix arg along to viper-mouse-click-search/insert-word
460 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
463 ;; Called just before switching frames. Saves the old selected frame.
464 ;; Sets last-command to handle-switch-frame (this is done automatically in
465 ;; Emacs.
466 ;; The semantics of switching frames is different in Emacs and XEmacs.
467 ;; In Emacs, if you select-frame A while mouse is over frame B and then
468 ;; start typing, input goes to frame B, which becomes selected.
469 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
470 ;; Emacsen, but also may be a design decision.
471 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
472 ;; event, while in XEmacs it doesn't.
473 ;; All this accounts for the difference in the behavior of
474 ;; viper-mouse-click-* commands when you click in a frame other than the one
475 ;; that was the last to receive input. In Emacs, focus will be in frame A
476 ;; until you do something other than viper-mouse-click-* command.
477 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
478 ;; order to shift focus to frame B.
484 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
485 ;; Converts into a valid mouse button spec for the appropriate version of
486 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
487 ;; returns button-down key.
490 button-spec meta-spec shift-spec control-spec key-spec)
492 ;; just return nil
493 ()
515 meta-spec
519 shift-spec
523 control-spec
532 control-spec meta-spec shift-spec button-spec)))
535 nil
537 control-spec meta-spec shift-spec button-spec)))))
538 )))
546 viper-mouse-down-search-key-parsed nil))
554 viper-mouse-down-insert-key-parsed nil))
556 ;; If FORCE, bind even if this mouse action is already bound to something else
560 viper-mouse-down-search-key-parsed
570 "%S already bound to a mouse event. Viper mouse-search feature disabled"
571 viper-mouse-up-search-key-parsed))
577 "%S already bound to a mouse event. Viper mouse-search feature disabled"
578 viper-mouse-down-search-key-parsed))
585 ;; If FORCE, bind even if this mouse action is already bound to something else
589 viper-mouse-down-insert-key-parsed
599 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
600 viper-mouse-up-insert-key-parsed))
606 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
607 viper-mouse-down-insert-key-parsed))
626 "Key used to click-search in Viper.
627 This must be a list that specifies the mouse button and modifiers.
628 The supported modifiers are `meta', `shift', and `control'.
629 For instance, `(meta shift 1)' means that holding the meta and shift
630 keys down and clicking on a word with mouse button 1
631 will search for that word in the buffer that was current before the click.
632 This buffer may be different from the one where the click occurred."
642 "Key used to click-insert in Viper.
643 Must be a list that specifies the mouse button and modifiers.
644 The supported modifiers are `meta', `shift', and `control'.
645 For instance, `(meta shift 2)' means that holding the meta and shift keys
646 down, and clicking on a word with mouse button 2, will insert that word
647 at the cursor in the buffer that was current just before the click.
648 This buffer may be different from the one where the click occurred."
659 ;; Local Variables:
660 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
661 ;; End:
664 ;;; viper-mous.el ends here