org-lparse.el 82 KB

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