test-org-element.el 104 KB

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