mouse.el 76.8 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'.
104 105 106 107 108

POSITION can be a click event or ((XOFFSET YOFFSET) WINDOW) and
defaults to the current mouse position.  If POSITION is the
symbol `point', the current point position is used.

Stefan Monnier's avatar
Stefan Monnier committed
109
PREFIX is the prefix argument (if any) to pass to the command."
110 111 112 113
  (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
114 115 116
			 (filter (when (symbolp map)
				   (plist-get (get map 'menu-prop) :filter))))
		    (if filter (funcall filter (symbol-function map)) map)))))
117
	 event cmd)
118 119 120 121 122 123 124 125 126 127 128
    (setq position
	  (cond
	   ((eq position 'point)
	    (let* ((pp (posn-at-point))
		   (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
129
    ;; The looping behavior was taken from lmenu's popup-menu-popup
130 131 132 133
    (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
134
			  (x-popup-menu position (indirect-function map))))
Stefan Monnier's avatar
Stefan Monnier committed
135 136 137
      ;; 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)))
138 139 140 141 142 143 144 145
      (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))
146
		    (if (numberp binding)	; `too long'
147 148 149 150 151 152 153 154 155
			(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)))
156 157 158
    ;; 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))
159 160 161 162 163
      (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
164
      (call-interactively cmd))))
165

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

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

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

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

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

(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)
291
  (popup-menu (mouse-menu-bar-map) (unless (integerp event) event) prefix))
292
(make-obsolete 'mouse-popup-menubar 'mouse-menu-bar-map "23.1")
293 294 295 296

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

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

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

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

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

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

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

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

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

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

    ;; Start tracking.
