test-org-element.el 103 KB

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