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