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