test-org-element.el 143 KB

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