Switch to recommended form of GPLv3 permissions notice.
[bpt/emacs.git] / lisp / emulation / pc-select.el
CommitLineData
b50c87ee
KH
1;;; pc-select.el --- emulate mark, cut, copy and paste from Motif
2;;; (or MAC GUI or MS-windoze (bah)) look-and-feel
3;;; including key bindings.
215e89e5 4
5fd6d89f 5;; Copyright (C) 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
8b72699e 6;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
215e89e5
RS
7
8;; Author: Michael Staats <michael@thp.Uni-Duisburg.DE>
de986953 9;; Keywords: convenience emulation
215e89e5
RS
10;; Created: 26 Sep 1995
11
12;; This file is part of GNU Emacs.
13
ed0f493f 14;; GNU Emacs is free software: you can redistribute it and/or modify
215e89e5 15;; it under the terms of the GNU General Public License as published by
ed0f493f
GM
16;; the Free Software Foundation, either version 3 of the License, or
17;; (at your option) any later version.
215e89e5
RS
18
19;; GNU Emacs is distributed in the hope that it will be useful,
20;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22;; GNU General Public License for more details.
23
24;; You should have received a copy of the GNU General Public License
ed0f493f 25;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
215e89e5
RS
26
27;;; Commentary:
b578f267 28
215e89e5
RS
29;; This package emulates the mark, copy, cut and paste look-and-feel of motif
30;; programs (which is the same as the MAC gui and (sorry for that) MS-Windows).
31;; It modifies the keybindings of the cursor keys and the next, prior,
32;; home and end keys. They will modify mark-active.
33;; You can still get the old behaviour of cursor moving with the
34;; control sequences C-f, C-b, etc.
35;; This package uses transient-mark-mode and
36;; delete-selection-mode.
37;;
13f5a20e 38;; In addition to that all key-bindings from the pc-mode are
215e89e5
RS
39;; done here too (as suggested by RMS).
40;;
41;; As I found out after I finished the first version, s-region.el tries
42;; to do the same.... But my code is a little more complete and using
43;; delete-selection-mode is very important for the look-and-feel.
44;; Pete Forman <pete.forman@airgun.wg.waii.com> provided some motif
45;; compliant keybindings which I added. I had to modify them a little
46;; to add the -mark and -nomark functionality of cursor moving.
47;;
48;; Credits:
49;; Many thanks to all who made comments.
50;; Thanks to RMS and Ralf Muschall <prm@rz.uni-jena.de> for criticism.
51;; Kevin Cutts <cutts@ukraine.corp.mot.com> added the beginning-of-buffer
52;; and end-of-buffer functions which I modified a little.
53;; David Biesack <sasdjb@unx.sas.com> suggested some more cleanup.
54;; Thanks to Pete Forman <pete.forman@airgun.wg.waii.com>
55;; for additional motif keybindings.
14dacacd
RS
56;; Thanks to jvromans@squirrel.nl (Johan Vromans) for a bug report
57;; concerning setting of this-command.
83d1d58c 58;; Dan Nicolaescu <done@ece.arizona.ro> suggested suppressing the
20c5a87d 59;; scroll-up/scroll-down error.
b50c87ee 60;; Eli Barzilay (eli@cs.bgu.ac.il) suggested the sexps functions and
13f5a20e 61;; keybindings.
215e89e5 62;;
e873bbf9 63;; Ok, some details about the idea of PC Selection mode:
215e89e5
RS
64;;
65;; o The standard keys for moving around (right, left, up, down, home, end,
66;; prior, next, called "move-keys" from now on) will always de-activate
67;; the mark.
68;; o If you press "Shift" together with the "move-keys", the region
69;; you pass along is activated
70;; o You have the copy, cut and paste functions (as in many other programs)
71;; which will operate on the active region
72;; It was not possible to bind them to C-v, C-x and C-c for obvious
73;; emacs reasons.
74;; They will be bound according to the "old" behaviour to S-delete (cut),
75;; S-insert (paste) and C-insert (copy). These keys do the same in many
76;; other programs.
20c5a87d 77;;
215e89e5 78
e8af40ee
PJ
79;;; Code:
80
fd4e5923 81;; Customization:
83d1d58c
RS
82(defgroup pc-select nil
83 "Emulate pc bindings."
84 :prefix "pc-select"
f5f727f8
DN
85 :group 'editing-basics
86 :group 'convenience)
20c5a87d 87
83d1d58c 88(defcustom pc-select-override-scroll-error t
20c5a87d
RS
89 "*Non-nil means don't generate error on scrolling past edge of buffer.
90This variable applies in PC Selection mode only.
91The scroll commands normally generate an error if you try to scroll
92past the top or bottom of the buffer. This is annoying when selecting
93text with these commands. If you set this variable to non-nil, these
83d1d58c
RS
94errors are suppressed."
95 :type 'boolean
96 :group 'pc-select)
215e89e5 97
83d1d58c 98(defcustom pc-select-selection-keys-only nil
b50c87ee
KH
99 "*Non-nil means only bind the basic selection keys when started.
100Other keys that emulate pc-behavior will be untouched.
ca088b04 101This gives mostly Emacs-like behavior with only the selection keys enabled."
83d1d58c
RS
102 :type 'boolean
103 :group 'pc-select)
b50c87ee 104
83d1d58c
RS
105(defcustom pc-select-meta-moves-sexps nil
106 "*Non-nil means move sexp-wise with Meta key, otherwise move word-wise."
107 :type 'boolean
108 :group 'pc-select)
b50c87ee 109
cb96f094
RS
110(defcustom pc-selection-mode-hook nil
111 "The hook to run when pc-selection-mode is toggled."
112 :type 'hook
113 :group 'pc-select)
114
115(defvar pc-select-saved-settings-alist nil
e873bbf9
RS
116 "The values of the variables before PC Selection mode was toggled on.
117When PC Selection mode is toggled on, it sets quite a few variables
cb96f094 118for its own purposes. This alist holds the original values of the
e873bbf9
RS
119variables PC Selection mode had set, so that these variables can be
120restored to their original values when PC Selection mode is toggled off.")
cb96f094
RS
121
122(defvar pc-select-map nil
e873bbf9 123 "The keymap used as the global map when PC Selection mode is on." )
cb96f094
RS
124
125(defvar pc-select-saved-global-map nil
e873bbf9 126 "The global map that was in effect when PC Selection mode was toggled on.")
cb96f094
RS
127
128(defvar pc-select-key-bindings-alist nil
e873bbf9 129 "This alist holds all the key bindings PC Selection mode sets.")
cb96f094
RS
130
131(defvar pc-select-default-key-bindings nil
e873bbf9 132 "These key bindings always get set by PC Selection mode.")
cb96f094
RS
133
134(unless pc-select-default-key-bindings
135 (let ((lst
de299ed7
SM
136 ;; This is to avoid confusion with the delete-selection-mode.
137 ;; On simple displays you can't see that a region is active and
cb96f094
RS
138 ;; will be deleted on the next keypress IMHO especially for
139 ;; copy-region-as-kill this is confusing.
140 ;; The same goes for exchange-point-and-mark
141 '(("\M-w" . copy-region-as-kill-nomark)
142 ("\C-x\C-x" . exchange-point-and-mark-nomark)
143 ([S-right] . forward-char-mark)
144 ([right] . forward-char-nomark)
145 ([C-S-right] . forward-word-mark)
146 ([C-right] . forward-word-nomark)
147 ([S-left] . backward-char-mark)
148 ([left] . backward-char-nomark)
149 ([C-S-left] . backward-word-mark)
150 ([C-left] . backward-word-nomark)
151 ([S-down] . next-line-mark)
152 ([down] . next-line-nomark)
153
154 ([S-end] . end-of-line-mark)
155 ([end] . end-of-line-nomark)
156 ([S-C-end] . end-of-buffer-mark)
157 ([C-end] . end-of-buffer-nomark)
158 ([S-M-end] . end-of-buffer-mark)
159 ([M-end] . end-of-buffer-nomark)
160
161 ([S-next] . scroll-up-mark)
162 ([next] . scroll-up-nomark)
163
164 ([S-up] . previous-line-mark)
165 ([up] . previous-line-nomark)
166
167 ([S-home] . beginning-of-line-mark)
168 ([home] . beginning-of-line-nomark)
169 ([S-C-home] . beginning-of-buffer-mark)
170 ([C-home] . beginning-of-buffer-nomark)
171 ([S-M-home] . beginning-of-buffer-mark)
172 ([M-home] . beginning-of-buffer-nomark)
173
174 ([M-S-down] . forward-line-mark)
175 ([M-down] . forward-line-nomark)
176 ([M-S-up] . backward-line-mark)
177 ([M-up] . backward-line-nomark)
178
179 ([S-prior] . scroll-down-mark)
180 ([prior] . scroll-down-nomark)
181
182 ;; Next four lines are from Pete Forman.
de299ed7 183 ([C-down] . forward-paragraph-nomark) ; KNextPara cDn
cb96f094
RS
184 ([C-up] . backward-paragraph-nomark) ; KPrevPara cUp
185 ([S-C-down] . forward-paragraph-mark)
186 ([S-C-up] . backward-paragraph-mark))))
a1506d29 187
cb96f094
RS
188 (setq pc-select-default-key-bindings lst)))
189
190(defvar pc-select-extra-key-bindings nil
191 "Key bindings to set only if `pc-select-selection-keys-only' is nil.")
192
193;; The following keybindings are for standard ISO keyboards
194;; as they are used with IBM compatible PCs, IBM RS/6000,
195;; MACs, many X-Stations and probably more
196(unless pc-select-extra-key-bindings
197 (let ((lst
198 '(([S-insert] . yank)
199 ([C-insert] . copy-region-as-kill)
200 ([S-delete] . kill-region)
201
202 ;; The following bindings are useful on Sun Type 3 keyboards
203 ;; They implement the Get-Delete-Put (copy-cut-paste)
204 ;; functions from sunview on the L6, L8 and L10 keys
205 ;; Sam Steingold <sds@gnu.org> says that f16 is copy and f18 is paste.
206 ([f16] . copy-region-as-kill)
207 ([f18] . yank)
208 ([f20] . kill-region)
209
210 ;; The following bindings are from Pete Forman.
211 ([f6] . other-window) ; KNextPane F6
212 ([C-delete] . kill-line) ; KEraseEndLine cDel
213 ("\M-\d" . undo) ; KUndo aBS
214
215 ;; The following binding is taken from pc-mode.el
216 ;; as suggested by RMS.
217 ;; I only used the one that is not covered above.
218 ([C-M-delete] . kill-sexp)
219 ;; Next line proposed by Eli Barzilay
220 ([C-escape] . electric-buffer-list))))
a1506d29 221
cb96f094
RS
222 (setq pc-select-extra-key-bindings lst)))
223
224(defvar pc-select-meta-moves-sexps-key-bindings
225 '((([M-S-right] . forward-sexp-mark)
226 ([M-right] . forward-sexp-nomark)
227 ([M-S-left] . backward-sexp-mark)
228 ([M-left] . backward-sexp-nomark))
229 (([M-S-right] . forward-word-mark)
230 ([M-right] . forward-word-nomark)
231 ([M-S-left] . backward-word-mark)
232 ([M-left] . backward-word-nomark)))
233 "The list of key bindings controlled by `pc-select-meta-moves-sexp'.
234The bindings in the car of this list get installed if
235`pc-select-meta-moves-sexp' is t, the bindings in the cadr of this
236list get installed otherwise.")
237
238;; This is for tty. We don't turn on normal-erase-is-backspace,
239;; but bind keys as pc-selection-mode did before
240;; normal-erase-is-backspace was invented, to keep us back
241;; compatible.
242(defvar pc-select-tty-key-bindings
243 '(([delete] . delete-char) ; KDelete Del
244 ([C-backspace] . backward-kill-word))
245 "The list of key bindings controlled by `pc-select-selection-keys-only'.
246These key bindings get installed when running in a tty, but only if
247`pc-select-selection-keys-only' is nil.")
248
249(defvar pc-select-old-M-delete-binding nil
250 "Holds the old mapping of [M-delete] in the `function-key-map'.
251This variable holds the value associated with [M-delete] in the
e873bbf9 252`function-key-map' before PC Selection mode had changed that
cb96f094
RS
253association.")
254
215e89e5
RS
255;;;;
256;; misc
257;;;;
258
259(provide 'pc-select)
260
261(defun copy-region-as-kill-nomark (beg end)
262 "Save the region as if killed; but don't kill it; deactivate mark.
263If `interprogram-cut-function' is non-nil, also save the text for a window
20c5a87d
RS
264system cut and paste.
265
fd4e5923
SM
266Deactivating mark is to avoid confusion with `delete-selection-mode'
267and `transient-mark-mode'."
215e89e5
RS
268 (interactive "r")
269 (copy-region-as-kill beg end)
270 (setq mark-active nil)
271 (message "Region saved"))
272
b50c87ee 273(defun exchange-point-and-mark-nomark ()
fd4e5923 274 "Like `exchange-point-and-mark' but without activating the mark."
b50c87ee
KH
275 (interactive)
276 (exchange-point-and-mark)
277 (setq mark-active nil))
278
215e89e5
RS
279;;;;
280;; non-interactive
281;;;;
e85c6b7c 282(defun pc-select-ensure-mark ()
215e89e5
RS
283 ;; make sure mark is active
284 ;; test if it is active, if it isn't, set it and activate it
de299ed7 285 (or mark-active (set-mark-command nil))
e85c6b7c
SM
286 ;; Remember who activated the mark.
287 (setq mark-active 'pc-select))
de299ed7 288
e85c6b7c 289(defun pc-select-maybe-deactivate-mark ()
de299ed7 290 ;; maybe switch off mark (only if *we* switched it on)
e85c6b7c
SM
291 (when (eq mark-active 'pc-select)
292 (deactivate-mark)))
215e89e5
RS
293
294;;;;;;;;;;;;;;;;;;;;;;;;;;;
295;;;;; forward and mark
296;;;;;;;;;;;;;;;;;;;;;;;;;;;
297
298(defun forward-char-mark (&optional arg)
299 "Ensure mark is active; move point right ARG characters (left if ARG negative).
300On reaching end of buffer, stop and signal error."
301 (interactive "p")
e85c6b7c 302 (pc-select-ensure-mark)
215e89e5
RS
303 (forward-char arg))
304
305(defun forward-word-mark (&optional arg)
306 "Ensure mark is active; move point right ARG words (backward if ARG is negative).
307Normally returns t.
308If an edge of the buffer is reached, point is left there
309and nil is returned."
310 (interactive "p")
e85c6b7c 311 (pc-select-ensure-mark)
215e89e5
RS
312 (forward-word arg))
313
20c5a87d
RS
314(defun forward-line-mark (&optional arg)
315 "Ensure mark is active; move cursor vertically down ARG lines."
316 (interactive "p")
e85c6b7c 317 (pc-select-ensure-mark)
20c5a87d
RS
318 (forward-line arg)
319 (setq this-command 'forward-line)
320)
321
b50c87ee
KH
322(defun forward-sexp-mark (&optional arg)
323 "Ensure mark is active; move forward across one balanced expression (sexp).
324With argument, do it that many times. Negative arg -N means
325move backward across N balanced expressions."
326 (interactive "p")
e85c6b7c 327 (pc-select-ensure-mark)
b50c87ee
KH
328 (forward-sexp arg))
329
215e89e5
RS
330(defun forward-paragraph-mark (&optional arg)
331 "Ensure mark is active; move forward to end of paragraph.
20c5a87d
RS
332With arg N, do it N times; negative arg -N means move backward N paragraphs.
333
215e89e5 334A line which `paragraph-start' matches either separates paragraphs
14dacacd 335\(if `paragraph-separate' matches it also) or is the first line of a paragraph.
215e89e5
RS
336A paragraph end is the beginning of a line which is not part of the paragraph
337to which the end of the previous line belongs, or the end of the buffer."
338 (interactive "p")
e85c6b7c 339 (pc-select-ensure-mark)
215e89e5 340 (forward-paragraph arg))
20c5a87d 341
215e89e5
RS
342(defun next-line-mark (&optional arg)
343 "Ensure mark is active; move cursor vertically down ARG lines.
344If there is no character in the target line exactly under the current column,
345the cursor is positioned after the character in that line which spans this
346column, or at the end of the line if it is not long enough.
347If there is no line in the buffer after this one, behavior depends on the
348value of `next-line-add-newlines'. If non-nil, it inserts a newline character
349to create a line, and moves the cursor to that line. Otherwise it moves the
350cursor to the end of the buffer \(if already at the end of the buffer, an error
20c5a87d
RS
351is signaled).
352
fd4e5923 353The command \\[set-goal-column] can be used to create
215e89e5
RS
354a semipermanent goal column to which this command always moves.
355Then it does not try to move vertically. This goal column is stored
356in `goal-column', which is nil when there is none."
357 (interactive "p")
e85c6b7c 358 (pc-select-ensure-mark)
3fe5c37a 359 (with-no-warnings (next-line arg))
14dacacd 360 (setq this-command 'next-line))
215e89e5
RS
361
362(defun end-of-line-mark (&optional arg)
363 "Ensure mark is active; move point to end of current line.
364With argument ARG not nil or 1, move forward ARG - 1 lines first.
365If scan reaches end of buffer, stop there without error."
366 (interactive "p")
e85c6b7c 367 (pc-select-ensure-mark)
14dacacd
RS
368 (end-of-line arg)
369 (setq this-command 'end-of-line))
215e89e5 370
20c5a87d
RS
371(defun backward-line-mark (&optional arg)
372 "Ensure mark is active; move cursor vertically up ARG lines."
373 (interactive "p")
e85c6b7c 374 (pc-select-ensure-mark)
20c5a87d
RS
375 (if (null arg)
376 (setq arg 1))
377 (forward-line (- arg))
378 (setq this-command 'forward-line)
379)
380
215e89e5
RS
381(defun scroll-down-mark (&optional arg)
382 "Ensure mark is active; scroll down ARG lines; or near full screen if no ARG.
383A near full screen is `next-screen-context-lines' less than a full screen.
384Negative ARG means scroll upward.
385When calling from a program, supply a number as argument or nil."
13f5a20e 386 (interactive "P")
e85c6b7c 387 (pc-select-ensure-mark)
2a811501
RS
388 (cond (pc-select-override-scroll-error
389 (condition-case nil (scroll-down arg)
390 (beginning-of-buffer (goto-char (point-min)))))
391 (t (scroll-down arg))))
215e89e5
RS
392
393(defun end-of-buffer-mark (&optional arg)
394 "Ensure mark is active; move point to the end of the buffer.
20c5a87d
RS
395With arg N, put point N/10 of the way from the end.
396
215e89e5 397If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
398of the accessible part of the buffer.
399
215e89e5
RS
400Don't use this command in Lisp programs!
401\(goto-char \(point-max)) is faster and avoids clobbering the mark."
402 (interactive "P")
e85c6b7c 403 (pc-select-ensure-mark)
215e89e5
RS
404 (let ((size (- (point-max) (point-min))))
405 (goto-char (if arg
406 (- (point-max)
407 (if (> size 10000)
408 ;; Avoid overflow for large buffer sizes!
409 (* (prefix-numeric-value arg)
410 (/ size 10))
411 (/ (* size (prefix-numeric-value arg)) 10)))
412 (point-max))))
413 ;; If we went to a place in the middle of the buffer,
414 ;; adjust it to the beginning of a line.
415 (if arg (forward-line 1)
416 ;; If the end of the buffer is not already on the screen,
417 ;; then scroll specially to put it near, but not at, the bottom.
418 (if (let ((old-point (point)))
419 (save-excursion
420 (goto-char (window-start))
421 (vertical-motion (window-height))
422 (< (point) old-point)))
423 (progn
424 (overlay-recenter (point))
425 (recenter -3)))))
426
427;;;;;;;;;
428;;;;; no mark
429;;;;;;;;;
430
431(defun forward-char-nomark (&optional arg)
432 "Deactivate mark; move point right ARG characters \(left if ARG negative).
433On reaching end of buffer, stop and signal error."
434 (interactive "p")
e85c6b7c 435 (pc-select-maybe-deactivate-mark)
215e89e5
RS
436 (forward-char arg))
437
438(defun forward-word-nomark (&optional arg)
439 "Deactivate mark; move point right ARG words \(backward if ARG is negative).
440Normally returns t.
441If an edge of the buffer is reached, point is left there
442and nil is returned."
443 (interactive "p")
e85c6b7c 444 (pc-select-maybe-deactivate-mark)
215e89e5
RS
445 (forward-word arg))
446
20c5a87d
RS
447(defun forward-line-nomark (&optional arg)
448 "Deactivate mark; move cursor vertically down ARG lines."
449 (interactive "p")
e85c6b7c 450 (pc-select-maybe-deactivate-mark)
20c5a87d
RS
451 (forward-line arg)
452 (setq this-command 'forward-line)
453)
454
b50c87ee
KH
455(defun forward-sexp-nomark (&optional arg)
456 "Deactivate mark; move forward across one balanced expression (sexp).
457With argument, do it that many times. Negative arg -N means
458move backward across N balanced expressions."
459 (interactive "p")
e85c6b7c 460 (pc-select-maybe-deactivate-mark)
b50c87ee
KH
461 (forward-sexp arg))
462
215e89e5
RS
463(defun forward-paragraph-nomark (&optional arg)
464 "Deactivate mark; move forward to end of paragraph.
20c5a87d
RS
465With arg N, do it N times; negative arg -N means move backward N paragraphs.
466
215e89e5 467A line which `paragraph-start' matches either separates paragraphs
14dacacd 468\(if `paragraph-separate' matches it also) or is the first line of a paragraph.
215e89e5
RS
469A paragraph end is the beginning of a line which is not part of the paragraph
470to which the end of the previous line belongs, or the end of the buffer."
471 (interactive "p")
e85c6b7c 472 (pc-select-maybe-deactivate-mark)
215e89e5
RS
473 (forward-paragraph arg))
474
475(defun next-line-nomark (&optional arg)
476 "Deactivate mark; move cursor vertically down ARG lines.
477If there is no character in the target line exactly under the current column,
478the cursor is positioned after the character in that line which spans this
479column, or at the end of the line if it is not long enough.
480If there is no line in the buffer after this one, behavior depends on the
481value of `next-line-add-newlines'. If non-nil, it inserts a newline character
482to create a line, and moves the cursor to that line. Otherwise it moves the
483cursor to the end of the buffer (if already at the end of the buffer, an error
20c5a87d
RS
484is signaled).
485
fd4e5923 486The command \\[set-goal-column] can be used to create
215e89e5
RS
487a semipermanent goal column to which this command always moves.
488Then it does not try to move vertically. This goal column is stored
489in `goal-column', which is nil when there is none."
490 (interactive "p")
e85c6b7c 491 (pc-select-maybe-deactivate-mark)
3fe5c37a 492 (with-no-warnings (next-line arg))
14dacacd 493 (setq this-command 'next-line))
215e89e5
RS
494
495(defun end-of-line-nomark (&optional arg)
496 "Deactivate mark; move point to end of current line.
497With argument ARG not nil or 1, move forward ARG - 1 lines first.
498If scan reaches end of buffer, stop there without error."
499 (interactive "p")
e85c6b7c 500 (pc-select-maybe-deactivate-mark)
14dacacd
RS
501 (end-of-line arg)
502 (setq this-command 'end-of-line))
215e89e5 503
20c5a87d
RS
504(defun backward-line-nomark (&optional arg)
505 "Deactivate mark; move cursor vertically up ARG lines."
506 (interactive "p")
e85c6b7c 507 (pc-select-maybe-deactivate-mark)
20c5a87d
RS
508 (if (null arg)
509 (setq arg 1))
510 (forward-line (- arg))
511 (setq this-command 'forward-line)
512)
513
215e89e5
RS
514(defun scroll-down-nomark (&optional arg)
515 "Deactivate mark; scroll down ARG lines; or near full screen if no ARG.
516A near full screen is `next-screen-context-lines' less than a full screen.
517Negative ARG means scroll upward.
518When calling from a program, supply a number as argument or nil."
519 (interactive "P")
e85c6b7c 520 (pc-select-maybe-deactivate-mark)
2a811501
RS
521 (cond (pc-select-override-scroll-error
522 (condition-case nil (scroll-down arg)
523 (beginning-of-buffer (goto-char (point-min)))))
524 (t (scroll-down arg))))
215e89e5
RS
525
526(defun end-of-buffer-nomark (&optional arg)
527 "Deactivate mark; move point to the end of the buffer.
20c5a87d
RS
528With arg N, put point N/10 of the way from the end.
529
215e89e5 530If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
531of the accessible part of the buffer.
532
215e89e5 533Don't use this command in Lisp programs!
14dacacd 534\(goto-char (point-max)) is faster and avoids clobbering the mark."
215e89e5 535 (interactive "P")
e85c6b7c 536 (pc-select-maybe-deactivate-mark)
215e89e5
RS
537 (let ((size (- (point-max) (point-min))))
538 (goto-char (if arg
539 (- (point-max)
540 (if (> size 10000)
541 ;; Avoid overflow for large buffer sizes!
542 (* (prefix-numeric-value arg)
543 (/ size 10))
544 (/ (* size (prefix-numeric-value arg)) 10)))
545 (point-max))))
546 ;; If we went to a place in the middle of the buffer,
547 ;; adjust it to the beginning of a line.
548 (if arg (forward-line 1)
549 ;; If the end of the buffer is not already on the screen,
550 ;; then scroll specially to put it near, but not at, the bottom.
551 (if (let ((old-point (point)))
552 (save-excursion
553 (goto-char (window-start))
554 (vertical-motion (window-height))
555 (< (point) old-point)))
556 (progn
557 (overlay-recenter (point))
558 (recenter -3)))))
559
560
561;;;;;;;;;;;;;;;;;;;;
562;;;;;; backwards and mark
563;;;;;;;;;;;;;;;;;;;;
564
565(defun backward-char-mark (&optional arg)
566"Ensure mark is active; move point left ARG characters (right if ARG negative).
567On attempt to pass beginning or end of buffer, stop and signal error."
568 (interactive "p")
e85c6b7c 569 (pc-select-ensure-mark)
215e89e5
RS
570 (backward-char arg))
571
572(defun backward-word-mark (&optional arg)
573 "Ensure mark is active; move backward until encountering the end of a word.
574With argument, do this that many times."
575 (interactive "p")
e85c6b7c 576 (pc-select-ensure-mark)
215e89e5
RS
577 (backward-word arg))
578
b50c87ee
KH
579(defun backward-sexp-mark (&optional arg)
580 "Ensure mark is active; move backward across one balanced expression (sexp).
581With argument, do it that many times. Negative arg -N means
582move forward across N balanced expressions."
583 (interactive "p")
e85c6b7c 584 (pc-select-ensure-mark)
b50c87ee
KH
585 (backward-sexp arg))
586
215e89e5
RS
587(defun backward-paragraph-mark (&optional arg)
588 "Ensure mark is active; move backward to start of paragraph.
20c5a87d
RS
589With arg N, do it N times; negative arg -N means move forward N paragraphs.
590
215e89e5
RS
591A paragraph start is the beginning of a line which is a
592`first-line-of-paragraph' or which is ordinary text and follows a
593paragraph-separating line; except: if the first real line of a
594paragraph is preceded by a blank line, the paragraph starts at that
20c5a87d
RS
595blank line.
596
215e89e5
RS
597See `forward-paragraph' for more information."
598 (interactive "p")
e85c6b7c 599 (pc-select-ensure-mark)
215e89e5
RS
600 (backward-paragraph arg))
601
602(defun previous-line-mark (&optional arg)
603 "Ensure mark is active; move cursor vertically up ARG lines.
604If there is no character in the target line exactly over the current column,
605the cursor is positioned after the character in that line which spans this
20c5a87d
RS
606column, or at the end of the line if it is not long enough.
607
fd4e5923 608The command \\[set-goal-column] can be used to create
215e89e5 609a semipermanent goal column to which this command always moves.
20c5a87d
RS
610Then it does not try to move vertically.
611
215e89e5
RS
612If you are thinking of using this in a Lisp program, consider using
613`forward-line' with a negative argument instead. It is usually easier
614to use and more reliable (no dependence on goal column, etc.)."
615 (interactive "p")
e85c6b7c 616 (pc-select-ensure-mark)
3fe5c37a 617 (with-no-warnings (previous-line arg))
14dacacd 618 (setq this-command 'previous-line))
215e89e5
RS
619
620(defun beginning-of-line-mark (&optional arg)
621 "Ensure mark is active; move point to beginning of current line.
622With argument ARG not nil or 1, move forward ARG - 1 lines first.
623If scan reaches end of buffer, stop there without error."
624 (interactive "p")
e85c6b7c 625 (pc-select-ensure-mark)
215e89e5
RS
626 (beginning-of-line arg))
627
628
629(defun scroll-up-mark (&optional arg)
630"Ensure mark is active; scroll upward ARG lines; or near full screen if no ARG.
631A near full screen is `next-screen-context-lines' less than a full screen.
632Negative ARG means scroll downward.
633When calling from a program, supply a number as argument or nil."
634 (interactive "P")
e85c6b7c 635 (pc-select-ensure-mark)
2a811501
RS
636 (cond (pc-select-override-scroll-error
637 (condition-case nil (scroll-up arg)
638 (end-of-buffer (goto-char (point-max)))))
639 (t (scroll-up arg))))
215e89e5
RS
640
641(defun beginning-of-buffer-mark (&optional arg)
642 "Ensure mark is active; move point to the beginning of the buffer.
20c5a87d
RS
643With arg N, put point N/10 of the way from the beginning.
644
215e89e5 645If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
646of the accessible part of the buffer.
647
215e89e5
RS
648Don't use this command in Lisp programs!
649\(goto-char (p\oint-min)) is faster and avoids clobbering the mark."
650 (interactive "P")
e85c6b7c 651 (pc-select-ensure-mark)
215e89e5
RS
652 (let ((size (- (point-max) (point-min))))
653 (goto-char (if arg
654 (+ (point-min)
655 (if (> size 10000)
656 ;; Avoid overflow for large buffer sizes!
657 (* (prefix-numeric-value arg)
658 (/ size 10))
659 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
660 (point-min))))
661 (if arg (forward-line 1)))
662
663;;;;;;;;
664;;; no mark
665;;;;;;;;
666
667(defun backward-char-nomark (&optional arg)
668 "Deactivate mark; move point left ARG characters (right if ARG negative).
669On attempt to pass beginning or end of buffer, stop and signal error."
670 (interactive "p")
e85c6b7c 671 (pc-select-maybe-deactivate-mark)
215e89e5
RS
672 (backward-char arg))
673
674(defun backward-word-nomark (&optional arg)
675 "Deactivate mark; move backward until encountering the end of a word.
676With argument, do this that many times."
677 (interactive "p")
e85c6b7c 678 (pc-select-maybe-deactivate-mark)
215e89e5
RS
679 (backward-word arg))
680
b50c87ee
KH
681(defun backward-sexp-nomark (&optional arg)
682 "Deactivate mark; move backward across one balanced expression (sexp).
683With argument, do it that many times. Negative arg -N means
684move forward across N balanced expressions."
685 (interactive "p")
e85c6b7c 686 (pc-select-maybe-deactivate-mark)
b50c87ee
KH
687 (backward-sexp arg))
688
215e89e5
RS
689(defun backward-paragraph-nomark (&optional arg)
690 "Deactivate mark; move backward to start of paragraph.
20c5a87d
RS
691With arg N, do it N times; negative arg -N means move forward N paragraphs.
692
215e89e5
RS
693A paragraph start is the beginning of a line which is a
694`first-line-of-paragraph' or which is ordinary text and follows a
695paragraph-separating line; except: if the first real line of a
696paragraph is preceded by a blank line, the paragraph starts at that
20c5a87d
RS
697blank line.
698
215e89e5
RS
699See `forward-paragraph' for more information."
700 (interactive "p")
e85c6b7c 701 (pc-select-maybe-deactivate-mark)
215e89e5
RS
702 (backward-paragraph arg))
703
704(defun previous-line-nomark (&optional arg)
705 "Deactivate mark; move cursor vertically up ARG lines.
706If there is no character in the target line exactly over the current column,
707the cursor is positioned after the character in that line which spans this
20c5a87d
RS
708column, or at the end of the line if it is not long enough.
709
fd4e5923 710The command \\[set-goal-column] can be used to create
215e89e5
RS
711a semipermanent goal column to which this command always moves.
712Then it does not try to move vertically."
713 (interactive "p")
e85c6b7c 714 (pc-select-maybe-deactivate-mark)
3fe5c37a 715 (with-no-warnings (previous-line arg))
14dacacd 716 (setq this-command 'previous-line))
215e89e5
RS
717
718(defun beginning-of-line-nomark (&optional arg)
719 "Deactivate mark; move point to beginning of current line.
720With argument ARG not nil or 1, move forward ARG - 1 lines first.
721If scan reaches end of buffer, stop there without error."
722 (interactive "p")
e85c6b7c 723 (pc-select-maybe-deactivate-mark)
215e89e5
RS
724 (beginning-of-line arg))
725
726(defun scroll-up-nomark (&optional arg)
727 "Deactivate mark; scroll upward ARG lines; or near full screen if no ARG.
728A near full screen is `next-screen-context-lines' less than a full screen.
729Negative ARG means scroll downward.
730When calling from a program, supply a number as argument or nil."
731 (interactive "P")
e85c6b7c 732 (pc-select-maybe-deactivate-mark)
2a811501
RS
733 (cond (pc-select-override-scroll-error
734 (condition-case nil (scroll-up arg)
735 (end-of-buffer (goto-char (point-max)))))
736 (t (scroll-up arg))))
215e89e5
RS
737
738(defun beginning-of-buffer-nomark (&optional arg)
739 "Deactivate mark; move point to the beginning of the buffer.
20c5a87d
RS
740With arg N, put point N/10 of the way from the beginning.
741
215e89e5 742If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
743of the accessible part of the buffer.
744
215e89e5 745Don't use this command in Lisp programs!
14dacacd 746\(goto-char (point-min)) is faster and avoids clobbering the mark."
215e89e5 747 (interactive "P")
e85c6b7c 748 (pc-select-maybe-deactivate-mark)
215e89e5
RS
749 (let ((size (- (point-max) (point-min))))
750 (goto-char (if arg
751 (+ (point-min)
752 (if (> size 10000)
753 ;; Avoid overflow for large buffer sizes!
754 (* (prefix-numeric-value arg)
755 (/ size 10))
756 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
757 (point-min))))
758 (if arg (forward-line 1)))
759
cb96f094
RS
760
761(defun pc-select-define-keys (alist keymap)
762 "Make KEYMAP have the key bindings specified in ALIST."
763 (let ((lst alist))
764 (while lst
765 (define-key keymap (caar lst) (cdar lst))
766 (setq lst (cdr lst)))))
767
768(defun pc-select-restore-keys (alist keymap saved-map)
769 "Use ALIST to restore key bindings from SAVED-MAP into KEYMAP.
770Go through all the key bindings in ALIST, and, for each key
771binding, if KEYMAP and ALIST still agree on the key binding,
772restore the previous value of that key binding from SAVED-MAP."
773 (let ((lst alist))
774 (while lst
775 (when (equal (lookup-key keymap (caar lst)) (cdar lst))
776 (define-key keymap (caar lst) (lookup-key saved-map (caar lst))))
777 (setq lst (cdr lst)))))
778
779(defmacro pc-select-add-to-alist (alist var val)
780 "Ensure that ALIST contains the cons cell (VAR . VAL).
781If a cons cell whose car is VAR is already on the ALIST, update the
a1506d29 782cdr of that cell with VAL. Otherwise, make a new cons cell
cb96f094
RS
783\(VAR . VAL), and prepend it onto ALIST."
784 (let ((elt (make-symbol "elt")))
785 `(let ((,elt (assq ',var ,alist)))
786 (if ,elt
787 (setcdr ,elt ,val)
788 (setq ,alist (cons (cons ',var ,val) ,alist))))))
789
790(defmacro pc-select-save-and-set-var (var newval)
791 "Set VAR to NEWVAL; save the old value.
792The old value is saved on the `pc-select-saved-settings-alist'."
793 `(when (boundp ',var)
024ab5b5
RS
794 (pc-select-add-to-alist pc-select-saved-settings-alist ,var ,var)
795 (setq ,var ,newval)))
cb96f094
RS
796
797(defmacro pc-select-save-and-set-mode (mode &optional arg mode-var)
798 "Call the function MODE; save the old value of the variable MODE.
799MODE is presumed to be a function which turns on a minor mode. First,
800save the value of the variable MODE on `pc-select-saved-settings-alist'.
801Then, if ARG is specified, call MODE with ARG, otherwise call it with
802nil as an argument. If MODE-VAR is specified, save the value of the
803variable MODE-VAR (instead of the value of the variable MODE) on
804`pc-select-saved-settings-alist'."
024ab5b5
RS
805 (unless mode-var (setq mode-var mode))
806 `(when (fboundp ',mode)
807 (pc-select-add-to-alist pc-select-saved-settings-alist
808 ,mode-var ,mode-var)
809 (,mode ,arg)))
cb96f094
RS
810
811(defmacro pc-select-restore-var (var)
a1506d29 812 "Restore the previous value of the variable VAR.
cb96f094
RS
813Look up VAR's previous value in `pc-select-saved-settings-alist', and,
814if the value is found, set VAR to that value."
815 (let ((elt (make-symbol "elt")))
816 `(let ((,elt (assq ',var pc-select-saved-settings-alist)))
817 (unless (null ,elt)
818 (setq ,var (cdr ,elt))))))
819
820(defmacro pc-select-restore-mode (mode)
821 "Restore the previous state (either on or off) of the minor mode MODE.
822Look up the value of the variable MODE on `pc-select-saved-settings-alist'.
823If the value is non-nil, call the function MODE with an argument of
8241, otherwise call it with an argument of -1."
825 (let ((elt (make-symbol "elt")))
826 `(when (fboundp ',mode)
827 (let ((,elt (assq ',mode pc-select-saved-settings-alist)))
828 (unless (null ,elt)
024ab5b5 829 (,mode (if (cdr ,elt) 1 -1)))))))
cb96f094
RS
830
831
3eeb7b9f 832;;;###autoload
cb96f094 833(define-minor-mode pc-selection-mode
ca088b04 834 "Change mark behavior to emulate Motif, MAC or MS-Windows cut and paste style.
20c5a87d
RS
835
836This mode enables Delete Selection mode and Transient Mark mode.
837
838The arrow keys (and others) are bound to new functions
839which modify the status of the mark.
840
841The ordinary arrow keys disable the mark.
842The shift-arrow keys move, leaving the mark behind.
843
844C-LEFT and C-RIGHT move back or forward one word, disabling the mark.
845S-C-LEFT and S-C-RIGHT move back or forward one word, leaving the mark behind.
846
b50c87ee
KH
847M-LEFT and M-RIGHT move back or forward one word or sexp, disabling the mark.
848S-M-LEFT and S-M-RIGHT move back or forward one word or sexp, leaving the mark
fd4e5923
SM
849behind. To control whether these keys move word-wise or sexp-wise set the
850variable `pc-select-meta-moves-sexps' after loading pc-select.el but before
e873bbf9 851turning PC Selection mode on.
b50c87ee 852
20c5a87d
RS
853C-DOWN and C-UP move back or forward a paragraph, disabling the mark.
854S-C-DOWN and S-C-UP move back or forward a paragraph, leaving the mark behind.
855
856HOME moves to beginning of line, disabling the mark.
857S-HOME moves to beginning of line, leaving the mark behind.
858With Ctrl or Meta, these keys move to beginning of buffer instead.
859
860END moves to end of line, disabling the mark.
861S-END moves to end of line, leaving the mark behind.
862With Ctrl or Meta, these keys move to end of buffer instead.
863
864PRIOR or PAGE-UP scrolls and disables the mark.
865S-PRIOR or S-PAGE-UP scrolls and leaves the mark behind.
866
867S-DELETE kills the region (`kill-region').
868S-INSERT yanks text from the kill ring (`yank').
869C-INSERT copies the region into the kill ring (`copy-region-as-kill').
870
b50c87ee 871In addition, certain other PC bindings are imitated (to avoid this, set
fd4e5923 872the variable `pc-select-selection-keys-only' to t after loading pc-select.el
e873bbf9 873but before calling PC Selection mode):
fd4e5923 874
cb96f094
RS
875 F6 other-window
876 DELETE delete-char
877 C-DELETE kill-line
878 M-DELETE kill-word
879 C-M-DELETE kill-sexp
880 C-BACKSPACE backward-kill-word
881 M-BACKSPACE undo"
fd4e5923 882 ;; FIXME: bring pc-bindings-mode here ?
cb96f094
RS
883 nil nil nil
884
885 :group 'pc-select
886 :global t
887
888 (if pc-selection-mode
889 (if (null pc-select-key-bindings-alist)
890 (progn
93e92186 891 (setq pc-select-saved-global-map (copy-keymap (current-global-map)))
cb96f094
RS
892 (setq pc-select-key-bindings-alist
893 (append pc-select-default-key-bindings
894 (if pc-select-selection-keys-only
895 nil
896 pc-select-extra-key-bindings)
897 (if pc-select-meta-moves-sexps
898 (car pc-select-meta-moves-sexps-key-bindings)
899 (cadr pc-select-meta-moves-sexps-key-bindings))
900 (if (or pc-select-selection-keys-only
901 (eq window-system 'x)
902 (memq system-name '(ms-dos windows-nt)))
903 nil
904 pc-select-tty-key-bindings)))
905
93e92186
RS
906 (pc-select-define-keys pc-select-key-bindings-alist
907 (current-global-map))
cb96f094
RS
908
909 (unless (or pc-select-selection-keys-only
910 (eq window-system 'x)
911 (memq system-name '(ms-dos windows-nt)))
912 ;; it is not clear that we need the following line
93e92186 913 ;; I hope it doesn't do too much harm to leave it in, though...
cb96f094
RS
914 (setq pc-select-old-M-delete-binding
915 (lookup-key function-key-map [M-delete]))
916 (define-key function-key-map [M-delete] [?\M-d]))
917
918 (when (and (not pc-select-selection-keys-only)
919 (or (eq window-system 'x)
920 (memq system-name '(ms-dos windows-nt)))
921 (fboundp 'normal-erase-is-backspace-mode))
922 (pc-select-save-and-set-mode normal-erase-is-backspace-mode 1
923 normal-erase-is-backspace))
924 ;; the original author also had this above:
925 ;; (setq-default normal-erase-is-backspace t)
926 ;; However, the documentation for the variable says that
93e92186 927 ;; "setting it with setq has no effect", so I'm removing it.
a1506d29 928
cb96f094
RS
929 (pc-select-save-and-set-var highlight-nonselected-windows nil)
930 (pc-select-save-and-set-var transient-mark-mode t)
931 (pc-select-save-and-set-var mark-even-if-inactive t)
932 (pc-select-save-and-set-mode delete-selection-mode 1))
933 ;;else
934 ;; If the user turned on pc-selection-mode a second time
935 ;; do not clobber the values of the variables that were
936 ;; saved from before pc-selection mode was activated --
937 ;; just make sure the values are the way we like them.
93e92186
RS
938 (pc-select-define-keys pc-select-key-bindings-alist
939 (current-global-map))
cb96f094
RS
940 (unless (or pc-select-selection-keys-only
941 (eq window-system 'x)
942 (memq system-name '(ms-dos windows-nt)))
943 ;; it is not clear that we need the following line
93e92186 944 ;; I hope it doesn't do too much harm to leave it in, though...
cb96f094
RS
945 (define-key function-key-map [M-delete] [?\M-d]))
946 (when (and (not pc-select-selection-keys-only)
947 (or (eq window-system 'x)
948 (memq system-name '(ms-dos windows-nt)))
949 (fboundp 'normal-erase-is-backspace-mode))
fd4e5923 950 (normal-erase-is-backspace-mode 1))
cb96f094
RS
951 (setq highlight-nonselected-windows nil)
952 (setq transient-mark-mode t)
953 (setq mark-even-if-inactive t)
954 (delete-selection-mode 1))
955 ;;else
956 (when pc-select-key-bindings-alist
957 (when (and (not pc-select-selection-keys-only)
958 (or (eq window-system 'x)
959 (memq system-name '(ms-dos windows-nt))))
960 (pc-select-restore-mode normal-erase-is-backspace-mode))
961
cb96f094 962 (pc-select-restore-keys
93e92186
RS
963 pc-select-key-bindings-alist (current-global-map)
964 pc-select-saved-global-map)
cb96f094
RS
965
966 (pc-select-restore-var highlight-nonselected-windows)
967 (pc-select-restore-var transient-mark-mode)
968 (pc-select-restore-var mark-even-if-inactive)
969 (pc-select-restore-mode delete-selection-mode)
970 (and pc-select-old-M-delete-binding
971 (define-key function-key-map [M-delete]
972 pc-select-old-M-delete-binding))
973 (setq pc-select-key-bindings-alist nil
974 pc-select-saved-settings-alist nil))))
a1506d29 975
de299ed7 976;; arch-tag: 10697b70-ae07-4f3e-ad23-7814a3f418c2
215e89e5 977;;; pc-select.el ends here