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