test-org-element.el 121 KB

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