1 ;;; texinfo.el --- major mode for editing Texinfo files -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1988-1993, 1996-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Robert J. Chassell
7 ;; Date: [See date below for texinfo-version]
9 ;; Keywords: maint, tex, docs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; - facemenu support.
29 ;; - command completion.
35 (eval-when-compile (require 'tex-mode
) (require 'cl
))
36 (defvar outline-heading-alist
)
40 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
44 (defcustom texinfo-open-quote
(purecopy "``")
45 "String inserted by typing \\[texinfo-insert-quote] to open a quotation."
50 (defcustom texinfo-close-quote
(purecopy "''")
51 "String inserted by typing \\[texinfo-insert-quote] to close a quotation."
55 (defcustom texinfo-mode-hook nil
56 "Normal hook run when entering Texinfo mode."
58 :options
'(turn-on-auto-fill flyspell-mode
)
64 (autoload 'makeinfo-region
66 "Make Info file from region of current Texinfo file, and switch to it.
68 This command does not offer the `next-error' feature since it would
69 apply to a temporary file, not the original; use the `makeinfo-buffer'
70 command to gain use of `next-error'."
73 (autoload 'makeinfo-buffer
75 "Make Info file from current buffer.
77 Use the \\[next-error] command to move to the next error
78 \(if there are errors\)."
81 (autoload 'kill-compilation
83 "Kill the process made by the \\[compile] command."
86 (autoload 'makeinfo-recenter-compilation-buffer
88 "Redisplay `*compilation*' buffer so most recent output can be seen.
89 The last line of the buffer is displayed on
90 line LINE of the window, or centered if LINE is nil."
93 (autoload 'texinfo-update-node
95 "Without any prefix argument, update the node in which point is located.
96 Non-nil argument (prefix, if interactive) means update the nodes in the
99 The functions for creating or updating nodes and menus, and their
102 `texinfo-update-node' (&optional region-p) \\[texinfo-update-node]
103 `texinfo-every-node-update' () \\[texinfo-every-node-update]
104 `texinfo-sequential-node-update' (&optional region-p)
106 `texinfo-make-menu' (&optional region-p) \\[texinfo-make-menu]
107 `texinfo-all-menus-update' () \\[texinfo-all-menus-update]
108 `texinfo-master-menu' ()
110 `texinfo-indent-menu-description' (column &optional region-p)
112 The `texinfo-column-for-description' variable specifies the column to
113 which menu descriptions are indented. Its default value is 32."
116 (autoload 'texinfo-every-node-update
118 "Update every node in a Texinfo file."
121 (autoload 'texinfo-sequential-node-update
123 "Update one node (or many) in a Texinfo file with sequential pointers.
125 This function causes the `Next' or `Previous' pointer to point to the
126 immediately preceding or following node, even if it is at a higher or
127 lower hierarchical level in the document. Continually pressing `n' or
128 `p' takes you straight through the file.
130 Without any prefix argument, update the node in which point is located.
131 Non-nil argument (prefix, if interactive) means update the nodes in the
134 This command makes it awkward to navigate among sections and
135 subsections; it should be used only for those documents that are meant
136 to be read like a novel rather than a reference, and for which the
137 Info `g*' command is inadequate."
140 (autoload 'texinfo-make-menu
142 "Without any prefix argument, make or update a menu.
143 Make the menu for the section enclosing the node found following point.
145 Non-nil argument (prefix, if interactive) means make or update menus
146 for nodes within or part of the marked region.
148 Whenever a menu exists, and is being updated, the descriptions that
149 are associated with node names in the pre-existing menu are
150 incorporated into the new menu. Otherwise, the nodes' section titles
151 are inserted as descriptions."
154 (autoload 'texinfo-all-menus-update
156 "Update every regular menu in a Texinfo file.
157 Remove pre-existing master menu, if there is one.
159 If called with a non-nil argument, this function first updates all the
160 nodes in the buffer before updating the menus."
163 (autoload 'texinfo-master-menu
165 "Make a master menu for a whole Texinfo file.
166 Non-nil argument (prefix, if interactive) means first update all
167 existing nodes and menus. Remove pre-existing master menu, if there is one.
169 This function creates a master menu that follows the top node. The
170 master menu includes every entry from all the other menus. It
171 replaces any existing ordinary menu that follows the top node.
173 If called with a non-nil argument, this function first updates all the
174 menus in the buffer (incorporating descriptions from pre-existing
175 menus) before it constructs the master menu.
177 The function removes the detailed part of an already existing master
178 menu. This action depends on the pre-existing master menu using the
179 standard `texinfo-master-menu-header'.
181 The master menu has the following format, which is adapted from the
182 recommendation in the Texinfo Manual:
184 * The first part contains the major nodes in the Texinfo file: the
185 nodes for the chapters, chapter-like sections, and the major
186 appendices. This includes the indices, so long as they are in
187 chapter-like sections, such as unnumbered sections.
189 * The second and subsequent parts contain a listing of the other,
190 lower level menus, in order. This way, an inquirer can go
191 directly to a particular node if he or she is searching for
192 specific information.
194 Each of the menus in the detailed node listing is introduced by the
195 title of the section containing the menu."
198 (autoload 'texinfo-indent-menu-description
200 "Indent every description in menu following point to COLUMN.
201 Non-nil argument (prefix, if interactive) means indent every
202 description in every menu in the region. Does not indent second and
203 subsequent lines of a multi-line description."
206 (autoload 'texinfo-insert-node-lines
208 "Insert missing `@node' lines in region of Texinfo file.
209 Non-nil argument (prefix, if interactive) means also to insert the
210 section titles as node names; and also to insert the section titles as
211 node names in pre-existing @node lines that lack names."
214 (autoload 'texinfo-start-menu-description
216 "In this menu entry, insert the node's section title as a description.
217 Position point at beginning of description ready for editing.
218 Do not insert a title if the line contains an existing description.
220 You will need to edit the inserted text since a useful description
221 complements the node name rather than repeats it as a title does."
224 (autoload 'texinfo-multiple-files-update
226 "Update first node pointers in each file included in OUTER-FILE;
227 create or update main menu in the outer file that refers to such nodes.
228 This does not create or update menus or pointers within the included files.
230 With optional MAKE-MASTER-MENU argument (prefix arg, if interactive),
231 insert a master menu in OUTER-FILE. This does not create or update
232 menus or pointers within the included files.
234 With optional UPDATE-EVERYTHING argument (numeric prefix arg, if
235 interactive), update all the menus and all the `Next', `Previous', and
236 `Up' pointers of all the files included in OUTER-FILE before inserting
237 a master menu in OUTER-FILE.
239 The command also updates the `Top' level node pointers of OUTER-FILE.
243 * this command does NOT save any files--you must save the
244 outer file and any modified, included files.
246 * except for the `Top' node, this command does NOT handle any
247 pre-existing nodes in the outer file; hence, indices must be
248 enclosed in an included file.
252 * each of the included files must contain exactly one highest
253 hierarchical level node,
254 * this highest node must be the first node in the included file,
255 * each highest hierarchical level node must be of the same type.
257 Thus, normally, each included file contains one, and only one,
264 ;;; Don't you dare insert any `require' calls at top level in this file--rms.
266 (defvar texinfo-section-list
274 ("unnumberedsubsec" 4)
275 ("unnumberedsubsubsec" 5)
278 ("appendixsection" 3)
280 ("appendixsubsubsec" 5)
286 "Alist of sectioning commands and their relative level.")
290 (defvar texinfo-mode-syntax-table
291 (let ((st (make-syntax-table)))
292 (modify-syntax-entry ?
\" "." st
)
293 (modify-syntax-entry ?
\\ "." st
)
294 (modify-syntax-entry ?
@ "\\" st
)
295 (modify-syntax-entry ?\^q
"\\" st
)
296 (modify-syntax-entry ?\
[ "(]" st
)
297 (modify-syntax-entry ?\
] ")[" st
)
298 (modify-syntax-entry ?
{ "(}" st
)
299 (modify-syntax-entry ?
} "){" st
)
300 (modify-syntax-entry ?
\n ">" st
)
301 (modify-syntax-entry ?
\' "w" st
)
304 ;; Written by Wolfgang Bangerth <zcg51122@rpool1.rus.uni-stuttgart.de>
305 ;; To override this example, set either `imenu-generic-expression'
306 ;; or `imenu-create-index-function'.
307 (defvar texinfo-imenu-generic-expression
308 '((nil "^@\\(node\\|anchor\\)[ \t]+\\([^,\n]*\\)" 2)
309 ("Chapters" "^@chapter[ \t]+\\(.*\\)$" 1))
310 "Imenu generic expression for Texinfo mode. See `imenu-generic-expression'.")
312 (defconst texinfo-syntax-propertize-function
313 (syntax-propertize-rules
314 ("\\(@\\)c\\(omment\\)?\\>" (1 "<"))
315 ("^\\(@\\)ignore\\>" (1 "< b"))
316 ("^@end ignore\\(\n\\)" (1 "> b")))
317 "Syntactic keywords to catch comment delimiters in `texinfo-mode'.")
319 (defconst texinfo-environments
320 '("cartouche" "copying" "defcv" "deffn" "defivar" "defmac"
321 "defmethod" "defop" "defopt" "defspec" "deftp" "deftypefn"
322 "deftypefun" "deftypevar" "deftypevr" "defun" "defvar"
323 "defvr" "description" "detailmenu" "direntry" "display"
324 "documentdescription" "enumerate" "example" "flushleft"
325 "flushright" "format" "ftable" "group" "ifclear" "ifset"
326 "ifhtml" "ifinfo" "ifnothtml" "ifnotinfo" "ifnotplaintext"
327 "ifnottex" "ifplaintext" "iftex" "ignore" "itemize" "lisp"
328 "macro" "menu" "multitable" "quotation" "smalldisplay"
329 "smallexample" "smallformat" "smalllisp" "table" "tex"
330 "titlepage" "verbatim" "vtable")
331 "List of Texinfo environments.")
333 (defconst texinfo-environment-regexp
334 (concat "^@" (regexp-opt (cons "end" texinfo-environments
) t
) "\\>")
335 "Regexp for environment-like Texinfo list commands.
336 Subexpression 1 is what goes into the corresponding `@end' statement.")
338 (defface texinfo-heading
339 '((t (:inherit font-lock-function-name-face
)))
340 "Face used for section headings in `texinfo-mode'."
342 (define-obsolete-face-alias 'texinfo-heading-face
'texinfo-heading
"22.1")
343 (defvar texinfo-heading-face
'texinfo-heading
)
345 (defvar texinfo-font-lock-keywords
346 `(;; All but the first had an OVERRIDE of t.
347 ;; It didn't seem to be any better, and it's slower--simon.
348 ;; Robert J. Chassell <bob@gnu.org> says remove this line.
349 ;;("\\$\\([^$]*\\)\\$" 1 font-lock-string-face t)
350 ("@\\([a-zA-Z]+\\|[^ \t\n]\\)" 1 font-lock-keyword-face
) ;commands
351 ("^\\*\\([^\n:]*\\)" 1 font-lock-function-name-face t
) ;menu items
352 ("@\\(emph\\|i\\|sc\\){\\([^}]+\\)" 2 'italic
)
353 ("@\\(strong\\|b\\){\\([^}]+\\)" 2 'bold
)
354 ("@\\(kbd\\|key\\|url\\|uref\\){\\([^}]+\\)" 2 font-lock-string-face
)
355 ;; The following two groups have an OVERRIDE of `keep' because
356 ;; their arguments frequently include a @@, and we don't want that
357 ;; to overwrite the normal fontification of the argument.
358 ("@\\(file\\|email\\){\\([^}]+\\)" 2 font-lock-string-face keep
)
359 ("@\\(samp\\|code\\|var\\|math\\|env\\|command\\|option\\){\\([^}]+\\)"
360 2 font-lock-variable-name-face keep
)
361 ("@\\(cite\\|x?ref\\|pxref\\|dfn\\|inforef\\){\\([^}]+\\)"
362 2 font-lock-constant-face
)
363 ("@\\(anchor\\){\\([^}]+\\)" 2 font-lock-type-face
)
364 ("@\\(dmn\\|acronym\\|value\\){\\([^}]+\\)" 2 font-lock-builtin-face
)
365 ("@\\(end\\|itemx?\\) +\\(.+\\)" 2 font-lock-keyword-face keep
)
366 ;; (,texinfo-environment-regexp
367 ;; 1 (texinfo-clone-environment (match-beginning 1) (match-end 1)) keep)
368 (,(concat "^@" (regexp-opt (mapcar 'car texinfo-section-list
) t
)
369 ".*\n") 0 texinfo-heading-face t
))
370 "Additional expressions to highlight in Texinfo mode.")
372 (defun texinfo-clone-environment (start end
)
377 (when (looking-at "end\\Sw+\\(\\sw+\\)")
378 (setq endp t start
(match-beginning 1) end
(match-end 1)))
379 (unless (get-char-property start
'text-clones
)
381 (texinfo-last-unended-begin)
383 (texinfo-next-unmatched-end))
384 (skip-syntax-forward "^w")
386 (concat (regexp-quote (buffer-substring start end
)) "\\>"))
387 (text-clone-create start end
'spread
"\\w*")))))))
392 ;;; Keys common both to Texinfo mode and to TeX shell.
394 (defun texinfo-define-common-keys (keymap)
395 "Define the keys both in Texinfo mode and in the texinfo-tex-shell."
396 (define-key keymap
"\C-c\C-t\C-k" 'tex-kill-job
)
397 (define-key keymap
"\C-c\C-t\C-x" 'texinfo-quit-job
)
398 (define-key keymap
"\C-c\C-t\C-l" 'tex-recenter-output-buffer
)
399 (define-key keymap
"\C-c\C-t\C-d" 'texinfo-delete-from-print-queue
)
400 (define-key keymap
"\C-c\C-t\C-q" 'tex-show-print-queue
)
401 (define-key keymap
"\C-c\C-t\C-p" 'texinfo-tex-print
)
402 (define-key keymap
"\C-c\C-t\C-v" 'texinfo-tex-view
)
403 (define-key keymap
"\C-c\C-t\C-i" 'texinfo-texindex
)
405 (define-key keymap
"\C-c\C-t\C-r" 'texinfo-tex-region
)
406 (define-key keymap
"\C-c\C-t\C-b" 'texinfo-tex-buffer
))
408 ;; Mode documentation displays commands in reverse order
409 ;; from how they are listed in the texinfo-mode-map.
411 (defvar texinfo-mode-map
412 (let ((map (make-sparse-keymap)))
414 ;; bindings for `texnfo-tex.el'
415 (texinfo-define-common-keys map
)
417 (define-key map
"\"" 'texinfo-insert-quote
)
419 ;; bindings for `makeinfo.el'
420 (define-key map
"\C-c\C-m\C-k" 'kill-compilation
)
421 (define-key map
"\C-c\C-m\C-l"
422 'makeinfo-recenter-compilation-buffer
)
423 (define-key map
"\C-c\C-m\C-r" 'makeinfo-region
)
424 (define-key map
"\C-c\C-m\C-b" 'makeinfo-buffer
)
426 ;; bindings for `texinfmt.el'
427 (define-key map
"\C-c\C-e\C-r" 'texinfo-format-region
)
428 (define-key map
"\C-c\C-e\C-b" 'texinfo-format-buffer
)
430 ;; AUCTeX-like bindings
431 (define-key map
"\e\r" 'texinfo-insert-
@item
)
433 ;; bindings for updating nodes and menus
435 (define-key map
"\C-c\C-um" 'texinfo-master-menu
)
437 (define-key map
"\C-c\C-u\C-m" 'texinfo-make-menu
)
438 (define-key map
"\C-c\C-u\C-n" 'texinfo-update-node
)
439 (define-key map
"\C-c\C-u\C-e" 'texinfo-every-node-update
)
440 (define-key map
"\C-c\C-u\C-a" 'texinfo-all-menus-update
)
442 (define-key map
"\C-c\C-s" 'texinfo-show-structure
)
444 (define-key map
"\C-c}" 'up-list
)
445 ;; FIXME: This is often used for "close block" aka texinfo-insert-@end.
446 (define-key map
"\C-c]" 'up-list
)
447 (define-key map
"\C-c/" 'texinfo-insert-
@end
)
448 (define-key map
"\C-c{" 'texinfo-insert-braces
)
450 ;; bindings for inserting strings
451 (define-key map
"\C-c\C-o" 'texinfo-insert-block
)
452 (define-key map
"\C-c\C-c\C-d" 'texinfo-start-menu-description
)
453 (define-key map
"\C-c\C-c\C-s" 'texinfo-insert-
@strong
)
454 (define-key map
"\C-c\C-c\C-e" 'texinfo-insert-
@emph
)
456 (define-key map
"\C-c\C-cv" 'texinfo-insert-
@var
)
457 (define-key map
"\C-c\C-cu" 'texinfo-insert-
@uref
)
458 (define-key map
"\C-c\C-ct" 'texinfo-insert-
@table
)
459 (define-key map
"\C-c\C-cs" 'texinfo-insert-
@samp
)
460 (define-key map
"\C-c\C-cq" 'texinfo-insert-
@quotation
)
461 (define-key map
"\C-c\C-co" 'texinfo-insert-
@noindent
)
462 (define-key map
"\C-c\C-cn" 'texinfo-insert-
@node
)
463 (define-key map
"\C-c\C-cm" 'texinfo-insert-
@email
)
464 (define-key map
"\C-c\C-ck" 'texinfo-insert-
@kbd
)
465 (define-key map
"\C-c\C-ci" 'texinfo-insert-
@item
)
466 (define-key map
"\C-c\C-cf" 'texinfo-insert-
@file
)
467 (define-key map
"\C-c\C-cx" 'texinfo-insert-
@example
)
468 (define-key map
"\C-c\C-ce" 'texinfo-insert-
@end
)
469 (define-key map
"\C-c\C-cd" 'texinfo-insert-
@dfn
)
470 (define-key map
"\C-c\C-cc" 'texinfo-insert-
@code
)
473 (easy-menu-define texinfo-mode-menu
475 "Menu used for `texinfo-mode'."
477 ["Insert block" texinfo-insert-block t
]
478 ;; ["Insert node" texinfo-insert-@node t]
480 ["Update All" (lambda () (interactive) (texinfo-master-menu t
))
481 :keys
"\\[universal-argument] \\[texinfo-master-menu]"]
482 ["Update every node" texinfo-every-node-update t
]
483 ["Update node" texinfo-update-node t
]
484 ["Make Master menu" texinfo-master-menu t
]
485 ["Make menu" texinfo-make-menu t
]
486 ["Update all menus" texinfo-all-menus-update t
]
488 ["Show structure" texinfo-show-structure t
]
489 ["Format region" texinfo-format-region t
]
490 ["Format buffer" texinfo-format-buffer t
]
491 ["Makeinfo region" makeinfo-region t
]
492 ["Makeinfo buffer" makeinfo-buffer t
]))
495 (defun texinfo-filter (section list
)
497 (dolist (x list
) (if (eq section
(cadr x
)) (push (car x
) res
)))
500 (defvar texinfo-chapter-level-regexp
501 (regexp-opt (texinfo-filter 2 texinfo-section-list
))
502 "Regular expression matching just the Texinfo chapter level headings.")
507 (define-derived-mode texinfo-mode text-mode
"Texinfo"
508 "Major mode for editing Texinfo files.
510 It has these extra commands:
513 These are files that are used as input for TeX to make printed manuals
514 and also to be turned into Info files with \\[makeinfo-buffer] or
515 the `makeinfo' program. These files must be written in a very restricted and
516 modified version of TeX input format.
518 Editing commands are like text-mode except that the syntax table is
519 set up so expression commands skip Texinfo bracket groups. To see
520 what the Info version of a region of the Texinfo file will look like,
521 use \\[makeinfo-region], which runs `makeinfo' on the current region.
523 You can show the structure of a Texinfo file with \\[texinfo-show-structure].
524 This command shows the structure of a Texinfo file by listing the
525 lines with the @-sign commands for @chapter, @section, and the like.
526 These lines are displayed in another window called the *Occur* window.
527 In that window, you can position the cursor over one of the lines and
528 use \\[occur-mode-goto-occurrence], to jump to the corresponding spot
531 In addition, Texinfo mode provides commands that insert various
532 frequently used @-sign commands into the buffer. You can use these
533 commands to save keystrokes. And you can insert balanced braces with
534 \\[texinfo-insert-braces] and later use the command \\[up-list] to
535 move forward past the closing brace.
537 Also, Texinfo mode provides functions for automatically creating or
538 updating menus and node pointers. These functions
540 * insert the `Next', `Previous' and `Up' pointers of a node,
541 * insert or update the menu for a section, and
542 * create a master menu for a Texinfo source file.
544 Here are the functions:
546 texinfo-update-node \\[texinfo-update-node]
547 texinfo-every-node-update \\[texinfo-every-node-update]
548 texinfo-sequential-node-update
550 texinfo-make-menu \\[texinfo-make-menu]
551 texinfo-all-menus-update \\[texinfo-all-menus-update]
554 texinfo-indent-menu-description (column &optional region-p)
556 The `texinfo-column-for-description' variable specifies the column to
557 which menu descriptions are indented.
559 Passed an argument (a prefix argument, if interactive), the
560 `texinfo-update-node' and `texinfo-make-menu' functions do their jobs
563 To use the updating commands, you must structure your Texinfo file
564 hierarchically, such that each `@node' line, with the exception of the
565 Top node, is accompanied by some kind of section line, such as an
566 `@chapter' or `@section' line.
568 If the file has a `top' node, it must be called `top' or `Top' and
569 be the first node in the file.
571 Entering Texinfo mode calls the value of `text-mode-hook', and then the
572 value of `texinfo-mode-hook'."
573 (set (make-local-variable 'page-delimiter
)
575 "^@node [ \t]*[Tt]op\\|^@\\("
576 texinfo-chapter-level-regexp
578 (make-local-variable 'require-final-newline
)
579 (setq require-final-newline mode-require-final-newline
)
580 (make-local-variable 'indent-tabs-mode
)
581 (setq indent-tabs-mode nil
)
582 (make-local-variable 'paragraph-separate
)
583 (setq paragraph-separate
584 (concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-separate
))
585 (make-local-variable 'paragraph-start
)
586 (setq paragraph-start
(concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-start
))
587 (set (make-local-variable 'sentence-end-base
)
588 "\\(@\\(end\\)?dots{}\\|[.?!]\\)[]\"'”)}]*")
589 (make-local-variable 'fill-column
)
590 (setq fill-column
70)
591 (make-local-variable 'comment-start
)
592 (setq comment-start
"@c ")
593 (make-local-variable 'comment-start-skip
)
594 (setq comment-start-skip
"@c +\\|@comment +")
595 (make-local-variable 'words-include-escapes
)
596 (setq words-include-escapes t
)
597 (make-local-variable 'imenu-generic-expression
)
598 (setq imenu-generic-expression texinfo-imenu-generic-expression
)
599 (setq imenu-case-fold-search nil
)
600 (make-local-variable 'font-lock-defaults
)
601 (setq font-lock-defaults
602 '(texinfo-font-lock-keywords nil nil nil backward-paragraph
))
603 (set (make-local-variable 'syntax-propertize-function
)
604 texinfo-syntax-propertize-function
)
605 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
608 (set (make-local-variable 'outline-heading-alist
)
609 ;; We should merge outline-heading-alist and texinfo-section-list
610 ;; but in the mean time, let's just generate one from the other.
611 (mapcar (lambda (x) (cons (concat "@" (car x
)) (cadr x
)))
612 texinfo-section-list
))
613 (set (make-local-variable 'outline-regexp
)
614 (concat (regexp-opt (mapcar 'car outline-heading-alist
) t
)
617 (make-local-variable 'tex-start-of-header
)
618 (setq tex-start-of-header
"%\\*\\*start")
619 (make-local-variable 'tex-end-of-header
)
620 (setq tex-end-of-header
"%\\*\\*end")
621 (make-local-variable 'tex-first-line-header-regexp
)
622 (setq tex-first-line-header-regexp
"^\\\\input")
623 (make-local-variable 'tex-trailer
)
624 (setq tex-trailer
"@bye\n")
626 ;; Prevent filling certain lines, in addition to ones specified
628 (let ((prevent-filling "^@\\(def\\|multitable\\)"))
629 (set (make-local-variable 'auto-fill-inhibit-regexp
)
630 (if (null auto-fill-inhibit-regexp
)
632 (concat auto-fill-inhibit-regexp
"\\|" prevent-filling
)))))
636 ;;; Insert string commands
638 (defvar texinfo-block-default
"example")
640 (define-skeleton texinfo-insert-block
641 "Create a matching pair @<cmd> .. @end <cmd> at point.
642 Puts point on a blank line between them."
643 (setq texinfo-block-default
644 (completing-read (format "Block name [%s]: " texinfo-block-default
)
646 nil nil nil nil texinfo-block-default
))
648 ;; Blocks that take parameters: all the def* blocks take parameters,
649 ;; plus a few others.
650 (if (or (string-match "\\`def" str
)
651 (member str
'("table" "ftable" "vtable")))
653 \n _
\n "@end " str
\n)
655 (defun texinfo-inside-macro-p (macro &optional bound
)
656 "Non-nil if inside a macro matching the regexp MACRO."
660 (narrow-to-region bound
(point))
663 (not (condition-case nil
671 (defun texinfo-inside-env-p (env &optional bound
)
672 "Non-nil if inside an environment matching the regexp @ENV."
674 (and (re-search-backward (concat "@\\(end\\s +\\)?" env
) bound t
)
675 (not (match-end 1)))))
677 (defvar texinfo-enable-quote-macros
"@\\(code\\|samp\\|kbd\\)\\>")
678 (defvar texinfo-enable-quote-envs
'("example\\>" "lisp\\>"))
679 (defun texinfo-insert-quote (&optional arg
)
680 "Insert the appropriate quote mark for Texinfo.
681 Usually inserts the value of `texinfo-open-quote' (normally ``) or
682 `texinfo-close-quote' (normally ''), depending on the context.
683 With prefix argument or inside @code or @example, inserts a plain \"."
685 (let ((top (or (save-excursion (re-search-backward "@node\\>" nil t
))
688 (= (preceding-char) ?
\\)
690 ;; Might be near the start of a (narrowed) buffer.
691 (ignore-errors (backward-char (length texinfo-open-quote
)))
692 (when (or (looking-at texinfo-open-quote
)
693 (looking-at texinfo-close-quote
))
694 (delete-char (length texinfo-open-quote
))
696 (texinfo-inside-macro-p texinfo-enable-quote-macros top
)
698 (dolist (env texinfo-enable-quote-envs in-env
)
699 (if (texinfo-inside-env-p env top
)
701 (self-insert-command (prefix-numeric-value arg
))
704 (memq (char-syntax (preceding-char)) '(?\
( ?
> ?\s
)))
706 texinfo-close-quote
)))))
708 ;; The following texinfo-insert-@end command not only inserts a SPC
709 ;; after the @end, but tries to find out what belongs there. It is
710 ;; not very smart: it does not understand nested lists.
712 (defun texinfo-last-unended-begin ()
713 (while (and (re-search-backward texinfo-environment-regexp
)
715 (texinfo-last-unended-begin)))
717 (defun texinfo-next-unmatched-end ()
718 (while (and (re-search-forward texinfo-environment-regexp
)
720 (goto-char (match-beginning 0))
721 (not (looking-at "@end"))))
722 (texinfo-next-unmatched-end)))
724 (define-skeleton texinfo-insert-
@end
725 "Insert the matching `@end' for the last Texinfo command that needs one."
729 (texinfo-last-unended-begin)
730 (or (match-string 1) '-
)))
733 (define-skeleton texinfo-insert-braces
734 "Make a pair of braces and be poised to type inside of them.
735 Use \\[up-list] to move forward out of the braces."
739 (define-skeleton texinfo-insert-
@code
740 "Insert a `@code{...}' command in a Texinfo buffer.
741 A numeric argument says how many words the braces should surround.
742 The default is not to surround any existing words with the braces."
746 (define-skeleton texinfo-insert-
@dfn
747 "Insert a `@dfn{...}' command in a Texinfo buffer.
748 A numeric argument says how many words the braces should surround.
749 The default is not to surround any existing words with the braces."
753 (define-skeleton texinfo-insert-
@email
754 "Insert a `@email{...}' command in a Texinfo buffer.
755 A numeric argument says how many words the braces should surround.
756 The default is not to surround any existing words with the braces."
760 (define-skeleton texinfo-insert-
@emph
761 "Insert a `@emph{...}' command in a Texinfo buffer.
762 A numeric argument says how many words the braces should surround.
763 The default is not to surround any existing words with the braces."
767 (define-skeleton texinfo-insert-
@example
768 "Insert the string `@example' in a Texinfo buffer."
772 (define-skeleton texinfo-insert-
@file
773 "Insert a `@file{...}' command in a Texinfo buffer.
774 A numeric argument says how many words the braces should surround.
775 The default is not to surround any existing words with the braces."
779 (define-skeleton texinfo-insert-
@item
780 "Insert the string `@item' in a Texinfo buffer.
781 If in a table defined by @table, follow said string with a space.
782 Otherwise, follow with a newline."
785 (if (equal (ignore-errors
787 (texinfo-last-unended-begin)
793 (define-skeleton texinfo-insert-
@kbd
794 "Insert a `@kbd{...}' command in a Texinfo buffer.
795 A numeric argument says how many words the braces should surround.
796 The default is not to surround any existing words with the braces."
800 (define-skeleton texinfo-insert-
@node
801 "Insert the string `@node' in a Texinfo buffer.
802 Insert a comment on the following line indicating the order of
803 arguments to @node. Insert a carriage return after the comment line.
804 Leave point after `@node'."
808 (define-skeleton texinfo-insert-
@noindent
809 "Insert the string `@noindent' in a Texinfo buffer."
813 (define-skeleton texinfo-insert-
@quotation
814 "Insert the string `@quotation' in a Texinfo buffer."
817 (define-skeleton texinfo-insert-
@samp
818 "Insert a `@samp{...}' command in a Texinfo buffer.
819 A numeric argument says how many words the braces should surround.
820 The default is not to surround any existing words with the braces."
824 (define-skeleton texinfo-insert-
@strong
825 "Insert a `@strong{...}' command in a Texinfo buffer.
826 A numeric argument says how many words the braces should surround.
827 The default is not to surround any existing words with the braces."
831 (define-skeleton texinfo-insert-
@table
832 "Insert the string `@table' in a Texinfo buffer."
836 (define-skeleton texinfo-insert-
@var
837 "Insert a `@var{}' command in a Texinfo buffer.
838 A numeric argument says how many words the braces should surround.
839 The default is not to surround any existing words with the braces."
843 (define-skeleton texinfo-insert-
@uref
844 "Insert a `@uref{}' command in a Texinfo buffer.
845 A numeric argument says how many words the braces should surround.
846 The default is not to surround any existing words with the braces."
849 (defalias 'texinfo-insert-
@url
'texinfo-insert-
@uref
)
851 ;;; Texinfo file structure
853 (defun texinfo-show-structure (&optional nodes-too
)
854 "Show the structure of a Texinfo file.
855 List the lines in the file that begin with the @-sign commands for
856 @chapter, @section, and the like.
858 With optional argument (prefix if interactive), list both the lines
859 with @-sign commands for @chapter, @section, and the like, and list
862 Lines with structuring commands beginning in them are displayed in
863 another buffer named `*Occur*'. In that buffer, you can move point to
864 one of those lines and then use
865 \\<occur-mode-map>\\[occur-mode-goto-occurrence],
866 to jump to the corresponding spot in the Texinfo source file."
869 ;; First, remember current location
870 (let (current-location)
872 (end-of-line) ; so as to find section on current line
873 (if (re-search-backward
874 ;; do not require `texinfo-section-types-regexp' in texnfo-upd.el
875 "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
877 (setq current-location
880 (buffer-substring (point) (progn (end-of-line) (point)))))
881 ;; else point is located before any section command.
882 (setq current-location
"tex")))
883 ;; Second, create and format an *Occur* buffer
885 (goto-char (point-min))
886 (occur (concat "^\\(?:" (if nodes-too
"@node\\>\\|")
887 outline-regexp
"\\)")))
888 (pop-to-buffer "*Occur*")
889 (goto-char (point-min))
890 (let ((inhibit-read-only t
))
891 (flush-lines "-----")
892 ;; Now format the "*Occur*" buffer to show the structure.
893 ;; Thanks to ceder@signum.se (Per Cederqvist)
894 (goto-char (point-max))
896 (while (re-search-backward "^ *[0-9]*:@\\(\\sw+\\)" nil
0)
897 (goto-char (1- (match-beginning 1)))
899 (or (cadr (assoc (match-string 1) texinfo-section-list
)) 2))
900 (indent-to-column (+ (current-column) (* 4 (- level
2))))
901 (beginning-of-line))))
902 ;; Third, go to line corresponding to location in source file
903 ;; potential bug: two exactly similar `current-location' lines ...
904 (goto-char (point-min))
905 (re-search-forward current-location nil t
)
910 ;;; The tex and print function definitions:
912 (defcustom texinfo-texi2dvi-command
"texi2dvi"
913 "Command used by `texinfo-tex-buffer' to run TeX and texindex on a buffer."
917 (defcustom texinfo-tex-command
"tex"
918 "Command used by `texinfo-tex-region' to run TeX on a region."
922 (defcustom texinfo-texindex-command
"texindex"
923 "Command used by `texinfo-texindex' to sort unsorted index files."
927 (defcustom texinfo-delete-from-print-queue-command
"lprm"
928 "Command string used to delete a job from the line printer queue.
929 Command is used by \\[texinfo-delete-from-print-queue] based on
930 number provided by a previous \\[tex-show-print-queue]
935 (defvar texinfo-tex-trailer
"@bye"
936 "String appended after a region sent to TeX by `texinfo-tex-region'.")
938 (defun texinfo-tex-region (beg end
)
939 "Run TeX on the current region.
940 This works by writing a temporary file (`tex-zap-file') in the directory
941 that is the value of `tex-directory', then running TeX on that file.
943 The first line of the buffer is copied to the
944 temporary file; and if the buffer has a header, it is written to the
945 temporary file before the region itself. The buffer's header is all lines
946 between the strings defined by `tex-start-of-header' and `tex-end-of-header'
947 inclusive. The header must start in the first 100 lines.
949 The value of `texinfo-tex-trailer' is appended to the temporary file after the region."
952 (let ((tex-command texinfo-tex-command
)
953 (tex-trailer texinfo-tex-trailer
))
954 (tex-region beg end
)))
956 (defun texinfo-tex-buffer ()
957 "Run TeX on visited file, once or twice, to make a correct `.dvi' file."
960 (let ((tex-command texinfo-texi2dvi-command
)
961 ;; Disable tex-start-options-string. texi2dvi would not
962 ;; understand anything specified here.
963 (tex-start-options-string ""))
966 (defun texinfo-texindex ()
967 "Run `texindex' on unsorted index files.
968 The index files are made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
969 This runs the shell command defined by `texinfo-texindex-command'."
972 (tex-send-command texinfo-texindex-command
(concat tex-zap-file
".??"))
974 ;; (send-string "tex-shell"
975 ;; (concat texinfo-texindex-command
976 ;; " " tex-zap-file ".??" "\n"))
977 (tex-recenter-output-buffer nil
))
979 (defun texinfo-tex-print ()
980 "Print `.dvi' file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
981 This runs the shell command defined by `tex-dvi-print-command'."
986 (defun texinfo-tex-view ()
987 "View `.dvi' file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
988 This runs the shell command defined by `tex-dvi-view-command'."
993 (defun texinfo-quit-job ()
994 "Quit currently running TeX job, by sending an `x' to it."
996 (if (not (get-process "tex-shell"))
997 (error "No TeX shell running"))
998 (tex-send-command "x"))
1001 ;; (set-buffer (get-buffer "*tex-shell*"))
1002 ;; (goto-char (point-max))
1004 ;; (comint-send-input)
1006 (defun texinfo-delete-from-print-queue (job-number)
1007 "Delete job from the line printer spooling queue.
1008 You are prompted for the job number (use a number shown by a previous
1009 \\[tex-show-print-queue] command)."
1010 (interactive "nPrinter job number for deletion: ")
1012 (if (tex-shell-running)
1015 (tex-send-command texinfo-delete-from-print-queue-command job-number
)
1017 ;; (send-string "tex-shell"
1019 ;; texinfo-delete-from-print-queue-command
1022 (tex-recenter-output-buffer nil
))
1026 ;;; texinfo.el ends here