* align.el:
[bpt/emacs.git] / lisp / mouse.el
1 ;;; mouse.el --- window system-independent mouse support
2
3 ;; Copyright (C) 1993, 1994, 1995, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5
6 ;; Maintainer: FSF
7 ;; Keywords: hardware, mouse
8
9 ;; This file is part of GNU Emacs.
10
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.
15
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.
20
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/>.
23
24 ;;; Commentary:
25
26 ;; This package provides various useful commands (including help
27 ;; system access) through the mouse. All this code assumes that mouse
28 ;; interpretation has been abstracted into Emacs input events.
29 ;;
30 ;; The code is rather X-dependent.
31
32 ;;; Code:
33
34 ;;; Utility functions.
35
36 ;; Indent track-mouse like progn.
37 (put 'track-mouse 'lisp-indent-function 0)
38
39 (defcustom mouse-yank-at-point nil
40 "If non-nil, mouse yank commands yank at point instead of at click."
41 :type 'boolean
42 :group 'mouse)
43
44 (defcustom mouse-drag-copy-region t
45 "If non-nil, mouse drag copies region to kill-ring."
46 :type 'boolean
47 :version "22.1"
48 :group 'mouse)
49
50 (defcustom mouse-1-click-follows-link 450
51 "Non-nil means that clicking Mouse-1 on a link follows the link.
52
53 With the default setting, an ordinary Mouse-1 click on a link
54 performs the same action as Mouse-2 on that link, while a longer
55 Mouse-1 click \(hold down the Mouse-1 button for more than 450
56 milliseconds) performs the original Mouse-1 binding \(which
57 typically sets point where you click the mouse).
58
59 If value is an integer, the time elapsed between pressing and
60 releasing the mouse button determines whether to follow the link
61 or perform the normal Mouse-1 action (typically set point).
62 The absolute numeric value specifices the maximum duration of a
63 \"short click\" in milliseconds. A positive value means that a
64 short click follows the link, and a longer click performs the
65 normal action. A negative value gives the opposite behavior.
66
67 If value is `double', a double click follows the link.
68
69 Otherwise, a single Mouse-1 click unconditionally follows the link.
70
71 Note that dragging the mouse never follows the link.
72
73 This feature only works in modes that specifically identify
74 clickable text as links, so it may not work with some external
75 packages. See `mouse-on-link-p' for details."
76 :version "22.1"
77 :type '(choice (const :tag "Disabled" nil)
78 (const :tag "Double click" double)
79 (number :tag "Single click time limit" :value 450)
80 (other :tag "Single click" t))
81 :group 'mouse)
82
83 (defcustom mouse-1-click-in-non-selected-windows t
84 "If non-nil, a Mouse-1 click also follows links in non-selected windows.
85
86 If nil, a Mouse-1 click on a link in a non-selected window performs
87 the normal mouse-1 binding, typically selects the window and sets
88 point at the click position."
89 :type 'boolean
90 :version "22.1"
91 :group 'mouse)
92
93
94 \f
95 ;; Provide a mode-specific menu on a mouse button.
96
97 (defun popup-menu (menu &optional position prefix)
98 "Popup the given menu and call the selected option.
99 MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
100 `x-popup-menu'.
101 POSITION can be a click event or ((XOFFSET YOFFSET) WINDOW) and defaults to
102 the current mouse position.
103 PREFIX is the prefix argument (if any) to pass to the command."
104 (let* ((map (cond
105 ((keymapp menu) menu)
106 ((and (listp menu) (keymapp (car menu))) menu)
107 (t (let* ((map (easy-menu-create-menu (car menu) (cdr menu)))
108 (filter (when (symbolp map)
109 (plist-get (get map 'menu-prop) :filter))))
110 (if filter (funcall filter (symbol-function map)) map)))))
111 event cmd)
112 (unless position
113 (let ((mp (mouse-pixel-position)))
114 (setq position (list (list (cadr mp) (cddr mp)) (car mp)))))
115 ;; The looping behavior was taken from lmenu's popup-menu-popup
116 (while (and map (setq event
117 ;; map could be a prefix key, in which case
118 ;; we need to get its function cell
119 ;; definition.
120 (x-popup-menu position (indirect-function map))))
121 ;; Strangely x-popup-menu returns a list.
122 ;; mouse-major-mode-menu was using a weird:
123 ;; (key-binding (apply 'vector (append '(menu-bar) menu-prefix events)))
124 (setq cmd
125 (if (and (not (keymapp map)) (listp map))
126 ;; We were given a list of keymaps. Search them all
127 ;; in sequence until a first binding is found.
128 (let ((mouse-click (apply 'vector event))
129 binding)
130 (while (and map (null binding))
131 (setq binding (lookup-key (car map) mouse-click))
132 (if (numberp binding) ; `too long'
133 (setq binding nil))
134 (setq map (cdr map)))
135 binding)
136 ;; We were given a single keymap.
137 (lookup-key map (apply 'vector event))))
138 ;; Clear out echoing, which perhaps shows a prefix arg.
139 (message "")
140 ;; Maybe try again but with the submap.
141 (setq map (if (keymapp cmd) cmd)))
142 ;; If the user did not cancel by refusing to select,
143 ;; and if the result is a command, run it.
144 (when (and (null map) (commandp cmd))
145 (setq prefix-arg prefix)
146 ;; `setup-specified-language-environment', for instance,
147 ;; expects this to be set from a menu keymap.
148 (setq last-command-event (car (last event)))
149 ;; mouse-major-mode-menu was using `command-execute' instead.
150 (call-interactively cmd))))
151
152 (defun minor-mode-menu-from-indicator (indicator)
153 "Show menu for minor mode specified by INDICATOR.
154 Interactively, INDICATOR is read using completion.
155 If there is no menu defined for the minor mode, then create one with
156 items `Turn Off' and `Help'."
157 (interactive
158 (list (completing-read
159 "Minor mode indicator: "
160 (describe-minor-mode-completion-table-for-indicator))))
161 (let ((minor-mode (lookup-minor-mode-from-indicator indicator)))
162 (unless minor-mode (error "Cannot find minor mode for `%s'" indicator))
163 (let* ((map (cdr-safe (assq minor-mode minor-mode-map-alist)))
164 (menu (and (keymapp map) (lookup-key map [menu-bar]))))
165 (setq menu
166 (if menu
167 (mouse-menu-non-singleton menu)
168 `(keymap
169 ,indicator
170 (turn-off menu-item "Turn Off minor mode" ,minor-mode)
171 (help menu-item "Help for minor mode"
172 (lambda () (interactive)
173 (describe-function ',minor-mode))))))
174 (popup-menu menu))))
175
176 (defun mouse-minor-mode-menu (event)
177 "Show minor-mode menu for EVENT on minor modes area of the mode line."
178 (interactive "@e")
179 (let ((indicator (car (nth 4 (car (cdr event))))))
180 (minor-mode-menu-from-indicator indicator)))
181
182 (defun mouse-menu-major-mode-map ()
183 (let* (;; Keymap from which to inherit; may be null.
184 (ancestor (mouse-menu-non-singleton
185 (and (current-local-map)
186 (local-key-binding [menu-bar]))))
187 ;; Make a keymap in which our last command leads to a menu or
188 ;; default to the edit menu.
189 (newmap (if ancestor
190 (make-sparse-keymap (concat (format-mode-line mode-name)
191 " Mode"))
192 menu-bar-edit-menu))
193 uniq)
194 (if ancestor
195 (set-keymap-parent newmap ancestor))
196 newmap))
197
198 (defun mouse-menu-non-singleton (menubar)
199 "Given menu keymap,
200 if it defines exactly one submenu, return just that submenu.
201 Otherwise return the whole menu."
202 (if menubar
203 (let (submap)
204 (map-keymap
205 (lambda (k v) (setq submap (if submap t (cons k v))))
206 (keymap-canonicalize menubar))
207 (if (eq submap t)
208 menubar
209 (lookup-key menubar (vector (car submap)))))))
210
211 (defun mouse-menu-bar-map ()
212 "Return a keymap equivalent to the menu bar.
213 The contents are the items that would be in the menu bar whether or
214 not it is actually displayed."
215 (let* ((local-menu (and (current-local-map)
216 (lookup-key (current-local-map) [menu-bar])))
217 (global-menu (lookup-key global-map [menu-bar]))
218 ;; If a keymap doesn't have a prompt string (a lazy
219 ;; programmer didn't bother to provide one), create it and
220 ;; insert it into the keymap; each keymap gets its own
221 ;; prompt. This is required for non-toolkit versions to
222 ;; display non-empty menu pane names.
223 (minor-mode-menus
224 (mapcar
225 (lambda (menu)
226 (let* ((minor-mode (car menu))
227 (menu (cdr menu))
228 (title-or-map (cadr menu)))
229 (or (stringp title-or-map)
230 (setq menu
231 (cons 'keymap
232 (cons (concat
233 (capitalize (subst-char-in-string
234 ?- ?\s (symbol-name
235 minor-mode)))
236 " Menu")
237 (cdr menu)))))
238 menu))
239 (minor-mode-key-binding [menu-bar])))
240 (local-title-or-map (and local-menu (cadr local-menu)))
241 (global-title-or-map (cadr global-menu)))
242 (or (null local-menu)
243 (stringp local-title-or-map)
244 (setq local-menu (cons 'keymap
245 (cons (concat (format-mode-line mode-name)
246 " Mode Menu")
247 (cdr local-menu)))))
248 (or (stringp global-title-or-map)
249 (setq global-menu (cons 'keymap
250 (cons "Global Menu"
251 (cdr global-menu)))))
252 ;; Supplying the list is faster than making a new map.
253 ;; FIXME: We have a problem here: we have to use the global/local/minor
254 ;; so they're displayed in the expected order, but later on in the command
255 ;; loop, they're actually looked up in the opposite order.
256 (apply 'append
257 global-menu
258 local-menu
259 minor-mode-menus)))
260
261 (defun mouse-major-mode-menu (event &optional prefix)
262 "Pop up a mode-specific menu of mouse commands.
263 Default to the Edit menu if the major mode doesn't define a menu."
264 (interactive "@e\nP")
265 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
266 (popup-menu (mouse-menu-major-mode-map) event prefix))
267 (make-obsolete 'mouse-major-mode-menu 'mouse-menu-major-mode-map "23.1")
268
269 (defun mouse-popup-menubar (event prefix)
270 "Pop up a menu equivalent to the menu bar for keyboard EVENT with PREFIX.
271 The contents are the items that would be in the menu bar whether or
272 not it is actually displayed."
273 (interactive "@e \nP")
274 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
275 (popup-menu (mouse-menu-bar-map) event prefix))
276 (make-obsolete 'mouse-popup-menubar 'mouse-menu-bar-map "23.1")
277
278 (defun mouse-popup-menubar-stuff (event prefix)
279 "Popup a menu like either `mouse-major-mode-menu' or `mouse-popup-menubar'.
280 Use the former if the menu bar is showing, otherwise the latter."
281 (interactive "@e\nP")
282 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
283 (popup-menu
284 (if (zerop (or (frame-parameter nil 'menu-bar-lines) 0))
285 (mouse-menu-bar-map)
286 (mouse-menu-major-mode-map))
287 event prefix))
288 (make-obsolete 'mouse-popup-menubar-stuff nil "23.1")
289 \f
290 ;; Commands that operate on windows.
291
292 (defun mouse-minibuffer-check (event)
293 (let ((w (posn-window (event-start event))))
294 (and (window-minibuffer-p w)
295 (not (minibuffer-window-active-p w))
296 (error "Minibuffer window is not active")))
297 ;; Give temporary modes such as isearch a chance to turn off.
298 (run-hooks 'mouse-leave-buffer-hook))
299
300 (defun mouse-delete-window (click)
301 "Delete the window you click on.
302 Do nothing if the frame has just one window.
303 This command must be bound to a mouse click."
304 (interactive "e")
305 (unless (one-window-p t)
306 (mouse-minibuffer-check click)
307 (delete-window (posn-window (event-start click)))))
308
309 (defun mouse-select-window (click)
310 "Select the window clicked on; don't move point."
311 (interactive "e")
312 (mouse-minibuffer-check click)
313 (let ((oframe (selected-frame))
314 (frame (window-frame (posn-window (event-start click)))))
315 (select-window (posn-window (event-start click)))
316 (raise-frame frame)
317 (select-frame frame)
318 (or (eq frame oframe)
319 (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
320
321 (defun mouse-tear-off-window (click)
322 "Delete the window clicked on, and create a new frame displaying its buffer."
323 (interactive "e")
324 (mouse-minibuffer-check click)
325 (let* ((window (posn-window (event-start click)))
326 (buf (window-buffer window))
327 (frame (make-frame)))
328 (select-frame frame)
329 (switch-to-buffer buf)
330 (delete-window window)))
331
332 (defun mouse-delete-other-windows ()
333 "Delete all windows except the one you click on."
334 (interactive "@")
335 (delete-other-windows))
336
337 (defun mouse-split-window-vertically (click)
338 "Select Emacs window mouse is on, then split it vertically in half.
339 The window is split at the line clicked on.
340 This command must be bound to a mouse click."
341 (interactive "@e")
342 (mouse-minibuffer-check click)
343 (let ((start (event-start click)))
344 (select-window (posn-window start))
345 (let ((new-height (1+ (cdr (posn-col-row (event-end click)))))
346 (first-line window-min-height)
347 (last-line (- (window-height) window-min-height)))
348 (if (< last-line first-line)
349 (error "Window too short to split")
350 (split-window-vertically
351 (min (max new-height first-line) last-line))))))
352
353 (defun mouse-split-window-horizontally (click)
354 "Select Emacs window mouse is on, then split it horizontally in half.
355 The window is split at the column clicked on.
356 This command must be bound to a mouse click."
357 (interactive "@e")
358 (mouse-minibuffer-check click)
359 (let ((start (event-start click)))
360 (select-window (posn-window start))
361 (let ((new-width (1+ (car (posn-col-row (event-end click)))))
362 (first-col window-min-width)
363 (last-col (- (window-width) window-min-width)))
364 (if (< last-col first-col)
365 (error "Window too narrow to split")
366 (split-window-horizontally
367 (min (max new-width first-col) last-col))))))
368
369 (defun mouse-drag-window-above (window)
370 "Return the (or a) window directly above WINDOW.
371 That means one whose bottom edge is at the same height as WINDOW's top edge."
372 (let ((start-top (nth 1 (window-edges window)))
373 (start-left (nth 0 (window-edges window)))
374 (start-right (nth 2 (window-edges window)))
375 (start-window window)
376 above-window)
377 (setq window (previous-window window 0))
378 (while (and (not above-window) (not (eq window start-window)))
379 (let ((left (nth 0 (window-edges window)))
380 (right (nth 2 (window-edges window))))
381 (when (and (= (+ (window-height window) (nth 1 (window-edges window)))
382 start-top)
383 (or (and (<= left start-left) (<= start-right right))
384 (and (<= start-left left) (<= left start-right))
385 (and (<= start-left right) (<= right start-right))))
386 (setq above-window window)))
387 (setq window (previous-window window)))
388 above-window))
389
390 (defun mouse-drag-move-window-bottom (window growth)
391 "Move the bottom of WINDOW up or down by GROWTH lines.
392 Move it down if GROWTH is positive, or up if GROWTH is negative.
393 If this would make WINDOW too short,
394 shrink the window or windows above it to make room."
395 (condition-case nil
396 (adjust-window-trailing-edge window growth nil)
397 (error nil)))
398
399 (defsubst mouse-drag-move-window-top (window growth)
400 "Move the top of WINDOW up or down by GROWTH lines.
401 Move it down if GROWTH is positive, or up if GROWTH is negative.
402 If this would make WINDOW too short, shrink the window or windows
403 above it to make room."
404 ;; Moving the top of WINDOW is actually moving the bottom of the
405 ;; window above.
406 (let ((window-above (mouse-drag-window-above window)))
407 (and window-above
408 (mouse-drag-move-window-bottom window-above (- growth)))))
409
410 (defun mouse-drag-mode-line-1 (start-event mode-line-p)
411 "Change the height of a window by dragging on the mode or header line.
412 START-EVENT is the starting mouse-event of the drag action.
413 MODE-LINE-P non-nil means dragging a mode line; nil means a header line."
414 ;; Give temporary modes such as isearch a chance to turn off.
415 (run-hooks 'mouse-leave-buffer-hook)
416 (let* ((done nil)
417 (echo-keystrokes 0)
418 (start (event-start start-event))
419 (start-event-window (posn-window start))
420 (start-event-frame (window-frame start-event-window))
421 (start-nwindows (count-windows t))
422 (minibuffer (frame-parameter nil 'minibuffer))
423 should-enlarge-minibuffer event mouse y top bot edges wconfig growth)
424 (track-mouse
425 (progn
426 ;; if this is the bottommost ordinary window, then to
427 ;; move its modeline the minibuffer must be enlarged.
428 (setq should-enlarge-minibuffer
429 (and minibuffer
430 mode-line-p
431 (not (one-window-p t))
432 (= (nth 1 (window-edges minibuffer))
433 (nth 3 (window-edges start-event-window)))))
434
435 ;; loop reading events and sampling the position of
436 ;; the mouse.
437 (while (not done)
438 (setq event (read-event)
439 mouse (mouse-position))
440
441 ;; do nothing if
442 ;; - there is a switch-frame event.
443 ;; - the mouse isn't in the frame that we started in
444 ;; - the mouse isn't in any Emacs frame
445 ;; drag if
446 ;; - there is a mouse-movement event
447 ;; - there is a scroll-bar-movement event
448 ;; (same as mouse movement for our purposes)
449 ;; quit if
450 ;; - there is a keyboard event or some other unknown event.
451 (cond ((not (consp event))
452 (setq done t))
453
454 ((memq (car event) '(switch-frame select-window))
455 nil)
456
457 ((not (memq (car event) '(mouse-movement scroll-bar-movement)))
458 (when (consp event)
459 ;; Do not unread a drag-mouse-1 event since it will cause the
460 ;; selection of the window above when dragging the modeline
461 ;; above the selected window.
462 (unless (eq (car event) 'drag-mouse-1)
463 (push event unread-command-events)))
464 (setq done t))
465
466 ((not (eq (car mouse) start-event-frame))
467 nil)
468
469 ((null (car (cdr mouse)))
470 nil)
471
472 (t
473 (setq y (cdr (cdr mouse))
474 edges (window-edges start-event-window)
475 top (nth 1 edges)
476 bot (nth 3 edges))
477
478 ;; compute size change needed
479 (cond (mode-line-p
480 (setq growth (- y bot -1)))
481 (t ; header line
482 (when (< (- bot y) window-min-height)
483 (setq y (- bot window-min-height)))
484 ;; The window's top includes the header line!
485 (setq growth (- top y))))
486 (setq wconfig (current-window-configuration))
487
488 ;; Check for an error case.
489 (when (and (/= growth 0)
490 (not minibuffer)
491 (one-window-p t))
492 (error "Attempt to resize sole window"))
493
494 ;; grow/shrink minibuffer?
495 (if should-enlarge-minibuffer
496 (unless resize-mini-windows
497 (mouse-drag-move-window-bottom start-event-window growth))
498 ;; no. grow/shrink the selected window
499 ;(message "growth = %d" growth)
500 (if mode-line-p
501 (mouse-drag-move-window-bottom start-event-window growth)
502 (mouse-drag-move-window-top start-event-window growth)))
503
504 ;; if this window's growth caused another
505 ;; window to be deleted because it was too
506 ;; short, rescind the change.
507 ;;
508 ;; if size change caused space to be stolen
509 ;; from a window above this one, rescind the
510 ;; change, but only if we didn't grow/shrink
511 ;; the minibuffer. minibuffer size changes
512 ;; can cause all windows to shrink... no way
513 ;; around it.
514 (when (or (/= start-nwindows (count-windows t))
515 (and (not should-enlarge-minibuffer)
516 (> growth 0)
517 mode-line-p
518 (/= top
519 (nth 1 (window-edges
520 ;; Choose right window.
521 start-event-window)))))
522 (set-window-configuration wconfig)))))))))
523
524 (defun mouse-drag-mode-line (start-event)
525 "Change the height of a window by dragging on the mode line."
526 (interactive "e")
527 (mouse-drag-mode-line-1 start-event t))
528
529 (defun mouse-drag-header-line (start-event)
530 "Change the height of a window by dragging on the header line.
531 Windows whose header-lines are at the top of the frame cannot be
532 resized by dragging their header-line."
533 (interactive "e")
534 ;; Changing the window's size by dragging its header-line when the
535 ;; header-line is at the top of the frame is somewhat strange,
536 ;; because the header-line doesn't move, so don't do it.
537 (let* ((start (event-start start-event))
538 (window (posn-window start))
539 (frame (window-frame window))
540 (first-window (frame-first-window frame)))
541 (unless (or (eq window first-window)
542 (= (nth 1 (window-edges window))
543 (nth 1 (window-edges first-window))))
544 (mouse-drag-mode-line-1 start-event nil))))
545
546 \f
547 (defun mouse-drag-vertical-line-rightward-window (window)
548 "Return a window that is immediately to the right of WINDOW, or nil."
549 (let ((bottom (nth 3 (window-inside-edges window)))
550 (left (nth 0 (window-inside-edges window)))
551 best best-right
552 (try (previous-window window)))
553 (while (not (eq try window))
554 (let ((try-top (nth 1 (window-inside-edges try)))
555 (try-bottom (nth 3 (window-inside-edges try)))
556 (try-right (nth 2 (window-inside-edges try))))
557 (if (and (< try-top bottom)
558 (>= try-bottom bottom)
559 (< try-right left)
560 (or (null best-right) (> try-right best-right)))
561 (setq best-right try-right best try)))
562 (setq try (previous-window try)))
563 best))
564
565 (defun mouse-drag-vertical-line (start-event)
566 "Change the width of a window by dragging on the vertical line."
567 (interactive "e")
568 ;; Give temporary modes such as isearch a chance to turn off.
569 (run-hooks 'mouse-leave-buffer-hook)
570 (let* ((done nil)
571 (echo-keystrokes 0)
572 (start-event-frame (window-frame (car (car (cdr start-event)))))
573 (start-event-window (car (car (cdr start-event))))
574 event mouse x left right edges growth
575 (which-side
576 (or (cdr (assq 'vertical-scroll-bars (frame-parameters start-event-frame)))
577 'right)))
578 (cond
579 ((one-window-p t)
580 (error "Attempt to resize sole ordinary window"))
581 ((and (eq which-side 'right)
582 (>= (nth 2 (window-inside-edges start-event-window))
583 (frame-width start-event-frame)))
584 (error "Attempt to drag rightmost scrollbar"))
585 ((and (eq which-side 'left)
586 (= (nth 0 (window-inside-edges start-event-window)) 0))
587 (error "Attempt to drag leftmost scrollbar")))
588 (track-mouse
589 (progn
590 ;; loop reading events and sampling the position of
591 ;; the mouse.
592 (while (not done)
593 (setq event (read-event)
594 mouse (mouse-position))
595 ;; do nothing if
596 ;; - there is a switch-frame event.
597 ;; - the mouse isn't in the frame that we started in
598 ;; - the mouse isn't in any Emacs frame
599 ;; drag if
600 ;; - there is a mouse-movement event
601 ;; - there is a scroll-bar-movement event
602 ;; (same as mouse movement for our purposes)
603 ;; quit if
604 ;; - there is a keyboard event or some other unknown event
605 ;; unknown event.
606 (cond ((integerp event)
607 (setq done t))
608 ((memq (car event) '(switch-frame select-window))
609 nil)
610 ((not (memq (car event)
611 '(mouse-movement scroll-bar-movement)))
612 (if (consp event)
613 (setq unread-command-events
614 (cons event unread-command-events)))
615 (setq done t))
616 ((not (eq (car mouse) start-event-frame))
617 nil)
618 ((null (car (cdr mouse)))
619 nil)
620 (t
621 (let ((window
622 ;; If the scroll bar is on the window's left,
623 ;; adjust the window on the left.
624 (if (eq which-side 'right)
625 start-event-window
626 (mouse-drag-vertical-line-rightward-window
627 start-event-window))))
628 (setq x (- (car (cdr mouse))
629 (if (eq which-side 'right) 0 2))
630 edges (window-edges window)
631 left (nth 0 edges)
632 right (nth 2 edges))
633 ;; scale back a move that would make the
634 ;; window too thin.
635 (if (< (- x left -1) window-min-width)
636 (setq x (+ left window-min-width -1)))
637 ;; compute size change needed
638 (setq growth (- x right -1))
639 (condition-case nil
640 (adjust-window-trailing-edge window growth t)
641 (error nil))))))))))
642 \f
643 (defun mouse-set-point (event)
644 "Move point to the position clicked on with the mouse.
645 This should be bound to a mouse click event type."
646 (interactive "e")
647 (mouse-minibuffer-check event)
648 ;; Use event-end in case called from mouse-drag-region.
649 ;; If EVENT is a click, event-end and event-start give same value.
650 (posn-set-point (event-end event)))
651
652 (defvar mouse-last-region-beg nil)
653 (defvar mouse-last-region-end nil)
654 (defvar mouse-last-region-tick nil)
655
656 (defun mouse-region-match ()
657 "Return non-nil if there's an active region that was set with the mouse."
658 (and (mark t) mark-active
659 (eq mouse-last-region-beg (region-beginning))
660 (eq mouse-last-region-end (region-end))
661 (eq mouse-last-region-tick (buffer-modified-tick))))
662
663 (defun mouse-set-region (click)
664 "Set the region to the text dragged over, and copy to kill ring.
665 This should be bound to a mouse drag event."
666 (interactive "e")
667 (mouse-minibuffer-check click)
668 (let ((posn (event-start click))
669 (end (event-end click)))
670 (select-window (posn-window posn))
671 (if (numberp (posn-point posn))
672 (goto-char (posn-point posn)))
673 ;; If mark is highlighted, no need to bounce the cursor.
674 ;; On X, we highlight while dragging, thus once again no need to bounce.
675 (or transient-mark-mode
676 (memq (framep (selected-frame)) '(x pc w32 ns))
677 (sit-for 1))
678 (push-mark)
679 (set-mark (point))
680 (if (numberp (posn-point end))
681 (goto-char (posn-point end)))
682 ;; Don't set this-command to kill-region, so that a following
683 ;; C-w will not double the text in the kill ring.
684 ;; Ignore last-command so we don't append to a preceding kill.
685 (when mouse-drag-copy-region
686 (let (this-command last-command deactivate-mark)
687 (copy-region-as-kill (mark) (point))))
688 (mouse-set-region-1)))
689
690 (defun mouse-set-region-1 ()
691 ;; Set transient-mark-mode for a little while.
692 (unless (eq (car-safe transient-mark-mode) 'only)
693 (setq transient-mark-mode
694 (cons 'only
695 (unless (eq transient-mark-mode 'lambda)
696 transient-mark-mode))))
697 (setq mouse-last-region-beg (region-beginning))
698 (setq mouse-last-region-end (region-end))
699 (setq mouse-last-region-tick (buffer-modified-tick)))
700
701 (defcustom mouse-scroll-delay 0.25
702 "The pause between scroll steps caused by mouse drags, in seconds.
703 If you drag the mouse beyond the edge of a window, Emacs scrolls the
704 window to bring the text beyond that edge into view, with a delay of
705 this many seconds between scroll steps. Scrolling stops when you move
706 the mouse back into the window, or release the button.
707 This variable's value may be non-integral.
708 Setting this to zero causes Emacs to scroll as fast as it can."
709 :type 'number
710 :group 'mouse)
711
712 (defcustom mouse-scroll-min-lines 1
713 "The minimum number of lines scrolled by dragging mouse out of window.
714 Moving the mouse out the top or bottom edge of the window begins
715 scrolling repeatedly. The number of lines scrolled per repetition
716 is normally equal to the number of lines beyond the window edge that
717 the mouse has moved. However, it always scrolls at least the number
718 of lines specified by this variable."
719 :type 'integer
720 :group 'mouse)
721
722 (defun mouse-scroll-subr (window jump &optional overlay start)
723 "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
724 If OVERLAY is an overlay, let it stretch from START to the far edge of
725 the newly visible text.
726 Upon exit, point is at the far edge of the newly visible text."
727 (cond
728 ((and (> jump 0) (< jump mouse-scroll-min-lines))
729 (setq jump mouse-scroll-min-lines))
730 ((and (< jump 0) (< (- jump) mouse-scroll-min-lines))
731 (setq jump (- mouse-scroll-min-lines))))
732 (let ((opoint (point)))
733 (while (progn
734 (goto-char (window-start window))
735 (if (not (zerop (vertical-motion jump window)))
736 (progn
737 (set-window-start window (point))
738 (if (natnump jump)
739 (if (window-end window)
740 (progn
741 (goto-char (window-end window))
742 ;; window-end doesn't reflect the window's new
743 ;; start position until the next redisplay.
744 (vertical-motion (1- jump) window))
745 (vertical-motion (- (window-height window) 2)))
746 (goto-char (window-start window)))
747 (if overlay
748 (move-overlay overlay start (point)))
749 ;; Now that we have scrolled WINDOW properly,
750 ;; put point back where it was for the redisplay
751 ;; so that we don't mess up the selected window.
752 (or (eq window (selected-window))
753 (goto-char opoint))
754 (sit-for mouse-scroll-delay)))))
755 (or (eq window (selected-window))
756 (goto-char opoint))))
757
758 ;; Create an overlay and immediately delete it, to get "overlay in no buffer".
759 (defconst mouse-drag-overlay
760 (let ((ol (make-overlay (point-min) (point-min))))
761 (delete-overlay ol)
762 (overlay-put ol 'face 'region)
763 ol))
764
765 (defvar mouse-selection-click-count 0)
766
767 (defvar mouse-selection-click-count-buffer nil)
768
769 (defun mouse-drag-region (start-event)
770 "Set the region to the text that the mouse is dragged over.
771 Highlight the drag area as you move the mouse.
772 This must be bound to a button-down mouse event.
773 In Transient Mark mode, the highlighting remains as long as the mark
774 remains active. Otherwise, it remains until the next input event.
775
776 If the click is in the echo area, display the `*Messages*' buffer."
777 (interactive "e")
778 (let ((w (posn-window (event-start start-event))))
779 (if (and (window-minibuffer-p w)
780 (not (minibuffer-window-active-p w)))
781 (save-excursion
782 ;; Swallow the up-event.
783 (read-event)
784 (set-buffer (get-buffer-create "*Messages*"))
785 (goto-char (point-max))
786 (display-buffer (current-buffer)))
787 ;; Give temporary modes such as isearch a chance to turn off.
788 (run-hooks 'mouse-leave-buffer-hook)
789 (mouse-drag-track start-event t))))
790
791
792 (defun mouse-posn-property (pos property)
793 "Look for a property at click position.
794 POS may be either a buffer position or a click position like
795 those returned from `event-start'. If the click position is on
796 a string, the text property PROPERTY is examined.
797 If this is nil or the click is not on a string, then
798 the corresponding buffer position is searched for PROPERTY.
799 If PROPERTY is encountered in one of those places,
800 its value is returned."
801 (if (consp pos)
802 (let ((w (posn-window pos)) (pt (posn-point pos))
803 (str (posn-string pos)))
804 (or (and str
805 (get-text-property (cdr str) property (car str)))
806 (and pt
807 (get-char-property pt property w))))
808 (get-char-property pos property)))
809
810 (defun mouse-on-link-p (pos)
811 "Return non-nil if POS is on a link in the current buffer.
812 POS must be a buffer position in the current buffer or a mouse
813 event location in the selected window (see `event-start').
814 However, if `mouse-1-click-in-non-selected-windows' is non-nil,
815 POS may be a mouse event location in any window.
816
817 A clickable link is identified by one of the following methods:
818
819 - If the character at POS has a non-nil `follow-link' text or
820 overlay property, the value of that property determines what to do.
821
822 - If there is a local key-binding or a keybinding at position POS
823 for the `follow-link' event, the binding of that event determines
824 what to do.
825
826 The resulting value determine whether POS is inside a link:
827
828 - If the value is `mouse-face', POS is inside a link if there
829 is a non-nil `mouse-face' property at POS. Return t in this case.
830
831 - If the value is a function, FUNC, POS is inside a link if
832 the call \(FUNC POS) returns non-nil. Return the return value
833 from that call. Arg is \(posn-point POS) if POS is a mouse event.
834
835 - Otherwise, return the value itself.
836
837 The return value is interpreted as follows:
838
839 - If it is a string, the mouse-1 event is translated into the
840 first character of the string, i.e. the action of the mouse-1
841 click is the local or global binding of that character.
842
843 - If it is a vector, the mouse-1 event is translated into the
844 first element of that vector, i.e. the action of the mouse-1
845 click is the local or global binding of that event.
846
847 - Otherwise, the mouse-1 event is translated into a mouse-2 event
848 at the same position."
849 (let ((action
850 (and (or (not (consp pos))
851 mouse-1-click-in-non-selected-windows
852 (eq (selected-window) (posn-window pos)))
853 (or (mouse-posn-property pos 'follow-link)
854 (key-binding [follow-link] nil t pos)))))
855 (cond
856 ((eq action 'mouse-face)
857 (and (mouse-posn-property pos 'mouse-face) t))
858 ((functionp action)
859 ;; FIXME: This seems questionable if the click is not in a buffer.
860 ;; Should we instead decide that `action' takes a `posn'?
861 (if (consp pos)
862 (with-current-buffer (window-buffer (posn-window pos))
863 (funcall action (posn-point pos)))
864 (funcall action pos)))
865 (t action))))
866
867 (defun mouse-fixup-help-message (msg)
868 "Fix help message MSG for `mouse-1-click-follows-link'."
869 (let (mp pos)
870 (if (and mouse-1-click-follows-link
871 (stringp msg)
872 (save-match-data
873 (string-match "^mouse-2" msg))
874 (setq mp (mouse-pixel-position))
875 (consp (setq pos (cdr mp)))
876 (car pos) (>= (car pos) 0)
877 (cdr pos) (>= (cdr pos) 0)
878 (setq pos (posn-at-x-y (car pos) (cdr pos) (car mp)))
879 (windowp (posn-window pos)))
880 (with-current-buffer (window-buffer (posn-window pos))
881 (if (mouse-on-link-p pos)
882 (setq msg (concat
883 (cond
884 ((eq mouse-1-click-follows-link 'double) "double-")
885 ((and (integerp mouse-1-click-follows-link)
886 (< mouse-1-click-follows-link 0)) "Long ")
887 (t ""))
888 "mouse-1" (substring msg 7)))))))
889 msg)
890
891 (defun mouse-move-drag-overlay (ol start end mode)
892 (unless (= start end)
893 ;; Go to START first, so that when we move to END, if it's in the middle
894 ;; of intangible text, point jumps in the direction away from START.
895 ;; Don't do it if START=END otherwise a single click risks selecting
896 ;; a region if it's on intangible text. This exception was originally
897 ;; only applied on entry to mouse-drag-region, which had the problem
898 ;; that a tiny move during a single-click would cause the intangible
899 ;; text to be selected.
900 (goto-char start)
901 (goto-char end)
902 (setq end (point)))
903 (let ((range (mouse-start-end start end mode)))
904 (move-overlay ol (car range) (nth 1 range))))
905
906 (defun mouse-drag-track (start-event &optional
907 do-mouse-drag-region-post-process)
908 "Track mouse drags by highlighting area between point and cursor.
909 The region will be defined with mark and point, and the overlay
910 will be deleted after return. DO-MOUSE-DRAG-REGION-POST-PROCESS
911 should only be used by mouse-drag-region."
912 (mouse-minibuffer-check start-event)
913 (setq mouse-selection-click-count-buffer (current-buffer))
914 (let* ((original-window (selected-window))
915 ;; We've recorded what we needed from the current buffer and
916 ;; window, now let's jump to the place of the event, where things
917 ;; are happening.
918 (_ (mouse-set-point start-event))
919 (echo-keystrokes 0)
920 (start-posn (event-start start-event))
921 (start-point (posn-point start-posn))
922 (start-window (posn-window start-posn))
923 (start-window-start (window-start start-window))
924 (start-hscroll (window-hscroll start-window))
925 (bounds (window-edges start-window))
926 (make-cursor-line-fully-visible nil)
927 (top (nth 1 bounds))
928 (bottom (if (window-minibuffer-p start-window)
929 (nth 3 bounds)
930 ;; Don't count the mode line.
931 (1- (nth 3 bounds))))
932 (on-link (and mouse-1-click-follows-link
933 (or mouse-1-click-in-non-selected-windows
934 (eq start-window original-window))
935 ;; Use start-point before the intangibility
936 ;; treatment, in case we click on a link inside an
937 ;; intangible text.
938 (mouse-on-link-p start-posn)))
939 (click-count (1- (event-click-count start-event)))
940 (remap-double-click (and on-link
941 (eq mouse-1-click-follows-link 'double)
942 (= click-count 1)))
943 ;; Suppress automatic hscrolling, because that is a nuisance
944 ;; when setting point near the right fringe (but see below).
945 (automatic-hscrolling-saved automatic-hscrolling)
946 (automatic-hscrolling nil))
947 (setq mouse-selection-click-count click-count)
948 ;; In case the down click is in the middle of some intangible text,
949 ;; use the end of that text, and put it in START-POINT.
950 (if (< (point) start-point)
951 (goto-char start-point))
952 (setq start-point (point))
953 (if remap-double-click ;; Don't expand mouse overlay in links
954 (setq click-count 0))
955 (mouse-move-drag-overlay mouse-drag-overlay start-point start-point
956 click-count)
957 (overlay-put mouse-drag-overlay 'window start-window)
958 (deactivate-mark)
959 (let (event end end-point last-end-point)
960 (track-mouse
961 (while (progn
962 (setq event (read-event))
963 (or (mouse-movement-p event)
964 (memq (car-safe event) '(switch-frame select-window))))
965 (if (memq (car-safe event) '(switch-frame select-window))
966 nil
967 ;; Automatic hscrolling did not occur during the call to
968 ;; `read-event'; but if the user subsequently drags the
969 ;; mouse, go ahead and hscroll.
970 (let ((automatic-hscrolling automatic-hscrolling-saved))
971 (redisplay))
972 (setq end (event-end event)
973 end-point (posn-point end))
974 (if (numberp end-point)
975 (setq last-end-point end-point))
976
977 (cond
978 ;; Are we moving within the original window?
979 ((and (eq (posn-window end) start-window)
980 (integer-or-marker-p end-point))
981 (mouse-move-drag-overlay mouse-drag-overlay start-point end-point click-count))
982
983 (t
984 (let ((mouse-row (cdr (cdr (mouse-position)))))
985 (cond
986 ((null mouse-row))
987 ((< mouse-row top)
988 (mouse-scroll-subr start-window (- mouse-row top)
989 mouse-drag-overlay start-point))
990 ((>= mouse-row bottom)
991 (mouse-scroll-subr start-window (1+ (- mouse-row bottom))
992 mouse-drag-overlay start-point)))))))))
993
994 ;; In case we did not get a mouse-motion event
995 ;; for the final move of the mouse before a drag event
996 ;; pretend that we did get one.
997 (when (and (memq 'drag (event-modifiers (car-safe event)))
998 (setq end (event-end event)
999 end-point (posn-point end))
1000 (eq (posn-window end) start-window)
1001 (integer-or-marker-p end-point))
1002 (mouse-move-drag-overlay mouse-drag-overlay start-point end-point click-count))
1003
1004 ;; Handle the terminating event
1005 (if (consp event)
1006 (let* ((fun (key-binding (vector (car event))))
1007 (do-multi-click (and (> (event-click-count event) 0)
1008 (functionp fun)
1009 (not (memq fun
1010 '(mouse-set-point
1011 mouse-set-region))))))
1012 ;; Run the binding of the terminating up-event, if possible.
1013 (if (and (not (= (overlay-start mouse-drag-overlay)
1014 (overlay-end mouse-drag-overlay)))
1015 (not do-multi-click))
1016 (let* ((stop-point
1017 (if (numberp (posn-point (event-end event)))
1018 (posn-point (event-end event))
1019 last-end-point))
1020 ;; The end that comes from where we ended the drag.
1021 ;; Point goes here.
1022 (region-termination
1023 (if (and stop-point (< stop-point start-point))
1024 (overlay-start mouse-drag-overlay)
1025 (overlay-end mouse-drag-overlay)))
1026 ;; The end that comes from where we started the drag.
1027 ;; Mark goes there.
1028 (region-commencement
1029 (- (+ (overlay-end mouse-drag-overlay)
1030 (overlay-start mouse-drag-overlay))
1031 region-termination))
1032 last-command this-command)
1033 (push-mark region-commencement t t)
1034 (goto-char region-termination)
1035 (if (not do-mouse-drag-region-post-process)
1036 ;; Skip all post-event handling, return immediately.
1037 (delete-overlay mouse-drag-overlay)
1038 ;; Don't let copy-region-as-kill set deactivate-mark.
1039 (when mouse-drag-copy-region
1040 (let (deactivate-mark)
1041 (copy-region-as-kill (point) (mark t))))
1042 (let ((buffer (current-buffer)))
1043 (mouse-show-mark)
1044 ;; mouse-show-mark can call read-event,
1045 ;; and that means the Emacs server could switch buffers
1046 ;; under us. If that happened,
1047 ;; avoid trying to use the region.
1048 (and (mark t) mark-active
1049 (eq buffer (current-buffer))
1050 (mouse-set-region-1)))))
1051 ;; Run the binding of the terminating up-event.
1052 ;; If a multiple click is not bound to mouse-set-point,
1053 ;; cancel the effects of mouse-move-drag-overlay to
1054 ;; avoid producing wrong results.
1055 (if do-multi-click (goto-char start-point))
1056 (delete-overlay mouse-drag-overlay)
1057 (when (and (functionp fun)
1058 (= start-hscroll (window-hscroll start-window))
1059 ;; Don't run the up-event handler if the
1060 ;; window start changed in a redisplay after
1061 ;; the mouse-set-point for the down-mouse
1062 ;; event at the beginning of this function.
1063 ;; When the window start has changed, the
1064 ;; up-mouse event will contain a different
1065 ;; position due to the new window contents,
1066 ;; and point is set again.
1067 (or end-point
1068 (= (window-start start-window)
1069 start-window-start)))
1070 (when (and on-link
1071 (or (not end-point) (= end-point start-point))
1072 (consp event)
1073 (or remap-double-click
1074 (and
1075 (not (eq mouse-1-click-follows-link 'double))
1076 (= click-count 0)
1077 (= (event-click-count event) 1)
1078 (or (not (integerp mouse-1-click-follows-link))
1079 (let ((t0 (posn-timestamp (event-start start-event)))
1080 (t1 (posn-timestamp (event-end event))))
1081 (and (integerp t0) (integerp t1)
1082 (if (> mouse-1-click-follows-link 0)
1083 (<= (- t1 t0) mouse-1-click-follows-link)
1084 (< (- t0 t1) mouse-1-click-follows-link))))))))
1085 ;; If we rebind to mouse-2, reselect previous selected window,
1086 ;; so that the mouse-2 event runs in the same
1087 ;; situation as if user had clicked it directly.
1088 ;; Fixes the bug reported by juri@jurta.org on 2005-12-27.
1089 (if (or (vectorp on-link) (stringp on-link))
1090 (setq event (aref on-link 0))
1091 (select-window original-window)
1092 (setcar event 'mouse-2)
1093 ;; If this mouse click has never been done by
1094 ;; the user, it doesn't have the necessary
1095 ;; property to be interpreted correctly.
1096 (put 'mouse-2 'event-kind 'mouse-click)))
1097 (push event unread-command-events))))
1098
1099 ;; Case where the end-event is not a cons cell (it's just a boring
1100 ;; char-key-press).
1101 (delete-overlay mouse-drag-overlay)))))
1102 \f
1103 ;; Commands to handle xterm-style multiple clicks.
1104 (defun mouse-skip-word (dir)
1105 "Skip over word, over whitespace, or over identical punctuation.
1106 If DIR is positive skip forward; if negative, skip backward."
1107 (let* ((char (following-char))
1108 (syntax (char-to-string (char-syntax char))))
1109 (cond ((string= syntax "w")
1110 ;; Here, we can't use skip-syntax-forward/backward because
1111 ;; they don't pay attention to word-separating-categories,
1112 ;; and thus they will skip over a true word boundary. So,
1113 ;; we simulate the original behavior by using forward-word.
1114 (if (< dir 0)
1115 (if (not (looking-at "\\<"))
1116 (forward-word -1))
1117 (if (or (looking-at "\\<") (not (looking-at "\\>")))
1118 (forward-word 1))))
1119 ((string= syntax " ")
1120 (if (< dir 0)
1121 (skip-syntax-backward syntax)
1122 (skip-syntax-forward syntax)))
1123 ((string= syntax "_")
1124 (if (< dir 0)
1125 (skip-syntax-backward "w_")
1126 (skip-syntax-forward "w_")))
1127 ((< dir 0)
1128 (while (and (not (bobp)) (= (preceding-char) char))
1129 (forward-char -1)))
1130 (t
1131 (while (and (not (eobp)) (= (following-char) char))
1132 (forward-char 1))))))
1133
1134 (defun mouse-start-end (start end mode)
1135 "Return a list of region bounds based on START and END according to MODE.
1136 If MODE is 0 then set point to (min START END), mark to (max START END).
1137 If MODE is 1 then set point to start of word at (min START END),
1138 mark to end of word at (max START END).
1139 If MODE is 2 then do the same for lines."
1140 (if (> start end)
1141 (let ((temp start))
1142 (setq start end
1143 end temp)))
1144 (setq mode (mod mode 3))
1145 (cond ((= mode 0)
1146 (list start end))
1147 ((and (= mode 1)
1148 (= start end)
1149 (char-after start)
1150 (= (char-syntax (char-after start)) ?\())
1151 (list start
1152 (save-excursion
1153 (goto-char start)
1154 (forward-sexp 1)
1155 (point))))
1156 ((and (= mode 1)
1157 (= start end)
1158 (char-after start)
1159 (= (char-syntax (char-after start)) ?\)))
1160 (list (save-excursion
1161 (goto-char (1+ start))
1162 (backward-sexp 1)
1163 (point))
1164 (1+ start)))
1165 ((and (= mode 1)
1166 (= start end)
1167 (char-after start)
1168 (= (char-syntax (char-after start)) ?\"))
1169 (let ((open (or (eq start (point-min))
1170 (save-excursion
1171 (goto-char (- start 1))
1172 (looking-at "\\s(\\|\\s \\|\\s>")))))
1173 (if open
1174 (list start
1175 (save-excursion
1176 (condition-case nil
1177 (progn
1178 (goto-char start)
1179 (forward-sexp 1)
1180 (point))
1181 (error end))))
1182 (list (save-excursion
1183 (condition-case nil
1184 (progn
1185 (goto-char (1+ start))
1186 (backward-sexp 1)
1187 (point))
1188 (error end)))
1189 (1+ start)))))
1190 ((= mode 1)
1191 (list (save-excursion
1192 (goto-char start)
1193 (mouse-skip-word -1)
1194 (point))
1195 (save-excursion
1196 (goto-char end)
1197 (mouse-skip-word 1)
1198 (point))))
1199 ((= mode 2)
1200 (list (save-excursion
1201 (goto-char start)
1202 (beginning-of-line 1)
1203 (point))
1204 (save-excursion
1205 (goto-char end)
1206 (forward-line 1)
1207 (point))))))
1208 \f
1209 ;; Subroutine: set the mark where CLICK happened,
1210 ;; but don't do anything else.
1211 (defun mouse-set-mark-fast (click)
1212 (mouse-minibuffer-check click)
1213 (let ((posn (event-start click)))
1214 (select-window (posn-window posn))
1215 (if (numberp (posn-point posn))
1216 (push-mark (posn-point posn) t t))))
1217
1218 (defun mouse-undouble-last-event (events)
1219 (let* ((index (1- (length events)))
1220 (last (nthcdr index events))
1221 (event (car last))
1222 (basic (event-basic-type event))
1223 (old-modifiers (event-modifiers event))
1224 (modifiers (delq 'double (delq 'triple (copy-sequence old-modifiers))))
1225 (new
1226 (if (consp event)
1227 ;; Use reverse, not nreverse, since event-modifiers
1228 ;; does not copy the list it returns.
1229 (cons (event-convert-list (reverse (cons basic modifiers)))
1230 (cdr event))
1231 event)))
1232 (setcar last new)
1233 (if (and (not (equal modifiers old-modifiers))
1234 (key-binding (apply 'vector events)))
1235 t
1236 (setcar last event)
1237 nil)))
1238
1239 ;; Momentarily show where the mark is, if highlighting doesn't show it.
1240
1241 (defcustom mouse-region-delete-keys '([delete] [deletechar] [backspace])
1242 "List of keys that should cause the mouse region to be deleted."
1243 :group 'mouse
1244 :type '(repeat key-sequence))
1245
1246 (defun mouse-show-mark ()
1247 (let ((inhibit-quit t)
1248 (echo-keystrokes 0)
1249 event events key ignore
1250 (x-lost-selection-functions
1251 (when (boundp 'x-lost-selection-functions)
1252 (copy-sequence x-lost-selection-functions))))
1253 (add-hook 'x-lost-selection-functions
1254 (lambda (seltype)
1255 (when (eq seltype 'PRIMARY)
1256 (setq ignore t)
1257 (throw 'mouse-show-mark t))))
1258 (if transient-mark-mode
1259 (delete-overlay mouse-drag-overlay)
1260 (move-overlay mouse-drag-overlay (point) (mark t)))
1261 (catch 'mouse-show-mark
1262 ;; In this loop, execute scroll bar and switch-frame events.
1263 ;; Should we similarly handle `select-window' events? --Stef
1264 ;; Also ignore down-events that are undefined.
1265 (while (progn (setq event (read-event))
1266 (setq events (append events (list event)))
1267 (setq key (apply 'vector events))
1268 (or (and (consp event)
1269 (eq (car event) 'switch-frame))
1270 (and (consp event)
1271 (eq (posn-point (event-end event))
1272 'vertical-scroll-bar))
1273 (and (memq 'down (event-modifiers event))
1274 (not (key-binding key))
1275 (not (mouse-undouble-last-event events))
1276 (not (member key mouse-region-delete-keys)))))
1277 (and (consp event)
1278 (or (eq (car event) 'switch-frame)
1279 (eq (posn-point (event-end event))
1280 'vertical-scroll-bar))
1281 (let ((keys (vector 'vertical-scroll-bar event)))
1282 (and (key-binding keys)
1283 (progn
1284 (call-interactively (key-binding keys)
1285 nil keys)
1286 (setq events nil)))))))
1287 ;; If we lost the selection, just turn off the highlighting.
1288 (unless ignore
1289 ;; For certain special keys, delete the region.
1290 (if (member key mouse-region-delete-keys)
1291 (progn
1292 ;; Since notionally this is a separate command,
1293 ;; run all the hooks that would be run if it were
1294 ;; executed separately.
1295 (run-hooks 'post-command-hook)
1296 (setq last-command this-command)
1297 (setq this-original-command 'delete-region)
1298 (setq this-command (or (command-remapping this-original-command)
1299 this-original-command))
1300 (run-hooks 'pre-command-hook)
1301 (call-interactively this-command))
1302 ;; Otherwise, unread the key so it gets executed normally.
1303 (setq unread-command-events
1304 (nconc events unread-command-events))))
1305 (setq quit-flag nil)
1306 (unless transient-mark-mode
1307 (delete-overlay mouse-drag-overlay))))
1308
1309 (defun mouse-set-mark (click)
1310 "Set mark at the position clicked on with the mouse.
1311 Display cursor at that position for a second.
1312 This must be bound to a mouse click."
1313 (interactive "e")
1314 (mouse-minibuffer-check click)
1315 (select-window (posn-window (event-start click)))
1316 ;; We don't use save-excursion because that preserves the mark too.
1317 (let ((point-save (point)))
1318 (unwind-protect
1319 (progn (mouse-set-point click)
1320 (push-mark nil t t)
1321 (or transient-mark-mode
1322 (sit-for 1)))
1323 (goto-char point-save))))
1324
1325 (defun mouse-kill (click)
1326 "Kill the region between point and the mouse click.
1327 The text is saved in the kill ring, as with \\[kill-region]."
1328 (interactive "e")
1329 (mouse-minibuffer-check click)
1330 (let* ((posn (event-start click))
1331 (click-posn (posn-point posn)))
1332 (select-window (posn-window posn))
1333 (if (numberp click-posn)
1334 (kill-region (min (point) click-posn)
1335 (max (point) click-posn)))))
1336
1337 (defun mouse-yank-at-click (click arg)
1338 "Insert the last stretch of killed text at the position clicked on.
1339 Also move point to one end of the text thus inserted (normally the end),
1340 and set mark at the beginning.
1341 Prefix arguments are interpreted as with \\[yank].
1342 If `mouse-yank-at-point' is non-nil, insert at point
1343 regardless of where you click."
1344 (interactive "e\nP")
1345 ;; Give temporary modes such as isearch a chance to turn off.
1346 (run-hooks 'mouse-leave-buffer-hook)
1347 (or mouse-yank-at-point (mouse-set-point click))
1348 (setq this-command 'yank)
1349 (setq mouse-selection-click-count 0)
1350 (yank arg))
1351
1352 (defun mouse-yank-primary (click)
1353 "Insert the primary selection at the position clicked on.
1354 Move point to the end of the inserted text.
1355 If `mouse-yank-at-point' is non-nil, insert at point
1356 regardless of where you click."
1357 (interactive "e")
1358 ;; Give temporary modes such as isearch a chance to turn off.
1359 (run-hooks 'mouse-leave-buffer-hook)
1360 (or mouse-yank-at-point (mouse-set-point click))
1361 (let ((primary (x-get-selection 'PRIMARY)))
1362 (if primary
1363 (insert (x-get-selection 'PRIMARY))
1364 (error "No primary selection"))))
1365
1366 (defun mouse-kill-ring-save (click)
1367 "Copy the region between point and the mouse click in the kill ring.
1368 This does not delete the region; it acts like \\[kill-ring-save]."
1369 (interactive "e")
1370 (mouse-set-mark-fast click)
1371 (let (this-command last-command)
1372 (kill-ring-save (point) (mark t)))
1373 (mouse-show-mark))
1374
1375 ;; This function used to delete the text between point and the mouse
1376 ;; whenever it was equal to the front of the kill ring, but some
1377 ;; people found that confusing.
1378
1379 ;; A list (TEXT START END), describing the text and position of the last
1380 ;; invocation of mouse-save-then-kill.
1381 (defvar mouse-save-then-kill-posn nil)
1382
1383 (defun mouse-save-then-kill-delete-region (beg end)
1384 ;; We must make our own undo boundaries
1385 ;; because they happen automatically only for the current buffer.
1386 (undo-boundary)
1387 (if (or (= beg end) (eq buffer-undo-list t))
1388 ;; If we have no undo list in this buffer,
1389 ;; just delete.
1390 (delete-region beg end)
1391 ;; Delete, but make the undo-list entry share with the kill ring.
1392 ;; First, delete just one char, so in case buffer is being modified
1393 ;; for the first time, the undo list records that fact.
1394 (let (before-change-functions after-change-functions)
1395 (delete-region beg
1396 (+ beg (if (> end beg) 1 -1))))
1397 (let ((buffer-undo-list buffer-undo-list))
1398 ;; Undo that deletion--but don't change the undo list!
1399 (let (before-change-functions after-change-functions)
1400 (primitive-undo 1 buffer-undo-list))
1401 ;; Now delete the rest of the specified region,
1402 ;; but don't record it.
1403 (setq buffer-undo-list t)
1404 (if (/= (length (car kill-ring)) (- (max end beg) (min end beg)))
1405 (error "Lossage in mouse-save-then-kill-delete-region"))
1406 (delete-region beg end))
1407 (let ((tail buffer-undo-list))
1408 ;; Search back in buffer-undo-list for the string
1409 ;; that came from deleting one character.
1410 (while (and tail (not (stringp (car (car tail)))))
1411 (setq tail (cdr tail)))
1412 ;; Replace it with an entry for the entire deleted text.
1413 (and tail
1414 (setcar tail (cons (car kill-ring) (min beg end))))))
1415 (undo-boundary))
1416
1417 (defun mouse-save-then-kill (click)
1418 "Save text to point in kill ring; the second time, kill the text.
1419 If the text between point and the mouse is the same as what's
1420 at the front of the kill ring, this deletes the text.
1421 Otherwise, it adds the text to the kill ring, like \\[kill-ring-save],
1422 which prepares for a second click to delete the text.
1423
1424 If you have selected words or lines, this command extends the
1425 selection through the word or line clicked on. If you do this
1426 again in a different position, it extends the selection again.
1427 If you do this twice in the same position, the selection is killed."
1428 (interactive "e")
1429 (let ((before-scroll
1430 (with-current-buffer (window-buffer (posn-window (event-start click)))
1431 point-before-scroll)))
1432 (mouse-minibuffer-check click)
1433 (let ((click-posn (posn-point (event-start click)))
1434 ;; Don't let a subsequent kill command append to this one:
1435 ;; prevent setting this-command to kill-region.
1436 (this-command this-command))
1437 (if (and (with-current-buffer
1438 (window-buffer (posn-window (event-start click)))
1439 (and (mark t) (> (mod mouse-selection-click-count 3) 0)
1440 ;; Don't be fooled by a recent click in some other buffer.
1441 (eq mouse-selection-click-count-buffer
1442 (current-buffer)))))
1443 (if (not (and (eq last-command 'mouse-save-then-kill)
1444 (equal click-posn
1445 (car (cdr-safe (cdr-safe mouse-save-then-kill-posn))))))
1446 ;; Find both ends of the object selected by this click.
1447 (let* ((range
1448 (mouse-start-end click-posn click-posn
1449 mouse-selection-click-count)))
1450 ;; Move whichever end is closer to the click.
1451 ;; That's what xterm does, and it seems reasonable.
1452 (if (< (abs (- click-posn (mark t)))
1453 (abs (- click-posn (point))))
1454 (set-mark (car range))
1455 (goto-char (nth 1 range)))
1456 ;; We have already put the old region in the kill ring.
1457 ;; Replace it with the extended region.
1458 ;; (It would be annoying to make a separate entry.)
1459 (kill-new (buffer-substring (point) (mark t)) t)
1460 (mouse-set-region-1)
1461 ;; Arrange for a repeated mouse-3 to kill this region.
1462 (setq mouse-save-then-kill-posn
1463 (list (car kill-ring) (point) click-posn))
1464 (mouse-show-mark))
1465 ;; If we click this button again without moving it,
1466 ;; that time kill.
1467 (mouse-save-then-kill-delete-region (mark) (point))
1468 (setq mouse-selection-click-count 0)
1469 (setq mouse-save-then-kill-posn nil))
1470 (if (and (eq last-command 'mouse-save-then-kill)
1471 mouse-save-then-kill-posn
1472 (eq (car mouse-save-then-kill-posn) (car kill-ring))
1473 (equal (cdr mouse-save-then-kill-posn) (list (point) click-posn)))
1474 ;; If this is the second time we've called
1475 ;; mouse-save-then-kill, delete the text from the buffer.
1476 (progn
1477 (mouse-save-then-kill-delete-region (point) (mark))
1478 ;; After we kill, another click counts as "the first time".
1479 (setq mouse-save-then-kill-posn nil))
1480 ;; This is not a repetition.
1481 ;; We are adjusting an old selection or creating a new one.
1482 (if (or (and (eq last-command 'mouse-save-then-kill)
1483 mouse-save-then-kill-posn)
1484 (and mark-active transient-mark-mode)
1485 (and (memq last-command
1486 '(mouse-drag-region mouse-set-region))
1487 (or mark-even-if-inactive
1488 (not transient-mark-mode))))
1489 ;; We have a selection or suitable region, so adjust it.
1490 (let* ((posn (event-start click))
1491 (new (posn-point posn)))
1492 (select-window (posn-window posn))
1493 (if (numberp new)
1494 (progn
1495 ;; Move whichever end of the region is closer to the click.
1496 ;; That is what xterm does, and it seems reasonable.
1497 (if (<= (abs (- new (point))) (abs (- new (mark t))))
1498 (goto-char new)
1499 (set-mark new))
1500 (setq deactivate-mark nil)))
1501 (kill-new (buffer-substring (point) (mark t)) t))
1502 ;; Set the mark where point is, then move where clicked.
1503 (mouse-set-mark-fast click)
1504 (if before-scroll
1505 (goto-char before-scroll))
1506 (exchange-point-and-mark) ;Why??? --Stef
1507 (kill-new (buffer-substring (point) (mark t))))
1508 (mouse-show-mark)
1509 (mouse-set-region-1)
1510 (setq mouse-save-then-kill-posn
1511 (list (car kill-ring) (point) click-posn)))))))
1512 \f
1513 (global-set-key [M-mouse-1] 'mouse-start-secondary)
1514 (global-set-key [M-drag-mouse-1] 'mouse-set-secondary)
1515 (global-set-key [M-down-mouse-1] 'mouse-drag-secondary)
1516 (global-set-key [M-mouse-3] 'mouse-secondary-save-then-kill)
1517 (global-set-key [M-mouse-2] 'mouse-yank-secondary)
1518
1519 (defconst mouse-secondary-overlay
1520 (let ((ol (make-overlay (point-min) (point-min))))
1521 (delete-overlay ol)
1522 (overlay-put ol 'face 'secondary-selection)
1523 ol)
1524 "An overlay which records the current secondary selection.
1525 It is deleted when there is no secondary selection.")
1526
1527 (defvar mouse-secondary-click-count 0)
1528
1529 ;; A marker which records the specified first end for a secondary selection.
1530 ;; May be nil.
1531 (defvar mouse-secondary-start nil)
1532
1533 (defun mouse-start-secondary (click)
1534 "Set one end of the secondary selection to the position clicked on.
1535 Use \\[mouse-secondary-save-then-kill] to set the other end
1536 and complete the secondary selection."
1537 (interactive "e")
1538 (mouse-minibuffer-check click)
1539 (let ((posn (event-start click)))
1540 (with-current-buffer (window-buffer (posn-window posn))
1541 ;; Cancel any preexisting secondary selection.
1542 (delete-overlay mouse-secondary-overlay)
1543 (if (numberp (posn-point posn))
1544 (progn
1545 (or mouse-secondary-start
1546 (setq mouse-secondary-start (make-marker)))
1547 (move-marker mouse-secondary-start (posn-point posn)))))))
1548
1549 (defun mouse-set-secondary (click)
1550 "Set the secondary selection to the text that the mouse is dragged over.
1551 This must be bound to a mouse drag event."
1552 (interactive "e")
1553 (mouse-minibuffer-check click)
1554 (let ((posn (event-start click))
1555 beg
1556 (end (event-end click)))
1557 (with-current-buffer (window-buffer (posn-window posn))
1558 (if (numberp (posn-point posn))
1559 (setq beg (posn-point posn)))
1560 (move-overlay mouse-secondary-overlay beg (posn-point end))
1561 (x-set-selection
1562 'SECONDARY
1563 (buffer-substring (overlay-start mouse-secondary-overlay)
1564 (overlay-end mouse-secondary-overlay))))))
1565
1566 (defun mouse-drag-secondary (start-event)
1567 "Set the secondary selection to the text that the mouse is dragged over.
1568 Highlight the drag area as you move the mouse.
1569 This must be bound to a button-down mouse event.
1570 The function returns a non-nil value if it creates a secondary selection."
1571 (interactive "e")
1572 (mouse-minibuffer-check start-event)
1573 (let* ((echo-keystrokes 0)
1574 (start-posn (event-start start-event))
1575 (start-point (posn-point start-posn))
1576 (start-window (posn-window start-posn))
1577 (bounds (window-edges start-window))
1578 (top (nth 1 bounds))
1579 (bottom (if (window-minibuffer-p start-window)
1580 (nth 3 bounds)
1581 ;; Don't count the mode line.
1582 (1- (nth 3 bounds))))
1583 (click-count (1- (event-click-count start-event))))
1584 (with-current-buffer (window-buffer start-window)
1585 (setq mouse-secondary-click-count click-count)
1586 (if (> (mod click-count 3) 0)
1587 ;; Double or triple press: make an initial selection
1588 ;; of one word or line.
1589 (let ((range (mouse-start-end start-point start-point click-count)))
1590 (set-marker mouse-secondary-start nil)
1591 ;; Why the double move? --Stef
1592 ;; (move-overlay mouse-secondary-overlay 1 1
1593 ;; (window-buffer start-window))
1594 (move-overlay mouse-secondary-overlay (car range) (nth 1 range)
1595 (window-buffer start-window)))
1596 ;; Single-press: cancel any preexisting secondary selection.
1597 (or mouse-secondary-start
1598 (setq mouse-secondary-start (make-marker)))
1599 (set-marker mouse-secondary-start start-point)
1600 (delete-overlay mouse-secondary-overlay))
1601 (let (event end end-point)
1602 (track-mouse
1603 (while (progn
1604 (setq event (read-event))
1605 (or (mouse-movement-p event)
1606 (memq (car-safe event) '(switch-frame select-window))))
1607
1608 (if (memq (car-safe event) '(switch-frame select-window))
1609 nil
1610 (setq end (event-end event)
1611 end-point (posn-point end))
1612 (cond
1613 ;; Are we moving within the original window?
1614 ((and (eq (posn-window end) start-window)
1615 (integer-or-marker-p end-point))
1616 (let ((range (mouse-start-end start-point end-point
1617 click-count)))
1618 (if (or (/= start-point end-point)
1619 (null (marker-position mouse-secondary-start)))
1620 (progn
1621 (set-marker mouse-secondary-start nil)
1622 (move-overlay mouse-secondary-overlay
1623 (car range) (nth 1 range))))))
1624 (t
1625 (let ((mouse-row (cdr (cdr (mouse-position)))))
1626 (cond
1627 ((null mouse-row))
1628 ((< mouse-row top)
1629 (mouse-scroll-subr start-window (- mouse-row top)
1630 mouse-secondary-overlay start-point))
1631 ((>= mouse-row bottom)
1632 (mouse-scroll-subr start-window (1+ (- mouse-row bottom))
1633 mouse-secondary-overlay start-point)))))))))
1634
1635 (if (consp event)
1636 (if (marker-position mouse-secondary-start)
1637 (save-window-excursion
1638 (delete-overlay mouse-secondary-overlay)
1639 (x-set-selection 'SECONDARY nil)
1640 (select-window start-window)
1641 (save-excursion
1642 (goto-char mouse-secondary-start)
1643 (sit-for 1)
1644 nil))
1645 (x-set-selection
1646 'SECONDARY
1647 (buffer-substring (overlay-start mouse-secondary-overlay)
1648 (overlay-end mouse-secondary-overlay)))))))))
1649
1650 (defun mouse-yank-secondary (click)
1651 "Insert the secondary selection at the position clicked on.
1652 Move point to the end of the inserted text.
1653 If `mouse-yank-at-point' is non-nil, insert at point
1654 regardless of where you click."
1655 (interactive "e")
1656 ;; Give temporary modes such as isearch a chance to turn off.
1657 (run-hooks 'mouse-leave-buffer-hook)
1658 (or mouse-yank-at-point (mouse-set-point click))
1659 (let ((secondary (x-get-selection 'SECONDARY)))
1660 (if secondary
1661 (insert (x-get-selection 'SECONDARY))
1662 (error "No secondary selection"))))
1663
1664 (defun mouse-kill-secondary ()
1665 "Kill the text in the secondary selection.
1666 This is intended more as a keyboard command than as a mouse command
1667 but it can work as either one.
1668
1669 The current buffer (in case of keyboard use), or the buffer clicked on,
1670 must be the one that the secondary selection is in. This requirement
1671 is to prevent accidents."
1672 (interactive)
1673 (let* ((keys (this-command-keys))
1674 (click (elt keys (1- (length keys)))))
1675 (or (eq (overlay-buffer mouse-secondary-overlay)
1676 (if (listp click)
1677 (window-buffer (posn-window (event-start click)))
1678 (current-buffer)))
1679 (error "Select or click on the buffer where the secondary selection is")))
1680 (let (this-command)
1681 (with-current-buffer (overlay-buffer mouse-secondary-overlay)
1682 (kill-region (overlay-start mouse-secondary-overlay)
1683 (overlay-end mouse-secondary-overlay))))
1684 (delete-overlay mouse-secondary-overlay)
1685 ;;; (x-set-selection 'SECONDARY nil)
1686 )
1687
1688 (defun mouse-secondary-save-then-kill (click)
1689 "Save text to point in kill ring; the second time, kill the text.
1690 You must use this in a buffer where you have recently done \\[mouse-start-secondary].
1691 If the text between where you did \\[mouse-start-secondary] and where
1692 you use this command matches the text at the front of the kill ring,
1693 this command deletes the text.
1694 Otherwise, it adds the text to the kill ring, like \\[kill-ring-save],
1695 which prepares for a second click with this command to delete the text.
1696
1697 If you have already made a secondary selection in that buffer,
1698 this command extends or retracts the selection to where you click.
1699 If you do this again in a different position, it extends or retracts
1700 again. If you do this twice in the same position, it kills the selection."
1701 (interactive "e")
1702 (mouse-minibuffer-check click)
1703 (let ((posn (event-start click))
1704 (click-posn (posn-point (event-start click)))
1705 ;; Don't let a subsequent kill command append to this one:
1706 ;; prevent setting this-command to kill-region.
1707 (this-command this-command))
1708 (or (eq (window-buffer (posn-window posn))
1709 (or (overlay-buffer mouse-secondary-overlay)
1710 (if mouse-secondary-start
1711 (marker-buffer mouse-secondary-start))))
1712 (error "Wrong buffer"))
1713 (with-current-buffer (window-buffer (posn-window posn))
1714 (if (> (mod mouse-secondary-click-count 3) 0)
1715 (if (not (and (eq last-command 'mouse-secondary-save-then-kill)
1716 (equal click-posn
1717 (car (cdr-safe (cdr-safe mouse-save-then-kill-posn))))))
1718 ;; Find both ends of the object selected by this click.
1719 (let* ((range
1720 (mouse-start-end click-posn click-posn
1721 mouse-secondary-click-count)))
1722 ;; Move whichever end is closer to the click.
1723 ;; That's what xterm does, and it seems reasonable.
1724 (if (< (abs (- click-posn (overlay-start mouse-secondary-overlay)))
1725 (abs (- click-posn (overlay-end mouse-secondary-overlay))))
1726 (move-overlay mouse-secondary-overlay (car range)
1727 (overlay-end mouse-secondary-overlay))
1728 (move-overlay mouse-secondary-overlay
1729 (overlay-start mouse-secondary-overlay)
1730 (nth 1 range)))
1731 ;; We have already put the old region in the kill ring.
1732 ;; Replace it with the extended region.
1733 ;; (It would be annoying to make a separate entry.)
1734 (kill-new (buffer-substring
1735 (overlay-start mouse-secondary-overlay)
1736 (overlay-end mouse-secondary-overlay)) t)
1737 ;; Arrange for a repeated mouse-3 to kill this region.
1738 (setq mouse-save-then-kill-posn
1739 (list (car kill-ring) (point) click-posn)))
1740 ;; If we click this button again without moving it,
1741 ;; that time kill.
1742 (progn
1743 (mouse-save-then-kill-delete-region
1744 (overlay-start mouse-secondary-overlay)
1745 (overlay-end mouse-secondary-overlay))
1746 (setq mouse-save-then-kill-posn nil)
1747 (setq mouse-secondary-click-count 0)
1748 (delete-overlay mouse-secondary-overlay)))
1749 (if (and (eq last-command 'mouse-secondary-save-then-kill)
1750 mouse-save-then-kill-posn
1751 (eq (car mouse-save-then-kill-posn) (car kill-ring))
1752 (equal (cdr mouse-save-then-kill-posn) (list (point) click-posn)))
1753 ;; If this is the second time we've called
1754 ;; mouse-secondary-save-then-kill, delete the text from the buffer.
1755 (progn
1756 (mouse-save-then-kill-delete-region
1757 (overlay-start mouse-secondary-overlay)
1758 (overlay-end mouse-secondary-overlay))
1759 (setq mouse-save-then-kill-posn nil)
1760 (delete-overlay mouse-secondary-overlay))
1761 (if (overlay-start mouse-secondary-overlay)
1762 ;; We have a selection, so adjust it.
1763 (progn
1764 (if (numberp click-posn)
1765 (progn
1766 ;; Move whichever end of the region is closer to the click.
1767 ;; That is what xterm does, and it seems reasonable.
1768 (if (< (abs (- click-posn (overlay-start mouse-secondary-overlay)))
1769 (abs (- click-posn (overlay-end mouse-secondary-overlay))))
1770 (move-overlay mouse-secondary-overlay click-posn
1771 (overlay-end mouse-secondary-overlay))
1772 (move-overlay mouse-secondary-overlay
1773 (overlay-start mouse-secondary-overlay)
1774 click-posn))
1775 (setq deactivate-mark nil)))
1776 (if (eq last-command 'mouse-secondary-save-then-kill)
1777 ;; If the front of the kill ring comes from
1778 ;; an immediately previous use of this command,
1779 ;; replace it with the extended region.
1780 ;; (It would be annoying to make a separate entry.)
1781 (kill-new (buffer-substring
1782 (overlay-start mouse-secondary-overlay)
1783 (overlay-end mouse-secondary-overlay)) t)
1784 (let (deactivate-mark)
1785 (copy-region-as-kill (overlay-start mouse-secondary-overlay)
1786 (overlay-end mouse-secondary-overlay)))))
1787 (if mouse-secondary-start
1788 ;; All we have is one end of a selection,
1789 ;; so put the other end here.
1790 (let ((start (+ 0 mouse-secondary-start)))
1791 (kill-ring-save start click-posn)
1792 (move-overlay mouse-secondary-overlay start click-posn))))
1793 (setq mouse-save-then-kill-posn
1794 (list (car kill-ring) (point) click-posn))))
1795 (if (overlay-buffer mouse-secondary-overlay)
1796 (x-set-selection 'SECONDARY
1797 (buffer-substring
1798 (overlay-start mouse-secondary-overlay)
1799 (overlay-end mouse-secondary-overlay)))))))
1800 \f
1801 (defcustom mouse-buffer-menu-maxlen 20
1802 "Number of buffers in one pane (submenu) of the buffer menu.
1803 If we have lots of buffers, divide them into groups of
1804 `mouse-buffer-menu-maxlen' and make a pane (or submenu) for each one."
1805 :type 'integer
1806 :group 'mouse)
1807
1808 (defcustom mouse-buffer-menu-mode-mult 4
1809 "Group the buffers by the major mode groups on \\[mouse-buffer-menu]?
1810 This number which determines (in a hairy way) whether \\[mouse-buffer-menu]
1811 will split the buffer menu by the major modes (see
1812 `mouse-buffer-menu-mode-groups') or just by menu length.
1813 Set to 1 (or even 0!) if you want to group by major mode always, and to
1814 a large number if you prefer a mixed multitude. The default is 4."
1815 :type 'integer
1816 :group 'mouse
1817 :version "20.3")
1818
1819 (defvar mouse-buffer-menu-mode-groups
1820 '(("Info\\|Help\\|Apropos\\|Man" . "Help")
1821 ("\\bVM\\b\\|\\bMH\\b\\|Message\\|Mail\\|Group\\|Score\\|Summary\\|Article"
1822 . "Mail/News")
1823 ("\\<C\\>" . "C")
1824 ("ObjC" . "C")
1825 ("Text" . "Text")
1826 ("Outline" . "Text")
1827 ("\\(HT\\|SG\\|X\\|XHT\\)ML" . "SGML")
1828 ("log\\|diff\\|vc\\|cvs\\|Annotate" . "Version Control") ; "Change Management"?
1829 ("Lisp" . "Lisp"))
1830 "How to group various major modes together in \\[mouse-buffer-menu].
1831 Each element has the form (REGEXP . GROUPNAME).
1832 If the major mode's name string matches REGEXP, use GROUPNAME instead.")
1833
1834 (defun mouse-buffer-menu (event)
1835 "Pop up a menu of buffers for selection with the mouse.
1836 This switches buffers in the window that you clicked on,
1837 and selects that window."
1838 (interactive "e")
1839 (mouse-minibuffer-check event)
1840 (let ((buffers (buffer-list)) alist menu split-by-major-mode sum-of-squares)
1841 ;; Make an alist of elements that look like (MENU-ITEM . BUFFER).
1842 (dolist (buf buffers)
1843 ;; Divide all buffers into buckets for various major modes.
1844 ;; Each bucket looks like (MODE NAMESTRING BUFFERS...).
1845 (with-current-buffer buf
1846 (let* ((adjusted-major-mode major-mode) elt)
1847 (dolist (group mouse-buffer-menu-mode-groups)
1848 (when (string-match (car group) (format-mode-line mode-name))
1849 (setq adjusted-major-mode (cdr group))))
1850 (setq elt (assoc adjusted-major-mode split-by-major-mode))
1851 (unless elt
1852 (setq elt (list adjusted-major-mode
1853 (if (stringp adjusted-major-mode)
1854 adjusted-major-mode
1855 (format-mode-line mode-name nil nil buf)))
1856 split-by-major-mode (cons elt split-by-major-mode)))
1857 (or (memq buf (cdr (cdr elt)))
1858 (setcdr (cdr elt) (cons buf (cdr (cdr elt))))))))
1859 ;; Compute the sum of squares of sizes of the major-mode buckets.
1860 (let ((tail split-by-major-mode))
1861 (setq sum-of-squares 0)
1862 (while tail
1863 (setq sum-of-squares
1864 (+ sum-of-squares
1865 (let ((len (length (cdr (cdr (car tail)))))) (* len len))))
1866 (setq tail (cdr tail))))
1867 (if (< (* sum-of-squares mouse-buffer-menu-mode-mult)
1868 (* (length buffers) (length buffers)))
1869 ;; Subdividing by major modes really helps, so let's do it.
1870 (let (subdivided-menus (buffers-left (length buffers)))
1871 ;; Sort the list to put the most popular major modes first.
1872 (setq split-by-major-mode
1873 (sort split-by-major-mode
1874 (function (lambda (elt1 elt2)
1875 (> (length elt1) (length elt2))))))
1876 ;; Make a separate submenu for each major mode
1877 ;; that has more than one buffer,
1878 ;; unless all the remaining buffers are less than 1/10 of them.
1879 (while (and split-by-major-mode
1880 (and (> (length (car split-by-major-mode)) 3)
1881 (> (* buffers-left 10) (length buffers))))
1882 (let ((this-mode-list (mouse-buffer-menu-alist
1883 (cdr (cdr (car split-by-major-mode))))))
1884 (and this-mode-list
1885 (setq subdivided-menus
1886 (cons (cons
1887 (nth 1 (car split-by-major-mode))
1888 this-mode-list)
1889 subdivided-menus))))
1890 (setq buffers-left
1891 (- buffers-left (length (cdr (car split-by-major-mode)))))
1892 (setq split-by-major-mode (cdr split-by-major-mode)))
1893 ;; If any major modes are left over,
1894 ;; make a single submenu for them.
1895 (if split-by-major-mode
1896 (let ((others-list
1897 (mouse-buffer-menu-alist
1898 ;; we don't need split-by-major-mode any more,
1899 ;; so we can ditch it with nconc.
1900 (apply 'nconc (mapcar 'cddr split-by-major-mode)))))
1901 (and others-list
1902 (setq subdivided-menus
1903 (cons (cons "Others" others-list)
1904 subdivided-menus)))))
1905 (setq menu (cons "Buffer Menu" (nreverse subdivided-menus))))
1906 (progn
1907 (setq alist (mouse-buffer-menu-alist buffers))
1908 (setq menu (cons "Buffer Menu"
1909 (mouse-buffer-menu-split "Select Buffer" alist)))))
1910 (let ((buf (x-popup-menu event menu))
1911 (window (posn-window (event-start event))))
1912 (when buf
1913 (select-window
1914 (if (framep window) (frame-selected-window window)
1915 window))
1916 (switch-to-buffer buf)))))
1917
1918 (defun mouse-buffer-menu-alist (buffers)
1919 (let (tail
1920 (maxlen 0)
1921 head)
1922 (setq buffers
1923 (sort buffers
1924 (function (lambda (elt1 elt2)
1925 (string< (buffer-name elt1) (buffer-name elt2))))))
1926 (setq tail buffers)
1927 (while tail
1928 (or (eq ?\s (aref (buffer-name (car tail)) 0))
1929 (setq maxlen
1930 (max maxlen
1931 (length (buffer-name (car tail))))))
1932 (setq tail (cdr tail)))
1933 (setq tail buffers)
1934 (while tail
1935 (let ((elt (car tail)))
1936 (if (/= (aref (buffer-name elt) 0) ?\s)
1937 (setq head
1938 (cons
1939 (cons
1940 (format
1941 (format "%%-%ds %%s%%s %%s" maxlen)
1942 (buffer-name elt)
1943 (if (buffer-modified-p elt) "*" " ")
1944 (save-excursion
1945 (set-buffer elt)
1946 (if buffer-read-only "%" " "))
1947 (or (buffer-file-name elt)
1948 (save-excursion
1949 (set-buffer elt)
1950 (if list-buffers-directory
1951 (expand-file-name
1952 list-buffers-directory)))
1953 ""))
1954 elt)
1955 head))))
1956 (setq tail (cdr tail)))
1957 ;; Compensate for the reversal that the above loop does.
1958 (nreverse head)))
1959
1960 (defun mouse-buffer-menu-split (title alist)
1961 ;; If we have lots of buffers, divide them into groups of 20
1962 ;; and make a pane (or submenu) for each one.
1963 (if (> (length alist) (/ (* mouse-buffer-menu-maxlen 3) 2))
1964 (let ((alist alist) sublists next
1965 (i 1))
1966 (while alist
1967 ;; Pull off the next mouse-buffer-menu-maxlen buffers
1968 ;; and make them the next element of sublist.
1969 (setq next (nthcdr mouse-buffer-menu-maxlen alist))
1970 (if next
1971 (setcdr (nthcdr (1- mouse-buffer-menu-maxlen) alist)
1972 nil))
1973 (setq sublists (cons (cons (format "Buffers %d" i) alist)
1974 sublists))
1975 (setq i (1+ i))
1976 (setq alist next))
1977 (nreverse sublists))
1978 ;; Few buffers--put them all in one pane.
1979 (list (cons title alist))))
1980 \f
1981 ;; These need to be rewritten for the new scroll bar implementation.
1982
1983 ;;!! ;; Commands for the scroll bar.
1984 ;;!!
1985 ;;!! (defun mouse-scroll-down (click)
1986 ;;!! (interactive "@e")
1987 ;;!! (scroll-down (1+ (cdr (mouse-coords click)))))
1988 ;;!!
1989 ;;!! (defun mouse-scroll-up (click)
1990 ;;!! (interactive "@e")
1991 ;;!! (scroll-up (1+ (cdr (mouse-coords click)))))
1992 ;;!!
1993 ;;!! (defun mouse-scroll-down-full ()
1994 ;;!! (interactive "@")
1995 ;;!! (scroll-down nil))
1996 ;;!!
1997 ;;!! (defun mouse-scroll-up-full ()
1998 ;;!! (interactive "@")
1999 ;;!! (scroll-up nil))
2000 ;;!!
2001 ;;!! (defun mouse-scroll-move-cursor (click)
2002 ;;!! (interactive "@e")
2003 ;;!! (move-to-window-line (1+ (cdr (mouse-coords click)))))
2004 ;;!!
2005 ;;!! (defun mouse-scroll-absolute (event)
2006 ;;!! (interactive "@e")
2007 ;;!! (let* ((pos (car event))
2008 ;;!! (position (car pos))
2009 ;;!! (length (car (cdr pos))))
2010 ;;!! (if (<= length 0) (setq length 1))
2011 ;;!! (let* ((scale-factor (max 1 (/ length (/ 8000000 (buffer-size)))))
2012 ;;!! (newpos (* (/ (* (/ (buffer-size) scale-factor)
2013 ;;!! position)
2014 ;;!! length)
2015 ;;!! scale-factor)))
2016 ;;!! (goto-char newpos)
2017 ;;!! (recenter '(4)))))
2018 ;;!!
2019 ;;!! (defun mouse-scroll-left (click)
2020 ;;!! (interactive "@e")
2021 ;;!! (scroll-left (1+ (car (mouse-coords click)))))
2022 ;;!!
2023 ;;!! (defun mouse-scroll-right (click)
2024 ;;!! (interactive "@e")
2025 ;;!! (scroll-right (1+ (car (mouse-coords click)))))
2026 ;;!!
2027 ;;!! (defun mouse-scroll-left-full ()
2028 ;;!! (interactive "@")
2029 ;;!! (scroll-left nil))
2030 ;;!!
2031 ;;!! (defun mouse-scroll-right-full ()
2032 ;;!! (interactive "@")
2033 ;;!! (scroll-right nil))
2034 ;;!!
2035 ;;!! (defun mouse-scroll-move-cursor-horizontally (click)
2036 ;;!! (interactive "@e")
2037 ;;!! (move-to-column (1+ (car (mouse-coords click)))))
2038 ;;!!
2039 ;;!! (defun mouse-scroll-absolute-horizontally (event)
2040 ;;!! (interactive "@e")
2041 ;;!! (let* ((pos (car event))
2042 ;;!! (position (car pos))
2043 ;;!! (length (car (cdr pos))))
2044 ;;!! (set-window-hscroll (selected-window) 33)))
2045 ;;!!
2046 ;;!! (global-set-key [scroll-bar mouse-1] 'mouse-scroll-up)
2047 ;;!! (global-set-key [scroll-bar mouse-2] 'mouse-scroll-absolute)
2048 ;;!! (global-set-key [scroll-bar mouse-3] 'mouse-scroll-down)
2049 ;;!!
2050 ;;!! (global-set-key [vertical-slider mouse-1] 'mouse-scroll-move-cursor)
2051 ;;!! (global-set-key [vertical-slider mouse-2] 'mouse-scroll-move-cursor)
2052 ;;!! (global-set-key [vertical-slider mouse-3] 'mouse-scroll-move-cursor)
2053 ;;!!
2054 ;;!! (global-set-key [thumbup mouse-1] 'mouse-scroll-up-full)
2055 ;;!! (global-set-key [thumbup mouse-2] 'mouse-scroll-up-full)
2056 ;;!! (global-set-key [thumbup mouse-3] 'mouse-scroll-up-full)
2057 ;;!!
2058 ;;!! (global-set-key [thumbdown mouse-1] 'mouse-scroll-down-full)
2059 ;;!! (global-set-key [thumbdown mouse-2] 'mouse-scroll-down-full)
2060 ;;!! (global-set-key [thumbdown mouse-3] 'mouse-scroll-down-full)
2061 ;;!!
2062 ;;!! (global-set-key [horizontal-scroll-bar mouse-1] 'mouse-scroll-left)
2063 ;;!! (global-set-key [horizontal-scroll-bar mouse-2]
2064 ;;!! 'mouse-scroll-absolute-horizontally)
2065 ;;!! (global-set-key [horizontal-scroll-bar mouse-3] 'mouse-scroll-right)
2066 ;;!!
2067 ;;!! (global-set-key [horizontal-slider mouse-1]
2068 ;;!! 'mouse-scroll-move-cursor-horizontally)
2069 ;;!! (global-set-key [horizontal-slider mouse-2]
2070 ;;!! 'mouse-scroll-move-cursor-horizontally)
2071 ;;!! (global-set-key [horizontal-slider mouse-3]
2072 ;;!! 'mouse-scroll-move-cursor-horizontally)
2073 ;;!!
2074 ;;!! (global-set-key [thumbleft mouse-1] 'mouse-scroll-left-full)
2075 ;;!! (global-set-key [thumbleft mouse-2] 'mouse-scroll-left-full)
2076 ;;!! (global-set-key [thumbleft mouse-3] 'mouse-scroll-left-full)
2077 ;;!!
2078 ;;!! (global-set-key [thumbright mouse-1] 'mouse-scroll-right-full)
2079 ;;!! (global-set-key [thumbright mouse-2] 'mouse-scroll-right-full)
2080 ;;!! (global-set-key [thumbright mouse-3] 'mouse-scroll-right-full)
2081 ;;!!
2082 ;;!! (global-set-key [horizontal-scroll-bar S-mouse-2]
2083 ;;!! 'mouse-split-window-horizontally)
2084 ;;!! (global-set-key [mode-line S-mouse-2]
2085 ;;!! 'mouse-split-window-horizontally)
2086 ;;!! (global-set-key [vertical-scroll-bar S-mouse-2]
2087 ;;!! 'mouse-split-window)
2088 \f
2089 ;;!! ;;;;
2090 ;;!! ;;;; Here are experimental things being tested. Mouse events
2091 ;;!! ;;;; are of the form:
2092 ;;!! ;;;; ((x y) window screen-part key-sequence timestamp)
2093 ;;!! ;;
2094 ;;!! ;;;;
2095 ;;!! ;;;; Dynamically track mouse coordinates
2096 ;;!! ;;;;
2097 ;;!! ;;
2098 ;;!! ;;(defun track-mouse (event)
2099 ;;!! ;; "Track the coordinates, absolute and relative, of the mouse."
2100 ;;!! ;; (interactive "@e")
2101 ;;!! ;; (while mouse-grabbed
2102 ;;!! ;; (let* ((pos (read-mouse-position (selected-screen)))
2103 ;;!! ;; (abs-x (car pos))
2104 ;;!! ;; (abs-y (cdr pos))
2105 ;;!! ;; (relative-coordinate (coordinates-in-window-p
2106 ;;!! ;; (list (car pos) (cdr pos))
2107 ;;!! ;; (selected-window))))
2108 ;;!! ;; (if (consp relative-coordinate)
2109 ;;!! ;; (message "mouse: [%d %d], (%d %d)" abs-x abs-y
2110 ;;!! ;; (car relative-coordinate)
2111 ;;!! ;; (car (cdr relative-coordinate)))
2112 ;;!! ;; (message "mouse: [%d %d]" abs-x abs-y)))))
2113 ;;!!
2114 ;;!! ;;
2115 ;;!! ;; Dynamically put a box around the line indicated by point
2116 ;;!! ;;
2117 ;;!! ;;
2118 ;;!! ;;(require 'backquote)
2119 ;;!! ;;
2120 ;;!! ;;(defun mouse-select-buffer-line (event)
2121 ;;!! ;; (interactive "@e")
2122 ;;!! ;; (let ((relative-coordinate
2123 ;;!! ;; (coordinates-in-window-p (car event) (selected-window)))
2124 ;;!! ;; (abs-y (car (cdr (car event)))))
2125 ;;!! ;; (if (consp relative-coordinate)
2126 ;;!! ;; (progn
2127 ;;!! ;; (save-excursion
2128 ;;!! ;; (move-to-window-line (car (cdr relative-coordinate)))
2129 ;;!! ;; (x-draw-rectangle
2130 ;;!! ;; (selected-screen)
2131 ;;!! ;; abs-y 0
2132 ;;!! ;; (save-excursion
2133 ;;!! ;; (move-to-window-line (car (cdr relative-coordinate)))
2134 ;;!! ;; (end-of-line)
2135 ;;!! ;; (push-mark nil t)
2136 ;;!! ;; (beginning-of-line)
2137 ;;!! ;; (- (region-end) (region-beginning))) 1))
2138 ;;!! ;; (sit-for 1)
2139 ;;!! ;; (x-erase-rectangle (selected-screen))))))
2140 ;;!! ;;
2141 ;;!! ;;(defvar last-line-drawn nil)
2142 ;;!! ;;(defvar begin-delim "[^ \t]")
2143 ;;!! ;;(defvar end-delim "[^ \t]")
2144 ;;!! ;;
2145 ;;!! ;;(defun mouse-boxing (event)
2146 ;;!! ;; (interactive "@e")
2147 ;;!! ;; (save-excursion
2148 ;;!! ;; (let ((screen (selected-screen)))
2149 ;;!! ;; (while (= (x-mouse-events) 0)
2150 ;;!! ;; (let* ((pos (read-mouse-position screen))
2151 ;;!! ;; (abs-x (car pos))
2152 ;;!! ;; (abs-y (cdr pos))
2153 ;;!! ;; (relative-coordinate
2154 ;;!! ;; (coordinates-in-window-p `(,abs-x ,abs-y)
2155 ;;!! ;; (selected-window)))
2156 ;;!! ;; (begin-reg nil)
2157 ;;!! ;; (end-reg nil)
2158 ;;!! ;; (end-column nil)
2159 ;;!! ;; (begin-column nil))
2160 ;;!! ;; (if (and (consp relative-coordinate)
2161 ;;!! ;; (or (not last-line-drawn)
2162 ;;!! ;; (not (= last-line-drawn abs-y))))
2163 ;;!! ;; (progn
2164 ;;!! ;; (move-to-window-line (car (cdr relative-coordinate)))
2165 ;;!! ;; (if (= (following-char) 10)
2166 ;;!! ;; ()
2167 ;;!! ;; (progn
2168 ;;!! ;; (setq begin-reg (1- (re-search-forward end-delim)))
2169 ;;!! ;; (setq begin-column (1- (current-column)))
2170 ;;!! ;; (end-of-line)
2171 ;;!! ;; (setq end-reg (1+ (re-search-backward begin-delim)))
2172 ;;!! ;; (setq end-column (1+ (current-column)))
2173 ;;!! ;; (message "%s" (buffer-substring begin-reg end-reg))
2174 ;;!! ;; (x-draw-rectangle screen
2175 ;;!! ;; (setq last-line-drawn abs-y)
2176 ;;!! ;; begin-column
2177 ;;!! ;; (- end-column begin-column) 1))))))))))
2178 ;;!! ;;
2179 ;;!! ;;(defun mouse-erase-box ()
2180 ;;!! ;; (interactive)
2181 ;;!! ;; (if last-line-drawn
2182 ;;!! ;; (progn
2183 ;;!! ;; (x-erase-rectangle (selected-screen))
2184 ;;!! ;; (setq last-line-drawn nil))))
2185 ;;!!
2186 ;;!! ;;; (defun test-x-rectangle ()
2187 ;;!! ;;; (use-local-mouse-map (setq rectangle-test-map (make-sparse-keymap)))
2188 ;;!! ;;; (define-key rectangle-test-map mouse-motion-button-left 'mouse-boxing)
2189 ;;!! ;;; (define-key rectangle-test-map mouse-button-left-up 'mouse-erase-box))
2190 ;;!!
2191 ;;!! ;;
2192 ;;!! ;; Here is how to do double clicking in lisp. About to change.
2193 ;;!! ;;
2194 ;;!!
2195 ;;!! (defvar double-start nil)
2196 ;;!! (defconst double-click-interval 300
2197 ;;!! "Max ticks between clicks")
2198 ;;!!
2199 ;;!! (defun double-down (event)
2200 ;;!! (interactive "@e")
2201 ;;!! (if double-start
2202 ;;!! (let ((interval (- (nth 4 event) double-start)))
2203 ;;!! (if (< interval double-click-interval)
2204 ;;!! (progn
2205 ;;!! (backward-up-list 1)
2206 ;;!! ;; (message "Interval %d" interval)
2207 ;;!! (sleep-for 1)))
2208 ;;!! (setq double-start nil))
2209 ;;!! (setq double-start (nth 4 event))))
2210 ;;!!
2211 ;;!! (defun double-up (event)
2212 ;;!! (interactive "@e")
2213 ;;!! (and double-start
2214 ;;!! (> (- (nth 4 event ) double-start) double-click-interval)
2215 ;;!! (setq double-start nil)))
2216 ;;!!
2217 ;;!! ;;; (defun x-test-doubleclick ()
2218 ;;!! ;;; (use-local-mouse-map (setq doubleclick-test-map (make-sparse-keymap)))
2219 ;;!! ;;; (define-key doubleclick-test-map mouse-button-left 'double-down)
2220 ;;!! ;;; (define-key doubleclick-test-map mouse-button-left-up 'double-up))
2221 ;;!!
2222 ;;!! ;;
2223 ;;!! ;; This scrolls while button is depressed. Use preferable in scroll bar.
2224 ;;!! ;;
2225 ;;!!
2226 ;;!! (defvar scrolled-lines 0)
2227 ;;!! (defconst scroll-speed 1)
2228 ;;!!
2229 ;;!! (defun incr-scroll-down (event)
2230 ;;!! (interactive "@e")
2231 ;;!! (setq scrolled-lines 0)
2232 ;;!! (incremental-scroll scroll-speed))
2233 ;;!!
2234 ;;!! (defun incr-scroll-up (event)
2235 ;;!! (interactive "@e")
2236 ;;!! (setq scrolled-lines 0)
2237 ;;!! (incremental-scroll (- scroll-speed)))
2238 ;;!!
2239 ;;!! (defun incremental-scroll (n)
2240 ;;!! (while (= (x-mouse-events) 0)
2241 ;;!! (setq scrolled-lines (1+ (* scroll-speed scrolled-lines)))
2242 ;;!! (scroll-down n)
2243 ;;!! (sit-for 300 t)))
2244 ;;!!
2245 ;;!! (defun incr-scroll-stop (event)
2246 ;;!! (interactive "@e")
2247 ;;!! (message "Scrolled %d lines" scrolled-lines)
2248 ;;!! (setq scrolled-lines 0)
2249 ;;!! (sleep-for 1))
2250 ;;!!
2251 ;;!! ;;; (defun x-testing-scroll ()
2252 ;;!! ;;; (let ((scrolling-map (function mouse-vertical-scroll-bar-prefix)))
2253 ;;!! ;;; (define-key scrolling-map mouse-button-left 'incr-scroll-down)
2254 ;;!! ;;; (define-key scrolling-map mouse-button-right 'incr-scroll-up)
2255 ;;!! ;;; (define-key scrolling-map mouse-button-left-up 'incr-scroll-stop)
2256 ;;!! ;;; (define-key scrolling-map mouse-button-right-up 'incr-scroll-stop)))
2257 ;;!!
2258 ;;!! ;;
2259 ;;!! ;; Some playthings suitable for picture mode? They need work.
2260 ;;!! ;;
2261 ;;!!
2262 ;;!! (defun mouse-kill-rectangle (event)
2263 ;;!! "Kill the rectangle between point and the mouse cursor."
2264 ;;!! (interactive "@e")
2265 ;;!! (let ((point-save (point)))
2266 ;;!! (save-excursion
2267 ;;!! (mouse-set-point event)
2268 ;;!! (push-mark nil t)
2269 ;;!! (if (> point-save (point))
2270 ;;!! (kill-rectangle (point) point-save)
2271 ;;!! (kill-rectangle point-save (point))))))
2272 ;;!!
2273 ;;!! (defun mouse-open-rectangle (event)
2274 ;;!! "Kill the rectangle between point and the mouse cursor."
2275 ;;!! (interactive "@e")
2276 ;;!! (let ((point-save (point)))
2277 ;;!! (save-excursion
2278 ;;!! (mouse-set-point event)
2279 ;;!! (push-mark nil t)
2280 ;;!! (if (> point-save (point))
2281 ;;!! (open-rectangle (point) point-save)
2282 ;;!! (open-rectangle point-save (point))))))
2283 ;;!!
2284 ;;!! ;; Must be a better way to do this.
2285 ;;!!
2286 ;;!! (defun mouse-multiple-insert (n char)
2287 ;;!! (while (> n 0)
2288 ;;!! (insert char)
2289 ;;!! (setq n (1- n))))
2290 ;;!!
2291 ;;!! ;; What this could do is not finalize until button was released.
2292 ;;!!
2293 ;;!! (defun mouse-move-text (event)
2294 ;;!! "Move text from point to cursor position, inserting spaces."
2295 ;;!! (interactive "@e")
2296 ;;!! (let* ((relative-coordinate
2297 ;;!! (coordinates-in-window-p (car event) (selected-window))))
2298 ;;!! (if (consp relative-coordinate)
2299 ;;!! (cond ((> (current-column) (car relative-coordinate))
2300 ;;!! (delete-char
2301 ;;!! (- (car relative-coordinate) (current-column))))
2302 ;;!! ((< (current-column) (car relative-coordinate))
2303 ;;!! (mouse-multiple-insert
2304 ;;!! (- (car relative-coordinate) (current-column)) " "))
2305 ;;!! ((= (current-column) (car relative-coordinate)) (ding))))))
2306 \f
2307 ;; Choose a completion with the mouse.
2308
2309 (defun mouse-choose-completion (event)
2310 "Click on an alternative in the `*Completions*' buffer to choose it."
2311 (interactive "e")
2312 ;; Give temporary modes such as isearch a chance to turn off.
2313 (run-hooks 'mouse-leave-buffer-hook)
2314 (let ((buffer (window-buffer))
2315 choice
2316 base-size)
2317 (save-excursion
2318 (set-buffer (window-buffer (posn-window (event-start event))))
2319 (if completion-reference-buffer
2320 (setq buffer completion-reference-buffer))
2321 (setq base-size completion-base-size)
2322 (save-excursion
2323 (goto-char (posn-point (event-start event)))
2324 (let (beg end)
2325 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2326 (setq end (point) beg (1+ (point))))
2327 (if (null beg)
2328 (error "No completion here"))
2329 (setq beg (previous-single-property-change beg 'mouse-face))
2330 (setq end (or (next-single-property-change end 'mouse-face)
2331 (point-max)))
2332 (setq choice (buffer-substring-no-properties beg end)))))
2333 (let ((owindow (selected-window)))
2334 (select-window (posn-window (event-start event)))
2335 (if (and (one-window-p t 'selected-frame)
2336 (window-dedicated-p (selected-window)))
2337 ;; This is a special buffer's frame
2338 (iconify-frame (selected-frame))
2339 (or (window-dedicated-p (selected-window))
2340 (bury-buffer)))
2341 (select-window owindow))
2342 (choose-completion-string choice buffer base-size)))
2343 \f
2344 ;; Font selection.
2345
2346 (defun font-menu-add-default ()
2347 (let* ((default (cdr (assq 'font (frame-parameters (selected-frame)))))
2348 (font-alist x-fixed-font-alist)
2349 (elt (or (assoc "Misc" font-alist) (nth 1 font-alist))))
2350 (if (assoc "Default" elt)
2351 (delete (assoc "Default" elt) elt))
2352 (setcdr elt
2353 (cons (list "Default" default)
2354 (cdr elt)))))
2355
2356 (defvar x-fixed-font-alist
2357 '("Font Menu"
2358 ("Misc"
2359 ;; For these, we specify the pixel height and width.
2360 ("fixed" "fixed")
2361 ("6x10" "-misc-fixed-medium-r-normal--10-*-*-*-c-60-iso8859-1" "6x10")
2362 ("6x12"
2363 "-misc-fixed-medium-r-semicondensed--12-*-*-*-c-60-iso8859-1" "6x12")
2364 ("6x13"
2365 "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" "6x13")
2366 ("7x13" "-misc-fixed-medium-r-normal--13-*-*-*-c-70-iso8859-1" "7x13")
2367 ("7x14" "-misc-fixed-medium-r-normal--14-*-*-*-c-70-iso8859-1" "7x14")
2368 ("8x13" "-misc-fixed-medium-r-normal--13-*-*-*-c-80-iso8859-1" "8x13")
2369 ("9x15" "-misc-fixed-medium-r-normal--15-*-*-*-c-90-iso8859-1" "9x15")
2370 ("10x20" "-misc-fixed-medium-r-normal--20-*-*-*-c-100-iso8859-1" "10x20")
2371 ("11x18" "-misc-fixed-medium-r-normal--18-*-*-*-c-110-iso8859-1" "11x18")
2372 ("12x24" "-misc-fixed-medium-r-normal--24-*-*-*-c-120-iso8859-1" "12x24")
2373 ("")
2374 ("clean 5x8"
2375 "-schumacher-clean-medium-r-normal--8-*-*-*-c-50-iso8859-1")
2376 ("clean 6x8"
2377 "-schumacher-clean-medium-r-normal--8-*-*-*-c-60-iso8859-1")
2378 ("clean 8x8"
2379 "-schumacher-clean-medium-r-normal--8-*-*-*-c-80-iso8859-1")
2380 ("clean 8x10"
2381 "-schumacher-clean-medium-r-normal--10-*-*-*-c-80-iso8859-1")
2382 ("clean 8x14"
2383 "-schumacher-clean-medium-r-normal--14-*-*-*-c-80-iso8859-1")
2384 ("clean 8x16"
2385 "-schumacher-clean-medium-r-normal--16-*-*-*-c-80-iso8859-1")
2386 ("")
2387 ("sony 8x16" "-sony-fixed-medium-r-normal--16-*-*-*-c-80-iso8859-1")
2388 ;; We don't seem to have these; who knows what they are.
2389 ;; ("fg-18" "fg-18")
2390 ;; ("fg-25" "fg-25")
2391 ("lucidasanstypewriter-12" "-b&h-lucidatypewriter-medium-r-normal-sans-*-120-*-*-*-*-iso8859-1")
2392 ("lucidasanstypewriter-bold-14" "-b&h-lucidatypewriter-bold-r-normal-sans-*-140-*-*-*-*-iso8859-1")
2393 ("lucidasanstypewriter-bold-24"
2394 "-b&h-lucidatypewriter-bold-r-normal-sans-*-240-*-*-*-*-iso8859-1")
2395 ;; ("lucidatypewriter-bold-r-24" "-b&h-lucidatypewriter-bold-r-normal-sans-24-240-75-75-m-140-iso8859-1")
2396 ;; ("fixed-medium-20" "-misc-fixed-medium-*-*-*-20-*-*-*-*-*-*-*")
2397 )
2398 ("Courier"
2399 ;; For these, we specify the point height.
2400 ("8" "-adobe-courier-medium-r-normal--*-80-*-*-m-*-iso8859-1")
2401 ("10" "-adobe-courier-medium-r-normal--*-100-*-*-m-*-iso8859-1")
2402 ("12" "-adobe-courier-medium-r-normal--*-120-*-*-m-*-iso8859-1")
2403 ("14" "-adobe-courier-medium-r-normal--*-140-*-*-m-*-iso8859-1")
2404 ("18" "-adobe-courier-medium-r-normal--*-180-*-*-m-*-iso8859-1")
2405 ("24" "-adobe-courier-medium-r-normal--*-240-*-*-m-*-iso8859-1")
2406 ("8 bold" "-adobe-courier-bold-r-normal--*-80-*-*-m-*-iso8859-1")
2407 ("10 bold" "-adobe-courier-bold-r-normal--*-100-*-*-m-*-iso8859-1")
2408 ("12 bold" "-adobe-courier-bold-r-normal--*-120-*-*-m-*-iso8859-1")
2409 ("14 bold" "-adobe-courier-bold-r-normal--*-140-*-*-m-*-iso8859-1")
2410 ("18 bold" "-adobe-courier-bold-r-normal--*-180-*-*-m-*-iso8859-1")
2411 ("24 bold" "-adobe-courier-bold-r-normal--*-240-*-*-m-*-iso8859-1")
2412 ("8 slant" "-adobe-courier-medium-o-normal--*-80-*-*-m-*-iso8859-1")
2413 ("10 slant" "-adobe-courier-medium-o-normal--*-100-*-*-m-*-iso8859-1")
2414 ("12 slant" "-adobe-courier-medium-o-normal--*-120-*-*-m-*-iso8859-1")
2415 ("14 slant" "-adobe-courier-medium-o-normal--*-140-*-*-m-*-iso8859-1")
2416 ("18 slant" "-adobe-courier-medium-o-normal--*-180-*-*-m-*-iso8859-1")
2417 ("24 slant" "-adobe-courier-medium-o-normal--*-240-*-*-m-*-iso8859-1")
2418 ("8 bold slant" "-adobe-courier-bold-o-normal--*-80-*-*-m-*-iso8859-1")
2419 ("10 bold slant" "-adobe-courier-bold-o-normal--*-100-*-*-m-*-iso8859-1")
2420 ("12 bold slant" "-adobe-courier-bold-o-normal--*-120-*-*-m-*-iso8859-1")
2421 ("14 bold slant" "-adobe-courier-bold-o-normal--*-140-*-*-m-*-iso8859-1")
2422 ("18 bold slant" "-adobe-courier-bold-o-normal--*-180-*-*-m-*-iso8859-1")
2423 ("24 bold slant" "-adobe-courier-bold-o-normal--*-240-*-*-m-*-iso8859-1"))
2424 )
2425 "X fonts suitable for use in Emacs.")
2426
2427 (declare-function generate-fontset-menu "fontset" ())
2428
2429 (defun mouse-select-font ()
2430 "Prompt for a font name, using `x-popup-menu', and return it."
2431 (interactive)
2432 (unless (display-multi-font-p)
2433 (error "Cannot change fonts on this display"))
2434 (x-popup-menu
2435 (if (listp last-nonmenu-event)
2436 last-nonmenu-event
2437 (list '(0 0) (selected-window)))
2438 (append x-fixed-font-alist
2439 (list (generate-fontset-menu)))))
2440
2441 (declare-function text-scale-mode "face-remap")
2442
2443 (defun mouse-set-font (&rest fonts)
2444 "Set the default font for the selected frame.
2445 The argument FONTS is a list of font names; the first valid font
2446 in this list is used.
2447
2448 When called interactively, pop up a menu and allow the user to
2449 choose a font."
2450 (interactive
2451 (progn (unless (display-multi-font-p)
2452 (error "Cannot change fonts on this display"))
2453 (x-popup-menu
2454 (if (listp last-nonmenu-event)
2455 last-nonmenu-event
2456 (list '(0 0) (selected-window)))
2457 ;; Append list of fontsets currently defined.
2458 (append x-fixed-font-alist (list (generate-fontset-menu))))))
2459 (if fonts
2460 (let (font)
2461 (while fonts
2462 (condition-case nil
2463 (progn
2464 (set-frame-font (car fonts))
2465 (setq font (car fonts))
2466 (setq fonts nil))
2467 (error
2468 (setq fonts (cdr fonts)))))
2469 (if (null font)
2470 (error "Font not found")))))
2471
2472 (defvar mouse-appearance-menu-map nil)
2473 (declare-function x-select-font "xfns.c" (&optional frame ignored)) ; USE_GTK
2474 (declare-function buffer-face-mode-invoke "face-remap"
2475 (face arg &optional interactive))
2476 (declare-function font-face-attributes "font.c" (font &optional frame))
2477
2478 (defun mouse-appearance-menu (event)
2479 (interactive "@e")
2480 (require 'face-remap)
2481 (when (display-multi-font-p)
2482 (with-selected-window (car (event-start event))
2483 (if mouse-appearance-menu-map
2484 nil ; regenerate new fonts
2485 ;; Initialize mouse-appearance-menu-map
2486 (setq mouse-appearance-menu-map
2487 (make-sparse-keymap "Change Default Buffer Face"))
2488 (define-key mouse-appearance-menu-map [face-remap-reset-base]
2489 '(menu-item "Reset to Default" face-remap-reset-base))
2490 (define-key mouse-appearance-menu-map [text-scale-decrease]
2491 '(menu-item "Decrease Buffer Text Size" text-scale-decrease))
2492 (define-key mouse-appearance-menu-map [text-scale-increase]
2493 '(menu-item "Increase Buffer Text Size" text-scale-increase))
2494 ;; Font selector
2495 (if (functionp 'x-select-font)
2496 (define-key mouse-appearance-menu-map [x-select-font]
2497 '(menu-item "Change Buffer Font..." x-select-font))
2498 ;; If the select-font is unavailable, construct a menu.
2499 (let ((font-submenu (make-sparse-keymap "Change Text Font"))
2500 (font-alist (cdr (append x-fixed-font-alist
2501 (list (generate-fontset-menu))))))
2502 (dolist (family font-alist)
2503 (let* ((submenu-name (car family))
2504 (submenu-map (make-sparse-keymap submenu-name)))
2505 (dolist (font (cdr family))
2506 (let ((font-name (car font))
2507 font-symbol)
2508 (if (string= font-name "")
2509 (define-key submenu-map [space]
2510 '("--"))
2511 (setq font-symbol (intern (cadr font)))
2512 (define-key submenu-map (vector font-symbol)
2513 (list 'menu-item (car font) font-symbol)))))
2514 (define-key font-submenu (vector (intern submenu-name))
2515 (list 'menu-item submenu-name submenu-map))))
2516 (define-key mouse-appearance-menu-map [font-submenu]
2517 (list 'menu-item "Change Text Font" font-submenu)))))
2518 (let ((choice (x-popup-menu event mouse-appearance-menu-map)))
2519 (setq choice (nth (1- (length choice)) choice))
2520 (cond ((eq choice 'text-scale-increase)
2521 (text-scale-increase 1))
2522 ((eq choice 'text-scale-decrease)
2523 (text-scale-increase -1))
2524 ((eq choice 'face-remap-reset-base)
2525 (text-scale-mode 0)
2526 (buffer-face-mode 0))
2527 (choice
2528 ;; Either choice == 'x-select-font, or choice is a
2529 ;; symbol whose name is a font.
2530 (buffer-face-mode-invoke (font-face-attributes
2531 (if (eq choice 'x-select-font)
2532 (x-select-font)
2533 (symbol-name choice)))
2534 t (interactive-p))))))))
2535
2536 \f
2537 ;;; Bindings for mouse commands.
2538
2539 (define-key global-map [down-mouse-1] 'mouse-drag-region)
2540 (global-set-key [mouse-1] 'mouse-set-point)
2541 (global-set-key [drag-mouse-1] 'mouse-set-region)
2542
2543 ;; These are tested for in mouse-drag-region.
2544 (global-set-key [double-mouse-1] 'mouse-set-point)
2545 (global-set-key [triple-mouse-1] 'mouse-set-point)
2546
2547 ;; Clicking on the fringes causes hscrolling:
2548 (global-set-key [left-fringe mouse-1] 'mouse-set-point)
2549 (global-set-key [right-fringe mouse-1] 'mouse-set-point)
2550
2551 (global-set-key [mouse-2] 'mouse-yank-at-click)
2552 ;; Allow yanking also when the corresponding cursor is "in the fringe".
2553 (global-set-key [right-fringe mouse-2] 'mouse-yank-at-click)
2554 (global-set-key [left-fringe mouse-2] 'mouse-yank-at-click)
2555 (global-set-key [mouse-3] 'mouse-save-then-kill)
2556 (global-set-key [right-fringe mouse-3] 'mouse-save-then-kill)
2557 (global-set-key [left-fringe mouse-3] 'mouse-save-then-kill)
2558
2559 ;; By binding these to down-going events, we let the user use the up-going
2560 ;; event to make the selection, saving a click.
2561 (global-set-key [C-down-mouse-1] 'mouse-buffer-menu)
2562 (if (not (eq system-type 'ms-dos))
2563 (global-set-key [S-down-mouse-1] 'mouse-appearance-menu))
2564 ;; C-down-mouse-2 is bound in facemenu.el.
2565 (global-set-key [C-down-mouse-3]
2566 '(menu-item "Menu Bar" ignore
2567 :filter (lambda (_)
2568 (if (zerop (or (frame-parameter nil 'menu-bar-lines) 0))
2569 (mouse-menu-bar-map)
2570 (mouse-menu-major-mode-map)))))
2571
2572
2573 ;; Replaced with dragging mouse-1
2574 ;; (global-set-key [S-mouse-1] 'mouse-set-mark)
2575
2576 ;; Binding mouse-1 to mouse-select-window when on mode-, header-, or
2577 ;; vertical-line prevents Emacs from signaling an error when the mouse
2578 ;; button is released after dragging these lines, on non-toolkit
2579 ;; versions.
2580 (global-set-key [mode-line mouse-1] 'mouse-select-window)
2581 (global-set-key [mode-line drag-mouse-1] 'mouse-select-window)
2582 (global-set-key [mode-line down-mouse-1] 'mouse-drag-mode-line)
2583 (global-set-key [header-line down-mouse-1] 'mouse-drag-header-line)
2584 (global-set-key [header-line mouse-1] 'mouse-select-window)
2585 (global-set-key [mode-line mouse-2] 'mouse-delete-other-windows)
2586 (global-set-key [mode-line mouse-3] 'mouse-delete-window)
2587 (global-set-key [mode-line C-mouse-2] 'mouse-split-window-horizontally)
2588 (global-set-key [vertical-scroll-bar C-mouse-2] 'mouse-split-window-vertically)
2589 (global-set-key [vertical-line C-mouse-2] 'mouse-split-window-vertically)
2590 (global-set-key [vertical-line down-mouse-1] 'mouse-drag-vertical-line)
2591 (global-set-key [vertical-line mouse-1] 'mouse-select-window)
2592
2593 (provide 'mouse)
2594
2595 ;; This file contains the functionality of the old mldrag.el.
2596 (defalias 'mldrag-drag-mode-line 'mouse-drag-mode-line)
2597 (defalias 'mldrag-drag-vertical-line 'mouse-drag-vertical-line)
2598 (make-obsolete 'mldrag-drag-mode-line 'mouse-drag-mode-line "21.1")
2599 (make-obsolete 'mldrag-drag-vertical-line 'mouse-drag-vertical-line "21.1")
2600 (provide 'mldrag)
2601
2602 ;; arch-tag: 9a710ce1-914a-4923-9b81-697f7bf82ab3
2603 ;;; mouse.el ends here