test-org-element.el 121 KB

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