org-element.el 176 KB

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