test-org-element.el 103 KB

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