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