contrib/lisp/ox-groff.el

   1 ;;; ox-groff.el --- Groff Back-End for Org Export Engine
   2
   3 ;; Copyright (C) 2011-2014  Free Software Foundation, Inc.
   4
   5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
   6 ;; Author: Luis R Anaya <papoanaya aroba hot mail punto com>
   7 ;; Keywords: outlines, hypermedia, calendar, wp
   8
   9 ;; This file is not part of GNU Emacs.
  10
  11 ;; This program 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.
  15
  16 ;; This program 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.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23 ;;; Commentary:
  24 ;;
  25 ;; This library implements a Groff Memorandum Macro back-end for Org
  26 ;; generic exporter.
  27 ;;
  28 ;; To test it, run
  29 ;;
  30 ;;   M-: (org-export-to-buffer 'groff "*Test Groff*") RET
  31 ;;
  32 ;; in an org-mode buffer then switch to the buffer to see the Groff
  33 ;; export.  See ox.el for more details on how this exporter works.
  34 ;;
  35 ;; It introduces two new buffer keywords: "GROFF_CLASS" and
  36 ;; "GROFF_CLASS_OPTIONS".
  37
  38 ;;; Code:
  39
  40 (eval-when-compile (require 'cl))
  41 (require 'ox)
  42
  43 (defvar orgtbl-exp-regexp)
  44
  45 \f
  46 ;;; Define Back-End
  47
  48 (org-export-define-backend 'groff
  49   '((bold . org-groff-bold)
  50     (center-block . org-groff-center-block)
  51     (clock . org-groff-clock)
  52     (code . org-groff-code)
  53     (comment . (lambda (&rest args) ""))
  54     (comment-block . (lambda (&rest args) ""))
  55     (drawer . org-groff-drawer)
  56     (dynamic-block . org-groff-dynamic-block)
  57     (entity . org-groff-entity)
  58     (example-block . org-groff-example-block)
  59     (export-block . org-groff-export-block)
  60     (export-snippet . org-groff-export-snippet)
  61     (fixed-width . org-groff-fixed-width)
  62     (footnote-definition . org-groff-footnote-definition)
  63     (footnote-reference . org-groff-footnote-reference)
  64     (headline . org-groff-headline)
  65     (horizontal-rule . org-groff-horizontal-rule)
  66     (inline-src-block . org-groff-inline-src-block)
  67     (inlinetask . org-groff-inlinetask)
  68     (italic . org-groff-italic)
  69     (item . org-groff-item)
  70     (keyword . org-groff-keyword)
  71     (line-break . org-groff-line-break)
  72     (link . org-groff-link)
  73     (paragraph . org-groff-paragraph)
  74     (plain-list . org-groff-plain-list)
  75     (plain-text . org-groff-plain-text)
  76     (planning . org-groff-planning)
  77     (property-drawer . (lambda (&rest args) ""))
  78     (quote-block . org-groff-quote-block)
  79     (quote-section . org-groff-quote-section)
  80     (radio-target . org-groff-radio-target)
  81     (section . org-groff-section)
  82     (special-block . org-groff-special-block)
  83     (src-block . org-groff-src-block)
  84     (statistics-cookie . org-groff-statistics-cookie)
  85     (strike-through . org-groff-strike-through)
  86     (subscript . org-groff-subscript)
  87     (superscript . org-groff-superscript)
  88     (table . org-groff-table)
  89     (table-cell . org-groff-table-cell)
  90     (table-row . org-groff-table-row)
  91     (target . org-groff-target)
  92     (template . org-groff-template)
  93     (timestamp . org-groff-timestamp)
  94     (underline . org-groff-underline)
  95     (verbatim . org-groff-verbatim)
  96     (verse-block . org-groff-verse-block))
  97   :export-block "GROFF"
  98   :menu-entry
  99   '(?g "Export to GROFF"
 100        ((?g "As GROFF file" org-groff-export-to-groff)
 101         (?p "As PDF file" org-groff-export-to-pdf)
 102         (?o "As PDF file and open"
 103             (lambda (a s v b)
 104               (if a (org-groff-export-to-pdf t s v b)
 105                 (org-open-file (org-groff-export-to-pdf nil s v b)))))))
 106   :options-alist
 107   '((:groff-class "GROFF_CLASS" nil org-groff-default-class t)
 108     (:groff-class-options "GROFF_CLASS_OPTIONS" nil nil t)
 109     (:groff-header-extra "GROFF_HEADER" nil nil newline)))
 110
 111
 112 \f
 113 ;;; User Configurable Variables
 114
 115 (defgroup org-export-groff nil
 116   "Options for exporting Org mode files to Groff."
 117   :tag "Org Export Groff"
 118   :group 'org-export)
 119
 120 ;;; Preamble
 121
 122 (defcustom org-groff-default-class "internal"
 123   "The default Groff class."
 124   :group 'org-export-groff
 125   :type '(string :tag "Groff class"))
 126
 127 (defcustom org-groff-classes
 128   '(("file" ".MT 1"
 129      (:heading 'default :type "memo" :last-section "toc"))
 130     ("internal" ".MT 0"
 131      (:heading 'default :type "memo" :last-section "toc"))
 132     ("programmer" ".MT 2"
 133      (:heading 'default :type "memo" :last-section "toc"))
 134     ("engineer" ".MT 3"
 135      (:heading 'default :type "memo" :last-section "toc"))
 136     ("external" ".MT 4"
 137      (:heading 'default :type "memo" :last-section "toc"))
 138     ("letter" ".MT 5"
 139      (:heading 'default :type "memo" :last-section "sign"))
 140     ("custom" ".so file"
 141      (:heading custom-function :type "custom" :last-section "toc"))
 142     ("dummy" ""
 143      (:heading 'default :type "memo"))
 144     ("ms" "ms"
 145      (:heading 'default :type "cover" :last-section "toc"))
 146     ("se_ms" "se_ms"
 147      (:heading 'default :type "cover" :last-section "toc"))
 148     ("block" "BL"
 149      (:heading 'default :type "letter" :last-section "sign"))
 150     ("semiblock" "SB"
 151      (:heading 'default :type "letter" :last-section "sign"))
 152     ("fullblock" "FB"
 153      (:heading 'default :type "letter" :last-section "sign"))
 154     ("simplified" "SP"
 155      (:heading 'default :type "letter" :last-section "sign"))
 156     ("none" "" (:heading 'default :type "custom")))
 157
 158   ;; none means, no Cover or Memorandum Type and no calls to AU, AT, ND and TL
 159   ;; This is to facilitate the creation of custom pages.
 160
 161   ;; dummy means, no Cover or Memorandum Type but calls to AU, AT, ND and TL
 162   ;; are made. This is to facilitate Abstract Insertion.
 163
 164   "This list describes the attributes for the documents being created.
 165    It allows for the creation of new "
 166   :group 'org-export-groff
 167   :type '(repeat
 168           (list (string :tag "Document Type")
 169                 (string :tag "Header")
 170                 (repeat :tag "Options" :inline t
 171                         (choice
 172                          (list :tag "Heading")
 173                          (function :tag "Hook computing sectioning"))))))
 174
 175 ;;; Headline
 176
 177 (defconst org-groff-special-tags
 178   '("FROM" "TO" "ABSTRACT" "APPENDIX" "BODY" "NS"))
 179
 180 (defcustom org-groff-format-headline-function nil
 181   "Function to format headline text.
 182
 183 This function will be called with 5 arguments:
 184 TODO      the todo keyword (string or nil).
 185 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
 186 PRIORITY  the priority of the headline (integer or nil)
 187 TEXT      the main headline text (string).
 188 TAGS      the tags as a list of strings (list of strings or nil).
 189
 190 The function result will be used in the section format string.
 191
 192 As an example, one could set the variable to the following, in
 193 order to reproduce the default set-up:
 194
 195 \(defun org-groff-format-headline (todo todo-type priority text tags)
 196   \"Default format function for a headline.\"
 197   \(concat (when todo
 198             \(format \"\\fB%s\\fP \" todo))
 199           \(when priority
 200             \(format \"[\\#%c] \" priority))
 201           text
 202           \(when tags
 203             \(format \" %s \"
 204               \(mapconcat 'identity tags \":\"))))"
 205   :group 'org-export-groff
 206   :type 'function)
 207
 208 ;;; Timestamps
 209
 210 (defcustom org-groff-active-timestamp-format "\\fI%s\\fP"
 211   "A printf format string to be applied to active timestamps."
 212   :group 'org-export-groff
 213   :type 'string)
 214
 215 (defcustom org-groff-inactive-timestamp-format "\\fI%s\\fP"
 216   "A printf format string to be applied to inactive timestamps."
 217   :group 'org-export-groff
 218   :type 'string)
 219
 220 (defcustom org-groff-diary-timestamp-format "\\fI%s\\fP"
 221   "A printf format string to be applied to diary timestamps."
 222   :group 'org-export-groff
 223   :type 'string)
 224
 225 ;;; Links
 226
 227 (defcustom org-groff-inline-image-rules
 228   '(("file" . "\\.\\(jpg\\|png\\|pdf\\|ps\\|eps\\|pic\\)\\'")
 229     ("fuzzy" . "\\.\\(jpg\\|png\\|pdf\\|ps\\|eps\\|pic\\)\\'"))
 230   "Rules characterizing image files that can be inlined into Groff.
 231
 232 A rule consists in an association whose key is the type of link
 233 to consider, and value is a regexp that will be matched against
 234 link's path.
 235
 236 Note that, by default, the image extensions actually allowed
 237 depend on the way the Groff file is processed.  When used with
 238 pdfgroff, pdf, jpg and png images are OK.  When processing
 239 through dvi to Postscript, only ps and eps are allowed.  The
 240 default we use here encompasses both."
 241   :group 'org-export-groff
 242   :type '(alist :key-type (string :tag "Type")
 243                 :value-type (regexp :tag "Path")))
 244
 245 (defcustom org-groff-link-with-unknown-path-format "\\fI%s\\fP"
 246   "Format string for links with unknown path type."
 247   :group 'org-export-groff
 248   :type 'string)
 249
 250 ;;; Tables
 251
 252 (defcustom org-groff-tables-centered t
 253   "When non-nil, tables are exported in a center environment."
 254   :group 'org-export-groff
 255   :type 'boolean)
 256
 257 (defcustom org-groff-tables-verbatim nil
 258   "When non-nil, tables are exported verbatim."
 259   :group 'org-export-groff
 260   :type 'boolean)
 261
 262 (defcustom org-groff-table-scientific-notation "%sE%s"
 263   "Format string to display numbers in scientific notation.
 264 The format should have \"%s\" twice, for mantissa and exponent
 265 \(i.e. \"%s\\\\times10^{%s}\").
 266
 267 When nil, no transformation is made."
 268   :group 'org-export-groff
 269   :type '(choice
 270           (string :tag "Format string")
 271           (const :tag "No formatting")))
 272
 273 ;;; Text markup
 274
 275 (defcustom org-groff-text-markup-alist
 276    '((bold . "\\fB%s\\fP")
 277     (code . "\\fC%s\\fP")
 278     (italic . "\\fI%s\\fP")
 279     (strike-through . "\\fC%s\\fP")  ; Strike through and underline
 280     (underline . "\\fI%s\\fP")       ; need to be revised.
 281     (verbatim .   "protectedtexttt"))
 282   "Alist of Groff expressions to convert text markup.
 283
 284 The key must be a symbol among `bold', `code', `italic',
 285 `strike-through', `underline' and `verbatim'.  The value is
 286 a formatting string to wrap fontified text with it.
 287
 288 If no association can be found for a given markup, text will be
 289 returned as-is."
 290   :group 'org-export-groff
 291   :type 'alist
 292   :options '(bold code italic strike-through underline verbatim))
 293
 294 ;;; Drawers
 295
 296 (defcustom org-groff-format-drawer-function nil
 297   "Function called to format a drawer in Groff code.
 298
 299 The function must accept two parameters:
 300   NAME      the drawer name, like \"LOGBOOK\"
 301   CONTENTS  the contents of the drawer.
 302
 303 The function should return the string to be exported.
 304
 305 For example, the variable could be set to the following function
 306 in order to mimic default behaviour:
 307
 308 \(defun org-groff-format-drawer-default \(name contents\)
 309   \"Format a drawer element for Groff export.\"
 310   contents\)"
 311   :group 'org-export-groff
 312   :type 'function)
 313
 314 ;;; Inlinetasks
 315
 316 (defcustom org-groff-format-inlinetask-function nil
 317   "Function called to format an inlinetask in Groff code.
 318
 319 The function must accept six parameters:
 320   TODO      the todo keyword, as a string
 321   TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
 322   PRIORITY  the inlinetask priority, as a string
 323   NAME      the inlinetask name, as a string.
 324   TAGS      the inlinetask tags, as a list of strings.
 325   CONTENTS  the contents of the inlinetask, as a string.
 326
 327 The function should return the string to be exported.
 328
 329 For example, the variable could be set to the following function
 330 in order to mimic default behaviour:
 331
 332 \(defun org-groff-format-inlinetask \(todo type priority name tags contents\)
 333 \"Format an inline task element for Groff export.\"
 334   \(let ((full-title
 335          \(concat
 336           \(when todo
 337             \(format \"\\fB%s\\fP \" todo))
 338           \(when priority (format \"[\\#%c] \" priority))
 339           title
 340           \(when tags
 341             \(format \":%s:\"
 342                     \(mapconcat 'identity tags \":\")))))
 343     \(format (concat \".DS L\\n\"
 344                     \"%s\\n\\n\"
 345                     \"%s\"
 346                     \".DE\")
 347             full-title contents))"
 348   :group 'org-export-groff
 349   :type 'function)
 350
 351 ;; Src blocks
 352
 353 (defcustom org-groff-source-highlight nil
 354   "Use GNU source highlight to embellish source blocks "
 355   :group 'org-export-groff
 356   :type 'boolean)
 357
 358 (defcustom org-groff-source-highlight-langs
 359   '((emacs-lisp "lisp") (lisp "lisp") (clojure "lisp")
 360     (scheme "scheme")
 361     (c "c") (cc "cpp") (csharp "csharp") (d "d")
 362     (fortran "fortran") (cobol "cobol") (pascal "pascal")
 363     (ada "ada") (asm "asm")
 364     (perl "perl") (cperl "perl")
 365     (python "python") (ruby "ruby") (tcl "tcl") (lua "lua")
 366     (java "java") (javascript "javascript")
 367     (tex "latex")
 368     (shell-script "sh") (awk "awk") (diff "diff") (m4 "m4")
 369     (ocaml "caml") (caml "caml")
 370     (sql "sql") (sqlite "sql")
 371     (html "html") (css "css") (xml "xml")
 372     (bat "bat") (bison "bison") (clipper "clipper")
 373     (ldap "ldap") (opa "opa")
 374     (php "php") (postscript "postscript") (prolog "prolog")
 375     (properties "properties") (makefile "makefile")
 376     (tml "tml") (vala "vala") (vbscript "vbscript") (xorg "xorg"))
 377   "Alist mapping languages to their listing language counterpart.
 378 The key is a symbol, the major mode symbol without the \"-mode\".
 379 The value is the string that should be inserted as the language
 380 parameter for the listings package.  If the mode name and the
 381 listings name are the same, the language does not need an entry
 382 in this list - but it does not hurt if it is present."
 383   :group 'org-export-groff
 384   :type '(repeat
 385           (list
 386            (symbol :tag "Major mode       ")
 387            (string :tag "Listings language"))))
 388
 389 (defcustom org-groff-source-highlight-options nil
 390   "Association list of options for the groff listings package.
 391
 392 These options are supplied as a comma-separated list to the
 393 \\lstset command.  Each element of the association list should be
 394 a list containing two strings: the name of the option, and the
 395 value.  For example,
 396
 397   (setq org-groff-source-highlight-options
 398     '((\"basicstyle\" \"\\small\")
 399       (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
 400
 401 will typeset the code in a small size font with underlined, bold
 402 black keywords.
 403
 404 Note that the same options will be applied to blocks of all
 405 languages."
 406   :group 'org-export-groff
 407   :type '(repeat
 408           (list
 409            (string :tag "Listings option name ")
 410            (string :tag "Listings option value"))))
 411
 412 (defvar org-groff-custom-lang-environments nil
 413   "Alist mapping languages to language-specific Groff environments.
 414
 415 It is used during export of src blocks by the listings and
 416 groff packages.  For example,
 417
 418   \(setq org-groff-custom-lang-environments
 419      '\(\(python \"pythoncode\"\)\)\)
 420
 421 would have the effect that if org encounters begin_src python
 422 during groff export it will use pythoncode as the source-highlight
 423 language.")
 424
 425 ;;; Plain text
 426
 427 (defcustom org-groff-special-char
 428   '(("(c)" . "\\\\(co")
 429     ("(tm)" . "\\\\(tm")
 430     ("(rg)" . "\\\\(rg"))
 431   "CONS list in which the value of the car
 432   is replace on the value of the CDR. "
 433   :group 'org-export-groff
 434   :type '(list
 435           (cons :tag "Character Subtitute"
 436                 (string :tag "Original Character Group")
 437                 (string :tag "Replacement Character"))))
 438
 439 ;;; Compilation
 440
 441 (defcustom org-groff-pdf-process
 442   '("pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"
 443     "pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"
 444     "pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf")
 445
 446   "Commands to process a Groff file to a PDF file.
 447 This is a list of strings, each of them will be given to the
 448 shell as a command.  %f in the command will be replaced by the
 449 full file name, %b by the file base name \(i.e. without
 450 extension) and %o by the base directory of the file."
 451   :group 'org-export-pdf
 452   :type '(choice
 453           (repeat :tag "Shell command sequence"
 454                   (string :tag "Shell command"))
 455           (const :tag "2 runs of pdfgroff"
 456                  ("pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"
 457                   "pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"))
 458           (const :tag "3 runs of pdfgroff"
 459                  ("pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"
 460                   "pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"
 461                   "pic %f | tbl | eqn | groff -mm | ps2pdf - > %b.pdf"))
 462           (function)))
 463
 464 (defcustom org-groff-logfiles-extensions
 465   '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
 466   "The list of file extensions to consider as Groff logfiles."
 467   :group 'org-export-groff
 468   :type '(repeat (string :tag "Extension")))
 469
 470 (defcustom org-groff-remove-logfiles t
 471   "Non-nil means remove the logfiles produced by PDF production.
 472 These are the .aux, .log, .out, and .toc files."
 473   :group 'org-export-groff
 474   :type 'boolean)
 475
 476 (defcustom org-groff-organization "Org User"
 477   "Name of the organization used to populate the .AF command."
 478   :group 'org-export-groff
 479   :type 'string)
 480
 481 (defcustom org-groff-raster-to-ps nil
 482   "Command used to convert raster to EPS. Nil for no conversion. Make sure that
 483    `org-groff-inline-image-rules' is adjusted accordingly if not conversion is being
 484    done. In this case, remove the entries for jpg and png in the file and fuzzy lists."
 485   :group 'org-export-groff
 486   :type '(choice
 487          (repeat :tag "Shell Command Sequence" (string :tag "Shell Command"))
 488          (const :tag "sam2p" "a=%s;b=%s;sam2p ${a} ${b} ;grep -v BeginData ${b} > b_${b};mv b_${b} ${b}" )
 489          (const :tag "NetPNM"  "a=%s;b=%s;pngtopnm ${a} | pnmtops -noturn > ${b}" )
 490          (const :tag "None" nil)))
 491
 492 (defvar org-groff-registered-references nil)
 493 (defvar org-groff-special-content nil)
 494
 495
 496 \f
 497 ;;; Internal Functions
 498
 499 (defun org-groff--caption/label-string (element info)
 500   "Return caption and label Groff string for ELEMENT.
 501
 502 INFO is a plist holding contextual information.  If there's no
 503 caption nor label, return the empty string.
 504
 505 For non-floats, see `org-groff--wrap-label'."
 506   (let ((main (org-export-get-caption element))
 507         (short (org-export-get-caption element t))
 508         (label (org-element-property :name element)))
 509     (cond ((and (not main) (not label)) "")
 510           ((not main) (format "\\fI%s\\fP" label))
 511           ;; Option caption format with short name.
 512           (short (format "%s\n.br\n - %s\n"
 513                          (org-export-data short info)
 514                          (org-export-data main info)))
 515           ;; Standard caption format.
 516           (t (format "\\fR%s\\fP" (org-export-data main info))))))
 517
 518 (defun org-groff--wrap-label (element output)
 519   "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
 520 This function shouldn't be used for floats.  See
 521 `org-groff--caption/label-string'."
 522   (let ((label (org-element-property :name element)))
 523     (if (or (not output) (not label) (string= output "") (string= label ""))
 524         output
 525       (concat (format "%s\n.br\n" label) output))))
 526
 527 (defun org-groff--text-markup (text markup)
 528   "Format TEXT depending on MARKUP text markup.
 529 See `org-groff-text-markup-alist' for details."
 530   (let ((fmt (cdr (assq markup org-groff-text-markup-alist))))
 531     (cond
 532      ;; No format string: Return raw text.
 533      ((not fmt) text)
 534      ((string= "protectedtexttt" fmt)
 535       (let ((start 0)
 536             (trans '(("\\" . "\\")))
 537             (rtn "")
 538             char)
 539         (while (string-match "[\\{}$%&_#~^]" text)
 540           (setq char (match-string 0 text))
 541           (if (> (match-beginning 0) 0)
 542               (setq rtn (concat rtn (substring text 0 (match-beginning 0)))))
 543           (setq text (substring text (1+ (match-beginning 0))))
 544           (setq char (or (cdr (assoc char trans)) (concat "\\" char))
 545                 rtn (concat rtn char)))
 546         (setq text (concat rtn text))
 547         (format "\\fC%s\\fP" text)))
 548      ;; Else use format string.
 549      (t (format fmt text)))))
 550
 551
 552 (defun org-groff--get-tagged-content  (tag info)
 553   (cdr  (assoc tag org-groff-special-content)))
 554
 555 (defun org-groff--mt-head (title contents attr info)
 556   (concat
 557
 558    ;; 1. Insert Organization
 559    (let ((firm-option (plist-get attr :firm)))
 560      (cond
 561       ((stringp firm-option)
 562        (format ".AF \"%s\" \n" firm-option))
 563       (t (format ".AF \"%s\" \n" (or org-groff-organization "")))))
 564
 565    ;; 2. Title
 566    (let ((subtitle1 (plist-get attr :subtitle1))
 567          (subtitle2 (plist-get attr :subtitle2)))
 568
 569      (cond
 570       ((string= "" title)
 571        (format ".TL \"%s\" \"%s\" \n%s\n"
 572                (or subtitle1 "")
 573                (or subtitle2 "") " "))
 574
 575       ((not (or subtitle1 subtitle2))
 576        (format ".TL\n%s\n"
 577                (or title "")))
 578       (t
 579        (format ".TL \"%s\" \"%s \" \n%s\n"
 580                (or subtitle1 "")
 581                (or subtitle2 "") title))))
 582
 583    ;; 3. Author.
 584    ;; In Groff, .AU *MUST* be placed after .TL
 585    ;; If From, populate with data from From else
 586    ;;
 587    (let ((author (and (plist-get info :with-author)
 588                       (let ((auth (plist-get info :author)))
 589                         (and auth (org-export-data auth info)))))
 590          (email (and (plist-get info :with-email)
 591                      (org-export-data (plist-get info :email) info)))
 592          (from-data  (org-groff--get-tagged-content "FROM" info))
 593
 594          (to-data  (org-groff--get-tagged-content "TO" info)))
 595
 596      (cond
 597       ((and author from-data)
 598        (let ((au-line
 599               (mapconcat
 600                (lambda (from-line)
 601                  (format " \"%s\" " from-line))
 602                (split-string
 603                 (setq from-data
 604                       (replace-regexp-in-string "\\.P\n" "" from-data)) "\n") "")))
 605
 606          (concat
 607           (format ".AU \"%s\" " author) au-line "\n")))
 608
 609       ((and author email (not (string= "" email)))
 610        (format ".AU \"%s\" \"%s\"\n" author email))
 611
 612       (author (format ".AU \"%s\"\n" author))
 613
 614       (t ".AU \"\" \n")))
 615
 616
 617    ;; 4. Author Title, if present
 618    (let ((at-item (plist-get attr :author-title)))
 619      (if (and at-item (stringp at-item))
 620          (format ".AT \"%s\" \n" at-item)
 621        ""))
 622
 623    ;; 5. Date.
 624    (when (plist-get info :with-date)
 625      (let ((date (org-export-data (org-export-get-date info) info)))
 626        (and (org-string-nw-p date) (format ".ND \"%s\"\n" date))))
 627
 628    ;;
 629    ;; If Abstract, then Populate Abstract
 630    ;;
 631
 632    (let ((abstract-data (org-groff--get-tagged-content "ABSTRACT" info))
 633          (to-data (org-groff--get-tagged-content "TO" info)))
 634      (cond
 635       (abstract-data
 636        (format ".AS\n%s\n.AE\n" abstract-data))
 637       (to-data
 638        (format ".AS\n%s\n.AE\n" to-data))))))
 639
 640 (defun org-groff--letter-head (title contents attr info)
 641   (let ((author (and (plist-get info :with-author)
 642                      (let ((auth (plist-get info :author)))
 643                        (and auth (org-export-data auth info)))))
 644         (email (and (plist-get info :with-email)
 645                     (org-export-data (plist-get info :email) info)))
 646         (from-data  (org-groff--get-tagged-content "FROM" info))
 647         (at-item (plist-get attr :author-title))
 648         (to-data  (org-groff--get-tagged-content "TO" info)))
 649
 650
 651     ;; If FROM then get data from FROM
 652     (if from-data
 653         (setq from-data
 654               (replace-regexp-in-string "\\.P\n" "" from-data))
 655       (setq from-data ""))
 656
 657     (if to-data
 658         (setq to-data
 659               (replace-regexp-in-string "\\.P\n" "" to-data))
 660       (setq from-data ""))
 661
 662     (concat
 663      (cond
 664       (from-data
 665        (format ".WA \"%s\" \"%s\" \n%s\n.WE\n" author (or at-item "") from-data))
 666       ((and author email (not (string= "" email)))
 667        (format ".WA \"%s\"\n \"%s\"\n.WE\n" author email))
 668       (author (format ".WA \"%s\"\n.WE\n" author))
 669       (t ".WA \"\" \n.WE\n"))
 670
 671      ;; If TO then get data from TO
 672
 673      (when to-data
 674        (format ".IA \n%s\n.IE\n" to-data)))))
 675
 676 \f
 677 ;;; Template
 678
 679 (defun org-groff-template (contents info)
 680   "Return complete document string after Groff conversion.
 681 CONTENTS is the transcoded contents string.  INFO is a plist
 682 holding export options."
 683   (let* ((title (org-export-data (plist-get info :title) info))
 684          (attr (read
 685                 (format "(%s)"
 686                         (mapconcat
 687                          #'identity
 688                          (list (plist-get info :groff-class-options))
 689                          " "))))
 690          (class (plist-get info :groff-class))
 691          (class-options (plist-get info :groff-class-options))
 692          (classes (assoc class org-groff-classes))
 693          (classes-options (car (last classes)))
 694          (heading-option (plist-get classes-options :heading))
 695          (type-option (plist-get classes-options :type))
 696          (last-option (plist-get classes-options :last-section))
 697          (hyphenate (plist-get attr :hyphenate))
 698          (justify-right (plist-get attr :justify-right))
 699
 700          (document-class-string
 701           (progn
 702             (org-element-normalize-string
 703              (let* ((header (nth 1 (assoc class org-groff-classes)))
 704                     (document-class-item (if (stringp header) header "")))
 705                document-class-item)))))
 706
 707
 708     (concat
 709      (if justify-right
 710          (case justify-right
 711            ('yes ".SA 1 \n")
 712            ('no ".SA 0 \n")
 713            (t ""))
 714        "")
 715
 716      (if hyphenate
 717          (case hyphenate
 718            ('yes ".nr Hy 1 \n")
 719            ('no ".nr Hy 0 \n")
 720            (t ""))
 721        "")
 722
 723      (cond
 724       ((string= type-option "custom") "")
 725
 726       ((and (stringp document-class-string)
 727             (string= type-option "cover"))
 728
 729        (concat
 730         (format ".COVER %s\n" document-class-string)
 731         (org-groff--mt-head title contents attr info)
 732         ".COVEND\n"))
 733
 734       ((string= type-option "memo")
 735        (concat
 736         (org-groff--mt-head title contents attr info)
 737         document-class-string))
 738       ((string= type-option "letter")
 739        (concat
 740         (org-groff--letter-head title contents attr info)
 741         (let ((sa-item (plist-get attr :salutation))
 742               (cn-item (plist-get attr :confidential))
 743               (sj-item (plist-get attr :subject))
 744               (rn-item (plist-get attr :reference))
 745               (at-item (plist-get attr :attention)))
 746
 747           (concat
 748
 749            (if (stringp sa-item)
 750                (format ".LO SA \"%s\" \n"  sa-item)
 751              ".LO SA\n")
 752
 753            (when cn-item
 754              (if (stringp cn-item)
 755                  (format ".LO CN \"%s\"\n" cn-item)
 756                ".LO CN\n"))
 757
 758            (when (and at-item (stringp at-item))
 759              (format ".LO AT \"%s\" \n"  at-item))
 760            (when (and title rn-item)
 761              (format ".LO RN \"%s\"\n" title))
 762
 763            (when (and sj-item (stringp sj-item))
 764              (format ".LO SJ \"%s\" \n"  sj-item))
 765
 766
 767            ".LT " document-class-string  "\n"))))
 768
 769       (t ""))
 770
 771      contents
 772
 773      (cond
 774       ((string= last-option "toc")
 775        ".TC")
 776       ((string= last-option "sign")
 777        (let ((fc-item (plist-get attr :closing)))
 778          (concat (if (stringp fc-item)
 779                      (format ".FC \"%s\" \n" fc-item)
 780                    ".FC\n")
 781                  ".SG\n")))
 782       (t ""))
 783
 784      (progn
 785        (mapconcat
 786         (lambda (item)
 787           (when (string= (car item) "NS")
 788             (replace-regexp-in-string
 789                     "\\.P\n" "" (cdr item))))
 790         (reverse org-groff-special-content) "\n")))))
 791
 792
 793 \f
 794 ;;; Transcode Functions
 795
 796 ;;; Babel Call
 797 ;;
 798 ;; Babel Calls are ignored.
 799
 800
 801 ;;; Bold
 802
 803 (defun org-groff-bold (bold contents info)
 804   "Transcode BOLD from Org to Groff.
 805 CONTENTS is the text with bold markup.  INFO is a plist holding
 806 contextual information."
 807   (org-groff--text-markup contents 'bold))
 808
 809 ;;; Center Block
 810
 811 (defun org-groff-center-block (center-block contents info)
 812   "Transcode a CENTER-BLOCK element from Org to Groff.
 813 CONTENTS holds the contents of the center block.  INFO is a plist
 814 holding contextual information."
 815   (org-groff--wrap-label
 816    center-block
 817    (format ".DS C \n%s\n.DE" contents)))
 818
 819 ;;; Clock
 820
 821 (defun org-groff-clock (clock contents info)
 822   "Transcode a CLOCK element from Org to Groff.
 823 CONTENTS is nil.  INFO is a plist holding contextual
 824 information."
 825   (concat
 826    (format "\\fB%s\\fP " org-clock-string)
 827    (format org-groff-inactive-timestamp-format
 828            (concat (org-translate-time
 829                     (org-element-property :raw-value
 830                                           (org-element-property :value clock)))
 831                    (let ((time (org-element-property :duration clock)))
 832                      (and time (format " (%s)" time)))))))
 833
 834 ;;; Code
 835
 836 (defun org-groff-code (code contents info)
 837   "Transcode a CODE object from Org to Groff.
 838 CONTENTS is nil.  INFO is a plist used as a communication
 839 channel."
 840   (org-groff--text-markup (org-element-property :value code) 'code))
 841
 842 ;;; Comments and Comment Blocks are ignored.
 843
 844 ;;; Drawer
 845
 846 (defun org-groff-drawer (drawer contents info)
 847   "Transcode a DRAWER element from Org to Groff.
 848 CONTENTS holds the contents of the block.  INFO is a plist
 849 holding contextual information."
 850   (let* ((name (org-element-property :drawer-name drawer))
 851          (output (if (functionp org-groff-format-drawer-function)
 852                      (funcall org-groff-format-drawer-function
 853                               name contents)
 854                    ;; If there's no user defined function: simply
 855                    ;; display contents of the drawer.
 856                    contents)))
 857     (org-groff--wrap-label drawer output)))
 858
 859 ;;; Dynamic Block
 860
 861 (defun org-groff-dynamic-block (dynamic-block contents info)
 862   "Transcode a DYNAMIC-BLOCK element from Org to Groff.
 863 CONTENTS holds the contents of the block.  INFO is a plist
 864 holding contextual information.  See `org-export-data'."
 865   (org-groff--wrap-label dynamic-block contents))
 866
 867 ;;; Entity
 868
 869 (defun org-groff-entity (entity contents info)
 870   "Transcode an ENTITY object from Org to Groff.
 871 CONTENTS are the definition itself.  INFO is a plist holding
 872 contextual information."
 873   (org-element-property :utf-8 entity))
 874
 875 ;;; Example Block
 876
 877 (defun org-groff-example-block (example-block contents info)
 878   "Transcode an EXAMPLE-BLOCK element from Org to Groff.
 879 CONTENTS is nil.  INFO is a plist holding contextual
 880 information."
 881   (org-groff--wrap-label
 882    example-block
 883    (format ".DS L\n%s\n.DE"
 884            (org-export-format-code-default example-block info))))
 885
 886 ;;; Export Block
 887
 888 (defun org-groff-export-block (export-block contents info)
 889   "Transcode a EXPORT-BLOCK element from Org to Groff.
 890 CONTENTS is nil.  INFO is a plist holding contextual information."
 891   (when (string= (org-element-property :type export-block) "GROFF")
 892     (org-remove-indentation (org-element-property :value export-block))))
 893
 894 ;;; Export Snippet
 895
 896 (defun org-groff-export-snippet (export-snippet contents info)
 897   "Transcode a EXPORT-SNIPPET object from Org to Groff.
 898 CONTENTS is nil.  INFO is a plist holding contextual information."
 899   (when (eq (org-export-snippet-backend export-snippet) 'groff)
 900     (org-element-property :value export-snippet)))
 901
 902 ;;; Fixed Width
 903
 904 (defun org-groff-fixed-width (fixed-width contents info)
 905   "Transcode a FIXED-WIDTH element from Org to Groff.
 906 CONTENTS is nil.  INFO is a plist holding contextual information."
 907   (org-groff--wrap-label
 908    fixed-width
 909    (format "\\fC\n%s\\fP"
 910            (org-remove-indentation
 911             (org-element-property :value fixed-width)))))
 912
 913 ;;; Footnote Definition
 914 ;;
 915 ;; Footnote Definitions are ignored.
 916 ;;
 917 ;; Footnotes are handled automatically in GROFF.  Although manual
 918 ;; references can be added, not really required.
 919
 920 (defun org-groff-footnote-reference (footnote-reference contents info)
 921   ;; Changing from info to footnote-reference
 922   (let* ((raw (org-export-get-footnote-definition footnote-reference info))
 923                  (n (org-export-get-footnote-number footnote-reference info))
 924                  (data (org-trim (org-export-data raw info)))
 925          (ref-id (plist-get (nth 1 footnote-reference) :label)))
 926     ;; It is a reference
 927     (if (string-match "fn:rl" ref-id)
 928         (if (member ref-id org-groff-registered-references)
 929             (format "\\*[%s]" ref-id)
 930           (progn
 931             (push ref-id org-groff-registered-references)
 932             (format "\\*(Rf\n.RS \"%s\" \n%s\n.RF\n" ref-id  data)))
 933       ;; else it is a footnote
 934       (format "\\u\\s-2%s\\d\\s+2\n.FS %s\n%s\n.FE\n" n n data))))
 935
 936 ;;; Headline
 937
 938 (defun org-groff-headline (headline contents info)
 939   "Transcode a HEADLINE element from Org to Groff.
 940 CONTENTS holds the contents of the headline.  INFO is a plist
 941 holding contextual information."
 942   (let* ((class (plist-get info :groff-class))
 943          (level (org-export-get-relative-level headline info))
 944          (numberedp (org-export-numbered-headline-p headline info))
 945          ;; Section formatting will set two placeholders: one for the
 946          ;; title and the other for the contents.
 947          (classes (assoc class org-groff-classes))
 948          (classes-options (car (last classes)))
 949          (heading-option (plist-get classes-options :heading))
 950          (section-fmt
 951           (progn
 952             (cond
 953              ((and (symbolp heading-option)
 954                    (fboundp heading-option))
 955               (funcall heading-option level numberedp))
 956              ((> level 7) nil)
 957              (t (if numberedp
 958                     (concat ".H " (number-to-string level) " \"%s\"\n%s")
 959                   ".HU \"%s\"\n%s")))))
 960          ;; End of section-fmt
 961          (text (org-export-data (org-element-property :title headline) info))
 962          (todo
 963           (and (plist-get info :with-todo-keywords)
 964                (let ((todo (org-element-property :todo-keyword headline)))
 965                  (and todo (org-export-data todo info)))))
 966          (todo-type (and todo (org-element-property :todo-type headline)))
 967          (tags (and (plist-get info :with-tags)
 968                     (org-export-get-tags headline info)))
 969          (priority (and (plist-get info :with-priority)
 970                         (org-element-property :priority headline)))
 971          ;; Create the headline text along with a no-tag version.  The
 972          ;; latter is required to remove tags from table of contents.
 973          (full-text (if (functionp org-groff-format-headline-function)
 974                         ;; User-defined formatting function.
 975                         (funcall org-groff-format-headline-function
 976                                  todo todo-type priority text tags)
 977                       ;; Default formatting.
 978                       (concat
 979                        (when todo
 980                          (format "\\fB%s\\fP " todo))
 981                        (when priority (format " [\\#%c] " priority))
 982                        text
 983                        (when tags
 984                          (format " \\fC:%s:\\fP "
 985                                  (mapconcat 'identity tags ":"))))))
 986          (full-text-no-tag
 987           (if (functionp org-groff-format-headline-function)
 988               ;; User-defined formatting function.
 989               (funcall org-groff-format-headline-function
 990                        todo todo-type priority text nil)
 991             ;; Default formatting.
 992             (concat
 993              (when todo (format "\\fB%s\\fP " todo))
 994              (when priority (format " [\\#%c] " priority))
 995              text)))
 996          ;; Associate some \label to the headline for internal links.
 997          ;;      (headline-label
 998          ;;       (format "\\label{sec-%s}\n"
 999          ;;               (mapconcat 'number-to-string
1000          ;;                          (org-export-get-headline-number headline info)
1001          ;;                          "-")))
1002          (headline-label "")
1003          (pre-blanks
1004           (make-string (org-element-property :pre-blank headline) 10)))
1005
1006     (cond
1007      ;; Case 1: Special Tag
1008      ((member (car  tags)  org-groff-special-tags)
1009       (cond
1010        ((string= (car tags) "BODY") contents)
1011
1012        ((string= (car tags) "NS")
1013         (progn
1014           (push (cons (car tags)
1015                       (format ".NS \"%s\" 1 \n%s"
1016                               (car (org-element-property :title headline))
1017                               (or contents " ")))
1018                 org-groff-special-content) nil))
1019
1020        (t
1021         (progn
1022           (push (cons  (car tags) contents) org-groff-special-content)
1023           nil))))
1024
1025      ;; Case 2: This is a footnote section: ignore it.
1026      ((org-element-property :footnote-section-p headline) nil)
1027
1028      ;; Case 3: This is a deep sub-tree: export it as a list item.
1029      ;;         Also export as items headlines for which no section
1030      ;;         format has been found.
1031      ((or (not section-fmt) (org-export-low-level-p headline info))
1032       ;; Build the real contents of the sub-tree.
1033       (let ((low-level-body
1034              (concat
1035               ;; If the headline is the first sibling, start a list.
1036               (when (org-export-first-sibling-p headline info)
1037                 (format "%s\n" (if numberedp ".AL 1\n" ".DL \n")))
1038               ;; Itemize headline
1039               ".LI\n" full-text "\n" headline-label pre-blanks contents)))
1040         ;; If headline is not the last sibling simply return
1041         ;; LOW-LEVEL-BODY.  Otherwise, also close the list, before any
1042         ;; blank line.
1043         (if (not (org-export-last-sibling-p headline info)) low-level-body
1044           (replace-regexp-in-string
1045            "[ \t\n]*\\'"
1046            (concat "\n.LE")
1047            low-level-body))))
1048
1049      ;; Case 4. Standard headline.  Export it as a section.
1050      (t
1051       (format section-fmt full-text
1052               (concat headline-label pre-blanks contents))))))
1053
1054 ;;; Horizontal Rule
1055 ;; Not supported
1056
1057 ;;; Inline Babel Call
1058 ;;
1059 ;; Inline Babel Calls are ignored.
1060
1061 ;;; Inline Src Block
1062
1063 (defun org-groff-inline-src-block (inline-src-block contents info)
1064   "Transcode an INLINE-SRC-BLOCK element from Org to Groff.
1065 CONTENTS holds the contents of the item.  INFO is a plist holding
1066 contextual information."
1067   (let* ((code (org-element-property :value inline-src-block)))
1068     (cond
1069      (org-groff-source-highlight
1070       (let* ((tmpdir (if (featurep 'xemacs)
1071                          temp-directory
1072                        temporary-file-directory))
1073              (in-file  (make-temp-name
1074                         (expand-file-name "srchilite" tmpdir)))
1075              (out-file (make-temp-name
1076                         (expand-file-name "reshilite" tmpdir)))
1077              (org-lang (org-element-property :language inline-src-block))
1078              (lst-lang (cadr (assq (intern org-lang)
1079                                    org-groff-source-highlight-langs)))
1080
1081              (cmd (concat (expand-file-name "source-highlight")
1082                           " -s " lst-lang
1083                           " -f groff_mm_color "
1084                           " -i " in-file
1085                           " -o " out-file)))
1086         (if lst-lang
1087             (let ((code-block ""))
1088               (with-temp-file in-file (insert code))
1089               (shell-command cmd)
1090               (setq code-block  (org-file-contents out-file))
1091               (delete-file in-file)
1092               (delete-file out-file)
1093               code-block)
1094           (format ".DS I\n\\fC\\m[black]%s\\m[]\\fP\n.DE\n"
1095                   code))))
1096
1097      ;; Do not use a special package: transcode it verbatim.
1098      (t
1099       (concat ".DS I\n" "\\fC" code "\\fP\n.DE\n")))))
1100
1101 ;;; Inlinetask
1102
1103 (defun org-groff-inlinetask (inlinetask contents info)
1104   "Transcode an INLINETASK element from Org to Groff.
1105 CONTENTS holds the contents of the block.  INFO is a plist
1106 holding contextual information."
1107   (let ((title (org-export-data (org-element-property :title inlinetask) info))
1108         (todo (and (plist-get info :with-todo-keywords)
1109                    (let ((todo (org-element-property :todo-keyword inlinetask)))
1110                      (and todo (org-export-data todo info)))))
1111         (todo-type (org-element-property :todo-type inlinetask))
1112         (tags (and (plist-get info :with-tags)
1113                    (org-export-get-tags inlinetask info)))
1114         (priority (and (plist-get info :with-priority)
1115                        (org-element-property :priority inlinetask))))
1116     ;; If `org-groff-format-inlinetask-function' is provided, call it
1117     ;; with appropriate arguments.
1118     (if (functionp org-groff-format-inlinetask-function)
1119         (funcall org-groff-format-inlinetask-function
1120                  todo todo-type priority title tags contents)
1121       ;; Otherwise, use a default template.
1122       (org-groff--wrap-label
1123        inlinetask
1124        (let ((full-title
1125               (concat
1126                (when todo (format "\\fB%s\\fP " todo))
1127                (when priority (format " [\\#%c] " priority))
1128                title
1129                (when tags (format " \\fC:%s:\\fP "
1130                                   (mapconcat 'identity tags ":"))))))
1131          (format (concat "\n.DS I\n"
1132                          "%s\n"
1133                          ".sp"
1134                          "%s\n"
1135                          ".DE")
1136                  full-title contents))))))
1137
1138 ;;; Italic
1139
1140 (defun org-groff-italic (italic contents info)
1141   "Transcode ITALIC from Org to Groff.
1142 CONTENTS is the text with italic markup.  INFO is a plist holding
1143 contextual information."
1144   (org-groff--text-markup contents 'italic))
1145
1146 ;;; Item
1147
1148 (defun org-groff-item (item contents info)
1149   "Transcode an ITEM element from Org to Groff.
1150 CONTENTS holds the contents of the item.  INFO is a plist holding
1151 contextual information."
1152   (let* ((bullet (org-element-property :bullet item))
1153          (type (org-element-property
1154                 :type (org-element-property :parent item)))
1155          (checkbox (case (org-element-property :checkbox item)
1156                      (on "\\o'\\(sq\\(mu'")
1157                      (off "\\(sq")
1158                      (trans "\\o'\\(sq\\(mi'")))
1159          (tag (let ((tag (org-element-property :tag item)))
1160                 ;; Check-boxes must belong to the tag.
1161                 (and tag (format "%s"
1162                                  (concat checkbox
1163                                          (org-export-data tag info)))))))
1164
1165         (cond
1166          ((or checkbox tag)
1167           (concat ".LI ""\"" (or tag (concat "\\ " checkbox)) "\""
1168               "\n"
1169               (org-trim (or contents " "))))
1170      ((eq type 'ordered)
1171       (concat ".LI"
1172               "\n"
1173               (org-trim (or contents " "))))
1174      (t
1175       (let* ((bullet (org-trim bullet))
1176              (marker (cond  ((string= "-" bullet) "\\(em")
1177                             ((string= "*" bullet) "\\(bu")
1178                             (t "\\(dg"))))
1179         (concat ".LI " marker "\n"
1180                 (org-trim (or contents " "))))))))
1181
1182 ;;; Keyword
1183
1184 (defun org-groff-keyword (keyword contents info)
1185   "Transcode a KEYWORD element from Org to Groff.
1186 CONTENTS is nil.  INFO is a plist holding contextual information."
1187   (let ((key (org-element-property :key keyword))
1188         (value (org-element-property :value keyword)))
1189     (cond
1190      ((string= key "GROFF") value)
1191      (t nil))))
1192
1193 ;;; Line Break
1194
1195 (defun org-groff-line-break (line-break contents info)
1196   "Transcode a LINE-BREAK object from Org to Groff.
1197 CONTENTS is nil.  INFO is a plist holding contextual information."
1198   ".br\n")
1199
1200 ;;; Link
1201 ;; Inline images just place a call to .PSPIC or .PS/.PE
1202 ;;  and load the graph.
1203
1204 (defun org-groff-link--inline-image (link info)
1205   "Return Groff code for an inline image.
1206 LINK is the link pointing to the inline image.  INFO is a plist
1207 used as a communication channel."
1208   (let* ((parent (org-export-get-parent-element link))
1209          (path (let ((raw-path (org-element-property :path link)))
1210                  (if (not (file-name-absolute-p raw-path)) raw-path
1211                    (expand-file-name raw-path))))
1212          (attr (org-export-read-attribute :attr_groff link))
1213          (placement
1214           (let ((pos (plist-get attr :position)))
1215             (cond ((string= pos 'center) "")
1216                   ((string= pos 'left) "-L")
1217                   ((string= pos 'right) "-R")
1218                   (t ""))))
1219          (width  (or (plist-get attr :width) ""))
1220          (height (or (plist-get attr :height) ""))
1221          (caption (and (not (plist-get attr :disable-caption))
1222                        (org-groff--caption/label-string parent info))))
1223     ;; Now clear ATTR from any special keyword and set a default value
1224     ;; if nothing is left.  Return proper string.
1225     (concat
1226      (cond
1227       ((and org-groff-raster-to-ps
1228             (or  (string-match ".\.png$" path)
1229                  (string-match ".\.jpg$" path)))
1230        (let ((eps-path (concat path ".eps")))
1231          (shell-command (format org-groff-raster-to-ps path eps-path))
1232          (format "\n.DS L F\n.PSPIC %s \"%s\" %s %s\n.DE "
1233                  placement eps-path width height)))
1234       ((string-match ".\.pic$" path)
1235        (format "\n.PS\ncopy \"%s\"\n.PE" path))
1236       (t (format "\n.DS L F\n.PSPIC %s \"%s\" %s %s\n.DE "
1237                  placement path width height)))
1238      (and caption (format "\n.FG \"%s\"" caption)))))
1239
1240 (defun org-groff-link (link desc info)
1241   "Transcode a LINK object from Org to Groff.
1242
1243 DESC is the description part of the link, or the empty string.
1244 INFO is a plist holding contextual information.  See
1245 `org-export-data'."
1246
1247   (let* ((type (org-element-property :type link))
1248          (raw-path (org-element-property :path link))
1249          ;; Ensure DESC really exists, or set it to nil.
1250          (desc (and (not (string= desc "")) desc))
1251          (imagep (org-export-inline-image-p
1252                   link org-groff-inline-image-rules))
1253          (path (cond
1254                 ((member type '("http" "https" "ftp" "mailto"))
1255                  (concat type "://" raw-path))
1256                 ((string= type "file")
1257                  (if (file-name-absolute-p raw-path)
1258                      (concat "file://" (expand-file-name raw-path))
1259                    (concat "file://" raw-path)))
1260                 (t raw-path)))
1261          protocol)
1262     (cond
1263      ;; Image file.
1264      (imagep (org-groff-link--inline-image link info))
1265      ;; import groff files
1266      ((and (string= type "file")
1267            (string-match ".\.groff$" raw-path))
1268       (concat ".so " raw-path "\n"))
1269      ;; Radio link: transcode target's contents and use them as link's
1270      ;; description.
1271      ((string= type "radio")
1272       (let ((destination (org-export-resolve-radio-link link info)))
1273         (when destination
1274           (format "\\fI [%s] \\fP"
1275                   (org-export-solidify-link-text
1276                    (org-element-property :value destination))))))
1277
1278      ;; Links pointing to a headline: find destination and build
1279      ;; appropriate referencing command.
1280      ((member type '("custom-id" "fuzzy" "id"))
1281       (let ((destination (if (string= type "fuzzy")
1282                              (org-export-resolve-fuzzy-link link info)
1283                            (org-export-resolve-id-link link info))))
1284         (case (org-element-type destination)
1285           ;; Id link points to an external file.
1286           (plain-text
1287            (if desc (format "%s \\fBat\\fP \\fIfile://%s\\fP" desc destination)
1288              (format "\\fI file://%s \\fP" destination)))
1289           ;; Fuzzy link points nowhere.
1290           ('nil
1291            (format org-groff-link-with-unknown-path-format
1292                    (or desc
1293                        (org-export-data
1294                         (org-element-property :raw-link link) info))))
1295           ;; LINK points to a headline.  If headlines are numbered and
1296           ;; the link has no description, display headline's number.
1297           ;; Otherwise, display description or headline's title.
1298           (headline
1299            (let ((label ""))
1300              (if (and (plist-get info :section-numbers) (not desc))
1301                  (format "\\fI%s\\fP" label)
1302                (format "\\fI%s\\fP"
1303                        (or desc
1304                            (org-export-data
1305                             (org-element-property :title destination) info))))))
1306           ;; Fuzzy link points to a target.  Do as above.
1307           (otherwise
1308            (let ((path (org-export-solidify-link-text path)))
1309              (if (not desc) (format "\\fI%s\\fP" path)
1310                (format "%s \\fBat\\fP \\fI%s\\fP" desc path)))))))
1311      ;; External link with a description part.
1312      ((and path desc) (format "%s \\fBat\\fP \\fI%s\\fP" path desc))
1313      ;; External link without a description part.
1314      (path (format "\\fI%s\\fP" path))
1315      ;; No path, only description.  Try to do something useful.
1316      (t (format org-groff-link-with-unknown-path-format desc)))))
1317
1318 ;;; Paragraph
1319
1320 (defun org-groff-paragraph (paragraph contents info)
1321   "Transcode a PARAGRAPH element from Org to Groff.
1322 CONTENTS is the contents of the paragraph, as a string.  INFO is
1323 the plist used as a communication channel."
1324   (let ((parent (plist-get (nth 1 paragraph) :parent)))
1325     (when parent
1326       (let* ((parent-type (car parent))
1327              (fixed-paragraph "")
1328              (class (plist-get info :groff-class))
1329              (class-options (plist-get info :groff-class-options))
1330              (classes (assoc class org-groff-classes))
1331              (classes-options (car (last classes)))
1332              (paragraph-option (plist-get classes-options :paragraph)))
1333         (cond
1334          ((and (symbolp paragraph-option)
1335                (fboundp paragraph-option))
1336           (funcall paragraph-option parent-type parent contents))
1337          ((and (eq parent-type 'item)
1338                (plist-get (nth 1 parent) :bullet))
1339           (setq fixed-paragraph (concat "" contents)))
1340          ((eq parent-type 'section)
1341           (setq fixed-paragraph (concat ".P\n" contents)))
1342          ((eq parent-type 'footnote-definition)
1343           (setq fixed-paragraph (concat "" contents)))
1344          (t (setq fixed-paragraph (concat "" contents))))
1345         fixed-paragraph))))
1346
1347 ;;; Plain List
1348
1349 (defun org-groff-plain-list (plain-list contents info)
1350   "Transcode a PLAIN-LIST element from Org to Groff.
1351 CONTENTS is the contents of the list.  INFO is a plist holding
1352 contextual information."
1353   (let* ((type (org-element-property :type plain-list))
1354          (attr (mapconcat #'identity
1355                           (org-element-property :attr_groff plain-list)
1356                           " "))
1357          (groff-type (cond
1358                       ((eq type 'ordered) ".AL")
1359                       ((eq type 'unordered) ".BL")
1360                       ((eq type 'descriptive) ".VL 2.0i"))))
1361     (org-groff--wrap-label
1362      plain-list
1363      (format "%s\n%s\n.LE" groff-type contents))))
1364
1365 ;;; Plain Text
1366
1367 (defun org-groff-plain-text (text info)
1368   "Transcode a TEXT string from Org to Groff.
1369 TEXT is the string to transcode.  INFO is a plist holding
1370 contextual information."
1371 (let ((output text))
1372   ;; Protect various characters.
1373   (setq output (replace-regexp-in-string
1374                 "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%$#&{}~^_\\]\\|$\\)"
1375                 "$\\" output nil t 1))
1376   ;; Activate smart quotes.  Be sure to provide original TEXT string
1377   ;; since OUTPUT may have been modified.
1378   (when (plist-get info :with-smart-quotes)
1379     (setq output (org-export-activate-smart-quotes output :utf-8 info text)))
1380   ;; Handle Special Characters
1381   (if org-groff-special-char
1382       (dolist (special-char-list org-groff-special-char)
1383         (setq output
1384               (replace-regexp-in-string (car special-char-list)
1385                                         (cdr special-char-list) output))))
1386   ;; Handle break preservation if required.
1387   (when (plist-get info :preserve-breaks)
1388     (setq output (replace-regexp-in-string
1389                   "\\(\\\\\\\\\\)?[ \t]*\n" ".br\n" output)))
1390   ;; Return value.
1391   output))
1392
1393 ;;; Planning
1394
1395 (defun org-groff-planning (planning contents info)
1396   "Transcode a PLANNING element from Org to Groff.
1397 CONTENTS is nil.  INFO is a plist holding contextual
1398 information."
1399   (concat
1400    (mapconcat
1401     'identity
1402     (delq nil
1403           (list
1404            (let ((closed (org-element-property :closed planning)))
1405              (when closed
1406                (concat
1407                 (format "\\fR %s \\fP" org-closed-string)
1408                 (format org-groff-inactive-timestamp-format
1409                         (org-translate-time
1410                          (org-element-property :raw-value closed))))))
1411            (let ((deadline (org-element-property :deadline planning)))
1412              (when deadline
1413                (concat
1414                 (format "\\fB %s \\fP" org-deadline-string)
1415                 (format org-groff-active-timestamp-format
1416                         (org-translate-time
1417                          (org-element-property :raw-value deadline))))))
1418            (let ((scheduled (org-element-property :scheduled planning)))
1419              (when scheduled
1420                (concat
1421                 (format "\\fR %s \\fP" org-scheduled-string)
1422                 (format org-groff-active-timestamp-format
1423                         (org-translate-time
1424                          (org-element-property :raw-value scheduled))))))))
1425     "")
1426    ""))
1427
1428 ;;; Quote Block
1429
1430 (defun org-groff-quote-block (quote-block contents info)
1431   "Transcode a QUOTE-BLOCK element from Org to Groff.
1432 CONTENTS holds the contents of the block.  INFO is a plist
1433 holding contextual information."
1434   (org-groff--wrap-label
1435    quote-block
1436    (format ".DS I\n.I\n%s\n.R\n.DE" contents)))
1437
1438 ;;; Quote Section
1439
1440 (defun org-groff-quote-section (quote-section contents info)
1441   "Transcode a QUOTE-SECTION element from Org to Groff.
1442 CONTENTS is nil.  INFO is a plist holding contextual information."
1443   (let ((value (org-remove-indentation
1444                 (org-element-property :value quote-section))))
1445     (when value (format ".DS L\n\\fI%s\\fP\n.DE\n" value))))
1446
1447 ;;; Radio Target
1448
1449 (defun org-groff-radio-target (radio-target text info)
1450   "Transcode a RADIO-TARGET object from Org to Groff.
1451 TEXT is the text of the target.  INFO is a plist holding
1452 contextual information."
1453   (format "%s - %s"
1454           (org-export-solidify-link-text
1455            (org-element-property :value radio-target))
1456           text))
1457
1458 ;;; Section
1459
1460 (defun org-groff-section (section contents info)
1461   "Transcode a SECTION element from Org to Groff.
1462 CONTENTS holds the contents of the section.  INFO is a plist
1463 holding contextual information."
1464   contents)
1465
1466 ;;; Special Block
1467
1468 (defun org-groff-special-block (special-block contents info)
1469   "Transcode a SPECIAL-BLOCK element from Org to Groff.
1470 CONTENTS holds the contents of the block.  INFO is a plist
1471 holding contextual information."
1472   (let ((type (downcase (org-element-property :type special-block))))
1473     (org-groff--wrap-label
1474      special-block
1475      (format "%s\n" contents))))
1476
1477 ;;; Src Block
1478
1479 (defun org-groff-src-block (src-block contents info)
1480   "Transcode a SRC-BLOCK element from Org to Groff.
1481 CONTENTS holds the contents of the item.  INFO is a plist holding
1482 contextual information."
1483   (let* ((lang (org-element-property :language src-block))
1484          (label (org-element-property :name src-block))
1485          (code (org-element-property :value src-block))
1486          (custom-env (and lang
1487                           (cadr (assq (intern lang)
1488                                       org-groff-custom-lang-environments))))
1489          (num-start (case (org-element-property :number-lines src-block)
1490                       (continued (org-export-get-loc src-block info))
1491                       (new 0)))
1492          (retain-labels (org-element-property :retain-labels src-block))
1493          (caption (and (not (org-export-read-attribute
1494                              :attr_groff src-block :disable-caption))
1495                        (org-groff--caption/label-string src-block info))))
1496
1497     (cond
1498      ;; Case 1.  No source fontification.
1499      ((not org-groff-source-highlight)
1500       (concat
1501        (format ".DS I\n\\fC%s\\fP\n.DE\n"
1502                (org-export-format-code-default src-block info))
1503        (and caption (format ".EX \"%s\" " caption))))
1504
1505      ;; Case 2.  Source fontification.
1506      (org-groff-source-highlight
1507       (let* ((tmpdir (if (featurep 'xemacs)
1508                          temp-directory
1509                        temporary-file-directory))
1510              (in-file  (make-temp-name
1511                         (expand-file-name "srchilite" tmpdir)))
1512              (out-file (make-temp-name
1513                         (expand-file-name "reshilite" tmpdir)))
1514
1515              (org-lang (org-element-property :language src-block))
1516              (lst-lang (cadr (assq (intern org-lang)
1517                                    org-groff-source-highlight-langs)))
1518
1519              (cmd (concat "source-highlight"
1520                           " -s " lst-lang
1521                           " -f groff_mm_color "
1522                           " -i " in-file
1523                           " -o " out-file)))
1524
1525         (concat
1526          (if lst-lang
1527              (let ((code-block ""))
1528                (with-temp-file in-file (insert code))
1529                (shell-command cmd)
1530                (setq code-block  (org-file-contents out-file))
1531                (delete-file in-file)
1532                (delete-file out-file)
1533                (format "%s\n"  code-block))
1534            (format ".DS I\n\\fC\\m[black]%s\\m[]\\fP\n.DE\n"
1535                    code))
1536          (and caption (format ".EX \"%s\" " caption))))))))
1537
1538
1539 ;;; Statistics Cookie
1540
1541 (defun org-groff-statistics-cookie (statistics-cookie contents info)
1542   "Transcode a STATISTICS-COOKIE object from Org to Groff.
1543 CONTENTS is nil.  INFO is a plist holding contextual information."
1544   (org-element-property :value statistics-cookie))
1545
1546
1547 ;;; Strike-Through
1548
1549 (defun org-groff-strike-through (strike-through contents info)
1550   "Transcode STRIKE-THROUGH from Org to Groff.
1551 CONTENTS is the text with strike-through markup.  INFO is a plist
1552 holding contextual information."
1553   (org-groff--text-markup contents 'strike-through))
1554
1555 ;;; Subscript
1556
1557 (defun org-groff-subscript (subscript contents info)
1558   "Transcode a SUBSCRIPT object from Org to Groff.
1559 CONTENTS is the contents of the object.  INFO is a plist holding
1560 contextual information."
1561   (format  "\\d\\s-2%s\\s+2\\u" contents))
1562
1563 ;;; Superscript "^_%s$
1564
1565 (defun org-groff-superscript (superscript contents info)
1566   "Transcode a SUPERSCRIPT object from Org to Groff.
1567 CONTENTS is the contents of the object.  INFO is a plist holding
1568 contextual information."
1569   (format  "\\u\\s-2%s\\s+2\\d" contents))
1570
1571
1572 ;;; Table
1573 ;;
1574 ;; `org-groff-table' is the entry point for table transcoding.  It
1575 ;; takes care of tables with a "verbatim" attribute.  Otherwise, it
1576 ;; delegates the job to  `org-groff-table--org-table' function,
1577 ;; depending of the type of the table.
1578 ;;
1579 ;; `org-groff-table--align-string' is a subroutine used to build
1580 ;; alignment string for Org tables.
1581
1582 (defun org-groff-table (table contents info)
1583   "Transcode a TABLE element from Org to Groff.
1584 CONTENTS is the contents of the table.  INFO is a plist holding
1585 contextual information."
1586   (cond
1587    ;; Case 1: verbatim table.
1588    ((or org-groff-tables-verbatim
1589         (let ((attr (read (format "(%s)"
1590                  (mapconcat
1591                   #'identity
1592                                    (org-element-property :attr_groff table) " ")))))
1593           (and attr (plist-get attr :verbatim))))
1594
1595     (format ".DS L\n\\fC%s\\fP\n.DE"
1596             ;; Re-create table, without affiliated keywords.
1597             (org-trim
1598              (org-element-interpret-data
1599               `(table nil ,@(org-element-contents table))))))
1600
1601    ;; Case 2: Standard table.
1602    (t (org-groff-table--org-table table contents info))))
1603
1604 (defun org-groff-table--align-string (divider table info)
1605   "Return an appropriate Groff alignment string.
1606 TABLE is the considered table.  INFO is a plist used as
1607 a communication channel."
1608   (let (alignment)
1609     ;; Extract column groups and alignment from first (non-rule) row.
1610     (org-element-map
1611         (org-element-map table 'table-row
1612           (lambda (row)
1613             (and (eq (org-element-property :type row) 'standard) row))
1614           info 'first-match)
1615         'table-cell
1616       (lambda (cell)
1617         (let* ((borders (org-export-table-cell-borders cell info))
1618                (raw-width (org-export-table-cell-width cell info))
1619                (width-cm (when raw-width (/ raw-width 5)))
1620                (width (if raw-width (format "w(%dc)"
1621                                             (if (< width-cm 1) 1 width-cm)) "")))
1622           ;; Check left border for the first cell only.
1623           ;; Alignment is nil on assignment
1624
1625           (when (and (memq 'left borders) (not alignment))
1626             (push "|" alignment))
1627           (push
1628            (case (org-export-table-cell-alignment cell info)
1629              (left (concat "l" width divider))
1630              (right (concat "r" width divider))
1631              (center (concat "c" width divider)))
1632            alignment)
1633           (when (memq 'right borders) (push "|" alignment))))
1634       info)
1635     (apply 'concat (reverse alignment))))
1636
1637 (defun org-groff-table--org-table (table contents info)
1638   "Return appropriate Groff code for an Org table.
1639
1640 TABLE is the table type element to transcode.  CONTENTS is its
1641 contents, as a string.  INFO is a plist used as a communication
1642 channel.
1643
1644 This function assumes TABLE has `org' as its `:type' attribute."
1645   (let* ((attr (org-export-read-attribute :attr_groff table))
1646          (label (org-element-property :name table))
1647          (caption (and (not (plist-get attr :disable-caption))
1648                        (org-groff--caption/label-string table info)))
1649          (divider (if (plist-get attr :divider) "|" " "))
1650
1651          ;; Determine alignment string.
1652          (alignment (org-groff-table--align-string divider table info))
1653
1654          ;; Extract others display options.
1655
1656          (lines (org-split-string contents "\n"))
1657
1658          (attr-list
1659           (delq nil
1660                 (list (and (plist-get attr :expand) "expand")
1661                       (let ((placement (plist-get attr :placement)))
1662                         (cond ((string= placement 'center) "center")
1663                               ((string= placement 'left) nil)
1664                               (t (if org-groff-tables-centered "center" ""))))
1665                       (or (plist-get attr :boxtype) "box"))))
1666
1667          (title-line  (plist-get attr :title-line))
1668          (long-cells (plist-get attr :long-cells))
1669
1670          (table-format
1671           (concat
1672            (or (car attr-list) "")
1673            (or
1674             (let (output-list)
1675               (when (cdr attr-list)
1676                 (dolist (attr-item (cdr attr-list))
1677                   (setq output-list (concat output-list
1678                                             (format ",%s" attr-item)))))
1679               output-list) "")))
1680          (first-line
1681           (when lines (org-split-string (car lines) "\t"))))
1682     ;; Prepare the final format string for the table.
1683
1684
1685     (cond
1686      ;; Others.
1687      (lines
1688       (concat ".TS\n " table-format ";\n"
1689               (format "%s.\n"
1690                       (let ((final-line ""))
1691                         (when title-line
1692                           (dotimes (i (length first-line))
1693                             (setq final-line (concat final-line "cb" divider))))
1694
1695                         (setq final-line (concat final-line "\n"))
1696
1697                         (if alignment
1698                             (setq final-line (concat final-line alignment))
1699                           (dotimes (i (length first-line))
1700                             (setq final-line (concat final-line "c" divider))))
1701                         final-line))
1702
1703               (format "%s.TE\n"
1704                       (let ((final-line "")
1705                             (long-line "")
1706                             (lines (org-split-string contents "\n")))
1707
1708                         (dolist (line-item lines)
1709                           (setq long-line "")
1710
1711                           (if long-cells
1712                               (progn
1713                                 (if (string= line-item "_")
1714                                     (setq long-line (format "%s\n" line-item))
1715                                   ;; else string =
1716                                   (let ((cell-item-list (org-split-string line-item "\t")))
1717                                     (dolist (cell-item cell-item-list)
1718
1719                                       (cond  ((eq cell-item (car (last cell-item-list)))
1720                                               (setq long-line (concat long-line
1721                                                                       (format "T{\n%s\nT}\t\n"  cell-item))))
1722                                              (t
1723                                               (setq long-line (concat long-line
1724                                                                       (format "T{\n%s\nT}\t"  cell-item))))))
1725                                     long-line))
1726                                 ;; else long cells
1727                                 (setq final-line (concat final-line long-line)))
1728
1729                             (setq final-line (concat final-line line-item "\n"))))
1730                         final-line))
1731
1732               (if caption (format ".TB \"%s\"" caption) ""))))))
1733
1734 ;;; Table Cell
1735
1736 (defun org-groff-table-cell (table-cell contents info)
1737   "Transcode a TABLE-CELL element from Org to Groff
1738 CONTENTS is the cell contents.  INFO is a plist used as
1739 a communication channel."
1740   (progn
1741     (concat (if (and contents
1742                      org-groff-table-scientific-notation
1743                      (string-match orgtbl-exp-regexp contents))
1744                 ;; Use appropriate format string for scientific
1745                 ;; notation.
1746                 (format org-groff-table-scientific-notation
1747                         (match-string 1 contents)
1748                         (match-string 2 contents))
1749               contents)
1750             (when (org-export-get-next-element table-cell info) "\t"))))
1751
1752
1753 ;;; Table Row
1754
1755 (defun org-groff-table-row (table-row contents info)
1756   "Transcode a TABLE-ROW element from Org to Groff
1757 CONTENTS is the contents of the row.  INFO is a plist used as
1758 a communication channel."
1759   ;; Rules are ignored since table separators are deduced from
1760   ;; borders of the current row.
1761   (when (eq (org-element-property :type table-row) 'standard)
1762     (let* ((attr (mapconcat 'identity
1763                             (org-element-property
1764                              :attr_groff (org-export-get-parent table-row))
1765                             " "))
1766            ;; TABLE-ROW's borders are extracted from its first cell.
1767            (borders
1768             (org-export-table-cell-borders
1769              (car (org-element-contents table-row)) info)))
1770       (concat
1771        ;; Mark horizontal lines
1772        (cond  ((and (memq 'top borders) (memq 'above borders)) "_\n"))
1773        contents
1774        (cond
1775         ;; When BOOKTABS are activated enforce bottom rule even when
1776         ;; no hline was specifically marked.
1777         ((and (memq 'bottom borders) (memq 'below borders)) "\n_")
1778         ((memq 'below borders) "\n_"))))))
1779
1780 ;;; Target
1781
1782 (defun org-groff-target (target contents info)
1783   "Transcode a TARGET object from Org to Groff.
1784 CONTENTS is nil.  INFO is a plist holding contextual
1785 information."
1786   (format "\\fI%s\\fP"
1787           (org-export-solidify-link-text (org-element-property :value target))))
1788
1789 ;;; Timestamp
1790
1791 (defun org-groff-timestamp (timestamp contents info)
1792   "Transcode a TIMESTAMP object from Org to Groff.
1793 CONTENTS is nil.  INFO is a plist holding contextual
1794 information."
1795   (let ((value (org-groff-plain-text
1796                 (org-timestamp-translate timestamp) info)))
1797     (case (org-element-property :type timestamp)
1798       ((active active-range)
1799        (format org-groff-active-timestamp-format value))
1800       ((inactive inactive-range)
1801        (format org-groff-inactive-timestamp-format value))
1802       (t (format org-groff-diary-timestamp-format value)))))
1803
1804 ;;; Underline
1805
1806 (defun org-groff-underline (underline contents info)
1807   "Transcode UNDERLINE from Org to Groff.
1808 CONTENTS is the text with underline markup.  INFO is a plist
1809 holding contextual information."
1810   (org-groff--text-markup contents 'underline))
1811
1812 ;;; Verbatim
1813
1814 (defun org-groff-verbatim (verbatim contents info)
1815   "Transcode a VERBATIM object from Org to Groff.
1816 CONTENTS is nil.  INFO is a plist used as a communication
1817 channel."
1818   (org-groff--text-markup (org-element-property :value verbatim) 'verbatim))
1819
1820 ;;; Verse Block
1821
1822 (defun org-groff-verse-block (verse-block contents info)
1823   "Transcode a VERSE-BLOCK element from Org to Groff.
1824 CONTENTS is verse block contents. INFO is a plist holding
1825 contextual information."
1826   (format ".DS C\n.ft HI\n%s\n.ft\n.DE" contents))
1827
1828 \f
1829 ;;; Interactive functions
1830
1831 (defun org-groff-export-to-groff
1832   (&optional async subtreep visible-only body-only ext-plist)
1833   "Export current buffer to a Groff file.
1834
1835 If narrowing is active in the current buffer, only export its
1836 narrowed part.
1837
1838 If a region is active, export that region.
1839
1840 A non-nil optional argument ASYNC means the process should happen
1841 asynchronously.  The resulting file should be accessible through
1842 the `org-export-stack' interface.
1843
1844 When optional argument SUBTREEP is non-nil, export the sub-tree
1845 at point, extracting information from the headline properties
1846 first.
1847
1848 When optional argument VISIBLE-ONLY is non-nil, don't export
1849 contents of hidden elements.
1850
1851 EXT-PLIST, when provided, is a property list with external
1852 parameters overriding Org default settings, but still inferior to
1853 file-local settings.
1854
1855 Return output file's name."
1856   (interactive)
1857   (let ((outfile (org-export-output-file-name ".groff" subtreep))
1858         (org-groff-registered-references nil)
1859         (org-groff-special-content nil))
1860     (org-export-to-file 'groff outfile
1861       async subtreep visible-only body-only ext-plist)))
1862
1863 (defun org-groff-export-to-pdf
1864   (&optional async subtreep visible-only body-only ext-plist)
1865   "Export current buffer to Groff then process through to PDF.
1866
1867 If narrowing is active in the current buffer, only export its
1868 narrowed part.
1869
1870 If a region is active, export that region.
1871
1872 A non-nil optional argument ASYNC means the process should happen
1873 asynchronously.  The resulting file should be accessible through
1874 the `org-export-stack' interface.
1875
1876 When optional argument SUBTREEP is non-nil, export the sub-tree
1877 at point, extracting information from the headline properties
1878 first.
1879
1880 When optional argument VISIBLE-ONLY is non-nil, don't export
1881 contents of hidden elements.
1882
1883 EXT-PLIST, when provided, is a property list with external
1884 parameters overriding Org default settings, but still inferior to
1885 file-local settings.
1886
1887 Return PDF file's name."
1888   (interactive)
1889   (let ((outfile (org-export-output-file-name ".groff" subtreep)))
1890     (org-export-to-file 'groff outfile
1891       async subtreep visible-only body-only ext-plist
1892       (lambda (file) (org-groff-compile file)))))
1893
1894 (defun org-groff-compile (file)
1895   "Compile a Groff file.
1896
1897 FILE is the name of the file being compiled.  Processing is done
1898 through the command specified in `org-groff-pdf-process'.
1899
1900 Return PDF file name or an error if it couldn't be produced."
1901   (let* ((base-name (file-name-sans-extension (file-name-nondirectory file)))
1902          (full-name (file-truename file))
1903          (out-dir (file-name-directory file))
1904          ;; Properly set working directory for compilation.
1905          (default-directory (if (file-name-absolute-p file)
1906                                 (file-name-directory full-name)
1907                               default-directory))
1908          errors)
1909     (message (format "Processing Groff file %s ..." file))
1910     (save-window-excursion
1911       (cond
1912        ;; A function is provided: Apply it.
1913        ((functionp org-groff-pdf-process)
1914         (funcall org-groff-pdf-process (shell-quote-argument file)))
1915        ;; A list is provided: Replace %b, %f and %o with appropriate
1916        ;; values in each command before applying it.  Output is
1917        ;; redirected to "*Org PDF Groff Output*" buffer.
1918        ((consp org-groff-pdf-process)
1919         (let ((outbuf (get-buffer-create "*Org PDF Groff Output*")))
1920           (mapc
1921            (lambda (command)
1922              (shell-command
1923               (replace-regexp-in-string
1924                "%b" (shell-quote-argument base-name)
1925                (replace-regexp-in-string
1926                 "%f" (shell-quote-argument full-name)
1927                 (replace-regexp-in-string
1928                  "%o" (shell-quote-argument out-dir) command t t)
1929                 t t) t t)
1930               outbuf))
1931            org-groff-pdf-process)
1932           ;; Collect standard errors from output buffer.
1933           (setq errors (org-groff-collect-errors outbuf))))
1934        (t (error "No valid command to process to PDF")))
1935       (let ((pdffile (concat out-dir base-name ".pdf")))
1936         ;; Check for process failure.  Provide collected errors if
1937         ;; possible.
1938         (if (not (file-exists-p pdffile))
1939             (error (concat (format "PDF file %s wasn't produced" pdffile)
1940                            (when errors (concat ": " errors))))
1941           ;; Else remove log files, when specified, and signal end of
1942           ;; process to user, along with any error encountered.
1943           (when org-groff-remove-logfiles
1944             (dolist (ext org-groff-logfiles-extensions)
1945               (let ((file (concat out-dir base-name "." ext)))
1946                 (when (file-exists-p file) (delete-file file)))))
1947           (message (concat "Process completed"
1948                            (if (not errors) "."
1949                              (concat " with errors: " errors)))))
1950         ;; Return output file name.
1951         pdffile))))
1952
1953 (defun org-groff-collect-errors (buffer)
1954   "Collect some kind of errors from \"groff\" output
1955 BUFFER is the buffer containing output.
1956 Return collected error types as a string, or nil if there was
1957 none."
1958   (with-current-buffer buffer
1959     (save-excursion
1960       (goto-char (point-max))
1961       ;; Find final run
1962       nil)))
1963
1964
1965 (provide 'ox-groff)
1966 ;;; ox-groff.el ends here