Commit | Line | Data |
---|---|---|
e739cc85 | 1 | ;;; texinfo.el --- major mode for editing Texinfo files -*- coding: utf-8 -*- |
be010748 | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 1985, 1988-1993, 1996-1997, 2000-2011 |
49c539a1 | 4 | ;; Free Software Foundation, Inc. |
e926e412 | 5 | |
5ccb13ff | 6 | ;; Author: Robert J. Chassell |
07e77e36 | 7 | ;; Date: [See date below for texinfo-version] |
630dd250 | 8 | ;; Maintainer: FSF |
5ccb13ff | 9 | ;; Keywords: maint, tex, docs |
eea8d4ef | 10 | |
be010748 | 11 | ;; This file is part of GNU Emacs. |
952d72ff | 12 | |
1fecc8fe | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
952d72ff | 14 | ;; it under the terms of the GNU General Public License as published by |
1fecc8fe GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
952d72ff RC |
17 | |
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. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
1fecc8fe | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
952d72ff | 25 | |
8fe6d67f SM |
26 | ;;; Todo: |
27 | ||
28 | ;; - facemenu support. | |
76b7c637 | 29 | ;; - command completion. |
8fe6d67f | 30 | |
e8af40ee PJ |
31 | ;;; Commentary: |
32 | ||
5ccb13ff RS |
33 | ;;; Code: |
34 | ||
a11609d8 | 35 | (eval-when-compile (require 'tex-mode) (require 'cl)) |
366fb0ab | 36 | (defvar outline-heading-alist) |
08f9e254 | 37 | |
cd482e05 | 38 | (defgroup texinfo nil |
dbc868a1 | 39 | "Texinfo Mode." |
8ec3bce0 | 40 | :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces) |
cd482e05 RS |
41 | :group 'docs) |
42 | ||
9768eaa7 | 43 | ;;;###autoload |
aaa448c9 | 44 | (defcustom texinfo-open-quote (purecopy "``") |
2db33a18 | 45 | "String inserted by typing \\[texinfo-insert-quote] to open a quotation." |
9768eaa7 EZ |
46 | :type 'string |
47 | :group 'texinfo) | |
48 | ||
49 | ;;;###autoload | |
aaa448c9 | 50 | (defcustom texinfo-close-quote (purecopy "''") |
2db33a18 | 51 | "String inserted by typing \\[texinfo-insert-quote] to close a quotation." |
9768eaa7 EZ |
52 | :type 'string |
53 | :group 'texinfo) | |
54 | ||
630dd250 SJ |
55 | (defcustom texinfo-mode-hook nil |
56 | "Normal hook run when entering Texinfo mode." | |
57 | :type 'hook | |
58 | :options '(turn-on-auto-fill flyspell-mode) | |
59 | :group 'texinfo) | |
60 | ||
c6cc04e9 RS |
61 | \f |
62 | ;;; Autoloads: | |
63 | ||
64 | (autoload 'makeinfo-region | |
5ccb13ff | 65 | "makeinfo" |
c6cc04e9 RS |
66 | "Make Info file from region of current Texinfo file, and switch to it. |
67 | ||
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'." | |
5ccb13ff | 71 | t nil) |
c6cc04e9 RS |
72 | |
73 | (autoload 'makeinfo-buffer | |
5ccb13ff | 74 | "makeinfo" |
c6cc04e9 RS |
75 | "Make Info file from current buffer. |
76 | ||
5ccb13ff | 77 | Use the \\[next-error] command to move to the next error |
c6cc04e9 | 78 | \(if there are errors\)." |
5ccb13ff | 79 | t nil) |
c6cc04e9 RS |
80 | |
81 | (autoload 'kill-compilation | |
5ccb13ff | 82 | "compile" |
c6cc04e9 | 83 | "Kill the process made by the \\[compile] command." |
5ccb13ff | 84 | t nil) |
c6cc04e9 RS |
85 | |
86 | (autoload 'makeinfo-recenter-compilation-buffer | |
5ccb13ff | 87 | "makeinfo" |
c6cc04e9 RS |
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." | |
5ccb13ff RS |
91 | t nil) |
92 | ||
93 | (autoload 'texinfo-update-node | |
94 | "texnfo-upd" | |
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 | |
97 | marked region. | |
98 | ||
99 | The functions for creating or updating nodes and menus, and their | |
100 | keybindings, are: | |
101 | ||
08f9e254 DL |
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) | |
5ccb13ff | 105 | |
08f9e254 DL |
106 | `texinfo-make-menu' (&optional region-p) \\[texinfo-make-menu] |
107 | `texinfo-all-menus-update' () \\[texinfo-all-menus-update] | |
108 | `texinfo-master-menu' () | |
5ccb13ff | 109 | |
08f9e254 | 110 | `texinfo-indent-menu-description' (column &optional region-p) |
5ccb13ff RS |
111 | |
112 | The `texinfo-column-for-description' variable specifies the column to | |
113 | which menu descriptions are indented. Its default value is 32." | |
114 | t nil) | |
115 | ||
116 | (autoload 'texinfo-every-node-update | |
117 | "texnfo-upd" | |
118 | "Update every node in a Texinfo file." | |
119 | t nil) | |
120 | ||
121 | (autoload 'texinfo-sequential-node-update | |
122 | "texnfo-upd" | |
123 | "Update one node (or many) in a Texinfo file with sequential pointers. | |
124 | ||
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. | |
129 | ||
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 | |
132 | marked region. | |
133 | ||
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." | |
138 | t nil) | |
c6cc04e9 RS |
139 | |
140 | (autoload 'texinfo-make-menu | |
5ccb13ff | 141 | "texnfo-upd" |
c6cc04e9 RS |
142 | "Without any prefix argument, make or update a menu. |
143 | Make the menu for the section enclosing the node found following point. | |
144 | ||
145 | Non-nil argument (prefix, if interactive) means make or update menus | |
146 | for nodes within or part of the marked region. | |
147 | ||
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." | |
5ccb13ff | 152 | t nil) |
c6cc04e9 RS |
153 | |
154 | (autoload 'texinfo-all-menus-update | |
5ccb13ff | 155 | "texnfo-upd" |
c6cc04e9 RS |
156 | "Update every regular menu in a Texinfo file. |
157 | Remove pre-existing master menu, if there is one. | |
158 | ||
159 | If called with a non-nil argument, this function first updates all the | |
160 | nodes in the buffer before updating the menus." | |
5ccb13ff | 161 | t nil) |
c6cc04e9 RS |
162 | |
163 | (autoload 'texinfo-master-menu | |
5ccb13ff | 164 | "texnfo-upd" |
c6cc04e9 RS |
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. | |
168 | ||
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. | |
172 | ||
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. | |
176 | ||
177 | The function removes the detailed part of an already existing master | |
9687a051 | 178 | menu. This action depends on the pre-existing master menu using the |
c6cc04e9 RS |
179 | standard `texinfo-master-menu-header'. |
180 | ||
181 | The master menu has the following format, which is adapted from the | |
182 | recommendation in the Texinfo Manual: | |
183 | ||
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. | |
188 | ||
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. | |
193 | ||
194 | Each of the menus in the detailed node listing is introduced by the | |
195 | title of the section containing the menu." | |
5ccb13ff | 196 | t nil) |
c6cc04e9 RS |
197 | |
198 | (autoload 'texinfo-indent-menu-description | |
5ccb13ff RS |
199 | "texnfo-upd" |
200 | "Indent every description in menu following point to COLUMN. | |
c6cc04e9 RS |
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." | |
5ccb13ff | 204 | t nil) |
c6cc04e9 RS |
205 | |
206 | (autoload 'texinfo-insert-node-lines | |
5ccb13ff | 207 | "texnfo-upd" |
c6cc04e9 RS |
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." | |
5ccb13ff | 212 | t nil) |
c6cc04e9 RS |
213 | |
214 | (autoload 'texinfo-start-menu-description | |
5ccb13ff RS |
215 | "texnfo-upd" |
216 | "In this menu entry, insert the node's section title as a description. | |
c6cc04e9 RS |
217 | Position point at beginning of description ready for editing. |
218 | Do not insert a title if the line contains an existing description. | |
219 | ||
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." | |
5ccb13ff | 222 | t nil) |
c6cc04e9 RS |
223 | |
224 | (autoload 'texinfo-multiple-files-update | |
5ccb13ff | 225 | "texnfo-upd" |
c6cc04e9 | 226 | "Update first node pointers in each file included in OUTER-FILE; |
5ccb13ff | 227 | create or update main menu in the outer file that refers to such nodes. |
c6cc04e9 RS |
228 | This does not create or update menus or pointers within the included files. |
229 | ||
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. | |
233 | ||
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. | |
238 | ||
239 | The command also updates the `Top' level node pointers of OUTER-FILE. | |
240 | ||
5ccb13ff | 241 | Notes: |
c6cc04e9 RS |
242 | |
243 | * this command does NOT save any files--you must save the | |
244 | outer file and any modified, included files. | |
245 | ||
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. | |
249 | ||
250 | Requirements: | |
251 | ||
252 | * each of the included files must contain exactly one highest | |
5ccb13ff | 253 | hierarchical level node, |
c6cc04e9 RS |
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. | |
256 | ||
257 | Thus, normally, each included file contains one, and only one, | |
258 | chapter." | |
5ccb13ff | 259 | t nil) |
c6cc04e9 RS |
260 | |
261 | \f | |
e5167999 ER |
262 | ;;; Code: |
263 | ||
c678a343 | 264 | ;;; Don't you dare insert any `require' calls at top level in this file--rms. |
e67adf46 | 265 | |
eedd2812 SM |
266 | (defvar texinfo-section-list |
267 | '(("top" 1) | |
eedd2812 | 268 | ("chapter" 2) |
eedd2812 | 269 | ("section" 3) |
eedd2812 | 270 | ("subsection" 4) |
eedd2812 | 271 | ("subsubsection" 5) |
f412245b SM |
272 | ("unnumbered" 2) |
273 | ("unnumberedsec" 3) | |
274 | ("unnumberedsubsec" 4) | |
eedd2812 | 275 | ("unnumberedsubsubsec" 5) |
f412245b SM |
276 | ("appendix" 2) |
277 | ("appendixsec" 3) | |
76b7c637 | 278 | ("appendixsection" 3) |
f412245b | 279 | ("appendixsubsec" 4) |
eedd2812 | 280 | ("appendixsubsubsec" 5) |
f412245b SM |
281 | ("majorheading" 2) |
282 | ("chapheading" 2) | |
283 | ("heading" 3) | |
284 | ("subheading" 4) | |
eedd2812 SM |
285 | ("subsubheading" 5)) |
286 | "Alist of sectioning commands and their relative level.") | |
287 | ||
c6cc04e9 | 288 | ;;; Syntax table |
1de2ada0 | 289 | |
2db33a18 SM |
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) | |
302 | st)) | |
952d72ff | 303 | |
e4cfb70d | 304 | ;; Written by Wolfgang Bangerth <zcg51122@rpool1.rus.uni-stuttgart.de> |
9687a051 | 305 | ;; To override this example, set either `imenu-generic-expression' |
e4cfb70d KH |
306 | ;; or `imenu-create-index-function'. |
307 | (defvar texinfo-imenu-generic-expression | |
08f9e254 | 308 | '((nil "^@\\(node\\|anchor\\)[ \t]+\\([^,\n]*\\)" 2) |
e4cfb70d | 309 | ("Chapters" "^@chapter[ \t]+\\(.*\\)$" 1)) |
887a2f77 | 310 | "Imenu generic expression for Texinfo mode. See `imenu-generic-expression'.") |
e4cfb70d | 311 | |
cf38dd42 SM |
312 | (defconst texinfo-syntax-propertize-function |
313 | (syntax-propertize-rules | |
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) | |
61f91c04 | 445 | ;; FIXME: This is often used for "close block" aka texinfo-insert-@end. |
2db33a18 | 446 | (define-key map "\C-c]" 'up-list) |
61f91c04 | 447 | (define-key map "\C-c/" 'texinfo-insert-@end) |
2db33a18 SM |
448 | (define-key map "\C-c{" 'texinfo-insert-braces) |
449 | ||
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) | |
455 | ||
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) | |
471 | map)) | |
952d72ff | 472 | |
eedd2812 SM |
473 | (easy-menu-define texinfo-mode-menu |
474 | texinfo-mode-map | |
475 | "Menu used for `texinfo-mode'." | |
476 | '("Texinfo" | |
477 | ["Insert block" texinfo-insert-block t] | |
478 | ;; ["Insert node" texinfo-insert-@node t] | |
479 | "----" | |
003dd635 SM |
480 | ["Update All" (lambda () (interactive) (texinfo-master-menu t)) |
481 | :keys "\\[universal-argument] \\[texinfo-master-menu]"] | |
eedd2812 SM |
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] | |
487 | "----" | |
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])) | |
493 | ||
c6cc04e9 | 494 | \f |
a11609d8 SM |
495 | (defun texinfo-filter (section list) |
496 | (let (res) | |
497 | (dolist (x list) (if (eq section (cadr x)) (push (car x) res))) | |
498 | res)) | |
499 | ||
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.") | |
503 | ||
c6cc04e9 | 504 | ;;; Texinfo mode |
952d72ff | 505 | |
f9f9507e | 506 | ;;;###autoload |
e3721db1 | 507 | (define-derived-mode texinfo-mode text-mode "Texinfo" |
d5aa8b02 | 508 | "Major mode for editing Texinfo files. |
952d72ff RC |
509 | |
510 | It has these extra commands: | |
511 | \\{texinfo-mode-map} | |
512 | ||
d5aa8b02 | 513 | These are files that are used as input for TeX to make printed manuals |
c6cc04e9 RS |
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 | |
d5aa8b02 | 516 | modified version of TeX input format. |
952d72ff RC |
517 | |
518 | Editing commands are like text-mode except that the syntax table is | |
d5aa8b02 RC |
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, | |
c6cc04e9 | 521 | use \\[makeinfo-region], which runs `makeinfo' on the current region. |
952d72ff | 522 | |
d5aa8b02 RC |
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 | |
529 | in the Texinfo file. | |
952d72ff | 530 | |
d5aa8b02 | 531 | In addition, Texinfo mode provides commands that insert various |
952d72ff RC |
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. | |
536 | ||
d5aa8b02 | 537 | Also, Texinfo mode provides functions for automatically creating or |
952d72ff RC |
538 | updating menus and node pointers. These functions |
539 | ||
540 | * insert the `Next', `Previous' and `Up' pointers of a node, | |
541 | * insert or update the menu for a section, and | |
d5aa8b02 | 542 | * create a master menu for a Texinfo source file. |
952d72ff RC |
543 | |
544 | Here are the functions: | |
545 | ||
546 | texinfo-update-node \\[texinfo-update-node] | |
547 | texinfo-every-node-update \\[texinfo-every-node-update] | |
5ccb13ff | 548 | texinfo-sequential-node-update |
952d72ff RC |
549 | |
550 | texinfo-make-menu \\[texinfo-make-menu] | |
551 | texinfo-all-menus-update \\[texinfo-all-menus-update] | |
552 | texinfo-master-menu | |
553 | ||
554 | texinfo-indent-menu-description (column &optional region-p) | |
555 | ||
556 | The `texinfo-column-for-description' variable specifies the column to | |
5ccb13ff | 557 | which menu descriptions are indented. |
952d72ff RC |
558 | |
559 | Passed an argument (a prefix argument, if interactive), the | |
560 | `texinfo-update-node' and `texinfo-make-menu' functions do their jobs | |
561 | in the region. | |
562 | ||
d5aa8b02 | 563 | To use the updating commands, you must structure your Texinfo file |
952d72ff | 564 | hierarchically, such that each `@node' line, with the exception of the |
d5aa8b02 | 565 | Top node, is accompanied by some kind of section line, such as an |
952d72ff RC |
566 | `@chapter' or `@section' line. |
567 | ||
568 | If the file has a `top' node, it must be called `top' or `Top' and | |
569 | be the first node in the file. | |
570 | ||
e3721db1 SM |
571 | Entering Texinfo mode calls the value of `text-mode-hook', and then the |
572 | value of `texinfo-mode-hook'." | |
a11609d8 SM |
573 | (set (make-local-variable 'page-delimiter) |
574 | (concat | |
575 | "^@node [ \t]*[Tt]op\\|^@\\(" | |
576 | texinfo-chapter-level-regexp | |
577 | "\\)\\>")) | |
952d72ff | 578 | (make-local-variable 'require-final-newline) |
7e630648 | 579 | (setq require-final-newline mode-require-final-newline) |
c6cc04e9 RS |
580 | (make-local-variable 'indent-tabs-mode) |
581 | (setq indent-tabs-mode nil) | |
952d72ff | 582 | (make-local-variable 'paragraph-separate) |
5ccb13ff RS |
583 | (setq paragraph-separate |
584 | (concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-separate)) | |
952d72ff | 585 | (make-local-variable 'paragraph-start) |
6e9f6940 | 586 | (setq paragraph-start (concat "\b\\|@[a-zA-Z]*[ \n]\\|" paragraph-start)) |
61f91c04 | 587 | (set (make-local-variable 'sentence-end-base) |
e739cc85 | 588 | "\\(@\\(end\\)?dots{}\\|[.?!]\\)[]\"'”)}]*") |
952d72ff | 589 | (make-local-variable 'fill-column) |
14ec09d7 | 590 | (setq fill-column 70) |
952d72ff RC |
591 | (make-local-variable 'comment-start) |
592 | (setq comment-start "@c ") | |
593 | (make-local-variable 'comment-start-skip) | |
e3721db1 | 594 | (setq comment-start-skip "@c +\\|@comment +") |
952d72ff RC |
595 | (make-local-variable 'words-include-escapes) |
596 | (setq words-include-escapes t) | |
e4cfb70d KH |
597 | (make-local-variable 'imenu-generic-expression) |
598 | (setq imenu-generic-expression texinfo-imenu-generic-expression) | |
c0b08eb0 | 599 | (setq imenu-case-fold-search nil) |
2ab3bf87 | 600 | (make-local-variable 'font-lock-defaults) |
e3721db1 | 601 | (setq font-lock-defaults |
cf38dd42 SM |
602 | '(texinfo-font-lock-keywords nil nil nil backward-paragraph)) |
603 | (set (make-local-variable 'syntax-propertize-function) | |
604 | texinfo-syntax-propertize-function) | |
e3721db1 | 605 | (set (make-local-variable 'parse-sexp-lookup-properties) t) |
f412245b SM |
606 | |
607 | ;; Outline settings. | |
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) | |
4ae1fdf6 | 614 | (concat (regexp-opt (mapcar 'car outline-heading-alist) t) |
f412245b SM |
615 | "\\>")) |
616 | ||
d78fc315 | 617 | (make-local-variable 'tex-start-of-header) |
24e519d8 | 618 | (setq tex-start-of-header "%\\*\\*start") |
d78fc315 | 619 | (make-local-variable 'tex-end-of-header) |
24e519d8 RS |
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) | |
8bd88d54 GM |
624 | (setq tex-trailer "@bye\n") |
625 | ||
626 | ;; Prevent filling certain lines, in addition to ones specified | |
627 | ;; by the user. | |
628 | (let ((prevent-filling "^@\\(def\\|multitable\\)")) | |
a11609d8 SM |
629 | (set (make-local-variable 'auto-fill-inhibit-regexp) |
630 | (if (null auto-fill-inhibit-regexp) | |
631 | prevent-filling | |
8fe6d67f | 632 | (concat auto-fill-inhibit-regexp "\\|" prevent-filling))))) |
db95369b | 633 | |
952d72ff RC |
634 | |
635 | \f | |
c6cc04e9 RS |
636 | ;;; Insert string commands |
637 | ||
d7fa3319 SM |
638 | (defvar texinfo-block-default "example") |
639 | ||
e3721db1 SM |
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." | |
d7fa3319 SM |
643 | (setq texinfo-block-default |
644 | (completing-read (format "Block name [%s]: " texinfo-block-default) | |
f412245b | 645 | texinfo-environments |
d7fa3319 | 646 | nil nil nil nil texinfo-block-default)) |
61f91c04 SM |
647 | \n "@" str |
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"))) | |
652 | '(nil " " -)) | |
653 | \n _ \n "@end " str \n) | |
e3721db1 | 654 | |
eedd2812 SM |
655 | (defun texinfo-inside-macro-p (macro &optional bound) |
656 | "Non-nil if inside a macro matching the regexp MACRO." | |
08f9e254 DL |
657 | (condition-case nil |
658 | (save-excursion | |
659 | (save-restriction | |
660 | (narrow-to-region bound (point)) | |
661 | (while (progn | |
662 | (up-list -1) | |
663 | (not (condition-case nil | |
664 | (save-excursion | |
665 | (backward-sexp 1) | |
666 | (looking-at macro)) | |
a11609d8 | 667 | (scan-error nil))))) |
08f9e254 | 668 | t)) |
a11609d8 | 669 | (scan-error nil))) |
eedd2812 SM |
670 | |
671 | (defun texinfo-inside-env-p (env &optional bound) | |
672 | "Non-nil if inside an environment matching the regexp @ENV." | |
673 | (save-excursion | |
674 | (and (re-search-backward (concat "@\\(end\\s +\\)?" env) bound t) | |
a11609d8 | 675 | (not (match-end 1))))) |
eedd2812 | 676 | |
ffa5b3a3 | 677 | (defvar texinfo-enable-quote-macros "@\\(code\\|samp\\|kbd\\)\\>") |
f412245b | 678 | (defvar texinfo-enable-quote-envs '("example\\>" "lisp\\>")) |
eedd2812 | 679 | (defun texinfo-insert-quote (&optional arg) |
887a2f77 | 680 | "Insert the appropriate quote mark for Texinfo. |
9768eaa7 EZ |
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 \"." | |
eedd2812 SM |
684 | (interactive "*P") |
685 | (let ((top (or (save-excursion (re-search-backward "@node\\>" nil t)) | |
686 | (point-min)))) | |
9768eaa7 | 687 | (if (or arg |
8fe6d67f SM |
688 | (= (preceding-char) ?\\) |
689 | (save-excursion | |
78151cd5 GM |
690 | ;; Might be near the start of a (narrowed) buffer. |
691 | (ignore-errors (backward-char (length texinfo-open-quote))) | |
8fe6d67f SM |
692 | (when (or (looking-at texinfo-open-quote) |
693 | (looking-at texinfo-close-quote)) | |
694 | (delete-char (length texinfo-open-quote)) | |
695 | t)) | |
f412245b SM |
696 | (texinfo-inside-macro-p texinfo-enable-quote-macros top) |
697 | (let ((in-env nil)) | |
698 | (dolist (env texinfo-enable-quote-envs in-env) | |
699 | (if (texinfo-inside-env-p env top) | |
700 | (setq in-env t))))) | |
eedd2812 | 701 | (self-insert-command (prefix-numeric-value arg)) |
9768eaa7 | 702 | (insert |
083654ee GM |
703 | (if (or (bobp) |
704 | (memq (char-syntax (preceding-char)) '(?\( ?> ?\s))) | |
8fe6d67f SM |
705 | texinfo-open-quote |
706 | texinfo-close-quote))))) | |
db95369b | 707 | |
5ccb13ff RS |
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. | |
c6cc04e9 | 711 | |
8fe6d67f SM |
712 | (defun texinfo-last-unended-begin () |
713 | (while (and (re-search-backward texinfo-environment-regexp) | |
714 | (looking-at "@end")) | |
715 | (texinfo-last-unended-begin))) | |
716 | ||
717 | (defun texinfo-next-unmatched-end () | |
718 | (while (and (re-search-forward texinfo-environment-regexp) | |
719 | (save-excursion | |
720 | (goto-char (match-beginning 0)) | |
721 | (not (looking-at "@end")))) | |
722 | (texinfo-next-unmatched-end))) | |
723 | ||
61f91c04 | 724 | (define-skeleton texinfo-insert-@end |
c6cc04e9 | 725 | "Insert the matching `@end' for the last Texinfo command that needs one." |
8fe6d67f SM |
726 | (ignore-errors |
727 | (save-excursion | |
61f91c04 | 728 | (backward-word 1) |
8fe6d67f | 729 | (texinfo-last-unended-begin) |
61f91c04 SM |
730 | (or (match-string 1) '-))) |
731 | \n "@end " str \n) | |
732 | ||
733 | (define-skeleton texinfo-insert-braces | |
c6cc04e9 RS |
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." | |
61f91c04 SM |
736 | nil |
737 | "{" _ "}") | |
c6cc04e9 | 738 | |
61f91c04 | 739 | (define-skeleton texinfo-insert-@code |
c6cc04e9 RS |
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." | |
61f91c04 SM |
743 | nil |
744 | "@code{" _ "}") | |
c6cc04e9 | 745 | |
61f91c04 | 746 | (define-skeleton texinfo-insert-@dfn |
c6cc04e9 RS |
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." | |
61f91c04 SM |
750 | nil |
751 | "@dfn{" _ "}") | |
952d72ff | 752 | |
61f91c04 | 753 | (define-skeleton texinfo-insert-@email |
af9eaa5e GM |
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." | |
61f91c04 SM |
757 | nil |
758 | "@email{" _ "}") | |
af9eaa5e | 759 | |
61f91c04 | 760 | (define-skeleton texinfo-insert-@emph |
af9eaa5e GM |
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." | |
61f91c04 SM |
764 | nil |
765 | "@emph{" _ "}") | |
af9eaa5e | 766 | |
61f91c04 | 767 | (define-skeleton texinfo-insert-@example |
c6cc04e9 | 768 | "Insert the string `@example' in a Texinfo buffer." |
61f91c04 SM |
769 | nil |
770 | \n "@example" \n) | |
c6cc04e9 | 771 | |
61f91c04 | 772 | (define-skeleton texinfo-insert-@file |
c6cc04e9 RS |
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." | |
61f91c04 SM |
776 | nil |
777 | "@file{" _ "}") | |
c6cc04e9 | 778 | |
61f91c04 | 779 | (define-skeleton texinfo-insert-@item |
235de372 EZ |
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." | |
61f91c04 SM |
783 | nil |
784 | \n "@item" | |
235de372 EZ |
785 | (if (equal (ignore-errors |
786 | (save-excursion | |
787 | (texinfo-last-unended-begin) | |
788 | (match-string 1))) | |
789 | "table") | |
61f91c04 SM |
790 | " " '\n) |
791 | _ \n) | |
c6cc04e9 | 792 | |
61f91c04 | 793 | (define-skeleton texinfo-insert-@kbd |
c6cc04e9 RS |
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." | |
61f91c04 SM |
797 | nil |
798 | "@kbd{" _ "}") | |
c6cc04e9 | 799 | |
61f91c04 | 800 | (define-skeleton texinfo-insert-@node |
c6cc04e9 | 801 | "Insert the string `@node' in a Texinfo buffer. |
481b0db7 RC |
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'." | |
61f91c04 SM |
805 | nil |
806 | \n "@node " _ \n) | |
c6cc04e9 | 807 | |
61f91c04 | 808 | (define-skeleton texinfo-insert-@noindent |
c6cc04e9 | 809 | "Insert the string `@noindent' in a Texinfo buffer." |
61f91c04 SM |
810 | nil |
811 | \n "@noindent" \n) | |
c6cc04e9 | 812 | |
61f91c04 | 813 | (define-skeleton texinfo-insert-@quotation |
af9eaa5e | 814 | "Insert the string `@quotation' in a Texinfo buffer." |
61f91c04 | 815 | \n "@quotation" \n) |
af9eaa5e | 816 | |
61f91c04 | 817 | (define-skeleton texinfo-insert-@samp |
c6cc04e9 RS |
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." | |
61f91c04 SM |
821 | nil |
822 | "@samp{" _ "}") | |
c6cc04e9 | 823 | |
61f91c04 | 824 | (define-skeleton texinfo-insert-@strong |
af9eaa5e GM |
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." | |
61f91c04 SM |
828 | nil |
829 | "@strong{" _ "}") | |
af9eaa5e | 830 | |
61f91c04 | 831 | (define-skeleton texinfo-insert-@table |
c6cc04e9 | 832 | "Insert the string `@table' in a Texinfo buffer." |
61f91c04 SM |
833 | nil |
834 | \n "@table " _ \n) | |
c6cc04e9 | 835 | |
61f91c04 | 836 | (define-skeleton texinfo-insert-@var |
c6cc04e9 RS |
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." | |
61f91c04 SM |
840 | nil |
841 | "@var{" _ "}") | |
af9eaa5e | 842 | |
61f91c04 | 843 | (define-skeleton texinfo-insert-@uref |
08f9e254 | 844 | "Insert a `@uref{}' command in a Texinfo buffer. |
af9eaa5e GM |
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." | |
61f91c04 SM |
847 | nil |
848 | "@uref{" _ "}") | |
4fb0a34c | 849 | (defalias 'texinfo-insert-@url 'texinfo-insert-@uref) |
c6cc04e9 RS |
850 | \f |
851 | ;;; Texinfo file structure | |
952d72ff | 852 | |
5ccb13ff | 853 | (defun texinfo-show-structure (&optional nodes-too) |
952d72ff | 854 | "Show the structure of a Texinfo file. |
d5aa8b02 RC |
855 | List the lines in the file that begin with the @-sign commands for |
856 | @chapter, @section, and the like. | |
857 | ||
858 | With optional argument (prefix if interactive), list both the lines | |
859 | with @-sign commands for @chapter, @section, and the like, and list | |
860 | @node lines. | |
952d72ff RC |
861 | |
862 | Lines with structuring commands beginning in them are displayed in | |
c6cc04e9 | 863 | another buffer named `*Occur*'. In that buffer, you can move point to |
db95369b | 864 | one of those lines and then use |
aae61ef3 | 865 | \\<occur-mode-map>\\[occur-mode-goto-occurrence], |
c6cc04e9 | 866 | to jump to the corresponding spot in the Texinfo source file." |
952d72ff RC |
867 | |
868 | (interactive "P") | |
aae61ef3 | 869 | ;; First, remember current location |
ffa5b3a3 | 870 | (let (current-location) |
aae61ef3 RC |
871 | (save-excursion |
872 | (end-of-line) ; so as to find section on current line | |
db95369b | 873 | (if (re-search-backward |
aae61ef3 RC |
874 | ;; do not require `texinfo-section-types-regexp' in texnfo-upd.el |
875 | "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)" | |
876 | nil t) | |
877 | (setq current-location | |
878 | (progn | |
879 | (beginning-of-line) | |
880 | (buffer-substring (point) (progn (end-of-line) (point))))) | |
ffa5b3a3 | 881 | ;; else point is located before any section command. |
aae61ef3 RC |
882 | (setq current-location "tex"))) |
883 | ;; Second, create and format an *Occur* buffer | |
884 | (save-excursion | |
885 | (goto-char (point-min)) | |
4ae1fdf6 SM |
886 | (occur (concat "^\\(?:" (if nodes-too "@node\\>\\|") |
887 | outline-regexp "\\)"))) | |
aae61ef3 | 888 | (pop-to-buffer "*Occur*") |
952d72ff | 889 | (goto-char (point-min)) |
aae61ef3 RC |
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)) | |
895 | (let (level) | |
896 | (while (re-search-backward "^ *[0-9]*:@\\(\\sw+\\)" nil 0) | |
897 | (goto-char (1- (match-beginning 1))) | |
898 | (setq level | |
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 | |
db95369b | 903 | ;; potential bug: two exactly similar `current-location' lines ... |
aae61ef3 RC |
904 | (goto-char (point-min)) |
905 | (re-search-forward current-location nil t) | |
906 | (beginning-of-line) | |
907 | )) | |
908 | ||
952d72ff RC |
909 | \f |
910 | ;;; The tex and print function definitions: | |
911 | ||
cd482e05 | 912 | (defcustom texinfo-texi2dvi-command "texi2dvi" |
2db33a18 | 913 | "Command used by `texinfo-tex-buffer' to run TeX and texindex on a buffer." |
cd482e05 RS |
914 | :type 'string |
915 | :group 'texinfo) | |
bb946175 | 916 | |
cd482e05 | 917 | (defcustom texinfo-tex-command "tex" |
2db33a18 | 918 | "Command used by `texinfo-tex-region' to run TeX on a region." |
cd482e05 RS |
919 | :type 'string |
920 | :group 'texinfo) | |
952d72ff | 921 | |
cd482e05 | 922 | (defcustom texinfo-texindex-command "texindex" |
2db33a18 | 923 | "Command used by `texinfo-texindex' to sort unsorted index files." |
cd482e05 RS |
924 | :type 'string |
925 | :group 'texinfo) | |
c6cc04e9 | 926 | |
cd482e05 | 927 | (defcustom texinfo-delete-from-print-queue-command "lprm" |
2db33a18 | 928 | "Command string used to delete a job from the line printer queue. |
c6cc04e9 RS |
929 | Command is used by \\[texinfo-delete-from-print-queue] based on |
930 | number provided by a previous \\[tex-show-print-queue] | |
cd482e05 RS |
931 | command." |
932 | :type 'string | |
933 | :group 'texinfo) | |
c6cc04e9 RS |
934 | |
935 | (defvar texinfo-tex-trailer "@bye" | |
936 | "String appended after a region sent to TeX by `texinfo-tex-region'.") | |
952d72ff RC |
937 | |
938 | (defun texinfo-tex-region (beg end) | |
c6cc04e9 RS |
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. | |
942 | ||
943 | The first line of the buffer is copied to the | |
1433a222 CZ |
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' | |
c6cc04e9 RS |
947 | inclusive. The header must start in the first 100 lines. |
948 | ||
949 | The value of `texinfo-tex-trailer' is appended to the temporary file after the region." | |
952d72ff | 950 | (interactive "r") |
e67adf46 | 951 | (require 'tex-mode) |
24e519d8 | 952 | (let ((tex-command texinfo-tex-command) |
3654a351 | 953 | (tex-trailer texinfo-tex-trailer)) |
24e519d8 | 954 | (tex-region beg end))) |
952d72ff RC |
955 | |
956 | (defun texinfo-tex-buffer () | |
c6cc04e9 RS |
957 | "Run TeX on visited file, once or twice, to make a correct `.dvi' file." |
958 | (interactive) | |
97c6c316 | 959 | (require 'tex-mode) |
3654a351 AS |
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 "")) | |
24e519d8 | 964 | (tex-buffer))) |
c6cc04e9 RS |
965 | |
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'." | |
952d72ff | 970 | (interactive) |
c6cc04e9 | 971 | (require 'tex-mode) |
79183f1a | 972 | (tex-send-command texinfo-texindex-command (concat tex-zap-file ".??")) |
5ccb13ff RS |
973 | ;; alternatively |
974 | ;; (send-string "tex-shell" | |
975 | ;; (concat texinfo-texindex-command | |
976 | ;; " " tex-zap-file ".??" "\n")) | |
c6cc04e9 | 977 | (tex-recenter-output-buffer nil)) |
952d72ff RC |
978 | |
979 | (defun texinfo-tex-print () | |
c6cc04e9 RS |
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'." | |
952d72ff | 982 | (interactive) |
e67adf46 | 983 | (require 'tex-mode) |
24e519d8 RS |
984 | (tex-print)) |
985 | ||
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'." | |
989 | (interactive) | |
990 | (require 'tex-mode) | |
991 | (tex-view)) | |
952d72ff | 992 | |
c6cc04e9 RS |
993 | (defun texinfo-quit-job () |
994 | "Quit currently running TeX job, by sending an `x' to it." | |
995 | (interactive) | |
996 | (if (not (get-process "tex-shell")) | |
997 | (error "No TeX shell running")) | |
79183f1a | 998 | (tex-send-command "x")) |
5ccb13ff RS |
999 | ;; alternatively: |
1000 | ;; save-excursion | |
1001 | ;; (set-buffer (get-buffer "*tex-shell*")) | |
1002 | ;; (goto-char (point-max)) | |
1003 | ;; (insert "x") | |
1004 | ;; (comint-send-input) | |
c6cc04e9 RS |
1005 | |
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 | |
5ccb13ff | 1009 | \\[tex-show-print-queue] command)." |
c6cc04e9 | 1010 | (interactive "nPrinter job number for deletion: ") |
97c6c316 | 1011 | (require 'tex-mode) |
c6cc04e9 RS |
1012 | (if (tex-shell-running) |
1013 | (tex-kill-job) | |
1014 | (tex-start-shell)) | |
79183f1a | 1015 | (tex-send-command texinfo-delete-from-print-queue-command job-number) |
5ccb13ff RS |
1016 | ;; alternatively |
1017 | ;; (send-string "tex-shell" | |
1018 | ;; (concat | |
1019 | ;; texinfo-delete-from-print-queue-command | |
1020 | ;; " " | |
1021 | ;; job-number"\n")) | |
c6cc04e9 RS |
1022 | (tex-recenter-output-buffer nil)) |
1023 | ||
49116ac0 JB |
1024 | (provide 'texinfo) |
1025 | ||
d501f516 | 1026 | ;;; texinfo.el ends here |