test-org-element.el 133 KB

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