| blob | 9bea921e167bced1d6b8d50109c061365f66fd3f |
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, 2010 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; Package: viper
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
30 ;; compiler pacifier
39 ;; loading happens only in non-interactive compilation
40 ;; in order to spare non-viperized emacs from being viperized
44 ))
45 ;; end pacifier
51 "Support for Viper special mouse-bound commands."
55 \f
56 ;;; Variables
58 ;; Variable used for catching the switch-frame event.
59 ;; If non-nil, indicates that previous-frame should be the selected
60 ;; one. Used by viper-mouse-click-get-word. Not a user option.
63 ;; Frame that was selected before the switch-frame event.
67 "*Function that determines what constitutes a word for clicking events.
68 Takes two parameters: a COUNT, indicating how many words to return,
69 and CLICK-COUNT, telling whether this is the first click, a double-click,
70 or a tripple-click."
74 ;; time interval in millisecond within which successive clicks are
75 ;; considered related
78 mouse-track-multi-click-time
79 double-click-time)
81 "*Time interval in millisecond within which successive mouse clicks are
82 considered related."
86 ;; current event click count; XEmacs only
88 ;; time stamp of the last click event; XEmacs only
91 ;; Local variable used to toggle wraparound search on click.
94 ;; Local variable used to delimit search after wraparound.
97 ;; remembers prefix argument to pass along to commands invoked by second
98 ;; click.
99 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
100 ;; causes Emacs to count the second click as if it was a single click
104 ;; same keys, but parsed
112 \f
113 ;;; Code
118 ;; Returns window where click occurs
123 win
126 ;; Returns window where click occurs
130 ;; Returns the buffer of the window where click occurs
134 ;; Returns the name of the buffer in the window where click occurs
138 ;; Returns position of a click
145 "Returns word surrounding point according to a heuristic.
146 COUNT indicates how many regions to return.
147 If CLICK-COUNT is 1, `word' is a word in Vi sense.
148 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
149 If the character clicked on is a non-separator and is non-alphanumeric but
150 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
151 for the purpose of this command. If this character has a matching
152 character, such as `\(' is a match for `\)', then the matching character is
153 also considered alphanumeric.
154 For convenience, in Lisp modes, `-' is considered alphanumeric.
156 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
157 trailing space and tabs removed. In that case, the first argument, COUNT,
158 is ignored."
160 beg skip-flag result
161 word-beg)
187 )
188 ))
190 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
219 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
220 ;; doesn't return properties together with the string, so it's not needed.
223 result
224 ))
228 "Returns word surrounding the position of a mouse click.
229 Click may be in another window. Current window and buffer isn't changed.
230 On single or double click, returns the word as determined by
231 `viper-surrounding-word-function'."
249 click-word))))
253 "Insert word clicked or double-clicked on.
254 With prefix argument, N, insert that many words.
255 This command must be bound to a mouse click.
256 The double-click action of the same mouse button must not be bound
257 \(or it must be bound to the same function\).
258 See `viper-surrounding-word' for the definition of a word in this case."
269 ;; turn arg into a number
271 ;; prefix arg is a list when one hits C-u then command
282 ;; This trick checks if there is a pending mouse event if so, we
283 ;; use this latter event and discard the current mouse click If
284 ;; the next pending event is not a mouse event, we execute the
285 ;; current mouse event
291 ;; count this click for XEmacs
293 ;; uninterrupted wait or the interrupting event wasn't a mouse event
297 viper-global-prefix-argument nil))
303 )))))
305 ;; Arg is an event. Accepts symbols and numbers, too
311 ;; XEmacs has no double-click events. So, we must simulate.
312 ;; So, we have to simulate event-click-count.
319 ;; kind of semaphore for updating viper-current-click-count
324 viper-last-click-event-timestamp))
325 inhibit-quit)
336 viper-current-click-count
341 "Find the word clicked or double-clicked on. Word may be in another window.
342 With prefix argument, N, search for N-th occurrence.
343 This command must be bound to a mouse click. The double-click action of the
344 same button must not be bound \(or it must be bound to the same function\).
345 See `viper-surrounding-word' for the details on what constitutes a word for
346 this command."
358 click-word click-count)
362 ;; This trick checks if there is a pending mouse event if so, we use
363 ;; this latter event and discard the current mouse click If the next
364 ;; pending event is not a mouse event, we execute the current mouse
365 ;; event
371 arg)
372 ;; remember command that was before the multiclick
373 this-command last-command)
374 ;; make sure we counted this event---needed for XEmacs only
376 ;; uninterrupted wait
382 viper-global-prefix-argument nil))
393 viper-local-search-start-marker viper-search-start-marker
394 viper-mouse-click-search-noerror t
395 viper-mouse-click-search-limit nil)
397 ;; make search string known to Viper
400 click-word))
404 ))
412 click-word viper-mouse-click-search-limit
413 viper-mouse-click-search-noerror))
426 viper-mouse-click-search-limit nil)))
433 )
440 "`%s': Last occurrence in %s. Back to beginning of search"
450 ))))
453 "Catch the event of switching frame.
454 Usually is bound to a `down-mouse' event to work properly. See sample
455 bindings in the Viper manual."
458 ;; pass prefix arg along to viper-mouse-click-search/insert-word
462 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
465 ;; Called just before switching frames. Saves the old selected frame.
466 ;; Sets last-command to handle-switch-frame (this is done automatically in
467 ;; Emacs.
468 ;; The semantics of switching frames is different in Emacs and XEmacs.
469 ;; In Emacs, if you select-frame A while mouse is over frame B and then
470 ;; start typing, input goes to frame B, which becomes selected.
471 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
472 ;; Emacsen, but also may be a design decision.
473 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
474 ;; event, while in XEmacs it doesn't.
475 ;; All this accounts for the difference in the behavior of
476 ;; viper-mouse-click-* commands when you click in a frame other than the one
477 ;; that was the last to receive input. In Emacs, focus will be in frame A
478 ;; until you do something other than viper-mouse-click-* command.
479 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
480 ;; order to shift focus to frame B.
486 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
487 ;; Converts into a valid mouse button spec for the appropriate version of
488 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
489 ;; returns button-down key.
492 button-spec meta-spec shift-spec control-spec key-spec)
494 ;; just return nil
495 ()
517 meta-spec
521 shift-spec
525 control-spec
534 control-spec meta-spec shift-spec button-spec)))
537 nil
539 control-spec meta-spec shift-spec button-spec)))))
540 )))
548 viper-mouse-down-search-key-parsed nil))
556 viper-mouse-down-insert-key-parsed nil))
558 ;; If FORCE, bind even if this mouse action is already bound to something else
562 viper-mouse-down-search-key-parsed
572 "%S already bound to a mouse event. Viper mouse-search feature disabled"
573 viper-mouse-up-search-key-parsed))
579 "%S already bound to a mouse event. Viper mouse-search feature disabled"
580 viper-mouse-down-search-key-parsed))
587 ;; If FORCE, bind even if this mouse action is already bound to something else
591 viper-mouse-down-insert-key-parsed
601 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
602 viper-mouse-up-insert-key-parsed))
608 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
609 viper-mouse-down-insert-key-parsed))
628 "*Key used to click-search in Viper.
629 This must be a list that specifies the mouse button and modifiers.
630 The supported modifiers are `meta', `shift', and `control'.
631 For instance, `(meta shift 1)' means that holding the meta and shift
632 keys down and clicking on a word with mouse button 1
633 will search for that word in the buffer that was current before the click.
634 This buffer may be different from the one where the click occurred."
644 "*Key used to click-insert in Viper.
645 Must be a list that specifies the mouse button and modifiers.
646 The supported modifiers are `meta', `shift', and `control'.
647 For instance, `(meta shift 2)' means that holding the meta and shift keys
648 down, and clicking on a word with mouse button 2, will insert that word
649 at the cursor in the buffer that was current just before the click.
650 This buffer may be different from the one where the click occurred."
661 ;; Local Variables:
662 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
663 ;; End:
666 ;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
667 ;;; viper-mous.el ends here