test-org-element.el 87 KB

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