org-element.el 149 KB

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