new version
[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
b50c87ee 5;; Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
215e89e5
RS
6
7;; Author: Michael Staats <michael@thp.Uni-Duisburg.DE>
8;; Created: 26 Sep 1995
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
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
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
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;;
38;; In addition to that all key-bindings from the pc-mode are
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
KH
60;; Eli Barzilay (eli@cs.bgu.ac.il) suggested the sexps functions and
61;; keybindings.
215e89e5
RS
62;;
63;; Ok, some details about the idea of pc-selection-mode:
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
20c5a87d 79;;;; Customization:
83d1d58c
RS
80(defgroup pc-select nil
81 "Emulate pc bindings."
82 :prefix "pc-select"
83 :group 'editing-basics)
20c5a87d 84
83d1d58c 85(defcustom pc-select-override-scroll-error t
20c5a87d
RS
86 "*Non-nil means don't generate error on scrolling past edge of buffer.
87This variable applies in PC Selection mode only.
88The scroll commands normally generate an error if you try to scroll
89past the top or bottom of the buffer. This is annoying when selecting
90text with these commands. If you set this variable to non-nil, these
83d1d58c
RS
91errors are suppressed."
92 :type 'boolean
93 :group 'pc-select)
215e89e5 94
83d1d58c 95(defcustom pc-select-selection-keys-only nil
b50c87ee
KH
96 "*Non-nil means only bind the basic selection keys when started.
97Other keys that emulate pc-behavior will be untouched.
83d1d58c
RS
98This gives mostly Emacs-like behaviour with only the selection keys enabled."
99 :type 'boolean
100 :group 'pc-select)
b50c87ee 101
83d1d58c
RS
102(defcustom pc-select-meta-moves-sexps nil
103 "*Non-nil means move sexp-wise with Meta key, otherwise move word-wise."
104 :type 'boolean
105 :group 'pc-select)
b50c87ee 106
215e89e5
RS
107;;;;
108;; misc
109;;;;
110
111(provide 'pc-select)
112
113(defun copy-region-as-kill-nomark (beg end)
114 "Save the region as if killed; but don't kill it; deactivate mark.
115If `interprogram-cut-function' is non-nil, also save the text for a window
20c5a87d
RS
116system cut and paste.
117
215e89e5
RS
118Deactivating mark is to avoid confusion with delete-selection-mode
119and transient-mark-mode."
120 (interactive "r")
121 (copy-region-as-kill beg end)
122 (setq mark-active nil)
123 (message "Region saved"))
124
b50c87ee
KH
125(defun exchange-point-and-mark-nomark ()
126 (interactive)
127 (exchange-point-and-mark)
128 (setq mark-active nil))
129
215e89e5
RS
130;;;;
131;; non-interactive
132;;;;
133(defun ensure-mark()
134 ;; make sure mark is active
135 ;; test if it is active, if it isn't, set it and activate it
2a811501 136 (or mark-active (set-mark-command nil)))
215e89e5
RS
137
138;;;;;;;;;;;;;;;;;;;;;;;;;;;
139;;;;; forward and mark
140;;;;;;;;;;;;;;;;;;;;;;;;;;;
141
142(defun forward-char-mark (&optional arg)
143 "Ensure mark is active; move point right ARG characters (left if ARG negative).
144On reaching end of buffer, stop and signal error."
145 (interactive "p")
146 (ensure-mark)
147 (forward-char arg))
148
149(defun forward-word-mark (&optional arg)
150 "Ensure mark is active; move point right ARG words (backward if ARG is negative).
151Normally returns t.
152If an edge of the buffer is reached, point is left there
153and nil is returned."
154 (interactive "p")
155 (ensure-mark)
156 (forward-word arg))
157
20c5a87d
RS
158(defun forward-line-mark (&optional arg)
159 "Ensure mark is active; move cursor vertically down ARG lines."
160 (interactive "p")
161 (ensure-mark)
162 (forward-line arg)
163 (setq this-command 'forward-line)
164)
165
b50c87ee
KH
166(defun forward-sexp-mark (&optional arg)
167 "Ensure mark is active; move forward across one balanced expression (sexp).
168With argument, do it that many times. Negative arg -N means
169move backward across N balanced expressions."
170 (interactive "p")
171 (ensure-mark)
172 (forward-sexp arg))
173
215e89e5
RS
174(defun forward-paragraph-mark (&optional arg)
175 "Ensure mark is active; move forward to end of paragraph.
20c5a87d
RS
176With arg N, do it N times; negative arg -N means move backward N paragraphs.
177
215e89e5 178A line which `paragraph-start' matches either separates paragraphs
14dacacd 179\(if `paragraph-separate' matches it also) or is the first line of a paragraph.
215e89e5
RS
180A paragraph end is the beginning of a line which is not part of the paragraph
181to which the end of the previous line belongs, or the end of the buffer."
182 (interactive "p")
183 (ensure-mark)
184 (forward-paragraph arg))
20c5a87d 185
215e89e5
RS
186(defun next-line-mark (&optional arg)
187 "Ensure mark is active; move cursor vertically down ARG lines.
188If there is no character in the target line exactly under the current column,
189the cursor is positioned after the character in that line which spans this
190column, or at the end of the line if it is not long enough.
191If there is no line in the buffer after this one, behavior depends on the
192value of `next-line-add-newlines'. If non-nil, it inserts a newline character
193to create a line, and moves the cursor to that line. Otherwise it moves the
194cursor to the end of the buffer \(if already at the end of the buffer, an error
20c5a87d
RS
195is signaled).
196
215e89e5
RS
197The command C-x C-n can be used to create
198a semipermanent goal column to which this command always moves.
199Then it does not try to move vertically. This goal column is stored
200in `goal-column', which is nil when there is none."
201 (interactive "p")
202 (ensure-mark)
14dacacd
RS
203 (next-line arg)
204 (setq this-command 'next-line))
215e89e5
RS
205
206(defun end-of-line-mark (&optional arg)
207 "Ensure mark is active; move point to end of current line.
208With argument ARG not nil or 1, move forward ARG - 1 lines first.
209If scan reaches end of buffer, stop there without error."
210 (interactive "p")
211 (ensure-mark)
14dacacd
RS
212 (end-of-line arg)
213 (setq this-command 'end-of-line))
215e89e5 214
20c5a87d
RS
215(defun backward-line-mark (&optional arg)
216 "Ensure mark is active; move cursor vertically up ARG lines."
217 (interactive "p")
218 (ensure-mark)
219 (if (null arg)
220 (setq arg 1))
221 (forward-line (- arg))
222 (setq this-command 'forward-line)
223)
224
215e89e5
RS
225(defun scroll-down-mark (&optional arg)
226 "Ensure mark is active; scroll down ARG lines; or near full screen if no ARG.
227A near full screen is `next-screen-context-lines' less than a full screen.
228Negative ARG means scroll upward.
229When calling from a program, supply a number as argument or nil."
230 (interactive "P")
231 (ensure-mark)
2a811501
RS
232 (cond (pc-select-override-scroll-error
233 (condition-case nil (scroll-down arg)
234 (beginning-of-buffer (goto-char (point-min)))))
235 (t (scroll-down arg))))
215e89e5
RS
236
237(defun end-of-buffer-mark (&optional arg)
238 "Ensure mark is active; move point to the end of the buffer.
20c5a87d
RS
239With arg N, put point N/10 of the way from the end.
240
215e89e5 241If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
242of the accessible part of the buffer.
243
215e89e5
RS
244Don't use this command in Lisp programs!
245\(goto-char \(point-max)) is faster and avoids clobbering the mark."
246 (interactive "P")
247 (ensure-mark)
248 (let ((size (- (point-max) (point-min))))
249 (goto-char (if arg
250 (- (point-max)
251 (if (> size 10000)
252 ;; Avoid overflow for large buffer sizes!
253 (* (prefix-numeric-value arg)
254 (/ size 10))
255 (/ (* size (prefix-numeric-value arg)) 10)))
256 (point-max))))
257 ;; If we went to a place in the middle of the buffer,
258 ;; adjust it to the beginning of a line.
259 (if arg (forward-line 1)
260 ;; If the end of the buffer is not already on the screen,
261 ;; then scroll specially to put it near, but not at, the bottom.
262 (if (let ((old-point (point)))
263 (save-excursion
264 (goto-char (window-start))
265 (vertical-motion (window-height))
266 (< (point) old-point)))
267 (progn
268 (overlay-recenter (point))
269 (recenter -3)))))
270
271;;;;;;;;;
272;;;;; no mark
273;;;;;;;;;
274
275(defun forward-char-nomark (&optional arg)
276 "Deactivate mark; move point right ARG characters \(left if ARG negative).
277On reaching end of buffer, stop and signal error."
278 (interactive "p")
279 (setq mark-active nil)
280 (forward-char arg))
281
282(defun forward-word-nomark (&optional arg)
283 "Deactivate mark; move point right ARG words \(backward if ARG is negative).
284Normally returns t.
285If an edge of the buffer is reached, point is left there
286and nil is returned."
287 (interactive "p")
288 (setq mark-active nil)
289 (forward-word arg))
290
20c5a87d
RS
291(defun forward-line-nomark (&optional arg)
292 "Deactivate mark; move cursor vertically down ARG lines."
293 (interactive "p")
294 (setq mark-active nil)
295 (forward-line arg)
296 (setq this-command 'forward-line)
297)
298
b50c87ee
KH
299(defun forward-sexp-nomark (&optional arg)
300 "Deactivate mark; move forward across one balanced expression (sexp).
301With argument, do it that many times. Negative arg -N means
302move backward across N balanced expressions."
303 (interactive "p")
304 (setq mark-active nil)
305 (forward-sexp arg))
306
215e89e5
RS
307(defun forward-paragraph-nomark (&optional arg)
308 "Deactivate mark; move forward to end of paragraph.
20c5a87d
RS
309With arg N, do it N times; negative arg -N means move backward N paragraphs.
310
215e89e5 311A line which `paragraph-start' matches either separates paragraphs
14dacacd 312\(if `paragraph-separate' matches it also) or is the first line of a paragraph.
215e89e5
RS
313A paragraph end is the beginning of a line which is not part of the paragraph
314to which the end of the previous line belongs, or the end of the buffer."
315 (interactive "p")
316 (setq mark-active nil)
317 (forward-paragraph arg))
318
319(defun next-line-nomark (&optional arg)
320 "Deactivate mark; move cursor vertically down ARG lines.
321If there is no character in the target line exactly under the current column,
322the cursor is positioned after the character in that line which spans this
323column, or at the end of the line if it is not long enough.
324If there is no line in the buffer after this one, behavior depends on the
325value of `next-line-add-newlines'. If non-nil, it inserts a newline character
326to create a line, and moves the cursor to that line. Otherwise it moves the
327cursor to the end of the buffer (if already at the end of the buffer, an error
20c5a87d
RS
328is signaled).
329
215e89e5
RS
330The command C-x C-n can be used to create
331a semipermanent goal column to which this command always moves.
332Then it does not try to move vertically. This goal column is stored
333in `goal-column', which is nil when there is none."
334 (interactive "p")
335 (setq mark-active nil)
14dacacd
RS
336 (next-line arg)
337 (setq this-command 'next-line))
215e89e5
RS
338
339(defun end-of-line-nomark (&optional arg)
340 "Deactivate mark; move point to end of current line.
341With argument ARG not nil or 1, move forward ARG - 1 lines first.
342If scan reaches end of buffer, stop there without error."
343 (interactive "p")
344 (setq mark-active nil)
14dacacd
RS
345 (end-of-line arg)
346 (setq this-command 'end-of-line))
215e89e5 347
20c5a87d
RS
348(defun backward-line-nomark (&optional arg)
349 "Deactivate mark; move cursor vertically up ARG lines."
350 (interactive "p")
351 (setq mark-active nil)
352 (if (null arg)
353 (setq arg 1))
354 (forward-line (- arg))
355 (setq this-command 'forward-line)
356)
357
215e89e5
RS
358(defun scroll-down-nomark (&optional arg)
359 "Deactivate mark; scroll down ARG lines; or near full screen if no ARG.
360A near full screen is `next-screen-context-lines' less than a full screen.
361Negative ARG means scroll upward.
362When calling from a program, supply a number as argument or nil."
363 (interactive "P")
364 (setq mark-active nil)
2a811501
RS
365 (cond (pc-select-override-scroll-error
366 (condition-case nil (scroll-down arg)
367 (beginning-of-buffer (goto-char (point-min)))))
368 (t (scroll-down arg))))
215e89e5
RS
369
370(defun end-of-buffer-nomark (&optional arg)
371 "Deactivate mark; move point to the end of the buffer.
20c5a87d
RS
372With arg N, put point N/10 of the way from the end.
373
215e89e5 374If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
375of the accessible part of the buffer.
376
215e89e5 377Don't use this command in Lisp programs!
14dacacd 378\(goto-char (point-max)) is faster and avoids clobbering the mark."
215e89e5
RS
379 (interactive "P")
380 (setq mark-active nil)
381 (let ((size (- (point-max) (point-min))))
382 (goto-char (if arg
383 (- (point-max)
384 (if (> size 10000)
385 ;; Avoid overflow for large buffer sizes!
386 (* (prefix-numeric-value arg)
387 (/ size 10))
388 (/ (* size (prefix-numeric-value arg)) 10)))
389 (point-max))))
390 ;; If we went to a place in the middle of the buffer,
391 ;; adjust it to the beginning of a line.
392 (if arg (forward-line 1)
393 ;; If the end of the buffer is not already on the screen,
394 ;; then scroll specially to put it near, but not at, the bottom.
395 (if (let ((old-point (point)))
396 (save-excursion
397 (goto-char (window-start))
398 (vertical-motion (window-height))
399 (< (point) old-point)))
400 (progn
401 (overlay-recenter (point))
402 (recenter -3)))))
403
404
405;;;;;;;;;;;;;;;;;;;;
406;;;;;; backwards and mark
407;;;;;;;;;;;;;;;;;;;;
408
409(defun backward-char-mark (&optional arg)
410"Ensure mark is active; move point left ARG characters (right if ARG negative).
411On attempt to pass beginning or end of buffer, stop and signal error."
412 (interactive "p")
413 (ensure-mark)
414 (backward-char arg))
415
416(defun backward-word-mark (&optional arg)
417 "Ensure mark is active; move backward until encountering the end of a word.
418With argument, do this that many times."
419 (interactive "p")
420 (ensure-mark)
421 (backward-word arg))
422
b50c87ee
KH
423(defun backward-sexp-mark (&optional arg)
424 "Ensure mark is active; move backward across one balanced expression (sexp).
425With argument, do it that many times. Negative arg -N means
426move forward across N balanced expressions."
427 (interactive "p")
428 (ensure-mark)
429 (backward-sexp arg))
430
215e89e5
RS
431(defun backward-paragraph-mark (&optional arg)
432 "Ensure mark is active; move backward to start of paragraph.
20c5a87d
RS
433With arg N, do it N times; negative arg -N means move forward N paragraphs.
434
215e89e5
RS
435A paragraph start is the beginning of a line which is a
436`first-line-of-paragraph' or which is ordinary text and follows a
437paragraph-separating line; except: if the first real line of a
438paragraph is preceded by a blank line, the paragraph starts at that
20c5a87d
RS
439blank line.
440
215e89e5
RS
441See `forward-paragraph' for more information."
442 (interactive "p")
443 (ensure-mark)
444 (backward-paragraph arg))
445
446(defun previous-line-mark (&optional arg)
447 "Ensure mark is active; move cursor vertically up ARG lines.
448If there is no character in the target line exactly over the current column,
449the cursor is positioned after the character in that line which spans this
20c5a87d
RS
450column, or at the end of the line if it is not long enough.
451
215e89e5
RS
452The command C-x C-n can be used to create
453a semipermanent goal column to which this command always moves.
20c5a87d
RS
454Then it does not try to move vertically.
455
215e89e5
RS
456If you are thinking of using this in a Lisp program, consider using
457`forward-line' with a negative argument instead. It is usually easier
458to use and more reliable (no dependence on goal column, etc.)."
459 (interactive "p")
460 (ensure-mark)
14dacacd
RS
461 (previous-line arg)
462 (setq this-command 'previous-line))
215e89e5
RS
463
464(defun beginning-of-line-mark (&optional arg)
465 "Ensure mark is active; move point to beginning of current line.
466With argument ARG not nil or 1, move forward ARG - 1 lines first.
467If scan reaches end of buffer, stop there without error."
468 (interactive "p")
469 (ensure-mark)
470 (beginning-of-line arg))
471
472
473(defun scroll-up-mark (&optional arg)
474"Ensure mark is active; scroll upward ARG lines; or near full screen if no ARG.
475A near full screen is `next-screen-context-lines' less than a full screen.
476Negative ARG means scroll downward.
477When calling from a program, supply a number as argument or nil."
478 (interactive "P")
479 (ensure-mark)
2a811501
RS
480 (cond (pc-select-override-scroll-error
481 (condition-case nil (scroll-up arg)
482 (end-of-buffer (goto-char (point-max)))))
483 (t (scroll-up arg))))
215e89e5
RS
484
485(defun beginning-of-buffer-mark (&optional arg)
486 "Ensure mark is active; move point to the beginning of the buffer.
20c5a87d
RS
487With arg N, put point N/10 of the way from the beginning.
488
215e89e5 489If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
490of the accessible part of the buffer.
491
215e89e5
RS
492Don't use this command in Lisp programs!
493\(goto-char (p\oint-min)) is faster and avoids clobbering the mark."
494 (interactive "P")
495 (ensure-mark)
496 (let ((size (- (point-max) (point-min))))
497 (goto-char (if arg
498 (+ (point-min)
499 (if (> size 10000)
500 ;; Avoid overflow for large buffer sizes!
501 (* (prefix-numeric-value arg)
502 (/ size 10))
503 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
504 (point-min))))
505 (if arg (forward-line 1)))
506
507;;;;;;;;
508;;; no mark
509;;;;;;;;
510
511(defun backward-char-nomark (&optional arg)
512 "Deactivate mark; move point left ARG characters (right if ARG negative).
513On attempt to pass beginning or end of buffer, stop and signal error."
514 (interactive "p")
515 (setq mark-active nil)
516 (backward-char arg))
517
518(defun backward-word-nomark (&optional arg)
519 "Deactivate mark; move backward until encountering the end of a word.
520With argument, do this that many times."
521 (interactive "p")
522 (setq mark-active nil)
523 (backward-word arg))
524
b50c87ee
KH
525(defun backward-sexp-nomark (&optional arg)
526 "Deactivate mark; move backward across one balanced expression (sexp).
527With argument, do it that many times. Negative arg -N means
528move forward across N balanced expressions."
529 (interactive "p")
530 (setq mark-active nil)
531 (backward-sexp arg))
532
215e89e5
RS
533(defun backward-paragraph-nomark (&optional arg)
534 "Deactivate mark; move backward to start of paragraph.
20c5a87d
RS
535With arg N, do it N times; negative arg -N means move forward N paragraphs.
536
215e89e5
RS
537A paragraph start is the beginning of a line which is a
538`first-line-of-paragraph' or which is ordinary text and follows a
539paragraph-separating line; except: if the first real line of a
540paragraph is preceded by a blank line, the paragraph starts at that
20c5a87d
RS
541blank line.
542
215e89e5
RS
543See `forward-paragraph' for more information."
544 (interactive "p")
545 (setq mark-active nil)
546 (backward-paragraph arg))
547
548(defun previous-line-nomark (&optional arg)
549 "Deactivate mark; move cursor vertically up ARG lines.
550If there is no character in the target line exactly over the current column,
551the cursor is positioned after the character in that line which spans this
20c5a87d
RS
552column, or at the end of the line if it is not long enough.
553
215e89e5
RS
554The command C-x C-n can be used to create
555a semipermanent goal column to which this command always moves.
556Then it does not try to move vertically."
557 (interactive "p")
558 (setq mark-active nil)
14dacacd
RS
559 (previous-line arg)
560 (setq this-command 'previous-line))
215e89e5
RS
561
562(defun beginning-of-line-nomark (&optional arg)
563 "Deactivate mark; move point to beginning of current line.
564With argument ARG not nil or 1, move forward ARG - 1 lines first.
565If scan reaches end of buffer, stop there without error."
566 (interactive "p")
567 (setq mark-active nil)
568 (beginning-of-line arg))
569
570(defun scroll-up-nomark (&optional arg)
571 "Deactivate mark; scroll upward ARG lines; or near full screen if no ARG.
572A near full screen is `next-screen-context-lines' less than a full screen.
573Negative ARG means scroll downward.
574When calling from a program, supply a number as argument or nil."
575 (interactive "P")
576 (setq mark-active nil)
2a811501
RS
577 (cond (pc-select-override-scroll-error
578 (condition-case nil (scroll-up arg)
579 (end-of-buffer (goto-char (point-max)))))
580 (t (scroll-up arg))))
215e89e5
RS
581
582(defun beginning-of-buffer-nomark (&optional arg)
583 "Deactivate mark; move point to the beginning of the buffer.
20c5a87d
RS
584With arg N, put point N/10 of the way from the beginning.
585
215e89e5 586If the buffer is narrowed, this command uses the beginning and size
20c5a87d
RS
587of the accessible part of the buffer.
588
215e89e5 589Don't use this command in Lisp programs!
14dacacd 590\(goto-char (point-min)) is faster and avoids clobbering the mark."
215e89e5
RS
591 (interactive "P")
592 (setq mark-active nil)
593 (let ((size (- (point-max) (point-min))))
594 (goto-char (if arg
595 (+ (point-min)
596 (if (> size 10000)
597 ;; Avoid overflow for large buffer sizes!
598 (* (prefix-numeric-value arg)
599 (/ size 10))
600 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
601 (point-min))))
602 (if arg (forward-line 1)))
603
3eeb7b9f 604;;;###autoload
215e89e5 605(defun pc-selection-mode ()
20c5a87d
RS
606 "Change mark behaviour to emulate Motif, MAC or MS-Windows cut and paste style.
607
608This mode enables Delete Selection mode and Transient Mark mode.
609
610The arrow keys (and others) are bound to new functions
611which modify the status of the mark.
612
613The ordinary arrow keys disable the mark.
614The shift-arrow keys move, leaving the mark behind.
615
616C-LEFT and C-RIGHT move back or forward one word, disabling the mark.
617S-C-LEFT and S-C-RIGHT move back or forward one word, leaving the mark behind.
618
b50c87ee
KH
619M-LEFT and M-RIGHT move back or forward one word or sexp, disabling the mark.
620S-M-LEFT and S-M-RIGHT move back or forward one word or sexp, leaving the mark
621behind. To control wether these keys move word-wise or sexp-wise set the
622variable pc-select-meta-moves-sexps after loading pc-select.el but before
623turning pc-selection-mode on.
624
20c5a87d
RS
625C-DOWN and C-UP move back or forward a paragraph, disabling the mark.
626S-C-DOWN and S-C-UP move back or forward a paragraph, leaving the mark behind.
627
628HOME moves to beginning of line, disabling the mark.
629S-HOME moves to beginning of line, leaving the mark behind.
630With Ctrl or Meta, these keys move to beginning of buffer instead.
631
632END moves to end of line, disabling the mark.
633S-END moves to end of line, leaving the mark behind.
634With Ctrl or Meta, these keys move to end of buffer instead.
635
636PRIOR or PAGE-UP scrolls and disables the mark.
637S-PRIOR or S-PAGE-UP scrolls and leaves the mark behind.
638
639S-DELETE kills the region (`kill-region').
640S-INSERT yanks text from the kill ring (`yank').
641C-INSERT copies the region into the kill ring (`copy-region-as-kill').
642
b50c87ee
KH
643In addition, certain other PC bindings are imitated (to avoid this, set
644the variable pc-select-selection-keys-only to t after loading pc-select.el
645but before calling pc-selection-mode):
20c5a87d
RS
646
647 F6 other-window
648 DELETE delete-char
649 C-DELETE kill-line
650 M-DELETE kill-word
651 C-M-DELETE kill-sexp
652 C-BACKSPACE backward-kill-word
653 M-BACKSPACE undo"
654
215e89e5
RS
655 (interactive)
656 ;;
657 ;; keybindings
658 ;;
659
660 ;; This is to avoid confusion with the delete-selection-mode
661 ;; On simple displays you can't see that a region is active and
b50c87ee
KH
662 ;; will be deleted on the next keypress. IMHO especially for
663 ;; copy-region-as-kill this is confusing.
664 ;; The same goes for exchange-point-and-mark
215e89e5 665 (define-key global-map "\M-w" 'copy-region-as-kill-nomark)
b50c87ee 666 (define-key global-map "\C-x\C-x" 'exchange-point-and-mark-nomark)
a7acbbe4 667 ;; The following keybindings are for standard ISO keyboards
215e89e5
RS
668 ;; as they are used with IBM compatible PCs, IBM RS/6000,
669 ;; MACs, many X-Stations and probably more
670 (define-key global-map [S-right] 'forward-char-mark)
671 (define-key global-map [right] 'forward-char-nomark)
672 (define-key global-map [C-S-right] 'forward-word-mark)
673 (define-key global-map [C-right] 'forward-word-nomark)
b50c87ee
KH
674 (define-key global-map [S-left] 'backward-char-mark)
675 (define-key global-map [left] 'backward-char-nomark)
676 (define-key global-map [C-S-left] 'backward-word-mark)
677 (define-key global-map [C-left] 'backward-word-nomark)
678 (cond (pc-select-meta-moves-sexps
679 (define-key global-map [M-S-right] 'forward-sexp-mark)
680 (define-key global-map [M-right] 'forward-sexp-nomark)
681 (define-key global-map [M-S-left] 'backward-sexp-mark)
682 (define-key global-map [M-left] 'backward-sexp-nomark))
683 (t
684 (define-key global-map [M-S-right] 'forward-word-mark)
685 (define-key global-map [M-right] 'forward-word-nomark)
686 (define-key global-map [M-S-left] 'backward-word-mark)
687 (define-key global-map [M-left] 'backward-word-nomark)))
215e89e5
RS
688
689 (define-key global-map [S-down] 'next-line-mark)
690 (define-key global-map [down] 'next-line-nomark)
691
692 (define-key global-map [S-end] 'end-of-line-mark)
693 (define-key global-map [end] 'end-of-line-nomark)
694 (global-set-key [S-C-end] 'end-of-buffer-mark)
695 (global-set-key [C-end] 'end-of-buffer-nomark)
14dacacd
RS
696 (global-set-key [S-M-end] 'end-of-buffer-mark)
697 (global-set-key [M-end] 'end-of-buffer-nomark)
215e89e5
RS
698
699 (define-key global-map [S-next] 'scroll-up-mark)
700 (define-key global-map [next] 'scroll-up-nomark)
701
215e89e5
RS
702 (define-key global-map [S-up] 'previous-line-mark)
703 (define-key global-map [up] 'previous-line-nomark)
704
705 (define-key global-map [S-home] 'beginning-of-line-mark)
706 (define-key global-map [home] 'beginning-of-line-nomark)
707 (global-set-key [S-C-home] 'beginning-of-buffer-mark)
708 (global-set-key [C-home] 'beginning-of-buffer-nomark)
14dacacd
RS
709 (global-set-key [S-M-home] 'beginning-of-buffer-mark)
710 (global-set-key [M-home] 'beginning-of-buffer-nomark)
215e89e5 711
20c5a87d
RS
712 (define-key global-map [M-S-down] 'forward-line-mark)
713 (define-key global-map [M-down] 'forward-line-nomark)
714 (define-key global-map [M-S-up] 'backward-line-mark)
715 (define-key global-map [M-up] 'backward-line-nomark)
716
b50c87ee
KH
717 (define-key global-map [S-prior] 'scroll-down-mark)
718 (define-key global-map [prior] 'scroll-down-nomark)
719
720 ;; Next four lines are from Pete Forman.
721 (global-set-key [C-down] 'forward-paragraph-nomark) ; KNextPara cDn
722 (global-set-key [C-up] 'backward-paragraph-nomark) ; KPrevPara cUp
215e89e5
RS
723 (global-set-key [S-C-down] 'forward-paragraph-mark)
724 (global-set-key [S-C-up] 'backward-paragraph-mark)
725
b50c87ee
KH
726 (or pc-select-selection-keys-only
727 (progn
728 (define-key global-map [S-insert] 'yank)
729 (define-key global-map [C-insert] 'copy-region-as-kill)
730 (define-key global-map [S-delete] 'kill-region)
731
732 ;; The following bindings are useful on Sun Type 3 keyboards
733 ;; They implement the Get-Delete-Put (copy-cut-paste)
734 ;; functions from sunview on the L6, L8 and L10 keys
735 ;; Sam Steingold <sds@ptc.com> says that f16 is copy and f18 is paste.
736 (define-key global-map [f16] 'copy-region-as-kill)
737 (define-key global-map [f18] 'yank)
738 (define-key global-map [f20] 'kill-region)
739
740 ;; The following bindings are from Pete Forman.
741 (global-set-key [f6] 'other-window) ; KNextPane F6
742 (global-set-key [delete] 'delete-char) ; KDelete Del
743 (global-set-key [C-delete] 'kill-line) ; KEraseEndLine cDel
744 (global-set-key [M-backspace] 'undo) ; KUndo aBS
745
746 ;; The following bindings are taken from pc-mode.el
747 ;; as suggested by RMS.
748 ;; I only used the ones that are not covered above.
749 (define-key function-key-map [M-delete] [?\M-d])
750 (global-set-key [C-M-delete] 'kill-sexp)
751 (global-set-key [C-backspace] 'backward-kill-word)
752 ;; Next line proposed by Eli Barzilay
753 (global-set-key [C-escape] 'electric-buffer-list)))
215e89e5
RS
754 ;;
755 ;; setup
756 ;;
b50c87ee
KH
757 ;; Next line proposed by Eli Barzilay
758 (setq highlight-nonselected-windows nil)
215e89e5
RS
759 (setq transient-mark-mode t)
760 (setq mark-even-if-inactive t)
20c5a87d 761 (delete-selection-mode 1)
2a811501 762)
83d1d58c
RS
763
764;;;###autoload
765(defcustom pc-selection-mode nil
766 "Toggle PC Selection mode.
767Change mark behaviour to emulate Motif, MAC or MS-Windows cut and paste style,
768and cursor movement commands.
769This mode enables Delete Selection mode and Transient Mark mode.
770You must modify via \\[customize] for this variable to have an effect."
771 :set (lambda (symbol value)
772 (if value (pc-selection-mode)))
773 :type 'boolean
774 :group 'pc-select
775 :require 'pc-select)
776
215e89e5 777;;; pc-select.el ends here