(texinfo-font-lock-syntactic-keywords):
[bpt/emacs.git] / lisp / textmodes / tex-mode.el
CommitLineData
d501f516
ER
1;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands.
2
c3ce7bf4 3;; Copyright (C) 1985, 86, 89, 92, 94, 95, 96, 97, 98, 1999
d61140e8 4;; Free Software Foundation, Inc.
eea8d4ef 5
70f20973 6;; Maintainer: FSF
d7b4d18f 7;; Keywords: tex
e5167999 8
528415e7 9;; Contributions over the years by William F. Schelter, Dick King,
70f20973 10;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold.
528415e7 11
869bff31 12;; This file is part of GNU Emacs.
13
14;; GNU Emacs is free software; you can redistribute it and/or modify
15;; it under the terms of the GNU General Public License as published by
e5167999 16;; the Free Software Foundation; either version 2, or (at your option)
869bff31 17;; any later version.
18
19;; GNU Emacs is distributed in the hope that it will be useful,
20;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22;; GNU General Public License for more details.
23
24;; You should have received a copy of the GNU General Public License
6da9bbd6
RS
25;; along with GNU Emacs; see the file COPYING. If not, write to the
26;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27;; Boston, MA 02111-1307, USA.
869bff31 28
e5167999
ER
29;;; Code:
30
bed1b0c8
RS
31;; Pacify the byte-compiler
32(eval-when-compile
33 (require 'compare-w)
34 (require 'skeleton))
35
a0e9c22a 36(require 'shell)
2f3067de 37(require 'compile)
528415e7 38
d61140e8
RS
39(defgroup tex-file nil
40 "TeX files and directories"
41 :prefix "tex-"
42 :group 'tex)
43
44(defgroup tex-run nil
45 "Running external commands from TeX mode"
46 :prefix "tex-"
47 :group 'tex)
48
49(defgroup tex-view nil
50 "Viewing and printing TeX files"
51 :prefix "tex-"
52 :group 'tex)
53
7e1dae73 54;;;###autoload
d61140e8
RS
55(defcustom tex-shell-file-name nil
56 "*If non-nil, the shell file name to run in the subshell used to run TeX."
57 :type '(choice (const :tag "None" nil)
58 string)
59 :group 'tex-run)
528415e7 60
7e1dae73 61;;;###autoload
d61140e8 62(defcustom tex-directory "."
f73741fc 63 "*Directory in which temporary files are written.
81c735c0 64You can make this `/tmp' if your TEXINPUTS has no relative directories in it
528415e7 65and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
d61140e8
RS
66`\\input' commands with relative directories."
67 :type 'directory
68 :group 'tex-file)
869bff31 69
725b7428 70;;;###autoload
d61140e8 71(defcustom tex-first-line-header-regexp nil
725b7428
RS
72 "Regexp for matching a first line which `tex-region' should include.
73If this is non-nil, it should be a regular expression string;
74if it matches the first line of the file,
d61140e8
RS
75`tex-region' always includes the first line in the TeX run."
76 :type '(choice (const :tag "None" nil)
77 regexp)
78 :group 'tex-file)
725b7428 79
f73741fc 80;;;###autoload
d61140e8 81(defcustom tex-main-file nil
f73741fc 82 "*The main TeX source file which includes this buffer's file.
be4a962d
RS
83The command `tex-file' runs TeX on the file specified by `tex-main-file'
84if the variable is non-nil."
d61140e8
RS
85 :type '(choice (const :tag "None" nil)
86 file)
87 :group 'tex-file)
f73741fc 88
7e1dae73 89;;;###autoload
d61140e8
RS
90(defcustom tex-offer-save t
91 "*If non-nil, ask about saving modified buffers before \\[tex-file] is run."
92 :type 'boolean
93 :group 'tex-file)
869bff31 94
7e1dae73 95;;;###autoload
d61140e8 96(defcustom tex-run-command "tex"
869bff31 97 "*Command used to run TeX subjob.
c3ce7bf4
RS
98TeX Mode sets `tex-command' to this string.
99See the documentation of that variable."
d61140e8
RS
100 :type 'string
101 :group 'tex-run)
869bff31 102
7e1dae73 103;;;###autoload
d61140e8 104(defcustom latex-run-command "latex"
869bff31 105 "*Command used to run LaTeX subjob.
c3ce7bf4
RS
106LaTeX Mode sets `tex-command' to this string.
107See the documentation of that variable."
d61140e8
RS
108 :type 'string
109 :group 'tex-run)
528415e7 110
bed1b0c8
RS
111;;;###autoload
112(defcustom slitex-run-command "slitex"
113 "*Command used to run SliTeX subjob.
c3ce7bf4
RS
114SliTeX Mode sets `tex-command' to this string.
115See the documentation of that variable."
bed1b0c8
RS
116 :type 'string
117 :group 'tex-run)
118
c3ce7bf4
RS
119;;;###autoload
120(defcustom tex-start-options-string "\\nonstopmode\\input"
bed1b0c8 121 "*TeX options to use when running TeX.
c3ce7bf4
RS
122These precede the input file name. If nil, TeX runs without option.
123See the documentation of `tex-command'."
124 :type '(radio (const :tag "Interactive \(nil\)" nil)
125 (const :tag "Nonstop \(\"\\nonstopmode\\input\"\)"
126 "\\nonstopmode\\input")
127 (string :tag "String at your choice"))
bed1b0c8
RS
128 :group 'tex-run
129 :version "20.4")
130
528415e7 131(defvar standard-latex-block-names
bed1b0c8
RS
132 '("abstract" "array" "center" "description"
133 "displaymath" "document" "enumerate" "eqnarray"
134 "eqnarray*" "equation" "figure" "figure*"
135 "flushleft" "flushright" "itemize" "letter"
136 "list" "minipage" "picture" "quotation"
137 "quote" "slide" "sloppypar" "tabbing"
138 "table" "table*" "tabular" "tabular*"
139 "thebibliography" "theindex*" "titlepage" "trivlist"
140 "verbatim" "verbatim*" "verse")
528415e7
RS
141 "Standard LaTeX block names.")
142
7e1dae73 143;;;###autoload
d61140e8 144(defcustom latex-block-names nil
528415e7 145 "*User defined LaTeX block names.
d61140e8
RS
146Combined with `standard-latex-block-names' for minibuffer completion."
147 :type '(repeat string)
148 :group 'tex-run)
869bff31 149
7e1dae73 150;;;###autoload
d61140e8 151(defcustom tex-bibtex-command "bibtex"
528415e7 152 "*Command used by `tex-bibtex-file' to gather bibliographic data.
81c735c0 153If this string contains an asterisk (`*'), that is replaced by the file name;
d61140e8
RS
154otherwise, the file name, preceded by blank, is added at the end."
155 :type 'string
156 :group 'tex-run)
869bff31 157
7e1dae73 158;;;###autoload
d61140e8 159(defcustom tex-dvi-print-command "lpr -d"
528415e7 160 "*Command used by \\[tex-print] to print a .dvi file.
81c735c0 161If this string contains an asterisk (`*'), that is replaced by the file name;
d61140e8
RS
162otherwise, the file name, preceded by blank, is added at the end."
163 :type 'string
164 :group 'tex-view)
528415e7 165
7e1dae73 166;;;###autoload
d61140e8 167(defcustom tex-alt-dvi-print-command "lpr -d"
528415e7 168 "*Command used by \\[tex-print] with a prefix arg to print a .dvi file.
81c735c0
RS
169If this string contains an asterisk (`*'), that is replaced by the file name;
170otherwise, the file name, preceded by blank, is added at the end.
528415e7 171
81c735c0
RS
172If two printers are not enough of a choice, you can set the variable
173`tex-alt-dvi-print-command' to an expression that asks what you want;
528415e7
RS
174for example,
175
176 (setq tex-alt-dvi-print-command
177 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
178
179would tell \\[tex-print] with a prefix argument to ask you which printer to
d61140e8
RS
180use."
181 :type '(choice (string :tag "Command")
182 (sexp :tag "Expression"))
183 :group 'tex-view)
869bff31 184
7e1dae73 185;;;###autoload
d61140e8 186(defcustom tex-dvi-view-command nil
81c735c0
RS
187 "*Command used by \\[tex-view] to display a `.dvi' file.
188If this string contains an asterisk (`*'), that is replaced by the file name;
189otherwise, the file name, preceded by blank, is added at the end.
528415e7
RS
190
191This can be set conditionally so that the previewer used is suitable for the
192window system being used. For example,
193
194 (setq tex-dvi-view-command
195 (if (eq window-system 'x) \"xdvi\" \"dvi2tty * | cat -s\"))
196
81c735c0 197would tell \\[tex-view] to use xdvi under X windows and to use dvi2tty
d61140e8
RS
198otherwise."
199 :type '(choice (const nil) string)
200 :group 'tex-view)
869bff31 201
7e1dae73 202;;;###autoload
d61140e8 203(defcustom tex-show-queue-command "lpq"
528415e7 204 "*Command used by \\[tex-show-print-queue] to show the print queue.
d61140e8
RS
205Should show the queue(s) that \\[tex-print] puts jobs on."
206 :type 'string
207 :group 'tex-view)
869bff31 208
7e1dae73 209;;;###autoload
9920303f 210(defcustom tex-default-mode 'latex-mode
869bff31 211 "*Mode to enter for a new file that might be either TeX or LaTeX.
212This variable is used when it can't be determined whether the file
213is plain TeX or LaTeX or what because the file contains no commands.
d61140e8
RS
214Normally set to either `plain-tex-mode' or `latex-mode'."
215 :type 'function
216 :group 'tex)
869bff31 217
7e1dae73 218;;;###autoload
d61140e8
RS
219(defcustom tex-open-quote "``"
220 "*String inserted by typing \\[tex-insert-quote] to open a quotation."
221 :type 'string
222 :group 'tex)
869bff31 223
7e1dae73 224;;;###autoload
d61140e8
RS
225(defcustom tex-close-quote "''"
226 "*String inserted by typing \\[tex-insert-quote] to close a quotation."
227 :type 'string
228 :group 'tex)
869bff31 229
528415e7
RS
230(defvar tex-last-temp-file nil
231 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
232Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
81c735c0 233tex shell terminates.")
528415e7 234
869bff31 235(defvar tex-command nil
c3ce7bf4
RS
236 "*Command to run TeX.
237If this string contains an asterisk \(`*'\), that is replaced by the file name\;
238otherwise the \(shell-quoted\) value of `tex-start-options-string' and
239the file name are added at the end, with blanks as separators.
240
241In TeX, LaTeX, and SliTeX Mode this variable becomes buffer local.
242In these modes, use \\[set-variable] if you want to change it for the
243current buffer.")
869bff31 244
245(defvar tex-trailer nil
246 "String appended after the end of a region sent to TeX by \\[tex-region].")
247
248(defvar tex-start-of-header nil
898b9ac1 249 "Regular expression used by \\[tex-region] to find start of file's header.")
869bff31 250
251(defvar tex-end-of-header nil
898b9ac1 252 "Regular expression used by \\[tex-region] to find end of file's header.")
869bff31 253
254(defvar tex-shell-cd-command "cd"
255 "Command to give to shell running TeX to change directory.
81c735c0 256The value of `tex-directory' is appended to this, separated by a space.")
869bff31 257
258(defvar tex-zap-file nil
259 "Temporary file name used for text being sent as input to TeX.
260Should be a simple file name with no extension or directory specification.")
261
262(defvar tex-last-buffer-texed nil
263 "Buffer which was last TeXed.")
264
265(defvar tex-print-file nil
266 "File name that \\[tex-print] prints.
267Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
268
269(defvar tex-mode-syntax-table nil
270 "Syntax table used while in TeX mode.")
271
d6709b80 272(defcustom latex-imenu-indent-string ". "
a53c647b
RS
273 "*String to add repeated in front of nested sectional units for Imenu.
274An alternative value is \" . \", if you use a font with a narrow period."
275 :type 'string
276 :group 'tex)
277
d6709b80
SM
278(defvar latex-section-alist
279 '(("part" . 0) ("chapter" . 1)
280 ("section" . 2) ("subsection" . 3)
281 ("subsubsection" . 4)
282 ("paragraph" . 5) ("subparagraph" . 6)))
283
a5e2ae01
RS
284(defun latex-imenu-create-index ()
285 "Generates an alist for imenu from a LaTeX buffer."
a53c647b
RS
286 (let (i0 menu case-fold-search)
287 (save-excursion
288 ;; Find the top-most level in this file but don't allow it to be
289 ;; any deeper than "section" (which is top-level in an article).
290 (goto-char (point-min))
291 (if (search-forward-regexp "\\\\part\\*?[ \t]*{" nil t)
292 (setq i0 0)
293 (if (search-forward-regexp "\\\\chapter\\*?[ \t]*{" nil t)
294 (setq i0 1)
295 (setq i0 2)))
296
297 ;; Look for chapters and sections.
298 (goto-char (point-min))
299 (while (search-forward-regexp
4e9b8ebe 300 (progn
d6709b80
SM
301 (concat "\\\\" (regexp-opt (mapcar 'car latex-section-alist) t)
302 "\\*?[ \t]*{")) nil t)
a53c647b
RS
303 (let ((start (match-beginning 0))
304 (here (point))
305 (i (cdr (assoc (buffer-substring-no-properties
306 (match-beginning 1)
307 (match-end 1))
d6709b80 308 latex-section-alist))))
a53c647b
RS
309 (backward-char 1)
310 (condition-case err
311 (progn
312 ;; Using sexps allows some use of matching {...} inside
313 ;; titles.
314 (forward-sexp 1)
d6709b80
SM
315 (push (cons (concat (apply 'concat
316 (make-list
317 (max 0 (- i i0))
318 latex-imenu-indent-string))
319 (buffer-substring-no-properties
320 here (1- (point))))
321 start)
322 menu))
a53c647b
RS
323 (error nil))))
324
325 ;; Look for included material.
326 (goto-char (point-min))
327 (while (search-forward-regexp
328 "\\\\\\(include\\|input\\|verbatiminput\\|bibliography\\)\
329[ \t]*{\\([^}\n]+\\)}"
330 nil t)
331 (setq menu
332 (cons (cons (concat "<<" (buffer-substring-no-properties
333 (match-beginning 2)
334 (match-end 2))
335 (if (= (char-after (match-beginning 1)) ?b)
336 ".bbl"
337 ".tex"))
338 (match-beginning 0))
339 menu)))
340
341 ;; Look for \frontmatter, \mainmatter, \backmatter, and \appendix.
342 (goto-char (point-min))
343 (while (search-forward-regexp
344 "\\\\\\(frontmatter\\|mainmatter\\|backmatter\\|appendix\\)\\b"
345 nil t)
346 (setq menu
347 (cons (cons "--" (match-beginning 0))
348 menu)))
349
350 ;; Sort in increasing buffer position order.
351 (sort menu (function (lambda (a b) (< (cdr a) (cdr b))))))))
0fb4f245 352
869bff31 353(defun tex-define-common-keys (keymap)
81c735c0 354 "Define the keys that we want defined both in TeX mode and in the TeX shell."
869bff31 355 (define-key keymap "\C-c\C-k" 'tex-kill-job)
356 (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer)
357 (define-key keymap "\C-c\C-q" 'tex-show-print-queue)
358 (define-key keymap "\C-c\C-p" 'tex-print)
359 (define-key keymap "\C-c\C-v" 'tex-view)
62a24cb5
RS
360
361 (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
362
363 (define-key keymap [menu-bar tex tex-kill-job] '("Tex Kill" . tex-kill-job))
cf6d6e8a
RS
364 (define-key keymap [menu-bar tex tex-recenter-output-buffer]
365 '("Tex Recenter" . tex-recenter-output-buffer))
62a24cb5
RS
366 (define-key keymap [menu-bar tex tex-show-print-queue]
367 '("Show Print Queue" . tex-show-print-queue))
cf6d6e8a
RS
368 (define-key keymap [menu-bar tex tex-alt-print]
369 '("Tex Print (alt printer)" . tex-alt-print))
62a24cb5 370 (define-key keymap [menu-bar tex tex-print] '("Tex Print" . tex-print))
cf6d6e8a 371 (define-key keymap [menu-bar tex tex-view] '("Tex View" . tex-view))
869bff31 372 )
373
374(defvar tex-mode-map nil "Keymap for TeX mode.")
375
bed1b0c8 376(if tex-mode-map
869bff31 377 nil
378 (setq tex-mode-map (make-sparse-keymap))
379 (tex-define-common-keys tex-mode-map)
380 (define-key tex-mode-map "\"" 'tex-insert-quote)
381 (define-key tex-mode-map "\n" 'tex-terminate-paragraph)
382 (define-key tex-mode-map "\C-c}" 'up-list)
383 (define-key tex-mode-map "\C-c{" 'tex-insert-braces)
384 (define-key tex-mode-map "\C-c\C-r" 'tex-region)
385 (define-key tex-mode-map "\C-c\C-b" 'tex-buffer)
386 (define-key tex-mode-map "\C-c\C-f" 'tex-file)
387 (define-key tex-mode-map "\C-c\C-i" 'tex-bibtex-file)
388 (define-key tex-mode-map "\C-c\C-o" 'tex-latex-block)
cf6d6e8a 389 (define-key tex-mode-map "\C-c\C-e" 'tex-close-latex-block)
6a900cf1 390 (define-key tex-mode-map "\C-c\C-u" 'tex-goto-last-unclosed-latex-block)
f05bd645
RS
391 (define-key tex-mode-map "\C-c\C-m" 'tex-feed-input)
392 (define-key tex-mode-map [(control return)] 'tex-feed-input)
002b0d00
RS
393 (define-key tex-mode-map [menu-bar tex tex-bibtex-file]
394 '("BibTeX File" . tex-bibtex-file))
cf6d6e8a
RS
395 (define-key tex-mode-map [menu-bar tex tex-validate-region]
396 '("Validate Region" . tex-validate-region))
e6b0b773
MR
397 (define-key tex-mode-map [menu-bar tex tex-validate-buffer]
398 '("Validate Buffer" . tex-validate-buffer))
cf6d6e8a 399 (define-key tex-mode-map [menu-bar tex tex-region]
002b0d00 400 '("TeX Region" . tex-region))
cf6d6e8a 401 (define-key tex-mode-map [menu-bar tex tex-buffer]
002b0d00
RS
402 '("TeX Buffer" . tex-buffer))
403 (define-key tex-mode-map [menu-bar tex tex-file] '("TeX File" . tex-file)))
cf6d6e8a
RS
404
405(put 'tex-region 'menu-enable 'mark-active)
406(put 'tex-validate-region 'menu-enable 'mark-active)
407(put 'tex-print 'menu-enable '(stringp tex-print-file))
408(put 'tex-alt-print 'menu-enable '(stringp tex-print-file))
409(put 'tex-view 'menu-enable '(stringp tex-print-file))
410(put 'tex-recenter-output-buffer 'menu-enable '(get-buffer "*tex-shell*"))
411(put 'tex-kill-job 'menu-enable '(tex-shell-running))
412
d6709b80
SM
413(defvar tex-shell-map
414 (let ((m (make-sparse-keymap)))
415 (set-keymap-parent m shell-mode-map)
416 (tex-define-common-keys m)
417 m)
81c735c0 418 "Keymap for the TeX shell.
dca5ea48 419Inherits `shell-mode-map' with a few additions.")
869bff31 420
6da9bbd6
RS
421(defvar tex-face-alist
422 '((bold . "{\\bf ")
423 (italic . "{\\it ")
424 (bold-italic . "{\\bi ") ; hypothetical
425 (underline . "\\underline{")
426 (default . "{\\rm "))
427 "Alist of face and TeX font name for facemenu.")
428
429(defvar tex-latex-face-alist
430 `((italic . "{\\em ")
431 ,@tex-face-alist)
432 "Alist of face and LaTeX font name for facemenu.")
433
869bff31 434;;; This would be a lot simpler if we just used a regexp search,
435;;; but then it would be too slow.
7229064d 436;;;###autoload
869bff31 437(defun tex-mode ()
438 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
439Tries to determine (by looking at the beginning of the file) whether
81c735c0
RS
440this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
441`latex-mode', or `slitex-mode', respectively. If it cannot be determined,
442such as if there are no commands in the file, the value of `tex-default-mode'
443says which mode to use."
869bff31 444 (interactive)
d6709b80 445 (let ((mode tex-default-mode) slash comment)
869bff31 446 (save-excursion
447 (goto-char (point-min))
448 (while (and (setq slash (search-forward "\\" nil t))
449 (setq comment (let ((search-end (point)))
450 (save-excursion
451 (beginning-of-line)
452 (search-forward "%" search-end t))))))
453 (if (and slash (not comment))
c0bcb239 454 (setq mode (if (looking-at "documentstyle\\|documentclass\\|begin\\b\\|NeedsTeXFormat{LaTeX")
0edb9815
RS
455 (if (looking-at
456 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
869bff31 457 'slitex-mode
458 'latex-mode)
459 'plain-tex-mode))))
d6709b80 460 (funcall mode)))
e4c8c838 461
6503cec3 462;;;###autoload
31e1d920 463(defalias 'TeX-mode 'tex-mode)
6503cec3 464;;;###autoload
c3ce7bf4
RS
465(defalias 'plain-TeX-mode 'plain-tex-mode)
466;;;###autoload
31e1d920 467(defalias 'LaTeX-mode 'latex-mode)
869bff31 468
7229064d 469;;;###autoload
d6709b80 470(define-derived-mode plain-tex-mode text-mode "TeX"
869bff31 471 "Major mode for editing files of input for plain TeX.
472Makes $ and } display the characters they match.
473Makes \" insert `` when it seems to be the beginning of a quotation,
474and '' when it appears to be the end; it inserts \" only after a \\.
475
476Use \\[tex-region] to run TeX on the current region, plus a \"header\"
477copied from the top of the file (containing macro definitions, etc.),
478running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
479\\[tex-file] saves the buffer and then processes the file.
480\\[tex-print] prints the .dvi file made by any of these.
481\\[tex-view] previews the .dvi file made by any of these.
482\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
483
e6b0b773 484Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 485mismatched $'s or braces.
486
487Special commands:
488\\{tex-mode-map}
489
490Mode variables:
491tex-run-command
492 Command string used by \\[tex-region] or \\[tex-buffer].
493tex-directory
494 Directory in which to create temporary files for TeX jobs
495 run by \\[tex-region] or \\[tex-buffer].
496tex-dvi-print-command
497 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
498tex-alt-dvi-print-command
499 Alternative command string used by \\[tex-print] (when given a prefix
500 argument) to print a .dvi file.
869bff31 501tex-dvi-view-command
502 Command string used by \\[tex-view] to preview a .dvi file.
503tex-show-queue-command
504 Command string used by \\[tex-show-print-queue] to show the print
505 queue that \\[tex-print] put your job on.
506
81c735c0
RS
507Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
508`tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
509special subshell is initiated, the hook `tex-shell-hook' is run."
869bff31 510 (tex-common-initialization)
869bff31 511 (setq tex-command tex-run-command)
898b9ac1
RS
512 (setq tex-start-of-header "%\\*\\*start of header")
513 (setq tex-end-of-header "%\\*\\*end of header")
869bff31 514 (setq tex-trailer "\\bye\n")
d6709b80 515 (run-hooks 'tex-mode-hook))
869bff31 516
7229064d 517;;;###autoload
d6709b80 518(define-derived-mode latex-mode text-mode "LaTeX"
869bff31 519 "Major mode for editing files of input for LaTeX.
520Makes $ and } display the characters they match.
521Makes \" insert `` when it seems to be the beginning of a quotation,
522and '' when it appears to be the end; it inserts \" only after a \\.
523
524Use \\[tex-region] to run LaTeX on the current region, plus the preamble
525copied from the top of the file (containing \\documentstyle, etc.),
526running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
527\\[tex-file] saves the buffer and then processes the file.
528\\[tex-print] prints the .dvi file made by any of these.
529\\[tex-view] previews the .dvi file made by any of these.
530\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
531
e6b0b773 532Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 533mismatched $'s or braces.
534
535Special commands:
536\\{tex-mode-map}
537
538Mode variables:
539latex-run-command
540 Command string used by \\[tex-region] or \\[tex-buffer].
541tex-directory
542 Directory in which to create temporary files for LaTeX jobs
543 run by \\[tex-region] or \\[tex-buffer].
544tex-dvi-print-command
545 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
546tex-alt-dvi-print-command
547 Alternative command string used by \\[tex-print] (when given a prefix
548 argument) to print a .dvi file.
869bff31 549tex-dvi-view-command
550 Command string used by \\[tex-view] to preview a .dvi file.
551tex-show-queue-command
552 Command string used by \\[tex-show-print-queue] to show the print
553 queue that \\[tex-print] put your job on.
554
bed1b0c8 555Entering Latex mode runs the hook `text-mode-hook', then
81c735c0
RS
556`tex-mode-hook', and finally `latex-mode-hook'. When the special
557subshell is initiated, `tex-shell-hook' is run."
869bff31 558 (tex-common-initialization)
869bff31 559 (setq tex-command latex-run-command)
898b9ac1
RS
560 (setq tex-start-of-header "\\\\documentstyle\\|\\\\documentclass")
561 (setq tex-end-of-header "\\\\begin{document}")
869bff31 562 (setq tex-trailer "\\end{document}\n")
ab2c9f54
RS
563 ;; A line containing just $$ is treated as a paragraph separator.
564 ;; A line starting with $$ starts a paragraph,
565 ;; but does not separate paragraphs if it has more stuff on it.
d6709b80
SM
566 (setq paragraph-start
567 (concat "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$\\|"
568 "\\\\[][]\\|"
569 "\\\\" (regexp-opt (append
570 (mapcar 'car latex-section-alist)
571 '("begin" "label" "end"
572 "item" "bibitem" "newline" "noindent"
573 "newpage" "footnote" "marginpar"
574 "parbox" "caption")) t)
575 "\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t)
576 "\\>"))
577 (setq paragraph-separate
578 (concat "[ \t]*$\\|[\f%]\\|[ \t]*\\$\\$[ \t]*$\\|"
579 "\\\\[][]\\|"
580 "\\\\" (regexp-opt (append
581 (mapcar 'car latex-section-alist)
582 '("begin" "label" "end" )) t)
583 "\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
584 "noindent" "newpage" "footnote"
585 "marginpar" "parbox" "caption"))
586 "\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
587 "\\)[ \t]*\\($\\|%\\)"))
588 (set (make-local-variable 'imenu-create-index-function)
589 'latex-imenu-create-index)
590 (set (make-local-variable 'tex-face-alist) tex-latex-face-alist)
591 (set (make-local-variable 'fill-nobreak-predicate)
592 'latex-fill-nobreak-predicate)
593 (set (make-local-variable 'outline-regexp) latex-outline-regexp)
594 (set (make-local-variable 'outline-level) 'latex-outline-level)
595 (run-hooks 'tex-mode-hook))
869bff31 596
bd2f2323 597;;;###autoload
d6709b80 598(define-derived-mode slitex-mode latex-mode "SliTeX"
869bff31 599 "Major mode for editing files of input for SliTeX.
600Makes $ and } display the characters they match.
601Makes \" insert `` when it seems to be the beginning of a quotation,
602and '' when it appears to be the end; it inserts \" only after a \\.
603
604Use \\[tex-region] to run SliTeX on the current region, plus the preamble
605copied from the top of the file (containing \\documentstyle, etc.),
606running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
607\\[tex-file] saves the buffer and then processes the file.
608\\[tex-print] prints the .dvi file made by any of these.
609\\[tex-view] previews the .dvi file made by any of these.
610\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
611
e6b0b773 612Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 613mismatched $'s or braces.
614
615Special commands:
616\\{tex-mode-map}
617
618Mode variables:
619slitex-run-command
620 Command string used by \\[tex-region] or \\[tex-buffer].
621tex-directory
622 Directory in which to create temporary files for SliTeX jobs
623 run by \\[tex-region] or \\[tex-buffer].
624tex-dvi-print-command
625 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
626tex-alt-dvi-print-command
627 Alternative command string used by \\[tex-print] (when given a prefix
628 argument) to print a .dvi file.
869bff31 629tex-dvi-view-command
630 Command string used by \\[tex-view] to preview a .dvi file.
631tex-show-queue-command
632 Command string used by \\[tex-show-print-queue] to show the print
633 queue that \\[tex-print] put your job on.
634
81c735c0
RS
635Entering SliTeX mode runs the hook `text-mode-hook', then the hook
636`tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
637`slitex-mode-hook'. When the special subshell is initiated, the hook
638`tex-shell-hook' is run."
869bff31 639 (setq tex-command slitex-run-command)
d6709b80 640 (setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
869bff31 641
642(defun tex-common-initialization ()
869bff31 643 (use-local-map tex-mode-map)
644 (setq local-abbrev-table text-mode-abbrev-table)
645 (if (null tex-mode-syntax-table)
646 (let ((char 0))
647 (setq tex-mode-syntax-table (make-syntax-table))
648 (set-syntax-table tex-mode-syntax-table)
649 (while (< char ? )
650 (modify-syntax-entry char ".")
651 (setq char (1+ char)))
652 (modify-syntax-entry ?\C-@ "w")
653 (modify-syntax-entry ?\t " ")
654 (modify-syntax-entry ?\n ">")
655 (modify-syntax-entry ?\f ">")
656 (modify-syntax-entry ?$ "$$")
657 (modify-syntax-entry ?% "<")
658 (modify-syntax-entry ?\\ "/")
659 (modify-syntax-entry ?\" ".")
660 (modify-syntax-entry ?& ".")
661 (modify-syntax-entry ?_ ".")
662 (modify-syntax-entry ?@ "_")
663 (modify-syntax-entry ?~ " ")
664 (modify-syntax-entry ?' "w"))
665 (set-syntax-table tex-mode-syntax-table))
822eddf4 666 ;; Regexp isearch should accept newline and formfeed as whitespace.
d6709b80 667 (set (make-local-variable 'search-whitespace-regexp) "[ \t\r\n\f]+")
64db2461 668 ;; A line containing just $$ is treated as a paragraph separator.
d6709b80
SM
669 (set (make-local-variable 'paragraph-start)
670 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
ab2c9f54
RS
671 ;; A line starting with $$ starts a paragraph,
672 ;; but does not separate paragraphs if it has more stuff on it.
d6709b80
SM
673 (set (make-local-variable 'paragraph-separate)
674 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
675 (set (make-local-variable 'comment-start) "%")
676 (set (make-local-variable 'comment-add) 1)
677 (set (make-local-variable 'comment-start-skip)
678 "\\(\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
679 (set (make-local-variable 'comment-indent-function) 'tex-comment-indent)
680 (set (make-local-variable 'parse-sexp-ignore-comments) t)
681 (set (make-local-variable 'compare-windows-whitespace)
682 'tex-categorize-whitespace)
683 (set (make-local-variable 'facemenu-add-face-function)
684 (lambda (face end)
685 (let ((face-text (cdr (assq face tex-face-alist))))
686 (if face-text
687 face-text
688 (error "Face %s not configured for %s mode" face mode-name)))))
689 (set (make-local-variable 'facemenu-end-add-face) "}")
690 (set (make-local-variable 'facemenu-remove-face-function) t)
691 (set (make-local-variable 'font-lock-defaults)
692 '((tex-font-lock-keywords
693 tex-font-lock-keywords-1 tex-font-lock-keywords-2)
694 nil nil ((?$ . "\"")) nil
695 ;; Who ever uses that anyway ???
696 (font-lock-mark-block-function . mark-paragraph)))
869bff31 697 (make-local-variable 'tex-command)
698 (make-local-variable 'tex-start-of-header)
699 (make-local-variable 'tex-end-of-header)
700 (make-local-variable 'tex-trailer))
701
702(defun tex-comment-indent ()
703 (if (looking-at "%%%")
704 (current-column)
705 (skip-chars-backward " \t")
706 (max (if (bolp) 0 (1+ (current-column)))
707 comment-column)))
708
709(defun tex-categorize-whitespace (backward-limit)
710 ;; compare-windows-whitespace is set to this.
711 ;; This is basically a finite-state machine.
712 ;; Returns a symbol telling how TeX would treat
713 ;; the whitespace we are looking at: null, space, or par.
714 (let ((category 'null)
715 (not-finished t))
716 (skip-chars-backward " \t\n\f" backward-limit)
717 (while not-finished
718 (cond ((looking-at "[ \t]+")
719 (goto-char (match-end 0))
2be5fefb 720 (if (eq category 'null)
869bff31 721 (setq category 'space)))
722 ((looking-at "\n")
2be5fefb 723 (cond ((eq category 'newline)
869bff31 724 (setq category 'par)
725 (setq not-finished nil))
726 (t
727 (setq category 'newline) ;a strictly internal state
728 (goto-char (match-end 0)))))
729 ((looking-at "\f+")
730 (setq category 'par)
731 (setq not-finished nil))
732 (t
733 (setq not-finished nil))))
734 (skip-chars-forward " \t\n\f")
2be5fefb 735 (if (eq category 'newline)
869bff31 736 'space ;TeX doesn't distinguish
737 category)))
738
739(defun tex-insert-quote (arg)
740 "Insert the appropriate quote marks for TeX.
08348502
RS
741Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
742\(normally '') depending on the context. With prefix argument, always
869bff31 743inserts \" characters."
528415e7 744 (interactive "*P")
869bff31 745 (if arg
746 (self-insert-command (prefix-numeric-value arg))
747 (insert
748 (cond ((or (bobp)
749 (save-excursion
750 (forward-char -1)
751 (looking-at "\\s(\\|\\s \\|\\s>")))
752 tex-open-quote)
753 ((= (preceding-char) ?\\)
754 ?\")
755 (t
756 tex-close-quote)))))
757
e6b0b773
MR
758(defun tex-validate-buffer ()
759 "Check current buffer for paragraphs containing mismatched braces or $s.
bbd93e41 760Their positions are recorded in the buffer `*Occur*'.
e6b0b773
MR
761To find a particular invalidity from `*Occur*', switch to that buffer
762and type C-c C-c or click with mouse-2
763on the line for the invalidity you want to see."
869bff31 764 (interactive)
bbd93e41
RS
765 (let ((buffer (current-buffer))
766 (prevpos (point-min))
e6b0b773
MR
767 (linenum nil)
768 (num-matches 0))
bbd93e41
RS
769 (with-output-to-temp-buffer "*Occur*"
770 (princ "Mismatches:\n")
771 (save-excursion
772 (set-buffer standard-output)
773 (occur-mode)
774 (setq occur-buffer buffer)
e6b0b773 775 (setq occur-nlines 0))
bbd93e41
RS
776 (save-excursion
777 (goto-char (point-max))
869bff31 778 (while (and (not (input-pending-p)) (not (bobp)))
710a0f53
KH
779 (let ((end (point))
780 prev-end)
bbd93e41 781 ;; Scan the previous paragraph for invalidities.
710a0f53
KH
782 (if (search-backward "\n\n" nil t)
783 (progn
784 (setq prev-end (point))
785 (forward-char 2))
786 (goto-char (setq prev-end (point-min))))
869bff31 787 (or (tex-validate-region (point) end)
710a0f53
KH
788 (let* ((oend end)
789 (end (save-excursion (forward-line 1) (point)))
bbd93e41
RS
790 start tem)
791 (beginning-of-line)
792 (setq start (point))
793 ;; Keep track of line number as we scan,
794 ;; in a cumulative fashion.
795 (if linenum
796 (setq linenum (- linenum (count-lines prevpos (point))))
797 (setq linenum (1+ (count-lines 1 start))))
798 (setq prevpos (point))
bed1b0c8 799 ;; Mention this mismatch in *Occur*.
bbd93e41 800 ;; Since we scan from end of buffer to beginning,
e6b0b773 801 ;; add each mismatch at the beginning of *Occur*.
bbd93e41
RS
802 (save-excursion
803 (setq tem (point-marker))
804 (set-buffer standard-output)
805 (goto-char (point-min))
806 ;; Skip "Mismatches:" header line.
807 (forward-line 1)
e6b0b773 808 (setq num-matches (1+ num-matches))
bbd93e41 809 (insert-buffer-substring buffer start end)
e6b0b773
MR
810 (let (text-beg (text-end (point-marker)))
811 (forward-char (- start end))
812 (setq text-beg (point-marker))
813 (insert (format "%3d: " linenum))
814 (put-text-property (marker-position text-beg)
815 (- (marker-position text-end) 1)
816 'mouse-face 'highlight)
817 (put-text-property (marker-position text-beg)
818 (- (marker-position text-end) 1)
819 'occur tem)))))
710a0f53 820 (goto-char prev-end))))
bbd93e41
RS
821 (save-excursion
822 (set-buffer standard-output)
e6b0b773 823 (if (eq num-matches 0)
bbd93e41
RS
824 (insert "None!\n"))
825 (if (interactive-p)
e6b0b773 826 (message "%d mismatches found" num-matches))))))
869bff31 827
828(defun tex-validate-region (start end)
829 "Check for mismatched braces or $'s in region.
830Returns t if no mismatches. Returns nil and moves point to suspect
831area if a mismatch is found."
832 (interactive "r")
833 (let ((failure-point nil) (max-possible-sexps (- end start)))
834 (save-excursion
835 (condition-case ()
836 (save-restriction
837 (narrow-to-region start end)
2ed2806c 838 ;; First check that the open and close parens balance in numbers.
869bff31 839 (goto-char start)
e6b0b773 840 (while (<= 0 (setq max-possible-sexps (1- max-possible-sexps)))
2ed2806c
KH
841 (forward-sexp 1))
842 ;; Now check that like matches like.
843 (goto-char start)
844 (while (progn (skip-syntax-forward "^(")
845 (not (eobp)))
846 (let ((match (matching-paren (following-char))))
847 (save-excursion
848 (forward-sexp 1)
849 (or (= (preceding-char) match)
850 (error "Mismatched parentheses"))))
851 (forward-char 1)))
869bff31 852 (error
bed1b0c8
RS
853 (skip-syntax-forward " .>")
854 (setq failure-point (point)))))
869bff31 855 (if failure-point
856 (progn
857 (goto-char failure-point)
858 nil)
859 t)))
860
861(defun tex-terminate-paragraph (inhibit-validation)
862 "Insert two newlines, breaking a paragraph for TeX.
81c735c0 863Check for mismatched braces or $s in paragraph being terminated.
869bff31 864A prefix arg inhibits the checking."
528415e7 865 (interactive "*P")
869bff31 866 (or inhibit-validation
867 (save-excursion
868 (tex-validate-region
bed1b0c8
RS
869 (save-excursion
870 (search-backward "\n\n" nil 'move)
871 (point))
872 (point)))
869bff31 873 (message "Paragraph being closed appears to contain a mismatch"))
874 (insert "\n\n"))
875
876(defun tex-insert-braces ()
877 "Make a pair of braces and be poised to type inside of them."
528415e7 878 (interactive "*")
869bff31 879 (insert ?\{)
880 (save-excursion
881 (insert ?})))
882
9bd4f69c
RS
883;; This function is used as the value of fill-nobreak-predicate
884;; in LaTeX mode. Its job is to prevent line-breaking inside
885;; of a \verb construct.
886(defun latex-fill-nobreak-predicate ()
887 (let ((opoint (point))
888 inside)
bed1b0c8 889 (save-excursion
9bd4f69c
RS
890 (save-restriction
891 (beginning-of-line)
892 (narrow-to-region (point) opoint)
893 (while (re-search-forward "\\\\verb\\(.\\)" nil t)
894 (unless (re-search-forward (regexp-quote (match-string 1)) nil t)
895 (setq inside t)))))
896 inside))
897
869bff31 898;;; Like tex-insert-braces, but for LaTeX.
cf149bdf
RS
899(define-skeleton tex-latex-block
900 "Create a matching pair of lines \\begin[OPT]{NAME} and \\end{NAME} at point.
869bff31 901Puts point on a blank line between them."
cf149bdf
RS
902 (completing-read "LaTeX block name: "
903 (mapcar 'list
904 (append standard-latex-block-names
905 latex-block-names)))
906 "\\begin["
907 (skeleton-read "[options]: ") & ?\] | -1
908 ?\{
909 str
910 ?\} \n
911 _ \n
912 "\\end{" str ?\})
869bff31 913
914(defun tex-last-unended-begin ()
81c735c0 915 "Leave point at the beginning of the last `\\begin{...}' that is unended."
869bff31 916 (while (and (re-search-backward "\\(\\\\begin\\s *{\\)\\|\\(\\\\end\\s *{\\)")
917 (looking-at "\\\\end{"))
918 (tex-last-unended-begin)))
919
6a900cf1
ER
920(defun tex-goto-last-unclosed-latex-block ()
921 "Move point to the last unclosed \\begin{...}.
922Mark is left at original location."
923 (interactive)
924 (let ((spot))
925 (save-excursion
926 (condition-case nil
927 (tex-last-unended-begin)
928 (error (error "Couldn't find unended \\begin")))
929 (setq spot (point)))
930 (push-mark)
931 (goto-char spot)))
932
869bff31 933(defun tex-close-latex-block ()
934 "Creates an \\end{...} to match the last unclosed \\begin{...}."
935 (interactive "*")
936 (let ((new-line-needed (bolp))
937 text indentation)
938 (save-excursion
528415e7 939 (condition-case nil
869bff31 940 (tex-last-unended-begin)
941 (error (error "Couldn't find unended \\begin")))
942 (setq indentation (current-column))
943 (re-search-forward "\\\\begin\\(\\s *{[^}\n]*}\\)")
944 (setq text (buffer-substring (match-beginning 1) (match-end 1))))
945 (indent-to indentation)
946 (insert "\\end" text)
947 (if new-line-needed (insert ?\n))))
948\f
949;;; Invoking TeX in an inferior shell.
950
951;;; Why use a shell instead of running TeX directly? Because if TeX
952;;; gets stuck, the user can switch to the shell window and type at it.
953
954;;; The utility functions:
955
d974af30 956;;;###autoload
869bff31 957(defun tex-start-shell ()
d6709b80
SM
958 (with-current-buffer
959 (make-comint
960 "tex-shell"
961 (or tex-shell-file-name (getenv "ESHELL") (getenv "SHELL") "/bin/sh")
962 nil)
528415e7
RS
963 (let ((proc (get-process "tex-shell")))
964 (set-process-sentinel proc 'tex-shell-sentinel)
965 (process-kill-without-query proc)
e8c04c88 966 (setq comint-prompt-regexp shell-prompt-pattern)
528415e7 967 (use-local-map tex-shell-map)
f05bd645 968 (compilation-shell-minor-mode t)
09592182
AS
969 (add-hook 'comint-input-filter-functions 'shell-directory-tracker nil t)
970 (make-local-variable 'list-buffers-directory)
971 (make-local-variable 'shell-dirstack)
972 (make-local-variable 'shell-last-dir)
973 (make-local-variable 'shell-dirtrackp)
f05bd645 974 (run-hooks 'tex-shell-hook)
528415e7 975 (while (zerop (buffer-size))
51b2c841
RS
976 (sleep-for 1)))))
977
033306e3
RS
978(defun tex-feed-input ()
979 "Send input to the tex shell process.
980In the tex buffer this can be used to continue an interactive tex run.
bed1b0c8 981In the tex shell buffer this command behaves like `comint-send-input'."
033306e3
RS
982 (interactive)
983 (set-buffer (process-buffer (get-process "tex-shell")))
984 (comint-send-input)
985 (tex-recenter-output-buffer nil))
986
51b2c841
RS
987(defun tex-display-shell ()
988 "Make the TeX shell buffer visible in a window."
989 (display-buffer (process-buffer (get-process "tex-shell")))
990 (tex-recenter-output-buffer nil))
528415e7
RS
991
992(defun tex-shell-sentinel (proc msg)
993 (cond ((null (buffer-name (process-buffer proc)))
994 ;; buffer killed
995 (set-process-buffer proc nil)
996 (tex-delete-last-temp-files))
997 ((memq (process-status proc) '(signal exit))
998 (tex-delete-last-temp-files))))
999
1000(defun tex-set-buffer-directory (buffer directory)
869bff31 1001 "Set BUFFER's default directory to be DIRECTORY."
1002 (setq directory (file-name-as-directory (expand-file-name directory)))
1003 (if (not (file-directory-p directory))
1004 (error "%s is not a directory" directory)
1005 (save-excursion
1006 (set-buffer buffer)
1007 (setq default-directory directory))))
1008
30803a05
RS
1009(defvar tex-send-command-modified-tick 0)
1010(make-variable-buffer-local 'tex-send-command-modified-tick)
1011
528415e7 1012(defun tex-send-command (command &optional file background)
4cdc1d4b 1013 "Send COMMAND to TeX shell process, substituting optional FILE for *.
8241d7b9
ER
1014Do this in background if optional BACKGROUND is t. If COMMAND has no *,
1015FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
1016substitution will be made in COMMAND. COMMAND can be any expression that
460e1b7d
RS
1017evaluates to a command string.
1018
1019Return the process in which TeX is running."
528415e7
RS
1020 (save-excursion
1021 (let* ((cmd (eval command))
c93931c3 1022 (proc (or (get-process "tex-shell") (error "No TeX subprocess")))
64db2461 1023 (buf (process-buffer proc))
4f45adda 1024 (star (string-match "\\*" cmd))
4cdc1d4b
RS
1025 (string
1026 (concat
1027 (if file
1028 (if star (concat (substring cmd 0 star)
1029 file (substring cmd (1+ star)))
1030 (concat cmd " " file))
1031 cmd)
1032 (if background "&" ""))))
64db2461
RS
1033 ;; Switch to buffer before checking for subproc output in it.
1034 (set-buffer buf)
30803a05
RS
1035 ;; If text is unchanged since previous tex-send-command,
1036 ;; we haven't got any output. So wait for output now.
64db2461 1037 (if (= (buffer-modified-tick buf) tex-send-command-modified-tick)
30803a05 1038 (accept-process-output proc))
4cdc1d4b
RS
1039 (goto-char (process-mark proc))
1040 (insert string)
30803a05 1041 (comint-send-input)
460e1b7d
RS
1042 (setq tex-send-command-modified-tick (buffer-modified-tick buf))
1043 proc)))
528415e7 1044
a15849cb
RS
1045(defun tex-delete-last-temp-files (&optional not-all)
1046 "Delete any junk files from last temp file.
1047If NOT-ALL is non-nil, save the `.dvi' file."
528415e7
RS
1048 (if tex-last-temp-file
1049 (let* ((dir (file-name-directory tex-last-temp-file))
adf6b7f9
KH
1050 (list (and (file-directory-p dir)
1051 (file-name-all-completions
02fd229c
RS
1052 (file-name-sans-extension
1053 (file-name-nondirectory tex-last-temp-file))
1054 dir))))
adf6b7f9 1055 (while list
a15849cb
RS
1056 (if not-all
1057 (and
1058 ;; If arg is non-nil, don't delete the .dvi file.
1059 (not (string-match "\\.dvi$" (car list)))
1060 (delete-file (concat dir (car list))))
1061 (delete-file (concat dir (car list))))
528415e7
RS
1062 (setq list (cdr list))))))
1063
99621a14 1064(add-hook 'kill-emacs-hook 'tex-delete-last-temp-files)
869bff31 1065
460e1b7d
RS
1066(defvar tex-start-tex-marker nil
1067 "Marker pointing after last TeX-running command in the TeX shell buffer.")
1068
d6709b80
SM
1069(defun tex-main-file ()
1070 (let ((file (or tex-main-file
1071 ;; Compatibility with AUCTeX
1072 (and (boundp 'TeX-master) (stringp TeX-master) TeX-master)
1073 (if (buffer-file-name)
1074 (file-relative-name (buffer-file-name))
1075 (error "Buffer is not associated with any file")))))
1076 (if (string-match "\\.tex\\'" file)
1077 (substring file 0 (match-beginning 0))
1078 file)))
1079
1080(defun tex-start-tex (command file &optional dir)
460e1b7d 1081 "Start a TeX run, using COMMAND on FILE."
6633b891 1082 (let* ((star (string-match "\\*" command))
460e1b7d 1083 (compile-command
6633b891
KH
1084 (if star
1085 (concat (substring command 0 star)
1086 (comint-quote-filename file)
1087 (substring command (1+ star)))
1088 (concat command " "
c3ce7bf4
RS
1089 (if (< 0 (length tex-start-options-string))
1090 (concat
1091 (shell-quote-argument tex-start-options-string) " "))
6633b891 1092 (comint-quote-filename file)))))
d6709b80
SM
1093 (when dir
1094 (let (shell-dirtrack-verbose)
1095 (tex-send-command tex-shell-cd-command dir)))
460e1b7d
RS
1096 (with-current-buffer (process-buffer (tex-send-command compile-command))
1097 (save-excursion
1098 (forward-line -1)
1099 (setq tex-start-tex-marker (point-marker)))
1100 (make-local-variable 'compilation-parse-errors-function)
f05bd645 1101 (setq compilation-parse-errors-function 'tex-compilation-parse-errors)
d6709b80
SM
1102 (compilation-forget-errors))
1103 (tex-display-shell)
1104 (setq tex-last-buffer-texed (current-buffer))))
460e1b7d
RS
1105\f
1106(defun tex-compilation-parse-errors (limit-search find-at-least)
f05bd645
RS
1107 "Parse the current buffer as TeX error messages.
1108See the variable `compilation-parse-errors-function' for the interface it uses.
1109
1110This function parses only the last TeX compilation.
1111It works on TeX compilations only. It is necessary for that purpose,
1112since TeX does not put file names and line numbers on the same line as
1113for the error messages."
460e1b7d
RS
1114 (require 'thingatpt)
1115 (setq compilation-error-list nil)
1116 (message "Parsing error messages...")
f05bd645
RS
1117 (let ((default-directory ; Perhaps dir has changed meanwhile.
1118 (file-name-directory (buffer-file-name tex-last-buffer-texed)))
1119 (old-syntax-table (syntax-table))
1120 (tex-error-parse-syntax-table (copy-syntax-table (syntax-table)))
1121 found-desired (num-errors-found 0)
1122 last-filename last-linenum last-position
1123 begin-of-error end-of-error)
1124 (modify-syntax-entry ?\{ "_" tex-error-parse-syntax-table)
1125 (modify-syntax-entry ?\} "_" tex-error-parse-syntax-table)
1126 (modify-syntax-entry ?\[ "_" tex-error-parse-syntax-table)
1127 (modify-syntax-entry ?\] "_" tex-error-parse-syntax-table)
1128 ;; Single quotations may appear in errors
1129 (modify-syntax-entry ?\" "_" tex-error-parse-syntax-table)
1130 ;; Don't parse previous compilations.
ee13a145
RS
1131 (set-marker compilation-parsing-end
1132 (max compilation-parsing-end tex-start-tex-marker))
f05bd645
RS
1133 ;; Don't reparse messages already seen at last parse.
1134 (goto-char compilation-parsing-end)
1135 ;; Parse messages.
1136 (while (and (not (or found-desired (eobp)))
1137 (prog1 (re-search-forward "^! " nil 'move)
1138 (setq begin-of-error (match-beginning 0)
1139 end-of-error (match-end 0)))
1140 (re-search-forward
1141 "^l\\.\\([0-9]+\\) \\(\\.\\.\\.\\)?\\(.*\\)$" nil 'move))
1142 (let* ((this-error (set-marker (make-marker) begin-of-error))
1143 (linenum (string-to-int (match-string 1)))
1144 (error-text (regexp-quote (match-string 3)))
1145 (filename
1146 (save-excursion
1147 (unwind-protect
1148 (progn
1149 (set-syntax-table tex-error-parse-syntax-table)
1150 (backward-up-list 1)
1151 (skip-syntax-forward "(_")
1152 (while (not (file-readable-p
1153 (thing-at-point 'filename)))
1154 (skip-syntax-backward "(_")
1155 (backward-up-list 1)
1156 (skip-syntax-forward "(_"))
1157 (thing-at-point 'filename))
1158 (set-syntax-table old-syntax-table))))
1159 (new-file
1160 (or (null last-filename)
1161 (not (string-equal last-filename filename))))
1162 (error-location
1163 (save-excursion
1164 (if (equal filename (concat tex-zap-file ".tex"))
1165 (set-buffer tex-last-buffer-texed)
1166 (set-buffer (find-file-noselect filename)))
1167 (if new-file
1168 (goto-line linenum)
1169 (goto-char last-position)
1170 (forward-line (- linenum last-linenum)))
1171 ;; first try a forward search for the error text,
1172 ;; then a backward search limited by the last error.
1173 (let ((starting-point (point)))
1174 (or (re-search-forward error-text nil t)
1175 (re-search-backward
1176 error-text
1177 (marker-position last-position) t)
1178 (goto-char starting-point)))
1179 (point-marker))))
1180 (goto-char this-error)
1181 (if (and compilation-error-list
1182 (or (and find-at-least
1183 (>= num-errors-found
1184 find-at-least))
1185 (and limit-search
1186 (>= end-of-error limit-search)))
1187 new-file)
1188 (setq found-desired t)
1189 (setq num-errors-found (1+ num-errors-found)
1190 last-filename filename
1191 last-linenum linenum
1192 last-position error-location
1193 compilation-error-list ; Add the new error
1194 (cons (cons this-error error-location)
1195 compilation-error-list))
1196 (goto-char end-of-error)))))
ee13a145 1197 (set-marker compilation-parsing-end (point))
f05bd645 1198 (setq compilation-error-list (nreverse compilation-error-list))
460e1b7d
RS
1199 (message "Parsing error messages...done"))
1200\f
528415e7 1201;;; The commands:
869bff31 1202
1203(defun tex-region (beg end)
1204 "Run TeX on the current region, via a temporary file.
1205The file's name comes from the variable `tex-zap-file' and the
1206variable `tex-directory' says where to put it.
1207
1208If the buffer has a header, the header is given to TeX before the
1209region itself. The buffer's header is all lines between the strings
1210defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
1211The header must start in the first 100 lines of the buffer.
1212
1213The value of `tex-trailer' is given to TeX as input after the region.
1214
1215The value of `tex-command' specifies the command to use to run TeX."
1216 (interactive "r")
1217 (if (tex-shell-running)
1218 (tex-kill-job)
1219 (tex-start-shell))
1220 (or tex-zap-file
1221 (setq tex-zap-file (tex-generate-zap-file-name)))
6d34c59f
RS
1222 ;; Temp file will be written and TeX will be run in zap-directory.
1223 ;; If the TEXINPUTS file has relative directories or if the region has
1224 ;; \input of files, this must be the same directory as the file for
1225 ;; TeX to access the correct inputs. That's why it's safest if
1226 ;; tex-directory is ".".
1227 (let* ((zap-directory
528415e7 1228 (file-name-as-directory (expand-file-name tex-directory)))
d6709b80
SM
1229 (tex-out-file (expand-file-name (concat tex-zap-file ".tex")
1230 zap-directory)))
0d548e5d
RS
1231 ;; Don't delete temp files if we do the same buffer twice in a row.
1232 (or (eq (current-buffer) tex-last-buffer-texed)
1233 (tex-delete-last-temp-files t))
869bff31 1234 ;; Write the new temp file.
1235 (save-excursion
1236 (save-restriction
1237 (widen)
1238 (goto-char (point-min))
1239 (forward-line 100)
1240 (let ((search-end (point))
6d34c59f
RS
1241 (default-directory zap-directory)
1242 (already-output 0))
869bff31 1243 (goto-char (point-min))
6d34c59f 1244
725b7428
RS
1245 ;; Maybe copy first line, such as `\input texinfo', to temp file.
1246 (and tex-first-line-header-regexp
1247 (looking-at tex-first-line-header-regexp)
bed1b0c8 1248 (write-region (point)
6d34c59f
RS
1249 (progn (forward-line 1)
1250 (setq already-output (point)))
725b7428
RS
1251 tex-out-file nil nil))
1252
6d34c59f
RS
1253 ;; Write out the header, if there is one,
1254 ;; and any of the specified region which extends before it.
1255 ;; But don't repeat anything already written.
898b9ac1 1256 (if (re-search-forward tex-start-of-header search-end t)
6d34c59f 1257 (let (hbeg)
869bff31 1258 (beginning-of-line)
1259 (setq hbeg (point)) ;mark beginning of header
898b9ac1 1260 (if (re-search-forward tex-end-of-header nil t)
6d34c59f
RS
1261 (let (hend)
1262 (forward-line 1)
bed1b0c8 1263 (setq hend (point)) ;mark end of header
6d34c59f
RS
1264 (write-region (max (min hbeg beg) already-output)
1265 hend
1266 tex-out-file
1267 (not (zerop already-output)) nil)
1268 (setq already-output hend)))))
1269
1270 ;; Write out the specified region
1271 ;; (but don't repeat anything already written).
1272 (write-region (max beg already-output) end
1273 tex-out-file
1274 (not (zerop already-output)) nil))
1275 ;; Write the trailer, if any.
1276 ;; Precede it with a newline to make sure it
1277 ;; is not hidden in a comment.
1278 (if tex-trailer
1279 (write-region (concat "\n" tex-trailer) nil
1280 tex-out-file t nil))))
528415e7
RS
1281 ;; Record the file name to be deleted afterward.
1282 (setq tex-last-temp-file tex-out-file)
f05bd645
RS
1283 ;; Use a relative file name here because (1) the proper dir
1284 ;; is already current, and (2) the abs file name is sometimes
1285 ;; too long and can make tex crash.
d6709b80
SM
1286 (tex-start-tex tex-command (concat tex-zap-file ".tex") zap-directory)
1287 (setq tex-print-file tex-out-file)))
869bff31 1288
1289(defun tex-buffer ()
1290 "Run TeX on current buffer. See \\[tex-region] for more information.
528415e7
RS
1291Does not save the buffer, so it's useful for trying experimental versions.
1292See \\[tex-file] for an alternative."
869bff31 1293 (interactive)
1294 (tex-region (point-min) (point-max)))
1295
1296(defun tex-file ()
1297 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
1298This function is more useful than \\[tex-buffer] when you need the
1299`.aux' file of LaTeX to have the correct name."
1300 (interactive)
d6709b80
SM
1301 (let* ((source-file (tex-main-file))
1302 (file-dir (expand-file-name (file-name-directory source-file))))
7047ec77 1303 (if tex-offer-save
99621a14 1304 (save-some-buffers))
869bff31 1305 (if (tex-shell-running)
1306 (tex-kill-job)
1307 (tex-start-shell))
d6709b80 1308 (tex-start-tex tex-command source-file file-dir)
f05bd645 1309 (setq tex-print-file (expand-file-name source-file))))
869bff31 1310
1311(defun tex-generate-zap-file-name ()
1312 "Generate a unique name suitable for use as a file name."
1313 ;; Include the shell process number and host name
1314 ;; in case there are multiple shells (for same or different user).
f5cdb851
KH
1315 ;; Dec 1998: There is a report that some versions of xdvi
1316 ;; don't work with file names that start with #.
5616ee46 1317 (format "_TZ_%d-%s"
869bff31 1318 (process-id (get-buffer-process "*tex-shell*"))
1319 (tex-strip-dots (system-name))))
1320
1321(defun tex-strip-dots (s)
1322 (setq s (copy-sequence s))
1323 (while (string-match "\\." s)
1324 (aset s (match-beginning 0) ?-))
1325 s)
1326
1327;; This will perhaps be useful for modifying TEXINPUTS.
1328;; Expand each file name, separated by colons, in the string S.
1329(defun tex-expand-files (s)
1330 (let (elts (start 0))
1331 (while (string-match ":" s start)
1332 (setq elts (cons (substring s start (match-beginning 0)) elts))
1333 (setq start (match-end 0)))
1334 (or (= start 0)
1335 (setq elts (cons (substring s start) elts)))
c0df1972
SM
1336 (mapconcat (lambda (elt)
1337 (if (= (length elt) 0) elt (expand-file-name elt)))
5616ee46 1338 (nreverse elts) ":")))
869bff31 1339
1340(defun tex-shell-running ()
1341 (and (get-process "tex-shell")
1342 (eq (process-status (get-process "tex-shell")) 'run)))
1343
1344(defun tex-kill-job ()
1345 "Kill the currently running TeX job."
1346 (interactive)
bed1b0c8
RS
1347 ;; quit-process leads to core dumps of the tex process (except if
1348 ;; coredumpsize has limit 0kb as on many environments). One would
1349 ;; like to use (kill-process proc 'lambda), however that construct
1350 ;; does not work on some systems and kills the shell itself.
528415e7 1351 (quit-process (get-process "tex-shell") t))
869bff31 1352
1353(defun tex-recenter-output-buffer (linenum)
1354 "Redisplay buffer of TeX job output so that most recent output can be seen.
1355The last line of the buffer is displayed on
1356line LINE of the window, or centered if LINE is nil."
1357 (interactive "P")
1358 (let ((tex-shell (get-buffer "*tex-shell*"))
23b64225
RS
1359 (old-buffer (current-buffer))
1360 (window))
869bff31 1361 (if (null tex-shell)
1362 (message "No TeX output buffer")
23b64225
RS
1363 (setq window (display-buffer tex-shell))
1364 (save-selected-window
1365 (select-window window)
1366 (bury-buffer tex-shell)
1367 (goto-char (point-max))
1368 (recenter (if linenum
1369 (prefix-numeric-value linenum)
1370 (/ (window-height) 2)))))))
869bff31 1371
528415e7 1372(defun tex-print (&optional alt)
869bff31 1373 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1433a222
CZ
1374Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
1375is provided, use the alternative command, `tex-alt-dvi-print-command'."
528415e7 1376 (interactive "P")
869bff31 1377 (let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
1378 test-name)
1379 (if (and (not (equal (current-buffer) tex-last-buffer-texed))
45c3304d
RS
1380 (buffer-file-name)
1381 ;; Check that this buffer's printed file is up to date.
869bff31 1382 (file-newer-than-file-p
1383 (setq test-name (tex-append (buffer-file-name) ".dvi"))
45c3304d 1384 (buffer-file-name)))
869bff31 1385 (setq print-file-name-dvi test-name))
528415e7
RS
1386 (if (not (file-exists-p print-file-name-dvi))
1387 (error "No appropriate `.dvi' file could be found")
460e1b7d
RS
1388 (if (tex-shell-running)
1389 (tex-kill-job)
1390 (tex-start-shell))
528415e7 1391 (tex-send-command
bed1b0c8
RS
1392 (if alt tex-alt-dvi-print-command tex-dvi-print-command)
1393 print-file-name-dvi t))))
869bff31 1394
cf6d6e8a
RS
1395(defun tex-alt-print ()
1396 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
002b0d00 1397Runs the shell command defined by `tex-alt-dvi-print-command'."
cf6d6e8a
RS
1398 (interactive)
1399 (tex-print t))
1400
869bff31 1401(defun tex-view ()
1402 "Preview the last `.dvi' file made by running TeX under Emacs.
1403This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
2b7971c9
RS
1404The variable `tex-dvi-view-command' specifies the shell command for preview.
1405You must set that variable yourself before using this command,
1406because there is no standard value that would generally work."
869bff31 1407 (interactive)
2b7971c9
RS
1408 (or tex-dvi-view-command
1409 (error "You must set `tex-dvi-view-command'"))
869bff31 1410 (let ((tex-dvi-print-command tex-dvi-view-command))
1411 (tex-print)))
1412
1413(defun tex-append (file-name suffix)
1414 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
cf6d6e8a 1415Pascal-based TeX scans for the first period, C TeX uses the last.
869bff31 1416No period is retained immediately before SUFFIX,
1417so normally SUFFIX starts with one."
1418 (if (stringp file-name)
cf6d6e8a
RS
1419 (let ((file (file-name-nondirectory file-name))
1420 trial-name)
6da9bbd6 1421 ;; Try splitting on last period.
7d0ca249
RS
1422 ;; The first-period split can get fooled when two files
1423 ;; named a.tex and a.b.tex are both tex'd;
1424 ;; the last-period split must be right if it matches at all.
cf6d6e8a
RS
1425 (setq trial-name
1426 (concat (file-name-directory file-name)
1427 (substring file 0
7d0ca249 1428 (string-match "\\.[^.]*$" file))
cf6d6e8a
RS
1429 suffix))
1430 (if (or (file-exists-p trial-name)
1431 (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
1432 trial-name
7d0ca249 1433 ;; Not found, so split on first period.
cf6d6e8a
RS
1434 (concat (file-name-directory file-name)
1435 (substring file 0
7d0ca249 1436 (string-match "\\." file))
cf6d6e8a 1437 suffix)))
869bff31 1438 " "))
1439
1440(defun tex-show-print-queue ()
1441 "Show the print queue that \\[tex-print] put your job on.
1433a222 1442Runs the shell command defined by `tex-show-queue-command'."
869bff31 1443 (interactive)
1444 (if (tex-shell-running)
1445 (tex-kill-job)
1446 (tex-start-shell))
51b2c841
RS
1447 (tex-send-command tex-show-queue-command)
1448 (tex-display-shell))
869bff31 1449
1450(defun tex-bibtex-file ()
1451 "Run BibTeX on the current buffer's file."
1452 (interactive)
1453 (if (tex-shell-running)
1454 (tex-kill-job)
1455 (tex-start-shell))
e6b0b773
MR
1456 (let (shell-dirtrack-verbose
1457 (tex-out-file
869bff31 1458 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
1459 (file-dir (file-name-directory (buffer-file-name))))
528415e7 1460 (tex-send-command tex-shell-cd-command file-dir)
51b2c841
RS
1461 (tex-send-command tex-bibtex-command tex-out-file))
1462 (tex-display-shell))
528415e7 1463
d6709b80
SM
1464;;;;
1465;;;; Outline support
1466;;;;
1467
1468(defvar latex-outline-regexp
1469 (concat "\\\\"
4e9b8ebe
GM
1470 (regexp-opt (nconc (list "documentstyle" "documentclass"
1471 "begin{document}" "end{document}"
1472 "appendix")
d6709b80
SM
1473 (mapcar 'car latex-section-alist)) t)))
1474
1475(defun latex-outline-level ()
1476 (if (looking-at latex-outline-regexp)
1477 (1+ (or (cdr (assoc (match-string 1) latex-section-alist)) -1))
1478 1000))
1479
1480
528415e7 1481(run-hooks 'tex-mode-load-hook)
869bff31 1482
49116ac0
JB
1483(provide 'tex-mode)
1484
d501f516 1485;;; tex-mode.el ends here