1 ;;; scribe.el --- scribe mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
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.
32 (defvar scribe-mode-syntax-table nil
33 "Syntax table used while in scribe mode.")
35 (defvar scribe-mode-abbrev-table nil
36 "Abbrev table used while in scribe mode.")
38 (defvar scribe-fancy-paragraphs nil
39 "*Non-NIL makes Scribe mode use a different style of paragraph separation.")
41 (defvar scribe-electric-quote nil
42 "*Non-NIL makes insert of double quote use `` or '' depending on context.")
44 (defvar scribe-electric-parenthesis nil
45 "*Non-NIL makes parenthesis char ( (]}> ) automatically insert its close
46 if typed after an @Command form.")
48 (defconst scribe-open-parentheses
"[({<"
49 "Open parenthesis characters for Scribe.")
51 (defconst scribe-close-parentheses
"])}>"
52 "Close parenthesis characters for Scribe.
53 These should match up with `scribe-open-parenthesis'.")
55 (if (null scribe-mode-syntax-table
)
56 (let ((st (syntax-table)))
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
))))
74 (defvar scribe-mode-map 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
))
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.
106 Interesting variables:
108 scribe-fancy-paragraphs
109 Non-nil makes Scribe mode use a different style of paragraph separation.
111 scribe-electric-quote
112 Non-nil makes insert of double quote use `` or '' depending on context.
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."
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
136 scribe-close-parentheses
138 (make-local-variable 'paragraph-separate
)
139 (setq paragraph-separate
(if scribe-fancy-paragraphs
140 paragraph-start
"$"))
141 (make-local-variable 'sentence-end
)
142 (setq sentence-end
"\\([.?!]\\|@:\\)[]\"')}]*\\($\\| $\\|\t\\| \\)[ \t\n]*")
143 (make-local-variable 'compile-command
)
144 (setq compile-command
(concat "scribe " (buffer-file-name)))
145 (set-syntax-table scribe-mode-syntax-table
)
146 (run-hooks 'text-mode-hook
'scribe-mode-hook
))
152 ;; This algorithm could probably be improved somewhat.
153 ;; Right now, it loses seriously...
156 "Run Scribe on the current buffer."
158 (call-interactively 'compile
))
160 (defun scribe-envelop-word (string count
)
161 "Surround current word with Scribe construct @STRING[...].
162 COUNT specifies how many words to surround. A negative count means
164 (let ((spos (point)) (epos (point)) (ccoun 0) noparens
)
165 (if (not (zerop count
))
166 (progn (if (= (char-syntax (preceding-char)) ?w
)
167 (forward-sexp (min -
1 count
)))
169 (if (looking-at (concat "@\\w[" scribe-open-parentheses
"]"))
172 (skip-chars-backward "\\W")
174 (forward-sexp (max count
1))
175 (setq epos
(point))))
177 (while (and (< ccoun
(length scribe-open-parentheses
))
179 (or (search-forward (char-to-string
180 (aref scribe-open-parentheses ccoun
))
182 (search-forward (char-to-string
183 (aref scribe-close-parentheses ccoun
))
185 (setq ccoun
(1+ ccoun
))))
186 (if (>= ccoun
(length scribe-open-parentheses
))
187 (progn (goto-char epos
)
188 (insert "@end(" string
")")
190 (insert "@begin(" string
")"))
192 (insert (aref scribe-close-parentheses ccoun
))
194 (insert "@" string
(aref scribe-open-parentheses ccoun
))
197 (skip-chars-forward scribe-close-parentheses
))))
199 (defun scribe-underline-word (count)
200 "Underline COUNT words around point by means of Scribe constructs."
202 (scribe-envelop-word "u" count
))
204 (defun scribe-bold-word (count)
205 "Boldface COUNT words around point by means of Scribe constructs."
207 (scribe-envelop-word "b" count
))
209 (defun scribe-italicize-word (count)
210 "Italicize COUNT words around point by means of Scribe constructs."
212 (scribe-envelop-word "i" count
))
214 (defun scribe-begin ()
218 (scribe-envelop-word "Begin" 0)
219 (re-search-forward (concat "[" scribe-open-parentheses
"]")))
225 (scribe-envelop-word "End" 0)
226 (re-search-forward (concat "[" scribe-open-parentheses
"]")))
228 (defun scribe-chapter ()
232 (scribe-envelop-word "Chapter" 0)
233 (re-search-forward (concat "[" scribe-open-parentheses
"]")))
235 (defun scribe-section ()
239 (scribe-envelop-word "Section" 0)
240 (re-search-forward (concat "[" scribe-open-parentheses
"]")))
242 (defun scribe-subsection ()
246 (scribe-envelop-word "SubSection" 0)
247 (re-search-forward (concat "[" scribe-open-parentheses
"]")))
249 (defun scribe-bracket-region-be (env min max
)
250 (interactive "sEnvironment: \nr")
253 (insert "@end(" env
")\n")
255 (insert "@begin(" env
")\n")))
257 (defun scribe-insert-environment (env)
258 (interactive "sEnvironment: ")
259 (scribe-bracket-region-be env
(point) (point))
264 (defun scribe-insert-quote (count)
265 "Insert ``, '' or \" according to preceding character.
266 If `scribe-electric-quote' is non-NIL, insert ``, '' or \" according
267 to preceding character. With numeric arg N, always insert N \" characters.
268 Else just insert \"."
270 (if (or count
(not scribe-electric-quote
))
271 (self-insert-command (prefix-numeric-value count
))
272 (let (lastfore lastback lastquote
)
275 ((= (preceding-char) ?
\\) ?
\")
278 (setq lastfore
(save-excursion (and (search-backward
279 "``" (- (point) 1000) t
)
281 lastback
(save-excursion (and (search-backward
282 "''" (- (point) 1000) t
)
284 lastquote
(save-excursion (and (search-backward
285 "\"" (- (point) 100) t
)
288 (cond ((not lastfore
) "``")
289 ((not lastback
) "''")
290 ((> lastfore lastback
) "''")
292 (cond ((and (not lastback
) (not lastfore
)) "\"")
293 ((and lastback
(not lastfore
) (> lastquote lastback
)) "\"")
294 ((and lastback
(not lastfore
) (> lastback lastquote
)) "``")
295 ((and lastfore
(not lastback
) (> lastquote lastfore
)) "\"")
296 ((and lastfore
(not lastback
) (> lastfore lastquote
)) "''")
297 ((and (> lastquote lastfore
) (> lastquote lastback
)) "\"")
298 ((> lastfore lastback
) "''")
301 (defun scribe-parenthesis (count)
302 "If scribe-electric-parenthesis is non-NIL, insertion of an open-parenthesis
303 character inserts the following close parenthesis character if the
304 preceding text is of the form @Command."
306 (self-insert-command (prefix-numeric-value count
))
307 (let (at-command paren-char point-save
)
308 (if (or count
(not scribe-electric-parenthesis
))
312 (setq point-save
(point))
313 (skip-chars-backward (concat "^ \n\t\f" scribe-open-parentheses
))
314 (setq at-command
(and (equal (following-char) ?
@)
315 (/= (point) (1- point-save
)))))
318 (string-match (regexp-quote
319 (char-to-string (preceding-char)))
320 scribe-open-parentheses
)))
322 (insert (aref scribe-close-parentheses paren-char
)))))))
324 ;;; scribe.el ends here