1 ;;; texnfo-upd.el --- utilities for updating nodes and menus in Texinfo files
3 ;; Copyright (C) 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
5 ;; Author: Robert J. Chassell
6 ;; Maintainer: bug-texinfo@prep.ai.mit.edu
7 ;; Keywords: maint, tex, docs
9 ;; This file is part of GNU Emacs.
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
13 ;; the Free Software Foundation; either version 2, or (at your option)
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.
21 ;; You should have received a copy of the GNU General Public License
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.
28 ;; Known bug: update commands fail to ignore @ignore.
30 ;; Summary: how to use the updating commands
32 ;; The node and menu updating functions automatically
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.
39 ;; With a prefix argument, the `texinfo-update-node' and
40 ;; `texinfo-make-menu' functions do their jobs in the region.
42 ;; In brief, the functions for creating or updating nodes and menus, are:
44 ;; texinfo-update-node (&optional beginning end)
45 ;; texinfo-every-node-update ()
46 ;; texinfo-sequential-node-update (&optional region-p)
48 ;; texinfo-make-menu (&optional beginning end)
49 ;; texinfo-all-menus-update ()
50 ;; texinfo-master-menu ()
52 ;; texinfo-insert-node-lines (&optional title-p)
54 ;; texinfo-indent-menu-description (column &optional region-p)
56 ;; The `texinfo-column-for-description' variable specifies the column to
57 ;; which menu descriptions are indented.
59 ;; Texinfo file structure
60 ;; ----------------------
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:
68 ;; @node Lists and Tables, Cross References, Structuring, Top
69 ;; @comment node-name, next, previous, up
70 ;; @chapter Making Lists and Tables
72 ;; or like this (without the `@comment' line):
74 ;; @node Lists and Tables, Cross References, Structuring, Top
75 ;; @chapter Making Lists and Tables
77 ;; If the file has a `top' node, it must be called `top' or `Top' and
78 ;; be the first node in the file.
81 ;;; The update node functions described in detail
83 ;; The `texinfo-update-node' command with no prefix 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).
87 ;; With prefix argument, the `texinfo-update-node' function inserts the
88 ;; correct next, previous and up pointers for the nodes inside the
91 ;; It does not matter whether the `@node' line has pre-existing
92 ;; `Next', `Previous', or `Up' pointers in it. They are removed.
94 ;; The `texinfo-every-node-update' function runs `texinfo-update-node'
95 ;; on the whole buffer.
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.
104 ;;; The menu making functions described in detail
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.
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.
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.
120 ;; The `texinfo-all-menus-update' function runs `texinfo-make-menu'
121 ;; on the whole buffer.
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.)
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.
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.
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.
146 ;; Since node names should be more concise than section or chapter
147 ;; titles, node names so inserted will need to be edited manually.
152 (or (fboundp 'defgroup)
153 (defmacro defgroup (&rest ignore) nil))
155 (or (fboundp 'defcustom)
156 (defmacro defcustom (var value doc &rest ignore)
157 `(defvar ,var ,value ,doc)))
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.")
164 (defun texinfo-make-menu (&optional beginning end)
165 "Without any prefix argument, make or update a menu.
166 Make the menu for the section enclosing the node found following point.
168 A prefix argument means make or update menus
169 for nodes within or part of the marked region.
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."
178 (list (point) (mark))))
180 (let ((level (texinfo-hierarchic-level)))
181 (texinfo-make-one-menu level)
182 (message "Menu updated"))
184 (message "Making or updating menus in %s... " (buffer-name))
186 (goto-char (min beginning end))
187 ;; find section type following point
188 (let ((level (texinfo-hierarchic-level))
189 (region-end (max beginning end)))
193 (while (texinfo-find-lower-level-node level region-end)
194 (setq level (texinfo-hierarchic-level)) ; new, lower level
195 (texinfo-make-one-menu level))
197 (while (and (< (point) region-end)
198 (texinfo-find-higher-level-node level region-end))
199 (setq level (texinfo-hierarchic-level))
200 (while (texinfo-find-lower-level-node level region-end)
201 (setq level (texinfo-hierarchic-level)) ; new, lower level
202 (texinfo-make-one-menu level))))))
203 (message "Making or updating menus in %s...done" (buffer-name))))
205 (defun texinfo-make-one-menu (level)
206 "Make a menu of all the appropriate nodes in this section.
207 `Appropriate nodes' are those associated with sections that are
208 at the level specified by LEVEL. Point is left at the end of menu."
210 ((case-fold-search t)
213 (goto-char (texinfo-update-menu-region-beginning level))
216 (end (texinfo-update-menu-region-end level))
217 (first (texinfo-menu-first-node beginning end))
219 (goto-char beginning)
221 (texinfo-copy-node-name)))
222 (new-menu-list (texinfo-make-menu-list beginning end level)))
223 (if (texinfo-old-menu-p beginning first)
225 (texinfo-incorporate-descriptions new-menu-list)
226 (texinfo-incorporate-menu-entry-names new-menu-list)
227 (texinfo-delete-old-menu beginning first)))
228 (texinfo-insert-menu new-menu-list node-name)))
230 (defun texinfo-all-menus-update (&optional update-all-nodes-p)
231 "Update every regular menu in a Texinfo file.
232 Update pre-existing master menu, if there is one.
234 If called with a non-nil argument, this function first updates all the
235 nodes in the buffer before updating the menus."
237 (let ((case-fold-search t)
240 (push-mark (point-max) t)
241 (goto-char (point-min))
242 (message "Checking for a master menu in %s ... "(buffer-name))
244 (if (search-forward texinfo-master-menu-header nil t)
246 ;; Check if @detailmenu kludge is used;
247 ;; if so, leave point before @detailmenu.
248 (search-backward "\n@detailmenu"
249 (save-excursion (forward-line -3) (point))
251 ;; Remove detailed master menu listing
252 (setq master-menu-p t)
253 (goto-char (match-beginning 0))
254 (let ((end-of-detailed-menu-descriptions
255 (save-excursion ; beginning of end menu line
256 (goto-char (texinfo-menu-end))
257 (beginning-of-line) (forward-char -1)
259 (delete-region (point) end-of-detailed-menu-descriptions)))))
261 (if update-all-nodes-p
263 (message "Updating all nodes in %s ... " (buffer-name))
265 (texinfo-update-node (point-min) (point-max))))
267 (message "Updating all menus in %s ... " (buffer-name))
269 (texinfo-make-menu (point-max) (point-min))
273 (message "Updating the master menu in %s... " (buffer-name))
275 (texinfo-master-menu nil))))
277 (message "Done...updated all the menus. You may save the buffer.")))
279 (defun texinfo-find-lower-level-node (level region-end)
280 "Search forward from point for node at any level lower than LEVEL.
281 Search is limited to the end of the marked region, REGION-END,
282 and to the end of the menu region for the level.
284 Return t if the node is found, else nil. Leave point at the beginning
285 of the node if one is found; else do not move point."
286 (let ((case-fold-search t))
287 (if (and (< (point) region-end)
290 "\\(^@node\\).*\n" ; match node line
291 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
293 "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
294 (eval (cdr (assoc level texinfo-update-menu-lower-regexps))))
295 ;; the next higher level node marks the end of this
296 ;; section, and no lower level node will be found beyond
297 ;; this position even if region-end is farther off
298 (texinfo-update-menu-region-end level)
300 (goto-char (match-beginning 1)))))
302 (defun texinfo-find-higher-level-node (level region-end)
303 "Search forward from point for node at any higher level than argument LEVEL.
304 Search is limited to the end of the marked region, REGION-END.
306 Return t if the node is found, else nil. Leave point at the beginning
307 of the node if one is found; else do not move point."
308 (let ((case-fold-search t))
310 ((or (string-equal "top" level) (string-equal "chapter" level))
311 (if (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t)
312 (progn (beginning-of-line) t)))
314 (if (re-search-forward
316 "\\(^@node\\).*\n" ; match node line
317 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
319 "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
320 (eval (cdr (assoc level texinfo-update-menu-higher-regexps))))
322 (progn (beginning-of-line) t))))))
325 ;;; Making the list of new menu entries
327 (defun texinfo-make-menu-list (beginning end level)
328 "Make a list of node names and their descriptions.
329 Point is left at the end of the menu region, but the menu is not inserted.
331 First argument is position from which to start making menu list;
332 second argument is end of region in which to try to locate entries;
333 third argument is the level of the nodes that are the entries.
335 Node names and descriptions are dotted pairs of strings. Each pair is
336 an element of the list. If the description does not exist, the
337 element consists only of the node name."
338 (goto-char beginning)
340 (while (texinfo-menu-locate-entry-p level end)
343 (texinfo-copy-node-name)
344 (prog1 "" (forward-line 1)))
345 ;; Use following to insert section titles automatically.
346 ;; (texinfo-copy-section-title))
348 (reverse new-menu-list)))
350 (defun texinfo-menu-locate-entry-p (level search-end)
351 "Find a node that will be part of menu for this section.
352 First argument is a string such as \"section\" specifying the general
353 hierarchical level of the menu; second argument is a position
354 specifying the end of the search.
356 The function returns t if the node is found, else nil. It searches
357 forward from point, and leaves point at the beginning of the node.
359 The function finds entries of the same type. Thus `subsections' and
360 `unnumberedsubsecs' will appear in the same menu."
361 (let ((case-fold-search t))
362 (if (re-search-forward
364 "\\(^@node\\).*\n" ; match node line
365 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
367 "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
369 (cdr (assoc level texinfo-update-menu-same-level-regexps))))
372 (goto-char (match-beginning 1)))))
374 (defun texinfo-copy-node-name ()
375 "Return the node name as a string.
377 Start with point at the beginning of the node line; copy the text
378 after the node command up to the first comma on the line, if any, and
379 return the text as a string. Leaves point at the beginning of the
380 line. If there is no node name, returns an empty string."
384 (progn (forward-word 1) ; skip over node command
385 (skip-chars-forward " \t") ; and over spaces
389 (save-excursion (end-of-line) (point)) t) ; bound search
391 (end-of-line) (point)))))
393 (defun texinfo-copy-section-title ()
394 "Return the title of the section as a string.
395 The title is used as a description line in the menu when one does not
398 Move point to the beginning of the appropriate section line by going
399 to the start of the text matched by last regexp searched for, which
400 must have been done by `texinfo-menu-locate-entry-p'."
402 ;; could use the same re-search as in `texinfo-menu-locate-entry-p'
403 ;; instead of using `match-beginning'; such a variation would be
404 ;; more general, but would waste information already collected
406 (goto-char (match-beginning 7)) ; match section name
409 (progn (forward-word 1) ; skip over section type
410 (skip-chars-forward " \t") ; and over spaces
412 (progn (end-of-line) (point))))
415 ;;; Handling the old menu
417 (defun texinfo-old-menu-p (beginning first)
418 "Move point to the beginning of the menu for this section, if any.
419 Otherwise move point to the end of the first node of this section.
420 Return t if a menu is found, nil otherwise.
422 First argument is the position of the beginning of the section in which
423 the menu will be located; second argument is the position of the first
424 node within the section.
426 If no menu is found, the function inserts two newlines just before the
427 end of the section, and leaves point there where a menu ought to be."
428 (goto-char beginning)
429 (if (not (re-search-forward "^@menu" first 'goto-end))
430 (progn (insert "\n\n") (forward-line -2) nil)
433 (defun texinfo-incorporate-descriptions (new-menu-list)
434 "Copy the old menu line descriptions that exist to the new menu.
436 Point must be at beginning of old menu.
438 If the node-name of the new menu is found in the old menu, insert the
439 old description into the new entry.
441 For this function, the new menu is a list made up of lists of dotted
442 pairs in which the first element of the pair is the node name and the
443 second element the description. The new menu is changed destructively.
444 The old menu is the menu as it appears in the Texinfo file."
446 (let ((new-menu-list-pointer new-menu-list)
447 (end-of-menu (texinfo-menu-end)))
449 (save-excursion ; keep point at beginning of menu
450 (if (re-search-forward
451 ;; Existing nodes can have the form
452 ;; * NODE NAME:: DESCRIPTION
454 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
456 ;; Recognize both when looking for the description.
457 (concat "\\* \\(" ; so only menu entries are found
458 (regexp-quote (car (car new-menu-list))) "::"
460 ".*: " (regexp-quote (car (car new-menu-list))) "[.,\t\n]"
462 ) ; so only complete entries are found
465 (setcdr (car new-menu-list)
466 (texinfo-menu-copy-old-description end-of-menu))))
467 (setq new-menu-list (cdr new-menu-list)))
468 (setq new-menu-list new-menu-list-pointer)))
470 (defun texinfo-incorporate-menu-entry-names (new-menu-list)
471 "Copy any old menu entry names to the new menu.
473 Point must be at beginning of old menu.
475 If the node-name of the new menu entry cannot be found in the old
478 For this function, the new menu is a list made up of lists of dotted
479 pairs in which the first element of the pair is the node name and the
480 second element is the description (or nil).
482 If we find an existing menu entry name, we change the first element of
483 the pair to be another dotted pair in which the car is the menu entry
484 name and the cdr is the node name.
486 NEW-MENU-LIST is changed destructively. The old menu is the menu as it
487 appears in the texinfo file."
489 (let ((new-menu-list-pointer new-menu-list)
490 (end-of-menu (texinfo-menu-end)))
492 (save-excursion ; keep point at beginning of menu
493 (if (re-search-forward
494 ;; Existing nodes can have the form
495 ;; * NODE NAME:: DESCRIPTION
497 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
499 ;; We're interested in the second case.
500 (concat "\\* " ; so only menu entries are found
501 "\\(.*\\): " (car (car new-menu-list)) "[.,\t\n]")
505 (car new-menu-list) ; replace the node name
506 (cons (buffer-substring (match-beginning 1) (match-end 1))
507 (car (car new-menu-list)))))
508 (setq new-menu-list (cdr new-menu-list))))
509 (setq new-menu-list new-menu-list-pointer)))
511 (defun texinfo-menu-copy-old-description (end-of-menu)
512 "Return description field of old menu line as string.
513 Point must be located just after the node name. Point left before description.
514 Single argument, END-OF-MENU, is position limiting search."
515 (skip-chars-forward "[:.,\t\n ]+")
516 ;; don't copy a carriage return at line beginning with asterisk!
517 ;; do copy a description that begins with an `@'!
518 ;; !! Known bug: does not copy descriptions starting with ^|\{?* etc.
519 (if (and (looking-at "\\(\\w+\\|@\\)")
520 (not (looking-at "\\(^\\* \\|^@end menu\\)")))
524 (re-search-forward "\\(^\\* \\|^@end menu\\)" end-of-menu t)
526 (end-of-line) ; go to end of last description line
530 (defun texinfo-menu-end ()
531 "Return position of end of menu, but don't move point.
532 Signal an error if not end of menu."
534 (if (re-search-forward "^@end menu" nil t)
536 (error "Menu does not have an end."))))
538 (defun texinfo-delete-old-menu (beginning first)
539 "Delete the old menu. Point must be in or after menu.
540 First argument is position of the beginning of the section in which
541 the menu will be located; second argument is the position of the first
542 node within the section."
543 ;; No third arg to search, so error if search fails.
544 (re-search-backward "^@menu" beginning)
545 (delete-region (point)
547 (re-search-forward "^@end menu" first)
551 ;;; Inserting new menu
553 ;; try 32, but perhaps 24 is better
554 (defvar texinfo-column-for-description 32
555 "*Column at which descriptions start in a Texinfo menu.")
557 (defun texinfo-insert-menu (menu-list node-name)
558 "Insert formatted menu at point.
559 Indents the first line of the description, if any, to the value of
560 texinfo-column-for-description.
564 \(\(\"node-name1\" . \"description\"\)
565 \(\"node-name2\" . \"description\"\) ... \)
567 However, the description field might be nil.
569 Also, the node-name field might itself be a dotted pair (call it P) of
570 strings instead of just a string. In that case, the car of P
571 is the menu entry name, and the cdr of P is the node name."
575 ;; Every menu entry starts with a star and a space.
578 ;; Insert the node name (and menu entry name, if present).
579 (let ((node-part (car (car menu-list))))
580 (if (stringp node-part)
581 ;; "Double colon" entry line; menu entry and node name are the same,
582 (insert (format "%s::" node-part))
583 ;; "Single colon" entry line; menu entry and node name are different.
584 (insert (format "%s: %s." (car node-part) (cdr node-part)))))
586 ;; Insert the description, if present.
587 (if (cdr (car menu-list))
589 ;; Move to right place.
590 (indent-to texinfo-column-for-description 2)
591 ;; Insert description.
592 (insert (format "%s" (cdr (car menu-list))))))
594 (insert "\n") ; end this menu entry
595 (setq menu-list (cdr menu-list)))
598 "Updated \"%s\" level menu following node: %s ... " level node-name))
601 ;;; Starting menu descriptions by inserting titles
603 (defun texinfo-start-menu-description ()
604 "In this menu entry, insert the node's section title as a description.
605 Position point at beginning of description ready for editing.
606 Do not insert a title if the line contains an existing description.
608 You will need to edit the inserted text since a useful description
609 complements the node name rather than repeats it as a title does."
612 (let (beginning end node-name title)
615 (if (search-forward "* " (save-excursion (end-of-line) (point)) t)
616 (progn (skip-chars-forward " \t")
617 (setq beginning (point)))
618 (error "This is not a line in a menu!"))
621 ;; "Double colon" entry line; menu entry and node name are the same,
622 ((search-forward "::" (save-excursion (end-of-line) (point)) t)
623 (if (looking-at "[ \t]*[^ \t\n]+")
624 (error "Descriptive text already exists."))
625 (skip-chars-backward ": \t")
626 (setq node-name (buffer-substring beginning (point))))
628 ;; "Single colon" entry line; menu entry and node name are different.
629 ((search-forward ":" (save-excursion (end-of-line) (point)) t)
630 (skip-chars-forward " \t")
631 (setq beginning (point))
632 ;; Menu entry line ends in a period, comma, or tab.
633 (if (re-search-forward "[.,\t]"
634 (save-excursion (forward-line 1) (point)) t)
636 (if (looking-at "[ \t]*[^ \t\n]+")
637 (error "Descriptive text already exists."))
638 (skip-chars-backward "., \t")
639 (setq node-name (buffer-substring beginning (point))))
640 ;; Menu entry line ends in a return.
641 (re-search-forward ".*\n"
642 (save-excursion (forward-line 1) (point)) t)
643 (skip-chars-backward " \t\n")
644 (setq node-name (buffer-substring beginning (point)))
645 (if (= 0 (length node-name))
646 (error "No node name on this line.")
648 (t (error "No node name on this line.")))
649 ;; Search for node that matches node name, and copy the section title.
650 (if (re-search-forward
654 ".*\n" ; match node line
656 "\\(\\(^@c \\|^@comment\\).*\n\\)" ; match comment line, if any
658 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
664 ;; skip over section type
665 (progn (forward-word 1)
667 (skip-chars-forward " \t")
670 (skip-chars-backward " \t")
672 (error "Cannot find node to match node name in menu entry.")))
673 ;; Return point to the menu and insert the title.
677 (save-excursion (skip-chars-backward " \t") (point)))
678 (indent-to texinfo-column-for-description 2)
679 (save-excursion (insert title))))
682 ;;; Handling description indentation
684 ;; Since the make-menu functions indent descriptions, these functions
685 ;; are useful primarily for indenting a single menu specially.
687 (defun texinfo-indent-menu-description (column &optional region-p)
688 "Indent every description in menu following point to COLUMN.
689 Non-nil argument (prefix, if interactive) means indent every
690 description in every menu in the region. Does not indent second and
691 subsequent lines of a multi-line description."
694 "nIndent menu descriptions to (column number): \nP")
700 (re-search-forward "^@menu")
701 (texinfo-menu-indent-description column)
703 "Indented descriptions in menu. You may save the buffer."))
705 (message "Indenting every menu description in region... ")
706 (goto-char (region-beginning))
707 (while (and (< (point) (region-end))
708 (texinfo-locate-menu-p))
710 (texinfo-menu-indent-description column))
711 (message "Indenting done. You may save the buffer.")))))
713 (defun texinfo-menu-indent-description (to-column-number)
714 "Indent the Texinfo file menu description to TO-COLUMN-NUMBER.
715 Start with point just after the word `menu' in the `@menu' line and
716 leave point on the line before the `@end menu' line. Does not indent
717 second and subsequent lines of a multi-line description."
718 (let* ((beginning-of-next-line (point)))
719 (while (< beginning-of-next-line
720 (save-excursion ; beginning of end menu line
721 (goto-char (texinfo-menu-end))
725 (if (re-search-forward "\\* \\(.*::\\|.*: [^.,\t\n]+[.,\t]\\)"
729 (let ((beginning-white-space (point)))
730 (skip-chars-forward " \t") ; skip over spaces
731 (if (looking-at "\\(@\\|\\w\\)+") ; if there is text
733 ;; remove pre-existing indentation
734 (delete-region beginning-white-space (point))
735 (indent-to-column to-column-number))))))
736 ;; position point at beginning of next line
738 (setq beginning-of-next-line (point)))))
741 ;;; Making the master menu
743 (defun texinfo-master-menu (update-all-nodes-menus-p)
744 "Make a master menu for a whole Texinfo file.
745 Non-nil argument (prefix, if interactive) means first update all
746 existing nodes and menus. Remove pre-existing master menu, if there is one.
748 This function creates a master menu that follows the top node. The
749 master menu includes every entry from all the other menus. It
750 replaces any existing ordinary menu that follows the top node.
752 If called with a non-nil argument, this function first updates all the
753 menus in the buffer (incorporating descriptions from pre-existing
754 menus) before it constructs the master menu.
756 The function removes the detailed part of an already existing master
757 menu. This action depends on the pre-existing master menu using the
758 standard `texinfo-master-menu-header'.
760 The master menu has the following format, which is adapted from the
761 recommendation in the Texinfo Manual:
763 * The first part contains the major nodes in the Texinfo file: the
764 nodes for the chapters, chapter-like sections, and the major
765 appendices. This includes the indices, so long as they are in
766 chapter-like sections, such as unnumbered sections.
768 * The second and subsequent parts contain a listing of the other,
769 lower level menus, in order. This way, an inquirer can go
770 directly to a particular node if he or she is searching for
771 specific information.
773 Each of the menus in the detailed node listing is introduced by the
774 title of the section containing the menu."
777 (let ((case-fold-search t))
779 (goto-char (point-min))
781 ;; Move point to location after `top'.
782 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t))
783 (error "This buffer needs a Top node!"))
787 (or (re-search-forward "^@node" nil t)
788 (error "Too few nodes for a master menu!"))
790 (if (search-forward texinfo-master-menu-header first-chapter t)
792 ;; Check if @detailmenu kludge is used;
793 ;; if so, leave point before @detailmenu.
794 (search-backward "\n@detailmenu"
795 (save-excursion (forward-line -3) (point))
797 ;; Remove detailed master menu listing
798 (goto-char (match-beginning 0))
799 (let ((end-of-detailed-menu-descriptions
800 (save-excursion ; beginning of end menu line
801 (goto-char (texinfo-menu-end))
802 (beginning-of-line) (forward-char -1)
804 (delete-region (point) end-of-detailed-menu-descriptions)))))
806 (if update-all-nodes-menus-p
808 (message "Making a master menu in %s ...first updating all nodes... "
811 (texinfo-update-node (point-min) (point-max))
813 (message "Updating all menus in %s ... " (buffer-name))
815 (texinfo-make-menu (point-min) (point-max))))
817 (message "Now making the master menu in %s... " (buffer-name))
819 (goto-char (point-min))
820 (texinfo-insert-master-menu-list
821 (texinfo-master-menu-list))
823 ;; Remove extra newlines that texinfo-insert-master-menu-list
824 ;; may have inserted.
827 (goto-char (point-min))
829 (if (search-forward texinfo-master-menu-header nil t)
831 (goto-char (match-beginning 0))
832 ;; Check if @detailmenu kludge is used;
833 ;; if so, leave point before @detailmenu.
834 (search-backward "\n@detailmenu"
835 (save-excursion (forward-line -3) (point))
839 (goto-char (point-min))))
841 (re-search-forward "^@menu")
845 (re-search-forward "^@end menu")
847 (delete-blank-lines))
850 "Done...completed making master menu. You may save the buffer.")))
852 (defun texinfo-master-menu-list ()
853 "Return a list of menu entries and header lines for the master menu.
855 Start with the menu for chapters and indices and then find each
856 following menu and the title of the node preceding that menu.
858 The master menu list has this form:
860 \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\)
861 \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\)
864 However, there does not need to be a title field."
866 (let (master-menu-list)
867 (while (texinfo-locate-menu-p)
868 (setq master-menu-list
871 (texinfo-copy-menu-title))
873 (reverse master-menu-list)))
875 (defun texinfo-insert-master-menu-list (master-menu-list)
876 "Format and insert the master menu in the current buffer."
877 (goto-char (point-min))
878 ;; Insert a master menu only after `Top' node and before next node
879 ;; \(or include file if there is no next node\).
880 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t))
881 (error "This buffer needs a Top node!"))
883 (save-excursion (re-search-forward "^@node\\|^@include") (point))))
884 (if (not (re-search-forward "^@menu" first-chapter t))
886 "Buffer lacks ordinary `Top' menu in which to insert master.")))
888 (delete-region ; buffer must have ordinary top menu
890 (save-excursion (re-search-forward "^@end menu") (point)))
893 ;; `master-menu-inserted-p' is a kludge to tell
894 ;; whether to insert @end detailmenu (see bleow)
895 (let (master-menu-inserted-p)
896 ;; Handle top of menu
898 ;; Insert chapter menu entries
899 (setq this-very-menu-list (reverse (car (car master-menu-list))))
900 ;; Tell user what is going on.
901 (message "Inserting chapter menu entry: %s ... " this-very-menu-list)
902 (while this-very-menu-list
903 (insert "* " (car this-very-menu-list) "\n")
904 (setq this-very-menu-list (cdr this-very-menu-list)))
906 (setq master-menu-list (cdr master-menu-list))
908 ;; Only insert detailed master menu if there is one....
909 (if (car (car master-menu-list))
910 (progn (setq master-menu-inserted-p t)
911 (insert (concat "\n@detailmenu" texinfo-master-menu-header))))
913 ;; @detailmenu added 5 Sept 1996 to `texinfo-master-menu-header'
914 ;; at Karl Berry's request to avert a bug in `makeinfo';
915 ;; all agree this is a bad kludge and should eventually be removed.
916 ;; @detailmenu ... @end detailmenu is a noop in `texinfmt.el'.
917 ;; See @end detailmenu below;
918 ;; also see `texinfo-all-menus-update' above, `texinfo-master-menu',
919 ;; `texinfo-multiple-files-update'.
921 ;; Now, insert all the other menus
923 ;; The menu master-menu-list has a form like this:
924 ;; ((("beta" "alpha") "title-A")
925 ;; (("delta" "gamma") "title-B"))
927 (while master-menu-list
930 "Inserting menu for %s .... " (car (cdr (car master-menu-list))))
931 ;; insert title of menu section
932 (insert "\n" (car (cdr (car master-menu-list))) "\n\n")
934 ;; insert each menu entry
935 (setq this-very-menu-list (reverse (car (car master-menu-list))))
936 (while this-very-menu-list
937 (insert "* " (car this-very-menu-list) "\n")
938 (setq this-very-menu-list (cdr this-very-menu-list)))
940 (setq master-menu-list (cdr master-menu-list)))
944 ;; @detailmenu (see note above)
945 ;; Only insert @end detailmenu if a master menu was inserted.
946 (if master-menu-inserted-p
947 (insert "\n@end detailmenu"))
948 (insert "\n@end menu\n\n"))))
950 (defun texinfo-locate-menu-p ()
951 "Find the next menu in the texinfo file.
952 If found, leave point after word `menu' on the `@menu' line, and return t.
953 If a menu is not found, do not move point and return nil."
954 (re-search-forward "\\(^@menu\\)" nil t))
956 (defun texinfo-copy-menu-title ()
957 "Return the title of the section preceding the menu as a string.
958 If such a title cannot be found, return an empty string. Do not move
960 (let ((case-fold-search t))
962 (if (re-search-backward
966 texinfo-section-types-regexp ; all other section types
972 (forward-word 1) ; skip over section type
973 (skip-chars-forward " \t") ; and over spaces
976 (progn (end-of-line) (point))))
979 (defun texinfo-copy-menu ()
980 "Return the entries of an existing menu as a list.
981 Start with point just after the word `menu' in the `@menu' line
982 and leave point on the line before the `@end menu' line."
983 (let* (this-menu-list
984 (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu'
985 (last-entry (save-excursion ; position of beginning of
987 (goto-char end-of-menu)
988 ;; handle multi-line description
989 (if (not (re-search-backward "^\\* " nil t))
990 (error "No entries in menu."))
992 (while (< (point) last-entry)
993 (if (re-search-forward "^\\* " end-of-menu t)
999 ;; copy multi-line descriptions
1001 (re-search-forward "\\(^\\* \\|^@e\\)" nil t)
1007 ;;; Determining the hierarchical level in the texinfo file
1009 (defun texinfo-specific-section-type ()
1010 "Return the specific type of next section, as a string.
1011 For example, \"unnumberedsubsec\". Return \"top\" for top node.
1013 Searches forward for a section. Hence, point must be before the
1014 section whose type will be found. Does not move point. Signal an
1015 error if the node is not the top node and a section is not found."
1016 (let ((case-fold-search t))
1019 ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1020 ;;; Following search limit by cph but causes a bug
1027 ((re-search-forward texinfo-section-types-regexp nil t)
1028 (buffer-substring-no-properties
1029 (progn (beginning-of-line) ; copy its name
1031 (progn (forward-word 1)
1035 "texinfo-specific-section-type: Chapter or section not found."))))))
1037 (defun texinfo-hierarchic-level ()
1038 "Return the general hierarchal level of the next node in a texinfo file.
1039 Thus, a subheading or appendixsubsec is of type subsection."
1040 (let ((case-fold-search t))
1042 (texinfo-specific-section-type)
1043 texinfo-section-to-generic-alist))))
1046 ;;; Locating the major positions
1048 (defun texinfo-update-menu-region-beginning (level)
1049 "Locate beginning of higher level section this section is within.
1050 Return position of the beginning of the node line; do not move point.
1051 Thus, if this level is subsection, searches backwards for section node.
1052 Only argument is a string of the general type of section."
1053 (let ((case-fold-search t))
1054 ;; !! Known bug: if section immediately follows top node, this
1055 ;; returns the beginning of the buffer as the beginning of the
1056 ;; higher level section.
1058 ((or (string-equal "top" level)
1059 (string-equal "chapter" level))
1061 (goto-char (point-min))
1062 (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)
1069 "\\(^@node\\).*\n" ; match node line
1070 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1072 "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
1074 (cdr (assoc level texinfo-update-menu-higher-regexps))))
1079 (defun texinfo-update-menu-region-end (level)
1080 "Locate end of higher level section this section is within.
1081 Return position; do not move point. Thus, if this level is a
1082 subsection, find the node for the section this subsection is within.
1083 If level is top or chapter, returns end of file. Only argument is a
1084 string of the general type of section."
1085 (let ((case-fold-search t))
1087 (if (re-search-forward
1089 "\\(^@node\\).*\n" ; match node line
1090 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1092 "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
1094 ;; Never finds end of level above chapter so goes to end.
1095 (cdr (assoc level texinfo-update-menu-higher-regexps))))
1101 (defun texinfo-menu-first-node (beginning end)
1102 "Locate first node of the section the menu will be placed in.
1103 Return position; do not move point.
1104 The menu will be located just before this position.
1106 First argument is the position of the beginning of the section in
1107 which the menu will be located; second argument is the position of the
1108 end of that region; it limits the search."
1111 (goto-char beginning)
1113 (re-search-forward "^@node" end t)
1118 ;;; Alists and regular expressions for defining hierarchical levels
1120 (defvar texinfo-section-to-generic-alist
1123 ("chapter" . "chapter")
1124 ("unnumbered" . "chapter")
1125 ("majorheading" . "chapter")
1126 ("chapheading" . "chapter")
1127 ("appendix" . "chapter")
1129 ("section" . "section")
1130 ("unnumberedsec" . "section")
1131 ("heading" . "section")
1132 ("appendixsec" . "section")
1134 ("subsection" . "subsection")
1135 ("unnumberedsubsec" . "subsection")
1136 ("subheading" . "subsection")
1137 ("appendixsubsec" . "subsection")
1139 ("subsubsection" . "subsubsection")
1140 ("unnumberedsubsubsec" . "subsubsection")
1141 ("subsubheading" . "subsubsection")
1142 ("appendixsubsubsec" . "subsubsection"))
1143 "*An alist of specific and corresponding generic Texinfo section types.
1144 The keys are strings specifying specific types of section; the values
1145 are strings of their corresponding general types.")
1147 ;; We used to look for just sub, but that found @subtitle.
1148 (defvar texinfo-section-types-regexp
1149 "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
1150 "Regexp matching chapter, section, other headings (but not the top node).")
1152 (defvar texinfo-chapter-level-regexp
1153 "chapter\\|unnumbered \\|appendix \\|majorheading\\|chapheading"
1154 "Regular expression matching just the Texinfo chapter level headings.")
1156 (defvar texinfo-section-level-regexp
1157 "section\\|unnumberedsec\\|heading \\|appendixsec"
1158 "Regular expression matching just the Texinfo section level headings.")
1160 (defvar texinfo-subsection-level-regexp
1161 "subsection\\|unnumberedsubsec\\|subheading\\|appendixsubsec"
1162 "Regular expression matching just the Texinfo subsection level headings.")
1164 (defvar texinfo-subsubsection-level-regexp
1165 "subsubsection\\|unnumberedsubsubsec\\|subsubheading\\|appendixsubsubsec"
1166 "Regular expression matching just the Texinfo subsubsection level headings.")
1168 (defvar texinfo-update-menu-same-level-regexps
1169 '(("top" . "top[ \t]+")
1171 (concat "\\(^@\\)\\(" texinfo-chapter-level-regexp "\\)[ \t]*"))
1173 (concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)[ \t]*"))
1175 (concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)[ \t]+"))
1177 (concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)[ \t]+")))
1178 "*Regexps for searching for same level sections in a Texinfo file.
1179 The keys are strings specifying the general hierarchical level in the
1180 document; the values are regular expressions.")
1182 (defvar texinfo-update-menu-higher-regexps
1183 '(("top" . "^@node [ \t]*DIR")
1184 ("chapter" . "^@node [ \t]*top[ \t]*\\(,\\|$\\)")
1188 texinfo-chapter-level-regexp
1193 texinfo-section-level-regexp
1195 texinfo-chapter-level-regexp
1200 texinfo-subsection-level-regexp
1202 texinfo-section-level-regexp
1204 texinfo-chapter-level-regexp
1206 "*Regexps for searching for higher level sections in a Texinfo file.
1207 The keys are strings specifying the general hierarchical level in the
1208 document; the values are regular expressions.")
1210 (defvar texinfo-update-menu-lower-regexps
1214 texinfo-chapter-level-regexp
1216 texinfo-section-level-regexp
1218 texinfo-subsection-level-regexp
1220 texinfo-subsubsection-level-regexp
1225 texinfo-section-level-regexp
1227 texinfo-subsection-level-regexp
1229 texinfo-subsubsection-level-regexp
1234 texinfo-subsection-level-regexp
1236 texinfo-subsubsection-level-regexp
1241 texinfo-subsubsection-level-regexp
1243 ("subsubsection" . "nothing lower"))
1244 "*Regexps for searching for lower level sections in a Texinfo file.
1245 The keys are strings specifying the general hierarchical level in the
1246 document; the values are regular expressions.")
1252 (defun texinfo-update-node (&optional beginning end)
1253 "Without any prefix argument, update the node in which point is located.
1254 Interactively, a prefix argument means to operate on the region.
1256 The functions for creating or updating nodes and menus, and their
1259 texinfo-update-node (&optional beginning end) \\[texinfo-update-node]
1260 texinfo-every-node-update () \\[texinfo-every-node-update]
1261 texinfo-sequential-node-update (&optional region-p)
1263 texinfo-make-menu (&optional region-p) \\[texinfo-make-menu]
1264 texinfo-all-menus-update () \\[texinfo-all-menus-update]
1265 texinfo-master-menu ()
1267 texinfo-indent-menu-description (column &optional region-p)
1269 The `texinfo-column-for-description' variable specifies the column to
1270 which menu descriptions are indented. Its default value is 32."
1274 (list (point) (mark))))
1275 (if (null beginning)
1276 ;; Update a single node.
1277 (let ((auto-fill-function nil) (auto-fill-hook nil))
1278 (if (not (re-search-backward "^@node" (point-min) t))
1279 (error "Node line not found before this position"))
1280 (texinfo-update-the-node)
1281 (message "Done...updated the node. You may save the buffer."))
1283 (let ((auto-fill-function nil)
1284 (auto-fill-hook nil))
1287 (narrow-to-region beginning end)
1288 (goto-char (point-min))
1289 (while (re-search-forward "^@node" (point-max) t)
1291 (texinfo-update-the-node))
1292 (goto-char (point-max))
1293 (message "Done...nodes updated in region. You may save the buffer."))))))
1296 (defun texinfo-every-node-update ()
1297 "Update every node in a Texinfo file."
1300 (texinfo-update-node (point-min) (point-max))
1301 (message "Done...updated every node. You may save the buffer.")))
1303 (defun texinfo-update-the-node ()
1304 "Update one node. Point must be at the beginning of node line.
1305 Leave point at the end of the node line."
1306 (texinfo-check-for-node-name)
1307 (texinfo-delete-existing-pointers)
1308 (message "Updating node: %s ... " (texinfo-copy-node-name))
1312 ((case-fold-search t)
1313 (level (texinfo-hierarchic-level))
1314 (beginning (texinfo-update-menu-region-beginning level))
1315 (end (texinfo-update-menu-region-end level)))
1316 (if (string-equal level "top")
1317 (texinfo-top-pointer-case)
1319 (texinfo-insert-pointer beginning end level 'next)
1320 (texinfo-insert-pointer beginning end level 'previous)
1321 (texinfo-insert-pointer beginning end level 'up)
1322 (texinfo-clean-up-node-line)))))
1324 (defun texinfo-top-pointer-case ()
1325 "Insert pointers in the Top node. This is a special case.
1327 The `Next' pointer is a pointer to a chapter or section at a lower
1328 hierarchical level in the file. The `Previous' and `Up' pointers are
1329 to `(dir)'. Point must be at the beginning of the node line, and is
1330 left at the end of the node line."
1332 (texinfo-clean-up-node-line)
1335 ;; There may be an @chapter or other such command between
1336 ;; the top node line and the next node line, as a title
1337 ;; for an `ifinfo' section. This @chapter command must
1338 ;; must be skipped. So the procedure is to search for
1339 ;; the next `@node' line, and then copy its name.
1340 (if (re-search-forward "^@node" nil t)
1343 (texinfo-copy-node-name))
1347 (defun texinfo-check-for-node-name ()
1348 "Determine whether the node has a node name. Prompt for one if not.
1349 Point must be at beginning of node line. Does not move point."
1351 (let ((initial (texinfo-copy-next-section-title)))
1352 ;; This is not clean. Use `interactive' to read the arg.
1353 (forward-word 1) ; skip over node command
1354 (skip-chars-forward " \t") ; and over spaces
1355 (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what Info looks for
1356 ; alternatively, use "[a-zA-Z]+"
1358 (read-from-minibuffer
1359 "Node name (use no @, commas, colons, or apostrophes): "
1361 (insert " " node-name))))))
1363 (defun texinfo-delete-existing-pointers ()
1364 "Delete `Next', `Previous', and `Up' pointers.
1365 Starts from the current position of the cursor, and searches forward
1366 on the line for a comma and if one is found, deletes the rest of the
1367 line, including the comma. Leaves point at beginning of line."
1368 (let ((eol-point (save-excursion (end-of-line) (point))))
1369 (if (search-forward "," eol-point t)
1370 (delete-region (1- (point)) eol-point)))
1371 (beginning-of-line))
1373 (defun texinfo-find-pointer (beginning end level direction)
1374 "Move point to section associated with next, previous, or up pointer.
1375 Return type of pointer (either `normal' or `no-pointer').
1377 The first and second arguments bound the search for a pointer to the
1378 beginning and end, respectively, of the enclosing higher level
1379 section. The third argument is a string specifying the general kind
1380 of section such as \"chapter\" or \"section\". When looking for the
1381 `Next' pointer, the section found will be at the same hierarchical
1382 level in the Texinfo file; when looking for the `Previous' pointer,
1383 the section found will be at the same or higher hierarchical level in
1384 the Texinfo file; when looking for the `Up' pointer, the section found
1385 will be at some level higher in the Texinfo file. The fourth argument
1386 \(one of 'next, 'previous, or 'up\) specifies whether to find the
1387 `Next', `Previous', or `Up' pointer."
1388 (let ((case-fold-search t))
1389 (cond ((eq direction 'next)
1390 (forward-line 3) ; skip over current node
1391 ;; Search for section commands accompanied by node lines;
1392 ;; ignore section commands in the middle of nodes.
1393 (if (re-search-forward
1394 ;; A `Top' node is never a next pointer, so won't find it.
1398 ;; Match comment or ifinfo line, if any
1399 "\\(\\(\\(^@c\\).*\n\\)\\|\\(^@ifinfo[ ]*\n\\)\\)?"
1401 (cdr (assoc level texinfo-update-menu-same-level-regexps))))
1406 ((eq direction 'previous)
1407 (if (re-search-backward
1412 ;; Match comment or ifinfo line, if any
1413 "\\(\\(\\(^@c\\).*\n\\)\\|\\(^@ifinfo[ ]*\n\\)\\)?"
1415 (cdr (assoc level texinfo-update-menu-same-level-regexps)))
1419 ;; Match comment or ifinfo line, if any
1420 "\\(\\(\\(^@c\\).*\n\\)\\|\\(^@ifinfo[ ]*\n\\)\\)?"
1422 (cdr (assoc level texinfo-update-menu-higher-regexps)))
1424 ;; Handle `Top' node specially.
1425 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1432 (if (re-search-backward
1437 ;; Match comment or ifinfo line, if any
1438 "\\(\\(\\(^@c\\).*\n\\)\\|\\(^@ifinfo[ ]*\n\\)\\)?"
1439 (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))
1441 ;; Handle `Top' node specially.
1442 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1445 (goto-char beginning)
1452 (error "texinfo-find-pointer: lack proper arguments")))))
1454 (defun texinfo-pointer-name (kind)
1455 "Return the node name preceding the section command.
1456 The argument is the kind of section, either `normal' or `no-pointer'."
1458 (cond ((eq kind 'normal)
1459 (end-of-line) ; this handles prev node top case
1460 (re-search-backward ; when point is already
1461 "^@node" ; at the beginning of @node line
1462 (save-excursion (forward-line -3))
1464 (setq name (texinfo-copy-node-name)))
1465 ((eq kind 'no-pointer)
1466 ;; Don't need to put a blank in the pointer slot,
1467 ;; since insert "' " always has a space
1468 (setq name " "))) ; put a blank in the pointer slot
1471 (defun texinfo-insert-pointer (beginning end level direction)
1472 "Insert the `Next', `Previous' or `Up' node name at point.
1475 The first and second arguments bound the search for a pointer to the
1476 beginning and end, respectively, of the enclosing higher level
1477 section. The third argument is the hierarchical level of the Texinfo
1478 file, a string such as \"section\". The fourth argument is direction
1479 towards which the pointer is directed, one of `next', `previous', or `up'."
1485 (texinfo-pointer-name
1486 (texinfo-find-pointer beginning end level direction)))))
1488 (defun texinfo-clean-up-node-line ()
1489 "Remove extra commas, if any, at end of node line."
1491 (skip-chars-backward ", ")
1492 (delete-region (point) (save-excursion (end-of-line) (point))))
1495 ;;; Updating nodes sequentially
1496 ;; These sequential update functions insert `Next' or `Previous'
1497 ;; pointers that point to the following or preceding nodes even if they
1498 ;; are at higher or lower hierarchical levels. This means that if a
1499 ;; section contains one or more subsections, the section's `Next'
1500 ;; pointer will point to the subsection and not the following section.
1501 ;; (The subsection to which `Next' points will most likely be the first
1502 ;; item on the section's menu.)
1505 (defun texinfo-sequential-node-update (&optional region-p)
1506 "Update one node (or many) in a Texinfo file with sequential pointers.
1508 This function causes the `Next' or `Previous' pointer to point to the
1509 immediately preceding or following node, even if it is at a higher or
1510 lower hierarchical level in the document. Continually pressing `n' or
1511 `p' takes you straight through the file.
1513 Without any prefix argument, update the node in which point is located.
1514 Non-nil argument (prefix, if interactive) means update the nodes in the
1517 This command makes it awkward to navigate among sections and
1518 subsections; it should be used only for those documents that are meant
1519 to be read like a novel rather than a reference, and for which the
1520 Info `g*' command is inadequate."
1524 ;; update a single node
1525 (let ((auto-fill-function nil) (auto-fill-hook nil))
1526 (if (not (re-search-backward "^@node" (point-min) t))
1527 (error "Node line not found before this position."))
1528 (texinfo-sequentially-update-the-node)
1530 "Done...sequentially updated the node . You may save the buffer."))
1532 (let ((auto-fill-function nil)
1533 (auto-fill-hook nil)
1534 (beginning (region-beginning))
1536 (if (= end beginning)
1537 (error "Please mark a region!"))
1539 (narrow-to-region beginning end)
1540 (goto-char beginning)
1541 (push-mark (point) t)
1542 (while (re-search-forward "^@node" (point-max) t)
1544 (texinfo-sequentially-update-the-node))
1546 "Done...updated the nodes in sequence. You may save the buffer.")))))
1548 (defun texinfo-sequentially-update-the-node ()
1549 "Update one node such that the pointers are sequential.
1550 A `Next' or `Previous' pointer points to any preceding or following node,
1551 regardless of its hierarchical level."
1553 (texinfo-check-for-node-name)
1554 (texinfo-delete-existing-pointers)
1556 "Sequentially updating node: %s ... " (texinfo-copy-node-name))
1560 ((case-fold-search t)
1561 (level (texinfo-hierarchic-level)))
1562 (if (string-equal level "top")
1563 (texinfo-top-pointer-case)
1565 (texinfo-sequentially-insert-pointer level 'next)
1566 (texinfo-sequentially-insert-pointer level 'previous)
1567 (texinfo-sequentially-insert-pointer level 'up)
1568 (texinfo-clean-up-node-line)))))
1570 (defun texinfo-sequentially-find-pointer (level direction)
1571 "Find next or previous pointer sequentially in Texinfo file, or up pointer.
1572 Move point to section associated with the pointer. Find point even if
1573 it is in a different section.
1575 Return type of pointer (either `normal' or `no-pointer').
1577 The first argument is a string specifying the general kind of section
1578 such as \"chapter\" or \"section\". The section found will be at the
1579 same hierarchical level in the Texinfo file, or, in the case of the up
1580 pointer, some level higher. The second argument (one of `next',
1581 `previous', or `up') specifies whether to find the `Next', `Previous',
1583 (let ((case-fold-search t))
1584 (cond ((eq direction 'next)
1585 (forward-line 3) ; skip over current node
1586 (if (re-search-forward
1587 texinfo-section-types-regexp
1592 ((eq direction 'previous)
1593 (if (re-search-backward
1594 texinfo-section-types-regexp
1600 (if (re-search-backward
1601 (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))
1607 (error "texinfo-sequential-find-pointer: lack proper arguments")))))
1609 (defun texinfo-sequentially-insert-pointer (level direction)
1610 "Insert the `Next', `Previous' or `Up' node name at point.
1613 The first argument is the hierarchical level of the Texinfo file, a
1614 string such as \"section\". The second argument is direction, one of
1615 `next', `previous', or `up'."
1621 (texinfo-pointer-name
1622 (texinfo-sequentially-find-pointer level direction)))))
1625 ;;; Inserting `@node' lines
1626 ;; The `texinfo-insert-node-lines' function inserts `@node' lines as needed
1627 ;; before the `@chapter', `@section', and such like lines of a region
1628 ;; in a Texinfo file.
1630 (defun texinfo-insert-node-lines (beginning end &optional title-p)
1631 "Insert missing `@node' lines in region of Texinfo file.
1632 Non-nil argument (prefix, if interactive) means also to insert the
1633 section titles as node names; and also to insert the section titles as
1634 node names in pre-existing `@node' lines that lack names."
1635 (interactive "r\nP")
1637 ;; Use marker; after inserting node lines, leave point at end of
1638 ;; region and mark at beginning.
1640 (let (beginning-marker end-marker title last-section-position)
1642 ;; Save current position on mark ring and set mark to end.
1644 (setq end-marker (mark-marker))
1646 (goto-char beginning)
1647 (while (re-search-forward
1648 texinfo-section-types-regexp
1651 ;; Copy title if desired.
1656 (skip-chars-forward " \t")
1657 (setq title (buffer-substring
1659 (save-excursion (end-of-line) (point))))))
1660 ;; Insert node line if necessary.
1661 (if (re-search-backward
1663 ;; Avoid finding previous node line if node lines are close.
1664 (or last-section-position
1665 (save-excursion (forward-line -2) (point))) t)
1666 ;; @node is present, and point at beginning of that line
1667 (forward-word 1) ; Leave point just after @node.
1668 ;; Else @node missing; insert one.
1669 (beginning-of-line) ; Beginning of `@section' line.
1671 (backward-char 1)) ; Leave point just after `@node'.
1672 ;; Insert title if desired.
1675 (skip-chars-forward " \t")
1676 ;; Use regexp based on what info looks for
1677 ;; (alternatively, use "[a-zA-Z]+");
1678 ;; this means we only insert a title if none exists.
1679 (if (not (looking-at "[^,\t\n ]+"))
1684 (message "Inserted title %s ... " title)))))
1685 ;; Go forward beyond current section title.
1686 (re-search-forward texinfo-section-types-regexp
1687 (save-excursion (forward-line 3) (point)) t)
1688 (setq last-section-position (point))
1691 ;; Leave point at end of region, mark at beginning.
1692 (set-mark beginning)
1696 "Done inserting node lines and titles. You may save the buffer.")
1697 (message "Done inserting node lines. You may save the buffer."))))
1700 ;;; Update and create menus for multi-file Texinfo sources
1702 ;; 1. M-x texinfo-multiple-files-update
1704 ;; Read the include file list of an outer Texinfo file and
1705 ;; update all highest level nodes in the files listed and insert a
1706 ;; main menu in the outer file after its top node.
1708 ;; 2. C-u M-x texinfo-multiple-files-update
1710 ;; Same as 1, but insert a master menu. (Saves reupdating lower
1711 ;; level menus and nodes.) This command simply reads every menu,
1712 ;; so if the menus are wrong, the master menu will be wrong.
1713 ;; Similarly, if the lower level node pointers are wrong, they
1716 ;; 3. C-u 2 M-x texinfo-multiple-files-update
1718 ;; Read the include file list of an outer Texinfo file and
1719 ;; update all nodes and menus in the files listed and insert a
1720 ;; master menu in the outer file after its top node.
1722 ;;; Note: these functions:
1724 ;;; * Do not save or delete any buffers. You may fill up your memory.
1725 ;;; * Do not handle any pre-existing nodes in outer file.
1726 ;;; Hence, you may need a file for indices.
1729 ;;; Auxiliary functions for multiple file updating
1731 (defun texinfo-multi-file-included-list (outer-file)
1732 "Return a list of the included files in OUTER-FILE."
1733 (let ((included-file-list (list outer-file))
1736 (switch-to-buffer (find-file-noselect outer-file))
1738 (goto-char (point-min))
1739 (while (re-search-forward "^@include" nil t)
1740 (skip-chars-forward " \t")
1741 (setq start (point))
1743 (skip-chars-backward " \t")
1744 (setq included-file-list
1745 (cons (buffer-substring start (point))
1746 included-file-list)))
1747 (nreverse included-file-list))))
1749 (defun texinfo-copy-next-section-title ()
1750 "Return the name of the immediately following section as a string.
1752 Start with point at the beginning of the node line. Leave point at the
1753 same place. If there is no title, returns an empty string."
1759 (if (re-search-forward "\\(^@node\\)" nil t)
1760 (match-beginning 0)))
1762 (if (re-search-forward texinfo-section-types-regexp node-end t)
1768 (progn (forward-word 1) ; skip over section type
1769 (skip-chars-forward " \t") ; and over spaces
1771 (progn (end-of-line) (point)))))
1775 (defun texinfo-multi-file-update (files &optional update-everything)
1776 "Update first node pointers in each file in FILES.
1777 Return a list of the node names.
1779 The first file in the list is an outer file; the remaining are
1780 files included in the outer file with `@include' commands.
1782 If optional arg UPDATE-EVERYTHING non-nil, update every menu and
1783 pointer in each of the included files.
1785 Also update the `Top' level node pointers of the outer file.
1789 * the first file in the FILES list must be the outer file,
1790 * each of the included files must contain exactly one highest
1791 hierarchical level node,
1792 * this node must be the first node in the included file,
1793 * each highest hierarchical level node must be of the same type.
1795 Thus, normally, each included file contains one, and only one, chapter."
1797 ;; The menu-list has the form:
1799 ;; \(\(\"node-name1\" . \"title1\"\)
1800 ;; \(\"node-name2\" . \"title2\"\) ... \)
1802 ;; However, there does not need to be a title field and this function
1803 ;; does not fill it; however a comment tells you how to do so.
1804 ;; You would use the title field if you wanted to insert titles in the
1805 ;; description slot of a menu as a description.
1807 (let ((case-fold-search t)
1810 ;; Find the name of the first node of the first included file.
1811 (switch-to-buffer (find-file-noselect (car (cdr files))))
1813 (goto-char (point-min))
1814 (if (not (re-search-forward "^@node" nil t))
1815 (error "No `@node' line found in %s !" (buffer-name)))
1817 (texinfo-check-for-node-name)
1818 (setq next-node-name (texinfo-copy-node-name))
1823 (prog1 "" (forward-line 1)))
1824 ;; Use following to insert section titles automatically.
1825 ;; (texinfo-copy-next-section-title)
1829 (switch-to-buffer (find-file-noselect (car files)))
1830 (goto-char (point-min))
1831 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t))
1832 (error "This buffer needs a Top node!"))
1834 (texinfo-delete-existing-pointers)
1836 (insert ", " next-node-name ", (dir), (dir)")
1838 (setq previous-node-name "Top")
1839 (setq files (cdr files))
1843 (if (not (cdr files))
1845 (setq next-node-name "")
1847 ;; find the name of the first node in the next file.
1848 (switch-to-buffer (find-file-noselect (car (cdr 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)))
1854 (texinfo-check-for-node-name)
1855 (setq next-node-name (texinfo-copy-node-name))
1859 (prog1 "" (forward-line 1)))
1860 ;; Use following to insert section titles automatically.
1861 ;; (texinfo-copy-next-section-title)
1864 ;; Go to node to be updated.
1865 (switch-to-buffer (find-file-noselect (car files)))
1866 (goto-char (point-min))
1867 (if (not (re-search-forward "^@node" nil t))
1868 (error "No `@node' line found in %s !" (buffer-name)))
1871 ;; Update other menus and nodes if requested.
1872 (if update-everything (texinfo-all-menus-update t))
1875 (texinfo-delete-existing-pointers)
1877 (insert ", " next-node-name ", " previous-node-name ", " up-node-name)
1880 (setq previous-node-name (texinfo-copy-node-name))
1882 (setq files (cdr files)))
1883 (nreverse menu-list)))
1885 (defun texinfo-multi-files-insert-main-menu (menu-list)
1886 "Insert formatted main menu at point.
1887 Indents the first line of the description, if any, to the value of
1888 `texinfo-column-for-description'."
1892 ;; Every menu entry starts with a star and a space.
1895 ;; Insert the node name (and menu entry name, if present).
1896 (let ((node-part (car (car menu-list))))
1897 (if (stringp node-part)
1898 ;; "Double colon" entry line; menu entry and node name are the same,
1899 (insert (format "%s::" node-part))
1900 ;; "Single colon" entry line; menu entry and node name are different.
1901 (insert (format "%s: %s." (car node-part) (cdr node-part)))))
1903 ;; Insert the description, if present.
1904 (if (cdr (car menu-list))
1906 ;; Move to right place.
1907 (indent-to texinfo-column-for-description 2)
1908 ;; Insert description.
1909 (insert (format "%s" (cdr (car menu-list))))))
1911 (insert "\n") ; end this menu entry
1912 (setq menu-list (cdr menu-list)))
1913 (insert "@end menu"))
1915 (defun texinfo-multi-file-master-menu-list (files-list)
1916 "Return master menu list from files in FILES-LIST.
1917 Menu entries in each file collected using `texinfo-master-menu-list'.
1919 The first file in FILES-LIST must be the outer file; the others must
1920 be the files included within it. A main menu must already exist."
1922 (let (master-menu-list)
1924 (switch-to-buffer (find-file-noselect (car files-list)))
1925 (message "Working on: %s " (current-buffer))
1926 (goto-char (point-min))
1927 (setq master-menu-list
1928 (append master-menu-list (texinfo-master-menu-list)))
1929 (setq files-list (cdr files-list)))
1933 ;;; The multiple-file update function
1935 (defun texinfo-multiple-files-update
1936 (outer-file &optional update-everything make-master-menu)
1937 "Update first node pointers in each file included in OUTER-FILE;
1938 create or update the `Top' level node pointers and the main menu in
1939 the outer file that refers to such nodes. This does not create or
1940 update menus or pointers within the included files.
1942 With optional MAKE-MASTER-MENU argument (prefix arg, if interactive),
1943 insert a master menu in OUTER-FILE in addition to creating or updating
1944 pointers in the first @node line in each included file and creating or
1945 updating the `Top' level node pointers of the outer file. This does
1946 not create or update other menus and pointers within the included
1949 With optional UPDATE-EVERYTHING argument (numeric prefix arg, if
1950 interactive), update all the menus and all the `Next', `Previous', and
1951 `Up' pointers of all the files included in OUTER-FILE before inserting
1952 a master menu in OUTER-FILE. Also, update the `Top' level node
1953 pointers of OUTER-FILE.
1957 * this command does NOT save any files--you must save the
1958 outer file and any modified, included files.
1960 * except for the `Top' node, this command does NOT handle any
1961 pre-existing nodes in the outer file; hence, indices must be
1962 enclosed in an included file.
1966 * each of the included files must contain exactly one highest
1967 hierarchical level node,
1968 * this highest node must be the first node in the included file,
1969 * each highest hierarchical level node must be of the same type.
1971 Thus, normally, each included file contains one, and only one,
1976 "Name of outer `include' file: "
1978 (cond ((not current-prefix-arg)
1980 ((listp current-prefix-arg)
1981 '(t nil)) ; make-master-menu
1982 ((numberp current-prefix-arg)
1983 '(t t)) ; update-everything
1986 (let* ((included-file-list (texinfo-multi-file-included-list outer-file))
1987 (files included-file-list)
1991 (up-node-name "Top"))
1993 ;;; Update the pointers
1994 ;;; and collect the names of the nodes and titles
1995 (setq main-menu-list (texinfo-multi-file-update files update-everything))
1997 ;;; Insert main menu
2000 (switch-to-buffer (find-file-noselect (car included-file-list)))
2001 (if (texinfo-old-menu-p
2004 (re-search-forward "^@include")
2008 ;; If found, leave point after word `menu' on the `@menu' line.
2010 (texinfo-incorporate-descriptions main-menu-list)
2011 ;; Delete existing menu.
2015 (save-excursion (re-search-forward "^@end menu") (point)))
2017 (texinfo-multi-files-insert-main-menu main-menu-list))
2019 ;; Else no current menu; insert it before `@include'
2020 (texinfo-multi-files-insert-main-menu main-menu-list))
2022 ;;; Insert master menu
2024 (if make-master-menu
2026 ;; First, removing detailed part of any pre-existing master menu
2027 (goto-char (point-min))
2028 (if (search-forward texinfo-master-menu-header nil t)
2030 (goto-char (match-beginning 0))
2031 ;; Check if @detailmenu kludge is used;
2032 ;; if so, leave point before @detailmenu.
2033 (search-backward "\n@detailmenu"
2034 (save-excursion (forward-line -3) (point))
2036 ;; Remove detailed master menu listing
2037 (let ((end-of-detailed-menu-descriptions
2038 (save-excursion ; beginning of end menu line
2039 (goto-char (texinfo-menu-end))
2040 (beginning-of-line) (forward-char -1)
2042 (delete-region (point) end-of-detailed-menu-descriptions))))
2044 ;; Create a master menu and insert it
2045 (texinfo-insert-master-menu-list
2046 (texinfo-multi-file-master-menu-list
2047 included-file-list)))))
2049 ;; Remove unwanted extra lines.
2051 (goto-char (point-min))
2053 (re-search-forward "^@menu")
2055 (insert "\n") ; Ensure at least one blank line.
2056 (delete-blank-lines)
2058 (re-search-forward "^@end menu")
2060 (insert "\n") ; Ensure at least one blank line.
2061 (delete-blank-lines))
2063 (message "Multiple files updated."))
2066 ;;; Place `provide' at end of file.
2067 (provide 'texnfo-upd)
2069 ;;; texnfo-upd.el ends here