451
    (track-mouse
452 453 454
      ;; Loop reading events and sampling the position of the mouse.
      (while draggable
	(setq event (read-event))
455
	(setq position (mouse-position))
456 457 458 459 460 461 462 463 464 465
	;; 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
	;; 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.
466
	(cond
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
	 ((not (consp event))
	  (setq draggable nil))
	 ((memq (car event) '(switch-frame select-window))
	  nil)
	 ((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 draggable nil))
483
	 ((or (not (eq (car position) frame))
484
	      (null (car (cdr position))))
485 486
	  nil)
	 ((eq line 'vertical)
487 488 489 490 491
	  ;; Drag vertical divider.
	  (setq growth (- (cadr position)
			  (if (eq side 'right) 0 2)
			  (nth 2 (window-edges window))
			  -1))
492 493 494
	  (unless (zerop growth)
	    (setq dragged t))
	  (adjust-window-trailing-edge window growth t))
495 496
	 (draggable
	  ;; Drag horizontal divider.
497 498
	  (setq growth
		(if (eq line 'mode)
499
		    (- (cddr position) (nth 3 (window-edges window)) -1)
500
		  ;; The window's top includes the header line!
501
		  (- (nth 3 (window-edges window)) (cddr position))))
502 503
	  (unless (zerop growth)
	    (setq dragged t))
504 505 506 507 508 509 510 511 512 513 514
	  (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)))
515

516 517 518
(defun mouse-drag-mode-line (start-event)
  "Change the height of a window by dragging on the mode line."
  (interactive "e")
519
  (mouse-drag-line start-event 'mode))
520 521

(defun mouse-drag-header-line (start-event)
522
  "Change the height of a window by dragging on the header line."
523
  (interactive "e")
524
  (mouse-drag-line start-event 'header))
525

526 527 528
(defun mouse-drag-vertical-line (start-event)
  "Change the width of a window by dragging on the vertical line."
  (interactive "e")
529
  (mouse-drag-line start-event 'vertical))
530

531
(defun mouse-set-point (event)
Jim Blandy's avatar
Jim Blandy committed
532
  "Move point to the position clicked on with the mouse.
533
This should be bound to a mouse click event type."
Jim Blandy's avatar
Jim Blandy committed
534
  (interactive "e")
535
  (mouse-minibuffer-check event)
536 537
  ;; 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
538
  (posn-set-point (event-end event)))
Jim Blandy's avatar
Jim Blandy committed
539

540 541 542 543 544 545 546 547 548 549 550
(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))))

551
(defun mouse-set-region (click)
552
  "Set the region to the text dragged over, and copy to kill ring.
553 554 555
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."
556
  (interactive "e")
557
  (mouse-minibuffer-check click)
558 559 560 561 562 563 564 565 566 567 568
  (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.
569
    (or transient-mark-mode
570
	(window-system)
571
	(sit-for 1))
572
    (push-mark)
573
    (set-mark (point))
574
    (if (numberp end) (goto-char end))
575 576 577
    (mouse-set-region-1)))

(defun mouse-set-region-1 ()
578
  ;; Set transient-mark-mode for a little while.
579 580 581 582 583
  (unless (eq (car-safe transient-mark-mode) 'only)
    (setq transient-mark-mode
	  (cons 'only
		(unless (eq transient-mark-mode 'lambda)
		  transient-mark-mode))))
584 585 586
  (setq mouse-last-region-beg (region-beginning))
  (setq mouse-last-region-end (region-end))
  (setq mouse-last-region-tick (buffer-modified-tick)))
587

Richard M. Stallman's avatar
Richard M. Stallman committed
588
(defcustom mouse-scroll-delay 0.25
Lute Kamstra's avatar
Lute Kamstra committed
589
  "The pause between scroll steps caused by mouse drags, in seconds.
590 591 592 593 594
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
595 596 597
Setting this to zero causes Emacs to scroll as fast as it can."
  :type 'number
  :group 'mouse)
598

Richard M. Stallman's avatar
Richard M. Stallman committed
599
(defcustom mouse-scroll-min-lines 1
Lute Kamstra's avatar
Lute Kamstra committed
600
  "The minimum number of lines scrolled by dragging mouse out of window.
601 602 603 604
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
605 606 607
of lines specified by this variable."
  :type 'integer
  :group 'mouse)
608

609 610
(defun mouse-scroll-subr (window jump &optional overlay start)
  "Scroll the window WINDOW, JUMP lines at a time, until new input arrives.
611 612 613
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."
614 615 616 617 618
  (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))))
619 620 621 622 623 624 625
  (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)
626 627 628 629 630 631 632
		       (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)))
633 634 635 636 637 638 639 640
		     (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))
641
		   (sit-for mouse-scroll-delay)))))
642 643
    (or (eq window (selected-window))
	(goto-char opoint))))
644

645
(defvar mouse-selection-click-count 0)
646

647 648
(defvar mouse-selection-click-count-buffer nil)

649
(defun mouse-drag-region (start-event)
650
  "Set the region to the text that the mouse is dragged over.
651 652
Highlight the drag area as you move the mouse.
This must be bound to a button-down mouse event.
653
In Transient Mark mode, the highlighting remains as long as the mark
654 655 656
remains active.  Otherwise, it remains until the next input event.

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

662

663
(defun mouse-posn-property (pos property)
664 665
  "Look for a property at click position.
POS may be either a buffer position or a click position like
666
those returned from `event-start'.  If the click position is on
667 668 669 670 671
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."
672 673 674 675 676 677 678 679 680
  (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)))

681 682
(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
683 684
POS must be a buffer position in the current buffer or a mouse
event location in the selected window (see `event-start').
685 686
However, if `mouse-1-click-in-non-selected-windows' is non-nil,
POS may be a mouse event location in any window.
687 688 689

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

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

Kim F. Storm's avatar
Kim F. Storm committed
693 694 695
- 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.
696

Kim F. Storm's avatar
Kim F. Storm committed
697 698 699
The resulting value determine whether POS is inside a link:

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

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

Kim F. Storm's avatar
Kim F. Storm committed
706
- Otherwise, return the value itself.
707 708 709 710 711 712 713 714 715 716 717 718 719

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."
720 721 722 723 724 725 726 727 728 729
  (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)
730
      ;; FIXME: This seems questionable if the click is not in a buffer.
731
      ;; Should we instead decide that `action' takes a `posn'?
732 733
      (if (consp pos)
	  (with-current-buffer (window-buffer (posn-window pos))
734
	    (funcall action (posn-point pos)))
735
	(funcall action pos)))
736
     (t action))))
737

738 739 740 741 742
(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)
743
	     (string-match-p "\\`mouse-2" msg)
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
	     (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)
760

761
(defun mouse-drag-track (start-event  &optional
762 763
				      do-mouse-drag-region-post-process)
    "Track mouse drags by highlighting area between point and cursor.
764 765 766
The region will be defined with mark and point.
DO-MOUSE-DRAG-REGION-POST-PROCESS should only be used by
`mouse-drag-region'."
767
  (mouse-minibuffer-check start-event)
768
  (setq mouse-selection-click-count-buffer (current-buffer))
769
  (deactivate-mark)
770 771
  (let* ((scroll-margin 0) ; Avoid margin scrolling (Bug#9541).
	 (original-window (selected-window))
772 773 774 775 776
         ;; 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)
777
	 (start-posn (event-start start-event))
778 779
	 (start-point (posn-point start-posn))
	 (start-window (posn-window start-posn))
780
	 (start-window-start (window-start start-window))
781
	 (start-hscroll (window-hscroll start-window))
782
	 (bounds (window-edges start-window))
783
	 (make-cursor-line-fully-visible nil)
784 785 786 787
	 (top (nth 1 bounds))
	 (bottom (if (window-minibuffer-p start-window)
		     (nth 3 bounds)
		   ;; Don't count the mode line.
788
		   (1- (nth 3 bounds))))
789
	 (on-link (and mouse-1-click-follows-link
790
                       ;; Use start-point before the intangibility
791
                       ;; treatment, in case we click on a link inside
792
                       ;; intangible text.
793
                       (mouse-on-link-p start-posn)))
794
	 (click-count (1- (event-click-count start-event)))
795 796 797
	 (remap-double-click (and on-link
				  (eq mouse-1-click-follows-link 'double)
				  (= click-count 1)))
798 799
	 ;; Suppress automatic hscrolling, because that is a nuisance
	 ;; when setting point near the right fringe (but see below).
800 801
	 (auto-hscroll-mode-saved auto-hscroll-mode)
	 (auto-hscroll-mode nil)
802
	 moved-off-start event end end-point)
803

804
    (setq mouse-selection-click-count click-count)
805 806 807 808 809
    ;; 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))
810 811
    (if remap-double-click
	(setq click-count 0))
812

813 814
    ;; Activate the region, using `mouse-start-end' to determine where
    ;; to put point and mark (e.g., double-click will select a word).
815 816 817 818
    (setq transient-mark-mode
	  (if (eq transient-mark-mode 'lambda)
	      '(only)
	    (cons 'only transient-mark-mode)))
819
    (let ((range (mouse-start-end start-point start-point click-count)))
820
      (push-mark (nth 0 range) t t)
821
      (goto-char (nth 1 range)))
822 823 824 825 826 827 828 829 830 831 832

    ;; 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.
833
	  (let ((auto-hscroll-mode auto-hscroll-mode-saved))
834 835 836
	    (redisplay))
	  (setq end (event-end event)
		end-point (posn-point end))
837 838 839
	  ;; Note whether the mouse has left the starting position.
	  (unless (eq end-point start-point)
	    (setq moved-off-start t))
840
	  (if (and (eq (posn-window end) start-window)
841
		   (integer-or-marker-p end-point))
842 843
	      (mouse--drag-set-mark-and-point start-point
					      end-point click-count)
844 845 846 847 848 849 850 851 852 853 854 855 856 857
	    (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)))
858
		 (eq (posn-window end) start-window)
859 860
		 (integer-or-marker-p end-point)
		 (/= start-point end-point))
861 862 863
	(mouse--drag-set-mark-and-point start-point
					end-point click-count))

864 865 866 867 868 869 870 871
      ;; 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))
872

873 874 875 876 877
	    ;; 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)
878
		     (copy-region-as-kill (mark) (point)))))
879

880
	  ;; Otherwise, run binding of terminating up-event.
881 882 883 884 885 886
	  (if do-multi-click
	      (goto-char start-point)
	    (deactivate-mark)
	    (unless moved-off-start
	      (pop-mark)))

887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
	  (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)))))))

916 917 918 919 920 921 922 923 924