(defun texinfo-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") (byte-code "Ĉ?  !!){ \" b  U1! \"J  !7` WU \"t  \"p  !]K))+!" [region-p level beginning region-end nil texinfo-hierarchic-level texinfo-make-one-menu message "Done...updated the menu. You may save the buffer." "Making or updating menus in %s... " buffer-name region-beginning error "Please mark a region!" widen texinfo-find-lower-level-node texinfo-find-higher-level-node "Done...updated menus. You may save the buffer."] 22)) (defun texinfo-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." (byte-code " !b `) ! \" b  # \"8! \"\"." [case-fold-search t beginning level end first node-name new-menu-list texinfo-update-menu-region-beginning end-of-line texinfo-update-menu-region-end texinfo-menu-first-node beginning-of-line texinfo-copy-node-name texinfo-make-menu-list texinfo-old-menu-p texinfo-incorporate-descriptions texinfo-delete-old-menu texinfo-insert-menu] 13)) (defun texinfo-all-menus-update (&optional update-all-nodes-p) "\ Update every regular menu in a Texinfo 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." (interactive "P") (byte-code "Ĉ \" #6!b b !`)` \"))M \"! ! \"! ! p \"!!)!*" [case-fold-search t master-menu-p texinfo-master-menu-header nil end-of-detailed-menu-descriptions update-all-nodes-p mark-whole-buffer message "Checking for a master menu in %s ... " buffer-name re-search-forward match-beginning 0 texinfo-menu-end beginning-of-line forward-char -1 delete-region "Updating all nodes in %s ... " sleep-for 2 texinfo-update-node "Updating all menus in %s ... " texinfo-make-menu "Updating the master menu in %s... " texinfo-master-menu "Done...updated all the menus. You may save the buffer."] 25)) (defun texinfo-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." (byte-code "` W \"A!% !#\"!b)" [case-fold-search t region-end level texinfo-update-menu-lower-regexps re-search-forward concat "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)" "\\|" "\\(^@ifinfo[ ]* \\)\\)?" eval assoc texinfo-update-menu-region-end match-beginning 1] 10)) (defun texinfo-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." (byte-code " \" \" # 7 \"A!% #7 )" [case-fold-search t level region-end texinfo-update-menu-higher-regexps string-equal "top" "chapter" re-search-forward "^@node [ ]*top[ ]*\\(,\\|$\\)" beginning-of-line concat "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)" "\\|" "\\(^@ifinfo[ ]* \\)\\)?" eval assoc] 14)) (defun texinfo-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." (byte-code "b \" B B !)" [beginning new-menu-list level end nil texinfo-menu-locate-entry-p texinfo-copy-node-name texinfo-copy-section-title reverse] 6)) (defun texinfo-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." (byte-code " \"A!% #!b)" [case-fold-search t level texinfo-update-menu-same-level-regexps search-end re-search-forward concat "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)" "\\|" "\\(^@ifinfo[ ]* \\)\\)?" eval assoc match-beginning 1] 10)) (defun texinfo-copy-node-name nil "\ 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." (byte-code "!!`NJ `)#`S! `\")" [t buffer-substring forward-word 1 skip-chars-forward " " search-forward "," end-of-line] 9)) (defun texinfo-copy-section-title nil "\ 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 `texinfo-menu-locate-entry-p'." (byte-code "!b!!` `\"" [match-beginning 7 buffer-substring forward-word 1 skip-chars-forward " " end-of-line] 7)) (defun texinfo-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." (byte-code "b #?c!‚Ç" [beginning first nil t re-search-forward "^@menu" goto-end " " forward-line -2] 4)) (defun texinfo-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 texinfo file." (byte-code "  ( @@Q # @ !\") A*" [new-menu-list-pointer new-menu-list end-of-menu t texinfo-menu-end search-forward "* " ":" setcdr texinfo-menu-copy-old-description] 7)) (defun texinfo-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." (byte-code "!!!?'`#! `)\"(̇" [end-of-menu t skip-chars-forward "[:., ]+" looking-at "\\(\\w+\\|@\\)" "\\(^\\* \\|^@end menu\\)" buffer-substring re-search-forward forward-line -1 end-of-line ""] 9)) (defun texinfo-menu-end nil "\ Return position of end of menu. Does not change location of point. Signal an error if not end of menu." (byte-code "# `!)" [nil t re-search-forward "^@end menu" error "Menu does not have an end."] 4)) (defun texinfo-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." (byte-code "\"` \"`)\"" [beginning first re-search-backward "^@menu" delete-region re-search-forward "^@end menu"] 6)) (defvar texinfo-column-for-description 32 "\ *Column at which descriptions start in a Texinfo menu.") (defun texinfo-insert-menu (menu-list node-name) "\ Insert formatted menu at point. Indents the first line of the description, if any, to the value of texinfo-column-for-description. MENU-LIST has form: ((\"node-name1\" . \"description\") (\"node-name\" . \"description\") ... ) However, there does not need to be a description field." (byte-code "c4@A$@@\"c \"@A\"c+@@\"cAc #" [menu-list texinfo-column-for-description level node-name "@menu " format "* %s::" indent-to 2 "%s " "* %s:: " "@end menu" message "Updated \"%s\" level menu following node: %s ... "] 8)) (defun texinfo-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): P") (byte-code "ˆ ?! !!=! b` W+ 9! !\"!))" [region-p column nil widen re-search-forward "^@menu" texinfo-menu-indent-description message "Indented descriptions in menu. You may save the buffer." "Indenting every menu description in region... " region-beginning region-end texinfo-locate-menu-p forward-line 1 "Indenting done. You may save the buffer."] 12)) (defun texinfo-menu-indent-description (to-column-number) "\ Indent the Texinfo 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." (byte-code "` b `)W; #/`!!. `\" !)!`)" [beginning-of-next-line t beginning-white-space to-column-number texinfo-menu-end beginning-of-line search-forward "::" skip-chars-forward " " looking-at "\\(@\\|\\w\\)+" delete-region indent-to-column forward-line 1] 12)) (defun texinfo-master-menu (update-all-nodes-menus-p) "\ Make a master menu for a whole Texinfo 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 `texinfo-master-menu-header'. The master menu has the following format, which is adapted from the recommendation in the Texinfo Manual: * The first part contains the major nodes in the Texinfo 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") (byte-code "ˆ eb#?!!`) #@!b b !`)` \"))h \"! ! \"! ! \"!eb !eb !!bc !! !! )!)" [case-fold-search t nil first-chapter texinfo-master-menu-header end-of-detailed-menu-descriptions update-all-nodes-menus-p widen re-search-forward "^@node [ ]*top[ ]*\\(,\\|$\\)" error "This buffer needs a Top node!" "^@node" match-beginning 0 texinfo-menu-end beginning-of-line forward-char -1 delete-region message "Making a master menu in %s ...first updating all nodes... " buffer-name sleep-for 2 mark-whole-buffer texinfo-update-node "Updating all menus in %s ... " texinfo-make-menu "Now making the master menu in %s... " texinfo-insert-master-menu-list texinfo-master-menu-list " " delete-blank-lines re-search-backward "^@menu" forward-line "^@end menu" 1 "Done...completed making master menu. You may save the buffer."] 36)) (defun texinfo-master-menu-list nil "\ 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." (byte-code "  DB!)" [master-menu-list nil texinfo-locate-menu-p texinfo-copy-menu texinfo-copy-menu-title reverse] 6)) (defun texinfo-insert-master-menu-list (master-menu-list) "\ Format and insert the master menu in the current buffer." (byte-code "eb! `!`)\"c @@!\"9@#A& A c { @A@\" @A@# @@!r@#A_ ABc)" [this-very-menu-list master-menu-list texinfo-master-menu-header re-search-forward "^@menu" beginning-of-line delete-region "^@end menu" " @menu " reverse message "Inserting chapter menu entry: %s ... " insert "* " " " "Inserting menu for %s .... " " " "@end menu "] 16)) (defvar texinfo-master-menu-header " --- The Detailed Node Listing --- " "String inserted before lower level entries in Texinfo master menu. It comes after the chapter-level menu entries.") (defun texinfo-locate-menu-p nil "\ Find the next menu in the texinfo file. If found, leave point after word `menu' on the `@menu' line, and return t. If a menu is not found, do not move point and return nil." (byte-code "#" [nil t re-search-forward "\\(^@menu\\)"] 4)) (defun texinfo-copy-menu-title nil "\ 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." (byte-code " R#$ !!` `\"%))" [case-fold-search t texinfo-section-types-regexp nil re-search-backward "\\(^@top" "\\|" "\\)" beginning-of-line forward-word 1 skip-chars-forward " " buffer-substring end-of-line ""] 8)) (defun texinfo-copy-menu nil "\ 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." (byte-code "  b!`)` W4 #0`#`Z)\"B+" [this-menu-list end-of-menu last-entry t nil texinfo-menu-end re-search-backward "^* " re-search-forward buffer-substring "\\(^* \\|^@e\\)" 3] 10)) (defun texinfo-specific-section-type nil "\ 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." (byte-code "#Ƃ) #& `T!`\")!))" [case-fold-search t nil texinfo-section-types-regexp re-search-forward "^@node [ ]*top[ ]*\\(,\\|$\\)" "top" buffer-substring beginning-of-line forward-word 1 error "texinfo-specific-section-type: Chapter or section not found."] 7)) (defun texinfo-hierarchic-level nil "\ Return the general hierarchal level of the next node in a texinfo file. Thus, a subheading or appendixsubsec is of type subsection." (byte-code " \"A)" [case-fold-search t texinfo-section-to-generic-alist assoc texinfo-specific-section-type] 4)) (defun texinfo-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." (byte-code " \" \"\"eb# `)7 \"A!%#`))" [case-fold-search t level nil texinfo-update-menu-higher-regexps string-equal "top" "chapter" re-search-forward "^@node [ ]*top[ ]*\\(,\\|$\\)" beginning-of-line re-search-backward concat "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)" "\\|" "\\(^@ifinfo[ ]* \\)\\)?" eval assoc goto-beginning] 14)) (defun texinfo-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." (byte-code " \"A!%#!d))" [case-fold-search t level texinfo-update-menu-higher-regexps nil re-search-forward concat "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)" "\\|" "\\(^@ifinfo[ ]* \\)\\)?" eval assoc goto-end match-beginning 1] 10)) (defun texinfo-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." (byte-code "b! # `)" [beginning end t forward-line 1 re-search-forward "^@node" beginning-of-line] 5)) (defvar texinfo-section-to-generic-alist (quote (("top" . "top") ("chapter" . "chapter") ("unnumbered" . "chapter") ("majorheading" . "chapter") ("chapheading" . "chapter") ("appendix" . "chapter") ("section" . "section") ("unnumberedsec" . "section") ("heading" . "section") ("appendixsec" . "section") ("subsection" . "subsection") ("unnumberedsubsec" . "subsection") ("subheading" . "subsection") ("appendixsubsec" . "subsection") ("subsubsection" . "subsubsection") ("unnumberedsubsubsec" . "subsubsection") ("subsubheading" . "subsubsection") ("appendixsubsubsec" . "subsubsection"))) "\ *An alist of specific and corresponding generic Texinfo section types. The keys are strings specifying specific types of section; the values are strings of their corresponding general types.") (defvar texinfo-section-types-regexp "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)" "\ Regexp matching chapter, section, other headings (but not the top node).") (defvar texinfo-chapter-level-regexp "chapter\\|unnumbered \\|appendix \\|majorheading\\|chapheading" "\ Regular expression matching just the Texinfo chapter level headings.") (defvar texinfo-section-level-regexp "section\\|unnumberedsec\\|heading \\|appendixsec" "\ Regular expression matching just the Texinfo section level headings.") (defvar texinfo-subsection-level-regexp "subsection\\|unnumberedsubsec\\|subheading\\|appendixsubsec" "\ Regular expression matching just the Texinfo subsection level headings.") (defvar texinfo-subsubsection-level-regexp "subsubsection\\|unnumberedsubsubsec\\|subsubheading\\|appendixsubsubsec" "\ Regular expression matching just the Texinfo subsubsection level headings.") (defvar texinfo-update-menu-same-level-regexps (quote (("top" . "top[ ]+") ("chapter" concat "\\(^@\\)\\(" texinfo-chapter-level-regexp "\\)[ ]*") ("section" concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)[ ]*") ("subsection" concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)[ ]+") ("subsubsection" concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)[ ]+"))) "\ *Regexps for searching for same level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") (defvar texinfo-update-menu-higher-regexps (quote (("top" . "^@node [ ]*DIR") ("chapter" . "^@node [ ]*top[ ]*\\(,\\|$\\)") ("section" concat "\\(^@\\(" texinfo-chapter-level-regexp "\\)[ ]*\\)") ("subsection" concat "\\(^@\\(" texinfo-section-level-regexp "\\|" texinfo-chapter-level-regexp "\\)[ ]*\\)") ("subsubsection" concat "\\(^@\\(" texinfo-subsection-level-regexp "\\|" texinfo-section-level-regexp "\\|" texinfo-chapter-level-regexp "\\)[ ]*\\)"))) "\ *Regexps for searching for higher level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") (defvar texinfo-update-menu-lower-regexps (quote (("top" concat "\\(^@\\(" texinfo-chapter-level-regexp "\\|" texinfo-section-level-regexp "\\|" texinfo-subsection-level-regexp "\\|" texinfo-subsubsection-level-regexp "\\)[ ]*\\)") ("chapter" concat "\\(^@\\(" texinfo-section-level-regexp "\\|" texinfo-subsection-level-regexp "\\|" texinfo-subsubsection-level-regexp "\\)[ ]*\\)") ("section" concat "\\(^@\\(" texinfo-subsection-level-regexp "\\|" texinfo-subsubsection-level-regexp "\\)[ ]+\\)") ("subsection" concat "\\(^@\\(" texinfo-subsubsection-level-regexp "\\)[ ]+\\)") ("subsubsection" . "nothing lower"))) "\ *Regexps for searching for lower level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") (defun texinfo-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: texinfo-update-node (&optional region-p) \\[texinfo-update-node] texinfo-every-node-update () \\[texinfo-every-node-update] texinfo-sequential-node-update (&optional region-p) texinfo-make-menu (&optional region-p) \\[texinfo-make-menu] texinfo-all-menus-update () \\[texinfo-all-menus-update] texinfo-master-menu () texinfo-indent-menu-description (column &optional region-p) The `texinfo-column-for-description' variable specifies the column to which menu descriptions are indented. Its default value is 32." (interactive "P") (byte-code "ˆ? e#?! !)U  U1! \" b d#O >!)+" [region-p auto-fill-hook nil t beginning end re-search-backward "^@node" error "Node line not found before this position." texinfo-update-the-node message "Done...updated the node. You may save the buffer." region-beginning region-end "Please mark a region!" narrow-to-region push-mark re-search-forward beginning-of-line "Done...updated nodes in region. You may save the buffer."] 14)) (defun texinfo-every-node-update nil "\ Update every node in a Texinfo file." (interactive) (byte-code " !!)" [t nil mark-whole-buffer texinfo-update-node message "Done...updated every node. You may save the buffer."] 4)) (defun texinfo-update-the-node nil "\ Update one node. Point must be at the beginning of node line. Leave point at the end of the node line." (byte-code " \"   ! ! \") @ $ $ $ ,)" [case-fold-search t level beginning end texinfo-check-for-node-name texinfo-delete-existing-pointers message "Updating node: %s ... " texinfo-copy-node-name widen texinfo-hierarchic-level texinfo-update-menu-region-beginning texinfo-update-menu-region-end string-equal "top" texinfo-top-pointer-case texinfo-insert-pointer next previous up texinfo-clean-up-node-line] 17)) (defun texinfo-top-pointer-case nil "\ 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." (byte-code " Ċ# )#" [nil t texinfo-clean-up-node-line insert ", " re-search-forward "^@node" beginning-of-line texinfo-copy-node-name " " ", (dir), (dir)"] 8)) (defun texinfo-check-for-node-name nil "\ 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." (byte-code "!!!?!\"))" [node-name forward-word 1 skip-chars-forward " " looking-at "[^, ]+" read-from-minibuffer "Node name: " insert " "] 7)) (defun texinfo-delete-existing-pointers nil "\ 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." (byte-code "Ê `)#`Sb! " [t nil search-forward "," end-of-line kill-line beginning-of-line] 5)) (defun texinfo-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 Texinfo file; when looking for the `Previous' pointer, the section found will be at the same or higher hierarchical level in the Texinfo file; when looking for the `Up' pointer, the section found will be at some level higher in the Texinfo file. The fourth argument (one of 'next, 'previous, or 'up) specifies whether to find the `Next', `Previous', or `Up' pointer." (byte-code " =%! \"A!Q #!Ђ\"т =V \"A! \"A!& #RЂSт = \"A!&b `)#Ђт!)" [case-fold-search t direction level texinfo-update-menu-same-level-regexps end texinfo-update-menu-higher-regexps beginning next forward-line 3 re-search-forward "\\(^@node\\).* " "\\(\\(\\(^@c\\).* \\)\\|\\(^@ifinfo[ ]* \\)\\)?" eval assoc normal no-pointer previous re-search-backward concat "\\(" "\\|" "^@node [ ]*top[ ]*\\(,\\|$\\)" "\\)" up beginning-of-line error "texinfo-find-pointer: lack proper arguments"] 21)) (defun texinfo-pointer-name (kind) "\ Return the node name preceding the section command. The argument is the kind of section, either normal or no-pointer." (byte-code " = NJ!)# % =%̉)" [name kind t nil normal end-of-line re-search-backward "^@node" forward-line -3 texinfo-copy-node-name no-pointer " "] 6)) (defun texinfo-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 Texinfo file, a string such as \"section\". The fourth argument is direction towards which the pointer is directed, one of `next, `previous, or 'up." (byte-code " Ɗ $!)\"" [beginning end level direction end-of-line insert ", " texinfo-pointer-name texinfo-find-pointer] 9)) (defun texinfo-clean-up-node-line nil "\ Remove extra commas, if any, at end of node line." (byte-code " !` `)\"" [end-of-line skip-chars-backward ", " delete-region] 6)) (defun texinfo-sequential-node-update (&optional region-p) "\ Update one node (or many) in a Texinfo 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") (byte-code "ˆ? e#?! !)U  U1! \" b d#O >!)+" [region-p auto-fill-hook nil t beginning end re-search-backward "^@node" error "Node line not found before this position." texinfo-sequentially-update-the-node message "Done...sequentially updated the node . You may save the buffer." region-beginning region-end "Please mark a region!" narrow-to-region push-mark re-search-forward beginning-of-line "Done...updated the nodes in sequence. You may save the buffer."] 14)) (defun texinfo-sequentially-update-the-node nil "\ 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." (byte-code " \"   \"! 2 \" \" \" *)" [case-fold-search t level texinfo-check-for-node-name texinfo-delete-existing-pointers message "Sequentially updating node: %s ... " texinfo-copy-node-name widen texinfo-hierarchic-level string-equal "top" texinfo-top-pointer-case texinfo-sequentially-insert-pointer next previous up texinfo-clean-up-node-line] 13)) (defun texinfo-sequentially-find-pointer (level direction) "\ Find next or previous pointer sequentially in Texinfo 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 Texinfo 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." (byte-code " =! d#˂̂R =2 e#.˂/̂R =O \"A!#K˂L̂R!)" [case-fold-search t direction texinfo-section-types-regexp level texinfo-update-menu-higher-regexps beginning next forward-line 3 re-search-forward normal no-pointer previous re-search-backward up eval assoc error "texinfo-sequential-find-pointer: lack proper arguments"] 9)) (defun texinfo-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 Texinfo file, a string such as \"section\". The second argument is direction, one of `next, `previous, or 'up." (byte-code " Ċ \"!)\"" [level direction end-of-line insert ", " texinfo-pointer-name texinfo-sequentially-find-pointer] 7)) (defun texinfo-insert-node-lines (beginning end &optional title-p) "\ Insert missing `@node' lines in region of Texinfo 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 P") (byte-code "Ɉ \" b #< !!` `)\" J!`)#U!^ c!!!? ! \" \"!`)#`!!!!," [beginning-marker end-marker title last-section-position end t beginning texinfo-section-types-regexp title-p nil push-mark mark-marker re-search-forward beginning-of-line forward-word 1 skip-chars-forward " " buffer-substring end-of-line re-search-backward "^@node" forward-line -2 "@node " backward-char looking-at "[^, ]+" insert " " message "Inserted title %s ... " 3 set-mark "Done inserting node lines and titles. You may save the buffer." "Done inserting node lines. You may save the buffer."] 26)) (defun texinfo-multi-file-included-list (outer-file) "\ Return a list of the included files in OUTER-FILE." (byte-code " C !! eb#5!` ! `\"B!)*" [included-file-list outer-file start nil t switch-to-buffer find-file-noselect widen re-search-forward "^@include" skip-chars-forward " " end-of-line skip-chars-backward buffer-substring nreverse] 11)) (defun texinfo-copy-next-section-title nil "\ 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." (byte-code " #!)d ## 7!!` `\" )))" [section-end nil t texinfo-section-types-regexp title end-of-line re-search-forward "\\(^@node\\)" match-beginning 0 beginning-of-line buffer-substring forward-word 1 skip-chars-forward " " ""] 11)) (defun texinfo-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." (byte-code " A@!! eb#? \"  B B @!!eb#?K! # ܉ A A?x݉ A@!! eb#? \"  B B @!!eb#? \" ! &  Ah !*" [case-fold-search t menu-list files nil next-node-name previous-node-name update-everything up-node-name switch-to-buffer find-file-noselect widen re-search-forward "^@node" error "No `@node' line found in %s !" buffer-name beginning-of-line texinfo-check-for-node-name texinfo-copy-node-name texinfo-copy-next-section-title "^@node [ ]*top[ ]*\\(,\\|$\\)" "This buffer needs a Top node!" texinfo-delete-existing-pointers end-of-line insert ", " ", (dir), (dir)" "Top" "" texinfo-all-menus-update nreverse] 47)) (defun texinfo-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 texinfo-column-for-description." (byte-code "c4@A$@@\"c \"@A\"c+@@\"cAc" [menu-list texinfo-column-for-description "@menu " format "* %s::" indent-to 2 "%s " "* %s:: " "@end menu"] 7)) (defun texinfo-multi-file-master-menu-list (files-list) "\ Return master menu list from files in FILES-LIST. Menu entries in each file collected using `texinfo-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." (byte-code " & @!!p\"eb \" A))" [master-menu-list files-list nil switch-to-buffer find-file-noselect message "Working on: %s " append texinfo-master-menu-list] 8)) (defun texinfo-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 (byte-code " \"?Ă<ł!B" [current-prefix-arg read-string "Name of outer `include' file: " buffer-file-name (nil nil) (t nil) numberp (t t)] 5)) (byte-code "ˈ !  \" @!!e! `)\"I ! `!`)\" !L ! eb #y!b b !`) ` \") !!.!" [current-prefix-arg included-file-list outer-file files main-menu-list next-node-name previous-node-name up-node-name update-everything make-master-menu texinfo-master-menu-header nil t end-of-detailed-menu-descriptions texinfo-multi-file-included-list "Top" texinfo-multi-file-update switch-to-buffer find-file-noselect texinfo-old-menu-p re-search-forward "^@include" beginning-of-line texinfo-incorporate-descriptions delete-region "^@end menu" texinfo-multi-files-insert-main-menu match-beginning 0 texinfo-menu-end forward-char -1 texinfo-insert-master-menu-list texinfo-multi-file-master-menu-list message "Multiple files updated."] 23)) (provide (quote texnfo-upd))