1 ;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands.
3 ;; Copyright (C) 1985, 1986, 1989, 1992 Free Software Foundation, Inc.
5 ;; Maintainer: Edward M. Reingold <reingold@cs.uiuc.edu>
8 ;; Contributions over the years by William F. Schelter, Dick King,
9 ;; Stephen Gildea, Michael Prange, and Jacob Gore.
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, is file name to use for the subshell in which TeX is run.")
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 (*), it will be replaced by the
51 filename; if not, the name of the file, preceded by blank, will be added to
55 (defvar latex-run-command "latex"
56 "*Command used to run LaTeX subjob.
57 If this string contains an asterisk (*), it will be replaced by the
58 filename; if not, the name of the file, preceded by blank, will be added to
61 (defvar standard-latex-block-names
62 '("abstract" "array" "center" "description"
63 "displaymath" "document" "enumerate" "eqnarray"
64 "eqnarray*" "equation" "figure" "figure*"
65 "flushleft" "flushright" "itemize" "letter"
66 "list" "minipage" "picture" "quotation"
67 "quote" "slide" "sloppypar" "tabbing"
68 "table" "table*" "tabular" "tabular*"
69 "thebibliography" "theindex*" "titlepage" "trivlist"
70 "verbatim" "verbatim*" "verse")
71 "Standard LaTeX block names.")
74 (defvar latex-block-names nil
75 "*User defined LaTeX block names.
76 Combined with `standard-latex-block-names' for minibuffer completion.")
79 (defvar slitex-run-command "slitex"
80 "*Command used to run SliTeX subjob.
81 If this string contains an asterisk (*), it will be replaced by the
82 filename; if not, the name of the file, preceded by blank, will be added to
86 (defvar tex-bibtex-command "bibtex"
87 "*Command used by `tex-bibtex-file' to gather bibliographic data.
88 If this string contains an asterisk (*), it will be replaced by the
89 filename; if not, the name of the file, preceded by blank, will be added to
93 (defvar tex-dvi-print-command "lpr -d"
94 "*Command used by \\[tex-print] to print a .dvi file.
95 If this string contains an asterisk (*), it will be replaced by the
96 filename; if not, the name of the file, preceded by blank, will be added to
100 (defvar tex-alt-dvi-print-command "lpr -d"
101 "*Command used by \\[tex-print] with a prefix arg to print a .dvi file.
102 If this string contains an asterisk (*), it will be replaced by the
103 filename; if not, the name of the file, preceded by blank, will be added to
106 If two printers are not enough of a choice, you can define the value
107 of tex-alt-dvi-print-command to be an expression that asks what you want;
110 (setq tex-alt-dvi-print-command
111 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
113 would tell \\[tex-print] with a prefix argument to ask you which printer to
117 (defvar tex-dvi-view-command nil
118 "*Command used by \\[tex-view] to display a .dvi file.
119 If this string contains an asterisk (*), it will be replaced by the
120 filename; if not, the name of the file, preceded by blank, will be added to
123 This can be set conditionally so that the previewer used is suitable for the
124 window system being used. For example,
126 (setq tex-dvi-view-command
127 (if (eq window-system 'x) \"xdvi\" \"dvi2tty * | cat -s\"))
129 would tell \\[tex-view] use xdvi under X windows and to use dvi2tty
133 (defvar tex-show-queue-command "lpq"
134 "*Command used by \\[tex-show-print-queue] to show the print queue.
135 Should show the queue(s) that \\[tex-print] puts jobs on.")
138 (defvar tex-default-mode 'plain-tex-mode
139 "*Mode to enter for a new file that might be either TeX or LaTeX.
140 This variable is used when it can't be determined whether the file
141 is plain TeX or LaTeX or what because the file contains no commands.
142 Normally set to either 'plain-tex-mode or 'latex-mode.")
145 (defvar tex-open-quote "``"
146 "*String inserted by typing \\[tex-insert-quote] to open a quotation.")
149 (defvar tex-close-quote "''"
150 "*String inserted by typing \\[tex-insert-quote] to close a quotation.")
152 (defvar tex-last-temp-file nil
153 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
154 Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
155 tex-shell goes away.")
157 (defvar tex-command nil
159 The name of the file, preceded by a blank, will be added to this string.")
161 (defvar tex-trailer nil
162 "String appended after the end of a region sent to TeX by \\[tex-region].")
164 (defvar tex-start-of-header nil
165 "String used by \\[tex-region] to delimit the start of the file's header.")
167 (defvar tex-end-of-header nil
168 "String used by \\[tex-region] to delimit the end of the file's header.")
170 (defvar tex-shell-cd-command "cd"
171 "Command to give to shell running TeX to change directory.
172 The value of tex-directory will be appended to this, separated by a space.")
174 (defvar tex-zap-file nil
175 "Temporary file name used for text being sent as input to TeX.
176 Should be a simple file name with no extension or directory specification.")
178 (defvar tex-last-buffer-texed nil
179 "Buffer which was last TeXed.")
181 (defvar tex-print-file nil
182 "File name that \\[tex-print] prints.
183 Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
185 (defvar tex-mode-syntax-table nil
186 "Syntax table used while in TeX mode.")
188 (defun tex-define-common-keys (keymap)
189 "Define the keys that we want defined both in TeX mode and in the tex-shell."
190 (define-key keymap "\C-c\C-k" 'tex-kill-job)
191 (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer)
192 (define-key keymap "\C-c\C-q" 'tex-show-print-queue)
193 (define-key keymap "\C-c\C-p" 'tex-print)
194 (define-key keymap "\C-c\C-v" 'tex-view)
196 (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
198 (define-key keymap [menu-bar tex tex-kill-job] '("Tex Kill" . tex-kill-job))
199 (define-key keymap [menu-bar tex tex-recenter-output-buffer]
200 '("Tex Recenter" . tex-recenter-output-buffer))
201 (define-key keymap [menu-bar tex tex-show-print-queue]
202 '("Show Print Queue" . tex-show-print-queue))
203 (define-key keymap [menu-bar tex tex-alt-print]
204 '("Tex Print (alt printer)" . tex-alt-print))
205 (define-key keymap [menu-bar tex tex-print] '("Tex Print" . tex-print))
206 (define-key keymap [menu-bar tex tex-view] '("Tex View" . tex-view))
209 (defvar tex-mode-map nil "Keymap for TeX mode.")
213 (setq tex-mode-map (make-sparse-keymap))
214 (tex-define-common-keys tex-mode-map)
215 (define-key tex-mode-map "\"" 'tex-insert-quote)
216 (define-key tex-mode-map "\n" 'tex-terminate-paragraph)
217 (define-key tex-mode-map "\C-c}" 'up-list)
218 (define-key tex-mode-map "\C-c{" 'tex-insert-braces)
219 (define-key tex-mode-map "\C-c\C-r" 'tex-region)
220 (define-key tex-mode-map "\C-c\C-b" 'tex-buffer)
221 (define-key tex-mode-map "\C-c\C-f" 'tex-file)
222 (define-key tex-mode-map "\C-c\C-i" 'tex-bibtex-file)
223 (define-key tex-mode-map "\C-c\C-o" 'tex-latex-block)
224 (define-key tex-mode-map "\C-c\C-e" 'tex-close-latex-block)
225 (define-key tex-mode-map [menu-bar tex tex-validate-region]
226 '("Validate Region" . tex-validate-region))
227 (define-key tex-mode-map [menu-bar tex validate-tex-buffer]
228 '("Validate Buffer" . validate-tex-buffer))
229 (define-key tex-mode-map [menu-bar tex tex-region]
230 '("Tex Region" . tex-region))
231 (define-key tex-mode-map [menu-bar tex tex-buffer]
232 '("Tex Buffer" . tex-buffer))
233 (define-key tex-mode-map [menu-bar tex tex-file] '("Tex File" . tex-file)))
235 (put 'tex-region 'menu-enable 'mark-active)
236 (put 'tex-validate-region 'menu-enable 'mark-active)
237 (put 'tex-print 'menu-enable '(stringp tex-print-file))
238 (put 'tex-alt-print 'menu-enable '(stringp tex-print-file))
239 (put 'tex-view 'menu-enable '(stringp tex-print-file))
240 (put 'tex-recenter-output-buffer 'menu-enable '(get-buffer "*tex-shell*"))
241 (put 'tex-kill-job 'menu-enable '(tex-shell-running))
244 (defvar tex-shell-map nil
245 "Keymap for the tex-shell. A comint-mode-map with a few additions.")
247 (defvar compare-windows-whitespace nil) ; Pacify the byte-compiler
249 ;;; This would be a lot simpler if we just used a regexp search,
250 ;;; but then it would be too slow.
253 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
254 Tries to determine (by looking at the beginning of the file) whether
255 this file is for plain TeX, LaTeX, or SliTeX and calls plain-tex-mode,
256 latex-mode, or slitex-mode, respectively. If it cannot be determined,
257 such as if there are no commands in the file, the value of tex-default-mode
260 (let (mode slash comment)
262 (goto-char (point-min))
263 (while (and (setq slash (search-forward "\\" nil t))
264 (setq comment (let ((search-end (point)))
267 (search-forward "%" search-end t))))))
268 (if (and slash (not comment))
269 (setq mode (if (looking-at "documentstyle")
270 (if (looking-at "documentstyle{slides}")
274 (if mode (funcall mode)
275 (funcall tex-default-mode))))
278 (defalias 'TeX-mode 'tex-mode)
280 (defalias 'LaTeX-mode 'latex-mode)
283 (defun plain-tex-mode ()
284 "Major mode for editing files of input for plain TeX.
285 Makes $ and } display the characters they match.
286 Makes \" insert `` when it seems to be the beginning of a quotation,
287 and '' when it appears to be the end; it inserts \" only after a \\.
289 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
290 copied from the top of the file (containing macro definitions, etc.),
291 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
292 \\[tex-file] saves the buffer and then processes the file.
293 \\[tex-print] prints the .dvi file made by any of these.
294 \\[tex-view] previews the .dvi file made by any of these.
295 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
297 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
298 mismatched $'s or braces.
305 Command string used by \\[tex-region] or \\[tex-buffer].
307 Directory in which to create temporary files for TeX jobs
308 run by \\[tex-region] or \\[tex-buffer].
309 tex-dvi-print-command
310 Command string used by \\[tex-print] to print a .dvi file.
311 tex-alt-dvi-print-command
312 Alternative command string used by \\[tex-print] (when given a prefix
313 argument) to print a .dvi file.
315 Command string used by \\[tex-view] to preview a .dvi file.
316 tex-show-queue-command
317 Command string used by \\[tex-show-print-queue] to show the print
318 queue that \\[tex-print] put your job on.
320 Entering Plain-tex mode calls the value of `text-mode-hook', then the value
321 of `tex-mode-hook', and then the value of `plain-tex-mode-hook'. When the
322 special subshell is initiated, the value of `tex-shell-hook' is called."
325 (tex-common-initialization)
326 (setq mode-name "TeX")
327 (setq major-mode 'plain-tex-mode)
328 (setq tex-command tex-run-command)
329 (setq tex-start-of-header "%**start of header")
330 (setq tex-end-of-header "%**end of header")
331 (setq tex-trailer "\\bye\n")
332 (run-hooks 'text-mode-hook 'tex-mode-hook 'plain-tex-mode-hook))
334 (defalias 'plain-TeX-mode 'plain-tex-mode)
338 "Major mode for editing files of input for LaTeX.
339 Makes $ and } display the characters they match.
340 Makes \" insert `` when it seems to be the beginning of a quotation,
341 and '' when it appears to be the end; it inserts \" only after a \\.
343 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
344 copied from the top of the file (containing \\documentstyle, etc.),
345 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
346 \\[tex-file] saves the buffer and then processes the file.
347 \\[tex-print] prints the .dvi file made by any of these.
348 \\[tex-view] previews the .dvi file made by any of these.
349 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
351 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
352 mismatched $'s or braces.
359 Command string used by \\[tex-region] or \\[tex-buffer].
361 Directory in which to create temporary files for LaTeX jobs
362 run by \\[tex-region] or \\[tex-buffer].
363 tex-dvi-print-command
364 Command string used by \\[tex-print] to print a .dvi file.
365 tex-alt-dvi-print-command
366 Alternative command string used by \\[tex-print] (when given a prefix
367 argument) to print a .dvi file.
369 Command string used by \\[tex-view] to preview a .dvi file.
370 tex-show-queue-command
371 Command string used by \\[tex-show-print-queue] to show the print
372 queue that \\[tex-print] put your job on.
374 Entering Latex mode calls the value of text-mode-hook, then the value of
375 tex-mode-hook, and then the value of latex-mode-hook. When the special
376 subshell is initiated, the value of tex-shell-hook is called."
378 (tex-common-initialization)
379 (setq mode-name "LaTeX")
380 (setq major-mode 'latex-mode)
381 (setq tex-command latex-run-command)
382 (setq tex-start-of-header "\\documentstyle")
383 (setq tex-end-of-header "\\begin{document}")
384 (setq tex-trailer "\\end{document}\n")
385 (run-hooks 'text-mode-hook 'tex-mode-hook 'latex-mode-hook))
388 (defun slitex-mode ()
389 "Major mode for editing files of input for SliTeX.
390 Makes $ and } display the characters they match.
391 Makes \" insert `` when it seems to be the beginning of a quotation,
392 and '' when it appears to be the end; it inserts \" only after a \\.
394 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
395 copied from the top of the file (containing \\documentstyle, etc.),
396 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
397 \\[tex-file] saves the buffer and then processes the file.
398 \\[tex-print] prints the .dvi file made by any of these.
399 \\[tex-view] previews the .dvi file made by any of these.
400 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
402 Use \\[validate-tex-buffer] to check buffer for paragraphs containing
403 mismatched $'s or braces.
410 Command string used by \\[tex-region] or \\[tex-buffer].
412 Directory in which to create temporary files for SliTeX jobs
413 run by \\[tex-region] or \\[tex-buffer].
414 tex-dvi-print-command
415 Command string used by \\[tex-print] to print a .dvi file.
416 tex-alt-dvi-print-command
417 Alternative command string used by \\[tex-print] (when given a prefix
418 argument) to print a .dvi file.
420 Command string used by \\[tex-view] to preview a .dvi file.
421 tex-show-queue-command
422 Command string used by \\[tex-show-print-queue] to show the print
423 queue that \\[tex-print] put your job on.
425 Entering SliTeX mode calls the value of `text-mode-hook', then the value of
426 `tex-mode-hook', then the value of `latex-mode-hook', and then the value of
427 `slitex-mode-hook'. When the special subshell is initiated, the value of
428 `tex-shell-hook' is called."
430 (tex-common-initialization)
431 (setq mode-name "SliTeX")
432 (setq major-mode 'slitex-mode)
433 (setq tex-command slitex-run-command)
434 (setq tex-start-of-header "\\documentstyle{slides}")
435 (setq tex-end-of-header "\\begin{document}")
436 (setq tex-trailer "\\end{document}\n")
438 'text-mode-hook 'tex-mode-hook 'latex-mode-hook 'slitex-mode-hook))
440 (defun tex-common-initialization ()
441 (kill-all-local-variables)
442 (use-local-map tex-mode-map)
443 (setq local-abbrev-table text-mode-abbrev-table)
444 (if (null tex-mode-syntax-table)
446 (setq tex-mode-syntax-table (make-syntax-table))
447 (set-syntax-table tex-mode-syntax-table)
449 (modify-syntax-entry char ".")
450 (setq char (1+ char)))
451 (modify-syntax-entry ?\C-@ "w")
452 (modify-syntax-entry ?\t " ")
453 (modify-syntax-entry ?\n ">")
454 (modify-syntax-entry ?\f ">")
455 (modify-syntax-entry ?$ "$$")
456 (modify-syntax-entry ?% "<")
457 (modify-syntax-entry ?\\ "/")
458 (modify-syntax-entry ?\" ".")
459 (modify-syntax-entry ?& ".")
460 (modify-syntax-entry ?_ ".")
461 (modify-syntax-entry ?@ "_")
462 (modify-syntax-entry ?~ " ")
463 (modify-syntax-entry ?' "w"))
464 (set-syntax-table tex-mode-syntax-table))
465 (make-local-variable 'paragraph-start)
466 (setq paragraph-start "^[ \t]*$\\|^[\f\\\\%]")
467 (make-local-variable 'paragraph-separate)
468 (setq paragraph-separate paragraph-start)
469 (make-local-variable 'comment-start)
470 (setq comment-start "%")
471 (make-local-variable 'comment-start-skip)
472 (setq comment-start-skip "\\(\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
473 (make-local-variable 'comment-indent-function)
474 (setq comment-indent-function 'tex-comment-indent)
475 (make-local-variable 'compare-windows-whitespace)
476 (setq compare-windows-whitespace 'tex-categorize-whitespace)
477 (make-local-variable 'tex-command)
478 (make-local-variable 'tex-start-of-header)
479 (make-local-variable 'tex-end-of-header)
480 (make-local-variable 'tex-trailer))
482 (defun tex-comment-indent ()
483 (if (looking-at "%%%")
485 (skip-chars-backward " \t")
486 (max (if (bolp) 0 (1+ (current-column)))
489 (defun tex-categorize-whitespace (backward-limit)
490 ;; compare-windows-whitespace is set to this.
491 ;; This is basically a finite-state machine.
492 ;; Returns a symbol telling how TeX would treat
493 ;; the whitespace we are looking at: null, space, or par.
494 (let ((category 'null)
496 (skip-chars-backward " \t\n\f" backward-limit)
498 (cond ((looking-at "[ \t]+")
499 (goto-char (match-end 0))
500 (if (eql category 'null)
501 (setq category 'space)))
503 (cond ((eql category 'newline)
505 (setq not-finished nil))
507 (setq category 'newline) ;a strictly internal state
508 (goto-char (match-end 0)))))
511 (setq not-finished nil))
513 (setq not-finished nil))))
514 (skip-chars-forward " \t\n\f")
515 (if (eql category 'newline)
516 'space ;TeX doesn't distinguish
519 (defun tex-insert-quote (arg)
520 "Insert the appropriate quote marks for TeX.
521 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
522 \(normally '') depending on the context. With prefix argument, always
523 inserts \" characters."
526 (self-insert-command (prefix-numeric-value arg))
531 (looking-at "\\s(\\|\\s \\|\\s>")))
533 ((= (preceding-char) ?\\)
538 (defun validate-tex-buffer ()
539 "Check current buffer for paragraphs containing mismatched $s.
540 Their positions are recorded in the buffer `*Occur*'.
541 To find a particular invalidity from `*Occur*',
542 switch to to that buffer and type C-c C-c on the line
543 for the invalidity you want to see."
545 (let ((buffer (current-buffer))
546 (prevpos (point-min))
548 (with-output-to-temp-buffer "*Occur*"
549 (princ "Mismatches:\n")
551 (set-buffer standard-output)
553 (setq occur-buffer buffer)
554 (setq occur-nlines 0)
555 (setq occur-pos-list nil))
557 (goto-char (point-max))
558 (while (and (not (input-pending-p)) (not (bobp)))
560 ;; Scan the previous paragraph for invalidities.
561 (search-backward "\n\n" nil 'move)
562 (or (tex-validate-region (point) end)
563 (let* ((end (save-excursion (forward-line 1) (point)))
567 ;; Keep track of line number as we scan,
568 ;; in a cumulative fashion.
570 (setq linenum (- linenum (count-lines prevpos (point))))
571 (setq linenum (1+ (count-lines 1 start))))
572 (setq prevpos (point))
573 ;; Mention this mismatch in *Occur*.
574 ;; Since we scan from end of buffer to beginning,
575 ;; add each mismatch at the beginning of *Occur*
576 ;; and at the beginning of occur-pos-list.
578 (setq tem (point-marker))
579 (set-buffer standard-output)
580 (goto-char (point-min))
581 ;; Skip "Mismatches:" header line.
583 (setq occur-pos-list (cons tem occur-pos-list))
584 (insert-buffer-substring buffer start end)
585 (forward-char (- start end))
586 (insert (format "%3d: " linenum))))))))
588 (set-buffer standard-output)
589 (if (null occur-pos-list)
592 (message "%d mismatches found" (length occur-pos-list)))))))
594 (defun tex-validate-region (start end)
595 "Check for mismatched braces or $'s in region.
596 Returns t if no mismatches. Returns nil and moves point to suspect
597 area if a mismatch is found."
599 (let ((failure-point nil) (max-possible-sexps (- end start)))
603 (narrow-to-region start end)
605 (while (< 0 (setq max-possible-sexps (1- max-possible-sexps)))
608 (setq failure-point (point)))))
611 (goto-char failure-point)
615 (defun tex-terminate-paragraph (inhibit-validation)
616 "Insert two newlines, breaking a paragraph for TeX.
617 Check for mismatched braces/$'s in paragraph being terminated.
618 A prefix arg inhibits the checking."
620 (or inhibit-validation
624 (search-backward "\n\n" nil 'move)
627 (message "Paragraph being closed appears to contain a mismatch"))
630 (defun tex-insert-braces ()
631 "Make a pair of braces and be poised to type inside of them."
637 ;;; Like tex-insert-braces, but for LaTeX.
638 (defun tex-latex-block (name)
639 "Creates a matching pair of lines \\begin{NAME} and \\end{NAME} at point.
640 Puts point on a blank line between them."
643 (barf-if-buffer-read-only)
645 (completing-read "LaTeX block name: "
647 (append standard-latex-block-names
648 latex-block-names))))))
649 (let ((col (current-column)))
650 (insert (format "\\begin{%s}\n" name))
655 (insert-string (format "\\end{%s}" name))
656 (if (eobp) (insert ?\n)))))
658 (defun tex-last-unended-begin ()
659 "Leave point at the beginning of the last \\begin{...} that is unended."
660 (while (and (re-search-backward "\\(\\\\begin\\s *{\\)\\|\\(\\\\end\\s *{\\)")
661 (looking-at "\\\\end{"))
662 (tex-last-unended-begin)))
664 (defun tex-close-latex-block ()
665 "Creates an \\end{...} to match the last unclosed \\begin{...}."
667 (let ((new-line-needed (bolp))
671 (tex-last-unended-begin)
672 (error (error "Couldn't find unended \\begin")))
673 (setq indentation (current-column))
674 (re-search-forward "\\\\begin\\(\\s *{[^}\n]*}\\)")
675 (setq text (buffer-substring (match-beginning 1) (match-end 1))))
676 (indent-to indentation)
677 (insert "\\end" text)
678 (if new-line-needed (insert ?\n))))
680 (defun tex-compilation-parse-errors ()
681 "Parse the current buffer as error messages.
682 This makes a list of error descriptors, compilation-error-list.
683 For each source-file, line-number pair in the buffer,
684 the source file is read in, and the text location is saved in
685 compilation-error-list. The function `next-error', assigned to
686 \\[next-error], takes the next error off the list and visits its location.
688 This function works on TeX compilations only. It is necessary for
689 that purpose, since TeX does not put file names on the same line as
690 line numbers for the errors."
691 (setq compilation-error-list nil)
692 (message "Parsing error messages...")
693 (modify-syntax-entry ?\{ "_")
694 (modify-syntax-entry ?\} "_")
695 (modify-syntax-entry ?\[ "_")
696 (modify-syntax-entry ?\] "_")
698 last-filename last-linenum)
699 ;; Don't reparse messages already seen at last parse.
700 (goto-char compilation-parsing-end)
701 ;; Don't parse the first two lines as error messages.
702 ;; This matters for grep.
705 (while (re-search-forward "^l\.[0-9]+ " nil t)
706 (let (linenum filename
707 error-marker text-marker)
708 ;; Extract file name and line number from error message.
709 ;; Line number is 2 away from beginning of line: "l.23"
711 (goto-char (+ (point) 2))
712 (setq linenum (read (current-buffer)))
713 ;; The file is the one that was opened last and is still open.
714 ;; We need to find the last open parenthesis.
718 (setq filename (current-word))
719 ;; Locate the erring file and line.
720 (if (and (equal filename last-filename)
721 (= linenum last-linenum))
723 (skip-chars-backward "^(")
726 (backward-delete-char 1)
727 (setq error-marker (point-marker))
728 ;; text-buffer gets the buffer containing this error's file.
729 (if (not (equal filename last-filename))
731 (and (file-exists-p (setq last-filename filename))
732 (find-file-noselect filename))
735 ;; Go to that buffer and find the erring line.
737 (set-buffer text-buffer)
738 (if (zerop last-linenum)
741 (setq last-linenum 1)))
742 (forward-line (- linenum last-linenum))
743 (setq last-linenum linenum)
744 (setq text-marker (point-marker))
745 (setq compilation-error-list
746 (cons (list error-marker text-marker)
747 compilation-error-list)))))
749 (setq compilation-parsing-end (point-max)))
750 (message "Parsing error messages...done")
751 (setq compilation-error-list (nreverse compilation-error-list)))
753 ;;; Invoking TeX in an inferior shell.
755 ;;; Why use a shell instead of running TeX directly? Because if TeX
756 ;;; gets stuck, the user can switch to the shell window and type at it.
758 ;;; The utility functions:
760 (defun tex-start-shell ()
765 (or tex-shell-file-name (getenv "ESHELL") (getenv "SHELL") "/bin/sh")
767 (let ((proc (get-process "tex-shell")))
768 (set-process-sentinel proc 'tex-shell-sentinel)
769 (process-kill-without-query proc)
770 (setq tex-shell-map (copy-keymap comint-mode-map))
771 (tex-define-common-keys tex-shell-map)
772 (use-local-map tex-shell-map)
773 (run-hooks 'tex-shell-hook)
774 (while (zerop (buffer-size))
777 (defun tex-shell-sentinel (proc msg)
778 (cond ((null (buffer-name (process-buffer proc)))
780 (set-process-buffer proc nil)
781 (tex-delete-last-temp-files))
782 ((memq (process-status proc) '(signal exit))
783 (tex-delete-last-temp-files))))
785 (defun tex-set-buffer-directory (buffer directory)
786 "Set BUFFER's default directory to be DIRECTORY."
787 (setq directory (file-name-as-directory (expand-file-name directory)))
788 (if (not (file-directory-p directory))
789 (error "%s is not a directory" directory)
792 (setq default-directory directory))))
794 (defun tex-send-command (command &optional file background)
795 "Send COMMAND to TeX shell process, substituting optional FILE for *.
796 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
797 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
798 substitution will be made in COMMAND. COMMAND can be any expression that
799 evaluates to a command string."
801 (let* ((cmd (eval command))
802 (proc (get-process "tex-shell"))
803 (star (string-match "\\*" cmd))
807 (if star (concat (substring cmd 0 star)
808 file (substring cmd (1+ star)))
809 (concat cmd " " file))
811 (if background "&" ""))))
812 (set-buffer (process-buffer proc))
813 (goto-char (process-mark proc))
815 (comint-send-input))))
817 (defun tex-delete-last-temp-files ()
818 "Delete any junk files from last temp file."
819 (if tex-last-temp-file
820 (let* ((dir (file-name-directory tex-last-temp-file))
821 (list (file-name-all-completions
822 (file-name-nondirectory tex-last-temp-file) dir)))
824 (delete-file (concat dir (car list)))
825 (setq list (cdr list))))))
827 (add-hook 'kill-emacs-hook 'tex-delete-last-temp-files)
831 (defun tex-region (beg end)
832 "Run TeX on the current region, via a temporary file.
833 The file's name comes from the variable `tex-zap-file' and the
834 variable `tex-directory' says where to put it.
836 If the buffer has a header, the header is given to TeX before the
837 region itself. The buffer's header is all lines between the strings
838 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
839 The header must start in the first 100 lines of the buffer.
841 The value of `tex-trailer' is given to TeX as input after the region.
843 The value of `tex-command' specifies the command to use to run TeX."
845 (if (tex-shell-running)
849 (setq tex-zap-file (tex-generate-zap-file-name)))
850 (let* ((temp-buffer (get-buffer-create " TeX-Output-Buffer"))
851 ; Temp file will be written and TeX will be run in zap-directory.
852 ; If the TEXINPUTS file has relative directories or if the region has
853 ; \input of files, this must be the same directory as the file for
854 ; TeX to access the correct inputs. That's why it's safest if
855 ; tex-directory is ".".
857 (file-name-as-directory (expand-file-name tex-directory)))
858 (tex-out-file (concat zap-directory tex-zap-file)))
859 (tex-delete-last-temp-files)
860 ;; Write the new temp file.
864 (goto-char (point-min))
866 (let ((search-end (point))
867 (hbeg (point-min)) (hend (point-min))
868 (default-directory zap-directory))
869 (goto-char (point-min))
870 ;; Initialize the temp file with either the header or nothing
871 (if (search-forward tex-start-of-header search-end t)
874 (setq hbeg (point)) ;mark beginning of header
875 (if (search-forward tex-end-of-header nil t)
876 (progn (forward-line 1)
877 (setq hend (point))) ;mark end of header
878 (setq hbeg (point-min))))) ;no header
879 (write-region (min hbeg beg) hend
880 (concat tex-out-file ".tex") nil nil)
881 (write-region (max beg hend) end (concat tex-out-file ".tex") t nil))
882 (let ((local-tex-trailer tex-trailer))
883 (set-buffer temp-buffer)
885 ;; make sure trailer isn't hidden by a comment
887 (if local-tex-trailer (insert-string local-tex-trailer))
888 (tex-set-buffer-directory temp-buffer zap-directory)
889 (write-region (point-min) (point-max)
890 (concat tex-out-file ".tex") t nil))))
891 ;; Record the file name to be deleted afterward.
892 (setq tex-last-temp-file tex-out-file)
893 (tex-send-command tex-shell-cd-command zap-directory)
894 (tex-send-command tex-command tex-out-file)
895 (setq tex-print-file tex-out-file)
896 (setq tex-last-buffer-texed (current-buffer))))
899 "Run TeX on current buffer. See \\[tex-region] for more information.
900 Does not save the buffer, so it's useful for trying experimental versions.
901 See \\[tex-file] for an alternative."
903 (tex-region (point-min) (point-max)))
906 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
907 This function is more useful than \\[tex-buffer] when you need the
908 `.aux' file of LaTeX to have the correct name."
911 (if (buffer-file-name)
912 (file-name-nondirectory (buffer-file-name))
913 (error "Buffer does not seem to be associated with any file")))
914 (file-dir (file-name-directory (buffer-file-name))))
917 (if (tex-shell-running)
920 (tex-send-command tex-shell-cd-command file-dir)
921 (tex-send-command tex-command tex-out-file))
922 (setq tex-last-buffer-texed (current-buffer))
923 (setq tex-print-file (buffer-file-name)))
925 (defun tex-generate-zap-file-name ()
926 "Generate a unique name suitable for use as a file name."
927 ;; Include the shell process number and host name
928 ;; in case there are multiple shells (for same or different user).
930 (process-id (get-buffer-process "*tex-shell*"))
931 (tex-strip-dots (system-name))))
933 (defun tex-strip-dots (s)
934 (setq s (copy-sequence s))
935 (while (string-match "\\." s)
936 (aset s (match-beginning 0) ?-))
939 ;; This will perhaps be useful for modifying TEXINPUTS.
940 ;; Expand each file name, separated by colons, in the string S.
941 (defun tex-expand-files (s)
942 (let (elts (start 0))
943 (while (string-match ":" s start)
944 (setq elts (cons (substring s start (match-beginning 0)) elts))
945 (setq start (match-end 0)))
947 (setq elts (cons (substring s start) elts)))
948 (mapconcat 'expand-file-name (nreverse elts) ":")))
950 (defun tex-shell-running ()
951 (and (get-process "tex-shell")
952 (eq (process-status (get-process "tex-shell")) 'run)))
954 (defun tex-kill-job ()
955 "Kill the currently running TeX job."
957 (quit-process (get-process "tex-shell") t))
959 (defun tex-recenter-output-buffer (linenum)
960 "Redisplay buffer of TeX job output so that most recent output can be seen.
961 The last line of the buffer is displayed on
962 line LINE of the window, or centered if LINE is nil."
964 (let ((tex-shell (get-buffer "*tex-shell*"))
965 (old-buffer (current-buffer)))
967 (message "No TeX output buffer")
968 (pop-to-buffer tex-shell)
969 (bury-buffer tex-shell)
970 (goto-char (point-max))
971 (recenter (if linenum
972 (prefix-numeric-value linenum)
973 (/ (window-height) 2)))
974 (pop-to-buffer old-buffer))))
976 (defun tex-print (&optional alt)
977 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
978 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
979 is provided, use the alternative command, `tex-alt-dvi-print-command'."
981 (let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
983 (if (and (not (equal (current-buffer) tex-last-buffer-texed))
984 (file-newer-than-file-p
985 (setq test-name (tex-append (buffer-file-name) ".dvi"))
986 print-file-name-dvi))
987 (setq print-file-name-dvi test-name))
988 (if (not (file-exists-p print-file-name-dvi))
989 (error "No appropriate `.dvi' file could be found")
991 (if alt tex-alt-dvi-print-command tex-dvi-print-command)
992 print-file-name-dvi t))))
994 (defun tex-alt-print ()
995 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
996 Runs the shell command defined by tex-alt-dvi-print-command."
1001 "Preview the last `.dvi' file made by running TeX under Emacs.
1002 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
1003 The variable `tex-dvi-view-command' specifies the shell command for preview."
1005 (let ((tex-dvi-print-command tex-dvi-view-command))
1008 (defun tex-append (file-name suffix)
1009 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
1010 Pascal-based TeX scans for the first period, C TeX uses the last.
1011 No period is retained immediately before SUFFIX,
1012 so normally SUFFIX starts with one."
1013 (if (stringp file-name)
1014 (let ((file (file-name-nondirectory file-name))
1016 ;; try spliting on first period
1018 (concat (file-name-directory file-name)
1020 (string-match "\\." file))
1022 (if (or (file-exists-p trial-name)
1023 (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
1025 ;; not found, so split on last period
1026 (concat (file-name-directory file-name)
1028 (string-match "\\.[^.]*$" file))
1032 (defun tex-show-print-queue ()
1033 "Show the print queue that \\[tex-print] put your job on.
1034 Runs the shell command defined by `tex-show-queue-command'."
1036 (if (tex-shell-running)
1039 (tex-send-command tex-show-queue-command))
1041 (defun tex-bibtex-file ()
1042 "Run BibTeX on the current buffer's file."
1044 (if (tex-shell-running)
1048 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
1049 (file-dir (file-name-directory (buffer-file-name))))
1050 (tex-send-command tex-shell-cd-command file-dir)
1051 (tex-send-command tex-bibtex-command tex-out-file)))
1053 (run-hooks 'tex-mode-load-hook)
1057 ;;; tex-mode.el ends here