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