home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / lisp / packages / texinfmt.el < prev    next >
Encoding:
Text File  |  1995-08-08  |  113.0 KB  |  3,069 lines
  1. ;;;; texinfmt.el
  2. ;;; Copyright (C) 1985, 1986, 1988, 1990, 1991,
  3. ;;;               1992, 1993, 1994, 1995  Free Software Foundation, Inc.
  4.  
  5. ;; Maintainer: Robert J. Chassell <bug-texinfo@prep.ai.mit.edu>
  6.  
  7. ;;; This file is part of GNU Emacs.
  8.  
  9. ;; GNU Emacs is free software; you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation; either version 2, or (at your option)
  12. ;; any later version.
  13.  
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17. ;; GNU General Public License for more details.
  18.  
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22.  
  23. ;;; Code:
  24.  
  25. ;;; Emacs lisp functions to convert Texinfo files to Info files.
  26.  
  27. (defvar texinfmt-version "2.34 of 7 June 1995")
  28.  
  29. ;;; Variable definitions
  30.  
  31. (require 'texinfo)          ; So `texinfo-footnote-style' is defined.
  32. (require 'texnfo-upd)       ; So `texinfo-section-types-regexp' is defined.
  33.  
  34. (defvar texinfo-format-syntax-table nil)
  35.  
  36. (defvar texinfo-vindex)
  37. (defvar texinfo-findex)
  38. (defvar texinfo-cindex)
  39. (defvar texinfo-pindex)
  40. (defvar texinfo-tindex)
  41. (defvar texinfo-kindex)
  42. (defvar texinfo-last-node)
  43. (defvar texinfo-node-names)
  44. (defvar texinfo-enclosure-list)
  45. (defvar texinfo-alias-list)
  46.  
  47. (defvar texinfo-command-start)
  48. (defvar texinfo-command-end)
  49. (defvar texinfo-command-name)
  50. (defvar texinfo-defun-type)
  51. (defvar texinfo-last-node-pos)
  52. (defvar texinfo-stack)
  53. (defvar texinfo-short-index-cmds-alist)
  54. (defvar texinfo-short-index-format-cmds-alist)
  55. (defvar texinfo-format-filename)
  56. (defvar texinfo-footnote-number)
  57. (defvar texinfo-start-of-header)
  58. (defvar texinfo-end-of-header)
  59. (defvar texinfo-raisesections-alist)
  60. (defvar texinfo-lowersections-alist)
  61.  
  62. ;;; Syntax table
  63.  
  64. (if texinfo-format-syntax-table
  65.     nil
  66.   (setq texinfo-format-syntax-table (make-syntax-table))
  67.   (modify-syntax-entry ?\" " " texinfo-format-syntax-table)
  68.   (modify-syntax-entry ?\\ " " texinfo-format-syntax-table)
  69.   (modify-syntax-entry ?@ "\\" texinfo-format-syntax-table)
  70.   (modify-syntax-entry ?\^q "\\" texinfo-format-syntax-table)
  71.   (modify-syntax-entry ?\[ "." texinfo-format-syntax-table)
  72.   (modify-syntax-entry ?\] "." texinfo-format-syntax-table)
  73.   (modify-syntax-entry ?\( "." texinfo-format-syntax-table)
  74.   (modify-syntax-entry ?\) "." texinfo-format-syntax-table)
  75.   (modify-syntax-entry ?{ "(}" texinfo-format-syntax-table)
  76.   (modify-syntax-entry ?} "){" texinfo-format-syntax-table)
  77.   (modify-syntax-entry ?\' "." texinfo-format-syntax-table))
  78.  
  79.  
  80. ;;; Top level buffer and region formatting functions
  81.  
  82. ;;;###autoload
  83. (defun texinfo-format-buffer (&optional notagify)
  84.   "Process the current buffer as texinfo code, into an Info file.
  85. The Info file output is generated in a buffer visiting the Info file
  86. names specified in the @setfilename command.
  87.  
  88. Non-nil argument (prefix, if interactive) means don't make tag table
  89. and don't split the file if large.  You can use Info-tagify and
  90. Info-split to do these manually."
  91.   (interactive "P")
  92.   (let ((lastmessage "Formatting Info file..."))
  93.     (message lastmessage)
  94.     (texinfo-format-buffer-1)
  95.     (if notagify
  96.         nil
  97.       (if (> (buffer-size) 30000)
  98.           (progn
  99.             (message (setq lastmessage "Making tags table for Info file..."))
  100.             (Info-tagify)))
  101.       (if (> (buffer-size) 100000)
  102.           (progn
  103.             (message (setq lastmessage "Splitting Info file..."))
  104.             (Info-split))))
  105.     (message (concat lastmessage
  106.                      (if (interactive-p) "done.  Now save it." "done.")))))
  107.  
  108. (defvar texinfo-region-buffer-name "*Info Region*"
  109.   "*Name of the temporary buffer used by \\[texinfo-format-region].")
  110.  
  111. ;;;###autoload
  112. (defun texinfo-format-region (region-beginning region-end)
  113.   "Convert the current region of the Texinfo file to Info format.
  114. This lets you see what that part of the file will look like in Info.
  115. The command is bound to \\[texinfo-format-region].  The text that is
  116. converted to Info is stored in a temporary buffer."
  117.   (interactive "r")
  118.   (message "Converting region to Info format...")
  119.   (let (texinfo-command-start
  120.         texinfo-command-end
  121.         texinfo-command-name
  122.         texinfo-vindex
  123.         texinfo-findex
  124.         texinfo-cindex
  125.         texinfo-pindex
  126.         texinfo-tindex
  127.         texinfo-kindex
  128.         texinfo-stack
  129.         (texinfo-format-filename "")
  130.         texinfo-example-start
  131.         texinfo-last-node-pos
  132.         texinfo-last-node
  133.         texinfo-node-names
  134.         (texinfo-footnote-number 0)
  135.         last-input-buffer
  136.         (fill-column-for-info fill-column)
  137.         (input-buffer (current-buffer))
  138.         (input-directory default-directory)
  139.         (header-text "")
  140.         (header-beginning 1)
  141.         (header-end 1))
  142.     
  143. ;;; Copy lines between beginning and end of header lines, 
  144. ;;;    if any, or else copy the `@setfilename' line, if any.
  145.     (save-excursion
  146.         (save-restriction
  147.           (widen)
  148.           (goto-char (point-min))
  149.           (let ((search-end (save-excursion (forward-line 100) (point))))
  150.             (if (or
  151.                  ;; Either copy header text.
  152.                  (and 
  153.                   (prog1 
  154.                       (search-forward tex-start-of-header search-end t)
  155.                     (forward-line 1)
  156.                     ;; Mark beginning of header.
  157.                     (setq header-beginning (point)))
  158.                   (prog1 
  159.                       (search-forward tex-end-of-header nil t)
  160.                     (beginning-of-line)
  161.                     ;; Mark end of header
  162.                     (setq header-end (point))))
  163.                  ;; Or copy @filename line.
  164.                  (prog2
  165.                   (goto-char (point-min))
  166.                   (search-forward "@setfilename" search-end t)
  167.                   (beginning-of-line)
  168.                   (setq header-beginning (point))
  169.                   (forward-line 1)
  170.                   (setq header-end (point))))
  171.                 
  172.                 ;; Copy header  
  173.                 (setq header-text
  174.                       (buffer-substring
  175.                        (min header-beginning region-beginning)
  176.                        header-end))))))
  177.  
  178. ;;; Find a buffer to use.
  179.     (switch-to-buffer (get-buffer-create texinfo-region-buffer-name))
  180.     (erase-buffer)
  181.     ;; Insert the header into the buffer.
  182.     (insert header-text)
  183.     ;; Insert the region into the buffer.
  184.     (insert-buffer-substring
  185.      input-buffer
  186.      (max region-beginning header-end)
  187.      region-end)
  188.     ;; Make sure region ends in a newline.
  189.     (or (= (preceding-char) ?\n)
  190.         (insert "\n"))
  191.     
  192.     (goto-char (point-min))
  193.     (texinfo-mode)
  194.     (message "Converting region to Info format...")
  195.     (setq fill-column fill-column-for-info)
  196.     ;; Install a syntax table useful for scanning command operands.
  197.     (set-syntax-table texinfo-format-syntax-table)
  198.  
  199.     ;; Insert @include files so `texinfo-raise-lower-sections' can
  200.     ;; work on them without losing track of multiple
  201.     ;; @raise/@lowersections commands. 
  202.     (while (re-search-forward "^@include" nil t)
  203.       (setq texinfo-command-end (point))
  204.       (let ((filename (concat input-directory
  205.                               (texinfo-parse-line-arg))))
  206.         (re-search-backward "^@include")
  207.         (delete-region (point) (save-excursion (forward-line 1) (point)))
  208.         (message "Reading included file: %s" filename)
  209.         (save-excursion
  210.           (save-restriction
  211.             (narrow-to-region
  212.              (point)
  213.              (+ (point) (car (cdr (insert-file-contents filename)))))
  214.             (goto-char (point-min))
  215.             ;; Remove `@setfilename' line from included file, if any,
  216.             ;; so @setfilename command not duplicated.
  217.             (if (re-search-forward 
  218.                  "^@setfilename" (save-excursion (forward-line 100) (point)) t)
  219.                 (progn
  220.                   (beginning-of-line)
  221.                   (delete-region
  222.                    (point) (save-excursion (forward-line 1) (point)))))))))
  223.  
  224.     ;; Raise or lower level of each section, if necessary.
  225.     (goto-char (point-min))
  226.     (texinfo-raise-lower-sections)
  227.     ;; Append @refill to appropriate paragraphs for filling.
  228.     (goto-char (point-min))
  229.     (texinfo-append-refill)
  230.     ;; If the region includes the effective end of the data,
  231.     ;; discard everything after that.
  232.     (goto-char (point-max))
  233.     (if (re-search-backward "^@bye" nil t)
  234.         (delete-region (point) (point-max)))
  235.     ;; Make sure buffer ends in a newline.
  236.     (or (= (preceding-char) ?\n)
  237.         (insert "\n"))
  238.     ;; Don't use a previous value of texinfo-enclosure-list.
  239.     (setq texinfo-enclosure-list nil)
  240.     (setq texinfo-alias-list nil)
  241.  
  242.     (goto-char (point-min))
  243.     (if (looking-at "\\\\input[ \t]+texinfo")
  244.         (delete-region (point) (save-excursion (forward-line 1) (point))))
  245.  
  246.     ;; Insert Info region title text.
  247.     (goto-char (point-min))
  248.     (if (search-forward 
  249.          "@setfilename" (save-excursion (forward-line 100) (point)) t)
  250.         (progn
  251.           (setq texinfo-command-end (point))
  252.           (beginning-of-line)
  253.           (setq texinfo-command-start (point))
  254.           (let ((arg (texinfo-parse-arg-discard)))
  255.             (insert " "
  256.               texinfo-region-buffer-name
  257.               " buffer for:  `") 
  258.             (insert (file-name-nondirectory (expand-file-name arg)))
  259.             (insert "',        -*-Text-*-\n")))
  260.       ;; Else no `@setfilename' line
  261.       (insert " "
  262.               texinfo-region-buffer-name
  263.               " buffer                       -*-Text-*-\n"))
  264.     (insert "produced by `texinfo-format-region'\n"
  265.             "from a region in: "
  266.             (if (buffer-file-name input-buffer)
  267.                   (concat "`"
  268.                           (file-name-sans-versions
  269.                            (file-name-nondirectory
  270.                             (buffer-file-name input-buffer)))
  271.                           "'")
  272.                 (concat "buffer `" (buffer-name input-buffer) "'"))
  273.               "\nusing `texinfmt.el' version "
  274.               texinfmt-version
  275.               ".\n\n")
  276.  
  277.     ;; Now convert for real.
  278.     (goto-char (point-min))
  279.     (texinfo-format-scan)
  280.     (goto-char (point-min))
  281.     
  282.     (message "Done.")))
  283.  
  284.  
  285. ;;; Primary internal formatting function for the whole buffer.
  286.  
  287. (defun texinfo-format-buffer-1 ()
  288.   (let (texinfo-format-filename
  289.         texinfo-example-start
  290.         texinfo-command-start
  291.         texinfo-command-end
  292.         texinfo-command-name
  293.         texinfo-last-node
  294.         texinfo-last-node-pos
  295.         texinfo-vindex
  296.         texinfo-findex
  297.         texinfo-cindex
  298.         texinfo-pindex
  299.         texinfo-tindex
  300.         texinfo-kindex
  301.         texinfo-stack
  302.         texinfo-node-names
  303.         (texinfo-footnote-number 0)
  304.         last-input-buffer
  305.         outfile
  306.         (fill-column-for-info fill-column)
  307.         (input-buffer (current-buffer))
  308.         (input-directory default-directory))
  309.     (setq texinfo-enclosure-list nil)
  310.     (setq texinfo-alias-list nil)
  311.     (save-excursion
  312.       (goto-char (point-min))
  313.       (or (search-forward "@setfilename" nil t)
  314.           (error "Texinfo file needs an `@setfilename FILENAME' line."))
  315.       (setq texinfo-command-end (point))
  316.       (setq outfile (texinfo-parse-line-arg)))
  317.     (find-file outfile)
  318.     (texinfo-mode)
  319.     (setq fill-column fill-column-for-info)
  320.     (set-syntax-table texinfo-format-syntax-table)
  321.     (erase-buffer)
  322.     (insert-buffer-substring input-buffer)
  323.     (message "Converting %s to Info format..." (buffer-name input-buffer))
  324.     
  325.     ;; Insert @include files so `texinfo-raise-lower-sections' can
  326.     ;; work on them without losing track of multiple
  327.     ;; @raise/@lowersections commands. 
  328.     (goto-char (point-min))
  329.     (while (re-search-forward "^@include" nil t)
  330.       (setq texinfo-command-end (point))
  331.       (let ((filename (concat input-directory
  332.                               (texinfo-parse-line-arg))))
  333.         (re-search-backward "^@include")
  334.         (delete-region (point) (save-excursion (forward-line 1) (point)))
  335.         (message "Reading included file: %s" filename)
  336.         (save-excursion
  337.           (save-restriction
  338.             (narrow-to-region
  339.              (point)
  340.              (+ (point) (car (cdr (insert-file-contents filename)))))
  341.             (goto-char (point-min))
  342.             ;; Remove `@setfilename' line from included file, if any,
  343.             ;; so @setfilename command not duplicated.
  344.             (if (re-search-forward 
  345.                  "^@setfilename"
  346.                  (save-excursion (forward-line 100) (point)) t)
  347.                 (progn
  348.                   (beginning-of-line)
  349.                   (delete-region
  350.                    (point) (save-excursion (forward-line 1) (point)))))))))
  351.     ;; Raise or lower level of each section, if necessary.
  352.     (goto-char (point-min))
  353.     (texinfo-raise-lower-sections)
  354.     ;; Append @refill to appropriate paragraphs
  355.     (goto-char (point-min))
  356.     (texinfo-append-refill)
  357.     (goto-char (point-min))
  358.     (search-forward "@setfilename")
  359.     (beginning-of-line)
  360.     (delete-region (point-min) (point))
  361.     ;; Remove @bye at end of file, if it is there.
  362.     (goto-char (point-max))
  363.     (if (search-backward "@bye" nil t)
  364.         (delete-region (point) (point-max)))
  365.     ;; Make sure buffer ends in a newline.
  366.     (or (= (preceding-char) ?\n)
  367.         (insert "\n"))
  368.     ;; Scan the whole buffer, converting to Info format.
  369.     (texinfo-format-scan)
  370.     ;; Return data for indices.
  371.     (goto-char (point-min))
  372.     (list outfile
  373.           texinfo-vindex texinfo-findex texinfo-cindex
  374.           texinfo-pindex texinfo-tindex texinfo-kindex)))
  375.  
  376.  
  377. ;;; Perform non-@-command file conversions: quotes and hyphens
  378.  
  379. (defun texinfo-format-convert (min max)
  380.   ;; Convert left and right quotes to typewriter font quotes.
  381.   (goto-char min)
  382.   (while (search-forward "``" max t)
  383.     (replace-match "\""))
  384.   (goto-char min)
  385.   (while (search-forward "''" max t)
  386.     (replace-match "\""))
  387.   ;; Convert three hyphens in a row to two.
  388.   (goto-char min)
  389.   (while (re-search-forward "\\( \\|\\w\\)\\(---\\)\\( \\|\\w\\)" max t)
  390.     (delete-region (1+ (match-beginning 2)) (+ 2 (match-beginning
  391.     2)))))
  392.  
  393.  
  394. ;;; Handle paragraph filling
  395.  
  396. (defvar texinfo-no-refill-regexp
  397.   "^@\\(example\\|smallexample\\|lisp\\|smalllisp\\|display\\|format\\|flushleft\\|flushright\\|menu\\|titlepage\\|iftex\\|ifhtml\\|tex\\|html\\)"
  398.   "Regexp specifying environments in which paragraphs are not filled.")
  399.  
  400. (defvar texinfo-part-of-para-regexp
  401.   "^@\\(b{\\|bullet{\\|cite{\\|code{\\|emph{\\|equiv{\\|error{\\|expansion{\\|file{\\|i{\\|inforef{\\|kbd{\\|key{\\|lisp{\\|minus{\\|point{\\|print{\\|pxref{\\|r{\\|ref{\\|result{\\|samp{\\|sc{\\|t{\\|TeX{\\|today{\\|var{\\|w{\\|xref{\\)"
  402.   "Regexp specifying @-commands found within paragraphs.")
  403.  
  404. (defun texinfo-append-refill ()
  405.   "Append @refill at end of each paragraph that should be filled.
  406. Do not append @refill to paragraphs within @example and similar environments.  
  407. Do not append @refill to paragraphs containing @w{TEXT} or @*."
  408.  
  409.   ;; It is necessary to append @refill before other processing because
  410.   ;; the other processing removes information that tells Texinfo
  411.   ;; whether the text should or should not be filled.
  412.   
  413.   (while (< (point) (point-max))
  414.     (let ((refill-blank-lines "^[ \t\n]*$")
  415.           (case-fold-search nil))       ; Don't confuse @TeX and @tex....
  416.       (beginning-of-line)
  417.       ;; 1. Skip over blank lines;
  418.       ;;    skip over lines beginning with @-commands, 
  419.       ;;    but do not skip over lines
  420.       ;;      that are no-refill environments such as @example or
  421.       ;;      that begin with within-paragraph @-commands such as @code.
  422.       (while (and (looking-at (concat "^@\\|^\\\\\\|" refill-blank-lines))
  423.                   (not (looking-at 
  424.                         (concat
  425.                          "\\(" 
  426.                          texinfo-no-refill-regexp
  427.                          "\\|" 
  428.                          texinfo-part-of-para-regexp
  429.                          "\\)")))
  430.                   (< (point) (point-max)))
  431.         (forward-line 1))
  432.       ;; 2. Skip over @example and similar no-refill environments.
  433.       (if (looking-at texinfo-no-refill-regexp)
  434.           (let ((environment
  435.                  (buffer-substring (match-beginning 1) (match-end 1))))
  436.             (progn (re-search-forward (concat "^@end " environment) nil t)
  437.                    (forward-line 1)))
  438.         ;; 3. Do not refill a paragraph containing @w or @*
  439.         (if  (or
  440.               (>= (point) (point-max))
  441.               (re-search-forward
  442.                "@w{\\|@\\*" (save-excursion (forward-paragraph) (point)) t))
  443.             ;; Go to end of paragraph and do nothing.
  444.             (forward-paragraph) 
  445.           ;; 4. Else go to end of paragraph and insert @refill
  446.           (forward-paragraph)
  447.           (forward-line -1)
  448.           (end-of-line)
  449.           (delete-region
  450.            (point)
  451.            (save-excursion (skip-chars-backward " \t") (point)))
  452.           ;; `looking-at-backward' not available in v. 18.57
  453.           ;; (if (not (looking-at-backward "@refill\\|@bye")) ;)
  454.           (if (not (re-search-backward
  455.                     "@refill\\|@bye"
  456.                     (save-excursion (beginning-of-line) (point))
  457.                     t))
  458.               (insert "@refill"))
  459.           (forward-line 1))))))
  460.  
  461.  
  462. ;;; Handle `@raisesections' and `@lowersections' commands
  463.  
  464. ;; These commands change the hierarchical level of chapter structuring
  465. ;; commands. 
  466. ;;    
  467. ;; @raisesections changes @subsection to @section,
  468. ;;                        @section    to @chapter,
  469. ;;                        etc.
  470. ;;
  471. ;; @lowersections changes @chapter    to @section
  472. ;;                        @subsection to @subsubsection,
  473. ;;                        etc.
  474. ;;
  475. ;; An @raisesections/@lowersections command changes only those
  476. ;; structuring commands that follow the @raisesections/@lowersections
  477. ;; command.
  478. ;;
  479. ;; Repeated @raisesections/@lowersections continue to raise or lower
  480. ;; the heading level.
  481. ;; 
  482. ;; An @lowersections command cancels an @raisesections command, and
  483. ;; vice versa.
  484. ;;
  485. ;; You cannot raise or lower "beyond" chapters or subsubsections, but
  486. ;; trying to do so does not elicit an error---you just get more
  487. ;; headings that mean the same thing as you keep raising or lowering
  488. ;; (for example, after a single @raisesections, both @chapter and
  489. ;; @section produce chapter headings).
  490.  
  491. (defun texinfo-raise-lower-sections ()
  492.   "Raise or lower the hierarchical level of chapters, sections, etc. 
  493.  
  494. This function acts according to `@raisesections' and `@lowersections'
  495. commands in the Texinfo file.
  496.  
  497. For example, an `@lowersections' command is useful if you wish to
  498. include what is written as an outer or standalone Texinfo file in
  499. another Texinfo file as an inner, included file.  The `@lowersections'
  500. command changes chapters to sections, sections to subsections and so
  501. on.
  502.  
  503. @raisesections changes @subsection to @section,
  504.                        @section    to @chapter,
  505.                        @heading    to @chapheading,
  506.                        etc.
  507.  
  508. @lowersections changes @chapter    to @section,
  509.                        @subsection to @subsubsection,
  510.                        @heading    to @subheading,
  511.                        etc.
  512.  
  513. An `@raisesections' or `@lowersections' command changes only those
  514. structuring commands that follow the `@raisesections' or
  515. `@lowersections' command.
  516.  
  517. An `@lowersections' command cancels an `@raisesections' command, and
  518. vice versa.
  519.  
  520. Repeated use of the commands continue to raise or lower the hierarchical
  521. level a step at a time.
  522.  
  523. An attempt to raise above `chapters' reproduces chapter commands; an
  524. attempt to lower below subsubsections reproduces subsubsection
  525. commands."
  526.   
  527.   ;; `texinfo-section-types-regexp' is defined in `texnfo-upd.el';
  528.   ;; it is a regexp matching chapter, section, other headings
  529.   ;; (but not the top node).
  530.  
  531.   (let (type (level 0))
  532.     (while 
  533.         (re-search-forward
  534.          (concat
  535.           "\\(\\(^@\\(raise\\|lower\\)sections\\)\\|\\("
  536.           texinfo-section-types-regexp
  537.           "\\)\\)")
  538.          nil t)
  539.       (beginning-of-line)
  540.       (save-excursion (setq type (read (current-buffer))))
  541.       (cond 
  542.        
  543.        ;; 1. Increment level
  544.        ((eq type '@raisesections)
  545.         (setq level (1+ level))
  546.         (delete-region
  547.          (point) (save-excursion (forward-line 1) (point))))
  548.        
  549.        ;; 2. Decrement level
  550.        ((eq type '@lowersections)
  551.         (setq level (1- level))
  552.         (delete-region
  553.          (point) (save-excursion (forward-line 1) (point))))
  554.        
  555.        ;; Now handle structuring commands
  556.        ((cond
  557.          
  558.          ;; 3. Raise level when positive
  559.          ((> level 0)
  560.           (let ((count level)
  561.                 (new-level type))
  562.             (while (> count 0)
  563.               (setq new-level
  564.                     (cdr (assq new-level texinfo-raisesections-alist)))
  565.               (setq count (1- count)))
  566.             (kill-word 1)
  567.             (insert (symbol-name new-level))))
  568.          
  569.          ;; 4. Do nothing except move point when level is zero
  570.          ((= level 0) (forward-line 1))
  571.          
  572.          ;; 5. Lower level when positive
  573.          ((< level 0)
  574.           (let ((count level)
  575.                 (new-level type))
  576.             (while (< count 0)
  577.               (setq new-level
  578.                     (cdr (assq new-level texinfo-lowersections-alist)))
  579.               (setq count (1+ count)))
  580.             (kill-word 1)
  581.             (insert (symbol-name new-level))))))))))
  582.  
  583. (defvar texinfo-raisesections-alist
  584.   '((@chapter . @chapter)             ; Cannot go higher
  585.     (@unnumbered . @unnumbered)
  586.  
  587.     (@majorheading . @majorheading)
  588.     (@chapheading . @chapheading)
  589.     (@appendix . @appendix)
  590.     
  591.     (@section . @chapter)
  592.     (@unnumberedsec . @unnumbered)
  593.     (@heading . @chapheading)
  594.     (@appendixsec . @appendix)
  595.     
  596.     (@subsection . @section)
  597.     (@unnumberedsubsec . @unnumberedsec)
  598.     (@subheading . @heading)
  599.     (@appendixsubsec . @appendixsec)
  600.     
  601.     (@subsubsection . @subsection)
  602.     (@unnumberedsubsubsec . @unnumberedsubsec)
  603.     (@subsubheading . @subheading)
  604.     (@appendixsubsubsec . @appendixsubsec))
  605.   "*An alist of next higher levels for chapters, sections. etc.
  606. For example, section to chapter, subsection to section.
  607. Used by `texinfo-raise-lower-sections'.
  608. The keys specify types of section; the values correspond to the next
  609. higher types.")
  610.  
  611. (defvar texinfo-lowersections-alist
  612.   '((@chapter . @section)  
  613.     (@unnumbered . @unnumberedsec)
  614.     (@majorheading . @heading)
  615.     (@chapheading . @heading)
  616.     (@appendix . @appendixsec)
  617.     
  618.     (@section . @subsection)
  619.     (@unnumberedsec . @unnumberedsubsec)
  620.     (@heading . @subheading)
  621.     (@appendixsec . @appendixsubsec)
  622.     
  623.     (@subsection . @subsubsection)
  624.     (@unnumberedsubsec . @unnumberedsubsubsec)
  625.     (@subheading . @subsubheading)
  626.     (@appendixsubsec . @appendixsubsubsec)
  627.     
  628.     (@subsubsection . @subsubsection) ; Cannot go lower.
  629.     (@unnumberedsubsubsec . @unnumberedsubsubsec)
  630.     (@subsubheading . @subsubheading)
  631.     (@appendixsubsubsec . @appendixsubsubsec))
  632.   "*An alist of next lower levels for chapters, sections. etc.
  633. For example, chapter to section, section to subsection.
  634. Used by `texinfo-raise-lower-sections'.
  635. The keys specify types of section; the values correspond to the next
  636. lower types.")
  637.  
  638.  
  639. ;;; Perform those texinfo-to-info conversions that apply to the whole input
  640. ;;; uniformly.
  641.  
  642. (defun texinfo-format-scan ()
  643.   (texinfo-format-convert (point-min) (point-max))
  644.   ;; Scan for @-commands.
  645.   (goto-char (point-min))
  646.   (while (search-forward "@" nil t)
  647.     (if (looking-at "[@{}^'` *\"?!]")
  648.         ;; Handle a few special @-followed-by-one-char commands.
  649.         (if (= (following-char) ?*)
  650.             (progn
  651.               ;; remove command
  652.               (delete-region (1- (point)) (1+ (point)))
  653.               ;; insert return if not at end of line;
  654.               ;; else line is already broken.
  655.               (if (not (= (following-char) ?\n))
  656.                   (insert ?\n)))      
  657.           ;; The other characters are simply quoted.  Delete the @.
  658.           (delete-char -1)
  659.           (forward-char 1))
  660.       ;; @ is followed by a command-word; find the end of the word.
  661.       (setq texinfo-command-start (1- (point)))
  662.       (if (= (char-syntax (following-char)) ?w)
  663.           (forward-word 1)
  664.         (forward-char 1))
  665.       (setq texinfo-command-end (point))
  666.       ;; Handle let aliasing
  667.       (setq texinfo-command-name
  668.         (let (trial
  669.           (cmdname 
  670.            (buffer-substring
  671.             (1+ texinfo-command-start) texinfo-command-end)))
  672.           (while (setq trial (assoc cmdname texinfo-alias-list))
  673.         (setq cmdname (cdr trial)))
  674.             (intern cmdname)))
  675.       ;; Call the handler for this command.
  676.       (let ((enclosure-type
  677.              (assoc
  678.               (symbol-name texinfo-command-name)
  679.               texinfo-enclosure-list)))
  680.         (if enclosure-type
  681.             (progn
  682.               (insert
  683.                (car (car (cdr enclosure-type))) 
  684.                (texinfo-parse-arg-discard)
  685.                (car (cdr (car (cdr enclosure-type)))))
  686.               (goto-char texinfo-command-start))
  687.           (let ((cmd (get texinfo-command-name 'texinfo-format)))
  688.             (if cmd (funcall cmd) (texinfo-unsupported)))))))
  689.   
  690.   (cond (texinfo-stack
  691.          (goto-char (nth 2 (car texinfo-stack)))
  692.          (error "Unterminated @%s" (car (car texinfo-stack))))))
  693.  
  694. (put 'begin 'texinfo-format 'texinfo-format-begin)
  695. (defun texinfo-format-begin ()
  696.   (texinfo-format-begin-end 'texinfo-format))
  697.  
  698. (put 'end 'texinfo-format 'texinfo-format-end)
  699. (defun texinfo-format-end ()
  700.   (texinfo-format-begin-end 'texinfo-end))
  701.  
  702. (defun texinfo-format-begin-end (prop)
  703.   (setq texinfo-command-name (intern (texinfo-parse-line-arg)))
  704.   (let ((cmd (get texinfo-command-name prop)))
  705.     (if cmd (funcall cmd)
  706.       (texinfo-unsupported))))
  707.  
  708. ;;; Parsing functions
  709.  
  710. (defun texinfo-parse-line-arg ()
  711.   (goto-char texinfo-command-end)
  712.   (let ((start (point)))
  713.     (cond ((looking-at " ")
  714.            (skip-chars-forward " ")
  715.            (setq start (point))
  716.            (end-of-line)
  717.            (skip-chars-backward " ")
  718.            (delete-region (point) (progn (end-of-line) (point)))
  719.            (setq texinfo-command-end (1+ (point))))
  720.           ((looking-at "{")
  721.            (setq start (1+ (point)))
  722.            (forward-list 1)
  723.            (setq texinfo-command-end (point))
  724.            (forward-char -1))
  725.           (t
  726.            (error "Invalid texinfo command arg format")))
  727.     (prog1 (buffer-substring start (point))
  728.            (if (eolp) (forward-char 1)))))
  729.  
  730. (defun texinfo-parse-expanded-arg ()
  731.   (goto-char texinfo-command-end)
  732.   (let ((start (point))
  733.         marker)
  734.     (cond ((looking-at " ")
  735.            (skip-chars-forward " ")
  736.            (setq start (point))
  737.            (end-of-line)
  738.            (setq texinfo-command-end (1+ (point))))
  739.           ((looking-at "{")
  740.            (setq start (1+ (point)))
  741.            (forward-list 1)
  742.            (setq texinfo-command-end (point))
  743.            (forward-char -1))
  744.           (t
  745.            (error "Invalid texinfo command arg format")))
  746.     (setq marker (move-marker (make-marker) texinfo-command-end))
  747.     (texinfo-format-expand-region start (point))
  748.     (setq texinfo-command-end (marker-position marker))
  749.     (move-marker marker nil)
  750.     (prog1 (buffer-substring start (point))
  751.            (if (eolp) (forward-char 1)))))
  752.  
  753. (defun texinfo-format-expand-region (start end)
  754.   (save-restriction
  755.     (narrow-to-region start end)
  756.     (let (texinfo-command-start
  757.           texinfo-command-end
  758.           texinfo-command-name
  759.           texinfo-stack)
  760.       (texinfo-format-scan))
  761.     (goto-char (point-max))))
  762.  
  763. (defun texinfo-parse-arg-discard ()
  764.   (prog1 (texinfo-parse-line-arg)
  765.          (texinfo-discard-command)))
  766.  
  767. (defun texinfo-discard-command ()
  768.   (delete-region texinfo-command-start texinfo-command-end))
  769.  
  770. (defun texinfo-optional-braces-discard ()
  771.   "Discard braces following command, if any."
  772.   (goto-char texinfo-command-end)
  773.   (let ((start (point)))
  774.     (cond ((looking-at "[ \t]*\n"))     ; do nothing
  775.           ((looking-at "{")             ; remove braces, if any
  776.            (forward-list 1)
  777.            (setq texinfo-command-end (point)))
  778.           (t
  779.            (error
  780.             "Invalid `texinfo-optional-braces-discard' format \(need braces?\)")))
  781.     (delete-region texinfo-command-start texinfo-command-end)))
  782.  
  783. (defun texinfo-format-parse-line-args ()
  784.   (let ((start (1- (point)))
  785.         next beg end
  786.         args)
  787.     (skip-chars-forward " ")
  788.     (while (not (eolp))
  789.       (setq beg (point))
  790.       (re-search-forward "[\n,]")
  791.       (setq next (point))
  792.       (if (bolp) (setq next (1- next)))
  793.       (forward-char -1)
  794.       (skip-chars-backward " ")
  795.       (setq end (point))
  796.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  797.                        args))
  798.       (goto-char next)
  799.       (skip-chars-forward " "))
  800.     (if (eolp) (forward-char 1))
  801.     (setq texinfo-command-end (point))
  802.     (nreverse args)))
  803.  
  804. (defun texinfo-format-parse-args ()
  805.   (let ((start (1- (point)))
  806.         next beg end
  807.         args)
  808.     (search-forward "{")
  809.     (save-excursion
  810.       (texinfo-format-expand-region 
  811.        (point)
  812.        (save-excursion (up-list 1) (1- (point)))))
  813.     ;; The following does not handle cross references of the form:
  814.     ;; `@xref{bullet, , @code{@@bullet}@{@}}.' because the
  815.     ;; re-search-forward finds the first right brace after the second
  816.     ;; comma. 
  817.     (while (/= (preceding-char) ?\})
  818.       (skip-chars-forward " \t\n")
  819.       (setq beg (point))
  820.       (re-search-forward "[},]")
  821.       (setq next (point))
  822.       (forward-char -1)
  823.       (skip-chars-backward " \t\n")
  824.       (setq end (point))
  825.       (cond ((< beg end)
  826.              (goto-char beg)
  827.              (while (search-forward "\n" end t)
  828.                (replace-match " "))))
  829.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  830.                        args))
  831.       (goto-char next))
  832.     (if (eolp) (forward-char 1))
  833.     (setq texinfo-command-end (point))
  834.     (nreverse args)))
  835.  
  836. (defun texinfo-format-parse-defun-args ()
  837.   (goto-char texinfo-command-end)
  838.   (let ((start (point)))
  839.     (end-of-line)
  840.     (setq texinfo-command-end (1+ (point)))
  841.     (let ((marker (move-marker (make-marker) texinfo-command-end)))
  842.       (texinfo-format-expand-region start (point))
  843.       (setq texinfo-command-end (marker-position marker))
  844.       (move-marker marker nil))
  845.     (goto-char start)
  846.     (let ((args '())
  847.           beg end)
  848.       (skip-chars-forward " ")
  849.       (while (not (eolp))
  850.         (cond ((looking-at "{")
  851.                (setq beg (1+ (point)))
  852.                (forward-list 1)
  853.                (setq end (1- (point))))
  854.               (t
  855.                (setq beg (point))
  856.                (re-search-forward "[\n ]")
  857.                (forward-char -1)
  858.                (setq end (point))))
  859.         (setq args (cons (buffer-substring beg end) args))
  860.         (skip-chars-forward " "))
  861.       (forward-char 1)
  862.       (nreverse args))))
  863.  
  864. (defun texinfo-discard-line ()
  865.   (goto-char texinfo-command-end)
  866.   (skip-chars-forward " \t")
  867.   (or (eolp)
  868.       (error "Extraneous text at end of command line."))
  869.   (goto-char texinfo-command-start)
  870.   (or (bolp)
  871.       (error "Extraneous text at beginning of command line."))
  872.   (delete-region (point) (progn (forward-line 1) (point))))
  873.  
  874. (defun texinfo-discard-line-with-args ()
  875.   (goto-char texinfo-command-start)
  876.   (delete-region (point) (progn (forward-line 1) (point))))
  877.  
  878.  
  879. ;;; @setfilename
  880.  
  881. ;; Only `texinfo-format-buffer' handles @setfilename with this
  882. ;; definition; `texinfo-format-region' handles @setfilename, if any,
  883. ;; specially. 
  884. (put 'setfilename 'texinfo-format 'texinfo-format-setfilename)
  885. (defun texinfo-format-setfilename ()
  886.   (let ((arg (texinfo-parse-arg-discard)))
  887.     (message "Formatting Info file: %s" arg)
  888.     (setq texinfo-format-filename
  889.           (file-name-nondirectory (expand-file-name arg)))
  890.     (insert "Info file: "
  891.             texinfo-format-filename ",    -*-Text-*-\n"
  892.             ;; Date string removed so that regression testing is easier.
  893.             ;; "produced on "
  894.             ;; (substring (current-time-string) 8 10) " "
  895.             ;; (substring (current-time-string) 4 7) " "
  896.             ;; (substring (current-time-string) -4)  " "
  897.             "produced by `texinfo-format-buffer'\n"
  898.             "from file"
  899.             (if (buffer-file-name input-buffer)
  900.                 (concat " `"
  901.                         (file-name-sans-versions
  902.                          (file-name-nondirectory
  903.                           (buffer-file-name input-buffer)))
  904.                         "'")
  905.               (concat "buffer `" (buffer-name input-buffer) "'"))
  906.             "\nusing `texinfmt.el' version "
  907.             texinfmt-version
  908.             ".\n\n")))
  909.  
  910. ;;; @node, @menu
  911.  
  912. (put 'node 'texinfo-format 'texinfo-format-node)
  913. (put 'nwnode 'texinfo-format 'texinfo-format-node)
  914. (defun texinfo-format-node ()
  915.   (let* ((args (texinfo-format-parse-line-args))
  916.          (name (nth 0 args))
  917.          (next (nth 1 args))
  918.          (prev (nth 2 args))
  919.          (up (nth 3 args)))
  920.     (texinfo-discard-command)
  921.     (setq texinfo-last-node name)
  922.     (let ((tem (downcase name)))
  923.       (if (assoc tem texinfo-node-names)
  924.           (error "Duplicate node name: %s" name)
  925.         (setq texinfo-node-names (cons (list tem) texinfo-node-names))))
  926.     (setq texinfo-footnote-number 0)
  927.     ;; insert "\n\^_" unconditionally since this is what info is looking for
  928.     (insert "\n\^_\nFile: " texinfo-format-filename
  929.             ", Node: " name)
  930.     (if next
  931.         (insert ", Next: " next))
  932.     (if prev
  933.         (insert ", Prev: " prev))
  934.     (if up
  935.         (insert ", Up: " up))
  936.     (insert ?\n)
  937.     (setq texinfo-last-node-pos (point))))
  938.  
  939. (put 'menu 'texinfo-format 'texinfo-format-menu)
  940. (defun texinfo-format-menu ()
  941.   (texinfo-discard-line)
  942.   (insert "* Menu:\n\n"))
  943.  
  944. (put 'menu 'texinfo-end 'texinfo-discard-command)
  945.  
  946.  
  947. ;;; Cross references
  948.  
  949. ; @xref {NODE, FNAME, NAME, FILE, DOCUMENT}
  950. ; -> *Note FNAME: (FILE)NODE
  951. ;   If FILE is missing,
  952. ;    *Note FNAME: NODE
  953. ;   If FNAME is empty and NAME is present
  954. ;    *Note NAME: Node
  955. ;   If both NAME and FNAME are missing
  956. ;    *Note NODE::
  957. ;   texinfo ignores the DOCUMENT argument.
  958. ; -> See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  959. ;   If FILE is specified, (FILE)NODE is used for xrefs.
  960. ;   If fifth argument DOCUMENT is specified, produces
  961. ;    See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  962. ;    of DOCUMENT
  963.  
  964. ; @ref             a reference that does not put `See' or `see' in
  965. ;                  the hardcopy and is the same as @xref in Info
  966. (put 'ref 'texinfo-format 'texinfo-format-xref)
  967.  
  968. (put 'xref 'texinfo-format 'texinfo-format-xref)
  969. (defun texinfo-format-xref ()
  970.   (let ((args (texinfo-format-parse-args)))
  971.     (texinfo-discard-command)
  972.     (insert "*Note ")
  973.     (let ((fname (or (nth 1 args) (nth 2 args))))
  974.       (if (null (or fname (nth 3 args)))
  975.           (insert (car args) "::")
  976.         (insert (or fname (car args)) ": ")
  977.         (if (nth 3 args)
  978.             (insert "(" (nth 3 args) ")"))
  979.         (insert (car args))))))
  980.  
  981. (put 'pxref 'texinfo-format 'texinfo-format-pxref)
  982. (defun texinfo-format-pxref ()
  983.   (texinfo-format-xref)
  984.   (or (save-excursion
  985.         (forward-char -2)
  986.         (looking-at "::"))
  987.       (insert ".")))
  988.  
  989. ;@inforef{NODE, FNAME, FILE}
  990. ;Like @xref{NODE, FNAME,,FILE} in texinfo.
  991. ;In Tex, generates "See Info file FILE, node NODE"
  992. (put 'inforef 'texinfo-format 'texinfo-format-inforef)
  993. (defun texinfo-format-inforef ()
  994.   (let ((args (texinfo-format-parse-args)))
  995.     (texinfo-discard-command)
  996.     (if (nth 1 args)
  997.         (insert "*Note " (nth 1 args) ": (" (nth 2 args) ")" (car args))
  998.       (insert "*Note " "(" (nth 2 args) ")" (car args) "::"))))
  999.  
  1000.  
  1001. ;;; Section headings
  1002.  
  1003. (put 'majorheading 'texinfo-format 'texinfo-format-chapter)
  1004. (put 'chapheading 'texinfo-format 'texinfo-format-chapter)
  1005. (put 'ichapter 'texinfo-format 'texinfo-format-chapter)
  1006. (put 'chapter 'texinfo-format 'texinfo-format-chapter)
  1007. (put 'iappendix 'texinfo-format 'texinfo-format-chapter)
  1008. (put 'appendix 'texinfo-format 'texinfo-format-chapter)
  1009. (put 'iunnumbered 'texinfo-format 'texinfo-format-chapter)
  1010. (put 'top 'texinfo-format 'texinfo-format-chapter)
  1011. (put 'unnumbered 'texinfo-format 'texinfo-format-chapter)
  1012. (defun texinfo-format-chapter ()
  1013.   (texinfo-format-chapter-1 ?*))
  1014.  
  1015. (put 'heading 'texinfo-format 'texinfo-format-section)
  1016. (put 'isection 'texinfo-format 'texinfo-format-section)
  1017. (put 'section 'texinfo-format 'texinfo-format-section)
  1018. (put 'iappendixsection 'texinfo-format 'texinfo-format-section)
  1019. (put 'appendixsection 'texinfo-format 'texinfo-format-section)
  1020. (put 'iappendixsec 'texinfo-format 'texinfo-format-section)
  1021. (put 'appendixsec 'texinfo-format 'texinfo-format-section)
  1022. (put 'iunnumberedsec 'texinfo-format 'texinfo-format-section)
  1023. (put 'unnumberedsec 'texinfo-format 'texinfo-format-section)
  1024. (defun texinfo-format-section ()
  1025.   (texinfo-format-chapter-1 ?=))
  1026.  
  1027. (put 'subheading 'texinfo-format 'texinfo-format-subsection)
  1028. (put 'isubsection 'texinfo-format 'texinfo-format-subsection)
  1029. (put 'subsection 'texinfo-format 'texinfo-format-subsection)
  1030. (put 'iappendixsubsec 'texinfo-format 'texinfo-format-subsection)
  1031. (put 'appendixsubsec 'texinfo-format 'texinfo-format-subsection)
  1032. (put 'iunnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  1033. (put 'unnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  1034. (defun texinfo-format-subsection ()
  1035.   (texinfo-format-chapter-1 ?-))
  1036.  
  1037. (put 'subsubheading 'texinfo-format 'texinfo-format-subsubsection)
  1038. (put 'isubsubsection 'texinfo-format 'texinfo-format-subsubsection)
  1039. (put 'subsubsection 'texinfo-format 'texinfo-format-subsubsection)
  1040. (put 'iappendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  1041. (put 'appendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  1042. (put 'iunnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  1043. (put 'unnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  1044. (defun texinfo-format-subsubsection ()
  1045.   (texinfo-format-chapter-1 ?.))
  1046.  
  1047. (defun texinfo-format-chapter-1 (belowchar)
  1048.   (let ((arg (texinfo-parse-arg-discard)))
  1049.     (message "Formatting: %s ... " arg)   ; So we can see where we are.
  1050.     (insert ?\n arg ?\n "@SectionPAD " belowchar ?\n)
  1051.     (forward-line -2)))
  1052.  
  1053. (put 'SectionPAD 'texinfo-format 'texinfo-format-sectionpad)
  1054. (defun texinfo-format-sectionpad ()
  1055.   (let ((str (texinfo-parse-arg-discard)))
  1056.     (forward-char -1)
  1057.     (let ((column (current-column)))
  1058.       (forward-char 1)
  1059.       (while (> column 0)
  1060.         (insert str)
  1061.         (setq column (1- column))))
  1062.     (insert ?\n)))
  1063.  
  1064.  
  1065. ;;; Space controlling commands:  @. and @:, and the soft hyphen.
  1066.  
  1067. (put '\. 'texinfo-format 'texinfo-format-\.)
  1068. (defun texinfo-format-\. ()
  1069.   (texinfo-discard-command)
  1070.   (insert "."))
  1071.  
  1072. (put '\: 'texinfo-format 'texinfo-format-\:)
  1073. (defun texinfo-format-\: ()
  1074.   (texinfo-discard-command))
  1075.  
  1076. (put '\- 'texinfo-format 'texinfo-format-soft-hyphen)
  1077. (defun texinfo-format-soft-hyphen ()
  1078.   (texinfo-discard-command))
  1079.  
  1080.  
  1081. ;;; @center, @sp, and @br
  1082.  
  1083. (put 'center 'texinfo-format 'texinfo-format-center)
  1084. (defun texinfo-format-center ()
  1085.   (let ((arg (texinfo-parse-expanded-arg)))
  1086.     (texinfo-discard-command)
  1087.     (insert arg)
  1088.     (insert ?\n)
  1089.     (save-restriction
  1090.       (goto-char (1- (point)))
  1091.       (let ((indent-tabs-mode nil))
  1092.         (center-line)))))
  1093.  
  1094. (put 'sp 'texinfo-format 'texinfo-format-sp)
  1095. (defun texinfo-format-sp ()
  1096.   (let* ((arg (texinfo-parse-arg-discard))
  1097.          (num (read arg)))
  1098.     (insert-char ?\n num)))
  1099.  
  1100. (put 'br 'texinfo-format 'texinfo-format-paragraph-break)
  1101. (defun texinfo-format-paragraph-break ()
  1102.   "Force a paragraph break.
  1103. If used within a line, follow `@br' with braces."
  1104.   (texinfo-optional-braces-discard)
  1105.   ;; insert one return if at end of line;
  1106.   ;; else insert two returns, to generate a blank line.
  1107.   (if (= (following-char) ?\n)
  1108.       (insert ?\n)
  1109.     (insert-char ?\n 2)))
  1110.  
  1111.  
  1112. ;;; @footnote  and  @footnotestyle
  1113.  
  1114. ; In Texinfo, footnotes are created with the `@footnote' command.
  1115. ; This command is followed immediately by a left brace, then by the text of
  1116. ; the footnote, and then by a terminating right brace.  The
  1117. ; template for a footnote is:
  1118. ; 
  1119. ;      @footnote{TEXT}
  1120. ;
  1121. ; Info has two footnote styles:
  1122. ; 
  1123. ;    * In the End of node style, all the footnotes for a single node
  1124. ;      are placed at the end of that node.  The footnotes are
  1125. ;      separated from the rest of the node by a line of dashes with
  1126. ;      the word `Footnotes' within it.
  1127. ; 
  1128. ;    * In the Separate node style, all the footnotes for a single node
  1129. ;      are placed in an automatically constructed node of their own.
  1130.  
  1131. ; Footnote style is specified by the @footnotestyle command, either
  1132. ;    @footnotestyle separate
  1133. ; or
  1134. ;    @footnotestyle end
  1135. ; 
  1136. ; The default is  separate
  1137.  
  1138. (defvar texinfo-footnote-style "separate" 
  1139.   "Footnote style, either separate or end.")
  1140.  
  1141. (put 'footnotestyle 'texinfo-format 'texinfo-footnotestyle)
  1142. (defun texinfo-footnotestyle ()
  1143.   "Specify whether footnotes are at end of node or in separate nodes.
  1144. Argument is either end or separate."
  1145.   (setq texinfo-footnote-style (texinfo-parse-arg-discard)))
  1146.  
  1147. (defvar texinfo-footnote-number)
  1148.  
  1149. (put 'footnote 'texinfo-format 'texinfo-format-footnote)
  1150. (defun texinfo-format-footnote ()
  1151.   "Format a footnote in either end of node or separate node style.
  1152. The   texinfo-footnote-style  variable controls which style is used."
  1153.   (setq texinfo-footnote-number (1+ texinfo-footnote-number))
  1154.   (cond ((string= texinfo-footnote-style "end")
  1155.          (texinfo-format-end-node))
  1156.         ((string= texinfo-footnote-style "separate")
  1157.          (texinfo-format-separate-node))))
  1158.  
  1159. (defun texinfo-format-separate-node ()
  1160.   "Format footnote in Separate node style, with notes in own node.
  1161. The node is constructed automatically."
  1162.   (let* (start
  1163.          (arg (texinfo-parse-line-arg))
  1164.          (node-name-beginning
  1165.           (save-excursion
  1166.             (re-search-backward
  1167.              "^File: \\w+\\(\\w\\|\\s_\\|\\.\\|,\\)*[ \t]+Node:")
  1168.             (match-end 0)))
  1169.          (node-name
  1170.           (save-excursion
  1171.             (buffer-substring
  1172.              (progn (goto-char node-name-beginning) ; skip over node command
  1173.                     (skip-chars-forward " \t")  ; and over spaces
  1174.                     (point))
  1175.              (if (search-forward
  1176.                   ","
  1177.                   (save-excursion (end-of-line) (point)) t) ; bound search
  1178.                  (1- (point))
  1179.                (end-of-line) (point))))))
  1180.     (texinfo-discard-command)  ; remove or insert whitespace, as needed
  1181.     (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
  1182.                    (point))
  1183.     (insert (format " (%d) (*Note %s-Footnotes::)"
  1184.                     texinfo-footnote-number node-name))
  1185.     (fill-paragraph nil)
  1186.     (save-excursion
  1187.     (if (re-search-forward "^@node" nil 'move)
  1188.         (forward-line -1))
  1189.  
  1190.     ;; two cases: for the first footnote, we must insert a node header;
  1191.     ;; for the second and subsequent footnotes, we need only insert 
  1192.     ;; the text of the  footnote.
  1193.  
  1194.     (if (save-excursion
  1195.          (re-search-backward
  1196.           (concat node-name "-Footnotes, Up: ")
  1197.           node-name-beginning
  1198.           t))
  1199.         (progn   ; already at least one footnote
  1200.           (setq start (point))
  1201.           (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  1202.           (fill-region start (point)))
  1203.       ;; else not yet a footnote
  1204.       (insert "\n\^_\nFile: "  texinfo-format-filename
  1205.               "  Node: " node-name "-Footnotes, Up: " node-name "\n")
  1206.       (setq start (point))
  1207.       (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  1208.       (fill-region start (point))))))
  1209.  
  1210. (defun texinfo-format-end-node ()
  1211.   "Format footnote in the End of node style, with notes at end of node."
  1212.   (let (start
  1213.         (arg (texinfo-parse-line-arg)))
  1214.     (texinfo-discard-command)  ; remove or insert whitespace, as needed
  1215.     (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
  1216.                    (point))
  1217.     (insert (format " (%d) " texinfo-footnote-number))
  1218.     (fill-paragraph nil)
  1219.     (save-excursion
  1220.       (if (search-forward "\n--------- Footnotes ---------\n" nil t)
  1221.           (progn ; already have footnote, put new one before end of node
  1222.             (if (re-search-forward "^@node" nil 'move)
  1223.                 (forward-line -1))
  1224.             (setq start (point))
  1225.             (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  1226.             (fill-region start (point)))
  1227.         ;; else no prior footnote
  1228.         (if (re-search-forward "^@node" nil 'move)
  1229.             (forward-line -1))
  1230.         (insert "\n--------- Footnotes ---------\n")
  1231.         (setq start (point))
  1232.         (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))))))
  1233.  
  1234.  
  1235. ;;; @itemize, @enumerate, and similar commands
  1236.  
  1237. ;; @itemize pushes (itemize "COMMANDS" STARTPOS) on texinfo-stack.
  1238. ;; @enumerate pushes (enumerate 0 STARTPOS).
  1239. ;; @item dispatches to the texinfo-item prop of the first elt of the list.
  1240. ;; For itemize, this puts in and rescans the COMMANDS.
  1241. ;; For enumerate, this increments the number and puts it in.
  1242. ;; In either case, it puts a Backspace at the front of the line
  1243. ;; which marks it not to be indented later.
  1244. ;; All other lines get indented by 5 when the @end is reached.
  1245.  
  1246. (defvar texinfo-stack-depth 0
  1247.   "Count of number of unpopped texinfo-push-stack calls.
  1248. Used by @refill indenting command to avoid indenting within lists, etc.")
  1249.  
  1250. (defun texinfo-push-stack (check arg)
  1251.   (setq texinfo-stack-depth (1+ texinfo-stack-depth))
  1252.   (setq texinfo-stack
  1253.         (cons (list check arg texinfo-command-start)
  1254.               texinfo-stack)))
  1255.  
  1256. (defun texinfo-pop-stack (check)
  1257.   (setq texinfo-stack-depth (1- texinfo-stack-depth))
  1258.   (if (null texinfo-stack)
  1259.       (error "Unmatched @end %s" check))
  1260.   (if (not (eq (car (car texinfo-stack)) check))
  1261.       (error "@end %s matches @%s"
  1262.              check (car (car texinfo-stack))))
  1263.   (prog1 (cdr (car texinfo-stack))
  1264.          (setq texinfo-stack (cdr texinfo-stack))))
  1265.  
  1266. (put 'itemize 'texinfo-format 'texinfo-itemize)
  1267. (defun texinfo-itemize ()
  1268.   (texinfo-push-stack
  1269.    'itemize
  1270.    (progn (skip-chars-forward " \t")
  1271.           (if (eolp)
  1272.               "@bullet"
  1273.             (texinfo-parse-line-arg))))
  1274.   (texinfo-discard-line-with-args)
  1275.   (setq fill-column (- fill-column 5)))
  1276.  
  1277. (put 'itemize 'texinfo-end 'texinfo-end-itemize)
  1278. (defun texinfo-end-itemize ()
  1279.   (setq fill-column (+ fill-column 5))
  1280.   (texinfo-discard-command)
  1281.   (let ((stacktop
  1282.          (texinfo-pop-stack 'itemize)))
  1283.     (texinfo-do-itemize (nth 1 stacktop))))
  1284.  
  1285. (put 'enumerate 'texinfo-format 'texinfo-enumerate)
  1286. (defun texinfo-enumerate ()
  1287.   (texinfo-push-stack
  1288.    'enumerate 
  1289.    (progn (skip-chars-forward " \t")
  1290.           (if (eolp)
  1291.               1
  1292.             (read (current-buffer)))))
  1293.   (if (and (symbolp (car (cdr (car texinfo-stack))))
  1294.            (> 1 (length (symbol-name (car (cdr (car texinfo-stack)))))))
  1295.       (error
  1296.        "@enumerate: Use a number or letter, eg: 1, A, a, 3, B, or d." ))
  1297.   (texinfo-discard-line-with-args)
  1298.   (setq fill-column (- fill-column 5)))
  1299.  
  1300. (put 'enumerate 'texinfo-end 'texinfo-end-enumerate)
  1301. (defun texinfo-end-enumerate ()
  1302.   (setq fill-column (+ fill-column 5))
  1303.   (texinfo-discard-command)
  1304.   (let ((stacktop
  1305.          (texinfo-pop-stack 'enumerate)))
  1306.     (texinfo-do-itemize (nth 1 stacktop))))
  1307.  
  1308. ;; @alphaenumerate never became a standard part of Texinfo
  1309. (put 'alphaenumerate 'texinfo-format 'texinfo-alphaenumerate)
  1310. (defun texinfo-alphaenumerate ()
  1311.   (texinfo-push-stack 'alphaenumerate (1- ?a))
  1312.   (setq fill-column (- fill-column 5))
  1313.   (texinfo-discard-line))
  1314.  
  1315. (put 'alphaenumerate 'texinfo-end 'texinfo-end-alphaenumerate)
  1316. (defun texinfo-end-alphaenumerate ()
  1317.   (setq fill-column (+ fill-column 5))
  1318.   (texinfo-discard-command)
  1319.   (let ((stacktop
  1320.          (texinfo-pop-stack 'alphaenumerate)))
  1321.     (texinfo-do-itemize (nth 1 stacktop))))
  1322.  
  1323. ;; @capsenumerate never became a standard part of Texinfo
  1324. (put 'capsenumerate 'texinfo-format 'texinfo-capsenumerate)
  1325. (defun texinfo-capsenumerate ()
  1326.   (texinfo-push-stack 'capsenumerate (1- ?A))
  1327.   (setq fill-column (- fill-column 5))
  1328.   (texinfo-discard-line))
  1329.  
  1330. (put 'capsenumerate 'texinfo-end 'texinfo-end-capsenumerate)
  1331. (defun texinfo-end-capsenumerate ()
  1332.   (setq fill-column (+ fill-column 5))
  1333.   (texinfo-discard-command)
  1334.   (let ((stacktop
  1335.          (texinfo-pop-stack 'capsenumerate)))
  1336.     (texinfo-do-itemize (nth 1 stacktop))))
  1337.  
  1338. ;; At the @end, indent all the lines within the construct
  1339. ;; except those marked with backspace.  FROM says where
  1340. ;; construct started.
  1341. (defun texinfo-do-itemize (from)
  1342.   (save-excursion
  1343.    (while (progn (forward-line -1)
  1344.                  (>= (point) from))
  1345.      (if (= (following-char) ?\b)
  1346.          (save-excursion
  1347.            (delete-char 1)
  1348.            (end-of-line)
  1349.            (delete-char 6))
  1350.        (if (not (looking-at "[ \t]*$"))
  1351.            (save-excursion (insert "     ")))))))
  1352.  
  1353. (put 'item 'texinfo-format 'texinfo-item)
  1354. (put 'itemx 'texinfo-format 'texinfo-item)
  1355. (defun texinfo-item ()
  1356.   (funcall (get (car (car texinfo-stack)) 'texinfo-item)))
  1357.  
  1358. (put 'itemize 'texinfo-item 'texinfo-itemize-item)
  1359. (defun texinfo-itemize-item ()
  1360.   ;; (texinfo-discard-line)   ; Did not handle text on same line as @item.
  1361.   (delete-region (1+ (point)) (save-excursion (beginning-of-line) (point)))
  1362.   (if (looking-at "[ \t]*[^ \t\n]+")
  1363.       ;; Text on same line as @item command.
  1364.       (insert "\b   " (nth 1 (car texinfo-stack)) " \n")
  1365.     ;; Else text on next line.
  1366.     (insert "\b   " (nth 1 (car texinfo-stack)) " "))
  1367.   (forward-line -1))
  1368.  
  1369. (put 'enumerate 'texinfo-item 'texinfo-enumerate-item)
  1370. (defun texinfo-enumerate-item ()
  1371.   (texinfo-discard-line)
  1372.   (let (enumerating-symbol)
  1373.     (cond ((integerp (car (cdr (car texinfo-stack))))
  1374.            (setq enumerating-symbol (car (cdr (car texinfo-stack))))
  1375.            (insert ?\b (format "%3d. " enumerating-symbol) ?\n)
  1376.            (setcar (cdr (car texinfo-stack)) (1+ enumerating-symbol)))
  1377.           ((symbolp (car (cdr (car texinfo-stack))))
  1378.            (setq enumerating-symbol
  1379.                  (symbol-name (car (cdr (car texinfo-stack)))))
  1380.            (if (or (equal ?\[ (string-to-char enumerating-symbol))
  1381.                    (equal ?\{ (string-to-char enumerating-symbol)))
  1382.                (error
  1383.                 "Too many items in enumerated list; alphabet ends at Z."))
  1384.            (insert ?\b (format "%3s. " enumerating-symbol) ?\n)
  1385.            (setcar (cdr (car texinfo-stack))
  1386.                    (make-symbol
  1387.                     (char-to-string
  1388.                      (1+ 
  1389.                       (string-to-char enumerating-symbol))))))
  1390.           (t
  1391.           (error
  1392.            "@enumerate: Use a number or letter, eg: 1, A, a, 3, B or d." )))
  1393.     (forward-line -1)))
  1394.  
  1395. (put 'alphaenumerate 'texinfo-item 'texinfo-alphaenumerate-item)
  1396. (defun texinfo-alphaenumerate-item ()
  1397.   (texinfo-discard-line)
  1398.   (let ((next (1+ (car (cdr (car texinfo-stack))))))
  1399.     (if (> next ?z)
  1400.         (error "More than 26 items in @alphaenumerate; get a bigger alphabet."))
  1401.     (setcar (cdr (car texinfo-stack)) next)
  1402.     (insert "\b  " next ". \n"))
  1403.   (forward-line -1))
  1404.  
  1405. (put 'capsenumerate 'texinfo-item 'texinfo-capsenumerate-item)
  1406. (defun texinfo-capsenumerate-item ()
  1407.   (texinfo-discard-line)
  1408.   (let ((next (1+ (car (cdr (car texinfo-stack))))))
  1409.     (if (> next ?Z)
  1410.         (error "More than 26 items in @capsenumerate; get a bigger alphabet."))
  1411.     (setcar (cdr (car texinfo-stack)) next)
  1412.     (insert "\b  " next ". \n"))
  1413.   (forward-line -1))
  1414.  
  1415.  
  1416. ;;; @table
  1417.  
  1418. ; The `@table' command produces two-column tables.
  1419.  
  1420. (put 'table 'texinfo-format 'texinfo-table)
  1421. (defun texinfo-table ()
  1422.   (texinfo-push-stack 
  1423.    'table 
  1424.    (progn (skip-chars-forward " \t")
  1425.           (if (eolp)
  1426.               "@asis"
  1427.             (texinfo-parse-line-arg))))
  1428.   (texinfo-discard-line-with-args)
  1429.   (setq fill-column (- fill-column 5)))
  1430.  
  1431. (put 'table 'texinfo-item 'texinfo-table-item)
  1432. (defun texinfo-table-item ()
  1433.   (let ((arg (texinfo-parse-arg-discard))
  1434.         (itemfont (car (cdr (car texinfo-stack)))))
  1435.     (insert ?\b itemfont ?\{ arg "}\n     \n"))
  1436.   (forward-line -2))
  1437.  
  1438. (put 'table 'texinfo-end 'texinfo-end-table)
  1439. (defun texinfo-end-table ()
  1440.   (setq fill-column (+ fill-column 5))
  1441.   (texinfo-discard-command)
  1442.   (let ((stacktop
  1443.          (texinfo-pop-stack 'table)))
  1444.     (texinfo-do-itemize (nth 1 stacktop))))
  1445.  
  1446. ;; @description appears to be an undocumented variant on @table that
  1447. ;; does not require an arg.  It fails in texinfo.tex 2.58 and is not
  1448. ;; part of makeinfo.c   The command appears to be a relic of the past.
  1449. (put 'description 'texinfo-end 'texinfo-end-table)
  1450. (put 'description 'texinfo-format 'texinfo-description)
  1451. (defun texinfo-description ()
  1452.   (texinfo-push-stack 'table "@asis")
  1453.   (setq fill-column (- fill-column 5))
  1454.   (texinfo-discard-line))
  1455.  
  1456.  
  1457. ;;; @ftable, @vtable
  1458.  
  1459. ; The `@ftable' and `@vtable' commands are like the `@table' command
  1460. ; but they also insert each entry in the first column of the table
  1461. ; into the function or variable index.
  1462.  
  1463. ;; Handle the @ftable and @vtable commands:
  1464.  
  1465. (put 'ftable 'texinfo-format 'texinfo-ftable)
  1466. (put 'vtable 'texinfo-format 'texinfo-vtable)
  1467.  
  1468. (defun texinfo-ftable () (texinfo-indextable 'ftable))
  1469. (defun texinfo-vtable () (texinfo-indextable 'vtable))
  1470.  
  1471. (defun texinfo-indextable (table-type)
  1472.   (texinfo-push-stack table-type (texinfo-parse-arg-discard))
  1473.   (setq fill-column (- fill-column 5)))
  1474.  
  1475. ;; Handle the @item commands within ftable and vtable:
  1476.  
  1477. (put 'ftable 'texinfo-item 'texinfo-ftable-item)
  1478. (put 'vtable 'texinfo-item 'texinfo-vtable-item)
  1479.  
  1480. (defun texinfo-ftable-item () (texinfo-indextable-item 'texinfo-findex))
  1481. (defun texinfo-vtable-item () (texinfo-indextable-item 'texinfo-vindex))
  1482.  
  1483. (defun texinfo-indextable-item (index-type)
  1484.   (let ((item (texinfo-parse-arg-discard))
  1485.         (itemfont (car (cdr (car texinfo-stack))))
  1486.         (indexvar index-type))
  1487.     (insert ?\b itemfont ?\{ item "}\n     \n")
  1488.     (set indexvar
  1489.          (cons
  1490.           (list item texinfo-last-node)
  1491.           (symbol-value indexvar)))
  1492.     (forward-line -2)))
  1493.  
  1494. ;; Handle @end ftable, @end vtable
  1495.  
  1496. (put 'ftable 'texinfo-end 'texinfo-end-ftable)
  1497. (put 'vtable 'texinfo-end 'texinfo-end-vtable)
  1498.  
  1499. (defun texinfo-end-ftable () (texinfo-end-indextable 'ftable))
  1500. (defun texinfo-end-vtable () (texinfo-end-indextable 'vtable))
  1501.  
  1502. (defun texinfo-end-indextable (table-type)
  1503.   (setq fill-column (+ fill-column 5))
  1504.   (texinfo-discard-command)
  1505.   (let ((stacktop
  1506.          (texinfo-pop-stack table-type)))
  1507.     (texinfo-do-itemize (nth 1 stacktop))))
  1508.  
  1509.  
  1510. ;;; @ifinfo,  @iftex, @tex, @ifhtml, @html
  1511.  
  1512. (put 'ifinfo 'texinfo-format 'texinfo-discard-line)
  1513. (put 'ifinfo 'texinfo-end 'texinfo-discard-command)
  1514.  
  1515. (put 'iftex 'texinfo-format 'texinfo-format-iftex)
  1516. (defun texinfo-format-iftex ()
  1517.   (delete-region texinfo-command-start
  1518.                  (progn (re-search-forward "@end iftex[ \t]*\n")
  1519.                         (point))))
  1520.  
  1521. (put 'ifhtml 'texinfo-format 'texinfo-format-ifhtml)
  1522. (defun texinfo-format-ifhtml ()
  1523.   (delete-region texinfo-command-start
  1524.                  (progn (re-search-forward "@end ifhtml[ \t]*\n")
  1525.                         (point))))
  1526.  
  1527. (put 'tex 'texinfo-format 'texinfo-format-tex)
  1528. (defun texinfo-format-tex ()
  1529.   (delete-region texinfo-command-start
  1530.                  (progn (re-search-forward "@end tex[ \t]*\n")
  1531.                         (point))))
  1532.  
  1533. (put 'html 'texinfo-format 'texinfo-format-html)
  1534. (defun texinfo-format-html ()
  1535.   (delete-region texinfo-command-start
  1536.                  (progn (re-search-forward "@end html[ \t]*\n")
  1537.                         (point))))
  1538.  
  1539.  
  1540. ;;; @titlepage
  1541.  
  1542. (put 'titlepage 'texinfo-format 'texinfo-format-titlepage)
  1543. (defun texinfo-format-titlepage ()
  1544.   (delete-region texinfo-command-start
  1545.                  (progn (re-search-forward "@end titlepage[ \t]*\n")
  1546.                         (point))))
  1547.  
  1548. (put 'endtitlepage 'texinfo-format 'texinfo-discard-line)
  1549.  
  1550. ; @titlespec         an alternative titling command; ignored by Info
  1551.  
  1552. (put 'titlespec 'texinfo-format 'texinfo-format-titlespec)
  1553. (defun texinfo-format-titlespec ()
  1554.   (delete-region texinfo-command-start
  1555.                  (progn (re-search-forward "@end titlespec[ \t]*\n")
  1556.                         (point))))
  1557.  
  1558. (put 'endtitlespec 'texinfo-format 'texinfo-discard-line)
  1559.  
  1560.  
  1561. ;;; @today
  1562.  
  1563. (put 'today 'texinfo-format 'texinfo-format-today)
  1564.  
  1565. ; Produces Day Month Year style of output.  eg `1 Jan 1900'
  1566. ; The `@today{}' command requires a pair of braces, like `@dots{}'.
  1567. (defun texinfo-format-today ()
  1568.   (texinfo-parse-arg-discard)
  1569.   (insert (format "%s %s %s"
  1570.           (substring (current-time-string) 8 10)
  1571.           (substring (current-time-string) 4 7)
  1572.           (substring (current-time-string) -4))))
  1573.  
  1574.  
  1575. ;;; @ignore
  1576.  
  1577. (put 'ignore 'texinfo-format 'texinfo-format-ignore)
  1578. (defun texinfo-format-ignore ()
  1579.   (delete-region texinfo-command-start
  1580.                  (progn (re-search-forward "@end ignore[ \t]*\n")
  1581.                         (point))))
  1582.  
  1583. (put 'endignore 'texinfo-format 'texinfo-discard-line)
  1584.  
  1585.  
  1586. ;;; Define the Info enclosure command: @definfoenclose
  1587.  
  1588. ; A `@definfoenclose' command may be used to define a highlighting
  1589. ; command for Info, but not for TeX.  A command defined using
  1590. ; `@definfoenclose' marks text by enclosing it in strings that precede
  1591. ; and follow the text.
  1592. ; 
  1593. ; Presumably, if you define a command with `@definfoenclose` for Info,
  1594. ; you will also define the same command in the TeX definitions file,
  1595. ; `texinfo.tex' in a manner appropriate for typesetting.
  1596. ; 
  1597. ; Write a `@definfoenclose' command on a line and follow it with three
  1598. ; arguments separated by commas (commas are used as separators in an
  1599. ; `@node' line in the same way).  The first argument to
  1600. ; `@definfoenclose' is the @-command name \(without the `@'\); the
  1601. ; second argument is the Info start delimiter string; and the third
  1602. ; argument is the Info end delimiter string.  The latter two arguments
  1603. ; enclose the highlighted text in the Info file.  A delimiter string
  1604. ; may contain spaces.  Neither the start nor end delimiter is
  1605. ; required.  However, if you do not provide a start delimiter, you
  1606. ; must follow the command name with two commas in a row; otherwise,
  1607. ; the Info formatting commands will misinterpret the end delimiter
  1608. ; string as a start delimiter string.
  1609. ;
  1610. ; If you do a @definfoenclose{} on the name of a pre-defined macro (such
  1611. ; as @emph{}, @strong{}, @tt{}, or @i{}) the enclosure definition will
  1612. ; override the built-in definition.
  1613. ; 
  1614. ; An enclosure command defined this way takes one argument in braces.
  1615. ;
  1616. ; For example, you can write:
  1617. ;
  1618. ;     @ifinfo
  1619. ;     @definfoenclose phoo, //, \\
  1620. ;     @end ifinfo
  1621. ;
  1622. ; near the beginning of a Texinfo file at the beginning of the lines
  1623. ; to define `@phoo' as an Info formatting command that inserts `//'
  1624. ; before and `\\' after the argument to `@phoo'.  You can then write
  1625. ; `@phoo{bar}' wherever you want `//bar\\' highlighted in Info.
  1626. ;
  1627. ; Also, for TeX formatting, you could write 
  1628. ;
  1629. ;     @iftex
  1630. ;     @global@let@phoo=@i
  1631. ;     @end iftex
  1632. ;
  1633. ; to define `@phoo' as a command that causes TeX to typeset
  1634. ; the argument to `@phoo' in italics.
  1635. ;
  1636. ; Note that each definition applies to its own formatter: one for TeX,
  1637. ; the other for texinfo-format-buffer or texinfo-format-region.
  1638. ;
  1639. ; Here is another example: write
  1640. ;
  1641. ;     @definfoenclose headword, , :
  1642. ;
  1643. ; near the beginning of the file, to define `@headword' as an Info
  1644. ; formatting command that inserts nothing before and a colon after the
  1645. ; argument to `@headword'.
  1646.  
  1647. (put 'definfoenclose 'texinfo-format 'texinfo-define-info-enclosure)
  1648. (defun texinfo-define-info-enclosure ()
  1649.   (let* ((args (texinfo-format-parse-line-args))
  1650.          (command-name (nth 0 args))
  1651.          (beginning-delimiter (or (nth 1 args) ""))
  1652.          (end-delimiter (or (nth 2 args) "")))
  1653.     (texinfo-discard-command)
  1654.     (setq texinfo-enclosure-list
  1655.         (cons
  1656.          (list command-name
  1657.                (list
  1658.                 beginning-delimiter
  1659.                 end-delimiter))
  1660.          texinfo-enclosure-list))))
  1661.  
  1662.  
  1663. ;;; @var, @code and the like
  1664.  
  1665. (put 'var 'texinfo-format 'texinfo-format-var)
  1666. ;  @sc  a small caps font for TeX; formatted as `var' in Info
  1667. (put 'sc 'texinfo-format 'texinfo-format-var)
  1668. (defun texinfo-format-var ()
  1669.   (insert (upcase (texinfo-parse-arg-discard)))
  1670.   (goto-char texinfo-command-start))
  1671.  
  1672. ; various noops
  1673.  
  1674. (put 'b 'texinfo-format 'texinfo-format-noop)
  1675. (put 'i 'texinfo-format 'texinfo-format-noop)
  1676. (put 'r 'texinfo-format 'texinfo-format-noop)
  1677. (put 't 'texinfo-format 'texinfo-format-noop)
  1678. (put 'w 'texinfo-format 'texinfo-format-noop)
  1679. (put 'asis 'texinfo-format 'texinfo-format-noop)
  1680. (put 'dmn 'texinfo-format 'texinfo-format-noop)
  1681. (put 'key 'texinfo-format 'texinfo-format-noop)
  1682. (put 'math 'texinfo-format 'texinfo-format-noop)
  1683. (put 'titlefont 'texinfo-format 'texinfo-format-noop)
  1684. (defun texinfo-format-noop ()
  1685.   (insert (texinfo-parse-arg-discard))
  1686.   (goto-char texinfo-command-start))
  1687.  
  1688. (put 'cite 'texinfo-format 'texinfo-format-code)
  1689. (put 'code 'texinfo-format 'texinfo-format-code)
  1690. (put 'file 'texinfo-format 'texinfo-format-code)
  1691. (put 'kbd 'texinfo-format 'texinfo-format-code)
  1692. (put 'samp 'texinfo-format 'texinfo-format-code)
  1693. (defun texinfo-format-code ()
  1694.   (insert "`" (texinfo-parse-arg-discard) "'")
  1695.   (goto-char texinfo-command-start))
  1696.  
  1697. (put 'emph 'texinfo-format 'texinfo-format-emph)
  1698. (put 'strong 'texinfo-format 'texinfo-format-emph)
  1699. (defun texinfo-format-emph ()
  1700.   (insert "*" (texinfo-parse-arg-discard) "*")
  1701.   (goto-char texinfo-command-start))
  1702.  
  1703. (put 'dfn 'texinfo-format 'texinfo-format-defn)
  1704. (put 'defn 'texinfo-format 'texinfo-format-defn)
  1705. (defun texinfo-format-defn ()
  1706.   (insert "\"" (texinfo-parse-arg-discard) "\"")
  1707.   (goto-char texinfo-command-start))
  1708.  
  1709. (put 'bullet 'texinfo-format 'texinfo-format-bullet)
  1710. (defun texinfo-format-bullet ()
  1711.   "Insert an asterisk.
  1712. If used within a line, follow `@bullet' with braces."
  1713.   (texinfo-optional-braces-discard)
  1714.   (insert "*"))
  1715.  
  1716.  
  1717. ;;; @example, @lisp, @quotation, @display, @smalllisp, @smallexample
  1718.  
  1719. (put 'display 'texinfo-format 'texinfo-format-example)
  1720. (put 'example 'texinfo-format 'texinfo-format-example)
  1721. (put 'lisp 'texinfo-format 'texinfo-format-example)
  1722. (put 'quotation 'texinfo-format 'texinfo-format-example)
  1723. (put 'smallexample 'texinfo-format 'texinfo-format-example)
  1724. (put 'smalllisp 'texinfo-format 'texinfo-format-example)
  1725. (defun texinfo-format-example ()
  1726.   (texinfo-push-stack 'example nil)
  1727.   (setq fill-column (- fill-column 5))
  1728.   (texinfo-discard-line))
  1729.  
  1730. (put 'example 'texinfo-end 'texinfo-end-example)
  1731. (put 'display 'texinfo-end 'texinfo-end-example)
  1732. (put 'lisp 'texinfo-end 'texinfo-end-example)
  1733. (put 'quotation 'texinfo-end 'texinfo-end-example)
  1734. (put 'smallexample 'texinfo-end 'texinfo-end-example)
  1735. (put 'smalllisp 'texinfo-end 'texinfo-end-example)
  1736. (defun texinfo-end-example ()
  1737.   (setq fill-column (+ fill-column 5))
  1738.   (texinfo-discard-command)
  1739.   (let ((stacktop
  1740.          (texinfo-pop-stack 'example)))
  1741.     (texinfo-do-itemize (nth 1 stacktop))))
  1742.  
  1743. (put 'exdent 'texinfo-format 'texinfo-format-exdent)
  1744. (defun texinfo-format-exdent ()
  1745.   (texinfo-discard-command)
  1746.   (delete-region (point)
  1747.                  (progn
  1748.                   (skip-chars-forward " ")
  1749.                   (point)))
  1750.   (insert ?\b)
  1751.   ;; Cancel out the deletion that texinfo-do-itemize
  1752.   ;; is going to do at the end of this line.
  1753.   (save-excursion
  1754.     (end-of-line)
  1755.     (insert "\n     ")))
  1756.  
  1757.  
  1758. ;;; @cartouche 
  1759.  
  1760. ; The @cartouche command is a noop in Info; in a printed manual,
  1761. ; it makes a box with rounded corners.
  1762.  
  1763. (put 'cartouche 'texinfo-format 'texinfo-discard-line)
  1764. (put 'cartouche 'texinfo-end 'texinfo-discard-command)
  1765.  
  1766.  
  1767. ;;; @flushleft and @format
  1768.  
  1769. ; The @flushleft command left justifies every line but leaves the
  1770. ; right end ragged.  As far as Info is concerned, @flushleft is a
  1771. ; `do-nothing' command
  1772.  
  1773. ; The @format command is similar to @example except that it does not
  1774. ; indent; this means that in Info, @format is similar to @flushleft.
  1775.  
  1776. (put 'format 'texinfo-format 'texinfo-format-flushleft)
  1777. (put 'flushleft 'texinfo-format 'texinfo-format-flushleft)
  1778. (defun texinfo-format-flushleft ()
  1779.   (texinfo-discard-line))
  1780.  
  1781. (put 'format 'texinfo-end 'texinfo-end-flushleft)
  1782. (put 'flushleft 'texinfo-end 'texinfo-end-flushleft)
  1783. (defun texinfo-end-flushleft ()
  1784.   (texinfo-discard-command))
  1785.  
  1786.  
  1787. ;;; @flushright
  1788.  
  1789. ; The @flushright command right justifies every line but leaves the
  1790. ; left end ragged.  Spaces and tabs at the right ends of lines are
  1791. ; removed so that visible text lines up on the right side.
  1792.  
  1793. (put 'flushright 'texinfo-format 'texinfo-format-flushright)
  1794. (defun texinfo-format-flushright ()
  1795.   (texinfo-push-stack 'flushright nil)
  1796.   (texinfo-discard-line))
  1797.  
  1798. (put 'flushright 'texinfo-end 'texinfo-end-flushright)
  1799. (defun texinfo-end-flushright ()
  1800.   (texinfo-discard-command)
  1801.  
  1802.   (let ((stacktop
  1803.          (texinfo-pop-stack 'flushright)))
  1804.  
  1805.     (texinfo-do-flushright (nth 1 stacktop))))
  1806.  
  1807. (defun texinfo-do-flushright (from)
  1808.   (save-excursion
  1809.    (while (progn (forward-line -1)
  1810.                  (>= (point) from))
  1811.  
  1812.      (beginning-of-line)
  1813.      (insert
  1814.       (make-string
  1815.        (- fill-column
  1816.           (save-excursion
  1817.             (end-of-line) 
  1818.             (skip-chars-backward " \t")
  1819.             (delete-region (point) (progn (end-of-line) (point)))
  1820.             (current-column)))  
  1821.        ? )))))
  1822.  
  1823.  
  1824. ;;; @ctrl, @TeX, @copyright, @minus, @dots
  1825.  
  1826. (put 'ctrl 'texinfo-format 'texinfo-format-ctrl)
  1827. (defun texinfo-format-ctrl ()
  1828.   (let ((str (texinfo-parse-arg-discard)))
  1829.     (insert (logand 31 (aref str 0)))))
  1830.  
  1831. (put 'TeX 'texinfo-format 'texinfo-format-TeX)
  1832. (defun texinfo-format-TeX ()
  1833.   (texinfo-parse-arg-discard)
  1834.   (insert "TeX"))
  1835.  
  1836. (put 'copyright 'texinfo-format 'texinfo-format-copyright)
  1837. (defun texinfo-format-copyright ()
  1838.   (texinfo-parse-arg-discard)
  1839.   (insert "(C)"))
  1840.  
  1841. (put 'minus 'texinfo-format 'texinfo-format-minus)
  1842. (defun texinfo-format-minus ()
  1843.   "Insert a minus sign.
  1844. If used within a line, follow `@minus' with braces."
  1845.   (texinfo-optional-braces-discard)
  1846.   (insert "-"))
  1847.  
  1848. (put 'dots 'texinfo-format 'texinfo-format-dots)
  1849. (defun texinfo-format-dots ()
  1850.   (texinfo-parse-arg-discard)
  1851.   (insert "..."))
  1852.  
  1853. (put 'enddots 'texinfo-format 'texinfo-format-enddots)
  1854. (defun texinfo-format-enddots ()
  1855.   (texinfo-parse-arg-discard)
  1856.   (insert "...."))
  1857.  
  1858.  
  1859. ;;; Refilling and indenting:  @refill, @paragraphindent, @noindent
  1860.  
  1861. ;;; Indent only those paragraphs that are refilled as a result of an
  1862. ;;; @refill command.  
  1863.  
  1864. ;    * If the value is `asis', do not change the existing indentation at
  1865. ;      the starts of paragraphs.
  1866.  
  1867. ;    * If the value zero, delete any existing indentation.
  1868.  
  1869. ;    * If the value is greater than zero, indent each paragraph by that
  1870. ;      number of spaces.
  1871.  
  1872. ;;; But do not refill paragraphs with an @refill command that are
  1873. ;;; preceded by @noindent or are part of a table, list, or deffn.
  1874.  
  1875. (defvar texinfo-paragraph-indent "asis"
  1876.   "Number of spaces for @refill to indent a paragraph; else to leave as is.")
  1877.  
  1878. (put 'paragraphindent 'texinfo-format 'texinfo-paragraphindent)
  1879.  
  1880. (defun texinfo-paragraphindent ()
  1881.   "Specify the number of spaces for @refill to indent a paragraph.
  1882. Default is to leave the number of spaces as is."
  1883.   (let ((arg  (texinfo-parse-arg-discard)))
  1884.     (if (string= "asis" arg)
  1885.         (setq texinfo-paragraph-indent "asis")
  1886.       (setq texinfo-paragraph-indent (string-to-int arg)))))
  1887.  
  1888. (put 'refill 'texinfo-format 'texinfo-format-refill)
  1889. (defun texinfo-format-refill ()
  1890.   "Refill paragraph. Also, indent first line as set by @paragraphindent.
  1891. Default is to leave paragraph indentation as is."
  1892.   (texinfo-discard-command)
  1893.   (forward-paragraph -1)     
  1894.   (if (looking-at "[ \t\n]*$") (forward-line 1))
  1895.   ;; Do not indent if an entry in a list, table, or deffn,
  1896.   ;; or if paragraph is preceded by @noindent.
  1897.   ;; Otherwise, indent
  1898.   (cond 
  1899.    ;; delete a @noindent line and do not indent paragraph
  1900.    ((save-excursion (forward-line -1)
  1901.                     (looking-at "^@noindent")) 
  1902.     (forward-line -1)
  1903.     (delete-region (point) (progn (forward-line 1) (point))))
  1904.    ;; do nothing if "asis"
  1905.    ((equal texinfo-paragraph-indent "asis"))
  1906.    ;; do no indenting in list, etc.
  1907.    ((> texinfo-stack-depth 0))   
  1908.    ;; otherwise delete existing whitespace and indent
  1909.    (t 
  1910.     (delete-region (point) (progn (skip-chars-forward " \t") (point)))
  1911.     (insert (make-string texinfo-paragraph-indent ? ))))
  1912.   (forward-paragraph 1) 
  1913.   (forward-line -1)
  1914.   (end-of-line)
  1915.   ;; Do not fill a section title line with asterisks, hyphens, etc. that
  1916.   ;; are used to underline it.  This could occur if the line following
  1917.   ;; the underlining is not an index entry and has text within it.
  1918.   ;; XEmacs change: the standard 3.6 paragraph separators cause
  1919.   ;; texinfmt to fail on vm.texi so we continue to use the older version.
  1920.   (let* ((previous-paragraph-separate paragraph-separate)
  1921.          (paragraph-separate (concat paragraph-separate "\\|^[=*---.]+"))
  1922.          (previous-paragraph-start paragraph-start)
  1923.          (paragraph-start (concat paragraph-start "\\|^[=*---.]+")))
  1924.     (unwind-protect
  1925.         (fill-paragraph nil)
  1926.       (setq paragraph-separate previous-paragraph-separate)
  1927.       (setq paragraph-start previous-paragraph-start))))
  1928.  
  1929. (put 'noindent 'texinfo-format 'texinfo-noindent)
  1930. (defun texinfo-noindent ()  
  1931.   (save-excursion 
  1932.     (forward-paragraph 1)
  1933.     (if (search-backward "@refill"
  1934.                             (save-excursion (forward-line -1) (point)) t)
  1935.         () ; leave @noindent command so @refill command knows not to indent
  1936.       ;; else
  1937.       (texinfo-discard-line))))
  1938.  
  1939.  
  1940. ;;; Index generation
  1941.  
  1942. (put 'vindex 'texinfo-format 'texinfo-format-vindex)
  1943. (defun texinfo-format-vindex ()
  1944.   (texinfo-index 'texinfo-vindex))
  1945.  
  1946. (put 'cindex 'texinfo-format 'texinfo-format-cindex)
  1947. (defun texinfo-format-cindex ()
  1948.   (texinfo-index 'texinfo-cindex))
  1949.  
  1950. (put 'findex 'texinfo-format 'texinfo-format-findex)
  1951. (defun texinfo-format-findex ()
  1952.   (texinfo-index 'texinfo-findex))
  1953.  
  1954. (put 'pindex 'texinfo-format 'texinfo-format-pindex)
  1955. (defun texinfo-format-pindex ()
  1956.   (texinfo-index 'texinfo-pindex))
  1957.  
  1958. (put 'tindex 'texinfo-format 'texinfo-format-tindex)
  1959. (defun texinfo-format-tindex ()
  1960.   (texinfo-index 'texinfo-tindex))
  1961.  
  1962. (put 'kindex 'texinfo-format 'texinfo-format-kindex)
  1963. (defun texinfo-format-kindex ()
  1964.   (texinfo-index 'texinfo-kindex))
  1965.  
  1966. (defun texinfo-index (indexvar)
  1967.   (let ((arg (texinfo-parse-expanded-arg)))
  1968.     (texinfo-discard-command)
  1969.     (set indexvar
  1970.          (cons (list arg
  1971.                      texinfo-last-node
  1972.                      ;; Region formatting may not provide last node position.
  1973.                      (if texinfo-last-node-pos
  1974.                          (1+ (count-lines texinfo-last-node-pos (point)))
  1975.                        1))
  1976.                (symbol-value indexvar)))))
  1977.  
  1978. (defconst texinfo-indexvar-alist
  1979.   '(("cp" . texinfo-cindex)
  1980.     ("fn" . texinfo-findex)
  1981.     ("vr" . texinfo-vindex)
  1982.     ("tp" . texinfo-tindex)
  1983.     ("pg" . texinfo-pindex)
  1984.     ("ky" . texinfo-kindex)))
  1985.  
  1986.  
  1987. ;;; @defindex   @defcodeindex
  1988. (put 'defindex 'texinfo-format 'texinfo-format-defindex)
  1989. (put 'defcodeindex 'texinfo-format 'texinfo-format-defindex)
  1990.  
  1991. (defun texinfo-format-defindex ()
  1992.   (let* ((index-name (texinfo-parse-arg-discard)) ; eg: `aa'
  1993.          (indexing-command (intern (concat index-name "index")))
  1994.          (index-formatting-command      ; eg: `texinfo-format-aaindex'
  1995.           (intern (concat "texinfo-format-" index-name "index")))
  1996.          (index-alist-name              ; eg: `texinfo-aaindex'
  1997.           (intern (concat "texinfo-" index-name "index"))))
  1998.  
  1999.     (set index-alist-name nil)
  2000.  
  2001.     (put indexing-command               ; eg, aaindex
  2002.          'texinfo-format
  2003.          index-formatting-command)      ; eg, texinfo-format-aaindex
  2004.  
  2005.     ;; eg: "aa" . texinfo-aaindex
  2006.     (or (assoc index-name texinfo-indexvar-alist)
  2007.         (setq texinfo-indexvar-alist
  2008.               (cons
  2009.                (cons index-name
  2010.                      index-alist-name)
  2011.                texinfo-indexvar-alist)))
  2012.  
  2013.     (fset index-formatting-command
  2014.           (list 'lambda 'nil
  2015.                 (list 'texinfo-index 
  2016.                       (list 'quote index-alist-name))))))
  2017.  
  2018.  
  2019. ;;; @synindex   @syncodeindex
  2020.  
  2021. (put 'synindex 'texinfo-format 'texinfo-format-synindex)
  2022. (put 'syncodeindex 'texinfo-format 'texinfo-format-synindex)
  2023.  
  2024. (defun texinfo-format-synindex ()
  2025.   (let* ((args (texinfo-parse-arg-discard))
  2026.          (second (cdr (read-from-string args)))
  2027.          (joiner (symbol-name (car (read-from-string args))))
  2028.          (joined (symbol-name (car (read-from-string args second)))))
  2029.  
  2030.     (if (assoc joiner texinfo-short-index-cmds-alist)
  2031.         (put
  2032.           (cdr (assoc joiner texinfo-short-index-cmds-alist))
  2033.          'texinfo-format
  2034.          (or (cdr (assoc joined texinfo-short-index-format-cmds-alist))
  2035.              (intern (concat "texinfo-format-" joined "index"))))
  2036.       (put
  2037.        (intern (concat joiner "index"))
  2038.        'texinfo-format
  2039.        (or (cdr(assoc joined texinfo-short-index-format-cmds-alist))
  2040.            (intern (concat "texinfo-format-" joined "index")))))))
  2041.  
  2042. (defconst texinfo-short-index-cmds-alist
  2043.   '(("cp" . cindex)
  2044.     ("fn" . findex)
  2045.     ("vr" . vindex)
  2046.     ("tp" . tindex)
  2047.     ("pg" . pindex)
  2048.     ("ky" . kindex)))
  2049.  
  2050. (defconst texinfo-short-index-format-cmds-alist
  2051.   '(("cp" . texinfo-format-cindex)
  2052.     ("fn" . texinfo-format-findex)
  2053.     ("vr" . texinfo-format-vindex)
  2054.     ("tp" . texinfo-format-tindex)
  2055.     ("pg" . texinfo-format-pindex)
  2056.     ("ky" . texinfo-format-kindex)))
  2057.  
  2058.  
  2059. ;;; Sort and index (for VMS)
  2060.  
  2061. ;; Sort an index which is in the current buffer between START and END.
  2062. ;; Used on VMS, where the `sort' utility is not available.
  2063. (defun texinfo-sort-region (start end)
  2064.   (require 'sort)
  2065.   (save-restriction
  2066.     (narrow-to-region start end)
  2067.     (sort-subr nil 'forward-line 'end-of-line 'texinfo-sort-startkeyfun)))
  2068.  
  2069. ;; Subroutine for sorting an index.
  2070. ;; At start of a line, return a string to sort the line under.
  2071. (defun texinfo-sort-startkeyfun ()
  2072.   (let ((line
  2073.          (buffer-substring (point) (save-excursion (end-of-line) (point)))))
  2074.     ;; Canonicalize whitespace and eliminate funny chars.
  2075.     (while (string-match "[ \t][ \t]+\\|[^a-z0-9 ]+" line)
  2076.       (setq line (concat (substring line 0 (match-beginning 0))
  2077.                          " "
  2078.                          (substring line (match-end 0) (length line)))))
  2079.     line))
  2080.  
  2081.  
  2082. ;;; @printindex
  2083.  
  2084. (put 'printindex 'texinfo-format 'texinfo-format-printindex)
  2085.  
  2086. (defun texinfo-format-printindex ()
  2087.   (let ((indexelts (symbol-value
  2088.                     (cdr (assoc (texinfo-parse-arg-discard)
  2089.                                 texinfo-indexvar-alist))))
  2090.         opoint)
  2091.     (insert "\n* Menu:\n\n")
  2092.     (setq opoint (point))
  2093.     (texinfo-print-index nil indexelts)
  2094.  
  2095.     (if (eq system-type 'vax-vms)
  2096.         (texinfo-sort-region opoint (point))
  2097.       (shell-command-on-region opoint (point) "sort -fd" 1))))
  2098.  
  2099. (defun texinfo-print-index (file indexelts)
  2100.   (while indexelts
  2101.     (if (stringp (car (car indexelts)))
  2102.         (progn
  2103.           (insert "* " (car (car indexelts)) ": " )
  2104.           (indent-to 32)
  2105.           (insert
  2106.            (if file (concat "(" file ")") "")
  2107.            (nth 1 (car indexelts)) ".")
  2108.           (indent-to 54)
  2109.           (insert
  2110.            (if (nth 2 (car indexelts))
  2111.                (format "  %d." (nth 2 (car indexelts)))
  2112.              "")
  2113.            "\n"))
  2114.       ;; index entries from @include'd file
  2115.       (texinfo-print-index (nth 1 (car indexelts))
  2116.                            (nth 2 (car indexelts))))
  2117.     (setq indexelts (cdr indexelts))))
  2118.  
  2119.  
  2120. ;;; Glyphs: @equiv, @error, etc
  2121.  
  2122. ;; @equiv           to show that two expressions are equivalent
  2123. ;; @error           to show an error message
  2124. ;; @expansion       to show what a macro expands to
  2125. ;; @point           to show the location of point in an example
  2126. ;; @print           to show what an evaluated expression prints
  2127. ;; @result          to indicate the value returned by an expression
  2128.  
  2129. (put 'equiv 'texinfo-format 'texinfo-format-equiv)
  2130. (defun texinfo-format-equiv ()
  2131.   (texinfo-parse-arg-discard)
  2132.   (insert "=="))
  2133.  
  2134. (put 'error 'texinfo-format 'texinfo-format-error)
  2135. (defun texinfo-format-error ()
  2136.   (texinfo-parse-arg-discard)
  2137.   (insert "error-->"))
  2138.  
  2139. (put 'expansion 'texinfo-format 'texinfo-format-expansion)
  2140. (defun texinfo-format-expansion ()
  2141.   (texinfo-parse-arg-discard)
  2142.   (insert "==>"))
  2143.  
  2144. (put 'point 'texinfo-format 'texinfo-format-point)
  2145. (defun texinfo-format-point ()
  2146.   (texinfo-parse-arg-discard)
  2147.   (insert "-!-"))
  2148.  
  2149. (put 'print 'texinfo-format 'texinfo-format-print)
  2150. (defun texinfo-format-print ()
  2151.   (texinfo-parse-arg-discard)
  2152.   (insert "-|"))
  2153.  
  2154. (put 'result 'texinfo-format 'texinfo-format-result)
  2155. (defun texinfo-format-result ()
  2156.   (texinfo-parse-arg-discard)
  2157.   (insert "=>"))
  2158.  
  2159.  
  2160. ;;; Definition formatting: @deffn, @defun, etc
  2161.  
  2162. ;; What definition formatting produces:
  2163. ;;
  2164. ;; @deffn category name args...
  2165. ;;     In Info, `Category: name ARGS'
  2166. ;;     In index: name:  node. line#.
  2167. ;;
  2168. ;; @defvr category name 
  2169. ;;     In Info, `Category: name'
  2170. ;;     In index: name:  node. line#.
  2171. ;;
  2172. ;; @deftp category name attributes...
  2173. ;; `category name attributes...'       Note: @deftp args in lower case.
  2174. ;;     In index: name:  node. line#.
  2175. ;;
  2176. ;; Specialized function-like or variable-like entity:
  2177. ;;
  2178. ;; @defun, @defmac, @defspec, @defvar, @defopt
  2179. ;;
  2180. ;; @defun name args           In Info, `Function: name ARGS'
  2181. ;; @defmac name args          In Info, `Macro: name ARGS'
  2182. ;; @defvar name               In Info, `Variable: name'
  2183. ;; etc.
  2184. ;;     In index: name:  node. line#.
  2185. ;;
  2186. ;; Generalized typed-function-like or typed-variable-like entity:
  2187. ;; @deftypefn category data-type name args...
  2188. ;;     In Info, `Category:  data-type name args...'
  2189. ;; @deftypevr category data-type name 
  2190. ;;     In Info, `Category:  data-type name'
  2191. ;;     In index: name:  node. line#.
  2192. ;;
  2193. ;; Specialized typed-function-like or typed-variable-like entity:
  2194. ;; @deftypefun data-type name args...
  2195. ;;     In Info, `Function:  data-type name ARGS'
  2196. ;;     In index: name:  node. line#.   
  2197. ;;
  2198. ;; @deftypevar data-type name 
  2199. ;;     In Info, `Variable:  data-type name'
  2200. ;;     In index: name:  node. line#.   but include args after name!?
  2201. ;;
  2202. ;; Generalized object oriented entity: 
  2203. ;; @defop category class name args...
  2204. ;;     In Info, `Category on class: name ARG'
  2205. ;;     In index: name on class: node. line#.
  2206. ;;
  2207. ;; @defcv category class name         
  2208. ;;     In Info, `Category of class: name'
  2209. ;;     In index: name of class: node. line#.
  2210. ;;
  2211. ;; Specialized object oriented entity:
  2212. ;; @defmethod class name args... 
  2213. ;;     In Info, `Method on class: name ARGS'
  2214. ;;     In index: name on class: node. line#.
  2215. ;;
  2216. ;; @defivar class name
  2217. ;;     In Info, `Instance variable of class: name'
  2218. ;;     In index: name of class: node. line#.
  2219.  
  2220.  
  2221. ;;; The definition formatting functions
  2222.  
  2223. (defun texinfo-format-defun ()
  2224.   (texinfo-push-stack 'defun nil)
  2225.   (setq fill-column (- fill-column 5))
  2226.   (texinfo-format-defun-1 t))
  2227.  
  2228. (defun texinfo-end-defun ()
  2229.   (setq fill-column (+ fill-column 5))
  2230.   (texinfo-discard-command)
  2231.   (let ((start (nth 1 (texinfo-pop-stack 'defun))))
  2232.     (texinfo-do-itemize start)
  2233.     ;; Delete extra newline inserted after header.
  2234.     (save-excursion
  2235.       (goto-char start)
  2236.       (delete-char -1))))
  2237.  
  2238. (defun texinfo-format-defunx ()
  2239.   (texinfo-format-defun-1 nil))
  2240.  
  2241. (defun texinfo-format-defun-1 (first-p)
  2242.   (let ((parse-args (texinfo-format-parse-defun-args))
  2243.         (texinfo-defun-type (get texinfo-command-name 'texinfo-defun-type)))
  2244.     (texinfo-discard-command)
  2245.     ;; Delete extra newline inserted after previous header line.
  2246.     (if (not first-p)
  2247.         (delete-char -1))
  2248.     (funcall
  2249.      (get texinfo-command-name 'texinfo-deffn-formatting-property) parse-args)
  2250.     ;; Insert extra newline so that paragraph filling does not mess
  2251.     ;; with header line.
  2252.     (insert "\n\n")
  2253.     (rplaca (cdr (cdr (car texinfo-stack))) (point))
  2254.     (funcall
  2255.      (get texinfo-command-name 'texinfo-defun-indexing-property) parse-args)))
  2256.  
  2257. ;;; Formatting the first line of a definition
  2258.  
  2259. ;; @deffn, @defvr, @deftp
  2260. (put 'deffn 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2261. (put 'deffnx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2262. (put 'defvr 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2263. (put 'defvrx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2264. (put 'deftp 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2265. (put 'deftpx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  2266. (defun texinfo-format-deffn (parsed-args)
  2267.   ;; Generalized function-like, variable-like, or generic data-type entity:
  2268.   ;; @deffn category name args...
  2269.   ;;     In Info, `Category: name ARGS'
  2270.   ;; @deftp category name attributes...
  2271.   ;; `category name attributes...'       Note: @deftp args in lower case.
  2272.   (let ((category (car parsed-args))
  2273.         (name (car (cdr parsed-args)))
  2274.         (args (cdr (cdr parsed-args))))
  2275.     (insert " -- " category ": " name)
  2276.     (while args
  2277.       (insert " "
  2278.               (if (or (= ?& (aref (car args) 0))
  2279.                       (eq (eval (car texinfo-defun-type)) 'deftp-type))
  2280.                   (car args)
  2281.                 (upcase (car args))))
  2282.       (setq args (cdr args)))))
  2283.  
  2284. ;; @defun, @defmac, @defspec, @defvar, @defopt: Specialized, simple
  2285. (put 'defun 'texinfo-deffn-formatting-property
  2286.      'texinfo-format-specialized-defun)
  2287. (put 'defunx 'texinfo-deffn-formatting-property
  2288.      'texinfo-format-specialized-defun)
  2289. (put 'defmac 'texinfo-deffn-formatting-property
  2290.      'texinfo-format-specialized-defun)
  2291. (put 'defmacx 'texinfo-deffn-formatting-property
  2292.      'texinfo-format-specialized-defun)
  2293. (put 'defspec 'texinfo-deffn-formatting-property
  2294.      'texinfo-format-specialized-defun)
  2295. (put 'defspecx 'texinfo-deffn-formatting-property
  2296.      'texinfo-format-specialized-defun)
  2297. (put 'defvar 'texinfo-deffn-formatting-property
  2298.      'texinfo-format-specialized-defun)
  2299. (put 'defvarx 'texinfo-deffn-formatting-property
  2300.      'texinfo-format-specialized-defun)
  2301. (put 'defopt 'texinfo-deffn-formatting-property
  2302.      'texinfo-format-specialized-defun)
  2303. (put 'defoptx 'texinfo-deffn-formatting-property
  2304.      'texinfo-format-specialized-defun)
  2305. (defun texinfo-format-specialized-defun (parsed-args)
  2306.   ;; Specialized function-like or variable-like entity:
  2307.   ;; @defun name args           In Info, `Function: Name ARGS'
  2308.   ;; @defmac name args          In Info, `Macro: Name ARGS'
  2309.   ;; @defvar name               In Info, `Variable: Name'
  2310.   ;; Use cdr of texinfo-defun-type to determine category:
  2311.   (let ((category (car (cdr texinfo-defun-type)))
  2312.         (name (car parsed-args))
  2313.         (args (cdr parsed-args)))
  2314.     (insert " -- " category ": " name)
  2315.     (while args
  2316.       (insert " "
  2317.               (if (= ?& (aref (car args) 0))
  2318.                   (car args)
  2319.                 (upcase (car args))))
  2320.       (setq args (cdr args)))))
  2321.  
  2322. ;; @deftypefn, @deftypevr: Generalized typed
  2323. (put 'deftypefn 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2324. (put 'deftypefnx 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2325. (put 'deftypevr 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2326. (put 'deftypevrx 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2327. (defun texinfo-format-deftypefn (parsed-args)
  2328.   ;; Generalized typed-function-like or typed-variable-like entity:
  2329.   ;; @deftypefn category data-type name args...
  2330.   ;;     In Info, `Category:  data-type name args...'
  2331.   ;; @deftypevr category data-type name 
  2332.   ;;     In Info, `Category:  data-type name'
  2333.   ;; Note: args in lower case, unless modified in command line.
  2334.   (let ((category (car parsed-args))
  2335.         (data-type (car (cdr parsed-args)))
  2336.         (name (car (cdr (cdr parsed-args))))
  2337.         (args (cdr (cdr (cdr parsed-args)))))
  2338.     (insert " -- " category ": " data-type " " name)
  2339.     (while args
  2340.       (insert " " (car args))
  2341.       (setq args (cdr args)))))
  2342.  
  2343. ;; @deftypefun, @deftypevar: Specialized typed
  2344. (put 'deftypefun 'texinfo-deffn-formatting-property 'texinfo-format-deftypefun)
  2345. (put 'deftypefunx 'texinfo-deffn-formatting-property
  2346.      'texinfo-format-deftypefun)
  2347. (put 'deftypevar 'texinfo-deffn-formatting-property 'texinfo-format-deftypefun)
  2348. (put 'deftypevarx 'texinfo-deffn-formatting-property
  2349.      'texinfo-format-deftypefun)
  2350. (defun texinfo-format-deftypefun (parsed-args)
  2351.   ;; Specialized typed-function-like or typed-variable-like entity:
  2352.   ;; @deftypefun data-type name args...
  2353.   ;;     In Info, `Function:  data-type name ARGS'
  2354.   ;; @deftypevar data-type name 
  2355.   ;;     In Info, `Variable:  data-type name'
  2356.   ;; Note: args in lower case, unless modified in command line.
  2357.   ;; Use cdr of texinfo-defun-type to determine category:
  2358.   (let ((category (car (cdr texinfo-defun-type)))
  2359.         (data-type (car parsed-args))
  2360.         (name (car (cdr  parsed-args)))
  2361.         (args (cdr (cdr parsed-args))))
  2362.     (insert " -- " category ": " data-type " " name)
  2363.     (while args
  2364.       (insert " " (car args))
  2365.       (setq args (cdr args)))))
  2366.  
  2367. ;; @defop: Generalized object-oriented
  2368. (put 'defop 'texinfo-deffn-formatting-property 'texinfo-format-defop)
  2369. (put 'defopx 'texinfo-deffn-formatting-property 'texinfo-format-defop)
  2370. (defun texinfo-format-defop (parsed-args)
  2371.   ;; Generalized object oriented entity: 
  2372.   ;; @defop category class name args...
  2373.   ;;     In Info, `Category on class: name ARG'
  2374.   ;; Note: args in upper case; use of `on'
  2375.   (let ((category (car parsed-args))
  2376.         (class (car (cdr parsed-args)))
  2377.         (name (car (cdr (cdr parsed-args))))
  2378.         (args (cdr (cdr (cdr parsed-args)))))
  2379.     (insert " -- " category " on " class ": " name)
  2380.     (while args
  2381.       (insert " " (upcase (car args)))
  2382.       (setq args (cdr args)))))
  2383.  
  2384. ;; @defcv: Generalized object-oriented
  2385. (put 'defcv 'texinfo-deffn-formatting-property 'texinfo-format-defcv)
  2386. (put 'defcvx 'texinfo-deffn-formatting-property 'texinfo-format-defcv)
  2387. (defun texinfo-format-defcv (parsed-args)
  2388.   ;; Generalized object oriented entity: 
  2389.   ;; @defcv category class name         
  2390.   ;;     In Info, `Category of class: name'
  2391.   ;; Note: args in upper case; use of `of'
  2392.   (let ((category (car parsed-args))
  2393.         (class (car (cdr parsed-args)))
  2394.         (name (car (cdr (cdr parsed-args))))
  2395.         (args (cdr (cdr (cdr parsed-args)))))
  2396.     (insert " -- " category " of " class ": " name)
  2397.     (while args
  2398.       (insert " " (upcase (car args)))
  2399.       (setq args (cdr args)))))
  2400.  
  2401. ;; @defmethod: Specialized object-oriented
  2402. (put 'defmethod 'texinfo-deffn-formatting-property 'texinfo-format-defmethod)
  2403. (put 'defmethodx 'texinfo-deffn-formatting-property 'texinfo-format-defmethod)
  2404. (defun texinfo-format-defmethod (parsed-args)
  2405.   ;; Specialized object oriented entity:
  2406.   ;; @defmethod class name args... 
  2407.   ;;     In Info, `Method on class: name ARGS'
  2408.   ;; Note: args in upper case; use of `on'
  2409.   ;; Use cdr of texinfo-defun-type to determine category:
  2410.   (let ((category (car (cdr texinfo-defun-type)))
  2411.         (class (car parsed-args))
  2412.         (name (car (cdr  parsed-args)))
  2413.         (args (cdr  (cdr parsed-args))))
  2414.     (insert " -- " category " on " class ": " name)
  2415.     (while args
  2416.       (insert " " (upcase (car args)))
  2417.       (setq args (cdr args)))))
  2418.  
  2419. ;; @defivar: Specialized object-oriented
  2420. (put 'defivar 'texinfo-deffn-formatting-property 'texinfo-format-defivar)
  2421. (put 'defivarx 'texinfo-deffn-formatting-property 'texinfo-format-defivar)
  2422. (defun texinfo-format-defivar (parsed-args)
  2423.   ;; Specialized object oriented entity:
  2424.   ;; @defivar class name
  2425.   ;;     In Info, `Instance variable of class: name'
  2426.   ;; Note: args in upper case; use of `of'
  2427.   ;; Use cdr of texinfo-defun-type to determine category:
  2428.   (let ((category (car (cdr texinfo-defun-type)))
  2429.         (class (car parsed-args))
  2430.         (name (car (cdr  parsed-args)))
  2431.         (args (cdr  (cdr parsed-args))))
  2432.     (insert " -- " category " of " class ": " name)
  2433.     (while args
  2434.       (insert " " (upcase (car args)))
  2435.       (setq args (cdr args)))))
  2436.  
  2437.  
  2438. ;;; Indexing for definitions
  2439.  
  2440. ;; An index entry has three parts: the `entry proper', the node name, and the
  2441. ;; line number.  Depending on the which command is used, the entry is
  2442. ;; formatted differently:
  2443. ;;
  2444. ;; @defun, 
  2445. ;; @defmac, 
  2446. ;; @defspec, 
  2447. ;; @defvar, 
  2448. ;; @defopt          all use their 1st argument as the entry-proper 
  2449. ;;
  2450. ;; @deffn, 
  2451. ;; @defvr, 
  2452. ;; @deftp 
  2453. ;; @deftypefun
  2454. ;; @deftypevar      all use their 2nd argument as the entry-proper
  2455. ;;
  2456. ;; @deftypefn, 
  2457. ;; @deftypevr       both use their 3rd argument as the entry-proper  
  2458. ;;
  2459. ;; @defmethod       uses its 2nd and 1st arguments as an entry-proper 
  2460. ;;                    formatted: NAME on CLASS
  2461.  
  2462. ;; @defop           uses its 3rd and 2nd arguments as an entry-proper 
  2463. ;;                    formatted: NAME on CLASS
  2464. ;;        
  2465. ;; @defivar         uses its 2nd and 1st arguments as an entry-proper
  2466. ;;                    formatted: NAME of CLASS
  2467. ;;
  2468. ;; @defcv           uses its 3rd and 2nd argument as an entry-proper
  2469. ;;                    formatted: NAME of CLASS
  2470.  
  2471. (put 'defun 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2472. (put 'defunx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2473. (put 'defmac 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2474. (put 'defmacx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2475. (put 'defspec 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2476. (put 'defspecx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2477. (put 'defvar 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2478. (put 'defvarx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2479. (put 'defopt  'texinfo-defun-indexing-property 'texinfo-index-defun)
  2480. (put 'defoptx  'texinfo-defun-indexing-property 'texinfo-index-defun)
  2481. (defun texinfo-index-defun (parsed-args)
  2482.   ;; use 1st parsed-arg  as entry-proper
  2483.   ;; `index-list' will be texinfo-findex or the like
  2484.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2485.     (set index-list
  2486.          (cons 
  2487.           ;; Three elements: entry-proper, node-name, line-number
  2488.           (list
  2489.            (car parsed-args)
  2490.            texinfo-last-node
  2491.            ;; Region formatting may not provide last node position.
  2492.            (if texinfo-last-node-pos
  2493.                (1+ (count-lines texinfo-last-node-pos (point)))
  2494.              1))
  2495.           (symbol-value index-list)))))
  2496.  
  2497. (put 'deffn 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2498. (put 'deffnx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2499. (put 'defvr 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2500. (put 'defvrx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2501. (put 'deftp 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2502. (put 'deftpx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2503. (put 'deftypefun 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2504. (put 'deftypefunx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2505. (put 'deftypevar 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2506. (put 'deftypevarx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2507. (defun texinfo-index-deffn (parsed-args) 
  2508.  ;; use 2nd parsed-arg  as entry-proper
  2509.   ;; `index-list' will be texinfo-findex or the like
  2510.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2511.     (set index-list
  2512.          (cons 
  2513.           ;; Three elements: entry-proper, node-name, line-number
  2514.           (list
  2515.            (car (cdr parsed-args))
  2516.            texinfo-last-node
  2517.            ;; Region formatting may not provide last node position.
  2518.            (if texinfo-last-node-pos
  2519.                (1+ (count-lines texinfo-last-node-pos (point)))
  2520.              1))
  2521.           (symbol-value index-list)))))
  2522.  
  2523. (put 'deftypefn 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2524. (put 'deftypefnx 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2525. (put 'deftypevr 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2526. (put 'deftypevrx 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2527. (defun texinfo-index-deftypefn (parsed-args)
  2528.   ;; use 3rd parsed-arg  as entry-proper
  2529.   ;; `index-list' will be texinfo-findex or the like
  2530.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2531.     (set index-list
  2532.          (cons 
  2533.           ;; Three elements: entry-proper, node-name, line-number
  2534.           (list
  2535.            (car (cdr (cdr parsed-args)))
  2536.            texinfo-last-node
  2537.            ;; Region formatting may not provide last node position.
  2538.            (if texinfo-last-node-pos
  2539.                (1+ (count-lines texinfo-last-node-pos (point)))
  2540.              1))
  2541.           (symbol-value index-list)))))
  2542.  
  2543. (put 'defmethod 'texinfo-defun-indexing-property 'texinfo-index-defmethod)
  2544. (put 'defmethodx 'texinfo-defun-indexing-property 'texinfo-index-defmethod)
  2545. (defun texinfo-index-defmethod (parsed-args)
  2546.   ;; use 2nd on 1st parsed-arg  as entry-proper
  2547.   ;; `index-list' will be texinfo-findex or the like
  2548.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2549.     (set index-list
  2550.          (cons 
  2551.           ;; Three elements: entry-proper, node-name, line-number
  2552.           (list
  2553.            (format "%s on %s"            
  2554.                    (car (cdr parsed-args))
  2555.                    (car parsed-args))
  2556.            texinfo-last-node
  2557.            ;; Region formatting may not provide last node position.
  2558.            (if texinfo-last-node-pos
  2559.                (1+ (count-lines texinfo-last-node-pos (point)))
  2560.              1))
  2561.           (symbol-value index-list)))))
  2562.  
  2563. (put 'defop 'texinfo-defun-indexing-property 'texinfo-index-defop)
  2564. (put 'defopx 'texinfo-defun-indexing-property 'texinfo-index-defop)
  2565. (defun texinfo-index-defop (parsed-args)
  2566.   ;; use 3rd on 2nd parsed-arg  as entry-proper
  2567.   ;; `index-list' will be texinfo-findex or the like
  2568.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2569.     (set index-list
  2570.          (cons 
  2571.           ;; Three elements: entry-proper, node-name, line-number
  2572.           (list
  2573.            (format "%s on %s"            
  2574.                    (car (cdr (cdr parsed-args)))
  2575.                    (car (cdr parsed-args)))
  2576.            texinfo-last-node
  2577.            ;; Region formatting may not provide last node position.
  2578.            (if texinfo-last-node-pos
  2579.                (1+ (count-lines texinfo-last-node-pos (point)))
  2580.              1))
  2581.           (symbol-value index-list)))))
  2582.  
  2583. (put 'defivar 'texinfo-defun-indexing-property 'texinfo-index-defivar)
  2584. (put 'defivarx 'texinfo-defun-indexing-property 'texinfo-index-defivar)
  2585. (defun texinfo-index-defivar (parsed-args)
  2586.   ;; use 2nd of 1st parsed-arg  as entry-proper
  2587.   ;; `index-list' will be texinfo-findex or the like
  2588.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2589.     (set index-list
  2590.          (cons 
  2591.           ;; Three elements: entry-proper, node-name, line-number
  2592.           (list
  2593.            (format "%s of %s"            
  2594.                    (car (cdr parsed-args))
  2595.                    (car parsed-args))
  2596.            texinfo-last-node
  2597.            ;; Region formatting may not provide last node position.
  2598.            (if texinfo-last-node-pos
  2599.                (1+ (count-lines texinfo-last-node-pos (point)))
  2600.              1))
  2601.           (symbol-value index-list)))))
  2602.  
  2603. (put 'defcv 'texinfo-defun-indexing-property 'texinfo-index-defcv)
  2604. (put 'defcvx 'texinfo-defun-indexing-property 'texinfo-index-defcv)
  2605. (defun texinfo-index-defcv (parsed-args)
  2606.   ;; use 3rd of 2nd parsed-arg  as entry-proper
  2607.   ;; `index-list' will be texinfo-findex or the like
  2608.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2609.     (set index-list
  2610.          (cons 
  2611.           ;; Three elements: entry-proper, node-name, line-number
  2612.           (list
  2613.            (format "%s of %s"            
  2614.                    (car (cdr (cdr parsed-args)))
  2615.                    (car (cdr parsed-args)))
  2616.            texinfo-last-node
  2617.            ;; Region formatting may not provide last node position.
  2618.            (if texinfo-last-node-pos
  2619.                (1+ (count-lines texinfo-last-node-pos (point)))
  2620.              1))
  2621.           (symbol-value index-list)))))
  2622.  
  2623.  
  2624. ;;; Properties for definitions
  2625.  
  2626. ;; Each definition command has six properties:
  2627. ;;
  2628. ;; 1. texinfo-deffn-formatting-property      to format definition line
  2629. ;; 2. texinfo-defun-indexing-property        to create index entry
  2630. ;; 3. texinfo-format                         formatting command
  2631. ;; 4. texinfo-end                            end formatting command
  2632. ;; 5. texinfo-defun-type                     type of deffn to format
  2633. ;; 6. texinfo-defun-index                    type of index to use
  2634. ;;
  2635. ;; The `x' forms of each definition command are used for the second
  2636. ;; and subsequent header lines.
  2637.  
  2638. ;; The texinfo-deffn-formatting-property and texinfo-defun-indexing-property
  2639. ;; are listed just before the appropriate formatting and indexing commands.
  2640.  
  2641. (put 'deffn 'texinfo-format 'texinfo-format-defun)
  2642. (put 'deffnx 'texinfo-format 'texinfo-format-defunx)
  2643. (put 'deffn 'texinfo-end 'texinfo-end-defun)
  2644. (put 'deffn 'texinfo-defun-type '('deffn-type nil))
  2645. (put 'deffnx 'texinfo-defun-type '('deffn-type nil))
  2646. (put 'deffn 'texinfo-defun-index 'texinfo-findex)
  2647. (put 'deffnx 'texinfo-defun-index 'texinfo-findex)
  2648.  
  2649. (put 'defun 'texinfo-format 'texinfo-format-defun)
  2650. (put 'defunx 'texinfo-format 'texinfo-format-defunx)
  2651. (put 'defun 'texinfo-end 'texinfo-end-defun)
  2652. (put 'defun 'texinfo-defun-type '('defun-type "Function"))
  2653. (put 'defunx 'texinfo-defun-type '('defun-type "Function"))
  2654. (put 'defun 'texinfo-defun-index 'texinfo-findex)
  2655. (put 'defunx 'texinfo-defun-index 'texinfo-findex)
  2656.  
  2657. (put 'defmac 'texinfo-format 'texinfo-format-defun)
  2658. (put 'defmacx 'texinfo-format 'texinfo-format-defunx)
  2659. (put 'defmac 'texinfo-end 'texinfo-end-defun)
  2660. (put 'defmac 'texinfo-defun-type '('defun-type "Macro"))
  2661. (put 'defmacx 'texinfo-defun-type '('defun-type "Macro"))
  2662. (put 'defmac 'texinfo-defun-index 'texinfo-findex)
  2663. (put 'defmacx 'texinfo-defun-index 'texinfo-findex)
  2664.  
  2665. (put 'defspec 'texinfo-format 'texinfo-format-defun)
  2666. (put 'defspecx 'texinfo-format 'texinfo-format-defunx)
  2667. (put 'defspec 'texinfo-end 'texinfo-end-defun)
  2668. (put 'defspec 'texinfo-defun-type '('defun-type "Special form"))
  2669. (put 'defspecx 'texinfo-defun-type '('defun-type "Special form"))
  2670. (put 'defspec 'texinfo-defun-index 'texinfo-findex)
  2671. (put 'defspecx 'texinfo-defun-index 'texinfo-findex)
  2672.  
  2673. (put 'defvr 'texinfo-format 'texinfo-format-defun)
  2674. (put 'defvrx 'texinfo-format 'texinfo-format-defunx)
  2675. (put 'defvr 'texinfo-end 'texinfo-end-defun)
  2676. (put 'defvr 'texinfo-defun-type '('deffn-type nil))
  2677. (put 'defvrx 'texinfo-defun-type '('deffn-type nil))
  2678. (put 'defvr 'texinfo-defun-index 'texinfo-vindex)
  2679. (put 'defvrx 'texinfo-defun-index 'texinfo-vindex)
  2680.  
  2681. (put 'defvar 'texinfo-format 'texinfo-format-defun)
  2682. (put 'defvarx 'texinfo-format 'texinfo-format-defunx)
  2683. (put 'defvar 'texinfo-end 'texinfo-end-defun)
  2684. (put 'defvar 'texinfo-defun-type '('defun-type "Variable"))
  2685. (put 'defvarx 'texinfo-defun-type '('defun-type "Variable"))
  2686. (put 'defvar 'texinfo-defun-index 'texinfo-vindex)
  2687. (put 'defvarx 'texinfo-defun-index 'texinfo-vindex)
  2688.  
  2689. (put 'defconst 'texinfo-format 'texinfo-format-defun)
  2690. (put 'defconstx 'texinfo-format 'texinfo-format-defunx)
  2691. (put 'defconst 'texinfo-end 'texinfo-end-defun)
  2692. (put 'defconst 'texinfo-defun-type '('defun-type "Constant"))
  2693. (put 'defconstx 'texinfo-defun-type '('defun-type "Constant"))
  2694. (put 'defconst 'texinfo-defun-index 'texinfo-vindex)
  2695. (put 'defconstx 'texinfo-defun-index 'texinfo-vindex)
  2696.  
  2697. (put 'defcmd 'texinfo-format 'texinfo-format-defun)
  2698. (put 'defcmdx 'texinfo-format 'texinfo-format-defunx)
  2699. (put 'defcmd 'texinfo-end 'texinfo-end-defun)
  2700. (put 'defcmd 'texinfo-defun-type '('defun-type "Command"))
  2701. (put 'defcmdx 'texinfo-defun-type '('defun-type "Command"))
  2702. (put 'defcmd 'texinfo-defun-index 'texinfo-findex)
  2703. (put 'defcmdx 'texinfo-defun-index 'texinfo-findex)
  2704.  
  2705. (put 'defopt 'texinfo-format 'texinfo-format-defun)
  2706. (put 'defoptx 'texinfo-format 'texinfo-format-defunx)
  2707. (put 'defopt 'texinfo-end 'texinfo-end-defun)
  2708. (put 'defopt 'texinfo-defun-type '('defun-type "User Option"))
  2709. (put 'defoptx 'texinfo-defun-type '('defun-type "User Option"))
  2710. (put 'defopt 'texinfo-defun-index 'texinfo-vindex)
  2711. (put 'defoptx 'texinfo-defun-index 'texinfo-vindex)
  2712.  
  2713. (put 'deftp 'texinfo-format 'texinfo-format-defun)
  2714. (put 'deftpx 'texinfo-format 'texinfo-format-defunx)
  2715. (put 'deftp 'texinfo-end 'texinfo-end-defun)
  2716. (put 'deftp 'texinfo-defun-type '('deftp-type nil))
  2717. (put 'deftpx 'texinfo-defun-type '('deftp-type nil))
  2718. (put 'deftp 'texinfo-defun-index 'texinfo-tindex)
  2719. (put 'deftpx 'texinfo-defun-index 'texinfo-tindex)
  2720.  
  2721. ;;; Object-oriented stuff is a little hairier.
  2722.  
  2723. (put 'defop 'texinfo-format 'texinfo-format-defun)
  2724. (put 'defopx 'texinfo-format 'texinfo-format-defunx)
  2725. (put 'defop 'texinfo-end 'texinfo-end-defun)
  2726. (put 'defop 'texinfo-defun-type '('defop-type nil))
  2727. (put 'defopx 'texinfo-defun-type '('defop-type nil))
  2728. (put 'defop 'texinfo-defun-index 'texinfo-findex)
  2729. (put 'defopx 'texinfo-defun-index 'texinfo-findex)
  2730.  
  2731. (put 'defmethod 'texinfo-format 'texinfo-format-defun)
  2732. (put 'defmethodx 'texinfo-format 'texinfo-format-defunx)
  2733. (put 'defmethod 'texinfo-end 'texinfo-end-defun)
  2734. (put 'defmethod 'texinfo-defun-type '('defmethod-type "Method"))
  2735. (put 'defmethodx 'texinfo-defun-type '('defmethod-type "Method"))
  2736. (put 'defmethod 'texinfo-defun-index 'texinfo-findex)
  2737. (put 'defmethodx 'texinfo-defun-index 'texinfo-findex)
  2738.  
  2739. (put 'defcv 'texinfo-format 'texinfo-format-defun)
  2740. (put 'defcvx 'texinfo-format 'texinfo-format-defunx)
  2741. (put 'defcv 'texinfo-end 'texinfo-end-defun)
  2742. (put 'defcv 'texinfo-defun-type '('defop-type nil))
  2743. (put 'defcvx 'texinfo-defun-type '('defop-type nil))
  2744. (put 'defcv 'texinfo-defun-index 'texinfo-vindex)
  2745. (put 'defcvx 'texinfo-defun-index 'texinfo-vindex)
  2746.  
  2747. (put 'defivar 'texinfo-format 'texinfo-format-defun)
  2748. (put 'defivarx 'texinfo-format 'texinfo-format-defunx)
  2749. (put 'defivar 'texinfo-end 'texinfo-end-defun)
  2750. (put 'defivar 'texinfo-defun-type '('defmethod-type "Instance variable"))
  2751. (put 'defivarx 'texinfo-defun-type '('defmethod-type "Instance variable"))
  2752. (put 'defivar 'texinfo-defun-index 'texinfo-vindex)
  2753. (put 'defivarx 'texinfo-defun-index 'texinfo-vindex)
  2754.  
  2755. ;;; Typed functions and variables
  2756.  
  2757. (put 'deftypefn 'texinfo-format 'texinfo-format-defun)
  2758. (put 'deftypefnx 'texinfo-format 'texinfo-format-defunx)
  2759. (put 'deftypefn 'texinfo-end 'texinfo-end-defun)
  2760. (put 'deftypefn 'texinfo-defun-type '('deftypefn-type nil))
  2761. (put 'deftypefnx 'texinfo-defun-type '('deftypefn-type nil))
  2762. (put 'deftypefn 'texinfo-defun-index 'texinfo-findex)
  2763. (put 'deftypefnx 'texinfo-defun-index 'texinfo-findex)
  2764.  
  2765. (put 'deftypefun 'texinfo-format 'texinfo-format-defun)
  2766. (put 'deftypefunx 'texinfo-format 'texinfo-format-defunx)
  2767. (put 'deftypefun 'texinfo-end 'texinfo-end-defun)
  2768. (put 'deftypefun 'texinfo-defun-type '('deftypefun-type "Function"))
  2769. (put 'deftypefunx 'texinfo-defun-type '('deftypefun-type "Function"))
  2770. (put 'deftypefun 'texinfo-defun-index 'texinfo-findex)
  2771. (put 'deftypefunx 'texinfo-defun-index 'texinfo-findex)
  2772.  
  2773. (put 'deftypevr 'texinfo-format 'texinfo-format-defun)
  2774. (put 'deftypevrx 'texinfo-format 'texinfo-format-defunx)
  2775. (put 'deftypevr 'texinfo-end 'texinfo-end-defun)
  2776. (put 'deftypevr 'texinfo-defun-type '('deftypefn-type nil))
  2777. (put 'deftypevrx 'texinfo-defun-type '('deftypefn-type nil))
  2778. (put 'deftypevr 'texinfo-defun-index 'texinfo-vindex)
  2779. (put 'deftypevrx 'texinfo-defun-index 'texinfo-vindex)
  2780.  
  2781. (put 'deftypevar 'texinfo-format 'texinfo-format-defun)
  2782. (put 'deftypevarx 'texinfo-format 'texinfo-format-defunx)
  2783. (put 'deftypevar 'texinfo-end 'texinfo-end-defun)
  2784. (put 'deftypevar 'texinfo-defun-type '('deftypevar-type "Variable"))
  2785. (put 'deftypevarx 'texinfo-defun-type '('deftypevar-type "Variable"))
  2786. (put 'deftypevar 'texinfo-defun-index 'texinfo-vindex)
  2787. (put 'deftypevarx 'texinfo-defun-index 'texinfo-vindex)
  2788.  
  2789.  
  2790. ;;; @set, @clear, @ifset, @ifclear
  2791.  
  2792. ;; If a flag is set with @set FLAG, then text between @ifset and @end
  2793. ;; ifset is formatted normally, but if the flag is is cleared with
  2794. ;; @clear FLAG, then the text is not formatted; it is ignored.
  2795.  
  2796. ;; If a flag is cleared with @clear FLAG, then text between @ifclear
  2797. ;; and @end ifclear is formatted normally, but if the flag is is set with
  2798. ;; @set FLAG, then the text is not formatted; it is ignored.  @ifclear
  2799. ;; is the opposite of @ifset.
  2800.  
  2801. ;; If a flag is set to a string with @set FLAG, 
  2802. ;; replace  @value{FLAG} with the string.
  2803. ;; If a flag with a value is cleared, 
  2804. ;; @value{FLAG} is invalid, 
  2805. ;; as if there had never been any @set FLAG previously.
  2806.  
  2807. (put 'clear 'texinfo-format 'texinfo-clear)
  2808. (defun texinfo-clear ()
  2809.   "Clear the value of the flag."
  2810.   (let* ((arg (texinfo-parse-arg-discard))
  2811.          (flag (car (read-from-string arg)))
  2812.          (value (substring arg (cdr (read-from-string arg)))))
  2813.     (put flag 'texinfo-whether-setp 'flag-cleared)
  2814.     (put flag 'texinfo-set-value "")))
  2815.  
  2816. (put 'set 'texinfo-format 'texinfo-set)
  2817. (defun texinfo-set ()
  2818.   "Set the value of the flag, optionally to a string.
  2819. The command  `@set foo This is a string.'
  2820. sets flag foo to the value: `This is a string.'
  2821. The command  `@value{foo}'  expands to the value."
  2822.   (let* ((arg (texinfo-parse-arg-discard))
  2823.          (flag (car (read-from-string arg)))
  2824.          (value (substring arg (cdr (read-from-string arg)))))
  2825.     (put flag 'texinfo-whether-setp 'flag-set)
  2826.     (put flag 'texinfo-set-value value)))
  2827.  
  2828. (put 'value 'texinfo-format 'texinfo-value)
  2829. (defun texinfo-value ()
  2830.   "Insert the string to which the flag is set.
  2831. The command  `@set foo This is a string.'
  2832. sets flag foo to the value: `This is a string.'
  2833. The command  `@value{foo}'  expands to the value."
  2834.   (let ((arg (texinfo-parse-arg-discard)))
  2835.     (cond ((and
  2836.             (eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2837.                 'flag-set)
  2838.             (get (car (read-from-string arg)) 'texinfo-set-value))
  2839.            (insert (get (car (read-from-string arg)) 'texinfo-set-value)))
  2840.           ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp) 
  2841.                'flag-cleared)
  2842.            (insert (format "{No value for \"%s\"}"  arg)))
  2843.           ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp) nil)
  2844.            (insert (format "{No value for \"%s\"}"  arg))))))
  2845.  
  2846. (put 'ifset 'texinfo-end 'texinfo-discard-command)
  2847. (put 'ifset 'texinfo-format 'texinfo-if-set)
  2848. (defun texinfo-if-set ()
  2849.   "If set, continue formatting; else do not format region up to @end ifset"
  2850.   (let ((arg (texinfo-parse-arg-discard)))
  2851.     (cond
  2852.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2853.           'flag-set)
  2854.       ;; Format the text (i.e., do not remove it); do nothing here.
  2855.       ())
  2856.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2857.           'flag-cleared)
  2858.       ;; Clear region (i.e., cause the text to be ignored).
  2859.       (delete-region texinfo-command-start
  2860.                        (progn (re-search-forward "@end ifset[ \t]*\n")
  2861.                               (point))))
  2862.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2863.           nil)
  2864.       ;; In this case flag is neither set nor cleared.  
  2865.       ;; Act as if set, i.e. do nothing.
  2866.       ()))))
  2867.  
  2868. (put 'ifclear 'texinfo-end 'texinfo-discard-command)
  2869. (put 'ifclear 'texinfo-format 'texinfo-if-clear)
  2870. (defun texinfo-if-clear ()
  2871.   "If clear, continue formatting; if set, do not format up to @end ifset"
  2872.   (let ((arg (texinfo-parse-arg-discard)))
  2873.     (cond
  2874.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2875.           'flag-set)
  2876.       ;; Clear region (i.e., cause the text to be ignored).
  2877.       (delete-region texinfo-command-start
  2878.                        (progn (re-search-forward "@end ifclear[ \t]*\n")
  2879.                               (point))))
  2880.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2881.           'flag-cleared)
  2882.       ;; Format the text (i.e., do not remove it); do nothing here.
  2883.       ())
  2884.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2885.           nil)
  2886.       ;; In this case flag is neither set nor cleared.  
  2887.       ;; Act as if clear, i.e. do nothing.
  2888.       ()))))
  2889.  
  2890.  
  2891. ;;; Process included files:  `@include' command
  2892.  
  2893. ;; Updated 19 October 1990
  2894. ;; In the original version, include files were ignored by Info but
  2895. ;; incorporated in to the printed manual.  To make references to the
  2896. ;; included file, the Texinfo source file has to refer to the included
  2897. ;; files using the `(filename)nodename' format for refering to other
  2898. ;; Info files.  Also, the included files had to be formatted on their
  2899. ;; own.  It was just like they were another file.
  2900.  
  2901. ;; Currently, include files are inserted into the buffer that is
  2902. ;; formatted for Info.  If large, the resulting info file is split and
  2903. ;; tagified.  For current include files to work, the master menu must
  2904. ;; refer to all the nodes, and the highest level nodes in the include
  2905. ;; files must have the correct next, prev, and up pointers.
  2906.  
  2907. ;; The included file may have an @setfilename and even an @settitle,
  2908. ;; but not an `\input texinfo' line.
  2909.  
  2910. ;; Updated 24 March 1993
  2911. ;; In order for @raisesections and @lowersections to work, included
  2912. ;; files must be inserted into the buffer holding the outer file
  2913. ;; before other Info formatting takes place.  So @include is no longer
  2914. ;; is treated like other @-commands.
  2915. (put 'include 'texinfo-format  'texinfo-format-noop)
  2916.  
  2917. ; Original definition:
  2918. ; (defun texinfo-format-include ()
  2919. ;   (let ((filename (texinfo-parse-arg-discard))
  2920. ;       (default-directory input-directory)
  2921. ;       subindex)
  2922. ;     (setq subindex
  2923. ;         (save-excursion
  2924. ;           (progn (find-file
  2925. ;                   (cond ((file-readable-p (concat filename ".texinfo"))
  2926. ;                          (concat filename ".texinfo"))
  2927. ;                         ((file-readable-p (concat filename ".texi"))
  2928. ;                          (concat filename ".texi"))
  2929. ;                         ((file-readable-p (concat filename ".tex"))
  2930. ;                          (concat filename ".tex"))
  2931. ;                         ((file-readable-p filename)
  2932. ;                          filename)
  2933. ;                         (t (error "@include'd file %s not found"
  2934. ;                                   filename))))
  2935. ;                  (texinfo-format-buffer-1))))
  2936. ;     (texinfo-subindex 'texinfo-vindex (car subindex) (nth 1 subindex))
  2937. ;     (texinfo-subindex 'texinfo-findex (car subindex) (nth 2 subindex))
  2938. ;     (texinfo-subindex 'texinfo-cindex (car subindex) (nth 3 subindex))
  2939. ;     (texinfo-subindex 'texinfo-pindex (car subindex) (nth 4 subindex))
  2940. ;     (texinfo-subindex 'texinfo-tindex (car subindex) (nth 5 subindex))
  2941. ;     (texinfo-subindex 'texinfo-kindex (car subindex) (nth 6 subindex))))
  2942. ;
  2943. ;(defun texinfo-subindex (indexvar file content)
  2944. ;  (set indexvar (cons (list 'recurse file content)
  2945. ;                      (symbol-value indexvar))))
  2946.  
  2947. ; Second definition:
  2948. ; (put 'include 'texinfo-format 'texinfo-format-include)
  2949. ; (defun texinfo-format-include ()
  2950. ;   (let ((filename (concat input-directory
  2951. ;                           (texinfo-parse-arg-discard)))
  2952. ;         (default-directory input-directory))
  2953. ;     (message "Reading: %s" filename)
  2954. ;     (save-excursion
  2955. ;       (save-restriction
  2956. ;         (narrow-to-region
  2957. ;          (point)
  2958. ;          (+ (point) (car (cdr (insert-file-contents filename)))))
  2959. ;         (goto-char (point-min))
  2960. ;         (texinfo-append-refill)
  2961. ;         (texinfo-format-convert (point-min) (point-max))))
  2962. ;     (setq last-input-buffer input-buffer)  ; to bypass setfilename
  2963. ;     ))
  2964.  
  2965.  
  2966. ;;; Numerous commands do nothing in Texinfo
  2967.  
  2968. ;; These commands are defined in texinfo.tex for printed output.
  2969.  
  2970. (put 'bye 'texinfo-format 'texinfo-discard-line)
  2971. (put 'c 'texinfo-format 'texinfo-discard-line-with-args)
  2972. (put 'comment 'texinfo-format 'texinfo-discard-line-with-args)
  2973. (put 'contents 'texinfo-format 'texinfo-discard-line-with-args)
  2974. (put 'finalout 'texinfo-format 'texinfo-discard-line)
  2975. (put 'group 'texinfo-end 'texinfo-discard-line-with-args)
  2976. (put 'group 'texinfo-format 'texinfo-discard-line-with-args)
  2977. (put 'headings 'texinfo-format 'texinfo-discard-line-with-args)
  2978. (put 'hsize 'texinfo-format 'texinfo-discard-line-with-args)
  2979. (put 'itemindent 'texinfo-format 'texinfo-discard-line-with-args)
  2980. (put 'lispnarrowing 'texinfo-format 'texinfo-discard-line-with-args)
  2981. (put 'need 'texinfo-format 'texinfo-discard-line-with-args)
  2982. (put 'nopara 'texinfo-format 'texinfo-discard-line-with-args)
  2983. (put 'page 'texinfo-format 'texinfo-discard-line-with-args)
  2984. (put 'parindent 'texinfo-format 'texinfo-discard-line-with-args)
  2985. (put 'setchapternewpage 'texinfo-format 'texinfo-discard-line-with-args)
  2986. (put 'setq 'texinfo-format 'texinfo-discard-line-with-args)
  2987. (put 'settitle 'texinfo-format 'texinfo-discard-line-with-args)
  2988. (put 'setx 'texinfo-format 'texinfo-discard-line-with-args)
  2989. (put 'shortcontents 'texinfo-format 'texinfo-discard-line-with-args)
  2990. (put 'shorttitlepage 'texinfo-format 'texinfo-discard-line-with-args)
  2991. (put 'smallbook 'texinfo-format 'texinfo-discard-line)
  2992. (put 'summarycontents 'texinfo-format 'texinfo-discard-line-with-args)
  2993.  
  2994.  
  2995. ;;; Some commands cannot be handled
  2996.  
  2997. (defun texinfo-unsupported ()
  2998.   (error "%s is not handled by texinfo"
  2999.          (buffer-substring texinfo-command-start texinfo-command-end)))
  3000.  
  3001. ;;; Batch formatting
  3002.  
  3003. ;;;###autoload
  3004. (defun batch-texinfo-format ()
  3005.   "Runs  texinfo-format-buffer  on the files remaining on the command line.
  3006. Must be used only with -batch, and kills emacs on completion.
  3007. Each file will be processed even if an error occurred previously.
  3008. For example, invoke
  3009.   \"emacs -batch -funcall batch-texinfo-format $docs/ ~/*.texinfo\"."
  3010.   (if (not noninteractive)
  3011.       (error "batch-texinfo-format may only be used -batch."))
  3012.   (let ((version-control t)
  3013.         (auto-save-default nil)
  3014.         (find-file-run-dired nil)
  3015.         (kept-old-versions 259259)
  3016.         (kept-new-versions 259259))
  3017.     (let ((error 0)
  3018.           file
  3019.           (files ()))
  3020.       (while command-line-args-left
  3021.         (setq file (expand-file-name (car command-line-args-left)))
  3022.         (cond ((not (file-exists-p file))
  3023.                (message ">> %s does not exist!" file)
  3024.                (setq error 1
  3025.                      command-line-args-left (cdr command-line-args-left)))
  3026.               ((file-directory-p file)
  3027.                (setq command-line-args-left
  3028.                      (nconc (directory-files file)
  3029.                             (cdr command-line-args-left))))
  3030.               (t
  3031.                (setq files (cons file files)
  3032.                      command-line-args-left (cdr command-line-args-left)))))
  3033.       (while files
  3034.         (setq file (car files)
  3035.               files (cdr files))
  3036.         (condition-case err
  3037.             (progn
  3038.               (if buffer-file-name (kill-buffer (current-buffer)))
  3039.               (find-file file)
  3040.               (buffer-disable-undo (current-buffer))
  3041.               (set-buffer-modified-p nil)
  3042.               (texinfo-mode)
  3043.               (message "texinfo formatting %s..." file)
  3044.               (texinfo-format-buffer nil)
  3045.               (if (buffer-modified-p)
  3046.                   (progn (message "Saving modified %s" (buffer-file-name))
  3047.                          (save-buffer))))
  3048.           (error
  3049.            (message ">> Error: %s" (prin1-to-string err))
  3050.            (message ">>  point at")
  3051.            (let ((s (buffer-substring (point)
  3052.                                       (min (+ (point) 100)
  3053.                                            (point-max))))
  3054.                  (tem 0))
  3055.              (while (setq tem (string-match "\n+" s tem))
  3056.                (setq s (concat (substring s 0 (match-beginning 0))
  3057.                                "\n>>  "
  3058.                                (substring s (match-end 0)))
  3059.                      tem (1+ tem)))
  3060.              (message ">>  %s" s))
  3061.            (setq error 1))))
  3062.       (kill-emacs error))))
  3063.  
  3064.  
  3065. ;;; Place `provide' at end of file.
  3066. (provide 'texinfmt)
  3067.  
  3068. ;;; texinfmt.el ends here.
  3069.