ox-ascii.el 77.8 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*-
Bastien Guerry's avatar
Bastien Guerry committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2012-2020 Free Software Foundation, Inc.
Bastien Guerry's avatar
Bastien Guerry committed
4 5 6 7

;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
;; Keywords: outlines, hypermedia, calendar, wp

8 9
;; This file is part of GNU Emacs.

Bastien Guerry's avatar
Bastien Guerry committed
10 11 12 13 14 15 16 17 18 19 20
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Bastien Guerry's avatar
Bastien Guerry committed
22 23 24 25 26 27 28 29 30 31

;;; Commentary:
;;
;; This library implements an ASCII back-end for Org generic exporter.
;; See Org manual for more information.

;;; Code:

(require 'ox)
(require 'ox-publish)
Rasmus's avatar
Rasmus committed
32
(require 'cl-lib)
Bastien Guerry's avatar
Bastien Guerry committed
33 34 35 36 37

(declare-function aa2u "ext:ascii-art-to-unicode" ())

;;; Define Back-End
;;
38
;; The following setting won't allow modifying preferred charset
Bastien Guerry's avatar
Bastien Guerry committed
39
;; through a buffer keyword or an option item, but, since the property
40 41
;; will appear in communication channel nonetheless, it allows
;; overriding `org-ascii-charset' variable on the fly by the ext-plist
Bastien Guerry's avatar
Bastien Guerry committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
;; mechanism.
;;
;; We also install a filter for headlines and sections, in order to
;; control blank lines separating them in output string.

(org-export-define-backend 'ascii
  '((bold . org-ascii-bold)
    (center-block . org-ascii-center-block)
    (clock . org-ascii-clock)
    (code . org-ascii-code)
    (drawer . org-ascii-drawer)
    (dynamic-block . org-ascii-dynamic-block)
    (entity . org-ascii-entity)
    (example-block . org-ascii-example-block)
    (export-block . org-ascii-export-block)
    (export-snippet . org-ascii-export-snippet)
    (fixed-width . org-ascii-fixed-width)
    (footnote-reference . org-ascii-footnote-reference)
    (headline . org-ascii-headline)
    (horizontal-rule . org-ascii-horizontal-rule)
    (inline-src-block . org-ascii-inline-src-block)
    (inlinetask . org-ascii-inlinetask)
    (inner-template . org-ascii-inner-template)
    (italic . org-ascii-italic)
    (item . org-ascii-item)
    (keyword . org-ascii-keyword)
    (latex-environment . org-ascii-latex-environment)
    (latex-fragment . org-ascii-latex-fragment)
    (line-break . org-ascii-line-break)
    (link . org-ascii-link)
Rasmus's avatar
Rasmus committed
72
    (node-property . org-ascii-node-property)
Bastien Guerry's avatar
Bastien Guerry committed
73 74 75 76
    (paragraph . org-ascii-paragraph)
    (plain-list . org-ascii-plain-list)
    (plain-text . org-ascii-plain-text)
    (planning . org-ascii-planning)
Rasmus's avatar
Rasmus committed
77
    (property-drawer . org-ascii-property-drawer)
Bastien Guerry's avatar
Bastien Guerry committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    (quote-block . org-ascii-quote-block)
    (radio-target . org-ascii-radio-target)
    (section . org-ascii-section)
    (special-block . org-ascii-special-block)
    (src-block . org-ascii-src-block)
    (statistics-cookie . org-ascii-statistics-cookie)
    (strike-through . org-ascii-strike-through)
    (subscript . org-ascii-subscript)
    (superscript . org-ascii-superscript)
    (table . org-ascii-table)
    (table-cell . org-ascii-table-cell)
    (table-row . org-ascii-table-row)
    (target . org-ascii-target)
    (template . org-ascii-template)
    (timestamp . org-ascii-timestamp)
    (underline . org-ascii-underline)
    (verbatim . org-ascii-verbatim)
    (verse-block . org-ascii-verse-block))
  :menu-entry
  '(?t "Export to Plain Text"
       ((?A "As ASCII buffer"
	    (lambda (a s v b)
	      (org-ascii-export-as-ascii a s v b '(:ascii-charset ascii))))
	(?a "As ASCII file"
	    (lambda (a s v b)
	      (org-ascii-export-to-ascii a s v b '(:ascii-charset ascii))))
	(?L "As Latin1 buffer"
	    (lambda (a s v b)
	      (org-ascii-export-as-ascii a s v b '(:ascii-charset latin1))))
	(?l "As Latin1 file"
	    (lambda (a s v b)
	      (org-ascii-export-to-ascii a s v b '(:ascii-charset latin1))))
	(?U "As UTF-8 buffer"
	    (lambda (a s v b)
	      (org-ascii-export-as-ascii a s v b '(:ascii-charset utf-8))))
	(?u "As UTF-8 file"
	    (lambda (a s v b)
	      (org-ascii-export-to-ascii a s v b '(:ascii-charset utf-8))))))
  :filters-alist '((:filter-headline . org-ascii-filter-headline-blank-lines)
		   (:filter-parse-tree org-ascii-filter-paragraph-spacing
				       org-ascii-filter-comment-spacing)
		   (:filter-section . org-ascii-filter-headline-blank-lines))
Rasmus's avatar
Rasmus committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  :options-alist
  '((:subtitle "SUBTITLE" nil nil parse)
    (:ascii-bullets nil nil org-ascii-bullets)
    (:ascii-caption-above nil nil org-ascii-caption-above)
    (:ascii-charset nil nil org-ascii-charset)
    (:ascii-global-margin nil nil org-ascii-global-margin)
    (:ascii-format-drawer-function nil nil org-ascii-format-drawer-function)
    (:ascii-format-inlinetask-function
     nil nil org-ascii-format-inlinetask-function)
    (:ascii-headline-spacing nil nil org-ascii-headline-spacing)
    (:ascii-indented-line-width nil nil org-ascii-indented-line-width)
    (:ascii-inlinetask-width nil nil org-ascii-inlinetask-width)
    (:ascii-inner-margin nil nil org-ascii-inner-margin)
    (:ascii-links-to-notes nil nil org-ascii-links-to-notes)
    (:ascii-list-margin nil nil org-ascii-list-margin)
    (:ascii-paragraph-spacing nil nil org-ascii-paragraph-spacing)
    (:ascii-quote-margin nil nil org-ascii-quote-margin)
    (:ascii-table-keep-all-vertical-lines
     nil nil org-ascii-table-keep-all-vertical-lines)
    (:ascii-table-use-ascii-art nil nil org-ascii-table-use-ascii-art)
    (:ascii-table-widen-columns nil nil org-ascii-table-widen-columns)
    (:ascii-text-width nil nil org-ascii-text-width)
    (:ascii-underline nil nil org-ascii-underline)
    (:ascii-verbatim-format nil nil org-ascii-verbatim-format)))
Bastien Guerry's avatar
Bastien Guerry committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179



;;; User Configurable Variables

(defgroup org-export-ascii nil
  "Options for exporting Org mode files to ASCII."
  :tag "Org Export ASCII"
  :group 'org-export)

(defcustom org-ascii-text-width 72
  "Maximum width of exported text.
This number includes margin size, as set in
`org-ascii-global-margin'."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'integer)

(defcustom org-ascii-global-margin 0
  "Width of the left margin, in number of characters."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'integer)

(defcustom org-ascii-inner-margin 2
  "Width of the inner margin, in number of characters.
Inner margin is applied between each headline."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'integer)

(defcustom org-ascii-quote-margin 6
  "Width of margin used for quoting text, in characters.
Rasmus's avatar
Rasmus committed
180 181
This margin is applied on both sides of the text.  It is also
applied on the left side of contents in descriptive lists."
Bastien Guerry's avatar
Bastien Guerry committed
182 183 184 185 186
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'integer)

Rasmus's avatar
Rasmus committed
187 188 189 190 191 192 193 194 195
(defcustom org-ascii-list-margin 0
  "Width of margin used for plain lists, in characters.
This margin applies to top level list only, not to its
sub-lists."
  :group 'org-export-ascii
  :version "26.1"
  :package-version '(Org . "8.3")
  :type 'integer)

Bastien Guerry's avatar
Bastien Guerry committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
(defcustom org-ascii-inlinetask-width 30
  "Width of inline tasks, in number of characters.
This number ignores any margin."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'integer)

(defcustom org-ascii-headline-spacing '(1 . 2)
  "Number of blank lines inserted around headlines.

This variable can be set to a cons cell.  In that case, its car
represents the number of blank lines present before headline
contents whereas its cdr reflects the number of blank lines after
contents.

A nil value replicates the number of blank lines found in the
original Org buffer at the same place."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(choice
	  (const :tag "Replicate original spacing" nil)
219
	  (cons :tag "Set a uniform spacing"
Bastien Guerry's avatar
Bastien Guerry committed
220 221 222 223 224 225
		(integer :tag "Number of blank lines before contents")
		(integer :tag "Number of blank lines after contents"))))

(defcustom org-ascii-indented-line-width 'auto
  "Additional indentation width for the first line in a paragraph.
If the value is an integer, indent the first line of each
Bastien Guerry's avatar
Bastien Guerry committed
226 227 228 229
paragraph by this width, unless it is located at the beginning of
a section, in which case indentation is removed from that line.
If it is the symbol `auto' preserve indentation from original
document."
Bastien Guerry's avatar
Bastien Guerry committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(choice
	  (integer :tag "Number of white spaces characters")
	  (const :tag "Preserve original width" auto)))

(defcustom org-ascii-paragraph-spacing 'auto
  "Number of white lines between paragraphs.
If the value is an integer, add this number of blank lines
between contiguous paragraphs.  If is it the symbol `auto', keep
the same number of blank lines as in the original document."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(choice
	  (integer :tag "Number of blank lines")
	  (const :tag "Preserve original spacing" auto)))

(defcustom org-ascii-charset 'ascii
  "The charset allowed to represent various elements and objects.
Possible values are:
`ascii'    Only use plain ASCII characters
`latin1'   Include Latin-1 characters
`utf-8'    Use all UTF-8 characters"
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(choice
	  (const :tag "ASCII" ascii)
	  (const :tag "Latin-1" latin1)
	  (const :tag "UTF-8" utf-8)))

(defcustom org-ascii-underline '((ascii ?= ?~ ?-)
				 (latin1 ?= ?~ ?-)
				 (utf-8 ? ? ? ? ?))
  "Characters for underlining headings in ASCII export.

Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
and whose value is a list of characters.

For each supported charset, this variable associates a sequence
of underline characters.  In a sequence, the characters will be
used in order for headlines level 1, 2, ...  If no character is
available for a given level, the headline won't be underlined."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(list
	  (cons :tag "Underline characters sequence"
		(const :tag "ASCII charset" ascii)
		(repeat character))
	  (cons :tag "Underline characters sequence"
		(const :tag "Latin-1 charset" latin1)
		(repeat character))
	  (cons :tag "Underline characters sequence"
		(const :tag "UTF-8 charset" utf-8)
		(repeat character))))

(defcustom org-ascii-bullets '((ascii ?* ?+ ?-)
			       (latin1 ?§ ?)
			       (utf-8 ?))
  "Bullet characters for headlines converted to lists in ASCII export.

Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
and whose value is a list of characters.

The first character is used for the first level considered as low
level, and so on.  If there are more levels than characters given
here, the list will be repeated.

Note that this variable doesn't affect plain lists
representation."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type '(list
	  (cons :tag "Bullet characters for low level headlines"
		(const :tag "ASCII charset" ascii)
		(repeat character))
	  (cons :tag "Bullet characters for low level headlines"
		(const :tag "Latin-1 charset" latin1)
		(repeat character))
	  (cons :tag "Bullet characters for low level headlines"
		(const :tag "UTF-8 charset" utf-8)
		(repeat character))))

(defcustom org-ascii-links-to-notes t
  "Non-nil means convert links to notes before the next headline.
When nil, the link will be exported in place.  If the line
becomes long in this way, it will be wrapped."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'boolean)

(defcustom org-ascii-table-keep-all-vertical-lines nil
  "Non-nil means keep all vertical lines in ASCII tables.
When nil, vertical lines will be removed except for those needed
for column grouping."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'boolean)

(defcustom org-ascii-table-widen-columns t
  "Non-nil means widen narrowed columns for export.
When nil, narrowed columns will look in ASCII export just like in
Org mode, i.e. with \"=>\" as ellipsis."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'boolean)

(defcustom org-ascii-table-use-ascii-art nil
Rasmus's avatar
Rasmus committed
345
  "Non-nil means \"table.el\" tables are turned into ASCII art.
Bastien Guerry's avatar
Bastien Guerry committed
346
It only makes sense when export charset is `utf-8'.  It is nil by
Rasmus's avatar
Rasmus committed
347 348
default since it requires \"ascii-art-to-unicode.el\" package,
available through, e.g., GNU ELPA."
Bastien Guerry's avatar
Bastien Guerry committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'boolean)

(defcustom org-ascii-caption-above nil
  "When non-nil, place caption string before the element.
Otherwise, place it right after it."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'boolean)

(defcustom org-ascii-verbatim-format "`%s'"
  "Format string used for verbatim text and inline code."
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'string)

Bastien Guerry's avatar
Bastien Guerry committed
369
(defcustom org-ascii-format-drawer-function
Rasmus's avatar
Rasmus committed
370
  (lambda (_name contents _width) contents)
Bastien Guerry's avatar
Bastien Guerry committed
371 372 373 374 375 376 377 378 379 380
  "Function called to format a drawer in ASCII.

The function must accept three parameters:
  NAME      the drawer name, like \"LOGBOOK\"
  CONTENTS  the contents of the drawer.
  WIDTH     the text width within the drawer.

The function should return either the string to be exported or
nil to ignore the drawer.

Bastien Guerry's avatar
Bastien Guerry committed
381
The default value simply returns the value of CONTENTS."
Bastien Guerry's avatar
Bastien Guerry committed
382 383 384 385 386
  :group 'org-export-ascii
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'function)

Bastien Guerry's avatar
Bastien Guerry committed
387 388
(defcustom org-ascii-format-inlinetask-function
  'org-ascii-format-inlinetask-default
Bastien Guerry's avatar
Bastien Guerry committed
389 390
  "Function called to format an inlinetask in ASCII.

Bastien Guerry's avatar
Bastien Guerry committed
391 392 393 394 395 396 397 398 399 400
The function must accept nine parameters:
  TODO       the todo keyword, as a string
  TODO-TYPE  the todo type, a symbol among `todo', `done' and nil.
  PRIORITY   the inlinetask priority, as a string
  NAME       the inlinetask name, as a string.
  TAGS       the inlinetask tags, as a list of strings.
  CONTENTS   the contents of the inlinetask, as a string.
  WIDTH      the width of the inlinetask, as a number.
  INLINETASK the inlinetask itself.
  INFO       the info channel.
Bastien Guerry's avatar
Bastien Guerry committed
401 402

The function should return either the string to be exported or
Bastien Guerry's avatar
Bastien Guerry committed
403
nil to ignore the inline task."
Bastien Guerry's avatar
Bastien Guerry committed
404
  :group 'org-export-ascii
Rasmus's avatar
Rasmus committed
405
  :version "26.1"
Bastien Guerry's avatar
Bastien Guerry committed
406
  :package-version '(Org . "8.3")
Bastien Guerry's avatar
Bastien Guerry committed
407 408 409 410 411 412 413 414
  :type 'function)



;;; Internal Functions

;; Internal functions fall into three categories.

Rasmus's avatar
Rasmus committed
415 416 417 418 419 420 421 422 423 424 425 426
;; The first one is about text formatting.  The core functions are
;; `org-ascii--current-text-width' and
;; `org-ascii--current-justification', which determine, respectively,
;; the current text width allowed to a given element and its expected
;; justification.  Once this information is known,
;; `org-ascii--fill-string', `org-ascii--justify-lines',
;; `org-ascii--justify-element' `org-ascii--box-string' and
;; `org-ascii--indent-string' can operate on a given output string.
;; In particular, justification happens at the regular (i.e.,
;; non-greater) element level, which means that when the exporting
;; process reaches a container (e.g., a center block) content are
;; already justified.
Bastien Guerry's avatar
Bastien Guerry committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

;; The second category contains functions handling elements listings,
;; triggered by "#+TOC:" keyword.  As such, `org-ascii--build-toc'
;; returns a complete table of contents, `org-ascii--list-listings'
;; returns a list of referenceable src-block elements, and
;; `org-ascii--list-tables' does the same for table elements.

;; The third category includes general helper functions.
;; `org-ascii--build-title' creates the title for a given headline
;; or inlinetask element.  `org-ascii--build-caption' returns the
;; caption string associated to a table or a src-block.
;; `org-ascii--describe-links' creates notes about links for
;; insertion at the end of a section.  It uses
;; `org-ascii--unique-links' to get the list of links to describe.
;; Eventually, `org-ascii--translate' translates a string according
;; to language and charset specification.


(defun org-ascii--fill-string (s text-width info &optional justify)
  "Fill a string with specified text-width and return it.

S is the string being filled.  TEXT-WIDTH is an integer
specifying maximum length of a line.  INFO is the plist used as
a communication channel.

Optional argument JUSTIFY can specify any type of justification
among `left', `center', `right' or `full'.  A nil value is
equivalent to `left'.  For a justification that doesn't also fill
Rasmus's avatar
Rasmus committed
455 456
string, see `org-ascii--justify-lines' and
`org-ascii--justify-block'.
Bastien Guerry's avatar
Bastien Guerry committed
457 458

Return nil if S isn't a string."
Bastien Guerry's avatar
Bastien Guerry committed
459 460 461 462 463 464 465 466 467 468 469
  (when (stringp s)
    (let ((double-space-p sentence-end-double-space))
      (with-temp-buffer
	(let ((fill-column text-width)
	      (use-hard-newlines t)
	      (sentence-end-double-space double-space-p))
	  (insert (if (plist-get info :preserve-breaks)
		      (replace-regexp-in-string "\n" hard-newline s)
		    s))
	  (fill-region (point-min) (point-max) justify))
	(buffer-string)))))
Bastien Guerry's avatar
Bastien Guerry committed
470

Rasmus's avatar
Rasmus committed
471 472
(defun org-ascii--justify-lines (s text-width how)
  "Justify all lines in string S.
Bastien Guerry's avatar
Bastien Guerry committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
TEXT-WIDTH is an integer specifying maximum length of a line.
HOW determines the type of justification: it can be `left',
`right', `full' or `center'."
  (with-temp-buffer
    (insert s)
    (goto-char (point-min))
    (let ((fill-column text-width)
	  ;; Disable `adaptive-fill-mode' so it doesn't prevent
	  ;; filling lines matching `adaptive-fill-regexp'.
	  (adaptive-fill-mode nil))
      (while (< (point) (point-max))
	(justify-current-line how)
	(forward-line)))
    (buffer-string)))

Rasmus's avatar
Rasmus committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
(defun org-ascii--justify-element (contents element info)
  "Justify CONTENTS of ELEMENT.
INFO is a plist used as a communication channel.  Justification
is done according to the type of element.  More accurately,
paragraphs are filled and other elements are justified as blocks,
that is according to the widest non blank line in CONTENTS."
  (if (not (org-string-nw-p contents)) contents
    (let ((text-width (org-ascii--current-text-width element info))
	  (how (org-ascii--current-justification element)))
      (cond
       ((eq (org-element-type element) 'paragraph)
	;; Paragraphs are treated specially as they need to be filled.
	(org-ascii--fill-string contents text-width info how))
       ((eq how 'left) contents)
       (t (with-temp-buffer
	    (insert contents)
	    (goto-char (point-min))
	    (catch 'exit
	      (let ((max-width 0))
		;; Compute maximum width.  Bail out if it is greater
		;; than page width, since no justification is
		;; possible.
		(save-excursion
		  (while (not (eobp))
		    (unless (looking-at-p "[ \t]*$")
		      (end-of-line)
		      (let ((column (current-column)))
			(cond
			 ((>= column text-width) (throw 'exit contents))
			 ((> column max-width) (setq max-width column)))))
		    (forward-line)))
		;; Justify every line according to TEXT-WIDTH and
		;; MAX-WIDTH.
		(let ((offset (/ (- text-width max-width)
				 (if (eq how 'right) 1 2))))
		  (if (zerop offset) (throw 'exit contents)
		    (while (not (eobp))
		      (unless (looking-at-p "[ \t]*$")
			(indent-to-column offset))
		      (forward-line)))))
	      (buffer-string))))))))

Bastien Guerry's avatar
Bastien Guerry committed
530 531 532 533 534
(defun org-ascii--indent-string (s width)
  "Indent string S by WIDTH white spaces.
Empty lines are not indented."
  (when (stringp s)
    (replace-regexp-in-string
Bastien Guerry's avatar
Bastien Guerry committed
535
     "\\(^\\)[ \t]*\\S-" (make-string width ?\s) s nil nil 1)))
Bastien Guerry's avatar
Bastien Guerry committed
536 537 538

(defun org-ascii--box-string (s info)
  "Return string S with a partial box to its left.
Paul Eggert's avatar
Paul Eggert committed
539
INFO is a plist used as a communication channel."
Bastien Guerry's avatar
Bastien Guerry committed
540
  (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
Bastien Guerry's avatar
Bastien Guerry committed
541
    (format (if utf8p "┌────\n%s\n└────" ",----\n%s\n`----")
Bastien Guerry's avatar
Bastien Guerry committed
542 543 544 545 546 547 548 549
	    (replace-regexp-in-string
	     "^" (if utf8p "│ " "| ")
	     ;; Remove last newline character.
	     (replace-regexp-in-string "\n[ \t]*\\'" "" s)))))

(defun org-ascii--current-text-width (element info)
  "Return maximum text width for ELEMENT's contents.
INFO is a plist used as a communication channel."
Rasmus's avatar
Rasmus committed
550
  (pcase (org-element-type element)
Bastien Guerry's avatar
Bastien Guerry committed
551
    ;; Elements with an absolute width: `headline' and `inlinetask'.
Rasmus's avatar
Rasmus committed
552 553 554
    (`inlinetask (plist-get info :ascii-inlinetask-width))
    (`headline
     (- (plist-get info :ascii-text-width)
Rasmus's avatar
Rasmus committed
555 556 557
        (let ((low-level-rank (org-export-low-level-p element info)))
          (if low-level-rank (* low-level-rank 2)
            (plist-get info :ascii-global-margin)))))
Bastien Guerry's avatar
Bastien Guerry committed
558 559
    ;; Elements with a relative width: store maximum text width in
    ;; TOTAL-WIDTH.
Rasmus's avatar
Rasmus committed
560 561
    (_
     (let* ((genealogy (org-element-lineage element nil t))
Rasmus's avatar
Rasmus committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
            ;; Total width is determined by the presence, or not, of an
            ;; inline task among ELEMENT parents.
            (total-width
             (if (cl-some (lambda (parent)
                            (eq (org-element-type parent) 'inlinetask))
                          genealogy)
                 (plist-get info :ascii-inlinetask-width)
               ;; No inlinetask: Remove global margin from text width.
               (- (plist-get info :ascii-text-width)
                  (plist-get info :ascii-global-margin)
                  (let ((parent (org-export-get-parent-headline element)))
                    ;; Inner margin doesn't apply to text before first
                    ;; headline.
                    (if (not parent) 0
                      (let ((low-level-rank
                             (org-export-low-level-p parent info)))
                        ;; Inner margin doesn't apply to contents of
                        ;; low level headlines, since they've got their
                        ;; own indentation mechanism.
                        (if low-level-rank (* low-level-rank 2)
                          (plist-get info :ascii-inner-margin)))))))))
Bastien Guerry's avatar
Bastien Guerry committed
583
       (- total-width
Rasmus's avatar
Rasmus committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
          ;; Each `quote-block' and `verse-block' above narrows text
          ;; width by twice the standard margin size.
          (+ (* (cl-count-if (lambda (parent)
                               (memq (org-element-type parent)
                                     '(quote-block verse-block)))
                             genealogy)
                2
                (plist-get info :ascii-quote-margin))
             ;; Apply list margin once per "top-level" plain-list
             ;; containing current line
             (* (cl-count-if
                 (lambda (e)
                   (and (eq (org-element-type e) 'plain-list)
                        (not (eq (org-element-type (org-export-get-parent e))
                                 'item))))
                 genealogy)
                (plist-get info :ascii-list-margin))
             ;; Compute indentation offset due to current list.  It is
	     ;; `org-ascii-quote-margin' per descriptive item in the
	     ;; genealogy, bullet's length otherwise.
             (let ((indentation 0))
               (dolist (e genealogy)
                 (cond
                  ((not (eq 'item (org-element-type e))))
                  ((eq (org-element-property :type (org-export-get-parent e))
                       'descriptive)
                   (cl-incf indentation org-ascii-quote-margin))
                  (t
                   (cl-incf indentation
                            (+ (string-width
                                (or (org-ascii--checkbox e info) ""))
                               (string-width
                                (org-element-property :bullet e)))))))
               indentation)))))))
Rasmus's avatar
Rasmus committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

(defun org-ascii--current-justification (element)
  "Return expected justification for ELEMENT's contents.
Return value is a symbol among `left', `center', `right' and
`full'."
  (let (justification)
    (while (and (not justification)
		(setq element (org-element-property :parent element)))
      (pcase (org-element-type element)
	(`center-block (setq justification 'center))
	(`special-block
	 (let ((name (org-element-property :type element)))
	   (cond ((string= name "JUSTIFYRIGHT") (setq justification 'right))
		 ((string= name "JUSTIFYLEFT") (setq justification 'left)))))))
    (or justification 'left)))
Bastien Guerry's avatar
Bastien Guerry committed
633 634

(defun org-ascii--build-title
Bastien's avatar
Bastien committed
635
    (element info text-width &optional underline notags toc)
Bastien Guerry's avatar
Bastien Guerry committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
  "Format ELEMENT title and return it.

ELEMENT is either an `headline' or `inlinetask' element.  INFO is
a plist used as a communication channel.  TEXT-WIDTH is an
integer representing the maximum length of a line.

When optional argument UNDERLINE is non-nil, underline title,
without the tags, according to `org-ascii-underline'
specifications.

If optional argument NOTAGS is non-nil, no tags will be added to
the title.

When optional argument TOC is non-nil, use optional title if
possible.  It doesn't apply to `inlinetask' elements."
  (let* ((headlinep (eq (org-element-type element) 'headline))
	 (numbers
	  ;; Numbering is specific to headlines.
Bastien's avatar
Bastien committed
654 655 656 657 658 659
	  (and headlinep
	       (org-export-numbered-headline-p element info)
	       (let ((numbering (org-export-get-headline-number element info)))
		 (if toc (format "%d. " (org-last numbering))
		   (concat (mapconcat #'number-to-string numbering ".")
			   " ")))))
Bastien Guerry's avatar
Bastien Guerry committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673
	 (text
	  (org-trim
	   (org-export-data
	    (if (and toc headlinep) (org-export-get-alt-title element info)
	      (org-element-property :title element))
	    info)))
	 (todo
	  (and (plist-get info :with-todo-keywords)
	       (let ((todo (org-element-property :todo-keyword element)))
		 (and todo (concat (org-export-data todo info) " ")))))
	 (tags (and (not notags)
		    (plist-get info :with-tags)
		    (let ((tag-list (org-export-get-tags element info)))
		      (and tag-list
Bastien's avatar
Bastien committed
674
			   (org-make-tag-string tag-list)))))
Bastien Guerry's avatar
Bastien Guerry committed
675 676 677 678 679 680 681 682 683 684 685
	 (priority
	  (and (plist-get info :with-priority)
	       (let ((char (org-element-property :priority element)))
		 (and char (format "(#%c) " char)))))
	 (first-part (concat numbers todo priority text)))
    (concat
     first-part
     ;; Align tags, if any.
     (when tags
       (format
	(format " %%%ds"
Bastien Guerry's avatar
Bastien Guerry committed
686 687
		(max (- text-width  (1+ (string-width first-part)))
		     (string-width tags)))
Bastien Guerry's avatar
Bastien Guerry committed
688 689 690 691 692 693 694
	tags))
     ;; Maybe underline text, if ELEMENT type is `headline' and an
     ;; underline character has been defined.
     (when (and underline headlinep)
       (let ((under-char
	      (nth (1- (org-export-get-relative-level element info))
		   (cdr (assq (plist-get info :ascii-charset)
Rasmus's avatar
Rasmus committed
695
			      (plist-get info :ascii-underline))))))
Bastien Guerry's avatar
Bastien Guerry committed
696 697
	 (and under-char
	      (concat "\n"
Bastien Guerry's avatar
Bastien Guerry committed
698 699 700
		      (make-string (/ (string-width first-part)
				      (char-width under-char))
				   under-char))))))))
Bastien Guerry's avatar
Bastien Guerry committed
701

Rasmus's avatar
Rasmus committed
702
(defun org-ascii--has-caption-p (element _info)
Bastien Guerry's avatar
Bastien Guerry committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
  "Non-nil when ELEMENT has a caption affiliated keyword.
INFO is a plist used as a communication channel.  This function
is meant to be used as a predicate for `org-export-get-ordinal'."
  (org-element-property :caption element))

(defun org-ascii--build-caption (element info)
  "Return caption string for ELEMENT, if applicable.

INFO is a plist used as a communication channel.

The caption string contains the sequence number of ELEMENT along
with its real caption.  Return nil when ELEMENT has no affiliated
caption keyword."
  (let ((caption (org-export-get-caption element)))
    (when caption
      ;; Get sequence number of current src-block among every
      ;; src-block with a caption.
      (let ((reference
	     (org-export-get-ordinal
	      element info nil 'org-ascii--has-caption-p))
	    (title-fmt (org-ascii--translate
Rasmus's avatar
Rasmus committed
724 725 726
			(pcase (org-element-type element)
			  (`table "Table %d:")
			  (`src-block "Listing %d:"))
Bastien Guerry's avatar
Bastien Guerry committed
727 728 729 730 731 732 733
			info)))
	(org-ascii--fill-string
	 (concat (format title-fmt reference)
		 " "
		 (org-export-data caption info))
	 (org-ascii--current-text-width element info) info)))))

Bastien's avatar
Bastien committed
734
(defun org-ascii--build-toc (info &optional n keyword scope)
Bastien Guerry's avatar
Bastien Guerry committed
735 736 737 738 739 740 741 742
  "Return a table of contents.

INFO is a plist used as a communication channel.

Optional argument N, when non-nil, is an integer specifying the
depth of the table.

Optional argument KEYWORD specifies the TOC keyword, if any, from
Rasmus's avatar
Rasmus committed
743 744
which the table of contents generation has been initiated.

Bastien's avatar
Bastien committed
745 746
When optional argument SCOPE is non-nil, build a table of
contents according to the specified scope."
Rasmus's avatar
Rasmus committed
747
  (concat
Bastien's avatar
Bastien committed
748
   (unless scope
Rasmus's avatar
Rasmus committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
     (let ((title (org-ascii--translate "Table of Contents" info)))
       (concat title "\n"
	       (make-string
		(string-width title)
		(if (eq (plist-get info :ascii-charset) 'utf-8) ? ?_))
	       "\n\n")))
   (let ((text-width
	  (if keyword (org-ascii--current-text-width keyword info)
	    (- (plist-get info :ascii-text-width)
	       (plist-get info :ascii-global-margin)))))
     (mapconcat
      (lambda (headline)
	(let* ((level (org-export-get-relative-level headline info))
	       (indent (* (1- level) 3)))
	  (concat
	   (unless (zerop indent) (concat (make-string (1- indent) ?.) " "))
	   (org-ascii--build-title
	    headline info (- text-width indent) nil
	    (or (not (plist-get info :with-tags))
		(eq (plist-get info :with-tags) 'not-in-toc))
	    'toc))))
Bastien's avatar
Bastien committed
770
      (org-export-collect-headlines info n scope) "\n"))))
Bastien Guerry's avatar
Bastien Guerry committed
771 772 773 774 775 776 777 778 779

(defun org-ascii--list-listings (keyword info)
  "Return a list of listings.

KEYWORD is the keyword that initiated the list of listings
generation.  INFO is a plist used as a communication channel."
  (let ((title (org-ascii--translate "List of Listings" info)))
    (concat
     title "\n"
Bastien Guerry's avatar
Bastien Guerry committed
780
     (make-string (string-width title)
Bastien Guerry's avatar
Bastien Guerry committed
781 782 783 784
		  (if (eq (plist-get info :ascii-charset) 'utf-8) ? ?_))
     "\n\n"
     (let ((text-width
	    (if keyword (org-ascii--current-text-width keyword info)
Rasmus's avatar
Rasmus committed
785 786
	      (- (plist-get info :ascii-text-width)
		 (plist-get info :ascii-global-margin))))
Paul Eggert's avatar
Paul Eggert committed
787
	   ;; Use a counter instead of retrieving ordinal of each
Bastien Guerry's avatar
Bastien Guerry committed
788 789 790 791 792 793 794
	   ;; src-block.
	   (count 0))
       (mapconcat
	(lambda (src-block)
	  ;; Store initial text so its length can be computed.  This is
	  ;; used to properly align caption right to it in case of
	  ;; filling (like contents of a description list item).
Bastien Guerry's avatar
Bastien Guerry committed
795 796
	  (let* ((initial-text
		  (format (org-ascii--translate "Listing %d:" info)
Rasmus's avatar
Rasmus committed
797
			  (cl-incf count)))
Bastien Guerry's avatar
Bastien Guerry committed
798
		 (initial-width (string-width initial-text)))
Bastien Guerry's avatar
Bastien Guerry committed
799 800 801 802 803 804 805 806 807
	    (concat
	     initial-text " "
	     (org-trim
	      (org-ascii--indent-string
	       (org-ascii--fill-string
		;; Use short name in priority, if available.
		(let ((caption (or (org-export-get-caption src-block t)
				   (org-export-get-caption src-block))))
		  (org-export-data caption info))
Bastien Guerry's avatar
Bastien Guerry committed
808 809
		(- text-width initial-width) info)
	       initial-width)))))
Bastien Guerry's avatar
Bastien Guerry committed
810 811 812 813 814 815 816 817 818 819
	(org-export-collect-listings info) "\n")))))

(defun org-ascii--list-tables (keyword info)
  "Return a list of tables.

KEYWORD is the keyword that initiated the list of tables
generation.  INFO is a plist used as a communication channel."
  (let ((title (org-ascii--translate "List of Tables" info)))
    (concat
     title "\n"
Bastien Guerry's avatar
Bastien Guerry committed
820
     (make-string (string-width title)
Bastien Guerry's avatar
Bastien Guerry committed
821 822 823 824
		  (if (eq (plist-get info :ascii-charset) 'utf-8) ? ?_))
     "\n\n"
     (let ((text-width
	    (if keyword (org-ascii--current-text-width keyword info)
Rasmus's avatar
Rasmus committed
825 826
	      (- (plist-get info :ascii-text-width)
		 (plist-get info :ascii-global-margin))))
Paul Eggert's avatar
Paul Eggert committed
827
	   ;; Use a counter instead of retrieving ordinal of each
Bastien Guerry's avatar
Bastien Guerry committed
828 829 830 831 832 833 834
	   ;; src-block.
	   (count 0))
       (mapconcat
	(lambda (table)
	  ;; Store initial text so its length can be computed.  This is
	  ;; used to properly align caption right to it in case of
	  ;; filling (like contents of a description list item).
Bastien Guerry's avatar
Bastien Guerry committed
835 836
	  (let* ((initial-text
		  (format (org-ascii--translate "Table %d:" info)
Rasmus's avatar
Rasmus committed
837
			  (cl-incf count)))
Bastien Guerry's avatar
Bastien Guerry committed
838
		 (initial-width (string-width initial-text)))
Bastien Guerry's avatar
Bastien Guerry committed
839 840 841 842 843 844 845 846 847
	    (concat
	     initial-text " "
	     (org-trim
	      (org-ascii--indent-string
	       (org-ascii--fill-string
		;; Use short name in priority, if available.
		(let ((caption (or (org-export-get-caption table t)
				   (org-export-get-caption table))))
		  (org-export-data caption info))
Bastien Guerry's avatar
Bastien Guerry committed
848 849
		(- text-width initial-width) info)
	       initial-width)))))
Bastien Guerry's avatar
Bastien Guerry committed
850 851 852 853 854 855 856 857
	(org-export-collect-tables info) "\n")))))

(defun org-ascii--unique-links (element info)
  "Return a list of unique link references in ELEMENT.
ELEMENT is either a headline element or a section element.  INFO
is a plist used as a communication channel."
  (let* (seen
	 (unique-link-p
Rasmus's avatar
Rasmus committed
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
	  ;; Return LINK if it wasn't referenced so far, or nil.
	  ;; Update SEEN links along the way.
	  (lambda (link)
	    (let ((footprint
		   ;; Normalize description in footprints.
		   (cons (org-element-property :raw-link link)
			 (let ((contents (org-element-contents link)))
			   (and contents
				(replace-regexp-in-string
				 "[ \r\t\n]+" " "
				 (org-trim
				  (org-element-interpret-data contents))))))))
	      ;; Ignore LINK if it hasn't been translated already.  It
	      ;; can happen if it is located in an affiliated keyword
	      ;; that was ignored.
	      (when (and (org-string-nw-p
			  (gethash link (plist-get info :exported-data)))
			 (not (member footprint seen)))
		(push footprint seen) link)))))
    (org-element-map (if (eq (org-element-type element) 'section)
			 element
		       ;; In a headline, only retrieve links in title
		       ;; and relative section, not in children.
		       (list (org-element-property :title element)
			     (car (org-element-contents element))))
	'link unique-link-p info nil 'headline t)))

(defun org-ascii--describe-datum (datum info)
  "Describe DATUM object or element.
If DATUM is a string, consider it to be a file name, per
`org-export-resolve-id-link'.  INFO is the communication channel,
as a plist."
  (pcase (org-element-type datum)
    (`plain-text (format "See file %s" datum)) ;External file
    (`headline
     (format (org-ascii--translate "See section %s" info)
	     (if (org-export-numbered-headline-p datum info)
		 (mapconcat #'number-to-string
			    (org-export-get-headline-number datum info)
			    ".")
	       (org-export-data (org-element-property :title datum) info))))
    (_
     (let ((number (org-export-get-ordinal
		    datum info nil #'org-ascii--has-caption-p))
	   ;; If destination is a target, make sure we can name the
	   ;; container it refers to.
	   (enumerable
Paul Eggert's avatar
Paul Eggert committed
905 906
	    (org-element-lineage datum
				 '(headline paragraph src-block table) t)))
Rasmus's avatar
Rasmus committed
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
       (pcase (org-element-type enumerable)
	 (`headline
	  (format (org-ascii--translate "See section %s" info)
		  (if (org-export-numbered-headline-p enumerable info)
		      (mapconcat #'number-to-string number ".")
		    (org-export-data
		     (org-element-property :title enumerable) info))))
	 ((guard (not number))
	  (org-ascii--translate "Unknown reference" info))
	 (`paragraph
	  (format (org-ascii--translate "See figure %s" info) number))
	 (`src-block
	  (format (org-ascii--translate "See listing %s" info) number))
	 (`table
	  (format (org-ascii--translate "See table %s" info) number))
	 (_ (org-ascii--translate "Unknown reference" info)))))))
Bastien Guerry's avatar
Bastien Guerry committed
923 924 925 926 927 928 929 930 931

(defun org-ascii--describe-links (links width info)
  "Return a string describing a list of links.
LINKS is a list of link type objects, as returned by
`org-ascii--unique-links'.  WIDTH is the text width allowed for
the output string.  INFO is a plist used as a communication
channel."
  (mapconcat
   (lambda (link)
Rasmus's avatar
Rasmus committed
932 933 934 935 936
     (let* ((type (org-element-property :type link))
	    (description (org-element-contents link))
	    (anchor (org-export-data
		     (or description (org-element-property :raw-link link))
		     info)))
Bastien Guerry's avatar
Bastien Guerry committed
937
       (cond
Rasmus's avatar
Rasmus committed
938 939 940 941 942 943 944 945 946 947 948 949 950
	((member type '("coderef" "radio")) nil)
	((member type '("custom-id" "fuzzy" "id"))
	 ;; Only links with a description need an entry.  Other are
	 ;; already handled in `org-ascii-link'.
	 (when description
	   (let ((dest (if (equal type "fuzzy")
			   (org-export-resolve-fuzzy-link link info)
			 (org-export-resolve-id-link link info))))
	     (concat
	      (org-ascii--fill-string
	       (format "[%s] %s" anchor (org-ascii--describe-datum dest info))
	       width info)
	      "\n\n"))))
Bastien Guerry's avatar
Bastien Guerry committed
951 952 953 954
	;; Do not add a link that cannot be resolved and doesn't have
	;; any description: destination is already visible in the
	;; paragraph.
	((not (org-element-contents link)) nil)
Rasmus's avatar
Rasmus committed
955 956 957
	;; Do not add a link already handled by custom export
	;; functions.
	((org-export-custom-protocol-maybe link anchor 'ascii) nil)
Bastien Guerry's avatar
Bastien Guerry committed
958 959 960
	(t
	 (concat
	  (org-ascii--fill-string
Bastien's avatar
Bastien committed
961
	   (format "[%s] <%s>" anchor (org-element-property :raw-link link))
Bastien Guerry's avatar
Bastien Guerry committed
962 963 964 965 966 967 968 969
	   width info)
	  "\n\n")))))
   links ""))

(defun org-ascii--checkbox (item info)
  "Return checkbox string for ITEM or nil.
INFO is a plist used as a communication channel."
  (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
Rasmus's avatar
Rasmus committed
970 971 972 973
    (pcase (org-element-property :checkbox item)
      (`on (if utf8p "☑ " "[X] "))
      (`off (if utf8p "☐ " "[ ] "))
      (`trans (if utf8p "☒ " "[-] ")))))
Bastien Guerry's avatar
Bastien Guerry committed
974 975 976 977 978 979 980 981



;;; Template

(defun org-ascii-template--document-title (info)
  "Return document title, as a string.
INFO is a plist used as a communication channel."
Rasmus's avatar
Rasmus committed
982
  (let* ((text-width (plist-get info :ascii-text-width))
Bastien Guerry's avatar
Bastien Guerry committed
983 984
	 ;; Links in the title will not be resolved later, so we make
	 ;; sure their path is located right after them.
Rasmus's avatar
Rasmus committed
985 986 987 988 989 990
	 (info (org-combine-plists info '(:ascii-links-to-notes nil)))
	 (with-title (plist-get info :with-title))
	 (title (org-export-data
		 (when with-title (plist-get info :title)) info))
	 (subtitle (org-export-data
		    (when with-title (plist-get info :subtitle)) info))
Bastien Guerry's avatar
Bastien Guerry committed
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
	 (author (and (plist-get info :with-author)
		      (let ((auth (plist-get info :author)))
			(and auth (org-export-data auth info)))))
	 (email (and (plist-get info :with-email)
		     (org-export-data (plist-get info :email) info)))
	 (date (and (plist-get info :with-date)
		    (org-export-data (org-export-get-date info) info))))
    ;; There are two types of title blocks depending on the presence
    ;; of a title to display.
    (if (string= title "")
	;; Title block without a title.  DATE is positioned at the top
	;; right of the document, AUTHOR to the top left and EMAIL
	;; just below.
	(cond
	 ((and (org-string-nw-p date) (org-string-nw-p author))
	  (concat
	   author
Bastien Guerry's avatar
Bastien Guerry committed
1008 1009
	   (make-string (- text-width (string-width date) (string-width author))
			?\s)
Bastien Guerry's avatar
Bastien Guerry committed
1010 1011 1012 1013 1014 1015
	   date
	   (when (org-string-nw-p email) (concat "\n" email))
	   "\n\n\n"))
	 ((and (org-string-nw-p date) (org-string-nw-p email))
	  (concat
	   email
Bastien Guerry's avatar
Bastien Guerry committed
1016 1017
	   (make-string (- text-width (string-width date) (string-width email))
			?\s)
Bastien Guerry's avatar
Bastien Guerry committed
1018 1019 1020
	   date "\n\n\n"))
	 ((org-string-nw-p date)
	  (concat
Rasmus's avatar
Rasmus committed
1021
	   (org-ascii--justify-lines date text-width 'right)
Bastien Guerry's avatar
Bastien Guerry committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
	   "\n\n\n"))
	 ((and (org-string-nw-p author) (org-string-nw-p email))
	  (concat author "\n" email "\n\n\n"))
	 ((org-string-nw-p author) (concat author "\n\n\n"))
	 ((org-string-nw-p email) (concat email "\n\n\n")))
      ;; Title block with a title.  Document's TITLE, along with the
      ;; AUTHOR and its EMAIL are both overlined and an underlined,
      ;; centered.  Date is just below, also centered.
      (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
	     ;; Format TITLE.  It may be filled if it is too wide,
	     ;; that is wider than the two thirds of the total width.
Rasmus's avatar
Rasmus committed
1033 1034 1035 1036 1037
	     (title-len (min (apply #'max
				    (mapcar #'length
					    (org-split-string
					     (concat title "\n" subtitle) "\n")))
			     (/ (* 2 text-width) 3)))
Bastien Guerry's avatar
Bastien Guerry committed
1038
	     (formatted-title (org-ascii--fill-string title title-len info))
Rasmus's avatar
Rasmus committed
1039 1040
	     (formatted-subtitle (when (org-string-nw-p subtitle)
				   (org-ascii--fill-string subtitle title-len info)))
Bastien Guerry's avatar
Bastien Guerry committed
1041 1042
	     (line
	      (make-string
Bastien Guerry's avatar
Bastien Guerry committed
1043 1044 1045 1046
	       (min (+ (max title-len
			    (string-width (or author ""))
			    (string-width (or email "")))
		       2)
Bastien Guerry's avatar
Bastien Guerry committed
1047
		    text-width) (if utf8p ? ?_))))
Rasmus's avatar
Rasmus committed
1048
	(org-ascii--justify-lines
Bastien Guerry's avatar
Bastien Guerry committed
1049 1050 1051
	 (concat line "\n"
		 (unless utf8p "\n")
		 (upcase formatted-title)
Rasmus's avatar
Rasmus committed
1052
		 (and formatted-subtitle (concat "\n" formatted-subtitle))
Bastien Guerry's avatar
Bastien Guerry committed
1053 1054
		 (cond
		  ((and (org-string-nw-p author) (org-string-nw-p email))
Rasmus's avatar
Rasmus committed
1055 1056 1057
		   (concat "\n\n" author "\n" email))
		  ((org-string-nw-p author) (concat "\n\n" author))
		  ((org-string-nw-p email) (concat "\n\n" email)))
Bastien Guerry's avatar
Bastien Guerry committed
1058 1059 1060 1061 1062 1063 1064 1065 1066
		 "\n" line
		 (when (org-string-nw-p date) (concat "\n\n\n" date))
		 "\n\n\n") text-width 'center)))))

(defun org-ascii-inner-template (contents info)
  "Return complete document string after ASCII conversion.
CONTENTS is the transcoded contents string.  INFO is a plist
holding export options."
  (org-element-normalize-string
Rasmus's avatar
Rasmus committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
   (let ((global-margin (plist-get info :ascii-global-margin)))
     (org-ascii--indent-string
      (concat
       ;; 1. Document's body.
       contents
       ;; 2. Footnote definitions.
       (let ((definitions (org-export-collect-footnote-definitions info))
	     ;; Insert full links right inside the footnote definition
	     ;; as they have no chance to be inserted later.
	     (info (org-combine-plists info '(:ascii-links-to-notes nil))))
	 (when definitions
	   (concat
	    "\n\n\n"
	    (let ((title (org-ascii--translate "Footnotes" info)))
	      (concat
	       title "\n"
	       (make-string
		(string-width title)
		(if (eq (plist-get info :ascii-charset) 'utf-8) ? ?_))))
	    "\n\n"
	    (let ((text-width (- (plist-get info :ascii-text-width)
				 global-margin)))
	      (mapconcat
	       (lambda (ref)
		 (let ((id (format "[%s] " (car ref))))
		   ;; Distinguish between inline definitions and
		   ;; full-fledged definitions.
		   (org-trim
		    (let ((def (nth 2 ref)))
		      (if (org-element-map def org-element-all-elements
			    #'identity info 'first-match)
			  ;; Full-fledged definition: footnote ID is
			  ;; inserted inside the first parsed
			  ;; paragraph (FIRST), if any, to be sure
			  ;; filling will take it into consideration.
			  (let ((first (car (org-element-contents def))))
			    (if (not (eq (org-element-type first) 'paragraph))
				(concat id "\n" (org-export-data def info))
			      (push id (nthcdr 2 first))
			      (org-export-data def info)))
			;; Fill paragraph once footnote ID is inserted
			;; in order to have a correct length for first
			;; line.
			(org-ascii--fill-string
			 (concat id (org-export-data def info))
			 text-width info))))))
	       definitions "\n\n"))))))
      global-margin))))
Bastien Guerry's avatar
Bastien Guerry committed
1115 1116 1117 1118 1119

(defun org-ascii-template (contents info)
  "Return complete document string after ASCII conversion.
CONTENTS is the transcoded contents string.  INFO is a plist
holding export options."
Rasmus's avatar
Rasmus committed
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
  (let ((global-margin (plist-get info :ascii-global-margin)))
    (concat
     ;; Build title block.
     (org-ascii--indent-string
      (concat (org-ascii-template--document-title info)
	      ;; 2. Table of contents.
	      (let ((depth (plist-get info :with-toc)))
		(when depth
		  (concat
		   (org-ascii--build-toc info (and (wholenump depth) depth))
		   "\n\n\n"))))
      global-margin)
     ;; Document's body.
     contents
     ;; Creator.  Justify it to the bottom right.
     (and (plist-get info :with-creator)
	  (org-ascii--indent-string
	   (let ((text-width
		  (- (plist-get info :ascii-text-width) global-margin)))
	     (concat
	      "\n\n\n"
	      (org-ascii--fill-string
	       (plist-get info :creator) text-width info 'right)))
	   global-margin)))))
Bastien Guerry's avatar
Bastien Guerry committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156

(defun org-ascii--translate (s info)
  "Translate string S according to specified language and charset.
INFO is a plist used as a communication channel."
  (let ((charset (intern (format ":%s" (plist-get info :ascii-charset)))))
    (org-export-translate s charset info)))



;;; Transcode Functions

;;;; Bold

Rasmus's avatar
Rasmus committed
1157
(defun org-ascii-bold (_bold contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1158 1159 1160 1161 1162 1163 1164 1165
  "Transcode BOLD from Org to ASCII.
CONTENTS is the text with bold markup.  INFO is a plist holding
contextual information."
  (format "*%s*" contents))


;;;; Center Block

Rasmus's avatar
Rasmus committed
1166
(defun org-ascii-center-block (_center-block contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1167 1168 1169
  "Transcode a CENTER-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
Rasmus's avatar
Rasmus committed
1170 1171 1172
  ;; Center has already been taken care of at a lower level, so
  ;; there's nothing left to do.
  contents)
Bastien Guerry's avatar
Bastien Guerry committed
1173 1174 1175 1176


;;;; Clock

Rasmus's avatar
Rasmus committed
1177
(defun org-ascii-clock (clock _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1178 1179 1180
  "Transcode a CLOCK object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
Rasmus's avatar
Rasmus committed
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
  (org-ascii--justify-element
   (concat org-clock-string " "
	   (org-timestamp-translate (org-element-property :value clock))
	   (let ((time (org-element-property :duration clock)))
	     (and time
		  (concat " => "
			  (apply 'format
				 "%2s:%02s"
				 (org-split-string time ":"))))))
   clock info))
Bastien Guerry's avatar
Bastien Guerry committed
1191 1192 1193 1194


;;;; Code

Rasmus's avatar
Rasmus committed
1195
(defun org-ascii-code (code _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1196 1197 1198
  "Return a CODE object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
Rasmus's avatar
Rasmus committed
1199 1200
  (format (plist-get info :ascii-verbatim-format)
	  (org-element-property :value code)))
Bastien Guerry's avatar
Bastien Guerry committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210


;;;; Drawer

(defun org-ascii-drawer (drawer contents info)
  "Transcode a DRAWER element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
  (let ((name (org-element-property :drawer-name drawer))
	(width (org-ascii--current-text-width drawer info)))
Rasmus's avatar
Rasmus committed
1211 1212
    (funcall (plist-get info :ascii-format-drawer-function)
	     name contents width)))
Bastien Guerry's avatar
Bastien Guerry committed
1213 1214 1215 1216


;;;; Dynamic Block

Rasmus's avatar
Rasmus committed
1217
(defun org-ascii-dynamic-block (_dynamic-block contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1218 1219 1220 1221 1222 1223 1224 1225
  "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
  contents)


;;;; Entity

Rasmus's avatar
Rasmus committed
1226
(defun org-ascii-entity (entity _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
  "Transcode an ENTITY object from Org to ASCII.
CONTENTS are the definition itself.  INFO is a plist holding
contextual information."
  (org-element-property
   (intern (concat ":" (symbol-name (plist-get info :ascii-charset))))
   entity))


;;;; Example Block

Rasmus's avatar
Rasmus committed
1237
(defun org-ascii-example-block (example-block _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1238 1239
  "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
Rasmus's avatar
Rasmus committed
1240 1241 1242 1243
  (org-ascii--justify-element
   (org-ascii--box-string
    (org-export-format-code-default example-block info) info)
   example-block info))
Bastien Guerry's avatar
Bastien Guerry committed
1244 1245 1246 1247


;;;; Export Snippet

Rasmus's avatar
Rasmus committed
1248
(defun org-ascii-export-snippet (export-snippet _contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1249 1250 1251 1252 1253 1254 1255 1256
  "Transcode a EXPORT-SNIPPET object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
  (when (eq (org-export-snippet-backend export-snippet) 'ascii)
    (org-element-property :value export-snippet)))


;;;; Export Block

Rasmus's avatar
Rasmus committed
1257
(defun org-ascii-export-block (export-block _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1258 1259 1260
  "Transcode a EXPORT-BLOCK element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
  (when (string= (org-element-property :type export-block) "ASCII")
Rasmus's avatar
Rasmus committed
1261 1262
    (org-ascii--justify-element
     (org-element-property :value export-block) export-block info)))
Bastien Guerry's avatar
Bastien Guerry committed
1263 1264 1265 1266


;;;; Fixed Width

Rasmus's avatar
Rasmus committed
1267
(defun org-ascii-fixed-width (fixed-width _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1268 1269
  "Transcode a FIXED-WIDTH element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
Rasmus's avatar
Rasmus committed
1270 1271 1272 1273 1274
  (org-ascii--justify-element
   (org-ascii--box-string
    (org-remove-indentation
     (org-element-property :value fixed-width)) info)
   fixed-width info))
Bastien Guerry's avatar
Bastien Guerry committed
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284


;;;; Footnote Definition

;; Footnote Definitions are ignored.  They are compiled at the end of
;; the document, by `org-ascii-inner-template'.


;;;; Footnote Reference

Rasmus's avatar
Rasmus committed
1285
(defun org-ascii-footnote-reference (footnote-reference _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
  "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
  (format "[%s]" (org-export-get-footnote-number footnote-reference info)))


;;;; Headline

(defun org-ascii-headline (headline contents info)
  "Transcode a HEADLINE element from Org to ASCII.
CONTENTS holds the contents of the headline.  INFO is a plist
holding contextual information."
  ;; Don't export footnote section, which will be handled at the end
  ;; of the template.
  (unless (org-element-property :footnote-section-p headline)
Rasmus's avatar
Rasmus committed
1300
    (let* ((low-level (org-export-low-level-p headline info))
Bastien Guerry's avatar
Bastien Guerry committed
1301
	   (width (org-ascii--current-text-width headline info))
Rasmus's avatar
Rasmus committed
1302 1303 1304
	   ;; Export title early so that any link in it can be
	   ;; exported and seen in `org-ascii--unique-links'.
	   (title (org-ascii--build-title headline info width (not low-level)))
Bastien Guerry's avatar
Bastien Guerry committed
1305 1306 1307 1308
	   ;; Blank lines between headline and its contents.
	   ;; `org-ascii-headline-spacing', when set, overwrites
	   ;; original buffer's spacing.
	   (pre-blanks
Rasmus's avatar
Rasmus committed
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
	    (make-string (or (car (plist-get info :ascii-headline-spacing))
			     (org-element-property :pre-blank headline)
			     0)
			 ?\n))
	   (links (and (plist-get info :ascii-links-to-notes)
		       (org-ascii--describe-links
			(org-ascii--unique-links headline info) width info)))
	   ;; Re-build contents, inserting section links at the right
	   ;; place.  The cost is low since build results are cached.
	   (body
	    (if (not (org-string-nw-p links)) contents
	      (let* ((contents (org-element-contents headline))
		     (section (let ((first (car contents)))
				(and (eq (org-element-type first) 'section)
				     first))))
		(concat (and section
			     (concat (org-element-normalize-string
				      (org-export-data section info))
				     "\n\n"))
			links
			(mapconcat (lambda (e) (org-export-data e info))
				   (if section (cdr contents) contents)
				   ""))))))
Bastien Guerry's avatar
Bastien Guerry committed
1332
      ;; Deep subtree: export it as a list item.
Rasmus's avatar
Rasmus committed
1333 1334 1335 1336 1337 1338 1339 1340 1341
      (if low-level
	  (let* ((bullets (cdr (assq (plist-get info :ascii-charset)
				     (plist-get info :ascii-bullets))))
		 (bullet
		  (format "%c "
			  (nth (mod (1- low-level) (length bullets)) bullets))))
	    (concat bullet title "\n" pre-blanks
		    ;; Contents, indented by length of bullet.
		    (org-ascii--indent-string body (length bullet))))
Bastien Guerry's avatar
Bastien Guerry committed
1342
	;; Else: Standard headline.
Rasmus's avatar
Rasmus committed
1343
	(concat title "\n" pre-blanks body)))))
Bastien Guerry's avatar
Bastien Guerry committed
1344 1345 1346 1347


;;;; Horizontal Rule

Rasmus's avatar
Rasmus committed
1348
(defun org-ascii-horizontal-rule (horizontal-rule _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1349 1350 1351 1352 1353 1354
  "Transcode an HORIZONTAL-RULE object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (let ((text-width (org-ascii--current-text-width horizontal-rule info))
	(spec-width
	 (org-export-read-attribute :attr_ascii horizontal-rule :width)))
Rasmus's avatar
Rasmus committed
1355
    (org-ascii--justify-lines
Bastien Guerry's avatar
Bastien Guerry committed
1356 1357 1358 1359 1360 1361 1362 1363 1364
     (make-string (if (and spec-width (string-match "^[0-9]+$" spec-width))
		      (string-to-number spec-width)
		    text-width)
		  (if (eq (plist-get info :ascii-charset) 'utf-8) ? ?-))
     text-width 'center)))


;;;; Inline Src Block

Rasmus's avatar
Rasmus committed
1365
(defun org-ascii-inline-src-block (inline-src-block _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1366 1367 1368
  "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the item.  INFO is a plist holding
contextual information."
Rasmus's avatar
Rasmus committed
1369
  (format (plist-get info :ascii-verbatim-format)
Bastien Guerry's avatar
Bastien Guerry committed
1370 1371 1372 1373 1374
	  (org-element-property :value inline-src-block)))


;;;; Inlinetask

Bastien Guerry's avatar
Bastien Guerry committed
1375
(defun org-ascii-format-inlinetask-default
Rasmus's avatar
Rasmus committed
1376
  (_todo _type _priority _name _tags contents width inlinetask info)
Bastien Guerry's avatar
Bastien Guerry committed
1377 1378
  "Format an inline task element for ASCII export.
See `org-ascii-format-inlinetask-function' for a description
Paul Eggert's avatar
Paul Eggert committed
1379
of the parameters."
Bastien Guerry's avatar
Bastien Guerry committed
1380
  (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
Rasmus's avatar
Rasmus committed
1381
	 (width (or width (plist-get info :ascii-inlinetask-width))))
Bastien Guerry's avatar
Bastien Guerry committed
1382 1383 1384 1385 1386 1387 1388
    (org-ascii--indent-string
     (concat
      ;; Top line, with an additional blank line if not in UTF-8.
      (make-string width (if utf8p ? ?_)) "\n"
      (unless utf8p (concat (make-string width ? ) "\n"))
      ;; Add title.  Fill it if wider than inlinetask.
      (let ((title (org-ascii--build-title inlinetask info width)))
Bastien Guerry's avatar
Bastien Guerry committed
1389
	(if (<= (string-width title) width) title
Bastien Guerry's avatar
Bastien Guerry committed
1390 1391 1392 1393 1394 1395 1396 1397 1398
	  (org-ascii--fill-string title width info)))
      "\n"
      ;; If CONTENTS is not empty, insert it along with
      ;; a separator.
      (when (org-string-nw-p contents)
        (concat (make-string width (if utf8p ? ?-)) "\n" contents))
      ;; Bottom line.
      (make-string width (if utf8p ? ?_)))
     ;; Flush the inlinetask to the right.
Rasmus's avatar
Rasmus committed
1399
     (- (plist-get info :ascii-text-width) (plist-get info :ascii-global-margin)
Bastien Guerry's avatar
Bastien Guerry committed
1400
	(if (not (org-export-get-parent-headline inlinetask)) 0
Rasmus's avatar
Rasmus committed
1401
	  (plist-get info :ascii-inner-margin))
Bastien Guerry's avatar
Bastien Guerry committed
1402 1403
	(org-ascii--current-text-width inlinetask info)))))

Bastien Guerry's avatar
Bastien Guerry committed
1404 1405 1406 1407 1408
(defun org-ascii-inlinetask (inlinetask contents info)
  "Transcode an INLINETASK element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
  (let ((width (org-ascii--current-text-width inlinetask info)))
Rasmus's avatar
Rasmus committed
1409
    (funcall (plist-get info :ascii-format-inlinetask-function)
Bastien Guerry's avatar
Bastien Guerry committed
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
	     ;; todo.
	     (and (plist-get info :with-todo-keywords)
		  (let ((todo (org-element-property
			       :todo-keyword inlinetask)))
		    (and todo (org-export-data todo info))))
	     ;; todo-type
	     (org-element-property :todo-type inlinetask)
	     ;; priority
	     (and (plist-get info :with-priority)
		  (org-element-property :priority inlinetask))
	     ;; title
	     (org-export-data (org-element-property :title inlinetask) info)
	     ;; tags
	     (and (plist-get info :with-tags)
		  (org-element-property :tags inlinetask))
	     ;; contents and width
	     contents width inlinetask info)))
Bastien Guerry's avatar
Bastien Guerry committed
1427 1428 1429 1430


;;;; Italic

Rasmus's avatar
Rasmus committed
1431
(defun org-ascii-italic (_italic contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
  "Transcode italic from Org to ASCII.
CONTENTS is the text with italic markup.  INFO is a plist holding
contextual information."
  (format "/%s/" contents))


;;;; Item

(defun org-ascii-item (item contents info)
  "Transcode an ITEM element from Org to ASCII.
CONTENTS holds the contents of the item.  INFO is a plist holding
contextual information."
  (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
	 (checkbox (org-ascii--checkbox item info))
	 (list-type (org-element-property :type (org-export-get-parent item)))
	 (bullet
	  ;; First parent of ITEM is always the plain-list.  Get
	  ;; `:type' property from it.
Rasmus's avatar
Rasmus committed
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
	  (pcase list-type
	    (`descriptive
	     (concat checkbox
		     (org-export-data (org-element-property :tag item)
				      info)))
	    (`ordered
	     ;; Return correct number for ITEM, paying attention to
	     ;; counters.
	     (let* ((struct (org-element-property :structure item))
		    (bul (org-list-bullet-string
			  (org-element-property :bullet item)))
		    (num (number-to-string
			  (car (last (org-list-get-item-number
				      (org-element-property :begin item)
				      struct
				      (org-list-prevs-alist struct)
				      (org-list-parents-alist struct)))))))
	       (replace-regexp-in-string "[0-9]+" num bul)))
	    (_ (let ((bul (org-list-bullet-string
			   (org-element-property :bullet item))))
		 ;; Change bullets into more visible form if UTF-8 is active.
		 (if (not utf8p) bul
		   (replace-regexp-in-string
		    "-" "•"
Bastien Guerry's avatar
Bastien Guerry committed
1474
		    (replace-regexp-in-string
1475 1476
		     "\\+" "⁃"
		     (replace-regexp-in-string "\\*" "‣" bul))))))))
Rasmus's avatar
Rasmus committed
1477 1478
	 (indentation (if (eq list-type 'descriptive) org-ascii-quote-margin
			(string-width bullet))))
Bastien Guerry's avatar
Bastien Guerry committed
1479 1480
    (concat
     bullet
Rasmus's avatar
Rasmus committed
1481
     checkbox
Bastien Guerry's avatar
Bastien Guerry committed
1482 1483 1484
     ;; Contents: Pay attention to indentation.  Note: check-boxes are
     ;; already taken care of at the paragraph level so they don't
     ;; interfere with indentation.
Rasmus's avatar
Rasmus committed
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
     (let ((contents (org-ascii--indent-string contents indentation)))
       ;; Determine if contents should follow the bullet or start
       ;; a new line.  Do the former when the first contributing
       ;; element to contents is a paragraph.  In descriptive lists
       ;; however, contents always start a new line.
       (if (and (not (eq list-type 'descriptive))
		(org-string-nw-p contents)
		(eq 'paragraph
		    (org-element-type
		     (cl-some (lambda (e)
				(and (org-string-nw-p (org-export-data e info))
				     e))
			      (org-element-contents item)))))
Bastien Guerry's avatar
Bastien Guerry committed
1498 1499 1500 1501 1502 1503
	   (org-trim contents)
	 (concat "\n" contents))))))


;;;; Keyword

Rasmus's avatar
Rasmus committed
1504
(defun org-ascii-keyword (keyword _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1505 1506 1507 1508 1509 1510
  "Transcode a KEYWORD element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (let ((key (org-element-property :key keyword))
	(value (org-element-property :value keyword)))
    (cond
Rasmus's avatar
Rasmus committed
1511
     ((string= key "ASCII") (org-ascii--justify-element value keyword info))
Bastien Guerry's avatar
Bastien Guerry committed
1512
     ((string= key "TOC")
Rasmus's avatar
Rasmus committed
1513 1514 1515 1516 1517 1518
      (org-ascii--justify-element
       (let ((case-fold-search t))
	 (cond
	  ((string-match-p "\\<headlines\\>" value)
	   (let ((depth (and (string-match "\\<[0-9]+\\>" value)
			     (string-to-number (match-string 0 value))))
Bastien's avatar
Bastien committed
1519 1520 1521 1522 1523 1524 1525
		 (scope
		  (cond
		   ((string-match ":target +\\(\".+?\"\\|\\S-+\\)" value) ;link
		    (org-export-resolve-link
		     (org-strip-quotes (match-string 1 value)) info))
		   ((string-match-p "\\<local\\>" value) keyword)))) ;local
	     (org-ascii--build-toc info depth keyword scope)))
Rasmus's avatar
Rasmus committed
1526 1527 1528 1529 1530
	  ((string-match-p "\\<tables\\>" value)
	   (org-ascii--list-tables keyword info))
	  ((string-match-p "\\<listings\\>" value)
	   (org-ascii--list-listings keyword info))))
       keyword info)))))
Bastien Guerry's avatar
Bastien Guerry committed
1531 1532 1533 1534


;;;; Latex Environment

Rasmus's avatar
Rasmus committed
1535
(defun org-ascii-latex-environment (latex-environment _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1536 1537 1538 1539
  "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (when (plist-get info :with-latex)
Rasmus's avatar
Rasmus committed
1540 1541 1542
    (org-ascii--justify-element
     (org-remove-indentation (org-element-property :value latex-environment))
     latex-environment info)))
Bastien Guerry's avatar
Bastien Guerry committed
1543 1544 1545 1546


;;;; Latex Fragment

Rasmus's avatar
Rasmus committed
1547
(defun org-ascii-latex-fragment (latex-fragment _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1548 1549 1550 1551 1552 1553 1554 1555 1556
  "Transcode a LATEX-FRAGMENT object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (when (plist-get info :with-latex)
    (org-element-property :value latex-fragment)))


;;;; Line Break

Rasmus's avatar
Rasmus committed
1557
(defun org-ascii-line-break (_line-break _contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
  "Transcode a LINE-BREAK object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
  information."  hard-newline)


;;;; Link

(defun org-ascii-link (link desc info)
  "Transcode a LINK object from Org to ASCII.

DESC is the description part of the link, or the empty string.
INFO is a plist holding contextual information."
Rasmus's avatar
Rasmus committed
1570
  (let ((type (org-element-property :type link)))
Bastien Guerry's avatar
Bastien Guerry committed
1571
    (cond
Rasmus's avatar
Rasmus committed
1572
     ((org-export-custom-protocol-maybe link desc 'ascii))
Bastien Guerry's avatar
Bastien Guerry committed
1573 1574 1575 1576 1577 1578
     ((string= type "coderef")
      (let ((ref (org-element-property :path link)))
	(format (org-export-get-coderef-format ref desc)
		(org-export-resolve-coderef ref info))))
     ;; Do not apply a special syntax on radio links.  Though, use
     ;; transcoded target's contents as output.
Bastien Guerry's avatar
Bastien Guerry committed
1579
     ((string= type "radio") desc)
Rasmus's avatar
Rasmus committed
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
     ((member type '("custom-id" "fuzzy" "id"))
      (let ((destination (if (string= type "fuzzy")
			     (org-export-resolve-fuzzy-link link info)
			   (org-export-resolve-id-link link info))))
	(pcase (org-element-type destination)
	  ((guard desc)
	   (if (plist-get info :ascii-links-to-notes)
	       (format "[%s]" desc)
	     (concat desc
		     (format " (%s)"
			     (org-ascii--describe-datum destination info)))))
	  ;; External file.
	  (`plain-text destination)
	  (`headline
	   (if (org-export-numbered-headline-p destination info)
	       (mapconcat #'number-to-string
			  (org-export-get-headline-number destination info)
			  ".")
	     (org-export-data (org-element-property :title destination) info)))
	  ;; Handle enumerable elements and targets within them.
	  ((and (let number (org-export-get-ordinal
			     destination info nil #'org-ascii--has-caption-p))
		(guard number))
	   (if (atom number) (number-to-string number)
	     (mapconcat #'number-to-string number ".")))
	  ;; Don't know what to do.  Signal it.
	  (_ "???"))))
Bastien Guerry's avatar
Bastien Guerry committed
1607
     (t
Bastien's avatar
Bastien committed
1608 1609 1610 1611
      (let ((raw-link (concat (org-element-property :type link)
			      ":"
			      (org-element-property :path link))))
	(if (not (org-string-nw-p desc)) (format "<%s>" raw-link)
Rasmus's avatar
Rasmus committed
1612 1613
	  (concat (format "[%s]" desc)
		  (and (not (plist-get info :ascii-links-to-notes))
Bastien's avatar
Bastien committed
1614
		       (format " (<%s>)" raw-link)))))))))
Rasmus's avatar
Rasmus committed
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626


;;;; Node Properties

(defun org-ascii-node-property (node-property _contents _info)
  "Transcode a NODE-PROPERTY element from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (format "%s:%s"
          (org-element-property :key node-property)
          (let ((value (org-element-property :value node-property)))
            (if value (concat " " value) ""))))
Bastien Guerry's avatar
Bastien Guerry committed
1627 1628 1629 1630 1631 1632 1633 1634


;;;; Paragraph

(defun org-ascii-paragraph (paragraph contents info)
  "Transcode a PARAGRAPH element from Org to ASCII.
CONTENTS is the contents of the paragraph, as a string.  INFO is
the plist used as a communication channel."
Rasmus's avatar
Rasmus committed
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
  (org-ascii--justify-element
   (let ((indented-line-width (plist-get info :ascii-indented-line-width)))
     (if (not (wholenump indented-line-width)) contents
       (concat
	;; Do not indent first paragraph in a section.
	(unless (and (not (org-export-get-previous-element paragraph info))
		     (eq (org-element-type (org-export-get-parent paragraph))
			 'section))
	  (make-string indented-line-width ?\s))
	(replace-regexp-in-string "\\`[ \t]+" "" contents))))
   paragraph info))
Bastien Guerry's avatar
Bastien Guerry committed
1646 1647 1648 1649 1650 1651 1652 1653


;;;; Plain List

(defun org-ascii-plain-list (plain-list contents info)
  "Transcode a PLAIN-LIST element from Org to ASCII.
CONTENTS is the contents of the list.  INFO is a plist holding
contextual information."
Rasmus's avatar
Rasmus committed
1654 1655 1656 1657 1658
  (let ((margin (plist-get info :ascii-list-margin)))
    (if (or (< margin 1)
	    (eq (org-element-type (org-export-get-parent plain-list)) 'item))
	contents
      (org-ascii--indent-string contents margin))))
Bastien Guerry's avatar
Bastien Guerry committed
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681


;;;; Plain Text

(defun org-ascii-plain-text (text info)
  "Transcode a TEXT string from Org to ASCII.
INFO is a plist used as a communication channel."
  (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
    (when (and utf8p (plist-get info :with-smart-quotes))
      (setq text (org-export-activate-smart-quotes text :utf-8 info)))
    (if (not (plist-get info :with-special-strings)) text
      (setq text (replace-regexp-in-string "\\\\-" "" text))
      (if (not utf8p) text
	;; Usual replacements in utf-8 with proper option set.
	(replace-regexp-in-string
	 "\\.\\.\\." "…"
	 (replace-regexp-in-string
	  "--" "–"
	  (replace-regexp-in-string "---" "—" text)))))))


;;;; Planning

Rasmus's avatar
Rasmus committed
1682
(defun org-ascii-planning (planning _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1683 1684 1685
  "Transcode a PLANNING element from Org to ASCII.
CONTENTS is nil.  INFO is a plist used as a communication
channel."
Rasmus's avatar
Rasmus committed
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
  (org-ascii--justify-element
   (mapconcat
    #'identity
    (delq nil
	  (list (let ((closed (org-element-property :closed planning)))
		  (when closed
		    (concat org-closed-string " "
			    (org-timestamp-translate closed))))
		(let ((deadline (org-element-property :deadline planning)))
		  (when deadline
		    (concat org-deadline-string " "
			    (org-timestamp-translate deadline))))
		(let ((scheduled (org-element-property :scheduled planning)))
		  (when scheduled
		    (concat org-scheduled-string " "
			    (org-timestamp-translate scheduled))))))
    " ")
   planning info))


;;;; Property Drawer

(defun org-ascii-property-drawer (property-drawer contents info)
  "Transcode a PROPERTY-DRAWER element from Org to ASCII.
CONTENTS holds the contents of the drawer.  INFO is a plist
holding contextual information."
  (and (org-string-nw-p contents)
       (org-ascii--justify-element contents property-drawer info)))
Bastien Guerry's avatar
Bastien Guerry committed
1714 1715 1716 1717


;;;; Quote Block

Rasmus's avatar
Rasmus committed
1718
(defun org-ascii-quote-block (_quote-block contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1719 1720 1721
  "Transcode a QUOTE-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
Rasmus's avatar
Rasmus committed
1722
  (org-ascii--indent-string contents (plist-get info :ascii-quote-margin)))
Bastien Guerry's avatar
Bastien Guerry committed
1723 1724 1725 1726


;;;; Radio Target

Rasmus's avatar
Rasmus committed
1727
(defun org-ascii-radio-target (_radio-target contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
  "Transcode a RADIO-TARGET object from Org to ASCII.
CONTENTS is the contents of the target.  INFO is a plist holding
contextual information."
  contents)


;;;; Section

(defun org-ascii-section (section contents info)
  "Transcode a SECTION element from Org to ASCII.
CONTENTS is the contents of the section.  INFO is a plist holding
contextual information."
Rasmus's avatar
Rasmus committed
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
  (let ((links
	 (and (plist-get info :ascii-links-to-notes)
	      ;; Take care of links in first section of the document.
	      (not (org-element-lineage section '(headline)))
	      (org-ascii--describe-links
	       (org-ascii--unique-links section info)
	       (org-ascii--current-text-width section info)
	       info))))
    (org-ascii--indent-string
     (if (not (org-string-nw-p links)) contents
       (concat (org-element-normalize-string contents) "\n\n" links))
     ;; Do not apply inner margin if parent headline is low level.
     (let ((headline (org-export-get-parent-headline section)))
       (if (or (not headline) (org-export-low-level-p headline info)) 0
	 (plist-get info :ascii-inner-margin))))))
Bastien Guerry's avatar
Bastien Guerry committed
1755 1756 1757 1758


;;;; Special Block

Rasmus's avatar
Rasmus committed
1759
(defun org-ascii-special-block (_special-block contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1760 1761 1762
  "Transcode a SPECIAL-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
Paul Eggert's avatar
Paul Eggert committed
1763
  ;; "JUSTIFYLEFT" and "JUSTIFYRIGHT" have already been taken care of
Rasmus's avatar
Rasmus committed
1764 1765
  ;; at a lower level.  There is no other special block type to
  ;; handle.
Bastien Guerry's avatar
Bastien Guerry committed
1766 1767 1768 1769 1770
  contents)


;;;; Src Block

Rasmus's avatar
Rasmus committed
1771
(defun org-ascii-src-block (src-block _contents info)
Bastien Guerry's avatar
Bastien Guerry committed
1772 1773 1774 1775
  "Transcode a SRC-BLOCK element from Org to ASCII.
CONTENTS holds the contents of the item.  INFO is a plist holding
contextual information."
  (let ((caption (org-ascii--build-caption src-block info))
Rasmus's avatar
Rasmus committed
1776
	(caption-above-p (plist-get info :ascii-caption-above))
Bastien Guerry's avatar
Bastien Guerry committed
1777 1778
	(code (org-export-format-code-default src-block info)))
    (if (equal code "") ""
Rasmus's avatar
Rasmus committed
1779 1780 1781 1782 1783 1784
      (org-ascii--justify-element
       (concat
	(and caption caption-above-p (concat caption "\n"))
	(org-ascii--box-string code info)
	(and caption (not caption-above-p) (concat "\n" caption)))
       src-block info))))
Bastien Guerry's avatar
Bastien Guerry committed
1785 1786 1787 1788


;;;; Statistics Cookie

Rasmus's avatar
Rasmus committed
1789
(defun org-ascii-statistics-cookie (statistics-cookie _contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1790 1791 1792 1793 1794 1795 1796
  "Transcode a STATISTICS-COOKIE object from Org to ASCII.
CONTENTS is nil.  INFO is a plist holding contextual information."
  (org-element-property :value statistics-cookie))


;;;; Subscript

Rasmus's avatar
Rasmus committed
1797
(defun org-ascii-subscript (subscript contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
  "Transcode a SUBSCRIPT object from Org to ASCII.
CONTENTS is the contents of the object.  INFO is a plist holding
contextual information."
  (if (org-element-property :use-brackets-p subscript)
      (format "_{%s}" contents)
    (format "_%s" contents)))


;;;; Superscript

Rasmus's avatar
Rasmus committed
1808
(defun org-ascii-superscript (superscript contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1809 1810 1811 1812
  "Transcode a SUPERSCRIPT object from Org to ASCII.
CONTENTS is the contents of the object.  INFO is a plist holding
contextual information."
  (if (org-element-property :use-brackets-p superscript)
Bastien Guerry's avatar
Bastien Guerry committed
1813 1814
      (format "^{%s}" contents)
    (format "^%s" contents)))
Bastien Guerry's avatar
Bastien Guerry committed
1815 1816 1817 1818


;;;; Strike-through

Rasmus's avatar
Rasmus committed
1819
(defun org-ascii-strike-through (_strike-through contents _info)
Bastien Guerry's avatar
Bastien Guerry committed
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
  "Transcode STRIKE-THROUGH from Org to ASCII.
CONTENTS is text with strike-through markup.  INFO is a plist
holding contextual information."
  (format "+%s+" contents))


;;;; Table

(defun org-ascii-table (table contents info)
  "Transcode a TABLE element from Org to ASCII.
CONTENTS is the contents of the table.  INFO is a plist holding
contextual information."