org-element.el 213 KB

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