Commit | Line | Data |
---|---|---|
d501f516 ER |
1 | ;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands. |
2 | ||
9596811a | 3 | ;; Copyright (C) 1985, 86, 89, 92, 94, 95, 96 Free Software Foundation, Inc. |
eea8d4ef | 4 | |
70f20973 | 5 | ;; Maintainer: FSF |
d7b4d18f | 6 | ;; Keywords: tex |
e5167999 | 7 | |
528415e7 | 8 | ;; Contributions over the years by William F. Schelter, Dick King, |
70f20973 | 9 | ;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold. |
528415e7 | 10 | |
869bff31 | 11 | ;; This file is part of GNU Emacs. |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 15 | ;; the Free Software Foundation; either version 2, or (at your option) |
869bff31 | 16 | ;; any later version. |
17 | ||
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
6da9bbd6 RS |
24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 | ;; Boston, MA 02111-1307, USA. | |
869bff31 | 27 | |
e5167999 ER |
28 | ;;; Code: |
29 | ||
a0e9c22a | 30 | (require 'shell) |
2f3067de | 31 | (require 'compile) |
528415e7 | 32 | |
7e1dae73 | 33 | ;;;###autoload |
528415e7 | 34 | (defvar tex-shell-file-name nil |
81c735c0 | 35 | "*If non-nil, the shell file name to run in the subshell used to run TeX.") |
528415e7 | 36 | |
7e1dae73 | 37 | ;;;###autoload |
528415e7 RS |
38 | (defvar tex-directory "." |
39 | "*Directory in which temporary files are left. | |
81c735c0 | 40 | You can make this `/tmp' if your TEXINPUTS has no relative directories in it |
528415e7 | 41 | and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are |
81c735c0 | 42 | `\\input' commands with relative directories.") |
869bff31 | 43 | |
7e1dae73 | 44 | ;;;###autoload |
528415e7 RS |
45 | (defvar tex-offer-save t |
46 | "*If non-nil, ask about saving modified buffers before \\[tex-file] is run.") | |
869bff31 | 47 | |
7e1dae73 | 48 | ;;;###autoload |
869bff31 | 49 | (defvar tex-run-command "tex" |
50 | "*Command used to run TeX subjob. | |
81c735c0 RS |
51 | If this string contains an asterisk (`*'), that is replaced by the file name; |
52 | otherwise, the file name, preceded by blank, is added at the end.") | |
869bff31 | 53 | |
7e1dae73 | 54 | ;;;###autoload |
869bff31 | 55 | (defvar latex-run-command "latex" |
56 | "*Command used to run LaTeX subjob. | |
81c735c0 RS |
57 | If this string contains an asterisk (`*'), that is replaced by the file name; |
58 | otherwise, the file name, preceded by blank, is added at the end.") | |
528415e7 RS |
59 | |
60 | (defvar standard-latex-block-names | |
61 | '("abstract" "array" "center" "description" | |
62 | "displaymath" "document" "enumerate" "eqnarray" | |
63 | "eqnarray*" "equation" "figure" "figure*" | |
64 | "flushleft" "flushright" "itemize" "letter" | |
65 | "list" "minipage" "picture" "quotation" | |
66 | "quote" "slide" "sloppypar" "tabbing" | |
67 | "table" "table*" "tabular" "tabular*" | |
68 | "thebibliography" "theindex*" "titlepage" "trivlist" | |
69 | "verbatim" "verbatim*" "verse") | |
70 | "Standard LaTeX block names.") | |
71 | ||
7e1dae73 | 72 | ;;;###autoload |
528415e7 RS |
73 | (defvar latex-block-names nil |
74 | "*User defined LaTeX block names. | |
75 | Combined with `standard-latex-block-names' for minibuffer completion.") | |
869bff31 | 76 | |
7e1dae73 | 77 | ;;;###autoload |
869bff31 | 78 | (defvar slitex-run-command "slitex" |
79 | "*Command used to run SliTeX subjob. | |
81c735c0 RS |
80 | If this string contains an asterisk (`*'), that is replaced by the file name; |
81 | otherwise, the file name, preceded by blank, is added at the end.") | |
869bff31 | 82 | |
7e1dae73 | 83 | ;;;###autoload |
869bff31 | 84 | (defvar tex-bibtex-command "bibtex" |
528415e7 | 85 | "*Command used by `tex-bibtex-file' to gather bibliographic data. |
81c735c0 RS |
86 | If this string contains an asterisk (`*'), that is replaced by the file name; |
87 | otherwise, the file name, preceded by blank, is added at the end.") | |
869bff31 | 88 | |
7e1dae73 | 89 | ;;;###autoload |
869bff31 | 90 | (defvar tex-dvi-print-command "lpr -d" |
528415e7 | 91 | "*Command used by \\[tex-print] to print a .dvi file. |
81c735c0 RS |
92 | If this string contains an asterisk (`*'), that is replaced by the file name; |
93 | otherwise, the file name, preceded by blank, is added at the end.") | |
528415e7 | 94 | |
7e1dae73 | 95 | ;;;###autoload |
528415e7 RS |
96 | (defvar tex-alt-dvi-print-command "lpr -d" |
97 | "*Command used by \\[tex-print] with a prefix arg to print a .dvi file. | |
81c735c0 RS |
98 | If this string contains an asterisk (`*'), that is replaced by the file name; |
99 | otherwise, the file name, preceded by blank, is added at the end. | |
528415e7 | 100 | |
81c735c0 RS |
101 | If two printers are not enough of a choice, you can set the variable |
102 | `tex-alt-dvi-print-command' to an expression that asks what you want; | |
528415e7 RS |
103 | for example, |
104 | ||
105 | (setq tex-alt-dvi-print-command | |
106 | '(format \"lpr -P%s\" (read-string \"Use printer: \"))) | |
107 | ||
108 | would tell \\[tex-print] with a prefix argument to ask you which printer to | |
109 | use.") | |
869bff31 | 110 | |
7e1dae73 | 111 | ;;;###autoload |
869bff31 | 112 | (defvar tex-dvi-view-command nil |
81c735c0 RS |
113 | "*Command used by \\[tex-view] to display a `.dvi' file. |
114 | If this string contains an asterisk (`*'), that is replaced by the file name; | |
115 | otherwise, the file name, preceded by blank, is added at the end. | |
528415e7 RS |
116 | |
117 | This can be set conditionally so that the previewer used is suitable for the | |
118 | window system being used. For example, | |
119 | ||
120 | (setq tex-dvi-view-command | |
121 | (if (eq window-system 'x) \"xdvi\" \"dvi2tty * | cat -s\")) | |
122 | ||
81c735c0 | 123 | would tell \\[tex-view] to use xdvi under X windows and to use dvi2tty |
528415e7 | 124 | otherwise.") |
869bff31 | 125 | |
7e1dae73 | 126 | ;;;###autoload |
869bff31 | 127 | (defvar tex-show-queue-command "lpq" |
528415e7 RS |
128 | "*Command used by \\[tex-show-print-queue] to show the print queue. |
129 | Should show the queue(s) that \\[tex-print] puts jobs on.") | |
869bff31 | 130 | |
7e1dae73 | 131 | ;;;###autoload |
869bff31 | 132 | (defvar tex-default-mode 'plain-tex-mode |
133 | "*Mode to enter for a new file that might be either TeX or LaTeX. | |
134 | This variable is used when it can't be determined whether the file | |
135 | is plain TeX or LaTeX or what because the file contains no commands. | |
81c735c0 | 136 | Normally set to either `plain-tex-mode' or `latex-mode'.") |
869bff31 | 137 | |
7e1dae73 | 138 | ;;;###autoload |
869bff31 | 139 | (defvar tex-open-quote "``" |
140 | "*String inserted by typing \\[tex-insert-quote] to open a quotation.") | |
141 | ||
7e1dae73 | 142 | ;;;###autoload |
869bff31 | 143 | (defvar tex-close-quote "''" |
144 | "*String inserted by typing \\[tex-insert-quote] to close a quotation.") | |
145 | ||
528415e7 RS |
146 | (defvar tex-last-temp-file nil |
147 | "Latest temporary file generated by \\[tex-region] and \\[tex-buffer]. | |
148 | Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the | |
81c735c0 | 149 | tex shell terminates.") |
528415e7 | 150 | |
869bff31 | 151 | (defvar tex-command nil |
152 | "Command to run TeX. | |
528415e7 | 153 | The name of the file, preceded by a blank, will be added to this string.") |
869bff31 | 154 | |
155 | (defvar tex-trailer nil | |
156 | "String appended after the end of a region sent to TeX by \\[tex-region].") | |
157 | ||
158 | (defvar tex-start-of-header nil | |
898b9ac1 | 159 | "Regular expression used by \\[tex-region] to find start of file's header.") |
869bff31 | 160 | |
161 | (defvar tex-end-of-header nil | |
898b9ac1 | 162 | "Regular expression used by \\[tex-region] to find end of file's header.") |
869bff31 | 163 | |
164 | (defvar tex-shell-cd-command "cd" | |
165 | "Command to give to shell running TeX to change directory. | |
81c735c0 | 166 | The value of `tex-directory' is appended to this, separated by a space.") |
869bff31 | 167 | |
168 | (defvar tex-zap-file nil | |
169 | "Temporary file name used for text being sent as input to TeX. | |
170 | Should be a simple file name with no extension or directory specification.") | |
171 | ||
172 | (defvar tex-last-buffer-texed nil | |
173 | "Buffer which was last TeXed.") | |
174 | ||
175 | (defvar tex-print-file nil | |
176 | "File name that \\[tex-print] prints. | |
177 | Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].") | |
178 | ||
179 | (defvar tex-mode-syntax-table nil | |
180 | "Syntax table used while in TeX mode.") | |
181 | ||
a5e2ae01 RS |
182 | (defun latex-imenu-create-index () |
183 | "Generates an alist for imenu from a LaTeX buffer." | |
184 | (let (result temp) | |
185 | (goto-char (point-max)) | |
186 | (while (re-search-backward "\\\\\\(part\\|chapter\\|\ | |
187 | \\(sub\\)?\\(\\(sub\\)?section\\|paragraph\\)\\)\\*?[ \t\n]*{\\([^}]*\\)}" nil t) | |
188 | (setq temp | |
189 | (assoc (buffer-substring-no-properties (match-beginning 1) | |
190 | (match-end 1)) | |
191 | '(("part" . "") ("chapter" . " ") | |
192 | ("section" . " ") ("subsection" . " ") | |
193 | ("subsubsection" . " ") | |
194 | ("paragraph" . " ") ("subparagraph" . " ")))) | |
195 | (setq result (cons (cons (concat (cdr temp) (match-string 5)) | |
196 | (match-beginning 0)) | |
197 | result))) | |
198 | result)) | |
0fb4f245 | 199 | |
869bff31 | 200 | (defun tex-define-common-keys (keymap) |
81c735c0 | 201 | "Define the keys that we want defined both in TeX mode and in the TeX shell." |
869bff31 | 202 | (define-key keymap "\C-c\C-k" 'tex-kill-job) |
203 | (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer) | |
204 | (define-key keymap "\C-c\C-q" 'tex-show-print-queue) | |
205 | (define-key keymap "\C-c\C-p" 'tex-print) | |
206 | (define-key keymap "\C-c\C-v" 'tex-view) | |
62a24cb5 RS |
207 | |
208 | (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX"))) | |
209 | ||
210 | (define-key keymap [menu-bar tex tex-kill-job] '("Tex Kill" . tex-kill-job)) | |
cf6d6e8a RS |
211 | (define-key keymap [menu-bar tex tex-recenter-output-buffer] |
212 | '("Tex Recenter" . tex-recenter-output-buffer)) | |
62a24cb5 RS |
213 | (define-key keymap [menu-bar tex tex-show-print-queue] |
214 | '("Show Print Queue" . tex-show-print-queue)) | |
cf6d6e8a RS |
215 | (define-key keymap [menu-bar tex tex-alt-print] |
216 | '("Tex Print (alt printer)" . tex-alt-print)) | |
62a24cb5 | 217 | (define-key keymap [menu-bar tex tex-print] '("Tex Print" . tex-print)) |
cf6d6e8a | 218 | (define-key keymap [menu-bar tex tex-view] '("Tex View" . tex-view)) |
869bff31 | 219 | ) |
220 | ||
221 | (defvar tex-mode-map nil "Keymap for TeX mode.") | |
222 | ||
223 | (if tex-mode-map | |
224 | nil | |
225 | (setq tex-mode-map (make-sparse-keymap)) | |
226 | (tex-define-common-keys tex-mode-map) | |
227 | (define-key tex-mode-map "\"" 'tex-insert-quote) | |
228 | (define-key tex-mode-map "\n" 'tex-terminate-paragraph) | |
229 | (define-key tex-mode-map "\C-c}" 'up-list) | |
230 | (define-key tex-mode-map "\C-c{" 'tex-insert-braces) | |
231 | (define-key tex-mode-map "\C-c\C-r" 'tex-region) | |
232 | (define-key tex-mode-map "\C-c\C-b" 'tex-buffer) | |
233 | (define-key tex-mode-map "\C-c\C-f" 'tex-file) | |
234 | (define-key tex-mode-map "\C-c\C-i" 'tex-bibtex-file) | |
235 | (define-key tex-mode-map "\C-c\C-o" 'tex-latex-block) | |
cf6d6e8a | 236 | (define-key tex-mode-map "\C-c\C-e" 'tex-close-latex-block) |
6a900cf1 | 237 | (define-key tex-mode-map "\C-c\C-u" 'tex-goto-last-unclosed-latex-block) |
002b0d00 RS |
238 | (define-key tex-mode-map [menu-bar tex tex-bibtex-file] |
239 | '("BibTeX File" . tex-bibtex-file)) | |
cf6d6e8a RS |
240 | (define-key tex-mode-map [menu-bar tex tex-validate-region] |
241 | '("Validate Region" . tex-validate-region)) | |
242 | (define-key tex-mode-map [menu-bar tex validate-tex-buffer] | |
243 | '("Validate Buffer" . validate-tex-buffer)) | |
244 | (define-key tex-mode-map [menu-bar tex tex-region] | |
002b0d00 | 245 | '("TeX Region" . tex-region)) |
cf6d6e8a | 246 | (define-key tex-mode-map [menu-bar tex tex-buffer] |
002b0d00 RS |
247 | '("TeX Buffer" . tex-buffer)) |
248 | (define-key tex-mode-map [menu-bar tex tex-file] '("TeX File" . tex-file))) | |
cf6d6e8a RS |
249 | |
250 | (put 'tex-region 'menu-enable 'mark-active) | |
251 | (put 'tex-validate-region 'menu-enable 'mark-active) | |
252 | (put 'tex-print 'menu-enable '(stringp tex-print-file)) | |
253 | (put 'tex-alt-print 'menu-enable '(stringp tex-print-file)) | |
254 | (put 'tex-view 'menu-enable '(stringp tex-print-file)) | |
255 | (put 'tex-recenter-output-buffer 'menu-enable '(get-buffer "*tex-shell*")) | |
256 | (put 'tex-kill-job 'menu-enable '(tex-shell-running)) | |
257 | ||
869bff31 | 258 | |
259 | (defvar tex-shell-map nil | |
81c735c0 | 260 | "Keymap for the TeX shell. |
dca5ea48 | 261 | Inherits `shell-mode-map' with a few additions.") |
869bff31 | 262 | |
6da9bbd6 RS |
263 | (defvar tex-face-alist |
264 | '((bold . "{\\bf ") | |
265 | (italic . "{\\it ") | |
266 | (bold-italic . "{\\bi ") ; hypothetical | |
267 | (underline . "\\underline{") | |
268 | (default . "{\\rm ")) | |
269 | "Alist of face and TeX font name for facemenu.") | |
270 | ||
271 | (defvar tex-latex-face-alist | |
272 | `((italic . "{\\em ") | |
273 | ,@tex-face-alist) | |
274 | "Alist of face and LaTeX font name for facemenu.") | |
275 | ||
276 | ||
0d548e5d | 277 | (defvar compare-windows-whitespace) ; Pacify the byte-compiler |
8241d7b9 | 278 | |
869bff31 | 279 | ;;; This would be a lot simpler if we just used a regexp search, |
280 | ;;; but then it would be too slow. | |
7229064d | 281 | ;;;###autoload |
869bff31 | 282 | (defun tex-mode () |
283 | "Major mode for editing files of input for TeX, LaTeX, or SliTeX. | |
284 | Tries to determine (by looking at the beginning of the file) whether | |
81c735c0 RS |
285 | this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode', |
286 | `latex-mode', or `slitex-mode', respectively. If it cannot be determined, | |
287 | such as if there are no commands in the file, the value of `tex-default-mode' | |
288 | says which mode to use." | |
869bff31 | 289 | (interactive) |
290 | (let (mode slash comment) | |
291 | (save-excursion | |
292 | (goto-char (point-min)) | |
293 | (while (and (setq slash (search-forward "\\" nil t)) | |
294 | (setq comment (let ((search-end (point))) | |
295 | (save-excursion | |
296 | (beginning-of-line) | |
297 | (search-forward "%" search-end t)))))) | |
298 | (if (and slash (not comment)) | |
c0bcb239 | 299 | (setq mode (if (looking-at "documentstyle\\|documentclass\\|begin\\b\\|NeedsTeXFormat{LaTeX") |
0edb9815 RS |
300 | (if (looking-at |
301 | "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}") | |
869bff31 | 302 | 'slitex-mode |
303 | 'latex-mode) | |
304 | 'plain-tex-mode)))) | |
305 | (if mode (funcall mode) | |
306 | (funcall tex-default-mode)))) | |
e4c8c838 | 307 | |
6503cec3 | 308 | ;;;###autoload |
31e1d920 | 309 | (defalias 'TeX-mode 'tex-mode) |
6503cec3 | 310 | ;;;###autoload |
31e1d920 | 311 | (defalias 'LaTeX-mode 'latex-mode) |
869bff31 | 312 | |
7229064d | 313 | ;;;###autoload |
869bff31 | 314 | (defun plain-tex-mode () |
315 | "Major mode for editing files of input for plain TeX. | |
316 | Makes $ and } display the characters they match. | |
317 | Makes \" insert `` when it seems to be the beginning of a quotation, | |
318 | and '' when it appears to be the end; it inserts \" only after a \\. | |
319 | ||
320 | Use \\[tex-region] to run TeX on the current region, plus a \"header\" | |
321 | copied from the top of the file (containing macro definitions, etc.), | |
322 | running TeX under a special subshell. \\[tex-buffer] does the whole buffer. | |
323 | \\[tex-file] saves the buffer and then processes the file. | |
324 | \\[tex-print] prints the .dvi file made by any of these. | |
325 | \\[tex-view] previews the .dvi file made by any of these. | |
326 | \\[tex-bibtex-file] runs bibtex on the file of the current buffer. | |
327 | ||
328 | Use \\[validate-tex-buffer] to check buffer for paragraphs containing | |
329 | mismatched $'s or braces. | |
330 | ||
331 | Special commands: | |
332 | \\{tex-mode-map} | |
333 | ||
334 | Mode variables: | |
335 | tex-run-command | |
336 | Command string used by \\[tex-region] or \\[tex-buffer]. | |
337 | tex-directory | |
338 | Directory in which to create temporary files for TeX jobs | |
339 | run by \\[tex-region] or \\[tex-buffer]. | |
340 | tex-dvi-print-command | |
341 | Command string used by \\[tex-print] to print a .dvi file. | |
528415e7 RS |
342 | tex-alt-dvi-print-command |
343 | Alternative command string used by \\[tex-print] (when given a prefix | |
344 | argument) to print a .dvi file. | |
869bff31 | 345 | tex-dvi-view-command |
346 | Command string used by \\[tex-view] to preview a .dvi file. | |
347 | tex-show-queue-command | |
348 | Command string used by \\[tex-show-print-queue] to show the print | |
349 | queue that \\[tex-print] put your job on. | |
350 | ||
81c735c0 RS |
351 | Entering Plain-tex mode runs the hook `text-mode-hook', then the hook |
352 | `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the | |
353 | special subshell is initiated, the hook `tex-shell-hook' is run." | |
8241d7b9 | 354 | |
869bff31 | 355 | (interactive) |
356 | (tex-common-initialization) | |
357 | (setq mode-name "TeX") | |
358 | (setq major-mode 'plain-tex-mode) | |
359 | (setq tex-command tex-run-command) | |
898b9ac1 RS |
360 | (setq tex-start-of-header "%\\*\\*start of header") |
361 | (setq tex-end-of-header "%\\*\\*end of header") | |
869bff31 | 362 | (setq tex-trailer "\\bye\n") |
363 | (run-hooks 'text-mode-hook 'tex-mode-hook 'plain-tex-mode-hook)) | |
6503cec3 | 364 | ;;;###autoload |
31e1d920 | 365 | (defalias 'plain-TeX-mode 'plain-tex-mode) |
869bff31 | 366 | |
7229064d | 367 | ;;;###autoload |
869bff31 | 368 | (defun latex-mode () |
369 | "Major mode for editing files of input for LaTeX. | |
370 | Makes $ and } display the characters they match. | |
371 | Makes \" insert `` when it seems to be the beginning of a quotation, | |
372 | and '' when it appears to be the end; it inserts \" only after a \\. | |
373 | ||
374 | Use \\[tex-region] to run LaTeX on the current region, plus the preamble | |
375 | copied from the top of the file (containing \\documentstyle, etc.), | |
376 | running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer. | |
377 | \\[tex-file] saves the buffer and then processes the file. | |
378 | \\[tex-print] prints the .dvi file made by any of these. | |
379 | \\[tex-view] previews the .dvi file made by any of these. | |
380 | \\[tex-bibtex-file] runs bibtex on the file of the current buffer. | |
381 | ||
382 | Use \\[validate-tex-buffer] to check buffer for paragraphs containing | |
383 | mismatched $'s or braces. | |
384 | ||
385 | Special commands: | |
386 | \\{tex-mode-map} | |
387 | ||
388 | Mode variables: | |
389 | latex-run-command | |
390 | Command string used by \\[tex-region] or \\[tex-buffer]. | |
391 | tex-directory | |
392 | Directory in which to create temporary files for LaTeX jobs | |
393 | run by \\[tex-region] or \\[tex-buffer]. | |
394 | tex-dvi-print-command | |
395 | Command string used by \\[tex-print] to print a .dvi file. | |
528415e7 RS |
396 | tex-alt-dvi-print-command |
397 | Alternative command string used by \\[tex-print] (when given a prefix | |
398 | argument) to print a .dvi file. | |
869bff31 | 399 | tex-dvi-view-command |
400 | Command string used by \\[tex-view] to preview a .dvi file. | |
401 | tex-show-queue-command | |
402 | Command string used by \\[tex-show-print-queue] to show the print | |
403 | queue that \\[tex-print] put your job on. | |
404 | ||
81c735c0 RS |
405 | Entering Latex mode runs the hook `text-mode-hook', then |
406 | `tex-mode-hook', and finally `latex-mode-hook'. When the special | |
407 | subshell is initiated, `tex-shell-hook' is run." | |
869bff31 | 408 | (interactive) |
409 | (tex-common-initialization) | |
410 | (setq mode-name "LaTeX") | |
411 | (setq major-mode 'latex-mode) | |
412 | (setq tex-command latex-run-command) | |
898b9ac1 RS |
413 | (setq tex-start-of-header "\\\\documentstyle\\|\\\\documentclass") |
414 | (setq tex-end-of-header "\\\\begin{document}") | |
869bff31 | 415 | (setq tex-trailer "\\end{document}\n") |
ab2c9f54 RS |
416 | ;; A line containing just $$ is treated as a paragraph separator. |
417 | ;; A line starting with $$ starts a paragraph, | |
418 | ;; but does not separate paragraphs if it has more stuff on it. | |
02202839 BG |
419 | (setq paragraph-start "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\ |
420 | \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\ | |
421 | \\\\chapter\\>\\|\\\\section\\>\\|\ | |
422 | \\\\subsection\\>\\|\\\\subsubsection\\>\\|\ | |
423 | \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\ | |
424 | \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\ | |
425 | \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\ | |
426 | \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\ | |
427 | \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>") | |
428 | (setq paragraph-separate "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\ | |
429 | \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\ | |
430 | \\\\chapter\\>\\|\\\\section\\>\\|\ | |
431 | \\\\subsection\\>\\|\\\\subsubsection\\>\\|\ | |
432 | \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\ | |
433 | \\(\\\\item\\|\\\\bibitem\\|\\\\newline\\|\\\\noindent\\|\ | |
434 | \\\\[a-z]*space\\|\\\\[a-z]*skip\\|\ | |
435 | \\\\newpage\\|\\\\[a-z]*page[a-z]*\\|\\\\footnote\\|\ | |
436 | \\\\marginpar\\|\\\\parbox\\|\\\\caption\\)[ \t]*\\($\\|%\\)") | |
a5e2ae01 RS |
437 | (make-local-variable 'imenu-create-index-function) |
438 | (setq imenu-create-index-function 'latex-imenu-create-index) | |
6da9bbd6 RS |
439 | (make-local-variable 'tex-face-alist) |
440 | (setq tex-face-alist tex-latex-face-alist) | |
869bff31 | 441 | (run-hooks 'text-mode-hook 'tex-mode-hook 'latex-mode-hook)) |
442 | ||
bd2f2323 | 443 | ;;;###autoload |
869bff31 | 444 | (defun slitex-mode () |
445 | "Major mode for editing files of input for SliTeX. | |
446 | Makes $ and } display the characters they match. | |
447 | Makes \" insert `` when it seems to be the beginning of a quotation, | |
448 | and '' when it appears to be the end; it inserts \" only after a \\. | |
449 | ||
450 | Use \\[tex-region] to run SliTeX on the current region, plus the preamble | |
451 | copied from the top of the file (containing \\documentstyle, etc.), | |
452 | running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer. | |
453 | \\[tex-file] saves the buffer and then processes the file. | |
454 | \\[tex-print] prints the .dvi file made by any of these. | |
455 | \\[tex-view] previews the .dvi file made by any of these. | |
456 | \\[tex-bibtex-file] runs bibtex on the file of the current buffer. | |
457 | ||
458 | Use \\[validate-tex-buffer] to check buffer for paragraphs containing | |
459 | mismatched $'s or braces. | |
460 | ||
461 | Special commands: | |
462 | \\{tex-mode-map} | |
463 | ||
464 | Mode variables: | |
465 | slitex-run-command | |
466 | Command string used by \\[tex-region] or \\[tex-buffer]. | |
467 | tex-directory | |
468 | Directory in which to create temporary files for SliTeX jobs | |
469 | run by \\[tex-region] or \\[tex-buffer]. | |
470 | tex-dvi-print-command | |
471 | Command string used by \\[tex-print] to print a .dvi file. | |
528415e7 RS |
472 | tex-alt-dvi-print-command |
473 | Alternative command string used by \\[tex-print] (when given a prefix | |
474 | argument) to print a .dvi file. | |
869bff31 | 475 | tex-dvi-view-command |
476 | Command string used by \\[tex-view] to preview a .dvi file. | |
477 | tex-show-queue-command | |
478 | Command string used by \\[tex-show-print-queue] to show the print | |
479 | queue that \\[tex-print] put your job on. | |
480 | ||
81c735c0 RS |
481 | Entering SliTeX mode runs the hook `text-mode-hook', then the hook |
482 | `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook | |
483 | `slitex-mode-hook'. When the special subshell is initiated, the hook | |
484 | `tex-shell-hook' is run." | |
869bff31 | 485 | (interactive) |
486 | (tex-common-initialization) | |
487 | (setq mode-name "SliTeX") | |
488 | (setq major-mode 'slitex-mode) | |
489 | (setq tex-command slitex-run-command) | |
6da9bbd6 | 490 | (setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\documentclass{slides}") |
898b9ac1 | 491 | (setq tex-end-of-header "\\\\begin{document}") |
869bff31 | 492 | (setq tex-trailer "\\end{document}\n") |
ab2c9f54 RS |
493 | ;; A line containing just $$ is treated as a paragraph separator. |
494 | ;; A line starting with $$ starts a paragraph, | |
495 | ;; but does not separate paragraphs if it has more stuff on it. | |
02202839 BG |
496 | (setq paragraph-start "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\ |
497 | \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\ | |
498 | \\\\chapter\\>\\|\\\\section\\>\\|\ | |
499 | \\\\subsection\\>\\|\\\\subsubsection\\>\\|\ | |
500 | \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\ | |
501 | \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\ | |
502 | \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\ | |
503 | \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\ | |
504 | \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>") | |
505 | (setq paragraph-separate "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\ | |
506 | \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\ | |
507 | \\\\chapter\\>\\|\\\\section\\>\\|\ | |
508 | \\\\subsection\\>\\|\\\\subsubsection\\>\\|\ | |
509 | \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\ | |
510 | \\\\item[ \t]*$\\|\\\\bibitem[ \t]*$\\|\\\\newline[ \t]*$\\|\\\\noindent[ \t]*$\\|\ | |
511 | \\\\[a-z]*space[ \t]*$\\|\\\\[a-z]*skip[ \t]*$\\|\ | |
512 | \\\\newpage[ \t]*$\\|\\\\[a-z]*page[a-z]*[ \t]*$\\|\\\\footnote[ \t]*$\\|\ | |
513 | \\\\marginpar[ \t]*$\\|\\\\parbox[ \t]*$\\|\\\\caption[ \t]*$") | |
869bff31 | 514 | (run-hooks |
515 | 'text-mode-hook 'tex-mode-hook 'latex-mode-hook 'slitex-mode-hook)) | |
516 | ||
517 | (defun tex-common-initialization () | |
518 | (kill-all-local-variables) | |
519 | (use-local-map tex-mode-map) | |
520 | (setq local-abbrev-table text-mode-abbrev-table) | |
521 | (if (null tex-mode-syntax-table) | |
522 | (let ((char 0)) | |
523 | (setq tex-mode-syntax-table (make-syntax-table)) | |
524 | (set-syntax-table tex-mode-syntax-table) | |
525 | (while (< char ? ) | |
526 | (modify-syntax-entry char ".") | |
527 | (setq char (1+ char))) | |
528 | (modify-syntax-entry ?\C-@ "w") | |
529 | (modify-syntax-entry ?\t " ") | |
530 | (modify-syntax-entry ?\n ">") | |
531 | (modify-syntax-entry ?\f ">") | |
532 | (modify-syntax-entry ?$ "$$") | |
533 | (modify-syntax-entry ?% "<") | |
534 | (modify-syntax-entry ?\\ "/") | |
535 | (modify-syntax-entry ?\" ".") | |
536 | (modify-syntax-entry ?& ".") | |
537 | (modify-syntax-entry ?_ ".") | |
538 | (modify-syntax-entry ?@ "_") | |
539 | (modify-syntax-entry ?~ " ") | |
540 | (modify-syntax-entry ?' "w")) | |
541 | (set-syntax-table tex-mode-syntax-table)) | |
542 | (make-local-variable 'paragraph-start) | |
64db2461 | 543 | ;; A line containing just $$ is treated as a paragraph separator. |
02202839 | 544 | (setq paragraph-start "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$") |
869bff31 | 545 | (make-local-variable 'paragraph-separate) |
ab2c9f54 RS |
546 | ;; A line starting with $$ starts a paragraph, |
547 | ;; but does not separate paragraphs if it has more stuff on it. | |
02202839 | 548 | (setq paragraph-separate "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$") |
869bff31 | 549 | (make-local-variable 'comment-start) |
550 | (setq comment-start "%") | |
551 | (make-local-variable 'comment-start-skip) | |
552 | (setq comment-start-skip "\\(\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)") | |
e41b2db1 ER |
553 | (make-local-variable 'comment-indent-function) |
554 | (setq comment-indent-function 'tex-comment-indent) | |
2e0b53ad RS |
555 | (make-local-variable 'parse-sexp-ignore-comments) |
556 | (setq parse-sexp-ignore-comments t) | |
869bff31 | 557 | (make-local-variable 'compare-windows-whitespace) |
558 | (setq compare-windows-whitespace 'tex-categorize-whitespace) | |
6da9bbd6 RS |
559 | (make-local-variable 'facemenu-add-face-function) |
560 | (make-local-variable 'facemenu-end-add-face) | |
561 | (make-local-variable 'facemenu-remove-face-function) | |
562 | (setq facemenu-add-face-function | |
563 | (lambda (face end) | |
564 | (let ((face-text (cdr (assq face tex-face-alist)))) | |
565 | (if face-text | |
566 | face-text | |
567 | (error "Face %s not configured for %s mode" face mode-name)))) | |
568 | facemenu-end-add-face "}" | |
569 | facemenu-remove-face-function t) | |
869bff31 | 570 | (make-local-variable 'tex-command) |
571 | (make-local-variable 'tex-start-of-header) | |
572 | (make-local-variable 'tex-end-of-header) | |
573 | (make-local-variable 'tex-trailer)) | |
574 | ||
575 | (defun tex-comment-indent () | |
576 | (if (looking-at "%%%") | |
577 | (current-column) | |
578 | (skip-chars-backward " \t") | |
579 | (max (if (bolp) 0 (1+ (current-column))) | |
580 | comment-column))) | |
581 | ||
582 | (defun tex-categorize-whitespace (backward-limit) | |
583 | ;; compare-windows-whitespace is set to this. | |
584 | ;; This is basically a finite-state machine. | |
585 | ;; Returns a symbol telling how TeX would treat | |
586 | ;; the whitespace we are looking at: null, space, or par. | |
587 | (let ((category 'null) | |
588 | (not-finished t)) | |
589 | (skip-chars-backward " \t\n\f" backward-limit) | |
590 | (while not-finished | |
591 | (cond ((looking-at "[ \t]+") | |
592 | (goto-char (match-end 0)) | |
593 | (if (eql category 'null) | |
594 | (setq category 'space))) | |
595 | ((looking-at "\n") | |
596 | (cond ((eql category 'newline) | |
597 | (setq category 'par) | |
598 | (setq not-finished nil)) | |
599 | (t | |
600 | (setq category 'newline) ;a strictly internal state | |
601 | (goto-char (match-end 0))))) | |
602 | ((looking-at "\f+") | |
603 | (setq category 'par) | |
604 | (setq not-finished nil)) | |
605 | (t | |
606 | (setq not-finished nil)))) | |
607 | (skip-chars-forward " \t\n\f") | |
608 | (if (eql category 'newline) | |
609 | 'space ;TeX doesn't distinguish | |
610 | category))) | |
611 | ||
612 | (defun tex-insert-quote (arg) | |
613 | "Insert the appropriate quote marks for TeX. | |
08348502 RS |
614 | Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote' |
615 | \(normally '') depending on the context. With prefix argument, always | |
869bff31 | 616 | inserts \" characters." |
528415e7 | 617 | (interactive "*P") |
869bff31 | 618 | (if arg |
619 | (self-insert-command (prefix-numeric-value arg)) | |
620 | (insert | |
621 | (cond ((or (bobp) | |
622 | (save-excursion | |
623 | (forward-char -1) | |
624 | (looking-at "\\s(\\|\\s \\|\\s>"))) | |
625 | tex-open-quote) | |
626 | ((= (preceding-char) ?\\) | |
627 | ?\") | |
628 | (t | |
629 | tex-close-quote))))) | |
630 | ||
631 | (defun validate-tex-buffer () | |
8241d7b9 | 632 | "Check current buffer for paragraphs containing mismatched $s. |
bbd93e41 RS |
633 | Their positions are recorded in the buffer `*Occur*'. |
634 | To find a particular invalidity from `*Occur*', | |
635 | switch to to that buffer and type C-c C-c on the line | |
636 | for the invalidity you want to see." | |
869bff31 | 637 | (interactive) |
bbd93e41 RS |
638 | (let ((buffer (current-buffer)) |
639 | (prevpos (point-min)) | |
640 | (linenum nil)) | |
641 | (with-output-to-temp-buffer "*Occur*" | |
642 | (princ "Mismatches:\n") | |
643 | (save-excursion | |
644 | (set-buffer standard-output) | |
645 | (occur-mode) | |
646 | (setq occur-buffer buffer) | |
647 | (setq occur-nlines 0) | |
648 | (setq occur-pos-list nil)) | |
649 | (save-excursion | |
650 | (goto-char (point-max)) | |
869bff31 | 651 | (while (and (not (input-pending-p)) (not (bobp))) |
652 | (let ((end (point))) | |
bbd93e41 | 653 | ;; Scan the previous paragraph for invalidities. |
869bff31 | 654 | (search-backward "\n\n" nil 'move) |
655 | (or (tex-validate-region (point) end) | |
bbd93e41 RS |
656 | (let* ((end (save-excursion (forward-line 1) (point))) |
657 | start tem) | |
658 | (beginning-of-line) | |
659 | (setq start (point)) | |
660 | ;; Keep track of line number as we scan, | |
661 | ;; in a cumulative fashion. | |
662 | (if linenum | |
663 | (setq linenum (- linenum (count-lines prevpos (point)))) | |
664 | (setq linenum (1+ (count-lines 1 start)))) | |
665 | (setq prevpos (point)) | |
666 | ;; Mention this mismatch in *Occur*. | |
667 | ;; Since we scan from end of buffer to beginning, | |
668 | ;; add each mismatch at the beginning of *Occur* | |
669 | ;; and at the beginning of occur-pos-list. | |
670 | (save-excursion | |
671 | (setq tem (point-marker)) | |
672 | (set-buffer standard-output) | |
673 | (goto-char (point-min)) | |
674 | ;; Skip "Mismatches:" header line. | |
675 | (forward-line 1) | |
676 | (setq occur-pos-list (cons tem occur-pos-list)) | |
677 | (insert-buffer-substring buffer start end) | |
678 | (forward-char (- start end)) | |
679 | (insert (format "%3d: " linenum)))))))) | |
680 | (save-excursion | |
681 | (set-buffer standard-output) | |
682 | (if (null occur-pos-list) | |
683 | (insert "None!\n")) | |
684 | (if (interactive-p) | |
685 | (message "%d mismatches found" (length occur-pos-list))))))) | |
869bff31 | 686 | |
687 | (defun tex-validate-region (start end) | |
688 | "Check for mismatched braces or $'s in region. | |
689 | Returns t if no mismatches. Returns nil and moves point to suspect | |
690 | area if a mismatch is found." | |
691 | (interactive "r") | |
692 | (let ((failure-point nil) (max-possible-sexps (- end start))) | |
693 | (save-excursion | |
694 | (condition-case () | |
695 | (save-restriction | |
696 | (narrow-to-region start end) | |
697 | (goto-char start) | |
698 | (while (< 0 (setq max-possible-sexps (1- max-possible-sexps))) | |
699 | (forward-sexp 1))) | |
700 | (error | |
701 | (setq failure-point (point))))) | |
702 | (if failure-point | |
703 | (progn | |
704 | (goto-char failure-point) | |
705 | nil) | |
706 | t))) | |
707 | ||
708 | (defun tex-terminate-paragraph (inhibit-validation) | |
709 | "Insert two newlines, breaking a paragraph for TeX. | |
81c735c0 | 710 | Check for mismatched braces or $s in paragraph being terminated. |
869bff31 | 711 | A prefix arg inhibits the checking." |
528415e7 | 712 | (interactive "*P") |
869bff31 | 713 | (or inhibit-validation |
714 | (save-excursion | |
715 | (tex-validate-region | |
716 | (save-excursion | |
717 | (search-backward "\n\n" nil 'move) | |
718 | (point)) | |
719 | (point))) | |
720 | (message "Paragraph being closed appears to contain a mismatch")) | |
721 | (insert "\n\n")) | |
722 | ||
723 | (defun tex-insert-braces () | |
724 | "Make a pair of braces and be poised to type inside of them." | |
528415e7 | 725 | (interactive "*") |
869bff31 | 726 | (insert ?\{) |
727 | (save-excursion | |
728 | (insert ?}))) | |
729 | ||
730 | ;;; Like tex-insert-braces, but for LaTeX. | |
731 | (defun tex-latex-block (name) | |
81c735c0 | 732 | "Creates a matching pair of lines `\\begin{NAME}' and `\\end{NAME}' at point. |
869bff31 | 733 | Puts point on a blank line between them." |
528415e7 RS |
734 | (interactive |
735 | (prog2 | |
736 | (barf-if-buffer-read-only) | |
737 | (list | |
738 | (completing-read "LaTeX block name: " | |
739 | (mapcar 'list | |
740 | (append standard-latex-block-names | |
741 | latex-block-names)))))) | |
869bff31 | 742 | (let ((col (current-column))) |
743 | (insert (format "\\begin{%s}\n" name)) | |
744 | (indent-to col) | |
745 | (save-excursion | |
746 | (insert ?\n) | |
747 | (indent-to col) | |
748 | (insert-string (format "\\end{%s}" name)) | |
749 | (if (eobp) (insert ?\n))))) | |
750 | ||
751 | (defun tex-last-unended-begin () | |
81c735c0 | 752 | "Leave point at the beginning of the last `\\begin{...}' that is unended." |
869bff31 | 753 | (while (and (re-search-backward "\\(\\\\begin\\s *{\\)\\|\\(\\\\end\\s *{\\)") |
754 | (looking-at "\\\\end{")) | |
755 | (tex-last-unended-begin))) | |
756 | ||
6a900cf1 ER |
757 | (defun tex-goto-last-unclosed-latex-block () |
758 | "Move point to the last unclosed \\begin{...}. | |
759 | Mark is left at original location." | |
760 | (interactive) | |
761 | (let ((spot)) | |
762 | (save-excursion | |
763 | (condition-case nil | |
764 | (tex-last-unended-begin) | |
765 | (error (error "Couldn't find unended \\begin"))) | |
766 | (setq spot (point))) | |
767 | (push-mark) | |
768 | (goto-char spot))) | |
769 | ||
869bff31 | 770 | (defun tex-close-latex-block () |
771 | "Creates an \\end{...} to match the last unclosed \\begin{...}." | |
772 | (interactive "*") | |
773 | (let ((new-line-needed (bolp)) | |
774 | text indentation) | |
775 | (save-excursion | |
528415e7 | 776 | (condition-case nil |
869bff31 | 777 | (tex-last-unended-begin) |
778 | (error (error "Couldn't find unended \\begin"))) | |
779 | (setq indentation (current-column)) | |
780 | (re-search-forward "\\\\begin\\(\\s *{[^}\n]*}\\)") | |
781 | (setq text (buffer-substring (match-beginning 1) (match-end 1)))) | |
782 | (indent-to indentation) | |
783 | (insert "\\end" text) | |
784 | (if new-line-needed (insert ?\n)))) | |
785 | \f | |
2f3067de ER |
786 | (defun tex-compilation-parse-errors () |
787 | "Parse the current buffer as error messages. | |
788 | This makes a list of error descriptors, compilation-error-list. | |
789 | For each source-file, line-number pair in the buffer, | |
790 | the source file is read in, and the text location is saved in | |
8241d7b9 | 791 | compilation-error-list. The function `next-error', assigned to |
2f3067de ER |
792 | \\[next-error], takes the next error off the list and visits its location. |
793 | ||
794 | This function works on TeX compilations only. It is necessary for | |
795 | that purpose, since TeX does not put file names on the same line as | |
796 | line numbers for the errors." | |
797 | (setq compilation-error-list nil) | |
798 | (message "Parsing error messages...") | |
799 | (modify-syntax-entry ?\{ "_") | |
800 | (modify-syntax-entry ?\} "_") | |
801 | (modify-syntax-entry ?\[ "_") | |
802 | (modify-syntax-entry ?\] "_") | |
2f3067de ER |
803 | (let (text-buffer |
804 | last-filename last-linenum) | |
805 | ;; Don't reparse messages already seen at last parse. | |
806 | (goto-char compilation-parsing-end) | |
807 | ;; Don't parse the first two lines as error messages. | |
808 | ;; This matters for grep. | |
809 | (if (bobp) | |
810 | (forward-line 2)) | |
8241d7b9 | 811 | (while (re-search-forward "^l\.[0-9]+ " nil t) |
2f3067de ER |
812 | (let (linenum filename |
813 | error-marker text-marker) | |
814 | ;; Extract file name and line number from error message. | |
815 | ;; Line number is 2 away from beginning of line: "l.23" | |
816 | (beginning-of-line) | |
817 | (goto-char (+ (point) 2)) | |
818 | (setq linenum (read (current-buffer))) | |
819 | ;; The file is the one that was opened last and is still open. | |
820 | ;; We need to find the last open parenthesis. | |
821 | (insert ?\)) | |
822 | (backward-sexp) | |
823 | (forward-char) | |
8241d7b9 | 824 | (setq filename (current-word)) |
2f3067de ER |
825 | ;; Locate the erring file and line. |
826 | (if (and (equal filename last-filename) | |
827 | (= linenum last-linenum)) | |
828 | nil | |
829 | (skip-chars-backward "^(") | |
830 | (backward-char) | |
831 | (forward-sexp) | |
832 | (backward-delete-char 1) | |
833 | (setq error-marker (point-marker)) | |
834 | ;; text-buffer gets the buffer containing this error's file. | |
835 | (if (not (equal filename last-filename)) | |
836 | (setq text-buffer | |
837 | (and (file-exists-p (setq last-filename filename)) | |
838 | (find-file-noselect filename)) | |
839 | last-linenum 0)) | |
840 | (if text-buffer | |
841 | ;; Go to that buffer and find the erring line. | |
842 | (save-excursion | |
843 | (set-buffer text-buffer) | |
844 | (if (zerop last-linenum) | |
845 | (progn | |
846 | (goto-char 1) | |
847 | (setq last-linenum 1))) | |
848 | (forward-line (- linenum last-linenum)) | |
849 | (setq last-linenum linenum) | |
850 | (setq text-marker (point-marker)) | |
851 | (setq compilation-error-list | |
852 | (cons (list error-marker text-marker) | |
853 | compilation-error-list))))) | |
854 | (forward-line 1))) | |
855 | (setq compilation-parsing-end (point-max))) | |
856 | (message "Parsing error messages...done") | |
857 | (setq compilation-error-list (nreverse compilation-error-list))) | |
858 | \f | |
869bff31 | 859 | ;;; Invoking TeX in an inferior shell. |
860 | ||
861 | ;;; Why use a shell instead of running TeX directly? Because if TeX | |
862 | ;;; gets stuck, the user can switch to the shell window and type at it. | |
863 | ||
864 | ;;; The utility functions: | |
865 | ||
d974af30 | 866 | ;;;###autoload |
869bff31 | 867 | (defun tex-start-shell () |
868 | (save-excursion | |
528415e7 RS |
869 | (set-buffer |
870 | (make-comint | |
871 | "tex-shell" | |
872 | (or tex-shell-file-name (getenv "ESHELL") (getenv "SHELL") "/bin/sh") | |
4cdc1d4b | 873 | nil)) |
528415e7 RS |
874 | (let ((proc (get-process "tex-shell"))) |
875 | (set-process-sentinel proc 'tex-shell-sentinel) | |
876 | (process-kill-without-query proc) | |
e8c04c88 | 877 | (setq comint-prompt-regexp shell-prompt-pattern) |
191cda94 | 878 | (setq tex-shell-map (nconc (make-sparse-keymap) shell-mode-map)) |
528415e7 RS |
879 | (tex-define-common-keys tex-shell-map) |
880 | (use-local-map tex-shell-map) | |
881 | (run-hooks 'tex-shell-hook) | |
882 | (while (zerop (buffer-size)) | |
51b2c841 RS |
883 | (sleep-for 1))))) |
884 | ||
885 | (defun tex-display-shell () | |
886 | "Make the TeX shell buffer visible in a window." | |
887 | (display-buffer (process-buffer (get-process "tex-shell"))) | |
888 | (tex-recenter-output-buffer nil)) | |
528415e7 RS |
889 | |
890 | (defun tex-shell-sentinel (proc msg) | |
891 | (cond ((null (buffer-name (process-buffer proc))) | |
892 | ;; buffer killed | |
893 | (set-process-buffer proc nil) | |
894 | (tex-delete-last-temp-files)) | |
895 | ((memq (process-status proc) '(signal exit)) | |
896 | (tex-delete-last-temp-files)))) | |
897 | ||
898 | (defun tex-set-buffer-directory (buffer directory) | |
869bff31 | 899 | "Set BUFFER's default directory to be DIRECTORY." |
900 | (setq directory (file-name-as-directory (expand-file-name directory))) | |
901 | (if (not (file-directory-p directory)) | |
902 | (error "%s is not a directory" directory) | |
903 | (save-excursion | |
904 | (set-buffer buffer) | |
905 | (setq default-directory directory)))) | |
906 | ||
30803a05 RS |
907 | (defvar tex-send-command-modified-tick 0) |
908 | (make-variable-buffer-local 'tex-send-command-modified-tick) | |
909 | ||
528415e7 | 910 | (defun tex-send-command (command &optional file background) |
4cdc1d4b | 911 | "Send COMMAND to TeX shell process, substituting optional FILE for *. |
8241d7b9 ER |
912 | Do this in background if optional BACKGROUND is t. If COMMAND has no *, |
913 | FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no | |
914 | substitution will be made in COMMAND. COMMAND can be any expression that | |
915 | evaluates to a command string." | |
528415e7 RS |
916 | (save-excursion |
917 | (let* ((cmd (eval command)) | |
c93931c3 | 918 | (proc (or (get-process "tex-shell") (error "No TeX subprocess"))) |
64db2461 | 919 | (buf (process-buffer proc)) |
4f45adda | 920 | (star (string-match "\\*" cmd)) |
4cdc1d4b RS |
921 | (string |
922 | (concat | |
923 | (if file | |
924 | (if star (concat (substring cmd 0 star) | |
925 | file (substring cmd (1+ star))) | |
926 | (concat cmd " " file)) | |
927 | cmd) | |
928 | (if background "&" "")))) | |
64db2461 RS |
929 | ;; Switch to buffer before checking for subproc output in it. |
930 | (set-buffer buf) | |
30803a05 RS |
931 | ;; If text is unchanged since previous tex-send-command, |
932 | ;; we haven't got any output. So wait for output now. | |
64db2461 | 933 | (if (= (buffer-modified-tick buf) tex-send-command-modified-tick) |
30803a05 | 934 | (accept-process-output proc)) |
4cdc1d4b RS |
935 | (goto-char (process-mark proc)) |
936 | (insert string) | |
30803a05 | 937 | (comint-send-input) |
64db2461 | 938 | (setq tex-send-command-modified-tick (buffer-modified-tick buf))))) |
528415e7 | 939 | |
a15849cb RS |
940 | (defun tex-delete-last-temp-files (&optional not-all) |
941 | "Delete any junk files from last temp file. | |
942 | If NOT-ALL is non-nil, save the `.dvi' file." | |
528415e7 RS |
943 | (if tex-last-temp-file |
944 | (let* ((dir (file-name-directory tex-last-temp-file)) | |
adf6b7f9 KH |
945 | (list (and (file-directory-p dir) |
946 | (file-name-all-completions | |
947 | (file-name-nondirectory tex-last-temp-file) dir)))) | |
948 | (while list | |
a15849cb RS |
949 | (if not-all |
950 | (and | |
951 | ;; If arg is non-nil, don't delete the .dvi file. | |
952 | (not (string-match "\\.dvi$" (car list))) | |
953 | (delete-file (concat dir (car list)))) | |
954 | (delete-file (concat dir (car list)))) | |
528415e7 RS |
955 | (setq list (cdr list)))))) |
956 | ||
99621a14 | 957 | (add-hook 'kill-emacs-hook 'tex-delete-last-temp-files) |
869bff31 | 958 | |
528415e7 | 959 | ;;; The commands: |
869bff31 | 960 | |
961 | (defun tex-region (beg end) | |
962 | "Run TeX on the current region, via a temporary file. | |
963 | The file's name comes from the variable `tex-zap-file' and the | |
964 | variable `tex-directory' says where to put it. | |
965 | ||
966 | If the buffer has a header, the header is given to TeX before the | |
967 | region itself. The buffer's header is all lines between the strings | |
968 | defined by `tex-start-of-header' and `tex-end-of-header' inclusive. | |
969 | The header must start in the first 100 lines of the buffer. | |
970 | ||
971 | The value of `tex-trailer' is given to TeX as input after the region. | |
972 | ||
973 | The value of `tex-command' specifies the command to use to run TeX." | |
974 | (interactive "r") | |
975 | (if (tex-shell-running) | |
976 | (tex-kill-job) | |
977 | (tex-start-shell)) | |
978 | (or tex-zap-file | |
979 | (setq tex-zap-file (tex-generate-zap-file-name))) | |
528415e7 RS |
980 | (let* ((temp-buffer (get-buffer-create " TeX-Output-Buffer")) |
981 | ; Temp file will be written and TeX will be run in zap-directory. | |
982 | ; If the TEXINPUTS file has relative directories or if the region has | |
983 | ; \input of files, this must be the same directory as the file for | |
984 | ; TeX to access the correct inputs. That's why it's safest if | |
985 | ; tex-directory is ".". | |
986 | (zap-directory | |
987 | (file-name-as-directory (expand-file-name tex-directory))) | |
988 | (tex-out-file (concat zap-directory tex-zap-file))) | |
0d548e5d RS |
989 | ;; Don't delete temp files if we do the same buffer twice in a row. |
990 | (or (eq (current-buffer) tex-last-buffer-texed) | |
991 | (tex-delete-last-temp-files t)) | |
869bff31 | 992 | ;; Write the new temp file. |
993 | (save-excursion | |
994 | (save-restriction | |
995 | (widen) | |
996 | (goto-char (point-min)) | |
997 | (forward-line 100) | |
998 | (let ((search-end (point)) | |
999 | (hbeg (point-min)) (hend (point-min)) | |
1000 | (default-directory zap-directory)) | |
1001 | (goto-char (point-min)) | |
1002 | ;; Initialize the temp file with either the header or nothing | |
898b9ac1 | 1003 | (if (re-search-forward tex-start-of-header search-end t) |
869bff31 | 1004 | (progn |
1005 | (beginning-of-line) | |
1006 | (setq hbeg (point)) ;mark beginning of header | |
898b9ac1 | 1007 | (if (re-search-forward tex-end-of-header nil t) |
869bff31 | 1008 | (progn (forward-line 1) |
1009 | (setq hend (point))) ;mark end of header | |
1010 | (setq hbeg (point-min))))) ;no header | |
528415e7 RS |
1011 | (write-region (min hbeg beg) hend |
1012 | (concat tex-out-file ".tex") nil nil) | |
1013 | (write-region (max beg hend) end (concat tex-out-file ".tex") t nil)) | |
869bff31 | 1014 | (let ((local-tex-trailer tex-trailer)) |
1015 | (set-buffer temp-buffer) | |
1016 | (erase-buffer) | |
1017 | ;; make sure trailer isn't hidden by a comment | |
1018 | (insert-string "\n") | |
1019 | (if local-tex-trailer (insert-string local-tex-trailer)) | |
528415e7 RS |
1020 | (tex-set-buffer-directory temp-buffer zap-directory) |
1021 | (write-region (point-min) (point-max) | |
1022 | (concat tex-out-file ".tex") t nil)))) | |
1023 | ;; Record the file name to be deleted afterward. | |
1024 | (setq tex-last-temp-file tex-out-file) | |
1025 | (tex-send-command tex-shell-cd-command zap-directory) | |
1026 | (tex-send-command tex-command tex-out-file) | |
51b2c841 | 1027 | (tex-display-shell) |
528415e7 RS |
1028 | (setq tex-print-file tex-out-file) |
1029 | (setq tex-last-buffer-texed (current-buffer)))) | |
869bff31 | 1030 | |
1031 | (defun tex-buffer () | |
1032 | "Run TeX on current buffer. See \\[tex-region] for more information. | |
528415e7 RS |
1033 | Does not save the buffer, so it's useful for trying experimental versions. |
1034 | See \\[tex-file] for an alternative." | |
869bff31 | 1035 | (interactive) |
1036 | (tex-region (point-min) (point-max))) | |
1037 | ||
1038 | (defun tex-file () | |
1039 | "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file. | |
1040 | This function is more useful than \\[tex-buffer] when you need the | |
1041 | `.aux' file of LaTeX to have the correct name." | |
1042 | (interactive) | |
1043 | (let ((tex-out-file | |
1044 | (if (buffer-file-name) | |
1045 | (file-name-nondirectory (buffer-file-name)) | |
1046 | (error "Buffer does not seem to be associated with any file"))) | |
1047 | (file-dir (file-name-directory (buffer-file-name)))) | |
7047ec77 | 1048 | (if tex-offer-save |
99621a14 | 1049 | (save-some-buffers)) |
869bff31 | 1050 | (if (tex-shell-running) |
1051 | (tex-kill-job) | |
1052 | (tex-start-shell)) | |
528415e7 RS |
1053 | (tex-send-command tex-shell-cd-command file-dir) |
1054 | (tex-send-command tex-command tex-out-file)) | |
51b2c841 | 1055 | (tex-display-shell) |
869bff31 | 1056 | (setq tex-last-buffer-texed (current-buffer)) |
528415e7 | 1057 | (setq tex-print-file (buffer-file-name))) |
869bff31 | 1058 | |
1059 | (defun tex-generate-zap-file-name () | |
1060 | "Generate a unique name suitable for use as a file name." | |
1061 | ;; Include the shell process number and host name | |
1062 | ;; in case there are multiple shells (for same or different user). | |
1063 | (format "#tz%d%s" | |
1064 | (process-id (get-buffer-process "*tex-shell*")) | |
1065 | (tex-strip-dots (system-name)))) | |
1066 | ||
1067 | (defun tex-strip-dots (s) | |
1068 | (setq s (copy-sequence s)) | |
1069 | (while (string-match "\\." s) | |
1070 | (aset s (match-beginning 0) ?-)) | |
1071 | s) | |
1072 | ||
1073 | ;; This will perhaps be useful for modifying TEXINPUTS. | |
1074 | ;; Expand each file name, separated by colons, in the string S. | |
1075 | (defun tex-expand-files (s) | |
1076 | (let (elts (start 0)) | |
1077 | (while (string-match ":" s start) | |
1078 | (setq elts (cons (substring s start (match-beginning 0)) elts)) | |
1079 | (setq start (match-end 0))) | |
1080 | (or (= start 0) | |
1081 | (setq elts (cons (substring s start) elts))) | |
1082 | (mapconcat 'expand-file-name (nreverse elts) ":"))) | |
1083 | ||
1084 | (defun tex-shell-running () | |
1085 | (and (get-process "tex-shell") | |
1086 | (eq (process-status (get-process "tex-shell")) 'run))) | |
1087 | ||
1088 | (defun tex-kill-job () | |
1089 | "Kill the currently running TeX job." | |
1090 | (interactive) | |
528415e7 | 1091 | (quit-process (get-process "tex-shell") t)) |
869bff31 | 1092 | |
1093 | (defun tex-recenter-output-buffer (linenum) | |
1094 | "Redisplay buffer of TeX job output so that most recent output can be seen. | |
1095 | The last line of the buffer is displayed on | |
1096 | line LINE of the window, or centered if LINE is nil." | |
1097 | (interactive "P") | |
1098 | (let ((tex-shell (get-buffer "*tex-shell*")) | |
1099 | (old-buffer (current-buffer))) | |
1100 | (if (null tex-shell) | |
1101 | (message "No TeX output buffer") | |
1102 | (pop-to-buffer tex-shell) | |
1103 | (bury-buffer tex-shell) | |
1104 | (goto-char (point-max)) | |
1105 | (recenter (if linenum | |
1106 | (prefix-numeric-value linenum) | |
1107 | (/ (window-height) 2))) | |
528415e7 | 1108 | (pop-to-buffer old-buffer)))) |
869bff31 | 1109 | |
528415e7 | 1110 | (defun tex-print (&optional alt) |
869bff31 | 1111 | "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file]. |
1433a222 CZ |
1112 | Runs the shell command defined by `tex-dvi-print-command'. If prefix argument |
1113 | is provided, use the alternative command, `tex-alt-dvi-print-command'." | |
528415e7 | 1114 | (interactive "P") |
869bff31 | 1115 | (let ((print-file-name-dvi (tex-append tex-print-file ".dvi")) |
1116 | test-name) | |
1117 | (if (and (not (equal (current-buffer) tex-last-buffer-texed)) | |
45c3304d RS |
1118 | (buffer-file-name) |
1119 | ;; Check that this buffer's printed file is up to date. | |
869bff31 | 1120 | (file-newer-than-file-p |
1121 | (setq test-name (tex-append (buffer-file-name) ".dvi")) | |
45c3304d | 1122 | (buffer-file-name))) |
869bff31 | 1123 | (setq print-file-name-dvi test-name)) |
528415e7 RS |
1124 | (if (not (file-exists-p print-file-name-dvi)) |
1125 | (error "No appropriate `.dvi' file could be found") | |
1126 | (tex-send-command | |
1127 | (if alt tex-alt-dvi-print-command tex-dvi-print-command) | |
1128 | print-file-name-dvi t)))) | |
869bff31 | 1129 | |
cf6d6e8a RS |
1130 | (defun tex-alt-print () |
1131 | "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file]. | |
002b0d00 | 1132 | Runs the shell command defined by `tex-alt-dvi-print-command'." |
cf6d6e8a RS |
1133 | (interactive) |
1134 | (tex-print t)) | |
1135 | ||
869bff31 | 1136 | (defun tex-view () |
1137 | "Preview the last `.dvi' file made by running TeX under Emacs. | |
1138 | This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file]. | |
2b7971c9 RS |
1139 | The variable `tex-dvi-view-command' specifies the shell command for preview. |
1140 | You must set that variable yourself before using this command, | |
1141 | because there is no standard value that would generally work." | |
869bff31 | 1142 | (interactive) |
2b7971c9 RS |
1143 | (or tex-dvi-view-command |
1144 | (error "You must set `tex-dvi-view-command'")) | |
869bff31 | 1145 | (let ((tex-dvi-print-command tex-dvi-view-command)) |
1146 | (tex-print))) | |
1147 | ||
1148 | (defun tex-append (file-name suffix) | |
1149 | "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses. | |
cf6d6e8a | 1150 | Pascal-based TeX scans for the first period, C TeX uses the last. |
869bff31 | 1151 | No period is retained immediately before SUFFIX, |
1152 | so normally SUFFIX starts with one." | |
1153 | (if (stringp file-name) | |
cf6d6e8a RS |
1154 | (let ((file (file-name-nondirectory file-name)) |
1155 | trial-name) | |
6da9bbd6 | 1156 | ;; Try splitting on last period. |
7d0ca249 RS |
1157 | ;; The first-period split can get fooled when two files |
1158 | ;; named a.tex and a.b.tex are both tex'd; | |
1159 | ;; the last-period split must be right if it matches at all. | |
cf6d6e8a RS |
1160 | (setq trial-name |
1161 | (concat (file-name-directory file-name) | |
1162 | (substring file 0 | |
7d0ca249 | 1163 | (string-match "\\.[^.]*$" file)) |
cf6d6e8a RS |
1164 | suffix)) |
1165 | (if (or (file-exists-p trial-name) | |
1166 | (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files | |
1167 | trial-name | |
7d0ca249 | 1168 | ;; Not found, so split on first period. |
cf6d6e8a RS |
1169 | (concat (file-name-directory file-name) |
1170 | (substring file 0 | |
7d0ca249 | 1171 | (string-match "\\." file)) |
cf6d6e8a | 1172 | suffix))) |
869bff31 | 1173 | " ")) |
1174 | ||
1175 | (defun tex-show-print-queue () | |
1176 | "Show the print queue that \\[tex-print] put your job on. | |
1433a222 | 1177 | Runs the shell command defined by `tex-show-queue-command'." |
869bff31 | 1178 | (interactive) |
1179 | (if (tex-shell-running) | |
1180 | (tex-kill-job) | |
1181 | (tex-start-shell)) | |
51b2c841 RS |
1182 | (tex-send-command tex-show-queue-command) |
1183 | (tex-display-shell)) | |
869bff31 | 1184 | |
1185 | (defun tex-bibtex-file () | |
1186 | "Run BibTeX on the current buffer's file." | |
1187 | (interactive) | |
1188 | (if (tex-shell-running) | |
1189 | (tex-kill-job) | |
1190 | (tex-start-shell)) | |
1191 | (let ((tex-out-file | |
1192 | (tex-append (file-name-nondirectory (buffer-file-name)) "")) | |
1193 | (file-dir (file-name-directory (buffer-file-name)))) | |
528415e7 | 1194 | (tex-send-command tex-shell-cd-command file-dir) |
51b2c841 RS |
1195 | (tex-send-command tex-bibtex-command tex-out-file)) |
1196 | (tex-display-shell)) | |
528415e7 RS |
1197 | |
1198 | (run-hooks 'tex-mode-load-hook) | |
869bff31 | 1199 | |
49116ac0 JB |
1200 | (provide 'tex-mode) |
1201 | ||
d501f516 | 1202 | ;;; tex-mode.el ends here |
99621a14 | 1203 |