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