test-org-element.el 95 KB

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