test-org-element.el 122 KB

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