| blob | e7d2315b52bee07268c7204dbbdd545fcb6e8401 |
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
45 ))
46 ;; end pacifier
52 "Support for Viper special mouse-bound commands."
56 \f
57 ;;; Variables
59 ;; Variable used for catching the switch-frame event.
60 ;; If non-nil, indicates that previous-frame should be the selected
61 ;; one. Used by viper-mouse-click-get-word. Not a user option.
64 ;; Frame that was selected before the switch-frame event.
68 "*Function that determines what constitutes a word for clicking events.
69 Takes two parameters: a COUNT, indicating how many words to return,
70 and CLICK-COUNT, telling whether this is the first click, a double-click,
71 or a tripple-click."
75 ;; time interval in millisecond within which successive clicks are
76 ;; considered related
79 mouse-track-multi-click-time
80 double-click-time)
82 "*Time interval in millisecond within which successive mouse clicks are
83 considered related."
87 ;; current event click count; XEmacs only
89 ;; time stamp of the last click event; XEmacs only
92 ;; Local variable used to toggle wraparound search on click.
95 ;; Local variable used to delimit search after wraparound.
98 ;; remembers prefix argument to pass along to commands invoked by second
99 ;; click.
100 ;; This is needed because in Emacs (not XEmacs), assigning to preix-arg
101 ;; causes Emacs to count the second click as if it was a single click
105 ;; same keys, but parsed
113 \f
114 ;;; Code
119 ;; Returns window where click occurs
124 win
127 ;; Returns window where click occurs
131 ;; Returns the buffer of the window where click occurs
135 ;; Returns the name of the buffer in the window where click occurs
139 ;; Returns position of a click
146 "Returns word surrounding point according to a heuristic.
147 COUNT indicates how many regions to return.
148 If CLICK-COUNT is 1, `word' is a word in Vi sense.
149 If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
150 If the character clicked on is a non-separator and is non-alphanumeric but
151 is adjacent to an alphanumeric symbol, then it is considered alphanumeric
152 for the purpose of this command. If this character has a matching
153 character, such as `\(' is a match for `\)', then the matching character is
154 also considered alphanumeric.
155 For convenience, in Lisp modes, `-' is considered alphanumeric.
157 If CLICK-COUNT is 3 or more, returns the line clicked on with leading and
158 trailing space and tabs removed. In that case, the first argument, COUNT,
159 is ignored."
161 beg skip-flag result
162 word-beg)
188 )
189 ))
191 ;; Add `-' to alphanum, if it wasn't added and if we are in Lisp
220 ;; XEmacs doesn't have set-text-properties, but there buffer-substring
221 ;; doesn't return properties together with the string, so it's not needed.
224 result
225 ))
229 "Returns word surrounding the position of a mouse click.
230 Click may be in another window. Current window and buffer isn't changed.
231 On single or double click, returns the word as determined by
232 `viper-surrounding-word-function'."
250 click-word))))
254 "Insert word clicked or double-clicked on.
255 With prefix argument, N, insert that many words.
256 This command must be bound to a mouse click.
257 The double-click action of the same mouse button must not be bound
258 \(or it must be bound to the same function\).
259 See `viper-surrounding-word' for the definition of a word in this case."
270 ;; turn arg into a number
272 ;; prefix arg is a list when one hits C-u then command
283 ;; This trick checks if there is a pending mouse event if so, we
284 ;; use this latter event and discard the current mouse click If
285 ;; the next pending event is not a mouse event, we execute the
286 ;; current mouse event
292 ;; count this click for XEmacs
294 ;; uninterrupted wait or the interrupting event wasn't a mouse event
298 viper-global-prefix-argument nil))
304 )))))
306 ;; Arg is an event. Accepts symbols and numbers, too
312 ;; XEmacs has no double-click events. So, we must simulate.
313 ;; So, we have to simulate event-click-count.
320 ;; kind of semaphore for updating viper-current-click-count
325 viper-last-click-event-timestamp))
326 inhibit-quit)
337 viper-current-click-count
342 "Find the word clicked or double-clicked on. Word may be in another window.
343 With prefix argument, N, search for N-th occurrence.
344 This command must be bound to a mouse click. The double-click action of the
345 same button must not be bound \(or it must be bound to the same function\).
346 See `viper-surrounding-word' for the details on what constitutes a word for
347 this command."
359 click-word click-count)
363 ;; This trick checks if there is a pending mouse event if so, we use
364 ;; this latter event and discard the current mouse click If the next
365 ;; pending event is not a mouse event, we execute the current mouse
366 ;; event
372 arg)
373 ;; remember command that was before the multiclick
374 this-command last-command)
375 ;; make sure we counted this event---needed for XEmacs only
377 ;; uninterrupted wait
383 viper-global-prefix-argument nil))
394 viper-local-search-start-marker viper-search-start-marker
395 viper-mouse-click-search-noerror t
396 viper-mouse-click-search-limit nil)
398 ;; make search string known to Viper
401 click-word))
405 ))
413 click-word viper-mouse-click-search-limit
414 viper-mouse-click-search-noerror))
427 viper-mouse-click-search-limit nil)))
434 )
441 "`%s': Last occurrence in %s. Back to beginning of search"
451 ))))
454 "Catch the event of switching frame.
455 Usually is bound to a `down-mouse' event to work properly. See sample
456 bindings in the Viper manual."
459 ;; pass prefix arg along to viper-mouse-click-search/insert-word
463 ;; make Emacs forget that it executed viper-mouse-catch-frame-switch
466 ;; Called just before switching frames. Saves the old selected frame.
467 ;; Sets last-command to handle-switch-frame (this is done automatically in
468 ;; Emacs.
469 ;; The semantics of switching frames is different in Emacs and XEmacs.
470 ;; In Emacs, if you select-frame A while mouse is over frame B and then
471 ;; start typing, input goes to frame B, which becomes selected.
472 ;; In XEmacs, input will go to frame A. This may be a bug in one of the
473 ;; Emacsen, but also may be a design decision.
474 ;; Also, in Emacs sending input to frame B generates handle-switch-frame
475 ;; event, while in XEmacs it doesn't.
476 ;; All this accounts for the difference in the behavior of
477 ;; viper-mouse-click-* commands when you click in a frame other than the one
478 ;; that was the last to receive input. In Emacs, focus will be in frame A
479 ;; until you do something other than viper-mouse-click-* command.
480 ;; In XEmacs, you have to manually select frame B (with the mouse click) in
481 ;; order to shift focus to frame B.
487 ;; The key is of the form (MODIFIER ... BUTTON-NUMBER)
488 ;; Converts into a valid mouse button spec for the appropriate version of
489 ;; Emacs. EVENT-TYPE is either `up' or `down'. Up returns button-up key; down
490 ;; returns button-down key.
493 button-spec meta-spec shift-spec control-spec key-spec)
495 ;; just return nil
496 ()
518 meta-spec
522 shift-spec
526 control-spec
535 control-spec meta-spec shift-spec button-spec)))
538 nil
540 control-spec meta-spec shift-spec button-spec)))))
541 )))
549 viper-mouse-down-search-key-parsed nil))
557 viper-mouse-down-insert-key-parsed nil))
559 ;; If FORCE, bind even if this mouse action is already bound to something else
563 viper-mouse-down-search-key-parsed
573 "%S already bound to a mouse event. Viper mouse-search feature disabled"
574 viper-mouse-up-search-key-parsed))
580 "%S already bound to a mouse event. Viper mouse-search feature disabled"
581 viper-mouse-down-search-key-parsed))
588 ;; If FORCE, bind even if this mouse action is already bound to something else
592 viper-mouse-down-insert-key-parsed
602 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
603 viper-mouse-up-insert-key-parsed))
609 "%S already bound to a mouse event. Viper mouse-insert feature disabled"
610 viper-mouse-down-insert-key-parsed))
629 "*Key used to click-search in Viper.
630 This must be a list that specifies the mouse button and modifiers.
631 The supported modifiers are `meta', `shift', and `control'.
632 For instance, `(meta shift 1)' means that holding the meta and shift
633 keys down and clicking on a word with mouse button 1
634 will search for that word in the buffer that was current before the click.
635 This buffer may be different from the one where the click occurred."
645 "*Key used to click-insert in Viper.
646 Must be a list that specifies the mouse button and modifiers.
647 The supported modifiers are `meta', `shift', and `control'.
648 For instance, `(meta shift 2)' means that holding the meta and shift keys
649 down, and clicking on a word with mouse button 2, will insert that word
650 at the cursor in the buffer that was current just before the click.
651 This buffer may be different from the one where the click occurred."
662 ;;; Local Variables:
663 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
664 ;;; End:
667 ;;; arch-tag: e56b2390-06c4-4dd1-96f5-c7876e2d8c2f
668 ;;; viper-mous.el ends here