mouse.el 76 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; mouse.el --- window system-independent mouse support
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1993-1995, 1999-2012 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 96

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)


Jim Blandy's avatar
Jim Blandy committed
97

98 99
;; Provide a mode-specific menu on a mouse button.

Stefan Monnier's avatar
Stefan Monnier committed
100 101
(defun popup-menu (menu &optional position prefix)
  "Popup the given menu and call the selected option.
102 103
MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
`x-popup-menu'.
Stefan Monnier's avatar
Stefan Monnier committed
104
POSITION can be a click event or ((XOFFSET YOFFSET) WINDOW) and defaults to
105 106
  the current mouse position. If POSITION is a symbol, `point' the current point
position is used.
Stefan Monnier's avatar
Stefan Monnier committed
107
PREFIX is the prefix argument (if any) to pass to the command."
108 109 110 111
  (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
112 113 114
			 (filter (when (symbolp map)
				   (plist-get (get map 'menu-prop) :filter))))
		    (if filter (funcall filter (symbol-function map)) map)))))
115
	 event cmd)
116 117 118
  (setq position
	(cond
	 ((eq position 'point)
119
	  (let* ((pp (posn-at-point))
120 121 122 123 124 125 126
                 (xy (posn-x-y pp)))
	    (list (list (car xy) (cdr xy)) (posn-window pp))))
	 ((not position)
	  (let ((mp (mouse-pixel-position)))
	    (list (list (cadr mp) (cddr mp)) (car mp))))
	 (t
	  position)))
Stefan Monnier's avatar
Stefan Monnier committed
127
    ;; The looping behavior was taken from lmenu's popup-menu-popup
128 129 130 131
    (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
132
			  (x-popup-menu position (indirect-function map))))
Stefan Monnier's avatar
Stefan Monnier committed
133 134 135
      ;; 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)))
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
      (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))
		    (if (numberp binding) ; `too long'
			(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)))
154 155 156
    ;; 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))
157 158 159 160 161
      (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
162
      (call-interactively cmd))))
163

164
(defun minor-mode-menu-from-indicator (indicator)
165 166 167 168 169
  "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
170
   (list (completing-read
171 172
	  "Minor mode indicator: "
	  (describe-minor-mode-completion-table-for-indicator))))
173 174
  (let* ((minor-mode (lookup-minor-mode-from-indicator indicator))
         (mm-fun (or (get minor-mode :minor-mode-function) minor-mode)))
175 176 177
    (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]))))
178 179 180
      (setq menu
            (if menu
                (mouse-menu-non-singleton menu)
181
	      `(keymap
182
                ,indicator
183
                (turn-off menu-item "Turn Off minor mode" ,mm-fun)
184
                (help menu-item "Help for minor mode"
185
                      (lambda () (interactive)
186
                        (describe-function ',mm-fun))))))
187
      (popup-menu menu))))
188 189 190 191 192 193 194

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

195
(defun mouse-menu-major-mode-map ()
Glenn Morris's avatar
Glenn Morris committed
196
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
197 198
  (let* (;; Keymap from which to inherit; may be null.
	 (ancestor (mouse-menu-non-singleton
199
		    (and (current-local-map)
200
			 (local-key-binding [menu-bar]))))
201 202 203
	 ;; Make a keymap in which our last command leads to a menu or
	 ;; default to the edit menu.
	 (newmap (if ancestor
204 205
		     (make-sparse-keymap (concat (format-mode-line mode-name)
                                                 " Mode"))
206
		   menu-bar-edit-menu)))
207
    (if ancestor
208
	(set-keymap-parent newmap ancestor))
209
    newmap))
210

211
(defun mouse-menu-non-singleton (menubar)
212 213 214
  "Return menu keybar MENUBAR, or a lone submenu inside it.
If MENUBAR defines exactly one submenu, return just that submenu.
Otherwise, return MENUBAR."
215
  (if menubar
216 217 218
      (let (submap)
        (map-keymap
         (lambda (k v) (setq submap (if submap t (cons k v))))
219
         (keymap-canonicalize menubar))
220 221 222
        (if (eq submap t)
            menubar
          (lookup-key menubar (vector (car submap)))))))
223

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

(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."
  (interactive "@e \nP")
  (run-hooks 'activate-menubar-hook 'menu-bar-update-hook)
289
  (popup-menu (mouse-menu-bar-map) (unless (integerp event) event) prefix))
290
(make-obsolete 'mouse-popup-menubar 'mouse-menu-bar-map "23.1")
291 292 293 294

(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."
295 296 297 298 299 300 301
  (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))
302
(make-obsolete 'mouse-popup-menubar-stuff nil "23.1")
303

304 305
;; Commands that operate on windows.

306 307 308 309
(defun mouse-minibuffer-check (event)
  (let ((w (posn-window (event-start event))))
    (and (window-minibuffer-p w)
	 (not (minibuffer-window-active-p w))
310
	 (user-error "Minibuffer window is not active")))
311 312
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook))
313

Jim Blandy's avatar
Jim Blandy committed
314
(defun mouse-delete-window (click)
315
  "Delete the window you click on.
316
Do nothing if the frame has just one window.
317
This command must be bound to a mouse click."
Jim Blandy's avatar
Jim Blandy committed
318
  (interactive "e")
319
  (unless (one-window-p t)
320 321
    (mouse-minibuffer-check click)
    (delete-window (posn-window (event-start click)))))
Jim Blandy's avatar
Jim Blandy committed
322

323 324 325
(defun mouse-select-window (click)
  "Select the window clicked on; don't move point."
  (interactive "e")
326
  (mouse-minibuffer-check click)
327 328 329 330 331 332
  (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)
333
	(set-mouse-position (selected-frame) (1- (frame-width)) 0))))
