1 ;;; ws-mode.el --- WordStar emulation mode for GNU Emacs
3 ;; Copyright (C) 1991, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
4 ;; 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Juergen Nickelsen <nickel@cs.tu-berlin.de>
8 ;; Keywords: emulations
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This emulates WordStar, with a major mode.
30 (defvar wordstar-C-k-map
31 (let ((map (make-keymap)))
32 (define-key map
" " ())
33 (define-key map
"0" 'ws-set-marker-0
)
34 (define-key map
"1" 'ws-set-marker-1
)
35 (define-key map
"2" 'ws-set-marker-2
)
36 (define-key map
"3" 'ws-set-marker-3
)
37 (define-key map
"4" 'ws-set-marker-4
)
38 (define-key map
"5" 'ws-set-marker-5
)
39 (define-key map
"6" 'ws-set-marker-6
)
40 (define-key map
"7" 'ws-set-marker-7
)
41 (define-key map
"8" 'ws-set-marker-8
)
42 (define-key map
"9" 'ws-set-marker-9
)
43 (define-key map
"b" 'ws-begin-block
)
44 (define-key map
"\C-b" 'ws-begin-block
)
45 (define-key map
"c" 'ws-copy-block
)
46 (define-key map
"\C-c" 'ws-copy-block
)
47 (define-key map
"d" 'save-buffers-kill-emacs
)
48 (define-key map
"\C-d" 'save-buffers-kill-emacs
)
49 (define-key map
"f" 'find-file
)
50 (define-key map
"\C-f" 'find-file
)
51 (define-key map
"h" 'ws-show-markers
)
52 (define-key map
"\C-h" 'ws-show-markers
)
53 (define-key map
"i" 'ws-indent-block
)
54 (define-key map
"\C-i" 'ws-indent-block
)
55 (define-key map
"k" 'ws-end-block
)
56 (define-key map
"\C-k" 'ws-end-block
)
57 (define-key map
"p" 'ws-print-block
)
58 (define-key map
"\C-p" 'ws-print-block
)
59 (define-key map
"q" 'kill-emacs
)
60 (define-key map
"\C-q" 'kill-emacs
)
61 (define-key map
"r" 'insert-file
)
62 (define-key map
"\C-r" 'insert-file
)
63 (define-key map
"s" 'save-some-buffers
)
64 (define-key map
"\C-s" 'save-some-buffers
)
65 (define-key map
"t" 'ws-mark-word
)
66 (define-key map
"\C-t" 'ws-mark-word
)
67 (define-key map
"u" 'ws-exdent-block
)
68 (define-key map
"\C-u" 'keyboard-quit
)
69 (define-key map
"v" 'ws-move-block
)
70 (define-key map
"\C-v" 'ws-move-block
)
71 (define-key map
"w" 'ws-write-block
)
72 (define-key map
"\C-w" 'ws-write-block
)
73 (define-key map
"x" 'save-buffers-kill-emacs
)
74 (define-key map
"\C-x" 'save-buffers-kill-emacs
)
75 (define-key map
"y" 'ws-delete-block
)
76 (define-key map
"\C-y" 'ws-delete-block
)
80 (defvar wordstar-C-o-map
81 (let ((map (make-keymap)))
82 (define-key map
" " ())
83 (define-key map
"c" 'wordstar-center-line
)
84 (define-key map
"\C-c" 'wordstar-center-line
)
85 (define-key map
"b" 'switch-to-buffer
)
86 (define-key map
"\C-b" 'switch-to-buffer
)
87 (define-key map
"j" 'justify-current-line
)
88 (define-key map
"\C-j" 'justify-current-line
)
89 (define-key map
"k" 'kill-buffer
)
90 (define-key map
"\C-k" 'kill-buffer
)
91 (define-key map
"l" 'list-buffers
)
92 (define-key map
"\C-l" 'list-buffers
)
93 (define-key map
"m" 'auto-fill-mode
)
94 (define-key map
"\C-m" 'auto-fill-mode
)
95 (define-key map
"r" 'set-fill-column
)
96 (define-key map
"\C-r" 'set-fill-column
)
97 (define-key map
"\C-u" 'keyboard-quit
)
98 (define-key map
"wd" 'delete-other-windows
)
99 (define-key map
"wh" 'split-window-horizontally
)
100 (define-key map
"wo" 'other-window
)
101 (define-key map
"wv" 'split-window-vertically
)
105 (defvar wordstar-C-q-map
106 (let ((map (make-keymap)))
107 (define-key map
" " ())
108 (define-key map
"0" 'ws-find-marker-0
)
109 (define-key map
"1" 'ws-find-marker-1
)
110 (define-key map
"2" 'ws-find-marker-2
)
111 (define-key map
"3" 'ws-find-marker-3
)
112 (define-key map
"4" 'ws-find-marker-4
)
113 (define-key map
"5" 'ws-find-marker-5
)
114 (define-key map
"6" 'ws-find-marker-6
)
115 (define-key map
"7" 'ws-find-marker-7
)
116 (define-key map
"8" 'ws-find-marker-8
)
117 (define-key map
"9" 'ws-find-marker-9
)
118 (define-key map
"a" 'ws-query-replace
)
119 (define-key map
"\C-a" 'ws-query-replace
)
120 (define-key map
"b" 'ws-goto-block-begin
)
121 (define-key map
"\C-b" 'ws-goto-block-begin
)
122 (define-key map
"c" 'end-of-buffer
)
123 (define-key map
"\C-c" 'end-of-buffer
)
124 (define-key map
"d" 'end-of-line
)
125 (define-key map
"\C-d" 'end-of-line
)
126 (define-key map
"f" 'ws-search
)
127 (define-key map
"\C-f" 'ws-search
)
128 (define-key map
"k" 'ws-goto-block-end
)
129 (define-key map
"\C-k" 'ws-goto-block-end
)
130 (define-key map
"l" 'ws-undo
)
131 (define-key map
"\C-l" 'ws-undo
)
132 (define-key map
"p" 'ws-last-cursorp
)
133 (define-key map
"\C-p" 'ws-last-cursorp
)
134 (define-key map
"r" 'beginning-of-buffer
)
135 (define-key map
"\C-r" 'beginning-of-buffer
)
136 (define-key map
"s" 'beginning-of-line
)
137 (define-key map
"\C-s" 'beginning-of-line
)
138 (define-key map
"\C-u" 'keyboard-quit
)
139 (define-key map
"w" 'ws-last-error
)
140 (define-key map
"\C-w" 'ws-last-error
)
141 (define-key map
"y" 'ws-kill-eol
)
142 (define-key map
"\C-y" 'ws-kill-eol
)
143 (define-key map
"\177" 'ws-kill-bol
)
147 (defvar wordstar-mode-map
148 (let ((map (make-keymap)))
149 (define-key map
"\C-a" 'backward-word
)
150 (define-key map
"\C-b" 'fill-paragraph
)
151 (define-key map
"\C-c" 'scroll-up
)
152 (define-key map
"\C-d" 'forward-char
)
153 (define-key map
"\C-e" 'previous-line
)
154 (define-key map
"\C-f" 'forward-word
)
155 (define-key map
"\C-g" 'delete-char
)
156 (define-key map
"\C-h" 'backward-char
)
157 (define-key map
"\C-i" 'indent-for-tab-command
)
158 (define-key map
"\C-j" 'help-for-help
)
159 (define-key map
"\C-k" wordstar-C-k-map
)
160 (define-key map
"\C-l" 'ws-repeat-search
)
161 (define-key map
"\C-n" 'open-line
)
162 (define-key map
"\C-o" wordstar-C-o-map
)
163 (define-key map
"\C-p" 'quoted-insert
)
164 (define-key map
"\C-q" wordstar-C-q-map
)
165 (define-key map
"\C-r" 'scroll-down
)
166 (define-key map
"\C-s" 'backward-char
)
167 (define-key map
"\C-t" 'kill-word
)
168 (define-key map
"\C-u" 'keyboard-quit
)
169 (define-key map
"\C-v" 'overwrite-mode
)
170 (define-key map
"\C-w" 'scroll-down-line
)
171 (define-key map
"\C-x" 'next-line
)
172 (define-key map
"\C-y" 'kill-complete-line
)
173 (define-key map
"\C-z" 'scroll-up-line
)
177 ;; wordstar-C-j-map not yet implemented
178 (defvar wordstar-C-j-map nil
"")
181 (put 'wordstar-mode
'mode-class
'special
)
184 (defun wordstar-mode ()
185 "Major mode with WordStar-like key bindings.
188 - Help menus with WordStar commands (C-j just calls help-for-help)
190 - Options for search and replace
191 - Show markers (C-k h) is somewhat strange
192 - Search and replace (C-q a) is only available in forward direction
194 No key bindings beginning with ESC are installed, they will work
197 The key bindings are:
207 C-i indent-for-tab-command
220 C-y kill-complete-line
223 C-k 0 ws-set-marker-0
224 C-k 1 ws-set-marker-1
225 C-k 2 ws-set-marker-2
226 C-k 3 ws-set-marker-3
227 C-k 4 ws-set-marker-4
228 C-k 5 ws-set-marker-5
229 C-k 6 ws-set-marker-6
230 C-k 7 ws-set-marker-7
231 C-k 8 ws-set-marker-8
232 C-k 9 ws-set-marker-9
235 C-k d save-buffers-kill-emacs
237 C-k h ws-show-markers
238 C-k i ws-indent-block
243 C-k s save-some-buffers
245 C-k u ws-exdent-block
246 C-k C-u keyboard-quit
250 C-k y ws-delete-block
252 C-o c wordstar-center-line
253 C-o b switch-to-buffer
254 C-o j justify-current-line
258 C-o r set-fill-column
259 C-o C-u keyboard-quit
260 C-o wd delete-other-windows
261 C-o wh split-window-horizontally
263 C-o wv split-window-vertically
265 C-q 0 ws-find-marker-0
266 C-q 1 ws-find-marker-1
267 C-q 2 ws-find-marker-2
268 C-q 3 ws-find-marker-3
269 C-q 4 ws-find-marker-4
270 C-q 5 ws-find-marker-5
271 C-q 6 ws-find-marker-6
272 C-q 7 ws-find-marker-7
273 C-q 8 ws-find-marker-8
274 C-q 9 ws-find-marker-9
275 C-q a ws-query-replace
276 C-q b ws-to-block-begin
280 C-q k ws-to-block-end
282 C-q p ws-last-cursorp
283 C-q r beginning-of-buffer
284 C-q C-u keyboard-quit
290 (kill-all-local-variables)
291 (use-local-map wordstar-mode-map
)
292 (setq mode-name
"WordStar")
293 (setq major-mode
'wordstar-mode
)
294 (run-mode-hooks 'wordstar-mode-hook
))
297 (defun wordstar-center-paragraph ()
298 "Center each line in the paragraph at or after point.
299 See `wordstar-center-line' for more info."
303 (or (bolp) (newline 1))
306 (wordstar-center-region (point) end
))))
308 (defun wordstar-center-region (from to
)
309 "Center each line starting in the region.
310 See `wordstar-center-line' for more info."
314 (setq to from from tem
)))
317 (narrow-to-region from to
)
320 (wordstar-center-line)
323 (defun wordstar-center-line ()
324 "Center the line point is on, within the width specified by `fill-column'.
325 This means adjusting the indentation to match
326 the distance between the end of the text and `fill-column'."
331 (delete-horizontal-space)
333 (delete-horizontal-space)
334 (setq line-length
(current-column))
338 (/ (- fill-column left-margin line-length
) 2))))))
341 ;; wordstar special variables:
343 (defvar ws-marker-0 nil
"Position marker 0 in WordStar mode.")
344 (defvar ws-marker-1 nil
"Position marker 1 in WordStar mode.")
345 (defvar ws-marker-2 nil
"Position marker 2 in WordStar mode.")
346 (defvar ws-marker-3 nil
"Position marker 3 in WordStar mode.")
347 (defvar ws-marker-4 nil
"Position marker 4 in WordStar mode.")
348 (defvar ws-marker-5 nil
"Position marker 5 in WordStar mode.")
349 (defvar ws-marker-6 nil
"Position marker 6 in WordStar mode.")
350 (defvar ws-marker-7 nil
"Position marker 7 in WordStar mode.")
351 (defvar ws-marker-8 nil
"Position marker 8 in WordStar mode.")
352 (defvar ws-marker-9 nil
"Position marker 9 in WordStar mode.")
354 (defvar ws-block-begin-marker nil
"Beginning of \"Block\" in WordStar mode.")
355 (defvar ws-block-end-marker nil
"End of \"Block\" in WordStar mode.")
357 (defvar ws-search-string nil
"String of last search in WordStar mode.")
358 (defvar ws-search-direction t
359 "Direction of last search in WordStar mode. t if forward, nil if backward.")
361 (defvar ws-last-cursorposition nil
362 "Position before last search etc. in WordStar mode.")
364 (defvar ws-last-errormessage nil
365 "Last error message issued by a WordStar mode function.")
368 ;; wordstar special functions:
370 (defun ws-error (string)
371 "Report error of a WordStar special function. Error message is saved
372 in ws-last-errormessage for recovery with C-q w."
373 (setq ws-last-errormessage string
)
376 (defun ws-set-marker-0 ()
377 "In WordStar mode: Set marker 0 to current cursor position."
379 (setq ws-marker-0
(point-marker))
380 (message "Marker 0 set"))
382 (defun ws-set-marker-1 ()
383 "In WordStar mode: Set marker 1 to current cursor position."
385 (setq ws-marker-1
(point-marker))
386 (message "Marker 1 set"))
388 (defun ws-set-marker-2 ()
389 "In WordStar mode: Set marker 2 to current cursor position."
391 (setq ws-marker-2
(point-marker))
392 (message "Marker 2 set"))
394 (defun ws-set-marker-3 ()
395 "In WordStar mode: Set marker 3 to current cursor position."
397 (setq ws-marker-3
(point-marker))
398 (message "Marker 3 set"))
400 (defun ws-set-marker-4 ()
401 "In WordStar mode: Set marker 4 to current cursor position."
403 (setq ws-marker-4
(point-marker))
404 (message "Marker 4 set"))
406 (defun ws-set-marker-5 ()
407 "In WordStar mode: Set marker 5 to current cursor position."
409 (setq ws-marker-5
(point-marker))
410 (message "Marker 5 set"))
412 (defun ws-set-marker-6 ()
413 "In WordStar mode: Set marker 6 to current cursor position."
415 (setq ws-marker-6
(point-marker))
416 (message "Marker 6 set"))
418 (defun ws-set-marker-7 ()
419 "In WordStar mode: Set marker 7 to current cursor position."
421 (setq ws-marker-7
(point-marker))
422 (message "Marker 7 set"))
424 (defun ws-set-marker-8 ()
425 "In WordStar mode: Set marker 8 to current cursor position."
427 (setq ws-marker-8
(point-marker))
428 (message "Marker 8 set"))
430 (defun ws-set-marker-9 ()
431 "In WordStar mode: Set marker 9 to current cursor position."
433 (setq ws-marker-9
(point-marker))
434 (message "Marker 9 set"))
436 (defun ws-begin-block ()
437 "In WordStar mode: Set block begin marker to current cursor position."
439 (setq ws-block-begin-marker
(point-marker))
440 (message "Block begin marker set"))
442 (defun ws-show-markers ()
443 "In WordStar mode: Show block markers."
445 (if (or ws-block-begin-marker ws-block-end-marker
)
447 (if ws-block-begin-marker
449 (goto-char ws-block-begin-marker
)
450 (message "Block begin marker")
452 (message "Block begin marker not set")
454 (if ws-block-end-marker
456 (goto-char ws-block-end-marker
)
457 (message "Block end marker")
459 (message "Block end marker not set"))
461 (message "Block markers not set")))
464 (defun ws-indent-block ()
465 "In WordStar mode: Indent block (not yet implemented)."
467 (ws-error "Indent block not yet implemented"))
469 (defun ws-end-block ()
470 "In WordStar mode: Set block end marker to current cursor position."
472 (setq ws-block-end-marker
(point-marker))
473 (message "Block end marker set"))
475 (defun ws-print-block ()
476 "In WordStar mode: Print block."
478 (message "Don't do this. Write block to a file (C-k w) and print this file."))
480 (defun ws-mark-word ()
481 "In WordStar mode: Mark current word as block."
491 (defun ws-exdent-block ()
492 "I don't know what this (C-k u) should do."
494 (ws-error "This won't be done -- not yet implemented."))
496 (defun ws-move-block ()
497 "In WordStar mode: Move block to current cursor position."
499 (if (and ws-block-begin-marker ws-block-end-marker
)
501 (kill-region ws-block-begin-marker ws-block-end-marker
)
504 (goto-char (region-beginning))
505 (setq ws-block-begin-marker
(point-marker))
506 (goto-char (region-end))
507 (setq ws-block-end-marker
(point-marker))))
508 (ws-error (cond (ws-block-begin-marker "Block end marker not set")
509 (ws-block-end-marker "Block begin marker not set")
510 (t "Block markers not set")))))
512 (defun ws-write-block ()
513 "In WordStar mode: Write block to file."
515 (if (and ws-block-begin-marker ws-block-end-marker
)
516 (let ((filename (read-file-name "Write block to file: ")))
517 (write-region ws-block-begin-marker ws-block-end-marker filename
))
518 (ws-error (cond (ws-block-begin-marker "Block end marker not set")
519 (ws-block-end-marker "Block begin marker not set")
520 (t "Block markers not set")))))
523 (defun ws-delete-block ()
524 "In WordStar mode: Delete block."
526 (if (and ws-block-begin-marker ws-block-end-marker
)
528 (kill-region ws-block-begin-marker ws-block-end-marker
)
529 (setq ws-block-end-marker nil
)
530 (setq ws-block-begin-marker nil
))
531 (ws-error (cond (ws-block-begin-marker "Block end marker not set")
532 (ws-block-end-marker "Block begin marker not set")
533 (t "Block markers not set")))))
535 (defun ws-find-marker-0 ()
536 "In WordStar mode: Go to marker 0."
540 (setq ws-last-cursorposition
(point-marker))
541 (goto-char ws-marker-0
))
542 (ws-error "Marker 0 not set")))
544 (defun ws-find-marker-1 ()
545 "In WordStar mode: Go to marker 1."
549 (setq ws-last-cursorposition
(point-marker))
550 (goto-char ws-marker-1
))
551 (ws-error "Marker 1 not set")))
553 (defun ws-find-marker-2 ()
554 "In WordStar mode: Go to marker 2."
558 (setq ws-last-cursorposition
(point-marker))
559 (goto-char ws-marker-2
))
560 (ws-error "Marker 2 not set")))
562 (defun ws-find-marker-3 ()
563 "In WordStar mode: Go to marker 3."
567 (setq ws-last-cursorposition
(point-marker))
568 (goto-char ws-marker-3
))
569 (ws-error "Marker 3 not set")))
571 (defun ws-find-marker-4 ()
572 "In WordStar mode: Go to marker 4."
576 (setq ws-last-cursorposition
(point-marker))
577 (goto-char ws-marker-4
))
578 (ws-error "Marker 4 not set")))
580 (defun ws-find-marker-5 ()
581 "In WordStar mode: Go to marker 5."
585 (setq ws-last-cursorposition
(point-marker))
586 (goto-char ws-marker-5
))
587 (ws-error "Marker 5 not set")))
589 (defun ws-find-marker-6 ()
590 "In WordStar mode: Go to marker 6."
594 (setq ws-last-cursorposition
(point-marker))
595 (goto-char ws-marker-6
))
596 (ws-error "Marker 6 not set")))
598 (defun ws-find-marker-7 ()
599 "In WordStar mode: Go to marker 7."
603 (setq ws-last-cursorposition
(point-marker))
604 (goto-char ws-marker-7
))
605 (ws-error "Marker 7 not set")))
607 (defun ws-find-marker-8 ()
608 "In WordStar mode: Go to marker 8."
612 (setq ws-last-cursorposition
(point-marker))
613 (goto-char ws-marker-8
))
614 (ws-error "Marker 8 not set")))
616 (defun ws-find-marker-9 ()
617 "In WordStar mode: Go to marker 9."
621 (setq ws-last-cursorposition
(point-marker))
622 (goto-char ws-marker-9
))
623 (ws-error "Marker 9 not set")))
625 (defun ws-goto-block-begin ()
626 "In WordStar mode: Go to block begin marker."
628 (if ws-block-begin-marker
630 (setq ws-last-cursorposition
(point-marker))
631 (goto-char ws-block-begin-marker
))
632 (ws-error "Block begin marker not set")))
634 (defun ws-search (string)
635 "In WordStar mode: Search string, remember string for repetition."
636 (interactive "sSearch for: ")
637 (message "Forward (f) or backward (b)")
640 (cond ((equal (upcase direction
) ?F
)
641 (setq ws-search-string string
)
642 (setq ws-search-direction t
)
643 (setq ws-last-cursorposition
(point-marker))
644 (search-forward string
))
645 ((equal (upcase direction
) ?B
)
646 (setq ws-search-string string
)
647 (setq ws-search-direction nil
)
648 (setq ws-last-cursorposition
(point-marker))
649 (search-backward string
))
650 (t (keyboard-quit)))))
652 (defun ws-goto-block-end ()
653 "In WordStar mode: Go to block end marker."
655 (if ws-block-end-marker
657 (setq ws-last-cursorposition
(point-marker))
658 (goto-char ws-block-end-marker
))
659 (ws-error "Block end marker not set")))
662 "In WordStar mode: Undo and give message about undoing more changes."
665 (message "Repeat C-q l to undo more changes."))
667 (defun ws-goto-last-cursorposition ()
670 (if ws-last-cursorposition
672 (setq ws-last-cursorposition
(point-marker))
673 (goto-char ws-last-cursorposition
))
674 (ws-error "No last cursor position available.")))
676 (defun ws-last-error ()
677 "In WordStar mode: repeat last error message.
678 This will only work for errors raised by WordStar mode functions."
680 (if ws-last-errormessage
681 (message "%s" ws-last-errormessage
)
682 (message "No WordStar error yet.")))
684 (defun ws-kill-eol ()
685 "In WordStar mode: Kill to end of line (like WordStar, not like Emacs)."
689 (kill-region p
(point))))
691 (defun ws-kill-bol ()
692 "In WordStar mode: Kill to beginning of line
693 \(like WordStar, not like Emacs)."
697 (kill-region (point) p
)))
699 (defun kill-complete-line ()
700 "Kill the complete line."
703 (if (eobp) (error "End of buffer"))
706 (kill-region beg
(point))))
708 (defun ws-repeat-search ()
709 "In WordStar mode: Repeat last search."
711 (setq ws-last-cursorposition
(point-marker))
713 (if ws-search-direction
714 (search-forward ws-search-string
)
715 (search-backward ws-search-string
))
716 (ws-error "No search to repeat")))
718 (defun ws-query-replace (from to
)
719 "In WordStar mode: Search string, remember string for repetition."
720 (interactive "sReplace:
722 (setq ws-search-string from
)
723 (setq ws-search-direction t
)
724 (setq ws-last-cursorposition
(point-marker))
725 (query-replace from to
))
727 (defun ws-copy-block ()
728 "In WordStar mode: Copy block to current cursor position."
730 (if (and ws-block-begin-marker ws-block-end-marker
)
732 (copy-region-as-kill ws-block-begin-marker ws-block-end-marker
)
735 (goto-char (region-beginning))
736 (setq ws-block-begin-marker
(point-marker))
737 (goto-char (region-end))
738 (setq ws-block-end-marker
(point-marker))))
739 (ws-error (cond (ws-block-begin-marker "Block end marker not set")
740 (ws-block-end-marker "Block begin marker not set")
741 (t "Block markers not set")))))
745 ;; arch-tag: 6dd864bf-2ccb-4d59-af6e-492eba2890a3
746 ;;; ws-mode.el ends here