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
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 ;; tex-font-lock-syntactic-keywords causes the \ of \end{verbatim} to be
492 ;; highlighted as tex-verbatim face. Let's undo that.
493 ;; This is ugly and brittle :-( --Stef
494 '("^\\(\\\\\\)end" (1 (get-text-property (match-end 1) 'face
) t
))
495 ;; display $$ math $$
496 ;; We only mark the match between $$ and $$ because the $$ delimiters
497 ;; themselves have already been marked (along with $..$) by syntactic
498 ;; fontification. Also this is done at the very beginning so as to
499 ;; interact with the other keywords in the same way as $...$ does.
500 (list "\\$\\$\\([^$]+\\)\\$\\$" 1 'tex-math-face
)
502 (list (concat slash headings
"\\*?" opt arg
)
503 ;; If ARG ends up matching too much (if the {} don't match, e.g.)
504 ;; jit-lock will do funny things: when updating the buffer
505 ;; the re-highlighting is only done locally so it will just
506 ;; match the local line, but defer-contextually will
507 ;; match more lines at a time, so ARG will end up matching
508 ;; a lot more, which might suddenly include a comment
509 ;; so you get things highlighted bold when you type them
510 ;; but they get turned back to normal a little while later
511 ;; because "there's already a face there".
512 ;; Using `keep' works around this un-intuitive behavior as well
513 ;; as improves the behavior in the very rare case where you do
514 ;; have a comment in ARG.
515 3 'font-lock-function-name-face
'keep
)
516 (list (concat slash
"\\(?:provide\\|\\(?:re\\)?new\\)command\\** *\\(\\\\[A-Za-z@]+\\)")
517 1 'font-lock-function-name-face
'keep
)
519 (list (concat slash variables
" *" arg
) 2 'font-lock-variable-name-face
)
521 (list (concat slash includes opt arg
) 3 'font-lock-builtin-face
)
522 ;; Definitions. I think.
523 '("^[ \t]*\\\\def *\\\\\\(\\(\\w\\|@\\)+\\)"
524 1 font-lock-function-name-face
))))
525 "Subdued expressions to highlight in TeX modes.")
527 (defun tex-font-lock-append-prop (prop)
528 (unless (memq (get-text-property (match-end 1) 'face
)
529 '(font-lock-comment-face tex-verbatim
))
532 (defconst tex-font-lock-keywords-2
533 (append tex-font-lock-keywords-1
536 ;; Names of commands whose arg should be fontified with fonts.
537 (bold (regexp-opt '("textbf" "textsc" "textup"
538 "boldsymbol" "pmb") t
))
539 (italic (regexp-opt '("textit" "textsl" "emph") t
))
540 ;; FIXME: unimplemented yet.
541 ;; (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
543 ;; Names of commands whose arg should be fontified as a citation.
544 (citations (regexp-opt
545 '("label" "ref" "pageref" "vref" "eqref"
546 "cite" "nocite" "index" "glossary" "bibitem"
547 ;; natbib's two variants of \cite:
549 ;; These are text, rather than citations.
550 ;; "caption" "footnote" "footnotemark" "footnotetext"
554 ;; Names of commands that should be fontified.
555 (specials-1 (regexp-opt '("\\" "\\*") t
)) ;; "-"
556 (specials-2 (regexp-opt
557 '("linebreak" "nolinebreak" "pagebreak" "nopagebreak"
558 "newline" "newpage" "clearpage" "cleardoublepage"
559 "displaybreak" "allowdisplaybreaks"
560 "enlargethispage") t
))
561 (general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
565 (opt " *\\(\\[[^]]*\\] *\\)*")
566 (args "\\(\\(?:[^{}&\\]+\\|\\\\.\\|{[^}]*}\\)+\\)")
567 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
571 (list (concat slash citations opt arg
) 3 'font-lock-constant-face
)
573 ;; Text between `` quotes ''.
574 (cons (concat (regexp-opt `("``" "\"<" "\"`" "<<" "«") t
)
575 "[^'\">{]+" ;a bit pessimistic
576 (regexp-opt `("''" "\">" "\"'" ">>" "»") t
))
577 'font-lock-string-face
)
579 ;; Command names, special and general.
580 (cons (concat slash specials-1
) 'font-lock-warning-face
)
581 (list (concat "\\(" slash specials-2
"\\)\\([^a-zA-Z@]\\|\\'\\)")
582 1 'font-lock-warning-face
)
583 (concat slash general
)
585 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
586 ;; since we might not be able to display those fonts.
587 (list (concat slash bold
" *" arg
) 2
588 '(tex-font-lock-append-prop 'bold
) 'append
)
589 (list (concat slash italic
" *" arg
) 2
590 '(tex-font-lock-append-prop 'italic
) 'append
)
591 ;; (list (concat slash type arg) 2 '(quote bold-italic) 'append)
593 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
594 (list (concat "\\\\\\(em\\|it\\|sl\\)\\>" args
)
595 2 '(tex-font-lock-append-prop 'italic
) 'append
)
596 ;; This is separate from the previous one because of cases like
597 ;; {\em foo {\bf bar} bla} where both match.
598 (list (concat "\\\\\\(bf\\(series\\)?\\)\\>" args
)
599 3 '(tex-font-lock-append-prop 'bold
) 'append
)))))
600 "Gaudy expressions to highlight in TeX modes.")
602 (defun tex-font-lock-suscript (pos)
603 (unless (or (memq (get-text-property pos
'face
)
604 '(font-lock-constant-face font-lock-builtin-face
605 font-lock-comment-face tex-verbatim
))
606 ;; Check for backslash quoting
609 (while (eq (char-before pos
) ?
\\)
610 (setq pos
(1- pos
) odd
(not odd
)))
612 (if (eq (char-after pos
) ?_
)
613 `(face subscript display
(raise ,(car tex-font-script-display
)))
614 `(face superscript display
(raise ,(cadr tex-font-script-display
))))))
616 (defun tex-font-lock-match-suscript (limit)
617 "Match subscript and superscript patterns up to LIMIT."
618 (when (and tex-fontify-script
619 (re-search-forward "[_^] *\\([^\n\\{}]\\|\
620 \\\\\\([a-zA-Z@]+\\|[^ \t\n]\\)\\|\\({\\)\\)" limit t
))
622 (let ((beg (match-beginning 3))
623 (end (save-restriction
624 (narrow-to-region (point-min) limit
)
625 (condition-case nil
(scan-lists (point) 1 1) (error nil
)))))
626 (store-match-data (if end
627 (list (match-beginning 0) end beg end
)
628 (list beg beg beg beg
)))))
631 (defconst tex-font-lock-keywords-3
632 (append tex-font-lock-keywords-2
633 '((tex-font-lock-match-suscript
634 (1 (tex-font-lock-suscript (match-beginning 0)) append
))))
635 "Experimental expressions to highlight in TeX modes.")
637 (defvar tex-font-lock-keywords tex-font-lock-keywords-1
638 "Default expressions to highlight in TeX modes.")
640 (defvar tex-verbatim-environments
641 '("verbatim" "verbatim*"))
642 (put 'tex-verbatim-environments
'safe-local-variable
643 (lambda (x) (null (delq t
(mapcar 'stringp x
)))))
645 (defvar tex-font-lock-syntactic-keywords
646 '((eval .
`(,(concat "^\\\\begin *{"
647 (regexp-opt tex-verbatim-environments t
)
648 "}.*\\(\n\\)") 2 "|"))
649 ;; Technically, we'd like to put the "|" property on the \n preceding
650 ;; the \end, but this would have 2 disadvantages:
651 ;; 1 - it's wrong if the verbatim env is empty (the same \n is used to
652 ;; start and end the fenced-string).
653 ;; 2 - font-lock considers the preceding \n as being part of the
654 ;; preceding line, so things gets screwed every time the previous
655 ;; line is re-font-locked on its own.
656 ;; There's a hack in tex-font-lock-keywords-1 to remove the verbatim
657 ;; face from the \ but C-M-f still jumps to the wrong spot :-( --Stef
658 ;; FIXME: See gud.el for an example of a solution to a similar problem.
659 (eval .
`(,(concat "^\\(\\\\\\)end *{"
660 (regexp-opt tex-verbatim-environments t
)
661 "}\\(.?\\)") (1 "|") (3 "<")))
662 ;; ("^\\(\\\\\\)begin *{comment}" 1 "< b")
663 ;; ("^\\\\end *{comment}.*\\(\n\\)" 1 "> b")
664 ("\\\\verb\\**\\([^a-z@*]\\)"
665 ;; Do it last, because it uses syntax-ppss which needs the
666 ;; syntax-table properties of previous entries.
667 1 (tex-font-lock-verb (match-end 1)))))
669 (defun tex-font-lock-unfontify-region (beg end
)
670 (font-lock-default-unfontify-region beg end
)
672 (let ((next (next-single-property-change beg
'display nil end
))
673 (prop (get-text-property beg
'display
)))
674 (if (and (eq (car-safe prop
) 'raise
)
675 (member (car-safe (cdr prop
)) tex-font-script-display
)
677 (put-text-property beg next
'display nil
))
680 (defcustom tex-suscript-height-ratio
0.8
681 "Ratio of subscript/superscript height to that of the preceding text.
682 In nested subscript/superscript, this factor is applied repeatedly,
683 subject to the limit set by `tex-suscript-height-minimum'."
688 (defcustom tex-suscript-height-minimum
0.0
689 "Integer or float limiting the minimum size of subscript/superscript text.
690 An integer is an absolute height in units of 1/10 point, a float
691 is a height relative to that of the default font. Zero means no minimum."
692 :type
'(choice (integer :tag
"Integer height in 1/10 point units")
693 (float :tag
"Fraction of default font height"))
697 (defun tex-suscript-height (height)
698 "Return the integer height of subscript/superscript font in 1/10 points.
699 Not smaller than the value set by `tex-suscript-height-minimum'."
700 (ceiling (max (if (integerp tex-suscript-height-minimum
)
701 tex-suscript-height-minimum
702 ;; For bootstrapping.
704 (* tex-suscript-height-minimum
705 (face-attribute 'default
:height
))
707 ;; NB assumes height is integer.
708 (* height tex-suscript-height-ratio
))))
711 '((t :height tex-suscript-height
)) ;; :raise 0.2
712 "Face used for superscripts."
715 '((t :height tex-suscript-height
)) ;; :raise -0.2
716 "Face used for subscripts."
720 '((t :inherit font-lock-string-face
))
721 "Face used to highlight TeX math expressions."
723 (define-obsolete-face-alias 'tex-math-face
'tex-math
"22.1")
724 (defvar tex-math-face
'tex-math
)
726 (defface tex-verbatim
727 ;; '((t :inherit font-lock-string-face))
728 '((t :family
"courier"))
729 "Face used to highlight TeX verbatim environments."
731 (define-obsolete-face-alias 'tex-verbatim-face
'tex-verbatim
"22.1")
732 (defvar tex-verbatim-face
'tex-verbatim
)
734 (defun tex-font-lock-verb (end)
735 "Place syntax-table properties on the \verb construct.
736 END is the position of the first delimiter after \verb."
737 (unless (nth 8 (syntax-ppss end
))
738 ;; Do nothing if the \verb construct is itself inside a comment or
741 ;; Let's find the end and mark it.
742 ;; We used to do it inside tex-font-lock-syntactic-face-function, but
743 ;; this leads to funny effects when jumping to the end of the buffer,
744 ;; because font-lock applies font-lock-syntactic-keywords to the whole
745 ;; preceding text but font-lock-syntactic-face-function only to the
746 ;; actually displayed text.
748 (let ((char (char-before)))
749 (skip-chars-forward (string ?^ char
)) ;; Use `end' ?
750 (when (eq (char-syntax (preceding-char)) ?
/)
751 (put-text-property (1- (point)) (point) 'syntax-table
'(1)))
753 (put-text-property (point) (1+ (point)) 'syntax-table
'(7))
754 ;; Cause the rest of the buffer to be re-fontified.
755 ;; (remove-text-properties (1+ (point)) (point-max) '(fontified))
759 ;; Use string syntax but math face for $...$.
760 (defun tex-font-lock-syntactic-face-function (state)
761 (let ((char (nth 3 state
)))
763 ((not char
) font-lock-comment-face
)
764 ((eq char ?$
) tex-math-face
)
765 (t tex-verbatim-face
))))
768 (defun tex-define-common-keys (keymap)
769 "Define the keys that we want defined both in TeX mode and in the TeX shell."
770 (define-key keymap
"\C-c\C-k" 'tex-kill-job
)
771 (define-key keymap
"\C-c\C-l" 'tex-recenter-output-buffer
)
772 (define-key keymap
"\C-c\C-q" 'tex-show-print-queue
)
773 (define-key keymap
"\C-c\C-p" 'tex-print
)
774 (define-key keymap
"\C-c\C-v" 'tex-view
)
776 (define-key keymap
[menu-bar tex
] (cons "TeX" (make-sparse-keymap "TeX")))
778 (define-key keymap
[menu-bar tex tex-kill-job
]
779 '(menu-item "Tex Kill" tex-kill-job
:enable
(tex-shell-running)))
780 (define-key keymap
[menu-bar tex tex-recenter-output-buffer
]
781 '(menu-item "Tex Recenter" tex-recenter-output-buffer
782 :enable
(get-buffer "*tex-shell*")))
783 (define-key keymap
[menu-bar tex tex-show-print-queue
]
784 '("Show Print Queue" . tex-show-print-queue
))
785 (define-key keymap
[menu-bar tex tex-alt-print
]
786 '(menu-item "Tex Print (alt printer)" tex-alt-print
787 :enable
(stringp tex-print-file
)))
788 (define-key keymap
[menu-bar tex tex-print
]
789 '(menu-item "Tex Print" tex-print
:enable
(stringp tex-print-file
)))
790 (define-key keymap
[menu-bar tex tex-view
]
791 '(menu-item "Tex View" tex-view
:enable
(stringp tex-print-file
))))
794 (let ((map (make-sparse-keymap)))
795 (set-keymap-parent map text-mode-map
)
796 (tex-define-common-keys map
)
797 (define-key map
"\"" 'tex-insert-quote
)
798 (define-key map
"(" 'skeleton-pair-insert-maybe
)
799 (define-key map
"{" 'skeleton-pair-insert-maybe
)
800 (define-key map
"[" 'skeleton-pair-insert-maybe
)
801 (define-key map
"$" 'skeleton-pair-insert-maybe
)
802 (define-key map
"\n" 'tex-terminate-paragraph
)
803 (define-key map
"\M-\r" 'latex-insert-item
)
804 (define-key map
"\C-c}" 'up-list
)
805 (define-key map
"\C-c{" 'tex-insert-braces
)
806 (define-key map
"\C-c\C-r" 'tex-region
)
807 (define-key map
"\C-c\C-b" 'tex-buffer
)
808 (define-key map
"\C-c\C-f" 'tex-file
)
809 (define-key map
"\C-c\C-c" 'tex-compile
)
810 (define-key map
"\C-c\C-i" 'tex-bibtex-file
)
811 (define-key map
"\C-c\C-o" 'latex-insert-block
)
813 ;; Redundant keybindings, for consistency with SGML mode.
814 (define-key map
"\C-c\C-t" 'latex-insert-block
)
815 (define-key map
"\C-c/" 'latex-close-block
)
817 (define-key map
"\C-c\C-e" 'latex-close-block
)
818 (define-key map
"\C-c\C-u" 'tex-goto-last-unclosed-latex-block
)
819 (define-key map
"\C-c\C-m" 'tex-feed-input
)
820 (define-key map
[(control return
)] 'tex-feed-input
)
821 (define-key map
[menu-bar tex tex-bibtex-file
]
822 '("BibTeX File" . tex-bibtex-file
))
823 (define-key map
[menu-bar tex tex-validate-region
]
824 '(menu-item "Validate Region" tex-validate-region
:enable mark-active
))
825 (define-key map
[menu-bar tex tex-validate-buffer
]
826 '("Validate Buffer" . tex-validate-buffer
))
827 (define-key map
[menu-bar tex tex-region
]
828 '(menu-item "TeX Region" tex-region
:enable mark-active
))
829 (define-key map
[menu-bar tex tex-buffer
]
830 '("TeX Buffer" . tex-buffer
))
831 (define-key map
[menu-bar tex tex-file
] '("TeX File" . tex-file
))
833 "Keymap shared by TeX modes.")
835 (defvar latex-mode-map
836 (let ((map (make-sparse-keymap)))
837 (set-keymap-parent map tex-mode-map
)
838 (define-key map
"\C-c\C-s" 'latex-split-block
)
840 "Keymap for `latex-mode'. See also `tex-mode-map'.")
842 (defvar plain-tex-mode-map
843 (let ((map (make-sparse-keymap)))
844 (set-keymap-parent map tex-mode-map
)
846 "Keymap for `plain-tex-mode'. See also `tex-mode-map'.")
848 (defvar tex-shell-map
849 (let ((m (make-sparse-keymap)))
850 (set-keymap-parent m shell-mode-map
)
851 (tex-define-common-keys m
)
853 "Keymap for the TeX shell.
854 Inherits `shell-mode-map' with a few additions.")
856 (defvar tex-face-alist
859 (bold-italic .
"{\\bi ") ; hypothetical
860 (underline .
"\\underline{")
861 (default .
"{\\rm "))
862 "Alist of face and TeX font name for facemenu.")
864 (defvar tex-latex-face-alist
865 `((italic .
"{\\em ")
867 "Alist of face and LaTeX font name for facemenu.")
869 (defun tex-facemenu-add-face-function (face end
)
870 (or (cdr (assq face tex-face-alist
))
871 (or (and (consp face
)
874 (eq major-mode
'latex-mode
)
875 ;; This actually requires the `color' LaTeX package.
876 (cond ((eq (caar face
) :foreground
)
877 (format "{\\color{%s} " (cadr (car face
))))
878 ((eq (caar face
) :background
)
879 (format "\\colorbox{%s}{" (cadr (car face
))))))
880 (error "Face %s not configured for %s mode" face mode-name
))))
882 ;; This would be a lot simpler if we just used a regexp search,
883 ;; but then it would be too slow.
884 (defun tex-guess-mode ()
885 (let ((mode tex-default-mode
) slash comment
)
887 (goto-char (point-min))
888 (while (and (setq slash
(search-forward "\\" nil t
))
889 (setq comment
(let ((search-end (point)))
892 (search-forward "%" search-end t
))))))
893 (when (and slash
(not comment
))
898 (regexp-opt '("documentstyle" "documentclass"
899 "begin" "subsection" "section"
900 "part" "chapter" "newcommand"
901 "renewcommand" "RequirePackage") 'words
)
902 "\\|NeedsTeXFormat{LaTeX")))
904 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
905 ;; SliTeX is almost never used any more nowadays.
906 (tex-executable-exists-p slitex-run-command
))
912 ;; `tex-mode' plays two roles: it's the parent of several sub-modes
913 ;; but it's also the function that chooses between those submodes.
914 ;; To tell the difference between those two cases where the function
915 ;; might be called, we check `delay-mode-hooks'.
916 (define-derived-mode tex-mode text-mode
"generic-TeX"
917 (tex-common-initialization))
918 ;; We now move the function and define it again. This gives a warning
919 ;; in the byte-compiler :-( but it's difficult to avoid because
920 ;; `define-derived-mode' will necessarily define the function once
921 ;; and we need to define it a second time for `autoload' to get the
923 (defalias 'tex-mode-internal
(symbol-function 'tex-mode
))
925 ;; Suppress the byte-compiler warning about multiple definitions.
926 ;; This is a) ugly, and b) cheating, but this was the last
927 ;; remaining warning from byte-compiling all of Emacs...
929 (setq byte-compile-function-environment
930 (delq (assq 'tex-mode byte-compile-function-environment
)
931 byte-compile-function-environment
)))
935 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
936 Tries to determine (by looking at the beginning of the file) whether
937 this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
938 `latex-mode', or `slitex-mode', respectively. If it cannot be determined,
939 such as if there are no commands in the file, the value of `tex-default-mode'
940 says which mode to use."
943 ;; We're called from one of the children already.
947 ;; The following three autoloaded aliases appear to conflict with
948 ;; AUCTeX. However, even though AUCTeX uses the mixed case variants
949 ;; for all mode relevant variables and hooks, the invocation function
950 ;; and setting of `major-mode' themselves need to be lowercase for
951 ;; AUCTeX to provide a fully functional user-level replacement. So
952 ;; these aliases should remain as they are, in particular since AUCTeX
953 ;; users are likely to use them.
956 (defalias 'TeX-mode
'tex-mode
)
958 (defalias 'plain-TeX-mode
'plain-tex-mode
)
960 (defalias 'LaTeX-mode
'latex-mode
)
963 (define-derived-mode plain-tex-mode tex-mode
"TeX"
964 "Major mode for editing files of input for plain TeX.
965 Makes $ and } display the characters they match.
966 Makes \" insert `` when it seems to be the beginning of a quotation,
967 and '' when it appears to be the end; it inserts \" only after a \\.
969 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
970 copied from the top of the file (containing macro definitions, etc.),
971 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
972 \\[tex-file] saves the buffer and then processes the file.
973 \\[tex-print] prints the .dvi file made by any of these.
974 \\[tex-view] previews the .dvi file made by any of these.
975 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
977 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
978 mismatched $'s or braces.
981 \\{plain-tex-mode-map}
985 Command string used by \\[tex-region] or \\[tex-buffer].
987 Directory in which to create temporary files for TeX jobs
988 run by \\[tex-region] or \\[tex-buffer].
989 tex-dvi-print-command
990 Command string used by \\[tex-print] to print a .dvi file.
991 tex-alt-dvi-print-command
992 Alternative command string used by \\[tex-print] (when given a prefix
993 argument) to print a .dvi file.
995 Command string used by \\[tex-view] to preview a .dvi file.
996 tex-show-queue-command
997 Command string used by \\[tex-show-print-queue] to show the print
998 queue that \\[tex-print] put your job on.
1000 Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
1001 `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
1002 special subshell is initiated, the hook `tex-shell-hook' is run."
1003 (set (make-local-variable 'tex-command
) tex-run-command
)
1004 (set (make-local-variable 'tex-start-of-header
) "%\\*\\*start of header")
1005 (set (make-local-variable 'tex-end-of-header
) "%\\*\\*end of header")
1006 (set (make-local-variable 'tex-trailer
) "\\bye\n"))
1009 (define-derived-mode latex-mode tex-mode
"LaTeX"
1010 "Major mode for editing files of input for LaTeX.
1011 Makes $ and } display the characters they match.
1012 Makes \" insert `` when it seems to be the beginning of a quotation,
1013 and '' when it appears to be the end; it inserts \" only after a \\.
1015 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
1016 copied from the top of the file (containing \\documentstyle, etc.),
1017 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
1018 \\[tex-file] saves the buffer and then processes the file.
1019 \\[tex-print] prints the .dvi file made by any of these.
1020 \\[tex-view] previews the .dvi file made by any of these.
1021 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1023 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
1024 mismatched $'s or braces.
1031 Command string used by \\[tex-region] or \\[tex-buffer].
1033 Directory in which to create temporary files for LaTeX jobs
1034 run by \\[tex-region] or \\[tex-buffer].
1035 tex-dvi-print-command
1036 Command string used by \\[tex-print] to print a .dvi file.
1037 tex-alt-dvi-print-command
1038 Alternative command string used by \\[tex-print] (when given a prefix
1039 argument) to print a .dvi file.
1040 tex-dvi-view-command
1041 Command string used by \\[tex-view] to preview a .dvi file.
1042 tex-show-queue-command
1043 Command string used by \\[tex-show-print-queue] to show the print
1044 queue that \\[tex-print] put your job on.
1046 Entering Latex mode runs the hook `text-mode-hook', then
1047 `tex-mode-hook', and finally `latex-mode-hook'. When the special
1048 subshell is initiated, `tex-shell-hook' is run."
1049 (set (make-local-variable 'tex-command
) latex-run-command
)
1050 (set (make-local-variable 'tex-start-of-header
)
1051 "\\\\document\\(style\\|class\\)")
1052 (set (make-local-variable 'tex-end-of-header
) "\\\\begin\\s-*{document}")
1053 (set (make-local-variable 'tex-trailer
) "\\end{document}\n")
1054 ;; A line containing just $$ is treated as a paragraph separator.
1055 ;; A line starting with $$ starts a paragraph,
1056 ;; but does not separate paragraphs if it has more stuff on it.
1057 (setq paragraph-start
1058 (concat "[ \t]*\\(\\$\\$\\|"
1060 "\\\\" (regexp-opt (append
1061 (mapcar 'car latex-section-alist
)
1062 '("begin" "label" "end"
1063 "item" "bibitem" "newline" "noindent"
1064 "newpage" "footnote" "marginpar"
1065 "parbox" "caption")) t
)
1066 "\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t
)
1068 (setq paragraph-separate
1069 (concat "[\f%]\\|[ \t]*\\($\\|"
1071 "\\\\" (regexp-opt (append
1072 (mapcar 'car latex-section-alist
)
1073 '("begin" "label" "end" )) t
)
1074 "\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
1075 "noindent" "newpage" "footnote"
1076 "marginpar" "parbox" "caption"))
1077 "\\|\\$\\$\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
1078 "\\>\\)[ \t]*\\($\\|%\\)\\)"))
1079 (set (make-local-variable 'imenu-create-index-function
)
1080 'latex-imenu-create-index
)
1081 (set (make-local-variable 'tex-face-alist
) tex-latex-face-alist
)
1082 (add-hook 'fill-nobreak-predicate
'latex-fill-nobreak-predicate nil t
)
1083 (set (make-local-variable 'indent-line-function
) 'latex-indent
)
1084 (set (make-local-variable 'fill-indent-according-to-mode
) t
)
1085 (add-hook 'completion-at-point-functions
1086 'latex-complete-data nil
'local
)
1087 (set (make-local-variable 'outline-regexp
) latex-outline-regexp
)
1088 (set (make-local-variable 'outline-level
) 'latex-outline-level
)
1089 (set (make-local-variable 'forward-sexp-function
) 'latex-forward-sexp
)
1090 (set (make-local-variable 'skeleton-end-hook
) nil
))
1093 (define-derived-mode slitex-mode latex-mode
"SliTeX"
1094 "Major mode for editing files of input for SliTeX.
1095 Makes $ and } display the characters they match.
1096 Makes \" insert `` when it seems to be the beginning of a quotation,
1097 and '' when it appears to be the end; it inserts \" only after a \\.
1099 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
1100 copied from the top of the file (containing \\documentstyle, etc.),
1101 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
1102 \\[tex-file] saves the buffer and then processes the file.
1103 \\[tex-print] prints the .dvi file made by any of these.
1104 \\[tex-view] previews the .dvi file made by any of these.
1105 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
1107 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
1108 mismatched $'s or braces.
1115 Command string used by \\[tex-region] or \\[tex-buffer].
1117 Directory in which to create temporary files for SliTeX jobs
1118 run by \\[tex-region] or \\[tex-buffer].
1119 tex-dvi-print-command
1120 Command string used by \\[tex-print] to print a .dvi file.
1121 tex-alt-dvi-print-command
1122 Alternative command string used by \\[tex-print] (when given a prefix
1123 argument) to print a .dvi file.
1124 tex-dvi-view-command
1125 Command string used by \\[tex-view] to preview a .dvi file.
1126 tex-show-queue-command
1127 Command string used by \\[tex-show-print-queue] to show the print
1128 queue that \\[tex-print] put your job on.
1130 Entering SliTeX mode runs the hook `text-mode-hook', then the hook
1131 `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
1132 `slitex-mode-hook'. When the special subshell is initiated, the hook
1133 `tex-shell-hook' is run."
1134 (setq tex-command slitex-run-command
)
1135 (setq tex-start-of-header
"\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
1137 (defun tex-common-initialization ()
1138 ;; Regexp isearch should accept newline and formfeed as whitespace.
1139 (set (make-local-variable 'search-whitespace-regexp
) "[ \t\r\n\f]+")
1140 ;; A line containing just $$ is treated as a paragraph separator.
1141 (set (make-local-variable 'paragraph-start
)
1142 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
1143 ;; A line starting with $$ starts a paragraph,
1144 ;; but does not separate paragraphs if it has more stuff on it.
1145 (set (make-local-variable 'paragraph-separate
)
1146 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
1147 (set (make-local-variable 'comment-start
) "%")
1148 (set (make-local-variable 'comment-add
) 1)
1149 (set (make-local-variable 'comment-start-skip
)
1150 "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
1151 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
1152 (set (make-local-variable 'compare-windows-whitespace
)
1153 'tex-categorize-whitespace
)
1154 (set (make-local-variable 'facemenu-add-face-function
)
1155 'tex-facemenu-add-face-function
)
1156 (set (make-local-variable 'facemenu-end-add-face
) "}")
1157 (set (make-local-variable 'facemenu-remove-face-function
) t
)
1158 (set (make-local-variable 'font-lock-defaults
)
1159 '((tex-font-lock-keywords tex-font-lock-keywords-1
1160 tex-font-lock-keywords-2 tex-font-lock-keywords-3
)
1161 nil nil
((?$ .
"\"")) nil
1162 ;; Who ever uses that anyway ???
1163 (font-lock-mark-block-function . mark-paragraph
)
1164 (font-lock-syntactic-face-function
1165 . tex-font-lock-syntactic-face-function
)
1166 (font-lock-unfontify-region-function
1167 . tex-font-lock-unfontify-region
)))
1168 (set (make-local-variable 'syntax-propertize-function
)
1169 (syntax-propertize-via-font-lock tex-font-lock-syntactic-keywords
))
1170 ;; TABs in verbatim environments don't do what you think.
1171 (set (make-local-variable 'indent-tabs-mode
) nil
)
1172 ;; Other vars that should be buffer-local.
1173 (make-local-variable 'tex-command
)
1174 (make-local-variable 'tex-start-of-header
)
1175 (make-local-variable 'tex-end-of-header
)
1176 (make-local-variable 'tex-trailer
))
1178 (defun tex-categorize-whitespace (backward-limit)
1179 ;; compare-windows-whitespace is set to this.
1180 ;; This is basically a finite-state machine.
1181 ;; Returns a symbol telling how TeX would treat
1182 ;; the whitespace we are looking at: null, space, or par.
1183 (let ((category 'null
)
1185 (skip-chars-backward " \t\n\f" backward-limit
)
1187 (cond ((looking-at "[ \t]+")
1188 (goto-char (match-end 0))
1189 (if (eq category
'null
)
1190 (setq category
'space
)))
1192 (cond ((eq category
'newline
)
1193 (setq category
'par
)
1194 (setq not-finished nil
))
1196 (setq category
'newline
) ;a strictly internal state
1197 (goto-char (match-end 0)))))
1199 (setq category
'par
)
1200 (setq not-finished nil
))
1202 (setq not-finished nil
))))
1203 (skip-chars-forward " \t\n\f")
1204 (if (eq category
'newline
)
1205 'space
;TeX doesn't distinguish
1208 (defun tex-insert-quote (arg)
1209 "Insert the appropriate quote marks for TeX.
1210 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
1211 \(normally '') depending on the context. With prefix argument, always
1212 inserts \" characters."
1214 (if (or arg
(memq (char-syntax (preceding-char)) '(?
/ ?
\\))
1215 (eq (get-text-property (point) 'face
) 'tex-verbatim
)
1217 (backward-char (length tex-open-quote
))
1218 (when (or (looking-at (regexp-quote tex-open-quote
))
1219 (looking-at (regexp-quote tex-close-quote
)))
1220 (delete-char (length tex-open-quote
))
1222 (self-insert-command (prefix-numeric-value arg
))
1223 (insert (if (memq (char-syntax (preceding-char)) '(?\
( ?
> ?\s
))
1224 tex-open-quote tex-close-quote
))))
1226 (defun tex-validate-buffer ()
1227 "Check current buffer for paragraphs containing mismatched braces or $s.
1228 Their positions are recorded in the buffer `*Occur*'.
1229 To find a particular invalidity from `*Occur*', switch to that buffer
1230 and type C-c C-c or click with mouse-2
1231 on the line for the invalidity you want to see."
1233 (let ((buffer (current-buffer))
1234 (prevpos (point-min))
1237 (with-output-to-temp-buffer "*Occur*"
1238 (princ "Mismatches:\n")
1239 (with-current-buffer standard-output
1241 ;; This won't actually work...Really, this whole thing should
1242 ;; be rewritten instead of being a hack on top of occur.
1243 (setq occur-revert-arguments
(list nil
0 (list buffer
))))
1245 (goto-char (point-max))
1246 ;; Do a little shimmy to place point at the end of the last
1247 ;; "real" paragraph. Need to avoid validating across an \end,
1248 ;; because that blows up latex-forward-sexp.
1249 (backward-paragraph)
1252 ;; Scan the previous paragraph for invalidities.
1253 (backward-paragraph)
1255 (or (tex-validate-region (point) (save-excursion
1258 (let ((end (line-beginning-position 2))
1261 (setq start
(point))
1262 ;; Keep track of line number as we scan,
1263 ;; in a cumulative fashion.
1265 (setq linenum
(- linenum
1266 (count-lines prevpos
(point))))
1267 (setq linenum
(1+ (count-lines 1 start
))))
1268 (setq prevpos
(point))
1269 ;; Mention this mismatch in *Occur*.
1270 ;; Since we scan from end of buffer to beginning,
1271 ;; add each mismatch at the beginning of *Occur*.
1273 (setq tem
(point-marker))
1274 (set-buffer standard-output
)
1275 (goto-char (point-min))
1276 ;; Skip "Mismatches:" header line.
1278 (setq num-matches
(1+ num-matches
))
1279 (insert-buffer-substring buffer start end
)
1280 (let (text-beg (text-end (point-marker)))
1281 (forward-char (- start end
))
1282 (setq text-beg
(point-marker))
1283 (insert (format "%3d: " linenum
))
1284 (add-text-properties
1285 text-beg
(- text-end
1)
1286 '(mouse-face highlight
1288 "mouse-2: go to this invalidity"))
1289 (put-text-property text-beg
(- text-end
1)
1290 'occur-target tem
))))))))
1291 (with-current-buffer standard-output
1292 (let ((no-matches (zerop num-matches
)))
1295 (if (called-interactively-p 'interactive
)
1296 (message (cond (no-matches "No mismatches found")
1297 ((= num-matches
1) "1 mismatch found")
1298 (t "%d mismatches found"))
1301 (defun tex-validate-region (start end
)
1302 "Check for mismatched braces or $'s in region.
1303 Returns t if no mismatches. Returns nil and moves point to suspect
1304 area if a mismatch is found."
1306 (let ((failure-point nil
) (max-possible-sexps (- end start
)))
1310 (narrow-to-region start end
)
1311 ;; First check that the open and close parens balance in numbers.
1313 (while (and (not (eobp))
1314 (<= 0 (setq max-possible-sexps
1315 (1- max-possible-sexps
))))
1317 ;; Now check that like matches like.
1319 (while (re-search-forward "\\s(" nil t
)
1321 (let ((pos (match-beginning 0)))
1323 (skip-chars-backward "\\\\") ; escaped parens
1325 (or (eq (preceding-char) (cdr (syntax-after pos
)))
1326 (eq (char-after pos
) (cdr (syntax-after (1- (point)))))
1327 (error "Mismatched parentheses"))))))
1329 (skip-syntax-forward " .>")
1330 (setq failure-point
(point)))))
1331 (if failure-point
(goto-char failure-point
))
1332 (not failure-point
)))
1334 (defun tex-terminate-paragraph (inhibit-validation)
1335 "Insert two newlines, breaking a paragraph for TeX.
1336 Check for mismatched braces or $s in paragraph being terminated.
1337 A prefix arg inhibits the checking."
1339 (or inhibit-validation
1341 ;; For the purposes of this, a "paragraph" is a block of text
1342 ;; wherein all the brackets etc are expected to be balanced. It
1343 ;; may start after a blank line (ie a "proper" paragraph), or
1344 ;; a begin{} or end{} block, etc.
1345 (tex-validate-region
1347 (backward-paragraph)
1350 (message "Paragraph being closed appears to contain a mismatch"))
1353 (define-skeleton tex-insert-braces
1354 "Make a pair of braces and be poised to type inside of them."
1358 ;; This function is used as the value of fill-nobreak-predicate
1359 ;; in LaTeX mode. Its job is to prevent line-breaking inside
1360 ;; of a \verb construct.
1361 (defun latex-fill-nobreak-predicate ()
1363 (skip-chars-backward " ")
1364 ;; Don't break after \ since `\ ' has special meaning.
1365 (or (and (not (bobp)) (memq (char-syntax (char-before)) '(?
\\ ?
/)))
1366 (let ((opoint (point))
1369 (while (re-search-forward "\\\\verb\\(.\\)" opoint t
)
1370 (unless (re-search-forward (regexp-quote (match-string 1)) opoint t
)
1374 (defvar latex-block-default
"enumerate")
1376 (defvar latex-block-args-alist
1377 '(("array" nil ?\
{ (skeleton-read "Format: ") ?\
})
1378 ("tabular" nil ?\
{ (skeleton-read "Format: ") ?\
})
1379 ("minipage" nil ?\
{ (skeleton-read "Size: ") ?\
})
1380 ("picture" nil ?\
( (skeleton-read "SizeX,SizeY: ") ?\
))
1381 ;; FIXME: This is right for Prosper, but not for seminar.
1382 ;; ("slide" nil ?\{ (skeleton-read "Title: ") ?\})
1384 "Skeleton element to use for arguments to particular environments.
1385 Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1386 the name of the environment and SKEL-ELEM is an element to use in
1387 a skeleton (see `skeleton-insert').")
1389 (defvar latex-block-body-alist
1390 '(("enumerate" nil
'(latex-insert-item) > _
)
1391 ("itemize" nil
'(latex-insert-item) > _
)
1392 ("table" nil
"\\caption{" > (skeleton-read "Caption: ") "}" > \n
1393 '(if (and (boundp 'reftex-mode
) reftex-mode
) (reftex-label "table"))
1395 ("figure" nil
> _
\n "\\caption{" > (skeleton-read "Caption: ") "}" > \n
1396 '(if (and (boundp 'reftex-mode
) reftex-mode
) (reftex-label "table"))))
1397 "Skeleton element to use for the body of particular environments.
1398 Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
1399 the name of the environment and SKEL-ELEM is an element to use in
1400 a skeleton (see `skeleton-insert').")
1402 ;; Like tex-insert-braces, but for LaTeX.
1403 (defalias 'tex-latex-block
'latex-insert-block
)
1404 (define-skeleton latex-insert-block
1405 "Create a matching pair of lines \\begin{NAME} and \\end{NAME} at point.
1406 Puts point on a blank line between them."
1407 (let ((choice (completing-read (format "LaTeX block name [%s]: "
1408 latex-block-default
)
1409 (append latex-block-names
1410 latex-standard-block-names
)
1411 nil nil nil nil latex-block-default
)))
1412 (setq latex-block-default choice
)
1413 (unless (or (member choice latex-standard-block-names
)
1414 (member choice latex-block-names
))
1415 ;; Remember new block names for later completion.
1416 (push choice latex-block-names
))
1418 \n "\\begin{" str
"}"
1419 (cdr (assoc str latex-block-args-alist
))
1420 > \n (or (cdr (assoc str latex-block-body-alist
)) '(nil > _
))
1422 "\\end{" str
"}" > \n)
1424 (define-skeleton latex-insert-item
1425 "Insert a \item macro."
1430 ;;;; LaTeX completion.
1432 (defvar latex-complete-bibtex-cache nil
)
1434 (defun latex-string-prefix-p (str1 str2
)
1435 (eq t
(compare-strings str1 nil nil str2
0 (length str1
))))
1437 (defvar bibtex-reference-key
)
1438 (declare-function reftex-get-bibfile-list
"reftex-cite.el" ())
1440 (defun latex-complete-bibtex-keys ()
1441 (when (bound-and-true-p reftex-mode
)
1442 (lambda (key pred action
)
1443 (let ((re (concat "^[ \t]*@\\([a-zA-Z]+\\)[ \t\n]*\\([{(][ \t\n]*\\)"
1444 (regexp-quote key
)))
1445 (files (reftex-get-bibfile-list))
1447 (if (and (eq (car latex-complete-bibtex-cache
)
1448 (reftex-get-bibfile-list))
1449 (latex-string-prefix-p (nth 1 latex-complete-bibtex-cache
)
1452 (setq keys
(nth 2 latex-complete-bibtex-cache
))
1453 (dolist (file files
)
1454 (with-current-buffer (find-file-noselect file
)
1455 (goto-char (point-min))
1456 (while (re-search-forward re nil t
)
1457 (goto-char (match-end 2))
1458 (when (and (not (member-ignore-case (match-string 1)
1459 '("c" "comment" "string")))
1460 (looking-at bibtex-reference-key
))
1461 (push (match-string-no-properties 0) keys
)))))
1463 (set (make-local-variable 'latex-complete-bibtex-cache
)
1464 (list files key keys
)))
1465 (complete-with-action action keys key pred
)))))
1467 (defun latex-complete-envnames ()
1468 (append latex-block-names latex-standard-block-names
))
1470 (defun latex-complete-refkeys ()
1471 (when (boundp 'reftex-docstruct-symbol
)
1472 (symbol-value reftex-docstruct-symbol
)))
1474 (defvar latex-complete-alist
1475 ;; TODO: Add \begin, \end, \ref, ...
1476 '(("\\`\\\\\\(short\\)?cite\\'" . latex-complete-bibtex-keys
)
1477 ("\\`\\\\\\(begin\\|end\\)\\'" . latex-complete-envnames
)
1478 ("\\`\\\\[vf]?ref\\'" . latex-complete-refkeys
)))
1480 (defun latex-complete-data ()
1481 "Get completion-data at point."
1484 (skip-chars-backward "^ {}\n\t\\\\")
1486 ((nil ?\s ?
\n ?
\t ?\
}) nil
)
1488 ;; TODO: Complete commands.
1491 ;; Complete args to commands.
1495 (skip-chars-backward " \n")
1496 (buffer-substring (point)
1498 (skip-chars-backward "a-zA-Z@*")
1499 (let ((n (skip-chars-backward "\\\\")))
1500 (forward-char (* 2 (/ n
2))))
1503 (_ (progn (goto-char pt
) (skip-chars-backward "^," start
)))
1505 (_ (progn (goto-char pt
) (skip-chars-forward "^, {}\n\t\\\\")))
1509 (let ((f (lambda () t
)))
1510 (dolist (comp latex-complete-alist
)
1511 (if (string-match (car comp
) cmd
)
1512 (setq f
(cdr comp
))))
1517 (list comp-beg comp-end table
))))))))
1520 ;;;; LaTeX syntax navigation
1523 (defmacro tex-search-noncomment
(&rest body
)
1524 "Execute BODY as long as it return non-nil and point is in a comment.
1525 Return the value returned by the last execution of BODY."
1527 (let ((res-sym (make-symbol "result")))
1530 (and (setq ,res-sym
(progn ,@body
))
1531 (save-excursion (skip-chars-backward "^\n%") (not (bolp)))))
1534 (defun tex-last-unended-begin ()
1535 "Leave point at the beginning of the last `\\begin{...}' that is unended."
1537 (while (and (tex-search-noncomment
1538 (re-search-backward "\\\\\\(begin\\|end\\)\\s *{"))
1539 (looking-at "\\\\end"))
1540 (tex-last-unended-begin))
1541 (search-failed (error "Couldn't find unended \\begin"))))
1543 (defun tex-next-unmatched-end ()
1544 "Leave point at the end of the next `\\end' that is unmatched."
1545 (while (and (tex-search-noncomment
1546 (re-search-forward "\\\\\\(begin\\|end\\)\\s *{[^}]+}"))
1547 (save-excursion (goto-char (match-beginning 0))
1548 (looking-at "\\\\begin")))
1549 (tex-next-unmatched-end)))
1551 (defun tex-next-unmatched-eparen (otype)
1552 "Leave point after the next unmatched escaped closing parenthesis.
1553 The string OTYPE is an opening parenthesis type: `(', `{', or `['."
1555 (let ((ctype (char-to-string (cdr (aref (syntax-table)
1556 (string-to-char otype
))))))
1557 (while (and (tex-search-noncomment
1558 (re-search-forward (format "\\\\[%s%s]" ctype otype
)))
1560 (goto-char (match-beginning 0))
1561 (looking-at (format "\\\\%s" (regexp-quote otype
)))))
1562 (tex-next-unmatched-eparen otype
)))
1563 (wrong-type-argument (error "Unknown opening parenthesis type: %s" otype
))
1564 (search-failed (error "Couldn't find closing escaped paren"))))
1566 (defun tex-last-unended-eparen (ctype)
1567 "Leave point at the start of the last unended escaped opening parenthesis.
1568 The string CTYPE is a closing parenthesis type: `)', `}', or `]'."
1570 (let ((otype (char-to-string (cdr (aref (syntax-table)
1571 (string-to-char ctype
))))))
1572 (while (and (tex-search-noncomment
1573 (re-search-backward (format "\\\\[%s%s]" ctype otype
)))
1574 (looking-at (format "\\\\%s" (regexp-quote ctype
))))
1575 (tex-last-unended-eparen ctype
)))
1576 (wrong-type-argument (error "Unknown opening parenthesis type: %s" ctype
))
1577 (search-failed (error "Couldn't find unended escaped paren"))))
1579 (defun tex-goto-last-unclosed-latex-block ()
1580 "Move point to the last unclosed \\begin{...}.
1581 Mark is left at original location."
1585 (tex-last-unended-begin)
1586 (setq spot
(point)))
1590 (defvar latex-handle-escaped-parens t
)
1592 ;; Don't think this one actually _needs_ (for the purposes of
1593 ;; tex-mode) to handle escaped parens.
1594 ;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
1595 (defun latex-backward-sexp-1 ()
1596 "Like (backward-sexp 1) but aware of multi-char elements and escaped parens."
1598 (forward-sexp-function))
1601 (if latex-handle-escaped-parens
1602 "\\\\\\(begin\\>\\|[[({]\\)"
1605 (list "Containing expression ends prematurely"
1606 (point) (prog1 (point) (goto-char pos
)))))
1607 ((and latex-handle-escaped-parens
1608 (looking-at "\\\\\\([])}]\\)"))
1609 (tex-last-unended-eparen (match-string 1)))
1610 ((eq (char-after) ?
{)
1611 (let ((newpos (point)))
1612 (when (ignore-errors (backward-sexp 1) t
)
1613 (if (or (looking-at "\\\\end\\>")
1614 ;; In case the \\ ends a verbatim section.
1615 (and (looking-at "end\\>") (eq (char-before) ?
\\)))
1616 (tex-last-unended-begin)
1617 (goto-char newpos
))))))))
1619 ;; Note this does not handle things like mismatched brackets inside
1620 ;; begin/end blocks.
1621 ;; Needs to handle escaped parens for tex-validate-*.
1622 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2007-09/msg00038.html
1623 ;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
1624 (defun latex-forward-sexp-1 ()
1625 "Like (forward-sexp 1) but aware of multi-char elements and escaped parens."
1627 (forward-sexp-function))
1629 (let ((newpos (point)))
1630 (skip-syntax-backward "/w")
1632 ((looking-at "\\\\end\\>")
1634 (list "Containing expression ends prematurely"
1637 (progn (ignore-errors (forward-sexp 2)) (point))
1639 ((looking-at "\\\\begin\\>")
1640 (goto-char (match-end 0))
1641 (tex-next-unmatched-end))
1642 ;; A better way to handle this, \( .. \) etc, is probably to
1643 ;; temporarily change the syntax of the \ in \( to punctuation.
1644 ((and latex-handle-escaped-parens
1645 (looking-back "\\\\[])}]"))
1647 (list "Containing expression ends prematurely"
1648 (- (point) 2) (prog1 (point)
1650 ((and latex-handle-escaped-parens
1651 (looking-back "\\\\\\([({[]\\)"))
1652 (tex-next-unmatched-eparen (match-string 1)))
1653 (t (goto-char newpos
))))))
1655 (defun latex-forward-sexp (&optional arg
)
1656 "Like `forward-sexp' but aware of multi-char elements and escaped parens."
1658 (unless arg
(setq arg
1))
1659 (let ((pos (point)))
1664 (progn (latex-forward-sexp-1) (1- arg
))
1665 (progn (latex-backward-sexp-1) (1+ arg
)))))
1668 (signal (car err
) (cdr err
))))))
1670 (defun latex-syntax-after ()
1671 "Like (char-syntax (char-after)) but aware of multi-char elements."
1672 (if (looking-at "\\\\end\\>") ?\
) (char-syntax (following-char))))
1674 (defun latex-skip-close-parens ()
1675 "Like (skip-syntax-forward \" )\") but aware of multi-char elements."
1676 (let ((forward-sexp-function nil
))
1677 (while (progn (skip-syntax-forward " )")
1678 (looking-at "\\\\end\\>"))
1681 (defun latex-down-list ()
1682 "Like (down-list 1) but aware of multi-char elements."
1683 (forward-comment (point-max))
1684 (let ((forward-sexp-function nil
))
1685 (if (not (looking-at "\\\\begin\\>"))
1689 (while (looking-at "[ \t]*[[{(]")
1690 (with-syntax-table tex-mode-syntax-table
1693 (defalias 'tex-close-latex-block
'latex-close-block
)
1694 (define-skeleton latex-close-block
1695 "Create an \\end{...} to match the last unclosed \\begin{...}."
1697 (tex-last-unended-begin)
1698 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _
"}")
1700 \n "\\end" str
> \n)
1702 (define-skeleton latex-split-block
1703 "Split the enclosing environment by inserting \\end{..}\\begin{..} at point."
1705 (tex-last-unended-begin)
1706 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _
"}")
1707 (prog1 (match-string 1)
1708 (goto-char (match-end 1))
1709 (setq v1
(buffer-substring (point)
1711 (while (looking-at "[ \t]*[[{]")
1714 \n "\\end" str
> \n _
\n "\\begin" str v1
> \n)
1716 (defconst tex-discount-args-cmds
1717 '("begin" "end" "input" "special" "cite" "ref" "include" "includeonly"
1718 "documentclass" "usepackage" "label")
1719 "TeX commands whose arguments should not be counted as text.")
1721 (defun tex-count-words (begin end
)
1722 "Count the number of words in the buffer."
1724 (if (and transient-mark-mode mark-active
)
1725 (list (region-beginning) (region-end))
1726 (list (point-min) (point-max))))
1727 ;; TODO: skip comments and math and maybe some environments.
1731 (while (and (< (point) end
) (re-search-forward "\\<" end t
))
1732 (if (not (eq (char-syntax (preceding-char)) ?
/))
1734 ;; Don't count single-char words.
1735 (unless (looking-at ".\\>") (incf count
))
1738 (buffer-substring-no-properties
1739 (point) (progn (when (zerop (skip-chars-forward "a-zA-Z@"))
1742 (when (member cmd tex-discount-args-cmds
)
1743 (skip-chars-forward "*")
1744 (forward-comment (point-max))
1745 (when (looking-at "\\[")
1747 (forward-comment (point-max)))
1748 (if (not (looking-at "{"))
1750 (forward-sexp 1))))))
1751 (message "%s words" count
))))
1755 ;;; Invoking TeX in an inferior shell.
1757 ;; Why use a shell instead of running TeX directly? Because if TeX
1758 ;; gets stuck, the user can switch to the shell window and type at it.
1760 ;; The utility functions:
1762 (define-derived-mode tex-shell shell-mode
"TeX-Shell"
1763 (set (make-local-variable 'compilation-parse-errors-function
)
1764 'tex-compilation-parse-errors
)
1765 (compilation-shell-minor-mode t
))
1768 (defun tex-start-shell ()
1769 (with-current-buffer
1772 (or tex-shell-file-name
(getenv "ESHELL") shell-file-name
)
1774 ;; Specify an interactive shell, to make sure it prompts.
1776 (let ((proc (get-process "tex-shell")))
1777 (set-process-sentinel proc
'tex-shell-sentinel
)
1778 (set-process-query-on-exit-flag proc nil
)
1780 (while (zerop (buffer-size))
1783 (defun tex-feed-input ()
1784 "Send input to the tex shell process.
1785 In the tex buffer this can be used to continue an interactive tex run.
1786 In the tex shell buffer this command behaves like `comint-send-input'."
1788 (set-buffer (tex-shell-buf))
1790 (tex-recenter-output-buffer nil
))
1792 (defun tex-display-shell ()
1793 "Make the TeX shell buffer visible in a window."
1794 (display-buffer (tex-shell-buf))
1795 (tex-recenter-output-buffer nil
))
1797 (defun tex-shell-sentinel (proc msg
)
1798 (cond ((null (buffer-name (process-buffer proc
)))
1800 (set-process-buffer proc nil
)
1801 (tex-delete-last-temp-files))
1802 ((memq (process-status proc
) '(signal exit
))
1803 (tex-delete-last-temp-files))))
1805 (defun tex-set-buffer-directory (buffer directory
)
1806 "Set BUFFER's default directory to be DIRECTORY."
1807 (setq directory
(file-name-as-directory (expand-file-name directory
)))
1808 (if (not (file-directory-p directory
))
1809 (error "%s is not a directory" directory
)
1810 (with-current-buffer buffer
1811 (setq default-directory directory
))))
1813 (defvar tex-send-command-modified-tick
0)
1814 (make-variable-buffer-local 'tex-send-command-modified-tick
)
1816 (defun tex-shell-proc ()
1817 (or (tex-shell-running) (error "No TeX subprocess")))
1818 (defun tex-shell-buf ()
1819 (process-buffer (tex-shell-proc)))
1820 (defun tex-shell-buf-no-error ()
1821 (let ((proc (tex-shell-running)))
1822 (and proc
(process-buffer proc
))))
1824 (defun tex-send-command (command &optional file background
)
1825 "Send COMMAND to TeX shell process, substituting optional FILE for *.
1826 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
1827 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
1828 substitution will be made in COMMAND. COMMAND can be any expression that
1829 evaluates to a command string.
1831 Return the process in which TeX is running."
1833 (let* ((cmd (eval command
))
1834 (proc (tex-shell-proc))
1835 (buf (process-buffer proc
))
1836 (star (string-match "\\*" cmd
))
1841 (if (file-name-absolute-p file
)
1842 (setq file
(convert-standard-filename file
)))
1843 (if star
(concat (substring cmd
0 star
)
1844 (shell-quote-argument file
)
1845 (substring cmd
(1+ star
)))
1846 (concat cmd
" " (shell-quote-argument file
))))
1847 (if background
"&" ""))))
1848 ;; Switch to buffer before checking for subproc output in it.
1850 ;; If text is unchanged since previous tex-send-command,
1851 ;; we haven't got any output. So wait for output now.
1852 (if (= (buffer-modified-tick buf
) tex-send-command-modified-tick
)
1853 (accept-process-output proc
))
1854 (goto-char (process-mark proc
))
1857 (setq tex-send-command-modified-tick
(buffer-modified-tick buf
))
1860 (defun tex-delete-last-temp-files (&optional not-all
)
1861 "Delete any junk files from last temp file.
1862 If NOT-ALL is non-nil, save the `.dvi' file."
1863 (if tex-last-temp-file
1864 (let* ((dir (file-name-directory tex-last-temp-file
))
1865 (list (and (file-directory-p dir
)
1866 (file-name-all-completions
1867 (file-name-sans-extension
1868 (file-name-nondirectory tex-last-temp-file
))
1873 ;; If arg is non-nil, don't delete the .dvi file.
1874 (not (string-match "\\.dvi$" (car list
)))
1875 (delete-file (concat dir
(car list
))))
1876 (delete-file (concat dir
(car list
))))
1877 (setq list
(cdr list
))))))
1879 (add-hook 'kill-emacs-hook
'tex-delete-last-temp-files
)
1882 ;; Machinery to guess the command that the user wants to execute.
1885 (defvar tex-compile-history nil
)
1887 (defvar tex-input-files-re
1889 (concat "\\." (regexp-opt '("tex" "texi" "texinfo"
1890 "bbl" "ind" "sty" "cls") t
)
1891 ;; Include files with no dots (for directories).
1892 "\\'\\|\\`[^.]+\\'")))
1894 (defcustom tex-use-reftex t
1895 "If non-nil, use RefTeX's list of files to determine what command to use."
1899 (defvar tex-compile-commands
1900 '(((concat "pdf" tex-command
1901 " " (if (< 0 (length tex-start-commands
))
1902 (shell-quote-argument tex-start-commands
)) " %f")
1904 ((concat tex-command
1905 " " (if (< 0 (length tex-start-commands
))
1906 (shell-quote-argument tex-start-commands
)) " %f")
1908 ("xdvi %r &" "%r.dvi")
1909 ("\\doc-view \"%r.pdf\"" "%r.pdf")
1910 ("xpdf %r.pdf &" "%r.pdf")
1911 ("gv %r.ps &" "%r.ps")
1912 ("yap %r &" "%r.dvi")
1913 ("advi %r &" "%r.dvi")
1914 ("gv %r.pdf &" "%r.pdf")
1915 ("bibtex %r" "%r.aux" "%r.bbl")
1916 ("makeindex %r" "%r.idx" "%r.ind")
1918 ("dvipdfm %r" "%r.dvi" "%r.pdf")
1919 ("dvipdf %r" "%r.dvi" "%r.pdf")
1920 ("dvips -o %r.ps %r" "%r.dvi" "%r.ps")
1921 ("ps2pdf %r.ps" "%r.ps" "%r.pdf")
1922 ("lpr %r.ps" "%r.ps"))
1923 "List of commands for `tex-compile'.
1924 Each element should be of the form (FORMAT IN OUT) where
1925 FORMAT is an expression that evaluates to a string that can contain
1926 - `%r' the main file name without extension.
1927 - `%f' the main file name.
1928 IN can be either a string (with the same % escapes in it) indicating
1929 the name of the input file, or t to indicate that the input is all
1930 the TeX files of the document, or nil if we don't know.
1931 OUT describes the output file and is either a %-escaped string
1932 or nil to indicate that there is no output file.")
1934 ;; defsubst* gives better byte-code than defsubst.
1935 (defsubst* tex-string-prefix-p
(str1 str2
)
1936 "Return non-nil if STR1 is a prefix of STR2"
1937 (eq t
(compare-strings str2 nil
(length str1
) str1 nil nil
)))
1939 (defun tex-guess-main-file (&optional all
)
1940 "Find a likely `tex-main-file'.
1941 Looks for hints in other buffers in the same directory or in
1942 ALL other buffers. If ALL is `sub' only look at buffers in parent directories
1943 of the current buffer."
1944 (let ((dir default-directory
)
1945 (header-re tex-start-of-header
))
1947 ;; Look for a buffer with `tex-main-file' set.
1948 (dolist (buf (if (consp all
) all
(buffer-list)))
1949 (with-current-buffer buf
1951 ((null all
) (equal dir default-directory
))
1952 ((eq all
'sub
) (tex-string-prefix-p default-directory dir
))
1954 (stringp tex-main-file
))
1955 (throw 'found
(expand-file-name tex-main-file
)))))
1956 ;; Look for a buffer containing the magic `tex-start-of-header'.
1957 (dolist (buf (if (consp all
) all
(buffer-list)))
1958 (with-current-buffer buf
1960 ((null all
) (equal dir default-directory
))
1961 ((eq all
'sub
) (tex-string-prefix-p default-directory dir
))
1964 ;; (or (easy-mmode-derived-mode-p 'latex-mode)
1965 ;; (easy-mmode-derived-mode-p 'plain-tex-mode))
1969 (goto-char (point-min))
1971 header-re
(+ (point) 10000) t
))))
1972 (throw 'found
(expand-file-name buffer-file-name
))))))))
1974 (defun tex-main-file ()
1975 "Return the relative name of the main file."
1976 (let* ((file (or tex-main-file
1977 ;; Compatibility with AUCTeX.
1979 (when (boundp 'TeX-master
)
1980 (cond ((stringp TeX-master
)
1981 (make-local-variable 'tex-main-file
)
1982 (setq tex-main-file TeX-master
))
1983 ((and (eq TeX-master t
) buffer-file-name
)
1984 (file-relative-name buffer-file-name
)))))
1985 ;; Try to guess the main file.
1986 (if (not buffer-file-name
)
1987 (error "Buffer is not associated with any file")
1990 (goto-char (point-min))
1991 (re-search-forward tex-start-of-header
1992 (+ (point) 10000) t
))
1993 ;; This is the main file.
1995 ;; This isn't the main file, let's try to find better,
1996 (or (tex-guess-main-file)
1997 (tex-guess-main-file 'sub
)
1998 ;; (tex-guess-main-file t)
1999 buffer-file-name
)))))))
2000 (if (or (file-exists-p file
) (string-match "\\.tex\\'" file
))
2001 file
(concat file
".tex"))))
2003 (defun tex-summarize-command (cmd)
2004 (if (not (stringp cmd
)) ""
2005 (mapconcat 'identity
2006 (mapcar (lambda (s) (car (split-string s
)))
2007 (split-string cmd
"\\s-*\\(?:;\\|&&\\)\\s-*"))
2010 (defun tex-uptodate-p (file)
2011 "Return non-nil if FILE is not uptodate w.r.t the document source files.
2012 FILE is typically the output DVI or PDF file."
2013 ;; We should check all the files included !!!
2015 ;; Clearly, the target must exist.
2016 (file-exists-p file
)
2017 ;; And the last run must not have asked for a rerun.
2018 ;; FIXME: this should check that the last run was done on the same file.
2019 (let ((buf (condition-case nil
(tex-shell-buf) (error nil
))))
2021 (with-current-buffer buf
2023 (goto-char (point-max))
2024 (and (re-search-backward
2025 (concat "(see the transcript file for additional information)"
2026 "\\|^Output written on .*"
2027 (regexp-quote (file-name-nondirectory file
))
2031 ;; Usually page numbers are output as [N], but
2032 ;; I've already seen things like
2033 ;; [1{/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map}]
2034 (or (re-search-backward "\\[[0-9]+\\({[^}]*}\\)?\\]"
2038 (or (re-search-backward "Rerun" nil t
)
2040 ;; And the input files must not have been changed in the meantime.
2041 (let ((files (if (and tex-use-reftex
2042 (fboundp 'reftex-scanning-info-available-p
)
2043 (reftex-scanning-info-available-p))
2044 (reftex-all-document-files)
2045 (list (file-name-directory (expand-file-name file
)))))
2049 (delq nil
(mapcar (lambda (s) (if (eq (aref s
(1- (length s
))) ?
/)
2050 (substring s
0 (1- (length s
)))))
2051 completion-ignored-extensions
))
2054 (while (and files uptodate
)
2055 (let ((f (pop files
)))
2056 (if (and (file-directory-p f
)
2057 ;; Avoid infinite loops.
2058 (not (file-symlink-p f
)))
2059 (unless (string-match ignored-dirs-re f
)
2061 (ignore-errors ;Not readable or something.
2062 (directory-files f t tex-input-files-re
))
2064 (when (file-newer-than-file-p f file
)
2065 (setq uptodate nil
)))))
2069 (autoload 'format-spec
"format-spec")
2071 (defvar tex-executable-cache nil
)
2072 (defun tex-executable-exists-p (name)
2073 "Like `executable-find' but with a cache."
2074 (let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" name
)
2075 (intern-soft (concat "tex-cmd-" (match-string 1 name
))))))
2078 (let ((cache (assoc name tex-executable-cache
)))
2079 (if cache
(cdr cache
)
2080 (let ((executable (executable-find name
)))
2081 (push (cons name executable
) tex-executable-cache
)
2084 (defun tex-command-executable (cmd)
2085 (let ((s (if (stringp cmd
) cmd
(eval (car cmd
)))))
2086 (substring s
0 (string-match "[ \t]\\|\\'" s
))))
2088 (defun tex-command-active-p (cmd fspec
)
2089 "Return non-nil if the CMD spec might need to be run."
2090 (let ((in (nth 1 cmd
))
2093 (let ((file (format-spec in fspec
)))
2094 (when (file-exists-p file
)
2096 (file-newer-than-file-p
2097 file
(format-spec out fspec
)))))
2098 (when (and (eq in t
) (stringp out
))
2099 (not (tex-uptodate-p (format-spec out fspec
)))))))
2101 (defcustom tex-cmd-bibtex-args
"--min-crossref=100"
2102 "Extra args to pass to `bibtex' by default."
2107 (defun tex-format-cmd (format fspec
)
2108 "Like `format-spec' but adds user-specified args to the command.
2109 Only applies the FSPEC to the args part of FORMAT."
2110 (if (not (string-match "\\([^ /\\]+\\) " format
))
2111 (format-spec format fspec
)
2112 (let* ((prefix (substring format
0 (match-beginning 0)))
2113 (cmd (match-string 1 format
))
2114 (args (substring format
(match-end 0)))
2115 (sym (intern-soft (format "tex-cmd-%s-args" cmd
)))
2116 (extra-args (and sym
(symbol-value sym
))))
2118 (if extra-args
(concat " " extra-args
))
2119 " " (format-spec args fspec
)))))
2121 (defun tex-compile-default (fspec)
2122 "Guess a default command given the `format-spec' FSPEC."
2123 ;; TODO: Learn to do latex+dvips!
2126 ;; Only consider active commands.
2127 (dolist (cmd tex-compile-commands
)
2128 (when (tex-executable-exists-p (tex-command-executable cmd
))
2129 (if (tex-command-active-p cmd fspec
)
2131 (push (nth 1 cmd
) unchanged-in
))))
2132 ;; If no command seems to be applicable, arbitrarily pick the first one.
2133 (setq cmds
(if cmds
(nreverse cmds
) (list (car tex-compile-commands
))))
2134 ;; Remove those commands whose input was considered stable for
2135 ;; some other command (typically if (t . "%.pdf") is inactive
2136 ;; then we're using pdflatex and the fact that the dvi file
2137 ;; is inexistent doesn't matter).
2140 (unless (member (nth 1 cmd
) unchanged-in
)
2142 ;; Only remove if there's something left.
2143 (if tmp
(setq cmds
(nreverse tmp
))))
2144 ;; Remove commands whose input is not uptodate either.
2145 (let ((outs (delq nil
(mapcar (lambda (x) (nth 2 x
)) cmds
)))
2148 (unless (member (nth 1 cmd
) outs
)
2150 ;; Only remove if there's something left.
2151 (if tmp
(setq cmds
(nreverse tmp
))))
2152 ;; Select which file we're going to operate on (the latest).
2153 (let ((latest (nth 1 (car cmds
))))
2154 (dolist (cmd (prog1 (cdr cmds
) (setq cmds
(list (car cmds
)))))
2155 (if (equal latest
(nth 1 cmd
))
2157 (unless (eq latest t
) ;Can't beat that!
2158 (if (or (not (stringp latest
))
2160 (and (stringp (nth 1 cmd
))
2161 (file-newer-than-file-p
2162 (format-spec (nth 1 cmd
) fspec
)
2163 (format-spec latest fspec
))))
2164 (setq latest
(nth 1 cmd
) cmds
(list cmd
)))))))
2165 ;; Expand the command spec into the actual text.
2166 (dolist (cmd (prog1 cmds
(setq cmds nil
)))
2167 (push (cons (eval (car cmd
)) (cdr cmd
)) cmds
))
2168 ;; Select the favorite command from the history.
2169 (let ((hist tex-compile-history
)
2172 (setq hist-cmd
(pop hist
))
2173 (setq re
(concat "\\`"
2174 (regexp-quote (tex-command-executable hist-cmd
))
2175 "\\([ \t]\\|\\'\\)"))
2177 ;; If the hist entry uses the same command and applies to a file
2178 ;; of the same type (e.g. `gv %r.pdf' vs `gv %r.ps'), select cmd.
2179 (and (string-match re
(car cmd
))
2180 (or (not (string-match "%[fr]\\([-._[:alnum:]]+\\)" (car cmd
)))
2181 (string-match (regexp-quote (match-string 1 (car cmd
)))
2183 (setq hist nil cmds
(list cmd
)))))
2184 ;; Substitute and return.
2186 (string-match (concat "[' \t\"]" (format-spec "%r" fspec
)
2187 "\\([;&' \t\"]\\|\\'\\)") hist-cmd
))
2188 ;; The history command was already applied to the same file,
2189 ;; so just reuse it.
2191 (if cmds
(tex-format-cmd (caar cmds
) fspec
))))))
2193 (defun tex-cmd-doc-view (file)
2194 (pop-to-buffer (find-file-noselect file
)))
2196 (defun tex-compile (dir cmd
)
2197 "Run a command CMD on current TeX buffer's file in DIR."
2198 ;; FIXME: Use time-stamps on files to decide the next op.
2200 (let* ((file (tex-main-file))
2202 (prog1 (file-name-directory (expand-file-name file
))
2203 (setq file
(file-name-nondirectory file
))))
2204 (root (file-name-sans-extension file
))
2205 (fspec (list (cons ?r
(shell-quote-argument root
))
2206 (cons ?f
(shell-quote-argument file
))))
2207 (default (tex-compile-default fspec
)))
2208 (list default-directory
2210 (format "Command [%s]: " (tex-summarize-command default
))
2212 (list (tex-format-cmd (eval (car x
)) fspec
)))
2213 tex-compile-commands
)
2214 nil nil nil
'tex-compile-history default
))))
2215 (save-some-buffers (not compilation-ask-about-save
) nil
)
2216 (let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" cmd
)
2217 (intern-soft (concat "tex-cmd-" (match-string 1 cmd
))))))
2220 (let ((default-directory dir
))
2221 (apply f
(split-string-and-unquote
2222 (substring cmd
(match-end 0)))))
2223 (wrong-number-of-arguments
2224 (error "Wrong number of arguments to %s"
2225 (substring (symbol-name f
) 8))))
2226 (if (tex-shell-running)
2229 (tex-send-tex-command cmd dir
))))
2231 (defun tex-start-tex (command file
&optional dir
)
2232 "Start a TeX run, using COMMAND on FILE."
2233 (let* ((star (string-match "\\*" command
))
2236 (concat (substring command
0 star
)
2237 (shell-quote-argument file
)
2238 (substring command
(1+ star
)))
2241 (if (< 0 (length tex-start-commands
))
2243 (shell-quote-argument tex-start-commands
) " "))
2244 (shell-quote-argument file
)))))
2245 (tex-send-tex-command compile-command dir
)))
2247 (defun tex-send-tex-command (cmd &optional dir
)
2248 (unless (or (equal dir
(let ((buf (tex-shell-buf-no-error)))
2249 (and buf
(with-current-buffer buf
2250 default-directory
))))
2252 (let (shell-dirtrack-verbose)
2253 (tex-send-command tex-shell-cd-command dir
)))
2254 (with-current-buffer (process-buffer (tex-send-command cmd
))
2255 (setq compilation-last-buffer
(current-buffer))
2256 (compilation-forget-errors)
2257 ;; Don't parse previous compilations.
2258 (set-marker compilation-parsing-end
(1- (point-max))))
2260 (setq tex-last-buffer-texed
(current-buffer)))
2262 (defvar tex-error-parse-syntax-table
2263 (let ((st (make-syntax-table)))
2264 (modify-syntax-entry ?\
( "()" st
)
2265 (modify-syntax-entry ?\
) ")(" st
)
2266 (modify-syntax-entry ?
\\ "\\" st
)
2267 (modify-syntax-entry ?\
{ "_" st
)
2268 (modify-syntax-entry ?\
} "_" st
)
2269 (modify-syntax-entry ?\
[ "_" st
)
2270 (modify-syntax-entry ?\
] "_" st
)
2271 ;; Single quotations may appear in errors
2272 (modify-syntax-entry ?
\" "_" st
)
2274 "Syntax-table used while parsing TeX error messages.")
2276 (defun tex-compilation-parse-errors (limit-search find-at-least
)
2277 "Parse the current buffer as TeX error messages.
2278 See the variable `compilation-parse-errors-function' for the interface it uses.
2280 This function parses only the last TeX compilation.
2281 It works on TeX compilations only. It is necessary for that purpose,
2282 since TeX does not put file names and line numbers on the same line as
2283 for the error messages."
2284 (require 'thingatpt
)
2285 (setq compilation-error-list nil
)
2286 (let ((default-directory ; Perhaps dir has changed meanwhile.
2287 (file-name-directory (buffer-file-name tex-last-buffer-texed
)))
2288 found-desired
(num-errors-found 0)
2289 last-filename last-linenum last-position
2290 begin-of-error end-of-error errfilename
)
2291 ;; Don't reparse messages already seen at last parse.
2292 (goto-char compilation-parsing-end
)
2294 (while (and (not (or found-desired
(eobp)))
2295 ;; First alternative handles the newer --file-line-error style:
2296 ;; ./test2.tex:14: Too many }'s.
2297 ;; Second handles the old-style:
2299 (prog1 (re-search-forward
2300 "^\\(?:\\([^:\n]+\\):[[:digit:]]+:\\|!\\) " nil
'move
)
2301 (setq begin-of-error
(match-beginning 0)
2302 end-of-error
(match-end 0)
2303 errfilename
(match-string 1)))
2305 "^l\\.\\([0-9]+\\) \\(\\.\\.\\.\\)?\\(.*\\)$" nil
'move
))
2306 (let* ((this-error (copy-marker begin-of-error
))
2307 (linenum (string-to-number (match-string 1)))
2308 (error-text (regexp-quote (match-string 3)))
2311 ;; Prefer --file-liner-error filename if we have it.
2314 (with-syntax-table tex-error-parse-syntax-table
2315 (backward-up-list 1)
2316 (skip-syntax-forward "(_")
2318 (and (setq try-filename
(thing-at-point
2320 (not (string= "" try-filename
))
2321 (file-readable-p try-filename
)))
2322 (skip-syntax-backward "(_")
2323 (backward-up-list 1)
2324 (skip-syntax-forward "(_"))
2325 (thing-at-point 'filename
)))))
2327 (or (null last-filename
)
2328 (not (string-equal last-filename filename
))))
2330 (with-current-buffer
2331 (if (equal filename
(concat tex-zap-file
".tex"))
2332 tex-last-buffer-texed
2333 (find-file-noselect filename
))
2337 (goto-char (point-min))
2338 (forward-line (1- linenum
))
2339 (setq last-position nil
))
2340 (goto-char last-position
)
2341 (forward-line (- linenum last-linenum
)))
2342 ;; first try a forward search for the error text,
2343 ;; then a backward search limited by the last error.
2344 (let ((starting-point (point)))
2345 (or (re-search-forward error-text nil t
)
2346 (re-search-backward error-text last-position t
)
2347 (goto-char starting-point
)))
2349 (goto-char this-error
)
2350 (if (and compilation-error-list
2351 (or (and find-at-least
2352 (>= num-errors-found
2355 (>= end-of-error limit-search
)))
2357 (setq found-desired t
)
2358 (setq num-errors-found
(1+ num-errors-found
)
2359 last-filename filename
2360 last-linenum linenum
2361 last-position error-location
2362 compilation-error-list
; Add the new error
2363 (cons (cons this-error error-location
)
2364 compilation-error-list
))
2365 (goto-char end-of-error
)))))
2366 (set-marker compilation-parsing-end
(point))
2367 (setq compilation-error-list
(nreverse compilation-error-list
)))
2371 (defun tex-region (beg end
)
2372 "Run TeX on the current region, via a temporary file.
2373 The file's name comes from the variable `tex-zap-file' and the
2374 variable `tex-directory' says where to put it.
2376 If the buffer has a header, the header is given to TeX before the
2377 region itself. The buffer's header is all lines between the strings
2378 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
2379 The header must start in the first 100 lines of the buffer.
2381 The value of `tex-trailer' is given to TeX as input after the region.
2383 The value of `tex-command' specifies the command to use to run TeX."
2385 (if (tex-shell-running)
2389 (setq tex-zap-file
(tex-generate-zap-file-name)))
2390 ;; Temp file will be written and TeX will be run in zap-directory.
2391 ;; If the TEXINPUTS file has relative directories or if the region has
2392 ;; \input of files, this must be the same directory as the file for
2393 ;; TeX to access the correct inputs. That's why it's safest if
2394 ;; tex-directory is ".".
2395 (let* ((zap-directory
2396 (file-name-as-directory (expand-file-name tex-directory
)))
2397 (tex-out-file (expand-file-name (concat tex-zap-file
".tex")
2399 (main-file (expand-file-name (tex-main-file)))
2400 (ismain (string-equal main-file
(buffer-file-name)))
2402 ;; Don't delete temp files if we do the same buffer twice in a row.
2403 (or (eq (current-buffer) tex-last-buffer-texed
)
2404 (tex-delete-last-temp-files t
))
2405 (let ((default-directory zap-directory
)) ; why?
2406 ;; We assume the header is fully contained in tex-main-file.
2407 ;; We use f-f-ns so we get prompted about any changes on disk.
2408 (with-current-buffer (find-file-noselect main-file
)
2409 (setq already-output
(tex-region-header tex-out-file
2411 ;; Write out the specified region (but don't repeat anything
2412 ;; already written in the header).
2413 (write-region (if ismain
2414 (max beg already-output
)
2416 end tex-out-file
(not (zerop already-output
)))
2417 ;; Write the trailer, if any.
2418 ;; Precede it with a newline to make sure it
2419 ;; is not hidden in a comment.
2421 (write-region (concat "\n" tex-trailer
) nil
2423 ;; Record the file name to be deleted afterward.
2424 (setq tex-last-temp-file tex-out-file
)
2425 ;; Use a relative file name here because (1) the proper dir
2426 ;; is already current, and (2) the abs file name is sometimes
2427 ;; too long and can make tex crash.
2428 (tex-start-tex tex-command
(concat tex-zap-file
".tex") zap-directory
)
2429 (setq tex-print-file tex-out-file
)))
2431 (defun tex-region-header (file &optional beg
)
2432 "If there is a TeX header in the current buffer, write it to FILE.
2433 Return point at the end of the region so written, or zero. If
2434 the optional buffer position BEG is specified, then the region
2435 written out starts at BEG, if this lies before the start of the header.
2437 If the first line matches `tex-first-line-header-regexp', it is
2438 also written out. The variables `tex-start-of-header' and
2439 `tex-end-of-header' are used to locate the header. Note that the
2440 start of the header is required to be within the first 100 lines."
2444 (goto-char (point-min))
2445 (let ((search-end (save-excursion
2450 ;; Maybe copy first line, such as `\input texinfo', to temp file.
2451 (and tex-first-line-header-regexp
2452 (looking-at tex-first-line-header-regexp
)
2453 (write-region (point)
2454 (progn (forward-line 1)
2455 (setq already-output
(point)))
2457 ;; Write out the header, if there is one, and any of the
2458 ;; specified region which extends before it. But don't repeat
2459 ;; anything already written.
2460 (and tex-start-of-header
2461 (re-search-forward tex-start-of-header search-end t
)
2464 (setq hbeg
(point)) ; mark beginning of header
2465 (when (re-search-forward tex-end-of-header nil t
)
2467 (setq hend
(point)) ; mark end of header
2473 hend file
(not (zerop already-output
)))
2474 (setq already-output hend
))))
2477 (defun tex-buffer ()
2478 "Run TeX on current buffer. See \\[tex-region] for more information.
2479 Does not save the buffer, so it's useful for trying experimental versions.
2480 See \\[tex-file] for an alternative."
2482 (tex-region (point-min) (point-max)))
2485 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
2486 This function is more useful than \\[tex-buffer] when you need the
2487 `.aux' file of LaTeX to have the correct name."
2489 (when tex-offer-save
2490 (save-some-buffers))
2491 (let* ((source-file (tex-main-file))
2492 (file-dir (file-name-directory (expand-file-name source-file
))))
2493 (if (tex-shell-running)
2496 (tex-start-tex tex-command source-file file-dir
)
2497 (setq tex-print-file
(expand-file-name source-file
))))
2499 (defun tex-generate-zap-file-name ()
2500 "Generate a unique name suitable for use as a file name."
2501 ;; Include the shell process number and host name
2502 ;; in case there are multiple shells (for same or different user).
2503 ;; Dec 1998: There is a report that some versions of xdvi
2504 ;; don't work with file names that start with #.
2506 (process-id (get-buffer-process "*tex-shell*"))
2507 (subst-char-in-string ?. ?-
(system-name))))
2509 ;; This will perhaps be useful for modifying TEXINPUTS.
2510 ;; Expand each file name, separated by colons, in the string S.
2511 (defun tex-expand-files (s)
2512 (let (elts (start 0))
2513 (while (string-match ":" s start
)
2514 (setq elts
(cons (substring s start
(match-beginning 0)) elts
))
2515 (setq start
(match-end 0)))
2517 (setq elts
(cons (substring s start
) elts
)))
2518 (mapconcat (lambda (elt)
2519 (if (= (length elt
) 0) elt
(expand-file-name elt
)))
2520 (nreverse elts
) ":")))
2522 (defun tex-shell-running ()
2523 (let ((proc (get-process "tex-shell")))
2525 (if (and (eq (process-status proc
) 'run
)
2526 (buffer-live-p (process-buffer proc
)))
2527 ;; return the TeX process on success
2529 ;; get rid of the process permanently
2530 ;; this should get rid of the annoying w32 problem with
2531 ;; dead tex-shell buffer and live process
2532 (delete-process proc
)))))
2534 (defun tex-kill-job ()
2535 "Kill the currently running TeX job."
2537 ;; `quit-process' leads to core dumps of the tex process (except if
2538 ;; coredumpsize has limit 0kb as on many environments). One would
2539 ;; like to use (kill-process proc 'lambda), however that construct
2540 ;; does not work on some systems and kills the shell itself.
2541 (let ((proc (get-process "tex-shell")))
2542 (when proc
(quit-process proc t
))))
2544 (defun tex-recenter-output-buffer (linenum)
2545 "Redisplay buffer of TeX job output so that most recent output can be seen.
2546 The last line of the buffer is displayed on
2547 line LINE of the window, or centered if LINE is nil."
2549 (let ((tex-shell (get-buffer "*tex-shell*"))
2551 (if (null tex-shell
)
2552 (message "No TeX output buffer")
2553 (setq window
(display-buffer tex-shell
))
2554 (save-selected-window
2555 (select-window window
)
2556 (bury-buffer tex-shell
)
2557 (goto-char (point-max))
2558 (recenter (if linenum
2559 (prefix-numeric-value linenum
)
2560 (/ (window-height) 2)))))))
2562 (defun tex-print (&optional alt
)
2563 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
2564 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
2565 is provided, use the alternative command, `tex-alt-dvi-print-command'."
2567 (let ((print-file-name-dvi (tex-append tex-print-file
".dvi"))
2569 (if (and (not (equal (current-buffer) tex-last-buffer-texed
))
2571 ;; Check that this buffer's printed file is up to date.
2572 (file-newer-than-file-p
2573 (setq test-name
(tex-append (buffer-file-name) ".dvi"))
2574 (buffer-file-name)))
2575 (setq print-file-name-dvi test-name
))
2576 (if (not (file-exists-p print-file-name-dvi
))
2577 (error "No appropriate `.dvi' file could be found")
2578 (if (tex-shell-running)
2582 (if alt tex-alt-dvi-print-command tex-dvi-print-command
)
2586 (defun tex-alt-print ()
2587 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
2588 Runs the shell command defined by `tex-alt-dvi-print-command'."
2593 "Preview the last `.dvi' file made by running TeX under Emacs.
2594 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
2595 The variable `tex-dvi-view-command' specifies the shell command for preview.
2596 You must set that variable yourself before using this command,
2597 because there is no standard value that would generally work."
2599 (or tex-dvi-view-command
2600 (error "You must set `tex-dvi-view-command'"))
2601 ;; Restart the TeX shell if necessary.
2602 (or (tex-shell-running)
2604 (let ((tex-dvi-print-command (eval tex-dvi-view-command
)))
2607 (defun tex-append (file-name suffix
)
2608 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
2609 Pascal-based TeX scans for the first period, C TeX uses the last.
2610 No period is retained immediately before SUFFIX,
2611 so normally SUFFIX starts with one."
2612 (if (stringp file-name
)
2613 (let ((file (file-name-nondirectory file-name
))
2615 ;; Try splitting on last period.
2616 ;; The first-period split can get fooled when two files
2617 ;; named a.tex and a.b.tex are both tex'd;
2618 ;; the last-period split must be right if it matches at all.
2620 (concat (file-name-directory file-name
)
2622 (string-match "\\.[^.]*$" file
))
2624 (if (or (file-exists-p trial-name
)
2625 (file-exists-p (concat trial-name
".aux"))) ;for BibTeX files
2627 ;; Not found, so split on first period.
2628 (concat (file-name-directory file-name
)
2630 (string-match "\\." file
))
2634 (defun tex-show-print-queue ()
2635 "Show the print queue that \\[tex-print] put your job on.
2636 Runs the shell command defined by `tex-show-queue-command'."
2638 (if (tex-shell-running)
2641 (tex-send-command tex-show-queue-command
)
2642 (tex-display-shell))
2644 (defun tex-bibtex-file ()
2645 "Run BibTeX on the current buffer's file."
2647 (if (tex-shell-running)
2650 (let* (shell-dirtrack-verbose
2651 (source-file (expand-file-name (tex-main-file)))
2653 (tex-append (file-name-nondirectory source-file
) ""))
2654 (file-dir (file-name-directory source-file
)))
2655 (tex-send-command tex-shell-cd-command file-dir
)
2656 (tex-send-command tex-bibtex-command tex-out-file
))
2657 (tex-display-shell))
2660 ;;;; LaTeX indentation
2663 (defvar tex-indent-allhanging t
)
2664 (defvar tex-indent-arg
4)
2665 (defvar tex-indent-basic
2)
2666 (defvar tex-indent-item tex-indent-basic
)
2667 (defvar tex-indent-item-re
"\\\\\\(bib\\)?item\\>")
2668 (defvar latex-noindent-environments
'("document"))
2670 (defvar tex-latex-indent-syntax-table
2671 (let ((st (make-syntax-table tex-mode-syntax-table
)))
2672 (modify-syntax-entry ?$
"." st
)
2673 (modify-syntax-entry ?\
( "." st
)
2674 (modify-syntax-entry ?\
) "." st
)
2676 "Syntax table used while computing indentation.")
2678 (defun latex-indent (&optional arg
)
2679 (if (and (eq (get-text-property (line-beginning-position) 'face
)
2682 (with-syntax-table tex-latex-indent-syntax-table
2683 ;; TODO: Rather than ignore $, we should try to be more clever about it.
2687 (latex-find-indent))))
2688 (if (< indent
0) (setq indent
0))
2689 (if (<= (current-column) (current-indentation))
2690 (indent-line-to indent
)
2691 (save-excursion (indent-line-to indent
)))))))
2693 (defcustom latex-indent-within-escaped-parens nil
2694 "Non-nil means add extra indent to text within escaped parens.
2695 When this is non-nil, text within matching pairs of escaped
2696 parens is indented at the column following the open paren. The
2697 default value does not add any extra indent thus providing the
2698 behavior of Emacs 22 and earlier."
2703 (defun latex-find-indent (&optional virtual
)
2704 "Find the proper indentation of text after point.
2705 VIRTUAL if non-nil indicates that we're only trying to find the indentation
2706 in order to determine the indentation of something else.
2707 There might be text before point."
2708 (let ((latex-handle-escaped-parens latex-indent-within-escaped-parens
))
2710 (skip-chars-forward " \t")
2712 ;; Stick the first line at column 0.
2713 (and (= (point-min) (line-beginning-position)) 0)
2714 ;; Trust the current indentation, if such info is applicable.
2715 (and virtual
(save-excursion (skip-chars-backward " \t&") (bolp))
2717 ;; Stick verbatim environments to the left margin.
2718 (and (looking-at "\\\\\\(begin\\|end\\) *{\\([^\n}]+\\)")
2719 (member (match-string 2) tex-verbatim-environments
)
2721 ;; Put leading close-paren where the matching open paren would be.
2723 (and (or (eq (latex-syntax-after) ?\
))
2724 ;; Try to handle escaped close parens but keep
2725 ;; original position if it doesn't work out.
2726 (and latex-handle-escaped-parens
2727 (setq escaped
(looking-at "\\\\\\([])}]\\)"))))
2731 (goto-char (match-beginning 1)))
2732 (latex-skip-close-parens)
2733 (latex-backward-sexp-1)
2734 (latex-find-indent 'virtual
)))))
2735 ;; Default (maybe an argument)
2737 ;; Outdent \item if necessary.
2738 (indent (if (looking-at tex-indent-item-re
) (- tex-indent-item
) 0))
2740 ;; Find the previous point which determines our current indentation.
2743 (latex-backward-sexp-1)
2744 (while (> (current-column) (current-indentation))
2745 (latex-backward-sexp-1)))
2747 (setq up-list-pos
(nth 2 err
))))
2749 ((= (point-min) pos
) 0) ; We're really just indenting the first line.
2750 ((integerp up-list-pos
)
2751 ;; Have to indent relative to the open-paren.
2752 (goto-char up-list-pos
)
2753 (if (and (not tex-indent-allhanging
)
2755 ;; Make sure we're an argument to a macro and
2756 ;; that the macro is at the beginning of a line.
2759 (while (eq (char-syntax (char-after)) ?\
()
2761 (and (eq (char-syntax (char-after)) ?
/)
2762 (progn (skip-chars-backward " \t&")
2765 (> pos
(progn (latex-down-list)
2766 (forward-comment (point-max))
2768 ;; Align with the first element after the open-paren.
2770 ;; We're the first element after a hanging brace.
2771 (goto-char up-list-pos
)
2772 (+ (if (and (looking-at "\\\\begin *{\\([^\n}]+\\)")
2773 (member (match-string 1)
2774 latex-noindent-environments
))
2776 indent
(latex-find-indent 'virtual
))))
2777 ;; We're now at the "beginning" of a line.
2778 ((not (and (not virtual
) (eq (char-after) ?
\\)))
2779 ;; Nothing particular here: just keep the same indentation.
2780 (+ indent
(current-column)))
2781 ;; We're now looking at a macro call.
2782 ((looking-at tex-indent-item-re
)
2783 ;; Indenting relative to an item, have to re-add the outdenting.
2784 (+ indent
(current-column) tex-indent-item
))
2786 (let ((col (current-column)))
2787 (if (or (not (eq (char-syntax (or (char-after pos
) ?\s
)) ?\
())
2788 ;; Can't be an arg if there's an empty line inbetween.
2789 (save-excursion (re-search-forward "^[ \t]*$" pos t
)))
2790 ;; If the first char was not an open-paren, there's
2791 ;; a risk that this is really not an argument to the
2795 (if (< (line-end-position)
2796 (save-excursion (forward-comment (point-max))
2798 ;; we're indenting the first argument.
2799 (min (current-column) (+ tex-indent-arg col
))
2800 (skip-syntax-forward " ")
2801 (current-column)))))))))))
2804 (defun doctex-font-lock-^^A
()
2805 (if (eq (char-after (line-beginning-position)) ?\%
)
2808 (1- (match-beginning 1)) (match-beginning 1)
2810 (if (= (1+ (line-beginning-position)) (match-beginning 1))
2811 ;; The `%' is a single-char comment, which Emacs
2812 ;; syntax-table can't deal with. We could turn it
2813 ;; into a non-comment, or use `\n%' or `%^' as the comment.
2814 ;; Instead, we include it in the ^^A comment.
2815 (eval-when-compile (string-to-syntax "< b"))
2816 (eval-when-compile (string-to-syntax ">"))))
2817 (let ((end (line-end-position)))
2818 (if (< end
(point-max))
2822 (eval-when-compile (string-to-syntax "> b")))))
2823 (eval-when-compile (string-to-syntax "< b")))))
2825 (defun doctex-font-lock-syntactic-face-function (state)
2826 ;; Mark DocTeX documentation, which is parsed as a style A comment
2827 ;; starting in column 0.
2828 (if (or (nth 3 state
) (nth 7 state
)
2829 (not (memq (char-before (nth 8 state
))
2831 ;; Anything else is just as for LaTeX.
2832 (tex-font-lock-syntactic-face-function state
)
2833 font-lock-doc-face
))
2835 (defvar doctex-font-lock-syntactic-keywords
2837 tex-font-lock-syntactic-keywords
2838 ;; For DocTeX comment-in-doc.
2839 `(("\\(\\^\\)\\^A" (1 (doctex-font-lock-^^A
))))))
2841 (defvar doctex-font-lock-keywords
2842 (append tex-font-lock-keywords
2843 '(("^%<[^>]*>" (0 font-lock-preprocessor-face t
)))))
2846 (define-derived-mode doctex-mode latex-mode
"DocTeX"
2847 "Major mode to edit DocTeX files."
2848 (setq font-lock-defaults
2849 (cons (append (car font-lock-defaults
) '(doctex-font-lock-keywords))
2853 (font-lock-syntactic-face-function
2854 (cons (car x
) 'doctex-font-lock-syntactic-face-function
))
2856 (cdr font-lock-defaults
))))
2857 (set (make-local-variable 'syntax-propertize-function
)
2858 (syntax-propertize-via-font-lock doctex-font-lock-syntactic-keywords
)))
2860 (run-hooks 'tex-mode-load-hook
)
2864 ;; arch-tag: c0a680b1-63aa-4547-84b9-4193c29c0080
2865 ;;; tex-mode.el ends here