1 ;;; texnfo-upd.el --- utilities for updating nodes and menus in Texinfo files
3 ;; Copyright (C) 1989, 1990, 1991, 1992, 2001 Free Software Foundation, Inc.
5 ;; Author: Robert J. Chassell
6 ;; Maintainer: bug-texinfo@gnu.org
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.
155 (defvar texinfo-master-menu-header
156 " --- The Detailed Node Listing ---\n"
157 "String inserted before lower level entries in Texinfo master menu.
158 It comes after the chapter-level menu entries.")
160 ;; We used to look for just sub, but that found @subtitle.
161 (defvar texinfo-section-types-regexp
162 "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
163 "Regexp matching chapter, section, other headings (but not the top node).")
165 (defvar texinfo-section-level-regexp
166 (regexp-opt (texinfo-filter 3 texinfo-section-list
))
167 "Regular expression matching just the Texinfo section level headings.")
169 (defvar texinfo-subsection-level-regexp
170 (regexp-opt (texinfo-filter 4 texinfo-section-list
))
171 "Regular expression matching just the Texinfo subsection level headings.")
173 (defvar texinfo-subsubsection-level-regexp
174 (regexp-opt (texinfo-filter 5 texinfo-section-list
))
175 "Regular expression matching just the Texinfo subsubsection level headings.")
177 (defvar texinfo-update-menu-same-level-regexps
179 (2 .
(concat "\\(^@\\)\\(" texinfo-chapter-level-regexp
"\\)\\>[ \t]*"))
180 (3 .
(concat "\\(^@\\)\\(" texinfo-section-level-regexp
"\\)\\>[ \t]*"))
181 (4 .
(concat "\\(^@\\)\\(" texinfo-subsection-level-regexp
"\\)\\>[ \t]+"))
182 (5 .
(concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp
"\\)\\>[ \t]+")))
183 "*Regexps for searching for same level sections in a Texinfo file.
184 The keys are strings specifying the general hierarchical level in the
185 document; the values are regular expressions.")
187 (defvar texinfo-update-menu-higher-regexps
188 '((1 .
"^@node [ \t]*DIR")
189 (2 .
"^@node [ \t]*top[ \t]*\\(,\\|$\\)")
193 texinfo-chapter-level-regexp
198 texinfo-section-level-regexp
200 texinfo-chapter-level-regexp
205 texinfo-subsection-level-regexp
207 texinfo-section-level-regexp
209 texinfo-chapter-level-regexp
211 "*Regexps for searching for higher level sections in a Texinfo file.
212 The keys are strings specifying the general hierarchical level in the
213 document; the values are regular expressions.")
215 (defvar texinfo-update-menu-lower-regexps
219 texinfo-chapter-level-regexp
221 texinfo-section-level-regexp
223 texinfo-subsection-level-regexp
225 texinfo-subsubsection-level-regexp
230 texinfo-section-level-regexp
232 texinfo-subsection-level-regexp
234 texinfo-subsubsection-level-regexp
239 texinfo-subsection-level-regexp
241 texinfo-subsubsection-level-regexp
246 texinfo-subsubsection-level-regexp
248 ;; There's nothing below 5, use a bogus regexp that can't match.
250 "*Regexps for searching for lower level sections in a Texinfo file.
251 The keys are strings specifying the general hierarchical level in the
252 document; the values are regular expressions.")
255 (defun texinfo-make-menu (&optional beginning end
)
256 "Without any prefix argument, make or update a menu.
257 Make the menu for the section enclosing the node found following point.
259 A prefix argument means make or update menus
260 for nodes within or part of the marked region.
262 Whenever a menu exists, and is being updated, the descriptions that
263 are associated with node names in the pre-existing menu are
264 incorporated into the new menu. Otherwise, the nodes' section titles
265 are inserted as descriptions."
269 (list (point) (mark))))
271 (let ((level (texinfo-hierarchic-level)))
272 (texinfo-make-one-menu level
)
273 (message "Menu updated"))
275 (message "Making or updating menus in %s... " (buffer-name))
277 (goto-char (min beginning end
))
278 ;; find section type following point
279 (let ((level (texinfo-hierarchic-level))
280 (region-end-marker (make-marker)))
281 (set-marker region-end-marker
(max beginning end
))
285 (while (texinfo-find-lower-level-node
286 level
(marker-position region-end-marker
))
287 (setq level
(texinfo-hierarchic-level)) ; new, lower level
288 (texinfo-make-one-menu level
))
290 (while (and (< (point) (marker-position region-end-marker
))
291 (texinfo-find-higher-level-node
292 level
(marker-position region-end-marker
)))
293 (setq level
(texinfo-hierarchic-level))
294 ;; Don't allow texinfo-find-higher-level-node
295 ;; to find the same node again.
297 (while (texinfo-find-lower-level-node
298 level
(marker-position region-end-marker
))
299 (setq level
(texinfo-hierarchic-level)) ; new, lower level
300 (texinfo-make-one-menu level
))))))
301 (message "Making or updating menus in %s...done" (buffer-name))))
303 (defun texinfo-make-one-menu (level)
304 "Make a menu of all the appropriate nodes in this section.
305 `Appropriate nodes' are those associated with sections that are
306 at the level specified by LEVEL. Point is left at the end of menu."
308 ((case-fold-search t
)
311 (goto-char (texinfo-update-menu-region-beginning level
))
314 (end (texinfo-update-menu-region-end level
))
315 (first (texinfo-menu-first-node beginning end
))
317 (goto-char beginning
)
319 (texinfo-copy-node-name)))
320 (new-menu-list (texinfo-make-menu-list beginning end level
)))
321 (when (texinfo-old-menu-p beginning first
)
322 (texinfo-incorporate-descriptions new-menu-list
)
323 (texinfo-incorporate-menu-entry-names new-menu-list
)
324 (texinfo-delete-old-menu beginning first
))
325 (texinfo-insert-menu new-menu-list node-name
)))
327 (defun texinfo-all-menus-update (&optional update-all-nodes-p
)
328 "Update every regular menu in a Texinfo file.
329 Update pre-existing master menu, if there is one.
331 If called with a non-nil argument, this function first updates all the
332 nodes in the buffer before updating the menus."
334 (let ((case-fold-search t
)
337 (push-mark (point-max) t
)
338 (goto-char (point-min))
339 (message "Checking for a master menu in %s ... "(buffer-name))
341 (when (search-forward texinfo-master-menu-header nil t
)
342 ;; Check if @detailmenu kludge is used;
343 ;; if so, leave point before @detailmenu.
344 (search-backward "\n@detailmenu"
345 (save-excursion (forward-line -
3) (point))
347 ;; Remove detailed master menu listing
348 (setq master-menu-p t
)
349 (goto-char (match-beginning 0))
350 (let ((end-of-detailed-menu-descriptions
351 (save-excursion ; beginning of end menu line
352 (goto-char (texinfo-menu-end))
353 (beginning-of-line) (forward-char -
1)
355 (delete-region (point) end-of-detailed-menu-descriptions
))))
357 (when update-all-nodes-p
358 (message "Updating all nodes in %s ... " (buffer-name))
359 (texinfo-update-node (point-min) (point-max)))
361 (message "Updating all menus in %s ... " (buffer-name))
362 (texinfo-make-menu (point-max) (point-min))
365 (message "Updating the master menu in %s... " (buffer-name))
366 (texinfo-master-menu nil
)))
368 (message "Done...updated all the menus. You may save the buffer.")))
370 (defun texinfo-find-lower-level-node (level region-end
)
371 "Search forward from point for node at any level lower than LEVEL.
372 Search is limited to the end of the marked region, REGION-END,
373 and to the end of the menu region for the level.
375 Return t if the node is found, else nil. Leave point at the beginning
376 of the node if one is found; else do not move point."
377 (let ((case-fold-search t
))
378 (if (and (< (point) region-end
)
381 "\\(^@node\\).*\n" ; match node line
382 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
384 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
386 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
387 "\\)?" ; end of expression
388 (eval (cdr (assoc level texinfo-update-menu-lower-regexps
))))
389 ;; the next higher level node marks the end of this
390 ;; section, and no lower level node will be found beyond
391 ;; this position even if region-end is farther off
392 (texinfo-update-menu-region-end level
)
394 (goto-char (match-beginning 1)))))
396 (defun texinfo-find-higher-level-node (level region-end
)
397 "Search forward from point for node at any higher level than argument LEVEL.
398 Search is limited to the end of the marked region, REGION-END.
400 Return t if the node is found, else nil. Leave point at the beginning
401 of the node if one is found; else do not move point.
403 A `@node' line starting at point does count as a match;
404 if the match is found there, the value is t and point does not move."
406 (let ((case-fold-search t
))
409 (if (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t
)
410 (progn (beginning-of-line) t
)))
412 (when (re-search-forward
414 "\\(^@node\\).*\n" ; match node line
415 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
417 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
419 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
420 "\\)?" ; end of expression
421 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
))))
423 (beginning-of-line) t
)))))
426 ;;; Making the list of new menu entries
428 (defun texinfo-make-menu-list (beginning end level
)
429 "Make a list of node names and their descriptions.
430 Point is left at the end of the menu region, but the menu is not inserted.
432 First argument is position from which to start making menu list;
433 second argument is end of region in which to try to locate entries;
434 third argument is the level of the nodes that are the entries.
436 Node names and descriptions are dotted pairs of strings. Each pair is
437 an element of the list. If the description does not exist, the
438 element consists only of the node name."
439 (goto-char beginning
)
441 (while (texinfo-menu-locate-entry-p level end
)
443 (texinfo-copy-node-name)
444 (prog1 "" (forward-line 1)))
445 ;; Use following to insert section titles automatically.
446 ;; (texinfo-copy-section-title))
448 (nreverse new-menu-list
)))
450 (defun texinfo-menu-locate-entry-p (level search-end
)
451 "Find a node that will be part of menu for this section.
452 First argument is a string such as \"section\" specifying the general
453 hierarchical level of the menu; second argument is a position
454 specifying the end of the search.
456 The function returns t if the node is found, else nil. It searches
457 forward from point, and leaves point at the beginning of the node.
459 The function finds entries of the same type. Thus `subsections' and
460 `unnumberedsubsecs' will appear in the same menu."
461 (let ((case-fold-search t
))
462 (if (re-search-forward
464 "\\(^@node\\).*\n" ; match node line
465 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
467 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
469 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
470 "\\)?" ; end of expression
472 (cdr (assoc level texinfo-update-menu-same-level-regexps
))))
475 (goto-char (match-beginning 1)))))
477 (defun texinfo-copy-node-name ()
478 "Return the node name as a string.
480 Start with point at the beginning of the node line; copy the text
481 after the node command up to the first comma on the line, if any, and
482 return the text as a string. Leaves point at the beginning of the
483 line. If there is no node name, returns an empty string."
487 (progn (forward-word 1) ; skip over node command
488 (skip-chars-forward " \t") ; and over spaces
490 (if (search-forward "," (line-end-position) t
) ; bound search
492 (end-of-line) (point)))))
494 (defun texinfo-copy-section-title ()
495 "Return the title of the section as a string.
496 The title is used as a description line in the menu when one does not
499 Move point to the beginning of the appropriate section line by going
500 to the start of the text matched by last regexp searched for, which
501 must have been done by `texinfo-menu-locate-entry-p'."
503 ;; could use the same re-search as in `texinfo-menu-locate-entry-p'
504 ;; instead of using `match-beginning'; such a variation would be
505 ;; more general, but would waste information already collected
507 (goto-char (match-beginning 7)) ; match section name
510 (progn (forward-word 1) ; skip over section type
511 (skip-chars-forward " \t") ; and over spaces
513 (progn (end-of-line) (point))))
516 ;;; Handling the old menu
518 (defun texinfo-old-menu-p (beginning first
)
519 "Move point to the beginning of the menu for this section, if any.
520 Otherwise move point to the end of the first node of this section.
521 Return t if a menu is found, nil otherwise.
523 First argument is the position of the beginning of the section in which
524 the menu will be located; second argument is the position of the first
525 node within the section.
527 If no menu is found, the function inserts two newlines just before the
528 end of the section, and leaves point there where a menu ought to be."
529 (goto-char beginning
)
530 (if (re-search-forward "^@menu" first
'goto-end
)
532 (insert "\n\n") (forward-line -
2) nil
))
534 (defun texinfo-incorporate-descriptions (new-menu-list)
535 "Copy the old menu line descriptions that exist to the new menu.
537 Point must be at beginning of old menu.
539 If the node-name of the new menu is found in the old menu, insert the
540 old description into the new entry.
542 For this function, the new menu is a list made up of lists of dotted
543 pairs in which the first element of the pair is the node name and the
544 second element the description. The new menu is changed destructively.
545 The old menu is the menu as it appears in the Texinfo file."
547 (let ((end-of-menu (texinfo-menu-end)))
548 (dolist (new-menu new-menu-list new-menu-list
)
549 (save-excursion ; keep point at beginning of menu
550 (when (re-search-forward
551 ;; Existing nodes can have the form
552 ;; * NODE NAME:: DESCRIPTION
554 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
556 ;; Recognize both when looking for the description.
557 (concat "\\* \\(" ; so only menu entries are found
558 (regexp-quote (car new-menu
)) "::"
560 ".*: " (regexp-quote (car new-menu
)) "[.,\t\n]"
562 ) ; so only complete entries are found
565 (setcdr new-menu
(texinfo-menu-copy-old-description end-of-menu
)))))))
567 (defun texinfo-incorporate-menu-entry-names (new-menu-list)
568 "Copy any old menu entry names to the new menu.
570 Point must be at beginning of old menu.
572 If the node-name of the new menu entry cannot be found in the old
575 For this function, the new menu is a list made up of lists of dotted
576 pairs in which the first element of the pair is the node name and the
577 second element is the description (or nil).
579 If we find an existing menu entry name, we change the first element of
580 the pair to be another dotted pair in which the car is the menu entry
581 name and the cdr is the node name.
583 NEW-MENU-LIST is changed destructively. The old menu is the menu as it
584 appears in the texinfo file."
586 (let ((end-of-menu (texinfo-menu-end)))
587 (dolist (new-menu new-menu-list new-menu-list
)
588 (save-excursion ; keep point at beginning of menu
589 (if (re-search-forward
590 ;; Existing nodes can have the form
591 ;; * NODE NAME:: DESCRIPTION
593 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
595 ;; We're interested in the second case.
596 (concat "\\* " ; so only menu entries are found
597 "\\(.*\\): " (regexp-quote (car new-menu
))
602 new-menu
; replace the node name
603 (cons (buffer-substring (match-beginning 1) (match-end 1))
604 (car new-menu
))))))))
606 (defun texinfo-menu-copy-old-description (end-of-menu)
607 "Return description field of old menu line as string.
608 Point must be located just after the node name. Point left before description.
609 Single argument, END-OF-MENU, is position limiting search."
610 (skip-chars-forward "[:.,\t\n ]+")
611 ;; don't copy a carriage return at line beginning with asterisk!
612 ;; do copy a description that begins with an `@'!
613 ;; !! Known bug: does not copy descriptions starting with ^|\{?* etc.
614 (if (and (looking-at "\\(\\w+\\|@\\)")
615 (not (looking-at "\\(^\\* \\|^@end menu\\)")))
619 (re-search-forward "\\(^\\* \\|^@end menu\\)" end-of-menu t
)
621 (end-of-line) ; go to end of last description line
625 (defun texinfo-menu-end ()
626 "Return position of end of menu, but don't move point.
627 Signal an error if not end of menu."
629 (if (re-search-forward "^@end menu" nil t
)
631 (error "Menu does not have an end"))))
633 (defun texinfo-delete-old-menu (beginning first
)
634 "Delete the old menu. Point must be in or after menu.
635 First argument is position of the beginning of the section in which
636 the menu will be located; second argument is the position of the first
637 node within the section."
638 ;; No third arg to search, so error if search fails.
639 (re-search-backward "^@menu" beginning
)
640 (delete-region (point)
642 (re-search-forward "^@end menu" first
)
646 ;;; Inserting new menu
648 ;; try 32, but perhaps 24 is better
649 (defvar texinfo-column-for-description
32
650 "*Column at which descriptions start in a Texinfo menu.")
652 (defun texinfo-insert-menu (menu-list node-name
)
653 "Insert formatted menu at point.
654 Indents the first line of the description, if any, to the value of
655 texinfo-column-for-description.
659 \(\(\"node-name1\" . \"description\"\)
660 \(\"node-name2\" . \"description\"\) ... \)
662 However, the description field might be nil.
664 Also, the node-name field might itself be a dotted pair (call it P) of
665 strings instead of just a string. In that case, the car of P
666 is the menu entry name, and the cdr of P is the node name."
669 (dolist (menu menu-list
)
670 ;; Every menu entry starts with a star and a space.
673 ;; Insert the node name (and menu entry name, if present).
674 (let ((node-part (car menu
)))
675 (if (stringp node-part
)
676 ;; "Double colon" entry line; menu entry and node name are the same,
677 (insert (format "%s::" node-part
))
678 ;; "Single colon" entry line; menu entry and node name are different.
679 (insert (format "%s: %s." (car node-part
) (cdr node-part
)))))
681 ;; Insert the description, if present.
683 ;; Move to right place.
684 (indent-to texinfo-column-for-description
2)
685 ;; Insert description.
686 (insert (format "%s" (cdr menu
))))
688 (insert "\n")) ; end this menu entry
691 ;; FIXME: `level' is passed by dynamic scoping.
692 "Updated \"%s\" level menu following node: %s ... " level node-name
))
695 ;;; Starting menu descriptions by inserting titles
697 (defun texinfo-start-menu-description ()
698 "In this menu entry, insert the node's section title as a description.
699 Position point at beginning of description ready for editing.
700 Do not insert a title if the line contains an existing description.
702 You will need to edit the inserted text since a useful description
703 complements the node name rather than repeats it as a title does."
706 (let (beginning end node-name title
)
709 (if (search-forward "* " (save-excursion (end-of-line) (point)) t
)
710 (progn (skip-chars-forward " \t")
711 (setq beginning
(point)))
712 (error "This is not a line in a menu"))
715 ;; "Double colon" entry line; menu entry and node name are the same,
716 ((search-forward "::" (save-excursion (end-of-line) (point)) t
)
717 (if (looking-at "[ \t]*[^ \t\n]+")
718 (error "Descriptive text already exists"))
719 (skip-chars-backward ": \t")
720 (setq node-name
(buffer-substring beginning
(point))))
722 ;; "Single colon" entry line; menu entry and node name are different.
723 ((search-forward ":" (save-excursion (end-of-line) (point)) t
)
724 (skip-chars-forward " \t")
725 (setq beginning
(point))
726 ;; Menu entry line ends in a period, comma, or tab.
727 (if (re-search-forward "[.,\t]"
728 (save-excursion (forward-line 1) (point)) t
)
730 (if (looking-at "[ \t]*[^ \t\n]+")
731 (error "Descriptive text already exists"))
732 (skip-chars-backward "., \t")
733 (setq node-name
(buffer-substring beginning
(point))))
734 ;; Menu entry line ends in a return.
735 (re-search-forward ".*\n"
736 (save-excursion (forward-line 1) (point)) t
)
737 (skip-chars-backward " \t\n")
738 (setq node-name
(buffer-substring beginning
(point)))
739 (if (= 0 (length node-name
))
740 (error "No node name on this line")
742 (t (error "No node name on this line")))
743 ;; Search for node that matches node name, and copy the section title.
744 (if (re-search-forward
747 (regexp-quote node-name
)
748 ".*\n" ; match node line
750 "\\(\\(^@c \\|^@comment\\).*\n\\)" ; match comment line, if any
752 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
754 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
755 "\\)?" ; end of expression
760 ;; skip over section type
761 (progn (forward-word 1)
763 (skip-chars-forward " \t")
766 (skip-chars-backward " \t")
768 (error "Cannot find node to match node name in menu entry")))
769 ;; Return point to the menu and insert the title.
773 (save-excursion (skip-chars-backward " \t") (point)))
774 (indent-to texinfo-column-for-description
2)
775 (save-excursion (insert title
))))
778 ;;; Handling description indentation
780 ;; Since the make-menu functions indent descriptions, these functions
781 ;; are useful primarily for indenting a single menu specially.
783 (defun texinfo-indent-menu-description (column &optional region-p
)
784 "Indent every description in menu following point to COLUMN.
785 Non-nil argument (prefix, if interactive) means indent every
786 description in every menu in the region. Does not indent second and
787 subsequent lines of a multi-line description."
790 "nIndent menu descriptions to (column number): \nP")
796 (re-search-forward "^@menu")
797 (texinfo-menu-indent-description column
)
799 "Indented descriptions in menu. You may save the buffer."))
801 (message "Indenting every menu description in region... ")
802 (goto-char (region-beginning))
803 (while (and (< (point) (region-end))
804 (texinfo-locate-menu-p))
806 (texinfo-menu-indent-description column
))
807 (message "Indenting done. You may save the buffer.")))))
809 (defun texinfo-menu-indent-description (to-column-number)
810 "Indent the Texinfo file menu description to TO-COLUMN-NUMBER.
811 Start with point just after the word `menu' in the `@menu' line and
812 leave point on the line before the `@end menu' line. Does not indent
813 second and subsequent lines of a multi-line description."
814 (let* ((beginning-of-next-line (point)))
815 (while (< beginning-of-next-line
816 (save-excursion ; beginning of end menu line
817 (goto-char (texinfo-menu-end))
821 (when (re-search-forward "\\* \\(.*::\\|.*: [^.,\t\n]+[.,\t]\\)"
824 (let ((beginning-white-space (point)))
825 (skip-chars-forward " \t") ; skip over spaces
826 (if (looking-at "\\(@\\|\\w\\)+") ; if there is text
828 ;; remove pre-existing indentation
829 (delete-region beginning-white-space
(point))
830 (indent-to-column to-column-number
)))))
831 ;; position point at beginning of next line
833 (setq beginning-of-next-line
(point)))))
836 ;;; Making the master menu
838 (defun texinfo-master-menu (update-all-nodes-menus-p)
839 "Make a master menu for a whole Texinfo file.
840 Non-nil argument (prefix, if interactive) means first update all
841 existing nodes and menus. Remove pre-existing master menu, if there is one.
843 This function creates a master menu that follows the top node. The
844 master menu includes every entry from all the other menus. It
845 replaces any existing ordinary menu that follows the top node.
847 If called with a non-nil argument, this function first updates all the
848 menus in the buffer (incorporating descriptions from pre-existing
849 menus) before it constructs the master menu.
851 The function removes the detailed part of an already existing master
852 menu. This action depends on the pre-existing master menu using the
853 standard `texinfo-master-menu-header'.
855 The master menu has the following format, which is adapted from the
856 recommendation in the Texinfo Manual:
858 * The first part contains the major nodes in the Texinfo file: the
859 nodes for the chapters, chapter-like sections, and the major
860 appendices. This includes the indices, so long as they are in
861 chapter-like sections, such as unnumbered sections.
863 * The second and subsequent parts contain a listing of the other,
864 lower level menus, in order. This way, an inquirer can go
865 directly to a particular node if he or she is searching for
866 specific information.
868 Each of the menus in the detailed node listing is introduced by the
869 title of the section containing the menu."
872 (let ((case-fold-search t
))
874 (goto-char (point-min))
876 ;; Move point to location after `top'.
877 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
))
878 (error "This buffer needs a Top node"))
882 (or (re-search-forward "^@node" nil t
)
883 (error "Too few nodes for a master menu"))
885 (if (search-forward texinfo-master-menu-header first-chapter t
)
887 ;; Check if @detailmenu kludge is used;
888 ;; if so, leave point before @detailmenu.
889 (search-backward "\n@detailmenu"
890 (save-excursion (forward-line -
3) (point))
892 ;; Remove detailed master menu listing
893 (goto-char (match-beginning 0))
894 (let ((end-of-detailed-menu-descriptions
895 (save-excursion ; beginning of end menu line
896 (goto-char (texinfo-menu-end))
897 (beginning-of-line) (forward-char -
1)
899 (delete-region (point) end-of-detailed-menu-descriptions
)))))
901 (if update-all-nodes-menus-p
903 (message "Making a master menu in %s ...first updating all nodes... "
905 (texinfo-update-node (point-min) (point-max))
907 (message "Updating all menus in %s ... " (buffer-name))
908 (texinfo-make-menu (point-min) (point-max))))
910 (message "Now making the master menu in %s... " (buffer-name))
911 (goto-char (point-min))
912 (texinfo-insert-master-menu-list
913 (texinfo-master-menu-list))
915 ;; Remove extra newlines that texinfo-insert-master-menu-list
916 ;; may have inserted.
919 (goto-char (point-min))
921 (if (search-forward texinfo-master-menu-header nil t
)
923 (goto-char (match-beginning 0))
924 ;; Check if @detailmenu kludge is used;
925 ;; if so, leave point before @detailmenu.
926 (search-backward "\n@detailmenu"
927 (save-excursion (forward-line -
3) (point))
931 (goto-char (point-min))))
933 (re-search-forward "^@menu")
937 (re-search-forward "^@end menu")
939 (delete-blank-lines))
942 "Done...completed making master menu. You may save the buffer.")))
944 (defun texinfo-master-menu-list ()
945 "Return a list of menu entries and header lines for the master menu.
947 Start with the menu for chapters and indices and then find each
948 following menu and the title of the node preceding that menu.
950 The master menu list has this form:
952 \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\)
953 \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\)
956 However, there does not need to be a title field."
958 (let (master-menu-list)
959 (while (texinfo-locate-menu-p)
960 (push (list (texinfo-copy-menu) (texinfo-copy-menu-title))
962 (nreverse master-menu-list
)))
964 (defun texinfo-insert-master-menu-list (master-menu-list)
965 "Format and insert the master menu in the current buffer."
966 (goto-char (point-min))
967 ;; Insert a master menu only after `Top' node and before next node
968 ;; \(or include file if there is no next node\).
969 (unless (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
)
970 (error "This buffer needs a Top node"))
972 (save-excursion (re-search-forward "^@node\\|^@include") (point))))
973 (unless (re-search-forward "^@menu" first-chapter t
)
974 (error "Buffer lacks ordinary `Top' menu in which to insert master")))
976 (delete-region ; buffer must have ordinary top menu
978 (save-excursion (re-search-forward "^@end menu") (point)))
981 ;; `master-menu-inserted-p' is a kludge to tell
982 ;; whether to insert @end detailmenu (see bleow)
983 (let (master-menu-inserted-p)
984 ;; Handle top of menu
986 ;; Insert chapter menu entries. Tell user what is going on.
987 (message "Inserting chapter menu entry: %s ... "
988 (car (car master-menu-list
)))
989 (dolist (entry (reverse (car (car master-menu-list
))))
990 (insert "* " entry
"\n"))
992 (setq master-menu-list
(cdr master-menu-list
))
994 ;; Only insert detailed master menu if there is one....
995 (if (car (car master-menu-list
))
996 (progn (setq master-menu-inserted-p t
)
997 (insert (concat "\n@detailmenu\n"
998 texinfo-master-menu-header
))))
1000 ;; @detailmenu added 5 Sept 1996 to `texinfo-master-menu-header'
1001 ;; at Karl Berry's request to avert a bug in `makeinfo';
1002 ;; all agree this is a bad kludge and should eventually be removed.
1003 ;; @detailmenu ... @end detailmenu is a noop in `texinfmt.el'.
1004 ;; See @end detailmenu below;
1005 ;; also see `texinfo-all-menus-update' above, `texinfo-master-menu',
1006 ;; `texinfo-multiple-files-update'.
1008 ;; Now, insert all the other menus
1010 ;; The menu master-menu-list has a form like this:
1011 ;; ((("beta" "alpha") "title-A")
1012 ;; (("delta" "gamma") "title-B"))
1014 (dolist (menu master-menu-list
)
1016 (message "Inserting menu for %s .... " (cadr menu
))
1017 ;; insert title of menu section
1018 (insert "\n" (cadr menu
) "\n\n")
1020 ;; insert each menu entry
1021 (dolist (entry (reverse (car menu
)))
1022 (insert "* " entry
"\n")))
1026 ;; @detailmenu (see note above)
1027 ;; Only insert @end detailmenu if a master menu was inserted.
1028 (if master-menu-inserted-p
1029 (insert "\n@end detailmenu"))
1030 (insert "\n@end menu\n\n"))))
1032 (defun texinfo-locate-menu-p ()
1033 "Find the next menu in the texinfo file.
1034 If found, leave point after word `menu' on the `@menu' line, and return t.
1035 If a menu is not found, do not move point and return nil."
1036 (re-search-forward "\\(^@menu\\)" nil t
))
1038 (defun texinfo-copy-menu-title ()
1039 "Return the title of the section preceding the menu as a string.
1040 If such a title cannot be found, return an empty string. Do not move
1042 (let ((case-fold-search t
))
1044 (if (re-search-backward
1048 texinfo-section-types-regexp
; all other section types
1054 (forward-word 1) ; skip over section type
1055 (skip-chars-forward " \t") ; and over spaces
1058 (progn (end-of-line) (point))))
1061 (defun texinfo-copy-menu ()
1062 "Return the entries of an existing menu as a list.
1063 Start with point just after the word `menu' in the `@menu' line
1064 and leave point on the line before the `@end menu' line."
1065 (let* (this-menu-list
1066 (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu'
1067 (last-entry (save-excursion ; position of beginning of
1069 (goto-char end-of-menu
)
1070 ;; handle multi-line description
1071 (if (not (re-search-backward "^\\* " nil t
))
1072 (error "No entries in menu"))
1074 (while (< (point) last-entry
)
1075 (if (re-search-forward "^\\* " end-of-menu t
)
1076 (push (buffer-substring
1078 ;; copy multi-line descriptions
1080 (re-search-forward "\\(^\\* \\|^@e\\)" nil t
)
1086 ;;; Determining the hierarchical level in the texinfo file
1088 (defun texinfo-specific-section-type ()
1089 "Return the specific type of next section, as a string.
1090 For example, \"unnumberedsubsec\". Return \"top\" for top node.
1092 Searches forward for a section. Hence, point must be before the
1093 section whose type will be found. Does not move point. Signal an
1094 error if the node is not the top node and a section is not found."
1095 (let ((case-fold-search t
))
1098 ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1099 ;; Following search limit by cph but causes a bug
1100 ;;(line-end-position)
1104 ((re-search-forward texinfo-section-types-regexp nil t
)
1105 (buffer-substring-no-properties
1106 (progn (beginning-of-line) ; copy its name
1108 (progn (forward-word 1)
1112 "texinfo-specific-section-type: Chapter or section not found"))))))
1114 (defun texinfo-hierarchic-level ()
1115 "Return the general hierarchal level of the next node in a texinfo file.
1116 Thus, a subheading or appendixsubsec is of type subsection."
1117 (let ((case-fold-search t
))
1119 (texinfo-specific-section-type)
1120 texinfo-section-list
))))
1123 ;;; Locating the major positions
1125 (defun texinfo-update-menu-region-beginning (level)
1126 "Locate beginning of higher level section this section is within.
1127 Return position of the beginning of the node line; do not move point.
1128 Thus, if this level is subsection, searches backwards for section node.
1129 Only argument is a string of the general type of section."
1130 (let ((case-fold-search t
))
1131 ;; !! Known bug: if section immediately follows top node, this
1132 ;; returns the beginning of the buffer as the beginning of the
1133 ;; higher level section.
1137 (goto-char (point-min))
1138 (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
)
1145 "\\(^@node\\).*\n" ; match node line
1146 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1148 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
1150 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
1151 "\\)?" ; end of expression
1153 (cdr (assoc level texinfo-update-menu-higher-regexps
))))
1158 (defun texinfo-update-menu-region-end (level)
1159 "Locate end of higher level section this section is within.
1160 Return position; do not move point. Thus, if this level is a
1161 subsection, find the node for the section this subsection is within.
1162 If level is top or chapter, returns end of file. Only argument is a
1163 string of the general type of section."
1164 (let ((case-fold-search t
))
1166 (if (re-search-forward
1168 "\\(^@node\\).*\n" ; match node line
1169 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1171 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
1173 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
1174 "\\)?" ; end of expression
1176 ;; Never finds end of level above chapter so goes to end.
1177 (cdr (assoc level texinfo-update-menu-higher-regexps
))))
1183 (defun texinfo-menu-first-node (beginning end
)
1184 "Locate first node of the section the menu will be placed in.
1185 Return position; do not move point.
1186 The menu will be located just before this position.
1188 First argument is the position of the beginning of the section in
1189 which the menu will be located; second argument is the position of the
1190 end of that region; it limits the search."
1193 (goto-char beginning
)
1195 (re-search-forward "^@node" end t
)
1202 (defun texinfo-update-node (&optional beginning end
)
1203 "Without any prefix argument, update the node in which point is located.
1204 Interactively, a prefix argument means to operate on the region.
1206 The functions for creating or updating nodes and menus, and their
1209 texinfo-update-node (&optional beginning end) \\[texinfo-update-node]
1210 texinfo-every-node-update () \\[texinfo-every-node-update]
1211 texinfo-sequential-node-update (&optional region-p)
1213 texinfo-make-menu (&optional region-p) \\[texinfo-make-menu]
1214 texinfo-all-menus-update () \\[texinfo-all-menus-update]
1215 texinfo-master-menu ()
1217 texinfo-indent-menu-description (column &optional region-p)
1219 The `texinfo-column-for-description' variable specifies the column to
1220 which menu descriptions are indented. Its default value is 32."
1224 (list (point) (mark))))
1225 (if (null beginning
)
1226 ;; Update a single node.
1227 (let ((auto-fill-function nil
))
1228 (if (not (re-search-backward "^@node" (point-min) t
))
1229 (error "Node line not found before this position"))
1230 (texinfo-update-the-node)
1231 (message "Done...updated the node. You may save the buffer."))
1233 (let ((auto-fill-function nil
))
1236 (narrow-to-region beginning end
)
1237 (goto-char (point-min))
1238 (while (re-search-forward "^@node" (point-max) t
)
1240 (texinfo-update-the-node))
1241 (goto-char (point-max))
1242 (message "Done...nodes updated in region. You may save the buffer."))))))
1244 (defun texinfo-every-node-update ()
1245 "Update every node in a Texinfo file."
1248 (texinfo-update-node (point-min) (point-max))
1249 (message "Done...updated every node. You may save the buffer.")))
1251 (defun texinfo-update-the-node ()
1252 "Update one node. Point must be at the beginning of node line.
1253 Leave point at the end of the node line."
1254 (texinfo-check-for-node-name)
1255 (texinfo-delete-existing-pointers)
1256 (message "Updating node: %s ... " (texinfo-copy-node-name))
1260 ((case-fold-search t
)
1261 (level (texinfo-hierarchic-level))
1262 (beginning (texinfo-update-menu-region-beginning level
))
1263 (end (texinfo-update-menu-region-end level
)))
1265 (texinfo-top-pointer-case)
1267 (texinfo-insert-pointer beginning end level
'next
)
1268 (texinfo-insert-pointer beginning end level
'previous
)
1269 (texinfo-insert-pointer beginning end level
'up
)
1270 (texinfo-clean-up-node-line)))))
1272 (defun texinfo-top-pointer-case ()
1273 "Insert pointers in the Top node. This is a special case.
1275 The `Next' pointer is a pointer to a chapter or section at a lower
1276 hierarchical level in the file. The `Previous' and `Up' pointers are
1277 to `(dir)'. Point must be at the beginning of the node line, and is
1278 left at the end of the node line."
1280 (texinfo-clean-up-node-line)
1283 ;; There may be an @chapter or other such command between
1284 ;; the top node line and the next node line, as a title
1285 ;; for an `ifinfo' section. This @chapter command must
1286 ;; must be skipped. So the procedure is to search for
1287 ;; the next `@node' line, and then copy its name.
1288 (if (re-search-forward "^@node" nil t
)
1291 (texinfo-copy-node-name))
1295 (defun texinfo-check-for-node-name ()
1296 "Determine whether the node has a node name. Prompt for one if not.
1297 Point must be at beginning of node line. Does not move point."
1299 (let ((initial (texinfo-copy-next-section-title)))
1300 ;; This is not clean. Use `interactive' to read the arg.
1301 (forward-word 1) ; skip over node command
1302 (skip-chars-forward " \t") ; and over spaces
1303 (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what Info looks for
1304 ; alternatively, use "[a-zA-Z]+"
1306 (read-from-minibuffer
1307 "Node name (use no @, commas, colons, or apostrophes): "
1309 (insert " " node-name
))))))
1311 (defun texinfo-delete-existing-pointers ()
1312 "Delete `Next', `Previous', and `Up' pointers.
1313 Starts from the current position of the cursor, and searches forward
1314 on the line for a comma and if one is found, deletes the rest of the
1315 line, including the comma. Leaves point at beginning of line."
1316 (let ((eol-point (save-excursion (end-of-line) (point))))
1317 (if (search-forward "," eol-point t
)
1318 (delete-region (1- (point)) eol-point
)))
1319 (beginning-of-line))
1321 (defun texinfo-find-pointer (beginning end level direction
)
1322 "Move point to section associated with next, previous, or up pointer.
1323 Return type of pointer (either `normal' or `no-pointer').
1325 The first and second arguments bound the search for a pointer to the
1326 beginning and end, respectively, of the enclosing higher level
1327 section. The third argument is a string specifying the general kind
1328 of section such as \"chapter\" or \"section\". When looking for the
1329 `Next' pointer, the section found will be at the same hierarchical
1330 level in the Texinfo file; when looking for the `Previous' pointer,
1331 the section found will be at the same or higher hierarchical level in
1332 the Texinfo file; when looking for the `Up' pointer, the section found
1333 will be at some level higher in the Texinfo file. The fourth argument
1334 \(one of 'next, 'previous, or 'up\) specifies whether to find the
1335 `Next', `Previous', or `Up' pointer."
1336 (let ((case-fold-search t
))
1337 (cond ((eq direction
'next
)
1338 (forward-line 3) ; skip over current node
1339 ;; Search for section commands accompanied by node lines;
1340 ;; ignore section commands in the middle of nodes.
1341 (if (re-search-forward
1342 ;; A `Top' node is never a next pointer, so won't find it.
1346 ;; Match comment, ifinfo, ifnottex line, if any
1351 "\\(^@ifinfo[ ]*\n\\)"
1353 "\\(^@ifnottex[ ]*\n\\)"
1356 (cdr (assoc level texinfo-update-menu-same-level-regexps
))))
1361 ((eq direction
'previous
)
1362 (if (re-search-backward
1367 ;; Match comment, ifinfo, ifnottex line, if any
1372 "\\(^@ifinfo[ ]*\n\\)"
1374 "\\(^@ifnottex[ ]*\n\\)"
1377 (cdr (assoc level texinfo-update-menu-same-level-regexps
)))
1381 ;; Match comment, ifinfo, ifnottex line, if any
1386 "\\(^@ifinfo[ ]*\n\\)"
1388 "\\(^@ifnottex[ ]*\n\\)"
1391 (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1393 ;; Handle `Top' node specially.
1394 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1401 (if (re-search-backward
1406 ;; Match comment, ifinfo, ifnottex line, if any
1411 "\\(^@ifinfo[ ]*\n\\)"
1413 "\\(^@ifnottex[ ]*\n\\)"
1415 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1417 ;; Handle `Top' node specially.
1418 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1421 (goto-char beginning
)
1428 (error "texinfo-find-pointer: lack proper arguments")))))
1430 (defun texinfo-pointer-name (kind)
1431 "Return the node name preceding the section command.
1432 The argument is the kind of section, either `normal' or `no-pointer'."
1434 (cond ((eq kind
'normal
)
1435 (end-of-line) ; this handles prev node top case
1436 (re-search-backward ; when point is already
1437 "^@node" ; at the beginning of @node line
1438 (save-excursion (forward-line -
3))
1440 (setq name
(texinfo-copy-node-name)))
1441 ((eq kind
'no-pointer
)
1442 ;; Don't need to put a blank in the pointer slot,
1443 ;; since insert "' " always has a space
1444 (setq name
" "))) ; put a blank in the pointer slot
1447 (defun texinfo-insert-pointer (beginning end level direction
)
1448 "Insert the `Next', `Previous' or `Up' node name at point.
1451 The first and second arguments bound the search for a pointer to the
1452 beginning and end, respectively, of the enclosing higher level
1453 section. The third argument is the hierarchical level of the Texinfo
1454 file, a string such as \"section\". The fourth argument is direction
1455 towards which the pointer is directed, one of `next', `previous', or `up'."
1461 (texinfo-pointer-name
1462 (texinfo-find-pointer beginning end level direction
)))))
1464 (defun texinfo-clean-up-node-line ()
1465 "Remove extra commas, if any, at end of node line."
1467 (skip-chars-backward ", ")
1468 (delete-region (point) (save-excursion (end-of-line) (point))))
1471 ;;; Updating nodes sequentially
1472 ;; These sequential update functions insert `Next' or `Previous'
1473 ;; pointers that point to the following or preceding nodes even if they
1474 ;; are at higher or lower hierarchical levels. This means that if a
1475 ;; section contains one or more subsections, the section's `Next'
1476 ;; pointer will point to the subsection and not the following section.
1477 ;; (The subsection to which `Next' points will most likely be the first
1478 ;; item on the section's menu.)
1480 (defun texinfo-sequential-node-update (&optional region-p
)
1481 "Update one node (or many) in a Texinfo file with sequential pointers.
1483 This function causes the `Next' or `Previous' pointer to point to the
1484 immediately preceding or following node, even if it is at a higher or
1485 lower hierarchical level in the document. Continually pressing `n' or
1486 `p' takes you straight through the file.
1488 Without any prefix argument, update the node in which point is located.
1489 Non-nil argument (prefix, if interactive) means update the nodes in the
1492 This command makes it awkward to navigate among sections and
1493 subsections; it should be used only for those documents that are meant
1494 to be read like a novel rather than a reference, and for which the
1495 Info `g*' command is inadequate."
1499 ;; update a single node
1500 (let ((auto-fill-function nil
))
1501 (if (not (re-search-backward "^@node" (point-min) t
))
1502 (error "Node line not found before this position"))
1503 (texinfo-sequentially-update-the-node)
1505 "Done...sequentially updated the node . You may save the buffer."))
1507 (let ((auto-fill-function nil
)
1508 (beginning (region-beginning))
1510 (if (= end beginning
)
1511 (error "Please mark a region"))
1513 (narrow-to-region beginning end
)
1514 (goto-char beginning
)
1515 (push-mark (point) t
)
1516 (while (re-search-forward "^@node" (point-max) t
)
1518 (texinfo-sequentially-update-the-node))
1520 "Done...updated the nodes in sequence. You may save the buffer.")))))
1522 (defun texinfo-sequentially-update-the-node ()
1523 "Update one node such that the pointers are sequential.
1524 A `Next' or `Previous' pointer points to any preceding or following node,
1525 regardless of its hierarchical level."
1527 (texinfo-check-for-node-name)
1528 (texinfo-delete-existing-pointers)
1530 "Sequentially updating node: %s ... " (texinfo-copy-node-name))
1533 (let* ((case-fold-search t
)
1534 (level (texinfo-hierarchic-level)))
1536 (texinfo-top-pointer-case)
1538 (texinfo-sequentially-insert-pointer level
'next
)
1539 (texinfo-sequentially-insert-pointer level
'previous
)
1540 (texinfo-sequentially-insert-pointer level
'up
)
1541 (texinfo-clean-up-node-line)))))
1543 (defun texinfo-sequentially-find-pointer (level direction
)
1544 "Find next or previous pointer sequentially in Texinfo file, or up pointer.
1545 Move point to section associated with the pointer. Find point even if
1546 it is in a different section.
1548 Return type of pointer (either `normal' or `no-pointer').
1550 The first argument is a string specifying the general kind of section
1551 such as \"chapter\" or \"section\". The section found will be at the
1552 same hierarchical level in the Texinfo file, or, in the case of the up
1553 pointer, some level higher. The second argument (one of `next',
1554 `previous', or `up') specifies whether to find the `Next', `Previous',
1556 (let ((case-fold-search t
))
1557 (cond ((eq direction
'next
)
1558 (forward-line 3) ; skip over current node
1559 (if (re-search-forward
1560 texinfo-section-types-regexp
1565 ((eq direction
'previous
)
1566 (if (re-search-backward
1567 texinfo-section-types-regexp
1573 (if (re-search-backward
1574 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1575 ;; FIXME: passed many levels down via dynamic scoping!
1581 (error "texinfo-sequential-find-pointer: lack proper arguments")))))
1583 (defun texinfo-sequentially-insert-pointer (level direction
)
1584 "Insert the `Next', `Previous' or `Up' node name at point.
1587 The first argument is the hierarchical level of the Texinfo file, a
1588 string such as \"section\". The second argument is direction, one of
1589 `next', `previous', or `up'."
1595 (texinfo-pointer-name
1596 (texinfo-sequentially-find-pointer level direction
)))))
1599 ;;; Inserting `@node' lines
1600 ;; The `texinfo-insert-node-lines' function inserts `@node' lines as needed
1601 ;; before the `@chapter', `@section', and such like lines of a region
1602 ;; in a Texinfo file.
1604 (defun texinfo-insert-node-lines (beginning end
&optional title-p
)
1605 "Insert missing `@node' lines in region of Texinfo file.
1606 Non-nil argument (prefix, if interactive) means also to insert the
1607 section titles as node names; and also to insert the section titles as
1608 node names in pre-existing `@node' lines that lack names."
1609 (interactive "r\nP")
1611 ;; Use marker; after inserting node lines, leave point at end of
1612 ;; region and mark at beginning.
1614 (let (beginning-marker end-marker title last-section-position
)
1616 ;; Save current position on mark ring and set mark to end.
1618 (setq end-marker
(mark-marker))
1620 (goto-char beginning
)
1621 (while (re-search-forward
1622 texinfo-section-types-regexp
1625 ;; Copy title if desired.
1630 (skip-chars-forward " \t")
1631 (setq title
(buffer-substring
1633 (save-excursion (end-of-line) (point))))))
1634 ;; Insert node line if necessary.
1635 (if (re-search-backward
1637 ;; Avoid finding previous node line if node lines are close.
1638 (or last-section-position
1639 (save-excursion (forward-line -
2) (point))) t
)
1640 ;; @node is present, and point at beginning of that line
1641 (forward-word 1) ; Leave point just after @node.
1642 ;; Else @node missing; insert one.
1643 (beginning-of-line) ; Beginning of `@section' line.
1645 (backward-char 1)) ; Leave point just after `@node'.
1646 ;; Insert title if desired.
1649 (skip-chars-forward " \t")
1650 ;; Use regexp based on what info looks for
1651 ;; (alternatively, use "[a-zA-Z]+");
1652 ;; this means we only insert a title if none exists.
1653 (if (not (looking-at "[^,\t\n ]+"))
1658 (message "Inserted title %s ... " title
)))))
1659 ;; Go forward beyond current section title.
1660 (re-search-forward texinfo-section-types-regexp
1661 (save-excursion (forward-line 3) (point)) t
)
1662 (setq last-section-position
(point))
1665 ;; Leave point at end of region, mark at beginning.
1666 (set-mark beginning
)
1670 "Done inserting node lines and titles. You may save the buffer.")
1671 (message "Done inserting node lines. You may save the buffer."))))
1674 ;;; Update and create menus for multi-file Texinfo sources
1676 ;; 1. M-x texinfo-multiple-files-update
1678 ;; Read the include file list of an outer Texinfo file and
1679 ;; update all highest level nodes in the files listed and insert a
1680 ;; main menu in the outer file after its top node.
1682 ;; 2. C-u M-x texinfo-multiple-files-update
1684 ;; Same as 1, but insert a master menu. (Saves reupdating lower
1685 ;; level menus and nodes.) This command simply reads every menu,
1686 ;; so if the menus are wrong, the master menu will be wrong.
1687 ;; Similarly, if the lower level node pointers are wrong, they
1690 ;; 3. C-u 2 M-x texinfo-multiple-files-update
1692 ;; Read the include file list of an outer Texinfo file and
1693 ;; update all nodes and menus in the files listed and insert a
1694 ;; master menu in the outer file after its top node.
1696 ;;; Note: these functions:
1698 ;;; * Do not save or delete any buffers. You may fill up your memory.
1699 ;;; * Do not handle any pre-existing nodes in outer file.
1700 ;;; Hence, you may need a file for indices.
1703 ;;; Auxiliary functions for multiple file updating
1705 (defun texinfo-multi-file-included-list (outer-file)
1706 "Return a list of the included files in OUTER-FILE."
1707 (let ((included-file-list (list outer-file
))
1710 (set-buffer (find-file-noselect outer-file
))
1712 (goto-char (point-min))
1713 (while (re-search-forward "^@include" nil t
)
1714 (skip-chars-forward " \t")
1715 (setq start
(point))
1717 (skip-chars-backward " \t")
1718 (setq included-file-list
1719 (cons (buffer-substring start
(point))
1720 included-file-list
)))
1721 (nreverse included-file-list
))))
1723 (defun texinfo-copy-next-section-title ()
1724 "Return the name of the immediately following section as a string.
1726 Start with point at the beginning of the node line. Leave point at the
1727 same place. If there is no title, returns an empty string."
1733 (if (re-search-forward "\\(^@node\\)" nil t
)
1734 (match-beginning 0)))
1736 (if (re-search-forward texinfo-section-types-regexp node-end t
)
1742 (progn (forward-word 1) ; skip over section type
1743 (skip-chars-forward " \t") ; and over spaces
1745 (progn (end-of-line) (point)))))
1749 (defun texinfo-multi-file-update (files &optional update-everything
)
1750 "Update first node pointers in each file in FILES.
1751 Return a list of the node names.
1753 The first file in the list is an outer file; the remaining are
1754 files included in the outer file with `@include' commands.
1756 If optional arg UPDATE-EVERYTHING non-nil, update every menu and
1757 pointer in each of the included files.
1759 Also update the `Top' level node pointers of the outer file.
1763 * the first file in the FILES list must be the outer file,
1764 * each of the included files must contain exactly one highest
1765 hierarchical level node,
1766 * this node must be the first node in the included file,
1767 * each highest hierarchical level node must be of the same type.
1769 Thus, normally, each included file contains one, and only one, chapter."
1771 ;; The menu-list has the form:
1773 ;; \(\(\"node-name1\" . \"title1\"\)
1774 ;; \(\"node-name2\" . \"title2\"\) ... \)
1776 ;; However, there does not need to be a title field and this function
1777 ;; does not fill it; however a comment tells you how to do so.
1778 ;; You would use the title field if you wanted to insert titles in the
1779 ;; description slot of a menu as a description.
1781 (let ((case-fold-search t
)
1782 menu-list next-node-name previous-node-name
)
1784 ;; Find the name of the first node of the first included file.
1785 (set-buffer (find-file-noselect (car (cdr files
))))
1787 (goto-char (point-min))
1788 (if (not (re-search-forward "^@node" nil t
))
1789 (error "No `@node' line found in %s" (buffer-name)))
1791 (texinfo-check-for-node-name)
1792 (setq next-node-name
(texinfo-copy-node-name))
1794 (push (cons next-node-name
(prog1 "" (forward-line 1)))
1795 ;; Use following to insert section titles automatically.
1796 ;; (texinfo-copy-next-section-title)
1800 (set-buffer (find-file-noselect (pop files
)))
1801 (goto-char (point-min))
1802 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
))
1803 (error "This buffer needs a Top node"))
1805 (texinfo-delete-existing-pointers)
1807 (insert ", " next-node-name
", (dir), (dir)")
1809 (setq previous-node-name
"Top")
1813 (if (not (cdr files
))
1815 (setq next-node-name
"")
1817 ;; find the name of the first node in the next file.
1818 (set-buffer (find-file-noselect (car (cdr files
))))
1820 (goto-char (point-min))
1821 (if (not (re-search-forward "^@node" nil t
))
1822 (error "No `@node' line found in %s" (buffer-name)))
1824 (texinfo-check-for-node-name)
1825 (setq next-node-name
(texinfo-copy-node-name))
1826 (push (cons next-node-name
(prog1 "" (forward-line 1)))
1827 ;; Use following to insert section titles automatically.
1828 ;; (texinfo-copy-next-section-title)
1831 ;; Go to node to be updated.
1832 (set-buffer (find-file-noselect (car files
)))
1833 (goto-char (point-min))
1834 (if (not (re-search-forward "^@node" nil t
))
1835 (error "No `@node' line found in %s" (buffer-name)))
1838 ;; Update other menus and nodes if requested.
1839 (if update-everything
(texinfo-all-menus-update t
))
1842 (texinfo-delete-existing-pointers)
1844 (insert ", " next-node-name
", " previous-node-name
", Top")
1847 (setq previous-node-name
(texinfo-copy-node-name))
1849 (setq files
(cdr files
)))
1850 (nreverse menu-list
)))
1852 (defun texinfo-multi-files-insert-main-menu (menu-list)
1853 "Insert formatted main menu at point.
1854 Indents the first line of the description, if any, to the value of
1855 `texinfo-column-for-description'."
1858 (dolist (entry menu-list
)
1859 ;; Every menu entry starts with a star and a space.
1862 ;; Insert the node name (and menu entry name, if present).
1863 (let ((node-part (car entry
)))
1864 (if (stringp node-part
)
1865 ;; "Double colon" entry line; menu entry and node name are the same,
1866 (insert (format "%s::" node-part
))
1867 ;; "Single colon" entry line; menu entry and node name are different.
1868 (insert (format "%s: %s." (car node-part
) (cdr node-part
)))))
1870 ;; Insert the description, if present.
1872 ;; Move to right place.
1873 (indent-to texinfo-column-for-description
2)
1874 ;; Insert description.
1875 (insert (format "%s" (cdr entry
))))
1877 (insert "\n")) ; end this menu entry
1878 (insert "@end menu"))
1880 (defun texinfo-multi-file-master-menu-list (files-list)
1881 "Return master menu list from files in FILES-LIST.
1882 Menu entries in each file collected using `texinfo-master-menu-list'.
1884 The first file in FILES-LIST must be the outer file; the others must
1885 be the files included within it. A main menu must already exist."
1887 (let (master-menu-list)
1888 (dolist (file files-list
)
1889 (set-buffer (find-file-noselect file
))
1890 (message "Working on: %s " (current-buffer))
1891 (goto-char (point-min))
1892 (setq master-menu-list
1893 (append master-menu-list
(texinfo-master-menu-list))))
1897 ;;; The multiple-file update function
1899 (defun texinfo-multiple-files-update
1900 (outer-file &optional update-everything make-master-menu
)
1901 "Update first node pointers in each file included in OUTER-FILE;
1902 create or update the `Top' level node pointers and the main menu in
1903 the outer file that refers to such nodes. This does not create or
1904 update menus or pointers within the included files.
1906 With optional MAKE-MASTER-MENU argument (prefix arg, if interactive),
1907 insert a master menu in OUTER-FILE in addition to creating or updating
1908 pointers in the first @node line in each included file and creating or
1909 updating the `Top' level node pointers of the outer file. This does
1910 not create or update other menus and pointers within the included
1913 With optional UPDATE-EVERYTHING argument (numeric prefix arg, if
1914 interactive), update all the menus and all the `Next', `Previous', and
1915 `Up' pointers of all the files included in OUTER-FILE before inserting
1916 a master menu in OUTER-FILE. Also, update the `Top' level node
1917 pointers of OUTER-FILE.
1921 * this command does NOT save any files--you must save the
1922 outer file and any modified, included files.
1924 * except for the `Top' node, this command does NOT handle any
1925 pre-existing nodes in the outer file; hence, indices must be
1926 enclosed in an included file.
1930 * each of the included files must contain exactly one highest
1931 hierarchical level node,
1932 * this highest node must be the first node in the included file,
1933 * each highest hierarchical level node must be of the same type.
1935 Thus, normally, each included file contains one, and only one,
1940 "Name of outer `include' file: "
1943 ((not current-prefix-arg
) '(nil nil
))
1944 ((listp current-prefix-arg
) '(t nil
)) ; make-master-menu
1945 ((numberp current-prefix-arg
) '(t t
))))) ; update-everything
1947 (let* ((included-file-list (texinfo-multi-file-included-list outer-file
))
1948 (files included-file-list
)
1951 ;; Update the pointers and collect the names of the nodes and titles
1952 (main-menu-list (texinfo-multi-file-update files update-everything
)))
1957 (set-buffer (find-file-noselect (car included-file-list
)))
1958 (if (texinfo-old-menu-p
1961 (re-search-forward "^@include")
1965 ;; If found, leave point after word `menu' on the `@menu' line.
1967 (texinfo-incorporate-descriptions main-menu-list
)
1968 ;; Delete existing menu.
1972 (save-excursion (re-search-forward "^@end menu") (point)))
1974 (texinfo-multi-files-insert-main-menu main-menu-list
))
1976 ;; Else no current menu; insert it before `@include'
1977 (texinfo-multi-files-insert-main-menu main-menu-list
))
1979 ;; Insert master menu
1981 (if make-master-menu
1983 ;; First, removing detailed part of any pre-existing master menu
1984 (goto-char (point-min))
1985 (if (search-forward texinfo-master-menu-header nil t
)
1987 (goto-char (match-beginning 0))
1988 ;; Check if @detailmenu kludge is used;
1989 ;; if so, leave point before @detailmenu.
1990 (search-backward "\n@detailmenu"
1991 (save-excursion (forward-line -
3) (point))
1993 ;; Remove detailed master menu listing
1994 (let ((end-of-detailed-menu-descriptions
1995 (save-excursion ; beginning of end menu line
1996 (goto-char (texinfo-menu-end))
1997 (beginning-of-line) (forward-char -
1)
1999 (delete-region (point) end-of-detailed-menu-descriptions
))))
2001 ;; Create a master menu and insert it
2002 (texinfo-insert-master-menu-list
2003 (texinfo-multi-file-master-menu-list
2004 included-file-list
)))))
2006 ;; Remove unwanted extra lines.
2008 (goto-char (point-min))
2010 (re-search-forward "^@menu")
2012 (insert "\n") ; Ensure at least one blank line.
2013 (delete-blank-lines)
2015 (re-search-forward "^@end menu")
2017 (insert "\n") ; Ensure at least one blank line.
2018 (delete-blank-lines))
2020 (message "Multiple files updated."))
2023 ;; Place `provide' at end of file.
2024 (provide 'texnfo-upd
)
2026 ;;; texnfo-upd.el ends here