test-org-element.el 104 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980
  1. ;;; test-org-element.el --- Tests for org-element.el
  2. ;; Copyright (C) 2012, 2013 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; This program is free software; you can redistribute it and/or modify
  5. ;; it under the terms of the GNU General Public License as published by
  6. ;; the Free Software Foundation, either version 3 of the License, or
  7. ;; (at your option) any later version.
  8. ;; This program is distributed in the hope that it will be useful,
  9. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. ;; GNU General Public License for more details.
  12. ;; You should have received a copy of the GNU General Public License
  13. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. ;;; Code:
  15. (unless (featurep 'org-element)
  16. (signal 'missing-test-dependency "org-element"))
  17. (defun org-test-parse-and-interpret (text)
  18. "Parse TEXT as Org syntax and interpret it.
  19. Return interpreted string."
  20. (with-temp-buffer
  21. (org-mode)
  22. (insert text)
  23. (org-element-interpret-data (org-element-parse-buffer))))
  24. ;;; Test `org-element-map'
  25. (ert-deftest test-org-element/map ()
  26. "Test `org-element-map'."
  27. ;; Can map to `plain-text' objects.
  28. (should
  29. (= 2
  30. (org-test-with-temp-text "Some text \alpha
  31. #+BEGIN_CENTER
  32. Some other text
  33. #+END_CENTER"
  34. (let ((count 0))
  35. (org-element-map
  36. (org-element-parse-buffer) 'plain-text
  37. (lambda (s) (when (string-match "text" s) (incf count))))
  38. count))))
  39. ;; Applies to secondary strings
  40. (should
  41. (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
  42. ;; Enter secondary strings before entering contents.
  43. (should
  44. (equal
  45. "alpha"
  46. (org-element-property
  47. :name
  48. (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
  49. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t)))))
  50. ;; Apply NO-RECURSION argument.
  51. (should-not
  52. (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
  53. (org-element-map
  54. (org-element-parse-buffer) 'entity 'identity nil nil 'center-block)))
  55. ;; Use WITH-AFFILIATED argument.
  56. (should
  57. (equal
  58. '("a" "1" "b" "2")
  59. (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
  60. (org-element-map
  61. (org-element-at-point) 'plain-text 'identity nil nil nil t)))))
  62. ;;; Test Setters
  63. (ert-deftest test-org-element/put-property ()
  64. "Test `org-element-put-property' specifications."
  65. ;; Standard test.
  66. (org-test-with-temp-text "* Headline\n *a*"
  67. (let ((tree (org-element-parse-buffer)))
  68. (org-element-put-property
  69. (org-element-map tree 'bold 'identity nil t) :test 1)
  70. (should (org-element-property
  71. :test (org-element-map tree 'bold 'identity nil t)))))
  72. ;; Put property on a string.
  73. (should
  74. (org-element-property :test (org-element-put-property "Paragraph" :test t))))
  75. (ert-deftest test-org-element/set-contents ()
  76. "Test `org-element-set-contents' specifications."
  77. ;; Accept multiple entries.
  78. (should
  79. (equal '("b" (italic nil "a"))
  80. (org-test-with-temp-text "* Headline\n *a*"
  81. (let ((tree (org-element-parse-buffer)))
  82. (org-element-set-contents
  83. (org-element-map tree 'bold 'identity nil t) "b" '(italic nil "a"))
  84. (org-element-contents
  85. (org-element-map tree 'bold 'identity nil t))))))
  86. ;; Accept atoms and elements.
  87. (should
  88. (equal '("b")
  89. (org-test-with-temp-text "* Headline\n *a*"
  90. (let ((tree (org-element-parse-buffer)))
  91. (org-element-set-contents
  92. (org-element-map tree 'bold 'identity nil t) "b")
  93. (org-element-contents
  94. (org-element-map tree 'bold 'identity nil t))))))
  95. (should
  96. (equal '((italic nil "b"))
  97. (org-test-with-temp-text "* Headline\n *a*"
  98. (let ((tree (org-element-parse-buffer)))
  99. (org-element-set-contents
  100. (org-element-map tree 'bold 'identity nil t) '(italic nil "b"))
  101. (org-element-contents
  102. (org-element-map tree 'bold 'identity nil t))))))
  103. ;; Allow nil contents.
  104. (should-not
  105. (org-test-with-temp-text "* Headline\n *a*"
  106. (let ((tree (org-element-parse-buffer)))
  107. (org-element-set-contents (org-element-map tree 'bold 'identity nil t))
  108. (org-element-contents (org-element-map tree 'bold 'identity nil t))))))
  109. (ert-deftest test-org-element/set-element ()
  110. "Test `org-element-set-element' specifications."
  111. (org-test-with-temp-text "* Headline\n*a*"
  112. (let ((tree (org-element-parse-buffer)))
  113. (org-element-set-element
  114. (org-element-map tree 'bold 'identity nil t)
  115. '(italic nil "b"))
  116. ;; Check if object is correctly replaced.
  117. (should (org-element-map tree 'italic 'identity))
  118. (should-not (org-element-map tree 'bold 'identity))
  119. ;; Check if new object's parent is correctly set.
  120. (should
  121. (eq
  122. (org-element-property :parent
  123. (org-element-map tree 'italic 'identity nil t))
  124. (org-element-map tree 'paragraph 'identity nil t))))))
  125. (ert-deftest test-org-element/secondary-p ()
  126. "Test `org-element-secondary-p' specifications."
  127. ;; In a secondary string, return property name.
  128. (should
  129. (eq :title
  130. (org-test-with-temp-text "* Headline *object*"
  131. (org-element-map (org-element-parse-buffer) 'bold
  132. (lambda (object) (org-element-secondary-p object))
  133. nil t))))
  134. ;; Outside a secondary string, return nil.
  135. (should-not
  136. (org-test-with-temp-text "Paragraph *object*"
  137. (org-element-map (org-element-parse-buffer) 'bold
  138. (lambda (object) (org-element-type (org-element-secondary-p object)))
  139. nil t))))
  140. (ert-deftest test-org-element/adopt-elements ()
  141. "Test `org-element-adopt-elements' specifications."
  142. ;; Adopt an element.
  143. (should
  144. (equal '(plain-text italic)
  145. (org-test-with-temp-text "* Headline\n *a*"
  146. (let ((tree (org-element-parse-buffer)))
  147. (org-element-adopt-elements
  148. (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
  149. (mapcar (lambda (blob) (org-element-type blob))
  150. (org-element-contents
  151. (org-element-map tree 'bold 'identity nil t)))))))
  152. ;; Adopt a string.
  153. (should
  154. (equal '("a" "b")
  155. (org-test-with-temp-text "* Headline\n *a*"
  156. (let ((tree (org-element-parse-buffer)))
  157. (org-element-adopt-elements
  158. (org-element-map tree 'bold 'identity nil t) "b")
  159. (org-element-contents
  160. (org-element-map tree 'bold 'identity nil t)))))))
  161. ;;; Test Parsers
  162. ;;;; Affiliated Keywords
  163. (ert-deftest test-org-element/affiliated-keywords-parser ()
  164. "Test affiliated keywords parsing."
  165. ;; Read simple keywords.
  166. (should
  167. (equal "para"
  168. (org-element-property
  169. :name
  170. (org-test-with-temp-text "#+NAME: para\nParagraph"
  171. (org-element-at-point)))))
  172. (should
  173. (= 1
  174. (org-element-property
  175. :begin
  176. (org-test-with-temp-text "#+NAME: para\nParagraph"
  177. (org-element-at-point)))))
  178. ;; Parse multiple keywords.
  179. (should
  180. (equal
  181. '("line2" "line1")
  182. (org-element-property
  183. :attr_ascii
  184. (org-test-with-temp-text
  185. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
  186. (org-element-at-point)))))
  187. ;; Parse "parsed" keywords.
  188. (should
  189. (equal
  190. '(("caption"))
  191. (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
  192. (car (org-element-property :caption (org-element-at-point))))))
  193. ;; Parse dual keywords.
  194. (should
  195. (equal
  196. '((("long") "short"))
  197. (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
  198. (org-element-property :caption (org-element-at-point)))))
  199. ;; Allow multiple caption keywords.
  200. (should
  201. (equal
  202. '((("l2") "s2") (("l1") "s1"))
  203. (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
  204. (org-element-property :caption (org-element-at-point)))))
  205. (should
  206. (equal
  207. '((("l1")) (nil "s1"))
  208. (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
  209. (org-element-property :caption (org-element-at-point)))))
  210. ;; Corner case: orphaned keyword at the end of an element.
  211. (should
  212. (eq 'keyword
  213. (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
  214. (progn (search-forward "name")
  215. (org-element-type (org-element-at-point))))))
  216. (should-not
  217. (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
  218. (progn (search-forward "Some")
  219. (org-element-property :name (org-element-at-point))))))
  220. ;;;; Babel Call
  221. (ert-deftest test-org-element/babel-call-parser ()
  222. "Test `babel-call' parsing."
  223. ;; Standard test.
  224. (should
  225. (org-test-with-temp-text "#+CALL: test()"
  226. (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
  227. ;; Ignore case.
  228. (should
  229. (org-test-with-temp-text "#+call: test()"
  230. (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
  231. ;; Handle non-empty blank line at the end of buffer.
  232. (should
  233. (org-test-with-temp-text "#+CALL: test()\n "
  234. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  235. ;;;; Bold
  236. (ert-deftest test-org-element/bold-parser ()
  237. "Test `bold' parser."
  238. ;; Standard test.
  239. (should
  240. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  241. (org-test-with-temp-text "*bold*"
  242. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  243. ;; Multi-line markup.
  244. (should
  245. (equal
  246. (org-element-contents
  247. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  248. (org-test-with-temp-text "*first line\nsecond line*"
  249. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  250. '("first line\nsecond line"))))
  251. ;;;; Center Block
  252. (ert-deftest test-org-element/center-block-parser ()
  253. "Test `center-block' parser."
  254. ;; Standard test.
  255. (should
  256. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  257. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  258. ;; Ignore case.
  259. (should
  260. (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
  261. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  262. ;; Ignore incomplete block.
  263. (should-not
  264. (org-test-with-temp-text "#+BEGIN_CENTER"
  265. (org-element-map (org-element-parse-buffer) 'center-block
  266. 'identity nil t)))
  267. ;; Handle non-empty blank line at the end of buffer.
  268. (should
  269. (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
  270. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  271. ;;;; Clock
  272. (ert-deftest test-org-element/clock-parser ()
  273. "Test `clock' parser."
  274. ;; Running clock.
  275. (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
  276. (org-element-at-point))))
  277. (should (eq (org-element-property :status clock) 'running))
  278. (should
  279. (equal (org-element-property :raw-value
  280. (org-element-property :value clock))
  281. "[2012-01-01 sun. 00:01]"))
  282. (should-not (org-element-property :duration clock)))
  283. ;; Closed clock.
  284. (let ((clock
  285. (org-test-with-temp-text
  286. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
  287. (org-element-at-point))))
  288. (should (eq (org-element-property :status clock) 'closed))
  289. (should (equal (org-element-property :raw-value
  290. (org-element-property :value clock))
  291. "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
  292. (should (equal (org-element-property :duration clock) "0:01"))))
  293. ;;;; Code
  294. (ert-deftest test-org-element/code-parser ()
  295. "Test `code' parser."
  296. ;; Regular test.
  297. (should
  298. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  299. (org-test-with-temp-text "~code~"
  300. (org-element-map (org-element-parse-buffer) 'code 'identity))))
  301. ;; Multi-line markup.
  302. (should
  303. (equal
  304. (org-element-property
  305. :value
  306. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  307. (org-test-with-temp-text "~first line\nsecond line~"
  308. (org-element-map
  309. (org-element-parse-buffer) 'code 'identity nil t))))
  310. "first line\nsecond line")))
  311. ;;;; Comment
  312. (ert-deftest test-org-element/comment-parser ()
  313. "Test `comment' parser."
  314. ;; Regular comment.
  315. (should
  316. (org-test-with-temp-text "# Comment"
  317. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  318. ;; Inline comment.
  319. (should
  320. (org-test-with-temp-text " # Comment"
  321. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  322. ;; Preserve indentation.
  323. (should
  324. (equal
  325. (org-element-property
  326. :value
  327. (org-test-with-temp-text "# No blank\n# One blank"
  328. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  329. "No blank\n One blank"))
  330. ;; Comment with blank lines.
  331. (should
  332. (equal
  333. (org-element-property
  334. :value
  335. (org-test-with-temp-text "# First part\n# \n#\n# Second part"
  336. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  337. "First part\n\n\nSecond part"))
  338. ;; Do not mix comments and keywords.
  339. (should
  340. (eq 1
  341. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  342. (length (org-element-map (org-element-parse-buffer) 'comment
  343. 'identity)))))
  344. (should
  345. (equal "comment"
  346. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  347. (org-element-property
  348. :value
  349. (org-element-map (org-element-parse-buffer) 'comment
  350. 'identity nil t)))))
  351. ;; Correctly handle non-empty blank lines at the end of buffer.
  352. (should
  353. (org-test-with-temp-text "# A\n "
  354. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  355. ;;;; Comment Block
  356. (ert-deftest test-org-element/comment-block-parser ()
  357. "Test `comment-block' parser."
  358. ;; Standard test.
  359. (should
  360. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  361. (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
  362. ;; Ignore case.
  363. (should
  364. (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
  365. (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
  366. ;; Ignore incomplete block.
  367. (should-not
  368. (org-test-with-temp-text "#+BEGIN_COMMENT"
  369. (org-element-map (org-element-parse-buffer) 'comment-block
  370. 'identity nil t)))
  371. ;; Handle non-empty blank line at the end of buffer.
  372. (should
  373. (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
  374. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  375. ;;;; Diary Sexp
  376. (ert-deftest test-org-element/diary-sexp-parser ()
  377. "Test `diary-sexp' parser."
  378. ;; Standard test.
  379. (should
  380. (eq 'diary-sexp
  381. (org-test-with-temp-text
  382. "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
  383. (org-element-type (org-element-at-point)))))
  384. ;; Diary sexp must live at beginning of line
  385. (should-not
  386. (eq 'diary-sexp
  387. (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
  388. (org-element-type (org-element-at-point)))))
  389. ;; Handle non-empty blank line at the end of buffer.
  390. (should
  391. (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
  392. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  393. ;;;; Drawer
  394. (ert-deftest test-org-element/drawer-parser ()
  395. "Test `drawer' parser."
  396. ;; Standard test.
  397. (should
  398. (org-test-with-temp-text ":TEST:\nText\n:END:"
  399. (org-element-map (org-element-parse-buffer) 'drawer 'identity)))
  400. ;; Do not mix regular drawers and property drawers.
  401. (should-not
  402. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  403. (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
  404. ;; Ignore incomplete drawer.
  405. (should-not
  406. (org-test-with-temp-text ":TEST:"
  407. (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
  408. ;; Handle non-empty blank line at the end of buffer.
  409. (should
  410. (org-test-with-temp-text ":TEST:\nC\n:END:\n "
  411. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  412. ;;;; Dynamic Block
  413. (ert-deftest test-org-element/dynamic-block-parser ()
  414. "Test `dynamic-block' parser."
  415. ;; Standard test.
  416. (should
  417. (org-test-with-temp-text
  418. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  419. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  420. ;; Ignore case.
  421. (should
  422. (org-test-with-temp-text
  423. "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
  424. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  425. ;; Ignore incomplete block.
  426. (should-not
  427. (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
  428. (org-element-map (org-element-parse-buffer) 'dynamic-block
  429. 'identity nil t)))
  430. ;; Handle non-empty blank line at the end of buffer.
  431. (should
  432. (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
  433. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  434. ;;;; Entity
  435. (ert-deftest test-org-element/entity-parser ()
  436. "Test `entity' parser."
  437. ;; Without brackets.
  438. (should
  439. (org-test-with-temp-text "\\sin"
  440. (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  441. ;; With brackets.
  442. (should
  443. (org-element-property
  444. :use-brackets-p
  445. (org-test-with-temp-text "\\alpha{}text"
  446. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  447. ;; User-defined entity.
  448. (should
  449. (equal
  450. (org-element-property
  451. :name
  452. (let ((org-entities-user
  453. '(("test" "test" nil "test" "test" "test" "test"))))
  454. (org-test-with-temp-text "\\test"
  455. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  456. "test"))
  457. ;; Special case: entity at the end of a container.
  458. (should
  459. (eq 'entity
  460. (org-test-with-temp-text "*\\alpha \\beta*"
  461. (search-forward "be")
  462. (org-element-type (org-element-context))))))
  463. ;;;; Example Block
  464. (ert-deftest test-org-element/example-block-parser ()
  465. "Test `example-block' parser."
  466. ;; Standard test.
  467. (should
  468. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  469. (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
  470. ;; Ignore incomplete block.
  471. (should-not
  472. (eq 'example-block
  473. (org-test-with-temp-text "#+BEGIN_EXAMPLE"
  474. (org-element-type (org-element-at-point)))))
  475. ;; Properly un-escape code.
  476. (should
  477. (equal "* Headline\n #+keyword\nText\n"
  478. (org-test-with-temp-text
  479. "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
  480. (org-element-property :value (org-element-at-point)))))
  481. ;; Remove block indentation according to block boundaries, unless
  482. ;; block contents are less indented than block boundaries.
  483. (should
  484. (equal " L1\nL2\n"
  485. (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
  486. (let ((org-src-preserve-indentation t))
  487. (org-element-property :value (org-element-at-point))))))
  488. (should
  489. (equal
  490. " L1\n L2\n"
  491. (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
  492. (let ((org-src-preserve-indentation t))
  493. (org-element-property :value (org-element-at-point))))))
  494. ;; Handle non-empty blank line at the end of buffer.
  495. (should
  496. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
  497. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  498. (ert-deftest test-org-element/block-switches ()
  499. "Test `example-block' and `src-block' switches parsing."
  500. (let ((org-coderef-label-format "(ref:%s)"))
  501. ;; 1. Test "-i" switch.
  502. (should-not
  503. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  504. (org-element-property :preserve-indent (org-element-at-point))))
  505. (should
  506. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  507. (org-element-property :preserve-indent (org-element-at-point))))
  508. (should-not
  509. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  510. (org-element-property :preserve-indent (org-element-at-point))))
  511. (should
  512. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  513. (org-element-property :preserve-indent (org-element-at-point))))
  514. ;; 2. "-n -r -k" combination should number lines, retain labels but
  515. ;; not use them in coderefs.
  516. (should
  517. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  518. (let ((element (org-element-at-point)))
  519. (and (org-element-property :number-lines element)
  520. (org-element-property :retain-labels element)
  521. (not (org-element-property :use-labels element))))))
  522. (should
  523. (org-test-with-temp-text
  524. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  525. (let ((element (org-element-at-point)))
  526. (and (org-element-property :number-lines element)
  527. (org-element-property :retain-labels element)
  528. (not (org-element-property :use-labels element))))))
  529. ;; 3. "-n -r" combination should number-lines remove labels and not
  530. ;; use them in coderefs.
  531. (should
  532. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  533. (let ((element (org-element-at-point)))
  534. (and (org-element-property :number-lines element)
  535. (not (org-element-property :retain-labels element))
  536. (not (org-element-property :use-labels element))))))
  537. (should
  538. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  539. (let ((element (org-element-at-point)))
  540. (and (org-element-property :number-lines element)
  541. (not (org-element-property :retain-labels element))
  542. (not (org-element-property :use-labels element))))))
  543. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  544. ;; in coderefs.
  545. (should
  546. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  547. (let ((element (org-element-at-point)))
  548. (and (org-element-property :number-lines element)
  549. (org-element-property :retain-labels element)
  550. (org-element-property :use-labels element)))))
  551. (should
  552. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  553. (let ((element (org-element-at-point)))
  554. (and (org-element-property :number-lines element)
  555. (org-element-property :retain-labels element)
  556. (org-element-property :use-labels element)))))
  557. (should
  558. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  559. (let ((element (org-element-at-point)))
  560. (and (org-element-property :number-lines element)
  561. (org-element-property :retain-labels element)
  562. (org-element-property :use-labels element)))))
  563. (should
  564. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  565. (let ((element (org-element-at-point)))
  566. (and (org-element-property :number-lines element)
  567. (org-element-property :retain-labels element)
  568. (org-element-property :use-labels element)))))
  569. ;; 5. No switch should not number lines, but retain labels and use
  570. ;; them in coderefs.
  571. (should
  572. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  573. (let ((element (org-element-at-point)))
  574. (and (not (org-element-property :number-lines element))
  575. (org-element-property :retain-labels element)
  576. (org-element-property :use-labels element)))))
  577. (should
  578. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  579. (let ((element (org-element-at-point)))
  580. (and (not (org-element-property :number-lines element))
  581. (org-element-property :retain-labels element)
  582. (org-element-property :use-labels element)))))
  583. ;; 6. "-r" switch only: do not number lines, remove labels, and
  584. ;; don't use labels in coderefs.
  585. (should
  586. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  587. (let ((element (org-element-at-point)))
  588. (and (not (org-element-property :number-lines element))
  589. (not (org-element-property :retain-labels element))
  590. (not (org-element-property :use-labels element))))))
  591. (should
  592. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  593. (let ((element (org-element-at-point)))
  594. (and (not (org-element-property :number-lines element))
  595. (not (org-element-property :retain-labels element))
  596. (not (org-element-property :use-labels element))))))
  597. ;; 7. Recognize coderefs with user-defined syntax.
  598. (should
  599. (equal
  600. "[ref:%s]"
  601. (org-test-with-temp-text
  602. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  603. (org-element-property :label-fmt (org-element-at-point)))))
  604. (should
  605. (equal
  606. "[ref:%s]"
  607. (org-test-with-temp-text
  608. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  609. (org-element-property :label-fmt (org-element-at-point)))))))
  610. ;;;; Export Block
  611. (ert-deftest test-org-element/export-block-parser ()
  612. "Test `export-block' parser."
  613. ;; Standard test.
  614. (should
  615. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  616. (org-element-map
  617. (let ((org-element-block-name-alist
  618. '(("LATEX" . org-element-export-block-parser))))
  619. (org-element-parse-buffer))
  620. 'export-block 'identity)))
  621. ;; Ignore case.
  622. (should
  623. (let ((org-element-block-name-alist
  624. '(("LATEX" . org-element-export-block-parser))))
  625. (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
  626. (org-element-map (org-element-parse-buffer) 'export-block 'identity))))
  627. ;; Ignore incomplete block.
  628. (should-not
  629. (let ((org-element-block-name-alist
  630. '(("LATEX" . org-element-export-block-parser))))
  631. (org-test-with-temp-text "#+BEGIN_LATEX"
  632. (org-element-map (org-element-parse-buffer) 'export-block
  633. 'identity nil t))))
  634. ;; Handle non-empty blank line at the end of buffer.
  635. (should
  636. (let ((org-element-block-name-alist
  637. '(("LATEX" . org-element-export-block-parser))))
  638. (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
  639. (= (org-element-property :end (org-element-at-point)) (point-max))))))
  640. ;;;; Export Snippet
  641. (ert-deftest test-org-element/export-snippet-parser ()
  642. "Test `export-snippet' parser."
  643. (should
  644. (equal
  645. '("back-end" . "contents")
  646. (org-test-with-temp-text "@@back-end:contents@@"
  647. (org-element-map
  648. (org-element-parse-buffer) 'export-snippet
  649. (lambda (snippet) (cons (org-element-property :back-end snippet)
  650. (org-element-property :value snippet)))
  651. nil t)))))
  652. ;;;; Fixed Width
  653. (ert-deftest test-org-element/fixed-width-parser ()
  654. "Test fixed-width area parsing."
  655. ;; Preserve indentation.
  656. (should
  657. (org-test-with-temp-text ": no blank\n: one blank"
  658. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  659. ;; Fixed-width with empty lines.
  660. (should
  661. (org-test-with-temp-text ": first part\n:\n: \n: second part"
  662. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  663. ;; Parse indented fixed-width markers.
  664. (should
  665. (org-test-with-temp-text "Text\n : no blank\n : one blank"
  666. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  667. ;; Distinguish fixed-width areas within a list and outside of it.
  668. (should
  669. (= 2
  670. (length
  671. (org-test-with-temp-text "
  672. - Item
  673. : fixed-width inside
  674. : fixed-width outside"
  675. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))))
  676. ;; Handle non-empty blank line at the end of buffer.
  677. (should
  678. (org-test-with-temp-text ": A\n "
  679. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  680. ;;;; Footnote Definition
  681. (ert-deftest test-org-element/footnote-definition-parser ()
  682. "Test `footnote-definition' parser."
  683. (should
  684. (org-test-with-temp-text "[fn:1] Definition"
  685. (org-element-map (org-element-parse-buffer) 'footnote-definition
  686. 'identity nil t)))
  687. ;; Footnote with more contents
  688. (should
  689. (= 29
  690. (org-element-property
  691. :end
  692. (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
  693. (org-element-map (org-element-parse-buffer) 'footnote-definition
  694. 'identity nil t)))))
  695. ;; Footnote starting with special syntax.
  696. (should-not
  697. (org-test-with-temp-text "[fn:1] - no item"
  698. (org-element-map (org-element-parse-buffer) 'item 'identity)))
  699. ;; Correctly handle footnote starting with an empty line.
  700. (should
  701. (= 9
  702. (org-test-with-temp-text "[fn:1]\n\n Body"
  703. (org-element-property :contents-begin (org-element-at-point)))))
  704. ;; Handle non-empty blank line at the end of buffer.
  705. (should
  706. (org-test-with-temp-text "[fn:1] Definition\n "
  707. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  708. ;;;; Footnotes Reference.
  709. (ert-deftest test-org-element/footnote-reference-parser ()
  710. "Test `footnote-reference' parser."
  711. ;; 1. Parse a standard reference.
  712. (org-test-with-temp-text "Text[fn:label]"
  713. (should
  714. (org-element-map
  715. (org-element-parse-buffer) 'footnote-reference 'identity)))
  716. ;; 2. Parse a normalized reference.
  717. (org-test-with-temp-text "Text[1]"
  718. (should
  719. (org-element-map
  720. (org-element-parse-buffer) 'footnote-reference 'identity)))
  721. ;; 3. Parse an inline reference.
  722. (org-test-with-temp-text "Text[fn:test:def]"
  723. (should
  724. (org-element-map
  725. (org-element-parse-buffer) 'footnote-reference 'identity)))
  726. ;; 4. Parse an anonymous reference.
  727. (org-test-with-temp-text "Text[fn::def]"
  728. (should
  729. (org-element-map
  730. (org-element-parse-buffer) 'footnote-reference 'identity)))
  731. ;; 5. Parse nested footnotes.
  732. (org-test-with-temp-text "Text[fn::def [fn:label]]"
  733. (should
  734. (= 2
  735. (length
  736. (org-element-map
  737. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  738. ;; 6. Parse adjacent footnotes.
  739. (org-test-with-temp-text "Text[fn:label1][fn:label2]"
  740. (should
  741. (= 2
  742. (length
  743. (org-element-map
  744. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  745. ;; 7. Only properly closed footnotes are recognized as such.
  746. (org-test-with-temp-text "Text[fn:label"
  747. (should-not
  748. (org-element-map
  749. (org-element-parse-buffer) 'footnote-reference 'identity))))
  750. ;;;; Headline
  751. (ert-deftest test-org-element/headline-quote-keyword ()
  752. "Test QUOTE keyword recognition."
  753. ;; Reference test.
  754. (org-test-with-temp-text "* Headline"
  755. (let ((org-quote-string "QUOTE"))
  756. (should-not (org-element-property :quotedp (org-element-at-point)))))
  757. ;; Standard position.
  758. (org-test-with-temp-text "* QUOTE Headline"
  759. (let* ((org-quote-string "QUOTE")
  760. (headline (org-element-at-point)))
  761. (should (org-element-property :quotedp headline))
  762. ;; Test removal from raw value.
  763. (should (equal (org-element-property :raw-value headline) "Headline"))))
  764. ;; Case sensitivity.
  765. (org-test-with-temp-text "* QUOTE Headline"
  766. (let* ((org-quote-string "Quote")
  767. (headline (org-element-at-point)))
  768. (should-not (org-element-property :quotedp headline))
  769. (should (equal (org-element-property :raw-value headline)
  770. "QUOTE Headline"))))
  771. ;; With another keyword.
  772. (org-test-with-temp-text "* TODO QUOTE Headline"
  773. (let* ((org-quote-string "QUOTE")
  774. (org-todo-keywords '((sequence "TODO" "DONE")))
  775. (headline (org-element-at-point)))
  776. (should (org-element-property :quotedp headline))
  777. (should (equal (org-element-property :raw-value headline) "Headline"))))
  778. ;; With the keyword only.
  779. (org-test-with-temp-text "* QUOTE"
  780. (let* ((org-quote-string "QUOTE")
  781. (headline (org-element-at-point)))
  782. (should (org-element-property :quotedp headline))
  783. (should (equal (org-element-property :raw-value headline) "")))))
  784. (ert-deftest test-org-element/headline-comment-keyword ()
  785. "Test COMMENT keyword recognition."
  786. ;; Reference test.
  787. (org-test-with-temp-text "* Headline"
  788. (let ((org-comment-string "COMMENT"))
  789. (should-not (org-element-property :commentedp (org-element-at-point)))))
  790. ;; Standard position.
  791. (org-test-with-temp-text "* COMMENT Headline"
  792. (let ((org-comment-string "COMMENT")
  793. (headline (org-element-at-point)))
  794. (should (org-element-property :commentedp headline))
  795. (should (equal (org-element-property :raw-value headline) "Headline"))))
  796. ;; Case sensitivity.
  797. (org-test-with-temp-text "* COMMENT Headline"
  798. (let* ((org-comment-string "Comment")
  799. (headline (org-element-at-point)))
  800. (should-not (org-element-property :commentedp headline))
  801. (should (equal (org-element-property :raw-value headline)
  802. "COMMENT Headline"))))
  803. ;; With another keyword.
  804. (org-test-with-temp-text "* TODO COMMENT Headline"
  805. (let* ((org-comment-string "COMMENT")
  806. (org-todo-keywords '((sequence "TODO" "DONE")))
  807. (headline (org-element-at-point)))
  808. (should (org-element-property :commentedp headline))
  809. (should (equal (org-element-property :raw-value headline) "Headline"))))
  810. ;; With the keyword only.
  811. (org-test-with-temp-text "* COMMENT"
  812. (let* ((org-comment-string "COMMENT")
  813. (headline (org-element-at-point)))
  814. (should (org-element-property :commentedp headline))
  815. (should (equal (org-element-property :raw-value headline) "")))))
  816. (ert-deftest test-org-element/headline-archive-tag ()
  817. "Test ARCHIVE tag recognition."
  818. ;; Reference test.
  819. (should-not
  820. (org-test-with-temp-text "* Headline"
  821. (let ((org-archive-tag "ARCHIVE"))
  822. (org-element-property :archivedp (org-element-at-point)))))
  823. ;; Single tag.
  824. (org-test-with-temp-text "* Headline :ARCHIVE:"
  825. (let ((org-archive-tag "ARCHIVE"))
  826. (let ((headline (org-element-at-point)))
  827. (should (org-element-property :archivedp headline))
  828. ;; Test tag removal.
  829. (should-not (org-element-property :tags headline)))))
  830. ;; Multiple tags.
  831. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  832. (let ((org-archive-tag "ARCHIVE"))
  833. (let ((headline (org-element-at-point)))
  834. (should (org-element-property :archivedp headline))
  835. ;; Test tag removal.
  836. (should (equal (org-element-property :tags headline) '("test"))))))
  837. ;; Tag is case-sensitive.
  838. (should-not
  839. (org-test-with-temp-text "* Headline :ARCHIVE:"
  840. (let ((org-archive-tag "Archive"))
  841. (org-element-property :archivedp (org-element-at-point))))))
  842. (ert-deftest test-org-element/headline-properties ()
  843. "Test properties from property drawer."
  844. ;; All properties from property drawer have their symbol upper
  845. ;; cased.
  846. (should
  847. (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
  848. (org-element-property :FOO (org-element-at-point))))
  849. (should-not
  850. (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
  851. (org-element-property :foo (org-element-at-point)))))
  852. ;;;; Horizontal Rule
  853. (ert-deftest test-org-element/horizontal-rule-parser ()
  854. "Test `horizontal-rule' parser."
  855. ;; Standard.
  856. (should
  857. (org-test-with-temp-text "-----"
  858. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  859. ;; Indented.
  860. (should
  861. (org-test-with-temp-text " -----"
  862. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  863. ;; Hyphen must be alone on the line.
  864. (should-not
  865. (org-test-with-temp-text "-----wrong"
  866. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  867. ;; 4 hyphens is too small.
  868. (should-not
  869. (org-test-with-temp-text "----"
  870. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  871. ;; Handle non-empty blank line at the end of buffer.
  872. (should
  873. (org-test-with-temp-text "-----\n "
  874. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  875. ;;;; Inline Babel Call
  876. (ert-deftest test-org-element/inline-babel-call-parser ()
  877. "Test `inline-babel-call' parser."
  878. (should
  879. (org-test-with-temp-text "call_test()"
  880. (org-element-map
  881. (org-element-parse-buffer) 'inline-babel-call 'identity))))
  882. ;;;; Inline Src Block
  883. (ert-deftest test-org-element/inline-src-block-parser ()
  884. "Test `inline-src-block' parser."
  885. (should
  886. (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
  887. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
  888. ;; Test parsing at the beginning of an item.
  889. (should
  890. (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
  891. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
  892. ;;;; Inlinetask
  893. (ert-deftest test-org-element/inlinetask-parser ()
  894. "Test `inlinetask' parser."
  895. (when (featurep 'org-inlinetask)
  896. (let ((org-inlinetask-min-level 15))
  897. ;; 1. Regular inlinetask.
  898. (should
  899. (org-test-with-temp-text
  900. "*************** Task\nTest\n*************** END"
  901. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  902. ;; 2. Degenerate inlinetask.
  903. (should
  904. (org-test-with-temp-text "*************** Task"
  905. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  906. ;; TODO keyword.
  907. (should
  908. (equal
  909. "TODO"
  910. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  911. (org-test-with-temp-text "*************** TODO Task"
  912. (org-element-property
  913. :todo-keyword
  914. (org-element-map (org-element-parse-buffer) 'inlinetask
  915. 'identity nil t))))))
  916. ;; Planning info.
  917. (should
  918. (equal
  919. "2012-03-29 thu."
  920. (org-test-with-temp-text "
  921. *************** Task
  922. DEADLINE: <2012-03-29 thu.>"
  923. (org-element-property
  924. :deadline
  925. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  926. ;; Priority.
  927. (should
  928. (equal
  929. ?A
  930. (org-test-with-temp-text "
  931. *************** [#A] Task"
  932. (org-element-property
  933. :priority
  934. (org-element-map
  935. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  936. ;; Tags.
  937. (should
  938. (equal
  939. '("test")
  940. (org-test-with-temp-text "
  941. *************** Task :test:"
  942. (org-element-property
  943. :tags
  944. (org-element-map
  945. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  946. ;; Regular properties are accessed through upper case keywords.
  947. (should
  948. (org-test-with-temp-text "
  949. *************** Task
  950. :PROPERTIES:
  951. :foo: bar
  952. :END:
  953. *************** END"
  954. (forward-line)
  955. (org-element-property :FOO (org-element-at-point))))
  956. (should-not
  957. (org-test-with-temp-text "
  958. *************** Task
  959. :PROPERTIES:
  960. :foo: bar
  961. :END:
  962. *************** END"
  963. (forward-line)
  964. (org-element-property :foo (org-element-at-point))))
  965. ;; Handle non-empty blank line at the end of buffer.
  966. (should
  967. (org-test-with-temp-text "*************** Task\n*************** END\n "
  968. (= (org-element-property :end (org-element-at-point)) (point-max)))))))
  969. ;;;; Italic
  970. (ert-deftest test-org-element/italic-parser ()
  971. "Test `italic' parser."
  972. ;; Regular test.
  973. (should
  974. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  975. (org-test-with-temp-text "/italic/"
  976. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  977. ;; Multi-line markup.
  978. (should
  979. (equal
  980. (org-element-contents
  981. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  982. (org-test-with-temp-text "/first line\nsecond line/"
  983. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  984. '("first line\nsecond line"))))
  985. ;;;; Item
  986. (ert-deftest test-org-element/item-parser ()
  987. "Test `item' parser."
  988. ;; Standard test.
  989. (should
  990. (org-test-with-temp-text "- item"
  991. (org-element-map (org-element-parse-buffer) 'item 'identity)))
  992. ;; Counter.
  993. (should
  994. (= 6
  995. (org-element-property
  996. :counter
  997. (org-test-with-temp-text "6. [@6] item"
  998. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  999. ;; Tag
  1000. (should
  1001. (equal
  1002. '("tag")
  1003. (org-element-property
  1004. :tag
  1005. (org-test-with-temp-text "- tag :: description"
  1006. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  1007. ;; No tags in ordered lists.
  1008. (should-not
  1009. (org-element-property
  1010. :tag
  1011. (org-test-with-temp-text "1. tag :: description"
  1012. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  1013. ;; Check-boxes
  1014. (should
  1015. (equal
  1016. '(trans on off)
  1017. (org-test-with-temp-text "
  1018. - [-] item 1
  1019. - [X] item 1.1
  1020. - [ ] item 1.2"
  1021. (org-element-map
  1022. (org-element-parse-buffer) 'item
  1023. (lambda (item) (org-element-property :checkbox item))))))
  1024. ;; Item starting with special syntax.
  1025. (should
  1026. (equal '(("- item"))
  1027. (org-test-with-temp-text "- - item"
  1028. (org-element-map (org-element-parse-buffer) 'paragraph
  1029. 'org-element-contents))))
  1030. ;; Block in an item: ignore indentation within the block.
  1031. (should
  1032. (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
  1033. (forward-char)
  1034. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1035. ;;;; Keyword
  1036. (ert-deftest test-org-element/keyword-parser ()
  1037. "Test `keyword' parser."
  1038. ;; Standard test.
  1039. (should
  1040. (org-test-with-temp-text "#+KEYWORD: value"
  1041. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  1042. ;; Keywords are case-insensitive.
  1043. (should
  1044. (org-test-with-temp-text "#+keyword: value"
  1045. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  1046. ;; Affiliated keywords are not keywords.
  1047. (should-not
  1048. (org-test-with-temp-text "#+NAME: value
  1049. Paragraph"
  1050. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  1051. ;; Do not mix keywords with Babel calls and dynamic blocks.
  1052. (should-not
  1053. (org-test-with-temp-text "#+CALL: fun()"
  1054. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  1055. (should-not
  1056. (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
  1057. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  1058. ;; Handle non-empty blank line at the end of buffer.
  1059. (should
  1060. (org-test-with-temp-text "#+KEYWORD: value\n "
  1061. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1062. ;;;; Latex Environment
  1063. (ert-deftest test-org-element/latex-environment-parser ()
  1064. "Test `latex-environment' parser."
  1065. (should
  1066. (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
  1067. (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
  1068. ;; Allow nested environments.
  1069. (should
  1070. (equal
  1071. "\\begin{outer}
  1072. \\begin{inner}
  1073. e^{i\\pi}+1=0
  1074. \\end{inner}
  1075. \\end{outer}"
  1076. (org-test-with-temp-text "
  1077. \\begin{outer}
  1078. \\begin{inner}
  1079. e^{i\\pi}+1=0
  1080. \\end{inner}
  1081. \\end{outer}"
  1082. (org-element-property
  1083. :value
  1084. (org-element-map
  1085. (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
  1086. ;; Allow environments with options and arguments.
  1087. (should
  1088. (eq 'latex-environment
  1089. (org-test-with-temp-text
  1090. "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
  1091. (org-element-type (org-element-at-point)))))
  1092. (should
  1093. (eq 'latex-environment
  1094. (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
  1095. (org-element-type (org-element-at-point)))))
  1096. (should-not
  1097. (eq 'latex-environment
  1098. (org-test-with-temp-text "\\begin{env}{arg} something\nvalue\n\\end{env}"
  1099. (org-element-type (org-element-at-point)))))
  1100. ;; Handle non-empty blank line at the end of buffer.
  1101. (should
  1102. (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
  1103. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1104. ;;;; Latex Fragment
  1105. (ert-deftest test-org-element/latex-fragment-parser ()
  1106. "Test `latex-fragment' parser."
  1107. (should
  1108. (org-test-with-temp-text "$a$"
  1109. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  1110. (should
  1111. (org-test-with-temp-text "$$a$$"
  1112. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  1113. (should
  1114. (org-test-with-temp-text "\\(a\\)"
  1115. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  1116. (should
  1117. (org-test-with-temp-text "\\[a\\]"
  1118. (org-element-map
  1119. (org-element-parse-buffer) 'latex-fragment 'identity)))
  1120. ;; Test fragment at the beginning of an item.
  1121. (should
  1122. (eq 'latex-fragment
  1123. (org-test-with-temp-text "- $x$"
  1124. (progn (search-forward "$")
  1125. (org-element-type (org-element-context)))))))
  1126. ;;;; Line Break
  1127. (ert-deftest test-org-element/line-break-parser ()
  1128. "Test `line-break' parser."
  1129. ;; Regular test.
  1130. (should
  1131. (org-test-with-temp-text "Text \\\\"
  1132. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  1133. ;; Line break with trailing white spaces.
  1134. (should
  1135. (org-test-with-temp-text "Text \\\\ "
  1136. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  1137. ;; Three backslashes are too much.
  1138. (should-not
  1139. (org-test-with-temp-text "Text \\\\\\"
  1140. (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
  1141. ;;;; Link
  1142. (ert-deftest test-org-element/link-parser ()
  1143. "Test `link' parser."
  1144. ;; Radio target.
  1145. (should
  1146. (equal
  1147. "radio"
  1148. (org-test-with-temp-text "A radio link"
  1149. (org-element-property
  1150. :type
  1151. (org-element-map
  1152. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  1153. 'link 'identity nil t)))))
  1154. ;; Standard link.
  1155. ;;
  1156. ;; ... with description.
  1157. (should
  1158. (equal
  1159. '("Orgmode.org")
  1160. (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  1161. (org-element-contents
  1162. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1163. ;; ... without description.
  1164. (should
  1165. (equal
  1166. "http"
  1167. (org-test-with-temp-text "[[http://orgmode.org]]"
  1168. (org-element-property
  1169. :type
  1170. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1171. ;; ... with expansion.
  1172. (should
  1173. (equal
  1174. "//orgmode.org/worg"
  1175. (org-test-with-temp-text "[[Org:worg]]"
  1176. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  1177. (org-element-property
  1178. :path
  1179. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
  1180. ;; ... with translation.
  1181. (should
  1182. (equal
  1183. "127.0.0.1"
  1184. (org-test-with-temp-text "[[http://orgmode.org]]"
  1185. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  1186. (let ((org-link-translation-function 'link-translate))
  1187. (org-element-property
  1188. :path
  1189. (org-element-map (org-element-parse-buffer) 'link
  1190. 'identity nil t)))))))
  1191. ;; ... id link.
  1192. (should
  1193. (equal
  1194. "id"
  1195. (org-test-with-temp-text "[[id:aaaa]]"
  1196. (org-element-property
  1197. :type
  1198. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1199. ;; ... custom-id link.
  1200. (should
  1201. (equal
  1202. "custom-id"
  1203. (org-test-with-temp-text "[[#some-id]]"
  1204. (org-element-property
  1205. :type
  1206. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1207. ;; ... coderef link.
  1208. (should
  1209. (equal
  1210. "coderef"
  1211. (org-test-with-temp-text "[[(reference)]]"
  1212. (org-element-property
  1213. :type
  1214. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1215. ;; ... fuzzy link.
  1216. (should
  1217. (equal
  1218. "fuzzy"
  1219. (org-test-with-temp-text "[[target-or-title]]"
  1220. (org-element-property
  1221. :type
  1222. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1223. ;; ... file-type link with search option.
  1224. (should
  1225. (equal
  1226. '(("file" "projects.org" "*task title"))
  1227. (org-test-with-temp-text "[[file:projects.org::*task title]]"
  1228. (org-element-map (org-element-parse-buffer) 'link
  1229. (lambda (l) (list (org-element-property :type l)
  1230. (org-element-property :path l)
  1231. (org-element-property :search-option l)))))))
  1232. ;; ... file-type link with application.
  1233. (should
  1234. (equal
  1235. '(("file" "projects.org" "docview"))
  1236. (org-test-with-temp-text "[[docview:projects.org]]"
  1237. (org-element-map (org-element-parse-buffer) 'link
  1238. (lambda (l) (list (org-element-property :type l)
  1239. (org-element-property :path l)
  1240. (org-element-property :application l)))))))
  1241. ;; Plain link.
  1242. (should
  1243. (org-test-with-temp-text "A link: http://orgmode.org"
  1244. (org-element-map (org-element-parse-buffer) 'link 'identity)))
  1245. ;; Angular link.
  1246. (should
  1247. (org-test-with-temp-text "A link: <http://orgmode.org>"
  1248. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))
  1249. ;; Link abbreviation.
  1250. (should
  1251. (equal "http"
  1252. (org-test-with-temp-text
  1253. "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
  1254. (progn (org-mode-restart)
  1255. (goto-char (1- (point-max)))
  1256. (org-element-property :type (org-element-context))))))
  1257. ;; Link abbreviation in a secondary string.
  1258. (should
  1259. (equal "http"
  1260. (org-test-with-temp-text
  1261. "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
  1262. (progn (org-mode-restart)
  1263. (org-element-map (org-element-parse-buffer) 'link
  1264. (lambda (link) (org-element-property :type link))
  1265. nil t nil t)))))
  1266. ;; Plain links are allowed as description of regular links.
  1267. (should
  1268. (equal "file"
  1269. (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
  1270. (search-forward "file:")
  1271. (org-element-property :type (org-element-context))))))
  1272. ;;;; Macro
  1273. (ert-deftest test-org-element/macro-parser ()
  1274. "Test `macro' parser."
  1275. ;; Without arguments.
  1276. (should
  1277. (org-test-with-temp-text "{{{macro}}}"
  1278. (org-element-map (org-element-parse-buffer) 'macro 'identity)))
  1279. ;; With arguments.
  1280. (should
  1281. (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
  1282. (org-element-map (org-element-parse-buffer) 'macro 'identity)))
  1283. ;; Properly handle protected commas in arguments...
  1284. (should
  1285. (= 2
  1286. (length
  1287. (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
  1288. (org-element-property :args (org-element-context))))))
  1289. ;; ... even when last argument ends with a protected comma.
  1290. (should
  1291. (equal '("C-,")
  1292. (org-test-with-temp-text "{{{macro(C-\\,)}}}"
  1293. (org-element-property :args (org-element-context)))))
  1294. ;; Allow to escape escaping character.
  1295. (should
  1296. (equal '("C-\\" "")
  1297. (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
  1298. (org-element-property :args (org-element-context)))))
  1299. ;; No need to escape backslashes elsewhere.
  1300. (should
  1301. (equal '("\\")
  1302. (org-test-with-temp-text "{{{macro(\\)}}}"
  1303. (org-element-property :args (org-element-context))))))
  1304. ;;;; Node Property
  1305. (ert-deftest test-org-element/node-property ()
  1306. "Test `node-property' parser."
  1307. ;; Standard test.
  1308. (should
  1309. (equal '("abc" "value")
  1310. (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
  1311. (progn (forward-line)
  1312. (let ((element (org-element-at-point)))
  1313. (list (org-element-property :key element)
  1314. (org-element-property :value element)))))))
  1315. ;; Value should be trimmed.
  1316. (should
  1317. (equal "value"
  1318. (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
  1319. (progn (forward-line)
  1320. (let ((element (org-element-at-point)))
  1321. (org-element-property :value element))))))
  1322. ;; A node property requires to be wrapped within a property drawer.
  1323. (should-not
  1324. (eq 'node-property
  1325. (org-test-with-temp-text ":abc: value"
  1326. (org-element-type (org-element-at-point))))))
  1327. ;;;; Paragraph
  1328. (ert-deftest test-org-element/paragraph-parser ()
  1329. "Test `paragraph' parser."
  1330. ;; Standard test.
  1331. (should
  1332. (org-test-with-temp-text "Paragraph"
  1333. (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
  1334. ;; Property find end of a paragraph stuck to another element.
  1335. (should
  1336. (eq ?#
  1337. (org-test-with-temp-text "Paragraph\n# Comment"
  1338. (org-element-map (org-element-parse-buffer) 'paragraph
  1339. (lambda (p) (char-after (org-element-property :end p)))
  1340. nil t))))
  1341. ;; Include ill-formed Keywords.
  1342. (should
  1343. (org-test-with-temp-text "#+wrong_keyword something"
  1344. (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
  1345. ;; Include incomplete-drawers.
  1346. (should
  1347. (org-test-with-temp-text ":TEST:\nParagraph"
  1348. (let ((elem (org-element-at-point)))
  1349. (and (eq (org-element-type elem) 'paragraph)
  1350. (= (point-max) (org-element-property :end elem))))))
  1351. ;; Include incomplete blocks.
  1352. (should
  1353. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
  1354. (let ((elem (org-element-at-point)))
  1355. (and (eq (org-element-type elem) 'paragraph)
  1356. (= (point-max) (org-element-property :end elem))))))
  1357. ;; Include incomplete dynamic blocks.
  1358. (should
  1359. (org-test-with-temp-text "#+BEGIN: \nParagraph"
  1360. (let ((elem (org-element-at-point)))
  1361. (and (eq (org-element-type elem) 'paragraph)
  1362. (= (point-max) (org-element-property :end elem))))))
  1363. ;; Include incomplete latex environments.
  1364. (should
  1365. (org-test-with-temp-text "\begin{equation}\nParagraph"
  1366. (let ((elem (org-element-at-point)))
  1367. (and (eq (org-element-type elem) 'paragraph)
  1368. (= (point-max) (org-element-property :end elem))))))
  1369. ;; Do not steal affiliated keywords from container.
  1370. (should
  1371. (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
  1372. (let ((elem (progn (search-forward "item") (org-element-at-point))))
  1373. (and (eq (org-element-type elem) 'paragraph)
  1374. (not (org-element-property :attr_latex elem))
  1375. (/= (org-element-property :begin elem) 1)))))
  1376. ;; Handle non-empty blank line at the end of buffer.
  1377. (should
  1378. (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
  1379. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1380. ;;;; Plain List
  1381. (ert-deftest test-org-element/plain-list-parser ()
  1382. "Test `plain-list' parser."
  1383. (org-test-with-temp-text "- item"
  1384. (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
  1385. ;; Blank lines after the list only belong to outer plain list.
  1386. (should
  1387. (equal
  1388. '(t t)
  1389. (org-test-with-temp-text "
  1390. - outer
  1391. - inner
  1392. Outside list"
  1393. (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
  1394. (lambda (pl) (org-element-property :end pl)))))
  1395. (list
  1396. ;; Move to ending of outer list.
  1397. (progn (goto-char (car endings)) (looking-at "Outside list"))
  1398. ;; Move to ending of inner list.
  1399. (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
  1400. ;; Correctly compute end of list if it doesn't end at a line
  1401. ;; beginning.
  1402. (should
  1403. (org-test-with-temp-text "- list\n \n "
  1404. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1405. ;;;; Planning
  1406. (ert-deftest test-org-element/planning-parser ()
  1407. "Test `planning' parser."
  1408. (should
  1409. (equal "[2012-03-29 thu.]"
  1410. (org-element-property
  1411. :raw-value
  1412. (org-element-property
  1413. :closed
  1414. (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
  1415. (org-element-at-point))))))
  1416. (should
  1417. (equal "<2012-03-29 thu.>"
  1418. (org-element-property
  1419. :raw-value
  1420. (org-element-property
  1421. :deadline
  1422. (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
  1423. (org-element-at-point))))))
  1424. (should
  1425. (equal "<2012-03-29 thu.>"
  1426. (org-element-property
  1427. :raw-value
  1428. (org-element-property
  1429. :scheduled
  1430. (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
  1431. (org-element-at-point)))))))
  1432. ;;;; Property Drawer
  1433. (ert-deftest test-org-element/property-drawer-parser ()
  1434. "Test `property-drawer' parser."
  1435. ;; Standard test.
  1436. (should
  1437. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  1438. (org-element-map
  1439. (org-element-parse-buffer) 'property-drawer 'identity nil t)))
  1440. ;; Do not mix property drawers and regular drawers.
  1441. (should-not
  1442. (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
  1443. (org-element-map
  1444. (org-element-parse-buffer) 'property-drawer 'identity nil t)))
  1445. ;; Ignore incomplete drawer.
  1446. (should-not
  1447. (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
  1448. (org-element-map
  1449. (org-element-parse-buffer) 'property-drawer 'identity nil t)))
  1450. ;; Handle non-empty blank line at the end of buffer.
  1451. (should
  1452. (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
  1453. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1454. ;;;; Quote Block
  1455. (ert-deftest test-org-element/quote-block-parser ()
  1456. "Test `quote-block' parser."
  1457. ;; Regular test.
  1458. (should
  1459. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1460. (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
  1461. ;; Ignore incomplete block.
  1462. (should-not
  1463. (org-test-with-temp-text "#+BEGIN_QUOTE"
  1464. (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
  1465. ;; Handle non-empty blank line at the end of buffer.
  1466. (should
  1467. (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
  1468. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1469. ;;;; Quote Section
  1470. (ert-deftest test-org-element/quote-section-parser ()
  1471. "Test `quote-section' parser."
  1472. (should
  1473. (let ((org-quote-string "QUOTE"))
  1474. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1475. (org-element-map (org-element-parse-buffer) 'quote-section 'identity))))
  1476. (should-not
  1477. (let ((org-quote-string "TEST"))
  1478. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1479. (org-element-map (org-element-parse-buffer) 'quote-section 'identity)))))
  1480. ;;;; Radio Target
  1481. (ert-deftest test-org-element/radio-target-parser ()
  1482. "Test `radio-target' parser."
  1483. ;; Standard test.
  1484. (should
  1485. (org-test-with-temp-text "<<<radio>>>"
  1486. (org-element-map (org-element-parse-buffer) 'radio-target 'identity)))
  1487. ;; Radio targets with objects.
  1488. (should
  1489. (org-test-with-temp-text "<<<radio \\alpha>>>"
  1490. (org-element-map (org-element-parse-buffer) 'radio-target 'identity))))
  1491. ;;;; Section
  1492. (ert-deftest test-org-element/section-parser ()
  1493. "Test `section' parser."
  1494. ;; Standard test.
  1495. (should
  1496. (org-test-with-temp-text "* Headline\nText"
  1497. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1498. ;; There's a section before the first headline.
  1499. (should
  1500. (org-test-with-temp-text "Text"
  1501. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1502. ;; A section cannot be empty.
  1503. (should-not
  1504. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  1505. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1506. ;; A section doesn't contain sub-trees.
  1507. (should-not
  1508. (org-test-with-temp-text "* Head\nText\n** Sub-Head"
  1509. (org-element-map
  1510. (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
  1511. 'headline 'identity))))
  1512. ;;;; Special Block
  1513. (ert-deftest test-org-element/special-block-parser ()
  1514. "Test `special-block' parser."
  1515. ;; Standard test.
  1516. (should
  1517. (equal "SPECIAL"
  1518. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1519. (org-element-property :type (org-element-at-point)))))
  1520. ;; Special blocks can contain paragraphs.
  1521. (should
  1522. (eq 'paragraph
  1523. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1524. (forward-line)
  1525. (org-element-type (org-element-at-point)))))
  1526. ;; Ignore incomplete block.
  1527. (should-not
  1528. (eq 'special-block
  1529. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  1530. (org-element-type (org-element-at-point)))))
  1531. ;; Allow special characters in type.
  1532. (should
  1533. (equal '(special-block "SPECIAL*")
  1534. (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
  1535. (let ((element (org-element-at-point)))
  1536. (list (org-element-type element)
  1537. (org-element-property :type element))))))
  1538. ;; Handle non-empty blank line at the end of buffer.
  1539. (should
  1540. (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
  1541. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1542. ;;;; Src Block
  1543. (ert-deftest test-org-element/src-block-parser ()
  1544. "Test `src-block' parser."
  1545. ;; Regular tests.
  1546. (should
  1547. (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
  1548. (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
  1549. ;; Ignore incomplete block.
  1550. (should-not
  1551. (org-test-with-temp-text "#+BEGIN_SRC"
  1552. (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
  1553. ;; Properly un-escape code.
  1554. (should
  1555. (equal "* Headline\n #+keyword\nText\n"
  1556. (org-test-with-temp-text
  1557. "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
  1558. (org-element-property :value (org-element-at-point)))))
  1559. ;; Remove block indentation according to block boundaries, unless
  1560. ;; block contents are less indented than block boundaries.
  1561. (should
  1562. (equal " L1\nL2\n"
  1563. (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
  1564. (let ((org-src-preserve-indentation t))
  1565. (org-element-property :value (org-element-at-point))))))
  1566. (should
  1567. (equal
  1568. " L1\n L2\n"
  1569. (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
  1570. (let ((org-src-preserve-indentation t))
  1571. (org-element-property :value (org-element-at-point))))))
  1572. ;; Handle non-empty blank line at the end of buffer.
  1573. (should
  1574. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
  1575. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1576. ;;;; Statistics Cookie
  1577. (ert-deftest test-org-element/statistics-cookie ()
  1578. "Test `statistics-cookie' parser."
  1579. ;; With numbers.
  1580. (should
  1581. (org-test-with-temp-text "[1/2]"
  1582. (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
  1583. ;; With percents.
  1584. (should
  1585. (org-test-with-temp-text "[33%]"
  1586. (org-element-map
  1587. (org-element-parse-buffer) 'statistics-cookie 'identity))))
  1588. ;;;; Strike Through
  1589. (ert-deftest test-org-element/strike-through-parser ()
  1590. "Test `strike-through' parser."
  1591. ;; Regular test.
  1592. (should
  1593. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1594. (org-test-with-temp-text "+strike-through+"
  1595. (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
  1596. ;; Multi-line markup.
  1597. (should
  1598. (equal
  1599. (org-element-contents
  1600. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1601. (org-test-with-temp-text "+first line\nsecond line+"
  1602. (org-element-map
  1603. (org-element-parse-buffer) 'strike-through 'identity nil t))))
  1604. '("first line\nsecond line"))))
  1605. ;;;; Subscript
  1606. (ert-deftest test-org-element/subscript-parser ()
  1607. "Test `subscript' parser."
  1608. ;; Without braces.
  1609. (should
  1610. (org-test-with-temp-text "a_b"
  1611. (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
  1612. ;; With braces.
  1613. (should
  1614. (org-test-with-temp-text "a_{b}"
  1615. (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
  1616. ;; Multiple subscripts in a paragraph.
  1617. (should
  1618. (= 2
  1619. (org-test-with-temp-text "a_b and c_d"
  1620. (length
  1621. (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
  1622. ;;;; Superscript
  1623. (ert-deftest test-org-element/superscript-parser ()
  1624. "Test `superscript' parser."
  1625. ;; Without braces.
  1626. (should
  1627. (org-test-with-temp-text "a^b"
  1628. (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
  1629. ;; With braces.
  1630. (should
  1631. (org-test-with-temp-text "a^{b}"
  1632. (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
  1633. ;; Multiple superscript in a paragraph.
  1634. (should
  1635. (= 2
  1636. (org-test-with-temp-text "a^b and c^d"
  1637. (length
  1638. (org-element-map
  1639. (org-element-parse-buffer) 'superscript 'identity))))))
  1640. ;;;; Table
  1641. (ert-deftest test-org-element/table-parser ()
  1642. "Test `table' parser."
  1643. (should
  1644. (org-test-with-temp-text "| a |"
  1645. (org-element-map (org-element-parse-buffer) 'table 'identity)))
  1646. ;; TBLFM keyword is case insensitive.
  1647. (should
  1648. (org-test-with-temp-text "| a |\n#+tblfm: test"
  1649. (org-element-property
  1650. :tblfm
  1651. (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
  1652. ;; Handle multiple TBLFM lines.
  1653. (should
  1654. (= 2
  1655. (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
  1656. (length (org-element-property
  1657. :tblfm
  1658. (org-element-map
  1659. (org-element-parse-buffer) 'table 'identity nil t))))))
  1660. ;; Handle non-empty blank line at the end of buffer.
  1661. (should
  1662. (org-test-with-temp-text "| a |\n "
  1663. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1664. ;;;; Table Cell
  1665. (ert-deftest test-org-element/table-cell-parser ()
  1666. "Test `table-cell' parser."
  1667. (should
  1668. (org-test-with-temp-text "| a |"
  1669. (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
  1670. ;;;; Table Row
  1671. (ert-deftest test-org-element/table-row-parser ()
  1672. "Test `table-row' parser."
  1673. (should
  1674. (equal '(standard rule)
  1675. (org-test-with-temp-text "| a |\n|---|"
  1676. (org-element-map
  1677. (org-element-parse-buffer) 'table-row
  1678. (lambda (row) (org-element-property :type row)))))))
  1679. ;;;; Target
  1680. (ert-deftest test-org-element/target-parser ()
  1681. "Test `target' parser."
  1682. (should
  1683. (org-test-with-temp-text "<<target>>"
  1684. (org-element-map (org-element-parse-buffer) 'target 'identity))))
  1685. ;;;; Timestamp
  1686. (ert-deftest test-org-element/timestamp ()
  1687. "Test `timestamp' parser."
  1688. ;; Active timestamp.
  1689. (should
  1690. (org-test-with-temp-text "<2012-03-29 16:40>"
  1691. (eq (org-element-property :type (org-element-context)) 'active)))
  1692. (should-not
  1693. (org-test-with-temp-text "<2012-03-29 Thu>"
  1694. (let ((timestamp (org-element-context)))
  1695. (or (org-element-property :hour-start timestamp)
  1696. (org-element-property :minute-start timestamp)))))
  1697. (should
  1698. (equal '(2012 3 29 16 40)
  1699. (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
  1700. (let ((object (org-element-context)))
  1701. (list (org-element-property :year-start object)
  1702. (org-element-property :month-start object)
  1703. (org-element-property :day-start object)
  1704. (org-element-property :hour-start object)
  1705. (org-element-property :minute-start object))))))
  1706. ;; Inactive timestamp.
  1707. (should
  1708. (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
  1709. (eq (org-element-property :type (org-element-context)) 'inactive)))
  1710. ;; Time range.
  1711. (should
  1712. (equal '(2012 3 29 16 40 7 30)
  1713. (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
  1714. (let ((object (org-element-context)))
  1715. (list (org-element-property :year-end object)
  1716. (org-element-property :month-end object)
  1717. (org-element-property :day-end object)
  1718. (org-element-property :hour-end object)
  1719. (org-element-property :minute-end object)
  1720. (org-element-property :hour-start object)
  1721. (org-element-property :minute-start object))))))
  1722. (should
  1723. (eq 'active-range
  1724. (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
  1725. (org-element-property :type (org-element-context)))))
  1726. ;; Date range.
  1727. (should
  1728. (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
  1729. (eq (org-element-property :type (org-element-context)) 'inactive-range)))
  1730. (should-not
  1731. (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
  1732. (let ((timestamp (org-element-context)))
  1733. (or (org-element-property :hour-end timestamp)
  1734. (org-element-property :minute-end timestamp)))))
  1735. ;; With repeater, warning delay and both.
  1736. (should
  1737. (eq 'catch-up
  1738. (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
  1739. (org-element-property :repeater-type (org-element-context)))))
  1740. (should
  1741. (eq 'first
  1742. (org-test-with-temp-text "<2012-03-29 Thu --1y>"
  1743. (org-element-property :warning-type (org-element-context)))))
  1744. (should
  1745. (equal '(cumulate all)
  1746. (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
  1747. (let ((ts (org-element-context)))
  1748. (list (org-element-property :repeater-type ts)
  1749. (org-element-property :warning-type ts))))))
  1750. ;; Timestamps are not planning elements.
  1751. (should-not
  1752. (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
  1753. (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
  1754. ;;;; Underline
  1755. (ert-deftest test-org-element/underline-parser ()
  1756. "Test `underline' parser."
  1757. ;; Regular test.
  1758. (should
  1759. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1760. (org-test-with-temp-text "_underline_"
  1761. (org-element-map (org-element-parse-buffer) 'underline 'identity))))
  1762. ;; Multi-line markup.
  1763. (should
  1764. (equal
  1765. (org-element-contents
  1766. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1767. (org-test-with-temp-text "_first line\nsecond line_"
  1768. (org-element-map
  1769. (org-element-parse-buffer) 'underline 'identity nil t))))
  1770. '("first line\nsecond line"))))
  1771. ;;;; Verbatim
  1772. (ert-deftest test-org-element/verbatim-parser ()
  1773. "Test `verbatim' parser."
  1774. ;; Regular test.
  1775. (should
  1776. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1777. (org-test-with-temp-text "=verbatim="
  1778. (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
  1779. ;; Multi-line markup.
  1780. (should
  1781. (equal
  1782. (org-element-property
  1783. :value
  1784. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1785. (org-test-with-temp-text "=first line\nsecond line="
  1786. (org-element-map
  1787. (org-element-parse-buffer) 'verbatim 'identity nil t))))
  1788. "first line\nsecond line")))
  1789. ;;;; Verse Block
  1790. (ert-deftest test-org-element/verse-block-parser ()
  1791. "Test `verse-block' parser."
  1792. ;; Standard test.
  1793. (should
  1794. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1795. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1796. ;; Ignore case.
  1797. (should
  1798. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  1799. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1800. ;; Parse objects in verse blocks.
  1801. (should
  1802. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  1803. (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  1804. ;; Ignore incomplete verse block.
  1805. (should-not
  1806. (org-test-with-temp-text "#+BEGIN_VERSE"
  1807. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
  1808. ;; Handle non-empty blank line at the end of buffer.
  1809. (should
  1810. (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
  1811. (= (org-element-property :end (org-element-at-point)) (point-max)))))
  1812. ;;; Test Interpreters.
  1813. (ert-deftest test-org-element/interpret-data ()
  1814. "Test `org-element-interpret-data' specifications."
  1815. ;; Interpret simple affiliated keywords.
  1816. (should
  1817. (equal
  1818. (org-element-interpret-data
  1819. '(org-data nil (paragraph (:name "para") "Paragraph")))
  1820. "#+NAME: para\nParagraph\n"))
  1821. ;; Interpret multiple affiliated keywords.
  1822. (should
  1823. (equal
  1824. (org-element-interpret-data
  1825. '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
  1826. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  1827. ;; Interpret parsed affiliated keywords.
  1828. (should
  1829. (equal
  1830. (org-element-interpret-data
  1831. '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
  1832. "#+CAPTION: caption\nParagraph\n"))
  1833. ;; Interpret dual affiliated keywords.
  1834. (should
  1835. (equal
  1836. (org-element-interpret-data
  1837. '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
  1838. "#+CAPTION[short]: long\nParagraph\n"))
  1839. ;; Interpret multiple parsed dual keywords.
  1840. (should
  1841. (equal
  1842. (org-element-interpret-data
  1843. '(org-data nil (paragraph
  1844. (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
  1845. "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
  1846. ;; Pseudo objects and elements are transparent.
  1847. (should
  1848. (equal "A B\n"
  1849. (org-element-interpret-data
  1850. '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")
  1851. '(pseudo-object))))
  1852. (should
  1853. (equal "A\n\nB\n"
  1854. (org-element-interpret-data
  1855. '(center nil
  1856. (pseudo-element (:post-blank 1) (paragraph nil "A"))
  1857. (paragraph nil "B"))))))
  1858. (ert-deftest test-org-element/center-block-interpreter ()
  1859. "Test center block interpreter."
  1860. (should
  1861. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1862. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1863. (ert-deftest test-org-element/drawer-interpreter ()
  1864. "Test drawer interpreter."
  1865. (should
  1866. (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
  1867. ":TEST:\nTest\n:END:\n")))
  1868. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1869. "Test dynamic block interpreter."
  1870. (should
  1871. (equal (org-test-parse-and-interpret
  1872. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1873. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1874. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1875. "Test footnote definition interpreter."
  1876. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1877. (ert-deftest test-org-element/headline-interpreter ()
  1878. "Test headline and section interpreters."
  1879. ;; 1. Standard test.
  1880. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1881. ;; 2. With TODO keywords.
  1882. (should
  1883. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1884. (org-test-parse-and-interpret "* TODO Headline"))
  1885. "* TODO Headline\n"))
  1886. ;; 3. With tags...
  1887. ;;
  1888. ;; 3.1. ... and a positive `org-tags-column' value.
  1889. (should
  1890. (equal (let ((org-tags-column 20))
  1891. (org-test-parse-and-interpret "* Headline :tag:"))
  1892. "* Headline :tag:\n"))
  1893. ;; 3.2. ... and a negative `org-tags-column' value.
  1894. (should
  1895. (equal (let ((org-tags-column -20))
  1896. (org-test-parse-and-interpret "* Headline :tag:"))
  1897. "* Headline :tag:\n"))
  1898. ;; 3.3. ... and a null `org-tags-column' value.
  1899. (should
  1900. (equal (let ((org-tags-column 0))
  1901. (org-test-parse-and-interpret "* Headline :tag:"))
  1902. "* Headline :tag:\n"))
  1903. ;; 4. With priority cookie.
  1904. (should
  1905. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1906. "* [#B] Headline\n"))
  1907. ;; 5. With comment keyword.
  1908. (should
  1909. (equal (let ((org-comment-string "COMMENT"))
  1910. (org-test-parse-and-interpret "* COMMENT Headline"))
  1911. "* COMMENT Headline\n"))
  1912. ;; 6. With quote section.
  1913. (should
  1914. (equal (let ((org-quote-string "QUOTE"))
  1915. (org-test-parse-and-interpret "* QUOTE Headline"))
  1916. "* QUOTE Headline\n"))
  1917. ;; 7. Keep same number of blank lines before body.
  1918. (should
  1919. (equal (org-test-parse-and-interpret
  1920. "* Headline\n\n\nText after two blank lines.")
  1921. "* Headline\n\n\nText after two blank lines.\n")))
  1922. (ert-deftest test-org-element/inlinetask-interpreter ()
  1923. "Test inlinetask interpretation."
  1924. (when (featurep 'org-inlinetask)
  1925. (let ((org-inlinetask-min-level 15))
  1926. ;; 1. Regular inlinetask.
  1927. (should (equal (org-test-parse-and-interpret
  1928. "*************** Task\nTest\n*************** END")
  1929. "*************** Task\nTest\n*************** END\n"))
  1930. ;; 2. Degenerate inlinetask.
  1931. (should (equal (org-test-parse-and-interpret "*************** Task")
  1932. "*************** Task\n"))
  1933. ;; 3. Prefer degenerate form when there are no contents.
  1934. (should (equal (org-test-parse-and-interpret
  1935. "*************** Task\n*************** END")
  1936. "*************** Task\n"))
  1937. ;; 4. With TODO keywords.
  1938. (should
  1939. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1940. (org-test-parse-and-interpret "*************** TODO Task"))
  1941. "*************** TODO Task\n"))
  1942. ;; 5. With tags...
  1943. ;;
  1944. ;; 5.1. ... and a positive `org-tags-column' value.
  1945. (should
  1946. (equal (let ((org-tags-column 30))
  1947. (org-test-parse-and-interpret "*************** Task :tag:"))
  1948. "*************** Task :tag:\n"))
  1949. ;; 5.2. ... and a negative `org-tags-column' value.
  1950. (should
  1951. (equal (let ((org-tags-column -30))
  1952. (org-test-parse-and-interpret "*************** Task :tag:"))
  1953. "*************** Task :tag:\n"))
  1954. ;; 5.3. ... and a null `org-tags-column' value.
  1955. (should
  1956. (equal (let ((org-tags-column 0))
  1957. (org-test-parse-and-interpret "*************** Task :tag:"))
  1958. "*************** Task :tag:\n"))
  1959. ;; 6. With priority cookie.
  1960. (should
  1961. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1962. "*************** [#B] Task\n")))))
  1963. (ert-deftest test-org-element/plain-list-interpreter ()
  1964. "Test plain-list and item interpreters."
  1965. (let ((org-list-two-spaces-after-bullet-regexp nil))
  1966. ;; Unordered list.
  1967. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1968. ;; Description list.
  1969. (should
  1970. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1971. ;; Ordered list.
  1972. (should
  1973. (equal (let ((org-plain-list-ordered-item-terminator t))
  1974. (org-test-parse-and-interpret "1. Item"))
  1975. "1. Item\n"))
  1976. (should
  1977. (equal (let ((org-plain-list-ordered-item-terminator ?\)))
  1978. (org-test-parse-and-interpret "1) Item"))
  1979. "1) Item\n"))
  1980. ;; Ordered list with counter.
  1981. (should
  1982. (equal (let ((org-plain-list-ordered-item-terminator t))
  1983. (org-test-parse-and-interpret "1. [@5] Item"))
  1984. "5. [@5] Item\n"))
  1985. ;; List with check-boxes.
  1986. (should
  1987. (equal (org-test-parse-and-interpret
  1988. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1989. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
  1990. ;; Item not starting with a paragraph.
  1991. (should
  1992. (equal (org-test-parse-and-interpret "-\n | a | b |")
  1993. "- \n | a | b |\n"))
  1994. ;; Special case: correctly handle "*" bullets.
  1995. (should (org-test-parse-and-interpret " * item"))
  1996. ;; Special case: correctly handle empty items.
  1997. (should (org-test-parse-and-interpret "-"))))
  1998. (ert-deftest test-org-element/quote-block-interpreter ()
  1999. "Test quote block interpreter."
  2000. (should (equal (org-test-parse-and-interpret
  2001. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  2002. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  2003. (ert-deftest test-org-element/special-block-interpreter ()
  2004. "Test special block interpreter."
  2005. (should (equal (org-test-parse-and-interpret
  2006. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  2007. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  2008. (ert-deftest test-org-element/babel-call-interpreter ()
  2009. "Test babel call interpreter."
  2010. ;; 1. Without argument.
  2011. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  2012. "#+CALL: test()\n"))
  2013. ;; 2. With argument.
  2014. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  2015. "#+CALL: test(x=2)\n"))
  2016. ;; 3. With header arguments.
  2017. (should (equal (org-test-parse-and-interpret
  2018. "#+CALL: test[:results output]()[:results html]")
  2019. "#+CALL: test[:results output]()[:results html]\n")))
  2020. (ert-deftest test-org-element/clock-interpreter ()
  2021. "Test clock interpreter."
  2022. ;; Running clock.
  2023. (should
  2024. (string-match
  2025. "CLOCK: \\[2012-01-01 .* 00:01\\]"
  2026. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
  2027. ;; Closed clock.
  2028. (should
  2029. (string-match
  2030. "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
  2031. (org-test-parse-and-interpret "
  2032. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
  2033. (ert-deftest test-org-element/comment-interpreter ()
  2034. "Test comment interpreter."
  2035. ;; Regular comment.
  2036. (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
  2037. ;; Inline comment.
  2038. (should (equal (org-test-parse-and-interpret " # Comment")
  2039. "# Comment\n"))
  2040. ;; Preserve indentation.
  2041. (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
  2042. "# No blank\n# One blank\n")))
  2043. (ert-deftest test-org-element/comment-block-interpreter ()
  2044. "Test comment block interpreter."
  2045. (should (equal (org-test-parse-and-interpret
  2046. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  2047. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  2048. (ert-deftest test-org-element/diary-sexp ()
  2049. "Test diary-sexp interpreter."
  2050. (should
  2051. (equal
  2052. (org-test-parse-and-interpret
  2053. "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
  2054. "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
  2055. (ert-deftest test-org-element/example-block-interpreter ()
  2056. "Test example block interpreter."
  2057. ;; Without switches.
  2058. (should (equal (org-test-parse-and-interpret
  2059. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  2060. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  2061. ;; With switches.
  2062. (should
  2063. (equal (org-test-parse-and-interpret
  2064. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  2065. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
  2066. ;; Preserve code escaping.
  2067. (should
  2068. (equal (org-test-parse-and-interpret
  2069. "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
  2070. "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
  2071. (ert-deftest test-org-element/export-block-interpreter ()
  2072. "Test export block interpreter."
  2073. (should (equal (org-test-parse-and-interpret
  2074. "#+BEGIN_HTML\nTest\n#+END_HTML")
  2075. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  2076. (ert-deftest test-org-element/fixed-width-interpreter ()
  2077. "Test fixed width interpreter."
  2078. ;; Standard test.
  2079. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  2080. ;; Preserve indentation.
  2081. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  2082. ": 2 blanks\n: 1 blank\n"))
  2083. ;; Remove last newline character
  2084. (should
  2085. (equal (org-element-fixed-width-interpreter
  2086. '(fixed-width (:value "Test\n")) nil)
  2087. ": Test"))
  2088. (should
  2089. (equal (org-element-fixed-width-interpreter
  2090. '(fixed-width (:value "Test")) nil)
  2091. ": Test"))
  2092. ;; Handle empty string.
  2093. (should
  2094. (equal (org-element-fixed-width-interpreter
  2095. '(fixed-width (:value "")) nil)
  2096. ""))
  2097. ;; Handle nil value.
  2098. (should-not
  2099. (org-element-fixed-width-interpreter
  2100. '(fixed-width (:value nil)) nil)))
  2101. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  2102. "Test horizontal rule interpreter."
  2103. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  2104. (ert-deftest test-org-element/keyword-interpreter ()
  2105. "Test keyword interpreter."
  2106. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  2107. "#+KEYWORD: value\n")))
  2108. (ert-deftest test-org-element/latex-environment-interpreter ()
  2109. "Test latex environment interpreter."
  2110. (should (equal (org-test-parse-and-interpret
  2111. "\\begin{equation}\n1+1=2\n\\end{equation}")
  2112. "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
  2113. (should (equal (org-test-parse-and-interpret
  2114. "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
  2115. "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
  2116. (ert-deftest test-org-element/planning-interpreter ()
  2117. "Test planning interpreter."
  2118. (should
  2119. (string-match
  2120. "\\* Headline
  2121. DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
  2122. (org-test-parse-and-interpret
  2123. "* Headline
  2124. DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
  2125. (ert-deftest test-org-element/property-drawer-interpreter ()
  2126. "Test property drawer interpreter."
  2127. (should (equal (let ((org-property-format "%-10s %s"))
  2128. (org-test-parse-and-interpret
  2129. ":PROPERTIES:\n:prop: value\n:END:"))
  2130. ":PROPERTIES:\n:prop: value\n:END:\n")))
  2131. (ert-deftest test-org-element/src-block-interpreter ()
  2132. "Test src block interpreter."
  2133. ;; With arguments.
  2134. (should
  2135. (equal (let ((org-edit-src-content-indentation 2))
  2136. (org-test-parse-and-interpret
  2137. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
  2138. "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
  2139. ;; With switches.
  2140. (should
  2141. (equal (let ((org-edit-src-content-indentation 2))
  2142. (org-test-parse-and-interpret
  2143. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
  2144. "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
  2145. ;; Preserve code escaping.
  2146. (should
  2147. (equal (let ((org-edit-src-content-indentation 2))
  2148. (org-test-parse-and-interpret
  2149. "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
  2150. "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
  2151. ;; Do not apply `org-edit-src-content-indentation' when preserving
  2152. ;; indentation.
  2153. (should
  2154. (equal (let ((org-edit-src-content-indentation 2)
  2155. (org-src-preserve-indentation t))
  2156. (org-test-parse-and-interpret
  2157. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
  2158. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
  2159. (should
  2160. (equal (let ((org-edit-src-content-indentation 2)
  2161. (org-src-preserve-indentation nil))
  2162. (org-test-parse-and-interpret
  2163. "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
  2164. "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
  2165. (ert-deftest test-org-element/table-interpreter ()
  2166. "Test table, table-row and table-cell interpreters."
  2167. ;; 1. Simple table.
  2168. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  2169. "| a | b |\n| c | d |\n"))
  2170. ;; 2. With horizontal rules.
  2171. (should (equal (org-test-parse-and-interpret
  2172. "| a | b |\n|---+---|\n| c | d |")
  2173. "| a | b |\n|---+---|\n| c | d |\n"))
  2174. ;; 3. With meta-data.
  2175. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  2176. "| / | < | > |\n| * | 1 | 2 |\n"))
  2177. ;; 4. With a formula.
  2178. (should
  2179. (equal (org-test-parse-and-interpret
  2180. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
  2181. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
  2182. ;; 5. With multiple formulas.
  2183. (should
  2184. (equal (org-test-parse-and-interpret
  2185. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
  2186. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
  2187. (ert-deftest test-org-element/timestamp-interpreter ()
  2188. "Test timestamp interpreter."
  2189. ;; Active.
  2190. (should
  2191. (string-match "<2012-03-29 .* 16:40>"
  2192. (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
  2193. (should
  2194. (string-match "<2012-03-29 .* 16:40>"
  2195. (org-element-timestamp-interpreter
  2196. '(timestamp
  2197. (:type active :year-start 2012 :month-start 3 :day-start 29
  2198. :hour-start 16 :minute-start 40)) nil)))
  2199. ;; Inactive.
  2200. (should
  2201. (string-match "\\[2012-03-29 .* 16:40\\]"
  2202. (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
  2203. (should
  2204. (string-match
  2205. "\\[2012-03-29 .* 16:40\\]"
  2206. (org-element-timestamp-interpreter
  2207. '(timestamp
  2208. (:type inactive :year-start 2012 :month-start 3 :day-start 29
  2209. :hour-start 16 :minute-start 40)) nil)))
  2210. ;; Active range.
  2211. (should
  2212. (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
  2213. (org-test-parse-and-interpret
  2214. "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
  2215. (should
  2216. (string-match
  2217. "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
  2218. (org-element-timestamp-interpreter
  2219. '(timestamp
  2220. (:type active-range :year-start 2012 :month-start 3 :day-start 29
  2221. :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
  2222. :day-end 29 :hour-end 16 :minute-end 41)) nil)))
  2223. ;; Inactive range.
  2224. (should
  2225. (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
  2226. (org-test-parse-and-interpret
  2227. "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
  2228. (should
  2229. (string-match
  2230. "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
  2231. (org-element-timestamp-interpreter
  2232. '(timestamp
  2233. (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
  2234. :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
  2235. :day-end 29 :hour-end 16 :minute-end 41)) nil)))
  2236. ;; Diary.
  2237. (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
  2238. "<%%diary-float t 4 2>\n"))
  2239. ;; Timestamp with repeater interval, with delay, with both.
  2240. (should
  2241. (string-match "<2012-03-29 .* \\+1y>"
  2242. (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
  2243. (should
  2244. (string-match
  2245. "<2012-03-29 .* \\+1y>"
  2246. (org-element-timestamp-interpreter
  2247. '(timestamp
  2248. (:type active :year-start 2012 :month-start 3 :day-start 29
  2249. :repeater-type cumulate :repeater-value 1 :repeater-unit year))
  2250. nil)))
  2251. (should
  2252. (string-match
  2253. "<2012-03-29 .* -1y>"
  2254. (org-element-timestamp-interpreter
  2255. '(timestamp
  2256. (:type active :year-start 2012 :month-start 3 :day-start 29
  2257. :warning-type all :warning-value 1 :warning-unit year))
  2258. nil)))
  2259. (should
  2260. (string-match
  2261. "<2012-03-29 .* \\+1y -1y>"
  2262. (org-element-timestamp-interpreter
  2263. '(timestamp
  2264. (:type active :year-start 2012 :month-start 3 :day-start 29
  2265. :warning-type all :warning-value 1 :warning-unit year
  2266. :repeater-type cumulate :repeater-value 1 :repeater-unit year))
  2267. nil)))
  2268. ;; Timestamp range with repeater interval
  2269. (should
  2270. (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
  2271. (org-test-parse-and-interpret
  2272. "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
  2273. (should
  2274. (string-match
  2275. "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
  2276. (org-element-timestamp-interpreter
  2277. '(timestamp
  2278. (:type active-range :year-start 2012 :month-start 3 :day-start 29
  2279. :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
  2280. :repeater-value 1 :repeater-unit year))
  2281. nil))))
  2282. (ert-deftest test-org-element/verse-block-interpreter ()
  2283. "Test verse block interpretation."
  2284. (should
  2285. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  2286. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  2287. (ert-deftest test-org-element/bold-interpreter ()
  2288. "Test bold interpreter."
  2289. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  2290. (ert-deftest test-org-element/code-interpreter ()
  2291. "Test code interpreter."
  2292. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  2293. (ert-deftest test-org-element/entity-interpreter ()
  2294. "Test entity interpreter."
  2295. ;; 1. Without brackets.
  2296. (should
  2297. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  2298. ;; 2. With brackets.
  2299. (should
  2300. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  2301. (ert-deftest test-org-element/export-snippet-interpreter ()
  2302. "Test export snippet interpreter."
  2303. (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
  2304. "@@back-end:contents@@\n")))
  2305. (ert-deftest test-org-element/footnote-reference-interpreter ()
  2306. "Test footnote reference interpreter."
  2307. ;; 1. Regular reference.
  2308. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  2309. ;; 2. Normalized reference.
  2310. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  2311. ;; 3. Named reference.
  2312. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  2313. "Text[fn:label]\n"))
  2314. ;; 4. Inline reference.
  2315. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  2316. "Text[fn:label:def]\n"))
  2317. ;; 5. Anonymous reference.
  2318. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  2319. "Text[fn::def]\n")))
  2320. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  2321. "Test inline babel call interpreter."
  2322. ;; 1. Without arguments.
  2323. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  2324. ;; 2. With arguments.
  2325. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  2326. "call_test(x=2)\n"))
  2327. ;; 3. With header arguments.
  2328. (should (equal (org-test-parse-and-interpret
  2329. "call_test[:results output]()[:results html]")
  2330. "call_test[:results output]()[:results html]\n")))
  2331. (ert-deftest test-org-element/inline-src-block-interpreter ()
  2332. "Test inline src block interpreter."
  2333. ;; 1. Without header argument.
  2334. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  2335. "src_emacs-lisp{(+ 1 1)}\n"))
  2336. ;; 2. With header arguments.
  2337. (should (equal (org-test-parse-and-interpret
  2338. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  2339. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  2340. (ert-deftest test-org-element/italic-interpreter ()
  2341. "Test italic interpreter."
  2342. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  2343. (ert-deftest test-org-element/latex-fragment-interpreter ()
  2344. "Test latex fragment interpreter."
  2345. (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
  2346. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  2347. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  2348. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  2349. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  2350. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
  2351. (ert-deftest test-org-element/line-break-interpreter ()
  2352. "Test line break interpreter."
  2353. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  2354. "First line \\\\\nSecond line\n")))
  2355. (ert-deftest test-org-element/link-interpreter ()
  2356. "Test link interpreter."
  2357. ;; 1. Links targeted from a radio target.
  2358. (should (equal (let ((org-target-link-regexp "radio-target"))
  2359. (org-test-parse-and-interpret "a radio-target"))
  2360. "a radio-target\n"))
  2361. ;; 2. Regular links.
  2362. ;;
  2363. ;; 2.1. Without description.
  2364. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  2365. "[[http://orgmode.org]]\n"))
  2366. ;; 2.2. With a description.
  2367. (should (equal (org-test-parse-and-interpret
  2368. "[[http://orgmode.org][Org mode]]")
  2369. "[[http://orgmode.org][Org mode]]\n"))
  2370. ;; 2.3. Id links.
  2371. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  2372. ;; 2.4. Custom-id links.
  2373. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  2374. ;; 2.5 Code-ref links.
  2375. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  2376. ;; 3. Normalize plain links.
  2377. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  2378. "[[http://orgmode.org]]\n"))
  2379. ;; 4. Normalize angular links.
  2380. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  2381. "[[http://orgmode.org]]\n")))
  2382. (ert-deftest test-org-element/macro-interpreter ()
  2383. "Test macro interpreter."
  2384. ;; 1. Without argument.
  2385. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  2386. ;; 2. With arguments.
  2387. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  2388. "{{{test(arg1,arg2)}}}\n")))
  2389. (ert-deftest test-org-element/radio-target-interpreter ()
  2390. "Test radio target interpreter."
  2391. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  2392. "<<<some text>>>\n")))
  2393. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  2394. "Test statistics cookie interpreter."
  2395. ;; 1. Without percent
  2396. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  2397. ;; 2. With percent.
  2398. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  2399. (ert-deftest test-org-element/strike-through-interpreter ()
  2400. "Test strike through interpreter."
  2401. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  2402. (ert-deftest test-org-element/subscript-interpreter ()
  2403. "Test subscript interpreter."
  2404. ;; 1. Without brackets.
  2405. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  2406. ;; 2. With brackets.
  2407. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  2408. (ert-deftest test-org-element/superscript-interpreter ()
  2409. "Test superscript interpreter."
  2410. ;; 1. Without brackets.
  2411. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  2412. ;; 2. With brackets.
  2413. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  2414. (ert-deftest test-org-element/target-interpreter ()
  2415. "Test target interpreter."
  2416. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  2417. (ert-deftest test-org-element/underline-interpreter ()
  2418. "Test underline interpreter."
  2419. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  2420. (ert-deftest test-org-element/verbatim-interpreter ()
  2421. "Test verbatim interpreter."
  2422. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  2423. ;;; Test Granularity
  2424. (ert-deftest test-org-element/granularity ()
  2425. "Test granularity impact on buffer parsing."
  2426. (org-test-with-temp-text "
  2427. * Head 1
  2428. ** Head 2
  2429. #+BEGIN_CENTER
  2430. Centered paragraph.
  2431. #+END_CENTER
  2432. Paragraph \\alpha."
  2433. ;; 1.1. Granularity set to `headline' should parse every headline
  2434. ;; in buffer, and only them.
  2435. (let ((tree (org-element-parse-buffer 'headline)))
  2436. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  2437. (should-not (org-element-map tree 'paragraph 'identity)))
  2438. ;; 1.2. Granularity set to `greater-element' should not enter
  2439. ;; greater elements excepted headlines and sections.
  2440. (let ((tree (org-element-parse-buffer 'greater-element)))
  2441. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  2442. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  2443. (should-not (org-element-map tree 'entity 'identity)))
  2444. ;; 1.3. Granularity set to `element' should enter every
  2445. ;; greater-element.
  2446. (let ((tree (org-element-parse-buffer 'element)))
  2447. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  2448. (should-not (org-element-map tree 'entity 'identity)))
  2449. ;; 1.4. Granularity set to `object' can see everything.
  2450. (let ((tree (org-element-parse-buffer 'object)))
  2451. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  2452. (ert-deftest test-org-element/secondary-string-parsing ()
  2453. "Test if granularity correctly toggles secondary strings parsing."
  2454. ;; 1. With a granularity bigger than `object', no secondary string
  2455. ;; should be parsed.
  2456. ;;
  2457. ;; 1.1. Test with `headline' type.
  2458. (org-test-with-temp-text "* Headline"
  2459. (let ((headline
  2460. (org-element-map (org-element-parse-buffer 'headline) 'headline
  2461. 'identity
  2462. nil
  2463. 'first-match)))
  2464. (should (stringp (org-element-property :title headline)))))
  2465. ;; 1.2. Test with `item' type.
  2466. (org-test-with-temp-text "* Headline\n- tag :: item"
  2467. (let ((item (org-element-map (org-element-parse-buffer 'element)
  2468. 'item
  2469. 'identity
  2470. nil
  2471. 'first-match)))
  2472. (should (stringp (org-element-property :tag item)))))
  2473. ;; 1.3. Test with `inlinetask' type, if avalaible.
  2474. (when (featurep 'org-inlinetask)
  2475. (let ((org-inlinetask-min-level 15))
  2476. (org-test-with-temp-text "*************** Inlinetask"
  2477. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  2478. 'inlinetask
  2479. 'identity
  2480. nil
  2481. 'first-match)))
  2482. (should (stringp (org-element-property :title inlinetask)))))))
  2483. ;; 2. With a default granularity, secondary strings should be
  2484. ;; parsed.
  2485. (org-test-with-temp-text "* Headline"
  2486. (let ((headline
  2487. (org-element-map (org-element-parse-buffer) 'headline
  2488. 'identity
  2489. nil
  2490. 'first-match)))
  2491. (should (listp (org-element-property :title headline)))))
  2492. ;; 3. `org-element-at-point' should never parse a secondary string.
  2493. (org-test-with-temp-text "* Headline"
  2494. (should (stringp (org-element-property :title (org-element-at-point))))))
  2495. ;;; Test Visible Only Parsing
  2496. (ert-deftest test-org-element/parse-buffer-visible ()
  2497. "Test `org-element-parse-buffer' with visible only argument."
  2498. (should
  2499. (equal '("H1" "H3" "H5")
  2500. (org-test-with-temp-text
  2501. "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
  2502. (org-occur ":visible:")
  2503. (org-element-map (org-element-parse-buffer nil t) 'headline
  2504. (lambda (hl) (org-element-property :raw-value hl)))))))
  2505. ;;; Test `:parent' Property
  2506. (ert-deftest test-org-element/parent-property ()
  2507. "Test `:parent' property."
  2508. ;; Elements.
  2509. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  2510. (let* ((tree (org-element-parse-buffer))
  2511. (parent (org-element-property
  2512. :parent
  2513. (org-element-map tree 'paragraph 'identity nil t))))
  2514. (should parent)
  2515. (should (eq (org-element-map tree 'center-block 'identity nil t)
  2516. parent))))
  2517. ;; Objects.
  2518. (org-test-with-temp-text "a_{/b/}"
  2519. (let* ((tree (org-element-parse-buffer))
  2520. (parent (org-element-property
  2521. :parent
  2522. (org-element-map tree 'italic 'identity nil t))))
  2523. (should parent)
  2524. (should (eq parent
  2525. (org-element-map tree 'subscript 'identity nil t)))))
  2526. ;; Secondary strings
  2527. (org-test-with-temp-text "* /italic/"
  2528. (let* ((tree (org-element-parse-buffer))
  2529. (parent (org-element-property
  2530. :parent (org-element-map tree 'italic 'identity nil t))))
  2531. (should parent)
  2532. (should (eq parent
  2533. (org-element-map tree 'headline 'identity nil t))))))
  2534. ;;; Test Normalize Contents
  2535. (ert-deftest test-org-element/normalize-contents ()
  2536. "Test `org-element-normalize-contents' specifications."
  2537. ;; 1. Remove maximum common indentation from element's contents.
  2538. (should
  2539. (equal
  2540. (org-element-normalize-contents
  2541. '(paragraph nil " Two spaces\n Three spaces"))
  2542. '(paragraph nil "Two spaces\n Three spaces")))
  2543. ;; 2. Ignore objects within contents when computing maximum common
  2544. ;; indentation.
  2545. (should
  2546. (equal
  2547. (org-element-normalize-contents
  2548. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  2549. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  2550. ;; 3. Ignore blank lines.
  2551. (should
  2552. (equal
  2553. (org-element-normalize-contents
  2554. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  2555. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  2556. ;; 4. Recursively enter objects in order to compute common
  2557. ;; indentation.
  2558. (should
  2559. (equal
  2560. (org-element-normalize-contents
  2561. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  2562. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  2563. ;; 5. When optional argument is provided, ignore first line
  2564. ;; indentation.
  2565. (should
  2566. (equal
  2567. (org-element-normalize-contents
  2568. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  2569. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  2570. ;;; Test Navigation Tools.
  2571. (ert-deftest test-org-element/at-point ()
  2572. "Test `org-element-at-point' specifications."
  2573. ;; Return closest element containing point.
  2574. (should
  2575. (eq 'paragraph
  2576. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2577. (progn (search-forward "A")
  2578. (org-element-type (org-element-at-point))))))
  2579. ;; Correctly set `:parent' property.
  2580. (should
  2581. (eq 'center-block
  2582. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2583. (progn (search-forward "A")
  2584. (org-element-type
  2585. (org-element-property :parent (org-element-at-point)))))))
  2586. ;; Special case: at a blank line just below a headline, return that
  2587. ;; headline.
  2588. (should
  2589. (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
  2590. (forward-line)
  2591. (org-element-property :title (org-element-at-point)))))
  2592. ;; Special case: at the very beginning of a table, return `table'
  2593. ;; object instead of `table-row'.
  2594. (should
  2595. (eq 'table
  2596. (org-test-with-temp-text "| a | b |"
  2597. (org-element-type (org-element-at-point)))))
  2598. ;; Special case: at the very beginning of a list or sub-list, return
  2599. ;; `plain-list' object instead of `item'.
  2600. (should
  2601. (eq 'plain-list
  2602. (org-test-with-temp-text "- item"
  2603. (org-element-type (org-element-at-point)))))
  2604. ;; Special case: at the closing line of a greater element, be sure
  2605. ;; to return it instead of the last element in its contents.
  2606. (should
  2607. (eq 'center-block
  2608. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
  2609. (progn (forward-line 2)
  2610. (org-element-type (org-element-at-point))))))
  2611. ;; Special case: at a blank line between two items, be sure to
  2612. ;; return item above instead of the last element of its contents.
  2613. (should
  2614. (eq 'item
  2615. (org-test-with-temp-text "- Para1\n\n- Para2"
  2616. (progn (forward-line)
  2617. (org-element-type
  2618. (let ((org-list-empty-line-terminates-plain-lists nil))
  2619. (org-element-at-point)))))))
  2620. ;; Special case: at the last blank line in a plain list, return it
  2621. ;; instead of the last item.
  2622. (should
  2623. (eq 'plain-list
  2624. (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
  2625. (progn (forward-line 2)
  2626. (org-element-type (org-element-at-point))))))
  2627. ;; Special case: when a list ends at the end of buffer and there's
  2628. ;; no final newline, return last element in last item.
  2629. (should
  2630. (eq 'paragraph
  2631. (org-test-with-temp-text "- a"
  2632. (end-of-line)
  2633. (org-element-type (org-element-at-point)))))
  2634. ;; Parse a list within a block itself contained in a list.
  2635. (should
  2636. (eq 'plain-list
  2637. (org-test-with-temp-text
  2638. "- outer\n #+begin_center\n - inner\n #+end_center"
  2639. (search-forward "inner")
  2640. (beginning-of-line)
  2641. (org-element-type (org-element-at-point)))))
  2642. ;; Do not error at eob on an empty line.
  2643. (should
  2644. (org-test-with-temp-text "* H\n"
  2645. (forward-line)
  2646. (or (org-element-at-point) t))))
  2647. (ert-deftest test-org-element/context ()
  2648. "Test `org-element-context' specifications."
  2649. ;; Return closest object containing point.
  2650. (should
  2651. (eq 'underline
  2652. (org-test-with-temp-text "Some *text with _underline_ text*"
  2653. (progn (search-forward "under")
  2654. (org-element-type (org-element-context))))))
  2655. ;; Find objects in secondary strings.
  2656. (should
  2657. (eq 'underline
  2658. (org-test-with-temp-text "* Headline _with_ underlining"
  2659. (progn (search-forward "w")
  2660. (org-element-type (org-element-context))))))
  2661. ;; Find objects in objects.
  2662. (should
  2663. (eq 'macro
  2664. (org-test-with-temp-text "| a | {{{macro}}} |"
  2665. (progn (search-forward "{")
  2666. (org-element-type (org-element-context))))))
  2667. (should
  2668. (eq 'table-cell
  2669. (org-test-with-temp-text "| a | b {{{macro}}} |"
  2670. (progn (search-forward "b")
  2671. (org-element-type (org-element-context))))))
  2672. ;; Find objects in document keywords.
  2673. (should
  2674. (eq 'macro
  2675. (org-test-with-temp-text "#+DATE: {{{macro}}}"
  2676. (progn (search-forward "{")
  2677. (org-element-type (org-element-context))))))
  2678. ;; Do not find objects in table rules.
  2679. (should
  2680. (eq 'table-row
  2681. (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
  2682. (forward-line)
  2683. (org-element-type (org-element-context)))))
  2684. ;; Find objects in parsed affiliated keywords.
  2685. (should
  2686. (eq 'macro
  2687. (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
  2688. (progn (search-forward "{")
  2689. (org-element-type (org-element-context))))))
  2690. (should
  2691. (eq 'bold
  2692. (org-test-with-temp-text "#+caption: *bold*\nParagraph"
  2693. (progn (search-forward "*")
  2694. (org-element-type (org-element-context))))))
  2695. ;; Correctly set `:parent' property.
  2696. (should
  2697. (eq 'paragraph
  2698. (org-test-with-temp-text "Some *bold* text"
  2699. (progn (search-forward "bold")
  2700. (org-element-type
  2701. (org-element-property :parent (org-element-context)))))))
  2702. ;; Between two objects, return the second one.
  2703. (should
  2704. (eq 'macro
  2705. (org-test-with-temp-text "<<target>>{{{test}}}"
  2706. (progn (search-forward "{")
  2707. (backward-char)
  2708. (org-element-type (org-element-context))))))
  2709. ;; Test optional argument.
  2710. (should
  2711. (eq 'underline
  2712. (org-test-with-temp-text "Some *text with _underline_ text*"
  2713. (progn
  2714. (search-forward "under")
  2715. (org-element-type (org-element-context (org-element-at-point))))))))
  2716. (provide 'test-org-element)
  2717. ;;; test-org-element.el ends here