1 ;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands.
3 ;; Copyright (C) 1985, 86, 89, 92, 94, 95 Free Software Foundation, Inc.
8 ;; Contributions over the years by William F. Schelter, Dick King,
9 ;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold.
11 ;; This file is part of GNU Emacs.
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
15 ;; the Free Software Foundation; either version 2, or (at your option)
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
33 (defvar tex-shell-file-name nil
34 "*If non-nil, the shell file name to run in the subshell used to run TeX.")
37 (defvar tex-directory
"."
38 "*Directory in which temporary files are left.
39 You can make this `/tmp' if your TEXINPUTS has no relative directories in it
40 and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
41 `\\input' commands with relative directories.")
44 (defvar tex-offer-save t
45 "*If non-nil, ask about saving modified buffers before \\[tex-file] is run.")
48 (defvar tex-run-command
"tex"
49 "*Command used to run TeX subjob.
50 If this string contains an asterisk (`*'), that is replaced by the file name;
51 otherwise, the file name, preceded by blank, is added at the end.")
54 (defvar latex-run-command
"latex"
55 "*Command used to run LaTeX subjob.
56 If this string contains an asterisk (`*'), that is replaced by the file name;
57 otherwise, the file name, preceded by blank, is added at the end.")
59 (defvar standard-latex-block-names
60 '("abstract" "array" "center" "description"
61 "displaymath" "document" "enumerate" "eqnarray"
62 "eqnarray*" "equation" "figure" "figure*"
63 "flushleft" "flushright" "itemize" "letter"
64 "list" "minipage" "picture" "quotation"
65 "quote" "slide" "sloppypar" "tabbing"
66 "table" "table*" "tabular" "tabular*"
67 "thebibliography" "theindex*" "titlepage" "trivlist"
68 "verbatim" "verbatim*" "verse")
69 "Standard LaTeX block names.")
72 (defvar latex-block-names nil
73 "*User defined LaTeX block names.
74 Combined with `standard-latex-block-names' for minibuffer completion.")
77 (defvar slitex-run-command
"slitex"
78 "*Command used to run SliTeX subjob.
79 If this string contains an asterisk (`*'), that is replaced by the file name;
80 otherwise, the file name, preceded by blank, is added at the end.")
83 (defvar tex-bibtex-command
"bibtex"
84 "*Command used by `tex-bibtex-file' to gather bibliographic data.
85 If this string contains an asterisk (`*'), that is replaced by the file name;
86 otherwise, the file name, preceded by blank, is added at the end.")
89 (defvar tex-dvi-print-command
"lpr -d"
90 "*Command used by \\[tex-print] to print a .dvi file.
91 If this string contains an asterisk (`*'), that is replaced by the file name;
92 otherwise, the file name, preceded by blank, is added at the end.")
95 (defvar tex-alt-dvi-print-command
"lpr -d"
96 "*Command used by \\[tex-print] with a prefix arg to print a .dvi file.
97 If this string contains an asterisk (`*'), that is replaced by the file name;
98 otherwise, the file name, preceded by blank, is added at the end.
100 If two printers are not enough of a choice, you can set the variable
101 `tex-alt-dvi-print-command' to an expression that asks what you want;
104 (setq tex-alt-dvi-print-command
105 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
107 would tell \\[tex-print] with a prefix argument to ask you which printer to
111 (defvar tex-dvi-view-command nil
112 "*Command used by \\[tex-view] to display a `.dvi' file.
113 If this string contains an asterisk (`*'), that is replaced by the file name;
114 otherwise, the file name, preceded by blank, is added at the end.
116 This can be set conditionally so that the previewer used is suitable for the
117 window system being used. For example,
119 (setq tex-dvi-view-command
120 (if (eq window-system 'x) \"xdvi\" \"dvi2tty * | cat -s\"))
122 would tell \\[tex-view] to use xdvi under X windows and to use dvi2tty
126 (defvar tex-show-queue-command
"lpq"
127 "*Command used by \\[tex-show-print-queue] to show the print queue.
128 Should show the queue(s) that \\[tex-print] puts jobs on.")
131 (defvar tex-default-mode
'plain-tex-mode
132 "*Mode to enter for a new file that might be either TeX or LaTeX.
133 This variable is used when it can't be determined whether the file
134 is plain TeX or LaTeX or what because the file contains no commands.
135 Normally set to either `plain-tex-mode' or `latex-mode'.")
138 (defvar tex-open-quote
"``"
139 "*String inserted by typing \\[tex-insert-quote] to open a quotation.")
142 (defvar tex-close-quote
"''"
143 "*String inserted by typing \\[tex-insert-quote] to close a quotation.")
145 (defvar tex-last-temp-file nil
146 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
147 Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
148 tex shell terminates.")
150 (defvar tex-command nil
152 The name of the file, preceded by a blank, will be added to this string.")
154 (defvar tex-trailer nil
155 "String appended after the end of a region sent to TeX by \\[tex-region].")
157 (defvar tex-start-of-header nil
158 "String used by \\[tex-region] to delimit the start of the file's header.")
160 (defvar tex-end-of-header nil
161 "String used by \\[tex-region] to delimit the end of the file's header.")
163 (defvar tex-shell-cd-command
"cd"
164 "Command to give to shell running TeX to change directory.
165 The value of `tex-directory' is appended to this, separated by a space.")
167 (defvar tex-zap-file nil
168 "Temporary file name used for text being sent as input to TeX.
169 Should be a simple file name with no extension or directory specification.")
171 (defvar tex-last-buffer-texed nil
172 "Buffer which was last TeXed.")
174 (defvar tex-print-file nil
175 "File name that \\[tex-print] prints.
176 Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
178 (defvar tex-mode-syntax-table nil
179 "Syntax table used while in TeX mode.")
181 (defun tex-define-common-keys (keymap)
182 "Define the keys that we want defined both in TeX mode and in the TeX shell."
183 (define-key keymap
"\C-c\C-k" 'tex-kill-job
)
184 (define-key keymap
"\C-c\C-l" 'tex-recenter-output-buffer
)
185 (define-key keymap
"\C-c\C-q" 'tex-show-print-queue
)
186 (define-key keymap
"\C-c\C-p" 'tex-print
)
187 (define-key keymap
"\C-c\C-v" 'tex-view
)
189 (define-key keymap
[menu-bar tex
] (cons "TeX" (make-sparse-keymap "TeX")))
191 (define-key keymap
[menu-bar tex tex-kill-job
] '("Tex Kill" . tex-kill-job
))
192 (define-key keymap
[menu-bar tex tex-recenter-output-buffer
]
193 '("Tex Recenter" . tex-recenter-output-buffer
))
194 (define-key keymap
[menu-bar tex tex-show-print-queue
]
195 '("Show Print Queue" . tex-show-print-queue
))
196 (define-key keymap
[menu-bar tex tex-alt-print
]
197 '("Tex Print (alt printer)" . tex-alt-print
))
198 (define-key keymap
[menu-bar tex tex-print
] '("Tex Print" . tex-print
))
199 (define-key keymap
[menu-bar tex tex-view
] '("Tex View" . tex-view
))
202 (defvar tex-mode-map nil
"Keymap for TeX mode.")
206 (setq tex-mode-map
(make-sparse-keymap))
207 (tex-define-common-keys tex-mode-map
)
208 (define-key tex-mode-map
"\"" 'tex-insert-quote
)
209 (define-key tex-mode-map
"\n" 'tex-terminate-paragraph
)
210 (define-key tex-mode-map
"\C-c}" 'up-list
)
211 (define-key tex-mode-map
"\C-c{" 'tex-insert-braces
)
212 (define-key tex-mode-map
"\C-c\C-r" 'tex-region
)
213 (define-key tex-mode-map
"\C-c\C-b" 'tex-buffer
)
214 (define-key tex-mode-map
"\C-c\C-f" 'tex-file
)
215 (define-key tex-mode-map
"\C-c\C-i" 'tex-bibtex-file
)
216 (define-key tex-mode-map
"\C-c\C-o" 'tex-latex-block
)
217 (define-key tex-mode-map
"\C-c\C-e" 'tex-close-latex-block
)
218 (define-key tex-mode-map
"\C-c\C-u" 'tex-goto-last-unclosed-latex-block
)
219 (define-key tex-mode-map
[menu-bar tex tex-bibtex-file
]
220 '("BibTeX File" . tex-bibtex-file
))
221 (define-key tex-mode-map
[menu-bar tex tex-validate-region
]
222 '("Validate Region" . tex-validate-region
))
223 (define-key tex-mode-map
[menu-bar tex validate-tex-buffer
]
224 '("Validate Buffer" . validate-tex-buffer
))
225 (define-key tex-mode-map
[menu-bar tex tex-region
]
226 '("TeX Region" . tex-region
))
227 (define-key tex-mode-map
[menu-bar tex tex-buffer
]
228 '("TeX Buffer" . tex-buffer
))
229 (define-key tex-mode-map
[menu-bar tex tex-file
] '("TeX File" . tex-file
)))
231 (put 'tex-region
'menu-enable
'mark-active
)
232 (put 'tex-validate-region
'menu-enable
'mark-active
)
233 (put 'tex-print
'menu-enable
'(stringp tex-print-file
))
234 (put 'tex-alt-print
'menu-enable
'(stringp tex-print-file
))
235 (put 'tex-view
'menu-enable
'(stringp tex-print-file
))
236 (put 'tex-recenter-output-buffer
'menu-enable
'(get-buffer "*tex-shell*"))
237 (put 'tex-kill-job
'menu-enable
'(tex-shell-running))
240 (defvar tex-shell-map nil
241 "Keymap for the TeX shell.
242 Inherits `shell-mode-map' with a few additions.")
244 (defvar compare-windows-whitespace
) ; Pacify the byte-compiler
246 ;;; This would be a lot simpler if we just used a regexp search,
247 ;;; but then it would be too slow.
250 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
251 Tries to determine (by looking at the beginning of the file) whether
252 this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
253 `latex-mode', or `slitex-mode', respectively. If it cannot be determined,
254 such as if there are no commands in the file, the value of `tex-default-mode'
255 says which mode to use."
257 (let (mode slash comment
)
259 (goto-char (point-min))
260 (while (and (setq slash
(search-forward "\\" nil t
))
261 (setq comment
(let ((search-end (point)))
264 (search-forward "%" search-end t
))))))
265 (if (and slash
(not comment
))
266 (setq mode
(if (looking-at "documentstyle\\|documentclass\\|begin\\b\\|NeedsTeXFormat{LaTeX")
268 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
272 (if mode
(funcall mode
)
273 (funcall tex-default-mode
))))
276 (defalias 'TeX-mode
'tex-mode
)
278 (defalias 'LaTeX-mode
'latex-mode
)
281 (defun plain-tex-mode ()
282 "Major mode for editing files of input for plain TeX.
283 Makes $ and } display the characters they match.
284 Makes \" insert `` when it seems to be the beginning of a quotation,
285 and '' when it appears to be the end; it inserts \" only after a \\.
287 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
288 copied from the top of the file (containing macro definitions, etc.),
289 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
290 \\[tex-file] saves the buffer and then processes the file.
291 \\[tex-print] prints the .dvi file made by any of these.
292 \\[tex-view] previews the .dvi file made by any of these.
293 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
295 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
296 mismatched $'s or braces.
303 Command string used by \\[tex-region] or \\[tex-buffer].
305 Directory in which to create temporary files for TeX jobs
306 run by \\[tex-region] or \\[tex-buffer].
307 tex-dvi-print-command
308 Command string used by \\[tex-print] to print a .dvi file.
309 tex-alt-dvi-print-command
310 Alternative command string used by \\[tex-print] (when given a prefix
311 argument) to print a .dvi file.
313 Command string used by \\[tex-view] to preview a .dvi file.
314 tex-show-queue-command
315 Command string used by \\[tex-show-print-queue] to show the print
316 queue that \\[tex-print] put your job on.
318 Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
319 `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
320 special subshell is initiated, the hook `tex-shell-hook' is run."
323 (tex-common-initialization)
324 (setq mode-name
"TeX")
325 (setq major-mode
'plain-tex-mode
)
326 (setq tex-command tex-run-command
)
327 (setq tex-start-of-header
"%**start of header")
328 (setq tex-end-of-header
"%**end of header")
329 (setq tex-trailer
"\\bye\n")
330 (run-hooks 'text-mode-hook
'tex-mode-hook
'plain-tex-mode-hook
))
332 (defalias 'plain-TeX-mode
'plain-tex-mode
)
336 "Major mode for editing files of input for LaTeX.
337 Makes $ and } display the characters they match.
338 Makes \" insert `` when it seems to be the beginning of a quotation,
339 and '' when it appears to be the end; it inserts \" only after a \\.
341 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
342 copied from the top of the file (containing \\documentstyle, etc.),
343 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
344 \\[tex-file] saves the buffer and then processes the file.
345 \\[tex-print] prints the .dvi file made by any of these.
346 \\[tex-view] previews the .dvi file made by any of these.
347 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
349 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
350 mismatched $'s or braces.
357 Command string used by \\[tex-region] or \\[tex-buffer].
359 Directory in which to create temporary files for LaTeX jobs
360 run by \\[tex-region] or \\[tex-buffer].
361 tex-dvi-print-command
362 Command string used by \\[tex-print] to print a .dvi file.
363 tex-alt-dvi-print-command
364 Alternative command string used by \\[tex-print] (when given a prefix
365 argument) to print a .dvi file.
367 Command string used by \\[tex-view] to preview a .dvi file.
368 tex-show-queue-command
369 Command string used by \\[tex-show-print-queue] to show the print
370 queue that \\[tex-print] put your job on.
372 Entering Latex mode runs the hook `text-mode-hook', then
373 `tex-mode-hook', and finally `latex-mode-hook'. When the special
374 subshell is initiated, `tex-shell-hook' is run."
376 (tex-common-initialization)
377 (setq mode-name
"LaTeX")
378 (setq major-mode
'latex-mode
)
379 (setq tex-command latex-run-command
)
380 (setq tex-start-of-header
"\\documentstyle")
381 (setq tex-end-of-header
"\\begin{document}")
382 (setq tex-trailer
"\\end{document}\n")
383 ;; A line containing just $$ is treated as a paragraph separator.
384 ;; A line starting with $$ starts a paragraph,
385 ;; but does not separate paragraphs if it has more stuff on it.
386 (setq paragraph-start
"[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\
387 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
388 \\\\chapter\\>\\|\\\\section\\>\\|\
389 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
390 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
391 \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\
392 \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\
393 \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\
394 \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>")
395 (setq paragraph-separate
"[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\
396 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
397 \\\\chapter\\>\\|\\\\section\\>\\|\
398 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
399 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
400 \\(\\\\item\\|\\\\bibitem\\|\\\\newline\\|\\\\noindent\\|\
401 \\\\[a-z]*space\\|\\\\[a-z]*skip\\|\
402 \\\\newpage\\|\\\\[a-z]*page[a-z]*\\|\\\\footnote\\|\
403 \\\\marginpar\\|\\\\parbox\\|\\\\caption\\)[ \t]*\\($\\|%\\)")
404 (run-hooks 'text-mode-hook
'tex-mode-hook
'latex-mode-hook
))
407 (defun slitex-mode ()
408 "Major mode for editing files of input for SliTeX.
409 Makes $ and } display the characters they match.
410 Makes \" insert `` when it seems to be the beginning of a quotation,
411 and '' when it appears to be the end; it inserts \" only after a \\.
413 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
414 copied from the top of the file (containing \\documentstyle, etc.),
415 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
416 \\[tex-file] saves the buffer and then processes the file.
417 \\[tex-print] prints the .dvi file made by any of these.
418 \\[tex-view] previews the .dvi file made by any of these.
419 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
421 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
422 mismatched $'s or braces.
429 Command string used by \\[tex-region] or \\[tex-buffer].
431 Directory in which to create temporary files for SliTeX jobs
432 run by \\[tex-region] or \\[tex-buffer].
433 tex-dvi-print-command
434 Command string used by \\[tex-print] to print a .dvi file.
435 tex-alt-dvi-print-command
436 Alternative command string used by \\[tex-print] (when given a prefix
437 argument) to print a .dvi file.
439 Command string used by \\[tex-view] to preview a .dvi file.
440 tex-show-queue-command
441 Command string used by \\[tex-show-print-queue] to show the print
442 queue that \\[tex-print] put your job on.
444 Entering SliTeX mode runs the hook `text-mode-hook', then the hook
445 `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
446 `slitex-mode-hook'. When the special subshell is initiated, the hook
447 `tex-shell-hook' is run."
449 (tex-common-initialization)
450 (setq mode-name
"SliTeX")
451 (setq major-mode
'slitex-mode
)
452 (setq tex-command slitex-run-command
)
453 (setq tex-start-of-header
"\\documentstyle{slides}")
454 (setq tex-end-of-header
"\\begin{document}")
455 (setq tex-trailer
"\\end{document}\n")
456 ;; A line containing just $$ is treated as a paragraph separator.
457 ;; A line starting with $$ starts a paragraph,
458 ;; but does not separate paragraphs if it has more stuff on it.
459 (setq paragraph-start
"[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\
460 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
461 \\\\chapter\\>\\|\\\\section\\>\\|\
462 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
463 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
464 \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\
465 \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\
466 \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\
467 \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>")
468 (setq paragraph-separate
"[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\
469 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
470 \\\\chapter\\>\\|\\\\section\\>\\|\
471 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
472 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
473 \\\\item[ \t]*$\\|\\\\bibitem[ \t]*$\\|\\\\newline[ \t]*$\\|\\\\noindent[ \t]*$\\|\
474 \\\\[a-z]*space[ \t]*$\\|\\\\[a-z]*skip[ \t]*$\\|\
475 \\\\newpage[ \t]*$\\|\\\\[a-z]*page[a-z]*[ \t]*$\\|\\\\footnote[ \t]*$\\|\
476 \\\\marginpar[ \t]*$\\|\\\\parbox[ \t]*$\\|\\\\caption[ \t]*$")
478 'text-mode-hook
'tex-mode-hook
'latex-mode-hook
'slitex-mode-hook
))
480 (defun tex-common-initialization ()
481 (kill-all-local-variables)
482 (use-local-map tex-mode-map
)
483 (setq local-abbrev-table text-mode-abbrev-table
)
484 (if (null tex-mode-syntax-table
)
486 (setq tex-mode-syntax-table
(make-syntax-table))
487 (set-syntax-table tex-mode-syntax-table
)
489 (modify-syntax-entry char
".")
490 (setq char
(1+ char
)))
491 (modify-syntax-entry ?\C-
@ "w")
492 (modify-syntax-entry ?
\t " ")
493 (modify-syntax-entry ?
\n ">")
494 (modify-syntax-entry ?
\f ">")
495 (modify-syntax-entry ?$
"$$")
496 (modify-syntax-entry ?%
"<")
497 (modify-syntax-entry ?
\\ "/")
498 (modify-syntax-entry ?
\" ".")
499 (modify-syntax-entry ?
& ".")
500 (modify-syntax-entry ?_
".")
501 (modify-syntax-entry ?
@ "_")
502 (modify-syntax-entry ?~
" ")
503 (modify-syntax-entry ?
' "w"))
504 (set-syntax-table tex-mode-syntax-table
))
505 (make-local-variable 'paragraph-start
)
506 ;; A line containing just $$ is treated as a paragraph separator.
507 (setq paragraph-start
"[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
508 (make-local-variable 'paragraph-separate
)
509 ;; A line starting with $$ starts a paragraph,
510 ;; but does not separate paragraphs if it has more stuff on it.
511 (setq paragraph-separate
"[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
512 (make-local-variable 'comment-start
)
513 (setq comment-start
"%")
514 (make-local-variable 'comment-start-skip
)
515 (setq comment-start-skip
"\\(\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
516 (make-local-variable 'comment-indent-function
)
517 (setq comment-indent-function
'tex-comment-indent
)
518 (make-local-variable 'parse-sexp-ignore-comments
)
519 (setq parse-sexp-ignore-comments t
)
520 (make-local-variable 'compare-windows-whitespace
)
521 (setq compare-windows-whitespace
'tex-categorize-whitespace
)
522 (make-local-variable 'tex-command
)
523 (make-local-variable 'tex-start-of-header
)
524 (make-local-variable 'tex-end-of-header
)
525 (make-local-variable 'tex-trailer
))
527 (defun tex-comment-indent ()
528 (if (looking-at "%%%")
530 (skip-chars-backward " \t")
531 (max (if (bolp) 0 (1+ (current-column)))
534 (defun tex-categorize-whitespace (backward-limit)
535 ;; compare-windows-whitespace is set to this.
536 ;; This is basically a finite-state machine.
537 ;; Returns a symbol telling how TeX would treat
538 ;; the whitespace we are looking at: null, space, or par.
539 (let ((category 'null
)
541 (skip-chars-backward " \t\n\f" backward-limit
)
543 (cond ((looking-at "[ \t]+")
544 (goto-char (match-end 0))
545 (if (eql category
'null
)
546 (setq category
'space
)))
548 (cond ((eql category
'newline
)
550 (setq not-finished nil
))
552 (setq category
'newline
) ;a strictly internal state
553 (goto-char (match-end 0)))))
556 (setq not-finished nil
))
558 (setq not-finished nil
))))
559 (skip-chars-forward " \t\n\f")
560 (if (eql category
'newline
)
561 'space
;TeX doesn't distinguish
564 (defun tex-insert-quote (arg)
565 "Insert the appropriate quote marks for TeX.
566 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
567 \(normally '') depending on the context. With prefix argument, always
568 inserts \" characters."
571 (self-insert-command (prefix-numeric-value arg
))
576 (looking-at "\\s(\\|\\s \\|\\s>")))
578 ((= (preceding-char) ?
\\)
583 (defun validate-tex-buffer ()
584 "Check current buffer for paragraphs containing mismatched $s.
585 Their positions are recorded in the buffer `*Occur*'.
586 To find a particular invalidity from `*Occur*',
587 switch to to that buffer and type C-c C-c on the line
588 for the invalidity you want to see."
590 (let ((buffer (current-buffer))
591 (prevpos (point-min))
593 (with-output-to-temp-buffer "*Occur*"
594 (princ "Mismatches:\n")
596 (set-buffer standard-output
)
598 (setq occur-buffer buffer
)
599 (setq occur-nlines
0)
600 (setq occur-pos-list nil
))
602 (goto-char (point-max))
603 (while (and (not (input-pending-p)) (not (bobp)))
605 ;; Scan the previous paragraph for invalidities.
606 (search-backward "\n\n" nil
'move
)
607 (or (tex-validate-region (point) end
)
608 (let* ((end (save-excursion (forward-line 1) (point)))
612 ;; Keep track of line number as we scan,
613 ;; in a cumulative fashion.
615 (setq linenum
(- linenum
(count-lines prevpos
(point))))
616 (setq linenum
(1+ (count-lines 1 start
))))
617 (setq prevpos
(point))
618 ;; Mention this mismatch in *Occur*.
619 ;; Since we scan from end of buffer to beginning,
620 ;; add each mismatch at the beginning of *Occur*
621 ;; and at the beginning of occur-pos-list.
623 (setq tem
(point-marker))
624 (set-buffer standard-output
)
625 (goto-char (point-min))
626 ;; Skip "Mismatches:" header line.
628 (setq occur-pos-list
(cons tem occur-pos-list
))
629 (insert-buffer-substring buffer start end
)
630 (forward-char (- start end
))
631 (insert (format "%3d: " linenum
))))))))
633 (set-buffer standard-output
)
634 (if (null occur-pos-list
)
637 (message "%d mismatches found" (length occur-pos-list
)))))))
639 (defun tex-validate-region (start end
)
640 "Check for mismatched braces or $'s in region.
641 Returns t if no mismatches. Returns nil and moves point to suspect
642 area if a mismatch is found."
644 (let ((failure-point nil
) (max-possible-sexps (- end start
)))
648 (narrow-to-region start end
)
650 (while (< 0 (setq max-possible-sexps
(1- max-possible-sexps
)))
653 (setq failure-point
(point)))))
656 (goto-char failure-point
)
660 (defun tex-terminate-paragraph (inhibit-validation)
661 "Insert two newlines, breaking a paragraph for TeX.
662 Check for mismatched braces or $s in paragraph being terminated.
663 A prefix arg inhibits the checking."
665 (or inhibit-validation
669 (search-backward "\n\n" nil
'move
)
672 (message "Paragraph being closed appears to contain a mismatch"))
675 (defun tex-insert-braces ()
676 "Make a pair of braces and be poised to type inside of them."
682 ;;; Like tex-insert-braces, but for LaTeX.
683 (defun tex-latex-block (name)
684 "Creates a matching pair of lines `\\begin{NAME}' and `\\end{NAME}' at point.
685 Puts point on a blank line between them."
688 (barf-if-buffer-read-only)
690 (completing-read "LaTeX block name: "
692 (append standard-latex-block-names
693 latex-block-names
))))))
694 (let ((col (current-column)))
695 (insert (format "\\begin{%s}\n" name
))
700 (insert-string (format "\\end{%s}" name
))
701 (if (eobp) (insert ?
\n)))))
703 (defun tex-last-unended-begin ()
704 "Leave point at the beginning of the last `\\begin{...}' that is unended."
705 (while (and (re-search-backward "\\(\\\\begin\\s *{\\)\\|\\(\\\\end\\s *{\\)")
706 (looking-at "\\\\end{"))
707 (tex-last-unended-begin)))
709 (defun tex-goto-last-unclosed-latex-block ()
710 "Move point to the last unclosed \\begin{...}.
711 Mark is left at original location."
716 (tex-last-unended-begin)
717 (error (error "Couldn't find unended \\begin")))
722 (defun tex-close-latex-block ()
723 "Creates an \\end{...} to match the last unclosed \\begin{...}."
725 (let ((new-line-needed (bolp))
729 (tex-last-unended-begin)
730 (error (error "Couldn't find unended \\begin")))
731 (setq indentation
(current-column))
732 (re-search-forward "\\\\begin\\(\\s *{[^}\n]*}\\)")
733 (setq text
(buffer-substring (match-beginning 1) (match-end 1))))
734 (indent-to indentation
)
735 (insert "\\end" text
)
736 (if new-line-needed
(insert ?
\n))))
738 (defun tex-compilation-parse-errors ()
739 "Parse the current buffer as error messages.
740 This makes a list of error descriptors, compilation-error-list.
741 For each source-file, line-number pair in the buffer,
742 the source file is read in, and the text location is saved in
743 compilation-error-list. The function `next-error', assigned to
744 \\[next-error], takes the next error off the list and visits its location.
746 This function works on TeX compilations only. It is necessary for
747 that purpose, since TeX does not put file names on the same line as
748 line numbers for the errors."
749 (setq compilation-error-list nil
)
750 (message "Parsing error messages...")
751 (modify-syntax-entry ?\
{ "_")
752 (modify-syntax-entry ?\
} "_")
753 (modify-syntax-entry ?\
[ "_")
754 (modify-syntax-entry ?\
] "_")
756 last-filename last-linenum
)
757 ;; Don't reparse messages already seen at last parse.
758 (goto-char compilation-parsing-end
)
759 ;; Don't parse the first two lines as error messages.
760 ;; This matters for grep.
763 (while (re-search-forward "^l\.[0-9]+ " nil t
)
764 (let (linenum filename
765 error-marker text-marker
)
766 ;; Extract file name and line number from error message.
767 ;; Line number is 2 away from beginning of line: "l.23"
769 (goto-char (+ (point) 2))
770 (setq linenum
(read (current-buffer)))
771 ;; The file is the one that was opened last and is still open.
772 ;; We need to find the last open parenthesis.
776 (setq filename
(current-word))
777 ;; Locate the erring file and line.
778 (if (and (equal filename last-filename
)
779 (= linenum last-linenum
))
781 (skip-chars-backward "^(")
784 (backward-delete-char 1)
785 (setq error-marker
(point-marker))
786 ;; text-buffer gets the buffer containing this error's file.
787 (if (not (equal filename last-filename
))
789 (and (file-exists-p (setq last-filename filename
))
790 (find-file-noselect filename
))
793 ;; Go to that buffer and find the erring line.
795 (set-buffer text-buffer
)
796 (if (zerop last-linenum
)
799 (setq last-linenum
1)))
800 (forward-line (- linenum last-linenum
))
801 (setq last-linenum linenum
)
802 (setq text-marker
(point-marker))
803 (setq compilation-error-list
804 (cons (list error-marker text-marker
)
805 compilation-error-list
)))))
807 (setq compilation-parsing-end
(point-max)))
808 (message "Parsing error messages...done")
809 (setq compilation-error-list
(nreverse compilation-error-list
)))
811 ;;; Invoking TeX in an inferior shell.
813 ;;; Why use a shell instead of running TeX directly? Because if TeX
814 ;;; gets stuck, the user can switch to the shell window and type at it.
816 ;;; The utility functions:
819 (defun tex-start-shell ()
824 (or tex-shell-file-name
(getenv "ESHELL") (getenv "SHELL") "/bin/sh")
826 (let ((proc (get-process "tex-shell")))
827 (set-process-sentinel proc
'tex-shell-sentinel
)
828 (process-kill-without-query proc
)
829 (setq comint-prompt-regexp shell-prompt-pattern
)
830 (setq tex-shell-map
(nconc (make-sparse-keymap) shell-mode-map
))
831 (tex-define-common-keys tex-shell-map
)
832 (use-local-map tex-shell-map
)
833 (run-hooks 'tex-shell-hook
)
834 (while (zerop (buffer-size))
837 (defun tex-display-shell ()
838 "Make the TeX shell buffer visible in a window."
839 (display-buffer (process-buffer (get-process "tex-shell")))
840 (tex-recenter-output-buffer nil
))
842 (defun tex-shell-sentinel (proc msg
)
843 (cond ((null (buffer-name (process-buffer proc
)))
845 (set-process-buffer proc nil
)
846 (tex-delete-last-temp-files))
847 ((memq (process-status proc
) '(signal exit
))
848 (tex-delete-last-temp-files))))
850 (defun tex-set-buffer-directory (buffer directory
)
851 "Set BUFFER's default directory to be DIRECTORY."
852 (setq directory
(file-name-as-directory (expand-file-name directory
)))
853 (if (not (file-directory-p directory
))
854 (error "%s is not a directory" directory
)
857 (setq default-directory directory
))))
859 (defvar tex-send-command-modified-tick
0)
860 (make-variable-buffer-local 'tex-send-command-modified-tick
)
862 (defun tex-send-command (command &optional file background
)
863 "Send COMMAND to TeX shell process, substituting optional FILE for *.
864 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
865 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
866 substitution will be made in COMMAND. COMMAND can be any expression that
867 evaluates to a command string."
869 (let* ((cmd (eval command
))
870 (proc (get-process "tex-shell"))
871 (buf (process-buffer proc
))
872 (star (string-match "\\*" cmd
))
876 (if star
(concat (substring cmd
0 star
)
877 file
(substring cmd
(1+ star
)))
878 (concat cmd
" " file
))
880 (if background
"&" ""))))
881 ;; Switch to buffer before checking for subproc output in it.
883 ;; If text is unchanged since previous tex-send-command,
884 ;; we haven't got any output. So wait for output now.
885 (if (= (buffer-modified-tick buf
) tex-send-command-modified-tick
)
886 (accept-process-output proc
))
887 (goto-char (process-mark proc
))
890 (setq tex-send-command-modified-tick
(buffer-modified-tick buf
)))))
892 (defun tex-delete-last-temp-files (&optional not-all
)
893 "Delete any junk files from last temp file.
894 If NOT-ALL is non-nil, save the `.dvi' file."
895 (if tex-last-temp-file
896 (let* ((dir (file-name-directory tex-last-temp-file
))
897 (list (and (file-directory-p dir
)
898 (file-name-all-completions
899 (file-name-nondirectory tex-last-temp-file
) dir
))))
903 ;; If arg is non-nil, don't delete the .dvi file.
904 (not (string-match "\\.dvi$" (car list
)))
905 (delete-file (concat dir
(car list
))))
906 (delete-file (concat dir
(car list
))))
907 (setq list
(cdr list
))))))
909 (add-hook 'kill-emacs-hook
'tex-delete-last-temp-files
)
913 (defun tex-region (beg end
)
914 "Run TeX on the current region, via a temporary file.
915 The file's name comes from the variable `tex-zap-file' and the
916 variable `tex-directory' says where to put it.
918 If the buffer has a header, the header is given to TeX before the
919 region itself. The buffer's header is all lines between the strings
920 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
921 The header must start in the first 100 lines of the buffer.
923 The value of `tex-trailer' is given to TeX as input after the region.
925 The value of `tex-command' specifies the command to use to run TeX."
927 (if (tex-shell-running)
931 (setq tex-zap-file
(tex-generate-zap-file-name)))
932 (let* ((temp-buffer (get-buffer-create " TeX-Output-Buffer"))
933 ; Temp file will be written and TeX will be run in zap-directory.
934 ; If the TEXINPUTS file has relative directories or if the region has
935 ; \input of files, this must be the same directory as the file for
936 ; TeX to access the correct inputs. That's why it's safest if
937 ; tex-directory is ".".
939 (file-name-as-directory (expand-file-name tex-directory
)))
940 (tex-out-file (concat zap-directory tex-zap-file
)))
941 ;; Don't delete temp files if we do the same buffer twice in a row.
942 (or (eq (current-buffer) tex-last-buffer-texed
)
943 (tex-delete-last-temp-files t
))
944 ;; Write the new temp file.
948 (goto-char (point-min))
950 (let ((search-end (point))
951 (hbeg (point-min)) (hend (point-min))
952 (default-directory zap-directory
))
953 (goto-char (point-min))
954 ;; Initialize the temp file with either the header or nothing
955 (if (search-forward tex-start-of-header search-end t
)
958 (setq hbeg
(point)) ;mark beginning of header
959 (if (search-forward tex-end-of-header nil t
)
960 (progn (forward-line 1)
961 (setq hend
(point))) ;mark end of header
962 (setq hbeg
(point-min))))) ;no header
963 (write-region (min hbeg beg
) hend
964 (concat tex-out-file
".tex") nil nil
)
965 (write-region (max beg hend
) end
(concat tex-out-file
".tex") t nil
))
966 (let ((local-tex-trailer tex-trailer
))
967 (set-buffer temp-buffer
)
969 ;; make sure trailer isn't hidden by a comment
971 (if local-tex-trailer
(insert-string local-tex-trailer
))
972 (tex-set-buffer-directory temp-buffer zap-directory
)
973 (write-region (point-min) (point-max)
974 (concat tex-out-file
".tex") t nil
))))
975 ;; Record the file name to be deleted afterward.
976 (setq tex-last-temp-file tex-out-file
)
977 (tex-send-command tex-shell-cd-command zap-directory
)
978 (tex-send-command tex-command tex-out-file
)
980 (setq tex-print-file tex-out-file
)
981 (setq tex-last-buffer-texed
(current-buffer))))
984 "Run TeX on current buffer. See \\[tex-region] for more information.
985 Does not save the buffer, so it's useful for trying experimental versions.
986 See \\[tex-file] for an alternative."
988 (tex-region (point-min) (point-max)))
991 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
992 This function is more useful than \\[tex-buffer] when you need the
993 `.aux' file of LaTeX to have the correct name."
996 (if (buffer-file-name)
997 (file-name-nondirectory (buffer-file-name))
998 (error "Buffer does not seem to be associated with any file")))
999 (file-dir (file-name-directory (buffer-file-name))))
1001 (save-some-buffers))
1002 (if (tex-shell-running)
1005 (tex-send-command tex-shell-cd-command file-dir
)
1006 (tex-send-command tex-command tex-out-file
))
1008 (setq tex-last-buffer-texed
(current-buffer))
1009 (setq tex-print-file
(buffer-file-name)))
1011 (defun tex-generate-zap-file-name ()
1012 "Generate a unique name suitable for use as a file name."
1013 ;; Include the shell process number and host name
1014 ;; in case there are multiple shells (for same or different user).
1016 (process-id (get-buffer-process "*tex-shell*"))
1017 (tex-strip-dots (system-name))))
1019 (defun tex-strip-dots (s)
1020 (setq s
(copy-sequence s
))
1021 (while (string-match "\\." s
)
1022 (aset s
(match-beginning 0) ?-
))
1025 ;; This will perhaps be useful for modifying TEXINPUTS.
1026 ;; Expand each file name, separated by colons, in the string S.
1027 (defun tex-expand-files (s)
1028 (let (elts (start 0))
1029 (while (string-match ":" s start
)
1030 (setq elts
(cons (substring s start
(match-beginning 0)) elts
))
1031 (setq start
(match-end 0)))
1033 (setq elts
(cons (substring s start
) elts
)))
1034 (mapconcat 'expand-file-name
(nreverse elts
) ":")))
1036 (defun tex-shell-running ()
1037 (and (get-process "tex-shell")
1038 (eq (process-status (get-process "tex-shell")) 'run
)))
1040 (defun tex-kill-job ()
1041 "Kill the currently running TeX job."
1043 (quit-process (get-process "tex-shell") t
))
1045 (defun tex-recenter-output-buffer (linenum)
1046 "Redisplay buffer of TeX job output so that most recent output can be seen.
1047 The last line of the buffer is displayed on
1048 line LINE of the window, or centered if LINE is nil."
1050 (let ((tex-shell (get-buffer "*tex-shell*"))
1051 (old-buffer (current-buffer)))
1052 (if (null tex-shell
)
1053 (message "No TeX output buffer")
1054 (pop-to-buffer tex-shell
)
1055 (bury-buffer tex-shell
)
1056 (goto-char (point-max))
1057 (recenter (if linenum
1058 (prefix-numeric-value linenum
)
1059 (/ (window-height) 2)))
1060 (pop-to-buffer old-buffer
))))
1062 (defun tex-print (&optional alt
)
1063 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1064 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
1065 is provided, use the alternative command, `tex-alt-dvi-print-command'."
1067 (let ((print-file-name-dvi (tex-append tex-print-file
".dvi"))
1069 (if (and (not (equal (current-buffer) tex-last-buffer-texed
))
1071 ;; Check that this buffer's printed file is up to date.
1072 (file-newer-than-file-p
1073 (setq test-name
(tex-append (buffer-file-name) ".dvi"))
1074 (buffer-file-name)))
1075 (setq print-file-name-dvi test-name
))
1076 (if (not (file-exists-p print-file-name-dvi
))
1077 (error "No appropriate `.dvi' file could be found")
1079 (if alt tex-alt-dvi-print-command tex-dvi-print-command
)
1080 print-file-name-dvi t
))))
1082 (defun tex-alt-print ()
1083 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1084 Runs the shell command defined by `tex-alt-dvi-print-command'."
1089 "Preview the last `.dvi' file made by running TeX under Emacs.
1090 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
1091 The variable `tex-dvi-view-command' specifies the shell command for preview."
1093 (let ((tex-dvi-print-command tex-dvi-view-command
))
1096 (defun tex-append (file-name suffix
)
1097 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
1098 Pascal-based TeX scans for the first period, C TeX uses the last.
1099 No period is retained immediately before SUFFIX,
1100 so normally SUFFIX starts with one."
1101 (if (stringp file-name
)
1102 (let ((file (file-name-nondirectory file-name
))
1104 ;; Try spliting on last period.
1105 ;; The first-period split can get fooled when two files
1106 ;; named a.tex and a.b.tex are both tex'd;
1107 ;; the last-period split must be right if it matches at all.
1109 (concat (file-name-directory file-name
)
1111 (string-match "\\.[^.]*$" file
))
1113 (if (or (file-exists-p trial-name
)
1114 (file-exists-p (concat trial-name
".aux"))) ;for BibTeX files
1116 ;; Not found, so split on first period.
1117 (concat (file-name-directory file-name
)
1119 (string-match "\\." file
))
1123 (defun tex-show-print-queue ()
1124 "Show the print queue that \\[tex-print] put your job on.
1125 Runs the shell command defined by `tex-show-queue-command'."
1127 (if (tex-shell-running)
1130 (tex-send-command tex-show-queue-command
)
1131 (tex-display-shell))
1133 (defun tex-bibtex-file ()
1134 "Run BibTeX on the current buffer's file."
1136 (if (tex-shell-running)
1140 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
1141 (file-dir (file-name-directory (buffer-file-name))))
1142 (tex-send-command tex-shell-cd-command file-dir
)
1143 (tex-send-command tex-bibtex-command tex-out-file
))
1144 (tex-display-shell))
1146 (run-hooks 'tex-mode-load-hook
)
1150 ;;; tex-mode.el ends here