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 (program (car convert-process
))
488 (dummy (and (or program
(error "Converter not configured"))
489 (or (executable-find program
)
490 (error "Cannot find converter %s" program
))))
491 (out-file (concat (file-name-sans-extension in-file
) "."
492 (nth 1 (or (cdr how
) out-fmt
))))
493 (out-dir (file-name-directory in-file
))
494 (arglist (mapcar (lambda (arg)
496 arg
`((?i .
,in-file
)
497 (?I .
,(browse-url-file-url in-file
))
500 (?O .
,(browse-url-file-url out-file
))
502 (?D .
,(browse-url-file-url out-dir
)))))
503 (cdr convert-process
))))
504 (when (file-exists-p out-file
)
505 (delete-file out-file
))
507 (message "Executing %s %s" program
(mapconcat 'identity arglist
" "))
508 (apply 'call-process program nil nil nil arglist
)
510 ((file-exists-p out-file
)
511 (message "Exported to %s using %s" out-file program
)
513 (message "Opening %s..." out-file
)
514 (org-open-file out-file
))
516 ;; (set-buffer (find-file-noselect out-file))
519 (message "Export to %s failed" out-file
)
522 (defvar org-lparse-insert-tag-with-newlines
'both
)
524 ;; Following variables are let-bound during `org-lparse'
525 (defvar org-lparse-dyn-first-heading-pos
)
526 (defvar org-lparse-toc
)
527 (defvar org-lparse-entity-control-callbacks-alist
)
528 (defvar org-lparse-entity-format-callbacks-alist
)
529 (defvar org-lparse-backend nil
530 "The native backend to which the document is currently exported.
531 This variable is let bound during `org-lparse'. Valid values are
532 one of the symbols corresponding to `org-lparse-native-backends'.
534 Compare this variable with `org-export-current-backend' which is
535 bound only during `org-export-preprocess-string' stage of the
538 See also `org-lparse-other-backend'.")
540 (defvar org-lparse-other-backend nil
541 "The target backend to which the document is currently exported.
542 This variable is let bound during `org-lparse'. This variable is
543 set to either `org-lparse-backend' or one of the symbols
544 corresponding to OTHER-BACKENDS specification of the
547 For example, if a document is exported to \"odt\" then both
548 org-lparse-backend and org-lparse-other-backend are bound to
549 'odt. On the other hand, if a document is exported to \"odt\"
550 and then converted to \"doc\" then org-lparse-backend is set to
551 'odt and org-lparse-other-backend is set to 'doc.")
553 (defvar org-lparse-body-only nil
554 "Bind this to BODY-ONLY arg of `org-lparse'.")
556 (defvar org-lparse-to-buffer nil
557 "Bind this to TO-BUFFER arg of `org-lparse'.")
559 (defun org-lparse-get-block-params (params)
562 (setq params
(org-trim params
))
563 (unless (string-match "\\`(.*)\\'" params
)
564 (setq params
(format "(%s)" params
)))
565 (ignore-errors (read params
)))))
567 (defvar org-heading-keyword-regexp-format
) ; defined in org.el
568 (defvar org-lparse-special-blocks
'("list-table" "annotation"))
569 (defun org-do-lparse (arg &optional hidden ext-plist
570 to-buffer body-only pub-dir
)
571 "Export the outline to various formats.
572 See `org-lparse' for more information. This function is a
573 html-agnostic version of the `org-export-as-html' function in 7.5
575 ;; Make sure we have a file name when we need it.
576 (when (and (not (or to-buffer body-only
))
577 (not buffer-file-name
))
578 (if (buffer-base-buffer)
579 (org-set-local 'buffer-file-name
580 (with-current-buffer (buffer-base-buffer)
582 (error "Need a file name to be able to export")))
585 (format "Exporting to %s using org-lparse..."
587 (or org-lparse-backend org-lparse-other-backend
)))))
589 (setq-default org-todo-line-regexp org-todo-line-regexp
)
590 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
591 (setq-default org-done-keywords org-done-keywords
)
592 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
593 (let* (hfy-user-sheet-assoc ; let `htmlfontify' know that
594 ; we are interested in
596 org-lparse-encode-pending
598 (org-lparse-par-open-stashed 0)
601 (org-lparse-list-stack '())
603 ;; list-table related vars
604 org-lparse-list-table-p
605 org-lparse-list-table
:table-cell-open
606 org-lparse-list-table
:table-row
607 org-lparse-list-table
:lines
609 org-lparse-outline-text-open
610 (org-lparse-latex-fragment-fallback ; currently used only by
612 (or (ignore-errors (org-lparse-get 'LATEX-FRAGMENT-FALLBACK
))
613 (if (and (org-check-external-command "latex" "" t
)
614 (org-check-external-command "dvipng" "" t
))
617 (org-lparse-insert-tag-with-newlines 'both
)
618 (org-lparse-to-buffer to-buffer
)
619 (org-lparse-body-only body-only
)
620 (org-lparse-entity-control-callbacks-alist
621 (org-lparse-get 'ENTITY-CONTROL
))
622 (org-lparse-entity-format-callbacks-alist
623 (org-lparse-get 'ENTITY-FORMAT
))
625 (org-export-process-option-filters
626 (org-combine-plists (org-default-export-plist)
628 (org-infile-export-plist))))
629 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
630 valid org-lparse-dyn-first-heading-pos
631 (odd org-odd-levels-only
)
632 (region-p (org-region-active-p))
633 (rbeg (and region-p
(region-beginning)))
634 (rend (and region-p
(region-end)))
636 (if (plist-get opt-plist
:ignore-subtree-p
)
641 (and (org-at-heading-p)
642 (>= (org-end-of-subtree t t
) rend
))))))
643 (level-offset (if subtree-p
646 (+ (funcall outline-level
)
647 (if org-odd-levels-only
1 0)))
649 (opt-plist (setq org-export-opt-plist
651 (org-export-add-subtree-options opt-plist rbeg
)
653 ;; The following two are dynamically scoped into other
655 (org-current-export-dir
656 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
)))
657 (org-current-export-file buffer-file-name
)
658 (level 0) (line "") (origline "") txt todo
661 (filename (if to-buffer nil
664 (file-name-sans-extension
666 (org-entry-get (region-beginning)
667 "EXPORT_FILE_NAME" t
))
668 (file-name-nondirectory buffer-file-name
)))
669 "." (org-lparse-get 'FILE-NAME-EXTENSION opt-plist
))
670 (file-name-as-directory
671 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
))))))
672 (current-dir (if buffer-file-name
673 (file-name-directory buffer-file-name
)
675 (auto-insert nil
) ; Avoid any auto-insert stuff for the new file
676 (buffer (if to-buffer
678 ((eq to-buffer
'string
)
679 (get-buffer-create (org-lparse-get 'EXPORT-BUFFER-NAME
)))
680 (t (get-buffer-create to-buffer
)))
682 (or (let ((f (org-lparse-get 'INIT-METHOD
)))
683 (and f
(functionp f
) (funcall f filename
)))
685 (org-levels-open (make-vector org-level-max nil
))
688 (let* ((val (plist-get opt-plist p
))
689 (val (org-xml-encode-org-text-skip-links val
)))
690 (setq opt-plist
(plist-put opt-plist p val
))))
691 '(:date
:author
:keywords
:description
)))
692 (date (plist-get opt-plist
:date
))
694 ((and date
(string-match "%" date
))
695 (format-time-string date
))
697 (t (format-time-string "%Y-%m-%d %T %Z"))))
698 (dummy (setq opt-plist
(plist-put opt-plist
:effective-date date
)))
699 (title (org-xml-encode-org-text-skip-links
700 (or (and subtree-p
(org-export-get-title-from-subtree))
701 (plist-get opt-plist
:title
)
704 (plist-get opt-plist
:skip-before-1st-heading
))
705 (org-export-grab-title-from-buffer))
706 (and buffer-file-name
707 (file-name-sans-extension
708 (file-name-nondirectory buffer-file-name
)))
710 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
711 (html-table-tag (plist-get opt-plist
:html-table-tag
))
712 (quote-re0 (concat "^ *" org-quote-string
"\\( +\\|[ \t]*$\\)"))
713 (quote-re (format org-heading-keyword-regexp-format
715 (org-lparse-dyn-current-environment nil
)
716 ;; Get the language-dependent settings
717 (lang-words (or (assoc (plist-get opt-plist
:language
)
718 org-export-language-setup
)
719 (assoc "en" org-export-language-setup
)))
720 (dummy (setq opt-plist
(plist-put opt-plist
:lang-words lang-words
)))
723 (coding-system-for-write
724 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-WRITE
))
725 (and (boundp 'buffer-file-coding-system
)
726 buffer-file-coding-system
)))
727 (save-buffer-coding-system
728 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-SAVE
))
729 (and (boundp 'buffer-file-coding-system
)
730 buffer-file-coding-system
)))
733 (if region-p
(region-beginning) (point-min))
734 (if region-p
(region-end) (point-max))))
735 (org-export-have-math nil
)
736 (org-export-footnotes-seen nil
)
737 (org-export-footnotes-data (org-footnote-all-labels 'with-defs
))
738 (org-footnote-insert-pos-for-preprocessor 'point-min
)
739 (org-lparse-opt-plist opt-plist
)
742 (org-export-preprocess-string
745 :for-backend
(if (equal org-lparse-backend
'xhtml
) ; hack
748 :skip-before-1st-heading
749 (plist-get opt-plist
:skip-before-1st-heading
)
750 :drawers
(plist-get opt-plist
:drawers
)
751 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
752 :tasks
(plist-get opt-plist
:tasks
)
753 :tags
(plist-get opt-plist
:tags
)
754 :priority
(plist-get opt-plist
:priority
)
755 :footnotes
(plist-get opt-plist
:footnotes
)
756 :timestamps
(plist-get opt-plist
:timestamps
)
758 (plist-get opt-plist
:archived-trees
)
759 :select-tags
(plist-get opt-plist
:select-tags
)
760 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
762 (plist-get opt-plist
:text
)
764 (plist-get opt-plist
:LaTeX-fragments
))
767 table-buffer table-orig-buffer
769 rpl path attr desc descp desc1 desc2 link
771 footnotes footref-seen
772 org-lparse-output-buffer
773 org-lparse-footnote-definitions
774 org-lparse-footnote-number
776 org-lparse-collect-buffer
777 (org-lparse-collect-count 0) ; things will get haywire if
778 ; collections are chained. Use
779 ; this variable to assert this
785 (let ((inhibit-read-only t
))
787 (remove-text-properties (point-min) (point-max)
788 '(:org-license-to-kill t
))))
790 (message "Exporting...")
791 (org-init-section-numbers)
793 ;; Switch to the output buffer
794 (setq org-lparse-output-buffer buffer
)
795 (set-buffer org-lparse-output-buffer
)
796 (let ((inhibit-read-only t
)) (erase-buffer))
798 (org-install-letbind)
800 (and (fboundp 'set-buffer-file-coding-system
)
801 (set-buffer-file-coding-system coding-system-for-write
))
803 (let ((case-fold-search nil
)
804 (org-odd-levels-only odd
))
805 ;; create local variables for all options, to make sure all called
806 ;; functions get the correct information
808 (set (make-local-variable (nth 2 x
))
809 (plist-get opt-plist
(car x
))))
810 org-export-plist-vars
)
811 (setq umax
(if arg
(prefix-numeric-value arg
)
812 org-export-headline-levels
))
813 (setq umax-toc
(if (integerp org-export-with-toc
)
814 (min org-export-with-toc umax
)
817 (when (and org-export-with-toc
(not body-only
))
818 (setq lines
(org-lparse-prepare-toc
819 lines level-offset opt-plist umax-toc
)))
822 (org-lparse-begin 'DOCUMENT-CONTENT opt-plist
)
823 (org-lparse-begin 'DOCUMENT-BODY opt-plist
))
826 (org-init-section-numbers)
828 (org-lparse-begin-paragraph)
830 (while (setq line
(pop lines
) origline line
)
832 (when (and (org-lparse-current-environment-p 'quote
)
833 (string-match org-outline-regexp-bol line
))
834 (org-lparse-end-environment 'quote
))
836 (when (org-lparse-current-environment-p 'quote
)
837 (org-lparse-insert 'LINE line
)
838 (throw 'nextline nil
))
840 ;; Fixed-width, verbatim lines (examples)
841 (when (and org-export-with-fixed-width
842 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
843 (when (not (org-lparse-current-environment-p 'fixedwidth
))
844 (org-lparse-begin-environment 'fixedwidth
))
845 (org-lparse-insert 'LINE
(match-string 3 line
))
846 (when (or (not lines
)
847 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
849 (org-lparse-end-environment 'fixedwidth
))
850 (throw 'nextline nil
))
852 ;; Notes: The baseline version of org-html.el (git commit
853 ;; 3d802e), while encountering a *line-long* protected text,
854 ;; does one of the following two things based on the state
855 ;; of the export buffer.
857 ;; 1. If a paragraph element has just been opened and
858 ;; contains only whitespace as content, insert the
859 ;; protected text as part of the previous paragraph.
861 ;; 2. If the paragraph element has already been opened and
862 ;; contains some valid content insert the protected text
863 ;; as part of the current paragraph.
867 ;; Scenario 1 mentioned above kicks in when a block of
868 ;; protected text has to be inserted en bloc. For example,
869 ;; this happens, when inserting an source or example block
870 ;; or preformatted content enclosed in #+backend,
871 ;; #+begin_backend ... #+end_backend)
873 ;; Scenario 2 mentioned above kicks in when the protected
874 ;; text is part of a running sentence. For example this
875 ;; happens in the case of an *multiline* LaTeX equation that
876 ;; needs to be inserted verbatim.
878 ;; org-html.el in the master branch seems to do some
879 ;; jugglery by moving paragraphs around. Inorder to make
880 ;; these changes backend-agnostic introduce a new text
881 ;; property org-native-text and impose the added semantics
882 ;; that these protected blocks appear outside of a
883 ;; conventional paragraph element.
885 ;; Extra Note: Check whether org-example and org-native-text
886 ;; are entirely equivalent.
888 ;; Fixes bug reported by Christian Moe concerning verbatim
890 ;; on git commit 533ba3f90250a1f25f494c390d639ea6274f235c
891 ;; http://repo.or.cz/w/org-mode/org-jambu.git/shortlog/refs/heads/staging
892 ;; See http://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01379.html
895 (when (and (get-text-property 0 'org-native-text line
)
896 ;; Make sure it is the entire line that is protected
897 (not (< (or (next-single-property-change
898 0 'org-native-text line
) 10000)
900 (let ((ind (get-text-property 0 'original-indentation line
)))
901 (org-lparse-begin-environment 'native
)
902 (org-lparse-insert 'LINE line
)
904 (or (= (length (car lines
)) 0)
906 (equal ind
(get-text-property
907 0 'original-indentation
(car lines
))))
908 (or (= (length (car lines
)) 0)
909 (get-text-property 0 'org-native-text
(car lines
))))
910 (org-lparse-insert 'LINE
(pop lines
)))
911 (org-lparse-end-environment 'native
))
912 (throw 'nextline nil
))
915 (when (and (get-text-property 0 'org-protected line
)
916 ;; Make sure it is the entire line that is protected
917 (not (< (or (next-single-property-change
918 0 'org-protected line
) 10000)
920 (let ((ind (get-text-property 0 'original-indentation line
)))
921 (org-lparse-insert 'LINE line
)
923 (or (= (length (car lines
)) 0)
925 (equal ind
(get-text-property
926 0 'original-indentation
(car lines
))))
927 (or (= (length (car lines
)) 0)
928 (get-text-property 0 'org-protected
(car lines
))))
929 (org-lparse-insert 'LINE
(pop lines
))))
930 (throw 'nextline nil
))
932 ;; Blockquotes, verse, and center
934 "^ORG-\\(.+\\)-\\(START\\|END\\)\\([ \t]+.*\\)?$" line
)
935 (let* ((style (intern (downcase (match-string 1 line
))))
936 (env-options-plist (org-lparse-get-block-params
937 (match-string 3 line
)))
938 (f (cdr (assoc (match-string 2 line
)
939 '(("START" . org-lparse-begin-environment
)
940 ("END" . org-lparse-end-environment
))))))
943 '(blockquote verse center
)
944 (mapcar 'intern org-lparse-special-blocks
)))
945 (funcall f style env-options-plist
)
946 (throw 'nextline nil
))))
948 (run-hooks 'org-export-html-after-blockquotes-hook
)
949 (when (org-lparse-current-environment-p 'verse
)
950 (let ((i (org-get-string-indentation line
)))
953 (let ((org-lparse-encode-pending t
))
954 (org-lparse-format 'SPACES
(* 2 i
)))
955 " " (org-trim line
))))
956 (unless (string-match "\\\\\\\\[ \t]*$" line
)
957 (setq line
(concat line
"\\\\")))))
959 ;; make targets to anchors
962 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
964 ((get-text-property (match-beginning 1) 'org-protected line
)
965 (setq start
(match-end 1)))
967 (setq line
(replace-match
968 (let ((org-lparse-encode-pending t
))
970 'ANCHOR
"" (org-solidify-link-text
971 (match-string 1 line
))))
973 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
974 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
975 (setq line
(replace-match
976 (let ((org-lparse-encode-pending t
))
978 'FONTIFY
(match-string 1 line
) "target"))
979 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
982 (setq line
(replace-match
984 (let ((org-lparse-encode-pending t
))
986 'ANCHOR
(match-string 1 line
)
987 (org-solidify-link-text (match-string 1 line
))
991 (let ((org-lparse-encode-pending t
))
992 (setq line
(org-lparse-handle-time-stamps line
)))
994 ;; replace "&" by "&", "<" and ">" by "<" and ">"
995 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
996 ;; Also handle sub_superscripts and checkboxes
997 (or (string-match org-table-hline-regexp line
)
998 (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line
)
999 (setq line
(org-xml-encode-org-text-skip-links line
)))
1001 (setq line
(org-lparse-format-org-link line opt-plist
))
1004 (if (and org-todo-line-regexp
1005 (string-match org-todo-line-regexp line
)
1006 (match-beginning 2))
1008 (substring line
0 (match-beginning 2))
1009 (org-lparse-format 'TODO
(match-string 2 line
))
1010 (substring line
(match-end 2)))))
1012 ;; Does this contain a reference to a footnote?
1013 (when org-export-with-footnotes
1015 (while (string-match "\\([^* \t].*?\\)[ \t]*\\[\\([0-9]+\\)\\]" line start
)
1016 ;; Discard protected matches not clearly identified as
1017 ;; footnote markers.
1018 (if (or (get-text-property (match-beginning 2) 'org-protected line
)
1019 (not (get-text-property (match-beginning 2) 'org-footnote line
)))
1020 (setq start
(match-end 2))
1021 (let ((n (match-string 2 line
)) refcnt a
)
1022 (if (setq a
(assoc n footref-seen
))
1024 (setcdr a
(1+ (cdr a
)))
1025 (setq refcnt
(cdr a
)))
1027 (push (cons n
1) footref-seen
))
1031 (or (match-string 1 line
) "")
1034 n
(cdr (assoc n org-lparse-footnote-definitions
))
1036 ;; If another footnote is following the
1037 ;; current one, add a separator.
1038 (if (save-match-data
1039 (string-match "\\`\\[[0-9]+\\]"
1040 (substring line
(match-end 0))))
1042 (org-lparse-get 'FOOTNOTE-SEPARATOR
))
1047 ((string-match "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$" line
)
1048 ;; This is a headline
1049 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1051 txt
(match-string 2 line
))
1052 (if (string-match quote-re0 txt
)
1053 (setq txt
(replace-match "" t t txt
)))
1054 (if (<= level
(max umax umax-toc
))
1055 (setq head-count
(+ head-count
1)))
1056 (unless org-lparse-dyn-first-heading-pos
1057 (setq org-lparse-dyn-first-heading-pos
(point)))
1058 (org-lparse-begin-level level txt umax head-count
)
1061 (when (string-match quote-re line
)
1062 (org-lparse-begin-environment 'quote
)))
1064 ((and org-export-with-tables
1065 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1066 (when (not table-open
)
1068 (setq table-open t table-buffer nil table-orig-buffer nil
))
1071 (setq table-buffer
(cons line table-buffer
)
1072 table-orig-buffer
(cons origline table-orig-buffer
))
1073 (when (or (not lines
)
1074 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1076 (setq table-open nil
1077 table-buffer
(nreverse table-buffer
)
1078 table-orig-buffer
(nreverse table-orig-buffer
))
1079 (org-lparse-end-paragraph)
1080 (when org-lparse-list-table-p
1081 (error "Regular tables are not allowed in a list-table block"))
1082 (org-lparse-insert 'TABLE table-buffer table-orig-buffer
)))
1086 ;; This line either is list item or end a list.
1087 (when (get-text-property 0 'list-item line
)
1088 (setq line
(org-lparse-export-list-line
1090 (get-text-property 0 'list-item line
)
1091 (get-text-property 0 'list-struct line
)
1092 (get-text-property 0 'list-prevs line
))))
1095 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1096 (with-org-lparse-preserve-paragraph-state
1097 (org-lparse-insert 'HORIZONTAL-LINE
))
1098 (throw 'nextline nil
))
1100 ;; Empty lines start a new paragraph. If hand-formatted lists
1101 ;; are not fully interpreted, lines starting with "-", "+", "*"
1102 ;; also start a new paragraph.
1103 (when (string-match "^ [-+*]-\\|^[ \t]*$" line
)
1104 (when org-lparse-footnote-number
1105 (org-lparse-end-footnote-definition org-lparse-footnote-number
)
1106 (setq org-lparse-footnote-number nil
))
1107 (org-lparse-begin-paragraph))
1109 ;; Is this the start of a footnote?
1110 (when org-export-with-footnotes
1111 (when (and (boundp 'footnote-section-tag-regexp
)
1112 (string-match (concat "^" footnote-section-tag-regexp
)
1115 (throw 'nextline nil
))
1116 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1117 (org-lparse-end-paragraph)
1118 (setq org-lparse-footnote-number
(match-string 1 line
))
1119 (setq line
(replace-match "" t t line
))
1120 (org-lparse-begin-footnote-definition org-lparse-footnote-number
)))
1121 ;; Check if the line break needs to be conserved
1123 ((string-match "\\\\\\\\[ \t]*$" line
)
1124 (setq line
(replace-match
1125 (org-lparse-format 'LINE-BREAK
)
1127 (org-export-preserve-breaks
1128 (setq line
(concat line
(org-lparse-format 'LINE-BREAK
)))))
1130 ;; Check if a paragraph should be started
1132 (while (and org-lparse-par-open
1133 (string-match "\\\\par\\>" line start
))
1135 ;; Leave a space in the </p> so that the footnote matcher
1136 ;; does not see this.
1137 (if (not (get-text-property (match-beginning 0)
1138 'org-protected line
))
1139 (setq line
(replace-match "</p ><p >" t t line
)))
1140 (setq start
(match-end 0))))
1142 (org-lparse-insert 'LINE line
)))))
1144 ;; Properly close all local lists and other lists
1145 (when (org-lparse-current-environment-p 'quote
)
1146 (org-lparse-end-environment 'quote
))
1148 (org-lparse-end-level 1 umax
)
1150 ;; the </div> to close the last text-... div.
1151 (when (and (> umax
0) org-lparse-dyn-first-heading-pos
)
1152 (org-lparse-end-outline-text-or-outline))
1154 (org-lparse-end 'DOCUMENT-BODY opt-plist
)
1156 (org-lparse-end 'DOCUMENT-CONTENT
))
1158 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1161 (org-lparse-end 'EXPORT
)
1163 ;; kill collection buffer
1164 (when org-lparse-collect-buffer
1165 (kill-buffer org-lparse-collect-buffer
))
1167 (goto-char (point-min))
1168 (or (org-export-push-to-kill-ring
1169 (upcase (symbol-name org-lparse-backend
)))
1170 (message "Exporting... done"))
1174 (let ((f (org-lparse-get 'SAVE-METHOD
)))
1175 (or (and f
(functionp f
) (funcall f filename opt-plist
))
1177 (or (and (boundp 'org-lparse-other-backend
)
1178 org-lparse-other-backend
1179 (not (equal org-lparse-backend org-lparse-other-backend
))
1180 (org-lparse-do-convert
1181 buffer-file-name
(symbol-name org-lparse-other-backend
)))
1183 ((eq to-buffer
'string
)
1184 (prog1 (buffer-substring (point-min) (point-max))
1185 (kill-buffer (current-buffer))))
1186 (t (current-buffer))))))
1188 (defun org-lparse-format-table (lines olines
)
1189 "Returns backend-specific code for org-type and table-type tables."
1191 (setq lines
(org-split-string lines
"\n")))
1192 (if (string-match "^[ \t]*|" (car lines
))
1193 ;; A normal org table
1194 (org-lparse-format-org-table lines nil
)
1195 ;; Table made by table.el
1196 (or (org-lparse-format-table-table-using-table-generate-source
1197 ;; FIXME: Need to take care of this during merge
1198 (if (eq org-lparse-backend
'xhtml
) 'html org-lparse-backend
)
1200 (not org-export-prefer-native-exporter-for-tables
))
1201 ;; We are here only when table.el table has NO col or row
1202 ;; spanning and the user prefers using org's own converter for
1203 ;; exporting of such simple table.el tables.
1204 (org-lparse-format-table-table lines
))))
1206 (defun org-lparse-table-get-colalign-info (lines)
1207 (let ((col-cookies (org-find-text-property-in-string
1208 'org-col-cookies
(car lines
))))
1209 (when (and col-cookies org-table-clean-did-remove-column
)
1211 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) col-cookies
)))
1214 (defvar org-lparse-table-style
)
1215 (defvar org-lparse-table-ncols
)
1216 (defvar org-lparse-table-rownum
)
1217 (defvar org-lparse-table-is-styled
)
1218 (defvar org-lparse-table-begin-marker
)
1219 (defvar org-lparse-table-num-numeric-items-per-column
)
1220 (defvar org-lparse-table-colalign-info
)
1221 (defvar org-lparse-table-colalign-vector
)
1223 ;; Following variables are defined in org-table.el
1224 (defvar org-table-number-fraction
)
1225 (defvar org-table-number-regexp
)
1226 (defun org-lparse-org-table-to-list-table (lines &optional splice
)
1227 "Convert org-table to list-table.
1228 LINES is a list of the form (ROW1 ROW2 ROW3 ...) where each
1229 element is a `string' representing a single row of org-table.
1230 Thus each ROW has vertical separators \"|\" separating the table
1231 fields. A ROW could also be a row-group separator of the form
1232 \"|---...|\". Return a list of the form (ROW1 ROW2 ROW3
1233 ...). ROW could either be symbol `:hrule' or a list of the
1234 form (FIELD1 FIELD2 FIELD3 ...) as appropriate."
1238 (while (setq line
(pop lines
))
1239 (unless (string-match "^[ \t]*|-" line
)
1240 (push (org-split-string line
"[ \t]*|[ \t]*") lines-1
))))
1242 (while (setq line
(pop lines
))
1244 ((string-match "^[ \t]*|-" line
)
1246 (push :hrule lines-1
)))
1248 (push (org-split-string line
"[ \t]*|[ \t]*") lines-1
))))))
1249 (nreverse lines-1
)))
1251 (defun org-lparse-insert-org-table (lines &optional splice
)
1252 "Format a org-type table into backend-specific code.
1253 LINES is a list of lines. Optional argument SPLICE means, do not
1254 insert header and surrounding <table> tags, just format the lines.
1255 Optional argument NO-CSS means use XHTML attributes instead of CSS
1256 for formatting. This is required for the DocBook exporter."
1257 (require 'org-table
)
1258 ;; Get rid of hlines at beginning and end
1259 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1260 (setq lines
(nreverse lines
))
1261 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1262 (setq lines
(nreverse lines
))
1263 (when org-export-table-remove-special-lines
1264 ;; Check if the table has a marking column. If yes remove the
1265 ;; column and the special lines
1266 (setq lines
(org-table-clean-before-export lines
)))
1267 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1268 (caption (and caption
(org-xml-encode-org-text caption
)))
1269 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1270 (org-lparse-table-colalign-info (org-lparse-table-get-colalign-info lines
))
1271 (attributes (org-find-text-property-in-string 'org-attributes
1273 (head (and org-export-highlight-first-table-line
1275 (lambda (x) (string-match "^[ \t]*|-" x
))
1277 (setq lines
(org-lparse-org-table-to-list-table lines splice
))
1278 (org-lparse-insert-list-table
1279 lines splice caption label attributes head org-lparse-table-colalign-info
)))
1281 (defun org-lparse-insert-list-table (lines &optional splice
1282 caption label attributes head
1283 org-lparse-table-colalign-info
)
1284 (or (featurep 'org-table
) ; required for
1285 (require 'org-table
)) ; `org-table-number-regexp'
1286 (let* ((org-lparse-table-rownum -
1) org-lparse-table-ncols i
(cnt 0)
1288 org-lparse-table-cur-rowgrp-is-hdr
1289 org-lparse-table-rowgrp-open
1290 org-lparse-table-num-numeric-items-per-column
1291 org-lparse-table-colalign-vector n
1292 org-lparse-table-rowgrp-info
1293 org-lparse-table-begin-marker
1294 (org-lparse-table-style 'org-table
)
1295 org-lparse-table-is-styled
)
1298 (setq org-lparse-table-is-styled nil
)
1299 (while (setq line
(pop lines
))
1300 (insert (org-lparse-format-table-row line
) "\n")))
1302 (setq org-lparse-table-is-styled t
)
1303 (org-lparse-begin 'TABLE caption label attributes
)
1304 (setq org-lparse-table-begin-marker
(point))
1305 (org-lparse-begin-table-rowgroup head
)
1306 (while (setq line
(pop lines
))
1308 ((equal line
:hrule
)
1309 (org-lparse-begin-table-rowgroup))
1311 (insert (org-lparse-format-table-row line
) "\n"))))
1312 (org-lparse-end 'TABLE-ROWGROUP
)
1313 (org-lparse-end-table)))))
1315 (defun org-lparse-format-org-table (lines &optional splice
)
1317 (org-lparse-insert-org-table lines splice
)
1318 (buffer-substring-no-properties (point-min) (point-max))))
1320 (defun org-lparse-format-list-table (lines &optional splice
)
1322 (org-lparse-insert-list-table lines splice
)
1323 (buffer-substring-no-properties (point-min) (point-max))))
1325 (defun org-lparse-insert-table-table (lines)
1326 "Format a table generated by table.el into backend-specific code.
1327 This conversion does *not* use `table-generate-source' from table.el.
1328 This has the advantage that Org-mode's HTML conversions can be used.
1329 But it has the disadvantage, that no cell- or row-spanning is allowed."
1330 (let (line field-buffer
1331 (org-lparse-table-cur-rowgrp-is-hdr
1332 org-export-highlight-first-table-line
)
1336 (org-lparse-table-style 'table-table
)
1337 (org-lparse-table-is-styled nil
)
1338 fields org-lparse-table-ncols i
(org-lparse-table-rownum -
1)
1339 (empty (org-lparse-format 'SPACES
1)))
1340 (org-lparse-begin 'TABLE caption label attributes
)
1341 (while (setq line
(pop lines
))
1343 ((string-match "^[ \t]*\\+-" line
)
1345 (let ((org-export-table-row-tags '("<tr>" .
"</tr>"))
1346 ;; (org-export-html-table-use-header-tags-for-first-column nil)
1348 (insert (org-lparse-format-table-row field-buffer empty
)))
1349 (setq org-lparse-table-cur-rowgrp-is-hdr nil
)
1350 (setq field-buffer nil
)))
1352 ;; Break the line into fields and store the fields
1353 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1355 (setq field-buffer
(mapcar
1357 (concat x
(org-lparse-format 'LINE-BREAK
)
1360 (setq field-buffer fields
)))))
1361 (org-lparse-end-table)))
1363 (defun org-lparse-format-table-table (lines)
1365 (org-lparse-insert-table-table lines
)
1366 (buffer-substring-no-properties (point-min) (point-max))))
1368 (defvar table-source-languages
) ; defined in table.el
1369 (defun org-lparse-format-table-table-using-table-generate-source (backend
1373 "Format a table into BACKEND, using `table-generate-source' from table.el.
1374 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
1376 When SPANNED-ONLY is nil, all table.el tables are exported. When
1377 SPANNED-ONLY is non-nil, only tables with either row or column
1380 This routine returns the generated source or nil as appropriate.
1382 Refer docstring of `org-export-prefer-native-exporter-for-tables'
1383 for further information."
1385 (with-current-buffer (get-buffer-create " org-tmp1 ")
1387 (insert (mapconcat 'identity lines
"\n"))
1388 (goto-char (point-min))
1389 (if (not (re-search-forward "|[^+]" nil t
))
1390 (error "Error processing table"))
1391 (table-recognize-table)
1392 (when (or (not spanned-only
)
1393 (let* ((dim (table-query-dimension))
1394 (c (nth 4 dim
)) (r (nth 5 dim
)) (cells (nth 6 dim
)))
1395 (not (= (* c r
) cells
))))
1396 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1398 ((member backend table-source-languages
)
1399 (table-generate-source backend
" org-tmp2 ")
1400 (set-buffer " org-tmp2 ")
1401 (buffer-substring (point-min) (point-max)))
1403 ;; table.el doesn't support the given backend. Currently this
1404 ;; happens in case of odt export. Strip the table from the
1405 ;; generated document. A better alternative would be to embed
1406 ;; the table as ascii text in the output document.
1409 "Found table.el-type table in the source org file. "
1410 (format "table.el doesn't support %s backend. "
1411 (upcase (symbol-name backend
)))
1412 "Skipping ahead ..."))
1415 (defun org-lparse-handle-time-stamps (s)
1416 "Format time stamps in string S, or remove them."
1419 (when org-maybe-keyword-time-regexp
1420 (while (string-match org-maybe-keyword-time-regexp s
)
1421 (or b
(setq b
(substring s
0 (match-beginning 0))))
1423 r
(substring s
0 (match-beginning 0)) " "
1430 (match-string 1 s
) "timestamp-kwd"))
1434 (substring (org-translate-time (match-string 3 s
)) 1 -
1)
1436 "timestamp-wrapper"))
1437 s
(substring s
(match-end 0)))))
1439 ;; Line break if line started and ended with time stamp stuff
1442 (setq r
(concat r s
))
1443 (unless (string-match "\\S-" (concat b s
))
1444 (setq r
(concat r
(org-lparse-format 'LINE-BREAK
))))
1447 (defun org-xml-encode-plain-text (s)
1448 "Convert plain text characters to HTML equivalent.
1449 Possible conversions are set in `org-export-html-protect-char-alist'."
1450 (let ((cl (org-lparse-get 'PLAIN-TEXT-MAP
)) c
)
1451 (while (setq c
(pop cl
))
1453 (while (string-match (car c
) s start
)
1454 (setq s
(replace-match (cdr c
) t t s
)
1455 start
(1+ (match-beginning 0))))))
1458 (defun org-xml-encode-org-text-skip-links (string)
1459 "Prepare STRING for HTML export. Apply all active conversions.
1460 If there are links in the string, don't modify these. If STRING
1461 is nil, return nil."
1463 (let* ((re (concat org-bracket-link-regexp
"\\|"
1464 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
1466 (while (setq m
(string-match re string
))
1467 (setq s
(substring string
0 m
)
1468 l
(match-string 0 string
)
1469 string
(substring string
(match-end 0)))
1470 (push (org-xml-encode-org-text s
) res
)
1472 (push (org-xml-encode-org-text string
) res
)
1473 (apply 'concat
(nreverse res
)))))
1475 (defun org-xml-encode-org-text (s)
1476 "Apply all active conversions to translate special ASCII to HTML."
1477 (setq s
(org-xml-encode-plain-text s
))
1478 (if org-export-html-expand
1479 (while (string-match "@<\\([^&]*\\)>" s
)
1480 (setq s
(replace-match "<\\1>" t nil s
))))
1481 (if org-export-with-emphasize
1482 (setq s
(org-lparse-apply-char-styles s
)))
1483 (if org-export-with-special-strings
1484 (setq s
(org-lparse-convert-special-strings s
)))
1485 (if org-export-with-sub-superscripts
1486 (setq s
(org-lparse-apply-sub-superscript-styles s
)))
1487 (if org-export-with-TeX-macros
1488 (let ((start 0) wd rep
)
1489 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
1491 (if (get-text-property (match-beginning 0) 'org-protected s
)
1492 (setq start
(match-end 0))
1493 (setq wd
(match-string 1 s
))
1494 (if (setq rep
(org-lparse-format 'ORG-ENTITY wd
))
1495 (setq s
(replace-match rep t t s
))
1496 (setq start
(+ start
(length wd
))))))))
1499 (defun org-lparse-convert-special-strings (string)
1500 "Convert special characters in STRING to HTML."
1501 (let ((all (org-lparse-get 'SPECIAL-STRING-REGEXPS
))
1503 (while (setq a
(pop all
))
1504 (setq re
(car a
) rpl
(cdr a
) start
0)
1505 (while (string-match re string start
)
1506 (if (get-text-property (match-beginning 0) 'org-protected string
)
1507 (setq start
(match-end 0))
1508 (setq string
(replace-match rpl t nil string
)))))
1511 (defun org-lparse-apply-sub-superscript-styles (string)
1512 "Apply subscript and superscript styles to STRING.
1513 Use `org-export-with-sub-superscripts' to control application of
1514 sub and superscript styles."
1515 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
1516 (while (string-match org-match-substring-regexp string s
)
1518 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
1519 ((get-text-property (match-beginning 2) 'org-protected string
)
1520 (setq s
(match-end 2)))
1522 (setq s
(match-end 1)
1523 key
(if (string= (match-string 2 string
) "_")
1524 'subscript
'superscript
)
1525 c
(or (match-string 8 string
)
1526 (match-string 6 string
)
1527 (match-string 5 string
))
1528 string
(replace-match
1529 (concat (match-string 1 string
)
1530 (org-lparse-format 'FONTIFY c key
))
1532 (while (string-match "\\\\\\([_^]\\)" string
)
1533 (setq string
(replace-match (match-string 1 string
) t t string
)))
1536 (defvar org-lparse-char-styles
1543 "Map Org emphasis markers to char styles.
1544 This is an alist where each element is of the
1545 form (ORG-EMPHASIS-CHAR . CHAR-STYLE).")
1547 (defun org-lparse-apply-char-styles (string)
1548 "Apply char styles to STRING.
1549 The variable `org-lparse-char-styles' controls how the Org
1550 emphasis markers are interpreted."
1552 (while (string-match org-emph-re string s
)
1554 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
1555 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
1556 (setq s
(match-beginning 0)
1559 (match-string 1 string
)
1561 'FONTIFY
(match-string 4 string
)
1562 (nth 1 (assoc (match-string 3 string
)
1563 org-lparse-char-styles
)))
1564 (match-string 5 string
))
1565 string
(replace-match rpl t t string
)
1566 s
(+ s
(- (length rpl
) 2)))
1570 (defun org-lparse-export-list-line (line pos struct prevs
)
1571 "Insert list syntax in export buffer. Return LINE, maybe modified.
1573 POS is the item position or line position the line had before
1574 modifications to buffer. STRUCT is the list structure. PREVS is
1575 the alist of previous items."
1578 ;; Translate type of list containing POS to "d", "o" or
1580 (lambda (pos struct prevs
)
1581 (let ((type (org-list-get-list-type pos struct prevs
)))
1583 ((eq 'ordered type
) "o")
1584 ((eq 'descriptive type
) "d")
1588 ;; Return list of all items and sublists ending at POS, in
1594 (let ((end (nth 6 e
))
1597 ((= end pos
) (push item out
))
1598 ((>= item pos
) (throw 'exit nil
)))))
1601 ;; First close any previous item, or list, ending at POS.
1603 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
1604 (first-item (org-list-get-list-begin e struct prevs
))
1605 (type (funcall get-type first-item struct prevs
)))
1606 (org-lparse-end-paragraph)
1607 ;; Ending for every item
1608 (org-lparse-end-list-item-1 type
)
1609 ;; We're ending last item of the list: end list.
1611 (org-lparse-end-list type
)
1612 (org-lparse-begin-paragraph))))
1613 (funcall get-closings pos
))
1615 ;; At an item: insert appropriate tags in export buffer.
1618 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
1619 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
1620 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
1621 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
1623 (let* ((checkbox (match-string 3 line
))
1624 (desc-tag (or (match-string 4 line
) "???"))
1625 (body (or (match-string 5 line
) ""))
1626 (list-beg (org-list-get-list-begin pos struct prevs
))
1627 (firstp (= list-beg pos
))
1628 ;; Always refer to first item to determine list type, in
1629 ;; case list is ill-formed.
1630 (type (funcall get-type list-beg struct prevs
))
1631 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
1633 ((not count-tmp
) nil
)
1634 ((string-match "[A-Za-z]" count-tmp
)
1635 (- (string-to-char (upcase count-tmp
)) 64))
1636 ((string-match "[0-9]+" count-tmp
)
1639 (org-lparse-end-paragraph)
1640 (org-lparse-begin-list type
))
1642 (let ((arg (cond ((equal type
"d") desc-tag
)
1643 ((equal type
"o") counter
))))
1644 (org-lparse-begin-list-item type arg
))
1646 ;; If line had a checkbox, some additional modification is required.
1654 ((string-match "X" checkbox
) "X")
1655 ((string-match " " checkbox
)
1656 (org-lparse-format 'SPACES
1))
1662 ;; Return modified line
1664 ;; At a list ender: go to next line (side-effects only).
1665 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
1666 ;; Not at an item: return line unchanged (side-effects only).
1669 (defun org-lparse-bind-local-variables (opt-plist)
1671 (set (make-local-variable (nth 2 x
))
1672 (plist-get opt-plist
(car x
))))
1673 org-export-plist-vars
))
1675 (defvar org-lparse-table-rowgrp-open
)
1676 (defvar org-lparse-table-cur-rowgrp-is-hdr
)
1677 (defvar org-lparse-footnote-number
)
1678 (defvar org-lparse-footnote-definitions
)
1679 (defvar org-lparse-output-buffer nil
1680 "Buffer to which `org-do-lparse' writes to.
1681 This buffer contains the contents of the to-be-created exported
1684 (defcustom org-lparse-debug nil
1685 "Enable or Disable logging of `org-lparse' callbacks.
1686 The parameters passed to the backend-registered ENTITY-CONTROL
1687 and ENTITY-FORMAT callbacks are logged as comment strings in the
1688 exported buffer. (org-lparse-format 'COMMENT fmt args) is used
1689 for logging. Customize this variable only if you are an expert
1690 user. Valid values of this variable are:
1691 nil : Disable logging
1692 control : Log all invocations of `org-lparse-begin' and
1693 `org-lparse-end' callbacks.
1694 format : Log invocations of `org-lparse-format' callbacks.
1695 t : Log all invocations of `org-lparse-begin', `org-lparse-end'
1696 and `org-lparse-format' callbacks,"
1699 (const :tag
"Disable" nil
)
1700 (const :tag
"Format callbacks" format
)
1701 (const :tag
"Control callbacks" control
)
1702 (const :tag
"Format and Control callbacks" t
)))
1704 (defun org-lparse-begin (entity &rest args
)
1705 "Begin ENTITY in current buffer. ARGS is entity specific.
1706 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM etc.
1708 Use (org-lparse-begin 'LIST \"o\") to begin a list in current
1711 See `org-xhtml-entity-control-callbacks-alist' for more
1713 (when (and (member org-lparse-debug
'(t control
))
1714 (not (eq entity
'DOCUMENT-CONTENT
)))
1715 (insert (org-lparse-format 'COMMENT
"%s BEGIN %S" entity args
)))
1717 (let ((f (cadr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1718 (unless f
(error "Unknown entity: %s" entity
))
1721 (defun org-lparse-end (entity &rest args
)
1722 "Close ENTITY in current buffer. ARGS is entity specific.
1723 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM
1726 Use (org-lparse-end 'LIST \"o\") to close a list in current
1729 See `org-xhtml-entity-control-callbacks-alist' for more
1731 (when (and (member org-lparse-debug
'(t control
))
1732 (not (eq entity
'DOCUMENT-CONTENT
)))
1733 (insert (org-lparse-format 'COMMENT
"%s END %S" entity args
)))
1735 (let ((f (caddr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1736 (unless f
(error "Unknown entity: %s" entity
))
1739 (defun org-lparse-begin-paragraph (&optional style
)
1740 "Insert <p>, but first close previous paragraph if any."
1741 (org-lparse-end-paragraph)
1742 (org-lparse-begin 'PARAGRAPH style
)
1743 (setq org-lparse-par-open t
))
1745 (defun org-lparse-end-paragraph ()
1746 "Close paragraph if there is one open."
1747 (when org-lparse-par-open
1748 (org-lparse-end 'PARAGRAPH
)
1749 (setq org-lparse-par-open nil
)))
1751 (defun org-lparse-end-list-item-1 (&optional type
)
1752 "Close <li> if necessary."
1753 (org-lparse-end-paragraph)
1754 (org-lparse-end-list-item (or type
"u")))
1756 (defun org-lparse-preprocess-after-blockquote-hook ()
1757 "Treat `org-lparse-special-blocks' specially."
1758 (goto-char (point-min))
1759 (while (re-search-forward
1760 "^[ \t]*#\\+\\(begin\\|end\\)_\\(\\S-+\\)[ \t]*\\(.*\\)$" nil t
)
1761 (when (member (downcase (match-string 2)) org-lparse-special-blocks
)
1763 (if (equal (downcase (match-string 1)) "begin")
1764 (format "ORG-%s-START %s" (upcase (match-string 2))
1766 (format "ORG-%s-END %s" (upcase (match-string 2))
1767 (match-string 3))) t t
))))
1769 (add-hook 'org-export-preprocess-after-blockquote-hook
1770 'org-lparse-preprocess-after-blockquote-hook
)
1772 (defun org-lparse-strip-experimental-blocks-maybe-hook ()
1773 "Strip \"list-table\" and \"annotation\" blocks.
1774 Stripping happens only when the exported backend is not one of
1775 \"odt\" or \"xhtml\"."
1776 (when (not org-lparse-backend
)
1777 (message "Stripping following blocks - %S" org-lparse-special-blocks
)
1778 (goto-char (point-min))
1779 (let ((case-fold-search t
))
1782 "^[ \t]*#\\+begin_\\(\\S-+\\)\\([ \t]+.*\\)?\n\\([^\000]*?\\)\n[ \t]*#\\+end_\\1\\>.*"
1784 (when (member (match-string 1) org-lparse-special-blocks
)
1785 (replace-match "" t t
))))))
1787 (add-hook 'org-export-preprocess-hook
1788 'org-lparse-strip-experimental-blocks-maybe-hook
)
1790 (defvar org-lparse-list-table-p nil
1791 "Non-nil if `org-do-lparse' is within a list-table.")
1793 (defvar org-lparse-dyn-current-environment nil
)
1794 (defun org-lparse-begin-environment (style &optional env-options-plist
)
1797 (setq org-lparse-list-table-p t
))
1798 (t (setq org-lparse-dyn-current-environment style
)
1799 (org-lparse-begin 'ENVIRONMENT style env-options-plist
))))
1801 (defun org-lparse-end-environment (style &optional env-options-plist
)
1804 (setq org-lparse-list-table-p nil
))
1805 (t (org-lparse-end 'ENVIRONMENT style env-options-plist
)
1806 (setq org-lparse-dyn-current-environment nil
))))
1808 (defun org-lparse-current-environment-p (style)
1809 (eq org-lparse-dyn-current-environment style
))
1811 (defun org-lparse-begin-footnote-definition (n)
1812 (org-lparse-begin-collect)
1813 (setq org-lparse-insert-tag-with-newlines nil
)
1814 (org-lparse-begin 'FOOTNOTE-DEFINITION n
))
1816 (defun org-lparse-end-footnote-definition (n)
1817 (org-lparse-end 'FOOTNOTE-DEFINITION n
)
1818 (setq org-lparse-insert-tag-with-newlines
'both
)
1819 (let ((footnote-def (org-lparse-end-collect)))
1820 (push (cons n footnote-def
) org-lparse-footnote-definitions
)))
1822 (defvar org-lparse-collect-buffer nil
1823 "An auxiliary buffer named \"*Org Lparse Collect*\".
1824 `org-do-lparse' uses this as output buffer while collecting
1825 footnote definitions and table-cell contents of list-tables. See
1826 `org-lparse-begin-collect' and `org-lparse-end-collect'.")
1828 (defvar org-lparse-collect-count nil
1829 "Count number of calls to `org-lparse-begin-collect'.
1830 Use this counter to catch chained collections if they ever
1833 (defun org-lparse-begin-collect ()
1834 "Temporarily switch to `org-lparse-collect-buffer'.
1835 Also erase it's contents."
1836 (unless (zerop org-lparse-collect-count
)
1837 (error "FIXME (org-lparse.el): Encountered chained collections"))
1838 (incf org-lparse-collect-count
)
1839 (unless org-lparse-collect-buffer
1840 (setq org-lparse-collect-buffer
1841 (get-buffer-create "*Org Lparse Collect*")))
1842 (set-buffer org-lparse-collect-buffer
)
1845 (defun org-lparse-end-collect ()
1846 "Switch to `org-lparse-output-buffer'.
1847 Return contents of `org-lparse-collect-buffer' as a `string'."
1848 (assert (> org-lparse-collect-count
0))
1849 (decf org-lparse-collect-count
)
1850 (prog1 (buffer-string)
1852 (set-buffer org-lparse-output-buffer
)))
1854 (defun org-lparse-format (entity &rest args
)
1855 "Format ENTITY in backend-specific way and return it.
1856 ARGS is specific to entity being formatted.
1858 Use (org-lparse-format 'HEADING \"text\" 1) to format text as
1861 See `org-xhtml-entity-format-callbacks-alist' for more information."
1862 (when (and (member org-lparse-debug
'(t format
))
1863 (not (equal entity
'COMMENT
)))
1864 (insert (org-lparse-format 'COMMENT
"%s: %S" entity args
)))
1867 (let ((text (pop args
)))
1868 (apply 'org-lparse-format
'TAGS entity text args
)))
1870 (let ((f (cdr (assoc entity org-lparse-entity-format-callbacks-alist
))))
1871 (unless f
(error "Unknown entity: %s" entity
))
1874 (defun org-lparse-insert (entity &rest args
)
1875 (insert (apply 'org-lparse-format entity args
)))
1877 (defun org-lparse-prepare-toc (lines level-offset opt-plist umax-toc
)
1878 (let* ((quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1879 (org-min-level (org-get-min-level lines level-offset
))
1880 (org-last-level org-min-level
)
1883 (org-lparse-bind-local-variables opt-plist
)
1885 (org-lparse-begin 'TOC
(nth 3 (plist-get opt-plist
:lang-words
)) umax-toc
)
1890 (when (and (string-match org-todo-line-regexp line
)
1891 (not (get-text-property 0 'org-protected line
))
1892 (<= (setq level
(org-tr-level
1893 (- (match-end 1) (match-beginning 1)
1896 (let ((txt (save-match-data
1897 (org-xml-encode-org-text-skip-links
1898 (org-export-cleanup-toc-line
1899 (match-string 3 line
)))))
1901 org-export-mark-todo-in-toc
1902 (or (and (match-beginning 2)
1903 (not (member (match-string 2 line
)
1904 org-done-keywords
)))
1905 (and (= level umax-toc
)
1906 (org-search-todo-below
1907 line lines level
)))))
1909 ;; Check for targets
1910 (while (string-match org-any-target-regexp line
)
1913 (let ((org-lparse-encode-pending t
))
1914 (org-lparse-format 'FONTIFY
1915 (match-string 1 line
) "target"))
1918 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1919 (setq tags
(match-string 1 txt
)
1920 txt
(replace-match "" t nil txt
)))
1921 (when (string-match quote-re0 txt
)
1922 (setq txt
(replace-match "" t t txt
)))
1923 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1924 (setq txt
(replace-match "" t t txt
)))
1927 (let* ((snumber (org-section-number level
))
1928 (href (replace-regexp-in-string
1929 "\\." "-" (format "sec-%s" snumber
)))
1933 href org-export-preferred-target-alist
))
1935 (href (org-solidify-link-text href
)))
1936 (org-lparse-format 'TOC-ENTRY snumber todo txt tags href
))
1937 level org-last-level
)
1938 (setq org-last-level level
)))
1941 (org-lparse-end 'TOC
)
1942 (setq org-lparse-toc
(buffer-string))))
1945 (defun org-lparse-format-table-row (fields &optional text-for-empty-fields
)
1946 (if org-lparse-table-ncols
1947 ;; second and subsequent rows of the table
1948 (when (and org-lparse-list-table-p
1949 (> (length fields
) org-lparse-table-ncols
))
1950 (error "Table row has %d columns but header row claims %d columns"
1951 (length fields
) org-lparse-table-ncols
))
1952 ;; first row of the table
1953 (setq org-lparse-table-ncols
(length fields
))
1954 (when org-lparse-table-is-styled
1955 (setq org-lparse-table-num-numeric-items-per-column
1956 (make-vector org-lparse-table-ncols
0))
1957 (setq org-lparse-table-colalign-vector
1958 (make-vector org-lparse-table-ncols nil
))
1960 (while (< (incf c
) org-lparse-table-ncols
)
1961 (let* ((col-cookie (cdr (assoc (1+ c
) org-lparse-table-colalign-info
)))
1962 (align (nth 0 col-cookie
)))
1963 (setf (aref org-lparse-table-colalign-vector c
)
1965 ((string= align
"l") "left")
1966 ((string= align
"r") "right")
1967 ((string= align
"c") "center")
1969 (incf org-lparse-table-rownum
)
1975 (when (and (string= x
"") text-for-empty-fields
)
1976 (setq x text-for-empty-fields
))
1978 (let (col-cookie horiz-span
)
1979 (when org-lparse-table-is-styled
1980 (when (and (< i org-lparse-table-ncols
)
1981 (string-match org-table-number-regexp x
))
1982 (incf (aref org-lparse-table-num-numeric-items-per-column i
)))
1983 (setq col-cookie
(cdr (assoc (1+ i
) org-lparse-table-colalign-info
))
1984 horiz-span
(nth 1 col-cookie
)))
1986 'TABLE-CELL x org-lparse-table-rownum i
(or horiz-span
0))))
1989 (defun org-lparse-get (what &optional opt-plist
)
1990 "Query for value of WHAT for the current backend `org-lparse-backend'.
1991 See also `org-lparse-backend-get'."
1992 (if (boundp 'org-lparse-backend
)
1993 (org-lparse-backend-get (symbol-name org-lparse-backend
) what opt-plist
)
1994 (error "org-lparse-backend is not bound yet")))
1996 (defun org-lparse-backend-get (backend what
&optional opt-plist
)
1997 "Query BACKEND for value of WHAT.
1998 Dispatch the call to `org-<backend>-user-get'. If that throws an
1999 error, dispatch the call to `org-<backend>-get'. See
2000 `org-xhtml-get' for all known settings queried for by
2001 `org-lparse' during the course of export."
2002 (assert (stringp backend
) t
)
2003 (unless (org-lparse-backend-is-native-p backend
)
2004 (error "Unknown native backend %s" backend
))
2005 (let ((backend-get-method (intern (format "org-%s-get" backend
)))
2006 (backend-user-get-method (intern (format "org-%s-user-get" backend
))))
2008 ((functionp backend-get-method
)
2010 (funcall backend-user-get-method what opt-plist
)
2011 (error (funcall backend-get-method what opt-plist
))))
2013 (error "Native backend %s doesn't define %s" backend backend-get-method
)))))
2015 (defun org-lparse-insert-tag (tag &rest args
)
2016 (when (member org-lparse-insert-tag-with-newlines
'(lead both
))
2018 (insert (apply 'format tag args
))
2019 (when (member org-lparse-insert-tag-with-newlines
'(trail both
))
2022 (defun org-lparse-get-targets-from-title (title)
2023 (let* ((target (org-get-text-property-any 0 'target title
))
2024 (extra-targets (assoc target org-export-target-aliases
))
2025 (target (or (cdr (assoc target org-export-preferred-target-alist
))
2027 (cons target
(remove target extra-targets
))))
2029 (defun org-lparse-suffix-from-snumber (snumber)
2030 (let* ((snu (replace-regexp-in-string "\\." "-" snumber
))
2031 (href (cdr (assoc (concat "sec-" snu
)
2032 org-export-preferred-target-alist
))))
2033 (org-solidify-link-text (or href snu
))))
2035 (defun org-lparse-begin-level (level title umax head-count
)
2036 "Insert a new LEVEL in HTML export.
2037 When TITLE is nil, just close all open levels."
2038 (org-lparse-end-level level umax
)
2039 (unless title
(error "Why is heading nil"))
2040 (let* ((targets (org-lparse-get-targets-from-title title
))
2041 (target (car targets
)) (extra-targets (cdr targets
))
2042 (target (and target
(org-solidify-link-text target
)))
2043 (extra-class (org-get-text-property-any 0 'html-container-class title
))
2044 snumber tags level1 class
)
2045 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2046 (setq tags
(and org-export-with-tags
(match-string 1 title
)))
2047 (setq title
(replace-match "" t t title
)))
2050 (if (aref org-levels-open
(1- level
))
2051 (org-lparse-end-list-item-1)
2052 (aset org-levels-open
(1- level
) t
)
2053 (org-lparse-end-paragraph)
2054 (org-lparse-begin-list 'unordered
))
2055 (org-lparse-begin-list-item
2056 'unordered target
(org-lparse-format
2057 'HEADLINE title extra-targets tags
)))
2058 (aset org-levels-open
(1- level
) t
)
2059 (setq snumber
(org-section-number level
))
2060 (setq level1
(+ level
(or (org-lparse-get 'TOPLEVEL-HLEVEL
) 1) -
1))
2061 (unless (= head-count
1)
2062 (org-lparse-end-outline-text-or-outline))
2063 (org-lparse-begin-outline-and-outline-text
2064 level1 snumber title tags target extra-targets extra-class
)
2065 (org-lparse-begin-paragraph))))
2067 (defun org-lparse-end-level (level umax
)
2068 (org-lparse-end-paragraph)
2069 (loop for l from org-level-max downto level
2070 do
(when (aref org-levels-open
(1- l
))
2071 ;; Terminate one level in HTML export
2073 (org-lparse-end-outline-text-or-outline)
2074 (org-lparse-end-list-item-1)
2075 (org-lparse-end-list 'unordered
))
2076 (aset org-levels-open
(1- l
) nil
))))
2078 (defvar org-lparse-outline-text-open
)
2079 (defun org-lparse-begin-outline-and-outline-text (level1 snumber title tags
2080 target extra-targets
2083 'OUTLINE level1 snumber title tags target extra-targets extra-class
)
2084 (org-lparse-begin-outline-text level1 snumber extra-class
))
2086 (defun org-lparse-end-outline-text-or-outline ()
2088 (org-lparse-outline-text-open
2089 (org-lparse-end 'OUTLINE-TEXT
)
2090 (setq org-lparse-outline-text-open nil
))
2091 (t (org-lparse-end 'OUTLINE
))))
2093 (defun org-lparse-begin-outline-text (level1 snumber extra-class
)
2094 (assert (not org-lparse-outline-text-open
) t
)
2095 (setq org-lparse-outline-text-open t
)
2096 (org-lparse-begin 'OUTLINE-TEXT level1 snumber extra-class
))
2098 (defun org-lparse-html-list-type-to-canonical-list-type (ltype)
2099 (cdr (assoc ltype
'(("o" . ordered
)
2101 ("d" . description
)))))
2103 ;; following vars are bound during `org-do-lparse'
2104 (defvar org-lparse-list-stack
)
2105 (defvar org-lparse-list-table
:table-row
)
2106 (defvar org-lparse-list-table
:lines
)
2108 ;; Notes on LIST-TABLES
2109 ;; ====================
2110 ;; Lists withing "list-table" blocks (as shown below)
2112 ;; #+begin_list-table
2123 ;; will be exported as though it were a table as shown below.
2125 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
2126 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
2128 ;; Note that org-tables are NOT multi-line and each line is mapped to
2129 ;; a unique row in the exported document. So if an exported table
2130 ;; needs to contain a single paragraph (with copious text) it needs to
2131 ;; be typed up in a single line. Editing such long lines using the
2132 ;; table editor will be a cumbersome task. Furthermore inclusion of
2133 ;; multi-paragraph text in a table cell is well-nigh impossible.
2135 ;; LIST-TABLEs are meant to circumvent the above problems with
2138 ;; Note that in the example above the list items could be paragraphs
2139 ;; themselves and the list can be arbitrarily deep.
2141 ;; Inspired by following thread:
2142 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
2144 (defun org-lparse-begin-list (ltype)
2145 (push ltype org-lparse-list-stack
)
2146 (let ((list-level (length org-lparse-list-stack
)))
2148 ((not org-lparse-list-table-p
)
2149 (org-lparse-begin 'LIST ltype
))
2150 ;; process LIST-TABLE
2153 (setq org-lparse-list-table
:lines nil
)
2154 (setq org-lparse-list-table
:table-row nil
))
2158 (org-lparse-begin 'LIST ltype
)))))
2160 (defun org-lparse-end-list (ltype)
2161 (pop org-lparse-list-stack
)
2162 (let ((list-level (length org-lparse-list-stack
)))
2164 ((not org-lparse-list-table-p
)
2165 (org-lparse-end 'LIST ltype
))
2166 ;; process LIST-TABLE
2169 (insert (org-lparse-format-list-table
2170 (nreverse org-lparse-list-table
:lines
))))
2174 (org-lparse-end 'LIST ltype
)))))
2176 (defun org-lparse-begin-list-item (ltype &optional arg headline
)
2177 (let ((list-level (length org-lparse-list-stack
)))
2179 ((not org-lparse-list-table-p
)
2180 (org-lparse-begin 'LIST-ITEM ltype arg headline
))
2181 ;; process LIST-TABLE
2183 ;; begin TABLE-ROW for LIST-TABLE
2184 (setq org-lparse-list-table
:table-row nil
)
2185 (org-lparse-begin-list-table:table-cell
))
2187 ;; begin TABLE-CELL for LIST-TABLE
2188 (org-lparse-begin-list-table:table-cell
))
2190 (org-lparse-begin 'LIST-ITEM ltype arg headline
)))))
2192 (defun org-lparse-end-list-item (ltype)
2193 (let ((list-level (length org-lparse-list-stack
)))
2195 ((not org-lparse-list-table-p
)
2196 (org-lparse-end 'LIST-ITEM ltype
))
2197 ;; process LIST-TABLE
2199 ;; end TABLE-ROW for LIST-TABLE
2200 (org-lparse-end-list-table:table-cell
)
2201 (push (nreverse org-lparse-list-table
:table-row
)
2202 org-lparse-list-table
:lines
))
2204 ;; end TABLE-CELL for LIST-TABLE
2205 (org-lparse-end-list-table:table-cell
))
2207 (org-lparse-end 'LIST-ITEM ltype
)))))
2209 (defvar org-lparse-list-table
:table-cell-open
)
2210 (defun org-lparse-begin-list-table:table-cell
()
2211 (org-lparse-end-list-table:table-cell
)
2212 (setq org-lparse-list-table
:table-cell-open t
)
2213 (org-lparse-begin-collect)
2214 (org-lparse-begin-paragraph))
2216 (defun org-lparse-end-list-table:table-cell
()
2217 (when org-lparse-list-table
:table-cell-open
2218 (setq org-lparse-list-table
:table-cell-open nil
)
2219 (org-lparse-end-paragraph)
2220 (push (org-lparse-end-collect)
2221 org-lparse-list-table
:table-row
)))
2223 (defvar org-lparse-table-rowgrp-info
)
2224 (defun org-lparse-begin-table-rowgroup (&optional is-header-row
)
2225 (push (cons (1+ org-lparse-table-rownum
) :start
) org-lparse-table-rowgrp-info
)
2226 (org-lparse-begin 'TABLE-ROWGROUP is-header-row
))
2228 (defun org-lparse-end-table ()
2229 (when org-lparse-table-is-styled
2231 (unless (car org-table-colgroup-info
)
2232 (setq org-table-colgroup-info
2233 (cons :start
(cdr org-table-colgroup-info
))))
2240 (setf (aref org-lparse-table-colalign-vector c
)
2241 (or (aref org-lparse-table-colalign-vector c
)
2242 (if (> (/ (float x
) (1+ org-lparse-table-rownum
))
2243 org-table-number-fraction
)
2245 org-lparse-table-num-numeric-items-per-column
)))
2246 (org-lparse-end 'TABLE
))
2248 (defvar org-lparse-encode-pending nil
)
2250 (defun org-lparse-format-tags (tag text prefix suffix
&rest args
)
2253 (concat prefix
(apply 'format
(car tag
) args
) text suffix
2254 (format (cdr tag
))))
2255 ((stringp tag
) ; singleton tag
2256 (concat prefix
(apply 'format tag args
) text
))))
2258 (defun org-xml-fix-class-name (kwd) ; audit callers of this function
2259 "Turn todo keyword into a valid class name.
2260 Replaces invalid characters with \"_\"."
2262 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2263 (setq kwd
(replace-match "_" t t kwd
))))
2266 (defun org-lparse-format-todo (todo)
2267 (org-lparse-format 'FONTIFY
2269 (ignore-errors (org-lparse-get 'TODO-KWD-CLASS-PREFIX
))
2270 (org-xml-fix-class-name todo
))
2271 (list (if (member todo org-done-keywords
) "done" "todo")
2274 (defun org-lparse-format-extra-targets (extra-targets)
2275 (if (not extra-targets
) ""
2276 (mapconcat (lambda (x)
2277 (setq x
(org-solidify-link-text
2278 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2279 (org-lparse-format 'ANCHOR
"" x
))
2282 (defun org-lparse-format-org-tags (tags)
2290 (ignore-errors (org-lparse-get 'TAG-CLASS-PREFIX
))
2291 (org-xml-fix-class-name x
))))
2292 (org-split-string tags
":")
2293 (org-lparse-format 'SPACES
1)) "tag")))
2295 (defun org-lparse-format-section-number (&optional snumber level
)
2296 (and org-export-with-section-numbers
2297 (not org-lparse-body-only
) snumber level
2298 (org-lparse-format 'FONTIFY snumber
(format "section-number-%d" level
))))
2300 (defun org-lparse-warn (msg)
2301 (if (not org-lparse-use-flashy-warning
)
2303 (put-text-property 0 (length msg
) 'face
'font-lock-warning-face msg
)
2307 (defun org-xml-format-href (s)
2308 "Make sure the S is valid as a href reference in an XHTML document."
2311 (while (string-match "&" s start
)
2312 (setq start
(+ (match-beginning 0) 3)
2313 s
(replace-match "&" t t s
)))))
2316 (defun org-xml-format-desc (s)
2317 "Make sure the S is valid as a description in a link."
2318 (if (and s
(not (get-text-property 1 'org-protected s
)))
2320 (org-xml-encode-org-text s
))
2323 (provide 'org-lparse
)
2325 ;;; org-lparse.el ends here