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