home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / lucid / lemacs-19.6 / lisp / packages / texinfmt.el < prev    next >
Encoding:
Text File  |  1992-06-29  |  55.6 KB  |  1,629 lines
  1. ;; Convert texinfo files to info files.
  2. ;; Copyright (C) 1985, 1986, 1988, 1990 Free Software Foundation, Inc.
  3.  
  4. ;; This file is part of GNU Emacs.
  5.  
  6. ;; GNU Emacs is free software; you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation; either version 1, or (at your option)
  9. ;; any later version.
  10.  
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. ;; GNU General Public License for more details.
  15.  
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  18. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19.  
  20. ;; Updated May 1990 to correspond, more or less, to version 2.8 of
  21. ;; texinfo.tex.  NOTE: texinfmt.el is being phased out; it is being
  22. ;; replaced by makeinfo.c, which is faster and provides better error
  23. ;; checking.  
  24. ;; Robert J. Chassell, bob@ai.mit.edu
  25.  
  26. (defvar texinfo-format-syntax-table nil)
  27.  
  28. (defvar texinfo-vindex)
  29. (defvar texinfo-findex)
  30. (defvar texinfo-cindex)
  31. (defvar texinfo-pindex)
  32. (defvar texinfo-tindex)
  33. (defvar texinfo-kindex)
  34. (defvar texinfo-last-node)
  35. (defvar texinfo-node-names)
  36.  
  37. (if texinfo-format-syntax-table
  38.     nil
  39.   (setq texinfo-format-syntax-table (make-syntax-table))
  40.   (modify-syntax-entry ?\" " " texinfo-format-syntax-table)
  41.   (modify-syntax-entry ?\\ " " texinfo-format-syntax-table)
  42.   (modify-syntax-entry ?@ "\\" texinfo-format-syntax-table)
  43.   (modify-syntax-entry ?\^q "\\" texinfo-format-syntax-table)
  44.   (modify-syntax-entry ?\[ "." texinfo-format-syntax-table)
  45.   (modify-syntax-entry ?\] "." texinfo-format-syntax-table)
  46.   (modify-syntax-entry ?\( "." texinfo-format-syntax-table)
  47.   (modify-syntax-entry ?\) "." texinfo-format-syntax-table)
  48.   (modify-syntax-entry ?{ "(}" texinfo-format-syntax-table)
  49.   (modify-syntax-entry ?} "){" texinfo-format-syntax-table)
  50.   (modify-syntax-entry ?\' "." texinfo-format-syntax-table))
  51.  
  52. (defun texinfo-format-buffer (&optional notagify)
  53.   "Process the current buffer as texinfo code, into an Info file.
  54. The Info file output is generated in a buffer visiting the Info file
  55. names specified in the @setfilename command.
  56.  
  57. Non-nil argument (prefix, if interactive) means don't make tag table
  58. and don't split the file if large.  You can use Info-tagify and
  59. Info-split to do these manually."
  60.   (interactive "P")
  61.   (let ((lastmessage "Formatting Info file..."))
  62.     (message lastmessage)
  63.     (texinfo-format-buffer-1)
  64.     (if notagify
  65.     nil
  66.       (if (> (buffer-size) 30000)
  67.       (progn
  68.         (message (setq lastmessage "Making tags table for Info file..."))
  69.         (Info-tagify)))
  70.       (if (> (buffer-size) 100000)
  71.       (progn
  72.         (message (setq lastmessage "Splitting Info file..."))
  73.         (Info-split))))
  74.     (message (concat lastmessage
  75.              (if (interactive-p) "done.  Now save it." "done.")))))
  76.  
  77.  
  78. (defun texinfo-format-buffer-1 ()
  79.   (let (texinfo-format-filename
  80.     texinfo-example-start
  81.     texinfo-command-start
  82.     texinfo-command-end
  83.     texinfo-command-name
  84.     texinfo-last-node
  85.     texinfo-vindex
  86.     texinfo-findex
  87.     texinfo-cindex
  88.     texinfo-pindex
  89.     texinfo-tindex
  90.     texinfo-kindex
  91.     texinfo-stack
  92.     texinfo-node-names
  93.     outfile
  94.     (fill-column fill-column)
  95.     (input-buffer (current-buffer))
  96.     (input-directory default-directory))
  97.     (save-excursion
  98.       (goto-char (point-min))
  99.       (search-forward "@setfilename")
  100.       (setq texinfo-command-end (point))
  101.       (setq outfile (texinfo-parse-line-arg)))
  102.     (find-file outfile)
  103.     (texinfo-mode)
  104.     (set-syntax-table texinfo-format-syntax-table)
  105.     (erase-buffer)
  106.     (insert-buffer-substring input-buffer)
  107.     (goto-char (point-min))
  108.     (search-forward "@setfilename")
  109.     (beginning-of-line)
  110.     (delete-region (point-min) (point))
  111.     ;; Remove @bye at end of file, if it is there.
  112.     (goto-char (point-max))
  113.     (if (search-backward "@bye" nil t)
  114.     (delete-region (point) (point-max)))
  115.     ;; Make sure buffer ends in a newline.
  116.     (or (= (preceding-char) ?\n)
  117.     (insert "\n"))
  118.     ;; Scan the whole buffer, converting to Info format.
  119.     (texinfo-format-scan)
  120.     ;; Return data for indices.
  121.     (goto-char (point-min))
  122.     (list outfile
  123.       texinfo-vindex texinfo-findex texinfo-cindex
  124.       texinfo-pindex texinfo-tindex texinfo-kindex)))
  125.  
  126. (defvar texinfo-region-buffer-name "*Info Region*"
  127.   "*Name of the temporary buffer used by \\[texinfo-format-region].")
  128.  
  129. (defun texinfo-format-region (region-beginning region-ending)
  130.   "Convert the current region of the Texinfo file to Info format.
  131. This lets you see what that part of the file will look like in Info.
  132. The command is bound to \\[texinfo-format-region].  The text that is
  133. converted to Info is stored in a temporary buffer."
  134.   (interactive "r")
  135.   (message "Converting region to Info format...")
  136.   (let (texinfo-command-start
  137.     texinfo-command-end
  138.     texinfo-command-name
  139.     texinfo-vindex
  140.     texinfo-findex
  141.     texinfo-cindex
  142.     texinfo-pindex
  143.     texinfo-tindex
  144.     texinfo-kindex
  145.     texinfo-stack
  146.     texinfo-format-filename
  147.     texinfo-example-start
  148.     texinfo-last-node
  149.     texinfo-node-names
  150.     (fill-column fill-column)
  151.     (input-buffer (current-buffer))
  152.     (input-directory default-directory)
  153.     filename-beginning
  154.     filename-ending)
  155.  
  156. ;;; Find a buffer to use.
  157.  
  158.     (switch-to-buffer (get-buffer-create texinfo-region-buffer-name))
  159.  
  160.     ;; Insert the region into the buffer.
  161.     (erase-buffer)
  162.  
  163.     (save-excursion
  164.       (set-buffer input-buffer)
  165.       (save-excursion
  166.     (save-restriction
  167.       (widen)
  168.       (goto-char (point-min))
  169.       ;; Initialize the buffer with the filename
  170.       ;; or else explain that a filename is needed.
  171.       (or (search-forward "@setfilename"
  172.                   (save-excursion (forward-line 100) (point)) t)
  173.           (error "The texinfo file needs a line saying: @setfilename <name>"))
  174.       (beginning-of-line)
  175.       (setq filename-beginning (point))
  176.       (forward-line 1)
  177.       (setq filename-ending (point)))))
  178.  
  179.     ;; Insert the @setfilename line into the buffer.
  180.     (insert-buffer-substring input-buffer
  181.                  (min filename-beginning region-beginning)  
  182.                  filename-ending)
  183.     
  184.     ;; Insert the region into the buffer.
  185.     (insert-buffer-substring input-buffer
  186.                  (max region-beginning filename-ending)
  187.                  region-ending)
  188.  
  189.     (texinfo-mode)
  190.  
  191.     ;; Install a syntax table useful for scanning command operands.
  192.     (set-syntax-table texinfo-format-syntax-table)
  193.     
  194.     ;; If the region includes the effective end of the data,
  195.     ;; discard everything after that.
  196.     (goto-char (point-max))
  197.     (if (re-search-backward "^@bye" nil t)
  198.     (delete-region (point) (point-max)))
  199.     ;; Make sure buffer ends in a newline.
  200.     (or (= (preceding-char) ?\n)
  201.     (insert "\n"))
  202.  
  203.     ;; Now convert for real.
  204.     (goto-char (point-min))
  205.     (texinfo-format-scan)
  206.     (goto-char (point-min)))
  207.  
  208.   (message "Done."))
  209.  
  210.  
  211. ;; Perform those texinfo-to-info conversions that apply to the whole input
  212. ;; uniformly.
  213. (defun texinfo-format-scan ()
  214.     ;; Convert left and right quotes to typewriter font quotes.
  215.     (goto-char (point-min))
  216.     (while (search-forward "``" nil t)
  217.       (replace-match "\""))
  218.     (goto-char (point-min))
  219.     (while (search-forward "''" nil t)
  220.       (replace-match "\""))
  221.     ;; Scan for @-commands.
  222.     (goto-char (point-min))
  223.     (while (search-forward "@" nil t)
  224.       (if (looking-at "[@{}'` *]")
  225.           ;; Handle a few special @-followed-by-one-char commands.
  226.           (if (= (following-char) ?*)
  227.               (progn
  228.                 ;; remove command
  229.                 (delete-region (1- (point)) (1+ (point)))
  230.                 ;; insert return if not at end of line;
  231.                 ;; else line is already broken.
  232.                 (if (not (= (following-char) ?\n))
  233.                     (insert ?\n)))      
  234.             ;; The other characters are simply quoted.  Delete the @.
  235.             (delete-char -1)
  236.             (forward-char 1))
  237.         ;; @ is followed by a command-word; find the end of the word.
  238.         (setq texinfo-command-start (1- (point)))
  239.         (if (= (char-syntax (following-char)) ?w)
  240.             (forward-word 1)
  241.           (forward-char 1))
  242.         (setq texinfo-command-end (point))
  243.         ;; Call the handler for this command.
  244.         (setq texinfo-command-name
  245.               (intern (buffer-substring (1+ texinfo-command-start)
  246.                                         texinfo-command-end)))
  247.         (let ((cmd (get texinfo-command-name 'texinfo-format)))
  248.           (if cmd (funcall cmd)
  249.             (texinfo-unsupported)))))
  250.     (cond (texinfo-stack
  251.            (goto-char (nth 2 (car texinfo-stack)))
  252.            (error "Unterminated @%s" (car (car texinfo-stack))))))
  253.  
  254. (put 'begin 'texinfo-format 'texinfo-format-begin)
  255. (defun texinfo-format-begin ()
  256.   (texinfo-format-begin-end 'texinfo-format))
  257.  
  258. (put 'end 'texinfo-format 'texinfo-format-end)
  259. (defun texinfo-format-end ()
  260.   (texinfo-format-begin-end 'texinfo-end))
  261.  
  262. (defun texinfo-format-begin-end (prop)
  263.   (setq texinfo-command-name (intern (texinfo-parse-line-arg)))
  264.   (setq cmd (get texinfo-command-name prop))
  265.   (if cmd (funcall cmd)
  266.     (texinfo-unsupported)))
  267.  
  268. (defun texinfo-parse-line-arg ()
  269.   (goto-char texinfo-command-end)
  270.   (let ((start (point)))
  271.     (cond ((looking-at " ")
  272.        (skip-chars-forward " ")
  273.        (setq start (point))
  274.        (end-of-line)
  275.        (setq texinfo-command-end (1+ (point))))
  276.       ((looking-at "{")
  277.        (setq start (1+ (point)))
  278.        (forward-list 1)
  279.        (setq texinfo-command-end (point))
  280.        (forward-char -1))
  281.       (t
  282.        (error "Invalid texinfo command arg format")))
  283.     (prog1 (buffer-substring start (point))
  284.        (if (eolp) (forward-char 1)))))
  285.  
  286. (defun texinfo-parse-expanded-arg ()
  287.   (goto-char texinfo-command-end)
  288.   (let ((start (point))
  289.     marker)
  290.     (cond ((looking-at " ")
  291.        (skip-chars-forward " ")
  292.        (setq start (point))
  293.        (end-of-line)
  294.        (setq texinfo-command-end (1+ (point))))
  295.       ((looking-at "{")
  296.        (setq start (1+ (point)))
  297.        (forward-list 1)
  298.        (setq texinfo-command-end (point))
  299.        (forward-char -1))
  300.       (t
  301.        (error "Invalid texinfo command arg format")))
  302.     (setq marker (move-marker (make-marker) texinfo-command-end))
  303.     (texinfo-format-expand-region start (point))
  304.     (setq texinfo-command-end (marker-position marker))
  305.     (move-marker marker nil)
  306.     (prog1 (buffer-substring start (point))
  307.        (if (eolp) (forward-char 1)))))
  308.  
  309. (defun texinfo-format-expand-region (start end)
  310.   (save-restriction
  311.     (narrow-to-region start end)
  312.     (let (texinfo-command-start
  313.       texinfo-command-end
  314.       texinfo-command-name
  315.       texinfo-stack)
  316.       (texinfo-format-scan))
  317.     (goto-char (point-max))))
  318.  
  319. (defun texinfo-parse-arg-discard ()
  320.   (prog1 (texinfo-parse-line-arg)
  321.      (texinfo-discard-command)))
  322.  
  323. (defun texinfo-discard-command ()
  324.   (delete-region texinfo-command-start texinfo-command-end))
  325.  
  326. (defun texinfo-format-parse-line-args ()
  327.   (let ((start (1- (point)))
  328.     next beg end
  329.     args)
  330.     (skip-chars-forward " ")
  331.     (while (not (eolp))
  332.       (setq beg (point))
  333.       (re-search-forward "[\n,]")
  334.       (setq next (point))
  335.       (if (bolp) (setq next (1- next)))
  336.       (forward-char -1)
  337.       (skip-chars-backward " ")
  338.       (setq end (point))
  339.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  340.                args))
  341.       (goto-char next)
  342.       (skip-chars-forward " "))
  343.     (if (eolp) (forward-char 1))
  344.     (setq texinfo-command-end (point))
  345.     (nreverse args)))
  346.  
  347. (defun texinfo-format-parse-args ()
  348.   (let ((start (1- (point)))
  349.     next beg end
  350.     args)
  351.     (search-forward "{")
  352.     (save-excursion
  353.       (texinfo-format-expand-region 
  354.        (point)
  355.        (save-excursion (up-list 1) (1- (point)))))
  356.     (while (/= (preceding-char) ?\})
  357.       (skip-chars-forward " \t\n")
  358.       (setq beg (point))
  359.       (re-search-forward "[},]")
  360.       (setq next (point))
  361.       (forward-char -1)
  362.       (skip-chars-backward " \t\n")
  363.       (setq end (point))
  364.       (cond ((< beg end)
  365.          (goto-char beg)
  366.          (while (search-forward "\n" end t)
  367.            (replace-match " "))))
  368.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  369.                args))
  370.       (goto-char next))
  371.     (if (eolp) (forward-char 1))
  372.     (setq texinfo-command-end (point))
  373.     (nreverse args)))
  374.  
  375. (defun texinfo-format-parse-defun-args ()
  376.   (goto-char texinfo-command-end)
  377.   (let ((start (point)))
  378.     (end-of-line)
  379.     (setq texinfo-command-end (1+ (point)))
  380.     (let ((marker (move-marker (make-marker) texinfo-command-end)))
  381.       (texinfo-format-expand-region start (point))
  382.       (setq texinfo-command-end (marker-position marker))
  383.       (move-marker marker nil))
  384.     (goto-char start)
  385.     (let ((args '())
  386.       beg end)
  387.       (skip-chars-forward " ")
  388.       (while (not (eolp))
  389.     (cond ((looking-at "{")
  390.            (setq beg (1+ (point)))
  391.            (forward-list 1)
  392.            (setq end (1- (point))))
  393.           (t
  394.            (setq beg (point))
  395.            (re-search-forward "[\n ]")
  396.            (forward-char -1)
  397.            (setq end (point))))
  398.     (setq args (cons (buffer-substring beg end) args))
  399.     (skip-chars-forward " "))
  400.       (forward-char 1)
  401.       (nreverse args))))
  402.  
  403. (put 'setfilename 'texinfo-format 'texinfo-format-setfilename)
  404. (defun texinfo-format-setfilename ()
  405.   (let ((arg (texinfo-parse-arg-discard)))
  406.     (setq texinfo-format-filename
  407.       (file-name-nondirectory (expand-file-name arg)))
  408.     (insert "Info file: "
  409.         texinfo-format-filename ",    -*-Text-*-\n"
  410.         "produced by texinfo-format-buffer\nfrom "
  411.         (if (buffer-file-name input-buffer)
  412.         (concat "file: "
  413.             (file-name-sans-versions
  414.              (file-name-nondirectory
  415.               (buffer-file-name input-buffer))))
  416.           (concat "buffer " (buffer-name input-buffer)))
  417.         "\n\n")))
  418.  
  419. (put 'node 'texinfo-format 'texinfo-format-node)
  420. (defun texinfo-format-node ()
  421.   (let* ((args (texinfo-format-parse-line-args))
  422.      (name (nth 0 args))
  423.      (next (nth 1 args))
  424.      (prev (nth 2 args))
  425.      (up (nth 3 args)))
  426.     (texinfo-discard-command)
  427.     (setq texinfo-last-node name)
  428.     (let ((tem (downcase name)))
  429.       (if (assoc tem texinfo-node-names)
  430.       (error "Duplicate node name: %s" name)
  431.     (setq texinfo-node-names (cons (list tem) texinfo-node-names))))
  432.     (or (bolp)
  433.     (insert ?\n))
  434.     (insert "\^_\nFile: " texinfo-format-filename
  435.         "  Node: " name)
  436.     (if prev
  437.     (insert ", Prev: " prev))
  438.     (if up
  439.     (insert ", Up: " up))
  440.     (if next
  441.     (insert ", Next: " next))
  442.     (insert ?\n)))
  443.  
  444. (put 'menu 'texinfo-format 'texinfo-format-menu)
  445. (defun texinfo-format-menu ()
  446.   (texinfo-discard-line)
  447.   (insert "* Menu:\n\n"))
  448.  
  449. (put 'menu 'texinfo-end 'texinfo-discard-command)
  450. (defun texinfo-discard-line ()
  451.   (goto-char texinfo-command-end)
  452.   (skip-chars-forward " \t")
  453.   (or (eolp)
  454.       (error "Extraneous text at end of command line."))
  455.   (goto-char texinfo-command-start)
  456.   (or (bolp)
  457.       (error "Extraneous text at beginning of command line."))
  458.   (delete-region (point) (progn (forward-line 1) (point))))
  459.  
  460. ; @xref {NODE, FNAME, NAME, FILE, DOCUMENT}
  461. ; -> *Note FNAME: (FILE)NODE
  462. ;   If FILE is missing,
  463. ;    *Note FNAME: NODE
  464. ;   If FNAME is empty and NAME is present
  465. ;    *Note NAME: Node
  466. ;   If both NAME and FNAME are missing
  467. ;    *Note NODE::
  468. ;   texinfo ignores the DOCUMENT argument.
  469. ; -> See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  470. ;   If FILE is specified, (FILE)NODE is used for xrefs.
  471. ;   If fifth argument DOCUMENT is specified, produces
  472. ;    See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  473. ;    of DOCUMENT
  474.  
  475. ; @ref             a reference that does not put `See' or `see' in
  476. ;                  the hardcopy and is the same as @xref in Info
  477. (put 'ref 'texinfo-format 'texinfo-format-xref)
  478.  
  479. (put 'xref 'texinfo-format 'texinfo-format-xref)
  480. (defun texinfo-format-xref ()
  481.   (let ((args (texinfo-format-parse-args)))
  482.     (texinfo-discard-command)
  483.     (insert "*Note ")
  484.     (let ((fname (or (nth 1 args) (nth 2 args))))
  485.       (if (null (or fname (nth 3 args)))
  486.       (insert (car args) "::")
  487.     (insert (or fname (car args)) ": ")
  488.     (if (nth 3 args)
  489.         (insert "(" (nth 3 args) ")"))
  490.     (insert (car args))))))
  491.  
  492. (put 'pxref 'texinfo-format 'texinfo-format-pxref)
  493. (defun texinfo-format-pxref ()
  494.   (texinfo-format-xref)
  495.   (or (save-excursion
  496.     (forward-char -2)
  497.     (looking-at "::"))
  498.       (insert ".")))
  499.  
  500. ;@inforef{NODE, FNAME, FILE}
  501. ;Like @xref{NODE, FNAME,,FILE} in texinfo.
  502. ;In Tex, generates "See Info file FILE, node NODE"
  503. (put 'inforef 'texinfo-format 'texinfo-format-inforef)
  504. (defun texinfo-format-inforef ()
  505.   (let ((args (texinfo-format-parse-args)))
  506.     (texinfo-discard-command)
  507.     (insert "*Note " (nth 1 args) ": (" (nth 2 args) ")" (car args))))
  508.  
  509. (put 'chapheading 'texinfo-format 'texinfo-format-chapter)
  510. (put 'ichapter 'texinfo-format 'texinfo-format-chapter)
  511. (put 'chapter 'texinfo-format 'texinfo-format-chapter)
  512. (put 'iappendix 'texinfo-format 'texinfo-format-chapter)
  513. (put 'appendix 'texinfo-format 'texinfo-format-chapter)
  514. (put 'iunnumbered 'texinfo-format 'texinfo-format-chapter)
  515. (put 'unnumbered 'texinfo-format 'texinfo-format-chapter)
  516. (defun texinfo-format-chapter ()
  517.   (texinfo-format-chapter-1 ?*))
  518.  
  519. (put 'heading 'texinfo-format 'texinfo-format-section)
  520. (put 'isection 'texinfo-format 'texinfo-format-section)
  521. (put 'section 'texinfo-format 'texinfo-format-section)
  522. (put 'iappendixsection 'texinfo-format 'texinfo-format-section)
  523. (put 'appendixsection 'texinfo-format 'texinfo-format-section)
  524. (put 'iappendixsec 'texinfo-format 'texinfo-format-section)
  525. (put 'appendixsec 'texinfo-format 'texinfo-format-section)
  526. (put 'iunnumberedsec 'texinfo-format 'texinfo-format-section)
  527. (put 'unnumberedsec 'texinfo-format 'texinfo-format-section)
  528. (defun texinfo-format-section ()
  529.   (texinfo-format-chapter-1 ?=))
  530.  
  531. (put 'subheading 'texinfo-format 'texinfo-format-subsection)
  532. (put 'isubsection 'texinfo-format 'texinfo-format-subsection)
  533. (put 'subsection 'texinfo-format 'texinfo-format-subsection)
  534. (put 'iappendixsubsec 'texinfo-format 'texinfo-format-subsection)
  535. (put 'appendixsubsec 'texinfo-format 'texinfo-format-subsection)
  536. (put 'iunnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  537. (put 'unnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  538. (defun texinfo-format-subsection ()
  539.   (texinfo-format-chapter-1 ?-))
  540.  
  541. (put 'subsubheading 'texinfo-format 'texinfo-format-subsubsection)
  542. (put 'isubsubsection 'texinfo-format 'texinfo-format-subsubsection)
  543. (put 'subsubsection 'texinfo-format 'texinfo-format-subsubsection)
  544. (put 'iappendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  545. (put 'appendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  546. (put 'iunnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  547. (put 'unnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  548. (defun texinfo-format-subsubsection ()
  549.   (texinfo-format-chapter-1 ?.))
  550.  
  551. (defun texinfo-format-chapter-1 (belowchar)
  552.   (let ((arg (texinfo-parse-arg-discard)))
  553.     (message "Formatting: %s ... " arg)   ; So we can see where we are.
  554.     (insert ?\n arg ?\n "@SectionPAD " belowchar ?\n)
  555.     (forward-line -2)))
  556.  
  557. (put 'SectionPAD 'texinfo-format 'texinfo-format-sectionpad)
  558. (defun texinfo-format-sectionpad ()
  559.   (let ((str (texinfo-parse-arg-discard)))
  560.     (forward-char -1)
  561.     (let ((column (current-column)))
  562.       (forward-char 1)
  563.       (while (> column 0)
  564.     (insert str)
  565.     (setq column (1- column))))
  566.     (insert ?\n)))
  567.  
  568. (put '\. 'texinfo-format 'texinfo-format-\.)
  569. (defun texinfo-format-\. ()
  570.   (texinfo-discard-command)
  571.   (insert "."))
  572.  
  573. (put '\: 'texinfo-format 'texinfo-format-\:)
  574. (defun texinfo-format-\: ()
  575.   (texinfo-discard-command))
  576.  
  577. (put 'center 'texinfo-format 'texinfo-format-center)
  578. (defun texinfo-format-center ()
  579.   (texinfo-discard-command)
  580.   (let ((indent-tabs-mode nil))
  581.     (center-line)))
  582.  
  583. (put 'sp 'texinfo-format 'texinfo-format-sp)
  584. (defun texinfo-format-sp ()
  585.   (let* ((arg (texinfo-parse-arg-discard))
  586.      (num (read arg)))
  587.     (insert-char ?\n num)))
  588.  
  589. (put 'br 'texinfo-format 'texinfo-format-paragraph-break)
  590. (defun texinfo-format-paragraph-break ()
  591.   (texinfo-parse-arg-discard)
  592.   ;; insert one return if at end of line;
  593.   ;; else insert two returns, to generate a blank line.
  594.   (if (= (following-char) ?\n)
  595.       (insert ?\n)
  596.     (insert-char ?\n 2)))
  597.  
  598.  
  599. ;;; @footnote
  600.  
  601. ; In Texinfo, footnotes are created with the `@footnote' command.
  602. ; This command is followed immediately by a left brace, then by the text of
  603. ; the footnote, and then by a terminating right brace.  The
  604. ; template for a footnote is:
  605. ; 
  606. ;      @footnote{TEXT}
  607. ;
  608. ; Info has two footnote styles:
  609. ; 
  610. ; `End Node'
  611. ;      In the "End Node" style, all the footnotes for a single node
  612. ;      are placed at the end of that node.  The footnotes are
  613. ;      separated from the rest of the node by a line of dashes with
  614. ;      the word `Footnotes' within it.
  615. ; 
  616. ; `Make Node'
  617. ;      In the "Make Node" style, all the footnotes for a single node are
  618. ;      placed in an automatically constructed node of their own.  
  619.  
  620. (put 'footnote 'texinfo-format 'texinfo-format-footnote)
  621.  
  622. (defvar texinfo-footnote-style 'MN "\
  623. *Footnote style, either EN for end node or MN for make node.")
  624.  
  625. (defun texinfo-format-footnote ()
  626.   "Format a footnote in either `end node' or `make node' style.
  627. The   texinfo-footnote-style  variable controls which style is used."
  628.   (cond ((eq texinfo-footnote-style 'EN) (texinfo-format-end-node))
  629.         ((eq texinfo-footnote-style 'MN) (texinfo-format-make-node))))
  630.  
  631. (defun texinfo-format-make-node ()
  632.   "Format footnote in `MN', Make Node, style with notes in own node.
  633. The node is constructed automatically."
  634.   (let* (start
  635.          (arg (texinfo-parse-expanded-arg))
  636.          (node-name-beginning
  637.           (save-excursion
  638.             (re-search-backward
  639.              "^File: \\w+\\(\\w\\|\\s_\\)*[ \t]+Node:")
  640.             (match-end 0)))
  641.          (node-name
  642.           (save-excursion
  643.             (buffer-substring
  644.              (progn (goto-char node-name-beginning) ; skip over node command
  645.                     (skip-chars-forward " \t")  ; and over spaces
  646.                     (point))
  647.              (if (search-forward
  648.                   ","
  649.                   (save-excursion (end-of-line) (point)) t) ; bound search
  650.                  (1- (point))
  651.                (end-of-line) (point))))))
  652.     (texinfo-discard-command)
  653.     (insert (format "() (*note %s-Footnotes::)" node-name))
  654.     (fill-paragraph nil)
  655.     (save-excursion
  656.     (if (re-search-forward "^@node" nil 'move)
  657.         (forward-line -1))
  658.  
  659.     ;; two cases: for the first footnote, we must insert a node header;
  660.     ;; for the second and subsequent footnotes, we need only insert 
  661.     ;; the text of the  footnote.
  662.  
  663.     (if (save-excursion
  664.          (re-search-backward
  665.           (concat node-name "-Footnotes, Up: ")
  666.           node-name-beginning
  667.           t))
  668.         (progn   ; already at least one footnote
  669.           (setq start (point))
  670.           (insert (format "\n()  %s\n" arg))
  671.           (fill-region start (point)))
  672.       ;; else not yet a footnote
  673.       (insert "\n\^_\nFile: "  texinfo-format-filename
  674.               "  Node: " node-name "-Footnotes, Up: " node-name "\n")
  675.       (setq start (point))
  676.       (insert (format "\n()  %s\n" arg))
  677.       (fill-region start (point))))))
  678.  
  679. (defun texinfo-format-end-node ()
  680.   "Format footnote in `EN', End Node, style with notes at end of node."
  681.   (let (start
  682.         (arg (texinfo-parse-expanded-arg)))
  683.     (texinfo-discard-command)
  684.     (insert "() ")
  685.     (fill-paragraph nil)
  686.     (save-excursion
  687.       (if (search-forward "\n--------- Footnotes ---------\n" nil t)
  688.           (progn ; already have footnote, put new one before end of node
  689.             (if (re-search-forward "^@node" nil 'move)
  690.                 (forward-line -1))
  691.             (setq start (point))
  692.             (insert (format "\n()  %s\n" arg))
  693.             (fill-region start (point)))
  694.         ;; else no prior footnote
  695.         (if (re-search-forward "^@node" nil 'move)
  696.             (forward-line -1))
  697.         (insert "\n--------- Footnotes ---------\n")
  698.         (setq start (point))
  699.         (insert (format "\n()  %s\n" arg))
  700.         (fill-region start (point))))))
  701.  
  702.  
  703. ;; @itemize pushes (itemize "COMMANDS" STARTPOS) on texinfo-stack.
  704. ;; @enumerate pushes (enumerate 0 STARTPOS).
  705. ;; @item dispatches to the texinfo-item prop of the first elt of the list.
  706. ;; For itemize, this puts in and rescans the COMMANDS.
  707. ;; For enumerate, this increments the number and puts it in.
  708. ;; In either case, it puts a Backspace at the front of the line
  709. ;; which marks it not to be indented later.
  710. ;; All other lines get indented by 5 when the @end is reached.
  711.  
  712. (defun texinfo-push-stack (check arg)
  713.   (setq texinfo-stack
  714.     (cons (list check arg texinfo-command-start)
  715.           texinfo-stack)))
  716.  
  717. (defun texinfo-pop-stack (check)
  718.   (if (null texinfo-stack)
  719.       (error "Unmatched @end %s" check))
  720.   (if (not (eq (car (car texinfo-stack)) check))
  721.       (error "@end %s matches @%s"
  722.          check (car (car texinfo-stack))))
  723.   (prog1 (cdr (car texinfo-stack))
  724.      (setq texinfo-stack (cdr texinfo-stack))))
  725.  
  726. (put 'itemize 'texinfo-format 'texinfo-itemize)
  727. (defun texinfo-itemize ()
  728.   (texinfo-push-stack 'itemize (texinfo-parse-arg-discard))
  729.   (setq fill-column (- fill-column 5)))
  730.  
  731. (put 'itemize 'texinfo-end 'texinfo-end-itemize)
  732. (defun texinfo-end-itemize ()
  733.   (setq fill-column (+ fill-column 5))
  734.   (texinfo-discard-command)
  735.   (let ((stacktop
  736.      (texinfo-pop-stack 'itemize)))
  737.     (texinfo-do-itemize (nth 1 stacktop))))
  738.  
  739. (put 'enumerate 'texinfo-format 'texinfo-enumerate)
  740. (defun texinfo-enumerate ()
  741.   (texinfo-push-stack 'enumerate 0)
  742.   (setq fill-column (- fill-column 5))
  743.   (texinfo-discard-line))
  744.  
  745. (put 'enumerate 'texinfo-end 'texinfo-end-enumerate)
  746. (defun texinfo-end-enumerate ()
  747.   (setq fill-column (+ fill-column 5))
  748.   (texinfo-discard-command)
  749.   (let ((stacktop
  750.      (texinfo-pop-stack 'enumerate)))
  751.     (texinfo-do-itemize (nth 1 stacktop))))
  752.  
  753. (put 'table 'texinfo-format 'texinfo-table)
  754. (defun texinfo-table ()
  755.   (texinfo-push-stack 'table (texinfo-parse-arg-discard))
  756.   (setq fill-column (- fill-column 5)))
  757.  
  758. (put 'ftable 'texinfo-format 'texinfo-ftable)
  759. (defun texinfo-ftable ()
  760.   (texinfo-push-stack 'table "@code")
  761.   (setq fill-column (- fill-column 5))
  762.   (texinfo-discard-line))
  763.  
  764. (put 'description 'texinfo-format 'texinfo-description)
  765. (defun texinfo-description ()
  766.   (texinfo-push-stack 'table "@asis")
  767.   (setq fill-column (- fill-column 5))
  768.   (texinfo-discard-line))
  769.  
  770. (put 'table 'texinfo-end 'texinfo-end-table)
  771. (put 'ftable 'texinfo-end 'texinfo-end-table)
  772. (put 'description 'texinfo-end 'texinfo-end-table)
  773. (defun texinfo-end-table ()
  774.   (setq fill-column (+ fill-column 5))
  775.   (texinfo-discard-command)
  776.   (let ((stacktop
  777.      (texinfo-pop-stack 'table)))
  778.     (texinfo-do-itemize (nth 1 stacktop))))
  779.  
  780. ;; At the @end, indent all the lines within the construct
  781. ;; except those marked with backspace.  FROM says where
  782. ;; construct started.
  783. (defun texinfo-do-itemize (from)
  784.   (save-excursion
  785.    (while (progn (forward-line -1)
  786.          (>= (point) from))
  787.      (if (= (following-char) ?\b)
  788.      (save-excursion
  789.        (delete-char 1)
  790.        (end-of-line)
  791.        (delete-char 6))
  792.        (if (not (looking-at "[ \t]*$"))
  793.        (save-excursion (insert "     ")))))))
  794.  
  795. (put 'item 'texinfo-format 'texinfo-item)
  796. (put 'itemx 'texinfo-format 'texinfo-item)
  797. (defun texinfo-item ()
  798.   (funcall (get (car (car texinfo-stack)) 'texinfo-item)))
  799.  
  800. (put 'itemize 'texinfo-item 'texinfo-itemize-item)
  801. (defun texinfo-itemize-item ()
  802.   (texinfo-discard-line)
  803.   (insert "\b   " (nth 1 (car texinfo-stack)) " \n")
  804.   (forward-line -1))
  805.  
  806. (put 'enumerate 'texinfo-item 'texinfo-enumerate-item)
  807. (defun texinfo-enumerate-item ()
  808.   (texinfo-discard-line)
  809.   (let ((next (1+ (car (cdr (car texinfo-stack))))))
  810.     (setcar (cdr (car texinfo-stack)) next)
  811.     (insert ?\b (format "%3d. " next) ?\n))
  812.   (forward-line -1))
  813.  
  814. (put 'table 'texinfo-item 'texinfo-table-item)
  815. (defun texinfo-table-item ()
  816.   (let ((arg (texinfo-parse-arg-discard))
  817.     (itemfont (car (cdr (car texinfo-stack)))))
  818.     (insert ?\b itemfont ?\{ arg "}\n     \n"))
  819.   (forward-line -2))
  820.  
  821.  
  822. ; @ftable
  823.  
  824. ; The `@ftable' command is like the `@table' command but it also
  825. ; inserts each item in the first column into the function index.
  826.  
  827. (put 'ftable 'texinfo-format 'texinfo-ftable)
  828.  
  829. ; The following function presumes that the first column of the table
  830. ; should be in `@code' font; but the texinfo.tex source does not
  831. ; presume this.  
  832. ; (defun texinfo-ftable ()
  833. ;   (texinfo-push-stack 'ftable "@code")
  834. ;   (setq fill-column (- fill-column 5))
  835. ;   (texinfo-discard-line))
  836.  
  837. (defun texinfo-ftable ()
  838.   (texinfo-push-stack 'ftable (texinfo-parse-arg-discard))
  839.   (setq fill-column (- fill-column 5)))
  840.  
  841. (put 'ftable 'texinfo-item 'texinfo-ftable-item)
  842. (defun texinfo-ftable-item ()
  843.   (let ((item (texinfo-parse-arg-discard))
  844.         (itemfont (car (cdr (car texinfo-stack))))
  845.         (indexvar 'texinfo-findex))
  846.     (insert ?\b itemfont ?\{ item "}\n     \n")
  847.     (set indexvar
  848.          (cons
  849.           (list item texinfo-last-node)
  850.           (symbol-value indexvar)))
  851.     (forward-line -2)))
  852.  
  853. (put 'ftable 'texinfo-end 'texinfo-end-ftable)
  854. (defun texinfo-end-ftable ()
  855.   (setq fill-column (+ fill-column 5))
  856.   (texinfo-discard-command)
  857.   (let ((stacktop
  858.          (texinfo-pop-stack 'ftable)))
  859.     (texinfo-do-itemize (nth 1 stacktop))))
  860.  
  861.  
  862. (put 'ifinfo 'texinfo-format 'texinfo-discard-line)
  863. (put 'ifinfo 'texinfo-end 'texinfo-discard-command)
  864.  
  865. (put 'iftex 'texinfo-format 'texinfo-format-iftex)
  866. (defun texinfo-format-iftex ()
  867.   (delete-region texinfo-command-start
  868.          (progn (re-search-forward "@end iftex\n")
  869.             (point))))
  870.  
  871. (put 'tex 'texinfo-format 'texinfo-format-tex)
  872. (defun texinfo-format-tex ()
  873.   (delete-region texinfo-command-start
  874.          (progn (re-search-forward "@end tex\n")
  875.             (point))))
  876.  
  877. (put 'titlepage 'texinfo-format 'texinfo-format-titlepage)
  878. (defun texinfo-format-titlepage ()
  879.   (delete-region texinfo-command-start
  880.          (progn (search-forward "@end titlepage\n")
  881.             (point))))
  882.  
  883. (put 'endtitlepage 'texinfo-format 'texinfo-discard-line)
  884.  
  885. ; @titlespec         an alternative titling command; ignored by Info
  886.  
  887. (put 'titlespec 'texinfo-format 'texinfo-format-titlespec)
  888. (defun texinfo-format-titlespec ()
  889.   (delete-region texinfo-command-start
  890.                  (progn (search-forward "@end titlespec\n")
  891.                         (point))))
  892.  
  893. (put 'endtitlespec 'texinfo-format 'texinfo-discard-line)
  894.  
  895. ; @today{}
  896.  
  897. (put 'today 'texinfo-format 'texinfo-format-today)
  898.  
  899. ; Produces Day Month Year style of output.  eg `1 Jan 1900'
  900. ; The `@today{}' command requires a pair of braces, like `@dots{}'.
  901. (defun texinfo-format-today ()
  902.   (texinfo-parse-arg-discard)
  903.   (insert (format "%s %s %s"
  904.           (substring (current-time-string) 8 10)
  905.           (substring (current-time-string) 4 7)
  906.           (substring (current-time-string) -4))))
  907.  
  908.  
  909. (put 'ignore 'texinfo-format 'texinfo-format-ignore)
  910. (defun texinfo-format-ignore ()
  911.   (delete-region texinfo-command-start
  912.          (progn (search-forward "@end ignore\n")
  913.             (point))))
  914.  
  915. (put 'endignore 'texinfo-format 'texinfo-discard-line)
  916.  
  917. (put 'var 'texinfo-format 'texinfo-format-var)
  918. ;  @sc  a small caps font for TeX; formatted as `var' in Info
  919. (put 'sc 'texinfo-format 'texinfo-format-var)
  920. (defun texinfo-format-var ()
  921.   (insert (upcase (texinfo-parse-arg-discard)))
  922.   (goto-char texinfo-command-start))
  923.  
  924. ; various noops
  925.  
  926. (put 'asis 'texinfo-format 'texinfo-format-noop)
  927. (put 'b 'texinfo-format 'texinfo-format-noop)
  928. (put 't 'texinfo-format 'texinfo-format-noop)
  929. (put 'i 'texinfo-format 'texinfo-format-noop)
  930. (put 'r 'texinfo-format 'texinfo-format-noop)
  931. (put 'titlefont 'texinfo-format 'texinfo-format-noop)
  932. (put 'key 'texinfo-format 'texinfo-format-noop)
  933. (put 'w 'texinfo-format 'texinfo-format-noop)
  934. (defun texinfo-format-noop ()
  935.   (insert (texinfo-parse-arg-discard))
  936.   (goto-char texinfo-command-start))
  937.  
  938. (put 'code 'texinfo-format 'texinfo-format-code)
  939. (put 'samp 'texinfo-format 'texinfo-format-code)
  940. (put 'file 'texinfo-format 'texinfo-format-code)
  941. (put 'kbd 'texinfo-format 'texinfo-format-code)
  942. (put 'cite 'texinfo-format 'texinfo-format-code)
  943. (defun texinfo-format-code ()
  944.   (insert "`" (texinfo-parse-arg-discard) "'")
  945.   (goto-char texinfo-command-start))
  946.  
  947. (put 'emph 'texinfo-format 'texinfo-format-emph)
  948. (put 'strong 'texinfo-format 'texinfo-format-emph)
  949. (defun texinfo-format-emph ()
  950.   (insert "*" (texinfo-parse-arg-discard) "*")
  951.   (goto-char texinfo-command-start))
  952.  
  953. (put 'defn 'texinfo-format 'texinfo-format-defn)
  954. (put 'dfn 'texinfo-format 'texinfo-format-defn)
  955. (defun texinfo-format-defn ()
  956.   (insert "\"" (texinfo-parse-arg-discard) "\"")
  957.   (goto-char texinfo-command-start))
  958.  
  959. (put 'bullet 'texinfo-format 'texinfo-format-bullet)
  960. (defun texinfo-format-bullet ()
  961.   (texinfo-discard-command)
  962.   (insert "*"))
  963.  
  964. (put 'smallexample 'texinfo-format 'texinfo-format-example)
  965. (put 'smalllisp 'texinfo-format 'texinfo-format-example)
  966. (put 'example 'texinfo-format 'texinfo-format-example)
  967. (put 'quotation 'texinfo-format 'texinfo-format-example)
  968. (put 'lisp 'texinfo-format 'texinfo-format-example)
  969. (put 'display 'texinfo-format 'texinfo-format-example)
  970. (put 'format 'texinfo-format 'texinfo-format-example)
  971. (put 'flushleft 'texinfo-format 'texinfo-format-example)
  972. (defun texinfo-format-example ()
  973.   (texinfo-push-stack 'example nil)
  974.   (setq fill-column (- fill-column 5))
  975.   (texinfo-discard-line))
  976.  
  977. (put 'smallexample 'texinfo-end 'texinfo-end-example)
  978. (put 'example 'texinfo-end 'texinfo-end-example)
  979. (put 'quotation 'texinfo-end 'texinfo-end-example)
  980. (put 'lisp 'texinfo-end 'texinfo-end-example)
  981. (put 'display 'texinfo-end 'texinfo-end-example)
  982. (put 'format 'texinfo-end 'texinfo-end-example)
  983. (put 'flushleft 'texinfo-end 'texinfo-end-example)
  984. (defun texinfo-end-example ()
  985.   (setq fill-column (+ fill-column 5))
  986.   (texinfo-discard-command)
  987.   (let ((stacktop
  988.      (texinfo-pop-stack 'example)))
  989.     (texinfo-do-itemize (nth 1 stacktop))))
  990.  
  991. (put 'exdent 'texinfo-format 'texinfo-format-exdent)
  992. (defun texinfo-format-exdent ()
  993.   (texinfo-discard-command)
  994.   (delete-region (point)
  995.          (progn
  996.           (skip-chars-forward " ")
  997.           (point)))
  998.   (insert ?\b)
  999.   ;; Cancel out the deletion that texinfo-do-itemize
  1000.   ;; is going to do at the end of this line.
  1001.   (save-excursion
  1002.     (end-of-line)
  1003.     (insert "\n     ")))
  1004.  
  1005.  
  1006. ;; @flushright  ...   @end flushright
  1007.  
  1008. ; The @flushright command right justifies every line but leaves the
  1009. ; left end ragged.
  1010.  
  1011. (put 'flushright 'texinfo-format 'texinfo-format-flushright)
  1012. (defun texinfo-format-flushright ()
  1013.   (texinfo-push-stack 'flushright nil)
  1014.   (texinfo-discard-line))
  1015.  
  1016. (put 'flushright 'texinfo-end 'texinfo-end-flushright)
  1017. (defun texinfo-end-flushright ()
  1018.   (texinfo-discard-command)
  1019.  
  1020.   (let ((stacktop
  1021.          (texinfo-pop-stack 'flushright)))
  1022.  
  1023.     (texinfo-do-flushright (nth 1 stacktop))))
  1024.  
  1025. (defun texinfo-do-flushright (from)
  1026.   (save-excursion
  1027.    (while (progn (forward-line -1)
  1028.                  (>= (point) from))
  1029.  
  1030.      (beginning-of-line)
  1031.      (insert
  1032.       (make-string
  1033.        (- fill-column
  1034.           (save-excursion
  1035.             (end-of-line)
  1036.             (current-column)))  
  1037.        ? )))))
  1038.  
  1039.  
  1040. (put 'ctrl 'texinfo-format 'texinfo-format-ctrl)
  1041. (defun texinfo-format-ctrl ()
  1042.   (let ((str (texinfo-parse-arg-discard)))
  1043.     (insert (logand 31 (aref str 0)))))
  1044.  
  1045. (put 'TeX 'texinfo-format 'texinfo-format-TeX)
  1046. (defun texinfo-format-TeX ()
  1047.   (texinfo-parse-arg-discard)
  1048.   (insert "TeX"))
  1049.  
  1050. (put 'copyright 'texinfo-format 'texinfo-format-copyright)
  1051. (defun texinfo-format-copyright ()
  1052.   (texinfo-parse-arg-discard)
  1053.   (insert "(C)"))
  1054.  
  1055. (put 'minus 'texinfo-format 'texinfo-format-minus)
  1056. (defun texinfo-format-minus ()
  1057.   (texinfo-parse-arg-discard)
  1058.   (insert "-"))
  1059.  
  1060. (put 'dots 'texinfo-format 'texinfo-format-dots)
  1061. (defun texinfo-format-dots ()
  1062.   (texinfo-parse-arg-discard)
  1063.   (insert "..."))
  1064.  
  1065. (put 'refill 'texinfo-format 'texinfo-format-refill)
  1066. (defun texinfo-format-refill ()
  1067.   (texinfo-discard-command)
  1068.   (fill-paragraph nil))
  1069.  
  1070.  
  1071. ;;; Index generation
  1072.  
  1073. (put 'vindex 'texinfo-format 'texinfo-format-vindex)
  1074. (defun texinfo-format-vindex ()
  1075.   (texinfo-index 'texinfo-vindex))
  1076.  
  1077. (put 'cindex 'texinfo-format 'texinfo-format-cindex)
  1078. (defun texinfo-format-cindex ()
  1079.   (texinfo-index 'texinfo-cindex))
  1080.  
  1081. (put 'findex 'texinfo-format 'texinfo-format-findex)
  1082. (defun texinfo-format-findex ()
  1083.   (texinfo-index 'texinfo-findex))
  1084.  
  1085. (put 'pindex 'texinfo-format 'texinfo-format-pindex)
  1086. (defun texinfo-format-pindex ()
  1087.   (texinfo-index 'texinfo-pindex))
  1088.  
  1089. (put 'tindex 'texinfo-format 'texinfo-format-tindex)
  1090. (defun texinfo-format-tindex ()
  1091.   (texinfo-index 'texinfo-tindex))
  1092.  
  1093. (put 'kindex 'texinfo-format 'texinfo-format-kindex)
  1094. (defun texinfo-format-kindex ()
  1095.   (texinfo-index 'texinfo-kindex))
  1096.  
  1097. (defun texinfo-index (indexvar)
  1098.   (let ((arg (texinfo-parse-expanded-arg)))
  1099.     (texinfo-discard-command)
  1100.     (set indexvar
  1101.      (cons (list arg texinfo-last-node)
  1102.            (symbol-value indexvar)))))
  1103.  
  1104. (defconst texinfo-indexvar-alist
  1105.   '(("cp" . texinfo-cindex)
  1106.     ("fn" . texinfo-findex)
  1107.     ("vr" . texinfo-vindex)
  1108.     ("tp" . texinfo-tindex)
  1109.     ("pg" . texinfo-pindex)
  1110.     ("ky" . texinfo-kindex)))
  1111.  
  1112.  
  1113. ;;; @defindex   @defcodeindex
  1114. (put 'defindex 'texinfo-format 'texinfo-format-defindex)
  1115. (put 'defcodeindex 'texinfo-format 'texinfo-format-defindex)
  1116.  
  1117. (defun texinfo-format-defindex ()
  1118.   (let* ((index-name (texinfo-parse-arg-discard)) ; eg: `aa'
  1119.          (indexing-command (intern (concat index-name "index")))
  1120.          (index-formatting-command      ; eg: `texinfo-format-aaindex'
  1121.           (intern (concat "texinfo-format-" index-name "index")))
  1122.          (index-alist-name              ; eg: `texinfo-aaindex'
  1123.           (intern (concat "texinfo-" index-name "index"))))
  1124.  
  1125.     (set index-alist-name nil)
  1126.  
  1127.     (put indexing-command               ; eg, aaindex
  1128.          'texinfo-format
  1129.          index-formatting-command)      ; eg, texinfo-format-aaindex
  1130.  
  1131.     ;; eg: "aa" . texinfo-aaindex
  1132.     (or (assoc index-name texinfo-indexvar-alist)
  1133.         (setq texinfo-indexvar-alist
  1134.               (cons
  1135.                (cons index-name
  1136.                      index-alist-name)
  1137.                texinfo-indexvar-alist)))
  1138.  
  1139.     (fset index-formatting-command
  1140.           (list 'lambda 'nil
  1141.                 (list 'texinfo-index 
  1142.                       (list 'quote index-alist-name))))))
  1143.  
  1144.  
  1145. ;;; @synindex   @syncodeindex
  1146.  
  1147. (put 'synindex 'texinfo-format 'texinfo-format-synindex)
  1148. (put 'syncodeindex 'texinfo-format 'texinfo-format-synindex)
  1149.  
  1150. (defun texinfo-format-synindex ()
  1151.   (let* ((args (texinfo-parse-arg-discard))
  1152.          (second (cdr (read-from-string args)))
  1153.          (joiner (symbol-name (car (read-from-string args))))
  1154.          (joined (symbol-name (car (read-from-string args second)))))
  1155.  
  1156.     (if (assoc joiner texinfo-short-index-cmds-alist)
  1157.         (put
  1158.           (cdr (assoc joiner texinfo-short-index-cmds-alist))
  1159.          'texinfo-format
  1160.          (or (cdr (assoc joined texinfo-short-index-format-cmds-alist))
  1161.              (intern (concat "texinfo-format-" joined "index"))))
  1162.       (put
  1163.        (intern (concat joiner "index"))
  1164.        'texinfo-format
  1165.        (or (cdr(assoc joined texinfo-short-index-format-cmds-alist))
  1166.            (intern (concat "texinfo-format-" joined "index")))))))
  1167.  
  1168. (defconst texinfo-short-index-cmds-alist
  1169.   '(("cp" . cindex)
  1170.     ("fn" . findex)
  1171.     ("vr" . vindex)
  1172.     ("tp" . tindex)
  1173.     ("pg" . pindex)
  1174.     ("ky" . kindex)))
  1175.  
  1176. (defconst texinfo-short-index-format-cmds-alist
  1177.   '(("cp" . texinfo-format-cindex)
  1178.     ("fn" . texinfo-format-findex)
  1179.     ("vr" . texinfo-format-vindex)
  1180.     ("tp" . texinfo-format-tindex)
  1181.     ("pg" . texinfo-format-pindex)
  1182.     ("ky" . texinfo-format-kindex)))
  1183.  
  1184.  
  1185. ;;; @printindex
  1186.  
  1187. (put 'printindex 'texinfo-format 'texinfo-format-printindex)
  1188.  
  1189. (defun texinfo-format-printindex ()
  1190.   (let ((indexelts (symbol-value
  1191.             (cdr (assoc (texinfo-parse-arg-discard)
  1192.                 texinfo-indexvar-alist))))
  1193.     opoint)
  1194.     (insert "\n* Menu:\n\n")
  1195.     (setq opoint (point))
  1196.     (texinfo-print-index nil indexelts)
  1197.  
  1198.     (if (eq system-type 'vax-vms)
  1199.         (texinfo-sort-region opoint (point))
  1200.       (shell-command-on-region opoint (point) "sort -fd" 1))))
  1201.  
  1202. (defun texinfo-print-index (file indexelts)
  1203.   (while indexelts
  1204.     (if (stringp (car (car indexelts)))
  1205.     (insert "* " (car (car indexelts))
  1206.         ": " (if file (concat "(" file ")") "")
  1207.         (nth 1 (car indexelts)) ".\n")
  1208.       ;; index entries from @include'd file
  1209.       (texinfo-print-index (nth 1 (car indexelts))
  1210.                (nth 2 (car indexelts))))
  1211.     (setq indexelts (cdr indexelts))))
  1212.  
  1213.  
  1214. ;;; NOTATIONS: @equiv, @error, etc
  1215.  
  1216. ;; @equiv           to show that two expressions are equivalent
  1217. ;; @error           to show an error message
  1218. ;; @expansion       to show what a macro expands to
  1219. ;; @point           to show the location of point in an example
  1220. ;; @print           to show what an evaluated expression prints
  1221. ;; @result          to indicate the value returned by an expression
  1222.  
  1223. (put 'equiv 'texinfo-format 'texinfo-format-equiv)
  1224. (defun texinfo-format-equiv ()
  1225.   (texinfo-parse-arg-discard)
  1226.   (insert "=="))
  1227.  
  1228. (put 'error 'texinfo-format 'texinfo-format-error)
  1229. (defun texinfo-format-error ()
  1230.   (texinfo-parse-arg-discard)
  1231.   (insert "error-->"))
  1232.  
  1233. (put 'expansion 'texinfo-format 'texinfo-format-expansion)
  1234. (defun texinfo-format-expansion ()
  1235.   (texinfo-parse-arg-discard)
  1236.   (insert "==>"))
  1237.  
  1238. (put 'point 'texinfo-format 'texinfo-format-point)
  1239. (defun texinfo-format-point ()
  1240.   (texinfo-parse-arg-discard)
  1241.   (insert "-!-"))
  1242.  
  1243. (put 'print 'texinfo-format 'texinfo-format-print)
  1244. (defun texinfo-format-print ()
  1245.   (texinfo-parse-arg-discard)
  1246.   (insert "-|"))
  1247.  
  1248. (put 'result 'texinfo-format 'texinfo-format-result)
  1249. (defun texinfo-format-result ()
  1250.   (texinfo-parse-arg-discard)
  1251.   (insert "=>"))
  1252.  
  1253.  
  1254. ;;;; Description formatting: @deffn, @defun, etc
  1255.  
  1256. (defun texinfo-format-defun ()
  1257.   (texinfo-push-stack 'defun nil)
  1258.   (setq fill-column (- fill-column 5))
  1259.   (texinfo-format-defun-1 t))
  1260.  
  1261. (defun texinfo-format-defunx ()
  1262.   (texinfo-format-defun-1 nil))
  1263.  
  1264. (defun texinfo-format-defun-1 (first-p)
  1265.   (let ((args (texinfo-format-parse-defun-args))
  1266.     (type (get texinfo-command-name 'texinfo-defun-type))
  1267.         (class "")
  1268.         (name ""))
  1269.     (texinfo-discard-command)
  1270.  
  1271.     (cond 
  1272.      ;; Generalized object oriented entity: `category class name [args...]'
  1273.      ((eq (eval (car type)) 'defop-type)
  1274.       (progn (setq category (car args))
  1275.              (setq class (car (cdr args)))
  1276.              (setq args (cdr (cdr args)))
  1277.              (setq name (car args))))
  1278.  
  1279.      ;; Specialized object oriented entity:  @defmethod, @defivar
  1280.      ;; "Instance Variable"    `class name [args...]'
  1281.      ((eq  (eval (car type)) 'defmethod-type)
  1282.       (progn (setq category (car (cdr type)))
  1283.              (setq class (car args))
  1284.              (setq args (cdr args))
  1285.              (setq name (car args))))
  1286.      
  1287.      ;; Generalized function-like or variable-like entity:
  1288.      ;; `category name [args...]'
  1289.      ((or (eq (eval (car type)) 'deffn-type)
  1290.           (eq (eval (car type)) 'deftp-type))
  1291.       (progn (setq category (car args))
  1292.              (setq args (cdr args))
  1293.              (setq name (car args))))
  1294.      
  1295.      ;; Specialized function-like or variable-like entity:
  1296.      ;; "Macro"    `name [args...]'
  1297.      ((eq (eval (car type)) 'defun-type)
  1298.       (progn (setq category (car (cdr type)))
  1299.              (setq name (car args)))))
  1300.  
  1301.     (let ((formatter (get texinfo-command-name 'texinfo-defun-format-type)))
  1302.       (if formatter
  1303.       (setq category (funcall formatter category class))))
  1304.  
  1305.     ;; Delete extra newline inserted after previous header line.
  1306.     (if (not first-p)
  1307.     (delete-char -1))
  1308.     (insert "* " category ": " name)
  1309.     (let ((args (cdr args)))
  1310.       (while args
  1311.     (insert " "
  1312.         (if (or (= ?& (aref (car args) 0))
  1313.                         (eq (eval (car type)) 'deftp-type))
  1314.             (car args)
  1315.             (upcase (car args))))
  1316.     (setq args (cdr args))))
  1317.     ;; Insert extra newline so that paragraph filling does not mess
  1318.     ;; with header line.
  1319.     (insert "\n\n")
  1320.     (rplaca (cdr (cdr (car texinfo-stack))) (point))
  1321.     (let ((indexvar (get texinfo-command-name 'texinfo-defun-index))
  1322.       (formatter (get texinfo-command-name 'texinfo-defun-format-index)))
  1323.       (set indexvar
  1324.        (cons (list (if formatter
  1325.                            (funcall formatter name class)
  1326.                          (car args))
  1327.                texinfo-last-node)
  1328.          (symbol-value indexvar))))))
  1329.  
  1330. (defun texinfo-end-defun ()
  1331.   (setq fill-column (+ fill-column 5))
  1332.   (texinfo-discard-command)
  1333.   (let ((start (nth 1 (texinfo-pop-stack 'defun))))
  1334.     (texinfo-do-itemize start)
  1335.     ;; Delete extra newline inserted after header.
  1336.     (save-excursion
  1337.       (goto-char start)
  1338.       (delete-char -1))))
  1339.  
  1340. (defun texinfo-format-defop-type (category class)
  1341.   (format "%s on %s" category class))
  1342.  
  1343. (defun texinfo-format-defop-index (name class)
  1344.   (format "%s on %s" name class))
  1345.  
  1346. (defun texinfo-format-defcv-type (category class)
  1347.   (format "%s of %s" category class))
  1348.  
  1349. (defun texinfo-format-defcv-index (name class)
  1350.   (format "%s of %s" name class))
  1351.  
  1352. (put 'deffn 'texinfo-format 'texinfo-format-defun)
  1353. (put 'deffnx 'texinfo-format 'texinfo-format-defunx)
  1354. (put 'deffn 'texinfo-end 'texinfo-end-defun)
  1355. (put 'deffn 'texinfo-defun-type '('deffn-type nil))
  1356. (put 'deffnx 'texinfo-defun-type '('deffn-type nil))
  1357. (put 'deffn 'texinfo-defun-index 'texinfo-findex)
  1358. (put 'deffnx 'texinfo-defun-index 'texinfo-findex)
  1359.  
  1360. (put 'defun 'texinfo-format 'texinfo-format-defun)
  1361. (put 'defunx 'texinfo-format 'texinfo-format-defunx)
  1362. (put 'defun 'texinfo-end 'texinfo-end-defun)
  1363. (put 'defun 'texinfo-defun-type '('defun-type "Function"))
  1364. (put 'defunx 'texinfo-defun-type '('defun-type "Function"))
  1365. (put 'defun 'texinfo-defun-index 'texinfo-findex)
  1366. (put 'defunx 'texinfo-defun-index 'texinfo-findex)
  1367.  
  1368. (put 'defmac 'texinfo-format 'texinfo-format-defun)
  1369. (put 'defmacx 'texinfo-format 'texinfo-format-defunx)
  1370. (put 'defmac 'texinfo-end 'texinfo-end-defun)
  1371. (put 'defmac 'texinfo-defun-type '('defun-type "Macro"))
  1372. (put 'defmacx 'texinfo-defun-type '('defun-type "Macro"))
  1373. (put 'defmac 'texinfo-defun-index 'texinfo-findex)
  1374. (put 'defmacx 'texinfo-defun-index 'texinfo-findex)
  1375.  
  1376. (put 'defspec 'texinfo-format 'texinfo-format-defun)
  1377. (put 'defspecx 'texinfo-format 'texinfo-format-defunx)
  1378. (put 'defspec 'texinfo-end 'texinfo-end-defun)
  1379. (put 'defspec 'texinfo-defun-type '('defun-type "Special form"))
  1380. (put 'defspecx 'texinfo-defun-type '('defun-type "Special form"))
  1381. (put 'defspec 'texinfo-defun-index 'texinfo-findex)
  1382. (put 'defspecx 'texinfo-defun-index 'texinfo-findex)
  1383.  
  1384. (put 'defvr 'texinfo-format 'texinfo-format-defun)
  1385. (put 'defvrx 'texinfo-format 'texinfo-format-defunx)
  1386. (put 'defvr 'texinfo-end 'texinfo-end-defun)
  1387. (put 'defvr 'texinfo-defun-type '('deffn-type nil))
  1388. (put 'defvrx 'texinfo-defun-type '('deffn-type nil))
  1389. (put 'defvr 'texinfo-defun-index 'texinfo-vindex)
  1390. (put 'defvrx 'texinfo-defun-index 'texinfo-vindex)
  1391.  
  1392. (put 'defvar 'texinfo-format 'texinfo-format-defun)
  1393. (put 'defvarx 'texinfo-format 'texinfo-format-defunx)
  1394. (put 'defvar 'texinfo-end 'texinfo-end-defun)
  1395. (put 'defvar 'texinfo-defun-type '('defun-type "Variable"))
  1396. (put 'defvarx 'texinfo-defun-type '('defun-type "Variable"))
  1397. (put 'defvar 'texinfo-defun-index 'texinfo-vindex)
  1398. (put 'defvarx 'texinfo-defun-index 'texinfo-vindex)
  1399.  
  1400. (put 'defconst 'texinfo-format 'texinfo-format-defun)
  1401. (put 'defconstx 'texinfo-format 'texinfo-format-defunx)
  1402. (put 'defconst 'texinfo-end 'texinfo-end-defun)
  1403. (put 'defconst 'texinfo-defun-type '('defun-type "Constant"))
  1404. (put 'defconstx 'texinfo-defun-type '('defun-type "Constant"))
  1405. (put 'defconst 'texinfo-defun-index 'texinfo-vindex)
  1406. (put 'defconstx 'texinfo-defun-index 'texinfo-vindex)
  1407.  
  1408. (put 'defcmd 'texinfo-format 'texinfo-format-defun)
  1409. (put 'defcmdx 'texinfo-format 'texinfo-format-defunx)
  1410. (put 'defcmd 'texinfo-end 'texinfo-end-defun)
  1411. (put 'defcmd 'texinfo-defun-type '('defun-type "Command"))
  1412. (put 'defcmdx 'texinfo-defun-type '('defun-type "Command"))
  1413. (put 'defcmd 'texinfo-defun-index 'texinfo-findex)
  1414. (put 'defcmdx 'texinfo-defun-index 'texinfo-findex)
  1415.  
  1416. (put 'defopt 'texinfo-format 'texinfo-format-defun)
  1417. (put 'defoptx 'texinfo-format 'texinfo-format-defunx)
  1418. (put 'defopt 'texinfo-end 'texinfo-end-defun)
  1419. (put 'defopt 'texinfo-defun-type '('defun-type "User Option"))
  1420. (put 'defoptx 'texinfo-defun-type '('defun-type "User Option"))
  1421. (put 'defopt 'texinfo-defun-index 'texinfo-vindex)
  1422. (put 'defoptx 'texinfo-defun-index 'texinfo-vindex)
  1423.  
  1424. (put 'deftp 'texinfo-format 'texinfo-format-defun)
  1425. (put 'deftpx 'texinfo-format 'texinfo-format-defunx)
  1426. (put 'deftp 'texinfo-end 'texinfo-end-defun)
  1427. (put 'deftp 'texinfo-defun-type '('deftp-type nil))
  1428. (put 'deftpx 'texinfo-defun-type '('deftp-type nil))
  1429. (put 'deftp 'texinfo-defun-index 'texinfo-tindex)
  1430. (put 'deftpx 'texinfo-defun-index 'texinfo-tindex)
  1431.  
  1432. ;;; Object-oriented stuff is a little hairier.
  1433.  
  1434. (put 'defop 'texinfo-format 'texinfo-format-defun)
  1435. (put 'defopx 'texinfo-format 'texinfo-format-defunx)
  1436. (put 'defop 'texinfo-end 'texinfo-end-defun)
  1437. (put 'defop 'texinfo-defun-type '('defop-type nil))
  1438. (put 'defopx 'texinfo-defun-type '('defop-type nil))
  1439. (put 'defop 'texinfo-defun-format-type 'texinfo-format-defop-type)
  1440. (put 'defopx 'texinfo-defun-format-type 'texinfo-format-defop-type)
  1441. (put 'defop 'texinfo-defun-index 'texinfo-findex)
  1442. (put 'defopx 'texinfo-defun-index 'texinfo-findex)
  1443. (put 'defop 'texinfo-defun-format-index 'texinfo-format-defop-index)
  1444. (put 'defopx 'texinfo-defun-format-index 'texinfo-format-defop-index)
  1445.  
  1446. (put 'defmethod 'texinfo-format 'texinfo-format-defun)
  1447. (put 'defmethodx 'texinfo-format 'texinfo-format-defunx)
  1448. (put 'defmethod 'texinfo-end 'texinfo-end-defun)
  1449. (put 'defmethod 'texinfo-defun-type '('defmethod-type "Operation"))
  1450. (put 'defmethodx 'texinfo-defun-type '('defmethod-type "Operation"))
  1451. (put 'defmethod 'texinfo-defun-format-type 'texinfo-format-defop-type)
  1452. (put 'defmethodx 'texinfo-defun-format-type 'texinfo-format-defop-type)
  1453. (put 'defmethod 'texinfo-defun-index 'texinfo-findex)
  1454. (put 'defmethodx 'texinfo-defun-index 'texinfo-findex)
  1455. (put 'defmethod 'texinfo-defun-format-index 'texinfo-format-defop-index)
  1456. (put 'defmethodx 'texinfo-defun-format-index 'texinfo-format-defop-index)
  1457.  
  1458. (put 'defcv 'texinfo-format 'texinfo-format-defun)
  1459. (put 'defcvx 'texinfo-format 'texinfo-format-defunx)
  1460. (put 'defcv 'texinfo-end 'texinfo-end-defun)
  1461. (put 'defcv 'texinfo-defun-type '('defop-type nil))
  1462. (put 'defcvx 'texinfo-defun-type '('defop-type nil))
  1463. (put 'defcv 'texinfo-defun-format-type 'texinfo-format-defcv-type)
  1464. (put 'defcvx 'texinfo-defun-format-type 'texinfo-format-defcv-type)
  1465. (put 'defcv 'texinfo-defun-index 'texinfo-vindex)
  1466. (put 'defcvx 'texinfo-defun-index 'texinfo-vindex)
  1467. (put 'defcv 'texinfo-defun-format-index 'texinfo-format-defcv-index)
  1468. (put 'defcvx 'texinfo-defun-format-index 'texinfo-format-defcv-index)
  1469.  
  1470. (put 'defivar 'texinfo-format 'texinfo-format-defun)
  1471. (put 'defivarx 'texinfo-format 'texinfo-format-defunx)
  1472. (put 'defivar 'texinfo-end 'texinfo-end-defun)
  1473. (put 'defivar 'texinfo-defun-type '('defmethod-type "Instance variable"))
  1474. (put 'defivarx 'texinfo-defun-type '('defmethod-type "Instance variable"))
  1475. (put 'defivar 'texinfo-defun-format-type 'texinfo-format-defcv-type)
  1476. (put 'defivarx 'texinfo-defun-format-type 'texinfo-format-defcv-type)
  1477. (put 'defivar 'texinfo-defun-index 'texinfo-vindex)
  1478. (put 'defivarx 'texinfo-defun-index 'texinfo-vindex)
  1479. (put 'defivar 'texinfo-defun-format-index 'texinfo-format-defcv-index)
  1480. (put 'defivarx 'texinfo-defun-format-index 'texinfo-format-defcv-index)
  1481.  
  1482.  
  1483. ;; process included files
  1484. (put 'include 'texinfo-format 'texinfo-format-include)
  1485. (defun texinfo-format-include ()
  1486.   (let ((filename (texinfo-parse-arg-discard))
  1487.     (default-directory input-directory)
  1488.     subindex)
  1489.     (setq subindex
  1490.       (save-excursion
  1491.         (progn (find-file
  1492.             (cond ((file-readable-p (concat filename ".texinfo"))
  1493.                (concat filename ".texinfo"))
  1494.               ((file-readable-p (concat filename ".texi"))
  1495.                (concat filename ".texi"))
  1496.               ((file-readable-p (concat filename ".tex"))
  1497.                (concat filename ".tex"))
  1498.               ((file-readable-p filename)
  1499.                filename)
  1500.               (t (error "@include'd file %s not found"
  1501.                     filename))))
  1502.            (texinfo-format-buffer-1))))
  1503.     (texinfo-subindex 'texinfo-vindex (car subindex) (nth 1 subindex))
  1504.     (texinfo-subindex 'texinfo-findex (car subindex) (nth 2 subindex))
  1505.     (texinfo-subindex 'texinfo-cindex (car subindex) (nth 3 subindex))
  1506.     (texinfo-subindex 'texinfo-pindex (car subindex) (nth 4 subindex))
  1507.     (texinfo-subindex 'texinfo-tindex (car subindex) (nth 5 subindex))
  1508.     (texinfo-subindex 'texinfo-kindex (car subindex) (nth 6 subindex))))
  1509.  
  1510. (defun texinfo-subindex (indexvar file content)
  1511.   (set indexvar (cons (list 'recurse file content)
  1512.               (symbol-value indexvar))))
  1513.  
  1514.  
  1515. ;; Lots of bolio constructs do nothing in texinfo.
  1516.  
  1517. (put 'page 'texinfo-format 'texinfo-discard-line-with-args)
  1518. (put 'c 'texinfo-format 'texinfo-discard-line-with-args)
  1519. (put 'comment 'texinfo-format 'texinfo-discard-line-with-args)
  1520. (put 'setchapternewpage 'texinfo-format 'texinfo-discard-line-with-args)
  1521. (put 'contents 'texinfo-format 'texinfo-discard-line-with-args)
  1522. (put 'summarycontents 'texinfo-format 'texinfo-discard-line-with-args)
  1523. (put 'shortcontents 'texinfo-format 'texinfo-discard-line-with-args)
  1524. (put 'nopara 'texinfo-format 'texinfo-discard-line-with-args)
  1525. (put 'noindent 'texinfo-format 'texinfo-discard-line-with-args)
  1526. (put 'setx 'texinfo-format 'texinfo-discard-line-with-args)
  1527. (put 'setq 'texinfo-format 'texinfo-discard-line-with-args)
  1528. (put 'settitle 'texinfo-format 'texinfo-discard-line-with-args)
  1529. (put 'hsize 'texinfo-format 'texinfo-discard-line-with-args)
  1530. (put 'parindent 'texinfo-format 'texinfo-discard-line-with-args)
  1531. (put 'lispnarrowing 'texinfo-format 'texinfo-discard-line-with-args)
  1532. (put 'itemindent 'texinfo-format 'texinfo-discard-line-with-args)
  1533. (put 'headings 'texinfo-format 'texinfo-discard-line-with-args)
  1534. (put 'group 'texinfo-format 'texinfo-discard-line-with-args)
  1535. (put 'group 'texinfo-end 'texinfo-discard-line-with-args)
  1536. (put 'need 'texinfo-format 'texinfo-discard-line-with-args)
  1537. (put 'bye 'texinfo-format 'texinfo-discard-line)
  1538. (put 'smallbook 'texinfo-format 'texinfo-discard-line)
  1539.  
  1540. (defun texinfo-discard-line-with-args ()
  1541.   (goto-char texinfo-command-start)
  1542.   (delete-region (point) (progn (forward-line 1) (point))))
  1543.  
  1544. ;; Sort an index which is in the current buffer between START and END.
  1545. ;; Used on VMS, where the `sort' utility is not available.
  1546. (defun texinfo-sort-region (start end)
  1547.   (require 'sort)
  1548.   (save-restriction
  1549.     (narrow-to-region start end)
  1550.     (sort-subr nil 'forward-line 'end-of-line 'texinfo-sort-startkeyfun)))
  1551.  
  1552. ;; Subroutine for sorting an index.
  1553. ;; At start of a line, return a string to sort the line under.
  1554. (defun texinfo-sort-startkeyfun ()
  1555.   (let ((line
  1556.      (buffer-substring (point) (save-excursion (end-of-line) (point)))))
  1557.     ;; Canonicalize whitespace and eliminate funny chars.
  1558.     (while (string-match "[ \t][ \t]+\\|[^a-z0-9 ]+" line)
  1559.       (setq line (concat (substring line 0 (match-beginning 0))
  1560.              " "
  1561.              (substring line (match-end 0) (length line)))))
  1562.     line))
  1563.  
  1564. ;; Some cannot be handled
  1565.  
  1566. (defun texinfo-unsupported ()
  1567.   (error "%s is not handled by texinfo"
  1568.      (buffer-substring texinfo-command-start texinfo-command-end)))
  1569.  
  1570. (defun batch-texinfo-format ()
  1571.   "Runs  texinfo-format-buffer  on the files remaining on the command line.
  1572. Must be used only with -batch, and kills emacs on completion.
  1573. Each file will be processed even if an error occurred previously.
  1574. For example, invoke
  1575.   \"emacs -batch -funcall batch-texinfo-format $docs/ ~/*.texinfo\"."
  1576.   (if (not noninteractive)
  1577.       (error "batch-texinfo-format may only be used -batch."))
  1578.   (let ((version-control t)
  1579.     (auto-save-default nil)
  1580.     (find-file-run-dired nil)
  1581.     (kept-old-versions 259259)
  1582.     (kept-new-versions 259259))
  1583.     (let ((error 0)
  1584.       file
  1585.       (files ()))
  1586.       (while command-line-args-left
  1587.     (setq file (expand-file-name (car command-line-args-left)))
  1588.     (cond ((not (file-exists-p file))
  1589.            (message ">> %s does not exist!" file)
  1590.            (setq error 1
  1591.              command-line-args-left (cdr command-line-args-left)))
  1592.           ((file-directory-p file)
  1593.            (setq command-line-args-left
  1594.              (nconc (directory-files file)
  1595.                 (cdr command-line-args-left))))
  1596.           (t
  1597.            (setq files (cons file files)
  1598.              command-line-args-left (cdr command-line-args-left)))))
  1599.       (while files
  1600.     (setq file (car files)
  1601.           files (cdr files))
  1602.     (condition-case err
  1603.         (progn
  1604.           (if buffer-file-name (kill-buffer (current-buffer)))
  1605.           (find-file file)
  1606.           (buffer-disable-undo (current-buffer))
  1607.           (set-buffer-modified-p nil)
  1608.           (texinfo-mode)
  1609.           (message "texinfo formatting %s..." file)
  1610.           (texinfo-format-buffer nil)
  1611.           (if (buffer-modified-p)
  1612.           (progn (message "Saving modified %s" (buffer-file-name))
  1613.              (save-buffer))))
  1614.       (error
  1615.        (message ">> Error: %s" (prin1-to-string err))
  1616.        (message ">>  point at")
  1617.        (let ((s (buffer-substring (point)
  1618.                       (min (+ (point) 100)
  1619.                        (point-max))))
  1620.          (tem 0))
  1621.          (while (setq tem (string-match "\n+" s tem))
  1622.            (setq s (concat (substring s 0 (match-beginning 0))
  1623.                    "\n>>  "
  1624.                    (substring s (match-end 0)))
  1625.              tem (1+ tem)))
  1626.          (message ">>  %s" s))
  1627.        (setq error 1))))
  1628.       (kill-emacs error))))
  1629.