org-element.el 132 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715
  1. ;;; org-element.el --- Parser And Applications for Org syntax
  2. ;; Copyright (C) 2012 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This program is free software; you can redistribute it and/or modify
  6. ;; it under the terms of the GNU General Public License as published by
  7. ;; the Free Software Foundation, either version 3 of the License, or
  8. ;; (at your option) any later version.
  9. ;; This program is distributed in the hope that it will be useful,
  10. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. ;; GNU General Public License for more details.
  13. ;; This file is not part of GNU Emacs.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;; Org syntax can be divided into three categories: "Greater
  18. ;; elements", "Elements" and "Objects".
  19. ;; An object can be defined anywhere on a line. It may span over more
  20. ;; than a line but never contains a blank one. Objects belong to the
  21. ;; following types: `emphasis', `entity', `export-snippet',
  22. ;; `footnote-reference', `inline-babel-call', `inline-src-block',
  23. ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
  24. ;; `statistics-cookie', `subscript', `superscript', `target',
  25. ;; `time-stamp' and `verbatim'.
  26. ;; An element always starts and ends at the beginning of a line. The
  27. ;; only element's type containing objects is called a `paragraph'.
  28. ;; Other types are: `comment', `comment-block', `example-block',
  29. ;; `export-block', `fixed-width', `horizontal-rule', `keyword',
  30. ;; `latex-environment', `babel-call', `property-drawer',
  31. ;; `quote-section', `src-block', `table' and `verse-block'.
  32. ;; Elements containing paragraphs are called greater elements.
  33. ;; Concerned types are: `center-block', `drawer', `dynamic-block',
  34. ;; `footnote-definition', `headline', `inlinetask', `item',
  35. ;; `plain-list', `quote-block', `section' and `special-block'.
  36. ;; Greater elements (excepted `headline', `item' and `section' types)
  37. ;; and elements (excepted `keyword', `babel-call', and
  38. ;; `property-drawer' types) can have a fixed set of keywords as
  39. ;; attributes. Those are called "affiliated keywords", to distinguish
  40. ;; them from others keywords, which are full-fledged elements. In
  41. ;; particular, the "name" affiliated keyword allows to label almost
  42. ;; any element in an Org buffer.
  43. ;; Notwithstanding affiliated keywords, each greater element, element
  44. ;; and object has a fixed set of properties attached to it. Among
  45. ;; them, three are shared by all types: `:begin' and `:end', which
  46. ;; refer to the beginning and ending buffer positions of the
  47. ;; considered element or object, and `:post-blank', which holds the
  48. ;; number of blank lines, or white spaces, at its end.
  49. ;; Some elements also have special properties whose value can hold
  50. ;; objects themselves (i.e. an item tag, an headline name, a table
  51. ;; cell). Such values are called "secondary strings".
  52. ;; Lisp-wise, an element or an object can be represented as a list.
  53. ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
  54. ;; TYPE is a symbol describing the Org element or object.
  55. ;; PROPERTIES is the property list attached to it. See docstring of
  56. ;; appropriate parsing function to get an exhaustive
  57. ;; list.
  58. ;; CONTENTS is a list of elements, objects or raw strings contained
  59. ;; in the current element or object, when applicable.
  60. ;; An Org buffer is a nested list of such elements and objects, whose
  61. ;; type is `org-data' and properties is nil.
  62. ;; The first part of this file implements a parser and an interpreter
  63. ;; for each type of Org syntax.
  64. ;; The next two parts introduce two accessors and a function
  65. ;; retrieving the smallest element containing point (respectively
  66. ;; `org-element-get-property', `org-element-get-contents' and
  67. ;; `org-element-at-point').
  68. ;; The following part creates a fully recursive buffer parser. It
  69. ;; also provides a tool to map a function to elements or objects
  70. ;; matching some criteria in the parse tree. Functions of interest
  71. ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
  72. ;; extent, `org-element-parse-secondary-string'.
  73. ;; The penultimate part is the cradle of an interpreter for the
  74. ;; obtained parse tree: `org-element-interpret-data' (and its
  75. ;; relative, `org-element-interpret-secondary').
  76. ;; The library ends by furnishing a set of interactive tools for
  77. ;; element's navigation and manipulation.
  78. ;;; Code:
  79. (eval-when-compile (require 'cl))
  80. (require 'org)
  81. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  82. ;;; Greater elements
  83. ;; For each greater element type, we define a parser and an
  84. ;; interpreter.
  85. ;; A parser (`item''s excepted) accepts no argument and represents the
  86. ;; element or object as the list described above. An interpreter
  87. ;; accepts two arguments: the list representation of the element or
  88. ;; object, and its contents. The latter may be nil, depending on the
  89. ;; element or object considered. It returns the appropriate Org
  90. ;; syntax, as a string.
  91. ;; Parsing functions must follow the naming convention:
  92. ;; org-element-TYPE-parser, where TYPE is greater element's type, as
  93. ;; defined in `org-element-greater-elements'.
  94. ;;
  95. ;; Similarly, interpreting functions must follow the naming
  96. ;; convention: org-element-TYPE-interpreter.
  97. ;; With the exception of `headline' and `item' types, greater elements
  98. ;; cannot contain other greater elements of their own type.
  99. ;; Beside implementing a parser and an interpreter, adding a new
  100. ;; greater element requires to tweak `org-element-guess-type'.
  101. ;; Moreover, the newly defined type must be added to both
  102. ;; `org-element-all-elements' and `org-element-greater-elements'.
  103. ;;;; Center Block
  104. (defun org-element-center-block-parser ()
  105. "Parse a center block.
  106. Return a list whose car is `center-block' and cdr is a plist
  107. containing `:begin', `:end', `:hiddenp', `:contents-begin',
  108. `:contents-end' and `:post-blank' keywords.
  109. Assume point is at beginning or end of the block."
  110. (save-excursion
  111. (let* ((case-fold-search t)
  112. (keywords (progn
  113. (end-of-line)
  114. (re-search-backward
  115. (concat "^[ \t]*#\\+begin_center") nil t)
  116. (org-element-collect-affiliated-keywords)))
  117. (begin (car keywords))
  118. (contents-begin (progn (forward-line) (point)))
  119. (hidden (org-truely-invisible-p))
  120. (contents-end (progn (re-search-forward
  121. (concat "^[ \t]*#\\+end_center") nil t)
  122. (point-at-bol)))
  123. (pos-before-blank (progn (forward-line) (point)))
  124. (end (progn (org-skip-whitespace)
  125. (if (eobp) (point) (point-at-bol)))))
  126. (list 'center-block
  127. `(:begin ,begin
  128. :end ,end
  129. :hiddenp ,hidden
  130. :contents-begin ,contents-begin
  131. :contents-end ,contents-end
  132. :post-blank ,(count-lines pos-before-blank end)
  133. ,@(cadr keywords))))))
  134. (defun org-element-center-block-interpreter (center-block contents)
  135. "Interpret CENTER-BLOCK element as Org syntax.
  136. CONTENTS is the contents of the element."
  137. (format "#+begin_center\n%s#+end_center" contents))
  138. ;;;; Drawer
  139. (defun org-element-drawer-parser ()
  140. "Parse a drawer.
  141. Return a list whose car is `drawer' and cdr is a plist containing
  142. `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
  143. `:contents-end' and `:post-blank' keywords.
  144. Assume point is at beginning of drawer."
  145. (save-excursion
  146. (let* ((case-fold-search t)
  147. (name (progn (looking-at org-drawer-regexp)
  148. (org-match-string-no-properties 1)))
  149. (keywords (org-element-collect-affiliated-keywords))
  150. (begin (car keywords))
  151. (contents-begin (progn (forward-line) (point)))
  152. (hidden (org-truely-invisible-p))
  153. (contents-end (progn (re-search-forward "^[ \t]*:END:" nil t)
  154. (point-at-bol)))
  155. (pos-before-blank (progn (forward-line) (point)))
  156. (end (progn (org-skip-whitespace)
  157. (if (eobp) (point) (point-at-bol)))))
  158. (list 'drawer
  159. `(:begin ,begin
  160. :end ,end
  161. :drawer-name ,name
  162. :hiddenp ,hidden
  163. :contents-begin ,contents-begin
  164. :contents-end ,contents-end
  165. :post-blank ,(count-lines pos-before-blank end)
  166. ,@(cadr keywords))))))
  167. (defun org-element-drawer-interpreter (drawer contents)
  168. "Interpret DRAWER element as Org syntax.
  169. CONTENTS is the contents of the element."
  170. (format ":%s:\n%s:END:"
  171. (org-element-get-property :drawer-name drawer)
  172. contents))
  173. ;;;; Dynamic Block
  174. (defun org-element-dynamic-block-parser ()
  175. "Parse a dynamic block.
  176. Return a list whose car is `dynamic-block' and cdr is a plist
  177. containing `:block-name', `:begin', `:end', `:hiddenp',
  178. `:contents-begin', `:contents-end', `:arguments' and
  179. `:post-blank' keywords.
  180. Assume point is at beginning of dynamic block."
  181. (save-excursion
  182. (let* ((case-fold-search t)
  183. (name (progn (looking-at org-dblock-start-re)
  184. (org-match-string-no-properties 1)))
  185. (arguments (org-match-string-no-properties 3))
  186. (keywords (org-element-collect-affiliated-keywords))
  187. (begin (car keywords))
  188. (contents-begin (progn (forward-line) (point)))
  189. (hidden (org-truely-invisible-p))
  190. (contents-end (progn (re-search-forward org-dblock-end-re nil t)
  191. (point-at-bol)))
  192. (pos-before-blank (progn (forward-line) (point)))
  193. (end (progn (org-skip-whitespace)
  194. (if (eobp) (point) (point-at-bol)))))
  195. (list 'dynamic-block
  196. `(:begin ,begin
  197. :end ,end
  198. :block-name ,name
  199. :arguments ,arguments
  200. :hiddenp ,hidden
  201. :contents-begin ,contents-begin
  202. :contents-end ,contents-end
  203. :post-blank ,(count-lines pos-before-blank end)
  204. ,@(cadr keywords))))))
  205. (defun org-element-dynamic-block-interpreter (dynamic-block contents)
  206. "Interpret DYNAMIC-BLOCK element as Org syntax.
  207. CONTENTS is the contents of the element."
  208. (format "#+BEGIN: %s%s\n%s#+END:"
  209. (org-element-get-property :block-name dynamic-block)
  210. (let ((args (org-element-get-property :arguments dynamic-block)))
  211. (and arg (concat " " args)))
  212. contents))
  213. ;;;; Footnote Definition
  214. (defun org-element-footnote-definition-parser ()
  215. "Parse a footnote definition.
  216. Return a list whose car is `footnote-definition' and cdr is
  217. a plist containing `:label', `:begin' `:end', `:contents-begin',
  218. `:contents-end' and `:post-blank' keywords."
  219. (save-excursion
  220. (let* ((f-def (org-footnote-at-definition-p))
  221. (label (car f-def))
  222. (keywords (progn (goto-char (nth 1 f-def))
  223. (org-element-collect-affiliated-keywords)))
  224. (begin (car keywords))
  225. (contents-begin (progn (looking-at (concat "\\[" label "\\]"))
  226. (goto-char (match-end 0))
  227. (org-skip-whitespace)
  228. (point)))
  229. (end (goto-char (nth 2 f-def)))
  230. (contents-end (progn (skip-chars-backward " \r\t\n")
  231. (forward-line)
  232. (point))))
  233. (list 'footnote-definition
  234. `(:label ,label
  235. :begin ,begin
  236. :end ,end
  237. :contents-begin ,contents-begin
  238. :contents-end ,contents-end
  239. :post-blank ,(count-lines contents-end end)
  240. ,@(cadr keywords))))))
  241. (defun org-element-footnote-definition-interpreter (footnote-definition contents)
  242. "Interpret FOOTNOTE-DEFINITION element as Org syntax.
  243. CONTENTS is the contents of the footnote-definition."
  244. (concat (format "[%s]" (org-element-get-property :label footnote-definition))
  245. " "
  246. contents))
  247. ;;;; Headline
  248. (defun org-element-headline-parser ()
  249. "Parse an headline.
  250. Return a list whose car is `headline' and cdr is a plist
  251. containing `:raw-value', `:title', `:begin', `:end',
  252. `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
  253. `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
  254. `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
  255. `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
  256. keywords.
  257. The plist also contains any property set in the property drawer,
  258. with its name in lowercase, the underscores replaced with hyphens
  259. and colons at the beginning (i.e. `:custom-id').
  260. Assume point is at beginning of the headline."
  261. (save-excursion
  262. (let* ((components (org-heading-components))
  263. (level (nth 1 components))
  264. (todo (nth 2 components))
  265. (todo-type (and todo
  266. (if (member todo org-done-keywords) 'done 'todo)))
  267. (tags (nth 5 components))
  268. (raw-value (nth 4 components))
  269. (quotedp (string-match (format "^%s +" org-quote-string) raw-value))
  270. (commentedp (string-match
  271. (format "^%s +" org-comment-string) raw-value))
  272. (archivedp (and tags
  273. (string-match (format ":%s:" org-archive-tag) tags)))
  274. (footnote-section-p (and org-footnote-section
  275. (string= org-footnote-section raw-value)))
  276. (standard-props (let (plist)
  277. (mapc
  278. (lambda (p)
  279. (let ((p-name (downcase (car p))))
  280. (while (string-match "_" p-name)
  281. (setq p-name
  282. (replace-match "-" nil nil p-name)))
  283. (setq p-name (intern (concat ":" p-name)))
  284. (setq plist
  285. (plist-put plist p-name (cdr p)))))
  286. (org-entry-properties nil 'standard))
  287. plist))
  288. (time-props (org-entry-properties nil 'special "CLOCK"))
  289. (scheduled (cdr (assoc "SCHEDULED" time-props)))
  290. (deadline (cdr (assoc "DEADLINE" time-props)))
  291. (clock (cdr (assoc "CLOCK" time-props)))
  292. (timestamp (cdr (assoc "TIMESTAMP" time-props)))
  293. (begin (point))
  294. (pos-after-head (save-excursion (forward-line) (point)))
  295. (contents-begin (save-excursion (forward-line)
  296. (org-skip-whitespace)
  297. (if (eobp) (point) (point-at-bol))))
  298. (hidden (save-excursion (forward-line) (org-truely-invisible-p)))
  299. (end (progn (goto-char (org-end-of-subtree t t))))
  300. (contents-end (progn (skip-chars-backward " \r\t\n")
  301. (forward-line)
  302. (point)))
  303. title)
  304. ;; Clean RAW-VALUE from any quote or comment string.
  305. (when (or quotedp commentedp)
  306. (setq raw-value
  307. (replace-regexp-in-string
  308. (concat "\\(" org-quote-string "\\|" org-comment-string "\\) +")
  309. ""
  310. raw-value)))
  311. ;; Clean TAGS from archive tag, if any.
  312. (when archivedp
  313. (setq tags
  314. (and (not (string= tags (format ":%s:" org-archive-tag)))
  315. (replace-regexp-in-string
  316. (concat org-archive-tag ":") "" tags)))
  317. (when (string= tags ":") (setq tags nil)))
  318. ;; Then get TITLE.
  319. (setq title (org-element-parse-secondary-string
  320. raw-value
  321. (cdr (assq 'headline org-element-string-restrictions))))
  322. (list 'headline
  323. `(:raw-value ,raw-value
  324. :title ,title
  325. :begin ,begin
  326. :end ,end
  327. :pre-blank ,(count-lines pos-after-head contents-begin)
  328. :hiddenp ,hidden
  329. :contents-begin ,contents-begin
  330. :contents-end ,contents-end
  331. :level ,level
  332. :priority ,(nth 3 components)
  333. :tags ,tags
  334. :todo-keyword ,todo
  335. :todo-type ,todo-type
  336. :scheduled ,scheduled
  337. :deadline ,deadline
  338. :timestamp ,timestamp
  339. :clock ,clock
  340. :post-blank ,(count-lines contents-end end)
  341. :footnote-section-p ,footnote-section-p
  342. :archivedp ,archivedp
  343. :commentedp ,commentedp
  344. :quotedp ,quotedp
  345. ,@standard-props)))))
  346. (defun org-element-headline-interpreter (headline contents)
  347. "Interpret HEADLINE element as Org syntax.
  348. CONTENTS is the contents of the element."
  349. (let* ((level (org-element-get-property :level headline))
  350. (todo (org-element-get-property :todo-keyword headline))
  351. (priority (org-element-get-property :priority headline))
  352. (title (org-element-get-property :raw-value headline))
  353. (tags (let ((tag-string (org-element-get-property :tags headline))
  354. (archivedp (org-element-get-property :archivedp headline)))
  355. (cond
  356. ((and (not tag-string) archivedp)
  357. (format ":%s:" org-archive-tag))
  358. (archivedp (concat ":" org-archive-tag tag-string))
  359. (t tag-string))))
  360. (commentedp (org-element-get-property :commentedp headline))
  361. (quotedp (org-element-get-property :quotedp headline))
  362. (pre-blank (org-element-get-property :pre-blank headline))
  363. (heading (concat (make-string level ?*)
  364. (and todo (concat " " todo))
  365. (and quotedp (concat " " org-quote-string))
  366. (and commentedp (concat " " org-comment-string))
  367. (and priority (concat " " priority))
  368. (cond ((and org-footnote-section
  369. (org-element-get-property
  370. :footnote-section-p headline))
  371. (concat " " org-footnote-section))
  372. (title (concat " " title)))))
  373. ;; Align tags.
  374. (tags-fmt (when tags
  375. (let ((tags-len (length tags)))
  376. (format "%% %ds"
  377. (cond
  378. ((zerop org-tags-column) (1+ tags-len))
  379. ((< org-tags-column 0)
  380. (max (- (+ org-tags-column (length heading)))
  381. (1+ tags-len)))
  382. (t (max (+ (- org-tags-column (length heading))
  383. tags-len)
  384. (1+ tags-len)))))))))
  385. (concat heading (and tags (format tags-fmt tags))
  386. (make-string (1+ pre-blank) 10)
  387. contents)))
  388. ;;;; Inlinetask
  389. (defun org-element-inlinetask-parser ()
  390. "Parse an inline task.
  391. Return a list whose car is `inlinetask' and cdr is a plist
  392. containing `:raw-value', `:title', `:begin', `:end', `:hiddenp',
  393. `:contents-begin' and `:contents-end', `:level', `:priority',
  394. `:raw-value', `:tags', `:todo-keyword', `:todo-type',
  395. `:scheduled', `:deadline', `:timestamp', `:clock' and
  396. `:post-blank' keywords.
  397. The plist also contains any property set in the property drawer,
  398. with its name in lowercase, the underscores replaced with hyphens
  399. and colons at the beginning (i.e. `:custom-id').
  400. Assume point is at beginning of the inline task."
  401. (save-excursion
  402. (let* ((keywords (org-element-collect-affiliated-keywords))
  403. (begin (car keywords))
  404. (components (org-heading-components))
  405. (todo (nth 2 components))
  406. (todo-type (and todo
  407. (if (member todo org-done-keywords) 'done 'todo)))
  408. (raw-value (nth 4 components))
  409. (standard-props (let (plist)
  410. (mapc
  411. (lambda (p)
  412. (let ((p-name (downcase (car p))))
  413. (while (string-match "_" p-name)
  414. (setq p-name
  415. (replace-match "-" nil nil p-name)))
  416. (setq p-name (intern (concat ":" p-name)))
  417. (setq plist
  418. (plist-put plist p-name (cdr p)))))
  419. (org-entry-properties nil 'standard))
  420. plist))
  421. (time-props (org-entry-properties nil 'special "CLOCK"))
  422. (scheduled (cdr (assoc "SCHEDULED" time-props)))
  423. (deadline (cdr (assoc "DEADLINE" time-props)))
  424. (clock (cdr (assoc "CLOCK" time-props)))
  425. (timestamp (cdr (assoc "TIMESTAMP" time-props)))
  426. (title (org-element-parse-secondary-string
  427. raw-value
  428. (cdr (assq 'inlinetask org-element-string-restrictions))))
  429. (contents-begin (save-excursion (forward-line) (point)))
  430. (hidden (org-truely-invisible-p))
  431. (pos-before-blank (org-inlinetask-goto-end))
  432. ;; In the case of a single line task, CONTENTS-BEGIN and
  433. ;; CONTENTS-END might overlap.
  434. (contents-end (max contents-begin
  435. (save-excursion (forward-line -1) (point))))
  436. (end (progn (org-skip-whitespace)
  437. (if (eobp) (point) (point-at-bol)))))
  438. (list 'inlinetask
  439. `(:raw-value ,raw-value
  440. :title ,title
  441. :begin ,begin
  442. :end ,end
  443. :hiddenp ,(and (> contents-end contents-begin) hidden)
  444. :contents-begin ,contents-begin
  445. :contents-end ,contents-end
  446. :level ,(nth 1 components)
  447. :priority ,(nth 3 components)
  448. :tags ,(nth 5 components)
  449. :todo-keyword ,todo
  450. :todo-type ,todo-type
  451. :scheduled ,scheduled
  452. :deadline ,deadline
  453. :timestamp ,timestamp
  454. :clock ,clock
  455. :post-blank ,(count-lines pos-before-blank end)
  456. ,@standard-props
  457. ,@(cadr keywords))))))
  458. (defun org-element-inlinetask-interpreter (inlinetask contents)
  459. "Interpret INLINETASK element as Org syntax.
  460. CONTENTS is the contents of inlinetask."
  461. (let* ((level (org-element-get-property :level inlinetask))
  462. (todo (org-element-get-property :todo-keyword inlinetask))
  463. (priority (org-element-get-property :priority inlinetask))
  464. (title (org-element-get-property :raw-value inlinetask))
  465. (tags (org-element-get-property :tags inlinetask))
  466. (task (concat (make-string level ?*)
  467. (and todo (concat " " todo))
  468. (and priority (concat " " priority))
  469. (and title (concat " " title))))
  470. ;; Align tags.
  471. (tags-fmt (when tags
  472. (format "%% %ds"
  473. (cond
  474. ((zerop org-tags-column) 1)
  475. ((< 0 org-tags-column)
  476. (max (+ org-tags-column
  477. (length inlinetask)
  478. (length tags))
  479. 1))
  480. (t (max (- org-tags-column (length inlinetask))
  481. 1)))))))
  482. (concat inlinetask (and tags (format tags-fmt tags) "\n" contents))))
  483. ;;;; Item
  484. (defun org-element-item-parser (struct)
  485. "Parse an item.
  486. STRUCT is the structure of the plain list.
  487. Return a list whose car is `item' and cdr is a plist containing
  488. `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
  489. `:checkbox', `:counter', `:tag', `:raw-tag', `:structure',
  490. `:hiddenp' and `:post-blank' keywords.
  491. Assume point is at the beginning of the item."
  492. (save-excursion
  493. (beginning-of-line)
  494. (let* ((begin (point))
  495. (bullet (org-list-get-bullet (point) struct))
  496. (checkbox (let ((box (org-list-get-checkbox begin struct)))
  497. (cond ((equal "[ ]" box) 'off)
  498. ((equal "[X]" box) 'on)
  499. ((equal "[-]" box) 'trans))))
  500. (counter (let ((c (org-list-get-counter begin struct)))
  501. (cond
  502. ((not c) nil)
  503. ((string-match "[A-Za-z]" c)
  504. (- (string-to-char (upcase (match-string 0 c)))
  505. 64))
  506. ((string-match "[0-9]+" c)
  507. (string-to-number (match-string 0 c))))))
  508. (raw-tag (org-list-get-tag begin struct))
  509. (tag (and raw-tag
  510. (org-element-parse-secondary-string
  511. raw-tag
  512. (cdr (assq 'item org-element-string-restrictions)))))
  513. (end (org-list-get-item-end begin struct))
  514. (contents-begin (progn (looking-at org-list-full-item-re)
  515. (goto-char (match-end 0))
  516. (org-skip-whitespace)
  517. (if (>= (point) end)
  518. (point-at-bol)
  519. (point))))
  520. (hidden (progn (forward-line)
  521. (and (not (= (point) end))
  522. (org-truely-invisible-p))))
  523. (contents-end (progn (goto-char end)
  524. (skip-chars-backward " \r\t\n")
  525. (forward-line)
  526. (point))))
  527. (list 'item
  528. `(:bullet ,bullet
  529. :begin ,begin
  530. :end ,end
  531. ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
  532. ;; up in the case of an empty item separated
  533. ;; from the next by a blank line. Thus, ensure
  534. ;; the former is always the smallest of two.
  535. :contents-begin ,(min contents-begin contents-end)
  536. :contents-end ,(max contents-begin contents-end)
  537. :checkbox ,checkbox
  538. :counter ,counter
  539. :raw-tag ,raw-tag
  540. :tag ,tag
  541. :hiddenp ,hidden
  542. :structure ,struct
  543. :post-blank ,(count-lines contents-end end))))))
  544. (defun org-element-item-interpreter (item contents)
  545. "Interpret ITEM element as Org syntax.
  546. CONTENTS is the contents of the element."
  547. (let* ((bullet (org-element-get-property :bullet item))
  548. (checkbox (org-element-get-property :checkbox item))
  549. (counter (org-element-get-property :counter item))
  550. (tag (org-element-get-property :raw-tag item))
  551. ;; Compute indentation.
  552. (ind (make-string (length bullet) 32)))
  553. ;; Indent contents.
  554. (concat
  555. bullet
  556. (when (and org-list-two-spaces-after-bullet-regexp
  557. (string-match org-list-two-spaces-after-bullet-regexp bullet))
  558. " ")
  559. (and counter (format "[@%d] " counter))
  560. (cond
  561. ((eq checkbox 'on) "[X] ")
  562. ((eq checkbox 'off) "[ ] ")
  563. ((eq checkbox 'trans) "[-] "))
  564. (and tag (format "%s :: " tag))
  565. (org-trim
  566. (replace-regexp-in-string
  567. "\\(^\\)[ \t]*\\S-" ind contents nil nil 1)))))
  568. ;;;; Plain List
  569. (defun org-element-plain-list-parser (&optional structure)
  570. "Parse a plain list.
  571. Return a list whose car is `plain-list' and cdr is a plist
  572. containing `:type', `:begin', `:end', `:contents-begin' and
  573. `:contents-end', `:level', `:structure' and `:post-blank'
  574. keywords.
  575. Assume point is at one of the list items."
  576. (save-excursion
  577. (let* ((struct (or structure (org-list-struct)))
  578. (prevs (org-list-prevs-alist struct))
  579. (parents (org-list-parents-alist struct))
  580. (type (org-list-get-list-type (point) struct prevs))
  581. (contents-begin (goto-char
  582. (org-list-get-list-begin (point) struct prevs)))
  583. (keywords (org-element-collect-affiliated-keywords))
  584. (begin (car keywords))
  585. (contents-end (goto-char
  586. (org-list-get-list-end (point) struct prevs)))
  587. (end (save-excursion (org-skip-whitespace)
  588. (if (eobp) (point) (point-at-bol))))
  589. (level 0))
  590. ;; Get list level.
  591. (let ((item contents-begin))
  592. (while (setq item
  593. (org-list-get-parent
  594. (org-list-get-list-begin item struct prevs)
  595. struct parents))
  596. (incf level)))
  597. ;; Blank lines below list belong to the top-level list only.
  598. (when (> level 0)
  599. (setq end (min (org-list-get-bottom-point struct)
  600. (progn (org-skip-whitespace)
  601. (if (eobp) (point) (point-at-bol))))))
  602. ;; Return value.
  603. (list 'plain-list
  604. `(:type ,type
  605. :begin ,begin
  606. :end ,end
  607. :contents-begin ,contents-begin
  608. :contents-end ,contents-end
  609. :level ,level
  610. :structure ,struct
  611. :post-blank ,(count-lines contents-end end)
  612. ,@(cadr keywords))))))
  613. (defun org-element-plain-list-interpreter (plain-list contents)
  614. "Interpret PLAIN-LIST element as Org syntax.
  615. CONTENTS is the contents of the element."
  616. contents)
  617. ;;;; Quote Block
  618. (defun org-element-quote-block-parser ()
  619. "Parse a quote block.
  620. Return a list whose car is `quote-block' and cdr is a plist
  621. containing `:begin', `:end', `:hiddenp', `:contents-begin',
  622. `:contents-end' and `:post-blank' keywords.
  623. Assume point is at beginning or end of the block."
  624. (save-excursion
  625. (let* ((case-fold-search t)
  626. (keywords (progn
  627. (end-of-line)
  628. (re-search-backward
  629. (concat "^[ \t]*#\\+begin_quote") nil t)
  630. (org-element-collect-affiliated-keywords)))
  631. (begin (car keywords))
  632. (contents-begin (progn (forward-line) (point)))
  633. (hidden (org-truely-invisible-p))
  634. (contents-end (progn (re-search-forward
  635. (concat "^[ \t]*#\\+end_quote") nil t)
  636. (point-at-bol)))
  637. (pos-before-blank (progn (forward-line) (point)))
  638. (end (progn (org-skip-whitespace)
  639. (if (eobp) (point) (point-at-bol)))))
  640. (list 'quote-block
  641. `(:begin ,begin
  642. :end ,end
  643. :hiddenp ,hidden
  644. :contents-begin ,contents-begin
  645. :contents-end ,contents-end
  646. :post-blank ,(count-lines pos-before-blank end)
  647. ,@(cadr keywords))))))
  648. (defun org-element-quote-block-interpreter (quote-block contents)
  649. "Interpret QUOTE-BLOCK element as Org syntax.
  650. CONTENTS is the contents of the element."
  651. (format "#+begin_quote\n%s#+end_quote" contents))
  652. ;;;; Section
  653. (defun org-element-section-parser ()
  654. "Parse a section.
  655. Return a list whose car is `section' and cdr is a plist
  656. containing `:begin', `:end', `:contents-begin', `contents-end'
  657. and `:post-blank' keywords."
  658. (save-excursion
  659. ;; Beginning of section is the beginning of the first non-blank
  660. ;; line after previous headline.
  661. (let ((begin (save-excursion
  662. (org-with-limited-levels (outline-previous-heading))
  663. (if (not (org-at-heading-p)) (point)
  664. (forward-line) (org-skip-whitespace) (point-at-bol))))
  665. (end (progn (org-with-limited-levels (outline-next-heading))
  666. (point)))
  667. (pos-before-blank (progn (skip-chars-backward " \r\t\n")
  668. (forward-line)
  669. (point))))
  670. (list 'section
  671. `(:begin ,begin
  672. :end ,end
  673. :contents-begin ,begin
  674. :contents-end ,pos-before-blank
  675. :post-blank ,(count-lines pos-before-blank end))))))
  676. (defun org-element-section-interpreter (section contents)
  677. "Interpret SECTION element as Org syntax.
  678. CONTENTS is the contents of the element."
  679. contents)
  680. ;;;; Special Block
  681. (defun org-element-special-block-parser ()
  682. "Parse a special block.
  683. Return a list whose car is `special-block' and cdr is a plist
  684. containing `:type', `:begin', `:end', `:hiddenp',
  685. `:contents-begin', `:contents-end' and `:post-blank' keywords.
  686. Assume point is at beginning or end of the block."
  687. (save-excursion
  688. (let* ((case-fold-search t)
  689. (type (progn (looking-at
  690. "[ \t]*#\\+\\(?:begin\\|end\\)_\\([-A-Za-z0-9]+\\)")
  691. (org-match-string-no-properties 1)))
  692. (keywords (progn
  693. (end-of-line)
  694. (re-search-backward
  695. (concat "^[ \t]*#\\+begin_" type) nil t)
  696. (org-element-collect-affiliated-keywords)))
  697. (begin (car keywords))
  698. (contents-begin (progn (forward-line) (point)))
  699. (hidden (org-truely-invisible-p))
  700. (contents-end (progn (re-search-forward
  701. (concat "^[ \t]*#\\+end_" type) nil t)
  702. (point-at-bol)))
  703. (pos-before-blank (progn (forward-line) (point)))
  704. (end (progn (org-skip-whitespace)
  705. (if (eobp) (point) (point-at-bol)))))
  706. (list 'special-block
  707. `(:type ,type
  708. :begin ,begin
  709. :end ,end
  710. :hiddenp ,hidden
  711. :contents-begin ,contents-begin
  712. :contents-end ,contents-end
  713. :post-blank ,(count-lines pos-before-blank end)
  714. ,@(cadr keywords))))))
  715. (defun org-element-special-block-interpreter (special-block contents)
  716. "Interpret SPECIAL-BLOCK element as Org syntax.
  717. CONTENTS is the contents of the element."
  718. (let ((block-type (org-element-get-property :type special-block)))
  719. (format "#+begin_%s\n%s#+end_%s" block-type contents block-type)))
  720. ;;; Elements
  721. ;; For each element, a parser and an interpreter are also defined.
  722. ;; Both follow the same naming convention used for greater elements.
  723. ;; Also, as for greater elements, adding a new element type is done
  724. ;; through the following steps: implement a parser and an interpreter,
  725. ;; tweak `org-element-guess-type' so that it recognizes the new type
  726. ;; and add that new type to `org-element-all-elements'.
  727. ;; As a special case, when the newly defined type is a block type,
  728. ;; `org-element-non-recursive-block-alist' has to be modified
  729. ;; accordingly.
  730. ;;;; Babel Call
  731. (defun org-element-babel-call-parser ()
  732. "Parse a babel call.
  733. Return a list whose car is `babel-call' and cdr is a plist
  734. containing `:begin', `:end', `:info' and `:post-blank' as
  735. keywords."
  736. (save-excursion
  737. (let ((info (progn (looking-at org-babel-block-lob-one-liner-regexp)
  738. (org-babel-lob-get-info)))
  739. (beg (point-at-bol))
  740. (pos-before-blank (progn (forward-line) (point)))
  741. (end (progn (org-skip-whitespace)
  742. (if (eobp) (point) (point-at-bol)))))
  743. (list 'babel-call
  744. `(:beg ,beg
  745. :end ,end
  746. :info ,info
  747. :post-blank ,(count-lines pos-before-blank end))))))
  748. (defun org-element-babel-call-interpreter (inline-babel-call contents)
  749. "Interpret INLINE-BABEL-CALL object as Org syntax.
  750. CONTENTS is nil."
  751. (let* ((babel-info (org-element-get-property :info inline-babel-call))
  752. (main-source (car babel-info))
  753. (post-options (nth 1 babel-info)))
  754. (concat "#+call: "
  755. (if (string-match "\\[\\(\\[.*?\\]\\)\\]" main-source)
  756. ;; Remove redundant square brackets.
  757. (replace-match
  758. (match-string 1 main-source) nil nil main-source)
  759. main-source)
  760. (and post-options (format "[%s]" post-options)))))
  761. ;;;; Comment
  762. (defun org-element-comment-parser ()
  763. "Parse a comment.
  764. Return a list whose car is `comment' and cdr is a plist
  765. containing `:begin', `:end', `:value' and `:post-blank'
  766. keywords."
  767. (let ((comment-re "\\(#\\|[ \t]*#\\+\\( \\|$\\)\\)")
  768. beg-coms begin end value pos-before-blank keywords)
  769. (save-excursion
  770. ;; Move to the beginning of comments.
  771. (unless (bobp)
  772. (while (and (not (bobp)) (looking-at comment-re))
  773. (forward-line -1))
  774. (unless (looking-at comment-re) (forward-line 1)))
  775. (setq beg-coms (point))
  776. ;; Get affiliated keywords, if any.
  777. (setq keywords (org-element-collect-affiliated-keywords))
  778. ;; Store true beginning of element.
  779. (setq begin (car keywords))
  780. ;; Get ending of comments. If point is in a list, ensure to not
  781. ;; get outside of it.
  782. (let* ((itemp (org-in-item-p))
  783. (max-pos (if itemp
  784. (org-list-get-bottom-point
  785. (save-excursion (goto-char itemp) (org-list-struct)))
  786. (point-max))))
  787. (while (and (looking-at comment-re) (< (point) max-pos))
  788. (forward-line)))
  789. (setq pos-before-blank (point))
  790. ;; Find position after blank.
  791. (org-skip-whitespace)
  792. (setq end (if (eobp) (point) (point-at-bol)))
  793. ;; Extract value.
  794. (setq value (buffer-substring-no-properties beg-coms pos-before-blank)))
  795. (list 'comment
  796. `(:begin ,begin
  797. :end ,end
  798. :value ,value
  799. :post-blank ,(count-lines pos-before-blank end)
  800. ,@(cadr keywords)))))
  801. (defun org-element-comment-interpreter (comment contents)
  802. "Interpret COMMENT element as Org syntax.
  803. CONTENTS is nil."
  804. (org-element-get-property :value comment))
  805. ;;;; Comment Block
  806. (defun org-element-comment-block-parser ()
  807. "Parse an export block.
  808. Return a list whose car is `comment-block' and cdr is a plist
  809. containing `:begin', `:end', `:hiddenp', `:value' and
  810. `:post-blank' keywords."
  811. (save-excursion
  812. (end-of-line)
  813. (let* ((case-fold-search t)
  814. (keywords (progn
  815. (re-search-backward "^[ \t]*#\\+begin_comment" nil t)
  816. (org-element-collect-affiliated-keywords)))
  817. (begin (car keywords))
  818. (contents-begin (progn (forward-line) (point)))
  819. (hidden (org-truely-invisible-p))
  820. (contents-end (progn (re-search-forward
  821. "^[ \t]*#\\+end_comment" nil t)
  822. (point-at-bol)))
  823. (pos-before-blank (progn (forward-line) (point)))
  824. (end (progn (org-skip-whitespace)
  825. (if (eobp) (point) (point-at-bol))))
  826. (value (buffer-substring-no-properties contents-begin contents-end)))
  827. (list 'comment-block
  828. `(:begin ,begin
  829. :end ,end
  830. :value ,value
  831. :hiddenp ,hidden
  832. :post-blank ,(count-lines pos-before-blank end)
  833. ,@(cadr keywords))))))
  834. (defun org-element-comment-block-interpreter (comment-block contents)
  835. "Interpret COMMENT-BLOCK element as Org syntax.
  836. CONTENTS is nil."
  837. (concat "#+begin_comment\n"
  838. (org-remove-indentation
  839. (org-element-get-property :value comment-block))
  840. "#+begin_comment"))
  841. ;;;; Example Block
  842. (defun org-element-example-block-parser ()
  843. "Parse an example block.
  844. Return a list whose car is `example' and cdr is a plist
  845. containing `:begin', `:end', `:options', `:hiddenp', `:value' and
  846. `:post-blank' keywords."
  847. (save-excursion
  848. (end-of-line)
  849. (let* ((case-fold-search t)
  850. (options (progn
  851. (re-search-backward
  852. "^[ \t]*#\\+begin_example\\(?: +\\(.*\\)\\)?" nil t)
  853. (org-match-string-no-properties 1)))
  854. (keywords (org-element-collect-affiliated-keywords))
  855. (begin (car keywords))
  856. (contents-begin (progn (forward-line) (point)))
  857. (hidden (org-truely-invisible-p))
  858. (contents-end (progn
  859. (re-search-forward "^[ \t]*#\\+end_example" nil t)
  860. (point-at-bol)))
  861. (value (buffer-substring-no-properties contents-begin contents-end))
  862. (pos-before-blank (progn (forward-line) (point)))
  863. (end (progn (org-skip-whitespace)
  864. (if (eobp) (point) (point-at-bol)))))
  865. (list 'example-block
  866. `(:begin ,begin
  867. :end ,end
  868. :value ,value
  869. :options ,options
  870. :hiddenp ,hidden
  871. :post-blank ,(count-lines pos-before-blank end)
  872. ,@(cadr keywords))))))
  873. (defun org-element-example-block-interpreter (example-block contents)
  874. "Interpret EXAMPLE-BLOCK element as Org syntax.
  875. CONTENTS is nil."
  876. (let ((options (org-element-get-property :options example-block)))
  877. (concat "#+begin_example" (and options (concat " " options)) "\n"
  878. (org-remove-indentation
  879. (org-element-get-property :value example-block))
  880. "#+end_example")))
  881. ;;;; Export Block
  882. (defun org-element-export-block-parser ()
  883. "Parse an export block.
  884. Return a list whose car is `export-block' and cdr is a plist
  885. containing `:begin', `:end', `:type', `:hiddenp', `:value' and
  886. `:post-blank' keywords."
  887. (save-excursion
  888. (end-of-line)
  889. (let* ((case-fold-search t)
  890. (contents)
  891. (type (progn (re-search-backward
  892. (concat "[ \t]*#\\+begin_"
  893. (org-re "\\([[:alnum:]]+\\)")))
  894. (downcase (org-match-string-no-properties 1))))
  895. (keywords (org-element-collect-affiliated-keywords))
  896. (begin (car keywords))
  897. (contents-begin (progn (forward-line) (point)))
  898. (hidden (org-truely-invisible-p))
  899. (contents-end (progn (re-search-forward
  900. (concat "^[ \t]*#\\+end_" type) nil t)
  901. (point-at-bol)))
  902. (pos-before-blank (progn (forward-line) (point)))
  903. (end (progn (org-skip-whitespace)
  904. (if (eobp) (point) (point-at-bol))))
  905. (value (buffer-substring-no-properties contents-begin contents-end)))
  906. (list 'export-block
  907. `(:begin ,begin
  908. :end ,end
  909. :type ,type
  910. :value ,value
  911. :hiddenp ,hidden
  912. :post-blank ,(count-lines pos-before-blank end)
  913. ,@(cadr keywords))))))
  914. (defun org-element-export-block-interpreter (export-block contents)
  915. "Interpret EXPORT-BLOCK element as Org syntax.
  916. CONTENTS is nil."
  917. (let ((type (org-element-get-property :type export-block)))
  918. (concat (format "#+begin_%s\n" type)
  919. (org-element-get-property :value export-block)
  920. (format "#+end_%s" type))))
  921. ;;;; Fixed-width
  922. (defun org-element-fixed-width-parser ()
  923. "Parse a fixed-width section.
  924. Return a list whose car is `fixed-width' and cdr is a plist
  925. containing `:begin', `:end', `:value' and `:post-blank'
  926. keywords."
  927. (let ((fixed-re "[ \t]*:\\( \\|$\\)")
  928. beg-area begin end value pos-before-blank keywords)
  929. (save-excursion
  930. ;; Move to the beginning of the fixed-width area.
  931. (unless (bobp)
  932. (while (and (not (bobp)) (looking-at fixed-re))
  933. (forward-line -1))
  934. (unless (looking-at fixed-re) (forward-line 1)))
  935. (setq beg-area (point))
  936. ;; Get affiliated keywords, if any.
  937. (setq keywords (org-element-collect-affiliated-keywords))
  938. ;; Store true beginning of element.
  939. (setq begin (car keywords))
  940. ;; Get ending of fixed-width area. If point is in a list,
  941. ;; ensure to not get outside of it.
  942. (let* ((itemp (org-in-item-p))
  943. (max-pos (if itemp
  944. (org-list-get-bottom-point
  945. (save-excursion (goto-char itemp) (org-list-struct)))
  946. (point-max))))
  947. (while (and (looking-at fixed-re) (< (point) max-pos))
  948. (forward-line)))
  949. (setq pos-before-blank (point))
  950. ;; Find position after blank
  951. (org-skip-whitespace)
  952. (setq end (if (eobp) (point) (point-at-bol)))
  953. ;; Extract value.
  954. (setq value (buffer-substring-no-properties beg-area pos-before-blank)))
  955. (list 'fixed-width
  956. `(:begin ,begin
  957. :end ,end
  958. :value ,value
  959. :post-blank ,(count-lines pos-before-blank end)
  960. ,@(cadr keywords)))))
  961. (defun org-element-fixed-width-interpreter (fixed-width contents)
  962. "Interpret FIXED-WIDTH element as Org syntax.
  963. CONTENTS is nil."
  964. (org-remove-indentation (org-element-get-property :value fixed-width)))
  965. ;;;; Horizontal Rule
  966. (defun org-element-horizontal-rule-parser ()
  967. "Parse an horizontal rule.
  968. Return a list whose car is `horizontal-rule' and cdr is
  969. a plist containing `:begin', `:end' and `:post-blank'
  970. keywords."
  971. (save-excursion
  972. (let* ((keywords (org-element-collect-affiliated-keywords))
  973. (begin (car keywords))
  974. (post-hr (progn (forward-line) (point)))
  975. (end (progn (org-skip-whitespace)
  976. (if (eobp) (point) (point-at-bol)))))
  977. (list 'horizontal-rule
  978. `(:begin ,begin
  979. :end ,end
  980. :post-blank ,(count-lines post-hr end)
  981. ,@(cadr keywords))))))
  982. (defun org-element-horizontal-rule-interpreter (horizontal-rule contents)
  983. "Interpret HORIZONTAL-RULE element as Org syntax.
  984. CONTENTS is nil."
  985. "-----")
  986. ;;;; Keyword
  987. (defun org-element-keyword-parser ()
  988. "Parse a keyword at point.
  989. Return a list whose car is `keyword' and cdr is a plist
  990. containing `:key', `:value', `:begin', `:end' and `:post-blank'
  991. keywords."
  992. (save-excursion
  993. (let* ((begin (point))
  994. (key (progn (looking-at
  995. "[ \t]*#\\+\\(\\(?:[a-z]+\\)\\(?:_[a-z]+\\)*\\):")
  996. (org-match-string-no-properties 1)))
  997. (value (org-trim (buffer-substring-no-properties
  998. (match-end 0) (point-at-eol))))
  999. (pos-before-blank (progn (forward-line) (point)))
  1000. (end (progn (org-skip-whitespace)
  1001. (if (eobp) (point) (point-at-bol)))))
  1002. (list 'keyword
  1003. `(:key ,key
  1004. :value ,value
  1005. :begin ,begin
  1006. :end ,end
  1007. :post-blank ,(count-lines pos-before-blank end))))))
  1008. (defun org-element-keyword-interpreter (keyword contents)
  1009. "Interpret KEYWORD element as Org syntax.
  1010. CONTENTS is nil."
  1011. (format "#+%s: %s"
  1012. (org-element-get-property :key keyword)
  1013. (org-element-get-property :value keyword)))
  1014. ;;;; Latex Environment
  1015. (defun org-element-latex-environment-parser ()
  1016. "Parse a LaTeX environment.
  1017. Return a list whose car is `latex-environment' and cdr is a plist
  1018. containing `:begin', `:end', `:value' and `:post-blank' keywords."
  1019. (save-excursion
  1020. (end-of-line)
  1021. (let* ((case-fold-search t)
  1022. (contents-begin (re-search-backward "^[ \t]*\\\\begin" nil t))
  1023. (keywords (org-element-collect-affiliated-keywords))
  1024. (begin (car keywords))
  1025. (contents-end (progn (re-search-forward "^[ \t]*\\\\end")
  1026. (forward-line)
  1027. (point)))
  1028. (value (buffer-substring-no-properties contents-begin contents-end))
  1029. (end (progn (org-skip-whitespace)
  1030. (if (eobp) (point) (point-at-bol)))))
  1031. (list 'latex-environment
  1032. `(:begin ,begin
  1033. :end ,end
  1034. :value ,value
  1035. :post-blank ,(count-lines contents-end end)
  1036. ,@(cadr keywords))))))
  1037. (defun org-element-latex-environment-interpreter (latex-environment contents)
  1038. "Interpret LATEX-ENVIRONMENT element as Org syntax.
  1039. CONTENTS is nil."
  1040. (org-element-get-property :value latex-environment))
  1041. ;;;; Paragraph
  1042. (defun org-element-paragraph-parser ()
  1043. "Parse a paragraph.
  1044. Return a list whose car is `paragraph' and cdr is a plist
  1045. containing `:begin', `:end', `:contents-begin' and
  1046. `:contents-end' and `:post-blank' keywords.
  1047. Assume point is at the beginning of the paragraph."
  1048. (save-excursion
  1049. (let* ((contents-begin (point))
  1050. (keywords (org-element-collect-affiliated-keywords))
  1051. (begin (car keywords))
  1052. (contents-end (progn
  1053. (end-of-line)
  1054. (if (re-search-forward
  1055. org-element-paragraph-separate nil 'm)
  1056. (progn (forward-line -1) (end-of-line) (point))
  1057. (point))))
  1058. (pos-before-blank (progn (forward-line) (point)))
  1059. (end (progn (org-skip-whitespace)
  1060. (if (eobp) (point) (point-at-bol)))))
  1061. (list 'paragraph
  1062. `(:begin ,begin
  1063. :end ,end
  1064. :contents-begin ,contents-begin
  1065. :contents-end ,contents-end
  1066. :post-blank ,(count-lines pos-before-blank end)
  1067. ,@(cadr keywords))))))
  1068. (defun org-element-paragraph-interpreter (paragraph contents)
  1069. "Interpret PARAGRAPH element as Org syntax.
  1070. CONTENTS is the contents of the element."
  1071. contents)
  1072. ;;;; Property Drawer
  1073. (defun org-element-property-drawer-parser ()
  1074. "Parse a property drawer.
  1075. Return a list whose car is `property-drawer' and cdr is a plist
  1076. containing `:begin', `:end', `:hiddenp', `:contents-begin',
  1077. `:contents-end', `:properties' and `:post-blank' keywords."
  1078. (save-excursion
  1079. (let ((case-fold-search t)
  1080. (begin (progn (end-of-line)
  1081. (re-search-backward org-property-start-re)
  1082. (match-beginning 0)))
  1083. (contents-begin (progn (forward-line) (point)))
  1084. (hidden (org-truely-invisible-p))
  1085. (properties (let (val)
  1086. (while (not (looking-at "^[ \t]*:END:"))
  1087. (when (looking-at
  1088. (org-re
  1089. "[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):"))
  1090. (push (cons (match-string 1)
  1091. (org-trim
  1092. (buffer-substring
  1093. (match-end 0) (point-at-eol))))
  1094. val))
  1095. (forward-line))
  1096. val))
  1097. (contents-end (progn (re-search-forward "^[ \t]*:END:" nil t)
  1098. (point-at-bol)))
  1099. (pos-before-blank (progn (forward-line) (point)))
  1100. (end (progn (org-skip-whitespace)
  1101. (if (eobp) (point) (point-at-bol)))))
  1102. (list 'property-drawer
  1103. `(:begin ,begin
  1104. :end ,end
  1105. :hiddenp ,hidden
  1106. :properties ,properties
  1107. :post-blank ,(count-lines pos-before-blank end))))))
  1108. (defun org-element-property-drawer-interpreter (property-drawer contents)
  1109. "Interpret PROPERTY-DRAWER element as Org syntax.
  1110. CONTENTS is nil."
  1111. (let ((props (org-element-get-property :properties property-drawer)))
  1112. (concat
  1113. ":PROPERTIES:\n"
  1114. (mapconcat (lambda (p)
  1115. (format org-property-format (format ":%s:" (car p)) (cdr p)))
  1116. (nreverse props) "\n")
  1117. "\n:END:")))
  1118. ;;;; Quote Section
  1119. (defun org-element-quote-section-parser ()
  1120. "Parse a quote section.
  1121. Return a list whose car is `quote-section' and cdr is a plist
  1122. containing `:begin', `:end', `:value' and `:post-blank'
  1123. keywords."
  1124. (save-excursion
  1125. (let* ((begin (progn (org-back-to-heading t)
  1126. (forward-line)
  1127. (org-skip-whitespace)
  1128. (point-at-bol)))
  1129. (end (progn (org-with-limited-levels (outline-next-heading))
  1130. (point)))
  1131. (pos-before-blank (progn (skip-chars-backward " \r\t\n")
  1132. (forward-line)
  1133. (point)))
  1134. (value (unless (= begin end)
  1135. (buffer-substring-no-properties begin pos-before-blank))))
  1136. (list 'quote-section
  1137. `(:begin ,begin
  1138. :end ,end
  1139. :value ,value
  1140. :post-blank ,(if value
  1141. (count-lines pos-before-blank end)
  1142. 0))))))
  1143. (defun org-element-quote-section-interpreter (quote-section contents)
  1144. "Interpret QUOTE-SECTION element as Org syntax.
  1145. CONTENTS is nil."
  1146. (org-element-get-property :value quote-section))
  1147. ;;;; Src Block
  1148. (defun org-element-src-block-parser ()
  1149. "Parse a src block.
  1150. Return a list whose car is `src-block' and cdr is a plist
  1151. containing `:language', `:switches', `:parameters', `:begin',
  1152. `:end', `:hiddenp', `:contents-begin', `:contents-end', `:value'
  1153. and `:post-blank' keywords."
  1154. (save-excursion
  1155. (end-of-line)
  1156. (let* ((case-fold-search t)
  1157. ;; Get position at beginning of block.
  1158. (contents-begin
  1159. (re-search-backward
  1160. (concat "^[ \t]*#\\+begin_src"
  1161. "\\(?: +\\(\\S-+\\)\\)?" ; language
  1162. "\\(\\(?: +[-+][A-Za-z]\\)*\\)" ; switches
  1163. "\\(.*\\)[ \t]*$") ; arguments
  1164. nil t))
  1165. ;; Get language as a string.
  1166. (language (org-match-string-no-properties 1))
  1167. ;; Get switches.
  1168. (switches (org-match-string-no-properties 2))
  1169. ;; Get parameters.
  1170. (parameters (org-trim (org-match-string-no-properties 3)))
  1171. ;; Get affiliated keywords.
  1172. (keywords (org-element-collect-affiliated-keywords))
  1173. ;; Get beginning position.
  1174. (begin (car keywords))
  1175. ;; Get position at end of block.
  1176. (contents-end (progn (re-search-forward "^[ \t]*#\\+end_src" nil t)
  1177. (forward-line)
  1178. (point)))
  1179. ;; Retrieve code.
  1180. (value (buffer-substring-no-properties
  1181. (save-excursion (goto-char contents-begin)
  1182. (forward-line)
  1183. (point))
  1184. (match-beginning 0)))
  1185. ;; Get position after ending blank lines.
  1186. (end (progn (org-skip-whitespace)
  1187. (if (eobp) (point) (point-at-bol))))
  1188. ;; Get visibility status.
  1189. (hidden (progn (goto-char contents-begin)
  1190. (forward-line)
  1191. (org-truely-invisible-p))))
  1192. (list 'src-block
  1193. `(:language ,language
  1194. :switches ,switches
  1195. :parameters ,parameters
  1196. :begin ,begin
  1197. :end ,end
  1198. :hiddenp ,hidden
  1199. :value ,value
  1200. :post-blank ,(count-lines contents-end end)
  1201. ,@(cadr keywords))))))
  1202. (defun org-element-src-block-interpreter (src-block contents)
  1203. "Interpret SRC-BLOCK element as Org syntax.
  1204. CONTENTS is nil."
  1205. (let ((lang (org-element-get-property :language src-block))
  1206. (switches (org-element-get-property :switches src-block))
  1207. (params (org-element-get-property :parameters src-block))
  1208. (value (let ((val (org-element-get-property :value src-block)))
  1209. (cond
  1210. (org-src-preserve-indentation val)
  1211. ((zerop org-edit-src-content-indentation)
  1212. (org-remove-indentation val))
  1213. (t
  1214. (let ((ind (make-string
  1215. org-edit-src-content-indentation 32)))
  1216. (replace-regexp-in-string
  1217. "\\(^\\)[ \t]*\\S-" ind
  1218. (org-remove-indentation val) nil nil 1)))))))
  1219. (concat (format "#+begin_src%s\n"
  1220. (concat (and lang (concat " " lang))
  1221. (and switches (concat " " switches))
  1222. (and params (concat " " params))))
  1223. value
  1224. "#+end_src")))
  1225. ;;;; Table
  1226. (defun org-element-table-parser ()
  1227. "Parse a table at point.
  1228. Return a list whose car is `table' and cdr is a plist containing
  1229. `:begin', `:end', `:contents-begin', `:contents-end', `:tblfm',
  1230. `:type', `:raw-table' and `:post-blank' keywords."
  1231. (save-excursion
  1232. (let* ((table-begin (goto-char (org-table-begin t)))
  1233. (type (if (org-at-table.el-p) 'table.el 'org))
  1234. (keywords (org-element-collect-affiliated-keywords))
  1235. (begin (car keywords))
  1236. (table-end (goto-char (marker-position (org-table-end t))))
  1237. (tblfm (when (looking-at "[ \t]*#\\+tblfm: +\\(.*\\)[ \t]*")
  1238. (prog1 (org-match-string-no-properties 1)
  1239. (forward-line))))
  1240. (pos-before-blank (point))
  1241. (end (progn (org-skip-whitespace)
  1242. (if (eobp) (point) (point-at-bol))))
  1243. (raw-table (org-remove-indentation
  1244. (buffer-substring-no-properties table-begin table-end))))
  1245. (list 'table
  1246. `(:begin ,begin
  1247. :end ,end
  1248. :type ,type
  1249. :raw-table ,raw-table
  1250. :tblfm ,tblfm
  1251. :post-blank ,(count-lines pos-before-blank end)
  1252. ,@(cadr keywords))))))
  1253. (defun org-element-table-interpreter (table contents)
  1254. "Interpret TABLE element as Org syntax.
  1255. CONTENTS is nil."
  1256. (org-element-get-property :raw-table table))
  1257. ;;;; Verse Block
  1258. (defun org-element-verse-block-parser ()
  1259. "Parse a verse block.
  1260. Return a list whose car is `verse-block' and cdr is a plist
  1261. containing `:begin', `:end', `:hiddenp', `:raw-value', `:value'
  1262. and `:post-blank' keywords.
  1263. Assume point is at beginning or end of the block."
  1264. (save-excursion
  1265. (let* ((case-fold-search t)
  1266. (keywords (progn
  1267. (end-of-line)
  1268. (re-search-backward
  1269. (concat "^[ \t]*#\\+begin_verse") nil t)
  1270. (org-element-collect-affiliated-keywords)))
  1271. (begin (car keywords))
  1272. (hidden (progn (forward-line) (org-truely-invisible-p)))
  1273. (raw-val (buffer-substring-no-properties
  1274. (point)
  1275. (progn
  1276. (re-search-forward (concat "^[ \t]*#\\+end_verse") nil t)
  1277. (point-at-bol))))
  1278. (pos-before-blank (progn (forward-line) (point)))
  1279. (end (progn (org-skip-whitespace)
  1280. (if (eobp) (point) (point-at-bol))))
  1281. (value (org-element-parse-secondary-string
  1282. (org-remove-indentation raw-val)
  1283. (cdr (assq 'verse org-element-string-restrictions)))))
  1284. (list 'verse-block
  1285. `(:begin ,begin
  1286. :end ,end
  1287. :hiddenp ,hidden
  1288. :raw-value ,raw-val
  1289. :value ,value
  1290. :post-blank ,(count-lines pos-before-blank end)
  1291. ,@(cadr keywords))))))
  1292. (defun org-element-verse-block-interpreter (verse-block contents)
  1293. "Interpret VERSE-BLOCK element as Org syntax.
  1294. CONTENTS is nil."
  1295. (format "#+begin_verse\n%s#+end_verse"
  1296. (org-remove-indentation
  1297. (org-element-get-property :raw-value verse-block))))
  1298. ;;; Objects
  1299. ;; Unlike to elements, interstices can be found between objects.
  1300. ;; That's why, along with the parser, successor functions are provided
  1301. ;; for each object. Some objects share the same successor
  1302. ;; (i.e. `emphasis' and `verbatim' objects).
  1303. ;; A successor must accept a single argument bounding the search. It
  1304. ;; will return either a cons cell whose car is the object's type, as
  1305. ;; a symbol, and cdr the position of its next occurrence, or nil.
  1306. ;; Successors follow the naming convention:
  1307. ;; org-element-NAME-successor, where NAME is the name of the
  1308. ;; successor, as defined in `org-element-all-successors'.
  1309. ;; Some object types (i.e `emphasis') are recursive. Restrictions on
  1310. ;; object types they can contain will be specified in
  1311. ;; `org-element-object-restrictions'.
  1312. ;; Adding a new type of object is simple. Implement a successor,
  1313. ;; a parser, and an interpreter for it, all following the naming
  1314. ;; convention. Register successor in `org-element-all-successors',
  1315. ;; maybe tweak restrictions about it, and that's it.
  1316. ;;;; Emphasis
  1317. (defun org-element-emphasis-parser ()
  1318. "Parse text markup object at point.
  1319. Return a list whose car is `emphasis' and cdr is a plist with
  1320. `:marker', `:begin', `:end', `:contents-begin' and
  1321. `:contents-end' and `:post-blank' keywords.
  1322. Assume point is at the first emphasis marker."
  1323. (save-excursion
  1324. (unless (bolp) (backward-char 1))
  1325. (looking-at org-emph-re)
  1326. (let ((begin (match-beginning 2))
  1327. (marker (org-match-string-no-properties 3))
  1328. (contents-begin (match-beginning 4))
  1329. (contents-end (match-end 4))
  1330. (post-blank (progn (goto-char (match-end 2))
  1331. (skip-chars-forward " \t")))
  1332. (end (point)))
  1333. (list 'emphasis
  1334. `(:marker ,marker
  1335. :begin ,begin
  1336. :end ,end
  1337. :contents-begin ,contents-begin
  1338. :contents-end ,contents-end
  1339. :post-blank ,post-blank)))))
  1340. (defun org-element-emphasis-interpreter (emphasis contents)
  1341. "Interpret EMPHASIS object as Org syntax.
  1342. CONTENTS is the contents of the object."
  1343. (let ((marker (org-element-get-property :marker emphasis)))
  1344. (concat marker contents marker)))
  1345. (defun org-element-text-markup-successor (limit)
  1346. "Search for the next emphasis or verbatim and return position.
  1347. LIMIT bounds the search.
  1348. Return value is a cons cell whose car is `emphasis' or
  1349. `verbatim' and cdr is beginning position."
  1350. (save-excursion
  1351. (unless (bolp) (backward-char))
  1352. (when (re-search-forward org-emph-re limit t)
  1353. (cons (if (nth 4 (assoc (match-string 3) org-emphasis-alist))
  1354. 'verbatim
  1355. 'emphasis)
  1356. (match-beginning 2)))))
  1357. ;;;; Entity
  1358. (defun org-element-entity-parser ()
  1359. "Parse entity at point.
  1360. Return a list whose car is `entity' and cdr a plist with
  1361. `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
  1362. `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
  1363. keywords.
  1364. Assume point is at the beginning of the entity."
  1365. (save-excursion
  1366. (looking-at "\\\\\\(frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
  1367. (let* ((value (org-entity-get (match-string 1)))
  1368. (begin (match-beginning 0))
  1369. (bracketsp (string= (match-string 2) "{}"))
  1370. (post-blank (progn (goto-char (match-end 1))
  1371. (when bracketsp (forward-char 2))
  1372. (skip-chars-forward " \t")))
  1373. (end (point)))
  1374. (list 'entity
  1375. `(:name ,(car value)
  1376. :latex ,(nth 1 value)
  1377. :latex-math-p ,(nth 2 value)
  1378. :html ,(nth 3 value)
  1379. :ascii ,(nth 4 value)
  1380. :latin1 ,(nth 5 value)
  1381. :utf-8 ,(nth 6 value)
  1382. :begin ,begin
  1383. :end ,end
  1384. :use-brackets-p ,bracketsp
  1385. :post-blank ,post-blank)))))
  1386. (defun org-element-entity-interpreter (entity contents)
  1387. "Interpret ENTITY object as Org syntax.
  1388. CONTENTS is nil."
  1389. (concat "\\"
  1390. (org-element-get-property :name entity)
  1391. (when (org-element-get-property :use-brackets-p entity) "{}")))
  1392. (defun org-element-latex-or-entity-successor (limit)
  1393. "Search for the next latex-fragment or entity object.
  1394. LIMIT bounds the search.
  1395. Return value is a cons cell whose car is `entity' or
  1396. `latex-fragment' and cdr is beginning position."
  1397. (save-excursion
  1398. (let ((matchers (plist-get org-format-latex-options :matchers))
  1399. ;; ENTITY-RE matches both LaTeX commands and Org entities.
  1400. (entity-re
  1401. "\\\\\\(frac[13][24]\\|[a-zA-Z]+\\)\\($\\|[^[:alpha:]\n]\\)"))
  1402. (when (re-search-forward
  1403. (concat (mapconcat (lambda (e) (nth 1 (assoc e org-latex-regexps)))
  1404. matchers "\\|")
  1405. "\\|" entity-re)
  1406. limit t)
  1407. (goto-char (match-beginning 0))
  1408. (if (looking-at entity-re)
  1409. ;; Determine if it's a real entity or a LaTeX command.
  1410. (cons (if (org-entity-get (match-string 1)) 'entity 'latex-fragment)
  1411. (match-beginning 0))
  1412. ;; No entity nor command: point is at a LaTeX fragment.
  1413. ;; Determine its type to get the correct beginning position.
  1414. (cons 'latex-fragment
  1415. (catch 'return
  1416. (mapc (lambda (e)
  1417. (when (looking-at (nth 1 (assoc e org-latex-regexps)))
  1418. (throw 'return
  1419. (match-beginning
  1420. (nth 2 (assoc e org-latex-regexps))))))
  1421. matchers)
  1422. (point))))))))
  1423. ;;;; Export Snippet
  1424. (defun org-element-export-snippet-parser ()
  1425. "Parse export snippet at point.
  1426. Return a list whose car is `export-snippet' and cdr a plist with
  1427. `:begin', `:end', `:back-end', `:value' and `:post-blank' as
  1428. keywords.
  1429. Assume point is at the beginning of the snippet."
  1430. (save-excursion
  1431. (looking-at "@\\([-A-Za-z0-9]+\\){")
  1432. (let* ((begin (point))
  1433. (back-end (org-match-string-no-properties 1))
  1434. (before-blank (progn (goto-char (scan-sexps (1- (match-end 0)) 1))))
  1435. (value (buffer-substring-no-properties
  1436. (match-end 0) (1- before-blank)))
  1437. (post-blank (skip-chars-forward " \t"))
  1438. (end (point)))
  1439. (list 'export-snippet
  1440. `(:back-end ,back-end
  1441. :value ,value
  1442. :begin ,begin
  1443. :end ,end
  1444. :post-blank ,post-blank)))))
  1445. (defun org-element-export-snippet-interpreter (export-snippet contents)
  1446. "Interpret EXPORT-SNIPPET object as Org syntax.
  1447. CONTENTS is nil."
  1448. (format "@%s{%s}"
  1449. (org-element-get-property :back-end export-snippet)
  1450. (org-element-get-property :value export-snippet)))
  1451. (defun org-element-export-snippet-successor (limit)
  1452. "Search for the next export-snippet object.
  1453. LIMIT bounds the search.
  1454. Return value is a cons cell whose car is `export-snippet' cdr is
  1455. its beginning position."
  1456. (save-excursion
  1457. (catch 'exit
  1458. (while (re-search-forward "@[-A-Za-z0-9]+{" limit t)
  1459. (when (let ((end (ignore-errors (scan-sexps (1- (point)) 1))))
  1460. (and end (eq (char-before end) ?})))
  1461. (throw 'exit (cons 'export-snippet (match-beginning 0))))))))
  1462. ;;;; Footnote Reference
  1463. (defun org-element-footnote-reference-parser ()
  1464. "Parse footnote reference at point.
  1465. Return a list whose car is `footnote-reference' and cdr a plist
  1466. with `:label', `:type', `:definition', `:begin', `:end' and
  1467. `:post-blank' as keywords."
  1468. (save-excursion
  1469. (let* ((ref (org-footnote-at-reference-p))
  1470. (label (car ref))
  1471. (raw-def (nth 3 ref))
  1472. (inline-def (and raw-def
  1473. (org-element-parse-secondary-string raw-def nil)))
  1474. (type (if (nth 3 ref) 'inline 'standard))
  1475. (begin (nth 1 ref))
  1476. (post-blank (progn (goto-char (nth 2 ref))
  1477. (skip-chars-forward " \t")))
  1478. (end (point)))
  1479. (list 'footnote-reference
  1480. `(:label ,label
  1481. :type ,type
  1482. :inline-definition ,inline-def
  1483. :begin ,begin
  1484. :end ,end
  1485. :post-blank ,post-blank
  1486. :raw-definition ,raw-def)))))
  1487. (defun org-element-footnote-reference-interpreter (footnote-reference contents)
  1488. "Interpret FOOTNOTE-REFERENCE object as Org syntax.
  1489. CONTENTS is nil."
  1490. (let ((label (or (org-element-get-property :label footnote-reference)
  1491. "fn:"))
  1492. (def (let ((raw (org-element-get-property
  1493. :raw-definition footnote-reference)))
  1494. (if raw (concat ":" raw) ""))))
  1495. (format "[%s]" (concat label def))))
  1496. (defun org-element-footnote-reference-successor (limit)
  1497. "Search for the next footnote-reference and return beginning
  1498. position.
  1499. LIMIT bounds the search.
  1500. Return value is a cons cell whose car is `footnote-reference' and
  1501. cdr is beginning position."
  1502. (let (fn-ref)
  1503. (when (setq fn-ref (org-footnote-get-next-reference nil nil limit))
  1504. (cons 'footnote-reference (nth 1 fn-ref)))))
  1505. ;;;; Inline Babel Call
  1506. (defun org-element-inline-babel-call-parser ()
  1507. "Parse inline babel call at point.
  1508. Return a list whose car is `inline-babel-call' and cdr a plist with
  1509. `:begin', `:end', `:info' and `:post-blank' as keywords.
  1510. Assume point is at the beginning of the babel call."
  1511. (save-excursion
  1512. (unless (bolp) (backward-char))
  1513. (looking-at org-babel-inline-lob-one-liner-regexp)
  1514. (let ((info (save-match-data (org-babel-lob-get-info)))
  1515. (begin (match-end 1))
  1516. (post-blank (progn (goto-char (match-end 0))
  1517. (skip-chars-forward " \t")))
  1518. (end (point)))
  1519. (list 'inline-babel-call
  1520. `(:begin ,begin
  1521. :end ,end
  1522. :info ,info
  1523. :post-blank ,post-blank)))))
  1524. (defun org-element-inline-babel-call-interpreter (inline-babel-call contents)
  1525. "Interpret INLINE-BABEL-CALL object as Org syntax.
  1526. CONTENTS is nil."
  1527. (let* ((babel-info (org-element-get-property :info inline-babel-call))
  1528. (main-source (car babel-info))
  1529. (post-options (nth 1 babel-info)))
  1530. (concat "call_"
  1531. (if (string-match "\\[\\(\\[.*?\\]\\)\\]" main-source)
  1532. ;; Remove redundant square brackets.
  1533. (replace-match
  1534. (match-string 1 main-source) nil nil main-source)
  1535. main-source)
  1536. (and post-options (format "[%s]" post-options)))))
  1537. (defun org-element-inline-babel-call-successor (limit)
  1538. "Search for the next inline-babel-call and return beginning
  1539. position.
  1540. LIMIT bounds the search.
  1541. Return value is a cons cell whose car is `inline-babel-call' and
  1542. cdr is beginning position."
  1543. (save-excursion
  1544. ;; Use a simplified version of
  1545. ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
  1546. (when (re-search-forward
  1547. "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
  1548. limit t)
  1549. (cons 'inline-babel-call (match-beginning 0)))))
  1550. ;;;; Inline Src Block
  1551. (defun org-element-inline-src-block-parser ()
  1552. "Parse inline source block at point.
  1553. Return a list whose car is `inline-src-block' and cdr a plist
  1554. with `:begin', `:end', `:language', `:value', `:parameters' and
  1555. `:post-blank' as keywords.
  1556. Assume point is at the beginning of the inline src block."
  1557. (save-excursion
  1558. (unless (bolp) (backward-char))
  1559. (looking-at org-babel-inline-src-block-regexp)
  1560. (let ((begin (match-beginning 1))
  1561. (language (org-match-string-no-properties 2))
  1562. (parameters (org-match-string-no-properties 4))
  1563. (value (org-match-string-no-properties 5))
  1564. (post-blank (progn (goto-char (match-end 0))
  1565. (skip-chars-forward " \t")))
  1566. (end (point)))
  1567. (list 'inline-src-block
  1568. `(:language ,language
  1569. :value ,value
  1570. :parameters ,parameters
  1571. :begin ,begin
  1572. :end ,end
  1573. :post-blank ,post-blank)))))
  1574. (defun org-element-inline-src-block-successor (limit)
  1575. "Search for the next inline-babel-call and return beginning position.
  1576. LIMIT bounds the search.
  1577. Return value is a cons cell whose car is `inline-babel-call' and
  1578. cdr is beginning position."
  1579. (save-excursion
  1580. (when (re-search-forward org-babel-inline-src-block-regexp limit t)
  1581. (cons 'inline-src-block (match-beginning 1)))))
  1582. ;;;; Latex Fragment
  1583. (defun org-element-latex-fragment-parser ()
  1584. "Parse latex fragment at point.
  1585. Return a list whose car is `latex-fragment' and cdr a plist with
  1586. `:value', `:begin', `:end', and `:post-blank' as keywords.
  1587. Assume point is at the beginning of the latex fragment."
  1588. (save-excursion
  1589. (let* ((begin (point))
  1590. (substring-match
  1591. (catch 'exit
  1592. (mapc (lambda (e)
  1593. (let ((latex-regexp (nth 1 (assoc e org-latex-regexps))))
  1594. (when (or (looking-at latex-regexp)
  1595. (and (not (bobp))
  1596. (save-excursion
  1597. (backward-char)
  1598. (looking-at latex-regexp))))
  1599. (throw 'exit (nth 2 (assoc e org-latex-regexps))))))
  1600. (plist-get org-format-latex-options :matchers))
  1601. ;; None found: it's a macro.
  1602. (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")
  1603. 0))
  1604. (value (match-string-no-properties substring-match))
  1605. (post-blank (progn (goto-char (match-end substring-match))
  1606. (skip-chars-forward " \t")))
  1607. (end (point)))
  1608. (list 'latex-fragment
  1609. `(:value ,value
  1610. :begin ,begin
  1611. :end ,end
  1612. :post-blank ,post-blank)))))
  1613. (defun org-element-latex-fragment-interpreter (latex-fragment contents)
  1614. "Interpret LATEX-FRAGMENT object as Org syntax.
  1615. CONTENTS is nil."
  1616. (org-element-get-property :value latex-fragment))
  1617. ;;;; Line Break
  1618. (defun org-element-line-break-parser ()
  1619. "Parse line break at point.
  1620. Return a list whose car is `line-break', and cdr a plist with
  1621. `:begin', `:end' and `:post-blank' keywords.
  1622. Assume point is at the beginning of the line break."
  1623. (save-excursion
  1624. (let* ((begin (point))
  1625. (end (progn (end-of-line) (point)))
  1626. (post-blank (- (skip-chars-backward " \t")))
  1627. (end (point)))
  1628. (list 'line-break
  1629. `(:begin ,begin
  1630. :end ,end
  1631. :post-blank ,post-blank)))))
  1632. (defun org-element-line-break-interpreter (line-break contents)
  1633. "Interpret LINE-BREAK object as Org syntax.
  1634. CONTENTS is nil."
  1635. (org-element-get-property :value line-break))
  1636. (defun org-element-line-break-successor (limit)
  1637. "Search for the next statistics cookie and return position.
  1638. LIMIT bounds the search.
  1639. Return value is a cons cell whose car is `line-break' and cdr is
  1640. beginning position."
  1641. (save-excursion
  1642. (let ((beg (and (re-search-forward "[^\\\\]\\(\\\\\\\\\\)[ \t]*$" limit t)
  1643. (goto-char (match-beginning 1)))))
  1644. ;; A line break can only happen on a non-empty line.
  1645. (when (and beg (re-search-backward "\\S-" (point-at-bol) t))
  1646. (cons 'line-break beg)))))
  1647. ;;;; Link
  1648. (defun org-element-link-parser ()
  1649. "Parse link at point.
  1650. Return a list whose car is `link' and cdr a plist with `:type',
  1651. `:path', `:raw-link', `:begin', `:end', `:contents-begin',
  1652. `:contents-end' and `:post-blank' as keywords.
  1653. Assume point is at the beginning of the link."
  1654. (save-excursion
  1655. (let ((begin (point))
  1656. end contents-begin contents-end link-end post-blank path type
  1657. raw-link link)
  1658. (cond
  1659. ;; Type 1: text targeted from a radio target.
  1660. ((and org-target-link-regexp (looking-at org-target-link-regexp))
  1661. (setq type "radio"
  1662. path (org-match-string-no-properties 0)
  1663. contents-begin (match-beginning 0)
  1664. contents-end (match-end 0)
  1665. link-end (match-end 0)))
  1666. ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
  1667. ((looking-at org-bracket-link-regexp)
  1668. (setq contents-begin (match-beginning 3)
  1669. contents-end (match-end 3)
  1670. link-end (match-end 0)
  1671. ;; RAW-LINK is the original link.
  1672. raw-link (org-match-string-no-properties 1)
  1673. link (org-link-expand-abbrev
  1674. (replace-regexp-in-string
  1675. " *\n *" " " (org-link-unescape raw-link) t t)))
  1676. ;; Determine TYPE of link and set PATH accordingly.
  1677. (cond
  1678. ;; File type.
  1679. ((or (file-name-absolute-p link) (string-match "^\\.\\.?/" link))
  1680. (setq type "file" path link))
  1681. ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
  1682. ((string-match org-link-re-with-space3 link)
  1683. (setq type (match-string 1 link) path (match-string 2 link)))
  1684. ;; Id type: PATH is the id.
  1685. ((string-match "^id:\\([-a-f0-9]+\\)" link)
  1686. (setq type "id" path (match-string 1 link)))
  1687. ;; Code-ref type: PATH is the name of the reference.
  1688. ((string-match "^(\\(.*\\))$" link)
  1689. (setq type "coderef" path (match-string 1 link)))
  1690. ;; Custom-id type: PATH is the name of the custom id.
  1691. ((= (aref link 0) ?#)
  1692. (setq type "custom-id" path (substring link 1)))
  1693. ;; Fuzzy type: Internal link either matches a target, an
  1694. ;; headline name or nothing. PATH is the target or headline's
  1695. ;; name.
  1696. (t (setq type "fuzzy" path link))))
  1697. ;; Type 3: Plain link, i.e. http://orgmode.org
  1698. ((looking-at org-plain-link-re)
  1699. (setq raw-link (org-match-string-no-properties 0)
  1700. type (org-match-string-no-properties 1)
  1701. path (org-match-string-no-properties 2)
  1702. link-end (match-end 0)))
  1703. ;; Type 4: Angular link, i.e. <http://orgmode.org>
  1704. ((looking-at org-angle-link-re)
  1705. (setq raw-link (buffer-substring-no-properties
  1706. (match-beginning 1) (match-end 2))
  1707. type (org-match-string-no-properties 1)
  1708. path (org-match-string-no-properties 2)
  1709. link-end (match-end 0))))
  1710. ;; In any case, deduce end point after trailing white space from
  1711. ;; LINK-END variable.
  1712. (setq post-blank (progn (goto-char link-end) (skip-chars-forward " \t"))
  1713. end (point))
  1714. (list 'link
  1715. `(:type ,type
  1716. :path ,path
  1717. :raw-link ,(or raw-link path)
  1718. :begin ,begin
  1719. :end ,end
  1720. :contents-begin ,contents-begin
  1721. :contents-end ,contents-end
  1722. :post-blank ,post-blank)))))
  1723. (defun org-element-link-interpreter (link contents)
  1724. "Interpret LINK object as Org syntax.
  1725. CONTENTS is the contents of the object."
  1726. (let ((type (org-element-get-property :type link))
  1727. (raw-link (org-element-get-property :raw-link link)))
  1728. (cond
  1729. ((string= type "radio") raw-link)
  1730. (t (format "[[%s]%s]"
  1731. raw-link
  1732. (if (string= contents "") "" (format "[%s]" contents)))))))
  1733. (defun org-element-link-successor (limit)
  1734. "Search for the next link and return position.
  1735. LIMIT bounds the search.
  1736. Return value is a cons cell whose car is `link' and cdr is
  1737. beginning position."
  1738. (save-excursion
  1739. (let ((link-regexp
  1740. (if org-target-link-regexp
  1741. (concat org-any-link-re "\\|" org-target-link-regexp)
  1742. org-any-link-re)))
  1743. (when (re-search-forward link-regexp limit t)
  1744. (cons 'link (match-beginning 0))))))
  1745. ;;;; Macro
  1746. (defun org-element-macro-parser ()
  1747. "Parse macro at point.
  1748. Return a list whose car is `macro' and cdr a plist with `:key',
  1749. `:args', `:begin', `:end', `:value' and `:post-blank' as
  1750. keywords.
  1751. Assume point is at the macro."
  1752. (save-excursion
  1753. (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}")
  1754. (let ((begin (point))
  1755. (key (downcase (org-match-string-no-properties 1)))
  1756. (value (org-match-string-no-properties 0))
  1757. (post-blank (progn (goto-char (match-end 0))
  1758. (skip-chars-forward " \t")))
  1759. (end (point))
  1760. (args (let ((args (org-match-string-no-properties 3)) args2)
  1761. (when args
  1762. (setq args (org-split-string args ","))
  1763. (while args
  1764. (while (string-match "\\\\\\'" (car args))
  1765. ;; Repair bad splits.
  1766. (setcar (cdr args) (concat (substring (car args) 0 -1)
  1767. "," (nth 1 args)))
  1768. (pop args))
  1769. (push (pop args) args2))
  1770. (mapcar 'org-trim (nreverse args2))))))
  1771. (list 'macro
  1772. `(:key ,key
  1773. :value ,value
  1774. :args ,args
  1775. :begin ,begin
  1776. :end ,end
  1777. :post-blank ,post-blank)))))
  1778. (defun org-element-macro-interpreter (macro contents)
  1779. "Interpret MACRO object as Org syntax.
  1780. CONTENTS is nil."
  1781. (org-element-get-property :value macro))
  1782. (defun org-element-macro-successor (limit)
  1783. "Search for the next macro and return position.
  1784. LIMIT bounds the search.
  1785. Return value is cons cell whose car is `macro' and cdr is
  1786. beginning position."
  1787. (save-excursion
  1788. (when (re-search-forward
  1789. "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
  1790. limit t)
  1791. (cons 'macro (match-beginning 0)))))
  1792. ;;;; Radio-target
  1793. (defun org-element-radio-target-parser ()
  1794. "Parse radio target at point.
  1795. Return a list whose car is `radio-target' and cdr a plist with
  1796. `:begin', `:end', `:contents-begin', `:contents-end', `raw-value'
  1797. and `:post-blank' as keywords.
  1798. Assume point is at the radio target."
  1799. (save-excursion
  1800. (looking-at org-radio-target-regexp)
  1801. (let ((begin (point))
  1802. (contents-begin (match-beginning 1))
  1803. (contents-end (match-end 1))
  1804. (raw-value (org-match-string-no-properties 1))
  1805. (post-blank (progn (goto-char (match-end 0))
  1806. (skip-chars-forward " \t")))
  1807. (end (point)))
  1808. (list 'radio-target
  1809. `(:begin ,begin
  1810. :end ,end
  1811. :contents-begin ,contents-begin
  1812. :contents-end ,contents-end
  1813. :raw-value ,raw-value
  1814. :post-blank ,post-blank)))))
  1815. (defun org-element-radio-target-interpreter (target contents)
  1816. "Interpret TARGET object as Org syntax.
  1817. CONTENTS is the contents of the object."
  1818. (concat "<<<" contents ">>>"))
  1819. (defun org-element-radio-target-successor (limit)
  1820. "Search for the next radio-target and return position.
  1821. LIMIT bounds the search.
  1822. Return value is a cons cell whose car is `radio-target' and cdr
  1823. is beginning position."
  1824. (save-excursion
  1825. (when (re-search-forward org-radio-target-regexp limit t)
  1826. (cons 'radio-target (match-beginning 0)))))
  1827. ;;;; Statistics Cookie
  1828. (defun org-element-statistics-cookie-parser ()
  1829. "Parse statistics cookie at point.
  1830. Return a list whose car is `statistics-cookie', and cdr a plist
  1831. with `:begin', `:end', `:value' and `:post-blank' keywords.
  1832. Assume point is at the beginning of the statistics-cookie."
  1833. (save-excursion
  1834. (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
  1835. (let* ((begin (point))
  1836. (value (buffer-substring-no-properties
  1837. (match-beginning 0) (match-end 0)))
  1838. (post-blank (progn (goto-char (match-end 0))
  1839. (skip-chars-forward " \t")))
  1840. (end (point)))
  1841. (list 'statistics-cookie
  1842. `(:begin ,begin
  1843. :end ,end
  1844. :value ,value
  1845. :post-blank ,post-blank)))))
  1846. (defun org-element-statistics-cookie-interpreter (statistics-cookie contents)
  1847. "Interpret STATISTICS-COOKIE object as Org syntax.
  1848. CONTENTS is nil."
  1849. (org-element-get-property :value statistics-cookie))
  1850. (defun org-element-statistics-cookie-successor (limit)
  1851. "Search for the next statistics cookie and return position.
  1852. LIMIT bounds the search.
  1853. Return value is a cons cell whose car is `statistics-cookie' and
  1854. cdr is beginning position."
  1855. (save-excursion
  1856. (when (re-search-forward "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]" limit t)
  1857. (cons 'statistics-cookie (match-beginning 0)))))
  1858. ;;;; Subscript
  1859. (defun org-element-subscript-parser ()
  1860. "Parse subscript at point.
  1861. Return a list whose car is `subscript' and cdr a plist with
  1862. `:begin', `:end', `:contents-begin', `:contents-end',
  1863. `:use-brackets-p' and `:post-blank' as keywords.
  1864. Assume point is at the underscore."
  1865. (save-excursion
  1866. (unless (bolp) (backward-char))
  1867. (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp)
  1868. t
  1869. (not (looking-at org-match-substring-regexp))))
  1870. (begin (match-beginning 2))
  1871. (contents-begin (or (match-beginning 5)
  1872. (match-beginning 3)))
  1873. (contents-end (or (match-end 5) (match-end 3)))
  1874. (post-blank (progn (goto-char (match-end 0))
  1875. (skip-chars-forward " \t")))
  1876. (end (point)))
  1877. (list 'subscript
  1878. `(:begin ,begin
  1879. :end ,end
  1880. :use-brackets-p ,bracketsp
  1881. :contents-begin ,contents-begin
  1882. :contents-end ,contents-end
  1883. :post-blank ,post-blank)))))
  1884. (defun org-element-subscript-interpreter (subscript contents)
  1885. "Interpret SUBSCRIPT object as Org syntax.
  1886. CONTENTS is the contents of the object."
  1887. (format
  1888. (if (org-element-get-property :use-brackets-p subscript) "_{%s}" "_%s")
  1889. contents))
  1890. (defun org-element-sub/superscript-successor (limit)
  1891. "Search for the next sub/superscript and return beginning
  1892. position.
  1893. LIMIT bounds the search.
  1894. Return value is a cons cell whose car is either `subscript' or
  1895. `superscript' and cdr is beginning position."
  1896. (save-excursion
  1897. (when (re-search-forward org-match-substring-regexp limit t)
  1898. (cons (if (string= (match-string 2) "_") 'subscript 'superscript)
  1899. (match-beginning 2)))))
  1900. ;;;; Superscript
  1901. (defun org-element-superscript-parser ()
  1902. "Parse superscript at point.
  1903. Return a list whose car is `superscript' and cdr a plist with
  1904. `:begin', `:end', `:contents-begin', `:contents-end',
  1905. `:use-brackets-p' and `:post-blank' as keywords.
  1906. Assume point is at the caret."
  1907. (save-excursion
  1908. (unless (bolp) (backward-char))
  1909. (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp)
  1910. t
  1911. (not (looking-at org-match-substring-regexp))))
  1912. (begin (match-beginning 2))
  1913. (contents-begin (or (match-beginning 5)
  1914. (match-beginning 3)))
  1915. (contents-end (or (match-end 5) (match-end 3)))
  1916. (post-blank (progn (goto-char (match-end 0))
  1917. (skip-chars-forward " \t")))
  1918. (end (point)))
  1919. (list 'superscript
  1920. `(:begin ,begin
  1921. :end ,end
  1922. :use-brackets-p ,bracketsp
  1923. :contents-begin ,contents-begin
  1924. :contents-end ,contents-end
  1925. :post-blank ,post-blank)))))
  1926. (defun org-element-superscript-interpreter (superscript contents)
  1927. "Interpret SUPERSCRIPT object as Org syntax.
  1928. CONTENTS is the contents of the object."
  1929. (format
  1930. (if (org-element-get-property :use-brackets-p superscript) "^{%s}" "^%s")
  1931. contents))
  1932. ;;;; Target
  1933. (defun org-element-target-parser ()
  1934. "Parse target at point.
  1935. Return a list whose car is `target' and cdr a plist with
  1936. `:begin', `:end', `:contents-begin', `:contents-end', `raw-value'
  1937. and `:post-blank' as keywords.
  1938. Assume point is at the target."
  1939. (save-excursion
  1940. (looking-at org-target-regexp)
  1941. (let ((begin (point))
  1942. (contents-begin (match-beginning 1))
  1943. (contents-end (match-end 1))
  1944. (raw-value (org-match-string-no-properties 1))
  1945. (post-blank (progn (goto-char (match-end 0))
  1946. (skip-chars-forward " \t")))
  1947. (end (point)))
  1948. (list 'target
  1949. `(:begin ,begin
  1950. :end ,end
  1951. :contents-begin ,contents-begin
  1952. :contents-end ,contents-end
  1953. :raw-value ,raw-value
  1954. :post-blank ,post-blank)))))
  1955. (defun org-element-target-interpreter (target contents)
  1956. "Interpret TARGET object as Org syntax.
  1957. CONTENTS is the contents of target."
  1958. (concat ""))
  1959. (defun org-element-target-successor (limit)
  1960. "Search for the next target and return position.
  1961. LIMIT bounds the search.
  1962. Return value is a cons cell whose car is `target' and cdr is
  1963. beginning position."
  1964. (save-excursion
  1965. (when (re-search-forward org-target-regexp limit t)
  1966. (cons 'target (match-beginning 0)))))
  1967. ;;;; Time-stamp
  1968. (defun org-element-time-stamp-parser ()
  1969. "Parse time stamp at point.
  1970. Return a list whose car is `time-stamp', and cdr a plist with
  1971. `:appt-type', `:type', `:begin', `:end', `:value' and
  1972. `:post-blank' keywords.
  1973. Assume point is at the beginning of the time-stamp."
  1974. (save-excursion
  1975. (let* ((appt-type (cond
  1976. ((looking-at (concat org-deadline-string " +"))
  1977. (goto-char (match-end 0))
  1978. 'deadline)
  1979. ((looking-at (concat org-scheduled-string " +"))
  1980. (goto-char (match-end 0))
  1981. 'scheduled)
  1982. ((looking-at (concat org-closed-string " +"))
  1983. (goto-char (match-end 0))
  1984. 'closed)))
  1985. (begin (and appt-type (match-beginning 0)))
  1986. (type (cond
  1987. ((looking-at org-tsr-regexp)
  1988. (if (match-string 2) 'active-range 'active))
  1989. ((looking-at org-tsr-regexp-both)
  1990. (if (match-string 2) 'inactive-range 'inactive))
  1991. ((looking-at (concat
  1992. "\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
  1993. "\\|"
  1994. "\\(<%%\\(([^>\n]+)\\)>\\)"))
  1995. 'diary)))
  1996. (begin (or begin (match-beginning 0)))
  1997. (value (buffer-substring-no-properties
  1998. (match-beginning 0) (match-end 0)))
  1999. (post-blank (progn (goto-char (match-end 0))
  2000. (skip-chars-forward " \t")))
  2001. (end (point)))
  2002. (list 'time-stamp
  2003. `(:appt-type ,appt-type
  2004. :type ,type
  2005. :value ,value
  2006. :begin ,begin
  2007. :end ,end
  2008. :post-blank ,post-blank)))))
  2009. (defun org-element-time-stamp-interpreter (time-stamp contents)
  2010. "Interpret TIME-STAMP object as Org syntax.
  2011. CONTENTS is nil."
  2012. (concat
  2013. (case (org-element-get-property :appt-type time-stamp)
  2014. (closed (concat org-closed-string " "))
  2015. (deadline (concat org-deadline-string " "))
  2016. (scheduled (concat org-scheduled-string " ")))
  2017. (org-element-get-property :value time-stamp)))
  2018. (defun org-element-time-stamp-successor (limit)
  2019. "Search for the next time-stamp and return position.
  2020. LIMIT bounds the search.
  2021. Return value is a cons cell whose car is `time-stamp' and cdr is
  2022. beginning position."
  2023. (save-excursion
  2024. (when (re-search-forward
  2025. (concat "\\(?:" org-scheduled-string " +\\|"
  2026. org-deadline-string " +\\|" org-closed-string " +\\)?"
  2027. org-ts-regexp-both
  2028. "\\|"
  2029. "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
  2030. "\\|"
  2031. "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
  2032. limit t)
  2033. (cons 'time-stamp (match-beginning 0)))))
  2034. ;;;; Verbatim
  2035. (defun org-element-verbatim-parser ()
  2036. "Parse verbatim object at point.
  2037. Return a list whose car is `verbatim' and cdr is a plist with
  2038. `:marker', `:begin', `:end' and `:post-blank' keywords.
  2039. Assume point is at the first verbatim marker."
  2040. (save-excursion
  2041. (unless (bolp) (backward-char 1))
  2042. (looking-at org-emph-re)
  2043. (let ((begin (match-beginning 2))
  2044. (marker (org-match-string-no-properties 3))
  2045. (value (org-match-string-no-properties 4))
  2046. (post-blank (progn (goto-char (match-end 2))
  2047. (skip-chars-forward " \t")))
  2048. (end (point)))
  2049. (list 'verbatim
  2050. `(:marker ,marker
  2051. :begin ,begin
  2052. :end ,end
  2053. :value ,value
  2054. :post-blank ,post-blank)))))
  2055. (defun org-element-verbatim-interpreter (verbatim contents)
  2056. "Interpret VERBATIM object as Org syntax.
  2057. CONTENTS is nil."
  2058. (let ((marker (org-element-get-property :marker verbatim))
  2059. (value (org-element-get-property :value verbatim)))
  2060. (concat marker value marker)))
  2061. ;;; Definitions And Rules
  2062. ;; Define elements, greater elements and specify recursive objects,
  2063. ;; along with the affiliated keywords recognized. Also set up
  2064. ;; restrictions on recursive objects combinations.
  2065. ;; These variables really act as a control center for the parsing
  2066. ;; process.
  2067. (defconst org-element-paragraph-separate
  2068. (concat "\f" "\\|" "^[ \t]*$" "\\|"
  2069. ;; Headlines and inlinetasks.
  2070. org-outline-regexp-bol "\\|"
  2071. ;; Comments, blocks (any type), keywords and babel calls.
  2072. "^[ \t]*#\\+" "\\|" "^#\\( \\|$\\)" "\\|"
  2073. ;; Lists.
  2074. (org-item-beginning-re) "\\|"
  2075. ;; Fixed-width, drawers (any type) and tables.
  2076. "^[ \t]*[:|]" "\\|"
  2077. ;; Footnote definitions.
  2078. org-footnote-definition-re "\\|"
  2079. ;; Horizontal rules.
  2080. "^[ \t]*-\\{5,\\}[ \t]*$" "\\|"
  2081. ;; LaTeX environments.
  2082. "^[ \t]*\\\\\\(begin\\|end\\)")
  2083. "Regexp to separate paragraphs in an Org buffer.")
  2084. (defconst org-element-all-elements
  2085. '(center-block comment comment-block drawer dynamic-block example-block
  2086. export-block fixed-width footnote-definition headline
  2087. horizontal-rule inlinetask item keyword latex-environment
  2088. babel-call paragraph plain-list property-drawer quote-block
  2089. quote-section section special-block src-block table
  2090. verse-block)
  2091. "Complete list of elements.")
  2092. (defconst org-element-greater-elements
  2093. '(center-block drawer dynamic-block footnote-definition headline inlinetask
  2094. item plain-list quote-block section special-block)
  2095. "List of recursive element types aka Greater Elements.")
  2096. (defconst org-element-all-successors
  2097. '(export-snippet footnote-reference inline-babel-call inline-src-block
  2098. latex-or-entity line-break link macro radio-target
  2099. statistics-cookie sub/superscript target text-markup
  2100. time-stamp)
  2101. "Complete list of successors.")
  2102. (defconst org-element-object-successor-alist
  2103. '((subscript . sub/superscript) (superscript . sub/superscript)
  2104. (emphasis . text-markup) (verbatim . text-markup)
  2105. (entity . latex-or-entity) (latex-fragment . latex-or-entity))
  2106. "Alist of translations between object type and successor name.
  2107. Sharing the same successor comes handy when, for example, the
  2108. regexp matching one object can also match the other object.")
  2109. (defconst org-element-recursive-objects
  2110. '(emphasis link subscript superscript target radio-target)
  2111. "List of recursive object types.")
  2112. (defconst org-element-non-recursive-block-alist
  2113. '(("ascii" . export-block)
  2114. ("comment" . comment-block)
  2115. ("docbook" . export-block)
  2116. ("example" . example-block)
  2117. ("html" . export-block)
  2118. ("latex" . latex-block)
  2119. ("odt" . export-block)
  2120. ("src" . src-block)
  2121. ("verse" . verse-block))
  2122. "Alist between non-recursive block name and their element type.")
  2123. (defconst org-element-affiliated-keywords
  2124. '("attr_ascii" "attr_docbook" "attr_html" "attr_latex" "attr_odt" "caption"
  2125. "data" "header" "headers" "label" "name" "plot" "resname" "result" "results"
  2126. "source" "srcname" "tblname")
  2127. "List of affiliated keywords as strings.")
  2128. (defconst org-element-keyword-translation-alist
  2129. '(("data" . "name") ("label" . "name") ("resname" . "name")
  2130. ("source" . "name") ("srcname" . "name") ("tblname" . "name")
  2131. ("result" . "results") ("headers" . "header"))
  2132. "Alist of usual translations for keywords.
  2133. The key is the old name and the value the new one. The property
  2134. holding their value will be named after the translated name.")
  2135. (defconst org-element-multiple-keywords
  2136. '("attr_ascii" "attr_docbook" "attr_html" "attr_latex" "attr_odt" "header")
  2137. "List of affiliated keywords that can occur more that once in an element.
  2138. Their value will be consed into a list of strings, which will be
  2139. returned as the value of the property.
  2140. This list is checked after translations have been applied. See
  2141. `org-element-keyword-translation-alist'.")
  2142. (defconst org-element-parsed-keywords '("author" "caption" "title")
  2143. "List of keywords whose value can be parsed.
  2144. Their value will be stored as a secondary string: a list of
  2145. strings and objects.
  2146. This list is checked after translations have been applied. See
  2147. `org-element-keyword-translation-alist'.")
  2148. (defconst org-element-dual-keywords '("results")
  2149. "List of keywords which can have a secondary value.
  2150. In Org syntax, they can be written with optional square brackets
  2151. before the colons. For example, results keyword can be
  2152. associated to a hash value with the following:
  2153. #+results[hash-string]: some-source
  2154. This list is checked after translations have been applied. See
  2155. `org-element-keyword-translation-alist'.")
  2156. (defconst org-element-object-restrictions
  2157. '((emphasis entity export-snippet inline-babel-call inline-src-block
  2158. radio-target sub/superscript target text-markup time-stamp)
  2159. (link entity export-snippet inline-babel-call inline-src-block
  2160. latex-fragment sub/superscript text-markup)
  2161. (radio-target entity export-snippet latex-fragment sub/superscript)
  2162. (subscript entity export-snippet inline-babel-call inline-src-block
  2163. latex-fragment sub/superscript text-markup)
  2164. (superscript entity export-snippet inline-babel-call inline-src-block
  2165. latex-fragment sub/superscript text-markup)
  2166. (target entity export-snippet latex-fragment sub/superscript text-markup))
  2167. "Alist of recursive objects restrictions.
  2168. Car is a recursive object type and cdr is a list of successors
  2169. that will be called within an object of such type.
  2170. For example, in a `radio-target' object, one can only find
  2171. entities, export snippets, latex-fragments, subscript and
  2172. superscript.")
  2173. (defconst org-element-string-restrictions
  2174. '((headline entity inline-babel-call latex-fragment link macro radio-target
  2175. statistics-cookie sub/superscript text-markup time-stamp)
  2176. (inlinetask entity inline-babel-call latex-fragment link macro radio-target
  2177. sub/superscript text-markup time-stamp)
  2178. (item entity inline-babel-call latex-fragment macro radio-target
  2179. sub/superscript target verbatim)
  2180. (keyword entity latex-fragment macro sub/superscript text-markup)
  2181. (table entity latex-fragment macro text-markup)
  2182. (verse entity footnote-reference inline-babel-call inline-src-block
  2183. latex-fragment line-break link macro radio-target sub/superscript
  2184. target text-markup time-stamp))
  2185. "Alist of secondary strings restrictions.
  2186. When parsed, some elements have a secondary string which could
  2187. contain various objects (i.e. headline's name, or table's cells).
  2188. For association, the car is the element type, and the cdr a list
  2189. of successors that will be called in that secondary string.
  2190. Note: `keyword' secondary string type only applies to keywords
  2191. matching `org-element-parsed-keywords'.")
  2192. ;;; Accessors
  2193. ;;
  2194. ;; Provide two accessors: `org-element-get-property' and
  2195. ;; `org-element-get-contents'.
  2196. (defun org-element-get-property (property element)
  2197. "Extract the value from the PROPERTY of an ELEMENT."
  2198. (plist-get (nth 1 element) property))
  2199. (defun org-element-get-contents (element)
  2200. "Extract contents from an ELEMENT."
  2201. (nthcdr 2 element))
  2202. ;; Obtaining The Smallest Element Containing Point
  2203. ;; `org-element-at-point' is the core function of this section. It
  2204. ;; returns the Lisp representation of the element at point. It uses
  2205. ;; `org-element-guess-type' and `org-element-skip-keywords' as helper
  2206. ;; functions.
  2207. ;; When point is at an item, there is no automatic way to determine if
  2208. ;; the function should return the `plain-list' element, or the
  2209. ;; corresponding `item' element. By default, `org-element-at-point'
  2210. ;; works at the `plain-list' level. But, by providing an optional
  2211. ;; argument, one can make it switch to the `item' level.
  2212. (defconst org-element--affiliated-re
  2213. (format "[ \t]*#\\+\\(%s\\):"
  2214. (mapconcat
  2215. (lambda (keyword)
  2216. (if (member keyword org-element-dual-keywords)
  2217. (format "\\(%s\\)\\(?:\\[\\(.*?\\)\\]\\)?"
  2218. (regexp-quote keyword))
  2219. (regexp-quote keyword)))
  2220. org-element-affiliated-keywords "\\|"))
  2221. "Regexp matching any affiliated keyword.
  2222. Keyword name is put in match group 1. Moreover, if keyword
  2223. belongs to `org-element-dual-keywords', put the dual value in
  2224. match group 2.
  2225. Don't modify it, set `org-element--affiliated-keywords' instead.")
  2226. (defun org-element-at-point (&optional special structure)
  2227. "Determine closest element around point.
  2228. Return value is a list \(TYPE PROPS\) where TYPE is the type of
  2229. the element and PROPS a plist of properties associated to the
  2230. element.
  2231. Possible types are defined in `org-element-all-elements'.
  2232. Optional argument SPECIAL, when non-nil, can be either `item' or
  2233. `section'. The former allows to parse item wise instead of
  2234. plain-list wise, using STRUCTURE as the current list structure.
  2235. The latter will try to parse a section before anything else.
  2236. If STRUCTURE isn't provided but SPECIAL is set to `item', it will
  2237. be computed."
  2238. (save-excursion
  2239. (beginning-of-line)
  2240. ;; Move before any blank line.
  2241. (when (looking-at "[ \t]*$")
  2242. (skip-chars-backward " \r\t\n")
  2243. (beginning-of-line))
  2244. (let ((case-fold-search t))
  2245. ;; Check if point is at an affiliated keyword. In that case,
  2246. ;; try moving to the beginning of the associated element. If
  2247. ;; the keyword is orphaned, treat it as plain text.
  2248. (when (looking-at org-element--affiliated-re)
  2249. (let ((opoint (point)))
  2250. (while (looking-at org-element--affiliated-re) (forward-line))
  2251. (when (looking-at "[ \t]*$") (goto-char opoint))))
  2252. (let ((type (org-element-guess-type (eq special 'section))))
  2253. (cond
  2254. ;; Guessing element type on the current line is impossible:
  2255. ;; try to find the beginning of the current element to get
  2256. ;; more information.
  2257. ((not type)
  2258. (let ((search-origin (point))
  2259. (opoint-in-item-p (org-in-item-p))
  2260. (par-found-p
  2261. (progn
  2262. (end-of-line)
  2263. (re-search-backward org-element-paragraph-separate nil 'm))))
  2264. (cond
  2265. ;; Unable to find a paragraph delimiter above: we're at
  2266. ;; bob and looking at a paragraph.
  2267. ((not par-found-p) (org-element-paragraph-parser))
  2268. ;; Trying to find element's beginning set point back to
  2269. ;; its original position. There's something peculiar on
  2270. ;; this line that prevents parsing, probably an
  2271. ;; ill-formed keyword or an undefined drawer name. Parse
  2272. ;; it as plain text anyway.
  2273. ((< search-origin (point-at-eol)) (org-element-paragraph-parser))
  2274. ;; Original point wasn't in a list but previous paragraph
  2275. ;; is. It means that either point was inside some block,
  2276. ;; or current list was ended without using a blank line.
  2277. ;; In the last case, paragraph really starts at list end.
  2278. ((let (item)
  2279. (and (not opoint-in-item-p)
  2280. (not (looking-at "[ \t]*#\\+begin"))
  2281. (setq item (org-in-item-p))
  2282. (let ((struct (save-excursion (goto-char item)
  2283. (org-list-struct))))
  2284. (goto-char (org-list-get-bottom-point struct))
  2285. (org-skip-whitespace)
  2286. (beginning-of-line)
  2287. (org-element-paragraph-parser)))))
  2288. ((org-footnote-at-definition-p)
  2289. (org-element-footnote-definition-parser))
  2290. ((and opoint-in-item-p (org-at-item-p) (= opoint-in-item-p (point)))
  2291. (if (eq special 'item)
  2292. (org-element-item-parser (or structure (org-list-struct)))
  2293. (org-element-plain-list-parser (or structure (org-list-struct)))))
  2294. ;; In any other case, the paragraph started the line
  2295. ;; below.
  2296. (t (forward-line) (org-element-paragraph-parser)))))
  2297. ((eq type 'plain-list)
  2298. (if (eq special 'item)
  2299. (org-element-item-parser (or structure (org-list-struct)))
  2300. (org-element-plain-list-parser (or structure (org-list-struct)))))
  2301. ;; Straightforward case: call the appropriate parser.
  2302. (t (funcall (intern (format "org-element-%s-parser" type)))))))))
  2303. ;; It is obvious to tell if point is in most elements, either by
  2304. ;; looking for a specific regexp in the current line, or by using
  2305. ;; already implemented functions. This is the goal of
  2306. ;; `org-element-guess-type'.
  2307. (defconst org-element--element-block-types
  2308. (mapcar 'car org-element-non-recursive-block-alist)
  2309. "List of non-recursive block types, as strings.
  2310. Used internally by `org-element-guess-type'. Do not modify it
  2311. directly, set `org-element-non-recursive-block-alist' instead.")
  2312. (defun org-element-guess-type (&optional section-mode)
  2313. "Return the type of element at point, or nil if undetermined.
  2314. This function may move point to an appropriate position for
  2315. parsing. Used internally by `org-element-at-point'.
  2316. When optional argument SECTION-MODE is non-nil, try to find if
  2317. point is in a section in priority."
  2318. ;; Beware: Order matters for some cases in that function.
  2319. (beginning-of-line)
  2320. (let ((case-fold-search t))
  2321. (cond
  2322. ((org-with-limited-levels (org-at-heading-p)) 'headline)
  2323. ((let ((headline (ignore-errors (nth 4 (org-heading-components)))))
  2324. (and headline
  2325. (let (case-fold-search)
  2326. (string-match (format "^%s\\(?: \\|$\\)" org-quote-string)
  2327. headline))))
  2328. 'quote-section)
  2329. ;; Any buffer position not at an headline or in a quote section
  2330. ;; is inside a section, provided function is actively looking for
  2331. ;; them.
  2332. (section-mode 'section)
  2333. ;; Non-recursive block.
  2334. ((let ((type (org-in-block-p org-element--element-block-types)))
  2335. (and type (cdr (assoc type org-element-non-recursive-block-alist)))))
  2336. ((org-at-heading-p) 'inlinetask)
  2337. ((org-between-regexps-p
  2338. "^[ \t]*\\\\begin{" "^[ \t]*\\\\end{[^}]*}[ \t]*") 'latex-environment)
  2339. ;; Property drawer. Almost `org-at-property-p', but allow drawer
  2340. ;; boundaries.
  2341. ((org-with-wide-buffer
  2342. (and (not (org-before-first-heading-p))
  2343. (let ((pblock (org-get-property-block)))
  2344. (and pblock
  2345. (<= (point) (cdr pblock))
  2346. (>= (point-at-eol) (1- (car pblock)))))))
  2347. 'property-drawer)
  2348. ;; Recursive block. If the block isn't complete, parse the
  2349. ;; current part as a paragraph.
  2350. ((looking-at "[ \t]*#\\+\\(begin\\|end\\)_\\([-A-Za-z0-9]+\\)\\(?:$\\|\\s-\\)")
  2351. (let ((type (downcase (match-string 2))))
  2352. (cond
  2353. ((not (org-in-block-p (list type))) 'paragraph)
  2354. ((string= type "center") 'center-block)
  2355. ((string= type "quote") 'quote-block)
  2356. (t 'special-block))))
  2357. ;; Regular drawers must be tested after property drawer as both
  2358. ;; elements share the same ending regexp.
  2359. ((or (looking-at org-drawer-regexp) (looking-at "[ \t]*:END:[ \t]*$"))
  2360. (let ((completep (org-between-regexps-p
  2361. org-drawer-regexp "^[ \t]*:END:[ \t]*$")))
  2362. (if (not completep)
  2363. 'paragraph
  2364. (goto-char (car completep)) 'drawer)))
  2365. ((looking-at "[ \t]*:\\( \\|$\\)") 'fixed-width)
  2366. ;; Babel calls must be tested before general keywords as they are
  2367. ;; a subset of them.
  2368. ((looking-at org-babel-block-lob-one-liner-regexp) 'babel-call)
  2369. ((looking-at org-footnote-definition-re) 'footnote-definition)
  2370. ((looking-at "[ \t]*#\\+\\([a-z]+\\(:?_[a-z]+\\)*\\):")
  2371. (if (member (downcase (match-string 1)) org-element-affiliated-keywords)
  2372. 'paragraph
  2373. 'keyword))
  2374. ;; Dynamic block: simplify regexp used for match. If it isn't
  2375. ;; complete, parse the current part as a paragraph.
  2376. ((looking-at "[ \t]*#\\+\\(begin\\end\\):\\(?:\\s-\\|$\\)")
  2377. (let ((completep (org-between-regexps-p
  2378. "^[ \t]*#\\+begin:\\(?:\\s-\\|$\\)"
  2379. "^[ \t]*#\\+end:\\(?:\\s-\\|$\\)")))
  2380. (if (not completep)
  2381. 'paragraph
  2382. (goto-char (car completep)) 'dynamic-block)))
  2383. ((looking-at "\\(#\\|[ \t]*#\\+\\( \\|$\\)\\)") 'comment)
  2384. ((looking-at "[ \t]*-\\{5,\\}[ \t]*$") 'horizontal-rule)
  2385. ((org-at-table-p t) 'table)
  2386. ((looking-at "[ \t]*#\\+tblfm:")
  2387. (forward-line -1)
  2388. ;; A TBLFM line separated from any table is just plain text.
  2389. (if (org-at-table-p)
  2390. 'table
  2391. (forward-line) 'paragraph))
  2392. ((looking-at (org-item-re)) 'plain-list))))
  2393. ;; Most elements can have affiliated keywords. When looking for an
  2394. ;; element beginning, we want to move before them, as they belong to
  2395. ;; that element, and, in the meantime, collect information they give
  2396. ;; into appropriate properties. Hence the following function.
  2397. ;; Usage of optional arguments may not be obvious at first glance:
  2398. ;; - TRANS-LIST is used to polish keywords names that have evolved
  2399. ;; during Org history. In example, even though =result= and
  2400. ;; =results= coexist, we want to have them under the same =result=
  2401. ;; property. It's also true for "srcname" and "name", where the
  2402. ;; latter seems to be preferred nowadays (thus the "name" property).
  2403. ;; - CONSED allows to regroup multi-lines keywords under the same
  2404. ;; property, while preserving their own identity. This is mostly
  2405. ;; used for "attr_latex" and al.
  2406. ;; - PARSED prepares a keyword value for export. This is useful for
  2407. ;; "caption". Objects restrictions for such keywords are defined in
  2408. ;; `org-element-string-restrictions'.
  2409. ;; - DUALS is used to take care of keywords accepting a main and an
  2410. ;; optional secondary values. For example "results" has its
  2411. ;; source's name as the main value, and may have an hash string in
  2412. ;; optional square brackets as the secondary one.
  2413. ;; A keyword may belong to more than one category.
  2414. (defun org-element-collect-affiliated-keywords (&optional key-re trans-list
  2415. consed parsed duals)
  2416. "Collect affiliated keywords before point.
  2417. Optional argument KEY-RE is a regexp matching keywords, which
  2418. puts matched keyword in group 1. It defaults to
  2419. `org-element--affiliated-re'.
  2420. TRANS-LIST is an alist where key is the keyword and value the
  2421. property name it should be translated to, without the colons. It
  2422. defaults to `org-element-keyword-translation-alist'.
  2423. CONSED is a list of strings. Any keyword belonging to that list
  2424. will have its value consed. The check is done after keyword
  2425. translation. It defaults to `org-element-multiple-keywords'.
  2426. PARSED is a list of strings. Any keyword member of this list
  2427. will have its value parsed. The check is done after keyword
  2428. translation. If a keyword is a member of both CONSED and PARSED,
  2429. it's value will be a list of parsed strings. It defaults to
  2430. `org-element-parsed-keywords'.
  2431. DUALS is a list of strings. Any keyword member of this list can
  2432. have two parts: one mandatory and one optional. Its value is
  2433. a cons cell whose car is the former, and the cdr the latter. If
  2434. a keyword is a member of both PARSED and DUALS, only the primary
  2435. part will be parsed. It defaults to `org-element-dual-keywords'.
  2436. Return a list whose car is the position at the first of them and
  2437. cdr a plist of keywords and values."
  2438. (save-excursion
  2439. (let ((case-fold-search t)
  2440. (key-re (or key-re org-element--affiliated-re))
  2441. (trans-list (or trans-list org-element-keyword-translation-alist))
  2442. (consed (or consed org-element-multiple-keywords))
  2443. (parsed (or parsed org-element-parsed-keywords))
  2444. (duals (or duals org-element-dual-keywords))
  2445. output)
  2446. (unless (bobp)
  2447. (while (and (not (bobp))
  2448. (progn (forward-line -1) (looking-at key-re)))
  2449. (let* ((raw-kwd (downcase (or (match-string 2) (match-string 1))))
  2450. ;; Apply translation to RAW-KWD. From there, KWD is
  2451. ;; the official keyword.
  2452. (kwd (or (cdr (assoc raw-kwd trans-list)) raw-kwd))
  2453. ;; If KWD is a dual keyword, find it secondary value.
  2454. (dual-value (and (member kwd duals)
  2455. (org-match-string-no-properties 3)))
  2456. ;; Find main value for any keyword.
  2457. (value (org-trim (buffer-substring-no-properties
  2458. (match-end 0) (point-at-eol))))
  2459. ;; Attribute a property name to KWD.
  2460. (kwd-sym (and kwd (intern (concat ":" kwd)))))
  2461. ;; Now set final shape for VALUE.
  2462. (when (member kwd parsed)
  2463. (setq value
  2464. (org-element-parse-secondary-string
  2465. value
  2466. (cdr (assq 'keyword org-element-string-restrictions)))))
  2467. (when (member kwd duals) (setq value (cons value dual-value)))
  2468. (when (member kwd consed)
  2469. (setq value (cons value (plist-get output kwd-sym))))
  2470. ;; Eventually store the new value in OUTPUT.
  2471. (setq output (plist-put output kwd-sym value))))
  2472. (unless (looking-at key-re) (forward-line 1)))
  2473. (list (point) output))))
  2474. ;;; The Org Parser
  2475. ;; The two major functions here are `org-element-parse-buffer', which
  2476. ;; parses Org syntax inside the current buffer, taking into account
  2477. ;; region, narrowing, or even visibility if specified, and
  2478. ;; `org-element-parse-secondary-string', which parses objects within
  2479. ;; a given string.
  2480. ;; The (almost) almighty `org-element-map' allows to apply a function
  2481. ;; on elements or objects matching some type, and accumulate the
  2482. ;; resulting values. In an export situation, it also skips unneeded
  2483. ;; parts of the parse tree, transparently walks into included files,
  2484. ;; and maintain a list of local properties (i.e. those inherited from
  2485. ;; parent headlines) for function's consumption.
  2486. (defun org-element-parse-buffer (&optional granularity visible-only)
  2487. "Recursively parse the buffer and return structure.
  2488. If narrowing is in effect, only parse the visible part of the
  2489. buffer.
  2490. Optional argument GRANULARITY determines the depth of the
  2491. recursion. It can be set to the following symbols:
  2492. `headline' Only parse headlines.
  2493. `greater-element' Don't recurse into greater elements. Thus,
  2494. elements parsed are the top-level ones.
  2495. `element' Parse everything but objects and plain text.
  2496. `object' Parse the complete buffer (default).
  2497. When VISIBLE-ONLY is non-nil, don't parse contents of hidden
  2498. elements.
  2499. Assume buffer is in Org mode."
  2500. (save-excursion
  2501. (goto-char (point-min))
  2502. (org-skip-whitespace)
  2503. (nconc (list 'org-data nil)
  2504. (org-element-parse-elements
  2505. (point-at-bol) (point-max)
  2506. ;; Start is section mode so text before the first headline
  2507. ;; belongs to a section.
  2508. 'section nil granularity visible-only nil))))
  2509. (defun org-element-parse-secondary-string (string restriction &optional buffer)
  2510. "Recursively parse objects in STRING and return structure.
  2511. RESTRICTION, when non-nil, is a symbol limiting the object types
  2512. that will be looked after.
  2513. Optional argument BUFFER indicates the buffer from where the
  2514. secondary string was extracted. It is used to determine where to
  2515. get extraneous information for an object \(i.e. when resolving
  2516. a link or looking for a footnote definition\). It defaults to
  2517. the current buffer."
  2518. (with-temp-buffer
  2519. (insert string)
  2520. (org-element-parse-objects (point-min) (point-max) nil restriction)))
  2521. (defun org-element-map (data types fun &optional info first-match)
  2522. "Map a function on selected elements or objects.
  2523. DATA is the parsed tree, as returned by, i.e,
  2524. `org-element-parse-buffer'. TYPES is a symbol or list of symbols
  2525. of elements or objects types. FUN is the function called on the
  2526. matching element or object. It must accept two arguments: the
  2527. element or object itself and a plist holding contextual
  2528. information.
  2529. When optional argument INFO is non-nil, it should be a plist
  2530. holding export options. In that case, parts of the parse tree
  2531. not exportable according to that property list will be skipped
  2532. and files included through a keyword will be visited.
  2533. When optional argument FIRST-MATCH is non-nil, stop at the first
  2534. match for which FUN doesn't return nil, and return that value.
  2535. Nil values returned from FUN are ignored in the result."
  2536. ;; Ensure TYPES is a list, even of one element.
  2537. (unless (listp types) (setq types (list types)))
  2538. ;; Recursion depth is determined by --CATEGORY.
  2539. (let* ((--category
  2540. (cond
  2541. ((loop for type in types
  2542. always (memq type org-element-greater-elements))
  2543. 'greater-elements)
  2544. ((loop for type in types
  2545. always (memq type org-element-all-elements))
  2546. 'elements)
  2547. (t 'objects)))
  2548. walk-tree ; For byte-compiler
  2549. --acc
  2550. (accumulate-maybe
  2551. (function
  2552. (lambda (--type types fun --blob --local)
  2553. ;; Check if TYPE is matching among TYPES. If so, apply
  2554. ;; FUN to --BLOB and accumulate return value
  2555. ;; into --ACC. --LOCAL is the communication channel.
  2556. (when (memq --type types)
  2557. (let ((result (funcall fun --blob --local)))
  2558. (cond ((not result))
  2559. (first-match (throw 'first-match result))
  2560. (t (push result --acc))))))))
  2561. (walk-tree
  2562. (function
  2563. (lambda (--data --local)
  2564. ;; Recursively walk DATA. --LOCAL, if non-nil, is
  2565. ;; a plist holding contextual information.
  2566. (mapc
  2567. (lambda (--blob)
  2568. (let ((--type (if (stringp --blob) 'plain-text (car --blob))))
  2569. ;; Determine if a recursion into --BLOB is
  2570. ;; possible and allowed.
  2571. (cond
  2572. ;; Element or object not exportable.
  2573. ((and info (org-export-skip-p --blob info)))
  2574. ;; Archived headline: Maybe apply fun on it, but
  2575. ;; skip contents.
  2576. ((and info
  2577. (eq --type 'headline)
  2578. (eq (plist-get info :with-archived-trees) 'headline)
  2579. (org-element-get-property :archivedp --blob))
  2580. (funcall accumulate-maybe --type types fun --blob --local))
  2581. ;; At an include keyword: apply mapping to its
  2582. ;; contents.
  2583. ((and --local
  2584. (eq --type 'keyword)
  2585. (string=
  2586. (downcase (org-element-get-property :key --blob))
  2587. "include"))
  2588. (funcall accumulate-maybe --type types fun --blob --local)
  2589. (let* ((--data
  2590. (org-export-parse-included-file --blob --local))
  2591. (--value (org-element-get-property :value --blob))
  2592. (--file
  2593. (and (string-match "^\"\\(\\S-+\\)\"" --value)
  2594. (match-string 1 --value))))
  2595. (funcall
  2596. walk-tree --data
  2597. (org-combine-plists
  2598. --local
  2599. ;; Store full path of already included files
  2600. ;; to avoid recursive file inclusion.
  2601. `(:included-files
  2602. ,(cons (expand-file-name --file)
  2603. (plist-get --local :included-files))
  2604. ;; Ensure that a top-level headline in the
  2605. ;; included file becomes a direct child of
  2606. ;; the current headline in the buffer.
  2607. :headline-offset
  2608. ,(- (+ (plist-get
  2609. (plist-get --local :inherited-properties)
  2610. :level)
  2611. (or (plist-get --local :headline-offset) 0))
  2612. (1- (org-export-get-min-level
  2613. --data --local))))))))
  2614. ;; Limiting recursion to greater elements, and --BLOB
  2615. ;; isn't one.
  2616. ((and (eq --category 'greater-elements)
  2617. (not (memq --type org-element-greater-elements)))
  2618. (funcall accumulate-maybe --type types fun --blob --local))
  2619. ;; Limiting recursion to elements, and --BLOB only
  2620. ;; contains objects.
  2621. ((and (eq --category 'elements) (eq --type 'paragraph)))
  2622. ;; No limitation on recursion, but --BLOB hasn't
  2623. ;; got a recursive type.
  2624. ((and (eq --category 'objects)
  2625. (not (or (eq --type 'paragraph)
  2626. (memq --type org-element-greater-elements)
  2627. (memq --type org-element-recursive-objects))))
  2628. (funcall accumulate-maybe --type types fun --blob --local))
  2629. ;; Recursion is possible and allowed: Update local
  2630. ;; information and move into --BLOB.
  2631. (t (funcall accumulate-maybe --type types fun --blob --local)
  2632. (funcall
  2633. walk-tree --blob
  2634. (and info (org-export-update-info --blob --local t)))))))
  2635. (org-element-get-contents --data))))))
  2636. (catch 'first-match
  2637. (funcall walk-tree data info)
  2638. ;; Return value in a proper order.
  2639. (reverse --acc))))
  2640. ;; The following functions are internal parts of the parser. The
  2641. ;; first one, `org-element-parse-elements' acts at the element's
  2642. ;; level. The second one, `org-element-parse-objects' applies on all
  2643. ;; objects of a paragraph or a secondary string. It uses
  2644. ;; `org-element-get-candidates' to optimize the search of the next
  2645. ;; object in the buffer.
  2646. ;;
  2647. ;; More precisely, that function looks for every allowed object type
  2648. ;; first. Then, it discards failed searches, keeps further matches,
  2649. ;; and searches again types matched behind point, for subsequent
  2650. ;; calls. Thus, searching for a given type fails only once, and every
  2651. ;; object is searched only once at top level (but sometimes more for
  2652. ;; nested types).
  2653. (defun org-element-parse-elements
  2654. (beg end special structure granularity visible-only acc)
  2655. "Parse ELEMENT with point at its beginning.
  2656. SPECIAL prioritize some elements over the others. It can set to
  2657. either `section' or `item', which will focus search,
  2658. respectively, on sections and items. Moreover, when value is
  2659. `item', STRUCTURE will be used as the current list structure.
  2660. GRANULARITY determines the depth of the recursion. It can be set
  2661. to the following symbols:
  2662. `headline' Only parse headlines.
  2663. `greater-element' Don't recurse into greater elements. Thus,
  2664. elements parsed are the top-level ones.
  2665. `element' Parse everything but objects and plain text.
  2666. `object' or nil Parse the complete buffer.
  2667. When VISIBLE-ONLY is non-nil, don't parse contents of hidden
  2668. elements.
  2669. Elements are accumulated into ACC."
  2670. (save-excursion
  2671. (goto-char beg)
  2672. ;; Shortcut when parsing only headlines.
  2673. (when (and (eq granularity 'headline) (not (org-at-heading-p)))
  2674. (org-with-limited-levels (outline-next-heading)))
  2675. ;; Main loop start.
  2676. (while (and (< (point) end) (not (eobp)))
  2677. (push
  2678. ;; 1. Item mode is active: point is at an item. Knowing that,
  2679. ;; there's no need to go through `org-element-at-point'.
  2680. (if (eq special 'item)
  2681. (let* ((element (org-element-item-parser structure))
  2682. (cbeg (org-element-get-property :contents-begin element))
  2683. (cend (org-element-get-property :contents-end element)))
  2684. (goto-char (org-element-get-property :end element))
  2685. ;; Narrow region to contents, so that item bullet don't
  2686. ;; interfere with paragraph parsing.
  2687. (save-restriction
  2688. (narrow-to-region cbeg cend)
  2689. (org-element-parse-elements
  2690. cbeg cend nil structure granularity visible-only
  2691. (reverse element))))
  2692. ;; 2. When ITEM is nil, find current element's type and parse
  2693. ;; it accordingly to its category.
  2694. (let ((element (org-element-at-point special structure)))
  2695. (goto-char (org-element-get-property :end element))
  2696. (cond
  2697. ;; Case 1. ELEMENT is a footnote-definition. If
  2698. ;; GRANURALITY allows parsing, use narrowing so that
  2699. ;; footnote label don't interfere with paragraph
  2700. ;; recognition.
  2701. ((and (eq (car element) 'footnote-definition)
  2702. (not (memq granularity '(headline greater-element))))
  2703. (let ((cbeg (org-element-get-property :contents-begin element))
  2704. (cend (org-element-get-property :contents-end element)))
  2705. (save-restriction
  2706. (narrow-to-region cbeg cend)
  2707. (org-element-parse-elements
  2708. cbeg cend nil structure granularity visible-only
  2709. (reverse element)))))
  2710. ;; Case 2. ELEMENT is a paragraph. Parse objects inside,
  2711. ;; if GRANULARITY allows it.
  2712. ((and (eq (car element) 'paragraph)
  2713. (or (not granularity) (eq granularity 'object)))
  2714. (org-element-parse-objects
  2715. (org-element-get-property :contents-begin element)
  2716. (org-element-get-property :contents-end element)
  2717. (reverse element)
  2718. nil))
  2719. ;; Case 3. ELEMENT is recursive: parse it between
  2720. ;; `contents-begin' and `contents-end'. Make sure
  2721. ;; GRANULARITY allows the recursion, or ELEMENT is an
  2722. ;; headline, in which case going inside is mandatory, in
  2723. ;; order to get sub-level headings. If VISIBLE-ONLY is
  2724. ;; true and element is hidden, do not recurse into it.
  2725. ((and (memq (car element) org-element-greater-elements)
  2726. (or (not granularity)
  2727. (memq granularity '(element object))
  2728. (eq (car element) 'headline))
  2729. (not (and visible-only
  2730. (org-element-get-property :hiddenp element))))
  2731. (org-element-parse-elements
  2732. (org-element-get-property :contents-begin element)
  2733. (org-element-get-property :contents-end element)
  2734. ;; At a plain list, switch to item mode. At an
  2735. ;; headline, switch to section mode. Any other element
  2736. ;; turns off special modes.
  2737. (case (car element) (plain-list 'item) (headline 'section))
  2738. (org-element-get-property :structure element)
  2739. granularity
  2740. visible-only
  2741. (reverse element)))
  2742. ;; Case 4. Else, just accumulate ELEMENT.
  2743. (t element))))
  2744. acc)
  2745. (org-skip-whitespace))
  2746. ;; Return result.
  2747. (nreverse acc)))
  2748. (defun org-element-parse-objects (beg end acc restriction)
  2749. "Parse objects between BEG and END and return recursive structure.
  2750. Objects are accumulated in ACC.
  2751. RESTRICTION, when non-nil, is a list of object types which are
  2752. allowed in the current object."
  2753. (let ((get-next-object
  2754. (function
  2755. (lambda (cand)
  2756. ;; Return the parsing function associated to the nearest
  2757. ;; object among list of candidates CAND.
  2758. (let ((pos (apply #'min (mapcar #'cdr cand))))
  2759. (save-excursion
  2760. (goto-char pos)
  2761. (funcall
  2762. (intern
  2763. (format "org-element-%s-parser" (car (rassq pos cand))))))))))
  2764. next-object candidates)
  2765. (save-excursion
  2766. (goto-char beg)
  2767. (while (setq candidates (org-element-get-next-object-candidates
  2768. end restriction candidates))
  2769. (setq next-object (funcall get-next-object candidates))
  2770. ;; 1. Text before any object.
  2771. (let ((obj-beg (org-element-get-property :begin next-object)))
  2772. (unless (= beg obj-beg)
  2773. (push (buffer-substring-no-properties (point) obj-beg) acc)))
  2774. ;; 2. Object...
  2775. (let ((obj-end (org-element-get-property :end next-object))
  2776. (cont-beg (org-element-get-property :contents-begin next-object)))
  2777. (push (if (and (memq (car next-object) org-element-recursive-objects)
  2778. cont-beg)
  2779. ;; ... recursive. The CONT-BEG check is for
  2780. ;; links, as some of them might not be recursive
  2781. ;; (i.e. plain links).
  2782. (save-restriction
  2783. (narrow-to-region
  2784. cont-beg
  2785. (org-element-get-property :contents-end next-object))
  2786. (org-element-parse-objects
  2787. (point-min) (point-max) (reverse next-object)
  2788. ;; Restrict allowed objects. This is the
  2789. ;; intersection of current restriction and next
  2790. ;; object's restriction.
  2791. (let ((new-restr
  2792. (cdr (assq (car next-object)
  2793. org-element-object-restrictions))))
  2794. (if (not restriction)
  2795. new-restr
  2796. (delq nil
  2797. (mapcar (lambda (e)
  2798. (and (memq e restriction) e))
  2799. new-restr))))))
  2800. ;; ... not recursive.
  2801. next-object)
  2802. acc)
  2803. (goto-char obj-end)))
  2804. ;; 3. Text after last object.
  2805. (unless (= (point) end)
  2806. (push (buffer-substring-no-properties (point) end) acc))
  2807. ;; Result.
  2808. (nreverse acc))))
  2809. (defun org-element-get-next-object-candidates (limit restriction objects)
  2810. "Return an alist of candidates for the next object.
  2811. LIMIT bounds the search, and RESTRICTION, when non-nil, bounds
  2812. the possible object types.
  2813. Return value is an alist whose car is position and cdr the object
  2814. type, as a string. There is an association for the closest
  2815. object of each type within RESTRICTION when non-nil, or for every
  2816. type otherwise.
  2817. OBJECTS is the previous candidates alist."
  2818. (let ((restriction (or restriction org-element-all-successors))
  2819. next-candidates types-to-search)
  2820. ;; If no previous result, search every object type in RESTRICTION.
  2821. ;; Otherwise, keep potential candidates (old objects located after
  2822. ;; point) and ask to search again those which had matched before.
  2823. (if objects
  2824. (mapc (lambda (obj)
  2825. (if (< (cdr obj) (point))
  2826. (push (car obj) types-to-search)
  2827. (push obj next-candidates)))
  2828. objects)
  2829. (setq types-to-search restriction))
  2830. ;; Call the appropriate "get-next" function for each type to
  2831. ;; search and accumulate matches.
  2832. (mapc
  2833. (lambda (type)
  2834. (let* ((successor-fun
  2835. (intern
  2836. (format "org-element-%s-successor"
  2837. (or (cdr (assq type org-element-object-successor-alist))
  2838. type))))
  2839. (obj (funcall successor-fun limit)))
  2840. (and obj (push obj next-candidates))))
  2841. types-to-search)
  2842. ;; Return alist.
  2843. next-candidates))
  2844. ;;; Towards A Bijective Process
  2845. ;; The parse tree obtained with `org-element-parse-buffer' is really
  2846. ;; a snapshot of the corresponding Org buffer. Therefore, it can be
  2847. ;; interpreted and expanded into a string with canonical Org
  2848. ;; syntax. Hence `org-element-interpret-data'.
  2849. ;;
  2850. ;; Data parsed from secondary strings, whose shape is slightly
  2851. ;; different than the standard parse tree, is expanded with the
  2852. ;; equivalent function `org-element-interpret-secondary'.
  2853. ;;
  2854. ;; Both functions rely internally on
  2855. ;; `org-element-interpret--affiliated-keywords'.
  2856. (defun org-element-interpret-data (data &optional genealogy previous)
  2857. "Interpret a parse tree representing Org data.
  2858. DATA is the parse tree to interpret.
  2859. Optional arguments GENEALOGY and PREVIOUS are used for recursive
  2860. calls:
  2861. GENEALOGY is the list of its parents types.
  2862. PREVIOUS is the type of the element or object at the same level
  2863. interpreted before.
  2864. Return Org syntax as a string."
  2865. (mapconcat
  2866. (lambda (blob)
  2867. ;; BLOB can be an element, an object, a string, or nil.
  2868. (cond
  2869. ((not blob) nil)
  2870. ((equal blob "") nil)
  2871. ((stringp blob) blob)
  2872. (t
  2873. (let* ((type (car blob))
  2874. (interpreter
  2875. (if (eq type 'org-data)
  2876. 'identity
  2877. (intern (format "org-element-%s-interpreter" type))))
  2878. (contents
  2879. (cond
  2880. ;; Full Org document.
  2881. ((eq type 'org-data)
  2882. (org-element-interpret-data blob genealogy previous))
  2883. ;; Recursive objects.
  2884. ((memq type org-element-recursive-objects)
  2885. (org-element-interpret-data
  2886. blob (cons type genealogy) nil))
  2887. ;; Recursive elements.
  2888. ((memq type org-element-greater-elements)
  2889. (org-element-normalize-string
  2890. (org-element-interpret-data
  2891. blob (cons type genealogy) nil)))
  2892. ;; Paragraphs.
  2893. ((eq type 'paragraph)
  2894. (let ((paragraph
  2895. (org-element-normalize-contents
  2896. blob
  2897. ;; When normalizing contents of an item,
  2898. ;; ignore first line's indentation.
  2899. (and (not previous)
  2900. (memq (car genealogy)
  2901. '(footnote-definiton item))))))
  2902. (org-element-interpret-data
  2903. paragraph (cons type genealogy) nil)))))
  2904. (results (funcall interpreter blob contents)))
  2905. ;; Update PREVIOUS.
  2906. (setq previous type)
  2907. ;; Build white spaces.
  2908. (cond
  2909. ((eq type 'org-data) results)
  2910. ((memq type org-element-all-elements)
  2911. (concat
  2912. (org-element-interpret--affiliated-keywords blob)
  2913. (org-element-normalize-string results)
  2914. (make-string (org-element-get-property :post-blank blob) 10)))
  2915. (t (concat
  2916. results
  2917. (make-string
  2918. (org-element-get-property :post-blank blob) 32))))))))
  2919. (org-element-get-contents data) ""))
  2920. (defun org-element-interpret-secondary (secondary)
  2921. "Interpret SECONDARY string as Org syntax.
  2922. SECONDARY-STRING is a nested list as returned by
  2923. `org-element-parse-secondary-string'.
  2924. Return interpreted string."
  2925. ;; Make SECONDARY acceptable for `org-element-interpret-data'.
  2926. (let ((s (if (listp secondary) secondary (list secondary))))
  2927. (org-element-interpret-data `(org-data nil ,@s) nil nil)))
  2928. ;; Both functions internally use `org-element--affiliated-keywords'.
  2929. (defun org-element-interpret--affiliated-keywords (element)
  2930. "Return ELEMENT's affiliated keywords as Org syntax.
  2931. If there is no affiliated keyword, return the empty string."
  2932. (let ((keyword-to-org
  2933. (function
  2934. (lambda (key value)
  2935. (let (dual)
  2936. (when (member key org-element-dual-keywords)
  2937. (setq dual (cdr value) value (car value)))
  2938. (concat "#+" key (and dual (format "[%s]" dual)) ": "
  2939. (if (member key org-element-parsed-keywords)
  2940. (org-element-interpret-secondary value)
  2941. value)
  2942. "\n"))))))
  2943. (mapconcat
  2944. (lambda (key)
  2945. (let ((value (org-element-get-property (intern (concat ":" key)) element)))
  2946. (when value
  2947. (if (member key org-element-multiple-keywords)
  2948. (mapconcat (lambda (line)
  2949. (funcall keyword-to-org key line))
  2950. value "")
  2951. (funcall keyword-to-org key value)))))
  2952. ;; Remove translated keywords.
  2953. (delq nil
  2954. (mapcar
  2955. (lambda (key)
  2956. (and (not (assoc key org-element-keyword-translation-alist)) key))
  2957. org-element-affiliated-keywords))
  2958. "")))
  2959. ;; Because interpretation of the parse tree must return the same
  2960. ;; number of blank lines between elements and the same number of white
  2961. ;; space after objects, some special care must be given to white
  2962. ;; spaces.
  2963. ;;
  2964. ;; The first function, `org-element-normalize-string', ensures any
  2965. ;; string different from the empty string will end with a single
  2966. ;; newline character.
  2967. ;;
  2968. ;; The second function, `org-element-normalize-contents', removes
  2969. ;; global indentation from the contents of the current element.
  2970. (defun org-element-normalize-string (s)
  2971. "Ensure string S ends with a single newline character.
  2972. If S isn't a string return it unchanged. If S is the empty
  2973. string, return it. Otherwise, return a new string with a single
  2974. newline character at its end."
  2975. (cond
  2976. ((not (stringp s)) s)
  2977. ((string= "" s) "")
  2978. (t (and (string-match "\\(\n[ \t]*\\)*\\'" s)
  2979. (replace-match "\n" nil nil s)))))
  2980. (defun org-element-normalize-contents (element &optional ignore-first)
  2981. "Normalize plain text in ELEMENT's contents.
  2982. ELEMENT must only contain plain text and objects.
  2983. The following changes are applied to plain text:
  2984. - Remove global indentation, preserving relative one.
  2985. - Untabify it.
  2986. If optional argument IGNORE-FIRST is non-nil, ignore first line's
  2987. indentation to compute maximal common indentation.
  2988. Return the normalized element."
  2989. (nconc
  2990. (list (car element) (nth 1 element))
  2991. (let ((contents (org-element-get-contents element)))
  2992. (cond
  2993. ((and (not ignore-first) (not (stringp (car contents)))) contents)
  2994. (t
  2995. (catch 'exit
  2996. ;; 1. Remove tabs from each string in CONTENTS. Get maximal
  2997. ;; common indentation (MCI) along the way.
  2998. (let* ((ind-list (unless ignore-first
  2999. (list (org-get-string-indentation (car contents)))))
  3000. (contents
  3001. (mapcar (lambda (object)
  3002. (if (not (stringp object))
  3003. object
  3004. (let ((start 0)
  3005. (object (org-remove-tabs object)))
  3006. (while (string-match "\n\\( *\\)" object start)
  3007. (setq start (match-end 0))
  3008. (push (length (match-string 1 object))
  3009. ind-list))
  3010. object)))
  3011. contents))
  3012. (mci (if ind-list
  3013. (apply 'min ind-list)
  3014. (throw 'exit contents))))
  3015. ;; 2. Remove that indentation from CONTENTS. First string
  3016. ;; must be treated differently because it's the only one
  3017. ;; whose indentation doesn't happen after a newline
  3018. ;; character.
  3019. (let ((first-obj (car contents)))
  3020. (unless (or (not (stringp first-obj)) ignore-first)
  3021. (setq contents
  3022. (cons (replace-regexp-in-string
  3023. (format "\\` \\{%d\\}" mci) "" first-obj)
  3024. (cdr contents)))))
  3025. (mapcar (lambda (object)
  3026. (if (not (stringp object))
  3027. object
  3028. (replace-regexp-in-string
  3029. (format "\n \\{%d\\}" mci) "\n" object)))
  3030. contents))))))))
  3031. ;;; The Toolbox
  3032. ;; Once the structure of an Org file is well understood, it's easy to
  3033. ;; implement some replacements for `forward-paragraph'
  3034. ;; `backward-paragraph', namely `org-element-forward' and
  3035. ;; `org-element-backward'.
  3036. ;; Also, `org-transpose-elements' mimics the behaviour of
  3037. ;; `transpose-words', at the element's level, whereas
  3038. ;; `org-element-drag-forward', `org-element-drag-backward', and
  3039. ;; `org-element-up' generalize, respectively, functions
  3040. ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
  3041. ;; `org-element-unindent-buffer' will, as its name almost suggests,
  3042. ;; smartly remove global indentation from buffer, making it possible
  3043. ;; to use Org indent mode on a file created with hard indentation.
  3044. ;; `org-element-nested-p' and `org-element-swap-A-B' are used
  3045. ;; internally by some of the previously cited tools.
  3046. (defsubst org-element-nested-p (elem-A elem-B)
  3047. "Non-nil when elements ELEM-A and ELEM-B are nested."
  3048. (let ((beg-A (org-element-get-property :begin elem-A))
  3049. (beg-B (org-element-get-property :begin elem-B))
  3050. (end-A (org-element-get-property :end elem-A))
  3051. (end-B (org-element-get-property :end elem-B)))
  3052. (or (and (>= beg-A beg-B) (<= end-A end-B))
  3053. (and (>= beg-B beg-A) (<= end-B end-A)))))
  3054. (defun org-element-swap-A-B (elem-A elem-B)
  3055. "Swap elements ELEM-A and ELEM-B.
  3056. Leave point at the end of ELEM-A.
  3057. Assume ELEM-A is before ELEM-B and that they are not nested."
  3058. (goto-char (org-element-get-property :begin elem-A))
  3059. (let* ((beg-B (org-element-get-property :begin elem-B))
  3060. (end-B-no-blank (save-excursion
  3061. (goto-char (org-element-get-property :end elem-B))
  3062. (skip-chars-backward " \r\t\n")
  3063. (forward-line)
  3064. (point)))
  3065. (beg-A (org-element-get-property :begin elem-A))
  3066. (end-A-no-blank (save-excursion
  3067. (goto-char (org-element-get-property :end elem-A))
  3068. (skip-chars-backward " \r\t\n")
  3069. (forward-line)
  3070. (point)))
  3071. (body-A (buffer-substring beg-A end-A-no-blank))
  3072. (body-B (buffer-substring beg-B end-B-no-blank))
  3073. (between-A-B (buffer-substring end-A-no-blank beg-B)))
  3074. (delete-region beg-A end-B-no-blank)
  3075. (insert body-B between-A-B body-A)
  3076. (goto-char (org-element-get-property :end elem-B))))
  3077. (defun org-element-backward ()
  3078. "Move backward by one element."
  3079. (interactive)
  3080. (let* ((opoint (point))
  3081. (element (org-element-at-point))
  3082. (start-el-beg (org-element-get-property :begin element)))
  3083. ;; At an headline. The previous element is the previous sibling,
  3084. ;; or the parent if any.
  3085. (cond
  3086. ;; Already at the beginning of the current element: move to the
  3087. ;; beginning of the previous one.
  3088. ((= opoint start-el-beg)
  3089. (forward-line -1)
  3090. (skip-chars-backward " \r\t\n")
  3091. (let* ((prev-element (org-element-at-point))
  3092. (itemp (org-in-item-p))
  3093. (struct (and itemp
  3094. (save-excursion (goto-char itemp)
  3095. (org-list-struct)))))
  3096. ;; When moving into a new list, go directly at the
  3097. ;; beginning of the top list structure.
  3098. (if (and itemp (<= (org-list-get-bottom-point struct) opoint))
  3099. (progn
  3100. (goto-char (org-list-get-top-point struct))
  3101. (goto-char (org-element-get-property
  3102. :begin (org-element-at-point))))
  3103. (goto-char (org-element-get-property :begin prev-element))))
  3104. (while (org-truely-invisible-p) (org-element-up)))
  3105. ;; Else, move at the element beginning. One exception: if point
  3106. ;; was in the blank lines after the end of a list, move directly
  3107. ;; to the top item.
  3108. (t
  3109. (let (struct itemp)
  3110. (if (and (setq itemp (org-in-item-p))
  3111. (<= (org-list-get-bottom-point
  3112. (save-excursion (goto-char itemp)
  3113. (setq struct (org-list-struct))))
  3114. opoint))
  3115. (progn (goto-char (org-list-get-top-point struct))
  3116. (goto-char (org-element-get-property
  3117. :begin (org-element-at-point))))
  3118. (goto-char start-el-beg)))))))
  3119. (defun org-element-drag-backward ()
  3120. "Drag backward element at point."
  3121. (interactive)
  3122. (let* ((pos (point))
  3123. (elem (org-element-at-point)))
  3124. (when (= (progn (goto-char (point-min))
  3125. (org-skip-whitespace)
  3126. (point-at-bol))
  3127. (org-element-get-property :end elem))
  3128. (error "Cannot drag element backward"))
  3129. (goto-char (org-element-get-property :begin elem))
  3130. (org-element-backward)
  3131. (let ((prev-elem (org-element-at-point)))
  3132. (when (or (org-element-nested-p elem prev-elem)
  3133. (and (eq (car elem) 'headline)
  3134. (not (eq (car prev-elem) 'headline))))
  3135. (goto-char pos)
  3136. (error "Cannot drag element backward"))
  3137. ;; Compute new position of point: it's shifted by PREV-ELEM
  3138. ;; body's length.
  3139. (let ((size-prev (- (org-element-get-property :end prev-elem)
  3140. (org-element-get-property :begin prev-elem))))
  3141. (org-element-swap-A-B prev-elem elem)
  3142. (goto-char (- pos size-prev))))))
  3143. (defun org-element-drag-forward ()
  3144. "Move forward element at point."
  3145. (interactive)
  3146. (let* ((pos (point))
  3147. (elem (org-element-at-point)))
  3148. (when (= (point-max) (org-element-get-property :end elem))
  3149. (error "Cannot drag element forward"))
  3150. (goto-char (org-element-get-property :end elem))
  3151. (let ((next-elem (org-element-at-point)))
  3152. (when (or (org-element-nested-p elem next-elem)
  3153. (and (eq (car next-elem) 'headline)
  3154. (not (eq (car elem) 'headline))))
  3155. (goto-char pos)
  3156. (error "Cannot drag element forward"))
  3157. ;; Compute new position of point: it's shifted by NEXT-ELEM
  3158. ;; body's length (without final blanks) and by the length of
  3159. ;; blanks between ELEM and NEXT-ELEM.
  3160. (let ((size-next (- (save-excursion
  3161. (goto-char (org-element-get-property :end next-elem))
  3162. (skip-chars-backward " \r\t\n")
  3163. (forward-line)
  3164. (point))
  3165. (org-element-get-property :begin next-elem)))
  3166. (size-blank (- (org-element-get-property :end elem)
  3167. (save-excursion
  3168. (goto-char (org-element-get-property :end elem))
  3169. (skip-chars-backward " \r\t\n")
  3170. (forward-line)
  3171. (point)))))
  3172. (org-element-swap-A-B elem next-elem)
  3173. (goto-char (+ pos size-next size-blank))))))
  3174. (defun org-element-forward ()
  3175. "Move forward by one element."
  3176. (interactive)
  3177. (beginning-of-line)
  3178. (cond ((eobp) (error "Cannot move further down"))
  3179. ((looking-at "[ \t]*$")
  3180. (org-skip-whitespace)
  3181. (goto-char (if (eobp) (point) (point-at-bol))))
  3182. (t
  3183. (let ((element (org-element-at-point t))
  3184. (origin (point)))
  3185. (cond
  3186. ;; At an item: Either move to the next element inside, or
  3187. ;; to its end if it's hidden.
  3188. ((eq (car element) 'item)
  3189. (if (org-element-get-property :hiddenp element)
  3190. (goto-char (org-element-get-property :end element))
  3191. (end-of-line)
  3192. (re-search-forward org-element-paragraph-separate nil t)
  3193. (org-skip-whitespace)
  3194. (beginning-of-line)))
  3195. ;; At a recursive element: Either move inside, or if it's
  3196. ;; hidden, move to its end.
  3197. ((memq (car element) org-element-greater-elements)
  3198. (let ((cbeg (org-element-get-property :contents-begin element)))
  3199. (goto-char
  3200. (if (or (org-element-get-property :hiddenp element)
  3201. (> origin cbeg))
  3202. (org-element-get-property :end element)
  3203. cbeg))))
  3204. ;; Else: move to the current element's end.
  3205. (t (goto-char (org-element-get-property :end element))))))))
  3206. (defun org-element-mark-element ()
  3207. "Put point at beginning of this element, mark at end.
  3208. Interactively, if this command is repeated or (in Transient Mark
  3209. mode) if the mark is active, it marks the next element after the
  3210. ones already marked."
  3211. (interactive)
  3212. (let (deactivate-mark)
  3213. (if (or (and (eq last-command this-command) (mark t))
  3214. (and transient-mark-mode mark-active))
  3215. (set-mark
  3216. (save-excursion
  3217. (goto-char (mark))
  3218. (goto-char (org-element-get-property :end (org-element-at-point)))))
  3219. (let ((element (org-element-at-point)))
  3220. (end-of-line)
  3221. (push-mark (org-element-get-property :end element) t t)
  3222. (goto-char (org-element-get-property :begin element))))))
  3223. (defun org-narrow-to-element ()
  3224. "Narrow buffer to current element."
  3225. (interactive)
  3226. (let ((elem (org-element-at-point)))
  3227. (cond
  3228. ((eq (car elem) 'headline)
  3229. (narrow-to-region
  3230. (org-element-get-property :begin elem)
  3231. (org-element-get-property :end elem)))
  3232. ((memq (car elem) org-element-greater-elements)
  3233. (narrow-to-region
  3234. (org-element-get-property :contents-begin elem)
  3235. (org-element-get-property :contents-end elem)))
  3236. (t
  3237. (narrow-to-region
  3238. (org-element-get-property :begin elem)
  3239. (org-element-get-property :end elem))))))
  3240. (defun org-transpose-elements ()
  3241. "Transpose current and previous elements, keeping blank lines between.
  3242. Point is moved after both elements."
  3243. (interactive)
  3244. (org-skip-whitespace)
  3245. (let ((pos (point))
  3246. (cur (org-element-at-point)))
  3247. (when (= (save-excursion (goto-char (point-min))
  3248. (org-skip-whitespace)
  3249. (point-at-bol))
  3250. (org-element-get-property :begin cur))
  3251. (error "No previous element"))
  3252. (goto-char (org-element-get-property :begin cur))
  3253. (forward-line -1)
  3254. (let ((prev (org-element-at-point)))
  3255. (when (org-element-nested-p cur prev)
  3256. (goto-char pos)
  3257. (error "Cannot transpose nested elements"))
  3258. (org-element-swap-A-B prev cur))))
  3259. (defun org-element-unindent-buffer ()
  3260. "Un-indent the visible part of the buffer.
  3261. Relative indentation \(between items, inside blocks, etc.\) isn't
  3262. modified."
  3263. (interactive)
  3264. (unless (eq major-mode 'org-mode)
  3265. (error "Cannot un-indent a buffer not in Org mode"))
  3266. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  3267. unindent-tree ; For byte-compiler.
  3268. (unindent-tree
  3269. (function
  3270. (lambda (contents)
  3271. (mapc (lambda (element)
  3272. (if (eq (car element) 'headline)
  3273. (funcall unindent-tree
  3274. (org-element-get-contents element))
  3275. (save-excursion
  3276. (save-restriction
  3277. (narrow-to-region
  3278. (org-element-get-property :begin element)
  3279. (org-element-get-property :end element))
  3280. (org-do-remove-indentation)))))
  3281. (reverse contents))))))
  3282. (funcall unindent-tree (org-element-get-contents parse-tree))))
  3283. (defun org-element-up ()
  3284. "Move to upper element.
  3285. Return position at the beginning of the upper element."
  3286. (interactive)
  3287. (let ((opoint (point)) elem)
  3288. (cond
  3289. ((bobp) (error "No surrounding element"))
  3290. ((org-with-limited-levels (org-at-heading-p))
  3291. (or (org-up-heading-safe) (error "No surronding element")))
  3292. ((and (org-at-item-p)
  3293. (setq elem (org-element-at-point))
  3294. (let* ((top-list-p (zerop (org-element-get-property :level elem))))
  3295. (unless top-list-p
  3296. ;; If parent is bound to be in the same list as the
  3297. ;; original point, move to that parent.
  3298. (let ((struct (org-element-get-property :structure elem)))
  3299. (goto-char
  3300. (org-list-get-parent
  3301. (point-at-bol) struct (org-list-parents-alist struct))))))))
  3302. (t
  3303. (let* ((elem (or elem (org-element-at-point)))
  3304. (end (save-excursion
  3305. (goto-char (org-element-get-property :end elem))
  3306. (skip-chars-backward " \r\t\n")
  3307. (forward-line)
  3308. (point)))
  3309. prev-elem)
  3310. (goto-char (org-element-get-property :begin elem))
  3311. (forward-line -1)
  3312. (while (and (< (org-element-get-property
  3313. :end (setq prev-elem (org-element-at-point)))
  3314. end)
  3315. (not (bobp)))
  3316. (goto-char (org-element-get-property :begin prev-elem))
  3317. (forward-line -1))
  3318. (if (and (bobp) (< (org-element-get-property :end prev-elem) end))
  3319. (progn (goto-char opoint)
  3320. (error "No surrounding element"))
  3321. (goto-char (org-element-get-property :begin prev-elem))))))))
  3322. (provide 'org-element)
  3323. ;;; org-element.el ends here