| blob | 1d60d1eb5eedb1257e34e77046698068b8717c67 |
1 ;;; viper-mous.el --- mouse support for Viper
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 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
47 )))
48 ;; end pacifier
54 "Support for Viper special mouse-bound commands."
58 \f
59 ;;; Variables
61 ;; Variable used for catching the switch-frame event.
62 ;; If non-nil, indicates that previous-frame should be the selected
63 ;; one. Used by viper-mouse-click-get-word. Not a user option.
66 ;; Frame that was selected before the switch-frame event.
70 "*Function that determines what constitutes a word for clicking events.
71 Takes two parameters: a COUNT, indicating how many words to return,
72 and CLICK-COUNT, telling whether this is the first click, a double-click,
73 or a tripple-click."
77 ;; time interval in millisecond within which successive clicks are
78 ;; considered related
81 mouse-track-multi-click-time
82 double-click-time)
84 "*Time interval in millisecond within which successive mouse clicks are
85 considered related."
89 ;; current event click count; XEmacs only
91 ;; time stamp of the last click event; XEmacs only
94 ;; Local variable used to toggle wraparound search on click.
97 ;; Local variable used to delimit search after wraparound.
100 ;; remembers prefix argument to pass along to commands invoked by second
101 ;; click.
102 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
103 ;; causes Emacs to count the second click as if it was a single click
107 ;; same keys, but parsed
115 \f
116 ;;; Code
121 ;; Returns window where click occurs
126 win
129 ;; Returns window where click occurs
133 ;; Returns the buffer of the window where click occurs
137 ;; Returns the name of the buffer in the window where click occurs
141 ;; Returns position of a click
148 "Returns word surrounding point according to a heuristic.
149 COUNT indicates how many regions to return.
150 If CLICK-COUNT is 1, `word' is a word in Vi sense.
151 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
152 If the character clicked on is a non-separator and is non-alphanumeric but
153 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
154 for the purpose of this command. If this character has a matching
155 character, such as `\(' is a match for `\)', then the matching character is
156 also considered alphanumeric.
157 For convenience, in Lisp modes, `-' is considered alphanumeric.
159 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
160 trailing space and tabs removed. In that case, the first argument, COUNT,
161 is ignored."
163 beg skip-flag result
164 word-beg)
190 )
191 ))
193 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
222 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
223 ;; doesn't return properties together with the string, so it's not needed.
226 result
227 ))
231 "Returns word surrounding the position of a mouse click.
232 Click may be in another window. Current window and buffer isn't changed.
233 On single or double click, returns the word as determined by
234 `viper-surrounding-word-function'."
252 click-word))))
256 "Insert word clicked or double-clicked on.
257 With prefix argument, N, insert that many words.
258 This command must be bound to a mouse click.
259 The double-click action of the same mouse button must not be bound
260 \(or it must be bound to the same function\).
261 See `viper-surrounding-word' for the definition of a word in this case."
272 ;; turn arg into a number
274 ;; prefix arg is a list when one hits C-u then command
285 ;; This trick checks if there is a pending mouse event if so, we
286 ;; use this latter event and discard the current mouse click If
287 ;; the next pending event is not a mouse event, we execute the
288 ;; current mouse event
294 ;; count this click for XEmacs
296 ;; uninterrupted wait or the interrupting event wasn't a mouse event
300 viper-global-prefix-argument nil))
306 )))))
308 ;; Arg is an event. Accepts symbols and numbers, too
314 ;; XEmacs has no double-click events. So, we must simulate.
315 ;; So, we have to simulate event-click-count.
322 ;; kind of semaphore for updating viper-current-click-count
327 viper-last-click-event-timestamp))
328 inhibit-quit)
339 viper-current-click-count
344 "Find the word clicked or double-clicked on. Word may be in another window.
345 With prefix argument, N, search for N-th occurrence.
346 This command must be bound to a mouse click. The double-click action of the
347 same button must not be bound \(or it must be bound to the same function\).
348 See `viper-surrounding-word' for the details on what constitutes a word for
349 this command."
361 click-word click-count)
365 ;; This trick checks if there is a pending mouse event if so, we use
366 ;; this latter event and discard the current mouse click If the next
367 ;; pending event is not a mouse event, we execute the current mouse
368 ;; event
374 arg)
375 ;; remember command that was before the multiclick
376 this-command last-command)
377 ;; make sure we counted this event---needed for XEmacs only
379 ;; uninterrupted wait
385 viper-global-prefix-argument nil))
396 viper-local-search-start-marker viper-search-start-marker
397 viper-mouse-click-search-noerror t
398 viper-mouse-click-search-limit nil)
400 ;; make search string known to Viper
403 click-word))
407 ))
415 click-word viper-mouse-click-search-limit
416 viper-mouse-click-search-noerror))
429 viper-mouse-click-search-limit nil)))
436 )
443 "`%s': Last occurrence in %s. Back to beginning of search"
453 ))))
456 "Catch the event of switching frame.
457 Usually is bound to a `down-mouse' event to work properly. See sample
458 bindings in the Viper manual."
461 ;; pass prefix arg along to viper-mouse-click-search/insert-word
465 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
468 ;; Called just before switching frames. Saves the old selected frame.
469 ;; Sets last-command to handle-switch-frame (this is done automatically in
470 ;; Emacs.
471 ;; The semantics of switching frames is different in Emacs and XEmacs.
472 ;; In Emacs, if you select-frame A while mouse is over frame B and then
473 ;; start typing, input goes to frame B, which becomes selected.
474 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
475 ;; Emacsen, but also may be a design decision.
476 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
477 ;; event, while in XEmacs it doesn't.
478 ;; All this accounts for the difference in the behavior of
479 ;; viper-mouse-click-* commands when you click in a frame other than the one
480 ;; that was the last to receive input. In Emacs, focus will be in frame A
481 ;; until you do something other than viper-mouse-click-* command.
482 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
483 ;; order to shift focus to frame B.
489 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
490 ;; Converts into a valid mouse button spec for the appropriate version of
491 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
492 ;; returns button-down key.
495 button-spec meta-spec shift-spec control-spec key-spec)
497 ;; just return nil
498 ()
520 meta-spec
524 shift-spec
528 control-spec
537 control-spec meta-spec shift-spec button-spec)))
540 nil
542 control-spec meta-spec shift-spec button-spec)))))
543 )))
551 viper-mouse-down-search-key-parsed nil))
559 viper-mouse-down-insert-key-parsed nil))
561 ;; If FORCE, bind even if this mouse action is already bound to something else
565 viper-mouse-down-search-key-parsed
575 "%S already bound to a mouse event. Viper mouse-search feature disabled"
576 viper-mouse-up-search-key-parsed))
582 "%S already bound to a mouse event. Viper mouse-search feature disabled"
583 viper-mouse-down-search-key-parsed))
590 ;; If FORCE, bind even if this mouse action is already bound to something else
594 viper-mouse-down-insert-key-parsed
604 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
605 viper-mouse-up-insert-key-parsed))
611 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
612 viper-mouse-down-insert-key-parsed))
631 "*Key used to click-search in Viper.
632 This must be a list that specifies the mouse button and modifiers.
633 The supported modifiers are `meta', `shift', and `control'.
634 For instance, `(meta shift 1)' means that holding the meta and shift
635 keys down and clicking on a word with mouse button 1
636 will search for that word in the buffer that was current before the click.
637 This buffer may be different from the one where the click occurred."
647 "*Key used to click-insert in Viper.
648 Must be a list that specifies the mouse button and modifiers.
649 The supported modifiers are `meta', `shift', and `control'.
650 For instance, `(meta shift 2)' means that holding the meta and shift keys
651 down, and clicking on a word with mouse button 2, will insert that word
652 at the cursor in the buffer that was current just before the click.
653 This buffer may be different from the one where the click occurred."
664 ;;; Local Variables:
665 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
666 ;;; End:
669 ;;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
670 ;;; viper-mous.el ends here