Commit | Line | Data |
---|---|---|
be010748 | 1 | ;;; texnfo-upd.el --- utilities for updating nodes and menus in Texinfo files |
1337cb42 | 2 | |
d7fc69d1 | 3 | ;; Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003 Free Software Foundation, Inc. |
7e1335cf | 4 | |
d1f9f441 | 5 | ;; Author: Robert J. Chassell |
64a1ba18 | 6 | ;; Maintainer: bug-texinfo@gnu.org |
d7b4d18f | 7 | ;; Keywords: maint, tex, docs |
7e1335cf | 8 | |
7e1335cf RC |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
e5d77022 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
7e1335cf RC |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
7e1335cf | 25 | |
22a89ee8 | 26 | ;;; Commentary: |
7e1335cf | 27 | |
b578f267 EN |
28 | ;; Known bug: update commands fail to ignore @ignore. |
29 | ||
30 | ;; Summary: how to use the updating commands | |
31 | ||
32 | ;; The node and menu updating functions automatically | |
33 | ||
34 | ;; * insert missing `@node' lines, | |
35 | ;; * insert the `Next', `Previous' and `Up' pointers of a node, | |
d1f9f441 | 36 | ;; * insert or update the menu for a section, |
b578f267 EN |
37 | ;; * create a master menu for a Texinfo source file. |
38 | ;; | |
78897d3d | 39 | ;; With a prefix argument, the `texinfo-update-node' and |
b578f267 EN |
40 | ;; `texinfo-make-menu' functions do their jobs in the region. |
41 | ;; | |
42 | ;; In brief, the functions for creating or updating nodes and menus, are: | |
d1f9f441 RS |
43 | ;; |
44 | ;; texinfo-update-node (&optional beginning end) | |
45 | ;; texinfo-every-node-update () | |
b578f267 | 46 | ;; texinfo-sequential-node-update (&optional region-p) |
d1f9f441 RS |
47 | ;; |
48 | ;; texinfo-make-menu (&optional beginning end) | |
49 | ;; texinfo-all-menus-update () | |
b578f267 EN |
50 | ;; texinfo-master-menu () |
51 | ;; | |
52 | ;; texinfo-insert-node-lines (&optional title-p) | |
d1f9f441 | 53 | ;; |
b578f267 EN |
54 | ;; texinfo-indent-menu-description (column &optional region-p) |
55 | ||
56 | ;; The `texinfo-column-for-description' variable specifies the column to | |
d1f9f441 | 57 | ;; which menu descriptions are indented. |
b578f267 EN |
58 | |
59 | ;; Texinfo file structure | |
60 | ;; ---------------------- | |
61 | ||
62 | ;; To use the updating commands, you must structure your Texinfo file | |
63 | ;; hierarchically. Each `@node' line, with the exception of the top | |
64 | ;; node, must be accompanied by some kind of section line, such as an | |
65 | ;; `@chapter' or `@section' line. Each node-line/section-line | |
66 | ;; combination must look like this: | |
67 | ||
68 | ;; @node Lists and Tables, Cross References, Structuring, Top | |
69 | ;; @comment node-name, next, previous, up | |
70 | ;; @chapter Making Lists and Tables | |
71 | ||
72 | ;; or like this (without the `@comment' line): | |
73 | ||
74 | ;; @node Lists and Tables, Cross References, Structuring, Top | |
75 | ;; @chapter Making Lists and Tables | |
76 | ||
77 | ;; If the file has a `top' node, it must be called `top' or `Top' and | |
78 | ;; be the first node in the file. | |
7e1335cf RC |
79 | |
80 | \f | |
daa6abb8 | 81 | ;;; The update node functions described in detail |
7e1335cf | 82 | |
78897d3d | 83 | ;; The `texinfo-update-node' command with no prefix argument inserts |
b578f267 EN |
84 | ;; the correct next, previous and up pointers for the node in which |
85 | ;; point is located (i.e., for the node preceding point). | |
7e1335cf | 86 | |
78897d3d | 87 | ;; With prefix argument, the `texinfo-update-node' function inserts the |
b578f267 EN |
88 | ;; correct next, previous and up pointers for the nodes inside the |
89 | ;; region. | |
7e1335cf | 90 | |
b578f267 EN |
91 | ;; It does not matter whether the `@node' line has pre-existing |
92 | ;; `Next', `Previous', or `Up' pointers in it. They are removed. | |
7e1335cf | 93 | |
b578f267 EN |
94 | ;; The `texinfo-every-node-update' function runs `texinfo-update-node' |
95 | ;; on the whole buffer. | |
7e1335cf | 96 | |
b578f267 EN |
97 | ;; The `texinfo-sequential-node-update' function inserts the |
98 | ;; immediately following and preceding node into the `Next' or | |
99 | ;; `Previous' pointers regardless of their hierarchical level. This is | |
100 | ;; only useful for certain kinds of text, like a novel, which you go | |
101 | ;; through sequentially. | |
daa6abb8 RS |
102 | |
103 | \f | |
104 | ;;; The menu making functions described in detail | |
7e1335cf | 105 | |
b578f267 EN |
106 | ;; The `texinfo-make-menu' function without an argument creates or |
107 | ;; updates a menu for the section encompassing the node that follows | |
108 | ;; point. With an argument, it makes or updates menus for the nodes | |
109 | ;; within or part of the marked region. | |
110 | ||
111 | ;; Whenever an existing menu is updated, the descriptions from | |
112 | ;; that menu are incorporated into the new menu. This is done by copying | |
113 | ;; descriptions from the existing menu to the entries in the new menu | |
114 | ;; that have the same node names. If the node names are different, the | |
115 | ;; descriptions are not copied to the new menu. | |
116 | ||
117 | ;; Menu entries that refer to other Info files are removed since they | |
118 | ;; are not a node within current buffer. This is a deficiency. | |
119 | ||
120 | ;; The `texinfo-all-menus-update' function runs `texinfo-make-menu' | |
121 | ;; on the whole buffer. | |
122 | ||
123 | ;; The `texinfo-master-menu' function creates an extended menu located | |
124 | ;; after the top node. (The file must have a top node.) The function | |
125 | ;; first updates all the regular menus in the buffer (incorporating the | |
126 | ;; descriptions from pre-existing menus), and then constructs a master | |
127 | ;; menu that includes every entry from every other menu. (However, the | |
128 | ;; function cannot update an already existing master menu; if one | |
129 | ;; exists, it must be removed before calling the function.) | |
130 | ||
131 | ;; The `texinfo-indent-menu-description' function indents every | |
132 | ;; description in the menu following point, to the specified column. | |
133 | ;; Non-nil argument (prefix, if interactive) means indent every | |
134 | ;; description in every menu in the region. This function does not | |
135 | ;; indent second and subsequent lines of a multi-line description. | |
136 | ||
137 | ;; The `texinfo-insert-node-lines' function inserts `@node' before the | |
138 | ;; `@chapter', `@section', and such like lines of a region in a Texinfo | |
139 | ;; file where the `@node' lines are missing. | |
d1f9f441 | 140 | ;; |
b578f267 EN |
141 | ;; With a non-nil argument (prefix, if interactive), the function not |
142 | ;; only inserts `@node' lines but also inserts the chapter or section | |
143 | ;; titles as the names of the corresponding nodes; and inserts titles | |
144 | ;; as node names in pre-existing `@node' lines that lack names. | |
d1f9f441 | 145 | ;; |
b578f267 EN |
146 | ;; Since node names should be more concise than section or chapter |
147 | ;; titles, node names so inserted will need to be edited manually. | |
7e1335cf | 148 | |
d1f9f441 | 149 | \f |
daa6abb8 RS |
150 | ;;; Code: |
151 | ||
6f602bd0 | 152 | (require 'texinfo) |
80216a47 | 153 | |
80216a47 | 154 | |
155b48df RS |
155 | (defvar texinfo-master-menu-header |
156 | " --- The Detailed Node Listing ---\n" | |
157 | "String inserted before lower level entries in Texinfo master menu. | |
158 | It comes after the chapter-level menu entries.") | |
159 | ||
739da925 SM |
160 | ;; We used to look for just sub, but that found @subtitle. |
161 | (defvar texinfo-section-types-regexp | |
162 | "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)" | |
163 | "Regexp matching chapter, section, other headings (but not the top node).") | |
164 | ||
165 | (defvar texinfo-section-level-regexp | |
166 | (regexp-opt (texinfo-filter 3 texinfo-section-list)) | |
167 | "Regular expression matching just the Texinfo section level headings.") | |
168 | ||
169 | (defvar texinfo-subsection-level-regexp | |
170 | (regexp-opt (texinfo-filter 4 texinfo-section-list)) | |
171 | "Regular expression matching just the Texinfo subsection level headings.") | |
172 | ||
173 | (defvar texinfo-subsubsection-level-regexp | |
174 | (regexp-opt (texinfo-filter 5 texinfo-section-list)) | |
175 | "Regular expression matching just the Texinfo subsubsection level headings.") | |
176 | ||
177 | (defvar texinfo-update-menu-same-level-regexps | |
178 | '((1 . "top[ \t]+") | |
179 | (2 . (concat "\\(^@\\)\\(" texinfo-chapter-level-regexp "\\)\\>[ \t]*")) | |
180 | (3 . (concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)\\>[ \t]*")) | |
181 | (4 . (concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)\\>[ \t]+")) | |
182 | (5 . (concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)\\>[ \t]+"))) | |
183 | "*Regexps for searching for same level sections in a Texinfo file. | |
184 | The keys are strings specifying the general hierarchical level in the | |
185 | document; the values are regular expressions.") | |
186 | ||
187 | (defvar texinfo-update-menu-higher-regexps | |
188 | '((1 . "^@node [ \t]*DIR") | |
189 | (2 . "^@node [ \t]*top[ \t]*\\(,\\|$\\)") | |
190 | (3 . | |
191 | (concat | |
192 | "\\(^@\\(" | |
193 | texinfo-chapter-level-regexp | |
194 | "\\)\\>[ \t]*\\)")) | |
195 | (4 . | |
196 | (concat | |
197 | "\\(^@\\(" | |
198 | texinfo-section-level-regexp | |
199 | "\\|" | |
200 | texinfo-chapter-level-regexp | |
201 | "\\)\\>[ \t]*\\)")) | |
202 | (5 . | |
203 | (concat | |
204 | "\\(^@\\(" | |
205 | texinfo-subsection-level-regexp | |
206 | "\\|" | |
207 | texinfo-section-level-regexp | |
208 | "\\|" | |
209 | texinfo-chapter-level-regexp | |
210 | "\\)\\>[ \t]*\\)"))) | |
211 | "*Regexps for searching for higher level sections in a Texinfo file. | |
212 | The keys are strings specifying the general hierarchical level in the | |
213 | document; the values are regular expressions.") | |
214 | ||
215 | (defvar texinfo-update-menu-lower-regexps | |
216 | '((1 . | |
217 | (concat | |
218 | "\\(^@\\(" | |
219 | texinfo-chapter-level-regexp | |
220 | "\\|" | |
221 | texinfo-section-level-regexp | |
222 | "\\|" | |
223 | texinfo-subsection-level-regexp | |
224 | "\\|" | |
225 | texinfo-subsubsection-level-regexp | |
226 | "\\)\\>[ \t]*\\)")) | |
227 | (2 . | |
228 | (concat | |
229 | "\\(^@\\(" | |
230 | texinfo-section-level-regexp | |
231 | "\\|" | |
232 | texinfo-subsection-level-regexp | |
233 | "\\|" | |
234 | texinfo-subsubsection-level-regexp | |
235 | "\\)\\>[ \t]*\\)")) | |
236 | (3 . | |
237 | (concat | |
238 | "\\(^@\\(" | |
239 | texinfo-subsection-level-regexp | |
240 | "\\|" | |
241 | texinfo-subsubsection-level-regexp | |
242 | "\\)\\>[ \t]+\\)")) | |
243 | (4 . | |
244 | (concat | |
245 | "\\(^@\\(" | |
246 | texinfo-subsubsection-level-regexp | |
247 | "\\)\\>[ \t]+\\)")) | |
248 | ;; There's nothing below 5, use a bogus regexp that can't match. | |
249 | (5 . "a\\(^\\)")) | |
250 | "*Regexps for searching for lower level sections in a Texinfo file. | |
251 | The keys are strings specifying the general hierarchical level in the | |
252 | document; the values are regular expressions.") | |
253 | ||
254 | \f | |
78897d3d | 255 | (defun texinfo-make-menu (&optional beginning end) |
7e1335cf RC |
256 | "Without any prefix argument, make or update a menu. |
257 | Make the menu for the section enclosing the node found following point. | |
258 | ||
78897d3d | 259 | A prefix argument means make or update menus |
7e1335cf RC |
260 | for nodes within or part of the marked region. |
261 | ||
262 | Whenever a menu exists, and is being updated, the descriptions that | |
263 | are associated with node names in the pre-existing menu are | |
70e2c6a4 RC |
264 | incorporated into the new menu. |
265 | ||
266 | Leaves trailing whitespace in a menu that lacks descriptions, so | |
267 | descriptions will format well. In general, a menu should contain | |
268 | descriptions, because node names and section titles are often too | |
269 | short to explain a node well." | |
d1f9f441 | 270 | |
78897d3d RS |
271 | (interactive |
272 | (if prefix-arg | |
273 | (list (point) (mark)))) | |
274 | (if (null beginning) | |
7e1335cf | 275 | (let ((level (texinfo-hierarchic-level))) |
91c6f26e KH |
276 | (texinfo-make-one-menu level) |
277 | (message "Menu updated")) | |
7e1335cf | 278 | ;; else |
daa6abb8 | 279 | (message "Making or updating menus in %s... " (buffer-name)) |
78897d3d RS |
280 | (save-excursion |
281 | (goto-char (min beginning end)) | |
282 | ;; find section type following point | |
283 | (let ((level (texinfo-hierarchic-level)) | |
91c6f26e KH |
284 | (region-end-marker (make-marker))) |
285 | (set-marker region-end-marker (max beginning end)) | |
286 | (save-restriction | |
287 | (widen) | |
d1f9f441 | 288 | |
91c6f26e KH |
289 | (while (texinfo-find-lower-level-node |
290 | level (marker-position region-end-marker)) | |
291 | (setq level (texinfo-hierarchic-level)) ; new, lower level | |
292 | (texinfo-make-one-menu level)) | |
d1f9f441 | 293 | |
91c6f26e KH |
294 | (while (and (< (point) (marker-position region-end-marker)) |
295 | (texinfo-find-higher-level-node | |
296 | level (marker-position region-end-marker))) | |
297 | (setq level (texinfo-hierarchic-level)) | |
af584472 RS |
298 | ;; Don't allow texinfo-find-higher-level-node |
299 | ;; to find the same node again. | |
300 | (forward-line 1) | |
91c6f26e KH |
301 | (while (texinfo-find-lower-level-node |
302 | level (marker-position region-end-marker)) | |
303 | (setq level (texinfo-hierarchic-level)) ; new, lower level | |
304 | (texinfo-make-one-menu level)))))) | |
78897d3d | 305 | (message "Making or updating menus in %s...done" (buffer-name)))) |
7e1335cf RC |
306 | |
307 | (defun texinfo-make-one-menu (level) | |
308 | "Make a menu of all the appropriate nodes in this section. | |
d1f9f441 | 309 | `Appropriate nodes' are those associated with sections that are |
7e1335cf RC |
310 | at the level specified by LEVEL. Point is left at the end of menu." |
311 | (let* | |
312 | ((case-fold-search t) | |
82ac4b77 JB |
313 | (beginning |
314 | (save-excursion | |
315 | (goto-char (texinfo-update-menu-region-beginning level)) | |
316 | (end-of-line) | |
317 | (point))) | |
7e1335cf RC |
318 | (end (texinfo-update-menu-region-end level)) |
319 | (first (texinfo-menu-first-node beginning end)) | |
320 | (node-name (progn | |
91c6f26e KH |
321 | (goto-char beginning) |
322 | (beginning-of-line) | |
323 | (texinfo-copy-node-name))) | |
7e1335cf | 324 | (new-menu-list (texinfo-make-menu-list beginning end level))) |
b9f60161 SM |
325 | (when (texinfo-old-menu-p beginning first) |
326 | (texinfo-incorporate-descriptions new-menu-list) | |
327 | (texinfo-incorporate-menu-entry-names new-menu-list) | |
328 | (texinfo-delete-old-menu beginning first)) | |
7e1335cf RC |
329 | (texinfo-insert-menu new-menu-list node-name))) |
330 | ||
331 | (defun texinfo-all-menus-update (&optional update-all-nodes-p) | |
332 | "Update every regular menu in a Texinfo file. | |
daa6abb8 | 333 | Update pre-existing master menu, if there is one. |
7e1335cf RC |
334 | |
335 | If called with a non-nil argument, this function first updates all the | |
70e2c6a4 RC |
336 | nodes in the buffer before updating the menus. |
337 | ||
338 | Indents the first line of descriptions, and leaves trailing whitespace | |
339 | in a menu that lacks descriptions, so descriptions will format well. | |
340 | In general, a menu should contain descriptions, because node names and | |
341 | section titles are often too short to explain a node well." | |
7e1335cf | 342 | (interactive "P") |
daa6abb8 | 343 | (let ((case-fold-search t) |
91c6f26e | 344 | master-menu-p) |
7e1335cf | 345 | (save-excursion |
daa6abb8 RS |
346 | (push-mark (point-max) t) |
347 | (goto-char (point-min)) | |
348 | (message "Checking for a master menu in %s ... "(buffer-name)) | |
349 | (save-excursion | |
b9f60161 SM |
350 | (when (search-forward texinfo-master-menu-header nil t) |
351 | ;; Check if @detailmenu kludge is used; | |
352 | ;; if so, leave point before @detailmenu. | |
353 | (search-backward "\n@detailmenu" | |
354 | (save-excursion (forward-line -3) (point)) | |
355 | t) | |
356 | ;; Remove detailed master menu listing | |
357 | (setq master-menu-p t) | |
358 | (goto-char (match-beginning 0)) | |
359 | (let ((end-of-detailed-menu-descriptions | |
360 | (save-excursion ; beginning of end menu line | |
361 | (goto-char (texinfo-menu-end)) | |
362 | (beginning-of-line) (forward-char -1) | |
363 | (point)))) | |
364 | (delete-region (point) end-of-detailed-menu-descriptions)))) | |
365 | ||
366 | (when update-all-nodes-p | |
367 | (message "Updating all nodes in %s ... " (buffer-name)) | |
368 | (texinfo-update-node (point-min) (point-max))) | |
d1f9f441 RS |
369 | |
370 | (message "Updating all menus in %s ... " (buffer-name)) | |
78897d3d | 371 | (texinfo-make-menu (point-max) (point-min)) |
d1f9f441 | 372 | |
b9f60161 SM |
373 | (when master-menu-p |
374 | (message "Updating the master menu in %s... " (buffer-name)) | |
375 | (texinfo-master-menu nil))) | |
d1f9f441 | 376 | |
7e1335cf RC |
377 | (message "Done...updated all the menus. You may save the buffer."))) |
378 | ||
379 | (defun texinfo-find-lower-level-node (level region-end) | |
380 | "Search forward from point for node at any level lower than LEVEL. | |
d1f9f441 | 381 | Search is limited to the end of the marked region, REGION-END, |
7e1335cf RC |
382 | and to the end of the menu region for the level. |
383 | ||
384 | Return t if the node is found, else nil. Leave point at the beginning | |
385 | of the node if one is found; else do not move point." | |
daa6abb8 RS |
386 | (let ((case-fold-search t)) |
387 | (if (and (< (point) region-end) | |
91c6f26e KH |
388 | (re-search-forward |
389 | (concat | |
390 | "\\(^@node\\).*\n" ; match node line | |
391 | "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any | |
392 | "\\|" ; or | |
21324fae GM |
393 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
394 | "\\|" ; or | |
395 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
396 | "\\)?" ; end of expression | |
91c6f26e KH |
397 | (eval (cdr (assoc level texinfo-update-menu-lower-regexps)))) |
398 | ;; the next higher level node marks the end of this | |
399 | ;; section, and no lower level node will be found beyond | |
400 | ;; this position even if region-end is farther off | |
401 | (texinfo-update-menu-region-end level) | |
402 | t)) | |
403 | (goto-char (match-beginning 1))))) | |
7e1335cf RC |
404 | |
405 | (defun texinfo-find-higher-level-node (level region-end) | |
406 | "Search forward from point for node at any higher level than argument LEVEL. | |
407 | Search is limited to the end of the marked region, REGION-END. | |
408 | ||
409 | Return t if the node is found, else nil. Leave point at the beginning | |
af584472 RS |
410 | of the node if one is found; else do not move point. |
411 | ||
412 | A `@node' line starting at point does count as a match; | |
413 | if the match is found there, the value is t and point does not move." | |
414 | ||
daa6abb8 RS |
415 | (let ((case-fold-search t)) |
416 | (cond | |
6f602bd0 | 417 | ((< level 3) |
daa6abb8 | 418 | (if (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t) |
91c6f26e | 419 | (progn (beginning-of-line) t))) |
daa6abb8 | 420 | (t |
b9f60161 SM |
421 | (when (re-search-forward |
422 | (concat | |
423 | "\\(^@node\\).*\n" ; match node line | |
424 | "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any | |
425 | "\\|" ; or | |
426 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any | |
427 | "\\|" ; or | |
428 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
429 | "\\)?" ; end of expression | |
430 | (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))) | |
431 | region-end t) | |
432 | (beginning-of-line) t))))) | |
7e1335cf RC |
433 | |
434 | \f | |
daa6abb8 | 435 | ;;; Making the list of new menu entries |
7e1335cf RC |
436 | |
437 | (defun texinfo-make-menu-list (beginning end level) | |
438 | "Make a list of node names and their descriptions. | |
439 | Point is left at the end of the menu region, but the menu is not inserted. | |
440 | ||
d1f9f441 | 441 | First argument is position from which to start making menu list; |
7e1335cf RC |
442 | second argument is end of region in which to try to locate entries; |
443 | third argument is the level of the nodes that are the entries. | |
444 | ||
445 | Node names and descriptions are dotted pairs of strings. Each pair is | |
446 | an element of the list. If the description does not exist, the | |
447 | element consists only of the node name." | |
448 | (goto-char beginning) | |
449 | (let (new-menu-list) | |
450 | (while (texinfo-menu-locate-entry-p level end) | |
b9f60161 SM |
451 | (push (cons |
452 | (texinfo-copy-node-name) | |
453 | (prog1 "" (forward-line 1))) | |
454 | ;; Use following to insert section titles automatically. | |
455 | ;; (texinfo-copy-section-title)) | |
456 | new-menu-list)) | |
457 | (nreverse new-menu-list))) | |
7e1335cf RC |
458 | |
459 | (defun texinfo-menu-locate-entry-p (level search-end) | |
460 | "Find a node that will be part of menu for this section. | |
461 | First argument is a string such as \"section\" specifying the general | |
daa6abb8 | 462 | hierarchical level of the menu; second argument is a position |
7e1335cf RC |
463 | specifying the end of the search. |
464 | ||
465 | The function returns t if the node is found, else nil. It searches | |
466 | forward from point, and leaves point at the beginning of the node. | |
467 | ||
468 | The function finds entries of the same type. Thus `subsections' and | |
469 | `unnumberedsubsecs' will appear in the same menu." | |
daa6abb8 RS |
470 | (let ((case-fold-search t)) |
471 | (if (re-search-forward | |
91c6f26e KH |
472 | (concat |
473 | "\\(^@node\\).*\n" ; match node line | |
474 | "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any | |
475 | "\\|" ; or | |
21324fae GM |
476 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
477 | "\\|" ; or | |
478 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
479 | "\\)?" ; end of expression | |
91c6f26e KH |
480 | (eval |
481 | (cdr (assoc level texinfo-update-menu-same-level-regexps)))) | |
482 | search-end | |
483 | t) | |
484 | (goto-char (match-beginning 1))))) | |
7e1335cf RC |
485 | |
486 | (defun texinfo-copy-node-name () | |
487 | "Return the node name as a string. | |
488 | ||
489 | Start with point at the beginning of the node line; copy the text | |
490 | after the node command up to the first comma on the line, if any, and | |
491 | return the text as a string. Leaves point at the beginning of the | |
492 | line. If there is no node name, returns an empty string." | |
d1f9f441 | 493 | |
7e1335cf RC |
494 | (save-excursion |
495 | (buffer-substring | |
496 | (progn (forward-word 1) ; skip over node command | |
91c6f26e KH |
497 | (skip-chars-forward " \t") ; and over spaces |
498 | (point)) | |
b9f60161 | 499 | (if (search-forward "," (line-end-position) t) ; bound search |
91c6f26e | 500 | (1- (point)) |
7e1335cf RC |
501 | (end-of-line) (point))))) |
502 | ||
503 | (defun texinfo-copy-section-title () | |
504 | "Return the title of the section as a string. | |
505 | The title is used as a description line in the menu when one does not | |
506 | already exist. | |
507 | ||
508 | Move point to the beginning of the appropriate section line by going | |
509 | to the start of the text matched by last regexp searched for, which | |
510 | must have been done by `texinfo-menu-locate-entry-p'." | |
511 | ||
512 | ;; could use the same re-search as in `texinfo-menu-locate-entry-p' | |
513 | ;; instead of using `match-beginning'; such a variation would be | |
514 | ;; more general, but would waste information already collected | |
515 | ||
d1f9f441 | 516 | (goto-char (match-beginning 7)) ; match section name |
7e1335cf RC |
517 | |
518 | (buffer-substring | |
519 | (progn (forward-word 1) ; skip over section type | |
91c6f26e KH |
520 | (skip-chars-forward " \t") ; and over spaces |
521 | (point)) | |
7e1335cf RC |
522 | (progn (end-of-line) (point)))) |
523 | ||
524 | \f | |
daa6abb8 | 525 | ;;; Handling the old menu |
7e1335cf RC |
526 | |
527 | (defun texinfo-old-menu-p (beginning first) | |
528 | "Move point to the beginning of the menu for this section, if any. | |
529 | Otherwise move point to the end of the first node of this section. | |
530 | Return t if a menu is found, nil otherwise. | |
531 | ||
532 | First argument is the position of the beginning of the section in which | |
533 | the menu will be located; second argument is the position of the first | |
534 | node within the section. | |
535 | ||
536 | If no menu is found, the function inserts two newlines just before the | |
537 | end of the section, and leaves point there where a menu ought to be." | |
538 | (goto-char beginning) | |
b9f60161 SM |
539 | (if (re-search-forward "^@menu" first 'goto-end) |
540 | t | |
541 | (insert "\n\n") (forward-line -2) nil)) | |
7e1335cf RC |
542 | |
543 | (defun texinfo-incorporate-descriptions (new-menu-list) | |
544 | "Copy the old menu line descriptions that exist to the new menu. | |
545 | ||
546 | Point must be at beginning of old menu. | |
547 | ||
daa6abb8 RS |
548 | If the node-name of the new menu is found in the old menu, insert the |
549 | old description into the new entry. | |
7e1335cf RC |
550 | |
551 | For this function, the new menu is a list made up of lists of dotted | |
552 | pairs in which the first element of the pair is the node name and the | |
daa6abb8 | 553 | second element the description. The new menu is changed destructively. |
06cc857d | 554 | The old menu is the menu as it appears in the Texinfo file." |
d1f9f441 | 555 | |
b9f60161 SM |
556 | (let ((end-of-menu (texinfo-menu-end))) |
557 | (dolist (new-menu new-menu-list new-menu-list) | |
558 | (save-excursion ; keep point at beginning of menu | |
559 | (when (re-search-forward | |
560 | ;; Existing nodes can have the form | |
561 | ;; * NODE NAME:: DESCRIPTION | |
562 | ;; or | |
563 | ;; * MENU ITEM: NODE NAME. DESCRIPTION. | |
564 | ;; | |
565 | ;; Recognize both when looking for the description. | |
566 | (concat "\\* \\(" ; so only menu entries are found | |
567 | (regexp-quote (car new-menu)) "::" | |
568 | "\\|" | |
569 | ".*: " (regexp-quote (car new-menu)) "[.,\t\n]" | |
570 | "\\)" | |
571 | ) ; so only complete entries are found | |
572 | end-of-menu | |
573 | t) | |
574 | (setcdr new-menu (texinfo-menu-copy-old-description end-of-menu))))))) | |
7e1335cf | 575 | |
daa6abb8 RS |
576 | (defun texinfo-incorporate-menu-entry-names (new-menu-list) |
577 | "Copy any old menu entry names to the new menu. | |
578 | ||
579 | Point must be at beginning of old menu. | |
580 | ||
581 | If the node-name of the new menu entry cannot be found in the old | |
582 | menu, do nothing. | |
583 | ||
584 | For this function, the new menu is a list made up of lists of dotted | |
585 | pairs in which the first element of the pair is the node name and the | |
586 | second element is the description (or nil). | |
587 | ||
588 | If we find an existing menu entry name, we change the first element of | |
589 | the pair to be another dotted pair in which the car is the menu entry | |
590 | name and the cdr is the node name. | |
591 | ||
592 | NEW-MENU-LIST is changed destructively. The old menu is the menu as it | |
593 | appears in the texinfo file." | |
d1f9f441 | 594 | |
b9f60161 SM |
595 | (let ((end-of-menu (texinfo-menu-end))) |
596 | (dolist (new-menu new-menu-list new-menu-list) | |
d1f9f441 | 597 | (save-excursion ; keep point at beginning of menu |
91c6f26e KH |
598 | (if (re-search-forward |
599 | ;; Existing nodes can have the form | |
600 | ;; * NODE NAME:: DESCRIPTION | |
601 | ;; or | |
602 | ;; * MENU ITEM: NODE NAME. DESCRIPTION. | |
603 | ;; | |
604 | ;; We're interested in the second case. | |
605 | (concat "\\* " ; so only menu entries are found | |
b9f60161 | 606 | "\\(.*\\): " (regexp-quote (car new-menu)) |
ca722adb | 607 | "[.,\t\n]") |
91c6f26e KH |
608 | end-of-menu |
609 | t) | |
610 | (setcar | |
b9f60161 | 611 | new-menu ; replace the node name |
91c6f26e | 612 | (cons (buffer-substring (match-beginning 1) (match-end 1)) |
b9f60161 | 613 | (car new-menu)))))))) |
daa6abb8 | 614 | |
7e1335cf RC |
615 | (defun texinfo-menu-copy-old-description (end-of-menu) |
616 | "Return description field of old menu line as string. | |
617 | Point must be located just after the node name. Point left before description. | |
618 | Single argument, END-OF-MENU, is position limiting search." | |
619 | (skip-chars-forward "[:.,\t\n ]+") | |
620 | ;; don't copy a carriage return at line beginning with asterisk! | |
8da9865a | 621 | ;; don't copy @detailmenu or @end menu as descriptions! |
7e1335cf | 622 | ;; do copy a description that begins with an `@'! |
daa6abb8 | 623 | ;; !! Known bug: does not copy descriptions starting with ^|\{?* etc. |
d1f9f441 | 624 | (if (and (looking-at "\\(\\w+\\|@\\)") |
8da9865a | 625 | (not (looking-at "\\(^\\* \\|^@detailmenu\\|^@end menu\\)"))) |
7e1335cf RC |
626 | (buffer-substring |
627 | (point) | |
628 | (save-excursion | |
91c6f26e KH |
629 | (re-search-forward "\\(^\\* \\|^@end menu\\)" end-of-menu t) |
630 | (forward-line -1) | |
631 | (end-of-line) ; go to end of last description line | |
632 | (point))) | |
7e1335cf RC |
633 | "")) |
634 | ||
635 | (defun texinfo-menu-end () | |
06cc857d | 636 | "Return position of end of menu, but don't move point. |
7e1335cf RC |
637 | Signal an error if not end of menu." |
638 | (save-excursion | |
639 | (if (re-search-forward "^@end menu" nil t) | |
91c6f26e | 640 | (point) |
5b02e712 | 641 | (error "Menu does not have an end")))) |
7e1335cf RC |
642 | |
643 | (defun texinfo-delete-old-menu (beginning first) | |
644 | "Delete the old menu. Point must be in or after menu. | |
645 | First argument is position of the beginning of the section in which | |
646 | the menu will be located; second argument is the position of the first | |
647 | node within the section." | |
648 | ;; No third arg to search, so error if search fails. | |
649 | (re-search-backward "^@menu" beginning) | |
650 | (delete-region (point) | |
91c6f26e KH |
651 | (save-excursion |
652 | (re-search-forward "^@end menu" first) | |
653 | (point)))) | |
7e1335cf RC |
654 | |
655 | \f | |
daa6abb8 | 656 | ;;; Inserting new menu |
7e1335cf RC |
657 | |
658 | ;; try 32, but perhaps 24 is better | |
659 | (defvar texinfo-column-for-description 32 | |
660 | "*Column at which descriptions start in a Texinfo menu.") | |
661 | ||
662 | (defun texinfo-insert-menu (menu-list node-name) | |
663 | "Insert formatted menu at point. | |
70e2c6a4 RC |
664 | Indents the first line of descriptions, if any, to the value of |
665 | texinfo-column-for-description. Indenting leaves trailing whitespace | |
666 | in a menu that lacks descriptions, so descriptions will format well. | |
667 | In general, a menu should contain descriptions, because node names and | |
668 | section titles are often too short to explain a node well. | |
7e1335cf RC |
669 | |
670 | MENU-LIST has form: | |
671 | ||
d1f9f441 | 672 | \(\(\"node-name1\" . \"description\"\) |
daa6abb8 | 673 | \(\"node-name2\" . \"description\"\) ... \) |
7e1335cf | 674 | |
daa6abb8 RS |
675 | However, the description field might be nil. |
676 | ||
677 | Also, the node-name field might itself be a dotted pair (call it P) of | |
678 | strings instead of just a string. In that case, the car of P | |
679 | is the menu entry name, and the cdr of P is the node name." | |
d1f9f441 | 680 | |
7e1335cf | 681 | (insert "@menu\n") |
b9f60161 | 682 | (dolist (menu menu-list) |
daa6abb8 RS |
683 | ;; Every menu entry starts with a star and a space. |
684 | (insert "* ") | |
d1f9f441 | 685 | |
daa6abb8 | 686 | ;; Insert the node name (and menu entry name, if present). |
b9f60161 | 687 | (let ((node-part (car menu))) |
daa6abb8 | 688 | (if (stringp node-part) |
91c6f26e KH |
689 | ;; "Double colon" entry line; menu entry and node name are the same, |
690 | (insert (format "%s::" node-part)) | |
691 | ;; "Single colon" entry line; menu entry and node name are different. | |
692 | (insert (format "%s: %s." (car node-part) (cdr node-part))))) | |
d1f9f441 | 693 | |
daa6abb8 | 694 | ;; Insert the description, if present. |
b9f60161 SM |
695 | (when (cdr menu) |
696 | ;; Move to right place. | |
697 | (indent-to texinfo-column-for-description 2) | |
698 | ;; Insert description. | |
699 | (insert (format "%s" (cdr menu)))) | |
daa6abb8 | 700 | |
b9f60161 | 701 | (insert "\n")) ; end this menu entry |
7e1335cf | 702 | (insert "@end menu") |
a056c2c7 RC |
703 | (let ((level (texinfo-hierarchic-level))) |
704 | (message | |
705 | "Updated level \"%s\" menu following node: %s ... " level node-name))) | |
7e1335cf RC |
706 | |
707 | \f | |
daa6abb8 RS |
708 | ;;; Starting menu descriptions by inserting titles |
709 | ||
710 | (defun texinfo-start-menu-description () | |
d1f9f441 | 711 | "In this menu entry, insert the node's section title as a description. |
daa6abb8 RS |
712 | Position point at beginning of description ready for editing. |
713 | Do not insert a title if the line contains an existing description. | |
714 | ||
715 | You will need to edit the inserted text since a useful description | |
716 | complements the node name rather than repeats it as a title does." | |
d1f9f441 | 717 | |
daa6abb8 RS |
718 | (interactive) |
719 | (let (beginning end node-name title) | |
720 | (save-excursion | |
b9f60161 | 721 | (beginning-of-line) |
daa6abb8 | 722 | (if (search-forward "* " (save-excursion (end-of-line) (point)) t) |
91c6f26e KH |
723 | (progn (skip-chars-forward " \t") |
724 | (setq beginning (point))) | |
5b02e712 | 725 | (error "This is not a line in a menu")) |
d1f9f441 | 726 | |
daa6abb8 | 727 | (cond |
b9f60161 | 728 | ;; "Double colon" entry line; menu entry and node name are the same, |
daa6abb8 | 729 | ((search-forward "::" (save-excursion (end-of-line) (point)) t) |
91c6f26e | 730 | (if (looking-at "[ \t]*[^ \t\n]+") |
5b02e712 | 731 | (error "Descriptive text already exists")) |
91c6f26e KH |
732 | (skip-chars-backward ": \t") |
733 | (setq node-name (buffer-substring beginning (point)))) | |
d1f9f441 | 734 | |
daa6abb8 RS |
735 | ;; "Single colon" entry line; menu entry and node name are different. |
736 | ((search-forward ":" (save-excursion (end-of-line) (point)) t) | |
91c6f26e KH |
737 | (skip-chars-forward " \t") |
738 | (setq beginning (point)) | |
739 | ;; Menu entry line ends in a period, comma, or tab. | |
740 | (if (re-search-forward "[.,\t]" | |
741 | (save-excursion (forward-line 1) (point)) t) | |
742 | (progn | |
743 | (if (looking-at "[ \t]*[^ \t\n]+") | |
5b02e712 | 744 | (error "Descriptive text already exists")) |
91c6f26e KH |
745 | (skip-chars-backward "., \t") |
746 | (setq node-name (buffer-substring beginning (point)))) | |
747 | ;; Menu entry line ends in a return. | |
748 | (re-search-forward ".*\n" | |
b9f60161 | 749 | (save-excursion (forward-line 1) (point)) t) |
91c6f26e KH |
750 | (skip-chars-backward " \t\n") |
751 | (setq node-name (buffer-substring beginning (point))) | |
752 | (if (= 0 (length node-name)) | |
5b02e712 | 753 | (error "No node name on this line") |
91c6f26e | 754 | (insert ".")))) |
5b02e712 | 755 | (t (error "No node name on this line"))) |
daa6abb8 RS |
756 | ;; Search for node that matches node name, and copy the section title. |
757 | (if (re-search-forward | |
91c6f26e KH |
758 | (concat |
759 | "^@node[ \t]+" | |
760 | (regexp-quote node-name) | |
b9f60161 | 761 | ".*\n" ; match node line |
91c6f26e KH |
762 | "\\(" |
763 | "\\(\\(^@c \\|^@comment\\).*\n\\)" ; match comment line, if any | |
764 | "\\|" ; or | |
765 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any | |
21324fae GM |
766 | "\\|" ; or |
767 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
768 | "\\)?" ; end of expression | |
857b864a | 769 | ) |
91c6f26e | 770 | nil t) |
b9f60161 SM |
771 | (setq title |
772 | (buffer-substring | |
773 | ;; skip over section type | |
774 | (progn (forward-word 1) | |
775 | ;; and over spaces | |
776 | (skip-chars-forward " \t") | |
777 | (point)) | |
778 | (progn (end-of-line) | |
779 | (skip-chars-backward " \t") | |
780 | (point)))) | |
5b02e712 | 781 | (error "Cannot find node to match node name in menu entry"))) |
daa6abb8 RS |
782 | ;; Return point to the menu and insert the title. |
783 | (end-of-line) | |
784 | (delete-region | |
785 | (point) | |
786 | (save-excursion (skip-chars-backward " \t") (point))) | |
787 | (indent-to texinfo-column-for-description 2) | |
788 | (save-excursion (insert title)))) | |
789 | ||
790 | \f | |
791 | ;;; Handling description indentation | |
7e1335cf | 792 | |
06cc857d RS |
793 | ;; Since the make-menu functions indent descriptions, these functions |
794 | ;; are useful primarily for indenting a single menu specially. | |
7e1335cf RC |
795 | |
796 | (defun texinfo-indent-menu-description (column &optional region-p) | |
d1f9f441 | 797 | "Indent every description in menu following point to COLUMN. |
7e1335cf RC |
798 | Non-nil argument (prefix, if interactive) means indent every |
799 | description in every menu in the region. Does not indent second and | |
800 | subsequent lines of a multi-line description." | |
d1f9f441 | 801 | |
7e1335cf RC |
802 | (interactive |
803 | "nIndent menu descriptions to (column number): \nP") | |
804 | (save-excursion | |
805 | (save-restriction | |
806 | (widen) | |
807 | (if (not region-p) | |
91c6f26e KH |
808 | (progn |
809 | (re-search-forward "^@menu") | |
810 | (texinfo-menu-indent-description column) | |
811 | (message | |
812 | "Indented descriptions in menu. You may save the buffer.")) | |
813 | ;;else | |
814 | (message "Indenting every menu description in region... ") | |
815 | (goto-char (region-beginning)) | |
816 | (while (and (< (point) (region-end)) | |
817 | (texinfo-locate-menu-p)) | |
818 | (forward-line 1) | |
819 | (texinfo-menu-indent-description column)) | |
820 | (message "Indenting done. You may save the buffer."))))) | |
7e1335cf RC |
821 | |
822 | (defun texinfo-menu-indent-description (to-column-number) | |
823 | "Indent the Texinfo file menu description to TO-COLUMN-NUMBER. | |
824 | Start with point just after the word `menu' in the `@menu' line and | |
825 | leave point on the line before the `@end menu' line. Does not indent | |
826 | second and subsequent lines of a multi-line description." | |
827 | (let* ((beginning-of-next-line (point))) | |
828 | (while (< beginning-of-next-line | |
b9f60161 | 829 | (save-excursion ; beginning of end menu line |
91c6f26e KH |
830 | (goto-char (texinfo-menu-end)) |
831 | (beginning-of-line) | |
832 | (point))) | |
daa6abb8 | 833 | |
b9f60161 SM |
834 | (when (re-search-forward "\\* \\(.*::\\|.*: [^.,\t\n]+[.,\t]\\)" |
835 | (texinfo-menu-end) | |
836 | t) | |
837 | (let ((beginning-white-space (point))) | |
838 | (skip-chars-forward " \t") ; skip over spaces | |
839 | (if (looking-at "\\(@\\|\\w\\)+") ; if there is text | |
840 | (progn | |
841 | ;; remove pre-existing indentation | |
842 | (delete-region beginning-white-space (point)) | |
843 | (indent-to-column to-column-number))))) | |
7e1335cf | 844 | ;; position point at beginning of next line |
d1f9f441 | 845 | (forward-line 1) |
7e1335cf RC |
846 | (setq beginning-of-next-line (point))))) |
847 | ||
848 | \f | |
daa6abb8 | 849 | ;;; Making the master menu |
7e1335cf RC |
850 | |
851 | (defun texinfo-master-menu (update-all-nodes-menus-p) | |
852 | "Make a master menu for a whole Texinfo file. | |
853 | Non-nil argument (prefix, if interactive) means first update all | |
854 | existing nodes and menus. Remove pre-existing master menu, if there is one. | |
855 | ||
856 | This function creates a master menu that follows the top node. The | |
857 | master menu includes every entry from all the other menus. It | |
858 | replaces any existing ordinary menu that follows the top node. | |
859 | ||
860 | If called with a non-nil argument, this function first updates all the | |
861 | menus in the buffer (incorporating descriptions from pre-existing | |
862 | menus) before it constructs the master menu. | |
863 | ||
864 | The function removes the detailed part of an already existing master | |
9687a051 | 865 | menu. This action depends on the pre-existing master menu using the |
7e1335cf RC |
866 | standard `texinfo-master-menu-header'. |
867 | ||
868 | The master menu has the following format, which is adapted from the | |
869 | recommendation in the Texinfo Manual: | |
870 | ||
871 | * The first part contains the major nodes in the Texinfo file: the | |
872 | nodes for the chapters, chapter-like sections, and the major | |
873 | appendices. This includes the indices, so long as they are in | |
874 | chapter-like sections, such as unnumbered sections. | |
875 | ||
876 | * The second and subsequent parts contain a listing of the other, | |
877 | lower level menus, in order. This way, an inquirer can go | |
878 | directly to a particular node if he or she is searching for | |
879 | specific information. | |
880 | ||
881 | Each of the menus in the detailed node listing is introduced by the | |
70e2c6a4 RC |
882 | title of the section containing the menu. |
883 | ||
884 | Indents the first line of descriptions, and leaves trailing whitespace | |
885 | in a menu that lacks descriptions, so descriptions will format well. | |
886 | In general, a menu should contain descriptions, because node names and | |
887 | section titles are often too short to explain a node well." | |
d1f9f441 | 888 | |
7e1335cf | 889 | (interactive "P") |
daa6abb8 RS |
890 | (let ((case-fold-search t)) |
891 | (widen) | |
892 | (goto-char (point-min)) | |
d1f9f441 | 893 | |
daa6abb8 RS |
894 | ;; Move point to location after `top'. |
895 | (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) | |
5b02e712 | 896 | (error "This buffer needs a Top node")) |
d1f9f441 RS |
897 | |
898 | (let ((first-chapter | |
91c6f26e KH |
899 | (save-excursion |
900 | (or (re-search-forward "^@node" nil t) | |
5b02e712 | 901 | (error "Too few nodes for a master menu")) |
91c6f26e | 902 | (point)))) |
155b48df | 903 | (if (search-forward texinfo-master-menu-header first-chapter t) |
91c6f26e KH |
904 | (progn |
905 | ;; Check if @detailmenu kludge is used; | |
906 | ;; if so, leave point before @detailmenu. | |
907 | (search-backward "\n@detailmenu" | |
06cc857d RS |
908 | (save-excursion (forward-line -3) (point)) |
909 | t) | |
910 | ;; Remove detailed master menu listing | |
91c6f26e KH |
911 | (goto-char (match-beginning 0)) |
912 | (let ((end-of-detailed-menu-descriptions | |
913 | (save-excursion ; beginning of end menu line | |
914 | (goto-char (texinfo-menu-end)) | |
915 | (beginning-of-line) (forward-char -1) | |
916 | (point)))) | |
917 | (delete-region (point) end-of-detailed-menu-descriptions))))) | |
d1f9f441 | 918 | |
daa6abb8 | 919 | (if update-all-nodes-menus-p |
91c6f26e KH |
920 | (progn |
921 | (message "Making a master menu in %s ...first updating all nodes... " | |
922 | (buffer-name)) | |
91c6f26e | 923 | (texinfo-update-node (point-min) (point-max)) |
d1f9f441 | 924 | |
91c6f26e | 925 | (message "Updating all menus in %s ... " (buffer-name)) |
91c6f26e | 926 | (texinfo-make-menu (point-min) (point-max)))) |
d1f9f441 | 927 | |
daa6abb8 | 928 | (message "Now making the master menu in %s... " (buffer-name)) |
7e1335cf | 929 | (goto-char (point-min)) |
daa6abb8 RS |
930 | (texinfo-insert-master-menu-list |
931 | (texinfo-master-menu-list)) | |
d1f9f441 | 932 | |
daa6abb8 RS |
933 | ;; Remove extra newlines that texinfo-insert-master-menu-list |
934 | ;; may have inserted. | |
d1f9f441 | 935 | |
daa6abb8 RS |
936 | (save-excursion |
937 | (goto-char (point-min)) | |
d1f9f441 | 938 | |
155b48df | 939 | (if (search-forward texinfo-master-menu-header nil t) |
91c6f26e KH |
940 | (progn |
941 | (goto-char (match-beginning 0)) | |
942 | ;; Check if @detailmenu kludge is used; | |
943 | ;; if so, leave point before @detailmenu. | |
944 | (search-backward "\n@detailmenu" | |
06cc857d RS |
945 | (save-excursion (forward-line -3) (point)) |
946 | t) | |
91c6f26e KH |
947 | (insert "\n") |
948 | (delete-blank-lines) | |
949 | (goto-char (point-min)))) | |
daa6abb8 RS |
950 | |
951 | (re-search-forward "^@menu") | |
952 | (forward-line -1) | |
953 | (delete-blank-lines) | |
d1f9f441 | 954 | |
daa6abb8 RS |
955 | (re-search-forward "^@end menu") |
956 | (forward-line 1) | |
957 | (delete-blank-lines)) | |
d1f9f441 | 958 | |
daa6abb8 RS |
959 | (message |
960 | "Done...completed making master menu. You may save the buffer."))) | |
7e1335cf RC |
961 | |
962 | (defun texinfo-master-menu-list () | |
963 | "Return a list of menu entries and header lines for the master menu. | |
964 | ||
965 | Start with the menu for chapters and indices and then find each | |
966 | following menu and the title of the node preceding that menu. | |
967 | ||
968 | The master menu list has this form: | |
969 | ||
970 | \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\) | |
971 | \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\) | |
972 | ...\) | |
973 | ||
974 | However, there does not need to be a title field." | |
975 | ||
976 | (let (master-menu-list) | |
977 | (while (texinfo-locate-menu-p) | |
b9f60161 SM |
978 | (push (list (texinfo-copy-menu) (texinfo-copy-menu-title)) |
979 | master-menu-list)) | |
980 | (nreverse master-menu-list))) | |
7e1335cf RC |
981 | |
982 | (defun texinfo-insert-master-menu-list (master-menu-list) | |
983 | "Format and insert the master menu in the current buffer." | |
984 | (goto-char (point-min)) | |
daa6abb8 RS |
985 | ;; Insert a master menu only after `Top' node and before next node |
986 | ;; \(or include file if there is no next node\). | |
b9f60161 SM |
987 | (unless (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t) |
988 | (error "This buffer needs a Top node")) | |
daa6abb8 | 989 | (let ((first-chapter |
91c6f26e | 990 | (save-excursion (re-search-forward "^@node\\|^@include") (point)))) |
b9f60161 SM |
991 | (unless (re-search-forward "^@menu" first-chapter t) |
992 | (error "Buffer lacks ordinary `Top' menu in which to insert master"))) | |
7e1335cf | 993 | (beginning-of-line) |
daa6abb8 | 994 | (delete-region ; buffer must have ordinary top menu |
d1f9f441 | 995 | (point) |
daa6abb8 | 996 | (save-excursion (re-search-forward "^@end menu") (point))) |
d1f9f441 RS |
997 | |
998 | (save-excursion | |
999 | ;; `master-menu-inserted-p' is a kludge to tell | |
06cc857d RS |
1000 | ;; whether to insert @end detailmenu (see bleow) |
1001 | (let (master-menu-inserted-p) | |
1002 | ;; Handle top of menu | |
1003 | (insert "\n@menu\n") | |
b9f60161 SM |
1004 | ;; Insert chapter menu entries. Tell user what is going on. |
1005 | (message "Inserting chapter menu entry: %s ... " | |
1006 | (car (car master-menu-list))) | |
1007 | (dolist (entry (reverse (car (car master-menu-list)))) | |
1008 | (insert "* " entry "\n")) | |
d1f9f441 | 1009 | |
06cc857d | 1010 | (setq master-menu-list (cdr master-menu-list)) |
d1f9f441 | 1011 | |
06cc857d RS |
1012 | ;; Only insert detailed master menu if there is one.... |
1013 | (if (car (car master-menu-list)) | |
91c6f26e KH |
1014 | (progn (setq master-menu-inserted-p t) |
1015 | (insert (concat "\n@detailmenu\n" | |
eae582fe | 1016 | texinfo-master-menu-header)))) |
06cc857d RS |
1017 | |
1018 | ;; @detailmenu added 5 Sept 1996 to `texinfo-master-menu-header' | |
1019 | ;; at Karl Berry's request to avert a bug in `makeinfo'; | |
1020 | ;; all agree this is a bad kludge and should eventually be removed. | |
1021 | ;; @detailmenu ... @end detailmenu is a noop in `texinfmt.el'. | |
1022 | ;; See @end detailmenu below; | |
1023 | ;; also see `texinfo-all-menus-update' above, `texinfo-master-menu', | |
1024 | ;; `texinfo-multiple-files-update'. | |
1025 | ||
1026 | ;; Now, insert all the other menus | |
d1f9f441 | 1027 | |
06cc857d RS |
1028 | ;; The menu master-menu-list has a form like this: |
1029 | ;; ((("beta" "alpha") "title-A") | |
1030 | ;; (("delta" "gamma") "title-B")) | |
d1f9f441 | 1031 | |
b9f60161 | 1032 | (dolist (menu master-menu-list) |
d1f9f441 | 1033 | |
b9f60161 | 1034 | (message "Inserting menu for %s .... " (cadr menu)) |
91c6f26e | 1035 | ;; insert title of menu section |
b9f60161 | 1036 | (insert "\n" (cadr menu) "\n\n") |
d1f9f441 | 1037 | |
91c6f26e | 1038 | ;; insert each menu entry |
b9f60161 SM |
1039 | (dolist (entry (reverse (car menu))) |
1040 | (insert "* " entry "\n"))) | |
d1f9f441 | 1041 | |
06cc857d RS |
1042 | ;; Finish menu |
1043 | ||
1044 | ;; @detailmenu (see note above) | |
1045 | ;; Only insert @end detailmenu if a master menu was inserted. | |
1046 | (if master-menu-inserted-p | |
91c6f26e | 1047 | (insert "\n@end detailmenu")) |
06cc857d | 1048 | (insert "\n@end menu\n\n")))) |
7e1335cf | 1049 | |
7e1335cf RC |
1050 | (defun texinfo-locate-menu-p () |
1051 | "Find the next menu in the texinfo file. | |
1052 | If found, leave point after word `menu' on the `@menu' line, and return t. | |
1053 | If a menu is not found, do not move point and return nil." | |
1054 | (re-search-forward "\\(^@menu\\)" nil t)) | |
1055 | ||
b9f60161 | 1056 | (defun texinfo-copy-menu-title () |
7e1335cf RC |
1057 | "Return the title of the section preceding the menu as a string. |
1058 | If such a title cannot be found, return an empty string. Do not move | |
1059 | point." | |
daa6abb8 RS |
1060 | (let ((case-fold-search t)) |
1061 | (save-excursion | |
1062 | (if (re-search-backward | |
91c6f26e KH |
1063 | (concat |
1064 | "\\(^@top" | |
1065 | "\\|" ; or | |
1066 | texinfo-section-types-regexp ; all other section types | |
1067 | "\\)") | |
1068 | nil | |
1069 | t) | |
1070 | (progn | |
1071 | (beginning-of-line) | |
1072 | (forward-word 1) ; skip over section type | |
1073 | (skip-chars-forward " \t") ; and over spaces | |
1074 | (buffer-substring | |
1075 | (point) | |
1076 | (progn (end-of-line) (point)))) | |
1077 | "")))) | |
7e1335cf RC |
1078 | |
1079 | (defun texinfo-copy-menu () | |
1080 | "Return the entries of an existing menu as a list. | |
1081 | Start with point just after the word `menu' in the `@menu' line | |
1082 | and leave point on the line before the `@end menu' line." | |
1083 | (let* (this-menu-list | |
91c6f26e KH |
1084 | (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu' |
1085 | (last-entry (save-excursion ; position of beginning of | |
1086 | ; last `* ' entry | |
1087 | (goto-char end-of-menu) | |
1088 | ;; handle multi-line description | |
1089 | (if (not (re-search-backward "^\\* " nil t)) | |
5b02e712 | 1090 | (error "No entries in menu")) |
91c6f26e | 1091 | (point)))) |
7e1335cf | 1092 | (while (< (point) last-entry) |
c0fbcada | 1093 | (if (re-search-forward "^\\* " end-of-menu t) |
b9f60161 SM |
1094 | (push (buffer-substring |
1095 | (point) | |
1096 | ;; copy multi-line descriptions | |
1097 | (save-excursion | |
1098 | (re-search-forward "\\(^\\* \\|^@e\\)" nil t) | |
1099 | (- (point) 3))) | |
1100 | this-menu-list))) | |
7e1335cf RC |
1101 | this-menu-list)) |
1102 | ||
1103 | \f | |
daa6abb8 | 1104 | ;;; Determining the hierarchical level in the texinfo file |
7e1335cf | 1105 | |
d1f9f441 | 1106 | (defun texinfo-specific-section-type () |
7e1335cf RC |
1107 | "Return the specific type of next section, as a string. |
1108 | For example, \"unnumberedsubsec\". Return \"top\" for top node. | |
1109 | ||
1110 | Searches forward for a section. Hence, point must be before the | |
1111 | section whose type will be found. Does not move point. Signal an | |
1112 | error if the node is not the top node and a section is not found." | |
daa6abb8 RS |
1113 | (let ((case-fold-search t)) |
1114 | (save-excursion | |
1115 | (cond | |
1116 | ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" | |
b9f60161 SM |
1117 | ;; Following search limit by cph but causes a bug |
1118 | ;;(line-end-position) | |
91c6f26e KH |
1119 | nil |
1120 | t) | |
1121 | "top") | |
daa6abb8 | 1122 | ((re-search-forward texinfo-section-types-regexp nil t) |
91c6f26e | 1123 | (buffer-substring-no-properties |
7007e1e3 RS |
1124 | (progn (beginning-of-line) ; copy its name |
1125 | (1+ (point))) | |
1126 | (progn (forward-word 1) | |
1127 | (point)))) | |
daa6abb8 | 1128 | (t |
91c6f26e | 1129 | (error |
5b02e712 | 1130 | "texinfo-specific-section-type: Chapter or section not found")))))) |
7e1335cf RC |
1131 | |
1132 | (defun texinfo-hierarchic-level () | |
1133 | "Return the general hierarchal level of the next node in a texinfo file. | |
1134 | Thus, a subheading or appendixsubsec is of type subsection." | |
daa6abb8 | 1135 | (let ((case-fold-search t)) |
6f602bd0 | 1136 | (cadr (assoc |
b9f60161 SM |
1137 | (texinfo-specific-section-type) |
1138 | texinfo-section-list)))) | |
7e1335cf RC |
1139 | |
1140 | \f | |
daa6abb8 | 1141 | ;;; Locating the major positions |
7e1335cf | 1142 | |
d1f9f441 | 1143 | (defun texinfo-update-menu-region-beginning (level) |
7e1335cf RC |
1144 | "Locate beginning of higher level section this section is within. |
1145 | Return position of the beginning of the node line; do not move point. | |
1146 | Thus, if this level is subsection, searches backwards for section node. | |
1147 | Only argument is a string of the general type of section." | |
daa6abb8 RS |
1148 | (let ((case-fold-search t)) |
1149 | ;; !! Known bug: if section immediately follows top node, this | |
1150 | ;; returns the beginning of the buffer as the beginning of the | |
1151 | ;; higher level section. | |
1152 | (cond | |
6f602bd0 | 1153 | ((< level 3) |
daa6abb8 | 1154 | (save-excursion |
91c6f26e KH |
1155 | (goto-char (point-min)) |
1156 | (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t) | |
1157 | (beginning-of-line) | |
1158 | (point))) | |
daa6abb8 RS |
1159 | (t |
1160 | (save-excursion | |
91c6f26e KH |
1161 | (re-search-backward |
1162 | (concat | |
1163 | "\\(^@node\\).*\n" ; match node line | |
1164 | "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any | |
1165 | "\\|" ; or | |
21324fae GM |
1166 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
1167 | "\\|" ; or | |
1168 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
1169 | "\\)?" ; end of expression | |
91c6f26e KH |
1170 | (eval |
1171 | (cdr (assoc level texinfo-update-menu-higher-regexps)))) | |
1172 | nil | |
1173 | 'goto-beginning) | |
1174 | (point)))))) | |
7e1335cf | 1175 | |
d1f9f441 | 1176 | (defun texinfo-update-menu-region-end (level) |
7e1335cf RC |
1177 | "Locate end of higher level section this section is within. |
1178 | Return position; do not move point. Thus, if this level is a | |
1179 | subsection, find the node for the section this subsection is within. | |
1180 | If level is top or chapter, returns end of file. Only argument is a | |
1181 | string of the general type of section." | |
daa6abb8 RS |
1182 | (let ((case-fold-search t)) |
1183 | (save-excursion | |
1184 | (if (re-search-forward | |
91c6f26e KH |
1185 | (concat |
1186 | "\\(^@node\\).*\n" ; match node line | |
1187 | "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any | |
1188 | "\\|" ; or | |
21324fae GM |
1189 | "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
1190 | "\\|" ; or | |
1191 | "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any | |
1192 | "\\)?" ; end of expression | |
91c6f26e KH |
1193 | (eval |
1194 | ;; Never finds end of level above chapter so goes to end. | |
1195 | (cdr (assoc level texinfo-update-menu-higher-regexps)))) | |
1196 | nil | |
1197 | 'goto-end) | |
1198 | (match-beginning 1) | |
1199 | (point-max))))) | |
7e1335cf RC |
1200 | |
1201 | (defun texinfo-menu-first-node (beginning end) | |
d1f9f441 | 1202 | "Locate first node of the section the menu will be placed in. |
7e1335cf | 1203 | Return position; do not move point. |
d1f9f441 | 1204 | The menu will be located just before this position. |
7e1335cf RC |
1205 | |
1206 | First argument is the position of the beginning of the section in | |
1207 | which the menu will be located; second argument is the position of the | |
1208 | end of that region; it limits the search." | |
d1f9f441 | 1209 | |
7e1335cf RC |
1210 | (save-excursion |
1211 | (goto-char beginning) | |
1212 | (forward-line 1) | |
1213 | (re-search-forward "^@node" end t) | |
1214 | (beginning-of-line) | |
1215 | (point))) | |
1216 | ||
1217 | \f | |
daa6abb8 | 1218 | ;;; Updating a node |
7e1335cf | 1219 | |
78897d3d | 1220 | (defun texinfo-update-node (&optional beginning end) |
7e1335cf | 1221 | "Without any prefix argument, update the node in which point is located. |
78897d3d | 1222 | Interactively, a prefix argument means to operate on the region. |
7e1335cf RC |
1223 | |
1224 | The functions for creating or updating nodes and menus, and their | |
1225 | keybindings, are: | |
1226 | ||
78897d3d | 1227 | texinfo-update-node (&optional beginning end) \\[texinfo-update-node] |
7e1335cf RC |
1228 | texinfo-every-node-update () \\[texinfo-every-node-update] |
1229 | texinfo-sequential-node-update (&optional region-p) | |
1230 | ||
1231 | texinfo-make-menu (&optional region-p) \\[texinfo-make-menu] | |
1232 | texinfo-all-menus-update () \\[texinfo-all-menus-update] | |
1233 | texinfo-master-menu () | |
1234 | ||
1235 | texinfo-indent-menu-description (column &optional region-p) | |
1236 | ||
1237 | The `texinfo-column-for-description' variable specifies the column to | |
daa6abb8 | 1238 | which menu descriptions are indented. Its default value is 32." |
d1f9f441 | 1239 | |
78897d3d RS |
1240 | (interactive |
1241 | (if prefix-arg | |
1242 | (list (point) (mark)))) | |
1243 | (if (null beginning) | |
1244 | ;; Update a single node. | |
b9f60161 | 1245 | (let ((auto-fill-function nil)) |
91c6f26e KH |
1246 | (if (not (re-search-backward "^@node" (point-min) t)) |
1247 | (error "Node line not found before this position")) | |
1248 | (texinfo-update-the-node) | |
1249 | (message "Done...updated the node. You may save the buffer.")) | |
7e1335cf | 1250 | ;; else |
b9f60161 | 1251 | (let ((auto-fill-function nil)) |
78897d3d RS |
1252 | (save-excursion |
1253 | (save-restriction | |
1254 | (narrow-to-region beginning end) | |
1255 | (goto-char (point-min)) | |
1256 | (while (re-search-forward "^@node" (point-max) t) | |
d1f9f441 | 1257 | (beginning-of-line) |
78897d3d RS |
1258 | (texinfo-update-the-node)) |
1259 | (goto-char (point-max)) | |
1260 | (message "Done...nodes updated in region. You may save the buffer.")))))) | |
7e1335cf RC |
1261 | |
1262 | (defun texinfo-every-node-update () | |
1263 | "Update every node in a Texinfo file." | |
1264 | (interactive) | |
1265 | (save-excursion | |
78897d3d | 1266 | (texinfo-update-node (point-min) (point-max)) |
8039284a | 1267 | (message "Done...updated every node. You may save the buffer."))) |
7e1335cf RC |
1268 | |
1269 | (defun texinfo-update-the-node () | |
d1f9f441 | 1270 | "Update one node. Point must be at the beginning of node line. |
7e1335cf RC |
1271 | Leave point at the end of the node line." |
1272 | (texinfo-check-for-node-name) | |
1273 | (texinfo-delete-existing-pointers) | |
1274 | (message "Updating node: %s ... " (texinfo-copy-node-name)) | |
1275 | (save-restriction | |
1276 | (widen) | |
1277 | (let* | |
91c6f26e KH |
1278 | ((case-fold-search t) |
1279 | (level (texinfo-hierarchic-level)) | |
1280 | (beginning (texinfo-update-menu-region-beginning level)) | |
1281 | (end (texinfo-update-menu-region-end level))) | |
6f602bd0 | 1282 | (if (eq level 1) |
91c6f26e KH |
1283 | (texinfo-top-pointer-case) |
1284 | ;; else | |
1285 | (texinfo-insert-pointer beginning end level 'next) | |
1286 | (texinfo-insert-pointer beginning end level 'previous) | |
1287 | (texinfo-insert-pointer beginning end level 'up) | |
1288 | (texinfo-clean-up-node-line))))) | |
7e1335cf RC |
1289 | |
1290 | (defun texinfo-top-pointer-case () | |
1291 | "Insert pointers in the Top node. This is a special case. | |
1292 | ||
1293 | The `Next' pointer is a pointer to a chapter or section at a lower | |
1294 | hierarchical level in the file. The `Previous' and `Up' pointers are | |
1295 | to `(dir)'. Point must be at the beginning of the node line, and is | |
1296 | left at the end of the node line." | |
1297 | ||
1298 | (texinfo-clean-up-node-line) | |
d1f9f441 | 1299 | (insert ", " |
91c6f26e KH |
1300 | (save-excursion |
1301 | ;; There may be an @chapter or other such command between | |
1302 | ;; the top node line and the next node line, as a title | |
1303 | ;; for an `ifinfo' section. This @chapter command must | |
1304 | ;; must be skipped. So the procedure is to search for | |
1305 | ;; the next `@node' line, and then copy its name. | |
1306 | (if (re-search-forward "^@node" nil t) | |
1307 | (progn | |
1308 | (beginning-of-line) | |
1309 | (texinfo-copy-node-name)) | |
1310 | " ")) | |
1311 | ", (dir), (dir)")) | |
7e1335cf RC |
1312 | |
1313 | (defun texinfo-check-for-node-name () | |
1314 | "Determine whether the node has a node name. Prompt for one if not. | |
1315 | Point must be at beginning of node line. Does not move point." | |
1316 | (save-excursion | |
daa6abb8 RS |
1317 | (let ((initial (texinfo-copy-next-section-title))) |
1318 | ;; This is not clean. Use `interactive' to read the arg. | |
1319 | (forward-word 1) ; skip over node command | |
1320 | (skip-chars-forward " \t") ; and over spaces | |
1321 | (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what Info looks for | |
91c6f26e KH |
1322 | ; alternatively, use "[a-zA-Z]+" |
1323 | (let ((node-name | |
1324 | (read-from-minibuffer | |
1325 | "Node name (use no @, commas, colons, or apostrophes): " | |
1326 | initial))) | |
1327 | (insert " " node-name)))))) | |
7e1335cf RC |
1328 | |
1329 | (defun texinfo-delete-existing-pointers () | |
d1f9f441 | 1330 | "Delete `Next', `Previous', and `Up' pointers. |
7e1335cf RC |
1331 | Starts from the current position of the cursor, and searches forward |
1332 | on the line for a comma and if one is found, deletes the rest of the | |
1333 | line, including the comma. Leaves point at beginning of line." | |
2db10f13 KH |
1334 | (let ((eol-point (save-excursion (end-of-line) (point)))) |
1335 | (if (search-forward "," eol-point t) | |
91c6f26e | 1336 | (delete-region (1- (point)) eol-point))) |
7e1335cf RC |
1337 | (beginning-of-line)) |
1338 | ||
1339 | (defun texinfo-find-pointer (beginning end level direction) | |
1340 | "Move point to section associated with next, previous, or up pointer. | |
06cc857d | 1341 | Return type of pointer (either `normal' or `no-pointer'). |
7e1335cf RC |
1342 | |
1343 | The first and second arguments bound the search for a pointer to the | |
1344 | beginning and end, respectively, of the enclosing higher level | |
1345 | section. The third argument is a string specifying the general kind | |
d460a763 | 1346 | of section such as \"chapter\" or \"section\". When looking for the |
7e1335cf RC |
1347 | `Next' pointer, the section found will be at the same hierarchical |
1348 | level in the Texinfo file; when looking for the `Previous' pointer, | |
1349 | the section found will be at the same or higher hierarchical level in | |
1350 | the Texinfo file; when looking for the `Up' pointer, the section found | |
1351 | will be at some level higher in the Texinfo file. The fourth argument | |
1352 | \(one of 'next, 'previous, or 'up\) specifies whether to find the | |
1353 | `Next', `Previous', or `Up' pointer." | |
daa6abb8 RS |
1354 | (let ((case-fold-search t)) |
1355 | (cond ((eq direction 'next) | |
91c6f26e KH |
1356 | (forward-line 3) ; skip over current node |
1357 | ;; Search for section commands accompanied by node lines; | |
1358 | ;; ignore section commands in the middle of nodes. | |
1359 | (if (re-search-forward | |
21324fae | 1360 | ;; A `Top' node is never a next pointer, so won't find it. |
91c6f26e KH |
1361 | (concat |
1362 | ;; Match node line. | |
1363 | "\\(^@node\\).*\n" | |
21324fae GM |
1364 | ;; Match comment, ifinfo, ifnottex line, if any |
1365 | (concat | |
1366 | "\\(\\(" | |
1367 | "\\(^@c\\).*\n\\)" | |
1368 | "\\|" | |
1369 | "\\(^@ifinfo[ ]*\n\\)" | |
1370 | "\\|" | |
1371 | "\\(^@ifnottex[ ]*\n\\)" | |
1372 | "\\)?") | |
91c6f26e KH |
1373 | (eval |
1374 | (cdr (assoc level texinfo-update-menu-same-level-regexps)))) | |
1375 | end | |
1376 | t) | |
1377 | 'normal | |
1378 | 'no-pointer)) | |
1379 | ((eq direction 'previous) | |
1380 | (if (re-search-backward | |
1381 | (concat | |
1382 | "\\(" | |
1383 | ;; Match node line. | |
1384 | "\\(^@node\\).*\n" | |
21324fae GM |
1385 | ;; Match comment, ifinfo, ifnottex line, if any |
1386 | (concat | |
1387 | "\\(\\(" | |
1388 | "\\(^@c\\).*\n\\)" | |
1389 | "\\|" | |
1390 | "\\(^@ifinfo[ ]*\n\\)" | |
1391 | "\\|" | |
1392 | "\\(^@ifnottex[ ]*\n\\)" | |
1393 | "\\)?") | |
91c6f26e KH |
1394 | (eval |
1395 | (cdr (assoc level texinfo-update-menu-same-level-regexps))) | |
1396 | "\\|" | |
1397 | ;; Match node line. | |
1398 | "\\(^@node\\).*\n" | |
21324fae GM |
1399 | ;; Match comment, ifinfo, ifnottex line, if any |
1400 | (concat | |
1401 | "\\(\\(" | |
1402 | "\\(^@c\\).*\n\\)" | |
1403 | "\\|" | |
1404 | "\\(^@ifinfo[ ]*\n\\)" | |
1405 | "\\|" | |
1406 | "\\(^@ifnottex[ ]*\n\\)" | |
1407 | "\\)?") | |
91c6f26e KH |
1408 | (eval |
1409 | (cdr (assoc level texinfo-update-menu-higher-regexps))) | |
1410 | "\\|" | |
1411 | ;; Handle `Top' node specially. | |
1412 | "^@node [ \t]*top[ \t]*\\(,\\|$\\)" | |
1413 | "\\)") | |
1414 | beginning | |
1415 | t) | |
1416 | 'normal | |
1417 | 'no-pointer)) | |
1418 | ((eq direction 'up) | |
1419 | (if (re-search-backward | |
1420 | (concat | |
1421 | "\\(" | |
1422 | ;; Match node line. | |
1423 | "\\(^@node\\).*\n" | |
21324fae GM |
1424 | ;; Match comment, ifinfo, ifnottex line, if any |
1425 | (concat | |
1426 | "\\(\\(" | |
1427 | "\\(^@c\\).*\n\\)" | |
1428 | "\\|" | |
1429 | "\\(^@ifinfo[ ]*\n\\)" | |
1430 | "\\|" | |
1431 | "\\(^@ifnottex[ ]*\n\\)" | |
1432 | "\\)?") | |
91c6f26e KH |
1433 | (eval (cdr (assoc level texinfo-update-menu-higher-regexps))) |
1434 | "\\|" | |
1435 | ;; Handle `Top' node specially. | |
1436 | "^@node [ \t]*top[ \t]*\\(,\\|$\\)" | |
1437 | "\\)") | |
1438 | (save-excursion | |
1439 | (goto-char beginning) | |
1440 | (beginning-of-line) | |
1441 | (point)) | |
1442 | t) | |
1443 | 'normal | |
1444 | 'no-pointer)) | |
1445 | (t | |
1446 | (error "texinfo-find-pointer: lack proper arguments"))))) | |
7e1335cf RC |
1447 | |
1448 | (defun texinfo-pointer-name (kind) | |
1449 | "Return the node name preceding the section command. | |
06cc857d | 1450 | The argument is the kind of section, either `normal' or `no-pointer'." |
7e1335cf RC |
1451 | (let (name) |
1452 | (cond ((eq kind 'normal) | |
91c6f26e KH |
1453 | (end-of-line) ; this handles prev node top case |
1454 | (re-search-backward ; when point is already | |
1455 | "^@node" ; at the beginning of @node line | |
1456 | (save-excursion (forward-line -3)) | |
1457 | t) | |
1458 | (setq name (texinfo-copy-node-name))) | |
7e1335cf | 1459 | ((eq kind 'no-pointer) |
91c6f26e KH |
1460 | ;; Don't need to put a blank in the pointer slot, |
1461 | ;; since insert "' " always has a space | |
7e1335cf RC |
1462 | (setq name " "))) ; put a blank in the pointer slot |
1463 | name)) | |
1464 | ||
1465 | (defun texinfo-insert-pointer (beginning end level direction) | |
1466 | "Insert the `Next', `Previous' or `Up' node name at point. | |
d1f9f441 | 1467 | Move point forward. |
7e1335cf RC |
1468 | |
1469 | The first and second arguments bound the search for a pointer to the | |
1470 | beginning and end, respectively, of the enclosing higher level | |
1471 | section. The third argument is the hierarchical level of the Texinfo | |
1472 | file, a string such as \"section\". The fourth argument is direction | |
06cc857d | 1473 | towards which the pointer is directed, one of `next', `previous', or `up'." |
7e1335cf RC |
1474 | |
1475 | (end-of-line) | |
1476 | (insert | |
1477 | ", " | |
1478 | (save-excursion | |
1479 | (texinfo-pointer-name | |
1480 | (texinfo-find-pointer beginning end level direction))))) | |
1481 | ||
1482 | (defun texinfo-clean-up-node-line () | |
1483 | "Remove extra commas, if any, at end of node line." | |
1484 | (end-of-line) | |
1485 | (skip-chars-backward ", ") | |
1486 | (delete-region (point) (save-excursion (end-of-line) (point)))) | |
1487 | ||
1488 | \f | |
daa6abb8 | 1489 | ;;; Updating nodes sequentially |
06cc857d RS |
1490 | ;; These sequential update functions insert `Next' or `Previous' |
1491 | ;; pointers that point to the following or preceding nodes even if they | |
1492 | ;; are at higher or lower hierarchical levels. This means that if a | |
1493 | ;; section contains one or more subsections, the section's `Next' | |
1494 | ;; pointer will point to the subsection and not the following section. | |
1495 | ;; (The subsection to which `Next' points will most likely be the first | |
1496 | ;; item on the section's menu.) | |
7e1335cf RC |
1497 | |
1498 | (defun texinfo-sequential-node-update (&optional region-p) | |
1499 | "Update one node (or many) in a Texinfo file with sequential pointers. | |
1500 | ||
1501 | This function causes the `Next' or `Previous' pointer to point to the | |
1502 | immediately preceding or following node, even if it is at a higher or | |
1503 | lower hierarchical level in the document. Continually pressing `n' or | |
1504 | `p' takes you straight through the file. | |
1505 | ||
1506 | Without any prefix argument, update the node in which point is located. | |
1507 | Non-nil argument (prefix, if interactive) means update the nodes in the | |
1508 | marked region. | |
1509 | ||
1510 | This command makes it awkward to navigate among sections and | |
1511 | subsections; it should be used only for those documents that are meant | |
1512 | to be read like a novel rather than a reference, and for which the | |
1513 | Info `g*' command is inadequate." | |
d1f9f441 | 1514 | |
7e1335cf RC |
1515 | (interactive "P") |
1516 | (if (not region-p) | |
fe3371ef | 1517 | ;; update a single node |
b9f60161 | 1518 | (let ((auto-fill-function nil)) |
91c6f26e | 1519 | (if (not (re-search-backward "^@node" (point-min) t)) |
5b02e712 | 1520 | (error "Node line not found before this position")) |
91c6f26e KH |
1521 | (texinfo-sequentially-update-the-node) |
1522 | (message | |
1523 | "Done...sequentially updated the node . You may save the buffer.")) | |
7e1335cf | 1524 | ;; else |
e5d77022 | 1525 | (let ((auto-fill-function nil) |
91c6f26e KH |
1526 | (beginning (region-beginning)) |
1527 | (end (region-end))) | |
7e1335cf | 1528 | (if (= end beginning) |
5b02e712 | 1529 | (error "Please mark a region")) |
7e1335cf | 1530 | (save-restriction |
91c6f26e KH |
1531 | (narrow-to-region beginning end) |
1532 | (goto-char beginning) | |
1533 | (push-mark (point) t) | |
1534 | (while (re-search-forward "^@node" (point-max) t) | |
1535 | (beginning-of-line) | |
1536 | (texinfo-sequentially-update-the-node)) | |
1537 | (message | |
1538 | "Done...updated the nodes in sequence. You may save the buffer."))))) | |
7e1335cf RC |
1539 | |
1540 | (defun texinfo-sequentially-update-the-node () | |
d1f9f441 | 1541 | "Update one node such that the pointers are sequential. |
7e1335cf RC |
1542 | A `Next' or `Previous' pointer points to any preceding or following node, |
1543 | regardless of its hierarchical level." | |
1544 | ||
6f602bd0 SM |
1545 | (texinfo-check-for-node-name) |
1546 | (texinfo-delete-existing-pointers) | |
1547 | (message | |
1548 | "Sequentially updating node: %s ... " (texinfo-copy-node-name)) | |
1549 | (save-restriction | |
1550 | (widen) | |
1551 | (let* ((case-fold-search t) | |
1552 | (level (texinfo-hierarchic-level))) | |
1553 | (if (eq level 1) | |
1554 | (texinfo-top-pointer-case) | |
1555 | ;; else | |
1556 | (texinfo-sequentially-insert-pointer level 'next) | |
1557 | (texinfo-sequentially-insert-pointer level 'previous) | |
1558 | (texinfo-sequentially-insert-pointer level 'up) | |
1559 | (texinfo-clean-up-node-line))))) | |
7e1335cf | 1560 | |
a056c2c7 RC |
1561 | (defun texinfo-sequentially-insert-pointer (level direction) |
1562 | "Insert the `Next', `Previous' or `Up' node name at point. | |
1563 | Move point forward. | |
1564 | ||
1565 | The first argument is the hierarchical level of the Texinfo file, a | |
1566 | string such as \"section\". The second argument is direction, one of | |
1567 | `next', `previous', or `up'." | |
1568 | ||
1569 | (end-of-line) | |
1570 | (insert | |
1571 | ", " | |
1572 | (save-excursion | |
1573 | (texinfo-pointer-name | |
1574 | (texinfo-sequentially-find-pointer level direction))))) | |
1575 | ||
7e1335cf RC |
1576 | (defun texinfo-sequentially-find-pointer (level direction) |
1577 | "Find next or previous pointer sequentially in Texinfo file, or up pointer. | |
1578 | Move point to section associated with the pointer. Find point even if | |
1579 | it is in a different section. | |
1580 | ||
06cc857d | 1581 | Return type of pointer (either `normal' or `no-pointer'). |
7e1335cf RC |
1582 | |
1583 | The first argument is a string specifying the general kind of section | |
d460a763 | 1584 | such as \"chapter\" or \"section\". The section found will be at the |
7e1335cf | 1585 | same hierarchical level in the Texinfo file, or, in the case of the up |
06cc857d RS |
1586 | pointer, some level higher. The second argument (one of `next', |
1587 | `previous', or `up') specifies whether to find the `Next', `Previous', | |
7e1335cf | 1588 | or `Up' pointer." |
d1f9f441 | 1589 | (let ((case-fold-search t)) |
daa6abb8 | 1590 | (cond ((eq direction 'next) |
91c6f26e KH |
1591 | (forward-line 3) ; skip over current node |
1592 | (if (re-search-forward | |
1593 | texinfo-section-types-regexp | |
1594 | (point-max) | |
1595 | t) | |
1596 | 'normal | |
1597 | 'no-pointer)) | |
1598 | ((eq direction 'previous) | |
1599 | (if (re-search-backward | |
1600 | texinfo-section-types-regexp | |
1601 | (point-min) | |
1602 | t) | |
1603 | 'normal | |
1604 | 'no-pointer)) | |
1605 | ((eq direction 'up) | |
1606 | (if (re-search-backward | |
1607 | (eval (cdr (assoc level texinfo-update-menu-higher-regexps))) | |
a056c2c7 | 1608 | (point-min) |
91c6f26e KH |
1609 | t) |
1610 | 'normal | |
1611 | 'no-pointer)) | |
1612 | (t | |
1613 | (error "texinfo-sequential-find-pointer: lack proper arguments"))))) | |
7e1335cf | 1614 | |
7e1335cf | 1615 | \f |
daa6abb8 | 1616 | ;;; Inserting `@node' lines |
06cc857d RS |
1617 | ;; The `texinfo-insert-node-lines' function inserts `@node' lines as needed |
1618 | ;; before the `@chapter', `@section', and such like lines of a region | |
1619 | ;; in a Texinfo file. | |
7e1335cf | 1620 | |
daa6abb8 | 1621 | (defun texinfo-insert-node-lines (beginning end &optional title-p) |
7e1335cf RC |
1622 | "Insert missing `@node' lines in region of Texinfo file. |
1623 | Non-nil argument (prefix, if interactive) means also to insert the | |
1624 | section titles as node names; and also to insert the section titles as | |
06cc857d | 1625 | node names in pre-existing `@node' lines that lack names." |
daa6abb8 RS |
1626 | (interactive "r\nP") |
1627 | ||
1628 | ;; Use marker; after inserting node lines, leave point at end of | |
1629 | ;; region and mark at beginning. | |
1630 | ||
1631 | (let (beginning-marker end-marker title last-section-position) | |
1632 | ||
1633 | ;; Save current position on mark ring and set mark to end. | |
d1f9f441 RS |
1634 | (push-mark end t) |
1635 | (setq end-marker (mark-marker)) | |
daa6abb8 RS |
1636 | |
1637 | (goto-char beginning) | |
1638 | (while (re-search-forward | |
91c6f26e KH |
1639 | texinfo-section-types-regexp |
1640 | end-marker | |
1641 | 'end) | |
daa6abb8 RS |
1642 | ;; Copy title if desired. |
1643 | (if title-p | |
91c6f26e KH |
1644 | (progn |
1645 | (beginning-of-line) | |
1646 | (forward-word 1) | |
1647 | (skip-chars-forward " \t") | |
1648 | (setq title (buffer-substring | |
1649 | (point) | |
1650 | (save-excursion (end-of-line) (point)))))) | |
daa6abb8 RS |
1651 | ;; Insert node line if necessary. |
1652 | (if (re-search-backward | |
91c6f26e KH |
1653 | "^@node" |
1654 | ;; Avoid finding previous node line if node lines are close. | |
1655 | (or last-section-position | |
1656 | (save-excursion (forward-line -2) (point))) t) | |
1657 | ;; @node is present, and point at beginning of that line | |
1658 | (forward-word 1) ; Leave point just after @node. | |
1659 | ;; Else @node missing; insert one. | |
1660 | (beginning-of-line) ; Beginning of `@section' line. | |
1661 | (insert "@node\n") | |
1662 | (backward-char 1)) ; Leave point just after `@node'. | |
daa6abb8 RS |
1663 | ;; Insert title if desired. |
1664 | (if title-p | |
91c6f26e KH |
1665 | (progn |
1666 | (skip-chars-forward " \t") | |
1667 | ;; Use regexp based on what info looks for | |
1668 | ;; (alternatively, use "[a-zA-Z]+"); | |
1669 | ;; this means we only insert a title if none exists. | |
1670 | (if (not (looking-at "[^,\t\n ]+")) | |
1671 | (progn | |
1672 | (beginning-of-line) | |
1673 | (forward-word 1) | |
1674 | (insert " " title) | |
1675 | (message "Inserted title %s ... " title))))) | |
daa6abb8 | 1676 | ;; Go forward beyond current section title. |
d1f9f441 | 1677 | (re-search-forward texinfo-section-types-regexp |
91c6f26e | 1678 | (save-excursion (forward-line 3) (point)) t) |
daa6abb8 RS |
1679 | (setq last-section-position (point)) |
1680 | (forward-line 1)) | |
1681 | ||
1682 | ;; Leave point at end of region, mark at beginning. | |
1683 | (set-mark beginning) | |
1684 | ||
1685 | (if title-p | |
7e1335cf RC |
1686 | (message |
1687 | "Done inserting node lines and titles. You may save the buffer.") | |
daa6abb8 | 1688 | (message "Done inserting node lines. You may save the buffer.")))) |
7e1335cf RC |
1689 | |
1690 | \f | |
daa6abb8 | 1691 | ;;; Update and create menus for multi-file Texinfo sources |
7e1335cf | 1692 | |
d1f9f441 | 1693 | ;; 1. M-x texinfo-multiple-files-update |
7e1335cf RC |
1694 | ;; |
1695 | ;; Read the include file list of an outer Texinfo file and | |
1696 | ;; update all highest level nodes in the files listed and insert a | |
1697 | ;; main menu in the outer file after its top node. | |
1698 | ||
d1f9f441 | 1699 | ;; 2. C-u M-x texinfo-multiple-files-update |
7e1335cf RC |
1700 | ;; |
1701 | ;; Same as 1, but insert a master menu. (Saves reupdating lower | |
1702 | ;; level menus and nodes.) This command simply reads every menu, | |
1703 | ;; so if the menus are wrong, the master menu will be wrong. | |
1704 | ;; Similarly, if the lower level node pointers are wrong, they | |
1705 | ;; will stay wrong. | |
1706 | ||
d1f9f441 | 1707 | ;; 3. C-u 2 M-x texinfo-multiple-files-update |
7e1335cf RC |
1708 | ;; |
1709 | ;; Read the include file list of an outer Texinfo file and | |
1710 | ;; update all nodes and menus in the files listed and insert a | |
1711 | ;; master menu in the outer file after its top node. | |
1712 | ||
1713 | ;;; Note: these functions: | |
1714 | ;;; | |
1715 | ;;; * Do not save or delete any buffers. You may fill up your memory. | |
d1f9f441 | 1716 | ;;; * Do not handle any pre-existing nodes in outer file. |
7e1335cf RC |
1717 | ;;; Hence, you may need a file for indices. |
1718 | ||
1719 | \f | |
daa6abb8 | 1720 | ;;; Auxiliary functions for multiple file updating |
7e1335cf RC |
1721 | |
1722 | (defun texinfo-multi-file-included-list (outer-file) | |
1723 | "Return a list of the included files in OUTER-FILE." | |
1724 | (let ((included-file-list (list outer-file)) | |
91c6f26e | 1725 | start) |
7e1335cf | 1726 | (save-excursion |
b9f60161 | 1727 | (set-buffer (find-file-noselect outer-file)) |
7e1335cf RC |
1728 | (widen) |
1729 | (goto-char (point-min)) | |
1730 | (while (re-search-forward "^@include" nil t) | |
91c6f26e KH |
1731 | (skip-chars-forward " \t") |
1732 | (setq start (point)) | |
1733 | (end-of-line) | |
1734 | (skip-chars-backward " \t") | |
1735 | (setq included-file-list | |
1736 | (cons (buffer-substring start (point)) | |
1737 | included-file-list))) | |
7e1335cf RC |
1738 | (nreverse included-file-list)))) |
1739 | ||
1740 | (defun texinfo-copy-next-section-title () | |
1741 | "Return the name of the immediately following section as a string. | |
1742 | ||
1743 | Start with point at the beginning of the node line. Leave point at the | |
1744 | same place. If there is no title, returns an empty string." | |
1745 | ||
1746 | (save-excursion | |
1747 | (end-of-line) | |
d1f9f441 | 1748 | (let ((node-end (or |
91c6f26e KH |
1749 | (save-excursion |
1750 | (if (re-search-forward "\\(^@node\\)" nil t) | |
1751 | (match-beginning 0))) | |
1752 | (point-max)))) | |
daa6abb8 | 1753 | (if (re-search-forward texinfo-section-types-regexp node-end t) |
91c6f26e KH |
1754 | (progn |
1755 | (beginning-of-line) | |
1756 | ;; copy title | |
1757 | (let ((title | |
1758 | (buffer-substring | |
1759 | (progn (forward-word 1) ; skip over section type | |
1760 | (skip-chars-forward " \t") ; and over spaces | |
1761 | (point)) | |
1762 | (progn (end-of-line) (point))))) | |
1763 | title)) | |
1764 | "")))) | |
7e1335cf RC |
1765 | |
1766 | (defun texinfo-multi-file-update (files &optional update-everything) | |
1767 | "Update first node pointers in each file in FILES. | |
daa6abb8 | 1768 | Return a list of the node names. |
7e1335cf RC |
1769 | |
1770 | The first file in the list is an outer file; the remaining are | |
1771 | files included in the outer file with `@include' commands. | |
1772 | ||
1773 | If optional arg UPDATE-EVERYTHING non-nil, update every menu and | |
1774 | pointer in each of the included files. | |
1775 | ||
1776 | Also update the `Top' level node pointers of the outer file. | |
1777 | ||
1778 | Requirements: | |
1779 | ||
1780 | * the first file in the FILES list must be the outer file, | |
1781 | * each of the included files must contain exactly one highest | |
d1f9f441 | 1782 | hierarchical level node, |
7e1335cf RC |
1783 | * this node must be the first node in the included file, |
1784 | * each highest hierarchical level node must be of the same type. | |
1785 | ||
12b795e1 RC |
1786 | Thus, normally, each included file contains one, and only one, chapter. |
1787 | ||
1788 | However, when an included file does not have any node lines in | |
1789 | it, this command does not try to create a menu entry for it. | |
1790 | Consequently, you can include any file, such as a version or an | |
1791 | update file without node lines, not just files that are | |
1792 | chapters." | |
7e1335cf | 1793 | |
06cc857d | 1794 | ;; The menu-list has the form: |
d1f9f441 RS |
1795 | ;; |
1796 | ;; \(\(\"node-name1\" . \"title1\"\) | |
06cc857d | 1797 | ;; \(\"node-name2\" . \"title2\"\) ... \) |
d1f9f441 | 1798 | ;; |
06cc857d RS |
1799 | ;; However, there does not need to be a title field and this function |
1800 | ;; does not fill it; however a comment tells you how to do so. | |
1801 | ;; You would use the title field if you wanted to insert titles in the | |
1802 | ;; description slot of a menu as a description. | |
d1f9f441 | 1803 | |
daa6abb8 | 1804 | (let ((case-fold-search t) |
d7fc69d1 | 1805 | menu-list next-node-name previous-node-name files-with-node-lines) |
d1f9f441 | 1806 | |
d7fc69d1 RC |
1807 | ;; Create a new list of included files that only have node lines |
1808 | (while files | |
1809 | (set-buffer (find-file-noselect (car files))) | |
1810 | (widen) | |
1811 | (goto-char (point-min)) | |
1812 | (when (re-search-forward "^@node" nil t) | |
1813 | (setq files-with-node-lines (cons (car files) files-with-node-lines))) | |
1814 | (setq files (cdr files))) | |
1815 | (setq files-with-node-lines (nreverse files-with-node-lines)) | |
1816 | ||
1817 | ;; Find the name of the first node in a subsequent file | |
1818 | ;; and copy it into the variable next-node-name | |
1819 | (set-buffer (find-file-noselect (car (cdr files-with-node-lines)))) | |
7e1335cf RC |
1820 | (widen) |
1821 | (goto-char (point-min)) | |
7e1335cf RC |
1822 | (beginning-of-line) |
1823 | (texinfo-check-for-node-name) | |
1824 | (setq next-node-name (texinfo-copy-node-name)) | |
b9f60161 SM |
1825 | (push (cons next-node-name (prog1 "" (forward-line 1))) |
1826 | ;; Use following to insert section titles automatically. | |
1827 | ;; (texinfo-copy-next-section-title) | |
1828 | menu-list) | |
daa6abb8 | 1829 | |
7e1335cf | 1830 | ;; Go to outer file |
d7fc69d1 RC |
1831 | ;; `pop' is analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))) |
1832 | (set-buffer (find-file-noselect (pop files-with-node-lines))) | |
7e1335cf | 1833 | (goto-char (point-min)) |
82ac4b77 | 1834 | (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) |
5b02e712 | 1835 | (error "This buffer needs a Top node")) |
7e1335cf RC |
1836 | (beginning-of-line) |
1837 | (texinfo-delete-existing-pointers) | |
1838 | (end-of-line) | |
1839 | (insert ", " next-node-name ", (dir), (dir)") | |
1840 | (beginning-of-line) | |
1841 | (setq previous-node-name "Top") | |
d1f9f441 | 1842 | |
d7fc69d1 | 1843 | (while files-with-node-lines |
d1f9f441 | 1844 | |
d7fc69d1 | 1845 | (if (not (cdr files-with-node-lines)) |
91c6f26e KH |
1846 | ;; No next file |
1847 | (setq next-node-name "") | |
1848 | ;; Else, | |
1849 | ;; find the name of the first node in the next file. | |
d7fc69d1 | 1850 | (set-buffer (find-file-noselect (car (cdr files-with-node-lines)))) |
91c6f26e KH |
1851 | (widen) |
1852 | (goto-char (point-min)) | |
91c6f26e KH |
1853 | (beginning-of-line) |
1854 | (texinfo-check-for-node-name) | |
1855 | (setq next-node-name (texinfo-copy-node-name)) | |
b9f60161 SM |
1856 | (push (cons next-node-name (prog1 "" (forward-line 1))) |
1857 | ;; Use following to insert section titles automatically. | |
1858 | ;; (texinfo-copy-next-section-title) | |
1859 | menu-list)) | |
7e1335cf RC |
1860 | |
1861 | ;; Go to node to be updated. | |
d7fc69d1 | 1862 | (set-buffer (find-file-noselect (car files-with-node-lines))) |
7e1335cf | 1863 | (goto-char (point-min)) |
7e1335cf | 1864 | (beginning-of-line) |
d1f9f441 | 1865 | |
daa6abb8 RS |
1866 | ;; Update other menus and nodes if requested. |
1867 | (if update-everything (texinfo-all-menus-update t)) | |
1868 | ||
1869 | (beginning-of-line) | |
7e1335cf RC |
1870 | (texinfo-delete-existing-pointers) |
1871 | (end-of-line) | |
b9f60161 | 1872 | (insert ", " next-node-name ", " previous-node-name ", Top") |
d1f9f441 | 1873 | |
7e1335cf RC |
1874 | (beginning-of-line) |
1875 | (setq previous-node-name (texinfo-copy-node-name)) | |
d1f9f441 | 1876 | |
d7fc69d1 | 1877 | (setq files-with-node-lines (cdr files-with-node-lines))) |
7e1335cf RC |
1878 | (nreverse menu-list))) |
1879 | ||
1880 | (defun texinfo-multi-files-insert-main-menu (menu-list) | |
1881 | "Insert formatted main menu at point. | |
1882 | Indents the first line of the description, if any, to the value of | |
06cc857d | 1883 | `texinfo-column-for-description'." |
7e1335cf RC |
1884 | |
1885 | (insert "@menu\n") | |
b9f60161 | 1886 | (dolist (entry menu-list) |
daa6abb8 RS |
1887 | ;; Every menu entry starts with a star and a space. |
1888 | (insert "* ") | |
d1f9f441 | 1889 | |
daa6abb8 | 1890 | ;; Insert the node name (and menu entry name, if present). |
b9f60161 | 1891 | (let ((node-part (car entry))) |
daa6abb8 | 1892 | (if (stringp node-part) |
91c6f26e KH |
1893 | ;; "Double colon" entry line; menu entry and node name are the same, |
1894 | (insert (format "%s::" node-part)) | |
1895 | ;; "Single colon" entry line; menu entry and node name are different. | |
1896 | (insert (format "%s: %s." (car node-part) (cdr node-part))))) | |
d1f9f441 | 1897 | |
daa6abb8 | 1898 | ;; Insert the description, if present. |
b9f60161 SM |
1899 | (when (cdr entry) |
1900 | ;; Move to right place. | |
1901 | (indent-to texinfo-column-for-description 2) | |
1902 | ;; Insert description. | |
1903 | (insert (format "%s" (cdr entry)))) | |
daa6abb8 | 1904 | |
b9f60161 | 1905 | (insert "\n")) ; end this menu entry |
7e1335cf RC |
1906 | (insert "@end menu")) |
1907 | ||
7e1335cf RC |
1908 | (defun texinfo-multi-file-master-menu-list (files-list) |
1909 | "Return master menu list from files in FILES-LIST. | |
1910 | Menu entries in each file collected using `texinfo-master-menu-list'. | |
1911 | ||
1912 | The first file in FILES-LIST must be the outer file; the others must | |
1913 | be the files included within it. A main menu must already exist." | |
1914 | (save-excursion | |
1915 | (let (master-menu-list) | |
b9f60161 SM |
1916 | (dolist (file files-list) |
1917 | (set-buffer (find-file-noselect file)) | |
91c6f26e KH |
1918 | (message "Working on: %s " (current-buffer)) |
1919 | (goto-char (point-min)) | |
1920 | (setq master-menu-list | |
b9f60161 | 1921 | (append master-menu-list (texinfo-master-menu-list)))) |
7e1335cf RC |
1922 | master-menu-list))) |
1923 | ||
1924 | \f | |
daa6abb8 | 1925 | ;;; The multiple-file update function |
7e1335cf RC |
1926 | |
1927 | (defun texinfo-multiple-files-update | |
1928 | (outer-file &optional update-everything make-master-menu) | |
1929 | "Update first node pointers in each file included in OUTER-FILE; | |
daa6abb8 RS |
1930 | create or update the `Top' level node pointers and the main menu in |
1931 | the outer file that refers to such nodes. This does not create or | |
1932 | update menus or pointers within the included files. | |
7e1335cf RC |
1933 | |
1934 | With optional MAKE-MASTER-MENU argument (prefix arg, if interactive), | |
daa6abb8 RS |
1935 | insert a master menu in OUTER-FILE in addition to creating or updating |
1936 | pointers in the first @node line in each included file and creating or | |
1937 | updating the `Top' level node pointers of the outer file. This does | |
1938 | not create or update other menus and pointers within the included | |
1939 | files. | |
7e1335cf RC |
1940 | |
1941 | With optional UPDATE-EVERYTHING argument (numeric prefix arg, if | |
1942 | interactive), update all the menus and all the `Next', `Previous', and | |
1943 | `Up' pointers of all the files included in OUTER-FILE before inserting | |
daa6abb8 RS |
1944 | a master menu in OUTER-FILE. Also, update the `Top' level node |
1945 | pointers of OUTER-FILE. | |
7e1335cf | 1946 | |
d1f9f441 | 1947 | Notes: |
7e1335cf RC |
1948 | |
1949 | * this command does NOT save any files--you must save the | |
1950 | outer file and any modified, included files. | |
1951 | ||
1952 | * except for the `Top' node, this command does NOT handle any | |
1953 | pre-existing nodes in the outer file; hence, indices must be | |
1954 | enclosed in an included file. | |
1955 | ||
1956 | Requirements: | |
1957 | ||
1958 | * each of the included files must contain exactly one highest | |
d1f9f441 | 1959 | hierarchical level node, |
7e1335cf RC |
1960 | * this highest node must be the first node in the included file, |
1961 | * each highest hierarchical level node must be of the same type. | |
1962 | ||
1963 | Thus, normally, each included file contains one, and only one, | |
1964 | chapter." | |
d1f9f441 | 1965 | |
daa6abb8 | 1966 | (interactive (cons |
91c6f26e KH |
1967 | (read-string |
1968 | "Name of outer `include' file: " | |
1969 | (buffer-file-name)) | |
b9f60161 SM |
1970 | (cond |
1971 | ((not current-prefix-arg) '(nil nil)) | |
1972 | ((listp current-prefix-arg) '(t nil)) ; make-master-menu | |
1973 | ((numberp current-prefix-arg) '(t t))))) ; update-everything | |
7e1335cf RC |
1974 | |
1975 | (let* ((included-file-list (texinfo-multi-file-included-list outer-file)) | |
91c6f26e | 1976 | (files included-file-list) |
91c6f26e KH |
1977 | next-node-name |
1978 | previous-node-name | |
b9f60161 SM |
1979 | ;; Update the pointers and collect the names of the nodes and titles |
1980 | (main-menu-list (texinfo-multi-file-update files update-everything))) | |
7e1335cf | 1981 | |
b9f60161 | 1982 | ;; Insert main menu |
7e1335cf | 1983 | |
b9f60161 SM |
1984 | ;; Go to outer file |
1985 | (set-buffer (find-file-noselect (car included-file-list))) | |
1986 | (if (texinfo-old-menu-p | |
1987 | (point-min) | |
1988 | (save-excursion | |
1989 | (re-search-forward "^@include") | |
1990 | (beginning-of-line) | |
1991 | (point))) | |
1992 | ||
1993 | ;; If found, leave point after word `menu' on the `@menu' line. | |
1994 | (progn | |
1995 | (texinfo-incorporate-descriptions main-menu-list) | |
1996 | ;; Delete existing menu. | |
1997 | (beginning-of-line) | |
1998 | (delete-region | |
1999 | (point) | |
2000 | (save-excursion (re-search-forward "^@end menu") (point))) | |
2001 | ;; Insert main menu | |
2002 | (texinfo-multi-files-insert-main-menu main-menu-list)) | |
7e1335cf | 2003 | |
b9f60161 SM |
2004 | ;; Else no current menu; insert it before `@include' |
2005 | (texinfo-multi-files-insert-main-menu main-menu-list)) | |
7e1335cf | 2006 | |
b9f60161 | 2007 | ;; Insert master menu |
7e1335cf | 2008 | |
b9f60161 SM |
2009 | (if make-master-menu |
2010 | (progn | |
2011 | ;; First, removing detailed part of any pre-existing master menu | |
2012 | (goto-char (point-min)) | |
2013 | (if (search-forward texinfo-master-menu-header nil t) | |
2014 | (progn | |
2015 | (goto-char (match-beginning 0)) | |
2016 | ;; Check if @detailmenu kludge is used; | |
2017 | ;; if so, leave point before @detailmenu. | |
2018 | (search-backward "\n@detailmenu" | |
2019 | (save-excursion (forward-line -3) (point)) | |
2020 | t) | |
2021 | ;; Remove detailed master menu listing | |
2022 | (let ((end-of-detailed-menu-descriptions | |
2023 | (save-excursion ; beginning of end menu line | |
2024 | (goto-char (texinfo-menu-end)) | |
2025 | (beginning-of-line) (forward-char -1) | |
2026 | (point)))) | |
2027 | (delete-region (point) end-of-detailed-menu-descriptions)))) | |
2028 | ||
2029 | ;; Create a master menu and insert it | |
2030 | (texinfo-insert-master-menu-list | |
2031 | (texinfo-multi-file-master-menu-list | |
2032 | included-file-list))))) | |
daa6abb8 RS |
2033 | |
2034 | ;; Remove unwanted extra lines. | |
2035 | (save-excursion | |
2036 | (goto-char (point-min)) | |
d1f9f441 | 2037 | |
daa6abb8 RS |
2038 | (re-search-forward "^@menu") |
2039 | (forward-line -1) | |
b9f60161 | 2040 | (insert "\n") ; Ensure at least one blank line. |
daa6abb8 | 2041 | (delete-blank-lines) |
d1f9f441 | 2042 | |
daa6abb8 RS |
2043 | (re-search-forward "^@end menu") |
2044 | (forward-line 1) | |
b9f60161 | 2045 | (insert "\n") ; Ensure at least one blank line. |
daa6abb8 RS |
2046 | (delete-blank-lines)) |
2047 | ||
7e1335cf RC |
2048 | (message "Multiple files updated.")) |
2049 | ||
daa6abb8 | 2050 | \f |
b9f60161 | 2051 | ;; Place `provide' at end of file. |
49116ac0 JB |
2052 | (provide 'texnfo-upd) |
2053 | ||
ab5796a9 | 2054 | ;;; arch-tag: d21613a5-c32f-43f4-8af4-bfb1e7455842 |
d501f516 | 2055 | ;;; texnfo-upd.el ends here |