annotate lisp/windmove.el @ 28234:763c6639628b

(combine-run-hooks): New function.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Tue, 21 Mar 2000 15:28:44 +0000
parents ea6b156518f2
children 495502641770
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27545
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 ;; windmove.el -- directional window-selection routines.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
2 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
4 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5 ;; Author: Hovav Shacham (hovav@cs.stanford.edu)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6 ;; Created: 17 October 1998
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
7 ;; Keywords: window, movement
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
8 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
14 ;; any later version.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
15 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
20 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
24 ;; Boston, MA 02111-1307, USA.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
25 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26 ;; --------------------------------------------------------------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
27
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
28 ;;; Commentary:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
29 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
30 ;; This package defines a set of routines, windmove-{left,up,right,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
31 ;; down}, for selection of windows in a frame geometrically. For
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
32 ;; example, `windmove-right' selects the window immediately to the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 ;; right of the currently-selected one. This functionality is similar
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34 ;; to the window-selection controls of the BRIEF editor of yore.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
36 ;; One subtle point is what happens when the window to the right has
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
37 ;; been split vertically; for example, consider a call to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
38 ;; `windmove-right' in this setup:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
39 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41 ;; | | A |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 ;; | | |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43 ;; | |-----
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 ;; | * | | (* is point in the currently
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 ;; | | B | selected window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 ;; | | |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
47 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
48 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
49 ;; There are (at least) three reasonable things to do:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
50 ;; (1) Always move to the window to the right of the top edge of the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
51 ;; selected window; in this case, this policy selects A.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
52 ;; (2) Always move to the window to the right of the bottom edge of
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
53 ;; the selected window; in this case, this policy selects B.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
54 ;; (3) Move to the window to the right of point in the slected
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55 ;; window. This may select either A or B, depending on the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
56 ;; position of point; in the illustrated example, it would select
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
57 ;; B.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59 ;; Similar issues arise for all the movement functions. Windmove
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 ;; resolves this problem by allowing the user to specify behavior
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
61 ;; through a prefix argument. The cases are thus:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 ;; * if no argument is given to the movement functions, or the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 ;; argument given is zero, movement is relative to point;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64 ;; * if a positive argument is given, movement is relative to the top
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 ;; or left edge of the selected window, depending on whether the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66 ;; movement is to be horizontal or vertical;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67 ;; * if a negative argument is given, movement is relative to the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
68 ;; bottom or right edge of the selected window, depending on whether
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
69 ;; the movement is to be horizontal or vertical.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72 ;; Another feature enables wrap-around mode when the variable
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73 ;; `windmove-wrap-around' is set to a non-nil value. In this mode,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74 ;; movement that falls off the edge of the frame will wrap around to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 ;; find the window on the opposite side of the frame. Windmove does
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
76 ;; the Right Thing about the minibuffer; for example, consider:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79 ;; | * |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80 ;; |-----------|
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 ;; | A |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 ;; |-----------| (* is point in the currently
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 ;; | B | C | selected window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84 ;; | | |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87 ;; With wraparound enabled, windmove-down will move to A, while
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 ;; windmove-up will move to the minibuffer if it is active, or to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89 ;; either B or C depending on the prefix argument.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
91 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92 ;; A set of default keybindings is supplied: shift-{left,up,right,down}
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
93 ;; invoke the corresponding Windmove function. See the installation
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
94 ;; section if you wish to use these keybindings.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
96
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
97 ;; Installation:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
98 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
99 ;; Put the following line in your `.emacs' file:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
100 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
101 ;; (windmove-default-keybindings) ; default keybindings
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
102 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
104 ;; If you wish to enable wrap-around, also add a line like:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
105 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
106 ;; (setq windmove-wrap-around t)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
107 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109 ;; Note: If you have an Emacs that manifests a bug that sometimes
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110 ;; causes the occasional creation of a "lost column" between windows,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111 ;; so that two adjacent windows do not actually touch, you may want to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112 ;; increase the value of `windmove-window-distance-delta' to 2 or 3:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
113 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
114 ;; (setq windmove-window-distance-delta 2)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
115 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
116
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117 ;; Acknowledgements:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
118 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
119 ;; Special thanks to Julian Assange (proff@iq.org), whose
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120 ;; change-windows-intuitively.el predates Windmove, and provided the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
121 ;; inspiration for it. Kin Cho (kin@symmetrycomm.com) was the first
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
122 ;; to suggest wrap-around behavior. Thanks also to Gerd Moellmann
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
123 ;; (gerd@gnu.org) for his comments and suggestions.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125 ;; --------------------------------------------------------------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
127 ;;; Code:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
128
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
129
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 ;; User configurable variables:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
131
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
132 ;; For customize ...
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
133 (defgroup windmove nil
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
134 "Directional selection of windows in a frame."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
135 :prefix "windmove-"
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
136 :group 'windows
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
137 :group 'convenience)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
138
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
139
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
140 (defcustom windmove-wrap-around nil
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
141 "Whether movement off the edge of the frame wraps around.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
142 If this variable is set to t, moving left from the leftmost window in
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 a frame will find the rightmost one, and similarly for the other
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
144 directions. The minibuffer is skipped over in up/down movements if it
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145 is inactive."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146 :type 'boolean
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
147 :group 'windmove)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
148
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
149 ;; If your Emacs sometimes places an empty column between two adjacent
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
150 ;; windows, you may wish to set this delta to 2.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
151 (defcustom windmove-window-distance-delta 1
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
152 "How far away from the current window to look for an adjacent window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
153 Measured in characters either horizontally or vertically; setting this
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
154 to a value larger than 1 may be useful in getting around window-
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
155 placement bugs in old versions of Emacs."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
156 :type 'number
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
157 :group 'windmove)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
158
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
159
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
160
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
161 ;; Implementation overview:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
162 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
163 ;; The conceptual framework behind this code is all fairly simple. We
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
164 ;; are on one window; we wish to move to another. The correct window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
165 ;; to move to is determined by the position of point in the current
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
166 ;; window as well as the overall window setup.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
167 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
168 ;; Early on, I made the decision to base my implementation around the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
169 ;; built-in function `window-at'. This function takes a frame-based
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
170 ;; coordinate, and returns the window that contains it. Using this
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
171 ;; function, the job of the various top-level windmove functions can
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
172 ;; be decomposed: first, find the current frame-based location of
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
173 ;; point; second, manipulate it in some way to give a new location,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
174 ;; that hopefully falls in the window immediately at left (or right,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
175 ;; etc.); third, use `window-at' and `select-window' to select the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
176 ;; window at that new location.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
177 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
178 ;; This is probably not the only possible architecture, and it turns
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
179 ;; out to have some inherent cruftiness. (Well, okay, the third step
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
180 ;; is pretty clean....) We will consider each step in turn.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
181 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
182 ;; A quick digression about coordinate frames: most of the functions
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
183 ;; in the windmove package deal with screen coordinates in one way or
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
184 ;; another. These coordinates are always relative to some reference
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
185 ;; points. Window-based coordinates have their reference point in the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
186 ;; upper-left-hand corner of whatever window is being talked about;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
187 ;; frame-based coordinates have their reference point in the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
188 ;; upper-left-hand corner of the entire frame (of which the current
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
189 ;; window is a component).
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
190 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
191 ;; All coordinates are zero-based, which simply means that the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
192 ;; reference point (whatever it is) is assigned the value (x=0, y=0).
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
193 ;; X-coordinates grow down the screen, and Y-coordinates grow towards
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
194 ;; the right of the screen.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
195 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
196 ;; Okay, back to work. The first step is to gather information about
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
197 ;; the frame-based coordinates of point, or rather, the reference
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
198 ;; location. The reference location can be point, or the upper-left,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
199 ;; or the lower-right corner of the window; the particular one used is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
200 ;; controlled by the prefix argument to `windmove-left' and all the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
201 ;; rest.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
202 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
203 ;; This work is done by `windmove-reference-loc'. It can figure out
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
204 ;; the locations of the corners by calling `window-edges', but to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
205 ;; calculate the frame-based location of point, it calls the workhorse
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
206 ;; function `windmove-coordinates-of-position', which itself calls the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
207 ;; incredibly hairy builtin `compute-motion'. There is a good deal of
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
208 ;; black magic in getting all the arguments to this function just right.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
209 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
210 ;; The second step is more messy. Conceptually, it is fairly simple:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
211 ;; if we know the reference location, and the coordinates of the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
212 ;; current window, we can "throw" our reference point just over the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
213 ;; appropriate edge of the window, and see what other window is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
214 ;; there. More explicitly, consider this example from the user
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
215 ;; documentation above.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
216 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
217 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
218 ;; | | A |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
219 ;; | | |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
220 ;; | |-----
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
221 ;; | * | | (* is point in the currently
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
222 ;; | | B | selected window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
223 ;; | | |
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
224 ;; -------------
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
225 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
226 ;; The asterisk marks the reference point; we wish to move right.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
227 ;; Since we are moving horizontally, the Y coordinate of the new
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
228 ;; location will be the same. The X coordinate can be such that it is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
229 ;; just past the edge of the present window. Obviously, the new point
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
230 ;; will be inside window B. This in itself is fairly simple: using
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
231 ;; the result of `windmove-reference-loc' and `window-edges', all the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
232 ;; necessary math can be performed. (Having said that, there is a
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
233 ;; good deal of room for off-by-one errors, and Emacs 19.34, at least,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
234 ;; sometimes manifests a bug where two windows don't actually touch,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
235 ;; so a larger skip is required.) The actual math here is done by
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
236 ;; `windmove-other-window-loc'.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
237 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
238 ;; But we can't just pass the result of `windmove-other-window-loc' to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
239 ;; `window-at' directly. Why not? Suppose a move would take us off
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
240 ;; the edge of the screen, say to the left. We want to give a
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
241 ;; descriptive error message to the user. Or, suppose that a move
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
242 ;; would place us in the minibuffer. What if the minibuffer is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
243 ;; inactive?
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
244 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
245 ;; Actually, the whole subject of the minibuffer edge of the frame is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
246 ;; rather messy. It turns out that with a sufficiently large delta,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
247 ;; we can fly off the bottom edge of the frame and miss the minibuffer
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
248 ;; altogther. This, I think, is never right: if there's a minibuffer
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
249 ;; and you're not in it, and you move down, the minibuffer should be
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
250 ;; in your way.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
251 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
252 ;; (By the way, I'm not totally sure that the code does the right
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
253 ;; thing in really weird cases, like a frame with no minibuffer.)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
254 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
255 ;; So, what we need is some ways to do constraining and such. The
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
256 ;; early versions of windmove took a fairly simplistic approach to all
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
257 ;; this. When I added the wrap-around option, those internals had to
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
258 ;; be rewritten. After a *lot* of futzing around, I came up with a
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
259 ;; two-step process that I think is general enough to cover the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
260 ;; relevant cases. (I'm not totally happy with having to pass the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
261 ;; window variable as deep as I do, but we can't have everything.)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
262 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
263 ;; In the first phase, we make sure that the new location is sane.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
264 ;; "Sane" means that we can only fall of the edge of the frame in the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
265 ;; direction we're moving in, and that we don't miss the minibuffer if
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
266 ;; we're moving down and not already in the minibuffer. The function
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
267 ;; `windmove-constrain-loc-for-movement' takes care of all this.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
268 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
269 ;; Then, we handle the wraparound, if it's enabled. The function
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
270 ;; `windmove-wrap-loc-for-movement' takes coordinate values (both X
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
271 ;; and Y) that fall off the edge of the frame, and replaces them with
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
272 ;; values on the other side of the frame. It also has special
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
273 ;; minibuffer-handling code again, because we want to wrap through the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
274 ;; minibuffer if it's not enabled.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
275 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
276 ;; So, that's it. Seems to work. All of this work is done by the fun
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
277 ;; function `windmove-find-other-window'.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
278 ;;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
279 ;; So, now we have a window to move to (or nil if something's gone
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
280 ;; wrong). The function `windmove-do-window-select' is the main
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
281 ;; driver function: it actually does the `select-window'. It is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
282 ;; called by four little convenience wrappers, `windmove-left',
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
283 ;; `windmove-up', `windmove-right', and `windmove-down', which make
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
284 ;; for convenient keybinding.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
285
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
286
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
287 ;; Quick & dirty utility function to add two (x . y) coords.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
288 (defun windmove-coord-add (coord1 coord2)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
289 "Add the two coordinates.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
290 Both COORD1 and COORD2 are coordinate cons pairs, (HPOS . VPOS). The
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
291 result is another coordinate cons pair."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
292 (cons (+ (car coord1) (car coord2))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
293 (+ (cdr coord1) (cdr coord2))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
294
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
295
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
296 (defun windmove-constrain-to-range (n min-n max-n)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
297 "Ensure that N is between MIN-N and MAX-N inclusive by constraining.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
298 If N is less than MIN-N, return MIN-N; if greater than MAX-N, return
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
299 MAX-N."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
300 (max min-n (min n max-n)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
301
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
302 (defun windmove-constrain-around-range (n min-n max-n)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
303 "Ensure that N is between MIN-N and MAX-N inclusive by wrapping.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
304 If N is less than MIN-N, return MAX-N; if greater than MAX-N, return
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
305 MIN-N."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
306 (cond
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
307 ((< n min-n) max-n)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
308 ((> n max-n) min-n)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
309 (t n)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
310
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
311 (defun windmove-frame-edges (window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
312 "Return (X-MIN Y-MIN X-MAX Y-MAX) for the frame containing WINDOW.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
313 If WINDOW is nil, return the edges for the selected frame.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
314 (X-MIN, Y-MIN) is the zero-based coordinate of the top-left corner
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
315 of the frame; (X-MAX, Y-MAX) is the zero-based coordinate of the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
316 bottom-right corner of the frame.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
317 For example, if a frame has 76 rows and 181 columns, the return value
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
318 from `windmove-frame-edges' will be the list (0 0 180 75)."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
319 (let ((frame (if window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
320 (window-frame window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
321 (selected-frame))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
322 (let ((x-min 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
323 (y-min 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
324 (x-max (1- (frame-width frame))) ; 1- for last row & col here
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
325 (y-max (1- (frame-height frame))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
326 (list x-min y-min x-max y-max))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
327
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
328 ;; it turns out that constraining is always a good thing, even when
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
329 ;; wrapping is going to happen. this is because:
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
330 ;; first, since we disallow exotic diagonal-around-a-corner type
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
331 ;; movements, so we can always fix the unimportant direction (the one
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
332 ;; we're not moving in).
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
333 ;; second, if we're moving down and we're not in the minibuffer, then
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
334 ;; constraining the y coordinate to max-y is okay, because if that
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
335 ;; falls in the minibuffer and the minibuffer isn't active, that y
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
336 ;; coordinate will still be off the bottom of the frame as the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
337 ;; wrapping function sees it and so will get wrapped around anyway.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
338 (defun windmove-constrain-loc-for-movement (coord window dir)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
339 "Constrain COORD so that it is reasonable for the given movement.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
340 This involves two things: first, make sure that the \"off\" coordinate
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
341 -- the one not being moved on, e.g., y for horizontal movement -- is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
342 within frame boundaries; second, if the movement is down and we're not
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
343 moving from the minibuffer, make sure that the y coordinate does not
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
344 exceed the frame max-y, so that we don't overshoot the minibuffer
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
345 accidentally. WINDOW is the window that movement is relative to; DIR
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
346 is the direction of the movement, one of `left', `up', `right',
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
347 or `down'.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
348 Returns the constrained coordinate."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
349 (let ((frame-edges (windmove-frame-edges window))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
350 (in-minibuffer (window-minibuffer-p window)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
351 (let ((min-x (nth 0 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
352 (min-y (nth 1 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
353 (max-x (nth 2 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
354 (max-y (nth 3 frame-edges)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
355 (let ((new-x
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
356 (if (memq dir '(up down)) ; vertical movement
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
357 (windmove-constrain-to-range (car coord) min-x max-x)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
358 (car coord)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
359 (new-y
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
360 (if (or (memq dir '(left right)) ; horizontal movement
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
361 (and (eq dir 'down)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
362 (not in-minibuffer))) ; don't miss minibuffer
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
363 ;; (technically, we shouldn't constrain on min-y in the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
364 ;; second case, but this shouldn't do any harm on a
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
365 ;; down movement.)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
366 (windmove-constrain-to-range (cdr coord) min-y max-y)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
367 (cdr coord))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
368 (cons new-x new-y)))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
369
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
370 ;; having constrained in the limited sense of windmove-constrain-loc-
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
371 ;; for-movement, the wrapping code is actually much simpler than it
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
372 ;; otherwise would be. the only complication is that we need to check
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
373 ;; if the minibuffer is active, and, if not, pretend that it's not
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
374 ;; even part of the frame.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
375 (defun windmove-wrap-loc-for-movement (coord window dir)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
376 "Takes the constrained COORD and wraps it around for the movement.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
377 This makes an out-of-range x or y coordinate and wraps it around the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
378 frame, giving a coordinate (hopefully) in the window on the other edge
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
379 of the frame. WINDOW is the window that movement is relative to (nil
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
380 means the currently selected window); DIR is the direction of the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
381 movement, one of `left', `up', `right',or `down'.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
382 Returns the wrapped coordinate."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
383 (let* ((frame-edges (windmove-frame-edges window))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
384 (frame-minibuffer (minibuffer-window (if window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
385 (window-frame window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
386 (selected-frame))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
387 (minibuffer-active (minibuffer-window-active-p
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
388 frame-minibuffer)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
389 (let ((min-x (nth 0 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
390 (min-y (nth 1 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
391 (max-x (nth 2 frame-edges))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
392 (max-y (if (not minibuffer-active)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
393 (- (nth 3 frame-edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
394 (window-height frame-minibuffer))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
395 (nth 3 frame-edges))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
396 (cons
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
397 (windmove-constrain-around-range (car coord) min-x max-x)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
398 (windmove-constrain-around-range (cdr coord) min-y max-y)))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
399
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
400
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
401
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
402 ;; `windmove-coordinates-of-position' is stolen and modified from the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
403 ;; Emacs Lisp Reference Manual, section 27.2.5. It seems to work
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
404 ;; okay, although I am bothered by the fact that tab-offset (the cdr
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
405 ;; of the next-to- last argument) is set to 0. On the other hand, I
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
406 ;; can't find a single usage of `compute-motion' anywhere that doesn't
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
407 ;; set this component to zero, and I'm too lazy to grovel through the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
408 ;; C source to figure out what's happening in the background. there
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
409 ;; also seems to be a good deal of fun in calculating the correct
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
410 ;; width of lines for telling `compute-motion' about; in particular,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
411 ;; it seems we need to subtract 1 (for the continuation column) from
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
412 ;; the number that `window-width' gives, or continuation lines aren't
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
413 ;; counted correctly. I haven't seen anyone doing this before,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
414 ;; though.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
415 (defun windmove-coordinates-of-position (pos &optional window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
416 "Return the coordinates of position POS in window WINDOW.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
417 Return the window-based coodinates in a cons pair: (HPOS . VPOS),
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
418 where HPOS and VPOS are the zero-based x and y components of the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
419 screen location of POS. If WINDOW is nil, return the coordinates in
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
420 the currently selected window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
421 As an example, if point is in the top left corner of a window, then
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
422 the return value from `windmove-coordinates-of-position' is (0 . 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
423 regardless of the where point is in the buffer and where the window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
424 is placed in the frame."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
425 (let* ((wind (if (null window) (selected-window) window))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
426 (usable-width (1- (window-width wind))) ; 1- for cont. column
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
427 (usable-height (1- (window-height wind))) ; 1- for mode line
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
428 (big-hairy-result (compute-motion
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
429 (window-start)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
430 '(0 . 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
431 pos
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
432 (cons usable-width usable-height)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
433 usable-width
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
434 (cons (window-hscroll)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
435 0) ; why zero?
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
436 wind)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
437 (cons (nth 1 big-hairy-result) ; hpos, not vpos as documented
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
438 (nth 2 big-hairy-result)))) ; vpos, not hpos as documented
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
439
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
440 ;; This calculates the reference location in the current window: the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
441 ;; frame-based (x . y) of either point, the top-left, or the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
442 ;; bottom-right of the window, depending on ARG.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
443 (defun windmove-reference-loc (&optional arg window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
444 "Return the reference location for directional window selection.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
445 Return a coordinate (HPOS . VPOS) that is frame-based. If ARG is nil
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
446 or not supplied, the reference point is the buffer's point in the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
447 currently-selected window, or WINDOW if supplied; otherwise, it is the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
448 top-left or bottom-right corner of the selected window, or WINDOW if
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
449 supplied, if ARG is greater or smaller than zero, respectively."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
450 (let ((effective-arg (if (null arg) 0 (prefix-numeric-value arg)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
451 (edges (window-edges window)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
452 (let ((top-left (cons (nth 0 edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
453 (nth 1 edges)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
454 ;; if 1-'s are not there, windows actually extend too far.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
455 ;; actually, -2 is necessary for bottom: (nth 3 edges) is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
456 ;; the height of the window; -1 because we want 0-based max,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
457 ;; -1 to get rid of mode line
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
458 (bottom-right (cons (- (nth 2 edges) 1)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
459 (- (nth 3 edges) 2))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
460 (cond
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
461 ((> effective-arg 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
462 top-left)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
463 ((< effective-arg 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
464 bottom-right)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
465 ((= effective-arg 0)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
466 (windmove-coord-add
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
467 top-left
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
468 (windmove-coordinates-of-position (window-point window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
469 window)))))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
470
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
471 ;; This uses the reference location in the current window (calculated
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
472 ;; by `windmove-reference-loc' above) to find a reference location
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
473 ;; that will hopefully be in the window we want to move to.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
474 (defun windmove-other-window-loc (dir &optional arg window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
475 "Return a location in the window to be moved to.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
476 Return value is a frame-based (HPOS . VPOS) value that should be moved
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
477 to. DIR is one of `left', `up', `right', or `down'; an optional ARG
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
478 is handled as by `windmove-reference-loc'; WINDOW is the window that
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
479 movement is relative to."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
480 (let ((edges (window-edges window)) ; edges: (x0, y0, x1, y1)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
481 (refpoint (windmove-reference-loc arg window))) ; (x . y)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
482 (cond
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
483 ((eq dir 'left)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
484 (cons (- (nth 0 edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
485 windmove-window-distance-delta)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
486 (cdr refpoint))) ; (x0-d, y)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
487 ((eq dir 'up)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
488 (cons (car refpoint)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
489 (- (nth 1 edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
490 windmove-window-distance-delta))) ; (x, y0-d)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
491 ((eq dir 'right)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
492 (cons (+ (nth 2 edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
493 windmove-window-distance-delta)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
494 (cdr refpoint))) ; (x1+d, y)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
495 ((eq dir 'down)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
496 (cons (car refpoint)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
497 (+ (nth 3 edges)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
498 windmove-window-distance-delta))) ; (x, y1+d)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
499 (t (error "Invalid direction of movement: %s" dir)))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
500
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
501 (defun windmove-find-other-window (dir &optional arg window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
502 "Return the window object in direction DIR.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
503 DIR, ARG, and WINDOW are handled as by `windmove-other-window-loc'."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
504 (let* ((actual-current-window (or window (selected-window)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
505 (raw-other-window-loc
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
506 (windmove-other-window-loc dir arg actual-current-window))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
507 (constrained-other-window-loc
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
508 (windmove-constrain-loc-for-movement raw-other-window-loc
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
509 actual-current-window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
510 dir))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
511 (other-window-loc
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
512 (if windmove-wrap-around
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
513 (windmove-wrap-loc-for-movement constrained-other-window-loc
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
514 actual-current-window
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
515 dir)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
516 constrained-other-window-loc)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
517 (window-at (car other-window-loc)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
518 (cdr other-window-loc))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
519
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
520
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
521 ;; Selects the window that's hopefully at the location returned by
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
522 ;; `windmove-other-window-loc', or screams if there's no window there.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
523 (defun windmove-do-window-select (dir &optional arg window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
524 "Moves to the window at direction DIR.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
525 DIR, ARG, and WINDOW are handled as by `windmove-other-window-loc'.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
526 If no window is at direction DIR, an error is signaled."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
527 (let ((other-window (windmove-find-other-window dir arg window)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
528 (cond ((null other-window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
529 (error "No window at %s" dir))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
530 ((and (window-minibuffer-p other-window)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
531 (not (minibuffer-window-active-p other-window)))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
532 (error "Can't move to inactive minibuffer"))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
533 (t
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
534 (select-window other-window)))))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
535
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
536
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
537 ;;; end-user functions
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
538 ;; these are all simple interactive wrappers to `windmove-do-
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
539 ;; window-select', meant to be bound to keys.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
540
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
541 ;;;###autoload
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
542 (defun windmove-left (&optional arg)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
543 "Select the window to the left of the current one.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
544 With no prefix argument, or with prefix argument equal to zero,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
545 \"left\" is relative to the position of point in the window; otherwise
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
546 it is relative to the top edge (for positive ARG) or the bottom edge
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
547 (for negative ARG) of the current window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
548 If no window is at the desired location, an error is signaled."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
549 (interactive "P")
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
550 (windmove-do-window-select 'left arg))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
551
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
552 ;;;###autoload
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
553 (defun windmove-up (&optional arg)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
554 "Select the window above the current one.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
555 With no prefix argument, or with prefix argument equal to zero, \"up\"
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
556 is relative to the position of point in the window; otherwise it is
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
557 relative to the left edge (for positive ARG) or the right edge (for
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
558 negative ARG) of the current window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
559 If no window is at the desired location, an error is signaled."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
560 (interactive "P")
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
561 (windmove-do-window-select 'up arg))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
562
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
563 ;;;###autoload
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
564 (defun windmove-right (&optional arg)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
565 "Select the window to the right of the current one.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
566 With no prefix argument, or with prefix argument equal to zero,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
567 \"right\" is relative to the position of point in the window;
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
568 otherwise it is relative to the top edge (for positive ARG) or the
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
569 bottom edge (for negative ARG) of the current window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
570 If no window is at the desired location, an error is signaled."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
571 (interactive "P")
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
572 (windmove-do-window-select 'right arg))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
573
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
574 ;;;###autoload
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
575 (defun windmove-down (&optional arg)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
576 "Select the window below the current one.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
577 With no prefix argument, or with prefix argument equal to zero,
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
578 \"down\" is relative to the position of point in the window; otherwise
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
579 it is relative to the left edge (for positive ARG) or the right edge
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
580 (for negative ARG) of the current window.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
581 If no window is at the desired location, an error is signaled."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
582 (interactive "P")
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
583 (windmove-do-window-select 'down arg))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
584
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
585
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
586 ;;; set up keybindings
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
587 ;; Idea for this function is from iswitchb.el, by Stephen Eglen
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
588 ;; (stephen@cns.ed.ac.uk).
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
589 ;; I don't think these bindings will work on non-X terminals; you
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
590 ;; probably want to use different bindings in that case.
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
591
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
592 ;;;###autoload
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
593 (defun windmove-default-keybindings ()
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
594 "Set up default keybindings for `windmove'."
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
595 (interactive)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
596 (global-set-key [(shift left)] 'windmove-left)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
597 (global-set-key [(shift up)] 'windmove-up)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
598 (global-set-key [(shift right)] 'windmove-right)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
599 (global-set-key [(shift down)] 'windmove-down))
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
600
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
601
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
602 (provide 'windmove)
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
603
ea6b156518f2 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
604 ;;; windmove.el ends here