38412
|
1 ;;; vcursor.el --- manipulate an alternative ("virtual") cursor
|
17450
|
2
|
74442
|
3 ;; Copyright (C) 1994, 1996, 1998, 2001, 2002, 2003,
|
79721
|
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
|
17450
|
5
|
22650
|
6 ;; Author: Peter Stephenson <pws@ibmth.df.unipi.it>
|
30430
|
7 ;; Maintainer: FSF
|
22901
|
8 ;; Keywords: virtual cursor, convenience
|
17450
|
9
|
17902
|
10 ;; This file is part of GNU Emacs.
|
|
11
|
|
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
17450
|
13 ;; it under the terms of the GNU General Public License as published by
|
78236
|
14 ;; the Free Software Foundation; either version 3, or (at your option)
|
17902
|
15 ;; any later version.
|
17450
|
16
|
17902
|
17 ;; GNU Emacs is distributed in the hope that it will be useful,
|
17450
|
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
20 ;; GNU General Public License for more details.
|
|
21
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
64091
|
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
25 ;; Boston, MA 02110-1301, USA.
|
17450
|
26
|
|
27 ;;; Commentary:
|
|
28
|
22650
|
29 ;; Latest changes
|
|
30 ;; ==============
|
21061
|
31 ;;
|
22650
|
32 ;; - *IMPORTANT* vcursor-key-bindings is now nil by default, to avoid
|
|
33 ;; side-effects when the package is loaded. This means no keys are
|
|
34 ;; bound by default. Use customize to change it to t to restore
|
|
35 ;; the old behaviour. (If you do it by hand in .emacs, it
|
|
36 ;; must come before vcursor is loaded.)
|
|
37 ;; - You can alter the main variables and the vcursor face via
|
|
38 ;; M-x customize: go to the Editing group and find Vcursor.
|
|
39 ;; - vcursor-auto-disable can now be 'copy (actually any value not nil
|
|
40 ;; or t), which means that copying from the vcursor will be turned
|
|
41 ;; off after any operation not involving the vcursor, but the
|
|
42 ;; vcursor itself will be left alone.
|
21061
|
43 ;; - works on dumb terminals with Emacs 19.29 and later
|
|
44 ;; - new keymap vcursor-map for binding to a prefix key
|
|
45 ;; - vcursor-compare-windows substantially improved
|
|
46 ;; - vcursor-execute-{key,command} much better about using the
|
|
47 ;; right keymaps and arranging for the correct windows to be used
|
|
48 ;; - vcursor-window-funcall can call functions interactively
|
|
49 ;; - vcursor-interpret-input for special effects
|
|
50 ;;
|
|
51 ;; Introduction
|
|
52 ;; ============
|
|
53 ;;
|
17450
|
54 ;; Virtual cursor commands. I got this idea from the old BBC micro.
|
21061
|
55 ;; You need Emacs 19 or 20 and a window system for the best effects.
|
|
56 ;; For character terminals, at least Emacs 19.29 is required
|
|
57 ;; (special behaviour for the overlay property
|
|
58 ;; "before-string" must be implemented). Search for "dumb terminals"
|
|
59 ;; for more information.
|
17450
|
60 ;;
|
|
61 ;; This is much easier to use than the instructions are to read.
|
22650
|
62 ;; First, you need to let vcursor define some keys: setting
|
|
63 ;; vcursor-key-bindings to t before loading, or by customize, will
|
|
64 ;; define various keys with the prefix C-S. You'll have to read
|
|
65 ;; further if you don't want this. Then I suggest you simply load it
|
|
66 ;; and play around with holding down Ctrl and Shift and pressing up,
|
|
67 ;; down, left, right, tab, return, and see what happens. (Find a
|
|
68 ;; scratch buffer before using C-S-tab: that toggles copying.)
|
17450
|
69 ;;
|
|
70 ;; Most of the functions described in this documentation are in
|
|
71 ;; parentheses so that if you have the package loaded you can type C-h
|
|
72 ;; f on top of them for help.
|
|
73 ;;
|
|
74 ;; Using the cursor keys with both control and shift held down moves
|
|
75 ;; around a virtual cursor, which is initially at point. When active,
|
|
76 ;; it appears with an underline through it to distinguish it from the
|
|
77 ;; normal cursor. You can then use one of the other commands to copy
|
|
78 ;; characters from the location of the virtual cursor to point. This
|
|
79 ;; is very useful, for example, when copying some previous text while
|
|
80 ;; making changes to it at the same time, since you never have to move
|
|
81 ;; the "real" cursor away from where you are inserting.
|
|
82 ;;
|
|
83 ;; The remaining default key bindings are based around the PC-type
|
|
84 ;; cluster found above the cursor keys on a lot of keyboards, the
|
|
85 ;; function keys which my limited knowledge of X terminals expects to
|
|
86 ;; find at the top. Some functions are duplicated in more obvious
|
|
87 ;; places for the X version.
|
|
88 ;;
|
|
89 ;; All the keybindings require you to hold down control and shift at
|
|
90 ;; once. I assumed this combination wouldn't be heavily bound by most
|
|
91 ;; people and that it would be easy to type with the left hand.
|
|
92 ;; Inevitably it will clash with some other packages, but I can't help
|
|
93 ;; that: an intuitive binding is a prerequisite here. See below for
|
21061
|
94 ;; other alternatives (search for "Oemacs"). There is also a keymap
|
|
95 ;; which you can bind to a prefix key, which may give some more
|
|
96 ;; intuitive alternatives in some cases, see `The vcursor keymap' below.
|
47941
|
97 ;;
|
17450
|
98 ;; Holding down control and shift and pressing insert (vcursor-copy)
|
|
99 ;; copies one character from wherever the virtual cursor is to point;
|
|
100 ;; point and the virtual cursor advance in the separate and equal
|
|
101 ;; station to which... (etc.). M-C-S-return (vcursor-copy-line)
|
|
102 ;; copies to the end of the line instead of just one character,
|
|
103 ;; C-S-delete or C-S-remove (vcursor-copy-word) copies a word.
|
47941
|
104 ;;
|
17450
|
105 ;; A more general way of copying is to use C-S-tab, which is a toggle.
|
|
106 ;; In the "on" state, moving the virtual cursor will copy the
|
|
107 ;; moved-over text to the normal cursor position (including when going
|
|
108 ;; backwards, though each piece of text moved over is copied forwards:
|
|
109 ;; compare the behaviour of C-S-up and C-S-left).
|
|
110 ;;
|
|
111 ;; However, that's just a small part of the magic. If the virtual
|
|
112 ;; cursor goes off the display, it will be redisplayed in some other
|
|
113 ;; window. (See the function (vcursor-find-window) for details of how
|
|
114 ;; this window is chosen.) This gives you fingertip control over two
|
|
115 ;; windows at once.
|
47941
|
116 ;;
|
17450
|
117 ;; C-S-return (vcursor-disable) disables the virtual cursor, removing
|
|
118 ;; it so that it starts from point whenever you move it again --- note
|
|
119 ;; that simply moving the cursor and virtual cursor on top of one
|
|
120 ;; another does not have this effect.
|
47941
|
121 ;;
|
21061
|
122 ;; If you give C-S-return a positive prefix arg, it will also delete the
|
17450
|
123 ;; window (unless it's the current one). Whenever the virtual cursor
|
|
124 ;; goes off-screen in its own window, point in that window is moved as
|
|
125 ;; well to restore it to view. (It's easier that way, that's why.
|
|
126 ;; However, point doesn't move unless the view in the window does, so
|
|
127 ;; it's not tied to the virtual cursor location.)
|
|
128 ;;
|
|
129 ;; You can also use C-S-return with a negative prefix argument which
|
|
130 ;; forces the vcursor to appear at point. This is particularly useful if
|
|
131 ;; you actually want to edit in another window but would like to
|
|
132 ;; remember the current cursor location for examining or copying from
|
|
133 ;; that buffer. (I just hit C-S-right C-S-left, but I'm a hopeless
|
|
134 ;; lowbrow.)
|
47941
|
135 ;;
|
17450
|
136 ;; There is also C-S-f6 (vcursor-other-window) which behaves like
|
|
137 ;; C-x o on the virtual rather than the real cursor, except that it
|
|
138 ;; will create another window if necessary.
|
|
139 ;;
|
|
140 ;; The keys C-S-prior (vcursor-scroll-down) and C-S-next
|
|
141 ;; (vcursor-scroll-up) (i.e., PageUp and PageDown) will scroll the
|
|
142 ;; virtual cursor window, appropriately chosen. They will always
|
|
143 ;; create a new window or take over an old one if necessary.
|
|
144 ;; Likewise, M-C-S-left and M-C-S-right move you to the
|
|
145 ;; beginning or end of a line, C-S-home and C-S-end the
|
|
146 ;; beginning or end of a buffer (these are also on M-C-S-up and
|
|
147 ;; M-C-S-down for those of us stuck with DEC keyboards).
|
|
148 ;;
|
|
149 ;; C-S-f7 (vcursor-goto) will take you to the vcursor position
|
|
150 ;; (swapping windows if it seems sensible) and (unless you give it a
|
|
151 ;; prefix argument) delete the virtual cursor, so this is useful for
|
|
152 ;; you to take over editing at the virtual cursor position. It is not
|
|
153 ;; an error if the virtual cursor is not active; it simply leaves you
|
|
154 ;; at point, because that is where the virtual cursor would start
|
|
155 ;; from.
|
|
156 ;;
|
|
157 ;; In a similar vein, M-C-S-tab (hope your left hand's flexible;
|
|
158 ;; C-S-select on DEC keyboards) (vcursor-swap-point) will take you to
|
|
159 ;; the virtual cursor position but simultaneously put the virtual
|
|
160 ;; cursor at the old cursor position. It is also supposed to ensure
|
|
161 ;; that both are visible.
|
|
162 ;;
|
|
163 ;; C-S-f8 (C-S-find on DEC keyboards) (vcursor-isearch-forward)
|
|
164 ;; allows you to do an isearch in another window. It works a bit like
|
|
165 ;; vcursor-scroll-*; it moves into another window, calls isearch
|
|
166 ;; there, and sets the virtual cursor position to the point found. In
|
|
167 ;; other words, it works just like isearch but with the virtual cursor
|
|
168 ;; instead of the real one (that's why it's called a "virtual
|
|
169 ;; cursor"). While you are isearching, you are editing in the virtual
|
|
170 ;; cursor window, but when you have finished you return to where you
|
|
171 ;; started. Note that once you are in isearch all the keys are normal
|
|
172 ;; --- use C-s, not C-S-f8, to search for the next occurrence.
|
|
173 ;;
|
|
174 ;; If you set the variable vcursor-auto-disable, then any command
|
|
175 ;; which does not involve moving or copying from the virtual cursor
|
22650
|
176 ;; causes the virtual cursor to be disabled. If you set it to non-nil
|
|
177 ;; but not t, then the vcursor itself will remain active, but copying
|
|
178 ;; will be turned off, so that the next time the vcursor is moved no
|
|
179 ;; text is copied over. Experience shows that this setting is
|
|
180 ;; particularly useful. If you don't intend to use this, you can
|
|
181 ;; comment out the `add-hook' line at the bottom of this file. (This
|
|
182 ;; feature partially emulates the way the "copy" key on the BBC micro
|
|
183 ;; worked; actually, the copy cursor was homed when you hit return.
|
|
184 ;; This was in keeping with the line-by-line way of entering BASIC,
|
|
185 ;; but is less appropriate here.)
|
17450
|
186 ;;
|
21061
|
187 ;; vcursor-compare-windows is now a reliable adaption of
|
|
188 ;; compare-windows, which compares between point in the current buffer
|
|
189 ;; and the vcursor location in the other one. It is an error if
|
|
190 ;; vcursor is not set, however it will be brought up in another window
|
|
191 ;; if it is not currently visible. The prefix argument acts just like
|
|
192 ;; compare-windows, ignoring whitespace if set. (In versions before
|
|
193 ;; 1.6, this simply called compare-windows, which was much less likely
|
|
194 ;; to pick the two windows you wanted.)
|
|
195 ;;
|
17450
|
196 ;; There is a way of moving the virtual cursor using ordinary
|
|
197 ;; commands: C-S-f9 (vcursor-execute-key) reads a key string,
|
|
198 ;; moves to the virtual cursor position, executes the command bound to
|
|
199 ;; the string, then returns to the original point. Thus C-S-f9 M-m
|
|
200 ;; moves the virtual cursor back to the first non-whitespace character
|
|
201 ;; on its line. As the command is called interactively all the usual
|
|
202 ;; ways of passing information to the command called, such as by a
|
21061
|
203 ;; prefix argument, are available. This has many uses not necessarily
|
|
204 ;; related to moving the vcursor itself; it can do essentially
|
|
205 ;; everything that the \C-x 4 series of commands can do and a lot
|
|
206 ;; more. Note, however, that a new window is not used if the vcursor
|
|
207 ;; is visible in the current one: this can lead to some strange effects,
|
|
208 ;; but it is preferable to making a new window every time the vcursor
|
|
209 ;; is moved in this may.
|
|
210 ;;
|
|
211 ;; C-S-f10 (C-S-x) (vcursor-execute-command) behaves the same way but
|
|
212 ;; you enter the name of the command. To do anything really
|
17450
|
213 ;; complicated, you are better off using M-C-S-tab
|
|
214 ;; (vcursor-swap-point), doing whatever it is, then calling M-C-S-tab
|
|
215 ;; again.
|
|
216 ;;
|
|
217 ;; If you want to add your own moving or copying functions you should
|
|
218 ;; be able to do this fairly easily with (vcursor-relative-move) and
|
|
219 ;; (vcursor-copy) together with (vcursor-get-char-count). If you want to
|
|
220 ;; do something in a different window, use (vcursor-window-funcall).
|
|
221 ;;
|
21061
|
222 ;; Key bindings
|
|
223 ;; ============
|
47941
|
224 ;;
|
17450
|
225 ;; There is an alternative set of key bindings which will be used
|
|
226 ;; automatically for a PC if Oemacs is detected. This set uses separate
|
|
227 ;; control, shift and meta keys with function keys 1 to 10. In
|
|
228 ;; particular, movement keys are concentrated on f5 to f8 with (in
|
|
229 ;; increasing order of distance travelled) C-, M- and S- as prefixes.
|
|
230 ;; See the actual bindings below (search for C-f1). This is because the
|
|
231 ;; C-S- prefix is represented by weird key sequences and the set is
|
|
232 ;; incomplete; if you don't mind that, some hints are given in comments
|
|
233 ;; below.
|
|
234 ;;
|
|
235 ;; You can specify the usual or the Oemacs bindings by setting the
|
|
236 ;; variable vcursor-key-bindings to `xterm' or `oemacs'. You can also set
|
|
237 ;; it to nil, in which case vcursor will not make any key bindings
|
|
238 ;; and you can define your own. The default is t, which makes vcursor
|
|
239 ;; guess (it will use xterm unless it thinks Oemacs is running). The
|
|
240 ;; oemacs set will work on an X terminal with function keys, but the
|
|
241 ;; xterm set will not work under Oemacs.
|
|
242 ;;
|
21061
|
243 ;; Usage on dumb terminals
|
|
244 ;; =======================
|
|
245 ;;
|
|
246 ;; If Emacs has set the variable window-system to nil, vcursor will
|
|
247 ;; assume that overlays cannot be displayed in a different face,
|
47941
|
248 ;; and will instead use a string (the variable vcursor-string, by
|
21061
|
249 ;; default "**>") to show its position. This was first implemented
|
|
250 ;; in Emacs 19.29. Unlike the old-fashioned overlay arrow (as used
|
|
251 ;; by debuggers), this appears between existing text, which can
|
|
252 ;; make it hard to read if you're not used to it. (This seemed the
|
|
253 ;; better option here.) This means moving the vcursor up and down is
|
|
254 ;; a very efficient way of locating it!
|
|
255 ;;
|
|
256 ;; Everything else should function as expected, but there is no way to
|
|
257 ;; get an easy key binding for the vcursor keys on a generic terminal.
|
|
258 ;; Consequently a special keymap is defined for you to use traditional
|
|
259 ;; methods: the keymap, however, is available on any terminal type.
|
47941
|
260 ;;
|
21061
|
261 ;; The vcursor keymap
|
|
262 ;; ==================
|
|
263 ;;
|
|
264 ;; In addition to any other bindings, vcursor-map contains key definitions
|
|
265 ;; for handling the vcursor. You should assign this to a prefix key
|
|
266 ;; in the usual way, e.g.
|
|
267 ;; (global-set-key [f14] vcursor-map)
|
|
268 ;; and also as usual \C-h in this map will list the key definitions, which
|
|
269 ;; are designed to be easy to remember.
|
|
270 ;;
|
84429
|
271 ;; A special feature is provided by (vcursor-use-vcursor-map), bound
|
21061
|
272 ;; to t in that keymap. With this in effect, the main keymap
|
|
273 ;; is overridden by the vcursor map, so keys like \C-p and so on
|
|
274 ;; move the vcursor instead. Remember how to turn it off (type t),
|
|
275 ;; or you are in serious trouble! Note that the cursor keys are not
|
|
276 ;; bound by default in this keymap and will continue to move the
|
|
277 ;; ordinary cursor.
|
|
278 ;;
|
|
279 ;; Interpreted input
|
|
280 ;; =================
|
|
281 ;;
|
|
282 ;; Just occasionally, you may want to pretend the strings copied from
|
|
283 ;; the vcursor position are to be interpreted as if you had typed them
|
|
284 ;; from the keyboard. Normally, they will just insert themselves anyway,
|
|
285 ;; but in some modes (Info and calc for example) typing ordinary characters
|
|
286 ;; does something else. To get this effect, set
|
|
287 ;; vcursor-interpret-input to t. This is normally not a good idea as
|
|
288 ;; interpreting input is very much slower than copying text.
|
47941
|
289 ;;
|
21061
|
290 ;; Un-features
|
|
291 ;; ===========
|
|
292 ;;
|
17450
|
293 ;; - The vcursor will not move to point-max, since otherwise it would
|
|
294 ;; disappear. However, no error is flagged as point-max is a valid
|
|
295 ;; point in the buffer. Thus cursor right or down at the second
|
|
296 ;; last point in the file does not flag an error, which is inconsistent,
|
|
297 ;; and if copying is on the last character (typically newline) will
|
|
298 ;; be repeatedly copied. (I've tried making it flag an error
|
|
299 ;; instead and that's worse since often the vcursor is sent to
|
|
300 ;; point in some other window, which may be point-max.)
|
|
301 ;; - The vcursor widens when over a tab character or right at the
|
|
302 ;; end of the line. You're welcome to consider this a feature;
|
|
303 ;; it's just a part of how overlays work.
|
|
304 ;; - The vcursor obscures the real cursor. Creative use of overlays
|
|
305 ;; could cure this.
|
|
306 ;; - The vcursor does not remember its own previous positions. If
|
|
307 ;; you cycle it back into a window it was in before, it will be at
|
|
308 ;; point in that window. Often, that is where a previous recenter
|
|
309 ;; left point, not where the vcursor was before.
|
|
310 ;; (Note, however, that the vcursor does remember where it *is*,
|
|
311 ;; even if it's off-screen. This can also lead to surprises, but I
|
|
312 ;; don't think it's a bug.)
|
|
313 ;; - vcursor-window-funcall could perhaps be smarter about restoring
|
|
314 ;; the previous window state on failure.
|
|
315 ;; - The logic in vcursor-find-window is rather complicated and
|
|
316 ;; therefore bug-prone, though in practice it seems to work OK.
|
|
317 ;;
|
54104
|
318 ;; Possible enhancements:
|
17450
|
319 ;; It would be easy to implement vcursor-push (save vcursor position
|
|
320 ;; as mark and deactivate) and vcursor-pop (deactivate vcursor and
|
|
321 ;; move to last pushed position) functions.
|
|
322
|
|
323 ;;; Code:
|
|
324
|
28459
|
325 (eval-when-compile (require 'compare-w))
|
|
326
|
21088
|
327 (defgroup vcursor nil
|
|
328 "Manipulate an alternative (\"virtual\") cursor."
|
|
329 :prefix "vcursor-"
|
22901
|
330 :group 'editing)
|
21088
|
331
|
22650
|
332 (defface vcursor
|
|
333 '((((class color)) (:foreground "blue" :background "cyan" :underline t))
|
|
334 (t (:inverse-video t :underline t)))
|
|
335 "Face for the virtual cursor."
|
|
336 :group 'vcursor)
|
17450
|
337
|
21088
|
338 (defcustom vcursor-auto-disable nil
|
84429
|
339 "If non-nil, disable the virtual cursor after use.
|
22650
|
340 Any non-vcursor command will force `vcursor-disable' to be called.
|
|
341 If non-nil but not t, just make sure copying is toggled off, but don't
|
|
342 disable the vcursor."
|
|
343 :type '(choice (const t) (const nil) (const copy))
|
21088
|
344 :group 'vcursor)
|
17450
|
345
|
54104
|
346 (defcustom vcursor-modifiers (list 'control 'shift)
|
84429
|
347 "A list of modifiers that are used to define vcursor key bindings."
|
54104
|
348 :type '(repeat symbol)
|
|
349 :group 'vcursor)
|
|
350
|
22650
|
351 ;; Needed for defcustom, must be up here
|
32291
|
352 (defun vcursor-cs-binding (base &optional meta)
|
54104
|
353 (vector (let ((key (append vcursor-modifiers (list (intern base)))))
|
32291
|
354 (if meta
|
|
355 (cons 'meta key)
|
|
356 key))))
|
22650
|
357
|
|
358 (defun vcursor-bind-keys (var value)
|
|
359 "Alter the value of the variable VAR to VALUE, binding keys as required.
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
360 VAR is usually `vcursor-key-bindings'. Normally this function is called
|
22650
|
361 on loading vcursor and from the customize package."
|
|
362 (set var value)
|
|
363 (cond
|
|
364 ((not value));; don't set any key bindings
|
|
365 ((or (eq value 'oemacs)
|
|
366 (and (eq value t) (fboundp 'oemacs-version)))
|
|
367 (global-set-key [C-f1] 'vcursor-toggle-copy)
|
|
368 (global-set-key [C-f2] 'vcursor-copy)
|
|
369 (global-set-key [C-f3] 'vcursor-copy-word)
|
|
370 (global-set-key [C-f4] 'vcursor-copy-line)
|
|
371
|
|
372 (global-set-key [S-f1] 'vcursor-disable)
|
|
373 (global-set-key [S-f2] 'vcursor-other-window)
|
|
374 (global-set-key [S-f3] 'vcursor-goto)
|
|
375 (global-set-key [S-f4] 'vcursor-swap-point)
|
|
376
|
|
377 (global-set-key [C-f5] 'vcursor-backward-char)
|
|
378 (global-set-key [C-f6] 'vcursor-previous-line)
|
|
379 (global-set-key [C-f7] 'vcursor-next-line)
|
|
380 (global-set-key [C-f8] 'vcursor-forward-char)
|
|
381
|
|
382 (global-set-key [M-f5] 'vcursor-beginning-of-line)
|
|
383 (global-set-key [M-f6] 'vcursor-backward-word)
|
|
384 (global-set-key [M-f6] 'vcursor-forward-word)
|
|
385 (global-set-key [M-f8] 'vcursor-end-of-line)
|
|
386
|
|
387 (global-set-key [S-f5] 'vcursor-beginning-of-buffer)
|
|
388 (global-set-key [S-f6] 'vcursor-scroll-down)
|
|
389 (global-set-key [S-f7] 'vcursor-scroll-up)
|
|
390 (global-set-key [S-f8] 'vcursor-end-of-buffer)
|
|
391
|
|
392 (global-set-key [C-f9] 'vcursor-isearch-forward)
|
|
393
|
|
394 (global-set-key [S-f9] 'vcursor-execute-key)
|
|
395 (global-set-key [S-f10] 'vcursor-execute-command)
|
|
396
|
|
397 ;;; Partial dictionary of Oemacs key sequences for you to roll your own,
|
|
398 ;;; e.g C-S-up: (global-set-key "\M-[\C-f\M-\C-m" 'vcursor-previous-line)
|
|
399 ;;; Sequence: Sends:
|
|
400 ;;; "\M-[\C-f\M-\C-m" C-S-up
|
|
401 ;;; "\M-[\C-f\M-\C-q" C-S-down
|
|
402 ;;; "\M-[\C-fs" C-S-left
|
|
403 ;;; "\M-[\C-ft" C-S-right
|
|
404 ;;;
|
|
405 ;;; "\M-[\C-fw" C-S-home
|
|
406 ;;; "\M-[\C-b\C-o" S-tab
|
|
407 ;;; "\M-[\C-f\M-\C-r" C-S-insert
|
|
408 ;;; "\M-[\C-fu" C-S-end
|
|
409 ;;; "\M-[\C-f\M-\C-s" C-S-delete
|
|
410 ;;; "\M-[\C-f\M-\C-d" C-S-prior
|
|
411 ;;; "\M-[\C-fv" C-S-next
|
47941
|
412 ;;;
|
22650
|
413 ;;; "\M-[\C-f^" C-S-f1
|
|
414 ;;; "\M-[\C-f_" C-S-f2
|
|
415 ;;; "\M-[\C-f`" C-S-f3
|
|
416 ;;; "\M-[\C-fa" C-S-f4
|
|
417 ;;; "\M-[\C-fb" C-S-f5
|
|
418 ;;; "\M-[\C-fc" C-S-f6
|
|
419 ;;; "\M-[\C-fd" C-S-f7
|
|
420 ;;; "\M-[\C-fe" C-S-f8
|
|
421 ;;; "\M-[\C-ff" C-S-f9
|
|
422 ;;; "\M-[\C-fg" C-S-f10
|
|
423 )
|
|
424 (t
|
|
425 (global-set-key (vcursor-cs-binding "up") 'vcursor-previous-line)
|
|
426 (global-set-key (vcursor-cs-binding "down") 'vcursor-next-line)
|
|
427 (global-set-key (vcursor-cs-binding "left") 'vcursor-backward-char)
|
|
428 (global-set-key (vcursor-cs-binding "right") 'vcursor-forward-char)
|
47941
|
429
|
22650
|
430 (global-set-key (vcursor-cs-binding "return") 'vcursor-disable)
|
|
431 (global-set-key (vcursor-cs-binding "insert") 'vcursor-copy)
|
|
432 (global-set-key (vcursor-cs-binding "delete") 'vcursor-copy-word)
|
|
433 (global-set-key (vcursor-cs-binding "remove") 'vcursor-copy-word)
|
|
434 (global-set-key (vcursor-cs-binding "tab") 'vcursor-toggle-copy)
|
|
435 (global-set-key (vcursor-cs-binding "backtab") 'vcursor-toggle-copy)
|
|
436 (global-set-key (vcursor-cs-binding "home") 'vcursor-beginning-of-buffer)
|
|
437 (global-set-key (vcursor-cs-binding "up" t) 'vcursor-beginning-of-buffer)
|
|
438 (global-set-key (vcursor-cs-binding "end") 'vcursor-end-of-buffer)
|
|
439 (global-set-key (vcursor-cs-binding "down" t) 'vcursor-end-of-buffer)
|
|
440 (global-set-key (vcursor-cs-binding "prior") 'vcursor-scroll-down)
|
|
441 (global-set-key (vcursor-cs-binding "next") 'vcursor-scroll-up)
|
47941
|
442
|
22650
|
443 (global-set-key (vcursor-cs-binding "f6") 'vcursor-other-window)
|
|
444 (global-set-key (vcursor-cs-binding "f7") 'vcursor-goto)
|
|
445
|
47941
|
446 (global-set-key (vcursor-cs-binding "select")
|
22650
|
447 'vcursor-swap-point) ; DEC keyboards
|
|
448 (global-set-key (vcursor-cs-binding "tab" t) 'vcursor-swap-point)
|
|
449
|
47941
|
450 (global-set-key (vcursor-cs-binding "find")
|
22650
|
451 'vcursor-isearch-forward) ; DEC keyboards
|
|
452 (global-set-key (vcursor-cs-binding "f8") 'vcursor-isearch-forward)
|
|
453
|
|
454 (global-set-key (vcursor-cs-binding "left" t) 'vcursor-beginning-of-line)
|
|
455 (global-set-key (vcursor-cs-binding "right" t) 'vcursor-end-of-line)
|
|
456
|
|
457 (global-set-key (vcursor-cs-binding "prior" t) 'vcursor-backward-word)
|
|
458 (global-set-key (vcursor-cs-binding "next" t) 'vcursor-forward-word)
|
|
459
|
|
460 (global-set-key (vcursor-cs-binding "return" t) 'vcursor-copy-line)
|
|
461
|
|
462 (global-set-key (vcursor-cs-binding "f9") 'vcursor-execute-key)
|
|
463 (global-set-key (vcursor-cs-binding "f10") 'vcursor-execute-command)
|
|
464 )))
|
|
465
|
|
466 (defcustom vcursor-key-bindings nil
|
84429
|
467 "How to bind keys when vcursor is loaded.
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
468 If t, guess; if `xterm', use bindings suitable for an X terminal; if
|
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
469 `oemacs', use bindings which work on a PC with Oemacs. If nil, don't
|
22650
|
470 define any key bindings.
|
|
471
|
|
472 Default is nil."
|
|
473 :type '(choice (const t) (const nil) (const xterm) (const oemacs))
|
|
474 :group 'vcursor
|
|
475 :set 'vcursor-bind-keys
|
|
476 :version "20.3")
|
17450
|
477
|
21088
|
478 (defcustom vcursor-interpret-input nil
|
84429
|
479 "If non-nil, input from the vcursor is treated as interactive input.
|
21061
|
480 This will cause text insertion to be much slower. Note that no special
|
|
481 interpretation of strings is done: \"\C-x\" is a string of four
|
21088
|
482 characters. The default is simply to copy strings."
|
|
483 :type 'boolean
|
21669
|
484 :group 'vcursor
|
|
485 :version "20.3")
|
21061
|
486
|
21088
|
487 (defcustom vcursor-string "**>"
|
|
488 "String used to show the vcursor position on dumb terminals."
|
|
489 :type 'string
|
21669
|
490 :group 'vcursor
|
|
491 :version "20.3")
|
21061
|
492
|
47941
|
493 (defvar vcursor-overlay nil
|
17450
|
494 "Overlay for the virtual cursor.
|
|
495 It is nil if that is not enabled.")
|
|
496
|
|
497 (defvar vcursor-window nil
|
|
498 "Last window to have displayed the virtual cursor.
|
|
499 See the function `vcursor-find-window' for how this is used.")
|
|
500
|
|
501 (defvar vcursor-last-command nil
|
|
502 "Non-nil if last command was a vcursor command.
|
|
503 The commands `vcursor-copy', `vcursor-relative-move' and the ones for
|
|
504 scrolling set this. It is used by the `vcursor-auto-disable' code.")
|
|
505 ;; could do some memq-ing with last-command instead, but this will
|
|
506 ;; automatically handle any new commands using the primitives.
|
|
507
|
47941
|
508 (defcustom vcursor-copy-flag nil
|
84429
|
509 "Non-nil means moving vcursor should copy characters moved over to point."
|
21088
|
510 :type 'boolean
|
|
511 :group 'vcursor)
|
17450
|
512
|
|
513 (defvar vcursor-temp-goal-column nil
|
|
514 "Keeps track of temporary goal columns for the virtual cursor.")
|
|
515
|
84429
|
516 (defvar vcursor-map
|
|
517 (let ((map (make-sparse-keymap)))
|
|
518 (define-key map "t" 'vcursor-use-vcursor-map)
|
21061
|
519
|
84429
|
520 (define-key map "\C-p" 'vcursor-previous-line)
|
|
521 (define-key map "\C-n" 'vcursor-next-line)
|
|
522 (define-key map "\C-b" 'vcursor-backward-char)
|
|
523 (define-key map "\C-f" 'vcursor-forward-char)
|
21061
|
524
|
84429
|
525 (define-key map "\r" 'vcursor-disable)
|
|
526 (define-key map " " 'vcursor-copy)
|
|
527 (define-key map "\C-y" 'vcursor-copy-word)
|
|
528 (define-key map "\C-i" 'vcursor-toggle-copy)
|
|
529 (define-key map "<" 'vcursor-beginning-of-buffer)
|
|
530 (define-key map ">" 'vcursor-end-of-buffer)
|
|
531 (define-key map "\M-v" 'vcursor-scroll-down)
|
|
532 (define-key map "\C-v" 'vcursor-scroll-up)
|
|
533 (define-key map "o" 'vcursor-other-window)
|
|
534 (define-key map "g" 'vcursor-goto)
|
|
535 (define-key map "x" 'vcursor-swap-point)
|
|
536 (define-key map "\C-s" 'vcursor-isearch-forward)
|
|
537 (define-key map "\C-r" 'vcursor-isearch-backward)
|
|
538 (define-key map "\C-a" 'vcursor-beginning-of-line)
|
|
539 (define-key map "\C-e" 'vcursor-end-of-line)
|
|
540 (define-key map "\M-w" 'vcursor-forward-word)
|
|
541 (define-key map "\M-b" 'vcursor-backward-word)
|
|
542 (define-key map "\M-l" 'vcursor-copy-line)
|
|
543 (define-key map "c" 'vcursor-compare-windows)
|
|
544 (define-key map "k" 'vcursor-execute-key)
|
|
545 (define-key map "\M-x" 'vcursor-execute-command)
|
|
546 map)
|
|
547 "Keymap for vcursor command.")
|
|
548 ;; This seems unused, but it was done as part of define-prefix-command,
|
|
549 ;; so let's keep it for now.
|
|
550 (fset 'vcursor-map vcursor-map)
|
21061
|
551
|
22650
|
552 ;; If vcursor-key-bindings is already set on loading, bind the keys now.
|
|
553 ;; This hybrid way of doing it retains compatibility while allowing
|
|
554 ;; customize to work smoothly.
|
47941
|
555 (if vcursor-key-bindings
|
22650
|
556 (vcursor-bind-keys 'vcursor-key-bindings vcursor-key-bindings))
|
17450
|
557
|
|
558 (defun vcursor-locate ()
|
|
559 "Go to the starting point of the virtual cursor.
|
|
560 If that's disabled, don't go anywhere but don't complain."
|
|
561 ;; This is where we go off-mass-shell. Assume there is a
|
|
562 ;; save-excursion to get us back to the pole, er, point.
|
|
563
|
|
564 (and (overlayp vcursor-overlay)
|
|
565 (overlay-buffer vcursor-overlay)
|
|
566 (set-buffer (overlay-buffer vcursor-overlay))
|
|
567 (goto-char (overlay-start vcursor-overlay)))
|
|
568 )
|
|
569
|
|
570 (defun vcursor-find-window (&optional not-this new-win this-frame)
|
|
571 "Return a suitable window for displaying the virtual cursor.
|
|
572 This is the first window in cyclic order where the vcursor is visible.
|
|
573
|
|
574 With optional NOT-THIS non-nil never return the current window.
|
|
575
|
|
576 With NEW-WIN non-nil, display the virtual cursor buffer in another
|
|
577 window if the virtual cursor is not currently visible \(note, however,
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
578 that this function never changes `window-point'\).
|
17450
|
579
|
|
580 With THIS-FRAME non-nil, don't search other frames for a new window
|
|
581 \(though if the vcursor is already off-frame then its current window is
|
|
582 always considered, and the value of `pop-up-frames' is always respected\).
|
|
583
|
|
584 Returns nil if the virtual cursor is not visible anywhere suitable.
|
|
585 Set `vcursor-window' to the returned value as a side effect."
|
|
586
|
|
587 ;; The order of priorities (respecting NOT-THIS) is (1)
|
|
588 ;; vcursor-window if the virtual cursor is visible there (2) any
|
|
589 ;; window displaying the virtual cursor (3) vcursor-window provided
|
|
590 ;; it is still displaying the buffer containing the virtual cursor and
|
|
591 ;; is not selected (4) any unselected window displaying the vcursor
|
|
592 ;; buffer (5) with NEW-WIN, a window selected by display-buffer (so
|
|
593 ;; the variables pop-up-windows and pop-up-frames are significant)
|
|
594 ;; (6) nil.
|
|
595
|
|
596 (let ((thiswin (selected-window)) winok winbuf)
|
|
597 (save-excursion
|
|
598 (vcursor-locate)
|
|
599 (or (and (window-live-p vcursor-window)
|
|
600 (eq (current-buffer) (window-buffer vcursor-window))
|
|
601 (not (and not-this (eq thiswin vcursor-window))))
|
|
602 (setq vcursor-window nil))
|
|
603 (or (and vcursor-window ; choice 1
|
|
604 (pos-visible-in-window-p (point) vcursor-window))
|
|
605 (progn
|
|
606 (walk-windows
|
47941
|
607 (function
|
17450
|
608 (lambda (win)
|
|
609 (and (not winok)
|
|
610 (eq (current-buffer) (window-buffer win))
|
|
611 (not (and not-this (eq thiswin win)))
|
|
612 (cond
|
|
613 ((pos-visible-in-window-p (point) win) (setq winok win))
|
|
614 ((eq thiswin win))
|
|
615 ((not winbuf) (setq winbuf win))))))
|
|
616 nil (not this-frame))
|
|
617 (setq vcursor-window
|
|
618 (cond
|
|
619 (winok) ; choice 2
|
|
620 ((and vcursor-window ; choice 3
|
|
621 (not (eq thiswin vcursor-window))) vcursor-window)
|
|
622 (winbuf) ; choice 4
|
|
623 (new-win (display-buffer (current-buffer) t)) ; choice 5
|
|
624 (t nil))))))) ; default (choice 6)
|
|
625 vcursor-window
|
|
626 )
|
|
627
|
|
628 (defun vcursor-toggle-copy (&optional arg nomsg)
|
|
629 "Toggle copying to point when the vcursor is moved.
|
|
630 With a prefix ARG, turn on if non-negative, off if negative.
|
|
631 Display a message unless optional NOMSG is non-nil."
|
|
632 (interactive "P")
|
|
633 (setq vcursor-copy-flag
|
|
634 (cond ((not arg) (not vcursor-copy-flag))
|
|
635 ((< (prefix-numeric-value arg) 0) nil)
|
|
636 (t))
|
|
637 vcursor-last-command t)
|
|
638 (or nomsg (message "Copying from the vcursor is now %s."
|
|
639 (if vcursor-copy-flag "on" "off")))
|
|
640 )
|
|
641
|
21061
|
642 (defun vcursor-move (pt &optional leave-b leave-w)
|
17450
|
643 "Move the virtual cursor to the character to the right of PT.
|
21061
|
644 PT is an absolute location in the current buffer. With optional
|
|
645 LEAVE-B, PT is in the same buffer the vcursor is currently in.
|
17450
|
646
|
|
647 If the new virtual cursor location would not be visible, display it in
|
21061
|
648 another window. With LEAVE-W, use the current `vcursor-window'."
|
17450
|
649 ;; this works even if we're on-mass-shell, but usually we won't be.
|
|
650
|
21061
|
651 (save-excursion
|
|
652 (and leave-b (vcursor-check t)
|
|
653 (set-buffer (overlay-buffer vcursor-overlay)))
|
|
654 (if (eq pt (point-max))
|
|
655 (setq pt (1- pt)))
|
|
656 (if (vcursor-check t)
|
|
657 (move-overlay vcursor-overlay pt (+ pt 1) (current-buffer))
|
|
658 (setq vcursor-overlay (make-overlay pt (+ pt 1)))
|
|
659 (or window-system
|
28459
|
660 (display-color-p)
|
21061
|
661 (overlay-put vcursor-overlay 'before-string vcursor-string))
|
|
662 (overlay-put vcursor-overlay 'face 'vcursor))
|
|
663 (or leave-w (vcursor-find-window nil t))
|
|
664 ;; vcursor-window now contains the right buffer
|
|
665 (or (pos-visible-in-window-p pt vcursor-window)
|
|
666 (set-window-point vcursor-window pt)))
|
|
667 )
|
|
668
|
|
669 (defun vcursor-insert (text)
|
|
670 "Insert TEXT, respecting `vcursor-interpret-input'."
|
|
671 (if vcursor-interpret-input
|
|
672 (setq unread-command-events
|
|
673 (append (listify-key-sequence text) unread-command-events))
|
|
674 (insert text))
|
17450
|
675 )
|
|
676
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
677 (defun vcursor-relative-move (func &rest args)
|
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
678 "Call FUNC with arbitrary ARGS ... to move the virtual cursor.
|
17450
|
679
|
|
680 This is called by most of the virtual-cursor motion commands."
|
|
681 (let (text opoint)
|
|
682 (save-excursion
|
|
683 (vcursor-locate)
|
|
684 (setq opoint (point))
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
685 (apply func args)
|
17450
|
686 (and (eq opoint (point-max)) (eq opoint (point))
|
|
687 (signal 'end-of-buffer nil))
|
|
688 (vcursor-move (point))
|
|
689 (if vcursor-copy-flag (setq text (buffer-substring opoint (point)))))
|
21061
|
690 (if text (vcursor-insert text)))
|
17450
|
691 (setq vcursor-last-command t)
|
|
692 )
|
|
693
|
|
694 (defun vcursor-goto (&optional arg)
|
|
695 "Move the real cursor to the virtual cursor position.
|
|
696 If the virtual cursor is (or was recently) visible in another window,
|
|
697 switch to that first. Without a prefix ARG, disable the virtual
|
|
698 cursor as well."
|
|
699
|
|
700 (interactive "P")
|
|
701 (and (vcursor-find-window) (select-window vcursor-window))
|
|
702 (let ((buf (and vcursor-overlay (overlay-buffer vcursor-overlay))))
|
|
703 (and buf (not (eq (current-buffer) buf)) (switch-to-buffer buf)))
|
|
704 (vcursor-locate)
|
|
705 (or arg (vcursor-disable))
|
|
706 )
|
|
707
|
|
708 (defun vcursor-swap-point ()
|
|
709 "Swap the location of point and that of the virtual cursor.
|
|
710
|
|
711 The virtual cursor window becomes the selected window and the old
|
|
712 window becomes the virtual cursor window. If the virtual cursor would
|
|
713 not be visible otherwise, display it in another window."
|
|
714
|
|
715 (interactive)
|
|
716 (let ((buf (current-buffer)) (here (point)) (win (selected-window)))
|
|
717 (vcursor-goto) ; will disable the vcursor
|
84429
|
718 (with-current-buffer buf
|
17450
|
719 (setq vcursor-window win)
|
|
720 (vcursor-move here)))
|
|
721 )
|
|
722
|
|
723 (defun vcursor-scroll-up (&optional n)
|
|
724 "Scroll up the vcursor window ARG lines or near full screen if none.
|
|
725 The vcursor will always appear in an unselected window."
|
|
726
|
|
727 (interactive "P")
|
|
728 (vcursor-window-funcall 'scroll-up n)
|
|
729 )
|
|
730
|
|
731 (defun vcursor-scroll-down (&optional n)
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
732 "Scroll down the vcursor window ARG lines or near full screen if none.
|
17450
|
733 The vcursor will always appear in an unselected window."
|
|
734
|
|
735 (interactive "P")
|
|
736 (vcursor-window-funcall 'scroll-down n)
|
|
737 )
|
|
738
|
|
739 (defun vcursor-isearch-forward (&optional rep norecurs)
|
|
740 "Perform forward incremental search in the virtual cursor window.
|
|
741 The virtual cursor is moved to the resulting point; the ordinary
|
|
742 cursor stays where it was."
|
|
743
|
|
744 (interactive "P")
|
|
745 (vcursor-window-funcall 'isearch-forward rep norecurs)
|
|
746 )
|
|
747
|
21061
|
748 (defun vcursor-isearch-backward (&optional rep norecurs)
|
|
749 "Perform backward incremental search in the virtual cursor window.
|
|
750 The virtual cursor is moved to the resulting point; the ordinary
|
|
751 cursor stays where it was."
|
|
752
|
|
753 (interactive "P")
|
|
754 (vcursor-window-funcall 'isearch-backward rep norecurs)
|
|
755 )
|
|
756
|
17450
|
757 (defun vcursor-window-funcall (func &rest args)
|
|
758 "Call FUNC with ARGS ... in a virtual cursor window.
|
|
759 A window other than the currently-selected one will always be used.
|
|
760 The virtual cursor is moved to the value of point when the function
|
21061
|
761 returns.
|
|
762
|
|
763 If FUNC is a list, call the car of the list interactively, ignoring
|
|
764 ARGS. In this case, a new window will not be created if the vcursor
|
|
765 is visible in the current one."
|
|
766 ;; that's to avoid messing up compatibility with old versions
|
|
767 ;; by introducing a new argument, which would have to come before ARGS.
|
17450
|
768
|
21061
|
769 (vcursor-find-window (not (and (listp func) (vcursor-check t))) t)
|
|
770 (save-excursion
|
|
771 (let ((sw (selected-window)) text)
|
|
772 ;; We can't use save-window-excursion because that would restore
|
|
773 ;; the original display in the window we may want to alter.
|
|
774 (unwind-protect
|
|
775 (let ((here (point)))
|
|
776 (select-window vcursor-window)
|
|
777 (vcursor-locate)
|
|
778 (if (listp func)
|
|
779 (call-interactively (car func))
|
|
780 (apply func args))
|
|
781 (setq vcursor-window (selected-window))
|
|
782 (and vcursor-copy-flag
|
|
783 (eq (current-buffer) (overlay-buffer vcursor-overlay))
|
|
784 (setq text (buffer-substring here (point))))
|
|
785 ;; vcursor-window and the current buffer are definitely
|
|
786 ;; right, so make sure vcursor-move doesn't pick others.
|
|
787 (vcursor-move (point) nil t))
|
|
788 (select-window sw))
|
|
789 (if text (vcursor-insert text))))
|
17450
|
790 (setq vcursor-last-command t)
|
|
791 )
|
|
792
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
793 (defun vcursor-get-char-count (func &rest args)
|
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
794 "Apply FUNC to ARGS ... and return the number of characters moved.
|
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
795 Point is temporarily set to the virtual cursor position before FUNC
|
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
796 is called.
|
17450
|
797
|
|
798 This is called by most of the virtual-cursor copying commands to find
|
|
799 out how much to copy."
|
|
800
|
|
801 (vcursor-check)
|
84429
|
802 (with-current-buffer (overlay-buffer vcursor-overlay)
|
17450
|
803 (let ((start (goto-char (overlay-start vcursor-overlay))))
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
804 (- (progn (apply func args) (point)) start)))
|
17450
|
805 )
|
|
806
|
|
807 ;; Make sure the virtual cursor is active. Unless arg is non-nil,
|
|
808 ;; report an error if it is not.
|
|
809 (defun vcursor-check (&optional arg)
|
|
810 (cond
|
|
811 ((and (overlayp vcursor-overlay) (overlay-start vcursor-overlay))
|
|
812 t)
|
|
813 (arg nil)
|
38412
|
814 (t (error "The virtual cursor is not active now")))
|
17450
|
815 )
|
|
816
|
84429
|
817 (define-minor-mode vcursor-use-vcursor-map
|
|
818 "Toggle the state of the vcursor key map.
|
|
819 When on, the keys defined in it are mapped directly on top of the main
|
|
820 keymap, allowing you to move the vcursor with ordinary motion keys.
|
|
821 An indication \"!VC\" appears in the mode list. The effect is
|
|
822 local to the current buffer.
|
|
823 Disabling the vcursor automatically turns this off."
|
|
824 :keymap vcursor-map
|
|
825 :lighter " !VC")
|
|
826
|
17450
|
827 (defun vcursor-disable (&optional arg)
|
|
828 "Disable the virtual cursor.
|
|
829 Next time you use it, it will start from point.
|
|
830
|
|
831 With a positive prefix ARG, the first window in cyclic order
|
|
832 displaying the virtual cursor (or which was recently displaying the
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
833 virtual cursor) will be deleted unless it's the selected window.
|
17450
|
834
|
|
835 With a negative prefix argument, enable the virtual cursor: make it
|
|
836 active at the same point as the real cursor.
|
|
837
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
838 Copying mode is always turned off: the next use of the vcursor will
|
17450
|
839 not copy text until you turn it on again."
|
|
840
|
|
841 (interactive "P")
|
|
842 (if (overlayp vcursor-overlay)
|
|
843 (progn
|
|
844 (delete-overlay vcursor-overlay)
|
|
845 (setq vcursor-overlay nil)))
|
|
846 (cond
|
|
847 ((not (vcursor-find-window t)))
|
|
848 ((or (not arg) (< (prefix-numeric-value arg) 0)))
|
|
849 ((delete-window vcursor-window)))
|
21061
|
850 (cond
|
|
851 ((and arg (< (prefix-numeric-value arg) 0))
|
|
852 (vcursor-move (point))
|
|
853 (setq vcursor-window (selected-window)))
|
84429
|
854 (vcursor-use-vcursor-map (vcursor-use-vcursor-map 0)))
|
17450
|
855 (setq vcursor-copy-flag nil)
|
|
856 )
|
|
857
|
|
858 (defun vcursor-other-window (n &optional all-frames)
|
|
859 "Activate the virtual cursor in another window.
|
47941
|
860 This is the next window cyclically after one currently showing the
|
17450
|
861 virtual cursor, or else after the current selected window. If there
|
|
862 is no other window, the current window is split.
|
|
863
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
864 Arguments N and optional ALL-FRAMES are the same as with `other-window'.
|
17450
|
865 ALL-FRAMES is also used to decide whether to split the window."
|
|
866
|
|
867 (interactive "p")
|
|
868 (if (if (fboundp 'oemacs-version)
|
|
869 (one-window-p nil)
|
|
870 (one-window-p nil all-frames))
|
|
871 (display-buffer (current-buffer) t))
|
|
872 (save-excursion
|
|
873 (save-window-excursion
|
|
874 ;; We don't use fancy vcursor-find-window trickery, since we're
|
|
875 ;; quite happy to have the vcursor cycle back into the current
|
|
876 ;; window.
|
84429
|
877 (let ((win (vcursor-find-window nil nil (not all-frames))))
|
17450
|
878 (if win (select-window win))
|
|
879 ;; else start from here
|
|
880 (other-window n all-frames)
|
|
881 (vcursor-disable -1))))
|
|
882 )
|
|
883
|
21061
|
884 ;; vcursor-compare-windows is copied from compare-w.el with only
|
|
885 ;; minor modifications; these are too bound up with the function
|
|
886 ;; to make it really useful to call compare-windows itself.
|
|
887 (defun vcursor-compare-windows (&optional ignore-whitespace)
|
|
888 "Compare text in current window with text in window with vcursor.
|
|
889 Compares the text starting at point in the current window and at the
|
|
890 vcursor position in the other window, moving over text in each one as
|
|
891 far as they match.
|
|
892
|
|
893 A prefix argument, if any, means ignore changes in whitespace.
|
|
894 The variable `compare-windows-whitespace' controls how whitespace is skipped.
|
|
895 If `compare-ignore-case' is non-nil, changes in case are also ignored."
|
|
896 (interactive "P")
|
|
897 ;; (vcursor-window-funcall 'compare-windows arg)
|
|
898 (require 'compare-w)
|
|
899 (let* (p1 p2 maxp1 maxp2 b1 b2 w2
|
84429
|
900 success
|
21061
|
901 (opoint1 (point))
|
|
902 opoint2
|
|
903 (skip-whitespace (if ignore-whitespace
|
|
904 compare-windows-whitespace)))
|
|
905 (setq p1 (point) b1 (current-buffer))
|
|
906 (setq w2 (vcursor-find-window t t))
|
|
907 (if (or (eq w2 (selected-window)) (not w2))
|
|
908 (error "No other window with vcursor"))
|
|
909 (save-excursion
|
|
910 (vcursor-locate)
|
|
911 (setq p2 (point) b2 (current-buffer)))
|
|
912 (setq opoint2 p2)
|
|
913 (setq maxp1 (point-max))
|
84429
|
914 (with-current-buffer b2
|
21061
|
915 (setq maxp2 (point-max)))
|
|
916
|
|
917 (setq success t)
|
|
918 (while success
|
|
919 (setq success nil)
|
|
920 ;; if interrupted, show how far we've gotten
|
|
921 (goto-char p1)
|
|
922 (vcursor-move p2 t)
|
|
923
|
|
924 ;; If both buffers have whitespace next to point,
|
|
925 ;; optionally skip over it.
|
17450
|
926
|
21061
|
927 (and skip-whitespace
|
|
928 (save-excursion
|
84429
|
929 (let (p1a p2a result1 result2)
|
21061
|
930 (setq result1
|
|
931 (if (stringp skip-whitespace)
|
|
932 (compare-windows-skip-whitespace opoint1)
|
|
933 (funcall skip-whitespace opoint1)))
|
|
934 (setq p1a (point))
|
|
935 (set-buffer b2)
|
|
936 (goto-char p2)
|
|
937 (setq result2
|
|
938 (if (stringp skip-whitespace)
|
|
939 (compare-windows-skip-whitespace opoint2)
|
|
940 (funcall skip-whitespace opoint2)))
|
|
941 (setq p2a (point))
|
|
942 (if (or (stringp skip-whitespace)
|
|
943 (and result1 result2 (eq result1 result2)))
|
|
944 (setq p1 p1a
|
|
945 p2 p2a)))))
|
|
946
|
|
947 ;; Try advancing comparing 1000 chars at a time.
|
|
948 ;; When that fails, go 500 chars at a time, and so on.
|
|
949 (let ((size 1000)
|
|
950 success-1
|
|
951 (case-fold-search compare-ignore-case))
|
|
952 (while (> size 0)
|
|
953 (setq success-1 t)
|
|
954 ;; Try comparing SIZE chars at a time, repeatedly, till that fails.
|
|
955 (while success-1
|
|
956 (setq size (min size (- maxp1 p1) (- maxp2 p2)))
|
|
957 (setq success-1
|
|
958 (and (> size 0)
|
|
959 (= 0 (compare-buffer-substrings b2 p2 (+ size p2)
|
|
960 b1 p1 (+ size p1)))))
|
|
961 (if success-1
|
|
962 (setq p1 (+ p1 size) p2 (+ p2 size)
|
|
963 success t)))
|
|
964 ;; If SIZE chars don't match, try fewer.
|
|
965 (setq size (/ size 2)))))
|
|
966
|
|
967 (goto-char p1)
|
|
968 (vcursor-move p2 t)
|
|
969 (if (= (point) opoint1)
|
|
970 (ding)))
|
|
971 )
|
17450
|
972
|
|
973 (defun vcursor-next-line (arg)
|
|
974 "Move the virtual cursor forward ARG lines."
|
|
975 ;; This is next-line rewritten for the vcursor. Maybe it would
|
|
976 ;; be easier simply to rewrite line-move.
|
|
977 (interactive "p")
|
|
978 (let (temporary-goal-column opoint text)
|
|
979 (save-excursion
|
|
980 (vcursor-locate)
|
|
981 (setq temporary-goal-column
|
|
982 (if (or (eq last-command 'vcursor-next-line)
|
|
983 (eq last-command 'vcursor-previous-line))
|
|
984 (progn
|
|
985 (setq last-command 'next-line) ; trick line-move
|
|
986 vcursor-temp-goal-column)
|
|
987 (if (and track-eol (eolp)
|
|
988 (or (not (bolp)) (eq last-command 'end-of-line)))
|
|
989 9999
|
|
990 (current-column)))
|
|
991 opoint (point))
|
|
992 (line-move arg)
|
|
993 (and (eq opoint (point-max)) (eq opoint (point))
|
|
994 (signal 'end-of-buffer nil))
|
|
995 (if vcursor-copy-flag (setq text (buffer-substring opoint (point))))
|
|
996 (vcursor-move (point))
|
|
997 (setq vcursor-temp-goal-column temporary-goal-column
|
|
998 vcursor-last-command t))
|
21061
|
999 (if text (vcursor-insert text)))
|
17450
|
1000 )
|
|
1001
|
|
1002 (defun vcursor-previous-line (arg)
|
|
1003 "Move the virtual cursor back ARG lines."
|
|
1004 (interactive "p")
|
|
1005 (vcursor-next-line (- arg))
|
|
1006 )
|
|
1007
|
|
1008 (defun vcursor-forward-char (arg)
|
|
1009 "Move the virtual cursor forward ARG characters."
|
|
1010 (interactive "p")
|
|
1011 (vcursor-relative-move 'forward-char arg)
|
|
1012 )
|
|
1013
|
|
1014 (defun vcursor-backward-char (arg)
|
|
1015 "Move the virtual cursor backward ARG characters."
|
|
1016 (interactive "p")
|
|
1017 (vcursor-relative-move 'backward-char arg)
|
|
1018 )
|
|
1019
|
|
1020 (defun vcursor-forward-word (arg)
|
|
1021 "Move the virtual cursor forward ARG words."
|
|
1022 (interactive "p")
|
|
1023 (vcursor-relative-move 'forward-word arg)
|
|
1024 )
|
|
1025
|
|
1026 (defun vcursor-backward-word (arg)
|
|
1027 "Move the virtual cursor backward ARG words."
|
|
1028 (interactive "p")
|
|
1029 (vcursor-relative-move 'backward-word arg)
|
|
1030 )
|
|
1031
|
|
1032 (defun vcursor-beginning-of-line (arg)
|
|
1033 "Move the virtual cursor to beginning of its current line.
|
|
1034 ARG is as for `beginning-of-line'."
|
|
1035 (interactive "P")
|
|
1036 (vcursor-relative-move 'beginning-of-line
|
|
1037 (if arg (prefix-numeric-value arg)))
|
|
1038 )
|
|
1039
|
|
1040 (defun vcursor-end-of-line (arg)
|
|
1041 "Move the virtual cursor to end of its current line.
|
|
1042 ARG is as for `end-of-line'."
|
|
1043 (interactive "P")
|
|
1044 (vcursor-relative-move 'end-of-line
|
|
1045 (if arg (prefix-numeric-value arg)))
|
|
1046 )
|
|
1047
|
|
1048 (defun vcursor-beginning-of-buffer (&optional arg)
|
|
1049 "Move the virtual cursor to the beginning of its buffer.
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
1050 ARG is as for `beginning-of-buffer'."
|
17450
|
1051 (interactive "P")
|
|
1052 (vcursor-relative-move
|
|
1053 (lambda (arg)
|
|
1054 (goto-char (if arg (/ (* arg (- (point-max) (point-min))) 10)
|
|
1055 (point-min))))
|
|
1056 (if arg (prefix-numeric-value arg)))
|
|
1057 )
|
|
1058
|
|
1059 (defun vcursor-end-of-buffer (&optional arg)
|
|
1060 "Move the virtual cursor to the end of its buffer.
|
64564
4b552d6938e8
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
1061 ARG is as for `end-of-buffer'.
|
17450
|
1062
|
|
1063 Actually, the vcursor is moved to the second from last character or it
|
|
1064 would be invisible."
|
|
1065 (interactive "P")
|
|
1066 (vcursor-relative-move
|
|
1067 (lambda (arg)
|
|
1068 (goto-char (if arg (- (point-max)
|
|
1069 (/ (* arg (- (point-max) (point-min))) 10))
|
|
1070 (point-max))))
|
|
1071 (if arg (prefix-numeric-value arg)))
|
|
1072 )
|
|
1073
|
|
1074 (defun vcursor-execute-command (cmd)
|
|
1075 "Execute COMMAND for the virtual cursor.
|
|
1076 COMMAND is called interactively. Not all commands (in fact, only a
|
|
1077 small subset) are useful."
|
|
1078 (interactive "CCommand: ")
|
21061
|
1079 (vcursor-window-funcall (list cmd))
|
17450
|
1080 )
|
|
1081
|
21061
|
1082 (defun vcursor-execute-key ()
|
|
1083 "Read a key sequence and execute the bound command for the virtual cursor.
|
|
1084 The key sequence is read at the vcursor location. The command found
|
|
1085 is called interactively, so prefix argument etc. are usable."
|
|
1086 (interactive)
|
|
1087 (let (cmd)
|
|
1088 (save-excursion
|
|
1089 ;; We'd like to avoid the display changing when we locate
|
|
1090 ;; to the vcursor position and read a key sequence.
|
|
1091 (vcursor-find-window (not (vcursor-check t)) t)
|
|
1092 (save-window-excursion
|
|
1093 (select-window vcursor-window)
|
|
1094 (vcursor-locate)
|
|
1095 (setq cmd (key-binding (read-key-sequence "Key sequence: ")))))
|
|
1096 (vcursor-window-funcall (list cmd)))
|
17450
|
1097 )
|
|
1098
|
|
1099 (defun vcursor-copy (arg)
|
|
1100 "Copy ARG characters from the virtual cursor position to point."
|
|
1101 (interactive "p")
|
|
1102 (vcursor-check)
|
21061
|
1103 (vcursor-insert
|
84429
|
1104 (with-current-buffer (overlay-buffer vcursor-overlay)
|
17450
|
1105 (let* ((ostart (overlay-start vcursor-overlay))
|
|
1106 (end (+ ostart arg)))
|
|
1107 (prog1
|
|
1108 (buffer-substring ostart end)
|
|
1109 (vcursor-move end)))))
|
|
1110 (setq vcursor-last-command t)
|
|
1111 )
|
|
1112
|
|
1113 (defun vcursor-copy-word (arg)
|
|
1114 "Copy ARG words from the virtual cursor position to point."
|
|
1115 (interactive "p")
|
|
1116 (vcursor-copy (vcursor-get-char-count 'forward-word arg))
|
|
1117 )
|
|
1118
|
|
1119 (defun vcursor-copy-line (arg)
|
|
1120 "Copy up to ARGth line after virtual cursor position.
|
|
1121 With no argument, copy to the end of the current line.
|
|
1122
|
63263
|
1123 Behavior with regard to newlines is similar (but not identical) to
|
17450
|
1124 `kill-line'; the main difference is that whitespace at the end of the
|
|
1125 line is treated like ordinary characters."
|
|
1126
|
|
1127 (interactive "P")
|
|
1128 (let* ((num (prefix-numeric-value arg))
|
|
1129 (count (vcursor-get-char-count 'end-of-line num)))
|
|
1130 (vcursor-copy (if (or (= count 0) arg) (1+ count) count)))
|
|
1131 )
|
|
1132
|
84429
|
1133 (define-obsolete-function-alias
|
|
1134 'vcursor-toggle-vcursor-map 'vcursor-use-vcursor-map "23.1")
|
21061
|
1135
|
17450
|
1136 (defun vcursor-post-command ()
|
|
1137 (and vcursor-auto-disable (not vcursor-last-command)
|
22650
|
1138 vcursor-overlay
|
|
1139 (if (eq vcursor-auto-disable t)
|
|
1140 (vcursor-disable)
|
|
1141 (vcursor-toggle-copy -1 t)))
|
17450
|
1142 (setq vcursor-last-command nil)
|
|
1143 )
|
|
1144
|
|
1145 (add-hook 'post-command-hook 'vcursor-post-command)
|
|
1146
|
|
1147 (provide 'vcursor)
|
|
1148
|
84429
|
1149 ;; arch-tag: cdfe1cdc-2c46-4046-88e4-ed57d20f7aca
|
38412
|
1150 ;;; vcursor.el ends here
|