test-org-element.el 87 KB

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