mouse.el 75.8 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-2014 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5
;; Maintainer: emacs-devel@gnu.org
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
(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)
131 132 133 134 135
                ;; Modify the event in place, so read-key-sequence doesn't
                ;; generate a second fake prefix key (see fake_prefixed_keys in
                ;; src/keyboard.c).
                (setcar this-event newdown)
                (vector this-event))
136 137 138 139 140 141 142
            (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)
143

Jim Blandy's avatar
Jim Blandy committed
144

145 146
;; Provide a mode-specific menu on a mouse button.

147
(defun minor-mode-menu-from-indicator (indicator)
148 149 150 151 152
  "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
153
   (list (completing-read
154 155
	  "Minor mode indicator: "
	  (describe-minor-mode-completion-table-for-indicator))))
156 157
  (let* ((minor-mode (lookup-minor-mode-from-indicator indicator))
         (mm-fun (or (get minor-mode :minor-mode-function) minor-mode)))
158 159 160
    (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]))))
161 162 163
      (setq menu
            (if menu
                (mouse-menu-non-singleton menu)
164
	      `(keymap
165
                ,indicator
166
                (turn-off menu-item "Turn Off minor mode" ,mm-fun)
167
                (help menu-item "Help for minor mode"
168
                      (lambda () (interactive)
169
                        (describe-function ',mm-fun))))))
170
      (popup-menu menu))))
171 172 173 174 175 176 177

(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)))

178
(defun mouse-menu-major-mode-map ()
Glenn Morris's avatar
Glenn Morris committed
179
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
180 181
  (let* (;; Keymap from which to inherit; may be null.
	 (ancestor (mouse-menu-non-singleton
182
		    (and (current-local-map)
183
			 (local-key-binding [menu-bar]))))
184 185 186
	 ;; Make a keymap in which our last command leads to a menu or
	 ;; default to the edit menu.
	 (newmap (if ancestor
187 188
		     (make-sparse-keymap (concat (format-mode-line mode-name)
                                                 " Mode"))
189
		   menu-bar-edit-menu)))
190
    (if ancestor
191
	(set-keymap-parent newmap ancestor))
192
    newmap))
193

194
(defun mouse-menu-non-singleton (menubar)
195 196 197
  "Return menu keybar MENUBAR, or a lone submenu inside it.
If MENUBAR defines exactly one submenu, return just that submenu.
Otherwise, return MENUBAR."
198
  (if menubar
199 200 201
      (let (submap)
        (map-keymap
         (lambda (k v) (setq submap (if submap t (cons k v))))
202
         (keymap-canonicalize menubar))
203 204 205
        (if (eq submap t)
            menubar
          (lookup-key menubar (vector (car submap)))))))
206

207 208
(defun mouse-menu-bar-map ()
  "Return a keymap equivalent to the menu bar.
209 210
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
211
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
212 213 214
  (let* ((local-menu (and (current-local-map)
			  (lookup-key (current-local-map) [menu-bar])))
	 (global-menu (lookup-key global-map [menu-bar]))
215 216 217 218 219 220 221
	 ;; 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
222 223 224 225 226 227 228 229 230 231 232 233 234 235
           (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))
236
	   (minor-mode-key-binding [menu-bar])))
237 238 239 240 241
	 (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
242
			       (cons (concat (format-mode-line mode-name)
243
                                             " Mode Menu")
244 245 246 247 248
				     (cdr local-menu)))))
    (or (stringp global-title-or-map)
	(setq global-menu (cons 'keymap
			        (cons "Global Menu"
				      (cdr global-menu)))))
249
    ;; Supplying the list is faster than making a new map.
250 251 252 253 254 255 256 257 258 259 260
    ;; 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."
261
  (declare (obsolete mouse-menu-major-mode-map "23.1"))
262 263 264 265 266 267 268 269
  (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."
270
  (declare (obsolete mouse-menu-bar-map "23.1"))
271 272
  (interactive "@e \nP")
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
273
  (popup-menu (mouse-menu-bar-map) (unless (integerp event) event) prefix))
274 275 276 277

(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."
278
  (declare (obsolete nil "23.1"))
279 280 281 282 283 284 285
  (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))
286

287 288
;; Commands that operate on windows.

289 290 291 292
(defun mouse-minibuffer-check (event)
  (let ((w (posn-window (event-start event))))
    (and (window-minibuffer-p w)
	 (not (minibuffer-window-active-p w))
293
	 (user-error "Minibuffer window is not active")))
294 295
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook))
296

Jim Blandy's avatar
Jim Blandy committed
297
(defun mouse-delete-window (click)
298
  "Delete the window you click on.
299
Do nothing if the frame has just one window.
300
This command must be bound to a mouse click."
Jim Blandy's avatar
Jim Blandy committed
301
  (interactive "e")
302
  (unless (one-window-p t)
303 304
    (mouse-minibuffer-check click)
    (delete-window (posn-window (event-start click)))))
Jim Blandy's avatar
Jim Blandy committed
305

306 307 308
(defun mouse-select-window (click)
  "Select the window clicked on; don't move point."
  (interactive "e")
309
  (mouse-minibuffer-check click)
310 311 312 313 314 315
  (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)
316
	(set-mouse-position (selected-frame) (1- (frame-width)) 0))))
317

318 319 320
(defun mouse-tear-off-window (click)
  "Delete the window clicked on, and create a new frame displaying its buffer."
  (interactive "e")
321
  (mouse-minibuffer-check click)
322 323
  (let* ((window (posn-window (event-start click)))
	 (buf (window-buffer window))
324
	 (frame (make-frame)))
325 326 327 328
    (select-frame frame)
    (switch-to-buffer buf)
    (delete-window window)))

329
(defun mouse-delete-other-windows ()
330
  "Delete all windows except the one you click on."
331
  (interactive "@")
Jim Blandy's avatar
Jim Blandy committed
332
  (delete-other-windows))
Richard M. Stallman's avatar
Richard M. Stallman committed
333

Jim Blandy's avatar
Jim Blandy committed
334 335 336 337
(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."
338
  (interactive "@e")
339
  (mouse-minibuffer-check click)
340 341
  (let ((start (event-start click)))
    (select-window (posn-window start))
342
    (let ((new-height (1+ (cdr (posn-col-row (event-end click)))))
343 344 345
	  (first-line window-min-height)
	  (last-line (- (window-height) window-min-height)))
      (if (< last-line first-line)
346
	  (error "Window too short to split")
347 348
	(split-window-vertically
	 (min (max new-height first-line) last-line))))))
Jim Blandy's avatar
Jim Blandy committed
349

350 351 352 353 354
(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")
355
  (mouse-minibuffer-check click)
356 357 358 359 360 361
  (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)
362
	  (error "Window too narrow to split")
363 364
	(split-window-horizontally
	 (min (max new-width first-col) last-col))))))
365

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
;; `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.
383

384
(defun mouse-drag-line (start-event line)
385
  "Drag a mode line, header line, or vertical line with the mouse.
386
START-EVENT is the starting mouse-event of the drag action.  LINE
387
must be one of the symbols `header', `mode', or `vertical'."
388 389
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook)
390
  (let* ((echo-keystrokes 0)
391
	 (start (event-start start-event))
392 393 394
	 (window (posn-window start))
	 (frame (window-frame window))
	 (minibuffer-window (minibuffer-window frame))
395 396
         (on-link (and mouse-1-click-follows-link
		       (mouse-on-link-p start)))
397 398 399 400 401
	 (side (and (eq line 'vertical)
		    (or (cdr (assq 'vertical-scroll-bars
				   (frame-parameters frame)))
			'right)))
	 (draggable t)
402
	 height finished event position growth dragged)
403 404 405
    (cond
     ((eq line 'header)
      ;; Check whether header-line can be dragged at all.
406
      (if (window-at-side-p window 'top)
407
	  (setq draggable nil)
408
	(setq height (/ (window-header-line-height window) 2))
409
	(setq window (window-in-direction 'above window t))))
410 411
     ((eq line 'mode)
      ;; Check whether mode-line can be dragged at all.
412 413 414 415 416 417 418 419 420 421 422 423
      (if (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-pixel-edges minibuffer-window))
			    (nth 3 (window-pixel-edges window)))
			 (or (not resize-mini-windows)
			     (eq minibuffer-window
				 (active-minibuffer-window))))))
	  (setq draggable nil)
	(setq height (/ (window-mode-line-height window) 2))))
424
     ((eq line 'vertical)
425 426 427 428 429 430 431
      ;; Get the window to adjust for the vertical case.  If the scroll
      ;; bar is on the window's right or we drag a vertical divider,
      ;; adjust the window where the start-event occurred.  If the
      ;; scroll bar is on the start-event window's left or there are no
      ;; scrollbars, adjust the window on the left of it.
      (unless (or (eq side 'right)
		  (not (zerop (window-right-divider-width window))))
432
	(setq window (window-in-direction 'left window t)))))
433 434

    ;; Start tracking.
435
    (track-mouse
436 437 438 439
      ;; Loop reading events and sampling the position of the mouse.
      (while (not finished)
	(setq event (read-event))
	(setq position (mouse-pixel-position))
440 441 442 443
	;; 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
444 445 446 447 448 449
	;; Drag if
	;;   - there is a mouse-movement event
	;;   - there is a scroll-bar-movement event (Why? -- cyd)
	;;     (same as mouse movement for our purposes)
	;; Quit if
	;;   - there is a keyboard event or some other unknown event.
450
	(cond
451 452
	 ((not (consp event))
	  (setq finished t))
453 454
	 ((memq (car event) '(switch-frame select-window))
	  nil)
455 456 457 458 459 460 461 462 463 464 465 466 467 468
	 ((not (memq (car event) '(mouse-movement scroll-bar-movement)))
	  (when (consp event)
	    ;; Do not unread a drag-mouse-1 event to avoid selecting
	    ;; some other window.  For vertical line dragging do not
	    ;; unread mouse-1 events either (but only if we dragged at
	    ;; least once to allow mouse-1 clicks get through).
	    (unless (and dragged
			 (if (eq line 'vertical)
			     (memq (car event) '(drag-mouse-1 mouse-1))
			   (eq (car event) 'drag-mouse-1)))
	      (push event unread-command-events)))
	  (setq finished t))
	 ((not (and (eq (car position) frame)
		    (cadr position)))
469 470
	  nil)
	 ((eq line 'vertical)
471 472
	  ;; Drag vertical divider.  This must be probably fixed like
	  ;; for the mode-line.
473 474
	  (setq growth (- (cadr position)
			  (if (eq side 'right) 0 2)
475
			  (nth 2 (window-pixel-edges window))
476
			  -1))
477
	  (unless (zerop growth)
478
	    (setq dragged t)
479
	    (adjust-window-trailing-edge window growth t t)))
480 481
	 (draggable
	  ;; Drag horizontal divider.
482 483
	  (setq growth
		(if (eq line 'mode)
484 485
		    (- (+ (cddr position) height)
		       (nth 3 (window-pixel-edges window)))
486
		  ;; The window's top includes the header line!
487 488
		  (- (+ (nth 3 (window-pixel-edges window)) height)
		     (cddr position))))
489
	  (unless (zerop growth)
490 491
	    (setq dragged t)
	    (adjust-window-trailing-edge
492
	     window (if (eq line 'mode) growth (- growth)) nil t))))))
493
    ;; Process the terminating event.
494 495 496 497 498 499
    (when (and (mouse-event-p event) on-link (not dragged)
	       (mouse--remap-link-click-p start-event event))
      ;; If mouse-2 has never been done by the user, it doesn't have
      ;; the necessary property to be interpreted correctly.
      (put 'mouse-2 'event-kind 'mouse-click)
      (setcar event 'mouse-2)
500
      (push event unread-command-events))))
501

502 503 504
(defun mouse-drag-mode-line (start-event)
  "Change the height of a window by dragging on the mode line."
  (interactive "e")
505
  (mouse-drag-line start-event 'mode))
506 507

(defun mouse-drag-header-line (start-event)
508
  "Change the height of a window by dragging on the header line."
509
  (interactive "e")
510
  (mouse-drag-line start-event 'header))
511

512 513 514
(defun mouse-drag-vertical-line (start-event)
  "Change the width of a window by dragging on the vertical line."
  (interactive "e")
515
  (mouse-drag-line start-event 'vertical))
516

517
(defun mouse-set-point (event)
Jim Blandy's avatar
Jim Blandy committed
518
  "Move point to the position clicked on with the mouse.
519
This should be bound to a mouse click event type."
Jim Blandy's avatar
Jim Blandy committed
520
  (interactive "e")
521
  (mouse-minibuffer-check event)
522 523
  ;; 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
524
  (posn-set-point (event-end event)))
Jim Blandy's avatar
Jim Blandy committed
525

526 527 528 529 530 531 532 533 534 535 536
(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))))

537
(defun mouse-set-region (click)
538
  "Set the region to the text dragged over, and copy to kill ring.
539 540 541
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."
542
  (interactive "e")
543
  (mouse-minibuffer-check click)
544 545 546 547 548 549 550 551 552 553 554
  (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.
555
    (or transient-mark-mode
556
	(window-system)
557
	(sit-for 1))
558
    (push-mark)
559
    (set-mark (point))
560
    (if (numberp end) (goto-char end))
561 562 563
    (mouse-set-region-1)))

(defun mouse-set-region-1 ()
564
  ;; Set transient-mark-mode for a little while.
565 566 567 568 569
  (unless (eq (car-safe transient-mark-mode) 'only)
    (setq transient-mark-mode
	  (cons 'only
		(unless (eq transient-mark-mode 'lambda)
		  transient-mark-mode))))
570 571 572
  (setq mouse-last-region-beg (region-beginning))
  (setq mouse-last-region-end (region-end))
  (setq mouse-last-region-tick (buffer-modified-tick)))
573

Richard M. Stallman's avatar
Richard M. Stallman committed
574
(defcustom mouse-scroll-delay 0.25
Lute Kamstra's avatar
Lute Kamstra committed
575
  "The pause between scroll steps caused by mouse drags, in seconds.
576 577 578 579 580
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
581 582 583
Setting this to zero causes Emacs to scroll as fast as it can."
  :type 'number
  :group 'mouse)
584

Richard M. Stallman's avatar
Richard M. Stallman committed
585
(defcustom mouse-scroll-min-lines 1
Lute Kamstra's avatar
Lute Kamstra committed
586
  "The minimum number of lines scrolled by dragging mouse out of window.
587 588 589 590
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
591 592 593
of lines specified by this variable."
  :type 'integer
  :group 'mouse)
594

595 596
(defun mouse-scroll-subr (window jump &optional overlay start)
  "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
597 598 599
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."
600 601 602 603 604
  (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))))
605 606 607 608 609 610 611
  (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)
612 613 614 615 616 617 618
		       (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)))
619 620 621 622 623 624 625 626
		     (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))
627
		   (sit-for mouse-scroll-delay)))))
628 629
    (or (eq window (selected-window))
	(goto-char opoint))))
630

631
(defvar mouse-selection-click-count 0)
632

633 634
(defvar mouse-selection-click-count-buffer nil)

635
(defun mouse-drag-region (start-event)
636
  "Set the region to the text that the mouse is dragged over.
637 638
Highlight the drag area as you move the mouse.
This must be bound to a button-down mouse event.
639
In Transient Mark mode, the highlighting remains as long as the mark
640 641 642
remains active.  Otherwise, it remains until the next input event.

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

648

649
(defun mouse-posn-property (pos property)
650 651
  "Look for a property at click position.
POS may be either a buffer position or a click position like
652
those returned from `event-start'.  If the click position is on
653 654 655 656 657
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."
658 659 660 661 662 663 664 665 666
  (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)))

667 668
(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
669 670
POS must be a buffer position in the current buffer or a mouse
event location in the selected window (see `event-start').
671 672
However, if `mouse-1-click-in-non-selected-windows' is non-nil,
POS may be a mouse event location in any window.
673 674 675

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

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

Kim F. Storm's avatar
Kim F. Storm committed
679 680 681
- 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.
682

Kim F. Storm's avatar
Kim F. Storm committed
683 684 685
The resulting value determine whether POS is inside a link:

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

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

Kim F. Storm's avatar
Kim F. Storm committed
692
- Otherwise, return the value itself.
693 694 695 696 697 698 699 700 701 702 703 704 705

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."
706
  (let ((action
707
	 (and (or (not (consp pos))
708 709 710
		  mouse-1-click-in-non-selected-windows
		  (eq (selected-window) (posn-window pos)))
	      (or (mouse-posn-property pos 'follow-link)
711 712 713
                  (let ((area (posn-area pos)))
                    (when area
                      (key-binding (vector area 'follow-link) nil t pos)))
714 715 716 717 718
		  (key-binding [follow-link] nil t pos)))))
    (cond
     ((eq action 'mouse-face)
      (and (mouse-posn-property pos 'mouse-face) t))
     ((functionp action)
719
      ;; FIXME: This seems questionable if the click is not in a buffer.
720
      ;; Should we instead decide that `action' takes a `posn'?
721 722
      (if (consp pos)
	  (with-current-buffer (window-buffer (posn-window pos))
723
	    (funcall action (posn-point pos)))
724
	(funcall action pos)))
725
     (t action))))
726

727 728 729 730 731
(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)
732
	     (string-match-p "\\`mouse-2" msg)
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	     (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)
749

750
(defun mouse-drag-track (start-event  &optional
751 752
				      do-mouse-drag-region-post-process)
    "Track mouse drags by highlighting area between point and cursor.
753 754 755
The region will be defined with mark and point.
DO-MOUSE-DRAG-REGION-POST-PROCESS should only be used by
`mouse-drag-region'."
756
  (mouse-minibuffer-check start-event)
757
  (setq mouse-selection-click-count-buffer (current-buffer))
758
  (deactivate-mark)
759
  (let* ((scroll-margin 0) ; Avoid margin scrolling (Bug#9541).
760 761 762 763 764
         ;; 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)
765
	 (start-posn (event-start start-event))
766 767
	 (start-point (posn-point start-posn))
	 (start-window (posn-window start-posn))
768
	 (start-window-start (window-start start-window))
769
	 (start-hscroll (window-hscroll start-window))
770
	 (bounds (window-edges start-window))
771
	 (make-cursor-line-fully-visible nil)
772 773 774 775
	 (top (nth 1 bounds))
	 (bottom (if (window-minibuffer-p start-window)
		     (nth 3 bounds)
		   ;; Don't count the mode line.
776
		   (1- (nth 3 bounds))))
777
	 (click-count (1- (event-click-count start-event)))
778 779
	 ;; Suppress automatic hscrolling, because that is a nuisance
	 ;; when setting point near the right fringe (but see below).
780 781
	 (auto-hscroll-mode-saved auto-hscroll-mode)
	 (auto-hscroll-mode nil)
782
	 moved-off-start event end end-point)
783

784
    (setq mouse-selection-click-count click-count)
785 786 787 788 789
    ;; 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))
790

791 792
    ;; Activate the region, using `mouse-start-end' to determine where
    ;; to put point and mark (e.g., double-click will select a word).
793 794 795 796
    (setq transient-mark-mode
	  (if (eq transient-mark-mode 'lambda)
	      '(only)
	    (cons 'only transient-mark-mode)))
797
    (let ((range (mouse-start-end start-point start-point click-count)))
798
      (push-mark (nth 0 range) t t)
799
      (goto-char (nth 1 range)))
800 801 802 803 804 805 806 807 808 809 810

    ;; 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.
811
	  (let ((auto-hscroll-mode auto-hscroll-mode-saved))
812 813 814
	    (redisplay))
	  (setq end (event-end event)
		end-point (posn-point end))
815 816 817
	  ;; Note whether the mouse has left the starting position.
	  (unless (eq end-point start-point)
	    (setq moved-off-start t))
818
	  (if (and (eq (posn-window end) start-window)
819
		   (integer-or-marker-p end-point))
820 821
	      (mouse--drag-set-mark-and-point start-point
					      end-point click-count)
822 823 824 825 826 827 828 829 830 831 832 833 834 835
	    (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)))
836
		 (eq (posn-window end) start-window)
837 838
		 (integer-or-marker-p end-point)
		 (/= start-point end-point))
839 840 841
	(mouse--drag-set-mark-and-point start-point
					end-point click-count))

842 843
      ;; Find its binding.
      (let* ((fun (key-binding (vector (car event))))
Glenn Morris's avatar
Glenn Morris committed
844 845
	     ;; FIXME This doesn't make sense, because
	     ;; event-click-count always returns something >= 1.
846 847 848 849 850 851
	     (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))
852

853 854 855 856 857
	    ;; 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)
858
		     (copy-region-as-kill (mark) (point)))))
859

860
	  ;; Otherwise, run binding of terminating up-event.
861
          (deactivate-mark)
862 863 864 865 866
	  (if do-multi-click
	      (goto-char start-point)
	    (unless moved-off-start
	      (pop-mark)))

867 868 869 870 871 872 873 874 875 876 877 878 879 880
	  (when (and (functionp fun)
		     (= start-hscroll (window-hscroll start-window))
		     ;; Don't run the up-event handler if the window
		     ;; start changed in a redisplay after the
		     ;; mouse-set-point for the down-mouse event at
		     ;; the beginning of this function.  When the
		     ;; window start has changed, the up-mouse event
		     ;; contains a different position due to the new
		     ;; window contents, and point is set again.
		     (or end-point
			 (= (window-start start-window)
			    start-window-start)))
	    (push event unread-command-events)))))))

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
(defun mouse--drag-set-mark-and-point (start click click-count)
  (let* ((range (mouse-start-end start click click-count))
	 (beg (nth 0 range))
	 (end (nth 1 range)))
    (cond ((eq (mark) beg)
	   (goto-char end))
	  ((eq (mark) end)
	   (goto-char beg))
	  ((< click (mark))
	   (set-mark end)
	   (goto-char beg))
	  (t
	   (set-mark beg)
	   (goto-char end)))))

896 897 898 899 900 901
;; Commands to handle xterm-style multiple clicks.
(defun mouse-skip-word (dir)
  "Skip over word, over whitespace, or over identical punctuation.
If DIR is positive skip forward; if negative, skip backward."
  (let* ((char (following-char))
	 (syntax (char-to-string (char-syntax char))))
902 903 904 905
    (cond ((string= syntax "w")
	   ;; Here, we can't use skip-syntax-forward/backward because
	   ;; they don't pay attention to word-separating-categories,
	   ;; and thus they will skip over a true word boundary.  So,
Glenn Morris's avatar
Glenn Morris committed
906
	   ;; we simulate the original behavior by using forward-word.
907 908 909 910 911 912
	   (if (< dir 0)
	       (if (not (looking-at "\\<"))
		   (forward-word -1))
	     (if (or (looking-at "\\<") (not (looking-at "\\>")))
		 (forward-word 1))))
	  ((string= syntax " ")
Richard M. Stallman's avatar