org-element.el 216 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110
  1. ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2012-2021 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 <https://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;;
  18. ;; See <https://orgmode.org/worg/dev/org-syntax.html> for details about
  19. ;; Org syntax.
  20. ;;
  21. ;; Lisp-wise, a syntax object can be represented as a list.
  22. ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
  23. ;; TYPE is a symbol describing the object.
  24. ;; PROPERTIES is the property list attached to it. See docstring of
  25. ;; appropriate parsing function to get an exhaustive list.
  26. ;; CONTENTS is a list of syntax objects or raw strings contained
  27. ;; in the current object, when applicable.
  28. ;;
  29. ;; For the whole document, TYPE is `org-data' and PROPERTIES is nil.
  30. ;;
  31. ;; The first part of this file defines constants for the Org syntax,
  32. ;; while the second one provide accessors and setters functions.
  33. ;;
  34. ;; The next part implements a parser and an interpreter for each
  35. ;; element and object type in Org syntax.
  36. ;;
  37. ;; The following part creates a fully recursive buffer parser. It
  38. ;; also provides a tool to map a function to elements or objects
  39. ;; matching some criteria in the parse tree. Functions of interest
  40. ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
  41. ;; extent, `org-element-parse-secondary-string'.
  42. ;;
  43. ;; The penultimate part is the cradle of an interpreter for the
  44. ;; obtained parse tree: `org-element-interpret-data'.
  45. ;;
  46. ;; The library ends by furnishing `org-element-at-point' function, and
  47. ;; a way to give information about document structure around point
  48. ;; with `org-element-context'. A cache mechanism is also provided for
  49. ;; these functions.
  50. ;;; Code:
  51. (require 'avl-tree)
  52. (require 'cl-lib)
  53. (require 'ol)
  54. (require 'org)
  55. (require 'org-compat)
  56. (require 'org-entities)
  57. (require 'org-footnote)
  58. (require 'org-list)
  59. (require 'org-macs)
  60. (require 'org-table)
  61. (declare-function org-at-heading-p "org" (&optional _))
  62. (declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
  63. (declare-function org-escape-code-in-string "org-src" (s))
  64. (declare-function org-macro-escape-arguments "org-macro" (&rest args))
  65. (declare-function org-macro-extract-arguments "org-macro" (s))
  66. (declare-function org-reduced-level "org" (l))
  67. (declare-function org-unescape-code-in-string "org-src" (s))
  68. (declare-function outline-next-heading "outline" ())
  69. (declare-function outline-previous-heading "outline" ())
  70. (defvar org-archive-tag)
  71. (defvar org-clock-line-re)
  72. (defvar org-closed-string)
  73. (defvar org-comment-string)
  74. (defvar org-complex-heading-regexp)
  75. (defvar org-dblock-start-re)
  76. (defvar org-deadline-string)
  77. (defvar org-done-keywords)
  78. (defvar org-drawer-regexp)
  79. (defvar org-edit-src-content-indentation)
  80. (defvar org-emph-re)
  81. (defvar org-emphasis-regexp-components)
  82. (defvar org-keyword-time-not-clock-regexp)
  83. (defvar org-match-substring-regexp)
  84. (defvar org-odd-levels-only)
  85. (defvar org-outline-regexp-bol)
  86. (defvar org-planning-line-re)
  87. (defvar org-property-drawer-re)
  88. (defvar org-property-format)
  89. (defvar org-property-re)
  90. (defvar org-scheduled-string)
  91. (defvar org-src-preserve-indentation)
  92. (defvar org-tags-column)
  93. (defvar org-time-stamp-formats)
  94. (defvar org-todo-regexp)
  95. (defvar org-ts-regexp-both)
  96. (defvar org-verbatim-re)
  97. ;;; Definitions And Rules
  98. ;;
  99. ;; Define elements, greater elements and specify recursive objects,
  100. ;; along with the affiliated keywords recognized. Also set up
  101. ;; restrictions on recursive objects combinations.
  102. ;;
  103. ;; `org-element-update-syntax' builds proper syntax regexps according
  104. ;; to current setup.
  105. (defvar org-element-paragraph-separate nil
  106. "Regexp to separate paragraphs in an Org buffer.
  107. In the case of lines starting with \"#\" and \":\", this regexp
  108. is not sufficient to know if point is at a paragraph ending. See
  109. `org-element-paragraph-parser' for more information.")
  110. (defvar org-element--object-regexp nil
  111. "Regexp possibly matching the beginning of an object.
  112. This regexp allows false positives. Dedicated parser (e.g.,
  113. `org-export-bold-parser') will take care of further filtering.
  114. Radio links are not matched by this regexp, as they are treated
  115. specially in `org-element--object-lex'.")
  116. (defun org-element--set-regexps ()
  117. "Build variable syntax regexps."
  118. (setq org-element-paragraph-separate
  119. (concat "^\\(?:"
  120. ;; Headlines, inlinetasks.
  121. "\\*+ " "\\|"
  122. ;; Footnote definitions.
  123. "\\[fn:[-_[:word:]]+\\]" "\\|"
  124. ;; Diary sexps.
  125. "%%(" "\\|"
  126. "[ \t]*\\(?:"
  127. ;; Empty lines.
  128. "$" "\\|"
  129. ;; Tables (any type).
  130. "|" "\\|"
  131. "\\+\\(?:-+\\+\\)+[ \t]*$" "\\|"
  132. ;; Comments, keyword-like or block-like constructs.
  133. ;; Blocks and keywords with dual values need to be
  134. ;; double-checked.
  135. "#\\(?: \\|$\\|\\+\\(?:"
  136. "BEGIN_\\S-+" "\\|"
  137. "\\S-+\\(?:\\[.*\\]\\)?:[ \t]*\\)\\)"
  138. "\\|"
  139. ;; Drawers (any type) and fixed-width areas. Drawers
  140. ;; need to be double-checked.
  141. ":\\(?: \\|$\\|[-_[:word:]]+:[ \t]*$\\)" "\\|"
  142. ;; Horizontal rules.
  143. "-\\{5,\\}[ \t]*$" "\\|"
  144. ;; LaTeX environments.
  145. "\\\\begin{\\([A-Za-z0-9*]+\\)}" "\\|"
  146. ;; Clock lines.
  147. "CLOCK:" "\\|"
  148. ;; Lists.
  149. (let ((term (pcase org-plain-list-ordered-item-terminator
  150. (?\) ")") (?. "\\.") (_ "[.)]")))
  151. (alpha (and org-list-allow-alphabetical "\\|[A-Za-z]")))
  152. (concat "\\(?:[-+*]\\|\\(?:[0-9]+" alpha "\\)" term "\\)"
  153. "\\(?:[ \t]\\|$\\)"))
  154. "\\)\\)")
  155. org-element--object-regexp
  156. (mapconcat #'identity
  157. (let ((link-types (regexp-opt (org-link-types))))
  158. (list
  159. ;; Sub/superscript.
  160. "\\(?:[_^][-{(*+.,[:alnum:]]\\)"
  161. ;; Bold, code, italic, strike-through, underline
  162. ;; and verbatim.
  163. (concat "[*~=+_/]"
  164. (format "[^%s]"
  165. (nth 2 org-emphasis-regexp-components)))
  166. ;; Plain links.
  167. (concat "\\<" link-types ":")
  168. ;; Objects starting with "[": regular link,
  169. ;; footnote reference, statistics cookie,
  170. ;; timestamp (inactive).
  171. (concat "\\[\\(?:"
  172. "fn:" "\\|"
  173. "\\[" "\\|"
  174. "[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}" "\\|"
  175. "[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
  176. "\\)")
  177. ;; Objects starting with "@": export snippets.
  178. "@@"
  179. ;; Objects starting with "{": macro.
  180. "{{{"
  181. ;; Objects starting with "<" : timestamp
  182. ;; (active, diary), target, radio target and
  183. ;; angular links.
  184. (concat "<\\(?:%%\\|<\\|[0-9]\\|" link-types "\\)")
  185. ;; Objects starting with "$": latex fragment.
  186. "\\$"
  187. ;; Objects starting with "\": line break,
  188. ;; entity, latex fragment.
  189. "\\\\\\(?:[a-zA-Z[(]\\|\\\\[ \t]*$\\|_ +\\)"
  190. ;; Objects starting with raw text: inline Babel
  191. ;; source block, inline Babel call.
  192. "\\(?:call\\|src\\)_"))
  193. "\\|")))
  194. (org-element--set-regexps)
  195. ;;;###autoload
  196. (defun org-element-update-syntax ()
  197. "Update parser internals."
  198. (interactive)
  199. (org-element--set-regexps)
  200. (org-element-cache-reset 'all))
  201. (defconst org-element-all-elements
  202. '(babel-call center-block clock comment comment-block diary-sexp drawer
  203. dynamic-block example-block export-block fixed-width
  204. footnote-definition headline horizontal-rule inlinetask item
  205. keyword latex-environment node-property paragraph plain-list
  206. planning property-drawer quote-block section
  207. special-block src-block table table-row verse-block)
  208. "Complete list of element types.")
  209. (defconst org-element-greater-elements
  210. '(center-block drawer dynamic-block footnote-definition headline inlinetask
  211. item plain-list property-drawer quote-block section
  212. special-block table)
  213. "List of recursive element types aka Greater Elements.")
  214. (defconst org-element-all-objects
  215. '(bold code entity export-snippet footnote-reference inline-babel-call
  216. inline-src-block italic line-break latex-fragment link macro
  217. radio-target statistics-cookie strike-through subscript superscript
  218. table-cell target timestamp underline verbatim)
  219. "Complete list of object types.")
  220. (defconst org-element-recursive-objects
  221. '(bold footnote-reference italic link subscript radio-target strike-through
  222. superscript table-cell underline)
  223. "List of recursive object types.")
  224. (defconst org-element-object-containers
  225. (append org-element-recursive-objects '(paragraph table-row verse-block))
  226. "List of object or element types that can directly contain objects.")
  227. (defconst org-element-affiliated-keywords
  228. '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
  229. "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
  230. "List of affiliated keywords as strings.
  231. By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
  232. are affiliated keywords and need not to be in this list.")
  233. (defconst org-element-keyword-translation-alist
  234. '(("DATA" . "NAME") ("LABEL" . "NAME") ("RESNAME" . "NAME")
  235. ("SOURCE" . "NAME") ("SRCNAME" . "NAME") ("TBLNAME" . "NAME")
  236. ("RESULT" . "RESULTS") ("HEADERS" . "HEADER"))
  237. "Alist of usual translations for keywords.
  238. The key is the old name and the value the new one. The property
  239. holding their value will be named after the translated name.")
  240. (defconst org-element-multiple-keywords '("CAPTION" "HEADER")
  241. "List of affiliated keywords that can occur more than once in an element.
  242. Their value will be consed into a list of strings, which will be
  243. returned as the value of the property.
  244. This list is checked after translations have been applied. See
  245. `org-element-keyword-translation-alist'.
  246. By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
  247. allow multiple occurrences and need not to be in this list.")
  248. (defconst org-element-parsed-keywords '("CAPTION")
  249. "List of affiliated keywords whose value can be parsed.
  250. Their value will be stored as a secondary string: a list of
  251. strings and objects.
  252. This list is checked after translations have been applied. See
  253. `org-element-keyword-translation-alist'.")
  254. (defconst org-element--parsed-properties-alist
  255. (mapcar (lambda (k) (cons k (intern (concat ":" (downcase k)))))
  256. org-element-parsed-keywords)
  257. "Alist of parsed keywords and associated properties.
  258. This is generated from `org-element-parsed-keywords', which
  259. see.")
  260. (defconst org-element-dual-keywords '("CAPTION" "RESULTS")
  261. "List of affiliated keywords which can have a secondary value.
  262. In Org syntax, they can be written with optional square brackets
  263. before the colons. For example, RESULTS keyword can be
  264. associated to a hash value with the following:
  265. #+RESULTS[hash-string]: some-source
  266. This list is checked after translations have been applied. See
  267. `org-element-keyword-translation-alist'.")
  268. (defconst org-element--affiliated-re
  269. (format "[ \t]*#\\+\\(?:%s\\):[ \t]*"
  270. (concat
  271. ;; Dual affiliated keywords.
  272. (format "\\(?1:%s\\)\\(?:\\[\\(.*\\)\\]\\)?"
  273. (regexp-opt org-element-dual-keywords))
  274. "\\|"
  275. ;; Regular affiliated keywords.
  276. (format "\\(?1:%s\\)"
  277. (regexp-opt
  278. (cl-remove-if
  279. (lambda (k) (member k org-element-dual-keywords))
  280. org-element-affiliated-keywords)))
  281. "\\|"
  282. ;; Export attributes.
  283. "\\(?1:ATTR_[-_A-Za-z0-9]+\\)"))
  284. "Regexp matching any affiliated keyword.
  285. Keyword name is put in match group 1. Moreover, if keyword
  286. belongs to `org-element-dual-keywords', put the dual value in
  287. match group 2.
  288. Don't modify it, set `org-element-affiliated-keywords' instead.")
  289. (defconst org-element-object-restrictions
  290. (let* ((minimal-set '(bold code entity italic latex-fragment strike-through
  291. subscript superscript underline verbatim))
  292. (standard-set (remq 'table-cell org-element-all-objects))
  293. (standard-set-no-line-break (remq 'line-break standard-set)))
  294. `((bold ,@standard-set)
  295. (footnote-reference ,@standard-set)
  296. (headline ,@standard-set-no-line-break)
  297. (inlinetask ,@standard-set-no-line-break)
  298. (italic ,@standard-set)
  299. (item ,@standard-set-no-line-break)
  300. (keyword ,@(remq 'footnote-reference standard-set))
  301. ;; Ignore all links in a link description. Also ignore
  302. ;; radio-targets and line breaks.
  303. (link export-snippet inline-babel-call inline-src-block macro
  304. statistics-cookie ,@minimal-set)
  305. (paragraph ,@standard-set)
  306. ;; Remove any variable object from radio target as it would
  307. ;; prevent it from being properly recognized.
  308. (radio-target ,@minimal-set)
  309. (strike-through ,@standard-set)
  310. (subscript ,@standard-set)
  311. (superscript ,@standard-set)
  312. ;; Ignore inline babel call and inline source block as formulas
  313. ;; are possible. Also ignore line breaks and statistics
  314. ;; cookies.
  315. (table-cell export-snippet footnote-reference link macro radio-target
  316. target timestamp ,@minimal-set)
  317. (table-row table-cell)
  318. (underline ,@standard-set)
  319. (verse-block ,@standard-set)))
  320. "Alist of objects restrictions.
  321. key is an element or object type containing objects and value is
  322. a list of types that can be contained within an element or object
  323. of such type.
  324. This alist also applies to secondary string. For example, an
  325. `headline' type element doesn't directly contain objects, but
  326. still has an entry since one of its properties (`:title') does.")
  327. (defconst org-element-secondary-value-alist
  328. '((headline :title)
  329. (inlinetask :title)
  330. (item :tag))
  331. "Alist between element types and locations of secondary values.")
  332. (defconst org-element--pair-round-table
  333. (let ((table (make-syntax-table)))
  334. (modify-syntax-entry ?\( "()" table)
  335. (modify-syntax-entry ?\) ")(" table)
  336. (dolist (char '(?\{ ?\} ?\[ ?\] ?\< ?\>) table)
  337. (modify-syntax-entry char " " table)))
  338. "Table used internally to pair only round brackets.
  339. Other brackets are treated as spaces.")
  340. (defconst org-element--pair-square-table
  341. (let ((table (make-syntax-table)))
  342. (modify-syntax-entry ?\[ "(]" table)
  343. (modify-syntax-entry ?\] ")[" table)
  344. (dolist (char '(?\{ ?\} ?\( ?\) ?\< ?\>) table)
  345. (modify-syntax-entry char " " table)))
  346. "Table used internally to pair only square brackets.
  347. Other brackets are treated as spaces.")
  348. (defconst org-element--pair-curly-table
  349. (let ((table (make-syntax-table)))
  350. (modify-syntax-entry ?\{ "(}" table)
  351. (modify-syntax-entry ?\} "){" table)
  352. (dolist (char '(?\[ ?\] ?\( ?\) ?\< ?\>) table)
  353. (modify-syntax-entry char " " table)))
  354. "Table used internally to pair only curly brackets.
  355. Other brackets are treated as spaces.")
  356. (defun org-element--parse-paired-brackets (char)
  357. "Parse paired brackets at point.
  358. CHAR is the opening bracket to consider, as a character. Return
  359. contents between brackets, as a string, or nil. Also move point
  360. past the brackets."
  361. (when (eq char (char-after))
  362. (let ((syntax-table (pcase char
  363. (?\{ org-element--pair-curly-table)
  364. (?\[ org-element--pair-square-table)
  365. (?\( org-element--pair-round-table)
  366. (_ nil)))
  367. (pos (point)))
  368. (when syntax-table
  369. (with-syntax-table syntax-table
  370. (let ((end (ignore-errors (scan-lists pos 1 0))))
  371. (when end
  372. (goto-char end)
  373. (buffer-substring-no-properties (1+ pos) (1- end)))))))))
  374. ;;; Accessors and Setters
  375. ;;
  376. ;; Provide four accessors: `org-element-type', `org-element-property'
  377. ;; `org-element-contents' and `org-element-restriction'.
  378. ;;
  379. ;; Setter functions allow modification of elements by side effect.
  380. ;; There is `org-element-put-property', `org-element-set-contents'.
  381. ;; These low-level functions are useful to build a parse tree.
  382. ;;
  383. ;; `org-element-adopt-elements', `org-element-set-element',
  384. ;; `org-element-extract-element' and `org-element-insert-before' are
  385. ;; high-level functions useful to modify a parse tree.
  386. ;;
  387. ;; `org-element-secondary-p' is a predicate used to know if a given
  388. ;; object belongs to a secondary string. `org-element-class' tells if
  389. ;; some parsed data is an element or an object, handling pseudo
  390. ;; elements and objects. `org-element-copy' returns an element or
  391. ;; object, stripping its parent property in the process.
  392. (defsubst org-element-type (element)
  393. "Return type of ELEMENT.
  394. The function returns the type of the element or object provided.
  395. It can also return the following special value:
  396. `plain-text' for a string
  397. `org-data' for a complete document
  398. nil in any other case."
  399. (cond
  400. ((not (consp element)) (and (stringp element) 'plain-text))
  401. ((symbolp (car element)) (car element))))
  402. (defsubst org-element-property (property element)
  403. "Extract the value from the PROPERTY of an ELEMENT."
  404. (if (stringp element) (get-text-property 0 property element)
  405. (plist-get (nth 1 element) property)))
  406. (defsubst org-element-contents (element)
  407. "Extract contents from an ELEMENT."
  408. (cond ((not (consp element)) nil)
  409. ((symbolp (car element)) (nthcdr 2 element))
  410. (t element)))
  411. (defsubst org-element-restriction (element)
  412. "Return restriction associated to ELEMENT.
  413. ELEMENT can be an element, an object or a symbol representing an
  414. element or object type."
  415. (cdr (assq (if (symbolp element) element (org-element-type element))
  416. org-element-object-restrictions)))
  417. (defsubst org-element-put-property (element property value)
  418. "In ELEMENT set PROPERTY to VALUE.
  419. Return modified element."
  420. (if (stringp element) (org-add-props element nil property value)
  421. (setcar (cdr element) (plist-put (nth 1 element) property value))
  422. element))
  423. (defsubst org-element-set-contents (element &rest contents)
  424. "Set ELEMENT's contents to CONTENTS.
  425. Return ELEMENT."
  426. (cond ((null element) contents)
  427. ((not (symbolp (car element))) contents)
  428. ((cdr element) (setcdr (cdr element) contents) element)
  429. (t (nconc element contents))))
  430. (defun org-element-secondary-p (object)
  431. "Non-nil when OBJECT directly belongs to a secondary string.
  432. Return value is the property name, as a keyword, or nil."
  433. (let* ((parent (org-element-property :parent object))
  434. (properties (cdr (assq (org-element-type parent)
  435. org-element-secondary-value-alist))))
  436. (catch 'exit
  437. (dolist (p properties)
  438. (and (memq object (org-element-property p parent))
  439. (throw 'exit p))))))
  440. (defsubst org-element-class (datum &optional parent)
  441. "Return class for ELEMENT, as a symbol.
  442. Class is either `element' or `object'. Optional argument PARENT
  443. is the element or object containing DATUM. It defaults to the
  444. value of DATUM `:parent' property."
  445. (let ((type (org-element-type datum))
  446. (parent (or parent (org-element-property :parent datum))))
  447. (cond
  448. ;; Trivial cases.
  449. ((memq type org-element-all-objects) 'object)
  450. ((memq type org-element-all-elements) 'element)
  451. ;; Special cases.
  452. ((eq type 'org-data) 'element)
  453. ((eq type 'plain-text) 'object)
  454. ((not type) 'object)
  455. ;; Pseudo object or elements. Make a guess about its class.
  456. ;; Basically a pseudo object is contained within another object,
  457. ;; a secondary string or a container element.
  458. ((not parent) 'element)
  459. (t
  460. (let ((parent-type (org-element-type parent)))
  461. (cond ((not parent-type) 'object)
  462. ((memq parent-type org-element-object-containers) 'object)
  463. ((org-element-secondary-p datum) 'object)
  464. (t 'element)))))))
  465. (defsubst org-element-adopt-elements (parent &rest children)
  466. "Append elements to the contents of another element.
  467. PARENT is an element or object. CHILDREN can be elements,
  468. objects, or a strings.
  469. The function takes care of setting `:parent' property for CHILD.
  470. Return parent element."
  471. (declare (indent 1))
  472. (if (not children) parent
  473. ;; Link every child to PARENT. If PARENT is nil, it is a secondary
  474. ;; string: parent is the list itself.
  475. (dolist (child children)
  476. (org-element-put-property child :parent (or parent children)))
  477. ;; Add CHILDREN at the end of PARENT contents.
  478. (when parent
  479. (apply #'org-element-set-contents
  480. parent
  481. (nconc (org-element-contents parent) children)))
  482. ;; Return modified PARENT element.
  483. (or parent children)))
  484. (defun org-element-extract-element (element)
  485. "Extract ELEMENT from parse tree.
  486. Remove element from the parse tree by side-effect, and return it
  487. with its `:parent' property stripped out."
  488. (let ((parent (org-element-property :parent element))
  489. (secondary (org-element-secondary-p element)))
  490. (if secondary
  491. (org-element-put-property
  492. parent secondary
  493. (delq element (org-element-property secondary parent)))
  494. (apply #'org-element-set-contents
  495. parent
  496. (delq element (org-element-contents parent))))
  497. ;; Return ELEMENT with its :parent removed.
  498. (org-element-put-property element :parent nil)))
  499. (defun org-element-insert-before (element location)
  500. "Insert ELEMENT before LOCATION in parse tree.
  501. LOCATION is an element, object or string within the parse tree.
  502. Parse tree is modified by side effect."
  503. (let* ((parent (org-element-property :parent location))
  504. (property (org-element-secondary-p location))
  505. (siblings (if property (org-element-property property parent)
  506. (org-element-contents parent)))
  507. ;; Special case: LOCATION is the first element of an
  508. ;; independent secondary string (e.g. :title property). Add
  509. ;; ELEMENT in-place.
  510. (specialp (and (not property)
  511. (eq siblings parent)
  512. (eq (car parent) location))))
  513. ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
  514. (cond (specialp)
  515. ((or (null siblings) (eq (car siblings) location))
  516. (push element siblings))
  517. ((null location) (nconc siblings (list element)))
  518. (t
  519. (let ((index (cl-position location siblings)))
  520. (unless index (error "No location found to insert element"))
  521. (push element (cdr (nthcdr (1- index) siblings))))))
  522. ;; Store SIBLINGS at appropriate place in parse tree.
  523. (cond
  524. (specialp (setcdr parent (copy-sequence parent)) (setcar parent element))
  525. (property (org-element-put-property parent property siblings))
  526. (t (apply #'org-element-set-contents parent siblings)))
  527. ;; Set appropriate :parent property.
  528. (org-element-put-property element :parent parent)))
  529. (defun org-element-set-element (old new)
  530. "Replace element or object OLD with element or object NEW.
  531. The function takes care of setting `:parent' property for NEW."
  532. ;; Ensure OLD and NEW have the same parent.
  533. (org-element-put-property new :parent (org-element-property :parent old))
  534. (if (or (memq (org-element-type old) '(plain-text nil))
  535. (memq (org-element-type new) '(plain-text nil)))
  536. ;; We cannot replace OLD with NEW since one of them is not an
  537. ;; object or element. We take the long path.
  538. (progn (org-element-insert-before new old)
  539. (org-element-extract-element old))
  540. ;; Since OLD is going to be changed into NEW by side-effect, first
  541. ;; make sure that every element or object within NEW has OLD as
  542. ;; parent.
  543. (dolist (blob (org-element-contents new))
  544. (org-element-put-property blob :parent old))
  545. ;; Transfer contents.
  546. (apply #'org-element-set-contents old (org-element-contents new))
  547. ;; Overwrite OLD's properties with NEW's.
  548. (setcar (cdr old) (nth 1 new))
  549. ;; Transfer type.
  550. (setcar old (car new))))
  551. (defun org-element-create (type &optional props &rest children)
  552. "Create a new element of type TYPE.
  553. Optional argument PROPS, when non-nil, is a plist defining the
  554. properties of the element. CHILDREN can be elements, objects or
  555. strings."
  556. (apply #'org-element-adopt-elements (list type props) children))
  557. (defun org-element-copy (datum)
  558. "Return a copy of DATUM.
  559. DATUM is an element, object, string or nil. `:parent' property
  560. is cleared and contents are removed in the process."
  561. (when datum
  562. (let ((type (org-element-type datum)))
  563. (pcase type
  564. (`org-data (list 'org-data nil))
  565. (`plain-text (substring-no-properties datum))
  566. (`nil (copy-sequence datum))
  567. (_
  568. (list type (plist-put (copy-sequence (nth 1 datum)) :parent nil)))))))
  569. ;;; Greater elements
  570. ;;
  571. ;; For each greater element type, we define a parser and an
  572. ;; interpreter.
  573. ;;
  574. ;; A parser returns the element or object as the list described above.
  575. ;; Most of them accepts no argument. Though, exceptions exist. Hence
  576. ;; every element containing a secondary string (see
  577. ;; `org-element-secondary-value-alist') will accept an optional
  578. ;; argument to toggle parsing of these secondary strings. Moreover,
  579. ;; `item' parser requires current list's structure as its first
  580. ;; element.
  581. ;;
  582. ;; An interpreter accepts two arguments: the list representation of
  583. ;; the element or object, and its contents. The latter may be nil,
  584. ;; depending on the element or object considered. It returns the
  585. ;; appropriate Org syntax, as a string.
  586. ;;
  587. ;; Parsing functions must follow the naming convention:
  588. ;; org-element-TYPE-parser, where TYPE is greater element's type, as
  589. ;; defined in `org-element-greater-elements'.
  590. ;;
  591. ;; Similarly, interpreting functions must follow the naming
  592. ;; convention: org-element-TYPE-interpreter.
  593. ;;
  594. ;; With the exception of `headline' and `item' types, greater elements
  595. ;; cannot contain other greater elements of their own type.
  596. ;;
  597. ;; Beside implementing a parser and an interpreter, adding a new
  598. ;; greater element requires tweaking `org-element--current-element'.
  599. ;; Moreover, the newly defined type must be added to both
  600. ;; `org-element-all-elements' and `org-element-greater-elements'.
  601. ;;;; Center Block
  602. (defun org-element-center-block-parser (limit affiliated)
  603. "Parse a center block.
  604. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  605. the buffer position at the beginning of the first affiliated
  606. keyword and CDR is a plist of affiliated keywords along with
  607. their value.
  608. Return a list whose CAR is `center-block' and CDR is a plist
  609. containing `:begin', `:end', `:contents-begin', `:contents-end',
  610. `:post-blank' and `:post-affiliated' keywords.
  611. Assume point is at the beginning of the block."
  612. (let ((case-fold-search t))
  613. (if (not (save-excursion
  614. (re-search-forward "^[ \t]*#\\+END_CENTER[ \t]*$" limit t)))
  615. ;; Incomplete block: parse it as a paragraph.
  616. (org-element-paragraph-parser limit affiliated)
  617. (let ((block-end-line (match-beginning 0)))
  618. (let* ((begin (car affiliated))
  619. (post-affiliated (point))
  620. ;; Empty blocks have no contents.
  621. (contents-begin (progn (forward-line)
  622. (and (< (point) block-end-line)
  623. (point))))
  624. (contents-end (and contents-begin block-end-line))
  625. (pos-before-blank (progn (goto-char block-end-line)
  626. (forward-line)
  627. (point)))
  628. (end (save-excursion
  629. (skip-chars-forward " \r\t\n" limit)
  630. (if (eobp) (point) (line-beginning-position)))))
  631. (list 'center-block
  632. (nconc
  633. (list :begin begin
  634. :end end
  635. :contents-begin contents-begin
  636. :contents-end contents-end
  637. :post-blank (count-lines pos-before-blank end)
  638. :post-affiliated post-affiliated)
  639. (cdr affiliated))))))))
  640. (defun org-element-center-block-interpreter (_ contents)
  641. "Interpret a center-block element as Org syntax.
  642. CONTENTS is the contents of the element."
  643. (format "#+begin_center\n%s#+end_center" contents))
  644. ;;;; Drawer
  645. (defun org-element-drawer-parser (limit affiliated)
  646. "Parse a drawer.
  647. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  648. the buffer position at the beginning of the first affiliated
  649. keyword and CDR is a plist of affiliated keywords along with
  650. their value.
  651. Return a list whose CAR is `drawer' and CDR is a plist containing
  652. `:drawer-name', `:begin', `:end', `:contents-begin',
  653. `:contents-end', `:post-blank' and `:post-affiliated' keywords.
  654. Assume point is at beginning of drawer."
  655. (let ((case-fold-search t))
  656. (if (not (save-excursion (re-search-forward "^[ \t]*:END:[ \t]*$" limit t)))
  657. ;; Incomplete drawer: parse it as a paragraph.
  658. (org-element-paragraph-parser limit affiliated)
  659. (save-excursion
  660. (let* ((drawer-end-line (match-beginning 0))
  661. (name (progn (looking-at org-drawer-regexp)
  662. (match-string-no-properties 1)))
  663. (begin (car affiliated))
  664. (post-affiliated (point))
  665. ;; Empty drawers have no contents.
  666. (contents-begin (progn (forward-line)
  667. (and (< (point) drawer-end-line)
  668. (point))))
  669. (contents-end (and contents-begin drawer-end-line))
  670. (pos-before-blank (progn (goto-char drawer-end-line)
  671. (forward-line)
  672. (point)))
  673. (end (progn (skip-chars-forward " \r\t\n" limit)
  674. (if (eobp) (point) (line-beginning-position)))))
  675. (list 'drawer
  676. (nconc
  677. (list :begin begin
  678. :end end
  679. :drawer-name name
  680. :contents-begin contents-begin
  681. :contents-end contents-end
  682. :post-blank (count-lines pos-before-blank end)
  683. :post-affiliated post-affiliated)
  684. (cdr affiliated))))))))
  685. (defun org-element-drawer-interpreter (drawer contents)
  686. "Interpret DRAWER element as Org syntax.
  687. CONTENTS is the contents of the element."
  688. (format ":%s:\n%s:END:"
  689. (org-element-property :drawer-name drawer)
  690. contents))
  691. ;;;; Dynamic Block
  692. (defun org-element-dynamic-block-parser (limit affiliated)
  693. "Parse a dynamic block.
  694. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  695. the buffer position at the beginning of the first affiliated
  696. keyword and CDR is a plist of affiliated keywords along with
  697. their value.
  698. Return a list whose CAR is `dynamic-block' and CDR is a plist
  699. containing `:block-name', `:begin', `:end', `:contents-begin',
  700. `:contents-end', `:arguments', `:post-blank' and
  701. `:post-affiliated' keywords.
  702. Assume point is at beginning of dynamic block."
  703. (let ((case-fold-search t))
  704. (if (not (save-excursion
  705. (re-search-forward "^[ \t]*#\\+END:?[ \t]*$" limit t)))
  706. ;; Incomplete block: parse it as a paragraph.
  707. (org-element-paragraph-parser limit affiliated)
  708. (let ((block-end-line (match-beginning 0)))
  709. (save-excursion
  710. (let* ((name (progn (looking-at org-dblock-start-re)
  711. (match-string-no-properties 1)))
  712. (arguments (match-string-no-properties 3))
  713. (begin (car affiliated))
  714. (post-affiliated (point))
  715. ;; Empty blocks have no contents.
  716. (contents-begin (progn (forward-line)
  717. (and (< (point) block-end-line)
  718. (point))))
  719. (contents-end (and contents-begin block-end-line))
  720. (pos-before-blank (progn (goto-char block-end-line)
  721. (forward-line)
  722. (point)))
  723. (end (progn (skip-chars-forward " \r\t\n" limit)
  724. (if (eobp) (point) (line-beginning-position)))))
  725. (list 'dynamic-block
  726. (nconc
  727. (list :begin begin
  728. :end end
  729. :block-name name
  730. :arguments arguments
  731. :contents-begin contents-begin
  732. :contents-end contents-end
  733. :post-blank (count-lines pos-before-blank end)
  734. :post-affiliated post-affiliated)
  735. (cdr affiliated)))))))))
  736. (defun org-element-dynamic-block-interpreter (dynamic-block contents)
  737. "Interpret DYNAMIC-BLOCK element as Org syntax.
  738. CONTENTS is the contents of the element."
  739. (format "#+begin: %s%s\n%s#+end:"
  740. (org-element-property :block-name dynamic-block)
  741. (let ((args (org-element-property :arguments dynamic-block)))
  742. (if args (concat " " args) ""))
  743. contents))
  744. ;;;; Footnote Definition
  745. (defconst org-element--footnote-separator
  746. (concat org-outline-regexp-bol "\\|"
  747. org-footnote-definition-re "\\|"
  748. "^\\([ \t]*\n\\)\\{2,\\}")
  749. "Regexp used as a footnote definition separator.")
  750. (defun org-element-footnote-definition-parser (limit affiliated)
  751. "Parse a footnote definition.
  752. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  753. the buffer position at the beginning of the first affiliated
  754. keyword and CDR is a plist of affiliated keywords along with
  755. their value.
  756. Return a list whose CAR is `footnote-definition' and CDR is
  757. a plist containing `:label', `:begin' `:end', `:contents-begin',
  758. `:contents-end', `:pre-blank',`:post-blank' and
  759. `:post-affiliated' keywords.
  760. Assume point is at the beginning of the footnote definition."
  761. (save-excursion
  762. (let* ((label (progn (looking-at org-footnote-definition-re)
  763. (match-string-no-properties 1)))
  764. (begin (car affiliated))
  765. (post-affiliated (point))
  766. (end
  767. (save-excursion
  768. (end-of-line)
  769. (cond
  770. ((not
  771. (re-search-forward org-element--footnote-separator limit t))
  772. limit)
  773. ((eq ?\[ (char-after (match-beginning 0)))
  774. ;; At a new footnote definition, make sure we end
  775. ;; before any affiliated keyword above.
  776. (forward-line -1)
  777. (while (and (> (point) post-affiliated)
  778. (looking-at-p org-element--affiliated-re))
  779. (forward-line -1))
  780. (line-beginning-position 2))
  781. ((eq ?* (char-after (match-beginning 0))) (match-beginning 0))
  782. (t (skip-chars-forward " \r\t\n" limit)
  783. (if (= limit (point)) limit (line-beginning-position))))))
  784. (pre-blank 0)
  785. (contents-begin
  786. (progn (search-forward "]")
  787. (skip-chars-forward " \r\t\n" end)
  788. (cond ((= (point) end) nil)
  789. ((= (line-beginning-position) post-affiliated) (point))
  790. (t
  791. (setq pre-blank
  792. (count-lines (line-beginning-position) begin))
  793. (line-beginning-position)))))
  794. (contents-end
  795. (progn (goto-char end)
  796. (skip-chars-backward " \r\t\n")
  797. (line-beginning-position 2))))
  798. (list 'footnote-definition
  799. (nconc
  800. (list :label label
  801. :begin begin
  802. :end end
  803. :contents-begin contents-begin
  804. :contents-end (and contents-begin contents-end)
  805. :pre-blank pre-blank
  806. :post-blank (count-lines contents-end end)
  807. :post-affiliated post-affiliated)
  808. (cdr affiliated))))))
  809. (defun org-element-footnote-definition-interpreter (footnote-definition contents)
  810. "Interpret FOOTNOTE-DEFINITION element as Org syntax.
  811. CONTENTS is the contents of the footnote-definition."
  812. (let ((pre-blank
  813. (min (or (org-element-property :pre-blank footnote-definition)
  814. ;; 0 is specific to paragraphs at the beginning of
  815. ;; the footnote definition, so we use 1 as
  816. ;; a fall-back value, which is more universal.
  817. 1)
  818. ;; Footnote ends after more than two consecutive empty
  819. ;; lines: limit ourselves to 2 newline characters.
  820. 2)))
  821. (concat (format "[fn:%s]" (org-element-property :label footnote-definition))
  822. (if (= pre-blank 0) (concat " " (org-trim contents))
  823. (concat (make-string pre-blank ?\n) contents)))))
  824. ;;;; Headline
  825. (defun org-element--get-node-properties ()
  826. "Return node properties associated to headline at point.
  827. Upcase property names. It avoids confusion between properties
  828. obtained through property drawer and default properties from the
  829. parser (e.g. `:end' and :END:). Return value is a plist."
  830. (save-excursion
  831. (forward-line)
  832. (when (looking-at-p org-planning-line-re) (forward-line))
  833. (when (looking-at org-property-drawer-re)
  834. (forward-line)
  835. (let ((end (match-end 0)) properties)
  836. (while (< (line-end-position) end)
  837. (looking-at org-property-re)
  838. (push (match-string-no-properties 3) properties)
  839. (push (intern (concat ":" (upcase (match-string 2)))) properties)
  840. (forward-line))
  841. properties))))
  842. (defun org-element--get-time-properties ()
  843. "Return time properties associated to headline at point.
  844. Return value is a plist."
  845. (save-excursion
  846. (when (progn (forward-line) (looking-at org-planning-line-re))
  847. (let ((end (line-end-position)) plist)
  848. (while (re-search-forward org-keyword-time-not-clock-regexp end t)
  849. (goto-char (match-end 1))
  850. (skip-chars-forward " \t")
  851. (let ((keyword (match-string 1))
  852. (time (org-element-timestamp-parser)))
  853. (cond ((equal keyword org-scheduled-string)
  854. (setq plist (plist-put plist :scheduled time)))
  855. ((equal keyword org-deadline-string)
  856. (setq plist (plist-put plist :deadline time)))
  857. (t (setq plist (plist-put plist :closed time))))))
  858. plist))))
  859. (defun org-element-headline-parser (limit &optional raw-secondary-p)
  860. "Parse a headline.
  861. Return a list whose CAR is `headline' and CDR is a plist
  862. containing `:raw-value', `:title', `:begin', `:end',
  863. `:pre-blank', `:contents-begin' and `:contents-end', `:level',
  864. `:priority', `:tags', `:todo-keyword', `:todo-type', `:scheduled',
  865. `:deadline', `:closed', `:archivedp', `:commentedp'
  866. `:footnote-section-p', `:post-blank' and `:post-affiliated'
  867. keywords.
  868. The plist also contains any property set in the property drawer,
  869. with its name in upper cases and colons added at the
  870. beginning (e.g., `:CUSTOM_ID').
  871. LIMIT is a buffer position bounding the search.
  872. When RAW-SECONDARY-P is non-nil, headline's title will not be
  873. parsed as a secondary string, but as a plain string instead.
  874. Assume point is at beginning of the headline."
  875. (save-excursion
  876. (let* ((begin (point))
  877. (level (prog1 (org-reduced-level (skip-chars-forward "*"))
  878. (skip-chars-forward " \t")))
  879. (todo (and org-todo-regexp
  880. (let (case-fold-search) (looking-at (concat org-todo-regexp " ")))
  881. (progn (goto-char (match-end 0))
  882. (skip-chars-forward " \t")
  883. (match-string 1))))
  884. (todo-type
  885. (and todo (if (member todo org-done-keywords) 'done 'todo)))
  886. (priority (and (looking-at "\\[#.\\][ \t]*")
  887. (progn (goto-char (match-end 0))
  888. (aref (match-string 0) 2))))
  889. (commentedp
  890. (and (let (case-fold-search) (looking-at org-comment-string))
  891. (goto-char (match-end 0))))
  892. (title-start (point))
  893. (tags (when (re-search-forward
  894. "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  895. (line-end-position)
  896. 'move)
  897. (goto-char (match-beginning 0))
  898. (org-split-string (match-string 1) ":")))
  899. (title-end (point))
  900. (raw-value (org-trim
  901. (buffer-substring-no-properties title-start title-end)))
  902. (archivedp (member org-archive-tag tags))
  903. (footnote-section-p (and org-footnote-section
  904. (string= org-footnote-section raw-value)))
  905. (standard-props (org-element--get-node-properties))
  906. (time-props (org-element--get-time-properties))
  907. (end (min (save-excursion (org-end-of-subtree t t)) limit))
  908. (contents-begin (save-excursion
  909. (forward-line)
  910. (skip-chars-forward " \r\t\n" end)
  911. (and (/= (point) end) (line-beginning-position))))
  912. (contents-end (and contents-begin
  913. (progn (goto-char end)
  914. (skip-chars-backward " \r\t\n")
  915. (line-beginning-position 2)))))
  916. (let ((headline
  917. (list 'headline
  918. (nconc
  919. (list :raw-value raw-value
  920. :begin begin
  921. :end end
  922. :pre-blank
  923. (if (not contents-begin) 0
  924. (1- (count-lines begin contents-begin)))
  925. :contents-begin contents-begin
  926. :contents-end contents-end
  927. :level level
  928. :priority priority
  929. :tags tags
  930. :todo-keyword todo
  931. :todo-type todo-type
  932. :post-blank
  933. (if contents-end
  934. (count-lines contents-end end)
  935. (1- (count-lines begin end)))
  936. :footnote-section-p footnote-section-p
  937. :archivedp archivedp
  938. :commentedp commentedp
  939. :post-affiliated begin)
  940. time-props
  941. standard-props))))
  942. (org-element-put-property
  943. headline :title
  944. (if raw-secondary-p raw-value
  945. (org-element--parse-objects
  946. (progn (goto-char title-start)
  947. (skip-chars-forward " \t")
  948. (point))
  949. (progn (goto-char title-end)
  950. (skip-chars-backward " \t")
  951. (point))
  952. nil
  953. (org-element-restriction 'headline)
  954. headline)))))))
  955. (defun org-element-headline-interpreter (headline contents)
  956. "Interpret HEADLINE element as Org syntax.
  957. CONTENTS is the contents of the element."
  958. (let* ((level (org-element-property :level headline))
  959. (todo (org-element-property :todo-keyword headline))
  960. (priority (org-element-property :priority headline))
  961. (title (org-element-interpret-data
  962. (org-element-property :title headline)))
  963. (tags (let ((tag-list (org-element-property :tags headline)))
  964. (and tag-list
  965. (format ":%s:" (mapconcat #'identity tag-list ":")))))
  966. (commentedp (org-element-property :commentedp headline))
  967. (pre-blank (or (org-element-property :pre-blank headline) 0))
  968. (heading
  969. (concat (make-string (if org-odd-levels-only (1- (* level 2)) level)
  970. ?*)
  971. (and todo (concat " " todo))
  972. (and commentedp (concat " " org-comment-string))
  973. (and priority (format " [#%c]" priority))
  974. " "
  975. (if (and org-footnote-section
  976. (org-element-property :footnote-section-p headline))
  977. org-footnote-section
  978. title))))
  979. (concat
  980. heading
  981. ;; Align tags.
  982. (when tags
  983. (cond
  984. ((zerop org-tags-column) (format " %s" tags))
  985. ((< org-tags-column 0)
  986. (concat
  987. (make-string
  988. (max (- (+ org-tags-column (length heading) (length tags))) 1)
  989. ?\s)
  990. tags))
  991. (t
  992. (concat
  993. (make-string (max (- org-tags-column (length heading)) 1) ?\s)
  994. tags))))
  995. (make-string (1+ pre-blank) ?\n)
  996. contents)))
  997. ;;;; Inlinetask
  998. (defun org-element-inlinetask-parser (limit &optional raw-secondary-p)
  999. "Parse an inline task.
  1000. Return a list whose CAR is `inlinetask' and CDR is a plist
  1001. containing `:title', `:begin', `:end', `:pre-blank',
  1002. `:contents-begin' and `:contents-end', `:level', `:priority',
  1003. `:raw-value', `:tags', `:todo-keyword', `:todo-type',
  1004. `:scheduled', `:deadline', `:closed', `:post-blank' and
  1005. `:post-affiliated' keywords.
  1006. The plist also contains any property set in the property drawer,
  1007. with its name in upper cases and colons added at the
  1008. beginning (e.g., `:CUSTOM_ID').
  1009. When optional argument RAW-SECONDARY-P is non-nil, inline-task's
  1010. title will not be parsed as a secondary string, but as a plain
  1011. string instead.
  1012. Assume point is at beginning of the inline task."
  1013. (save-excursion
  1014. (let* ((begin (point))
  1015. (level (prog1 (org-reduced-level (skip-chars-forward "*"))
  1016. (skip-chars-forward " \t")))
  1017. (todo (and org-todo-regexp
  1018. (let (case-fold-search) (looking-at org-todo-regexp))
  1019. (progn (goto-char (match-end 0))
  1020. (skip-chars-forward " \t")
  1021. (match-string 0))))
  1022. (todo-type (and todo
  1023. (if (member todo org-done-keywords) 'done 'todo)))
  1024. (priority (and (looking-at "\\[#.\\][ \t]*")
  1025. (progn (goto-char (match-end 0))
  1026. (aref (match-string 0) 2))))
  1027. (title-start (point))
  1028. (tags (when (re-search-forward
  1029. "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  1030. (line-end-position)
  1031. 'move)
  1032. (goto-char (match-beginning 0))
  1033. (org-split-string (match-string 1) ":")))
  1034. (title-end (point))
  1035. (raw-value (org-trim
  1036. (buffer-substring-no-properties title-start title-end)))
  1037. (task-end (save-excursion
  1038. (end-of-line)
  1039. (and (re-search-forward org-outline-regexp-bol limit t)
  1040. (looking-at-p "[ \t]*END[ \t]*$")
  1041. (line-beginning-position))))
  1042. (standard-props (and task-end (org-element--get-node-properties)))
  1043. (time-props (and task-end (org-element--get-time-properties)))
  1044. (contents-begin (and task-end
  1045. (< (point) task-end)
  1046. (progn
  1047. (forward-line)
  1048. (skip-chars-forward " \t\n")
  1049. (line-beginning-position))))
  1050. (contents-end (and contents-begin task-end))
  1051. (end (progn (when task-end (goto-char task-end))
  1052. (forward-line)
  1053. (skip-chars-forward " \r\t\n" limit)
  1054. (if (eobp) (point) (line-beginning-position))))
  1055. (inlinetask
  1056. (list 'inlinetask
  1057. (nconc
  1058. (list :raw-value raw-value
  1059. :begin begin
  1060. :end end
  1061. :pre-blank
  1062. (if (not contents-begin) 0
  1063. (1- (count-lines begin contents-begin)))
  1064. :contents-begin contents-begin
  1065. :contents-end contents-end
  1066. :level level
  1067. :priority priority
  1068. :tags tags
  1069. :todo-keyword todo
  1070. :todo-type todo-type
  1071. :post-blank (1- (count-lines (or task-end begin) end))
  1072. :post-affiliated begin)
  1073. time-props
  1074. standard-props))))
  1075. (org-element-put-property
  1076. inlinetask :title
  1077. (if raw-secondary-p raw-value
  1078. (org-element--parse-objects
  1079. (progn (goto-char title-start)
  1080. (skip-chars-forward " \t")
  1081. (point))
  1082. (progn (goto-char title-end)
  1083. (skip-chars-backward " \t")
  1084. (point))
  1085. nil
  1086. (org-element-restriction 'inlinetask)
  1087. inlinetask))))))
  1088. (defun org-element-inlinetask-interpreter (inlinetask contents)
  1089. "Interpret INLINETASK element as Org syntax.
  1090. CONTENTS is the contents of inlinetask."
  1091. (let* ((level (org-element-property :level inlinetask))
  1092. (todo (org-element-property :todo-keyword inlinetask))
  1093. (priority (org-element-property :priority inlinetask))
  1094. (title (org-element-interpret-data
  1095. (org-element-property :title inlinetask)))
  1096. (tags (let ((tag-list (org-element-property :tags inlinetask)))
  1097. (and tag-list
  1098. (format ":%s:" (mapconcat 'identity tag-list ":")))))
  1099. (task (concat (make-string level ?*)
  1100. (and todo (concat " " todo))
  1101. (and priority (format " [#%c]" priority))
  1102. (and title (concat " " title)))))
  1103. (concat task
  1104. ;; Align tags.
  1105. (when tags
  1106. (cond
  1107. ((zerop org-tags-column) (format " %s" tags))
  1108. ((< org-tags-column 0)
  1109. (concat
  1110. (make-string
  1111. (max (- (+ org-tags-column (length task) (length tags))) 1)
  1112. ?\s)
  1113. tags))
  1114. (t
  1115. (concat
  1116. (make-string (max (- org-tags-column (length task)) 1) ?\s)
  1117. tags))))
  1118. ;; Prefer degenerate inlinetasks when there are no
  1119. ;; contents.
  1120. (when contents
  1121. (concat "\n"
  1122. contents
  1123. (make-string level ?*) " end")))))
  1124. ;;;; Item
  1125. (defun org-element-item-parser (_ struct &optional raw-secondary-p)
  1126. "Parse an item.
  1127. STRUCT is the structure of the plain list.
  1128. Return a list whose CAR is `item' and CDR is a plist containing
  1129. `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
  1130. `:checkbox', `:counter', `:tag', `:structure', `:pre-blank',
  1131. `:post-blank' and `:post-affiliated' keywords.
  1132. When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
  1133. any, will not be parsed as a secondary string, but as a plain
  1134. string instead.
  1135. Assume point is at the beginning of the item."
  1136. (save-excursion
  1137. (beginning-of-line)
  1138. (looking-at org-list-full-item-re)
  1139. (let* ((begin (point))
  1140. (bullet (match-string-no-properties 1))
  1141. (checkbox (let ((box (match-string 3)))
  1142. (cond ((equal "[ ]" box) 'off)
  1143. ((equal "[X]" box) 'on)
  1144. ((equal "[-]" box) 'trans))))
  1145. (counter (let ((c (match-string 2)))
  1146. (save-match-data
  1147. (cond
  1148. ((not c) nil)
  1149. ((string-match "[A-Za-z]" c)
  1150. (- (string-to-char (upcase (match-string 0 c)))
  1151. 64))
  1152. ((string-match "[0-9]+" c)
  1153. (string-to-number (match-string 0 c)))))))
  1154. (end (progn (goto-char (nth 6 (assq (point) struct)))
  1155. (if (bolp) (point) (line-beginning-position 2))))
  1156. (pre-blank 0)
  1157. (contents-begin
  1158. (progn
  1159. (goto-char
  1160. ;; Ignore tags in un-ordered lists: they are just
  1161. ;; a part of item's body.
  1162. (if (and (match-beginning 4)
  1163. (save-match-data (string-match "[.)]" bullet)))
  1164. (match-beginning 4)
  1165. (match-end 0)))
  1166. (skip-chars-forward " \r\t\n" end)
  1167. (cond ((= (point) end) nil)
  1168. ;; If first line isn't empty, contents really
  1169. ;; start at the text after item's meta-data.
  1170. ((= (line-beginning-position) begin) (point))
  1171. (t
  1172. (setq pre-blank
  1173. (count-lines (line-beginning-position) begin))
  1174. (line-beginning-position)))))
  1175. (contents-end (and contents-begin
  1176. (progn (goto-char end)
  1177. (skip-chars-backward " \r\t\n")
  1178. (line-beginning-position 2))))
  1179. (item
  1180. (list 'item
  1181. (list :bullet bullet
  1182. :begin begin
  1183. :end end
  1184. :contents-begin contents-begin
  1185. :contents-end contents-end
  1186. :checkbox checkbox
  1187. :counter counter
  1188. :structure struct
  1189. :pre-blank pre-blank
  1190. :post-blank (count-lines (or contents-end begin) end)
  1191. :post-affiliated begin))))
  1192. (org-element-put-property
  1193. item :tag
  1194. (let ((raw (org-list-get-tag begin struct)))
  1195. (when raw
  1196. (if raw-secondary-p raw
  1197. (org-element--parse-objects
  1198. (match-beginning 4) (match-end 4) nil
  1199. (org-element-restriction 'item)
  1200. item))))))))
  1201. (defun org-element-item-interpreter (item contents)
  1202. "Interpret ITEM element as Org syntax.
  1203. CONTENTS is the contents of the element."
  1204. (let ((tag (pcase (org-element-property :tag item)
  1205. (`nil nil)
  1206. (tag (format "%s :: " (org-element-interpret-data tag)))))
  1207. (bullet
  1208. (org-list-bullet-string
  1209. (cond
  1210. ((not (string-match-p "[0-9a-zA-Z]"
  1211. (org-element-property :bullet item))) "- ")
  1212. ((eq org-plain-list-ordered-item-terminator ?\)) "1)")
  1213. (t "1.")))))
  1214. (concat
  1215. bullet
  1216. (pcase (org-element-property :counter item)
  1217. (`nil nil)
  1218. (counter (format "[@%d] " counter)))
  1219. (pcase (org-element-property :checkbox item)
  1220. (`on "[X] ")
  1221. (`off "[ ] ")
  1222. (`trans "[-] ")
  1223. (_ nil))
  1224. tag
  1225. (when contents
  1226. (let* ((ind (make-string (if tag 5 (length bullet)) ?\s))
  1227. (pre-blank
  1228. (min (or (org-element-property :pre-blank item)
  1229. ;; 0 is specific to paragraphs at the
  1230. ;; beginning of the item, so we use 1 as
  1231. ;; a fall-back value, which is more universal.
  1232. 1)
  1233. ;; Lists ends after more than two consecutive
  1234. ;; empty lines: limit ourselves to 2 newline
  1235. ;; characters.
  1236. 2))
  1237. (contents (replace-regexp-in-string
  1238. "\\(^\\)[ \t]*\\S-" ind contents nil nil 1)))
  1239. (if (= pre-blank 0) (org-trim contents)
  1240. (concat (make-string pre-blank ?\n) contents)))))))
  1241. ;;;; Plain List
  1242. (defun org-element--list-struct (limit)
  1243. ;; Return structure of list at point. Internal function. See
  1244. ;; `org-list-struct' for details.
  1245. (let ((case-fold-search t)
  1246. (top-ind limit)
  1247. (item-re (org-item-re))
  1248. (inlinetask-re (and (featurep 'org-inlinetask) "^\\*+ "))
  1249. items struct)
  1250. (save-excursion
  1251. (catch :exit
  1252. (while t
  1253. (cond
  1254. ;; At limit: end all items.
  1255. ((>= (point) limit)
  1256. (let ((end (progn (skip-chars-backward " \r\t\n")
  1257. (line-beginning-position 2))))
  1258. (dolist (item items) (setcar (nthcdr 6 item) end)))
  1259. (throw :exit (sort (nconc items struct) #'car-less-than-car)))
  1260. ;; At list end: end all items.
  1261. ((looking-at org-list-end-re)
  1262. (dolist (item items) (setcar (nthcdr 6 item) (point)))
  1263. (throw :exit (sort (nconc items struct) #'car-less-than-car)))
  1264. ;; At a new item: end previous sibling.
  1265. ((looking-at item-re)
  1266. (let ((ind (save-excursion (skip-chars-forward " \t")
  1267. (current-column))))
  1268. (setq top-ind (min top-ind ind))
  1269. (while (and items (<= ind (nth 1 (car items))))
  1270. (let ((item (pop items)))
  1271. (setcar (nthcdr 6 item) (point))
  1272. (push item struct)))
  1273. (push (progn (looking-at org-list-full-item-re)
  1274. (let ((bullet (match-string-no-properties 1)))
  1275. (list (point)
  1276. ind
  1277. bullet
  1278. (match-string-no-properties 2) ; counter
  1279. (match-string-no-properties 3) ; checkbox
  1280. ;; Description tag.
  1281. (and (save-match-data
  1282. (string-match "[-+*]" bullet))
  1283. (match-string-no-properties 4))
  1284. ;; Ending position, unknown so far.
  1285. nil)))
  1286. items))
  1287. (forward-line))
  1288. ;; Skip empty lines.
  1289. ((looking-at "^[ \t]*$") (forward-line))
  1290. ;; Skip inline tasks and blank lines along the way.
  1291. ((and inlinetask-re (looking-at inlinetask-re))
  1292. (forward-line)
  1293. (let ((origin (point)))
  1294. (when (re-search-forward inlinetask-re limit t)
  1295. (if (looking-at-p "END[ \t]*$") (forward-line)
  1296. (goto-char origin)))))
  1297. ;; At some text line. Check if it ends any previous item.
  1298. (t
  1299. (let ((ind (save-excursion
  1300. (skip-chars-forward " \t")
  1301. (current-column)))
  1302. (end (save-excursion
  1303. (skip-chars-backward " \r\t\n")
  1304. (line-beginning-position 2))))
  1305. (while (<= ind (nth 1 (car items)))
  1306. (let ((item (pop items)))
  1307. (setcar (nthcdr 6 item) end)
  1308. (push item struct)
  1309. (unless items
  1310. (throw :exit (sort struct #'car-less-than-car))))))
  1311. ;; Skip blocks (any type) and drawers contents.
  1312. (cond
  1313. ((and (looking-at "[ \t]*#\\+BEGIN\\(:\\|_\\S-+\\)")
  1314. (re-search-forward
  1315. (format "^[ \t]*#\\+END%s[ \t]*$" (match-string 1))
  1316. limit t)))
  1317. ((and (looking-at org-drawer-regexp)
  1318. (re-search-forward "^[ \t]*:END:[ \t]*$" limit t))))
  1319. (forward-line))))))))
  1320. (defun org-element-plain-list-parser (limit affiliated structure)
  1321. "Parse a plain list.
  1322. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1323. the buffer position at the beginning of the first affiliated
  1324. keyword and CDR is a plist of affiliated keywords along with
  1325. their value. STRUCTURE is the structure of the plain list being
  1326. parsed.
  1327. Return a list whose CAR is `plain-list' and CDR is a plist
  1328. containing `:type', `:begin', `:end', `:contents-begin' and
  1329. `:contents-end', `:structure', `:post-blank' and
  1330. `:post-affiliated' keywords.
  1331. Assume point is at the beginning of the list."
  1332. (save-excursion
  1333. (let* ((struct (or structure (org-element--list-struct limit)))
  1334. (type (cond ((looking-at-p "[ \t]*[A-Za-z0-9]") 'ordered)
  1335. ((nth 5 (assq (point) struct)) 'descriptive)
  1336. (t 'unordered)))
  1337. (contents-begin (point))
  1338. (begin (car affiliated))
  1339. (contents-end (let* ((item (assq contents-begin struct))
  1340. (ind (nth 1 item))
  1341. (pos (nth 6 item)))
  1342. (while (and (setq item (assq pos struct))
  1343. (= (nth 1 item) ind))
  1344. (setq pos (nth 6 item)))
  1345. pos))
  1346. (end (progn (goto-char contents-end)
  1347. (skip-chars-forward " \r\t\n" limit)
  1348. (if (= (point) limit) limit (line-beginning-position)))))
  1349. ;; Return value.
  1350. (list 'plain-list
  1351. (nconc
  1352. (list :type type
  1353. :begin begin
  1354. :end end
  1355. :contents-begin contents-begin
  1356. :contents-end contents-end
  1357. :structure struct
  1358. :post-blank (count-lines contents-end end)
  1359. :post-affiliated contents-begin)
  1360. (cdr affiliated))))))
  1361. (defun org-element-plain-list-interpreter (_ contents)
  1362. "Interpret plain-list element as Org syntax.
  1363. CONTENTS is the contents of the element."
  1364. (with-temp-buffer
  1365. (insert contents)
  1366. (goto-char (point-min))
  1367. (org-list-repair)
  1368. (buffer-string)))
  1369. ;;;; Property Drawer
  1370. (defun org-element-property-drawer-parser (limit)
  1371. "Parse a property drawer.
  1372. LIMIT bounds the search.
  1373. Return a list whose car is `property-drawer' and cdr is a plist
  1374. containing `:begin', `:end', `:contents-begin', `:contents-end',
  1375. `:post-blank' and `:post-affiliated' keywords.
  1376. Assume point is at the beginning of the property drawer."
  1377. (save-excursion
  1378. (let ((case-fold-search t)
  1379. (begin (point))
  1380. (contents-begin (line-beginning-position 2)))
  1381. (re-search-forward "^[ \t]*:END:[ \t]*$" limit t)
  1382. (let ((contents-end (and (> (match-beginning 0) contents-begin)
  1383. (match-beginning 0)))
  1384. (before-blank (progn (forward-line) (point)))
  1385. (end (progn (skip-chars-forward " \r\t\n" limit)
  1386. (if (eobp) (point) (line-beginning-position)))))
  1387. (list 'property-drawer
  1388. (list :begin begin
  1389. :end end
  1390. :contents-begin (and contents-end contents-begin)
  1391. :contents-end contents-end
  1392. :post-blank (count-lines before-blank end)
  1393. :post-affiliated begin))))))
  1394. (defun org-element-property-drawer-interpreter (_ contents)
  1395. "Interpret property-drawer element as Org syntax.
  1396. CONTENTS is the properties within the drawer."
  1397. (format ":PROPERTIES:\n%s:END:" contents))
  1398. ;;;; Quote Block
  1399. (defun org-element-quote-block-parser (limit affiliated)
  1400. "Parse a quote block.
  1401. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1402. the buffer position at the beginning of the first affiliated
  1403. keyword and CDR is a plist of affiliated keywords along with
  1404. their value.
  1405. Return a list whose CAR is `quote-block' and CDR is a plist
  1406. containing `:begin', `:end', `:contents-begin', `:contents-end',
  1407. `:post-blank' and `:post-affiliated' keywords.
  1408. Assume point is at the beginning of the block."
  1409. (let ((case-fold-search t))
  1410. (if (not (save-excursion
  1411. (re-search-forward "^[ \t]*#\\+END_QUOTE[ \t]*$" limit t)))
  1412. ;; Incomplete block: parse it as a paragraph.
  1413. (org-element-paragraph-parser limit affiliated)
  1414. (let ((block-end-line (match-beginning 0)))
  1415. (save-excursion
  1416. (let* ((begin (car affiliated))
  1417. (post-affiliated (point))
  1418. ;; Empty blocks have no contents.
  1419. (contents-begin (progn (forward-line)
  1420. (and (< (point) block-end-line)
  1421. (point))))
  1422. (contents-end (and contents-begin block-end-line))
  1423. (pos-before-blank (progn (goto-char block-end-line)
  1424. (forward-line)
  1425. (point)))
  1426. (end (progn (skip-chars-forward " \r\t\n" limit)
  1427. (if (eobp) (point) (line-beginning-position)))))
  1428. (list 'quote-block
  1429. (nconc
  1430. (list :begin begin
  1431. :end end
  1432. :contents-begin contents-begin
  1433. :contents-end contents-end
  1434. :post-blank (count-lines pos-before-blank end)
  1435. :post-affiliated post-affiliated)
  1436. (cdr affiliated)))))))))
  1437. (defun org-element-quote-block-interpreter (_ contents)
  1438. "Interpret quote-block element as Org syntax.
  1439. CONTENTS is the contents of the element."
  1440. (format "#+begin_quote\n%s#+end_quote" contents))
  1441. ;;;; Section
  1442. (defun org-element-section-parser (_)
  1443. "Parse a section.
  1444. Return a list whose CAR is `section' and CDR is a plist
  1445. containing `:begin', `:end', `:contents-begin', `contents-end',
  1446. `:post-blank' and `:post-affiliated' keywords."
  1447. (save-excursion
  1448. ;; Beginning of section is the beginning of the first non-blank
  1449. ;; line after previous headline.
  1450. (let ((begin (point))
  1451. (end (progn (org-with-limited-levels (outline-next-heading))
  1452. (point)))
  1453. (pos-before-blank (progn (skip-chars-backward " \r\t\n")
  1454. (line-beginning-position 2))))
  1455. (list 'section
  1456. (list :begin begin
  1457. :end end
  1458. :contents-begin begin
  1459. :contents-end pos-before-blank
  1460. :post-blank (count-lines pos-before-blank end)
  1461. :post-affiliated begin)))))
  1462. (defun org-element-section-interpreter (_ contents)
  1463. "Interpret section element as Org syntax.
  1464. CONTENTS is the contents of the element."
  1465. contents)
  1466. ;;;; Special Block
  1467. (defun org-element-special-block-parser (limit affiliated)
  1468. "Parse a special block.
  1469. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1470. the buffer position at the beginning of the first affiliated
  1471. keyword and CDR is a plist of affiliated keywords along with
  1472. their value.
  1473. Return a list whose CAR is `special-block' and CDR is a plist
  1474. containing `:type', `:begin', `:end', `:contents-begin',
  1475. `:contents-end', `:post-blank' and `:post-affiliated' keywords.
  1476. Assume point is at the beginning of the block."
  1477. (let* ((case-fold-search t)
  1478. (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
  1479. (match-string-no-properties 1))))
  1480. (if (not (save-excursion
  1481. (re-search-forward
  1482. (format "^[ \t]*#\\+END_%s[ \t]*$" (regexp-quote type))
  1483. limit t)))
  1484. ;; Incomplete block: parse it as a paragraph.
  1485. (org-element-paragraph-parser limit affiliated)
  1486. (let ((block-end-line (match-beginning 0)))
  1487. (save-excursion
  1488. (let* ((begin (car affiliated))
  1489. (post-affiliated (point))
  1490. ;; Empty blocks have no contents.
  1491. (contents-begin (progn (forward-line)
  1492. (and (< (point) block-end-line)
  1493. (point))))
  1494. (contents-end (and contents-begin block-end-line))
  1495. (pos-before-blank (progn (goto-char block-end-line)
  1496. (forward-line)
  1497. (point)))
  1498. (end (progn (skip-chars-forward " \r\t\n" limit)
  1499. (if (eobp) (point) (line-beginning-position)))))
  1500. (list 'special-block
  1501. (nconc
  1502. (list :type type
  1503. :begin begin
  1504. :end end
  1505. :contents-begin contents-begin
  1506. :contents-end contents-end
  1507. :post-blank (count-lines pos-before-blank end)
  1508. :post-affiliated post-affiliated)
  1509. (cdr affiliated)))))))))
  1510. (defun org-element-special-block-interpreter (special-block contents)
  1511. "Interpret SPECIAL-BLOCK element as Org syntax.
  1512. CONTENTS is the contents of the element."
  1513. (let ((block-type (org-element-property :type special-block)))
  1514. (format "#+begin_%s\n%s#+end_%s" block-type contents block-type)))
  1515. ;;; Elements
  1516. ;;
  1517. ;; For each element, a parser and an interpreter are also defined.
  1518. ;; Both follow the same naming convention used for greater elements.
  1519. ;;
  1520. ;; Also, as for greater elements, adding a new element type is done
  1521. ;; through the following steps: implement a parser and an interpreter,
  1522. ;; tweak `org-element--current-element' so that it recognizes the new
  1523. ;; type and add that new type to `org-element-all-elements'.
  1524. ;;;; Babel Call
  1525. (defun org-element-babel-call-parser (limit affiliated)
  1526. "Parse a babel call.
  1527. LIMIT bounds the search. AFFILIATED is a list of which car is
  1528. the buffer position at the beginning of the first affiliated
  1529. keyword and cdr is a plist of affiliated keywords along with
  1530. their value.
  1531. Return a list whose car is `babel-call' and cdr is a plist
  1532. containing `:call', `:inside-header', `:arguments',
  1533. `:end-header', `:begin', `:end', `:value', `:post-blank' and
  1534. `:post-affiliated' as keywords."
  1535. (save-excursion
  1536. (let* ((begin (car affiliated))
  1537. (post-affiliated (point))
  1538. (before-blank (line-beginning-position 2))
  1539. (value (progn (search-forward ":" before-blank t)
  1540. (skip-chars-forward " \t")
  1541. (org-trim
  1542. (buffer-substring-no-properties
  1543. (point) (line-end-position)))))
  1544. (call
  1545. (or (org-string-nw-p
  1546. (buffer-substring-no-properties
  1547. (point) (progn (skip-chars-forward "^[]()" before-blank)
  1548. (point))))))
  1549. (inside-header (org-element--parse-paired-brackets ?\[))
  1550. (arguments (org-string-nw-p
  1551. (org-element--parse-paired-brackets ?\()))
  1552. (end-header
  1553. (org-string-nw-p
  1554. (org-trim
  1555. (buffer-substring-no-properties (point) (line-end-position)))))
  1556. (end (progn (forward-line)
  1557. (skip-chars-forward " \r\t\n" limit)
  1558. (if (eobp) (point) (line-beginning-position)))))
  1559. (list 'babel-call
  1560. (nconc
  1561. (list :call call
  1562. :inside-header inside-header
  1563. :arguments arguments
  1564. :end-header end-header
  1565. :begin begin
  1566. :end end
  1567. :value value
  1568. :post-blank (count-lines before-blank end)
  1569. :post-affiliated post-affiliated)
  1570. (cdr affiliated))))))
  1571. (defun org-element-babel-call-interpreter (babel-call _)
  1572. "Interpret BABEL-CALL element as Org syntax."
  1573. (concat "#+call: "
  1574. (org-element-property :call babel-call)
  1575. (let ((h (org-element-property :inside-header babel-call)))
  1576. (and h (format "[%s]" h)))
  1577. (concat "(" (org-element-property :arguments babel-call) ")")
  1578. (let ((h (org-element-property :end-header babel-call)))
  1579. (and h (concat " " h)))))
  1580. ;;;; Clock
  1581. (defun org-element-clock-parser (limit)
  1582. "Parse a clock.
  1583. LIMIT bounds the search.
  1584. Return a list whose CAR is `clock' and CDR is a plist containing
  1585. `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
  1586. `:post-affiliated' as keywords."
  1587. (save-excursion
  1588. (let* ((case-fold-search nil)
  1589. (begin (point))
  1590. (value (progn (search-forward "CLOCK:" (line-end-position) t)
  1591. (skip-chars-forward " \t")
  1592. (org-element-timestamp-parser)))
  1593. (duration (and (search-forward " => " (line-end-position) t)
  1594. (progn (skip-chars-forward " \t")
  1595. (looking-at "\\(\\S-+\\)[ \t]*$"))
  1596. (match-string-no-properties 1)))
  1597. (status (if duration 'closed 'running))
  1598. (post-blank (let ((before-blank (progn (forward-line) (point))))
  1599. (skip-chars-forward " \r\t\n" limit)
  1600. (skip-chars-backward " \t")
  1601. (unless (bolp) (end-of-line))
  1602. (count-lines before-blank (point))))
  1603. (end (point)))
  1604. (list 'clock
  1605. (list :status status
  1606. :value value
  1607. :duration duration
  1608. :begin begin
  1609. :end end
  1610. :post-blank post-blank
  1611. :post-affiliated begin)))))
  1612. (defun org-element-clock-interpreter (clock _)
  1613. "Interpret CLOCK element as Org syntax."
  1614. (concat "CLOCK: "
  1615. (org-element-timestamp-interpreter
  1616. (org-element-property :value clock) nil)
  1617. (let ((duration (org-element-property :duration clock)))
  1618. (and duration
  1619. (concat " => "
  1620. (apply 'format
  1621. "%2s:%02s"
  1622. (org-split-string duration ":")))))))
  1623. ;;;; Comment
  1624. (defun org-element-comment-parser (limit)
  1625. "Parse a comment.
  1626. LIMIT bounds the search.
  1627. Return a list whose CAR is `comment' and CDR is a plist
  1628. containing `:begin', `:end', `:value', `:post-blank',
  1629. `:post-affiliated' keywords.
  1630. Assume point is at comment beginning."
  1631. (save-excursion
  1632. (let* ((begin (point))
  1633. (value (prog2 (looking-at "[ \t]*# ?")
  1634. (buffer-substring-no-properties
  1635. (match-end 0) (line-end-position))
  1636. (forward-line)))
  1637. (com-end
  1638. ;; Get comments ending.
  1639. (progn
  1640. (while (and (< (point) limit) (looking-at "[ \t]*#\\( \\|$\\)"))
  1641. ;; Accumulate lines without leading hash and first
  1642. ;; whitespace.
  1643. (setq value
  1644. (concat value
  1645. "\n"
  1646. (buffer-substring-no-properties
  1647. (match-end 0) (line-end-position))))
  1648. (forward-line))
  1649. (point)))
  1650. (end (progn (goto-char com-end)
  1651. (skip-chars-forward " \r\t\n" limit)
  1652. (if (eobp) (point) (line-beginning-position)))))
  1653. (list 'comment
  1654. (list :begin begin
  1655. :end end
  1656. :value value
  1657. :post-blank (count-lines com-end end)
  1658. :post-affiliated begin)))))
  1659. (defun org-element-comment-interpreter (comment _)
  1660. "Interpret COMMENT element as Org syntax.
  1661. CONTENTS is nil."
  1662. (replace-regexp-in-string "^" "# " (org-element-property :value comment)))
  1663. ;;;; Comment Block
  1664. (defun org-element-comment-block-parser (limit affiliated)
  1665. "Parse an export block.
  1666. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1667. the buffer position at the beginning of the first affiliated
  1668. keyword and CDR is a plist of affiliated keywords along with
  1669. their value.
  1670. Return a list whose CAR is `comment-block' and CDR is a plist
  1671. containing `:begin', `:end', `:value', `:post-blank' and
  1672. `:post-affiliated' keywords.
  1673. Assume point is at comment block beginning."
  1674. (let ((case-fold-search t))
  1675. (if (not (save-excursion
  1676. (re-search-forward "^[ \t]*#\\+END_COMMENT[ \t]*$" limit t)))
  1677. ;; Incomplete block: parse it as a paragraph.
  1678. (org-element-paragraph-parser limit affiliated)
  1679. (let ((contents-end (match-beginning 0)))
  1680. (save-excursion
  1681. (let* ((begin (car affiliated))
  1682. (post-affiliated (point))
  1683. (contents-begin (progn (forward-line) (point)))
  1684. (pos-before-blank (progn (goto-char contents-end)
  1685. (forward-line)
  1686. (point)))
  1687. (end (progn (skip-chars-forward " \r\t\n" limit)
  1688. (if (eobp) (point) (line-beginning-position))))
  1689. (value (buffer-substring-no-properties
  1690. contents-begin contents-end)))
  1691. (list 'comment-block
  1692. (nconc
  1693. (list :begin begin
  1694. :end end
  1695. :value value
  1696. :post-blank (count-lines pos-before-blank end)
  1697. :post-affiliated post-affiliated)
  1698. (cdr affiliated)))))))))
  1699. (defun org-element-comment-block-interpreter (comment-block _)
  1700. "Interpret COMMENT-BLOCK element as Org syntax."
  1701. (format "#+begin_comment\n%s#+end_comment"
  1702. (org-element-normalize-string
  1703. (org-remove-indentation
  1704. (org-element-property :value comment-block)))))
  1705. ;;;; Diary Sexp
  1706. (defun org-element-diary-sexp-parser (limit affiliated)
  1707. "Parse a diary sexp.
  1708. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1709. the buffer position at the beginning of the first affiliated
  1710. keyword and CDR is a plist of affiliated keywords along with
  1711. their value.
  1712. Return a list whose CAR is `diary-sexp' and CDR is a plist
  1713. containing `:begin', `:end', `:value', `:post-blank' and
  1714. `:post-affiliated' keywords."
  1715. (save-excursion
  1716. (let ((begin (car affiliated))
  1717. (post-affiliated (point))
  1718. (value (progn (looking-at "\\(%%(.*\\)[ \t]*$")
  1719. (match-string-no-properties 1)))
  1720. (pos-before-blank (progn (forward-line) (point)))
  1721. (end (progn (skip-chars-forward " \r\t\n" limit)
  1722. (if (eobp) (point) (line-beginning-position)))))
  1723. (list 'diary-sexp
  1724. (nconc
  1725. (list :value value
  1726. :begin begin
  1727. :end end
  1728. :post-blank (count-lines pos-before-blank end)
  1729. :post-affiliated post-affiliated)
  1730. (cdr affiliated))))))
  1731. (defun org-element-diary-sexp-interpreter (diary-sexp _)
  1732. "Interpret DIARY-SEXP as Org syntax."
  1733. (org-element-property :value diary-sexp))
  1734. ;;;; Example Block
  1735. (defun org-element-example-block-parser (limit affiliated)
  1736. "Parse an example block.
  1737. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1738. the buffer position at the beginning of the first affiliated
  1739. keyword and CDR is a plist of affiliated keywords along with
  1740. their value.
  1741. Return a list whose CAR is `example-block' and CDR is a plist
  1742. containing `:begin', `:end', `:number-lines', `:preserve-indent',
  1743. `:retain-labels', `:use-labels', `:label-fmt', `:switches',
  1744. `:value', `:post-blank' and `:post-affiliated' keywords."
  1745. (let ((case-fold-search t))
  1746. (if (not (save-excursion
  1747. (re-search-forward "^[ \t]*#\\+END_EXAMPLE[ \t]*$" limit t)))
  1748. ;; Incomplete block: parse it as a paragraph.
  1749. (org-element-paragraph-parser limit affiliated)
  1750. (let ((contents-end (match-beginning 0)))
  1751. (save-excursion
  1752. (let* ((switches
  1753. (progn
  1754. (looking-at "^[ \t]*#\\+BEGIN_EXAMPLE\\(?: +\\(.*\\)\\)?")
  1755. (match-string-no-properties 1)))
  1756. ;; Switches analysis.
  1757. (number-lines
  1758. (and switches
  1759. (string-match "\\([-+]\\)n\\(?: *\\([0-9]+\\)\\)?\\>"
  1760. switches)
  1761. (cons
  1762. (if (equal (match-string 1 switches) "-")
  1763. 'new
  1764. 'continued)
  1765. (if (not (match-end 2)) 0
  1766. ;; Subtract 1 to give number of lines before
  1767. ;; first line.
  1768. (1- (string-to-number (match-string 2 switches)))))))
  1769. (preserve-indent
  1770. (and switches (string-match "-i\\>" switches)))
  1771. ;; Should labels be retained in (or stripped from) example
  1772. ;; blocks?
  1773. (retain-labels
  1774. (or (not switches)
  1775. (not (string-match "-r\\>" switches))
  1776. (and number-lines (string-match "-k\\>" switches))))
  1777. ;; What should code-references use - labels or
  1778. ;; line-numbers?
  1779. (use-labels
  1780. (or (not switches)
  1781. (and retain-labels
  1782. (not (string-match "-k\\>" switches)))))
  1783. (label-fmt
  1784. (and switches
  1785. (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
  1786. (match-string 1 switches)))
  1787. ;; Standard block parsing.
  1788. (begin (car affiliated))
  1789. (post-affiliated (point))
  1790. (contents-begin (line-beginning-position 2))
  1791. (value (org-unescape-code-in-string
  1792. (buffer-substring-no-properties
  1793. contents-begin contents-end)))
  1794. (pos-before-blank (progn (goto-char contents-end)
  1795. (forward-line)
  1796. (point)))
  1797. (end (progn (skip-chars-forward " \r\t\n" limit)
  1798. (if (eobp) (point) (line-beginning-position)))))
  1799. (list 'example-block
  1800. (nconc
  1801. (list :begin begin
  1802. :end end
  1803. :value value
  1804. :switches switches
  1805. :number-lines number-lines
  1806. :preserve-indent preserve-indent
  1807. :retain-labels retain-labels
  1808. :use-labels use-labels
  1809. :label-fmt label-fmt
  1810. :post-blank (count-lines pos-before-blank end)
  1811. :post-affiliated post-affiliated)
  1812. (cdr affiliated)))))))))
  1813. (defun org-element-example-block-interpreter (example-block _)
  1814. "Interpret EXAMPLE-BLOCK element as Org syntax."
  1815. (let ((switches (org-element-property :switches example-block))
  1816. (value
  1817. (let ((val (org-element-property :value example-block)))
  1818. (cond
  1819. ((or org-src-preserve-indentation
  1820. (org-element-property :preserve-indent example-block))
  1821. val)
  1822. ((= 0 org-edit-src-content-indentation)
  1823. (org-remove-indentation val))
  1824. (t
  1825. (let ((ind (make-string org-edit-src-content-indentation ?\s)))
  1826. (replace-regexp-in-string "^[ \t]*\\S-"
  1827. (concat ind "\\&")
  1828. (org-remove-indentation val))))))))
  1829. (concat "#+begin_example" (and switches (concat " " switches)) "\n"
  1830. (org-element-normalize-string (org-escape-code-in-string value))
  1831. "#+end_example")))
  1832. ;;;; Export Block
  1833. (defun org-element-export-block-parser (limit affiliated)
  1834. "Parse an export block.
  1835. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1836. the buffer position at the beginning of the first affiliated
  1837. keyword and CDR is a plist of affiliated keywords along with
  1838. their value.
  1839. Return a list whose CAR is `export-block' and CDR is a plist
  1840. containing `:begin', `:end', `:type', `:value', `:post-blank' and
  1841. `:post-affiliated' keywords.
  1842. Assume point is at export-block beginning."
  1843. (let* ((case-fold-search t))
  1844. (if (not (save-excursion
  1845. (re-search-forward "^[ \t]*#\\+END_EXPORT[ \t]*$" limit t)))
  1846. ;; Incomplete block: parse it as a paragraph.
  1847. (org-element-paragraph-parser limit affiliated)
  1848. (save-excursion
  1849. (let* ((contents-end (match-beginning 0))
  1850. (backend
  1851. (progn
  1852. (looking-at
  1853. "[ \t]*#\\+BEGIN_EXPORT\\(?:[ \t]+\\(\\S-+\\)\\)?[ \t]*$")
  1854. (match-string-no-properties 1)))
  1855. (begin (car affiliated))
  1856. (post-affiliated (point))
  1857. (contents-begin (progn (forward-line) (point)))
  1858. (pos-before-blank (progn (goto-char contents-end)
  1859. (forward-line)
  1860. (point)))
  1861. (end (progn (skip-chars-forward " \r\t\n" limit)
  1862. (if (eobp) (point) (line-beginning-position))))
  1863. (value (org-unescape-code-in-string
  1864. (buffer-substring-no-properties contents-begin
  1865. contents-end))))
  1866. (list 'export-block
  1867. (nconc
  1868. (list :type (and backend (upcase backend))
  1869. :begin begin
  1870. :end end
  1871. :value value
  1872. :post-blank (count-lines pos-before-blank end)
  1873. :post-affiliated post-affiliated)
  1874. (cdr affiliated))))))))
  1875. (defun org-element-export-block-interpreter (export-block _)
  1876. "Interpret EXPORT-BLOCK element as Org syntax."
  1877. (format "#+begin_export %s\n%s#+end_export"
  1878. (org-element-property :type export-block)
  1879. (org-element-property :value export-block)))
  1880. ;;;; Fixed-width
  1881. (defun org-element-fixed-width-parser (limit affiliated)
  1882. "Parse a fixed-width section.
  1883. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1884. the buffer position at the beginning of the first affiliated
  1885. keyword and CDR is a plist of affiliated keywords along with
  1886. their value.
  1887. Return a list whose CAR is `fixed-width' and CDR is a plist
  1888. containing `:begin', `:end', `:value', `:post-blank' and
  1889. `:post-affiliated' keywords.
  1890. Assume point is at the beginning of the fixed-width area."
  1891. (save-excursion
  1892. (let* ((begin (car affiliated))
  1893. (post-affiliated (point))
  1894. (end-area
  1895. (progn
  1896. (while (and (< (point) limit)
  1897. (looking-at "[ \t]*:\\( \\|$\\)"))
  1898. (forward-line))
  1899. (if (bolp) (line-end-position 0) (point))))
  1900. (end (progn (skip-chars-forward " \r\t\n" limit)
  1901. (if (eobp) (point) (line-beginning-position)))))
  1902. (list 'fixed-width
  1903. (nconc
  1904. (list :begin begin
  1905. :end end
  1906. :value (replace-regexp-in-string
  1907. "^[ \t]*: ?" ""
  1908. (buffer-substring-no-properties post-affiliated
  1909. end-area))
  1910. :post-blank (count-lines end-area end)
  1911. :post-affiliated post-affiliated)
  1912. (cdr affiliated))))))
  1913. (defun org-element-fixed-width-interpreter (fixed-width _)
  1914. "Interpret FIXED-WIDTH element as Org syntax."
  1915. (let ((value (org-element-property :value fixed-width)))
  1916. (and value (replace-regexp-in-string "^" ": " value))))
  1917. ;;;; Horizontal Rule
  1918. (defun org-element-horizontal-rule-parser (limit affiliated)
  1919. "Parse an horizontal rule.
  1920. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1921. the buffer position at the beginning of the first affiliated
  1922. keyword and CDR is a plist of affiliated keywords along with
  1923. their value.
  1924. Return a list whose CAR is `horizontal-rule' and CDR is a plist
  1925. containing `:begin', `:end', `:post-blank' and `:post-affiliated'
  1926. keywords."
  1927. (save-excursion
  1928. (let ((begin (car affiliated))
  1929. (post-affiliated (point))
  1930. (post-hr (progn (forward-line) (point)))
  1931. (end (progn (skip-chars-forward " \r\t\n" limit)
  1932. (if (eobp) (point) (line-beginning-position)))))
  1933. (list 'horizontal-rule
  1934. (nconc
  1935. (list :begin begin
  1936. :end end
  1937. :post-blank (count-lines post-hr end)
  1938. :post-affiliated post-affiliated)
  1939. (cdr affiliated))))))
  1940. (defun org-element-horizontal-rule-interpreter (&rest _)
  1941. "Interpret HORIZONTAL-RULE element as Org syntax."
  1942. "-----")
  1943. ;;;; Keyword
  1944. (defun org-element-keyword-parser (limit affiliated)
  1945. "Parse a keyword at point.
  1946. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1947. the buffer position at the beginning of the first affiliated
  1948. keyword and CDR is a plist of affiliated keywords along with
  1949. their value.
  1950. Return a list whose CAR is a normalized `keyword' (uppercase) and
  1951. CDR is a plist containing `:key', `:value', `:begin', `:end',
  1952. `:post-blank' and `:post-affiliated' keywords."
  1953. (save-excursion
  1954. ;; An orphaned affiliated keyword is considered as a regular
  1955. ;; keyword. In this case AFFILIATED is nil, so we take care of
  1956. ;; this corner case.
  1957. (let ((begin (or (car affiliated) (point)))
  1958. (post-affiliated (point))
  1959. (key (progn (looking-at "[ \t]*#\\+\\(\\S-*\\):")
  1960. (upcase (match-string-no-properties 1))))
  1961. (value (org-trim (buffer-substring-no-properties
  1962. (match-end 0) (point-at-eol))))
  1963. (pos-before-blank (progn (forward-line) (point)))
  1964. (end (progn (skip-chars-forward " \r\t\n" limit)
  1965. (if (eobp) (point) (line-beginning-position)))))
  1966. (list 'keyword
  1967. (nconc
  1968. (list :key key
  1969. :value value
  1970. :begin begin
  1971. :end end
  1972. :post-blank (count-lines pos-before-blank end)
  1973. :post-affiliated post-affiliated)
  1974. (cdr affiliated))))))
  1975. (defun org-element-keyword-interpreter (keyword _)
  1976. "Interpret KEYWORD element as Org syntax."
  1977. (format "#+%s: %s"
  1978. (downcase (org-element-property :key keyword))
  1979. (org-element-property :value keyword)))
  1980. ;;;; Latex Environment
  1981. (defconst org-element--latex-begin-environment
  1982. "^[ \t]*\\\\begin{\\([A-Za-z0-9*]+\\)}"
  1983. "Regexp matching the beginning of a LaTeX environment.
  1984. The environment is captured by the first group.
  1985. See also `org-element--latex-end-environment'.")
  1986. (defconst org-element--latex-end-environment
  1987. "\\\\end{%s}[ \t]*$"
  1988. "Format string matching the ending of a LaTeX environment.
  1989. See also `org-element--latex-begin-environment'.")
  1990. (defun org-element-latex-environment-parser (limit affiliated)
  1991. "Parse a LaTeX environment.
  1992. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  1993. the buffer position at the beginning of the first affiliated
  1994. keyword and CDR is a plist of affiliated keywords along with
  1995. their value.
  1996. Return a list whose CAR is `latex-environment' and CDR is a plist
  1997. containing `:begin', `:end', `:value', `:post-blank' and
  1998. `:post-affiliated' keywords.
  1999. Assume point is at the beginning of the latex environment."
  2000. (save-excursion
  2001. (let ((case-fold-search t)
  2002. (code-begin (point)))
  2003. (looking-at org-element--latex-begin-environment)
  2004. (if (not (re-search-forward (format org-element--latex-end-environment
  2005. (regexp-quote (match-string 1)))
  2006. limit t))
  2007. ;; Incomplete latex environment: parse it as a paragraph.
  2008. (org-element-paragraph-parser limit affiliated)
  2009. (let* ((code-end (progn (forward-line) (point)))
  2010. (begin (car affiliated))
  2011. (value (buffer-substring-no-properties code-begin code-end))
  2012. (end (progn (skip-chars-forward " \r\t\n" limit)
  2013. (if (eobp) (point) (line-beginning-position)))))
  2014. (list 'latex-environment
  2015. (nconc
  2016. (list :begin begin
  2017. :end end
  2018. :value value
  2019. :post-blank (count-lines code-end end)
  2020. :post-affiliated code-begin)
  2021. (cdr affiliated))))))))
  2022. (defun org-element-latex-environment-interpreter (latex-environment _)
  2023. "Interpret LATEX-ENVIRONMENT element as Org syntax."
  2024. (org-element-property :value latex-environment))
  2025. ;;;; Node Property
  2026. (defun org-element-node-property-parser (limit)
  2027. "Parse a node-property at point.
  2028. LIMIT bounds the search.
  2029. Return a list whose CAR is `node-property' and CDR is a plist
  2030. containing `:key', `:value', `:begin', `:end', `:post-blank' and
  2031. `:post-affiliated' keywords."
  2032. (looking-at org-property-re)
  2033. (let ((case-fold-search t)
  2034. (begin (point))
  2035. (key (match-string-no-properties 2))
  2036. (value (match-string-no-properties 3))
  2037. (end (save-excursion
  2038. (end-of-line)
  2039. (if (re-search-forward org-property-re limit t)
  2040. (line-beginning-position)
  2041. limit))))
  2042. (list 'node-property
  2043. (list :key key
  2044. :value value
  2045. :begin begin
  2046. :end end
  2047. :post-blank 0
  2048. :post-affiliated begin))))
  2049. (defun org-element-node-property-interpreter (node-property _)
  2050. "Interpret NODE-PROPERTY element as Org syntax."
  2051. (format org-property-format
  2052. (format ":%s:" (org-element-property :key node-property))
  2053. (or (org-element-property :value node-property) "")))
  2054. ;;;; Paragraph
  2055. (defun org-element-paragraph-parser (limit affiliated)
  2056. "Parse a paragraph.
  2057. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  2058. the buffer position at the beginning of the first affiliated
  2059. keyword and CDR is a plist of affiliated keywords along with
  2060. their value.
  2061. Return a list whose CAR is `paragraph' and CDR is a plist
  2062. containing `:begin', `:end', `:contents-begin' and
  2063. `:contents-end', `:post-blank' and `:post-affiliated' keywords.
  2064. Assume point is at the beginning of the paragraph."
  2065. (save-excursion
  2066. (let* ((begin (car affiliated))
  2067. (contents-begin (point))
  2068. (before-blank
  2069. (let ((case-fold-search t))
  2070. (end-of-line)
  2071. ;; A matching `org-element-paragraph-separate' is not
  2072. ;; necessarily the end of the paragraph. In particular,
  2073. ;; drawers, blocks or LaTeX environments opening lines
  2074. ;; must be closed. Moreover keywords with a secondary
  2075. ;; value must belong to "dual keywords".
  2076. (while (not
  2077. (cond
  2078. ((not (and (re-search-forward
  2079. org-element-paragraph-separate limit 'move)
  2080. (progn (beginning-of-line) t))))
  2081. ((looking-at org-drawer-regexp)
  2082. (save-excursion
  2083. (re-search-forward "^[ \t]*:END:[ \t]*$" limit t)))
  2084. ((looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
  2085. (save-excursion
  2086. (re-search-forward
  2087. (format "^[ \t]*#\\+END_%s[ \t]*$"
  2088. (regexp-quote (match-string 1)))
  2089. limit t)))
  2090. ((looking-at org-element--latex-begin-environment)
  2091. (save-excursion
  2092. (re-search-forward
  2093. (format org-element--latex-end-environment
  2094. (regexp-quote (match-string 1)))
  2095. limit t)))
  2096. ((looking-at "[ \t]*#\\+\\(\\S-+\\)\\[.*\\]:")
  2097. (member-ignore-case (match-string 1)
  2098. org-element-dual-keywords))
  2099. ;; Everything else is unambiguous.
  2100. (t)))
  2101. (end-of-line))
  2102. (if (= (point) limit) limit
  2103. (goto-char (line-beginning-position)))))
  2104. (contents-end (save-excursion
  2105. (skip-chars-backward " \r\t\n" contents-begin)
  2106. (line-beginning-position 2)))
  2107. (end (progn (skip-chars-forward " \r\t\n" limit)
  2108. (if (eobp) (point) (line-beginning-position)))))
  2109. (list 'paragraph
  2110. (nconc
  2111. (list :begin begin
  2112. :end end
  2113. :contents-begin contents-begin
  2114. :contents-end contents-end
  2115. :post-blank (count-lines before-blank end)
  2116. :post-affiliated contents-begin)
  2117. (cdr affiliated))))))
  2118. (defun org-element-paragraph-interpreter (_ contents)
  2119. "Interpret paragraph element as Org syntax.
  2120. CONTENTS is the contents of the element."
  2121. contents)
  2122. ;;;; Planning
  2123. (defun org-element-planning-parser (limit)
  2124. "Parse a planning.
  2125. LIMIT bounds the search.
  2126. Return a list whose CAR is `planning' and CDR is a plist
  2127. containing `:closed', `:deadline', `:scheduled', `:begin',
  2128. `:end', `:post-blank' and `:post-affiliated' keywords."
  2129. (save-excursion
  2130. (let* ((case-fold-search nil)
  2131. (begin (point))
  2132. (post-blank (let ((before-blank (progn (forward-line) (point))))
  2133. (skip-chars-forward " \r\t\n" limit)
  2134. (skip-chars-backward " \t")
  2135. (unless (bolp) (end-of-line))
  2136. (count-lines before-blank (point))))
  2137. (end (point))
  2138. closed deadline scheduled)
  2139. (goto-char begin)
  2140. (while (re-search-forward org-keyword-time-not-clock-regexp end t)
  2141. (goto-char (match-end 1))
  2142. (skip-chars-forward " \t" end)
  2143. (let ((keyword (match-string 1))
  2144. (time (org-element-timestamp-parser)))
  2145. (cond ((equal keyword org-closed-string) (setq closed time))
  2146. ((equal keyword org-deadline-string) (setq deadline time))
  2147. (t (setq scheduled time)))))
  2148. (list 'planning
  2149. (list :closed closed
  2150. :deadline deadline
  2151. :scheduled scheduled
  2152. :begin begin
  2153. :end end
  2154. :post-blank post-blank
  2155. :post-affiliated begin)))))
  2156. (defun org-element-planning-interpreter (planning _)
  2157. "Interpret PLANNING element as Org syntax."
  2158. (mapconcat
  2159. #'identity
  2160. (delq nil
  2161. (list (let ((deadline (org-element-property :deadline planning)))
  2162. (when deadline
  2163. (concat org-deadline-string " "
  2164. (org-element-timestamp-interpreter deadline nil))))
  2165. (let ((scheduled (org-element-property :scheduled planning)))
  2166. (when scheduled
  2167. (concat org-scheduled-string " "
  2168. (org-element-timestamp-interpreter scheduled nil))))
  2169. (let ((closed (org-element-property :closed planning)))
  2170. (when closed
  2171. (concat org-closed-string " "
  2172. (org-element-timestamp-interpreter closed nil))))))
  2173. " "))
  2174. ;;;; Src Block
  2175. (defun org-element-src-block-parser (limit affiliated)
  2176. "Parse a source block.
  2177. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  2178. the buffer position at the beginning of the first affiliated
  2179. keyword and CDR is a plist of affiliated keywords along with
  2180. their value.
  2181. Return a list whose CAR is `src-block' and CDR is a plist
  2182. containing `:language', `:switches', `:parameters', `:begin',
  2183. `:end', `:number-lines', `:retain-labels', `:use-labels',
  2184. `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
  2185. `:post-affiliated' keywords.
  2186. Assume point is at the beginning of the block."
  2187. (let ((case-fold-search t))
  2188. (if (not (save-excursion (re-search-forward "^[ \t]*#\\+END_SRC[ \t]*$"
  2189. limit t)))
  2190. ;; Incomplete block: parse it as a paragraph.
  2191. (org-element-paragraph-parser limit affiliated)
  2192. (let ((contents-end (match-beginning 0)))
  2193. (save-excursion
  2194. (let* ((begin (car affiliated))
  2195. (post-affiliated (point))
  2196. ;; Get language as a string.
  2197. (language
  2198. (progn
  2199. (looking-at
  2200. "^[ \t]*#\\+BEGIN_SRC\
  2201. \\(?: +\\(\\S-+\\)\\)?\
  2202. \\(\\(?: +\\(?:-\\(?:l \".+\"\\|[ikr]\\)\\|[-+]n\\(?: *[0-9]+\\)?\\)\\)+\\)?\
  2203. \\(.*\\)[ \t]*$")
  2204. (match-string-no-properties 1)))
  2205. ;; Get switches.
  2206. (switches (match-string-no-properties 2))
  2207. ;; Get parameters.
  2208. (parameters (match-string-no-properties 3))
  2209. ;; Switches analysis.
  2210. (number-lines
  2211. (and switches
  2212. (string-match "\\([-+]\\)n\\(?: *\\([0-9]+\\)\\)?\\>"
  2213. switches)
  2214. (cons
  2215. (if (equal (match-string 1 switches) "-")
  2216. 'new
  2217. 'continued)
  2218. (if (not (match-end 2)) 0
  2219. ;; Subtract 1 to give number of lines before
  2220. ;; first line.
  2221. (1- (string-to-number (match-string 2 switches)))))))
  2222. (preserve-indent (and switches
  2223. (string-match "-i\\>" switches)))
  2224. (label-fmt
  2225. (and switches
  2226. (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
  2227. (match-string 1 switches)))
  2228. ;; Should labels be retained in (or stripped from)
  2229. ;; source blocks?
  2230. (retain-labels
  2231. (or (not switches)
  2232. (not (string-match "-r\\>" switches))
  2233. (and number-lines (string-match "-k\\>" switches))))
  2234. ;; What should code-references use - labels or
  2235. ;; line-numbers?
  2236. (use-labels
  2237. (or (not switches)
  2238. (and retain-labels
  2239. (not (string-match "-k\\>" switches)))))
  2240. ;; Retrieve code.
  2241. (value (org-unescape-code-in-string
  2242. (buffer-substring-no-properties
  2243. (line-beginning-position 2) contents-end)))
  2244. (pos-before-blank (progn (goto-char contents-end)
  2245. (forward-line)
  2246. (point)))
  2247. ;; Get position after ending blank lines.
  2248. (end (progn (skip-chars-forward " \r\t\n" limit)
  2249. (if (eobp) (point) (line-beginning-position)))))
  2250. (list 'src-block
  2251. (nconc
  2252. (list :language language
  2253. :switches (and (org-string-nw-p switches)
  2254. (org-trim switches))
  2255. :parameters (and (org-string-nw-p parameters)
  2256. (org-trim parameters))
  2257. :begin begin
  2258. :end end
  2259. :number-lines number-lines
  2260. :preserve-indent preserve-indent
  2261. :retain-labels retain-labels
  2262. :use-labels use-labels
  2263. :label-fmt label-fmt
  2264. :value value
  2265. :post-blank (count-lines pos-before-blank end)
  2266. :post-affiliated post-affiliated)
  2267. (cdr affiliated)))))))))
  2268. (defun org-element-src-block-interpreter (src-block _)
  2269. "Interpret SRC-BLOCK element as Org syntax."
  2270. (let ((lang (org-element-property :language src-block))
  2271. (switches (org-element-property :switches src-block))
  2272. (params (org-element-property :parameters src-block))
  2273. (value
  2274. (let ((val (org-element-property :value src-block)))
  2275. (cond
  2276. ((or org-src-preserve-indentation
  2277. (org-element-property :preserve-indent src-block))
  2278. val)
  2279. ((zerop org-edit-src-content-indentation)
  2280. (org-remove-indentation val))
  2281. (t
  2282. (let ((ind (make-string org-edit-src-content-indentation ?\s)))
  2283. (replace-regexp-in-string "^[ \t]*\\S-"
  2284. (concat ind "\\&")
  2285. (org-remove-indentation val))))))))
  2286. (format "#+begin_src%s\n%s#+end_src"
  2287. (concat (and lang (concat " " lang))
  2288. (and switches (concat " " switches))
  2289. (and params (concat " " params)))
  2290. (org-element-normalize-string (org-escape-code-in-string value)))))
  2291. ;;;; Table
  2292. (defun org-element-table-parser (limit affiliated)
  2293. "Parse a table at point.
  2294. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  2295. the buffer position at the beginning of the first affiliated
  2296. keyword and CDR is a plist of affiliated keywords along with
  2297. their value.
  2298. Return a list whose CAR is `table' and CDR is a plist containing
  2299. `:begin', `:end', `:tblfm', `:type', `:contents-begin',
  2300. `:contents-end', `:value', `:post-blank' and `:post-affiliated'
  2301. keywords.
  2302. Assume point is at the beginning of the table."
  2303. (save-excursion
  2304. (let* ((case-fold-search t)
  2305. (table-begin (point))
  2306. (type (if (looking-at "[ \t]*|") 'org 'table.el))
  2307. (end-re (format "^[ \t]*\\($\\|[^| \t%s]\\)"
  2308. (if (eq type 'org) "" "+")))
  2309. (begin (car affiliated))
  2310. (table-end
  2311. (if (re-search-forward end-re limit 'move)
  2312. (goto-char (match-beginning 0))
  2313. (point)))
  2314. (tblfm (let (acc)
  2315. (while (looking-at "[ \t]*#\\+TBLFM: +\\(.*\\)[ \t]*$")
  2316. (push (match-string-no-properties 1) acc)
  2317. (forward-line))
  2318. acc))
  2319. (pos-before-blank (point))
  2320. (end (progn (skip-chars-forward " \r\t\n" limit)
  2321. (if (eobp) (point) (line-beginning-position)))))
  2322. (list 'table
  2323. (nconc
  2324. (list :begin begin
  2325. :end end
  2326. :type type
  2327. :tblfm tblfm
  2328. ;; Only `org' tables have contents. `table.el' tables
  2329. ;; use a `:value' property to store raw table as
  2330. ;; a string.
  2331. :contents-begin (and (eq type 'org) table-begin)
  2332. :contents-end (and (eq type 'org) table-end)
  2333. :value (and (eq type 'table.el)
  2334. (buffer-substring-no-properties
  2335. table-begin table-end))
  2336. :post-blank (count-lines pos-before-blank end)
  2337. :post-affiliated table-begin)
  2338. (cdr affiliated))))))
  2339. (defun org-element-table-interpreter (table contents)
  2340. "Interpret TABLE element as Org syntax.
  2341. CONTENTS is a string, if table's type is `org', or nil."
  2342. (if (eq (org-element-property :type table) 'table.el)
  2343. (org-remove-indentation (org-element-property :value table))
  2344. (concat (with-temp-buffer (insert contents)
  2345. (org-table-align)
  2346. (buffer-string))
  2347. (mapconcat (lambda (fm) (concat "#+TBLFM: " fm))
  2348. (reverse (org-element-property :tblfm table))
  2349. "\n"))))
  2350. ;;;; Table Row
  2351. (defun org-element-table-row-parser (_)
  2352. "Parse table row at point.
  2353. Return a list whose CAR is `table-row' and CDR is a plist
  2354. containing `:begin', `:end', `:contents-begin', `:contents-end',
  2355. `:type', `:post-blank' and `:post-affiliated' keywords."
  2356. (save-excursion
  2357. (let* ((type (if (looking-at "^[ \t]*|-") 'rule 'standard))
  2358. (begin (point))
  2359. ;; A table rule has no contents. In that case, ensure
  2360. ;; CONTENTS-BEGIN matches CONTENTS-END.
  2361. (contents-begin (and (eq type 'standard) (search-forward "|")))
  2362. (contents-end (and (eq type 'standard)
  2363. (progn
  2364. (end-of-line)
  2365. (skip-chars-backward " \t")
  2366. (point))))
  2367. (end (line-beginning-position 2)))
  2368. (list 'table-row
  2369. (list :type type
  2370. :begin begin
  2371. :end end
  2372. :contents-begin contents-begin
  2373. :contents-end contents-end
  2374. :post-blank 0
  2375. :post-affiliated begin)))))
  2376. (defun org-element-table-row-interpreter (table-row contents)
  2377. "Interpret TABLE-ROW element as Org syntax.
  2378. CONTENTS is the contents of the table row."
  2379. (if (eq (org-element-property :type table-row) 'rule) "|-"
  2380. (concat "|" contents)))
  2381. ;;;; Verse Block
  2382. (defun org-element-verse-block-parser (limit affiliated)
  2383. "Parse a verse block.
  2384. LIMIT bounds the search. AFFILIATED is a list of which CAR is
  2385. the buffer position at the beginning of the first affiliated
  2386. keyword and CDR is a plist of affiliated keywords along with
  2387. their value.
  2388. Return a list whose CAR is `verse-block' and CDR is a plist
  2389. containing `:begin', `:end', `:contents-begin', `:contents-end',
  2390. `:post-blank' and `:post-affiliated' keywords.
  2391. Assume point is at beginning of the block."
  2392. (let ((case-fold-search t))
  2393. (if (not (save-excursion
  2394. (re-search-forward "^[ \t]*#\\+END_VERSE[ \t]*$" limit t)))
  2395. ;; Incomplete block: parse it as a paragraph.
  2396. (org-element-paragraph-parser limit affiliated)
  2397. (let ((contents-end (match-beginning 0)))
  2398. (save-excursion
  2399. (let* ((begin (car affiliated))
  2400. (post-affiliated (point))
  2401. (contents-begin (progn (forward-line) (point)))
  2402. (pos-before-blank (progn (goto-char contents-end)
  2403. (forward-line)
  2404. (point)))
  2405. (end (progn (skip-chars-forward " \r\t\n" limit)
  2406. (if (eobp) (point) (line-beginning-position)))))
  2407. (list 'verse-block
  2408. (nconc
  2409. (list :begin begin
  2410. :end end
  2411. :contents-begin contents-begin
  2412. :contents-end contents-end
  2413. :post-blank (count-lines pos-before-blank end)
  2414. :post-affiliated post-affiliated)
  2415. (cdr affiliated)))))))))
  2416. (defun org-element-verse-block-interpreter (_ contents)
  2417. "Interpret verse-block element as Org syntax.
  2418. CONTENTS is verse block contents."
  2419. (format "#+begin_verse\n%s#+end_verse" contents))
  2420. ;;; Objects
  2421. ;;
  2422. ;; Unlike to elements, raw text can be found between objects. Hence,
  2423. ;; `org-element--object-lex' is provided to find the next object in
  2424. ;; buffer.
  2425. ;;
  2426. ;; Some object types (e.g., `italic') are recursive. Restrictions on
  2427. ;; object types they can contain will be specified in
  2428. ;; `org-element-object-restrictions'.
  2429. ;;
  2430. ;; Creating a new type of object requires to alter
  2431. ;; `org-element--object-regexp' and `org-element--object-lex', add the
  2432. ;; new type in `org-element-all-objects', and possibly add
  2433. ;; restrictions in `org-element-object-restrictions'.
  2434. ;;;; Bold
  2435. (defun org-element-bold-parser ()
  2436. "Parse bold object at point, if any.
  2437. When at a bold object, return a list whose car is `bold' and cdr
  2438. is a plist with `:begin', `:end', `:contents-begin' and
  2439. `:contents-end' and `:post-blank' keywords. Otherwise, return
  2440. nil.
  2441. Assume point is at the first star marker."
  2442. (save-excursion
  2443. (unless (bolp) (backward-char 1))
  2444. (when (looking-at org-emph-re)
  2445. (let ((begin (match-beginning 2))
  2446. (contents-begin (match-beginning 4))
  2447. (contents-end (match-end 4))
  2448. (post-blank (progn (goto-char (match-end 2))
  2449. (skip-chars-forward " \t")))
  2450. (end (point)))
  2451. (list 'bold
  2452. (list :begin begin
  2453. :end end
  2454. :contents-begin contents-begin
  2455. :contents-end contents-end
  2456. :post-blank post-blank))))))
  2457. (defun org-element-bold-interpreter (_ contents)
  2458. "Interpret bold object as Org syntax.
  2459. CONTENTS is the contents of the object."
  2460. (format "*%s*" contents))
  2461. ;;;; Code
  2462. (defun org-element-code-parser ()
  2463. "Parse code object at point, if any.
  2464. When at a code object, return a list whose car is `code' and cdr
  2465. is a plist with `:value', `:begin', `:end' and `:post-blank'
  2466. keywords. Otherwise, return nil.
  2467. Assume point is at the first tilde marker."
  2468. (save-excursion
  2469. (unless (bolp) (backward-char 1))
  2470. (when (looking-at org-verbatim-re)
  2471. (let ((begin (match-beginning 2))
  2472. (value (match-string-no-properties 4))
  2473. (post-blank (progn (goto-char (match-end 2))
  2474. (skip-chars-forward " \t")))
  2475. (end (point)))
  2476. (list 'code
  2477. (list :value value
  2478. :begin begin
  2479. :end end
  2480. :post-blank post-blank))))))
  2481. (defun org-element-code-interpreter (code _)
  2482. "Interpret CODE object as Org syntax."
  2483. (format "~%s~" (org-element-property :value code)))
  2484. ;;;; Entity
  2485. (defun org-element-entity-parser ()
  2486. "Parse entity at point, if any.
  2487. When at an entity, return a list whose car is `entity' and cdr
  2488. a plist with `:begin', `:end', `:latex', `:latex-math-p',
  2489. `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
  2490. `:post-blank' as keywords. Otherwise, return nil.
  2491. Assume point is at the beginning of the entity."
  2492. (catch 'no-object
  2493. (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
  2494. (save-excursion
  2495. (let* ((value (or (org-entity-get (match-string 1))
  2496. (throw 'no-object nil)))
  2497. (begin (match-beginning 0))
  2498. (bracketsp (string= (match-string 2) "{}"))
  2499. (post-blank (progn (goto-char (match-end 1))
  2500. (when bracketsp (forward-char 2))
  2501. (skip-chars-forward " \t")))
  2502. (end (point)))
  2503. (list 'entity
  2504. (list :name (car value)
  2505. :latex (nth 1 value)
  2506. :latex-math-p (nth 2 value)
  2507. :html (nth 3 value)
  2508. :ascii (nth 4 value)
  2509. :latin1 (nth 5 value)
  2510. :utf-8 (nth 6 value)
  2511. :begin begin
  2512. :end end
  2513. :use-brackets-p bracketsp
  2514. :post-blank post-blank)))))))
  2515. (defun org-element-entity-interpreter (entity _)
  2516. "Interpret ENTITY object as Org syntax."
  2517. (concat "\\"
  2518. (org-element-property :name entity)
  2519. (when (org-element-property :use-brackets-p entity) "{}")))
  2520. ;;;; Export Snippet
  2521. (defun org-element-export-snippet-parser ()
  2522. "Parse export snippet at point.
  2523. When at an export snippet, return a list whose car is
  2524. `export-snippet' and cdr a plist with `:begin', `:end',
  2525. `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
  2526. return nil.
  2527. Assume point is at the beginning of the snippet."
  2528. (save-excursion
  2529. (let (contents-end)
  2530. (when (and (looking-at "@@\\([-A-Za-z0-9]+\\):")
  2531. (setq contents-end
  2532. (save-match-data (goto-char (match-end 0))
  2533. (re-search-forward "@@" nil t)
  2534. (match-beginning 0))))
  2535. (let* ((begin (match-beginning 0))
  2536. (back-end (match-string-no-properties 1))
  2537. (value (buffer-substring-no-properties
  2538. (match-end 0) contents-end))
  2539. (post-blank (skip-chars-forward " \t"))
  2540. (end (point)))
  2541. (list 'export-snippet
  2542. (list :back-end back-end
  2543. :value value
  2544. :begin begin
  2545. :end end
  2546. :post-blank post-blank)))))))
  2547. (defun org-element-export-snippet-interpreter (export-snippet _)
  2548. "Interpret EXPORT-SNIPPET object as Org syntax."
  2549. (format "@@%s:%s@@"
  2550. (org-element-property :back-end export-snippet)
  2551. (org-element-property :value export-snippet)))
  2552. ;;;; Footnote Reference
  2553. (defun org-element-footnote-reference-parser ()
  2554. "Parse footnote reference at point, if any.
  2555. When at a footnote reference, return a list whose car is
  2556. `footnote-reference' and cdr a plist with `:label', `:type',
  2557. `:begin', `:end', `:contents-begin', `:contents-end' and
  2558. `:post-blank' as keywords. Otherwise, return nil."
  2559. (when (looking-at org-footnote-re)
  2560. (let ((closing (with-syntax-table org-element--pair-square-table
  2561. (ignore-errors (scan-lists (point) 1 0)))))
  2562. (when closing
  2563. (save-excursion
  2564. (let* ((begin (point))
  2565. (label (match-string-no-properties 1))
  2566. (inner-begin (match-end 0))
  2567. (inner-end (1- closing))
  2568. (type (if (match-end 2) 'inline 'standard))
  2569. (post-blank (progn (goto-char closing)
  2570. (skip-chars-forward " \t")))
  2571. (end (point)))
  2572. (list 'footnote-reference
  2573. (list :label label
  2574. :type type
  2575. :begin begin
  2576. :end end
  2577. :contents-begin (and (eq type 'inline) inner-begin)
  2578. :contents-end (and (eq type 'inline) inner-end)
  2579. :post-blank post-blank))))))))
  2580. (defun org-element-footnote-reference-interpreter (footnote-reference contents)
  2581. "Interpret FOOTNOTE-REFERENCE object as Org syntax.
  2582. CONTENTS is its definition, when inline, or nil."
  2583. (format "[fn:%s%s]"
  2584. (or (org-element-property :label footnote-reference) "")
  2585. (if contents (concat ":" contents) "")))
  2586. ;;;; Inline Babel Call
  2587. (defun org-element-inline-babel-call-parser ()
  2588. "Parse inline babel call at point, if any.
  2589. When at an inline babel call, return a list whose car is
  2590. `inline-babel-call' and cdr a plist with `:call',
  2591. `:inside-header', `:arguments', `:end-header', `:begin', `:end',
  2592. `:value' and `:post-blank' as keywords. Otherwise, return nil.
  2593. Assume point is at the beginning of the babel call."
  2594. (save-excursion
  2595. (catch :no-object
  2596. (when (let ((case-fold-search nil))
  2597. (looking-at "\\<call_\\([^ \t\n[(]+\\)[([]"))
  2598. (goto-char (match-end 1))
  2599. (let* ((begin (match-beginning 0))
  2600. (call (match-string-no-properties 1))
  2601. (inside-header
  2602. (let ((p (org-element--parse-paired-brackets ?\[)))
  2603. (and (org-string-nw-p p)
  2604. (replace-regexp-in-string "\n[ \t]*" " " (org-trim p)))))
  2605. (arguments (org-string-nw-p
  2606. (or (org-element--parse-paired-brackets ?\()
  2607. ;; Parenthesis are mandatory.
  2608. (throw :no-object nil))))
  2609. (end-header
  2610. (let ((p (org-element--parse-paired-brackets ?\[)))
  2611. (and (org-string-nw-p p)
  2612. (replace-regexp-in-string "\n[ \t]*" " " (org-trim p)))))
  2613. (value (buffer-substring-no-properties begin (point)))
  2614. (post-blank (skip-chars-forward " \t"))
  2615. (end (point)))
  2616. (list 'inline-babel-call
  2617. (list :call call
  2618. :inside-header inside-header
  2619. :arguments arguments
  2620. :end-header end-header
  2621. :begin begin
  2622. :end end
  2623. :value value
  2624. :post-blank post-blank)))))))
  2625. (defun org-element-inline-babel-call-interpreter (inline-babel-call _)
  2626. "Interpret INLINE-BABEL-CALL object as Org syntax."
  2627. (concat "call_"
  2628. (org-element-property :call inline-babel-call)
  2629. (let ((h (org-element-property :inside-header inline-babel-call)))
  2630. (and h (format "[%s]" h)))
  2631. "(" (org-element-property :arguments inline-babel-call) ")"
  2632. (let ((h (org-element-property :end-header inline-babel-call)))
  2633. (and h (format "[%s]" h)))))
  2634. ;;;; Inline Src Block
  2635. (defun org-element-inline-src-block-parser ()
  2636. "Parse inline source block at point, if any.
  2637. When at an inline source block, return a list whose car is
  2638. `inline-src-block' and cdr a plist with `:begin', `:end',
  2639. `:language', `:value', `:parameters' and `:post-blank' as
  2640. keywords. Otherwise, return nil.
  2641. Assume point is at the beginning of the inline source block."
  2642. (save-excursion
  2643. (catch :no-object
  2644. (when (let ((case-fold-search nil))
  2645. (looking-at "\\<src_\\([^ \t\n[{]+\\)[{[]"))
  2646. (goto-char (match-end 1))
  2647. (let ((begin (match-beginning 0))
  2648. (language (match-string-no-properties 1))
  2649. (parameters
  2650. (let ((p (org-element--parse-paired-brackets ?\[)))
  2651. (and (org-string-nw-p p)
  2652. (replace-regexp-in-string "\n[ \t]*" " " (org-trim p)))))
  2653. (value (or (org-element--parse-paired-brackets ?\{)
  2654. (throw :no-object nil)))
  2655. (post-blank (skip-chars-forward " \t")))
  2656. (list 'inline-src-block
  2657. (list :language language
  2658. :value value
  2659. :parameters parameters
  2660. :begin begin
  2661. :end (point)
  2662. :post-blank post-blank)))))))
  2663. (defun org-element-inline-src-block-interpreter (inline-src-block _)
  2664. "Interpret INLINE-SRC-BLOCK object as Org syntax."
  2665. (let ((language (org-element-property :language inline-src-block))
  2666. (arguments (org-element-property :parameters inline-src-block))
  2667. (body (org-element-property :value inline-src-block)))
  2668. (format "src_%s%s{%s}"
  2669. language
  2670. (if arguments (format "[%s]" arguments) "")
  2671. body)))
  2672. ;;;; Italic
  2673. (defun org-element-italic-parser ()
  2674. "Parse italic object at point, if any.
  2675. When at an italic object, return a list whose car is `italic' and
  2676. cdr is a plist with `:begin', `:end', `:contents-begin' and
  2677. `:contents-end' and `:post-blank' keywords. Otherwise, return
  2678. nil.
  2679. Assume point is at the first slash marker."
  2680. (save-excursion
  2681. (unless (bolp) (backward-char 1))
  2682. (when (looking-at org-emph-re)
  2683. (let ((begin (match-beginning 2))
  2684. (contents-begin (match-beginning 4))
  2685. (contents-end (match-end 4))
  2686. (post-blank (progn (goto-char (match-end 2))
  2687. (skip-chars-forward " \t")))
  2688. (end (point)))
  2689. (list 'italic
  2690. (list :begin begin
  2691. :end end
  2692. :contents-begin contents-begin
  2693. :contents-end contents-end
  2694. :post-blank post-blank))))))
  2695. (defun org-element-italic-interpreter (_ contents)
  2696. "Interpret italic object as Org syntax.
  2697. CONTENTS is the contents of the object."
  2698. (format "/%s/" contents))
  2699. ;;;; Latex Fragment
  2700. (defun org-element-latex-fragment-parser ()
  2701. "Parse LaTeX fragment at point, if any.
  2702. When at a LaTeX fragment, return a list whose car is
  2703. `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
  2704. and `:post-blank' as keywords. Otherwise, return nil.
  2705. Assume point is at the beginning of the LaTeX fragment."
  2706. (catch 'no-object
  2707. (save-excursion
  2708. (let* ((begin (point))
  2709. (after-fragment
  2710. (cond
  2711. ((not (eq ?$ (char-after)))
  2712. (pcase (char-after (1+ (point)))
  2713. (?\( (search-forward "\\)" nil t))
  2714. (?\[ (search-forward "\\]" nil t))
  2715. (_
  2716. ;; Macro.
  2717. (and (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\
  2718. \\|\\({[^{}\n]*}\\)\\)*")
  2719. (match-end 0)))))
  2720. ((eq ?$ (char-after (1+ (point))))
  2721. (search-forward "$$" nil t 2))
  2722. (t
  2723. (and (not (eq ?$ (char-before)))
  2724. (not (memq (char-after (1+ (point)))
  2725. '(?\s ?\t ?\n ?, ?. ?\;)))
  2726. (search-forward "$" nil t 2)
  2727. (not (memq (char-before (match-beginning 0))
  2728. '(?\s ?\t ?\n ?, ?.)))
  2729. (looking-at-p
  2730. "\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|'\\|$\\)")
  2731. (point)))))
  2732. (post-blank
  2733. (if (not after-fragment) (throw 'no-object nil)
  2734. (goto-char after-fragment)
  2735. (skip-chars-forward " \t")))
  2736. (end (point)))
  2737. (list 'latex-fragment
  2738. (list :value (buffer-substring-no-properties begin after-fragment)
  2739. :begin begin
  2740. :end end
  2741. :post-blank post-blank))))))
  2742. (defun org-element-latex-fragment-interpreter (latex-fragment _)
  2743. "Interpret LATEX-FRAGMENT object as Org syntax."
  2744. (org-element-property :value latex-fragment))
  2745. ;;;; Line Break
  2746. (defun org-element-line-break-parser ()
  2747. "Parse line break at point, if any.
  2748. When at a line break, return a list whose car is `line-break',
  2749. and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
  2750. Otherwise, return nil.
  2751. Assume point is at the beginning of the line break."
  2752. (when (and (looking-at-p "\\\\\\\\[ \t]*$")
  2753. (not (eq (char-before) ?\\)))
  2754. (list 'line-break
  2755. (list :begin (point)
  2756. :end (line-beginning-position 2)
  2757. :post-blank 0))))
  2758. (defun org-element-line-break-interpreter (&rest _)
  2759. "Interpret LINE-BREAK object as Org syntax."
  2760. "\\\\\n")
  2761. ;;;; Link
  2762. (defun org-element-link-parser ()
  2763. "Parse link at point, if any.
  2764. When at a link, return a list whose car is `link' and cdr a plist
  2765. with `:type', `:path', `:format', `:raw-link', `:application',
  2766. `:search-option', `:begin', `:end', `:contents-begin',
  2767. `:contents-end' and `:post-blank' as keywords. Otherwise, return
  2768. nil.
  2769. Assume point is at the beginning of the link."
  2770. (catch 'no-object
  2771. (let ((begin (point))
  2772. end contents-begin contents-end link-end post-blank path type format
  2773. raw-link search-option application)
  2774. (cond
  2775. ;; Type 1: Text targeted from a radio target.
  2776. ((and org-target-link-regexp
  2777. (save-excursion (or (bolp) (backward-char))
  2778. (looking-at org-target-link-regexp)))
  2779. (setq type "radio")
  2780. (setq format 'plain)
  2781. (setq link-end (match-end 1))
  2782. (setq path (match-string-no-properties 1))
  2783. (setq contents-begin (match-beginning 1))
  2784. (setq contents-end (match-end 1)))
  2785. ;; Type 2: Standard link, i.e. [[https://orgmode.org][homepage]]
  2786. ((looking-at org-link-bracket-re)
  2787. (setq format 'bracket)
  2788. (setq contents-begin (match-beginning 2))
  2789. (setq contents-end (match-end 2))
  2790. (setq link-end (match-end 0))
  2791. ;; RAW-LINK is the original link. Decode any encoding.
  2792. ;; Expand any abbreviation in it.
  2793. ;;
  2794. ;; Also treat any newline character and associated
  2795. ;; indentation as a single space character. This is not
  2796. ;; compatible with RFC 3986, which requires to ignore
  2797. ;; them altogether. However, doing so would require
  2798. ;; users to encode spaces on the fly when writing links
  2799. ;; (e.g., insert [[shell:ls%20*.org]] instead of
  2800. ;; [[shell:ls *.org]], which defeats Org's focus on
  2801. ;; simplicity.
  2802. (setq raw-link (org-link-expand-abbrev
  2803. (org-link-unescape
  2804. (replace-regexp-in-string
  2805. "[ \t]*\n[ \t]*" " "
  2806. (match-string-no-properties 1)))))
  2807. ;; Determine TYPE of link and set PATH accordingly. According
  2808. ;; to RFC 3986, remove whitespaces from URI in external links.
  2809. ;; In internal ones, treat indentation as a single space.
  2810. (cond
  2811. ;; File type.
  2812. ((or (file-name-absolute-p raw-link)
  2813. (string-match "\\`\\.\\.?/" raw-link))
  2814. (setq type "file")
  2815. (setq path raw-link))
  2816. ;; Explicit type (http, irc, bbdb...).
  2817. ((string-match org-link-types-re raw-link)
  2818. (setq type (match-string 1 raw-link))
  2819. (setq path (substring raw-link (match-end 0))))
  2820. ;; Code-ref type: PATH is the name of the reference.
  2821. ((and (string-match-p "\\`(" raw-link)
  2822. (string-match-p ")\\'" raw-link))
  2823. (setq type "coderef")
  2824. (setq path (substring raw-link 1 -1)))
  2825. ;; Custom-id type: PATH is the name of the custom id.
  2826. ((= (string-to-char raw-link) ?#)
  2827. (setq type "custom-id")
  2828. (setq path (substring raw-link 1)))
  2829. ;; Fuzzy type: Internal link either matches a target, an
  2830. ;; headline name or nothing. PATH is the target or
  2831. ;; headline's name.
  2832. (t
  2833. (setq type "fuzzy")
  2834. (setq path raw-link))))
  2835. ;; Type 3: Plain link, e.g., https://orgmode.org
  2836. ((looking-at org-link-plain-re)
  2837. (setq format 'plain)
  2838. (setq raw-link (match-string-no-properties 0))
  2839. (setq type (match-string-no-properties 1))
  2840. (setq link-end (match-end 0))
  2841. (setq path (match-string-no-properties 2)))
  2842. ;; Type 4: Angular link, e.g., <https://orgmode.org>. Unlike to
  2843. ;; bracket links, follow RFC 3986 and remove any extra
  2844. ;; whitespace in URI.
  2845. ((looking-at org-link-angle-re)
  2846. (setq format 'angle)
  2847. (setq type (match-string-no-properties 1))
  2848. (setq link-end (match-end 0))
  2849. (setq raw-link
  2850. (buffer-substring-no-properties
  2851. (match-beginning 1) (match-end 2)))
  2852. (setq path (replace-regexp-in-string
  2853. "[ \t]*\n[ \t]*" "" (match-string-no-properties 2))))
  2854. (t (throw 'no-object nil)))
  2855. ;; In any case, deduce end point after trailing white space from
  2856. ;; LINK-END variable.
  2857. (save-excursion
  2858. (setq post-blank
  2859. (progn (goto-char link-end) (skip-chars-forward " \t")))
  2860. (setq end (point)))
  2861. ;; Special "file"-type link processing. Extract opening
  2862. ;; application and search option, if any. Also normalize URI.
  2863. (when (string-match "\\`file\\(?:\\+\\(.+\\)\\)?\\'" type)
  2864. (setq application (match-string 1 type))
  2865. (setq type "file")
  2866. (when (string-match "::\\(.*\\)\\'" path)
  2867. (setq search-option (match-string 1 path))
  2868. (setq path (replace-match "" nil nil path)))
  2869. (setq path (replace-regexp-in-string "\\`///*\\(.:\\)?/" "\\1/" path)))
  2870. ;; Translate link, if `org-link-translation-function' is set.
  2871. (let ((trans (and (functionp org-link-translation-function)
  2872. (funcall org-link-translation-function type path))))
  2873. (when trans
  2874. (setq type (car trans))
  2875. (setq path (cdr trans))))
  2876. (list 'link
  2877. (list :type type
  2878. :path path
  2879. :format format
  2880. :raw-link (or raw-link path)
  2881. :application application
  2882. :search-option search-option
  2883. :begin begin
  2884. :end end
  2885. :contents-begin contents-begin
  2886. :contents-end contents-end
  2887. :post-blank post-blank)))))
  2888. (defun org-element-link-interpreter (link contents)
  2889. "Interpret LINK object as Org syntax.
  2890. CONTENTS is the contents of the object, or nil."
  2891. (let ((type (org-element-property :type link))
  2892. (path (org-element-property :path link)))
  2893. (if (string= type "radio") path
  2894. (let ((fmt (pcase (org-element-property :format link)
  2895. ;; Links with contents and internal links have to
  2896. ;; use bracket syntax. Ignore `:format' in these
  2897. ;; cases. This is also the default syntax when the
  2898. ;; property is not defined, e.g., when the object
  2899. ;; was crafted by the user.
  2900. ((guard contents)
  2901. (format "[[%%s][%s]]"
  2902. ;; Since this is going to be used as
  2903. ;; a format string, escape percent signs
  2904. ;; in description.
  2905. (replace-regexp-in-string "%" "%%" contents)))
  2906. ((or `bracket
  2907. `nil
  2908. (guard (member type '("coderef" "custom-id" "fuzzy"))))
  2909. "[[%s]]")
  2910. ;; Otherwise, just obey to `:format'.
  2911. (`angle "<%s>")
  2912. (`plain "%s")
  2913. (f (error "Wrong `:format' value: %s" f)))))
  2914. (format fmt
  2915. (pcase type
  2916. ("coderef" (format "(%s)" path))
  2917. ("custom-id" (concat "#" path))
  2918. ("file"
  2919. (let ((app (org-element-property :application link))
  2920. (opt (org-element-property :search-option link)))
  2921. (concat type (and app (concat "+" app)) ":"
  2922. path
  2923. (and opt (concat "::" opt)))))
  2924. ("fuzzy" path)
  2925. (_ (concat type ":" path))))))))
  2926. ;;;; Macro
  2927. (defun org-element-macro-parser ()
  2928. "Parse macro at point, if any.
  2929. When at a macro, return a list whose car is `macro' and cdr
  2930. a plist with `:key', `:args', `:begin', `:end', `:value' and
  2931. `:post-blank' as keywords. Otherwise, return nil.
  2932. Assume point is at the macro."
  2933. (save-excursion
  2934. (when (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\((\\([^\000]*?\\))\\)?}}}")
  2935. (let ((begin (point))
  2936. (key (downcase (match-string-no-properties 1)))
  2937. (value (match-string-no-properties 0))
  2938. (post-blank (progn (goto-char (match-end 0))
  2939. (skip-chars-forward " \t")))
  2940. (end (point))
  2941. (args (pcase (match-string-no-properties 3)
  2942. (`nil nil)
  2943. (a (org-macro-extract-arguments
  2944. (replace-regexp-in-string
  2945. "[ \t\r\n]+" " " (org-trim a)))))))
  2946. (list 'macro
  2947. (list :key key
  2948. :value value
  2949. :args args
  2950. :begin begin
  2951. :end end
  2952. :post-blank post-blank))))))
  2953. (defun org-element-macro-interpreter (macro _)
  2954. "Interpret MACRO object as Org syntax."
  2955. (format "{{{%s%s}}}"
  2956. (org-element-property :key macro)
  2957. (pcase (org-element-property :args macro)
  2958. (`nil "")
  2959. (args (format "(%s)" (apply #'org-macro-escape-arguments args))))))
  2960. ;;;; Radio-target
  2961. (defun org-element-radio-target-parser ()
  2962. "Parse radio target at point, if any.
  2963. When at a radio target, return a list whose car is `radio-target'
  2964. and cdr a plist with `:begin', `:end', `:contents-begin',
  2965. `:contents-end', `:value' and `:post-blank' as keywords.
  2966. Otherwise, return nil.
  2967. Assume point is at the radio target."
  2968. (save-excursion
  2969. (when (looking-at org-radio-target-regexp)
  2970. (let ((begin (point))
  2971. (contents-begin (match-beginning 1))
  2972. (contents-end (match-end 1))
  2973. (value (match-string-no-properties 1))
  2974. (post-blank (progn (goto-char (match-end 0))
  2975. (skip-chars-forward " \t")))
  2976. (end (point)))
  2977. (list 'radio-target
  2978. (list :begin begin
  2979. :end end
  2980. :contents-begin contents-begin
  2981. :contents-end contents-end
  2982. :post-blank post-blank
  2983. :value value))))))
  2984. (defun org-element-radio-target-interpreter (_ contents)
  2985. "Interpret target object as Org syntax.
  2986. CONTENTS is the contents of the object."
  2987. (concat "<<<" contents ">>>"))
  2988. ;;;; Statistics Cookie
  2989. (defun org-element-statistics-cookie-parser ()
  2990. "Parse statistics cookie at point, if any.
  2991. When at a statistics cookie, return a list whose car is
  2992. `statistics-cookie', and cdr a plist with `:begin', `:end',
  2993. `:value' and `:post-blank' keywords. Otherwise, return nil.
  2994. Assume point is at the beginning of the statistics-cookie."
  2995. (save-excursion
  2996. (when (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
  2997. (let* ((begin (point))
  2998. (value (buffer-substring-no-properties
  2999. (match-beginning 0) (match-end 0)))
  3000. (post-blank (progn (goto-char (match-end 0))
  3001. (skip-chars-forward " \t")))
  3002. (end (point)))
  3003. (list 'statistics-cookie
  3004. (list :begin begin
  3005. :end end
  3006. :value value
  3007. :post-blank post-blank))))))
  3008. (defun org-element-statistics-cookie-interpreter (statistics-cookie _)
  3009. "Interpret STATISTICS-COOKIE object as Org syntax."
  3010. (org-element-property :value statistics-cookie))
  3011. ;;;; Strike-Through
  3012. (defun org-element-strike-through-parser ()
  3013. "Parse strike-through object at point, if any.
  3014. When at a strike-through object, return a list whose car is
  3015. `strike-through' and cdr is a plist with `:begin', `:end',
  3016. `:contents-begin' and `:contents-end' and `:post-blank' keywords.
  3017. Otherwise, return nil.
  3018. Assume point is at the first plus sign marker."
  3019. (save-excursion
  3020. (unless (bolp) (backward-char 1))
  3021. (when (looking-at org-emph-re)
  3022. (let ((begin (match-beginning 2))
  3023. (contents-begin (match-beginning 4))
  3024. (contents-end (match-end 4))
  3025. (post-blank (progn (goto-char (match-end 2))
  3026. (skip-chars-forward " \t")))
  3027. (end (point)))
  3028. (list 'strike-through
  3029. (list :begin begin
  3030. :end end
  3031. :contents-begin contents-begin
  3032. :contents-end contents-end
  3033. :post-blank post-blank))))))
  3034. (defun org-element-strike-through-interpreter (_ contents)
  3035. "Interpret strike-through object as Org syntax.
  3036. CONTENTS is the contents of the object."
  3037. (format "+%s+" contents))
  3038. ;;;; Subscript
  3039. (defun org-element-subscript-parser ()
  3040. "Parse subscript at point, if any.
  3041. When at a subscript object, return a list whose car is
  3042. `subscript' and cdr a plist with `:begin', `:end',
  3043. `:contents-begin', `:contents-end', `:use-brackets-p' and
  3044. `:post-blank' as keywords. Otherwise, return nil.
  3045. Assume point is at the underscore."
  3046. (save-excursion
  3047. (unless (bolp) (backward-char))
  3048. (when (looking-at org-match-substring-regexp)
  3049. (let ((bracketsp (match-beginning 4))
  3050. (begin (match-beginning 2))
  3051. (contents-begin (or (match-beginning 4)
  3052. (match-beginning 3)))
  3053. (contents-end (or (match-end 4) (match-end 3)))
  3054. (post-blank (progn (goto-char (match-end 0))
  3055. (skip-chars-forward " \t")))
  3056. (end (point)))
  3057. (list 'subscript
  3058. (list :begin begin
  3059. :end end
  3060. :use-brackets-p bracketsp
  3061. :contents-begin contents-begin
  3062. :contents-end contents-end
  3063. :post-blank post-blank))))))
  3064. (defun org-element-subscript-interpreter (subscript contents)
  3065. "Interpret SUBSCRIPT object as Org syntax.
  3066. CONTENTS is the contents of the object."
  3067. (format
  3068. (if (org-element-property :use-brackets-p subscript) "_{%s}" "_%s")
  3069. contents))
  3070. ;;;; Superscript
  3071. (defun org-element-superscript-parser ()
  3072. "Parse superscript at point, if any.
  3073. When at a superscript object, return a list whose car is
  3074. `superscript' and cdr a plist with `:begin', `:end',
  3075. `:contents-begin', `:contents-end', `:use-brackets-p' and
  3076. `:post-blank' as keywords. Otherwise, return nil.
  3077. Assume point is at the caret."
  3078. (save-excursion
  3079. (unless (bolp) (backward-char))
  3080. (when (looking-at org-match-substring-regexp)
  3081. (let ((bracketsp (match-beginning 4))
  3082. (begin (match-beginning 2))
  3083. (contents-begin (or (match-beginning 4)
  3084. (match-beginning 3)))
  3085. (contents-end (or (match-end 4) (match-end 3)))
  3086. (post-blank (progn (goto-char (match-end 0))
  3087. (skip-chars-forward " \t")))
  3088. (end (point)))
  3089. (list 'superscript
  3090. (list :begin begin
  3091. :end end
  3092. :use-brackets-p bracketsp
  3093. :contents-begin contents-begin
  3094. :contents-end contents-end
  3095. :post-blank post-blank))))))
  3096. (defun org-element-superscript-interpreter (superscript contents)
  3097. "Interpret SUPERSCRIPT object as Org syntax.
  3098. CONTENTS is the contents of the object."
  3099. (format
  3100. (if (org-element-property :use-brackets-p superscript) "^{%s}" "^%s")
  3101. contents))
  3102. ;;;; Table Cell
  3103. (defun org-element-table-cell-parser ()
  3104. "Parse table cell at point.
  3105. Return a list whose car is `table-cell' and cdr is a plist
  3106. containing `:begin', `:end', `:contents-begin', `:contents-end'
  3107. and `:post-blank' keywords."
  3108. (looking-at "[ \t]*\\(.*?\\)[ \t]*\\(?:|\\|$\\)")
  3109. (let* ((begin (match-beginning 0))
  3110. (end (match-end 0))
  3111. (contents-begin (match-beginning 1))
  3112. (contents-end (match-end 1)))
  3113. (list 'table-cell
  3114. (list :begin begin
  3115. :end end
  3116. :contents-begin contents-begin
  3117. :contents-end contents-end
  3118. :post-blank 0))))
  3119. (defun org-element-table-cell-interpreter (_ contents)
  3120. "Interpret table-cell element as Org syntax.
  3121. CONTENTS is the contents of the cell, or nil."
  3122. (concat " " contents " |"))
  3123. ;;;; Target
  3124. (defun org-element-target-parser ()
  3125. "Parse target at point, if any.
  3126. When at a target, return a list whose car is `target' and cdr
  3127. a plist with `:begin', `:end', `:value' and `:post-blank' as
  3128. keywords. Otherwise, return nil.
  3129. Assume point is at the target."
  3130. (save-excursion
  3131. (when (looking-at org-target-regexp)
  3132. (let ((begin (point))
  3133. (value (match-string-no-properties 1))
  3134. (post-blank (progn (goto-char (match-end 0))
  3135. (skip-chars-forward " \t")))
  3136. (end (point)))
  3137. (list 'target
  3138. (list :begin begin
  3139. :end end
  3140. :value value
  3141. :post-blank post-blank))))))
  3142. (defun org-element-target-interpreter (target _)
  3143. "Interpret TARGET object as Org syntax."
  3144. (format "<<%s>>" (org-element-property :value target)))
  3145. ;;;; Timestamp
  3146. (defconst org-element--timestamp-regexp
  3147. (concat org-ts-regexp-both
  3148. "\\|"
  3149. "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
  3150. "\\|"
  3151. "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
  3152. "Regexp matching any timestamp type object.")
  3153. (defun org-element-timestamp-parser ()
  3154. "Parse time stamp at point, if any.
  3155. When at a time stamp, return a list whose car is `timestamp', and
  3156. cdr a plist with `:type', `:raw-value', `:year-start',
  3157. `:month-start', `:day-start', `:hour-start', `:minute-start',
  3158. `:year-end', `:month-end', `:day-end', `:hour-end',
  3159. `:minute-end', `:repeater-type', `:repeater-value',
  3160. `:repeater-unit', `:warning-type', `:warning-value',
  3161. `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
  3162. Otherwise, return nil.
  3163. Assume point is at the beginning of the timestamp."
  3164. (when (looking-at-p org-element--timestamp-regexp)
  3165. (save-excursion
  3166. (let* ((begin (point))
  3167. (activep (eq (char-after) ?<))
  3168. (raw-value
  3169. (progn
  3170. (looking-at "\\([<[]\\(%%\\)?.*?\\)[]>]\\(?:--\\([<[].*?[]>]\\)\\)?")
  3171. (match-string-no-properties 0)))
  3172. (date-start (match-string-no-properties 1))
  3173. (date-end (match-string 3))
  3174. (diaryp (match-beginning 2))
  3175. (post-blank (progn (goto-char (match-end 0))
  3176. (skip-chars-forward " \t")))
  3177. (end (point))
  3178. (time-range
  3179. (and (not diaryp)
  3180. (string-match
  3181. "[012]?[0-9]:[0-5][0-9]\\(-\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)"
  3182. date-start)
  3183. (cons (string-to-number (match-string 2 date-start))
  3184. (string-to-number (match-string 3 date-start)))))
  3185. (type (cond (diaryp 'diary)
  3186. ((and activep (or date-end time-range)) 'active-range)
  3187. (activep 'active)
  3188. ((or date-end time-range) 'inactive-range)
  3189. (t 'inactive)))
  3190. (repeater-props
  3191. (and (not diaryp)
  3192. (string-match "\\([.+]?\\+\\)\\([0-9]+\\)\\([hdwmy]\\)"
  3193. raw-value)
  3194. (list
  3195. :repeater-type
  3196. (let ((type (match-string 1 raw-value)))
  3197. (cond ((equal "++" type) 'catch-up)
  3198. ((equal ".+" type) 'restart)
  3199. (t 'cumulate)))
  3200. :repeater-value (string-to-number (match-string 2 raw-value))
  3201. :repeater-unit
  3202. (pcase (string-to-char (match-string 3 raw-value))
  3203. (?h 'hour) (?d 'day) (?w 'week) (?m 'month) (_ 'year)))))
  3204. (warning-props
  3205. (and (not diaryp)
  3206. (string-match "\\(-\\)?-\\([0-9]+\\)\\([hdwmy]\\)" raw-value)
  3207. (list
  3208. :warning-type (if (match-string 1 raw-value) 'first 'all)
  3209. :warning-value (string-to-number (match-string 2 raw-value))
  3210. :warning-unit
  3211. (pcase (string-to-char (match-string 3 raw-value))
  3212. (?h 'hour) (?d 'day) (?w 'week) (?m 'month) (_ 'year)))))
  3213. year-start month-start day-start hour-start minute-start year-end
  3214. month-end day-end hour-end minute-end)
  3215. ;; Parse date-start.
  3216. (unless diaryp
  3217. (let ((date (org-parse-time-string date-start t)))
  3218. (setq year-start (nth 5 date)
  3219. month-start (nth 4 date)
  3220. day-start (nth 3 date)
  3221. hour-start (nth 2 date)
  3222. minute-start (nth 1 date))))
  3223. ;; Compute date-end. It can be provided directly in time-stamp,
  3224. ;; or extracted from time range. Otherwise, it defaults to the
  3225. ;; same values as date-start.
  3226. (unless diaryp
  3227. (let ((date (and date-end (org-parse-time-string date-end t))))
  3228. (setq year-end (or (nth 5 date) year-start)
  3229. month-end (or (nth 4 date) month-start)
  3230. day-end (or (nth 3 date) day-start)
  3231. hour-end (or (nth 2 date) (car time-range) hour-start)
  3232. minute-end (or (nth 1 date) (cdr time-range) minute-start))))
  3233. (list 'timestamp
  3234. (nconc (list :type type
  3235. :raw-value raw-value
  3236. :year-start year-start
  3237. :month-start month-start
  3238. :day-start day-start
  3239. :hour-start hour-start
  3240. :minute-start minute-start
  3241. :year-end year-end
  3242. :month-end month-end
  3243. :day-end day-end
  3244. :hour-end hour-end
  3245. :minute-end minute-end
  3246. :begin begin
  3247. :end end
  3248. :post-blank post-blank)
  3249. repeater-props
  3250. warning-props))))))
  3251. (defun org-element-timestamp-interpreter (timestamp _)
  3252. "Interpret TIMESTAMP object as Org syntax."
  3253. (let* ((repeat-string
  3254. (concat
  3255. (pcase (org-element-property :repeater-type timestamp)
  3256. (`cumulate "+") (`catch-up "++") (`restart ".+"))
  3257. (let ((val (org-element-property :repeater-value timestamp)))
  3258. (and val (number-to-string val)))
  3259. (pcase (org-element-property :repeater-unit timestamp)
  3260. (`hour "h") (`day "d") (`week "w") (`month "m") (`year "y"))))
  3261. (warning-string
  3262. (concat
  3263. (pcase (org-element-property :warning-type timestamp)
  3264. (`first "--") (`all "-"))
  3265. (let ((val (org-element-property :warning-value timestamp)))
  3266. (and val (number-to-string val)))
  3267. (pcase (org-element-property :warning-unit timestamp)
  3268. (`hour "h") (`day "d") (`week "w") (`month "m") (`year "y"))))
  3269. (build-ts-string
  3270. ;; Build an Org timestamp string from TIME. ACTIVEP is
  3271. ;; non-nil when time stamp is active. If WITH-TIME-P is
  3272. ;; non-nil, add a time part. HOUR-END and MINUTE-END
  3273. ;; specify a time range in the timestamp. REPEAT-STRING is
  3274. ;; the repeater string, if any.
  3275. (lambda (time activep &optional with-time-p hour-end minute-end)
  3276. (let ((ts (format-time-string
  3277. (funcall (if with-time-p #'cdr #'car)
  3278. org-time-stamp-formats)
  3279. time)))
  3280. (when (and hour-end minute-end)
  3281. (string-match "[012]?[0-9]:[0-5][0-9]" ts)
  3282. (setq ts
  3283. (replace-match
  3284. (format "\\&-%02d:%02d" hour-end minute-end)
  3285. nil nil ts)))
  3286. (unless activep (setq ts (format "[%s]" (substring ts 1 -1))))
  3287. (dolist (s (list repeat-string warning-string))
  3288. (when (org-string-nw-p s)
  3289. (setq ts (concat (substring ts 0 -1)
  3290. " "
  3291. s
  3292. (substring ts -1)))))
  3293. ;; Return value.
  3294. ts)))
  3295. (type (org-element-property :type timestamp)))
  3296. (pcase type
  3297. ((or `active `inactive)
  3298. (let* ((minute-start (org-element-property :minute-start timestamp))
  3299. (minute-end (org-element-property :minute-end timestamp))
  3300. (hour-start (org-element-property :hour-start timestamp))
  3301. (hour-end (org-element-property :hour-end timestamp))
  3302. (time-range-p (and hour-start hour-end minute-start minute-end
  3303. (or (/= hour-start hour-end)
  3304. (/= minute-start minute-end)))))
  3305. (funcall
  3306. build-ts-string
  3307. (encode-time 0
  3308. (or minute-start 0)
  3309. (or hour-start 0)
  3310. (org-element-property :day-start timestamp)
  3311. (org-element-property :month-start timestamp)
  3312. (org-element-property :year-start timestamp))
  3313. (eq type 'active)
  3314. (and hour-start minute-start)
  3315. (and time-range-p hour-end)
  3316. (and time-range-p minute-end))))
  3317. ((or `active-range `inactive-range)
  3318. (let ((minute-start (org-element-property :minute-start timestamp))
  3319. (minute-end (org-element-property :minute-end timestamp))
  3320. (hour-start (org-element-property :hour-start timestamp))
  3321. (hour-end (org-element-property :hour-end timestamp)))
  3322. (concat
  3323. (funcall
  3324. build-ts-string (encode-time
  3325. 0
  3326. (or minute-start 0)
  3327. (or hour-start 0)
  3328. (org-element-property :day-start timestamp)
  3329. (org-element-property :month-start timestamp)
  3330. (org-element-property :year-start timestamp))
  3331. (eq type 'active-range)
  3332. (and hour-start minute-start))
  3333. "--"
  3334. (funcall build-ts-string
  3335. (encode-time 0
  3336. (or minute-end 0)
  3337. (or hour-end 0)
  3338. (org-element-property :day-end timestamp)
  3339. (org-element-property :month-end timestamp)
  3340. (org-element-property :year-end timestamp))
  3341. (eq type 'active-range)
  3342. (and hour-end minute-end)))))
  3343. (_ (org-element-property :raw-value timestamp)))))
  3344. ;;;; Underline
  3345. (defun org-element-underline-parser ()
  3346. "Parse underline object at point, if any.
  3347. When at an underline object, return a list whose car is
  3348. `underline' and cdr is a plist with `:begin', `:end',
  3349. `:contents-begin' and `:contents-end' and `:post-blank' keywords.
  3350. Otherwise, return nil.
  3351. Assume point is at the first underscore marker."
  3352. (save-excursion
  3353. (unless (bolp) (backward-char 1))
  3354. (when (looking-at org-emph-re)
  3355. (let ((begin (match-beginning 2))
  3356. (contents-begin (match-beginning 4))
  3357. (contents-end (match-end 4))
  3358. (post-blank (progn (goto-char (match-end 2))
  3359. (skip-chars-forward " \t")))
  3360. (end (point)))
  3361. (list 'underline
  3362. (list :begin begin
  3363. :end end
  3364. :contents-begin contents-begin
  3365. :contents-end contents-end
  3366. :post-blank post-blank))))))
  3367. (defun org-element-underline-interpreter (_ contents)
  3368. "Interpret underline object as Org syntax.
  3369. CONTENTS is the contents of the object."
  3370. (format "_%s_" contents))
  3371. ;;;; Verbatim
  3372. (defun org-element-verbatim-parser ()
  3373. "Parse verbatim object at point, if any.
  3374. When at a verbatim object, return a list whose car is `verbatim'
  3375. and cdr is a plist with `:value', `:begin', `:end' and
  3376. `:post-blank' keywords. Otherwise, return nil.
  3377. Assume point is at the first equal sign marker."
  3378. (save-excursion
  3379. (unless (bolp) (backward-char 1))
  3380. (when (looking-at org-verbatim-re)
  3381. (let ((begin (match-beginning 2))
  3382. (value (match-string-no-properties 4))
  3383. (post-blank (progn (goto-char (match-end 2))
  3384. (skip-chars-forward " \t")))
  3385. (end (point)))
  3386. (list 'verbatim
  3387. (list :value value
  3388. :begin begin
  3389. :end end
  3390. :post-blank post-blank))))))
  3391. (defun org-element-verbatim-interpreter (verbatim _)
  3392. "Interpret VERBATIM object as Org syntax."
  3393. (format "=%s=" (org-element-property :value verbatim)))
  3394. ;;; Parsing Element Starting At Point
  3395. ;;
  3396. ;; `org-element--current-element' is the core function of this section.
  3397. ;; It returns the Lisp representation of the element starting at
  3398. ;; point.
  3399. (defun org-element--current-element (limit &optional granularity mode structure)
  3400. "Parse the element starting at point.
  3401. Return value is a list like (TYPE PROPS) where TYPE is the type
  3402. of the element and PROPS a plist of properties associated to the
  3403. element.
  3404. Possible types are defined in `org-element-all-elements'.
  3405. LIMIT bounds the search.
  3406. Optional argument GRANULARITY determines the depth of the
  3407. recursion. Allowed values are `headline', `greater-element',
  3408. `element', `object' or nil. When it is broader than `object' (or
  3409. nil), secondary values will not be parsed, since they only
  3410. contain objects.
  3411. Optional argument MODE, when non-nil, can be either
  3412. `first-section', `item', `node-property', `planning',
  3413. `property-drawer', `section', `table-row', or `top-comment'.
  3414. If STRUCTURE isn't provided but MODE is set to `item', it will be
  3415. computed.
  3416. This function assumes point is always at the beginning of the
  3417. element it has to parse."
  3418. (save-excursion
  3419. (let ((case-fold-search t)
  3420. ;; Determine if parsing depth allows for secondary strings
  3421. ;; parsing. It only applies to elements referenced in
  3422. ;; `org-element-secondary-value-alist'.
  3423. (raw-secondary-p (and granularity (not (eq granularity 'object)))))
  3424. (cond
  3425. ;; Item.
  3426. ((eq mode 'item)
  3427. (org-element-item-parser limit structure raw-secondary-p))
  3428. ;; Table Row.
  3429. ((eq mode 'table-row) (org-element-table-row-parser limit))
  3430. ;; Node Property.
  3431. ((eq mode 'node-property) (org-element-node-property-parser limit))
  3432. ;; Headline.
  3433. ((org-with-limited-levels (org-at-heading-p))
  3434. (org-element-headline-parser limit raw-secondary-p))
  3435. ;; Sections (must be checked after headline).
  3436. ((eq mode 'section) (org-element-section-parser limit))
  3437. ((eq mode 'first-section)
  3438. (org-element-section-parser
  3439. (or (save-excursion (org-with-limited-levels (outline-next-heading)))
  3440. limit)))
  3441. ;; Comments.
  3442. ((looking-at "^[ \t]*#\\(?: \\|$\\)")
  3443. (org-element-comment-parser limit))
  3444. ;; Planning.
  3445. ((and (eq mode 'planning)
  3446. (eq ?* (char-after (line-beginning-position 0)))
  3447. (looking-at org-planning-line-re))
  3448. (org-element-planning-parser limit))
  3449. ;; Property drawer.
  3450. ((and (pcase mode
  3451. (`planning (eq ?* (char-after (line-beginning-position 0))))
  3452. ((or `property-drawer `top-comment)
  3453. (save-excursion
  3454. (beginning-of-line 0)
  3455. (not (looking-at "[[:blank:]]*$"))))
  3456. (_ nil))
  3457. (looking-at org-property-drawer-re))
  3458. (org-element-property-drawer-parser limit))
  3459. ;; When not at bol, point is at the beginning of an item or
  3460. ;; a footnote definition: next item is always a paragraph.
  3461. ((not (bolp)) (org-element-paragraph-parser limit (list (point))))
  3462. ;; Clock.
  3463. ((looking-at org-clock-line-re) (org-element-clock-parser limit))
  3464. ;; Inlinetask.
  3465. ((looking-at "^\\*+ ")
  3466. (org-element-inlinetask-parser limit raw-secondary-p))
  3467. ;; From there, elements can have affiliated keywords.
  3468. (t (let ((affiliated (org-element--collect-affiliated-keywords
  3469. limit (memq granularity '(nil object)))))
  3470. (cond
  3471. ;; Jumping over affiliated keywords put point off-limits.
  3472. ;; Parse them as regular keywords.
  3473. ((and (cdr affiliated) (>= (point) limit))
  3474. (goto-char (car affiliated))
  3475. (org-element-keyword-parser limit nil))
  3476. ;; LaTeX Environment.
  3477. ((looking-at org-element--latex-begin-environment)
  3478. (org-element-latex-environment-parser limit affiliated))
  3479. ;; Drawer.
  3480. ((looking-at org-drawer-regexp)
  3481. (org-element-drawer-parser limit affiliated))
  3482. ;; Fixed Width
  3483. ((looking-at "[ \t]*:\\( \\|$\\)")
  3484. (org-element-fixed-width-parser limit affiliated))
  3485. ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
  3486. ;; Keywords.
  3487. ((looking-at "[ \t]*#\\+")
  3488. (goto-char (match-end 0))
  3489. (cond
  3490. ((looking-at "BEGIN_\\(\\S-+\\)")
  3491. (beginning-of-line)
  3492. (funcall (pcase (upcase (match-string 1))
  3493. ("CENTER" #'org-element-center-block-parser)
  3494. ("COMMENT" #'org-element-comment-block-parser)
  3495. ("EXAMPLE" #'org-element-example-block-parser)
  3496. ("EXPORT" #'org-element-export-block-parser)
  3497. ("QUOTE" #'org-element-quote-block-parser)
  3498. ("SRC" #'org-element-src-block-parser)
  3499. ("VERSE" #'org-element-verse-block-parser)
  3500. (_ #'org-element-special-block-parser))
  3501. limit
  3502. affiliated))
  3503. ((looking-at "CALL:")
  3504. (beginning-of-line)
  3505. (org-element-babel-call-parser limit affiliated))
  3506. ((looking-at "BEGIN:? ")
  3507. (beginning-of-line)
  3508. (org-element-dynamic-block-parser limit affiliated))
  3509. ((looking-at "\\S-+:")
  3510. (beginning-of-line)
  3511. (org-element-keyword-parser limit affiliated))
  3512. (t
  3513. (beginning-of-line)
  3514. (org-element-paragraph-parser limit affiliated))))
  3515. ;; Footnote Definition.
  3516. ((looking-at org-footnote-definition-re)
  3517. (org-element-footnote-definition-parser limit affiliated))
  3518. ;; Horizontal Rule.
  3519. ((looking-at "[ \t]*-\\{5,\\}[ \t]*$")
  3520. (org-element-horizontal-rule-parser limit affiliated))
  3521. ;; Diary Sexp.
  3522. ((looking-at "%%(")
  3523. (org-element-diary-sexp-parser limit affiliated))
  3524. ;; Table.
  3525. ((or (looking-at "[ \t]*|")
  3526. ;; There is no strict definition of a table.el
  3527. ;; table. Try to prevent false positive while being
  3528. ;; quick.
  3529. (let ((rule-regexp
  3530. (rx (zero-or-more (any " \t"))
  3531. "+"
  3532. (one-or-more (one-or-more "-") "+")
  3533. (zero-or-more (any " \t"))
  3534. eol))
  3535. (non-table.el-line
  3536. (rx bol
  3537. (zero-or-more (any " \t"))
  3538. (or eol (not (any "+| \t")))))
  3539. (next (line-beginning-position 2)))
  3540. ;; Start with a full rule.
  3541. (and
  3542. (looking-at rule-regexp)
  3543. (< next limit) ;no room for a table.el table
  3544. (save-excursion
  3545. (end-of-line)
  3546. (cond
  3547. ;; Must end with a full rule.
  3548. ((not (re-search-forward non-table.el-line limit 'move))
  3549. (if (bolp) (forward-line -1) (beginning-of-line))
  3550. (looking-at rule-regexp))
  3551. ;; Ignore pseudo-tables with a single
  3552. ;; rule.
  3553. ((= next (line-beginning-position))
  3554. nil)
  3555. ;; Must end with a full rule.
  3556. (t
  3557. (forward-line -1)
  3558. (looking-at rule-regexp)))))))
  3559. (org-element-table-parser limit affiliated))
  3560. ;; List.
  3561. ((looking-at (org-item-re))
  3562. (org-element-plain-list-parser
  3563. limit affiliated
  3564. (or structure (org-element--list-struct limit))))
  3565. ;; Default element: Paragraph.
  3566. (t (org-element-paragraph-parser limit affiliated)))))))))
  3567. ;; Most elements can have affiliated keywords. When looking for an
  3568. ;; element beginning, we want to move before them, as they belong to
  3569. ;; that element, and, in the meantime, collect information they give
  3570. ;; into appropriate properties. Hence the following function.
  3571. (defun org-element--collect-affiliated-keywords (limit parse)
  3572. "Collect affiliated keywords from point down to LIMIT.
  3573. Return a list whose CAR is the position at the first of them and
  3574. CDR a plist of keywords and values and move point to the
  3575. beginning of the first line after them.
  3576. As a special case, if element doesn't start at the beginning of
  3577. the line (e.g., a paragraph starting an item), CAR is current
  3578. position of point and CDR is nil.
  3579. When PARSE is non-nil, values from keywords belonging to
  3580. `org-element-parsed-keywords' are parsed as secondary strings."
  3581. (if (not (bolp)) (list (point))
  3582. (let ((case-fold-search t)
  3583. (origin (point))
  3584. ;; RESTRICT is the list of objects allowed in parsed
  3585. ;; keywords value. If PARSE is nil, no object is allowed.
  3586. (restrict (and parse (org-element-restriction 'keyword)))
  3587. output)
  3588. (while (and (< (point) limit) (looking-at org-element--affiliated-re))
  3589. (let* ((raw-kwd (upcase (match-string 1)))
  3590. ;; Apply translation to RAW-KWD. From there, KWD is
  3591. ;; the official keyword.
  3592. (kwd (or (cdr (assoc raw-kwd
  3593. org-element-keyword-translation-alist))
  3594. raw-kwd))
  3595. ;; PARSED? is non-nil when keyword should have its
  3596. ;; value parsed.
  3597. (parsed? (member kwd org-element-parsed-keywords))
  3598. ;; Find main value for any keyword.
  3599. (value
  3600. (let ((beg (match-end 0))
  3601. (end (save-excursion
  3602. (end-of-line)
  3603. (skip-chars-backward " \t")
  3604. (point))))
  3605. (if parsed?
  3606. (save-match-data
  3607. (org-element--parse-objects beg end nil restrict))
  3608. (org-trim (buffer-substring-no-properties beg end)))))
  3609. ;; If KWD is a dual keyword, find its secondary value.
  3610. ;; Maybe parse it.
  3611. (dual? (member kwd org-element-dual-keywords))
  3612. (dual-value
  3613. (and dual?
  3614. (let ((sec (match-string-no-properties 2)))
  3615. (cond
  3616. ((and sec parsed?)
  3617. (save-match-data
  3618. (org-element--parse-objects
  3619. (match-beginning 2) (match-end 2) nil restrict)))
  3620. (sec sec)))))
  3621. ;; Attribute a property name to KWD.
  3622. (kwd-sym (and kwd (intern (concat ":" (downcase kwd))))))
  3623. ;; Now set final shape for VALUE.
  3624. (when dual?
  3625. (setq value (and (or value dual-value) (cons value dual-value))))
  3626. (when (or (member kwd org-element-multiple-keywords)
  3627. ;; Attributes can always appear on multiple lines.
  3628. (string-match "^ATTR_" kwd))
  3629. (setq value (cons value (plist-get output kwd-sym))))
  3630. ;; Eventually store the new value in OUTPUT.
  3631. (setq output (plist-put output kwd-sym value))
  3632. ;; Move to next keyword.
  3633. (forward-line)))
  3634. ;; If affiliated keywords are orphaned: move back to first one.
  3635. ;; They will be parsed as a paragraph.
  3636. (when (looking-at "[ \t]*$") (goto-char origin) (setq output nil))
  3637. ;; Return value.
  3638. (cons origin output))))
  3639. ;;; The Org Parser
  3640. ;;
  3641. ;; The two major functions here are `org-element-parse-buffer', which
  3642. ;; parses Org syntax inside the current buffer, taking into account
  3643. ;; region, narrowing, or even visibility if specified, and
  3644. ;; `org-element-parse-secondary-string', which parses objects within
  3645. ;; a given string.
  3646. ;;
  3647. ;; The (almost) almighty `org-element-map' allows applying a function
  3648. ;; on elements or objects matching some type, and accumulating the
  3649. ;; resulting values. In an export situation, it also skips unneeded
  3650. ;; parts of the parse tree.
  3651. (defun org-element-parse-buffer (&optional granularity visible-only)
  3652. "Recursively parse the buffer and return structure.
  3653. If narrowing is in effect, only parse the visible part of the
  3654. buffer.
  3655. Optional argument GRANULARITY determines the depth of the
  3656. recursion. It can be set to the following symbols:
  3657. `headline' Only parse headlines.
  3658. `greater-element' Don't recurse into greater elements except
  3659. headlines and sections. Thus, elements
  3660. parsed are the top-level ones.
  3661. `element' Parse everything but objects and plain text.
  3662. `object' Parse the complete buffer (default).
  3663. When VISIBLE-ONLY is non-nil, don't parse contents of hidden
  3664. elements.
  3665. An element or object is represented as a list with the
  3666. pattern (TYPE PROPERTIES CONTENTS), where :
  3667. TYPE is a symbol describing the element or object. See
  3668. `org-element-all-elements' and `org-element-all-objects' for an
  3669. exhaustive list of such symbols. One can retrieve it with
  3670. `org-element-type' function.
  3671. PROPERTIES is the list of attributes attached to the element or
  3672. object, as a plist. Although most of them are specific to the
  3673. element or object type, all types share `:begin', `:end',
  3674. `:post-blank' and `:parent' properties, which respectively
  3675. refer to buffer position where the element or object starts,
  3676. ends, the number of white spaces or blank lines after it, and
  3677. the element or object containing it. Properties values can be
  3678. obtained by using `org-element-property' function.
  3679. CONTENTS is a list of elements, objects or raw strings
  3680. contained in the current element or object, when applicable.
  3681. One can access them with `org-element-contents' function.
  3682. The Org buffer has `org-data' as type and nil as properties.
  3683. `org-element-map' function can be used to find specific elements
  3684. or objects within the parse tree.
  3685. This function assumes that current major mode is `org-mode'."
  3686. (save-excursion
  3687. (goto-char (point-min))
  3688. (org-skip-whitespace)
  3689. (org-element--parse-elements
  3690. (point-at-bol) (point-max)
  3691. ;; Start in `first-section' mode so text before the first
  3692. ;; headline belongs to a section.
  3693. 'first-section nil granularity visible-only (list 'org-data nil))))
  3694. (defun org-element-parse-secondary-string (string restriction &optional parent)
  3695. "Recursively parse objects in STRING and return structure.
  3696. RESTRICTION is a symbol limiting the object types that will be
  3697. looked after.
  3698. Optional argument PARENT, when non-nil, is the element or object
  3699. containing the secondary string. It is used to set correctly
  3700. `:parent' property within the string.
  3701. If STRING is the empty string or nil, return nil."
  3702. (cond
  3703. ((not string) nil)
  3704. ((equal string "") nil)
  3705. (t (let ((local-variables (buffer-local-variables)))
  3706. (with-temp-buffer
  3707. (dolist (v local-variables)
  3708. (ignore-errors
  3709. (if (symbolp v) (makunbound v)
  3710. ;; Don't set file name to avoid mishandling hooks (bug#44524)
  3711. (unless (memq (car v) '(buffer-file-name buffer-file-truename))
  3712. (set (make-local-variable (car v)) (cdr v))))))
  3713. ;; Transferring local variables may put the temporary buffer
  3714. ;; into a read-only state. Make sure we can insert STRING.
  3715. (let ((inhibit-read-only t)) (insert string))
  3716. ;; Prevent "Buffer *temp* modified; kill anyway?".
  3717. (restore-buffer-modified-p nil)
  3718. (org-element--parse-objects
  3719. (point-min) (point-max) nil restriction parent))))))
  3720. (defun org-element-map
  3721. (data types fun &optional info first-match no-recursion with-affiliated)
  3722. "Map a function on selected elements or objects.
  3723. DATA is a parse tree, an element, an object, a string, or a list
  3724. of such constructs. TYPES is a symbol or list of symbols of
  3725. elements or objects types (see `org-element-all-elements' and
  3726. `org-element-all-objects' for a complete list of types). FUN is
  3727. the function called on the matching element or object. It has to
  3728. accept one argument: the element or object itself.
  3729. When optional argument INFO is non-nil, it should be a plist
  3730. holding export options. In that case, parts of the parse tree
  3731. not exportable according to that property list will be skipped.
  3732. When optional argument FIRST-MATCH is non-nil, stop at the first
  3733. match for which FUN doesn't return nil, and return that value.
  3734. Optional argument NO-RECURSION is a symbol or a list of symbols
  3735. representing elements or objects types. `org-element-map' won't
  3736. enter any recursive element or object whose type belongs to that
  3737. list. Though, FUN can still be applied on them.
  3738. When optional argument WITH-AFFILIATED is non-nil, FUN will also
  3739. apply to matching objects within parsed affiliated keywords (see
  3740. `org-element-parsed-keywords').
  3741. Nil values returned from FUN do not appear in the results.
  3742. Examples:
  3743. ---------
  3744. Assuming TREE is a variable containing an Org buffer parse tree,
  3745. the following example will return a flat list of all `src-block'
  3746. and `example-block' elements in it:
  3747. (org-element-map tree \\='(example-block src-block) #\\='identity)
  3748. The following snippet will find the first headline with a level
  3749. of 1 and a \"phone\" tag, and will return its beginning position:
  3750. (org-element-map tree \\='headline
  3751. (lambda (hl)
  3752. (and (= (org-element-property :level hl) 1)
  3753. (member \"phone\" (org-element-property :tags hl))
  3754. (org-element-property :begin hl)))
  3755. nil t)
  3756. The next example will return a flat list of all `plain-list' type
  3757. elements in TREE that are not a sub-list themselves:
  3758. (org-element-map tree \\='plain-list #\\='identity nil nil \\='plain-list)
  3759. Eventually, this example will return a flat list of all `bold'
  3760. type objects containing a `latex-snippet' type object, even
  3761. looking into captions:
  3762. (org-element-map tree \\='bold
  3763. (lambda (b)
  3764. (and (org-element-map b \\='latex-snippet #\\='identity nil t) b))
  3765. nil nil nil t)"
  3766. (declare (indent 2))
  3767. ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
  3768. (let* ((types (if (listp types) types (list types)))
  3769. (no-recursion (if (listp no-recursion) no-recursion
  3770. (list no-recursion)))
  3771. ;; Recursion depth is determined by --CATEGORY.
  3772. (--category
  3773. (catch :--found
  3774. (let ((category 'greater-elements)
  3775. (all-objects (cons 'plain-text org-element-all-objects)))
  3776. (dolist (type types category)
  3777. (cond ((memq type all-objects)
  3778. ;; If one object is found, the function has
  3779. ;; to recurse into every object.
  3780. (throw :--found 'objects))
  3781. ((not (memq type org-element-greater-elements))
  3782. ;; If one regular element is found, the
  3783. ;; function has to recurse, at least, into
  3784. ;; every element it encounters.
  3785. (and (not (eq category 'elements))
  3786. (setq category 'elements))))))))
  3787. --acc)
  3788. (letrec ((--walk-tree
  3789. (lambda (--data)
  3790. ;; Recursively walk DATA. INFO, if non-nil, is a plist
  3791. ;; holding contextual information.
  3792. (let ((--type (org-element-type --data)))
  3793. (cond
  3794. ((not --data))
  3795. ;; Ignored element in an export context.
  3796. ((and info (memq --data (plist-get info :ignore-list))))
  3797. ;; List of elements or objects.
  3798. ((not --type) (mapc --walk-tree --data))
  3799. ;; Unconditionally enter parse trees.
  3800. ((eq --type 'org-data)
  3801. (mapc --walk-tree (org-element-contents --data)))
  3802. (t
  3803. ;; Check if TYPE is matching among TYPES. If so,
  3804. ;; apply FUN to --DATA and accumulate return value
  3805. ;; into --ACC (or exit if FIRST-MATCH is non-nil).
  3806. (when (memq --type types)
  3807. (let ((result (funcall fun --data)))
  3808. (cond ((not result))
  3809. (first-match (throw :--map-first-match result))
  3810. (t (push result --acc)))))
  3811. ;; If --DATA has a secondary string that can contain
  3812. ;; objects with their type among TYPES, look inside.
  3813. (when (and (eq --category 'objects) (not (stringp --data)))
  3814. (dolist (p (cdr (assq --type
  3815. org-element-secondary-value-alist)))
  3816. (funcall --walk-tree (org-element-property p --data))))
  3817. ;; If --DATA has any parsed affiliated keywords and
  3818. ;; WITH-AFFILIATED is non-nil, look for objects in
  3819. ;; them.
  3820. (when (and with-affiliated
  3821. (eq --category 'objects)
  3822. (eq (org-element-class --data) 'element))
  3823. (dolist (kwd-pair org-element--parsed-properties-alist)
  3824. (let ((kwd (car kwd-pair))
  3825. (value (org-element-property (cdr kwd-pair) --data)))
  3826. ;; Pay attention to the type of parsed
  3827. ;; keyword. In particular, preserve order for
  3828. ;; multiple keywords.
  3829. (cond
  3830. ((not value))
  3831. ((member kwd org-element-dual-keywords)
  3832. (if (member kwd org-element-multiple-keywords)
  3833. (dolist (line (reverse value))
  3834. (funcall --walk-tree (cdr line))
  3835. (funcall --walk-tree (car line)))
  3836. (funcall --walk-tree (cdr value))
  3837. (funcall --walk-tree (car value))))
  3838. ((member kwd org-element-multiple-keywords)
  3839. (mapc --walk-tree (reverse value)))
  3840. (t (funcall --walk-tree value))))))
  3841. ;; Determine if a recursion into --DATA is possible.
  3842. (cond
  3843. ;; --TYPE is explicitly removed from recursion.
  3844. ((memq --type no-recursion))
  3845. ;; --DATA has no contents.
  3846. ((not (org-element-contents --data)))
  3847. ;; Looking for greater elements but --DATA is
  3848. ;; simply an element or an object.
  3849. ((and (eq --category 'greater-elements)
  3850. (not (memq --type org-element-greater-elements))))
  3851. ;; Looking for elements but --DATA is an object.
  3852. ((and (eq --category 'elements)
  3853. (eq (org-element-class --data) 'object)))
  3854. ;; In any other case, map contents.
  3855. (t (mapc --walk-tree (org-element-contents --data))))))))))
  3856. (catch :--map-first-match
  3857. (funcall --walk-tree data)
  3858. ;; Return value in a proper order.
  3859. (nreverse --acc)))))
  3860. ;; The following functions are internal parts of the parser.
  3861. ;;
  3862. ;; The first one, `org-element--parse-elements' acts at the element's
  3863. ;; level.
  3864. ;;
  3865. ;; The second one, `org-element--parse-objects' applies on all objects
  3866. ;; of a paragraph or a secondary string. It calls
  3867. ;; `org-element--object-lex' to find the next object in the current
  3868. ;; container.
  3869. (defsubst org-element--next-mode (mode type parent?)
  3870. "Return next mode according to current one.
  3871. MODE is a symbol representing the expectation about the next
  3872. element or object. Meaningful values are `first-section',
  3873. `item', `node-property', `planning', `property-drawer',
  3874. `section', `table-row', `top-comment', and nil.
  3875. TYPE is the type of the current element or object.
  3876. If PARENT? is non-nil, assume the next element or object will be
  3877. located inside the current one. "
  3878. (if parent?
  3879. (pcase type
  3880. (`headline 'section)
  3881. ((and (guard (eq mode 'first-section)) `section) 'top-comment)
  3882. (`inlinetask 'planning)
  3883. (`plain-list 'item)
  3884. (`property-drawer 'node-property)
  3885. (`section 'planning)
  3886. (`table 'table-row))
  3887. (pcase mode
  3888. (`item 'item)
  3889. (`node-property 'node-property)
  3890. ((and `planning (guard (eq type 'planning))) 'property-drawer)
  3891. (`table-row 'table-row)
  3892. ((and `top-comment (guard (eq type 'comment))) 'property-drawer))))
  3893. (defun org-element--parse-elements
  3894. (beg end mode structure granularity visible-only acc)
  3895. "Parse elements between BEG and END positions.
  3896. MODE prioritizes some elements over the others. It can be set to
  3897. `first-section', `item', `node-property', `planning',
  3898. `property-drawer', `section', `table-row', `top-comment', or nil.
  3899. When value is `item', STRUCTURE will be used as the current list
  3900. structure.
  3901. GRANULARITY determines the depth of the recursion. See
  3902. `org-element-parse-buffer' for more information.
  3903. When VISIBLE-ONLY is non-nil, don't parse contents of hidden
  3904. elements.
  3905. Elements are accumulated into ACC."
  3906. (save-excursion
  3907. (goto-char beg)
  3908. ;; When parsing only headlines, skip any text before first one.
  3909. (when (and (eq granularity 'headline) (not (org-at-heading-p)))
  3910. (org-with-limited-levels (outline-next-heading)))
  3911. (let (elements)
  3912. (while (< (point) end)
  3913. ;; Visible only: skip invisible parts due to folding.
  3914. (if (and visible-only (org-invisible-p nil t))
  3915. (progn
  3916. (goto-char (org-find-visible))
  3917. (when (and (eolp) (not (eobp))) (forward-char)))
  3918. ;; Find current element's type and parse it accordingly to
  3919. ;; its category.
  3920. (let* ((element (org-element--current-element
  3921. end granularity mode structure))
  3922. (type (org-element-type element))
  3923. (cbeg (org-element-property :contents-begin element)))
  3924. (goto-char (org-element-property :end element))
  3925. ;; Fill ELEMENT contents by side-effect.
  3926. (cond
  3927. ;; If element has no contents, don't modify it.
  3928. ((not cbeg))
  3929. ;; Greater element: parse it between `contents-begin' and
  3930. ;; `contents-end'. Ensure GRANULARITY allows recursion,
  3931. ;; or ELEMENT is a headline, in which case going inside
  3932. ;; is mandatory, in order to get sub-level headings.
  3933. ((and (memq type org-element-greater-elements)
  3934. (or (memq granularity '(element object nil))
  3935. (and (eq granularity 'greater-element)
  3936. (eq type 'section))
  3937. (eq type 'headline)))
  3938. (org-element--parse-elements
  3939. cbeg (org-element-property :contents-end element)
  3940. ;; Possibly switch to a special mode.
  3941. (org-element--next-mode mode type t)
  3942. (and (memq type '(item plain-list))
  3943. (org-element-property :structure element))
  3944. granularity visible-only element))
  3945. ;; ELEMENT has contents. Parse objects inside, if
  3946. ;; GRANULARITY allows it.
  3947. ((memq granularity '(object nil))
  3948. (org-element--parse-objects
  3949. cbeg (org-element-property :contents-end element) element
  3950. (org-element-restriction type))))
  3951. (push (org-element-put-property element :parent acc) elements)
  3952. ;; Update mode.
  3953. (setq mode (org-element--next-mode mode type nil)))))
  3954. ;; Return result.
  3955. (apply #'org-element-set-contents acc (nreverse elements)))))
  3956. (defun org-element--object-lex (restriction)
  3957. "Return next object in current buffer or nil.
  3958. RESTRICTION is a list of object types, as symbols, that should be
  3959. looked after. This function assumes that the buffer is narrowed
  3960. to an appropriate container (e.g., a paragraph)."
  3961. (if (memq 'table-cell restriction) (org-element-table-cell-parser)
  3962. (let* ((start (point))
  3963. (limit
  3964. ;; Object regexp sometimes needs to have a peek at
  3965. ;; a character ahead. Therefore, when there is a hard
  3966. ;; limit, make it one more than the true beginning of the
  3967. ;; radio target.
  3968. (save-excursion
  3969. (cond ((not org-target-link-regexp) nil)
  3970. ((not (memq 'link restriction)) nil)
  3971. ((progn
  3972. (unless (bolp) (forward-char -1))
  3973. (not (re-search-forward org-target-link-regexp nil t)))
  3974. nil)
  3975. ;; Since we moved backward, we do not want to
  3976. ;; match again an hypothetical 1-character long
  3977. ;; radio link before us. Realizing that this can
  3978. ;; only happen if such a radio link starts at
  3979. ;; beginning of line, we prevent this here.
  3980. ((and (= start (1+ (line-beginning-position)))
  3981. (= start (match-end 1)))
  3982. (and (re-search-forward org-target-link-regexp nil t)
  3983. (1+ (match-beginning 1))))
  3984. (t (1+ (match-beginning 1))))))
  3985. found)
  3986. (save-excursion
  3987. (while (and (not found)
  3988. (re-search-forward org-element--object-regexp limit 'move))
  3989. (goto-char (match-beginning 0))
  3990. (let ((result (match-string 0)))
  3991. (setq found
  3992. (cond
  3993. ((string-prefix-p "call_" result t)
  3994. (and (memq 'inline-babel-call restriction)
  3995. (org-element-inline-babel-call-parser)))
  3996. ((string-prefix-p "src_" result t)
  3997. (and (memq 'inline-src-block restriction)
  3998. (org-element-inline-src-block-parser)))
  3999. (t
  4000. (pcase (char-after)
  4001. (?^ (and (memq 'superscript restriction)
  4002. (org-element-superscript-parser)))
  4003. (?_ (or (and (memq 'subscript restriction)
  4004. (org-element-subscript-parser))
  4005. (and (memq 'underline restriction)
  4006. (org-element-underline-parser))))
  4007. (?* (and (memq 'bold restriction)
  4008. (org-element-bold-parser)))
  4009. (?/ (and (memq 'italic restriction)
  4010. (org-element-italic-parser)))
  4011. (?~ (and (memq 'code restriction)
  4012. (org-element-code-parser)))
  4013. (?= (and (memq 'verbatim restriction)
  4014. (org-element-verbatim-parser)))
  4015. (?+ (and (memq 'strike-through restriction)
  4016. (org-element-strike-through-parser)))
  4017. (?@ (and (memq 'export-snippet restriction)
  4018. (org-element-export-snippet-parser)))
  4019. (?{ (and (memq 'macro restriction)
  4020. (org-element-macro-parser)))
  4021. (?$ (and (memq 'latex-fragment restriction)
  4022. (org-element-latex-fragment-parser)))
  4023. (?<
  4024. (if (eq (aref result 1) ?<)
  4025. (or (and (memq 'radio-target restriction)
  4026. (org-element-radio-target-parser))
  4027. (and (memq 'target restriction)
  4028. (org-element-target-parser)))
  4029. (or (and (memq 'timestamp restriction)
  4030. (org-element-timestamp-parser))
  4031. (and (memq 'link restriction)
  4032. (org-element-link-parser)))))
  4033. (?\\
  4034. (if (eq (aref result 1) ?\\)
  4035. (and (memq 'line-break restriction)
  4036. (org-element-line-break-parser))
  4037. (or (and (memq 'entity restriction)
  4038. (org-element-entity-parser))
  4039. (and (memq 'latex-fragment restriction)
  4040. (org-element-latex-fragment-parser)))))
  4041. (?\[
  4042. (pcase (aref result 1)
  4043. ((and ?\[
  4044. (guard (memq 'link restriction)))
  4045. (org-element-link-parser))
  4046. ((and ?f
  4047. (guard (memq 'footnote-reference restriction)))
  4048. (org-element-footnote-reference-parser))
  4049. ((and (or ?% ?/)
  4050. (guard (memq 'statistics-cookie restriction)))
  4051. (org-element-statistics-cookie-parser))
  4052. (_
  4053. (or (and (memq 'timestamp restriction)
  4054. (org-element-timestamp-parser))
  4055. (and (memq 'statistics-cookie restriction)
  4056. (org-element-statistics-cookie-parser))))))
  4057. ;; This is probably a plain link.
  4058. (_ (and (memq 'link restriction)
  4059. (org-element-link-parser)))))))
  4060. (or (eobp) (forward-char))))
  4061. (cond (found)
  4062. (limit (forward-char -1)
  4063. (org-element-link-parser)) ;radio link
  4064. (t nil))))))
  4065. (defun org-element--parse-objects (beg end acc restriction &optional parent)
  4066. "Parse objects between BEG and END and return recursive structure.
  4067. Objects are accumulated in ACC. RESTRICTION is a list of object
  4068. successors which are allowed in the current object.
  4069. ACC becomes the parent for all parsed objects. However, if ACC
  4070. is nil (i.e., a secondary string is being parsed) and optional
  4071. argument PARENT is non-nil, use it as the parent for all objects.
  4072. Eventually, if both ACC and PARENT are nil, the common parent is
  4073. the list of objects itself."
  4074. (save-excursion
  4075. (save-restriction
  4076. (narrow-to-region beg end)
  4077. (goto-char (point-min))
  4078. (let (next-object contents)
  4079. (while (and (not (eobp))
  4080. (setq next-object (org-element--object-lex restriction)))
  4081. ;; Text before any object.
  4082. (let ((obj-beg (org-element-property :begin next-object)))
  4083. (unless (= (point) obj-beg)
  4084. (let ((text (buffer-substring-no-properties (point) obj-beg)))
  4085. (push (if acc (org-element-put-property text :parent acc) text)
  4086. contents))))
  4087. ;; Object...
  4088. (let ((obj-end (org-element-property :end next-object))
  4089. (cont-beg (org-element-property :contents-begin next-object)))
  4090. (when acc (org-element-put-property next-object :parent acc))
  4091. (push (if cont-beg
  4092. ;; Fill contents of NEXT-OBJECT if possible.
  4093. (org-element--parse-objects
  4094. cont-beg
  4095. (org-element-property :contents-end next-object)
  4096. next-object
  4097. (org-element-restriction next-object))
  4098. next-object)
  4099. contents)
  4100. (goto-char obj-end)))
  4101. ;; Text after last object.
  4102. (unless (eobp)
  4103. (let ((text (buffer-substring-no-properties (point) end)))
  4104. (push (if acc (org-element-put-property text :parent acc) text)
  4105. contents)))
  4106. ;; Result. Set appropriate parent.
  4107. (if acc (apply #'org-element-set-contents acc (nreverse contents))
  4108. (let* ((contents (nreverse contents))
  4109. (parent (or parent contents)))
  4110. (dolist (datum contents contents)
  4111. (org-element-put-property datum :parent parent))))))))
  4112. ;;; Towards A Bijective Process
  4113. ;;
  4114. ;; The parse tree obtained with `org-element-parse-buffer' is really
  4115. ;; a snapshot of the corresponding Org buffer. Therefore, it can be
  4116. ;; interpreted and expanded into a string with canonical Org syntax.
  4117. ;; Hence `org-element-interpret-data'.
  4118. ;;
  4119. ;; The function relies internally on
  4120. ;; `org-element--interpret-affiliated-keywords'.
  4121. ;;;###autoload
  4122. (defun org-element-interpret-data (data)
  4123. "Interpret DATA as Org syntax.
  4124. DATA is a parse tree, an element, an object or a secondary string
  4125. to interpret. Return Org syntax as a string."
  4126. (letrec ((fun
  4127. (lambda (data parent)
  4128. (let* ((type (org-element-type data))
  4129. ;; Find interpreter for current object or
  4130. ;; element. If it doesn't exist (e.g. this is
  4131. ;; a pseudo object or element), return contents,
  4132. ;; if any.
  4133. (interpret
  4134. (let ((fun (intern
  4135. (format "org-element-%s-interpreter" type))))
  4136. (if (fboundp fun) fun (lambda (_ contents) contents))))
  4137. (results
  4138. (cond
  4139. ;; Secondary string.
  4140. ((not type)
  4141. (mapconcat (lambda (obj) (funcall fun obj parent))
  4142. data
  4143. ""))
  4144. ;; Full Org document.
  4145. ((eq type 'org-data)
  4146. (mapconcat (lambda (obj) (funcall fun obj parent))
  4147. (org-element-contents data)
  4148. ""))
  4149. ;; Plain text: return it.
  4150. ((stringp data) data)
  4151. ;; Element or object without contents.
  4152. ((not (org-element-contents data))
  4153. (funcall interpret data nil))
  4154. ;; Element or object with contents.
  4155. (t
  4156. (funcall
  4157. interpret
  4158. data
  4159. ;; Recursively interpret contents.
  4160. (mapconcat
  4161. (lambda (datum) (funcall fun datum data))
  4162. (org-element-contents
  4163. (if (not (memq type '(paragraph verse-block)))
  4164. data
  4165. ;; Fix indentation of elements containing
  4166. ;; objects. We ignore `table-row'
  4167. ;; elements as they are one line long
  4168. ;; anyway.
  4169. (org-element-normalize-contents
  4170. data
  4171. ;; When normalizing first paragraph of
  4172. ;; an item or a footnote-definition,
  4173. ;; ignore first line's indentation.
  4174. (and (eq type 'paragraph)
  4175. (memq (org-element-type parent)
  4176. '(footnote-definition item))
  4177. (eq data (car (org-element-contents parent)))
  4178. (eq (org-element-property :pre-blank parent)
  4179. 0)))))
  4180. ""))))))
  4181. (if (memq type '(org-data plain-text nil)) results
  4182. ;; Build white spaces. If no `:post-blank' property
  4183. ;; is specified, assume its value is 0.
  4184. (let ((blank (or (org-element-property :post-blank data) 0)))
  4185. (if (eq (org-element-class data parent) 'object)
  4186. (concat results (make-string blank ?\s))
  4187. (concat (org-element--interpret-affiliated-keywords data)
  4188. (org-element-normalize-string results)
  4189. (make-string blank ?\n)))))))))
  4190. (funcall fun data nil)))
  4191. (defun org-element--interpret-affiliated-keywords (element)
  4192. "Return ELEMENT's affiliated keywords as Org syntax.
  4193. If there is no affiliated keyword, return the empty string."
  4194. (let ((keyword-to-org
  4195. (lambda (key value)
  4196. (let (dual)
  4197. (when (member key org-element-dual-keywords)
  4198. (setq dual (cdr value) value (car value)))
  4199. (concat "#+" (downcase key)
  4200. (and dual
  4201. (format "[%s]" (org-element-interpret-data dual)))
  4202. ": "
  4203. (if (member key org-element-parsed-keywords)
  4204. (org-element-interpret-data value)
  4205. value)
  4206. "\n")))))
  4207. (mapconcat
  4208. (lambda (prop)
  4209. (let ((value (org-element-property prop element))
  4210. (keyword (upcase (substring (symbol-name prop) 1))))
  4211. (when value
  4212. (if (or (member keyword org-element-multiple-keywords)
  4213. ;; All attribute keywords can have multiple lines.
  4214. (string-match "^ATTR_" keyword))
  4215. (mapconcat (lambda (line) (funcall keyword-to-org keyword line))
  4216. (reverse value)
  4217. "")
  4218. (funcall keyword-to-org keyword value)))))
  4219. ;; List all ELEMENT's properties matching an attribute line or an
  4220. ;; affiliated keyword, but ignore translated keywords since they
  4221. ;; cannot belong to the property list.
  4222. (cl-loop for prop in (nth 1 element) by 'cddr
  4223. when (let ((keyword (upcase (substring (symbol-name prop) 1))))
  4224. (or (string-match "^ATTR_" keyword)
  4225. (and
  4226. (member keyword org-element-affiliated-keywords)
  4227. (not (assoc keyword
  4228. org-element-keyword-translation-alist)))))
  4229. collect prop)
  4230. "")))
  4231. ;; Because interpretation of the parse tree must return the same
  4232. ;; number of blank lines between elements and the same number of white
  4233. ;; space after objects, some special care must be given to white
  4234. ;; spaces.
  4235. ;;
  4236. ;; The first function, `org-element-normalize-string', ensures any
  4237. ;; string different from the empty string will end with a single
  4238. ;; newline character.
  4239. ;;
  4240. ;; The second function, `org-element-normalize-contents', removes
  4241. ;; global indentation from the contents of the current element.
  4242. (defun org-element-normalize-string (s)
  4243. "Ensure string S ends with a single newline character.
  4244. If S isn't a string return it unchanged. If S is the empty
  4245. string, return it. Otherwise, return a new string with a single
  4246. newline character at its end."
  4247. (cond
  4248. ((not (stringp s)) s)
  4249. ((string= "" s) "")
  4250. (t (and (string-match "\\(\n[ \t]*\\)*\\'" s)
  4251. (replace-match "\n" nil nil s)))))
  4252. (defun org-element-normalize-contents (element &optional ignore-first)
  4253. "Normalize plain text in ELEMENT's contents.
  4254. ELEMENT must only contain plain text and objects.
  4255. If optional argument IGNORE-FIRST is non-nil, ignore first line's
  4256. indentation to compute maximal common indentation.
  4257. Return the normalized element that is element with global
  4258. indentation removed from its contents."
  4259. (letrec ((find-min-ind
  4260. ;; Return minimal common indentation within BLOB. This is
  4261. ;; done by walking recursively BLOB and updating MIN-IND
  4262. ;; along the way. FIRST-FLAG is non-nil when the next
  4263. ;; object is expected to be a string that doesn't start
  4264. ;; with a newline character. It happens for strings at
  4265. ;; the beginnings of the contents or right after a line
  4266. ;; break.
  4267. (lambda (blob first-flag min-ind)
  4268. (dolist (datum (org-element-contents blob) min-ind)
  4269. (when first-flag
  4270. (setq first-flag nil)
  4271. (cond
  4272. ;; Objects cannot start with spaces: in this
  4273. ;; case, indentation is 0.
  4274. ((not (stringp datum)) (throw :zero 0))
  4275. ((not (string-match
  4276. "\\`\\([ \t]+\\)\\([^ \t\n]\\|\n\\|\\'\\)" datum))
  4277. (throw :zero 0))
  4278. ((equal (match-string 2 datum) "\n")
  4279. (put-text-property
  4280. (match-beginning 1) (match-end 1) 'org-ind 'empty datum))
  4281. (t
  4282. (let ((i (string-width (match-string 1 datum))))
  4283. (put-text-property
  4284. (match-beginning 1) (match-end 1) 'org-ind i datum)
  4285. (setq min-ind (min i min-ind))))))
  4286. (cond
  4287. ((stringp datum)
  4288. (let ((s 0))
  4289. (while (string-match
  4290. "\n\\([ \t]*\\)\\([^ \t\n]\\|\n\\|\\'\\)" datum s)
  4291. (setq s (match-end 1))
  4292. (cond
  4293. ((equal (match-string 1 datum) "")
  4294. (unless (member (match-string 2 datum) '("" "\n"))
  4295. (throw :zero 0)))
  4296. ((equal (match-string 2 datum) "\n")
  4297. (put-text-property (match-beginning 1) (match-end 1)
  4298. 'org-ind 'empty datum))
  4299. (t
  4300. (let ((i (string-width (match-string 1 datum))))
  4301. (put-text-property (match-beginning 1) (match-end 1)
  4302. 'org-ind i datum)
  4303. (setq min-ind (min i min-ind))))))))
  4304. ((eq (org-element-type datum) 'line-break)
  4305. (setq first-flag t))
  4306. ((memq (org-element-type datum) org-element-recursive-objects)
  4307. (setq min-ind
  4308. (funcall find-min-ind datum first-flag min-ind)))))))
  4309. (min-ind
  4310. (catch :zero
  4311. (funcall find-min-ind
  4312. element (not ignore-first) most-positive-fixnum))))
  4313. (if (or (zerop min-ind) (= min-ind most-positive-fixnum)) element
  4314. ;; Build ELEMENT back, replacing each string with the same
  4315. ;; string minus common indentation.
  4316. (letrec ((build
  4317. (lambda (datum)
  4318. ;; Return DATUM with all its strings indentation
  4319. ;; shortened from MIN-IND white spaces.
  4320. (setcdr
  4321. (cdr datum)
  4322. (mapcar
  4323. (lambda (object)
  4324. (cond
  4325. ((stringp object)
  4326. (with-temp-buffer
  4327. (insert object)
  4328. (let ((s (point-min)))
  4329. (while (setq s (text-property-not-all
  4330. s (point-max) 'org-ind nil))
  4331. (goto-char s)
  4332. (let ((i (get-text-property s 'org-ind)))
  4333. (delete-region s (progn
  4334. (skip-chars-forward " \t")
  4335. (point)))
  4336. (when (integerp i) (indent-to (- i min-ind))))))
  4337. (buffer-string)))
  4338. ((memq (org-element-type object)
  4339. org-element-recursive-objects)
  4340. (funcall build object))
  4341. (t object)))
  4342. (org-element-contents datum)))
  4343. datum)))
  4344. (funcall build element)))))
  4345. ;;; Cache
  4346. ;;
  4347. ;; Implement a caching mechanism for `org-element-at-point' and
  4348. ;; `org-element-context', which see.
  4349. ;;
  4350. ;; A single public function is provided: `org-element-cache-reset'.
  4351. ;;
  4352. ;; Cache is disabled by default for now because it sometimes triggers
  4353. ;; freezes, but it can be enabled globally with
  4354. ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
  4355. ;; `org-element-cache-sync-duration' and
  4356. ;; `org-element-cache-sync-break' can be tweaked to control caching
  4357. ;; behavior.
  4358. ;;
  4359. ;; Internally, parsed elements are stored in an AVL tree,
  4360. ;; `org-element--cache'. This tree is updated lazily: whenever
  4361. ;; a change happens to the buffer, a synchronization request is
  4362. ;; registered in `org-element--cache-sync-requests' (see
  4363. ;; `org-element--cache-submit-request'). During idle time, requests
  4364. ;; are processed by `org-element--cache-sync'. Synchronization also
  4365. ;; happens when an element is required from the cache. In this case,
  4366. ;; the process stops as soon as the needed element is up-to-date.
  4367. ;;
  4368. ;; A synchronization request can only apply on a synchronized part of
  4369. ;; the cache. Therefore, the cache is updated at least to the
  4370. ;; location where the new request applies. Thus, requests are ordered
  4371. ;; from left to right and all elements starting before the first
  4372. ;; request are correct. This property is used by functions like
  4373. ;; `org-element--cache-find' to retrieve elements in the part of the
  4374. ;; cache that can be trusted.
  4375. ;;
  4376. ;; A request applies to every element, starting from its original
  4377. ;; location (or key, see below). When a request is processed, it
  4378. ;; moves forward and may collide the next one. In this case, both
  4379. ;; requests are merged into a new one that starts from that element.
  4380. ;; As a consequence, the whole synchronization complexity does not
  4381. ;; depend on the number of pending requests, but on the number of
  4382. ;; elements the very first request will be applied on.
  4383. ;;
  4384. ;; Elements cannot be accessed through their beginning position, which
  4385. ;; may or may not be up-to-date. Instead, each element in the tree is
  4386. ;; associated to a key, obtained with `org-element--cache-key'. This
  4387. ;; mechanism is robust enough to preserve total order among elements
  4388. ;; even when the tree is only partially synchronized.
  4389. (defvar org-element-use-cache nil
  4390. "Non-nil when Org parser should cache its results.
  4391. WARNING: for the time being, using cache sometimes triggers
  4392. freezes. Therefore, it is disabled by default. Activate it if
  4393. you want to help debugging the issue.")
  4394. (defvar org-element-cache-sync-idle-time 0.6
  4395. "Length, in seconds, of idle time before syncing cache.")
  4396. (defvar org-element-cache-sync-duration 0.04
  4397. "Maximum duration, as a time value, for a cache synchronization.
  4398. If the synchronization is not over after this delay, the process
  4399. pauses and resumes after `org-element-cache-sync-break'
  4400. seconds.")
  4401. (defvar org-element-cache-sync-break 0.3
  4402. "Duration, as a time value, of the pause between synchronizations.
  4403. See `org-element-cache-sync-duration' for more information.")
  4404. ;;;; Data Structure
  4405. (defvar org-element--cache nil
  4406. "AVL tree used to cache elements.
  4407. Each node of the tree contains an element. Comparison is done
  4408. with `org-element--cache-compare'. This cache is used in
  4409. `org-element-at-point'.")
  4410. (defvar org-element--cache-sync-requests nil
  4411. "List of pending synchronization requests.
  4412. A request is a vector with the following pattern:
  4413. [NEXT BEG END OFFSET PARENT PHASE]
  4414. Processing a synchronization request consists of three phases:
  4415. 0. Delete modified elements,
  4416. 1. Fill missing area in cache,
  4417. 2. Shift positions and re-parent elements after the changes.
  4418. During phase 0, NEXT is the key of the first element to be
  4419. removed, BEG and END is buffer position delimiting the
  4420. modifications. Elements starting between them (inclusive) are
  4421. removed. So are elements whose parent is removed. PARENT, when
  4422. non-nil, is the parent of the first element to be removed.
  4423. During phase 1, NEXT is the key of the next known element in
  4424. cache and BEG its beginning position. Parse buffer between that
  4425. element and the one before it in order to determine the parent of
  4426. the next element. Set PARENT to the element containing NEXT.
  4427. During phase 2, NEXT is the key of the next element to shift in
  4428. the parse tree. All elements starting from this one have their
  4429. properties relatives to buffer positions shifted by integer
  4430. OFFSET and, if they belong to element PARENT, are adopted by it.
  4431. PHASE specifies the phase number, as an integer.")
  4432. (defvar org-element--cache-sync-timer nil
  4433. "Timer used for cache synchronization.")
  4434. (defvar org-element--cache-sync-keys nil
  4435. "Hash table used to store keys during synchronization.
  4436. See `org-element--cache-key' for more information.")
  4437. (defsubst org-element--cache-key (element)
  4438. "Return a unique key for ELEMENT in cache tree.
  4439. Keys are used to keep a total order among elements in the cache.
  4440. Comparison is done with `org-element--cache-key-less-p'.
  4441. When no synchronization is taking place, a key is simply the
  4442. beginning position of the element, or that position plus one in
  4443. the case of an first item (respectively row) in
  4444. a list (respectively a table).
  4445. During a synchronization, the key is the one the element had when
  4446. the cache was synchronized for the last time. Elements added to
  4447. cache during the synchronization get a new key generated with
  4448. `org-element--cache-generate-key'.
  4449. Such keys are stored in `org-element--cache-sync-keys'. The hash
  4450. table is cleared once the synchronization is complete."
  4451. (or (gethash element org-element--cache-sync-keys)
  4452. (let* ((begin (org-element-property :begin element))
  4453. ;; Increase beginning position of items (respectively
  4454. ;; table rows) by one, so the first item can get
  4455. ;; a different key from its parent list (respectively
  4456. ;; table).
  4457. (key (if (memq (org-element-type element) '(item table-row))
  4458. (1+ begin)
  4459. begin)))
  4460. (if org-element--cache-sync-requests
  4461. (puthash element key org-element--cache-sync-keys)
  4462. key))))
  4463. (defun org-element--cache-generate-key (lower upper)
  4464. "Generate a key between LOWER and UPPER.
  4465. LOWER and UPPER are fixnums or lists of same, possibly empty.
  4466. If LOWER and UPPER are equals, return LOWER. Otherwise, return
  4467. a unique key, as an integer or a list of integers, according to
  4468. the following rules:
  4469. - LOWER and UPPER are compared level-wise until values differ.
  4470. - If, at a given level, LOWER and UPPER differ from more than
  4471. 2, the new key shares all the levels above with LOWER and
  4472. gets a new level. Its value is the mean between LOWER and
  4473. UPPER:
  4474. (1 2) + (1 4) --> (1 3)
  4475. - If LOWER has no value to compare with, it is assumed that its
  4476. value is `most-negative-fixnum'. E.g.,
  4477. (1 1) + (1 1 2)
  4478. is equivalent to
  4479. (1 1 m) + (1 1 2)
  4480. where m is `most-negative-fixnum'. Likewise, if UPPER is
  4481. short of levels, the current value is `most-positive-fixnum'.
  4482. - If they differ from only one, the new key inherits from
  4483. current LOWER level and fork it at the next level. E.g.,
  4484. (2 1) + (3 3)
  4485. is equivalent to
  4486. (2 1) + (2 M)
  4487. where M is `most-positive-fixnum'.
  4488. - If the key is only one level long, it is returned as an
  4489. integer:
  4490. (1 2) + (3 2) --> 2
  4491. When they are not equals, the function assumes that LOWER is
  4492. lesser than UPPER, per `org-element--cache-key-less-p'."
  4493. (if (equal lower upper) lower
  4494. (let ((lower (if (integerp lower) (list lower) lower))
  4495. (upper (if (integerp upper) (list upper) upper))
  4496. skip-upper key)
  4497. (catch 'exit
  4498. (while t
  4499. (let ((min (or (car lower) most-negative-fixnum))
  4500. (max (cond (skip-upper most-positive-fixnum)
  4501. ((car upper))
  4502. (t most-positive-fixnum))))
  4503. (if (< (1+ min) max)
  4504. (let ((mean (+ (ash min -1) (ash max -1) (logand min max 1))))
  4505. (throw 'exit (if key (nreverse (cons mean key)) mean)))
  4506. (when (and (< min max) (not skip-upper))
  4507. ;; When at a given level, LOWER and UPPER differ from
  4508. ;; 1, ignore UPPER altogether. Instead create a key
  4509. ;; between LOWER and the greatest key with the same
  4510. ;; prefix as LOWER so far.
  4511. (setq skip-upper t))
  4512. (push min key)
  4513. (setq lower (cdr lower) upper (cdr upper)))))))))
  4514. (defsubst org-element--cache-key-less-p (a b)
  4515. "Non-nil if key A is less than key B.
  4516. A and B are either integers or lists of integers, as returned by
  4517. `org-element--cache-key'."
  4518. (if (integerp a) (if (integerp b) (< a b) (<= a (car b)))
  4519. (if (integerp b) (< (car a) b)
  4520. (catch 'exit
  4521. (while (and a b)
  4522. (cond ((car-less-than-car a b) (throw 'exit t))
  4523. ((car-less-than-car b a) (throw 'exit nil))
  4524. (t (setq a (cdr a) b (cdr b)))))
  4525. ;; If A is empty, either keys are equal (B is also empty) and
  4526. ;; we return nil, or A is lesser than B (B is longer) and we
  4527. ;; return a non-nil value.
  4528. ;;
  4529. ;; If A is not empty, B is necessarily empty and A is greater
  4530. ;; than B (A is longer). Therefore, return nil.
  4531. (and (null a) b)))))
  4532. (defun org-element--cache-compare (a b)
  4533. "Non-nil when element A is located before element B."
  4534. (org-element--cache-key-less-p (org-element--cache-key a)
  4535. (org-element--cache-key b)))
  4536. (defsubst org-element--cache-root ()
  4537. "Return root value in cache.
  4538. This function assumes `org-element--cache' is a valid AVL tree."
  4539. (avl-tree--node-left (avl-tree--dummyroot org-element--cache)))
  4540. ;;;; Tools
  4541. (defsubst org-element--cache-active-p ()
  4542. "Non-nil when cache is active in current buffer."
  4543. (and org-element-use-cache
  4544. org-element--cache
  4545. (derived-mode-p 'org-mode)))
  4546. (defun org-element--cache-find (pos &optional side)
  4547. "Find element in cache starting at POS or before.
  4548. POS refers to a buffer position.
  4549. When optional argument SIDE is non-nil, the function checks for
  4550. elements starting at or past POS instead. If SIDE is `both', the
  4551. function returns a cons cell where car is the first element
  4552. starting at or before POS and cdr the first element starting
  4553. after POS.
  4554. The function can only find elements in the synchronized part of
  4555. the cache."
  4556. (let ((limit (and org-element--cache-sync-requests
  4557. (aref (car org-element--cache-sync-requests) 0)))
  4558. (node (org-element--cache-root))
  4559. lower upper)
  4560. (while node
  4561. (let* ((element (avl-tree--node-data node))
  4562. (begin (org-element-property :begin element)))
  4563. (cond
  4564. ((and limit
  4565. (not (org-element--cache-key-less-p
  4566. (org-element--cache-key element) limit)))
  4567. (setq node (avl-tree--node-left node)))
  4568. ((> begin pos)
  4569. (setq upper element
  4570. node (avl-tree--node-left node)))
  4571. ((< begin pos)
  4572. (setq lower element
  4573. node (avl-tree--node-right node)))
  4574. ;; We found an element in cache starting at POS. If `side'
  4575. ;; is `both' we also want the next one in order to generate
  4576. ;; a key in-between.
  4577. ;;
  4578. ;; If the element is the first row or item in a table or
  4579. ;; a plain list, we always return the table or the plain
  4580. ;; list.
  4581. ;;
  4582. ;; In any other case, we return the element found.
  4583. ((eq side 'both)
  4584. (setq lower element)
  4585. (setq node (avl-tree--node-right node)))
  4586. ((and (memq (org-element-type element) '(item table-row))
  4587. (let ((parent (org-element-property :parent element)))
  4588. (and (= (org-element-property :begin element)
  4589. (org-element-property :contents-begin parent))
  4590. (setq node nil
  4591. lower parent
  4592. upper parent)))))
  4593. (t
  4594. (setq node nil
  4595. lower element
  4596. upper element)))))
  4597. (pcase side
  4598. (`both (cons lower upper))
  4599. (`nil lower)
  4600. (_ upper))))
  4601. (defun org-element--cache-put (element)
  4602. "Store ELEMENT in current buffer's cache, if allowed."
  4603. (when (org-element--cache-active-p)
  4604. (when org-element--cache-sync-requests
  4605. ;; During synchronization, first build an appropriate key for
  4606. ;; the new element so `avl-tree-enter' can insert it at the
  4607. ;; right spot in the cache.
  4608. (let ((keys (org-element--cache-find
  4609. (org-element-property :begin element) 'both)))
  4610. (puthash element
  4611. (org-element--cache-generate-key
  4612. (and (car keys) (org-element--cache-key (car keys)))
  4613. (cond ((cdr keys) (org-element--cache-key (cdr keys)))
  4614. (org-element--cache-sync-requests
  4615. (aref (car org-element--cache-sync-requests) 0))))
  4616. org-element--cache-sync-keys)))
  4617. (avl-tree-enter org-element--cache element)))
  4618. (defsubst org-element--cache-remove (element)
  4619. "Remove ELEMENT from cache.
  4620. Assume ELEMENT belongs to cache and that a cache is active."
  4621. (avl-tree-delete org-element--cache element))
  4622. ;;;; Synchronization
  4623. (defsubst org-element--cache-set-timer (buffer)
  4624. "Set idle timer for cache synchronization in BUFFER."
  4625. (when org-element--cache-sync-timer
  4626. (cancel-timer org-element--cache-sync-timer))
  4627. (setq org-element--cache-sync-timer
  4628. (run-with-idle-timer
  4629. (let ((idle (current-idle-time)))
  4630. (if idle (org-time-add idle org-element-cache-sync-break)
  4631. org-element-cache-sync-idle-time))
  4632. nil
  4633. #'org-element--cache-sync
  4634. buffer)))
  4635. (defsubst org-element--cache-interrupt-p (time-limit)
  4636. "Non-nil when synchronization process should be interrupted.
  4637. TIME-LIMIT is a time value or nil."
  4638. (and time-limit
  4639. (or (input-pending-p)
  4640. (org-time-less-p time-limit nil))))
  4641. (defsubst org-element--cache-shift-positions (element offset &optional props)
  4642. "Shift ELEMENT properties relative to buffer positions by OFFSET.
  4643. Properties containing buffer positions are `:begin', `:end',
  4644. `:contents-begin', `:contents-end' and `:structure'. When
  4645. optional argument PROPS is a list of keywords, only shift
  4646. properties provided in that list.
  4647. Properties are modified by side-effect."
  4648. (let ((properties (nth 1 element)))
  4649. ;; Shift `:structure' property for the first plain list only: it
  4650. ;; is the only one that really matters and it prevents from
  4651. ;; shifting it more than once.
  4652. (when (and (or (not props) (memq :structure props))
  4653. (eq (org-element-type element) 'plain-list)
  4654. (not (eq (org-element-type (plist-get properties :parent))
  4655. 'item)))
  4656. (dolist (item (plist-get properties :structure))
  4657. (cl-incf (car item) offset)
  4658. (cl-incf (nth 6 item) offset)))
  4659. (dolist (key '(:begin :contents-begin :contents-end :end :post-affiliated))
  4660. (let ((value (and (or (not props) (memq key props))
  4661. (plist-get properties key))))
  4662. (and value (plist-put properties key (+ offset value)))))))
  4663. (defun org-element--cache-sync (buffer &optional threshold future-change)
  4664. "Synchronize cache with recent modification in BUFFER.
  4665. When optional argument THRESHOLD is non-nil, do the
  4666. synchronization for all elements starting before or at threshold,
  4667. then exit. Otherwise, synchronize cache for as long as
  4668. `org-element-cache-sync-duration' or until Emacs leaves idle
  4669. state.
  4670. FUTURE-CHANGE, when non-nil, is a buffer position where changes
  4671. not registered yet in the cache are going to happen. It is used
  4672. in `org-element--cache-submit-request', where cache is partially
  4673. updated before current modification are actually submitted."
  4674. (when (buffer-live-p buffer)
  4675. (with-current-buffer buffer
  4676. (let ((inhibit-quit t) request next)
  4677. (when org-element--cache-sync-timer
  4678. (cancel-timer org-element--cache-sync-timer))
  4679. (catch 'interrupt
  4680. (while org-element--cache-sync-requests
  4681. (setq request (car org-element--cache-sync-requests)
  4682. next (nth 1 org-element--cache-sync-requests))
  4683. (org-element--cache-process-request
  4684. request
  4685. (and next (aref next 0))
  4686. threshold
  4687. (and (not threshold)
  4688. (org-time-add nil
  4689. org-element-cache-sync-duration))
  4690. future-change)
  4691. ;; Request processed. Merge current and next offsets and
  4692. ;; transfer ending position.
  4693. (when next
  4694. (cl-incf (aref next 3) (aref request 3))
  4695. (aset next 2 (aref request 2)))
  4696. (setq org-element--cache-sync-requests
  4697. (cdr org-element--cache-sync-requests))))
  4698. ;; If more requests are awaiting, set idle timer accordingly.
  4699. ;; Otherwise, reset keys.
  4700. (if org-element--cache-sync-requests
  4701. (org-element--cache-set-timer buffer)
  4702. (clrhash org-element--cache-sync-keys))))))
  4703. (defun org-element--cache-process-request
  4704. (request next threshold time-limit future-change)
  4705. "Process synchronization REQUEST for all entries before NEXT.
  4706. REQUEST is a vector, built by `org-element--cache-submit-request'.
  4707. NEXT is a cache key, as returned by `org-element--cache-key'.
  4708. When non-nil, THRESHOLD is a buffer position. Synchronization
  4709. stops as soon as a shifted element begins after it.
  4710. When non-nil, TIME-LIMIT is a time value. Synchronization stops
  4711. after this time or when Emacs exits idle state.
  4712. When non-nil, FUTURE-CHANGE is a buffer position where changes
  4713. not registered yet in the cache are going to happen. See
  4714. `org-element--cache-submit-request' for more information.
  4715. Throw `interrupt' if the process stops before completing the
  4716. request."
  4717. (catch 'quit
  4718. (when (= (aref request 5) 0)
  4719. ;; Phase 0.
  4720. ;;
  4721. ;; Delete all elements starting after BEG, but not after buffer
  4722. ;; position END or past element with key NEXT. Also delete
  4723. ;; elements contained within a previously removed element
  4724. ;; (stored in `last-container').
  4725. ;;
  4726. ;; At each iteration, we start again at tree root since
  4727. ;; a deletion modifies structure of the balanced tree.
  4728. (catch 'end-phase
  4729. (while t
  4730. (when (org-element--cache-interrupt-p time-limit)
  4731. (throw 'interrupt nil))
  4732. ;; Find first element in cache with key BEG or after it.
  4733. (let ((beg (aref request 0))
  4734. (end (aref request 2))
  4735. (node (org-element--cache-root))
  4736. data data-key last-container)
  4737. (while node
  4738. (let* ((element (avl-tree--node-data node))
  4739. (key (org-element--cache-key element)))
  4740. (cond
  4741. ((org-element--cache-key-less-p key beg)
  4742. (setq node (avl-tree--node-right node)))
  4743. ((org-element--cache-key-less-p beg key)
  4744. (setq data element
  4745. data-key key
  4746. node (avl-tree--node-left node)))
  4747. (t (setq data element
  4748. data-key key
  4749. node nil)))))
  4750. (if data
  4751. (let ((pos (org-element-property :begin data)))
  4752. (if (if (or (not next)
  4753. (org-element--cache-key-less-p data-key next))
  4754. (<= pos end)
  4755. (and last-container
  4756. (let ((up data))
  4757. (while (and up (not (eq up last-container)))
  4758. (setq up (org-element-property :parent up)))
  4759. up)))
  4760. (progn (when (and (not last-container)
  4761. (> (org-element-property :end data)
  4762. end))
  4763. (setq last-container data))
  4764. (org-element--cache-remove data))
  4765. (aset request 0 data-key)
  4766. (aset request 1 pos)
  4767. (aset request 5 1)
  4768. (throw 'end-phase nil)))
  4769. ;; No element starting after modifications left in
  4770. ;; cache: further processing is futile.
  4771. (throw 'quit t))))))
  4772. (when (= (aref request 5) 1)
  4773. ;; Phase 1.
  4774. ;;
  4775. ;; Phase 0 left a hole in the cache. Some elements after it
  4776. ;; could have parents within. For example, in the following
  4777. ;; buffer:
  4778. ;;
  4779. ;; - item
  4780. ;;
  4781. ;;
  4782. ;; Paragraph1
  4783. ;;
  4784. ;; Paragraph2
  4785. ;;
  4786. ;; if we remove a blank line between "item" and "Paragraph1",
  4787. ;; everything down to "Paragraph2" is removed from cache. But
  4788. ;; the paragraph now belongs to the list, and its `:parent'
  4789. ;; property no longer is accurate.
  4790. ;;
  4791. ;; Therefore we need to parse again elements in the hole, or at
  4792. ;; least in its last section, so that we can re-parent
  4793. ;; subsequent elements, during phase 2.
  4794. ;;
  4795. ;; Note that we only need to get the parent from the first
  4796. ;; element in cache after the hole.
  4797. ;;
  4798. ;; When next key is lesser or equal to the current one, delegate
  4799. ;; phase 1 processing to next request in order to preserve key
  4800. ;; order among requests.
  4801. (let ((key (aref request 0)))
  4802. (when (and next (not (org-element--cache-key-less-p key next)))
  4803. (let ((next-request (nth 1 org-element--cache-sync-requests)))
  4804. (aset next-request 0 key)
  4805. (aset next-request 1 (aref request 1))
  4806. (aset next-request 5 1))
  4807. (throw 'quit t)))
  4808. ;; Next element will start at its beginning position plus
  4809. ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
  4810. ;; contains the real beginning position of the first element to
  4811. ;; shift and re-parent.
  4812. (let ((limit (+ (aref request 1) (aref request 3))))
  4813. (cond ((and threshold (> limit threshold)) (throw 'interrupt nil))
  4814. ((and future-change (>= limit future-change))
  4815. ;; Changes are going to happen around this element and
  4816. ;; they will trigger another phase 1 request. Skip the
  4817. ;; current one.
  4818. (aset request 5 2))
  4819. (t
  4820. (let ((parent (org-element--parse-to limit t time-limit)))
  4821. (aset request 4 parent)
  4822. (aset request 5 2))))))
  4823. ;; Phase 2.
  4824. ;;
  4825. ;; Shift all elements starting from key START, but before NEXT, by
  4826. ;; OFFSET, and re-parent them when appropriate.
  4827. ;;
  4828. ;; Elements are modified by side-effect so the tree structure
  4829. ;; remains intact.
  4830. ;;
  4831. ;; Once THRESHOLD, if any, is reached, or once there is an input
  4832. ;; pending, exit. Before leaving, the current synchronization
  4833. ;; request is updated.
  4834. (let ((start (aref request 0))
  4835. (offset (aref request 3))
  4836. (parent (aref request 4))
  4837. (node (org-element--cache-root))
  4838. (stack (list nil))
  4839. (leftp t)
  4840. exit-flag)
  4841. ;; No re-parenting nor shifting planned: request is over.
  4842. (when (and (not parent) (zerop offset)) (throw 'quit t))
  4843. (while node
  4844. (let* ((data (avl-tree--node-data node))
  4845. (key (org-element--cache-key data)))
  4846. (if (and leftp (avl-tree--node-left node)
  4847. (not (org-element--cache-key-less-p key start)))
  4848. (progn (push node stack)
  4849. (setq node (avl-tree--node-left node)))
  4850. (unless (org-element--cache-key-less-p key start)
  4851. ;; We reached NEXT. Request is complete.
  4852. (when (equal key next) (throw 'quit t))
  4853. ;; Handle interruption request. Update current request.
  4854. (when (or exit-flag (org-element--cache-interrupt-p time-limit))
  4855. (aset request 0 key)
  4856. (aset request 4 parent)
  4857. (throw 'interrupt nil))
  4858. ;; Shift element.
  4859. (unless (zerop offset)
  4860. (org-element--cache-shift-positions data offset))
  4861. (let ((begin (org-element-property :begin data)))
  4862. ;; Update PARENT and re-parent DATA, only when
  4863. ;; necessary. Propagate new structures for lists.
  4864. (while (and parent
  4865. (<= (org-element-property :end parent) begin))
  4866. (setq parent (org-element-property :parent parent)))
  4867. (cond ((and (not parent) (zerop offset)) (throw 'quit nil))
  4868. ((and parent
  4869. (let ((p (org-element-property :parent data)))
  4870. (or (not p)
  4871. (< (org-element-property :begin p)
  4872. (org-element-property :begin parent)))))
  4873. (org-element-put-property data :parent parent)
  4874. (let ((s (org-element-property :structure parent)))
  4875. (when (and s (org-element-property :structure data))
  4876. (org-element-put-property data :structure s)))))
  4877. ;; Cache is up-to-date past THRESHOLD. Request
  4878. ;; interruption.
  4879. (when (and threshold (> begin threshold)) (setq exit-flag t))))
  4880. (setq node (if (setq leftp (avl-tree--node-right node))
  4881. (avl-tree--node-right node)
  4882. (pop stack))))))
  4883. ;; We reached end of tree: synchronization complete.
  4884. t)))
  4885. (defun org-element--parse-to (pos &optional syncp time-limit)
  4886. "Parse elements in current section, down to POS.
  4887. Start parsing from the closest between the last known element in
  4888. cache or headline above. Return the smallest element containing
  4889. POS.
  4890. When optional argument SYNCP is non-nil, return the parent of the
  4891. element containing POS instead. In that case, it is also
  4892. possible to provide TIME-LIMIT, which is a time value specifying
  4893. when the parsing should stop. The function throws `interrupt' if
  4894. the process stopped before finding the expected result."
  4895. (catch 'exit
  4896. (org-with-wide-buffer
  4897. (goto-char pos)
  4898. (let* ((cached (and (org-element--cache-active-p)
  4899. (org-element--cache-find pos nil)))
  4900. (begin (org-element-property :begin cached))
  4901. element next mode)
  4902. (cond
  4903. ;; Nothing in cache before point: start parsing from first
  4904. ;; element following headline above, or first element in
  4905. ;; buffer.
  4906. ((not cached)
  4907. (if (org-with-limited-levels (outline-previous-heading))
  4908. (progn
  4909. (setq mode 'planning)
  4910. (forward-line))
  4911. (setq mode 'top-comment))
  4912. (skip-chars-forward " \r\t\n")
  4913. (beginning-of-line))
  4914. ;; Cache returned exact match: return it.
  4915. ((= pos begin)
  4916. (throw 'exit (if syncp (org-element-property :parent cached) cached)))
  4917. ;; There's a headline between cached value and POS: cached
  4918. ;; value is invalid. Start parsing from first element
  4919. ;; following the headline.
  4920. ((re-search-backward
  4921. (org-with-limited-levels org-outline-regexp-bol) begin t)
  4922. (forward-line)
  4923. (skip-chars-forward " \r\t\n")
  4924. (beginning-of-line)
  4925. (setq mode 'planning))
  4926. ;; Check if CACHED or any of its ancestors contain point.
  4927. ;;
  4928. ;; If there is such an element, we inspect it in order to know
  4929. ;; if we return it or if we need to parse its contents.
  4930. ;; Otherwise, we just start parsing from current location,
  4931. ;; which is right after the top-most element containing
  4932. ;; CACHED.
  4933. ;;
  4934. ;; As a special case, if POS is at the end of the buffer, we
  4935. ;; want to return the innermost element ending there.
  4936. ;;
  4937. ;; Also, if we find an ancestor and discover that we need to
  4938. ;; parse its contents, make sure we don't start from
  4939. ;; `:contents-begin', as we would otherwise go past CACHED
  4940. ;; again. Instead, in that situation, we will resume parsing
  4941. ;; from NEXT, which is located after CACHED or its higher
  4942. ;; ancestor not containing point.
  4943. (t
  4944. (let ((up cached)
  4945. (pos (if (= (point-max) pos) (1- pos) pos)))
  4946. (goto-char (or (org-element-property :contents-begin cached) begin))
  4947. (while (let ((end (org-element-property :end up)))
  4948. (and (<= end pos)
  4949. (goto-char end)
  4950. (setq up (org-element-property :parent up)))))
  4951. (cond ((not up))
  4952. ((eobp) (setq element up))
  4953. (t (setq element up next (point)))))))
  4954. ;; Parse successively each element until we reach POS.
  4955. (let ((end (or (org-element-property :end element)
  4956. (save-excursion
  4957. (org-with-limited-levels (outline-next-heading))
  4958. (point))))
  4959. (parent element))
  4960. (while t
  4961. (when syncp
  4962. (cond ((= (point) pos) (throw 'exit parent))
  4963. ((org-element--cache-interrupt-p time-limit)
  4964. (throw 'interrupt nil))))
  4965. (unless element
  4966. (setq element (org-element--current-element
  4967. end 'element mode
  4968. (org-element-property :structure parent)))
  4969. (org-element-put-property element :parent parent)
  4970. (org-element--cache-put element))
  4971. (let ((elem-end (org-element-property :end element))
  4972. (type (org-element-type element)))
  4973. (cond
  4974. ;; Skip any element ending before point. Also skip
  4975. ;; element ending at point (unless it is also the end of
  4976. ;; buffer) since we're sure that another element begins
  4977. ;; after it.
  4978. ((and (<= elem-end pos) (/= (point-max) elem-end))
  4979. (goto-char elem-end)
  4980. (setq mode (org-element--next-mode mode type nil)))
  4981. ;; A non-greater element contains point: return it.
  4982. ((not (memq type org-element-greater-elements))
  4983. (throw 'exit element))
  4984. ;; Otherwise, we have to decide if ELEMENT really
  4985. ;; contains POS. In that case we start parsing from
  4986. ;; contents' beginning.
  4987. ;;
  4988. ;; If POS is at contents' beginning but it is also at
  4989. ;; the beginning of the first item in a list or a table.
  4990. ;; In that case, we need to create an anchor for that
  4991. ;; list or table, so return it.
  4992. ;;
  4993. ;; Also, if POS is at the end of the buffer, no element
  4994. ;; can start after it, but more than one may end there.
  4995. ;; Arbitrarily, we choose to return the innermost of
  4996. ;; such elements.
  4997. ((let ((cbeg (org-element-property :contents-begin element))
  4998. (cend (org-element-property :contents-end element)))
  4999. (when (or syncp
  5000. (and cbeg cend
  5001. (or (< cbeg pos)
  5002. (and (= cbeg pos)
  5003. (not (memq type '(plain-list table)))))
  5004. (or (> cend pos)
  5005. (and (= cend pos) (= (point-max) pos)))))
  5006. (goto-char (or next cbeg))
  5007. (setq next nil
  5008. mode (org-element--next-mode mode type t)
  5009. parent element
  5010. end cend))))
  5011. ;; Otherwise, return ELEMENT as it is the smallest
  5012. ;; element containing POS.
  5013. (t (throw 'exit element))))
  5014. (setq element nil)))))))
  5015. ;;;; Staging Buffer Changes
  5016. (defconst org-element--cache-sensitive-re
  5017. (concat
  5018. "^\\*+ " "\\|"
  5019. "\\\\end{[A-Za-z0-9*]+}[ \t]*$" "\\|"
  5020. "^[ \t]*\\(?:"
  5021. "#\\+\\(?:BEGIN[:_]\\|END\\(?:_\\|:?[ \t]*$\\)\\)" "\\|"
  5022. "\\\\begin{[A-Za-z0-9*]+}" "\\|"
  5023. ":\\(?:\\w\\|[-_]\\)+:[ \t]*$"
  5024. "\\)")
  5025. "Regexp matching a sensitive line, structure wise.
  5026. A sensitive line is a headline, inlinetask, block, drawer, or
  5027. latex-environment boundary. When such a line is modified,
  5028. structure changes in the document may propagate in the whole
  5029. section, possibly making cache invalid.")
  5030. (defvar org-element--cache-change-warning nil
  5031. "Non-nil when a sensitive line is about to be changed.
  5032. It is a symbol among nil, t and `headline'.")
  5033. (defun org-element--cache-before-change (beg end)
  5034. "Request extension of area going to be modified if needed.
  5035. BEG and END are the beginning and end of the range of changed
  5036. text. See `before-change-functions' for more information."
  5037. (when (org-element--cache-active-p)
  5038. (org-with-wide-buffer
  5039. (goto-char beg)
  5040. (beginning-of-line)
  5041. (let ((bottom (save-excursion (goto-char end) (line-end-position))))
  5042. (setq org-element--cache-change-warning
  5043. (save-match-data
  5044. (if (and (org-with-limited-levels (org-at-heading-p))
  5045. (= (line-end-position) bottom))
  5046. 'headline
  5047. (let ((case-fold-search t))
  5048. (re-search-forward
  5049. org-element--cache-sensitive-re bottom t)))))))))
  5050. (defun org-element--cache-after-change (beg end pre)
  5051. "Update buffer modifications for current buffer.
  5052. BEG and END are the beginning and end of the range of changed
  5053. text, and the length in bytes of the pre-change text replaced by
  5054. that range. See `after-change-functions' for more information."
  5055. (when (org-element--cache-active-p)
  5056. (org-with-wide-buffer
  5057. (goto-char beg)
  5058. (beginning-of-line)
  5059. (save-match-data
  5060. (let ((top (point))
  5061. (bottom (save-excursion (goto-char end) (line-end-position))))
  5062. ;; Determine if modified area needs to be extended, according
  5063. ;; to both previous and current state. We make a special
  5064. ;; case for headline editing: if a headline is modified but
  5065. ;; not removed, do not extend.
  5066. (when (pcase org-element--cache-change-warning
  5067. (`t t)
  5068. (`headline
  5069. (not (and (org-with-limited-levels (org-at-heading-p))
  5070. (= (line-end-position) bottom))))
  5071. (_
  5072. (let ((case-fold-search t))
  5073. (re-search-forward
  5074. org-element--cache-sensitive-re bottom t))))
  5075. ;; Effectively extend modified area.
  5076. (org-with-limited-levels
  5077. (setq top (progn (goto-char top)
  5078. (when (outline-previous-heading) (forward-line))
  5079. (point)))
  5080. (setq bottom (progn (goto-char bottom)
  5081. (if (outline-next-heading) (1- (point))
  5082. (point))))))
  5083. ;; Store synchronization request.
  5084. (let ((offset (- end beg pre)))
  5085. (org-element--cache-submit-request top (- bottom offset) offset)))))
  5086. ;; Activate a timer to process the request during idle time.
  5087. (org-element--cache-set-timer (current-buffer))))
  5088. (defun org-element--cache-for-removal (beg end offset)
  5089. "Return first element to remove from cache.
  5090. BEG and END are buffer positions delimiting buffer modifications.
  5091. OFFSET is the size of the changes.
  5092. Returned element is usually the first element in cache containing
  5093. any position between BEG and END. As an exception, greater
  5094. elements around the changes that are robust to contents
  5095. modifications are preserved and updated according to the
  5096. changes."
  5097. (let* ((elements (org-element--cache-find (1- beg) 'both))
  5098. (before (car elements))
  5099. (after (cdr elements)))
  5100. (if (not before) after
  5101. (let ((up before)
  5102. (robust-flag t))
  5103. (while up
  5104. (if (let ((type (org-element-type up)))
  5105. (and (or (memq type '(center-block dynamic-block quote-block
  5106. special-block))
  5107. ;; Drawers named "PROPERTIES" are probably
  5108. ;; a properties drawer being edited. Force
  5109. ;; parsing to check if editing is over.
  5110. (and (eq type 'drawer)
  5111. (not (string=
  5112. (org-element-property :drawer-name up)
  5113. "PROPERTIES"))))
  5114. (let ((cbeg (org-element-property :contents-begin up)))
  5115. (and cbeg
  5116. (<= cbeg beg)
  5117. (> (org-element-property :contents-end up) end)))))
  5118. ;; UP is a robust greater element containing changes.
  5119. ;; We only need to extend its ending boundaries.
  5120. (org-element--cache-shift-positions
  5121. up offset '(:contents-end :end))
  5122. (setq before up)
  5123. (when robust-flag (setq robust-flag nil)))
  5124. (setq up (org-element-property :parent up)))
  5125. ;; We're at top level element containing ELEMENT: if it's
  5126. ;; altered by buffer modifications, it is first element in
  5127. ;; cache to be removed. Otherwise, that first element is the
  5128. ;; following one.
  5129. ;;
  5130. ;; As a special case, do not remove BEFORE if it is a robust
  5131. ;; container for current changes.
  5132. (if (or (< (org-element-property :end before) beg) robust-flag) after
  5133. before)))))
  5134. (defun org-element--cache-submit-request (beg end offset)
  5135. "Submit a new cache synchronization request for current buffer.
  5136. BEG and END are buffer positions delimiting the minimal area
  5137. where cache data should be removed. OFFSET is the size of the
  5138. change, as an integer."
  5139. (let ((next (car org-element--cache-sync-requests))
  5140. delete-to delete-from)
  5141. (if (and next
  5142. (zerop (aref next 5))
  5143. (> (setq delete-to (+ (aref next 2) (aref next 3))) end)
  5144. (<= (setq delete-from (aref next 1)) end))
  5145. ;; Current changes can be merged with first sync request: we
  5146. ;; can save a partial cache synchronization.
  5147. (progn
  5148. (cl-incf (aref next 3) offset)
  5149. ;; If last change happened within area to be removed, extend
  5150. ;; boundaries of robust parents, if any. Otherwise, find
  5151. ;; first element to remove and update request accordingly.
  5152. (if (> beg delete-from)
  5153. (let ((up (aref next 4)))
  5154. (while up
  5155. (org-element--cache-shift-positions
  5156. up offset '(:contents-end :end))
  5157. (setq up (org-element-property :parent up))))
  5158. (let ((first (org-element--cache-for-removal beg delete-to offset)))
  5159. (when first
  5160. (aset next 0 (org-element--cache-key first))
  5161. (aset next 1 (org-element-property :begin first))
  5162. (aset next 4 (org-element-property :parent first))))))
  5163. ;; Ensure cache is correct up to END. Also make sure that NEXT,
  5164. ;; if any, is no longer a 0-phase request, thus ensuring that
  5165. ;; phases are properly ordered. We need to provide OFFSET as
  5166. ;; optional parameter since current modifications are not known
  5167. ;; yet to the otherwise correct part of the cache (i.e, before
  5168. ;; the first request).
  5169. (when next (org-element--cache-sync (current-buffer) end beg))
  5170. (let ((first (org-element--cache-for-removal beg end offset)))
  5171. (if first
  5172. (push (let ((beg (org-element-property :begin first))
  5173. (key (org-element--cache-key first)))
  5174. (cond
  5175. ;; When changes happen before the first known
  5176. ;; element, re-parent and shift the rest of the
  5177. ;; cache.
  5178. ((> beg end) (vector key beg nil offset nil 1))
  5179. ;; Otherwise, we find the first non robust
  5180. ;; element containing END. All elements between
  5181. ;; FIRST and this one are to be removed.
  5182. ((let ((first-end (org-element-property :end first)))
  5183. (and (> first-end end)
  5184. (vector key beg first-end offset first 0))))
  5185. (t
  5186. (let* ((element (org-element--cache-find end))
  5187. (end (org-element-property :end element))
  5188. (up element))
  5189. (while (and (setq up (org-element-property :parent up))
  5190. (>= (org-element-property :begin up) beg))
  5191. (setq end (org-element-property :end up)
  5192. element up))
  5193. (vector key beg end offset element 0)))))
  5194. org-element--cache-sync-requests)
  5195. ;; No element to remove. No need to re-parent either.
  5196. ;; Simply shift additional elements, if any, by OFFSET.
  5197. (when org-element--cache-sync-requests
  5198. (cl-incf (aref (car org-element--cache-sync-requests) 3)
  5199. offset)))))))
  5200. ;;;; Public Functions
  5201. ;;;###autoload
  5202. (defun org-element-cache-reset (&optional all)
  5203. "Reset cache in current buffer.
  5204. When optional argument ALL is non-nil, reset cache in all Org
  5205. buffers."
  5206. (interactive "P")
  5207. (dolist (buffer (if all (buffer-list) (list (current-buffer))))
  5208. (with-current-buffer buffer
  5209. (when (and org-element-use-cache (derived-mode-p 'org-mode))
  5210. (setq-local org-element--cache
  5211. (avl-tree-create #'org-element--cache-compare))
  5212. (setq-local org-element--cache-sync-keys
  5213. (make-hash-table :weakness 'key :test #'eq))
  5214. (setq-local org-element--cache-change-warning nil)
  5215. (setq-local org-element--cache-sync-requests nil)
  5216. (setq-local org-element--cache-sync-timer nil)
  5217. (add-hook 'before-change-functions
  5218. #'org-element--cache-before-change nil t)
  5219. (add-hook 'after-change-functions
  5220. #'org-element--cache-after-change nil t)))))
  5221. ;;;###autoload
  5222. (defun org-element-cache-refresh (pos)
  5223. "Refresh cache at position POS."
  5224. (when (org-element--cache-active-p)
  5225. (org-element--cache-sync (current-buffer) pos)
  5226. (org-element--cache-submit-request pos pos 0)
  5227. (org-element--cache-set-timer (current-buffer))))
  5228. ;;; The Toolbox
  5229. ;;
  5230. ;; The first move is to implement a way to obtain the smallest element
  5231. ;; containing point. This is the job of `org-element-at-point'. It
  5232. ;; basically jumps back to the beginning of section containing point
  5233. ;; and proceed, one element after the other, with
  5234. ;; `org-element--current-element' until the container is found. Note:
  5235. ;; When using `org-element-at-point', secondary values are never
  5236. ;; parsed since the function focuses on elements, not on objects.
  5237. ;;
  5238. ;; At a deeper level, `org-element-context' lists all elements and
  5239. ;; objects containing point.
  5240. ;;
  5241. ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
  5242. ;; internally by navigation and manipulation tools.
  5243. ;;;###autoload
  5244. (defun org-element-at-point ()
  5245. "Determine closest element around point.
  5246. Return value is a list like (TYPE PROPS) where TYPE is the type
  5247. of the element and PROPS a plist of properties associated to the
  5248. element.
  5249. Possible types are defined in `org-element-all-elements'.
  5250. Properties depend on element or object type, but always include
  5251. `:begin', `:end', and `:post-blank' properties.
  5252. As a special case, if point is at the very beginning of the first
  5253. item in a list or sub-list, returned element will be that list
  5254. instead of the item. Likewise, if point is at the beginning of
  5255. the first row of a table, returned element will be the table
  5256. instead of the first row.
  5257. When point is at the end of the buffer, return the innermost
  5258. element ending there."
  5259. (org-with-wide-buffer
  5260. (let ((origin (point)))
  5261. (end-of-line)
  5262. (skip-chars-backward " \r\t\n")
  5263. (cond
  5264. ;; Within blank lines at the beginning of buffer, return nil.
  5265. ((bobp) nil)
  5266. ;; Within blank lines right after a headline, return that
  5267. ;; headline.
  5268. ((org-with-limited-levels (org-at-heading-p))
  5269. (beginning-of-line)
  5270. (org-element-headline-parser (point-max) t))
  5271. ;; Otherwise parse until we find element containing ORIGIN.
  5272. (t
  5273. (when (org-element--cache-active-p)
  5274. (if (not org-element--cache) (org-element-cache-reset)
  5275. (org-element--cache-sync (current-buffer) origin)))
  5276. (org-element--parse-to origin))))))
  5277. ;;;###autoload
  5278. (defun org-element-context (&optional element)
  5279. "Return smallest element or object around point.
  5280. Return value is a list like (TYPE PROPS) where TYPE is the type
  5281. of the element or object and PROPS a plist of properties
  5282. associated to it.
  5283. Possible types are defined in `org-element-all-elements' and
  5284. `org-element-all-objects'. Properties depend on element or
  5285. object type, but always include `:begin', `:end', `:parent' and
  5286. `:post-blank'.
  5287. As a special case, if point is right after an object and not at
  5288. the beginning of any other object, return that object.
  5289. Optional argument ELEMENT, when non-nil, is the closest element
  5290. containing point, as returned by `org-element-at-point'.
  5291. Providing it allows for quicker computation."
  5292. (catch 'objects-forbidden
  5293. (org-with-wide-buffer
  5294. (let* ((pos (point))
  5295. (element (or element (org-element-at-point)))
  5296. (type (org-element-type element))
  5297. (post (org-element-property :post-affiliated element)))
  5298. ;; If point is inside an element containing objects or
  5299. ;; a secondary string, narrow buffer to the container and
  5300. ;; proceed with parsing. Otherwise, return ELEMENT.
  5301. (cond
  5302. ;; At a parsed affiliated keyword, check if we're inside main
  5303. ;; or dual value.
  5304. ((and post (< pos post))
  5305. (beginning-of-line)
  5306. (let ((case-fold-search t)) (looking-at org-element--affiliated-re))
  5307. (cond
  5308. ((not (member-ignore-case (match-string 1)
  5309. org-element-parsed-keywords))
  5310. (throw 'objects-forbidden element))
  5311. ((< (match-end 0) pos)
  5312. (narrow-to-region (match-end 0) (line-end-position)))
  5313. ((and (match-beginning 2)
  5314. (>= pos (match-beginning 2))
  5315. (< pos (match-end 2)))
  5316. (narrow-to-region (match-beginning 2) (match-end 2)))
  5317. (t (throw 'objects-forbidden element)))
  5318. ;; Also change type to retrieve correct restrictions.
  5319. (setq type 'keyword))
  5320. ;; At an item, objects can only be located within tag, if any.
  5321. ((eq type 'item)
  5322. (let ((tag (org-element-property :tag element)))
  5323. (if (or (not tag) (/= (line-beginning-position) post))
  5324. (throw 'objects-forbidden element)
  5325. (beginning-of-line)
  5326. (search-forward tag (line-end-position))
  5327. (goto-char (match-beginning 0))
  5328. (if (and (>= pos (point)) (< pos (match-end 0)))
  5329. (narrow-to-region (point) (match-end 0))
  5330. (throw 'objects-forbidden element)))))
  5331. ;; At an headline or inlinetask, objects are in title.
  5332. ((memq type '(headline inlinetask))
  5333. (let ((case-fold-search nil))
  5334. (goto-char (org-element-property :begin element))
  5335. (looking-at org-complex-heading-regexp)
  5336. (let ((end (match-end 4)))
  5337. (if (not end) (throw 'objects-forbidden element)
  5338. (goto-char (match-beginning 4))
  5339. (when (looking-at org-comment-string)
  5340. (goto-char (match-end 0)))
  5341. (if (>= (point) end) (throw 'objects-forbidden element)
  5342. (narrow-to-region (point) end))))))
  5343. ;; At a paragraph, a table-row or a verse block, objects are
  5344. ;; located within their contents.
  5345. ((memq type '(paragraph table-row verse-block))
  5346. (let ((cbeg (org-element-property :contents-begin element))
  5347. (cend (org-element-property :contents-end element)))
  5348. ;; CBEG is nil for table rules.
  5349. (if (and cbeg cend (>= pos cbeg)
  5350. (or (< pos cend) (and (= pos cend) (eobp))))
  5351. (narrow-to-region cbeg cend)
  5352. (throw 'objects-forbidden element))))
  5353. (t (throw 'objects-forbidden element)))
  5354. (goto-char (point-min))
  5355. (let ((restriction (org-element-restriction type))
  5356. (parent element)
  5357. last)
  5358. (catch 'exit
  5359. (while t
  5360. (let ((next (org-element--object-lex restriction)))
  5361. (when next (org-element-put-property next :parent parent))
  5362. ;; Process NEXT, if any, in order to know if we need to
  5363. ;; skip it, return it or move into it.
  5364. (if (or (not next) (> (org-element-property :begin next) pos))
  5365. (throw 'exit (or last parent))
  5366. (let ((end (org-element-property :end next))
  5367. (cbeg (org-element-property :contents-begin next))
  5368. (cend (org-element-property :contents-end next)))
  5369. (cond
  5370. ;; Skip objects ending before point. Also skip
  5371. ;; objects ending at point unless it is also the
  5372. ;; end of buffer, since we want to return the
  5373. ;; innermost object.
  5374. ((and (<= end pos) (/= (point-max) end))
  5375. (goto-char end)
  5376. ;; For convenience, when object ends at POS,
  5377. ;; without any space, store it in LAST, as we
  5378. ;; will return it if no object starts here.
  5379. (when (and (= end pos)
  5380. (not (memq (char-before) '(?\s ?\t))))
  5381. (setq last next)))
  5382. ;; If POS is within a container object, move into
  5383. ;; that object.
  5384. ((and cbeg cend
  5385. (>= pos cbeg)
  5386. (or (< pos cend)
  5387. ;; At contents' end, if there is no
  5388. ;; space before point, also move into
  5389. ;; object, for consistency with
  5390. ;; convenience feature above.
  5391. (and (= pos cend)
  5392. (or (= (point-max) pos)
  5393. (not (memq (char-before pos)
  5394. '(?\s ?\t)))))))
  5395. (goto-char cbeg)
  5396. (narrow-to-region (point) cend)
  5397. (setq parent next)
  5398. (setq restriction (org-element-restriction next)))
  5399. ;; Otherwise, return NEXT.
  5400. (t (throw 'exit next)))))))))))))
  5401. (defun org-element-lineage (datum &optional types with-self)
  5402. "List all ancestors of a given element or object.
  5403. DATUM is an object or element.
  5404. Return ancestors from the closest to the farthest. When optional
  5405. argument TYPES is a list of symbols, return the first element or
  5406. object in the lineage whose type belongs to that list instead.
  5407. When optional argument WITH-SELF is non-nil, lineage includes
  5408. DATUM itself as the first element, and TYPES, if provided, also
  5409. apply to it.
  5410. When DATUM is obtained through `org-element-context' or
  5411. `org-element-at-point', only ancestors from its section can be
  5412. found. There is no such limitation when DATUM belongs to a full
  5413. parse tree."
  5414. (let ((up (if with-self datum (org-element-property :parent datum)))
  5415. ancestors)
  5416. (while (and up (not (memq (org-element-type up) types)))
  5417. (unless types (push up ancestors))
  5418. (setq up (org-element-property :parent up)))
  5419. (if types up (nreverse ancestors))))
  5420. (defun org-element-nested-p (elem-A elem-B)
  5421. "Non-nil when elements ELEM-A and ELEM-B are nested."
  5422. (let ((beg-A (org-element-property :begin elem-A))
  5423. (beg-B (org-element-property :begin elem-B))
  5424. (end-A (org-element-property :end elem-A))
  5425. (end-B (org-element-property :end elem-B)))
  5426. (or (and (>= beg-A beg-B) (<= end-A end-B))
  5427. (and (>= beg-B beg-A) (<= end-B end-A)))))
  5428. (defun org-element-swap-A-B (elem-A elem-B)
  5429. "Swap elements ELEM-A and ELEM-B.
  5430. Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
  5431. end of ELEM-A."
  5432. (goto-char (org-element-property :begin elem-A))
  5433. ;; There are two special cases when an element doesn't start at bol:
  5434. ;; the first paragraph in an item or in a footnote definition.
  5435. (let ((specialp (not (bolp))))
  5436. ;; Only a paragraph without any affiliated keyword can be moved at
  5437. ;; ELEM-A position in such a situation. Note that the case of
  5438. ;; a footnote definition is impossible: it cannot contain two
  5439. ;; paragraphs in a row because it cannot contain a blank line.
  5440. (when (and specialp
  5441. (or (not (eq (org-element-type elem-B) 'paragraph))
  5442. (/= (org-element-property :begin elem-B)
  5443. (org-element-property :contents-begin elem-B))))
  5444. (error "Cannot swap elements"))
  5445. ;; In a special situation, ELEM-A will have no indentation. We'll
  5446. ;; give it ELEM-B's (which will in, in turn, have no indentation).
  5447. (let* ((ind-B (when specialp
  5448. (goto-char (org-element-property :begin elem-B))
  5449. (current-indentation)))
  5450. (beg-A (org-element-property :begin elem-A))
  5451. (end-A (save-excursion
  5452. (goto-char (org-element-property :end elem-A))
  5453. (skip-chars-backward " \r\t\n")
  5454. (point-at-eol)))
  5455. (beg-B (org-element-property :begin elem-B))
  5456. (end-B (save-excursion
  5457. (goto-char (org-element-property :end elem-B))
  5458. (skip-chars-backward " \r\t\n")
  5459. (point-at-eol)))
  5460. ;; Store inner overlays responsible for visibility status.
  5461. ;; We also need to store their boundaries as they will be
  5462. ;; removed from buffer.
  5463. (overlays
  5464. (cons
  5465. (delq nil
  5466. (mapcar (lambda (o)
  5467. (and (>= (overlay-start o) beg-A)
  5468. (<= (overlay-end o) end-A)
  5469. (list o (overlay-start o) (overlay-end o))))
  5470. (overlays-in beg-A end-A)))
  5471. (delq nil
  5472. (mapcar (lambda (o)
  5473. (and (>= (overlay-start o) beg-B)
  5474. (<= (overlay-end o) end-B)
  5475. (list o (overlay-start o) (overlay-end o))))
  5476. (overlays-in beg-B end-B)))))
  5477. ;; Get contents.
  5478. (body-A (buffer-substring beg-A end-A))
  5479. (body-B (delete-and-extract-region beg-B end-B)))
  5480. (goto-char beg-B)
  5481. (when specialp
  5482. (setq body-B (replace-regexp-in-string "\\`[ \t]*" "" body-B))
  5483. (indent-to-column ind-B))
  5484. (insert body-A)
  5485. ;; Restore ex ELEM-A overlays.
  5486. (let ((offset (- beg-B beg-A)))
  5487. (dolist (o (car overlays))
  5488. (move-overlay (car o) (+ (nth 1 o) offset) (+ (nth 2 o) offset)))
  5489. (goto-char beg-A)
  5490. (delete-region beg-A end-A)
  5491. (insert body-B)
  5492. ;; Restore ex ELEM-B overlays.
  5493. (dolist (o (cdr overlays))
  5494. (move-overlay (car o) (- (nth 1 o) offset) (- (nth 2 o) offset))))
  5495. (goto-char (org-element-property :end elem-B)))))
  5496. (provide 'org-element)
  5497. ;; Local variables:
  5498. ;; generated-autoload-file: "org-loaddefs.el"
  5499. ;; End:
  5500. ;;; org-element.el ends here