lisp/ox.el

   1 ;;; ox.el --- Generic Export Engine for Org Mode
   2
   3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
   4
   5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
   6 ;; Keywords: outlines, hypermedia, calendar, wp
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24 ;;
  25 ;; This library implements a generic export engine for Org, built on
  26 ;; its syntactical parser: Org Elements.
  27 ;;
  28 ;; Besides that parser, the generic exporter is made of three distinct
  29 ;; parts:
  30 ;;
  31 ;; - The communication channel consists of a property list, which is
  32 ;;   created and updated during the process.  Its use is to offer
  33 ;;   every piece of information, would it be about initial environment
  34 ;;   or contextual data, all in a single place.
  35 ;;
  36 ;; - The transcoder walks the parse tree, ignores or treat as plain
  37 ;;   text elements and objects according to export options, and
  38 ;;   eventually calls back-end specific functions to do the real
  39 ;;   transcoding, concatenating their return value along the way.
  40 ;;
  41 ;; - The filter system is activated at the very beginning and the very
  42 ;;   end of the export process, and each time an element or an object
  43 ;;   has been converted.  It is the entry point to fine-tune standard
  44 ;;   output from back-end transcoders.  See "The Filter System"
  45 ;;   section for more information.
  46 ;;
  47 ;; The core functions is `org-export-as'.  It returns the transcoded
  48 ;; buffer as a string.  Its derivatives are `org-export-to-buffer' and
  49 ;; `org-export-to-file'.
  50 ;;
  51 ;; An export back-end is defined with `org-export-define-backend'.
  52 ;; This function can also support specific buffer keywords, OPTION
  53 ;; keyword's items and filters.  Refer to function's documentation for
  54 ;; more information.
  55 ;;
  56 ;; If the new back-end shares most properties with another one,
  57 ;; `org-export-define-derived-backend' can be used to simplify the
  58 ;; process.
  59 ;;
  60 ;; Any back-end can define its own variables.  Among them, those
  61 ;; customizable should belong to the `org-export-BACKEND' group.
  62 ;;
  63 ;; Tools for common tasks across back-ends are implemented in the
  64 ;; following part of the file.
  65 ;;
  66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
  67 ;; last one.
  68 ;;
  69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
  70 ;; more information.
  71
  72 ;;; Code:
  73
  74 (eval-when-compile (require 'cl))
  75 (require 'org-element)
  76 (require 'org-macro)
  77 (require 'ob-exp)
  78
  79 (declare-function org-publish "ox-publish" (project &optional force async))
  80 (declare-function org-publish-all "ox-publish" (&optional force async))
  81 (declare-function
  82  org-publish-current-file "ox-publish" (&optional force async))
  83 (declare-function org-publish-current-project "ox-publish"
  84                   (&optional force async))
  85
  86 (defvar org-publish-project-alist)
  87 (defvar org-table-number-fraction)
  88 (defvar org-table-number-regexp)
  89
  90 \f
  91 ;;; Internal Variables
  92 ;;
  93 ;; Among internal variables, the most important is
  94 ;; `org-export-options-alist'.  This variable define the global export
  95 ;; options, shared between every exporter, and how they are acquired.
  96
  97 (defconst org-export-max-depth 19
  98   "Maximum nesting depth for headlines, counting from 0.")
  99
 100 (defconst org-export-options-alist
 101   '((:title "TITLE" nil nil parse)
 102     (:date "DATE" nil nil parse)
 103     (:author "AUTHOR" nil user-full-name parse)
 104     (:email "EMAIL" nil user-mail-address t)
 105     (:language "LANGUAGE" nil org-export-default-language t)
 106     (:select-tags "SELECT_TAGS" nil org-export-select-tags split)
 107     (:exclude-tags "EXCLUDE_TAGS" nil org-export-exclude-tags split)
 108     (:creator "CREATOR" nil org-export-creator-string)
 109     (:headline-levels nil "H" org-export-headline-levels)
 110     (:preserve-breaks nil "\\n" org-export-preserve-breaks)
 111     (:section-numbers nil "num" org-export-with-section-numbers)
 112     (:time-stamp-file nil "timestamp" org-export-time-stamp-file)
 113     (:with-archived-trees nil "arch" org-export-with-archived-trees)
 114     (:with-author nil "author" org-export-with-author)
 115     (:with-clocks nil "c" org-export-with-clocks)
 116     (:with-creator nil "creator" org-export-with-creator)
 117     (:with-date nil "date" org-export-with-date)
 118     (:with-drawers nil "d" org-export-with-drawers)
 119     (:with-email nil "email" org-export-with-email)
 120     (:with-emphasize nil "*" org-export-with-emphasize)
 121     (:with-entities nil "e" org-export-with-entities)
 122     (:with-fixed-width nil ":" org-export-with-fixed-width)
 123     (:with-footnotes nil "f" org-export-with-footnotes)
 124     (:with-inlinetasks nil "inline" org-export-with-inlinetasks)
 125     (:with-latex nil "tex" org-export-with-latex)
 126     (:with-planning nil "p" org-export-with-planning)
 127     (:with-priority nil "pri" org-export-with-priority)
 128     (:with-properties nil "prop" org-export-with-properties)
 129     (:with-smart-quotes nil "'" org-export-with-smart-quotes)
 130     (:with-special-strings nil "-" org-export-with-special-strings)
 131     (:with-statistics-cookies nil "stat" org-export-with-statistics-cookies)
 132     (:with-sub-superscript nil "^" org-export-with-sub-superscripts)
 133     (:with-toc nil "toc" org-export-with-toc)
 134     (:with-tables nil "|" org-export-with-tables)
 135     (:with-tags nil "tags" org-export-with-tags)
 136     (:with-tasks nil "tasks" org-export-with-tasks)
 137     (:with-timestamps nil "<" org-export-with-timestamps)
 138     (:with-title nil "title" org-export-with-title)
 139     (:with-todo-keywords nil "todo" org-export-with-todo-keywords))
 140   "Alist between export properties and ways to set them.
 141
 142 The key of the alist is the property name, and the value is a list
 143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
 144
 145 KEYWORD is a string representing a buffer keyword, or nil.  Each
 146   property defined this way can also be set, during subtree
 147   export, through a headline property named after the keyword
 148   with the \"EXPORT_\" prefix (i.e. DATE keyword and EXPORT_DATE
 149   property).
 150 OPTION is a string that could be found in an #+OPTIONS: line.
 151 DEFAULT is the default value for the property.
 152 BEHAVIOR determines how Org should handle multiple keywords for
 153   the same property.  It is a symbol among:
 154   nil       Keep old value and discard the new one.
 155   t         Replace old value with the new one.
 156   `space'   Concatenate the values, separating them with a space.
 157   `newline' Concatenate the values, separating them with
 158             a newline.
 159   `split'   Split values at white spaces, and cons them to the
 160             previous list.
 161   `parse'   Parse value as a list of strings and Org objects,
 162             which can then be transcoded with, e.g.,
 163             `org-export-data'.  It implies `space' behavior.
 164
 165 Values set through KEYWORD and OPTION have precedence over
 166 DEFAULT.
 167
 168 All these properties should be back-end agnostic.  Back-end
 169 specific properties are set through `org-export-define-backend'.
 170 Properties redefined there have precedence over these.")
 171
 172 (defconst org-export-special-keywords '("FILETAGS" "SETUPFILE" "OPTIONS")
 173   "List of in-buffer keywords that require special treatment.
 174 These keywords are not directly associated to a property.  The
 175 way they are handled must be hard-coded into
 176 `org-export--get-inbuffer-options' function.")
 177
 178 (defconst org-export-filters-alist
 179   '((:filter-body . org-export-filter-body-functions)
 180     (:filter-bold . org-export-filter-bold-functions)
 181     (:filter-babel-call . org-export-filter-babel-call-functions)
 182     (:filter-center-block . org-export-filter-center-block-functions)
 183     (:filter-clock . org-export-filter-clock-functions)
 184     (:filter-code . org-export-filter-code-functions)
 185     (:filter-diary-sexp . org-export-filter-diary-sexp-functions)
 186     (:filter-drawer . org-export-filter-drawer-functions)
 187     (:filter-dynamic-block . org-export-filter-dynamic-block-functions)
 188     (:filter-entity . org-export-filter-entity-functions)
 189     (:filter-example-block . org-export-filter-example-block-functions)
 190     (:filter-export-block . org-export-filter-export-block-functions)
 191     (:filter-export-snippet . org-export-filter-export-snippet-functions)
 192     (:filter-final-output . org-export-filter-final-output-functions)
 193     (:filter-fixed-width . org-export-filter-fixed-width-functions)
 194     (:filter-footnote-definition . org-export-filter-footnote-definition-functions)
 195     (:filter-footnote-reference . org-export-filter-footnote-reference-functions)
 196     (:filter-headline . org-export-filter-headline-functions)
 197     (:filter-horizontal-rule . org-export-filter-horizontal-rule-functions)
 198     (:filter-inline-babel-call . org-export-filter-inline-babel-call-functions)
 199     (:filter-inline-src-block . org-export-filter-inline-src-block-functions)
 200     (:filter-inlinetask . org-export-filter-inlinetask-functions)
 201     (:filter-italic . org-export-filter-italic-functions)
 202     (:filter-item . org-export-filter-item-functions)
 203     (:filter-keyword . org-export-filter-keyword-functions)
 204     (:filter-latex-environment . org-export-filter-latex-environment-functions)
 205     (:filter-latex-fragment . org-export-filter-latex-fragment-functions)
 206     (:filter-line-break . org-export-filter-line-break-functions)
 207     (:filter-link . org-export-filter-link-functions)
 208     (:filter-node-property . org-export-filter-node-property-functions)
 209     (:filter-options . org-export-filter-options-functions)
 210     (:filter-paragraph . org-export-filter-paragraph-functions)
 211     (:filter-parse-tree . org-export-filter-parse-tree-functions)
 212     (:filter-plain-list . org-export-filter-plain-list-functions)
 213     (:filter-plain-text . org-export-filter-plain-text-functions)
 214     (:filter-planning . org-export-filter-planning-functions)
 215     (:filter-property-drawer . org-export-filter-property-drawer-functions)
 216     (:filter-quote-block . org-export-filter-quote-block-functions)
 217     (:filter-radio-target . org-export-filter-radio-target-functions)
 218     (:filter-section . org-export-filter-section-functions)
 219     (:filter-special-block . org-export-filter-special-block-functions)
 220     (:filter-src-block . org-export-filter-src-block-functions)
 221     (:filter-statistics-cookie . org-export-filter-statistics-cookie-functions)
 222     (:filter-strike-through . org-export-filter-strike-through-functions)
 223     (:filter-subscript . org-export-filter-subscript-functions)
 224     (:filter-superscript . org-export-filter-superscript-functions)
 225     (:filter-table . org-export-filter-table-functions)
 226     (:filter-table-cell . org-export-filter-table-cell-functions)
 227     (:filter-table-row . org-export-filter-table-row-functions)
 228     (:filter-target . org-export-filter-target-functions)
 229     (:filter-timestamp . org-export-filter-timestamp-functions)
 230     (:filter-underline . org-export-filter-underline-functions)
 231     (:filter-verbatim . org-export-filter-verbatim-functions)
 232     (:filter-verse-block . org-export-filter-verse-block-functions))
 233   "Alist between filters properties and initial values.
 234
 235 The key of each association is a property name accessible through
 236 the communication channel.  Its value is a configurable global
 237 variable defining initial filters.
 238
 239 This list is meant to install user specified filters.  Back-end
 240 developers may install their own filters using
 241 `org-export-define-backend'.  Filters defined there will always
 242 be prepended to the current list, so they always get applied
 243 first.")
 244
 245 (defconst org-export-default-inline-image-rule
 246   `(("file" .
 247      ,(format "\\.%s\\'"
 248               (regexp-opt
 249                '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm"
 250                  "xpm" "pbm" "pgm" "ppm") t))))
 251   "Default rule for link matching an inline image.
 252 This rule applies to links with no description.  By default, it
 253 will be considered as an inline image if it targets a local file
 254 whose extension is either \"png\", \"jpeg\", \"jpg\", \"gif\",
 255 \"tiff\", \"tif\", \"xbm\", \"xpm\", \"pbm\", \"pgm\" or \"ppm\".
 256 See `org-export-inline-image-p' for more information about
 257 rules.")
 258
 259 (defconst org-export-ignored-local-variables
 260   '(org-font-lock-keywords
 261     org-element--cache org-element--cache-objects org-element--cache-sync-keys
 262     org-element--cache-sync-requests org-element--cache-sync-timer)
 263   "List of variables not copied through upon buffer duplication.
 264 Export process takes place on a copy of the original buffer.
 265 When this copy is created, all Org related local variables not in
 266 this list are copied to the new buffer.  Variables with an
 267 unreadable value are also ignored.")
 268
 269 (defvar org-export-async-debug nil
 270   "Non-nil means asynchronous export process should leave data behind.
 271
 272 This data is found in the appropriate \"*Org Export Process*\"
 273 buffer, and in files prefixed with \"org-export-process\" and
 274 located in `temporary-file-directory'.
 275
 276 When non-nil, it will also set `debug-on-error' to a non-nil
 277 value in the external process.")
 278
 279 (defvar org-export-stack-contents nil
 280   "Record asynchronously generated export results and processes.
 281 This is an alist: its CAR is the source of the
 282 result (destination file or buffer for a finished process,
 283 original buffer for a running one) and its CDR is a list
 284 containing the back-end used, as a symbol, and either a process
 285 or the time at which it finished.  It is used to build the menu
 286 from `org-export-stack'.")
 287
 288 (defvar org-export-registered-backends nil
 289   "List of backends currently available in the exporter.
 290 This variable is set with `org-export-define-backend' and
 291 `org-export-define-derived-backend' functions.")
 292
 293 (defvar org-export-dispatch-last-action nil
 294   "Last command called from the dispatcher.
 295 The value should be a list.  Its CAR is the action, as a symbol,
 296 and its CDR is a list of export options.")
 297
 298 (defvar org-export-dispatch-last-position (make-marker)
 299   "The position where the last export command was created using the dispatcher.
 300 This marker will be used with `C-u C-c C-e' to make sure export repetition
 301 uses the same subtree if the previous command was restricted to a subtree.")
 302
 303 ;; For compatibility with Org < 8
 304 (defvar org-export-current-backend nil
 305   "Name, if any, of the back-end used during an export process.
 306
 307 Its value is a symbol such as `html', `latex', `ascii', or nil if
 308 the back-end is anonymous (see `org-export-create-backend') or if
 309 there is no export process in progress.
 310
 311 It can be used to teach Babel blocks how to act differently
 312 according to the back-end used.")
 313
 314
 315 \f
 316 ;;; User-configurable Variables
 317 ;;
 318 ;; Configuration for the masses.
 319 ;;
 320 ;; They should never be accessed directly, as their value is to be
 321 ;; stored in a property list (cf. `org-export-options-alist').
 322 ;; Back-ends will read their value from there instead.
 323
 324 (defgroup org-export nil
 325   "Options for exporting Org mode files."
 326   :tag "Org Export"
 327   :group 'org)
 328
 329 (defgroup org-export-general nil
 330   "General options for export engine."
 331   :tag "Org Export General"
 332   :group 'org-export)
 333
 334 (defcustom org-export-with-archived-trees 'headline
 335   "Whether sub-trees with the ARCHIVE tag should be exported.
 336
 337 This can have three different values:
 338 nil         Do not export, pretend this tree is not present.
 339 t           Do export the entire tree.
 340 `headline'  Only export the headline, but skip the tree below it.
 341
 342 This option can also be set with the OPTIONS keyword,
 343 e.g. \"arch:nil\"."
 344   :group 'org-export-general
 345   :type '(choice
 346           (const :tag "Not at all" nil)
 347           (const :tag "Headline only" headline)
 348           (const :tag "Entirely" t)))
 349
 350 (defcustom org-export-with-author t
 351   "Non-nil means insert author name into the exported file.
 352 This option can also be set with the OPTIONS keyword,
 353 e.g. \"author:nil\"."
 354   :group 'org-export-general
 355   :type 'boolean)
 356
 357 (defcustom org-export-with-clocks nil
 358   "Non-nil means export CLOCK keywords.
 359 This option can also be set with the OPTIONS keyword,
 360 e.g. \"c:t\"."
 361   :group 'org-export-general
 362   :type 'boolean)
 363
 364 (defcustom org-export-with-creator nil
 365   "Non-nil means the postamble should contain a creator sentence.
 366
 367 The sentence can be set in `org-export-creator-string', which
 368 see.
 369
 370 This option can also be set with the OPTIONS keyword, e.g.,
 371 \"creator:t\"."
 372   :group 'org-export-general
 373   :version "25.1"
 374   :package-version '(Org . "8.3")
 375   :type 'boolean)
 376
 377 (defcustom org-export-with-date t
 378   "Non-nil means insert date in the exported document.
 379 This option can also be set with the OPTIONS keyword,
 380 e.g. \"date:nil\"."
 381   :group 'org-export-general
 382   :type 'boolean)
 383
 384 (defcustom org-export-date-timestamp-format nil
 385   "Time-stamp format string to use for DATE keyword.
 386
 387 The format string, when specified, only applies if date consists
 388 in a single time-stamp.  Otherwise its value will be ignored.
 389
 390 See `format-time-string' for details on how to build this
 391 string."
 392   :group 'org-export-general
 393   :type '(choice
 394           (string :tag "Time-stamp format string")
 395           (const :tag "No format string" nil)))
 396
 397 (defcustom org-export-creator-string
 398   (format "Emacs %s (Org mode %s)"
 399           emacs-version
 400           (if (fboundp 'org-version) (org-version) "unknown version"))
 401   "Information about the creator of the document.
 402 This option can also be set on with the CREATOR keyword."
 403   :group 'org-export-general
 404   :type '(string :tag "Creator string"))
 405
 406 (defcustom org-export-with-drawers '(not "LOGBOOK")
 407   "Non-nil means export contents of standard drawers.
 408
 409 When t, all drawers are exported.  This may also be a list of
 410 drawer names to export, as strings.  If that list starts with
 411 `not', only drawers with such names will be ignored.
 412
 413 This variable doesn't apply to properties drawers.  See
 414 `org-export-with-properties' instead.
 415
 416 This option can also be set with the OPTIONS keyword,
 417 e.g. \"d:nil\"."
 418   :group 'org-export-general
 419   :version "24.4"
 420   :package-version '(Org . "8.0")
 421   :type '(choice
 422           (const :tag "All drawers" t)
 423           (const :tag "None" nil)
 424           (repeat :tag "Selected drawers"
 425                   (string :tag "Drawer name"))
 426           (list :tag "Ignored drawers"
 427                 (const :format "" not)
 428                 (repeat :tag "Specify names of drawers to ignore during export"
 429                         :inline t
 430                         (string :tag "Drawer name")))))
 431
 432 (defcustom org-export-with-email nil
 433   "Non-nil means insert author email into the exported file.
 434 This option can also be set with the OPTIONS keyword,
 435 e.g. \"email:t\"."
 436   :group 'org-export-general
 437   :type 'boolean)
 438
 439 (defcustom org-export-with-emphasize t
 440   "Non-nil means interpret *word*, /word/, _word_ and +word+.
 441
 442 If the export target supports emphasizing text, the word will be
 443 typeset in bold, italic, with an underline or strike-through,
 444 respectively.
 445
 446 This option can also be set with the OPTIONS keyword,
 447 e.g. \"*:nil\"."
 448   :group 'org-export-general
 449   :type 'boolean)
 450
 451 (defcustom org-export-exclude-tags '("noexport")
 452   "Tags that exclude a tree from export.
 453
 454 All trees carrying any of these tags will be excluded from
 455 export.  This is without condition, so even subtrees inside that
 456 carry one of the `org-export-select-tags' will be removed.
 457
 458 This option can also be set with the EXCLUDE_TAGS keyword."
 459   :group 'org-export-general
 460   :type '(repeat (string :tag "Tag")))
 461
 462 (defcustom org-export-with-fixed-width t
 463   "Non-nil means export lines starting with \":\".
 464 This option can also be set with the OPTIONS keyword,
 465 e.g. \"::nil\"."
 466   :group 'org-export-general
 467   :version "24.4"
 468   :package-version '(Org . "8.0")
 469   :type 'boolean)
 470
 471 (defcustom org-export-with-footnotes t
 472   "Non-nil means Org footnotes should be exported.
 473 This option can also be set with the OPTIONS keyword,
 474 e.g. \"f:nil\"."
 475   :group 'org-export-general
 476   :type 'boolean)
 477
 478 (defcustom org-export-with-latex t
 479   "Non-nil means process LaTeX environments and fragments.
 480
 481 This option can also be set with the OPTIONS line,
 482 e.g. \"tex:verbatim\".  Allowed values are:
 483
 484 nil         Ignore math snippets.
 485 `verbatim'  Keep everything in verbatim.
 486 t           Allow export of math snippets."
 487   :group 'org-export-general
 488   :version "24.4"
 489   :package-version '(Org . "8.0")
 490   :type '(choice
 491           (const :tag "Do not process math in any way" nil)
 492           (const :tag "Interpret math snippets" t)
 493           (const :tag "Leave math verbatim" verbatim)))
 494
 495 (defcustom org-export-headline-levels 3
 496   "The last level which is still exported as a headline.
 497
 498 Inferior levels will usually produce itemize or enumerate lists
 499 when exported, but back-end behaviour may differ.
 500
 501 This option can also be set with the OPTIONS keyword,
 502 e.g. \"H:2\"."
 503   :group 'org-export-general
 504   :type 'integer)
 505
 506 (defcustom org-export-default-language "en"
 507   "The default language for export and clocktable translations, as a string.
 508 This may have an association in
 509 `org-clock-clocktable-language-setup',
 510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
 511 This option can also be set with the LANGUAGE keyword."
 512   :group 'org-export-general
 513   :type '(string :tag "Language"))
 514
 515 (defcustom org-export-preserve-breaks nil
 516   "Non-nil means preserve all line breaks when exporting.
 517 This option can also be set with the OPTIONS keyword,
 518 e.g. \"\\n:t\"."
 519   :group 'org-export-general
 520   :type 'boolean)
 521
 522 (defcustom org-export-with-entities t
 523   "Non-nil means interpret entities when exporting.
 524
 525 For example, HTML export converts \\alpha to &alpha; and \\AA to
 526 &Aring;.
 527
 528 For a list of supported names, see the constant `org-entities'
 529 and the user option `org-entities-user'.
 530
 531 This option can also be set with the OPTIONS keyword,
 532 e.g. \"e:nil\"."
 533   :group 'org-export-general
 534   :type 'boolean)
 535
 536 (defcustom org-export-with-inlinetasks t
 537   "Non-nil means inlinetasks should be exported.
 538 This option can also be set with the OPTIONS keyword,
 539 e.g. \"inline:nil\"."
 540   :group 'org-export-general
 541   :version "24.4"
 542   :package-version '(Org . "8.0")
 543   :type 'boolean)
 544
 545 (defcustom org-export-with-planning nil
 546   "Non-nil means include planning info in export.
 547
 548 Planning info is the line containing either SCHEDULED:,
 549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
 550
 551 This option can also be set with the OPTIONS keyword,
 552 e.g. \"p:t\"."
 553   :group 'org-export-general
 554   :version "24.4"
 555   :package-version '(Org . "8.0")
 556   :type 'boolean)
 557
 558 (defcustom org-export-with-priority nil
 559   "Non-nil means include priority cookies in export.
 560 This option can also be set with the OPTIONS keyword,
 561 e.g. \"pri:t\"."
 562   :group 'org-export-general
 563   :type 'boolean)
 564
 565 (defcustom org-export-with-properties nil
 566   "Non-nil means export contents of properties drawers.
 567
 568 When t, all properties are exported.  This may also be a list of
 569 properties to export, as strings.
 570
 571 This option can also be set with the OPTIONS keyword,
 572 e.g. \"prop:t\"."
 573   :group 'org-export-general
 574   :version "24.4"
 575   :package-version '(Org . "8.3")
 576   :type '(choice
 577           (const :tag "All properties" t)
 578           (const :tag "None" nil)
 579           (repeat :tag "Selected properties"
 580                   (string :tag "Property name"))))
 581
 582 (defcustom org-export-with-section-numbers t
 583   "Non-nil means add section numbers to headlines when exporting.
 584
 585 When set to an integer n, numbering will only happen for
 586 headlines whose relative level is higher or equal to n.
 587
 588 This option can also be set with the OPTIONS keyword,
 589 e.g. \"num:t\"."
 590   :group 'org-export-general
 591   :type 'boolean)
 592
 593 (defcustom org-export-select-tags '("export")
 594   "Tags that select a tree for export.
 595
 596 If any such tag is found in a buffer, all trees that do not carry
 597 one of these tags will be ignored during export.  Inside trees
 598 that are selected like this, you can still deselect a subtree by
 599 tagging it with one of the `org-export-exclude-tags'.
 600
 601 This option can also be set with the SELECT_TAGS keyword."
 602   :group 'org-export-general
 603   :type '(repeat (string :tag "Tag")))
 604
 605 (defcustom org-export-with-smart-quotes nil
 606   "Non-nil means activate smart quotes during export.
 607 This option can also be set with the OPTIONS keyword,
 608 e.g., \"':t\".
 609
 610 When setting this to non-nil, you need to take care of
 611 using the correct Babel package when exporting to LaTeX.
 612 E.g., you can load Babel for french like this:
 613
 614 #+LATEX_HEADER: \\usepackage[french]{babel}"
 615   :group 'org-export-general
 616   :version "24.4"
 617   :package-version '(Org . "8.0")
 618   :type 'boolean)
 619
 620 (defcustom org-export-with-special-strings t
 621   "Non-nil means interpret \"\\-\", \"--\" and \"---\" for export.
 622
 623 When this option is turned on, these strings will be exported as:
 624
 625    Org     HTML     LaTeX    UTF-8
 626   -----+----------+--------+-------
 627    \\-    &shy;      \\-
 628    --    &ndash;    --         –
 629    ---   &mdash;    ---        —
 630    ...   &hellip;   \\ldots     …
 631
 632 This option can also be set with the OPTIONS keyword,
 633 e.g. \"-:nil\"."
 634   :group 'org-export-general
 635   :type 'boolean)
 636
 637 (defcustom org-export-with-statistics-cookies t
 638   "Non-nil means include statistics cookies in export.
 639 This option can also be set with the OPTIONS keyword,
 640 e.g. \"stat:nil\""
 641   :group 'org-export-general
 642   :version "24.4"
 643   :package-version '(Org . "8.0")
 644   :type 'boolean)
 645
 646 (defcustom org-export-with-sub-superscripts t
 647   "Non-nil means interpret \"_\" and \"^\" for export.
 648
 649 If you want to control how Org displays those characters, see
 650 `org-use-sub-superscripts'.  `org-export-with-sub-superscripts'
 651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
 652 it is not anymore.
 653
 654 When this option is turned on, you can use TeX-like syntax for
 655 sub- and superscripts and see them exported correctly.
 656
 657 You can also set the option with #+OPTIONS: ^:t
 658
 659 Several characters after \"_\" or \"^\" will be considered as a
 660 single item - so grouping with {} is normally not needed.  For
 661 example, the following things will be parsed as single sub- or
 662 superscripts:
 663
 664  10^24   or   10^tau     several digits will be considered 1 item.
 665  10^-12  or   10^-tau    a leading sign with digits or a word
 666  x^2-y^3                 will be read as x^2 - y^3, because items are
 667                          terminated by almost any nonword/nondigit char.
 668  x_{i^2} or   x^(2-i)    braces or parenthesis do grouping.
 669
 670 Still, ambiguity is possible.  So when in doubt, use {} to enclose
 671 the sub/superscript.  If you set this variable to the symbol `{}',
 672 the braces are *required* in order to trigger interpretations as
 673 sub/superscript.  This can be helpful in documents that need \"_\"
 674 frequently in plain text."
 675   :group 'org-export-general
 676   :version "24.4"
 677   :package-version '(Org . "8.0")
 678   :type '(choice
 679           (const :tag "Interpret them" t)
 680           (const :tag "Curly brackets only" {})
 681           (const :tag "Do not interpret them" nil)))
 682
 683 (defcustom org-export-with-toc t
 684   "Non-nil means create a table of contents in exported files.
 685
 686 The TOC contains headlines with levels up
 687 to`org-export-headline-levels'.  When an integer, include levels
 688 up to N in the toc, this may then be different from
 689 `org-export-headline-levels', but it will not be allowed to be
 690 larger than the number of headline levels.  When nil, no table of
 691 contents is made.
 692
 693 This option can also be set with the OPTIONS keyword,
 694 e.g. \"toc:nil\" or \"toc:3\"."
 695   :group 'org-export-general
 696   :type '(choice
 697           (const :tag "No Table of Contents" nil)
 698           (const :tag "Full Table of Contents" t)
 699           (integer :tag "TOC to level")))
 700
 701 (defcustom org-export-with-tables t
 702   "Non-nil means export tables.
 703 This option can also be set with the OPTIONS keyword,
 704 e.g. \"|:nil\"."
 705   :group 'org-export-general
 706   :version "24.4"
 707   :package-version '(Org . "8.0")
 708   :type 'boolean)
 709
 710 (defcustom org-export-with-tags t
 711   "If nil, do not export tags, just remove them from headlines.
 712
 713 If this is the symbol `not-in-toc', tags will be removed from
 714 table of contents entries, but still be shown in the headlines of
 715 the document.
 716
 717 This option can also be set with the OPTIONS keyword,
 718 e.g. \"tags:nil\"."
 719   :group 'org-export-general
 720   :type '(choice
 721           (const :tag "Off" nil)
 722           (const :tag "Not in TOC" not-in-toc)
 723           (const :tag "On" t)))
 724
 725 (defcustom org-export-with-tasks t
 726   "Non-nil means include TODO items for export.
 727
 728 This may have the following values:
 729 t                    include tasks independent of state.
 730 `todo'               include only tasks that are not yet done.
 731 `done'               include only tasks that are already done.
 732 nil                  ignore all tasks.
 733 list of keywords     include tasks with these keywords.
 734
 735 This option can also be set with the OPTIONS keyword,
 736 e.g. \"tasks:nil\"."
 737   :group 'org-export-general
 738   :type '(choice
 739           (const :tag "All tasks" t)
 740           (const :tag "No tasks" nil)
 741           (const :tag "Not-done tasks" todo)
 742           (const :tag "Only done tasks" done)
 743           (repeat :tag "Specific TODO keywords"
 744                   (string :tag "Keyword"))))
 745
 746 (defcustom org-export-with-title t
 747   "Non-nil means print title into the exported file.
 748 This option can also be set with the OPTIONS keyword,
 749 e.g. \"title:nil\"."
 750   :group 'org-export-general
 751   :version "25.1"
 752   :package-version '(Org . "8.3")
 753   :type 'boolean)
 754
 755 (defcustom org-export-time-stamp-file t
 756   "Non-nil means insert a time stamp into the exported file.
 757 The time stamp shows when the file was created.  This option can
 758 also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"."
 759   :group 'org-export-general
 760   :type 'boolean)
 761
 762 (defcustom org-export-with-timestamps t
 763   "Non nil means allow timestamps in export.
 764
 765 It can be set to any of the following values:
 766   t          export all timestamps.
 767   `active'   export active timestamps only.
 768   `inactive' export inactive timestamps only.
 769   nil        do not export timestamps
 770
 771 This only applies to timestamps isolated in a paragraph
 772 containing only timestamps.  Other timestamps are always
 773 exported.
 774
 775 This option can also be set with the OPTIONS keyword, e.g.
 776 \"<:nil\"."
 777   :group 'org-export-general
 778   :type '(choice
 779           (const :tag "All timestamps" t)
 780           (const :tag "Only active timestamps" active)
 781           (const :tag "Only inactive timestamps" inactive)
 782           (const :tag "No timestamp" nil)))
 783
 784 (defcustom org-export-with-todo-keywords t
 785   "Non-nil means include TODO keywords in export.
 786 When nil, remove all these keywords from the export.  This option
 787 can also be set with the OPTIONS keyword, e.g.  \"todo:nil\"."
 788   :group 'org-export-general
 789   :type 'boolean)
 790
 791 (defcustom org-export-allow-bind-keywords nil
 792   "Non-nil means BIND keywords can define local variable values.
 793 This is a potential security risk, which is why the default value
 794 is nil.  You can also allow them through local buffer variables."
 795   :group 'org-export-general
 796   :version "24.4"
 797   :package-version '(Org . "8.0")
 798   :type 'boolean)
 799
 800 (defcustom org-export-snippet-translation-alist nil
 801   "Alist between export snippets back-ends and exporter back-ends.
 802
 803 This variable allows to provide shortcuts for export snippets.
 804
 805 For example, with a value of '\(\(\"h\" . \"html\"\)\), the
 806 HTML back-end will recognize the contents of \"@@h:<b>@@\" as
 807 HTML code while every other back-end will ignore it."
 808   :group 'org-export-general
 809   :version "24.4"
 810   :package-version '(Org . "8.0")
 811   :type '(repeat
 812           (cons (string :tag "Shortcut")
 813                 (string :tag "Back-end"))))
 814
 815 (defcustom org-export-coding-system nil
 816   "Coding system for the exported file."
 817   :group 'org-export-general
 818   :version "24.4"
 819   :package-version '(Org . "8.0")
 820   :type 'coding-system)
 821
 822 (defcustom org-export-copy-to-kill-ring nil
 823   "Non-nil means pushing export output to the kill ring.
 824 This variable is ignored during asynchronous export."
 825   :group 'org-export-general
 826   :version "25.1"
 827   :package-version '(Org . "8.3")
 828   :type '(choice
 829           (const :tag "Always" t)
 830           (const :tag "When export is done interactively" if-interactive)
 831           (const :tag "Never" nil)))
 832
 833 (defcustom org-export-initial-scope 'buffer
 834   "The initial scope when exporting with `org-export-dispatch'.
 835 This variable can be either set to `buffer' or `subtree'."
 836   :group 'org-export-general
 837   :type '(choice
 838           (const :tag "Export current buffer" buffer)
 839           (const :tag "Export current subtree" subtree)))
 840
 841 (defcustom org-export-show-temporary-export-buffer t
 842   "Non-nil means show buffer after exporting to temp buffer.
 843 When Org exports to a file, the buffer visiting that file is never
 844 shown, but remains buried.  However, when exporting to
 845 a temporary buffer, that buffer is popped up in a second window.
 846 When this variable is nil, the buffer remains buried also in
 847 these cases."
 848   :group 'org-export-general
 849   :type 'boolean)
 850
 851 (defcustom org-export-in-background nil
 852   "Non-nil means export and publishing commands will run in background.
 853 Results from an asynchronous export are never displayed
 854 automatically.  But you can retrieve them with \\[org-export-stack]."
 855   :group 'org-export-general
 856   :version "24.4"
 857   :package-version '(Org . "8.0")
 858   :type 'boolean)
 859
 860 (defcustom org-export-async-init-file nil
 861   "File used to initialize external export process.
 862
 863 Value must be either nil or an absolute file name.  When nil, the
 864 external process is launched like a regular Emacs session,
 865 loading user's initialization file and any site specific
 866 configuration.  If a file is provided, it, and only it, is loaded
 867 at start-up.
 868
 869 Therefore, using a specific configuration makes the process to
 870 load faster and the export more portable."
 871   :group 'org-export-general
 872   :version "24.4"
 873   :package-version '(Org . "8.0")
 874   :type '(choice
 875           (const :tag "Regular startup" nil)
 876           (file :tag "Specific start-up file" :must-match t)))
 877
 878 (defcustom org-export-dispatch-use-expert-ui nil
 879   "Non-nil means using a non-intrusive `org-export-dispatch'.
 880 In that case, no help buffer is displayed.  Though, an indicator
 881 for current export scope is added to the prompt (\"b\" when
 882 output is restricted to body only, \"s\" when it is restricted to
 883 the current subtree, \"v\" when only visible elements are
 884 considered for export, \"f\" when publishing functions should be
 885 passed the FORCE argument and \"a\" when the export should be
 886 asynchronous).  Also, \[?] allows to switch back to standard
 887 mode."
 888   :group 'org-export-general
 889   :version "24.4"
 890   :package-version '(Org . "8.0")
 891   :type 'boolean)
 892
 893
 894 \f
 895 ;;; Defining Back-ends
 896 ;;
 897 ;; An export back-end is a structure with `org-export-backend' type
 898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
 899 ;; and `menu' slots.
 900 ;;
 901 ;; At the lowest level, a back-end is created with
 902 ;; `org-export-create-backend' function.
 903 ;;
 904 ;; A named back-end can be registered with
 905 ;; `org-export-register-backend' function.  A registered back-end can
 906 ;; later be referred to by its name, with `org-export-get-backend'
 907 ;; function.  Also, such a back-end can become the parent of a derived
 908 ;; back-end from which slot values will be inherited by default.
 909 ;; `org-export-derived-backend-p' can check if a given back-end is
 910 ;; derived from a list of back-end names.
 911 ;;
 912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
 913 ;; `org-export-get-all-filters' return the full alist of transcoders,
 914 ;; options and filters, including those inherited from ancestors.
 915 ;;
 916 ;; At a higher level, `org-export-define-backend' is the standard way
 917 ;; to define an export back-end.  If the new back-end is similar to
 918 ;; a registered back-end, `org-export-define-derived-backend' may be
 919 ;; used instead.
 920 ;;
 921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
 922 ;; when a given back-end hasn't been registered yet.
 923
 924 (defstruct (org-export-backend (:constructor org-export-create-backend)
 925                                (:copier nil))
 926   name parent transcoders options filters blocks menu)
 927
 928 (defun org-export-get-backend (name)
 929   "Return export back-end named after NAME.
 930 NAME is a symbol.  Return nil if no such back-end is found."
 931   (catch 'found
 932     (dolist (b org-export-registered-backends)
 933       (when (eq (org-export-backend-name b) name)
 934         (throw 'found b)))))
 935
 936 (defun org-export-register-backend (backend)
 937   "Register BACKEND as a known export back-end.
 938 BACKEND is a structure with `org-export-backend' type."
 939   ;; Refuse to register an unnamed back-end.
 940   (unless (org-export-backend-name backend)
 941     (error "Cannot register a unnamed export back-end"))
 942   ;; Refuse to register a back-end with an unknown parent.
 943   (let ((parent (org-export-backend-parent backend)))
 944     (when (and parent (not (org-export-get-backend parent)))
 945       (error "Cannot use unknown \"%s\" back-end as a parent" parent)))
 946   ;; Register dedicated export blocks in the parser.
 947   (dolist (name (org-export-backend-blocks backend))
 948     (add-to-list 'org-element-block-name-alist
 949                  (cons name 'org-element-export-block-parser)))
 950   ;; If a back-end with the same name as BACKEND is already
 951   ;; registered, replace it with BACKEND.  Otherwise, simply add
 952   ;; BACKEND to the list of registered back-ends.
 953   (let ((old (org-export-get-backend (org-export-backend-name backend))))
 954     (if old (setcar (memq old org-export-registered-backends) backend)
 955       (push backend org-export-registered-backends))))
 956
 957 (defun org-export-barf-if-invalid-backend (backend)
 958   "Signal an error if BACKEND isn't defined."
 959   (unless (org-export-backend-p backend)
 960     (error "Unknown \"%s\" back-end: Aborting export" backend)))
 961
 962 (defun org-export-derived-backend-p (backend &rest backends)
 963   "Non-nil if BACKEND is derived from one of BACKENDS.
 964 BACKEND is an export back-end, as returned by, e.g.,
 965 `org-export-create-backend', or a symbol referring to
 966 a registered back-end.  BACKENDS is constituted of symbols."
 967   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
 968   (when backend
 969     (catch 'exit
 970       (while (org-export-backend-parent backend)
 971         (when (memq (org-export-backend-name backend) backends)
 972           (throw 'exit t))
 973         (setq backend
 974               (org-export-get-backend (org-export-backend-parent backend))))
 975       (memq (org-export-backend-name backend) backends))))
 976
 977 (defun org-export-get-all-transcoders (backend)
 978   "Return full translation table for BACKEND.
 979
 980 BACKEND is an export back-end, as return by, e.g,,
 981 `org-export-create-backend'.  Return value is an alist where
 982 keys are element or object types, as symbols, and values are
 983 transcoders.
 984
 985 Unlike to `org-export-backend-transcoders', this function
 986 also returns transcoders inherited from parent back-ends,
 987 if any."
 988   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
 989   (when backend
 990     (let ((transcoders (org-export-backend-transcoders backend))
 991           parent)
 992       (while (setq parent (org-export-backend-parent backend))
 993         (setq backend (org-export-get-backend parent))
 994         (setq transcoders
 995               (append transcoders (org-export-backend-transcoders backend))))
 996       transcoders)))
 997
 998 (defun org-export-get-all-options (backend)
 999   "Return export options for BACKEND.
1000
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'.  See `org-export-options-alist'
1003 for the shape of the return value.
1004
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1007   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
1008   (when backend
1009     (let ((options (org-export-backend-options backend))
1010           parent)
1011       (while (setq parent (org-export-backend-parent backend))
1012         (setq backend (org-export-get-backend parent))
1013         (setq options (append options (org-export-backend-options backend))))
1014       options)))
1015
1016 (defun org-export-get-all-filters (backend)
1017   "Return complete list of filters for BACKEND.
1018
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'.  Return value is an alist where
1021 keys are symbols and values lists of functions.
1022
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1025   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
1026   (when backend
1027     (let ((filters (org-export-backend-filters backend))
1028           parent)
1029       (while (setq parent (org-export-backend-parent backend))
1030         (setq backend (org-export-get-backend parent))
1031         (setq filters (append filters (org-export-backend-filters backend))))
1032       filters)))
1033
1034 (defun org-export-define-backend (backend transcoders &rest body)
1035   "Define a new back-end BACKEND.
1036
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1039
1040 These functions should return a string without any trailing
1041 space, or nil.  They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1044
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved).  They also always end
1047 with a single newline character.
1048
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end.  The same will happen if the function
1052 returns the nil value.  If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1055
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1059
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body.  It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options.  A function associated to `template'
1064 will not be applied if export has option \"body-only\".
1065 A function associated to `inner-template' is always applied.
1066
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object.  It must accept two
1069 arguments: the text string and the information channel.  It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1072
1073 BODY can start with pre-defined keyword arguments.  The following
1074 keywords are understood:
1075
1076   :export-block
1077
1078     String, or list of strings, representing block names that
1079     will not be parsed.  This is used to specify blocks that will
1080     contain raw code specific to the back-end.  These blocks
1081     still have to be handled by the relative `export-block' type
1082     translator.
1083
1084   :filters-alist
1085
1086     Alist between filters and function, or list of functions,
1087     specific to the back-end.  See `org-export-filters-alist' for
1088     a list of all allowed filters.  Filters defined here
1089     shouldn't make a back-end test, as it may prevent back-ends
1090     derived from this one to behave properly.
1091
1092   :menu-entry
1093
1094     Menu entry for the export dispatcher.  It should be a list
1095     like:
1096
1097       '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1098
1099     where :
1100
1101       KEY is a free character selecting the back-end.
1102
1103       DESCRIPTION-OR-ORDINAL is either a string or a number.
1104
1105       If it is a string, is will be used to name the back-end in
1106       its menu entry.  If it is a number, the following menu will
1107       be displayed as a sub-menu of the back-end with the same
1108       KEY.  Also, the number will be used to determine in which
1109       order such sub-menus will appear (lowest first).
1110
1111       ACTION-OR-MENU is either a function or an alist.
1112
1113       If it is an action, it will be called with four
1114       arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115       BODY-ONLY.  See `org-export-as' for further explanations on
1116       some of them.
1117
1118       If it is an alist, associations should follow the
1119       pattern:
1120
1121         '(KEY DESCRIPTION ACTION)
1122
1123       where KEY, DESCRIPTION and ACTION are described above.
1124
1125     Valid values include:
1126
1127       '(?m \"My Special Back-end\" my-special-export-function)
1128
1129       or
1130
1131       '(?l \"Export to LaTeX\"
1132            \(?p \"As PDF file\" org-latex-export-to-pdf)
1133            \(?o \"As PDF file and open\"
1134                \(lambda (a s v b)
1135                  \(if a (org-latex-export-to-pdf t s v b)
1136                    \(org-open-file
1137                     \(org-latex-export-to-pdf nil s v b)))))))
1138
1139       or the following, which will be added to the previous
1140       sub-menu,
1141
1142       '(?l 1
1143           \((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex)
1144            \(?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf)))
1145
1146   :options-alist
1147
1148     Alist between back-end specific properties introduced in
1149     communication channel and how their value are acquired.  See
1150     `org-export-options-alist' for more information about
1151     structure of the values."
1152   (declare (indent 1))
1153   (let (blocks filters menu-entry options contents)
1154     (while (keywordp (car body))
1155       (let ((keyword (pop body)))
1156         (case keyword
1157           (:export-block (let ((names (pop body)))
1158                            (setq blocks (if (consp names) (mapcar 'upcase names)
1159                                           (list (upcase names))))))
1160           (:filters-alist (setq filters (pop body)))
1161           (:menu-entry (setq menu-entry (pop body)))
1162           (:options-alist (setq options (pop body)))
1163           (t (error "Unknown keyword: %s" keyword)))))
1164     (org-export-register-backend
1165      (org-export-create-backend :name backend
1166                                 :transcoders transcoders
1167                                 :options options
1168                                 :filters filters
1169                                 :blocks blocks
1170                                 :menu menu-entry))))
1171
1172 (defun org-export-define-derived-backend (child parent &rest body)
1173   "Create a new back-end as a variant of an existing one.
1174
1175 CHILD is the name of the derived back-end.  PARENT is the name of
1176 the parent back-end.
1177
1178 BODY can start with pre-defined keyword arguments.  The following
1179 keywords are understood:
1180
1181   :export-block
1182
1183     String, or list of strings, representing block names that
1184     will not be parsed.  This is used to specify blocks that will
1185     contain raw code specific to the back-end.  These blocks
1186     still have to be handled by the relative `export-block' type
1187     translator.
1188
1189   :filters-alist
1190
1191     Alist of filters that will overwrite or complete filters
1192     defined in PARENT back-end.  See `org-export-filters-alist'
1193     for a list of allowed filters.
1194
1195   :menu-entry
1196
1197     Menu entry for the export dispatcher.  See
1198     `org-export-define-backend' for more information about the
1199     expected value.
1200
1201   :options-alist
1202
1203     Alist of back-end specific properties that will overwrite or
1204     complete those defined in PARENT back-end.  Refer to
1205     `org-export-options-alist' for more information about
1206     structure of the values.
1207
1208   :translate-alist
1209
1210     Alist of element and object types and transcoders that will
1211     overwrite or complete transcode table from PARENT back-end.
1212     Refer to `org-export-define-backend' for detailed information
1213     about transcoders.
1214
1215 As an example, here is how one could define \"my-latex\" back-end
1216 as a variant of `latex' back-end with a custom template function:
1217
1218   \(org-export-define-derived-backend 'my-latex 'latex
1219      :translate-alist '((template . my-latex-template-fun)))
1220
1221 The back-end could then be called with, for example:
1222
1223   \(org-export-to-buffer 'my-latex \"*Test my-latex*\")"
1224   (declare (indent 2))
1225   (let (blocks filters menu-entry options transcoders contents)
1226     (while (keywordp (car body))
1227       (let ((keyword (pop body)))
1228         (case keyword
1229           (:export-block (let ((names (pop body)))
1230                            (setq blocks (if (consp names) (mapcar 'upcase names)
1231                                           (list (upcase names))))))
1232           (:filters-alist (setq filters (pop body)))
1233           (:menu-entry (setq menu-entry (pop body)))
1234           (:options-alist (setq options (pop body)))
1235           (:translate-alist (setq transcoders (pop body)))
1236           (t (error "Unknown keyword: %s" keyword)))))
1237     (org-export-register-backend
1238      (org-export-create-backend :name child
1239                                 :parent parent
1240                                 :transcoders transcoders
1241                                 :options options
1242                                 :filters filters
1243                                 :blocks blocks
1244                                 :menu menu-entry))))
1245
1246
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties.  They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;;    the process, out of the original buffer and configuration.
1255 ;;    Collecting them is handled by `org-export-get-environment'
1256 ;;    function.
1257 ;;
1258 ;;    Most environment options are defined through the
1259 ;;    `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;;    just before export, by `org-export-collect-tree-properties'.
1263
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data.  They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'.  It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;;  The internal functions doing the retrieval are:
1282 ;;  `org-export--get-global-options',
1283 ;;  `org-export--get-buffer-attributes',
1284 ;;  `org-export--parse-option-keyword',
1285 ;;  `org-export--get-subtree-options' and
1286 ;;  `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1291
1292 (defun org-export-get-environment (&optional backend subtreep ext-plist)
1293   "Collect export options from the current buffer.
1294
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1297
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1300
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304   ;; First install #+BIND variables since these must be set before
1305   ;; global options are read.
1306   (dolist (pair (org-export--list-bound-variables))
1307     (org-set-local (car pair) (nth 1 pair)))
1308   ;; Get and prioritize export options...
1309   (org-combine-plists
1310    ;; ... from global variables...
1311    (org-export--get-global-options backend)
1312    ;; ... from an external property list...
1313    ext-plist
1314    ;; ... from in-buffer settings...
1315    (org-export--get-inbuffer-options backend)
1316    ;; ... and from subtree, when appropriate.
1317    (and subtreep (org-export--get-subtree-options backend))
1318    ;; Eventually add misc. properties.
1319    (list
1320     :back-end
1321     backend
1322     :translate-alist (org-export-get-all-transcoders backend)
1323     :footnote-definition-alist
1324     ;; Footnotes definitions must be collected in the original
1325     ;; buffer, as there's no insurance that they will still be in
1326     ;; the parse tree, due to possible narrowing.
1327     (let (alist)
1328       (org-with-wide-buffer
1329        (goto-char (point-min))
1330        (while (re-search-forward org-footnote-re nil t)
1331          (backward-char)
1332          (let ((fn (save-match-data (org-element-context))))
1333            (case (org-element-type fn)
1334              (footnote-definition
1335               (push
1336                (cons (org-element-property :label fn)
1337                      (let ((cbeg (org-element-property :contents-begin fn)))
1338                        (when cbeg
1339                          (org-element--parse-elements
1340                           cbeg (org-element-property :contents-end fn)
1341                           nil nil nil nil (list 'org-data nil)))))
1342                alist))
1343              (footnote-reference
1344               (let ((label (org-element-property :label fn))
1345                     (cbeg (org-element-property :contents-begin fn)))
1346                 (when (and label cbeg
1347                            (eq (org-element-property :type fn) 'inline))
1348                   (push
1349                    (cons label
1350                          (org-element-parse-secondary-string
1351                           (buffer-substring
1352                            cbeg (org-element-property :contents-end fn))
1353                           (org-element-restriction 'footnote-reference)))
1354                    alist)))))))
1355        alist))
1356     :id-alist
1357     ;; Collect id references.
1358     (let (alist)
1359       (org-with-wide-buffer
1360        (goto-char (point-min))
1361        (while (re-search-forward "\\[\\[id:\\S-+?\\]" nil t)
1362          (let ((link (org-element-context)))
1363            (when (eq (org-element-type link) 'link)
1364              (let* ((id (org-element-property :path link))
1365                     (file (car (org-id-find id))))
1366                (when file
1367                  (push (cons id (file-relative-name file)) alist)))))))
1368       alist))))
1369
1370 (defun org-export--parse-option-keyword (options &optional backend)
1371   "Parse an OPTIONS line and return values as a plist.
1372 Optional argument BACKEND is an export back-end, as returned by,
1373 e.g., `org-export-create-backend'.  It specifies which back-end
1374 specific items to read, if any."
1375   (let ((all
1376          (mapcar
1377           (lambda (o) (cons (nth 2 o) (car o)))
1378           ;; Priority is given to back-end specific options.
1379           (append (and backend (org-export-get-all-options backend))
1380                   org-export-options-alist)))
1381         (start)
1382         plist)
1383     (while (string-match "\\(.+?\\):\\((.*?)\\|\\S-*\\)[ \t\n]*" options start)
1384       (setq start (match-end 0))
1385       (let ((property (cdr (assoc-string (match-string 1 options) all t))))
1386         (when property
1387           (setq plist
1388                 (plist-put plist property (read (match-string 2 options)))))))
1389     plist))
1390
1391 (defun org-export--get-subtree-options (&optional backend)
1392   "Get export options in subtree at point.
1393 Optional argument BACKEND is an export back-end, as returned by,
1394 e.g., `org-export-create-backend'.  It specifies back-end used
1395 for export.  Return options as a plist."
1396   ;; For each buffer keyword, create a headline property setting the
1397   ;; same property in communication channel.  The name for the
1398   ;; property is the keyword with "EXPORT_" appended to it.
1399   (org-with-wide-buffer
1400    (let (plist
1401          ;; Look for both general keywords and back-end specific
1402          ;; options, with priority given to the latter.
1403          (options (append (and backend (org-export-get-all-options backend))
1404                           org-export-options-alist)))
1405      ;; Make sure point is at a heading.
1406      (if (org-at-heading-p) (org-up-heading-safe) (org-back-to-heading t))
1407      ;; Take care of EXPORT_TITLE.  If it isn't defined, use
1408      ;; headline's title (with no todo keyword, priority cookie or
1409      ;; tag) as its fallback value.
1410      (let ((title (or (org-entry-get (point) "EXPORT_TITLE")
1411                       (progn (looking-at org-complex-heading-regexp)
1412                              (org-match-string-no-properties 4)))))
1413        (setq plist
1414              (plist-put
1415               plist :title
1416               (if (eq (nth 4 (assq :title options)) 'parse)
1417                   (org-element-parse-secondary-string
1418                    title (org-element-restriction 'keyword))
1419                 title))))
1420      ;; EXPORT_OPTIONS are parsed in a non-standard way.
1421      (let ((o (org-entry-get (point) "EXPORT_OPTIONS")))
1422        (when o
1423          (setq plist
1424                (nconc plist (org-export--parse-option-keyword o backend)))))
1425      ;; Handle other keywords.  TITLE keyword is excluded as it has
1426      ;; been handled already.  Then return PLIST.
1427      (let ((seen '("TITLE")))
1428        (dolist (option options plist)
1429          (let ((property (car option))
1430                (keyword (nth 1 option)))
1431            (when (and keyword (not (member keyword seen)))
1432              (let* ((subtree-prop (concat "EXPORT_" keyword))
1433                     (value (org-entry-get (point) subtree-prop)))
1434                (push keyword seen)
1435                (when (and value (not (plist-member plist property)))
1436                  (setq plist
1437                        (plist-put
1438                         plist
1439                         property
1440                         (case (nth 4 option)
1441                           (parse
1442                            (org-element-parse-secondary-string
1443                             value (org-element-restriction 'keyword)))
1444                           (split (org-split-string value))
1445                           (t value)))))))))))))
1446
1447 (defun org-export--get-inbuffer-options (&optional backend)
1448   "Return current buffer export options, as a plist.
1449
1450 Optional argument BACKEND, when non-nil, is an export back-end,
1451 as returned by, e.g., `org-export-create-backend'.  It specifies
1452 which back-end specific options should also be read in the
1453 process.
1454
1455 Assume buffer is in Org mode.  Narrowing, if any, is ignored."
1456   (let* (plist
1457          get-options                    ; For byte-compiler.
1458          (case-fold-search t)
1459          (options (append
1460                    ;; Priority is given to back-end specific options.
1461                    (and backend (org-export-get-all-options backend))
1462                    org-export-options-alist))
1463          (regexp (format "^[ \t]*#\\+%s:"
1464                          (regexp-opt (nconc (delq nil (mapcar #'cadr options))
1465                                             org-export-special-keywords))))
1466          (find-properties
1467           (lambda (keyword)
1468             ;; Return all properties associated to KEYWORD.
1469             (let (properties)
1470               (dolist (option options properties)
1471                 (when (equal (nth 1 option) keyword)
1472                   (pushnew (car option) properties))))))
1473          to-parse
1474          (get-options
1475           (lambda (&optional files plist)
1476             ;; Recursively read keywords in buffer.  FILES is a list
1477             ;; of files read so far.  PLIST is the current property
1478             ;; list obtained.
1479             (org-with-wide-buffer
1480              (goto-char (point-min))
1481              (while (re-search-forward regexp nil t)
1482                (let ((element (org-element-at-point)))
1483                  (when (eq (org-element-type element) 'keyword)
1484                    (let ((key (org-element-property :key element))
1485                          (val (org-element-property :value element)))
1486                      (cond
1487                       ;; Options in `org-export-special-keywords'.
1488                       ((equal key "SETUPFILE")
1489                        (let ((file (expand-file-name
1490                                     (org-remove-double-quotes (org-trim val)))))
1491                          ;; Avoid circular dependencies.
1492                          (unless (member file files)
1493                            (with-temp-buffer
1494                              (insert (org-file-contents file 'noerror))
1495                              (let ((org-inhibit-startup t)) (org-mode))
1496                              (setq plist (funcall get-options
1497                                                   (cons file files) plist))))))
1498                       ((equal key "OPTIONS")
1499                        (setq plist
1500                              (org-combine-plists
1501                               plist
1502                               (org-export--parse-option-keyword val backend))))
1503                       ((equal key "FILETAGS")
1504                        (setq plist
1505                              (org-combine-plists
1506                               plist
1507                               (list :filetags
1508                                     (org-uniquify
1509                                      (append (org-split-string val ":")
1510                                              (plist-get plist :filetags)))))))
1511                       (t
1512                        ;; Options in `org-export-options-alist'.
1513                        (dolist (property (funcall find-properties key))
1514                          (setq
1515                           plist
1516                           (plist-put
1517                            plist property
1518                            ;; Handle value depending on specified
1519                            ;; BEHAVIOR.
1520                            (case (nth 4 (assq property options))
1521                              (parse
1522                               (unless (memq property to-parse)
1523                                 (push property to-parse))
1524                               ;; Even if `parse' implies `space'
1525                               ;; behavior, we separate line with "\n"
1526                               ;; so as to preserve line-breaks.
1527                               ;; However, empty lines are forbidden
1528                               ;; since `parse' doesn't allow more than
1529                               ;; one paragraph.
1530                               (let ((old (plist-get plist property)))
1531                                 (cond ((not (org-string-nw-p val)) old)
1532                                       (old (concat old "\n" val))
1533                                       (t val))))
1534                              (space
1535                               (if (not (plist-get plist property))
1536                                   (org-trim val)
1537                                 (concat (plist-get plist property)
1538                                         " "
1539                                         (org-trim val))))
1540                              (newline
1541                               (org-trim
1542                                (concat (plist-get plist property)
1543                                        "\n"
1544                                        (org-trim val))))
1545                              (split `(,@(plist-get plist property)
1546                                       ,@(org-split-string val)))
1547                              ((t) val)
1548                              (otherwise
1549                               (if (not (plist-member plist property)) val
1550                                 (plist-get plist property)))))))))))))
1551              plist))))
1552     ;; Read options in the current buffer and return value.
1553     (let ((options (funcall get-options
1554                             (and buffer-file-name (list buffer-file-name))
1555                             nil)))
1556       ;; Parse properties in TO-PARSE.  Remove newline characters not
1557       ;; involved in line breaks to simulate `space' behaviour.
1558       ;; Finally return options.
1559       (dolist (p to-parse options)
1560         (let ((value (org-element-parse-secondary-string
1561                       (plist-get options p)
1562                       (org-element-restriction 'keyword))))
1563           (org-element-map value 'plain-text
1564             (lambda (s)
1565               (org-element-set-element
1566                s (replace-regexp-in-string "\n" " " s))))
1567           (setq options (plist-put options p value)))))))
1568
1569 (defun org-export--get-buffer-attributes ()
1570   "Return properties related to buffer attributes, as a plist."
1571   (list :input-buffer (buffer-name (buffer-base-buffer))
1572         :input-file (buffer-file-name (buffer-base-buffer))))
1573
1574 (defun org-export--get-global-options (&optional backend)
1575   "Return global export options as a plist.
1576 Optional argument BACKEND, if non-nil, is an export back-end, as
1577 returned by, e.g., `org-export-create-backend'.  It specifies
1578 which back-end specific export options should also be read in the
1579 process."
1580   (let (plist
1581         ;; Priority is given to back-end specific options.
1582         (all (append (and backend (org-export-get-all-options backend))
1583                      org-export-options-alist)))
1584     (dolist (cell all plist)
1585       (let ((prop (car cell)))
1586         (unless (plist-member plist prop)
1587           (setq plist
1588                 (plist-put
1589                  plist
1590                  prop
1591                  ;; Evaluate default value provided.
1592                  (let ((value (eval (nth 3 cell))))
1593                    (if (eq (nth 4 cell) 'parse)
1594                        (org-element-parse-secondary-string
1595                         value (org-element-restriction 'keyword))
1596                      value)))))))))
1597
1598 (defun org-export--list-bound-variables ()
1599   "Return variables bound from BIND keywords in current buffer.
1600 Also look for BIND keywords in setup files.  The return value is
1601 an alist where associations are (VARIABLE-NAME VALUE)."
1602   (when org-export-allow-bind-keywords
1603     (let* (collect-bind                 ; For byte-compiler.
1604            (collect-bind
1605             (lambda (files alist)
1606               ;; Return an alist between variable names and their
1607               ;; value.  FILES is a list of setup files names read so
1608               ;; far, used to avoid circular dependencies.  ALIST is
1609               ;; the alist collected so far.
1610               (let ((case-fold-search t))
1611                 (org-with-wide-buffer
1612                  (goto-char (point-min))
1613                  (while (re-search-forward
1614                          "^[ \t]*#\\+\\(BIND\\|SETUPFILE\\):" nil t)
1615                    (let ((element (org-element-at-point)))
1616                      (when (eq (org-element-type element) 'keyword)
1617                        (let ((val (org-element-property :value element)))
1618                          (if (equal (org-element-property :key element) "BIND")
1619                              (push (read (format "(%s)" val)) alist)
1620                            ;; Enter setup file.
1621                            (let ((file (expand-file-name
1622                                         (org-remove-double-quotes val))))
1623                              (unless (member file files)
1624                                (with-temp-buffer
1625                                  (let ((org-inhibit-startup t)) (org-mode))
1626                                  (insert (org-file-contents file 'noerror))
1627                                  (setq alist
1628                                        (funcall collect-bind
1629                                                 (cons file files)
1630                                                 alist))))))))))
1631                  alist)))))
1632       ;; Return value in appropriate order of appearance.
1633       (nreverse (funcall collect-bind nil nil)))))
1634
1635 ;; defsubst org-export-get-parent must be defined before first use,
1636 ;; was originally defined in the topology section
1637
1638 (defsubst org-export-get-parent (blob)
1639   "Return BLOB parent or nil.
1640 BLOB is the element or object considered."
1641   (org-element-property :parent blob))
1642
1643 ;;;; Tree Properties
1644 ;;
1645 ;; Tree properties are information extracted from parse tree.  They
1646 ;; are initialized at the beginning of the transcoding process by
1647 ;; `org-export-collect-tree-properties'.
1648 ;;
1649 ;; Dedicated functions focus on computing the value of specific tree
1650 ;; properties during initialization.  Thus,
1651 ;; `org-export--populate-ignore-list' lists elements and objects that
1652 ;; should be skipped during export, `org-export--get-min-level' gets
1653 ;; the minimal exportable level, used as a basis to compute relative
1654 ;; level for headlines.  Eventually
1655 ;; `org-export--collect-headline-numbering' builds an alist between
1656 ;; headlines and their numbering.
1657
1658 (defun org-export-collect-tree-properties (data info)
1659   "Extract tree properties from parse tree.
1660
1661 DATA is the parse tree from which information is retrieved.  INFO
1662 is a list holding export options.
1663
1664 Following tree properties are set or updated:
1665
1666 `:exported-data' Hash table used to memoize results from
1667                  `org-export-data'.
1668
1669 `:footnote-definition-alist' List of footnotes definitions in
1670                    original buffer and current parse tree.
1671
1672 `:headline-offset' Offset between true level of headlines and
1673                    local level.  An offset of -1 means a headline
1674                    of level 2 should be considered as a level
1675                    1 headline in the context.
1676
1677 `:headline-numbering' Alist of all headlines as key an the
1678                       associated numbering as value.
1679
1680 Return updated plist."
1681   ;; Install the parse tree in the communication channel.
1682   (setq info (plist-put info :parse-tree data))
1683   ;; Compute `:headline-offset' in order to be able to use
1684   ;; `org-export-get-relative-level'.
1685   (setq info
1686         (plist-put info
1687                    :headline-offset
1688                    (- 1 (org-export--get-min-level data info))))
1689   ;; Footnote definitions in parse tree override those stored in
1690   ;; `:footnote-definition-alist'.  This way, any change to
1691   ;; a definition in the parse tree (e.g., through a parse tree
1692   ;; filter) propagates into the alist.
1693   (let ((defs (plist-get info :footnote-definition-alist)))
1694     (org-element-map data '(footnote-definition footnote-reference)
1695       (lambda (fn)
1696         (cond ((eq (org-element-type fn) 'footnote-definition)
1697                (push (cons (org-element-property :label fn)
1698                            (append '(org-data nil) (org-element-contents fn)))
1699                      defs))
1700               ((eq (org-element-property :type fn) 'inline)
1701                (push (cons (org-element-property :label fn)
1702                            (org-element-contents fn))
1703                      defs)))))
1704     (setq info (plist-put info :footnote-definition-alist defs)))
1705   ;; Properties order doesn't matter: get the rest of the tree
1706   ;; properties.
1707   (nconc
1708    `(:headline-numbering ,(org-export--collect-headline-numbering data info)
1709      :exported-data ,(make-hash-table :test 'eq :size 4001))
1710    info))
1711
1712 (defun org-export--get-min-level (data options)
1713   "Return minimum exportable headline's level in DATA.
1714 DATA is parsed tree as returned by `org-element-parse-buffer'.
1715 OPTIONS is a plist holding export options."
1716   (catch 'exit
1717     (let ((min-level 10000))
1718       (mapc
1719        (lambda (blob)
1720          (when (and (eq (org-element-type blob) 'headline)
1721                     (not (org-element-property :footnote-section-p blob))
1722                     (not (memq blob (plist-get options :ignore-list))))
1723            (setq min-level (min (org-element-property :level blob) min-level)))
1724          (when (= min-level 1) (throw 'exit 1)))
1725        (org-element-contents data))
1726       ;; If no headline was found, for the sake of consistency, set
1727       ;; minimum level to 1 nonetheless.
1728       (if (= min-level 10000) 1 min-level))))
1729
1730 (defun org-export--collect-headline-numbering (data options)
1731   "Return numbering of all exportable, numbered headlines in a parse tree.
1732
1733 DATA is the parse tree.  OPTIONS is the plist holding export
1734 options.
1735
1736 Return an alist whose key is a headline and value is its
1737 associated numbering \(in the shape of a list of numbers\) or nil
1738 for a footnotes section."
1739   (let ((numbering (make-vector org-export-max-depth 0)))
1740     (org-element-map data 'headline
1741       (lambda (headline)
1742         (when (and (org-export-numbered-headline-p headline options)
1743                    (not (org-element-property :footnote-section-p headline)))
1744           (let ((relative-level
1745                  (1- (org-export-get-relative-level headline options))))
1746             (cons
1747              headline
1748              (loop for n across numbering
1749                    for idx from 0 to org-export-max-depth
1750                    when (< idx relative-level) collect n
1751                    when (= idx relative-level) collect (aset numbering idx (1+ n))
1752                    when (> idx relative-level) do (aset numbering idx 0))))))
1753       options)))
1754
1755 (defun org-export--selected-trees (data info)
1756   "List headlines and inlinetasks with a select tag in their tree.
1757 DATA is parsed data as returned by `org-element-parse-buffer'.
1758 INFO is a plist holding export options."
1759   (let* (selected-trees
1760          walk-data                      ; For byte-compiler.
1761          (walk-data
1762           (function
1763            (lambda (data genealogy)
1764              (let ((type (org-element-type data)))
1765                (cond
1766                 ((memq type '(headline inlinetask))
1767                  (let ((tags (org-element-property :tags data)))
1768                    (if (loop for tag in (plist-get info :select-tags)
1769                              thereis (member tag tags))
1770                        ;; When a select tag is found, mark full
1771                        ;; genealogy and every headline within the tree
1772                        ;; as acceptable.
1773                        (setq selected-trees
1774                              (append
1775                               genealogy
1776                               (org-element-map data '(headline inlinetask)
1777                                 #'identity)
1778                               selected-trees))
1779                      ;; If at a headline, continue searching in tree,
1780                      ;; recursively.
1781                      (when (eq type 'headline)
1782                        (dolist (el (org-element-contents data))
1783                          (funcall walk-data el (cons data genealogy)))))))
1784                 ((or (eq type 'org-data)
1785                      (memq type org-element-greater-elements))
1786                  (dolist (el (org-element-contents data))
1787                    (funcall walk-data el genealogy)))))))))
1788     (funcall walk-data data nil)
1789     selected-trees))
1790
1791 (defun org-export--skip-p (blob options selected)
1792   "Non-nil when element or object BLOB should be skipped during export.
1793 OPTIONS is the plist holding export options.  SELECTED, when
1794 non-nil, is a list of headlines or inlinetasks belonging to
1795 a tree with a select tag."
1796   (case (org-element-type blob)
1797     (clock (not (plist-get options :with-clocks)))
1798     (drawer
1799      (let ((with-drawers-p (plist-get options :with-drawers)))
1800        (or (not with-drawers-p)
1801            (and (consp with-drawers-p)
1802                 ;; If `:with-drawers' value starts with `not', ignore
1803                 ;; every drawer whose name belong to that list.
1804                 ;; Otherwise, ignore drawers whose name isn't in that
1805                 ;; list.
1806                 (let ((name (org-element-property :drawer-name blob)))
1807                   (if (eq (car with-drawers-p) 'not)
1808                       (member-ignore-case name (cdr with-drawers-p))
1809                     (not (member-ignore-case name with-drawers-p))))))))
1810     (fixed-width (not (plist-get options :with-fixed-width)))
1811     ((footnote-definition footnote-reference)
1812      (not (plist-get options :with-footnotes)))
1813     ((headline inlinetask)
1814      (let ((with-tasks (plist-get options :with-tasks))
1815            (todo (org-element-property :todo-keyword blob))
1816            (todo-type (org-element-property :todo-type blob))
1817            (archived (plist-get options :with-archived-trees))
1818            (tags (org-element-property :tags blob)))
1819        (or
1820         (and (eq (org-element-type blob) 'inlinetask)
1821              (not (plist-get options :with-inlinetasks)))
1822         ;; Ignore subtrees with an exclude tag.
1823         (loop for k in (plist-get options :exclude-tags)
1824               thereis (member k tags))
1825         ;; When a select tag is present in the buffer, ignore any tree
1826         ;; without it.
1827         (and selected (not (memq blob selected)))
1828         ;; Ignore commented sub-trees.
1829         (org-element-property :commentedp blob)
1830         ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1831         (and (not archived) (org-element-property :archivedp blob))
1832         ;; Ignore tasks, if specified by `:with-tasks' property.
1833         (and todo
1834              (or (not with-tasks)
1835                  (and (memq with-tasks '(todo done))
1836                       (not (eq todo-type with-tasks)))
1837                  (and (consp with-tasks) (not (member todo with-tasks))))))))
1838     ((latex-environment latex-fragment) (not (plist-get options :with-latex)))
1839     (node-property
1840      (let ((properties-set (plist-get options :with-properties)))
1841        (cond ((null properties-set) t)
1842              ((consp properties-set)
1843               (not (member-ignore-case (org-element-property :key blob)
1844                                        properties-set))))))
1845     (planning (not (plist-get options :with-planning)))
1846     (property-drawer (not (plist-get options :with-properties)))
1847     (statistics-cookie (not (plist-get options :with-statistics-cookies)))
1848     (table (not (plist-get options :with-tables)))
1849     (table-cell
1850      (and (org-export-table-has-special-column-p
1851            (org-export-get-parent-table blob))
1852           (org-export-first-sibling-p blob options)))
1853     (table-row (org-export-table-row-is-special-p blob options))
1854     (timestamp
1855      ;; `:with-timestamps' only applies to isolated timestamps
1856      ;; objects, i.e. timestamp objects in a paragraph containing only
1857      ;; timestamps and whitespaces.
1858      (when (let ((parent (org-export-get-parent-element blob)))
1859              (and (memq (org-element-type parent) '(paragraph verse-block))
1860                   (not (org-element-map parent
1861                            (cons 'plain-text
1862                                  (remq 'timestamp org-element-all-objects))
1863                          (lambda (obj)
1864                            (or (not (stringp obj)) (org-string-nw-p obj)))
1865                          options t))))
1866        (case (plist-get options :with-timestamps)
1867          ((nil) t)
1868          (active
1869           (not (memq (org-element-property :type blob) '(active active-range))))
1870          (inactive
1871           (not (memq (org-element-property :type blob)
1872                      '(inactive inactive-range)))))))))
1873
1874 \f
1875 ;;; The Transcoder
1876 ;;
1877 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1878 ;; `org-element-parse-buffer') and transcodes it into a specified
1879 ;; back-end output.  It takes care of filtering out elements or
1880 ;; objects according to export options and organizing the output blank
1881 ;; lines and white space are preserved.  The function memoizes its
1882 ;; results, so it is cheap to call it within transcoders.
1883 ;;
1884 ;; It is possible to modify locally the back-end used by
1885 ;; `org-export-data' or even use a temporary back-end by using
1886 ;; `org-export-data-with-backend'.
1887 ;;
1888 ;; `org-export-transcoder' is an accessor returning appropriate
1889 ;; translator function for a given element or object.
1890
1891 (defun org-export-transcoder (blob info)
1892   "Return appropriate transcoder for BLOB.
1893 INFO is a plist containing export directives."
1894   (let ((type (org-element-type blob)))
1895     ;; Return contents only for complete parse trees.
1896     (if (eq type 'org-data) (lambda (blob contents info) contents)
1897       (let ((transcoder (cdr (assq type (plist-get info :translate-alist)))))
1898         (and (functionp transcoder) transcoder)))))
1899
1900 (defun org-export-data (data info)
1901   "Convert DATA into current back-end format.
1902
1903 DATA is a parse tree, an element or an object or a secondary
1904 string.  INFO is a plist holding export options.
1905
1906 Return a string."
1907   (or (gethash data (plist-get info :exported-data))
1908       (let* ((type (org-element-type data))
1909              (results
1910               (cond
1911                ;; Ignored element/object.
1912                ((memq data (plist-get info :ignore-list)) nil)
1913                ;; Plain text.
1914                ((eq type 'plain-text)
1915                 (org-export-filter-apply-functions
1916                  (plist-get info :filter-plain-text)
1917                  (let ((transcoder (org-export-transcoder data info)))
1918                    (if transcoder (funcall transcoder data info) data))
1919                  info))
1920                ;; Secondary string.
1921                ((not type)
1922                 (mapconcat (lambda (obj) (org-export-data obj info)) data ""))
1923                ;; Element/Object without contents or, as a special
1924                ;; case, headline with archive tag and archived trees
1925                ;; restricted to title only.
1926                ((or (not (org-element-contents data))
1927                     (and (eq type 'headline)
1928                          (eq (plist-get info :with-archived-trees) 'headline)
1929                          (org-element-property :archivedp data)))
1930                 (let ((transcoder (org-export-transcoder data info)))
1931                   (or (and (functionp transcoder)
1932                            (funcall transcoder data nil info))
1933                       ;; Export snippets never return a nil value so
1934                       ;; that white spaces following them are never
1935                       ;; ignored.
1936                       (and (eq type 'export-snippet) ""))))
1937                ;; Element/Object with contents.
1938                (t
1939                 (let ((transcoder (org-export-transcoder data info)))
1940                   (when transcoder
1941                     (let* ((greaterp (memq type org-element-greater-elements))
1942                            (objectp
1943                             (and (not greaterp)
1944                                  (memq type org-element-recursive-objects)))
1945                            (contents
1946                             (mapconcat
1947                              (lambda (element) (org-export-data element info))
1948                              (org-element-contents
1949                               (if (or greaterp objectp) data
1950                                 ;; Elements directly containing
1951                                 ;; objects must have their indentation
1952                                 ;; normalized first.
1953                                 (org-element-normalize-contents
1954                                  data
1955                                  ;; When normalizing contents of the
1956                                  ;; first paragraph in an item or
1957                                  ;; a footnote definition, ignore
1958                                  ;; first line's indentation: there is
1959                                  ;; none and it might be misleading.
1960                                  (when (eq type 'paragraph)
1961                                    (let ((parent (org-export-get-parent data)))
1962                                      (and
1963                                       (eq (car (org-element-contents parent))
1964                                           data)
1965                                       (memq (org-element-type parent)
1966                                             '(footnote-definition item))))))))
1967                              "")))
1968                       (funcall transcoder data
1969                                (if (not greaterp) contents
1970                                  (org-element-normalize-string contents))
1971                                info))))))))
1972         ;; Final result will be memoized before being returned.
1973         (puthash
1974          data
1975          (cond
1976           ((not results) "")
1977           ((memq type '(org-data plain-text nil)) results)
1978           ;; Append the same white space between elements or objects
1979           ;; as in the original buffer, and call appropriate filters.
1980           (t
1981            (let ((results
1982                   (org-export-filter-apply-functions
1983                    (plist-get info (intern (format ":filter-%s" type)))
1984                    (let ((post-blank (or (org-element-property :post-blank data)
1985                                          0)))
1986                      (if (memq type org-element-all-elements)
1987                          (concat (org-element-normalize-string results)
1988                                  (make-string post-blank ?\n))
1989                        (concat results (make-string post-blank ?\s))))
1990                    info)))
1991              results)))
1992          (plist-get info :exported-data)))))
1993
1994 (defun org-export-data-with-backend (data backend info)
1995   "Convert DATA into BACKEND format.
1996
1997 DATA is an element, an object, a secondary string or a string.
1998 BACKEND is a symbol.  INFO is a plist used as a communication
1999 channel.
2000
2001 Unlike to `org-export-with-backend', this function will
2002 recursively convert DATA using BACKEND translation table."
2003   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
2004   (org-export-data
2005    data
2006    ;; Set-up a new communication channel with translations defined in
2007    ;; BACKEND as the translate table and a new hash table for
2008    ;; memoization.
2009    (org-combine-plists
2010     info
2011     (list :back-end backend
2012           :translate-alist (org-export-get-all-transcoders backend)
2013           ;; Size of the hash table is reduced since this function
2014           ;; will probably be used on small trees.
2015           :exported-data (make-hash-table :test 'eq :size 401)))))
2016
2017 (defun org-export-expand (blob contents &optional with-affiliated)
2018   "Expand a parsed element or object to its original state.
2019
2020 BLOB is either an element or an object.  CONTENTS is its
2021 contents, as a string or nil.
2022
2023 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2024 keywords before output."
2025   (let ((type (org-element-type blob)))
2026     (concat (and with-affiliated (memq type org-element-all-elements)
2027                  (org-element--interpret-affiliated-keywords blob))
2028             (funcall (intern (format "org-element-%s-interpreter" type))
2029                      blob contents))))
2030
2031
2032 \f
2033 ;;; The Filter System
2034 ;;
2035 ;; Filters allow end-users to tweak easily the transcoded output.
2036 ;; They are the functional counterpart of hooks, as every filter in
2037 ;; a set is applied to the return value of the previous one.
2038 ;;
2039 ;; Every set is back-end agnostic.  Although, a filter is always
2040 ;; called, in addition to the string it applies to, with the back-end
2041 ;; used as argument, so it's easy for the end-user to add back-end
2042 ;; specific filters in the set.  The communication channel, as
2043 ;; a plist, is required as the third argument.
2044 ;;
2045 ;; From the developer side, filters sets can be installed in the
2046 ;; process with the help of `org-export-define-backend', which
2047 ;; internally stores filters as an alist.  Each association has a key
2048 ;; among the following symbols and a function or a list of functions
2049 ;; as value.
2050 ;;
2051 ;; - `:filter-options' applies to the property list containing export
2052 ;;   options.  Unlike to other filters, functions in this list accept
2053 ;;   two arguments instead of three: the property list containing
2054 ;;   export options and the back-end.  Users can set its value through
2055 ;;   `org-export-filter-options-functions' variable.
2056 ;;
2057 ;; - `:filter-parse-tree' applies directly to the complete parsed
2058 ;;   tree.  Users can set it through
2059 ;;   `org-export-filter-parse-tree-functions' variable.
2060 ;;
2061 ;; - `:filter-body' applies to the body of the output, before template
2062 ;;   translator chimes in.  Users can set it through
2063 ;;   `org-export-filter-body-functions' variable.
2064 ;;
2065 ;; - `:filter-final-output' applies to the final transcoded string.
2066 ;;   Users can set it with `org-export-filter-final-output-functions'
2067 ;;   variable.
2068 ;;
2069 ;; - `:filter-plain-text' applies to any string not recognized as Org
2070 ;;   syntax.  `org-export-filter-plain-text-functions' allows users to
2071 ;;   configure it.
2072 ;;
2073 ;; - `:filter-TYPE' applies on the string returned after an element or
2074 ;;   object of type TYPE has been transcoded.  A user can modify
2075 ;;   `org-export-filter-TYPE-functions' to install these filters.
2076 ;;
2077 ;; All filters sets are applied with
2078 ;; `org-export-filter-apply-functions' function.  Filters in a set are
2079 ;; applied in a LIFO fashion.  It allows developers to be sure that
2080 ;; their filters will be applied first.
2081 ;;
2082 ;; Filters properties are installed in communication channel with
2083 ;; `org-export-install-filters' function.
2084 ;;
2085 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2086 ;; `org-export-before-parsing-hook') are run at the beginning of the
2087 ;; export process and just before parsing to allow for heavy structure
2088 ;; modifications.
2089
2090
2091 ;;;; Hooks
2092
2093 (defvar org-export-before-processing-hook nil
2094   "Hook run at the beginning of the export process.
2095
2096 This is run before include keywords and macros are expanded and
2097 Babel code blocks executed, on a copy of the original buffer
2098 being exported.  Visibility and narrowing are preserved.  Point
2099 is at the beginning of the buffer.
2100
2101 Every function in this hook will be called with one argument: the
2102 back-end currently used, as a symbol.")
2103
2104 (defvar org-export-before-parsing-hook nil
2105   "Hook run before parsing an export buffer.
2106
2107 This is run after include keywords and macros have been expanded
2108 and Babel code blocks executed, on a copy of the original buffer
2109 being exported.  Visibility and narrowing are preserved.  Point
2110 is at the beginning of the buffer.
2111
2112 Every function in this hook will be called with one argument: the
2113 back-end currently used, as a symbol.")
2114
2115
2116 ;;;; Special Filters
2117
2118 (defvar org-export-filter-options-functions nil
2119   "List of functions applied to the export options.
2120 Each filter is called with two arguments: the export options, as
2121 a plist, and the back-end, as a symbol.  It must return
2122 a property list containing export options.")
2123
2124 (defvar org-export-filter-parse-tree-functions nil
2125   "List of functions applied to the parsed tree.
2126 Each filter is called with three arguments: the parse tree, as
2127 returned by `org-element-parse-buffer', the back-end, as
2128 a symbol, and the communication channel, as a plist.  It must
2129 return the modified parse tree to transcode.")
2130
2131 (defvar org-export-filter-plain-text-functions nil
2132   "List of functions applied to plain text.
2133 Each filter is called with three arguments: a string which
2134 contains no Org syntax, the back-end, as a symbol, and the
2135 communication channel, as a plist.  It must return a string or
2136 nil.")
2137
2138 (defvar org-export-filter-body-functions nil
2139   "List of functions applied to transcoded body.
2140 Each filter is called with three arguments: a string which
2141 contains no Org syntax, the back-end, as a symbol, and the
2142 communication channel, as a plist.  It must return a string or
2143 nil.")
2144
2145 (defvar org-export-filter-final-output-functions nil
2146   "List of functions applied to the transcoded string.
2147 Each filter is called with three arguments: the full transcoded
2148 string, the back-end, as a symbol, and the communication channel,
2149 as a plist.  It must return a string that will be used as the
2150 final export output.")
2151
2152
2153 ;;;; Elements Filters
2154
2155 (defvar org-export-filter-babel-call-functions nil
2156   "List of functions applied to a transcoded babel-call.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2159 channel, as a plist.  It must return a string or nil.")
2160
2161 (defvar org-export-filter-center-block-functions nil
2162   "List of functions applied to a transcoded center block.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2165 channel, as a plist.  It must return a string or nil.")
2166
2167 (defvar org-export-filter-clock-functions nil
2168   "List of functions applied to a transcoded clock.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2171 channel, as a plist.  It must return a string or nil.")
2172
2173 (defvar org-export-filter-diary-sexp-functions nil
2174   "List of functions applied to a transcoded diary-sexp.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2177 channel, as a plist.  It must return a string or nil.")
2178
2179 (defvar org-export-filter-drawer-functions nil
2180   "List of functions applied to a transcoded drawer.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2183 channel, as a plist.  It must return a string or nil.")
2184
2185 (defvar org-export-filter-dynamic-block-functions nil
2186   "List of functions applied to a transcoded dynamic-block.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2189 channel, as a plist.  It must return a string or nil.")
2190
2191 (defvar org-export-filter-example-block-functions nil
2192   "List of functions applied to a transcoded example-block.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2195 channel, as a plist.  It must return a string or nil.")
2196
2197 (defvar org-export-filter-export-block-functions nil
2198   "List of functions applied to a transcoded export-block.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2201 channel, as a plist.  It must return a string or nil.")
2202
2203 (defvar org-export-filter-fixed-width-functions nil
2204   "List of functions applied to a transcoded fixed-width.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2207 channel, as a plist.  It must return a string or nil.")
2208
2209 (defvar org-export-filter-footnote-definition-functions nil
2210   "List of functions applied to a transcoded footnote-definition.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2213 channel, as a plist.  It must return a string or nil.")
2214
2215 (defvar org-export-filter-headline-functions nil
2216   "List of functions applied to a transcoded headline.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2219 channel, as a plist.  It must return a string or nil.")
2220
2221 (defvar org-export-filter-horizontal-rule-functions nil
2222   "List of functions applied to a transcoded horizontal-rule.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2225 channel, as a plist.  It must return a string or nil.")
2226
2227 (defvar org-export-filter-inlinetask-functions nil
2228   "List of functions applied to a transcoded inlinetask.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2231 channel, as a plist.  It must return a string or nil.")
2232
2233 (defvar org-export-filter-item-functions nil
2234   "List of functions applied to a transcoded item.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2237 channel, as a plist.  It must return a string or nil.")
2238
2239 (defvar org-export-filter-keyword-functions nil
2240   "List of functions applied to a transcoded keyword.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2243 channel, as a plist.  It must return a string or nil.")
2244
2245 (defvar org-export-filter-latex-environment-functions nil
2246   "List of functions applied to a transcoded latex-environment.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2249 channel, as a plist.  It must return a string or nil.")
2250
2251 (defvar org-export-filter-node-property-functions nil
2252   "List of functions applied to a transcoded node-property.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2255 channel, as a plist.  It must return a string or nil.")
2256
2257 (defvar org-export-filter-paragraph-functions nil
2258   "List of functions applied to a transcoded paragraph.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2261 channel, as a plist.  It must return a string or nil.")
2262
2263 (defvar org-export-filter-plain-list-functions nil
2264   "List of functions applied to a transcoded plain-list.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2267 channel, as a plist.  It must return a string or nil.")
2268
2269 (defvar org-export-filter-planning-functions nil
2270   "List of functions applied to a transcoded planning.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2273 channel, as a plist.  It must return a string or nil.")
2274
2275 (defvar org-export-filter-property-drawer-functions nil
2276   "List of functions applied to a transcoded property-drawer.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2279 channel, as a plist.  It must return a string or nil.")
2280
2281 (defvar org-export-filter-quote-block-functions nil
2282   "List of functions applied to a transcoded quote block.
2283 Each filter is called with three arguments: the transcoded quote
2284 data, as a string, the back-end, as a symbol, and the
2285 communication channel, as a plist.  It must return a string or
2286 nil.")
2287
2288 (defvar org-export-filter-section-functions nil
2289   "List of functions applied to a transcoded section.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2292 channel, as a plist.  It must return a string or nil.")
2293
2294 (defvar org-export-filter-special-block-functions nil
2295   "List of functions applied to a transcoded special block.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2298 channel, as a plist.  It must return a string or nil.")
2299
2300 (defvar org-export-filter-src-block-functions nil
2301   "List of functions applied to a transcoded src-block.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2304 channel, as a plist.  It must return a string or nil.")
2305
2306 (defvar org-export-filter-table-functions nil
2307   "List of functions applied to a transcoded table.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2310 channel, as a plist.  It must return a string or nil.")
2311
2312 (defvar org-export-filter-table-cell-functions nil
2313   "List of functions applied to a transcoded table-cell.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2316 channel, as a plist.  It must return a string or nil.")
2317
2318 (defvar org-export-filter-table-row-functions nil
2319   "List of functions applied to a transcoded table-row.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2322 channel, as a plist.  It must return a string or nil.")
2323
2324 (defvar org-export-filter-verse-block-functions nil
2325   "List of functions applied to a transcoded verse block.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2328 channel, as a plist.  It must return a string or nil.")
2329
2330
2331 ;;;; Objects Filters
2332
2333 (defvar org-export-filter-bold-functions nil
2334   "List of functions applied to transcoded bold text.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2337 channel, as a plist.  It must return a string or nil.")
2338
2339 (defvar org-export-filter-code-functions nil
2340   "List of functions applied to transcoded code text.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2343 channel, as a plist.  It must return a string or nil.")
2344
2345 (defvar org-export-filter-entity-functions nil
2346   "List of functions applied to a transcoded entity.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2349 channel, as a plist.  It must return a string or nil.")
2350
2351 (defvar org-export-filter-export-snippet-functions nil
2352   "List of functions applied to a transcoded export-snippet.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2355 channel, as a plist.  It must return a string or nil.")
2356
2357 (defvar org-export-filter-footnote-reference-functions nil
2358   "List of functions applied to a transcoded footnote-reference.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2361 channel, as a plist.  It must return a string or nil.")
2362
2363 (defvar org-export-filter-inline-babel-call-functions nil
2364   "List of functions applied to a transcoded inline-babel-call.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2367 channel, as a plist.  It must return a string or nil.")
2368
2369 (defvar org-export-filter-inline-src-block-functions nil
2370   "List of functions applied to a transcoded inline-src-block.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2373 channel, as a plist.  It must return a string or nil.")
2374
2375 (defvar org-export-filter-italic-functions nil
2376   "List of functions applied to transcoded italic text.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2379 channel, as a plist.  It must return a string or nil.")
2380
2381 (defvar org-export-filter-latex-fragment-functions nil
2382   "List of functions applied to a transcoded latex-fragment.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2385 channel, as a plist.  It must return a string or nil.")
2386
2387 (defvar org-export-filter-line-break-functions nil
2388   "List of functions applied to a transcoded line-break.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2391 channel, as a plist.  It must return a string or nil.")
2392
2393 (defvar org-export-filter-link-functions nil
2394   "List of functions applied to a transcoded link.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2397 channel, as a plist.  It must return a string or nil.")
2398
2399 (defvar org-export-filter-radio-target-functions nil
2400   "List of functions applied to a transcoded radio-target.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2403 channel, as a plist.  It must return a string or nil.")
2404
2405 (defvar org-export-filter-statistics-cookie-functions nil
2406   "List of functions applied to a transcoded statistics-cookie.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2409 channel, as a plist.  It must return a string or nil.")
2410
2411 (defvar org-export-filter-strike-through-functions nil
2412   "List of functions applied to transcoded strike-through text.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2415 channel, as a plist.  It must return a string or nil.")
2416
2417 (defvar org-export-filter-subscript-functions nil
2418   "List of functions applied to a transcoded subscript.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2421 channel, as a plist.  It must return a string or nil.")
2422
2423 (defvar org-export-filter-superscript-functions nil
2424   "List of functions applied to a transcoded superscript.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2427 channel, as a plist.  It must return a string or nil.")
2428
2429 (defvar org-export-filter-target-functions nil
2430   "List of functions applied to a transcoded target.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2433 channel, as a plist.  It must return a string or nil.")
2434
2435 (defvar org-export-filter-timestamp-functions nil
2436   "List of functions applied to a transcoded timestamp.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2439 channel, as a plist.  It must return a string or nil.")
2440
2441 (defvar org-export-filter-underline-functions nil
2442   "List of functions applied to transcoded underline text.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2445 channel, as a plist.  It must return a string or nil.")
2446
2447 (defvar org-export-filter-verbatim-functions nil
2448   "List of functions applied to transcoded verbatim text.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2451 channel, as a plist.  It must return a string or nil.")
2452
2453
2454 ;;;; Filters Tools
2455 ;;
2456 ;; Internal function `org-export-install-filters' installs filters
2457 ;; hard-coded in back-ends (developer filters) and filters from global
2458 ;; variables (user filters) in the communication channel.
2459 ;;
2460 ;; Internal function `org-export-filter-apply-functions' takes care
2461 ;; about applying each filter in order to a given data.  It ignores
2462 ;; filters returning a nil value but stops whenever a filter returns
2463 ;; an empty string.
2464
2465 (defun org-export-filter-apply-functions (filters value info)
2466   "Call every function in FILTERS.
2467
2468 Functions are called with arguments VALUE, current export
2469 back-end's name and INFO.  A function returning a nil value will
2470 be skipped.  If it returns the empty string, the process ends and
2471 VALUE is ignored.
2472
2473 Call is done in a LIFO fashion, to be sure that developer
2474 specified filters, if any, are called first."
2475   (catch 'exit
2476     (let* ((backend (plist-get info :back-end))
2477            (backend-name (and backend (org-export-backend-name backend))))
2478       (dolist (filter filters value)
2479         (let ((result (funcall filter value backend-name info)))
2480           (cond ((not result) value)
2481                 ((equal value "") (throw 'exit nil))
2482                 (t (setq value result))))))))
2483
2484 (defun org-export-install-filters (info)
2485   "Install filters properties in communication channel.
2486 INFO is a plist containing the current communication channel.
2487 Return the updated communication channel."
2488   (let (plist)
2489     ;; Install user-defined filters with `org-export-filters-alist'
2490     ;; and filters already in INFO (through ext-plist mechanism).
2491     (mapc (lambda (p)
2492             (let* ((prop (car p))
2493                    (info-value (plist-get info prop))
2494                    (default-value (symbol-value (cdr p))))
2495               (setq plist
2496                     (plist-put plist prop
2497                                ;; Filters in INFO will be called
2498                                ;; before those user provided.
2499                                (append (if (listp info-value) info-value
2500                                          (list info-value))
2501                                        default-value)))))
2502           org-export-filters-alist)
2503     ;; Prepend back-end specific filters to that list.
2504     (mapc (lambda (p)
2505             ;; Single values get consed, lists are appended.
2506             (let ((key (car p)) (value (cdr p)))
2507               (when value
2508                 (setq plist
2509                       (plist-put
2510                        plist key
2511                        (if (atom value) (cons value (plist-get plist key))
2512                          (append value (plist-get plist key))))))))
2513           (org-export-get-all-filters (plist-get info :back-end)))
2514     ;; Return new communication channel.
2515     (org-combine-plists info plist)))
2516
2517
2518 \f
2519 ;;; Core functions
2520 ;;
2521 ;; This is the room for the main function, `org-export-as', along with
2522 ;; its derivative, `org-export-string-as'.
2523 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2524 ;; function should be added to kill ring.
2525 ;;
2526 ;; Note that `org-export-as' doesn't really parse the current buffer,
2527 ;; but a copy of it (with the same buffer-local variables and
2528 ;; visibility), where macros and include keywords are expanded and
2529 ;; Babel blocks are executed, if appropriate.
2530 ;; `org-export-with-buffer-copy' macro prepares that copy.
2531 ;;
2532 ;; File inclusion is taken care of by
2533 ;; `org-export-expand-include-keyword' and
2534 ;; `org-export--prepare-file-contents'.  Structure wise, including
2535 ;; a whole Org file in a buffer often makes little sense.  For
2536 ;; example, if the file contains a headline and the include keyword
2537 ;; was within an item, the item should contain the headline.  That's
2538 ;; why file inclusion should be done before any structure can be
2539 ;; associated to the file, that is before parsing.
2540 ;;
2541 ;; `org-export-insert-default-template' is a command to insert
2542 ;; a default template (or a back-end specific template) at point or in
2543 ;; current subtree.
2544
2545 (defun org-export-copy-buffer ()
2546   "Return a copy of the current buffer.
2547 The copy preserves Org buffer-local variables, visibility and
2548 narrowing."
2549   (let ((copy-buffer-fun (org-export--generate-copy-script (current-buffer)))
2550         (new-buf (generate-new-buffer (buffer-name))))
2551     (with-current-buffer new-buf
2552       (funcall copy-buffer-fun)
2553       (set-buffer-modified-p nil))
2554     new-buf))
2555
2556 (defmacro org-export-with-buffer-copy (&rest body)
2557   "Apply BODY in a copy of the current buffer.
2558 The copy preserves local variables, visibility and contents of
2559 the original buffer.  Point is at the beginning of the buffer
2560 when BODY is applied."
2561   (declare (debug t))
2562   (org-with-gensyms (buf-copy)
2563     `(let ((,buf-copy (org-export-copy-buffer)))
2564        (unwind-protect
2565            (with-current-buffer ,buf-copy
2566              (goto-char (point-min))
2567              (progn ,@body))
2568          (and (buffer-live-p ,buf-copy)
2569               ;; Kill copy without confirmation.
2570               (progn (with-current-buffer ,buf-copy
2571                        (restore-buffer-modified-p nil))
2572                      (kill-buffer ,buf-copy)))))))
2573
2574 (defun org-export--generate-copy-script (buffer)
2575   "Generate a function duplicating BUFFER.
2576
2577 The copy will preserve local variables, visibility, contents and
2578 narrowing of the original buffer.  If a region was active in
2579 BUFFER, contents will be narrowed to that region instead.
2580
2581 The resulting function can be evaluated at a later time, from
2582 another buffer, effectively cloning the original buffer there.
2583
2584 The function assumes BUFFER's major mode is `org-mode'."
2585   (with-current-buffer buffer
2586     `(lambda ()
2587        (let ((inhibit-modification-hooks t))
2588          ;; Set major mode. Ignore `org-mode-hook' as it has been run
2589          ;; already in BUFFER.
2590          (let ((org-mode-hook nil) (org-inhibit-startup t)) (org-mode))
2591          ;; Copy specific buffer local variables and variables set
2592          ;; through BIND keywords.
2593          ,@(let ((bound-variables (org-export--list-bound-variables))
2594                  vars)
2595              (dolist (entry (buffer-local-variables (buffer-base-buffer)) vars)
2596                (when (consp entry)
2597                  (let ((var (car entry))
2598                        (val (cdr entry)))
2599                    (and (not (memq var org-export-ignored-local-variables))
2600                         (or (memq var
2601                                   '(default-directory
2602                                      buffer-file-name
2603                                      buffer-file-coding-system))
2604                             (assq var bound-variables)
2605                             (string-match "^\\(org-\\|orgtbl-\\)"
2606                                           (symbol-name var)))
2607                         ;; Skip unreadable values, as they cannot be
2608                         ;; sent to external process.
2609                         (or (not val) (ignore-errors (read (format "%S" val))))
2610                         (push `(set (make-local-variable (quote ,var))
2611                                     (quote ,val))
2612                               vars))))))
2613          ;; Whole buffer contents.
2614          (insert
2615           ,(org-with-wide-buffer
2616             (buffer-substring-no-properties
2617              (point-min) (point-max))))
2618          ;; Narrowing.
2619          ,(if (org-region-active-p)
2620               `(narrow-to-region ,(region-beginning) ,(region-end))
2621             `(narrow-to-region ,(point-min) ,(point-max)))
2622          ;; Current position of point.
2623          (goto-char ,(point))
2624          ;; Overlays with invisible property.
2625          ,@(let (ov-set)
2626              (mapc
2627               (lambda (ov)
2628                 (let ((invis-prop (overlay-get ov 'invisible)))
2629                   (when invis-prop
2630                     (push `(overlay-put
2631                             (make-overlay ,(overlay-start ov)
2632                                           ,(overlay-end ov))
2633                             'invisible (quote ,invis-prop))
2634                           ov-set))))
2635               (overlays-in (point-min) (point-max)))
2636              ov-set)))))
2637
2638 (defun org-export--delete-comments ()
2639   "Delete commented areas in the buffer.
2640 Commented areas are comments, comment blocks, commented trees and
2641 inlinetasks.  Trailing blank lines after a comment or a comment
2642 block are preserved.  Narrowing, if any, is ignored."
2643   (org-with-wide-buffer
2644    (goto-char (point-min))
2645    (let ((regexp (concat org-outline-regexp-bol ".*" org-comment-string
2646                          "\\|"
2647                          "^[ \t]*#\\(?: \\|$\\|\\+begin_comment\\)"))
2648          (case-fold-search t))
2649      (while (re-search-forward regexp nil t)
2650        (let ((e (org-element-at-point)))
2651          (case (org-element-type e)
2652            ((comment comment-block)
2653             (delete-region (org-element-property :begin e)
2654                            (progn (goto-char (org-element-property :end e))
2655                                   (skip-chars-backward " \r\t\n")
2656                                   (line-beginning-position 2))))
2657            ((headline inlinetask)
2658             (when (org-element-property :commentedp e)
2659               (delete-region (org-element-property :begin e)
2660                              (org-element-property :end e))))))))))
2661
2662 (defun org-export--prune-tree (data info)
2663   "Prune non exportable elements from DATA.
2664 DATA is the parse tree to traverse.  INFO is the plist holding
2665 export info.  Also set `:ignore-list' in INFO to a list of
2666 objects which should be ignored during export, but not removed
2667 from tree."
2668   (let* (walk-data
2669          ignore
2670          ;; First find trees containing a select tag, if any.
2671          (selected (org-export--selected-trees data info))
2672          (walk-data
2673           (lambda (data)
2674             ;; Prune non-exportable elements and objects from tree.
2675             ;; As a special case, special rows and cells from tables
2676             ;; are stored in IGNORE, as they still need to be accessed
2677             ;; during export.
2678             (when data
2679               (let ((type (org-element-type data)))
2680                 (if (org-export--skip-p data info selected)
2681                     (if (memq type '(table-cell table-row)) (push data ignore)
2682                       (org-element-extract-element data))
2683                   (if (and (eq type 'headline)
2684                            (eq (plist-get info :with-archived-trees) 'headline)
2685                            (org-element-property :archivedp data))
2686                       ;; If headline is archived but tree below has to
2687                       ;; be skipped, remove contents.
2688                       (org-element-set-contents data)
2689                     ;; Move into secondary string, if any.
2690                     (let ((sec-prop
2691                            (cdr (assq type org-element-secondary-value-alist))))
2692                       (when sec-prop
2693                         (mapc walk-data (org-element-property sec-prop data))))
2694                     ;; Move into recursive objects/elements.
2695                     (mapc walk-data (org-element-contents data)))))))))
2696     ;; If a select tag is active, also ignore the section before the
2697     ;; first headline, if any.
2698     (when selected
2699       (let ((first-element (car (org-element-contents data))))
2700         (when (eq (org-element-type first-element) 'section)
2701           (org-element-extract-element first-element))))
2702     ;; Prune tree and communication channel.
2703     (funcall walk-data data)
2704     (dolist (entry
2705              (append
2706               ;; Priority is given to back-end specific options.
2707               (org-export-get-all-options (plist-get info :back-end))
2708               org-export-options-alist))
2709       (when (eq (nth 4 entry) 'parse)
2710         (funcall walk-data (plist-get info (car entry)))))
2711     ;; Eventually set `:ignore-list'.
2712     (plist-put info :ignore-list ignore)))
2713
2714 (defun org-export--remove-uninterpreted-data (data info)
2715   "Change uninterpreted elements back into Org syntax.
2716 DATA is the parse tree.  INFO is a plist containing export
2717 options.  Each uninterpreted element or object is changed back
2718 into a string.  Contents, if any, are not modified.  The parse
2719 tree is modified by side effect."
2720   (org-export--remove-uninterpreted-data-1 data info)
2721   (dolist (entry org-export-options-alist)
2722     (when (eq (nth 4 entry) 'parse)
2723       (let ((p (car entry)))
2724         (plist-put info
2725                    p
2726                    (org-export--remove-uninterpreted-data-1
2727                     (plist-get info p)
2728                     info))))))
2729
2730 (defun org-export--remove-uninterpreted-data-1 (data info)
2731   "Change uninterpreted elements back into Org syntax.
2732 DATA is a parse tree or a secondary string.  INFO is a plist
2733 containing export options.  It is modified by side effect and
2734 returned by the function."
2735   (org-element-map data
2736       '(entity bold italic latex-environment latex-fragment strike-through
2737                subscript superscript underline)
2738     (lambda (blob)
2739       (let ((new
2740              (case (org-element-type blob)
2741                ;; ... entities...
2742                (entity
2743                 (and (not (plist-get info :with-entities))
2744                      (list (concat
2745                             (org-export-expand blob nil)
2746                             (make-string
2747                              (or (org-element-property :post-blank blob) 0)
2748                              ?\s)))))
2749                ;; ... emphasis...
2750                ((bold italic strike-through underline)
2751                 (and (not (plist-get info :with-emphasize))
2752                      (let ((marker (case (org-element-type blob)
2753                                      (bold "*")
2754                                      (italic "/")
2755                                      (strike-through "+")
2756                                      (underline "_"))))
2757                        (append
2758                         (list marker)
2759                         (org-element-contents blob)
2760                         (list (concat
2761                                marker
2762                                (make-string
2763                                 (or (org-element-property :post-blank blob)
2764                                     0)
2765                                 ?\s)))))))
2766                ;; ... LaTeX environments and fragments...
2767                ((latex-environment latex-fragment)
2768                 (and (eq (plist-get info :with-latex) 'verbatim)
2769                      (list (org-export-expand blob nil))))
2770                ;; ... sub/superscripts...
2771                ((subscript superscript)
2772                 (let ((sub/super-p (plist-get info :with-sub-superscript))
2773                       (bracketp (org-element-property :use-brackets-p blob)))
2774                   (and (or (not sub/super-p)
2775                            (and (eq sub/super-p '{}) (not bracketp)))
2776                        (append
2777                         (list (concat
2778                                (if (eq (org-element-type blob) 'subscript)
2779                                    "_"
2780                                  "^")
2781                                (and bracketp "{")))
2782                         (org-element-contents blob)
2783                         (list (concat
2784                                (and bracketp "}")
2785                                (and (org-element-property :post-blank blob)
2786                                     (make-string
2787                                      (org-element-property :post-blank blob)
2788                                      ?\s)))))))))))
2789         (when new
2790           ;; Splice NEW at BLOB location in parse tree.
2791           (dolist (e new (org-element-extract-element blob))
2792             (unless (string= e "") (org-element-insert-before e blob))))))
2793     info)
2794   ;; Return modified parse tree.
2795   data)
2796
2797 ;;;###autoload
2798 (defun org-export-as
2799     (backend &optional subtreep visible-only body-only ext-plist)
2800   "Transcode current Org buffer into BACKEND code.
2801
2802 BACKEND is either an export back-end, as returned by, e.g.,
2803 `org-export-create-backend', or a symbol referring to
2804 a registered back-end.
2805
2806 If narrowing is active in the current buffer, only transcode its
2807 narrowed part.
2808
2809 If a region is active, transcode that region.
2810
2811 When optional argument SUBTREEP is non-nil, transcode the
2812 sub-tree at point, extracting information from the headline
2813 properties first.
2814
2815 When optional argument VISIBLE-ONLY is non-nil, don't export
2816 contents of hidden elements.
2817
2818 When optional argument BODY-ONLY is non-nil, only return body
2819 code, without surrounding template.
2820
2821 Optional argument EXT-PLIST, when provided, is a property list
2822 with external parameters overriding Org default settings, but
2823 still inferior to file-local settings.
2824
2825 Return code as a string."
2826   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
2827   (org-export-barf-if-invalid-backend backend)
2828   (save-excursion
2829     (save-restriction
2830       ;; Narrow buffer to an appropriate region or subtree for
2831       ;; parsing.  If parsing subtree, be sure to remove main headline
2832       ;; too.
2833       (cond ((org-region-active-p)
2834              (narrow-to-region (region-beginning) (region-end)))
2835             (subtreep
2836              (org-narrow-to-subtree)
2837              (goto-char (point-min))
2838              (forward-line)
2839              (narrow-to-region (point) (point-max))))
2840       ;; Initialize communication channel with original buffer
2841       ;; attributes, unavailable in its copy.
2842       (let* ((org-export-current-backend (org-export-backend-name backend))
2843              (info (org-combine-plists
2844                     (list :export-options
2845                           (delq nil
2846                                 (list (and subtreep 'subtree)
2847                                       (and visible-only 'visible-only)
2848                                       (and body-only 'body-only))))
2849                     (org-export--get-buffer-attributes)))
2850              (parsed-keywords
2851               (delq nil
2852                     (mapcar (lambda (o) (and (eq (nth 4 o) 'parse) (nth 1 o)))
2853                             (append (org-export-get-all-options backend)
2854                                     org-export-options-alist))))
2855              tree)
2856         ;; Update communication channel and get parse tree.  Buffer
2857         ;; isn't parsed directly.  Instead, a temporary copy is
2858         ;; created, where include keywords, macros are expanded and
2859         ;; code blocks are evaluated.
2860         (org-export-with-buffer-copy
2861          ;; Run first hook with current back-end's name as argument.
2862          (run-hook-with-args 'org-export-before-processing-hook
2863                              (org-export-backend-name backend))
2864          (org-export-expand-include-keyword)
2865          (org-export--delete-comments)
2866          ;; Update macro templates since #+INCLUDE keywords might have
2867          ;; added some new ones.
2868          (org-macro-initialize-templates)
2869          (org-macro-replace-all org-macro-templates nil parsed-keywords)
2870          (org-export-execute-babel-code)
2871          ;; Update radio targets since keyword inclusion might have
2872          ;; added some more.
2873          (org-update-radio-target-regexp)
2874          ;; Run last hook with current back-end's name as argument.
2875          (goto-char (point-min))
2876          (save-excursion
2877            (run-hook-with-args 'org-export-before-parsing-hook
2878                                (org-export-backend-name backend)))
2879          ;; Update communication channel with environment.  Also
2880          ;; install user's and developer's filters.
2881          (setq info
2882                (org-export-install-filters
2883                 (org-combine-plists
2884                  info (org-export-get-environment backend subtreep ext-plist))))
2885          ;; Call options filters and update export options.  We do not
2886          ;; use `org-export-filter-apply-functions' here since the
2887          ;; arity of such filters is different.
2888          (let ((backend-name (org-export-backend-name backend)))
2889            (dolist (filter (plist-get info :filter-options))
2890              (let ((result (funcall filter info backend-name)))
2891                (when result (setq info result)))))
2892          ;; Expand export-specific set of macros: {{{author}}},
2893          ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}.  It must
2894          ;; be done once regular macros have been expanded, since
2895          ;; parsed keywords may contain one of them.
2896          (org-macro-replace-all
2897           (list
2898            (cons "author" (org-element-interpret-data (plist-get info :author)))
2899            (cons "date"
2900                  (let* ((date (plist-get info :date))
2901                         (value (or (org-element-interpret-data date) "")))
2902                    (if (and (consp date)
2903                             (not (cdr date))
2904                             (eq (org-element-type (car date)) 'timestamp))
2905                        (format "(eval (if (org-string-nw-p \"$1\") %s %S))"
2906                                (format "(org-timestamp-format '%S \"$1\")"
2907                                        (org-element-copy (car date)))
2908                                value)
2909                      value)))
2910            (cons "email" (org-element-interpret-data (plist-get info :email)))
2911            (cons "title" (org-element-interpret-data (plist-get info :title)))
2912            (cons "results" "$1"))
2913           'finalize
2914           parsed-keywords)
2915          ;; Parse buffer.
2916          (setq tree (org-element-parse-buffer nil visible-only))
2917          ;; Prune tree from non-exported elements and transform
2918          ;; uninterpreted elements or objects in both parse tree and
2919          ;; communication channel.
2920          (org-export--prune-tree tree info)
2921          (org-export--remove-uninterpreted-data tree info)
2922          ;; Parse buffer, handle uninterpreted elements or objects,
2923          ;; then call parse-tree filters.
2924          (setq tree
2925                (org-export-filter-apply-functions
2926                 (plist-get info :filter-parse-tree) tree info))
2927          ;; Now tree is complete, compute its properties and add them
2928          ;; to communication channel.
2929          (setq info
2930                (org-combine-plists
2931                 info (org-export-collect-tree-properties tree info)))
2932          ;; Eventually transcode TREE.  Wrap the resulting string into
2933          ;; a template.
2934          (let* ((body (org-element-normalize-string
2935                        (or (org-export-data tree info) "")))
2936                 (inner-template (cdr (assq 'inner-template
2937                                            (plist-get info :translate-alist))))
2938                 (full-body (org-export-filter-apply-functions
2939                             (plist-get info :filter-body)
2940                             (if (not (functionp inner-template)) body
2941                               (funcall inner-template body info))
2942                             info))
2943                 (template (cdr (assq 'template
2944                                      (plist-get info :translate-alist)))))
2945            ;; Remove all text properties since they cannot be
2946            ;; retrieved from an external process.  Finally call
2947            ;; final-output filter and return result.
2948            (org-no-properties
2949             (org-export-filter-apply-functions
2950              (plist-get info :filter-final-output)
2951              (if (or (not (functionp template)) body-only) full-body
2952                (funcall template full-body info))
2953              info))))))))
2954
2955 ;;;###autoload
2956 (defun org-export-string-as (string backend &optional body-only ext-plist)
2957   "Transcode STRING into BACKEND code.
2958
2959 BACKEND is either an export back-end, as returned by, e.g.,
2960 `org-export-create-backend', or a symbol referring to
2961 a registered back-end.
2962
2963 When optional argument BODY-ONLY is non-nil, only return body
2964 code, without preamble nor postamble.
2965
2966 Optional argument EXT-PLIST, when provided, is a property list
2967 with external parameters overriding Org default settings, but
2968 still inferior to file-local settings.
2969
2970 Return code as a string."
2971   (with-temp-buffer
2972     (insert string)
2973     (let ((org-inhibit-startup t)) (org-mode))
2974     (org-export-as backend nil nil body-only ext-plist)))
2975
2976 ;;;###autoload
2977 (defun org-export-replace-region-by (backend)
2978   "Replace the active region by its export to BACKEND.
2979 BACKEND is either an export back-end, as returned by, e.g.,
2980 `org-export-create-backend', or a symbol referring to
2981 a registered back-end."
2982   (if (not (org-region-active-p))
2983       (user-error "No active region to replace")
2984     (let* ((beg (region-beginning))
2985            (end (region-end))
2986            (str (buffer-substring beg end)) rpl)
2987       (setq rpl (org-export-string-as str backend t))
2988       (delete-region beg end)
2989       (insert rpl))))
2990
2991 ;;;###autoload
2992 (defun org-export-insert-default-template (&optional backend subtreep)
2993   "Insert all export keywords with default values at beginning of line.
2994
2995 BACKEND is a symbol referring to the name of a registered export
2996 back-end, for which specific export options should be added to
2997 the template, or `default' for default template.  When it is nil,
2998 the user will be prompted for a category.
2999
3000 If SUBTREEP is non-nil, export configuration will be set up
3001 locally for the subtree through node properties."
3002   (interactive)
3003   (unless (derived-mode-p 'org-mode) (user-error "Not in an Org mode buffer"))
3004   (when (and subtreep (org-before-first-heading-p))
3005     (user-error "No subtree to set export options for"))
3006   (let ((node (and subtreep (save-excursion (org-back-to-heading t) (point))))
3007         (backend
3008          (or backend
3009              (intern
3010               (org-completing-read
3011                "Options category: "
3012                (cons "default"
3013                      (mapcar (lambda (b)
3014                                (symbol-name (org-export-backend-name b)))
3015                              org-export-registered-backends))
3016                nil t))))
3017         options keywords)
3018     ;; Populate OPTIONS and KEYWORDS.
3019     (dolist (entry (cond ((eq backend 'default) org-export-options-alist)
3020                          ((org-export-backend-p backend)
3021                           (org-export-backend-options backend))
3022                          (t (org-export-backend-options
3023                              (org-export-get-backend backend)))))
3024       (let ((keyword (nth 1 entry))
3025             (option (nth 2 entry)))
3026         (cond
3027          (keyword (unless (assoc keyword keywords)
3028                     (let ((value
3029                            (if (eq (nth 4 entry) 'split)
3030                                (mapconcat #'identity (eval (nth 3 entry)) " ")
3031                              (eval (nth 3 entry)))))
3032                       (push (cons keyword value) keywords))))
3033          (option (unless (assoc option options)
3034                    (push (cons option (eval (nth 3 entry))) options))))))
3035     ;; Move to an appropriate location in order to insert options.
3036     (unless subtreep (beginning-of-line))
3037     ;; First (multiple) OPTIONS lines.  Never go past fill-column.
3038     (when options
3039       (let ((items
3040              (mapcar
3041               #'(lambda (opt) (format "%s:%S" (car opt) (cdr opt)))
3042               (sort options (lambda (k1 k2) (string< (car k1) (car k2)))))))
3043         (if subtreep
3044             (org-entry-put
3045              node "EXPORT_OPTIONS" (mapconcat 'identity items " "))
3046           (while items
3047             (insert "#+OPTIONS:")
3048             (let ((width 10))
3049               (while (and items
3050                           (< (+ width (length (car items)) 1) fill-column))
3051                 (let ((item (pop items)))
3052                   (insert " " item)
3053                   (incf width (1+ (length item))))))
3054             (insert "\n")))))
3055     ;; Then the rest of keywords, in the order specified in either
3056     ;; `org-export-options-alist' or respective export back-ends.
3057     (dolist (key (nreverse keywords))
3058       (let ((val (cond ((equal (car key) "DATE")
3059                         (or (cdr key)
3060                             (with-temp-buffer
3061                               (org-insert-time-stamp (current-time)))))
3062                        ((equal (car key) "TITLE")
3063                         (or (let ((visited-file
3064                                    (buffer-file-name (buffer-base-buffer))))
3065                               (and visited-file
3066                                    (file-name-sans-extension
3067                                     (file-name-nondirectory visited-file))))
3068                             (buffer-name (buffer-base-buffer))))
3069                        (t (cdr key)))))
3070         (if subtreep (org-entry-put node (concat "EXPORT_" (car key)) val)
3071           (insert
3072            (format "#+%s:%s\n"
3073                    (car key)
3074                    (if (org-string-nw-p val) (format " %s" val) ""))))))))
3075
3076 (defun org-export-expand-include-keyword (&optional included dir footnotes)
3077   "Expand every include keyword in buffer.
3078 Optional argument INCLUDED is a list of included file names along
3079 with their line restriction, when appropriate.  It is used to
3080 avoid infinite recursion.  Optional argument DIR is the current
3081 working directory.  It is used to properly resolve relative
3082 paths.  Optional argument FOOTNOTES is a hash-table used for
3083 storing and resolving footnotes.  It is created automatically."
3084   (let ((case-fold-search t)
3085         (file-prefix (make-hash-table :test #'equal))
3086         (current-prefix 0)
3087         (footnotes (or footnotes (make-hash-table :test #'equal)))
3088         (include-re "^[ \t]*#\\+INCLUDE:"))
3089     ;; If :minlevel is not set the text-property
3090     ;; `:org-include-induced-level' will be used to determine the
3091     ;; relative level when expanding INCLUDE.
3092     ;; Only affects included Org documents.
3093     (goto-char (point-min))
3094     (while (re-search-forward include-re nil t)
3095       (put-text-property (line-beginning-position) (line-end-position)
3096                          :org-include-induced-level
3097                          (1+ (org-reduced-level (or (org-current-level) 0)))))
3098     ;; Expand INCLUDE keywords.
3099     (goto-char (point-min))
3100     (while (re-search-forward include-re nil t)
3101       (let ((element (save-match-data (org-element-at-point))))
3102         (when (eq (org-element-type element) 'keyword)
3103           (beginning-of-line)
3104           ;; Extract arguments from keyword's value.
3105           (let* ((value (org-element-property :value element))
3106                  (ind (org-get-indentation))
3107                  location
3108                  (file (and (string-match
3109                              "^\\(\".+?\"\\|\\S-+\\)\\(?:\\s-+\\|$\\)" value)
3110                             (prog1
3111                                 (save-match-data
3112                                   (let ((matched (match-string 1 value)))
3113                                     (when (string-match "\\(::\\(.*?\\)\\)\"?\\'" matched)
3114                                       (setq location (match-string 2 matched))
3115                                       (setq matched
3116                                             (replace-match "" nil nil matched 1)))
3117                                     (expand-file-name
3118                                      (org-remove-double-quotes
3119                                       matched)
3120                                      dir)))
3121                               (setq value (replace-match "" nil nil value)))))
3122                  (only-contents
3123                   (and (string-match ":only-contents *\\([^: \r\t\n]\\S-*\\)?" value)
3124                        (prog1 (org-not-nil (match-string 1 value))
3125                          (setq value (replace-match "" nil nil value)))))
3126                  (lines
3127                   (and (string-match
3128                         ":lines +\"\\(\\(?:[0-9]+\\)?-\\(?:[0-9]+\\)?\\)\""
3129                         value)
3130                        (prog1 (match-string 1 value)
3131                          (setq value (replace-match "" nil nil value)))))
3132                  (env (cond ((string-match "\\<example\\>" value)
3133                              'literal)
3134                             ((string-match "\\<src\\(?: +\\(.*\\)\\)?" value)
3135                              'literal)))
3136                  ;; Minimal level of included file defaults to the child
3137                  ;; level of the current headline, if any, or one.  It
3138                  ;; only applies is the file is meant to be included as
3139                  ;; an Org one.
3140                  (minlevel
3141                   (and (not env)
3142                        (if (string-match ":minlevel +\\([0-9]+\\)" value)
3143                            (prog1 (string-to-number (match-string 1 value))
3144                              (setq value (replace-match "" nil nil value)))
3145                          (get-text-property (point) :org-include-induced-level))))
3146                  (src-args (and (eq env 'literal)
3147                                 (match-string 1 value)))
3148                  (block (and (string-match "\\<\\(\\S-+\\)\\>" value)
3149                              (match-string 1 value))))
3150             ;; Remove keyword.
3151             (delete-region (point) (progn (forward-line) (point)))
3152             (cond
3153              ((not file) nil)
3154              ((not (file-readable-p file))
3155               (error "Cannot include file %s" file))
3156              ;; Check if files has already been parsed.  Look after
3157              ;; inclusion lines too, as different parts of the same file
3158              ;; can be included too.
3159              ((member (list file lines) included)
3160               (error "Recursive file inclusion: %s" file))
3161              (t
3162               (cond
3163                ((eq env 'literal)
3164                 (insert
3165                  (let ((ind-str (make-string ind ? ))
3166                        (arg-str (if (stringp src-args)
3167                                     (format " %s" src-args)
3168                                   ""))
3169                        (contents
3170                         (org-escape-code-in-string
3171                          (org-export--prepare-file-contents file lines))))
3172                    (format "%s#+BEGIN_%s%s\n%s%s#+END_%s\n"
3173                            ind-str block arg-str contents ind-str block))))
3174                ((stringp block)
3175                 (insert
3176                  (let ((ind-str (make-string ind ? ))
3177                        (contents
3178                         (org-export--prepare-file-contents file lines)))
3179                    (format "%s#+BEGIN_%s\n%s%s#+END_%s\n"
3180                            ind-str block contents ind-str block))))
3181                (t
3182                 (insert
3183                  (with-temp-buffer
3184                    (let ((org-inhibit-startup t)
3185                          (lines
3186                           (if location
3187                               (org-export--inclusion-absolute-lines
3188                                file location only-contents lines)
3189                             lines)))
3190                      (org-mode)
3191                      (insert (org-export--prepare-file-contents
3192                               file lines ind minlevel
3193                               (or (gethash file file-prefix)
3194                                   (puthash file (incf current-prefix) file-prefix))
3195                               footnotes)))
3196                    (org-export-expand-include-keyword
3197                     (cons (list file lines) included)
3198                     (file-name-directory file)
3199                     footnotes)
3200                    (buffer-string)))))
3201               ;; Expand footnotes after all files have been
3202               ;; included.  Footnotes are stored at end of buffer.
3203               (unless included
3204                 (org-with-wide-buffer
3205                  (goto-char (point-max))
3206                  (maphash (lambda (ref def) (insert (format "\n[%s] %s\n" ref def)))
3207                           footnotes)))))))))))
3208
3209 (defun org-export--inclusion-absolute-lines (file location only-contents lines)
3210   "Resolve absolute lines for an included file with file-link.
3211
3212 FILE is string file-name of the file to include.  LOCATION is a
3213 string name within FILE to be included (located via
3214 `org-link-search').  If ONLY-CONTENTS is non-nil only the
3215 contents of the named element will be included, as determined
3216 Org-Element.  If LINES is non-nil only those lines are included.
3217
3218 Return a string of lines to be included in the format expected by
3219 `org-export--prepare-file-contents'."
3220   (with-temp-buffer
3221     (insert-file-contents file)
3222     (unless (eq major-mode 'org-mode)
3223       (let ((org-inhibit-startup t)) (org-mode)))
3224     (condition-case err
3225         ;; Enforce consistent search.
3226         (let ((org-link-search-must-match-exact-headline t))
3227           (org-link-search location))
3228       (error
3229        (error (format "%s for %s::%s" (error-message-string err) file location))))
3230     (let* ((element (org-element-at-point))
3231            (contents-begin
3232             (and only-contents (org-element-property :contents-begin element))))
3233       (narrow-to-region
3234        (or contents-begin (org-element-property :begin element))
3235        (org-element-property (if contents-begin :contents-end :end) element))
3236       (when (and only-contents
3237                  (memq (org-element-type element) '(headline inlinetask)))
3238         ;; Skip planning line and property-drawer.
3239         (goto-char (point-min))
3240         (when (org-looking-at-p org-planning-line-re) (forward-line))
3241         (when (looking-at org-property-drawer-re) (goto-char (match-end 0)))
3242         (unless (bolp) (forward-line))
3243         (narrow-to-region (point) (point-max))))
3244     (when lines
3245       (org-skip-whitespace)
3246       (beginning-of-line)
3247       (let* ((lines (split-string lines "-"))
3248              (lbeg (string-to-number (car lines)))
3249              (lend (string-to-number (cadr lines)))
3250              (beg (if (zerop lbeg) (point-min)
3251                     (goto-char (point-min))
3252                     (forward-line (1- lbeg))
3253                     (point)))
3254              (end (if (zerop lend) (point-max)
3255                     (goto-char beg)
3256                     (forward-line (1- lend))
3257                     (point))))
3258         (narrow-to-region beg end)))
3259     (let ((end (point-max)))
3260       (goto-char (point-min))
3261       (widen)
3262       (let ((start-line (line-number-at-pos)))
3263         (format "%d-%d"
3264                 start-line
3265                 (save-excursion
3266                   (+ start-line
3267                      (let ((counter 0))
3268                        (while (< (point) end) (incf counter) (forward-line))
3269                        counter))))))))
3270
3271 (defun org-export--update-footnote-label (ref-begin digit-label id)
3272   "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3273
3274 REF-BEGIN corresponds to the property `:begin' of objects of type
3275 footnote-definition and footnote-reference.
3276
3277 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3278 \[N] where N is one or more numbers.
3279
3280 Return the new label."
3281   (goto-char (1+ ref-begin))
3282   (buffer-substring (point)
3283                     (progn
3284                       (if digit-label (insert (format "fn:%d-" id))
3285                         (forward-char 3)
3286                         (insert (format "%d-" id)))
3287                       (1- (search-forward "]")))))
3288
3289 (defun org-export--prepare-file-contents (file &optional lines ind minlevel id footnotes)
3290   "Prepare contents of FILE for inclusion and return it as a string.
3291
3292 When optional argument LINES is a string specifying a range of
3293 lines, include only those lines.
3294
3295 Optional argument IND, when non-nil, is an integer specifying the
3296 global indentation of returned contents.  Since its purpose is to
3297 allow an included file to stay in the same environment it was
3298 created \(i.e. a list item), it doesn't apply past the first
3299 headline encountered.
3300
3301 Optional argument MINLEVEL, when non-nil, is an integer
3302 specifying the level that any top-level headline in the included
3303 file should have.
3304 Optional argument ID is an integer that will be inserted before
3305 each footnote definition and reference if FILE is an Org file.
3306 This is useful to avoid conflicts when more than one Org file
3307 with footnotes is included in a document.
3308
3309 Optional argument FOOTNOTES is a hash-table to store footnotes in
3310 the included document.
3311 "
3312   (with-temp-buffer
3313     (insert-file-contents file)
3314     (when lines
3315       (let* ((lines (split-string lines "-"))
3316              (lbeg (string-to-number (car lines)))
3317              (lend (string-to-number (cadr lines)))
3318              (beg (if (zerop lbeg) (point-min)
3319                     (goto-char (point-min))
3320                     (forward-line (1- lbeg))
3321                     (point)))
3322              (end (if (zerop lend) (point-max)
3323                     (goto-char (point-min))
3324                     (forward-line (1- lend))
3325                     (point))))
3326         (narrow-to-region beg end)))
3327     ;; Remove blank lines at beginning and end of contents.  The logic
3328     ;; behind that removal is that blank lines around include keyword
3329     ;; override blank lines in included file.
3330     (goto-char (point-min))
3331     (org-skip-whitespace)
3332     (beginning-of-line)
3333     (delete-region (point-min) (point))
3334     (goto-char (point-max))
3335     (skip-chars-backward " \r\t\n")
3336     (forward-line)
3337     (delete-region (point) (point-max))
3338     ;; If IND is set, preserve indentation of include keyword until
3339     ;; the first headline encountered.
3340     (when ind
3341       (unless (eq major-mode 'org-mode)
3342         (let ((org-inhibit-startup t)) (org-mode)))
3343       (goto-char (point-min))
3344       (let ((ind-str (make-string ind ? )))
3345         (while (not (or (eobp) (looking-at org-outline-regexp-bol)))
3346           ;; Do not move footnote definitions out of column 0.
3347           (unless (and (looking-at org-footnote-definition-re)
3348                        (eq (org-element-type (org-element-at-point))
3349                            'footnote-definition))
3350             (insert ind-str))
3351           (forward-line))))
3352     ;; When MINLEVEL is specified, compute minimal level for headlines
3353     ;; in the file (CUR-MIN), and remove stars to each headline so
3354     ;; that headlines with minimal level have a level of MINLEVEL.
3355     (when minlevel
3356       (unless (eq major-mode 'org-mode)
3357         (let ((org-inhibit-startup t)) (org-mode)))
3358       (org-with-limited-levels
3359        (let ((levels (org-map-entries
3360                       (lambda () (org-reduced-level (org-current-level))))))
3361          (when levels
3362            (let ((offset (- minlevel (apply 'min levels))))
3363              (unless (zerop offset)
3364                (when org-odd-levels-only (setq offset (* offset 2)))
3365                ;; Only change stars, don't bother moving whole
3366                ;; sections.
3367                (org-map-entries
3368                 (lambda () (if (< offset 0) (delete-char (abs offset))
3369                              (insert (make-string offset ?*)))))))))))
3370     ;; Append ID to all footnote references and definitions, so they
3371     ;; become file specific and cannot collide with footnotes in other
3372     ;; included files.  Further, collect relevant footnotes outside of
3373     ;; LINES.
3374     (when id
3375       (let ((marker-min (point-min-marker))
3376             (marker-max (point-max-marker)))
3377         (goto-char (point-min))
3378         (while (re-search-forward org-footnote-re nil t)
3379           (let ((reference (org-element-context)))
3380             (when (eq (org-element-type reference) 'footnote-reference)
3381               (let* ((label (org-element-property :label reference))
3382                      (digit-label (and label (org-string-match-p "\\`[0-9]+\\'" label))))
3383                 ;; Update the footnote-reference at point and collect
3384                 ;; the new label, which is only used for footnotes
3385                 ;; outsides LINES.
3386                 (when label
3387                   ;; If label is akin to [1] convert it to [fn:ID-1].
3388                   ;; Otherwise add "ID-" after "fn:".
3389                   (let ((new-label (org-export--update-footnote-label
3390                                     (org-element-property :begin reference) digit-label id)))
3391                     (unless (eq (org-element-property :type reference) 'inline)
3392                       (org-with-wide-buffer
3393                        (let* ((definition (org-footnote-get-definition label))
3394                               (beginning (nth 1 definition)))
3395                          (unless definition
3396                            (error "Definition not found for footnote %s in file %s" label file))
3397                          (if (or (< beginning marker-min) (> beginning marker-max))
3398                              ;; Store since footnote-definition is outside of LINES.
3399                              (puthash new-label
3400                                       (org-element-normalize-string (nth 3 definition))
3401                                       footnotes)
3402                            ;; Update label of definition since it is included directly.
3403                            (org-export--update-footnote-label beginning digit-label id)))))))))))
3404         (set-marker marker-min nil)
3405         (set-marker marker-max nil)))
3406     (org-element-normalize-string (buffer-string))))
3407
3408 (defun org-export-execute-babel-code ()
3409   "Execute every Babel code in the visible part of current buffer."
3410   ;; Get a pristine copy of current buffer so Babel references can be
3411   ;; properly resolved.
3412   (let ((reference (org-export-copy-buffer)))
3413     (unwind-protect (org-babel-exp-process-buffer reference)
3414       (kill-buffer reference))))
3415
3416 (defun org-export--copy-to-kill-ring-p ()
3417   "Return a non-nil value when output should be added to the kill ring.
3418 See also `org-export-copy-to-kill-ring'."
3419   (if (eq org-export-copy-to-kill-ring 'if-interactive)
3420       (not (or executing-kbd-macro noninteractive))
3421     (eq org-export-copy-to-kill-ring t)))
3422
3423
3424 \f
3425 ;;; Tools For Back-Ends
3426 ;;
3427 ;; A whole set of tools is available to help build new exporters.  Any
3428 ;; function general enough to have its use across many back-ends
3429 ;; should be added here.
3430
3431 ;;;; For Affiliated Keywords
3432 ;;
3433 ;; `org-export-read-attribute' reads a property from a given element
3434 ;;  as a plist.  It can be used to normalize affiliated keywords'
3435 ;;  syntax.
3436 ;;
3437 ;; Since captions can span over multiple lines and accept dual values,
3438 ;; their internal representation is a bit tricky.  Therefore,
3439 ;; `org-export-get-caption' transparently returns a given element's
3440 ;; caption as a secondary string.
3441
3442 (defun org-export-read-attribute (attribute element &optional property)
3443   "Turn ATTRIBUTE property from ELEMENT into a plist.
3444
3445 When optional argument PROPERTY is non-nil, return the value of
3446 that property within attributes.
3447
3448 This function assumes attributes are defined as \":keyword
3449 value\" pairs.  It is appropriate for `:attr_html' like
3450 properties.
3451
3452 All values will become strings except the empty string and
3453 \"nil\", which will become nil.  Also, values containing only
3454 double quotes will be read as-is, which means that \"\" value
3455 will become the empty string."
3456   (let* ((prepare-value
3457           (lambda (str)
3458             (save-match-data
3459               (cond ((member str '(nil "" "nil")) nil)
3460                     ((string-match "^\"\\(\"+\\)?\"$" str)
3461                      (or (match-string 1 str) ""))
3462                     (t str)))))
3463          (attributes
3464           (let ((value (org-element-property attribute element)))
3465             (when value
3466               (let ((s (mapconcat 'identity value " ")) result)
3467                 (while (string-match
3468                         "\\(?:^\\|[ \t]+\\)\\(:[-a-zA-Z0-9_]+\\)\\([ \t]+\\|$\\)"
3469                         s)
3470                   (let ((value (substring s 0 (match-beginning 0))))
3471                     (push (funcall prepare-value value) result))
3472                   (push (intern (match-string 1 s)) result)
3473                   (setq s (substring s (match-end 0))))
3474                 ;; Ignore any string before first property with `cdr'.
3475                 (cdr (nreverse (cons (funcall prepare-value s) result))))))))
3476     (if property (plist-get attributes property) attributes)))
3477
3478 (defun org-export-get-caption (element &optional shortp)
3479   "Return caption from ELEMENT as a secondary string.
3480
3481 When optional argument SHORTP is non-nil, return short caption,
3482 as a secondary string, instead.
3483
3484 Caption lines are separated by a white space."
3485   (let ((full-caption (org-element-property :caption element)) caption)
3486     (dolist (line full-caption (cdr caption))
3487       (let ((cap (funcall (if shortp 'cdr 'car) line)))
3488         (when cap
3489           (setq caption (nconc (list " ") (copy-sequence cap) caption)))))))
3490
3491
3492 ;;;; For Derived Back-ends
3493 ;;
3494 ;; `org-export-with-backend' is a function allowing to locally use
3495 ;; another back-end to transcode some object or element.  In a derived
3496 ;; back-end, it may be used as a fall-back function once all specific
3497 ;; cases have been treated.
3498
3499 (defun org-export-with-backend (backend data &optional contents info)
3500   "Call a transcoder from BACKEND on DATA.
3501 BACKEND is an export back-end, as returned by, e.g.,
3502 `org-export-create-backend', or a symbol referring to
3503 a registered back-end.  DATA is an Org element, object, secondary
3504 string or string.  CONTENTS, when non-nil, is the transcoded
3505 contents of DATA element, as a string.  INFO, when non-nil, is
3506 the communication channel used for export, as a plist."
3507   (when (symbolp backend) (setq backend (org-export-get-backend backend)))
3508   (org-export-barf-if-invalid-backend backend)
3509   (let ((type (org-element-type data)))
3510     (if (memq type '(nil org-data)) (error "No foreign transcoder available")
3511       (let* ((all-transcoders (org-export-get-all-transcoders backend))
3512              (transcoder (cdr (assq type all-transcoders))))
3513         (if (not (functionp transcoder))
3514             (error "No foreign transcoder available")
3515           (funcall
3516            transcoder data contents
3517            (org-combine-plists
3518             info (list :back-end backend
3519                        :translate-alist all-transcoders
3520                        :exported-data (make-hash-table :test 'eq :size 401)))))))))
3521
3522
3523 ;;;; For Export Snippets
3524 ;;
3525 ;; Every export snippet is transmitted to the back-end.  Though, the
3526 ;; latter will only retain one type of export-snippet, ignoring
3527 ;; others, based on the former's target back-end.  The function
3528 ;; `org-export-snippet-backend' returns that back-end for a given
3529 ;; export-snippet.
3530
3531 (defun org-export-snippet-backend (export-snippet)
3532   "Return EXPORT-SNIPPET targeted back-end as a symbol.
3533 Translation, with `org-export-snippet-translation-alist', is
3534 applied."
3535   (let ((back-end (org-element-property :back-end export-snippet)))
3536     (intern
3537      (or (cdr (assoc back-end org-export-snippet-translation-alist))
3538          back-end))))
3539
3540
3541 ;;;; For Footnotes
3542 ;;
3543 ;; `org-export-collect-footnote-definitions' is a tool to list
3544 ;; actually used footnotes definitions in the whole parse tree, or in
3545 ;; a headline, in order to add footnote listings throughout the
3546 ;; transcoded data.
3547 ;;
3548 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3549 ;; back-ends, when they need to attach the footnote definition only to
3550 ;; the first occurrence of the corresponding label.
3551 ;;
3552 ;; `org-export-get-footnote-definition' and
3553 ;; `org-export-get-footnote-number' provide easier access to
3554 ;; additional information relative to a footnote reference.
3555
3556 (defun org-export-get-footnote-definition (footnote-reference info)
3557   "Return definition of FOOTNOTE-REFERENCE as parsed data.
3558 INFO is the plist used as a communication channel.  If no such
3559 definition can be found, raise an error."
3560   (let ((label (org-element-property :label footnote-reference)))
3561     (or (if label
3562             (cdr (assoc label (plist-get info :footnote-definition-alist)))
3563           (org-element-contents footnote-reference))
3564         (error "Definition not found for footnote %s" label))))
3565
3566 (defun org-export--footnote-reference-map
3567     (function data info &optional body-first)
3568   "Apply FUNCTION on every footnote reference in DATA.
3569 INFO is a plist containing export state.  By default, as soon as
3570 a new footnote reference is encountered, FUNCTION is called onto
3571 its definition.  However, if BODY-FIRST is non-nil, this step is
3572 delayed until the end of the process."
3573   (let* ((definitions)
3574          (seen-refs)
3575          (search-ref)                   ; For byte-compiler.
3576          (search-ref
3577           (lambda (data delayp)
3578             ;; Search footnote references through DATA, filling
3579             ;; SEEN-REFS along the way.  When DELAYP is non-nil, store
3580             ;; footnote definitions so they can be entered later.
3581             (org-element-map data 'footnote-reference
3582               (lambda (f)
3583                 (funcall function f)
3584                 (let ((--label (org-element-property :label f)))
3585                   (unless (and --label (member --label seen-refs))
3586                     (when --label (push --label seen-refs))
3587                     ;; Search for subsequent references in footnote
3588                     ;; definition so numbering follows reading logic,
3589                     ;; unless DELAYP in non-nil.
3590                     (cond
3591                      (delayp
3592                       (push (org-export-get-footnote-definition f info)
3593                             definitions))
3594                      ;; Do not force entering inline definitions,
3595                      ;; since `org-element-map' already traverses them
3596                      ;; at the right time.
3597                      ((eq (org-element-property :type f) 'inline))
3598                      (t (funcall search-ref
3599                                  (org-export-get-footnote-definition f info)
3600                                  nil))))))
3601               info nil
3602               ;; Don't enter footnote definitions since it will happen
3603               ;; when their first reference is found.  Moreover, if
3604               ;; DELAYP is non-nil, make sure we postpone entering
3605               ;; definitions of inline references.
3606               (if delayp '(footnote-definition footnote-reference)
3607                 'footnote-definition)))))
3608     (funcall search-ref data body-first)
3609     (funcall search-ref (nreverse definitions) nil)))
3610
3611 (defun org-export-collect-footnote-definitions (info &optional data body-first)
3612   "Return an alist between footnote numbers, labels and definitions.
3613
3614 INFO is the current export state, as a plist.
3615
3616 Definitions are collected throughout the whole parse tree, or
3617 DATA when non-nil.
3618
3619 Sorting is done by order of references.  As soon as a new
3620 reference is encountered, other references are searched within
3621 its definition.  However, if BODY-FIRST is non-nil, this step is
3622 delayed after the whole tree is checked.  This alters results
3623 when references are found in footnote definitions.
3624
3625 Definitions either appear as Org data or as a secondary string
3626 for inlined footnotes.  Unreferenced definitions are ignored."
3627   (let ((n 0) labels alist)
3628     (org-export--footnote-reference-map
3629      (lambda (f)
3630        ;; Collect footnote number, label and definition.
3631        (let ((l (org-element-property :label f)))
3632          (unless (and l (member l labels))
3633            (incf n)
3634            (push (list n l (org-export-get-footnote-definition f info)) alist))
3635          (when l (push l labels))))
3636      (or data (plist-get info :parse-tree)) info body-first)
3637     (nreverse alist)))
3638
3639 (defun org-export-footnote-first-reference-p
3640     (footnote-reference info &optional data body-first)
3641   "Non-nil when a footnote reference is the first one for its label.
3642
3643 FOOTNOTE-REFERENCE is the footnote reference being considered.
3644 INFO is a plist containing current export state.
3645
3646 Search is done throughout the whole parse tree, or DATA when
3647 non-nil.
3648
3649 By default, as soon as a new footnote reference is encountered,
3650 other references are searched within its definition.  However, if
3651 BODY-FIRST is non-nil, this step is delayed after the whole tree
3652 is checked.  This alters results when references are found in
3653 footnote definitions."
3654   (let ((label (org-element-property :label footnote-reference)))
3655     ;; Anonymous footnotes are always a first reference.
3656     (or (not label)
3657         (catch 'exit
3658           (org-export--footnote-reference-map
3659            (lambda (f)
3660              (let ((l (org-element-property :label f)))
3661                (when (and l label (string= label l))
3662                  (throw 'exit (eq footnote-reference f)))))
3663            (or data (plist-get info :parse-tree)) info body-first)))))
3664
3665 (defun org-export-get-footnote-number (footnote info &optional data body-first)
3666   "Return number associated to a footnote.
3667
3668 FOOTNOTE is either a footnote reference or a footnote definition.
3669 INFO is the plist containing export state.
3670
3671 Number is unique throughout the whole parse tree, or DATA, when
3672 non-nil.
3673
3674 By default, as soon as a new footnote reference is encountered,
3675 counting process moves into its definition.  However, if
3676 BODY-FIRST is non-nil, this step is delayed until the end of the
3677 process, leading to a different order when footnotes are nested."
3678   (let ((count 0)
3679         (seen)
3680         (label (org-element-property :label footnote)))
3681     (catch 'exit
3682       (org-export--footnote-reference-map
3683        (lambda (f)
3684          (let ((l (org-element-property :label f)))
3685            (cond
3686             ;; Anonymous footnote match: return number.
3687             ((and (not l) (not label) (eq footnote f)) (throw 'exit (1+ count)))
3688             ;; Labels match: return number.
3689             ((and label l (string= label l)) (throw 'exit (1+ count)))
3690             ;; Otherwise store label and increase counter if label
3691             ;; wasn't encountered yet.
3692             ((not l) (incf count))
3693             ((not (member l seen)) (push l seen) (incf count)))))
3694        (or data (plist-get info :parse-tree)) info body-first))))
3695
3696
3697 ;;;; For Headlines
3698 ;;
3699 ;; `org-export-get-relative-level' is a shortcut to get headline
3700 ;; level, relatively to the lower headline level in the parsed tree.
3701 ;;
3702 ;; `org-export-get-headline-number' returns the section number of an
3703 ;; headline, while `org-export-number-to-roman' allows to convert it
3704 ;; to roman numbers.  With an optional argument,
3705 ;; `org-export-get-headline-number' returns a number to unnumbered
3706 ;; headlines (used for internal id).
3707 ;;
3708 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3709 ;; `org-export-last-sibling-p' are three useful predicates when it
3710 ;; comes to fulfill the `:headline-levels' property.
3711 ;;
3712 ;; `org-export-get-tags', `org-export-get-category' and
3713 ;; `org-export-get-node-property' extract useful information from an
3714 ;; headline or a parent headline.  They all handle inheritance.
3715 ;;
3716 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3717 ;; as a secondary string, suitable for table of contents.  It falls
3718 ;; back onto default title.
3719
3720 (defun org-export-get-relative-level (headline info)
3721   "Return HEADLINE relative level within current parsed tree.
3722 INFO is a plist holding contextual information."
3723   (+ (org-element-property :level headline)
3724      (or (plist-get info :headline-offset) 0)))
3725
3726 (defun org-export-low-level-p (headline info)
3727   "Non-nil when HEADLINE is considered as low level.
3728
3729 INFO is a plist used as a communication channel.
3730
3731 A low level headlines has a relative level greater than
3732 `:headline-levels' property value.
3733
3734 Return value is the difference between HEADLINE relative level
3735 and the last level being considered as high enough, or nil."
3736   (let ((limit (plist-get info :headline-levels)))
3737     (when (wholenump limit)
3738       (let ((level (org-export-get-relative-level headline info)))
3739         (and (> level limit) (- level limit))))))
3740
3741 (defun org-export-get-headline-number (headline info)
3742   "Return numbered HEADLINE numbering as a list of numbers.
3743 INFO is a plist holding contextual information."
3744   (and (org-export-numbered-headline-p headline info)
3745        (cdr (assq headline (plist-get info :headline-numbering)))))
3746
3747 (defun org-export-numbered-headline-p (headline info)
3748   "Return a non-nil value if HEADLINE element should be numbered.
3749 INFO is a plist used as a communication channel."
3750   (unless (org-some
3751            (lambda (head) (org-not-nil (org-element-property :UNNUMBERED head)))
3752            (org-element-lineage headline nil t))
3753     (let ((sec-num (plist-get info :section-numbers))
3754           (level (org-export-get-relative-level headline info)))
3755       (if (wholenump sec-num) (<= level sec-num) sec-num))))
3756
3757 (defun org-export-number-to-roman (n)
3758   "Convert integer N into a roman numeral."
3759   (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
3760                  ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
3761                  (  10 . "X") (  9 . "IX") (  5 . "V") (  4 . "IV")
3762                  (   1 . "I")))
3763         (res ""))
3764     (if (<= n 0)
3765         (number-to-string n)
3766       (while roman
3767         (if (>= n (caar roman))
3768             (setq n (- n (caar roman))
3769                   res (concat res (cdar roman)))
3770           (pop roman)))
3771       res)))
3772
3773 (defun org-export-get-tags (element info &optional tags inherited)
3774   "Return list of tags associated to ELEMENT.
3775
3776 ELEMENT has either an `headline' or an `inlinetask' type.  INFO
3777 is a plist used as a communication channel.
3778
3779 Select tags (see `org-export-select-tags') and exclude tags (see
3780 `org-export-exclude-tags') are removed from the list.
3781
3782 When non-nil, optional argument TAGS should be a list of strings.
3783 Any tag belonging to this list will also be removed.
3784
3785 When optional argument INHERITED is non-nil, tags can also be
3786 inherited from parent headlines and FILETAGS keywords."
3787   (org-remove-if
3788    (lambda (tag) (or (member tag (plist-get info :select-tags))
3789                 (member tag (plist-get info :exclude-tags))
3790                 (member tag tags)))
3791    (if (not inherited) (org-element-property :tags element)
3792      ;; Build complete list of inherited tags.
3793      (let ((current-tag-list (org-element-property :tags element)))
3794        (dolist (parent (org-element-lineage element))
3795          (dolist (tag (org-element-property :tags parent))
3796            (when (and (memq (org-element-type parent) '(headline inlinetask))
3797                       (not (member tag current-tag-list)))
3798              (push tag current-tag-list))))
3799        ;; Add FILETAGS keywords and return results.
3800        (org-uniquify (append (plist-get info :filetags) current-tag-list))))))
3801
3802 (defun org-export-get-node-property (property blob &optional inherited)
3803   "Return node PROPERTY value for BLOB.
3804
3805 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA').  BLOB is an
3806 element or object.
3807
3808 If optional argument INHERITED is non-nil, the value can be
3809 inherited from a parent headline.
3810
3811 Return value is a string or nil."
3812   (let ((headline (if (eq (org-element-type blob) 'headline) blob
3813                     (org-export-get-parent-headline blob))))
3814     (if (not inherited) (org-element-property property blob)
3815       (let ((parent headline) value)
3816         (catch 'found
3817           (while parent
3818             (when (plist-member (nth 1 parent) property)
3819               (throw 'found (org-element-property property parent)))
3820             (setq parent (org-element-property :parent parent))))))))
3821
3822 (defun org-export-get-category (blob info)
3823   "Return category for element or object BLOB.
3824
3825 INFO is a plist used as a communication channel.
3826
3827 CATEGORY is automatically inherited from a parent headline, from
3828 #+CATEGORY: keyword or created out of original file name.  If all
3829 fail, the fall-back value is \"???\"."
3830   (or (org-export-get-node-property :CATEGORY blob t)
3831       (org-element-map (plist-get info :parse-tree) 'keyword
3832         (lambda (kwd)
3833           (when (equal (org-element-property :key kwd) "CATEGORY")
3834             (org-element-property :value kwd)))
3835         info 'first-match)
3836       (let ((file (plist-get info :input-file)))
3837         (and file (file-name-sans-extension (file-name-nondirectory file))))
3838       "???"))
3839
3840 (defun org-export-get-alt-title (headline info)
3841   "Return alternative title for HEADLINE, as a secondary string.
3842 INFO is a plist used as a communication channel.  If no optional
3843 title is defined, fall-back to the regular title."
3844   (let ((alt (org-element-property :ALT_TITLE headline)))
3845     (if alt (org-element-parse-secondary-string
3846              alt (org-element-restriction 'headline) headline)
3847       (org-element-property :title headline))))
3848
3849 (defun org-export-first-sibling-p (blob info)
3850   "Non-nil when BLOB is the first sibling in its parent.
3851 BLOB is an element or an object.  If BLOB is a headline, non-nil
3852 means it is the first sibling in the sub-tree.  INFO is a plist
3853 used as a communication channel."
3854   (memq (org-element-type (org-export-get-previous-element blob info))
3855         '(nil section)))
3856
3857 (defun org-export-last-sibling-p (blob info)
3858   "Non-nil when BLOB is the last sibling in its parent.
3859 BLOB is an element or an object.  INFO is a plist used as
3860 a communication channel."
3861   (not (org-export-get-next-element blob info)))
3862
3863
3864 ;;;; For Keywords
3865 ;;
3866 ;; `org-export-get-date' returns a date appropriate for the document
3867 ;;  to about to be exported.  In particular, it takes care of
3868 ;;  `org-export-date-timestamp-format'.
3869
3870 (defun org-export-get-date (info &optional fmt)
3871   "Return date value for the current document.
3872
3873 INFO is a plist used as a communication channel.  FMT, when
3874 non-nil, is a time format string that will be applied on the date
3875 if it consists in a single timestamp object.  It defaults to
3876 `org-export-date-timestamp-format' when nil.
3877
3878 A proper date can be a secondary string, a string or nil.  It is
3879 meant to be translated with `org-export-data' or alike."
3880   (let ((date (plist-get info :date))
3881         (fmt (or fmt org-export-date-timestamp-format)))
3882     (cond ((not date) nil)
3883           ((and fmt
3884                 (not (cdr date))
3885                 (eq (org-element-type (car date)) 'timestamp))
3886            (org-timestamp-format (car date) fmt))
3887           (t date))))
3888
3889
3890 ;;;; For Links
3891 ;;
3892 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3893 ;; with `org-add-link-type', which see.
3894 ;;
3895 ;; `org-export-get-coderef-format' returns an appropriate format
3896 ;; string for coderefs.
3897 ;;
3898 ;; `org-export-inline-image-p' returns a non-nil value when the link
3899 ;; provided should be considered as an inline image.
3900 ;;
3901 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3902 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3903 ;; returns an appropriate unique identifier when found, or nil.
3904 ;;
3905 ;; `org-export-resolve-id-link' returns the first headline with
3906 ;; specified id or custom-id in parse tree, the path to the external
3907 ;; file with the id or nil when neither was found.
3908 ;;
3909 ;; `org-export-resolve-coderef' associates a reference to a line
3910 ;; number in the element it belongs, or returns the reference itself
3911 ;; when the element isn't numbered.
3912 ;;
3913 ;; `org-export-file-uri' expands a filename as stored in :path value
3914 ;;  of a "file" link into a file URI.
3915
3916 (defun org-export-custom-protocol-maybe (link desc backend)
3917   "Try exporting LINK with a dedicated function.
3918
3919 DESC is its description, as a string, or nil.  BACKEND is the
3920 back-end used for export, as a symbol.
3921
3922 Return output as a string, or nil if no protocol handles LINK.
3923
3924 A custom protocol has precedence over regular back-end export.
3925 The function ignores links with an implicit type (e.g.,
3926 \"custom-id\")."
3927   (let ((type (org-element-property :type link)))
3928     (unless (or (member type '("coderef" "custom-id" "fuzzy" "radio"))
3929                 (not backend))
3930       (let ((protocol (nth 2 (assoc type org-link-protocols))))
3931         (and (functionp protocol)
3932              (funcall protocol
3933                       (org-link-unescape (org-element-property :path link))
3934                       desc
3935                       backend))))))
3936
3937 (defun org-export-get-coderef-format (path desc)
3938   "Return format string for code reference link.
3939 PATH is the link path.  DESC is its description."
3940   (save-match-data
3941     (cond ((not desc) "%s")
3942           ((string-match (regexp-quote (concat "(" path ")")) desc)
3943            (replace-match "%s" t t desc))
3944           (t desc))))
3945
3946 (defun org-export-inline-image-p (link &optional rules)
3947   "Non-nil if LINK object points to an inline image.
3948
3949 Optional argument is a set of RULES defining inline images.  It
3950 is an alist where associations have the following shape:
3951
3952   \(TYPE . REGEXP)
3953
3954 Applying a rule means apply REGEXP against LINK's path when its
3955 type is TYPE.  The function will return a non-nil value if any of
3956 the provided rules is non-nil.  The default rule is
3957 `org-export-default-inline-image-rule'.
3958
3959 This only applies to links without a description."
3960   (and (not (org-element-contents link))
3961        (let ((case-fold-search t))
3962          (catch 'exit
3963            (dolist (rule (or rules org-export-default-inline-image-rule))
3964              (and (string= (org-element-property :type link) (car rule))
3965                   (org-string-match-p (cdr rule)
3966                                       (org-element-property :path link))
3967                   (throw 'exit t)))))))
3968
3969 (defun org-export-resolve-coderef (ref info)
3970   "Resolve a code reference REF.
3971
3972 INFO is a plist used as a communication channel.
3973
3974 Return associated line number in source code, or REF itself,
3975 depending on src-block or example element's switches.  Throw an
3976 error if no block contains REF."
3977   (or (org-element-map (plist-get info :parse-tree) '(example-block src-block)
3978         (lambda (el)
3979           (with-temp-buffer
3980             (insert (org-trim (org-element-property :value el)))
3981             (let* ((label-fmt (regexp-quote
3982                                (or (org-element-property :label-fmt el)
3983                                    org-coderef-label-format)))
3984                    (ref-re
3985                     (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
3986                             (format label-fmt ref))))
3987               ;; Element containing REF is found.  Resolve it to
3988               ;; either a label or a line number, as needed.
3989               (when (re-search-backward ref-re nil t)
3990                 (cond
3991                  ((org-element-property :use-labels el) ref)
3992                  ((eq (org-element-property :number-lines el) 'continued)
3993                   (+ (org-export-get-loc el info) (line-number-at-pos)))
3994                  (t (line-number-at-pos)))))))
3995         info 'first-match)
3996       (user-error "Unable to resolve code reference: %s" ref)))
3997
3998 (defun org-export-resolve-fuzzy-link (link info)
3999   "Return LINK destination.
4000
4001 INFO is a plist holding contextual information.
4002
4003 Return value can be an object, an element, or nil:
4004
4005 - If LINK path matches a target object (i.e. <<path>>) return it.
4006
4007 - If LINK path exactly matches the name affiliated keyword
4008   \(i.e. #+NAME: path) of an element, return that element.
4009
4010 - If LINK path exactly matches any headline name, return that
4011   element.  If more than one headline share that name, priority
4012   will be given to the one with the closest common ancestor, if
4013   any, or the first one in the parse tree otherwise.
4014
4015 - Otherwise, throw an error.
4016
4017 Assume LINK type is \"fuzzy\".  White spaces are not
4018 significant."
4019   (let* ((raw-path (org-element-property :path link))
4020          (match-title-p (eq (aref raw-path 0) ?*))
4021          ;; Split PATH at white spaces so matches are space
4022          ;; insensitive.
4023          (path (org-split-string
4024                 (if match-title-p (substring raw-path 1) raw-path)))
4025          ;; Cache for destinations that are not position dependent.
4026          (link-cache
4027           (or (plist-get info :resolve-fuzzy-link-cache)
4028               (plist-get (setq info (plist-put info :resolve-fuzzy-link-cache
4029                                                (make-hash-table :test 'equal)))
4030                          :resolve-fuzzy-link-cache)))
4031          (cached (gethash path link-cache 'not-found)))
4032     (cond
4033      ;; Destination is not position dependent: use cached value.
4034      ((and (not match-title-p) (not (eq cached 'not-found))) cached)
4035      ;; First try to find a matching "<<path>>" unless user specified
4036      ;; he was looking for a headline (path starts with a "*"
4037      ;; character).
4038      ((and (not match-title-p)
4039            (let ((match (org-element-map (plist-get info :parse-tree) 'target
4040                           (lambda (blob)
4041                             (and (equal (org-split-string
4042                                          (org-element-property :value blob))
4043                                         path)
4044                                  blob))
4045                           info 'first-match)))
4046              (and match (puthash path match link-cache)))))
4047      ;; Then try to find an element with a matching "#+NAME: path"
4048      ;; affiliated keyword.
4049      ((and (not match-title-p)
4050            (let ((match (org-element-map (plist-get info :parse-tree)
4051                             org-element-all-elements
4052                           (lambda (el)
4053                             (let ((name (org-element-property :name el)))
4054                               (when (and name
4055                                          (equal (org-split-string name) path))
4056                                 el)))
4057                           info 'first-match)))
4058              (and match (puthash path match link-cache)))))
4059      ;; Last case: link either points to a headline or to nothingness.
4060      ;; Try to find the source, with priority given to headlines with
4061      ;; the closest common ancestor.  If such candidate is found,
4062      ;; return it, otherwise signal an error.
4063      (t
4064       (let ((find-headline
4065              (function
4066               ;; Return first headline whose `:raw-value' property is
4067               ;; NAME in parse tree DATA, or nil.  Statistics cookies
4068               ;; are ignored.
4069               (lambda (name data)
4070                 (org-element-map data 'headline
4071                   (lambda (headline)
4072                     (when (equal (org-split-string
4073                                   (replace-regexp-in-string
4074                                    "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
4075                                    (org-element-property :raw-value headline)))
4076                                  name)
4077                       headline))
4078                   info 'first-match)))))
4079         ;; Search among headlines sharing an ancestor with link, from
4080         ;; closest to farthest.
4081         (catch 'exit
4082           (dolist (parent
4083                    (let ((parent-hl (org-export-get-parent-headline link)))
4084                      (if (not parent-hl) (list (plist-get info :parse-tree))
4085                        (org-element-lineage parent-hl nil t))))
4086             (let ((foundp (funcall find-headline path parent)))
4087               (when foundp (throw 'exit foundp))))
4088           ;; No destination found: error.
4089           (user-error "Unable to resolve link \"%s\"" raw-path)))))))
4090
4091 (defun org-export-resolve-id-link (link info)
4092   "Return headline referenced as LINK destination.
4093
4094 INFO is a plist used as a communication channel.
4095
4096 Return value can be the headline element matched in current parse
4097 tree or a file name.  Assume LINK type is either \"id\" or
4098 \"custom-id\".  Throw an error if no match is found."
4099   (let ((id (org-element-property :path link)))
4100     ;; First check if id is within the current parse tree.
4101     (or (org-element-map (plist-get info :parse-tree) 'headline
4102           (lambda (headline)
4103             (when (or (equal (org-element-property :ID headline) id)
4104                       (equal (org-element-property :CUSTOM_ID headline) id))
4105               headline))
4106           info 'first-match)
4107         ;; Otherwise, look for external files.
4108         (cdr (assoc id (plist-get info :id-alist)))
4109         (user-error "Unable to resolve ID \"%s\"" id))))
4110
4111 (defun org-export-resolve-radio-link (link info)
4112   "Return radio-target object referenced as LINK destination.
4113
4114 INFO is a plist used as a communication channel.
4115
4116 Return value can be a radio-target object or nil.  Assume LINK
4117 has type \"radio\"."
4118   (let ((path (replace-regexp-in-string
4119                "[ \r\t\n]+" " " (org-element-property :path link))))
4120     (org-element-map (plist-get info :parse-tree) 'radio-target
4121       (lambda (radio)
4122         (and (eq (compare-strings
4123                   (replace-regexp-in-string
4124                    "[ \r\t\n]+" " " (org-element-property :value radio))
4125                   nil nil path nil nil t)
4126                  t)
4127              radio))
4128       info 'first-match)))
4129
4130 (defun org-export-file-uri (filename)
4131   "Return file URI associated to FILENAME."
4132   (if (not (file-name-absolute-p filename)) filename
4133     (concat "file:/"
4134             (and (not (org-file-remote-p filename)) "/")
4135             (if (org-string-match-p "\\`~" filename)
4136                 (expand-file-name filename)
4137               filename))))
4138
4139
4140 ;;;; For References
4141 ;;
4142 ;; `org-export-get-reference' associate a unique reference for any
4143 ;; object or element.
4144 ;;
4145 ;; `org-export-get-ordinal' associates a sequence number to any object
4146 ;; or element.
4147
4148 (defun org-export-get-reference (datum info)
4149   "Return a unique reference for DATUM, as a string.
4150 DATUM is either an element or an object.  INFO is the current
4151 export state, as a plist.  Returned reference consists of
4152 alphanumeric characters only."
4153   (let ((type (org-element-type datum))
4154         (cache (or (plist-get info :internal-references)
4155                    (let ((h (make-hash-table :test #'eq)))
4156                      (plist-put info :internal-references h)
4157                      h))))
4158     (or (gethash datum cache)
4159         (puthash datum
4160                  (format "org%s%d"
4161                          (if type
4162                              (replace-regexp-in-string "-" "" (symbol-name type))
4163                            "secondarystring")
4164                          (incf (gethash type cache 0)))
4165                  cache))))
4166
4167 (defun org-export-get-ordinal (element info &optional types predicate)
4168   "Return ordinal number of an element or object.
4169
4170 ELEMENT is the element or object considered.  INFO is the plist
4171 used as a communication channel.
4172
4173 Optional argument TYPES, when non-nil, is a list of element or
4174 object types, as symbols, that should also be counted in.
4175 Otherwise, only provided element's type is considered.
4176
4177 Optional argument PREDICATE is a function returning a non-nil
4178 value if the current element or object should be counted in.  It
4179 accepts two arguments: the element or object being considered and
4180 the plist used as a communication channel.  This allows to count
4181 only a certain type of objects (i.e. inline images).
4182
4183 Return value is a list of numbers if ELEMENT is a headline or an
4184 item.  It is nil for keywords.  It represents the footnote number
4185 for footnote definitions and footnote references.  If ELEMENT is
4186 a target, return the same value as if ELEMENT was the closest
4187 table, item or headline containing the target.  In any other
4188 case, return the sequence number of ELEMENT among elements or
4189 objects of the same type."
4190   ;; Ordinal of a target object refer to the ordinal of the closest
4191   ;; table, item, or headline containing the object.
4192   (when (eq (org-element-type element) 'target)
4193     (setq element
4194           (org-element-lineage
4195            element
4196            '(footnote-definition footnote-reference headline item table))))
4197   (case (org-element-type element)
4198     ;; Special case 1: A headline returns its number as a list.
4199     (headline (org-export-get-headline-number element info))
4200     ;; Special case 2: An item returns its number as a list.
4201     (item (let ((struct (org-element-property :structure element)))
4202             (org-list-get-item-number
4203              (org-element-property :begin element)
4204              struct
4205              (org-list-prevs-alist struct)
4206              (org-list-parents-alist struct))))
4207     ((footnote-definition footnote-reference)
4208      (org-export-get-footnote-number element info))
4209     (otherwise
4210      (let ((counter 0))
4211        ;; Increment counter until ELEMENT is found again.
4212        (org-element-map (plist-get info :parse-tree)
4213            (or types (org-element-type element))
4214          (lambda (el)
4215            (cond
4216             ((eq element el) (1+ counter))
4217             ((not predicate) (incf counter) nil)
4218             ((funcall predicate el info) (incf counter) nil)))
4219          info 'first-match)))))
4220
4221
4222 ;;;; For Src-Blocks
4223 ;;
4224 ;; `org-export-get-loc' counts number of code lines accumulated in
4225 ;; src-block or example-block elements with a "+n" switch until
4226 ;; a given element, excluded.  Note: "-n" switches reset that count.
4227 ;;
4228 ;; `org-export-unravel-code' extracts source code (along with a code
4229 ;; references alist) from an `element-block' or `src-block' type
4230 ;; element.
4231 ;;
4232 ;; `org-export-format-code' applies a formatting function to each line
4233 ;; of code, providing relative line number and code reference when
4234 ;; appropriate.  Since it doesn't access the original element from
4235 ;; which the source code is coming, it expects from the code calling
4236 ;; it to know if lines should be numbered and if code references
4237 ;; should appear.
4238 ;;
4239 ;; Eventually, `org-export-format-code-default' is a higher-level
4240 ;; function (it makes use of the two previous functions) which handles
4241 ;; line numbering and code references inclusion, and returns source
4242 ;; code in a format suitable for plain text or verbatim output.
4243
4244 (defun org-export-get-loc (element info)
4245   "Return accumulated lines of code up to ELEMENT.
4246
4247 INFO is the plist used as a communication channel.
4248
4249 ELEMENT is excluded from count."
4250   (let ((loc 0))
4251     (org-element-map (plist-get info :parse-tree)
4252         `(src-block example-block ,(org-element-type element))
4253       (lambda (el)
4254         (cond
4255          ;; ELEMENT is reached: Quit the loop.
4256          ((eq el element))
4257          ;; Only count lines from src-block and example-block elements
4258          ;; with a "+n" or "-n" switch.  A "-n" switch resets counter.
4259          ((not (memq (org-element-type el) '(src-block example-block))) nil)
4260          ((let ((linums (org-element-property :number-lines el)))
4261             (when linums
4262               ;; Accumulate locs or reset them.
4263               (let ((lines (org-count-lines
4264                             (org-trim (org-element-property :value el)))))
4265                 (setq loc (if (eq linums 'new) lines (+ loc lines))))))
4266           ;; Return nil to stay in the loop.
4267           nil)))
4268       info 'first-match)
4269     ;; Return value.
4270     loc))
4271
4272 (defun org-export-unravel-code (element)
4273   "Clean source code and extract references out of it.
4274
4275 ELEMENT has either a `src-block' an `example-block' type.
4276
4277 Return a cons cell whose CAR is the source code, cleaned from any
4278 reference, protective commas and spurious indentation, and CDR is
4279 an alist between relative line number (integer) and name of code
4280 reference on that line (string)."
4281   (let* ((line 0) refs
4282          (value (org-element-property :value element))
4283          ;; Get code and clean it.  Remove blank lines at its
4284          ;; beginning and end.
4285          (code (replace-regexp-in-string
4286                 "\\`\\([ \t]*\n\\)+" ""
4287                 (replace-regexp-in-string
4288                  "\\([ \t]*\n\\)*[ \t]*\\'" "\n"
4289                  (if (or org-src-preserve-indentation
4290                          (org-element-property :preserve-indent element))
4291                      value
4292                    (org-element-remove-indentation value)))))
4293          ;; Get format used for references.
4294          (label-fmt (regexp-quote
4295                      (or (org-element-property :label-fmt element)
4296                          org-coderef-label-format)))
4297          ;; Build a regexp matching a loc with a reference.
4298          (with-ref-re
4299           (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)[ \t]*\\)$"
4300                   (replace-regexp-in-string
4301                    "%s" "\\([-a-zA-Z0-9_ ]+\\)" label-fmt nil t))))
4302     ;; Return value.
4303     (cons
4304      ;; Code with references removed.
4305      (org-element-normalize-string
4306       (mapconcat
4307        (lambda (loc)
4308          (incf line)
4309          (if (not (string-match with-ref-re loc)) loc
4310            ;; Ref line: remove ref, and signal its position in REFS.
4311            (push (cons line (match-string 3 loc)) refs)
4312            (replace-match "" nil nil loc 1)))
4313        (org-split-string code "\n") "\n"))
4314      ;; Reference alist.
4315      refs)))
4316
4317 (defun org-export-format-code (code fun &optional num-lines ref-alist)
4318   "Format CODE by applying FUN line-wise and return it.
4319
4320 CODE is a string representing the code to format.  FUN is
4321 a function.  It must accept three arguments: a line of
4322 code (string), the current line number (integer) or nil and the
4323 reference associated to the current line (string) or nil.
4324
4325 Optional argument NUM-LINES can be an integer representing the
4326 number of code lines accumulated until the current code.  Line
4327 numbers passed to FUN will take it into account.  If it is nil,
4328 FUN's second argument will always be nil.  This number can be
4329 obtained with `org-export-get-loc' function.
4330
4331 Optional argument REF-ALIST can be an alist between relative line
4332 number (i.e. ignoring NUM-LINES) and the name of the code
4333 reference on it.  If it is nil, FUN's third argument will always
4334 be nil.  It can be obtained through the use of
4335 `org-export-unravel-code' function."
4336   (let ((--locs (org-split-string code "\n"))
4337         (--line 0))
4338     (org-element-normalize-string
4339      (mapconcat
4340       (lambda (--loc)
4341         (incf --line)
4342         (let ((--ref (cdr (assq --line ref-alist))))
4343           (funcall fun --loc (and num-lines (+ num-lines --line)) --ref)))
4344       --locs "\n"))))
4345
4346 (defun org-export-format-code-default (element info)
4347   "Return source code from ELEMENT, formatted in a standard way.
4348
4349 ELEMENT is either a `src-block' or `example-block' element.  INFO
4350 is a plist used as a communication channel.
4351
4352 This function takes care of line numbering and code references
4353 inclusion.  Line numbers, when applicable, appear at the
4354 beginning of the line, separated from the code by two white
4355 spaces.  Code references, on the other hand, appear flushed to
4356 the right, separated by six white spaces from the widest line of
4357 code."
4358   ;; Extract code and references.
4359   (let* ((code-info (org-export-unravel-code element))
4360          (code (car code-info))
4361          (code-lines (org-split-string code "\n")))
4362     (if (null code-lines) ""
4363       (let* ((refs (and (org-element-property :retain-labels element)
4364                         (cdr code-info)))
4365              ;; Handle line numbering.
4366              (num-start (case (org-element-property :number-lines element)
4367                           (continued (org-export-get-loc element info))
4368                           (new 0)))
4369              (num-fmt
4370               (and num-start
4371                    (format "%%%ds  "
4372                            (length (number-to-string
4373                                     (+ (length code-lines) num-start))))))
4374              ;; Prepare references display, if required.  Any reference
4375              ;; should start six columns after the widest line of code,
4376              ;; wrapped with parenthesis.
4377              (max-width
4378               (+ (apply 'max (mapcar 'length code-lines))
4379                  (if (not num-start) 0 (length (format num-fmt num-start))))))
4380         (org-export-format-code
4381          code
4382          (lambda (loc line-num ref)
4383            (let ((number-str (and num-fmt (format num-fmt line-num))))
4384              (concat
4385               number-str
4386               loc
4387               (and ref
4388                    (concat (make-string
4389                             (- (+ 6 max-width)
4390                                (+ (length loc) (length number-str))) ? )
4391                            (format "(%s)" ref))))))
4392          num-start refs)))))
4393
4394
4395 ;;;; For Tables
4396 ;;
4397 ;; `org-export-table-has-special-column-p' and and
4398 ;; `org-export-table-row-is-special-p' are predicates used to look for
4399 ;; meta-information about the table structure.
4400 ;;
4401 ;; `org-table-has-header-p' tells when the rows before the first rule
4402 ;;  should be considered as table's header.
4403 ;;
4404 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4405 ;; and `org-export-table-cell-borders' extract information from
4406 ;; a table-cell element.
4407 ;;
4408 ;; `org-export-table-dimensions' gives the number on rows and columns
4409 ;; in the table, ignoring horizontal rules and special columns.
4410 ;; `org-export-table-cell-address', given a table-cell object, returns
4411 ;; the absolute address of a cell. On the other hand,
4412 ;; `org-export-get-table-cell-at' does the contrary.
4413 ;;
4414 ;; `org-export-table-cell-starts-colgroup-p',
4415 ;; `org-export-table-cell-ends-colgroup-p',
4416 ;; `org-export-table-row-starts-rowgroup-p',
4417 ;; `org-export-table-row-ends-rowgroup-p',
4418 ;; `org-export-table-row-starts-header-p',
4419 ;; `org-export-table-row-ends-header-p' and
4420 ;; `org-export-table-row-in-header-p' indicate position of current row
4421 ;; or cell within the table.
4422
4423 (defun org-export-table-has-special-column-p (table)
4424   "Non-nil when TABLE has a special column.
4425 All special columns will be ignored during export."
4426   ;; The table has a special column when every first cell of every row
4427   ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4428   ;; "*" "_" and "^".  Though, do not consider a first row containing
4429   ;; only empty cells as special.
4430   (let ((special-column-p 'empty))
4431     (catch 'exit
4432       (mapc
4433        (lambda (row)
4434          (when (eq (org-element-property :type row) 'standard)
4435            (let ((value (org-element-contents
4436                          (car (org-element-contents row)))))
4437              (cond ((member value '(("/") ("#") ("!") ("$") ("*") ("_") ("^")))
4438                     (setq special-column-p 'special))
4439                    ((not value))
4440                    (t (throw 'exit nil))))))
4441        (org-element-contents table))
4442       (eq special-column-p 'special))))
4443
4444 (defun org-export-table-has-header-p (table info)
4445   "Non-nil when TABLE has a header.
4446
4447 INFO is a plist used as a communication channel.
4448
4449 A table has a header when it contains at least two row groups."
4450   (let ((cache (or (plist-get info :table-header-cache)
4451                    (plist-get (setq info
4452                                     (plist-put info :table-header-cache
4453                                                (make-hash-table :test 'eq)))
4454                               :table-header-cache))))
4455     (or (gethash table cache)
4456         (let ((rowgroup 1) row-flag)
4457           (puthash
4458            table
4459            (org-element-map table 'table-row
4460              (lambda (row)
4461                (cond
4462                 ((> rowgroup 1) t)
4463                 ((and row-flag (eq (org-element-property :type row) 'rule))
4464                  (incf rowgroup) (setq row-flag nil))
4465                 ((and (not row-flag) (eq (org-element-property :type row)
4466                                          'standard))
4467                  (setq row-flag t) nil)))
4468              info 'first-match)
4469            cache)))))
4470
4471 (defun org-export-table-row-is-special-p (table-row info)
4472   "Non-nil if TABLE-ROW is considered special.
4473
4474 INFO is a plist used as the communication channel.
4475
4476 All special rows will be ignored during export."
4477   (when (eq (org-element-property :type table-row) 'standard)
4478     (let ((first-cell (org-element-contents
4479                        (car (org-element-contents table-row)))))
4480       ;; A row is special either when...
4481       (or
4482        ;; ... it starts with a field only containing "/",
4483        (equal first-cell '("/"))
4484        ;; ... the table contains a special column and the row start
4485        ;; with a marking character among, "^", "_", "$" or "!",
4486        (and (org-export-table-has-special-column-p
4487              (org-export-get-parent table-row))
4488             (member first-cell '(("^") ("_") ("$") ("!"))))
4489        ;; ... it contains only alignment cookies and empty cells.
4490        (let ((special-row-p 'empty))
4491          (catch 'exit
4492            (mapc
4493             (lambda (cell)
4494               (let ((value (org-element-contents cell)))
4495                 ;; Since VALUE is a secondary string, the following
4496                 ;; checks avoid expanding it with `org-export-data'.
4497                 (cond ((not value))
4498                       ((and (not (cdr value))
4499                             (stringp (car value))
4500                             (string-match "\\`<[lrc]?\\([0-9]+\\)?>\\'"
4501                                           (car value)))
4502                        (setq special-row-p 'cookie))
4503                       (t (throw 'exit nil)))))
4504             (org-element-contents table-row))
4505            (eq special-row-p 'cookie)))))))
4506
4507 (defun org-export-table-row-group (table-row info)
4508   "Return TABLE-ROW's group number, as an integer.
4509
4510 INFO is a plist used as the communication channel.
4511
4512 Return value is the group number, as an integer, or nil for
4513 special rows and rows separators.  First group is also table's
4514 header."
4515   (let ((cache (or (plist-get info :table-row-group-cache)
4516                    (plist-get (setq info
4517                                     (plist-put info :table-row-group-cache
4518                                                (make-hash-table :test 'eq)))
4519                               :table-row-group-cache))))
4520     (cond ((gethash table-row cache))
4521           ((eq (org-element-property :type table-row) 'rule) nil)
4522           (t (let ((group 0) row-flag)
4523                (org-element-map (org-export-get-parent table-row) 'table-row
4524                  (lambda (row)
4525                    (if (eq (org-element-property :type row) 'rule)
4526                        (setq row-flag nil)
4527                      (unless row-flag (incf group) (setq row-flag t)))
4528                    (when (eq table-row row) (puthash table-row group cache)))
4529                  info 'first-match))))))
4530
4531 (defun org-export-table-cell-width (table-cell info)
4532   "Return TABLE-CELL contents width.
4533
4534 INFO is a plist used as the communication channel.
4535
4536 Return value is the width given by the last width cookie in the
4537 same column as TABLE-CELL, or nil."
4538   (let* ((row (org-export-get-parent table-cell))
4539          (table (org-export-get-parent row))
4540          (cells (org-element-contents row))
4541          (columns (length cells))
4542          (column (- columns (length (memq table-cell cells))))
4543          (cache (or (plist-get info :table-cell-width-cache)
4544                     (plist-get (setq info
4545                                      (plist-put info :table-cell-width-cache
4546                                                 (make-hash-table :test 'eq)))
4547                                :table-cell-width-cache)))
4548          (width-vector (or (gethash table cache)
4549                            (puthash table (make-vector columns 'empty) cache)))
4550          (value (aref width-vector column)))
4551     (if (not (eq value 'empty)) value
4552       (let (cookie-width)
4553         (dolist (row (org-element-contents table)
4554                      (aset width-vector column cookie-width))
4555           (when (org-export-table-row-is-special-p row info)
4556             ;; In a special row, try to find a width cookie at COLUMN.
4557             (let* ((value (org-element-contents
4558                            (elt (org-element-contents row) column)))
4559                    (cookie (car value)))
4560               ;; The following checks avoid expanding unnecessarily
4561               ;; the cell with `org-export-data'.
4562               (when (and value
4563                          (not (cdr value))
4564                          (stringp cookie)
4565                          (string-match "\\`<[lrc]?\\([0-9]+\\)?>\\'" cookie)
4566                          (match-string 1 cookie))
4567                 (setq cookie-width
4568                       (string-to-number (match-string 1 cookie)))))))))))
4569
4570 (defun org-export-table-cell-alignment (table-cell info)
4571   "Return TABLE-CELL contents alignment.
4572
4573 INFO is a plist used as the communication channel.
4574
4575 Return alignment as specified by the last alignment cookie in the
4576 same column as TABLE-CELL.  If no such cookie is found, a default
4577 alignment value will be deduced from fraction of numbers in the
4578 column (see `org-table-number-fraction' for more information).
4579 Possible values are `left', `right' and `center'."
4580   ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4581   (require 'org-table)
4582   (let* ((row (org-export-get-parent table-cell))
4583          (table (org-export-get-parent row))
4584          (cells (org-element-contents row))
4585          (columns (length cells))
4586          (column (- columns (length (memq table-cell cells))))
4587          (cache (or (plist-get info :table-cell-alignment-cache)
4588                     (plist-get (setq info
4589                                      (plist-put info :table-cell-alignment-cache
4590                                                 (make-hash-table :test 'eq)))
4591                                :table-cell-alignment-cache)))
4592          (align-vector (or (gethash table cache)
4593                            (puthash table (make-vector columns nil) cache))))
4594     (or (aref align-vector column)
4595         (let ((number-cells 0)
4596               (total-cells 0)
4597               cookie-align
4598               previous-cell-number-p)
4599           (dolist (row (org-element-contents (org-export-get-parent row)))
4600             (cond
4601              ;; In a special row, try to find an alignment cookie at
4602              ;; COLUMN.
4603              ((org-export-table-row-is-special-p row info)
4604               (let ((value (org-element-contents
4605                             (elt (org-element-contents row) column))))
4606                 ;; Since VALUE is a secondary string, the following
4607                 ;; checks avoid useless expansion through
4608                 ;; `org-export-data'.
4609                 (when (and value
4610                            (not (cdr value))
4611                            (stringp (car value))
4612                            (string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'"
4613                                          (car value))
4614                            (match-string 1 (car value)))
4615                   (setq cookie-align (match-string 1 (car value))))))
4616              ;; Ignore table rules.
4617              ((eq (org-element-property :type row) 'rule))
4618              ;; In a standard row, check if cell's contents are
4619              ;; expressing some kind of number.  Increase NUMBER-CELLS
4620              ;; accordingly.  Though, don't bother if an alignment
4621              ;; cookie has already defined cell's alignment.
4622              ((not cookie-align)
4623               (let ((value (org-export-data
4624                             (org-element-contents
4625                              (elt (org-element-contents row) column))
4626                             info)))
4627                 (incf total-cells)
4628                 ;; Treat an empty cell as a number if it follows
4629                 ;; a number.
4630                 (if (not (or (string-match org-table-number-regexp value)
4631                              (and (string= value "") previous-cell-number-p)))
4632                     (setq previous-cell-number-p nil)
4633                   (setq previous-cell-number-p t)
4634                   (incf number-cells))))))
4635           ;; Return value.  Alignment specified by cookies has
4636           ;; precedence over alignment deduced from cell's contents.
4637           (aset align-vector
4638                 column
4639                 (cond ((equal cookie-align "l") 'left)
4640                       ((equal cookie-align "r") 'right)
4641                       ((equal cookie-align "c") 'center)
4642                       ((>= (/ (float number-cells) total-cells)
4643                            org-table-number-fraction)
4644                        'right)
4645                       (t 'left)))))))
4646
4647 (defun org-export-table-cell-borders (table-cell info)
4648   "Return TABLE-CELL borders.
4649
4650 INFO is a plist used as a communication channel.
4651
4652 Return value is a list of symbols, or nil.  Possible values are:
4653 `top', `bottom', `above', `below', `left' and `right'.  Note:
4654 `top' (resp. `bottom') only happen for a cell in the first
4655 row (resp. last row) of the table, ignoring table rules, if any.
4656
4657 Returned borders ignore special rows."
4658   (let* ((row (org-export-get-parent table-cell))
4659          (table (org-export-get-parent-table table-cell))
4660          borders)
4661     ;; Top/above border?  TABLE-CELL has a border above when a rule
4662     ;; used to demarcate row groups can be found above.  Hence,
4663     ;; finding a rule isn't sufficient to push `above' in BORDERS:
4664     ;; another regular row has to be found above that rule.
4665     (let (rule-flag)
4666       (catch 'exit
4667         (mapc (lambda (row)
4668                 (cond ((eq (org-element-property :type row) 'rule)
4669                        (setq rule-flag t))
4670                       ((not (org-export-table-row-is-special-p row info))
4671                        (if rule-flag (throw 'exit (push 'above borders))
4672                          (throw 'exit nil)))))
4673               ;; Look at every row before the current one.
4674               (cdr (memq row (reverse (org-element-contents table)))))
4675         ;; No rule above, or rule found starts the table (ignoring any
4676         ;; special row): TABLE-CELL is at the top of the table.
4677         (when rule-flag (push 'above borders))
4678         (push 'top borders)))
4679     ;; Bottom/below border? TABLE-CELL has a border below when next
4680     ;; non-regular row below is a rule.
4681     (let (rule-flag)
4682       (catch 'exit
4683         (mapc (lambda (row)
4684                 (cond ((eq (org-element-property :type row) 'rule)
4685                        (setq rule-flag t))
4686                       ((not (org-export-table-row-is-special-p row info))
4687                        (if rule-flag (throw 'exit (push 'below borders))
4688                          (throw 'exit nil)))))
4689               ;; Look at every row after the current one.
4690               (cdr (memq row (org-element-contents table))))
4691         ;; No rule below, or rule found ends the table (modulo some
4692         ;; special row): TABLE-CELL is at the bottom of the table.
4693         (when rule-flag (push 'below borders))
4694         (push 'bottom borders)))
4695     ;; Right/left borders?  They can only be specified by column
4696     ;; groups.  Column groups are defined in a row starting with "/".
4697     ;; Also a column groups row only contains "<", "<>", ">" or blank
4698     ;; cells.
4699     (catch 'exit
4700       (let ((column (let ((cells (org-element-contents row)))
4701                       (- (length cells) (length (memq table-cell cells))))))
4702         (mapc
4703          (lambda (row)
4704            (unless (eq (org-element-property :type row) 'rule)
4705              (when (equal (org-element-contents
4706                            (car (org-element-contents row)))
4707                           '("/"))
4708                (let ((column-groups
4709                       (mapcar
4710                        (lambda (cell)
4711                          (let ((value (org-element-contents cell)))
4712                            (when (member value '(("<") ("<>") (">") nil))
4713                              (car value))))
4714                        (org-element-contents row))))
4715                  ;; There's a left border when previous cell, if
4716                  ;; any, ends a group, or current one starts one.
4717                  (when (or (and (not (zerop column))
4718                                 (member (elt column-groups (1- column))
4719                                         '(">" "<>")))
4720                            (member (elt column-groups column) '("<" "<>")))
4721                    (push 'left borders))
4722                  ;; There's a right border when next cell, if any,
4723                  ;; starts a group, or current one ends one.
4724                  (when (or (and (/= (1+ column) (length column-groups))
4725                                 (member (elt column-groups (1+ column))
4726                                         '("<" "<>")))
4727                            (member (elt column-groups column) '(">" "<>")))
4728                    (push 'right borders))
4729                  (throw 'exit nil)))))
4730          ;; Table rows are read in reverse order so last column groups
4731          ;; row has precedence over any previous one.
4732          (reverse (org-element-contents table)))))
4733     ;; Return value.
4734     borders))
4735
4736 (defun org-export-table-cell-starts-colgroup-p (table-cell info)
4737   "Non-nil when TABLE-CELL is at the beginning of a column group.
4738 INFO is a plist used as a communication channel."
4739   ;; A cell starts a column group either when it is at the beginning
4740   ;; of a row (or after the special column, if any) or when it has
4741   ;; a left border.
4742   (or (eq (org-element-map (org-export-get-parent table-cell) 'table-cell
4743             'identity info 'first-match)
4744           table-cell)
4745       (memq 'left (org-export-table-cell-borders table-cell info))))
4746
4747 (defun org-export-table-cell-ends-colgroup-p (table-cell info)
4748   "Non-nil when TABLE-CELL is at the end of a column group.
4749 INFO is a plist used as a communication channel."
4750   ;; A cell ends a column group either when it is at the end of a row
4751   ;; or when it has a right border.
4752   (or (eq (car (last (org-element-contents
4753                          (org-export-get-parent table-cell))))
4754              table-cell)
4755       (memq 'right (org-export-table-cell-borders table-cell info))))
4756
4757 (defun org-export-table-row-starts-rowgroup-p (table-row info)
4758   "Non-nil when TABLE-ROW is at the beginning of a row group.
4759 INFO is a plist used as a communication channel."
4760   (unless (or (eq (org-element-property :type table-row) 'rule)
4761               (org-export-table-row-is-special-p table-row info))
4762     (let ((borders (org-export-table-cell-borders
4763                     (car (org-element-contents table-row)) info)))
4764       (or (memq 'top borders) (memq 'above borders)))))
4765
4766 (defun org-export-table-row-ends-rowgroup-p (table-row info)
4767   "Non-nil when TABLE-ROW is at the end of a row group.
4768 INFO is a plist used as a communication channel."
4769   (unless (or (eq (org-element-property :type table-row) 'rule)
4770               (org-export-table-row-is-special-p table-row info))
4771     (let ((borders (org-export-table-cell-borders
4772                     (car (org-element-contents table-row)) info)))
4773       (or (memq 'bottom borders) (memq 'below borders)))))
4774
4775 (defun org-export-table-row-in-header-p (table-row info)
4776   "Non-nil when TABLE-ROW is located within table's header.
4777 INFO is a plist used as a communication channel.  Always return
4778 nil for special rows and rows separators."
4779   (and (org-export-table-has-header-p
4780         (org-export-get-parent-table table-row) info)
4781        (eql (org-export-table-row-group table-row info) 1)))
4782
4783 (defun org-export-table-row-starts-header-p (table-row info)
4784   "Non-nil when TABLE-ROW is the first table header's row.
4785 INFO is a plist used as a communication channel."
4786   (and (org-export-table-row-in-header-p table-row info)
4787        (org-export-table-row-starts-rowgroup-p table-row info)))
4788
4789 (defun org-export-table-row-ends-header-p (table-row info)
4790   "Non-nil when TABLE-ROW is the last table header's row.
4791 INFO is a plist used as a communication channel."
4792   (and (org-export-table-row-in-header-p table-row info)
4793        (org-export-table-row-ends-rowgroup-p table-row info)))
4794
4795 (defun org-export-table-row-number (table-row info)
4796   "Return TABLE-ROW number.
4797 INFO is a plist used as a communication channel.  Return value is
4798 zero-based and ignores separators.  The function returns nil for
4799 special columns and separators."
4800   (when (and (eq (org-element-property :type table-row) 'standard)
4801              (not (org-export-table-row-is-special-p table-row info)))
4802     (let ((number 0))
4803       (org-element-map (org-export-get-parent-table table-row) 'table-row
4804         (lambda (row)
4805           (cond ((eq row table-row) number)
4806                 ((eq (org-element-property :type row) 'standard)
4807                  (incf number) nil)))
4808         info 'first-match))))
4809
4810 (defun org-export-table-dimensions (table info)
4811   "Return TABLE dimensions.
4812
4813 INFO is a plist used as a communication channel.
4814
4815 Return value is a CONS like (ROWS . COLUMNS) where
4816 ROWS (resp. COLUMNS) is the number of exportable
4817 rows (resp. columns)."
4818   (let (first-row (columns 0) (rows 0))
4819     ;; Set number of rows, and extract first one.
4820     (org-element-map table 'table-row
4821       (lambda (row)
4822         (when (eq (org-element-property :type row) 'standard)
4823           (incf rows)
4824           (unless first-row (setq first-row row)))) info)
4825     ;; Set number of columns.
4826     (org-element-map first-row 'table-cell (lambda (cell) (incf columns)) info)
4827     ;; Return value.
4828     (cons rows columns)))
4829
4830 (defun org-export-table-cell-address (table-cell info)
4831   "Return address of a regular TABLE-CELL object.
4832
4833 TABLE-CELL is the cell considered.  INFO is a plist used as
4834 a communication channel.
4835
4836 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4837 zero-based index.  Only exportable cells are considered.  The
4838 function returns nil for other cells."
4839   (let* ((table-row (org-export-get-parent table-cell))
4840          (row-number (org-export-table-row-number table-row info)))
4841     (when row-number
4842       (cons row-number
4843             (let ((col-count 0))
4844               (org-element-map table-row 'table-cell
4845                 (lambda (cell)
4846                   (if (eq cell table-cell) col-count (incf col-count) nil))
4847                 info 'first-match))))))
4848
4849 (defun org-export-get-table-cell-at (address table info)
4850   "Return regular table-cell object at ADDRESS in TABLE.
4851
4852 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4853 zero-based index.  TABLE is a table type element.  INFO is
4854 a plist used as a communication channel.
4855
4856 If no table-cell, among exportable cells, is found at ADDRESS,
4857 return nil."
4858   (let ((column-pos (cdr address)) (column-count 0))
4859     (org-element-map
4860         ;; Row at (car address) or nil.
4861         (let ((row-pos (car address)) (row-count 0))
4862           (org-element-map table 'table-row
4863             (lambda (row)
4864               (cond ((eq (org-element-property :type row) 'rule) nil)
4865                     ((= row-count row-pos) row)
4866                     (t (incf row-count) nil)))
4867             info 'first-match))
4868         'table-cell
4869       (lambda (cell)
4870         (if (= column-count column-pos) cell
4871           (incf column-count) nil))
4872       info 'first-match)))
4873
4874
4875 ;;;; For Tables Of Contents
4876 ;;
4877 ;; `org-export-collect-headlines' builds a list of all exportable
4878 ;; headline elements, maybe limited to a certain depth.  One can then
4879 ;; easily parse it and transcode it.
4880 ;;
4881 ;; Building lists of tables, figures or listings is quite similar.
4882 ;; Once the generic function `org-export-collect-elements' is defined,
4883 ;; `org-export-collect-tables', `org-export-collect-figures' and
4884 ;; `org-export-collect-listings' can be derived from it.
4885
4886 (defun org-export-collect-headlines (info &optional n scope)
4887   "Collect headlines in order to build a table of contents.
4888
4889 INFO is a plist used as a communication channel.
4890
4891 When optional argument N is an integer, it specifies the depth of
4892 the table of contents.  Otherwise, it is set to the value of the
4893 last headline level.  See `org-export-headline-levels' for more
4894 information.
4895
4896 Optional argument SCOPE, when non-nil, is an element.  If it is
4897 a headline, only children of SCOPE are collected.  Otherwise,
4898 collect children of the headline containing provided element.  If
4899 there is no such headline, collect all headlines.  In any case,
4900 argument N becomes relative to the level of that headline.
4901
4902 Return a list of all exportable headlines as parsed elements.
4903 Footnote sections are ignored."
4904   (let* ((scope (cond ((not scope) (plist-get info :parse-tree))
4905                       ((eq (org-element-type scope) 'headline) scope)
4906                       ((org-export-get-parent-headline scope))
4907                       (t (plist-get info :parse-tree))))
4908          (limit (plist-get info :headline-levels))
4909          (n (if (not (wholenump n)) limit
4910               (min (if (eq (org-element-type scope) 'org-data) n
4911                      (+ (org-export-get-relative-level scope info) n))
4912                    limit))))
4913     (org-element-map (org-element-contents scope) 'headline
4914       (lambda (headline)
4915         (unless (org-element-property :footnote-section-p headline)
4916           (let ((level (org-export-get-relative-level headline info)))
4917             (and (<= level n) headline))))
4918       info)))
4919
4920 (defun org-export-collect-elements (type info &optional predicate)
4921   "Collect referenceable elements of a determined type.
4922
4923 TYPE can be a symbol or a list of symbols specifying element
4924 types to search.  Only elements with a caption are collected.
4925
4926 INFO is a plist used as a communication channel.
4927
4928 When non-nil, optional argument PREDICATE is a function accepting
4929 one argument, an element of type TYPE.  It returns a non-nil
4930 value when that element should be collected.
4931
4932 Return a list of all elements found, in order of appearance."
4933   (org-element-map (plist-get info :parse-tree) type
4934     (lambda (element)
4935       (and (org-element-property :caption element)
4936            (or (not predicate) (funcall predicate element))
4937            element))
4938     info))
4939
4940 (defun org-export-collect-tables (info)
4941   "Build a list of tables.
4942 INFO is a plist used as a communication channel.
4943
4944 Return a list of table elements with a caption."
4945   (org-export-collect-elements 'table info))
4946
4947 (defun org-export-collect-figures (info predicate)
4948   "Build a list of figures.
4949
4950 INFO is a plist used as a communication channel.  PREDICATE is
4951 a function which accepts one argument: a paragraph element and
4952 whose return value is non-nil when that element should be
4953 collected.
4954
4955 A figure is a paragraph type element, with a caption, verifying
4956 PREDICATE.  The latter has to be provided since a \"figure\" is
4957 a vague concept that may depend on back-end.
4958
4959 Return a list of elements recognized as figures."
4960   (org-export-collect-elements 'paragraph info predicate))
4961
4962 (defun org-export-collect-listings (info)
4963   "Build a list of src blocks.
4964
4965 INFO is a plist used as a communication channel.
4966
4967 Return a list of src-block elements with a caption."
4968   (org-export-collect-elements 'src-block info))
4969
4970
4971 ;;;; Smart Quotes
4972 ;;
4973 ;; The main function for the smart quotes sub-system is
4974 ;; `org-export-activate-smart-quotes', which replaces every quote in
4975 ;; a given string from the parse tree with its "smart" counterpart.
4976 ;;
4977 ;; Dictionary for smart quotes is stored in
4978 ;; `org-export-smart-quotes-alist'.
4979 ;;
4980 ;; Internally, regexps matching potential smart quotes (checks at
4981 ;; string boundaries are also necessary) are defined in
4982 ;; `org-export-smart-quotes-regexps'.
4983
4984 (defconst org-export-smart-quotes-alist
4985   '(("da"
4986      ;; one may use: »...«, "...", ›...‹, or '...'.
4987      ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4988      ;; LaTeX quotes require Babel!
4989      (opening-double-quote :utf-8 "»" :html "&raquo;" :latex ">>"
4990                            :texinfo "@guillemetright{}")
4991      (closing-double-quote :utf-8 "«" :html "&laquo;" :latex "<<"
4992                            :texinfo "@guillemetleft{}")
4993      (opening-single-quote :utf-8 "›" :html "&rsaquo;" :latex "\\frq{}"
4994                            :texinfo "@guilsinglright{}")
4995      (closing-single-quote :utf-8 "‹" :html "&lsaquo;" :latex "\\flq{}"
4996                            :texinfo "@guilsingleft{}")
4997      (apostrophe :utf-8 "’" :html "&rsquo;"))
4998     ("de"
4999      (opening-double-quote :utf-8 "„" :html "&bdquo;" :latex "\"`"
5000                            :texinfo "@quotedblbase{}")
5001      (closing-double-quote :utf-8 "“" :html "&ldquo;" :latex "\"'"
5002                            :texinfo "@quotedblleft{}")
5003      (opening-single-quote :utf-8 "‚" :html "&sbquo;" :latex "\\glq{}"
5004                            :texinfo "@quotesinglbase{}")
5005      (closing-single-quote :utf-8 "‘" :html "&lsquo;" :latex "\\grq{}"
5006                            :texinfo "@quoteleft{}")
5007      (apostrophe :utf-8 "’" :html "&rsquo;"))
5008     ("en"
5009      (opening-double-quote :utf-8 "“" :html "&ldquo;" :latex "``" :texinfo "``")
5010      (closing-double-quote :utf-8 "”" :html "&rdquo;" :latex "''" :texinfo "''")
5011      (opening-single-quote :utf-8 "‘" :html "&lsquo;" :latex "`" :texinfo "`")
5012      (closing-single-quote :utf-8 "’" :html "&rsquo;" :latex "'" :texinfo "'")
5013      (apostrophe :utf-8 "’" :html "&rsquo;"))
5014     ("es"
5015      (opening-double-quote :utf-8 "«" :html "&laquo;" :latex "\\guillemotleft{}"
5016                            :texinfo "@guillemetleft{}")
5017      (closing-double-quote :utf-8 "»" :html "&raquo;" :latex "\\guillemotright{}"
5018                            :texinfo "@guillemetright{}")
5019      (opening-single-quote :utf-8 "“" :html "&ldquo;" :latex "``" :texinfo "``")
5020      (closing-single-quote :utf-8 "”" :html "&rdquo;" :latex "''" :texinfo "''")
5021      (apostrophe :utf-8 "’" :html "&rsquo;"))
5022     ("fr"
5023      (opening-double-quote :utf-8 "« " :html "&laquo;&nbsp;" :latex "\\og "
5024                            :texinfo "@guillemetleft{}@tie{}")
5025      (closing-double-quote :utf-8 " »" :html "&nbsp;&raquo;" :latex "\\fg{}"
5026                            :texinfo "@tie{}@guillemetright{}")
5027      (opening-single-quote :utf-8 "« " :html "&laquo;&nbsp;" :latex "\\og "
5028                            :texinfo "@guillemetleft{}@tie{}")
5029      (closing-single-quote :utf-8 " »" :html "&nbsp;&raquo;" :latex "\\fg{}"
5030                            :texinfo "@tie{}@guillemetright{}")
5031      (apostrophe :utf-8 "’" :html "&rsquo;"))
5032     ("no"
5033      ;; https://nn.wikipedia.org/wiki/Sitatteikn
5034      (opening-double-quote :utf-8 "«" :html "&laquo;" :latex "\\guillemotleft{}"
5035                            :texinfo "@guillemetleft{}")
5036      (closing-double-quote :utf-8 "»" :html "&raquo;" :latex "\\guillemotright{}"
5037                            :texinfo "@guillemetright{}")
5038      (opening-single-quote :utf-8 "‘" :html "&lsquo;" :latex "`" :texinfo "`")
5039      (closing-single-quote :utf-8 "’" :html "&rsquo;" :latex "'" :texinfo "'")
5040      (apostrophe :utf-8 "’" :html "&rsquo;"))
5041     ("nb"
5042      ;; https://nn.wikipedia.org/wiki/Sitatteikn
5043      (opening-double-quote :utf-8 "«" :html "&laquo;" :latex "\\guillemotleft{}"
5044                            :texinfo "@guillemetleft{}")
5045      (closing-double-quote :utf-8 "»" :html "&raquo;" :latex "\\guillemotright{}"
5046                            :texinfo "@guillemetright{}")
5047      (opening-single-quote :utf-8 "‘" :html "&lsquo;" :latex "`" :texinfo "`")
5048      (closing-single-quote :utf-8 "’" :html "&rsquo;" :latex "'" :texinfo "'")
5049      (apostrophe :utf-8 "’" :html "&rsquo;"))
5050     ("nn"
5051      ;; https://nn.wikipedia.org/wiki/Sitatteikn
5052      (opening-double-quote :utf-8 "«" :html "&laquo;" :latex "\\guillemotleft{}"
5053                            :texinfo "@guillemetleft{}")
5054      (closing-double-quote :utf-8 "»" :html "&raquo;" :latex "\\guillemotright{}"
5055                            :texinfo "@guillemetright{}")
5056      (opening-single-quote :utf-8 "‘" :html "&lsquo;" :latex "`" :texinfo "`")
5057      (closing-single-quote :utf-8 "’" :html "&rsquo;" :latex "'" :texinfo "'")
5058      (apostrophe :utf-8 "’" :html "&rsquo;"))
5059     ("ru"
5060      ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
5061      ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5062      (opening-double-quote :utf-8 "«" :html "&laquo;" :latex "{}<<"
5063                            :texinfo "@guillemetleft{}")
5064      (closing-double-quote :utf-8 "»" :html "&raquo;" :latex ">>{}"
5065                            :texinfo "@guillemetright{}")
5066      (opening-single-quote :utf-8 "„" :html "&bdquo;" :latex "\\glqq{}"
5067                            :texinfo "@quotedblbase{}")
5068      (closing-single-quote :utf-8 "“" :html "&ldquo;" :latex "\\grqq{}"
5069                            :texinfo "@quotedblleft{}")
5070      (apostrophe :utf-8 "’" :html: "&#39;"))
5071     ("sv"
5072      ;; based on https://sv.wikipedia.org/wiki/Citattecken
5073      (opening-double-quote :utf-8 "”" :html "&rdquo;" :latex "’’" :texinfo "’’")
5074      (closing-double-quote :utf-8 "”" :html "&rdquo;" :latex "’’" :texinfo "’’")
5075      (opening-single-quote :utf-8 "’" :html "&rsquo;" :latex "’" :texinfo "`")
5076      (closing-single-quote :utf-8 "’" :html "&rsquo;" :latex "’" :texinfo "'")
5077      (apostrophe :utf-8 "’" :html "&rsquo;"))
5078     )
5079   "Smart quotes translations.
5080
5081 Alist whose CAR is a language string and CDR is an alist with
5082 quote type as key and a plist associating various encodings to
5083 their translation as value.
5084
5085 A quote type can be any symbol among `opening-double-quote',
5086 `closing-double-quote', `opening-single-quote',
5087 `closing-single-quote' and `apostrophe'.
5088
5089 Valid encodings include `:utf-8', `:html', `:latex' and
5090 `:texinfo'.
5091
5092 If no translation is found, the quote character is left as-is.")
5093
5094 (defun org-export--smart-quote-status (s info)
5095   "Return smart quote status at the beginning of string S.
5096 INFO is the current export state, as a plist."
5097   (let* ((parent (org-element-property :parent s))
5098          (cache (or (plist-get info :smart-quote-cache)
5099                     (let ((table (make-hash-table :test #'eq)))
5100                       (plist-put info :smart-quote-cache table)
5101                       table)))
5102          (value (gethash parent cache 'missing-data)))
5103     (if (not (eq value 'missing-data)) (cdr (assq s value))
5104       (let (level1-open level2-open full-status)
5105         (org-element-map parent 'plain-text
5106           (lambda (text)
5107             (let ((start 0) current-status)
5108               (while (setq start (string-match "['\"]" text start))
5109                 (incf start)
5110                 (push
5111                  (cond
5112                   ((equal (match-string 0 text) "\"")
5113                    (setf level1-open (not level1-open))
5114                    (setf level2-open nil)
5115                    (if level1-open 'opening-double-quote 'closing-double-quote))
5116                   ;; Not already in a level 1 quote: this is an
5117                   ;; apostrophe.
5118                   ((not level1-open) 'apostrophe)
5119                   ;; Apostrophe.
5120                   ((org-string-match-p "\\S-'\\S-" text) 'apostrophe)
5121                   ;; Apostrophe at the beginning of a string.  Check
5122                   ;; white space at the end of the last object.
5123                   ((and (org-string-match-p "\\`'\\S-" text)
5124                         (let ((p (org-export-get-previous-element text info)))
5125                           (and p
5126                                (if (stringp p)
5127                                    (not (org-string-match-p "[ \t]\\'" p))
5128                                  (memq (org-element-property :post-blank p)
5129                                        '(0 nil))))))
5130                    'apostrophe)
5131                   ;; Apostrophe at the end of a string.  Check white
5132                   ;; space at the beginning of the next object, which
5133                   ;; can only happen if that object is a string.
5134                   ((and (org-string-match-p "\\S-'\\'" text)
5135                         (let ((n (org-export-get-next-element text info)))
5136                           (and n
5137                                (not (and (stringp n)
5138                                          (org-string-match-p "\\`[ \t]" n))))))
5139                    'apostrophe)
5140                   ;; Lonesome apostrophe.  Check white space around
5141                   ;; both ends.
5142                   ((and (equal text "'")
5143                         (let ((p (org-export-get-previous-element text info)))
5144                           (and p
5145                                (if (stringp p)
5146                                    (not (org-string-match-p "[ \t]\\'" p))
5147                                  (memq (org-element-property :post-blank p)
5148                                        '(0 nil)))
5149                                (let ((n (org-export-get-next-element text info)))
5150                                  (and n
5151                                       (not (and (stringp n)
5152                                                 (org-string-match-p "\\`[ \t]"
5153                                                                     n))))))))
5154                    'apostrophe)
5155                   ;; Else, consider it as a level 2 quote.
5156                   (t (setf level2-open (not level2-open))
5157                      (if level2-open 'opening-single-quote
5158                        'closing-single-quote)))
5159                  current-status))
5160               (when current-status
5161                 (push (cons text (nreverse current-status)) full-status))))
5162           info nil org-element-recursive-objects)
5163         (puthash parent full-status cache)
5164         (cdr (assq s full-status))))))
5165
5166 (defun org-export-activate-smart-quotes (s encoding info &optional original)
5167   "Replace regular quotes with \"smart\" quotes in string S.
5168
5169 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5170 `:utf-8'.  INFO is a plist used as a communication channel.
5171
5172 The function has to retrieve information about string
5173 surroundings in parse tree.  It can only happen with an
5174 unmodified string.  Thus, if S has already been through another
5175 process, a non-nil ORIGINAL optional argument will provide that
5176 original string.
5177
5178 Return the new string."
5179   (let ((quote-status
5180          (copy-sequence (org-export--smart-quote-status (or original s) info))))
5181     (replace-regexp-in-string
5182      "['\"]"
5183      (lambda (match)
5184        (or (plist-get
5185             (cdr (assq (pop quote-status)
5186                        (cdr (assoc (plist-get info :language)
5187                                    org-export-smart-quotes-alist))))
5188             encoding)
5189            match))
5190      s nil t)))
5191
5192 ;;;; Topology
5193 ;;
5194 ;; Here are various functions to retrieve information about the
5195 ;; neighborhood of a given element or object.  Neighbors of interest
5196 ;; are direct parent (`org-export-get-parent'), parent headline
5197 ;; (`org-export-get-parent-headline'), first element containing an
5198 ;; object, (`org-export-get-parent-element'), parent table
5199 ;; (`org-export-get-parent-table'), previous element or object
5200 ;; (`org-export-get-previous-element') and next element or object
5201 ;; (`org-export-get-next-element').
5202
5203 ;; defsubst org-export-get-parent must be defined before first use
5204
5205 (define-obsolete-function-alias
5206   'org-export-get-genealogy 'org-element-lineage "25.1")
5207
5208 (defun org-export-get-parent-headline (blob)
5209   "Return BLOB parent headline or nil.
5210 BLOB is the element or object being considered."
5211   (org-element-lineage blob '(headline)))
5212
5213 (defun org-export-get-parent-element (object)
5214   "Return first element containing OBJECT or nil.
5215 OBJECT is the object to consider."
5216   (org-element-lineage object org-element-all-elements))
5217
5218 (defun org-export-get-parent-table (object)
5219   "Return OBJECT parent table or nil.
5220 OBJECT is either a `table-cell' or `table-element' type object."
5221   (org-element-lineage object '(table)))
5222
5223 (defun org-export-get-previous-element (blob info &optional n)
5224   "Return previous element or object.
5225
5226 BLOB is an element or object.  INFO is a plist used as
5227 a communication channel.  Return previous exportable element or
5228 object, a string, or nil.
5229
5230 When optional argument N is a positive integer, return a list
5231 containing up to N siblings before BLOB, from farthest to
5232 closest.  With any other non-nil value, return a list containing
5233 all of them."
5234   (let* ((secondary (org-element-secondary-p blob))
5235          (parent (org-export-get-parent blob))
5236          (siblings
5237           (if secondary (org-element-property secondary parent)
5238             (org-element-contents parent)))
5239          prev)
5240     (catch 'exit
5241       (dolist (obj (cdr (memq blob (reverse siblings))) prev)
5242         (cond ((memq obj (plist-get info :ignore-list)))
5243               ((null n) (throw 'exit obj))
5244               ((not (wholenump n)) (push obj prev))
5245               ((zerop n) (throw 'exit prev))
5246               (t (decf n) (push obj prev)))))))
5247
5248 (defun org-export-get-next-element (blob info &optional n)
5249   "Return next element or object.
5250
5251 BLOB is an element or object.  INFO is a plist used as
5252 a communication channel.  Return next exportable element or
5253 object, a string, or nil.
5254
5255 When optional argument N is a positive integer, return a list
5256 containing up to N siblings after BLOB, from closest to farthest.
5257 With any other non-nil value, return a list containing all of
5258 them."
5259   (let* ((secondary (org-element-secondary-p blob))
5260          (parent (org-export-get-parent blob))
5261          (siblings
5262           (cdr (memq blob
5263                      (if secondary (org-element-property secondary parent)
5264                        (org-element-contents parent)))))
5265          next)
5266     (catch 'exit
5267       (dolist (obj siblings (nreverse next))
5268         (cond ((memq obj (plist-get info :ignore-list)))
5269               ((null n) (throw 'exit obj))
5270               ((not (wholenump n)) (push obj next))
5271               ((zerop n) (throw 'exit (nreverse next)))
5272               (t (decf n) (push obj next)))))))
5273
5274
5275 ;;;; Translation
5276 ;;
5277 ;; `org-export-translate' translates a string according to the language
5278 ;; specified by the LANGUAGE keyword.  `org-export-dictionary' contains
5279 ;; the dictionary used for the translation.
5280
5281 (defconst org-export-dictionary
5282   '(("%e %n: %c"
5283      ("fr" :default "%e %n : %c" :html "%e&nbsp;%n&nbsp;: %c"))
5284     ("Author"
5285      ("ca" :default "Autor")
5286      ("cs" :default "Autor")
5287      ("da" :default "Forfatter")
5288      ("de" :default "Autor")
5289      ("eo" :html "A&#365;toro")
5290      ("es" :default "Autor")
5291      ("et" :default "Autor")
5292      ("fi" :html "Tekij&auml;")
5293      ("fr" :default "Auteur")
5294      ("hu" :default "Szerz&otilde;")
5295      ("is" :html "H&ouml;fundur")
5296      ("it" :default "Autore")
5297      ("ja" :default "著者" :html "&#33879;&#32773;")
5298      ("nl" :default "Auteur")
5299      ("no" :default "Forfatter")
5300      ("nb" :default "Forfatter")
5301      ("nn" :default "Forfattar")
5302      ("pl" :default "Autor")
5303      ("pt_BR" :default "Autor")
5304      ("ru" :html "&#1040;&#1074;&#1090;&#1086;&#1088;" :utf-8 "Автор")
5305      ("sv" :html "F&ouml;rfattare")
5306      ("uk" :html "&#1040;&#1074;&#1090;&#1086;&#1088;" :utf-8 "Автор")
5307      ("zh-CN" :html "&#20316;&#32773;" :utf-8 "作者")
5308      ("zh-TW" :html "&#20316;&#32773;" :utf-8 "作者"))
5309     ("Continued from previous page"
5310      ("de" :default "Fortsetzung von vorheriger Seite")
5311      ("es" :html "Contin&uacute;a de la p&aacute;gina anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5312      ("fr" :default "Suite de la page précédente")
5313      ("it" :default "Continua da pagina precedente")
5314      ("ja" :default "前ページからの続き")
5315      ("nl" :default "Vervolg van vorige pagina")
5316      ("pt" :default "Continuação da página anterior")
5317      ("ru" :html "(&#1055;&#1088;&#1086;&#1076;&#1086;&#1083;&#1078;&#1077;&#1085;&#1080;&#1077;)"
5318       :utf-8 "(Продолжение)"))
5319     ("Continued on next page"
5320      ("de" :default "Fortsetzung nächste Seite")
5321      ("es" :html "Contin&uacute;a en la siguiente p&aacute;gina" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5322      ("fr" :default "Suite page suivante")
5323      ("it" :default "Continua alla pagina successiva")
5324      ("ja" :default "次ページに続く")
5325      ("nl" :default "Vervolg op volgende pagina")
5326      ("pt" :default "Continua na página seguinte")
5327      ("ru" :html "(&#1055;&#1088;&#1086;&#1076;&#1086;&#1083;&#1078;&#1077;&#1085;&#1080;&#1077; &#1089;&#1083;&#1077;&#1076;&#1091;&#1077;&#1090;)"
5328       :utf-8 "(Продолжение следует)"))
5329     ("Date"
5330      ("ca" :default "Data")
5331      ("cs" :default "Datum")
5332      ("da" :default "Dato")
5333      ("de" :default "Datum")
5334      ("eo" :default "Dato")
5335      ("es" :default "Fecha")
5336      ("et" :html "Kuup&#228;ev" :utf-8 "Kuupäev")
5337      ("fi" :html "P&auml;iv&auml;m&auml;&auml;r&auml;")
5338      ("hu" :html "D&aacute;tum")
5339      ("is" :default "Dagsetning")
5340      ("it" :default "Data")
5341      ("ja" :default "日付" :html "&#26085;&#20184;")
5342      ("nl" :default "Datum")
5343      ("no" :default "Dato")
5344      ("nb" :default "Dato")
5345      ("nn" :default "Dato")
5346      ("pl" :default "Data")
5347      ("pt_BR" :default "Data")
5348      ("ru" :html "&#1044;&#1072;&#1090;&#1072;" :utf-8 "Дата")
5349      ("sv" :default "Datum")
5350      ("uk" :html "&#1044;&#1072;&#1090;&#1072;" :utf-8 "Дата")
5351      ("zh-CN" :html "&#26085;&#26399;" :utf-8 "日期")
5352      ("zh-TW" :html "&#26085;&#26399;" :utf-8 "日期"))
5353     ("Equation"
5354      ("da" :default "Ligning")
5355      ("de" :default "Gleichung")
5356      ("es" :ascii "Ecuacion" :html "Ecuaci&oacute;n" :default "Ecuación")
5357      ("et" :html "V&#245;rrand" :utf-8 "Võrrand")
5358      ("fr" :ascii "Equation" :default "Équation")
5359      ("ja" :default "方程式")
5360      ("no" :default "Ligning")
5361      ("nb" :default "Ligning")
5362      ("nn" :default "Likning")
5363      ("pt_BR" :html "Equa&ccedil;&atilde;o" :default "Equação" :ascii "Equacao")
5364      ("ru" :html "&#1059;&#1088;&#1072;&#1074;&#1085;&#1077;&#1085;&#1080;&#1077;"
5365       :utf-8 "Уравнение")
5366      ("sv" :default "Ekvation")
5367      ("zh-CN" :html "&#26041;&#31243;" :utf-8 "方程"))
5368     ("Figure"
5369      ("da" :default "Figur")
5370      ("de" :default "Abbildung")
5371      ("es" :default "Figura")
5372      ("et" :default "Joonis")
5373      ("ja" :default "図" :html "&#22259;")
5374      ("no" :default "Illustrasjon")
5375      ("nb" :default "Illustrasjon")
5376      ("nn" :default "Illustrasjon")
5377      ("pt_BR" :default "Figura")
5378      ("ru" :html "&#1056;&#1080;&#1089;&#1091;&#1085;&#1086;&#1082;" :utf-8 "Рисунок")
5379      ("sv" :default "Illustration")
5380      ("zh-CN" :html "&#22270;" :utf-8 "图"))
5381     ("Figure %d:"
5382      ("da" :default "Figur %d")
5383      ("de" :default "Abbildung %d:")
5384      ("es" :default "Figura %d:")
5385      ("et" :default "Joonis %d:")
5386      ("fr" :default "Figure %d :" :html "Figure&nbsp;%d&nbsp;:")
5387      ("ja" :default "図%d: " :html "&#22259;%d: ")
5388      ("no" :default "Illustrasjon %d")
5389      ("nb" :default "Illustrasjon %d")
5390      ("nn" :default "Illustrasjon %d")
5391      ("pt_BR" :default "Figura %d:")
5392      ("ru" :html "&#1056;&#1080;&#1089;. %d.:" :utf-8 "Рис. %d.:")
5393      ("sv" :default "Illustration %d")
5394      ("zh-CN" :html "&#22270;%d&nbsp;" :utf-8 "图%d "))
5395     ("Footnotes"
5396      ("ca" :html "Peus de p&agrave;gina")
5397      ("cs" :default "Pozn\xe1mky pod carou")
5398      ("da" :default "Fodnoter")
5399      ("de" :html "Fu&szlig;noten" :default "Fußnoten")
5400      ("eo" :default "Piednotoj")
5401      ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de p&aacute;gina" :default "Nota al pie de página")
5402      ("et" :html "Allm&#228;rkused" :utf-8 "Allmärkused")
5403      ("fi" :default "Alaviitteet")
5404      ("fr" :default "Notes de bas de page")
5405      ("hu" :html "L&aacute;bjegyzet")
5406      ("is" :html "Aftanm&aacute;lsgreinar")
5407      ("it" :html "Note a pi&egrave; di pagina")
5408      ("ja" :default "脚注" :html "&#33050;&#27880;")
5409      ("nl" :default "Voetnoten")
5410      ("no" :default "Fotnoter")
5411      ("nb" :default "Fotnoter")
5412      ("nn" :default "Fotnotar")
5413      ("pl" :default "Przypis")
5414      ("pt_BR" :html "Notas de Rodap&eacute;" :default "Notas de Rodapé" :ascii "Notas de Rodape")
5415      ("ru" :html "&#1057;&#1085;&#1086;&#1089;&#1082;&#1080;" :utf-8 "Сноски")
5416      ("sv" :default "Fotnoter")
5417      ("uk" :html "&#1055;&#1088;&#1080;&#1084;&#1110;&#1090;&#1082;&#1080;"
5418       :utf-8 "Примітки")
5419      ("zh-CN" :html "&#33050;&#27880;" :utf-8 "脚注")
5420      ("zh-TW" :html "&#33139;&#35387;" :utf-8 "腳註"))
5421     ("List of Listings"
5422      ("da" :default "Programmer")
5423      ("de" :default "Programmauflistungsverzeichnis")
5424      ("es" :ascii "Indice de Listados de programas" :html "&Iacute;ndice de Listados de programas" :default "Índice de Listados de programas")
5425      ("et" :default "Loendite nimekiri")
5426      ("fr" :default "Liste des programmes")
5427      ("ja" :default "ソースコード目次")
5428      ("no" :default "Dataprogrammer")
5429      ("nb" :default "Dataprogrammer")
5430      ("ru" :html "&#1057;&#1087;&#1080;&#1089;&#1086;&#1082; &#1088;&#1072;&#1089;&#1087;&#1077;&#1095;&#1072;&#1090;&#1086;&#1082;"
5431       :utf-8 "Список распечаток")
5432      ("zh-CN" :html "&#20195;&#30721;&#30446;&#24405;" :utf-8 "代码目录"))
5433     ("List of Tables"
5434      ("da" :default "Tabeller")
5435      ("de" :default "Tabellenverzeichnis")
5436      ("es" :ascii "Indice de tablas" :html "&Iacute;ndice de tablas" :default "Índice de tablas")
5437      ("et" :default "Tabelite nimekiri")
5438      ("fr" :default "Liste des tableaux")
5439      ("ja" :default "表目次")
5440      ("no" :default "Tabeller")
5441      ("nb" :default "Tabeller")
5442      ("nn" :default "Tabeller")
5443      ("pt_BR" :default "Índice de Tabelas" :ascii "Indice de Tabelas")
5444      ("ru" :html "&#1057;&#1087;&#1080;&#1089;&#1086;&#1082; &#1090;&#1072;&#1073;&#1083;&#1080;&#1094;"
5445       :utf-8 "Список таблиц")
5446      ("sv" :default "Tabeller")
5447      ("zh-CN" :html "&#34920;&#26684;&#30446;&#24405;" :utf-8 "表格目录"))
5448     ("Listing %d:"
5449      ("da" :default "Program %d")
5450      ("de" :default "Programmlisting %d")
5451      ("es" :default "Listado de programa %d")
5452      ("et" :default "Loend %d")
5453      ("fr" :default "Programme %d :" :html "Programme&nbsp;%d&nbsp;:")
5454      ("ja" :default "ソースコード%d:")
5455      ("no" :default "Dataprogram %d")
5456      ("nb" :default "Dataprogram %d")
5457      ("pt_BR" :default "Listagem %d")
5458      ("ru" :html "&#1056;&#1072;&#1089;&#1087;&#1077;&#1095;&#1072;&#1090;&#1082;&#1072; %d.:"
5459       :utf-8 "Распечатка %d.:")
5460      ("zh-CN" :html "&#20195;&#30721;%d&nbsp;" :utf-8 "代码%d "))
5461     ("References"
5462      ("fr" :ascii "References" :default "Références")
5463      ("de" :default "Quellen")
5464      ("es" :default "Referencias"))
5465     ("See section %s"
5466      ("da" :default "jævnfør afsnit %s")
5467      ("de" :default "siehe Abschnitt %s")
5468      ("es" :ascii "Vea seccion %s" :html "Vea secci&oacute;n %s" :default "Vea sección %s")
5469      ("et" :html "Vaata peat&#252;kki %s" :utf-8 "Vaata peatükki %s")
5470      ("fr" :default "cf. section %s")
5471      ("ja" :default "セクション %s を参照")
5472      ("pt_BR" :html "Veja a se&ccedil;&atilde;o %s" :default "Veja a seção %s"
5473       :ascii "Veja a secao %s")
5474      ("ru" :html "&#1057;&#1084;. &#1088;&#1072;&#1079;&#1076;&#1077;&#1083; %s"
5475       :utf-8 "См. раздел %s")
5476      ("zh-CN" :html "&#21442;&#35265;&#31532;%s&#33410;" :utf-8 "参见第%s节"))
5477     ("Table"
5478      ("de" :default "Tabelle")
5479      ("es" :default "Tabla")
5480      ("et" :default "Tabel")
5481      ("fr" :default "Tableau")
5482      ("ja" :default "表" :html "&#34920;")
5483      ("pt_BR" :default "Tabela")
5484      ("ru" :html "&#1058;&#1072;&#1073;&#1083;&#1080;&#1094;&#1072;"
5485       :utf-8 "Таблица")
5486      ("zh-CN" :html "&#34920;" :utf-8 "表"))
5487     ("Table %d:"
5488      ("da" :default "Tabel %d")
5489      ("de" :default "Tabelle %d")
5490      ("es" :default "Tabla %d")
5491      ("et" :default "Tabel %d")
5492      ("fr" :default "Tableau %d :")
5493      ("ja" :default "表%d:" :html "&#34920;%d:")
5494      ("no" :default "Tabell %d")
5495      ("nb" :default "Tabell %d")
5496      ("nn" :default "Tabell %d")
5497      ("pt_BR" :default "Tabela %d")
5498      ("ru" :html "&#1058;&#1072;&#1073;&#1083;&#1080;&#1094;&#1072; %d.:"
5499       :utf-8 "Таблица %d.:")
5500      ("sv" :default "Tabell %d")
5501      ("zh-CN" :html "&#34920;%d&nbsp;" :utf-8 "表%d "))
5502     ("Table of Contents"
5503      ("ca" :html "&Iacute;ndex")
5504      ("cs" :default "Obsah")
5505      ("da" :default "Indhold")
5506      ("de" :default "Inhaltsverzeichnis")
5507      ("eo" :default "Enhavo")
5508      ("es" :ascii "Indice" :html "&Iacute;ndice" :default "Índice")
5509      ("et" :default "Sisukord")
5510      ("fi" :html "Sis&auml;llysluettelo")
5511      ("fr" :ascii "Sommaire" :default "Table des matières")
5512      ("hu" :html "Tartalomjegyz&eacute;k")
5513      ("is" :default "Efnisyfirlit")
5514      ("it" :default "Indice")
5515      ("ja" :default "目次" :html "&#30446;&#27425;")
5516      ("nl" :default "Inhoudsopgave")
5517      ("no" :default "Innhold")
5518      ("nb" :default "Innhold")
5519      ("nn" :default "Innhald")
5520      ("pl" :html "Spis tre&#x015b;ci")
5521      ("pt_BR" :html "&Iacute;ndice" :utf8 "Índice" :ascii "Indice")
5522      ("ru" :html "&#1057;&#1086;&#1076;&#1077;&#1088;&#1078;&#1072;&#1085;&#1080;&#1077;"
5523       :utf-8 "Содержание")
5524      ("sv" :html "Inneh&aring;ll")
5525      ("uk" :html "&#1047;&#1084;&#1110;&#1089;&#1090;" :utf-8 "Зміст")
5526      ("zh-CN" :html "&#30446;&#24405;" :utf-8 "目录")
5527      ("zh-TW" :html "&#30446;&#37636;" :utf-8 "目錄"))
5528     ("Unknown reference"
5529      ("da" :default "ukendt reference")
5530      ("de" :default "Unbekannter Verweis")
5531      ("es" :default "Referencia desconocida")
5532      ("et" :default "Tundmatu viide")
5533      ("fr" :ascii "Destination inconnue" :default "Référence inconnue")
5534      ("ja" :default "不明な参照先")
5535      ("pt_BR" :default "Referência desconhecida"
5536       :ascii "Referencia desconhecida")
5537      ("ru" :html "&#1053;&#1077;&#1080;&#1079;&#1074;&#1077;&#1089;&#1090;&#1085;&#1072;&#1103; &#1089;&#1089;&#1099;&#1083;&#1082;&#1072;"
5538       :utf-8 "Неизвестная ссылка")
5539      ("zh-CN" :html "&#26410;&#30693;&#24341;&#29992;" :utf-8 "未知引用")))
5540   "Dictionary for export engine.
5541
5542 Alist whose car is the string to translate and cdr is an alist
5543 whose car is the language string and cdr is a plist whose
5544 properties are possible charsets and values translated terms.
5545
5546 It is used as a database for `org-export-translate'.  Since this
5547 function returns the string as-is if no translation was found,
5548 the variable only needs to record values different from the
5549 entry.")
5550
5551 (defun org-export-translate (s encoding info)
5552   "Translate string S according to language specification.
5553
5554 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5555 and `:utf-8'.  INFO is a plist used as a communication channel.
5556
5557 Translation depends on `:language' property.  Return the
5558 translated string.  If no translation is found, try to fall back
5559 to `:default' encoding.  If it fails, return S."
5560   (let* ((lang (plist-get info :language))
5561          (translations (cdr (assoc lang
5562                                    (cdr (assoc s org-export-dictionary))))))
5563     (or (plist-get translations encoding)
5564         (plist-get translations :default)
5565         s)))
5566
5567
5568 \f
5569 ;;; Asynchronous Export
5570 ;;
5571 ;; `org-export-async-start' is the entry point for asynchronous
5572 ;; export.  It recreates current buffer (including visibility,
5573 ;; narrowing and visited file) in an external Emacs process, and
5574 ;; evaluates a command there.  It then applies a function on the
5575 ;; returned results in the current process.
5576 ;;
5577 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5578 ;; allow to export to a buffer or a file, asynchronously or not.
5579 ;;
5580 ;; `org-export-output-file-name' is an auxiliary function meant to be
5581 ;; used with `org-export-to-file'.  With a given extension, it tries
5582 ;; to provide a canonical file name to write export output to.
5583 ;;
5584 ;; Asynchronously generated results are never displayed directly.
5585 ;; Instead, they are stored in `org-export-stack-contents'.  They can
5586 ;; then be retrieved by calling `org-export-stack'.
5587 ;;
5588 ;; Export Stack is viewed through a dedicated major mode
5589 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5590 ;;`org-export-stack-delete', `org-export-stack-view' and
5591 ;;`org-export-stack-clear'.
5592 ;;
5593 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5594 ;; It should be used whenever `org-export-async-start' is called.
5595
5596 (defmacro org-export-async-start  (fun &rest body)
5597   "Call function FUN on the results returned by BODY evaluation.
5598
5599 FUN is an anonymous function of one argument.  BODY evaluation
5600 happens in an asynchronous process, from a buffer which is an
5601 exact copy of the current one.
5602
5603 Use `org-export-add-to-stack' in FUN in order to register results
5604 in the stack.
5605
5606 This is a low level function.  See also `org-export-to-buffer'
5607 and `org-export-to-file' for more specialized functions."
5608   (declare (indent 1) (debug t))
5609   (org-with-gensyms (process temp-file copy-fun proc-buffer coding)
5610     ;; Write the full sexp evaluating BODY in a copy of the current
5611     ;; buffer to a temporary file, as it may be too long for program
5612     ;; args in `start-process'.
5613     `(with-temp-message "Initializing asynchronous export process"
5614        (let ((,copy-fun (org-export--generate-copy-script (current-buffer)))
5615              (,temp-file (make-temp-file "org-export-process"))
5616              (,coding buffer-file-coding-system))
5617          (with-temp-file ,temp-file
5618            (insert
5619             ;; Null characters (from variable values) are inserted
5620             ;; within the file.  As a consequence, coding system for
5621             ;; buffer contents will not be recognized properly.  So,
5622             ;; we make sure it is the same as the one used to display
5623             ;; the original buffer.
5624             (format ";; -*- coding: %s; -*-\n%S"
5625                     ,coding
5626                     `(with-temp-buffer
5627                        (when org-export-async-debug '(setq debug-on-error t))
5628                        ;; Ignore `kill-emacs-hook' and code evaluation
5629                        ;; queries from Babel as we need a truly
5630                        ;; non-interactive process.
5631                        (setq kill-emacs-hook nil
5632                              org-babel-confirm-evaluate-answer-no t)
5633                        ;; Initialize export framework.
5634                        (require 'ox)
5635                        ;; Re-create current buffer there.
5636                        (funcall ,,copy-fun)
5637                        (restore-buffer-modified-p nil)
5638                        ;; Sexp to evaluate in the buffer.
5639                        (print (progn ,,@body))))))
5640          ;; Start external process.
5641          (let* ((process-connection-type nil)
5642                 (,proc-buffer (generate-new-buffer-name "*Org Export Process*"))
5643                 (,process
5644                  (apply
5645                   #'start-process
5646                   (append
5647                    (list "org-export-process"
5648                          ,proc-buffer
5649                          (expand-file-name invocation-name invocation-directory)
5650                          "--batch")
5651                    (if org-export-async-init-file
5652                        (list "-Q" "-l" org-export-async-init-file)
5653                      (list "-l" user-init-file))
5654                    (list "-l" ,temp-file)))))
5655            ;; Register running process in stack.
5656            (org-export-add-to-stack (get-buffer ,proc-buffer) nil ,process)
5657            ;; Set-up sentinel in order to catch results.
5658            (let ((handler ,fun))
5659              (set-process-sentinel
5660               ,process
5661               `(lambda (p status)
5662                  (let ((proc-buffer (process-buffer p)))
5663                    (when (eq (process-status p) 'exit)
5664                      (unwind-protect
5665                          (if (zerop (process-exit-status p))
5666                              (unwind-protect
5667                                  (let ((results
5668                                         (with-current-buffer proc-buffer
5669                                           (goto-char (point-max))
5670                                           (backward-sexp)
5671                                           (read (current-buffer)))))
5672                                    (funcall ,handler results))
5673                                (unless org-export-async-debug
5674                                  (and (get-buffer proc-buffer)
5675                                       (kill-buffer proc-buffer))))
5676                            (org-export-add-to-stack proc-buffer nil p)
5677                            (ding)
5678                            (message "Process '%s' exited abnormally" p))
5679                        (unless org-export-async-debug
5680                          (delete-file ,,temp-file)))))))))))))
5681
5682 ;;;###autoload
5683 (defun org-export-to-buffer
5684   (backend buffer
5685            &optional async subtreep visible-only body-only ext-plist
5686            post-process)
5687   "Call `org-export-as' with output to a specified buffer.
5688
5689 BACKEND is either an export back-end, as returned by, e.g.,
5690 `org-export-create-backend', or a symbol referring to
5691 a registered back-end.
5692
5693 BUFFER is the name of the output buffer.  If it already exists,
5694 it will be erased first, otherwise, it will be created.
5695
5696 A non-nil optional argument ASYNC means the process should happen
5697 asynchronously.  The resulting buffer should then be accessible
5698 through the `org-export-stack' interface.  When ASYNC is nil, the
5699 buffer is displayed if `org-export-show-temporary-export-buffer'
5700 is non-nil.
5701
5702 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5703 EXT-PLIST are similar to those used in `org-export-as', which
5704 see.
5705
5706 Optional argument POST-PROCESS is a function which should accept
5707 no argument.  It is always called within the current process,
5708 from BUFFER, with point at its beginning.  Export back-ends can
5709 use it to set a major mode there, e.g,
5710
5711   \(defun org-latex-export-as-latex
5712     \(&optional async subtreep visible-only body-only ext-plist)
5713     \(interactive)
5714     \(org-export-to-buffer 'latex \"*Org LATEX Export*\"
5715       async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5716
5717 This function returns BUFFER."
5718   (declare (indent 2))
5719   (if async
5720       (org-export-async-start
5721           `(lambda (output)
5722              (with-current-buffer (get-buffer-create ,buffer)
5723                (erase-buffer)
5724                (setq buffer-file-coding-system ',buffer-file-coding-system)
5725                (insert output)
5726                (goto-char (point-min))
5727                (org-export-add-to-stack (current-buffer) ',backend)
5728                (ignore-errors (funcall ,post-process))))
5729         `(org-export-as
5730           ',backend ,subtreep ,visible-only ,body-only ',ext-plist))
5731     (let ((output
5732            (org-export-as backend subtreep visible-only body-only ext-plist))
5733           (buffer (get-buffer-create buffer))
5734           (encoding buffer-file-coding-system))
5735       (when (and (org-string-nw-p output) (org-export--copy-to-kill-ring-p))
5736         (org-kill-new output))
5737       (with-current-buffer buffer
5738         (erase-buffer)
5739         (setq buffer-file-coding-system encoding)
5740         (insert output)
5741         (goto-char (point-min))
5742         (and (functionp post-process) (funcall post-process)))
5743       (when org-export-show-temporary-export-buffer
5744         (switch-to-buffer-other-window buffer))
5745       buffer)))
5746
5747 ;;;###autoload
5748 (defun org-export-to-file
5749   (backend file &optional async subtreep visible-only body-only ext-plist
5750            post-process)
5751   "Call `org-export-as' with output to a specified file.
5752
5753 BACKEND is either an export back-end, as returned by, e.g.,
5754 `org-export-create-backend', or a symbol referring to
5755 a registered back-end.  FILE is the name of the output file, as
5756 a string.
5757
5758 A non-nil optional argument ASYNC means the process should happen
5759 asynchronously.  The resulting buffer will then be accessible
5760 through the `org-export-stack' interface.
5761
5762 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5763 EXT-PLIST are similar to those used in `org-export-as', which
5764 see.
5765
5766 Optional argument POST-PROCESS is called with FILE as its
5767 argument and happens asynchronously when ASYNC is non-nil.  It
5768 has to return a file name, or nil.  Export back-ends can use this
5769 to send the output file through additional processing, e.g,
5770
5771   \(defun org-latex-export-to-latex
5772     \(&optional async subtreep visible-only body-only ext-plist)
5773     \(interactive)
5774     \(let ((outfile (org-export-output-file-name \".tex\" subtreep)))
5775       \(org-export-to-file 'latex outfile
5776         async subtreep visible-only body-only ext-plist
5777         \(lambda (file) (org-latex-compile file)))
5778
5779 The function returns either a file name returned by POST-PROCESS,
5780 or FILE."
5781   (declare (indent 2))
5782   (if (not (file-writable-p file)) (error "Output file not writable")
5783     (let ((ext-plist (org-combine-plists `(:output-file ,file) ext-plist))
5784           (encoding (or org-export-coding-system buffer-file-coding-system)))
5785       (if async
5786           (org-export-async-start
5787               `(lambda (file)
5788                  (org-export-add-to-stack (expand-file-name file) ',backend))
5789             `(let ((output
5790                     (org-export-as
5791                      ',backend ,subtreep ,visible-only ,body-only
5792                      ',ext-plist)))
5793                (with-temp-buffer
5794                  (insert output)
5795                  (let ((coding-system-for-write ',encoding))
5796                    (write-file ,file)))
5797                (or (ignore-errors (funcall ',post-process ,file)) ,file)))
5798         (let ((output (org-export-as
5799                        backend subtreep visible-only body-only ext-plist)))
5800           (with-temp-buffer
5801             (insert output)
5802             (let ((coding-system-for-write encoding))
5803               (write-file file)))
5804           (when (and (org-export--copy-to-kill-ring-p) (org-string-nw-p output))
5805             (org-kill-new output))
5806           ;; Get proper return value.
5807           (or (and (functionp post-process) (funcall post-process file))
5808               file))))))
5809
5810 (defun org-export-output-file-name (extension &optional subtreep pub-dir)
5811   "Return output file's name according to buffer specifications.
5812
5813 EXTENSION is a string representing the output file extension,
5814 with the leading dot.
5815
5816 With a non-nil optional argument SUBTREEP, try to determine
5817 output file's name by looking for \"EXPORT_FILE_NAME\" property
5818 of subtree at point.
5819
5820 When optional argument PUB-DIR is set, use it as the publishing
5821 directory.
5822
5823 When optional argument VISIBLE-ONLY is non-nil, don't export
5824 contents of hidden elements.
5825
5826 Return file name as a string."
5827   (let* ((visited-file (buffer-file-name (buffer-base-buffer)))
5828          (base-name
5829           ;; File name may come from EXPORT_FILE_NAME subtree
5830           ;; property, assuming point is at beginning of said
5831           ;; sub-tree.
5832           (file-name-sans-extension
5833            (or (and subtreep
5834                     (org-entry-get
5835                      (save-excursion
5836                        (ignore-errors (org-back-to-heading) (point)))
5837                      "EXPORT_FILE_NAME" t))
5838                ;; File name may be extracted from buffer's associated
5839                ;; file, if any.
5840                (and visited-file (file-name-nondirectory visited-file))
5841                ;; Can't determine file name on our own: Ask user.
5842                (let ((read-file-name-function
5843                       (and org-completion-use-ido 'ido-read-file-name)))
5844                  (read-file-name
5845                   "Output file: " pub-dir nil nil nil
5846                   (lambda (name)
5847                     (string= (file-name-extension name t) extension)))))))
5848          (output-file
5849           ;; Build file name.  Enforce EXTENSION over whatever user
5850           ;; may have come up with.  PUB-DIR, if defined, always has
5851           ;; precedence over any provided path.
5852           (cond
5853            (pub-dir
5854             (concat (file-name-as-directory pub-dir)
5855                     (file-name-nondirectory base-name)
5856                     extension))
5857            ((file-name-absolute-p base-name) (concat base-name extension))
5858            (t (concat (file-name-as-directory ".") base-name extension)))))
5859     ;; If writing to OUTPUT-FILE would overwrite original file, append
5860     ;; EXTENSION another time to final name.
5861     (if (and visited-file (org-file-equal-p visited-file output-file))
5862         (concat output-file extension)
5863       output-file)))
5864
5865 (defun org-export-add-to-stack (source backend &optional process)
5866   "Add a new result to export stack if not present already.
5867
5868 SOURCE is a buffer or a file name containing export results.
5869 BACKEND is a symbol representing export back-end used to generate
5870 it.
5871
5872 Entries already pointing to SOURCE and unavailable entries are
5873 removed beforehand.  Return the new stack."
5874   (setq org-export-stack-contents
5875         (cons (list source backend (or process (current-time)))
5876               (org-export-stack-remove source))))
5877
5878 (defun org-export-stack ()
5879   "Menu for asynchronous export results and running processes."
5880   (interactive)
5881   (let ((buffer (get-buffer-create "*Org Export Stack*")))
5882     (set-buffer buffer)
5883     (when (zerop (buffer-size)) (org-export-stack-mode))
5884     (org-export-stack-refresh)
5885     (pop-to-buffer buffer))
5886   (message "Type \"q\" to quit, \"?\" for help"))
5887
5888 (defun org-export--stack-source-at-point ()
5889   "Return source from export results at point in stack."
5890   (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
5891     (if (not source) (error "Source unavailable, please refresh buffer")
5892       (let ((source-name (if (stringp source) source (buffer-name source))))
5893         (if (save-excursion
5894               (beginning-of-line)
5895               (looking-at (concat ".* +" (regexp-quote source-name) "$")))
5896             source
5897           ;; SOURCE is not consistent with current line.  The stack
5898           ;; view is outdated.
5899           (error "Source unavailable; type `g' to update buffer"))))))
5900
5901 (defun org-export-stack-clear ()
5902   "Remove all entries from export stack."
5903   (interactive)
5904   (setq org-export-stack-contents nil))
5905
5906 (defun org-export-stack-refresh (&rest dummy)
5907   "Refresh the asynchronous export stack.
5908 DUMMY is ignored.  Unavailable sources are removed from the list.
5909 Return the new stack."
5910   (let ((inhibit-read-only t))
5911     (org-preserve-lc
5912      (erase-buffer)
5913      (insert (concat
5914               (let ((counter 0))
5915                 (mapconcat
5916                  (lambda (entry)
5917                    (let ((proc-p (processp (nth 2 entry))))
5918                      (concat
5919                       ;; Back-end.
5920                       (format " %-12s  " (or (nth 1 entry) ""))
5921                       ;; Age.
5922                       (let ((data (nth 2 entry)))
5923                         (if proc-p (format " %6s  " (process-status data))
5924                           ;; Compute age of the results.
5925                           (org-format-seconds
5926                            "%4h:%.2m  "
5927                            (float-time (time-since data)))))
5928                       ;; Source.
5929                       (format " %s"
5930                               (let ((source (car entry)))
5931                                 (if (stringp source) source
5932                                   (buffer-name source)))))))
5933                  ;; Clear stack from exited processes, dead buffers or
5934                  ;; non-existent files.
5935                  (setq org-export-stack-contents
5936                        (org-remove-if-not
5937                         (lambda (el)
5938                           (if (processp (nth 2 el))
5939                               (buffer-live-p (process-buffer (nth 2 el)))
5940                             (let ((source (car el)))
5941                               (if (bufferp source) (buffer-live-p source)
5942                                 (file-exists-p source)))))
5943                         org-export-stack-contents)) "\n")))))))
5944
5945 (defun org-export-stack-remove (&optional source)
5946   "Remove export results at point from stack.
5947 If optional argument SOURCE is non-nil, remove it instead."
5948   (interactive)
5949   (let ((source (or source (org-export--stack-source-at-point))))
5950     (setq org-export-stack-contents
5951           (org-remove-if (lambda (el) (equal (car el) source))
5952                          org-export-stack-contents))))
5953
5954 (defun org-export-stack-view (&optional in-emacs)
5955   "View export results at point in stack.
5956 With an optional prefix argument IN-EMACS, force viewing files
5957 within Emacs."
5958   (interactive "P")
5959   (let ((source (org-export--stack-source-at-point)))
5960     (cond ((processp source)
5961            (org-switch-to-buffer-other-window (process-buffer source)))
5962           ((bufferp source) (org-switch-to-buffer-other-window source))
5963           (t (org-open-file source in-emacs)))))
5964
5965 (defvar org-export-stack-mode-map
5966   (let ((km (make-sparse-keymap)))
5967     (define-key km " " 'next-line)
5968     (define-key km "n" 'next-line)
5969     (define-key km "\C-n" 'next-line)
5970     (define-key km [down] 'next-line)
5971     (define-key km "p" 'previous-line)
5972     (define-key km "\C-p" 'previous-line)
5973     (define-key km "\C-?" 'previous-line)
5974     (define-key km [up] 'previous-line)
5975     (define-key km "C" 'org-export-stack-clear)
5976     (define-key km "v" 'org-export-stack-view)
5977     (define-key km (kbd "RET") 'org-export-stack-view)
5978     (define-key km "d" 'org-export-stack-remove)
5979     km)
5980   "Keymap for Org Export Stack.")
5981
5982 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5983   "Mode for displaying asynchronous export stack.
5984
5985 Type \\[org-export-stack] to visualize the asynchronous export
5986 stack.
5987
5988 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5989 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5990 stack completely.
5991
5992 Removing entries in an Org Export Stack buffer doesn't affect
5993 files or buffers, only the display.
5994
5995 \\{org-export-stack-mode-map}"
5996   (abbrev-mode 0)
5997   (auto-fill-mode 0)
5998   (setq buffer-read-only t
5999         buffer-undo-list t
6000         truncate-lines t
6001         header-line-format
6002         '(:eval
6003           (format "  %-12s | %6s | %s" "Back-End" "Age" "Source")))
6004   (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6005   (set (make-local-variable 'revert-buffer-function)
6006        'org-export-stack-refresh))
6007
6008
6009 \f
6010 ;;; The Dispatcher
6011 ;;
6012 ;; `org-export-dispatch' is the standard interactive way to start an
6013 ;; export process.  It uses `org-export--dispatch-ui' as a subroutine
6014 ;; for its interface, which, in turn, delegates response to key
6015 ;; pressed to `org-export--dispatch-action'.
6016
6017 ;;;###autoload
6018 (defun org-export-dispatch (&optional arg)
6019   "Export dispatcher for Org mode.
6020
6021 It provides an access to common export related tasks in a buffer.
6022 Its interface comes in two flavors: standard and expert.
6023
6024 While both share the same set of bindings, only the former
6025 displays the valid keys associations in a dedicated buffer.
6026 Scrolling (resp. line-wise motion) in this buffer is done with
6027 SPC and DEL (resp. C-n and C-p) keys.
6028
6029 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6030 flavor or the other.
6031
6032 When ARG is \\[universal-argument], repeat the last export action, with the same set
6033 of options used back then, on the current buffer.
6034
6035 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6036   (interactive "P")
6037   (let* ((input
6038           (cond ((equal arg '(16)) '(stack))
6039                 ((and arg org-export-dispatch-last-action))
6040                 (t (save-window-excursion
6041                      (unwind-protect
6042                          (progn
6043                            ;; Remember where we are
6044                            (move-marker org-export-dispatch-last-position
6045                                         (point)
6046                                         (org-base-buffer (current-buffer)))
6047                            ;; Get and store an export command
6048                            (setq org-export-dispatch-last-action
6049                                  (org-export--dispatch-ui
6050                                   (list org-export-initial-scope
6051                                         (and org-export-in-background 'async))
6052                                   nil
6053                                   org-export-dispatch-use-expert-ui)))
6054                        (and (get-buffer "*Org Export Dispatcher*")
6055                             (kill-buffer "*Org Export Dispatcher*")))))))
6056          (action (car input))
6057          (optns (cdr input)))
6058     (unless (memq 'subtree optns)
6059       (move-marker org-export-dispatch-last-position nil))
6060     (case action
6061       ;; First handle special hard-coded actions.
6062       (template (org-export-insert-default-template nil optns))
6063       (stack (org-export-stack))
6064       (publish-current-file
6065        (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6066       (publish-current-project
6067        (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6068       (publish-choose-project
6069        (org-publish (assoc (org-icompleting-read
6070                             "Publish project: "
6071                             org-publish-project-alist nil t)
6072                            org-publish-project-alist)
6073                     (memq 'force optns)
6074                     (memq 'async optns)))
6075       (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6076       (otherwise
6077        (save-excursion
6078          (when arg
6079            ;; Repeating command, maybe move cursor to restore subtree
6080            ;; context.
6081            (if (eq (marker-buffer org-export-dispatch-last-position)
6082                    (org-base-buffer (current-buffer)))
6083                (goto-char org-export-dispatch-last-position)
6084              ;; We are in a different buffer, forget position.
6085              (move-marker org-export-dispatch-last-position nil)))
6086          (funcall action
6087                   ;; Return a symbol instead of a list to ease
6088                   ;; asynchronous export macro use.
6089                   (and (memq 'async optns) t)
6090                   (and (memq 'subtree optns) t)
6091                   (and (memq 'visible optns) t)
6092                   (and (memq 'body optns) t)))))))
6093
6094 (defun org-export--dispatch-ui (options first-key expertp)
6095   "Handle interface for `org-export-dispatch'.
6096
6097 OPTIONS is a list containing current interactive options set for
6098 export.  It can contain any of the following symbols:
6099 `body'    toggles a body-only export
6100 `subtree' restricts export to current subtree
6101 `visible' restricts export to visible part of buffer.
6102 `force'   force publishing files.
6103 `async'   use asynchronous export process
6104
6105 FIRST-KEY is the key pressed to select the first level menu.  It
6106 is nil when this menu hasn't been selected yet.
6107
6108 EXPERTP, when non-nil, triggers expert UI.  In that case, no help
6109 buffer is provided, but indications about currently active
6110 options are given in the prompt.  Moreover, \[?] allows to switch
6111 back to standard interface."
6112   (let* ((fontify-key
6113           (lambda (key &optional access-key)
6114             ;; Fontify KEY string.  Optional argument ACCESS-KEY, when
6115             ;; non-nil is the required first-level key to activate
6116             ;; KEY.  When its value is t, activate KEY independently
6117             ;; on the first key, if any.  A nil value means KEY will
6118             ;; only be activated at first level.
6119             (if (or (eq access-key t) (eq access-key first-key))
6120                 (org-propertize key 'face 'org-warning)
6121               key)))
6122          (fontify-value
6123           (lambda (value)
6124             ;; Fontify VALUE string.
6125             (org-propertize value 'face 'font-lock-variable-name-face)))
6126          ;; Prepare menu entries by extracting them from registered
6127          ;; back-ends and sorting them by access key and by ordinal,
6128          ;; if any.
6129          (entries
6130           (sort (sort (delq nil
6131                             (mapcar #'org-export-backend-menu
6132                                     org-export-registered-backends))
6133                       (lambda (a b)
6134                         (let ((key-a (nth 1 a))
6135                               (key-b (nth 1 b)))
6136                           (cond ((and (numberp key-a) (numberp key-b))
6137                                  (< key-a key-b))
6138                                 ((numberp key-b) t)))))
6139                 'car-less-than-car))
6140          ;; Compute a list of allowed keys based on the first key
6141          ;; pressed, if any.  Some keys
6142          ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6143          ;; available.
6144          (allowed-keys
6145           (nconc (list 2 22 19 6 1)
6146                  (if (not first-key) (org-uniquify (mapcar 'car entries))
6147                    (let (sub-menu)
6148                      (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6149                        (when (eq (car entry) first-key)
6150                          (setq sub-menu (append (nth 2 entry) sub-menu))))))
6151                  (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6152                        ((not first-key) (list ?P)))
6153                  (list ?& ?#)
6154                  (when expertp (list ??))
6155                  (list ?q)))
6156          ;; Build the help menu for standard UI.
6157          (help
6158           (unless expertp
6159             (concat
6160              ;; Options are hard-coded.
6161              (format "[%s] Body only:    %s           [%s] Visible only:     %s
6162 \[%s] Export scope: %s       [%s] Force publishing: %s
6163 \[%s] Async export: %s\n\n"
6164                      (funcall fontify-key "C-b" t)
6165                      (funcall fontify-value
6166                               (if (memq 'body options) "On " "Off"))
6167                      (funcall fontify-key "C-v" t)
6168                      (funcall fontify-value
6169                               (if (memq 'visible options) "On " "Off"))
6170                      (funcall fontify-key "C-s" t)
6171                      (funcall fontify-value
6172                               (if (memq 'subtree options) "Subtree" "Buffer "))
6173                      (funcall fontify-key "C-f" t)
6174                      (funcall fontify-value
6175                               (if (memq 'force options) "On " "Off"))
6176                      (funcall fontify-key "C-a" t)
6177                      (funcall fontify-value
6178                               (if (memq 'async options) "On " "Off")))
6179              ;; Display registered back-end entries.  When a key
6180              ;; appears for the second time, do not create another
6181              ;; entry, but append its sub-menu to existing menu.
6182              (let (last-key)
6183                (mapconcat
6184                 (lambda (entry)
6185                   (let ((top-key (car entry)))
6186                     (concat
6187                      (unless (eq top-key last-key)
6188                        (setq last-key top-key)
6189                        (format "\n[%s] %s\n"
6190                                (funcall fontify-key (char-to-string top-key))
6191                                (nth 1 entry)))
6192                      (let ((sub-menu (nth 2 entry)))
6193                        (unless (functionp sub-menu)
6194                          ;; Split sub-menu into two columns.
6195                          (let ((index -1))
6196                            (concat
6197                             (mapconcat
6198                              (lambda (sub-entry)
6199                                (incf index)
6200                                (format
6201                                 (if (zerop (mod index 2)) "    [%s] %-26s"
6202                                   "[%s] %s\n")
6203                                 (funcall fontify-key
6204                                          (char-to-string (car sub-entry))
6205                                          top-key)
6206                                 (nth 1 sub-entry)))
6207                              sub-menu "")
6208                             (when (zerop (mod index 2)) "\n"))))))))
6209                 entries ""))
6210              ;; Publishing menu is hard-coded.
6211              (format "\n[%s] Publish
6212     [%s] Current file              [%s] Current project
6213     [%s] Choose project            [%s] All projects\n\n\n"
6214                      (funcall fontify-key "P")
6215                      (funcall fontify-key "f" ?P)
6216                      (funcall fontify-key "p" ?P)
6217                      (funcall fontify-key "x" ?P)
6218                      (funcall fontify-key "a" ?P))
6219              (format "[%s] Export stack                  [%s] Insert template\n"
6220                      (funcall fontify-key "&" t)
6221                      (funcall fontify-key "#" t))
6222              (format "[%s] %s"
6223                      (funcall fontify-key "q" t)
6224                      (if first-key "Main menu" "Exit")))))
6225          ;; Build prompts for both standard and expert UI.
6226          (standard-prompt (unless expertp "Export command: "))
6227          (expert-prompt
6228           (when expertp
6229             (format
6230              "Export command (C-%s%s%s%s%s) [%s]: "
6231              (if (memq 'body options) (funcall fontify-key "b" t) "b")
6232              (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6233              (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6234              (if (memq 'force options) (funcall fontify-key "f" t) "f")
6235              (if (memq 'async options) (funcall fontify-key "a" t) "a")
6236              (mapconcat (lambda (k)
6237                           ;; Strip control characters.
6238                           (unless (< k 27) (char-to-string k)))
6239                         allowed-keys "")))))
6240     ;; With expert UI, just read key with a fancy prompt.  In standard
6241     ;; UI, display an intrusive help buffer.
6242     (if expertp
6243         (org-export--dispatch-action
6244          expert-prompt allowed-keys entries options first-key expertp)
6245       ;; At first call, create frame layout in order to display menu.
6246       (unless (get-buffer "*Org Export Dispatcher*")
6247         (delete-other-windows)
6248         (org-switch-to-buffer-other-window
6249          (get-buffer-create "*Org Export Dispatcher*"))
6250         (setq cursor-type nil
6251               header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6252         ;; Make sure that invisible cursor will not highlight square
6253         ;; brackets.
6254         (set-syntax-table (copy-syntax-table))
6255         (modify-syntax-entry ?\[ "w"))
6256       ;; At this point, the buffer containing the menu exists and is
6257       ;; visible in the current window.  So, refresh it.
6258       (with-current-buffer "*Org Export Dispatcher*"
6259         ;; Refresh help.  Maintain display continuity by re-visiting
6260         ;; previous window position.
6261         (let ((pos (window-start)))
6262           (erase-buffer)
6263           (insert help)
6264           (set-window-start nil pos)))
6265       (org-fit-window-to-buffer)
6266       (org-export--dispatch-action
6267        standard-prompt allowed-keys entries options first-key expertp))))
6268
6269 (defun org-export--dispatch-action
6270   (prompt allowed-keys entries options first-key expertp)
6271   "Read a character from command input and act accordingly.
6272
6273 PROMPT is the displayed prompt, as a string.  ALLOWED-KEYS is
6274 a list of characters available at a given step in the process.
6275 ENTRIES is a list of menu entries.  OPTIONS, FIRST-KEY and
6276 EXPERTP are the same as defined in `org-export--dispatch-ui',
6277 which see.
6278
6279 Toggle export options when required.  Otherwise, return value is
6280 a list with action as CAR and a list of interactive export
6281 options as CDR."
6282   (let (key)
6283     ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6284     ;; C-p, SPC, DEL).
6285     (while (and (setq key (read-char-exclusive prompt))
6286                 (not expertp)
6287                 (memq key '(14 16 ?\s ?\d)))
6288       (case key
6289         (14 (if (not (pos-visible-in-window-p (point-max)))
6290                 (ignore-errors (scroll-up 1))
6291               (message "End of buffer")
6292               (sit-for 1)))
6293         (16 (if (not (pos-visible-in-window-p (point-min)))
6294                 (ignore-errors (scroll-down 1))
6295               (message "Beginning of buffer")
6296               (sit-for 1)))
6297         (?\s (if (not (pos-visible-in-window-p (point-max)))
6298                  (scroll-up nil)
6299                (message "End of buffer")
6300                (sit-for 1)))
6301         (?\d (if (not (pos-visible-in-window-p (point-min)))
6302                  (scroll-down nil)
6303                (message "Beginning of buffer")
6304                (sit-for 1)))))
6305     (cond
6306      ;; Ignore undefined associations.
6307      ((not (memq key allowed-keys))
6308       (ding)
6309       (unless expertp (message "Invalid key") (sit-for 1))
6310       (org-export--dispatch-ui options first-key expertp))
6311      ;; q key at first level aborts export.  At second level, cancel
6312      ;; first key instead.
6313      ((eq key ?q) (if (not first-key) (error "Export aborted")
6314                     (org-export--dispatch-ui options nil expertp)))
6315      ;; Help key: Switch back to standard interface if expert UI was
6316      ;; active.
6317      ((eq key ??) (org-export--dispatch-ui options first-key nil))
6318      ;; Send request for template insertion along with export scope.
6319      ((eq key ?#) (cons 'template (memq 'subtree options)))
6320      ;; Switch to asynchronous export stack.
6321      ((eq key ?&) '(stack))
6322      ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6323      ((memq key '(2 22 19 6 1))
6324       (org-export--dispatch-ui
6325        (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6326                            (6 'force) (1 'async))))
6327          (if (memq option options) (remq option options)
6328            (cons option options)))
6329        first-key expertp))
6330      ;; Action selected: Send key and options back to
6331      ;; `org-export-dispatch'.
6332      ((or first-key (functionp (nth 2 (assq key entries))))
6333       (cons (cond
6334              ((not first-key) (nth 2 (assq key entries)))
6335              ;; Publishing actions are hard-coded.  Send a special
6336              ;; signal to `org-export-dispatch'.
6337              ((eq first-key ?P)
6338               (case key
6339                 (?f 'publish-current-file)
6340                 (?p 'publish-current-project)
6341                 (?x 'publish-choose-project)
6342                 (?a 'publish-all)))
6343              ;; Return first action associated to FIRST-KEY + KEY
6344              ;; path. Indeed, derived backends can share the same
6345              ;; FIRST-KEY.
6346              (t (catch 'found
6347                   (mapc (lambda (entry)
6348                           (let ((match (assq key (nth 2 entry))))
6349                             (when match (throw 'found (nth 2 match)))))
6350                         (member (assq first-key entries) entries)))))
6351             options))
6352      ;; Otherwise, enter sub-menu.
6353      (t (org-export--dispatch-ui options key expertp)))))
6354
6355
6356
6357 (provide 'ox)
6358
6359 ;; Local variables:
6360 ;; generated-autoload-file: "org-loaddefs.el"
6361 ;; End:
6362
6363 ;;; ox.el ends here