Commit | Line | Data |
---|---|---|
e739cc85 | 1 | ;;; texinfo.el --- major mode for editing Texinfo files -*- coding: utf-8 -*- |
be010748 | 2 | |
98a864f0 | 3 | ;; Copyright (C) 1985, 1988, 1989, 1990, 1991, 1992, 1993, 1996, 1997, |
114f9c96 | 4 | ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
49c539a1 | 5 | ;; Free Software Foundation, Inc. |
e926e412 | 6 | |
5ccb13ff | 7 | ;; Author: Robert J. Chassell |
07e77e36 | 8 | ;; Date: [See date below for texinfo-version] |
630dd250 | 9 | ;; Maintainer: FSF |
5ccb13ff | 10 | ;; Keywords: maint, tex, docs |
eea8d4ef | 11 | |
be010748 | 12 | ;; This file is part of GNU Emacs. |
952d72ff | 13 | |
1fecc8fe | 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
952d72ff | 15 | ;; it under the terms of the GNU General Public License as published by |
1fecc8fe GM |
16 | ;; the Free Software Foundation, either version 3 of the License, or |
17 | ;; (at your option) any later version. | |
952d72ff RC |
18 | |
19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | ;; GNU General Public License for more details. | |
23 | ||
24 | ;; You should have received a copy of the GNU General Public License | |
1fecc8fe | 25 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
952d72ff | 26 | |
8fe6d67f SM |
27 | ;;; Todo: |
28 | ||
29 | ;; - facemenu support. | |
76b7c637 | 30 | ;; - command completion. |
8fe6d67f | 31 | |
e8af40ee PJ |
32 | ;;; Commentary: |
33 | ||
5ccb13ff RS |
34 | ;;; Code: |
35 | ||
a11609d8 | 36 | (eval-when-compile (require 'tex-mode) (require 'cl)) |
366fb0ab | 37 | (defvar outline-heading-alist) |
08f9e254 | 38 | |
cd482e05 | 39 | (defgroup texinfo nil |
dbc868a1 | 40 | "Texinfo Mode." |
8ec3bce0 | 41 | :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces) |
cd482e05 RS |
42 | :group 'docs) |
43 | ||
9768eaa7 | 44 | ;;;###autoload |
aaa448c9 | 45 | (defcustom texinfo-open-quote (purecopy "``") |
2db33a18 | 46 | "String inserted by typing \\[texinfo-insert-quote] to open a quotation." |
9768eaa7 EZ |
47 | :type 'string |
48 | :group 'texinfo) | |
49 | ||
50 | ;;;###autoload | |
aaa448c9 | 51 | (defcustom texinfo-close-quote (purecopy "''") |
2db33a18 | 52 | "String inserted by typing \\[texinfo-insert-quote] to close a quotation." |
9768eaa7 EZ |
53 | :type 'string |
54 | :group 'texinfo) | |
55 | ||
630dd250 SJ |
56 | (defcustom texinfo-mode-hook nil |
57 | "Normal hook run when entering Texinfo mode." | |
58 | :type 'hook | |
59 | :options '(turn-on-auto-fill flyspell-mode) | |
60 | :group 'texinfo) | |
61 | ||
c6cc04e9 RS |
62 | \f |
63 | ;;; Autoloads: | |
64 | ||
65 | (autoload 'makeinfo-region | |
5ccb13ff | 66 | "makeinfo" |
c6cc04e9 RS |
67 | "Make Info file from region of current Texinfo file, and switch to it. |
68 | ||
69 | This command does not offer the `next-error' feature since it would | |
70 | apply to a temporary file, not the original; use the `makeinfo-buffer' | |
71 | command to gain use of `next-error'." | |
5ccb13ff | 72 | t nil) |
c6cc04e9 RS |
73 | |
74 | (autoload 'makeinfo-buffer | |
5ccb13ff | 75 | "makeinfo" |
c6cc04e9 RS |
76 | "Make Info file from current buffer. |
77 | ||
5ccb13ff | 78 | Use the \\[next-error] command to move to the next error |
c6cc04e9 | 79 | \(if there are errors\)." |
5ccb13ff | 80 | t nil) |
c6cc04e9 RS |
81 | |
82 | (autoload 'kill-compilation | |
5ccb13ff | 83 | "compile" |
c6cc04e9 | 84 | "Kill the process made by the \\[compile] command." |
5ccb13ff | 85 | t nil) |
c6cc04e9 RS |
86 | |
87 | (autoload 'makeinfo-recenter-compilation-buffer | |
5ccb13ff | 88 | "makeinfo" |
c6cc04e9 RS |
89 | "Redisplay `*compilation*' buffer so most recent output can be seen. |
90 | The last line of the buffer is displayed on | |
91 | line LINE of the window, or centered if LINE is nil." | |
5ccb13ff RS |
92 | t nil) |
93 | ||
94 | (autoload 'texinfo-update-node | |
95 | "texnfo-upd" | |
96 | "Without any prefix argument, update the node in which point is located. | |
97 | Non-nil argument (prefix, if interactive) means update the nodes in the | |
98 | marked region. | |
99 | ||
100 | The functions for creating or updating nodes and menus, and their | |
101 | keybindings, are: | |
102 | ||
08f9e254 DL |
103 | `texinfo-update-node' (&optional region-p) \\[texinfo-update-node] |
104 | `texinfo-every-node-update' () \\[texinfo-every-node-update] | |
105 | `texinfo-sequential-node-update' (&optional region-p) | |
5ccb13ff | 106 | |
08f9e254 DL |
107 | `texinfo-make-menu' (&optional region-p) \\[texinfo-make-menu] |
108 | `texinfo-all-menus-update' () \\[texinfo-all-menus-update] | |
109 | `texinfo-master-menu' () | |
5ccb13ff | 110 | |
08f9e254 | 111 | `texinfo-indent-menu-description' (column &optional region-p) |
5ccb13ff RS |
112 | |
113 | The `texinfo-column-for-description' variable specifies the column to | |
114 | which menu descriptions are indented. Its default value is 32." | |
115 | t nil) | |
116 | ||
117 | (autoload 'texinfo-every-node-update | |
118 | "texnfo-upd" | |
119 | "Update every node in a Texinfo file." | |
120 | t nil) | |
121 | ||
122 | (autoload 'texinfo-sequential-node-update | |
123 | "texnfo-upd" | |
124 | "Update one node (or many) in a Texinfo file with sequential pointers. | |
125 | ||
126 | This function causes the `Next' or `Previous' pointer to point to the | |
127 | immediately preceding or following node, even if it is at a higher or | |
128 | lower hierarchical level in the document. Continually pressing `n' or | |
129 | `p' takes you straight through the file. | |
130 | ||
131 | Without any prefix argument, update the node in which point is located. | |
132 | Non-nil argument (prefix, if interactive) means update the nodes in the | |
133 | marked region. | |
134 | ||
135 | This command makes it awkward to navigate among sections and | |
136 | subsections; it should be used only for those documents that are meant | |
137 | to be read like a novel rather than a reference, and for which the | |
138 | Info `g*' command is inadequate." | |
139 | t nil) | |
c6cc04e9 RS |
140 | |
141 | (autoload 'texinfo-make-menu | |
5ccb13ff | 142 | "texnfo-upd" |
c6cc04e9 RS |
143 | "Without any prefix argument, make or update a menu. |
144 | Make the menu for the section enclosing the node found following point. | |
145 | ||
146 | Non-nil argument (prefix, if interactive) means make or update menus | |
147 | for nodes within or part of the marked region. | |
148 | ||
149 | Whenever a menu exists, and is being updated, the descriptions that | |
150 | are associated with node names in the pre-existing menu are | |
151 | incorporated into the new menu. Otherwise, the nodes' section titles | |
152 | are inserted as descriptions." | |
5ccb13ff | 153 | t nil) |
c6cc04e9 RS |
154 | |
155 | (autoload 'texinfo-all-menus-update | |
5ccb13ff | 156 | "texnfo-upd" |
c6cc04e9 RS |
157 | "Update every regular menu in a Texinfo file. |
158 | Remove pre-existing master menu, if there is one. | |
159 | ||
160 | If called with a non-nil argument, this function first updates all the | |
161 | nodes in the buffer before updating the menus." | |
5ccb13ff | 162 | t nil) |
c6cc04e9 RS |
163 | |
164 | (autoload 'texinfo-master-menu | |
5ccb13ff | 165 | "texnfo-upd" |
c6cc04e9 RS |
166 | "Make a master menu for a whole Texinfo file. |
167 | Non-nil argument (prefix, if interactive) means first update all | |
168 | existing nodes and menus. Remove pre-existing master menu, if there is one. | |
169 | ||
170 | This function creates a master menu that follows the top node. The | |
171 | master menu includes every entry from all the other menus. It | |
172 | replaces any existing ordinary menu that follows the top node. | |
173 | ||
174 | If called with a non-nil argument, this function first updates all the | |
175 | menus in the buffer (incorporating descriptions from pre-existing | |
176 | menus) before it constructs the master menu. | |
177 | ||
178 | The function removes the detailed part of an already existing master | |
9687a051 | 179 | menu. This action depends on the pre-existing master menu using the |
c6cc04e9 RS |
180 | standard `texinfo-master-menu-header'. |
181 | ||
182 | The master menu has the following format, which is adapted from the | |
183 | recommendation in the Texinfo Manual: | |
184 | ||
185 | * The first part contains the major nodes in the Texinfo file: the | |
186 | nodes for the chapters, chapter-like sections, and the major | |
187 | appendices. This includes the indices, so long as they are in | |
188 | chapter-like sections, such as unnumbered sections. | |
189 | ||
190 | * The second and subsequent parts contain a listing of the other, | |
191 | lower level menus, in order. This way, an inquirer can go | |
192 | directly to a particular node if he or she is searching for | |
193 | specific information. | |
194 | ||
195 | Each of the menus in the detailed node listing is introduced by the | |
196 | title of the section containing the menu." | |
5ccb13ff | 197 | t nil) |
c6cc04e9 RS |
198 | |
199 | (autoload 'texinfo-indent-menu-description | |
5ccb13ff RS |
200 | "texnfo-upd" |
201 | "Indent every description in menu following point to COLUMN. | |
c6cc04e9 RS |
202 | Non-nil argument (prefix, if interactive) means indent every |
203 | description in every menu in the region. Does not indent second and | |
204 | subsequent lines of a multi-line description." | |
5ccb13ff | 205 | t nil) |
c6cc04e9 RS |
206 | |
207 | (autoload 'texinfo-insert-node-lines | |
5ccb13ff | 208 | "texnfo-upd" |
c6cc04e9 RS |
209 | "Insert missing `@node' lines in region of Texinfo file. |
210 | Non-nil argument (prefix, if interactive) means also to insert the | |
211 | section titles as node names; and also to insert the section titles as | |
212 | node names in pre-existing @node lines that lack names." | |
5ccb13ff | 213 | t nil) |
c6cc04e9 RS |
214 | |
215 | (autoload 'texinfo-start-menu-description | |
5ccb13ff RS |
216 | "texnfo-upd" |
217 | "In this menu entry, insert the node's section title as a description. | |
c6cc04e9 RS |
218 | Position point at beginning of description ready for editing. |
219 | Do not insert a title if the line contains an existing description. | |
220 | ||
221 | You will need to edit the inserted text since a useful description | |
222 | complements the node name rather than repeats it as a title does." | |
5ccb13ff | 223 | t nil) |
c6cc04e9 RS |
224 | |
225 | (autoload 'texinfo-multiple-files-update | |
5ccb13ff | 226 | "texnfo-upd" |
c6cc04e9 | 227 | "Update first node pointers in each file included in OUTER-FILE; |
5ccb13ff | 228 | create or update main menu in the outer file that refers to such nodes. |
c6cc04e9 RS |
229 | This does not create or update menus or pointers within the included files. |
230 | ||
231 | With optional MAKE-MASTER-MENU argument (prefix arg, if interactive), | |
232 | insert a master menu in OUTER-FILE. This does not create or update | |
233 | menus or pointers within the included files. | |
234 | ||
235 | With optional UPDATE-EVERYTHING argument (numeric prefix arg, if | |
236 | interactive), update all the menus and all the `Next', `Previous', and | |
237 | `Up' pointers of all the files included in OUTER-FILE before inserting | |
238 | a master menu in OUTER-FILE. | |
239 | ||
240 | The command also updates the `Top' level node pointers of OUTER-FILE. | |
241 | ||
5ccb13ff | 242 | Notes: |
c6cc04e9 RS |
243 | |
244 | * this command does NOT save any files--you must save the | |
245 | outer file and any modified, included files. | |
246 | ||
247 | * except for the `Top' node, this command does NOT handle any | |
248 | pre-existing nodes in the outer file; hence, indices must be | |
249 | enclosed in an included file. | |
250 | ||
251 | Requirements: | |
252 | ||
253 | * each of the included files must contain exactly one highest | |
5ccb13ff | 254 | hierarchical level node, |
c6cc04e9 RS |
255 | * this highest node must be the first node in the included file, |
256 | * each highest hierarchical level node must be of the same type. | |
257 | ||
258 | Thus, normally, each included file contains one, and only one, | |
259 | chapter." | |
5ccb13ff | 260 | t nil) |
c6cc04e9 RS |
261 | |
262 | \f | |
e5167999 ER |
263 | ;;; Code: |
264 | ||
c678a343 | 265 | ;;; Don't you dare insert any `require' calls at top level in this file--rms. |
e67adf46 | 266 | |
eedd2812 SM |
267 | (defvar texinfo-section-list |
268 | '(("top" 1) | |
eedd2812 | 269 | ("chapter" 2) |
eedd2812 | 270 | ("section" 3) |
eedd2812 | 271 | ("subsection" 4) |
eedd2812 | 272 | ("subsubsection" 5) |
f412245b SM |
273 | ("unnumbered" 2) |
274 | ("unnumberedsec" 3) | |
275 | ("unnumberedsubsec" 4) | |
eedd2812 | 276 | ("unnumberedsubsubsec" 5) |
f412245b SM |
277 | ("appendix" 2) |
278 | ("appendixsec" 3) | |
76b7c637 | 279 | ("appendixsection" 3) |
f412245b | 280 | ("appendixsubsec" 4) |
eedd2812 | 281 | ("appendixsubsubsec" 5) |
f412245b SM |
282 | ("majorheading" 2) |
283 | ("chapheading" 2) | |
284 | ("heading" 3) | |
285 | ("subheading" 4) | |
eedd2812 SM |
286 | ("subsubheading" 5)) |
287 | "Alist of sectioning commands and their relative level.") | |
288 | ||
c6cc04e9 | 289 | ;;; Syntax table |
1de2ada0 | 290 | |
2db33a18 SM |
291 | (defvar texinfo-mode-syntax-table |
292 | (let ((st (make-syntax-table))) | |
293 | (modify-syntax-entry ?\" "." st) | |
294 | (modify-syntax-entry ?\\ "." st) | |
295 | (modify-syntax-entry ?@ "\\" st) | |
296 | (modify-syntax-entry ?\^q "\\" st) | |
297 | (modify-syntax-entry ?\[ "(]" st) | |
298 | (modify-syntax-entry ?\] ")[" st) | |
299 | (modify-syntax-entry ?{ "(}" st) | |
300 | (modify-syntax-entry ?} "){" st) | |
301 | (modify-syntax-entry ?\n ">" st) | |
302 | (modify-syntax-entry ?\' "w" st) | |
303 | st)) | |
952d72ff | 304 | |
e4cfb70d | 305 | ;; Written by Wolfgang Bangerth <zcg51122@rpool1.rus.uni-stuttgart.de> |
9687a051 | 306 | ;; To override this example, set either `imenu-generic-expression' |
e4cfb70d KH |
307 | ;; or `imenu-create-index-function'. |
308 | (defvar texinfo-imenu-generic-expression | |
08f9e254 | 309 | '((nil "^@\\(node\\|anchor\\)[ \t]+\\([^,\n]*\\)" 2) |
e4cfb70d | 310 | ("Chapters" "^@chapter[ \t]+\\(.*\\)$" 1)) |
887a2f77 | 311 | "Imenu generic expression for Texinfo mode. See `imenu-generic-expression'.") |
e4cfb70d | 312 | |
e3721db1 | 313 | (defvar texinfo-font-lock-syntactic-keywords |
92819e90 SM |
314 | '(("\\(@\\)c\\(omment\\)?\\>" (1 "<")) |
315 | ("^\\(@\\)ignore\\>" (1 "< b")) | |
316 | ("^@end ignore\\(\n\\)" (1 "> b"))) | |
e3721db1 SM |
317 | "Syntactic keywords to catch comment delimiters in `texinfo-mode'.") |
318 | ||
8fe6d67f | 319 | (defconst texinfo-environments |
db95369b | 320 | '("cartouche" "copying" "defcv" "deffn" "defivar" "defmac" |
e1a68e89 JB |
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") | |
887a2f77 | 331 | "List of Texinfo environments.") |
8fe6d67f SM |
332 | |
333 | (defconst texinfo-environment-regexp | |
334 | (concat "^@" (regexp-opt (cons "end" texinfo-environments) t) "\\>") | |
887a2f77 | 335 | "Regexp for environment-like Texinfo list commands. |
8fe6d67f SM |
336 | Subexpression 1 is what goes into the corresponding `@end' statement.") |
337 | ||
e639491a | 338 | (defface texinfo-heading |
eedd2812 | 339 | '((t (:inherit font-lock-function-name-face))) |
3ec0e903 LK |
340 | "Face used for section headings in `texinfo-mode'." |
341 | :group 'texinfo) | |
49c539a1 | 342 | (define-obsolete-face-alias 'texinfo-heading-face 'texinfo-heading "22.1") |
e639491a | 343 | (defvar texinfo-heading-face 'texinfo-heading) |
eedd2812 | 344 | |
0ece5f43 | 345 | (defvar texinfo-font-lock-keywords |
eedd2812 | 346 | `(;; All but the first had an OVERRIDE of t. |
dd7366bf | 347 | ;; It didn't seem to be any better, and it's slower--simon. |
5762abec | 348 | ;; Robert J. Chassell <bob@gnu.org> says remove this line. |
5ccb13ff RS |
349 | ;;("\\$\\([^$]*\\)\\$" 1 font-lock-string-face t) |
350 | ("@\\([a-zA-Z]+\\|[^ \t\n]\\)" 1 font-lock-keyword-face) ;commands | |
8fe6d67f SM |
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) | |
e38af9bd EZ |
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) | |
0cf452f3 | 359 | ("@\\(samp\\|code\\|var\\|math\\|env\\|command\\|option\\){\\([^}]+\\)" |
e38af9bd EZ |
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) | |
8fe6d67f | 365 | ("@\\(end\\|itemx?\\) +\\(.+\\)" 2 font-lock-keyword-face keep) |
28736082 SM |
366 | ;; (,texinfo-environment-regexp |
367 | ;; 1 (texinfo-clone-environment (match-beginning 1) (match-end 1)) keep) | |
eedd2812 | 368 | (,(concat "^@" (regexp-opt (mapcar 'car texinfo-section-list) t) |
08f9e254 | 369 | ".*\n") 0 texinfo-heading-face t)) |
887a2f77 | 370 | "Additional expressions to highlight in Texinfo mode.") |
491f6f0f | 371 | |
8fe6d67f SM |
372 | (defun texinfo-clone-environment (start end) |
373 | (let ((endp nil)) | |
374 | (save-excursion | |
375 | (ignore-errors | |
376 | (goto-char start) | |
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) | |
380 | (if endp | |
381 | (texinfo-last-unended-begin) | |
382 | (forward-word 1) | |
383 | (texinfo-next-unmatched-end)) | |
384 | (skip-syntax-forward "^w") | |
28736082 SM |
385 | (when (looking-at |
386 | (concat (regexp-quote (buffer-substring start end)) "\\>")) | |
8fe6d67f SM |
387 | (text-clone-create start end 'spread "\\w*"))))))) |
388 | ||
c6cc04e9 RS |
389 | \f |
390 | ;;; Keybindings | |
952d72ff | 391 | |
c6cc04e9 RS |
392 | ;;; Keys common both to Texinfo mode and to TeX shell. |
393 | ||
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) | |
24e519d8 | 402 | (define-key keymap "\C-c\C-t\C-v" 'texinfo-tex-view) |
c6cc04e9 RS |
403 | (define-key keymap "\C-c\C-t\C-i" 'texinfo-texindex) |
404 | ||
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)) | |
407 | ||
5ccb13ff | 408 | ;; Mode documentation displays commands in reverse order |
952d72ff | 409 | ;; from how they are listed in the texinfo-mode-map. |
c6cc04e9 | 410 | |
2db33a18 SM |
411 | (defvar texinfo-mode-map |
412 | (let ((map (make-sparse-keymap))) | |
413 | ||
414 | ;; bindings for `texnfo-tex.el' | |
415 | (texinfo-define-common-keys map) | |
416 | ||
417 | (define-key map "\"" 'texinfo-insert-quote) | |
418 | ||
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) | |
425 | ||
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) | |
429 | ||
430 | ;; AUCTeX-like bindings | |
431 | (define-key map "\e\r" 'texinfo-insert-@item) | |
432 | ||
433 | ;; bindings for updating nodes and menus | |
434 | ||
435 | (define-key map "\C-c\C-um" 'texinfo-master-menu) | |
436 | ||
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) | |
441 | ||
442 | (define-key map "\C-c\C-s" 'texinfo-show-structure) | |
443 | ||
444 | (define-key map "\C-c}" 'up-list) | |
445 | (define-key map "\C-c]" 'up-list) | |
446 | (define-key map "\C-c{" 'texinfo-insert-braces) | |
447 | ||
448 | ;; bindings for inserting strings | |
449 | (define-key map "\C-c\C-o" 'texinfo-insert-block) | |
450 | (define-key map "\C-c\C-c\C-d" 'texinfo-start-menu-description) | |
451 | (define-key map "\C-c\C-c\C-s" 'texinfo-insert-@strong) | |
452 | (define-key map "\C-c\C-c\C-e" 'texinfo-insert-@emph) | |
453 | ||
454 | (define-key map "\C-c\C-cv" 'texinfo-insert-@var) | |
455 | (define-key map "\C-c\C-cu" 'texinfo-insert-@uref) | |
456 | (define-key map "\C-c\C-ct" 'texinfo-insert-@table) | |
457 | (define-key map "\C-c\C-cs" 'texinfo-insert-@samp) | |
458 | (define-key map "\C-c\C-cq" 'texinfo-insert-@quotation) | |
459 | (define-key map "\C-c\C-co" 'texinfo-insert-@noindent) | |
460 | (define-key map "\C-c\C-cn" 'texinfo-insert-@node) | |
461 | (define-key map "\C-c\C-cm" 'texinfo-insert-@email) | |
462 | (define-key map "\C-c\C-ck" 'texinfo-insert-@kbd) | |
463 | (define-key map "\C-c\C-ci" 'texinfo-insert-@item) | |
464 | (define-key map "\C-c\C-cf" 'texinfo-insert-@file) | |
465 | (define-key map "\C-c\C-cx" 'texinfo-insert-@example) | |
466 | (define-key map "\C-c\C-ce" 'texinfo-insert-@end) | |
467 | (define-key map "\C-c\C-cd" 'texinfo-insert-@dfn) | |
468 | (define-key map "\C-c\C-cc" 'texinfo-insert-@code) | |
469 | map)) | |
952d72ff | 470 | |
eedd2812 SM |
471 | (easy-menu-define texinfo-mode-menu |
472 | texinfo-mode-map | |
473 | "Menu used for `texinfo-mode'." | |
474 | '("Texinfo" | |
475 | ["Insert block" texinfo-insert-block t] | |
476 | ;; ["Insert node" texinfo-insert-@node t] | |
477 | "----" | |
003dd635 SM |
478 | ["Update All" (lambda () (interactive) (texinfo-master-menu t)) |
479 | :keys "\\[universal-argument] \\[texinfo-master-menu]"] | |
eedd2812 SM |
480 | ["Update every node" texinfo-every-node-update t] |
481 | ["Update node" texinfo-update-node t] | |
482 | ["Make Master menu" texinfo-master-menu t] | |
483 | ["Make menu" texinfo-make-menu t] | |
484 | ["Update all menus" texinfo-all-menus-update t] | |
485 | "----" | |
486 | ["Show structure" texinfo-show-structure t] | |
487 | ["Format region" texinfo-format-region t] | |
488 | ["Format buffer" texinfo-format-buffer t] | |
489 | ["Makeinfo region" makeinfo-region t] | |
490 | ["Makeinfo buffer" makeinfo-buffer t])) | |
491 | ||
c6cc04e9 | 492 | \f |
a11609d8 SM |
493 | (defun texinfo-filter (section list) |
494 | (let (res) | |
495 | (dolist (x list) (if (eq section (cadr x)) (push (car x) res))) | |
496 | res)) | |
497 | ||
498 | (defvar texinfo-chapter-level-regexp | |
499 | (regexp-opt (texinfo-filter 2 texinfo-section-list)) | |
500 | "Regular expression matching just the Texinfo chapter level headings.") | |
501 | ||
c6cc04e9 | 502 | ;;; Texinfo mode |
952d72ff | 503 | |
f9f9507e | 504 | ;;;###autoload |
e3721db1 | 505 | (define-derived-mode texinfo-mode text-mode "Texinfo" |
d5aa8b02 | 506 | "Major mode for editing Texinfo files. |
952d72ff RC |
507 | |
508 | It has these extra commands: | |
509 | \\{texinfo-mode-map} | |
510 | ||
d5aa8b02 | 511 | These are files that are used as input for TeX to make printed manuals |
c6cc04e9 RS |
512 | and also to be turned into Info files with \\[makeinfo-buffer] or |
513 | the `makeinfo' program. These files must be written in a very restricted and | |
d5aa8b02 | 514 | modified version of TeX input format. |
952d72ff RC |
515 | |
516 | Editing commands are like text-mode except that the syntax table is | |
d5aa8b02 RC |
517 | set up so expression commands skip Texinfo bracket groups. To see |
518 | what the Info version of a region of the Texinfo file will look like, | |
c6cc04e9 | 519 | use \\[makeinfo-region], which runs `makeinfo' on the current region. |
952d72ff | 520 | |
d5aa8b02 RC |
521 | You can show the structure of a Texinfo file with \\[texinfo-show-structure]. |
522 | This command shows the structure of a Texinfo file by listing the | |
523 | lines with the @-sign commands for @chapter, @section, and the like. | |
524 | These lines are displayed in another window called the *Occur* window. | |
525 | In that window, you can position the cursor over one of the lines and | |
526 | use \\[occur-mode-goto-occurrence], to jump to the corresponding spot | |
527 | in the Texinfo file. | |
952d72ff | 528 | |
d5aa8b02 | 529 | In addition, Texinfo mode provides commands that insert various |
952d72ff RC |
530 | frequently used @-sign commands into the buffer. You can use these |
531 | commands to save keystrokes. And you can insert balanced braces with | |
532 | \\[texinfo-insert-braces] and later use the command \\[up-list] to | |
533 | move forward past the closing brace. | |
534 | ||
d5aa8b02 | 535 | Also, Texinfo mode provides functions for automatically creating or |
952d72ff RC |
536 | updating menus and node pointers. These functions |
537 | ||
538 | * insert the `Next', `Previous' and `Up' pointers of a node, | |
539 | * insert or update the menu for a section, and | |
d5aa8b02 | 540 | * create a master menu for a Texinfo source file. |
952d72ff RC |
541 | |
542 | Here are the functions: | |
543 | ||
544 | texinfo-update-node \\[texinfo-update-node] | |
545 | texinfo-every-node-update \\[texinfo-every-node-update] | |
5ccb13ff | 546 | texinfo-sequential-node-update |
952d72ff RC |
547 | |
548 | texinfo-make-menu \\[texinfo-make-menu] | |
549 | texinfo-all-menus-update \\[texinfo-all-menus-update] | |
550 | texinfo-master-menu | |
551 | ||
552 | texinfo-indent-menu-description (column &optional region-p) | |
553 | ||
554 | The `texinfo-column-for-description' variable specifies the column to | |
5ccb13ff | 555 | which menu descriptions are indented. |
952d72ff RC |
556 | |
557 | Passed an argument (a prefix argument, if interactive), the | |
558 | `texinfo-update-node' and `texinfo-make-menu' functions do their jobs | |
559 | in the region. | |
560 | ||
d5aa8b02 | 561 | To use the updating commands, you must structure your Texinfo file |
952d72ff | 562 | hierarchically, such that each `@node' line, with the exception of the |
d5aa8b02 | 563 | Top node, is accompanied by some kind of section line, such as an |
952d72ff RC |
564 | `@chapter' or `@section' line. |
565 | ||
566 | If the file has a `top' node, it must be called `top' or `Top' and | |
567 | be the first node in the file. | |
568 | ||
e3721db1 SM |
569 | Entering Texinfo mode calls the value of `text-mode-hook', and then the |
570 | value of `texinfo-mode-hook'." | |
a11609d8 SM |
571 | (set (make-local-variable 'page-delimiter) |
572 | (concat | |
573 | "^@node [ \t]*[Tt]op\\|^@\\(" | |
574 | texinfo-chapter-level-regexp | |
575 | "\\)\\>")) | |
952d72ff | 576 | (make-local-variable 'require-final-newline) |
7e630648 | 577 | (setq require-final-newline mode-require-final-newline) |
c6cc04e9 RS |
578 | (make-local-variable 'indent-tabs-mode) |
579 | (setq indent-tabs-mode nil) | |
952d72ff | 580 | (make-local-variable 'paragraph-separate) |
5ccb13ff RS |
581 | (setq paragraph-separate |
582 | (concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-separate)) | |
952d72ff | 583 | (make-local-variable 'paragraph-start) |
6e9f6940 | 584 | (setq paragraph-start (concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-start)) |
bb66398d RS |
585 | (make-local-variable 'sentence-end-base) |
586 | (setq sentence-end-base | |
e739cc85 | 587 | "\\(@\\(end\\)?dots{}\\|[.?!]\\)[]\"'”)}]*") |
5ed14933 RS |
588 | (make-local-variable 'adaptive-fill-mode) |
589 | (setq adaptive-fill-mode nil) | |
952d72ff | 590 | (make-local-variable 'fill-column) |
14ec09d7 | 591 | (setq fill-column 70) |
952d72ff RC |
592 | (make-local-variable 'comment-start) |
593 | (setq comment-start "@c ") | |
594 | (make-local-variable 'comment-start-skip) | |
e3721db1 | 595 | (setq comment-start-skip "@c +\\|@comment +") |
952d72ff RC |
596 | (make-local-variable 'words-include-escapes) |
597 | (setq words-include-escapes t) | |
e4cfb70d KH |
598 | (make-local-variable 'imenu-generic-expression) |
599 | (setq imenu-generic-expression texinfo-imenu-generic-expression) | |
c0b08eb0 | 600 | (setq imenu-case-fold-search nil) |
2ab3bf87 | 601 | (make-local-variable 'font-lock-defaults) |
e3721db1 | 602 | (setq font-lock-defaults |
48bb9196 | 603 | '(texinfo-font-lock-keywords nil nil nil backward-paragraph |
e3721db1 SM |
604 | (font-lock-syntactic-keywords |
605 | . texinfo-font-lock-syntactic-keywords))) | |
606 | (set (make-local-variable 'parse-sexp-lookup-properties) t) | |
f412245b SM |
607 | |
608 | ;; Outline settings. | |
609 | (set (make-local-variable 'outline-heading-alist) | |
610 | ;; We should merge outline-heading-alist and texinfo-section-list | |
611 | ;; but in the mean time, let's just generate one from the other. | |
612 | (mapcar (lambda (x) (cons (concat "@" (car x)) (cadr x))) | |
613 | texinfo-section-list)) | |
614 | (set (make-local-variable 'outline-regexp) | |
4ae1fdf6 | 615 | (concat (regexp-opt (mapcar 'car outline-heading-alist) t) |
f412245b SM |
616 | "\\>")) |
617 | ||
d78fc315 | 618 | (make-local-variable 'tex-start-of-header) |
24e519d8 | 619 | (setq tex-start-of-header "%\\*\\*start") |
d78fc315 | 620 | (make-local-variable 'tex-end-of-header) |
24e519d8 RS |
621 | (setq tex-end-of-header "%\\*\\*end") |
622 | (make-local-variable 'tex-first-line-header-regexp) | |
623 | (setq tex-first-line-header-regexp "^\\\\input") | |
624 | (make-local-variable 'tex-trailer) | |
8bd88d54 GM |
625 | (setq tex-trailer "@bye\n") |
626 | ||
627 | ;; Prevent filling certain lines, in addition to ones specified | |
628 | ;; by the user. | |
629 | (let ((prevent-filling "^@\\(def\\|multitable\\)")) | |
a11609d8 SM |
630 | (set (make-local-variable 'auto-fill-inhibit-regexp) |
631 | (if (null auto-fill-inhibit-regexp) | |
632 | prevent-filling | |
8fe6d67f | 633 | (concat auto-fill-inhibit-regexp "\\|" prevent-filling))))) |
db95369b | 634 | |
952d72ff RC |
635 | |
636 | \f | |
c6cc04e9 RS |
637 | ;;; Insert string commands |
638 | ||
d7fa3319 SM |
639 | (defvar texinfo-block-default "example") |
640 | ||
e3721db1 SM |
641 | (define-skeleton texinfo-insert-block |
642 | "Create a matching pair @<cmd> .. @end <cmd> at point. | |
643 | Puts point on a blank line between them." | |
d7fa3319 SM |
644 | (setq texinfo-block-default |
645 | (completing-read (format "Block name [%s]: " texinfo-block-default) | |
f412245b | 646 | texinfo-environments |
d7fa3319 | 647 | nil nil nil nil texinfo-block-default)) |
8fe6d67f | 648 | \n "@" str \n _ \n "@end " str \n) |
e3721db1 | 649 | |
eedd2812 SM |
650 | (defun texinfo-inside-macro-p (macro &optional bound) |
651 | "Non-nil if inside a macro matching the regexp MACRO." | |
08f9e254 DL |
652 | (condition-case nil |
653 | (save-excursion | |
654 | (save-restriction | |
655 | (narrow-to-region bound (point)) | |
656 | (while (progn | |
657 | (up-list -1) | |
658 | (not (condition-case nil | |
659 | (save-excursion | |
660 | (backward-sexp 1) | |
661 | (looking-at macro)) | |
a11609d8 | 662 | (scan-error nil))))) |
08f9e254 | 663 | t)) |
a11609d8 | 664 | (scan-error nil))) |
eedd2812 SM |
665 | |
666 | (defun texinfo-inside-env-p (env &optional bound) | |
667 | "Non-nil if inside an environment matching the regexp @ENV." | |
668 | (save-excursion | |
669 | (and (re-search-backward (concat "@\\(end\\s +\\)?" env) bound t) | |
a11609d8 | 670 | (not (match-end 1))))) |
eedd2812 | 671 | |
ffa5b3a3 | 672 | (defvar texinfo-enable-quote-macros "@\\(code\\|samp\\|kbd\\)\\>") |
f412245b | 673 | (defvar texinfo-enable-quote-envs '("example\\>" "lisp\\>")) |
eedd2812 | 674 | (defun texinfo-insert-quote (&optional arg) |
887a2f77 | 675 | "Insert the appropriate quote mark for Texinfo. |
9768eaa7 EZ |
676 | Usually inserts the value of `texinfo-open-quote' (normally ``) or |
677 | `texinfo-close-quote' (normally ''), depending on the context. | |
678 | With prefix argument or inside @code or @example, inserts a plain \"." | |
eedd2812 SM |
679 | (interactive "*P") |
680 | (let ((top (or (save-excursion (re-search-backward "@node\\>" nil t)) | |
681 | (point-min)))) | |
9768eaa7 | 682 | (if (or arg |
8fe6d67f SM |
683 | (= (preceding-char) ?\\) |
684 | (save-excursion | |
78151cd5 GM |
685 | ;; Might be near the start of a (narrowed) buffer. |
686 | (ignore-errors (backward-char (length texinfo-open-quote))) | |
8fe6d67f SM |
687 | (when (or (looking-at texinfo-open-quote) |
688 | (looking-at texinfo-close-quote)) | |
689 | (delete-char (length texinfo-open-quote)) | |
690 | t)) | |
f412245b SM |
691 | (texinfo-inside-macro-p texinfo-enable-quote-macros top) |
692 | (let ((in-env nil)) | |
693 | (dolist (env texinfo-enable-quote-envs in-env) | |
694 | (if (texinfo-inside-env-p env top) | |
695 | (setq in-env t))))) | |
eedd2812 | 696 | (self-insert-command (prefix-numeric-value arg)) |
9768eaa7 | 697 | (insert |
083654ee GM |
698 | (if (or (bobp) |
699 | (memq (char-syntax (preceding-char)) '(?\( ?> ?\s))) | |
8fe6d67f SM |
700 | texinfo-open-quote |
701 | texinfo-close-quote))))) | |
db95369b | 702 | |
5ccb13ff RS |
703 | ;; The following texinfo-insert-@end command not only inserts a SPC |
704 | ;; after the @end, but tries to find out what belongs there. It is | |
705 | ;; not very smart: it does not understand nested lists. | |
c6cc04e9 | 706 | |
8fe6d67f SM |
707 | (defun texinfo-last-unended-begin () |
708 | (while (and (re-search-backward texinfo-environment-regexp) | |
709 | (looking-at "@end")) | |
710 | (texinfo-last-unended-begin))) | |
711 | ||
712 | (defun texinfo-next-unmatched-end () | |
713 | (while (and (re-search-forward texinfo-environment-regexp) | |
714 | (save-excursion | |
715 | (goto-char (match-beginning 0)) | |
716 | (not (looking-at "@end")))) | |
717 | (texinfo-next-unmatched-end))) | |
718 | ||
c6cc04e9 RS |
719 | (defun texinfo-insert-@end () |
720 | "Insert the matching `@end' for the last Texinfo command that needs one." | |
721 | (interactive) | |
8fe6d67f SM |
722 | (let ((string |
723 | (ignore-errors | |
724 | (save-excursion | |
725 | (texinfo-last-unended-begin) | |
726 | (match-string 1))))) | |
62993ed6 EZ |
727 | (insert "@end ") |
728 | (if string (insert string "\n")))) | |
c6cc04e9 RS |
729 | |
730 | ;; The following insert commands accept a prefix arg N, which is the | |
731 | ;; number of words (actually s-exprs) that should be surrounded by | |
732 | ;; braces. Thus you can first paste a variable name into a .texinfo | |
733 | ;; buffer, then say C-u 1 C-c C-c v at the beginning of the just | |
734 | ;; pasted variable name to put @var{...} *around* the variable name. | |
735 | ;; Operate on previous word or words with negative arg. | |
736 | ||
737 | ;; These commands use texinfo-insert-@-with-arg | |
738 | (defun texinfo-insert-@-with-arg (string &optional arg) | |
5ccb13ff | 739 | (if arg |
c6cc04e9 RS |
740 | (progn |
741 | (setq arg (prefix-numeric-value arg)) | |
742 | (if (< arg 0) | |
743 | (progn | |
744 | (skip-chars-backward " \t\n\r\f") | |
745 | (save-excursion | |
746 | (forward-sexp arg) | |
747 | (insert "@" string "{")) | |
748 | (insert "}")) | |
749 | (skip-chars-forward " \t\n\r\f") | |
750 | (insert "@" string "{") | |
751 | (forward-sexp arg) | |
752 | (insert "}"))) | |
753 | (insert "@" string "{}") | |
754 | (backward-char))) | |
755 | ||
756 | (defun texinfo-insert-braces () | |
757 | "Make a pair of braces and be poised to type inside of them. | |
758 | Use \\[up-list] to move forward out of the braces." | |
759 | (interactive) | |
760 | (insert "{}") | |
761 | (backward-char)) | |
762 | ||
763 | (defun texinfo-insert-@code (&optional arg) | |
764 | "Insert a `@code{...}' command in a Texinfo buffer. | |
765 | A numeric argument says how many words the braces should surround. | |
766 | The default is not to surround any existing words with the braces." | |
767 | (interactive "P") | |
768 | (texinfo-insert-@-with-arg "code" arg)) | |
769 | ||
770 | (defun texinfo-insert-@dfn (&optional arg) | |
771 | "Insert a `@dfn{...}' command in a Texinfo buffer. | |
772 | A numeric argument says how many words the braces should surround. | |
773 | The default is not to surround any existing words with the braces." | |
774 | (interactive "P") | |
775 | (texinfo-insert-@-with-arg "dfn" arg)) | |
952d72ff | 776 | |
af9eaa5e GM |
777 | (defun texinfo-insert-@email (&optional arg) |
778 | "Insert a `@email{...}' command in a Texinfo buffer. | |
779 | A numeric argument says how many words the braces should surround. | |
780 | The default is not to surround any existing words with the braces." | |
781 | (interactive "P") | |
782 | (texinfo-insert-@-with-arg "email" arg)) | |
783 | ||
784 | (defun texinfo-insert-@emph (&optional arg) | |
785 | "Insert a `@emph{...}' command in a Texinfo buffer. | |
786 | A numeric argument says how many words the braces should surround. | |
787 | The default is not to surround any existing words with the braces." | |
788 | (interactive "P") | |
789 | (texinfo-insert-@-with-arg "emph" arg)) | |
790 | ||
c6cc04e9 RS |
791 | (defun texinfo-insert-@example () |
792 | "Insert the string `@example' in a Texinfo buffer." | |
793 | (interactive) | |
794 | (insert "@example\n")) | |
795 | ||
796 | (defun texinfo-insert-@file (&optional arg) | |
797 | "Insert a `@file{...}' command in a Texinfo buffer. | |
798 | A numeric argument says how many words the braces should surround. | |
799 | The default is not to surround any existing words with the braces." | |
800 | (interactive "P") | |
801 | (texinfo-insert-@-with-arg "file" arg)) | |
802 | ||
803 | (defun texinfo-insert-@item () | |
235de372 EZ |
804 | "Insert the string `@item' in a Texinfo buffer. |
805 | If in a table defined by @table, follow said string with a space. | |
806 | Otherwise, follow with a newline." | |
c6cc04e9 | 807 | (interactive) |
235de372 EZ |
808 | (insert "@item" |
809 | (if (equal (ignore-errors | |
810 | (save-excursion | |
811 | (texinfo-last-unended-begin) | |
812 | (match-string 1))) | |
813 | "table") | |
16f43910 | 814 | ?\s |
235de372 | 815 | ?\n))) |
c6cc04e9 RS |
816 | |
817 | (defun texinfo-insert-@kbd (&optional arg) | |
818 | "Insert a `@kbd{...}' 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." | |
821 | (interactive "P") | |
822 | (texinfo-insert-@-with-arg "kbd" arg)) | |
823 | ||
824 | (defun texinfo-insert-@node () | |
825 | "Insert the string `@node' in a Texinfo buffer. | |
481b0db7 RC |
826 | Insert a comment on the following line indicating the order of |
827 | arguments to @node. Insert a carriage return after the comment line. | |
828 | Leave point after `@node'." | |
c6cc04e9 | 829 | (interactive) |
481b0db7 RC |
830 | (insert "@node \n@comment node-name, next, previous, up\n") |
831 | (forward-line -2) | |
c6cc04e9 RS |
832 | (forward-char 6)) |
833 | ||
834 | (defun texinfo-insert-@noindent () | |
835 | "Insert the string `@noindent' in a Texinfo buffer." | |
836 | (interactive) | |
837 | (insert "@noindent\n")) | |
838 | ||
af9eaa5e GM |
839 | (defun texinfo-insert-@quotation () |
840 | "Insert the string `@quotation' in a Texinfo buffer." | |
841 | (interactive) | |
842 | (insert "@quotation\n")) | |
843 | ||
c6cc04e9 RS |
844 | (defun texinfo-insert-@samp (&optional arg) |
845 | "Insert a `@samp{...}' command in a Texinfo buffer. | |
846 | A numeric argument says how many words the braces should surround. | |
847 | The default is not to surround any existing words with the braces." | |
848 | (interactive "P") | |
849 | (texinfo-insert-@-with-arg "samp" arg)) | |
850 | ||
af9eaa5e GM |
851 | (defun texinfo-insert-@strong (&optional arg) |
852 | "Insert a `@strong{...}' command in a Texinfo buffer. | |
853 | A numeric argument says how many words the braces should surround. | |
854 | The default is not to surround any existing words with the braces." | |
855 | (interactive "P") | |
856 | (texinfo-insert-@-with-arg "strong" arg)) | |
857 | ||
ffa5b3a3 | 858 | (defun texinfo-insert-@table () |
c6cc04e9 | 859 | "Insert the string `@table' in a Texinfo buffer." |
ffa5b3a3 | 860 | (interactive) |
c6cc04e9 RS |
861 | (insert "@table ")) |
862 | ||
863 | (defun texinfo-insert-@var (&optional arg) | |
864 | "Insert a `@var{}' command in a Texinfo buffer. | |
865 | A numeric argument says how many words the braces should surround. | |
866 | The default is not to surround any existing words with the braces." | |
867 | (interactive "P") | |
868 | (texinfo-insert-@-with-arg "var" arg)) | |
af9eaa5e | 869 | |
4fb0a34c | 870 | (defun texinfo-insert-@uref (&optional arg) |
08f9e254 | 871 | "Insert a `@uref{}' command in a Texinfo buffer. |
af9eaa5e GM |
872 | A numeric argument says how many words the braces should surround. |
873 | The default is not to surround any existing words with the braces." | |
874 | (interactive "P") | |
4fb0a34c EZ |
875 | (texinfo-insert-@-with-arg "uref" arg)) |
876 | (defalias 'texinfo-insert-@url 'texinfo-insert-@uref) | |
c6cc04e9 RS |
877 | \f |
878 | ;;; Texinfo file structure | |
952d72ff | 879 | |
5ccb13ff | 880 | (defun texinfo-show-structure (&optional nodes-too) |
952d72ff | 881 | "Show the structure of a Texinfo file. |
d5aa8b02 RC |
882 | List the lines in the file that begin with the @-sign commands for |
883 | @chapter, @section, and the like. | |
884 | ||
885 | With optional argument (prefix if interactive), list both the lines | |
886 | with @-sign commands for @chapter, @section, and the like, and list | |
887 | @node lines. | |
952d72ff RC |
888 | |
889 | Lines with structuring commands beginning in them are displayed in | |
c6cc04e9 | 890 | another buffer named `*Occur*'. In that buffer, you can move point to |
db95369b | 891 | one of those lines and then use |
aae61ef3 | 892 | \\<occur-mode-map>\\[occur-mode-goto-occurrence], |
c6cc04e9 | 893 | to jump to the corresponding spot in the Texinfo source file." |
952d72ff RC |
894 | |
895 | (interactive "P") | |
aae61ef3 | 896 | ;; First, remember current location |
ffa5b3a3 | 897 | (let (current-location) |
aae61ef3 RC |
898 | (save-excursion |
899 | (end-of-line) ; so as to find section on current line | |
db95369b | 900 | (if (re-search-backward |
aae61ef3 RC |
901 | ;; do not require `texinfo-section-types-regexp' in texnfo-upd.el |
902 | "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)" | |
903 | nil t) | |
904 | (setq current-location | |
905 | (progn | |
906 | (beginning-of-line) | |
907 | (buffer-substring (point) (progn (end-of-line) (point))))) | |
ffa5b3a3 | 908 | ;; else point is located before any section command. |
aae61ef3 RC |
909 | (setq current-location "tex"))) |
910 | ;; Second, create and format an *Occur* buffer | |
911 | (save-excursion | |
912 | (goto-char (point-min)) | |
4ae1fdf6 SM |
913 | (occur (concat "^\\(?:" (if nodes-too "@node\\>\\|") |
914 | outline-regexp "\\)"))) | |
aae61ef3 | 915 | (pop-to-buffer "*Occur*") |
952d72ff | 916 | (goto-char (point-min)) |
aae61ef3 RC |
917 | (let ((inhibit-read-only t)) |
918 | (flush-lines "-----") | |
919 | ;; Now format the "*Occur*" buffer to show the structure. | |
920 | ;; Thanks to ceder@signum.se (Per Cederqvist) | |
921 | (goto-char (point-max)) | |
922 | (let (level) | |
923 | (while (re-search-backward "^ *[0-9]*:@\\(\\sw+\\)" nil 0) | |
924 | (goto-char (1- (match-beginning 1))) | |
925 | (setq level | |
926 | (or (cadr (assoc (match-string 1) texinfo-section-list)) 2)) | |
927 | (indent-to-column (+ (current-column) (* 4 (- level 2)))) | |
928 | (beginning-of-line)))) | |
929 | ;; Third, go to line corresponding to location in source file | |
db95369b | 930 | ;; potential bug: two exactly similar `current-location' lines ... |
aae61ef3 RC |
931 | (goto-char (point-min)) |
932 | (re-search-forward current-location nil t) | |
933 | (beginning-of-line) | |
934 | )) | |
935 | ||
952d72ff RC |
936 | \f |
937 | ;;; The tex and print function definitions: | |
938 | ||
cd482e05 | 939 | (defcustom texinfo-texi2dvi-command "texi2dvi" |
2db33a18 | 940 | "Command used by `texinfo-tex-buffer' to run TeX and texindex on a buffer." |
cd482e05 RS |
941 | :type 'string |
942 | :group 'texinfo) | |
bb946175 | 943 | |
cd482e05 | 944 | (defcustom texinfo-tex-command "tex" |
2db33a18 | 945 | "Command used by `texinfo-tex-region' to run TeX on a region." |
cd482e05 RS |
946 | :type 'string |
947 | :group 'texinfo) | |
952d72ff | 948 | |
cd482e05 | 949 | (defcustom texinfo-texindex-command "texindex" |
2db33a18 | 950 | "Command used by `texinfo-texindex' to sort unsorted index files." |
cd482e05 RS |
951 | :type 'string |
952 | :group 'texinfo) | |
c6cc04e9 | 953 | |
cd482e05 | 954 | (defcustom texinfo-delete-from-print-queue-command "lprm" |
2db33a18 | 955 | "Command string used to delete a job from the line printer queue. |
c6cc04e9 RS |
956 | Command is used by \\[texinfo-delete-from-print-queue] based on |
957 | number provided by a previous \\[tex-show-print-queue] | |
cd482e05 RS |
958 | command." |
959 | :type 'string | |
960 | :group 'texinfo) | |
c6cc04e9 RS |
961 | |
962 | (defvar texinfo-tex-trailer "@bye" | |
963 | "String appended after a region sent to TeX by `texinfo-tex-region'.") | |
952d72ff RC |
964 | |
965 | (defun texinfo-tex-region (beg end) | |
c6cc04e9 RS |
966 | "Run TeX on the current region. |
967 | This works by writing a temporary file (`tex-zap-file') in the directory | |
968 | that is the value of `tex-directory', then running TeX on that file. | |
969 | ||
970 | The first line of the buffer is copied to the | |
1433a222 CZ |
971 | temporary file; and if the buffer has a header, it is written to the |
972 | temporary file before the region itself. The buffer's header is all lines | |
973 | between the strings defined by `tex-start-of-header' and `tex-end-of-header' | |
c6cc04e9 RS |
974 | inclusive. The header must start in the first 100 lines. |
975 | ||
976 | The value of `texinfo-tex-trailer' is appended to the temporary file after the region." | |
952d72ff | 977 | (interactive "r") |
e67adf46 | 978 | (require 'tex-mode) |
24e519d8 | 979 | (let ((tex-command texinfo-tex-command) |
3654a351 | 980 | (tex-trailer texinfo-tex-trailer)) |
24e519d8 | 981 | (tex-region beg end))) |
952d72ff RC |
982 | |
983 | (defun texinfo-tex-buffer () | |
c6cc04e9 RS |
984 | "Run TeX on visited file, once or twice, to make a correct `.dvi' file." |
985 | (interactive) | |
97c6c316 | 986 | (require 'tex-mode) |
3654a351 AS |
987 | (let ((tex-command texinfo-texi2dvi-command) |
988 | ;; Disable tex-start-options-string. texi2dvi would not | |
989 | ;; understand anything specified here. | |
990 | (tex-start-options-string "")) | |
24e519d8 | 991 | (tex-buffer))) |
c6cc04e9 RS |
992 | |
993 | (defun texinfo-texindex () | |
994 | "Run `texindex' on unsorted index files. | |
995 | The index files are made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer]. | |
996 | This runs the shell command defined by `texinfo-texindex-command'." | |
952d72ff | 997 | (interactive) |
c6cc04e9 | 998 | (require 'tex-mode) |
79183f1a | 999 | (tex-send-command texinfo-texindex-command (concat tex-zap-file ".??")) |
5ccb13ff RS |
1000 | ;; alternatively |
1001 | ;; (send-string "tex-shell" | |
1002 | ;; (concat texinfo-texindex-command | |
1003 | ;; " " tex-zap-file ".??" "\n")) | |
c6cc04e9 | 1004 | (tex-recenter-output-buffer nil)) |
952d72ff RC |
1005 | |
1006 | (defun texinfo-tex-print () | |
c6cc04e9 RS |
1007 | "Print `.dvi' file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer]. |
1008 | This runs the shell command defined by `tex-dvi-print-command'." | |
952d72ff | 1009 | (interactive) |
e67adf46 | 1010 | (require 'tex-mode) |
24e519d8 RS |
1011 | (tex-print)) |
1012 | ||
1013 | (defun texinfo-tex-view () | |
1014 | "View `.dvi' file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer]. | |
1015 | This runs the shell command defined by `tex-dvi-view-command'." | |
1016 | (interactive) | |
1017 | (require 'tex-mode) | |
1018 | (tex-view)) | |
952d72ff | 1019 | |
c6cc04e9 RS |
1020 | (defun texinfo-quit-job () |
1021 | "Quit currently running TeX job, by sending an `x' to it." | |
1022 | (interactive) | |
1023 | (if (not (get-process "tex-shell")) | |
1024 | (error "No TeX shell running")) | |
79183f1a | 1025 | (tex-send-command "x")) |
5ccb13ff RS |
1026 | ;; alternatively: |
1027 | ;; save-excursion | |
1028 | ;; (set-buffer (get-buffer "*tex-shell*")) | |
1029 | ;; (goto-char (point-max)) | |
1030 | ;; (insert "x") | |
1031 | ;; (comint-send-input) | |
c6cc04e9 RS |
1032 | |
1033 | (defun texinfo-delete-from-print-queue (job-number) | |
1034 | "Delete job from the line printer spooling queue. | |
1035 | You are prompted for the job number (use a number shown by a previous | |
5ccb13ff | 1036 | \\[tex-show-print-queue] command)." |
c6cc04e9 | 1037 | (interactive "nPrinter job number for deletion: ") |
97c6c316 | 1038 | (require 'tex-mode) |
c6cc04e9 RS |
1039 | (if (tex-shell-running) |
1040 | (tex-kill-job) | |
1041 | (tex-start-shell)) | |
79183f1a | 1042 | (tex-send-command texinfo-delete-from-print-queue-command job-number) |
5ccb13ff RS |
1043 | ;; alternatively |
1044 | ;; (send-string "tex-shell" | |
1045 | ;; (concat | |
1046 | ;; texinfo-delete-from-print-queue-command | |
1047 | ;; " " | |
1048 | ;; job-number"\n")) | |
c6cc04e9 RS |
1049 | (tex-recenter-output-buffer nil)) |
1050 | ||
49116ac0 JB |
1051 | (provide 'texinfo) |
1052 | ||
bc6785f3 | 1053 | ;; arch-tag: 005d7c38-43b9-4b7d-aa1d-aea69bae73e1 |
d501f516 | 1054 | ;;; texinfo.el ends here |