* help.texi (Misc Help): Mention `describe-prefix-bindings' explicitly.
[emacs.git] / lisp / mouse.el
blob63395619f4405455b0027e57aeb295f71efd10ac
1 ;;; mouse.el --- window system-independent mouse support
3 ;; Copyright (C) 1993-1995, 1999-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: hardware, mouse
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package provides various useful commands (including help
27 ;; system access) through the mouse. All this code assumes that mouse
28 ;; interpretation has been abstracted into Emacs input events.
30 ;; The code is rather X-dependent.
32 ;;; Code:
34 ;;; Utility functions.
36 ;; Indent track-mouse like progn.
37 (put 'track-mouse 'lisp-indent-function 0)
39 (defcustom mouse-yank-at-point nil
40 "If non-nil, mouse yank commands yank at point instead of at click."
41 :type 'boolean
42 :group 'mouse)
44 (defcustom mouse-drag-copy-region nil
45 "If non-nil, copy to kill-ring upon mouse adjustments of the region.
47 This affects `mouse-save-then-kill' (\\[mouse-save-then-kill]) in
48 addition to mouse drags."
49 :type 'boolean
50 :version "24.1"
51 :group 'mouse)
53 (defcustom mouse-1-click-follows-link 450
54 "Non-nil means that clicking Mouse-1 on a link follows the link.
56 With the default setting, an ordinary Mouse-1 click on a link
57 performs the same action as Mouse-2 on that link, while a longer
58 Mouse-1 click \(hold down the Mouse-1 button for more than 450
59 milliseconds) performs the original Mouse-1 binding \(which
60 typically sets point where you click the mouse).
62 If value is an integer, the time elapsed between pressing and
63 releasing the mouse button determines whether to follow the link
64 or perform the normal Mouse-1 action (typically set point).
65 The absolute numeric value specifices the maximum duration of a
66 \"short click\" in milliseconds. A positive value means that a
67 short click follows the link, and a longer click performs the
68 normal action. A negative value gives the opposite behavior.
70 If value is `double', a double click follows the link.
72 Otherwise, a single Mouse-1 click unconditionally follows the link.
74 Note that dragging the mouse never follows the link.
76 This feature only works in modes that specifically identify
77 clickable text as links, so it may not work with some external
78 packages. See `mouse-on-link-p' for details."
79 :version "22.1"
80 :type '(choice (const :tag "Disabled" nil)
81 (const :tag "Double click" double)
82 (number :tag "Single click time limit" :value 450)
83 (other :tag "Single click" t))
84 :group 'mouse)
86 (defcustom mouse-1-click-in-non-selected-windows t
87 "If non-nil, a Mouse-1 click also follows links in non-selected windows.
89 If nil, a Mouse-1 click on a link in a non-selected window performs
90 the normal mouse-1 binding, typically selects the window and sets
91 point at the click position."
92 :type 'boolean
93 :version "22.1"
94 :group 'mouse)
98 ;; Provide a mode-specific menu on a mouse button.
100 (defun popup-menu (menu &optional position prefix)
101 "Popup the given menu and call the selected option.
102 MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
103 `x-popup-menu'.
104 POSITION can be a click event or ((XOFFSET YOFFSET) WINDOW) and defaults to
105 the current mouse position.
106 PREFIX is the prefix argument (if any) to pass to the command."
107 (let* ((map (cond
108 ((keymapp menu) menu)
109 ((and (listp menu) (keymapp (car menu))) menu)
110 (t (let* ((map (easy-menu-create-menu (car menu) (cdr menu)))
111 (filter (when (symbolp map)
112 (plist-get (get map 'menu-prop) :filter))))
113 (if filter (funcall filter (symbol-function map)) map)))))
114 event cmd)
115 (unless position
116 (let ((mp (mouse-pixel-position)))
117 (setq position (list (list (cadr mp) (cddr mp)) (car mp)))))
118 ;; The looping behavior was taken from lmenu's popup-menu-popup
119 (while (and map (setq event
120 ;; map could be a prefix key, in which case
121 ;; we need to get its function cell
122 ;; definition.
123 (x-popup-menu position (indirect-function map))))
124 ;; Strangely x-popup-menu returns a list.
125 ;; mouse-major-mode-menu was using a weird:
126 ;; (key-binding (apply 'vector (append '(menu-bar) menu-prefix events)))
127 (setq cmd
128 (if (and (not (keymapp map)) (listp map))
129 ;; We were given a list of keymaps. Search them all
130 ;; in sequence until a first binding is found.
131 (let ((mouse-click (apply 'vector event))
132 binding)
133 (while (and map (null binding))
134 (setq binding (lookup-key (car map) mouse-click))
135 (if (numberp binding) ; `too long'
136 (setq binding nil))
137 (setq map (cdr map)))
138 binding)
139 ;; We were given a single keymap.
140 (lookup-key map (apply 'vector event))))
141 ;; Clear out echoing, which perhaps shows a prefix arg.
142 (message "")
143 ;; Maybe try again but with the submap.
144 (setq map (if (keymapp cmd) cmd)))
145 ;; If the user did not cancel by refusing to select,
146 ;; and if the result is a command, run it.
147 (when (and (null map) (commandp cmd))
148 (setq prefix-arg prefix)
149 ;; `setup-specified-language-environment', for instance,
150 ;; expects this to be set from a menu keymap.
151 (setq last-command-event (car (last event)))
152 ;; mouse-major-mode-menu was using `command-execute' instead.
153 (call-interactively cmd))))
155 (defun minor-mode-menu-from-indicator (indicator)
156 "Show menu for minor mode specified by INDICATOR.
157 Interactively, INDICATOR is read using completion.
158 If there is no menu defined for the minor mode, then create one with
159 items `Turn Off' and `Help'."
160 (interactive
161 (list (completing-read
162 "Minor mode indicator: "
163 (describe-minor-mode-completion-table-for-indicator))))
164 (let* ((minor-mode (lookup-minor-mode-from-indicator indicator))
165 (mm-fun (or (get minor-mode :minor-mode-function) minor-mode)))
166 (unless minor-mode (error "Cannot find minor mode for `%s'" indicator))
167 (let* ((map (cdr-safe (assq minor-mode minor-mode-map-alist)))
168 (menu (and (keymapp map) (lookup-key map [menu-bar]))))
169 (setq menu
170 (if menu
171 (mouse-menu-non-singleton menu)
172 `(keymap
173 ,indicator
174 (turn-off menu-item "Turn Off minor mode" ,mm-fun)
175 (help menu-item "Help for minor mode"
176 (lambda () (interactive)
177 (describe-function ',mm-fun))))))
178 (popup-menu menu))))
180 (defun mouse-minor-mode-menu (event)
181 "Show minor-mode menu for EVENT on minor modes area of the mode line."
182 (interactive "@e")
183 (let ((indicator (car (nth 4 (car (cdr event))))))
184 (minor-mode-menu-from-indicator indicator)))
186 (defun mouse-menu-major-mode-map ()
187 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
188 (let* (;; Keymap from which to inherit; may be null.
189 (ancestor (mouse-menu-non-singleton
190 (and (current-local-map)
191 (local-key-binding [menu-bar]))))
192 ;; Make a keymap in which our last command leads to a menu or
193 ;; default to the edit menu.
194 (newmap (if ancestor
195 (make-sparse-keymap (concat (format-mode-line mode-name)
196 " Mode"))
197 menu-bar-edit-menu))
198 uniq)
199 (if ancestor
200 (set-keymap-parent newmap ancestor))
201 newmap))
203 (defun mouse-menu-non-singleton (menubar)
204 "Return menu keybar MENUBAR, or a lone submenu inside it.
205 If MENUBAR defines exactly one submenu, return just that submenu.
206 Otherwise, return MENUBAR."
207 (if menubar
208 (let (submap)
209 (map-keymap
210 (lambda (k v) (setq submap (if submap t (cons k v))))
211 (keymap-canonicalize menubar))
212 (if (eq submap t)
213 menubar
214 (lookup-key menubar (vector (car submap)))))))
216 (defun mouse-menu-bar-map ()
217 "Return a keymap equivalent to the menu bar.
218 The contents are the items that would be in the menu bar whether or
219 not it is actually displayed."
220 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
221 (let* ((local-menu (and (current-local-map)
222 (lookup-key (current-local-map) [menu-bar])))
223 (global-menu (lookup-key global-map [menu-bar]))
224 ;; If a keymap doesn't have a prompt string (a lazy
225 ;; programmer didn't bother to provide one), create it and
226 ;; insert it into the keymap; each keymap gets its own
227 ;; prompt. This is required for non-toolkit versions to
228 ;; display non-empty menu pane names.
229 (minor-mode-menus
230 (mapcar
231 (lambda (menu)
232 (let* ((minor-mode (car menu))
233 (menu (cdr menu))
234 (title-or-map (cadr menu)))
235 (or (stringp title-or-map)
236 (setq menu
237 (cons 'keymap
238 (cons (concat
239 (capitalize (subst-char-in-string
240 ?- ?\s (symbol-name
241 minor-mode)))
242 " Menu")
243 (cdr menu)))))
244 menu))
245 (minor-mode-key-binding [menu-bar])))
246 (local-title-or-map (and local-menu (cadr local-menu)))
247 (global-title-or-map (cadr global-menu)))
248 (or (null local-menu)
249 (stringp local-title-or-map)
250 (setq local-menu (cons 'keymap
251 (cons (concat (format-mode-line mode-name)
252 " Mode Menu")
253 (cdr local-menu)))))
254 (or (stringp global-title-or-map)
255 (setq global-menu (cons 'keymap
256 (cons "Global Menu"
257 (cdr global-menu)))))
258 ;; Supplying the list is faster than making a new map.
259 ;; FIXME: We have a problem here: we have to use the global/local/minor
260 ;; so they're displayed in the expected order, but later on in the command
261 ;; loop, they're actually looked up in the opposite order.
262 (apply 'append
263 global-menu
264 local-menu
265 minor-mode-menus)))
267 (defun mouse-major-mode-menu (event &optional prefix)
268 "Pop up a mode-specific menu of mouse commands.
269 Default to the Edit menu if the major mode doesn't define a menu."
270 (interactive "@e\nP")
271 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
272 (popup-menu (mouse-menu-major-mode-map) event prefix))
273 (make-obsolete 'mouse-major-mode-menu 'mouse-menu-major-mode-map "23.1")
275 (defun mouse-popup-menubar (event prefix)
276 "Pop up a menu equivalent to the menu bar for keyboard EVENT with PREFIX.
277 The contents are the items that would be in the menu bar whether or
278 not it is actually displayed."
279 (interactive "@e \nP")
280 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
281 (popup-menu (mouse-menu-bar-map) (unless (integerp event) event) prefix))
282 (make-obsolete 'mouse-popup-menubar 'mouse-menu-bar-map "23.1")
284 (defun mouse-popup-menubar-stuff (event prefix)
285 "Popup a menu like either `mouse-major-mode-menu' or `mouse-popup-menubar'.
286 Use the former if the menu bar is showing, otherwise the latter."
287 (interactive "@e\nP")
288 (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
289 (popup-menu
290 (if (zerop (or (frame-parameter nil 'menu-bar-lines) 0))
291 (mouse-menu-bar-map)
292 (mouse-menu-major-mode-map))
293 event prefix))
294 (make-obsolete 'mouse-popup-menubar-stuff nil "23.1")
296 ;; Commands that operate on windows.
298 (defun mouse-minibuffer-check (event)
299 (let ((w (posn-window (event-start event))))
300 (and (window-minibuffer-p w)
301 (not (minibuffer-window-active-p w))
302 (error "Minibuffer window is not active")))
303 ;; Give temporary modes such as isearch a chance to turn off.
304 (run-hooks 'mouse-leave-buffer-hook))
306 (defun mouse-delete-window (click)
307 "Delete the window you click on.
308 Do nothing if the frame has just one window.
309 This command must be bound to a mouse click."
310 (interactive "e")
311 (unless (one-window-p t)
312 (mouse-minibuffer-check click)
313 (delete-window (posn-window (event-start click)))))
315 (defun mouse-select-window (click)
316 "Select the window clicked on; don't move point."
317 (interactive "e")
318 (mouse-minibuffer-check click)
319 (let ((oframe (selected-frame))
320 (frame (window-frame (posn-window (event-start click)))))
321 (select-window (posn-window (event-start click)))
322 (raise-frame frame)
323 (select-frame frame)
324 (or (eq frame oframe)
325 (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
327 (defun mouse-tear-off-window (click)
328 "Delete the window clicked on, and create a new frame displaying its buffer."
329 (interactive "e")
330 (mouse-minibuffer-check click)
331 (let* ((window (posn-window (event-start click)))
332 (buf (window-buffer window))
333 (frame (make-frame)))
334 (select-frame frame)
335 (switch-to-buffer buf)
336 (delete-window window)))
338 (defun mouse-delete-other-windows ()
339 "Delete all windows except the one you click on."
340 (interactive "@")
341 (delete-other-windows))
343 (defun mouse-split-window-vertically (click)
344 "Select Emacs window mouse is on, then split it vertically in half.
345 The window is split at the line clicked on.
346 This command must be bound to a mouse click."
347 (interactive "@e")
348 (mouse-minibuffer-check click)
349 (let ((start (event-start click)))
350 (select-window (posn-window start))
351 (let ((new-height (1+ (cdr (posn-col-row (event-end click)))))
352 (first-line window-min-height)
353 (last-line (- (window-height) window-min-height)))
354 (if (< last-line first-line)
355 (error "Window too short to split")
356 (split-window-vertically
357 (min (max new-height first-line) last-line))))))
359 (defun mouse-split-window-horizontally (click)
360 "Select Emacs window mouse is on, then split it horizontally in half.
361 The window is split at the column clicked on.
362 This command must be bound to a mouse click."
363 (interactive "@e")
364 (mouse-minibuffer-check click)
365 (let ((start (event-start click)))
366 (select-window (posn-window start))
367 (let ((new-width (1+ (car (posn-col-row (event-end click)))))
368 (first-col window-min-width)
369 (last-col (- (window-width) window-min-width)))
370 (if (< last-col first-col)
371 (error "Window too narrow to split")
372 (split-window-horizontally
373 (min (max new-width first-col) last-col))))))
375 (defun mouse-drag-window-above (window)
376 "Return the (or a) window directly above WINDOW.
377 That means one whose bottom edge is at the same height as WINDOW's top edge."
378 (let ((start-top (nth 1 (window-edges window)))
379 (start-left (nth 0 (window-edges window)))
380 (start-right (nth 2 (window-edges window)))
381 (start-window window)
382 above-window)
383 (setq window (previous-window window 0))
384 (while (and (not above-window) (not (eq window start-window)))
385 (let ((left (nth 0 (window-edges window)))
386 (right (nth 2 (window-edges window))))
387 (when (and (= (+ (window-height window) (nth 1 (window-edges window)))
388 start-top)
389 (or (and (<= left start-left) (<= start-right right))
390 (and (<= start-left left) (<= left start-right))
391 (and (<= start-left right) (<= right start-right))))
392 (setq above-window window)))
393 (setq window (previous-window window)))
394 above-window))
396 (defun mouse-drag-move-window-bottom (window growth)
397 "Move the bottom of WINDOW up or down by GROWTH lines.
398 Move it down if GROWTH is positive, or up if GROWTH is negative.
399 If this would make WINDOW too short,
400 shrink the window or windows above it to make room."
401 (condition-case nil
402 (adjust-window-trailing-edge window growth nil)
403 (error nil)))
405 (defsubst mouse-drag-move-window-top (window growth)
406 "Move the top of WINDOW up or down by GROWTH lines.
407 Move it down if GROWTH is positive, or up if GROWTH is negative.
408 If this would make WINDOW too short, shrink the window or windows
409 above it to make room."
410 ;; Moving the top of WINDOW is actually moving the bottom of the
411 ;; window above.
412 (let ((window-above (mouse-drag-window-above window)))
413 (and window-above
414 (mouse-drag-move-window-bottom window-above (- growth)))))
416 (defun mouse-drag-mode-line-1 (start-event mode-line-p)
417 "Change the height of a window by dragging on the mode or header line.
418 START-EVENT is the starting mouse-event of the drag action.
419 MODE-LINE-P non-nil means dragging a mode line; nil means a header line."
420 ;; Give temporary modes such as isearch a chance to turn off.
421 (run-hooks 'mouse-leave-buffer-hook)
422 (let* ((done nil)
423 (echo-keystrokes 0)
424 (start (event-start start-event))
425 (start-event-window (posn-window start))
426 (start-event-frame (window-frame start-event-window))
427 (start-nwindows (count-windows t))
428 (on-link (and mouse-1-click-follows-link
429 (or mouse-1-click-in-non-selected-windows
430 (eq (posn-window start) (selected-window)))
431 (mouse-on-link-p start)))
432 (minibuffer (frame-parameter nil 'minibuffer))
433 should-enlarge-minibuffer event mouse y top bot edges wconfig growth)
434 (track-mouse
435 (progn
436 ;; if this is the bottommost ordinary window, then to
437 ;; move its modeline the minibuffer must be enlarged.
438 (setq should-enlarge-minibuffer
439 (and minibuffer
440 mode-line-p
441 (not (one-window-p t))
442 (= (nth 1 (window-edges minibuffer))
443 (nth 3 (window-edges start-event-window)))))
445 ;; loop reading events and sampling the position of
446 ;; the mouse.
447 (while (not done)
448 (setq event (read-event)
449 mouse (mouse-position))
451 ;; do nothing if
452 ;; - there is a switch-frame event.
453 ;; - the mouse isn't in the frame that we started in
454 ;; - the mouse isn't in any Emacs frame
455 ;; drag if
456 ;; - there is a mouse-movement event
457 ;; - there is a scroll-bar-movement event
458 ;; (same as mouse movement for our purposes)
459 ;; quit if
460 ;; - there is a keyboard event or some other unknown event.
461 (cond ((not (consp event))
462 (setq done t))
464 ((memq (car event) '(switch-frame select-window))
465 nil)
467 ((not (memq (car event) '(mouse-movement scroll-bar-movement)))
468 (when (consp event)
469 ;; Do not unread a drag-mouse-1 event since it will cause the
470 ;; selection of the window above when dragging the modeline
471 ;; above the selected window.
472 (unless (eq (car event) 'drag-mouse-1)
473 (push event unread-command-events)))
474 (setq done t))
476 ((not (eq (car mouse) start-event-frame))
477 nil)
479 ((null (car (cdr mouse)))
480 nil)
483 (setq y (cdr (cdr mouse))
484 edges (window-edges start-event-window)
485 top (nth 1 edges)
486 bot (nth 3 edges))
488 ;; compute size change needed
489 (cond (mode-line-p
490 (setq growth (- y bot -1)))
491 (t ; header line
492 (when (< (- bot y) window-min-height)
493 (setq y (- bot window-min-height)))
494 ;; The window's top includes the header line!
495 (setq growth (- top y))))
496 (setq wconfig (current-window-configuration))
498 ;; Check for an error case.
499 (when (and (/= growth 0)
500 (not minibuffer)
501 (one-window-p t))
502 (error "Attempt to resize sole window"))
504 ;; If we ever move, make sure we don't mistakenly treat
505 ;; some unexpected `mouse-1' final event as a sign that
506 ;; this whole drag was nothing more than a click.
507 (if (/= growth 0) (setq on-link nil))
509 ;; grow/shrink minibuffer?
510 (if should-enlarge-minibuffer
511 (unless resize-mini-windows
512 (mouse-drag-move-window-bottom start-event-window growth))
513 ;; no. grow/shrink the selected window
514 ;(message "growth = %d" growth)
515 (if mode-line-p
516 (mouse-drag-move-window-bottom start-event-window growth)
517 (mouse-drag-move-window-top start-event-window growth)))
519 ;; if this window's growth caused another
520 ;; window to be deleted because it was too
521 ;; short, rescind the change.
523 ;; if size change caused space to be stolen
524 ;; from a window above this one, rescind the
525 ;; change, but only if we didn't grow/shrink
526 ;; the minibuffer. minibuffer size changes
527 ;; can cause all windows to shrink... no way
528 ;; around it.
529 (when (or (/= start-nwindows (count-windows t))
530 (and (not should-enlarge-minibuffer)
531 (> growth 0)
532 mode-line-p
533 (/= top
534 (nth 1 (window-edges
535 ;; Choose right window.
536 start-event-window)))))
537 (set-window-configuration wconfig)))))
539 ;; Presumably if this was just a click, the last event should
540 ;; be `mouse-1', whereas if this did move the mouse, it should be
541 ;; a `drag-mouse-1'. In any case `on-link' would have been nulled
542 ;; above if there had been any significant mouse movement.
543 (when (and on-link (eq 'mouse-1 (car-safe event)))
544 ;; If mouse-2 has never been done by the user, it doesn't
545 ;; have the necessary property to be interpreted correctly.
546 (put 'mouse-2 'event-kind 'mouse-click)
547 (push (cons 'mouse-2 (cdr event)) unread-command-events))))))
549 (defun mouse-drag-mode-line (start-event)
550 "Change the height of a window by dragging on the mode line."
551 (interactive "e")
552 (mouse-drag-mode-line-1 start-event t))
554 (defun mouse-drag-header-line (start-event)
555 "Change the height of a window by dragging on the header line.
556 Windows whose header-lines are at the top of the frame cannot be
557 resized by dragging their header-line."
558 (interactive "e")
559 ;; Changing the window's size by dragging its header-line when the
560 ;; header-line is at the top of the frame is somewhat strange,
561 ;; because the header-line doesn't move, so don't do it.
562 (let* ((start (event-start start-event))
563 (window (posn-window start))
564 (frame (window-frame window))
565 (first-window (frame-first-window frame)))
566 (unless (or (eq window first-window)
567 (= (nth 1 (window-edges window))
568 (nth 1 (window-edges first-window))))
569 (mouse-drag-mode-line-1 start-event nil))))
572 (defun mouse-drag-vertical-line-rightward-window (window)
573 "Return a window that is immediately to the right of WINDOW, or nil."
574 (let ((bottom (nth 3 (window-inside-edges window)))
575 (left (nth 0 (window-inside-edges window)))
576 best best-right
577 (try (previous-window window)))
578 (while (not (eq try window))
579 (let ((try-top (nth 1 (window-inside-edges try)))
580 (try-bottom (nth 3 (window-inside-edges try)))
581 (try-right (nth 2 (window-inside-edges try))))
582 (if (and (< try-top bottom)
583 (>= try-bottom bottom)
584 (< try-right left)
585 (or (null best-right) (> try-right best-right)))
586 (setq best-right try-right best try)))
587 (setq try (previous-window try)))
588 best))
590 (defun mouse-drag-vertical-line (start-event)
591 "Change the width of a window by dragging on the vertical line."
592 (interactive "e")
593 ;; Give temporary modes such as isearch a chance to turn off.
594 (run-hooks 'mouse-leave-buffer-hook)
595 (let* ((done nil)
596 (echo-keystrokes 0)
597 (start-event-frame (window-frame (car (car (cdr start-event)))))
598 (start-event-window (car (car (cdr start-event))))
599 event mouse x left right edges growth
600 (which-side
601 (or (cdr (assq 'vertical-scroll-bars (frame-parameters start-event-frame)))
602 'right)))
603 (cond
604 ((one-window-p t)
605 (error "Attempt to resize sole ordinary window"))
606 ((and (eq which-side 'right)
607 (>= (nth 2 (window-inside-edges start-event-window))
608 (frame-width start-event-frame)))
609 (error "Attempt to drag rightmost scrollbar"))
610 ((and (eq which-side 'left)
611 (= (nth 0 (window-inside-edges start-event-window)) 0))
612 (error "Attempt to drag leftmost scrollbar")))
613 (track-mouse
614 (progn
615 ;; loop reading events and sampling the position of
616 ;; the mouse.
617 (while (not done)
618 (setq event (read-event)
619 mouse (mouse-position))
620 ;; do nothing if
621 ;; - there is a switch-frame event.
622 ;; - the mouse isn't in the frame that we started in
623 ;; - the mouse isn't in any Emacs frame
624 ;; drag if
625 ;; - there is a mouse-movement event
626 ;; - there is a scroll-bar-movement event
627 ;; (same as mouse movement for our purposes)
628 ;; quit if
629 ;; - there is a keyboard event or some other unknown event
630 ;; unknown event.
631 (cond ((integerp event)
632 (setq done t))
633 ((memq (car event) '(switch-frame select-window))
634 nil)
635 ((not (memq (car event)
636 '(mouse-movement scroll-bar-movement)))
637 (if (consp event)
638 (setq unread-command-events
639 (cons event unread-command-events)))
640 (setq done t))
641 ((not (eq (car mouse) start-event-frame))
642 nil)
643 ((null (car (cdr mouse)))
644 nil)
646 (let ((window
647 ;; If the scroll bar is on the window's left,
648 ;; adjust the window on the left.
649 (if (eq which-side 'right)
650 start-event-window
651 (mouse-drag-vertical-line-rightward-window
652 start-event-window))))
653 (setq x (- (car (cdr mouse))
654 (if (eq which-side 'right) 0 2))
655 edges (window-edges window)
656 left (nth 0 edges)
657 right (nth 2 edges))
658 ;; scale back a move that would make the
659 ;; window too thin.
660 (if (< (- x left -1) window-min-width)
661 (setq x (+ left window-min-width -1)))
662 ;; compute size change needed
663 (setq growth (- x right -1))
664 (condition-case nil
665 (adjust-window-trailing-edge window growth t)
666 (error nil))))))))))
668 (defun mouse-set-point (event)
669 "Move point to the position clicked on with the mouse.
670 This should be bound to a mouse click event type."
671 (interactive "e")
672 (mouse-minibuffer-check event)
673 ;; Use event-end in case called from mouse-drag-region.
674 ;; If EVENT is a click, event-end and event-start give same value.
675 (posn-set-point (event-end event)))
677 (defvar mouse-last-region-beg nil)
678 (defvar mouse-last-region-end nil)
679 (defvar mouse-last-region-tick nil)
681 (defun mouse-region-match ()
682 "Return non-nil if there's an active region that was set with the mouse."
683 (and (mark t) mark-active
684 (eq mouse-last-region-beg (region-beginning))
685 (eq mouse-last-region-end (region-end))
686 (eq mouse-last-region-tick (buffer-modified-tick))))
688 (defun mouse-set-region (click)
689 "Set the region to the text dragged over, and copy to kill ring.
690 This should be bound to a mouse drag event.
691 See the `mouse-drag-copy-region' variable to control whether this
692 command alters the kill ring or not."
693 (interactive "e")
694 (mouse-minibuffer-check click)
695 (select-window (posn-window (event-start click)))
696 (let ((beg (posn-point (event-start click)))
697 (end (posn-point (event-end click))))
698 (and mouse-drag-copy-region (integerp beg) (integerp end)
699 ;; Don't set this-command to `kill-region', so a following
700 ;; C-w won't double the text in the kill ring. Ignore
701 ;; `last-command' so we don't append to a preceding kill.
702 (let (this-command last-command deactivate-mark)
703 (copy-region-as-kill beg end)))
704 (if (numberp beg) (goto-char beg))
705 ;; On a text terminal, bounce the cursor.
706 (or transient-mark-mode
707 (window-system)
708 (sit-for 1))
709 (push-mark)
710 (set-mark (point))
711 (if (numberp end) (goto-char end))
712 (mouse-set-region-1)))
714 (defun mouse-set-region-1 ()
715 ;; Set transient-mark-mode for a little while.
716 (unless (eq (car-safe transient-mark-mode) 'only)
717 (setq transient-mark-mode
718 (cons 'only
719 (unless (eq transient-mark-mode 'lambda)
720 transient-mark-mode))))
721 (setq mouse-last-region-beg (region-beginning))
722 (setq mouse-last-region-end (region-end))
723 (setq mouse-last-region-tick (buffer-modified-tick)))
725 (defcustom mouse-scroll-delay 0.25
726 "The pause between scroll steps caused by mouse drags, in seconds.
727 If you drag the mouse beyond the edge of a window, Emacs scrolls the
728 window to bring the text beyond that edge into view, with a delay of
729 this many seconds between scroll steps. Scrolling stops when you move
730 the mouse back into the window, or release the button.
731 This variable's value may be non-integral.
732 Setting this to zero causes Emacs to scroll as fast as it can."
733 :type 'number
734 :group 'mouse)
736 (defcustom mouse-scroll-min-lines 1
737 "The minimum number of lines scrolled by dragging mouse out of window.
738 Moving the mouse out the top or bottom edge of the window begins
739 scrolling repeatedly. The number of lines scrolled per repetition
740 is normally equal to the number of lines beyond the window edge that
741 the mouse has moved. However, it always scrolls at least the number
742 of lines specified by this variable."
743 :type 'integer
744 :group 'mouse)
746 (defun mouse-scroll-subr (window jump &optional overlay start)
747 "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
748 If OVERLAY is an overlay, let it stretch from START to the far edge of
749 the newly visible text.
750 Upon exit, point is at the far edge of the newly visible text."
751 (cond
752 ((and (> jump 0) (< jump mouse-scroll-min-lines))
753 (setq jump mouse-scroll-min-lines))
754 ((and (< jump 0) (< (- jump) mouse-scroll-min-lines))
755 (setq jump (- mouse-scroll-min-lines))))
756 (let ((opoint (point)))
757 (while (progn
758 (goto-char (window-start window))
759 (if (not (zerop (vertical-motion jump window)))
760 (progn
761 (set-window-start window (point))
762 (if (natnump jump)
763 (if (window-end window)
764 (progn
765 (goto-char (window-end window))
766 ;; window-end doesn't reflect the window's new
767 ;; start position until the next redisplay.
768 (vertical-motion (1- jump) window))
769 (vertical-motion (- (window-height window) 2)))
770 (goto-char (window-start window)))
771 (if overlay
772 (move-overlay overlay start (point)))
773 ;; Now that we have scrolled WINDOW properly,
774 ;; put point back where it was for the redisplay
775 ;; so that we don't mess up the selected window.
776 (or (eq window (selected-window))
777 (goto-char opoint))
778 (sit-for mouse-scroll-delay)))))
779 (or (eq window (selected-window))
780 (goto-char opoint))))
782 (defvar mouse-selection-click-count 0)
784 (defvar mouse-selection-click-count-buffer nil)
786 (defun mouse-drag-region (start-event)
787 "Set the region to the text that the mouse is dragged over.
788 Highlight the drag area as you move the mouse.
789 This must be bound to a button-down mouse event.
790 In Transient Mark mode, the highlighting remains as long as the mark
791 remains active. Otherwise, it remains until the next input event.
793 If the click is in the echo area, display the `*Messages*' buffer."
794 (interactive "e")
795 ;; Give temporary modes such as isearch a chance to turn off.
796 (run-hooks 'mouse-leave-buffer-hook)
797 (mouse-drag-track start-event t))
800 (defun mouse-posn-property (pos property)
801 "Look for a property at click position.
802 POS may be either a buffer position or a click position like
803 those returned from `event-start'. If the click position is on
804 a string, the text property PROPERTY is examined.
805 If this is nil or the click is not on a string, then
806 the corresponding buffer position is searched for PROPERTY.
807 If PROPERTY is encountered in one of those places,
808 its value is returned."
809 (if (consp pos)
810 (let ((w (posn-window pos)) (pt (posn-point pos))
811 (str (posn-string pos)))
812 (or (and str
813 (get-text-property (cdr str) property (car str)))
814 (and pt
815 (get-char-property pt property w))))
816 (get-char-property pos property)))
818 (defun mouse-on-link-p (pos)
819 "Return non-nil if POS is on a link in the current buffer.
820 POS must be a buffer position in the current buffer or a mouse
821 event location in the selected window (see `event-start').
822 However, if `mouse-1-click-in-non-selected-windows' is non-nil,
823 POS may be a mouse event location in any window.
825 A clickable link is identified by one of the following methods:
827 - If the character at POS has a non-nil `follow-link' text or
828 overlay property, the value of that property determines what to do.
830 - If there is a local key-binding or a keybinding at position POS
831 for the `follow-link' event, the binding of that event determines
832 what to do.
834 The resulting value determine whether POS is inside a link:
836 - If the value is `mouse-face', POS is inside a link if there
837 is a non-nil `mouse-face' property at POS. Return t in this case.
839 - If the value is a function, FUNC, POS is inside a link if
840 the call \(FUNC POS) returns non-nil. Return the return value
841 from that call. Arg is \(posn-point POS) if POS is a mouse event.
843 - Otherwise, return the value itself.
845 The return value is interpreted as follows:
847 - If it is a string, the mouse-1 event is translated into the
848 first character of the string, i.e. the action of the mouse-1
849 click is the local or global binding of that character.
851 - If it is a vector, the mouse-1 event is translated into the
852 first element of that vector, i.e. the action of the mouse-1
853 click is the local or global binding of that event.
855 - Otherwise, the mouse-1 event is translated into a mouse-2 event
856 at the same position."
857 (let ((action
858 (and (or (not (consp pos))
859 mouse-1-click-in-non-selected-windows
860 (eq (selected-window) (posn-window pos)))
861 (or (mouse-posn-property pos 'follow-link)
862 (key-binding [follow-link] nil t pos)))))
863 (cond
864 ((eq action 'mouse-face)
865 (and (mouse-posn-property pos 'mouse-face) t))
866 ((functionp action)
867 ;; FIXME: This seems questionable if the click is not in a buffer.
868 ;; Should we instead decide that `action' takes a `posn'?
869 (if (consp pos)
870 (with-current-buffer (window-buffer (posn-window pos))
871 (funcall action (posn-point pos)))
872 (funcall action pos)))
873 (t action))))
875 (defun mouse-fixup-help-message (msg)
876 "Fix help message MSG for `mouse-1-click-follows-link'."
877 (let (mp pos)
878 (if (and mouse-1-click-follows-link
879 (stringp msg)
880 (string-match-p "\\`mouse-2" msg)
881 (setq mp (mouse-pixel-position))
882 (consp (setq pos (cdr mp)))
883 (car pos) (>= (car pos) 0)
884 (cdr pos) (>= (cdr pos) 0)
885 (setq pos (posn-at-x-y (car pos) (cdr pos) (car mp)))
886 (windowp (posn-window pos)))
887 (with-current-buffer (window-buffer (posn-window pos))
888 (if (mouse-on-link-p pos)
889 (setq msg (concat
890 (cond
891 ((eq mouse-1-click-follows-link 'double) "double-")
892 ((and (integerp mouse-1-click-follows-link)
893 (< mouse-1-click-follows-link 0)) "Long ")
894 (t ""))
895 "mouse-1" (substring msg 7)))))))
896 msg)
898 (defun mouse-drag-track (start-event &optional
899 do-mouse-drag-region-post-process)
900 "Track mouse drags by highlighting area between point and cursor.
901 The region will be defined with mark and point.
902 DO-MOUSE-DRAG-REGION-POST-PROCESS should only be used by
903 `mouse-drag-region'."
904 (mouse-minibuffer-check start-event)
905 (setq mouse-selection-click-count-buffer (current-buffer))
906 (deactivate-mark)
907 (let* ((original-window (selected-window))
908 ;; We've recorded what we needed from the current buffer and
909 ;; window, now let's jump to the place of the event, where things
910 ;; are happening.
911 (_ (mouse-set-point start-event))
912 (echo-keystrokes 0)
913 (start-posn (event-start start-event))
914 (start-point (posn-point start-posn))
915 (start-window (posn-window start-posn))
916 (start-window-start (window-start start-window))
917 (start-hscroll (window-hscroll start-window))
918 (bounds (window-edges start-window))
919 (make-cursor-line-fully-visible nil)
920 (top (nth 1 bounds))
921 (bottom (if (window-minibuffer-p start-window)
922 (nth 3 bounds)
923 ;; Don't count the mode line.
924 (1- (nth 3 bounds))))
925 (on-link (and mouse-1-click-follows-link
926 (or mouse-1-click-in-non-selected-windows
927 (eq start-window original-window))
928 ;; Use start-point before the intangibility
929 ;; treatment, in case we click on a link inside an
930 ;; intangible text.
931 (mouse-on-link-p start-posn)))
932 (click-count (1- (event-click-count start-event)))
933 (remap-double-click (and on-link
934 (eq mouse-1-click-follows-link 'double)
935 (= click-count 1)))
936 ;; Suppress automatic hscrolling, because that is a nuisance
937 ;; when setting point near the right fringe (but see below).
938 (automatic-hscrolling-saved automatic-hscrolling)
939 (automatic-hscrolling nil)
940 event end end-point)
942 (setq mouse-selection-click-count click-count)
943 ;; In case the down click is in the middle of some intangible text,
944 ;; use the end of that text, and put it in START-POINT.
945 (if (< (point) start-point)
946 (goto-char start-point))
947 (setq start-point (point))
948 (if remap-double-click
949 (setq click-count 0))
951 ;; Activate the region, using `mouse-start-end' to determine where
952 ;; to put point and mark (e.g., double-click will select a word).
953 (setq transient-mark-mode
954 (if (eq transient-mark-mode 'lambda)
955 '(only)
956 (cons 'only transient-mark-mode)))
957 (let ((range (mouse-start-end start-point start-point click-count)))
958 (push-mark (nth 0 range) t t)
959 (goto-char (nth 1 range)))
961 ;; Track the mouse until we get a non-movement event.
962 (track-mouse
963 (while (progn
964 (setq event (read-event))
965 (or (mouse-movement-p event)
966 (memq (car-safe event) '(switch-frame select-window))))
967 (unless (memq (car-safe event) '(switch-frame select-window))
968 ;; Automatic hscrolling did not occur during the call to
969 ;; `read-event'; but if the user subsequently drags the
970 ;; mouse, go ahead and hscroll.
971 (let ((automatic-hscrolling automatic-hscrolling-saved))
972 (redisplay))
973 (setq end (event-end event)
974 end-point (posn-point end))
975 (if (and (eq (posn-window end) start-window)
976 (integer-or-marker-p end-point))
977 (mouse--drag-set-mark-and-point start-point
978 end-point click-count)
979 (let ((mouse-row (cdr (cdr (mouse-position)))))
980 (cond
981 ((null mouse-row))
982 ((< mouse-row top)
983 (mouse-scroll-subr start-window (- mouse-row top)
984 nil start-point))
985 ((>= mouse-row bottom)
986 (mouse-scroll-subr start-window (1+ (- mouse-row bottom))
987 nil start-point))))))))
989 ;; Handle the terminating event if possible.
990 (when (consp event)
991 ;; Ensure that point is on the end of the last event.
992 (when (and (setq end-point (posn-point (event-end event)))
993 (eq (posn-window end) start-window)
994 (integer-or-marker-p end-point)
995 (/= start-point end-point))
996 (mouse--drag-set-mark-and-point start-point
997 end-point click-count))
999 ;; Find its binding.
1000 (let* ((fun (key-binding (vector (car event))))
1001 (do-multi-click (and (> (event-click-count event) 0)
1002 (functionp fun)
1003 (not (memq fun '(mouse-set-point
1004 mouse-set-region))))))
1005 (if (and (/= (mark) (point))
1006 (not do-multi-click))
1008 ;; If point has moved, finish the drag.
1009 (let* (last-command this-command)
1010 (and mouse-drag-copy-region
1011 do-mouse-drag-region-post-process
1012 (let (deactivate-mark)
1013 (copy-region-as-kill (mark) (point)))))
1015 ;; If point hasn't moved, run the binding of the
1016 ;; terminating up-event.
1017 (if do-multi-click
1018 (goto-char start-point)
1019 (deactivate-mark))
1020 (when (and (functionp fun)
1021 (= start-hscroll (window-hscroll start-window))
1022 ;; Don't run the up-event handler if the window
1023 ;; start changed in a redisplay after the
1024 ;; mouse-set-point for the down-mouse event at
1025 ;; the beginning of this function. When the
1026 ;; window start has changed, the up-mouse event
1027 ;; contains a different position due to the new
1028 ;; window contents, and point is set again.
1029 (or end-point
1030 (= (window-start start-window)
1031 start-window-start)))
1032 (when (and on-link
1033 (= start-point (point))
1034 (mouse--remap-link-click-p start-event event))
1035 ;; If we rebind to mouse-2, reselect previous selected
1036 ;; window, so that the mouse-2 event runs in the same
1037 ;; situation as if user had clicked it directly. Fixes
1038 ;; the bug reported by juri@jurta.org on 2005-12-27.
1039 (if (or (vectorp on-link) (stringp on-link))
1040 (setq event (aref on-link 0))
1041 (select-window original-window)
1042 (setcar event 'mouse-2)
1043 ;; If this mouse click has never been done by the
1044 ;; user, it doesn't have the necessary property to be
1045 ;; interpreted correctly.
1046 (put 'mouse-2 'event-kind 'mouse-click)))
1047 (push event unread-command-events)))))))
1049 (defun mouse--drag-set-mark-and-point (start click click-count)
1050 (let* ((range (mouse-start-end start click click-count))
1051 (beg (nth 0 range))
1052 (end (nth 1 range)))
1053 (cond ((eq (mark) beg)
1054 (goto-char end))
1055 ((eq (mark) end)
1056 (goto-char beg))
1057 ((< click (mark))
1058 (set-mark end)
1059 (goto-char beg))
1061 (set-mark beg)
1062 (goto-char end)))))
1064 (defun mouse--remap-link-click-p (start-event end-event)
1065 (or (and (eq mouse-1-click-follows-link 'double)
1066 (= (event-click-count start-event) 2))
1067 (and
1068 (not (eq mouse-1-click-follows-link 'double))
1069 (= (event-click-count start-event) 1)
1070 (= (event-click-count end-event) 1)
1071 (or (not (integerp mouse-1-click-follows-link))
1072 (let ((t0 (posn-timestamp (event-start start-event)))
1073 (t1 (posn-timestamp (event-end end-event))))
1074 (and (integerp t0) (integerp t1)
1075 (if (> mouse-1-click-follows-link 0)
1076 (<= (- t1 t0) mouse-1-click-follows-link)
1077 (< (- t0 t1) mouse-1-click-follows-link))))))))
1080 ;; Commands to handle xterm-style multiple clicks.
1081 (defun mouse-skip-word (dir)
1082 "Skip over word, over whitespace, or over identical punctuation.
1083 If DIR is positive skip forward; if negative, skip backward."
1084 (let* ((char (following-char))
1085 (syntax (char-to-string (char-syntax char))))
1086 (cond ((string= syntax "w")
1087 ;; Here, we can't use skip-syntax-forward/backward because
1088 ;; they don't pay attention to word-separating-categories,
1089 ;; and thus they will skip over a true word boundary. So,
1090 ;; we simulate the original behavior by using forward-word.
1091 (if (< dir 0)
1092 (if (not (looking-at "\\<"))
1093 (forward-word -1))
1094 (if (or (looking-at "\\<") (not (looking-at "\\>")))
1095 (forward-word 1))))
1096 ((string= syntax " ")
1097 (if (< dir 0)
1098 (skip-syntax-backward syntax)
1099 (skip-syntax-forward syntax)))
1100 ((string= syntax "_")
1101 (if (< dir 0)
1102 (skip-syntax-backward "w_")
1103 (skip-syntax-forward "w_")))
1104 ((< dir 0)
1105 (while (and (not (bobp)) (= (preceding-char) char))
1106 (forward-char -1)))
1108 (while (and (not (eobp)) (= (following-char) char))
1109 (forward-char 1))))))
1111 (defun mouse-start-end (start end mode)
1112 "Return a list of region bounds based on START and END according to MODE.
1113 If MODE is 0 then set point to (min START END), mark to (max START END).
1114 If MODE is 1 then set point to start of word at (min START END),
1115 mark to end of word at (max START END).
1116 If MODE is 2 then do the same for lines."
1117 (if (> start end)
1118 (let ((temp start))
1119 (setq start end
1120 end temp)))
1121 (setq mode (mod mode 3))
1122 (cond ((= mode 0)
1123 (list start end))
1124 ((and (= mode 1)
1125 (= start end)
1126 (char-after start)
1127 (= (char-syntax (char-after start)) ?\())
1128 (list start
1129 (save-excursion
1130 (goto-char start)
1131 (forward-sexp 1)
1132 (point))))
1133 ((and (= mode 1)
1134 (= start end)
1135 (char-after start)
1136 (= (char-syntax (char-after start)) ?\)))
1137 (list (save-excursion
1138 (goto-char (1+ start))
1139 (backward-sexp 1)
1140 (point))
1141 (1+ start)))
1142 ((and (= mode 1)
1143 (= start end)
1144 (char-after start)
1145 (= (char-syntax (char-after start)) ?\"))
1146 (let ((open (or (eq start (point-min))
1147 (save-excursion
1148 (goto-char (- start 1))
1149 (looking-at "\\s(\\|\\s \\|\\s>")))))
1150 (if open
1151 (list start
1152 (save-excursion
1153 (condition-case nil
1154 (progn
1155 (goto-char start)
1156 (forward-sexp 1)
1157 (point))
1158 (error end))))
1159 (list (save-excursion
1160 (condition-case nil
1161 (progn
1162 (goto-char (1+ start))
1163 (backward-sexp 1)
1164 (point))
1165 (error end)))
1166 (1+ start)))))
1167 ((= mode 1)
1168 (list (save-excursion
1169 (goto-char start)
1170 (mouse-skip-word -1)
1171 (point))
1172 (save-excursion
1173 (goto-char end)
1174 (mouse-skip-word 1)
1175 (point))))
1176 ((= mode 2)
1177 (list (save-excursion
1178 (goto-char start)
1179 (line-beginning-position 1))
1180 (save-excursion
1181 (goto-char end)
1182 (forward-line 1)
1183 (point))))))
1185 ;; Subroutine: set the mark where CLICK happened,
1186 ;; but don't do anything else.
1187 (defun mouse-set-mark-fast (click)
1188 (mouse-minibuffer-check click)
1189 (let ((posn (event-start click)))
1190 (select-window (posn-window posn))
1191 (if (numberp (posn-point posn))
1192 (push-mark (posn-point posn) t t))))
1194 (defun mouse-undouble-last-event (events)
1195 (let* ((index (1- (length events)))
1196 (last (nthcdr index events))
1197 (event (car last))
1198 (basic (event-basic-type event))
1199 (old-modifiers (event-modifiers event))
1200 (modifiers (delq 'double (delq 'triple (copy-sequence old-modifiers))))
1201 (new
1202 (if (consp event)
1203 ;; Use reverse, not nreverse, since event-modifiers
1204 ;; does not copy the list it returns.
1205 (cons (event-convert-list (reverse (cons basic modifiers)))
1206 (cdr event))
1207 event)))
1208 (setcar last new)
1209 (if (and (not (equal modifiers old-modifiers))
1210 (key-binding (apply 'vector events)))
1212 (setcar last event)
1213 nil)))
1215 ;; Momentarily show where the mark is, if highlighting doesn't show it.
1217 (defun mouse-set-mark (click)
1218 "Set mark at the position clicked on with the mouse.
1219 Display cursor at that position for a second.
1220 This must be bound to a mouse click."
1221 (interactive "e")
1222 (mouse-minibuffer-check click)
1223 (select-window (posn-window (event-start click)))
1224 ;; We don't use save-excursion because that preserves the mark too.
1225 (let ((point-save (point)))
1226 (unwind-protect
1227 (progn (mouse-set-point click)
1228 (push-mark nil t t)
1229 (or transient-mark-mode
1230 (sit-for 1)))
1231 (goto-char point-save))))
1233 (defun mouse-kill (click)
1234 "Kill the region between point and the mouse click.
1235 The text is saved in the kill ring, as with \\[kill-region]."
1236 (interactive "e")
1237 (mouse-minibuffer-check click)
1238 (let* ((posn (event-start click))
1239 (click-posn (posn-point posn)))
1240 (select-window (posn-window posn))
1241 (if (numberp click-posn)
1242 (kill-region (min (point) click-posn)
1243 (max (point) click-posn)))))
1245 (defun mouse-yank-at-click (click arg)
1246 "Insert the last stretch of killed text at the position clicked on.
1247 Also move point to one end of the text thus inserted (normally the end),
1248 and set mark at the beginning.
1249 Prefix arguments are interpreted as with \\[yank].
1250 If `mouse-yank-at-point' is non-nil, insert at point
1251 regardless of where you click."
1252 (interactive "e\nP")
1253 ;; Give temporary modes such as isearch a chance to turn off.
1254 (run-hooks 'mouse-leave-buffer-hook)
1255 (when select-active-regions
1256 ;; Without this, confusing things happen upon e.g. inserting into
1257 ;; the middle of an active region.
1258 (deactivate-mark))
1259 (or mouse-yank-at-point (mouse-set-point click))
1260 (setq this-command 'yank)
1261 (setq mouse-selection-click-count 0)
1262 (yank arg))
1264 (defun mouse-yank-primary (click)
1265 "Insert the primary selection at the position clicked on.
1266 Move point to the end of the inserted text.
1267 If `mouse-yank-at-point' is non-nil, insert at point
1268 regardless of where you click."
1269 (interactive "e")
1270 ;; Give temporary modes such as isearch a chance to turn off.
1271 (run-hooks 'mouse-leave-buffer-hook)
1272 ;; Without this, confusing things happen upon e.g. inserting into
1273 ;; the middle of an active region.
1274 (when select-active-regions
1275 (let (select-active-regions)
1276 (deactivate-mark)))
1277 (or mouse-yank-at-point (mouse-set-point click))
1278 (let ((primary
1279 (cond
1280 ((eq system-type 'windows-nt)
1281 ;; MS-Windows emulates PRIMARY in x-get-selection, but not
1282 ;; in x-get-selection-value (the latter only accesses the
1283 ;; clipboard). So try PRIMARY first, in case they selected
1284 ;; something with the mouse in the current Emacs session.
1285 (or (x-get-selection 'PRIMARY)
1286 (x-get-selection-value)))
1287 ((fboundp 'x-get-selection-value) ; MS-DOS and X.
1288 ;; On X, x-get-selection-value supports more formats and
1289 ;; encodings, so use it in preference to x-get-selection.
1290 (or (x-get-selection-value)
1291 (x-get-selection 'PRIMARY)))
1292 ;; FIXME: What about xterm-mouse-mode etc.?
1294 (x-get-selection 'PRIMARY)))))
1295 (if primary
1296 (insert primary)
1297 (error "No selection is available"))))
1299 (defun mouse-kill-ring-save (click)
1300 "Copy the region between point and the mouse click in the kill ring.
1301 This does not delete the region; it acts like \\[kill-ring-save]."
1302 (interactive "e")
1303 (mouse-set-mark-fast click)
1304 (let (this-command last-command)
1305 (kill-ring-save (point) (mark t))))
1307 ;; This function used to delete the text between point and the mouse
1308 ;; whenever it was equal to the front of the kill ring, but some
1309 ;; people found that confusing.
1311 ;; The position of the last invocation of `mouse-save-then-kill'.
1312 (defvar mouse-save-then-kill-posn nil)
1314 (defun mouse-save-then-kill-delete-region (beg end)
1315 ;; We must make our own undo boundaries
1316 ;; because they happen automatically only for the current buffer.
1317 (undo-boundary)
1318 (if (or (= beg end) (eq buffer-undo-list t))
1319 ;; If we have no undo list in this buffer,
1320 ;; just delete.
1321 (delete-region beg end)
1322 ;; Delete, but make the undo-list entry share with the kill ring.
1323 ;; First, delete just one char, so in case buffer is being modified
1324 ;; for the first time, the undo list records that fact.
1325 (let (before-change-functions after-change-functions)
1326 (delete-region beg
1327 (+ beg (if (> end beg) 1 -1))))
1328 (let ((buffer-undo-list buffer-undo-list))
1329 ;; Undo that deletion--but don't change the undo list!
1330 (let (before-change-functions after-change-functions)
1331 (primitive-undo 1 buffer-undo-list))
1332 ;; Now delete the rest of the specified region,
1333 ;; but don't record it.
1334 (setq buffer-undo-list t)
1335 (if (/= (length (car kill-ring)) (- (max end beg) (min end beg)))
1336 (error "Lossage in mouse-save-then-kill-delete-region"))
1337 (delete-region beg end))
1338 (let ((tail buffer-undo-list))
1339 ;; Search back in buffer-undo-list for the string
1340 ;; that came from deleting one character.
1341 (while (and tail (not (stringp (car (car tail)))))
1342 (setq tail (cdr tail)))
1343 ;; Replace it with an entry for the entire deleted text.
1344 (and tail
1345 (setcar tail (cons (car kill-ring) (min beg end))))))
1346 (undo-boundary))
1348 (defun mouse-save-then-kill (click)
1349 "Set the region according to CLICK; the second time, kill it.
1350 CLICK should be a mouse click event.
1352 If the region is inactive, activate it temporarily. Set mark at
1353 the original point, and move point to the position of CLICK.
1355 If the region is already active, adjust it. Normally, do this by
1356 moving point or mark, whichever is closer, to CLICK. But if you
1357 have selected whole words or lines, move point or mark to the
1358 word or line boundary closest to CLICK instead.
1360 If `mouse-drag-copy-region' is non-nil, this command also saves the
1361 new region to the kill ring (replacing the previous kill if the
1362 previous region was just saved to the kill ring).
1364 If this command is called a second consecutive time with the same
1365 CLICK position, kill the region (or delete it
1366 if `mouse-drag-copy-region' is non-nil)"
1367 (interactive "e")
1368 (mouse-minibuffer-check click)
1369 (let* ((posn (event-start click))
1370 (click-pt (posn-point posn))
1371 (window (posn-window posn))
1372 (buf (window-buffer window))
1373 ;; Don't let a subsequent kill command append to this one.
1374 (this-command this-command)
1375 ;; Check if the user has multi-clicked to select words/lines.
1376 (click-count
1377 (if (and (eq mouse-selection-click-count-buffer buf)
1378 (with-current-buffer buf (mark t)))
1379 mouse-selection-click-count
1380 0)))
1381 (cond
1382 ((not (numberp click-pt)) nil)
1383 ;; If the user clicked without moving point, kill the region.
1384 ;; This also resets `mouse-selection-click-count'.
1385 ((and (eq last-command 'mouse-save-then-kill)
1386 (eq click-pt mouse-save-then-kill-posn)
1387 (eq window (selected-window)))
1388 (if mouse-drag-copy-region
1389 ;; Region already saved in the previous click;
1390 ;; don't make a duplicate entry, just delete.
1391 (delete-region (mark t) (point))
1392 (kill-region (mark t) (point)))
1393 (setq mouse-selection-click-count 0)
1394 (setq mouse-save-then-kill-posn nil))
1396 ;; Otherwise, if there is a suitable region, adjust it by moving
1397 ;; one end (whichever is closer) to CLICK-PT.
1398 ((or (with-current-buffer buf (region-active-p))
1399 (and (eq window (selected-window))
1400 (mark t)
1401 (or (and (eq last-command 'mouse-save-then-kill)
1402 mouse-save-then-kill-posn)
1403 (and (memq last-command '(mouse-drag-region
1404 mouse-set-region))
1405 (or mark-even-if-inactive
1406 (not transient-mark-mode))))))
1407 (select-window window)
1408 (let* ((range (mouse-start-end click-pt click-pt click-count)))
1409 (if (< (abs (- click-pt (mark t)))
1410 (abs (- click-pt (point))))
1411 (set-mark (car range))
1412 (goto-char (nth 1 range)))
1413 (setq deactivate-mark nil)
1414 (mouse-set-region-1)
1415 (when mouse-drag-copy-region
1416 ;; Region already copied to kill-ring once, so replace.
1417 (kill-new (filter-buffer-substring (mark t) (point)) t))
1418 ;; Arrange for a repeated mouse-3 to kill the region.
1419 (setq mouse-save-then-kill-posn click-pt)))
1421 ;; Otherwise, set the mark where point is and move to CLICK-PT.
1423 (select-window window)
1424 (mouse-set-mark-fast click)
1425 (let ((before-scroll (with-current-buffer buf point-before-scroll)))
1426 (if before-scroll (goto-char before-scroll)))
1427 (exchange-point-and-mark)
1428 (mouse-set-region-1)
1429 (when mouse-drag-copy-region
1430 (kill-new (filter-buffer-substring (mark t) (point))))
1431 (setq mouse-save-then-kill-posn click-pt)))))
1434 (global-set-key [M-mouse-1] 'mouse-start-secondary)
1435 (global-set-key [M-drag-mouse-1] 'mouse-set-secondary)
1436 (global-set-key [M-down-mouse-1] 'mouse-drag-secondary)
1437 (global-set-key [M-mouse-3] 'mouse-secondary-save-then-kill)
1438 (global-set-key [M-mouse-2] 'mouse-yank-secondary)
1440 (defconst mouse-secondary-overlay
1441 (let ((ol (make-overlay (point-min) (point-min))))
1442 (delete-overlay ol)
1443 (overlay-put ol 'face 'secondary-selection)
1445 "An overlay which records the current secondary selection.
1446 It is deleted when there is no secondary selection.")
1448 (defvar mouse-secondary-click-count 0)
1450 ;; A marker which records the specified first end for a secondary selection.
1451 ;; May be nil.
1452 (defvar mouse-secondary-start nil)
1454 (defun mouse-start-secondary (click)
1455 "Set one end of the secondary selection to the position clicked on.
1456 Use \\[mouse-secondary-save-then-kill] to set the other end
1457 and complete the secondary selection."
1458 (interactive "e")
1459 (mouse-minibuffer-check click)
1460 (let ((posn (event-start click)))
1461 (with-current-buffer (window-buffer (posn-window posn))
1462 ;; Cancel any preexisting secondary selection.
1463 (delete-overlay mouse-secondary-overlay)
1464 (if (numberp (posn-point posn))
1465 (progn
1466 (or mouse-secondary-start
1467 (setq mouse-secondary-start (make-marker)))
1468 (move-marker mouse-secondary-start (posn-point posn)))))))
1470 (defun mouse-set-secondary (click)
1471 "Set the secondary selection to the text that the mouse is dragged over.
1472 This must be bound to a mouse drag event."
1473 (interactive "e")
1474 (mouse-minibuffer-check click)
1475 (let ((posn (event-start click))
1477 (end (event-end click)))
1478 (with-current-buffer (window-buffer (posn-window posn))
1479 (if (numberp (posn-point posn))
1480 (setq beg (posn-point posn)))
1481 (move-overlay mouse-secondary-overlay beg (posn-point end))
1482 (x-set-selection
1483 'SECONDARY
1484 (buffer-substring (overlay-start mouse-secondary-overlay)
1485 (overlay-end mouse-secondary-overlay))))))
1487 (defun mouse-drag-secondary (start-event)
1488 "Set the secondary selection to the text that the mouse is dragged over.
1489 Highlight the drag area as you move the mouse.
1490 This must be bound to a button-down mouse event.
1491 The function returns a non-nil value if it creates a secondary selection."
1492 (interactive "e")
1493 (mouse-minibuffer-check start-event)
1494 (let* ((echo-keystrokes 0)
1495 (start-posn (event-start start-event))
1496 (start-point (posn-point start-posn))
1497 (start-window (posn-window start-posn))
1498 (bounds (window-edges start-window))
1499 (top (nth 1 bounds))
1500 (bottom (if (window-minibuffer-p start-window)
1501 (nth 3 bounds)
1502 ;; Don't count the mode line.
1503 (1- (nth 3 bounds))))
1504 (click-count (1- (event-click-count start-event))))
1505 (with-current-buffer (window-buffer start-window)
1506 (setq mouse-secondary-click-count click-count)
1507 (if (> (mod click-count 3) 0)
1508 ;; Double or triple press: make an initial selection
1509 ;; of one word or line.
1510 (let ((range (mouse-start-end start-point start-point click-count)))
1511 (set-marker mouse-secondary-start nil)
1512 (move-overlay mouse-secondary-overlay (car range) (nth 1 range)
1513 (window-buffer start-window)))
1514 ;; Single-press: cancel any preexisting secondary selection.
1515 (or mouse-secondary-start
1516 (setq mouse-secondary-start (make-marker)))
1517 (set-marker mouse-secondary-start start-point)
1518 (delete-overlay mouse-secondary-overlay))
1519 (let (event end end-point)
1520 (track-mouse
1521 (while (progn
1522 (setq event (read-event))
1523 (or (mouse-movement-p event)
1524 (memq (car-safe event) '(switch-frame select-window))))
1526 (if (memq (car-safe event) '(switch-frame select-window))
1528 (setq end (event-end event)
1529 end-point (posn-point end))
1530 (cond
1531 ;; Are we moving within the original window?
1532 ((and (eq (posn-window end) start-window)
1533 (integer-or-marker-p end-point))
1534 (let ((range (mouse-start-end start-point end-point
1535 click-count)))
1536 (if (or (/= start-point end-point)
1537 (null (marker-position mouse-secondary-start)))
1538 (progn
1539 (set-marker mouse-secondary-start nil)
1540 (move-overlay mouse-secondary-overlay
1541 (car range) (nth 1 range))))))
1543 (let ((mouse-row (cdr (cdr (mouse-position)))))
1544 (cond
1545 ((null mouse-row))
1546 ((< mouse-row top)
1547 (mouse-scroll-subr start-window (- mouse-row top)
1548 mouse-secondary-overlay start-point))
1549 ((>= mouse-row bottom)
1550 (mouse-scroll-subr start-window (1+ (- mouse-row bottom))
1551 mouse-secondary-overlay start-point)))))))))
1553 (if (consp event)
1554 (if (marker-position mouse-secondary-start)
1555 (save-window-excursion
1556 (delete-overlay mouse-secondary-overlay)
1557 (x-set-selection 'SECONDARY nil)
1558 (select-window start-window)
1559 (save-excursion
1560 (goto-char mouse-secondary-start)
1561 (sit-for 1)
1562 nil))
1563 (x-set-selection
1564 'SECONDARY
1565 (buffer-substring (overlay-start mouse-secondary-overlay)
1566 (overlay-end mouse-secondary-overlay)))))))))
1568 (defun mouse-yank-secondary (click)
1569 "Insert the secondary selection at the position clicked on.
1570 Move point to the end of the inserted text.
1571 If `mouse-yank-at-point' is non-nil, insert at point
1572 regardless of where you click."
1573 (interactive "e")
1574 ;; Give temporary modes such as isearch a chance to turn off.
1575 (run-hooks 'mouse-leave-buffer-hook)
1576 (or mouse-yank-at-point (mouse-set-point click))
1577 (let ((secondary (x-get-selection 'SECONDARY)))
1578 (if secondary
1579 (insert secondary)
1580 (error "No secondary selection"))))
1582 (defun mouse-kill-secondary ()
1583 "Kill the text in the secondary selection.
1584 This is intended more as a keyboard command than as a mouse command
1585 but it can work as either one.
1587 The current buffer (in case of keyboard use), or the buffer clicked on,
1588 must be the one that the secondary selection is in. This requirement
1589 is to prevent accidents."
1590 (interactive)
1591 (let* ((keys (this-command-keys))
1592 (click (elt keys (1- (length keys)))))
1593 (or (eq (overlay-buffer mouse-secondary-overlay)
1594 (if (listp click)
1595 (window-buffer (posn-window (event-start click)))
1596 (current-buffer)))
1597 (error "Select or click on the buffer where the secondary selection is")))
1598 (let (this-command)
1599 (with-current-buffer (overlay-buffer mouse-secondary-overlay)
1600 (kill-region (overlay-start mouse-secondary-overlay)
1601 (overlay-end mouse-secondary-overlay))))
1602 (delete-overlay mouse-secondary-overlay))
1604 (defun mouse-secondary-save-then-kill (click)
1605 "Set the secondary selection and save it to the kill ring.
1606 The second time, kill it. CLICK should be a mouse click event.
1608 If you have not called `mouse-start-secondary' in the clicked
1609 buffer, activate the secondary selection and set it between point
1610 and the click position CLICK.
1612 Otherwise, adjust the bounds of the secondary selection.
1613 Normally, do this by moving its beginning or end, whichever is
1614 closer, to CLICK. But if you have selected whole words or lines,
1615 adjust to the word or line boundary closest to CLICK instead.
1617 If this command is called a second consecutive time with the same
1618 CLICK position, kill the secondary selection."
1619 (interactive "e")
1620 (mouse-minibuffer-check click)
1621 (let* ((posn (event-start click))
1622 (click-pt (posn-point posn))
1623 (window (posn-window posn))
1624 (buf (window-buffer window))
1625 ;; Don't let a subsequent kill command append to this one.
1626 (this-command this-command)
1627 ;; Check if the user has multi-clicked to select words/lines.
1628 (click-count
1629 (if (eq (overlay-buffer mouse-secondary-overlay) buf)
1630 mouse-secondary-click-count
1632 (beg (overlay-start mouse-secondary-overlay))
1633 (end (overlay-end mouse-secondary-overlay)))
1635 (cond
1636 ((not (numberp click-pt)) nil)
1638 ;; If the secondary selection is not active in BUF, activate it.
1639 ((not (eq buf (or (overlay-buffer mouse-secondary-overlay)
1640 (if mouse-secondary-start
1641 (marker-buffer mouse-secondary-start)))))
1642 (select-window window)
1643 (setq mouse-secondary-start (make-marker))
1644 (move-marker mouse-secondary-start (point))
1645 (move-overlay mouse-secondary-overlay (point) click-pt buf)
1646 (kill-ring-save (point) click-pt))
1648 ;; If the user clicked without moving point, delete the secondary
1649 ;; selection. This also resets `mouse-secondary-click-count'.
1650 ((and (eq last-command 'mouse-secondary-save-then-kill)
1651 (eq click-pt mouse-save-then-kill-posn)
1652 (eq window (selected-window)))
1653 (mouse-save-then-kill-delete-region beg end)
1654 (delete-overlay mouse-secondary-overlay)
1655 (setq mouse-secondary-click-count 0)
1656 (setq mouse-save-then-kill-posn nil))
1658 ;; Otherwise, if there is a suitable secondary selection overlay,
1659 ;; adjust it by moving one end (whichever is closer) to CLICK-PT.
1660 ((and beg (eq buf (overlay-buffer mouse-secondary-overlay)))
1661 (let* ((range (mouse-start-end click-pt click-pt click-count)))
1662 (if (< (abs (- click-pt beg))
1663 (abs (- click-pt end)))
1664 (move-overlay mouse-secondary-overlay (car range) end)
1665 (move-overlay mouse-secondary-overlay beg (nth 1 range))))
1666 (setq deactivate-mark nil)
1667 (if (eq last-command 'mouse-secondary-save-then-kill)
1668 ;; If the front of the kill ring comes from an immediately
1669 ;; previous use of this command, replace the entry.
1670 (kill-new
1671 (buffer-substring (overlay-start mouse-secondary-overlay)
1672 (overlay-end mouse-secondary-overlay))
1674 (let (deactivate-mark)
1675 (copy-region-as-kill (overlay-start mouse-secondary-overlay)
1676 (overlay-end mouse-secondary-overlay))))
1677 (setq mouse-save-then-kill-posn click-pt))
1679 ;; Otherwise, set the secondary selection overlay.
1681 (select-window window)
1682 (if mouse-secondary-start
1683 ;; All we have is one end of a selection, so put the other
1684 ;; end here.
1685 (let ((start (+ 0 mouse-secondary-start)))
1686 (kill-ring-save start click-pt)
1687 (move-overlay mouse-secondary-overlay start click-pt)))
1688 (setq mouse-save-then-kill-posn click-pt))))
1690 ;; Finally, set the window system's secondary selection.
1691 (let (str)
1692 (and (overlay-buffer mouse-secondary-overlay)
1693 (setq str (buffer-substring (overlay-start mouse-secondary-overlay)
1694 (overlay-end mouse-secondary-overlay)))
1695 (> (length str) 0)
1696 (x-set-selection 'SECONDARY str))))
1699 (defcustom mouse-buffer-menu-maxlen 20
1700 "Number of buffers in one pane (submenu) of the buffer menu.
1701 If we have lots of buffers, divide them into groups of
1702 `mouse-buffer-menu-maxlen' and make a pane (or submenu) for each one."
1703 :type 'integer
1704 :group 'mouse)
1706 (defcustom mouse-buffer-menu-mode-mult 4
1707 "Group the buffers by the major mode groups on \\[mouse-buffer-menu]?
1708 This number which determines (in a hairy way) whether \\[mouse-buffer-menu]
1709 will split the buffer menu by the major modes (see
1710 `mouse-buffer-menu-mode-groups') or just by menu length.
1711 Set to 1 (or even 0!) if you want to group by major mode always, and to
1712 a large number if you prefer a mixed multitude. The default is 4."
1713 :type 'integer
1714 :group 'mouse
1715 :version "20.3")
1717 (defvar mouse-buffer-menu-mode-groups
1718 (mapcar (lambda (arg) (cons (purecopy (car arg)) (purecopy (cdr arg))))
1719 '(("Info\\|Help\\|Apropos\\|Man" . "Help")
1720 ("\\bVM\\b\\|\\bMH\\b\\|Message\\|Mail\\|Group\\|Score\\|Summary\\|Article"
1721 . "Mail/News")
1722 ("\\<C\\>" . "C")
1723 ("ObjC" . "C")
1724 ("Text" . "Text")
1725 ("Outline" . "Text")
1726 ("\\(HT\\|SG\\|X\\|XHT\\)ML" . "SGML")
1727 ("log\\|diff\\|vc\\|cvs\\|Annotate" . "Version Control") ; "Change Management"?
1728 ("Threads\\|Memory\\|Disassembly\\|Breakpoints\\|Frames\\|Locals\\|Registers\\|Inferior I/O\\|Debugger"
1729 . "GDB")
1730 ("Lisp" . "Lisp")))
1731 "How to group various major modes together in \\[mouse-buffer-menu].
1732 Each element has the form (REGEXP . GROUPNAME).
1733 If the major mode's name string matches REGEXP, use GROUPNAME instead.")
1735 (defun mouse-buffer-menu (event)
1736 "Pop up a menu of buffers for selection with the mouse.
1737 This switches buffers in the window that you clicked on,
1738 and selects that window."
1739 (interactive "e")
1740 (mouse-minibuffer-check event)
1741 (let ((buffers (buffer-list)) alist menu split-by-major-mode sum-of-squares)
1742 ;; Make an alist of elements that look like (MENU-ITEM . BUFFER).
1743 (dolist (buf buffers)
1744 ;; Divide all buffers into buckets for various major modes.
1745 ;; Each bucket looks like (MODE NAMESTRING BUFFERS...).
1746 (with-current-buffer buf
1747 (let* ((adjusted-major-mode major-mode) elt)
1748 (dolist (group mouse-buffer-menu-mode-groups)
1749 (when (string-match (car group) (format-mode-line mode-name))
1750 (setq adjusted-major-mode (cdr group))))
1751 (setq elt (assoc adjusted-major-mode split-by-major-mode))
1752 (unless elt
1753 (setq elt (list adjusted-major-mode
1754 (if (stringp adjusted-major-mode)
1755 adjusted-major-mode
1756 (format-mode-line mode-name nil nil buf)))
1757 split-by-major-mode (cons elt split-by-major-mode)))
1758 (or (memq buf (cdr (cdr elt)))
1759 (setcdr (cdr elt) (cons buf (cdr (cdr elt))))))))
1760 ;; Compute the sum of squares of sizes of the major-mode buckets.
1761 (let ((tail split-by-major-mode))
1762 (setq sum-of-squares 0)
1763 (while tail
1764 (setq sum-of-squares
1765 (+ sum-of-squares
1766 (let ((len (length (cdr (cdr (car tail)))))) (* len len))))
1767 (setq tail (cdr tail))))
1768 (if (< (* sum-of-squares mouse-buffer-menu-mode-mult)
1769 (* (length buffers) (length buffers)))
1770 ;; Subdividing by major modes really helps, so let's do it.
1771 (let (subdivided-menus (buffers-left (length buffers)))
1772 ;; Sort the list to put the most popular major modes first.
1773 (setq split-by-major-mode
1774 (sort split-by-major-mode
1775 (function (lambda (elt1 elt2)
1776 (> (length elt1) (length elt2))))))
1777 ;; Make a separate submenu for each major mode
1778 ;; that has more than one buffer,
1779 ;; unless all the remaining buffers are less than 1/10 of them.
1780 (while (and split-by-major-mode
1781 (and (> (length (car split-by-major-mode)) 3)
1782 (> (* buffers-left 10) (length buffers))))
1783 (let ((this-mode-list (mouse-buffer-menu-alist
1784 (cdr (cdr (car split-by-major-mode))))))
1785 (and this-mode-list
1786 (setq subdivided-menus
1787 (cons (cons
1788 (nth 1 (car split-by-major-mode))
1789 this-mode-list)
1790 subdivided-menus))))
1791 (setq buffers-left
1792 (- buffers-left (length (cdr (car split-by-major-mode)))))
1793 (setq split-by-major-mode (cdr split-by-major-mode)))
1794 ;; If any major modes are left over,
1795 ;; make a single submenu for them.
1796 (if split-by-major-mode
1797 (let ((others-list
1798 (mouse-buffer-menu-alist
1799 ;; we don't need split-by-major-mode any more,
1800 ;; so we can ditch it with nconc.
1801 (apply 'nconc (mapcar 'cddr split-by-major-mode)))))
1802 (and others-list
1803 (setq subdivided-menus
1804 (cons (cons "Others" others-list)
1805 subdivided-menus)))))
1806 (setq menu (cons "Buffer Menu" (nreverse subdivided-menus))))
1807 (progn
1808 (setq alist (mouse-buffer-menu-alist buffers))
1809 (setq menu (cons "Buffer Menu"
1810 (mouse-buffer-menu-split "Select Buffer" alist)))))
1811 (let ((buf (x-popup-menu event menu))
1812 (window (posn-window (event-start event))))
1813 (when buf
1814 (select-window
1815 (if (framep window) (frame-selected-window window)
1816 window))
1817 (switch-to-buffer buf)))))
1819 (defun mouse-buffer-menu-alist (buffers)
1820 (let (tail
1821 (maxlen 0)
1822 head)
1823 (setq buffers
1824 (sort buffers
1825 (function (lambda (elt1 elt2)
1826 (string< (buffer-name elt1) (buffer-name elt2))))))
1827 (setq tail buffers)
1828 (while tail
1829 (or (eq ?\s (aref (buffer-name (car tail)) 0))
1830 (setq maxlen
1831 (max maxlen
1832 (length (buffer-name (car tail))))))
1833 (setq tail (cdr tail)))
1834 (setq tail buffers)
1835 (while tail
1836 (let ((elt (car tail)))
1837 (if (/= (aref (buffer-name elt) 0) ?\s)
1838 (setq head
1839 (cons
1840 (cons
1841 (format
1842 (format "%%-%ds %%s%%s %%s" maxlen)
1843 (buffer-name elt)
1844 (if (buffer-modified-p elt) "*" " ")
1845 (with-current-buffer elt
1846 (if buffer-read-only "%" " "))
1847 (or (buffer-file-name elt)
1848 (with-current-buffer elt
1849 (if list-buffers-directory
1850 (expand-file-name
1851 list-buffers-directory)))
1852 ""))
1853 elt)
1854 head))))
1855 (setq tail (cdr tail)))
1856 ;; Compensate for the reversal that the above loop does.
1857 (nreverse head)))
1859 (defun mouse-buffer-menu-split (title alist)
1860 ;; If we have lots of buffers, divide them into groups of 20
1861 ;; and make a pane (or submenu) for each one.
1862 (if (> (length alist) (/ (* mouse-buffer-menu-maxlen 3) 2))
1863 (let ((alist alist) sublists next
1864 (i 1))
1865 (while alist
1866 ;; Pull off the next mouse-buffer-menu-maxlen buffers
1867 ;; and make them the next element of sublist.
1868 (setq next (nthcdr mouse-buffer-menu-maxlen alist))
1869 (if next
1870 (setcdr (nthcdr (1- mouse-buffer-menu-maxlen) alist)
1871 nil))
1872 (setq sublists (cons (cons (format "Buffers %d" i) alist)
1873 sublists))
1874 (setq i (1+ i))
1875 (setq alist next))
1876 (nreverse sublists))
1877 ;; Few buffers--put them all in one pane.
1878 (list (cons title alist))))
1880 (define-obsolete-function-alias
1881 'mouse-choose-completion 'choose-completion "23.2")
1883 ;; Font selection.
1885 (defun font-menu-add-default ()
1886 (let* ((default (cdr (assq 'font (frame-parameters (selected-frame)))))
1887 (font-alist x-fixed-font-alist)
1888 (elt (or (assoc "Misc" font-alist) (nth 1 font-alist))))
1889 (if (assoc "Default" elt)
1890 (delete (assoc "Default" elt) elt))
1891 (setcdr elt
1892 (cons (list "Default" default)
1893 (cdr elt)))))
1895 (defvar x-fixed-font-alist
1896 (list
1897 (purecopy "Font Menu")
1898 (cons
1899 (purecopy "Misc")
1900 (mapcar
1901 (lambda (arg) (cons (purecopy (car arg)) (purecopy (cdr arg))))
1902 ;; For these, we specify the pixel height and width.
1903 '(("fixed" "fixed")
1904 ("6x10" "-misc-fixed-medium-r-normal--10-*-*-*-c-60-iso8859-1" "6x10")
1905 ("6x12"
1906 "-misc-fixed-medium-r-semicondensed--12-*-*-*-c-60-iso8859-1" "6x12")
1907 ("6x13"
1908 "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" "6x13")
1909 ("7x13" "-misc-fixed-medium-r-normal--13-*-*-*-c-70-iso8859-1" "7x13")
1910 ("7x14" "-misc-fixed-medium-r-normal--14-*-*-*-c-70-iso8859-1" "7x14")
1911 ("8x13" "-misc-fixed-medium-r-normal--13-*-*-*-c-80-iso8859-1" "8x13")
1912 ("9x15" "-misc-fixed-medium-r-normal--15-*-*-*-c-90-iso8859-1" "9x15")
1913 ("10x20" "-misc-fixed-medium-r-normal--20-*-*-*-c-100-iso8859-1" "10x20")
1914 ("11x18" "-misc-fixed-medium-r-normal--18-*-*-*-c-110-iso8859-1" "11x18")
1915 ("12x24" "-misc-fixed-medium-r-normal--24-*-*-*-c-120-iso8859-1" "12x24")
1916 ("")
1917 ("clean 5x8"
1918 "-schumacher-clean-medium-r-normal--8-*-*-*-c-50-iso8859-1")
1919 ("clean 6x8"
1920 "-schumacher-clean-medium-r-normal--8-*-*-*-c-60-iso8859-1")
1921 ("clean 8x8"
1922 "-schumacher-clean-medium-r-normal--8-*-*-*-c-80-iso8859-1")
1923 ("clean 8x10"
1924 "-schumacher-clean-medium-r-normal--10-*-*-*-c-80-iso8859-1")
1925 ("clean 8x14"
1926 "-schumacher-clean-medium-r-normal--14-*-*-*-c-80-iso8859-1")
1927 ("clean 8x16"
1928 "-schumacher-clean-medium-r-normal--16-*-*-*-c-80-iso8859-1")
1929 ("")
1930 ("sony 8x16" "-sony-fixed-medium-r-normal--16-*-*-*-c-80-iso8859-1")
1931 ;; We don't seem to have these; who knows what they are.
1932 ;; ("fg-18" "fg-18")
1933 ;; ("fg-25" "fg-25")
1934 ("lucidasanstypewriter-12" "-b&h-lucidatypewriter-medium-r-normal-sans-*-120-*-*-*-*-iso8859-1")
1935 ("lucidasanstypewriter-bold-14" "-b&h-lucidatypewriter-bold-r-normal-sans-*-140-*-*-*-*-iso8859-1")
1936 ("lucidasanstypewriter-bold-24"
1937 "-b&h-lucidatypewriter-bold-r-normal-sans-*-240-*-*-*-*-iso8859-1")
1938 ;; ("lucidatypewriter-bold-r-24" "-b&h-lucidatypewriter-bold-r-normal-sans-24-240-75-75-m-140-iso8859-1")
1939 ;; ("fixed-medium-20" "-misc-fixed-medium-*-*-*-20-*-*-*-*-*-*-*")
1942 (cons
1943 (purecopy "Courier")
1944 (mapcar
1945 (lambda (arg) (cons (purecopy (car arg)) (purecopy (cdr arg))))
1946 ;; For these, we specify the point height.
1947 '(("8" "-adobe-courier-medium-r-normal--*-80-*-*-m-*-iso8859-1")
1948 ("10" "-adobe-courier-medium-r-normal--*-100-*-*-m-*-iso8859-1")
1949 ("12" "-adobe-courier-medium-r-normal--*-120-*-*-m-*-iso8859-1")
1950 ("14" "-adobe-courier-medium-r-normal--*-140-*-*-m-*-iso8859-1")
1951 ("18" "-adobe-courier-medium-r-normal--*-180-*-*-m-*-iso8859-1")
1952 ("24" "-adobe-courier-medium-r-normal--*-240-*-*-m-*-iso8859-1")
1953 ("8 bold" "-adobe-courier-bold-r-normal--*-80-*-*-m-*-iso8859-1")
1954 ("10 bold" "-adobe-courier-bold-r-normal--*-100-*-*-m-*-iso8859-1")
1955 ("12 bold" "-adobe-courier-bold-r-normal--*-120-*-*-m-*-iso8859-1")
1956 ("14 bold" "-adobe-courier-bold-r-normal--*-140-*-*-m-*-iso8859-1")
1957 ("18 bold" "-adobe-courier-bold-r-normal--*-180-*-*-m-*-iso8859-1")
1958 ("24 bold" "-adobe-courier-bold-r-normal--*-240-*-*-m-*-iso8859-1")
1959 ("8 slant" "-adobe-courier-medium-o-normal--*-80-*-*-m-*-iso8859-1")
1960 ("10 slant" "-adobe-courier-medium-o-normal--*-100-*-*-m-*-iso8859-1")
1961 ("12 slant" "-adobe-courier-medium-o-normal--*-120-*-*-m-*-iso8859-1")
1962 ("14 slant" "-adobe-courier-medium-o-normal--*-140-*-*-m-*-iso8859-1")
1963 ("18 slant" "-adobe-courier-medium-o-normal--*-180-*-*-m-*-iso8859-1")
1964 ("24 slant" "-adobe-courier-medium-o-normal--*-240-*-*-m-*-iso8859-1")
1965 ("8 bold slant" "-adobe-courier-bold-o-normal--*-80-*-*-m-*-iso8859-1")
1966 ("10 bold slant" "-adobe-courier-bold-o-normal--*-100-*-*-m-*-iso8859-1")
1967 ("12 bold slant" "-adobe-courier-bold-o-normal--*-120-*-*-m-*-iso8859-1")
1968 ("14 bold slant" "-adobe-courier-bold-o-normal--*-140-*-*-m-*-iso8859-1")
1969 ("18 bold slant" "-adobe-courier-bold-o-normal--*-180-*-*-m-*-iso8859-1")
1970 ("24 bold slant" "-adobe-courier-bold-o-normal--*-240-*-*-m-*-iso8859-1")
1971 ))))
1972 "X fonts suitable for use in Emacs.")
1974 (declare-function generate-fontset-menu "fontset" ())
1976 (defun mouse-select-font ()
1977 "Prompt for a font name, using `x-popup-menu', and return it."
1978 (interactive)
1979 (unless (display-multi-font-p)
1980 (error "Cannot change fonts on this display"))
1981 (car
1982 (x-popup-menu
1983 (if (listp last-nonmenu-event)
1984 last-nonmenu-event
1985 (list '(0 0) (selected-window)))
1986 (append x-fixed-font-alist
1987 (list (generate-fontset-menu))))))
1989 (declare-function text-scale-mode "face-remap")
1991 (defun mouse-set-font (&rest fonts)
1992 "Set the default font for the selected frame.
1993 The argument FONTS is a list of font names; the first valid font
1994 in this list is used.
1996 When called interactively, pop up a menu and allow the user to
1997 choose a font."
1998 (interactive
1999 (progn (unless (display-multi-font-p)
2000 (error "Cannot change fonts on this display"))
2001 (x-popup-menu
2002 (if (listp last-nonmenu-event)
2003 last-nonmenu-event
2004 (list '(0 0) (selected-window)))
2005 ;; Append list of fontsets currently defined.
2006 (append x-fixed-font-alist (list (generate-fontset-menu))))))
2007 (if fonts
2008 (let (font)
2009 (while fonts
2010 (condition-case nil
2011 (progn
2012 (set-frame-font (car fonts))
2013 (setq font (car fonts))
2014 (setq fonts nil))
2015 (error
2016 (setq fonts (cdr fonts)))))
2017 (if (null font)
2018 (error "Font not found")))))
2020 (defvar mouse-appearance-menu-map nil)
2021 (declare-function x-select-font "xfns.c" (&optional frame ignored)) ; USE_GTK
2022 (declare-function buffer-face-mode-invoke "face-remap"
2023 (face arg &optional interactive))
2024 (declare-function font-face-attributes "font.c" (font &optional frame))
2026 (defun mouse-appearance-menu (event)
2027 "Show a menu for changing the default face in the current buffer."
2028 (interactive "@e")
2029 (require 'face-remap)
2030 (when (display-multi-font-p)
2031 (with-selected-window (car (event-start event))
2032 (if mouse-appearance-menu-map
2033 nil ; regenerate new fonts
2034 ;; Initialize mouse-appearance-menu-map
2035 (setq mouse-appearance-menu-map
2036 (make-sparse-keymap "Change Default Buffer Face"))
2037 (define-key mouse-appearance-menu-map [face-remap-reset-base]
2038 '(menu-item "Reset to Default" face-remap-reset-base))
2039 (define-key mouse-appearance-menu-map [text-scale-decrease]
2040 '(menu-item "Decrease Buffer Text Size" text-scale-decrease))
2041 (define-key mouse-appearance-menu-map [text-scale-increase]
2042 '(menu-item "Increase Buffer Text Size" text-scale-increase))
2043 ;; Font selector
2044 (if (functionp 'x-select-font)
2045 (define-key mouse-appearance-menu-map [x-select-font]
2046 '(menu-item "Change Buffer Font..." x-select-font))
2047 ;; If the select-font is unavailable, construct a menu.
2048 (let ((font-submenu (make-sparse-keymap "Change Text Font"))
2049 (font-alist (cdr (append x-fixed-font-alist
2050 (list (generate-fontset-menu))))))
2051 (dolist (family font-alist)
2052 (let* ((submenu-name (car family))
2053 (submenu-map (make-sparse-keymap submenu-name)))
2054 (dolist (font (cdr family))
2055 (let ((font-name (car font))
2056 font-symbol)
2057 (if (string= font-name "")
2058 (define-key submenu-map [space]
2059 '("--"))
2060 (setq font-symbol (intern (cadr font)))
2061 (define-key submenu-map (vector font-symbol)
2062 (list 'menu-item (car font) font-symbol)))))
2063 (define-key font-submenu (vector (intern submenu-name))
2064 (list 'menu-item submenu-name submenu-map))))
2065 (define-key mouse-appearance-menu-map [font-submenu]
2066 (list 'menu-item "Change Text Font" font-submenu)))))
2067 (let ((choice (x-popup-menu event mouse-appearance-menu-map)))
2068 (setq choice (nth (1- (length choice)) choice))
2069 (cond ((eq choice 'text-scale-increase)
2070 (text-scale-increase 1))
2071 ((eq choice 'text-scale-decrease)
2072 (text-scale-increase -1))
2073 ((eq choice 'face-remap-reset-base)
2074 (text-scale-mode 0)
2075 (buffer-face-mode 0))
2076 (choice
2077 ;; Either choice == 'x-select-font, or choice is a
2078 ;; symbol whose name is a font.
2079 (buffer-face-mode-invoke (font-face-attributes
2080 (if (eq choice 'x-select-font)
2081 (x-select-font)
2082 (symbol-name choice)))
2084 (called-interactively-p 'interactive))))))))
2087 ;;; Bindings for mouse commands.
2089 (define-key global-map [down-mouse-1] 'mouse-drag-region)
2090 (global-set-key [mouse-1] 'mouse-set-point)
2091 (global-set-key [drag-mouse-1] 'mouse-set-region)
2093 ;; These are tested for in mouse-drag-region.
2094 (global-set-key [double-mouse-1] 'mouse-set-point)
2095 (global-set-key [triple-mouse-1] 'mouse-set-point)
2097 (defun mouse--strip-first-event (_prompt)
2098 (substring (this-single-command-raw-keys) 1))
2100 (define-key function-key-map [left-fringe mouse-1] 'mouse--strip-first-event)
2101 (define-key function-key-map [right-fringe mouse-1] 'mouse--strip-first-event)
2103 (global-set-key [mouse-2] 'mouse-yank-primary)
2104 ;; Allow yanking also when the corresponding cursor is "in the fringe".
2105 (define-key function-key-map [right-fringe mouse-2] 'mouse--strip-first-event)
2106 (define-key function-key-map [left-fringe mouse-2] 'mouse--strip-first-event)
2107 (global-set-key [mouse-3] 'mouse-save-then-kill)
2108 (define-key function-key-map [right-fringe mouse-3] 'mouse--strip-first-event)
2109 (define-key function-key-map [left-fringe mouse-3] 'mouse--strip-first-event)
2111 ;; By binding these to down-going events, we let the user use the up-going
2112 ;; event to make the selection, saving a click.
2113 (global-set-key [C-down-mouse-1] 'mouse-buffer-menu)
2114 (if (not (eq system-type 'ms-dos))
2115 (global-set-key [S-down-mouse-1] 'mouse-appearance-menu))
2116 ;; C-down-mouse-2 is bound in facemenu.el.
2117 (global-set-key [C-down-mouse-3]
2118 `(menu-item ,(purecopy "Menu Bar") ignore
2119 :filter (lambda (_)
2120 (if (zerop (or (frame-parameter nil 'menu-bar-lines) 0))
2121 (mouse-menu-bar-map)
2122 (mouse-menu-major-mode-map)))))
2124 ;; Binding mouse-1 to mouse-select-window when on mode-, header-, or
2125 ;; vertical-line prevents Emacs from signaling an error when the mouse
2126 ;; button is released after dragging these lines, on non-toolkit
2127 ;; versions.
2128 (global-set-key [mode-line mouse-1] 'mouse-select-window)
2129 (global-set-key [mode-line drag-mouse-1] 'mouse-select-window)
2130 (global-set-key [mode-line down-mouse-1] 'mouse-drag-mode-line)
2131 (global-set-key [header-line down-mouse-1] 'mouse-drag-header-line)
2132 (global-set-key [header-line mouse-1] 'mouse-select-window)
2133 (global-set-key [mode-line mouse-2] 'mouse-delete-other-windows)
2134 (global-set-key [mode-line mouse-3] 'mouse-delete-window)
2135 (global-set-key [mode-line C-mouse-2] 'mouse-split-window-horizontally)
2136 (global-set-key [vertical-scroll-bar C-mouse-2] 'mouse-split-window-vertically)
2137 (global-set-key [vertical-line C-mouse-2] 'mouse-split-window-vertically)
2138 (global-set-key [vertical-line down-mouse-1] 'mouse-drag-vertical-line)
2139 (global-set-key [vertical-line mouse-1] 'mouse-select-window)
2141 (provide 'mouse)
2143 ;;; mouse.el ends here