test-org-element.el 84 KB

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