1 ;;; texinfmt.el --- format Texinfo files into Info files
3 ;; Copyright (C) 1985-1986, 1988, 1990-1998, 2000-2013 Free Software
6 ;; Maintainer: Robert J. Chassell <bug-texinfo@gnu.org>
7 ;; Keywords: maint, tex, docs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;;; Emacs lisp functions to convert Texinfo files to Info files.
30 (defvar texinfmt-version
"2.42 of 7 Jul 2006")
32 (defun texinfmt-version (&optional here
)
33 "Show the version of texinfmt.el in the minibuffer.
34 If optional argument HERE is non-nil, insert info at point."
37 (format "Version of \`texinfmt.el\': %s" texinfmt-version
)))
39 (insert version-string
)
40 (if (called-interactively-p 'interactive
)
41 (message "%s" version-string
)
45 ;;; Variable definitions
47 (require 'texinfo
) ; So `texinfo-footnote-style' is defined.
48 (require 'texnfo-upd
) ; So `texinfo-section-types-regexp' is defined.
50 (defvar texinfo-vindex
)
51 (defvar texinfo-findex
)
52 (defvar texinfo-cindex
)
53 (defvar texinfo-pindex
)
54 (defvar texinfo-tindex
)
55 (defvar texinfo-kindex
)
56 (defvar texinfo-last-node
)
57 (defvar texinfo-node-names
)
58 (defvar texinfo-enclosure-list
)
59 (defvar texinfo-alias-list
)
60 (defvar texinfo-fold-nodename-case nil
)
62 (defvar texinfo-command-start
)
63 (defvar texinfo-command-end
)
64 (defvar texinfo-command-name
)
65 (defvar texinfo-defun-type
)
66 (defvar texinfo-last-node-pos
)
67 (defvar texinfo-stack
)
68 (defvar texinfo-short-index-cmds-alist
)
69 (defvar texinfo-short-index-format-cmds-alist
)
70 (defvar texinfo-format-filename
)
71 (defvar texinfo-footnote-number
)
73 (defvar texinfo-raisesections-alist
74 '((@chapter .
@chapter
) ; Cannot go higher
75 (@unnumbered .
@unnumbered
)
76 (@centerchap .
@unnumbered
)
78 (@majorheading .
@majorheading
)
79 (@chapheading .
@chapheading
)
80 (@appendix .
@appendix
)
83 (@unnumberedsec .
@unnumbered
)
84 (@heading .
@chapheading
)
85 (@appendixsec .
@appendix
)
87 (@subsection .
@section
)
88 (@unnumberedsubsec .
@unnumberedsec
)
89 (@subheading .
@heading
)
90 (@appendixsubsec .
@appendixsec
)
92 (@subsubsection .
@subsection
)
93 (@unnumberedsubsubsec .
@unnumberedsubsec
)
94 (@subsubheading .
@subheading
)
95 (@appendixsubsubsec .
@appendixsubsec
))
96 "An alist of next higher levels for chapters, sections, etc...
97 For example, section to chapter, subsection to section.
98 Used by `texinfo-raise-lower-sections'.
99 The keys specify types of section; the values correspond to the next
102 (defvar texinfo-lowersections-alist
103 '((@chapter .
@section
)
104 (@unnumbered .
@unnumberedsec
)
105 (@centerchap .
@unnumberedsec
)
106 (@majorheading .
@heading
)
107 (@chapheading .
@heading
)
108 (@appendix .
@appendixsec
)
110 (@section .
@subsection
)
111 (@unnumberedsec .
@unnumberedsubsec
)
112 (@heading .
@subheading
)
113 (@appendixsec .
@appendixsubsec
)
115 (@subsection .
@subsubsection
)
116 (@unnumberedsubsec .
@unnumberedsubsubsec
)
117 (@subheading .
@subsubheading
)
118 (@appendixsubsec .
@appendixsubsubsec
)
120 (@subsubsection .
@subsubsection
) ; Cannot go lower.
121 (@unnumberedsubsubsec .
@unnumberedsubsubsec
)
122 (@subsubheading .
@subsubheading
)
123 (@appendixsubsubsec .
@appendixsubsubsec
))
124 "An alist of next lower levels for chapters, sections, etc...
125 For example, chapter to section, section to subsection.
126 Used by `texinfo-raise-lower-sections'.
127 The keys specify types of section; the values correspond to the next
132 (defvar texinfo-format-syntax-table
133 (let ((st (make-syntax-table)))
134 (modify-syntax-entry ?
\" " " st
)
135 (modify-syntax-entry ?
\\ " " st
)
136 (modify-syntax-entry ?
@ "\\" st
)
137 (modify-syntax-entry ?\^q
"\\" st
)
138 (modify-syntax-entry ?\
[ "." st
)
139 (modify-syntax-entry ?\
] "." st
)
140 (modify-syntax-entry ?\
( "." st
)
141 (modify-syntax-entry ?\
) "." st
)
142 (modify-syntax-entry ?
{ "(}" st
)
143 (modify-syntax-entry ?
} "){" st
)
144 (modify-syntax-entry ?
\' "." st
)
148 ;;; Top level buffer and region formatting functions
151 (defun texinfo-format-buffer (&optional nosplit
)
152 "Process the current buffer as texinfo code, into an Info file.
153 The Info file output is generated in a buffer visiting the Info file
154 name specified in the @setfilename command.
156 Non-nil argument (prefix, if interactive) means don't make tag table
157 and don't split the file if large. You can use `Info-tagify' and
158 `Info-split' to do these manually."
160 (let ((lastmessage "Formatting Info file...")
161 (coding-system-for-write buffer-file-coding-system
))
162 (message lastmessage
)
164 (texinfo-format-buffer-1)
168 (if (> (buffer-size) (+ 50000 Info-split-threshold
))
170 (message (setq lastmessage
"Splitting Info file..."))
172 (message (concat lastmessage
173 (if (called-interactively-p 'interactive
)
174 "done. Now save it." "done.")))))
176 (defvar texinfo-region-buffer-name
"*Info Region*"
177 "Name of the temporary buffer used by \\[texinfo-format-region].")
179 (defvar texinfo-pre-format-hook nil
180 "Hook called before the conversion of the Texinfo file to Info format.
181 The functions on this hook are called with argument BUFFER, the buffer
182 containing the Texinfo file.")
184 ;; These come from tex-mode.el.
185 (defvar tex-start-of-header
)
186 (defvar tex-end-of-header
)
189 (defun texinfo-format-region (region-beginning region-end
)
190 "Convert the current region of the Texinfo file to Info format.
191 This lets you see what that part of the file will look like in Info.
192 The command is bound to \\[texinfo-format-region]. The text that is
193 converted to Info is stored in a temporary buffer."
195 (message "Converting region to Info format...")
196 (let (texinfo-command-start
206 (texinfo-format-filename "")
207 texinfo-example-start
208 texinfo-last-node-pos
211 (texinfo-footnote-number 0)
213 (fill-column-for-info fill-column
)
214 (input-buffer (current-buffer))
215 (input-directory default-directory
)
220 ;;; Copy lines between beginning and end of header lines,
221 ;;; if any, or else copy the `@setfilename' line, if any.
225 (goto-char (point-min))
226 (let ((search-end (line-beginning-position 101)))
228 ;; Either copy header text.
231 (search-forward tex-start-of-header search-end t
)
233 ;; Mark beginning of header.
234 (setq header-beginning
(point)))
236 (search-forward tex-end-of-header nil t
)
238 ;; Mark end of header
239 (setq header-end
(point))))
240 ;; Or copy @filename line.
242 (goto-char (point-min))
243 (search-forward "@setfilename" search-end t
)
245 (setq header-beginning
(point))
247 (setq header-end
(point))))
251 (buffer-substring-no-properties
252 (min header-beginning region-beginning
)
255 ;;; Find a buffer to use.
256 (switch-to-buffer (get-buffer-create texinfo-region-buffer-name
))
257 (setq buffer-read-only t
)
258 (let ((inhibit-read-only t
))
260 ;; Insert the header into the buffer.
262 ;; Insert the region into the buffer.
263 (insert-buffer-substring
265 (max region-beginning header-end
)
267 (run-hook-with-args 'texinfo-pre-format-hook input-buffer
)
268 ;; Make sure region ends in a newline.
269 (or (= (preceding-char) ?
\n)
272 (goto-char (point-min))
274 (message "Converting region to Info format...")
275 (setq fill-column fill-column-for-info
)
276 ;; Install a syntax table useful for scanning command operands.
277 (set-syntax-table texinfo-format-syntax-table
)
279 ;; Insert @include files so `texinfo-raise-lower-sections' can
280 ;; work on them without losing track of multiple
281 ;; @raise/@lowersections commands.
282 (while (re-search-forward "^@include" nil t
)
283 (setq texinfo-command-end
(point))
284 (let ((filename (concat input-directory
285 (texinfo-parse-line-arg))))
286 (re-search-backward "^@include")
287 (delete-region (point) (line-beginning-position 2))
288 (message "Reading included file: %s" filename
)
293 (+ (point) (car (cdr (insert-file-contents filename
)))))
294 (goto-char (point-min))
295 ;; Remove `@setfilename' line from included file, if any,
296 ;; so @setfilename command not duplicated.
297 (if (re-search-forward "^@setfilename" (line-end-position 100) t
)
298 (delete-region (line-beginning-position 1)
299 (line-beginning-position 2)))))))
301 ;; Raise or lower level of each section, if necessary.
302 (goto-char (point-min))
303 (texinfo-raise-lower-sections)
304 ;; Append @refill to appropriate paragraphs for filling.
305 (goto-char (point-min))
306 (texinfo-append-refill)
307 ;; If the region includes the effective end of the data,
308 ;; discard everything after that.
309 (goto-char (point-max))
310 (if (re-search-backward "^@bye" nil t
)
311 (delete-region (point) (point-max)))
312 ;; Make sure buffer ends in a newline.
313 (or (= (preceding-char) ?
\n)
315 ;; Don't use a previous value of texinfo-enclosure-list.
316 (setq texinfo-enclosure-list nil
)
317 (setq texinfo-alias-list nil
)
319 (goto-char (point-min))
320 (if (looking-at "\\\\input[ \t]+texinfo")
321 (delete-region (point) (line-beginning-position 2)))
323 ;; Insert Info region title text.
324 (goto-char (point-min))
325 (if (search-forward "@setfilename" (line-beginning-position 101) t
)
327 (setq texinfo-command-end
(point))
329 (setq texinfo-command-start
(point))
330 (let ((arg (texinfo-parse-arg-discard)))
332 texinfo-region-buffer-name
334 (insert (file-name-nondirectory (expand-file-name arg
)))
335 (insert "', -*-Text-*-\n")))
336 ;; Else no `@setfilename' line
338 texinfo-region-buffer-name
339 " buffer -*-Text-*-\n"))
340 (insert "produced by `texinfo-format-region'\n"
342 (if (buffer-file-name input-buffer
)
344 (file-name-sans-versions
345 (file-name-nondirectory
346 (buffer-file-name input-buffer
)))
348 (concat "buffer `" (buffer-name input-buffer
) "'"))
349 "\nusing `texinfmt.el' version "
353 ;; Now convert for real.
354 (goto-char (point-min))
355 (texinfo-format-scan)
356 (goto-char (point-min))
357 (Info-tagify input-buffer
)
358 (goto-char (point-min))
362 (defun texi2info (&optional nosplit
)
363 "Convert the current buffer (written in Texinfo code) into an Info file.
364 The Info file output is generated in a buffer visiting the Info file
365 names specified in the @setfilename command.
367 This function automatically updates all node pointers and menus, and
368 creates a master menu. This work is done on a temporary buffer that
369 is automatically removed when the Info file is created. The original
370 Texinfo source buffer is not changed.
372 Non-nil argument (prefix, if interactive) means don't split the file
373 if large. You can use `Info-split' to do this manually."
375 (let ((temp-buffer (concat "*--" (buffer-name) "--temporary-buffer*" )))
376 (message "First updating nodes and menus, then creating Info file.")
378 (copy-to-buffer temp-buffer
(point-min) (point-max))
379 (switch-to-buffer temp-buffer
)
380 (texinfo-master-menu t
)
381 (message "Now creating Info file.")
383 (texinfo-format-buffer nosplit
)
385 (kill-buffer temp-buffer
)))
388 ;;; Primary internal formatting function for the whole buffer.
390 (defun texinfo-format-buffer-1 ()
391 (let (texinfo-format-filename
392 texinfo-example-start
393 texinfo-command-start
397 texinfo-last-node-pos
406 (texinfo-footnote-number 0)
409 (fill-column-for-info fill-column
)
410 (input-buffer (current-buffer))
411 (input-directory default-directory
))
412 (setq texinfo-enclosure-list nil
)
413 (setq texinfo-alias-list nil
)
415 (goto-char (point-min))
416 (or (search-forward "@setfilename" nil t
)
417 (error "Texinfo file needs an `@setfilename FILENAME' line"))
418 (setq texinfo-command-end
(point))
419 (setq outfile
(texinfo-parse-line-arg)))
424 (buffer-disable-undo)
426 (message "Formatting Info file: %s" outfile
)
427 (setq texinfo-format-filename
428 (file-name-nondirectory (expand-file-name outfile
)))
430 (setq fill-column fill-column-for-info
)
431 (set-syntax-table texinfo-format-syntax-table
)
433 (insert-buffer-substring input-buffer
)
434 (run-hook-with-args 'texinfo-pre-format-hook input-buffer
)
435 (message "Converting %s to Info format..." (buffer-name input-buffer
))
437 ;; Insert @include files so `texinfo-raise-lower-sections' can
438 ;; work on them without losing track of multiple
439 ;; @raise/@lowersections commands.
440 (goto-char (point-min))
441 (while (re-search-forward "^@include" nil t
)
442 (setq texinfo-command-end
(point))
443 (let ((filename (concat input-directory
444 (texinfo-parse-line-arg))))
445 (re-search-backward "^@include")
446 (delete-region (point) (line-beginning-position 2))
447 (message "Reading included file: %s" filename
)
452 (+ (point) (car (cdr (insert-file-contents filename
)))))
453 (goto-char (point-min))
454 ;; Remove `@setfilename' line from included file, if any,
455 ;; so @setfilename command not duplicated.
456 (if (re-search-forward "^@setfilename" (line-end-position 100) t
)
457 (delete-region (line-beginning-position 1)
458 (line-beginning-position 2)))))))
459 ;; Raise or lower level of each section, if necessary.
460 (goto-char (point-min))
461 (texinfo-raise-lower-sections)
462 ;; Append @refill to appropriate paragraphs
463 (goto-char (point-min))
464 (texinfo-append-refill)
465 (goto-char (point-min))
466 (search-forward "@setfilename")
468 (delete-region (point-min) (point))
469 ;; Remove @bye at end of file, if it is there.
470 (goto-char (point-max))
471 (if (search-backward "@bye" nil t
)
472 (delete-region (point) (point-max)))
473 ;; Make sure buffer ends in a newline.
474 (or (= (preceding-char) ?
\n)
476 ;; Scan the whole buffer, converting to Info format.
477 (texinfo-format-scan)
478 (goto-char (point-min))
479 ;; Insert info about how this file was made.
480 (insert "Info file: "
481 texinfo-format-filename
", -*-Text-*-\n"
482 "produced by `texinfo-format-buffer'\n"
483 ;; Date string removed so that regression testing is easier.
485 ;; (insert (format-time-string "%e %b %Y")) " "
487 (if (buffer-file-name input-buffer
)
489 (file-name-sans-versions
490 (file-name-nondirectory
491 (buffer-file-name input-buffer
)))
493 (concat "buffer `" (buffer-name input-buffer
) "'"))
494 "\nusing `texinfmt.el' version "
497 ;; Return data for indices.
499 texinfo-vindex texinfo-findex texinfo-cindex
500 texinfo-pindex texinfo-tindex texinfo-kindex
)))
503 ;;; Perform non-@-command file conversions: quotes and hyphens
505 (defun texinfo-format-convert (min max
)
506 ;; Convert left and right quotes to typewriter font quotes.
508 (while (search-forward "``" max t
)
509 (replace-match "\""))
511 (while (search-forward "''" max t
)
512 (replace-match "\""))
513 ;; Convert three hyphens in a row to two.
515 (while (re-search-forward "\\( \\|\\w\\)\\(---\\)\\( \\|\\w\\)" max t
)
516 (delete-region (1+ (match-beginning 2)) (+ 2 (match-beginning 2)))))
519 ;;; Handle paragraph filling
521 ;; Keep as concatenated lists for ease of maintenance
523 (defvar texinfo-no-refill-regexp
527 ;; add "itemize\\|" (from experiment of 2001 Nov 28)
528 ;; because of a problem with @end itemize@refill
529 ;; I don't know if this causes other problems.
530 ;; I suspect itemized lists don't get filled properly and a
531 ;; more precise fix is required. Bob
532 ;; commented out on 2005 Feb 28 by Bob
553 "Regexp specifying environments in which paragraphs are not filled.")
555 (defvar texinfo-accent-commands
588 (defvar texinfo-part-of-para-regexp
623 "@-\\|" ; @- is a discretionary hyphen (not an accent) (a noop).
624 texinfo-accent-commands
627 "Regexp specifying @-commands found within paragraphs.")
629 (defun texinfo-append-refill ()
630 "Append @refill at end of each paragraph that should be filled.
631 Do not append @refill to paragraphs within @example and similar environments.
632 Do not append @refill to paragraphs containing @w{TEXT} or @*."
634 ;; It is necessary to append @refill before other processing because
635 ;; the other processing removes information that tells Texinfo
636 ;; whether the text should or should not be filled.
638 (while (< (point) (point-max))
639 (let ((refill-blank-lines "^[ \t\n]*$")
640 (case-fold-search nil
)) ; Don't confuse @TeX and @tex....
642 ;; 1. Skip over blank lines;
643 ;; skip over lines beginning with @-commands,
644 ;; but do not skip over lines
645 ;; that are no-refill environments such as @example or
646 ;; that begin with within-paragraph @-commands such as @code.
647 (while (and (looking-at (concat "^@\\|^\\\\\\|" refill-blank-lines
))
651 texinfo-no-refill-regexp
653 texinfo-part-of-para-regexp
655 (< (point) (point-max)))
657 ;; 2. Skip over @example and similar no-refill environments.
658 (if (looking-at texinfo-no-refill-regexp
)
659 (let ((environment (match-string-no-properties 1)))
660 (progn (re-search-forward (concat "^@end " environment
) nil t
)
663 ;; 3. Do not refill a paragraph containing @w or @*, or ending
664 ;; with @<newline> followed by a newline.
665 (if (or (>= (point) (point-max))
668 (save-excursion (forward-paragraph)
669 (line-beginning-position 2))
671 ;; Go to end of paragraph and do nothing.
673 ;; 4. Else go to end of paragraph and insert @refill
676 (let ((line-beg (point)))
680 (save-excursion (skip-chars-backward " \t") (point)))
682 (unless (re-search-backward "@c[ \t\n]\\|@comment[ \t\n]" line-beg t
)
684 (unless (re-search-backward "@refill\\|^[ \t]*@" line-beg t
)
686 (forward-line 1))))))
689 ;;; Handle `@raisesections' and `@lowersections' commands
691 ;; These commands change the hierarchical level of chapter structuring
694 ;; @raisesections changes @subsection to @section,
695 ;; @section to @chapter,
698 ;; @lowersections changes @chapter to @section
699 ;; @subsection to @subsubsection,
702 ;; An @raisesections/@lowersections command changes only those
703 ;; structuring commands that follow the @raisesections/@lowersections
706 ;; Repeated @raisesections/@lowersections continue to raise or lower
707 ;; the heading level.
709 ;; An @lowersections command cancels an @raisesections command, and
712 ;; You cannot raise or lower "beyond" chapters or subsubsections, but
713 ;; trying to do so does not elicit an error---you just get more
714 ;; headings that mean the same thing as you keep raising or lowering
715 ;; (for example, after a single @raisesections, both @chapter and
716 ;; @section produce chapter headings).
718 (defun texinfo-raise-lower-sections ()
719 "Raise or lower the hierarchical level of chapters, sections, etc.
721 This function acts according to `@raisesections' and `@lowersections'
722 commands in the Texinfo file.
724 For example, an `@lowersections' command is useful if you wish to
725 include what is written as an outer or standalone Texinfo file in
726 another Texinfo file as an inner, included file. The `@lowersections'
727 command changes chapters to sections, sections to subsections and so
730 @raisesections changes @subsection to @section,
731 @section to @chapter,
732 @heading to @chapheading,
735 @lowersections changes @chapter to @section,
736 @subsection to @subsubsection,
737 @heading to @subheading,
740 An `@raisesections' or `@lowersections' command changes only those
741 structuring commands that follow the `@raisesections' or
742 `@lowersections' command.
744 An `@lowersections' command cancels an `@raisesections' command, and
747 Repeated use of the commands continue to raise or lower the hierarchical
748 level a step at a time.
750 An attempt to raise above `chapters' reproduces chapter commands; an
751 attempt to lower below subsubsections reproduces subsubsection
754 ;; `texinfo-section-types-regexp' is defined in `texnfo-upd.el';
755 ;; it is a regexp matching chapter, section, other headings
756 ;; (but not the top node).
758 (let (type (level 0))
762 "\\(\\(^@\\(raise\\|lower\\)sections\\)\\|\\("
763 texinfo-section-types-regexp
767 (save-excursion (setq type
(read (current-buffer))))
770 ;; 1. Increment level
771 ((eq type
'@raisesections
)
772 (setq level
(1+ level
))
774 (point) (line-beginning-position 2)))
776 ;; 2. Decrement level
777 ((eq type
'@lowersections
)
778 (setq level
(1- level
))
780 (point) (line-beginning-position 2)))
782 ;; Now handle structuring commands
785 ;; 3. Raise level when positive
791 (cdr (assq new-level texinfo-raisesections-alist
)))
792 (setq count
(1- count
)))
794 (insert (symbol-name new-level
))))
796 ;; 4. Do nothing except move point when level is zero
797 ((= level
0) (forward-line 1))
799 ;; 5. Lower level when positive
805 (cdr (assq new-level texinfo-lowersections-alist
)))
806 (setq count
(1+ count
)))
808 (insert (symbol-name new-level
))))))))))
810 ;;; Perform those texinfo-to-info conversions that apply to the whole input
813 (defun texinfo-format-scan ()
814 (texinfo-format-convert (point-min) (point-max))
815 ;; Search for @copying, which has to be first since the
816 ;; @insertcopying command then inserts the text elsewhere.
817 (goto-char (point-min))
818 (when (search-forward "@copying" nil t
)
820 (while (search-forward "@insertcopying" nil t
)
821 (delete-region (match-beginning 0) (match-end 0))
823 (texinfo-insertcopying))
824 ;; Scan for other @-commands.
825 (goto-char (point-min))
826 (while (search-forward "@" nil t
)
828 ;; These are the single-character accent commands: @^ @` @' @" @= @~
829 ;; In Info, they are simply quoted and the @ deleted.
830 ;; Other single-character commands:
831 ;; @* forces a line break,
832 ;; @- is a discretionary hyphenation point; does nothing in Info.
833 ;; @<space>, @<tab>, @<newline> each produce a single space,
834 ;; unless followed by a newline.
836 ;; Old version 2.34 expression: (looking-at "[@{}^'` *\"?!]")
837 (if (looking-at "[@{}^'`\"=~ \t\n*?!-]")
838 ;; @*, causes a line break.
841 ((= (following-char) ?
*)
843 (delete-region (1- (point)) (1+ (point)))
844 ;; insert return if not at end of line;
845 ;; else line is already broken.
846 (if (not (= (following-char) ?
\n))
849 ((= (following-char) ?-
)
850 (delete-region (1- (point)) (1+ (point))))
851 ;; @<space>, @<tab>, @<newline>: produce a single space,
852 ;; unless followed by a newline.
853 ((= (following-char) ?
)
854 (delete-region (1- (point)) (1+ (point)))
855 ;; insert single space if not at end of line;
856 ;; else line is already broken.
857 (if (not (= (following-char) ?
\n))
859 ((= (following-char) ?
\t)
860 (delete-region (1- (point)) (1+ (point)))
861 ;; insert single space if not at end of line;
862 ;; else line is already broken.
863 (if (not (= (following-char) ?
\n))
865 ;; following char is a carriage return
866 ((= (following-char) ?
\n)
868 (delete-region (1- (point)) (1+ (point)))
869 ;; insert single space if not at end of line;
870 ;; else line is already broken.
871 (if (not (= (following-char) ?
\n))
873 ;; Otherwise: the other characters are simply quoted. Delete the @.
876 ;; Be compatible with makeinfo: if @' and its ilk are
877 ;; followed by a @ without a brace, barf.
878 (if (looking-at "[\"'^`~=]")
880 (if (= (char-after (1+ (point))) ?
@)
881 (error "Use braces to give a command as an argument to @%c"
884 ;; @' etc. can optionally accept their argument in
885 ;; braces (makeinfo supports that).
886 (when (looking-at "{")
887 (let ((start (point)))
893 ;; @ is followed by a command-word; find the end of the word.
894 (setq texinfo-command-start
(1- (point)))
895 (if (= (char-syntax (following-char)) ?w
)
898 (setq texinfo-command-end
(point))
899 ;; Detect the case of two @-commands in a row;
900 ;; process just the first one.
901 (goto-char (1+ texinfo-command-start
))
902 (skip-chars-forward "^@" texinfo-command-end
)
903 (setq texinfo-command-end
(point))
904 ;; Handle let aliasing
905 (setq texinfo-command-name
908 (buffer-substring-no-properties
909 (1+ texinfo-command-start
) texinfo-command-end
)))
910 (while (setq trial
(assoc cmdname texinfo-alias-list
))
911 (setq cmdname
(cdr trial
)))
913 ;; Call the handler for this command.
914 (let ((enclosure-type
916 (symbol-name texinfo-command-name
)
917 texinfo-enclosure-list
)))
921 (car (car (cdr enclosure-type
)))
922 (texinfo-parse-arg-discard)
923 (car (cdr (car (cdr enclosure-type
)))))
924 (goto-char texinfo-command-start
))
925 (let ((cmd (get texinfo-command-name
'texinfo-format
)))
926 (if cmd
(funcall cmd
) (texinfo-unsupported)))))))
929 (goto-char (nth 2 (car texinfo-stack
)))
930 (error "Unterminated @%s" (car (car texinfo-stack
)))))
932 ;; Remove excess whitespace
933 (let ((whitespace-silent t
))
934 (whitespace-cleanup)))
936 (defvar texinfo-copying-text
""
937 "Text of the copyright notice and copying permissions.")
939 (defun texinfo-copying ()
940 "Copy the copyright notice and copying permissions from the Texinfo file,
941 as indicated by the @copying ... @end copying command;
942 insert the text with the @insertcopying command."
943 (let ((beg (progn (beginning-of-line) (point)))
944 (end (progn (re-search-forward "^@end copying[ \t]*\n") (point))))
945 (setq texinfo-copying-text
946 (buffer-substring-no-properties
947 (save-excursion (goto-char beg
) (line-beginning-position 2))
948 (save-excursion (goto-char end
) (line-beginning-position 0))))
949 (delete-region beg end
)))
951 (defun texinfo-insertcopying ()
952 "Insert the copyright notice and copying permissions from the Texinfo file,
953 which are indicated by the @copying ... @end copying command."
954 (insert (concat "\n" texinfo-copying-text
)))
956 (put 'begin
'texinfo-format
'texinfo-format-begin
)
957 (defun texinfo-format-begin ()
958 (texinfo-format-begin-end 'texinfo-format
))
960 (put 'end
'texinfo-format
'texinfo-format-end
)
961 (defun texinfo-format-end ()
962 (texinfo-format-begin-end 'texinfo-end
))
964 (defun texinfo-format-begin-end (prop)
965 (setq texinfo-command-name
(intern (texinfo-parse-line-arg)))
966 (let ((cmd (get texinfo-command-name prop
)))
967 (if cmd
(funcall cmd
)
968 (texinfo-unsupported))))
970 ;;; Parsing functions
972 (defun texinfo-parse-line-arg ()
973 "Return argument of @-command as string.
974 Argument is separated from command either by a space or by a brace.
975 If a space, return rest of line, with beginning and ending white
976 space removed. If a brace, return string between braces.
977 Leave point after argument."
978 (goto-char texinfo-command-end
)
979 (let ((start (point)))
980 (cond ((looking-at " ")
981 (skip-chars-forward " ")
984 (skip-chars-backward " ")
985 (delete-region (point) (progn (end-of-line) (point)))
986 (setq texinfo-command-end
(1+ (point))))
988 (setq start
(1+ (point)))
990 (setq texinfo-command-end
(point))
993 (error "Invalid texinfo command arg format")))
994 (prog1 (buffer-substring-no-properties start
(point))
995 (if (eolp) (forward-char 1)))))
997 (defun texinfo-parse-expanded-arg ()
998 (goto-char texinfo-command-end
)
999 (let ((start (point))
1001 (cond ((looking-at " ")
1002 (skip-chars-forward " ")
1003 (setq start
(point))
1005 (setq texinfo-command-end
(1+ (point))))
1007 (setq start
(1+ (point)))
1009 (setq texinfo-command-end
(point))
1012 (error "Invalid texinfo command arg format")))
1013 (setq marker
(move-marker (make-marker) texinfo-command-end
))
1014 (texinfo-format-expand-region start
(point))
1015 (setq texinfo-command-end
(marker-position marker
))
1016 (move-marker marker nil
)
1017 (prog1 (buffer-substring-no-properties start
(point))
1018 (if (eolp) (forward-char 1)))))
1020 (defun texinfo-format-expand-region (start end
)
1022 (narrow-to-region start end
)
1023 (let (texinfo-command-start
1025 texinfo-command-name
1027 (texinfo-format-scan))
1028 (goto-char (point-max))))
1030 (defun texinfo-parse-arg-discard ()
1031 "Delete command and argument; return argument of command."
1032 (prog1 (texinfo-parse-line-arg)
1033 (texinfo-discard-command)))
1035 (defun texinfo-discard-command ()
1036 (delete-region texinfo-command-start texinfo-command-end
))
1038 (defun texinfo-optional-braces-discard ()
1039 "Discard braces following command, if any."
1040 (goto-char texinfo-command-end
)
1041 (let ((start (point)))
1042 (cond ((looking-at "[ \t]*\n")) ; do nothing
1043 ((looking-at "{") ; remove braces, if any
1045 (setq texinfo-command-end
(point)))
1048 "Invalid `texinfo-optional-braces-discard' format \(need braces?\)")))
1049 (delete-region texinfo-command-start texinfo-command-end
)))
1051 (defun texinfo-format-parse-line-args ()
1052 (let ((start (1- (point)))
1055 (skip-chars-forward " ")
1058 (re-search-forward "[\n,]")
1060 (if (bolp) (setq next
(1- next
)))
1062 (skip-chars-backward " ")
1064 (push (if (> end beg
) (buffer-substring-no-properties beg end
))
1067 (skip-chars-forward " "))
1068 (if (eolp) (forward-char 1))
1069 (setq texinfo-command-end
(point))
1072 (defun texinfo-format-parse-args ()
1073 (let ((start (1- (point)))
1076 (search-forward "{")
1078 (texinfo-format-expand-region
1080 (save-excursion (up-list 1) (1- (point)))))
1081 ;; The following does not handle cross references of the form:
1082 ;; `@xref{bullet, , @code{@@bullet}@{@}}.' because the
1083 ;; re-search-forward finds the first right brace after the second
1085 (while (/= (preceding-char) ?\
})
1086 (skip-chars-forward " \t\n")
1088 (re-search-forward "[},]")
1091 (skip-chars-backward " \t\n")
1095 (while (search-forward "\n" end t
)
1096 (replace-match " "))))
1097 (push (if (> end beg
) (buffer-substring-no-properties beg end
))
1100 ;;(if (eolp) (forward-char 1))
1101 (setq texinfo-command-end
(point))
1104 (defun texinfo-format-parse-defun-args ()
1105 (goto-char texinfo-command-end
)
1106 (let ((start (point)))
1108 (setq texinfo-command-end
(1+ (point)))
1109 (let ((marker (move-marker (make-marker) texinfo-command-end
)))
1110 (texinfo-format-expand-region start
(point))
1111 (setq texinfo-command-end
(marker-position marker
))
1112 (move-marker marker nil
))
1116 (skip-chars-forward " ")
1118 (cond ((looking-at "{")
1119 (setq beg
(1+ (point)))
1121 (setq end
(1- (point))))
1124 (re-search-forward "[\n ]")
1126 (setq end
(point))))
1127 (push (buffer-substring-no-properties beg end
) args
)
1128 (skip-chars-forward " "))
1132 (defun texinfo-discard-line ()
1133 (goto-char texinfo-command-end
)
1134 (skip-chars-forward " \t")
1136 (error "Extraneous text at end of command line"))
1137 (goto-char texinfo-command-start
)
1139 (error "Extraneous text at beginning of command line"))
1140 (delete-region (point) (progn (forward-line 1) (point))))
1142 (defun texinfo-discard-line-with-args ()
1143 (goto-char texinfo-command-start
)
1144 (delete-region (point) (progn (forward-line 1) (point))))
1149 ;; Only `texinfo-format-buffer' handles @setfilename with this
1150 ;; definition; `texinfo-format-region' handles @setfilename, if any,
1152 (put 'setfilename
'texinfo-format
'texinfo-format-setfilename
)
1153 (defun texinfo-format-setfilename ()
1154 (texinfo-parse-arg-discard))
1156 ;;; @node, @menu, @detailmenu
1158 (put 'node
'texinfo-format
'texinfo-format-node
)
1159 (put 'nwnode
'texinfo-format
'texinfo-format-node
)
1160 (defun texinfo-format-node ()
1161 (let* ((args (texinfo-format-parse-line-args))
1166 (texinfo-discard-command)
1167 (setq texinfo-last-node name
)
1168 (let ((tem (if texinfo-fold-nodename-case
(downcase name
) name
)))
1169 (if (assoc tem texinfo-node-names
)
1170 (error "Duplicate node name: %s" name
)
1171 (push (list tem
) texinfo-node-names
)))
1172 (setq texinfo-footnote-number
0)
1173 ;; insert "\n\^_" unconditionally since this is what info is looking for
1174 (insert "\n\^_\nFile: " texinfo-format-filename
1177 (insert ", Next: " next
))
1179 (insert ", Prev: " prev
))
1181 (insert ", Up: " up
))
1183 (setq texinfo-last-node-pos
(point))))
1185 (put 'anchor
'texinfo-format
'texinfo-anchor
)
1186 (defun texinfo-anchor ()
1188 (here (- (point) 7)) ; save location of beginning of `@anchor'
1189 (arg (texinfo-parse-arg-discard)))
1190 (if (looking-at " ") ; since a space may be left after -discard
1193 (let ((end (point)))
1196 (search-forward "@refill" end t
))
1197 (setq anchor-string
"@anchor-yes-refill")
1198 (setq anchor-string
"@anchor-no-refill")))
1200 (insert anchor-string
"{" arg
"}")))
1202 (put 'menu
'texinfo-format
'texinfo-format-menu
)
1203 (defun texinfo-format-menu ()
1204 (texinfo-discard-line)
1205 (insert "* Menu:\n\n"))
1207 (put 'menu
'texinfo-end
'texinfo-discard-command
)
1209 ;; The @detailmenu should be removed eventually.
1211 ;; According to Karl Berry, 31 August 1996:
1213 ;; You don't like, I don't like it. I agree, it would be better just to
1214 ;; fix the bug [in `makeinfo']. .. At this point, since inserting those
1215 ;; two commands in the Elisp fn is trivial, I don't especially want to
1216 ;; expend more effort...
1218 ;; I added a couple sentences of documentation to the manual (putting the
1219 ;; blame on makeinfo where it belongs :-().
1221 (put 'detailmenu
'texinfo-format
'texinfo-discard-line
)
1222 (put 'detailmenu
'texinfo-end
'texinfo-discard-command
)
1224 ;; (Also see `texnfo-upd.el')
1227 ;;; Cross references
1229 ;; @xref {NODE, FNAME, NAME, FILE, DOCUMENT}
1230 ;; -> *Note FNAME: (FILE)NODE
1231 ;; If FILE is missing,
1232 ;; *Note FNAME: NODE
1233 ;; If FNAME is empty and NAME is present
1235 ;; If both NAME and FNAME are missing
1237 ;; texinfo ignores the DOCUMENT argument.
1238 ;; -> See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
1239 ;; If FILE is specified, (FILE)NODE is used for xrefs.
1240 ;; If fifth argument DOCUMENT is specified, produces
1241 ;; See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
1244 ;; @ref a reference that does not put `See' or `see' in
1245 ;; the hardcopy and is the same as @xref in Info
1246 (put 'ref
'texinfo-format
'texinfo-format-xref
)
1248 (put 'xref
'texinfo-format
'texinfo-format-xref
)
1249 (defun texinfo-format-xref ()
1250 (let ((args (texinfo-format-parse-args)))
1251 (texinfo-discard-command)
1253 (let ((fname (or (nth 1 args
) (nth 2 args
))))
1254 (if (null (or fname
(nth 3 args
)))
1255 (insert (car args
) "::")
1256 (insert (or fname
(car args
)) ": ")
1258 (insert "(" (nth 3 args
) ")"))
1259 (and (car args
) (insert (car args
)))))))
1261 (put 'pxref
'texinfo-format
'texinfo-format-pxref
)
1262 (defun texinfo-format-pxref ()
1263 (texinfo-format-xref)
1269 ;; @inforef{NODE, FNAME, FILE}
1270 ;; Like @xref{NODE, FNAME,,FILE} in texinfo.
1271 ;; In Tex, generates "See Info file FILE, node NODE"
1272 (put 'inforef
'texinfo-format
'texinfo-format-inforef
)
1273 (defun texinfo-format-inforef ()
1274 (let ((args (texinfo-format-parse-args)))
1275 (texinfo-discard-command)
1277 (insert "*Note " (nth 1 args
) ": (" (nth 2 args
) ")" (car args
))
1278 (insert "*Note " "(" (nth 2 args
) ")" (car args
) "::"))))
1281 ;;; URL Reference: @uref
1283 ;; @uref produces a reference to a uniform resource locator (URL).
1284 ;; It takes one mandatory argument, the URL, and one optional argument,
1285 ;; the text to display (the default is the URL itself).
1287 (put 'uref
'texinfo-format
'texinfo-format-uref
)
1288 (defun texinfo-format-uref ()
1289 "Format URL and optional URL-TITLE.
1290 Insert ` ... ' around URL if no URL-TITLE argument;
1291 otherwise, insert URL-TITLE followed by URL in parentheses."
1292 (let ((args (texinfo-format-parse-args)))
1293 (texinfo-discard-command)
1296 (insert (nth 1 args
) " (" (nth 0 args
) ")")
1297 (insert "`" (nth 0 args
) "'"))
1298 (goto-char texinfo-command-start
)))
1301 ;;; Section headings
1303 (put 'majorheading
'texinfo-format
'texinfo-format-chapter
)
1304 (put 'chapheading
'texinfo-format
'texinfo-format-chapter
)
1305 (put 'ichapter
'texinfo-format
'texinfo-format-chapter
)
1306 (put 'chapter
'texinfo-format
'texinfo-format-chapter
)
1307 (put 'iappendix
'texinfo-format
'texinfo-format-chapter
)
1308 (put 'appendix
'texinfo-format
'texinfo-format-chapter
)
1309 (put 'iunnumbered
'texinfo-format
'texinfo-format-chapter
)
1310 (put 'top
'texinfo-format
'texinfo-format-chapter
)
1311 (put 'unnumbered
'texinfo-format
'texinfo-format-chapter
)
1312 (put 'centerchap
'texinfo-format
'texinfo-format-chapter
)
1313 (defun texinfo-format-chapter ()
1314 (texinfo-format-chapter-1 ?
*))
1316 (put 'heading
'texinfo-format
'texinfo-format-section
)
1317 (put 'isection
'texinfo-format
'texinfo-format-section
)
1318 (put 'section
'texinfo-format
'texinfo-format-section
)
1319 (put 'iappendixsection
'texinfo-format
'texinfo-format-section
)
1320 (put 'appendixsection
'texinfo-format
'texinfo-format-section
)
1321 (put 'iappendixsec
'texinfo-format
'texinfo-format-section
)
1322 (put 'appendixsec
'texinfo-format
'texinfo-format-section
)
1323 (put 'iunnumberedsec
'texinfo-format
'texinfo-format-section
)
1324 (put 'unnumberedsec
'texinfo-format
'texinfo-format-section
)
1325 (defun texinfo-format-section ()
1326 (texinfo-format-chapter-1 ?
=))
1328 (put 'subheading
'texinfo-format
'texinfo-format-subsection
)
1329 (put 'isubsection
'texinfo-format
'texinfo-format-subsection
)
1330 (put 'subsection
'texinfo-format
'texinfo-format-subsection
)
1331 (put 'iappendixsubsec
'texinfo-format
'texinfo-format-subsection
)
1332 (put 'appendixsubsec
'texinfo-format
'texinfo-format-subsection
)
1333 (put 'iunnumberedsubsec
'texinfo-format
'texinfo-format-subsection
)
1334 (put 'unnumberedsubsec
'texinfo-format
'texinfo-format-subsection
)
1335 (defun texinfo-format-subsection ()
1336 (texinfo-format-chapter-1 ?-
))
1338 (put 'subsubheading
'texinfo-format
'texinfo-format-subsubsection
)
1339 (put 'isubsubsection
'texinfo-format
'texinfo-format-subsubsection
)
1340 (put 'subsubsection
'texinfo-format
'texinfo-format-subsubsection
)
1341 (put 'iappendixsubsubsec
'texinfo-format
'texinfo-format-subsubsection
)
1342 (put 'appendixsubsubsec
'texinfo-format
'texinfo-format-subsubsection
)
1343 (put 'iunnumberedsubsubsec
'texinfo-format
'texinfo-format-subsubsection
)
1344 (put 'unnumberedsubsubsec
'texinfo-format
'texinfo-format-subsubsection
)
1345 (defun texinfo-format-subsubsection ()
1346 (texinfo-format-chapter-1 ?.
))
1348 (defun texinfo-format-chapter-1 (belowchar)
1349 (let ((arg (texinfo-parse-arg-discard)))
1350 (message "Formatting: %s ... " arg
) ; So we can see where we are.
1351 (insert ?
\n arg ?
\n "@SectionPAD " belowchar ?
\n)
1354 (put 'SectionPAD
'texinfo-format
'texinfo-format-sectionpad
)
1355 (defun texinfo-format-sectionpad ()
1356 (let ((str (texinfo-parse-arg-discard)))
1358 (let ((column (current-column)))
1362 (setq column
(1- column
))))
1366 ;;; Space controlling commands: @. and @:, and the soft hyphen.
1368 (put '\.
'texinfo-format
'texinfo-format-\.
)
1369 (defun texinfo-format-\.
()
1370 (texinfo-discard-command)
1373 (put '\
: 'texinfo-format
'texinfo-format-\
:)
1374 (defun texinfo-format-\
: ()
1375 (texinfo-discard-command))
1377 (put '\-
'texinfo-format
'texinfo-format-soft-hyphen
)
1378 (defun texinfo-format-soft-hyphen ()
1379 (texinfo-discard-command))
1382 ;;; @kbdinputstyle, @vskip, headings & footings
1383 ;; These commands for not for Info and should never
1384 ;; appear in an Info environment; but if they do,
1385 ;; this causes them to be discarded.
1388 (put 'kbdinputstyle
'texinfo-format
'texinfo-discard-line-with-args
)
1391 (put 'vskip
'texinfo-format
'texinfo-discard-line-with-args
)
1393 ;; headings & footings
1394 (put 'evenfooting
'texinfo-format
'texinfo-discard-line-with-args
)
1395 (put 'evenheading
'texinfo-format
'texinfo-discard-line-with-args
)
1396 (put 'oddfooting
'texinfo-format
'texinfo-discard-line-with-args
)
1397 (put 'oddheading
'texinfo-format
'texinfo-discard-line-with-args
)
1398 (put 'everyfooting
'texinfo-format
'texinfo-discard-line-with-args
)
1399 (put 'everyheading
'texinfo-format
'texinfo-discard-line-with-args
)
1402 ;;; @documentdescription ... @end documentdescription
1403 ;; This command is for HTML output and should never
1404 ;; appear in an Info environment; but if it does,
1405 ;; this causes it to be discarded.
1407 (put 'documentdescription
'texinfo-format
'texinfo-format-documentdescription
)
1408 (defun texinfo-format-documentdescription ()
1409 (delete-region texinfo-command-start
1410 (progn (re-search-forward "^@end documentdescription[ \t]*\n")
1415 ;;; @center, @sp, and @br
1417 (put 'center
'texinfo-format
'texinfo-format-center
)
1418 (defun texinfo-format-center ()
1419 (let ((arg (texinfo-parse-expanded-arg)))
1420 (texinfo-discard-command)
1424 (goto-char (1- (point)))
1425 (let ((indent-tabs-mode nil
))
1428 (put 'sp
'texinfo-format
'texinfo-format-sp
)
1429 (defun texinfo-format-sp ()
1430 (let* ((arg (texinfo-parse-arg-discard))
1432 (insert-char ?
\n num
)))
1434 (put 'br
'texinfo-format
'texinfo-format-paragraph-break
)
1435 (defun texinfo-format-paragraph-break ()
1436 "Force a paragraph break.
1437 If used within a line, follow `@br' with braces."
1438 (texinfo-optional-braces-discard)
1439 ;; insert one return if at end of line;
1440 ;; else insert two returns, to generate a blank line.
1441 (if (= (following-char) ?
\n)
1443 (insert-char ?
\n 2)))
1446 ;;; @footnote and @footnotestyle
1448 ;; In Texinfo, footnotes are created with the `@footnote' command.
1449 ;; This command is followed immediately by a left brace, then by the text of
1450 ;; the footnote, and then by a terminating right brace. The
1451 ;; template for a footnote is:
1455 ;; Info has two footnote styles:
1457 ;; * In the End of node style, all the footnotes for a single node
1458 ;; are placed at the end of that node. The footnotes are
1459 ;; separated from the rest of the node by a line of dashes with
1460 ;; the word `Footnotes' within it.
1462 ;; * In the Separate node style, all the footnotes for a single node
1463 ;; are placed in an automatically constructed node of their own.
1465 ;; Footnote style is specified by the @footnotestyle command, either
1466 ;; @footnotestyle separate
1468 ;; @footnotestyle end
1470 ;; The default is separate
1472 (defvar texinfo-footnote-style
"separate"
1473 "Footnote style, either separate or end.")
1475 (put 'footnotestyle
'texinfo-format
'texinfo-footnotestyle
)
1476 (defun texinfo-footnotestyle ()
1477 "Specify whether footnotes are at end of node or in separate nodes.
1478 Argument is either end or separate."
1479 (setq texinfo-footnote-style
(texinfo-parse-arg-discard)))
1481 (put 'footnote
'texinfo-format
'texinfo-format-footnote
)
1482 (defun texinfo-format-footnote ()
1483 "Format a footnote in either end of node or separate node style.
1484 The texinfo-footnote-style variable controls which style is used."
1485 (setq texinfo-footnote-number
(1+ texinfo-footnote-number
))
1486 (cond ((string= texinfo-footnote-style
"end")
1487 (texinfo-format-end-node))
1488 ((string= texinfo-footnote-style
"separate")
1489 (texinfo-format-separate-node))))
1491 (defun texinfo-format-separate-node ()
1492 "Format footnote in Separate node style, with notes in own node.
1493 The node is constructed automatically."
1495 (arg (texinfo-parse-line-arg))
1496 (node-name-beginning
1499 "^File: \\w+\\(\\w\\|\\s_\\|\\.\\|,\\)*[ \t]+Node:")
1503 (buffer-substring-no-properties
1504 (progn (goto-char node-name-beginning
) ; skip over node command
1505 (skip-chars-forward " \t") ; and over spaces
1507 (if (search-forward "," (line-end-position) t
) ; bound search
1509 (end-of-line) (point))))))
1510 (texinfo-discard-command) ; remove or insert whitespace, as needed
1511 (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
1513 (insert (format " (%d) (*Note %s-Footnotes::)"
1514 texinfo-footnote-number node-name
))
1515 (fill-paragraph nil
)
1517 (if (re-search-forward "^@node" nil
'move
)
1520 ;; two cases: for the first footnote, we must insert a node header;
1521 ;; for the second and subsequent footnotes, we need only insert
1522 ;; the text of the footnote.
1526 (concat node-name
"-Footnotes, Up: ")
1529 (progn ; already at least one footnote
1530 (setq start
(point))
1531 (insert (format "\n(%d) %s\n" texinfo-footnote-number arg
))
1532 (fill-region start
(point)))
1533 ;; else not yet a footnote
1534 (insert "\n\^_\nFile: " texinfo-format-filename
1535 " Node: " node-name
"-Footnotes, Up: " node-name
"\n")
1536 (setq start
(point))
1537 (insert (format "\n(%d) %s\n" texinfo-footnote-number arg
))
1538 (narrow-to-region (save-excursion (goto-char start
) (point)) (point))
1539 (fill-region (point-min) (point-max))
1542 (defun texinfo-format-end-node ()
1543 "Format footnote in the End of node style, with notes at end of node."
1545 (arg (texinfo-parse-line-arg)))
1546 (texinfo-discard-command) ; remove or insert whitespace, as needed
1547 (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
1549 (insert (format " (%d) " texinfo-footnote-number
))
1550 (fill-paragraph nil
)
1552 (if (search-forward "\n--------- Footnotes ---------\n" nil t
)
1553 (progn ; already have footnote, put new one before end of node
1554 (if (re-search-forward "^@node" nil
'move
)
1556 (setq start
(point))
1557 (insert (format "\n(%d) %s\n" texinfo-footnote-number arg
))
1558 (fill-region start
(point)))
1559 ;; else no prior footnote
1560 (if (re-search-forward "^@node" nil
'move
)
1562 (insert "\n--------- Footnotes ---------\n")
1563 (setq start
(point))
1564 (insert (format "\n(%d) %s\n" texinfo-footnote-number arg
))))))
1567 ;;; @itemize, @enumerate, and similar commands
1569 ;; @itemize pushes (itemize "COMMANDS" STARTPOS) on texinfo-stack.
1570 ;; @enumerate pushes (enumerate 0 STARTPOS).
1571 ;; @item dispatches to the texinfo-item prop of the first elt of the list.
1572 ;; For itemize, this puts in and rescans the COMMANDS.
1573 ;; For enumerate, this increments the number and puts it in.
1574 ;; In either case, it puts a Backspace at the front of the line
1575 ;; which marks it not to be indented later.
1576 ;; All other lines get indented by 5 when the @end is reached.
1578 (defvar texinfo-stack-depth
0
1579 "Count of number of unpopped texinfo-push-stack calls.
1580 Used by @refill indenting command to avoid indenting within lists, etc.")
1582 (defun texinfo-push-stack (check arg
)
1583 (setq texinfo-stack-depth
(1+ texinfo-stack-depth
))
1584 (push (list check arg texinfo-command-start
)
1587 (defun texinfo-pop-stack (check)
1588 (setq texinfo-stack-depth
(1- texinfo-stack-depth
))
1589 (if (null texinfo-stack
)
1590 (error "Unmatched @end %s" check
))
1591 (if (not (eq (car (car texinfo-stack
)) check
))
1592 (error "@end %s matches @%s"
1593 check
(car (car texinfo-stack
))))
1594 (prog1 (cdr (car texinfo-stack
))
1595 (setq texinfo-stack
(cdr texinfo-stack
))))
1597 (put 'itemize
'texinfo-format
'texinfo-itemize
)
1598 (defun texinfo-itemize ()
1601 (progn (skip-chars-forward " \t")
1604 (texinfo-parse-line-arg))))
1605 (texinfo-discard-line-with-args)
1606 (setq fill-column
(- fill-column
5)))
1608 (put 'itemize
'texinfo-end
'texinfo-end-itemize
)
1609 (defun texinfo-end-itemize ()
1610 (setq fill-column
(+ fill-column
5))
1611 (texinfo-discard-command)
1613 (texinfo-pop-stack 'itemize
)))
1614 (texinfo-do-itemize (nth 1 stacktop
))))
1616 (put 'enumerate
'texinfo-format
'texinfo-enumerate
)
1617 (defun texinfo-enumerate ()
1620 (progn (skip-chars-forward " \t")
1623 (read (current-buffer)))))
1624 (if (and (symbolp (car (cdr (car texinfo-stack
))))
1625 (> 1 (length (symbol-name (car (cdr (car texinfo-stack
)))))))
1627 "@enumerate: Use a number or letter, eg: 1, A, a, 3, B, or d." ))
1628 (texinfo-discard-line-with-args)
1629 (setq fill-column
(- fill-column
5)))
1631 (put 'enumerate
'texinfo-end
'texinfo-end-enumerate
)
1632 (defun texinfo-end-enumerate ()
1633 (setq fill-column
(+ fill-column
5))
1634 (texinfo-discard-command)
1636 (texinfo-pop-stack 'enumerate
)))
1637 (texinfo-do-itemize (nth 1 stacktop
))))
1639 ;; @alphaenumerate never became a standard part of Texinfo
1640 (put 'alphaenumerate
'texinfo-format
'texinfo-alphaenumerate
)
1641 (defun texinfo-alphaenumerate ()
1642 (texinfo-push-stack 'alphaenumerate
(1- ?a
))
1643 (setq fill-column
(- fill-column
5))
1644 (texinfo-discard-line))
1646 (put 'alphaenumerate
'texinfo-end
'texinfo-end-alphaenumerate
)
1647 (defun texinfo-end-alphaenumerate ()
1648 (setq fill-column
(+ fill-column
5))
1649 (texinfo-discard-command)
1651 (texinfo-pop-stack 'alphaenumerate
)))
1652 (texinfo-do-itemize (nth 1 stacktop
))))
1654 ;; @capsenumerate never became a standard part of Texinfo
1655 (put 'capsenumerate
'texinfo-format
'texinfo-capsenumerate
)
1656 (defun texinfo-capsenumerate ()
1657 (texinfo-push-stack 'capsenumerate
(1- ?A
))
1658 (setq fill-column
(- fill-column
5))
1659 (texinfo-discard-line))
1661 (put 'capsenumerate
'texinfo-end
'texinfo-end-capsenumerate
)
1662 (defun texinfo-end-capsenumerate ()
1663 (setq fill-column
(+ fill-column
5))
1664 (texinfo-discard-command)
1666 (texinfo-pop-stack 'capsenumerate
)))
1667 (texinfo-do-itemize (nth 1 stacktop
))))
1669 ;; At the @end, indent all the lines within the construct
1670 ;; except those marked with backspace. FROM says where
1671 ;; construct started.
1672 (defun texinfo-do-itemize (from)
1674 (while (progn (forward-line -
1)
1676 (if (= (following-char) ?
\b)
1681 (if (not (looking-at "[ \t]*$"))
1682 (save-excursion (insert " ")))))))
1684 (put 'item
'texinfo-format
'texinfo-item
)
1685 (put 'itemx
'texinfo-format
'texinfo-item
)
1686 (defun texinfo-item ()
1687 (funcall (get (car (car texinfo-stack
)) 'texinfo-item
)))
1689 (put 'itemize
'texinfo-item
'texinfo-itemize-item
)
1690 (defun texinfo-itemize-item ()
1691 ;; (texinfo-discard-line) ; Did not handle text on same line as @item.
1692 (delete-region (1+ (point)) (line-beginning-position))
1693 (if (looking-at "[ \t]*[^ \t\n]+")
1694 ;; Text on same line as @item command.
1695 (insert "\b " (nth 1 (car texinfo-stack
)) " \n")
1696 ;; Else text on next line.
1697 (insert "\b " (nth 1 (car texinfo-stack
)) " "))
1700 (put 'enumerate
'texinfo-item
'texinfo-enumerate-item
)
1701 (defun texinfo-enumerate-item ()
1702 (texinfo-discard-line)
1703 (let (enumerating-symbol)
1704 (cond ((integerp (car (cdr (car texinfo-stack
))))
1705 (setq enumerating-symbol
(car (cdr (car texinfo-stack
))))
1706 (insert ?
\b (format "%3d. " enumerating-symbol
) ?
\n)
1707 (setcar (cdr (car texinfo-stack
)) (1+ enumerating-symbol
)))
1708 ((symbolp (car (cdr (car texinfo-stack
))))
1709 (setq enumerating-symbol
1710 (symbol-name (car (cdr (car texinfo-stack
)))))
1711 (if (or (equal ?\
[ (string-to-char enumerating-symbol
))
1712 (equal ?\
{ (string-to-char enumerating-symbol
)))
1714 "Too many items in enumerated list; alphabet ends at Z."))
1715 (insert ?
\b (format "%3s. " enumerating-symbol
) ?
\n)
1716 (setcar (cdr (car texinfo-stack
))
1720 (string-to-char enumerating-symbol
))))))
1723 "@enumerate: Use a number or letter, eg: 1, A, a, 3, B or d." )))
1726 (put 'alphaenumerate
'texinfo-item
'texinfo-alphaenumerate-item
)
1727 (defun texinfo-alphaenumerate-item ()
1728 (texinfo-discard-line)
1729 (let ((next (1+ (car (cdr (car texinfo-stack
))))))
1731 (error "More than 26 items in @alphaenumerate; get a bigger alphabet"))
1732 (setcar (cdr (car texinfo-stack
)) next
)
1733 (insert "\b " next
". \n"))
1736 (put 'capsenumerate
'texinfo-item
'texinfo-capsenumerate-item
)
1737 (defun texinfo-capsenumerate-item ()
1738 (texinfo-discard-line)
1739 (let ((next (1+ (car (cdr (car texinfo-stack
))))))
1741 (error "More than 26 items in @capsenumerate; get a bigger alphabet"))
1742 (setcar (cdr (car texinfo-stack
)) next
)
1743 (insert "\b " next
". \n"))
1749 ;; The `@table' command produces two-column tables.
1751 (put 'table
'texinfo-format
'texinfo-table
)
1752 (defun texinfo-table ()
1755 (progn (skip-chars-forward " \t")
1758 (texinfo-parse-line-arg))))
1759 (texinfo-discard-line-with-args)
1760 (setq fill-column
(- fill-column
5)))
1762 (put 'table
'texinfo-item
'texinfo-table-item
)
1763 (defun texinfo-table-item ()
1764 (let ((arg (texinfo-parse-arg-discard))
1765 (itemfont (car (cdr (car texinfo-stack
)))))
1766 (insert ?
\b itemfont ?\
{ arg
"}\n \n"))
1769 (put 'table
'texinfo-end
'texinfo-end-table
)
1770 (defun texinfo-end-table ()
1771 (setq fill-column
(+ fill-column
5))
1772 (texinfo-discard-command)
1774 (texinfo-pop-stack 'table
)))
1775 (texinfo-do-itemize (nth 1 stacktop
))))
1777 ;; @description appears to be an undocumented variant on @table that
1778 ;; does not require an arg. It fails in texinfo.tex 2.58 and is not
1779 ;; part of makeinfo.c The command appears to be a relic of the past.
1780 (put 'description
'texinfo-end
'texinfo-end-table
)
1781 (put 'description
'texinfo-format
'texinfo-description
)
1782 (defun texinfo-description ()
1783 (texinfo-push-stack 'table
"@asis")
1784 (setq fill-column
(- fill-column
5))
1785 (texinfo-discard-line))
1788 ;;; @ftable, @vtable
1790 ;; The `@ftable' and `@vtable' commands are like the `@table' command
1791 ;; but they also insert each entry in the first column of the table
1792 ;; into the function or variable index.
1794 ;; Handle the @ftable and @vtable commands:
1796 (put 'ftable
'texinfo-format
'texinfo-ftable
)
1797 (put 'vtable
'texinfo-format
'texinfo-vtable
)
1799 (defun texinfo-ftable () (texinfo-indextable 'ftable
))
1800 (defun texinfo-vtable () (texinfo-indextable 'vtable
))
1802 (defun texinfo-indextable (table-type)
1803 (texinfo-push-stack table-type
(texinfo-parse-arg-discard))
1804 (setq fill-column
(- fill-column
5)))
1806 ;; Handle the @item commands within ftable and vtable:
1808 (put 'ftable
'texinfo-item
'texinfo-ftable-item
)
1809 (put 'vtable
'texinfo-item
'texinfo-vtable-item
)
1811 (defun texinfo-ftable-item () (texinfo-indextable-item 'texinfo-findex
))
1812 (defun texinfo-vtable-item () (texinfo-indextable-item 'texinfo-vindex
))
1814 (defun texinfo-indextable-item (index-type)
1815 (let ((item (texinfo-parse-arg-discard))
1816 (itemfont (car (cdr (car texinfo-stack
))))
1817 (indexvar index-type
))
1818 (insert ?
\b itemfont ?\
{ item
"}\n \n")
1821 (list item texinfo-last-node
)
1822 (symbol-value indexvar
)))
1825 ;; Handle @end ftable, @end vtable
1827 (put 'ftable
'texinfo-end
'texinfo-end-ftable
)
1828 (put 'vtable
'texinfo-end
'texinfo-end-vtable
)
1830 (defun texinfo-end-ftable () (texinfo-end-indextable 'ftable
))
1831 (defun texinfo-end-vtable () (texinfo-end-indextable 'vtable
))
1833 (defun texinfo-end-indextable (table-type)
1834 (setq fill-column
(+ fill-column
5))
1835 (texinfo-discard-command)
1837 (texinfo-pop-stack table-type
)))
1838 (texinfo-do-itemize (nth 1 stacktop
))))
1841 ;;; @multitable ... @end multitable
1843 ;; Produce a multi-column table, with as many columns as desired.
1845 ;; A multi-column table has this template:
1847 ;; @multitable {A1} {A2} {A3}
1848 ;; @item A1 @tab A2 @tab A3
1849 ;; @item B1 @tab B2 @tab B3
1850 ;; @item C1 @tab C2 @tab C3
1853 ;; where the width of the text in brackets specifies the width of the
1854 ;; respective column.
1858 ;; @multitable @columnfractions .25 .3 .45
1859 ;; @item A1 @tab A2 @tab A3
1860 ;; @item B1 @tab B2 @tab B3
1863 ;; where the fractions specify the width of each column as a percent
1864 ;; of the current width of the text (i.e., of the fill-column).
1866 ;; Long lines of text are filled within columns.
1868 ;; Using the Emacs Lisp formatter, texinfmt.el,
1869 ;; the whitespace between columns can be increased by setting
1870 ;; `texinfo-extra-inter-column-width' to a value greater than 0. By default,
1871 ;; there is at least one blank space between columns.
1873 ;; The Emacs Lisp formatter, texinfmt.el, ignores the following four
1874 ;; commands that are defined in texinfo.tex for printed output.
1876 ;; @multitableparskip,
1877 ;; @multitableparindent,
1878 ;; @multitablecolmargin,
1879 ;; @multitablelinespace.
1881 ;; How @multitable works.
1882 ;; =====================
1884 ;; `texinfo-multitable' reads the @multitable line and determines from it
1885 ;; how wide each column should be.
1887 ;; Also, it pushes this information, along with an identifying symbol,
1888 ;; onto the `texinfo-stack'. At the @end multitable command, the stack
1889 ;; is checked for its matching @multitable command, and then popped, or
1890 ;; else an error is signaled. Also, this command pushes the location of
1891 ;; the start of the table onto the stack.
1893 ;; `texinfo-end-multitable' checks the `texinfo-stack' that the @end
1894 ;; multitable truly is ending a corresponding beginning, and if it is,
1897 ;; `texinfo-multitable-widths' is called by `texinfo-multitable'.
1898 ;; The function returns a list of the widths of each column in a
1899 ;; multi-column table, based on the information supplied by the arguments
1900 ;; to the @multitable command (by arguments, I mean the text on the rest
1901 ;; of the @multitable line, not the remainder of the multi-column table
1904 ;; `texinfo-multitable-item' formats a row within a multicolumn table.
1905 ;; This command is executed when texinfmt sees @item inside @multitable.
1906 ;; Cells in row are separated by `@tab's. Widths of cells are specified
1907 ;; by the arguments in the @multitable line. Cells are filled. All cells
1908 ;; are made to be the same height by padding their bottoms, as needed,
1911 ;; `texinfo-multitable-extract-row' is called by `texinfo-multitable-item'.
1912 ;; This function returns the text in a multitable row, as a string.
1913 ;; The start of a row is marked by an @item and the end of row is the
1914 ;; beginning of next @item or beginning of the @end multitable line.
1915 ;; Cells within a row are separated by @tab.
1917 ;; Note that @tab, the cell separators, are not treated as independent
1918 ;; Texinfo commands.
1920 (defvar texinfo-extra-inter-column-width
0
1921 "Number of extra spaces between entries (columns) in @multitable.")
1923 (defvar texinfo-multitable-buffer-name
"*multitable-temporary-buffer*")
1924 (defvar texinfo-multitable-rectangle-name
"texinfo-multitable-temp-")
1926 ;; These commands are defined in texinfo.tex for printed output.
1927 (put 'multitableparskip
'texinfo-format
'texinfo-discard-line-with-args
)
1928 (put 'multitableparindent
'texinfo-format
'texinfo-discard-line-with-args
)
1929 (put 'multitablecolmargin
'texinfo-format
'texinfo-discard-line-with-args
)
1930 (put 'multitablelinespace
'texinfo-format
'texinfo-discard-line-with-args
)
1932 (put 'multitable
'texinfo-format
'texinfo-multitable
)
1934 (defun texinfo-multitable ()
1935 "Produce multi-column tables.
1937 A multi-column table has this template:
1939 @multitable {A1} {A2} {A3}
1940 @item A1 @tab A2 @tab A3
1941 @item B1 @tab B2 @tab B3
1942 @item C1 @tab C2 @tab C3
1945 where the width of the text in brackets specifies the width of the
1950 @multitable @columnfractions .25 .3 .45
1951 @item A1 @tab A2 @tab A3
1952 @item B1 @tab B2 @tab B3
1955 where the fractions specify the width of each column as a percent
1956 of the current width of the text (i.e., of the `fill-column').
1958 Long lines of text are filled within columns.
1960 Using the Emacs Lisp formatter, texinfmt.el,
1961 the whitespace between columns can be increased by setting
1962 `texinfo-extra-inter-column-width' to a value greater than 0. By default,
1963 there is at least one blank space between columns.
1965 The Emacs Lisp formatter, texinfmt.el, ignores the following four
1966 commands that are defined in texinfo.tex for printed output.
1969 @multitableparindent,
1970 @multitablecolmargin,
1971 @multitablelinespace."
1973 ;; This function pushes information onto the `texinfo-stack'.
1974 ;; A stack element consists of:
1975 ;; - type-of-command, i.e., multitable
1976 ;; - the information about column widths, and
1977 ;; - the position of texinfo-command-start.
1978 ;; e.g., ('multitable (1 2 3 4) 123)
1979 ;; The command line is then deleted.
1982 ;; push width information on stack
1983 (texinfo-multitable-widths))
1984 (texinfo-discard-line-with-args))
1986 (put 'multitable
'texinfo-end
'texinfo-end-multitable
)
1987 (defun texinfo-end-multitable ()
1988 "Discard the @end multitable line and pop the stack of multitable."
1989 (texinfo-discard-command)
1990 (texinfo-pop-stack 'multitable
))
1992 (defun texinfo-multitable-widths ()
1993 "Return list of widths of each column in a multi-column table."
1994 (let (texinfo-multitable-width-list)
1995 ;; Fractions format:
1996 ;; @multitable @columnfractions .25 .3 .45
1999 ;; @multitable {Column 1 template} {Column 2} {Column 3 example}
2000 ;; Place point before first argument
2001 (skip-chars-forward " \t")
2003 ;; Check for common misspelling
2004 ((looking-at "@columnfraction ")
2005 (error "In @multitable, @columnfractions misspelled"))
2006 ;; Case 1: @columnfractions .25 .3 .45
2007 ((looking-at "@columnfractions")
2012 (* fill-column
(read (get-buffer (current-buffer))))))
2013 texinfo-multitable-width-list
)))
2015 ;; Case 2: {Column 1 template} {Column 2} {Column 3 example}
2017 (let ((start-of-templates (point)))
2019 (skip-chars-forward " \t")
2020 (let* ((start-of-template (1+ (point)))
2022 ;; forward-sexp works with braces in Texinfo mode
2023 (progn (forward-sexp 1) (1- (point)))))
2024 (push (- end-of-template start-of-template
)
2025 texinfo-multitable-width-list
)
2026 ;; Remove carriage return from within a template, if any.
2027 ;; This helps those those who want to use more than
2028 ;; one line's worth of words in @multitable line.
2029 (narrow-to-region start-of-template end-of-template
)
2030 (goto-char (point-min))
2031 (while (search-forward "
2034 (goto-char (point-max))
2036 (forward-char 1)))))
2041 "You probably need to specify column widths for @multitable correctly.")))
2042 ;; Check whether columns fit on page.
2043 (let ((desired-columns
2045 ;; between column spaces
2046 (length texinfo-multitable-width-list
)
2047 ;; additional between column spaces, if any
2048 texinfo-extra-inter-column-width
2049 ;; sum of spaces for each entry
2050 (apply '+ texinfo-multitable-width-list
))))
2051 (if (> desired-columns fill-column
)
2053 "Multi-column table width, %d chars, is greater than page width, %d chars."
2054 desired-columns fill-column
)))
2055 texinfo-multitable-width-list
))
2057 ;; @item A1 @tab A2 @tab A3
2058 (defun texinfo-multitable-extract-row ()
2059 "Return multitable row, as a string.
2060 End of row is beginning of next @item or beginning of @end.
2061 Cells within rows are separated by @tab."
2062 (skip-chars-forward " \t")
2063 (let* ((start (point))
2065 (re-search-forward "@item\\|@end")
2066 (match-beginning 0)))
2067 (row (progn (goto-char end
)
2068 (skip-chars-backward " ")
2069 ;; remove whitespace at end of argument
2070 (delete-region (point) end
)
2071 (buffer-substring-no-properties start
(point)))))
2072 (delete-region texinfo-command-start end
)
2075 (put 'multitable
'texinfo-item
'texinfo-multitable-item
)
2076 (defun texinfo-multitable-item ()
2077 "Format a row within a multicolumn table.
2078 Cells in row are separated by @tab.
2079 Widths of cells are specified by the arguments in the @multitable line.
2080 All cells are made to be the same height.
2081 This command is executed when texinfmt sees @item inside @multitable."
2082 (let ((original-buffer (current-buffer))
2083 (table-widths (reverse (car (cdr (car texinfo-stack
)))))
2084 (existing-fill-column fill-column
)
2088 (table-entry-height 0)
2089 ;; unformatted row looks like: A1 @tab A2 @tab A3
2090 ;; extract-row command deletes the source line in the table.
2091 (unformatted-row (texinfo-multitable-extract-row)))
2092 ;; Use a temporary buffer
2093 (set-buffer (get-buffer-create texinfo-multitable-buffer-name
))
2094 (delete-region (point-min) (point-max))
2095 (insert unformatted-row
)
2096 (goto-char (point-min))
2097 ;; 1. Check for correct number of @tab in line.
2098 (let ((tab-number 1)) ; one @tab between two columns
2099 (while (search-forward "@tab" nil t
)
2100 (setq tab-number
(1+ tab-number
)))
2101 (let ((needed-tabs (- (length table-widths
) tab-number
)))
2102 (when (> needed-tabs
0)
2103 (goto-char (point-min))
2105 (while (> needed-tabs
0)
2106 (insert "@w{ }\n@tab")
2107 (setq needed-tabs
(1- needed-tabs
))
2109 "Added @tabs and empty spaces to a @multitable row")))))
2110 (goto-char (point-min))
2111 ;; 2. Format each cell, and copy to a rectangle
2112 ;; buffer looks like this: A1 @tab A2 @tab A3
2113 ;; Cell #1: format up to @tab
2114 ;; Cell #2: format up to @tab
2115 ;; Cell #3: format up to eob
2117 (setq start
(point))
2118 (setq end
(save-excursion
2119 (if (search-forward "@tab" nil
'move
)
2120 ;; Delete the @tab command, including the @-sign
2123 (progn (forward-word -
1) (1- (point)))))
2125 ;; Set fill-column *wider* than needed to produce inter-column space
2126 (setq fill-column
(+ 1
2127 texinfo-extra-inter-column-width
2128 (nth table-column table-widths
)))
2129 (narrow-to-region start end
)
2130 ;; Remove whitespace before and after entry.
2131 (skip-chars-forward " ")
2132 (delete-region (point) (line-beginning-position))
2133 (goto-char (point-max))
2134 (skip-chars-backward " ")
2135 (delete-region (point) (line-end-position))
2136 ;; Temporarily set texinfo-stack to nil so texinfo-format-scan
2137 ;; does not see an unterminated @multitable.
2138 (let (texinfo-stack) ; nil
2139 (texinfo-format-scan))
2140 (let (fill-prefix) ; no fill prefix
2141 (fill-region (point-min) (point-max)))
2142 (setq table-entry-height
2143 (max table-entry-height
(count-lines (point-min) (point-max))))
2144 ;; 3. Move point to end of bottom line, and pad that line to fill column.
2145 (goto-char (point-min))
2146 (forward-line (1- table-entry-height
))
2147 (let* ((beg (point)) ; beginning of line
2148 ;; add one more space for inter-column spacing
2153 (progn (end-of-line) (point)) ; end of existing line
2155 (insert (make-string
2156 (if (> needed-whitespace
0) needed-whitespace
1)
2158 ;; now, put formatted cell into a rectangle
2159 (set (intern (concat texinfo-multitable-rectangle-name
2160 (int-to-string table-column
)))
2161 (extract-rectangle (point-min) (point)))
2162 (delete-region (point-min) (point))
2163 (goto-char (point-max))
2164 (setq table-column
(1+ table-column
))
2166 ;; 4. Add extra lines to rectangles so all are of same height
2167 (let ((total-number-of-columns table-column
)
2170 (while (> table-column
0)
2171 (let ((this-rectangle (int-to-string table-column
)))
2172 (while (< (length this-rectangle
) table-entry-height
)
2173 (setq this-rectangle
(append this-rectangle
'("")))))
2174 (setq table-column
(1- table-column
)))
2175 ;; 5. Insert formatted rectangles in original buffer
2176 (switch-to-buffer original-buffer
)
2177 (open-line table-entry-height
)
2178 (while (< column-number total-number-of-columns
)
2182 (concat texinfo-multitable-rectangle-name
2183 (int-to-string column-number
)))))
2186 (setq column-number
(1+ column-number
))))
2187 (kill-buffer texinfo-multitable-buffer-name
)
2188 (setq fill-column existing-fill-column
)))
2192 ;; Use only the FILENAME argument to the command.
2193 ;; In Info, ignore the other arguments.
2195 (put 'image
'texinfo-format
'texinfo-format-image
)
2196 (defun texinfo-format-image ()
2197 "Insert an image from a file ending in .txt.
2198 Use only the FILENAME arg; for Info, ignore the other arguments to @image."
2199 (let ((args (texinfo-format-parse-args))
2201 (when (null (nth 0 args
))
2202 (error "Invalid image command"))
2203 (texinfo-discard-command)
2204 ;; makeinfo uses FILENAME.txt
2205 (setq filename
(format "%s.txt" (nth 0 args
)))
2206 (message "Reading included file: %s" filename
)
2207 ;; verbatim for Info output
2208 (goto-char (+ (point) (cadr (insert-file-contents filename
))))
2209 (message "Reading included file: %s...done" filename
)))
2212 ;;; @ifinfo, @iftex, @tex, @ifhtml, @html, @ifplaintext, @ifxml, @xml
2213 ;; @ifnottex, @ifnotinfo, @ifnothtml, @ifnotplaintext, @ifnotxml
2215 (put 'ifinfo
'texinfo-format
'texinfo-discard-line
)
2216 (put 'ifinfo
'texinfo-end
'texinfo-discard-command
)
2218 (put 'iftex
'texinfo-format
'texinfo-format-iftex
)
2219 (defun texinfo-format-iftex ()
2220 (delete-region texinfo-command-start
2221 (re-search-forward "@end iftex[ \t]*\n")))
2223 (put 'ifhtml
'texinfo-format
'texinfo-format-ifhtml
)
2224 (defun texinfo-format-ifhtml ()
2225 (delete-region texinfo-command-start
2226 (re-search-forward "@end ifhtml[ \t]*\n")))
2228 (put 'ifplaintext
'texinfo-format
'texinfo-format-ifplaintext
)
2229 (defun texinfo-format-ifplaintext ()
2230 (delete-region texinfo-command-start
2231 (re-search-forward "@end ifplaintext[ \t]*\n")))
2233 (put 'ifxml
'texinfo-format
'texinfo-format-ifxml
)
2234 (defun texinfo-format-ifxml ()
2235 (delete-region texinfo-command-start
2236 (progn (re-search-forward "^@end ifxml[ \t]*\n")
2239 (put 'tex
'texinfo-format
'texinfo-format-tex
)
2240 (defun texinfo-format-tex ()
2241 (delete-region texinfo-command-start
2242 (re-search-forward "@end tex[ \t]*\n")))
2244 (put 'html
'texinfo-format
'texinfo-format-html
)
2245 (defun texinfo-format-html ()
2246 (delete-region texinfo-command-start
2247 (re-search-forward "@end html[ \t]*\n")))
2249 (put 'xml
'texinfo-format
'texinfo-format-xml
)
2250 (defun texinfo-format-xml ()
2251 (delete-region texinfo-command-start
2252 (progn (re-search-forward "^@end xml[ \t]*\n")
2255 (put 'ifnotinfo
'texinfo-format
'texinfo-format-ifnotinfo
)
2256 (defun texinfo-format-ifnotinfo ()
2257 (delete-region texinfo-command-start
2258 (re-search-forward "@end ifnotinfo[ \t]*\n")))
2260 (put 'ifnotplaintext
'texinfo-format
'texinfo-discard-line
)
2261 (put 'ifnotplaintext
'texinfo-end
'texinfo-discard-command
)
2263 (put 'ifnottex
'texinfo-format
'texinfo-discard-line
)
2264 (put 'ifnottex
'texinfo-end
'texinfo-discard-command
)
2266 (put 'ifnothtml
'texinfo-format
'texinfo-discard-line
)
2267 (put 'ifnothtml
'texinfo-end
'texinfo-discard-command
)
2269 (put 'ifnotxml
'texinfo-format
'texinfo-discard-line
)
2270 (put 'ifnotxml
'texinfo-end
'texinfo-discard-command
)
2275 (put 'titlepage
'texinfo-format
'texinfo-format-titlepage
)
2276 (defun texinfo-format-titlepage ()
2277 (delete-region texinfo-command-start
2278 (re-search-forward "@end titlepage[ \t]*\n")))
2280 (put 'endtitlepage
'texinfo-format
'texinfo-discard-line
)
2282 ;; @titlespec an alternative titling command; ignored by Info
2284 (put 'titlespec
'texinfo-format
'texinfo-format-titlespec
)
2285 (defun texinfo-format-titlespec ()
2286 (delete-region texinfo-command-start
2287 (re-search-forward "@end titlespec[ \t]*\n")))
2289 (put 'endtitlespec
'texinfo-format
'texinfo-discard-line
)
2294 (put 'today
'texinfo-format
'texinfo-format-today
)
2296 ;; Produces Day Month Year style of output. eg `1 Jan 1900'
2297 ;; The `@today{}' command requires a pair of braces, like `@dots{}'.
2298 (defun texinfo-format-today ()
2299 (texinfo-parse-arg-discard)
2300 (insert (format-time-string "%e %b %Y")))
2304 ;; Produce `Day Month Year Hour:Min' style of output.
2305 ;; eg `1 Jan 1900 13:52'
2307 (put 'timestamp
'texinfo-format
'texinfo-format-timestamp
)
2309 ;; The `@timestamp{}' command requires a pair of braces, like `@dots{}'.
2310 (defun texinfo-format-timestamp ()
2311 "Insert the current local time and date."
2312 (texinfo-parse-arg-discard)
2313 ;; For seconds and time zone, replace format string with "%e %b %Y %T %Z"
2314 (insert (format-time-string "%e %b %Y %R")))
2319 (put 'ignore
'texinfo-format
'texinfo-format-ignore
)
2320 (defun texinfo-format-ignore ()
2321 (delete-region texinfo-command-start
2322 (re-search-forward "@end ignore[ \t]*\n")))
2324 (put 'endignore
'texinfo-format
'texinfo-discard-line
)
2327 ;;; Define the Info enclosure command: @definfoenclose
2329 ;; A `@definfoenclose' command may be used to define a highlighting
2330 ;; command for Info, but not for TeX. A command defined using
2331 ;; `@definfoenclose' marks text by enclosing it in strings that precede
2332 ;; and follow the text.
2334 ;; Presumably, if you define a command with `@definfoenclose` for Info,
2335 ;; you will also define the same command in the TeX definitions file,
2336 ;; `texinfo.tex' in a manner appropriate for typesetting.
2338 ;; Write a `@definfoenclose' command on a line and follow it with three
2339 ;; arguments separated by commas (commas are used as separators in an
2340 ;; `@node' line in the same way). The first argument to
2341 ;; `@definfoenclose' is the @-command name \(without the `@'\); the
2342 ;; second argument is the Info start delimiter string; and the third
2343 ;; argument is the Info end delimiter string. The latter two arguments
2344 ;; enclose the highlighted text in the Info file. A delimiter string
2345 ;; may contain spaces. Neither the start nor end delimiter is
2346 ;; required. However, if you do not provide a start delimiter, you
2347 ;; must follow the command name with two commas in a row; otherwise,
2348 ;; the Info formatting commands will misinterpret the end delimiter
2349 ;; string as a start delimiter string.
2351 ;; If you do a @definfoenclose{} on the name of a pre-defined macro (such
2352 ;; as @emph{}, @strong{}, @tt{}, or @i{}) the enclosure definition will
2353 ;; override the built-in definition.
2355 ;; An enclosure command defined this way takes one argument in braces.
2357 ;; For example, you can write:
2360 ;; @definfoenclose phoo, //, \\
2363 ;; near the beginning of a Texinfo file at the beginning of the lines
2364 ;; to define `@phoo' as an Info formatting command that inserts `//'
2365 ;; before and `\\' after the argument to `@phoo'. You can then write
2366 ;; `@phoo{bar}' wherever you want `//bar\\' highlighted in Info.
2368 ;; Also, for TeX formatting, you could write
2371 ;; @global@let@phoo=@i
2374 ;; to define `@phoo' as a command that causes TeX to typeset
2375 ;; the argument to `@phoo' in italics.
2377 ;; Note that each definition applies to its own formatter: one for TeX,
2378 ;; the other for texinfo-format-buffer or texinfo-format-region.
2380 ;; Here is another example: write
2382 ;; @definfoenclose headword, , :
2384 ;; near the beginning of the file, to define `@headword' as an Info
2385 ;; formatting command that inserts nothing before and a colon after the
2386 ;; argument to `@headword'.
2388 (put 'definfoenclose
'texinfo-format
'texinfo-define-info-enclosure
)
2389 (defun texinfo-define-info-enclosure ()
2390 (let* ((args (texinfo-format-parse-line-args))
2391 (command-name (nth 0 args
))
2392 (beginning-delimiter (or (nth 1 args
) ""))
2393 (end-delimiter (or (nth 2 args
) "")))
2394 (texinfo-discard-command)
2395 (push (list command-name
2399 texinfo-enclosure-list
)))
2404 (put 'alias
'texinfo-format
'texinfo-alias
)
2405 (defun texinfo-alias ()
2406 (let ((start (1- (point)))
2408 (skip-chars-forward " ")
2409 (setq texinfo-command-end
(line-end-position))
2410 (if (not (looking-at "\\([^=]+\\)=\\(.*\\)"))
2411 (error "Invalid alias command")
2413 (match-string-no-properties 1)
2414 (match-string-no-properties 2))
2416 (texinfo-discard-command))))
2419 ;;; @var, @code and the like
2421 (put 'var
'texinfo-format
'texinfo-format-var
)
2422 ;; @sc a small caps font for TeX; formatted as `var' in Info
2423 (put 'sc
'texinfo-format
'texinfo-format-var
)
2424 ;; @acronym for abbreviations in all caps, such as `NASA'.
2425 ;; Convert all letters to uppercase if they are not already.
2426 (put 'acronym
'texinfo-format
'texinfo-format-var
)
2427 (defun texinfo-format-var ()
2428 (let ((arg (texinfo-parse-expanded-arg)))
2429 (texinfo-discard-command)
2430 (insert (upcase arg
))))
2432 (put 'cite
'texinfo-format
'texinfo-format-code
)
2433 (put 'code
'texinfo-format
'texinfo-format-code
)
2434 ;; @command (for command names)
2435 (put 'command
'texinfo-format
'texinfo-format-code
)
2436 ;; @env (for environment variables)
2437 (put 'env
'texinfo-format
'texinfo-format-code
)
2438 (put 'file
'texinfo-format
'texinfo-format-code
)
2439 (put 'samp
'texinfo-format
'texinfo-format-code
)
2440 (put 'url
'texinfo-format
'texinfo-format-code
)
2441 (defun texinfo-format-code ()
2442 (insert "`" (texinfo-parse-arg-discard) "'")
2443 (goto-char texinfo-command-start
))
2445 ;; @option (for command-line options) must be different from @code
2446 ;; because of its special formatting in @table; namely that it does
2447 ;; not lead to inserted ` ... ' in a table, but does elsewhere.
2448 (put 'option
'texinfo-format
'texinfo-format-option
)
2449 (defun texinfo-format-option ()
2450 "Insert ` ... ' around arg unless inside a table; in that case, no quotes."
2451 ;; `looking-at-backward' not available in v. 18.57, 20.2
2452 (if (not (search-backward "\b" ; searched-for character is a control-H
2453 (line-beginning-position)
2455 (insert "`" (texinfo-parse-arg-discard) "'")
2456 (insert (texinfo-parse-arg-discard)))
2457 (goto-char texinfo-command-start
))
2459 (put 'emph
'texinfo-format
'texinfo-format-emph
)
2460 (put 'strong
'texinfo-format
'texinfo-format-emph
)
2461 (defun texinfo-format-emph ()
2462 (insert "*" (texinfo-parse-arg-discard) "*")
2463 (goto-char texinfo-command-start
))
2465 (put 'dfn
'texinfo-format
'texinfo-format-defn
)
2466 (put 'defn
'texinfo-format
'texinfo-format-defn
)
2467 (defun texinfo-format-defn ()
2468 (insert "\"" (texinfo-parse-arg-discard) "\"")
2469 (goto-char texinfo-command-start
))
2471 (put 'email
'texinfo-format
'texinfo-format-email
)
2472 (defun texinfo-format-email ()
2473 "Format email address and optional following full name.
2474 Insert full name, if present, followed by email address
2475 surrounded by in angle brackets."
2476 (let ((args (texinfo-format-parse-args)))
2477 (texinfo-discard-command)
2480 (insert (nth 1 args
) " "))
2481 (insert "<" (nth 0 args
) ">")))
2483 (put 'key
'texinfo-format
'texinfo-format-key
)
2484 ;; I've decided not want to have angle brackets around these -- rms.
2485 (defun texinfo-format-key ()
2486 (insert (texinfo-parse-arg-discard))
2487 (goto-char texinfo-command-start
))
2489 ;; @verb{<char>TEXT<char>} (in `makeinfo' 4.1 and later)
2490 (put 'verb
'texinfo-format
'texinfo-format-verb
)
2491 (defun texinfo-format-verb ()
2492 "Format text between non-quoted unique delimiter characters verbatim.
2493 Enclose the verbatim text, including the delimiters, in braces. Print
2494 text exactly as written (but not the delimiters) in a fixed-width.
2496 For example, @verb\{|@|\} results in @ and
2497 @verb\{+@'e?`!`+} results in @'e?`!`."
2499 (let ((delimiter (buffer-substring-no-properties
2500 (1+ texinfo-command-end
) (+ 2 texinfo-command-end
))))
2501 (unless (looking-at "{")
2502 (error "Not found: @verb start brace"))
2503 (delete-region texinfo-command-start
(+ 2 texinfo-command-end
))
2504 (search-forward delimiter
))
2506 (unless (looking-at "}")
2507 (error "Not found: @verb end brace"))
2510 ;; as of 2002 Dec 10
2511 ;; see (texinfo)Block Enclosing Commands
2514 ;; as of 2002 Dec 10
2515 ;; see (texinfo)verbatiminclude
2516 ;; need: @verbatiminclude FILENAME
2518 (put 'bullet
'texinfo-format
'texinfo-format-bullet
)
2519 (defun texinfo-format-bullet ()
2520 "Insert an asterisk.
2521 If used within a line, follow `@bullet' with braces."
2522 (texinfo-optional-braces-discard)
2528 ;; Inside of @example ... @end example and similar environments,
2529 ;; @kbd does nothing; but outside of such environments, it places
2530 ;; single quotation marks around its argument.
2532 (defvar texinfo-format-kbd-regexp
2542 "Regexp matching environments in which @kbd does not put `...' around arg.")
2544 (defvar texinfo-format-kbd-end-regexp
2554 "Regexp specifying end of environments in which @kbd does not put `...'
2555 around argument. (See `texinfo-format-kbd-regexp')")
2557 (put 'kbd
'texinfo-format
'texinfo-format-kbd
)
2558 (defun texinfo-format-kbd ()
2559 "Place single quote marks around arg, except in @example and similar."
2560 ;; Search forward for @end example closer than an @example.
2561 ;; Can stop search at nearest @node or texinfo-section-types-regexp
2565 (concat "^@node\\|\\(" texinfo-section-types-regexp
"\\)")
2567 'move-to-end
) ; if necessary, return point at end of buffer
2571 (re-search-forward texinfo-format-kbd-regexp stop
'move-to-end
)
2573 (end-example-location
2575 (re-search-forward texinfo-format-kbd-end-regexp stop
'move-to-end
)
2577 ;; If inside @example, @end example will be closer than @example
2578 ;; or end of search i.e., end-example-location less than example-location
2579 (if (>= end-example-location example-location
)
2580 ;; outside an @example or equivalent
2581 (insert "`" (texinfo-parse-arg-discard) "'")
2582 ;; else, in @example; do not surround with `...'
2583 (insert (texinfo-parse-arg-discard)))
2584 (goto-char texinfo-command-start
)))
2587 ;;; @example, @lisp, @quotation, @display, @smalllisp, @smallexample,
2590 (put 'display
'texinfo-format
'texinfo-format-example
)
2591 (put 'smalldisplay
'texinfo-format
'texinfo-format-example
)
2592 (put 'example
'texinfo-format
'texinfo-format-example
)
2593 (put 'lisp
'texinfo-format
'texinfo-format-example
)
2594 (put 'quotation
'texinfo-format
'texinfo-format-example
)
2595 (put 'smallexample
'texinfo-format
'texinfo-format-example
)
2596 (put 'smalllisp
'texinfo-format
'texinfo-format-example
)
2597 (defun texinfo-format-example ()
2598 (texinfo-push-stack 'example nil
)
2599 (setq fill-column
(- fill-column
5))
2600 (texinfo-discard-line))
2602 (put 'example
'texinfo-end
'texinfo-end-example
)
2603 (put 'display
'texinfo-end
'texinfo-end-example
)
2604 (put 'smalldisplay
'texinfo-end
'texinfo-end-example
)
2605 (put 'lisp
'texinfo-end
'texinfo-end-example
)
2606 (put 'quotation
'texinfo-end
'texinfo-end-example
)
2607 (put 'smallexample
'texinfo-end
'texinfo-end-example
)
2608 (put 'smalllisp
'texinfo-end
'texinfo-end-example
)
2609 (defun texinfo-end-example ()
2610 (setq fill-column
(+ fill-column
5))
2611 (texinfo-discard-command)
2613 (texinfo-pop-stack 'example
)))
2614 (texinfo-do-itemize (nth 1 stacktop
))))
2616 (put 'exdent
'texinfo-format
'texinfo-format-exdent
)
2617 (defun texinfo-format-exdent ()
2618 (texinfo-discard-command)
2619 (delete-region (point)
2621 (skip-chars-forward " ")
2624 ;; Cancel out the deletion that texinfo-do-itemize
2625 ;; is going to do at the end of this line.
2631 ;; @direntry and @dircategory
2633 (put 'direntry
'texinfo-format
'texinfo-format-direntry
)
2634 (defun texinfo-format-direntry ()
2635 (texinfo-push-stack 'direntry nil
)
2636 (texinfo-discard-line)
2637 (insert "START-INFO-DIR-ENTRY\n"))
2639 (put 'direntry
'texinfo-end
'texinfo-end-direntry
)
2640 (defun texinfo-end-direntry ()
2641 (texinfo-discard-command)
2642 (insert "END-INFO-DIR-ENTRY\n\n")
2643 (texinfo-pop-stack 'direntry
))
2645 (put 'dircategory
'texinfo-format
'texinfo-format-dircategory
)
2646 (defun texinfo-format-dircategory ()
2647 (let ((str (texinfo-parse-arg-discard)))
2648 (delete-region (point)
2650 (skip-chars-forward " ")
2652 (insert "INFO-DIR-SECTION " str
"\n")))
2656 ;; The @cartouche command is a noop in Info; in a printed manual,
2657 ;; it makes a box with rounded corners.
2659 (put 'cartouche
'texinfo-format
'texinfo-discard-line
)
2660 (put 'cartouche
'texinfo-end
'texinfo-discard-command
)
2663 ;;; @flushleft and @format
2665 ;; The @flushleft command left justifies every line but leaves the
2666 ;; right end ragged. As far as Info is concerned, @flushleft is a
2667 ;; `do-nothing' command
2669 ;; The @format command is similar to @example except that it does not
2670 ;; indent; this means that in Info, @format is similar to @flushleft.
2672 (put 'format
'texinfo-format
'texinfo-format-flushleft
)
2673 (put 'smallformat
'texinfo-format
'texinfo-format-flushleft
)
2674 (put 'flushleft
'texinfo-format
'texinfo-format-flushleft
)
2675 (defun texinfo-format-flushleft ()
2676 (texinfo-discard-line))
2678 (put 'format
'texinfo-end
'texinfo-end-flushleft
)
2679 (put 'smallformat
'texinfo-end
'texinfo-end-flushleft
)
2680 (put 'flushleft
'texinfo-end
'texinfo-end-flushleft
)
2681 (defun texinfo-end-flushleft ()
2682 (texinfo-discard-command))
2687 ;; The @flushright command right justifies every line but leaves the
2688 ;; left end ragged. Spaces and tabs at the right ends of lines are
2689 ;; removed so that visible text lines up on the right side.
2691 (put 'flushright
'texinfo-format
'texinfo-format-flushright
)
2692 (defun texinfo-format-flushright ()
2693 (texinfo-push-stack 'flushright nil
)
2694 (texinfo-discard-line))
2696 (put 'flushright
'texinfo-end
'texinfo-end-flushright
)
2697 (defun texinfo-end-flushright ()
2698 (texinfo-discard-command)
2701 (texinfo-pop-stack 'flushright
)))
2703 (texinfo-do-flushright (nth 1 stacktop
))))
2705 (defun texinfo-do-flushright (from)
2707 (while (progn (forward-line -
1)
2716 (skip-chars-backward " \t")
2717 (delete-region (point) (progn (end-of-line) (point)))
2722 ;;; @ctrl, @TeX, @copyright, @minus, @dots, @enddots, @pounds
2724 (put 'ctrl
'texinfo-format
'texinfo-format-ctrl
)
2725 (defun texinfo-format-ctrl ()
2726 (let ((str (texinfo-parse-arg-discard)))
2727 (insert (logand 31 (aref str
0)))))
2729 (put 'TeX
'texinfo-format
'texinfo-format-TeX
)
2730 (defun texinfo-format-TeX ()
2731 (texinfo-parse-arg-discard)
2734 (put 'copyright
'texinfo-format
'texinfo-format-copyright
)
2735 (defun texinfo-format-copyright ()
2736 (texinfo-parse-arg-discard)
2739 (put 'minus
'texinfo-format
'texinfo-format-minus
)
2740 (defun texinfo-format-minus ()
2741 "Insert a minus sign.
2742 If used within a line, follow `@minus' with braces."
2743 (texinfo-optional-braces-discard)
2746 (put 'dots
'texinfo-format
'texinfo-format-dots
)
2747 (defun texinfo-format-dots ()
2748 (texinfo-parse-arg-discard)
2751 (put 'enddots
'texinfo-format
'texinfo-format-enddots
)
2752 (defun texinfo-format-enddots ()
2753 (texinfo-parse-arg-discard)
2756 (put 'pounds
'texinfo-format
'texinfo-format-pounds
)
2757 (defun texinfo-format-pounds ()
2758 (texinfo-parse-arg-discard)
2762 ;;; Refilling and indenting: @refill, @paragraphindent, @noindent
2764 ;; Indent only those paragraphs that are refilled as a result of an
2767 ;; * If the value is `asis', do not change the existing indentation at
2768 ;; the starts of paragraphs.
2770 ;; * If the value zero, delete any existing indentation.
2772 ;; * If the value is greater than zero, indent each paragraph by that
2773 ;; number of spaces.
2775 ;; But do not refill paragraphs with an @refill command that are
2776 ;; preceded by @noindent or are part of a table, list, or deffn.
2778 (defvar texinfo-paragraph-indent
"asis"
2779 "Number of spaces for @refill to indent a paragraph; else to leave as is.")
2781 (put 'paragraphindent
'texinfo-format
'texinfo-paragraphindent
)
2783 (defun texinfo-paragraphindent ()
2784 "Specify the number of spaces for @refill to indent a paragraph.
2785 Default is to leave the number of spaces as is."
2786 (let ((arg (texinfo-parse-arg-discard)))
2787 (if (string= "asis" arg
)
2788 (setq texinfo-paragraph-indent
"asis")
2789 (setq texinfo-paragraph-indent
(string-to-number arg
)))))
2791 (put 'refill
'texinfo-format
'texinfo-format-refill
)
2792 (defun texinfo-format-refill ()
2793 "Refill paragraph. Also, indent first line as set by @paragraphindent.
2794 Default is to leave paragraph indentation as is."
2795 (texinfo-discard-command)
2796 (let ((position (point-marker)))
2797 (forward-paragraph -
1)
2798 (if (looking-at "[ \t\n]*$") (forward-line 1))
2799 ;; Do not indent if an entry in a list, table, or deffn,
2800 ;; or if paragraph is preceded by @noindent.
2801 ;; Otherwise, indent
2803 ;; delete a @noindent line and do not indent paragraph
2804 ((save-excursion (forward-line -
1)
2805 (looking-at "^@noindent"))
2807 (delete-region (point) (progn (forward-line 1) (point))))
2808 ;; do nothing if "asis"
2809 ((equal texinfo-paragraph-indent
"asis"))
2810 ;; do no indenting in list, etc.
2811 ((> texinfo-stack-depth
0))
2812 ;; otherwise delete existing whitespace and indent
2814 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
2815 (insert (make-string texinfo-paragraph-indent ?
))))
2816 (forward-paragraph 1)
2819 ;; Do not fill a section title line with asterisks, hyphens, etc. that
2820 ;; are used to underline it. This could occur if the line following
2821 ;; the underlining is not an index entry and has text within it.
2822 (let* ((previous-paragraph-separate paragraph-separate
)
2824 (concat paragraph-separate
"\\|[-=.]+\\|\\*\\*+"))
2825 (previous-paragraph-start paragraph-start
)
2827 (concat paragraph-start
"\\|[-=.]+\\|\\*\\*+")))
2829 (fill-paragraph nil
)
2830 (setq paragraph-separate previous-paragraph-separate
)
2831 (setq paragraph-start previous-paragraph-start
)))
2832 (goto-char position
)))
2834 (put 'noindent
'texinfo-format
'texinfo-noindent
)
2835 (defun texinfo-noindent ()
2837 (forward-paragraph 1)
2838 (if (search-backward "@refill" (line-beginning-position 0) t
)
2839 () ; leave @noindent command so @refill command knows not to indent
2841 (texinfo-discard-line))))
2844 ;;; Index generation
2846 (put 'vindex
'texinfo-format
'texinfo-format-vindex
)
2847 (defun texinfo-format-vindex ()
2848 (texinfo-index 'texinfo-vindex
))
2850 (put 'cindex
'texinfo-format
'texinfo-format-cindex
)
2851 (defun texinfo-format-cindex ()
2852 (texinfo-index 'texinfo-cindex
))
2854 (put 'findex
'texinfo-format
'texinfo-format-findex
)
2855 (defun texinfo-format-findex ()
2856 (texinfo-index 'texinfo-findex
))
2858 (put 'pindex
'texinfo-format
'texinfo-format-pindex
)
2859 (defun texinfo-format-pindex ()
2860 (texinfo-index 'texinfo-pindex
))
2862 (put 'tindex
'texinfo-format
'texinfo-format-tindex
)
2863 (defun texinfo-format-tindex ()
2864 (texinfo-index 'texinfo-tindex
))
2866 (put 'kindex
'texinfo-format
'texinfo-format-kindex
)
2867 (defun texinfo-format-kindex ()
2868 (texinfo-index 'texinfo-kindex
))
2870 (defun texinfo-index (indexvar)
2871 (let ((arg (texinfo-parse-expanded-arg)))
2872 (texinfo-discard-command)
2876 ;; Region formatting may not provide last node position.
2877 (if texinfo-last-node-pos
2878 (1+ (count-lines texinfo-last-node-pos
(point)))
2880 (symbol-value indexvar
)))))
2882 (defvar texinfo-indexvar-alist
2883 '(("cp" . texinfo-cindex
)
2884 ("fn" . texinfo-findex
)
2885 ("vr" . texinfo-vindex
)
2886 ("tp" . texinfo-tindex
)
2887 ("pg" . texinfo-pindex
)
2888 ("ky" . texinfo-kindex
)))
2891 ;;; @defindex @defcodeindex
2892 (put 'defindex
'texinfo-format
'texinfo-format-defindex
)
2893 (put 'defcodeindex
'texinfo-format
'texinfo-format-defindex
)
2895 (defun texinfo-format-defindex ()
2896 (let* ((index-name (texinfo-parse-arg-discard)) ; eg: `aa'
2897 (indexing-command (intern (concat index-name
"index")))
2898 (index-formatting-command ; eg: `texinfo-format-aaindex'
2899 (intern (concat "texinfo-format-" index-name
"index")))
2900 (index-alist-name ; eg: `texinfo-aaindex'
2901 (intern (concat "texinfo-" index-name
"index"))))
2903 (set index-alist-name nil
)
2905 (put indexing-command
; eg, aaindex
2907 index-formatting-command
) ; eg, texinfo-format-aaindex
2909 ;; eg: "aa" . texinfo-aaindex
2910 (or (assoc index-name texinfo-indexvar-alist
)
2911 (push (cons index-name
2913 texinfo-indexvar-alist
))
2915 (fset index-formatting-command
2917 (list 'texinfo-index
2918 (list 'quote index-alist-name
))))))
2921 ;;; @synindex @syncodeindex
2923 (put 'synindex
'texinfo-format
'texinfo-format-synindex
)
2924 (put 'syncodeindex
'texinfo-format
'texinfo-format-synindex
)
2926 (defun texinfo-format-synindex ()
2927 (let* ((args (texinfo-parse-arg-discard))
2928 (second (cdr (read-from-string args
)))
2929 (joiner (symbol-name (car (read-from-string args
))))
2930 (joined (symbol-name (car (read-from-string args second
)))))
2932 (if (assoc joiner texinfo-short-index-cmds-alist
)
2934 (cdr (assoc joiner texinfo-short-index-cmds-alist
))
2936 (or (cdr (assoc joined texinfo-short-index-format-cmds-alist
))
2937 (intern (concat "texinfo-format-" joined
"index"))))
2939 (intern (concat joiner
"index"))
2941 (or (cdr(assoc joined texinfo-short-index-format-cmds-alist
))
2942 (intern (concat "texinfo-format-" joined
"index")))))))
2944 (defconst texinfo-short-index-cmds-alist
2952 (defconst texinfo-short-index-format-cmds-alist
2953 '(("cp" . texinfo-format-cindex
)
2954 ("fn" . texinfo-format-findex
)
2955 ("vr" . texinfo-format-vindex
)
2956 ("tp" . texinfo-format-tindex
)
2957 ("pg" . texinfo-format-pindex
)
2958 ("ky" . texinfo-format-kindex
)))
2963 ;; Sort an index which is in the current buffer between START and END.
2964 (defun texinfo-sort-region (start end
)
2967 (narrow-to-region start end
)
2968 (goto-char (point-min))
2969 (sort-subr nil
'forward-line
'end-of-line
'texinfo-sort-startkeyfun
)))
2971 ;; Subroutine for sorting an index.
2972 ;; At start of a line, return a string to sort the line under.
2973 (defun texinfo-sort-startkeyfun ()
2974 (let ((line (buffer-substring-no-properties (point) (line-end-position))))
2975 ;; Canonicalize whitespace and eliminate funny chars.
2976 (while (string-match "[ \t][ \t]+\\|[^a-z0-9 ]+" line
)
2977 (setq line
(concat (substring line
0 (match-beginning 0))
2979 (substring line
(match-end 0)))))
2985 (put 'printindex
'texinfo-format
'texinfo-format-printindex
)
2987 (defun texinfo-format-printindex ()
2988 (let* ((arg (texinfo-parse-arg-discard))
2989 (fmt (cdr (assoc arg texinfo-short-index-format-cmds-alist
)))
2990 (index-list (delq nil
(mapcar (lambda (e)
2991 (and (eq fmt
(get (cdr e
) 'texinfo-format
))
2992 (cdr (assoc (car e
) texinfo-indexvar-alist
))))
2993 texinfo-short-index-cmds-alist
)))
2994 (indexelts (apply #'append nil
(mapcar #'symbol-value index-list
)))
2996 (insert "\n* Menu:\n\n")
2997 (setq opoint
(point))
2998 (texinfo-print-index nil indexelts
)
2999 (texinfo-sort-region opoint
(point))))
3001 (defun texinfo-print-index (file indexelts
)
3003 (if (stringp (car (car indexelts
)))
3005 (insert "* " (car (car indexelts
)) ": " )
3008 (if file
(concat "(" file
")") "")
3009 (nth 1 (car indexelts
)) ".")
3012 (if (nth 2 (car indexelts
))
3013 (format " (line %3d)" (1+ (nth 2 (car indexelts
))))
3016 ;; index entries from @include'd file
3017 (texinfo-print-index (nth 1 (car indexelts
))
3018 (nth 2 (car indexelts
))))
3019 (setq indexelts
(cdr indexelts
))))
3022 ;;; Glyphs: @equiv, @error, etc
3024 ;; @equiv to show that two expressions are equivalent
3025 ;; @error to show an error message
3026 ;; @expansion to show what a macro expands to
3027 ;; @point to show the location of point in an example
3028 ;; @print to show what an evaluated expression prints
3029 ;; @result to indicate the value returned by an expression
3031 (put 'equiv
'texinfo-format
'texinfo-format-equiv
)
3032 (defun texinfo-format-equiv ()
3033 (texinfo-parse-arg-discard)
3036 (put 'error
'texinfo-format
'texinfo-format-error
)
3037 (defun texinfo-format-error ()
3038 (texinfo-parse-arg-discard)
3039 (insert "error-->"))
3041 (put 'expansion
'texinfo-format
'texinfo-format-expansion
)
3042 (defun texinfo-format-expansion ()
3043 (texinfo-parse-arg-discard)
3046 (put 'point
'texinfo-format
'texinfo-format-point
)
3047 (defun texinfo-format-point ()
3048 (texinfo-parse-arg-discard)
3051 (put 'print
'texinfo-format
'texinfo-format-print
)
3052 (defun texinfo-format-print ()
3053 (texinfo-parse-arg-discard)
3056 (put 'result
'texinfo-format
'texinfo-format-result
)
3057 (defun texinfo-format-result ()
3058 (texinfo-parse-arg-discard)
3064 ;; Info presumes a plain ASCII output, so the accented characters do
3065 ;; not look as they would if typeset, or output with a different
3068 ;; See the `texinfo-accent-commands' variable
3069 ;; in the section for `texinfo-append-refill'.
3070 ;; Also, see the defun for `texinfo-format-scan'
3071 ;; for single-character accent commands.
3073 ;; Command Info output Name
3075 ;; These do not have braces:
3076 ;; @^ ==> ^ circumflex accent
3077 ;; @` ==> ` grave accent
3078 ;; @' ==> ' acute accent
3079 ;; @" ==> " umlaut accent
3080 ;; @= ==> = overbar accent
3081 ;; @~ ==> ~ tilde accent
3083 ;; These have braces, but take no argument:
3084 ;; @OE{} ==> OE French-OE-ligature
3086 ;; @AA{} ==> AA Scandinavian-A-with-circle
3088 ;; @AE{} ==> AE Latin-Scandinavian-AE
3090 ;; @ss{} ==> ss German-sharp-S
3092 ;; @questiondown{} ==> ? upside-down-question-mark
3093 ;; @exclamdown{} ==> ! upside-down-exclamation-mark
3094 ;; @L{} ==> L/ Polish suppressed-L (Lslash)
3095 ;; @l{} ==> l/ Polish suppressed-L (Lslash) (lower case)
3096 ;; @O{} ==> O/ Scandinavian O-with-slash
3097 ;; @o{} ==> o/ Scandinavian O-with-slash (lower case)
3099 ;; These have braces, and take an argument:
3100 ;; @,{c} ==> c, cedilla accent
3101 ;; @dotaccent{o} ==> .o overdot-accent
3102 ;; @ubaraccent{o} ==> _o underbar-accent
3103 ;; @udotaccent{o} ==> o-. underdot-accent
3104 ;; @H{o} ==> ""o long Hungarian umlaut
3105 ;; @ringaccent{o} ==> *o ring accent
3106 ;; @tieaccent{oo} ==> [oo tie after accent
3107 ;; @u{o} ==> (o breve accent
3108 ;; @v{o} ==> <o hacek accent
3109 ;; @dotless{i} ==> i dotless i and dotless j
3113 ;; Note: The defun texinfo-format-scan
3114 ;; looks at "[@{}^'`\",=~ *?!-]"
3115 ;; In the case of @*, a line break is inserted;
3116 ;; in the other cases, the characters are simply quoted and the @ is deleted.
3117 ;; Thus, `texinfo-format-scan' handles the following
3118 ;; single-character accent commands: @^ @` @' @" @, @- @= @~
3120 ;; @^ ==> ^ circumflex accent
3121 ;; (put '^ 'texinfo-format 'texinfo-format-circumflex-accent)
3122 ;; (defun texinfo-format-circumflex-accent ()
3123 ;; (texinfo-discard-command)
3126 ;; @` ==> ` grave accent
3127 ;; (put '\` 'texinfo-format 'texinfo-format-grave-accent)
3128 ;; (defun texinfo-format-grave-accent ()
3129 ;; (texinfo-discard-command)
3132 ;; @' ==> ' acute accent
3133 ;; (put '\' 'texinfo-format 'texinfo-format-acute-accent)
3134 ;; (defun texinfo-format-acute-accent ()
3135 ;; (texinfo-discard-command)
3138 ;; @" ==> " umlaut accent
3139 ;; (put '\" 'texinfo-format 'texinfo-format-umlaut-accent)
3140 ;; (defun texinfo-format-umlaut-accent ()
3141 ;; (texinfo-discard-command)
3144 ;; @= ==> = overbar accent
3145 ;; (put '= 'texinfo-format 'texinfo-format-overbar-accent)
3146 ;; (defun texinfo-format-overbar-accent ()
3147 ;; (texinfo-discard-command)
3150 ;; @~ ==> ~ tilde accent
3151 ;; (put '~ 'texinfo-format 'texinfo-format-tilde-accent)
3152 ;; (defun texinfo-format-tilde-accent ()
3153 ;; (texinfo-discard-command)
3156 ;; @OE{} ==> OE French-OE-ligature
3157 (put 'OE
'texinfo-format
'texinfo-format-French-OE-ligature
)
3158 (defun texinfo-format-French-OE-ligature ()
3159 (insert "OE" (texinfo-parse-arg-discard))
3160 (goto-char texinfo-command-start
))
3163 (put 'oe
'texinfo-format
'texinfo-format-French-oe-ligature
)
3164 (defun texinfo-format-French-oe-ligature () ; lower case
3165 (insert "oe" (texinfo-parse-arg-discard))
3166 (goto-char texinfo-command-start
))
3168 ;; @AA{} ==> AA Scandinavian-A-with-circle
3169 (put 'AA
'texinfo-format
'texinfo-format-Scandinavian-A-with-circle
)
3170 (defun texinfo-format-Scandinavian-A-with-circle ()
3171 (insert "AA" (texinfo-parse-arg-discard))
3172 (goto-char texinfo-command-start
))
3175 (put 'aa
'texinfo-format
'texinfo-format-Scandinavian-a-with-circle
)
3176 (defun texinfo-format-Scandinavian-a-with-circle () ; lower case
3177 (insert "aa" (texinfo-parse-arg-discard))
3178 (goto-char texinfo-command-start
))
3180 ;; @AE{} ==> AE Latin-Scandinavian-AE
3181 (put 'AE
'texinfo-format
'texinfo-format-Latin-Scandinavian-AE
)
3182 (defun texinfo-format-Latin-Scandinavian-AE ()
3183 (insert "AE" (texinfo-parse-arg-discard))
3184 (goto-char texinfo-command-start
))
3187 (put 'ae
'texinfo-format
'texinfo-format-Latin-Scandinavian-ae
)
3188 (defun texinfo-format-Latin-Scandinavian-ae () ; lower case
3189 (insert "ae" (texinfo-parse-arg-discard))
3190 (goto-char texinfo-command-start
))
3192 ;; @ss{} ==> ss German-sharp-S
3193 (put 'ss
'texinfo-format
'texinfo-format-German-sharp-S
)
3194 (defun texinfo-format-German-sharp-S ()
3195 (insert "ss" (texinfo-parse-arg-discard))
3196 (goto-char texinfo-command-start
))
3198 ;; @questiondown{} ==> ? upside-down-question-mark
3199 (put 'questiondown
'texinfo-format
'texinfo-format-upside-down-question-mark
)
3200 (defun texinfo-format-upside-down-question-mark ()
3201 (insert "?" (texinfo-parse-arg-discard))
3202 (goto-char texinfo-command-start
))
3204 ;; @exclamdown{} ==> ! upside-down-exclamation-mark
3205 (put 'exclamdown
'texinfo-format
'texinfo-format-upside-down-exclamation-mark
)
3206 (defun texinfo-format-upside-down-exclamation-mark ()
3207 (insert "!" (texinfo-parse-arg-discard))
3208 (goto-char texinfo-command-start
))
3210 ;; @L{} ==> L/ Polish suppressed-L (Lslash)
3211 (put 'L
'texinfo-format
'texinfo-format-Polish-suppressed-L
)
3212 (defun texinfo-format-Polish-suppressed-L ()
3213 (insert (texinfo-parse-arg-discard) "/L")
3214 (goto-char texinfo-command-start
))
3216 ;; @l{} ==> l/ Polish suppressed-L (Lslash) (lower case)
3217 (put 'l
'texinfo-format
'texinfo-format-Polish-suppressed-l-lower-case
)
3218 (defun texinfo-format-Polish-suppressed-l-lower-case ()
3219 (insert (texinfo-parse-arg-discard) "/l")
3220 (goto-char texinfo-command-start
))
3223 ;; @O{} ==> O/ Scandinavian O-with-slash
3224 (put 'O
'texinfo-format
'texinfo-format-Scandinavian-O-with-slash
)
3225 (defun texinfo-format-Scandinavian-O-with-slash ()
3226 (insert (texinfo-parse-arg-discard) "O/")
3227 (goto-char texinfo-command-start
))
3229 ;; @o{} ==> o/ Scandinavian O-with-slash (lower case)
3230 (put 'o
'texinfo-format
'texinfo-format-Scandinavian-o-with-slash-lower-case
)
3231 (defun texinfo-format-Scandinavian-o-with-slash-lower-case ()
3232 (insert (texinfo-parse-arg-discard) "o/")
3233 (goto-char texinfo-command-start
))
3237 ;; @,{c} ==> c, cedilla accent
3238 (put '\
, 'texinfo-format
'texinfo-format-cedilla-accent
)
3239 (defun texinfo-format-cedilla-accent ()
3240 (insert (texinfo-parse-arg-discard) ",")
3241 (goto-char texinfo-command-start
))
3244 ;; @dotaccent{o} ==> .o overdot-accent
3245 (put 'dotaccent
'texinfo-format
'texinfo-format-overdot-accent
)
3246 (defun texinfo-format-overdot-accent ()
3247 (insert "." (texinfo-parse-arg-discard))
3248 (goto-char texinfo-command-start
))
3250 ;; @ubaraccent{o} ==> _o underbar-accent
3251 (put 'ubaraccent
'texinfo-format
'texinfo-format-underbar-accent
)
3252 (defun texinfo-format-underbar-accent ()
3253 (insert "_" (texinfo-parse-arg-discard))
3254 (goto-char texinfo-command-start
))
3256 ;; @udotaccent{o} ==> o-. underdot-accent
3257 (put 'udotaccent
'texinfo-format
'texinfo-format-underdot-accent
)
3258 (defun texinfo-format-underdot-accent ()
3259 (insert (texinfo-parse-arg-discard) "-.")
3260 (goto-char texinfo-command-start
))
3262 ;; @H{o} ==> ""o long Hungarian umlaut
3263 (put 'H
'texinfo-format
'texinfo-format-long-Hungarian-umlaut
)
3264 (defun texinfo-format-long-Hungarian-umlaut ()
3265 (insert "\"\"" (texinfo-parse-arg-discard))
3266 (goto-char texinfo-command-start
))
3268 ;; @ringaccent{o} ==> *o ring accent
3269 (put 'ringaccent
'texinfo-format
'texinfo-format-ring-accent
)
3270 (defun texinfo-format-ring-accent ()
3271 (insert "*" (texinfo-parse-arg-discard))
3272 (goto-char texinfo-command-start
))
3274 ;; @tieaccent{oo} ==> [oo tie after accent
3275 (put 'tieaccent
'texinfo-format
'texinfo-format-tie-after-accent
)
3276 (defun texinfo-format-tie-after-accent ()
3277 (insert "[" (texinfo-parse-arg-discard))
3278 (goto-char texinfo-command-start
))
3281 ;; @u{o} ==> (o breve accent
3282 (put 'u
'texinfo-format
'texinfo-format-breve-accent
)
3283 (defun texinfo-format-breve-accent ()
3284 (insert "(" (texinfo-parse-arg-discard))
3285 (goto-char texinfo-command-start
))
3287 ;; @v{o} ==> <o hacek accent
3288 (put 'v
'texinfo-format
'texinfo-format-hacek-accent
)
3289 (defun texinfo-format-hacek-accent ()
3290 (insert "<" (texinfo-parse-arg-discard))
3291 (goto-char texinfo-command-start
))
3294 ;; @dotless{i} ==> i dotless i and dotless j
3295 (put 'dotless
'texinfo-format
'texinfo-format-dotless
)
3296 (defun texinfo-format-dotless ()
3297 (insert (texinfo-parse-arg-discard))
3298 (goto-char texinfo-command-start
))
3301 ;;; Definition formatting: @deffn, @defun, etc
3303 ;; What definition formatting produces:
3305 ;; @deffn category name args...
3306 ;; In Info, `Category: name ARGS'
3307 ;; In index: name: node. line#.
3309 ;; @defvr category name
3310 ;; In Info, `Category: name'
3311 ;; In index: name: node. line#.
3313 ;; @deftp category name attributes...
3314 ;; `category name attributes...' Note: @deftp args in lower case.
3315 ;; In index: name: node. line#.
3317 ;; Specialized function-like or variable-like entity:
3319 ;; @defun, @defmac, @defspec, @defvar, @defopt
3321 ;; @defun name args In Info, `Function: name ARGS'
3322 ;; @defmac name args In Info, `Macro: name ARGS'
3323 ;; @defvar name In Info, `Variable: name'
3325 ;; In index: name: node. line#.
3327 ;; Generalized typed-function-like or typed-variable-like entity:
3328 ;; @deftypefn category data-type name args...
3329 ;; In Info, `Category: data-type name args...'
3330 ;; @deftypevr category data-type name
3331 ;; In Info, `Category: data-type name'
3332 ;; In index: name: node. line#.
3334 ;; Specialized typed-function-like or typed-variable-like entity:
3335 ;; @deftypefun data-type name args...
3336 ;; In Info, `Function: data-type name ARGS'
3337 ;; In index: name: node. line#.
3339 ;; @deftypevar data-type name
3340 ;; In Info, `Variable: data-type name'
3341 ;; In index: name: node. line#. but include args after name!?
3343 ;; Generalized object oriented entity:
3344 ;; @defop category class name args...
3345 ;; In Info, `Category on class: name ARG'
3346 ;; In index: name on class: node. line#.
3348 ;; @defcv category class name
3349 ;; In Info, `Category of class: name'
3350 ;; In index: name of class: node. line#.
3352 ;; Specialized object oriented entity:
3353 ;; @defmethod class name args...
3354 ;; In Info, `Method on class: name ARGS'
3355 ;; In index: name on class: node. line#.
3357 ;; @defivar class name
3358 ;; In Info, `Instance variable of class: name'
3359 ;; In index: name of class: node. line#.
3362 ;;; The definition formatting functions
3364 (defun texinfo-format-defun ()
3365 (texinfo-push-stack 'defun
nil)
3366 (setq fill-column
(- fill-column
5))
3367 (texinfo-format-defun-1 t
))
3369 (defun texinfo-end-defun ()
3370 (setq fill-column
(+ fill-column
5))
3371 (texinfo-discard-command)
3372 (let ((start (nth 1 (texinfo-pop-stack 'defun
))))
3373 (texinfo-do-itemize start
)
3374 ;; Delete extra newline inserted after header.
3379 (defun texinfo-format-defunx ()
3380 (texinfo-format-defun-1 nil
))
3382 (defun texinfo-format-defun-1 (first-p)
3383 (let ((parse-args (texinfo-format-parse-defun-args))
3384 (texinfo-defun-type (get texinfo-command-name
'texinfo-defun-type
)))
3385 (texinfo-discard-command)
3386 ;; Delete extra newline inserted after previous header line.
3390 (get texinfo-command-name
'texinfo-deffn-formatting-property
) parse-args
)
3391 ;; Insert extra newline so that paragraph filling does not mess
3392 ;; with header line.
3394 (rplaca (cdr (cdr (car texinfo-stack
))) (point))
3396 (get texinfo-command-name
'texinfo-defun-indexing-property
) parse-args
)))
3398 ;;; Formatting the first line of a definition
3400 ;; @deffn, @defvr, @deftp
3401 (put 'deffn
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3402 (put 'deffnx
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3403 (put 'defvr
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3404 (put 'defvrx
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3405 (put 'deftp
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3406 (put 'deftpx
'texinfo-deffn-formatting-property
'texinfo-format-deffn
)
3407 (defun texinfo-format-deffn (parsed-args)
3408 ;; Generalized function-like, variable-like, or generic data-type entity:
3409 ;; @deffn category name args...
3410 ;; In Info, `Category: name ARGS'
3411 ;; @deftp category name attributes...
3412 ;; `category name attributes...' Note: @deftp args in lower case.
3413 (let ((category (car parsed-args
))
3414 (name (car (cdr parsed-args
)))
3415 (args (cdr (cdr parsed-args
))))
3416 (insert " -- " category
": " name
)
3419 (if (or (= ?
& (aref (car args
) 0))
3420 (eq (eval (car texinfo-defun-type
)) 'deftp-type
))
3422 (upcase (car args
))))
3423 (setq args
(cdr args
)))))
3425 ;; @defun, @defmac, @defspec, @defvar, @defopt: Specialized, simple
3426 (put 'defun
'texinfo-deffn-formatting-property
3427 'texinfo-format-specialized-defun
)
3428 (put 'defunx
'texinfo-deffn-formatting-property
3429 'texinfo-format-specialized-defun
)
3430 (put 'defmac
'texinfo-deffn-formatting-property
3431 'texinfo-format-specialized-defun
)
3432 (put 'defmacx
'texinfo-deffn-formatting-property
3433 'texinfo-format-specialized-defun
)
3434 (put 'defspec
'texinfo-deffn-formatting-property
3435 'texinfo-format-specialized-defun
)
3436 (put 'defspecx
'texinfo-deffn-formatting-property
3437 'texinfo-format-specialized-defun
)
3438 (put 'defvar
'texinfo-deffn-formatting-property
3439 'texinfo-format-specialized-defun
)
3440 (put 'defvarx
'texinfo-deffn-formatting-property
3441 'texinfo-format-specialized-defun
)
3442 (put 'defopt
'texinfo-deffn-formatting-property
3443 'texinfo-format-specialized-defun
)
3444 (put 'defoptx
'texinfo-deffn-formatting-property
3445 'texinfo-format-specialized-defun
)
3446 (defun texinfo-format-specialized-defun (parsed-args)
3447 ;; Specialized function-like or variable-like entity:
3448 ;; @defun name args In Info, `Function: Name ARGS'
3449 ;; @defmac name args In Info, `Macro: Name ARGS'
3450 ;; @defvar name In Info, `Variable: Name'
3451 ;; Use cdr of texinfo-defun-type to determine category:
3452 (let ((category (car (cdr texinfo-defun-type
)))
3453 (name (car parsed-args
))
3454 (args (cdr parsed-args
)))
3455 (insert " -- " category
": " name
)
3458 (if (= ?
& (aref (car args
) 0))
3460 (upcase (car args
))))
3461 (setq args
(cdr args
)))))
3463 ;; @deftypefn, @deftypevr: Generalized typed
3464 (put 'deftypefn
'texinfo-deffn-formatting-property
'texinfo-format-deftypefn
)
3465 (put 'deftypefnx
'texinfo-deffn-formatting-property
'texinfo-format-deftypefn
)
3466 (put 'deftypevr
'texinfo-deffn-formatting-property
'texinfo-format-deftypefn
)
3467 (put 'deftypevrx
'texinfo-deffn-formatting-property
'texinfo-format-deftypefn
)
3468 (defun texinfo-format-deftypefn (parsed-args)
3469 ;; Generalized typed-function-like or typed-variable-like entity:
3470 ;; @deftypefn category data-type name args...
3471 ;; In Info, `Category: data-type name args...'
3472 ;; @deftypevr category data-type name
3473 ;; In Info, `Category: data-type name'
3474 ;; Note: args in lower case, unless modified in command line.
3475 (let ((category (car parsed-args
))
3476 (data-type (car (cdr parsed-args
)))
3477 (name (car (cdr (cdr parsed-args
))))
3478 (args (cdr (cdr (cdr parsed-args
)))))
3479 (insert " -- " category
": " data-type
" " name
)
3481 (insert " " (car args
))
3482 (setq args
(cdr args
)))))
3484 ;; @deftypefun, @deftypevar: Specialized typed
3485 (put 'deftypefun
'texinfo-deffn-formatting-property
'texinfo-format-deftypefun
)
3486 (put 'deftypefunx
'texinfo-deffn-formatting-property
3487 'texinfo-format-deftypefun
)
3488 (put 'deftypevar
'texinfo-deffn-formatting-property
'texinfo-format-deftypefun
)
3489 (put 'deftypevarx
'texinfo-deffn-formatting-property
3490 'texinfo-format-deftypefun
)
3491 (defun texinfo-format-deftypefun (parsed-args)
3492 ;; Specialized typed-function-like or typed-variable-like entity:
3493 ;; @deftypefun data-type name args...
3494 ;; In Info, `Function: data-type name ARGS'
3495 ;; @deftypevar data-type name
3496 ;; In Info, `Variable: data-type name'
3497 ;; Note: args in lower case, unless modified in command line.
3498 ;; Use cdr of texinfo-defun-type to determine category:
3499 (let ((category (car (cdr texinfo-defun-type
)))
3500 (data-type (car parsed-args
))
3501 (name (car (cdr parsed-args
)))
3502 (args (cdr (cdr parsed-args
))))
3503 (insert " -- " category
": " data-type
" " name
)
3505 (insert " " (car args
))
3506 (setq args
(cdr args
)))))
3508 ;; @defop: Generalized object-oriented
3509 (put 'defop
'texinfo-deffn-formatting-property
'texinfo-format-defop
)
3510 (put 'defopx
'texinfo-deffn-formatting-property
'texinfo-format-defop
)
3511 (defun texinfo-format-defop (parsed-args)
3512 ;; Generalized object oriented entity:
3513 ;; @defop category class name args...
3514 ;; In Info, `Category on class: name ARG'
3515 ;; Note: args in upper case; use of `on'
3516 (let ((category (car parsed-args
))
3517 (class (car (cdr parsed-args
)))
3518 (name (car (cdr (cdr parsed-args
))))
3519 (args (cdr (cdr (cdr parsed-args
)))))
3520 (insert " -- " category
" on " class
": " name
)
3522 (insert " " (upcase (car args
)))
3523 (setq args
(cdr args
)))))
3525 ;; @defcv: Generalized object-oriented
3526 (put 'defcv
'texinfo-deffn-formatting-property
'texinfo-format-defcv
)
3527 (put 'defcvx
'texinfo-deffn-formatting-property
'texinfo-format-defcv
)
3528 (defun texinfo-format-defcv (parsed-args)
3529 ;; Generalized object oriented entity:
3530 ;; @defcv category class name
3531 ;; In Info, `Category of class: name'
3532 ;; Note: args in upper case; use of `of'
3533 (let ((category (car parsed-args
))
3534 (class (car (cdr parsed-args
)))
3535 (name (car (cdr (cdr parsed-args
))))
3536 (args (cdr (cdr (cdr parsed-args
)))))
3537 (insert " -- " category
" of " class
": " name
)
3539 (insert " " (upcase (car args
)))
3540 (setq args
(cdr args
)))))
3542 ;; @defmethod: Specialized object-oriented
3543 (put 'defmethod
'texinfo-deffn-formatting-property
'texinfo-format-defmethod
)
3544 (put 'defmethodx
'texinfo-deffn-formatting-property
'texinfo-format-defmethod
)
3545 (defun texinfo-format-defmethod (parsed-args)
3546 ;; Specialized object oriented entity:
3547 ;; @defmethod class name args...
3548 ;; In Info, `Method on class: name ARGS'
3549 ;; Note: args in upper case; use of `on'
3550 ;; Use cdr of texinfo-defun-type to determine category:
3551 (let ((category (car (cdr texinfo-defun-type
)))
3552 (class (car parsed-args
))
3553 (name (car (cdr parsed-args
)))
3554 (args (cdr (cdr parsed-args
))))
3555 (insert " -- " category
" on " class
": " name
)
3557 (insert " " (upcase (car args
)))
3558 (setq args
(cdr args
)))))
3560 ;; @defivar: Specialized object-oriented
3561 (put 'defivar
'texinfo-deffn-formatting-property
'texinfo-format-defivar
)
3562 (put 'defivarx
'texinfo-deffn-formatting-property
'texinfo-format-defivar
)
3563 (defun texinfo-format-defivar (parsed-args)
3564 ;; Specialized object oriented entity:
3565 ;; @defivar class name
3566 ;; In Info, `Instance variable of class: name'
3567 ;; Note: args in upper case; use of `of'
3568 ;; Use cdr of texinfo-defun-type to determine category:
3569 (let ((category (car (cdr texinfo-defun-type
)))
3570 (class (car parsed-args
))
3571 (name (car (cdr parsed-args
)))
3572 (args (cdr (cdr parsed-args
))))
3573 (insert " -- " category
" of " class
": " name
)
3575 (insert " " (upcase (car args
)))
3576 (setq args
(cdr args
)))))
3579 ;;; Indexing for definitions
3581 ;; An index entry has three parts: the `entry proper', the node name, and the
3582 ;; line number. Depending on the which command is used, the entry is
3583 ;; formatted differently:
3589 ;; @defopt all use their 1st argument as the entry-proper
3595 ;; @deftypevar all use their 2nd argument as the entry-proper
3598 ;; @deftypevr both use their 3rd argument as the entry-proper
3600 ;; @defmethod uses its 2nd and 1st arguments as an entry-proper
3601 ;; formatted: NAME on CLASS
3603 ;; @defop uses its 3rd and 2nd arguments as an entry-proper
3604 ;; formatted: NAME on CLASS
3606 ;; @defivar uses its 2nd and 1st arguments as an entry-proper
3607 ;; formatted: NAME of CLASS
3609 ;; @defcv uses its 3rd and 2nd argument as an entry-proper
3610 ;; formatted: NAME of CLASS
3612 (put 'defun
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3613 (put 'defunx
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3614 (put 'defmac
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3615 (put 'defmacx
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3616 (put 'defspec
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3617 (put 'defspecx
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3618 (put 'defvar
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3619 (put 'defvarx
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3620 (put 'defopt
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3621 (put 'defoptx
'texinfo-defun-indexing-property
'texinfo-index-defun
)
3622 (defun texinfo-index-defun (parsed-args)
3623 ;; use 1st parsed-arg as entry-proper
3624 ;; `index-list' will be texinfo-findex or the like
3625 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3628 ;; Three elements: entry-proper, node-name, line-number
3632 ;; Region formatting may not provide last node position.
3633 (if texinfo-last-node-pos
3634 (1+ (count-lines texinfo-last-node-pos
(point)))
3636 (symbol-value index-list
)))))
3638 (put 'deffn
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3639 (put 'deffnx
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3640 (put 'defvr
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3641 (put 'defvrx
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3642 (put 'deftp
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3643 (put 'deftpx
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3644 (put 'deftypefun
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3645 (put 'deftypefunx
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3646 (put 'deftypevar
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3647 (put 'deftypevarx
'texinfo-defun-indexing-property
'texinfo-index-deffn
)
3648 (defun texinfo-index-deffn (parsed-args)
3649 ;; use 2nd parsed-arg as entry-proper
3650 ;; `index-list' will be texinfo-findex or the like
3651 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3654 ;; Three elements: entry-proper, node-name, line-number
3656 (car (cdr parsed-args
))
3658 ;; Region formatting may not provide last node position.
3659 (if texinfo-last-node-pos
3660 (1+ (count-lines texinfo-last-node-pos
(point)))
3662 (symbol-value index-list
)))))
3664 (put 'deftypefn
'texinfo-defun-indexing-property
'texinfo-index-deftypefn
)
3665 (put 'deftypefnx
'texinfo-defun-indexing-property
'texinfo-index-deftypefn
)
3666 (put 'deftypevr
'texinfo-defun-indexing-property
'texinfo-index-deftypefn
)
3667 (put 'deftypevrx
'texinfo-defun-indexing-property
'texinfo-index-deftypefn
)
3668 (defun texinfo-index-deftypefn (parsed-args)
3669 ;; use 3rd parsed-arg as entry-proper
3670 ;; `index-list' will be texinfo-findex or the like
3671 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3674 ;; Three elements: entry-proper, node-name, line-number
3676 (car (cdr (cdr parsed-args
)))
3678 ;; Region formatting may not provide last node position.
3679 (if texinfo-last-node-pos
3680 (1+ (count-lines texinfo-last-node-pos
(point)))
3682 (symbol-value index-list
)))))
3684 (put 'defmethod
'texinfo-defun-indexing-property
'texinfo-index-defmethod
)
3685 (put 'defmethodx
'texinfo-defun-indexing-property
'texinfo-index-defmethod
)
3686 (defun texinfo-index-defmethod (parsed-args)
3687 ;; use 2nd on 1st parsed-arg as entry-proper
3688 ;; `index-list' will be texinfo-findex or the like
3689 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3692 ;; Three elements: entry-proper, node-name, line-number
3695 (car (cdr parsed-args
))
3698 ;; Region formatting may not provide last node position.
3699 (if texinfo-last-node-pos
3700 (1+ (count-lines texinfo-last-node-pos
(point)))
3702 (symbol-value index-list
)))))
3704 (put 'defop
'texinfo-defun-indexing-property
'texinfo-index-defop
)
3705 (put 'defopx
'texinfo-defun-indexing-property
'texinfo-index-defop
)
3706 (defun texinfo-index-defop (parsed-args)
3707 ;; use 3rd on 2nd parsed-arg as entry-proper
3708 ;; `index-list' will be texinfo-findex or the like
3709 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3712 ;; Three elements: entry-proper, node-name, line-number
3715 (car (cdr (cdr parsed-args
)))
3716 (car (cdr parsed-args
)))
3718 ;; Region formatting may not provide last node position.
3719 (if texinfo-last-node-pos
3720 (1+ (count-lines texinfo-last-node-pos
(point)))
3722 (symbol-value index-list
)))))
3724 (put 'defivar
'texinfo-defun-indexing-property
'texinfo-index-defivar
)
3725 (put 'defivarx
'texinfo-defun-indexing-property
'texinfo-index-defivar
)
3726 (defun texinfo-index-defivar (parsed-args)
3727 ;; use 2nd of 1st parsed-arg as entry-proper
3728 ;; `index-list' will be texinfo-findex or the like
3729 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3732 ;; Three elements: entry-proper, node-name, line-number
3735 (car (cdr parsed-args
))
3738 ;; Region formatting may not provide last node position.
3739 (if texinfo-last-node-pos
3740 (1+ (count-lines texinfo-last-node-pos
(point)))
3742 (symbol-value index-list
)))))
3744 (put 'defcv
'texinfo-defun-indexing-property
'texinfo-index-defcv
)
3745 (put 'defcvx
'texinfo-defun-indexing-property
'texinfo-index-defcv
)
3746 (defun texinfo-index-defcv (parsed-args)
3747 ;; use 3rd of 2nd parsed-arg as entry-proper
3748 ;; `index-list' will be texinfo-findex or the like
3749 (let ((index-list (get texinfo-command-name
'texinfo-defun-index
)))
3752 ;; Three elements: entry-proper, node-name, line-number
3755 (car (cdr (cdr parsed-args
)))
3756 (car (cdr parsed-args
)))
3758 ;; Region formatting may not provide last node position.
3759 (if texinfo-last-node-pos
3760 (1+ (count-lines texinfo-last-node-pos
(point)))
3762 (symbol-value index-list
)))))
3765 ;;; Properties for definitions
3767 ;; Each definition command has six properties:
3769 ;; 1. texinfo-deffn-formatting-property to format definition line
3770 ;; 2. texinfo-defun-indexing-property to create index entry
3771 ;; 3. texinfo-format formatting command
3772 ;; 4. texinfo-end end formatting command
3773 ;; 5. texinfo-defun-type type of deffn to format
3774 ;; 6. texinfo-defun-index type of index to use
3776 ;; The `x' forms of each definition command are used for the second
3777 ;; and subsequent header lines.
3779 ;; The texinfo-deffn-formatting-property and texinfo-defun-indexing-property
3780 ;; are listed just before the appropriate formatting and indexing commands.
3782 (put 'deffn
'texinfo-format
'texinfo-format-defun
)
3783 (put 'deffnx
'texinfo-format
'texinfo-format-defunx
)
3784 (put 'deffn
'texinfo-end
'texinfo-end-defun
)
3785 (put 'deffn
'texinfo-defun-type
'('deffn-type nil
))
3786 (put 'deffnx
'texinfo-defun-type
'('deffn-type nil
))
3787 (put 'deffn
'texinfo-defun-index
'texinfo-findex
)
3788 (put 'deffnx
'texinfo-defun-index
'texinfo-findex
)
3790 (put 'defun
'texinfo-format
'texinfo-format-defun
)
3791 (put 'defunx
'texinfo-format
'texinfo-format-defunx
)
3792 (put 'defun
'texinfo-end
'texinfo-end-defun
)
3793 (put 'defun
'texinfo-defun-type
'('defun-type
"Function"))
3794 (put 'defunx
'texinfo-defun-type
'('defun-type
"Function"))
3795 (put 'defun
'texinfo-defun-index
'texinfo-findex
)
3796 (put 'defunx
'texinfo-defun-index
'texinfo-findex
)
3798 (put 'defmac
'texinfo-format
'texinfo-format-defun
)
3799 (put 'defmacx
'texinfo-format
'texinfo-format-defunx
)
3800 (put 'defmac
'texinfo-end
'texinfo-end-defun
)
3801 (put 'defmac
'texinfo-defun-type
'('defun-type
"Macro"))
3802 (put 'defmacx
'texinfo-defun-type
'('defun-type
"Macro"))
3803 (put 'defmac
'texinfo-defun-index
'texinfo-findex
)
3804 (put 'defmacx
'texinfo-defun-index
'texinfo-findex
)
3806 (put 'defspec
'texinfo-format
'texinfo-format-defun
)
3807 (put 'defspecx
'texinfo-format
'texinfo-format-defunx
)
3808 (put 'defspec
'texinfo-end
'texinfo-end-defun
)
3809 (put 'defspec
'texinfo-defun-type
'('defun-type
"Special form"))
3810 (put 'defspecx
'texinfo-defun-type
'('defun-type
"Special form"))
3811 (put 'defspec
'texinfo-defun-index
'texinfo-findex
)
3812 (put 'defspecx
'texinfo-defun-index
'texinfo-findex
)
3814 (put 'defvr
'texinfo-format
'texinfo-format-defun
)
3815 (put 'defvrx
'texinfo-format
'texinfo-format-defunx
)
3816 (put 'defvr
'texinfo-end
'texinfo-end-defun
)
3817 (put 'defvr
'texinfo-defun-type
'('deffn-type nil
))
3818 (put 'defvrx
'texinfo-defun-type
'('deffn-type nil
))
3819 (put 'defvr
'texinfo-defun-index
'texinfo-vindex
)
3820 (put 'defvrx
'texinfo-defun-index
'texinfo-vindex
)
3822 (put 'defvar
'texinfo-format
'texinfo-format-defun
)
3823 (put 'defvarx
'texinfo-format
'texinfo-format-defunx
)
3824 (put 'defvar
'texinfo-end
'texinfo-end-defun
)
3825 (put 'defvar
'texinfo-defun-type
'('defun-type
"Variable"))
3826 (put 'defvarx
'texinfo-defun-type
'('defun-type
"Variable"))
3827 (put 'defvar
'texinfo-defun-index
'texinfo-vindex
)
3828 (put 'defvarx
'texinfo-defun-index
'texinfo-vindex
)
3830 (put 'defconst
'texinfo-format
'texinfo-format-defun
)
3831 (put 'defconstx
'texinfo-format
'texinfo-format-defunx
)
3832 (put 'defconst
'texinfo-end
'texinfo-end-defun
)
3833 (put 'defconst
'texinfo-defun-type
'('defun-type
"Constant"))
3834 (put 'defconstx
'texinfo-defun-type
'('defun-type
"Constant"))
3835 (put 'defconst
'texinfo-defun-index
'texinfo-vindex
)
3836 (put 'defconstx
'texinfo-defun-index
'texinfo-vindex
)
3838 (put 'defcmd
'texinfo-format
'texinfo-format-defun
)
3839 (put 'defcmdx
'texinfo-format
'texinfo-format-defunx
)
3840 (put 'defcmd
'texinfo-end
'texinfo-end-defun
)
3841 (put 'defcmd
'texinfo-defun-type
'('defun-type
"Command"))
3842 (put 'defcmdx
'texinfo-defun-type
'('defun-type
"Command"))
3843 (put 'defcmd
'texinfo-defun-index
'texinfo-findex
)
3844 (put 'defcmdx
'texinfo-defun-index
'texinfo-findex
)
3846 (put 'defopt
'texinfo-format
'texinfo-format-defun
)
3847 (put 'defoptx
'texinfo-format
'texinfo-format-defunx
)
3848 (put 'defopt
'texinfo-end
'texinfo-end-defun
)
3849 (put 'defopt
'texinfo-defun-type
'('defun-type
"User Option"))
3850 (put 'defoptx
'texinfo-defun-type
'('defun-type
"User Option"))
3851 (put 'defopt
'texinfo-defun-index
'texinfo-vindex
)
3852 (put 'defoptx
'texinfo-defun-index
'texinfo-vindex
)
3854 (put 'deftp
'texinfo-format
'texinfo-format-defun
)
3855 (put 'deftpx
'texinfo-format
'texinfo-format-defunx
)
3856 (put 'deftp
'texinfo-end
'texinfo-end-defun
)
3857 (put 'deftp
'texinfo-defun-type
'('deftp-type nil
))
3858 (put 'deftpx
'texinfo-defun-type
'('deftp-type nil
))
3859 (put 'deftp
'texinfo-defun-index
'texinfo-tindex
)
3860 (put 'deftpx
'texinfo-defun-index
'texinfo-tindex
)
3862 ;;; Object-oriented stuff is a little hairier.
3864 (put 'defop
'texinfo-format
'texinfo-format-defun
)
3865 (put 'defopx
'texinfo-format
'texinfo-format-defunx
)
3866 (put 'defop
'texinfo-end
'texinfo-end-defun
)
3867 (put 'defop
'texinfo-defun-type
'('defop-type nil
))
3868 (put 'defopx
'texinfo-defun-type
'('defop-type nil
))
3869 (put 'defop
'texinfo-defun-index
'texinfo-findex
)
3870 (put 'defopx
'texinfo-defun-index
'texinfo-findex
)
3872 (put 'defmethod
'texinfo-format
'texinfo-format-defun
)
3873 (put 'defmethodx
'texinfo-format
'texinfo-format-defunx
)
3874 (put 'defmethod
'texinfo-end
'texinfo-end-defun
)
3875 (put 'defmethod
'texinfo-defun-type
'('defmethod-type
"Method"))
3876 (put 'defmethodx
'texinfo-defun-type
'('defmethod-type
"Method"))
3877 (put 'defmethod
'texinfo-defun-index
'texinfo-findex
)
3878 (put 'defmethodx
'texinfo-defun-index
'texinfo-findex
)
3880 (put 'defcv
'texinfo-format
'texinfo-format-defun
)
3881 (put 'defcvx
'texinfo-format
'texinfo-format-defunx
)
3882 (put 'defcv
'texinfo-end
'texinfo-end-defun
)
3883 (put 'defcv
'texinfo-defun-type
'('defop-type nil
))
3884 (put 'defcvx
'texinfo-defun-type
'('defop-type nil
))
3885 (put 'defcv
'texinfo-defun-index
'texinfo-vindex
)
3886 (put 'defcvx
'texinfo-defun-index
'texinfo-vindex
)
3888 (put 'defivar
'texinfo-format
'texinfo-format-defun
)
3889 (put 'defivarx
'texinfo-format
'texinfo-format-defunx
)
3890 (put 'defivar
'texinfo-end
'texinfo-end-defun
)
3891 (put 'defivar
'texinfo-defun-type
'('defmethod-type
"Instance variable"))
3892 (put 'defivarx
'texinfo-defun-type
'('defmethod-type
"Instance variable"))
3893 (put 'defivar
'texinfo-defun-index
'texinfo-vindex
)
3894 (put 'defivarx
'texinfo-defun-index
'texinfo-vindex
)
3896 ;;; Typed functions and variables
3898 (put 'deftypefn
'texinfo-format
'texinfo-format-defun
)
3899 (put 'deftypefnx
'texinfo-format
'texinfo-format-defunx
)
3900 (put 'deftypefn
'texinfo-end
'texinfo-end-defun
)
3901 (put 'deftypefn
'texinfo-defun-type
'('deftypefn-type nil
))
3902 (put 'deftypefnx
'texinfo-defun-type
'('deftypefn-type nil
))
3903 (put 'deftypefn
'texinfo-defun-index
'texinfo-findex
)
3904 (put 'deftypefnx
'texinfo-defun-index
'texinfo-findex
)
3906 (put 'deftypefun
'texinfo-format
'texinfo-format-defun
)
3907 (put 'deftypefunx
'texinfo-format
'texinfo-format-defunx
)
3908 (put 'deftypefun
'texinfo-end
'texinfo-end-defun
)
3909 (put 'deftypefun
'texinfo-defun-type
'('deftypefun-type
"Function"))
3910 (put 'deftypefunx
'texinfo-defun-type
'('deftypefun-type
"Function"))
3911 (put 'deftypefun
'texinfo-defun-index
'texinfo-findex
)
3912 (put 'deftypefunx
'texinfo-defun-index
'texinfo-findex
)
3914 (put 'deftypevr
'texinfo-format
'texinfo-format-defun
)
3915 (put 'deftypevrx
'texinfo-format
'texinfo-format-defunx
)
3916 (put 'deftypevr
'texinfo-end
'texinfo-end-defun
)
3917 (put 'deftypevr
'texinfo-defun-type
'('deftypefn-type nil
))
3918 (put 'deftypevrx
'texinfo-defun-type
'('deftypefn-type nil
))
3919 (put 'deftypevr
'texinfo-defun-index
'texinfo-vindex
)
3920 (put 'deftypevrx
'texinfo-defun-index
'texinfo-vindex
)
3922 (put 'deftypevar
'texinfo-format
'texinfo-format-defun
)
3923 (put 'deftypevarx
'texinfo-format
'texinfo-format-defunx
)
3924 (put 'deftypevar
'texinfo-end
'texinfo-end-defun
)
3925 (put 'deftypevar
'texinfo-defun-type
'('deftypevar-type
"Variable"))
3926 (put 'deftypevarx
'texinfo-defun-type
'('deftypevar-type
"Variable"))
3927 (put 'deftypevar
'texinfo-defun-index
'texinfo-vindex
)
3928 (put 'deftypevarx
'texinfo-defun-index
'texinfo-vindex
)
3931 ;;; @set, @clear, @ifset, @ifclear
3933 ;; If a flag is set with @set FLAG, then text between @ifset and @end
3934 ;; ifset is formatted normally, but if the flag is cleared with
3935 ;; @clear FLAG, then the text is not formatted; it is ignored.
3937 ;; If a flag is cleared with @clear FLAG, then text between @ifclear
3938 ;; and @end ifclear is formatted normally, but if the flag is set with
3939 ;; @set FLAG, then the text is not formatted; it is ignored. @ifclear
3940 ;; is the opposite of @ifset.
3942 ;; If a flag is set to a string with @set FLAG,
3943 ;; replace @value{FLAG} with the string.
3944 ;; If a flag with a value is cleared,
3945 ;; @value{FLAG} is invalid,
3946 ;; as if there had never been any @set FLAG previously.
3948 (put 'clear
'texinfo-format
'texinfo-clear
)
3949 (defun texinfo-clear ()
3950 "Clear the value of the flag."
3951 (let* ((arg (texinfo-parse-arg-discard))
3952 (flag (car (read-from-string arg
)))
3953 (value (substring arg
(cdr (read-from-string arg
)))))
3954 (put flag
'texinfo-whether-setp
'flag-cleared
)
3955 (put flag
'texinfo-set-value
"")))
3957 (put 'set
'texinfo-format
'texinfo-set
)
3958 (defun texinfo-set ()
3959 "Set the value of the flag, optionally to a string.
3960 The command `@set foo This is a string.'
3961 sets flag foo to the value: `This is a string.'
3962 The command `@value{foo}' expands to the value."
3963 (let* ((arg (texinfo-parse-arg-discard))
3964 (flag (car (read-from-string arg
)))
3965 (value (substring arg
(cdr (read-from-string arg
)))))
3966 (if (string-match "^[ \t]+" value
)
3967 (setq value
(substring value
(match-end 0))))
3968 (put flag
'texinfo-whether-setp
'flag-set
)
3969 (put flag
'texinfo-set-value value
)))
3971 (put 'value
'texinfo-format
'texinfo-value
)
3972 (defun texinfo-value ()
3973 "Insert the string to which the flag is set.
3974 The command `@set foo This is a string.'
3975 sets flag foo to the value: `This is a string.'
3976 The command `@value{foo}' expands to the value."
3977 (let ((arg (texinfo-parse-arg-discard)))
3979 (eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
3981 (get (car (read-from-string arg
)) 'texinfo-set-value
))
3982 (insert (get (car (read-from-string arg
)) 'texinfo-set-value
)))
3983 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
3985 (insert (format "{No value for \"%s\"}" arg
)))
3986 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
) nil
)
3987 (insert (format "{No value for \"%s\"}" arg
))))))
3989 (put 'ifset
'texinfo-end
'texinfo-discard-command
)
3990 (put 'ifset
'texinfo-format
'texinfo-if-set
)
3991 (defun texinfo-if-set ()
3992 "If set, continue formatting; else do not format region up to @end ifset."
3993 (let ((arg (texinfo-parse-arg-discard)))
3995 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
3997 ;; Format the text (i.e., do not remove it); do nothing here.
3999 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
4001 ;; Clear region (i.e., cause the text to be ignored).
4002 (delete-region texinfo-command-start
4003 (re-search-forward "@end ifset[ \t]*\n")))
4004 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
4006 ;; In this case flag is neither set nor cleared.
4007 ;; Act as if set, i.e. do nothing.
4010 (put 'ifclear
'texinfo-end
'texinfo-discard-command
)
4011 (put 'ifclear
'texinfo-format
'texinfo-if-clear
)
4012 (defun texinfo-if-clear ()
4013 "If clear, continue formatting; if set, do not format up to @end ifset."
4014 (let ((arg (texinfo-parse-arg-discard)))
4016 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
4018 ;; Clear region (i.e., cause the text to be ignored).
4019 (delete-region texinfo-command-start
4020 (re-search-forward "@end ifclear[ \t]*\n")))
4021 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
4023 ;; Format the text (i.e., do not remove it); do nothing here.
4025 ((eq (get (car (read-from-string arg
)) 'texinfo-whether-setp
)
4027 ;; In this case flag is neither set nor cleared.
4028 ;; Act as if clear, i.e. do nothing.
4033 (put 'ifeq
'texinfo-format
'texinfo-format-ifeq
)
4034 (defun texinfo-format-ifeq ()
4035 "If ARG1 and ARG2 caselessly string compare to same string, perform COMMAND.
4036 Otherwise produces no output.
4039 @ifeq{ arg1 , arg1 , @code{foo}} bar
4043 @ifeq{ arg1 , arg2 , @code{foo}} bar
4047 Note that the Texinfo command and its arguments must be arguments to
4049 ;; compare-buffer-substrings does not exist in version 18; don't use
4050 (goto-char texinfo-command-end
)
4051 (let* ((case-fold-search t
)
4052 (stop (save-excursion (forward-sexp 1) (point)))
4054 ;; @ifeq{arg1, arg2, @command{optional-args}}
4058 (skip-chars-forward " ")
4059 (setq start
(point))
4060 (search-forward "," stop t
)
4061 (skip-chars-backward ", ")
4062 (buffer-substring-no-properties start
(point))))
4065 (search-forward "," stop t
)
4066 (skip-chars-forward " ")
4067 (setq start
(point))
4068 (search-forward "," stop t
)
4069 (skip-chars-backward ", ")
4070 (buffer-substring-no-properties start
(point))))
4073 (search-forward "," stop t
)
4074 (skip-chars-forward " ")
4075 (setq start
(point))
4076 (goto-char (1- stop
))
4077 (skip-chars-backward " ")
4078 (buffer-substring-no-properties start
(point)))))
4079 (delete-region texinfo-command-start stop
)
4080 (if (equal arg1 arg2
)
4081 (insert texinfo-command
))
4082 (goto-char texinfo-command-start
)))
4085 ;;; Process included files: `@include' command
4087 ;; Updated 19 October 1990
4088 ;; In the original version, include files were ignored by Info but
4089 ;; incorporated in to the printed manual. To make references to the
4090 ;; included file, the Texinfo source file has to refer to the included
4091 ;; files using the `(filename)nodename' format for referring to other
4092 ;; Info files. Also, the included files had to be formatted on their
4093 ;; own. It was just like they were another file.
4095 ;; Currently, include files are inserted into the buffer that is
4096 ;; formatted for Info. If large, the resulting info file is split and
4097 ;; tagified. For current include files to work, the master menu must
4098 ;; refer to all the nodes, and the highest level nodes in the include
4099 ;; files must have the correct next, prev, and up pointers.
4101 ;; The included file may have an @setfilename and even an @settitle,
4102 ;; but not an `\input texinfo' line.
4104 ;; Updated 24 March 1993
4105 ;; In order for @raisesections and @lowersections to work, included
4106 ;; files must be inserted into the buffer holding the outer file
4107 ;; before other Info formatting takes place. So @include is no longer
4108 ;; is treated like other @-commands.
4109 (put 'include
'texinfo-format
'texinfo-format-noop
)
4111 ;; Original definition:
4112 ;; (defun texinfo-format-include ()
4113 ;; (let ((filename (texinfo-parse-arg-discard))
4114 ;; (default-directory input-directory)
4118 ;; (progn (find-file
4119 ;; (cond ((file-readable-p (concat filename ".texinfo"))
4120 ;; (concat filename ".texinfo"))
4121 ;; ((file-readable-p (concat filename ".texi"))
4122 ;; (concat filename ".texi"))
4123 ;; ((file-readable-p (concat filename ".tex"))
4124 ;; (concat filename ".tex"))
4125 ;; ((file-readable-p filename)
4127 ;; (t (error "@include'd file %s not found"
4129 ;; (texinfo-format-buffer-1))))
4130 ;; (texinfo-subindex 'texinfo-vindex (car subindex) (nth 1 subindex))
4131 ;; (texinfo-subindex 'texinfo-findex (car subindex) (nth 2 subindex))
4132 ;; (texinfo-subindex 'texinfo-cindex (car subindex) (nth 3 subindex))
4133 ;; (texinfo-subindex 'texinfo-pindex (car subindex) (nth 4 subindex))
4134 ;; (texinfo-subindex 'texinfo-tindex (car subindex) (nth 5 subindex))
4135 ;; (texinfo-subindex 'texinfo-kindex (car subindex) (nth 6 subindex))))
4137 ;;(defun texinfo-subindex (indexvar file content)
4138 ;; (set indexvar (cons (list 'recurse file content)
4139 ;; (symbol-value indexvar))))
4141 ;; Second definition:
4142 ;; (put 'include 'texinfo-format 'texinfo-format-include)
4143 ;; (defun texinfo-format-include ()
4144 ;; (let ((filename (concat input-directory
4145 ;; (texinfo-parse-arg-discard)))
4146 ;; (default-directory input-directory))
4147 ;; (message "Reading: %s" filename)
4149 ;; (save-restriction
4150 ;; (narrow-to-region
4152 ;; (+ (point) (car (cdr (insert-file-contents filename)))))
4153 ;; (goto-char (point-min))
4154 ;; (texinfo-append-refill)
4155 ;; (texinfo-format-convert (point-min) (point-max))))
4156 ;; (setq last-input-buffer input-buffer) ; to bypass setfilename
4160 ;;; Numerous commands do nothing in Info
4161 ;; These commands are defined in texinfo.tex for printed output.
4164 ;;; various noops, such as @b{foo}, that take arguments in braces
4166 (put 'b
'texinfo-format
'texinfo-format-noop
)
4167 (put 'i
'texinfo-format
'texinfo-format-noop
)
4168 (put 'r
'texinfo-format
'texinfo-format-noop
)
4169 (put 't
'texinfo-format
'texinfo-format-noop
)
4170 (put 'w
'texinfo-format
'texinfo-format-noop
)
4171 (put 'asis
'texinfo-format
'texinfo-format-noop
)
4172 (put 'dmn
'texinfo-format
'texinfo-format-noop
)
4173 (put 'math
'texinfo-format
'texinfo-format-noop
)
4174 (put 'titlefont
'texinfo-format
'texinfo-format-noop
)
4175 (defun texinfo-format-noop ()
4176 (insert (texinfo-parse-arg-discard))
4177 (goto-char texinfo-command-start
))
4179 ;; @hyphenation command discards an argument within braces
4180 (put 'hyphenation
'texinfo-format
'texinfo-discard-command-and-arg
)
4181 (defun texinfo-discard-command-and-arg ()
4182 "Discard both @-command and its argument in braces."
4183 (goto-char texinfo-command-end
)
4185 (setq texinfo-command-end
(point))
4186 (delete-region texinfo-command-start texinfo-command-end
))
4189 ;;; Do nothing commands, such as @smallbook, that have no args and no braces
4190 ;; These must appear on a line of their own
4192 (put 'bye
'texinfo-format
'texinfo-discard-line
)
4193 (put 'smallbook
'texinfo-format
'texinfo-discard-line
)
4194 (put 'finalout
'texinfo-format
'texinfo-discard-line
)
4195 (put 'overfullrule
'texinfo-format
'texinfo-discard-line
)
4196 (put 'smallbreak
'texinfo-format
'texinfo-discard-line
)
4197 (put 'medbreak
'texinfo-format
'texinfo-discard-line
)
4198 (put 'bigbreak
'texinfo-format
'texinfo-discard-line
)
4199 (put 'afourpaper
'texinfo-format
'texinfo-discard-line
)
4200 (put 'afivepaper
'texinfo-format
'texinfo-discard-line
)
4201 (put 'afourlatex
'texinfo-format
'texinfo-discard-line
)
4202 (put 'afourwide
'texinfo-format
'texinfo-discard-line
)
4205 ;;; These noop commands discard the rest of the line.
4207 (put 'c
'texinfo-format
'texinfo-discard-line-with-args
)
4208 (put 'comment
'texinfo-format
'texinfo-discard-line-with-args
)
4209 (put 'contents
'texinfo-format
'texinfo-discard-line-with-args
)
4210 (put 'group
'texinfo-end
'texinfo-discard-line-with-args
)
4211 (put 'group
'texinfo-format
'texinfo-discard-line-with-args
)
4212 (put 'headings
'texinfo-format
'texinfo-discard-line-with-args
)
4213 (put 'setchapterstyle
'texinfo-format
'texinfo-discard-line-with-args
)
4214 (put 'hsize
'texinfo-format
'texinfo-discard-line-with-args
)
4215 (put 'itemindent
'texinfo-format
'texinfo-discard-line-with-args
)
4216 (put 'lispnarrowing
'texinfo-format
'texinfo-discard-line-with-args
)
4217 (put 'need
'texinfo-format
'texinfo-discard-line-with-args
)
4218 (put 'nopara
'texinfo-format
'texinfo-discard-line-with-args
)
4220 ;; @novalidate suppresses cross-reference checking and auxiliary file
4221 ;; creation with TeX. The Info-validate command checks that every
4222 ;; node pointer points to an existing node. Since this Info command
4223 ;; is not invoked automatically, the @novalidate command is irrelevant
4224 ;; and not supported by texinfmt.el
4225 (put 'novalidate
'texinfo-format
'texinfo-discard-line-with-args
)
4227 (put 'page
'texinfo-format
'texinfo-discard-line-with-args
)
4228 (put 'pagesizes
'texinfo-format
'texinfo-discard-line-with-args
)
4229 (put 'parindent
'texinfo-format
'texinfo-discard-line-with-args
)
4230 (put 'setchapternewpage
'texinfo-format
'texinfo-discard-line-with-args
)
4231 (put 'setq
'texinfo-format
'texinfo-discard-line-with-args
)
4233 (put 'setcontentsaftertitlepage
4234 'texinfo-format
'texinfo-discard-line-with-args
)
4235 (put 'setshortcontentsaftertitlepage
4236 'texinfo-format
'texinfo-discard-line-with-args
)
4238 (put 'settitle
'texinfo-format
'texinfo-discard-line-with-args
)
4239 (put 'setx
'texinfo-format
'texinfo-discard-line-with-args
)
4240 (put 'shortcontents
'texinfo-format
'texinfo-discard-line-with-args
)
4241 (put 'shorttitlepage
'texinfo-format
'texinfo-discard-line-with-args
)
4242 (put 'summarycontents
'texinfo-format
'texinfo-discard-line-with-args
)
4243 (put 'input
'texinfo-format
'texinfo-discard-line-with-args
)
4245 (put 'documentlanguage
'texinfo-format
'texinfo-discard-line-with-args
)
4246 (put 'documentencoding
'texinfo-format
'texinfo-discard-line-with-args
)
4250 ;;; Some commands cannot be handled
4252 (defun texinfo-unsupported ()
4253 (error "%s is not handled by texinfo"
4254 (buffer-substring-no-properties texinfo-command-start texinfo-command-end
)))
4256 ;;; Batch formatting
4258 (defun batch-texinfo-format ()
4259 "Run `texinfo-format-buffer' on the files remaining on the command line.
4260 Must be used only with -batch, and kills Emacs on completion.
4261 Each file will be processed even if an error occurred previously.
4263 \"emacs -batch -l texinfmt -f batch-texinfo-format $docs/ ~/*.texinfo\"."
4264 (if (not noninteractive
)
4265 (error "batch-texinfo-format may only be used -batch"))
4266 (let ((version-control t
)
4267 (auto-save-default nil
)
4268 (find-file-run-dired nil
)
4269 (kept-old-versions 259259)
4270 (kept-new-versions 259259))
4274 (while command-line-args-left
4275 (setq file
(expand-file-name (car command-line-args-left
)))
4276 (cond ((not (file-exists-p file
))
4277 (message ">> %s does not exist!" file
)
4279 command-line-args-left
(cdr command-line-args-left
)))
4280 ((file-directory-p file
)
4281 (setq command-line-args-left
4282 (nconc (directory-files file
)
4283 (cdr command-line-args-left
))))
4286 (setq command-line-args-left
(cdr command-line-args-left
)))))
4288 (setq file
(car files
)
4292 (if buffer-file-name
(kill-buffer (current-buffer)))
4294 (buffer-disable-undo (current-buffer))
4295 (set-buffer-modified-p nil
)
4297 (message "texinfo formatting %s..." file
)
4298 (texinfo-format-buffer nil
)
4299 (if (buffer-modified-p)
4300 (progn (message "Saving modified %s" (buffer-file-name))
4303 (message ">> Error: %s" (prin1-to-string err
))
4304 (message ">> point at")
4305 (let ((s (buffer-substring-no-properties (point)
4306 (min (+ (point) 100)
4309 (while (setq tem
(string-match "\n+" s tem
))
4310 (setq s
(concat (substring s
0 (match-beginning 0))
4312 (substring s
(match-end 0)))
4314 (message ">> %s" s
))
4316 (kill-emacs error
))))
4319 ;;; Place `provide' at end of file.
4322 ;;; texinfmt.el ends here
