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