Commit | Line | Data |
---|---|---|
c88ab9ce ER |
1 | ;;; scribe.el --- scribe mode, and its idiosyncratic commands. |
2 | ||
248b25a4 RS |
3 | ;; Copyright (C) 1985 Free Software Foundation, Inc. |
4 | ||
9750e079 | 5 | ;; Maintainer: FSF |
e9571d2a | 6 | ;; Keywords: wp |
9750e079 | 7 | |
248b25a4 RS |
8 | ;; This file might become part of GNU Emacs. |
9 | ||
10 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
11 | ;; but without any warranty. No author or distributor | |
12 | ;; accepts responsibility to anyone for the consequences of using it | |
13 | ;; or for whether it serves any particular purpose or works at all, | |
14 | ;; unless he says so in writing. | |
15 | ||
16 | ;; Everyone is granted permission to copy, modify and redistribute | |
17 | ;; GNU Emacs, but only under the conditions described in the | |
18 | ;; document "GNU Emacs copying permission notice". An exact copy | |
19 | ;; of the document is supposed to have been given to you along with | |
20 | ;; GNU Emacs so that you can know how you may redistribute it all. | |
21 | ;; It should be in a file named COPYING. Among other things, the | |
22 | ;; copyright notice and this notice must be preserved on all copies. | |
23 | ||
d9ecc911 ER |
24 | ;;; Commentary: |
25 | ||
26 | ;; A major mode for editing source in written for the Scribe text formatter. | |
27 | ;; Knows about Scribe syntax and standard layout rules. The command to | |
28 | ;; run Scribe on a buffer is bogus; someone interested should fix it. | |
29 | ||
630cc463 | 30 | ;;; Code: |
248b25a4 RS |
31 | |
32 | (defvar scribe-mode-syntax-table nil | |
33 | "Syntax table used while in scribe mode.") | |
34 | ||
35 | (defvar scribe-mode-abbrev-table nil | |
36 | "Abbrev table used while in scribe mode.") | |
37 | ||
38 | (defvar scribe-fancy-paragraphs nil | |
39 | "*Non-NIL makes Scribe mode use a different style of paragraph separation.") | |
40 | ||
41 | (defvar scribe-electric-quote nil | |
42 | "*Non-NIL makes insert of double quote use `` or '' depending on context.") | |
43 | ||
44 | (defvar scribe-electric-parenthesis nil | |
45 | "*Non-NIL makes parenthesis char ( (]}> ) automatically insert its close | |
46 | if typed after an @Command form.") | |
47 | ||
48 | (defconst scribe-open-parentheses "[({<" | |
49 | "Open parenthesis characters for Scribe.") | |
50 | ||
51 | (defconst scribe-close-parentheses "])}>" | |
33b4a308 CZ |
52 | "Close parenthesis characters for Scribe. |
53 | These should match up with `scribe-open-parenthesis'.") | |
248b25a4 RS |
54 | |
55 | (if (null scribe-mode-syntax-table) | |
56 | (let ((st (syntax-table))) | |
57 | (unwind-protect | |
58 | (progn | |
59 | (setq scribe-mode-syntax-table (copy-syntax-table | |
60 | text-mode-syntax-table)) | |
61 | (set-syntax-table scribe-mode-syntax-table) | |
62 | (modify-syntax-entry ?\" " ") | |
63 | (modify-syntax-entry ?\\ " ") | |
64 | (modify-syntax-entry ?@ "w ") | |
65 | (modify-syntax-entry ?< "(> ") | |
66 | (modify-syntax-entry ?> ")< ") | |
67 | (modify-syntax-entry ?[ "(] ") | |
68 | (modify-syntax-entry ?] ")[ ") | |
69 | (modify-syntax-entry ?{ "(} ") | |
70 | (modify-syntax-entry ?} "){ ") | |
71 | (modify-syntax-entry ?' "w ")) | |
72 | (set-syntax-table st)))) | |
73 | ||
74 | (defvar scribe-mode-map nil) | |
75 | ||
76 | (if scribe-mode-map | |
77 | nil | |
78 | (setq scribe-mode-map (make-sparse-keymap)) | |
79 | (define-key scribe-mode-map "\t" 'scribe-tab) | |
80 | (define-key scribe-mode-map "\e\t" 'tab-to-tab-stop) | |
81 | (define-key scribe-mode-map "\es" 'center-line) | |
82 | (define-key scribe-mode-map "\e}" 'up-list) | |
83 | (define-key scribe-mode-map "\eS" 'center-paragraph) | |
84 | (define-key scribe-mode-map "\"" 'scribe-insert-quote) | |
85 | (define-key scribe-mode-map "(" 'scribe-parenthesis) | |
86 | (define-key scribe-mode-map "[" 'scribe-parenthesis) | |
87 | (define-key scribe-mode-map "{" 'scribe-parenthesis) | |
88 | (define-key scribe-mode-map "<" 'scribe-parenthesis) | |
89 | (define-key scribe-mode-map "\^cc" 'scribe-chapter) | |
90 | (define-key scribe-mode-map "\^cS" 'scribe-section) | |
91 | (define-key scribe-mode-map "\^cs" 'scribe-subsection) | |
92 | (define-key scribe-mode-map "\^ce" 'scribe-insert-environment) | |
93 | (define-key scribe-mode-map "\^c\^e" 'scribe-bracket-region-be) | |
94 | (define-key scribe-mode-map "\^c[" 'scribe-begin) | |
95 | (define-key scribe-mode-map "\^c]" 'scribe-end) | |
96 | (define-key scribe-mode-map "\^ci" 'scribe-italicize-word) | |
97 | (define-key scribe-mode-map "\^cb" 'scribe-bold-word) | |
98 | (define-key scribe-mode-map "\^cu" 'scribe-underline-word)) | |
99 | ||
f9f9507e | 100 | ;;;###autoload |
248b25a4 RS |
101 | (defun scribe-mode () |
102 | "Major mode for editing files of Scribe (a text formatter) source. | |
103 | Scribe-mode is similar text-mode, with a few extra commands added. | |
104 | \\{scribe-mode-map} | |
105 | ||
106 | Interesting variables: | |
107 | ||
108 | scribe-fancy-paragraphs | |
109 | Non-nil makes Scribe mode use a different style of paragraph separation. | |
110 | ||
111 | scribe-electric-quote | |
112 | Non-nil makes insert of double quote use `` or '' depending on context. | |
113 | ||
114 | scribe-electric-parenthesis | |
115 | Non-nil makes an open-parenthesis char (one of `([<{') | |
116 | automatically insert its close if typed after an @Command form." | |
117 | (interactive) | |
118 | (kill-all-local-variables) | |
119 | (use-local-map scribe-mode-map) | |
120 | (setq mode-name "Scribe") | |
121 | (setq major-mode 'scribe-mode) | |
122 | (define-abbrev-table 'scribe-mode-abbrev-table ()) | |
123 | (setq local-abbrev-table scribe-mode-abbrev-table) | |
124 | (make-local-variable 'comment-start) | |
125 | (setq comment-start "@Comment[") | |
126 | (make-local-variable 'comment-start-skip) | |
127 | (setq comment-start-skip (concat "@Comment[" scribe-open-parentheses "]")) | |
128 | (make-local-variable 'comment-column) | |
129 | (setq comment-column 0) | |
130 | (make-local-variable 'comment-end) | |
131 | (setq comment-end "]") | |
132 | (make-local-variable 'paragraph-start) | |
133 | (setq paragraph-start (concat "\\(^[\n\f]\\)\\|\\(^@\\w+[" | |
134 | scribe-open-parentheses | |
135 | "].*[" | |
136 | scribe-close-parentheses | |
137 | "]$\\)")) | |
138 | (make-local-variable 'paragraph-separate) | |
139 | (setq paragraph-separate (if scribe-fancy-paragraphs | |
140 | paragraph-start "^$")) | |
141 | (make-local-variable 'compile-command) | |
142 | (setq compile-command (concat "scribe " (buffer-file-name))) | |
143 | (set-syntax-table scribe-mode-syntax-table) | |
144 | (run-hooks 'text-mode-hook 'scribe-mode-hook)) | |
145 | ||
146 | (defun scribe-tab () | |
147 | (interactive) | |
148 | (insert "@\\")) | |
149 | ||
150 | ;; This algorithm could probably be improved somewhat. | |
151 | ;; Right now, it loses seriously... | |
152 | ||
153 | (defun scribe () | |
154 | "Run Scribe on the current buffer." | |
155 | (interactive) | |
156 | (call-interactively 'compile)) | |
157 | ||
158 | (defun scribe-envelop-word (string count) | |
33b4a308 CZ |
159 | "Surround current word with Scribe construct @STRING[...]. |
160 | COUNT specifies how many words to surround. A negative count means | |
161 | to skip backward." | |
248b25a4 RS |
162 | (let ((spos (point)) (epos (point)) (ccoun 0) noparens) |
163 | (if (not (zerop count)) | |
164 | (progn (if (= (char-syntax (preceding-char)) ?w) | |
165 | (forward-sexp (min -1 count))) | |
166 | (setq spos (point)) | |
167 | (if (looking-at (concat "@\\w[" scribe-open-parentheses "]")) | |
168 | (forward-char 2) | |
169 | (goto-char epos) | |
170 | (skip-chars-backward "\\W") | |
171 | (forward-char -1)) | |
172 | (forward-sexp (max count 1)) | |
173 | (setq epos (point)))) | |
174 | (goto-char spos) | |
175 | (while (and (< ccoun (length scribe-open-parentheses)) | |
176 | (save-excursion | |
177 | (or (search-forward (char-to-string | |
178 | (aref scribe-open-parentheses ccoun)) | |
179 | epos t) | |
180 | (search-forward (char-to-string | |
181 | (aref scribe-close-parentheses ccoun)) | |
182 | epos t))) | |
183 | (setq ccoun (1+ ccoun)))) | |
184 | (if (>= ccoun (length scribe-open-parentheses)) | |
185 | (progn (goto-char epos) | |
186 | (insert "@end(" string ")") | |
187 | (goto-char spos) | |
188 | (insert "@begin(" string ")")) | |
189 | (goto-char epos) | |
190 | (insert (aref scribe-close-parentheses ccoun)) | |
191 | (goto-char spos) | |
192 | (insert "@" string (aref scribe-open-parentheses ccoun)) | |
193 | (goto-char epos) | |
194 | (forward-char 3) | |
195 | (skip-chars-forward scribe-close-parentheses)))) | |
196 | ||
197 | (defun scribe-underline-word (count) | |
198 | "Underline COUNT words around point by means of Scribe constructs." | |
199 | (interactive "p") | |
200 | (scribe-envelop-word "u" count)) | |
201 | ||
202 | (defun scribe-bold-word (count) | |
203 | "Boldface COUNT words around point by means of Scribe constructs." | |
204 | (interactive "p") | |
205 | (scribe-envelop-word "b" count)) | |
206 | ||
207 | (defun scribe-italicize-word (count) | |
208 | "Italicize COUNT words around point by means of Scribe constructs." | |
209 | (interactive "p") | |
210 | (scribe-envelop-word "i" count)) | |
211 | ||
212 | (defun scribe-begin () | |
213 | (interactive) | |
214 | (insert "\n") | |
215 | (forward-char -1) | |
216 | (scribe-envelop-word "Begin" 0) | |
217 | (re-search-forward (concat "[" scribe-open-parentheses "]"))) | |
218 | ||
219 | (defun scribe-end () | |
220 | (interactive) | |
221 | (insert "\n") | |
222 | (forward-char -1) | |
223 | (scribe-envelop-word "End" 0) | |
224 | (re-search-forward (concat "[" scribe-open-parentheses "]"))) | |
225 | ||
226 | (defun scribe-chapter () | |
227 | (interactive) | |
228 | (insert "\n") | |
229 | (forward-char -1) | |
230 | (scribe-envelop-word "Chapter" 0) | |
231 | (re-search-forward (concat "[" scribe-open-parentheses "]"))) | |
232 | ||
233 | (defun scribe-section () | |
234 | (interactive) | |
235 | (insert "\n") | |
236 | (forward-char -1) | |
237 | (scribe-envelop-word "Section" 0) | |
238 | (re-search-forward (concat "[" scribe-open-parentheses "]"))) | |
239 | ||
240 | (defun scribe-subsection () | |
241 | (interactive) | |
242 | (insert "\n") | |
243 | (forward-char -1) | |
244 | (scribe-envelop-word "SubSection" 0) | |
245 | (re-search-forward (concat "[" scribe-open-parentheses "]"))) | |
246 | ||
247 | (defun scribe-bracket-region-be (env min max) | |
248 | (interactive "sEnvironment: \nr") | |
249 | (save-excursion | |
250 | (goto-char max) | |
251 | (insert "@end(" env ")\n") | |
252 | (goto-char min) | |
253 | (insert "@begin(" env ")\n"))) | |
254 | ||
255 | (defun scribe-insert-environment (env) | |
256 | (interactive "sEnvironment: ") | |
257 | (scribe-bracket-region-be env (point) (point)) | |
258 | (forward-line 1) | |
259 | (insert ?\n) | |
260 | (forward-char -1)) | |
261 | ||
262 | (defun scribe-insert-quote (count) | |
33b4a308 CZ |
263 | "Insert ``, '' or \" according to preceding character. |
264 | If `scribe-electric-quote' is non-NIL, insert ``, '' or \" according | |
248b25a4 RS |
265 | to preceding character. With numeric arg N, always insert N \" characters. |
266 | Else just insert \"." | |
267 | (interactive "P") | |
268 | (if (or count (not scribe-electric-quote)) | |
269 | (self-insert-command (prefix-numeric-value count)) | |
270 | (let (lastfore lastback lastquote) | |
271 | (insert | |
272 | (cond | |
273 | ((= (preceding-char) ?\\) ?\") | |
274 | ((bobp) "``") | |
275 | (t | |
276 | (setq lastfore (save-excursion (and (search-backward | |
277 | "``" (- (point) 1000) t) | |
278 | (point))) | |
279 | lastback (save-excursion (and (search-backward | |
280 | "''" (- (point) 1000) t) | |
281 | (point))) | |
282 | lastquote (save-excursion (and (search-backward | |
283 | "\"" (- (point) 100) t) | |
284 | (point)))) | |
285 | (if (not lastquote) | |
286 | (cond ((not lastfore) "``") | |
287 | ((not lastback) "''") | |
288 | ((> lastfore lastback) "''") | |
289 | (t "``")) | |
290 | (cond ((and (not lastback) (not lastfore)) "\"") | |
291 | ((and lastback (not lastfore) (> lastquote lastback)) "\"") | |
292 | ((and lastback (not lastfore) (> lastback lastquote)) "``") | |
293 | ((and lastfore (not lastback) (> lastquote lastfore)) "\"") | |
294 | ((and lastfore (not lastback) (> lastfore lastquote)) "''") | |
295 | ((and (> lastquote lastfore) (> lastquote lastback)) "\"") | |
296 | ((> lastfore lastback) "''") | |
297 | (t "``"))))))))) | |
298 | ||
299 | (defun scribe-parenthesis (count) | |
300 | "If scribe-electric-parenthesis is non-NIL, insertion of an open-parenthesis | |
301 | character inserts the following close parenthesis character if the | |
302 | preceding text is of the form @Command." | |
303 | (interactive "P") | |
304 | (self-insert-command (prefix-numeric-value count)) | |
305 | (let (at-command paren-char point-save) | |
306 | (if (or count (not scribe-electric-parenthesis)) | |
307 | nil | |
308 | (save-excursion | |
309 | (forward-char -1) | |
310 | (setq point-save (point)) | |
311 | (skip-chars-backward (concat "^ \n\t\f" scribe-open-parentheses)) | |
312 | (setq at-command (and (equal (following-char) ?@) | |
313 | (/= (point) (1- point-save))))) | |
314 | (if (and at-command | |
315 | (setq paren-char | |
316 | (string-match (regexp-quote | |
317 | (char-to-string (preceding-char))) | |
318 | scribe-open-parentheses))) | |
319 | (save-excursion | |
320 | (insert (aref scribe-close-parentheses paren-char))))))) | |
c88ab9ce ER |
321 | |
322 | ;;; scribe.el ends here |