1 ;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1986, 1989, 1992, 1994, 1995, 1996, 1997, 1998
4 ;; 1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
10 ;; Contributions over the years by William F. Schelter, Dick King,
11 ;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold.
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;; Pacify the byte-compiler
38 (defvar font-lock-comment-face)
39 (defvar font-lock-doc-face)
44 (defgroup tex-file nil
45 "TeX files and directories."
50 "Running external commands from TeX mode."
54 (defgroup tex-view nil
55 "Viewing and printing TeX files."
60 (defcustom tex-shell-file-name nil
61 "If non-nil, the shell file name to run in the subshell used to run TeX."
62 :type '(choice (const :tag "None" nil)
67 (defcustom tex-directory (purecopy ".")
68 "Directory in which temporary files are written.
69 You can make this `/tmp' if your TEXINPUTS has no relative directories in it
70 and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
71 `\\input' commands with relative directories."
76 (defcustom tex-first-line-header-regexp nil
77 "Regexp for matching a first line which `tex-region' should include.
78 If this is non-nil, it should be a regular expression string;
79 if it matches the first line of the file,
80 `tex-region' always includes the first line in the TeX run."
81 :type '(choice (const :tag "None" nil)
86 (defcustom tex-main-file nil
87 "The main TeX source file which includes this buffer's file.
88 The command `tex-file' runs TeX on the file specified by `tex-main-file'
89 if the variable is non-nil."
90 :type '(choice (const :tag "None" nil)
95 (defcustom tex-offer-save t
96 "If non-nil, ask about saving modified buffers before \\[tex-file] is run."
101 (defcustom tex-run-command (purecopy "tex")
102 "Command used to run TeX subjob.
103 TeX Mode sets `tex-command' to this string.
104 See the documentation of that variable."
109 (defcustom latex-run-command (purecopy "latex")
110 "Command used to run LaTeX subjob.
111 LaTeX Mode sets `tex-command' to this string.
112 See the documentation of that variable."
117 (defcustom slitex-run-command (purecopy "slitex")
118 "Command used to run SliTeX subjob.
119 SliTeX Mode sets `tex-command' to this string.
120 See the documentation of that variable."
125 (defcustom tex-start-options (purecopy "")
126 "TeX options to use when starting TeX.
127 These immediately precede the commands in `tex-start-commands'
128 and the input file name, with no separating space and are not shell-quoted.
129 If nil, TeX runs with no options. See the documentation of `tex-command'."
135 (defcustom tex-start-commands (purecopy "\\nonstopmode\\input")
136 "TeX commands to use when starting TeX.
137 They are shell-quoted and precede the input file name, with a separating space.
138 If nil, no commands are used. See the documentation of `tex-command'."
139 :type '(radio (const :tag "Interactive \(nil\)" nil)
140 (const :tag "Nonstop \(\"\\nonstopmode\\input\"\)"
141 "\\nonstopmode\\input")
142 (string :tag "String at your choice"))
146 (defvar latex-standard-block-names
147 '("abstract" "array" "center" "description"
148 "displaymath" "document" "enumerate" "eqnarray"
149 "eqnarray*" "equation" "figure" "figure*"
150 "flushleft" "flushright" "itemize" "letter"
151 "list" "minipage" "picture" "quotation"
152 "quote" "slide" "sloppypar" "tabbing"
153 "table" "table*" "tabular" "tabular*"
154 "thebibliography" "theindex*" "titlepage" "trivlist"
155 "verbatim" "verbatim*" "verse" "math")
156 "Standard LaTeX block names.")
159 (defcustom latex-block-names nil
160 "User defined LaTeX block names.
161 Combined with `latex-standard-block-names' for minibuffer completion."
162 :type '(repeat string)
166 (defcustom tex-bibtex-command (purecopy "bibtex")
167 "Command used by `tex-bibtex-file' to gather bibliographic data.
168 If this string contains an asterisk (`*'), that is replaced by the file name;
169 otherwise, the file name, preceded by blank, is added at the end."
174 (defcustom tex-dvi-print-command (purecopy "lpr -d")
175 "Command used by \\[tex-print] to print a .dvi file.
176 If this string contains an asterisk (`*'), that is replaced by the file name;
177 otherwise, the file name, preceded by blank, is added at the end."
182 (defcustom tex-alt-dvi-print-command (purecopy "lpr -d")
183 "Command used by \\[tex-print] with a prefix arg to print a .dvi file.
184 If this string contains an asterisk (`*'), that is replaced by the file name;
185 otherwise, the file name, preceded by blank, is added at the end.
187 If two printers are not enough of a choice, you can set the variable
188 `tex-alt-dvi-print-command' to an expression that asks what you want;
191 (setq tex-alt-dvi-print-command
192 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
194 would tell \\[tex-print] with a prefix argument to ask you which printer to
196 :type '(choice (string :tag "Command")
197 (sexp :tag "Expression"))
201 (defcustom tex-dvi-view-command
203 ((eq window-system 'x) ,(purecopy "xdvi"))
204 ((eq window-system 'w32) ,(purecopy "yap"))
205 (t ,(purecopy "dvi2tty * | cat -s")))
206 "Command used by \\[tex-view] to display a `.dvi' file.
207 If it is a string, that specifies the command directly.
208 If this string contains an asterisk (`*'), that is replaced by the file name;
209 otherwise, the file name, preceded by a space, is added at the end.
211 If the value is a form, it is evaluated to get the command to use."
212 :type '(choice (const nil) string sexp)
216 (defcustom tex-show-queue-command (purecopy "lpq")
217 "Command used by \\[tex-show-print-queue] to show the print queue.
218 Should show the queue(s) that \\[tex-print] puts jobs on."
223 (defcustom tex-default-mode 'latex-mode
224 "Mode to enter for a new file that might be either TeX or LaTeX.
225 This variable is used when it can't be determined whether the file
226 is plain TeX or LaTeX or what because the file contains no commands.
227 Normally set to either `plain-tex-mode' or `latex-mode'."
232 (defcustom tex-open-quote (purecopy "``")
233 "String inserted by typing \\[tex-insert-quote] to open a quotation."
235 :options '("``" "\"<" "\"`" "<<" "«")
239 (defcustom tex-close-quote (purecopy "''")
240 "String inserted by typing \\[tex-insert-quote] to close a quotation."
242 :options '("''" "\">" "\"'" ">>" "»")
245 (defcustom tex-fontify-script t
246 "If non-nil, fontify subscript and superscript strings."
250 (put 'tex-fontify-script 'safe-local-variable 'booleanp)
252 (defcustom tex-font-script-display '(-0.2 0.2)
253 "How much to lower and raise subscript and superscript content.
254 This is a list of two floats. The first is negative and
255 specifies how much subscript is lowered, the second is positive
256 and specifies how much superscript is raised. Heights are
257 measured relative to that of the normal text."
259 :type '(list (float :tag "Subscript")
260 (float :tag "Superscript"))
263 (defvar tex-last-temp-file nil
264 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
265 Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
266 tex shell terminates.")
268 (defvar tex-command "tex"
269 "*Command to run TeX.
270 If this string contains an asterisk \(`*'\), that is replaced by the file name;
271 otherwise the value of `tex-start-options', the \(shell-quoted\)
272 value of `tex-start-commands', and the file name are added at the end
273 with blanks as separators.
275 In TeX, LaTeX, and SliTeX Mode this variable becomes buffer local.
276 In these modes, use \\[set-variable] if you want to change it for the
279 (defvar tex-trailer nil
280 "String appended after the end of a region sent to TeX by \\[tex-region].")
282 (defvar tex-start-of-header nil
283 "Regular expression used by \\[tex-region] to find start of file's header.")
285 (defvar tex-end-of-header nil
286 "Regular expression used by \\[tex-region] to find end of file's header.")
288 (defvar tex-shell-cd-command "cd"
289 "Command to give to shell running TeX to change directory.
290 The value of `tex-directory' is appended to this, separated by a space.")
292 (defvar tex-zap-file nil
293 "Temporary file name used for text being sent as input to TeX.
294 Should be a simple file name with no extension or directory specification.")
296 (defvar tex-last-buffer-texed nil
297 "Buffer which was last TeXed.")
299 (defvar tex-print-file nil
300 "File name that \\[tex-print] prints.
301 Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
303 (defvar tex-mode-syntax-table
304 (let ((st (make-syntax-table)))
305 (modify-syntax-entry ?% "<" st)
306 (modify-syntax-entry ?\n ">" st)
307 (modify-syntax-entry ?\f ">" st)
308 (modify-syntax-entry ?\C-@ "w" st)
309 (modify-syntax-entry ?' "w" st)
310 (modify-syntax-entry ?@ "_" st)
311 (modify-syntax-entry ?* "_" st)
312 (modify-syntax-entry ?\t " " st)
313 ;; ~ is printed by TeX as a space, but it's semantics in the syntax
314 ;; of TeX is not `whitespace' (i.e. it's just like \hspace{foo}).
315 (modify-syntax-entry ?~ "." st)
316 (modify-syntax-entry ?$ "$$" st)
317 (modify-syntax-entry ?\\ "/" st)
318 (modify-syntax-entry ?\" "." st)
319 (modify-syntax-entry ?& "." st)
320 (modify-syntax-entry ?_ "." st)
321 (modify-syntax-entry ?^ "." st)
323 "Syntax table used while in TeX mode.")
329 (defcustom latex-imenu-indent-string ". "
330 "String to add repeated in front of nested sectional units for Imenu.
331 An alternative value is \" . \", if you use a font with a narrow period."
335 (defvar latex-section-alist
336 '(("part" . 0) ("chapter" . 1)
337 ("section" . 2) ("subsection" . 3)
338 ("subsubsection" . 4)
339 ("paragraph" . 5) ("subparagraph" . 6)))
341 (defvar latex-metasection-list
342 '("documentstyle" "documentclass"
343 "begin{document}" "end{document}"
344 "appendix" "frontmatter" "mainmatter" "backmatter"))
346 (defun latex-imenu-create-index ()
347 "Generate an alist for imenu from a LaTeX buffer."
348 (let ((section-regexp
349 (concat "\\\\" (regexp-opt (mapcar 'car latex-section-alist) t)
352 (concat "\\\\" (regexp-opt latex-metasection-list t)))
353 i0 menu case-fold-search)
355 ;; Find the top-most level in this file but don't allow it to be
356 ;; any deeper than "section" (which is top-level in an article).
357 (goto-char (point-min))
358 (if (search-forward-regexp "\\\\part\\*?[ \t]*{" nil t)
360 (if (search-forward-regexp "\\\\chapter\\*?[ \t]*{" nil t)
364 ;; Look for chapters and sections.
365 (goto-char (point-min))
366 (while (search-forward-regexp section-regexp nil t)
367 (let ((start (match-beginning 0))
369 (i (cdr (assoc (buffer-substring-no-properties
372 latex-section-alist))))
376 ;; Using sexps allows some use of matching {...} inside
379 (push (cons (concat (apply 'concat
382 latex-imenu-indent-string))
383 (buffer-substring-no-properties
389 ;; Look for included material.
390 (goto-char (point-min))
391 (while (search-forward-regexp
392 "\\\\\\(include\\|input\\|verbatiminput\\|bibliography\\)\
393 \[ \t]*{\\([^}\n]+\\)}"
395 (push (cons (concat "<<" (buffer-substring-no-properties
398 (if (= (char-after (match-beginning 1)) ?b)
404 ;; Look for \frontmatter, \mainmatter, \backmatter, and \appendix.
405 (goto-char (point-min))
406 (while (search-forward-regexp metasection-regexp nil t)
407 (push (cons "--" (match-beginning 0)) menu))
409 ;; Sort in increasing buffer position order.
410 (sort menu (function (lambda (a b) (< (cdr a) (cdr b))))))))
416 (defvar latex-outline-regexp
418 (regexp-opt (append latex-metasection-list
419 (mapcar 'car latex-section-alist)) t)))
421 (defun latex-outline-level ()
422 (if (looking-at latex-outline-regexp)
423 (1+ (or (cdr (assoc (match-string 1) latex-section-alist)) -1))
427 ;;;; Font-Lock support
430 ;(defvar tex-font-lock-keywords
431 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
432 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
433 ; 2 font-lock-function-name-face)
434 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
435 ; 2 font-lock-constant-face)
436 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
437 ; ;; not be able to display those fonts.
438 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
439 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
440 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
441 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
442 ; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
443 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
444 ; 2 font-lock-function-name-face)
445 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
446 ; 2 font-lock-constant-face)
447 ; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
448 ; "\\\\\\([a-zA-Z@]+\\|.\\)"
449 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
450 ; ;; not be able to display those fonts.
451 ; ;; LaTeX2e: \emph{This is emphasized}.
452 ; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
453 ; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
454 ; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
455 ; 3 (if (match-beginning 2) 'bold 'italic) keep)
456 ; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
457 ; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
458 ; 3 (if (match-beginning 2) 'bold 'italic) keep))
460 ;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
461 (defconst tex-font-lock-keywords-1
463 (let* (;; Names of commands whose arg should be fontified as heading, etc.
464 (headings (regexp-opt
465 '("title" "begin" "end" "chapter" "part"
466 "section" "subsection" "subsubsection"
467 "paragraph" "subparagraph" "subsubparagraph"
468 "newcommand" "renewcommand" "providecommand"
469 "newenvironment" "renewenvironment"
470 "newtheorem" "renewtheorem")
472 (variables (regexp-opt
473 '("newcounter" "newcounter*" "setcounter" "addtocounter"
474 "setlength" "addtolength" "settowidth")
476 (includes (regexp-opt
477 '("input" "include" "includeonly" "bibliography"
478 "epsfig" "psfig" "epsf" "nofiles" "usepackage"
479 "documentstyle" "documentclass" "verbatiminput"
480 "includegraphics" "includegraphics*"
485 (opt " *\\(\\[[^]]*\\] *\\)*")
486 ;; This would allow highlighting \newcommand\CMD but requires
487 ;; adapting subgroup numbers below.
488 ;; (arg "\\(?:{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)\\|\\\\[a-z*]+\\)"))
489 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
491 ;; display $$ math $$
492 ;; We only mark the match between $$ and $$ because the $$ delimiters
493 ;; themselves have already been marked (along with $..$) by syntactic
494 ;; fontification. Also this is done at the very beginning so as to
495 ;; interact with the other keywords in the same way as $...$ does.
496 (list "\\$\\$\\([^$]+\\)\\$\\$" 1 'tex-math-face)
498 (list (concat slash headings "\\*?" opt arg)
499 ;; If ARG ends up matching too much (if the {} don't match, e.g.)
500 ;; jit-lock will do funny things: when updating the buffer
501 ;; the re-highlighting is only done locally so it will just
502 ;; match the local line, but defer-contextually will
503 ;; match more lines at a time, so ARG will end up matching
504 ;; a lot more, which might suddenly include a comment
505 ;; so you get things highlighted bold when you type them
506 ;; but they get turned back to normal a little while later
507 ;; because "there's already a face there".
508 ;; Using `keep' works around this un-intuitive behavior as well
509 ;; as improves the behavior in the very rare case where you do
510 ;; have a comment in ARG.
511 3 'font-lock-function-name-face 'keep)
512 (list (concat slash "\\(?:provide\\|\\(?:re\\)?new\\)command\\** *\\(\\\\[A-Za-z@]+\\)")
513 1 'font-lock-function-name-face 'keep)
515 (list (concat slash variables " *" arg) 2 'font-lock-variable-name-face)
517 (list (concat slash includes opt arg) 3 'font-lock-builtin-face)
518 ;; Definitions. I think.
519 '("^[ \t]*\\\\def *\\\\\\(\\(\\w\\|@\\)+\\)"
520 1 font-lock-function-name-face))))
521 "Subdued expressions to highlight in TeX modes.")
523 (defun tex-font-lock-append-prop (prop)
524 (unless (memq (get-text-property (match-end 1) 'face)
525 '(font-lock-comment-face tex-verbatim))
528 (defconst tex-font-lock-keywords-2
529 (append tex-font-lock-keywords-1
532 ;; Names of commands whose arg should be fontified with fonts.
533 (bold (regexp-opt '("textbf" "textsc" "textup"
534 "boldsymbol" "pmb") t))
535 (italic (regexp-opt '("textit" "textsl" "emph") t))
536 ;; FIXME: unimplemented yet.
537 ;; (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
539 ;; Names of commands whose arg should be fontified as a citation.
540 (citations (regexp-opt
541 '("label" "ref" "pageref" "vref" "eqref"
542 "cite" "nocite" "index" "glossary" "bibitem"
543 ;; natbib's two variants of \cite:
545 ;; These are text, rather than citations.
546 ;; "caption" "footnote" "footnotemark" "footnotetext"
550 ;; Names of commands that should be fontified.
551 (specials-1 (regexp-opt '("\\" "\\*") t)) ;; "-"
552 (specials-2 (regexp-opt
553 '("linebreak" "nolinebreak" "pagebreak" "nopagebreak"
554 "newline" "newpage" "clearpage" "cleardoublepage"
555 "displaybreak" "allowdisplaybreaks"
556 "enlargethispage") t))
557 (general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
561 (opt " *\\(\\[[^]]*\\] *\\)*")
562 (args "\\(\\(?:[^{}&\\]+\\|\\\\.\\|{[^}]*}\\)+\\)")
563 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
567 (list (concat slash citations opt arg) 3 'font-lock-constant-face)
569 ;; Text between `` quotes ''.
570 (cons (concat (regexp-opt `("``" "\"<" "\"`" "<<" "«") t)
571 "[^'\">{]+" ;a bit pessimistic
572 (regexp-opt `("''" "\">" "\"'" ">>" "»") t))
573 'font-lock-string-face)
575 ;; Command names, special and general.
576 (cons (concat slash specials-1) 'font-lock-warning-face)
577 (list (concat "\\(" slash specials-2 "\\)\\([^a-zA-Z@]\\|\\'\\)")
578 1 'font-lock-warning-face)
579 (concat slash general)
581 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
582 ;; since we might not be able to display those fonts.
583 (list (concat slash bold " *" arg) 2
584 '(tex-font-lock-append-prop 'bold) 'append)
585 (list (concat slash italic " *" arg) 2
586 '(tex-font-lock-append-prop 'italic) 'append)
587 ;; (list (concat slash type arg) 2 '(quote bold-italic) 'append)
589 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
590 (list (concat "\\\\\\(em\\|it\\|sl\\)\\>" args)
591 2 '(tex-font-lock-append-prop 'italic) 'append)
592 ;; This is separate from the previous one because of cases like
593 ;; {\em foo {\bf bar} bla} where both match.
594 (list (concat "\\\\\\(bf\\(series\\)?\\)\\>" args)
595 3 '(tex-font-lock-append-prop 'bold) 'append)))))
596 "Gaudy expressions to highlight in TeX modes.")
598 (defun tex-font-lock-suscript (pos)
599 (unless (or (memq (get-text-property pos 'face)
600 '(font-lock-constant-face font-lock-builtin-face
601 font-lock-comment-face tex-verbatim))
602 ;; Check for backslash quoting
605 (while (eq (char-before pos) ?\\)
606 (setq pos (1- pos) odd (not odd)))
608 (if (eq (char-after pos) ?_)
609 `(face subscript display (raise ,(car tex-font-script-display)))
610 `(face superscript display (raise ,(cadr tex-font-script-display))))))
612 (defun tex-font-lock-match-suscript (limit)
613 "Match subscript and superscript patterns up to LIMIT."
614 (when (and tex-fontify-script
615 (re-search-forward "[_^] *\\([^\n\\{}]\\|\
616 \\\\\\([a-zA-Z@]+\\|[^ \t\n]\\)\\|\\({\\)\\)" limit t))
618 (let ((beg (match-beginning 3))
619 (end (save-restriction
620 (narrow-to-region (point-min) limit)
621 (condition-case nil (scan-lists (point) 1 1) (error nil)))))
622 (store-match-data (if end
623 (list (match-beginning 0) end beg end)
624 (list beg beg beg beg)))))
627 (defconst tex-font-lock-keywords-3
628 (append tex-font-lock-keywords-2
629 '((tex-font-lock-match-suscript
630 (1 (tex-font-lock-suscript (match-beginning 0)) append))))
631 "Experimental expressions to highlight in TeX modes.")
633 (defvar tex-font-lock-keywords tex-font-lock-keywords-1
634 "Default expressions to highlight in TeX modes.")
636 (defvar tex-verbatim-environments
637 '("verbatim" "verbatim*"))
638 (put 'tex-verbatim-environments 'safe-local-variable
639 (lambda (x) (null (delq t (mapcar 'stringp x)))))
642 (defconst tex-syntax-propertize-rules
643 (syntax-propertize-precompile-rules
644 ("\\\\verb\\**\\([^a-z@*]\\)"
647 (match-beginning 0) (char-after (match-beginning 1))))))))
649 (defconst latex-syntax-propertize-rules
650 (syntax-propertize-precompile-rules
651 tex-syntax-propertize-rules
652 ("\\\\\\(?:end\\|begin\\) *\\({[^\n{}]*}\\)"
654 (tex-env-mark (match-beginning 0)
655 (match-beginning 1) (match-end 1))))))))
657 (defun tex-env-mark (cmd start end)
658 (when (= cmd (line-beginning-position))
659 (let ((arg (buffer-substring-no-properties (1+ start) (1- end))))
660 (when (member arg tex-verbatim-environments)
661 (if (eq ?b (char-after (1+ cmd)))
663 (put-text-property (line-end-position)
664 (line-beginning-position 2)
665 'syntax-table (string-to-syntax "< c"))
666 ;; In the case of an empty verbatim env, the \n after the \begin is
667 ;; the same as the \n before the \end. Lucky for us, the "> c"
668 ;; property associated to the \end will be placed afterwards, so it
669 ;; will override the "< c".
670 (put-text-property (1- cmd) cmd
671 'syntax-table (string-to-syntax "> c"))
672 ;; The text between \end{verbatim} and \n is ignored, so we'll treat
674 (put-text-property end (min (1+ end) (line-end-position))
675 'syntax-table (string-to-syntax "<"))))))
676 ;; Mark env args for possible electric pairing.
677 (unless (get-char-property (1+ start) 'text-clones) ;Already paired-up.
678 (put-text-property start end 'latex-env-pair t)))
680 (define-minor-mode latex-electric-env-pair-mode
681 "Automatically update the \\end arg when editing the \\begin one.
684 (if latex-electric-env-pair-mode
685 (add-hook 'before-change-functions
686 #'latex-env-before-change nil 'local)
687 (remove-hook 'before-change-functions
688 #'latex-env-before-change 'local)))
690 (defun latex-env-before-change (start end)
691 (when (get-text-property start 'latex-env-pair)
693 (with-silent-modifications
694 ;; Remove properties even if don't find a pair.
695 (remove-text-properties
696 (previous-single-property-change (1+ start) 'latex-env-pair)
697 (next-single-property-change start 'latex-env-pair)
699 (unless (or (get-char-property start 'text-clones)
700 (get-char-property (1+ start) 'text-clones)
703 (not (re-search-backward
704 "\\\\\\(?:end\\|begi\\(n\\)\\) *{"
705 (line-beginning-position) t))))
706 (let ((cmd-start (match-beginning 0))
707 (type (match-end 1)) ;nil for \end, else \begin.
708 (arg-start (1- (match-end 0))))
710 (goto-char (match-end 0))
711 (when (and (looking-at "[^\n{}]*}")
712 (> (match-end 0) end))
713 (let ((arg-end (match-end 0)))
714 (if (null type) ;\end
715 (progn (goto-char arg-end)
716 (latex-forward-sexp -1) (forward-word 1))
717 (goto-char cmd-start)
718 (latex-forward-sexp 1)
719 (let (forward-sexp-function) (backward-sexp)))
721 (regexp-quote (buffer-substring arg-start arg-end)))
722 (text-clone-create arg-start arg-end))))))))
724 (error (message "Error in latex-env-before-change: %s" err)))))
726 (defun tex-font-lock-unfontify-region (beg end)
727 (font-lock-default-unfontify-region beg end)
729 (let ((next (next-single-property-change beg 'display nil end))
730 (prop (get-text-property beg 'display)))
731 (if (and (eq (car-safe prop) 'raise)
732 (member (car-safe (cdr prop)) tex-font-script-display)
734 (put-text-property beg next 'display nil))
737 (defcustom tex-suscript-height-ratio 0.8
738 "Ratio of subscript/superscript height to that of the preceding text.
739 In nested subscript/superscript, this factor is applied repeatedly,
740 subject to the limit set by `tex-suscript-height-minimum'."
745 (defcustom tex-suscript-height-minimum 0.0
746 "Integer or float limiting the minimum size of subscript/superscript text.
747 An integer is an absolute height in units of 1/10 point, a float
748 is a height relative to that of the default font. Zero means no minimum."
749 :type '(choice (integer :tag "Integer height in 1/10 point units")
750 (float :tag "Fraction of default font height"))
754 (defun tex-suscript-height (height)
755 "Return the integer height of subscript/superscript font in 1/10 points.
756 Not smaller than the value set by `tex-suscript-height-minimum'."
757 (ceiling (max (if (integerp tex-suscript-height-minimum)
758 tex-suscript-height-minimum
759 ;; For bootstrapping.
761 (* tex-suscript-height-minimum
762 (face-attribute 'default :height))
764 ;; NB assumes height is integer.
765 (* height tex-suscript-height-ratio))))
768 '((t :height tex-suscript-height)) ;; :raise 0.2
769 "Face used for superscripts."
772 '((t :height tex-suscript-height)) ;; :raise -0.2
773 "Face used for subscripts."
777 '((t :inherit font-lock-string-face))
778 "Face used to highlight TeX math expressions."
780 (define-obsolete-face-alias 'tex-math-face 'tex-math "22.1")
781 (defvar tex-math-face 'tex-math)
783 (defface tex-verbatim
784 ;; '((t :inherit font-lock-string-face))
785 '((t :family "courier"))
786 "Face used to highlight TeX verbatim environments."
788 (define-obsolete-face-alias 'tex-verbatim-face 'tex-verbatim "22.1")
789 (defvar tex-verbatim-face 'tex-verbatim)
791 (defun tex-font-lock-verb (start delim)
792 "Place syntax table properties on the \verb construct.
793 START is the position of the \\ and DELIM is the delimiter char."
794 ;; Do nothing if the \verb construct is itself inside a comment or
796 (unless (nth 8 (save-excursion (syntax-ppss start)))
797 ;; Let's find the end and mark it.
798 (let ((afterdelim (point)))
799 (skip-chars-forward (string ?^ delim) (line-end-position))
801 ;; "LaTeX Error: \verb ended by end of line."
802 ;; Remove the syntax-table property we've just put on the
803 ;; start-delimiter, so it doesn't spill over subsequent lines.
804 (put-text-property (1- afterdelim) afterdelim
806 (when (eq (char-syntax (preceding-char)) ?/)
807 (put-text-property (1- (point)) (point)
808 'syntax-table (string-to-syntax ".")))
809 (put-text-property (point) (1+ (point))
810 'syntax-table (string-to-syntax "\""))))))
812 ;; Use string syntax but math face for $...$.
813 (defun tex-font-lock-syntactic-face-function (state)
814 (let ((char (nth 3 state)))
817 (if (eq 2 (nth 7 state)) tex-verbatim-face font-lock-comment-face))
818 ((eq char ?$) tex-math-face)
820 (t tex-verbatim-face))))
823 (defun tex-define-common-keys (keymap)
824 "Define the keys that we want defined both in TeX mode and in the TeX shell."
825 (define-key keymap "\C-c\C-k" 'tex-kill-job)
826 (define-key keymap "\C-c\C-l" 'tex-recenter-output-buffer)
827 (define-key keymap "\C-c\C-q" 'tex-show-print-queue)
828 (define-key keymap "\C-c\C-p" 'tex-print)
829 (define-key keymap "\C-c\C-v" 'tex-view)
831 (define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
833 (define-key keymap [menu-bar tex tex-kill-job]
834 '(menu-item "Tex Kill" tex-kill-job :enable (tex-shell-running)))
835 (define-key keymap [menu-bar tex tex-recenter-output-buffer]
836 '(menu-item "Tex Recenter" tex-recenter-output-buffer
837 :enable (get-buffer "*tex-shell*")))
838 (define-key keymap [menu-bar tex tex-show-print-queue]
839 '("Show Print Queue" . tex-show-print-queue))
840 (define-key keymap [menu-bar tex tex-alt-print]
841 '(menu-item "Tex Print (alt printer)" tex-alt-print
842 :enable (stringp tex-print-file)))
843 (define-key keymap [menu-bar tex tex-print]
844 '(menu-item "Tex Print" tex-print :enable (stringp tex-print-file)))
845 (define-key keymap [menu-bar tex tex-view]
846 '(menu-item "Tex View" tex-view :enable (stringp tex-print-file))))
849 (let ((map (make-sparse-keymap)))
850 (set-keymap-parent map text-mode-map)
851 (tex-define-common-keys map)
852 (define-key map "\"" 'tex-insert-quote)
853 (define-key map "(" 'skeleton-pair-insert-maybe)
854 (define-key map "{" 'skeleton-pair-insert-maybe)
855 (define-key map "[" 'skeleton-pair-insert-maybe)
856 (define-key map "$" 'skeleton-pair-insert-maybe)
857 (define-key map "\n" 'tex-terminate-paragraph)
858 (define-key map "\M-\r" 'latex-insert-item)
859 (define-key map "\C-c}" 'up-list)
860 (define-key map "\C-c{" 'tex-insert-braces)
861 (define-key map "\C-c\C-r" 'tex-region)
862 (define-key map "\C-c\C-b" 'tex-buffer)
863 (define-key map "\C-c\C-f" 'tex-file)
864 (define-key map "\C-c\C-c" 'tex-compile)
865 (define-key map "\C-c\C-i" 'tex-bibtex-file)
866 (define-key map "\C-c\C-o" 'latex-insert-block)
868 ;; Redundant keybindings, for consistency with SGML mode.
869 (define-key map "\C-c\C-t" 'latex-insert-block)
870 (define-key map "\C-c]" 'latex-close-block)
871 (define-key map "\C-c/" 'latex-close-block)
873 (define-key map "\C-c\C-e" 'latex-close-block)
874 (define-key map "\C-c\C-u" 'tex-goto-last-unclosed-latex-block)
875 (define-key map "\C-c\C-m" 'tex-feed-input)
876 (define-key map [(control return)] 'tex-feed-input)
877 (define-key map [menu-bar tex tex-bibtex-file]
878 '("BibTeX File" . tex-bibtex-file))
879 (define-key map [menu-bar tex tex-validate-region]
880 '(menu-item "Validate Region" tex-validate-region :enable mark-active))
881 (define-key map [menu-bar tex tex-validate-buffer]
882 '("Validate Buffer" . tex-validate-buffer))
883 (define-key map [menu-bar tex tex-region]
884 '(menu-item "TeX Region" tex-region :enable mark-active))
885 (define-key map [menu-bar tex tex-buffer]
886 '("TeX Buffer" . tex-buffer))
887 (define-key map [menu-bar tex tex-file] '("TeX File" . tex-file))
889 "Keymap shared by TeX modes.")
891 (defvar latex-mode-map
892 (let ((map (make-sparse-keymap)))
893 (set-keymap-parent map tex-mode-map)
894 (define-key map "\C-c\C-s" 'latex-split-block)
896 "Keymap for `latex-mode'. See also `tex-mode-map'.")
898 (defvar plain-tex-mode-map
899 (let ((map (make-sparse-keymap)))
900 (set-keymap-parent map tex-mode-map)
902 "Keymap for `plain-tex-mode'. See also `tex-mode-map'.")
904 (defvar tex-shell-map
905 (let ((m (make-sparse-keymap)))
906 (set-keymap-parent m shell-mode-map)
907 (tex-define-common-keys m)
909 "Keymap for the TeX shell.
910 Inherits `shell-mode-map' with a few additions.")
912 (defvar tex-face-alist
915 (bold-italic . "{\\bi ") ; hypothetical
916 (underline . "\\underline{")
917 (default . "{\\rm "))
918 "Alist of face and TeX font name for facemenu.")
920 (defvar tex-latex-face-alist
921 `((italic . "{\\em ")
923 "Alist of face and LaTeX font name for facemenu.")
925 (defun tex-facemenu-add-face-function (face end)
926 (or (cdr (assq face tex-face-alist))
927 (or (and (consp face)
930 (eq major-mode 'latex-mode)
931 ;; This actually requires the `color' LaTeX package.
932 (cond ((eq (caar face) :foreground)
933 (format "{\\color{%s} " (cadr (car face))))
934 ((eq (caar face) :background)
935 (format "\\colorbox{%s}{" (cadr (car face))))))
936 (error "Face %s not configured for %s mode" face mode-name))))
938 ;; This would be a lot simpler if we just used a regexp search,
939 ;; but then it would be too slow.
940 (defun tex-guess-mode ()
941 (let ((mode tex-default-mode) slash comment)
943 (goto-char (point-min))
944 (while (and (setq slash (search-forward "\\" nil t))
945 (setq comment (let ((search-end (point)))
948 (search-forward "%" search-end t))))))
949 (when (and slash (not comment))
954 (regexp-opt '("documentstyle" "documentclass"
955 "begin" "subsection" "section"
956 "part" "chapter" "newcommand"
957 "renewcommand" "RequirePackage") 'words)
958 "\\|NeedsTeXFormat{LaTeX")))
960 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
961 ;; SliTeX is almost never used any more nowadays.
962 (tex-executable-exists-p slitex-run-command))
968 ;; `tex-mode' plays two roles: it's the parent of several sub-modes
969 ;; but it's also the function that chooses between those submodes.
970 ;; To tell the difference between those two cases where the function
971 ;; might be called, we check `delay-mode-hooks'.
972 (define-derived-mode tex-mode text-mode "generic-TeX"
973 (tex-common-initialization))
974 ;; We now move the function and define it again. This gives a warning
975 ;; in the byte-compiler :-( but it's difficult to avoid because
976 ;; `define-derived-mode' will necessarily define the function once
977 ;; and we need to define it a second time for `autoload' to get the
979 (defalias 'tex-mode-internal (symbol-function 'tex-mode))
981 ;; Suppress the byte-compiler warning about multiple definitions.
982 ;; This is a) ugly, and b) cheating, but this was the last
983 ;; remaining warning from byte-compiling all of Emacs...
985 (setq byte-compile-function-environment
986 (delq (assq 'tex-mode byte-compile-function-environment)
987 byte-compile-function-environment)))
991 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
992 Tries to determine (by looking at the beginning of the file) whether
993 this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
994 `latex-mode', or `slitex-mode', respectively. If it cannot be determined,
995 such as if there are no commands in the file, the value of `tex-default-mode'
996 says which mode to use."
999 ;; We're called from one of the children already.
1003 ;; The following three autoloaded aliases appear to conflict with
1004 ;; AUCTeX. However, even though AUCTeX uses the mixed case variants
1005 ;; for all mode relevant variables and hooks, the invocation function
1006 ;; and setting of `major-mode' themselves need to be lowercase for
1007 ;; AUCTeX to provide a fully functional user-level replacement. So
1008 ;; these aliases should remain as they are, in particular since AUCTeX
1009 ;; users are likely to use them.
1012 (defalias 'TeX-mode 'tex-mode)
1014 (defalias 'plain-TeX-mode 'plain-tex-mode)
1016 (defalias 'LaTeX-mode 'latex-mode)
1019 (define-derived-mode plain-tex-mode tex-mode "TeX"
1020 "Major mode for editing files of input for plain TeX.
1021 Makes $ and } display the characters they match.
1022 Makes \" insert `` when it seems to be the beginning of a quotation,
1023 and '' when it appears to be the end; it inserts \" only after a \\.
1025 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
1026 copied from the top of the file (containing macro definitions, etc.),
1027 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
1028 \\[tex-file] saves the buffer and then processes the file.
1029 \\[tex-print] prints the .dvi file made by any of these.
1030 \\[tex-view] previews the .dvi file made by any of these.
1031 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1033 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
1034 mismatched $'s or braces.
1037 \\{plain-tex-mode-map}
1041 Command string used by \\[tex-region] or \\[tex-buffer].
1043 Directory in which to create temporary files for TeX jobs
1044 run by \\[tex-region] or \\[tex-buffer].
1045 tex-dvi-print-command
1046 Command string used by \\[tex-print] to print a .dvi file.
1047 tex-alt-dvi-print-command
1048 Alternative command string used by \\[tex-print] (when given a prefix
1049 argument) to print a .dvi file.
1050 tex-dvi-view-command
1051 Command string used by \\[tex-view] to preview a .dvi file.
1052 tex-show-queue-command
1053 Command string used by \\[tex-show-print-queue] to show the print
1054 queue that \\[tex-print] put your job on.
1056 Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
1057 `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
1058 special subshell is initiated, the hook `tex-shell-hook' is run."
1059 (set (make-local-variable 'tex-command) tex-run-command)
1060 (set (make-local-variable 'tex-start-of-header) "%\\*\\*start of header")
1061 (set (make-local-variable 'tex-end-of-header) "%\\*\\*end of header")
1062 (set (make-local-variable 'tex-trailer) "\\bye\n"))
1065 (define-derived-mode latex-mode tex-mode "LaTeX"
1066 "Major mode for editing files of input for LaTeX.
1067 Makes $ and } display the characters they match.
1068 Makes \" insert `` when it seems to be the beginning of a quotation,
1069 and '' when it appears to be the end; it inserts \" only after a \\.
1071 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
1072 copied from the top of the file (containing \\documentstyle, etc.),
1073 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
1074 \\[tex-file] saves the buffer and then processes the file.
1075 \\[tex-print] prints the .dvi file made by any of these.
1076 \\[tex-view] previews the .dvi file made by any of these.
1077 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1079 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
1080 mismatched $'s or braces.
1087 Command string used by \\[tex-region] or \\[tex-buffer].
1089 Directory in which to create temporary files for LaTeX jobs
1090 run by \\[tex-region] or \\[tex-buffer].
1091 tex-dvi-print-command
1092 Command string used by \\[tex-print] to print a .dvi file.
1093 tex-alt-dvi-print-command
1094 Alternative command string used by \\[tex-print] (when given a prefix
1095 argument) to print a .dvi file.
1096 tex-dvi-view-command
1097 Command string used by \\[tex-view] to preview a .dvi file.
1098 tex-show-queue-command
1099 Command string used by \\[tex-show-print-queue] to show the print
1100 queue that \\[tex-print] put your job on.
1102 Entering Latex mode runs the hook `text-mode-hook', then
1103 `tex-mode-hook', and finally `latex-mode-hook'. When the special
1104 subshell is initiated, `tex-shell-hook' is run."
1105 (set (make-local-variable 'tex-command) latex-run-command)
1106 (set (make-local-variable 'tex-start-of-header)
1107 "\\\\document\\(style\\|class\\)")
1108 (set (make-local-variable 'tex-end-of-header) "\\\\begin\\s-*{document}")
1109 (set (make-local-variable 'tex-trailer) "\\end{document}\n")
1110 ;; A line containing just $$ is treated as a paragraph separator.
1111 ;; A line starting with $$ starts a paragraph,
1112 ;; but does not separate paragraphs if it has more stuff on it.
1113 (setq paragraph-start
1114 (concat "[ \t]*\\(\\$\\$\\|"
1116 "\\\\" (regexp-opt (append
1117 (mapcar 'car latex-section-alist)
1118 '("begin" "label" "end"
1119 "item" "bibitem" "newline" "noindent"
1120 "newpage" "footnote" "marginpar"
1121 "parbox" "caption")) t)
1122 "\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t)
1124 (setq paragraph-separate
1125 (concat "[\f%]\\|[ \t]*\\($\\|"
1127 "\\\\" (regexp-opt (append
1128 (mapcar 'car latex-section-alist)
1129 '("begin" "label" "end" )) t)
1130 "\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
1131 "noindent" "newpage" "footnote"
1132 "marginpar" "parbox" "caption"))
1133 "\\|\\$\\$\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
1134 "\\>\\)[ \t]*\\($\\|%\\)\\)"))
1135 (set (make-local-variable 'imenu-create-index-function)
1136 'latex-imenu-create-index)
1137 (set (make-local-variable 'tex-face-alist) tex-latex-face-alist)
1138 (add-hook 'fill-nobreak-predicate 'latex-fill-nobreak-predicate nil t)
1139 (set (make-local-variable 'indent-line-function) 'latex-indent)
1140 (set (make-local-variable 'fill-indent-according-to-mode) t)
1141 (add-hook 'completion-at-point-functions
1142 'latex-complete-data nil 'local)
1143 (set (make-local-variable 'outline-regexp) latex-outline-regexp)
1144 (set (make-local-variable 'outline-level) 'latex-outline-level)
1145 (set (make-local-variable 'forward-sexp-function) 'latex-forward-sexp)
1146 (set (make-local-variable 'skeleton-end-hook) nil))
1149 (define-derived-mode slitex-mode latex-mode "SliTeX"
1150 "Major mode for editing files of input for SliTeX.
1151 Makes $ and } display the characters they match.
1152 Makes \" insert `` when it seems to be the beginning of a quotation,
1153 and '' when it appears to be the end; it inserts \" only after a \\.
1155 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
1156 copied from the top of the file (containing \\documentstyle, etc.),
1157 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
1158 \\[tex-file] saves the buffer and then processes the file.
1159 \\[tex-print] prints the .dvi file made by any of these.
1160 \\[tex-view] previews the .dvi file made by any of these.
1161 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1163 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
1164 mismatched $'s or braces.
1171 Command string used by \\[tex-region] or \\[tex-buffer].
1173 Directory in which to create temporary files for SliTeX jobs
1174 run by \\[tex-region] or \\[tex-buffer].
1175 tex-dvi-print-command
1176 Command string used by \\[tex-print] to print a .dvi file.
1177 tex-alt-dvi-print-command
1178 Alternative command string used by \\[tex-print] (when given a prefix
1179 argument) to print a .dvi file.
1180 tex-dvi-view-command
1181 Command string used by \\[tex-view] to preview a .dvi file.
1182 tex-show-queue-command
1183 Command string used by \\[tex-show-print-queue] to show the print
1184 queue that \\[tex-print] put your job on.
1186 Entering SliTeX mode runs the hook `text-mode-hook', then the hook
1187 `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
1188 `slitex-mode-hook'. When the special subshell is initiated, the hook
1189 `tex-shell-hook' is run."
1190 (setq tex-command slitex-run-command)
1191 (setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
1193 (defun tex-common-initialization ()
1194 ;; Regexp isearch should accept newline and formfeed as whitespace.
1195 (set (make-local-variable 'search-whitespace-regexp) "[ \t\r\n\f]+")
1196 ;; A line containing just $$ is treated as a paragraph separator.
1197 (set (make-local-variable 'paragraph-start)
1198 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
1199 ;; A line starting with $$ starts a paragraph,
1200 ;; but does not separate paragraphs if it has more stuff on it.
1201 (set (make-local-variable 'paragraph-separate)
1202 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
1203 (set (make-local-variable 'comment-start) "%")
1204 (set (make-local-variable 'comment-add) 1)
1205 (set (make-local-variable 'comment-start-skip)
1206 "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
1207 (set (make-local-variable 'parse-sexp-ignore-comments) t)
1208 (set (make-local-variable 'compare-windows-whitespace)
1209 'tex-categorize-whitespace)
1210 (set (make-local-variable 'facemenu-add-face-function)
1211 'tex-facemenu-add-face-function)
1212 (set (make-local-variable 'facemenu-end-add-face) "}")
1213 (set (make-local-variable 'facemenu-remove-face-function) t)
1214 (set (make-local-variable 'font-lock-defaults)
1215 '((tex-font-lock-keywords tex-font-lock-keywords-1
1216 tex-font-lock-keywords-2 tex-font-lock-keywords-3)
1217 nil nil ((?$ . "\"")) nil
1218 ;; Who ever uses that anyway ???
1219 (font-lock-mark-block-function . mark-paragraph)
1220 (font-lock-syntactic-face-function
1221 . tex-font-lock-syntactic-face-function)
1222 (font-lock-unfontify-region-function
1223 . tex-font-lock-unfontify-region)))
1224 (set (make-local-variable 'syntax-propertize-function)
1225 (syntax-propertize-rules latex-syntax-propertize-rules))
1226 ;; TABs in verbatim environments don't do what you think.
1227 (set (make-local-variable 'indent-tabs-mode) nil)
1228 ;; Other vars that should be buffer-local.
1229 (make-local-variable 'tex-command)
1230 (make-local-variable 'tex-start-of-header)
1231 (make-local-variable 'tex-end-of-header)
1232 (make-local-variable 'tex-trailer))
1234 (defun tex-categorize-whitespace (backward-limit)
1235 ;; compare-windows-whitespace is set to this.
1236 ;; This is basically a finite-state machine.
1237 ;; Returns a symbol telling how TeX would treat
1238 ;; the whitespace we are looking at: null, space, or par.
1239 (let ((category 'null)
1241 (skip-chars-backward " \t\n\f" backward-limit)
1243 (cond ((looking-at "[ \t]+")
1244 (goto-char (match-end 0))
1245 (if (eq category 'null)
1246 (setq category 'space)))
1248 (cond ((eq category 'newline)
1249 (setq category 'par)
1250 (setq not-finished nil))
1252 (setq category 'newline) ;a strictly internal state
1253 (goto-char (match-end 0)))))
1255 (setq category 'par)
1256 (setq not-finished nil))
1258 (setq not-finished nil))))
1259 (skip-chars-forward " \t\n\f")
1260 (if (eq category 'newline)
1261 'space ;TeX doesn't distinguish
1264 (defun tex-insert-quote (arg)
1265 "Insert the appropriate quote marks for TeX.
1266 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
1267 \(normally '') depending on the context. With prefix argument, always
1268 inserts \" characters."
1270 (if (or arg (memq (char-syntax (preceding-char)) '(?/ ?\\))
1271 (eq (get-text-property (point) 'face) 'tex-verbatim)
1273 (backward-char (length tex-open-quote))
1274 (when (or (looking-at (regexp-quote tex-open-quote))
1275 (looking-at (regexp-quote tex-close-quote)))
1276 (delete-char (length tex-open-quote))
1278 (self-insert-command (prefix-numeric-value arg))
1279 (insert (if (memq (char-syntax (preceding-char)) '(?\( ?> ?\s))
1280 tex-open-quote tex-close-quote))))
1282 (defun tex-validate-buffer ()
1283 "Check current buffer for paragraphs containing mismatched braces or $s.
1284 Their positions are recorded in the buffer `*Occur*'.
1285 To find a particular invalidity from `*Occur*', switch to that buffer
1286 and type C-c C-c or click with mouse-2
1287 on the line for the invalidity you want to see."
1289 (let ((buffer (current-buffer))
1290 (prevpos (point-min))
1293 (with-output-to-temp-buffer "*Occur*"
1294 (princ "Mismatches:\n")
1295 (with-current-buffer standard-output
1297 ;; This won't actually work...Really, this whole thing should
1298 ;; be rewritten instead of being a hack on top of occur.
1299 (setq occur-revert-arguments (list nil 0 (list buffer))))
1301 (goto-char (point-max))
1302 ;; Do a little shimmy to place point at the end of the last
1303 ;; "real" paragraph. Need to avoid validating across an \end,
1304 ;; because that blows up latex-forward-sexp.
1305 (backward-paragraph)
1308 ;; Scan the previous paragraph for invalidities.
1309 (backward-paragraph)
1311 (or (tex-validate-region (point) (save-excursion
1314 (let ((end (line-beginning-position 2))
1317 (setq start (point))
1318 ;; Keep track of line number as we scan,
1319 ;; in a cumulative fashion.
1321 (setq linenum (- linenum
1322 (count-lines prevpos (point))))
1323 (setq linenum (1+ (count-lines 1 start))))
1324 (setq prevpos (point))
1325 ;; Mention this mismatch in *Occur*.
1326 ;; Since we scan from end of buffer to beginning,
1327 ;; add each mismatch at the beginning of *Occur*.
1329 (setq tem (point-marker))
1330 (set-buffer standard-output)
1331 (goto-char (point-min))
1332 ;; Skip "Mismatches:" header line.
1334 (setq num-matches (1+ num-matches))
1335 (insert-buffer-substring buffer start end)
1336 (let (text-beg (text-end (point-marker)))
1337 (forward-char (- start end))
1338 (setq text-beg (point-marker))
1339 (insert (format "%3d: " linenum))
1340 (add-text-properties
1341 text-beg (- text-end 1)
1342 '(mouse-face highlight
1344 "mouse-2: go to this invalidity"))
1345 (put-text-property text-beg (- text-end 1)
1346 'occur-target tem))))))))
1347 (with-current-buffer standard-output
1348 (let ((no-matches (zerop num-matches)))
1351 (if (called-interactively-p 'interactive)
1352 (message (cond (no-matches "No mismatches found")
1353 ((= num-matches 1) "1 mismatch found")
1354 (t "%d mismatches found"))
1357 (defun tex-validate-region (start end)
1358 "Check for mismatched braces or $'s in region.
1359 Returns t if no mismatches. Returns nil and moves point to suspect
1360 area if a mismatch is found."
1362 (let ((failure-point nil) (max-possible-sexps (- end start)))
1366 (narrow-to-region start end)
1367 ;; First check that the open and close parens balance in numbers.
1369 (while (and (not (eobp))
1370 (<= 0 (setq max-possible-sexps
1371 (1- max-possible-sexps))))
1373 ;; Now check that like matches like.
1375 (while (re-search-forward "\\s(" nil t)
1377 (let ((pos (match-beginning 0)))
1379 (skip-chars-backward "\\\\") ; escaped parens
1381 (or (eq (preceding-char) (cdr (syntax-after pos)))
1382 (eq (char-after pos) (cdr (syntax-after (1- (point)))))
1383 (error "Mismatched parentheses"))))))
1385 (skip-syntax-forward " .>")
1386 (setq failure-point (point)))))
1387 (if failure-point (goto-char failure-point))
1388 (not failure-point)))
1390 (defun tex-terminate-paragraph (inhibit-validation)
1391 "Insert two newlines, breaking a paragraph for TeX.
1392 Check for mismatched braces or $s in paragraph being terminated.
1393 A prefix arg inhibits the checking."
1395 (or inhibit-validation
1397 ;; For the purposes of this, a "paragraph" is a block of text
1398 ;; wherein all the brackets etc are expected to be balanced. It
1399 ;; may start after a blank line (ie a "proper" paragraph), or
1400 ;; a begin{} or end{} block, etc.
1401 (tex-validate-region
1403 (backward-paragraph)
1406 (message "Paragraph being closed appears to contain a mismatch"))
1409 (define-skeleton tex-insert-braces
1410 "Make a pair of braces and be poised to type inside of them."
1414 ;; This function is used as the value of fill-nobreak-predicate
1415 ;; in LaTeX mode. Its job is to prevent line-breaking inside
1416 ;; of a \verb construct.
1417 (defun latex-fill-nobreak-predicate ()
1419 (skip-chars-backward " ")
1420 ;; Don't break after \ since `\ ' has special meaning.
1421 (or (and (not (bobp)) (memq (char-syntax (char-before)) '(?\\ ?/)))
1422 (let ((opoint (point))
1425 (while (re-search-forward "\\\\verb\\(.\\)" opoint t)
1426 (unless (re-search-forward (regexp-quote (match-string 1)) opoint t)
1430 (defvar latex-block-default "enumerate")
1432 (defvar latex-block-args-alist
1433 '(("array" nil ?\{ (skeleton-read "Format: ") ?\})
1434 ("tabular" nil ?\{ (skeleton-read "Format: ") ?\})
1435 ("minipage" nil ?\{ (skeleton-read "Size: ") ?\})
1436 ("picture" nil ?\( (skeleton-read "SizeX,SizeY: ") ?\))
1437 ;; FIXME: This is right for Prosper, but not for seminar.
1438 ;; ("slide" nil ?\{ (skeleton-read "Title: ") ?\})
1440 "Skeleton element to use for arguments to particular environments.
1441 Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1442 the name of the environment and SKEL-ELEM is an element to use in
1443 a skeleton (see `skeleton-insert').")
1445 (defvar latex-block-body-alist
1446 '(("enumerate" nil '(latex-insert-item) > _)
1447 ("itemize" nil '(latex-insert-item) > _)
1448 ("table" nil "\\caption{" > (skeleton-read "Caption: ") "}" > \n
1449 '(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "table"))
1451 ("figure" nil > _ \n "\\caption{" > (skeleton-read "Caption: ") "}" > \n
1452 '(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "table"))))
1453 "Skeleton element to use for the body of particular environments.
1454 Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1455 the name of the environment and SKEL-ELEM is an element to use in
1456 a skeleton (see `skeleton-insert').")
1458 ;; Like tex-insert-braces, but for LaTeX.
1459 (defalias 'tex-latex-block 'latex-insert-block)
1460 (define-skeleton latex-insert-block
1461 "Create a matching pair of lines \\begin{NAME} and \\end{NAME} at point.
1462 Puts point on a blank line between them."
1463 (let ((choice (completing-read (format "LaTeX block name [%s]: "
1464 latex-block-default)
1465 (append latex-block-names
1466 latex-standard-block-names)
1467 nil nil nil nil latex-block-default)))
1468 (setq latex-block-default choice)
1469 (unless (or (member choice latex-standard-block-names)
1470 (member choice latex-block-names))
1471 ;; Remember new block names for later completion.
1472 (push choice latex-block-names))
1474 \n "\\begin{" str "}"
1475 (cdr (assoc str latex-block-args-alist))
1476 > \n (or (cdr (assoc str latex-block-body-alist)) '(nil > _))
1478 "\\end{" str "}" > \n)
1480 (define-skeleton latex-insert-item
1481 "Insert a \item macro."
1486 ;;;; LaTeX completion.
1488 (defvar latex-complete-bibtex-cache nil)
1490 (defun latex-string-prefix-p (str1 str2)
1491 (eq t (compare-strings str1 nil nil str2 0 (length str1))))
1493 (defvar bibtex-reference-key)
1494 (declare-function reftex-get-bibfile-list "reftex-cite.el" ())
1496 (defun latex-complete-bibtex-keys ()
1497 (when (bound-and-true-p reftex-mode)
1498 (lambda (key pred action)
1499 (let ((re (concat "^[ \t]*@\\([a-zA-Z]+\\)[ \t\n]*\\([{(][ \t\n]*\\)"
1500 (regexp-quote key)))
1501 (files (reftex-get-bibfile-list))
1503 (if (and (eq (car latex-complete-bibtex-cache)
1504 (reftex-get-bibfile-list))
1505 (latex-string-prefix-p (nth 1 latex-complete-bibtex-cache)
1508 (setq keys (nth 2 latex-complete-bibtex-cache))
1509 (dolist (file files)
1510 (with-current-buffer (find-file-noselect file)
1511 (goto-char (point-min))
1512 (while (re-search-forward re nil t)
1513 (goto-char (match-end 2))
1514 (when (and (not (member-ignore-case (match-string 1)
1515 '("c" "comment" "string")))
1516 (looking-at bibtex-reference-key))
1517 (push (match-string-no-properties 0) keys)))))
1519 (set (make-local-variable 'latex-complete-bibtex-cache)
1520 (list files key keys)))
1521 (complete-with-action action keys key pred)))))
1523 (defun latex-complete-envnames ()
1524 (append latex-block-names latex-standard-block-names))
1526 (defun latex-complete-refkeys ()
1527 (when (boundp 'reftex-docstruct-symbol)
1528 (symbol-value reftex-docstruct-symbol)))
1530 (defvar latex-complete-alist
1531 ;; TODO: Add \begin, \end, \ref, ...
1532 '(("\\`\\\\\\(short\\)?cite\\'" . latex-complete-bibtex-keys)
1533 ("\\`\\\\\\(begin\\|end\\)\\'" . latex-complete-envnames)
1534 ("\\`\\\\[vf]?ref\\'" . latex-complete-refkeys)))
1536 (defun latex-complete-data ()
1537 "Get completion-data at point."
1540 (skip-chars-backward "^ {}\n\t\\\\")
1542 ((nil ?\s ?\n ?\t ?\}) nil)
1544 ;; TODO: Complete commands.
1547 ;; Complete args to commands.
1551 (skip-chars-backward " \n")
1552 (buffer-substring (point)
1554 (skip-chars-backward "a-zA-Z@*")
1555 (let ((n (skip-chars-backward "\\\\")))
1556 (forward-char (* 2 (/ n 2))))
1559 (_ (progn (goto-char pt) (skip-chars-backward "^," start)))
1561 (_ (progn (goto-char pt) (skip-chars-forward "^, {}\n\t\\\\")))
1565 (let ((f (lambda () t)))
1566 (dolist (comp latex-complete-alist)
1567 (if (string-match (car comp) cmd)
1568 (setq f (cdr comp))))
1573 (list comp-beg comp-end table))))))))
1576 ;;;; LaTeX syntax navigation
1579 (defmacro tex-search-noncomment (&rest body)
1580 "Execute BODY as long as it return non-nil and point is in a comment.
1581 Return the value returned by the last execution of BODY."
1583 (let ((res-sym (make-symbol "result")))
1586 (and (setq ,res-sym (progn ,@body))
1587 (save-excursion (skip-chars-backward "^\n%") (not (bolp)))))
1590 (defun tex-last-unended-begin ()
1591 "Leave point at the beginning of the last `\\begin{...}' that is unended."
1593 (while (and (tex-search-noncomment
1594 (re-search-backward "\\\\\\(begin\\|end\\)\\s *{"))
1595 (looking-at "\\\\end"))
1596 (tex-last-unended-begin))
1597 (search-failed (error "Couldn't find unended \\begin"))))
1599 (defun tex-next-unmatched-end ()
1600 "Leave point at the end of the next `\\end' that is unmatched."
1601 (while (and (tex-search-noncomment
1602 (re-search-forward "\\\\\\(begin\\|end\\)\\s *{[^}]+}"))
1603 (save-excursion (goto-char (match-beginning 0))
1604 (looking-at "\\\\begin")))
1605 (tex-next-unmatched-end)))
1607 (defun tex-next-unmatched-eparen (otype)
1608 "Leave point after the next unmatched escaped closing parenthesis.
1609 The string OTYPE is an opening parenthesis type: `(', `{', or `['."
1611 (let ((ctype (char-to-string (cdr (aref (syntax-table)
1612 (string-to-char otype))))))
1613 (while (and (tex-search-noncomment
1614 (re-search-forward (format "\\\\[%s%s]" ctype otype)))
1616 (goto-char (match-beginning 0))
1617 (looking-at (format "\\\\%s" (regexp-quote otype)))))
1618 (tex-next-unmatched-eparen otype)))
1619 (wrong-type-argument (error "Unknown opening parenthesis type: %s" otype))
1620 (search-failed (error "Couldn't find closing escaped paren"))))
1622 (defun tex-last-unended-eparen (ctype)
1623 "Leave point at the start of the last unended escaped opening parenthesis.
1624 The string CTYPE is a closing parenthesis type: `)', `}', or `]'."
1626 (let ((otype (char-to-string (cdr (aref (syntax-table)
1627 (string-to-char ctype))))))
1628 (while (and (tex-search-noncomment
1629 (re-search-backward (format "\\\\[%s%s]" ctype otype)))
1630 (looking-at (format "\\\\%s" (regexp-quote ctype))))
1631 (tex-last-unended-eparen ctype)))
1632 (wrong-type-argument (error "Unknown opening parenthesis type: %s" ctype))
1633 (search-failed (error "Couldn't find unended escaped paren"))))
1635 (defun tex-goto-last-unclosed-latex-block ()
1636 "Move point to the last unclosed \\begin{...}.
1637 Mark is left at original location."
1641 (tex-last-unended-begin)
1642 (setq spot (point)))
1646 (defvar latex-handle-escaped-parens t)
1648 ;; Don't think this one actually _needs_ (for the purposes of
1649 ;; tex-mode) to handle escaped parens.
1650 ;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
1651 (defun latex-backward-sexp-1 ()
1652 "Like (backward-sexp 1) but aware of multi-char elements and escaped parens."
1654 (forward-sexp-function))
1657 (if latex-handle-escaped-parens
1658 "\\\\\\(begin\\>\\|[[({]\\)"
1661 (list "Containing expression ends prematurely"
1662 (point) (prog1 (point) (goto-char pos)))))
1663 ((and latex-handle-escaped-parens
1664 (looking-at "\\\\\\([])}]\\)"))
1665 (tex-last-unended-eparen (match-string 1)))
1666 ((eq (char-after) ?{)
1667 (let ((newpos (point)))
1668 (when (ignore-errors (backward-sexp 1) t)
1669 (if (or (looking-at "\\\\end\\>")
1670 ;; In case the \\ ends a verbatim section.
1671 (and (looking-at "end\\>") (eq (char-before) ?\\)))
1672 (tex-last-unended-begin)
1673 (goto-char newpos))))))))
1675 ;; Note this does not handle things like mismatched brackets inside
1676 ;; begin/end blocks.
1677 ;; Needs to handle escaped parens for tex-validate-*.
1678 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2007-09/msg00038.html
1679 ;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
1680 (defun latex-forward-sexp-1 ()
1681 "Like (forward-sexp 1) but aware of multi-char elements and escaped parens."
1683 (forward-sexp-function))
1685 (let ((newpos (point)))
1686 (skip-syntax-backward "/w")
1688 ((looking-at "\\\\end\\>")
1690 (list "Containing expression ends prematurely"
1693 (progn (ignore-errors (forward-sexp 2)) (point))
1695 ((looking-at "\\\\begin\\>")
1696 (goto-char (match-end 0))
1697 (tex-next-unmatched-end))
1698 ;; A better way to handle this, \( .. \) etc, is probably to
1699 ;; temporarily change the syntax of the \ in \( to punctuation.
1700 ((and latex-handle-escaped-parens
1701 (looking-back "\\\\[])}]"))
1703 (list "Containing expression ends prematurely"
1704 (- (point) 2) (prog1 (point)
1706 ((and latex-handle-escaped-parens
1707 (looking-back "\\\\\\([({[]\\)"))
1708 (tex-next-unmatched-eparen (match-string 1)))
1709 (t (goto-char newpos))))))
1711 (defun latex-forward-sexp (&optional arg)
1712 "Like `forward-sexp' but aware of multi-char elements and escaped parens."
1714 (unless arg (setq arg 1))
1715 (let ((pos (point)))
1720 (progn (latex-forward-sexp-1) (1- arg))
1721 (progn (latex-backward-sexp-1) (1+ arg)))))
1724 (signal (car err) (cdr err))))))
1726 (defun latex-syntax-after ()
1727 "Like (char-syntax (char-after)) but aware of multi-char elements."
1728 (if (looking-at "\\\\end\\>") ?\) (char-syntax (following-char))))
1730 (defun latex-skip-close-parens ()
1731 "Like (skip-syntax-forward \" )\") but aware of multi-char elements."
1732 (let ((forward-sexp-function nil))
1733 (while (progn (skip-syntax-forward " )")
1734 (looking-at "\\\\end\\>"))
1737 (defun latex-down-list ()
1738 "Like (down-list 1) but aware of multi-char elements."
1739 (forward-comment (point-max))
1740 (let ((forward-sexp-function nil))
1741 (if (not (looking-at "\\\\begin\\>"))
1745 (while (looking-at "[ \t]*[[{(]")
1746 (with-syntax-table tex-mode-syntax-table
1749 (defalias 'tex-close-latex-block 'latex-close-block)
1750 (define-skeleton latex-close-block
1751 "Create an \\end{...} to match the last unclosed \\begin{...}."
1753 (tex-last-unended-begin)
1754 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
1756 \n "\\end" str > \n)
1758 (define-skeleton latex-split-block
1759 "Split the enclosing environment by inserting \\end{..}\\begin{..} at point."
1761 (tex-last-unended-begin)
1762 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
1763 (prog1 (match-string 1)
1764 (goto-char (match-end 1))
1765 (setq v1 (buffer-substring (point)
1767 (while (looking-at "[ \t]*[[{]")
1770 \n "\\end" str > \n _ \n "\\begin" str v1 > \n)
1772 (defconst tex-discount-args-cmds
1773 '("begin" "end" "input" "special" "cite" "ref" "include" "includeonly"
1774 "documentclass" "usepackage" "label")
1775 "TeX commands whose arguments should not be counted as text.")
1777 (defun tex-count-words (begin end)
1778 "Count the number of words in the buffer."
1780 (if (and transient-mark-mode mark-active)
1781 (list (region-beginning) (region-end))
1782 (list (point-min) (point-max))))
1783 ;; TODO: skip comments and math and maybe some environments.
1787 (while (and (< (point) end) (re-search-forward "\\<" end t))
1788 (if (not (eq (char-syntax (preceding-char)) ?/))
1790 ;; Don't count single-char words.
1791 (unless (looking-at ".\\>") (incf count))
1794 (buffer-substring-no-properties
1795 (point) (progn (when (zerop (skip-chars-forward "a-zA-Z@"))
1798 (when (member cmd tex-discount-args-cmds)
1799 (skip-chars-forward "*")
1800 (forward-comment (point-max))
1801 (when (looking-at "\\[")
1803 (forward-comment (point-max)))
1804 (if (not (looking-at "{"))
1806 (forward-sexp 1))))))
1807 (message "%s words" count))))
1811 ;;; Invoking TeX in an inferior shell.
1813 ;; Why use a shell instead of running TeX directly? Because if TeX
1814 ;; gets stuck, the user can switch to the shell window and type at it.
1816 ;; The utility functions:
1818 (define-derived-mode tex-shell shell-mode "TeX-Shell"
1819 (set (make-local-variable 'compilation-parse-errors-function)
1820 'tex-compilation-parse-errors)
1821 (compilation-shell-minor-mode t))
1824 (defun tex-start-shell ()
1825 (with-current-buffer
1828 (or tex-shell-file-name (getenv "ESHELL") shell-file-name)
1830 ;; Specify an interactive shell, to make sure it prompts.
1832 (let ((proc (get-process "tex-shell")))
1833 (set-process-sentinel proc 'tex-shell-sentinel)
1834 (set-process-query-on-exit-flag proc nil)
1836 (while (zerop (buffer-size))
1839 (defun tex-feed-input ()
1840 "Send input to the tex shell process.
1841 In the tex buffer this can be used to continue an interactive tex run.
1842 In the tex shell buffer this command behaves like `comint-send-input'."
1844 (set-buffer (tex-shell-buf))
1846 (tex-recenter-output-buffer nil))
1848 (defun tex-display-shell ()
1849 "Make the TeX shell buffer visible in a window."
1850 (display-buffer (tex-shell-buf))
1851 (tex-recenter-output-buffer nil))
1853 (defun tex-shell-sentinel (proc msg)
1854 (cond ((null (buffer-name (process-buffer proc)))
1856 (set-process-buffer proc nil)
1857 (tex-delete-last-temp-files))
1858 ((memq (process-status proc) '(signal exit))
1859 (tex-delete-last-temp-files))))
1861 (defun tex-set-buffer-directory (buffer directory)
1862 "Set BUFFER's default directory to be DIRECTORY."
1863 (setq directory (file-name-as-directory (expand-file-name directory)))
1864 (if (not (file-directory-p directory))
1865 (error "%s is not a directory" directory)
1866 (with-current-buffer buffer
1867 (setq default-directory directory))))
1869 (defvar tex-send-command-modified-tick 0)
1870 (make-variable-buffer-local 'tex-send-command-modified-tick)
1872 (defun tex-shell-proc ()
1873 (or (tex-shell-running) (error "No TeX subprocess")))
1874 (defun tex-shell-buf ()
1875 (process-buffer (tex-shell-proc)))
1876 (defun tex-shell-buf-no-error ()
1877 (let ((proc (tex-shell-running)))
1878 (and proc (process-buffer proc))))
1880 (defun tex-send-command (command &optional file background)
1881 "Send COMMAND to TeX shell process, substituting optional FILE for *.
1882 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
1883 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
1884 substitution will be made in COMMAND. COMMAND can be any expression that
1885 evaluates to a command string.
1887 Return the process in which TeX is running."
1889 (let* ((cmd (eval command))
1890 (proc (tex-shell-proc))
1891 (buf (process-buffer proc))
1892 (star (string-match "\\*" cmd))
1897 (if (file-name-absolute-p file)
1898 (setq file (convert-standard-filename file)))
1899 (if star (concat (substring cmd 0 star)
1900 (shell-quote-argument file)
1901 (substring cmd (1+ star)))
1902 (concat cmd " " (shell-quote-argument file))))
1903 (if background "&" ""))))
1904 ;; Switch to buffer before checking for subproc output in it.
1906 ;; If text is unchanged since previous tex-send-command,
1907 ;; we haven't got any output. So wait for output now.
1908 (if (= (buffer-modified-tick buf) tex-send-command-modified-tick)
1909 (accept-process-output proc))
1910 (goto-char (process-mark proc))
1913 (setq tex-send-command-modified-tick (buffer-modified-tick buf))
1916 (defun tex-delete-last-temp-files (&optional not-all)
1917 "Delete any junk files from last temp file.
1918 If NOT-ALL is non-nil, save the `.dvi' file."
1919 (if tex-last-temp-file
1920 (let* ((dir (file-name-directory tex-last-temp-file))
1921 (list (and (file-directory-p dir)
1922 (file-name-all-completions
1923 (file-name-sans-extension
1924 (file-name-nondirectory tex-last-temp-file))
1929 ;; If arg is non-nil, don't delete the .dvi file.
1930 (not (string-match "\\.dvi$" (car list)))
1931 (delete-file (concat dir (car list))))
1932 (delete-file (concat dir (car list))))
1933 (setq list (cdr list))))))
1935 (add-hook 'kill-emacs-hook 'tex-delete-last-temp-files)
1938 ;; Machinery to guess the command that the user wants to execute.
1941 (defvar tex-compile-history nil)
1943 (defvar tex-input-files-re
1945 (concat "\\." (regexp-opt '("tex" "texi" "texinfo"
1946 "bbl" "ind" "sty" "cls") t)
1947 ;; Include files with no dots (for directories).
1948 "\\'\\|\\`[^.]+\\'")))
1950 (defcustom tex-use-reftex t
1951 "If non-nil, use RefTeX's list of files to determine what command to use."
1955 (defvar tex-compile-commands
1956 '(((concat "pdf" tex-command
1957 " " (if (< 0 (length tex-start-commands))
1958 (shell-quote-argument tex-start-commands)) " %f")
1960 ((concat tex-command
1961 " " (if (< 0 (length tex-start-commands))
1962 (shell-quote-argument tex-start-commands)) " %f")
1964 ("xdvi %r &" "%r.dvi")
1965 ("\\doc-view \"%r.pdf\"" "%r.pdf")
1966 ("xpdf %r.pdf &" "%r.pdf")
1967 ("gv %r.ps &" "%r.ps")
1968 ("yap %r &" "%r.dvi")
1969 ("advi %r &" "%r.dvi")
1970 ("gv %r.pdf &" "%r.pdf")
1971 ("bibtex %r" "%r.aux" "%r.bbl")
1972 ("makeindex %r" "%r.idx" "%r.ind")
1974 ("dvipdfm %r" "%r.dvi" "%r.pdf")
1975 ("dvipdf %r" "%r.dvi" "%r.pdf")
1976 ("dvips -o %r.ps %r" "%r.dvi" "%r.ps")
1977 ("ps2pdf %r.ps" "%r.ps" "%r.pdf")
1978 ("lpr %r.ps" "%r.ps"))
1979 "List of commands for `tex-compile'.
1980 Each element should be of the form (FORMAT IN OUT) where
1981 FORMAT is an expression that evaluates to a string that can contain
1982 - `%r' the main file name without extension.
1983 - `%f' the main file name.
1984 IN can be either a string (with the same % escapes in it) indicating
1985 the name of the input file, or t to indicate that the input is all
1986 the TeX files of the document, or nil if we don't know.
1987 OUT describes the output file and is either a %-escaped string
1988 or nil to indicate that there is no output file.")
1990 ;; defsubst* gives better byte-code than defsubst.
1991 (defsubst* tex-string-prefix-p (str1 str2)
1992 "Return non-nil if STR1 is a prefix of STR2"
1993 (eq t (compare-strings str2 nil (length str1) str1 nil nil)))
1995 (defun tex-guess-main-file (&optional all)
1996 "Find a likely `tex-main-file'.
1997 Looks for hints in other buffers in the same directory or in
1998 ALL other buffers. If ALL is `sub' only look at buffers in parent directories
1999 of the current buffer."
2000 (let ((dir default-directory)
2001 (header-re tex-start-of-header))
2003 ;; Look for a buffer with `tex-main-file' set.
2004 (dolist (buf (if (consp all) all (buffer-list)))
2005 (with-current-buffer buf
2007 ((null all) (equal dir default-directory))
2008 ((eq all 'sub) (tex-string-prefix-p default-directory dir))
2010 (stringp tex-main-file))
2011 (throw 'found (expand-file-name tex-main-file)))))
2012 ;; Look for a buffer containing the magic `tex-start-of-header'.
2013 (dolist (buf (if (consp all) all (buffer-list)))
2014 (with-current-buffer buf
2016 ((null all) (equal dir default-directory))
2017 ((eq all 'sub) (tex-string-prefix-p default-directory dir))
2020 ;; (or (easy-mmode-derived-mode-p 'latex-mode)
2021 ;; (easy-mmode-derived-mode-p 'plain-tex-mode))
2025 (goto-char (point-min))
2027 header-re (+ (point) 10000) t))))
2028 (throw 'found (expand-file-name buffer-file-name))))))))
2030 (defun tex-main-file ()
2031 "Return the relative name of the main file."
2032 (let* ((file (or tex-main-file
2033 ;; Compatibility with AUCTeX.
2035 (when (boundp 'TeX-master)
2036 (cond ((stringp TeX-master)
2037 (make-local-variable 'tex-main-file)
2038 (setq tex-main-file TeX-master))
2039 ((and (eq TeX-master t) buffer-file-name)
2040 (file-relative-name buffer-file-name)))))
2041 ;; Try to guess the main file.
2042 (if (not buffer-file-name)
2043 (error "Buffer is not associated with any file")
2046 (goto-char (point-min))
2047 (re-search-forward tex-start-of-header
2048 (+ (point) 10000) t))
2049 ;; This is the main file.
2051 ;; This isn't the main file, let's try to find better,
2052 (or (tex-guess-main-file)
2053 (tex-guess-main-file 'sub)
2054 ;; (tex-guess-main-file t)
2055 buffer-file-name)))))))
2056 (if (or (file-exists-p file) (string-match "\\.tex\\'" file))
2057 file (concat file ".tex"))))
2059 (defun tex-summarize-command (cmd)
2060 (if (not (stringp cmd)) ""
2061 (mapconcat 'identity
2062 (mapcar (lambda (s) (car (split-string s)))
2063 (split-string cmd "\\s-*\\(?:;\\|&&\\)\\s-*"))
2066 (defun tex-uptodate-p (file)
2067 "Return non-nil if FILE is not uptodate w.r.t the document source files.
2068 FILE is typically the output DVI or PDF file."
2069 ;; We should check all the files included !!!
2071 ;; Clearly, the target must exist.
2072 (file-exists-p file)
2073 ;; And the last run must not have asked for a rerun.
2074 ;; FIXME: this should check that the last run was done on the same file.
2075 (let ((buf (condition-case nil (tex-shell-buf) (error nil))))
2077 (with-current-buffer buf
2079 (goto-char (point-max))
2080 (and (re-search-backward
2081 (concat "(see the transcript file for additional information)"
2082 "\\|^Output written on .*"
2083 (regexp-quote (file-name-nondirectory file))
2087 ;; Usually page numbers are output as [N], but
2088 ;; I've already seen things like
2089 ;; [1{/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map}]
2090 (or (re-search-backward "\\[[0-9]+\\({[^}]*}\\)?\\]"
2094 (or (re-search-backward "Rerun" nil t)
2096 ;; And the input files must not have been changed in the meantime.
2097 (let ((files (if (and tex-use-reftex
2098 (fboundp 'reftex-scanning-info-available-p)
2099 (reftex-scanning-info-available-p))
2100 (reftex-all-document-files)
2101 (list (file-name-directory (expand-file-name file)))))
2105 (delq nil (mapcar (lambda (s) (if (eq (aref s (1- (length s))) ?/)
2106 (substring s 0 (1- (length s)))))
2107 completion-ignored-extensions))
2110 (while (and files uptodate)
2111 (let ((f (pop files)))
2112 (if (and (file-directory-p f)
2113 ;; Avoid infinite loops.
2114 (not (file-symlink-p f)))
2115 (unless (string-match ignored-dirs-re f)
2117 (ignore-errors ;Not readable or something.
2118 (directory-files f t tex-input-files-re))
2120 (when (file-newer-than-file-p f file)
2121 (setq uptodate nil)))))
2125 (autoload 'format-spec "format-spec")
2127 (defvar tex-executable-cache nil)
2128 (defun tex-executable-exists-p (name)
2129 "Like `executable-find' but with a cache."
2130 (let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" name)
2131 (intern-soft (concat "tex-cmd-" (match-string 1 name))))))
2134 (let ((cache (assoc name tex-executable-cache)))
2135 (if cache (cdr cache)
2136 (let ((executable (executable-find name)))
2137 (push (cons name executable) tex-executable-cache)
2140 (defun tex-command-executable (cmd)
2141 (let ((s (if (stringp cmd) cmd (eval (car cmd)))))
2142 (substring s 0 (string-match "[ \t]\\|\\'" s))))
2144 (defun tex-command-active-p (cmd fspec)
2145 "Return non-nil if the CMD spec might need to be run."
2146 (let ((in (nth 1 cmd))
2149 (let ((file (format-spec in fspec)))
2150 (when (file-exists-p file)
2152 (file-newer-than-file-p
2153 file (format-spec out fspec)))))
2154 (when (and (eq in t) (stringp out))
2155 (not (tex-uptodate-p (format-spec out fspec)))))))
2157 (defcustom tex-cmd-bibtex-args "--min-crossref=100"
2158 "Extra args to pass to `bibtex' by default."
2163 (defun tex-format-cmd (format fspec)
2164 "Like `format-spec' but adds user-specified args to the command.
2165 Only applies the FSPEC to the args part of FORMAT."
2166 (if (not (string-match "\\([^ /\\]+\\) " format))
2167 (format-spec format fspec)
2168 (let* ((prefix (substring format 0 (match-beginning 0)))
2169 (cmd (match-string 1 format))
2170 (args (substring format (match-end 0)))
2171 (sym (intern-soft (format "tex-cmd-%s-args" cmd)))
2172 (extra-args (and sym (symbol-value sym))))
2174 (if extra-args (concat " " extra-args))
2175 " " (format-spec args fspec)))))
2177 (defun tex-compile-default (fspec)
2178 "Guess a default command given the `format-spec' FSPEC."
2179 ;; TODO: Learn to do latex+dvips!
2182 ;; Only consider active commands.
2183 (dolist (cmd tex-compile-commands)
2184 (when (tex-executable-exists-p (tex-command-executable cmd))
2185 (if (tex-command-active-p cmd fspec)
2187 (push (nth 1 cmd) unchanged-in))))
2188 ;; If no command seems to be applicable, arbitrarily pick the first one.
2189 (setq cmds (if cmds (nreverse cmds) (list (car tex-compile-commands))))
2190 ;; Remove those commands whose input was considered stable for
2191 ;; some other command (typically if (t . "%.pdf") is inactive
2192 ;; then we're using pdflatex and the fact that the dvi file
2193 ;; is inexistent doesn't matter).
2196 (unless (member (nth 1 cmd) unchanged-in)
2198 ;; Only remove if there's something left.
2199 (if tmp (setq cmds (nreverse tmp))))
2200 ;; Remove commands whose input is not uptodate either.
2201 (let ((outs (delq nil (mapcar (lambda (x) (nth 2 x)) cmds)))
2204 (unless (member (nth 1 cmd) outs)
2206 ;; Only remove if there's something left.
2207 (if tmp (setq cmds (nreverse tmp))))
2208 ;; Select which file we're going to operate on (the latest).
2209 (let ((latest (nth 1 (car cmds))))
2210 (dolist (cmd (prog1 (cdr cmds) (setq cmds (list (car cmds)))))
2211 (if (equal latest (nth 1 cmd))
2213 (unless (eq latest t) ;Can't beat that!
2214 (if (or (not (stringp latest))
2216 (and (stringp (nth 1 cmd))
2217 (file-newer-than-file-p
2218 (format-spec (nth 1 cmd) fspec)
2219 (format-spec latest fspec))))
2220 (setq latest (nth 1 cmd) cmds (list cmd)))))))
2221 ;; Expand the command spec into the actual text.
2222 (dolist (cmd (prog1 cmds (setq cmds nil)))
2223 (push (cons (eval (car cmd)) (cdr cmd)) cmds))
2224 ;; Select the favorite command from the history.
2225 (let ((hist tex-compile-history)
2228 (setq hist-cmd (pop hist))
2229 (setq re (concat "\\`"
2230 (regexp-quote (tex-command-executable hist-cmd))
2231 "\\([ \t]\\|\\'\\)"))
2233 ;; If the hist entry uses the same command and applies to a file
2234 ;; of the same type (e.g. `gv %r.pdf' vs `gv %r.ps'), select cmd.
2235 (and (string-match re (car cmd))
2236 (or (not (string-match "%[fr]\\([-._[:alnum:]]+\\)" (car cmd)))
2237 (string-match (regexp-quote (match-string 1 (car cmd)))
2239 (setq hist nil cmds (list cmd)))))
2240 ;; Substitute and return.
2242 (string-match (concat "[' \t\"]" (format-spec "%r" fspec)
2243 "\\([;&' \t\"]\\|\\'\\)") hist-cmd))
2244 ;; The history command was already applied to the same file,
2245 ;; so just reuse it.
2247 (if cmds (tex-format-cmd (caar cmds) fspec))))))
2249 (defun tex-cmd-doc-view (file)
2250 (pop-to-buffer (find-file-noselect file)))
2252 (defun tex-compile (dir cmd)
2253 "Run a command CMD on current TeX buffer's file in DIR."
2254 ;; FIXME: Use time-stamps on files to decide the next op.
2256 (let* ((file (tex-main-file))
2258 (prog1 (file-name-directory (expand-file-name file))
2259 (setq file (file-name-nondirectory file))))
2260 (root (file-name-sans-extension file))
2261 (fspec (list (cons ?r (shell-quote-argument root))
2262 (cons ?f (shell-quote-argument file))))
2263 (default (tex-compile-default fspec)))
2264 (list default-directory
2266 (format "Command [%s]: " (tex-summarize-command default))
2268 (list (tex-format-cmd (eval (car x)) fspec)))
2269 tex-compile-commands)
2270 nil nil nil 'tex-compile-history default))))
2271 (save-some-buffers (not compilation-ask-about-save) nil)
2272 (let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" cmd)
2273 (intern-soft (concat "tex-cmd-" (match-string 1 cmd))))))
2276 (let ((default-directory dir))
2277 (apply f (split-string-and-unquote
2278 (substring cmd (match-end 0)))))
2279 (wrong-number-of-arguments
2280 (error "Wrong number of arguments to %s"
2281 (substring (symbol-name f) 8))))
2282 (if (tex-shell-running)
2285 (tex-send-tex-command cmd dir))))
2287 (defun tex-start-tex (command file &optional dir)
2288 "Start a TeX run, using COMMAND on FILE."
2289 (let* ((star (string-match "\\*" command))
2292 (concat (substring command 0 star)
2293 (shell-quote-argument file)
2294 (substring command (1+ star)))
2297 (if (< 0 (length tex-start-commands))
2299 (shell-quote-argument tex-start-commands) " "))
2300 (shell-quote-argument file)))))
2301 (tex-send-tex-command compile-command dir)))
2303 (defun tex-send-tex-command (cmd &optional dir)
2304 (unless (or (equal dir (let ((buf (tex-shell-buf-no-error)))
2305 (and buf (with-current-buffer buf
2306 default-directory))))
2308 (let (shell-dirtrack-verbose)
2309 (tex-send-command tex-shell-cd-command dir)))
2310 (with-current-buffer (process-buffer (tex-send-command cmd))
2311 (setq compilation-last-buffer (current-buffer))
2312 (compilation-forget-errors)
2313 ;; Don't parse previous compilations.
2314 (set-marker compilation-parsing-end (1- (point-max))))
2316 (setq tex-last-buffer-texed (current-buffer)))
2318 (defvar tex-error-parse-syntax-table
2319 (let ((st (make-syntax-table)))
2320 (modify-syntax-entry ?\( "()" st)
2321 (modify-syntax-entry ?\) ")(" st)
2322 (modify-syntax-entry ?\\ "\\" st)
2323 (modify-syntax-entry ?\{ "_" st)
2324 (modify-syntax-entry ?\} "_" st)
2325 (modify-syntax-entry ?\[ "_" st)
2326 (modify-syntax-entry ?\] "_" st)
2327 ;; Single quotations may appear in errors
2328 (modify-syntax-entry ?\" "_" st)
2330 "Syntax-table used while parsing TeX error messages.")
2332 (defun tex-compilation-parse-errors (limit-search find-at-least)
2333 "Parse the current buffer as TeX error messages.
2334 See the variable `compilation-parse-errors-function' for the interface it uses.
2336 This function parses only the last TeX compilation.
2337 It works on TeX compilations only. It is necessary for that purpose,
2338 since TeX does not put file names and line numbers on the same line as
2339 for the error messages."
2340 (require 'thingatpt)
2341 (setq compilation-error-list nil)
2342 (let ((default-directory ; Perhaps dir has changed meanwhile.
2343 (file-name-directory (buffer-file-name tex-last-buffer-texed)))
2344 found-desired (num-errors-found 0)
2345 last-filename last-linenum last-position
2346 begin-of-error end-of-error errfilename)
2347 ;; Don't reparse messages already seen at last parse.
2348 (goto-char compilation-parsing-end)
2350 (while (and (not (or found-desired (eobp)))
2351 ;; First alternative handles the newer --file-line-error style:
2352 ;; ./test2.tex:14: Too many }'s.
2353 ;; Second handles the old-style:
2355 (prog1 (re-search-forward
2356 "^\\(?:\\([^:\n]+\\):[[:digit:]]+:\\|!\\) " nil 'move)
2357 (setq begin-of-error (match-beginning 0)
2358 end-of-error (match-end 0)
2359 errfilename (match-string 1)))
2361 "^l\\.\\([0-9]+\\) \\(\\.\\.\\.\\)?\\(.*\\)$" nil 'move))
2362 (let* ((this-error (copy-marker begin-of-error))
2363 (linenum (string-to-number (match-string 1)))
2364 (error-text (regexp-quote (match-string 3)))
2367 ;; Prefer --file-liner-error filename if we have it.
2370 (with-syntax-table tex-error-parse-syntax-table
2371 (backward-up-list 1)
2372 (skip-syntax-forward "(_")
2374 (and (setq try-filename (thing-at-point
2376 (not (string= "" try-filename))
2377 (file-readable-p try-filename)))
2378 (skip-syntax-backward "(_")
2379 (backward-up-list 1)
2380 (skip-syntax-forward "(_"))
2381 (thing-at-point 'filename)))))
2383 (or (null last-filename)
2384 (not (string-equal last-filename filename))))
2386 (with-current-buffer
2387 (if (equal filename (concat tex-zap-file ".tex"))
2388 tex-last-buffer-texed
2389 (find-file-noselect filename))
2393 (goto-char (point-min))
2394 (forward-line (1- linenum))
2395 (setq last-position nil))
2396 (goto-char last-position)
2397 (forward-line (- linenum last-linenum)))
2398 ;; first try a forward search for the error text,
2399 ;; then a backward search limited by the last error.
2400 (let ((starting-point (point)))
2401 (or (re-search-forward error-text nil t)
2402 (re-search-backward error-text last-position t)
2403 (goto-char starting-point)))
2405 (goto-char this-error)
2406 (if (and compilation-error-list
2407 (or (and find-at-least
2408 (>= num-errors-found
2411 (>= end-of-error limit-search)))
2413 (setq found-desired t)
2414 (setq num-errors-found (1+ num-errors-found)
2415 last-filename filename
2416 last-linenum linenum
2417 last-position error-location
2418 compilation-error-list ; Add the new error
2419 (cons (cons this-error error-location)
2420 compilation-error-list))
2421 (goto-char end-of-error)))))
2422 (set-marker compilation-parsing-end (point))
2423 (setq compilation-error-list (nreverse compilation-error-list)))
2427 (defun tex-region (beg end)
2428 "Run TeX on the current region, via a temporary file.
2429 The file's name comes from the variable `tex-zap-file' and the
2430 variable `tex-directory' says where to put it.
2432 If the buffer has a header, the header is given to TeX before the
2433 region itself. The buffer's header is all lines between the strings
2434 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
2435 The header must start in the first 100 lines of the buffer.
2437 The value of `tex-trailer' is given to TeX as input after the region.
2439 The value of `tex-command' specifies the command to use to run TeX."
2441 (if (tex-shell-running)
2445 (setq tex-zap-file (tex-generate-zap-file-name)))
2446 ;; Temp file will be written and TeX will be run in zap-directory.
2447 ;; If the TEXINPUTS file has relative directories or if the region has
2448 ;; \input of files, this must be the same directory as the file for
2449 ;; TeX to access the correct inputs. That's why it's safest if
2450 ;; tex-directory is ".".
2451 (let* ((zap-directory
2452 (file-name-as-directory (expand-file-name tex-directory)))
2453 (tex-out-file (expand-file-name (concat tex-zap-file ".tex")
2455 (main-file (expand-file-name (tex-main-file)))
2456 (ismain (string-equal main-file (buffer-file-name)))
2458 ;; Don't delete temp files if we do the same buffer twice in a row.
2459 (or (eq (current-buffer) tex-last-buffer-texed)
2460 (tex-delete-last-temp-files t))
2461 (let ((default-directory zap-directory)) ; why?
2462 ;; We assume the header is fully contained in tex-main-file.
2463 ;; We use f-f-ns so we get prompted about any changes on disk.
2464 (with-current-buffer (find-file-noselect main-file)
2465 (setq already-output (tex-region-header tex-out-file
2467 ;; Write out the specified region (but don't repeat anything
2468 ;; already written in the header).
2469 (write-region (if ismain
2470 (max beg already-output)
2472 end tex-out-file (not (zerop already-output)))
2473 ;; Write the trailer, if any.
2474 ;; Precede it with a newline to make sure it
2475 ;; is not hidden in a comment.
2477 (write-region (concat "\n" tex-trailer) nil
2479 ;; Record the file name to be deleted afterward.
2480 (setq tex-last-temp-file tex-out-file)
2481 ;; Use a relative file name here because (1) the proper dir
2482 ;; is already current, and (2) the abs file name is sometimes
2483 ;; too long and can make tex crash.
2484 (tex-start-tex tex-command (concat tex-zap-file ".tex") zap-directory)
2485 (setq tex-print-file tex-out-file)))
2487 (defun tex-region-header (file &optional beg)
2488 "If there is a TeX header in the current buffer, write it to FILE.
2489 Return point at the end of the region so written, or zero. If
2490 the optional buffer position BEG is specified, then the region
2491 written out starts at BEG, if this lies before the start of the header.
2493 If the first line matches `tex-first-line-header-regexp', it is
2494 also written out. The variables `tex-start-of-header' and
2495 `tex-end-of-header' are used to locate the header. Note that the
2496 start of the header is required to be within the first 100 lines."
2500 (goto-char (point-min))
2501 (let ((search-end (save-excursion
2506 ;; Maybe copy first line, such as `\input texinfo', to temp file.
2507 (and tex-first-line-header-regexp
2508 (looking-at tex-first-line-header-regexp)
2509 (write-region (point)
2510 (progn (forward-line 1)
2511 (setq already-output (point)))
2513 ;; Write out the header, if there is one, and any of the
2514 ;; specified region which extends before it. But don't repeat
2515 ;; anything already written.
2516 (and tex-start-of-header
2517 (re-search-forward tex-start-of-header search-end t)
2520 (setq hbeg (point)) ; mark beginning of header
2521 (when (re-search-forward tex-end-of-header nil t)
2523 (setq hend (point)) ; mark end of header
2529 hend file (not (zerop already-output)))
2530 (setq already-output hend))))
2533 (defun tex-buffer ()
2534 "Run TeX on current buffer. See \\[tex-region] for more information.
2535 Does not save the buffer, so it's useful for trying experimental versions.
2536 See \\[tex-file] for an alternative."
2538 (tex-region (point-min) (point-max)))
2541 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
2542 This function is more useful than \\[tex-buffer] when you need the
2543 `.aux' file of LaTeX to have the correct name."
2545 (when tex-offer-save
2546 (save-some-buffers))
2547 (let* ((source-file (tex-main-file))
2548 (file-dir (file-name-directory (expand-file-name source-file))))
2549 (if (tex-shell-running)
2552 (tex-start-tex tex-command source-file file-dir)
2553 (setq tex-print-file (expand-file-name source-file))))
2555 (defun tex-generate-zap-file-name ()
2556 "Generate a unique name suitable for use as a file name."
2557 ;; Include the shell process number and host name
2558 ;; in case there are multiple shells (for same or different user).
2559 ;; Dec 1998: There is a report that some versions of xdvi
2560 ;; don't work with file names that start with #.
2562 (process-id (get-buffer-process "*tex-shell*"))
2563 (subst-char-in-string ?. ?- (system-name))))
2565 ;; This will perhaps be useful for modifying TEXINPUTS.
2566 ;; Expand each file name, separated by colons, in the string S.
2567 (defun tex-expand-files (s)
2568 (let (elts (start 0))
2569 (while (string-match ":" s start)
2570 (setq elts (cons (substring s start (match-beginning 0)) elts))
2571 (setq start (match-end 0)))
2573 (setq elts (cons (substring s start) elts)))
2574 (mapconcat (lambda (elt)
2575 (if (= (length elt) 0) elt (expand-file-name elt)))
2576 (nreverse elts) ":")))
2578 (defun tex-shell-running ()
2579 (let ((proc (get-process "tex-shell")))
2581 (if (and (eq (process-status proc) 'run)
2582 (buffer-live-p (process-buffer proc)))
2583 ;; return the TeX process on success
2585 ;; get rid of the process permanently
2586 ;; this should get rid of the annoying w32 problem with
2587 ;; dead tex-shell buffer and live process
2588 (delete-process proc)))))
2590 (defun tex-kill-job ()
2591 "Kill the currently running TeX job."
2593 ;; `quit-process' leads to core dumps of the tex process (except if
2594 ;; coredumpsize has limit 0kb as on many environments). One would
2595 ;; like to use (kill-process proc 'lambda), however that construct
2596 ;; does not work on some systems and kills the shell itself.
2597 (let ((proc (get-process "tex-shell")))
2598 (when proc (quit-process proc t))))
2600 (defun tex-recenter-output-buffer (linenum)
2601 "Redisplay buffer of TeX job output so that most recent output can be seen.
2602 The last line of the buffer is displayed on
2603 line LINE of the window, or centered if LINE is nil."
2605 (let ((tex-shell (get-buffer "*tex-shell*"))
2607 (if (null tex-shell)
2608 (message "No TeX output buffer")
2609 (setq window (display-buffer tex-shell))
2610 (save-selected-window
2611 (select-window window)
2612 (bury-buffer tex-shell)
2613 (goto-char (point-max))
2614 (recenter (if linenum
2615 (prefix-numeric-value linenum)
2616 (/ (window-height) 2)))))))
2618 (defun tex-print (&optional alt)
2619 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
2620 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
2621 is provided, use the alternative command, `tex-alt-dvi-print-command'."
2623 (let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
2625 (if (and (not (equal (current-buffer) tex-last-buffer-texed))
2627 ;; Check that this buffer's printed file is up to date.
2628 (file-newer-than-file-p
2629 (setq test-name (tex-append (buffer-file-name) ".dvi"))
2630 (buffer-file-name)))
2631 (setq print-file-name-dvi test-name))
2632 (if (not (file-exists-p print-file-name-dvi))
2633 (error "No appropriate `.dvi' file could be found")
2634 (if (tex-shell-running)
2638 (if alt tex-alt-dvi-print-command tex-dvi-print-command)
2642 (defun tex-alt-print ()
2643 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
2644 Runs the shell command defined by `tex-alt-dvi-print-command'."
2649 "Preview the last `.dvi' file made by running TeX under Emacs.
2650 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
2651 The variable `tex-dvi-view-command' specifies the shell command for preview.
2652 You must set that variable yourself before using this command,
2653 because there is no standard value that would generally work."
2655 (or tex-dvi-view-command
2656 (error "You must set `tex-dvi-view-command'"))
2657 ;; Restart the TeX shell if necessary.
2658 (or (tex-shell-running)
2660 (let ((tex-dvi-print-command (eval tex-dvi-view-command)))
2663 (defun tex-append (file-name suffix)
2664 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
2665 Pascal-based TeX scans for the first period, C TeX uses the last.
2666 No period is retained immediately before SUFFIX,
2667 so normally SUFFIX starts with one."
2668 (if (stringp file-name)
2669 (let ((file (file-name-nondirectory file-name))
2671 ;; Try splitting on last period.
2672 ;; The first-period split can get fooled when two files
2673 ;; named a.tex and a.b.tex are both tex'd;
2674 ;; the last-period split must be right if it matches at all.
2676 (concat (file-name-directory file-name)
2678 (string-match "\\.[^.]*$" file))
2680 (if (or (file-exists-p trial-name)
2681 (file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
2683 ;; Not found, so split on first period.
2684 (concat (file-name-directory file-name)
2686 (string-match "\\." file))
2690 (defun tex-show-print-queue ()
2691 "Show the print queue that \\[tex-print] put your job on.
2692 Runs the shell command defined by `tex-show-queue-command'."
2694 (if (tex-shell-running)
2697 (tex-send-command tex-show-queue-command)
2698 (tex-display-shell))
2700 (defun tex-bibtex-file ()
2701 "Run BibTeX on the current buffer's file."
2703 (if (tex-shell-running)
2706 (let* (shell-dirtrack-verbose
2707 (source-file (expand-file-name (tex-main-file)))
2709 (tex-append (file-name-nondirectory source-file) ""))
2710 (file-dir (file-name-directory source-file)))
2711 (tex-send-command tex-shell-cd-command file-dir)
2712 (tex-send-command tex-bibtex-command tex-out-file))
2713 (tex-display-shell))
2716 ;;;; LaTeX indentation
2719 (defvar tex-indent-allhanging t)
2720 (defvar tex-indent-arg 4)
2721 (defvar tex-indent-basic 2)
2722 (defvar tex-indent-item tex-indent-basic)
2723 (defvar tex-indent-item-re "\\\\\\(bib\\)?item\\>")
2724 (defvar latex-noindent-environments '("document"))
2726 (defvar tex-latex-indent-syntax-table
2727 (let ((st (make-syntax-table tex-mode-syntax-table)))
2728 (modify-syntax-entry ?$ "." st)
2729 (modify-syntax-entry ?\( "." st)
2730 (modify-syntax-entry ?\) "." st)
2732 "Syntax table used while computing indentation.")
2734 (defun latex-indent (&optional arg)
2735 (if (and (eq (get-text-property (line-beginning-position) 'face)
2738 (with-syntax-table tex-latex-indent-syntax-table
2739 ;; TODO: Rather than ignore $, we should try to be more clever about it.
2743 (latex-find-indent))))
2744 (if (< indent 0) (setq indent 0))
2745 (if (<= (current-column) (current-indentation))
2746 (indent-line-to indent)
2747 (save-excursion (indent-line-to indent)))))))
2749 (defcustom latex-indent-within-escaped-parens nil
2750 "Non-nil means add extra indent to text within escaped parens.
2751 When this is non-nil, text within matching pairs of escaped
2752 parens is indented at the column following the open paren. The
2753 default value does not add any extra indent thus providing the
2754 behavior of Emacs 22 and earlier."
2759 (defun latex-find-indent (&optional virtual)
2760 "Find the proper indentation of text after point.
2761 VIRTUAL if non-nil indicates that we're only trying to find the indentation
2762 in order to determine the indentation of something else.
2763 There might be text before point."
2764 (let ((latex-handle-escaped-parens latex-indent-within-escaped-parens))
2766 (skip-chars-forward " \t")
2768 ;; Stick the first line at column 0.
2769 (and (= (point-min) (line-beginning-position)) 0)
2770 ;; Trust the current indentation, if such info is applicable.
2771 (and virtual (save-excursion (skip-chars-backward " \t&") (bolp))
2773 ;; Stick verbatim environments to the left margin.
2774 (and (looking-at "\\\\\\(begin\\|end\\) *{\\([^\n}]+\\)")
2775 (member (match-string 2) tex-verbatim-environments)
2777 ;; Put leading close-paren where the matching open paren would be.
2779 (and (or (eq (latex-syntax-after) ?\))
2780 ;; Try to handle escaped close parens but keep
2781 ;; original position if it doesn't work out.
2782 (and latex-handle-escaped-parens
2783 (setq escaped (looking-at "\\\\\\([])}]\\)"))))
2787 (goto-char (match-beginning 1)))
2788 (latex-skip-close-parens)
2789 (latex-backward-sexp-1)
2790 (latex-find-indent 'virtual)))))
2791 ;; Default (maybe an argument)
2793 ;; Outdent \item if necessary.
2794 (indent (if (looking-at tex-indent-item-re) (- tex-indent-item) 0))
2796 ;; Find the previous point which determines our current indentation.
2799 (latex-backward-sexp-1)
2800 (while (> (current-column) (current-indentation))
2801 (latex-backward-sexp-1)))
2803 (setq up-list-pos (nth 2 err))))
2805 ((= (point-min) pos) 0) ; We're really just indenting the first line.
2806 ((integerp up-list-pos)
2807 ;; Have to indent relative to the open-paren.
2808 (goto-char up-list-pos)
2809 (if (and (not tex-indent-allhanging)
2811 ;; Make sure we're an argument to a macro and
2812 ;; that the macro is at the beginning of a line.
2815 (while (eq (char-syntax (char-after)) ?\()
2817 (and (eq (char-syntax (char-after)) ?/)
2818 (progn (skip-chars-backward " \t&")
2821 (> pos (progn (latex-down-list)
2822 (forward-comment (point-max))
2824 ;; Align with the first element after the open-paren.
2826 ;; We're the first element after a hanging brace.
2827 (goto-char up-list-pos)
2828 (+ (if (and (looking-at "\\\\begin *{\\([^\n}]+\\)")
2829 (member (match-string 1)
2830 latex-noindent-environments))
2832 indent (latex-find-indent 'virtual))))
2833 ;; We're now at the "beginning" of a line.
2834 ((not (and (not virtual) (eq (char-after) ?\\)))
2835 ;; Nothing particular here: just keep the same indentation.
2836 (+ indent (current-column)))
2837 ;; We're now looking at a macro call.
2838 ((looking-at tex-indent-item-re)
2839 ;; Indenting relative to an item, have to re-add the outdenting.
2840 (+ indent (current-column) tex-indent-item))
2842 (let ((col (current-column)))
2843 (if (or (not (eq (char-syntax (or (char-after pos) ?\s)) ?\())
2844 ;; Can't be an arg if there's an empty line inbetween.
2845 (save-excursion (re-search-forward "^[ \t]*$" pos t)))
2846 ;; If the first char was not an open-paren, there's
2847 ;; a risk that this is really not an argument to the
2851 (if (< (line-end-position)
2852 (save-excursion (forward-comment (point-max))
2854 ;; we're indenting the first argument.
2855 (min (current-column) (+ tex-indent-arg col))
2856 (skip-syntax-forward " ")
2857 (current-column)))))))))))
2860 (defun doctex-font-lock-^^A ()
2861 (if (eq (char-after (line-beginning-position)) ?\%)
2864 (1- (match-beginning 1)) (match-beginning 1)
2866 (if (= (1+ (line-beginning-position)) (match-beginning 1))
2867 ;; The `%' is a single-char comment, which Emacs
2868 ;; syntax-table can't deal with. We could turn it
2869 ;; into a non-comment, or use `\n%' or `%^' as the comment.
2870 ;; Instead, we include it in the ^^A comment.
2871 (string-to-syntax "< b")
2872 (string-to-syntax ">")))
2873 (let ((end (line-end-position)))
2874 (if (< end (point-max))
2878 (string-to-syntax "> b"))))
2879 (string-to-syntax "< b"))))
2881 (defun doctex-font-lock-syntactic-face-function (state)
2882 ;; Mark DocTeX documentation, which is parsed as a style A comment
2883 ;; starting in column 0.
2884 (if (or (nth 3 state) (nth 7 state)
2885 (not (memq (char-before (nth 8 state))
2887 ;; Anything else is just as for LaTeX.
2888 (tex-font-lock-syntactic-face-function state)
2889 font-lock-doc-face))
2892 (defconst doctex-syntax-propertize-rules
2893 (syntax-propertize-precompile-rules
2894 latex-syntax-propertize-rules
2895 ;; For DocTeX comment-in-doc.
2896 ("\\(\\^\\)\\^A" (1 (doctex-font-lock-^^A))))))
2898 (defvar doctex-font-lock-keywords
2899 (append tex-font-lock-keywords
2900 '(("^%<[^>]*>" (0 font-lock-preprocessor-face t)))))
2903 (define-derived-mode doctex-mode latex-mode "DocTeX"
2904 "Major mode to edit DocTeX files."
2905 (setq font-lock-defaults
2906 (cons (append (car font-lock-defaults) '(doctex-font-lock-keywords))
2910 (font-lock-syntactic-face-function
2911 (cons (car x) 'doctex-font-lock-syntactic-face-function))
2913 (cdr font-lock-defaults))))
2914 (set (make-local-variable 'syntax-propertize-function)
2915 (syntax-propertize-rules doctex-syntax-propertize-rules)))
2917 (run-hooks 'tex-mode-load-hook)
2921 ;;; tex-mode.el ends here