334

335 336 337
(defun mouse-tear-off-window (click)
  "Delete the window clicked on, and create a new frame displaying its buffer."
  (interactive "e")
338
  (mouse-minibuffer-check click)
339 340
  (let* ((window (posn-window (event-start click)))
	 (buf (window-buffer window))
341
	 (frame (make-frame)))
342 343 344 345
    (select-frame frame)
    (switch-to-buffer buf)
    (delete-window window)))

346
(defun mouse-delete-other-windows ()
347
  "Delete all windows except the one you click on."
348
  (interactive "@")
Jim Blandy's avatar
Jim Blandy committed
349
  (delete-other-windows))
Richard M. Stallman's avatar
Richard M. Stallman committed
350

Jim Blandy's avatar
Jim Blandy committed
351 352 353 354
(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."
355
  (interactive "@e")
356
  (mouse-minibuffer-check click)
357 358
  (let ((start (event-start click)))
    (select-window (posn-window start))
359
    (let ((new-height (1+ (cdr (posn-col-row (event-end click)))))
360 361 362
	  (first-line window-min-height)
	  (last-line (- (window-height) window-min-height)))
      (if (< last-line first-line)
363
	  (error "Window too short to split")
364 365
	(split-window-vertically
	 (min (max new-height first-line) last-line))))))
Jim Blandy's avatar
Jim Blandy committed
366

367 368 369 370 371
(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")
372
  (mouse-minibuffer-check click)
373 374 375 376 377 378
  (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)
379
	  (error "Window too narrow to split")
380 381
	(split-window-horizontally
	 (min (max new-width first-col) last-col))))))
