test-org-element.el 105 KB

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