1 ;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 86, 89, 92, 94, 95, 96, 97, 98, 1999, 2002
4 ;; Free Software Foundation, Inc.
9 ;; Contributions over the years by William F. Schelter, Dick King,
10 ;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold.
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
33 ;; Pacify the byte-compiler
42 (defgroup tex-file nil
43 "TeX files and directories"
48 "Running external commands from TeX mode"
52 (defgroup tex-view nil
53 "Viewing and printing TeX files"
58 (defcustom tex-shell-file-name nil
59 "*If non-nil, the shell file name to run in the subshell used to run TeX."
60 :type
'(choice (const :tag
"None" nil
)
65 (defcustom tex-directory
"."
66 "*Directory in which temporary files are written.
67 You can make this `/tmp' if your TEXINPUTS has no relative directories in it
68 and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
69 `\\input' commands with relative directories."
74 (defcustom tex-first-line-header-regexp nil
75 "Regexp for matching a first line which `tex-region' should include.
76 If this is non-nil, it should be a regular expression string;
77 if it matches the first line of the file,
78 `tex-region' always includes the first line in the TeX run."
79 :type
'(choice (const :tag
"None" nil
)
84 (defcustom tex-main-file nil
85 "*The main TeX source file which includes this buffer's file.
86 The command `tex-file' runs TeX on the file specified by `tex-main-file'
87 if the variable is non-nil."
88 :type
'(choice (const :tag
"None" nil
)
93 (defcustom tex-offer-save t
94 "*If non-nil, ask about saving modified buffers before \\[tex-file] is run."
99 (defcustom tex-run-command
"tex"
100 "*Command used to run TeX subjob.
101 TeX Mode sets `tex-command' to this string.
102 See the documentation of that variable."
107 (defcustom latex-run-command
"latex"
108 "*Command used to run LaTeX subjob.
109 LaTeX Mode sets `tex-command' to this string.
110 See the documentation of that variable."
115 (defcustom slitex-run-command
"slitex"
116 "*Command used to run SliTeX subjob.
117 SliTeX Mode sets `tex-command' to this string.
118 See the documentation of that variable."
123 (defcustom tex-start-options
""
124 "*TeX options to use when starting TeX.
125 These immediately precede the commands in `tex-start-commands'
126 and the input file name, with no separating space and are not shell-quoted.
127 If nil, TeX runs with no options. See the documentation of `tex-command'."
133 (defcustom tex-start-commands
"\\nonstopmode\\input"
134 "*TeX commands to use when starting TeX.
135 They are shell-quoted and precede the input file name, with a separating space.
136 If nil, no commands are used. See the documentation of `tex-command'."
137 :type
'(radio (const :tag
"Interactive \(nil\)" nil
)
138 (const :tag
"Nonstop \(\"\\nonstopmode\\input\"\)"
139 "\\nonstopmode\\input")
140 (string :tag
"String at your choice"))
144 (defvar latex-standard-block-names
145 '("abstract" "array" "center" "description"
146 "displaymath" "document" "enumerate" "eqnarray"
147 "eqnarray*" "equation" "figure" "figure*"
148 "flushleft" "flushright" "itemize" "letter"
149 "list" "minipage" "picture" "quotation"
150 "quote" "slide" "sloppypar" "tabbing"
151 "table" "table*" "tabular" "tabular*"
152 "thebibliography" "theindex*" "titlepage" "trivlist"
153 "verbatim" "verbatim*" "verse" "math")
154 "Standard LaTeX block names.")
157 (defcustom latex-block-names nil
158 "*User defined LaTeX block names.
159 Combined with `latex-standard-block-names' for minibuffer completion."
160 :type
'(repeat string
)
164 (defcustom tex-bibtex-command
"bibtex"
165 "*Command used by `tex-bibtex-file' to gather bibliographic data.
166 If this string contains an asterisk (`*'), that is replaced by the file name;
167 otherwise, the file name, preceded by blank, is added at the end."
172 (defcustom tex-dvi-print-command
"lpr -d"
173 "*Command used by \\[tex-print] to print a .dvi file.
174 If this string contains an asterisk (`*'), that is replaced by the file name;
175 otherwise, the file name, preceded by blank, is added at the end."
180 (defcustom tex-alt-dvi-print-command
"lpr -d"
181 "*Command used by \\[tex-print] with a prefix arg to print a .dvi file.
182 If this string contains an asterisk (`*'), that is replaced by the file name;
183 otherwise, the file name, preceded by blank, is added at the end.
185 If two printers are not enough of a choice, you can set the variable
186 `tex-alt-dvi-print-command' to an expression that asks what you want;
189 (setq tex-alt-dvi-print-command
190 '(format \"lpr -P%s\" (read-string \"Use printer: \")))
192 would tell \\[tex-print] with a prefix argument to ask you which printer to
194 :type
'(choice (string :tag
"Command")
195 (sexp :tag
"Expression"))
199 (defcustom tex-dvi-view-command
'(if (eq window-system
'x
) \"xdvi
\" \"dvi2tty
* | cat -s
\")
200 "*Command used by \\[tex-view] to display a `.dvi' file.
201 If it is a string, that specifies the command directly.
202 If this string contains an asterisk (`*'), that is replaced by the file name;
203 otherwise, the file name, preceded by a space, is added at the end.
205 If the value is a form, it is evaluated to get the command to use."
206 :type
'(choice (const nil
) string sexp
)
210 (defcustom tex-show-queue-command
"lpq"
211 "*Command used by \\[tex-show-print-queue] to show the print queue.
212 Should show the queue(s) that \\[tex-print] puts jobs on."
217 (defcustom tex-default-mode
'latex-mode
218 "*Mode to enter for a new file that might be either TeX or LaTeX.
219 This variable is used when it can't be determined whether the file
220 is plain TeX or LaTeX or what because the file contains no commands.
221 Normally set to either `plain-tex-mode' or `latex-mode'."
226 (defcustom tex-open-quote
"``"
227 "*String inserted by typing \\[tex-insert-quote] to open a quotation."
229 :options
'("``" "\"<" "\"`" "<<" "«")
233 (defcustom tex-close-quote
"''"
234 "*String inserted by typing \\[tex-insert-quote] to close a quotation."
236 :options
'("''" "\">" "\"'" ">>" "»")
239 (defvar tex-last-temp-file nil
240 "Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
241 Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
242 tex shell terminates.")
244 (defvar tex-command
"tex"
245 "*Command to run TeX.
246 If this string contains an asterisk \(`*'\), that is replaced by the file name;
247 otherwise the value of `tex-start-options', the \(shell-quoted\)
248 value of `tex-start-commands', and the file name are added at the end
249 with blanks as separators.
251 In TeX, LaTeX, and SliTeX Mode this variable becomes buffer local.
252 In these modes, use \\[set-variable] if you want to change it for the
255 (defvar tex-trailer nil
256 "String appended after the end of a region sent to TeX by \\[tex-region].")
258 (defvar tex-start-of-header nil
259 "Regular expression used by \\[tex-region] to find start of file's header.")
261 (defvar tex-end-of-header nil
262 "Regular expression used by \\[tex-region] to find end of file's header.")
264 (defvar tex-shell-cd-command
"cd"
265 "Command to give to shell running TeX to change directory.
266 The value of `tex-directory' is appended to this, separated by a space.")
268 (defvar tex-zap-file nil
269 "Temporary file name used for text being sent as input to TeX.
270 Should be a simple file name with no extension or directory specification.")
272 (defvar tex-last-buffer-texed nil
273 "Buffer which was last TeXed.")
275 (defvar tex-print-file nil
276 "File name that \\[tex-print] prints.
277 Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
279 (easy-mmode-defsyntax tex-mode-syntax-table
295 "Syntax table used while in TeX mode.")
301 (defcustom latex-imenu-indent-string
". "
302 "*String to add repeated in front of nested sectional units for Imenu.
303 An alternative value is \" . \", if you use a font with a narrow period."
307 (defvar latex-section-alist
308 '(("part" .
0) ("chapter" .
1)
309 ("section" .
2) ("subsection" .
3)
310 ("subsubsection" .
4)
311 ("paragraph" .
5) ("subparagraph" .
6)))
313 (defvar latex-metasection-list
314 '("documentstyle" "documentclass"
315 "begin{document}" "end{document}"
316 "appendix" "frontmatter" "mainmatter" "backmatter"))
318 (defun latex-imenu-create-index ()
319 "Generate an alist for imenu from a LaTeX buffer."
320 (let ((section-regexp
321 (concat "\\\\" (regexp-opt (mapcar 'car latex-section-alist
) t
)
324 (concat "\\\\" (regexp-opt latex-metasection-list t
)))
325 i0 menu case-fold-search
)
327 ;; Find the top-most level in this file but don't allow it to be
328 ;; any deeper than "section" (which is top-level in an article).
329 (goto-char (point-min))
330 (if (search-forward-regexp "\\\\part\\*?[ \t]*{" nil t
)
332 (if (search-forward-regexp "\\\\chapter\\*?[ \t]*{" nil t
)
336 ;; Look for chapters and sections.
337 (goto-char (point-min))
338 (while (search-forward-regexp section-regexp nil t
)
339 (let ((start (match-beginning 0))
341 (i (cdr (assoc (buffer-substring-no-properties
344 latex-section-alist
))))
348 ;; Using sexps allows some use of matching {...} inside
351 (push (cons (concat (apply 'concat
354 latex-imenu-indent-string
))
355 (buffer-substring-no-properties
361 ;; Look for included material.
362 (goto-char (point-min))
363 (while (search-forward-regexp
364 "\\\\\\(include\\|input\\|verbatiminput\\|bibliography\\)\
365 \[ \t]*{\\([^}\n]+\\)}"
367 (push (cons (concat "<<" (buffer-substring-no-properties
370 (if (= (char-after (match-beginning 1)) ?b
)
376 ;; Look for \frontmatter, \mainmatter, \backmatter, and \appendix.
377 (goto-char (point-min))
378 (while (search-forward-regexp metasection-regexp nil t
)
379 (push (cons "--" (match-beginning 0)) menu
))
381 ;; Sort in increasing buffer position order.
382 (sort menu
(function (lambda (a b
) (< (cdr a
) (cdr b
))))))))
388 (defvar latex-outline-regexp
390 (regexp-opt (append latex-metasection-list
391 (mapcar 'car latex-section-alist
)) t
)))
393 (defun latex-outline-level ()
394 (if (looking-at latex-outline-regexp
)
395 (1+ (or (cdr (assoc (match-string 1) latex-section-alist
)) -
1))
399 ;;;; Font-Lock support
402 ;(defvar tex-font-lock-keywords
403 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
404 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
405 ; 2 font-lock-function-name-face)
406 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
407 ; 2 font-lock-constant-face)
408 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
409 ; ;; not be able to display those fonts.
410 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
411 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
412 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
413 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
414 ; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
415 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
416 ; 2 font-lock-function-name-face)
417 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
418 ; 2 font-lock-constant-face)
419 ; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
420 ; "\\\\\\([a-zA-Z@]+\\|.\\)"
421 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
422 ; ;; not be able to display those fonts.
423 ; ;; LaTeX2e: \emph{This is emphasized}.
424 ; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
425 ; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
426 ; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
427 ; 3 (if (match-beginning 2) 'bold 'italic) keep)
428 ; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
429 ; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
430 ; 3 (if (match-beginning 2) 'bold 'italic) keep))
432 ;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
433 (defconst tex-font-lock-keywords-1
435 (let* (;; Names of commands whose arg should be fontified as heading, etc.
436 (headings (regexp-opt
437 '("title" "begin" "end" "chapter" "part"
438 "section" "subsection" "subsubsection"
439 "paragraph" "subparagraph" "subsubparagraph"
440 "newcommand" "renewcommand" "providecommand"
441 "newenvironment" "renewenvironment"
442 "newtheorem" "renewtheorem")
444 (variables (regexp-opt
445 '("newcounter" "newcounter*" "setcounter" "addtocounter"
446 "setlength" "addtolength" "settowidth")
448 (includes (regexp-opt
449 '("input" "include" "includeonly" "bibliography"
450 "epsfig" "psfig" "epsf" "nofiles" "usepackage"
451 "documentstyle" "documentclass" "verbatiminput"
452 "includegraphics" "includegraphics*")
456 (opt " *\\(\\[[^]]*\\] *\\)*")
457 ;; This would allow highlighting \newcommand\CMD but requires
458 ;; adapting subgroup numbers below.
459 ;; (arg "\\(?:{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)\\|\\\\[a-z*]+\\)"))
460 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
462 ;; display $$ math $$
463 ;; We only mark the match between $$ and $$ because the $$ delimiters
464 ;; themselves have already been marked (along with $..$) by syntactic
465 ;; fontification. Also this is done at the very beginning so as to
466 ;; interact with the other keywords in the same way as $...$ does.
467 (list "\\$\\$\\([^$]+\\)\\$\\$" 1 'tex-math-face
)
469 (list (concat slash headings
"\\*?" opt arg
)
470 ;; If ARG ends up matching too much (if the {} don't match, f.ex)
471 ;; jit-lock will do funny things: when updating the buffer
472 ;; the re-highlighting is only done locally so it will just
473 ;; match the local line, but defer-contextually will
474 ;; match more lines at a time, so ARG will end up matching
475 ;; a lot more, which might suddenly include a comment
476 ;; so you get things highlighted bold when you type them
477 ;; but they get turned back to normal a little while later
478 ;; because "there's already a face there".
479 ;; Using `keep' works around this un-intuitive behavior as well
480 ;; as improves the behavior in the very rare case where you do
481 ;; have a comment in ARG.
482 3 'font-lock-function-name-face
'keep
)
483 (list (concat slash
"\\(?:provide\\|\\(?:re\\)?new\\)command\\** *\\(\\\\[A-Za-z@]+\\)")
484 1 'font-lock-function-name-face
'keep
)
486 (list (concat slash variables
" *" arg
) 2 'font-lock-variable-name-face
)
488 (list (concat slash includes opt arg
) 3 'font-lock-builtin-face
)
489 ;; Definitions. I think.
490 '("^[ \t]*\\\\def *\\\\\\(\\(\\w\\|@\\)+\\)"
491 1 font-lock-function-name-face
))))
492 "Subdued expressions to highlight in TeX modes.")
494 (defconst tex-font-lock-keywords-2
495 (append tex-font-lock-keywords-1
498 ;; Names of commands whose arg should be fontified with fonts.
499 (bold (regexp-opt '("textbf" "textsc" "textup"
500 "boldsymbol" "pmb") t
))
501 (italic (regexp-opt '("textit" "textsl" "emph") t
))
502 ;; FIXME: unimplemented yet.
503 ;; (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
505 ;; Names of commands whose arg should be fontified as a citation.
506 (citations (regexp-opt
507 '("label" "ref" "pageref" "vref" "eqref"
508 "cite" "nocite" "index" "glossary" "bibitem"
509 ;; These are text, rather than citations.
510 ;; "caption" "footnote" "footnotemark" "footnotetext"
514 ;; Names of commands that should be fontified.
515 (specials-1 (regexp-opt '("\\" "\\*") t
)) ;; "-"
516 (specials-2 (regexp-opt
517 '("linebreak" "nolinebreak" "pagebreak" "nopagebreak"
518 "newline" "newpage" "clearpage" "cleardoublepage"
519 "displaybreak" "allowdisplaybreaks"
520 "enlargethispage") t
))
521 (general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
525 (opt " *\\(\\[[^]]*\\] *\\)*")
526 (args "\\(\\(?:[^{}&\\]+\\|\\\\.\\|{[^}]*}\\)+\\)")
527 (arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
531 (list (concat slash citations opt arg
) 3 'font-lock-constant-face
)
533 ;; Text between `` quotes ''.
534 (cons (concat (regexp-opt `("``" "\"<" "\"`" "<<" "«") t
)
535 "[^'\">{]+" ;a bit pessimistic
536 (regexp-opt `("''" "\">" "\"'" ">>" "»") t
))
537 'font-lock-string-face
)
539 ;; Command names, special and general.
540 (cons (concat slash specials-1
) 'font-lock-warning-face
)
541 (list (concat "\\(" slash specials-2
"\\)\\([^a-zA-Z@]\\|\\'\\)")
542 1 'font-lock-warning-face
)
543 (concat slash general
)
545 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
546 ;; since we might not be able to display those fonts.
547 (list (concat slash bold
" *" arg
) 2 '(quote bold
) 'append
)
548 (list (concat slash italic
" *" arg
) 2 '(quote italic
) 'append
)
549 ;; (list (concat slash type arg) 2 '(quote bold-italic) 'append)
551 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
552 (list (concat "\\\\\\(em\\|it\\|sl\\)\\>" args
)
553 2 '(quote italic
) 'append
)
554 ;; This is separate from the previous one because of cases like
555 ;; {\em foo {\bf bar} bla} where both match.
556 (list (concat "\\\\bf\\>" args
) 1 '(quote bold
) 'append
)))))
557 "Gaudy expressions to highlight in TeX modes.")
559 (defun tex-font-lock-suscript (pos)
560 (unless (or (memq (get-text-property pos
'face
)
561 '(font-lock-constant-face font-lock-builtin-face
562 font-lock-comment-face tex-verbatim-face
))
563 ;; Check for backslash quoting
566 (while (eq (char-before pos
) ?
\\)
567 (setq pos
(1- pos
) odd
(not odd
)))
569 (if (eq (char-after pos
) ?_
)
570 '(face subscript display
(raise -
0.3))
571 '(face superscript display
(raise +0.3)))))
573 (defconst tex-font-lock-keywords-3
574 (append tex-font-lock-keywords-2
576 (let ((general "\\([a-zA-Z@]+\\|[^ \t\n]\\)")
578 ;; This is not the same regexp as before: it has a `+' removed.
579 ;; The + makes the matching faster in the above cases (where we can
580 ;; exit as soon as the match fails) but would make this matching
581 ;; degenerate to nasty complexity (because we try to match the
582 ;; closing brace, which forces trying all matching combinations).
583 (arg "{\\(?:[^{}\\]\\|\\\\.\\|{[^}]*}\\)*"))
584 `((,(concat "[_^] *\\([^\n\\{}]\\|" slash general
"\\|" arg
"}\\)")
585 (1 (tex-font-lock-suscript (match-beginning 0))
587 "Experimental expressions to highlight in TeX modes.")
589 (defvar tex-font-lock-keywords tex-font-lock-keywords-1
590 "Default expressions to highlight in TeX modes.")
592 (defvar tex-verbatim-environments
593 '("verbatim" "verbatim*"))
595 (defvar tex-font-lock-syntactic-keywords
596 (let ((verbs (regexp-opt tex-verbatim-environments t
)))
597 `((,(concat "^\\\\begin *{" verbs
"}.*\\(\n\\)") 2 "|")
598 (,(concat "^\\\\end *{" verbs
"}\\(.?\\)") 2
599 (unless (<= (match-beginning 0) (point-min))
600 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
601 'syntax-table
(string-to-syntax "|"))
603 ;; ("^\\(\\\\\\)begin *{comment}" 1 "< b")
604 ;; ("^\\\\end *{comment}.*\\(\n\\)" 1 "> b")
605 ("\\\\verb\\**\\([^a-z@*]\\)" 1 "\""))))
607 (defun tex-font-lock-unfontify-region (beg end
)
608 (font-lock-default-unfontify-region beg end
)
610 (let ((next (next-single-property-change beg
'display nil end
))
611 (prop (get-text-property beg
'display
)))
612 (if (and (eq (car-safe prop
) 'raise
)
613 (member (car-safe (cdr prop
)) '(-0.3
+0.3))
615 (put-text-property beg next
'display nil
))
619 '((t :height
0.8)) ;; :raise 0.3
620 "Face used for superscripts.")
622 '((t :height
0.8)) ;; :raise -0.3
623 "Face used for subscripts.")
625 (defface tex-math-face
626 '((t :inherit font-lock-string-face
))
627 "Face used to highlight TeX math expressions.")
628 (defvar tex-math-face
'tex-math-face
)
629 (defface tex-verbatim-face
630 ;; '((t :inherit font-lock-string-face))
631 '((t :family
"courier"))
632 "Face used to highlight TeX verbatim environments.")
633 (defvar tex-verbatim-face
'tex-verbatim-face
)
635 ;; Use string syntax but math face for $...$.
636 (defun tex-font-lock-syntactic-face-function (state)
637 (let ((char (nth 3 state
)))
639 ((not char
) font-lock-comment-face
)
640 ((eq char ?$
) tex-math-face
)
642 (when (char-valid-p char
)
643 ;; This is a \verb?...? construct. Let's find the end and mark it.
645 (skip-chars-forward (string ?^ char
)) ;; Use `end' ?
646 (when (eq (char-syntax (preceding-char)) ?
/)
647 (put-text-property (1- (point)) (point) 'syntax-table
'(1)))
649 (put-text-property (point) (1+ (point)) 'syntax-table
'(7)))))
650 tex-verbatim-face
))))
653 (defun tex-define-common-keys (keymap)
654 "Define the keys that we want defined both in TeX mode and in the TeX shell."
655 (define-key keymap
"\C-c\C-k" 'tex-kill-job
)
656 (define-key keymap
"\C-c\C-l" 'tex-recenter-output-buffer
)
657 (define-key keymap
"\C-c\C-q" 'tex-show-print-queue
)
658 (define-key keymap
"\C-c\C-p" 'tex-print
)
659 (define-key keymap
"\C-c\C-v" 'tex-view
)
661 (define-key keymap
[menu-bar tex
] (cons "TeX" (make-sparse-keymap "TeX")))
663 (define-key keymap
[menu-bar tex tex-kill-job
]
664 '(menu-item "Tex Kill" tex-kill-job
:enable
(tex-shell-running)))
665 (define-key keymap
[menu-bar tex tex-recenter-output-buffer
]
666 '(menu-item "Tex Recenter" tex-recenter-output-buffer
667 :enable
(get-buffer "*tex-shell*")))
668 (define-key keymap
[menu-bar tex tex-show-print-queue
]
669 '("Show Print Queue" . tex-show-print-queue
))
670 (define-key keymap
[menu-bar tex tex-alt-print
]
671 '(menu-item "Tex Print (alt printer)" tex-alt-print
672 :enable
(stringp tex-print-file
)))
673 (define-key keymap
[menu-bar tex tex-print
]
674 '(menu-item "Tex Print" tex-print
:enable
(stringp tex-print-file
)))
675 (define-key keymap
[menu-bar tex tex-view
]
676 '(menu-item "Tex View" tex-view
:enable
(stringp tex-print-file
))))
679 (let ((map (make-sparse-keymap)))
680 (set-keymap-parent map text-mode-map
)
681 (tex-define-common-keys map
)
682 (define-key map
"\"" 'tex-insert-quote
)
683 (define-key map
"(" 'skeleton-pair-insert-maybe
)
684 (define-key map
"{" 'skeleton-pair-insert-maybe
)
685 (define-key map
"[" 'skeleton-pair-insert-maybe
)
686 (define-key map
"$" 'skeleton-pair-insert-maybe
)
687 (define-key map
"\n" 'tex-terminate-paragraph
)
688 (define-key map
"\M-\r" 'latex-insert-item
)
689 (define-key map
"\C-c}" 'up-list
)
690 (define-key map
"\C-c{" 'tex-insert-braces
)
691 (define-key map
"\C-c\C-r" 'tex-region
)
692 (define-key map
"\C-c\C-b" 'tex-buffer
)
693 (define-key map
"\C-c\C-f" 'tex-file
)
694 (define-key map
"\C-c\C-i" 'tex-bibtex-file
)
695 (define-key map
"\C-c\C-o" 'latex-insert-block
)
696 (define-key map
"\C-c\C-e" 'latex-close-block
)
697 (define-key map
"\C-c\C-u" 'tex-goto-last-unclosed-latex-block
)
698 (define-key map
"\C-c\C-m" 'tex-feed-input
)
699 (define-key map
[(control return
)] 'tex-feed-input
)
700 (define-key map
[menu-bar tex tex-bibtex-file
]
701 '("BibTeX File" . tex-bibtex-file
))
702 (define-key map
[menu-bar tex tex-validate-region
]
703 '(menu-item "Validate Region" tex-validate-region
:enable mark-active
))
704 (define-key map
[menu-bar tex tex-validate-buffer
]
705 '("Validate Buffer" . tex-validate-buffer
))
706 (define-key map
[menu-bar tex tex-region
]
707 '(menu-item "TeX Region" tex-region
:enable mark-active
))
708 (define-key map
[menu-bar tex tex-buffer
]
709 '("TeX Buffer" . tex-buffer
))
710 (define-key map
[menu-bar tex tex-file
] '("TeX File" . tex-file
))
712 "Keymap shared by TeX modes.")
714 (defvar latex-mode-map
715 (let ((map (make-sparse-keymap)))
716 (set-keymap-parent map tex-mode-map
)
717 (define-key map
"\C-c\C-s" 'latex-split-block
)
719 "Keymap for `latex-mode'. See also `tex-mode-map'.")
721 (defvar plain-tex-mode-map
722 (let ((map (make-sparse-keymap)))
723 (set-keymap-parent map tex-mode-map
)
725 "Keymap for `plain-tex-mode'. See also `tex-mode-map'.")
727 (defvar tex-shell-map
728 (let ((m (make-sparse-keymap)))
729 (set-keymap-parent m shell-mode-map
)
730 (tex-define-common-keys m
)
732 "Keymap for the TeX shell.
733 Inherits `shell-mode-map' with a few additions.")
735 (defvar tex-face-alist
738 (bold-italic .
"{\\bi ") ; hypothetical
739 (underline .
"\\underline{")
740 (default .
"{\\rm "))
741 "Alist of face and TeX font name for facemenu.")
743 (defvar tex-latex-face-alist
744 `((italic .
"{\\em ")
746 "Alist of face and LaTeX font name for facemenu.")
748 ;; This would be a lot simpler if we just used a regexp search,
749 ;; but then it would be too slow.
750 (defun tex-guess-mode ()
751 (let ((mode tex-default-mode
) slash comment
)
753 (goto-char (point-min))
754 (while (and (setq slash
(search-forward "\\" nil t
))
755 (setq comment
(let ((search-end (point)))
758 (search-forward "%" search-end t
))))))
759 (when (and slash
(not comment
))
764 (regexp-opt '("documentstyle" "documentclass"
765 "begin" "subsection" "section"
766 "part" "chapter" "newcommand") 'words
)
767 "\\|NeedsTeXFormat{LaTeX")))
769 "document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
775 ;; `tex-mode' plays two roles: it's the parent of several sub-modes
776 ;; but it's also the function that chooses between those submodes.
777 ;; To tell the difference between those two cases where the function
778 ;; might be called, we check `delay-mode-hooks'.
780 (define-derived-mode tex-mode text-mode
"generic-TeX"
781 (tex-common-initialization))
784 "Major mode for editing files of input for TeX, LaTeX, or SliTeX.
785 Tries to determine (by looking at the beginning of the file) whether
786 this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
787 `latex-mode', or `slitex-mode', respectively. If it cannot be determined,
788 such as if there are no commands in the file, the value of `tex-default-mode'
789 says which mode to use."
792 ;; We're called from one of the children already.
793 (funcall ,(symbol-function 'tex-mode
))
797 (defalias 'TeX-mode
'tex-mode
)
799 (defalias 'plain-TeX-mode
'plain-tex-mode
)
801 (defalias 'LaTeX-mode
'latex-mode
)
804 (define-derived-mode plain-tex-mode tex-mode
"TeX"
805 "Major mode for editing files of input for plain TeX.
806 Makes $ and } display the characters they match.
807 Makes \" insert `` when it seems to be the beginning of a quotation,
808 and '' when it appears to be the end; it inserts \" only after a \\.
810 Use \\[tex-region] to run TeX on the current region, plus a \"header\"
811 copied from the top of the file (containing macro definitions, etc.),
812 running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
813 \\[tex-file] saves the buffer and then processes the file.
814 \\[tex-print] prints the .dvi file made by any of these.
815 \\[tex-view] previews the .dvi file made by any of these.
816 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
818 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
819 mismatched $'s or braces.
822 \\{plain-tex-mode-map}
826 Command string used by \\[tex-region] or \\[tex-buffer].
828 Directory in which to create temporary files for TeX jobs
829 run by \\[tex-region] or \\[tex-buffer].
830 tex-dvi-print-command
831 Command string used by \\[tex-print] to print a .dvi file.
832 tex-alt-dvi-print-command
833 Alternative command string used by \\[tex-print] (when given a prefix
834 argument) to print a .dvi file.
836 Command string used by \\[tex-view] to preview a .dvi file.
837 tex-show-queue-command
838 Command string used by \\[tex-show-print-queue] to show the print
839 queue that \\[tex-print] put your job on.
841 Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
842 `tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
843 special subshell is initiated, the hook `tex-shell-hook' is run."
844 (set (make-local-variable 'tex-command
) tex-run-command
)
845 (set (make-local-variable 'tex-start-of-header
) "%\\*\\*start of header")
846 (set (make-local-variable 'tex-end-of-header
) "%\\*\\*end of header")
847 (set (make-local-variable 'tex-trailer
) "\\bye\n"))
850 (define-derived-mode latex-mode tex-mode
"LaTeX"
851 "Major mode for editing files of input for LaTeX.
852 Makes $ and } display the characters they match.
853 Makes \" insert `` when it seems to be the beginning of a quotation,
854 and '' when it appears to be the end; it inserts \" only after a \\.
856 Use \\[tex-region] to run LaTeX on the current region, plus the preamble
857 copied from the top of the file (containing \\documentstyle, etc.),
858 running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
859 \\[tex-file] saves the buffer and then processes the file.
860 \\[tex-print] prints the .dvi file made by any of these.
861 \\[tex-view] previews the .dvi file made by any of these.
862 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
864 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
865 mismatched $'s or braces.
872 Command string used by \\[tex-region] or \\[tex-buffer].
874 Directory in which to create temporary files for LaTeX jobs
875 run by \\[tex-region] or \\[tex-buffer].
876 tex-dvi-print-command
877 Command string used by \\[tex-print] to print a .dvi file.
878 tex-alt-dvi-print-command
879 Alternative command string used by \\[tex-print] (when given a prefix
880 argument) to print a .dvi file.
882 Command string used by \\[tex-view] to preview a .dvi file.
883 tex-show-queue-command
884 Command string used by \\[tex-show-print-queue] to show the print
885 queue that \\[tex-print] put your job on.
887 Entering Latex mode runs the hook `text-mode-hook', then
888 `tex-mode-hook', and finally `latex-mode-hook'. When the special
889 subshell is initiated, `tex-shell-hook' is run."
890 (set (make-local-variable 'tex-command
) latex-run-command
)
891 (set (make-local-variable 'tex-start-of-header
)
892 "\\\\document\\(style\\|class\\)")
893 (set (make-local-variable 'tex-end-of-header
) "\\\\begin\\s-*{document}")
894 (set (make-local-variable 'tex-trailer
) "\\end\\s-*{document}\n")
895 ;; A line containing just $$ is treated as a paragraph separator.
896 ;; A line starting with $$ starts a paragraph,
897 ;; but does not separate paragraphs if it has more stuff on it.
898 (setq paragraph-start
899 (concat "[ \t]*\\(\\$\\$\\|"
901 "\\\\" (regexp-opt (append
902 (mapcar 'car latex-section-alist
)
903 '("begin" "label" "end"
904 "item" "bibitem" "newline" "noindent"
905 "newpage" "footnote" "marginpar"
906 "parbox" "caption")) t
)
907 "\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t
)
909 (setq paragraph-separate
910 (concat "[\f%]\\|[ \t]*\\($\\|"
912 "\\\\" (regexp-opt (append
913 (mapcar 'car latex-section-alist
)
914 '("begin" "label" "end" )) t
)
915 "\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
916 "noindent" "newpage" "footnote"
917 "marginpar" "parbox" "caption"))
918 "\\|\\$\\$\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
919 "\\>\\)[ \t]*\\($\\|%\\)\\)"))
920 (set (make-local-variable 'imenu-create-index-function
)
921 'latex-imenu-create-index
)
922 (set (make-local-variable 'tex-face-alist
) tex-latex-face-alist
)
923 (add-hook 'fill-nobreak-predicate
'latex-fill-nobreak-predicate nil t
)
924 (set (make-local-variable 'indent-line-function
) 'latex-indent
)
925 (set (make-local-variable 'fill-indent-according-to-mode
) t
)
926 (set (make-local-variable 'outline-regexp
) latex-outline-regexp
)
927 (set (make-local-variable 'outline-level
) 'latex-outline-level
)
928 (set (make-local-variable 'forward-sexp-function
) 'latex-forward-sexp
)
929 (set (make-local-variable 'skeleton-end-hook
) nil
))
932 (define-derived-mode slitex-mode latex-mode
"SliTeX"
933 "Major mode for editing files of input for SliTeX.
934 Makes $ and } display the characters they match.
935 Makes \" insert `` when it seems to be the beginning of a quotation,
936 and '' when it appears to be the end; it inserts \" only after a \\.
938 Use \\[tex-region] to run SliTeX on the current region, plus the preamble
939 copied from the top of the file (containing \\documentstyle, etc.),
940 running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
941 \\[tex-file] saves the buffer and then processes the file.
942 \\[tex-print] prints the .dvi file made by any of these.
943 \\[tex-view] previews the .dvi file made by any of these.
944 \\[tex-bibtex-file] runs bibtex on the file of the current buffer.
946 Use \\[tex-validate-buffer] to check buffer for paragraphs containing
947 mismatched $'s or braces.
954 Command string used by \\[tex-region] or \\[tex-buffer].
956 Directory in which to create temporary files for SliTeX jobs
957 run by \\[tex-region] or \\[tex-buffer].
958 tex-dvi-print-command
959 Command string used by \\[tex-print] to print a .dvi file.
960 tex-alt-dvi-print-command
961 Alternative command string used by \\[tex-print] (when given a prefix
962 argument) to print a .dvi file.
964 Command string used by \\[tex-view] to preview a .dvi file.
965 tex-show-queue-command
966 Command string used by \\[tex-show-print-queue] to show the print
967 queue that \\[tex-print] put your job on.
969 Entering SliTeX mode runs the hook `text-mode-hook', then the hook
970 `tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
971 `slitex-mode-hook'. When the special subshell is initiated, the hook
972 `tex-shell-hook' is run."
973 (setq tex-command slitex-run-command
)
974 (setq tex-start-of-header
"\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
976 (defun tex-common-initialization ()
977 ;; Regexp isearch should accept newline and formfeed as whitespace.
978 (set (make-local-variable 'search-whitespace-regexp
) "[ \t\r\n\f]+")
979 ;; A line containing just $$ is treated as a paragraph separator.
980 (set (make-local-variable 'paragraph-start
)
981 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$")
982 ;; A line starting with $$ starts a paragraph,
983 ;; but does not separate paragraphs if it has more stuff on it.
984 (set (make-local-variable 'paragraph-separate
)
985 "[ \t]*$\\|[\f\\\\%]\\|[ \t]*\\$\\$[ \t]*$")
986 (set (make-local-variable 'comment-start
) "%")
987 (set (make-local-variable 'comment-add
) 1)
988 (set (make-local-variable 'comment-start-skip
)
989 "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
990 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
991 (set (make-local-variable 'compare-windows-whitespace
)
992 'tex-categorize-whitespace
)
993 (set (make-local-variable 'facemenu-add-face-function
)
995 (let ((face-text (cdr (assq face tex-face-alist
))))
998 (error "Face %s not configured for %s mode" face mode-name
)))))
999 (set (make-local-variable 'facemenu-end-add-face
) "}")
1000 (set (make-local-variable 'facemenu-remove-face-function
) t
)
1001 (set (make-local-variable 'font-lock-defaults
)
1002 '((tex-font-lock-keywords tex-font-lock-keywords-1
1003 tex-font-lock-keywords-2 tex-font-lock-keywords-3
)
1004 nil nil
((?$ .
"\"")) nil
1005 ;; Who ever uses that anyway ???
1006 (font-lock-mark-block-function . mark-paragraph
)
1007 (font-lock-syntactic-face-function
1008 . tex-font-lock-syntactic-face-function
)
1009 (font-lock-unfontify-region-function
1010 . tex-font-lock-unfontify-region
)
1011 (font-lock-syntactic-keywords
1012 . tex-font-lock-syntactic-keywords
)
1013 (parse-sexp-lookup-properties . t
)))
1014 ;; TABs in verbatim environments don't do what you think.
1015 (set (make-local-variable 'indent-tabs-mode
) nil
)
1016 ;; Other vars that should be buffer-local.
1017 (make-local-variable 'tex-command
)
1018 (make-local-variable 'tex-start-of-header
)
1019 (make-local-variable 'tex-end-of-header
)
1020 (make-local-variable 'tex-trailer
))
1022 (defun tex-categorize-whitespace (backward-limit)
1023 ;; compare-windows-whitespace is set to this.
1024 ;; This is basically a finite-state machine.
1025 ;; Returns a symbol telling how TeX would treat
1026 ;; the whitespace we are looking at: null, space, or par.
1027 (let ((category 'null
)
1029 (skip-chars-backward " \t\n\f" backward-limit
)
1031 (cond ((looking-at "[ \t]+")
1032 (goto-char (match-end 0))
1033 (if (eq category
'null
)
1034 (setq category
'space
)))
1036 (cond ((eq category
'newline
)
1037 (setq category
'par
)
1038 (setq not-finished nil
))
1040 (setq category
'newline
) ;a strictly internal state
1041 (goto-char (match-end 0)))))
1043 (setq category
'par
)
1044 (setq not-finished nil
))
1046 (setq not-finished nil
))))
1047 (skip-chars-forward " \t\n\f")
1048 (if (eq category
'newline
)
1049 'space
;TeX doesn't distinguish
1052 (defun tex-insert-quote (arg)
1053 "Insert the appropriate quote marks for TeX.
1054 Inserts the value of `tex-open-quote' (normally ``) or `tex-close-quote'
1055 \(normally '') depending on the context. With prefix argument, always
1056 inserts \" characters."
1058 (if (or arg
(memq (char-syntax (preceding-char)) '(?
/ ?
\\))
1059 (eq (get-text-property (point) 'face
) 'tex-verbatim-face
)
1061 (backward-char (length tex-open-quote
))
1062 (when (or (looking-at (regexp-quote tex-open-quote
))
1063 (looking-at (regexp-quote tex-close-quote
)))
1064 (delete-char (length tex-open-quote
))
1066 (self-insert-command (prefix-numeric-value arg
))
1067 (insert (if (memq (char-syntax (preceding-char)) '(?\
( ?
> ?\
))
1068 tex-open-quote tex-close-quote
))))
1070 (defun tex-validate-buffer ()
1071 "Check current buffer for paragraphs containing mismatched braces or $s.
1072 Their positions are recorded in the buffer `*Occur*'.
1073 To find a particular invalidity from `*Occur*', switch to that buffer
1074 and type C-c C-c or click with mouse-2
1075 on the line for the invalidity you want to see."
1077 (let ((buffer (current-buffer))
1078 (prevpos (point-min))
1081 (with-output-to-temp-buffer "*Occur*"
1082 (princ "Mismatches:\n")
1083 (with-current-buffer standard-output
1085 ;; This won't actually work...Really, this whole thing should
1086 ;; be rewritten instead of being a hack on top of occur.
1087 (setq occur-revert-arguments
(list nil
0 (list buffer
))))
1089 (goto-char (point-max))
1090 (while (and (not (bobp)))
1093 ;; Scan the previous paragraph for invalidities.
1094 (if (search-backward "\n\n" nil t
)
1096 (setq prev-end
(point))
1098 (goto-char (setq prev-end
(point-min))))
1099 (or (tex-validate-region (point) end
)
1100 (let* ((end (line-beginning-position 2))
1103 (setq start
(point))
1104 ;; Keep track of line number as we scan,
1105 ;; in a cumulative fashion.
1107 (setq linenum
(- linenum
(count-lines prevpos
(point))))
1108 (setq linenum
(1+ (count-lines 1 start
))))
1109 (setq prevpos
(point))
1110 ;; Mention this mismatch in *Occur*.
1111 ;; Since we scan from end of buffer to beginning,
1112 ;; add each mismatch at the beginning of *Occur*.
1114 (setq tem
(point-marker))
1115 (set-buffer standard-output
)
1116 (goto-char (point-min))
1117 ;; Skip "Mismatches:" header line.
1119 (setq num-matches
(1+ num-matches
))
1120 (insert-buffer-substring buffer start end
)
1121 (let (text-beg (text-end (point-marker)))
1122 (forward-char (- start end
))
1123 (setq text-beg
(point-marker))
1124 (insert (format "%3d: " linenum
))
1125 (add-text-properties
1126 text-beg
(- text-end
1)
1127 '(mouse-face highlight
1128 help-echo
"mouse-2: go to this invalidity"))
1129 (put-text-property text-beg
(- text-end
1)
1130 'occur-target tem
)))))
1131 (goto-char prev-end
))))
1132 (with-current-buffer standard-output
1133 (if (eq num-matches
0)
1136 (message "%d mismatches found" num-matches
))))))
1138 (defun tex-validate-region (start end
)
1139 "Check for mismatched braces or $'s in region.
1140 Returns t if no mismatches. Returns nil and moves point to suspect
1141 area if a mismatch is found."
1143 (let ((failure-point nil
) (max-possible-sexps (- end start
)))
1147 (narrow-to-region start end
)
1148 ;; First check that the open and close parens balance in numbers.
1150 (while (<= 0 (setq max-possible-sexps
(1- max-possible-sexps
)))
1152 ;; Now check that like matches like.
1154 (while (progn (skip-syntax-forward "^(")
1156 (let ((match (matching-paren (following-char))))
1159 (or (= (preceding-char) match
)
1160 (error "Mismatched parentheses"))))
1163 (skip-syntax-forward " .>")
1164 (setq failure-point
(point)))))
1165 (if failure-point
(goto-char failure-point
))
1166 (not failure-point
)))
1168 (defun tex-terminate-paragraph (inhibit-validation)
1169 "Insert two newlines, breaking a paragraph for TeX.
1170 Check for mismatched braces or $s in paragraph being terminated.
1171 A prefix arg inhibits the checking."
1173 (or inhibit-validation
1175 (tex-validate-region
1177 (search-backward "\n\n" nil
'move
)
1180 (message "Paragraph being closed appears to contain a mismatch"))
1183 (define-skeleton tex-insert-braces
1184 "Make a pair of braces and be poised to type inside of them."
1188 ;; This function is used as the value of fill-nobreak-predicate
1189 ;; in LaTeX mode. Its job is to prevent line-breaking inside
1190 ;; of a \verb construct.
1191 (defun latex-fill-nobreak-predicate ()
1193 (skip-chars-backward " ")
1194 ;; Don't break after \ since `\ ' has special meaning.
1195 (or (and (not (bobp)) (memq (char-syntax (char-before)) '(?
\\ ?
/)))
1196 (let ((opoint (point))
1199 (while (re-search-forward "\\\\verb\\(.\\)" opoint t
)
1200 (unless (re-search-forward (regexp-quote (match-string 1)) opoint t
)
1204 (defvar latex-block-default
"enumerate")
1206 ;; Like tex-insert-braces, but for LaTeX.
1207 (defalias 'tex-latex-block
'latex-insert-block
)
1208 (define-skeleton latex-insert-block
1209 "Create a matching pair of lines \\begin[OPT]{NAME} and \\end{NAME} at point.
1210 Puts point on a blank line between them."
1211 (let ((choice (completing-read (format "LaTeX block name [%s]: "
1212 latex-block-default
)
1213 (append latex-block-names
1214 latex-standard-block-names
)
1215 nil nil nil nil latex-block-default
)))
1216 (setq latex-block-default choice
)
1217 (unless (or (member choice latex-standard-block-names
)
1218 (member choice latex-block-names
))
1219 ;; Remember new block names for later completion.
1220 (push choice latex-block-names
))
1222 \n "\\begin{" str
"}"
1223 ?\
[ (skeleton-read "[options]: ") & ?\
] | -
1
1225 "\\end{" str
"}" > \n)
1227 (define-skeleton latex-insert-item
1228 "Insert a \item macro."
1234 ;;;; LaTeX syntax navigation
1237 (defun tex-last-unended-begin ()
1238 "Leave point at the beginning of the last `\\begin{...}' that is unended."
1240 (while (and (re-search-backward "\\\\\\(begin\\|end\\)\\s *{")
1241 (looking-at "\\\\end"))
1242 (tex-last-unended-begin))
1243 (search-failed (error "Couldn't find unended \\begin"))))
1245 (defun tex-next-unmatched-end ()
1246 "Leave point at the end of the next `\\end' that is unended."
1247 (while (and (re-search-forward "\\\\\\(begin\\|end\\)\\s *{[^}]+}")
1248 (save-excursion (goto-char (match-beginning 0))
1249 (looking-at "\\\\begin")))
1250 (tex-next-unmatched-end)))
1252 (defun tex-goto-last-unclosed-latex-block ()
1253 "Move point to the last unclosed \\begin{...}.
1254 Mark is left at original location."
1258 (tex-last-unended-begin)
1259 (setq spot
(point)))
1263 (defun latex-backward-sexp-1 ()
1264 "Like (backward-sexp 1) but aware of multi-char elements."
1266 (forward-sexp-function))
1268 (if (looking-at "\\\\begin\\>")
1270 (list "Containing expression ends prematurely"
1271 (point) (prog1 (point) (goto-char pos
))))
1272 (when (eq (char-after) ?
{)
1273 (let ((newpos (point)))
1274 (when (ignore-errors (backward-sexp 1) t
)
1275 (if (looking-at "\\\\end\\>")
1276 (tex-last-unended-begin)
1277 (goto-char newpos
))))))))
1279 (defun latex-forward-sexp-1 ()
1280 "Like (forward-sexp 1) but aware of multi-char elements."
1282 (forward-sexp-function))
1284 (let ((newpos (point)))
1285 (skip-syntax-backward "/w")
1287 ((looking-at "\\\\end\\>")
1289 (list "Containing expression ends prematurely"
1292 (progn (ignore-errors (forward-sexp 2)) (point))
1294 ((looking-at "\\\\begin\\>")
1295 (goto-char (match-end 0))
1296 (tex-next-unmatched-end))
1297 (t (goto-char newpos
))))))
1299 (defun latex-forward-sexp (&optional arg
)
1300 "Like `forward-sexp' but aware of multi-char elements."
1302 (unless arg
(setq arg
1))
1303 (let ((pos (point)))
1308 (progn (latex-forward-sexp-1) (1- arg
))
1309 (progn (latex-backward-sexp-1) (1+ arg
)))))
1312 (signal (car err
) (cdr err
))))))
1314 (defun latex-syntax-after ()
1315 "Like (char-syntax (char-after)) but aware of multi-char elements."
1316 (if (looking-at "\\\\end\\>") ?\
) (char-syntax (following-char))))
1318 (defun latex-skip-close-parens ()
1319 "Like (skip-syntax-forward \" )\") but aware of multi-char elements."
1320 (let ((forward-sexp-function nil
))
1321 (while (progn (skip-syntax-forward " )")
1322 (looking-at "\\\\end\\>"))
1325 (defun latex-down-list ()
1326 "Like (down-list 1) but aware of multi-char elements."
1327 (forward-comment (point-max))
1328 (let ((forward-sexp-function nil
))
1329 (if (not (looking-at "\\\\begin\\>"))
1333 (while (looking-at "[ \t]*[[{(]")
1334 (with-syntax-table tex-mode-syntax-table
1337 (defalias 'tex-close-latex-block
'latex-close-block
)
1338 (define-skeleton latex-close-block
1339 "Create an \\end{...} to match the last unclosed \\begin{...}."
1341 (tex-last-unended-begin)
1342 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _
"}")
1344 \n "\\end" str
> \n)
1346 (define-skeleton latex-split-block
1347 "Split the enclosing environment by inserting \\end{..}\\begin{..} at point."
1349 (tex-last-unended-begin)
1350 (if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _
"}")
1351 (prog1 (match-string 1)
1352 (goto-char (match-end 1))
1353 (setq v1
(buffer-substring (point)
1355 (while (looking-at "[ \t]*[[{]")
1358 \n "\\end" str
> \n _
\n "\\begin" str v1
> \n)
1360 (defconst tex-discount-args-cmds
1361 '("begin" "end" "input" "special" "cite" "ref" "include" "includeonly"
1362 "documentclass" "usepackage" "label")
1363 "TeX commands whose arguments should not be counted as text.")
1365 (defun tex-count-words (begin end
)
1366 "Count the number of words in the buffer."
1368 (if (and transient-mark-mode mark-active
)
1369 (list (region-beginning) (region-end))
1370 (list (point-min) (point-max))))
1371 ;; TODO: skip comments and math and maybe some environments.
1375 (while (and (< (point) end
) (re-search-forward "\\<" end t
))
1376 (if (not (eq (char-syntax (preceding-char)) ?
/))
1378 ;; Don't count single-char words.
1379 (unless (looking-at ".\\>") (incf count
))
1382 (buffer-substring-no-properties
1383 (point) (progn (when (zerop (skip-chars-forward "a-zA-Z@"))
1386 (when (member cmd tex-discount-args-cmds
)
1387 (skip-chars-forward "*")
1388 (forward-comment (point-max))
1389 (when (looking-at "\\[")
1391 (forward-comment (point-max)))
1392 (if (not (looking-at "{"))
1394 (forward-sexp 1))))))
1395 (message "%s words" count
))))
1399 ;;; Invoking TeX in an inferior shell.
1401 ;; Why use a shell instead of running TeX directly? Because if TeX
1402 ;; gets stuck, the user can switch to the shell window and type at it.
1404 ;; The utility functions:
1406 (define-derived-mode tex-shell shell-mode
"TeX-Shell"
1407 (compilation-shell-minor-mode t
))
1410 (defun tex-start-shell ()
1411 (with-current-buffer
1414 (or tex-shell-file-name
(getenv "ESHELL") shell-file-name
)
1416 (let ((proc (get-process "tex-shell")))
1417 (set-process-sentinel proc
'tex-shell-sentinel
)
1418 (process-kill-without-query proc
)
1420 (while (zerop (buffer-size))
1423 (defun tex-feed-input ()
1424 "Send input to the tex shell process.
1425 In the tex buffer this can be used to continue an interactive tex run.
1426 In the tex shell buffer this command behaves like `comint-send-input'."
1428 (set-buffer (tex-shell-buf))
1430 (tex-recenter-output-buffer nil
))
1432 (defun tex-display-shell ()
1433 "Make the TeX shell buffer visible in a window."
1434 (display-buffer (tex-shell-buf))
1435 (tex-recenter-output-buffer nil
))
1437 (defun tex-shell-sentinel (proc msg
)
1438 (cond ((null (buffer-name (process-buffer proc
)))
1440 (set-process-buffer proc nil
)
1441 (tex-delete-last-temp-files))
1442 ((memq (process-status proc
) '(signal exit
))
1443 (tex-delete-last-temp-files))))
1445 (defun tex-set-buffer-directory (buffer directory
)
1446 "Set BUFFER's default directory to be DIRECTORY."
1447 (setq directory
(file-name-as-directory (expand-file-name directory
)))
1448 (if (not (file-directory-p directory
))
1449 (error "%s is not a directory" directory
)
1452 (setq default-directory directory
))))
1454 (defvar tex-send-command-modified-tick
0)
1455 (make-variable-buffer-local 'tex-send-command-modified-tick
)
1457 (defun tex-shell-proc ()
1458 (or (tex-shell-running) (error "No TeX subprocess")))
1459 (defun tex-shell-buf ()
1460 (process-buffer (tex-shell-proc)))
1461 (defun tex-shell-buf-no-error ()
1462 (let ((proc (tex-shell-running)))
1463 (and proc
(process-buffer proc
))))
1465 (defun tex-send-command (command &optional file background
)
1466 "Send COMMAND to TeX shell process, substituting optional FILE for *.
1467 Do this in background if optional BACKGROUND is t. If COMMAND has no *,
1468 FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
1469 substitution will be made in COMMAND. COMMAND can be any expression that
1470 evaluates to a command string.
1472 Return the process in which TeX is running."
1474 (let* ((cmd (eval command
))
1475 (proc (tex-shell-proc))
1476 (buf (process-buffer proc
))
1477 (star (string-match "\\*" cmd
))
1481 (if star
(concat (substring cmd
0 star
)
1482 file
(substring cmd
(1+ star
)))
1483 (concat cmd
" " file
))
1485 (if background
"&" ""))))
1486 ;; Switch to buffer before checking for subproc output in it.
1488 ;; If text is unchanged since previous tex-send-command,
1489 ;; we haven't got any output. So wait for output now.
1490 (if (= (buffer-modified-tick buf
) tex-send-command-modified-tick
)
1491 (accept-process-output proc
))
1492 (goto-char (process-mark proc
))
1495 (setq tex-send-command-modified-tick
(buffer-modified-tick buf
))
1498 (defun tex-delete-last-temp-files (&optional not-all
)
1499 "Delete any junk files from last temp file.
1500 If NOT-ALL is non-nil, save the `.dvi' file."
1501 (if tex-last-temp-file
1502 (let* ((dir (file-name-directory tex-last-temp-file
))
1503 (list (and (file-directory-p dir
)
1504 (file-name-all-completions
1505 (file-name-sans-extension
1506 (file-name-nondirectory tex-last-temp-file
))
1511 ;; If arg is non-nil, don't delete the .dvi file.
1512 (not (string-match "\\.dvi$" (car list
)))
1513 (delete-file (concat dir
(car list
))))
1514 (delete-file (concat dir
(car list
))))
1515 (setq list
(cdr list
))))))
1517 (add-hook 'kill-emacs-hook
'tex-delete-last-temp-files
)
1519 (defun tex-guess-main-file (&optional all
)
1520 "Find a likely `tex-main-file'.
1521 Looks for hints in other buffers in the same directory or in
1523 (let ((dir default-directory
)
1524 (header-re tex-start-of-header
))
1526 ;; Look for a buffer with `tex-main-file' set.
1527 (dolist (buf (if (consp all
) all
(buffer-list)))
1528 (with-current-buffer buf
1529 (when (and (or all
(equal dir default-directory
))
1530 (stringp tex-main-file
))
1531 (throw 'found
(expand-file-name tex-main-file
)))))
1532 ;; Look for a buffer containing the magic `tex-start-of-header'.
1533 (dolist (buf (if (consp all
) all
(buffer-list)))
1534 (with-current-buffer buf
1535 (when (and (or all
(equal dir default-directory
))
1537 ;; (or (easy-mmode-derived-mode-p 'latex-mode)
1538 ;; (easy-mmode-derived-mode-p 'plain-tex-mode))
1542 (goto-char (point-min))
1544 header-re
(+ (point) 10000) t
))))
1545 (throw 'found
(expand-file-name buffer-file-name
))))))))
1547 (defun tex-main-file ()
1548 "Return the relative name of the main file."
1549 (let* ((file (or tex-main-file
1550 ;; Compatibility with AUCTeX.
1551 (and (boundp 'TeX-master
) (stringp TeX-master
)
1552 (set (make-local-variable 'tex-main-file
) TeX-master
))
1553 ;; Try to guess the main file.
1554 (if (not buffer-file-name
)
1555 (error "Buffer is not associated with any file")
1558 (goto-char (point-min))
1559 (re-search-forward tex-start-of-header
1560 (+ (point) 10000) t
))
1561 ;; This is the main file.
1563 ;; This isn't the main file, let's try to find better,
1564 (or (tex-guess-main-file)
1565 ;; (tex-guess-main-file t)
1566 buffer-file-name
)))))))
1567 (if (file-exists-p file
) file
(concat file
".tex"))))
1570 (defun tex-start-tex (command file
&optional dir
)
1571 "Start a TeX run, using COMMAND on FILE."
1572 (let* ((star (string-match "\\*" command
))
1575 (concat (substring command
0 star
)
1576 (comint-quote-filename file
)
1577 (substring command
(1+ star
)))
1580 (if (< 0 (length tex-start-commands
))
1582 (shell-quote-argument tex-start-commands
) " "))
1583 (comint-quote-filename file
)))))
1584 (tex-send-tex-command compile-command dir
)))
1586 (defun tex-send-tex-command (cmd &optional dir
)
1587 (unless (or (equal dir
(let ((buf (tex-shell-buf-no-error)))
1588 (and buf
(with-current-buffer buf
1589 default-directory
))))
1591 (let (shell-dirtrack-verbose)
1592 (tex-send-command tex-shell-cd-command dir
)))
1593 (with-current-buffer (process-buffer (tex-send-command cmd
))
1594 (make-local-variable 'compilation-parse-errors-function
)
1595 (setq compilation-parse-errors-function
'tex-compilation-parse-errors
)
1596 (setq compilation-last-buffer
(current-buffer))
1597 (compilation-forget-errors)
1598 ;; Don't parse previous compilations.
1599 (set-marker compilation-parsing-end
(1- (point-max))))
1601 (setq tex-last-buffer-texed
(current-buffer)))
1603 (defvar tex-error-parse-syntax-table
1604 (let ((st (make-syntax-table)))
1605 (modify-syntax-entry ?\
( "()" st
)
1606 (modify-syntax-entry ?\
) ")(" st
)
1607 (modify-syntax-entry ?
\\ "\\" st
)
1608 (modify-syntax-entry ?\
{ "_" st
)
1609 (modify-syntax-entry ?\
} "_" st
)
1610 (modify-syntax-entry ?\
[ "_" st
)
1611 (modify-syntax-entry ?\
] "_" st
)
1612 ;; Single quotations may appear in errors
1613 (modify-syntax-entry ?
\" "_" st
)
1615 "Syntax-table used while parsing TeX error messages.")
1617 (defun tex-compilation-parse-errors (limit-search find-at-least
)
1618 "Parse the current buffer as TeX error messages.
1619 See the variable `compilation-parse-errors-function' for the interface it uses.
1621 This function parses only the last TeX compilation.
1622 It works on TeX compilations only. It is necessary for that purpose,
1623 since TeX does not put file names and line numbers on the same line as
1624 for the error messages."
1625 (require 'thingatpt
)
1626 (setq compilation-error-list nil
)
1627 (message "Parsing error messages...")
1628 (let ((default-directory ; Perhaps dir has changed meanwhile.
1629 (file-name-directory (buffer-file-name tex-last-buffer-texed
)))
1630 found-desired
(num-errors-found 0)
1631 last-filename last-linenum last-position
1632 begin-of-error end-of-error
)
1633 ;; Don't reparse messages already seen at last parse.
1634 (goto-char compilation-parsing-end
)
1636 (while (and (not (or found-desired
(eobp)))
1637 (prog1 (re-search-forward "^! " nil
'move
)
1638 (setq begin-of-error
(match-beginning 0)
1639 end-of-error
(match-end 0)))
1641 "^l\\.\\([0-9]+\\) \\(\\.\\.\\.\\)?\\(.*\\)$" nil
'move
))
1642 (let* ((this-error (set-marker (make-marker) begin-of-error
))
1643 (linenum (string-to-int (match-string 1)))
1644 (error-text (regexp-quote (match-string 3)))
1647 (with-syntax-table tex-error-parse-syntax-table
1648 (backward-up-list 1)
1649 (skip-syntax-forward "(_")
1650 (while (not (file-readable-p (thing-at-point 'filename
)))
1651 (skip-syntax-backward "(_")
1652 (backward-up-list 1)
1653 (skip-syntax-forward "(_"))
1654 (thing-at-point 'filename
))))
1656 (or (null last-filename
)
1657 (not (string-equal last-filename filename
))))
1660 (if (equal filename
(concat tex-zap-file
".tex"))
1661 (set-buffer tex-last-buffer-texed
)
1662 (set-buffer (find-file-noselect filename
)))
1664 (progn (goto-line linenum
) (setq last-position nil
))
1665 (goto-char last-position
)
1666 (forward-line (- linenum last-linenum
)))
1667 ;; first try a forward search for the error text,
1668 ;; then a backward search limited by the last error.
1669 (let ((starting-point (point)))
1670 (or (re-search-forward error-text nil t
)
1671 (re-search-backward error-text last-position t
)
1672 (goto-char starting-point
)))
1674 (goto-char this-error
)
1675 (if (and compilation-error-list
1676 (or (and find-at-least
1677 (>= num-errors-found
1680 (>= end-of-error limit-search
)))
1682 (setq found-desired t
)
1683 (setq num-errors-found
(1+ num-errors-found
)
1684 last-filename filename
1685 last-linenum linenum
1686 last-position error-location
1687 compilation-error-list
; Add the new error
1688 (cons (cons this-error error-location
)
1689 compilation-error-list
))
1690 (goto-char end-of-error
)))))
1691 (set-marker compilation-parsing-end
(point))
1692 (setq compilation-error-list
(nreverse compilation-error-list
))
1693 (message "Parsing error messages...done"))
1697 (defun tex-region (beg end
)
1698 "Run TeX on the current region, via a temporary file.
1699 The file's name comes from the variable `tex-zap-file' and the
1700 variable `tex-directory' says where to put it.
1702 If the buffer has a header, the header is given to TeX before the
1703 region itself. The buffer's header is all lines between the strings
1704 defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
1705 The header must start in the first 100 lines of the buffer.
1707 The value of `tex-trailer' is given to TeX as input after the region.
1709 The value of `tex-command' specifies the command to use to run TeX."
1711 (if (tex-shell-running)
1715 (setq tex-zap-file
(tex-generate-zap-file-name)))
1716 ;; Temp file will be written and TeX will be run in zap-directory.
1717 ;; If the TEXINPUTS file has relative directories or if the region has
1718 ;; \input of files, this must be the same directory as the file for
1719 ;; TeX to access the correct inputs. That's why it's safest if
1720 ;; tex-directory is ".".
1721 (let* ((zap-directory
1722 (file-name-as-directory (expand-file-name tex-directory
)))
1723 (tex-out-file (expand-file-name (concat tex-zap-file
".tex")
1725 ;; Don't delete temp files if we do the same buffer twice in a row.
1726 (or (eq (current-buffer) tex-last-buffer-texed
)
1727 (tex-delete-last-temp-files t
))
1728 ;; Write the new temp file.
1732 (goto-char (point-min))
1734 (let ((search-end (point))
1735 (default-directory zap-directory
)
1737 (goto-char (point-min))
1739 ;; Maybe copy first line, such as `\input texinfo', to temp file.
1740 (and tex-first-line-header-regexp
1741 (looking-at tex-first-line-header-regexp
)
1742 (write-region (point)
1743 (progn (forward-line 1)
1744 (setq already-output
(point)))
1745 tex-out-file nil nil
))
1747 ;; Write out the header, if there is one,
1748 ;; and any of the specified region which extends before it.
1749 ;; But don't repeat anything already written.
1750 (if (re-search-forward tex-start-of-header search-end t
)
1753 (setq hbeg
(point)) ;mark beginning of header
1754 (if (re-search-forward tex-end-of-header nil t
)
1757 (setq hend
(point)) ;mark end of header
1758 (write-region (max (min hbeg beg
) already-output
)
1761 (not (zerop already-output
)) nil
)
1762 (setq already-output hend
)))))
1764 ;; Write out the specified region
1765 ;; (but don't repeat anything already written).
1766 (write-region (max beg already-output
) end
1768 (not (zerop already-output
)) nil
))
1769 ;; Write the trailer, if any.
1770 ;; Precede it with a newline to make sure it
1771 ;; is not hidden in a comment.
1773 (write-region (concat "\n" tex-trailer
) nil
1774 tex-out-file t nil
))))
1775 ;; Record the file name to be deleted afterward.
1776 (setq tex-last-temp-file tex-out-file
)
1777 ;; Use a relative file name here because (1) the proper dir
1778 ;; is already current, and (2) the abs file name is sometimes
1779 ;; too long and can make tex crash.
1780 (tex-start-tex tex-command
(concat tex-zap-file
".tex") zap-directory
)
1781 (setq tex-print-file tex-out-file
)))
1783 (defun tex-buffer ()
1784 "Run TeX on current buffer. See \\[tex-region] for more information.
1785 Does not save the buffer, so it's useful for trying experimental versions.
1786 See \\[tex-file] for an alternative."
1788 (tex-region (point-min) (point-max)))
1791 "Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
1792 This function is more useful than \\[tex-buffer] when you need the
1793 `.aux' file of LaTeX to have the correct name."
1795 (when tex-offer-save
1796 (save-some-buffers))
1797 (let* ((source-file (tex-main-file))
1798 (file-dir (file-name-directory (expand-file-name source-file
))))
1799 (if (tex-shell-running)
1802 (tex-start-tex tex-command source-file file-dir
)
1803 (setq tex-print-file
(expand-file-name source-file
))))
1805 (defun tex-generate-zap-file-name ()
1806 "Generate a unique name suitable for use as a file name."
1807 ;; Include the shell process number and host name
1808 ;; in case there are multiple shells (for same or different user).
1809 ;; Dec 1998: There is a report that some versions of xdvi
1810 ;; don't work with file names that start with #.
1812 (process-id (get-buffer-process "*tex-shell*"))
1813 (subst-char-in-string ?. ?-
(system-name))))
1815 ;; This will perhaps be useful for modifying TEXINPUTS.
1816 ;; Expand each file name, separated by colons, in the string S.
1817 (defun tex-expand-files (s)
1818 (let (elts (start 0))
1819 (while (string-match ":" s start
)
1820 (setq elts
(cons (substring s start
(match-beginning 0)) elts
))
1821 (setq start
(match-end 0)))
1823 (setq elts
(cons (substring s start
) elts
)))
1824 (mapconcat (lambda (elt)
1825 (if (= (length elt
) 0) elt
(expand-file-name elt
)))
1826 (nreverse elts
) ":")))
1828 (defun tex-shell-running ()
1829 (let ((proc (get-process "tex-shell")))
1831 (if (and (eq (process-status proc
) 'run
)
1832 (buffer-live-p (process-buffer proc
)))
1833 ;; return the TeX process on success
1835 ;; get rid of the process permanently
1836 ;; this should get rid of the annoying w32 problem with
1837 ;; dead tex-shell buffer and live process
1838 (delete-process proc
)))))
1840 (defun tex-kill-job ()
1841 "Kill the currently running TeX job."
1843 ;; `quit-process' leads to core dumps of the tex process (except if
1844 ;; coredumpsize has limit 0kb as on many environments). One would
1845 ;; like to use (kill-process proc 'lambda), however that construct
1846 ;; does not work on some systems and kills the shell itself.
1847 (let ((proc (get-process "tex-shell")))
1848 (when proc
(quit-process proc t
))))
1850 (defun tex-recenter-output-buffer (linenum)
1851 "Redisplay buffer of TeX job output so that most recent output can be seen.
1852 The last line of the buffer is displayed on
1853 line LINE of the window, or centered if LINE is nil."
1855 (let ((tex-shell (get-buffer "*tex-shell*"))
1857 (if (null tex-shell
)
1858 (message "No TeX output buffer")
1859 (setq window
(display-buffer tex-shell
))
1860 (save-selected-window
1861 (select-window window
)
1862 (bury-buffer tex-shell
)
1863 (goto-char (point-max))
1864 (recenter (if linenum
1865 (prefix-numeric-value linenum
)
1866 (/ (window-height) 2)))))))
1868 (defun tex-print (&optional alt
)
1869 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1870 Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
1871 is provided, use the alternative command, `tex-alt-dvi-print-command'."
1873 (let ((print-file-name-dvi (tex-append tex-print-file
".dvi"))
1875 (if (and (not (equal (current-buffer) tex-last-buffer-texed
))
1877 ;; Check that this buffer's printed file is up to date.
1878 (file-newer-than-file-p
1879 (setq test-name
(tex-append (buffer-file-name) ".dvi"))
1880 (buffer-file-name)))
1881 (setq print-file-name-dvi test-name
))
1882 (if (not (file-exists-p print-file-name-dvi
))
1883 (error "No appropriate `.dvi' file could be found")
1884 (if (tex-shell-running)
1888 (if alt tex-alt-dvi-print-command tex-dvi-print-command
)
1889 (shell-quote-argument
1890 print-file-name-dvi
)
1893 (defun tex-alt-print ()
1894 "Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
1895 Runs the shell command defined by `tex-alt-dvi-print-command'."
1900 "Preview the last `.dvi' file made by running TeX under Emacs.
1901 This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
1902 The variable `tex-dvi-view-command' specifies the shell command for preview.
1903 You must set that variable yourself before using this command,
1904 because there is no standard value that would generally work."
1906 (or tex-dvi-view-command
1907 (error "You must set `tex-dvi-view-command'"))
1908 (let ((tex-dvi-print-command (eval tex-dvi-view-command
)))
1911 (defun tex-append (file-name suffix
)
1912 "Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
1913 Pascal-based TeX scans for the first period, C TeX uses the last.
1914 No period is retained immediately before SUFFIX,
1915 so normally SUFFIX starts with one."
1916 (if (stringp file-name
)
1917 (let ((file (file-name-nondirectory file-name
))
1919 ;; Try splitting on last period.
1920 ;; The first-period split can get fooled when two files
1921 ;; named a.tex and a.b.tex are both tex'd;
1922 ;; the last-period split must be right if it matches at all.
1924 (concat (file-name-directory file-name
)
1926 (string-match "\\.[^.]*$" file
))
1928 (if (or (file-exists-p trial-name
)
1929 (file-exists-p (concat trial-name
".aux"))) ;for BibTeX files
1931 ;; Not found, so split on first period.
1932 (concat (file-name-directory file-name
)
1934 (string-match "\\." file
))
1938 (defun tex-show-print-queue ()
1939 "Show the print queue that \\[tex-print] put your job on.
1940 Runs the shell command defined by `tex-show-queue-command'."
1942 (if (tex-shell-running)
1945 (tex-send-command tex-show-queue-command
)
1946 (tex-display-shell))
1948 (defun tex-bibtex-file ()
1949 "Run BibTeX on the current buffer's file."
1951 (if (tex-shell-running)
1954 (let (shell-dirtrack-verbose
1956 (tex-append (file-name-nondirectory (buffer-file-name)) ""))
1957 (file-dir (file-name-directory (buffer-file-name))))
1958 (tex-send-command tex-shell-cd-command file-dir
)
1959 (tex-send-command tex-bibtex-command tex-out-file
))
1960 (tex-display-shell))
1963 ;;;; LaTeX indentation
1966 (defvar tex-indent-allhanging t
)
1967 (defvar tex-indent-arg
4)
1968 (defvar tex-indent-basic
2)
1969 (defvar tex-indent-item tex-indent-basic
)
1970 (defvar tex-indent-item-re
"\\\\\\(bib\\)?item\\>")
1972 (easy-mmode-defsyntax tex-latex-indent-syntax-table
1976 "Syntax table used while computing indentation."
1977 :copy tex-mode-syntax-table
)
1979 (defun latex-indent (&optional arg
)
1980 (if (and (eq (get-text-property (line-beginning-position) 'face
)
1983 (with-syntax-table tex-latex-indent-syntax-table
1984 ;; TODO: Rather than ignore $, we should try to be more clever about it.
1988 (latex-find-indent))))
1989 (if (< indent
0) (setq indent
0))
1990 (if (<= (current-column) (current-indentation))
1991 (indent-line-to indent
)
1992 (save-excursion (indent-line-to indent
)))))))
1994 (defun latex-find-indent (&optional virtual
)
1995 "Find the proper indentation of text after point.
1996 VIRTUAL if non-nil indicates that we're only trying to find the indentation
1997 in order to determine the indentation of something else.
1998 There might be text before point."
2000 (skip-chars-forward " \t")
2002 ;; Stick the first line at column 0.
2003 (and (= (point-min) (line-beginning-position)) 0)
2004 ;; Trust the current indentation, if such info is applicable.
2005 (and virtual
(save-excursion (skip-chars-backward " \t&") (bolp))
2007 ;; Stick verbatim environments to the left margin.
2008 (and (looking-at "\\\\\\(begin\\|end\\) *{\\([^\n}]+\\)")
2009 (member (match-string 2) tex-verbatim-environments
)
2011 ;; Put leading close-paren where the matching open brace would be.
2012 (and (eq (latex-syntax-after) ?\
))
2015 (latex-skip-close-parens)
2016 (latex-backward-sexp-1)
2017 (latex-find-indent 'virtual
))))
2018 ;; Default (maybe an argument)
2021 ;; Outdent \item if necessary.
2022 (indent (if (looking-at tex-indent-item-re
) (- tex-indent-item
) 0))
2024 ;; Find the previous point which determines our current indentation.
2027 (latex-backward-sexp-1)
2028 (while (> (current-column) (current-indentation))
2029 (latex-backward-sexp-1)))
2031 (setq up-list-pos
(nth 2 err
))))
2033 ((= (point-min) pos
) 0) ; We're really just indenting the first line.
2034 ((integerp up-list-pos
)
2035 ;; Have to indent relative to the open-paren.
2036 (goto-char up-list-pos
)
2037 (if (and (not tex-indent-allhanging
)
2038 (> pos
(progn (latex-down-list)
2039 (forward-comment (point-max))
2041 ;; Align with the first element after the open-paren.
2043 ;; We're the first element after a hanging brace.
2044 (goto-char up-list-pos
)
2045 (+ indent tex-indent-basic
(latex-find-indent 'virtual
))))
2046 ;; We're now at the "beginning" of a line.
2047 ((not (and (not virtual
) (eq (char-after) ?
\\)))
2048 ;; Nothing particular here: just keep the same indentation.
2049 (+ indent
(current-column)))
2050 ;; We're now looking at a macro call.
2051 ((looking-at tex-indent-item-re
)
2052 ;; Indenting relative to an item, have to re-add the outdenting.
2053 (+ indent
(current-column) tex-indent-item
))
2055 (let ((col (current-column)))
2056 (if (not (eq (char-syntax char
) ?\
())
2057 ;; If the first char was not an open-paren, there's
2058 ;; a risk that this is really not an argument to the
2062 (if (< (line-end-position)
2063 (save-excursion (forward-comment (point-max))
2065 ;; we're indenting the first argument.
2066 (min (current-column) (+ tex-indent-arg col
))
2067 (skip-syntax-forward " ")
2068 (current-column))))))))))
2071 (defun doctex-font-lock-^^A
()
2072 (if (eq (char-after (line-beginning-position)) ?\%
)
2075 (1- (match-beginning 1)) (match-beginning 1)
2077 (if (= (1+ (line-beginning-position)) (match-beginning 1))
2078 ;; The `%' is a single-char comment, which Emacs
2079 ;; syntax-table can't deal with. We could turn it
2080 ;; into a non-comment, or use `\n%' or `%^' as the comment.
2081 ;; Instead, we include it in the ^^A comment.
2082 (eval-when-compile (string-to-syntax "< b"))
2083 (eval-when-compile (string-to-syntax ">"))))
2084 (let ((end (line-end-position)))
2085 (if (< end
(point-max))
2089 (eval-when-compile (string-to-syntax "> b")))))
2090 (eval-when-compile (string-to-syntax "< b")))))
2092 (defun doctex-font-lock-syntactic-face-function (state)
2093 ;; Mark DocTeX documentation, which is parsed as a style A comment
2094 ;; starting in column 0.
2095 (if (or (nth 3 state
) (nth 7 state
)
2096 (not (memq (char-before (nth 8 state
))
2098 ;; Anything else is just as for LaTeX.
2099 (tex-font-lock-syntactic-face-function state
)
2100 font-lock-doc-face
))
2102 (defvar doctex-font-lock-syntactic-keywords
2104 tex-font-lock-syntactic-keywords
2105 ;; For DocTeX comment-in-doc.
2106 `(("\\(\\^\\)\\^A" (1 (doctex-font-lock-^^A
))))))
2108 (defvar doctex-font-lock-keywords
2109 (append tex-font-lock-keywords
2110 '(("^%<[^>]*>" (0 font-lock-preprocessor-face t
)))))
2113 (define-derived-mode doctex-mode latex-mode
"DocTeX"
2114 "Major mode to edit DocTeX files."
2115 (setq font-lock-defaults
2116 (cons (append (car font-lock-defaults
) '(doctex-font-lock-keywords))
2120 (font-lock-syntactic-keywords
2121 (cons (car x
) 'doctex-font-lock-syntactic-keywords
))
2122 (font-lock-syntactic-face-function
2123 (cons (car x
) 'doctex-font-lock-syntactic-face-function
))
2125 (cdr font-lock-defaults
)))))
2127 (run-hooks 'tex-mode-load-hook
)
2131 ;;; tex-mode.el ends here
