test-org-element.el 101 KB

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