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