org-element.el 174 KB

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