test-org-element.el 84 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447
  1. ;;; test-org-element.el --- Tests for org-element.el
  2. ;; Copyright (C) 2012 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. (unless (featurep 'org-element)
  15. (signal 'missing-test-dependency "org-element"))
  16. (defun org-test-parse-and-interpret (text)
  17. "Parse TEXT as Org syntax and interpret it.
  18. Return interpreted string."
  19. (with-temp-buffer
  20. (org-mode)
  21. (insert text)
  22. (org-element-interpret-data (org-element-parse-buffer))))
  23. ;;; Test `org-element-map'
  24. (ert-deftest test-org-element/map ()
  25. "Test `org-element-map'."
  26. ;; Can map to `plain-text' objects.
  27. (should
  28. (= 2
  29. (org-test-with-temp-text "Some text \alpha
  30. #+BEGIN_CENTER
  31. Some other text
  32. #+END_CENTER"
  33. (let ((count 0))
  34. (org-element-map
  35. (org-element-parse-buffer) 'plain-text
  36. (lambda (s) (when (string-match "text" s) (incf count))))
  37. count))))
  38. ;; Applies to secondary strings
  39. (should
  40. (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
  41. ;; Enter secondary strings before entering contents.
  42. (should
  43. (equal
  44. "alpha"
  45. (org-element-property
  46. :name
  47. (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
  48. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t)))))
  49. ;; Apply NO-RECURSION argument.
  50. (should-not
  51. (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
  52. (org-element-map
  53. (org-element-parse-buffer) 'entity 'identity nil nil 'center-block))))
  54. ;;; Test Setters
  55. (ert-deftest test-org-element/put-property ()
  56. "Test `org-element-put-property' specifications."
  57. (org-test-with-temp-text "* Headline\n *a*"
  58. (let ((tree (org-element-parse-buffer)))
  59. (org-element-put-property
  60. (org-element-map tree 'bold 'identity nil t) :test 1)
  61. (should (org-element-property
  62. :test (org-element-map tree 'bold 'identity nil t))))))
  63. (ert-deftest test-org-element/set-contents ()
  64. "Test `org-element-set-contents' specifications."
  65. ;; Accept multiple entries.
  66. (should
  67. (equal '("b" (italic nil "a"))
  68. (org-test-with-temp-text "* Headline\n *a*"
  69. (let ((tree (org-element-parse-buffer)))
  70. (org-element-set-contents
  71. (org-element-map tree 'bold 'identity nil t) "b" '(italic nil "a"))
  72. (org-element-contents
  73. (org-element-map tree 'bold 'identity nil t))))))
  74. ;; Accept atoms and elements.
  75. (should
  76. (equal '("b")
  77. (org-test-with-temp-text "* Headline\n *a*"
  78. (let ((tree (org-element-parse-buffer)))
  79. (org-element-set-contents
  80. (org-element-map tree 'bold 'identity nil t) "b")
  81. (org-element-contents
  82. (org-element-map tree 'bold 'identity nil t))))))
  83. (should
  84. (equal '((italic nil "b"))
  85. (org-test-with-temp-text "* Headline\n *a*"
  86. (let ((tree (org-element-parse-buffer)))
  87. (org-element-set-contents
  88. (org-element-map tree 'bold 'identity nil t) '(italic nil "b"))
  89. (org-element-contents
  90. (org-element-map tree 'bold 'identity nil t))))))
  91. ;; Allow nil contents.
  92. (should-not
  93. (org-test-with-temp-text "* Headline\n *a*"
  94. (let ((tree (org-element-parse-buffer)))
  95. (org-element-set-contents (org-element-map tree 'bold 'identity nil t))
  96. (org-element-contents (org-element-map tree 'bold 'identity nil t))))))
  97. (ert-deftest test-org-element/set-element ()
  98. "Test `org-element-set-element' specifications."
  99. (org-test-with-temp-text "* Headline\n*a*"
  100. (let ((tree (org-element-parse-buffer)))
  101. (org-element-set-element
  102. (org-element-map tree 'bold 'identity nil t)
  103. '(italic nil "b"))
  104. ;; Check if object is correctly replaced.
  105. (should (org-element-map tree 'italic 'identity))
  106. (should-not (org-element-map tree 'bold 'identity))
  107. ;; Check if new object's parent is correctly set.
  108. (should
  109. (eq
  110. (org-element-property :parent
  111. (org-element-map tree 'italic 'identity nil t))
  112. (org-element-map tree 'paragraph 'identity nil t))))))
  113. (ert-deftest test-org-element/adopt-elements ()
  114. "Test `org-element-adopt-elements' specifications."
  115. ;; Adopt an element.
  116. (should
  117. (equal '(plain-text italic)
  118. (org-test-with-temp-text "* Headline\n *a*"
  119. (let ((tree (org-element-parse-buffer)))
  120. (org-element-adopt-elements
  121. (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
  122. (mapcar (lambda (blob) (org-element-type blob))
  123. (org-element-contents
  124. (org-element-map tree 'bold 'identity nil t)))))))
  125. ;; Adopt a string.
  126. (should
  127. (equal '("a" "b")
  128. (org-test-with-temp-text "* Headline\n *a*"
  129. (let ((tree (org-element-parse-buffer)))
  130. (org-element-adopt-elements
  131. (org-element-map tree 'bold 'identity nil t) "b")
  132. (org-element-contents
  133. (org-element-map tree 'bold 'identity nil t)))))))
  134. ;;; Test Parsers
  135. ;;;; Affiliated Keywords
  136. (ert-deftest test-org-element/affiliated-keywords-parser ()
  137. "Test affiliated keywords parsing."
  138. ;; Read simple keywords.
  139. (should
  140. (equal "para"
  141. (org-element-property
  142. :name
  143. (org-test-with-temp-text "#+NAME: para\nParagraph"
  144. (org-element-at-point)))))
  145. (should
  146. (= 1
  147. (org-element-property
  148. :begin
  149. (org-test-with-temp-text "#+NAME: para\nParagraph"
  150. (org-element-at-point)))))
  151. ;; Parse multiple keywords.
  152. (should
  153. (equal
  154. '("line2" "line1")
  155. (org-element-property
  156. :attr_ascii
  157. (org-test-with-temp-text
  158. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
  159. (org-element-at-point)))))
  160. ;; Parse "parsed" keywords.
  161. (should
  162. (equal
  163. '(("caption"))
  164. (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
  165. (car (org-element-property :caption (org-element-at-point))))))
  166. ;; Parse dual keywords.
  167. (should
  168. (equal
  169. '((("long") "short"))
  170. (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
  171. (org-element-property :caption (org-element-at-point)))))
  172. ;; Allow multiple caption keywords.
  173. (should
  174. (equal
  175. '((("l2") "s2") (("l1") "s1"))
  176. (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
  177. (org-element-property :caption (org-element-at-point))))))
  178. ;;;; Babel Call
  179. (ert-deftest test-org-element/babel-call-parser ()
  180. "Test `babel-call' parsing."
  181. ;; Standard test.
  182. (should
  183. (org-test-with-temp-text "#+CALL: test()"
  184. (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
  185. ;; Ignore case.
  186. (should
  187. (org-test-with-temp-text "#+call: test()"
  188. (org-element-map (org-element-parse-buffer) 'babel-call 'identity))))
  189. ;;;; Bold
  190. (ert-deftest test-org-element/bold-parser ()
  191. "Test `bold' parser."
  192. ;; Standard test.
  193. (should
  194. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  195. (org-test-with-temp-text "*bold*"
  196. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  197. ;; Multi-line markup.
  198. (should
  199. (equal
  200. (org-element-contents
  201. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  202. (org-test-with-temp-text "*first line\nsecond line*"
  203. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  204. '("first line\nsecond line"))))
  205. ;;;; Center Block
  206. (ert-deftest test-org-element/center-block-parser ()
  207. "Test `center-block' parser."
  208. ;; Standard test.
  209. (should
  210. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  211. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  212. ;; Ignore case.
  213. (should
  214. (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
  215. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  216. ;; Test folded block.
  217. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  218. (org-cycle)
  219. (should
  220. (org-element-property
  221. :hiddenp
  222. (org-element-map
  223. (org-element-parse-buffer) 'center-block 'identity nil t))))
  224. ;; Ignore incomplete block.
  225. (should-not
  226. (org-test-with-temp-text "#+BEGIN_CENTER"
  227. (org-element-map
  228. (org-element-parse-buffer) 'center-block 'identity nil t))))
  229. ;;;; Clock
  230. (ert-deftest test-org-element/clock-parser ()
  231. "Test `clock' parser."
  232. ;; Running clock.
  233. (let* ((org-clock-string "CLOCK:")
  234. (clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
  235. (org-element-map
  236. (org-element-parse-buffer) 'clock 'identity nil t))))
  237. (should (eq (org-element-property :status clock) 'running))
  238. (should (equal (org-element-property :value clock)
  239. "[2012-01-01 sun. 00:01]"))
  240. (should-not (org-element-property :time clock)))
  241. ;; Closed clock.
  242. (let* ((org-clock-string "CLOCK:")
  243. (clock (org-test-with-temp-text "
  244. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
  245. (org-element-map
  246. (org-element-parse-buffer) 'clock 'identity nil t))))
  247. (should (eq (org-element-property :status clock) 'closed))
  248. (should (equal (org-element-property :value clock)
  249. "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
  250. (should (equal (org-element-property :time clock) "0:01"))))
  251. ;;;; Code
  252. (ert-deftest test-org-element/code-parser ()
  253. "Test `code' parser."
  254. ;; Regular test.
  255. (should
  256. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  257. (org-test-with-temp-text "~code~"
  258. (org-element-map (org-element-parse-buffer) 'code 'identity))))
  259. ;; Multi-line markup.
  260. (should
  261. (equal
  262. (org-element-property
  263. :value
  264. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  265. (org-test-with-temp-text "~first line\nsecond line~"
  266. (org-element-map
  267. (org-element-parse-buffer) 'code 'identity nil t))))
  268. "first line\nsecond line")))
  269. ;;;; Comment
  270. (ert-deftest test-org-element/comment-parser ()
  271. "Test `comment' parser."
  272. ;; Regular comment.
  273. (should
  274. (org-test-with-temp-text "# Comment"
  275. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  276. ;; Inline comment.
  277. (should
  278. (org-test-with-temp-text " # Comment"
  279. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  280. ;; Preserve indentation.
  281. (should
  282. (equal
  283. (org-element-property
  284. :value
  285. (org-test-with-temp-text "# No blank\n# One blank"
  286. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  287. "No blank\n One blank"))
  288. ;; Comment with blank lines.
  289. (should
  290. (equal
  291. (org-element-property
  292. :value
  293. (org-test-with-temp-text "# First part\n# \n#\n# Second part"
  294. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  295. "First part\n\n\nSecond part"))
  296. ;; Do not mix comments and keywords.
  297. (should
  298. (eq 1
  299. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  300. (length (org-element-map
  301. (org-element-parse-buffer) 'comment 'identity)))))
  302. (should
  303. (equal "comment"
  304. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  305. (org-element-property
  306. :value
  307. (org-element-map
  308. (org-element-parse-buffer) 'comment 'identity nil t))))))
  309. ;;;; Comment Block
  310. (ert-deftest test-org-element/comment-block-parser ()
  311. "Test `comment-block' parser."
  312. ;; Standard test.
  313. (should
  314. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  315. (org-element-map
  316. (org-element-parse-buffer) 'comment-block 'identity)))
  317. ;; Ignore case.
  318. (should
  319. (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
  320. (org-element-map
  321. (org-element-parse-buffer) 'comment-block 'identity)))
  322. ;; Test folded block.
  323. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  324. (org-cycle)
  325. (should
  326. (org-element-property
  327. :hiddenp
  328. (org-element-map
  329. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  330. ;; Ignore incomplete block.
  331. (should-not
  332. (org-test-with-temp-text "#+BEGIN_COMMENT"
  333. (org-element-map
  334. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  335. ;;;; Drawer
  336. (ert-deftest test-org-element/drawer-parser ()
  337. "Test `drawer' parser."
  338. ;; Standard test.
  339. (should
  340. (let ((org-drawers '("TEST")))
  341. (org-test-with-temp-text ":TEST:\nText\n:END:"
  342. (org-element-map (org-element-parse-buffer) 'drawer 'identity))))
  343. ;; Do not mix regular drawers and property drawers.
  344. (should-not
  345. (let ((org-drawers '("PROPERTIES")))
  346. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  347. (org-element-map
  348. (org-element-parse-buffer) 'drawer 'identity nil t))))
  349. ;; Ignore incomplete drawer.
  350. (should-not
  351. (let ((org-drawers '("TEST")))
  352. (org-test-with-temp-text ":TEST:"
  353. (org-element-map
  354. (org-element-parse-buffer) 'drawer 'identity nil t)))))
  355. ;;;; Dynamic Block
  356. (ert-deftest test-org-element/dynamic-block-parser ()
  357. "Test `dynamic-block' parser."
  358. ;; Standard test.
  359. (should
  360. (org-test-with-temp-text
  361. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  362. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  363. ;; Folded view
  364. (org-test-with-temp-text
  365. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  366. (org-cycle)
  367. (should
  368. (org-element-property
  369. :hiddenp
  370. (org-element-map
  371. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  372. ;; Ignore case.
  373. (should
  374. (org-test-with-temp-text
  375. "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
  376. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  377. ;; Ignore incomplete block.
  378. (should-not
  379. (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
  380. (org-element-map
  381. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  382. ;;;; Entity
  383. (ert-deftest test-org-element/entity-parser ()
  384. "Test `entity' parser."
  385. ;; Without brackets.
  386. (should
  387. (org-test-with-temp-text "\\sin"
  388. (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  389. ;; With brackets.
  390. (should
  391. (org-element-property
  392. :use-brackets-p
  393. (org-test-with-temp-text "\\alpha{}text"
  394. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  395. ;; User-defined entity.
  396. (should
  397. (equal
  398. (org-element-property
  399. :name
  400. (let ((org-entities-user
  401. '(("test" "test" nil "test" "test" "test" "test"))))
  402. (org-test-with-temp-text "\\test"
  403. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  404. "test")))
  405. ;;;; Example Block
  406. (ert-deftest test-org-element/example-block-parser ()
  407. "Test `example-block' parser."
  408. ;; Standard test.
  409. (should
  410. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  411. (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
  412. ;; Test folded block.
  413. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  414. (org-cycle)
  415. (should
  416. (org-element-property
  417. :hiddenp
  418. (org-element-map
  419. (org-element-parse-buffer) 'example-block 'identity nil t))))
  420. ;; Ignore incomplete block.
  421. (should-not
  422. (org-test-with-temp-text "#+BEGIN_EXAMPLE"
  423. (org-element-map
  424. (org-element-parse-buffer) 'example-block 'identity nil t))))
  425. (ert-deftest test-org-element/block-switches ()
  426. "Test `example-block' and `src-block' switches parsing."
  427. (let ((org-coderef-label-format "(ref:%s)"))
  428. ;; 1. Test "-i" switch.
  429. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  430. (should-not
  431. (org-element-property :preserve-indent (org-element-at-point))))
  432. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  433. (should (org-element-property :preserve-indent (org-element-at-point))))
  434. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  435. (should-not
  436. (org-element-property :preserve-indent (org-element-at-point))))
  437. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  438. (should (org-element-property :preserve-indent (org-element-at-point))))
  439. ;; 2. "-n -r -k" combination should number lines, retain labels but
  440. ;; not use them in coderefs.
  441. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  442. (let ((element (org-element-at-point)))
  443. (should (and (org-element-property :number-lines element)
  444. (org-element-property :retain-labels element)
  445. (not (org-element-property :use-labels element))))))
  446. (org-test-with-temp-text
  447. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  448. (let ((element (org-element-at-point)))
  449. (should (and (org-element-property :number-lines element)
  450. (org-element-property :retain-labels element)
  451. (not (org-element-property :use-labels element))))))
  452. ;; 3. "-n -r" combination should number-lines remove labels and not
  453. ;; use them in coderefs.
  454. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  455. (let ((element (org-element-at-point)))
  456. (should (and (org-element-property :number-lines element)
  457. (not (org-element-property :retain-labels element))
  458. (not (org-element-property :use-labels element))))))
  459. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  460. (let ((element (org-element-at-point)))
  461. (should (and (org-element-property :number-lines element)
  462. (not (org-element-property :retain-labels element))
  463. (not (org-element-property :use-labels element))))))
  464. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  465. ;; in coderefs.
  466. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  467. (let ((element (org-element-at-point)))
  468. (should (and (org-element-property :number-lines element)
  469. (org-element-property :retain-labels element)
  470. (org-element-property :use-labels element)))))
  471. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  472. (let ((element (org-element-at-point)))
  473. (should (and (org-element-property :number-lines element)
  474. (org-element-property :retain-labels element)
  475. (org-element-property :use-labels element)))))
  476. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  477. (let ((element (org-element-at-point)))
  478. (should (and (org-element-property :number-lines element)
  479. (org-element-property :retain-labels element)
  480. (org-element-property :use-labels element)))))
  481. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  482. (let ((element (org-element-at-point)))
  483. (should (and (org-element-property :number-lines element)
  484. (org-element-property :retain-labels element)
  485. (org-element-property :use-labels element)))))
  486. ;; 5. No switch should not number lines, but retain labels and use
  487. ;; them in coderefs.
  488. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  489. (let ((element (org-element-at-point)))
  490. (should (and (not (org-element-property :number-lines element))
  491. (org-element-property :retain-labels element)
  492. (org-element-property :use-labels element)))))
  493. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  494. (let ((element (org-element-at-point)))
  495. (should (and (not (org-element-property :number-lines element))
  496. (org-element-property :retain-labels element)
  497. (org-element-property :use-labels element)))))
  498. ;; 6. "-r" switch only: do not number lines, remove labels, and
  499. ;; don't use labels in coderefs.
  500. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  501. (let ((element (org-element-at-point)))
  502. (should (and (not (org-element-property :number-lines element))
  503. (not (org-element-property :retain-labels element))
  504. (not (org-element-property :use-labels element))))))
  505. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  506. (let ((element (org-element-at-point)))
  507. (should (and (not (org-element-property :number-lines element))
  508. (not (org-element-property :retain-labels element))
  509. (not (org-element-property :use-labels element))))))
  510. ;; 7. Recognize coderefs with user-defined syntax.
  511. (org-test-with-temp-text
  512. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  513. (let ((element (org-element-at-point)))
  514. (should
  515. (equal (org-element-property :label-fmt element) "[ref:%s]"))))
  516. (org-test-with-temp-text
  517. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  518. (let ((element (org-element-at-point)))
  519. (should
  520. (equal (org-element-property :label-fmt element) "[ref:%s]"))))))
  521. ;;;; Export Block
  522. (ert-deftest test-org-element/export-block-parser ()
  523. "Test `export-block' parser."
  524. ;; Standard test.
  525. (should
  526. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  527. (org-element-map
  528. (let ((org-element-block-name-alist
  529. '(("LATEX" . org-element-export-block-parser))))
  530. (org-element-parse-buffer))
  531. 'export-block 'identity)))
  532. ;; Test folded block.
  533. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  534. (org-cycle)
  535. (should
  536. (org-element-property
  537. :hiddenp
  538. (org-element-map
  539. (let ((org-element-block-name-alist
  540. '(("LATEX" . org-element-export-block-parser))))
  541. (org-element-parse-buffer))
  542. 'export-block 'identity nil t))))
  543. ;; Ignore case.
  544. (should
  545. (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
  546. (org-element-map
  547. (let ((org-element-block-name-alist
  548. '(("LATEX" . org-element-export-block-parser))))
  549. (org-element-parse-buffer))
  550. 'export-block 'identity)))
  551. ;; Ignore incomplete block.
  552. (should-not
  553. (org-test-with-temp-text "#+BEGIN_LATEX"
  554. (org-element-map
  555. (let ((org-element-block-name-alist
  556. '(("LATEX" . org-element-export-block-parser))))
  557. (org-element-parse-buffer))
  558. 'export-block 'identity nil t))))
  559. ;;;; Export Snippet
  560. (ert-deftest test-org-element/export-snippet-parser ()
  561. "Test `export-snippet' parser."
  562. (should
  563. (equal
  564. '("back-end" . "contents")
  565. (org-test-with-temp-text "@@back-end:contents@@"
  566. (org-element-map
  567. (org-element-parse-buffer) 'export-snippet
  568. (lambda (snippet) (cons (org-element-property :back-end snippet)
  569. (org-element-property :value snippet)))
  570. nil t)))))
  571. ;;;; Fixed Width
  572. (ert-deftest test-org-element/fixed-width ()
  573. "Test fixed-width area parsing."
  574. ;; Preserve indentation.
  575. (should
  576. (org-test-with-temp-text ": no blank\n: one blank"
  577. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  578. ;; Fixed-width with empty lines.
  579. (should
  580. (org-test-with-temp-text ": first part\n:\n: \n: second part"
  581. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  582. ;; Parse indented fixed-width markers.
  583. (should
  584. (org-test-with-temp-text "Text\n : no blank\n : one blank"
  585. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  586. ;; Distinguish fixed-width areas within a list and outside of it.
  587. (should
  588. (= 2
  589. (length
  590. (org-test-with-temp-text "
  591. - Item
  592. : fixed-width inside
  593. : fixed-width outside"
  594. (org-element-map
  595. (org-element-parse-buffer) 'fixed-width 'identity))))))
  596. ;;;; Footnote Definition
  597. (ert-deftest test-org-element/footnote-definition-parser ()
  598. "Test `footnote-definition' parser."
  599. (should
  600. (org-test-with-temp-text "[fn:1] Definition"
  601. (org-element-map
  602. (org-element-parse-buffer) 'footnote-definition 'identity nil t)))
  603. ;; Footnote with more contents
  604. (should
  605. (= 28
  606. (org-element-property
  607. :end
  608. (org-test-with-temp-text "[fn:1] Definition\n| a | b |"
  609. (org-element-map
  610. (org-element-parse-buffer)
  611. 'footnote-definition 'identity nil t)))))
  612. ;; Footnote starting with special syntax.
  613. (should-not
  614. (org-test-with-temp-text "[fn:1] - no item"
  615. (org-element-map (org-element-parse-buffer) 'item 'identity))))
  616. ;;;; Footnotes Reference.
  617. (ert-deftest test-org-element/footnote-reference-parser ()
  618. "Test `footnote-reference' parser."
  619. ;; 1. Parse a standard reference.
  620. (org-test-with-temp-text "Text[fn:label]"
  621. (should
  622. (org-element-map
  623. (org-element-parse-buffer) 'footnote-reference 'identity)))
  624. ;; 2. Parse a normalized reference.
  625. (org-test-with-temp-text "Text[1]"
  626. (should
  627. (org-element-map
  628. (org-element-parse-buffer) 'footnote-reference 'identity)))
  629. ;; 3. Parse an inline reference.
  630. (org-test-with-temp-text "Text[fn:test:def]"
  631. (should
  632. (org-element-map
  633. (org-element-parse-buffer) 'footnote-reference 'identity)))
  634. ;; 4. Parse an anonymous reference.
  635. (org-test-with-temp-text "Text[fn::def]"
  636. (should
  637. (org-element-map
  638. (org-element-parse-buffer) 'footnote-reference 'identity)))
  639. ;; 5. Parse nested footnotes.
  640. (org-test-with-temp-text "Text[fn::def [fn:label]]"
  641. (should
  642. (= 2
  643. (length
  644. (org-element-map
  645. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  646. ;; 6. Parse adjacent footnotes.
  647. (org-test-with-temp-text "Text[fn:label1][fn:label2]"
  648. (should
  649. (= 2
  650. (length
  651. (org-element-map
  652. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  653. ;; 7. Only properly closed footnotes are recognized as such.
  654. (org-test-with-temp-text "Text[fn:label"
  655. (should-not
  656. (org-element-map
  657. (org-element-parse-buffer) 'footnote-reference 'identity))))
  658. ;;;; Headline
  659. (ert-deftest test-org-element/headline-quote-keyword ()
  660. "Test QUOTE keyword recognition."
  661. ;; Reference test.
  662. (org-test-with-temp-text "* Headline"
  663. (let ((org-quote-string "QUOTE"))
  664. (should-not (org-element-property :quotedp (org-element-at-point)))))
  665. ;; Standard position.
  666. (org-test-with-temp-text "* QUOTE Headline"
  667. (let ((org-quote-string "QUOTE"))
  668. (let ((headline (org-element-at-point)))
  669. (should (org-element-property :quotedp headline))
  670. ;; Test removal from raw value.
  671. (should (equal (org-element-property :raw-value headline) "Headline"))))
  672. ;; Case sensitivity.
  673. (let ((org-quote-string "Quote"))
  674. (should-not (org-element-property :quotedp (org-element-at-point)))))
  675. ;; With another keyword.
  676. (org-test-with-temp-text "* TODO QUOTE Headline"
  677. (let ((org-quote-string "QUOTE")
  678. (org-todo-keywords '((sequence "TODO" "DONE"))))
  679. (should (org-element-property :quotedp (org-element-at-point))))))
  680. (ert-deftest test-org-element/headline-comment-keyword ()
  681. "Test COMMENT keyword recognition."
  682. ;; Reference test.
  683. (org-test-with-temp-text "* Headline"
  684. (let ((org-comment-string "COMMENT"))
  685. (should-not (org-element-property :commentedp (org-element-at-point)))))
  686. ;; Standard position.
  687. (org-test-with-temp-text "* COMMENT Headline"
  688. (let ((org-comment-string "COMMENT"))
  689. (let ((headline (org-element-at-point)))
  690. (should (org-element-property :commentedp headline))
  691. ;; Test removal from raw value.
  692. (should (equal (org-element-property :raw-value headline) "Headline"))))
  693. ;; Case sensitivity.
  694. (let ((org-comment-string "Comment"))
  695. (should-not (org-element-property :commentedp (org-element-at-point)))))
  696. ;; With another keyword.
  697. (org-test-with-temp-text "* TODO COMMENT Headline"
  698. (let ((org-comment-string "COMMENT")
  699. (org-todo-keywords '((sequence "TODO" "DONE"))))
  700. (should (org-element-property :commentedp (org-element-at-point))))))
  701. (ert-deftest test-org-element/headline-archive-tag ()
  702. "Test ARCHIVE tag recognition."
  703. ;; Reference test.
  704. (org-test-with-temp-text "* Headline"
  705. (let ((org-archive-tag "ARCHIVE"))
  706. (should-not (org-element-property :archivedp (org-element-at-point)))))
  707. ;; Single tag.
  708. (org-test-with-temp-text "* Headline :ARCHIVE:"
  709. (let ((org-archive-tag "ARCHIVE"))
  710. (let ((headline (org-element-at-point)))
  711. (should (org-element-property :archivedp headline))
  712. ;; Test tag removal.
  713. (should-not (org-element-property :tags headline))))
  714. (let ((org-archive-tag "Archive"))
  715. (should-not (org-element-property :archivedp (org-element-at-point)))))
  716. ;; Multiple tags.
  717. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  718. (let ((org-archive-tag "ARCHIVE"))
  719. (let ((headline (org-element-at-point)))
  720. (should (org-element-property :archivedp headline))
  721. ;; Test tag removal.
  722. (should (equal (org-element-property :tags headline) '("test")))))))
  723. ;;;; Horizontal Rule
  724. (ert-deftest test-org-element/horizontal-rule-parser ()
  725. "Test `horizontal-rule' parser."
  726. ;; Standard.
  727. (should
  728. (org-test-with-temp-text "-----"
  729. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  730. ;; Indented.
  731. (should
  732. (org-test-with-temp-text " -----"
  733. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  734. ;; Hyphen must be alone on the line.
  735. (should-not
  736. (org-test-with-temp-text "-----wrong"
  737. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  738. ;; 4 hyphens is too small.
  739. (should-not
  740. (org-test-with-temp-text "----"
  741. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity))))
  742. ;;;; Inline Babel Call
  743. (ert-deftest test-org-element/inline-babel-call-parser ()
  744. "Test `inline-babel-call' parser."
  745. (should
  746. (org-test-with-temp-text "call_test()"
  747. (org-element-map
  748. (org-element-parse-buffer) 'inline-babel-call 'identity))))
  749. ;;;; Inline Src Block
  750. (ert-deftest test-org-element/inline-src-block-parser ()
  751. "Test `inline-src-block' parser."
  752. (should
  753. (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
  754. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
  755. ;; Test parsing at the beginning of an item.
  756. (should
  757. (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
  758. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
  759. ;;;; Inlinetask
  760. (ert-deftest test-org-element/inlinetask-parser ()
  761. "Test `inlinetask' parser."
  762. (when (featurep 'org-inlinetask)
  763. (let ((org-inlinetask-min-level 15))
  764. ;; 1. Regular inlinetask.
  765. (should
  766. (org-test-with-temp-text
  767. "*************** Task\nTest\n*************** END"
  768. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  769. ;; 2. Degenerate inlinetask.
  770. (should
  771. (org-test-with-temp-text "*************** Task"
  772. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  773. ;; TODO keyword.
  774. (should
  775. (equal
  776. "TODO"
  777. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  778. (org-test-with-temp-text "*************** TODO Task"
  779. (org-element-property
  780. :todo-keyword
  781. (org-element-map
  782. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))
  783. ;; Planning info.
  784. (should
  785. (equal
  786. "2012-03-29 thu."
  787. (org-test-with-temp-text "
  788. *************** Task
  789. DEADLINE: <2012-03-29 thu.>"
  790. (org-element-property
  791. :deadline
  792. (org-element-map
  793. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  794. ;; Priority.
  795. (should
  796. (equal
  797. ?A
  798. (org-test-with-temp-text "
  799. *************** [#A] Task"
  800. (org-element-property
  801. :priority
  802. (org-element-map
  803. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  804. ;; Tags.
  805. (should
  806. (equal
  807. '("test")
  808. (org-test-with-temp-text "
  809. *************** Task :test:"
  810. (org-element-property
  811. :tags
  812. (org-element-map
  813. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))))
  814. ;;;; Italic
  815. (ert-deftest test-org-element/italic-parser ()
  816. "Test `italic' parser."
  817. ;; Regular test.
  818. (should
  819. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  820. (org-test-with-temp-text "/italic/"
  821. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  822. ;; Multi-line markup.
  823. (should
  824. (equal
  825. (org-element-contents
  826. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  827. (org-test-with-temp-text "/first line\nsecond line/"
  828. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  829. '("first line\nsecond line"))))
  830. ;;;; Item
  831. (ert-deftest test-org-element/item-parser ()
  832. "Test `item' parser."
  833. ;; Standard test.
  834. (should
  835. (org-test-with-temp-text "- item"
  836. (org-element-map (org-element-parse-buffer) 'item 'identity)))
  837. ;; Counter.
  838. (should
  839. (= 6
  840. (org-element-property
  841. :counter
  842. (org-test-with-temp-text "6. [@6] item"
  843. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  844. ;; Tag
  845. (should
  846. (equal
  847. '("tag")
  848. (org-element-property
  849. :tag
  850. (org-test-with-temp-text "- tag :: description"
  851. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  852. ;; No tags in ordered lists.
  853. (should-not
  854. (org-element-property
  855. :tag
  856. (org-test-with-temp-text "1. tag :: description"
  857. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  858. ;; Check-boxes
  859. (should
  860. (equal
  861. '(trans on off)
  862. (org-test-with-temp-text "
  863. - [-] item 1
  864. - [X] item 1.1
  865. - [ ] item 1.2"
  866. (org-element-map
  867. (org-element-parse-buffer) 'item
  868. (lambda (item) (org-element-property :checkbox item))))))
  869. ;; Folded state.
  870. (org-test-with-temp-text "* Headline
  871. - item
  872. paragraph below"
  873. (forward-line)
  874. (let ((org-cycle-include-plain-lists t)) (org-cycle))
  875. (should
  876. (org-element-property
  877. :hiddenp
  878. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  879. ;; Item starting with special syntax.
  880. (should
  881. (equal '(("- item"))
  882. (org-test-with-temp-text "- - item"
  883. (org-element-map
  884. (org-element-parse-buffer) 'paragraph 'org-element-contents)))))
  885. ;;;; Keyword
  886. (ert-deftest test-org-element/keyword-parser ()
  887. "Test `keyword' parser."
  888. ;; Standard test.
  889. (should
  890. (org-test-with-temp-text "#+KEYWORD: value"
  891. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  892. ;; Keywords are case-insensitive.
  893. (should
  894. (org-test-with-temp-text "#+keyword: value"
  895. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  896. ;; Affiliated keywords are not keywords.
  897. (should-not
  898. (org-test-with-temp-text "#+NAME: value
  899. Paragraph"
  900. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  901. ;; Do not mix keywords with Babel calls and dynamic blocks.
  902. (should-not
  903. (org-test-with-temp-text "#+CALL: fun()"
  904. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  905. (should-not
  906. (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
  907. (org-element-map (org-element-parse-buffer) 'keyword 'identity))))
  908. ;;;; Latex Environment
  909. (ert-deftest test-org-element/latex-environment-parser ()
  910. "Test `latex-environment' parser."
  911. (should
  912. (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
  913. (org-element-map
  914. (org-element-parse-buffer) 'latex-environment 'identity)))
  915. ;; Allow nested environments.
  916. (should
  917. (equal
  918. "\\begin{outer}
  919. \\begin{inner}
  920. e^{i\\pi}+1=0
  921. \\end{inner}
  922. \\end{outer}"
  923. (org-test-with-temp-text "
  924. \\begin{outer}
  925. \\begin{inner}
  926. e^{i\\pi}+1=0
  927. \\end{inner}
  928. \\end{outer}"
  929. (org-element-property
  930. :value
  931. (org-element-map
  932. (org-element-parse-buffer) 'latex-environment 'identity nil t))))))
  933. ;;;; Latex Fragment
  934. (ert-deftest test-org-element/latex-fragment-parser ()
  935. "Test `latex-fragment' parser."
  936. (let ((org-latex-regexps
  937. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  938. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  939. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  940. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  941. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  942. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  943. (should
  944. (org-test-with-temp-text "$a$"
  945. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  946. (should
  947. (org-test-with-temp-text "$$a$$"
  948. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  949. (should
  950. (org-test-with-temp-text "\\(a\\)"
  951. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  952. (should
  953. (org-test-with-temp-text "\\[a\\]"
  954. (org-element-map
  955. (org-element-parse-buffer) 'latex-fragment 'identity)))))
  956. ;;;; Line Break
  957. (ert-deftest test-org-element/line-break-parser ()
  958. "Test `line-break' parser."
  959. ;; Regular test.
  960. (should
  961. (org-test-with-temp-text "Text \\\\"
  962. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  963. ;; Line break with trailing white spaces.
  964. (should
  965. (org-test-with-temp-text "Text \\\\ "
  966. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  967. ;; Three backslashes are too much.
  968. (should-not
  969. (org-test-with-temp-text "Text \\\\\\"
  970. (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
  971. ;;;; Link
  972. (ert-deftest test-org-element/link-parser ()
  973. "Test `link' parser."
  974. ;; 1. Radio target.
  975. (should
  976. (equal
  977. "radio"
  978. (org-test-with-temp-text "A radio link"
  979. (org-element-property
  980. :type
  981. (org-element-map
  982. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  983. 'link 'identity nil t)))))
  984. ;; 2. Standard link.
  985. ;;
  986. ;; 2.1. With description.
  987. (should
  988. (equal
  989. '("Orgmode.org")
  990. (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  991. (org-element-contents
  992. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  993. ;; 2.2. Without description.
  994. (should
  995. (equal
  996. "http"
  997. (org-test-with-temp-text "[[http://orgmode.org]]"
  998. (org-element-property
  999. :type
  1000. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1001. ;; 2.3. With expansion.
  1002. (should
  1003. (equal
  1004. "//orgmode.org/worg"
  1005. (org-test-with-temp-text "[[Org:worg]]"
  1006. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  1007. (org-element-property
  1008. :path
  1009. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
  1010. ;; 2.4. With translation.
  1011. (should
  1012. (equal
  1013. "127.0.0.1"
  1014. (org-test-with-temp-text "[[http://orgmode.org]]"
  1015. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  1016. (let ((org-link-translation-function 'link-translate))
  1017. (org-element-property
  1018. :path
  1019. (org-element-map
  1020. (org-element-parse-buffer) 'link 'identity nil t)))))))
  1021. ;; 2.5. Id link.
  1022. (should
  1023. (equal
  1024. "id"
  1025. (org-test-with-temp-text "[[id:aaaa]]"
  1026. (org-element-property
  1027. :type
  1028. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1029. ;; 2.6. Custom-id link.
  1030. (should
  1031. (equal
  1032. "custom-id"
  1033. (org-test-with-temp-text "[[#some-id]]"
  1034. (org-element-property
  1035. :type
  1036. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1037. ;; 2.7 Coderef link.
  1038. (should
  1039. (equal
  1040. "coderef"
  1041. (org-test-with-temp-text "[[(reference)]]"
  1042. (org-element-property
  1043. :type
  1044. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1045. ;; 2.8 Fuzzy link.
  1046. (should
  1047. (equal
  1048. "fuzzy"
  1049. (org-test-with-temp-text "[[target-or-title]]"
  1050. (org-element-property
  1051. :type
  1052. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1053. ;; 2.9 File-type link with search option.
  1054. (should
  1055. (equal
  1056. '(("file" "projects.org" "*task title"))
  1057. (org-test-with-temp-text "[[file:projects.org::*task title]]"
  1058. (org-element-map
  1059. (org-element-parse-buffer) 'link
  1060. (lambda (l) (list (org-element-property :type l)
  1061. (org-element-property :path l)
  1062. (org-element-property :search-option l)))))))
  1063. ;; 2.10 File-type link with application.
  1064. (should
  1065. (equal
  1066. '(("file" "projects.org" "docview"))
  1067. (org-test-with-temp-text "[[docview:projects.org]]"
  1068. (org-element-map
  1069. (org-element-parse-buffer) 'link
  1070. (lambda (l) (list (org-element-property :type l)
  1071. (org-element-property :path l)
  1072. (org-element-property :application l)))))))
  1073. ;; 3. Plain link.
  1074. (should
  1075. (org-test-with-temp-text "A link: http://orgmode.org"
  1076. (org-element-map (org-element-parse-buffer) 'link 'identity)))
  1077. ;; 4. Angular link.
  1078. (should
  1079. (org-test-with-temp-text "A link: <http://orgmode.org>"
  1080. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))
  1081. ;;;; Macro
  1082. (ert-deftest test-org-element/macro-parser ()
  1083. "Test `macro' parser."
  1084. ;; Without arguments.
  1085. (should
  1086. (org-test-with-temp-text "{{{macro}}}"
  1087. (org-element-map (org-element-parse-buffer) 'macro 'identity)))
  1088. ;; With arguments.
  1089. (should
  1090. (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
  1091. (org-element-map (org-element-parse-buffer) 'macro 'identity))))
  1092. ;;;; Paragraph
  1093. (ert-deftest test-org-element/paragraph-parser ()
  1094. "Test `paragraph' parser."
  1095. ;; Standard test.
  1096. (should
  1097. (org-test-with-temp-text "Paragraph"
  1098. (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
  1099. ;; Property find end of a paragraph stuck to another element.
  1100. (should
  1101. (eq ?#
  1102. (org-test-with-temp-text "Paragraph\n# Comment"
  1103. (org-element-map
  1104. (org-element-parse-buffer) 'paragraph
  1105. (lambda (p) (char-after (org-element-property :end p)))
  1106. nil t))))
  1107. ;; Include ill-formed Keywords.
  1108. (should
  1109. (org-test-with-temp-text "#+wrong_keyword something"
  1110. (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
  1111. ;; Include incomplete-drawers.
  1112. (should
  1113. (let ((org-drawers '("TEST")))
  1114. (org-test-with-temp-text ":TEST:\nParagraph"
  1115. (let ((elem (org-element-at-point)))
  1116. (and (eq (org-element-type elem) 'paragraph)
  1117. (= (point-max) (org-element-property :end elem)))))))
  1118. ;; Include non-existent drawers.
  1119. (should
  1120. (let ((org-drawers '("TEST")))
  1121. (org-test-with-temp-text ":NONAME:"
  1122. (org-element-map (org-element-parse-buffer) 'paragraph 'identity))))
  1123. ;; Include incomplete blocks.
  1124. (should
  1125. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
  1126. (let ((elem (org-element-at-point)))
  1127. (and (eq (org-element-type elem) 'paragraph)
  1128. (= (point-max) (org-element-property :end elem))))))
  1129. ;; Include incomplete dynamic blocks.
  1130. (should
  1131. (org-test-with-temp-text "#+BEGIN: \nParagraph"
  1132. (let ((elem (org-element-at-point)))
  1133. (and (eq (org-element-type elem) 'paragraph)
  1134. (= (point-max) (org-element-property :end elem))))))
  1135. ;; Include incomplete latex environments.
  1136. (should
  1137. (org-test-with-temp-text "\begin{equation}\nParagraph"
  1138. (let ((elem (org-element-at-point)))
  1139. (and (eq (org-element-type elem) 'paragraph)
  1140. (= (point-max) (org-element-property :end elem))))))
  1141. ;; Do not steal affiliated keywords from container.
  1142. (should
  1143. (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
  1144. (let ((elem (progn (search-forward "item") (org-element-at-point))))
  1145. (and (eq (org-element-type elem) 'paragraph)
  1146. (not (org-element-property :attr_latex elem))
  1147. (/= (org-element-property :begin elem) 1))))))
  1148. ;;;; Plain List
  1149. (ert-deftest test-org-element/plain-list-parser ()
  1150. "Test `plain-list' parser."
  1151. (should
  1152. (org-test-with-temp-text "- item"
  1153. (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
  1154. ;; Blank lines after the list only belong to outer plain list.
  1155. (org-test-with-temp-text "
  1156. - outer
  1157. - inner
  1158. Outside list"
  1159. (let ((endings (org-element-map
  1160. (org-element-parse-buffer) 'plain-list
  1161. (lambda (pl) (org-element-property :end pl)))))
  1162. ;; Move to ending of outer list.
  1163. (goto-char (car endings))
  1164. (should (looking-at "Outside list"))
  1165. ;; Move to ending of inner list.
  1166. (goto-char (nth 1 endings))
  1167. (should (looking-at "^$")))))
  1168. ;;;; Planning
  1169. (ert-deftest test-org-element/planning-parser ()
  1170. "Test `planning' parser."
  1171. (should
  1172. (equal
  1173. (org-element-property
  1174. :closed
  1175. (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
  1176. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1177. "2012-03-29 thu."))
  1178. (should
  1179. (equal
  1180. (org-element-property
  1181. :deadline
  1182. (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
  1183. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1184. "2012-03-29 thu."))
  1185. (should
  1186. (equal
  1187. (org-element-property
  1188. :scheduled
  1189. (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
  1190. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1191. "2012-03-29 thu.")))
  1192. ;;;; Property Drawer
  1193. (ert-deftest test-org-element/property-drawer ()
  1194. "Test `property-drawer' parser."
  1195. ;; Standard test.
  1196. (should
  1197. (let ((org-drawers '("PROPERTIES")))
  1198. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  1199. (org-element-map
  1200. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1201. ;; Do not mix property drawers and regular drawers.
  1202. (should-not
  1203. (let ((org-drawers '("TEST")))
  1204. (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
  1205. (org-element-map
  1206. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1207. ;; Ignore incomplete drawer.
  1208. (should-not
  1209. (let ((org-drawers '("PROPERTIES")))
  1210. (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
  1211. (org-element-map
  1212. (org-element-parse-buffer) 'property-drawer 'identity nil t)))))
  1213. ;;;; Quote Block
  1214. (ert-deftest test-org-element/quote-block-parser ()
  1215. "Test `quote-block' parser."
  1216. ;; Regular test.
  1217. (should
  1218. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1219. (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
  1220. ;; Test folded block.
  1221. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1222. (org-cycle)
  1223. (should
  1224. (org-element-property
  1225. :hiddenp
  1226. (org-element-map
  1227. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1228. ;; Ignore incomplete block.
  1229. (should-not
  1230. (org-test-with-temp-text "#+BEGIN_QUOTE"
  1231. (org-element-map
  1232. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1233. ;;;; Quote Section
  1234. (ert-deftest test-org-element/quote-section-parser ()
  1235. "Test `quote-section' parser."
  1236. (should
  1237. (let ((org-quote-string "QUOTE"))
  1238. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1239. (org-element-map (org-element-parse-buffer) 'quote-section 'identity))))
  1240. (should-not
  1241. (let ((org-quote-string "TEST"))
  1242. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1243. (org-element-map (org-element-parse-buffer) 'quote-section 'identity)))))
  1244. ;;;; Radio Target
  1245. (ert-deftest test-org-element/radio-target-parser ()
  1246. "Test `radio-target' parser."
  1247. ;; Standard test.
  1248. (should
  1249. (org-test-with-temp-text "<<<radio>>>"
  1250. (org-element-map (org-element-parse-buffer) 'radio-target 'identity)))
  1251. ;; Radio targets with objects.
  1252. (should
  1253. (org-test-with-temp-text "<<<radio \\alpha>>>"
  1254. (org-element-map (org-element-parse-buffer) 'radio-target 'identity))))
  1255. ;;;; Section
  1256. (ert-deftest test-org-element/section-parser ()
  1257. "Test `section' parser."
  1258. ;; Standard test.
  1259. (should
  1260. (org-test-with-temp-text "* Headline\nText"
  1261. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1262. ;; There's a section before the first headline.
  1263. (should
  1264. (org-test-with-temp-text "Text"
  1265. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1266. ;; A section cannot be empty.
  1267. (should-not
  1268. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  1269. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1270. ;; A section doesn't contain sub-trees.
  1271. (should-not
  1272. (org-test-with-temp-text "* Head\nText\n** Sub-Head"
  1273. (org-element-map
  1274. (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
  1275. 'headline 'identity))))
  1276. ;;;; Special Block
  1277. (ert-deftest test-org-element/special-block-parser ()
  1278. "Test `special-block' parser."
  1279. ;; Standard test.
  1280. (let ((special-block
  1281. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1282. (org-element-map
  1283. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1284. (should (equal (org-element-property :type special-block) "SPECIAL"))
  1285. (should (org-element-map special-block 'paragraph 'identity)))
  1286. ;; Test folded block.
  1287. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1288. (org-cycle)
  1289. (should
  1290. (org-element-property
  1291. :hiddenp
  1292. (org-element-map
  1293. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1294. ;; Ignore incomplete block.
  1295. (should-not
  1296. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  1297. (org-element-map
  1298. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1299. ;;;; Src Block
  1300. (ert-deftest test-org-element/src-block-parser ()
  1301. "Test `src-block' parser."
  1302. ;; Regular tests.
  1303. (should
  1304. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1305. (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
  1306. ;; Test folded block.
  1307. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1308. (org-cycle)
  1309. (should
  1310. (org-element-property
  1311. :hiddenp
  1312. (org-element-map
  1313. (org-element-parse-buffer) 'src-block 'identity nil t))))
  1314. ;; Ignore incomplete block.
  1315. (should-not
  1316. (org-test-with-temp-text "#+BEGIN_SRC"
  1317. (org-element-map (org-element-parse-buffer) 'src-block 'identity))))
  1318. ;;;; Statistics Cookie
  1319. (ert-deftest test-org-element/statistics-cookie ()
  1320. "Test `statistics-cookie' parser."
  1321. ;; With numbers.
  1322. (should
  1323. (org-test-with-temp-text "[1/2]"
  1324. (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
  1325. ;; With percents.
  1326. (should
  1327. (org-test-with-temp-text "[33%]"
  1328. (org-element-map
  1329. (org-element-parse-buffer) 'statistics-cookie 'identity))))
  1330. ;;;; Strike Through
  1331. (ert-deftest test-org-element/strike-through-parser ()
  1332. "Test `strike-through' parser."
  1333. ;; Regular test.
  1334. (should
  1335. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1336. (org-test-with-temp-text "+strike-through+"
  1337. (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
  1338. ;; Multi-line markup.
  1339. (should
  1340. (equal
  1341. (org-element-contents
  1342. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1343. (org-test-with-temp-text "+first line\nsecond line+"
  1344. (org-element-map
  1345. (org-element-parse-buffer) 'strike-through 'identity nil t))))
  1346. '("first line\nsecond line"))))
  1347. ;;;; Subscript
  1348. (ert-deftest test-org-element/subscript-parser ()
  1349. "Test `subscript' parser."
  1350. ;; Without braces.
  1351. (should
  1352. (org-test-with-temp-text "a_b"
  1353. (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
  1354. ;; With braces.
  1355. (should
  1356. (org-test-with-temp-text "a_{b}"
  1357. (org-element-map (org-element-parse-buffer) 'subscript 'identity))))
  1358. ;;;; Superscript
  1359. (ert-deftest test-org-element/superscript-parser ()
  1360. "Test `superscript' parser."
  1361. ;; Without braces.
  1362. (should
  1363. (org-test-with-temp-text "a^b"
  1364. (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
  1365. ;; With braces.
  1366. (should
  1367. (org-test-with-temp-text "a^{b}"
  1368. (org-element-map (org-element-parse-buffer) 'superscript 'identity))))
  1369. ;;;; Table
  1370. (ert-deftest test-org-element/table-parser ()
  1371. "Test `table' parser."
  1372. (should
  1373. (org-test-with-temp-text "| a |"
  1374. (org-element-map (org-element-parse-buffer) 'table 'identity)))
  1375. ;; TBLFM keyword is case insensitive.
  1376. (should
  1377. (org-test-with-temp-text "| a |\n#+tblfm: test"
  1378. (org-element-property
  1379. :tblfm
  1380. (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
  1381. ;; Handle multiple TBLFM lines.
  1382. (should
  1383. (= 2
  1384. (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
  1385. (length (org-element-property
  1386. :tblfm
  1387. (org-element-map
  1388. (org-element-parse-buffer) 'table 'identity nil t)))))))
  1389. ;;;; Table Cell
  1390. (ert-deftest test-org-element/table-cell-parser ()
  1391. "Test `table-cell' parser."
  1392. (should
  1393. (org-test-with-temp-text "| a |"
  1394. (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
  1395. ;;;; Table Row
  1396. (ert-deftest test-org-element/table-row-parser ()
  1397. "Test `table-row' parser."
  1398. (should
  1399. (equal '(standard rule)
  1400. (org-test-with-temp-text "| a |\n|---|"
  1401. (org-element-map
  1402. (org-element-parse-buffer) 'table-row
  1403. (lambda (row) (org-element-property :type row)))))))
  1404. ;;;; Target
  1405. (ert-deftest test-org-element/target-parser ()
  1406. "Test `target' parser."
  1407. (should
  1408. (org-test-with-temp-text "<<target>>"
  1409. (org-element-map (org-element-parse-buffer) 'target 'identity))))
  1410. ;;;; Timestamp
  1411. (ert-deftest test-org-element/timestamp ()
  1412. "Test `timestamp' parser."
  1413. ;; Active timestamp.
  1414. (should
  1415. (org-test-with-temp-text "<2012-03-29 16:40>"
  1416. (eq (org-element-property :type
  1417. (org-element-map
  1418. (org-element-parse-buffer)
  1419. 'timestamp 'identity nil t))
  1420. 'active)))
  1421. ;; Inactive timestamp.
  1422. (should
  1423. (org-test-with-temp-text "[2012-03-29 16:40]"
  1424. (eq (org-element-property :type
  1425. (org-element-map
  1426. (org-element-parse-buffer)
  1427. 'timestamp 'identity nil t))
  1428. 'inactive)))
  1429. ;; Date range.
  1430. (should
  1431. (org-test-with-temp-text "[2012-03-29 16:40]--[2012-03-29 16:41]"
  1432. (eq (org-element-property :type
  1433. (org-element-map
  1434. (org-element-parse-buffer)
  1435. 'timestamp 'identity nil t))
  1436. 'inactive-range)))
  1437. ;; Timestamps are not planning elements.
  1438. (should-not
  1439. (org-test-with-temp-text "SCHEDULED: <2012-03-29 16:40>"
  1440. (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
  1441. ;;;; Underline
  1442. (ert-deftest test-org-element/underline-parser ()
  1443. "Test `underline' parser."
  1444. ;; Regular test.
  1445. (should
  1446. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1447. (org-test-with-temp-text "_underline_"
  1448. (org-element-map (org-element-parse-buffer) 'underline 'identity))))
  1449. ;; Multi-line markup.
  1450. (should
  1451. (equal
  1452. (org-element-contents
  1453. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1454. (org-test-with-temp-text "_first line\nsecond line_"
  1455. (org-element-map
  1456. (org-element-parse-buffer) 'underline 'identity nil t))))
  1457. '("first line\nsecond line"))))
  1458. ;;;; Verbatim
  1459. (ert-deftest test-org-element/verbatim-parser ()
  1460. "Test `verbatim' parser."
  1461. ;; Regular test.
  1462. (should
  1463. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1464. (org-test-with-temp-text "=verbatim="
  1465. (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
  1466. ;; Multi-line markup.
  1467. (should
  1468. (equal
  1469. (org-element-property
  1470. :value
  1471. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1472. (org-test-with-temp-text "=first line\nsecond line="
  1473. (org-element-map
  1474. (org-element-parse-buffer) 'verbatim 'identity nil t))))
  1475. "first line\nsecond line")))
  1476. ;;;; Verse Block
  1477. (ert-deftest test-org-element/verse-block-parser ()
  1478. "Test `verse-block' parser."
  1479. ;; Standard test.
  1480. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1481. (should
  1482. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1483. ;; Ignore case.
  1484. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  1485. (should
  1486. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1487. ;; Parse folding.
  1488. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1489. (org-hide-block-all)
  1490. (should
  1491. (org-element-property
  1492. :hiddenp
  1493. (org-element-map
  1494. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1495. ;; Parse objects in verse blocks.
  1496. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  1497. (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  1498. ;; Ignore incomplete verse block.
  1499. (should-not
  1500. (org-test-with-temp-text "#+BEGIN_VERSE"
  1501. (org-element-map
  1502. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1503. ;;; Test Interpreters.
  1504. (ert-deftest test-org-element/affiliated-keywords-interpreter ()
  1505. "Test if affiliated keywords are correctly interpreted."
  1506. ;; Interpret simple keywords.
  1507. (should
  1508. (equal
  1509. (org-element-interpret-data
  1510. '(org-data nil (paragraph (:name "para") "Paragraph")))
  1511. "#+NAME: para\nParagraph\n"))
  1512. ;; Interpret multiple keywords.
  1513. (should
  1514. (equal
  1515. (org-element-interpret-data
  1516. '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
  1517. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  1518. ;; Interpret parsed keywords.
  1519. (should
  1520. (equal
  1521. (org-element-interpret-data
  1522. '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
  1523. "#+CAPTION: caption\nParagraph\n"))
  1524. ;; Interpret dual keywords.
  1525. (should
  1526. (equal
  1527. (org-element-interpret-data
  1528. '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
  1529. "#+CAPTION[short]: long\nParagraph\n"))
  1530. ;; Interpret multiple parsed dual keywords.
  1531. (should
  1532. (equal
  1533. (org-element-interpret-data
  1534. '(org-data nil (paragraph
  1535. (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
  1536. "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n")))
  1537. (ert-deftest test-org-element/center-block-interpreter ()
  1538. "Test center block interpreter."
  1539. (should
  1540. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1541. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1542. (ert-deftest test-org-element/drawer-interpreter ()
  1543. "Test drawer interpreter."
  1544. (should
  1545. (equal (let ((org-drawers '("TEST")))
  1546. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  1547. ":TEST:\nTest\n:END:\n")))
  1548. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1549. "Test dynamic block interpreter."
  1550. (should
  1551. (equal (org-test-parse-and-interpret
  1552. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1553. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1554. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1555. "Test footnote definition interpreter."
  1556. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1557. (ert-deftest test-org-element/headline-interpreter ()
  1558. "Test headline and section interpreters."
  1559. ;; 1. Standard test.
  1560. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1561. ;; 2. With TODO keywords.
  1562. (should
  1563. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1564. (org-test-parse-and-interpret "* TODO Headline"))
  1565. "* TODO Headline\n"))
  1566. ;; 3. With tags...
  1567. ;;
  1568. ;; 3.1. ... and a positive `org-tags-column' value.
  1569. (should
  1570. (equal (let ((org-tags-column 20))
  1571. (org-test-parse-and-interpret "* Headline :tag:"))
  1572. "* Headline :tag:\n"))
  1573. ;; 3.2. ... and a negative `org-tags-column' value.
  1574. (should
  1575. (equal (let ((org-tags-column -20))
  1576. (org-test-parse-and-interpret "* Headline :tag:"))
  1577. "* Headline :tag:\n"))
  1578. ;; 3.3. ... and a null `org-tags-column' value.
  1579. (should
  1580. (equal (let ((org-tags-column 0))
  1581. (org-test-parse-and-interpret "* Headline :tag:"))
  1582. "* Headline :tag:\n"))
  1583. ;; 4. With priority cookie.
  1584. (should
  1585. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1586. "* [#B] Headline\n"))
  1587. ;; 5. With comment keyword.
  1588. (should
  1589. (equal (let ((org-comment-string "COMMENT"))
  1590. (org-test-parse-and-interpret "* COMMENT Headline"))
  1591. "* COMMENT Headline\n"))
  1592. ;; 6. With quote section.
  1593. (should
  1594. (equal (let ((org-quote-string "QUOTE"))
  1595. (org-test-parse-and-interpret "* QUOTE Headline"))
  1596. "* QUOTE Headline\n"))
  1597. ;; 7. Keep same number of blank lines before body.
  1598. (should
  1599. (equal (org-test-parse-and-interpret
  1600. "* Headline\n\n\nText after two blank lines.")
  1601. "* Headline\n\n\nText after two blank lines.\n")))
  1602. (ert-deftest test-org-element/inlinetask-interpreter ()
  1603. "Test inlinetask interpretation."
  1604. (when (featurep 'org-inlinetask)
  1605. (let ((org-inlinetask-min-level 15))
  1606. ;; 1. Regular inlinetask.
  1607. (should (equal (org-test-parse-and-interpret
  1608. "*************** Task\nTest\n*************** END")
  1609. "*************** Task\nTest\n*************** END\n"))
  1610. ;; 2. Degenerate inlinetask.
  1611. (should (equal (org-test-parse-and-interpret "*************** Task")
  1612. "*************** Task\n"))
  1613. ;; 3. Prefer degenerate form when there are no contents.
  1614. (should (equal (org-test-parse-and-interpret
  1615. "*************** Task\n*************** END")
  1616. "*************** Task\n"))
  1617. ;; 4. With TODO keywords.
  1618. (should
  1619. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1620. (org-test-parse-and-interpret "*************** TODO Task"))
  1621. "*************** TODO Task\n"))
  1622. ;; 5. With tags...
  1623. ;;
  1624. ;; 5.1. ... and a positive `org-tags-column' value.
  1625. (should
  1626. (equal (let ((org-tags-column 30))
  1627. (org-test-parse-and-interpret "*************** Task :tag:"))
  1628. "*************** Task :tag:\n"))
  1629. ;; 5.2. ... and a negative `org-tags-column' value.
  1630. (should
  1631. (equal (let ((org-tags-column -30))
  1632. (org-test-parse-and-interpret "*************** Task :tag:"))
  1633. "*************** Task :tag:\n"))
  1634. ;; 5.3. ... and a null `org-tags-column' value.
  1635. (should
  1636. (equal (let ((org-tags-column 0))
  1637. (org-test-parse-and-interpret "*************** Task :tag:"))
  1638. "*************** Task :tag:\n"))
  1639. ;; 6. With priority cookie.
  1640. (should
  1641. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1642. "*************** [#B] Task\n")))))
  1643. (ert-deftest test-org-element/plain-list-interpreter ()
  1644. "Test plain-list and item interpreters."
  1645. (let ((org-list-two-spaces-after-bullet-regexp nil))
  1646. ;; 1. Unordered list.
  1647. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1648. ;; 2. Description list.
  1649. (should
  1650. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1651. ;; 3. Ordered list.
  1652. (should
  1653. (equal (let ((org-plain-list-ordered-item-terminator t))
  1654. (org-test-parse-and-interpret "1. Item"))
  1655. "1. Item\n"))
  1656. ;; 4. Ordered list with counter.
  1657. (should
  1658. (equal (let ((org-plain-list-ordered-item-terminator t))
  1659. (org-test-parse-and-interpret "1. [@5] Item"))
  1660. "5. [@5] Item\n"))
  1661. ;; 5. List with check-boxes.
  1662. (should
  1663. (equal (org-test-parse-and-interpret
  1664. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1665. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
  1666. ;; 6. Item not starting with a paragraph.
  1667. (should
  1668. (equal (org-test-parse-and-interpret "-\n | a | b |")
  1669. "- \n | a | b |\n"))))
  1670. (ert-deftest test-org-element/quote-block-interpreter ()
  1671. "Test quote block interpreter."
  1672. (should (equal (org-test-parse-and-interpret
  1673. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  1674. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  1675. (ert-deftest test-org-element/special-block-interpreter ()
  1676. "Test special block interpreter."
  1677. (should (equal (org-test-parse-and-interpret
  1678. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  1679. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  1680. (ert-deftest test-org-element/babel-call-interpreter ()
  1681. "Test babel call interpreter."
  1682. ;; 1. Without argument.
  1683. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  1684. "#+CALL: test()\n"))
  1685. ;; 2. With argument.
  1686. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  1687. "#+CALL: test(x=2)\n"))
  1688. ;; 3. With header arguments.
  1689. (should (equal (org-test-parse-and-interpret
  1690. "#+CALL: test[:results output]()[:results html]")
  1691. "#+CALL: test[:results output]()[:results html]\n")))
  1692. (ert-deftest test-org-element/clock-interpreter ()
  1693. "Test clock interpreter."
  1694. ;; Running clock.
  1695. (should
  1696. (equal (let ((org-clock-string "CLOCK:"))
  1697. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  1698. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  1699. ;; Closed clock.
  1700. (should
  1701. (equal
  1702. (let ((org-clock-string "CLOCK:"))
  1703. (org-test-parse-and-interpret "
  1704. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  1705. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  1706. (ert-deftest test-org-element/comment-interpreter ()
  1707. "Test comment interpreter."
  1708. ;; Regular comment.
  1709. (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
  1710. ;; Inline comment.
  1711. (should (equal (org-test-parse-and-interpret " # Comment")
  1712. "# Comment\n"))
  1713. ;; Preserve indentation.
  1714. (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
  1715. "# No blank\n# One blank\n")))
  1716. (ert-deftest test-org-element/comment-block-interpreter ()
  1717. "Test comment block interpreter."
  1718. (should (equal (org-test-parse-and-interpret
  1719. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  1720. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  1721. (ert-deftest test-org-element/example-block-interpreter ()
  1722. "Test example block interpreter."
  1723. ;; Without switches.
  1724. (should (equal (org-test-parse-and-interpret
  1725. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  1726. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  1727. ;; With switches.
  1728. (should
  1729. (equal (org-test-parse-and-interpret
  1730. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  1731. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  1732. (ert-deftest test-org-element/export-block-interpreter ()
  1733. "Test export block interpreter."
  1734. (should (equal (org-test-parse-and-interpret
  1735. "#+BEGIN_HTML\nTest\n#+END_HTML")
  1736. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  1737. (ert-deftest test-org-element/fixed-width-interpreter ()
  1738. "Test fixed width interpreter."
  1739. ;; Standard test.
  1740. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  1741. ;; Preserve indentation.
  1742. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  1743. ": 2 blanks\n: 1 blank\n")))
  1744. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  1745. "Test horizontal rule interpreter."
  1746. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  1747. (ert-deftest test-org-element/keyword-interpreter ()
  1748. "Test keyword interpreter."
  1749. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  1750. "#+KEYWORD: value\n")))
  1751. (ert-deftest test-org-element/latex-environment-interpreter ()
  1752. "Test latex environment interpreter."
  1753. (should (equal (org-test-parse-and-interpret
  1754. "\\begin{equation}\n1+1=2\n\\end{equation}")
  1755. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  1756. (ert-deftest test-org-element/planning-interpreter ()
  1757. "Test planning interpreter."
  1758. (let ((org-closed-string "CLOSED:")
  1759. (org-deadline-string "DEADLINE:")
  1760. (org-scheduled-string "SCHEDULED:"))
  1761. (should
  1762. (equal
  1763. (org-test-parse-and-interpret
  1764. "* Headline
  1765. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  1766. "* Headline
  1767. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  1768. (ert-deftest test-org-element/property-drawer-interpreter ()
  1769. "Test property drawer interpreter."
  1770. (should (equal (let ((org-property-format "%-10s %s"))
  1771. (org-test-parse-and-interpret
  1772. ":PROPERTIES:\n:prop: value\n:END:"))
  1773. ":PROPERTIES:\n:prop: value\n:END:\n")))
  1774. (ert-deftest test-org-element/src-block-interpreter ()
  1775. "Test src block interpreter."
  1776. ;; With arguments.
  1777. (should
  1778. (equal (let ((org-edit-src-content-indentation 2))
  1779. (org-test-parse-and-interpret
  1780. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
  1781. "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
  1782. ;; With switches.
  1783. (should
  1784. (equal (let ((org-edit-src-content-indentation 2))
  1785. (org-test-parse-and-interpret
  1786. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
  1787. "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n")))
  1788. (ert-deftest test-org-element/table-interpreter ()
  1789. "Test table, table-row and table-cell interpreters."
  1790. ;; 1. Simple table.
  1791. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  1792. "| a | b |\n| c | d |\n"))
  1793. ;; 2. With horizontal rules.
  1794. (should (equal (org-test-parse-and-interpret
  1795. "| a | b |\n|---+---|\n| c | d |")
  1796. "| a | b |\n|---+---|\n| c | d |\n"))
  1797. ;; 3. With meta-data.
  1798. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  1799. "| / | < | > |\n| * | 1 | 2 |\n"))
  1800. ;; 4. With a formula.
  1801. (should
  1802. (equal (org-test-parse-and-interpret
  1803. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
  1804. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
  1805. ;; 5. With multiple formulas.
  1806. (should
  1807. (equal (org-test-parse-and-interpret
  1808. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
  1809. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
  1810. (ert-deftest test-org-element/timestamp-interpreter ()
  1811. "Test timestamp interpreter."
  1812. ;; Active.
  1813. (should (equal (org-test-parse-and-interpret "<2012-03-29 16:40>")
  1814. "<2012-03-29 16:40>\n"))
  1815. ;; Inactive.
  1816. (should (equal (org-test-parse-and-interpret "[2012-03-29 16:40]")
  1817. "[2012-03-29 16:40]\n"))
  1818. ;; Active range.
  1819. (should (equal (org-test-parse-and-interpret
  1820. "<2012-03-29 16:40>--<2012-03-29 16:41>")
  1821. "<2012-03-29 16:40>--<2012-03-29 16:41>\n"))
  1822. ;; Inactive range.
  1823. (should (equal (org-test-parse-and-interpret
  1824. "[2012-03-29 16:40]--[2012-03-29 16:41]")
  1825. "[2012-03-29 16:40]--[2012-03-29 16:41]\n"))
  1826. ;; Diary.
  1827. (should (equal (org-test-parse-and-interpret "<%%org-float t 4 2>")
  1828. "<%%org-float t 4 2>\n"))
  1829. ;; Timestamp with repeater interval.
  1830. (should (equal (org-test-parse-and-interpret "<2012-03-29 +1y>")
  1831. "<2012-03-29 +1y>\n")))
  1832. (ert-deftest test-org-element/verse-block-interpreter ()
  1833. "Test verse block interpretation."
  1834. (should
  1835. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  1836. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  1837. (ert-deftest test-org-element/bold-interpreter ()
  1838. "Test bold interpreter."
  1839. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  1840. (ert-deftest test-org-element/code-interpreter ()
  1841. "Test code interpreter."
  1842. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  1843. (ert-deftest test-org-element/entity-interpreter ()
  1844. "Test entity interpreter."
  1845. ;; 1. Without brackets.
  1846. (should
  1847. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  1848. ;; 2. With brackets.
  1849. (should
  1850. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  1851. (ert-deftest test-org-element/export-snippet-interpreter ()
  1852. "Test export snippet interpreter."
  1853. (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
  1854. "@@back-end:contents@@\n")))
  1855. (ert-deftest test-org-element/footnote-reference-interpreter ()
  1856. "Test footnote reference interpreter."
  1857. ;; 1. Regular reference.
  1858. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  1859. ;; 2. Normalized reference.
  1860. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  1861. ;; 3. Named reference.
  1862. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  1863. "Text[fn:label]\n"))
  1864. ;; 4. Inline reference.
  1865. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  1866. "Text[fn:label:def]\n"))
  1867. ;; 5. Anonymous reference.
  1868. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  1869. "Text[fn::def]\n")))
  1870. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  1871. "Test inline babel call interpreter."
  1872. ;; 1. Without arguments.
  1873. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  1874. ;; 2. With arguments.
  1875. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  1876. "call_test(x=2)\n"))
  1877. ;; 3. With header arguments.
  1878. (should (equal (org-test-parse-and-interpret
  1879. "call_test[:results output]()[:results html]")
  1880. "call_test[:results output]()[:results html]\n")))
  1881. (ert-deftest test-org-element/inline-src-block-interpreter ()
  1882. "Test inline src block interpreter."
  1883. ;; 1. Without header argument.
  1884. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  1885. "src_emacs-lisp{(+ 1 1)}\n"))
  1886. ;; 2. With header arguments.
  1887. (should (equal (org-test-parse-and-interpret
  1888. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  1889. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  1890. (ert-deftest test-org-element/italic-interpreter ()
  1891. "Test italic interpreter."
  1892. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  1893. (ert-deftest test-org-element/latex-fragment-interpreter ()
  1894. "Test latex fragment interpreter."
  1895. (let ((org-latex-regexps
  1896. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  1897. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1898. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1899. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  1900. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  1901. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  1902. (should (equal (org-test-parse-and-interpret "\\command{}")
  1903. "\\command{}\n"))
  1904. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  1905. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  1906. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  1907. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  1908. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  1909. (ert-deftest test-org-element/line-break-interpreter ()
  1910. "Test line break interpreter."
  1911. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  1912. "First line \\\\\nSecond line\n")))
  1913. (ert-deftest test-org-element/link-interpreter ()
  1914. "Test link interpreter."
  1915. ;; 1. Links targeted from a radio target.
  1916. (should (equal (let ((org-target-link-regexp "radio-target"))
  1917. (org-test-parse-and-interpret "a radio-target"))
  1918. "a radio-target\n"))
  1919. ;; 2. Regular links.
  1920. ;;
  1921. ;; 2.1. Without description.
  1922. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  1923. "[[http://orgmode.org]]\n"))
  1924. ;; 2.2. With a description.
  1925. (should (equal (org-test-parse-and-interpret
  1926. "[[http://orgmode.org][Org mode]]")
  1927. "[[http://orgmode.org][Org mode]]\n"))
  1928. ;; 2.3. Id links.
  1929. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  1930. ;; 2.4. Custom-id links.
  1931. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  1932. ;; 2.5 Code-ref links.
  1933. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  1934. ;; 3. Normalize plain links.
  1935. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  1936. "[[http://orgmode.org]]\n"))
  1937. ;; 4. Normalize angular links.
  1938. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  1939. "[[http://orgmode.org]]\n")))
  1940. (ert-deftest test-org-element/macro-interpreter ()
  1941. "Test macro interpreter."
  1942. ;; 1. Without argument.
  1943. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  1944. ;; 2. With arguments.
  1945. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  1946. "{{{test(arg1,arg2)}}}\n")))
  1947. (ert-deftest test-org-element/radio-target-interpreter ()
  1948. "Test radio target interpreter."
  1949. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  1950. "<<<some text>>>\n")))
  1951. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  1952. "Test statistics cookie interpreter."
  1953. ;; 1. Without percent
  1954. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  1955. ;; 2. With percent.
  1956. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  1957. (ert-deftest test-org-element/strike-through-interpreter ()
  1958. "Test strike through interpreter."
  1959. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  1960. (ert-deftest test-org-element/subscript-interpreter ()
  1961. "Test subscript interpreter."
  1962. ;; 1. Without brackets.
  1963. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  1964. ;; 2. With brackets.
  1965. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  1966. (ert-deftest test-org-element/superscript-interpreter ()
  1967. "Test superscript interpreter."
  1968. ;; 1. Without brackets.
  1969. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  1970. ;; 2. With brackets.
  1971. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  1972. (ert-deftest test-org-element/target-interpreter ()
  1973. "Test target interpreter."
  1974. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  1975. (ert-deftest test-org-element/underline-interpreter ()
  1976. "Test underline interpreter."
  1977. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  1978. (ert-deftest test-org-element/verbatim-interpreter ()
  1979. "Test verbatim interpreter."
  1980. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  1981. ;;; Test Granularity
  1982. (ert-deftest test-org-element/granularity ()
  1983. "Test granularity impact on buffer parsing."
  1984. (org-test-with-temp-text "
  1985. * Head 1
  1986. ** Head 2
  1987. #+BEGIN_CENTER
  1988. Centered paragraph.
  1989. #+END_CENTER
  1990. Paragraph \\alpha."
  1991. ;; 1.1. Granularity set to `headline' should parse every headline
  1992. ;; in buffer, and only them.
  1993. (let ((tree (org-element-parse-buffer 'headline)))
  1994. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  1995. (should-not (org-element-map tree 'paragraph 'identity)))
  1996. ;; 1.2. Granularity set to `greater-element' should not enter
  1997. ;; greater elements excepted headlines and sections.
  1998. (let ((tree (org-element-parse-buffer 'greater-element)))
  1999. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  2000. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  2001. (should-not (org-element-map tree 'entity 'identity)))
  2002. ;; 1.3. Granularity set to `element' should enter every
  2003. ;; greater-element.
  2004. (let ((tree (org-element-parse-buffer 'element)))
  2005. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  2006. (should-not (org-element-map tree 'entity 'identity)))
  2007. ;; 1.4. Granularity set to `object' can see everything.
  2008. (let ((tree (org-element-parse-buffer 'object)))
  2009. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  2010. (ert-deftest test-org-element/secondary-string-parsing ()
  2011. "Test if granularity correctly toggles secondary strings parsing."
  2012. ;; 1. With a granularity bigger than `object', no secondary string
  2013. ;; should be parsed.
  2014. ;;
  2015. ;; 1.1. Test with `headline' type.
  2016. (org-test-with-temp-text "* Headline"
  2017. (let ((headline
  2018. (org-element-map (org-element-parse-buffer 'headline) 'headline
  2019. 'identity
  2020. nil
  2021. 'first-match)))
  2022. (should (stringp (org-element-property :title headline)))))
  2023. ;; 1.2. Test with `item' type.
  2024. (org-test-with-temp-text "* Headline\n- tag :: item"
  2025. (let ((item (org-element-map (org-element-parse-buffer 'element)
  2026. 'item
  2027. 'identity
  2028. nil
  2029. 'first-match)))
  2030. (should (stringp (org-element-property :tag item)))))
  2031. ;; 1.3. Test with `inlinetask' type, if avalaible.
  2032. (when (featurep 'org-inlinetask)
  2033. (let ((org-inlinetask-min-level 15))
  2034. (org-test-with-temp-text "*************** Inlinetask"
  2035. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  2036. 'inlinetask
  2037. 'identity
  2038. nil
  2039. 'first-match)))
  2040. (should (stringp (org-element-property :title inlinetask)))))))
  2041. ;; 2. With a default granularity, secondary strings should be
  2042. ;; parsed.
  2043. (org-test-with-temp-text "* Headline"
  2044. (let ((headline
  2045. (org-element-map (org-element-parse-buffer) 'headline
  2046. 'identity
  2047. nil
  2048. 'first-match)))
  2049. (should (listp (org-element-property :title headline)))))
  2050. ;; 3. `org-element-at-point' should never parse a secondary string.
  2051. (org-test-with-temp-text "* Headline"
  2052. (should (stringp (org-element-property :title (org-element-at-point))))))
  2053. ;;; Test `:parent' Property
  2054. (ert-deftest test-org-element/parent-property ()
  2055. "Test `:parent' property."
  2056. ;; Elements.
  2057. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  2058. (let* ((tree (org-element-parse-buffer))
  2059. (parent (org-element-property
  2060. :parent
  2061. (org-element-map tree 'paragraph 'identity nil t))))
  2062. (should parent)
  2063. (should (eq (org-element-map tree 'center-block 'identity nil t)
  2064. parent))))
  2065. ;; Objects.
  2066. (org-test-with-temp-text "a_{/b/}"
  2067. (let* ((tree (org-element-parse-buffer))
  2068. (parent (org-element-property
  2069. :parent
  2070. (org-element-map tree 'italic 'identity nil t))))
  2071. (should parent)
  2072. (should (eq parent
  2073. (org-element-map tree 'subscript 'identity nil t)))))
  2074. ;; Secondary strings
  2075. (org-test-with-temp-text "* /italic/"
  2076. (let* ((tree (org-element-parse-buffer))
  2077. (parent (org-element-property
  2078. :parent (org-element-map tree 'italic 'identity nil t))))
  2079. (should parent)
  2080. (should (eq parent
  2081. (org-element-map tree 'headline 'identity nil t))))))
  2082. ;;; Test Normalize Contents
  2083. (ert-deftest test-org-element/normalize-contents ()
  2084. "Test `org-element-normalize-contents' specifications."
  2085. ;; 1. Remove maximum common indentation from element's contents.
  2086. (should
  2087. (equal
  2088. (org-element-normalize-contents
  2089. '(paragraph nil " Two spaces\n Three spaces"))
  2090. '(paragraph nil "Two spaces\n Three spaces")))
  2091. ;; 2. Ignore objects within contents when computing maximum common
  2092. ;; indentation.
  2093. (should
  2094. (equal
  2095. (org-element-normalize-contents
  2096. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  2097. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  2098. ;; 3. Ignore blank lines.
  2099. (should
  2100. (equal
  2101. (org-element-normalize-contents
  2102. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  2103. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  2104. ;; 4. Recursively enter objects in order to compute common
  2105. ;; indentation.
  2106. (should
  2107. (equal
  2108. (org-element-normalize-contents
  2109. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  2110. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  2111. ;; 5. When optional argument is provided, ignore first line
  2112. ;; indentation.
  2113. (should
  2114. (equal
  2115. (org-element-normalize-contents
  2116. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  2117. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  2118. ;;; Test Navigation Tools.
  2119. (ert-deftest test-org-element/at-point ()
  2120. "Test `org-element-at-point' specifications."
  2121. ;; Return closest element containing point.
  2122. (should
  2123. (eq 'paragraph
  2124. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2125. (progn (search-forward "A")
  2126. (org-element-type (org-element-at-point))))))
  2127. ;; Correctly set `:parent' property.
  2128. (should
  2129. (eq 'center-block
  2130. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2131. (progn (search-forward "A")
  2132. (org-element-type
  2133. (org-element-property :parent (org-element-at-point)))))))
  2134. ;; Special case: at the very beginning of a table, return `table'
  2135. ;; object instead of `table-row'.
  2136. (should
  2137. (eq 'table
  2138. (org-test-with-temp-text "| a | b |"
  2139. (org-element-type (org-element-at-point)))))
  2140. ;; Special case: at the very beginning of a list or sub-list, return
  2141. ;; `plain-list' object instead of `item'.
  2142. (should
  2143. (eq 'plain-list
  2144. (org-test-with-temp-text "- item"
  2145. (org-element-type (org-element-at-point)))))
  2146. ;; Special case: at the closing line of a greater element, be sure
  2147. ;; to return it instead of the last element in its contents.
  2148. (should
  2149. (eq 'center-block
  2150. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
  2151. (progn (forward-line 2)
  2152. (org-element-type (org-element-at-point))))))
  2153. ;; Special case: at a blank line between two items, be sure to
  2154. ;; return item above instead of the last element of its contents.
  2155. (should
  2156. (eq 'item
  2157. (org-test-with-temp-text "- Para1\n\n- Para2"
  2158. (progn (forward-line)
  2159. (org-element-type
  2160. (let ((org-empty-line-terminates-plain-lists nil))
  2161. (org-element-at-point)))))))
  2162. ;; Special case: at the last blank line in a plain list, return it
  2163. ;; instead of the last item.
  2164. (should
  2165. (eq 'plain-list
  2166. (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
  2167. (progn (forward-line 2)
  2168. (org-element-type (org-element-at-point))))))
  2169. ;; With an optional argument, return trail.
  2170. (should
  2171. (equal '(paragraph center-block)
  2172. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER\nZ"
  2173. (progn (search-forward "Z")
  2174. (mapcar 'org-element-type (org-element-at-point t)))))))
  2175. (ert-deftest test-org-element/context ()
  2176. "Test `org-element-context' specifications."
  2177. ;; Return closest object containing point.
  2178. (should
  2179. (eq 'underline
  2180. (org-test-with-temp-text "Some *text with _underline_ text*"
  2181. (progn (search-forward "under")
  2182. (org-element-type (org-element-context))))))
  2183. ;; Find objects in secondary strings.
  2184. (should
  2185. (eq 'underline
  2186. (org-test-with-temp-text "* Headline _with_ underlining"
  2187. (progn (search-forward "w")
  2188. (org-element-type (org-element-context))))))
  2189. ;; Correctly set `:parent' property.
  2190. (should
  2191. (eq 'paragraph
  2192. (org-test-with-temp-text "Some *bold* text"
  2193. (progn (search-forward "bold")
  2194. (org-element-type
  2195. (org-element-property :parent (org-element-context))))))))
  2196. (provide 'test-org-element)
  2197. ;;; test-org-element.el ends here