1 ;;; texnfo-upd.el --- utilities for updating nodes and menus in Texinfo files
3 ;; Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003 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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, 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.
266 Leaves trailing whitespace in a menu that lacks descriptions, so
267 descriptions will format well. In general, a menu should contain
268 descriptions, because node names and section titles are often too
269 short to explain a node well."
273 (list (point) (mark))))
275 (let ((level (texinfo-hierarchic-level)))
276 (texinfo-make-one-menu level
)
277 (message "Menu updated"))
279 (message "Making or updating menus in %s... " (buffer-name))
281 (goto-char (min beginning end
))
282 ;; find section type following point
283 (let ((level (texinfo-hierarchic-level))
284 (region-end-marker (make-marker)))
285 (set-marker region-end-marker
(max beginning end
))
289 (while (texinfo-find-lower-level-node
290 level
(marker-position region-end-marker
))
291 (setq level
(texinfo-hierarchic-level)) ; new, lower level
292 (texinfo-make-one-menu level
))
294 (while (and (< (point) (marker-position region-end-marker
))
295 (texinfo-find-higher-level-node
296 level
(marker-position region-end-marker
)))
297 (setq level
(texinfo-hierarchic-level))
298 ;; Don't allow texinfo-find-higher-level-node
299 ;; to find the same node again.
301 (while (texinfo-find-lower-level-node
302 level
(marker-position region-end-marker
))
303 (setq level
(texinfo-hierarchic-level)) ; new, lower level
304 (texinfo-make-one-menu level
))))))
305 (message "Making or updating menus in %s...done" (buffer-name))))
307 (defun texinfo-make-one-menu (level)
308 "Make a menu of all the appropriate nodes in this section.
309 `Appropriate nodes' are those associated with sections that are
310 at the level specified by LEVEL. Point is left at the end of menu."
312 ((case-fold-search t
)
315 (goto-char (texinfo-update-menu-region-beginning level
))
318 (end (texinfo-update-menu-region-end level
))
319 (first (texinfo-menu-first-node beginning end
))
321 (goto-char beginning
)
323 (texinfo-copy-node-name)))
324 (new-menu-list (texinfo-make-menu-list beginning end level
)))
325 (when (texinfo-old-menu-p beginning first
)
326 (texinfo-incorporate-descriptions new-menu-list
)
327 (texinfo-incorporate-menu-entry-names new-menu-list
)
328 (texinfo-delete-old-menu beginning first
))
329 (texinfo-insert-menu new-menu-list node-name
)))
331 (defun texinfo-all-menus-update (&optional update-all-nodes-p
)
332 "Update every regular menu in a Texinfo file.
333 Update pre-existing master menu, if there is one.
335 If called with a non-nil argument, this function first updates all the
336 nodes in the buffer before updating the menus.
338 Indents the first line of descriptions, and leaves trailing whitespace
339 in a menu that lacks descriptions, so descriptions will format well.
340 In general, a menu should contain descriptions, because node names and
341 section titles are often too short to explain a node well."
343 (let ((case-fold-search t
)
346 (push-mark (point-max) t
)
347 (goto-char (point-min))
348 (message "Checking for a master menu in %s ... "(buffer-name))
350 (when (search-forward texinfo-master-menu-header nil t
)
351 ;; Check if @detailmenu kludge is used;
352 ;; if so, leave point before @detailmenu.
353 (search-backward "\n@detailmenu"
354 (save-excursion (forward-line -
3) (point))
356 ;; Remove detailed master menu listing
357 (setq master-menu-p t
)
358 (goto-char (match-beginning 0))
359 (let ((end-of-detailed-menu-descriptions
360 (save-excursion ; beginning of end menu line
361 (goto-char (texinfo-menu-end))
362 (beginning-of-line) (forward-char -
1)
364 (delete-region (point) end-of-detailed-menu-descriptions
))))
366 (when update-all-nodes-p
367 (message "Updating all nodes in %s ... " (buffer-name))
368 (texinfo-update-node (point-min) (point-max)))
370 (message "Updating all menus in %s ... " (buffer-name))
371 (texinfo-make-menu (point-max) (point-min))
374 (message "Updating the master menu in %s... " (buffer-name))
375 (texinfo-master-menu nil
)))
377 (message "Done...updated all the menus. You may save the buffer.")))
379 (defun texinfo-find-lower-level-node (level region-end
)
380 "Search forward from point for node at any level lower than LEVEL.
381 Search is limited to the end of the marked region, REGION-END,
382 and to the end of the menu region for the level.
384 Return t if the node is found, else nil. Leave point at the beginning
385 of the node if one is found; else do not move point."
386 (let ((case-fold-search t
))
387 (if (and (< (point) region-end
)
390 "\\(^@node\\).*\n" ; match node line
391 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
393 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
395 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
396 "\\)?" ; end of expression
397 (eval (cdr (assoc level texinfo-update-menu-lower-regexps
))))
398 ;; the next higher level node marks the end of this
399 ;; section, and no lower level node will be found beyond
400 ;; this position even if region-end is farther off
401 (texinfo-update-menu-region-end level
)
403 (goto-char (match-beginning 1)))))
405 (defun texinfo-find-higher-level-node (level region-end
)
406 "Search forward from point for node at any higher level than argument LEVEL.
407 Search is limited to the end of the marked region, REGION-END.
409 Return t if the node is found, else nil. Leave point at the beginning
410 of the node if one is found; else do not move point.
412 A `@node' line starting at point does count as a match;
413 if the match is found there, the value is t and point does not move."
415 (let ((case-fold-search t
))
418 (if (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t
)
419 (progn (beginning-of-line) t
)))
421 (when (re-search-forward
423 "\\(^@node\\).*\n" ; match node line
424 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
426 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
428 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
429 "\\)?" ; end of expression
430 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
))))
432 (beginning-of-line) t
)))))
435 ;;; Making the list of new menu entries
437 (defun texinfo-make-menu-list (beginning end level
)
438 "Make a list of node names and their descriptions.
439 Point is left at the end of the menu region, but the menu is not inserted.
441 First argument is position from which to start making menu list;
442 second argument is end of region in which to try to locate entries;
443 third argument is the level of the nodes that are the entries.
445 Node names and descriptions are dotted pairs of strings. Each pair is
446 an element of the list. If the description does not exist, the
447 element consists only of the node name."
448 (goto-char beginning
)
450 (while (texinfo-menu-locate-entry-p level end
)
452 (texinfo-copy-node-name)
453 (prog1 "" (forward-line 1)))
454 ;; Use following to insert section titles automatically.
455 ;; (texinfo-copy-section-title))
457 (nreverse new-menu-list
)))
459 (defun texinfo-menu-locate-entry-p (level search-end
)
460 "Find a node that will be part of menu for this section.
461 First argument is a string such as \"section\" specifying the general
462 hierarchical level of the menu; second argument is a position
463 specifying the end of the search.
465 The function returns t if the node is found, else nil. It searches
466 forward from point, and leaves point at the beginning of the node.
468 The function finds entries of the same type. Thus `subsections' and
469 `unnumberedsubsecs' will appear in the same menu."
470 (let ((case-fold-search t
))
471 (if (re-search-forward
473 "\\(^@node\\).*\n" ; match node line
474 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
476 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
478 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
479 "\\)?" ; end of expression
481 (cdr (assoc level texinfo-update-menu-same-level-regexps
))))
484 (goto-char (match-beginning 1)))))
486 (defun texinfo-copy-node-name ()
487 "Return the node name as a string.
489 Start with point at the beginning of the node line; copy the text
490 after the node command up to the first comma on the line, if any, and
491 return the text as a string. Leaves point at the beginning of the
492 line. If there is no node name, returns an empty string."
496 (progn (forward-word 1) ; skip over node command
497 (skip-chars-forward " \t") ; and over spaces
499 (if (search-forward "," (line-end-position) t
) ; bound search
501 (end-of-line) (point)))))
503 (defun texinfo-copy-section-title ()
504 "Return the title of the section as a string.
505 The title is used as a description line in the menu when one does not
508 Move point to the beginning of the appropriate section line by going
509 to the start of the text matched by last regexp searched for, which
510 must have been done by `texinfo-menu-locate-entry-p'."
512 ;; could use the same re-search as in `texinfo-menu-locate-entry-p'
513 ;; instead of using `match-beginning'; such a variation would be
514 ;; more general, but would waste information already collected
516 (goto-char (match-beginning 7)) ; match section name
519 (progn (forward-word 1) ; skip over section type
520 (skip-chars-forward " \t") ; and over spaces
522 (progn (end-of-line) (point))))
525 ;;; Handling the old menu
527 (defun texinfo-old-menu-p (beginning first
)
528 "Move point to the beginning of the menu for this section, if any.
529 Otherwise move point to the end of the first node of this section.
530 Return t if a menu is found, nil otherwise.
532 First argument is the position of the beginning of the section in which
533 the menu will be located; second argument is the position of the first
534 node within the section.
536 If no menu is found, the function inserts two newlines just before the
537 end of the section, and leaves point there where a menu ought to be."
538 (goto-char beginning
)
539 (if (re-search-forward "^@menu" first
'goto-end
)
541 (insert "\n\n") (forward-line -
2) nil
))
543 (defun texinfo-incorporate-descriptions (new-menu-list)
544 "Copy the old menu line descriptions that exist to the new menu.
546 Point must be at beginning of old menu.
548 If the node-name of the new menu is found in the old menu, insert the
549 old description into the new entry.
551 For this function, the new menu is a list made up of lists of dotted
552 pairs in which the first element of the pair is the node name and the
553 second element the description. The new menu is changed destructively.
554 The old menu is the menu as it appears in the Texinfo file."
556 (let ((end-of-menu (texinfo-menu-end)))
557 (dolist (new-menu new-menu-list new-menu-list
)
558 (save-excursion ; keep point at beginning of menu
559 (when (re-search-forward
560 ;; Existing nodes can have the form
561 ;; * NODE NAME:: DESCRIPTION
563 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
565 ;; Recognize both when looking for the description.
566 (concat "\\* \\(" ; so only menu entries are found
567 (regexp-quote (car new-menu
)) "::"
569 ".*: " (regexp-quote (car new-menu
)) "[.,\t\n]"
571 ) ; so only complete entries are found
574 (setcdr new-menu
(texinfo-menu-copy-old-description end-of-menu
)))))))
576 (defun texinfo-incorporate-menu-entry-names (new-menu-list)
577 "Copy any old menu entry names to the new menu.
579 Point must be at beginning of old menu.
581 If the node-name of the new menu entry cannot be found in the old
584 For this function, the new menu is a list made up of lists of dotted
585 pairs in which the first element of the pair is the node name and the
586 second element is the description (or nil).
588 If we find an existing menu entry name, we change the first element of
589 the pair to be another dotted pair in which the car is the menu entry
590 name and the cdr is the node name.
592 NEW-MENU-LIST is changed destructively. The old menu is the menu as it
593 appears in the texinfo file."
595 (let ((end-of-menu (texinfo-menu-end)))
596 (dolist (new-menu new-menu-list new-menu-list
)
597 (save-excursion ; keep point at beginning of menu
598 (if (re-search-forward
599 ;; Existing nodes can have the form
600 ;; * NODE NAME:: DESCRIPTION
602 ;; * MENU ITEM: NODE NAME. DESCRIPTION.
604 ;; We're interested in the second case.
605 (concat "\\* " ; so only menu entries are found
606 "\\(.*\\): " (regexp-quote (car new-menu
))
611 new-menu
; replace the node name
612 (cons (buffer-substring (match-beginning 1) (match-end 1))
613 (car new-menu
))))))))
615 (defun texinfo-menu-copy-old-description (end-of-menu)
616 "Return description field of old menu line as string.
617 Point must be located just after the node name. Point left before description.
618 Single argument, END-OF-MENU, is position limiting search."
619 (skip-chars-forward "[:.,\t\n ]+")
620 ;; don't copy a carriage return at line beginning with asterisk!
621 ;; don't copy @detailmenu or @end menu as descriptions!
622 ;; do copy a description that begins with an `@'!
623 ;; !! Known bug: does not copy descriptions starting with ^|\{?* etc.
624 (if (and (looking-at "\\(\\w+\\|@\\)")
625 (not (looking-at "\\(^\\* \\|^@detailmenu\\|^@end menu\\)")))
629 (re-search-forward "\\(^\\* \\|^@end menu\\)" end-of-menu t
)
631 (end-of-line) ; go to end of last description line
635 (defun texinfo-menu-end ()
636 "Return position of end of menu, but don't move point.
637 Signal an error if not end of menu."
639 (if (re-search-forward "^@end menu" nil t
)
641 (error "Menu does not have an end"))))
643 (defun texinfo-delete-old-menu (beginning first
)
644 "Delete the old menu. Point must be in or after menu.
645 First argument is position of the beginning of the section in which
646 the menu will be located; second argument is the position of the first
647 node within the section."
648 ;; No third arg to search, so error if search fails.
649 (re-search-backward "^@menu" beginning
)
650 (delete-region (point)
652 (re-search-forward "^@end menu" first
)
656 ;;; Inserting new menu
658 ;; try 32, but perhaps 24 is better
659 (defvar texinfo-column-for-description
32
660 "*Column at which descriptions start in a Texinfo menu.")
662 (defun texinfo-insert-menu (menu-list node-name
)
663 "Insert formatted menu at point.
664 Indents the first line of descriptions, if any, to the value of
665 texinfo-column-for-description. Indenting leaves trailing whitespace
666 in a menu that lacks descriptions, so descriptions will format well.
667 In general, a menu should contain descriptions, because node names and
668 section titles are often too short to explain a node well.
672 \(\(\"node-name1\" . \"description\"\)
673 \(\"node-name2\" . \"description\"\) ... \)
675 However, the description field might be nil.
677 Also, the node-name field might itself be a dotted pair (call it P) of
678 strings instead of just a string. In that case, the car of P
679 is the menu entry name, and the cdr of P is the node name."
682 (dolist (menu menu-list
)
683 ;; Every menu entry starts with a star and a space.
686 ;; Insert the node name (and menu entry name, if present).
687 (let ((node-part (car menu
)))
688 (if (stringp node-part
)
689 ;; "Double colon" entry line; menu entry and node name are the same,
690 (insert (format "%s::" node-part
))
691 ;; "Single colon" entry line; menu entry and node name are different.
692 (insert (format "%s: %s." (car node-part
) (cdr node-part
)))))
694 ;; Insert the description, if present.
696 ;; Move to right place.
697 (indent-to texinfo-column-for-description
2)
698 ;; Insert description.
699 (insert (format "%s" (cdr menu
))))
701 (insert "\n")) ; end this menu entry
703 (let ((level (texinfo-hierarchic-level)))
705 "Updated level \"%s\" menu following node: %s ... " level node-name
)))
708 ;;; Starting menu descriptions by inserting titles
710 (defun texinfo-start-menu-description ()
711 "In this menu entry, insert the node's section title as a description.
712 Position point at beginning of description ready for editing.
713 Do not insert a title if the line contains an existing description.
715 You will need to edit the inserted text since a useful description
716 complements the node name rather than repeats it as a title does."
719 (let (beginning end node-name title
)
722 (if (search-forward "* " (save-excursion (end-of-line) (point)) t
)
723 (progn (skip-chars-forward " \t")
724 (setq beginning
(point)))
725 (error "This is not a line in a menu"))
728 ;; "Double colon" entry line; menu entry and node name are the same,
729 ((search-forward "::" (save-excursion (end-of-line) (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))))
735 ;; "Single colon" entry line; menu entry and node name are different.
736 ((search-forward ":" (save-excursion (end-of-line) (point)) t
)
737 (skip-chars-forward " \t")
738 (setq beginning
(point))
739 ;; Menu entry line ends in a period, comma, or tab.
740 (if (re-search-forward "[.,\t]"
741 (save-excursion (forward-line 1) (point)) t
)
743 (if (looking-at "[ \t]*[^ \t\n]+")
744 (error "Descriptive text already exists"))
745 (skip-chars-backward "., \t")
746 (setq node-name
(buffer-substring beginning
(point))))
747 ;; Menu entry line ends in a return.
748 (re-search-forward ".*\n"
749 (save-excursion (forward-line 1) (point)) t
)
750 (skip-chars-backward " \t\n")
751 (setq node-name
(buffer-substring beginning
(point)))
752 (if (= 0 (length node-name
))
753 (error "No node name on this line")
755 (t (error "No node name on this line")))
756 ;; Search for node that matches node name, and copy the section title.
757 (if (re-search-forward
760 (regexp-quote node-name
)
761 ".*\n" ; match node line
763 "\\(\\(^@c \\|^@comment\\).*\n\\)" ; match comment line, if any
765 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
767 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
768 "\\)?" ; end of expression
773 ;; skip over section type
774 (progn (forward-word 1)
776 (skip-chars-forward " \t")
779 (skip-chars-backward " \t")
781 (error "Cannot find node to match node name in menu entry")))
782 ;; Return point to the menu and insert the title.
786 (save-excursion (skip-chars-backward " \t") (point)))
787 (indent-to texinfo-column-for-description
2)
788 (save-excursion (insert title
))))
791 ;;; Handling description indentation
793 ;; Since the make-menu functions indent descriptions, these functions
794 ;; are useful primarily for indenting a single menu specially.
796 (defun texinfo-indent-menu-description (column &optional region-p
)
797 "Indent every description in menu following point to COLUMN.
798 Non-nil argument (prefix, if interactive) means indent every
799 description in every menu in the region. Does not indent second and
800 subsequent lines of a multi-line description."
803 "nIndent menu descriptions to (column number): \nP")
809 (re-search-forward "^@menu")
810 (texinfo-menu-indent-description column
)
812 "Indented descriptions in menu. You may save the buffer."))
814 (message "Indenting every menu description in region... ")
815 (goto-char (region-beginning))
816 (while (and (< (point) (region-end))
817 (texinfo-locate-menu-p))
819 (texinfo-menu-indent-description column
))
820 (message "Indenting done. You may save the buffer.")))))
822 (defun texinfo-menu-indent-description (to-column-number)
823 "Indent the Texinfo file menu description to TO-COLUMN-NUMBER.
824 Start with point just after the word `menu' in the `@menu' line and
825 leave point on the line before the `@end menu' line. Does not indent
826 second and subsequent lines of a multi-line description."
827 (let* ((beginning-of-next-line (point)))
828 (while (< beginning-of-next-line
829 (save-excursion ; beginning of end menu line
830 (goto-char (texinfo-menu-end))
834 (when (re-search-forward "\\* \\(.*::\\|.*: [^.,\t\n]+[.,\t]\\)"
837 (let ((beginning-white-space (point)))
838 (skip-chars-forward " \t") ; skip over spaces
839 (if (looking-at "\\(@\\|\\w\\)+") ; if there is text
841 ;; remove pre-existing indentation
842 (delete-region beginning-white-space
(point))
843 (indent-to-column to-column-number
)))))
844 ;; position point at beginning of next line
846 (setq beginning-of-next-line
(point)))))
849 ;;; Making the master menu
851 (defun texinfo-master-menu (update-all-nodes-menus-p)
852 "Make a master menu for a whole Texinfo file.
853 Non-nil argument (prefix, if interactive) means first update all
854 existing nodes and menus. Remove pre-existing master menu, if there is one.
856 This function creates a master menu that follows the top node. The
857 master menu includes every entry from all the other menus. It
858 replaces any existing ordinary menu that follows the top node.
860 If called with a non-nil argument, this function first updates all the
861 menus in the buffer (incorporating descriptions from pre-existing
862 menus) before it constructs the master menu.
864 The function removes the detailed part of an already existing master
865 menu. This action depends on the pre-existing master menu using the
866 standard `texinfo-master-menu-header'.
868 The master menu has the following format, which is adapted from the
869 recommendation in the Texinfo Manual:
871 * The first part contains the major nodes in the Texinfo file: the
872 nodes for the chapters, chapter-like sections, and the major
873 appendices. This includes the indices, so long as they are in
874 chapter-like sections, such as unnumbered sections.
876 * The second and subsequent parts contain a listing of the other,
877 lower level menus, in order. This way, an inquirer can go
878 directly to a particular node if he or she is searching for
879 specific information.
881 Each of the menus in the detailed node listing is introduced by the
882 title of the section containing the menu.
884 Indents the first line of descriptions, and leaves trailing whitespace
885 in a menu that lacks descriptions, so descriptions will format well.
886 In general, a menu should contain descriptions, because node names and
887 section titles are often too short to explain a node well."
890 (let ((case-fold-search t
))
892 (goto-char (point-min))
894 ;; Move point to location after `top'.
895 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
))
896 (error "This buffer needs a Top node"))
900 (or (re-search-forward "^@node" nil t
)
901 (error "Too few nodes for a master menu"))
903 (if (search-forward texinfo-master-menu-header first-chapter t
)
905 ;; Check if @detailmenu kludge is used;
906 ;; if so, leave point before @detailmenu.
907 (search-backward "\n@detailmenu"
908 (save-excursion (forward-line -
3) (point))
910 ;; Remove detailed master menu listing
911 (goto-char (match-beginning 0))
912 (let ((end-of-detailed-menu-descriptions
913 (save-excursion ; beginning of end menu line
914 (goto-char (texinfo-menu-end))
915 (beginning-of-line) (forward-char -
1)
917 (delete-region (point) end-of-detailed-menu-descriptions
)))))
919 (if update-all-nodes-menus-p
921 (message "Making a master menu in %s ...first updating all nodes... "
923 (texinfo-update-node (point-min) (point-max))
925 (message "Updating all menus in %s ... " (buffer-name))
926 (texinfo-make-menu (point-min) (point-max))))
928 (message "Now making the master menu in %s... " (buffer-name))
929 (goto-char (point-min))
930 (texinfo-insert-master-menu-list
931 (texinfo-master-menu-list))
933 ;; Remove extra newlines that texinfo-insert-master-menu-list
934 ;; may have inserted.
937 (goto-char (point-min))
939 (if (search-forward texinfo-master-menu-header nil t
)
941 (goto-char (match-beginning 0))
942 ;; Check if @detailmenu kludge is used;
943 ;; if so, leave point before @detailmenu.
944 (search-backward "\n@detailmenu"
945 (save-excursion (forward-line -
3) (point))
949 (goto-char (point-min))))
951 (re-search-forward "^@menu")
955 (re-search-forward "^@end menu")
957 (delete-blank-lines))
960 "Done...completed making master menu. You may save the buffer.")))
962 (defun texinfo-master-menu-list ()
963 "Return a list of menu entries and header lines for the master menu.
965 Start with the menu for chapters and indices and then find each
966 following menu and the title of the node preceding that menu.
968 The master menu list has this form:
970 \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\)
971 \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\)
974 However, there does not need to be a title field."
976 (let (master-menu-list)
977 (while (texinfo-locate-menu-p)
978 (push (list (texinfo-copy-menu) (texinfo-copy-menu-title))
980 (nreverse master-menu-list
)))
982 (defun texinfo-insert-master-menu-list (master-menu-list)
983 "Format and insert the master menu in the current buffer."
984 (goto-char (point-min))
985 ;; Insert a master menu only after `Top' node and before next node
986 ;; \(or include file if there is no next node\).
987 (unless (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
)
988 (error "This buffer needs a Top node"))
990 (save-excursion (re-search-forward "^@node\\|^@include") (point))))
991 (unless (re-search-forward "^@menu" first-chapter t
)
992 (error "Buffer lacks ordinary `Top' menu in which to insert master")))
994 (delete-region ; buffer must have ordinary top menu
996 (save-excursion (re-search-forward "^@end menu") (point)))
999 ;; `master-menu-inserted-p' is a kludge to tell
1000 ;; whether to insert @end detailmenu (see bleow)
1001 (let (master-menu-inserted-p)
1002 ;; Handle top of menu
1003 (insert "\n@menu\n")
1004 ;; Insert chapter menu entries. Tell user what is going on.
1005 (message "Inserting chapter menu entry: %s ... "
1006 (car (car master-menu-list
)))
1007 (dolist (entry (reverse (car (car master-menu-list
))))
1008 (insert "* " entry
"\n"))
1010 (setq master-menu-list
(cdr master-menu-list
))
1012 ;; Only insert detailed master menu if there is one....
1013 (if (car (car master-menu-list
))
1014 (progn (setq master-menu-inserted-p t
)
1015 (insert (concat "\n@detailmenu\n"
1016 texinfo-master-menu-header
))))
1018 ;; @detailmenu added 5 Sept 1996 to `texinfo-master-menu-header'
1019 ;; at Karl Berry's request to avert a bug in `makeinfo';
1020 ;; all agree this is a bad kludge and should eventually be removed.
1021 ;; @detailmenu ... @end detailmenu is a noop in `texinfmt.el'.
1022 ;; See @end detailmenu below;
1023 ;; also see `texinfo-all-menus-update' above, `texinfo-master-menu',
1024 ;; `texinfo-multiple-files-update'.
1026 ;; Now, insert all the other menus
1028 ;; The menu master-menu-list has a form like this:
1029 ;; ((("beta" "alpha") "title-A")
1030 ;; (("delta" "gamma") "title-B"))
1032 (dolist (menu master-menu-list
)
1034 (message "Inserting menu for %s .... " (cadr menu
))
1035 ;; insert title of menu section
1036 (insert "\n" (cadr menu
) "\n\n")
1038 ;; insert each menu entry
1039 (dolist (entry (reverse (car menu
)))
1040 (insert "* " entry
"\n")))
1044 ;; @detailmenu (see note above)
1045 ;; Only insert @end detailmenu if a master menu was inserted.
1046 (if master-menu-inserted-p
1047 (insert "\n@end detailmenu"))
1048 (insert "\n@end menu\n\n"))))
1050 (defun texinfo-locate-menu-p ()
1051 "Find the next menu in the texinfo file.
1052 If found, leave point after word `menu' on the `@menu' line, and return t.
1053 If a menu is not found, do not move point and return nil."
1054 (re-search-forward "\\(^@menu\\)" nil t
))
1056 (defun texinfo-copy-menu-title ()
1057 "Return the title of the section preceding the menu as a string.
1058 If such a title cannot be found, return an empty string. Do not move
1060 (let ((case-fold-search t
))
1062 (if (re-search-backward
1066 texinfo-section-types-regexp
; all other section types
1072 (forward-word 1) ; skip over section type
1073 (skip-chars-forward " \t") ; and over spaces
1076 (progn (end-of-line) (point))))
1079 (defun texinfo-copy-menu ()
1080 "Return the entries of an existing menu as a list.
1081 Start with point just after the word `menu' in the `@menu' line
1082 and leave point on the line before the `@end menu' line."
1083 (let* (this-menu-list
1084 (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu'
1085 (last-entry (save-excursion ; position of beginning of
1087 (goto-char end-of-menu
)
1088 ;; handle multi-line description
1089 (if (not (re-search-backward "^\\* " nil t
))
1090 (error "No entries in menu"))
1092 (while (< (point) last-entry
)
1093 (if (re-search-forward "^\\* " end-of-menu t
)
1094 (push (buffer-substring
1096 ;; copy multi-line descriptions
1098 (re-search-forward "\\(^\\* \\|^@e\\)" nil t
)
1104 ;;; Determining the hierarchical level in the texinfo file
1106 (defun texinfo-specific-section-type ()
1107 "Return the specific type of next section, as a string.
1108 For example, \"unnumberedsubsec\". Return \"top\" for top node.
1110 Searches forward for a section. Hence, point must be before the
1111 section whose type will be found. Does not move point. Signal an
1112 error if the node is not the top node and a section is not found."
1113 (let ((case-fold-search t
))
1116 ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1117 ;; Following search limit by cph but causes a bug
1118 ;;(line-end-position)
1122 ((re-search-forward texinfo-section-types-regexp nil t
)
1123 (buffer-substring-no-properties
1124 (progn (beginning-of-line) ; copy its name
1126 (progn (forward-word 1)
1130 "texinfo-specific-section-type: Chapter or section not found"))))))
1132 (defun texinfo-hierarchic-level ()
1133 "Return the general hierarchal level of the next node in a texinfo file.
1134 Thus, a subheading or appendixsubsec is of type subsection."
1135 (let ((case-fold-search t
))
1137 (texinfo-specific-section-type)
1138 texinfo-section-list
))))
1141 ;;; Locating the major positions
1143 (defun texinfo-update-menu-region-beginning (level)
1144 "Locate beginning of higher level section this section is within.
1145 Return position of the beginning of the node line; do not move point.
1146 Thus, if this level is subsection, searches backwards for section node.
1147 Only argument is a string of the general type of section."
1148 (let ((case-fold-search t
))
1149 ;; !! Known bug: if section immediately follows top node, this
1150 ;; returns the beginning of the buffer as the beginning of the
1151 ;; higher level section.
1155 (goto-char (point-min))
1156 (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
)
1163 "\\(^@node\\).*\n" ; match node line
1164 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1166 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
1168 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
1169 "\\)?" ; end of expression
1171 (cdr (assoc level texinfo-update-menu-higher-regexps
))))
1176 (defun texinfo-update-menu-region-end (level)
1177 "Locate end of higher level section this section is within.
1178 Return position; do not move point. Thus, if this level is a
1179 subsection, find the node for the section this subsection is within.
1180 If level is top or chapter, returns end of file. Only argument is a
1181 string of the general type of section."
1182 (let ((case-fold-search t
))
1184 (if (re-search-forward
1186 "\\(^@node\\).*\n" ; match node line
1187 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any
1189 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any
1191 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any
1192 "\\)?" ; end of expression
1194 ;; Never finds end of level above chapter so goes to end.
1195 (cdr (assoc level texinfo-update-menu-higher-regexps
))))
1201 (defun texinfo-menu-first-node (beginning end
)
1202 "Locate first node of the section the menu will be placed in.
1203 Return position; do not move point.
1204 The menu will be located just before this position.
1206 First argument is the position of the beginning of the section in
1207 which the menu will be located; second argument is the position of the
1208 end of that region; it limits the search."
1211 (goto-char beginning
)
1213 (re-search-forward "^@node" end t
)
1220 (defun texinfo-update-node (&optional beginning end
)
1221 "Without any prefix argument, update the node in which point is located.
1222 Interactively, a prefix argument means to operate on the region.
1224 The functions for creating or updating nodes and menus, and their
1227 texinfo-update-node (&optional beginning end) \\[texinfo-update-node]
1228 texinfo-every-node-update () \\[texinfo-every-node-update]
1229 texinfo-sequential-node-update (&optional region-p)
1231 texinfo-make-menu (&optional region-p) \\[texinfo-make-menu]
1232 texinfo-all-menus-update () \\[texinfo-all-menus-update]
1233 texinfo-master-menu ()
1235 texinfo-indent-menu-description (column &optional region-p)
1237 The `texinfo-column-for-description' variable specifies the column to
1238 which menu descriptions are indented. Its default value is 32."
1242 (list (point) (mark))))
1243 (if (null beginning
)
1244 ;; Update a single node.
1245 (let ((auto-fill-function nil
))
1246 (if (not (re-search-backward "^@node" (point-min) t
))
1247 (error "Node line not found before this position"))
1248 (texinfo-update-the-node)
1249 (message "Done...updated the node. You may save the buffer."))
1251 (let ((auto-fill-function nil
))
1254 (narrow-to-region beginning end
)
1255 (goto-char (point-min))
1256 (while (re-search-forward "^@node" (point-max) t
)
1258 (texinfo-update-the-node))
1259 (goto-char (point-max))
1260 (message "Done...nodes updated in region. You may save the buffer."))))))
1262 (defun texinfo-every-node-update ()
1263 "Update every node in a Texinfo file."
1266 (texinfo-update-node (point-min) (point-max))
1267 (message "Done...updated every node. You may save the buffer.")))
1269 (defun texinfo-update-the-node ()
1270 "Update one node. Point must be at the beginning of node line.
1271 Leave point at the end of the node line."
1272 (texinfo-check-for-node-name)
1273 (texinfo-delete-existing-pointers)
1274 (message "Updating node: %s ... " (texinfo-copy-node-name))
1278 ((case-fold-search t
)
1279 (level (texinfo-hierarchic-level))
1280 (beginning (texinfo-update-menu-region-beginning level
))
1281 (end (texinfo-update-menu-region-end level
)))
1283 (texinfo-top-pointer-case)
1285 (texinfo-insert-pointer beginning end level
'next
)
1286 (texinfo-insert-pointer beginning end level
'previous
)
1287 (texinfo-insert-pointer beginning end level
'up
)
1288 (texinfo-clean-up-node-line)))))
1290 (defun texinfo-top-pointer-case ()
1291 "Insert pointers in the Top node. This is a special case.
1293 The `Next' pointer is a pointer to a chapter or section at a lower
1294 hierarchical level in the file. The `Previous' and `Up' pointers are
1295 to `(dir)'. Point must be at the beginning of the node line, and is
1296 left at the end of the node line."
1298 (texinfo-clean-up-node-line)
1301 ;; There may be an @chapter or other such command between
1302 ;; the top node line and the next node line, as a title
1303 ;; for an `ifinfo' section. This @chapter command must
1304 ;; must be skipped. So the procedure is to search for
1305 ;; the next `@node' line, and then copy its name.
1306 (if (re-search-forward "^@node" nil t
)
1309 (texinfo-copy-node-name))
1313 (defun texinfo-check-for-node-name ()
1314 "Determine whether the node has a node name. Prompt for one if not.
1315 Point must be at beginning of node line. Does not move point."
1317 (let ((initial (texinfo-copy-next-section-title)))
1318 ;; This is not clean. Use `interactive' to read the arg.
1319 (forward-word 1) ; skip over node command
1320 (skip-chars-forward " \t") ; and over spaces
1321 (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what Info looks for
1322 ; alternatively, use "[a-zA-Z]+"
1324 (read-from-minibuffer
1325 "Node name (use no @, commas, colons, or apostrophes): "
1327 (insert " " node-name
))))))
1329 (defun texinfo-delete-existing-pointers ()
1330 "Delete `Next', `Previous', and `Up' pointers.
1331 Starts from the current position of the cursor, and searches forward
1332 on the line for a comma and if one is found, deletes the rest of the
1333 line, including the comma. Leaves point at beginning of line."
1334 (let ((eol-point (save-excursion (end-of-line) (point))))
1335 (if (search-forward "," eol-point t
)
1336 (delete-region (1- (point)) eol-point
)))
1337 (beginning-of-line))
1339 (defun texinfo-find-pointer (beginning end level direction
)
1340 "Move point to section associated with next, previous, or up pointer.
1341 Return type of pointer (either `normal' or `no-pointer').
1343 The first and second arguments bound the search for a pointer to the
1344 beginning and end, respectively, of the enclosing higher level
1345 section. The third argument is a string specifying the general kind
1346 of section such as \"chapter\" or \"section\". When looking for the
1347 `Next' pointer, the section found will be at the same hierarchical
1348 level in the Texinfo file; when looking for the `Previous' pointer,
1349 the section found will be at the same or higher hierarchical level in
1350 the Texinfo file; when looking for the `Up' pointer, the section found
1351 will be at some level higher in the Texinfo file. The fourth argument
1352 \(one of 'next, 'previous, or 'up\) specifies whether to find the
1353 `Next', `Previous', or `Up' pointer."
1354 (let ((case-fold-search t
))
1355 (cond ((eq direction
'next
)
1356 (forward-line 3) ; skip over current node
1357 ;; Search for section commands accompanied by node lines;
1358 ;; ignore section commands in the middle of nodes.
1359 (if (re-search-forward
1360 ;; A `Top' node is never a next pointer, so won't find it.
1364 ;; Match comment, ifinfo, ifnottex line, if any
1369 "\\(^@ifinfo[ ]*\n\\)"
1371 "\\(^@ifnottex[ ]*\n\\)"
1374 (cdr (assoc level texinfo-update-menu-same-level-regexps
))))
1379 ((eq direction
'previous
)
1380 (if (re-search-backward
1385 ;; Match comment, ifinfo, ifnottex line, if any
1390 "\\(^@ifinfo[ ]*\n\\)"
1392 "\\(^@ifnottex[ ]*\n\\)"
1395 (cdr (assoc level texinfo-update-menu-same-level-regexps
)))
1399 ;; Match comment, ifinfo, ifnottex line, if any
1404 "\\(^@ifinfo[ ]*\n\\)"
1406 "\\(^@ifnottex[ ]*\n\\)"
1409 (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1411 ;; Handle `Top' node specially.
1412 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1419 (if (re-search-backward
1424 ;; Match comment, ifinfo, ifnottex line, if any
1429 "\\(^@ifinfo[ ]*\n\\)"
1431 "\\(^@ifnottex[ ]*\n\\)"
1433 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1435 ;; Handle `Top' node specially.
1436 "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
1439 (goto-char beginning
)
1446 (error "texinfo-find-pointer: lack proper arguments")))))
1448 (defun texinfo-pointer-name (kind)
1449 "Return the node name preceding the section command.
1450 The argument is the kind of section, either `normal' or `no-pointer'."
1452 (cond ((eq kind
'normal
)
1453 (end-of-line) ; this handles prev node top case
1454 (re-search-backward ; when point is already
1455 "^@node" ; at the beginning of @node line
1456 (save-excursion (forward-line -
3))
1458 (setq name
(texinfo-copy-node-name)))
1459 ((eq kind
'no-pointer
)
1460 ;; Don't need to put a blank in the pointer slot,
1461 ;; since insert "' " always has a space
1462 (setq name
" "))) ; put a blank in the pointer slot
1465 (defun texinfo-insert-pointer (beginning end level direction
)
1466 "Insert the `Next', `Previous' or `Up' node name at point.
1469 The first and second arguments bound the search for a pointer to the
1470 beginning and end, respectively, of the enclosing higher level
1471 section. The third argument is the hierarchical level of the Texinfo
1472 file, a string such as \"section\". The fourth argument is direction
1473 towards which the pointer is directed, one of `next', `previous', or `up'."
1479 (texinfo-pointer-name
1480 (texinfo-find-pointer beginning end level direction
)))))
1482 (defun texinfo-clean-up-node-line ()
1483 "Remove extra commas, if any, at end of node line."
1485 (skip-chars-backward ", ")
1486 (delete-region (point) (save-excursion (end-of-line) (point))))
1489 ;;; Updating nodes sequentially
1490 ;; These sequential update functions insert `Next' or `Previous'
1491 ;; pointers that point to the following or preceding nodes even if they
1492 ;; are at higher or lower hierarchical levels. This means that if a
1493 ;; section contains one or more subsections, the section's `Next'
1494 ;; pointer will point to the subsection and not the following section.
1495 ;; (The subsection to which `Next' points will most likely be the first
1496 ;; item on the section's menu.)
1498 (defun texinfo-sequential-node-update (&optional region-p
)
1499 "Update one node (or many) in a Texinfo file with sequential pointers.
1501 This function causes the `Next' or `Previous' pointer to point to the
1502 immediately preceding or following node, even if it is at a higher or
1503 lower hierarchical level in the document. Continually pressing `n' or
1504 `p' takes you straight through the file.
1506 Without any prefix argument, update the node in which point is located.
1507 Non-nil argument (prefix, if interactive) means update the nodes in the
1510 This command makes it awkward to navigate among sections and
1511 subsections; it should be used only for those documents that are meant
1512 to be read like a novel rather than a reference, and for which the
1513 Info `g*' command is inadequate."
1517 ;; update a single node
1518 (let ((auto-fill-function nil
))
1519 (if (not (re-search-backward "^@node" (point-min) t
))
1520 (error "Node line not found before this position"))
1521 (texinfo-sequentially-update-the-node)
1523 "Done...sequentially updated the node . You may save the buffer."))
1525 (let ((auto-fill-function nil
)
1526 (beginning (region-beginning))
1528 (if (= end beginning
)
1529 (error "Please mark a region"))
1531 (narrow-to-region beginning end
)
1532 (goto-char beginning
)
1533 (push-mark (point) t
)
1534 (while (re-search-forward "^@node" (point-max) t
)
1536 (texinfo-sequentially-update-the-node))
1538 "Done...updated the nodes in sequence. You may save the buffer.")))))
1540 (defun texinfo-sequentially-update-the-node ()
1541 "Update one node such that the pointers are sequential.
1542 A `Next' or `Previous' pointer points to any preceding or following node,
1543 regardless of its hierarchical level."
1545 (texinfo-check-for-node-name)
1546 (texinfo-delete-existing-pointers)
1548 "Sequentially updating node: %s ... " (texinfo-copy-node-name))
1551 (let* ((case-fold-search t
)
1552 (level (texinfo-hierarchic-level)))
1554 (texinfo-top-pointer-case)
1556 (texinfo-sequentially-insert-pointer level
'next
)
1557 (texinfo-sequentially-insert-pointer level
'previous
)
1558 (texinfo-sequentially-insert-pointer level
'up
)
1559 (texinfo-clean-up-node-line)))))
1561 (defun texinfo-sequentially-insert-pointer (level direction
)
1562 "Insert the `Next', `Previous' or `Up' node name at point.
1565 The first argument is the hierarchical level of the Texinfo file, a
1566 string such as \"section\". The second argument is direction, one of
1567 `next', `previous', or `up'."
1573 (texinfo-pointer-name
1574 (texinfo-sequentially-find-pointer level direction
)))))
1576 (defun texinfo-sequentially-find-pointer (level direction
)
1577 "Find next or previous pointer sequentially in Texinfo file, or up pointer.
1578 Move point to section associated with the pointer. Find point even if
1579 it is in a different section.
1581 Return type of pointer (either `normal' or `no-pointer').
1583 The first argument is a string specifying the general kind of section
1584 such as \"chapter\" or \"section\". The section found will be at the
1585 same hierarchical level in the Texinfo file, or, in the case of the up
1586 pointer, some level higher. The second argument (one of `next',
1587 `previous', or `up') specifies whether to find the `Next', `Previous',
1589 (let ((case-fold-search t
))
1590 (cond ((eq direction
'next
)
1591 (forward-line 3) ; skip over current node
1592 (if (re-search-forward
1593 texinfo-section-types-regexp
1598 ((eq direction
'previous
)
1599 (if (re-search-backward
1600 texinfo-section-types-regexp
1606 (if (re-search-backward
1607 (eval (cdr (assoc level texinfo-update-menu-higher-regexps
)))
1613 (error "texinfo-sequential-find-pointer: lack proper arguments")))))
1616 ;;; Inserting `@node' lines
1617 ;; The `texinfo-insert-node-lines' function inserts `@node' lines as needed
1618 ;; before the `@chapter', `@section', and such like lines of a region
1619 ;; in a Texinfo file.
1621 (defun texinfo-insert-node-lines (beginning end
&optional title-p
)
1622 "Insert missing `@node' lines in region of Texinfo file.
1623 Non-nil argument (prefix, if interactive) means also to insert the
1624 section titles as node names; and also to insert the section titles as
1625 node names in pre-existing `@node' lines that lack names."
1626 (interactive "r\nP")
1628 ;; Use marker; after inserting node lines, leave point at end of
1629 ;; region and mark at beginning.
1631 (let (beginning-marker end-marker title last-section-position
)
1633 ;; Save current position on mark ring and set mark to end.
1635 (setq end-marker
(mark-marker))
1637 (goto-char beginning
)
1638 (while (re-search-forward
1639 texinfo-section-types-regexp
1642 ;; Copy title if desired.
1647 (skip-chars-forward " \t")
1648 (setq title
(buffer-substring
1650 (save-excursion (end-of-line) (point))))))
1651 ;; Insert node line if necessary.
1652 (if (re-search-backward
1654 ;; Avoid finding previous node line if node lines are close.
1655 (or last-section-position
1656 (save-excursion (forward-line -
2) (point))) t
)
1657 ;; @node is present, and point at beginning of that line
1658 (forward-word 1) ; Leave point just after @node.
1659 ;; Else @node missing; insert one.
1660 (beginning-of-line) ; Beginning of `@section' line.
1662 (backward-char 1)) ; Leave point just after `@node'.
1663 ;; Insert title if desired.
1666 (skip-chars-forward " \t")
1667 ;; Use regexp based on what info looks for
1668 ;; (alternatively, use "[a-zA-Z]+");
1669 ;; this means we only insert a title if none exists.
1670 (if (not (looking-at "[^,\t\n ]+"))
1675 (message "Inserted title %s ... " title
)))))
1676 ;; Go forward beyond current section title.
1677 (re-search-forward texinfo-section-types-regexp
1678 (save-excursion (forward-line 3) (point)) t
)
1679 (setq last-section-position
(point))
1682 ;; Leave point at end of region, mark at beginning.
1683 (set-mark beginning
)
1687 "Done inserting node lines and titles. You may save the buffer.")
1688 (message "Done inserting node lines. You may save the buffer."))))
1691 ;;; Update and create menus for multi-file Texinfo sources
1693 ;; 1. M-x texinfo-multiple-files-update
1695 ;; Read the include file list of an outer Texinfo file and
1696 ;; update all highest level nodes in the files listed and insert a
1697 ;; main menu in the outer file after its top node.
1699 ;; 2. C-u M-x texinfo-multiple-files-update
1701 ;; Same as 1, but insert a master menu. (Saves reupdating lower
1702 ;; level menus and nodes.) This command simply reads every menu,
1703 ;; so if the menus are wrong, the master menu will be wrong.
1704 ;; Similarly, if the lower level node pointers are wrong, they
1707 ;; 3. C-u 2 M-x texinfo-multiple-files-update
1709 ;; Read the include file list of an outer Texinfo file and
1710 ;; update all nodes and menus in the files listed and insert a
1711 ;; master menu in the outer file after its top node.
1713 ;;; Note: these functions:
1715 ;;; * Do not save or delete any buffers. You may fill up your memory.
1716 ;;; * Do not handle any pre-existing nodes in outer file.
1717 ;;; Hence, you may need a file for indices.
1720 ;;; Auxiliary functions for multiple file updating
1722 (defun texinfo-multi-file-included-list (outer-file)
1723 "Return a list of the included files in OUTER-FILE."
1724 (let ((included-file-list (list outer-file
))
1727 (set-buffer (find-file-noselect outer-file
))
1729 (goto-char (point-min))
1730 (while (re-search-forward "^@include" nil t
)
1731 (skip-chars-forward " \t")
1732 (setq start
(point))
1734 (skip-chars-backward " \t")
1735 (setq included-file-list
1736 (cons (buffer-substring start
(point))
1737 included-file-list
)))
1738 (nreverse included-file-list
))))
1740 (defun texinfo-copy-next-section-title ()
1741 "Return the name of the immediately following section as a string.
1743 Start with point at the beginning of the node line. Leave point at the
1744 same place. If there is no title, returns an empty string."
1750 (if (re-search-forward "\\(^@node\\)" nil t
)
1751 (match-beginning 0)))
1753 (if (re-search-forward texinfo-section-types-regexp node-end t
)
1759 (progn (forward-word 1) ; skip over section type
1760 (skip-chars-forward " \t") ; and over spaces
1762 (progn (end-of-line) (point)))))
1766 (defun texinfo-multi-file-update (files &optional update-everything
)
1767 "Update first node pointers in each file in FILES.
1768 Return a list of the node names.
1770 The first file in the list is an outer file; the remaining are
1771 files included in the outer file with `@include' commands.
1773 If optional arg UPDATE-EVERYTHING non-nil, update every menu and
1774 pointer in each of the included files.
1776 Also update the `Top' level node pointers of the outer file.
1780 * the first file in the FILES list must be the outer file,
1781 * each of the included files must contain exactly one highest
1782 hierarchical level node,
1783 * this node must be the first node in the included file,
1784 * each highest hierarchical level node must be of the same type.
1786 Thus, normally, each included file contains one, and only one, chapter.
1788 However, when an included file does not have any node lines in
1789 it, this command does not try to create a menu entry for it.
1790 Consequently, you can include any file, such as a version or an
1791 update file without node lines, not just files that are
1794 ;; The menu-list has the form:
1796 ;; \(\(\"node-name1\" . \"title1\"\)
1797 ;; \(\"node-name2\" . \"title2\"\) ... \)
1799 ;; However, there does not need to be a title field and this function
1800 ;; does not fill it; however a comment tells you how to do so.
1801 ;; You would use the title field if you wanted to insert titles in the
1802 ;; description slot of a menu as a description.
1804 (let ((case-fold-search t
)
1805 menu-list next-node-name previous-node-name files-with-node-lines
)
1807 ;; Create a new list of included files that only have node lines
1809 (set-buffer (find-file-noselect (car files
)))
1811 (goto-char (point-min))
1812 (when (re-search-forward "^@node" nil t
)
1813 (setq files-with-node-lines
(cons (car files
) files-with-node-lines
)))
1814 (setq files
(cdr files
)))
1815 (setq files-with-node-lines
(nreverse files-with-node-lines
))
1817 ;; Find the name of the first node in a subsequent file
1818 ;; and copy it into the variable next-node-name
1819 (set-buffer (find-file-noselect (car (cdr files-with-node-lines
))))
1821 (goto-char (point-min))
1823 (texinfo-check-for-node-name)
1824 (setq next-node-name
(texinfo-copy-node-name))
1825 (push (cons next-node-name
(prog1 "" (forward-line 1)))
1826 ;; Use following to insert section titles automatically.
1827 ;; (texinfo-copy-next-section-title)
1831 ;; `pop' is analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE)))
1832 (set-buffer (find-file-noselect (pop files-with-node-lines
)))
1833 (goto-char (point-min))
1834 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t
))
1835 (error "This buffer needs a Top node"))
1837 (texinfo-delete-existing-pointers)
1839 (insert ", " next-node-name
", (dir), (dir)")
1841 (setq previous-node-name
"Top")
1843 (while files-with-node-lines
1845 (if (not (cdr files-with-node-lines
))
1847 (setq next-node-name
"")
1849 ;; find the name of the first node in the next file.
1850 (set-buffer (find-file-noselect (car (cdr files-with-node-lines
))))
1852 (goto-char (point-min))
1854 (texinfo-check-for-node-name)
1855 (setq next-node-name
(texinfo-copy-node-name))
1856 (push (cons next-node-name
(prog1 "" (forward-line 1)))
1857 ;; Use following to insert section titles automatically.
1858 ;; (texinfo-copy-next-section-title)
1861 ;; Go to node to be updated.
1862 (set-buffer (find-file-noselect (car files-with-node-lines
)))
1863 (goto-char (point-min))
1866 ;; Update other menus and nodes if requested.
1867 (if update-everything
(texinfo-all-menus-update t
))
1870 (texinfo-delete-existing-pointers)
1872 (insert ", " next-node-name
", " previous-node-name
", Top")
1875 (setq previous-node-name
(texinfo-copy-node-name))
1877 (setq files-with-node-lines
(cdr files-with-node-lines
)))
1878 (nreverse menu-list
)))
1880 (defun texinfo-multi-files-insert-main-menu (menu-list)
1881 "Insert formatted main menu at point.
1882 Indents the first line of the description, if any, to the value of
1883 `texinfo-column-for-description'."
1886 (dolist (entry menu-list
)
1887 ;; Every menu entry starts with a star and a space.
1890 ;; Insert the node name (and menu entry name, if present).
1891 (let ((node-part (car entry
)))
1892 (if (stringp node-part
)
1893 ;; "Double colon" entry line; menu entry and node name are the same,
1894 (insert (format "%s::" node-part
))
1895 ;; "Single colon" entry line; menu entry and node name are different.
1896 (insert (format "%s: %s." (car node-part
) (cdr node-part
)))))
1898 ;; Insert the description, if present.
1900 ;; Move to right place.
1901 (indent-to texinfo-column-for-description
2)
1902 ;; Insert description.
1903 (insert (format "%s" (cdr entry
))))
1905 (insert "\n")) ; end this menu entry
1906 (insert "@end menu"))
1908 (defun texinfo-multi-file-master-menu-list (files-list)
1909 "Return master menu list from files in FILES-LIST.
1910 Menu entries in each file collected using `texinfo-master-menu-list'.
1912 The first file in FILES-LIST must be the outer file; the others must
1913 be the files included within it. A main menu must already exist."
1915 (let (master-menu-list)
1916 (dolist (file files-list
)
1917 (set-buffer (find-file-noselect file
))
1918 (message "Working on: %s " (current-buffer))
1919 (goto-char (point-min))
1920 (setq master-menu-list
1921 (append master-menu-list
(texinfo-master-menu-list))))
1925 ;;; The multiple-file update function
1927 (defun texinfo-multiple-files-update
1928 (outer-file &optional update-everything make-master-menu
)
1929 "Update first node pointers in each file included in OUTER-FILE;
1930 create or update the `Top' level node pointers and the main menu in
1931 the outer file that refers to such nodes. This does not create or
1932 update menus or pointers within the included files.
1934 With optional MAKE-MASTER-MENU argument (prefix arg, if interactive),
1935 insert a master menu in OUTER-FILE in addition to creating or updating
1936 pointers in the first @node line in each included file and creating or
1937 updating the `Top' level node pointers of the outer file. This does
1938 not create or update other menus and pointers within the included
1941 With optional UPDATE-EVERYTHING argument (numeric prefix arg, if
1942 interactive), update all the menus and all the `Next', `Previous', and
1943 `Up' pointers of all the files included in OUTER-FILE before inserting
1944 a master menu in OUTER-FILE. Also, update the `Top' level node
1945 pointers of OUTER-FILE.
1949 * this command does NOT save any files--you must save the
1950 outer file and any modified, included files.
1952 * except for the `Top' node, this command does NOT handle any
1953 pre-existing nodes in the outer file; hence, indices must be
1954 enclosed in an included file.
1958 * each of the included files must contain exactly one highest
1959 hierarchical level node,
1960 * this highest node must be the first node in the included file,
1961 * each highest hierarchical level node must be of the same type.
1963 Thus, normally, each included file contains one, and only one,
1968 "Name of outer `include' file: "
1971 ((not current-prefix-arg
) '(nil nil
))
1972 ((listp current-prefix-arg
) '(t nil
)) ; make-master-menu
1973 ((numberp current-prefix-arg
) '(t t
))))) ; update-everything
1975 (let* ((included-file-list (texinfo-multi-file-included-list outer-file
))
1976 (files included-file-list
)
1979 ;; Update the pointers and collect the names of the nodes and titles
1980 (main-menu-list (texinfo-multi-file-update files update-everything
)))
1985 (set-buffer (find-file-noselect (car included-file-list
)))
1986 (if (texinfo-old-menu-p
1989 (re-search-forward "^@include")
1993 ;; If found, leave point after word `menu' on the `@menu' line.
1995 (texinfo-incorporate-descriptions main-menu-list
)
1996 ;; Delete existing menu.
2000 (save-excursion (re-search-forward "^@end menu") (point)))
2002 (texinfo-multi-files-insert-main-menu main-menu-list
))
2004 ;; Else no current menu; insert it before `@include'
2005 (texinfo-multi-files-insert-main-menu main-menu-list
))
2007 ;; Insert master menu
2009 (if make-master-menu
2011 ;; First, removing detailed part of any pre-existing master menu
2012 (goto-char (point-min))
2013 (if (search-forward texinfo-master-menu-header nil t
)
2015 (goto-char (match-beginning 0))
2016 ;; Check if @detailmenu kludge is used;
2017 ;; if so, leave point before @detailmenu.
2018 (search-backward "\n@detailmenu"
2019 (save-excursion (forward-line -
3) (point))
2021 ;; Remove detailed master menu listing
2022 (let ((end-of-detailed-menu-descriptions
2023 (save-excursion ; beginning of end menu line
2024 (goto-char (texinfo-menu-end))
2025 (beginning-of-line) (forward-char -
1)
2027 (delete-region (point) end-of-detailed-menu-descriptions
))))
2029 ;; Create a master menu and insert it
2030 (texinfo-insert-master-menu-list
2031 (texinfo-multi-file-master-menu-list
2032 included-file-list
)))))
2034 ;; Remove unwanted extra lines.
2036 (goto-char (point-min))
2038 (re-search-forward "^@menu")
2040 (insert "\n") ; Ensure at least one blank line.
2041 (delete-blank-lines)
2043 (re-search-forward "^@end menu")
2045 (insert "\n") ; Ensure at least one blank line.
2046 (delete-blank-lines))
2048 (message "Multiple files updated."))
2051 ;; Place `provide' at end of file.
2052 (provide 'texnfo-upd
)
2054 ;;; arch-tag: d21613a5-c32f-43f4-8af4-bfb1e7455842
2055 ;;; texnfo-upd.el ends here