org-lparse.el 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300
  1. ;;; org-lparse.el --- Line-oriented parser-exporter for Org-mode
  2. ;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
  3. ;; Author: Jambunathan K <kjambunathan at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; `org-lparse' is the entry point for the generic line-oriented
  19. ;; exporter. `org-do-lparse' is the genericized version of the
  20. ;; original `org-export-as-html' routine.
  21. ;; `org-lparse-native-backends' is a good starting point for
  22. ;; exploring the generic exporter.
  23. ;; Following new interactive commands are provided by this library.
  24. ;; `org-lparse', `org-lparse-and-open', `org-lparse-to-buffer'
  25. ;; `org-replace-region-by', `org-lparse-region'.
  26. ;; Note that the above routines correspond to the following routines
  27. ;; in the html exporter `org-export-as-html',
  28. ;; `org-export-as-html-and-open', `org-export-as-html-to-buffer',
  29. ;; `org-replace-region-by-html' and `org-export-region-as-html'.
  30. ;; The new interactive command `org-lparse-convert' can be used to
  31. ;; convert documents between various formats. Use this to command,
  32. ;; for example, to convert odt file to doc or pdf format.
  33. ;;; Code:
  34. (eval-when-compile
  35. (require 'cl))
  36. (require 'org-exp)
  37. (require 'org-list)
  38. (require 'format-spec)
  39. (defun org-lparse-and-open (target-backend native-backend arg
  40. &optional file-or-buf)
  41. "Export outline to TARGET-BACKEND via NATIVE-BACKEND and open exported file.
  42. If there is an active region, export only the region. The prefix
  43. ARG specifies how many levels of the outline should become
  44. headlines. The default is 3. Lower levels will become bulleted
  45. lists."
  46. (let (f (file-or-buf (or file-or-buf
  47. (org-lparse target-backend native-backend
  48. arg 'hidden))))
  49. (when file-or-buf
  50. (setq f (cond
  51. ((bufferp file-or-buf) buffer-file-name)
  52. ((file-exists-p file-or-buf) file-or-buf)
  53. (t (error "org-lparse-and-open: This shouldn't happen"))))
  54. (message "Opening file %s" f)
  55. (org-open-file f 'system)
  56. (when org-export-kill-product-buffer-when-displayed
  57. (kill-buffer (current-buffer))))))
  58. (defun org-lparse-batch (target-backend &optional native-backend)
  59. "Call the function `org-lparse'.
  60. This function can be used in batch processing as:
  61. emacs --batch
  62. --load=$HOME/lib/emacs/org.el
  63. --eval \"(setq org-export-headline-levels 2)\"
  64. --visit=MyFile --funcall org-lparse-batch"
  65. (setq native-backend (or native-backend target-backend))
  66. (org-lparse target-backend native-backend
  67. org-export-headline-levels 'hidden))
  68. (defun org-lparse-to-buffer (backend arg)
  69. "Call `org-lparse' with output to a temporary buffer.
  70. No file is created. The prefix ARG is passed through to
  71. `org-lparse'."
  72. (let ((tempbuf (format "*Org %s Export*" (upcase backend))))
  73. (org-lparse backend backend arg nil nil tempbuf)
  74. (when org-export-show-temporary-export-buffer
  75. (switch-to-buffer-other-window tempbuf))))
  76. (defun org-replace-region-by (backend beg end)
  77. "Assume the current region has org-mode syntax, and convert it to HTML.
  78. This can be used in any buffer. For example, you could write an
  79. itemized list in org-mode syntax in an HTML buffer and then use
  80. this command to convert it."
  81. (let (reg backend-string buf pop-up-frames)
  82. (save-window-excursion
  83. (if (derived-mode-p 'org-mode)
  84. (setq backend-string (org-lparse-region backend beg end t 'string))
  85. (setq reg (buffer-substring beg end)
  86. buf (get-buffer-create "*Org tmp*"))
  87. (with-current-buffer buf
  88. (erase-buffer)
  89. (insert reg)
  90. (org-mode)
  91. (setq backend-string (org-lparse-region backend (point-min)
  92. (point-max) t 'string)))
  93. (kill-buffer buf)))
  94. (delete-region beg end)
  95. (insert backend-string)))
  96. (defun org-lparse-region (backend beg end &optional body-only buffer)
  97. "Convert region from BEG to END in org-mode buffer to HTML.
  98. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  99. contents, and only produce the region of converted text, useful for
  100. cut-and-paste operations.
  101. If BUFFER is a buffer or a string, use/create that buffer as a target
  102. of the converted HTML. If BUFFER is the symbol `string', return the
  103. produced HTML as a string and leave not buffer behind. For example,
  104. a Lisp program could call this function in the following way:
  105. (setq html (org-lparse-region \"html\" beg end t 'string))
  106. When called interactively, the output buffer is selected, and shown
  107. in a window. A non-interactive call will only return the buffer."
  108. (let ((transient-mark-mode t) (zmacs-regions t)
  109. ext-plist rtn)
  110. (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
  111. (goto-char end)
  112. (set-mark (point)) ;; to activate the region
  113. (goto-char beg)
  114. (setq rtn (org-lparse backend backend nil nil ext-plist buffer body-only))
  115. (if (fboundp 'deactivate-mark) (deactivate-mark))
  116. (if (and (org-called-interactively-p 'any) (bufferp rtn))
  117. (switch-to-buffer-other-window rtn)
  118. rtn)))
  119. (defvar org-lparse-par-open nil)
  120. (defun org-lparse-should-inline-p (filename descp)
  121. "Return non-nil if link FILENAME should be inlined.
  122. The decision to inline the FILENAME link is based on the current
  123. settings. DESCP is the boolean of whether there was a link
  124. description. See variables `org-export-html-inline-images' and
  125. `org-export-html-inline-image-extensions'."
  126. (let ((inline-images (org-lparse-get 'INLINE-IMAGES))
  127. (inline-image-extensions
  128. (org-lparse-get 'INLINE-IMAGE-EXTENSIONS)))
  129. (and (or (eq t inline-images) (and inline-images (not descp)))
  130. (org-file-image-p filename inline-image-extensions))))
  131. (defun org-lparse-format-org-link (line opt-plist)
  132. "Return LINE with markup of Org mode links.
  133. OPT-PLIST is the export options list."
  134. (let ((start 0)
  135. (current-dir (if buffer-file-name
  136. (file-name-directory buffer-file-name)
  137. default-directory))
  138. (link-validate (plist-get opt-plist :link-validation-function))
  139. type id-file fnc
  140. rpl path attr desc descp desc1 desc2 link
  141. org-lparse-link-description-is-image)
  142. (while (string-match org-bracket-link-analytic-regexp++ line start)
  143. (setq org-lparse-link-description-is-image nil)
  144. (setq start (match-beginning 0))
  145. (setq path (save-match-data (org-link-unescape
  146. (match-string 3 line))))
  147. (setq type (cond
  148. ((match-end 2) (match-string 2 line))
  149. ((save-match-data
  150. (or (file-name-absolute-p path)
  151. (string-match "^\\.\\.?/" path)))
  152. "file")
  153. (t "internal")))
  154. (setq path (org-extract-attributes path))
  155. (setq attr (get-text-property 0 'org-attributes path))
  156. (setq desc1 (if (match-end 5) (match-string 5 line))
  157. desc2 (if (match-end 2) (concat type ":" path) path)
  158. descp (and desc1 (not (equal desc1 desc2)))
  159. desc (or desc1 desc2))
  160. ;; Make an image out of the description if that is so wanted
  161. (when (and descp (org-file-image-p
  162. desc (org-lparse-get 'INLINE-IMAGE-EXTENSIONS)))
  163. (setq org-lparse-link-description-is-image t)
  164. (save-match-data
  165. (if (string-match "^file:" desc)
  166. (setq desc (substring desc (match-end 0)))))
  167. (save-match-data
  168. (setq desc (org-add-props
  169. (org-lparse-format 'INLINE-IMAGE desc)
  170. '(org-protected t)))))
  171. (cond
  172. ((equal type "internal")
  173. (let
  174. ((frag-0
  175. (if (= (string-to-char path) ?#)
  176. (substring path 1)
  177. path)))
  178. (setq rpl
  179. (org-lparse-format
  180. 'ORG-LINK opt-plist "" "" (org-solidify-link-text
  181. (save-match-data
  182. (org-link-unescape frag-0))
  183. nil) desc attr descp))))
  184. ((and (equal type "id")
  185. (setq id-file (org-id-find-id-file path)))
  186. ;; This is an id: link to another file (if it was the same file,
  187. ;; it would have become an internal link...)
  188. (save-match-data
  189. (setq id-file (file-relative-name
  190. id-file
  191. (file-name-directory org-current-export-file)))
  192. (setq rpl
  193. (org-lparse-format
  194. 'ORG-LINK opt-plist type id-file
  195. (concat (if (org-uuidgen-p path) "ID-") path)
  196. desc attr descp))))
  197. ((member type '("http" "https"))
  198. ;; standard URL, can inline as image
  199. (setq rpl
  200. (org-lparse-format
  201. 'ORG-LINK opt-plist type path nil desc attr descp)))
  202. ((member type '("ftp" "mailto" "news"))
  203. ;; standard URL, can't inline as image
  204. (setq rpl
  205. (org-lparse-format
  206. 'ORG-LINK opt-plist type path nil desc attr descp)))
  207. ((string= type "coderef")
  208. (setq rpl (org-lparse-format
  209. 'ORG-LINK opt-plist type "" path desc nil descp)))
  210. ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
  211. ;; The link protocol has a function for format the link
  212. (setq rpl (save-match-data
  213. (funcall fnc (org-link-unescape path)
  214. desc1 (and (boundp 'org-lparse-backend)
  215. (case org-lparse-backend
  216. (xhtml 'html)
  217. (t org-lparse-backend)))))))
  218. ((string= type "file")
  219. ;; FILE link
  220. (save-match-data
  221. (let*
  222. ((components
  223. (if
  224. (string-match "::\\(.*\\)" path)
  225. (list
  226. (replace-match "" t nil path)
  227. (match-string 1 path))
  228. (list path nil)))
  229. ;;The proper path, without a fragment
  230. (path-1
  231. (first components))
  232. ;;The raw fragment
  233. (fragment-0
  234. (second components))
  235. ;;Check the fragment. If it can't be used as
  236. ;;target fragment we'll pass nil instead.
  237. (fragment-1
  238. (if
  239. (and fragment-0
  240. (not (string-match "^[0-9]*$" fragment-0))
  241. (not (string-match "^\\*" fragment-0))
  242. (not (string-match "^/.*/$" fragment-0)))
  243. (org-solidify-link-text
  244. (org-link-unescape fragment-0))
  245. nil))
  246. (desc-2
  247. ;;Description minus "file:" and ".org"
  248. (if (string-match "^file:" desc)
  249. (let
  250. ((desc-1 (replace-match "" t t desc)))
  251. (if (string-match "\\.org$" desc-1)
  252. (replace-match "" t t desc-1)
  253. desc-1))
  254. desc)))
  255. (setq rpl
  256. (if
  257. (and
  258. (functionp link-validate)
  259. (not (funcall link-validate path-1 current-dir)))
  260. desc
  261. (org-lparse-format
  262. 'ORG-LINK opt-plist "file" path-1 fragment-1
  263. desc-2 attr descp))))))
  264. (t
  265. ;; just publish the path, as default
  266. (setq rpl (concat "<i>&lt;" type ":"
  267. (save-match-data (org-link-unescape path))
  268. "&gt;</i>"))))
  269. (setq line (replace-match rpl t t line)
  270. start (+ start (length rpl))))
  271. line))
  272. (defvar org-lparse-par-open-stashed) ; bound during `org-do-lparse'
  273. (defun org-lparse-stash-save-paragraph-state ()
  274. (assert (zerop org-lparse-par-open-stashed))
  275. (setq org-lparse-par-open-stashed org-lparse-par-open)
  276. (setq org-lparse-par-open nil))
  277. (defun org-lparse-stash-pop-paragraph-state ()
  278. (setq org-lparse-par-open org-lparse-par-open-stashed)
  279. (setq org-lparse-par-open-stashed 0))
  280. (defmacro with-org-lparse-preserve-paragraph-state (&rest body)
  281. `(let ((org-lparse-do-open-par org-lparse-par-open))
  282. (org-lparse-end-paragraph)
  283. ,@body
  284. (when org-lparse-do-open-par
  285. (org-lparse-begin-paragraph))))
  286. (def-edebug-spec with-org-lparse-preserve-paragraph-state (body))
  287. (defvar org-lparse-native-backends nil
  288. "List of native backends registered with `org-lparse'.
  289. A backend can use `org-lparse-register-backend' to add itself to
  290. this list.
  291. All native backends must implement a get routine and a mandatory
  292. set of callback routines.
  293. The get routine must be named as org-<backend>-get where backend
  294. is the name of the backend. The exporter uses `org-lparse-get'
  295. and retrieves the backend-specific callback by querying for
  296. ENTITY-CONTROL and ENTITY-FORMAT variables.
  297. For the sake of illustration, the html backend implements
  298. `org-xhtml-get'. It returns
  299. `org-xhtml-entity-control-callbacks-alist' and
  300. `org-xhtml-entity-format-callbacks-alist' as the values of
  301. ENTITY-CONTROL and ENTITY-FORMAT settings.")
  302. (defun org-lparse-register-backend (backend)
  303. "Make BACKEND known to `org-lparse' library.
  304. Add BACKEND to `org-lparse-native-backends'."
  305. (when backend
  306. (setq backend (cond
  307. ((symbolp backend) (symbol-name backend))
  308. ((stringp backend) backend)
  309. (t (error "Error while registering backend: %S" backend))))
  310. (add-to-list 'org-lparse-native-backends backend)))
  311. (defun org-lparse-unregister-backend (backend)
  312. (setq org-lparse-native-backends
  313. (remove (cond
  314. ((symbolp backend) (symbol-name backend))
  315. ((stringp backend) backend))
  316. org-lparse-native-backends))
  317. (message "Unregistered backend %S" backend))
  318. (defun org-lparse-do-reachable-formats (in-fmt)
  319. "Return verbose info about formats to which IN-FMT can be converted.
  320. Return a list where each element is of the
  321. form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
  322. `org-export-odt-convert-processes' for CONVERTER-PROCESS and see
  323. `org-export-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
  324. (let (reachable-formats)
  325. (dolist (backend org-lparse-native-backends reachable-formats)
  326. (let* ((converter (org-lparse-backend-get
  327. backend 'CONVERT-METHOD))
  328. (capabilities (org-lparse-backend-get
  329. backend 'CONVERT-CAPABILITIES)))
  330. (when converter
  331. (dolist (c capabilities)
  332. (when (member in-fmt (nth 1 c))
  333. (push (cons converter (nth 2 c)) reachable-formats))))))))
  334. (defun org-lparse-reachable-formats (in-fmt)
  335. "Return list of formats to which IN-FMT can be converted.
  336. The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
  337. (let (l)
  338. (mapc (lambda (e) (add-to-list 'l e))
  339. (apply 'append (mapcar
  340. (lambda (e) (mapcar 'car (cdr e)))
  341. (org-lparse-do-reachable-formats in-fmt))))
  342. l))
  343. (defun org-lparse-reachable-p (in-fmt out-fmt)
  344. "Return non-nil if IN-FMT can be converted to OUT-FMT."
  345. (catch 'done
  346. (let ((reachable-formats (org-lparse-do-reachable-formats in-fmt)))
  347. (dolist (e reachable-formats)
  348. (let ((out-fmt-spec (assoc out-fmt (cdr e))))
  349. (when out-fmt-spec
  350. (throw 'done (cons (car e) out-fmt-spec))))))))
  351. (defun org-lparse-backend-is-native-p (backend)
  352. (member backend org-lparse-native-backends))
  353. (defun org-lparse (target-backend native-backend arg
  354. &optional hidden ext-plist
  355. to-buffer body-only pub-dir)
  356. "Export the outline to various formats.
  357. If there is an active region, export only the region. The
  358. outline is first exported to NATIVE-BACKEND and optionally
  359. converted to TARGET-BACKEND. See `org-lparse-native-backends'
  360. for list of known native backends. Each native backend can
  361. specify a converter and list of target backends it exports to
  362. using the CONVERT-PROCESS and OTHER-BACKENDS settings of it's get
  363. method. See `org-xhtml-get' for an illustrative example.
  364. ARG is a prefix argument that specifies how many levels of
  365. outline should become headlines. The default is 3. Lower levels
  366. will become bulleted lists.
  367. HIDDEN is obsolete and does nothing.
  368. EXT-PLIST is a property list that controls various aspects of
  369. export. The settings here override org-mode's default settings
  370. and but are inferior to file-local settings.
  371. TO-BUFFER dumps the exported lines to a buffer or a string
  372. instead of a file. If TO-BUFFER is the symbol `string' return the
  373. exported lines as a string. If TO-BUFFER is non-nil, create a
  374. buffer with that name and export to that buffer.
  375. BODY-ONLY controls the presence of header and footer lines in
  376. exported text. If BODY-ONLY is non-nil, don't produce the file
  377. header and footer, simply return the content of <body>...</body>,
  378. without even the body tags themselves.
  379. PUB-DIR specifies the publishing directory."
  380. (let* ((org-lparse-backend (intern native-backend))
  381. (org-lparse-other-backend (and target-backend
  382. (intern target-backend))))
  383. (add-hook 'org-export-preprocess-hook
  384. 'org-lparse-strip-experimental-blocks-maybe)
  385. (add-hook 'org-export-preprocess-after-blockquote-hook
  386. 'org-lparse-preprocess-after-blockquote)
  387. (unless (org-lparse-backend-is-native-p native-backend)
  388. (error "Don't know how to export natively to backend %s" native-backend))
  389. (unless (or (equal native-backend target-backend)
  390. (org-lparse-reachable-p native-backend target-backend))
  391. (error "Don't know how to export to backend %s %s" target-backend
  392. (format "via %s" native-backend)))
  393. (run-hooks 'org-export-first-hook)
  394. (org-do-lparse arg hidden ext-plist to-buffer body-only pub-dir)
  395. (remove-hook 'org-export-preprocess-hook
  396. 'org-lparse-strip-experimental-blocks-maybe)
  397. (remove-hook 'org-export-preprocess-after-blockquote-hook
  398. 'org-lparse-preprocess-after-blockquote)))
  399. (defcustom org-lparse-use-flashy-warning nil
  400. "Control flashing of messages logged with `org-lparse-warn'.
  401. When non-nil, messages are fontified with warning face and the
  402. exporter lingers for a while to catch user's attention."
  403. :type 'boolean
  404. :group 'org-lparse)
  405. (defun org-lparse-convert-read-params ()
  406. "Return IN-FILE and OUT-FMT params for `org-lparse-do-convert'.
  407. This is a helper routine for interactive use."
  408. (let* ((input (if (featurep 'ido) 'ido-completing-read 'completing-read))
  409. (in-file (read-file-name "File to be converted: "
  410. nil buffer-file-name t))
  411. (in-fmt (file-name-extension in-file))
  412. (out-fmt-choices (org-lparse-reachable-formats in-fmt))
  413. (out-fmt
  414. (or (and out-fmt-choices
  415. (funcall input "Output format: "
  416. out-fmt-choices nil nil nil))
  417. (error
  418. "No known converter or no known output formats for %s files"
  419. in-fmt))))
  420. (list in-file out-fmt)))
  421. (eval-when-compile
  422. (require 'browse-url))
  423. (defun org-lparse-do-convert (in-file out-fmt &optional prefix-arg)
  424. "Workhorse routine for `org-export-odt-convert'."
  425. (require 'browse-url)
  426. (let* ((in-file (expand-file-name (or in-file buffer-file-name)))
  427. (dummy (or (file-readable-p in-file)
  428. (error "Cannot read %s" in-file)))
  429. (in-fmt (file-name-extension in-file))
  430. (out-fmt (or out-fmt (error "Output format unspecified")))
  431. (how (or (org-lparse-reachable-p in-fmt out-fmt)
  432. (error "Cannot convert from %s format to %s format?"
  433. in-fmt out-fmt)))
  434. (convert-process (car how))
  435. (out-file (concat (file-name-sans-extension in-file) "."
  436. (nth 1 (or (cdr how) out-fmt))))
  437. (extra-options (or (nth 2 (cdr how)) ""))
  438. (out-dir (file-name-directory in-file))
  439. (cmd (format-spec convert-process
  440. `((?i . ,(shell-quote-argument in-file))
  441. (?I . ,(browse-url-file-url in-file))
  442. (?f . ,out-fmt)
  443. (?o . ,out-file)
  444. (?O . ,(browse-url-file-url out-file))
  445. (?d . , (shell-quote-argument out-dir))
  446. (?D . ,(browse-url-file-url out-dir))
  447. (?x . ,extra-options)))))
  448. (when (file-exists-p out-file)
  449. (delete-file out-file))
  450. (message "Executing %s" cmd)
  451. (let ((cmd-output (shell-command-to-string cmd)))
  452. (message "%s" cmd-output))
  453. (cond
  454. ((file-exists-p out-file)
  455. (message "Exported to %s" out-file)
  456. (when prefix-arg
  457. (message "Opening %s..." out-file)
  458. (org-open-file out-file 'system))
  459. out-file)
  460. (t
  461. (message "Export to %s failed" out-file)
  462. nil))))
  463. (defvar org-lparse-insert-tag-with-newlines 'both)
  464. ;; Following variables are let-bound during `org-lparse'
  465. (defvar org-lparse-dyn-first-heading-pos)
  466. (defvar org-lparse-toc)
  467. (defvar org-lparse-entity-control-callbacks-alist)
  468. (defvar org-lparse-entity-format-callbacks-alist)
  469. (defvar org-lparse-backend nil
  470. "The native backend to which the document is currently exported.
  471. This variable is let bound during `org-lparse'. Valid values are
  472. one of the symbols corresponding to `org-lparse-native-backends'.
  473. Compare this variable with `org-export-current-backend' which is
  474. bound only during `org-export-preprocess-string' stage of the
  475. export process.
  476. See also `org-lparse-other-backend'.")
  477. (defvar org-lparse-other-backend nil
  478. "The target backend to which the document is currently exported.
  479. This variable is let bound during `org-lparse'. This variable is
  480. set to either `org-lparse-backend' or one of the symbols
  481. corresponding to OTHER-BACKENDS specification of the
  482. org-lparse-backend.
  483. For example, if a document is exported to \"odt\" then both
  484. org-lparse-backend and org-lparse-other-backend are bound to
  485. 'odt. On the other hand, if a document is exported to \"odt\"
  486. and then converted to \"doc\" then org-lparse-backend is set to
  487. 'odt and org-lparse-other-backend is set to 'doc.")
  488. (defvar org-lparse-body-only nil
  489. "Bind this to BODY-ONLY arg of `org-lparse'.")
  490. (defvar org-lparse-to-buffer nil
  491. "Bind this to TO-BUFFER arg of `org-lparse'.")
  492. (defun org-lparse-get-block-params (params)
  493. (save-match-data
  494. (when params
  495. (setq params (org-trim params))
  496. (unless (string-match "\\`(.*)\\'" params)
  497. (setq params (format "(%s)" params)))
  498. (ignore-errors (read params)))))
  499. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  500. (defvar org-lparse-special-blocks '("list-table" "annotation"))
  501. (defun org-do-lparse (arg &optional hidden ext-plist
  502. to-buffer body-only pub-dir)
  503. "Export the outline to various formats.
  504. See `org-lparse' for more information. This function is a
  505. html-agnostic version of the `org-export-as-html' function in 7.5
  506. version."
  507. ;; Make sure we have a file name when we need it.
  508. (when (and (not (or to-buffer body-only))
  509. (not buffer-file-name))
  510. (if (buffer-base-buffer)
  511. (org-set-local 'buffer-file-name
  512. (with-current-buffer (buffer-base-buffer)
  513. buffer-file-name))
  514. (error "Need a file name to be able to export")))
  515. (org-lparse-warn
  516. (format "Exporting to %s using org-lparse..."
  517. (upcase (symbol-name
  518. (or org-lparse-backend org-lparse-other-backend)))))
  519. (setq-default org-todo-line-regexp org-todo-line-regexp)
  520. (setq-default org-deadline-line-regexp org-deadline-line-regexp)
  521. (setq-default org-done-keywords org-done-keywords)
  522. (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
  523. (let* (hfy-user-sheet-assoc ; let `htmlfontify' know that
  524. ; we are interested in
  525. ; collecting styles
  526. org-lparse-encode-pending
  527. org-lparse-par-open
  528. (org-lparse-par-open-stashed 0)
  529. ;; list related vars
  530. (org-lparse-list-stack '())
  531. ;; list-table related vars
  532. org-lparse-list-table-p
  533. org-lparse-list-table:table-cell-open
  534. org-lparse-list-table:table-row
  535. org-lparse-list-table:lines
  536. org-lparse-outline-text-open
  537. (org-lparse-latex-fragment-fallback ; currently used only by
  538. ; odt exporter
  539. (or (ignore-errors (org-lparse-get 'LATEX-FRAGMENT-FALLBACK))
  540. (if (and (org-check-external-command "latex" "" t)
  541. (org-check-external-command "dvipng" "" t))
  542. 'dvipng
  543. 'verbatim)))
  544. (org-lparse-insert-tag-with-newlines 'both)
  545. (org-lparse-to-buffer to-buffer)
  546. (org-lparse-body-only body-only)
  547. (org-lparse-entity-control-callbacks-alist
  548. (org-lparse-get 'ENTITY-CONTROL))
  549. (org-lparse-entity-format-callbacks-alist
  550. (org-lparse-get 'ENTITY-FORMAT))
  551. (opt-plist
  552. (org-export-process-option-filters
  553. (org-combine-plists (org-default-export-plist)
  554. ext-plist
  555. (org-infile-export-plist))))
  556. (body-only (or body-only (plist-get opt-plist :body-only)))
  557. valid org-lparse-dyn-first-heading-pos
  558. (odd org-odd-levels-only)
  559. (region-p (org-region-active-p))
  560. (rbeg (and region-p (region-beginning)))
  561. (rend (and region-p (region-end)))
  562. (subtree-p
  563. (if (plist-get opt-plist :ignore-subtree-p)
  564. nil
  565. (when region-p
  566. (save-excursion
  567. (goto-char rbeg)
  568. (and (org-at-heading-p)
  569. (>= (org-end-of-subtree t t) rend))))))
  570. (level-offset (if subtree-p
  571. (save-excursion
  572. (goto-char rbeg)
  573. (+ (funcall outline-level)
  574. (if org-odd-levels-only 1 0)))
  575. 0))
  576. (opt-plist (setq org-export-opt-plist
  577. (if subtree-p
  578. (org-export-add-subtree-options opt-plist rbeg)
  579. opt-plist)))
  580. ;; The following two are dynamically scoped into other
  581. ;; routines below.
  582. (org-current-export-dir
  583. (or pub-dir (org-lparse-get 'EXPORT-DIR opt-plist)))
  584. (org-current-export-file buffer-file-name)
  585. (level 0) (line "") (origline "") txt todo
  586. (umax nil)
  587. (umax-toc nil)
  588. (filename (if to-buffer nil
  589. (expand-file-name
  590. (concat
  591. (file-name-sans-extension
  592. (or (and subtree-p
  593. (org-entry-get (region-beginning)
  594. "EXPORT_FILE_NAME" t))
  595. (file-name-nondirectory buffer-file-name)))
  596. "." (org-lparse-get 'FILE-NAME-EXTENSION opt-plist))
  597. (file-name-as-directory
  598. (or pub-dir (org-lparse-get 'EXPORT-DIR opt-plist))))))
  599. (current-dir (if buffer-file-name
  600. (file-name-directory buffer-file-name)
  601. default-directory))
  602. (auto-insert nil) ; Avoid any auto-insert stuff for the new file
  603. (buffer (if to-buffer
  604. (cond
  605. ((eq to-buffer 'string)
  606. (get-buffer-create (org-lparse-get 'EXPORT-BUFFER-NAME)))
  607. (t (get-buffer-create to-buffer)))
  608. (find-file-noselect
  609. (or (let ((f (org-lparse-get 'INIT-METHOD)))
  610. (and f (functionp f) (funcall f filename)))
  611. filename))))
  612. (org-levels-open (make-vector org-level-max nil))
  613. (dummy (mapc
  614. (lambda(p)
  615. (let* ((val (plist-get opt-plist p))
  616. (val (org-xml-encode-org-text-skip-links val)))
  617. (setq opt-plist (plist-put opt-plist p val))))
  618. '(:date :author :keywords :description)))
  619. (date (plist-get opt-plist :date))
  620. (date (cond
  621. ((and date (string-match "%" date))
  622. (format-time-string date))
  623. (date date)
  624. (t (format-time-string "%Y-%m-%d %T %Z"))))
  625. (dummy (setq opt-plist (plist-put opt-plist :effective-date date)))
  626. (title (org-xml-encode-org-text-skip-links
  627. (or (and subtree-p (org-export-get-title-from-subtree))
  628. (plist-get opt-plist :title)
  629. (and (not body-only)
  630. (not
  631. (plist-get opt-plist :skip-before-1st-heading))
  632. (org-export-grab-title-from-buffer))
  633. (and buffer-file-name
  634. (file-name-sans-extension
  635. (file-name-nondirectory buffer-file-name)))
  636. "UNTITLED")))
  637. (dummy (setq opt-plist (plist-put opt-plist :title title)))
  638. (html-table-tag (plist-get opt-plist :html-table-tag))
  639. (quote-re0 (concat "^ *" org-quote-string "\\( +\\|[ \t]*$\\)"))
  640. (quote-re (format org-heading-keyword-regexp-format
  641. org-quote-string))
  642. (org-lparse-dyn-current-environment nil)
  643. ;; Get the language-dependent settings
  644. (lang-words (or (assoc (plist-get opt-plist :language)
  645. org-export-language-setup)
  646. (assoc "en" org-export-language-setup)))
  647. (dummy (setq opt-plist (plist-put opt-plist :lang-words lang-words)))
  648. (head-count 0) cnt
  649. (start 0)
  650. (coding-system-for-write
  651. (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-WRITE))
  652. (and (boundp 'buffer-file-coding-system)
  653. buffer-file-coding-system)))
  654. (save-buffer-coding-system
  655. (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-SAVE))
  656. (and (boundp 'buffer-file-coding-system)
  657. buffer-file-coding-system)))
  658. (region
  659. (buffer-substring
  660. (if region-p (region-beginning) (point-min))
  661. (if region-p (region-end) (point-max))))
  662. (org-export-have-math nil)
  663. (org-export-footnotes-seen nil)
  664. (org-export-footnotes-data (org-footnote-all-labels 'with-defs))
  665. (org-footnote-insert-pos-for-preprocessor 'point-min)
  666. (org-lparse-opt-plist opt-plist)
  667. (lines
  668. (org-split-string
  669. (org-export-preprocess-string
  670. region
  671. :emph-multiline t
  672. :for-backend (if (equal org-lparse-backend 'xhtml) ; hack
  673. 'html
  674. org-lparse-backend)
  675. :skip-before-1st-heading
  676. (plist-get opt-plist :skip-before-1st-heading)
  677. :drawers (plist-get opt-plist :drawers)
  678. :todo-keywords (plist-get opt-plist :todo-keywords)
  679. :tasks (plist-get opt-plist :tasks)
  680. :tags (plist-get opt-plist :tags)
  681. :priority (plist-get opt-plist :priority)
  682. :footnotes (plist-get opt-plist :footnotes)
  683. :timestamps (plist-get opt-plist :timestamps)
  684. :archived-trees
  685. (plist-get opt-plist :archived-trees)
  686. :select-tags (plist-get opt-plist :select-tags)
  687. :exclude-tags (plist-get opt-plist :exclude-tags)
  688. :add-text
  689. (plist-get opt-plist :text)
  690. :LaTeX-fragments
  691. (plist-get opt-plist :LaTeX-fragments))
  692. "[\r\n]"))
  693. table-open
  694. table-buffer table-orig-buffer
  695. ind
  696. rpl path attr desc descp desc1 desc2 link
  697. snumber fnc
  698. footnotes footref-seen
  699. org-lparse-output-buffer
  700. org-lparse-footnote-definitions
  701. org-lparse-footnote-number
  702. ;; collection
  703. org-lparse-collect-buffer
  704. (org-lparse-collect-count 0) ; things will get haywire if
  705. ; collections are chained. Use
  706. ; this variable to assert this
  707. ; pre-requisite
  708. org-lparse-toc
  709. href
  710. )
  711. (let ((inhibit-read-only t))
  712. (org-unmodified
  713. (remove-text-properties (point-min) (point-max)
  714. '(:org-license-to-kill t))))
  715. (message "Exporting...")
  716. (org-init-section-numbers)
  717. ;; Switch to the output buffer
  718. (setq org-lparse-output-buffer buffer)
  719. (set-buffer org-lparse-output-buffer)
  720. (let ((inhibit-read-only t)) (erase-buffer))
  721. (fundamental-mode)
  722. (org-install-letbind)
  723. (and (fboundp 'set-buffer-file-coding-system)
  724. (set-buffer-file-coding-system coding-system-for-write))
  725. (let ((case-fold-search nil)
  726. (org-odd-levels-only odd))
  727. ;; create local variables for all options, to make sure all called
  728. ;; functions get the correct information
  729. (mapc (lambda (x)
  730. (set (make-local-variable (nth 2 x))
  731. (plist-get opt-plist (car x))))
  732. org-export-plist-vars)
  733. (setq umax (if arg (prefix-numeric-value arg)
  734. org-export-headline-levels))
  735. (setq umax-toc (if (integerp org-export-with-toc)
  736. (min org-export-with-toc umax)
  737. umax))
  738. (setq org-lparse-opt-plist
  739. (plist-put org-lparse-opt-plist :headline-levels umax))
  740. (when (and org-export-with-toc (not body-only))
  741. (setq lines (org-lparse-prepare-toc
  742. lines level-offset opt-plist umax-toc)))
  743. (unless body-only
  744. (org-lparse-begin 'DOCUMENT-CONTENT opt-plist)
  745. (org-lparse-begin 'DOCUMENT-BODY opt-plist))
  746. (setq head-count 0)
  747. (org-init-section-numbers)
  748. (org-lparse-begin-paragraph)
  749. (while (setq line (pop lines) origline line)
  750. (catch 'nextline
  751. (when (and (org-lparse-current-environment-p 'quote)
  752. (string-match org-outline-regexp-bol line))
  753. (org-lparse-end-environment 'quote))
  754. (when (org-lparse-current-environment-p 'quote)
  755. (org-lparse-insert 'LINE line)
  756. (throw 'nextline nil))
  757. ;; Fixed-width, verbatim lines (examples)
  758. (when (and org-export-with-fixed-width
  759. (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
  760. (when (not (org-lparse-current-environment-p 'fixedwidth))
  761. (org-lparse-begin-environment 'fixedwidth))
  762. (org-lparse-insert 'LINE (match-string 3 line))
  763. (when (or (not lines)
  764. (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
  765. (car lines))))
  766. (org-lparse-end-environment 'fixedwidth))
  767. (throw 'nextline nil))
  768. ;; Native Text
  769. (when (and (get-text-property 0 'org-native-text line)
  770. ;; Make sure it is the entire line that is protected
  771. (not (< (or (next-single-property-change
  772. 0 'org-native-text line) 10000)
  773. (length line))))
  774. (let ((ind (get-text-property 0 'original-indentation line)))
  775. (org-lparse-begin-environment 'native)
  776. (org-lparse-insert 'LINE line)
  777. (while (and lines
  778. (or (= (length (car lines)) 0)
  779. (not ind)
  780. (equal ind (get-text-property
  781. 0 'original-indentation (car lines))))
  782. (or (= (length (car lines)) 0)
  783. (get-text-property 0 'org-native-text (car lines))))
  784. (org-lparse-insert 'LINE (pop lines)))
  785. (org-lparse-end-environment 'native))
  786. (throw 'nextline nil))
  787. ;; Protected HTML
  788. (when (and (get-text-property 0 'org-protected line)
  789. ;; Make sure it is the entire line that is protected
  790. (not (< (or (next-single-property-change
  791. 0 'org-protected line) 10000)
  792. (length line))))
  793. (let ((ind (get-text-property 0 'original-indentation line)))
  794. (org-lparse-insert 'LINE line)
  795. (while (and lines
  796. (or (= (length (car lines)) 0)
  797. (not ind)
  798. (equal ind (get-text-property
  799. 0 'original-indentation (car lines))))
  800. (or (= (length (car lines)) 0)
  801. (get-text-property 0 'org-protected (car lines))))
  802. (org-lparse-insert 'LINE (pop lines))))
  803. (throw 'nextline nil))
  804. ;; Blockquotes, verse, and center
  805. (when (string-match
  806. "^ORG-\\(.+\\)-\\(START\\|END\\)\\([ \t]+.*\\)?$" line)
  807. (let* ((style (intern (downcase (match-string 1 line))))
  808. (env-options-plist (org-lparse-get-block-params
  809. (match-string 3 line)))
  810. (f (cdr (assoc (match-string 2 line)
  811. '(("START" . org-lparse-begin-environment)
  812. ("END" . org-lparse-end-environment))))))
  813. (when (memq style
  814. (append
  815. '(blockquote verse center)
  816. (mapcar 'intern org-lparse-special-blocks)))
  817. (funcall f style env-options-plist)
  818. (throw 'nextline nil))))
  819. (when (org-lparse-current-environment-p 'verse)
  820. (let ((i (org-get-string-indentation line)))
  821. (if (> i 0)
  822. (setq line (concat
  823. (let ((org-lparse-encode-pending t))
  824. (org-lparse-format 'SPACES (* 2 i)))
  825. " " (org-trim line))))
  826. (unless (string-match "\\\\\\\\[ \t]*$" line)
  827. (setq line (concat line "\\\\")))))
  828. ;; make targets to anchors
  829. (setq start 0)
  830. (while (string-match
  831. "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
  832. (cond
  833. ((get-text-property (match-beginning 1) 'org-protected line)
  834. (setq start (match-end 1)))
  835. ((match-end 2)
  836. (setq line (replace-match
  837. (let ((org-lparse-encode-pending t))
  838. (org-lparse-format
  839. 'ANCHOR "" (org-solidify-link-text
  840. (match-string 1 line))))
  841. t t line)))
  842. ((and org-export-with-toc (equal (string-to-char line) ?*))
  843. ;; FIXME: NOT DEPENDENT on TOC?????????????????????
  844. (setq line (replace-match
  845. (let ((org-lparse-encode-pending t))
  846. (org-lparse-format
  847. 'FONTIFY (match-string 1 line) "target"))
  848. ;; (concat "@<i>" (match-string 1 line) "@</i> ")
  849. t t line)))
  850. (t
  851. (setq line (replace-match
  852. (concat
  853. (let ((org-lparse-encode-pending t))
  854. (org-lparse-format
  855. 'ANCHOR (match-string 1 line)
  856. (org-solidify-link-text (match-string 1 line))
  857. "target")) " ")
  858. t t line)))))
  859. (let ((org-lparse-encode-pending t))
  860. (setq line (org-lparse-handle-time-stamps line)))
  861. ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
  862. ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
  863. ;; Also handle sub_superscripts and checkboxes
  864. (or (string-match org-table-hline-regexp line)
  865. (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line)
  866. (setq line (org-xml-encode-org-text-skip-links line)))
  867. (setq line (org-lparse-format-org-link line opt-plist))
  868. ;; TODO items
  869. (if (and org-todo-line-regexp
  870. (string-match org-todo-line-regexp line)
  871. (match-beginning 2))
  872. (setq line (concat
  873. (substring line 0 (match-beginning 2))
  874. (org-lparse-format 'TODO (match-string 2 line))
  875. (substring line (match-end 2)))))
  876. ;; Does this contain a reference to a footnote?
  877. (when org-export-with-footnotes
  878. (setq start 0)
  879. (while (string-match "\\([^* \t].*?\\)[ \t]*\\[\\([0-9]+\\)\\]" line start)
  880. ;; Discard protected matches not clearly identified as
  881. ;; footnote markers.
  882. (if (or (get-text-property (match-beginning 2) 'org-protected line)
  883. (not (get-text-property (match-beginning 2) 'org-footnote line)))
  884. (setq start (match-end 2))
  885. (let ((n (match-string 2 line)) refcnt a)
  886. (if (setq a (assoc n footref-seen))
  887. (progn
  888. (setcdr a (1+ (cdr a)))
  889. (setq refcnt (cdr a)))
  890. (setq refcnt 1)
  891. (push (cons n 1) footref-seen))
  892. (setq line
  893. (replace-match
  894. (concat
  895. (or (match-string 1 line) "")
  896. (org-lparse-format
  897. 'FOOTNOTE-REFERENCE
  898. n (cdr (assoc n org-lparse-footnote-definitions))
  899. refcnt)
  900. ;; If another footnote is following the
  901. ;; current one, add a separator.
  902. (if (save-match-data
  903. (string-match "\\`\\[[0-9]+\\]"
  904. (substring line (match-end 0))))
  905. (ignore-errors
  906. (org-lparse-get 'FOOTNOTE-SEPARATOR))
  907. ""))
  908. t t line))))))
  909. (cond
  910. ((string-match "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$" line)
  911. ;; This is a headline
  912. (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
  913. level-offset))
  914. txt (match-string 2 line))
  915. (if (string-match quote-re0 txt)
  916. (setq txt (replace-match "" t t txt)))
  917. (if (<= level (max umax umax-toc))
  918. (setq head-count (+ head-count 1)))
  919. (unless org-lparse-dyn-first-heading-pos
  920. (setq org-lparse-dyn-first-heading-pos (point)))
  921. (org-lparse-begin-level level txt umax head-count)
  922. ;; QUOTES
  923. (when (string-match quote-re line)
  924. (org-lparse-begin-environment 'quote)))
  925. ((and org-export-with-tables
  926. (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
  927. (when (not table-open)
  928. ;; New table starts
  929. (setq table-open t table-buffer nil table-orig-buffer nil))
  930. ;; Accumulate lines
  931. (setq table-buffer (cons line table-buffer)
  932. table-orig-buffer (cons origline table-orig-buffer))
  933. (when (or (not lines)
  934. (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
  935. (car lines))))
  936. (setq table-open nil
  937. table-buffer (nreverse table-buffer)
  938. table-orig-buffer (nreverse table-orig-buffer))
  939. (org-lparse-end-paragraph)
  940. (when org-lparse-list-table-p
  941. (error "Regular tables are not allowed in a list-table block"))
  942. (org-lparse-insert 'TABLE table-buffer table-orig-buffer)))
  943. ;; Normal lines
  944. (t
  945. ;; This line either is list item or end a list.
  946. (when (get-text-property 0 'list-item line)
  947. (setq line (org-lparse-export-list-line
  948. line
  949. (get-text-property 0 'list-item line)
  950. (get-text-property 0 'list-struct line)
  951. (get-text-property 0 'list-prevs line))))
  952. ;; Horizontal line
  953. (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
  954. (with-org-lparse-preserve-paragraph-state
  955. (org-lparse-insert 'HORIZONTAL-LINE))
  956. (throw 'nextline nil))
  957. ;; Empty lines start a new paragraph. If hand-formatted lists
  958. ;; are not fully interpreted, lines starting with "-", "+", "*"
  959. ;; also start a new paragraph.
  960. (when (string-match "^ [-+*]-\\|^[ \t]*$" line)
  961. (when org-lparse-footnote-number
  962. (org-lparse-end-footnote-definition org-lparse-footnote-number)
  963. (setq org-lparse-footnote-number nil))
  964. (org-lparse-begin-paragraph))
  965. ;; Is this the start of a footnote?
  966. (when org-export-with-footnotes
  967. (when (and (boundp 'footnote-section-tag-regexp)
  968. (string-match (concat "^" footnote-section-tag-regexp)
  969. line))
  970. ;; ignore this line
  971. (throw 'nextline nil))
  972. (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
  973. (org-lparse-end-paragraph)
  974. (setq org-lparse-footnote-number (match-string 1 line))
  975. (setq line (replace-match "" t t line))
  976. (org-lparse-begin-footnote-definition org-lparse-footnote-number)))
  977. ;; Check if the line break needs to be conserved
  978. (cond
  979. ((string-match "\\\\\\\\[ \t]*$" line)
  980. (setq line (replace-match
  981. (org-lparse-format 'LINE-BREAK)
  982. t t line)))
  983. (org-export-preserve-breaks
  984. (setq line (concat line (org-lparse-format 'LINE-BREAK)))))
  985. ;; Check if a paragraph should be started
  986. (let ((start 0))
  987. (while (and org-lparse-par-open
  988. (string-match "\\\\par\\>" line start))
  989. (error "FIXME")
  990. ;; Leave a space in the </p> so that the footnote matcher
  991. ;; does not see this.
  992. (if (not (get-text-property (match-beginning 0)
  993. 'org-protected line))
  994. (setq line (replace-match "</p ><p >" t t line)))
  995. (setq start (match-end 0))))
  996. (org-lparse-insert 'LINE line)))))
  997. ;; Properly close all local lists and other lists
  998. (when (org-lparse-current-environment-p 'quote)
  999. (org-lparse-end-environment 'quote))
  1000. (org-lparse-end-level 1 umax)
  1001. ;; the </div> to close the last text-... div.
  1002. (when (and (> umax 0) org-lparse-dyn-first-heading-pos)
  1003. (org-lparse-end-outline-text-or-outline))
  1004. (org-lparse-end 'DOCUMENT-BODY opt-plist)
  1005. (unless body-only
  1006. (org-lparse-end 'DOCUMENT-CONTENT))
  1007. (org-lparse-end 'EXPORT)
  1008. ;; kill collection buffer
  1009. (when org-lparse-collect-buffer
  1010. (kill-buffer org-lparse-collect-buffer))
  1011. (goto-char (point-min))
  1012. (or (org-export-push-to-kill-ring
  1013. (upcase (symbol-name org-lparse-backend)))
  1014. (message "Exporting... done"))
  1015. (cond
  1016. ((not to-buffer)
  1017. (let ((f (org-lparse-get 'SAVE-METHOD)))
  1018. (or (and f (functionp f) (funcall f filename opt-plist))
  1019. (save-buffer)))
  1020. (or (and (boundp 'org-lparse-other-backend)
  1021. org-lparse-other-backend
  1022. (not (equal org-lparse-backend org-lparse-other-backend))
  1023. (org-lparse-do-convert
  1024. buffer-file-name (symbol-name org-lparse-other-backend)))
  1025. (current-buffer)))
  1026. ((eq to-buffer 'string)
  1027. (prog1 (buffer-substring (point-min) (point-max))
  1028. (kill-buffer (current-buffer))))
  1029. (t (current-buffer))))))
  1030. (defun org-lparse-format-table (lines olines)
  1031. "Returns backend-specific code for org-type and table-type tables."
  1032. (if (stringp lines)
  1033. (setq lines (org-split-string lines "\n")))
  1034. (if (string-match "^[ \t]*|" (car lines))
  1035. ;; A normal org table
  1036. (org-lparse-format-org-table lines nil)
  1037. ;; Table made by table.el
  1038. (or (org-lparse-format-table-table-using-table-generate-source
  1039. ;; FIXME: Need to take care of this during merge
  1040. (if (eq org-lparse-backend 'xhtml) 'html org-lparse-backend)
  1041. olines
  1042. (not org-export-prefer-native-exporter-for-tables))
  1043. ;; We are here only when table.el table has NO col or row
  1044. ;; spanning and the user prefers using org's own converter for
  1045. ;; exporting of such simple table.el tables.
  1046. (org-lparse-format-table-table lines))))
  1047. (defun org-lparse-table-get-colalign-info (lines)
  1048. (let ((col-cookies (org-find-text-property-in-string
  1049. 'org-col-cookies (car lines))))
  1050. (when (and col-cookies org-table-clean-did-remove-column)
  1051. (setq col-cookies
  1052. (mapcar (lambda (x) (cons (1- (car x)) (cdr x))) col-cookies)))
  1053. col-cookies))
  1054. (defvar org-lparse-table-style)
  1055. (defvar org-lparse-table-ncols)
  1056. (defvar org-lparse-table-rownum)
  1057. (defvar org-lparse-table-is-styled)
  1058. (defvar org-lparse-table-begin-marker)
  1059. (defvar org-lparse-table-num-numeric-items-per-column)
  1060. (defvar org-lparse-table-colalign-info)
  1061. (defvar org-lparse-table-colalign-vector)
  1062. ;; Following variables are defined in org-table.el
  1063. (defvar org-table-number-fraction)
  1064. (defvar org-table-number-regexp)
  1065. (defun org-lparse-org-table-to-list-table (lines &optional splice)
  1066. "Convert org-table to list-table.
  1067. LINES is a list of the form (ROW1 ROW2 ROW3 ...) where each
  1068. element is a `string' representing a single row of org-table.
  1069. Thus each ROW has vertical separators \"|\" separating the table
  1070. fields. A ROW could also be a row-group separator of the form
  1071. \"|---...|\". Return a list of the form (ROW1 ROW2 ROW3
  1072. ...). ROW could either be symbol `:hrule' or a list of the
  1073. form (FIELD1 FIELD2 FIELD3 ...) as appropriate."
  1074. (let (line lines-1)
  1075. (cond
  1076. (splice
  1077. (while (setq line (pop lines))
  1078. (unless (string-match "^[ \t]*|-" line)
  1079. (push (org-split-string line "[ \t]*|[ \t]*") lines-1))))
  1080. (t
  1081. (while (setq line (pop lines))
  1082. (cond
  1083. ((string-match "^[ \t]*|-" line)
  1084. (when lines
  1085. (push :hrule lines-1)))
  1086. (t
  1087. (push (org-split-string line "[ \t]*|[ \t]*") lines-1))))))
  1088. (nreverse lines-1)))
  1089. (defun org-lparse-insert-org-table (lines &optional splice)
  1090. "Format a org-type table into backend-specific code.
  1091. LINES is a list of lines. Optional argument SPLICE means, do not
  1092. insert header and surrounding <table> tags, just format the lines.
  1093. Optional argument NO-CSS means use XHTML attributes instead of CSS
  1094. for formatting. This is required for the DocBook exporter."
  1095. (require 'org-table)
  1096. ;; Get rid of hlines at beginning and end
  1097. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1098. (setq lines (nreverse lines))
  1099. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1100. (setq lines (nreverse lines))
  1101. (when org-export-table-remove-special-lines
  1102. ;; Check if the table has a marking column. If yes remove the
  1103. ;; column and the special lines
  1104. (setq lines (org-table-clean-before-export lines)))
  1105. (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
  1106. (short-caption (or (org-find-text-property-in-string
  1107. 'org-caption-shortn (car lines)) caption))
  1108. (caption (and caption (org-xml-encode-org-text caption)))
  1109. (short-caption (and short-caption
  1110. (org-xml-encode-plain-text short-caption)))
  1111. (label (org-find-text-property-in-string 'org-label (car lines)))
  1112. (org-lparse-table-colalign-info (org-lparse-table-get-colalign-info lines))
  1113. (attributes (org-find-text-property-in-string 'org-attributes
  1114. (car lines)))
  1115. (head (and org-export-highlight-first-table-line
  1116. (delq nil (mapcar
  1117. (lambda (x) (string-match "^[ \t]*|-" x))
  1118. (cdr lines))))))
  1119. (setq lines (org-lparse-org-table-to-list-table lines splice))
  1120. (org-lparse-insert-list-table
  1121. lines splice caption label attributes head org-lparse-table-colalign-info
  1122. short-caption)))
  1123. (defun org-lparse-insert-list-table (lines &optional splice
  1124. caption label attributes head
  1125. org-lparse-table-colalign-info
  1126. short-caption)
  1127. (or (featurep 'org-table) ; required for
  1128. (require 'org-table)) ; `org-table-number-regexp'
  1129. (let* ((org-lparse-table-rownum -1) org-lparse-table-ncols i (cnt 0)
  1130. tbopen fields line
  1131. org-lparse-table-cur-rowgrp-is-hdr
  1132. org-lparse-table-rowgrp-open
  1133. org-lparse-table-num-numeric-items-per-column
  1134. org-lparse-table-colalign-vector n
  1135. org-lparse-table-rowgrp-info
  1136. org-lparse-table-begin-marker
  1137. (org-lparse-table-style 'org-table)
  1138. org-lparse-table-is-styled)
  1139. (cond
  1140. (splice
  1141. (setq org-lparse-table-is-styled nil)
  1142. (while (setq line (pop lines))
  1143. (insert (org-lparse-format-table-row line) "\n")))
  1144. (t
  1145. (setq org-lparse-table-is-styled t)
  1146. (org-lparse-begin 'TABLE caption label attributes short-caption)
  1147. (setq org-lparse-table-begin-marker (point))
  1148. (org-lparse-begin-table-rowgroup head)
  1149. (while (setq line (pop lines))
  1150. (cond
  1151. ((equal line :hrule)
  1152. (org-lparse-begin-table-rowgroup))
  1153. (t
  1154. (insert (org-lparse-format-table-row line) "\n"))))
  1155. (org-lparse-end 'TABLE-ROWGROUP)
  1156. (org-lparse-end-table)))))
  1157. (defun org-lparse-format-org-table (lines &optional splice)
  1158. (with-temp-buffer
  1159. (org-lparse-insert-org-table lines splice)
  1160. (buffer-substring-no-properties (point-min) (point-max))))
  1161. (defun org-lparse-format-list-table (lines &optional splice)
  1162. (with-temp-buffer
  1163. (org-lparse-insert-list-table lines splice)
  1164. (buffer-substring-no-properties (point-min) (point-max))))
  1165. (defun org-lparse-insert-table-table (lines)
  1166. "Format a table generated by table.el into backend-specific code.
  1167. This conversion does *not* use `table-generate-source' from table.el.
  1168. This has the advantage that Org-mode's HTML conversions can be used.
  1169. But it has the disadvantage, that no cell- or row-spanning is allowed."
  1170. (let (line field-buffer
  1171. (org-lparse-table-cur-rowgrp-is-hdr
  1172. org-export-highlight-first-table-line)
  1173. (caption nil)
  1174. (short-caption nil)
  1175. (attributes nil)
  1176. (label nil)
  1177. (org-lparse-table-style 'table-table)
  1178. (org-lparse-table-is-styled nil)
  1179. fields org-lparse-table-ncols i (org-lparse-table-rownum -1)
  1180. (empty (org-lparse-format 'SPACES 1)))
  1181. (org-lparse-begin 'TABLE caption label attributes short-caption)
  1182. (while (setq line (pop lines))
  1183. (cond
  1184. ((string-match "^[ \t]*\\+-" line)
  1185. (when field-buffer
  1186. (let ((org-export-table-row-tags '("<tr>" . "</tr>"))
  1187. ;; (org-export-html-table-use-header-tags-for-first-column nil)
  1188. )
  1189. (insert (org-lparse-format-table-row field-buffer empty)))
  1190. (setq org-lparse-table-cur-rowgrp-is-hdr nil)
  1191. (setq field-buffer nil)))
  1192. (t
  1193. ;; Break the line into fields and store the fields
  1194. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1195. (if field-buffer
  1196. (setq field-buffer (mapcar
  1197. (lambda (x)
  1198. (concat x (org-lparse-format 'LINE-BREAK)
  1199. (pop fields)))
  1200. field-buffer))
  1201. (setq field-buffer fields)))))
  1202. (org-lparse-end-table)))
  1203. (defun org-lparse-format-table-table (lines)
  1204. (with-temp-buffer
  1205. (org-lparse-insert-table-table lines)
  1206. (buffer-substring-no-properties (point-min) (point-max))))
  1207. (defvar table-source-languages) ; defined in table.el
  1208. (defun org-lparse-format-table-table-using-table-generate-source (backend
  1209. lines
  1210. &optional
  1211. spanned-only)
  1212. "Format a table into BACKEND, using `table-generate-source' from table.el.
  1213. Use SPANNED-ONLY to suppress exporting of simple table.el tables.
  1214. When SPANNED-ONLY is nil, all table.el tables are exported. When
  1215. SPANNED-ONLY is non-nil, only tables with either row or column
  1216. spans are exported.
  1217. This routine returns the generated source or nil as appropriate.
  1218. Refer docstring of `org-export-prefer-native-exporter-for-tables'
  1219. for further information."
  1220. (require 'table)
  1221. (with-current-buffer (get-buffer-create " org-tmp1 ")
  1222. (erase-buffer)
  1223. (insert (mapconcat 'identity lines "\n"))
  1224. (goto-char (point-min))
  1225. (if (not (re-search-forward "|[^+]" nil t))
  1226. (error "Error processing table"))
  1227. (table-recognize-table)
  1228. (when (or (not spanned-only)
  1229. (let* ((dim (table-query-dimension))
  1230. (c (nth 4 dim)) (r (nth 5 dim)) (cells (nth 6 dim)))
  1231. (not (= (* c r) cells))))
  1232. (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
  1233. (cond
  1234. ((member backend table-source-languages)
  1235. (table-generate-source backend " org-tmp2 ")
  1236. (set-buffer " org-tmp2 ")
  1237. (buffer-substring (point-min) (point-max)))
  1238. (t
  1239. ;; table.el doesn't support the given backend. Currently this
  1240. ;; happens in case of odt export. Strip the table from the
  1241. ;; generated document. A better alternative would be to embed
  1242. ;; the table as ascii text in the output document.
  1243. (org-lparse-warn
  1244. (concat
  1245. "Found table.el-type table in the source org file. "
  1246. (format "table.el doesn't support %s backend. "
  1247. (upcase (symbol-name backend)))
  1248. "Skipping ahead ..."))
  1249. "")))))
  1250. (defun org-lparse-handle-time-stamps (s)
  1251. "Format time stamps in string S, or remove them."
  1252. (catch 'exit
  1253. (let (r b)
  1254. (when org-maybe-keyword-time-regexp
  1255. (while (string-match org-maybe-keyword-time-regexp s)
  1256. (or b (setq b (substring s 0 (match-beginning 0))))
  1257. (setq r (concat
  1258. r (substring s 0 (match-beginning 0)) " "
  1259. (org-lparse-format
  1260. 'FONTIFY
  1261. (concat
  1262. (if (match-end 1)
  1263. (org-lparse-format
  1264. 'FONTIFY
  1265. (match-string 1 s) "timestamp-kwd"))
  1266. " "
  1267. (org-lparse-format
  1268. 'FONTIFY
  1269. (substring (org-translate-time (match-string 3 s)) 1 -1)
  1270. "timestamp"))
  1271. "timestamp-wrapper"))
  1272. s (substring s (match-end 0)))))
  1273. ;; Line break if line started and ended with time stamp stuff
  1274. (if (not r)
  1275. s
  1276. (setq r (concat r s))
  1277. (unless (string-match "\\S-" (concat b s))
  1278. (setq r (concat r (org-lparse-format 'LINE-BREAK))))
  1279. r))))
  1280. (defun org-xml-encode-plain-text (s)
  1281. "Convert plain text characters to HTML equivalent.
  1282. Possible conversions are set in `org-export-html-protect-char-alist'."
  1283. (let ((cl (org-lparse-get 'PLAIN-TEXT-MAP)) c)
  1284. (while (setq c (pop cl))
  1285. (let ((start 0))
  1286. (while (string-match (car c) s start)
  1287. (setq s (replace-match (cdr c) t t s)
  1288. start (1+ (match-beginning 0))))))
  1289. s))
  1290. (defun org-xml-encode-org-text-skip-links (string)
  1291. "Prepare STRING for HTML export. Apply all active conversions.
  1292. If there are links in the string, don't modify these. If STRING
  1293. is nil, return nil."
  1294. (when string
  1295. (let* ((re (concat org-bracket-link-regexp "\\|"
  1296. (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
  1297. m s l res)
  1298. (while (setq m (string-match re string))
  1299. (setq s (substring string 0 m)
  1300. l (match-string 0 string)
  1301. string (substring string (match-end 0)))
  1302. (push (org-xml-encode-org-text s) res)
  1303. (push l res))
  1304. (push (org-xml-encode-org-text string) res)
  1305. (apply 'concat (nreverse res)))))
  1306. (defun org-xml-encode-org-text (s)
  1307. "Apply all active conversions to translate special ASCII to HTML."
  1308. (setq s (org-xml-encode-plain-text s))
  1309. (if org-export-html-expand
  1310. (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
  1311. (setq s (replace-match "<\\1>" t nil s))))
  1312. (if org-export-with-emphasize
  1313. (setq s (org-lparse-apply-char-styles s)))
  1314. (if org-export-with-special-strings
  1315. (setq s (org-lparse-convert-special-strings s)))
  1316. (if org-export-with-sub-superscripts
  1317. (setq s (org-lparse-apply-sub-superscript-styles s)))
  1318. (if org-export-with-TeX-macros
  1319. (let ((start 0) wd rep)
  1320. (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
  1321. s start))
  1322. (if (get-text-property (match-beginning 0) 'org-protected s)
  1323. (setq start (match-end 0))
  1324. (setq wd (match-string 1 s))
  1325. (if (setq rep (org-lparse-format 'ORG-ENTITY wd))
  1326. (setq s (replace-match rep t t s))
  1327. (setq start (+ start (length wd))))))))
  1328. s)
  1329. (defun org-lparse-convert-special-strings (string)
  1330. "Convert special characters in STRING to HTML."
  1331. (let ((all (org-lparse-get 'SPECIAL-STRING-REGEXPS))
  1332. e a re rpl start)
  1333. (while (setq a (pop all))
  1334. (setq re (car a) rpl (cdr a) start 0)
  1335. (while (string-match re string start)
  1336. (if (get-text-property (match-beginning 0) 'org-protected string)
  1337. (setq start (match-end 0))
  1338. (setq string (replace-match rpl t nil string)))))
  1339. string))
  1340. (defun org-lparse-apply-sub-superscript-styles (string)
  1341. "Apply subscript and superscript styles to STRING.
  1342. Use `org-export-with-sub-superscripts' to control application of
  1343. sub and superscript styles."
  1344. (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
  1345. (while (string-match org-match-substring-regexp string s)
  1346. (cond
  1347. ((and requireb (match-end 8)) (setq s (match-end 2)))
  1348. ((get-text-property (match-beginning 2) 'org-protected string)
  1349. (setq s (match-end 2)))
  1350. (t
  1351. (setq s (match-end 1)
  1352. key (if (string= (match-string 2 string) "_")
  1353. 'subscript 'superscript)
  1354. c (or (match-string 8 string)
  1355. (match-string 6 string)
  1356. (match-string 5 string))
  1357. string (replace-match
  1358. (concat (match-string 1 string)
  1359. (org-lparse-format 'FONTIFY c key))
  1360. t t string)))))
  1361. (while (string-match "\\\\\\([_^]\\)" string)
  1362. (setq string (replace-match (match-string 1 string) t t string)))
  1363. string))
  1364. (defvar org-lparse-char-styles
  1365. `(("*" bold)
  1366. ("/" emphasis)
  1367. ("_" underline)
  1368. ("=" code)
  1369. ("~" verbatim)
  1370. ("+" strike))
  1371. "Map Org emphasis markers to char styles.
  1372. This is an alist where each element is of the
  1373. form (ORG-EMPHASIS-CHAR . CHAR-STYLE).")
  1374. (defun org-lparse-apply-char-styles (string)
  1375. "Apply char styles to STRING.
  1376. The variable `org-lparse-char-styles' controls how the Org
  1377. emphasis markers are interpreted."
  1378. (let ((s 0) rpl)
  1379. (while (string-match org-emph-re string s)
  1380. (if (not (equal
  1381. (substring string (match-beginning 3) (1+ (match-beginning 3)))
  1382. (substring string (match-beginning 4) (1+ (match-beginning 4)))))
  1383. (setq s (match-beginning 0)
  1384. rpl
  1385. (concat
  1386. (match-string 1 string)
  1387. (org-lparse-format
  1388. 'FONTIFY (match-string 4 string)
  1389. (nth 1 (assoc (match-string 3 string)
  1390. org-lparse-char-styles)))
  1391. (match-string 5 string))
  1392. string (replace-match rpl t t string)
  1393. s (+ s (- (length rpl) 2)))
  1394. (setq s (1+ s))))
  1395. string))
  1396. (defun org-lparse-export-list-line (line pos struct prevs)
  1397. "Insert list syntax in export buffer. Return LINE, maybe modified.
  1398. POS is the item position or line position the line had before
  1399. modifications to buffer. STRUCT is the list structure. PREVS is
  1400. the alist of previous items."
  1401. (let* ((get-type
  1402. (function
  1403. ;; Translate type of list containing POS to "d", "o" or
  1404. ;; "u".
  1405. (lambda (pos struct prevs)
  1406. (let ((type (org-list-get-list-type pos struct prevs)))
  1407. (cond
  1408. ((eq 'ordered type) "o")
  1409. ((eq 'descriptive type) "d")
  1410. (t "u"))))))
  1411. (get-closings
  1412. (function
  1413. ;; Return list of all items and sublists ending at POS, in
  1414. ;; reverse order.
  1415. (lambda (pos)
  1416. (let (out)
  1417. (catch 'exit
  1418. (mapc (lambda (e)
  1419. (let ((end (nth 6 e))
  1420. (item (car e)))
  1421. (cond
  1422. ((= end pos) (push item out))
  1423. ((>= item pos) (throw 'exit nil)))))
  1424. struct))
  1425. out)))))
  1426. ;; First close any previous item, or list, ending at POS.
  1427. (mapc (lambda (e)
  1428. (let* ((lastp (= (org-list-get-last-item e struct prevs) e))
  1429. (first-item (org-list-get-list-begin e struct prevs))
  1430. (type (funcall get-type first-item struct prevs)))
  1431. (org-lparse-end-paragraph)
  1432. ;; Ending for every item
  1433. (org-lparse-end-list-item-1 type)
  1434. ;; We're ending last item of the list: end list.
  1435. (when lastp
  1436. (org-lparse-end-list type)
  1437. (org-lparse-begin-paragraph))))
  1438. (funcall get-closings pos))
  1439. (cond
  1440. ;; At an item: insert appropriate tags in export buffer.
  1441. ((assq pos struct)
  1442. (string-match
  1443. (concat "[ \t]*\\(\\S-+[ \t]*\\)"
  1444. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  1445. "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
  1446. "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
  1447. "\\(.*\\)") line)
  1448. (let* ((checkbox (match-string 3 line))
  1449. (desc-tag (or (match-string 4 line) "???"))
  1450. (body (or (match-string 5 line) ""))
  1451. (list-beg (org-list-get-list-begin pos struct prevs))
  1452. (firstp (= list-beg pos))
  1453. ;; Always refer to first item to determine list type, in
  1454. ;; case list is ill-formed.
  1455. (type (funcall get-type list-beg struct prevs))
  1456. (counter (let ((count-tmp (org-list-get-counter pos struct)))
  1457. (cond
  1458. ((not count-tmp) nil)
  1459. ((string-match "[A-Za-z]" count-tmp)
  1460. (- (string-to-char (upcase count-tmp)) 64))
  1461. ((string-match "[0-9]+" count-tmp)
  1462. count-tmp)))))
  1463. (when firstp
  1464. (org-lparse-end-paragraph)
  1465. (org-lparse-begin-list type))
  1466. (let ((arg (cond ((equal type "d") desc-tag)
  1467. ((equal type "o") counter))))
  1468. (org-lparse-begin-list-item type arg))
  1469. ;; If line had a checkbox, some additional modification is required.
  1470. (when checkbox
  1471. (setq body
  1472. (concat
  1473. (org-lparse-format
  1474. 'FONTIFY (concat
  1475. "["
  1476. (cond
  1477. ((string-match "X" checkbox) "X")
  1478. ((string-match " " checkbox)
  1479. (org-lparse-format 'SPACES 1))
  1480. (t "-"))
  1481. "]")
  1482. 'code)
  1483. " "
  1484. body)))
  1485. ;; Return modified line
  1486. body))
  1487. ;; At a list ender: go to next line (side-effects only).
  1488. ((equal "ORG-LIST-END-MARKER" line) (throw 'nextline nil))
  1489. ;; Not at an item: return line unchanged (side-effects only).
  1490. (t line))))
  1491. (defun org-lparse-bind-local-variables (opt-plist)
  1492. (mapc (lambda (x)
  1493. (set (make-local-variable (nth 2 x))
  1494. (plist-get opt-plist (car x))))
  1495. org-export-plist-vars))
  1496. (defvar org-lparse-table-rowgrp-open)
  1497. (defvar org-lparse-table-cur-rowgrp-is-hdr)
  1498. (defvar org-lparse-footnote-number)
  1499. (defvar org-lparse-footnote-definitions)
  1500. (defvar org-lparse-output-buffer nil
  1501. "Buffer to which `org-do-lparse' writes to.
  1502. This buffer contains the contents of the to-be-created exported
  1503. document.")
  1504. (defcustom org-lparse-debug nil
  1505. "Enable or Disable logging of `org-lparse' callbacks.
  1506. The parameters passed to the backend-registered ENTITY-CONTROL
  1507. and ENTITY-FORMAT callbacks are logged as comment strings in the
  1508. exported buffer. (org-lparse-format 'COMMENT fmt args) is used
  1509. for logging. Customize this variable only if you are an expert
  1510. user. Valid values of this variable are:
  1511. nil : Disable logging
  1512. control : Log all invocations of `org-lparse-begin' and
  1513. `org-lparse-end' callbacks.
  1514. format : Log invocations of `org-lparse-format' callbacks.
  1515. t : Log all invocations of `org-lparse-begin', `org-lparse-end'
  1516. and `org-lparse-format' callbacks,"
  1517. :group 'org-lparse
  1518. :type '(choice
  1519. (const :tag "Disable" nil)
  1520. (const :tag "Format callbacks" format)
  1521. (const :tag "Control callbacks" control)
  1522. (const :tag "Format and Control callbacks" t)))
  1523. (defun org-lparse-begin (entity &rest args)
  1524. "Begin ENTITY in current buffer. ARGS is entity specific.
  1525. ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM etc.
  1526. Use (org-lparse-begin 'LIST \"o\") to begin a list in current
  1527. buffer.
  1528. See `org-xhtml-entity-control-callbacks-alist' for more
  1529. information."
  1530. (when (and (member org-lparse-debug '(t control))
  1531. (not (eq entity 'DOCUMENT-CONTENT)))
  1532. (insert (org-lparse-format 'COMMENT "%s BEGIN %S" entity args)))
  1533. (let ((f (cadr (assoc entity org-lparse-entity-control-callbacks-alist))))
  1534. (unless f (error "Unknown entity: %s" entity))
  1535. (apply f args)))
  1536. (defun org-lparse-end (entity &rest args)
  1537. "Close ENTITY in current buffer. ARGS is entity specific.
  1538. ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM
  1539. etc.
  1540. Use (org-lparse-end 'LIST \"o\") to close a list in current
  1541. buffer.
  1542. See `org-xhtml-entity-control-callbacks-alist' for more
  1543. information."
  1544. (when (and (member org-lparse-debug '(t control))
  1545. (not (eq entity 'DOCUMENT-CONTENT)))
  1546. (insert (org-lparse-format 'COMMENT "%s END %S" entity args)))
  1547. (let ((f (caddr (assoc entity org-lparse-entity-control-callbacks-alist))))
  1548. (unless f (error "Unknown entity: %s" entity))
  1549. (apply f args)))
  1550. (defun org-lparse-begin-paragraph (&optional style)
  1551. "Insert <p>, but first close previous paragraph if any."
  1552. (org-lparse-end-paragraph)
  1553. (org-lparse-begin 'PARAGRAPH style)
  1554. (setq org-lparse-par-open t))
  1555. (defun org-lparse-end-paragraph ()
  1556. "Close paragraph if there is one open."
  1557. (when org-lparse-par-open
  1558. (org-lparse-end 'PARAGRAPH)
  1559. (setq org-lparse-par-open nil)))
  1560. (defun org-lparse-end-list-item-1 (&optional type)
  1561. "Close <li> if necessary."
  1562. (org-lparse-end-paragraph)
  1563. (org-lparse-end-list-item (or type "u")))
  1564. (define-obsolete-function-alias
  1565. 'org-lparse-preprocess-after-blockquote-hook
  1566. 'org-lparse-preprocess-after-blockquote
  1567. "24.3")
  1568. (defun org-lparse-preprocess-after-blockquote ()
  1569. "Treat `org-lparse-special-blocks' specially."
  1570. (goto-char (point-min))
  1571. (while (re-search-forward
  1572. "^[ \t]*#\\+\\(begin\\|end\\)_\\(\\S-+\\)[ \t]*\\(.*\\)$" nil t)
  1573. (when (member (downcase (match-string 2)) org-lparse-special-blocks)
  1574. (replace-match
  1575. (if (equal (downcase (match-string 1)) "begin")
  1576. (format "ORG-%s-START %s" (upcase (match-string 2))
  1577. (match-string 3))
  1578. (format "ORG-%s-END %s" (upcase (match-string 2))
  1579. (match-string 3))) t t))))
  1580. (define-obsolete-function-alias
  1581. 'org-lparse-strip-experimental-blocks-maybe-hook
  1582. 'org-lparse-strip-experimental-blocks-maybe
  1583. "24.3")
  1584. (defun org-lparse-strip-experimental-blocks-maybe ()
  1585. "Strip \"list-table\" and \"annotation\" blocks.
  1586. Stripping happens only when the exported backend is not one of
  1587. \"odt\" or \"xhtml\"."
  1588. (when (not org-lparse-backend)
  1589. (message "Stripping following blocks - %S" org-lparse-special-blocks)
  1590. (goto-char (point-min))
  1591. (let ((case-fold-search t))
  1592. (while
  1593. (re-search-forward
  1594. "^[ \t]*#\\+begin_\\(\\S-+\\)\\([ \t]+.*\\)?\n\\([^\000]*?\\)\n[ \t]*#\\+end_\\1\\>.*"
  1595. nil t)
  1596. (when (member (match-string 1) org-lparse-special-blocks)
  1597. (replace-match "" t t))))))
  1598. (defvar org-lparse-list-table-p nil
  1599. "Non-nil if `org-do-lparse' is within a list-table.")
  1600. (defvar org-lparse-dyn-current-environment nil)
  1601. (defun org-lparse-begin-environment (style &optional env-options-plist)
  1602. (case style
  1603. (list-table
  1604. (setq org-lparse-list-table-p t))
  1605. (t (setq org-lparse-dyn-current-environment style)
  1606. (org-lparse-begin 'ENVIRONMENT style env-options-plist))))
  1607. (defun org-lparse-end-environment (style &optional env-options-plist)
  1608. (case style
  1609. (list-table
  1610. (setq org-lparse-list-table-p nil))
  1611. (t (org-lparse-end 'ENVIRONMENT style env-options-plist)
  1612. (setq org-lparse-dyn-current-environment nil))))
  1613. (defun org-lparse-current-environment-p (style)
  1614. (eq org-lparse-dyn-current-environment style))
  1615. (defun org-lparse-begin-footnote-definition (n)
  1616. (org-lparse-begin-collect)
  1617. (setq org-lparse-insert-tag-with-newlines nil)
  1618. (org-lparse-begin 'FOOTNOTE-DEFINITION n))
  1619. (defun org-lparse-end-footnote-definition (n)
  1620. (org-lparse-end 'FOOTNOTE-DEFINITION n)
  1621. (setq org-lparse-insert-tag-with-newlines 'both)
  1622. (let ((footnote-def (org-lparse-end-collect)))
  1623. ;; Cleanup newlines in footnote definition. This ensures that a
  1624. ;; transcoded line is never (wrongly) broken in to multiple lines.
  1625. (let ((pos 0))
  1626. (while (string-match "[\r\n]+" footnote-def pos)
  1627. (setq pos (1+ (match-beginning 0)))
  1628. (setq footnote-def (replace-match " " t t footnote-def))))
  1629. (push (cons n footnote-def) org-lparse-footnote-definitions)))
  1630. (defvar org-lparse-collect-buffer nil
  1631. "An auxiliary buffer named \"*Org Lparse Collect*\".
  1632. `org-do-lparse' uses this as output buffer while collecting
  1633. footnote definitions and table-cell contents of list-tables. See
  1634. `org-lparse-begin-collect' and `org-lparse-end-collect'.")
  1635. (defvar org-lparse-collect-count nil
  1636. "Count number of calls to `org-lparse-begin-collect'.
  1637. Use this counter to catch chained collections if they ever
  1638. happen.")
  1639. (defun org-lparse-begin-collect ()
  1640. "Temporarily switch to `org-lparse-collect-buffer'.
  1641. Also erase it's contents."
  1642. (unless (zerop org-lparse-collect-count)
  1643. (error "FIXME (org-lparse.el): Encountered chained collections"))
  1644. (incf org-lparse-collect-count)
  1645. (unless org-lparse-collect-buffer
  1646. (setq org-lparse-collect-buffer
  1647. (get-buffer-create "*Org Lparse Collect*")))
  1648. (set-buffer org-lparse-collect-buffer)
  1649. (erase-buffer))
  1650. (defun org-lparse-end-collect ()
  1651. "Switch to `org-lparse-output-buffer'.
  1652. Return contents of `org-lparse-collect-buffer' as a `string'."
  1653. (assert (> org-lparse-collect-count 0))
  1654. (decf org-lparse-collect-count)
  1655. (prog1 (buffer-string)
  1656. (erase-buffer)
  1657. (set-buffer org-lparse-output-buffer)))
  1658. (defun org-lparse-format (entity &rest args)
  1659. "Format ENTITY in backend-specific way and return it.
  1660. ARGS is specific to entity being formatted.
  1661. Use (org-lparse-format 'HEADING \"text\" 1) to format text as
  1662. level 1 heading.
  1663. See `org-xhtml-entity-format-callbacks-alist' for more information."
  1664. (when (and (member org-lparse-debug '(t format))
  1665. (not (equal entity 'COMMENT)))
  1666. (insert (org-lparse-format 'COMMENT "%s: %S" entity args)))
  1667. (cond
  1668. ((consp entity)
  1669. (let ((text (pop args)))
  1670. (apply 'org-lparse-format 'TAGS entity text args)))
  1671. (t
  1672. (let ((f (cdr (assoc entity org-lparse-entity-format-callbacks-alist))))
  1673. (unless f (error "Unknown entity: %s" entity))
  1674. (apply f args)))))
  1675. (defun org-lparse-insert (entity &rest args)
  1676. (insert (apply 'org-lparse-format entity args)))
  1677. (defun org-lparse-prepare-toc (lines level-offset opt-plist umax-toc)
  1678. (let* ((quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
  1679. (org-min-level (org-get-min-level lines level-offset))
  1680. (org-last-level org-min-level)
  1681. level)
  1682. (with-temp-buffer
  1683. (org-lparse-bind-local-variables opt-plist)
  1684. (erase-buffer)
  1685. (org-lparse-begin 'TOC (nth 3 (plist-get opt-plist :lang-words)) umax-toc)
  1686. (setq
  1687. lines
  1688. (mapcar
  1689. #'(lambda (line)
  1690. (when (and (string-match org-todo-line-regexp line)
  1691. (not (get-text-property 0 'org-protected line))
  1692. (<= (setq level (org-tr-level
  1693. (- (match-end 1) (match-beginning 1)
  1694. level-offset)))
  1695. umax-toc))
  1696. (let ((txt (save-match-data
  1697. (org-xml-encode-org-text-skip-links
  1698. (org-export-cleanup-toc-line
  1699. (match-string 3 line)))))
  1700. (todo (and
  1701. org-export-mark-todo-in-toc
  1702. (or (and (match-beginning 2)
  1703. (not (member (match-string 2 line)
  1704. org-done-keywords)))
  1705. (and (= level umax-toc)
  1706. (org-search-todo-below
  1707. line lines level)))))
  1708. tags)
  1709. ;; Check for targets
  1710. (while (string-match org-any-target-regexp line)
  1711. (setq line
  1712. (replace-match
  1713. (let ((org-lparse-encode-pending t))
  1714. (org-lparse-format 'FONTIFY
  1715. (match-string 1 line) "target"))
  1716. t t line)))
  1717. (when (string-match
  1718. (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
  1719. (setq tags (match-string 1 txt)
  1720. txt (replace-match "" t nil txt)))
  1721. (when (string-match quote-re0 txt)
  1722. (setq txt (replace-match "" t t txt)))
  1723. (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
  1724. (setq txt (replace-match "" t t txt)))
  1725. (org-lparse-format
  1726. 'TOC-ITEM
  1727. (let* ((snumber (org-section-number level))
  1728. (href (replace-regexp-in-string
  1729. "\\." "-" (format "sec-%s" snumber)))
  1730. (href
  1731. (or
  1732. (cdr (assoc
  1733. href org-export-preferred-target-alist))
  1734. href))
  1735. (href (org-solidify-link-text href)))
  1736. (org-lparse-format 'TOC-ENTRY snumber todo txt tags href))
  1737. level org-last-level)
  1738. (setq org-last-level level)))
  1739. line)
  1740. lines))
  1741. (org-lparse-end 'TOC)
  1742. (setq org-lparse-toc (buffer-string))))
  1743. lines)
  1744. (defun org-lparse-format-table-row (fields &optional text-for-empty-fields)
  1745. (if org-lparse-table-ncols
  1746. ;; second and subsequent rows of the table
  1747. (when (and org-lparse-list-table-p
  1748. (> (length fields) org-lparse-table-ncols))
  1749. (error "Table row has %d columns but header row claims %d columns"
  1750. (length fields) org-lparse-table-ncols))
  1751. ;; first row of the table
  1752. (setq org-lparse-table-ncols (length fields))
  1753. (when org-lparse-table-is-styled
  1754. (setq org-lparse-table-num-numeric-items-per-column
  1755. (make-vector org-lparse-table-ncols 0))
  1756. (setq org-lparse-table-colalign-vector
  1757. (make-vector org-lparse-table-ncols nil))
  1758. (let ((c -1))
  1759. (while (< (incf c) org-lparse-table-ncols)
  1760. (let* ((col-cookie (cdr (assoc (1+ c) org-lparse-table-colalign-info)))
  1761. (align (nth 0 col-cookie)))
  1762. (setf (aref org-lparse-table-colalign-vector c)
  1763. (cond
  1764. ((string= align "l") "left")
  1765. ((string= align "r") "right")
  1766. ((string= align "c") "center"))))))))
  1767. (incf org-lparse-table-rownum)
  1768. (let ((i -1))
  1769. (org-lparse-format
  1770. 'TABLE-ROW
  1771. (mapconcat
  1772. (lambda (x)
  1773. (when (and (string= x "") text-for-empty-fields)
  1774. (setq x text-for-empty-fields))
  1775. (incf i)
  1776. (let (col-cookie horiz-span)
  1777. (when org-lparse-table-is-styled
  1778. (when (and (< i org-lparse-table-ncols)
  1779. (string-match org-table-number-regexp x))
  1780. (incf (aref org-lparse-table-num-numeric-items-per-column i)))
  1781. (setq col-cookie (cdr (assoc (1+ i) org-lparse-table-colalign-info))
  1782. horiz-span (nth 1 col-cookie)))
  1783. (org-lparse-format
  1784. 'TABLE-CELL x org-lparse-table-rownum i (or horiz-span 0))))
  1785. fields "\n"))))
  1786. (defun org-lparse-get (what &optional opt-plist)
  1787. "Query for value of WHAT for the current backend `org-lparse-backend'.
  1788. See also `org-lparse-backend-get'."
  1789. (if (boundp 'org-lparse-backend)
  1790. (org-lparse-backend-get (symbol-name org-lparse-backend) what opt-plist)
  1791. (error "org-lparse-backend is not bound yet")))
  1792. (defun org-lparse-backend-get (backend what &optional opt-plist)
  1793. "Query BACKEND for value of WHAT.
  1794. Dispatch the call to `org-<backend>-user-get'. If that throws an
  1795. error, dispatch the call to `org-<backend>-get'. See
  1796. `org-xhtml-get' for all known settings queried for by
  1797. `org-lparse' during the course of export."
  1798. (assert (stringp backend) t)
  1799. (unless (org-lparse-backend-is-native-p backend)
  1800. (error "Unknown native backend %s" backend))
  1801. (let ((backend-get-method (intern (format "org-%s-get" backend)))
  1802. (backend-user-get-method (intern (format "org-%s-user-get" backend))))
  1803. (cond
  1804. ((functionp backend-get-method)
  1805. (condition-case nil
  1806. (funcall backend-user-get-method what opt-plist)
  1807. (error (funcall backend-get-method what opt-plist))))
  1808. (t
  1809. (error "Native backend %s doesn't define %s" backend backend-get-method)))))
  1810. (defun org-lparse-insert-tag (tag &rest args)
  1811. (when (member org-lparse-insert-tag-with-newlines '(lead both))
  1812. (insert "\n"))
  1813. (insert (apply 'format tag args))
  1814. (when (member org-lparse-insert-tag-with-newlines '(trail both))
  1815. (insert "\n")))
  1816. (defun org-lparse-get-targets-from-title (title)
  1817. (let* ((target (org-get-text-property-any 0 'target title))
  1818. (extra-targets (assoc target org-export-target-aliases))
  1819. (target (or (cdr (assoc target org-export-preferred-target-alist))
  1820. target)))
  1821. (cons target (remove target extra-targets))))
  1822. (defun org-lparse-suffix-from-snumber (snumber)
  1823. (let* ((snu (replace-regexp-in-string "\\." "-" snumber))
  1824. (href (cdr (assoc (concat "sec-" snu)
  1825. org-export-preferred-target-alist))))
  1826. (org-solidify-link-text (or href snu))))
  1827. (defun org-lparse-begin-level (level title umax head-count)
  1828. "Insert a new LEVEL in HTML export.
  1829. When TITLE is nil, just close all open levels."
  1830. (org-lparse-end-level level umax)
  1831. (unless title (error "Why is heading nil"))
  1832. (let* ((targets (org-lparse-get-targets-from-title title))
  1833. (target (car targets)) (extra-targets (cdr targets))
  1834. (target (and target (org-solidify-link-text target)))
  1835. (extra-class (org-get-text-property-any 0 'html-container-class title))
  1836. snumber tags level1 class)
  1837. (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title)
  1838. (setq tags (and org-export-with-tags (match-string 1 title)))
  1839. (setq title (replace-match "" t t title)))
  1840. (if (> level umax)
  1841. (progn
  1842. (if (aref org-levels-open (1- level))
  1843. (org-lparse-end-list-item-1)
  1844. (aset org-levels-open (1- level) t)
  1845. (org-lparse-end-paragraph)
  1846. (org-lparse-begin-list 'unordered))
  1847. (org-lparse-begin-list-item
  1848. 'unordered target (org-lparse-format
  1849. 'HEADLINE title extra-targets tags)))
  1850. (aset org-levels-open (1- level) t)
  1851. (setq snumber (org-section-number level))
  1852. (setq level1 (+ level (or (org-lparse-get 'TOPLEVEL-HLEVEL) 1) -1))
  1853. (unless (= head-count 1)
  1854. (org-lparse-end-outline-text-or-outline))
  1855. (org-lparse-begin-outline-and-outline-text
  1856. level1 snumber title tags target extra-targets extra-class)
  1857. (org-lparse-begin-paragraph))))
  1858. (defun org-lparse-end-level (level umax)
  1859. (org-lparse-end-paragraph)
  1860. (loop for l from org-level-max downto level
  1861. do (when (aref org-levels-open (1- l))
  1862. ;; Terminate one level in HTML export
  1863. (if (<= l umax)
  1864. (org-lparse-end-outline-text-or-outline)
  1865. (org-lparse-end-list-item-1)
  1866. (org-lparse-end-list 'unordered))
  1867. (aset org-levels-open (1- l) nil))))
  1868. (defvar org-lparse-outline-text-open)
  1869. (defun org-lparse-begin-outline-and-outline-text (level1 snumber title tags
  1870. target extra-targets
  1871. extra-class)
  1872. (org-lparse-begin
  1873. 'OUTLINE level1 snumber title tags target extra-targets extra-class)
  1874. (org-lparse-begin-outline-text level1 snumber extra-class))
  1875. (defun org-lparse-end-outline-text-or-outline ()
  1876. (cond
  1877. (org-lparse-outline-text-open
  1878. (org-lparse-end 'OUTLINE-TEXT)
  1879. (setq org-lparse-outline-text-open nil))
  1880. (t (org-lparse-end 'OUTLINE))))
  1881. (defun org-lparse-begin-outline-text (level1 snumber extra-class)
  1882. (assert (not org-lparse-outline-text-open) t)
  1883. (setq org-lparse-outline-text-open t)
  1884. (org-lparse-begin 'OUTLINE-TEXT level1 snumber extra-class))
  1885. (defun org-lparse-html-list-type-to-canonical-list-type (ltype)
  1886. (cdr (assoc ltype '(("o" . ordered)
  1887. ("u" . unordered)
  1888. ("d" . description)))))
  1889. ;; following vars are bound during `org-do-lparse'
  1890. (defvar org-lparse-list-stack)
  1891. (defvar org-lparse-list-table:table-row)
  1892. (defvar org-lparse-list-table:lines)
  1893. ;; Notes on LIST-TABLES
  1894. ;; ====================
  1895. ;; Lists withing "list-table" blocks (as shown below)
  1896. ;;
  1897. ;; #+begin_list-table
  1898. ;; - Row 1
  1899. ;; - 1.1
  1900. ;; - 1.2
  1901. ;; - 1.3
  1902. ;; - Row 2
  1903. ;; - 2.1
  1904. ;; - 2.2
  1905. ;; - 2.3
  1906. ;; #+end_list-table
  1907. ;;
  1908. ;; will be exported as though it were a table as shown below.
  1909. ;;
  1910. ;; | Row 1 | 1.1 | 1.2 | 1.3 |
  1911. ;; | Row 2 | 2.1 | 2.2 | 2.3 |
  1912. ;;
  1913. ;; Note that org-tables are NOT multi-line and each line is mapped to
  1914. ;; a unique row in the exported document. So if an exported table
  1915. ;; needs to contain a single paragraph (with copious text) it needs to
  1916. ;; be typed up in a single line. Editing such long lines using the
  1917. ;; table editor will be a cumbersome task. Furthermore inclusion of
  1918. ;; multi-paragraph text in a table cell is well-nigh impossible.
  1919. ;;
  1920. ;; LIST-TABLEs are meant to circumvent the above problems with
  1921. ;; org-tables.
  1922. ;;
  1923. ;; Note that in the example above the list items could be paragraphs
  1924. ;; themselves and the list can be arbitrarily deep.
  1925. ;;
  1926. ;; Inspired by following thread:
  1927. ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
  1928. (defun org-lparse-begin-list (ltype)
  1929. (push ltype org-lparse-list-stack)
  1930. (let ((list-level (length org-lparse-list-stack)))
  1931. (cond
  1932. ((not org-lparse-list-table-p)
  1933. (org-lparse-begin 'LIST ltype))
  1934. ;; process LIST-TABLE
  1935. ((= 1 list-level)
  1936. ;; begin LIST-TABLE
  1937. (setq org-lparse-list-table:lines nil)
  1938. (setq org-lparse-list-table:table-row nil))
  1939. ((= 2 list-level)
  1940. (ignore))
  1941. (t
  1942. (org-lparse-begin 'LIST ltype)))))
  1943. (defun org-lparse-end-list (ltype)
  1944. (pop org-lparse-list-stack)
  1945. (let ((list-level (length org-lparse-list-stack)))
  1946. (cond
  1947. ((not org-lparse-list-table-p)
  1948. (org-lparse-end 'LIST ltype))
  1949. ;; process LIST-TABLE
  1950. ((= 0 list-level)
  1951. ;; end LIST-TABLE
  1952. (insert (org-lparse-format-list-table
  1953. (nreverse org-lparse-list-table:lines))))
  1954. ((= 1 list-level)
  1955. (ignore))
  1956. (t
  1957. (org-lparse-end 'LIST ltype)))))
  1958. (defun org-lparse-begin-list-item (ltype &optional arg headline)
  1959. (let ((list-level (length org-lparse-list-stack)))
  1960. (cond
  1961. ((not org-lparse-list-table-p)
  1962. (org-lparse-begin 'LIST-ITEM ltype arg headline))
  1963. ;; process LIST-TABLE
  1964. ((= 1 list-level)
  1965. ;; begin TABLE-ROW for LIST-TABLE
  1966. (setq org-lparse-list-table:table-row nil)
  1967. (org-lparse-begin-list-table:table-cell))
  1968. ((= 2 list-level)
  1969. ;; begin TABLE-CELL for LIST-TABLE
  1970. (org-lparse-begin-list-table:table-cell))
  1971. (t
  1972. (org-lparse-begin 'LIST-ITEM ltype arg headline)))))
  1973. (defun org-lparse-end-list-item (ltype)
  1974. (let ((list-level (length org-lparse-list-stack)))
  1975. (cond
  1976. ((not org-lparse-list-table-p)
  1977. (org-lparse-end 'LIST-ITEM ltype))
  1978. ;; process LIST-TABLE
  1979. ((= 1 list-level)
  1980. ;; end TABLE-ROW for LIST-TABLE
  1981. (org-lparse-end-list-table:table-cell)
  1982. (push (nreverse org-lparse-list-table:table-row)
  1983. org-lparse-list-table:lines))
  1984. ((= 2 list-level)
  1985. ;; end TABLE-CELL for LIST-TABLE
  1986. (org-lparse-end-list-table:table-cell))
  1987. (t
  1988. (org-lparse-end 'LIST-ITEM ltype)))))
  1989. (defvar org-lparse-list-table:table-cell-open)
  1990. (defun org-lparse-begin-list-table:table-cell ()
  1991. (org-lparse-end-list-table:table-cell)
  1992. (setq org-lparse-list-table:table-cell-open t)
  1993. (org-lparse-begin-collect)
  1994. (org-lparse-begin-paragraph))
  1995. (defun org-lparse-end-list-table:table-cell ()
  1996. (when org-lparse-list-table:table-cell-open
  1997. (setq org-lparse-list-table:table-cell-open nil)
  1998. (org-lparse-end-paragraph)
  1999. (push (org-lparse-end-collect)
  2000. org-lparse-list-table:table-row)))
  2001. (defvar org-lparse-table-rowgrp-info)
  2002. (defun org-lparse-begin-table-rowgroup (&optional is-header-row)
  2003. (push (cons (1+ org-lparse-table-rownum) :start) org-lparse-table-rowgrp-info)
  2004. (org-lparse-begin 'TABLE-ROWGROUP is-header-row))
  2005. (defun org-lparse-end-table ()
  2006. (when org-lparse-table-is-styled
  2007. ;; column groups
  2008. (unless (car org-table-colgroup-info)
  2009. (setq org-table-colgroup-info
  2010. (cons :start (cdr org-table-colgroup-info))))
  2011. ;; column alignment
  2012. (let ((c -1))
  2013. (mapc
  2014. (lambda (x)
  2015. (incf c)
  2016. (setf (aref org-lparse-table-colalign-vector c)
  2017. (or (aref org-lparse-table-colalign-vector c)
  2018. (if (> (/ (float x) (1+ org-lparse-table-rownum))
  2019. org-table-number-fraction)
  2020. "right" "left"))))
  2021. org-lparse-table-num-numeric-items-per-column)))
  2022. (org-lparse-end 'TABLE))
  2023. (defvar org-lparse-encode-pending nil)
  2024. (defun org-lparse-format-tags (tag text prefix suffix &rest args)
  2025. (cond
  2026. ((consp tag)
  2027. (concat prefix (apply 'format (car tag) args) text suffix
  2028. (format (cdr tag))))
  2029. ((stringp tag) ; singleton tag
  2030. (concat prefix (apply 'format tag args) text))))
  2031. (defun org-xml-fix-class-name (kwd) ; audit callers of this function
  2032. "Turn todo keyword into a valid class name.
  2033. Replaces invalid characters with \"_\"."
  2034. (save-match-data
  2035. (while (string-match "[^a-zA-Z0-9_]" kwd)
  2036. (setq kwd (replace-match "_" t t kwd))))
  2037. kwd)
  2038. (defun org-lparse-format-todo (todo)
  2039. (org-lparse-format 'FONTIFY
  2040. (concat
  2041. (ignore-errors (org-lparse-get 'TODO-KWD-CLASS-PREFIX))
  2042. (org-xml-fix-class-name todo))
  2043. (list (if (member todo org-done-keywords) "done" "todo")
  2044. todo)))
  2045. (defun org-lparse-format-extra-targets (extra-targets)
  2046. (if (not extra-targets) ""
  2047. (mapconcat (lambda (x)
  2048. (setq x (org-solidify-link-text
  2049. (if (org-uuidgen-p x) (concat "ID-" x) x)))
  2050. (org-lparse-format 'ANCHOR "" x))
  2051. extra-targets "")))
  2052. (defun org-lparse-format-org-tags (tags)
  2053. (if (not tags) ""
  2054. (org-lparse-format
  2055. 'FONTIFY (mapconcat
  2056. (lambda (x)
  2057. (org-lparse-format
  2058. 'FONTIFY x
  2059. (concat
  2060. (ignore-errors (org-lparse-get 'TAG-CLASS-PREFIX))
  2061. (org-xml-fix-class-name x))))
  2062. (org-split-string tags ":")
  2063. (org-lparse-format 'SPACES 1)) "tag")))
  2064. (defun org-lparse-format-section-number (&optional snumber level)
  2065. (and org-export-with-section-numbers
  2066. (not org-lparse-body-only) snumber level
  2067. (org-lparse-format 'FONTIFY snumber (format "section-number-%d" level))))
  2068. (defun org-lparse-warn (msg)
  2069. (if (not org-lparse-use-flashy-warning)
  2070. (message msg)
  2071. (put-text-property 0 (length msg) 'face 'font-lock-warning-face msg)
  2072. (message msg)
  2073. (sleep-for 3)))
  2074. (defun org-xml-format-href (s)
  2075. "Make sure the S is valid as a href reference in an XHTML document."
  2076. (save-match-data
  2077. (let ((start 0))
  2078. (while (string-match "&" s start)
  2079. (setq start (+ (match-beginning 0) 3)
  2080. s (replace-match "&amp;" t t s)))))
  2081. s)
  2082. (defun org-xml-format-desc (s)
  2083. "Make sure the S is valid as a description in a link."
  2084. (if (and s (not (get-text-property 1 'org-protected s)))
  2085. (save-match-data
  2086. (org-xml-encode-org-text s))
  2087. s))
  2088. (provide 'org-lparse)
  2089. ;; Local variables:
  2090. ;; generated-autoload-file: "org-loaddefs.el"
  2091. ;; End:
  2092. ;;; org-lparse.el ends here