;;;; latexnfo-upd.el ;;; Latexinfo mode utilities for updating nodes and menus in Latexinfo files. ;;; Version 2.07 10 September 1991 ;;; Robert J. Chassell ;;; Converted to Latexinfo by Mike Clarkson ;;; Please send bug reports to: mike@apl.ists.ca ;;; Copyright 1989, 1990, 1991 Free Software Foundation ;;; Copyleft (C) 1988, 1989, 1990, 1991 Michael E. Clarkson ;;; Known bug: update commands fail to ignore \begin{ignore}. ;;; This file is not part of GNU Emacs. ;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 1, or (at your option) ;; any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. ;;; Summary: how to use the updating commands ; The node and menu updating functions automatically ; * insert missing `\node' lines, ; * insert the `Next', `Previous' and `Up' pointers of a node, ; * insert or update the menu for a section, ; * create a master menu for a Latexinfo source file. ; ; Passed an argument, the `latexinfo-update-node' and ; `latexinfo-make-menu' functions do their jobs in the region. ; ; In brief, the functions for creating or updating nodes and menus, are: ; ; latexinfo-update-node (&optional region-p) ; latexinfo-every-node-update () ; latexinfo-sequential-node-update (&optional region-p) ; ; latexinfo-make-menu (&optional region-p) ; latexinfo-all-menus-update () ; latexinfo-master-menu () ; ; latexinfo-insert-node-lines (&optional title-p) ; ; latexinfo-indent-menu-description (column &optional region-p) ; The `latexinfo-column-for-description' variable specifies the column to ; which menu descriptions are indented. ; Latexinfo file structure ; ---------------------- ; To use the updating commands, you must structure your Latexinfo file ; hierarchically. Each `\node' line, with the exception of the top ; node, must be accompanied by some kind of section line, such as an ; `\chapter' or `\section' line. Each node-line/section-line ; combination must look like this: ; \node Lists and Tables, Cross References, Structuring, Top ; \comment node-name, next, previous, up ; \chapter{Making Lists and Tables} ; or like this (without the `\comment' line): ; \node Lists and Tables, Cross References, Structuring, Top ; \chapter{Making Lists and Tables} ; If the file has a `top' node, it must be called `top' or `Top' and ; be the first node in the file. ;;; The update node functions described in detail ; The `latexinfo-update-node' function without an argument inserts ; the correct next, previous and up pointers for the node in which ; point is located (i.e., for the node preceding point). ; With an argument, the `latexinfo-update-node' function inserts the ; correct next, previous and up pointers for the nodes inside the ; region. ; It does not matter whether the `\node' line has pre-existing ; `Next', `Previous', or `Up' pointers in it. They are removed. ; The `latexinfo-every-node-update' function runs `latexinfo-update-node' ; on the whole buffer. ; The `latexinfo-update-node' function inserts the immediately following ; and preceding node into the `Next' or `Previous' pointers regardless ; of their hierarchical level. This is only useful for certain kinds ; of text, like a novel, which you go through sequentially. ;;; The menu making functions described in detail ; The `latexinfo-make-menu' function without an argument creates or ; updates a menu for the section encompassing the node that follows ; point. With an argument, it makes or updates menus for the nodes ; within or part of the marked region. ; Whenever an existing menu is updated, the descriptions from ; that menu are incorporated into the new menu. This is done by copying ; descriptions from the existing menu to the entries in the new menu ; that have the same node names. If the node names are different, the ; descriptions are not copied to the new menu. ; Menu entries that refer to other Info files are removed since they ; are not a node within current buffer. This is a deficiency. ; The `latexinfo-all-menus-update' function runs `latexinfo-make-menu' ; on the whole buffer. ; The `latexinfo-master-menu' function creates an extended menu located ; after the top node. (The file must have a top node.) The function ; first updates all the regular menus in the buffer (incorporating the ; descriptions from pre-existing menus), and then constructs a master ; menu that includes every entry from every other menu. (However, the ; function cannot update an already existing master menu; if one ; exists, it must be removed before calling the function.) ; The `latexinfo-indent-menu-description' function indents every ; description in the menu following point, to the specified column. ; Non-nil argument (prefix, if interactive) means indent every ; description in every menu in the region. This function does not ; indent second and subsequent lines of a multi-line description. ; The `latexinfo-insert-node-lines' function inserts `\node' before the ; `\chapter', `\section', and such like lines of a region in a Latexinfo ; file where the `\node' lines are missing. ; ; With a non-nil argument (prefix, if interactive), the function not ; only inserts `\node' lines but also inserts the chapter or section ; titles as the names of the corresponding nodes; and inserts titles ; as node names in pre-existing `\node' lines that lack names. ; ; Since node names should be more concise than section or chapter ; titles, node names so inserted will need to be edited manually. ;;; The menu making functions (defun latexinfo-make-menu (&optional region-p) "Without any prefix argument, make or update a menu. Make the menu for the section enclosing the node found following point. Non-nil argument (prefix, if interactive) means make or update menus for nodes within or part of the marked region. Whenever a menu exists, and is being updated, the descriptions that are associated with node names in the pre-existing menu are incorporated into the new menu. Otherwise, the nodes' section titles are inserted as descriptions." (interactive "P") (if (not region-p) (let ((level (latexinfo-hierarchic-level))) (latexinfo-make-one-menu level) (message "Done...updated the menu. You may save the buffer.")) ;; else (message "Making or updating menus in %s... " (buffer-name)) (let ((beginning (region-beginning)) (region-end (region-end)) (level (progn ; find section type following point (goto-char (region-beginning)) (latexinfo-hierarchic-level)))) (if (= region-end beginning) (error "Please mark a region!")) (save-excursion (save-restriction (widen) (while (latexinfo-find-lower-level-node level region-end) (setq level (latexinfo-hierarchic-level)) ; new, lower level (latexinfo-make-one-menu level)) (while (and (< (point) region-end) (latexinfo-find-higher-level-node level region-end)) (setq level (latexinfo-hierarchic-level)) (while (latexinfo-find-lower-level-node level region-end) (setq level (latexinfo-hierarchic-level)) ; new, lower level (latexinfo-make-one-menu level)))))) (message "Done...updated menus. You may save the buffer."))) (defun latexinfo-make-one-menu (level) "Make a menu of all the appropriate nodes in this section. `Appropriate nodes' are those associated with sections that are at the level specified by LEVEL. Point is left at the end of menu." (let* ((case-fold-search t) (beginning (save-excursion (goto-char (latexinfo-update-menu-region-beginning level)) (end-of-line) (point))) (end (latexinfo-update-menu-region-end level)) (first (latexinfo-menu-first-node beginning end)) (node-name (progn (goto-char beginning) (beginning-of-line) (latexinfo-copy-node-name))) (new-menu-list (latexinfo-make-menu-list beginning end level))) (if (latexinfo-old-menu-p beginning first) (progn (latexinfo-incorporate-descriptions new-menu-list) (latexinfo-delete-old-menu beginning first))) (latexinfo-insert-menu new-menu-list node-name))) (defun latexinfo-all-menus-update (&optional update-all-nodes-p) "Update every regular menu in a Latexinfo file. Update pre-existing master menu, if there is one. If called with a non-nil argument, this function first updates all the nodes in the buffer before updating the menus. If called with a non-nil argument of 'sequential, this function first sequentially updates all the nodes in the buffer before updating the menus. " (interactive "P") (let (master-menu-p) (save-excursion (mark-whole-buffer) (message "Checking for a master menu in %s ... "(buffer-name)) (save-excursion (if (re-search-forward latexinfo-master-menu-header nil t) ;; Remove detailed master menu listing (progn (setq master-menu-p t) (goto-char (match-beginning 0)) (let ((end-of-detailed-menu-descriptions (save-excursion ; beginning of end menu line (goto-char (latexinfo-menu-end)) (beginning-of-line) (forward-char -1) (point)))) (delete-region (point) end-of-detailed-menu-descriptions))))) (if update-all-nodes-p (progn (message "Updating all nodes in %s ... " (buffer-name)) (sleep-for 2) (mark-whole-buffer) (if (equal update-all-nodes-p 'sequential) (latexinfo-sequential-node-update t) (latexinfo-update-node t)))) (message "Updating all menus in %s ... " (buffer-name)) (sleep-for 2) (mark-whole-buffer) (latexinfo-make-menu t) (if master-menu-p (progn (message "Updating the master menu in %s... " (buffer-name)) (sleep-for 2) (latexinfo-master-menu nil)))) (message "Done...updated all the menus. You may save the buffer."))) (defun latexinfo-find-lower-level-node (level region-end) "Search forward from point for node at any level lower than LEVEL. Search is limited to the end of the marked region, REGION-END, and to the end of the menu region for the level. Return t if the node is found, else nil. Leave point at the beginning of the node if one is found; else do not move point." (if (and (< (point) region-end) (re-search-forward (concat "\\(^\\\\node\\).*\n" ; match node line "\\(\\(\\(^\\\\c\\).*\n\\)" ; match comment line, if any "\\|" ; or "\\(^\\\\begin{ifinfo}[ ]*\n\\)\\)?" ; ifinfo line, if any (eval (cdr (assoc level latexinfo-update-menu-lower-regexps)))) ;; the next higher level node marks the end of this ;; section, and no lower level node will be found beyond ;; this position even if region-end is farther off (latexinfo-update-menu-region-end level) t)) (goto-char (match-beginning 1)))) (defun latexinfo-find-higher-level-node (level region-end) "Search forward from point for node at any higher level than argument LEVEL. Search is limited to the end of the marked region, REGION-END. Return t if the node is found, else nil. Leave point at the beginning of the node if one is found; else do not move point." (cond ((or (string-equal "top" level) (string-equal "chapter" level)) (if (re-search-forward "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t) (progn (beginning-of-line) t))) (t (if (re-search-forward (concat "\\(^\\\\node\\).*\n" ; match node line "\\(\\(\\(^\\\\c\\).*\n\\)" ; match comment line, if any "\\|" ; or "\\(^\\\\begin{ifinfo}[ ]*\n\\)\\)?" ; ifinfo line, if any (eval (cdr (assoc level latexinfo-update-menu-higher-regexps)))) region-end t) (progn (beginning-of-line) t))))) ;;; Making the list of new menu entries (defun latexinfo-make-menu-list (beginning end level) "Make a list of node names and their descriptions. Point is left at the end of the menu region, but the menu is not inserted. First argument is position from which to start making menu list; second argument is end of region in which to try to locate entries; third argument is the level of the nodes that are the entries. Node names and descriptions are dotted pairs of strings. Each pair is an element of the list. If the description does not exist, the element consists only of the node name." (goto-char beginning) (let (new-menu-list) (while (latexinfo-menu-locate-entry-p level end) (setq new-menu-list (cons (cons (latexinfo-copy-node-name) (latexinfo-copy-section-title)) new-menu-list))) (reverse new-menu-list))) (defun latexinfo-menu-locate-entry-p (level search-end) "Find a node that will be part of menu for this section. First argument is a string such as \"section\" specifying the general hierarchical level of the menu; second argument is a postion specifying the end of the search. The function returns t if the node is found, else nil. It searches forward from point, and leaves point at the beginning of the node. The function finds entries of the same type. Thus `subsections' and `unnumberedsubsecs' will appear in the same menu." (if (re-search-forward (concat "\\(^\\\\node\\).*\n" ; match node line "\\(\\(\\(^\\\\c\\).*\n\\)" ; match comment line, if any "\\|" ; or "\\(^\\\\begin{ifinfo}[ ]*\n\\)\\)?" ; ifinfo line, if any (eval (cdr (assoc level latexinfo-update-menu-same-level-regexps)))) search-end t) (goto-char (match-beginning 1)))) (defun latexinfo-copy-node-name () "Return the node name as a string. Start with point at the beginning of the node line; copy the text after the node command up to the first comma on the line, if any, and return the text as a string. Leaves point at the beginning of the line. If there is no node name, returns an empty string." (save-excursion (buffer-substring (progn (forward-word 1) (skip-chars-forward " \t") (point)) (if (search-forward ; mike "," (save-excursion (end-of-line) (point)) t) ; bound search (1- (point)) (end-of-line) (point))) )) (defun latexinfo-copy-section-title () "Return the title of the section as a string. The title is used as a description line in the menu when one does not already exist. Move point to the beginning of the appropriate section line by going to the start of the text matched by last regexp searched for, which must have been done by `latexinfo-menu-locate-entry-p'." ;; could use the same re-search as in `latexinfo-menu-locate-entry-p' ;; instead of using `match-beginning'; such a variation would be ;; more general, but would waste information already collected (goto-char (match-beginning 7)) ; match section name (forward-word 1) (skip-chars-forward " \t") (buffer-substring ; look for braces - mike (1+ (point)) (progn (forward-sexp 1) (1- (point))))) ;;; Handling the old menu (defun latexinfo-old-menu-p (beginning first) "Move point to the beginning of the menu for this section, if any. Otherwise move point to the end of the first node of this section. Return t if a menu is found, nil otherwise. First argument is the position of the beginning of the section in which the menu will be located; second argument is the position of the first node within the section. If no menu is found, the function inserts two newlines just before the end of the section, and leaves point there where a menu ought to be." (goto-char beginning) (if (not (re-search-forward "^\\\\begin{menu}" first 'goto-end)) (progn (insert "\n\n") (forward-line -2) nil) t)) (defun latexinfo-incorporate-descriptions (new-menu-list) "Copy the old menu line descriptions that exist to the new menu. Point must be at beginning of old menu. If the node-name of the new menu entry cannot be found in the old menu, use the new section title for the description, but if the node-name of the new menu is found in the old menu, replace the section title with the old description, whatever it may be. For this function, the new menu is a list made up of lists of dotted pairs in which the first element of the pair is the node name and the second element the description. The new menu is changed destructively. The old menu is the menu as it appears in the latexinfo file." (let ((new-menu-list-pointer new-menu-list) (end-of-menu (latexinfo-menu-end))) (while new-menu-list (save-excursion ; keep point at beginning of menu (if (search-forward (concat "\* " ; so only menu entries are found (car (car new-menu-list)) ":") ; so only complete entries are found end-of-menu t) (setcdr (car new-menu-list) (latexinfo-menu-copy-old-description end-of-menu)))) (setq new-menu-list (cdr new-menu-list))) (setq new-menu-list new-menu-list-pointer))) (defun latexinfo-menu-copy-old-description (end-of-menu) "Return description field of old menu line as string. Point must be located just after the node name. Point left before description. Single argument, END-OF-MENU, is position limiting search." (skip-chars-forward "[:.,\t\n ]+") ;; don't copy a carriage return at line beginning with asterisk! ;; do copy a description that begins with an `\'! (if (and (looking-at "\\(\\w+\\|\\\\\\)") (not (looking-at "\\(^\\* \\|^\\\\end{menu}\\)"))) (buffer-substring (point) (save-excursion (re-search-forward "\\(^\\* \\|^\\\\end{menu}\\)" end-of-menu t) (forward-line -1) (end-of-line) ; go to end of last description line (point))) "")) (defun latexinfo-menu-end () "Return position of end of menu. Does not change location of point. Signal an error if not end of menu." (save-excursion (if (re-search-forward "^\\\\end{menu}" nil t) (point) (error "Menu does not have an end.")))) (defun latexinfo-delete-old-menu (beginning first) "Delete the old menu. Point must be in or after menu. First argument is position of the beginning of the section in which the menu will be located; second argument is the position of the first node within the section." ;; No third arg to search, so error if search fails. (re-search-backward "^\\\\begin{menu}" beginning) (delete-region (point) (save-excursion (re-search-forward "^\\\\end{menu}" first) (point)))) ;;; Inserting new menu ;; try 32, but perhaps 24 is better (defvar latexinfo-column-for-description 32 "*Column at which descriptions start in a Latexinfo menu.") (defun latexinfo-insert-menu (menu-list node-name) "Insert formatted menu at point. Indents the first line of the description, if any, to the value of latexinfo-column-for-description. MENU-LIST has form: \(\(\"node-name1\" . \"description\"\) \(\"node-name\" . \"description\"\) ... \) However, there does not need to be a description field." (insert "\\begin{menu}\n") (while menu-list (if (and (cdr (car menu-list)) ; menu-list has description entry (not (string-equal (cdr (car menu-list)) (car (car menu-list))))) (progn ; if its not a duplicate - mike (insert (format "* %s::" (car (car menu-list)))) ; node-name entry (indent-to latexinfo-column-for-description 2) (insert (format "%s\n" (cdr (car menu-list))))) ; description entry ;; else menu-list lacks description entry (insert (format "* %s::\n" (car (car menu-list))))) ; node-name entry (setq menu-list (cdr menu-list))) (insert "\\end{menu}") (message "Updated \"%s\" level menu following node: %s ... " level node-name)) ;;; Handling description indentation ; Since the make-menu functions indent descriptions, these functions ; are useful primarily for indenting a single menu specially. (defun latexinfo-indent-menu-description (column &optional region-p) "Indent every description in menu following point to COLUMN. Non-nil argument (prefix, if interactive) means indent every description in every menu in the region. Does not indent second and subsequent lines of a multi-line description." (interactive "nIndent menu descriptions to (column number): \nP") (save-excursion (save-restriction (widen) (if (not region-p) (progn (re-search-forward "^\\\\begin{menu}") (latexinfo-menu-indent-description column) (message "Indented descriptions in menu. You may save the buffer.")) ;;else (message "Indenting every menu description in region... ") (goto-char (region-beginning)) (while (and (< (point) (region-end)) (latexinfo-locate-menu-p)) (forward-line 1) (latexinfo-menu-indent-description column)) (message "Indenting done. You may save the buffer."))))) (defun latexinfo-menu-indent-description (to-column-number) "Indent the Latexinfo file menu description to TO-COLUMN-NUMBER. Start with point just after the word `menu' in the `\\menu' line and leave point on the line before the `\\end{menu}' line. Does not indent second and subsequent lines of a multi-line description." (let* ((beginning-of-next-line (point))) (while (< beginning-of-next-line (save-excursion ; beginning of end menu line (goto-char (latexinfo-menu-end)) (beginning-of-line) (point))) (if (search-forward "::" (latexinfo-menu-end) t) (progn (let ((beginning-white-space (point))) (skip-chars-forward " \t") ; skip over spaces (if (looking-at "\\(\\\\\\|\\w\\)+") ; if there is text (progn ;; remove pre-existing indentation (delete-region beginning-white-space (point)) (indent-to-column to-column-number)))))) ;; position point at beginning of next line (forward-line 1) (setq beginning-of-next-line (point))))) ;;; Making the master menu (defun latexinfo-master-menu (update-all-nodes-menus-p) "Make a master menu for a whole Latexinfo file. Non-nil argument (prefix, if interactive) means first update all existing nodes and menus. Remove pre-existing master menu, if there is one. This function creates a master menu that follows the top node. The master menu includes every entry from all the other menus. It replaces any existing ordinary menu that follows the top node. If called with a non-nil argument, this function first updates all the menus in the buffer (incorporating descriptions from pre-existing menus) before it constructs the master menu. The function removes the detailed part of an already existing master menu. This action depends on the pre-exisitng master menu using the standard `latexinfo-master-menu-header'. The master menu has the following format, which is adapted from the recommendation in the Latexinfo Manual: * The first part contains the major nodes in the Latexinfo file: the nodes for the chapters, chapter-like sections, and the major appendices. This includes the indices, so long as they are in chapter-like sections, such as unnumbered sections. * The second and subsequent parts contain a listing of the other, lower level menus, in order. This way, an inquirer can go directly to a particular node if he or she is searching for specific information. Each of the menus in the detailed node listing is introduced by the title of the section containing the menu." (interactive "P") (widen) (goto-char (point-min)) ;; Move point to location after `top'. (if (not (re-search-forward "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) (error "This buffer needs a Top node!")) (let ((first-chapter (save-excursion (re-search-forward "^\\\\node") (point)))) (if (re-search-forward latexinfo-master-menu-header first-chapter t) ;; Remove detailed master menu listing (progn (goto-char (match-beginning 0)) (let ((end-of-detailed-menu-descriptions (save-excursion ; beginning of end menu line (goto-char (latexinfo-menu-end)) (beginning-of-line) (forward-char -1) (point)))) (delete-region (point) end-of-detailed-menu-descriptions))))) (if update-all-nodes-menus-p (progn (message "Making a master menu in %s ...first updating all nodes... " (buffer-name)) (sleep-for 2) (mark-whole-buffer) (latexinfo-update-node t) (message "Updating all menus in %s ... " (buffer-name)) (sleep-for 2) (mark-whole-buffer) (latexinfo-make-menu t))) (message "Now making the master menu in %s... " (buffer-name)) (sleep-for 2) (goto-char (point-min)) (latexinfo-insert-master-menu-list (latexinfo-master-menu-list)) ;; Remove extra newlines that latexinfo-insert-master-menu-list ;; may have inserted. (save-excursion (goto-char (point-min)) (re-search-forward latexinfo-master-menu-header) (goto-char (match-beginning 0)) (insert "\n") (delete-blank-lines) (re-search-backward "^\\\\begin{menu}") (forward-line -1) (delete-blank-lines) (re-search-forward "^\\\\end{menu}") (forward-line 1) (delete-blank-lines)) (message "Done...completed making master menu. You may save the buffer.")) (defun latexinfo-master-menu-list () "Return a list of menu entries and header lines for the master menu. Start with the menu for chapters and indices and then find each following menu and the title of the node preceding that menu. The master menu list has this form: \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\) \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\) ...\) However, there does not need to be a title field." (let (master-menu-list) (while (latexinfo-locate-menu-p) (setq master-menu-list (cons (list (latexinfo-copy-menu) (latexinfo-copy-menu-title)) master-menu-list))) (reverse master-menu-list))) (defun latexinfo-insert-master-menu-list (master-menu-list) "Format and insert the master menu in the current buffer." (goto-char (point-min)) (re-search-forward "^\\\\begin{menu}") (beginning-of-line) (delete-region (point) ; buffer must have ordinary top menu (save-excursion (re-search-forward "^\\\\end{menu}") (point))) (save-excursion ; leave point at beginning of menu ;; Handle top of menu (insert "\n\\begin{menu}\n") ;; Insert chapter menu entries (setq this-very-menu-list (reverse (car (car master-menu-list)))) ;;; Tell user what is going on. (message "Inserting chapter menu entry: %s ... " this-very-menu-list) (while this-very-menu-list (insert "* " (car this-very-menu-list) "\n") (setq this-very-menu-list (cdr this-very-menu-list))) (setq master-menu-list (cdr master-menu-list)) (insert latexinfo-master-menu-header) ;; Now, insert all the other menus ;; The menu master-menu-list has a form like this: ;; ((("beta" "alpha") "title-A") ;; (("delta" "gamma") "title-B")) (while master-menu-list (message "Inserting menu for %s .... " (car (cdr (car master-menu-list)))) ;; insert title of menu section (insert "\n" (car (cdr (car master-menu-list))) "\n\n") ;; insert each menu entry (setq this-very-menu-list (reverse (car (car master-menu-list)))) (while this-very-menu-list (insert "* " (car this-very-menu-list) "\n") (setq this-very-menu-list (cdr this-very-menu-list))) (setq master-menu-list (cdr master-menu-list))) ;; Finish menu (insert "\\end{menu}\n\n"))) (defvar latexinfo-master-menu-header "\n --- The Detailed Node Listing ---\n" "String inserted before lower level entries in Latexinfo master menu. It comes after the chapter-level menu entries.") (defun latexinfo-locate-menu-p () "Find the next menu in the latexinfo file. If found, leave point after word `menu' on the `\\begin{menu}' line, and return t. If a menu is not found, do not move point and return nil." (re-search-forward "\\(^\\\\begin{menu}\\)" nil t)) (defun latexinfo-copy-menu-title () "Return the title of the section preceding the menu as a string. If such a title cannot be found, return an empty string. Do not move point." (save-excursion (if (re-search-backward (concat "\\(^\\\\top" "\\|" ; or latexinfo-section-types-regexp ; all other section types "\\)") nil t) (progn (beginning-of-line) (forward-word 1) ; skip over section type (skip-chars-forward " \t") ; and over spaces (buffer-substring ; look for braces - mike (1+ (point)) (progn (forward-sexp 1) (1- (point))))) ""))) (defun latexinfo-copy-menu () "Return the entries of an existing menu as a list. Start with point just after the word `menu' in the `\\menu' line and leave point on the line before the `\\end{menu}' line." (let* (this-menu-list (end-of-menu (latexinfo-menu-end)) ; position of end of `\\end{menu}' (last-entry (save-excursion ; position of beginning of ; last `* ' entry (goto-char end-of-menu) (re-search-backward "^\* ") ; handle multi-line desc. (point)))) (while (< (point) last-entry) (if (re-search-forward "^\* " end-of-menu t) (progn (setq this-menu-list (cons (buffer-substring (point) ;; copy multi-line descriptions (save-excursion (re-search-forward "\\(^\* \\|^\\\\e\\)" nil t) (- (point) 3))) this-menu-list))))) this-menu-list)) ;;; Determining the hierarchical level in the latexinfo file (defun latexinfo-specific-section-type () "Return the specific type of next section, as a string. For example, \"unnumberedsubsec\". Return \"top\" for top node. Searches forward for a section. Hence, point must be before the section whose type will be found. Does not move point. Signal an error if the node is not the top node and a section is not found." (save-excursion (cond ((re-search-forward "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)" ;;; Following search limit by cph but causes a bug ;;; (save-excursion ;;; (end-of-line) ;;; (point)) nil t) "top") ((re-search-forward latexinfo-section-types-regexp nil t) (buffer-substring (progn (beginning-of-line) ; copy its name (1+ (point))) (progn (forward-word 1) (point)))) (t (error "latexinfo-specific-section-type: Chapter or section not found."))))) (defun latexinfo-hierarchic-level () "Return the general hierarchal level of the next node in a latexinfo file. Thus, a subsection* is of type subsection." (or (cdr (assoc (latexinfo-specific-section-type) latexinfo-section-to-generic-alist)) (error "Unknown section type!")) ) ;;; Locating the major positions (defun latexinfo-update-menu-region-beginning (level) "Locate beginning of higher level section this section is within. Return position of the beginning of the node line; do not move point. Thus, if this level is subsection, searches backwards for section node. Only argument is a string of the general type of section." (cond ((or (string-equal "top" level) (string-equal "chapter" level)) (save-excursion (goto-char (point-min)) (re-search-forward "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)" nil t) (beginning-of-line) (point))) (t (save-excursion (re-search-backward (concat "\\(^\\\\node\\).*\n" ; match node line "\\(\\(\\(^\\\\c\\).*\n\\)" ; match comment line, if any "\\|" ; or "\\(^\\\\begin{ifinfo}[ ]*\n\\)\\)?" ; ifinfo line, if any (eval (cdr (assoc level latexinfo-update-menu-higher-regexps)))) nil 'goto-beginning) (point))))) (defun latexinfo-update-menu-region-end (level) "Locate end of higher level section this section is within. Return position; do not move point. Thus, if this level is a subsection, find the node for the section this subsection is within. If level is top or chapter, returns end of file. Only argument is a string of the general type of section." (save-excursion (if (re-search-forward (concat "\\(^\\\\node\\).*\n" ; match node line "\\(\\(\\(^\\\\c\\).*\n\\)" ; match comment line, if any "\\|" ; or "\\(^\\\\begin{ifinfo}[ ]*\n\\)\\)?" ; ifinfo line, if any (eval ;; Never finds end of level above chapter so goes to end. (cdr (assoc level latexinfo-update-menu-higher-regexps)))) nil 'goto-end) (match-beginning 1) (point-max)))) (defun latexinfo-menu-first-node (beginning end) "Locate first node of the section the menu will be placed in. Return position; do not move point. The menu will be located just before this position. First argument is the position of the beginning of the section in which the menu will be located; second argument is the position of the end of that region; it limits the search." (save-excursion (goto-char beginning) (forward-line 1) (re-search-forward "^\\\\node" end t) (beginning-of-line) (point))) ;;; Alists and regular expressions for defining hierarchical levels (defvar latexinfo-section-to-generic-alist '(("top" . "top") ("chapter" . "chapter") ("chapter*" . "chapter") ("unnumbered" . "chapter") ("section" . "section") ("section*" . "section") ("unnumberedsec" . "section") ("subsection" . "subsection") ("subsection*" . "subsection") ("unnumberedsubsec" . "subsection") ("subsubsection" . "subsubsection") ("subsubsection*" . "subsubsection") ("unnumberedsubsubsec" . "subsubsection")) "*An alist of specific and corresponding generic Latexinfo section types. The keys are strings specifying specific types of section; the values are strings of their corresponding general types.") (defvar latexinfo-section-types-regexp "^\\\\\\(chapter\\|section\\|subsection\\|subsubsection\\|unnumbered\\|unnumberedsec\\|unnumberedsubsec\\|unnumberedsubsubsec\\)" "Regexp matching chapter, section, other headings (but not the top node).") (defvar latexinfo-chapter-level-regexp "chapter\\|chapter\\*\\|unnumbered" "Regular expression matching just the Latexinfo chapter level headings.") (defvar latexinfo-section-level-regexp "section\\|section\\*\\|unnumberedsec" "Regular expression matching just the Latexinfo section level headings.") (defvar latexinfo-subsection-level-regexp "subsection\\|subsection\\*\\|unnumberedsubsec" "Regular expression matching just the Latexinfo subsection level headings.") (defvar latexinfo-subsubsection-level-regexp "subsubsection\\|subsubsection\\*\\|unnumberedsubsubsec" "Regular expression matching just the Latexinfo subsubsection level headings.") (defvar latexinfo-update-menu-same-level-regexps '(("top" . "top[ \t{]+") ("chapter" . (concat "\\(^\\\\\\)\\(" latexinfo-chapter-level-regexp "\\)[ \t{]*")) ("section" . (concat "\\(^\\\\\\)\\(" latexinfo-section-level-regexp "\\)[ \t{]*")) ("subsection" . (concat "\\(^\\\\\\)\\(" latexinfo-subsection-level-regexp "\\)[ \t{]*")) ("subsubsection" . (concat "\\(^\\\\\\)\\(" latexinfo-subsubsection-level-regexp "\\)[ \t{]*"))) "*Regexps for searching for same level sections in a Latexinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") (defvar latexinfo-update-menu-higher-regexps '(("top" . "^\\\\node [ \t]*DIR") ("chapter" . "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)") ("section" . (concat "\\(^\\\\\\(" latexinfo-chapter-level-regexp "\\)[ \t{]*\\)")) ("subsection" . (concat "\\(^\\\\\\(" latexinfo-section-level-regexp "\\|" latexinfo-chapter-level-regexp "\\)[ \t{]*\\)")) ("subsubsection" . (concat "\\(^\\\\\\(" latexinfo-subsection-level-regexp "\\|" latexinfo-section-level-regexp "\\|" latexinfo-chapter-level-regexp "\\)[ \t{]*\\)"))) "*Regexps for searching for higher level sections in a Latexinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") (defvar latexinfo-update-menu-lower-regexps '(("top" . (concat "\\(^\\\\\\(" latexinfo-chapter-level-regexp "\\|" latexinfo-section-level-regexp "\\|" latexinfo-subsection-level-regexp "\\|" latexinfo-subsubsection-level-regexp "\\)[ \t{]*\\)")) ("chapter" . (concat "\\(^\\\\\\(" latexinfo-section-level-regexp "\\|" latexinfo-subsection-level-regexp "\\|" latexinfo-subsubsection-level-regexp "\\)[ \t{]*\\)")) ("section" . (concat "\\(^\\\\\\(" latexinfo-subsection-level-regexp "\\|" latexinfo-subsubsection-level-regexp "\\)[ \t{]*\\)")) ("subsection" . (concat "\\(^\\\\\\(" latexinfo-subsubsection-level-regexp "\\)[ \t{]*\\)")) ("subsubsection" . "nothing lower")) "*Regexps for searching for lower level sections in a Latexinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") ;;; Updating a node (defun latexinfo-update-node (&optional region-p) "Without any prefix argument, update the node in which point is located. Non-nil argument (prefix, if interactive) means update the nodes in the marked region. The functions for creating or updating nodes and menus, and their keybindings, are: latexinfo-update-node (&optional region-p) \\[latexinfo-update-node] latexinfo-every-node-update () \\[latexinfo-every-node-update] latexinfo-sequential-node-update (&optional region-p) latexinfo-make-menu (&optional region-p) \\[latexinfo-make-menu] latexinfo-all-menus-update () \\[latexinfo-all-menus-update] latexinfo-master-menu () latexinfo-indent-menu-description (column &optional region-p) The `latexinfo-column-for-description' variable specifies the column to which menu descriptions are indented. Its default value is 32." (interactive "P") (if (not region-p) (let ((auto-fill-hook nil)) ; update a single node (if (not (re-search-backward "^\\\\node" (point-min) t)) (error "Node line not found before this position.")) (latexinfo-update-the-node) (message "Done...updated the node. You may save the buffer.")) ;; else (let ((auto-fill-hook nil) (beginning (region-beginning)) (end (region-end))) (if (= end beginning) (error "Please mark a region!")) (save-restriction (narrow-to-region beginning end) (goto-char beginning) (push-mark) (while (re-search-forward "^\\\\node" (point-max) t) (beginning-of-line) (latexinfo-update-the-node)) (message "Done...updated nodes in region. You may save the buffer."))))) (defun latexinfo-every-node-update () "Update every node in a Latexinfo file." (interactive) (save-excursion (mark-whole-buffer) (latexinfo-update-node t) (message "Done...updated every node. You may save the buffer."))) (defun latexinfo-update-the-node () "Update one node. Point must be at the beginning of node line. Leave point at the end of the node line." (latexinfo-check-for-node-name) (latexinfo-delete-existing-pointers) (message "Updating node: %s ... " (latexinfo-copy-node-name)) (save-restriction (widen) (let* ((case-fold-search t) (level (latexinfo-hierarchic-level)) (beginning (latexinfo-update-menu-region-beginning level)) (end (latexinfo-update-menu-region-end level))) (if (string-equal level "top") (latexinfo-top-pointer-case) ;; else (latexinfo-insert-pointer beginning end level 'next) (latexinfo-insert-pointer beginning end level 'previous) (latexinfo-insert-pointer beginning end level 'up) (latexinfo-clean-up-node-line))))) (defun latexinfo-top-pointer-case () "Insert pointers in the Top node. This is a special case. The `Next' pointer is a pointer to a chapter or section at a lower hierarchical level in the file. The `Previous' and `Up' pointers are to `(dir)'. Point must be at the beginning of the node line, and is left at the end of the node line." (latexinfo-clean-up-node-line) (insert ", " (save-excursion ;; There may be an \chapter or other such command between ;; the top node line and the next node line, as a title ;; for an `ifinfo' section. This \chapter command must ;; must be skipped. So the procedure is to search for ;; the next `\node' line, and then copy its name. (if (re-search-forward "^\\\\node" nil t) (progn (beginning-of-line) (latexinfo-copy-node-name)) " ")) ", (dir), (dir)")) (defun latexinfo-check-for-node-name () "Determine whether the node has a node name. Prompt for one if not. Point must be at beginning of node line. Does not move point." (save-excursion (forward-word 1) ; skip over node command (skip-chars-forward " \t") ; and over spaces (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what info looks for ; alternatively, use "[a-zA-Z]+" (let ((node-name (read-from-minibuffer "Node name: "))) (insert " " node-name))))) (defun latexinfo-delete-existing-pointers () "Delete `Next', `Previous', and `Up' pointers. Starts from the current position of the cursor, and searches forward on the line for a comma and if one is found, deletes the rest of the line, including the comma. Leaves point at beginning of line." (if (search-forward "," (save-excursion (end-of-line) (point)) t) (progn (goto-char (1- (point))) (kill-line nil))) (beginning-of-line)) (defun latexinfo-find-pointer (beginning end level direction) "Move point to section associated with next, previous, or up pointer. Return type of pointer (either 'normal or 'no-pointer). The first and second arguments bound the search for a pointer to the beginning and end, respectively, of the enclosing higher level section. The third argument is a string specifying the general kind of section such as \"chapter\ or \"section\". When looking for the `Next' pointer, the section found will be at the same hierarchical level in the Latexinfo file; when looking for the `Previous' pointer, the section found will be at the same or higher hierarchical level in the Latexinfo file; when looking for the `Up' pointer, the section found will be at some level higher in the Latexinfo file. The fourth argument \(one of 'next, 'previous, or 'up\) specifies whether to find the `Next', `Previous', or `Up' pointer." (cond ((eq direction 'next) (forward-line 3) ; skip over current node (if (re-search-forward (eval (cdr (assoc level latexinfo-update-menu-same-level-regexps))) end t) 'normal 'no-pointer)) ((eq direction 'previous) (if (re-search-backward (concat "\\(" (eval (cdr (assoc level latexinfo-update-menu-same-level-regexps))) "\\|" (eval (cdr (assoc level latexinfo-update-menu-higher-regexps))) "\\)") beginning t) 'normal 'no-pointer)) ((eq direction 'up) (if (re-search-backward (eval (cdr (assoc level latexinfo-update-menu-higher-regexps))) (save-excursion (goto-char beginning) (beginning-of-line) (point)) t) 'normal 'no-pointer)) (t (error "latexinfo-find-pointer: lack proper arguments")))) (defun latexinfo-pointer-name (kind) "Return the node name preceding the section command. The argument is the kind of section, either normal or no-pointer." (let (name) (cond ((eq kind 'normal) (end-of-line) ; this handles prev node top case (re-search-backward ; when point is already "^\\\\node" ; at the beginning of \node line (save-excursion (forward-line -3)) t) (setq name (latexinfo-copy-node-name))) ((eq kind 'no-pointer) (setq name " "))) ; put a blank in the pointer slot name)) (defun latexinfo-insert-pointer (beginning end level direction) "Insert the `Next', `Previous' or `Up' node name at point. Move point forward. The first and second arguments bound the search for a pointer to the beginning and end, respectively, of the enclosing higher level section. The third argument is the hierarchical level of the Latexinfo file, a string such as \"section\". The fourth argument is direction towards which the pointer is directed, one of `next, `previous, or 'up." (end-of-line) (insert ", " (save-excursion (latexinfo-pointer-name (latexinfo-find-pointer beginning end level direction))))) (defun latexinfo-clean-up-node-line () "Remove extra commas, if any, at end of node line." (end-of-line) (skip-chars-backward ", ") (delete-region (point) (save-excursion (end-of-line) (point)))) ;;; Updating nodes sequentially ; These sequential update functions insert `Next' or `Previous' ; pointers that point to the following or preceding nodes even if they ; are at higher or lower hierarchical levels. This means that if a ; section contains one or more subsections, the section's `Next' ; pointer will point to the subsection and not the following section. ; (The subsection to which `Next' points will most likely be the first ; item on the section's menu.) (defun latexinfo-sequential-node-update (&optional region-p) "Update one node (or many) in a Latexinfo file with sequential pointers. This function causes the `Next' or `Previous' pointer to point to the immediately preceding or following node, even if it is at a higher or lower hierarchical level in the document. Continually pressing `n' or `p' takes you straight through the file. Without any prefix argument, update the node in which point is located. Non-nil argument (prefix, if interactive) means update the nodes in the marked region. This command makes it awkward to navigate among sections and subsections; it should be used only for those documents that are meant to be read like a novel rather than a reference, and for which the Info `g*' command is inadequate." (interactive "P") (if (not region-p) (let ((auto-fill-hook nil)) ; update a single node (if (not (re-search-backward "^\\\\node" (point-min) t)) (error "Node line not found before this position.")) (latexinfo-sequentially-update-the-node) (message "Done...sequentially updated the node . You may save the buffer.")) ;; else (let ((auto-fill-hook nil) (beginning (region-beginning)) (end (region-end))) (if (= end beginning) (error "Please mark a region!")) (save-restriction (narrow-to-region beginning end) (goto-char beginning) (push-mark) (while (re-search-forward "^\\\\node" (point-max) t) (beginning-of-line) (latexinfo-sequentially-update-the-node)) (message "Done...updated the nodes in sequence. You may save the buffer."))))) (defun latexinfo-sequentially-update-the-node () "Update one node such that the pointers are sequential. A `Next' or `Previous' pointer points to any preceding or following node, regardless of its hierarchical level." (latexinfo-check-for-node-name) (latexinfo-delete-existing-pointers) (message "Sequentially updating node: %s ... " (latexinfo-copy-node-name)) (save-restriction (widen) (let* ((case-fold-search t) (level (latexinfo-hierarchic-level))) (if (string-equal level "top") (latexinfo-top-pointer-case) ;; else (latexinfo-sequentially-insert-pointer level 'next) (latexinfo-sequentially-insert-pointer level 'previous) (latexinfo-sequentially-insert-pointer level 'up) (latexinfo-clean-up-node-line))))) (defun latexinfo-sequentially-find-pointer (level direction) "Find next or previous pointer sequentially in Latexinfo file, or up pointer. Move point to section associated with the pointer. Find point even if it is in a different section. Return type of pointer (either 'normal or 'no-pointer). The first argument is a string specifying the general kind of section such as \"chapter\ or \"section\". The section found will be at the same hierarchical level in the Latexinfo file, or, in the case of the up pointer, some level higher. The second argument (one of 'next, 'previous, or 'up) specifies whether to find the `Next', `Previous', or `Up' pointer." (cond ((eq direction 'next) (forward-line 3) ; skip over current node (if (re-search-forward latexinfo-section-types-regexp (point-max) t) 'normal 'no-pointer)) ((eq direction 'previous) (if (re-search-backward latexinfo-section-types-regexp (point-min) t) 'normal 'no-pointer)) ((eq direction 'up) (let ((up-level (eval (cdr (assoc level latexinfo-update-menu-higher-regexps))))) (if (null up-level) (message "latexinfo-sequential-find-pointer: null up-level" )) (if (and (stringp up-level) (re-search-backward up-level nil ;; beginning ;; -mike t)) 'normal 'no-pointer))) (t (error "latexinfo-sequential-find-pointer: lack proper arguments")))) (defun latexinfo-sequentially-insert-pointer (level direction) "Insert the `Next', `Previous' or `Up' node name at point. Move point forward. The first argument is the hierarchical level of the Latexinfo file, a string such as \"section\". The second argument is direction, one of `next, `previous, or 'up." (end-of-line) (insert ", " (save-excursion (latexinfo-pointer-name (latexinfo-sequentially-find-pointer level direction))))) ;;; Inserting `\node' lines ; The `latexinfo-insert-node-lines' function inserts `\node' lines as needed ; before the `\chapter', `\section', and such like lines of a region ; in a Latexinfo file. (defun latexinfo-insert-node-lines (beginning end &optional title-p) "Insert missing `\\node' lines in region of Latexinfo file. Non-nil argument (prefix, if interactive) means also to insert the section titles as node names; and also to insert the section titles as node names in pre-existing \\node lines that lack names." (interactive "r\nP") ;; Use marker; after inserting node lines, leave point at end of ;; region and mark at beginning. (let (beginning-marker end-marker title last-section-position) ;; Save current position on mark ring and set mark to end. (push-mark end t) (setq end-marker (mark-marker)) (goto-char beginning) (while (re-search-forward latexinfo-section-types-regexp end-marker 'end) ;; Copy title if desired. (if title-p (setq title (progn (beginning-of-line) (forward-word 1) (skip-chars-forward " \t") (buffer-substring (1+ (point)) (save-excursion (search-forward "," (save-excursion (forward-sexp 1) (1- (point))) 'yes) (point)))) ) ) ;; Insert node line if necessary. (if (re-search-backward "^\\\\node" ;; Avoid finding previous node line if node lines are close. (or last-section-position (save-excursion (forward-line -2) (point))) t) ;; \node is present, and point at beginning of that line (forward-word 1) ; Leave point just after \node. ;; Else \node missing; insert one. (beginning-of-line) ; Beginning of `\section' line. (insert "\\node\n") (backward-char 1)) ; Leave point just after `\node'. ;; Insert title if desired. (if title-p (progn (skip-chars-forward " \t") ;; Use regexp based on what info looks for ;; (alternatively, use "[a-zA-Z]+"); ;; this means we only insert a title if none exists. (if (not (looking-at "[^,\t\n ]+")) (progn (beginning-of-line) (forward-word 1) (insert " " title) (message "Inserted title %s ... " title))))) ;; Go forward beyond current section title. (re-search-forward latexinfo-section-types-regexp (save-excursion (forward-line 3) (point)) t) (setq last-section-position (point)) (forward-line 1)) ;; Leave point at end of region, mark at beginning. (set-mark beginning) (if title-p (message "Done inserting node lines and titles. You may save the buffer.") (message "Done inserting node lines. You may save the buffer.")))) ;;; Update and create menus for multi-file Latexinfo sources ;; 1. M-x latexinfo-multiple-files-update ;; ;; Read the include file list of an outer Latexinfo file and ;; update all highest level nodes in the files listed and insert a ;; main menu in the outer file after its top node. ;; 2. C-u M-x latexinfo-multiple-files-update ;; ;; Same as 1, but insert a master menu. (Saves reupdating lower ;; level menus and nodes.) This command simply reads every menu, ;; so if the menus are wrong, the master menu will be wrong. ;; Similarly, if the lower level node pointers are wrong, they ;; will stay wrong. ;; 3. C-u 2 M-x latexinfo-multiple-files-update ;; ;; Read the include file list of an outer Latexinfo file and ;; update all nodes and menus in the files listed and insert a ;; master menu in the outer file after its top node. ;;; Note: these functions: ;;; ;;; * Do not save or delete any buffers. You may fill up your memory. ;;; * Do not handle any pre-existing nodes in outer file. ;;; Hence, you may need a file for indices. ;;; Auxiliary functions for multiple file updating (defun latexinfo-multi-file-included-list (outer-file) "Return a list of the included files in OUTER-FILE." (let ((included-file-list (list outer-file)) start) (save-excursion (switch-to-buffer (find-file-noselect outer-file)) (widen) (goto-char (point-min)) (while (re-search-forward "^\\\\include" nil t) (skip-chars-forward " \t") (setq start (point)) (end-of-line) (skip-chars-backward " \t") (setq included-file-list (cons (buffer-substring start (point)) included-file-list))) (nreverse included-file-list)))) (defun latexinfo-copy-next-section-title () "Return the name of the immediately following section as a string. Start with point at the beginning of the node line. Leave point at the same place. If there is no title, returns an empty string." (save-excursion (end-of-line) (let ((section-end (or (save-excursion (if (re-search-forward "\\(^\\\\node\\)" nil t) (match-beginning 0))) (point-max)))) (if (re-search-forward latexinfo-section-types-regexp section-end t) (beginning-of-line) ;; copy title (let ((title (buffer-substring (progn (forward-word 1) ; skip over section type (skip-chars-forward " \t") ; and over spaces (point)) (progn (end-of-line) (point))))) title) "")))) (defun latexinfo-multi-file-update (files &optional update-everything) "Update first node pointers in each file in FILES. Return a list of the node names and the title immediate following them. The first file in the list is an outer file; the remaining are files included in the outer file with `\\include' commands. If optional arg UPDATE-EVERYTHING non-nil, update every menu and pointer in each of the included files. Also update the `Top' level node pointers of the outer file. Requirements: * the first file in the FILES list must be the outer file, * each of the included files must contain exactly one highest hierarchical level node, * this node must be the first node in the included file, * each highest hierarchical level node must be of the same type. Thus, normally, each included file contains one, and only one, chapter. The menu-list has the form: \(\(\"node-name1\" . \"title1\"\) \(\"node-name2\" . \"title2\"\) ... \) However, there does not need to be a title field." (let (menu-list) ;; Find the name of the first node of the first included file. (switch-to-buffer (find-file-noselect (car (cdr files)))) (widen) (goto-char (point-min)) (if (not (re-search-forward "^\\\\node" nil t)) (error "No `\\node' line found in %s !" (buffer-name))) (beginning-of-line) (latexinfo-check-for-node-name) (setq next-node-name (latexinfo-copy-node-name)) (setq menu-list (cons (cons next-node-name (latexinfo-copy-next-section-title)) menu-list)) ;; Go to outer file (switch-to-buffer (find-file-noselect (car files))) (goto-char (point-min)) (if (not (re-search-forward "^\\\\node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) (error "This buffer needs a Top node!")) (beginning-of-line) (latexinfo-delete-existing-pointers) (end-of-line) (insert ", " next-node-name ", (dir), (dir)") (beginning-of-line) (setq previous-node-name "Top") (setq files (cdr files)) (while files (if (not (cdr files)) ;; No next file (setq next-node-name "") ;; Else, ;; find the name of the first node in the next file. (switch-to-buffer (find-file-noselect (car (cdr files)))) (widen) (goto-char (point-min)) (if (not (re-search-forward "^\\\\node" nil t)) (error "No `\\node' line found in %s !" (buffer-name))) (beginning-of-line) (latexinfo-check-for-node-name) (setq next-node-name (latexinfo-copy-node-name)) (setq menu-list (cons (cons next-node-name (latexinfo-copy-next-section-title)) menu-list))) ;; Go to node to be updated. (switch-to-buffer (find-file-noselect (car files))) (goto-char (point-min)) (if (not (re-search-forward "^\\\\node" nil t)) (error "No `\\node' line found in %s !" (buffer-name))) (beginning-of-line) ;; Update other menus and nodes if requested. (if update-everything (latexinfo-all-menus-update t)) (beginning-of-line) (latexinfo-delete-existing-pointers) (end-of-line) (insert ", " next-node-name ", " previous-node-name ", " up-node-name) (beginning-of-line) (setq previous-node-name (latexinfo-copy-node-name)) (setq files (cdr files))) (nreverse menu-list))) (defun latexinfo-multi-files-insert-main-menu (menu-list) "Insert formatted main menu at point. Indents the first line of the description, if any, to the value of latexinfo-column-for-description." (insert "\\begin{menu}\n") (while menu-list (if (cdr (car menu-list)) ; menu-list has description entry (progn (insert (format "* %s::" (car (car menu-list)))) ; node-name entry (indent-to latexinfo-column-for-description 2) (insert (format "%s\n" (cdr (car menu-list))))) ; description entry ;; else menu-list lacks description entry (insert (format "* %s::\n" (car (car menu-list))))) ; node-name entry (setq menu-list (cdr menu-list))) (insert "\\end{menu}")) (defun latexinfo-multi-file-master-menu-list (files-list) "Return master menu list from files in FILES-LIST. Menu entries in each file collected using `latexinfo-master-menu-list'. The first file in FILES-LIST must be the outer file; the others must be the files included within it. A main menu must already exist." (save-excursion (let (master-menu-list) (while files-list (switch-to-buffer (find-file-noselect (car files-list))) (message "Working on: %s " (current-buffer)) (goto-char (point-min)) (setq master-menu-list (append master-menu-list (latexinfo-master-menu-list))) (setq files-list (cdr files-list))) master-menu-list))) ;;; The multiple-file update function (defun latexinfo-multiple-files-update (outer-file &optional update-everything make-master-menu) "Update first node pointers in each file included in OUTER-FILE; create or update the `Top' level node pointers and the main menu in the outer file that refers to such nodes. This does not create or update menus or pointers within the included files. With optional MAKE-MASTER-MENU argument (prefix arg, if interactive), insert a master menu in OUTER-FILE in addition to creating or updating pointers in the first \\node line in each included file and creating or updating the `Top' level node pointers of the outer file. This does not create or update other menus and pointers within the included files. With optional UPDATE-EVERYTHING argument (numeric prefix arg, if interactive), update all the menus and all the `Next', `Previous', and `Up' pointers of all the files included in OUTER-FILE before inserting a master menu in OUTER-FILE. Also, update the `Top' level node pointers of OUTER-FILE. Notes: * this command does NOT save any files--you must save the outer file and any modified, included files. * except for the `Top' node, this command does NOT handle any pre-existing nodes in the outer file; hence, indices must be enclosed in an included file. Requirements: * each of the included files must contain exactly one highest hierarchical level node, * this highest node must be the first node in the included file, * each highest hierarchical level node must be of the same type. Thus, normally, each included file contains one, and only one, chapter." (interactive (cons (read-string "Name of outer `include' file: " (buffer-file-name)) (cond ((not current-prefix-arg) '(nil nil)) ((listp current-prefix-arg) '(t nil)) ; make-master-menu ((numberp current-prefix-arg) '(t t)) ; update-everything ))) (let* ((included-file-list (latexinfo-multi-file-included-list outer-file)) (files included-file-list) main-menu-list next-node-name previous-node-name (up-node-name "Top")) ;;; Update the pointers ;;; and collect the names of the nodes and titles (setq main-menu-list (latexinfo-multi-file-update files update-everything)) ;;; Insert main menu ;; Go to outer file (switch-to-buffer (find-file-noselect (car included-file-list))) (if (latexinfo-old-menu-p (point-min) (save-excursion (re-search-forward "^\\include") (beginning-of-line) (point))) ;; If found, leave point after word `menu' on the `\\menu' line. (progn (latexinfo-incorporate-descriptions main-menu-list) ;; Delete existing menu. (beginning-of-line) (delete-region (point) (save-excursion (re-search-forward "^\\\\end{menu}") (point))) ;; Insert main menu (latexinfo-multi-files-insert-main-menu main-menu-list)) ;; Else no current menu; insert it before `\include' (latexinfo-multi-files-insert-main-menu main-menu-list)) ;;; Insert master menu (if make-master-menu (progn ;; First, removing detailed part of any pre-existing master menu (goto-char (point-min)) (if (re-search-forward latexinfo-master-menu-header nil t) ;; Remove detailed master menu listing (progn (goto-char (match-beginning 0)) (let ((end-of-detailed-menu-descriptions (save-excursion ; beginning of end menu line (goto-char (latexinfo-menu-end)) (beginning-of-line) (forward-char -1) (point)))) (delete-region (point) end-of-detailed-menu-descriptions)))) ;; Create a master menu and insert it (latexinfo-insert-master-menu-list (latexinfo-multi-file-master-menu-list included-file-list))))) (message "Multiple files updated.")) ;;; Place `provide' at end of file. (provide 'latexnfo-upd) ;;;;;;;;;;;;;;;; end texnfo-upd.el ;;;;;;;;;;;;;;;;