org-element.el 174 KB

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