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 "Regular expression used by \\[tex-region] to find start of file's header.")
160 (defvar tex-end-of-header nil
161 "Regular expression used by \\[tex-region] to find end of 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 ;; Written by Wolfgang Bangerth <zcg51122@rpool1.rus.uni-stuttgart.de>
182 (defvar latex-imenu-generic-expression
184 ("Part" "\\\\part{\\([^}]*\\)}" 1)
185 ("Chapter" "\\\\chapter{\\([^}]*\\)}" 1)
186 ("Section" "\\\\[a-zA-Z]*section{\\([^}]*\\)}" 1)
187 ;; i put numbers like 3.15 before my
188 ;; \begin{equation}'s which tell me
189 ;; the number the equation will get when
191 ("Equations" "%[ \t]*\\([0-9]+\\.[0-9]+\\)[,;]?[ \t]?" 1))
193 "Imenu generic expression for LaTex mode. See `imenu-generic-expression'.")
195 (defun tex-define-common-keys (keymap)
196 "Define the keys that we want defined both in TeX mode and in the TeX shell."
197 (define-key keymap "\C-c\C-k" 'tex-kill-job)
198 (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer)
199 (define-key keymap "\C-c\C-q" 'tex-show-print-queue)
200 (define-key keymap "\C-c\C-p" 'tex-print)
201 (define-key keymap "\C-c\C-v" 'tex-view)
203 (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
205 (define-key keymap [menu-bar tex tex-kill-job] '("Tex Kill" . tex-kill-job))
206 (define-key keymap [menu-bar tex tex-recenter-output-buffer]
207 '("Tex Recenter" . tex-recenter-output-buffer))
208 (define-key keymap [menu-bar tex tex-show-print-queue]
209 '("Show Print Queue" . tex-show-print-queue))
210 (define-key keymap [menu-bar tex tex-alt-print]
211 '("Tex Print (alt printer)" . tex-alt-print))
212 (define-key keymap [menu-bar tex tex-print] '("Tex Print" . tex-print))
213 (define-key keymap [menu-bar tex tex-view] '("Tex View" . tex-view))
216 (defvar tex-mode-map nil "Keymap for TeX mode.")
220 (setq tex-mode-map (make-sparse-keymap))
221 (tex-define-common-keys tex-mode-map)
222 (define-key tex-mode-map "\"" 'tex-insert-quote)
223 (define-key tex-mode-map "\n" 'tex-terminate-paragraph)
224 (define-key tex-mode-map "\C-c}" 'up-list)
225 (define-key tex-mode-map "\C-c{" 'tex-insert-braces)
226 (define-key tex-mode-map "\C-c\C-r" 'tex-region)
227 (define-key tex-mode-map "\C-c\C-b" 'tex-buffer)
228 (define-key tex-mode-map "\C-c\C-f" 'tex-file)
229 (define-key tex-mode-map "\C-c\C-i" 'tex-bibtex-file)
230 (define-key tex-mode-map "\C-c\C-o" 'tex-latex-block)
231 (define-key tex-mode-map "\C-c\C-e" 'tex-close-latex-block)
232 (define-key tex-mode-map "\C-c\C-u" 'tex-goto-last-unclosed-latex-block)
233 (define-key tex-mode-map [menu-bar tex tex-bibtex-file]
234 '("BibTeX File" . tex-bibtex-file))
235 (define-key tex-mode-map [menu-bar tex tex-validate-region]
236 '("Validate Region" . tex-validate-region))
237 (define-key tex-mode-map [menu-bar tex validate-tex-buffer]
238 '("Validate Buffer" . validate-tex-buffer))
239 (define-key tex-mode-map [menu-bar tex tex-region]
240 '("TeX Region" . tex-region))
241 (define-key tex-mode-map [menu-bar tex tex-buffer]
242 '("TeX Buffer" . tex-buffer))
243 (define-key tex-mode-map [menu-bar tex tex-file] '("TeX File" . tex-file)))
245 (put 'tex-region 'menu-enable 'mark-active)
246 (put 'tex-validate-region 'menu-enable 'mark-active)
247 (put 'tex-print 'menu-enable '(stringp tex-print-file))
248 (put 'tex-alt-print 'menu-enable '(stringp tex-print-file))
249 (put 'tex-view 'menu-enable '(stringp tex-print-file))
250 (put 'tex-recenter-output-buffer 'menu-enable '(get-buffer "*tex-shell*"))
251 (put 'tex-kill-job 'menu-enable '(tex-shell-running))
254 (defvar tex-shell-map nil
255 "Keymap for the TeX shell.
256 Inherits `shell-mode-map' with a few additions.")
258 (defvar compare-windows-whitespace) ; Pacify the byte-compiler
260 ;;; This would be a lot simpler if we just used a regexp search,
261 ;;; but then it would be too slow.
264 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
265 Tries to determine (by looking at the beginning of the file) whether
266 this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
267 `latex-mode', or `slitex-mode', respectively. If it cannot be determined,
268 such as if there are no commands in the file, the value of `tex-default-mode'
269 says which mode to use."
271 (let (mode slash comment)
273 (goto-char (point-min))
274 (while (and (setq slash (search-forward "\\" nil t))
275 (setq comment (let ((search-end (point)))
278 (search-forward "%" search-end t))))))
279 (if (and slash (not comment))
280 (setq mode (if (looking-at "documentstyle\\|documentclass\\|begin\\b\\|NeedsTeXFormat{LaTeX")
282 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
286 (if mode (funcall mode)
287 (funcall tex-default-mode))))
290 (defalias 'TeX-mode 'tex-mode)
292 (defalias 'LaTeX-mode 'latex-mode)
295 (defun plain-tex-mode ()
296 "Major mode for editing files of input for plain TeX.
297 Makes $ and } display the characters they match.
298 Makes \" insert `` when it seems to be the beginning of a quotation,
299 and '' when it appears to be the end; it inserts \" only after a \\.
301 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
302 copied from the top of the file (containing macro definitions, etc.),
303 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
304 \\[tex-file] saves the buffer and then processes the file.
305 \\[tex-print] prints the .dvi file made by any of these.
306 \\[tex-view] previews the .dvi file made by any of these.
307 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
309 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
310 mismatched $'s or braces.
317 Command string used by \\[tex-region] or \\[tex-buffer].
319 Directory in which to create temporary files for TeX jobs
320 run by \\[tex-region] or \\[tex-buffer].
321 tex-dvi-print-command
322 Command string used by \\[tex-print] to print a .dvi file.
323 tex-alt-dvi-print-command
324 Alternative command string used by \\[tex-print] (when given a prefix
325 argument) to print a .dvi file.
327 Command string used by \\[tex-view] to preview a .dvi file.
328 tex-show-queue-command
329 Command string used by \\[tex-show-print-queue] to show the print
330 queue that \\[tex-print] put your job on.
332 Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
333 `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
334 special subshell is initiated, the hook `tex-shell-hook' is run."
337 (tex-common-initialization)
338 (setq mode-name "TeX")
339 (setq major-mode 'plain-tex-mode)
340 (setq tex-command tex-run-command)
341 (setq tex-start-of-header "%\\*\\*start of header")
342 (setq tex-end-of-header "%\\*\\*end of header")
343 (setq tex-trailer "\\bye\n")
344 (run-hooks 'text-mode-hook 'tex-mode-hook 'plain-tex-mode-hook))
346 (defalias 'plain-TeX-mode 'plain-tex-mode)
350 "Major mode for editing files of input for LaTeX.
351 Makes $ and } display the characters they match.
352 Makes \" insert `` when it seems to be the beginning of a quotation,
353 and '' when it appears to be the end; it inserts \" only after a \\.
355 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
356 copied from the top of the file (containing \\documentstyle, etc.),
357 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
358 \\[tex-file] saves the buffer and then processes the file.
359 \\[tex-print] prints the .dvi file made by any of these.
360 \\[tex-view] previews the .dvi file made by any of these.
361 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
363 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
364 mismatched $'s or braces.
371 Command string used by \\[tex-region] or \\[tex-buffer].
373 Directory in which to create temporary files for LaTeX jobs
374 run by \\[tex-region] or \\[tex-buffer].
375 tex-dvi-print-command
376 Command string used by \\[tex-print] to print a .dvi file.
377 tex-alt-dvi-print-command
378 Alternative command string used by \\[tex-print] (when given a prefix
379 argument) to print a .dvi file.
381 Command string used by \\[tex-view] to preview a .dvi file.
382 tex-show-queue-command
383 Command string used by \\[tex-show-print-queue] to show the print
384 queue that \\[tex-print] put your job on.
386 Entering Latex mode runs the hook `text-mode-hook', then
387 `tex-mode-hook', and finally `latex-mode-hook'. When the special
388 subshell is initiated, `tex-shell-hook' is run."
390 (tex-common-initialization)
391 (setq mode-name "LaTeX")
392 (setq major-mode 'latex-mode)
393 (setq tex-command latex-run-command)
394 (setq tex-start-of-header "\\\\documentstyle\\|\\\\documentclass")
395 (setq tex-end-of-header "\\\\begin{document}")
396 (setq tex-trailer "\\end{document}\n")
397 ;; A line containing just $$ is treated as a paragraph separator.
398 ;; A line starting with $$ starts a paragraph,
399 ;; but does not separate paragraphs if it has more stuff on it.
400 (setq paragraph-start "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\
401 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
402 \\\\chapter\\>\\|\\\\section\\>\\|\
403 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
404 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
405 \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\
406 \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\
407 \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\
408 \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>")
409 (setq paragraph-separate "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\
410 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
411 \\\\chapter\\>\\|\\\\section\\>\\|\
412 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
413 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
414 \\(\\\\item\\|\\\\bibitem\\|\\\\newline\\|\\\\noindent\\|\
415 \\\\[a-z]*space\\|\\\\[a-z]*skip\\|\
416 \\\\newpage\\|\\\\[a-z]*page[a-z]*\\|\\\\footnote\\|\
417 \\\\marginpar\\|\\\\parbox\\|\\\\caption\\)[ \t]*\\($\\|%\\)")
418 (make-local-variable 'imenu-generic-expression)
419 (setq imenu-generic-expression latex-imenu-generic-expression)
420 (run-hooks 'text-mode-hook 'tex-mode-hook 'latex-mode-hook))
423 (defun slitex-mode ()
424 "Major mode for editing files of input for SliTeX.
425 Makes $ and } display the characters they match.
426 Makes \" insert `` when it seems to be the beginning of a quotation,
427 and '' when it appears to be the end; it inserts \" only after a \\.
429 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
430 copied from the top of the file (containing \\documentstyle, etc.),
431 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
432 \\[tex-file] saves the buffer and then processes the file.
433 \\[tex-print] prints the .dvi file made by any of these.
434 \\[tex-view] previews the .dvi file made by any of these.
435 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
437 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
438 mismatched $'s or braces.
445 Command string used by \\[tex-region] or \\[tex-buffer].
447 Directory in which to create temporary files for SliTeX jobs
448 run by \\[tex-region] or \\[tex-buffer].
449 tex-dvi-print-command
450 Command string used by \\[tex-print] to print a .dvi file.
451 tex-alt-dvi-print-command
452 Alternative command string used by \\[tex-print] (when given a prefix
453 argument) to print a .dvi file.
455 Command string used by \\[tex-view] to preview a .dvi file.
456 tex-show-queue-command
457 Command string used by \\[tex-show-print-queue] to show the print
458 queue that \\[tex-print] put your job on.
460 Entering SliTeX mode runs the hook `text-mode-hook', then the hook
461 `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
462 `slitex-mode-hook'. When the special subshell is initiated, the hook
463 `tex-shell-hook' is run."
465 (tex-common-initialization)
466 (setq mode-name "SliTeX")
467 (setq major-mode 'slitex-mode)
468 (setq tex-command slitex-run-command)
469 (setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\docuentclass{slides}")
470 (setq tex-end-of-header "\\\\begin{document}")
471 (setq tex-trailer "\\end{document}\n")
472 ;; A line containing just $$ is treated as a paragraph separator.
473 ;; A line starting with $$ starts a paragraph,
474 ;; but does not separate paragraphs if it has more stuff on it.
475 (setq paragraph-start "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|\
476 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
477 \\\\chapter\\>\\|\\\\section\\>\\|\
478 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
479 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
480 \\\\item\\>\\|\\\\bibitem\\>\\|\\\\newline\\>\\|\\\\noindent\\>\\|\
481 \\\\[a-z]*space\\>\\|\\\\[a-z]*skip\\>\\|\
482 \\\\newpage\\>\\|\\\\[a-z]*page\\|\\\\footnote\\>\\|\
483 \\\\marginpar\\>\\|\\\\parbox\\>\\|\\\\caption\\>")
484 (setq paragraph-separate "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|\
485 \\\\begin\\>\\|\\\\label\\>\\|\\\\end\\>\\|\\\\\\[\\|\\\\\\]\\|\
486 \\\\chapter\\>\\|\\\\section\\>\\|\
487 \\\\subsection\\>\\|\\\\subsubsection\\>\\|\
488 \\\\paragraph\\>\\|\\\\subparagraph\\>\\|\
489 \\\\item[ \t]*$\\|\\\\bibitem[ \t]*$\\|\\\\newline[ \t]*$\\|\\\\noindent[ \t]*$\\|\
490 \\\\[a-z]*space[ \t]*$\\|\\\\[a-z]*skip[ \t]*$\\|\
491 \\\\newpage[ \t]*$\\|\\\\[a-z]*page[a-z]*[ \t]*$\\|\\\\footnote[ \t]*$\\|\
492 \\\\marginpar[ \t]*$\\|\\\\parbox[ \t]*$\\|\\\\caption[ \t]*$")
494 'text-mode-hook 'tex-mode-hook 'latex-mode-hook 'slitex-mode-hook))
496 (defun tex-common-initialization ()
497 (kill-all-local-variables)
498 (use-local-map tex-mode-map)
499 (setq local-abbrev-table text-mode-abbrev-table)
500 (if (null tex-mode-syntax-table)
502 (setq tex-mode-syntax-table (make-syntax-table))
503 (set-syntax-table tex-mode-syntax-table)
505 (modify-syntax-entry char ".")
506 (setq char (1+ char)))
507 (modify-syntax-entry ?\C-@ "w")
508 (modify-syntax-entry ?\t " ")
509 (modify-syntax-entry ?\n ">")
510 (modify-syntax-entry ?\f ">")
511 (modify-syntax-entry ?$ "$$")
512 (modify-syntax-entry ?% "<")
513 (modify-syntax-entry ?\\ "/")
514 (modify-syntax-entry ?\" ".")
515 (modify-syntax-entry ?& ".")
516 (modify-syntax-entry ?_ ".")
517 (modify-syntax-entry ?@ "_")
518 (modify-syntax-entry ?~ " ")
519 (modify-syntax-entry ?' "w"))
520 (set-syntax-table tex-mode-syntax-table))
521 (make-local-variable 'paragraph-start)
522 ;; A line containing just $$ is treated as a paragraph separator.
523 (setq paragraph-start "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
524 (make-local-variable 'paragraph-separate)
525 ;; A line starting with $$ starts a paragraph,
526 ;; but does not separate paragraphs if it has more stuff on it.
527 (setq paragraph-separate "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
528 (make-local-variable 'comment-start)
529 (setq comment-start "%")
530 (make-local-variable 'comment-start-skip)
531 (setq comment-start-skip "\\(\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
532 (make-local-variable 'comment-indent-function)
533 (setq comment-indent-function 'tex-comment-indent)
534 (make-local-variable 'parse-sexp-ignore-comments)
535 (setq parse-sexp-ignore-comments t)
536 (make-local-variable 'compare-windows-whitespace)
537 (setq compare-windows-whitespace 'tex-categorize-whitespace)
538 (make-local-variable 'tex-command)
539 (make-local-variable 'tex-start-of-header)
540 (make-local-variable 'tex-end-of-header)
541 (make-local-variable 'tex-trailer))
543 (defun tex-comment-indent ()
544 (if (looking-at "%%%")
546 (skip-chars-backward " \t")
547 (max (if (bolp) 0 (1+ (current-column)))
550 (defun tex-categorize-whitespace (backward-limit)
551 ;; compare-windows-whitespace is set to this.
552 ;; This is basically a finite-state machine.
553 ;; Returns a symbol telling how TeX would treat
554 ;; the whitespace we are looking at: null, space, or par.
555 (let ((category 'null)
557 (skip-chars-backward " \t\n\f" backward-limit)
559 (cond ((looking-at "[ \t]+")
560 (goto-char (match-end 0))
561 (if (eql category 'null)
562 (setq category 'space)))
564 (cond ((eql category 'newline)
566 (setq not-finished nil))
568 (setq category 'newline) ;a strictly internal state
569 (goto-char (match-end 0)))))
572 (setq not-finished nil))
574 (setq not-finished nil))))
575 (skip-chars-forward " \t\n\f")
576 (if (eql category 'newline)
577 'space ;TeX doesn't distinguish
580 (defun tex-insert-quote (arg)
581 "Insert the appropriate quote marks for TeX.
582 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
583 \(normally '') depending on the context. With prefix argument, always
584 inserts \" characters."
587 (self-insert-command (prefix-numeric-value arg))
592 (looking-at "\\s(\\|\\s \\|\\s>")))
594 ((= (preceding-char) ?\\)
599 (defun validate-tex-buffer ()
600 "Check current buffer for paragraphs containing mismatched $s.
601 Their positions are recorded in the buffer `*Occur*'.
602 To find a particular invalidity from `*Occur*',
603 switch to to that buffer and type C-c C-c on the line
604 for the invalidity you want to see."
606 (let ((buffer (current-buffer))
607 (prevpos (point-min))
609 (with-output-to-temp-buffer "*Occur*"
610 (princ "Mismatches:\n")
612 (set-buffer standard-output)
614 (setq occur-buffer buffer)
615 (setq occur-nlines 0)
616 (setq occur-pos-list nil))
618 (goto-char (point-max))
619 (while (and (not (input-pending-p)) (not (bobp)))
621 ;; Scan the previous paragraph for invalidities.
622 (search-backward "\n\n" nil 'move)
623 (or (tex-validate-region (point) end)
624 (let* ((end (save-excursion (forward-line 1) (point)))
628 ;; Keep track of line number as we scan,
629 ;; in a cumulative fashion.
631 (setq linenum (- linenum (count-lines prevpos (point))))
632 (setq linenum (1+ (count-lines 1 start))))
633 (setq prevpos (point))
634 ;; Mention this mismatch in *Occur*.
635 ;; Since we scan from end of buffer to beginning,
636 ;; add each mismatch at the beginning of *Occur*
637 ;; and at the beginning of occur-pos-list.
639 (setq tem (point-marker))
640 (set-buffer standard-output)
641 (goto-char (point-min))
642 ;; Skip "Mismatches:" header line.
644 (setq occur-pos-list (cons tem occur-pos-list))
645 (insert-buffer-substring buffer start end)
646 (forward-char (- start end))
647 (insert (format "%3d: " linenum))))))))
649 (set-buffer standard-output)
650 (if (null occur-pos-list)
653 (message "%d mismatches found" (length occur-pos-list)))))))
655 (defun tex-validate-region (start end)
656 "Check for mismatched braces or $'s in region.
657 Returns t if no mismatches. Returns nil and moves point to suspect
658 area if a mismatch is found."
660 (let ((failure-point nil) (max-possible-sexps (- end start)))
664 (narrow-to-region start end)
666 (while (< 0 (setq max-possible-sexps (1- max-possible-sexps)))
669 (setq failure-point (point)))))
672 (goto-char failure-point)
676 (defun tex-terminate-paragraph (inhibit-validation)
677 "Insert two newlines, breaking a paragraph for TeX.
678 Check for mismatched braces or $s in paragraph being terminated.
679 A prefix arg inhibits the checking."
681 (or inhibit-validation
685 (search-backward "\n\n" nil 'move)
688 (message "Paragraph being closed appears to contain a mismatch"))
691 (defun tex-insert-braces ()
692 "Make a pair of braces and be poised to type inside of them."
698 ;;; Like tex-insert-braces, but for LaTeX.
699 (defun tex-latex-block (name)
700 "Creates a matching pair of lines `\\begin{NAME}' and `\\end{NAME}' at point.
701 Puts point on a blank line between them."
704 (barf-if-buffer-read-only)
706 (completing-read "LaTeX block name: "
708 (append standard-latex-block-names
709 latex-block-names))))))
710 (let ((col (current-column)))
711 (insert (format "\\begin{%s}\n" name))
716 (insert-string (format "\\end{%s}" name))
717 (if (eobp) (insert ?\n)))))
719 (defun tex-last-unended-begin ()
720 "Leave point at the beginning of the last `\\begin{...}' that is unended."
721 (while (and (re-search-backward "\\(\\\\begin\\s *{\\)\\|\\(\\\\end\\s *{\\)")
722 (looking-at "\\\\end{"))
723 (tex-last-unended-begin)))
725 (defun tex-goto-last-unclosed-latex-block ()
726 "Move point to the last unclosed \\begin{...}.
727 Mark is left at original location."
732 (tex-last-unended-begin)
733 (error (error "Couldn't find unended \\begin")))
738 (defun tex-close-latex-block ()
739 "Creates an \\end{...} to match the last unclosed \\begin{...}."
741 (let ((new-line-needed (bolp))
745 (tex-last-unended-begin)
746 (error (error "Couldn't find unended \\begin")))
747 (setq indentation (current-column))
748 (re-search-forward "\\\\begin\\(\\s *{[^}\n]*}\\)")
749 (setq text (buffer-substring (match-beginning 1) (match-end 1))))
750 (indent-to indentation)
751 (insert "\\end" text)
752 (if new-line-needed (insert ?\n))))
754 (defun tex-compilation-parse-errors ()
755 "Parse the current buffer as error messages.
756 This makes a list of error descriptors, compilation-error-list.
757 For each source-file, line-number pair in the buffer,
758 the source file is read in, and the text location is saved in
759 compilation-error-list. The function `next-error', assigned to
760 \\[next-error], takes the next error off the list and visits its location.
762 This function works on TeX compilations only. It is necessary for
763 that purpose, since TeX does not put file names on the same line as
764 line numbers for the errors."
765 (setq compilation-error-list nil)
766 (message "Parsing error messages...")
767 (modify-syntax-entry ?\{ "_")
768 (modify-syntax-entry ?\} "_")
769 (modify-syntax-entry ?\[ "_")
770 (modify-syntax-entry ?\] "_")
772 last-filename last-linenum)
773 ;; Don't reparse messages already seen at last parse.
774 (goto-char compilation-parsing-end)
775 ;; Don't parse the first two lines as error messages.
776 ;; This matters for grep.
779 (while (re-search-forward "^l\.[0-9]+ " nil t)
780 (let (linenum filename
781 error-marker text-marker)
782 ;; Extract file name and line number from error message.
783 ;; Line number is 2 away from beginning of line: "l.23"
785 (goto-char (+ (point) 2))
786 (setq linenum (read (current-buffer)))
787 ;; The file is the one that was opened last and is still open.
788 ;; We need to find the last open parenthesis.
792 (setq filename (current-word))
793 ;; Locate the erring file and line.
794 (if (and (equal filename last-filename)
795 (= linenum last-linenum))
797 (skip-chars-backward "^(")
800 (backward-delete-char 1)
801 (setq error-marker (point-marker))
802 ;; text-buffer gets the buffer containing this error's file.
803 (if (not (equal filename last-filename))
805 (and (file-exists-p (setq last-filename filename))
806 (find-file-noselect filename))
809 ;; Go to that buffer and find the erring line.
811 (set-buffer text-buffer)
812 (if (zerop last-linenum)
815 (setq last-linenum 1)))
816 (forward-line (- linenum last-linenum))
817 (setq last-linenum linenum)
818 (setq text-marker (point-marker))
819 (setq compilation-error-list
820 (cons (list error-marker text-marker)
821 compilation-error-list)))))
823 (setq compilation-parsing-end (point-max)))
824 (message "Parsing error messages...done")
825 (setq compilation-error-list (nreverse compilation-error-list)))
827 ;;; Invoking TeX in an inferior shell.
829 ;;; Why use a shell instead of running TeX directly? Because if TeX
830 ;;; gets stuck, the user can switch to the shell window and type at it.
832 ;;; The utility functions:
835 (defun tex-start-shell ()
840 (or tex-shell-file-name (getenv "ESHELL") (getenv "SHELL") "/bin/sh")
842 (let ((proc (get-process "tex-shell")))
843 (set-process-sentinel proc 'tex-shell-sentinel)
844 (process-kill-without-query proc)
845 (setq comint-prompt-regexp shell-prompt-pattern)
846 (setq tex-shell-map (nconc (make-sparse-keymap) shell-mode-map))
847 (tex-define-common-keys tex-shell-map)
848 (use-local-map tex-shell-map)
849 (run-hooks 'tex-shell-hook)
850 (while (zerop (buffer-size))
853 (defun tex-display-shell ()
854 "Make the TeX shell buffer visible in a window."
855 (display-buffer (process-buffer (get-process "tex-shell")))
856 (tex-recenter-output-buffer nil))
858 (defun tex-shell-sentinel (proc msg)
859 (cond ((null (buffer-name (process-buffer proc)))
861 (set-process-buffer proc nil)
862 (tex-delete-last-temp-files))
863 ((memq (process-status proc) '(signal exit))
864 (tex-delete-last-temp-files))))
866 (defun tex-set-buffer-directory (buffer directory)
867 "Set BUFFER's default directory to be DIRECTORY."
868 (setq directory (file-name-as-directory (expand-file-name directory)))
869 (if (not (file-directory-p directory))
870 (error "%s is not a directory" directory)
873 (setq default-directory directory))))
875 (defvar tex-send-command-modified-tick 0)
876 (make-variable-buffer-local 'tex-send-command-modified-tick)
878 (defun tex-send-command (command &optional file background)
879 "Send COMMAND to TeX shell process, substituting optional FILE for *.
880 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
881 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
882 substitution will be made in COMMAND. COMMAND can be any expression that
883 evaluates to a command string."
885 (let* ((cmd (eval command))
886 (proc (or (get-process "tex-shell") (error "No TeX subprocess")))
887 (buf (process-buffer proc))
888 (star (string-match "\\*" cmd))
892 (if star (concat (substring cmd 0 star)
893 file (substring cmd (1+ star)))
894 (concat cmd " " file))
896 (if background "&" ""))))
897 ;; Switch to buffer before checking for subproc output in it.
899 ;; If text is unchanged since previous tex-send-command,
900 ;; we haven't got any output. So wait for output now.
901 (if (= (buffer-modified-tick buf) tex-send-command-modified-tick)
902 (accept-process-output proc))
903 (goto-char (process-mark proc))
906 (setq tex-send-command-modified-tick (buffer-modified-tick buf)))))
908 (defun tex-delete-last-temp-files (&optional not-all)
909 "Delete any junk files from last temp file.
910 If NOT-ALL is non-nil, save the `.dvi' file."
911 (if tex-last-temp-file
912 (let* ((dir (file-name-directory tex-last-temp-file))
913 (list (and (file-directory-p dir)
914 (file-name-all-completions
915 (file-name-nondirectory tex-last-temp-file) dir))))
919 ;; If arg is non-nil, don't delete the .dvi file.
920 (not (string-match "\\.dvi$" (car list)))
921 (delete-file (concat dir (car list))))
922 (delete-file (concat dir (car list))))
923 (setq list (cdr list))))))
925 (add-hook 'kill-emacs-hook 'tex-delete-last-temp-files)
929 (defun tex-region (beg end)
930 "Run TeX on the current region, via a temporary file.
931 The file's name comes from the variable `tex-zap-file' and the
932 variable `tex-directory' says where to put it.
934 If the buffer has a header, the header is given to TeX before the
935 region itself. The buffer's header is all lines between the strings
936 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
937 The header must start in the first 100 lines of the buffer.
939 The value of `tex-trailer' is given to TeX as input after the region.
941 The value of `tex-command' specifies the command to use to run TeX."
943 (if (tex-shell-running)
947 (setq tex-zap-file (tex-generate-zap-file-name)))
948 (let* ((temp-buffer (get-buffer-create " TeX-Output-Buffer"))
949 ; Temp file will be written and TeX will be run in zap-directory.
950 ; If the TEXINPUTS file has relative directories or if the region has
951 ; \input of files, this must be the same directory as the file for
952 ; TeX to access the correct inputs. That's why it's safest if
953 ; tex-directory is ".".
955 (file-name-as-directory (expand-file-name tex-directory)))
956 (tex-out-file (concat zap-directory tex-zap-file)))
957 ;; Don't delete temp files if we do the same buffer twice in a row.
958 (or (eq (current-buffer) tex-last-buffer-texed)
959 (tex-delete-last-temp-files t))
960 ;; Write the new temp file.
964 (goto-char (point-min))
966 (let ((search-end (point))
967 (hbeg (point-min)) (hend (point-min))
968 (default-directory zap-directory))
969 (goto-char (point-min))
970 ;; Initialize the temp file with either the header or nothing
971 (if (re-search-forward tex-start-of-header search-end t)
974 (setq hbeg (point)) ;mark beginning of header
975 (if (re-search-forward tex-end-of-header nil t)
976 (progn (forward-line 1)
977 (setq hend (point))) ;mark end of header
978 (setq hbeg (point-min))))) ;no header
979 (write-region (min hbeg beg) hend
980 (concat tex-out-file ".tex") nil nil)
981 (write-region (max beg hend) end (concat tex-out-file ".tex") t nil))
982 (let ((local-tex-trailer tex-trailer))
983 (set-buffer temp-buffer)
985 ;; make sure trailer isn't hidden by a comment
987 (if local-tex-trailer (insert-string local-tex-trailer))
988 (tex-set-buffer-directory temp-buffer zap-directory)
989 (write-region (point-min) (point-max)
990 (concat tex-out-file ".tex") t nil))))
991 ;; Record the file name to be deleted afterward.
992 (setq tex-last-temp-file tex-out-file)
993 (tex-send-command tex-shell-cd-command zap-directory)
994 (tex-send-command tex-command tex-out-file)
996 (setq tex-print-file tex-out-file)
997 (setq tex-last-buffer-texed (current-buffer))))
1000 "Run TeX on current buffer. See \\[tex-region] for more information.
1001 Does not save the buffer, so it's useful for trying experimental versions.
1002 See \\[tex-file] for an alternative."
1004 (tex-region (point-min) (point-max)))
1007 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
1008 This function is more useful than \\[tex-buffer] when you need the
1009 `.aux' file of LaTeX to have the correct name."
1012 (if (buffer-file-name)
1013 (file-name-nondirectory (buffer-file-name))
1014 (error "Buffer does not seem to be associated with any file")))
1015 (file-dir (file-name-directory (buffer-file-name))))
1017 (save-some-buffers))
1018 (if (tex-shell-running)
1021 (tex-send-command tex-shell-cd-command file-dir)
1022 (tex-send-command tex-command tex-out-file))
1024 (setq tex-last-buffer-texed (current-buffer))
1025 (setq tex-print-file (buffer-file-name)))
1027 (defun tex-generate-zap-file-name ()
1028 "Generate a unique name suitable for use as a file name."
1029 ;; Include the shell process number and host name
1030 ;; in case there are multiple shells (for same or different user).
1032 (process-id (get-buffer-process "*tex-shell*"))
1033 (tex-strip-dots (system-name))))
1035 (defun tex-strip-dots (s)
1036 (setq s (copy-sequence s))
1037 (while (string-match "\\." s)
1038 (aset s (match-beginning 0) ?-))
1041 ;; This will perhaps be useful for modifying TEXINPUTS.
1042 ;; Expand each file name, separated by colons, in the string S.
1043 (defun tex-expand-files (s)
1044 (let (elts (start 0))
1045 (while (string-match ":" s start)
1046 (setq elts (cons (substring s start (match-beginning 0)) elts))
1047 (setq start (match-end 0)))
1049 (setq elts (cons (substring s start) elts)))
1050 (mapconcat 'expand-file-name (nreverse elts) ":")))
1052 (defun tex-shell-running ()
1053 (and (get-process "tex-shell")
1054 (eq (process-status (get-process "tex-shell")) 'run)))
1056 (defun tex-kill-job ()
1057 "Kill the currently running TeX job."
1059 (quit-process (get-process "tex-shell") t))
1061 (defun tex-recenter-output-buffer (linenum)
1062 "Redisplay buffer of TeX job output so that most recent output can be seen.
1063 The last line of the buffer is displayed on
1064 line LINE of the window, or centered if LINE is nil."
1066 (let ((tex-shell (get-buffer "*tex-shell*"))
1067 (old-buffer (current-buffer)))
1068 (if (null tex-shell)
1069 (message "No TeX output buffer")
1070 (pop-to-buffer tex-shell)
1071 (bury-buffer tex-shell)
1072 (goto-char (point-max))
1073 (recenter (if linenum
1074 (prefix-numeric-value linenum)
1075 (/ (window-height) 2)))
1076 (pop-to-buffer old-buffer))))
1078 (defun tex-print (&optional alt)
1079 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1080 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
1081 is provided, use the alternative command, `tex-alt-dvi-print-command'."
1083 (let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
1085 (if (and (not (equal (current-buffer) tex-last-buffer-texed))
1087 ;; Check that this buffer's printed file is up to date.
1088 (file-newer-than-file-p
1089 (setq test-name (tex-append (buffer-file-name) ".dvi"))
1090 (buffer-file-name)))
1091 (setq print-file-name-dvi test-name))
1092 (if (not (file-exists-p print-file-name-dvi))
1093 (error "No appropriate `.dvi' file could be found")
1095 (if alt tex-alt-dvi-print-command tex-dvi-print-command)
1096 print-file-name-dvi t))))
1098 (defun tex-alt-print ()
1099 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1100 Runs the shell command defined by `tex-alt-dvi-print-command'."
1105 "Preview the last `.dvi' file made by running TeX under Emacs.
1106 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
1107 The variable `tex-dvi-view-command' specifies the shell command for preview.
1108 You must set that variable yourself before using this command,
1109 because there is no standard value that would generally work."
1111 (or tex-dvi-view-command
1112 (error "You must set `tex-dvi-view-command'"))
1113 (let ((tex-dvi-print-command tex-dvi-view-command))
1116 (defun tex-append (file-name suffix)
1117 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
1118 Pascal-based TeX scans for the first period, C TeX uses the last.
1119 No period is retained immediately before SUFFIX,
1120 so normally SUFFIX starts with one."
1121 (if (stringp file-name)
1122 (let ((file (file-name-nondirectory file-name))
1124 ;; Try spliting on last period.
1125 ;; The first-period split can get fooled when two files
1126 ;; named a.tex and a.b.tex are both tex'd;
1127 ;; the last-period split must be right if it matches at all.
1129 (concat (file-name-directory file-name)
1131 (string-match "\\.[^.]*$" file))
1133 (if (or (file-exists-p trial-name)
1134 (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
1136 ;; Not found, so split on first period.
1137 (concat (file-name-directory file-name)
1139 (string-match "\\." file))
1143 (defun tex-show-print-queue ()
1144 "Show the print queue that \\[tex-print] put your job on.
1145 Runs the shell command defined by `tex-show-queue-command'."
1147 (if (tex-shell-running)
1150 (tex-send-command tex-show-queue-command)
1151 (tex-display-shell))
1153 (defun tex-bibtex-file ()
1154 "Run BibTeX on the current buffer's file."
1156 (if (tex-shell-running)
1160 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
1161 (file-dir (file-name-directory (buffer-file-name))))
1162 (tex-send-command tex-shell-cd-command file-dir)
1163 (tex-send-command tex-bibtex-command tex-out-file))
1164 (tex-display-shell))
1166 (run-hooks 'tex-mode-load-hook)
1170 ;;; tex-mode.el ends here