| blob | be2739777eb2fa084d7baaba1538f26b8177077e |
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 )))
128 win
131 ;; Returns window where click occurs
135 ;; Returns the buffer of the window where click occurs
139 ;; Returns the name of the buffer in the window where click occurs
143 ;; Returns position of a click
148 ))
152 "Returns word surrounding point according to a heuristic.
153 COUNT indicates how many regions to return.
154 If CLICK-COUNT is 1, `word' is a word in Vi sense.
155 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
156 If the character clicked on is a non-separator and is non-alphanumeric but
157 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
158 for the purpose of this command. If this character has a matching
159 character, such as `\(' is a match for `\)', then the matching character is
160 also considered alphanumeric.
161 For convenience, in Lisp modes, `-' is considered alphanumeric.
163 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
164 trailing space and tabs removed. In that case, the first argument, COUNT,
165 is ignored."
167 beg skip-flag result
168 word-beg)
194 )
195 ))
197 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
226 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
227 ;; doesn't return properties together with the string, so it's not needed.
230 result
231 ))
235 "Returns word surrounding the position of a mouse click.
236 Click may be in another window. Current window and buffer isn't changed.
237 On single or double click, returns the word as determined by
238 `viper-surrounding-word-function'."
256 click-word))))
260 "Insert word clicked or double-clicked on.
261 With prefix argument, N, insert that many words.
262 This command must be bound to a mouse click.
263 The double-click action of the same mouse button must not be bound
264 \(or it must be bound to the same function\).
265 See `viper-surrounding-word' for the definition of a word in this case."
276 ;; turn arg into a number
278 ;; prefix arg is a list when one hits C-u then command
289 ;; This trick checks if there is a pending mouse event if so, we
290 ;; use this latter event and discard the current mouse click If
291 ;; the next pending event is not a mouse event, we execute the
292 ;; current mouse event
298 ;; count this click for XEmacs
300 ;; uninterrupted wait or the interrupting event wasn't a mouse event
304 viper-global-prefix-argument nil))
310 )))))
312 ;; Arg is an event. Accepts symbols and numbers, too
318 ;; XEmacs has no double-click events. So, we must simulate.
319 ;; So, we have to simulate event-click-count.
324 ))
326 ;; kind of semaphore for updating viper-current-click-count
331 viper-last-click-event-timestamp))
332 inhibit-quit)
343 viper-current-click-count
345 ))
346 nil ; emacs
347 )
351 "Find the word clicked or double-clicked on. Word may be in another window.
352 With prefix argument, N, search for N-th occurrence.
353 This command must be bound to a mouse click. The double-click action of the
354 same button must not be bound \(or it must be bound to the same function\).
355 See `viper-surrounding-word' for the details on what constitutes a word for
356 this command."
368 click-word click-count)
372 ;; This trick checks if there is a pending mouse event if so, we use
373 ;; this latter event and discard the current mouse click If the next
374 ;; pending event is not a mouse event, we execute the current mouse
375 ;; event
381 arg)
382 ;; remember command that was before the multiclick
383 this-command last-command)
384 ;; make sure we counted this event---needed for XEmacs only
386 ;; uninterrupted wait
392 viper-global-prefix-argument nil))
403 viper-local-search-start-marker viper-search-start-marker
404 viper-mouse-click-search-noerror t
405 viper-mouse-click-search-limit nil)
407 ;; make search string known to Viper
410 click-word))
414 ))
422 click-word viper-mouse-click-search-limit
423 viper-mouse-click-search-noerror))
436 viper-mouse-click-search-limit nil)))
443 )
450 "`%s': Last occurrence in %s. Back to beginning of search"
460 ))))
463 "Catch the event of switching frame.
464 Usually is bound to a `down-mouse' event to work properly. See sample
465 bindings in the Viper manual."
468 ;; pass prefix arg along to viper-mouse-click-search/insert-word
472 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
475 ;; Called just before switching frames. Saves the old selected frame.
476 ;; Sets last-command to handle-switch-frame (this is done automatically in
477 ;; Emacs.
478 ;; The semantics of switching frames is different in Emacs and XEmacs.
479 ;; In Emacs, if you select-frame A while mouse is over frame B and then
480 ;; start typing, input goes to frame B, which becomes selected.
481 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
482 ;; Emacsen, but also may be a design decision.
483 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
484 ;; event, while in XEmacs it doesn't.
485 ;; All this accounts for the difference in the behavior of
486 ;; viper-mouse-click-* commands when you click in a frame other than the one
487 ;; that was the last to receive input. In Emacs, focus will be in frame A
488 ;; until you do something other than viper-mouse-click-* command.
489 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
490 ;; order to shift focus to frame B.
496 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
497 ;; Converts into a valid mouse button spec for the appropriate version of
498 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
499 ;; returns button-down key.
502 button-spec meta-spec shift-spec control-spec key-spec)
504 ;; just return nil
505 ()
527 meta-spec
531 shift-spec
535 control-spec
544 control-spec meta-spec shift-spec button-spec)))
547 nil
549 control-spec meta-spec shift-spec button-spec)))))
550 )))
558 viper-mouse-down-search-key-parsed nil))
566 viper-mouse-down-insert-key-parsed nil))
568 ;; If FORCE, bind even if this mouse action is already bound to something else
572 viper-mouse-down-search-key-parsed
582 "%S already bound to a mouse event. Viper mouse-search feature disabled"
583 viper-mouse-up-search-key-parsed))
589 "%S already bound to a mouse event. Viper mouse-search feature disabled"
590 viper-mouse-down-search-key-parsed))
597 ;; If FORCE, bind even if this mouse action is already bound to something else
601 viper-mouse-down-insert-key-parsed
611 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
612 viper-mouse-up-insert-key-parsed))
618 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
619 viper-mouse-down-insert-key-parsed))
638 "*Key used to click-search in Viper.
639 This must be a list that specifies the mouse button and modifiers.
640 The supported modifiers are `meta', `shift', and `control'.
641 For instance, `(meta shift 1)' means that holding the meta and shift
642 keys down and clicking on a word with mouse button 1
643 will search for that word in the buffer that was current before the click.
644 This buffer may be different from the one where the click occurred."
654 "*Key used to click-insert in Viper.
655 Must be a list that specifies the mouse button and modifiers.
656 The supported modifiers are `meta', `shift', and `control'.
657 For instance, `(meta shift 2)' means that holding the meta and shift keys
658 down, and clicking on a word with mouse button 2, will insert that word
659 at the cursor in the buffer that was current just before the click.
660 This buffer may be different from the one where the click occurred."
671 ;;; Local Variables:
672 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
673 ;;; End:
676 ;;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
677 ;;; viper-mous.el ends here