| blob | c35c776eac4e234364f3b741a9fd2745ea61a5e7 |
1 ;;; viper-mous.el --- mouse support for Viper
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
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
38 ;; loading happens only in non-interactive compilation
39 ;; in order to spare non-viperized emacs from being viperized
43 ))
44 ;; end pacifier
50 "Support for Viper special mouse-bound commands."
54 \f
55 ;;; Variables
57 ;; Variable used for catching the switch-frame event.
58 ;; If non-nil, indicates that previous-frame should be the selected
59 ;; one. Used by viper-mouse-click-get-word. Not a user option.
62 ;; Frame that was selected before the switch-frame event.
66 "*Function that determines what constitutes a word for clicking events.
67 Takes two parameters: a COUNT, indicating how many words to return,
68 and CLICK-COUNT, telling whether this is the first click, a double-click,
69 or a tripple-click."
73 ;; time interval in millisecond within which successive clicks are
74 ;; considered related
77 mouse-track-multi-click-time
78 double-click-time)
80 "*Time interval in millisecond within which successive mouse clicks are
81 considered related."
85 ;; current event click count; XEmacs only
87 ;; time stamp of the last click event; XEmacs only
90 ;; Local variable used to toggle wraparound search on click.
93 ;; Local variable used to delimit search after wraparound.
96 ;; remembers prefix argument to pass along to commands invoked by second
97 ;; click.
98 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
99 ;; causes Emacs to count the second click as if it was a single click
103 ;; same keys, but parsed
111 \f
112 ;;; Code
117 ;; Returns window where click occurs
122 win
125 ;; Returns window where click occurs
129 ;; Returns the buffer of the window where click occurs
133 ;; Returns the name of the buffer in the window where click occurs
137 ;; Returns position of a click
144 "Returns word surrounding point according to a heuristic.
145 COUNT indicates how many regions to return.
146 If CLICK-COUNT is 1, `word' is a word in Vi sense.
147 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
148 If the character clicked on is a non-separator and is non-alphanumeric but
149 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
150 for the purpose of this command. If this character has a matching
151 character, such as `\(' is a match for `\)', then the matching character is
152 also considered alphanumeric.
153 For convenience, in Lisp modes, `-' is considered alphanumeric.
155 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
156 trailing space and tabs removed. In that case, the first argument, COUNT,
157 is ignored."
159 beg skip-flag result
160 word-beg)
186 )
187 ))
189 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
218 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
219 ;; doesn't return properties together with the string, so it's not needed.
222 result
223 ))
227 "Returns word surrounding the position of a mouse click.
228 Click may be in another window. Current window and buffer isn't changed.
229 On single or double click, returns the word as determined by
230 `viper-surrounding-word-function'."
248 click-word))))
252 "Insert word clicked or double-clicked on.
253 With prefix argument, N, insert that many words.
254 This command must be bound to a mouse click.
255 The double-click action of the same mouse button must not be bound
256 \(or it must be bound to the same function\).
257 See `viper-surrounding-word' for the definition of a word in this case."
268 ;; turn arg into a number
270 ;; prefix arg is a list when one hits C-u then command
281 ;; This trick checks if there is a pending mouse event if so, we
282 ;; use this latter event and discard the current mouse click If
283 ;; the next pending event is not a mouse event, we execute the
284 ;; current mouse event
290 ;; count this click for XEmacs
292 ;; uninterrupted wait or the interrupting event wasn't a mouse event
296 viper-global-prefix-argument nil))
302 )))))
304 ;; Arg is an event. Accepts symbols and numbers, too
310 ;; XEmacs has no double-click events. So, we must simulate.
311 ;; So, we have to simulate event-click-count.
318 ;; kind of semaphore for updating viper-current-click-count
323 viper-last-click-event-timestamp))
324 inhibit-quit)
335 viper-current-click-count
340 "Find the word clicked or double-clicked on. Word may be in another window.
341 With prefix argument, N, search for N-th occurrence.
342 This command must be bound to a mouse click. The double-click action of the
343 same button must not be bound \(or it must be bound to the same function\).
344 See `viper-surrounding-word' for the details on what constitutes a word for
345 this command."
357 click-word click-count)
361 ;; This trick checks if there is a pending mouse event if so, we use
362 ;; this latter event and discard the current mouse click If the next
363 ;; pending event is not a mouse event, we execute the current mouse
364 ;; event
370 arg)
371 ;; remember command that was before the multiclick
372 this-command last-command)
373 ;; make sure we counted this event---needed for XEmacs only
375 ;; uninterrupted wait
381 viper-global-prefix-argument nil))
392 viper-local-search-start-marker viper-search-start-marker
393 viper-mouse-click-search-noerror t
394 viper-mouse-click-search-limit nil)
396 ;; make search string known to Viper
399 click-word))
403 ))
411 click-word viper-mouse-click-search-limit
412 viper-mouse-click-search-noerror))
425 viper-mouse-click-search-limit nil)))
432 )
439 "`%s': Last occurrence in %s. Back to beginning of search"
449 ))))
452 "Catch the event of switching frame.
453 Usually is bound to a `down-mouse' event to work properly. See sample
454 bindings in the Viper manual."
457 ;; pass prefix arg along to viper-mouse-click-search/insert-word
461 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
464 ;; Called just before switching frames. Saves the old selected frame.
465 ;; Sets last-command to handle-switch-frame (this is done automatically in
466 ;; Emacs.
467 ;; The semantics of switching frames is different in Emacs and XEmacs.
468 ;; In Emacs, if you select-frame A while mouse is over frame B and then
469 ;; start typing, input goes to frame B, which becomes selected.
470 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
471 ;; Emacsen, but also may be a design decision.
472 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
473 ;; event, while in XEmacs it doesn't.
474 ;; All this accounts for the difference in the behavior of
475 ;; viper-mouse-click-* commands when you click in a frame other than the one
476 ;; that was the last to receive input. In Emacs, focus will be in frame A
477 ;; until you do something other than viper-mouse-click-* command.
478 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
479 ;; order to shift focus to frame B.
485 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
486 ;; Converts into a valid mouse button spec for the appropriate version of
487 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
488 ;; returns button-down key.
491 button-spec meta-spec shift-spec control-spec key-spec)
493 ;; just return nil
494 ()
516 meta-spec
520 shift-spec
524 control-spec
533 control-spec meta-spec shift-spec button-spec)))
536 nil
538 control-spec meta-spec shift-spec button-spec)))))
539 )))
547 viper-mouse-down-search-key-parsed nil))
555 viper-mouse-down-insert-key-parsed nil))
557 ;; If FORCE, bind even if this mouse action is already bound to something else
561 viper-mouse-down-search-key-parsed
571 "%S already bound to a mouse event. Viper mouse-search feature disabled"
572 viper-mouse-up-search-key-parsed))
578 "%S already bound to a mouse event. Viper mouse-search feature disabled"
579 viper-mouse-down-search-key-parsed))
586 ;; If FORCE, bind even if this mouse action is already bound to something else
590 viper-mouse-down-insert-key-parsed
600 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
601 viper-mouse-up-insert-key-parsed))
607 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
608 viper-mouse-down-insert-key-parsed))
627 "*Key used to click-search in Viper.
628 This must be a list that specifies the mouse button and modifiers.
629 The supported modifiers are `meta', `shift', and `control'.
630 For instance, `(meta shift 1)' means that holding the meta and shift
631 keys down and clicking on a word with mouse button 1
632 will search for that word in the buffer that was current before the click.
633 This buffer may be different from the one where the click occurred."
643 "*Key used to click-insert in Viper.
644 Must be a list that specifies the mouse button and modifiers.
645 The supported modifiers are `meta', `shift', and `control'.
646 For instance, `(meta shift 2)' means that holding the meta and shift keys
647 down, and clicking on a word with mouse button 2, will insert that word
648 at the cursor in the buffer that was current just before the click.
649 This buffer may be different from the one where the click occurred."
660 ;;; Local Variables:
661 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
662 ;;; End:
665 ;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
666 ;;; viper-mous.el ends here