test-org-element.el 100 KB

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