1 ;;; org-lparse.el --- Line-oriented parser-exporter for Org-mode
3 ;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; `org-lparse' is the entry point for the generic line-oriented
27 ;; exporter. `org-do-lparse' is the genericized version of the
28 ;; original `org-export-as-html' routine.
30 ;; `org-lparse-native-backends' is a good starting point for
31 ;; exploring the generic exporter.
33 ;; Following new interactive commands are provided by this library.
34 ;; `org-lparse', `org-lparse-and-open', `org-lparse-to-buffer'
35 ;; `org-replace-region-by', `org-lparse-region'.
37 ;; Note that the above routines correspond to the following routines
38 ;; in the html exporter `org-export-as-html',
39 ;; `org-export-as-html-and-open', `org-export-as-html-to-buffer',
40 ;; `org-replace-region-by-html' and `org-export-region-as-html'.
42 ;; The new interactive command `org-lparse-convert' can be used to
43 ;; convert documents between various formats. Use this to command,
44 ;; for example, to convert odt file to doc or pdf format.
51 (require 'format-spec
)
54 (defun org-lparse-and-open (target-backend native-backend arg
55 &optional file-or-buf
)
56 "Export outline to TARGET-BACKEND via NATIVE-BACKEND and open exported file.
57 If there is an active region, export only the region. The prefix
58 ARG specifies how many levels of the outline should become
59 headlines. The default is 3. Lower levels will become bulleted
61 (let (f (file-or-buf (or file-or-buf
62 (org-lparse target-backend native-backend
66 ((bufferp file-or-buf
) buffer-file-name
)
67 ((file-exists-p file-or-buf
) file-or-buf
)
68 (t (error "org-lparse-and-open: This shouldn't happen"))))
69 (message "Opening file %s" f
)
71 (when org-export-kill-product-buffer-when-displayed
72 (kill-buffer (current-buffer))))))
75 (defun org-lparse-batch (target-backend &optional native-backend
)
76 "Call the function `org-lparse'.
77 This function can be used in batch processing as:
79 --load=$HOME/lib/emacs/org.el
80 --eval \"(setq org-export-headline-levels 2)\"
81 --visit=MyFile --funcall org-lparse-batch"
82 (setq native-backend
(or native-backend target-backend
))
83 (org-lparse target-backend native-backend
84 org-export-headline-levels
'hidden
))
87 (defun org-lparse-to-buffer (backend arg
)
88 "Call `org-lparse' with output to a temporary buffer.
89 No file is created. The prefix ARG is passed through to
91 (let ((tempbuf (format "*Org %s Export*" (upcase backend
))))
92 (org-lparse backend backend arg nil nil tempbuf
)
93 (when org-export-show-temporary-export-buffer
94 (switch-to-buffer-other-window tempbuf
))))
97 (defun org-replace-region-by (backend beg end
)
98 "Assume the current region has org-mode syntax, and convert it to HTML.
99 This can be used in any buffer. For example, you could write an
100 itemized list in org-mode syntax in an HTML buffer and then use
101 this command to convert it."
102 (let (reg backend-string buf pop-up-frames
)
103 (save-window-excursion
104 (if (eq major-mode
'org-mode
)
105 (setq backend-string
(org-lparse-region backend beg end t
'string
))
106 (setq reg
(buffer-substring beg end
)
107 buf
(get-buffer-create "*Org tmp*"))
108 (with-current-buffer buf
112 (setq backend-string
(org-lparse-region backend
(point-min)
113 (point-max) t
'string
)))
115 (delete-region beg end
)
116 (insert backend-string
)))
119 (defun org-lparse-region (backend beg end
&optional body-only buffer
)
120 "Convert region from BEG to END in org-mode buffer to HTML.
121 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
122 contents, and only produce the region of converted text, useful for
123 cut-and-paste operations.
124 If BUFFER is a buffer or a string, use/create that buffer as a target
125 of the converted HTML. If BUFFER is the symbol `string', return the
126 produced HTML as a string and leave not buffer behind. For example,
127 a Lisp program could call this function in the following way:
129 (setq html (org-lparse-region \"html\" beg end t 'string))
131 When called interactively, the output buffer is selected, and shown
132 in a window. A non-interactive call will only return the buffer."
133 (let ((transient-mark-mode t
) (zmacs-regions t
)
135 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
137 (set-mark (point)) ;; to activate the region
139 (setq rtn
(org-lparse backend backend nil nil ext-plist buffer body-only
))
140 (if (fboundp 'deactivate-mark
) (deactivate-mark))
141 (if (and (org-called-interactively-p 'any
) (bufferp rtn
))
142 (switch-to-buffer-other-window rtn
)
145 (defvar org-lparse-par-open nil
)
147 (defun org-lparse-should-inline-p (filename descp
)
148 "Return non-nil if link FILENAME should be inlined.
149 The decision to inline the FILENAME link is based on the current
150 settings. DESCP is the boolean of whether there was a link
151 description. See variables `org-export-html-inline-images' and
152 `org-export-html-inline-image-extensions'."
153 (let ((inline-images (org-lparse-get 'INLINE-IMAGES
))
154 (inline-image-extensions
155 (org-lparse-get 'INLINE-IMAGE-EXTENSIONS
)))
156 (and (or (eq t inline-images
) (and inline-images
(not descp
)))
157 (org-file-image-p filename inline-image-extensions
))))
159 (defun org-lparse-format-org-link (line opt-plist
)
160 "Return LINE with markup of Org mode links.
161 OPT-PLIST is the export options list."
163 (current-dir (if buffer-file-name
164 (file-name-directory buffer-file-name
)
166 (link-validate (plist-get opt-plist
:link-validation-function
))
168 rpl path attr desc descp desc1 desc2 link
169 org-lparse-link-description-is-image
)
170 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
171 (setq org-lparse-link-description-is-image nil
)
172 (setq start
(match-beginning 0))
173 (setq path
(save-match-data (org-link-unescape
174 (match-string 3 line
))))
176 ((match-end 2) (match-string 2 line
))
178 (or (file-name-absolute-p path
)
179 (string-match "^\\.\\.?/" path
)))
182 (setq path
(org-extract-attributes path
))
183 (setq attr
(get-text-property 0 'org-attributes path
))
184 (setq desc1
(if (match-end 5) (match-string 5 line
))
185 desc2
(if (match-end 2) (concat type
":" path
) path
)
186 descp
(and desc1
(not (equal desc1 desc2
)))
187 desc
(or desc1 desc2
))
188 ;; Make an image out of the description if that is so wanted
189 (when (and descp
(org-file-image-p
190 desc
(org-lparse-get 'INLINE-IMAGE-EXTENSIONS
)))
191 (setq org-lparse-link-description-is-image t
)
193 (if (string-match "^file:" desc
)
194 (setq desc
(substring desc
(match-end 0)))))
196 (setq desc
(org-add-props
197 (org-lparse-format 'INLINE-IMAGE desc
)
198 '(org-protected t
)))))
200 ((equal type
"internal")
203 (if (= (string-to-char path
) ?
#)
208 'ORG-LINK opt-plist
"" "" (org-solidify-link-text
210 (org-link-unescape frag-0
))
211 nil
) desc attr descp
))))
212 ((and (equal type
"id")
213 (setq id-file
(org-id-find-id-file path
)))
214 ;; This is an id: link to another file (if it was the same file,
215 ;; it would have become an internal link...)
217 (setq id-file
(file-relative-name
219 (file-name-directory org-current-export-file
)))
222 'ORG-LINK opt-plist type id-file
223 (concat (if (org-uuidgen-p path
) "ID-") path
)
225 ((member type
'("http" "https"))
226 ;; standard URL, can inline as image
229 'ORG-LINK opt-plist type path nil desc attr descp
)))
230 ((member type
'("ftp" "mailto" "news"))
231 ;; standard URL, can't inline as image
234 'ORG-LINK opt-plist type path nil desc attr descp
)))
236 ((string= type
"coderef")
237 (setq rpl
(org-lparse-format
238 'ORG-LINK opt-plist type
"" path desc nil descp
)))
240 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
241 ;; The link protocol has a function for format the link
242 (setq rpl
(save-match-data
243 (funcall fnc
(org-link-unescape path
)
244 desc1
(and (boundp 'org-lparse-backend
)
245 (case org-lparse-backend
247 (t org-lparse-backend
)))))))
248 ((string= type
"file")
254 (string-match "::\\(.*\\)" path
)
256 (replace-match "" t nil path
)
257 (match-string 1 path
))
260 ;;The proper path, without a fragment
268 ;;Check the fragment. If it can't be used as
269 ;;target fragment we'll pass nil instead.
273 (not (string-match "^[0-9]*$" fragment-0
))
274 (not (string-match "^\\*" fragment-0
))
275 (not (string-match "^/.*/$" fragment-0
)))
276 (org-solidify-link-text
277 (org-link-unescape fragment-0
))
280 ;;Description minus "file:" and ".org"
281 (if (string-match "^file:" desc
)
283 ((desc-1 (replace-match "" t t desc
)))
284 (if (string-match "\\.org$" desc-1
)
285 (replace-match "" t t desc-1
)
292 (functionp link-validate
)
293 (not (funcall link-validate path-1 current-dir
)))
296 'ORG-LINK opt-plist
"file" path-1 fragment-1
297 desc-2 attr descp
))))))
300 ;; just publish the path, as default
301 (setq rpl
(concat "<i><" type
":"
302 (save-match-data (org-link-unescape path
))
304 (setq line
(replace-match rpl t t line
)
305 start
(+ start
(length rpl
))))
308 (defvar org-lparse-par-open-stashed
) ; bound during `org-do-lparse'
309 (defun org-lparse-stash-save-paragraph-state ()
310 (assert (zerop org-lparse-par-open-stashed
))
311 (setq org-lparse-par-open-stashed org-lparse-par-open
)
312 (setq org-lparse-par-open nil
))
314 (defun org-lparse-stash-pop-paragraph-state ()
315 (setq org-lparse-par-open org-lparse-par-open-stashed
)
316 (setq org-lparse-par-open-stashed
0))
318 (defmacro with-org-lparse-preserve-paragraph-state
(&rest body
)
319 `(let ((org-lparse-do-open-par org-lparse-par-open
))
320 (org-lparse-end-paragraph)
322 (when org-lparse-do-open-par
323 (org-lparse-begin-paragraph))))
324 (def-edebug-spec with-org-lparse-preserve-paragraph-state
(body))
326 (defvar org-lparse-native-backends nil
327 "List of native backends registered with `org-lparse'.
328 A backend can use `org-lparse-register-backend' to add itself to
331 All native backends must implement a get routine and a mandatory
332 set of callback routines.
334 The get routine must be named as org-<backend>-get where backend
335 is the name of the backend. The exporter uses `org-lparse-get'
336 and retrieves the backend-specific callback by querying for
337 ENTITY-CONTROL and ENTITY-FORMAT variables.
339 For the sake of illustration, the html backend implements
340 `org-xhtml-get'. It returns
341 `org-xhtml-entity-control-callbacks-alist' and
342 `org-xhtml-entity-format-callbacks-alist' as the values of
343 ENTITY-CONTROL and ENTITY-FORMAT settings.")
345 (defun org-lparse-register-backend (backend)
346 "Make BACKEND known to `org-lparse' library.
347 Add BACKEND to `org-lparse-native-backends'."
350 ((symbolp backend
) (symbol-name backend
))
351 ((stringp backend
) backend
)
352 (t (error "Error while registering backend: %S" backend
))))
353 (add-to-list 'org-lparse-native-backends backend
)))
355 (defun org-lparse-unregister-backend (backend)
356 (setq org-lparse-native-backends
358 ((symbolp backend
) (symbol-name backend
))
359 ((stringp backend
) backend
))
360 org-lparse-native-backends
))
361 (message "Unregistered backend %S" backend
))
363 (defun org-lparse-do-reachable-formats (in-fmt)
364 "Return verbose info about formats to which IN-FMT can be converted.
365 Return a list where each element is of the
366 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
367 `org-export-odt-convert-processes' for CONVERTER-PROCESS and see
368 `org-export-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
369 (let (reachable-formats)
370 (dolist (backend org-lparse-native-backends reachable-formats
)
371 (let* ((converter (org-lparse-backend-get
372 backend
'CONVERT-METHOD
))
373 (capabilities (org-lparse-backend-get
374 backend
'CONVERT-CAPABILITIES
)))
376 (dolist (c capabilities
)
377 (when (member in-fmt
(nth 1 c
))
378 (push (cons converter
(nth 2 c
)) reachable-formats
))))))))
380 (defun org-lparse-reachable-formats (in-fmt)
381 "Return list of formats to which IN-FMT can be converted.
382 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
384 (mapc (lambda (e) (add-to-list 'l e
))
385 (apply 'append
(mapcar
386 (lambda (e) (mapcar 'car
(cdr e
)))
387 (org-lparse-do-reachable-formats in-fmt
))))
390 (defun org-lparse-reachable-p (in-fmt out-fmt
)
391 "Return non-nil if IN-FMT can be converted to OUT-FMT."
393 (let ((reachable-formats (org-lparse-do-reachable-formats in-fmt
)))
394 (dolist (e reachable-formats
)
395 (let ((out-fmt-spec (assoc out-fmt
(cdr e
))))
397 (throw 'done
(cons (car e
) out-fmt-spec
))))))))
399 (defun org-lparse-backend-is-native-p (backend)
400 (member backend org-lparse-native-backends
))
402 (defun org-lparse (target-backend native-backend arg
403 &optional hidden ext-plist
404 to-buffer body-only pub-dir
)
405 "Export the outline to various formats.
406 If there is an active region, export only the region. The
407 outline is first exported to NATIVE-BACKEND and optionally
408 converted to TARGET-BACKEND. See `org-lparse-native-backends'
409 for list of known native backends. Each native backend can
410 specify a converter and list of target backends it exports to
411 using the CONVERT-PROCESS and OTHER-BACKENDS settings of it's get
412 method. See `org-xhtml-get' for an illustrative example.
414 ARG is a prefix argument that specifies how many levels of
415 outline should become headlines. The default is 3. Lower levels
416 will become bulleted lists.
418 HIDDEN is obsolete and does nothing.
420 EXT-PLIST is a property list that controls various aspects of
421 export. The settings here override org-mode's default settings
422 and but are inferior to file-local settings.
424 TO-BUFFER dumps the exported lines to a buffer or a string
425 instead of a file. If TO-BUFFER is the symbol `string' return the
426 exported lines as a string. If TO-BUFFER is non-nil, create a
427 buffer with that name and export to that buffer.
429 BODY-ONLY controls the presence of header and footer lines in
430 exported text. If BODY-ONLY is non-nil, don't produce the file
431 header and footer, simply return the content of <body>...</body>,
432 without even the body tags themselves.
434 PUB-DIR specifies the publishing directory."
435 (let* ((org-lparse-backend (intern native-backend
))
436 (org-lparse-other-backend (and target-backend
437 (intern target-backend
))))
438 (unless (org-lparse-backend-is-native-p native-backend
)
439 (error "Don't know how to export natively to backend %s" native-backend
))
441 (unless (or (equal native-backend target-backend
)
442 (org-lparse-reachable-p native-backend target-backend
))
443 (error "Don't know how to export to backend %s %s" target-backend
444 (format "via %s" native-backend
)))
445 (run-hooks 'org-export-first-hook
)
446 (org-do-lparse arg hidden ext-plist to-buffer body-only pub-dir
)))
448 (defcustom org-lparse-use-flashy-warning nil
449 "Control flashing of messages logged with `org-lparse-warn'.
450 When non-nil, messages are fontified with warning face and the
451 exporter lingers for a while to catch user's attention."
455 (defun org-lparse-convert-read-params ()
456 "Return IN-FILE and OUT-FMT params for `org-lparse-do-convert'.
457 This is a helper routine for interactive use."
458 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
459 (in-file (read-file-name "File to be converted: "
460 nil buffer-file-name t
))
461 (in-fmt (file-name-extension in-file
))
462 (out-fmt-choices (org-lparse-reachable-formats in-fmt
))
464 (or (and out-fmt-choices
465 (funcall input
"Output format: "
466 out-fmt-choices nil nil nil
))
468 "No known converter or no known output formats for %s files"
470 (list in-file out-fmt
)))
473 (require 'browse-url
))
475 (defun org-lparse-do-convert (in-file out-fmt
&optional prefix-arg
)
476 "Workhorse routine for `org-export-odt-convert'."
477 (require 'browse-url
)
478 (let* ((in-file (expand-file-name (or in-file buffer-file-name
)))
479 (dummy (or (file-readable-p in-file
)
480 (error "Cannot read %s" in-file
)))
481 (in-fmt (file-name-extension in-file
))
482 (out-fmt (or out-fmt
(error "Output format unspecified")))
483 (how (or (org-lparse-reachable-p in-fmt out-fmt
)
484 (error "Cannot convert from %s format to %s format?"
486 (convert-process (car how
))
487 (out-file (concat (file-name-sans-extension in-file
) "."
488 (nth 1 (or (cdr how
) out-fmt
))))
489 (extra-options (or (nth 2 (cdr how
)) ""))
490 (out-dir (file-name-directory in-file
))
491 (cmd (format-spec convert-process
492 `((?i .
,(shell-quote-argument in-file
))
493 (?I .
,(browse-url-file-url in-file
))
496 (?O .
,(browse-url-file-url out-file
))
497 (?d .
, (shell-quote-argument out-dir
))
498 (?D .
,(browse-url-file-url out-dir
))
499 (?x .
,extra-options
)))))
500 (when (file-exists-p out-file
)
501 (delete-file out-file
))
503 (message "Executing %s" cmd
)
504 (let ((cmd-output (shell-command-to-string cmd
)))
505 (message "%s" cmd-output
))
508 ((file-exists-p out-file
)
509 (message "Exported to %s" out-file
)
511 (message "Opening %s..." out-file
)
512 (org-open-file out-file
))
515 (message "Export to %s failed" out-file
)
518 (defvar org-lparse-insert-tag-with-newlines
'both
)
520 ;; Following variables are let-bound during `org-lparse'
521 (defvar org-lparse-dyn-first-heading-pos
)
522 (defvar org-lparse-toc
)
523 (defvar org-lparse-entity-control-callbacks-alist
)
524 (defvar org-lparse-entity-format-callbacks-alist
)
525 (defvar org-lparse-backend nil
526 "The native backend to which the document is currently exported.
527 This variable is let bound during `org-lparse'. Valid values are
528 one of the symbols corresponding to `org-lparse-native-backends'.
530 Compare this variable with `org-export-current-backend' which is
531 bound only during `org-export-preprocess-string' stage of the
534 See also `org-lparse-other-backend'.")
536 (defvar org-lparse-other-backend nil
537 "The target backend to which the document is currently exported.
538 This variable is let bound during `org-lparse'. This variable is
539 set to either `org-lparse-backend' or one of the symbols
540 corresponding to OTHER-BACKENDS specification of the
543 For example, if a document is exported to \"odt\" then both
544 org-lparse-backend and org-lparse-other-backend are bound to
545 'odt. On the other hand, if a document is exported to \"odt\"
546 and then converted to \"doc\" then org-lparse-backend is set to
547 'odt and org-lparse-other-backend is set to 'doc.")
549 (defvar org-lparse-body-only nil
550 "Bind this to BODY-ONLY arg of `org-lparse'.")
552 (defvar org-lparse-to-buffer nil
553 "Bind this to TO-BUFFER arg of `org-lparse'.")
555 (defun org-lparse-get-block-params (params)
558 (setq params
(org-trim params
))
559 (unless (string-match "\\`(.*)\\'" params
)
560 (setq params
(format "(%s)" params
)))
561 (ignore-errors (read params
)))))
563 (defvar org-heading-keyword-regexp-format
) ; defined in org.el
564 (defvar org-lparse-special-blocks
'("list-table" "annotation"))
565 (defun org-do-lparse (arg &optional hidden ext-plist
566 to-buffer body-only pub-dir
)
567 "Export the outline to various formats.
568 See `org-lparse' for more information. This function is a
569 html-agnostic version of the `org-export-as-html' function in 7.5
571 ;; Make sure we have a file name when we need it.
572 (when (and (not (or to-buffer body-only
))
573 (not buffer-file-name
))
574 (if (buffer-base-buffer)
575 (org-set-local 'buffer-file-name
576 (with-current-buffer (buffer-base-buffer)
578 (error "Need a file name to be able to export")))
581 (format "Exporting to %s using org-lparse..."
583 (or org-lparse-backend org-lparse-other-backend
)))))
585 (setq-default org-todo-line-regexp org-todo-line-regexp
)
586 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
587 (setq-default org-done-keywords org-done-keywords
)
588 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
589 (let* (hfy-user-sheet-assoc ; let `htmlfontify' know that
590 ; we are interested in
592 org-lparse-encode-pending
594 (org-lparse-par-open-stashed 0)
597 (org-lparse-list-stack '())
599 ;; list-table related vars
600 org-lparse-list-table-p
601 org-lparse-list-table
:table-cell-open
602 org-lparse-list-table
:table-row
603 org-lparse-list-table
:lines
605 org-lparse-outline-text-open
606 (org-lparse-latex-fragment-fallback ; currently used only by
608 (or (ignore-errors (org-lparse-get 'LATEX-FRAGMENT-FALLBACK
))
609 (if (and (org-check-external-command "latex" "" t
)
610 (org-check-external-command "dvipng" "" t
))
613 (org-lparse-insert-tag-with-newlines 'both
)
614 (org-lparse-to-buffer to-buffer
)
615 (org-lparse-body-only body-only
)
616 (org-lparse-entity-control-callbacks-alist
617 (org-lparse-get 'ENTITY-CONTROL
))
618 (org-lparse-entity-format-callbacks-alist
619 (org-lparse-get 'ENTITY-FORMAT
))
621 (org-export-process-option-filters
622 (org-combine-plists (org-default-export-plist)
624 (org-infile-export-plist))))
625 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
626 valid org-lparse-dyn-first-heading-pos
627 (odd org-odd-levels-only
)
628 (region-p (org-region-active-p))
629 (rbeg (and region-p
(region-beginning)))
630 (rend (and region-p
(region-end)))
632 (if (plist-get opt-plist
:ignore-subtree-p
)
637 (and (org-at-heading-p)
638 (>= (org-end-of-subtree t t
) rend
))))))
639 (level-offset (if subtree-p
642 (+ (funcall outline-level
)
643 (if org-odd-levels-only
1 0)))
645 (opt-plist (setq org-export-opt-plist
647 (org-export-add-subtree-options opt-plist rbeg
)
649 ;; The following two are dynamically scoped into other
651 (org-current-export-dir
652 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
)))
653 (org-current-export-file buffer-file-name
)
654 (level 0) (line "") (origline "") txt todo
657 (filename (if to-buffer nil
660 (file-name-sans-extension
662 (org-entry-get (region-beginning)
663 "EXPORT_FILE_NAME" t
))
664 (file-name-nondirectory buffer-file-name
)))
665 "." (org-lparse-get 'FILE-NAME-EXTENSION opt-plist
))
666 (file-name-as-directory
667 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
))))))
668 (current-dir (if buffer-file-name
669 (file-name-directory buffer-file-name
)
671 (auto-insert nil
) ; Avoid any auto-insert stuff for the new file
672 (buffer (if to-buffer
674 ((eq to-buffer
'string
)
675 (get-buffer-create (org-lparse-get 'EXPORT-BUFFER-NAME
)))
676 (t (get-buffer-create to-buffer
)))
678 (or (let ((f (org-lparse-get 'INIT-METHOD
)))
679 (and f
(functionp f
) (funcall f filename
)))
681 (org-levels-open (make-vector org-level-max nil
))
684 (let* ((val (plist-get opt-plist p
))
685 (val (org-xml-encode-org-text-skip-links val
)))
686 (setq opt-plist
(plist-put opt-plist p val
))))
687 '(:date
:author
:keywords
:description
)))
688 (date (plist-get opt-plist
:date
))
690 ((and date
(string-match "%" date
))
691 (format-time-string date
))
693 (t (format-time-string "%Y-%m-%d %T %Z"))))
694 (dummy (setq opt-plist
(plist-put opt-plist
:effective-date date
)))
695 (title (org-xml-encode-org-text-skip-links
696 (or (and subtree-p
(org-export-get-title-from-subtree))
697 (plist-get opt-plist
:title
)
700 (plist-get opt-plist
:skip-before-1st-heading
))
701 (org-export-grab-title-from-buffer))
702 (and buffer-file-name
703 (file-name-sans-extension
704 (file-name-nondirectory buffer-file-name
)))
706 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
707 (html-table-tag (plist-get opt-plist
:html-table-tag
))
708 (quote-re0 (concat "^ *" org-quote-string
"\\( +\\|[ \t]*$\\)"))
709 (quote-re (format org-heading-keyword-regexp-format
711 (org-lparse-dyn-current-environment nil
)
712 ;; Get the language-dependent settings
713 (lang-words (or (assoc (plist-get opt-plist
:language
)
714 org-export-language-setup
)
715 (assoc "en" org-export-language-setup
)))
716 (dummy (setq opt-plist
(plist-put opt-plist
:lang-words lang-words
)))
719 (coding-system-for-write
720 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-WRITE
))
721 (and (boundp 'buffer-file-coding-system
)
722 buffer-file-coding-system
)))
723 (save-buffer-coding-system
724 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-SAVE
))
725 (and (boundp 'buffer-file-coding-system
)
726 buffer-file-coding-system
)))
729 (if region-p
(region-beginning) (point-min))
730 (if region-p
(region-end) (point-max))))
731 (org-export-have-math nil
)
732 (org-export-footnotes-seen nil
)
733 (org-export-footnotes-data (org-footnote-all-labels 'with-defs
))
734 (org-footnote-insert-pos-for-preprocessor 'point-min
)
735 (org-lparse-opt-plist opt-plist
)
738 (org-export-preprocess-string
741 :for-backend
(if (equal org-lparse-backend
'xhtml
) ; hack
744 :skip-before-1st-heading
745 (plist-get opt-plist
:skip-before-1st-heading
)
746 :drawers
(plist-get opt-plist
:drawers
)
747 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
748 :tasks
(plist-get opt-plist
:tasks
)
749 :tags
(plist-get opt-plist
:tags
)
750 :priority
(plist-get opt-plist
:priority
)
751 :footnotes
(plist-get opt-plist
:footnotes
)
752 :timestamps
(plist-get opt-plist
:timestamps
)
754 (plist-get opt-plist
:archived-trees
)
755 :select-tags
(plist-get opt-plist
:select-tags
)
756 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
758 (plist-get opt-plist
:text
)
760 (plist-get opt-plist
:LaTeX-fragments
))
763 table-buffer table-orig-buffer
765 rpl path attr desc descp desc1 desc2 link
767 footnotes footref-seen
768 org-lparse-output-buffer
769 org-lparse-footnote-definitions
770 org-lparse-footnote-number
772 org-lparse-collect-buffer
773 (org-lparse-collect-count 0) ; things will get haywire if
774 ; collections are chained. Use
775 ; this variable to assert this
781 (let ((inhibit-read-only t
))
783 (remove-text-properties (point-min) (point-max)
784 '(:org-license-to-kill t
))))
786 (message "Exporting...")
787 (org-init-section-numbers)
789 ;; Switch to the output buffer
790 (setq org-lparse-output-buffer buffer
)
791 (set-buffer org-lparse-output-buffer
)
792 (let ((inhibit-read-only t
)) (erase-buffer))
794 (org-install-letbind)
796 (and (fboundp 'set-buffer-file-coding-system
)
797 (set-buffer-file-coding-system coding-system-for-write
))
799 (let ((case-fold-search nil
)
800 (org-odd-levels-only odd
))
801 ;; create local variables for all options, to make sure all called
802 ;; functions get the correct information
804 (set (make-local-variable (nth 2 x
))
805 (plist-get opt-plist
(car x
))))
806 org-export-plist-vars
)
807 (setq umax
(if arg
(prefix-numeric-value arg
)
808 org-export-headline-levels
))
809 (setq umax-toc
(if (integerp org-export-with-toc
)
810 (min org-export-with-toc umax
)
813 (when (and org-export-with-toc
(not body-only
))
814 (setq lines
(org-lparse-prepare-toc
815 lines level-offset opt-plist umax-toc
)))
818 (org-lparse-begin 'DOCUMENT-CONTENT opt-plist
)
819 (org-lparse-begin 'DOCUMENT-BODY opt-plist
))
822 (org-init-section-numbers)
824 (org-lparse-begin-paragraph)
826 (while (setq line
(pop lines
) origline line
)
828 (when (and (org-lparse-current-environment-p 'quote
)
829 (string-match org-outline-regexp-bol line
))
830 (org-lparse-end-environment 'quote
))
832 (when (org-lparse-current-environment-p 'quote
)
833 (org-lparse-insert 'LINE line
)
834 (throw 'nextline nil
))
836 ;; Fixed-width, verbatim lines (examples)
837 (when (and org-export-with-fixed-width
838 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
839 (when (not (org-lparse-current-environment-p 'fixedwidth
))
840 (org-lparse-begin-environment 'fixedwidth
))
841 (org-lparse-insert 'LINE
(match-string 3 line
))
842 (when (or (not lines
)
843 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
845 (org-lparse-end-environment 'fixedwidth
))
846 (throw 'nextline nil
))
848 ;; Notes: The baseline version of org-html.el (git commit
849 ;; 3d802e), while encountering a *line-long* protected text,
850 ;; does one of the following two things based on the state
851 ;; of the export buffer.
853 ;; 1. If a paragraph element has just been opened and
854 ;; contains only whitespace as content, insert the
855 ;; protected text as part of the previous paragraph.
857 ;; 2. If the paragraph element has already been opened and
858 ;; contains some valid content insert the protected text
859 ;; as part of the current paragraph.
863 ;; Scenario 1 mentioned above kicks in when a block of
864 ;; protected text has to be inserted en bloc. For example,
865 ;; this happens, when inserting an source or example block
866 ;; or preformatted content enclosed in #+backend,
867 ;; #+begin_backend ... #+end_backend)
869 ;; Scenario 2 mentioned above kicks in when the protected
870 ;; text is part of a running sentence. For example this
871 ;; happens in the case of an *multiline* LaTeX equation that
872 ;; needs to be inserted verbatim.
874 ;; org-html.el in the master branch seems to do some
875 ;; jugglery by moving paragraphs around. Inorder to make
876 ;; these changes backend-agnostic introduce a new text
877 ;; property org-native-text and impose the added semantics
878 ;; that these protected blocks appear outside of a
879 ;; conventional paragraph element.
881 ;; Extra Note: Check whether org-example and org-native-text
882 ;; are entirely equivalent.
884 ;; Fixes bug reported by Christian Moe concerning verbatim
886 ;; on git commit 533ba3f90250a1f25f494c390d639ea6274f235c
887 ;; http://repo.or.cz/w/org-mode/org-jambu.git/shortlog/refs/heads/staging
888 ;; See http://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01379.html
891 (when (and (get-text-property 0 'org-native-text line
)
892 ;; Make sure it is the entire line that is protected
893 (not (< (or (next-single-property-change
894 0 'org-native-text line
) 10000)
896 (let ((ind (get-text-property 0 'original-indentation line
)))
897 (org-lparse-begin-environment 'native
)
898 (org-lparse-insert 'LINE line
)
900 (or (= (length (car lines
)) 0)
902 (equal ind
(get-text-property
903 0 'original-indentation
(car lines
))))
904 (or (= (length (car lines
)) 0)
905 (get-text-property 0 'org-native-text
(car lines
))))
906 (org-lparse-insert 'LINE
(pop lines
)))
907 (org-lparse-end-environment 'native
))
908 (throw 'nextline nil
))
911 (when (and (get-text-property 0 'org-protected line
)
912 ;; Make sure it is the entire line that is protected
913 (not (< (or (next-single-property-change
914 0 'org-protected line
) 10000)
916 (let ((ind (get-text-property 0 'original-indentation line
)))
917 (org-lparse-insert 'LINE line
)
919 (or (= (length (car lines
)) 0)
921 (equal ind
(get-text-property
922 0 'original-indentation
(car lines
))))
923 (or (= (length (car lines
)) 0)
924 (get-text-property 0 'org-protected
(car lines
))))
925 (org-lparse-insert 'LINE
(pop lines
))))
926 (throw 'nextline nil
))
928 ;; Blockquotes, verse, and center
930 "^ORG-\\(.+\\)-\\(START\\|END\\)\\([ \t]+.*\\)?$" line
)
931 (let* ((style (intern (downcase (match-string 1 line
))))
932 (env-options-plist (org-lparse-get-block-params
933 (match-string 3 line
)))
934 (f (cdr (assoc (match-string 2 line
)
935 '(("START" . org-lparse-begin-environment
)
936 ("END" . org-lparse-end-environment
))))))
939 '(blockquote verse center
)
940 (mapcar 'intern org-lparse-special-blocks
)))
941 (funcall f style env-options-plist
)
942 (throw 'nextline nil
))))
944 (run-hooks 'org-export-html-after-blockquotes-hook
)
945 (when (org-lparse-current-environment-p 'verse
)
946 (let ((i (org-get-string-indentation line
)))
949 (let ((org-lparse-encode-pending t
))
950 (org-lparse-format 'SPACES
(* 2 i
)))
951 " " (org-trim line
))))
952 (unless (string-match "\\\\\\\\[ \t]*$" line
)
953 (setq line
(concat line
"\\\\")))))
955 ;; make targets to anchors
958 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
960 ((get-text-property (match-beginning 1) 'org-protected line
)
961 (setq start
(match-end 1)))
963 (setq line
(replace-match
964 (let ((org-lparse-encode-pending t
))
966 'ANCHOR
"" (org-solidify-link-text
967 (match-string 1 line
))))
969 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
970 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
971 (setq line
(replace-match
972 (let ((org-lparse-encode-pending t
))
974 'FONTIFY
(match-string 1 line
) "target"))
975 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
978 (setq line
(replace-match
980 (let ((org-lparse-encode-pending t
))
982 'ANCHOR
(match-string 1 line
)
983 (org-solidify-link-text (match-string 1 line
))
987 (let ((org-lparse-encode-pending t
))
988 (setq line
(org-lparse-handle-time-stamps line
)))
990 ;; replace "&" by "&", "<" and ">" by "<" and ">"
991 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
992 ;; Also handle sub_superscripts and checkboxes
993 (or (string-match org-table-hline-regexp line
)
994 (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line
)
995 (setq line
(org-xml-encode-org-text-skip-links line
)))
997 (setq line
(org-lparse-format-org-link line opt-plist
))
1000 (if (and org-todo-line-regexp
1001 (string-match org-todo-line-regexp line
)
1002 (match-beginning 2))
1004 (substring line
0 (match-beginning 2))
1005 (org-lparse-format 'TODO
(match-string 2 line
))
1006 (substring line
(match-end 2)))))
1008 ;; Does this contain a reference to a footnote?
1009 (when org-export-with-footnotes
1011 (while (string-match "\\([^* \t].*?\\)[ \t]*\\[\\([0-9]+\\)\\]" line start
)
1012 ;; Discard protected matches not clearly identified as
1013 ;; footnote markers.
1014 (if (or (get-text-property (match-beginning 2) 'org-protected line
)
1015 (not (get-text-property (match-beginning 2) 'org-footnote line
)))
1016 (setq start
(match-end 2))
1017 (let ((n (match-string 2 line
)) refcnt a
)
1018 (if (setq a
(assoc n footref-seen
))
1020 (setcdr a
(1+ (cdr a
)))
1021 (setq refcnt
(cdr a
)))
1023 (push (cons n
1) footref-seen
))
1027 (or (match-string 1 line
) "")
1030 n
(cdr (assoc n org-lparse-footnote-definitions
))
1032 ;; If another footnote is following the
1033 ;; current one, add a separator.
1034 (if (save-match-data
1035 (string-match "\\`\\[[0-9]+\\]"
1036 (substring line
(match-end 0))))
1038 (org-lparse-get 'FOOTNOTE-SEPARATOR
))
1043 ((string-match "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$" line
)
1044 ;; This is a headline
1045 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1047 txt
(match-string 2 line
))
1048 (if (string-match quote-re0 txt
)
1049 (setq txt
(replace-match "" t t txt
)))
1050 (if (<= level
(max umax umax-toc
))
1051 (setq head-count
(+ head-count
1)))
1052 (unless org-lparse-dyn-first-heading-pos
1053 (setq org-lparse-dyn-first-heading-pos
(point)))
1054 (org-lparse-begin-level level txt umax head-count
)
1057 (when (string-match quote-re line
)
1058 (org-lparse-begin-environment 'quote
)))
1060 ((and org-export-with-tables
1061 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1062 (when (not table-open
)
1064 (setq table-open t table-buffer nil table-orig-buffer nil
))
1067 (setq table-buffer
(cons line table-buffer
)
1068 table-orig-buffer
(cons origline table-orig-buffer
))
1069 (when (or (not lines
)
1070 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1072 (setq table-open nil
1073 table-buffer
(nreverse table-buffer
)
1074 table-orig-buffer
(nreverse table-orig-buffer
))
1075 (org-lparse-end-paragraph)
1076 (when org-lparse-list-table-p
1077 (error "Regular tables are not allowed in a list-table block"))
1078 (org-lparse-insert 'TABLE table-buffer table-orig-buffer
)))
1082 ;; This line either is list item or end a list.
1083 (when (get-text-property 0 'list-item line
)
1084 (setq line
(org-lparse-export-list-line
1086 (get-text-property 0 'list-item line
)
1087 (get-text-property 0 'list-struct line
)
1088 (get-text-property 0 'list-prevs line
))))
1091 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1092 (with-org-lparse-preserve-paragraph-state
1093 (org-lparse-insert 'HORIZONTAL-LINE
))
1094 (throw 'nextline nil
))
1096 ;; Empty lines start a new paragraph. If hand-formatted lists
1097 ;; are not fully interpreted, lines starting with "-", "+", "*"
1098 ;; also start a new paragraph.
1099 (when (string-match "^ [-+*]-\\|^[ \t]*$" line
)
1100 (when org-lparse-footnote-number
1101 (org-lparse-end-footnote-definition org-lparse-footnote-number
)
1102 (setq org-lparse-footnote-number nil
))
1103 (org-lparse-begin-paragraph))
1105 ;; Is this the start of a footnote?
1106 (when org-export-with-footnotes
1107 (when (and (boundp 'footnote-section-tag-regexp
)
1108 (string-match (concat "^" footnote-section-tag-regexp
)
1111 (throw 'nextline nil
))
1112 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1113 (org-lparse-end-paragraph)
1114 (setq org-lparse-footnote-number
(match-string 1 line
))
1115 (setq line
(replace-match "" t t line
))
1116 (org-lparse-begin-footnote-definition org-lparse-footnote-number
)))
1117 ;; Check if the line break needs to be conserved
1119 ((string-match "\\\\\\\\[ \t]*$" line
)
1120 (setq line
(replace-match
1121 (org-lparse-format 'LINE-BREAK
)
1123 (org-export-preserve-breaks
1124 (setq line
(concat line
(org-lparse-format 'LINE-BREAK
)))))
1126 ;; Check if a paragraph should be started
1128 (while (and org-lparse-par-open
1129 (string-match "\\\\par\\>" line start
))
1131 ;; Leave a space in the </p> so that the footnote matcher
1132 ;; does not see this.
1133 (if (not (get-text-property (match-beginning 0)
1134 'org-protected line
))
1135 (setq line
(replace-match "</p ><p >" t t line
)))
1136 (setq start
(match-end 0))))
1138 (org-lparse-insert 'LINE line
)))))
1140 ;; Properly close all local lists and other lists
1141 (when (org-lparse-current-environment-p 'quote
)
1142 (org-lparse-end-environment 'quote
))
1144 (org-lparse-end-level 1 umax
)
1146 ;; the </div> to close the last text-... div.
1147 (when (and (> umax
0) org-lparse-dyn-first-heading-pos
)
1148 (org-lparse-end-outline-text-or-outline))
1150 (org-lparse-end 'DOCUMENT-BODY opt-plist
)
1152 (org-lparse-end 'DOCUMENT-CONTENT
))
1154 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1157 (org-lparse-end 'EXPORT
)
1159 ;; kill collection buffer
1160 (when org-lparse-collect-buffer
1161 (kill-buffer org-lparse-collect-buffer
))
1163 (goto-char (point-min))
1164 (or (org-export-push-to-kill-ring
1165 (upcase (symbol-name org-lparse-backend
)))
1166 (message "Exporting... done"))
1170 (let ((f (org-lparse-get 'SAVE-METHOD
)))
1171 (or (and f
(functionp f
) (funcall f filename opt-plist
))
1173 (or (and (boundp 'org-lparse-other-backend
)
1174 org-lparse-other-backend
1175 (not (equal org-lparse-backend org-lparse-other-backend
))
1176 (org-lparse-do-convert
1177 buffer-file-name
(symbol-name org-lparse-other-backend
)))
1179 ((eq to-buffer
'string
)
1180 (prog1 (buffer-substring (point-min) (point-max))
1181 (kill-buffer (current-buffer))))
1182 (t (current-buffer))))))
1184 (defun org-lparse-format-table (lines olines
)
1185 "Returns backend-specific code for org-type and table-type tables."
1187 (setq lines
(org-split-string lines
"\n")))
1188 (if (string-match "^[ \t]*|" (car lines
))
1189 ;; A normal org table
1190 (org-lparse-format-org-table lines nil
)
1191 ;; Table made by table.el
1192 (or (org-lparse-format-table-table-using-table-generate-source
1193 ;; FIXME: Need to take care of this during merge
1194 (if (eq org-lparse-backend
'xhtml
) 'html org-lparse-backend
)
1196 (not org-export-prefer-native-exporter-for-tables
))
1197 ;; We are here only when table.el table has NO col or row
1198 ;; spanning and the user prefers using org's own converter for
1199 ;; exporting of such simple table.el tables.
1200 (org-lparse-format-table-table lines
))))
1202 (defun org-lparse-table-get-colalign-info (lines)
1203 (let ((col-cookies (org-find-text-property-in-string
1204 'org-col-cookies
(car lines
))))
1205 (when (and col-cookies org-table-clean-did-remove-column
)
1207 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) col-cookies
)))
1210 (defvar org-lparse-table-style
)
1211 (defvar org-lparse-table-ncols
)
1212 (defvar org-lparse-table-rownum
)
1213 (defvar org-lparse-table-is-styled
)
1214 (defvar org-lparse-table-begin-marker
)
1215 (defvar org-lparse-table-num-numeric-items-per-column
)
1216 (defvar org-lparse-table-colalign-info
)
1217 (defvar org-lparse-table-colalign-vector
)
1219 ;; Following variables are defined in org-table.el
1220 (defvar org-table-number-fraction
)
1221 (defvar org-table-number-regexp
)
1222 (defun org-lparse-org-table-to-list-table (lines &optional splice
)
1223 "Convert org-table to list-table.
1224 LINES is a list of the form (ROW1 ROW2 ROW3 ...) where each
1225 element is a `string' representing a single row of org-table.
1226 Thus each ROW has vertical separators \"|\" separating the table
1227 fields. A ROW could also be a row-group separator of the form
1228 \"|---...|\". Return a list of the form (ROW1 ROW2 ROW3
1229 ...). ROW could either be symbol `:hrule' or a list of the
1230 form (FIELD1 FIELD2 FIELD3 ...) as appropriate."
1234 (while (setq line
(pop lines
))
1235 (unless (string-match "^[ \t]*|-" line
)
1236 (push (org-split-string line
"[ \t]*|[ \t]*") lines-1
))))
1238 (while (setq line
(pop lines
))
1240 ((string-match "^[ \t]*|-" line
)
1242 (push :hrule lines-1
)))
1244 (push (org-split-string line
"[ \t]*|[ \t]*") lines-1
))))))
1245 (nreverse lines-1
)))
1247 (defun org-lparse-insert-org-table (lines &optional splice
)
1248 "Format a org-type table into backend-specific code.
1249 LINES is a list of lines. Optional argument SPLICE means, do not
1250 insert header and surrounding <table> tags, just format the lines.
1251 Optional argument NO-CSS means use XHTML attributes instead of CSS
1252 for formatting. This is required for the DocBook exporter."
1253 (require 'org-table
)
1254 ;; Get rid of hlines at beginning and end
1255 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1256 (setq lines
(nreverse lines
))
1257 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1258 (setq lines
(nreverse lines
))
1259 (when org-export-table-remove-special-lines
1260 ;; Check if the table has a marking column. If yes remove the
1261 ;; column and the special lines
1262 (setq lines
(org-table-clean-before-export lines
)))
1263 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1264 (caption (and caption
(org-xml-encode-org-text caption
)))
1265 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1266 (org-lparse-table-colalign-info (org-lparse-table-get-colalign-info lines
))
1267 (attributes (org-find-text-property-in-string 'org-attributes
1269 (head (and org-export-highlight-first-table-line
1271 (lambda (x) (string-match "^[ \t]*|-" x
))
1273 (setq lines
(org-lparse-org-table-to-list-table lines splice
))
1274 (org-lparse-insert-list-table
1275 lines splice caption label attributes head org-lparse-table-colalign-info
)))
1277 (defun org-lparse-insert-list-table (lines &optional splice
1278 caption label attributes head
1279 org-lparse-table-colalign-info
)
1280 (or (featurep 'org-table
) ; required for
1281 (require 'org-table
)) ; `org-table-number-regexp'
1282 (let* ((org-lparse-table-rownum -
1) org-lparse-table-ncols i
(cnt 0)
1284 org-lparse-table-cur-rowgrp-is-hdr
1285 org-lparse-table-rowgrp-open
1286 org-lparse-table-num-numeric-items-per-column
1287 org-lparse-table-colalign-vector n
1288 org-lparse-table-rowgrp-info
1289 org-lparse-table-begin-marker
1290 (org-lparse-table-style 'org-table
)
1291 org-lparse-table-is-styled
)
1294 (setq org-lparse-table-is-styled nil
)
1295 (while (setq line
(pop lines
))
1296 (insert (org-lparse-format-table-row line
) "\n")))
1298 (setq org-lparse-table-is-styled t
)
1299 (org-lparse-begin 'TABLE caption label attributes
)
1300 (setq org-lparse-table-begin-marker
(point))
1301 (org-lparse-begin-table-rowgroup head
)
1302 (while (setq line
(pop lines
))
1304 ((equal line
:hrule
)
1305 (org-lparse-begin-table-rowgroup))
1307 (insert (org-lparse-format-table-row line
) "\n"))))
1308 (org-lparse-end 'TABLE-ROWGROUP
)
1309 (org-lparse-end-table)))))
1311 (defun org-lparse-format-org-table (lines &optional splice
)
1313 (org-lparse-insert-org-table lines splice
)
1314 (buffer-substring-no-properties (point-min) (point-max))))
1316 (defun org-lparse-format-list-table (lines &optional splice
)
1318 (org-lparse-insert-list-table lines splice
)
1319 (buffer-substring-no-properties (point-min) (point-max))))
1321 (defun org-lparse-insert-table-table (lines)
1322 "Format a table generated by table.el into backend-specific code.
1323 This conversion does *not* use `table-generate-source' from table.el.
1324 This has the advantage that Org-mode's HTML conversions can be used.
1325 But it has the disadvantage, that no cell- or row-spanning is allowed."
1326 (let (line field-buffer
1327 (org-lparse-table-cur-rowgrp-is-hdr
1328 org-export-highlight-first-table-line
)
1332 (org-lparse-table-style 'table-table
)
1333 (org-lparse-table-is-styled nil
)
1334 fields org-lparse-table-ncols i
(org-lparse-table-rownum -
1)
1335 (empty (org-lparse-format 'SPACES
1)))
1336 (org-lparse-begin 'TABLE caption label attributes
)
1337 (while (setq line
(pop lines
))
1339 ((string-match "^[ \t]*\\+-" line
)
1341 (let ((org-export-table-row-tags '("<tr>" .
"</tr>"))
1342 ;; (org-export-html-table-use-header-tags-for-first-column nil)
1344 (insert (org-lparse-format-table-row field-buffer empty
)))
1345 (setq org-lparse-table-cur-rowgrp-is-hdr nil
)
1346 (setq field-buffer nil
)))
1348 ;; Break the line into fields and store the fields
1349 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1351 (setq field-buffer
(mapcar
1353 (concat x
(org-lparse-format 'LINE-BREAK
)
1356 (setq field-buffer fields
)))))
1357 (org-lparse-end-table)))
1359 (defun org-lparse-format-table-table (lines)
1361 (org-lparse-insert-table-table lines
)
1362 (buffer-substring-no-properties (point-min) (point-max))))
1364 (defvar table-source-languages
) ; defined in table.el
1365 (defun org-lparse-format-table-table-using-table-generate-source (backend
1369 "Format a table into BACKEND, using `table-generate-source' from table.el.
1370 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
1372 When SPANNED-ONLY is nil, all table.el tables are exported. When
1373 SPANNED-ONLY is non-nil, only tables with either row or column
1376 This routine returns the generated source or nil as appropriate.
1378 Refer docstring of `org-export-prefer-native-exporter-for-tables'
1379 for further information."
1381 (with-current-buffer (get-buffer-create " org-tmp1 ")
1383 (insert (mapconcat 'identity lines
"\n"))
1384 (goto-char (point-min))
1385 (if (not (re-search-forward "|[^+]" nil t
))
1386 (error "Error processing table"))
1387 (table-recognize-table)
1388 (when (or (not spanned-only
)
1389 (let* ((dim (table-query-dimension))
1390 (c (nth 4 dim
)) (r (nth 5 dim
)) (cells (nth 6 dim
)))
1391 (not (= (* c r
) cells
))))
1392 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1394 ((member backend table-source-languages
)
1395 (table-generate-source backend
" org-tmp2 ")
1396 (set-buffer " org-tmp2 ")
1397 (buffer-substring (point-min) (point-max)))
1399 ;; table.el doesn't support the given backend. Currently this
1400 ;; happens in case of odt export. Strip the table from the
1401 ;; generated document. A better alternative would be to embed
1402 ;; the table as ascii text in the output document.
1405 "Found table.el-type table in the source org file. "
1406 (format "table.el doesn't support %s backend. "
1407 (upcase (symbol-name backend
)))
1408 "Skipping ahead ..."))
1411 (defun org-lparse-handle-time-stamps (s)
1412 "Format time stamps in string S, or remove them."
1415 (when org-maybe-keyword-time-regexp
1416 (while (string-match org-maybe-keyword-time-regexp s
)
1417 (or b
(setq b
(substring s
0 (match-beginning 0))))
1419 r
(substring s
0 (match-beginning 0)) " "
1426 (match-string 1 s
) "timestamp-kwd"))
1430 (substring (org-translate-time (match-string 3 s
)) 1 -
1)
1432 "timestamp-wrapper"))
1433 s
(substring s
(match-end 0)))))
1435 ;; Line break if line started and ended with time stamp stuff
1438 (setq r
(concat r s
))
1439 (unless (string-match "\\S-" (concat b s
))
1440 (setq r
(concat r
(org-lparse-format 'LINE-BREAK
))))
1443 (defun org-xml-encode-plain-text (s)
1444 "Convert plain text characters to HTML equivalent.
1445 Possible conversions are set in `org-export-html-protect-char-alist'."
1446 (let ((cl (org-lparse-get 'PLAIN-TEXT-MAP
)) c
)
1447 (while (setq c
(pop cl
))
1449 (while (string-match (car c
) s start
)
1450 (setq s
(replace-match (cdr c
) t t s
)
1451 start
(1+ (match-beginning 0))))))
1454 (defun org-xml-encode-org-text-skip-links (string)
1455 "Prepare STRING for HTML export. Apply all active conversions.
1456 If there are links in the string, don't modify these. If STRING
1457 is nil, return nil."
1459 (let* ((re (concat org-bracket-link-regexp
"\\|"
1460 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
1462 (while (setq m
(string-match re string
))
1463 (setq s
(substring string
0 m
)
1464 l
(match-string 0 string
)
1465 string
(substring string
(match-end 0)))
1466 (push (org-xml-encode-org-text s
) res
)
1468 (push (org-xml-encode-org-text string
) res
)
1469 (apply 'concat
(nreverse res
)))))
1471 (defun org-xml-encode-org-text (s)
1472 "Apply all active conversions to translate special ASCII to HTML."
1473 (setq s
(org-xml-encode-plain-text s
))
1474 (if org-export-html-expand
1475 (while (string-match "@<\\([^&]*\\)>" s
)
1476 (setq s
(replace-match "<\\1>" t nil s
))))
1477 (if org-export-with-emphasize
1478 (setq s
(org-lparse-apply-char-styles s
)))
1479 (if org-export-with-special-strings
1480 (setq s
(org-lparse-convert-special-strings s
)))
1481 (if org-export-with-sub-superscripts
1482 (setq s
(org-lparse-apply-sub-superscript-styles s
)))
1483 (if org-export-with-TeX-macros
1484 (let ((start 0) wd rep
)
1485 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
1487 (if (get-text-property (match-beginning 0) 'org-protected s
)
1488 (setq start
(match-end 0))
1489 (setq wd
(match-string 1 s
))
1490 (if (setq rep
(org-lparse-format 'ORG-ENTITY wd
))
1491 (setq s
(replace-match rep t t s
))
1492 (setq start
(+ start
(length wd
))))))))
1495 (defun org-lparse-convert-special-strings (string)
1496 "Convert special characters in STRING to HTML."
1497 (let ((all (org-lparse-get 'SPECIAL-STRING-REGEXPS
))
1499 (while (setq a
(pop all
))
1500 (setq re
(car a
) rpl
(cdr a
) start
0)
1501 (while (string-match re string start
)
1502 (if (get-text-property (match-beginning 0) 'org-protected string
)
1503 (setq start
(match-end 0))
1504 (setq string
(replace-match rpl t nil string
)))))
1507 (defun org-lparse-apply-sub-superscript-styles (string)
1508 "Apply subscript and superscript styles to STRING.
1509 Use `org-export-with-sub-superscripts' to control application of
1510 sub and superscript styles."
1511 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
1512 (while (string-match org-match-substring-regexp string s
)
1514 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
1515 ((get-text-property (match-beginning 2) 'org-protected string
)
1516 (setq s
(match-end 2)))
1518 (setq s
(match-end 1)
1519 key
(if (string= (match-string 2 string
) "_")
1520 'subscript
'superscript
)
1521 c
(or (match-string 8 string
)
1522 (match-string 6 string
)
1523 (match-string 5 string
))
1524 string
(replace-match
1525 (concat (match-string 1 string
)
1526 (org-lparse-format 'FONTIFY c key
))
1528 (while (string-match "\\\\\\([_^]\\)" string
)
1529 (setq string
(replace-match (match-string 1 string
) t t string
)))
1532 (defvar org-lparse-char-styles
1539 "Map Org emphasis markers to char styles.
1540 This is an alist where each element is of the
1541 form (ORG-EMPHASIS-CHAR . CHAR-STYLE).")
1543 (defun org-lparse-apply-char-styles (string)
1544 "Apply char styles to STRING.
1545 The variable `org-lparse-char-styles' controls how the Org
1546 emphasis markers are interpreted."
1548 (while (string-match org-emph-re string s
)
1550 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
1551 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
1552 (setq s
(match-beginning 0)
1555 (match-string 1 string
)
1557 'FONTIFY
(match-string 4 string
)
1558 (nth 1 (assoc (match-string 3 string
)
1559 org-lparse-char-styles
)))
1560 (match-string 5 string
))
1561 string
(replace-match rpl t t string
)
1562 s
(+ s
(- (length rpl
) 2)))
1566 (defun org-lparse-export-list-line (line pos struct prevs
)
1567 "Insert list syntax in export buffer. Return LINE, maybe modified.
1569 POS is the item position or line position the line had before
1570 modifications to buffer. STRUCT is the list structure. PREVS is
1571 the alist of previous items."
1574 ;; Translate type of list containing POS to "d", "o" or
1576 (lambda (pos struct prevs
)
1577 (let ((type (org-list-get-list-type pos struct prevs
)))
1579 ((eq 'ordered type
) "o")
1580 ((eq 'descriptive type
) "d")
1584 ;; Return list of all items and sublists ending at POS, in
1590 (let ((end (nth 6 e
))
1593 ((= end pos
) (push item out
))
1594 ((>= item pos
) (throw 'exit nil
)))))
1597 ;; First close any previous item, or list, ending at POS.
1599 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
1600 (first-item (org-list-get-list-begin e struct prevs
))
1601 (type (funcall get-type first-item struct prevs
)))
1602 (org-lparse-end-paragraph)
1603 ;; Ending for every item
1604 (org-lparse-end-list-item-1 type
)
1605 ;; We're ending last item of the list: end list.
1607 (org-lparse-end-list type
)
1608 (org-lparse-begin-paragraph))))
1609 (funcall get-closings pos
))
1611 ;; At an item: insert appropriate tags in export buffer.
1614 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
1615 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
1616 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
1617 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
1619 (let* ((checkbox (match-string 3 line
))
1620 (desc-tag (or (match-string 4 line
) "???"))
1621 (body (or (match-string 5 line
) ""))
1622 (list-beg (org-list-get-list-begin pos struct prevs
))
1623 (firstp (= list-beg pos
))
1624 ;; Always refer to first item to determine list type, in
1625 ;; case list is ill-formed.
1626 (type (funcall get-type list-beg struct prevs
))
1627 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
1629 ((not count-tmp
) nil
)
1630 ((string-match "[A-Za-z]" count-tmp
)
1631 (- (string-to-char (upcase count-tmp
)) 64))
1632 ((string-match "[0-9]+" count-tmp
)
1635 (org-lparse-end-paragraph)
1636 (org-lparse-begin-list type
))
1638 (let ((arg (cond ((equal type
"d") desc-tag
)
1639 ((equal type
"o") counter
))))
1640 (org-lparse-begin-list-item type arg
))
1642 ;; If line had a checkbox, some additional modification is required.
1650 ((string-match "X" checkbox
) "X")
1651 ((string-match " " checkbox
)
1652 (org-lparse-format 'SPACES
1))
1658 ;; Return modified line
1660 ;; At a list ender: go to next line (side-effects only).
1661 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
1662 ;; Not at an item: return line unchanged (side-effects only).
1665 (defun org-lparse-bind-local-variables (opt-plist)
1667 (set (make-local-variable (nth 2 x
))
1668 (plist-get opt-plist
(car x
))))
1669 org-export-plist-vars
))
1671 (defvar org-lparse-table-rowgrp-open
)
1672 (defvar org-lparse-table-cur-rowgrp-is-hdr
)
1673 (defvar org-lparse-footnote-number
)
1674 (defvar org-lparse-footnote-definitions
)
1675 (defvar org-lparse-output-buffer nil
1676 "Buffer to which `org-do-lparse' writes to.
1677 This buffer contains the contents of the to-be-created exported
1680 (defcustom org-lparse-debug nil
1681 "Enable or Disable logging of `org-lparse' callbacks.
1682 The parameters passed to the backend-registered ENTITY-CONTROL
1683 and ENTITY-FORMAT callbacks are logged as comment strings in the
1684 exported buffer. (org-lparse-format 'COMMENT fmt args) is used
1685 for logging. Customize this variable only if you are an expert
1686 user. Valid values of this variable are:
1687 nil : Disable logging
1688 control : Log all invocations of `org-lparse-begin' and
1689 `org-lparse-end' callbacks.
1690 format : Log invocations of `org-lparse-format' callbacks.
1691 t : Log all invocations of `org-lparse-begin', `org-lparse-end'
1692 and `org-lparse-format' callbacks,"
1695 (const :tag
"Disable" nil
)
1696 (const :tag
"Format callbacks" format
)
1697 (const :tag
"Control callbacks" control
)
1698 (const :tag
"Format and Control callbacks" t
)))
1700 (defun org-lparse-begin (entity &rest args
)
1701 "Begin ENTITY in current buffer. ARGS is entity specific.
1702 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM etc.
1704 Use (org-lparse-begin 'LIST \"o\") to begin a list in current
1707 See `org-xhtml-entity-control-callbacks-alist' for more
1709 (when (and (member org-lparse-debug
'(t control
))
1710 (not (eq entity
'DOCUMENT-CONTENT
)))
1711 (insert (org-lparse-format 'COMMENT
"%s BEGIN %S" entity args
)))
1713 (let ((f (cadr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1714 (unless f
(error "Unknown entity: %s" entity
))
1717 (defun org-lparse-end (entity &rest args
)
1718 "Close ENTITY in current buffer. ARGS is entity specific.
1719 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM
1722 Use (org-lparse-end 'LIST \"o\") to close a list in current
1725 See `org-xhtml-entity-control-callbacks-alist' for more
1727 (when (and (member org-lparse-debug
'(t control
))
1728 (not (eq entity
'DOCUMENT-CONTENT
)))
1729 (insert (org-lparse-format 'COMMENT
"%s END %S" entity args
)))
1731 (let ((f (caddr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1732 (unless f
(error "Unknown entity: %s" entity
))
1735 (defun org-lparse-begin-paragraph (&optional style
)
1736 "Insert <p>, but first close previous paragraph if any."
1737 (org-lparse-end-paragraph)
1738 (org-lparse-begin 'PARAGRAPH style
)
1739 (setq org-lparse-par-open t
))
1741 (defun org-lparse-end-paragraph ()
1742 "Close paragraph if there is one open."
1743 (when org-lparse-par-open
1744 (org-lparse-end 'PARAGRAPH
)
1745 (setq org-lparse-par-open nil
)))
1747 (defun org-lparse-end-list-item-1 (&optional type
)
1748 "Close <li> if necessary."
1749 (org-lparse-end-paragraph)
1750 (org-lparse-end-list-item (or type
"u")))
1752 (defun org-lparse-preprocess-after-blockquote-hook ()
1753 "Treat `org-lparse-special-blocks' specially."
1754 (goto-char (point-min))
1755 (while (re-search-forward
1756 "^[ \t]*#\\+\\(begin\\|end\\)_\\(\\S-+\\)[ \t]*\\(.*\\)$" nil t
)
1757 (when (member (downcase (match-string 2)) org-lparse-special-blocks
)
1759 (if (equal (downcase (match-string 1)) "begin")
1760 (format "ORG-%s-START %s" (upcase (match-string 2))
1762 (format "ORG-%s-END %s" (upcase (match-string 2))
1763 (match-string 3))) t t
))))
1765 (add-hook 'org-export-preprocess-after-blockquote-hook
1766 'org-lparse-preprocess-after-blockquote-hook
)
1768 (defun org-lparse-strip-experimental-blocks-maybe-hook ()
1769 "Strip \"list-table\" and \"annotation\" blocks.
1770 Stripping happens only when the exported backend is not one of
1771 \"odt\" or \"xhtml\"."
1772 (when (not org-lparse-backend
)
1773 (message "Stripping following blocks - %S" org-lparse-special-blocks
)
1774 (goto-char (point-min))
1775 (let ((case-fold-search t
))
1778 "^[ \t]*#\\+begin_\\(\\S-+\\)\\([ \t]+.*\\)?\n\\([^\000]*?\\)\n[ \t]*#\\+end_\\1\\>.*"
1780 (when (member (match-string 1) org-lparse-special-blocks
)
1781 (replace-match "" t t
))))))
1783 (add-hook 'org-export-preprocess-hook
1784 'org-lparse-strip-experimental-blocks-maybe-hook
)
1786 (defvar org-lparse-list-table-p nil
1787 "Non-nil if `org-do-lparse' is within a list-table.")
1789 (defvar org-lparse-dyn-current-environment nil
)
1790 (defun org-lparse-begin-environment (style &optional env-options-plist
)
1793 (setq org-lparse-list-table-p t
))
1794 (t (setq org-lparse-dyn-current-environment style
)
1795 (org-lparse-begin 'ENVIRONMENT style env-options-plist
))))
1797 (defun org-lparse-end-environment (style &optional env-options-plist
)
1800 (setq org-lparse-list-table-p nil
))
1801 (t (org-lparse-end 'ENVIRONMENT style env-options-plist
)
1802 (setq org-lparse-dyn-current-environment nil
))))
1804 (defun org-lparse-current-environment-p (style)
1805 (eq org-lparse-dyn-current-environment style
))
1807 (defun org-lparse-begin-footnote-definition (n)
1808 (org-lparse-begin-collect)
1809 (setq org-lparse-insert-tag-with-newlines nil
)
1810 (org-lparse-begin 'FOOTNOTE-DEFINITION n
))
1812 (defun org-lparse-end-footnote-definition (n)
1813 (org-lparse-end 'FOOTNOTE-DEFINITION n
)
1814 (setq org-lparse-insert-tag-with-newlines
'both
)
1815 (let ((footnote-def (org-lparse-end-collect)))
1816 ;; Cleanup newlines in footnote definition. This ensures that a
1817 ;; transcoded line is never (wrongly) broken in to multiple lines.
1819 (while (string-match "[\r\n]+" footnote-def pos
)
1820 (setq pos
(1+ (match-beginning 0)))
1821 (setq footnote-def
(replace-match " " t t footnote-def
))))
1822 (push (cons n footnote-def
) org-lparse-footnote-definitions
)))
1824 (defvar org-lparse-collect-buffer nil
1825 "An auxiliary buffer named \"*Org Lparse Collect*\".
1826 `org-do-lparse' uses this as output buffer while collecting
1827 footnote definitions and table-cell contents of list-tables. See
1828 `org-lparse-begin-collect' and `org-lparse-end-collect'.")
1830 (defvar org-lparse-collect-count nil
1831 "Count number of calls to `org-lparse-begin-collect'.
1832 Use this counter to catch chained collections if they ever
1835 (defun org-lparse-begin-collect ()
1836 "Temporarily switch to `org-lparse-collect-buffer'.
1837 Also erase it's contents."
1838 (unless (zerop org-lparse-collect-count
)
1839 (error "FIXME (org-lparse.el): Encountered chained collections"))
1840 (incf org-lparse-collect-count
)
1841 (unless org-lparse-collect-buffer
1842 (setq org-lparse-collect-buffer
1843 (get-buffer-create "*Org Lparse Collect*")))
1844 (set-buffer org-lparse-collect-buffer
)
1847 (defun org-lparse-end-collect ()
1848 "Switch to `org-lparse-output-buffer'.
1849 Return contents of `org-lparse-collect-buffer' as a `string'."
1850 (assert (> org-lparse-collect-count
0))
1851 (decf org-lparse-collect-count
)
1852 (prog1 (buffer-string)
1854 (set-buffer org-lparse-output-buffer
)))
1856 (defun org-lparse-format (entity &rest args
)
1857 "Format ENTITY in backend-specific way and return it.
1858 ARGS is specific to entity being formatted.
1860 Use (org-lparse-format 'HEADING \"text\" 1) to format text as
1863 See `org-xhtml-entity-format-callbacks-alist' for more information."
1864 (when (and (member org-lparse-debug
'(t format
))
1865 (not (equal entity
'COMMENT
)))
1866 (insert (org-lparse-format 'COMMENT
"%s: %S" entity args
)))
1869 (let ((text (pop args
)))
1870 (apply 'org-lparse-format
'TAGS entity text args
)))
1872 (let ((f (cdr (assoc entity org-lparse-entity-format-callbacks-alist
))))
1873 (unless f
(error "Unknown entity: %s" entity
))
1876 (defun org-lparse-insert (entity &rest args
)
1877 (insert (apply 'org-lparse-format entity args
)))
1879 (defun org-lparse-prepare-toc (lines level-offset opt-plist umax-toc
)
1880 (let* ((quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1881 (org-min-level (org-get-min-level lines level-offset
))
1882 (org-last-level org-min-level
)
1885 (org-lparse-bind-local-variables opt-plist
)
1887 (org-lparse-begin 'TOC
(nth 3 (plist-get opt-plist
:lang-words
)) umax-toc
)
1892 (when (and (string-match org-todo-line-regexp line
)
1893 (not (get-text-property 0 'org-protected line
))
1894 (<= (setq level
(org-tr-level
1895 (- (match-end 1) (match-beginning 1)
1898 (let ((txt (save-match-data
1899 (org-xml-encode-org-text-skip-links
1900 (org-export-cleanup-toc-line
1901 (match-string 3 line
)))))
1903 org-export-mark-todo-in-toc
1904 (or (and (match-beginning 2)
1905 (not (member (match-string 2 line
)
1906 org-done-keywords
)))
1907 (and (= level umax-toc
)
1908 (org-search-todo-below
1909 line lines level
)))))
1911 ;; Check for targets
1912 (while (string-match org-any-target-regexp line
)
1915 (let ((org-lparse-encode-pending t
))
1916 (org-lparse-format 'FONTIFY
1917 (match-string 1 line
) "target"))
1920 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1921 (setq tags
(match-string 1 txt
)
1922 txt
(replace-match "" t nil txt
)))
1923 (when (string-match quote-re0 txt
)
1924 (setq txt
(replace-match "" t t txt
)))
1925 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1926 (setq txt
(replace-match "" t t txt
)))
1929 (let* ((snumber (org-section-number level
))
1930 (href (replace-regexp-in-string
1931 "\\." "-" (format "sec-%s" snumber
)))
1935 href org-export-preferred-target-alist
))
1937 (href (org-solidify-link-text href
)))
1938 (org-lparse-format 'TOC-ENTRY snumber todo txt tags href
))
1939 level org-last-level
)
1940 (setq org-last-level level
)))
1943 (org-lparse-end 'TOC
)
1944 (setq org-lparse-toc
(buffer-string))))
1947 (defun org-lparse-format-table-row (fields &optional text-for-empty-fields
)
1948 (if org-lparse-table-ncols
1949 ;; second and subsequent rows of the table
1950 (when (and org-lparse-list-table-p
1951 (> (length fields
) org-lparse-table-ncols
))
1952 (error "Table row has %d columns but header row claims %d columns"
1953 (length fields
) org-lparse-table-ncols
))
1954 ;; first row of the table
1955 (setq org-lparse-table-ncols
(length fields
))
1956 (when org-lparse-table-is-styled
1957 (setq org-lparse-table-num-numeric-items-per-column
1958 (make-vector org-lparse-table-ncols
0))
1959 (setq org-lparse-table-colalign-vector
1960 (make-vector org-lparse-table-ncols nil
))
1962 (while (< (incf c
) org-lparse-table-ncols
)
1963 (let* ((col-cookie (cdr (assoc (1+ c
) org-lparse-table-colalign-info
)))
1964 (align (nth 0 col-cookie
)))
1965 (setf (aref org-lparse-table-colalign-vector c
)
1967 ((string= align
"l") "left")
1968 ((string= align
"r") "right")
1969 ((string= align
"c") "center")
1971 (incf org-lparse-table-rownum
)
1977 (when (and (string= x
"") text-for-empty-fields
)
1978 (setq x text-for-empty-fields
))
1980 (let (col-cookie horiz-span
)
1981 (when org-lparse-table-is-styled
1982 (when (and (< i org-lparse-table-ncols
)
1983 (string-match org-table-number-regexp x
))
1984 (incf (aref org-lparse-table-num-numeric-items-per-column i
)))
1985 (setq col-cookie
(cdr (assoc (1+ i
) org-lparse-table-colalign-info
))
1986 horiz-span
(nth 1 col-cookie
)))
1988 'TABLE-CELL x org-lparse-table-rownum i
(or horiz-span
0))))
1991 (defun org-lparse-get (what &optional opt-plist
)
1992 "Query for value of WHAT for the current backend `org-lparse-backend'.
1993 See also `org-lparse-backend-get'."
1994 (if (boundp 'org-lparse-backend
)
1995 (org-lparse-backend-get (symbol-name org-lparse-backend
) what opt-plist
)
1996 (error "org-lparse-backend is not bound yet")))
1998 (defun org-lparse-backend-get (backend what
&optional opt-plist
)
1999 "Query BACKEND for value of WHAT.
2000 Dispatch the call to `org-<backend>-user-get'. If that throws an
2001 error, dispatch the call to `org-<backend>-get'. See
2002 `org-xhtml-get' for all known settings queried for by
2003 `org-lparse' during the course of export."
2004 (assert (stringp backend
) t
)
2005 (unless (org-lparse-backend-is-native-p backend
)
2006 (error "Unknown native backend %s" backend
))
2007 (let ((backend-get-method (intern (format "org-%s-get" backend
)))
2008 (backend-user-get-method (intern (format "org-%s-user-get" backend
))))
2010 ((functionp backend-get-method
)
2012 (funcall backend-user-get-method what opt-plist
)
2013 (error (funcall backend-get-method what opt-plist
))))
2015 (error "Native backend %s doesn't define %s" backend backend-get-method
)))))
2017 (defun org-lparse-insert-tag (tag &rest args
)
2018 (when (member org-lparse-insert-tag-with-newlines
'(lead both
))
2020 (insert (apply 'format tag args
))
2021 (when (member org-lparse-insert-tag-with-newlines
'(trail both
))
2024 (defun org-lparse-get-targets-from-title (title)
2025 (let* ((target (org-get-text-property-any 0 'target title
))
2026 (extra-targets (assoc target org-export-target-aliases
))
2027 (target (or (cdr (assoc target org-export-preferred-target-alist
))
2029 (cons target
(remove target extra-targets
))))
2031 (defun org-lparse-suffix-from-snumber (snumber)
2032 (let* ((snu (replace-regexp-in-string "\\." "-" snumber
))
2033 (href (cdr (assoc (concat "sec-" snu
)
2034 org-export-preferred-target-alist
))))
2035 (org-solidify-link-text (or href snu
))))
2037 (defun org-lparse-begin-level (level title umax head-count
)
2038 "Insert a new LEVEL in HTML export.
2039 When TITLE is nil, just close all open levels."
2040 (org-lparse-end-level level umax
)
2041 (unless title
(error "Why is heading nil"))
2042 (let* ((targets (org-lparse-get-targets-from-title title
))
2043 (target (car targets
)) (extra-targets (cdr targets
))
2044 (target (and target
(org-solidify-link-text target
)))
2045 (extra-class (org-get-text-property-any 0 'html-container-class title
))
2046 snumber tags level1 class
)
2047 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2048 (setq tags
(and org-export-with-tags
(match-string 1 title
)))
2049 (setq title
(replace-match "" t t title
)))
2052 (if (aref org-levels-open
(1- level
))
2053 (org-lparse-end-list-item-1)
2054 (aset org-levels-open
(1- level
) t
)
2055 (org-lparse-end-paragraph)
2056 (org-lparse-begin-list 'unordered
))
2057 (org-lparse-begin-list-item
2058 'unordered target
(org-lparse-format
2059 'HEADLINE title extra-targets tags
)))
2060 (aset org-levels-open
(1- level
) t
)
2061 (setq snumber
(org-section-number level
))
2062 (setq level1
(+ level
(or (org-lparse-get 'TOPLEVEL-HLEVEL
) 1) -
1))
2063 (unless (= head-count
1)
2064 (org-lparse-end-outline-text-or-outline))
2065 (org-lparse-begin-outline-and-outline-text
2066 level1 snumber title tags target extra-targets extra-class
)
2067 (org-lparse-begin-paragraph))))
2069 (defun org-lparse-end-level (level umax
)
2070 (org-lparse-end-paragraph)
2071 (loop for l from org-level-max downto level
2072 do
(when (aref org-levels-open
(1- l
))
2073 ;; Terminate one level in HTML export
2075 (org-lparse-end-outline-text-or-outline)
2076 (org-lparse-end-list-item-1)
2077 (org-lparse-end-list 'unordered
))
2078 (aset org-levels-open
(1- l
) nil
))))
2080 (defvar org-lparse-outline-text-open
)
2081 (defun org-lparse-begin-outline-and-outline-text (level1 snumber title tags
2082 target extra-targets
2085 'OUTLINE level1 snumber title tags target extra-targets extra-class
)
2086 (org-lparse-begin-outline-text level1 snumber extra-class
))
2088 (defun org-lparse-end-outline-text-or-outline ()
2090 (org-lparse-outline-text-open
2091 (org-lparse-end 'OUTLINE-TEXT
)
2092 (setq org-lparse-outline-text-open nil
))
2093 (t (org-lparse-end 'OUTLINE
))))
2095 (defun org-lparse-begin-outline-text (level1 snumber extra-class
)
2096 (assert (not org-lparse-outline-text-open
) t
)
2097 (setq org-lparse-outline-text-open t
)
2098 (org-lparse-begin 'OUTLINE-TEXT level1 snumber extra-class
))
2100 (defun org-lparse-html-list-type-to-canonical-list-type (ltype)
2101 (cdr (assoc ltype
'(("o" . ordered
)
2103 ("d" . description
)))))
2105 ;; following vars are bound during `org-do-lparse'
2106 (defvar org-lparse-list-stack
)
2107 (defvar org-lparse-list-table
:table-row
)
2108 (defvar org-lparse-list-table
:lines
)
2110 ;; Notes on LIST-TABLES
2111 ;; ====================
2112 ;; Lists withing "list-table" blocks (as shown below)
2114 ;; #+begin_list-table
2125 ;; will be exported as though it were a table as shown below.
2127 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
2128 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
2130 ;; Note that org-tables are NOT multi-line and each line is mapped to
2131 ;; a unique row in the exported document. So if an exported table
2132 ;; needs to contain a single paragraph (with copious text) it needs to
2133 ;; be typed up in a single line. Editing such long lines using the
2134 ;; table editor will be a cumbersome task. Furthermore inclusion of
2135 ;; multi-paragraph text in a table cell is well-nigh impossible.
2137 ;; LIST-TABLEs are meant to circumvent the above problems with
2140 ;; Note that in the example above the list items could be paragraphs
2141 ;; themselves and the list can be arbitrarily deep.
2143 ;; Inspired by following thread:
2144 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
2146 (defun org-lparse-begin-list (ltype)
2147 (push ltype org-lparse-list-stack
)
2148 (let ((list-level (length org-lparse-list-stack
)))
2150 ((not org-lparse-list-table-p
)
2151 (org-lparse-begin 'LIST ltype
))
2152 ;; process LIST-TABLE
2155 (setq org-lparse-list-table
:lines nil
)
2156 (setq org-lparse-list-table
:table-row nil
))
2160 (org-lparse-begin 'LIST ltype
)))))
2162 (defun org-lparse-end-list (ltype)
2163 (pop org-lparse-list-stack
)
2164 (let ((list-level (length org-lparse-list-stack
)))
2166 ((not org-lparse-list-table-p
)
2167 (org-lparse-end 'LIST ltype
))
2168 ;; process LIST-TABLE
2171 (insert (org-lparse-format-list-table
2172 (nreverse org-lparse-list-table
:lines
))))
2176 (org-lparse-end 'LIST ltype
)))))
2178 (defun org-lparse-begin-list-item (ltype &optional arg headline
)
2179 (let ((list-level (length org-lparse-list-stack
)))
2181 ((not org-lparse-list-table-p
)
2182 (org-lparse-begin 'LIST-ITEM ltype arg headline
))
2183 ;; process LIST-TABLE
2185 ;; begin TABLE-ROW for LIST-TABLE
2186 (setq org-lparse-list-table
:table-row nil
)
2187 (org-lparse-begin-list-table:table-cell
))
2189 ;; begin TABLE-CELL for LIST-TABLE
2190 (org-lparse-begin-list-table:table-cell
))
2192 (org-lparse-begin 'LIST-ITEM ltype arg headline
)))))
2194 (defun org-lparse-end-list-item (ltype)
2195 (let ((list-level (length org-lparse-list-stack
)))
2197 ((not org-lparse-list-table-p
)
2198 (org-lparse-end 'LIST-ITEM ltype
))
2199 ;; process LIST-TABLE
2201 ;; end TABLE-ROW for LIST-TABLE
2202 (org-lparse-end-list-table:table-cell
)
2203 (push (nreverse org-lparse-list-table
:table-row
)
2204 org-lparse-list-table
:lines
))
2206 ;; end TABLE-CELL for LIST-TABLE
2207 (org-lparse-end-list-table:table-cell
))
2209 (org-lparse-end 'LIST-ITEM ltype
)))))
2211 (defvar org-lparse-list-table
:table-cell-open
)
2212 (defun org-lparse-begin-list-table:table-cell
()
2213 (org-lparse-end-list-table:table-cell
)
2214 (setq org-lparse-list-table
:table-cell-open t
)
2215 (org-lparse-begin-collect)
2216 (org-lparse-begin-paragraph))
2218 (defun org-lparse-end-list-table:table-cell
()
2219 (when org-lparse-list-table
:table-cell-open
2220 (setq org-lparse-list-table
:table-cell-open nil
)
2221 (org-lparse-end-paragraph)
2222 (push (org-lparse-end-collect)
2223 org-lparse-list-table
:table-row
)))
2225 (defvar org-lparse-table-rowgrp-info
)
2226 (defun org-lparse-begin-table-rowgroup (&optional is-header-row
)
2227 (push (cons (1+ org-lparse-table-rownum
) :start
) org-lparse-table-rowgrp-info
)
2228 (org-lparse-begin 'TABLE-ROWGROUP is-header-row
))
2230 (defun org-lparse-end-table ()
2231 (when org-lparse-table-is-styled
2233 (unless (car org-table-colgroup-info
)
2234 (setq org-table-colgroup-info
2235 (cons :start
(cdr org-table-colgroup-info
))))
2242 (setf (aref org-lparse-table-colalign-vector c
)
2243 (or (aref org-lparse-table-colalign-vector c
)
2244 (if (> (/ (float x
) (1+ org-lparse-table-rownum
))
2245 org-table-number-fraction
)
2247 org-lparse-table-num-numeric-items-per-column
)))
2248 (org-lparse-end 'TABLE
))
2250 (defvar org-lparse-encode-pending nil
)
2252 (defun org-lparse-format-tags (tag text prefix suffix
&rest args
)
2255 (concat prefix
(apply 'format
(car tag
) args
) text suffix
2256 (format (cdr tag
))))
2257 ((stringp tag
) ; singleton tag
2258 (concat prefix
(apply 'format tag args
) text
))))
2260 (defun org-xml-fix-class-name (kwd) ; audit callers of this function
2261 "Turn todo keyword into a valid class name.
2262 Replaces invalid characters with \"_\"."
2264 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2265 (setq kwd
(replace-match "_" t t kwd
))))
2268 (defun org-lparse-format-todo (todo)
2269 (org-lparse-format 'FONTIFY
2271 (ignore-errors (org-lparse-get 'TODO-KWD-CLASS-PREFIX
))
2272 (org-xml-fix-class-name todo
))
2273 (list (if (member todo org-done-keywords
) "done" "todo")
2276 (defun org-lparse-format-extra-targets (extra-targets)
2277 (if (not extra-targets
) ""
2278 (mapconcat (lambda (x)
2279 (setq x
(org-solidify-link-text
2280 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2281 (org-lparse-format 'ANCHOR
"" x
))
2284 (defun org-lparse-format-org-tags (tags)
2292 (ignore-errors (org-lparse-get 'TAG-CLASS-PREFIX
))
2293 (org-xml-fix-class-name x
))))
2294 (org-split-string tags
":")
2295 (org-lparse-format 'SPACES
1)) "tag")))
2297 (defun org-lparse-format-section-number (&optional snumber level
)
2298 (and org-export-with-section-numbers
2299 (not org-lparse-body-only
) snumber level
2300 (org-lparse-format 'FONTIFY snumber
(format "section-number-%d" level
))))
2302 (defun org-lparse-warn (msg)
2303 (if (not org-lparse-use-flashy-warning
)
2305 (put-text-property 0 (length msg
) 'face
'font-lock-warning-face msg
)
2309 (defun org-xml-format-href (s)
2310 "Make sure the S is valid as a href reference in an XHTML document."
2313 (while (string-match "&" s start
)
2314 (setq start
(+ (match-beginning 0) 3)
2315 s
(replace-match "&" t t s
)))))
2318 (defun org-xml-format-desc (s)
2319 "Make sure the S is valid as a description in a link."
2320 (if (and s
(not (get-text-property 1 'org-protected s
)))
2322 (org-xml-encode-org-text s
))
2325 (provide 'org-lparse
)
2327 ;;; org-lparse.el ends here