382

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
;; `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.
400

401
(defun mouse-drag-line (start-event line)
402
  "Drag a mode line, header line, or vertical line with the mouse.
403
START-EVENT is the starting mouse-event of the drag action.  LINE
404
must be one of the symbols `header', `mode', or `vertical'."
405 406
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook)
407
  (let* ((echo-keystrokes 0)
408
	 (start (event-start start-event))
409 410 411
	 (window (posn-window start))
	 (frame (window-frame window))
	 (minibuffer-window (minibuffer-window frame))
412
         (on-link (and mouse-1-click-follows-link
413
		       (mouse-on-link-p start)))
414 415 416 417 418 419
	 (side (and (eq line 'vertical)
		    (or (cdr (assq 'vertical-scroll-bars
				   (frame-parameters frame)))
			'right)))
	 (draggable t)
	 event position growth dragged)
420 421 422
    (cond
     ((eq line 'header)
      ;; Check whether header-line can be dragged at all.
423
      (if (window-at-side-p window 'top)
424
	  (setq draggable nil)
425
	(setq window (window-in-direction 'above window t))))
426 427
     ((eq line 'mode)
      ;; Check whether mode-line can be dragged at all.
428 429 430 431 432 433 434 435 436 437 438
      (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)))
439
     ((eq line 'vertical)
440 441 442 443 444 445 446
      ;; 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)))))
447 448

    ;; Start tracking.
449
    (track-mouse
450 451 452 453 454 455 456 457
      ;; 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)
      (while (progn
	       (setq event (read-event))
	       (memq (car-safe event) '(mouse-movement scroll-bar-movement)))
	(setq position (mouse-position))
458
	(cond
459 460
	 ((or (not (eq (car position) frame))
	      (null (cadr position)))
461 462
	  nil)
	 ((eq line 'vertical)
463 464 465 466 467
	  ;; Drag vertical divider.
	  (setq growth (- (cadr position)
			  (if (eq side 'right) 0 2)
			  (nth 2 (window-edges window))
			  -1))
468 469 470
	  (unless (zerop growth)
	    (setq dragged t))
	  (adjust-window-trailing-edge window growth t))
471 472
	 (draggable
	  ;; Drag horizontal divider.
473 474
	  (setq growth
		(if (eq line 'mode)
475
		    (- (cddr position) (nth 3 (window-edges window)) -1)
476
		  ;; The window's top includes the header line!
477
		  (- (nth 3 (window-edges window)) (cddr position))))
478 479
	  (unless (zerop growth)
	    (setq dragged t))
480 481 482 483 484 485 486 487 488 489 490
	  (adjust-window-trailing-edge window (if (eq line 'mode)
						  growth
						(- growth)))))))
    ;; Process the terminating event.
    (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))
    (push event unread-command-events)))
491

492 493 494 495

(defun mouse-drag-mode-line (start-event)
  "Change the height of a window by dragging on the mode line."
  (interactive "e")
496
  (mouse-drag-line start-event 'mode))
497 498

(defun mouse-drag-header-line (start-event)
499
  "Change the height of a window by dragging on the header line."
500
  (interactive "e")
501
  (mouse-drag-line start-event 'header))
502

503 504 505
(defun mouse-drag-vertical-line (start-event)
  "Change the width of a window by dragging on the vertical line."
  (interactive "e")
506
  (mouse-drag-line start-event 'vertical))
507

508
(defun mouse-set-point (event)
Jim Blandy's avatar
Jim Blandy committed
509
  "Move point to the position clicked on with the mouse.
510
This should be bound to a mouse click event type."
Jim Blandy's avatar
Jim Blandy committed
511
  (interactive "e")
512
  (mouse-minibuffer-check event)
513 514
  ;; 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
515
  (posn-set-point (event-end event)))
Jim Blandy's avatar
Jim Blandy committed
516

517 518 519 520 521 522 523 524 525 526 527
(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))))

528
(defun mouse-set-region (click)
529
  "Set the region to the text dragged over, and copy to kill ring.
530 531 532
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."
533
  (interactive "e")
534
  (mouse-minibuffer-check click)
535 536 537 538 539 540 541 542 543 544 545
  (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.
546
    (or transient-mark-mode
547
	(window-system)
548
	(sit-for 1))
549
    (push-mark)
550
    (set-mark (point))
551
    (if (numberp end) (goto-char end))
552 553 554
    (mouse-set-region-1)))

(defun mouse-set-region-1 ()
555
  ;; Set transient-mark-mode for a little while.
556 557 558 559 560
  (unless (eq (car-safe transient-mark-mode) 'only)
    (setq transient-mark-mode
	  (cons 'only
		(unless (eq transient-mark-mode 'lambda)
		  transient-mark-mode))))
561 562 563
  (setq mouse-last-region-beg (region-beginning))
  (setq mouse-last-region-end (region-end))
  (setq mouse-last-region-tick (buffer-modified-tick)))
564

Richard M. Stallman's avatar
Richard M. Stallman committed
565
(defcustom mouse-scroll-delay 0.25
Lute Kamstra's avatar
Lute Kamstra committed
566
  "The pause between scroll steps caused by mouse drags, in seconds.
567 568 569 570 571
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
572 573 574
Setting this to zero causes Emacs to scroll as fast as it can."
  :type 'number
  :group 'mouse)
575

Richard M. Stallman's avatar
Richard M. Stallman committed
576
(defcustom mouse-scroll-min-lines 1
Lute Kamstra's avatar
Lute Kamstra committed
577
  "The minimum number of lines scrolled by dragging mouse out of window.
578 579 580 581
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
582 583 584
of lines specified by this variable."
  :type 'integer
  :group 'mouse)
585

586 587
(defun mouse-scroll-subr (window jump &optional overlay start)
  "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
588 589 590
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."
591 592 593 594 595
  (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))))
596 597 598 599 600 601 602
  (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)
603 604 605 606 607 608 609
		       (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)))
610 611 612 613 614 615 616 617
		     (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))
618
		   (sit-for mouse-scroll-delay)))))
619 620
    (or (eq window (selected-window))
	(goto-char opoint))))
621

622
(defvar mouse-selection-click-count 0)
623

624 625
(defvar mouse-selection-click-count-buffer nil)

626
(defun mouse-drag-region (start-event)
627
  "Set the region to the text that the mouse is dragged over.
628 629
Highlight the drag area as you move the mouse.
This must be bound to a button-down mouse event.
630
In Transient Mark mode, the highlighting remains as long as the mark
631 632 633
remains active.  Otherwise, it remains until the next input event.

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

639

640
(defun mouse-posn-property (pos property)
641 642
  "Look for a property at click position.
POS may be either a buffer position or a click position like
643
those returned from `event-start'.  If the click position is on
644 645 646 647 648
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."
649 650 651 652 653 654 655 656 657
  (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)))

