| blob | e95e80aa4e03a76ad9e77053c9631a04c4fb29ce |
1 ;;; viper-mous.el --- mouse support for Viper
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
31 ;; compiler pacifier
40 ;; loading happens only in non-interactive compilation
41 ;; in order to spare non-viperized emacs from being viperized
49 )))
50 ;; end pacifier
56 "Support for Viper special mouse-bound commands."
60 \f
61 ;;; Variables
63 ;; Variable used for catching the switch-frame event.
64 ;; If non-nil, indicates that previous-frame should be the selected
65 ;; one. Used by viper-mouse-click-get-word. Not a user option.
68 ;; Frame that was selected before the switch-frame event.
72 "*Function that determines what constitutes a word for clicking events.
73 Takes two parameters: a COUNT, indicating how many words to return,
74 and CLICK-COUNT, telling whether this is the first click, a double-click,
75 or a tripple-click."
79 ;; time interval in millisecond within which successive clicks are
80 ;; considered related
83 mouse-track-multi-click-time
84 double-click-time)
86 "*Time interval in millisecond within which successive mouse clicks are
87 considered related."
91 ;; current event click count; XEmacs only
93 ;; time stamp of the last click event; XEmacs only
96 ;; Local variable used to toggle wraparound search on click.
99 ;; Local variable used to delimit search after wraparound.
102 ;; remembers prefix argument to pass along to commands invoked by second
103 ;; click.
104 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
105 ;; causes Emacs to count the second click as if it was a single click
109 ;; same keys, but parsed
117 \f
118 ;;; Code
123 ;; Returns window where click occurs
128 )))
130 win
133 ;; Returns window where click occurs
137 ;; Returns the buffer of the window where click occurs
141 ;; Returns the name of the buffer in the window where click occurs
145 ;; Returns position of a click
150 ))
154 "Returns word surrounding point according to a heuristic.
155 COUNT indicates how many regions to return.
156 If CLICK-COUNT is 1, `word' is a word in Vi sense.
157 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
158 If the character clicked on is a non-separator and is non-alphanumeric but
159 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
160 for the purpose of this command. If this character has a matching
161 character, such as `\(' is a match for `\)', then the matching character is
162 also considered alphanumeric.
163 For convenience, in Lisp modes, `-' is considered alphanumeric.
165 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
166 trailing space and tabs removed. In that case, the first argument, COUNT,
167 is ignored."
169 beg skip-flag result
170 word-beg)
196 )
197 ))
199 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
228 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
229 ;; doesn't return properties together with the string, so it's not needed.
232 result
233 ))
237 "Returns word surrounding the position of a mouse click.
238 Click may be in another window. Current window and buffer isn't changed.
239 On single or double click, returns the word as determined by
240 `viper-surrounding-word-function'."
258 click-word))))
262 "Insert word clicked or double-clicked on.
263 With prefix argument, N, insert that many words.
264 This command must be bound to a mouse click.
265 The double-click action of the same mouse button must not be bound
266 \(or it must be bound to the same function\).
267 See `viper-surrounding-word' for the definition of a word in this case."
278 ;; turn arg into a number
280 ;; prefix arg is a list when one hits C-u then command
291 ;; This trick checks if there is a pending mouse event if so, we
292 ;; use this latter event and discard the current mouse click If
293 ;; the next pending event is not a mouse event, we execute the
294 ;; current mouse event
300 ;; count this click for XEmacs
302 ;; uninterrupted wait or the interrupting event wasn't a mouse event
306 viper-global-prefix-argument nil))
312 )))))
314 ;; Arg is an event. Accepts symbols and numbers, too
320 ;; XEmacs has no double-click events. So, we must simulate.
321 ;; So, we have to simulate event-click-count.
326 ))
328 ;; kind of semaphore for updating viper-current-click-count
333 viper-last-click-event-timestamp))
334 inhibit-quit)
345 viper-current-click-count
347 ))
348 nil ; emacs
349 )
353 "Find the word clicked or double-clicked on. Word may be in another window.
354 With prefix argument, N, search for N-th occurrence.
355 This command must be bound to a mouse click. The double-click action of the
356 same button must not be bound \(or it must be bound to the same function\).
357 See `viper-surrounding-word' for the details on what constitutes a word for
358 this command."
370 click-word click-count)
374 ;; This trick checks if there is a pending mouse event if so, we use
375 ;; this latter event and discard the current mouse click If the next
376 ;; pending event is not a mouse event, we execute the current mouse
377 ;; event
383 arg)
384 ;; remember command that was before the multiclick
385 this-command last-command)
386 ;; make sure we counted this event---needed for XEmacs only
388 ;; uninterrupted wait
394 viper-global-prefix-argument nil))
405 viper-local-search-start-marker viper-search-start-marker
406 viper-mouse-click-search-noerror t
407 viper-mouse-click-search-limit nil)
409 ;; make search string known to Viper
412 click-word))
416 ))
424 click-word viper-mouse-click-search-limit
425 viper-mouse-click-search-noerror))
438 viper-mouse-click-search-limit nil)))
445 )
452 "`%s': Last occurrence in %s. Back to beginning of search"
462 ))))
465 "Catch the event of switching frame.
466 Usually is bound to a `down-mouse' event to work properly. See sample
467 bindings in the Viper manual."
470 ;; pass prefix arg along to viper-mouse-click-search/insert-word
474 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
477 ;; Called just before switching frames. Saves the old selected frame.
478 ;; Sets last-command to handle-switch-frame (this is done automatically in
479 ;; Emacs.
480 ;; The semantics of switching frames is different in Emacs and XEmacs.
481 ;; In Emacs, if you select-frame A while mouse is over frame B and then
482 ;; start typing, input goes to frame B, which becomes selected.
483 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
484 ;; Emacsen, but also may be a design decision.
485 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
486 ;; event, while in XEmacs it doesn't.
487 ;; All this accounts for the difference in the behavior of
488 ;; viper-mouse-click-* commands when you click in a frame other than the one
489 ;; that was the last to receive input. In Emacs, focus will be in frame A
490 ;; until you do something other than viper-mouse-click-* command.
491 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
492 ;; order to shift focus to frame B.
498 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
499 ;; Converts into a valid mouse button spec for the appropriate version of
500 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
501 ;; returns button-down key.
504 button-spec meta-spec shift-spec control-spec key-spec)
506 ;; just return nil
507 ()
529 meta-spec
533 shift-spec
537 control-spec
546 control-spec meta-spec shift-spec button-spec)))
549 nil
551 control-spec meta-spec shift-spec button-spec)))))
552 )))
560 viper-mouse-down-search-key-parsed nil))
568 viper-mouse-down-insert-key-parsed nil))
570 ;; If FORCE, bind even if this mouse action is already bound to something else
574 viper-mouse-down-search-key-parsed
584 "%S already bound to a mouse event. Viper mouse-search feature disabled"
585 viper-mouse-up-search-key-parsed))
591 "%S already bound to a mouse event. Viper mouse-search feature disabled"
592 viper-mouse-down-search-key-parsed))
599 ;; If FORCE, bind even if this mouse action is already bound to something else
603 viper-mouse-down-insert-key-parsed
613 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
614 viper-mouse-up-insert-key-parsed))
620 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
621 viper-mouse-down-insert-key-parsed))
640 "*Key used to click-search in Viper.
641 This must be a list that specifies the mouse button and modifiers.
642 The supported modifiers are `meta', `shift', and `control'.
643 For instance, `(meta shift 1)' means that holding the meta and shift
644 keys down and clicking on a word with mouse button 1
645 will search for that word in the buffer that was current before the click.
646 This buffer may be different from the one where the click occurred."
656 "*Key used to click-insert in Viper.
657 Must be a list that specifies the mouse button and modifiers.
658 The supported modifiers are `meta', `shift', and `control'.
659 For instance, `(meta shift 2)' means that holding the meta and shift keys
660 down, and clicking on a word with mouse button 2, will insert that word
661 at the cursor in the buffer that was current just before the click.
662 This buffer may be different from the one where the click occurred."
673 ;;; Local Variables:
674 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
675 ;;; End:
678 ;;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
679 ;;; viper-mous.el ends here