org-element.el 212 KB

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