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