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