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