(Quitting): Minor clarification.
[bpt/emacs.git] / lisp / textmodes / tex-mode.el
CommitLineData
95a045bd 1;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands -*- coding: utf-8 -*-
d501f516 2
dd166d5f 3;; Copyright (C) 1985, 1986, 1989, 1992, 1994, 1995, 1996, 1997, 1998, 1999,
3731a850 4;; 2002, 2003, 2004, 2005 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 25;; along with GNU Emacs; see the file COPYING. If not, write to the
4fc5845f
LK
26;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27;; Boston, MA 02110-1301, USA.
869bff31 28
55535639
PJ
29;;; Commentary:
30
e5167999
ER
31;;; Code:
32
bed1b0c8
RS
33;; Pacify the byte-compiler
34(eval-when-compile
35 (require 'compare-w)
ea590e1c 36 (require 'cl)
bed1b0c8
RS
37 (require 'skeleton))
38
2e261f76
JB
39(defvar font-lock-comment-face)
40(defvar font-lock-doc-face)
41
a0e9c22a 42(require 'shell)
2f3067de 43(require 'compile)
528415e7 44
d61140e8 45(defgroup tex-file nil
d1218e3e 46 "TeX files and directories."
d61140e8
RS
47 :prefix "tex-"
48 :group 'tex)
49
50(defgroup tex-run nil
d1218e3e 51 "Running external commands from TeX mode."
d61140e8
RS
52 :prefix "tex-"
53 :group 'tex)
54
55(defgroup tex-view nil
d1218e3e 56 "Viewing and printing TeX files."
d61140e8
RS
57 :prefix "tex-"
58 :group 'tex)
59
7e1dae73 60;;;###autoload
d61140e8
RS
61(defcustom tex-shell-file-name nil
62 "*If non-nil, the shell file name to run in the subshell used to run TeX."
63 :type '(choice (const :tag "None" nil)
64 string)
65 :group 'tex-run)
528415e7 66
7e1dae73 67;;;###autoload
d61140e8 68(defcustom tex-directory "."
f73741fc 69 "*Directory in which temporary files are written.
81c735c0 70You can make this `/tmp' if your TEXINPUTS has no relative directories in it
528415e7 71and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
d61140e8
RS
72`\\input' commands with relative directories."
73 :type 'directory
74 :group 'tex-file)
869bff31 75
725b7428 76;;;###autoload
d61140e8 77(defcustom tex-first-line-header-regexp nil
725b7428
RS
78 "Regexp for matching a first line which `tex-region' should include.
79If this is non-nil, it should be a regular expression string;
80if it matches the first line of the file,
d61140e8
RS
81`tex-region' always includes the first line in the TeX run."
82 :type '(choice (const :tag "None" nil)
83 regexp)
84 :group 'tex-file)
725b7428 85
f73741fc 86;;;###autoload
d61140e8 87(defcustom tex-main-file nil
f73741fc 88 "*The main TeX source file which includes this buffer's file.
be4a962d
RS
89The command `tex-file' runs TeX on the file specified by `tex-main-file'
90if the variable is non-nil."
d61140e8
RS
91 :type '(choice (const :tag "None" nil)
92 file)
93 :group 'tex-file)
f73741fc 94
7e1dae73 95;;;###autoload
d61140e8
RS
96(defcustom tex-offer-save t
97 "*If non-nil, ask about saving modified buffers before \\[tex-file] is run."
98 :type 'boolean
99 :group 'tex-file)
869bff31 100
7e1dae73 101;;;###autoload
d61140e8 102(defcustom tex-run-command "tex"
869bff31 103 "*Command used to run TeX subjob.
c3ce7bf4
RS
104TeX Mode sets `tex-command' to this string.
105See the documentation of that variable."
d61140e8
RS
106 :type 'string
107 :group 'tex-run)
869bff31 108
7e1dae73 109;;;###autoload
d61140e8 110(defcustom latex-run-command "latex"
869bff31 111 "*Command used to run LaTeX subjob.
c3ce7bf4
RS
112LaTeX Mode sets `tex-command' to this string.
113See the documentation of that variable."
d61140e8
RS
114 :type 'string
115 :group 'tex-run)
528415e7 116
bed1b0c8
RS
117;;;###autoload
118(defcustom slitex-run-command "slitex"
119 "*Command used to run SliTeX subjob.
c3ce7bf4
RS
120SliTeX Mode sets `tex-command' to this string.
121See the documentation of that variable."
bed1b0c8
RS
122 :type 'string
123 :group 'tex-run)
124
c3ce7bf4 125;;;###autoload
95a045bd 126(defcustom tex-start-options ""
9e0ad27a 127 "*TeX options to use when starting TeX.
95a045bd
SM
128These immediately precede the commands in `tex-start-commands'
129and the input file name, with no separating space and are not shell-quoted.
130If nil, TeX runs with no options. See the documentation of `tex-command'."
131 :type 'string
bed1b0c8 132 :group 'tex-run
bf247b6e 133 :version "22.1")
9e0ad27a
RS
134
135;;;###autoload
136(defcustom tex-start-commands "\\nonstopmode\\input"
137 "*TeX commands to use when starting TeX.
95a045bd
SM
138They are shell-quoted and precede the input file name, with a separating space.
139If nil, no commands are used. See the documentation of `tex-command'."
9e0ad27a
RS
140 :type '(radio (const :tag "Interactive \(nil\)" nil)
141 (const :tag "Nonstop \(\"\\nonstopmode\\input\"\)"
142 "\\nonstopmode\\input")
143 (string :tag "String at your choice"))
144 :group 'tex-run
bf247b6e 145 :version "22.1")
bed1b0c8 146
7afecb99 147(defvar latex-standard-block-names
dd459839
SM
148 '("abstract" "array" "center" "description"
149 "displaymath" "document" "enumerate" "eqnarray"
150 "eqnarray*" "equation" "figure" "figure*"
151 "flushleft" "flushright" "itemize" "letter"
152 "list" "minipage" "picture" "quotation"
153 "quote" "slide" "sloppypar" "tabbing"
154 "table" "table*" "tabular" "tabular*"
155 "thebibliography" "theindex*" "titlepage" "trivlist"
156 "verbatim" "verbatim*" "verse" "math")
528415e7
RS
157 "Standard LaTeX block names.")
158
7e1dae73 159;;;###autoload
d61140e8 160(defcustom latex-block-names nil
528415e7 161 "*User defined LaTeX block names.
7afecb99 162Combined with `latex-standard-block-names' for minibuffer completion."
d61140e8
RS
163 :type '(repeat string)
164 :group 'tex-run)
869bff31 165
7e1dae73 166;;;###autoload
d61140e8 167(defcustom tex-bibtex-command "bibtex"
528415e7 168 "*Command used by `tex-bibtex-file' to gather bibliographic data.
81c735c0 169If this string contains an asterisk (`*'), that is replaced by the file name;
d61140e8
RS
170otherwise, the file name, preceded by blank, is added at the end."
171 :type 'string
172 :group 'tex-run)
869bff31 173
7e1dae73 174;;;###autoload
d61140e8 175(defcustom tex-dvi-print-command "lpr -d"
528415e7 176 "*Command used by \\[tex-print] to print a .dvi file.
81c735c0 177If this string contains an asterisk (`*'), that is replaced by the file name;
d61140e8
RS
178otherwise, the file name, preceded by blank, is added at the end."
179 :type 'string
180 :group 'tex-view)
528415e7 181
7e1dae73 182;;;###autoload
d61140e8 183(defcustom tex-alt-dvi-print-command "lpr -d"
528415e7 184 "*Command used by \\[tex-print] with a prefix arg to print a .dvi file.
81c735c0
RS
185If this string contains an asterisk (`*'), that is replaced by the file name;
186otherwise, the file name, preceded by blank, is added at the end.
528415e7 187
81c735c0
RS
188If two printers are not enough of a choice, you can set the variable
189`tex-alt-dvi-print-command' to an expression that asks what you want;
528415e7
RS
190for example,
191
192 (setq tex-alt-dvi-print-command
193 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
194
195would tell \\[tex-print] with a prefix argument to ask you which printer to
d61140e8
RS
196use."
197 :type '(choice (string :tag "Command")
198 (sexp :tag "Expression"))
199 :group 'tex-view)
869bff31 200
7e1dae73 201;;;###autoload
dd166d5f
SM
202(defcustom tex-dvi-view-command
203 '(cond
204 ((eq window-system 'x) "xdvi")
bf247b6e 205 ((eq window-system 'w32) "yap")
dd166d5f 206 (t "dvi2tty * | cat -s"))
81c735c0 207 "*Command used by \\[tex-view] to display a `.dvi' file.
746c30e2 208If it is a string, that specifies the command directly.
81c735c0 209If this string contains an asterisk (`*'), that is replaced by the file name;
746c30e2 210otherwise, the file name, preceded by a space, is added at the end.
528415e7 211
746c30e2
RS
212If the value is a form, it is evaluated to get the command to use."
213 :type '(choice (const nil) string sexp)
d61140e8 214 :group 'tex-view)
869bff31 215
7e1dae73 216;;;###autoload
d61140e8 217(defcustom tex-show-queue-command "lpq"
528415e7 218 "*Command used by \\[tex-show-print-queue] to show the print queue.
d61140e8
RS
219Should show the queue(s) that \\[tex-print] puts jobs on."
220 :type 'string
221 :group 'tex-view)
869bff31 222
7e1dae73 223;;;###autoload
9920303f 224(defcustom tex-default-mode 'latex-mode
869bff31 225 "*Mode to enter for a new file that might be either TeX or LaTeX.
226This variable is used when it can't be determined whether the file
227is plain TeX or LaTeX or what because the file contains no commands.
d61140e8
RS
228Normally set to either `plain-tex-mode' or `latex-mode'."
229 :type 'function
230 :group 'tex)
869bff31 231
7e1dae73 232;;;###autoload
d61140e8
RS
233(defcustom tex-open-quote "``"
234 "*String inserted by typing \\[tex-insert-quote] to open a quotation."
235 :type 'string
95a045bd 236 :options '("``" "\"<" "\"`" "<<" "«")
d61140e8 237 :group 'tex)
869bff31 238
7e1dae73 239;;;###autoload
d61140e8
RS
240(defcustom tex-close-quote "''"
241 "*String inserted by typing \\[tex-insert-quote] to close a quotation."
242 :type 'string
95a045bd 243 :options '("''" "\">" "\"'" ">>" "»")
d61140e8 244 :group 'tex)
869bff31 245
528415e7
RS
246(defvar tex-last-temp-file nil
247 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
248Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
81c735c0 249tex shell terminates.")
528415e7 250
95a045bd 251(defvar tex-command "tex"
c3ce7bf4 252 "*Command to run TeX.
95a045bd 253If this string contains an asterisk \(`*'\), that is replaced by the file name;
9e0ad27a
RS
254otherwise the value of `tex-start-options', the \(shell-quoted\)
255value of `tex-start-commands', and the file name are added at the end
256with blanks as separators.
c3ce7bf4
RS
257
258In TeX, LaTeX, and SliTeX Mode this variable becomes buffer local.
259In these modes, use \\[set-variable] if you want to change it for the
260current buffer.")
869bff31 261
262(defvar tex-trailer nil
263 "String appended after the end of a region sent to TeX by \\[tex-region].")
264
265(defvar tex-start-of-header nil
898b9ac1 266 "Regular expression used by \\[tex-region] to find start of file's header.")
869bff31 267
268(defvar tex-end-of-header nil
898b9ac1 269 "Regular expression used by \\[tex-region] to find end of file's header.")
869bff31 270
271(defvar tex-shell-cd-command "cd"
272 "Command to give to shell running TeX to change directory.
81c735c0 273The value of `tex-directory' is appended to this, separated by a space.")
869bff31 274
275(defvar tex-zap-file nil
276 "Temporary file name used for text being sent as input to TeX.
277Should be a simple file name with no extension or directory specification.")
278
279(defvar tex-last-buffer-texed nil
280 "Buffer which was last TeXed.")
281
282(defvar tex-print-file nil
283 "File name that \\[tex-print] prints.
284Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
285
8a591d52
SM
286(defvar tex-mode-syntax-table
287 (let ((st (make-syntax-table)))
288 (modify-syntax-entry ?% "<" st)
289 (modify-syntax-entry ?\n ">" st)
290 (modify-syntax-entry ?\f ">" st)
291 (modify-syntax-entry ?\C-@ "w" st)
292 (modify-syntax-entry ?' "w" st)
293 (modify-syntax-entry ?@ "_" st)
294 (modify-syntax-entry ?* "_" st)
295 (modify-syntax-entry ?\t " " st)
bca7a08b
SM
296 ;; ~ is printed by TeX as a space, but it's semantics in the syntax
297 ;; of TeX is not `whitespace' (i.e. it's just like \hspace{foo}).
8a591d52
SM
298 (modify-syntax-entry ?~ "." st)
299 (modify-syntax-entry ?$ "$$" st)
300 (modify-syntax-entry ?\\ "/" st)
301 (modify-syntax-entry ?\" "." st)
302 (modify-syntax-entry ?& "." st)
303 (modify-syntax-entry ?_ "." st)
304 (modify-syntax-entry ?^ "." st)
305 st)
869bff31 306 "Syntax table used while in TeX mode.")
53c4fe47
SM
307\f
308;;;;
309;;;; Imenu support
310;;;;
869bff31 311
d6709b80 312(defcustom latex-imenu-indent-string ". "
a53c647b
RS
313 "*String to add repeated in front of nested sectional units for Imenu.
314An alternative value is \" . \", if you use a font with a narrow period."
315 :type 'string
316 :group 'tex)
317
d6709b80
SM
318(defvar latex-section-alist
319 '(("part" . 0) ("chapter" . 1)
320 ("section" . 2) ("subsection" . 3)
321 ("subsubsection" . 4)
322 ("paragraph" . 5) ("subparagraph" . 6)))
323
53c4fe47
SM
324(defvar latex-metasection-list
325 '("documentstyle" "documentclass"
326 "begin{document}" "end{document}"
327 "appendix" "frontmatter" "mainmatter" "backmatter"))
328
a5e2ae01 329(defun latex-imenu-create-index ()
53c4fe47
SM
330 "Generate an alist for imenu from a LaTeX buffer."
331 (let ((section-regexp
332 (concat "\\\\" (regexp-opt (mapcar 'car latex-section-alist) t)
333 "\\*?[ \t]*{"))
334 (metasection-regexp
335 (concat "\\\\" (regexp-opt latex-metasection-list t)))
336 i0 menu case-fold-search)
a53c647b
RS
337 (save-excursion
338 ;; Find the top-most level in this file but don't allow it to be
339 ;; any deeper than "section" (which is top-level in an article).
340 (goto-char (point-min))
341 (if (search-forward-regexp "\\\\part\\*?[ \t]*{" nil t)
342 (setq i0 0)
343 (if (search-forward-regexp "\\\\chapter\\*?[ \t]*{" nil t)
344 (setq i0 1)
345 (setq i0 2)))
346
347 ;; Look for chapters and sections.
348 (goto-char (point-min))
53c4fe47 349 (while (search-forward-regexp section-regexp nil t)
a53c647b
RS
350 (let ((start (match-beginning 0))
351 (here (point))
352 (i (cdr (assoc (buffer-substring-no-properties
353 (match-beginning 1)
354 (match-end 1))
d6709b80 355 latex-section-alist))))
a53c647b
RS
356 (backward-char 1)
357 (condition-case err
358 (progn
359 ;; Using sexps allows some use of matching {...} inside
360 ;; titles.
361 (forward-sexp 1)
d6709b80
SM
362 (push (cons (concat (apply 'concat
363 (make-list
364 (max 0 (- i i0))
365 latex-imenu-indent-string))
366 (buffer-substring-no-properties
367 here (1- (point))))
368 start)
369 menu))
a53c647b
RS
370 (error nil))))
371
372 ;; Look for included material.
373 (goto-char (point-min))
374 (while (search-forward-regexp
375 "\\\\\\(include\\|input\\|verbatiminput\\|bibliography\\)\
53c4fe47 376\[ \t]*{\\([^}\n]+\\)}"
a53c647b 377 nil t)
53c4fe47
SM
378 (push (cons (concat "<<" (buffer-substring-no-properties
379 (match-beginning 2)
380 (match-end 2))
381 (if (= (char-after (match-beginning 1)) ?b)
382 ".bbl"
383 ".tex"))
384 (match-beginning 0))
385 menu))
a53c647b
RS
386
387 ;; Look for \frontmatter, \mainmatter, \backmatter, and \appendix.
388 (goto-char (point-min))
53c4fe47
SM
389 (while (search-forward-regexp metasection-regexp nil t)
390 (push (cons "--" (match-beginning 0)) menu))
a53c647b
RS
391
392 ;; Sort in increasing buffer position order.
393 (sort menu (function (lambda (a b) (< (cdr a) (cdr b))))))))
53c4fe47
SM
394\f
395;;;;
396;;;; Outline support
397;;;;
398
399(defvar latex-outline-regexp
400 (concat "\\\\"
401 (regexp-opt (append latex-metasection-list
402 (mapcar 'car latex-section-alist)) t)))
403
404(defun latex-outline-level ()
405 (if (looking-at latex-outline-regexp)
406 (1+ (or (cdr (assoc (match-string 1) latex-section-alist)) -1))
407 1000))
408\f
409;;;;
410;;;; Font-Lock support
411;;;;
412
413;(defvar tex-font-lock-keywords
414; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
415; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
416; 2 font-lock-function-name-face)
417; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
418; 2 font-lock-constant-face)
419; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
420; ;; not be able to display those fonts.
421; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
422; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
423; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
424; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
425; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
426; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
427; 2 font-lock-function-name-face)
428; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
429; 2 font-lock-constant-face)
430; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
431; "\\\\\\([a-zA-Z@]+\\|.\\)"
432; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
433; ;; not be able to display those fonts.
434; ;; LaTeX2e: \emph{This is emphasized}.
435; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
436; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
437; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
438; 3 (if (match-beginning 2) 'bold 'italic) keep)
439; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
440; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
441; 3 (if (match-beginning 2) 'bold 'italic) keep))
442
443;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
444(defconst tex-font-lock-keywords-1
445 (eval-when-compile
446 (let* (;; Names of commands whose arg should be fontified as heading, etc.
447 (headings (regexp-opt
448 '("title" "begin" "end" "chapter" "part"
449 "section" "subsection" "subsubsection"
450 "paragraph" "subparagraph" "subsubparagraph"
7afecb99
SM
451 "newcommand" "renewcommand" "providecommand"
452 "newenvironment" "renewenvironment"
453 "newtheorem" "renewtheorem")
53c4fe47
SM
454 t))
455 (variables (regexp-opt
456 '("newcounter" "newcounter*" "setcounter" "addtocounter"
457 "setlength" "addtolength" "settowidth")
458 t))
459 (includes (regexp-opt
460 '("input" "include" "includeonly" "bibliography"
461 "epsfig" "psfig" "epsf" "nofiles" "usepackage"
15ca8de7 462 "documentstyle" "documentclass" "verbatiminput"
dd166d5f
SM
463 "includegraphics" "includegraphics*"
464 "url" "nolinkurl")
53c4fe47
SM
465 t))
466 ;; Miscellany.
467 (slash "\\\\")
15ca8de7
SM
468 (opt " *\\(\\[[^]]*\\] *\\)*")
469 ;; This would allow highlighting \newcommand\CMD but requires
470 ;; adapting subgroup numbers below.
471 ;; (arg "\\(?:{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)\\|\\\\[a-z*]+\\)"))
1598a961 472 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
53c4fe47 473 (list
b119fdd5 474 ;; font-lock-syntactic-keywords causes the \ of \end{verbatim} to be
621f893a 475 ;; highlighted as tex-verbatim face. Let's undo that.
b119fdd5
SM
476 ;; This is ugly and brittle :-( --Stef
477 '("^\\(\\\\\\)end" (1 (get-text-property (match-end 1) 'face) t))
95a045bd
SM
478 ;; display $$ math $$
479 ;; We only mark the match between $$ and $$ because the $$ delimiters
480 ;; themselves have already been marked (along with $..$) by syntactic
481 ;; fontification. Also this is done at the very beginning so as to
482 ;; interact with the other keywords in the same way as $...$ does.
483 (list "\\$\\$\\([^$]+\\)\\$\\$" 1 'tex-math-face)
53c4fe47
SM
484 ;; Heading args.
485 (list (concat slash headings "\\*?" opt arg)
bdbd9606
SM
486 ;; If ARG ends up matching too much (if the {} don't match, f.ex)
487 ;; jit-lock will do funny things: when updating the buffer
488 ;; the re-highlighting is only done locally so it will just
489 ;; match the local line, but defer-contextually will
490 ;; match more lines at a time, so ARG will end up matching
491 ;; a lot more, which might suddenly include a comment
492 ;; so you get things highlighted bold when you type them
493 ;; but they get turned back to normal a little while later
494 ;; because "there's already a face there".
495 ;; Using `keep' works around this un-intuitive behavior as well
15ca8de7
SM
496 ;; as improves the behavior in the very rare case where you do
497 ;; have a comment in ARG.
bdbd9606 498 3 'font-lock-function-name-face 'keep)
7afecb99
SM
499 (list (concat slash "\\(?:provide\\|\\(?:re\\)?new\\)command\\** *\\(\\\\[A-Za-z@]+\\)")
500 1 'font-lock-function-name-face 'keep)
53c4fe47 501 ;; Variable args.
15ca8de7 502 (list (concat slash variables " *" arg) 2 'font-lock-variable-name-face)
53c4fe47
SM
503 ;; Include args.
504 (list (concat slash includes opt arg) 3 'font-lock-builtin-face)
505 ;; Definitions. I think.
15ca8de7 506 '("^[ \t]*\\\\def *\\\\\\(\\(\\w\\|@\\)+\\)"
bdbd9606 507 1 font-lock-function-name-face))))
53c4fe47
SM
508 "Subdued expressions to highlight in TeX modes.")
509
1f4cc034
SM
510(defun tex-font-lock-append-prop (prop)
511 (unless (memq (get-text-property (match-end 1) 'face)
621f893a 512 '(font-lock-comment-face tex-verbatim))
1f4cc034
SM
513 prop))
514
53c4fe47
SM
515(defconst tex-font-lock-keywords-2
516 (append tex-font-lock-keywords-1
517 (eval-when-compile
518 (let* (;;
519 ;; Names of commands whose arg should be fontified with fonts.
1598a961 520 (bold (regexp-opt '("textbf" "textsc" "textup"
53c4fe47 521 "boldsymbol" "pmb") t))
1598a961 522 (italic (regexp-opt '("textit" "textsl" "emph") t))
a3d80d4a
SM
523 ;; FIXME: unimplemented yet.
524 ;; (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
53c4fe47
SM
525 ;;
526 ;; Names of commands whose arg should be fontified as a citation.
527 (citations (regexp-opt
528 '("label" "ref" "pageref" "vref" "eqref"
15ca8de7 529 "cite" "nocite" "index" "glossary" "bibitem"
1598a961
SM
530 ;; These are text, rather than citations.
531 ;; "caption" "footnote" "footnotemark" "footnotetext"
532 )
53c4fe47
SM
533 t))
534 ;;
535 ;; Names of commands that should be fontified.
1b741d9e
AS
536 (specials-1 (regexp-opt '("\\" "\\*") t)) ;; "-"
537 (specials-2 (regexp-opt
538 '("linebreak" "nolinebreak" "pagebreak" "nopagebreak"
539 "newline" "newpage" "clearpage" "cleardoublepage"
540 "displaybreak" "allowdisplaybreaks"
541 "enlargethispage") t))
53c4fe47
SM
542 (general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
543 ;;
544 ;; Miscellany.
545 (slash "\\\\")
15ca8de7 546 (opt " *\\(\\[[^]]*\\] *\\)*")
7afecb99 547 (args "\\(\\(?:[^{}&\\]+\\|\\\\.\\|{[^}]*}\\)+\\)")
1598a961 548 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
53c4fe47
SM
549 (list
550 ;;
551 ;; Citation args.
552 (list (concat slash citations opt arg) 3 'font-lock-constant-face)
553 ;;
15ca8de7 554 ;; Text between `` quotes ''.
95a045bd 555 (cons (concat (regexp-opt `("``" "\"<" "\"`" "<<" "«") t)
7abc9add 556 "[^'\">{]+" ;a bit pessimistic
95a045bd 557 (regexp-opt `("''" "\">" "\"'" ">>" "»") t))
15ca8de7
SM
558 'font-lock-string-face)
559 ;;
53c4fe47 560 ;; Command names, special and general.
1b741d9e
AS
561 (cons (concat slash specials-1) 'font-lock-warning-face)
562 (list (concat "\\(" slash specials-2 "\\)\\([^a-zA-Z@]\\|\\'\\)")
563 1 'font-lock-warning-face)
53c4fe47
SM
564 (concat slash general)
565 ;;
566 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
567 ;; since we might not be able to display those fonts.
1f4cc034
SM
568 (list (concat slash bold " *" arg) 2
569 '(tex-font-lock-append-prop 'bold) 'append)
570 (list (concat slash italic " *" arg) 2
571 '(tex-font-lock-append-prop 'italic) 'append)
1598a961 572 ;; (list (concat slash type arg) 2 '(quote bold-italic) 'append)
53c4fe47
SM
573 ;;
574 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
7afecb99 575 (list (concat "\\\\\\(em\\|it\\|sl\\)\\>" args)
1f4cc034 576 2 '(tex-font-lock-append-prop 'italic) 'append)
7afecb99
SM
577 ;; This is separate from the previous one because of cases like
578 ;; {\em foo {\bf bar} bla} where both match.
21ea3649 579 (list (concat "\\\\\\(bf\\(?:series\\)?\\)\\>" args)
9bf211ad 580 3 '(tex-font-lock-append-prop 'bold) 'append)))))
53c4fe47
SM
581 "Gaudy expressions to highlight in TeX modes.")
582
7afecb99
SM
583(defun tex-font-lock-suscript (pos)
584 (unless (or (memq (get-text-property pos 'face)
585 '(font-lock-constant-face font-lock-builtin-face
621f893a 586 font-lock-comment-face tex-verbatim))
7afecb99
SM
587 ;; Check for backslash quoting
588 (let ((odd nil)
589 (pos pos))
590 (while (eq (char-before pos) ?\\)
591 (setq pos (1- pos) odd (not odd)))
592 odd))
593 (if (eq (char-after pos) ?_)
594 '(face subscript display (raise -0.3))
595 '(face superscript display (raise +0.3)))))
596
597(defconst tex-font-lock-keywords-3
598 (append tex-font-lock-keywords-2
599 (eval-when-compile
600 (let ((general "\\([a-zA-Z@]+\\|[^ \t\n]\\)")
601 (slash "\\\\")
602 ;; This is not the same regexp as before: it has a `+' removed.
603 ;; The + makes the matching faster in the above cases (where we can
604 ;; exit as soon as the match fails) but would make this matching
605 ;; degenerate to nasty complexity (because we try to match the
606 ;; closing brace, which forces trying all matching combinations).
607 (arg "{\\(?:[^{}\\]\\|\\\\.\\|{[^}]*}\\)*"))
6ecedb40 608 `((,(concat "[_^] *\\([^\n\\{}#]\\|" slash general "\\|#[0-9]\\|" arg "}\\)")
7afecb99
SM
609 (1 (tex-font-lock-suscript (match-beginning 0))
610 append))))))
611 "Experimental expressions to highlight in TeX modes.")
612
53c4fe47
SM
613(defvar tex-font-lock-keywords tex-font-lock-keywords-1
614 "Default expressions to highlight in TeX modes.")
0fb4f245 615
7afecb99
SM
616(defvar tex-verbatim-environments
617 '("verbatim" "verbatim*"))
618
619(defvar tex-font-lock-syntactic-keywords
620 (let ((verbs (regexp-opt tex-verbatim-environments t)))
621 `((,(concat "^\\\\begin *{" verbs "}.*\\(\n\\)") 2 "|")
1f4cc034
SM
622 ;; Technically, we'd like to put the "|" property on the \n preceding
623 ;; the \end, but this would have 2 disadvantages:
624 ;; 1 - it's wrong if the verbatim env is empty (the same \n is used to
625 ;; start and end the fenced-string).
626 ;; 2 - font-lock considers the preceding \n as being part of the
627 ;; preceding line, so things gets screwed every time the previous
628 ;; line is re-font-locked on its own.
b119fdd5
SM
629 ;; There's a hack in tex-font-lock-keywords-1 to remove the verbatim
630 ;; face from the \ but C-M-f still jumps to the wrong spot :-( --Stef
1f4cc034 631 (,(concat "^\\(\\\\\\)end *{" verbs "}\\(.?\\)") (1 "|") (3 "<"))
7afecb99
SM
632 ;; ("^\\(\\\\\\)begin *{comment}" 1 "< b")
633 ;; ("^\\\\end *{comment}.*\\(\n\\)" 1 "> b")
3307a4fa
SM
634 ("\\\\verb\\**\\([^a-z@*]\\)"
635 ;; Do it last, because it uses syntax-ppss which needs the
636 ;; syntax-table properties of previous entries.
637 1 (tex-font-lock-verb (match-end 1))))))
7afecb99
SM
638
639(defun tex-font-lock-unfontify-region (beg end)
640 (font-lock-default-unfontify-region beg end)
641 (while (< beg end)
642 (let ((next (next-single-property-change beg 'display nil end))
643 (prop (get-text-property beg 'display)))
644 (if (and (eq (car-safe prop) 'raise)
645 (member (car-safe (cdr prop)) '(-0.3 +0.3))
646 (null (cddr prop)))
647 (put-text-property beg next 'display nil))
648 (setq beg next))))
649
650(defface superscript
651 '((t :height 0.8)) ;; :raise 0.3
18a8c773
LK
652 "Face used for superscripts."
653 :group 'tex)
7afecb99
SM
654(defface subscript
655 '((t :height 0.8)) ;; :raise -0.3
18a8c773
LK
656 "Face used for subscripts."
657 :group 'tex)
bdbd9606 658
ad49d9d6 659(defface tex-math
bdbd9606 660 '((t :inherit font-lock-string-face))
18a8c773
LK
661 "Face used to highlight TeX math expressions."
662 :group 'tex)
ad49d9d6
MB
663;; backward-compatibility alias
664(put 'tex-math-face 'face-alias 'tex-math)
665(defvar tex-math-face 'tex-math)
666
667(defface tex-verbatim
7afecb99
SM
668 ;; '((t :inherit font-lock-string-face))
669 '((t :family "courier"))
18a8c773
LK
670 "Face used to highlight TeX verbatim environments."
671 :group 'tex)
ad49d9d6
MB
672;; backward-compatibility alias
673(put 'tex-verbatim-face 'face-alias 'tex-verbatim)
674(defvar tex-verbatim-face 'tex-verbatim)
bdbd9606 675
3307a4fa
SM
676(defun tex-font-lock-verb (end)
677 "Place syntax-table properties on the \verb construct.
678END is the position of the first delimiter after \verb."
679 (unless (nth 8 (syntax-ppss end))
680 ;; Do nothing if the \verb construct is itself inside a comment or
681 ;; verbatim env.
682 (save-excursion
683 ;; Let's find the end and mark it.
684 ;; We used to do it inside tex-font-lock-syntactic-face-function, but
685 ;; this leads to funny effects when jumping to the end of the buffer,
686 ;; because font-lock applies font-lock-syntactic-keywords to the whole
687 ;; preceding text but font-lock-syntactic-face-function only to the
688 ;; actually displayed text.
689 (goto-char end)
690 (let ((char (char-before)))
691 (skip-chars-forward (string ?^ char)) ;; Use `end' ?
692 (when (eq (char-syntax (preceding-char)) ?/)
693 (put-text-property (1- (point)) (point) 'syntax-table '(1)))
694 (unless (eobp)
695 (put-text-property (point) (1+ (point)) 'syntax-table '(7))
696 ;; Cause the rest of the buffer to be re-fontified.
697 ;; (remove-text-properties (1+ (point)) (point-max) '(fontified))
698 )))
699 "\""))
700
bdbd9606
SM
701;; Use string syntax but math face for $...$.
702(defun tex-font-lock-syntactic-face-function (state)
7afecb99
SM
703 (let ((char (nth 3 state)))
704 (cond
705 ((not char) font-lock-comment-face)
706 ((eq char ?$) tex-math-face)
3307a4fa 707 (t tex-verbatim-face))))
bdbd9606 708
53c4fe47 709\f
869bff31 710(defun tex-define-common-keys (keymap)
81c735c0 711 "Define the keys that we want defined both in TeX mode and in the TeX shell."
869bff31 712 (define-key keymap "\C-c\C-k" 'tex-kill-job)
713 (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer)
714 (define-key keymap "\C-c\C-q" 'tex-show-print-queue)
715 (define-key keymap "\C-c\C-p" 'tex-print)
716 (define-key keymap "\C-c\C-v" 'tex-view)
62a24cb5
RS
717
718 (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
719
bdbd9606
SM
720 (define-key keymap [menu-bar tex tex-kill-job]
721 '(menu-item "Tex Kill" tex-kill-job :enable (tex-shell-running)))
cf6d6e8a 722 (define-key keymap [menu-bar tex tex-recenter-output-buffer]
bdbd9606
SM
723 '(menu-item "Tex Recenter" tex-recenter-output-buffer
724 :enable (get-buffer "*tex-shell*")))
62a24cb5
RS
725 (define-key keymap [menu-bar tex tex-show-print-queue]
726 '("Show Print Queue" . tex-show-print-queue))
cf6d6e8a 727 (define-key keymap [menu-bar tex tex-alt-print]
bdbd9606
SM
728 '(menu-item "Tex Print (alt printer)" tex-alt-print
729 :enable (stringp tex-print-file)))
730 (define-key keymap [menu-bar tex tex-print]
731 '(menu-item "Tex Print" tex-print :enable (stringp tex-print-file)))
732 (define-key keymap [menu-bar tex tex-view]
733 '(menu-item "Tex View" tex-view :enable (stringp tex-print-file))))
734
735(defvar tex-mode-map
736 (let ((map (make-sparse-keymap)))
15ca8de7 737 (set-keymap-parent map text-mode-map)
bdbd9606
SM
738 (tex-define-common-keys map)
739 (define-key map "\"" 'tex-insert-quote)
740 (define-key map "(" 'skeleton-pair-insert-maybe)
741 (define-key map "{" 'skeleton-pair-insert-maybe)
742 (define-key map "[" 'skeleton-pair-insert-maybe)
743 (define-key map "$" 'skeleton-pair-insert-maybe)
744 (define-key map "\n" 'tex-terminate-paragraph)
745 (define-key map "\M-\r" 'latex-insert-item)
746 (define-key map "\C-c}" 'up-list)
747 (define-key map "\C-c{" 'tex-insert-braces)
748 (define-key map "\C-c\C-r" 'tex-region)
749 (define-key map "\C-c\C-b" 'tex-buffer)
750 (define-key map "\C-c\C-f" 'tex-file)
75035a80 751 (define-key map "\C-c\C-c" 'tex-compile)
bdbd9606 752 (define-key map "\C-c\C-i" 'tex-bibtex-file)
7afecb99
SM
753 (define-key map "\C-c\C-o" 'latex-insert-block)
754 (define-key map "\C-c\C-e" 'latex-close-block)
bdbd9606
SM
755 (define-key map "\C-c\C-u" 'tex-goto-last-unclosed-latex-block)
756 (define-key map "\C-c\C-m" 'tex-feed-input)
757 (define-key map [(control return)] 'tex-feed-input)
758 (define-key map [menu-bar tex tex-bibtex-file]
759 '("BibTeX File" . tex-bibtex-file))
760 (define-key map [menu-bar tex tex-validate-region]
761 '(menu-item "Validate Region" tex-validate-region :enable mark-active))
762 (define-key map [menu-bar tex tex-validate-buffer]
763 '("Validate Buffer" . tex-validate-buffer))
764 (define-key map [menu-bar tex tex-region]
765 '(menu-item "TeX Region" tex-region :enable mark-active))
766 (define-key map [menu-bar tex tex-buffer]
767 '("TeX Buffer" . tex-buffer))
768 (define-key map [menu-bar tex tex-file] '("TeX File" . tex-file))
769 map)
15ca8de7
SM
770 "Keymap shared by TeX modes.")
771
772(defvar latex-mode-map
773 (let ((map (make-sparse-keymap)))
774 (set-keymap-parent map tex-mode-map)
a3d80d4a 775 (define-key map "\C-c\C-s" 'latex-split-block)
15ca8de7
SM
776 map)
777 "Keymap for `latex-mode'. See also `tex-mode-map'.")
778
779(defvar plain-tex-mode-map
780 (let ((map (make-sparse-keymap)))
781 (set-keymap-parent map tex-mode-map)
782 map)
783 "Keymap for `plain-tex-mode'. See also `tex-mode-map'.")
cf6d6e8a 784
d6709b80
SM
785(defvar tex-shell-map
786 (let ((m (make-sparse-keymap)))
787 (set-keymap-parent m shell-mode-map)
788 (tex-define-common-keys m)
789 m)
81c735c0 790 "Keymap for the TeX shell.
dca5ea48 791Inherits `shell-mode-map' with a few additions.")
869bff31 792
6da9bbd6
RS
793(defvar tex-face-alist
794 '((bold . "{\\bf ")
795 (italic . "{\\it ")
796 (bold-italic . "{\\bi ") ; hypothetical
797 (underline . "\\underline{")
798 (default . "{\\rm "))
799 "Alist of face and TeX font name for facemenu.")
800
801(defvar tex-latex-face-alist
802 `((italic . "{\\em ")
803 ,@tex-face-alist)
804 "Alist of face and LaTeX font name for facemenu.")
805
15ca8de7
SM
806;; This would be a lot simpler if we just used a regexp search,
807;; but then it would be too slow.
a3d80d4a 808(defun tex-guess-mode ()
d6709b80 809 (let ((mode tex-default-mode) slash comment)
869bff31 810 (save-excursion
811 (goto-char (point-min))
812 (while (and (setq slash (search-forward "\\" nil t))
813 (setq comment (let ((search-end (point)))
814 (save-excursion
815 (beginning-of-line)
816 (search-forward "%" search-end t))))))
bdbd9606
SM
817 (when (and slash (not comment))
818 (setq mode
819 (if (looking-at
820 (eval-when-compile
821 (concat
822 (regexp-opt '("documentstyle" "documentclass"
95a045bd 823 "begin" "subsection" "section"
bca7a08b 824 "part" "chapter" "newcommand"
29a47b89 825 "renewcommand" "RequirePackage") 'words)
bdbd9606 826 "\\|NeedsTeXFormat{LaTeX")))
dd166d5f
SM
827 (if (and (looking-at
828 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
829 ;; SliTeX is almost never used any more nowadays.
830 (tex-executable-exists-p slitex-run-command))
bdbd9606
SM
831 'slitex-mode
832 'latex-mode)
833 'plain-tex-mode))))
d6709b80 834 (funcall mode)))
e4c8c838 835
a3d80d4a
SM
836;; `tex-mode' plays two roles: it's the parent of several sub-modes
837;; but it's also the function that chooses between those submodes.
838;; To tell the difference between those two cases where the function
839;; might be called, we check `delay-mode-hooks'.
a3d80d4a
SM
840(define-derived-mode tex-mode text-mode "generic-TeX"
841 (tex-common-initialization))
bca7a08b
SM
842;; We now move the function and define it again. This gives a warning
843;; in the byte-compiler :-( but it's difficult to avoid because
844;; `define-derived-mode' will necessarily define the function once
845;; and we need to define it a second time for `autoload' to get the
846;; proper docstring.
847(defalias 'tex-mode-internal (symbol-function 'tex-mode))
848;;;###autoload
849(defun tex-mode ()
850 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
a3d80d4a
SM
851Tries to determine (by looking at the beginning of the file) whether
852this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
853`latex-mode', or `slitex-mode', respectively. If it cannot be determined,
854such as if there are no commands in the file, the value of `tex-default-mode'
855says which mode to use."
bca7a08b
SM
856 (interactive)
857 (if delay-mode-hooks
858 ;; We're called from one of the children already.
859 (tex-mode-internal)
860 (tex-guess-mode)))
a3d80d4a 861
1639cc2e
DK
862;; The following three autoloaded aliases appear to conflict with
863;; AUCTeX. However, even though AUCTeX uses the mixed case variants
864;; for all mode relevant variables and hooks, the invocation function
865;; and setting of `major-mode' themselves need to be lowercase for
866;; AUCTeX to provide a fully functional user-level replacement. So
867;; these aliases should remain as they are, in particular since AUCTeX
868;; users are likely to use them.
869
6503cec3 870;;;###autoload
31e1d920 871(defalias 'TeX-mode 'tex-mode)
6503cec3 872;;;###autoload
c3ce7bf4
RS
873(defalias 'plain-TeX-mode 'plain-tex-mode)
874;;;###autoload
31e1d920 875(defalias 'LaTeX-mode 'latex-mode)
869bff31 876
7229064d 877;;;###autoload
a3d80d4a 878(define-derived-mode plain-tex-mode tex-mode "TeX"
869bff31 879 "Major mode for editing files of input for plain TeX.
880Makes $ and } display the characters they match.
881Makes \" insert `` when it seems to be the beginning of a quotation,
882and '' when it appears to be the end; it inserts \" only after a \\.
883
884Use \\[tex-region] to run TeX on the current region, plus a \"header\"
885copied from the top of the file (containing macro definitions, etc.),
886running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
887\\[tex-file] saves the buffer and then processes the file.
888\\[tex-print] prints the .dvi file made by any of these.
889\\[tex-view] previews the .dvi file made by any of these.
890\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
891
e6b0b773 892Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 893mismatched $'s or braces.
894
895Special commands:
15ca8de7 896\\{plain-tex-mode-map}
869bff31 897
898Mode variables:
899tex-run-command
900 Command string used by \\[tex-region] or \\[tex-buffer].
901tex-directory
902 Directory in which to create temporary files for TeX jobs
903 run by \\[tex-region] or \\[tex-buffer].
904tex-dvi-print-command
905 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
906tex-alt-dvi-print-command
907 Alternative command string used by \\[tex-print] (when given a prefix
908 argument) to print a .dvi file.
869bff31 909tex-dvi-view-command
910 Command string used by \\[tex-view] to preview a .dvi file.
911tex-show-queue-command
912 Command string used by \\[tex-show-print-queue] to show the print
913 queue that \\[tex-print] put your job on.
914
81c735c0
RS
915Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
916`tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
917special subshell is initiated, the hook `tex-shell-hook' is run."
a3d80d4a
SM
918 (set (make-local-variable 'tex-command) tex-run-command)
919 (set (make-local-variable 'tex-start-of-header) "%\\*\\*start of header")
920 (set (make-local-variable 'tex-end-of-header) "%\\*\\*end of header")
921 (set (make-local-variable 'tex-trailer) "\\bye\n"))
869bff31 922
7229064d 923;;;###autoload
a3d80d4a 924(define-derived-mode latex-mode tex-mode "LaTeX"
869bff31 925 "Major mode for editing files of input for LaTeX.
926Makes $ and } display the characters they match.
927Makes \" insert `` when it seems to be the beginning of a quotation,
928and '' when it appears to be the end; it inserts \" only after a \\.
929
930Use \\[tex-region] to run LaTeX on the current region, plus the preamble
931copied from the top of the file (containing \\documentstyle, etc.),
932running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
933\\[tex-file] saves the buffer and then processes the file.
934\\[tex-print] prints the .dvi file made by any of these.
935\\[tex-view] previews the .dvi file made by any of these.
936\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
937
e6b0b773 938Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 939mismatched $'s or braces.
940
941Special commands:
15ca8de7 942\\{latex-mode-map}
869bff31 943
944Mode variables:
945latex-run-command
946 Command string used by \\[tex-region] or \\[tex-buffer].
947tex-directory
948 Directory in which to create temporary files for LaTeX jobs
949 run by \\[tex-region] or \\[tex-buffer].
950tex-dvi-print-command
951 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
952tex-alt-dvi-print-command
953 Alternative command string used by \\[tex-print] (when given a prefix
954 argument) to print a .dvi file.
869bff31 955tex-dvi-view-command
956 Command string used by \\[tex-view] to preview a .dvi file.
957tex-show-queue-command
958 Command string used by \\[tex-show-print-queue] to show the print
959 queue that \\[tex-print] put your job on.
960
bed1b0c8 961Entering Latex mode runs the hook `text-mode-hook', then
81c735c0
RS
962`tex-mode-hook', and finally `latex-mode-hook'. When the special
963subshell is initiated, `tex-shell-hook' is run."
a3d80d4a
SM
964 (set (make-local-variable 'tex-command) latex-run-command)
965 (set (make-local-variable 'tex-start-of-header)
966 "\\\\document\\(style\\|class\\)")
967 (set (make-local-variable 'tex-end-of-header) "\\\\begin\\s-*{document}")
d9cbee57 968 (set (make-local-variable 'tex-trailer) "\\end{document}\n")
ab2c9f54
RS
969 ;; A line containing just $$ is treated as a paragraph separator.
970 ;; A line starting with $$ starts a paragraph,
971 ;; but does not separate paragraphs if it has more stuff on it.
d6709b80 972 (setq paragraph-start
a3d80d4a 973 (concat "[ \t]*\\(\\$\\$\\|"
d6709b80
SM
974 "\\\\[][]\\|"
975 "\\\\" (regexp-opt (append
976 (mapcar 'car latex-section-alist)
977 '("begin" "label" "end"
978 "item" "bibitem" "newline" "noindent"
979 "newpage" "footnote" "marginpar"
980 "parbox" "caption")) t)
981 "\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t)
dd459839 982 "\\>\\)"))
d6709b80 983 (setq paragraph-separate
dd459839 984 (concat "[\f%]\\|[ \t]*\\($\\|"
d6709b80
SM
985 "\\\\[][]\\|"
986 "\\\\" (regexp-opt (append
987 (mapcar 'car latex-section-alist)
988 '("begin" "label" "end" )) t)
989 "\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
990 "noindent" "newpage" "footnote"
991 "marginpar" "parbox" "caption"))
dd459839
SM
992 "\\|\\$\\$\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
993 "\\>\\)[ \t]*\\($\\|%\\)\\)"))
d6709b80
SM
994 (set (make-local-variable 'imenu-create-index-function)
995 'latex-imenu-create-index)
996 (set (make-local-variable 'tex-face-alist) tex-latex-face-alist)
95a045bd 997 (add-hook 'fill-nobreak-predicate 'latex-fill-nobreak-predicate nil t)
ea590e1c 998 (set (make-local-variable 'indent-line-function) 'latex-indent)
dd459839 999 (set (make-local-variable 'fill-indent-according-to-mode) t)
d6709b80
SM
1000 (set (make-local-variable 'outline-regexp) latex-outline-regexp)
1001 (set (make-local-variable 'outline-level) 'latex-outline-level)
53c4fe47 1002 (set (make-local-variable 'forward-sexp-function) 'latex-forward-sexp)
a3d80d4a 1003 (set (make-local-variable 'skeleton-end-hook) nil))
869bff31 1004
bd2f2323 1005;;;###autoload
d6709b80 1006(define-derived-mode slitex-mode latex-mode "SliTeX"
869bff31 1007 "Major mode for editing files of input for SliTeX.
1008Makes $ and } display the characters they match.
1009Makes \" insert `` when it seems to be the beginning of a quotation,
1010and '' when it appears to be the end; it inserts \" only after a \\.
1011
1012Use \\[tex-region] to run SliTeX on the current region, plus the preamble
1013copied from the top of the file (containing \\documentstyle, etc.),
1014running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
1015\\[tex-file] saves the buffer and then processes the file.
1016\\[tex-print] prints the .dvi file made by any of these.
1017\\[tex-view] previews the .dvi file made by any of these.
1018\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1019
e6b0b773 1020Use \\[tex-validate-buffer] to check buffer for paragraphs containing
869bff31 1021mismatched $'s or braces.
1022
1023Special commands:
15ca8de7 1024\\{slitex-mode-map}
869bff31 1025
1026Mode variables:
1027slitex-run-command
1028 Command string used by \\[tex-region] or \\[tex-buffer].
1029tex-directory
1030 Directory in which to create temporary files for SliTeX jobs
1031 run by \\[tex-region] or \\[tex-buffer].
1032tex-dvi-print-command
1033 Command string used by \\[tex-print] to print a .dvi file.
528415e7
RS
1034tex-alt-dvi-print-command
1035 Alternative command string used by \\[tex-print] (when given a prefix
1036 argument) to print a .dvi file.
869bff31 1037tex-dvi-view-command
1038 Command string used by \\[tex-view] to preview a .dvi file.
1039tex-show-queue-command
1040 Command string used by \\[tex-show-print-queue] to show the print
1041 queue that \\[tex-print] put your job on.
1042
81c735c0
RS
1043Entering SliTeX mode runs the hook `text-mode-hook', then the hook
1044`tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
1045`slitex-mode-hook'. When the special subshell is initiated, the hook
1046`tex-shell-hook' is run."
869bff31 1047 (setq tex-command slitex-run-command)
d6709b80 1048 (setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
869bff31 1049
1050(defun tex-common-initialization ()
822eddf4 1051 ;; Regexp isearch should accept newline and formfeed as whitespace.
d6709b80 1052 (set (make-local-variable 'search-whitespace-regexp) "[ \t\r\n\f]+")
64db2461 1053 ;; A line containing just $$ is treated as a paragraph separator.
d6709b80
SM
1054 (set (make-local-variable 'paragraph-start)
1055 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
ab2c9f54
RS
1056 ;; A line starting with $$ starts a paragraph,
1057 ;; but does not separate paragraphs if it has more stuff on it.
d6709b80
SM
1058 (set (make-local-variable 'paragraph-separate)
1059 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
1060 (set (make-local-variable 'comment-start) "%")
1061 (set (make-local-variable 'comment-add) 1)
1062 (set (make-local-variable 'comment-start-skip)
5ae0d697 1063 "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
d6709b80
SM
1064 (set (make-local-variable 'parse-sexp-ignore-comments) t)
1065 (set (make-local-variable 'compare-windows-whitespace)
1066 'tex-categorize-whitespace)
1067 (set (make-local-variable 'facemenu-add-face-function)
1068 (lambda (face end)
6ecedb40
SM
1069 (or (cdr (assq face tex-face-alist))
1070 (error "Face %s not configured for %s mode" face mode-name))))
d6709b80
SM
1071 (set (make-local-variable 'facemenu-end-add-face) "}")
1072 (set (make-local-variable 'facemenu-remove-face-function) t)
1073 (set (make-local-variable 'font-lock-defaults)
7afecb99
SM
1074 '((tex-font-lock-keywords tex-font-lock-keywords-1
1075 tex-font-lock-keywords-2 tex-font-lock-keywords-3)
d6709b80
SM
1076 nil nil ((?$ . "\"")) nil
1077 ;; Who ever uses that anyway ???
bdbd9606
SM
1078 (font-lock-mark-block-function . mark-paragraph)
1079 (font-lock-syntactic-face-function
7afecb99
SM
1080 . tex-font-lock-syntactic-face-function)
1081 (font-lock-unfontify-region-function
1082 . tex-font-lock-unfontify-region)
1083 (font-lock-syntactic-keywords
1084 . tex-font-lock-syntactic-keywords)
1085 (parse-sexp-lookup-properties . t)))
95a045bd
SM
1086 ;; TABs in verbatim environments don't do what you think.
1087 (set (make-local-variable 'indent-tabs-mode) nil)
7afecb99 1088 ;; Other vars that should be buffer-local.
869bff31 1089 (make-local-variable 'tex-command)
1090 (make-local-variable 'tex-start-of-header)
1091 (make-local-variable 'tex-end-of-header)
1092 (make-local-variable 'tex-trailer))
1093
869bff31 1094(defun tex-categorize-whitespace (backward-limit)
1095 ;; compare-windows-whitespace is set to this.
1096 ;; This is basically a finite-state machine.
1097 ;; Returns a symbol telling how TeX would treat
1098 ;; the whitespace we are looking at: null, space, or par.
1099 (let ((category 'null)
1100 (not-finished t))
1101 (skip-chars-backward " \t\n\f" backward-limit)
1102 (while not-finished
1103 (cond ((looking-at "[ \t]+")
1104 (goto-char (match-end 0))
2be5fefb 1105 (if (eq category 'null)
869bff31 1106 (setq category 'space)))
1107 ((looking-at "\n")
2be5fefb 1108 (cond ((eq category 'newline)
869bff31 1109 (setq category 'par)
1110 (setq not-finished nil))
1111 (t
1112 (setq category 'newline) ;a strictly internal state
1113 (goto-char (match-end 0)))))
1114 ((looking-at "\f+")
1115 (setq category 'par)
1116 (setq not-finished nil))
1117 (t
1118 (setq not-finished nil))))
1119 (skip-chars-forward " \t\n\f")
2be5fefb 1120 (if (eq category 'newline)
869bff31 1121 'space ;TeX doesn't distinguish
1122 category)))
1123
1124(defun tex-insert-quote (arg)
1125 "Insert the appropriate quote marks for TeX.
08348502
RS
1126Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
1127\(normally '') depending on the context. With prefix argument, always
869bff31 1128inserts \" characters."
528415e7 1129 (interactive "*P")
95a045bd 1130 (if (or arg (memq (char-syntax (preceding-char)) '(?/ ?\\))
014e29b9 1131 (eq (get-text-property (point) 'face) 'tex-verbatim)
95a045bd
SM
1132 (save-excursion
1133 (backward-char (length tex-open-quote))
1134 (when (or (looking-at (regexp-quote tex-open-quote))
1135 (looking-at (regexp-quote tex-close-quote)))
1136 (delete-char (length tex-open-quote))
1137 t)))
869bff31 1138 (self-insert-command (prefix-numeric-value arg))
d1218e3e 1139 (insert (if (memq (char-syntax (preceding-char)) '(?\( ?> ?\s))
95a045bd 1140 tex-open-quote tex-close-quote))))
869bff31 1141
e6b0b773
MR
1142(defun tex-validate-buffer ()
1143 "Check current buffer for paragraphs containing mismatched braces or $s.
bbd93e41 1144Their positions are recorded in the buffer `*Occur*'.
e6b0b773
MR
1145To find a particular invalidity from `*Occur*', switch to that buffer
1146and type C-c C-c or click with mouse-2
1147on the line for the invalidity you want to see."
869bff31 1148 (interactive)
bbd93e41
RS
1149 (let ((buffer (current-buffer))
1150 (prevpos (point-min))
e6b0b773
MR
1151 (linenum nil)
1152 (num-matches 0))
bbd93e41
RS
1153 (with-output-to-temp-buffer "*Occur*"
1154 (princ "Mismatches:\n")
a3d80d4a 1155 (with-current-buffer standard-output
bbd93e41 1156 (occur-mode)
52ab062c
CW
1157 ;; This won't actually work...Really, this whole thing should
1158 ;; be rewritten instead of being a hack on top of occur.
1159 (setq occur-revert-arguments (list nil 0 (list buffer))))
bbd93e41
RS
1160 (save-excursion
1161 (goto-char (point-max))
52ab062c 1162 (while (and (not (bobp)))
710a0f53
KH
1163 (let ((end (point))
1164 prev-end)
bbd93e41 1165 ;; Scan the previous paragraph for invalidities.
710a0f53
KH
1166 (if (search-backward "\n\n" nil t)
1167 (progn
1168 (setq prev-end (point))
1169 (forward-char 2))
1170 (goto-char (setq prev-end (point-min))))
869bff31 1171 (or (tex-validate-region (point) end)
a3d80d4a 1172 (let* ((end (line-beginning-position 2))
bbd93e41
RS
1173 start tem)
1174 (beginning-of-line)
1175 (setq start (point))
1176 ;; Keep track of line number as we scan,
1177 ;; in a cumulative fashion.
1178 (if linenum
1179 (setq linenum (- linenum (count-lines prevpos (point))))
1180 (setq linenum (1+ (count-lines 1 start))))
1181 (setq prevpos (point))
bed1b0c8 1182 ;; Mention this mismatch in *Occur*.
bbd93e41 1183 ;; Since we scan from end of buffer to beginning,
e6b0b773 1184 ;; add each mismatch at the beginning of *Occur*.
bbd93e41
RS
1185 (save-excursion
1186 (setq tem (point-marker))
1187 (set-buffer standard-output)
1188 (goto-char (point-min))
1189 ;; Skip "Mismatches:" header line.
1190 (forward-line 1)
e6b0b773 1191 (setq num-matches (1+ num-matches))
bbd93e41 1192 (insert-buffer-substring buffer start end)
e6b0b773
MR
1193 (let (text-beg (text-end (point-marker)))
1194 (forward-char (- start end))
1195 (setq text-beg (point-marker))
1196 (insert (format "%3d: " linenum))
a865de85
EZ
1197 (add-text-properties
1198 text-beg (- text-end 1)
1199 '(mouse-face highlight
1200 help-echo "mouse-2: go to this invalidity"))
1598a961 1201 (put-text-property text-beg (- text-end 1)
52ab062c 1202 'occur-target tem)))))
710a0f53 1203 (goto-char prev-end))))
bdbd9606 1204 (with-current-buffer standard-output
003274a0
JPW
1205 (let ((no-matches (zerop num-matches)))
1206 (if no-matches
1207 (insert "None!\n"))
1208 (if (interactive-p)
f04232c3
JPW
1209 (message (cond (no-matches "No mismatches found")
1210 ((= num-matches 1) "1 mismatch found")
1211 (t "%d mismatches found"))
1212 num-matches)))))))
869bff31 1213
1214(defun tex-validate-region (start end)
1215 "Check for mismatched braces or $'s in region.
1216Returns t if no mismatches. Returns nil and moves point to suspect
1217area if a mismatch is found."
1218 (interactive "r")
1219 (let ((failure-point nil) (max-possible-sexps (- end start)))
1220 (save-excursion
1221 (condition-case ()
1222 (save-restriction
1223 (narrow-to-region start end)
2ed2806c 1224 ;; First check that the open and close parens balance in numbers.
869bff31 1225 (goto-char start)
e6b0b773 1226 (while (<= 0 (setq max-possible-sexps (1- max-possible-sexps)))
2ed2806c
KH
1227 (forward-sexp 1))
1228 ;; Now check that like matches like.
1229 (goto-char start)
35dccc62
SM
1230 (while (re-search-forward "\\s(" nil t)
1231 (save-excursion
1232 (let ((pos (match-beginning 0)))
1233 (goto-char pos)
2ed2806c 1234 (forward-sexp 1)
35dccc62
SM
1235 (or (eq (preceding-char) (cdr (syntax-after pos)))
1236 (eq (char-after pos) (cdr (syntax-after (1- (point)))))
1237 (error "Mismatched parentheses"))))))
869bff31 1238 (error
bed1b0c8
RS
1239 (skip-syntax-forward " .>")
1240 (setq failure-point (point)))))
bdbd9606
SM
1241 (if failure-point (goto-char failure-point))
1242 (not failure-point)))
869bff31 1243
1244(defun tex-terminate-paragraph (inhibit-validation)
1245 "Insert two newlines, breaking a paragraph for TeX.
81c735c0 1246Check for mismatched braces or $s in paragraph being terminated.
869bff31 1247A prefix arg inhibits the checking."
528415e7 1248 (interactive "*P")
869bff31 1249 (or inhibit-validation
1250 (save-excursion
1251 (tex-validate-region
bed1b0c8
RS
1252 (save-excursion
1253 (search-backward "\n\n" nil 'move)
1254 (point))
1255 (point)))
869bff31 1256 (message "Paragraph being closed appears to contain a mismatch"))
1257 (insert "\n\n"))
1258
7afecb99 1259(define-skeleton tex-insert-braces
869bff31 1260 "Make a pair of braces and be poised to type inside of them."
7afecb99
SM
1261 nil
1262 ?\{ _ ?})
869bff31 1263
9bd4f69c
RS
1264;; This function is used as the value of fill-nobreak-predicate
1265;; in LaTeX mode. Its job is to prevent line-breaking inside
1266;; of a \verb construct.
1267(defun latex-fill-nobreak-predicate ()
7afecb99
SM
1268 (save-excursion
1269 (skip-chars-backward " ")
1270 ;; Don't break after \ since `\ ' has special meaning.
1271 (or (and (not (bobp)) (memq (char-syntax (char-before)) '(?\\ ?/)))
1272 (let ((opoint (point))
1273 inside)
1274 (beginning-of-line)
1275 (while (re-search-forward "\\\\verb\\(.\\)" opoint t)
1276 (unless (re-search-forward (regexp-quote (match-string 1)) opoint t)
1277 (setq inside t)))
1278 inside))))
9bd4f69c 1279
53c4fe47
SM
1280(defvar latex-block-default "enumerate")
1281
8084f5d8 1282(defvar latex-block-args-alist
dd166d5f
SM
1283 '(("array" nil ?\{ (skeleton-read "Format: ") ?\})
1284 ("tabular" nil ?\{ (skeleton-read "Format: ") ?\})
1285 ("minipage" nil ?\{ (skeleton-read "Size: ") ?\})
1286 ("picture" nil ?\( (skeleton-read "SizeX,SizeY: ") ?\))
1287 ;; FIXME: This is right for Prosper, but not for seminar.
1288 ;; ("slide" nil ?\{ (skeleton-read "Title: ") ?\})
1289 )
8084f5d8
SM
1290 "Skeleton element to use for arguments to particular environments.
1291Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1292the name of the environment and SKEL-ELEM is an element to use in
1293a skeleton (see `skeleton-insert').")
1294
1295(defvar latex-block-body-alist
1296 '(("enumerate" nil '(latex-insert-item) > _)
1297 ("itemize" nil '(latex-insert-item) > _)
dd166d5f
SM
1298 ("table" nil "\\caption{" > (skeleton-read "Caption: ") "}" > \n
1299 '(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "table"))
1300 \n _)
1301 ("figure" nil > _ \n "\\caption{" > (skeleton-read "Caption: ") "}" > \n
1302 '(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "table"))))
8084f5d8
SM
1303 "Skeleton element to use for the body of particular environments.
1304Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1305the name of the environment and SKEL-ELEM is an element to use in
1306a skeleton (see `skeleton-insert').")
1307
15ca8de7 1308;; Like tex-insert-braces, but for LaTeX.
7afecb99
SM
1309(defalias 'tex-latex-block 'latex-insert-block)
1310(define-skeleton latex-insert-block
8a591d52 1311 "Create a matching pair of lines \\begin{NAME} and \\end{NAME} at point.
869bff31 1312Puts point on a blank line between them."
53c4fe47
SM
1313 (let ((choice (completing-read (format "LaTeX block name [%s]: "
1314 latex-block-default)
95a045bd 1315 (append latex-block-names
7afecb99 1316 latex-standard-block-names)
53c4fe47
SM
1317 nil nil nil nil latex-block-default)))
1318 (setq latex-block-default choice)
7afecb99 1319 (unless (or (member choice latex-standard-block-names)
53c4fe47
SM
1320 (member choice latex-block-names))
1321 ;; Remember new block names for later completion.
1322 (push choice latex-block-names))
1323 choice)
95a045bd 1324 \n "\\begin{" str "}"
8084f5d8 1325 (cdr (assoc str latex-block-args-alist))
dd166d5f
SM
1326 > \n (or (cdr (assoc str latex-block-body-alist)) '(nil > _))
1327 (unless (bolp) '\n)
95a045bd 1328 "\\end{" str "}" > \n)
53c4fe47 1329
ea590e1c
SM
1330(define-skeleton latex-insert-item
1331 "Insert a \item macro."
1332 nil
15ca8de7 1333 \n "\\item " >)
ea590e1c 1334
53c4fe47
SM
1335\f
1336;;;;
1337;;;; LaTeX syntax navigation
1338;;;;
869bff31 1339
5e56fb53
SM
1340(defmacro tex-search-noncomment (&rest body)
1341 "Execute BODY as long as it return non-nil and point is in a comment.
1342Return the value returned by the last execution of BODY."
1343 (declare (debug t))
1344 (let ((res-sym (make-symbol "result")))
1345 `(let (,res-sym)
1346 (while
1347 (and (setq ,res-sym (progn ,@body))
1348 (save-excursion (skip-chars-backward "^\n%") (not (bolp)))))
1349 ,res-sym)))
1350
869bff31 1351(defun tex-last-unended-begin ()
81c735c0 1352 "Leave point at the beginning of the last `\\begin{...}' that is unended."
95a045bd 1353 (condition-case nil
5e56fb53
SM
1354 (while (and (tex-search-noncomment
1355 (re-search-backward "\\\\\\(begin\\|end\\)\\s *{"))
95a045bd
SM
1356 (looking-at "\\\\end"))
1357 (tex-last-unended-begin))
1358 (search-failed (error "Couldn't find unended \\begin"))))
869bff31 1359
53c4fe47
SM
1360(defun tex-next-unmatched-end ()
1361 "Leave point at the end of the next `\\end' that is unended."
5e56fb53
SM
1362 (while (and (tex-search-noncomment
1363 (re-search-forward "\\\\\\(begin\\|end\\)\\s *{[^}]+}"))
ea590e1c
SM
1364 (save-excursion (goto-char (match-beginning 0))
1365 (looking-at "\\\\begin")))
53c4fe47
SM
1366 (tex-next-unmatched-end)))
1367
6a900cf1
ER
1368(defun tex-goto-last-unclosed-latex-block ()
1369 "Move point to the last unclosed \\begin{...}.
1370Mark is left at original location."
1371 (interactive)
1372 (let ((spot))
1373 (save-excursion
95a045bd 1374 (tex-last-unended-begin)
6a900cf1
ER
1375 (setq spot (point)))
1376 (push-mark)
1377 (goto-char spot)))
1378
53c4fe47
SM
1379(defun latex-backward-sexp-1 ()
1380 "Like (backward-sexp 1) but aware of multi-char elements."
1381 (let ((pos (point))
1382 (forward-sexp-function))
1383 (backward-sexp 1)
1384 (if (looking-at "\\\\begin\\>")
1385 (signal 'scan-error
1386 (list "Containing expression ends prematurely"
1387 (point) (prog1 (point) (goto-char pos))))
1388 (when (eq (char-after) ?{)
1389 (let ((newpos (point)))
1390 (when (ignore-errors (backward-sexp 1) t)
e67064e2
SM
1391 (if (or (looking-at "\\\\end\\>")
1392 ;; In case the \\ ends a verbatim section.
1393 (and (looking-at "end\\>") (eq (char-before) ?\\)))
53c4fe47
SM
1394 (tex-last-unended-begin)
1395 (goto-char newpos))))))))
1396
1397(defun latex-forward-sexp-1 ()
1398 "Like (forward-sexp 1) but aware of multi-char elements."
1399 (let ((pos (point))
1400 (forward-sexp-function))
1401 (forward-sexp 1)
1402 (let ((newpos (point)))
1403 (skip-syntax-backward "/w")
1404 (cond
1405 ((looking-at "\\\\end\\>")
1406 (signal 'scan-error
1407 (list "Containing expression ends prematurely"
1408 (point)
1409 (prog1
1410 (progn (ignore-errors (forward-sexp 2)) (point))
1411 (goto-char pos)))))
1412 ((looking-at "\\\\begin\\>")
1413 (goto-char (match-end 0))
1414 (tex-next-unmatched-end))
1415 (t (goto-char newpos))))))
1416
1417(defun latex-forward-sexp (&optional arg)
1418 "Like `forward-sexp' but aware of multi-char elements."
1419 (interactive "P")
1420 (unless arg (setq arg 1))
1421 (let ((pos (point)))
1422 (condition-case err
1423 (while (/= arg 0)
1424 (setq arg
1425 (if (> arg 0)
1426 (progn (latex-forward-sexp-1) (1- arg))
1427 (progn (latex-backward-sexp-1) (1+ arg)))))
1428 (scan-error
1429 (goto-char pos)
1430 (signal (car err) (cdr err))))))
1431
ea590e1c
SM
1432(defun latex-syntax-after ()
1433 "Like (char-syntax (char-after)) but aware of multi-char elements."
15ca8de7 1434 (if (looking-at "\\\\end\\>") ?\) (char-syntax (following-char))))
ea590e1c
SM
1435
1436(defun latex-skip-close-parens ()
1437 "Like (skip-syntax-forward \" )\") but aware of multi-char elements."
1438 (let ((forward-sexp-function nil))
1439 (while (progn (skip-syntax-forward " )")
1440 (looking-at "\\\\end\\>"))
1441 (forward-sexp 2))))
1442
1443(defun latex-down-list ()
1444 "Like (down-list 1) but aware of multi-char elements."
1445 (forward-comment (point-max))
1446 (let ((forward-sexp-function nil))
1447 (if (not (looking-at "\\\\begin\\>"))
1448 (down-list 1)
1449 (forward-sexp 1)
1450 ;; Skip arguments.
7afecb99
SM
1451 (while (looking-at "[ \t]*[[{(]")
1452 (with-syntax-table tex-mode-syntax-table
1453 (forward-sexp))))))
ea590e1c 1454
7afecb99
SM
1455(defalias 'tex-close-latex-block 'latex-close-block)
1456(define-skeleton latex-close-block
1457 "Create an \\end{...} to match the last unclosed \\begin{...}."
1458 (save-excursion
1459 (tex-last-unended-begin)
1460 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
1461 (match-string 1)))
1462 \n "\\end" str > \n)
1463
1464(define-skeleton latex-split-block
1465 "Split the enclosing environment by inserting \\end{..}\\begin{..} at point."
1466 (save-excursion
1467 (tex-last-unended-begin)
1468 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
1469 (prog1 (match-string 1)
1470 (goto-char (match-end 1))
1471 (setq v1 (buffer-substring (point)
1472 (progn
1473 (while (looking-at "[ \t]*[[{]")
1474 (forward-sexp 1))
1475 (point)))))))
1476 \n "\\end" str > \n _ \n "\\begin" str v1 > \n)
15ca8de7
SM
1477
1478(defconst tex-discount-args-cmds
1479 '("begin" "end" "input" "special" "cite" "ref" "include" "includeonly"
1480 "documentclass" "usepackage" "label")
1481 "TeX commands whose arguments should not be counted as text.")
1482
1483(defun tex-count-words (begin end)
1484 "Count the number of words in the buffer."
1485 (interactive
1486 (if (and transient-mark-mode mark-active)
1487 (list (region-beginning) (region-end))
1488 (list (point-min) (point-max))))
1489 ;; TODO: skip comments and math and maybe some environments.
1490 (save-excursion
1491 (goto-char begin)
1492 (let ((count 0))
1493 (while (and (< (point) end) (re-search-forward "\\<" end t))
1494 (if (not (eq (char-syntax (preceding-char)) ?/))
1495 (progn
1496 ;; Don't count single-char words.
1497 (unless (looking-at ".\\>") (incf count))
1498 (forward-char 1))
1499 (let ((cmd
1500 (buffer-substring-no-properties
1501 (point) (progn (when (zerop (skip-chars-forward "a-zA-Z@"))
1502 (forward-char 1))
1503 (point)))))
1504 (when (member cmd tex-discount-args-cmds)
1505 (skip-chars-forward "*")
1506 (forward-comment (point-max))
1507 (when (looking-at "\\[")
1508 (forward-sexp 1)
1509 (forward-comment (point-max)))
1510 (if (not (looking-at "{"))
1511 (forward-char 1)
1512 (forward-sexp 1))))))
1513 (message "%s words" count))))
b781e739
SS
1514
1515
869bff31 1516\f
1517;;; Invoking TeX in an inferior shell.
1518
15ca8de7
SM
1519;; Why use a shell instead of running TeX directly? Because if TeX
1520;; gets stuck, the user can switch to the shell window and type at it.
869bff31 1521
15ca8de7 1522;; The utility functions:
869bff31 1523
bdbd9606 1524(define-derived-mode tex-shell shell-mode "TeX-Shell"
3f2c97ea
SM
1525 (set (make-local-variable 'compilation-parse-errors-function)
1526 'tex-compilation-parse-errors)
bdbd9606
SM
1527 (compilation-shell-minor-mode t))
1528
d974af30 1529;;;###autoload
869bff31 1530(defun tex-start-shell ()
d6709b80
SM
1531 (with-current-buffer
1532 (make-comint
1533 "tex-shell"
07c16ec4 1534 (or tex-shell-file-name (getenv "ESHELL") shell-file-name)
4042dc25 1535 nil
053be11a 1536 ;; Specify an interactive shell, to make sure it prompts.
4042dc25 1537 "-i")
528415e7
RS
1538 (let ((proc (get-process "tex-shell")))
1539 (set-process-sentinel proc 'tex-shell-sentinel)
003274a0 1540 (set-process-query-on-exit-flag proc nil)
bdbd9606 1541 (tex-shell)
528415e7 1542 (while (zerop (buffer-size))
51b2c841
RS
1543 (sleep-for 1)))))
1544
033306e3
RS
1545(defun tex-feed-input ()
1546 "Send input to the tex shell process.
1547In the tex buffer this can be used to continue an interactive tex run.
bed1b0c8 1548In the tex shell buffer this command behaves like `comint-send-input'."
033306e3 1549 (interactive)
b781e739 1550 (set-buffer (tex-shell-buf))
033306e3
RS
1551 (comint-send-input)
1552 (tex-recenter-output-buffer nil))
1553
51b2c841
RS
1554(defun tex-display-shell ()
1555 "Make the TeX shell buffer visible in a window."
b781e739 1556 (display-buffer (tex-shell-buf))
51b2c841 1557 (tex-recenter-output-buffer nil))
528415e7
RS
1558
1559(defun tex-shell-sentinel (proc msg)
1560 (cond ((null (buffer-name (process-buffer proc)))
1561 ;; buffer killed
1562 (set-process-buffer proc nil)
1563 (tex-delete-last-temp-files))
1564 ((memq (process-status proc) '(signal exit))
1565 (tex-delete-last-temp-files))))
1566
1567(defun tex-set-buffer-directory (buffer directory)
869bff31 1568 "Set BUFFER's default directory to be DIRECTORY."
1569 (setq directory (file-name-as-directory (expand-file-name directory)))
1570 (if (not (file-directory-p directory))
1571 (error "%s is not a directory" directory)
1572 (save-excursion
1573 (set-buffer buffer)
1574 (setq default-directory directory))))
1575
30803a05
RS
1576(defvar tex-send-command-modified-tick 0)
1577(make-variable-buffer-local 'tex-send-command-modified-tick)
1578
bdbd9606 1579(defun tex-shell-proc ()
b781e739 1580 (or (tex-shell-running) (error "No TeX subprocess")))
bdbd9606
SM
1581(defun tex-shell-buf ()
1582 (process-buffer (tex-shell-proc)))
b781e739
SS
1583(defun tex-shell-buf-no-error ()
1584 (let ((proc (tex-shell-running)))
1585 (and proc (process-buffer proc))))
bdbd9606 1586
528415e7 1587(defun tex-send-command (command &optional file background)
4cdc1d4b 1588 "Send COMMAND to TeX shell process, substituting optional FILE for *.
8241d7b9
ER
1589Do this in background if optional BACKGROUND is t. If COMMAND has no *,
1590FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
1591substitution will be made in COMMAND. COMMAND can be any expression that
460e1b7d
RS
1592evaluates to a command string.
1593
1594Return the process in which TeX is running."
528415e7
RS
1595 (save-excursion
1596 (let* ((cmd (eval command))
bdbd9606 1597 (proc (tex-shell-proc))
64db2461 1598 (buf (process-buffer proc))
4f45adda 1599 (star (string-match "\\*" cmd))
4cdc1d4b
RS
1600 (string
1601 (concat
8ca66348
SM
1602 (if (null file)
1603 cmd
1604 (if (file-name-absolute-p file)
1605 (setq file (convert-standard-filename file)))
1606 (if star (concat (substring cmd 0 star)
1607 (shell-quote-argument file)
1608 (substring cmd (1+ star)))
1609 (concat cmd " " (shell-quote-argument file))))
4cdc1d4b 1610 (if background "&" ""))))
64db2461
RS
1611 ;; Switch to buffer before checking for subproc output in it.
1612 (set-buffer buf)
30803a05
RS
1613 ;; If text is unchanged since previous tex-send-command,
1614 ;; we haven't got any output. So wait for output now.
64db2461 1615 (if (= (buffer-modified-tick buf) tex-send-command-modified-tick)
30803a05 1616 (accept-process-output proc))
4cdc1d4b
RS
1617 (goto-char (process-mark proc))
1618 (insert string)
30803a05 1619 (comint-send-input)
460e1b7d
RS
1620 (setq tex-send-command-modified-tick (buffer-modified-tick buf))
1621 proc)))
528415e7 1622
a15849cb
RS
1623(defun tex-delete-last-temp-files (&optional not-all)
1624 "Delete any junk files from last temp file.
1625If NOT-ALL is non-nil, save the `.dvi' file."
528415e7
RS
1626 (if tex-last-temp-file
1627 (let* ((dir (file-name-directory tex-last-temp-file))
adf6b7f9
KH
1628 (list (and (file-directory-p dir)
1629 (file-name-all-completions
02fd229c
RS
1630 (file-name-sans-extension
1631 (file-name-nondirectory tex-last-temp-file))
1632 dir))))
adf6b7f9 1633 (while list
a15849cb
RS
1634 (if not-all
1635 (and
1636 ;; If arg is non-nil, don't delete the .dvi file.
1637 (not (string-match "\\.dvi$" (car list)))
1638 (delete-file (concat dir (car list))))
1639 (delete-file (concat dir (car list))))
528415e7
RS
1640 (setq list (cdr list))))))
1641
99621a14 1642(add-hook 'kill-emacs-hook 'tex-delete-last-temp-files)
869bff31 1643
75035a80
SM
1644;;
1645;; Machinery to guess the command that the user wants to execute.
1646;;
1647
1648(defvar tex-compile-history nil)
1649
1650(defvar tex-input-files-re
1651 (eval-when-compile
1652 (concat "\\." (regexp-opt '("tex" "texi" "texinfo"
1653 "bbl" "ind" "sty" "cls") t)
1654 ;; Include files with no dots (for directories).
1655 "\\'\\|\\`[^.]+\\'")))
1656
1657(defcustom tex-use-reftex t
1658 "If non-nil, use RefTeX's list of files to determine what command to use."
18a8c773
LK
1659 :type 'boolean
1660 :group 'tex)
75035a80
SM
1661
1662(defvar tex-compile-commands
1663 '(((concat "pdf" tex-command
bf4ec222 1664 " " (if (< 0 (length tex-start-commands))
d18fc930 1665 (shell-quote-argument tex-start-commands)) " %f")
75035a80
SM
1666 t "%r.pdf")
1667 ((concat tex-command
bf4ec222 1668 " " (if (< 0 (length tex-start-commands))
d18fc930 1669 (shell-quote-argument tex-start-commands)) " %f")
75035a80
SM
1670 t "%r.dvi")
1671 ("xdvi %r &" "%r.dvi")
29a47b89
SM
1672 ("xpdf %r.pdf &" "%r.pdf")
1673 ("gv %r.ps &" "%r.ps")
1674 ("yap %r &" "%r.dvi")
75035a80 1675 ("advi %r &" "%r.dvi")
29a47b89 1676 ("gv %r.pdf &" "%r.pdf")
75035a80
SM
1677 ("bibtex %r" "%r.aux" "%r.bbl")
1678 ("makeindex %r" "%r.idx" "%r.ind")
1679 ("texindex %r.??")
1680 ("dvipdfm %r" "%r.dvi" "%r.pdf")
1681 ("dvipdf %r" "%r.dvi" "%r.pdf")
dd166d5f 1682 ("dvips -o %r.ps %r" "%r.dvi" "%r.ps")
e70ff1af 1683 ("ps2pdf %r.ps" "%r.ps" "%r.pdf")
75035a80
SM
1684 ("lpr %r.ps" "%r.ps"))
1685 "List of commands for `tex-compile'.
1686Each element should be of the form (FORMAT IN OUT) where
1687FORMAT is an expression that evaluates to a string that can contain
1688 - `%r' the main file name without extension.
1689 - `%f' the main file name.
1690IN can be either a string (with the same % escapes in it) indicating
1691 the name of the input file, or t to indicate that the input is all
1692 the TeX files of the document, or nil if we don't know.
1693OUT describes the output file and is either a %-escaped string
1694 or nil to indicate that there is no output file.")
1695
8084f5d8
SM
1696;; defsubst* gives better byte-code than defsubst.
1697(defsubst* tex-string-prefix-p (str1 str2)
1698 "Return non-nil if STR1 is a prefix of STR2"
1699 (eq t (compare-strings str2 nil (length str1) str1 nil nil)))
1700
dd459839
SM
1701(defun tex-guess-main-file (&optional all)
1702 "Find a likely `tex-main-file'.
1703Looks for hints in other buffers in the same directory or in
8084f5d8
SM
1704ALL other buffers. If ALL is `sub' only look at buffers in parent directories
1705of the current buffer."
dd459839
SM
1706 (let ((dir default-directory)
1707 (header-re tex-start-of-header))
1708 (catch 'found
1709 ;; Look for a buffer with `tex-main-file' set.
1710 (dolist (buf (if (consp all) all (buffer-list)))
1711 (with-current-buffer buf
8084f5d8
SM
1712 (when (and (cond
1713 ((null all) (equal dir default-directory))
1714 ((eq all 'sub) (tex-string-prefix-p default-directory dir))
1715 (t))
dd459839
SM
1716 (stringp tex-main-file))
1717 (throw 'found (expand-file-name tex-main-file)))))
1718 ;; Look for a buffer containing the magic `tex-start-of-header'.
1719 (dolist (buf (if (consp all) all (buffer-list)))
1720 (with-current-buffer buf
8084f5d8
SM
1721 (when (and (cond
1722 ((null all) (equal dir default-directory))
1723 ((eq all 'sub) (tex-string-prefix-p default-directory dir))
1724 (t))
dd459839
SM
1725 buffer-file-name
1726 ;; (or (easy-mmode-derived-mode-p 'latex-mode)
1727 ;; (easy-mmode-derived-mode-p 'plain-tex-mode))
1728 (save-excursion
cb30255a
SM
1729 (save-restriction
1730 (widen)
1731 (goto-char (point-min))
95a045bd
SM
1732 (re-search-forward
1733 header-re (+ (point) 10000) t))))
dd459839
SM
1734 (throw 'found (expand-file-name buffer-file-name))))))))
1735
07c16ec4
SM
1736(defun tex-main-file ()
1737 "Return the relative name of the main file."
bdbd9606
SM
1738 (let* ((file (or tex-main-file
1739 ;; Compatibility with AUCTeX.
96c0d9e9 1740 (with-no-warnings
034a48f4
MR
1741 (when (boundp 'TeX-master)
1742 (cond ((stringp TeX-master)
1743 (make-local-variable 'tex-main-file)
1744 (setq tex-main-file TeX-master))
1745 ((and (eq TeX-master t) buffer-file-name)
1746 (file-relative-name buffer-file-name)))))
bdbd9606
SM
1747 ;; Try to guess the main file.
1748 (if (not buffer-file-name)
1749 (error "Buffer is not associated with any file")
1750 (file-relative-name
1751 (if (save-excursion
1752 (goto-char (point-min))
95a045bd
SM
1753 (re-search-forward tex-start-of-header
1754 (+ (point) 10000) t))
bdbd9606
SM
1755 ;; This is the main file.
1756 buffer-file-name
1757 ;; This isn't the main file, let's try to find better,
1758 (or (tex-guess-main-file)
8084f5d8 1759 (tex-guess-main-file 'sub)
bdbd9606 1760 ;; (tex-guess-main-file t)
07c16ec4 1761 buffer-file-name)))))))
e70ff1af
SM
1762 (if (or (file-exists-p file) (string-match "\\.tex\\'" file))
1763 file (concat file ".tex"))))
dd459839 1764
75035a80
SM
1765(defun tex-summarize-command (cmd)
1766 (if (not (stringp cmd)) ""
1767 (mapconcat 'identity
1768 (mapcar (lambda (s) (car (split-string s)))
1769 (split-string cmd "\\s-*\\(?:;\\|&&\\)\\s-*"))
1770 "&")))
1771
1772(defun tex-uptodate-p (file)
1773 "Return non-nil if FILE is not uptodate w.r.t the document source files.
1774FILE is typically the output DVI or PDF file."
1775 ;; We should check all the files included !!!
1776 (and
1777 ;; Clearly, the target must exist.
1778 (file-exists-p file)
1779 ;; And the last run must not have asked for a rerun.
1780 ;; FIXME: this should check that the last run was done on the same file.
1781 (let ((buf (condition-case nil (tex-shell-buf) (error nil))))
1782 (when buf
1783 (with-current-buffer buf
1784 (save-excursion
1785 (goto-char (point-max))
1786 (and (re-search-backward
8ca66348
SM
1787 (concat
1788 "(see the transcript file for additional information)"
1789 "\\|^Output written on .*"
1790 (regexp-quote (file-name-nondirectory file))
1791 " (.*)\\.") nil t)
75035a80
SM
1792 (> (save-excursion
1793 (or (re-search-backward "\\[[0-9]+\\]" nil t)
1794 (point-min)))
1795 (save-excursion
1796 (or (re-search-backward "Rerun" nil t)
1797 (point-min)))))))))
1798 ;; And the input files must not have been changed in the meantime.
1799 (let ((files (if (and tex-use-reftex
1800 (fboundp 'reftex-scanning-info-available-p)
1801 (reftex-scanning-info-available-p))
1802 (reftex-all-document-files)
1803 (list (file-name-directory (expand-file-name file)))))
1804 (ignored-dirs-re
1805 (concat
1806 (regexp-opt
1807 (delq nil (mapcar (lambda (s) (if (eq (aref s (1- (length s))) ?/)
1808 (substring s 0 (1- (length s)))))
1809 completion-ignored-extensions))
1810 t) "\\'"))
1811 (uptodate t))
1812 (while (and files uptodate)
1813 (let ((f (pop files)))
e70ff1af
SM
1814 (if (and (file-directory-p f)
1815 ;; Avoid infinite loops.
1816 (not (file-symlink-p f)))
75035a80
SM
1817 (unless (string-match ignored-dirs-re f)
1818 (setq files (nconc
1819 (directory-files f t tex-input-files-re)
1820 files)))
1821 (when (file-newer-than-file-p f file)
1822 (setq uptodate nil)))))
1823 uptodate)))
bf247b6e 1824
75035a80
SM
1825
1826(autoload 'format-spec "format-spec")
1827
1828(defvar tex-executable-cache nil)
1829(defun tex-executable-exists-p (name)
1830 "Like `executable-find' but with a cache."
1831 (let ((cache (assoc name tex-executable-cache)))
1832 (if cache (cdr cache)
1833 (let ((executable (executable-find name)))
1834 (push (cons name executable) tex-executable-cache)
1835 executable))))
1836
1837(defun tex-command-executable (cmd)
1838 (let ((s (if (stringp cmd) cmd (eval (car cmd)))))
1839 (substring s 0 (string-match "[ \t]\\|\\'" s))))
1840
1841(defun tex-command-active-p (cmd fspec)
1842 "Return non-nil if the CMD spec might need to be run."
1843 (let ((in (nth 1 cmd))
1844 (out (nth 2 cmd)))
1845 (if (stringp in)
1846 (let ((file (format-spec in fspec)))
1847 (when (file-exists-p file)
1848 (or (not out)
1849 (file-newer-than-file-p
1850 file (format-spec out fspec)))))
1851 (when (and (eq in t) (stringp out))
1852 (not (tex-uptodate-p (format-spec out fspec)))))))
1853
8084f5d8 1854(defun tex-compile-default (fspec)
dd166d5f 1855 "Guess a default command given the `format-spec' FSPEC."
75035a80
SM
1856 ;; TODO: Learn to do latex+dvips!
1857 (let ((cmds nil)
1858 (unchanged-in nil))
1859 ;; Only consider active commands.
1860 (dolist (cmd tex-compile-commands)
1861 (when (tex-executable-exists-p (tex-command-executable cmd))
1862 (if (tex-command-active-p cmd fspec)
1863 (push cmd cmds)
1864 (push (nth 1 cmd) unchanged-in))))
dd166d5f 1865 ;; If no command seems to be applicable, arbitrarily pick the first one.
29a47b89 1866 (setq cmds (if cmds (nreverse cmds) (list (car tex-compile-commands))))
75035a80
SM
1867 ;; Remove those commands whose input was considered stable for
1868 ;; some other command (typically if (t . "%.pdf") is inactive
1869 ;; then we're using pdflatex and the fact that the dvi file
1870 ;; is inexistent doesn't matter).
1871 (let ((tmp nil))
1872 (dolist (cmd cmds)
1873 (unless (member (nth 1 cmd) unchanged-in)
1874 (push cmd tmp)))
8084f5d8 1875 ;; Only remove if there's something left.
29a47b89 1876 (if tmp (setq cmds (nreverse tmp))))
8084f5d8
SM
1877 ;; Remove commands whose input is not uptodate either.
1878 (let ((outs (delq nil (mapcar (lambda (x) (nth 2 x)) cmds)))
1879 (tmp nil))
1880 (dolist (cmd cmds)
75035a80 1881 (unless (member (nth 1 cmd) outs)
8084f5d8
SM
1882 (push cmd tmp)))
1883 ;; Only remove if there's something left.
29a47b89 1884 (if tmp (setq cmds (nreverse tmp))))
75035a80
SM
1885 ;; Select which file we're going to operate on (the latest).
1886 (let ((latest (nth 1 (car cmds))))
1887 (dolist (cmd (prog1 (cdr cmds) (setq cmds (list (car cmds)))))
1888 (if (equal latest (nth 1 cmd))
1889 (push cmd cmds)
1890 (unless (eq latest t) ;Can't beat that!
1891 (if (or (not (stringp latest))
1892 (eq (nth 1 cmd) t)
1893 (and (stringp (nth 1 cmd))
1894 (file-newer-than-file-p
1895 (format-spec (nth 1 cmd) fspec)
1896 (format-spec latest fspec))))
1897 (setq latest (nth 1 cmd) cmds (list cmd)))))))
1898 ;; Expand the command spec into the actual text.
1899 (dolist (cmd (prog1 cmds (setq cmds nil)))
1900 (push (cons (eval (car cmd)) (cdr cmd)) cmds))
1901 ;; Select the favorite command from the history.
1902 (let ((hist tex-compile-history)
8084f5d8 1903 re hist-cmd)
75035a80 1904 (while hist
8084f5d8 1905 (setq hist-cmd (pop hist))
75035a80 1906 (setq re (concat "\\`"
8084f5d8 1907 (regexp-quote (tex-command-executable hist-cmd))
75035a80
SM
1908 "\\([ \t]\\|\\'\\)"))
1909 (dolist (cmd cmds)
8084f5d8
SM
1910 ;; If the hist entry uses the same command and applies to a file
1911 ;; of the same type (e.g. `gv %r.pdf' vs `gv %r.ps'), select cmd.
1912 (and (string-match re (car cmd))
1913 (or (not (string-match "%[fr]\\([-._[:alnum:]]+\\)" (car cmd)))
1914 (string-match (regexp-quote (match-string 1 (car cmd)))
1915 hist-cmd))
1916 (setq hist nil cmds (list cmd)))))
1917 ;; Substitute and return.
1918 (if (and hist-cmd
1919 (string-match (concat "[' \t\"]" (format-spec "%r" fspec)
1920 "\\([;&' \t\"]\\|\\'\\)") hist-cmd))
1921 ;; The history command was already applied to the same file,
1922 ;; so just reuse it.
1923 hist-cmd
1924 (if cmds (format-spec (caar cmds) fspec))))))
75035a80
SM
1925
1926(defun tex-compile (dir cmd)
1927 "Run a command CMD on current TeX buffer's file in DIR."
1928 ;; FIXME: Use time-stamps on files to decide the next op.
1929 (interactive
1930 (let* ((file (tex-main-file))
5e56fb53
SM
1931 (default-directory
1932 (prog1 (file-name-directory (expand-file-name file))
1933 (setq file (file-name-nondirectory file))))
75035a80 1934 (root (file-name-sans-extension file))
d18fc930
SM
1935 (fspec (list (cons ?r (shell-quote-argument root))
1936 (cons ?f (shell-quote-argument file))))
8084f5d8 1937 (default (tex-compile-default fspec)))
5e56fb53 1938 (list default-directory
75035a80
SM
1939 (completing-read
1940 (format "Command [%s]: " (tex-summarize-command default))
1941 (mapcar (lambda (x)
1942 (list (format-spec (eval (car x)) fspec)))
1943 tex-compile-commands)
1944 nil nil nil 'tex-compile-history default))))
1945 (save-some-buffers (not compilation-ask-about-save) nil)
1946 (if (tex-shell-running)
1947 (tex-kill-job)
1948 (tex-start-shell))
1949 (tex-send-tex-command cmd dir))
d6709b80
SM
1950
1951(defun tex-start-tex (command file &optional dir)
460e1b7d 1952 "Start a TeX run, using COMMAND on FILE."
6633b891 1953 (let* ((star (string-match "\\*" command))
460e1b7d 1954 (compile-command
6633b891
KH
1955 (if star
1956 (concat (substring command 0 star)
d18fc930 1957 (shell-quote-argument file)
6633b891
KH
1958 (substring command (1+ star)))
1959 (concat command " "
95a045bd 1960 tex-start-options
9e0ad27a 1961 (if (< 0 (length tex-start-commands))
d18fc930
SM
1962 (concat
1963 (shell-quote-argument tex-start-commands) " "))
1964 (shell-quote-argument file)))))
bdbd9606
SM
1965 (tex-send-tex-command compile-command dir)))
1966
1967(defun tex-send-tex-command (cmd &optional dir)
b781e739
SS
1968 (unless (or (equal dir (let ((buf (tex-shell-buf-no-error)))
1969 (and buf (with-current-buffer buf
1970 default-directory))))
bdbd9606
SM
1971 (not dir))
1972 (let (shell-dirtrack-verbose)
8ca66348 1973 (tex-send-command tex-shell-cd-command dir)))
bdbd9606 1974 (with-current-buffer (process-buffer (tex-send-command cmd))
bdbd9606
SM
1975 (setq compilation-last-buffer (current-buffer))
1976 (compilation-forget-errors)
1598a961 1977 ;; Don't parse previous compilations.
bdbd9606
SM
1978 (set-marker compilation-parsing-end (1- (point-max))))
1979 (tex-display-shell)
1980 (setq tex-last-buffer-texed (current-buffer)))
460e1b7d 1981\f
1598a961
SM
1982(defvar tex-error-parse-syntax-table
1983 (let ((st (make-syntax-table)))
1984 (modify-syntax-entry ?\( "()" st)
1985 (modify-syntax-entry ?\) ")(" st)
1986 (modify-syntax-entry ?\\ "\\" st)
1987 (modify-syntax-entry ?\{ "_" st)
1988 (modify-syntax-entry ?\} "_" st)
1989 (modify-syntax-entry ?\[ "_" st)
1990 (modify-syntax-entry ?\] "_" st)
1991 ;; Single quotations may appear in errors
1992 (modify-syntax-entry ?\" "_" st)
1993 st)
1994 "Syntax-table used while parsing TeX error messages.")
1995
460e1b7d 1996(defun tex-compilation-parse-errors (limit-search find-at-least)
f05bd645
RS
1997 "Parse the current buffer as TeX error messages.
1998See the variable `compilation-parse-errors-function' for the interface it uses.
1999
2000This function parses only the last TeX compilation.
2001It works on TeX compilations only. It is necessary for that purpose,
2002since TeX does not put file names and line numbers on the same line as
2003for the error messages."
460e1b7d
RS
2004 (require 'thingatpt)
2005 (setq compilation-error-list nil)
f05bd645
RS
2006 (let ((default-directory ; Perhaps dir has changed meanwhile.
2007 (file-name-directory (buffer-file-name tex-last-buffer-texed)))
f05bd645
RS
2008 found-desired (num-errors-found 0)
2009 last-filename last-linenum last-position
2010 begin-of-error end-of-error)
f05bd645
RS
2011 ;; Don't reparse messages already seen at last parse.
2012 (goto-char compilation-parsing-end)
2013 ;; Parse messages.
2014 (while (and (not (or found-desired (eobp)))
2015 (prog1 (re-search-forward "^! " nil 'move)
2016 (setq begin-of-error (match-beginning 0)
2017 end-of-error (match-end 0)))
2018 (re-search-forward
2019 "^l\\.\\([0-9]+\\) \\(\\.\\.\\.\\)?\\(.*\\)$" nil 'move))
3f2c97ea 2020 (let* ((this-error (copy-marker begin-of-error))
003274a0 2021 (linenum (string-to-number (match-string 1)))
f05bd645
RS
2022 (error-text (regexp-quote (match-string 3)))
2023 (filename
2024 (save-excursion
ea590e1c
SM
2025 (with-syntax-table tex-error-parse-syntax-table
2026 (backward-up-list 1)
2027 (skip-syntax-forward "(_")
2028 (while (not (file-readable-p (thing-at-point 'filename)))
2029 (skip-syntax-backward "(_")
2030 (backward-up-list 1)
2031 (skip-syntax-forward "(_"))
2032 (thing-at-point 'filename))))
f05bd645
RS
2033 (new-file
2034 (or (null last-filename)
2035 (not (string-equal last-filename filename))))
2036 (error-location
cc9f5376
SM
2037 (with-current-buffer
2038 (if (equal filename (concat tex-zap-file ".tex"))
2039 tex-last-buffer-texed
2040 (find-file-noselect filename))
2041 (save-excursion
2042 (if new-file
2043 (progn (goto-line linenum) (setq last-position nil))
2044 (goto-char last-position)
2045 (forward-line (- linenum last-linenum)))
2046 ;; first try a forward search for the error text,
2047 ;; then a backward search limited by the last error.
2048 (let ((starting-point (point)))
2049 (or (re-search-forward error-text nil t)
2050 (re-search-backward error-text last-position t)
2051 (goto-char starting-point)))
2052 (point-marker)))))
f05bd645
RS
2053 (goto-char this-error)
2054 (if (and compilation-error-list
2055 (or (and find-at-least
2056 (>= num-errors-found
2057 find-at-least))
2058 (and limit-search
2059 (>= end-of-error limit-search)))
2060 new-file)
2061 (setq found-desired t)
2062 (setq num-errors-found (1+ num-errors-found)
2063 last-filename filename
2064 last-linenum linenum
2065 last-position error-location
2066 compilation-error-list ; Add the new error
2067 (cons (cons this-error error-location)
2068 compilation-error-list))
2069 (goto-char end-of-error)))))
ee13a145 2070 (set-marker compilation-parsing-end (point))
13376c78 2071 (setq compilation-error-list (nreverse compilation-error-list)))
460e1b7d 2072\f
528415e7 2073;;; The commands:
869bff31 2074
2075(defun tex-region (beg end)
2076 "Run TeX on the current region, via a temporary file.
2077The file's name comes from the variable `tex-zap-file' and the
2078variable `tex-directory' says where to put it.
2079
2080If the buffer has a header, the header is given to TeX before the
2081region itself. The buffer's header is all lines between the strings
2082defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
2083The header must start in the first 100 lines of the buffer.
2084
2085The value of `tex-trailer' is given to TeX as input after the region.
2086
2087The value of `tex-command' specifies the command to use to run TeX."
2088 (interactive "r")
2089 (if (tex-shell-running)
2090 (tex-kill-job)
2091 (tex-start-shell))
2092 (or tex-zap-file
2093 (setq tex-zap-file (tex-generate-zap-file-name)))
6d34c59f
RS
2094 ;; Temp file will be written and TeX will be run in zap-directory.
2095 ;; If the TEXINPUTS file has relative directories or if the region has
2096 ;; \input of files, this must be the same directory as the file for
2097 ;; TeX to access the correct inputs. That's why it's safest if
2098 ;; tex-directory is ".".
2099 (let* ((zap-directory
528415e7 2100 (file-name-as-directory (expand-file-name tex-directory)))
d6709b80
SM
2101 (tex-out-file (expand-file-name (concat tex-zap-file ".tex")
2102 zap-directory)))
0d548e5d
RS
2103 ;; Don't delete temp files if we do the same buffer twice in a row.
2104 (or (eq (current-buffer) tex-last-buffer-texed)
2105 (tex-delete-last-temp-files t))
869bff31 2106 ;; Write the new temp file.
2107 (save-excursion
2108 (save-restriction
2109 (widen)
2110 (goto-char (point-min))
2111 (forward-line 100)
2112 (let ((search-end (point))
6d34c59f
RS
2113 (default-directory zap-directory)
2114 (already-output 0))
869bff31 2115 (goto-char (point-min))
6d34c59f 2116
725b7428
RS
2117 ;; Maybe copy first line, such as `\input texinfo', to temp file.
2118 (and tex-first-line-header-regexp
2119 (looking-at tex-first-line-header-regexp)
bed1b0c8 2120 (write-region (point)
6d34c59f
RS
2121 (progn (forward-line 1)
2122 (setq already-output (point)))
725b7428
RS
2123 tex-out-file nil nil))
2124
6d34c59f
RS
2125 ;; Write out the header, if there is one,
2126 ;; and any of the specified region which extends before it.
2127 ;; But don't repeat anything already written.
898b9ac1 2128 (if (re-search-forward tex-start-of-header search-end t)
6d34c59f 2129 (let (hbeg)
869bff31 2130 (beginning-of-line)
2131 (setq hbeg (point)) ;mark beginning of header
898b9ac1 2132 (if (re-search-forward tex-end-of-header nil t)
6d34c59f
RS
2133 (let (hend)
2134 (forward-line 1)
bed1b0c8 2135 (setq hend (point)) ;mark end of header
6d34c59f
RS
2136 (write-region (max (min hbeg beg) already-output)
2137 hend
2138 tex-out-file
2139 (not (zerop already-output)) nil)
2140 (setq already-output hend)))))
2141
2142 ;; Write out the specified region
2143 ;; (but don't repeat anything already written).
2144 (write-region (max beg already-output) end
2145 tex-out-file
2146 (not (zerop already-output)) nil))
2147 ;; Write the trailer, if any.
2148 ;; Precede it with a newline to make sure it
2149 ;; is not hidden in a comment.
2150 (if tex-trailer
2151 (write-region (concat "\n" tex-trailer) nil
2152 tex-out-file t nil))))
528415e7
RS
2153 ;; Record the file name to be deleted afterward.
2154 (setq tex-last-temp-file tex-out-file)
f05bd645
RS
2155 ;; Use a relative file name here because (1) the proper dir
2156 ;; is already current, and (2) the abs file name is sometimes
2157 ;; too long and can make tex crash.
d6709b80
SM
2158 (tex-start-tex tex-command (concat tex-zap-file ".tex") zap-directory)
2159 (setq tex-print-file tex-out-file)))
869bff31 2160
2161(defun tex-buffer ()
2162 "Run TeX on current buffer. See \\[tex-region] for more information.
528415e7
RS
2163Does not save the buffer, so it's useful for trying experimental versions.
2164See \\[tex-file] for an alternative."
869bff31 2165 (interactive)
2166 (tex-region (point-min) (point-max)))
2167
2168(defun tex-file ()
2169 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
2170This function is more useful than \\[tex-buffer] when you need the
2171`.aux' file of LaTeX to have the correct name."
2172 (interactive)
7abc9add
SS
2173 (when tex-offer-save
2174 (save-some-buffers))
d6709b80 2175 (let* ((source-file (tex-main-file))
07c16ec4 2176 (file-dir (file-name-directory (expand-file-name source-file))))
869bff31 2177 (if (tex-shell-running)
2178 (tex-kill-job)
2179 (tex-start-shell))
d6709b80 2180 (tex-start-tex tex-command source-file file-dir)
f05bd645 2181 (setq tex-print-file (expand-file-name source-file))))
869bff31 2182
2183(defun tex-generate-zap-file-name ()
2184 "Generate a unique name suitable for use as a file name."
2185 ;; Include the shell process number and host name
2186 ;; in case there are multiple shells (for same or different user).
f5cdb851
KH
2187 ;; Dec 1998: There is a report that some versions of xdvi
2188 ;; don't work with file names that start with #.
5616ee46 2189 (format "_TZ_%d-%s"
869bff31 2190 (process-id (get-buffer-process "*tex-shell*"))
07c16ec4 2191 (subst-char-in-string ?. ?- (system-name))))
869bff31 2192
2193;; This will perhaps be useful for modifying TEXINPUTS.
2194;; Expand each file name, separated by colons, in the string S.
2195(defun tex-expand-files (s)
2196 (let (elts (start 0))
2197 (while (string-match ":" s start)
2198 (setq elts (cons (substring s start (match-beginning 0)) elts))
2199 (setq start (match-end 0)))
2200 (or (= start 0)
2201 (setq elts (cons (substring s start) elts)))
c0df1972
SM
2202 (mapconcat (lambda (elt)
2203 (if (= (length elt) 0) elt (expand-file-name elt)))
5616ee46 2204 (nreverse elts) ":")))
869bff31 2205
2206(defun tex-shell-running ()
713f7b15 2207 (let ((proc (get-process "tex-shell")))
b781e739
SS
2208 (when proc
2209 (if (and (eq (process-status proc) 'run)
2210 (buffer-live-p (process-buffer proc)))
2211 ;; return the TeX process on success
2212 proc
2213 ;; get rid of the process permanently
2214 ;; this should get rid of the annoying w32 problem with
2215 ;; dead tex-shell buffer and live process
2216 (delete-process proc)))))
869bff31 2217
2218(defun tex-kill-job ()
2219 "Kill the currently running TeX job."
2220 (interactive)
b781e739 2221 ;; `quit-process' leads to core dumps of the tex process (except if
bed1b0c8
RS
2222 ;; coredumpsize has limit 0kb as on many environments). One would
2223 ;; like to use (kill-process proc 'lambda), however that construct
2224 ;; does not work on some systems and kills the shell itself.
b781e739
SS
2225 (let ((proc (get-process "tex-shell")))
2226 (when proc (quit-process proc t))))
869bff31 2227
2228(defun tex-recenter-output-buffer (linenum)
2229 "Redisplay buffer of TeX job output so that most recent output can be seen.
2230The last line of the buffer is displayed on
2231line LINE of the window, or centered if LINE is nil."
2232 (interactive "P")
2233 (let ((tex-shell (get-buffer "*tex-shell*"))
23b64225 2234 (window))
869bff31 2235 (if (null tex-shell)
2236 (message "No TeX output buffer")
23b64225
RS
2237 (setq window (display-buffer tex-shell))
2238 (save-selected-window
2239 (select-window window)
2240 (bury-buffer tex-shell)
2241 (goto-char (point-max))
2242 (recenter (if linenum
2243 (prefix-numeric-value linenum)
2244 (/ (window-height) 2)))))))
869bff31 2245
528415e7 2246(defun tex-print (&optional alt)
869bff31 2247 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1433a222
CZ
2248Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
2249is provided, use the alternative command, `tex-alt-dvi-print-command'."
528415e7 2250 (interactive "P")
869bff31 2251 (let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
2252 test-name)
2253 (if (and (not (equal (current-buffer) tex-last-buffer-texed))
45c3304d
RS
2254 (buffer-file-name)
2255 ;; Check that this buffer's printed file is up to date.
869bff31 2256 (file-newer-than-file-p
2257 (setq test-name (tex-append (buffer-file-name) ".dvi"))
45c3304d 2258 (buffer-file-name)))
869bff31 2259 (setq print-file-name-dvi test-name))
528415e7
RS
2260 (if (not (file-exists-p print-file-name-dvi))
2261 (error "No appropriate `.dvi' file could be found")
460e1b7d
RS
2262 (if (tex-shell-running)
2263 (tex-kill-job)
2264 (tex-start-shell))
528415e7 2265 (tex-send-command
bed1b0c8 2266 (if alt tex-alt-dvi-print-command tex-dvi-print-command)
b5352ff5 2267 print-file-name-dvi
602503c5 2268 t))))
869bff31 2269
cf6d6e8a
RS
2270(defun tex-alt-print ()
2271 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
002b0d00 2272Runs the shell command defined by `tex-alt-dvi-print-command'."
cf6d6e8a
RS
2273 (interactive)
2274 (tex-print t))
2275
869bff31 2276(defun tex-view ()
2277 "Preview the last `.dvi' file made by running TeX under Emacs.
2278This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
2b7971c9
RS
2279The variable `tex-dvi-view-command' specifies the shell command for preview.
2280You must set that variable yourself before using this command,
2281because there is no standard value that would generally work."
869bff31 2282 (interactive)
2b7971c9
RS
2283 (or tex-dvi-view-command
2284 (error "You must set `tex-dvi-view-command'"))
3356ce3b
EZ
2285 ;; Restart the TeX shell if necessary.
2286 (or (tex-shell-running)
2287 (tex-start-shell))
746c30e2 2288 (let ((tex-dvi-print-command (eval tex-dvi-view-command)))
869bff31 2289 (tex-print)))
2290
2291(defun tex-append (file-name suffix)
2292 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
cf6d6e8a 2293Pascal-based TeX scans for the first period, C TeX uses the last.
869bff31 2294No period is retained immediately before SUFFIX,
2295so normally SUFFIX starts with one."
2296 (if (stringp file-name)
cf6d6e8a
RS
2297 (let ((file (file-name-nondirectory file-name))
2298 trial-name)
6da9bbd6 2299 ;; Try splitting on last period.
7d0ca249
RS
2300 ;; The first-period split can get fooled when two files
2301 ;; named a.tex and a.b.tex are both tex'd;
2302 ;; the last-period split must be right if it matches at all.
cf6d6e8a
RS
2303 (setq trial-name
2304 (concat (file-name-directory file-name)
2305 (substring file 0
7d0ca249 2306 (string-match "\\.[^.]*$" file))
cf6d6e8a
RS
2307 suffix))
2308 (if (or (file-exists-p trial-name)
2309 (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
2310 trial-name
7d0ca249 2311 ;; Not found, so split on first period.
cf6d6e8a
RS
2312 (concat (file-name-directory file-name)
2313 (substring file 0
7d0ca249 2314 (string-match "\\." file))
cf6d6e8a 2315 suffix)))
869bff31 2316 " "))
2317
2318(defun tex-show-print-queue ()
2319 "Show the print queue that \\[tex-print] put your job on.
1433a222 2320Runs the shell command defined by `tex-show-queue-command'."
869bff31 2321 (interactive)
2322 (if (tex-shell-running)
2323 (tex-kill-job)
2324 (tex-start-shell))
51b2c841
RS
2325 (tex-send-command tex-show-queue-command)
2326 (tex-display-shell))
869bff31 2327
2328(defun tex-bibtex-file ()
2329 "Run BibTeX on the current buffer's file."
2330 (interactive)
2331 (if (tex-shell-running)
2332 (tex-kill-job)
2333 (tex-start-shell))
e6b0b773
MR
2334 (let (shell-dirtrack-verbose
2335 (tex-out-file
869bff31 2336 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
2337 (file-dir (file-name-directory (buffer-file-name))))
8ca66348 2338 (tex-send-command tex-shell-cd-command file-dir)
51b2c841
RS
2339 (tex-send-command tex-bibtex-command tex-out-file))
2340 (tex-display-shell))
ea590e1c
SM
2341\f
2342;;;;
2343;;;; LaTeX indentation
2344;;;;
2345
2346(defvar tex-indent-allhanging t)
2347(defvar tex-indent-arg 4)
2348(defvar tex-indent-basic 2)
2349(defvar tex-indent-item tex-indent-basic)
2350(defvar tex-indent-item-re "\\\\\\(bib\\)?item\\>")
dd166d5f 2351(defvar latex-noindent-environments '("document"))
ea590e1c 2352
8a591d52
SM
2353(defvar tex-latex-indent-syntax-table
2354 (let ((st (make-syntax-table tex-mode-syntax-table)))
2355 (modify-syntax-entry ?$ "." st)
2356 (modify-syntax-entry ?\( "." st)
2357 (modify-syntax-entry ?\) "." st)
2358 st)
2359 "Syntax table used while computing indentation.")
ea590e1c
SM
2360
2361(defun latex-indent (&optional arg)
7afecb99 2362 (if (and (eq (get-text-property (line-beginning-position) 'face)
014e29b9 2363 'tex-verbatim))
a3d80d4a 2364 'noindent
7afecb99
SM
2365 (with-syntax-table tex-latex-indent-syntax-table
2366 ;; TODO: Rather than ignore $, we should try to be more clever about it.
2367 (let ((indent
2368 (save-excursion
2369 (beginning-of-line)
2370 (latex-find-indent))))
2371 (if (< indent 0) (setq indent 0))
2372 (if (<= (current-column) (current-indentation))
2373 (indent-line-to indent)
2374 (save-excursion (indent-line-to indent)))))))
ea590e1c
SM
2375
2376(defun latex-find-indent (&optional virtual)
2377 "Find the proper indentation of text after point.
2378VIRTUAL if non-nil indicates that we're only trying to find the indentation
2379 in order to determine the indentation of something else.
2380There might be text before point."
2381 (save-excursion
2382 (skip-chars-forward " \t")
2383 (or
7afecb99
SM
2384 ;; Stick the first line at column 0.
2385 (and (= (point-min) (line-beginning-position)) 0)
ea590e1c 2386 ;; Trust the current indentation, if such info is applicable.
7afecb99
SM
2387 (and virtual (save-excursion (skip-chars-backward " \t&") (bolp))
2388 (current-column))
2389 ;; Stick verbatim environments to the left margin.
2390 (and (looking-at "\\\\\\(begin\\|end\\) *{\\([^\n}]+\\)")
2391 (member (match-string 2) tex-verbatim-environments)
2392 0)
ea590e1c
SM
2393 ;; Put leading close-paren where the matching open brace would be.
2394 (and (eq (latex-syntax-after) ?\))
2395 (ignore-errors
2396 (save-excursion
2397 (latex-skip-close-parens)
2398 (latex-backward-sexp-1)
2399 (latex-find-indent 'virtual))))
2400 ;; Default (maybe an argument)
2401 (let ((pos (point))
ea590e1c
SM
2402 ;; Outdent \item if necessary.
2403 (indent (if (looking-at tex-indent-item-re) (- tex-indent-item) 0))
2404 up-list-pos)
2405 ;; Find the previous point which determines our current indentation.
2406 (condition-case err
2407 (progn
2408 (latex-backward-sexp-1)
2409 (while (> (current-column) (current-indentation))
2410 (latex-backward-sexp-1)))
2411 (scan-error
2412 (setq up-list-pos (nth 2 err))))
8908cf40
SM
2413 (cond
2414 ((= (point-min) pos) 0) ; We're really just indenting the first line.
2415 ((integerp up-list-pos)
2416 ;; Have to indent relative to the open-paren.
2417 (goto-char up-list-pos)
2418 (if (and (not tex-indent-allhanging)
dd166d5f
SM
2419 (save-excursion
2420 ;; Make sure we're an argument to a macro and
2421 ;; that the macro is at the beginning of a line.
2422 (condition-case nil
2423 (progn
2424 (while (eq (char-syntax (char-after)) ?\()
2425 (forward-sexp -1))
2426 (and (eq (char-syntax (char-after)) ?/)
2427 (progn (skip-chars-backward " \t&")
2428 (bolp))))
2429 (scan-error nil)))
8908cf40
SM
2430 (> pos (progn (latex-down-list)
2431 (forward-comment (point-max))
2432 (point))))
7afecb99 2433 ;; Align with the first element after the open-paren.
8908cf40
SM
2434 (current-column)
2435 ;; We're the first element after a hanging brace.
2436 (goto-char up-list-pos)
dd166d5f
SM
2437 (+ (if (and (looking-at "\\\\begin *{\\([^\n}]+\\)")
2438 (member (match-string 1)
2439 latex-noindent-environments))
2440 0 tex-indent-basic)
2441 indent (latex-find-indent 'virtual))))
8908cf40
SM
2442 ;; We're now at the "beginning" of a line.
2443 ((not (and (not virtual) (eq (char-after) ?\\)))
2444 ;; Nothing particular here: just keep the same indentation.
2445 (+ indent (current-column)))
2446 ;; We're now looking at a macro call.
dd166d5f
SM
2447 ((looking-at tex-indent-item-re)
2448 ;; Indenting relative to an item, have to re-add the outdenting.
8908cf40
SM
2449 (+ indent (current-column) tex-indent-item))
2450 (t
2451 (let ((col (current-column)))
d1218e3e 2452 (if (or (not (eq (char-syntax (or (char-after pos) ?\s)) ?\())
dd166d5f
SM
2453 ;; Can't be an arg if there's an empty line inbetween.
2454 (save-excursion (re-search-forward "^[ \t]*$" pos t)))
8908cf40
SM
2455 ;; If the first char was not an open-paren, there's
2456 ;; a risk that this is really not an argument to the
2457 ;; macro at all.
21749f14
RS
2458 (+ indent col)
2459 (forward-sexp 1)
2460 (if (< (line-end-position)
2461 (save-excursion (forward-comment (point-max))
2462 (point)))
8908cf40
SM
2463 ;; we're indenting the first argument.
2464 (min (current-column) (+ tex-indent-arg col))
2465 (skip-syntax-forward " ")
2466 (current-column))))))))))
a3d80d4a
SM
2467;;; DocTeX support
2468
2469(defun doctex-font-lock-^^A ()
2470 (if (eq (char-after (line-beginning-position)) ?\%)
2471 (progn
2472 (put-text-property
2473 (1- (match-beginning 1)) (match-beginning 1)
2474 'syntax-table
2475 (if (= (1+ (line-beginning-position)) (match-beginning 1))
2476 ;; The `%' is a single-char comment, which Emacs
2477 ;; syntax-table can't deal with. We could turn it
2478 ;; into a non-comment, or use `\n%' or `%^' as the comment.
2479 ;; Instead, we include it in the ^^A comment.
2480 (eval-when-compile (string-to-syntax "< b"))
2481 (eval-when-compile (string-to-syntax ">"))))
2482 (let ((end (line-end-position)))
2483 (if (< end (point-max))
2484 (put-text-property
2485 end (1+ end)
2486 'syntax-table
2487 (eval-when-compile (string-to-syntax "> b")))))
2488 (eval-when-compile (string-to-syntax "< b")))))
2489
2490(defun doctex-font-lock-syntactic-face-function (state)
2491 ;; Mark DocTeX documentation, which is parsed as a style A comment
2492 ;; starting in column 0.
2493 (if (or (nth 3 state) (nth 7 state)
2494 (not (memq (char-before (nth 8 state))
2495 '(?\n nil))))
2496 ;; Anything else is just as for LaTeX.
2497 (tex-font-lock-syntactic-face-function state)
2498 font-lock-doc-face))
2499
2500(defvar doctex-font-lock-syntactic-keywords
2501 (append
2502 tex-font-lock-syntactic-keywords
2503 ;; For DocTeX comment-in-doc.
2504 `(("\\(\\^\\)\\^A" (1 (doctex-font-lock-^^A))))))
2505
2506(defvar doctex-font-lock-keywords
2507 (append tex-font-lock-keywords
2508 '(("^%<[^>]*>" (0 font-lock-preprocessor-face t)))))
2509
2510;;;###autoload
2511(define-derived-mode doctex-mode latex-mode "DocTeX"
2512 "Major mode to edit DocTeX files."
2513 (setq font-lock-defaults
2514 (cons (append (car font-lock-defaults) '(doctex-font-lock-keywords))
2515 (mapcar
2516 (lambda (x)
2517 (case (car-safe x)
2518 (font-lock-syntactic-keywords
2519 (cons (car x) 'doctex-font-lock-syntactic-keywords))
2520 (font-lock-syntactic-face-function
2521 (cons (car x) 'doctex-font-lock-syntactic-face-function))
2522 (t x)))
2523 (cdr font-lock-defaults)))))
528415e7
RS
2524
2525(run-hooks 'tex-mode-load-hook)
869bff31 2526
49116ac0
JB
2527(provide 'tex-mode)
2528
dd166d5f 2529;; arch-tag: c0a680b1-63aa-4547-84b9-4193c29c0080
d501f516 2530;;; tex-mode.el ends here