mouse.el 77.4 KB
Newer Older
1
;;; mouse.el --- window system-independent mouse support  -*- lexical-binding: t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1993-1995, 1999-2013 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
6
;; Keywords: hardware, mouse
7
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; This file is part of GNU Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
10

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15

Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
Richard M. Stallman's avatar
Richard M. Stallman committed
20

Richard M. Stallman's avatar
Richard M. Stallman committed
21
;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23

24 25 26 27 28 29 30 31
;;; Commentary:

;; This package provides various useful commands (including help
;; system access) through the mouse.  All this code assumes that mouse
;; interpretation has been abstracted into Emacs input events.
;;
;; The code is rather X-dependent.

32 33
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
34
;;; Utility functions.
Richard M. Stallman's avatar
Richard M. Stallman committed
35

36
;; Indent track-mouse like progn.
Jim Blandy's avatar
Jim Blandy committed
37
(put 'track-mouse 'lisp-indent-function 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
38

Richard M. Stallman's avatar
Richard M. Stallman committed
39
(defcustom mouse-yank-at-point nil
Lute Kamstra's avatar
Lute Kamstra committed
40
  "If non-nil, mouse yank commands yank at point instead of at click."
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42
  :type 'boolean
  :group 'mouse)
43

44
(defcustom mouse-drag-copy-region nil
45 46 47 48
  "If non-nil, copy to kill-ring upon mouse adjustments of the region.

This affects `mouse-save-then-kill' (\\[mouse-save-then-kill]) in
addition to mouse drags."
49
  :type 'boolean
50
  :version "24.1"
51 52
  :group 'mouse)

53
(defcustom mouse-1-click-follows-link 450
54
  "Non-nil means that clicking Mouse-1 on a link follows the link.
55

56 57
With the default setting, an ordinary Mouse-1 click on a link
performs the same action as Mouse-2 on that link, while a longer
58
Mouse-1 click \(hold down the Mouse-1 button for more than 450
59
milliseconds) performs the original Mouse-1 binding \(which
60 61 62 63
typically sets point where you click the mouse).

If value is an integer, the time elapsed between pressing and
releasing the mouse button determines whether to follow the link
64
or perform the normal Mouse-1 action (typically set point).
Paul Eggert's avatar
Paul Eggert committed
65
The absolute numeric value specifies the maximum duration of a
66 67
\"short click\" in milliseconds.  A positive value means that a
short click follows the link, and a longer click performs the
68
normal action.  A negative value gives the opposite behavior.
69 70 71

If value is `double', a double click follows the link.

72
Otherwise, a single Mouse-1 click unconditionally follows the link.
73 74 75 76 77 78

Note that dragging the mouse never follows the link.

This feature only works in modes that specifically identify
clickable text as links, so it may not work with some external
packages.  See `mouse-on-link-p' for details."
79
  :version "22.1"
80 81
  :type '(choice (const :tag "Disabled" nil)
		 (const :tag "Double click" double)
82
                 (number :tag "Single click time limit" :value 450)
83 84 85
                 (other :tag "Single click" t))
  :group 'mouse)

86
(defcustom mouse-1-click-in-non-selected-windows t
Lute Kamstra's avatar
Lute Kamstra committed
87
  "If non-nil, a Mouse-1 click also follows links in non-selected windows.
88 89 90 91 92 93 94 95

If nil, a Mouse-1 click on a link in a non-selected window performs
the normal mouse-1 binding, typically selects the window and sets
point at the click position."
  :type 'boolean
  :version "22.1"
  :group 'mouse)

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
(defun mouse--down-1-maybe-follows-link (&optional _prompt)
  "Turn `mouse-1' events into `mouse-2' events if follows-link.
Expects to be bound to `down-mouse-1' in `key-translation-map'."
  (if (or (null mouse-1-click-follows-link)
          (not (eq (if (eq mouse-1-click-follows-link 'double)
                       'double-down-mouse-1 'down-mouse-1)
                   (car-safe last-input-event)))
          (not (mouse-on-link-p (event-start last-input-event)))
          (and (not mouse-1-click-in-non-selected-windows)
               (not (eq (selected-window)
                        (posn-window (event-start last-input-event))))))
      nil
    (let ((this-event last-input-event)
          (timedout
           (sit-for (if (numberp mouse-1-click-follows-link)
                     (/ (abs mouse-1-click-follows-link) 1000.0)
                     0))))
      (if (if (and (numberp mouse-1-click-follows-link)
                   (>= mouse-1-click-follows-link 0))
              timedout (not timedout))
          nil

        (let ((event (read-event)))
          (if (eq (car-safe event) (if (eq mouse-1-click-follows-link 'double)
                                       'double-mouse-1 'mouse-1))
              ;; Turn the mouse-1 into a mouse-2 to follow links.
              (let ((newup (if (eq mouse-1-click-follows-link 'double)
                                'double-mouse-2 'mouse-2))
                    (newdown (if (eq mouse-1-click-follows-link 'double)
                                 'double-down-mouse-2 'down-mouse-2)))
                ;; If mouse-2 has never been done by the user, it doesn't have
                ;; the necessary property to be interpreted correctly.
                (put newup 'event-kind (get (car event) 'event-kind))
                (put newdown 'event-kind (get (car this-event) 'event-kind))
                (push (cons newup (cdr event)) unread-command-events)
                (vector (cons newdown (cdr this-event))))
            (push event unread-command-events)
            nil))))))

(define-key key-translation-map [down-mouse-1]
  #'mouse--down-1-maybe-follows-link)
(define-key key-translation-map [double-down-mouse-1]
  #'mouse--down-1-maybe-follows-link)
139

Jim Blandy's avatar
Jim Blandy committed
140

141 142
;; Provide a mode-specific menu on a mouse button.

Stefan Monnier's avatar
Stefan Monnier committed
143 144
(defun popup-menu (menu &optional position prefix)
  "Popup the given menu and call the selected option.
145 146
MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
`x-popup-menu'.
147 148
The menu is shown at the place where POSITION specifies. About
the form of POSITION, see `popup-menu-normalize-position'.
Stefan Monnier's avatar
Stefan Monnier committed
149
PREFIX is the prefix argument (if any) to pass to the command."
150 151 152 153
  (let* ((map (cond
	       ((keymapp menu) menu)
	       ((and (listp menu) (keymapp (car menu))) menu)
	       (t (let* ((map (easy-menu-create-menu (car menu) (cdr menu)))
Stefan Monnier's avatar
Stefan Monnier committed
154 155 156
			 (filter (when (symbolp map)
				   (plist-get (get map 'menu-prop) :filter))))
		    (if filter (funcall filter (symbol-function map)) map)))))
157 158
	 event cmd
	 (position (popup-menu-normalize-position position)))
Stefan Monnier's avatar
Stefan Monnier committed
159
    ;; The looping behavior was taken from lmenu's popup-menu-popup
160 161 162 163
    (while (and map (setq event
			  ;; map could be a prefix key, in which case
			  ;; we need to get its function cell
			  ;; definition.
Dave Love's avatar
Dave Love committed
164
			  (x-popup-menu position (indirect-function map))))
Stefan Monnier's avatar
Stefan Monnier committed
165 166 167
      ;; Strangely x-popup-menu returns a list.
      ;; mouse-major-mode-menu was using a weird:
      ;; (key-binding (apply 'vector (append '(menu-bar) menu-prefix events)))
168 169 170 171 172 173 174 175
      (setq cmd
	    (if (and (not (keymapp map)) (listp map))
		;; We were given a list of keymaps.  Search them all
		;; in sequence until a first binding is found.
		(let ((mouse-click (apply 'vector event))
		      binding)
		  (while (and map (null binding))
		    (setq binding (lookup-key (car map) mouse-click))
176
		    (if (numberp binding)	; `too long'
177 178 179 180 181 182 183 184 185
			(setq binding nil))
		    (setq map (cdr map)))
		  binding)
	      ;; We were given a single keymap.
	      (lookup-key map (apply 'vector event))))
      ;; Clear out echoing, which perhaps shows a prefix arg.
      (message "")
      ;; Maybe try again but with the submap.
      (setq map (if (keymapp cmd) cmd)))
186 187 188
    ;; If the user did not cancel by refusing to select,
    ;; and if the result is a command, run it.
    (when (and (null map) (commandp cmd))
189 190 191 192 193
      (setq prefix-arg prefix)
      ;; `setup-specified-language-environment', for instance,
      ;; expects this to be set from a menu keymap.
      (setq last-command-event (car (last event)))
      ;; mouse-major-mode-menu was using `command-execute' instead.
Miles Bader's avatar
Miles Bader committed
194
      (call-interactively cmd))))
195

196
(defun popup-menu-normalize-position (position)
197 198 199 200
  "Convert the POSITION to the form which `popup-menu' expects internally.
POSITION can an event, a posn- value, a value having
form ((XOFFSET YOFFSET) WINDOW), or nil.
If nil, the current mouse position is used."
201 202 203 204 205
  (pcase position
    ;; nil -> mouse cursor position
    (`nil
     (let ((mp (mouse-pixel-position)))
       (list (list (cadr mp) (cddr mp)) (car mp))))
206 207
    ;; Value returned from `event-end' or `posn-at-point'.
    ((pred posnp)
208 209 210
     (let ((xy (posn-x-y position)))
       (list (list (car xy) (cdr xy))
	     (posn-window position))))
211
    ;; Event.
212 213
    ((pred eventp)
     (popup-menu-normalize-position (event-end position)))
214
    (t position)))
215

216
(defun minor-mode-menu-from-indicator (indicator)
217 218 219 220 221
  "Show menu for minor mode specified by INDICATOR.
Interactively, INDICATOR is read using completion.
If there is no menu defined for the minor mode, then create one with
items `Turn Off' and `Help'."
  (interactive
222
   (list (completing-read
223 224
	  "Minor mode indicator: "
	  (describe-minor-mode-completion-table-for-indicator))))
225 226
  (let* ((minor-mode (lookup-minor-mode-from-indicator indicator))
         (mm-fun (or (get minor-mode :minor-mode-function) minor-mode)))
227 228 229
    (unless minor-mode (error "Cannot find minor mode for `%s'" indicator))
    (let* ((map (cdr-safe (assq minor-mode minor-mode-map-alist)))
           (menu (and (keymapp map) (lookup-key map [menu-bar]))))
230 231 232
      (setq menu
            (if menu
                (mouse-menu-non-singleton menu)
233
	      `(keymap
234
                ,indicator
235
                (turn-off menu-item "Turn Off minor mode" ,mm-fun)
236
                (help menu-item "Help for minor mode"
237
                      (lambda () (interactive)
238
                        (describe-function ',mm-fun))))))
239
      (popup-menu menu))))
240 241 242 243 244 245 246

(defun mouse-minor-mode-menu (event)
  "Show minor-mode menu for EVENT on minor modes area of the mode line."
  (interactive "@e")
  (let ((indicator (car (nth 4 (car (cdr event))))))
    (minor-mode-menu-from-indicator indicator)))

247
(defun mouse-menu-major-mode-map ()
Glenn Morris's avatar
Glenn Morris committed
248
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
249 250
  (let* (;; Keymap from which to inherit; may be null.
	 (ancestor (mouse-menu-non-singleton
251
		    (and (current-local-map)
252
			 (local-key-binding [menu-bar]))))
253 254 255
	 ;; Make a keymap in which our last command leads to a menu or
	 ;; default to the edit menu.
	 (newmap (if ancestor
256 257
		     (make-sparse-keymap (concat (format-mode-line mode-name)
                                                 " Mode"))
258
		   menu-bar-edit-menu)))
259
    (if ancestor
260
	(set-keymap-parent newmap ancestor))
261
    newmap))
262

263
(defun mouse-menu-non-singleton (menubar)
264 265 266
  "Return menu keybar MENUBAR, or a lone submenu inside it.
If MENUBAR defines exactly one submenu, return just that submenu.
Otherwise, return MENUBAR."
267
  (if menubar
268 269 270
      (let (submap)
        (map-keymap
         (lambda (k v) (setq submap (if submap t (cons k v))))
271
         (keymap-canonicalize menubar))
272 273 274
        (if (eq submap t)
            menubar
          (lookup-key menubar (vector (car submap)))))))
275

276 277
(defun mouse-menu-bar-map ()
  "Return a keymap equivalent to the menu bar.
278 279
The contents are the items that would be in the menu bar whether or
not it is actually displayed."
Glenn Morris's avatar
Glenn Morris committed
280
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
281 282 283
  (let* ((local-menu (and (current-local-map)
			  (lookup-key (current-local-map) [menu-bar])))
	 (global-menu (lookup-key global-map [menu-bar]))
284 285 286 287 288 289 290
	 ;; If a keymap doesn't have a prompt string (a lazy
	 ;; programmer didn't bother to provide one), create it and
	 ;; insert it into the keymap; each keymap gets its own
	 ;; prompt.  This is required for non-toolkit versions to
	 ;; display non-empty menu pane names.
	 (minor-mode-menus
	  (mapcar
291 292 293 294 295 296 297 298 299 300 301 302 303 304
           (lambda (menu)
             (let* ((minor-mode (car menu))
                    (menu (cdr menu))
                    (title-or-map (cadr menu)))
               (or (stringp title-or-map)
                   (setq menu
                         (cons 'keymap
                               (cons (concat
                                      (capitalize (subst-char-in-string
                                                   ?- ?\s (symbol-name
                                                           minor-mode)))
                                      " Menu")
                                     (cdr menu)))))
               menu))
305
	   (minor-mode-key-binding [menu-bar])))
306 307 308 309 310
	 (local-title-or-map (and local-menu (cadr local-menu)))
	 (global-title-or-map (cadr global-menu)))
    (or (null local-menu)
	(stringp local-title-or-map)
	(setq local-menu (cons 'keymap
311
			       (cons (concat (format-mode-line mode-name)
312
                                             " Mode Menu")
313 314 315 316 317
				     (cdr local-menu)))))
    (or (stringp global-title-or-map)
	(setq global-menu (cons 'keymap
			        (cons "Global Menu"
				      (cdr global-menu)))))
318
    ;; Supplying the list is faster than making a new map.
319 320 321 322 323 324 325 326 327 328 329
    ;; FIXME: We have a problem here: we have to use the global/local/minor
    ;; so they're displayed in the expected order, but later on in the command
    ;; loop, they're actually looked up in the opposite order.
    (apply 'append
           global-menu
           local-menu
           minor-mode-menus)))

(defun mouse-major-mode-menu (event &optional prefix)
  "Pop up a mode-specific menu of mouse commands.
Default to the Edit menu if the major mode doesn't define a menu."
330
  (declare (obsolete mouse-menu-major-mode-map "23.1"))
331 332 333 334 335 336 337 338
  (interactive "@e\nP")
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
  (popup-menu (mouse-menu-major-mode-map) event prefix))

(defun mouse-popup-menubar (event prefix)
  "Pop up a menu equivalent to the menu bar for keyboard EVENT with PREFIX.
The contents are the items that would be in the menu bar whether or
not it is actually displayed."
339
  (declare (obsolete mouse-menu-bar-map "23.1"))
340 341
  (interactive "@e \nP")
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
342
  (popup-menu (mouse-menu-bar-map) (unless (integerp event) event) prefix))
343 344 345 346

(defun mouse-popup-menubar-stuff (event prefix)
  "Popup a menu like either `mouse-major-mode-menu' or `mouse-popup-menubar'.
Use the former if the menu bar is showing, otherwise the latter."
347
  (declare (obsolete nil "23.1"))
348 349 350 351 352 353 354
  (interactive "@e\nP")
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
  (popup-menu
   (if (zerop (or (frame-parameter nil 'menu-bar-lines) 0))
       (mouse-menu-bar-map)
     (mouse-menu-major-mode-map))
   event prefix))
355

356 357
;; Commands that operate on windows.

358 359 360 361
(defun mouse-minibuffer-check (event)
  (let ((w (posn-window (event-start event))))
    (and (window-minibuffer-p w)
	 (not (minibuffer-window-active-p w))
362
	 (user-error "Minibuffer window is not active")))
363 364
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook))
365

Jim Blandy's avatar
Jim Blandy committed
366
(defun mouse-delete-window (click)
367
  "Delete the window you click on.
368
Do nothing if the frame has just one window.
369
This command must be bound to a mouse click."
Jim Blandy's avatar
Jim Blandy committed
370
  (interactive "e")
371
  (unless (one-window-p t)
372 373
    (mouse-minibuffer-check click)
    (delete-window (posn-window (event-start click)))))
Jim Blandy's avatar
Jim Blandy committed
374

375 376 377
(defun mouse-select-window (click)
  "Select the window clicked on; don't move point."
  (interactive "e")
378
  (mouse-minibuffer-check click)
379 380 381 382 383 384
  (let ((oframe (selected-frame))
	(frame (window-frame (posn-window (event-start click)))))
    (select-window (posn-window (event-start click)))
    (raise-frame frame)
    (select-frame frame)
    (or (eq frame oframe)
385
	(set-mouse-position (selected-frame) (1- (frame-width)) 0))))
386

387 388 389
(defun mouse-tear-off-window (click)
  "Delete the window clicked on, and create a new frame displaying its buffer."
  (interactive "e")
390
  (mouse-minibuffer-check click)
391 392
  (let* ((window (posn-window (event-start click)))
	 (buf (window-buffer window))
393
	 (frame (make-frame)))
394 395 396 397
    (select-frame frame)
    (switch-to-buffer buf)
    (delete-window window)))

398
(defun mouse-delete-other-windows ()
399
  "Delete all windows except the one you click on."
400
  (interactive "@")
Jim Blandy's avatar
Jim Blandy committed
401
  (delete-other-windows))
Richard M. Stallman's avatar
Richard M. Stallman committed
402

Jim Blandy's avatar
Jim Blandy committed
403 404 405 406
(defun mouse-split-window-vertically (click)
  "Select Emacs window mouse is on, then split it vertically in half.
The window is split at the line clicked on.
This command must be bound to a mouse click."
407
  (interactive "@e")
408
  (mouse-minibuffer-check click)
409 410
  (let ((start (event-start click)))
    (select-window (posn-window start))
411
    (let ((new-height (1+ (cdr (posn-col-row (event-end click)))))
412 413 414
	  (first-line window-min-height)
	  (last-line (- (window-height) window-min-height)))
      (if (< last-line first-line)
415
	  (error "Window too short to split")
416 417
	(split-window-vertically
	 (min (max new-height first-line) last-line))))))
Jim Blandy's avatar
Jim Blandy committed
418

419 420 421 422 423
(defun mouse-split-window-horizontally (click)
  "Select Emacs window mouse is on, then split it horizontally in half.
The window is split at the column clicked on.
This command must be bound to a mouse click."
  (interactive "@e")
424
  (mouse-minibuffer-check click)
425 426 427 428 429 430
  (let ((start (event-start click)))
    (select-window (posn-window start))
    (let ((new-width (1+ (car (posn-col-row (event-end click)))))
	  (first-col window-min-width)
	  (last-col (- (window-width) window-min-width)))
      (if (< last-col first-col)
431
	  (error "Window too narrow to split")
432 433
	(split-window-horizontally
	 (min (max new-width first-col) last-col))))))
434

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
;; `mouse-drag-line' is now the common routine for handling all line
;; dragging events combining the earlier `mouse-drag-mode-line-1' and
;; `mouse-drag-vertical-line'.  It should improve the behavior of line
;; dragging wrt Emacs 23 as follows:

;; (1) Gratuitous error messages and restrictions have been (hopefully)
;; removed.  (The help-echo that dragging the mode-line can resize a
;; one-window-frame's window will still show through via bindings.el.)

;; (2) No gratuitous selection of other windows should happen.  (This
;; has not been completely fixed for mouse-autoselected windows yet.)

;; (3) Mouse clicks below a scroll-bar should pass through via unread
;; command events.

;; Note that `window-in-direction' replaces `mouse-drag-window-above'
;; and `mouse-drag-vertical-line-rightward-window' with Emacs 24.1.
452

453
(defun mouse-drag-line (start-event line)
454
  "Drag a mode line, header line, or vertical line with the mouse.
455
START-EVENT is the starting mouse-event of the drag action.  LINE
456
must be one of the symbols `header', `mode', or `vertical'."
457 458
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook)
459
  (let* ((echo-keystrokes 0)
460
	 (start (event-start start-event))
461 462 463
	 (window (posn-window start))
	 (frame (window-frame window))
	 (minibuffer-window (minibuffer-window frame))
464 465 466 467 468
	 (side (and (eq line 'vertical)
		    (or (cdr (assq 'vertical-scroll-bars
				   (frame-parameters frame)))
			'right)))
	 (draggable t)
469
	 event position growth dragged)
470 471 472
    (cond
     ((eq line 'header)
      ;; Check whether header-line can be dragged at all.
473
      (if (window-at-side-p window 'top)
474
	  (setq draggable nil)
475
	(setq window (window-in-direction 'above window t))))
476 477
     ((eq line 'mode)
      ;; Check whether mode-line can be dragged at all.
478 479 480 481 482 483 484 485 486 487 488
      (and (window-at-side-p window 'bottom)
	   ;; Allow resizing the minibuffer window if it's on the same
	   ;; frame as and immediately below the clicked window, and
	   ;; it's active or `resize-mini-windows' is nil.
	   (not (and (eq (window-frame minibuffer-window) frame)
		     (= (nth 1 (window-edges minibuffer-window))
			(nth 3 (window-edges window)))
		     (or (not resize-mini-windows)
			 (eq minibuffer-window
			     (active-minibuffer-window)))))
	   (setq draggable nil)))
489
     ((eq line 'vertical)
490 491 492 493 494 495 496
      ;; Get the window to adjust for the vertical case.  If the
      ;; scroll bar is on the window's right or there's no scroll bar
      ;; at all, adjust the window where the start-event occurred.  If
      ;; the scroll bar is on the start-event window's left, adjust
      ;; the window on the left of it.
      (unless (eq side 'right)
	(setq window (window-in-direction 'left window t)))))
497 498

    ;; Start tracking.
499
    (track-mouse
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
      ;; Loop reading events and sampling the position of the mouse,
      ;; until there is a non-mouse-movement event.  Also,
      ;; scroll-bar-movement events are the same as mouse movement for
      ;; our purposes.  (Why? -- cyd)
      ;; If you change this, check that all of the following still work:
      ;; Resizing windows by dragging mode-lines and header lines,
      ;; and vertical lines (in windows without scroll bars).
      ;;   Doing this should not select another window, even if
      ;;   mouse-autoselect-window is non-nil.
      ;; Mouse-1 clicks in Info header lines should advance position
      ;; by one node at a time if mouse-1-click-follows-link is non-nil,
      ;; otherwise they should just select the window.
      (while (progn
	       (setq event (read-event))
	       (memq (car-safe event)
                     '(mouse-movement scroll-bar-movement
                                      switch-frame select-window)))
517
	(setq position (mouse-position))
518 519 520 521
	;; Do nothing if
	;;   - there is a switch-frame event.
	;;   - the mouse isn't in the frame that we started in
	;;   - the mouse isn't in any Emacs frame
522
	(cond
523 524
	 ((memq (car event) '(switch-frame select-window))
	  nil)
525 526
 	 ((not (and (eq (car position) frame)
 		    (cadr position)))
527 528
	  nil)
	 ((eq line 'vertical)
529 530 531 532 533
	  ;; Drag vertical divider.
	  (setq growth (- (cadr position)
			  (if (eq side 'right) 0 2)
			  (nth 2 (window-edges window))
			  -1))
534 535 536
	  (unless (zerop growth)
	    (setq dragged t))
	  (adjust-window-trailing-edge window growth t))
537 538
	 (draggable
	  ;; Drag horizontal divider.
539 540
	  (setq growth
		(if (eq line 'mode)
541
		    (- (cddr position) (nth 3 (window-edges window)) -1)
542
		  ;; The window's top includes the header line!
543
		  (- (nth 3 (window-edges window)) (cddr position))))
544 545
	  (unless (zerop growth)
	    (setq dragged t))
546 547 548 549
	  (adjust-window-trailing-edge window (if (eq line 'mode)
						  growth
						(- growth)))))))
    ;; Process the terminating event.
550
    (unless dragged
551
      (push event unread-command-events))))
552

553 554 555
(defun mouse-drag-mode-line (start-event)
  "Change the height of a window by dragging on the mode line."
  (interactive "e")
556
  (mouse-drag-line start-event 'mode))
557 558

(defun mouse-drag-header-line (start-event)
559
  "Change the height of a window by dragging on the header line."
560
  (interactive "e")
561
  (mouse-drag-line start-event 'header))
562

563 564 565
(defun mouse-drag-vertical-line (start-event)
  "Change the width of a window by dragging on the vertical line."
  (interactive "e")
566
  (mouse-drag-line start-event 'vertical))
567

568
(defun mouse-set-point (event)
Jim Blandy's avatar
Jim Blandy committed
569
  "Move point to the position clicked on with the mouse.
570
This should be bound to a mouse click event type."
Jim Blandy's avatar
Jim Blandy committed
571
  (interactive "e")
572
  (mouse-minibuffer-check event)
573 574
  ;; Use event-end in case called from mouse-drag-region.
  ;; If EVENT is a click, event-end and event-start give same value.
Stefan Monnier's avatar
Stefan Monnier committed
575
  (posn-set-point (event-end event)))
Jim Blandy's avatar
Jim Blandy committed
576

577 578 579 580 581 582 583 584 585 586 587
(defvar mouse-last-region-beg nil)
(defvar mouse-last-region-end nil)
(defvar mouse-last-region-tick nil)

(defun mouse-region-match ()
  "Return non-nil if there's an active region that was set with the mouse."
  (and (mark t) mark-active
       (eq mouse-last-region-beg (region-beginning))
       (eq mouse-last-region-end (region-end))
       (eq mouse-last-region-tick (buffer-modified-tick))))

588
(defun mouse-set-region (click)
589
  "Set the region to the text dragged over, and copy to kill ring.
590 591 592
This should be bound to a mouse drag event.
See the `mouse-drag-copy-region' variable to control whether this
command alters the kill ring or not."
593
  (interactive "e")
594
  (mouse-minibuffer-check click)
595 596 597 598 599 600 601 602 603 604 605
  (select-window (posn-window (event-start click)))
  (let ((beg (posn-point (event-start click)))
	(end (posn-point (event-end click))))
    (and mouse-drag-copy-region (integerp beg) (integerp end)
	 ;; Don't set this-command to `kill-region', so a following
	 ;; C-w won't double the text in the kill ring.  Ignore
	 ;; `last-command' so we don't append to a preceding kill.
	 (let (this-command last-command deactivate-mark)
	   (copy-region-as-kill beg end)))
    (if (numberp beg) (goto-char beg))
    ;; On a text terminal, bounce the cursor.
606
    (or transient-mark-mode
607
	(window-system)
608
	(sit-for 1))
609
    (push-mark)
610
    (set-mark (point))
611
    (if (numberp end) (goto-char end))
612 613 614
    (mouse-set-region-1)))

(defun mouse-set-region-1 ()
615
  ;; Set transient-mark-mode for a little while.
616 617 618 619 620
  (unless (eq (car-safe transient-mark-mode) 'only)
    (setq transient-mark-mode
	  (cons 'only
		(unless (eq transient-mark-mode 'lambda)
		  transient-mark-mode))))
621 622 623
  (setq mouse-last-region-beg (region-beginning))
  (setq mouse-last-region-end (region-end))
  (setq mouse-last-region-tick (buffer-modified-tick)))
624

Richard M. Stallman's avatar
Richard M. Stallman committed
625
(defcustom mouse-scroll-delay 0.25
Lute Kamstra's avatar
Lute Kamstra committed
626
  "The pause between scroll steps caused by mouse drags, in seconds.
627 628 629 630 631
If you drag the mouse beyond the edge of a window, Emacs scrolls the
window to bring the text beyond that edge into view, with a delay of
this many seconds between scroll steps.  Scrolling stops when you move
the mouse back into the window, or release the button.
This variable's value may be non-integral.
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633 634
Setting this to zero causes Emacs to scroll as fast as it can."
  :type 'number
  :group 'mouse)
635

Richard M. Stallman's avatar
Richard M. Stallman committed
636
(defcustom mouse-scroll-min-lines 1
Lute Kamstra's avatar
Lute Kamstra committed
637
  "The minimum number of lines scrolled by dragging mouse out of window.
638 639 640 641
Moving the mouse out the top or bottom edge of the window begins
scrolling repeatedly.  The number of lines scrolled per repetition
is normally equal to the number of lines beyond the window edge that
the mouse has moved.  However, it always scrolls at least the number
Richard M. Stallman's avatar
Richard M. Stallman committed
642 643 644
of lines specified by this variable."
  :type 'integer
  :group 'mouse)
645

646 647
(defun mouse-scroll-subr (window jump &optional overlay start)
  "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
648 649 650
If OVERLAY is an overlay, let it stretch from START to the far edge of
the newly visible text.
Upon exit, point is at the far edge of the newly visible text."
651 652 653 654 655
  (cond
   ((and (> jump 0) (< jump mouse-scroll-min-lines))
    (setq jump mouse-scroll-min-lines))
   ((and (< jump 0) (< (- jump) mouse-scroll-min-lines))
    (setq jump (- mouse-scroll-min-lines))))
656 657 658 659 660 661 662
  (let ((opoint (point)))
    (while (progn
	     (goto-char (window-start window))
	     (if (not (zerop (vertical-motion jump window)))
		 (progn
		   (set-window-start window (point))
		   (if (natnump jump)
663 664 665 666 667 668 669
		       (if (window-end window)
			   (progn
			     (goto-char (window-end window))
			     ;; window-end doesn't reflect the window's new
			     ;; start position until the next redisplay.
			     (vertical-motion (1- jump) window))
			 (vertical-motion (- (window-height window) 2)))
670 671 672 673 674 675 676 677
		     (goto-char (window-start window)))
		   (if overlay
		       (move-overlay overlay start (point)))
		   ;; Now that we have scrolled WINDOW properly,
		   ;; put point back where it was for the redisplay
		   ;; so that we don't mess up the selected window.
		   (or (eq window (selected-window))
		       (goto-char opoint))
678
		   (sit-for mouse-scroll-delay)))))
679 680
    (or (eq window (selected-window))
	(goto-char opoint))))
681

682
(defvar mouse-selection-click-count 0)
683

684 685
(defvar mouse-selection-click-count-buffer nil)

686
(defun mouse-drag-region (start-event)
687
  "Set the region to the text that the mouse is dragged over.
688 689
Highlight the drag area as you move the mouse.
This must be bound to a button-down mouse event.
690
In Transient Mark mode, the highlighting remains as long as the mark
691 692 693
remains active.  Otherwise, it remains until the next input event.

If the click is in the echo area, display the `*Messages*' buffer."
694
  (interactive "e")
695 696 697
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook)
  (mouse-drag-track start-event t))
698

699

700
(defun mouse-posn-property (pos property)
701 702
  "Look for a property at click position.
POS may be either a buffer position or a click position like
703
those returned from `event-start'.  If the click position is on
704 705 706 707 708
a string, the text property PROPERTY is examined.
If this is nil or the click is not on a string, then
the corresponding buffer position is searched for PROPERTY.
If PROPERTY is encountered in one of those places,
its value is returned."
709 710 711 712 713 714 715 716 717
  (if (consp pos)
      (let ((w (posn-window pos)) (pt (posn-point pos))
	    (str (posn-string pos)))
	(or (and str
		 (get-text-property (cdr str) property (car str)))
	    (and pt
		 (get-char-property pt property w))))
    (get-char-property pos property)))

718 719
(defun mouse-on-link-p (pos)
  "Return non-nil if POS is on a link in the current buffer.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
720 721
POS must be a buffer position in the current buffer or a mouse
event location in the selected window (see `event-start').
722 723
However, if `mouse-1-click-in-non-selected-windows' is non-nil,
POS may be a mouse event location in any window.
724 725 726

A clickable link is identified by one of the following methods:

Kim F. Storm's avatar
Kim F. Storm committed
727
- If the character at POS has a non-nil `follow-link' text or
728
overlay property, the value of that property determines what to do.
729

Kim F. Storm's avatar
Kim F. Storm committed
730 731 732
- If there is a local key-binding or a keybinding at position POS
for the `follow-link' event, the binding of that event determines
what to do.
733

Kim F. Storm's avatar
Kim F. Storm committed
734 735 736
The resulting value determine whether POS is inside a link:

- If the value is `mouse-face', POS is inside a link if there
737 738
is a non-nil `mouse-face' property at POS.  Return t in this case.

Kim F. Storm's avatar
Kim F. Storm committed
739
- If the value is a function, FUNC, POS is inside a link if
740
the call \(FUNC POS) returns non-nil.  Return the return value
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
741
from that call.  Arg is \(posn-point POS) if POS is a mouse event.
742

Kim F. Storm's avatar
Kim F. Storm committed
743
- Otherwise, return the value itself.
744 745 746 747 748 749 750 751 752 753 754 755 756

The return value is interpreted as follows:

- If it is a string, the mouse-1 event is translated into the
first character of the string, i.e. the action of the mouse-1
click is the local or global binding of that character.

- If it is a vector, the mouse-1 event is translated into the
first element of that vector, i.e. the action of the mouse-1
click is the local or global binding of that event.

- Otherwise, the mouse-1 event is translated into a mouse-2 event
at the same position."
757 758 759 760 761 762 763 764 765 766
  (let ((action
	 (and (or (not (consp pos))
		  mouse-1-click-in-non-selected-windows
		  (eq (selected-window) (posn-window pos)))
	      (or (mouse-posn-property pos 'follow-link)
		  (key-binding [follow-link] nil t pos)))))
    (cond
     ((eq action 'mouse-face)
      (and (mouse-posn-property pos 'mouse-face) t))
     ((functionp action)
767
      ;; FIXME: This seems questionable if the click is not in a buffer.
768
      ;; Should we instead decide that `action' takes a `posn'?
769 770
      (if (consp pos)
	  (with-current-buffer (window-buffer (posn-window pos))
771
	    (funcall action (posn-point pos)))
772
	(funcall action pos)))
773
     (t action))))
774

775 776 777 778 779
(defun mouse-fixup-help-message (msg)
  "Fix help message MSG for `mouse-1-click-follows-link'."
  (let (mp pos)
    (if (and mouse-1-click-follows-link
	     (stringp msg)
780
	     (string-match-p "\\`mouse-2" msg)
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
	     (setq mp (mouse-pixel-position))
	     (consp (setq pos (cdr mp)))
	     (car pos) (>= (car pos) 0)
	     (cdr pos) (>= (cdr pos) 0)
	     (setq pos (posn-at-x-y (car pos) (cdr pos) (car mp)))
	     (windowp (posn-window pos)))
	(with-current-buffer (window-buffer (posn-window pos))
	  (if (mouse-on-link-p pos)
	      (setq msg (concat
		    (cond
		     ((eq mouse-1-click-follows-link 'double) "double-")
		     ((and (integerp mouse-1-click-follows-link)
			   (< mouse-1-click-follows-link 0)) "Long ")
		     (t ""))
		    "mouse-1" (substring msg 7)))))))
  msg)
797

798
(defun mouse-drag-track (start-event  &optional
799 800
				      do-mouse-drag-region-post-process)
    "Track mouse drags by highlighting area between point and cursor.
801 802 803
The region will be defined with mark and point.
DO-MOUSE-DRAG-REGION-POST-PROCESS should only be used by
`mouse-drag-region'."
804
  (mouse-minibuffer-check start-event)
805
  (setq mouse-selection-click-count-buffer (current-buffer))
806
  (deactivate-mark)
807
  (let* ((scroll-margin 0) ; Avoid margin scrolling (Bug#9541).
808 809 810 811 812
         ;; We've recorded what we needed from the current buffer and
         ;; window, now let's jump to the place of the event, where things
         ;; are happening.
         (_ (mouse-set-point start-event))
         (echo-keystrokes 0)
813
	 (start-posn (event-start start-event))
814 815
	 (start-point (posn-point start-posn))
	 (start-window (posn-window start-posn))
816
	 (start-window-start (window-start start-window))
817
	 (start-hscroll (window-hscroll start-window))
818
	 (bounds (window-edges start-window))
819
	 (make-cursor-line-fully-visible nil)
820 821 822 823
	 (top (nth 1 bounds))
	 (bottom (if (window-minibuffer-p start-window)
		     (nth 3 bounds)
		   ;; Don't count the mode line.
824
		   (1- (nth 3 bounds))))
825
	 (click-count (1- (event-click-count start-event)))
826 827
	 ;; Suppress automatic hscrolling, because that is a nuisance
	 ;; when setting point near the right fringe (but see below).
828 829
	 (auto-hscroll-mode-saved auto-hscroll-mode)
	 (auto-hscroll-mode nil)
830
	 moved-off-start event end end-point)
831

832
    (setq mouse-selection-click-count click-count)
833 834 835 836 837
    ;; In case the down click is in the middle of some intangible text,
    ;; use the end of that text, and put it in START-POINT.
    (if (< (point) start-point)
	(goto-char start-point))
    (setq start-point (point))
838

839 840
    ;; Activate the region, using `mouse-start-end' to determine where
    ;; to put point and mark (e.g., double-click will select a word).
841 842 843 844
    (setq transient-mark-mode
	  (if (eq transient-mark-mode 'lambda)
	      '(only)
	    (cons 'only transient-mark-mode)))
845
    (let ((range (mouse-start-end start-point start-point click-count)))
846
      (push-mark (nth 0 range) t t)
847
      (goto-char (nth 1 range)))
848 849 850 851 852 853 854 855 856 857 858

    ;; Track the mouse until we get a non-movement event.
    (track-mouse
      (while (progn
	       (setq event (read-event))
	       (or (mouse-movement-p event)
		   (memq (car-safe event) '(switch-frame select-window))))
	(unless (memq (car-safe event) '(switch-frame select-window))
	  ;; Automatic hscrolling did not occur during the call to
	  ;; `read-event'; but if the user subsequently drags the
	  ;; mouse, go ahead and hscroll.
859
	  (let ((auto-hscroll-mode auto-hscroll-mode-saved))
860 861 862
	    (redisplay))
	  (setq end (event-end event)
		end-point (posn-point end))
863 864 865
	  ;; Note whether the mouse has left the starting position.
	  (unless (eq end-point start-point)
	    (setq moved-off-start t))
866
	  (if (and (eq (posn-window end) start-window)
867
		   (integer-or-marker-p end-point))
868 869
	      (mouse--drag-set-mark-and-point start-point
					      end-point click-count)
870 871 872 873 874 875 876 877 878 879 880 881 882 883
	    (let ((mouse-row (cdr (cdr (mouse-position)))))
	      (cond
	       ((null mouse-row))
	       ((< mouse-row top)
		(mouse-scroll-subr start-window (- mouse-row top)
				   nil start-point))
	       ((>= mouse-row bottom)
		(mouse-scroll-subr start-window (1+ (- mouse-row bottom))
				   nil start-point))))))))

    ;; Handle the terminating event if possible.
    (when (consp event)
      ;; Ensure that point is on the end of the last event.
      (when (and (setq end-point (posn-point (event-end event)))
884
		 (eq (posn-window end) start-window)
885 886
		 (integer-or-marker-p end-point)
		 (/= start-point end-point))
887 888 889
	(mouse--drag-set-mark-and-point start-point
					end-point click-count))

890 891
      ;; Find its binding.
      (let* ((fun (key-binding (vector (car event))))
Glenn Morris's avatar
Glenn Morris committed
892 893
	     ;; FIXME This doesn't make sense, because
	     ;; event-click-count always returns something >= 1.
894 895 896 897 898 899
	     (do-multi-click (and (> (event-click-count event) 0)
				  (functionp fun)
				  (not (memq fun '(mouse-set-point
						   mouse-set-region))))))
	(if (and (/= (mark) (point))
		 (not do-multi-click))
900

901 902 903 904 905
	    ;; If point has moved, finish the drag.
	    (let* (last-command this-command)
	      (and mouse-drag-copy-region
		   do-mouse-drag-region-post-process
		   (let (deactivate-mark)
906
		     (copy-region-as-kill (mark) (point)))))
907

908