org-lparse.el 81 KB

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