658 659
(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
660 661
POS must be a buffer position in the current buffer or a mouse
event location in the selected window (see `event-start').
662 663
However, if `mouse-1-click-in-non-selected-windows' is non-nil,
POS may be a mouse event location in any window.
664 665 666

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

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

Kim F. Storm's avatar
Kim F. Storm committed
670 671 672
- 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.
673

Kim F. Storm's avatar
Kim F. Storm committed
674 675 676
The resulting value determine whether POS is inside a link:

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

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

Kim F. Storm's avatar
Kim F. Storm committed
683
- Otherwise, return the value itself.
684 685 686 687 688 689 690 691 692 693 694 695 696

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."
697 698 699 700 701 702 703 704 705 706
  (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)
707
      ;; FIXME: This seems questionable if the click is not in a buffer.
708
      ;; Should we instead decide that `action' takes a `posn'?
709 710
      (if (consp pos)
	  (with-current-buffer (window-buffer (posn-window pos))
711
	    (funcall action (posn-point pos)))
712
	(funcall action pos)))
713
     (t action))))
714

715 716 717 718 719
(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)
720
	     (string-match-p "\\`mouse-2" msg)
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
	     (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)
737

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

781
    (setq mouse-selection-click-count click-count)
782 783 784 785 786
    ;; 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))
787 788
    (if remap-double-click
	(setq click-count 0))
789

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

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

841 842 843 844 845 846 847 848
      ;; Find its binding.
      (let* ((fun (key-binding (vector (car event))))
	     (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))
849

850 851 852 853 854
	    ;; 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)
855
		     (copy-region-as-kill (mark) (point)))))
856

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

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
	  (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)))
	    (when (and on-link
		       (= start-point (point))
		       (mouse--remap-link-click-p start-event event))
	      ;; If we rebind to mouse-2, reselect previous selected
	      ;; window, so that the mouse-2 event runs in the same
	      ;; situation as if user had clicked it directly.  Fixes
	      ;; the bug reported by juri@jurta.org on 2005-12-27.
	      (if (or (vectorp on-link) (stringp on-link))
		  (setq event (aref on-link 0))
		(select-window original-window)
		(setcar event 'mouse-2)
		;; If this mouse click 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)))
	    (push event unread-command-events)))))))

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
(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)))))

908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
(defun mouse--remap-link-click-p (start-event end-event)
  (or (and (eq mouse-1-click-follows-link 'double)
	   (= (event-click-count start-event) 2))
      (and
       (not (eq mouse-1-click-follows-link 'double))
       (= (event-click-count start-event) 1)
       (= (event-click-count end-event) 1)
       (or (not (integerp mouse-1-click-follows-link))
	   (let ((t0 (posn-timestamp (event-start start-event)))
		 (t1 (posn-timestamp (event-end   end-event))))
	     (and (integerp t0) (integerp t1)
		  (if (> mouse-1-click-follows-link 0)
		      (<= (- t1 t0) mouse-1-click-follows-link)
		    (< (- t0 t1) mouse-1-click-follows-link))))))))