utils/ptexinfmt.el

   1 ;;; ptexinfmt.el -- portable Texinfo formatter.
   2
   3 ;; Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993,
   4 ;;               1994, 1995, 1996, 1997 Free Software Foundation, Inc.
   5 ;; Copyright (C) 1999 Yoshiki Hayashi <yoshiki@xemacs.org>
   6 ;; Copyright (C) 2000 TAKAHASHI Kaoru <kaoru@kaisei.org>
   7
   8 ;; Author: TAKAHASHI Kaoru <kaoru@kaisei.org>
   9 ;;      Yoshiki Hayashi <yoshiki@xemacs.org>
  10 ;; Maintainer: TAKAHASHI Kaoru <kaoru@kaisei.org>
  11 ;; Created: 7 Jul 2000
  12 ;; Keywords: maint, tex, docs, emulation, compatibility
  13
  14 ;; This program is free software; you can redistribute it and/or
  15 ;; modify it under the terms of the GNU General Public License as
  16 ;; published by the Free Software Foundation; either version 2, or (at
  17 ;; your option) any later version.
  18
  19 ;; This program is distributed in the hope that it will be useful, but
  20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22 ;; General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  27 ;; Boston, MA 02111-1307, USA.
  28
  29 ;;; Commentary:
  30
  31 ;; Original code: Yoshiki Hayashi <yoshiki@xemacs.org>
  32 ;;      makeinfo.el (gnujdoc project)
  33
  34 ;; Support texinfmt.el 2.32 or later.
  35
  36 ;;; Code:
  37 (require 'texinfmt)
  38 (require 'poe)
  39 (require 'broken)
  40
  41 (provide 'ptexinfmt)
  42
  43 ;;; Broken
  44 (defvar ptexinfmt-disable-broken-notice-flag t
  45   "If non-nil disable notice, when call `broken-facility'.
  46 This is NO-NOTICE argument in `broken-facility'.")
  47
  48 ;; sort -fd
  49 (broken-facility texinfo-format-printindex
  50   "Can't sort on Mule for Windows."
  51   (if (and (memq system-type '(windows-nt ms-dos))
  52 ;;; I don't know version threshold.
  53 ;;;        (string< texinfmt-version "2.37 of 24 May 1997")
  54            (boundp 'MULE) (not (featurep 'meadow))) ; Mule for Windows
  55       nil
  56     t)
  57   ptexinfmt-disable-broken-notice-flag)
  58
  59 ;; @var
  60 (broken-facility texinfo-format-var
  61   "Don't perse @var argument."
  62   (condition-case nil
  63       (with-temp-buffer
  64         (let (texinfo-enclosure-list texinfo-alias-list)
  65           (texinfo-mode)
  66           (insert "@var{@asis{foo}}\n")
  67           (texinfo-format-expand-region (point-min) (point-max))
  68           t))
  69     (error nil))
  70   ptexinfmt-disable-broken-notice-flag)
  71
  72 ;; @xref
  73 (broken-facility texinfo-format-xref
  74   "Can't format @xref, 1st argument is empty."
  75   (condition-case nil
  76       (with-temp-buffer
  77         (let (texinfo-enclosure-list texinfo-alias-list)
  78           (texinfo-mode)
  79           (insert "@xref{, xref, , file}\n")
  80           (texinfo-format-expand-region (point-min) (point-max))
  81           t))
  82     (error nil))
  83   ptexinfmt-disable-broken-notice-flag)
  84
  85 ;; @uref
  86 (broken-facility texinfo-format-uref
  87   "Parse twice @uref argument."
  88   (condition-case nil
  89       (with-temp-buffer
  90         (let (texinfo-enclosure-list texinfo-alias-list)
  91           (texinfo-mode)
  92           (insert "@uref{mailto:foo@@bar.com}\n")
  93           (texinfo-format-expand-region (point-min) (point-max))
  94           t))
  95     (error nil))
  96   ptexinfmt-disable-broken-notice-flag)
  97
  98 ;; @multitable
  99 (broken-facility texinfo-multitable-widths
 100   "`texinfo-multitable-widths' unsupport wide-char."
 101   (if (fboundp 'texinfo-multitable-widths)
 102       (with-temp-buffer
 103         (let ((str "\e$BI}9-J8;z\e(B"))
 104           (texinfo-mode)
 105           (insert (format " {%s}\n" str))
 106           (goto-char (point-min))
 107           (if (= (car (texinfo-multitable-widths)) (length str))
 108               nil
 109             t)))
 110     ;; function definition is void
 111     t)
 112   ptexinfmt-disable-broken-notice-flag)
 113
 114 (broken-facility texinfo-multitable-item
 115   "`texinfo-multitable-item' unsupport wide-char."
 116   (if-broken texinfo-multitable-widths nil t)
 117   ptexinfmt-disable-broken-notice-flag)
 118
 119
 120 ;;; Obsolete
 121 ;; Removed Texinfo 3.8
 122 (put 'overfullrule 'texinfo-format 'texinfo-discard-line)
 123 (put 'smallbreak 'texinfo-format 'texinfo-discard-line)
 124 (put 'medbreak 'texinfo-format 'texinfo-discard-line)
 125 (put 'bigbreak 'texinfo-format 'texinfo-discard-line)
 126 ;; Removed Texinfo 3.9
 127 (put 'setchapterstyle 'texinfo-format 'texinfo-discard-line-with-args)
 128
 129 ;;; Hardcopy and HTML (discard)
 130 ;; I18N
 131 (put 'documentlanguage 'texinfo-format 'texinfo-discard-line-with-args)
 132 (put 'documentencoding 'texinfo-format 'texinfo-discard-line-with-args)
 133
 134 ;; size
 135 (put 'smallbook 'texinfo-format 'texinfo-discard-line)
 136 (put 'afourpaper 'texinfo-format 'texinfo-discard-line)
 137 (put 'afourlatex 'texinfo-format 'texinfo-discard-line)
 138 (put 'afourwide 'texinfo-format 'texinfo-discard-line)
 139 (put 'pagesizes 'texinfo-format 'texinfo-discard-line-with-args)
 140
 141 ;; style
 142 (put 'setchapternewpage 'texinfo-format 'texinfo-discard-line-with-args)
 143 (put 'kbdinputstyle 'texinfo-format 'texinfo-discard-line-with-args)
 144
 145 ;; flags
 146 (put 'setcontentsaftertitlepage 'texinfo-format 'texinfo-discard-line)
 147 (put 'setshortcontentsaftertitlepage 'texinfo-format 'texinfo-discard-line)
 148 (put 'novalidate 'texinfo-format 'texinfo-discard-line-with-args)
 149
 150 ;; head & foot
 151 (put 'headings 'texinfo-format 'texinfo-discard-line-with-args)
 152 (put 'evenfooting 'texinfo-format 'texinfo-discard-line-with-args)
 153 (put 'evenheading 'texinfo-format 'texinfo-discard-line-with-args)
 154 (put 'oddfooting 'texinfo-format 'texinfo-discard-line-with-args)
 155 (put 'oddheading 'texinfo-format 'texinfo-discard-line-with-args)
 156 (put 'everyfooting 'texinfo-format 'texinfo-discard-line-with-args)
 157 (put 'everyheading 'texinfo-format 'texinfo-discard-line-with-args)
 158
 159 ;; misc
 160 (put 'page 'texinfo-format 'texinfo-discard-line)
 161 (put 'hyphenation 'texinfo-format 'texinfo-discard-command-and-arg)
 162
 163
 164 \f
 165 ;;; Directory File
 166 ;; @direcategory
 167 (put 'dircategory 'texinfo-format 'texinfo-format-dircategory)
 168 (defun-maybe texinfo-format-dircategory ()
 169   (let ((str (texinfo-parse-arg-discard)))
 170     (delete-region (point)
 171                    (progn
 172                      (skip-chars-forward " ")
 173                      (point)))
 174     (insert "INFO-DIR-SECTION " str "\n")))
 175
 176 ;; @direntry
 177 (put 'direntry 'texinfo-format 'texinfo-format-direntry)
 178 (defun-maybe texinfo-format-direntry ()
 179   (texinfo-push-stack 'direntry nil)
 180   (texinfo-discard-line)
 181   (insert "START-INFO-DIR-ENTRY\n\n"))
 182
 183 (put 'direntry 'texinfo-end 'texinfo-end-direntry)
 184 (defun-maybe texinfo-end-direntry ()
 185   (texinfo-discard-command)
 186   (insert "END-INFO-DIR-ENTRY\n\n")
 187   (texinfo-pop-stack 'direntry))
 188
 189
 190 ;;; Block Enclosing and Conditional
 191 ;; @detailmenu ... @end detailmenu
 192 (put 'detailmenu 'texinfo-format 'texinfo-discard-line)
 193 (put 'detailmenu 'texinfo-end 'texinfo-discard-command)
 194
 195 ;; @smalldisplay ... @end smalldisplay
 196 (put 'smalldisplay 'texinfo-format 'texinfo-format-example)
 197 (put 'smalldisplay 'texinfo-end 'texinfo-end-example)
 198
 199 ;; @smallformat ... @end smallformat
 200 (put 'smallformat 'texinfo-format 'texinfo-format-flushleft)
 201 (put 'smallformat 'texinfo-end 'texinfo-end-flushleft)
 202
 203 ;; @ifnottex ... @end ifnottex
 204 (put 'ifnottex 'texinfo-format 'texinfo-discard-line)
 205 (put 'ifnottex 'texinfo-end 'texinfo-discard-command)
 206
 207 ;; @ifnothtml ... @end ifnothtml
 208 (put 'ifnothtml 'texinfo-format 'texinfo-discard-line)
 209 (put 'ifnothtml 'texinfo-end 'texinfo-discard-command)
 210
 211 ;; @ifnotinfo ... @end ifnotinfo
 212 (put 'ifnotinfo 'texinfo-format 'texinfo-format-ifnotinfo)
 213 (put 'endifnotinfo 'texinfo-format 'texinfo-discard-line)
 214 (defun-maybe texinfo-format-ifnotinfo ()
 215   (delete-region texinfo-command-start
 216                  (progn (re-search-forward "@end ifnotinfo[ \t]*\n")
 217                         (point))))
 218
 219 ;; @html ... @end html
 220 (put 'html 'texinfo-format 'texinfo-format-html)
 221 (put 'endhtml 'texinfo-format 'texinfo-discard-line)
 222 (defun-maybe texinfo-format-html ()
 223   (delete-region texinfo-command-start
 224                  (progn (re-search-forward "@end html[ \t]*\n")
 225                         (point))))
 226
 227
 228 \f
 229 ;;; Marking
 230 ;; @url, @env, @command
 231 (put 'url 'texinfo-format 'texinfo-format-code)
 232 (put 'env 'texinfo-format 'texinfo-format-code)
 233 (put 'command 'texinfo-format 'texinfo-format-code)
 234
 235 ;; @acronym
 236 (put 'acronym 'texinfo-format 'texinfo-format-var)
 237
 238 (when-broken texinfo-format-var
 239   (fmakunbound 'texinfo-format-var))
 240 (defun-maybe texinfo-format-var ()
 241   (let ((arg (texinfo-parse-expanded-arg)))
 242     (texinfo-discard-command)
 243     (insert (upcase arg))))
 244
 245 ;; @key
 246 (put 'key 'texinfo-format 'texinfo-format-key)
 247 (defun-maybe texinfo-format-key ()
 248   (insert (texinfo-parse-arg-discard))
 249   (goto-char texinfo-command-start))
 250
 251 ;; @email{EMAIL-ADDRESS[, DISPLAYED-TEXT]}
 252 (put 'email 'texinfo-format 'texinfo-format-email)
 253 (defun-maybe texinfo-format-email ()
 254   "Format EMAIL-ADDRESS and optional DISPLAYED-TXT.
 255 Insert < ... > around EMAIL-ADDRESS."
 256   (let ((args (texinfo-format-parse-args)))
 257   (texinfo-discard-command)
 258     ;; if displayed-text
 259     (if (nth 1 args)
 260         (insert (nth 1 args) " <" (nth 0 args) ">")
 261       (insert "<" (nth 0 args) ">"))))
 262
 263 ;; @option
 264 (put 'option 'texinfo-format 'texinfo-format-option)
 265 (defun texinfo-format-option ()
 266   "Insert ` ... ' around arg unless inside a table; in that case, no quotes."
 267   ;; `looking-at-backward' not available in v. 18.57, 20.2
 268   ;; searched-for character is a control-H
 269   (if (not (search-backward "\010"
 270                             (save-excursion (beginning-of-line) (point))
 271                             t))
 272       (insert "`" (texinfo-parse-arg-discard) "'")
 273     (insert (texinfo-parse-arg-discard)))
 274   (goto-char texinfo-command-start))
 275
 276
 277 \f
 278 ;;; Accents and Special characters
 279 ;; @pounds{}    ==>     #       Pounds Sterling
 280 (put 'pounds 'texinfo-format 'texinfo-format-pounds)
 281 (defun-maybe texinfo-format-pounds ()
 282   (texinfo-parse-arg-discard)
 283   (insert "#"))
 284
 285 ;; @OE{}        ==>     OE      French-OE-ligature
 286 (put 'OE 'texinfo-format 'texinfo-format-French-OE-ligature)
 287 (defun-maybe texinfo-format-French-OE-ligature ()
 288   (insert "OE" (texinfo-parse-arg-discard))
 289   (goto-char texinfo-command-start))
 290
 291 ;; @oe{}        ==>     oe
 292 (put 'oe 'texinfo-format 'texinfo-format-French-oe-ligature)
 293 (defun-maybe texinfo-format-French-oe-ligature () ; lower case
 294   (insert "oe" (texinfo-parse-arg-discard))
 295   (goto-char texinfo-command-start))
 296
 297 ;; @AA{}        ==>     AA      Scandinavian-A-with-circle
 298 (put 'AA 'texinfo-format 'texinfo-format-Scandinavian-A-with-circle)
 299 (defun-maybe texinfo-format-Scandinavian-A-with-circle ()
 300   (insert "AA" (texinfo-parse-arg-discard))
 301   (goto-char texinfo-command-start))
 302
 303 ;; @aa{}        ==>     aa
 304 (put 'aa 'texinfo-format 'texinfo-format-Scandinavian-a-with-circle)
 305 (defun-maybe texinfo-format-Scandinavian-a-with-circle () ; lower case
 306   (insert "aa" (texinfo-parse-arg-discard))
 307   (goto-char texinfo-command-start))
 308
 309 ;; @AE{}        ==>     AE      Latin-Scandinavian-AE
 310 (put 'AE 'texinfo-format 'texinfo-format-Latin-Scandinavian-AE)
 311 (defun-maybe texinfo-format-Latin-Scandinavian-AE ()
 312   (insert "AE" (texinfo-parse-arg-discard))
 313   (goto-char texinfo-command-start))
 314
 315 ;; @ae{}        ==>     ae
 316 (put 'ae 'texinfo-format 'texinfo-format-Latin-Scandinavian-ae)
 317 (defun-maybe texinfo-format-Latin-Scandinavian-ae () ; lower case
 318   (insert "ae" (texinfo-parse-arg-discard))
 319   (goto-char texinfo-command-start))
 320
 321 ;; @ss{}        ==>     ss      German-sharp-S
 322 (put 'ss 'texinfo-format 'texinfo-format-German-sharp-S)
 323 (defun-maybe texinfo-format-German-sharp-S ()
 324   (insert "ss" (texinfo-parse-arg-discard))
 325   (goto-char texinfo-command-start))
 326
 327 ;; @questiondown{}      ==>     ?       upside-down-question-mark
 328 (put 'questiondown 'texinfo-format 'texinfo-format-upside-down-question-mark)
 329 (defun-maybe texinfo-format-upside-down-question-mark ()
 330   (insert "?" (texinfo-parse-arg-discard))
 331   (goto-char texinfo-command-start))
 332
 333 ;; @exclamdown{}        ==>     !       upside-down-exclamation-mark
 334 (put 'exclamdown 'texinfo-format 'texinfo-format-upside-down-exclamation-mark)
 335 (defun-maybe texinfo-format-upside-down-exclamation-mark ()
 336   (insert "!" (texinfo-parse-arg-discard))
 337   (goto-char texinfo-command-start))
 338
 339 ;; @L{}         ==>     L/      Polish suppressed-L (Lslash)
 340 (put 'L 'texinfo-format 'texinfo-format-Polish-suppressed-L)
 341 (defun-maybe texinfo-format-Polish-suppressed-L ()
 342   (insert (texinfo-parse-arg-discard) "/L")
 343   (goto-char texinfo-command-start))
 344
 345 ;; @l{}         ==>     l/      Polish suppressed-L (Lslash) (lower case)
 346 (put 'l 'texinfo-format 'texinfo-format-Polish-suppressed-l-lower-case)
 347 (defun-maybe texinfo-format-Polish-suppressed-l-lower-case ()
 348   (insert (texinfo-parse-arg-discard) "/l")
 349   (goto-char texinfo-command-start))
 350
 351 ;; @O{}         ==>     O/      Scandinavian O-with-slash
 352 (put 'O 'texinfo-format 'texinfo-format-Scandinavian-O-with-slash)
 353 (defun-maybe texinfo-format-Scandinavian-O-with-slash ()
 354   (insert (texinfo-parse-arg-discard) "O/")
 355   (goto-char texinfo-command-start))
 356
 357 ;; @o{}         ==>     o/      Scandinavian O-with-slash (lower case)
 358 (put 'o 'texinfo-format 'texinfo-format-Scandinavian-o-with-slash-lower-case)
 359 (defun-maybe texinfo-format-Scandinavian-o-with-slash-lower-case ()
 360   (insert (texinfo-parse-arg-discard) "o/")
 361   (goto-char texinfo-command-start))
 362
 363 ;; @,{c}        ==>     c,      cedilla accent
 364 (put ', 'texinfo-format 'texinfo-format-cedilla-accent)
 365 (defun-maybe texinfo-format-cedilla-accent ()
 366   (insert (texinfo-parse-arg-discard) ",")
 367   (goto-char texinfo-command-start))
 368
 369
 370 ;; @dotaccent{o}        ==>     .o      overdot-accent
 371 (put 'dotaccent 'texinfo-format 'texinfo-format-overdot-accent)
 372 (defun-maybe texinfo-format-overdot-accent ()
 373   (insert "." (texinfo-parse-arg-discard))
 374   (goto-char texinfo-command-start))
 375
 376 ;; @ubaraccent{o}       ==>     _o      underbar-accent
 377 (put 'ubaraccent 'texinfo-format 'texinfo-format-underbar-accent)
 378 (defun-maybe texinfo-format-underbar-accent ()
 379   (insert "_" (texinfo-parse-arg-discard))
 380   (goto-char texinfo-command-start))
 381
 382 ;; @udotaccent{o}       ==>     o-.     underdot-accent
 383 (put 'udotaccent 'texinfo-format 'texinfo-format-underdot-accent)
 384 (defun-maybe texinfo-format-underdot-accent ()
 385   (insert (texinfo-parse-arg-discard) "-.")
 386   (goto-char texinfo-command-start))
 387
 388 ;; @H{o}        ==>     ""o     long Hungarian umlaut
 389 (put 'H 'texinfo-format 'texinfo-format-long-Hungarian-umlaut)
 390 (defun-maybe texinfo-format-long-Hungarian-umlaut ()
 391   (insert "\"\"" (texinfo-parse-arg-discard))
 392   (goto-char texinfo-command-start))
 393
 394 ;; @ringaccent{o}       ==>     *o      ring accent
 395 (put 'ringaccent 'texinfo-format 'texinfo-format-ring-accent)
 396 (defun-maybe texinfo-format-ring-accent ()
 397   (insert "*" (texinfo-parse-arg-discard))
 398   (goto-char texinfo-command-start))
 399
 400 ;; @tieaccent{oo}       ==>     [oo     tie after accent
 401 (put 'tieaccent 'texinfo-format 'texinfo-format-tie-after-accent)
 402 (defun-maybe texinfo-format-tie-after-accent ()
 403   (insert "[" (texinfo-parse-arg-discard))
 404   (goto-char texinfo-command-start))
 405
 406 ;; @u{o}        ==>     (o      breve accent
 407 (put 'u 'texinfo-format 'texinfo-format-breve-accent)
 408 (defun-maybe texinfo-format-breve-accent ()
 409   (insert "(" (texinfo-parse-arg-discard))
 410   (goto-char texinfo-command-start))
 411
 412 ;; @v{o}        ==>     <o      hacek accent
 413 (put 'v 'texinfo-format 'texinfo-format-hacek-accent)
 414 (defun-maybe texinfo-format-hacek-accent ()
 415   (insert "<" (texinfo-parse-arg-discard))
 416   (goto-char texinfo-command-start))
 417
 418 ;; @dotless{i}  ==>     i       dotless i and dotless j
 419 (put 'dotless 'texinfo-format 'texinfo-format-dotless)
 420 (defun-maybe texinfo-format-dotless ()
 421   (insert (texinfo-parse-arg-discard))
 422   (goto-char texinfo-command-start))
 423
 424
 425 \f
 426 ;;; Cross References
 427 ;; @ref, @xref
 428 (put 'ref 'texinfo-format 'texinfo-format-xref)
 429
 430 (when-broken texinfo-format-xref
 431   (fmakunbound 'texinfo-format-xref))
 432 (defun-maybe texinfo-format-xref ()
 433   (let ((args (texinfo-format-parse-args)))
 434     (texinfo-discard-command)
 435     (insert "*Note ")
 436     (let ((fname (or (nth 1 args) (nth 2 args))))
 437       (if (null (or fname (nth 3 args)))
 438           (insert (nth 0 args) "::")
 439         (insert (or fname (nth 0 args)) ": ")
 440         (if (nth 3 args)
 441             (insert "(" (nth 3 args) ")"))
 442         (unless (null (nth 0 args))
 443           (insert (nth 0 args)))))))
 444
 445 ;; @uref
 446 (put 'uref 'texinfo-format 'texinfo-format-uref)
 447 (when-broken texinfo-format-uref
 448   (fmakunbound 'texinfo-format-uref))
 449 (defun-maybe texinfo-format-uref ()
 450   "Format URL and optional URL-TITLE.
 451 Insert ` ... ' around URL if no URL-TITLE argument;
 452 otherwise, insert URL-TITLE followed by URL in parentheses."
 453   (let ((args (texinfo-format-parse-args)))
 454     (texinfo-discard-command)
 455     ;; if url-title
 456     (if (nth 1 args)
 457         (insert  (nth 1 args) " (" (nth 0 args) ")")
 458       (insert "`" (nth 0 args) "'"))))
 459
 460
 461 \f
 462 ;;; New command definition
 463 ;; @alias NEW=EXISTING
 464 (put 'alias 'texinfo-format 'texinfo-alias)
 465 (defun-maybe texinfo-alias ()
 466   (let ((start (1- (point)))
 467         args)
 468     (skip-chars-forward " ")
 469     (save-excursion (end-of-line) (setq texinfo-command-end (point)))
 470     (if (not (looking-at "\\([^=]+\\)=\\(.*\\)"))
 471         (error "Invalid alias command")
 472       (setq texinfo-alias-list
 473             (cons
 474              (cons
 475               (buffer-substring (match-beginning 1) (match-end 1))
 476               (buffer-substring (match-beginning 2) (match-end 2)))
 477              texinfo-alias-list))
 478       (texinfo-discard-command))))
 479
 480 ;; @definfoenclose NEWCMD, BEFORE, AFTER
 481
 482
 483 \f
 484 ;;; Special
 485 ;; @image{FILENAME, [WIDTH], [HEIGHT]}
 486 (put 'image 'texinfo-format 'texinfo-format-image)
 487 (defun-maybe texinfo-format-image ()
 488   (let ((args (texinfo-format-parse-args)) ; parse FILENAME?
 489         filename)
 490     (when (null (nth 0 args))
 491       (error "Invalid image command"))
 492     (texinfo-discard-command)
 493     ;; makeinfo uses FILENAME.txt
 494     (setq filename (format "%s.txt" (nth 0 args)))
 495     (message "Reading included file: %s" filename)
 496     ;; verbatim for Info output
 497     (goto-char (+ (point) (cadr (insert-file-contents filename))))
 498     (message "Reading included file: %s...done" filename)))
 499
 500
 501 ;; @exampleindent
 502
 503
 504 \f
 505 ;;; @multitable ... @end multitable
 506 (defvar-maybe texinfo-extra-inter-column-width 0
 507   "*Number of extra spaces between entries (columns) in @multitable.")
 508
 509 (defvar-maybe texinfo-multitable-buffer-name "*multitable-temporary-buffer*")
 510 (defvar-maybe texinfo-multitable-rectangle-name "texinfo-multitable-temp-")
 511
 512 ;; These commands are defined in texinfo.tex for printed output.
 513 (put 'multitableparskip 'texinfo-format 'texinfo-discard-line-with-args)
 514 (put 'multitableparindent 'texinfo-format 'texinfo-discard-line-with-args)
 515 (put 'multitablecolmargin 'texinfo-format 'texinfo-discard-line-with-args)
 516 (put 'multitablelinespace 'texinfo-format 'texinfo-discard-line-with-args)
 517
 518 (put 'multitable 'texinfo-format 'texinfo-multitable)
 519
 520 (defun-maybe texinfo-multitable ()
 521   "Produce multi-column tables."
 522
 523 ;; This function pushes information onto the `texinfo-stack'.
 524 ;; A stack element consists of:
 525 ;;   - type-of-command, i.e., multitable
 526 ;;   - the information about column widths, and
 527 ;;   - the position of texinfo-command-start.
 528 ;; e.g., ('multitable (1 2 3 4) 123)
 529 ;; The command line is then deleted.
 530   (texinfo-push-stack
 531    'multitable
 532    ;; push width information on stack
 533    (texinfo-multitable-widths))
 534   (texinfo-discard-line-with-args))
 535
 536 (put 'multitable 'texinfo-end 'texinfo-end-multitable)
 537 (defun-maybe texinfo-end-multitable ()
 538   "Discard the @end multitable line and pop the stack of multitable."
 539   (texinfo-discard-command)
 540   (texinfo-pop-stack 'multitable))
 541
 542 (when-broken texinfo-multitable-widths
 543   (fmakunbound 'texinfo-multitable-widths))
 544
 545 (defun-maybe texinfo-multitable-widths ()
 546   "Return list of widths of each column in a multi-column table."
 547   (let (texinfo-multitable-width-list)
 548     ;; Fractions format:
 549     ;;  @multitable @columnfractions .25 .3 .45
 550     ;;
 551     ;; Template format:
 552     ;;  @multitable {Column 1 template} {Column 2} {Column 3 example}
 553     ;; Place point before first argument
 554     (skip-chars-forward " \t")
 555     (cond
 556      ;; Check for common misspelling
 557      ((looking-at "@columnfraction ")
 558       (error "In @multitable, @columnfractions misspelled"))
 559      ;; Case 1: @columnfractions .25 .3 .45
 560      ((looking-at "@columnfractions")
 561       (forward-word 1)
 562       (while (not (eolp))
 563         (setq texinfo-multitable-width-list
 564               (cons
 565                (truncate
 566                 (1-
 567                  (* fill-column (read (get-buffer (current-buffer))))))
 568                texinfo-multitable-width-list))))
 569      ;;
 570      ;; Case 2: {Column 1 template} {Column 2} {Column 3 example}
 571      ((looking-at "{")
 572       (let ((start-of-templates (point)))
 573         (while (not (eolp))
 574           (skip-chars-forward " \t")
 575           (let* ((start-of-template (1+ (point)))
 576                  (end-of-template
 577                  ;; forward-sexp works with braces in Texinfo mode
 578                   (progn (forward-sexp 1) (1- (point)))))
 579             (setq texinfo-multitable-width-list
 580                   (cons (- (progn (goto-char end-of-template) (current-column))
 581                            (progn (goto-char start-of-template) (current-column)))
 582                         texinfo-multitable-width-list))
 583             ;; Remove carriage return from within a template, if any.
 584             ;; This helps those those who want to use more than
 585             ;; one line's worth of words in @multitable line.
 586             (narrow-to-region start-of-template end-of-template)
 587             (goto-char (point-min))
 588             (while (search-forward "
 589 " nil t)
 590               (delete-char -1))
 591             (goto-char (point-max))
 592             (widen)
 593             (forward-char 1)))))
 594      ;;
 595      ;; Case 3: Trouble
 596      (t
 597       (error
 598        "You probably need to specify column widths for @multitable correctly")))
 599     ;; Check whether columns fit on page.
 600     (let ((desired-columns
 601            (+
 602             ;; between column spaces
 603             (length texinfo-multitable-width-list)
 604             ;; additional between column spaces, if any
 605             texinfo-extra-inter-column-width
 606             ;; sum of spaces for each entry
 607             (apply '+ texinfo-multitable-width-list))))
 608       (if (> desired-columns fill-column)
 609           (error
 610            (format
 611             "Multi-column table width, %d chars, is greater than page width, %d chars."
 612             desired-columns fill-column))))
 613     texinfo-multitable-width-list))
 614
 615 ;; @item  A1  @tab  A2  @tab  A3
 616 (defun-maybe texinfo-multitable-extract-row ()
 617   "Return multitable row, as a string.
 618 End of row is beginning of next @item or beginning of @end.
 619 Cells within rows are separated by @tab."
 620   (skip-chars-forward " \t")
 621   (let* ((start (point))
 622          (end (progn
 623                 (re-search-forward "@item\\|@end")
 624                 (match-beginning 0)))
 625          (row (progn (goto-char end)
 626                      (skip-chars-backward " ")
 627                      ;; remove whitespace at end of argument
 628                      (delete-region (point) end)
 629                      (buffer-substring start (point)))))
 630     (delete-region texinfo-command-start end)
 631     row))
 632
 633 (when-broken texinfo-multitable-item
 634   (fmakunbound 'texinfo-multitable-item))
 635
 636 (put 'multitable 'texinfo-item 'texinfo-multitable-item)
 637 (defun-maybe texinfo-multitable-item ()
 638   "Format a row within a multicolumn table.
 639 Cells in row are separated by @tab.
 640 Widths of cells are specified by the arguments in the @multitable line.
 641 All cells are made to be the same height.
 642 This command is executed when texinfmt sees @item inside @multitable."
 643   (let ((original-buffer (current-buffer))
 644         (table-widths (reverse (car (cdr (car texinfo-stack)))))
 645         (existing-fill-column fill-column)
 646         start
 647         end
 648         (table-column       0)
 649         (table-entry-height 0)
 650         ;; unformatted row looks like:  A1  @tab  A2  @tab  A3
 651         ;; extract-row command deletes the source line in the table.
 652         (unformated-row (texinfo-multitable-extract-row)))
 653     ;; Use a temporary buffer
 654     (set-buffer (get-buffer-create texinfo-multitable-buffer-name))
 655     (delete-region (point-min) (point-max))
 656     (insert unformated-row)
 657     (goto-char (point-min))
 658 ;; 1. Check for correct number of @tab in line.
 659     (let ((tab-number 1))                       ; one @tab between two columns
 660       (while (search-forward "@tab" nil t)
 661         (setq tab-number (1+ tab-number)))
 662       (if (/= tab-number (length table-widths))
 663           (error "Wrong number of @tab's in a @multitable row")))
 664     (goto-char (point-min))
 665 ;; 2. Format each cell, and copy to a rectangle
 666     ;; buffer looks like this:    A1  @tab  A2  @tab  A3
 667     ;; Cell #1: format up to @tab
 668     ;; Cell #2: format up to @tab
 669     ;; Cell #3: format up to eob
 670     (while (not (eobp))
 671       (setq start (point))
 672       (setq end (save-excursion
 673                   (if (search-forward "@tab" nil 'move)
 674                       ;; Delete the @tab command, including the @-sign
 675                       (delete-region
 676                        (point)
 677                        (progn (forward-word -1) (1- (point)))))
 678                   (point)))
 679       ;; Set fill-column *wider* than needed to produce inter-column space
 680       (setq fill-column (+ 1
 681                            texinfo-extra-inter-column-width
 682                            (nth table-column table-widths)))
 683       (narrow-to-region start end)
 684       ;; Remove whitespace before and after entry.
 685       (skip-chars-forward " ")
 686       (delete-region (point) (save-excursion (beginning-of-line) (point)))
 687       (goto-char (point-max))
 688       (skip-chars-backward " ")
 689       (delete-region (point) (save-excursion (end-of-line) (point)))
 690       ;; Temorarily set texinfo-stack to nil so texinfo-format-scan
 691       ;; does not see an unterminated @multitable.
 692       (let (texinfo-stack)                      ; nil
 693         (texinfo-format-scan))
 694       (let (fill-prefix)                        ; no fill prefix
 695         (fill-region (point-min) (point-max)))
 696       (setq table-entry-height
 697             (max table-entry-height (count-lines (point-min) (point-max))))
 698 ;; 3. Move point to end of bottom line, and pad that line to fill column.
 699       (goto-char (point-min))
 700       (forward-line (1- table-entry-height))
 701       (let* ((beg (point))                      ; beginning of line
 702              ;; add one more space for inter-column spacing
 703              (needed-whitespace
 704               (1+
 705                (- fill-column
 706                   (progn (end-of-line) (current-column)))))) ; end of existing line
 707         (insert (make-string
 708                  (if (> needed-whitespace 0) needed-whitespace 1)
 709                  ? )))
 710       ;; now, put formatted cell into a rectangle
 711       (set (intern (concat texinfo-multitable-rectangle-name
 712                            (int-to-string table-column)))
 713            (extract-rectangle (point-min) (point)))
 714       (delete-region (point-min) (point))
 715       (goto-char (point-max))
 716       (setq table-column (1+ table-column))
 717       (widen))
 718 ;; 4. Add extra lines to rectangles so all are of same height
 719     (let ((total-number-of-columns table-column)
 720           (column-number 0)
 721           here)
 722       (while (> table-column 0)
 723         (let ((this-rectangle (int-to-string table-column)))
 724           (while (< (length this-rectangle) table-entry-height)
 725             (setq this-rectangle (append this-rectangle '("")))))
 726         (setq table-column (1- table-column)))
 727 ;; 5. Insert formatted rectangles in original buffer
 728       (switch-to-buffer original-buffer)
 729       (open-line table-entry-height)
 730       (while (< column-number total-number-of-columns)
 731         (setq here (point))
 732         (insert-rectangle
 733          (eval (intern
 734                 (concat texinfo-multitable-rectangle-name
 735                         (int-to-string column-number)))))
 736         (goto-char here)
 737         (end-of-line)
 738         (setq column-number (1+ column-number))))
 739     (kill-buffer texinfo-multitable-buffer-name)
 740     (setq fill-column existing-fill-column)))
 741
 742 \f
 743 (when-broken texinfo-format-printindex
 744   (fmakunbound 'texinfo-format-printindex))
 745
 746 (defun-maybe texinfo-format-printindex ()
 747   (let ((indexelts (symbol-value
 748                     (cdr (assoc (texinfo-parse-arg-discard)
 749                                 texinfo-indexvar-alist))))
 750         opoint)
 751     (insert "\n* Menu:\n\n")
 752     (setq opoint (point))
 753     (texinfo-print-index nil indexelts)
 754
 755     (if (memq system-type '(vax-vms windows-nt ms-dos))
 756         (texinfo-sort-region opoint (point))
 757       (shell-command-on-region opoint (point) "sort -fd" 1))))
 758
 759 ;;; ptexinfmt.el ends here