123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162 |
- ;;; org.el --- Outline-based notes management and organizer -*- lexical-binding: t; -*-
- ;; Carstens outline-mode for keeping track of everything.
- ;; Copyright (C) 2004-2022 Free Software Foundation, Inc.
- ;;
- ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
- ;; Maintainer: Bastien Guerry <bzg@gnu.org>
- ;; Keywords: outlines, hypermedia, calendar, wp
- ;; URL: https://orgmode.org
- ;; Package-Requires: ((emacs "25.1"))
- ;; Version: 9.6-pre
- ;; This file is part of GNU Emacs.
- ;;
- ;; GNU Emacs is free software: you can redistribute it and/or modify
- ;; it under the terms of the GNU General Public License as published by
- ;; the Free Software Foundation, either version 3 of the License, or
- ;; (at your option) any later version.
- ;; GNU Emacs is distributed in the hope that it will be useful,
- ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
- ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- ;; GNU General Public License for more details.
- ;; You should have received a copy of the GNU General Public License
- ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
- ;;
- ;;; Commentary:
- ;;
- ;; Org is a mode for keeping notes, maintaining ToDo lists, and doing
- ;; project planning with a fast and effective plain-text system.
- ;;
- ;; Org mode develops organizational tasks around NOTES files that
- ;; contain information about projects as plain text. Org mode is
- ;; implemented on top of outline-mode, which makes it possible to keep
- ;; the content of large files well structured. Visibility cycling and
- ;; structure editing help to work with the tree. Tables are easily
- ;; created with a built-in table editor. Org mode supports ToDo
- ;; items, deadlines, time stamps, and scheduling. It dynamically
- ;; compiles entries into an agenda that utilizes and smoothly
- ;; integrates much of the Emacs calendar and diary. Plain text
- ;; URL-like links connect to websites, emails, Usenet messages, BBDB
- ;; entries, and any files related to the projects. For printing and
- ;; sharing of notes, an Org file can be exported as a structured ASCII
- ;; file, as HTML, or (todo and agenda items only) as an iCalendar
- ;; file. It can also serve as a publishing tool for a set of linked
- ;; webpages.
- ;;
- ;; Installation and Activation
- ;; ---------------------------
- ;; See the corresponding sections in the manual at
- ;;
- ;; https://orgmode.org/org.html#Installation
- ;;
- ;; Documentation
- ;; -------------
- ;; The documentation of Org mode can be found in the TeXInfo file. The
- ;; distribution also contains a PDF version of it. At the Org mode website,
- ;; you can read the same text online as HTML. There is also an excellent
- ;; reference card made by Philip Rooke. This card can be found in the
- ;; doc/ directory.
- ;;
- ;; A list of recent changes can be found at
- ;; https://orgmode.org/Changes.html
- ;;
- ;;; Code:
- (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
- (defvar org-inlinetask-min-level)
- ;;;; Require other packages
- (require 'org-compat)
- (org-assert-version)
- (require 'cl-lib)
- (eval-when-compile (require 'gnus-sum))
- (require 'calendar)
- (require 'find-func)
- (require 'format-spec)
- (condition-case nil
- (load (concat (file-name-directory load-file-name)
- "org-loaddefs.el")
- nil t t t)
- (error
- (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
- (sit-for 3)
- (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
- (sit-for 3)))
- (eval-and-compile (require 'org-macs))
- (require 'org-compat)
- (require 'org-keys)
- (require 'ol)
- (require 'oc)
- (require 'org-table)
- (require 'org-fold)
- (require 'org-cycle)
- (defvaralias 'org-hide-block-startup 'org-cycle-hide-block-startup)
- (defvaralias 'org-pre-cycle-hook 'org-cycle-pre-hook)
- (defvaralias 'org-tab-first-hook 'org-cycle-tab-first-hook)
- (defalias 'org-global-cycle #'org-cycle-global)
- (defalias 'org-overview #'org-cycle-overview)
- (defalias 'org-content #'org-cycle-content)
- (defalias 'org-reveal #'org-fold-reveal)
- (defalias 'org-force-cycle-archived #'org-cycle-force-archived)
- ;; `org-outline-regexp' ought to be a defconst but is let-bound in
- ;; some places -- e.g. see the macro `org-with-limited-levels'.
- (defvar org-outline-regexp "\\*+ "
- "Regexp to match Org headlines.")
- (defvar org-outline-regexp-bol "^\\*+ "
- "Regexp to match Org headlines.
- This is similar to `org-outline-regexp' but additionally makes
- sure that we are at the beginning of the line.")
- (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
- "Matches a headline, putting stars and text into groups.
- Stars are put in group 1 and the trimmed body in group 2.")
- (declare-function calendar-check-holidays "holidays" (date))
- (declare-function cdlatex-environment "ext:cdlatex" (environment item))
- (declare-function cdlatex-math-symbol "ext:cdlatex")
- (declare-function Info-goto-node "info" (nodename &optional fork strict-case))
- (declare-function isearch-no-upper-case-p "isearch" (string regexp-flag))
- (declare-function org-add-archive-files "org-archive" (files))
- (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
- (declare-function org-agenda-todo-yesterday "org-agenda" (&optional arg))
- (declare-function org-agenda-list "org-agenda" (&optional arg start-day span with-hour))
- (declare-function org-agenda-redo "org-agenda" (&optional all))
- (declare-function org-agenda-remove-restriction-lock "org-agenda" (&optional noupdate))
- (declare-function org-archive-subtree "org-archive" (&optional find-done))
- (declare-function org-archive-subtree-default "org-archive" ())
- (declare-function org-archive-to-archive-sibling "org-archive" ())
- (declare-function org-attach "org-attach" ())
- (declare-function org-attach-dir "org-attach"
- (&optional create-if-not-exists-p no-fs-check))
- (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
- (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
- (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
- (declare-function org-clock-auto-clockout "org-clock" ())
- (declare-function org-clock-cancel "org-clock" ())
- (declare-function org-clock-display "org-clock" (&optional arg))
- (declare-function org-clock-get-last-clock-out-time "org-clock" ())
- (declare-function org-clock-goto "org-clock" (&optional select))
- (declare-function org-clock-in "org-clock" (&optional select start-time))
- (declare-function org-clock-in-last "org-clock" (&optional arg))
- (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
- (declare-function org-clock-out-if-current "org-clock" ())
- (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
- (declare-function org-clock-report "org-clock" (&optional arg))
- (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
- (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
- (declare-function org-clock-timestamps-down "org-clock" (&optional n))
- (declare-function org-clock-timestamps-up "org-clock" (&optional n))
- (declare-function org-clock-update-time-maybe "org-clock" ())
- (declare-function org-clocktable-shift "org-clock" (dir n))
- (declare-function org-columns-quit "org-colview" ())
- (declare-function org-columns-insert-dblock "org-colview" ())
- (declare-function org-duration-from-minutes "org-duration" (minutes &optional fmt canonical))
- (declare-function org-duration-to-minutes "org-duration" (duration &optional canonical))
- (declare-function org-element-at-point "org-element" (&optional pom cached-only))
- (declare-function org-element-at-point-no-context "org-element" (&optional pom))
- (declare-function org-element-cache-refresh "org-element" (pos))
- (declare-function org-element-cache-reset "org-element" (&optional all))
- (declare-function org-element-cache-map "org-element" (func &rest keys))
- (declare-function org-element-contents "org-element" (element))
- (declare-function org-element-context "org-element" (&optional element))
- (declare-function org-element-copy "org-element" (datum))
- (declare-function org-element-create "org-element" (type &optional props &rest children))
- (declare-function org-element-extract-element "org-element" (element))
- (declare-function org-element-insert-before "org-element" (element location))
- (declare-function org-element-interpret-data "org-element" (data))
- (declare-function org-element-keyword-parser "org-element" (limit affiliated))
- (declare-function org-element-lineage "org-element" (blob &optional types with-self))
- (declare-function org-element-link-parser "org-element" ())
- (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
- (declare-function org-element-nested-p "org-element" (elem-a elem-b))
- (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
- (declare-function org-element-parse-secondary-string "org-element" (string restriction &optional parent))
- (declare-function org-element-property "org-element" (property element))
- (declare-function org-element-put-property "org-element" (element property value))
- (declare-function org-element-restriction "org-element" (element))
- (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
- (declare-function org-element-timestamp-parser "org-element" ())
- (declare-function org-element-type "org-element" (element))
- (declare-function org-element--cache-active-p "org-element" ())
- (declare-function org-export-dispatch "ox" (&optional arg))
- (declare-function org-export-get-backend "ox" (name))
- (declare-function org-export-get-environment "ox" (&optional backend subtreep ext-plist))
- (declare-function org-feed-goto-inbox "org-feed" (feed))
- (declare-function org-feed-update-all "org-feed" ())
- (declare-function org-goto "org-goto" (&optional alternative-interface))
- (declare-function org-id-find-id-file "org-id" (id))
- (declare-function org-id-get-create "org-id" (&optional force))
- (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
- (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
- (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
- (declare-function org-latex-make-preamble "ox-latex" (info &optional template snippet?))
- (declare-function org-num-mode "org-num" (&optional arg))
- (declare-function org-plot/gnuplot "org-plot" (&optional params))
- (declare-function org-persist-load "org-persist" (container &optional associated hash-must-match))
- (declare-function org-tags-view "org-agenda" (&optional todo-only match))
- (declare-function org-timer "org-timer" (&optional restart no-insert))
- (declare-function org-timer-item "org-timer" (&optional arg))
- (declare-function org-timer-pause-or-continue "org-timer" (&optional stop))
- (declare-function org-timer-set-timer "org-timer" (&optional opt))
- (declare-function org-timer-start "org-timer" (&optional offset))
- (declare-function org-timer-stop "org-timer" ())
- (declare-function org-toggle-archive-tag "org-archive" (&optional find-done))
- (declare-function org-update-radio-target-regexp "ol" ())
- (defvar org-agenda-buffer-name)
- (defvar org-element-paragraph-separate)
- (defvar org-element-cache-map-continue-from)
- (defvar org-element--timestamp-regexp)
- (defvar org-indent-indentation-per-level)
- (defvar org-radio-target-regexp)
- (defvar org-target-link-regexp)
- (defvar org-target-regexp)
- (defvar org-id-overriding-file-name)
- ;; load languages based on value of `org-babel-load-languages'
- (defvar org-babel-load-languages)
- (defvar crm-separator) ; dynamically scoped param
- ;;;###autoload
- (defun org-babel-do-load-languages (sym value)
- "Load the languages defined in `org-babel-load-languages'."
- (set-default-toplevel-value sym value)
- (dolist (pair org-babel-load-languages)
- (let ((active (cdr pair)) (lang (symbol-name (car pair))))
- (if active
- (require (intern (concat "ob-" lang)))
- (fmakunbound
- (intern (concat "org-babel-execute:" lang)))
- (fmakunbound
- (intern (concat "org-babel-expand-body:" lang)))))))
- ;;;###autoload
- (defun org-babel-load-file (file &optional compile)
- "Load Emacs Lisp source code blocks in the Org FILE.
- This function exports the source code using `org-babel-tangle'
- and then loads the resulting file using `load-file'. With
- optional prefix argument COMPILE, the tangled Emacs Lisp file is
- byte-compiled before it is loaded."
- (interactive "fFile to load: \nP")
- (let ((tangled-file (concat (file-name-sans-extension file) ".el")))
- ;; Tangle only if the Org file is newer than the Elisp file.
- (unless (org-file-newer-than-p
- tangled-file
- (file-attribute-modification-time
- (file-attributes (file-truename file))))
- ;; Make sure that tangled file modification time is
- ;; updated even when `org-babel-tangle-file' does not make changes.
- ;; This avoids re-tangling changed FILE where the changes did
- ;; not affect the tangled code.
- (when (file-exists-p tangled-file)
- (set-file-times tangled-file))
- (org-babel-tangle-file file
- tangled-file
- (rx string-start
- (or "emacs-lisp" "elisp")
- string-end)))
- (if compile
- (progn
- (byte-compile-file tangled-file)
- (load-file (byte-compile-dest-file tangled-file))
- (message "Compiled and loaded %s" tangled-file))
- (load-file tangled-file)
- (message "Loaded %s" tangled-file))))
- (defcustom org-babel-load-languages '((emacs-lisp . t))
- "Languages which can be evaluated in Org buffers.
- \\<org-mode-map>
- This list can be used to load support for any of the available
- languages with babel support (see info node `(org) Languages'). Each
- language will depend on a different set of system executables and/or
- Emacs modes.
- When a language is \"loaded\", code blocks in that language can
- be evaluated with `org-babel-execute-src-block', which is bound
- by default to \\[org-ctrl-c-ctrl-c].
- The `org-babel-no-eval-on-ctrl-c-ctrl-c' option can be set to
- remove code block evaluation from \\[org-ctrl-c-ctrl-c]. By
- default, only Emacs Lisp is loaded, since it has no specific
- requirement."
- :group 'org-babel
- :set 'org-babel-do-load-languages
- :version "24.1"
- :type '(alist :tag "Babel Languages"
- :key-type
- (choice
- (const :tag "Awk" awk)
- (const :tag "C" C)
- (const :tag "R" R)
- (const :tag "Calc" calc)
- (const :tag "Clojure" clojure)
- (const :tag "CSS" css)
- (const :tag "Ditaa" ditaa)
- (const :tag "Dot" dot)
- (const :tag "Emacs Lisp" emacs-lisp)
- (const :tag "Forth" forth)
- (const :tag "Fortran" fortran)
- (const :tag "Gnuplot" gnuplot)
- (const :tag "Haskell" haskell)
- (const :tag "Java" java)
- (const :tag "Javascript" js)
- (const :tag "LaTeX" latex)
- (const :tag "Lilypond" lilypond)
- (const :tag "Lisp" lisp)
- (const :tag "Makefile" makefile)
- (const :tag "Maxima" maxima)
- (const :tag "Matlab" matlab)
- (const :tag "Ocaml" ocaml)
- (const :tag "Octave" octave)
- (const :tag "Org" org)
- (const :tag "Perl" perl)
- (const :tag "Pico Lisp" picolisp)
- (const :tag "PlantUML" plantuml)
- (const :tag "Python" python)
- (const :tag "Ruby" ruby)
- (const :tag "Sass" sass)
- (const :tag "Scala" scala)
- (const :tag "Scheme" scheme)
- (const :tag "Screen" screen)
- (const :tag "Shell Script" shell)
- (const :tag "Sql" sql)
- (const :tag "Sqlite" sqlite)
- (const :tag "Stan" stan))
- :value-type (boolean :tag "Activate" :value t)))
- ;;;; Customization variables
- (defcustom org-clone-delete-id nil
- "Remove ID property of clones of a subtree.
- When non-nil, clones of a subtree don't inherit the ID property.
- Otherwise they inherit the ID property with a new unique
- identifier."
- :type 'boolean
- :version "24.1"
- :group 'org-id)
- ;;; Version
- (org-check-version)
- ;;;###autoload
- (defun org-version (&optional here full message)
- "Show the Org version.
- Interactively, or when MESSAGE is non-nil, show it in echo area.
- With prefix argument, or when HERE is non-nil, insert it at point.
- In non-interactive uses, a reduced version string is output unless
- FULL is given."
- (interactive (list current-prefix-arg t (not current-prefix-arg)))
- (let ((org-dir (ignore-errors (org-find-library-dir "org")))
- (save-load-suffixes load-suffixes)
- (load-suffixes (list ".el"))
- (org-install-dir
- (ignore-errors (org-find-library-dir "org-loaddefs"))))
- (unless (and (fboundp 'org-release) (fboundp 'org-git-version))
- (org-load-noerror-mustsuffix (concat org-dir "org-version")))
- (let* ((load-suffixes save-load-suffixes)
- (release (org-release))
- (git-version (org-git-version))
- (version (format "Org mode version %s (%s @ %s)"
- release
- git-version
- (if org-install-dir
- (if (string= org-dir org-install-dir)
- org-install-dir
- (concat "mixed installation! "
- org-install-dir
- " and "
- org-dir))
- "org-loaddefs.el can not be found!")))
- (version1 (if full version release)))
- (when here (insert version1))
- (when message (message "%s" version1))
- version1)))
- (defconst org-version (org-version))
- ;;; Syntax Constants
- ;;;; Comments
- (defconst org-comment-regexp
- (rx (seq bol (zero-or-more (any "\t ")) "#" (or " " eol)))
- "Regular expression for comment lines.")
- ;;;; Keyword
- (defconst org-keyword-regexp "^[ \t]*#\\+\\(\\S-+?\\):[ \t]*\\(.*\\)$"
- "Regular expression for keyword-lines.")
- ;;;; Block
- (defconst org-block-regexp
- "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
- "Regular expression for hiding blocks.")
- (defconst org-dblock-start-re
- "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
- "Matches the start line of a dynamic block, with parameters.")
- (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
- "Matches the end of a dynamic block.")
- ;;;; Timestamp
- (defconst org-ts--internal-regexp
- (rx (seq
- (= 4 digit) "-" (= 2 digit) "-" (= 2 digit)
- (optional " " (*? nonl))))
- "Regular expression matching the innards of a time stamp.")
- (defconst org-ts-regexp (format "<\\(%s\\)>" org-ts--internal-regexp)
- "Regular expression for fast time stamp matching.")
- (defconst org-ts-regexp-inactive
- (format "\\[\\(%s\\)\\]" org-ts--internal-regexp)
- "Regular expression for fast inactive time stamp matching.")
- (defconst org-ts-regexp-both (format "[[<]\\(%s\\)[]>]" org-ts--internal-regexp)
- "Regular expression for fast time stamp matching.")
- (defconst org-ts-regexp0
- "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
- "Regular expression matching time strings for analysis.
- This one does not require the space after the date, so it can be used
- on a string that terminates immediately after the date.")
- (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
- "Regular expression matching time strings for analysis.")
- (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
- "Regular expression matching time stamps, with groups.")
- (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
- "Regular expression matching time stamps (also [..]), with groups.")
- (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
- "Regular expression matching a time stamp range.")
- (defconst org-tr-regexp-both
- (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
- "Regular expression matching a time stamp range.")
- (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
- org-ts-regexp "\\)?")
- "Regular expression matching a time stamp or time stamp range.")
- (defconst org-tsr-regexp-both
- (concat org-ts-regexp-both "\\(--?-?"
- org-ts-regexp-both "\\)?")
- "Regular expression matching a time stamp or time stamp range.
- The time stamps may be either active or inactive.")
- (defconst org-repeat-re
- "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\
- \\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
- "Regular expression for specifying repeated events.
- After a match, group 1 contains the repeat expression.")
- (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
- "Formats for `format-time-string' which are used for time stamps.")
- ;;;; Clock and Planning
- (defconst org-clock-string "CLOCK:"
- "String used as prefix for timestamps clocking work hours on an item.")
- (defvar org-closed-string "CLOSED:"
- "String used as the prefix for timestamps logging closing a TODO entry.")
- (defvar org-deadline-string "DEADLINE:"
- "String to mark deadline entries.
- \\<org-mode-map>
- A deadline is this string, followed by a time stamp. It must be
- a word, terminated by a colon. You can insert a schedule keyword
- and a timestamp with `\\[org-deadline]'.")
- (defvar org-scheduled-string "SCHEDULED:"
- "String to mark scheduled TODO entries.
- \\<org-mode-map>
- A schedule is this string, followed by a time stamp. It must be
- a word, terminated by a colon. You can insert a schedule keyword
- and a timestamp with `\\[org-schedule]'.")
- (defconst org-ds-keyword-length
- (+ 2
- (apply #'max
- (mapcar #'length
- (list org-deadline-string org-scheduled-string
- org-clock-string org-closed-string))))
- "Maximum length of the DEADLINE and SCHEDULED keywords.")
- (defconst org-planning-line-re
- (concat "^[ \t]*"
- (regexp-opt
- (list org-closed-string org-deadline-string org-scheduled-string)
- t))
- "Matches a line with planning info.
- Matched keyword is in group 1.")
- (defconst org-clock-line-re
- (concat "^[ \t]*" org-clock-string)
- "Matches a line with clock info.")
- (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
- "Matches the DEADLINE keyword.")
- (defconst org-deadline-time-regexp
- (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
- "Matches the DEADLINE keyword together with a time stamp.")
- (defconst org-deadline-time-hour-regexp
- (concat "\\<" org-deadline-string
- " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9+:hdwmy/ \t.-]*\\)>")
- "Matches the DEADLINE keyword together with a time-and-hour stamp.")
- (defconst org-deadline-line-regexp
- (concat "\\<\\(" org-deadline-string "\\).*")
- "Matches the DEADLINE keyword and the rest of the line.")
- (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
- "Matches the SCHEDULED keyword.")
- (defconst org-scheduled-time-regexp
- (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
- "Matches the SCHEDULED keyword together with a time stamp.")
- (defconst org-scheduled-time-hour-regexp
- (concat "\\<" org-scheduled-string
- " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9+:hdwmy/ \t.-]*\\)>")
- "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
- (defconst org-closed-time-regexp
- (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
- "Matches the CLOSED keyword together with a time stamp.")
- (defconst org-keyword-time-regexp
- (concat "\\<"
- (regexp-opt
- (list org-scheduled-string org-deadline-string org-closed-string
- org-clock-string)
- t)
- " *[[<]\\([^]>]+\\)[]>]")
- "Matches any of the 4 keywords, together with the time stamp.")
- (defconst org-keyword-time-not-clock-regexp
- (concat
- "\\<"
- (regexp-opt
- (list org-scheduled-string org-deadline-string org-closed-string) t)
- " *[[<]\\([^]>]+\\)[]>]")
- "Matches any of the 3 keywords, together with the time stamp.")
- (defconst org-all-time-keywords
- (mapcar (lambda (w) (substring w 0 -1))
- (list org-scheduled-string org-deadline-string
- org-clock-string org-closed-string))
- "List of time keywords.")
- ;;;; Drawer
- (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
- "Matches first or last line of a hidden block.
- Group 1 contains drawer's name or \"END\".")
- (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
- "Regular expression matching the first line of a property drawer.")
- (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
- "Regular expression matching the last line of a property drawer.")
- (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
- "Regular expression matching the first line of a clock drawer.")
- (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
- "Regular expression matching the last line of a clock drawer.")
- (defconst org-logbook-drawer-re
- (rx (seq bol (0+ (any "\t ")) ":LOGBOOK:" (0+ (any "\t ")) "\n"
- (*? (0+ nonl) "\n")
- (0+ (any "\t ")) ":END:" (0+ (any "\t ")) eol))
- "Matches an entire LOGBOOK drawer.")
- (defconst org-property-drawer-re
- (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
- "\\(?:[ \t]*:\\S-+:\\(?:[ \t].*\\)?[ \t]*\n\\)*?"
- "[ \t]*:END:[ \t]*$")
- "Matches an entire property drawer.")
- (defconst org-clock-drawer-re
- (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
- org-clock-drawer-end-re "\\)\n?")
- "Matches an entire clock drawer.")
- ;;;; Headline
- (defconst org-heading-keyword-regexp-format
- "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
- "Printf format for a regexp matching a headline with some keyword.
- This regexp will match the headline of any node which has the
- exact keyword that is put into the format. The keyword isn't in
- any group by default, but the stars and the body are.")
- (defconst org-heading-keyword-maybe-regexp-format
- "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
- "Printf format for a regexp matching a headline, possibly with some keyword.
- This regexp can match any headline with the specified keyword, or
- without a keyword. The keyword isn't in any group by default,
- but the stars and the body are.")
- (defconst org-archive-tag "ARCHIVE"
- "The tag that marks a subtree as archived.
- An archived subtree does not open during visibility cycling, and does
- not contribute to the agenda listings.")
- (defconst org-tag-re "[[:alnum:]_@#%]+"
- "Regexp matching a single tag.")
- (defconst org-tag-group-re "[ \t]+\\(:\\([[:alnum:]_@#%:]+\\):\\)[ \t]*$"
- "Regexp matching the tag group at the end of a line, with leading spaces.
- Tags are stored in match group 1. Match group 2 stores the tags
- without the enclosing colons.")
- (defconst org-tag-line-re
- "^\\*+ \\(?:.*[ \t]\\)?\\(:\\([[:alnum:]_@#%:]+\\):\\)[ \t]*$"
- "Regexp matching tags in a headline.
- Tags are stored in match group 1. Match group 2 stores the tags
- without the enclosing colons.")
- (eval-and-compile
- (defconst org-comment-string "COMMENT"
- "Entries starting with this keyword will never be exported.
- \\<org-mode-map>
- An entry can be toggled between COMMENT and normal with
- `\\[org-toggle-comment]'."))
- ;;;; LaTeX Environments and Fragments
- (defconst org-latex-regexps
- '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
- ;; ("$" "\\([ \t(]\\|^\\)\\(\\(\\([$]\\)\\([^ \t\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \t\n,.$]\\)\\4\\)\\)\\([ \t.,?;:'\")]\\|$\\)" 2 nil)
- ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
- ("$1" "\\([^$]\\|^\\)\\(\\$[^ \t\r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
- ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \t\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \t\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
- ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
- ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
- ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
- "Regular expressions for matching embedded LaTeX.")
- ;;;; Node Property
- (defconst org-effort-property "Effort"
- "The property that is being used to keep track of effort estimates.
- Effort estimates given in this property need to be in the format
- defined in org-duration.el.")
- ;;; The custom variables
- (defgroup org nil
- "Outline-based notes management and organizer."
- :tag "Org"
- :group 'outlines
- :group 'calendar)
- (defcustom org-mode-hook nil
- "Mode hook for Org mode, run after the mode was turned on."
- :group 'org
- :type 'hook)
- (defcustom org-load-hook nil
- "Hook that is run after org.el has been loaded."
- :group 'org
- :type 'hook)
- (make-obsolete-variable
- 'org-load-hook
- "use `with-eval-after-load' instead." "9.5")
- (defcustom org-log-buffer-setup-hook nil
- "Hook that is run after an Org log buffer is created."
- :group 'org
- :version "24.1"
- :type 'hook)
- (defvar org-modules) ; defined below
- (defvar org-modules-loaded nil
- "Have the modules been loaded already?")
- ;;;###autoload
- (defun org-load-modules-maybe (&optional force)
- "Load all extensions listed in `org-modules'."
- (when (or force (not org-modules-loaded))
- (dolist (ext org-modules)
- (condition-case nil (require ext)
- (error (message "Problems while trying to load feature `%s'" ext))))
- (setq org-modules-loaded t)))
- (defun org-set-modules (var value)
- "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
- (set-default-toplevel-value var value)
- (when (featurep 'org)
- (org-load-modules-maybe 'force)
- (org-element-cache-reset 'all)))
- (defcustom org-modules '(ol-doi ol-w3m ol-bbdb ol-bibtex ol-docview ol-gnus ol-info ol-irc ol-mhe ol-rmail ol-eww)
- "Modules that should always be loaded together with org.el.
- If a description starts with <C>, the file is not part of Emacs and Org mode,
- so loading it will require that you have properly installed org-contrib
- package from NonGNU Emacs Lisp Package Archive
- https://elpa.nongnu.org/nongnu/org-contrib.html
- You can also use this system to load external packages (i.e. neither Org
- core modules, nor org-contrib modules). Just add symbols
- to the end of the list. If the package is called org-xyz.el, then you need
- to add the symbol `xyz', and the package must have a call to:
- (provide \\='org-xyz)
- For export specific modules, see also `org-export-backends'."
- :group 'org
- :set 'org-set-modules
- :package-version '(Org . "9.5")
- :type
- '(set :greedy t
- (const :tag " bbdb: Links to BBDB entries" ol-bbdb)
- (const :tag " bibtex: Links to BibTeX entries" ol-bibtex)
- (const :tag " crypt: Encryption of subtrees" org-crypt)
- (const :tag " ctags: Access to Emacs tags with links" org-ctags)
- (const :tag " docview: Links to Docview buffers" ol-docview)
- (const :tag " doi: Links to DOI references" ol-doi)
- (const :tag " eww: Store link to URL of Eww" ol-eww)
- (const :tag " gnus: Links to GNUS folders/messages" ol-gnus)
- (const :tag " habit: Track your consistency with habits" org-habit)
- (const :tag " id: Global IDs for identifying entries" org-id)
- (const :tag " info: Links to Info nodes" ol-info)
- (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
- (const :tag " irc: Links to IRC/ERC chat sessions" ol-irc)
- (const :tag " mhe: Links to MHE folders/messages" ol-mhe)
- (const :tag " mouse: Additional mouse support" org-mouse)
- (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
- (const :tag " rmail: Links to RMAIL folders/messages" ol-rmail)
- (const :tag " tempo: Fast completion for structures" org-tempo)
- (const :tag " w3m: Special cut/paste from w3m to Org mode." ol-w3m)
- (const :tag " eshell: Links to working directories in Eshell" ol-eshell)
- (const :tag "C annotate-file: Annotate a file with Org syntax" org-annotate-file)
- (const :tag "C bookmark: Links to bookmarks" ol-bookmark)
- (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
- (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
- (const :tag "C collector: Collect properties into tables" org-collector)
- (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
- (const :tag "C elisp-symbol: Links to emacs-lisp symbols" ol-elisp-symbol)
- (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
- (const :tag "C eval: Include command output as text" org-eval)
- (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
- (const :tag "C git-link: Links to specific file version" ol-git-link)
- (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
- (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
- (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
- (const :tag "C mac-iCal: Imports events from iCal.app to the Emacs diary" org-mac-iCal)
- (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
- (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
- (const :tag "C man: Links to man pages in Org mode" ol-man)
- (const :tag "C mew: Links to Mew folders/messages" ol-mew)
- (const :tag "C notify: Notifications for Org mode" org-notify)
- (const :tag "C notmuch: Provide Org links to notmuch searches or messages" ol-notmuch)
- (const :tag "C panel: Simple routines for us with bad memory" org-panel)
- (const :tag "C registry: A registry for Org links" org-registry)
- (const :tag "C screen: Visit screen sessions through links" org-screen)
- (const :tag "C screenshot: Take and manage screenshots in Org files" org-screenshot)
- (const :tag "C secretary: Team management with Org" org-secretary)
- (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
- (const :tag "C toc: Table of contents for Org buffer" org-toc)
- (const :tag "C track: Keep up with Org mode development" org-track)
- (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
- (const :tag "C vm: Links to VM folders/messages" ol-vm)
- (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
- (const :tag "C wl: Links to Wanderlust folders/messages" ol-wl)
- (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
- (defvar org-export-registered-backends) ; From ox.el.
- (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
- (declare-function org-export-backend-name "ox" (backend) t)
- (defcustom org-export-backends '(ascii html icalendar latex odt)
- "List of export back-ends that should be always available.
- If a description starts with <C>, the file is not part of Emacs and Org mode,
- so loading it will require that you have properly installed org-contrib
- package from NonGNU Emacs Lisp Package Archive
- https://elpa.nongnu.org/nongnu/org-contrib.html
- Unlike to `org-modules', libraries in this list will not be
- loaded along with Org, but only once the export framework is
- needed.
- This variable needs to be set before org.el is loaded. If you
- need to make a change while Emacs is running, use the customize
- interface or run the following code, where VAL stands for the new
- value of the variable, after updating it:
- (progn
- (setq org-export-registered-backends
- (cl-remove-if-not
- (lambda (backend)
- (let ((name (org-export-backend-name backend)))
- (or (memq name val)
- (catch \\='parentp
- (dolist (b val)
- (and (org-export-derived-backend-p b name)
- (throw \\='parentp t)))))))
- org-export-registered-backends))
- (let ((new-list (mapcar #\\='org-export-backend-name
- org-export-registered-backends)))
- (dolist (backend val)
- (cond
- ((not (load (format \"ox-%s\" backend) t t))
- (message \"Problems while trying to load export back-end \\=`%s\\='\"
- backend))
- ((not (memq backend new-list)) (push backend new-list))))
- (set-default \\='org-export-backends new-list)))
- Adding a back-end to this list will also pull the back-end it
- depends on, if any."
- :group 'org
- :group 'org-export
- :version "26.1"
- :package-version '(Org . "9.0")
- :initialize 'custom-initialize-set
- :set (lambda (var val)
- (if (not (featurep 'ox)) (set-default-toplevel-value var val)
- ;; Any back-end not required anymore (not present in VAL and not
- ;; a parent of any back-end in the new value) is removed from the
- ;; list of registered back-ends.
- (setq org-export-registered-backends
- (cl-remove-if-not
- (lambda (backend)
- (let ((name (org-export-backend-name backend)))
- (or (memq name val)
- (catch 'parentp
- (dolist (b val)
- (and (org-export-derived-backend-p b name)
- (throw 'parentp t)))))))
- org-export-registered-backends))
- ;; Now build NEW-LIST of both new back-ends and required
- ;; parents.
- (let ((new-list (mapcar #'org-export-backend-name
- org-export-registered-backends)))
- (dolist (backend val)
- (cond
- ((not (load (format "ox-%s" backend) t t))
- (message "Problems while trying to load export back-end `%s'"
- backend))
- ((not (memq backend new-list)) (push backend new-list))))
- ;; Set VAR to that list with fixed dependencies.
- (set-default-toplevel-value var new-list))))
- :type '(set :greedy t
- (const :tag " ascii Export buffer to ASCII format" ascii)
- (const :tag " beamer Export buffer to Beamer presentation" beamer)
- (const :tag " html Export buffer to HTML format" html)
- (const :tag " icalendar Export buffer to iCalendar format" icalendar)
- (const :tag " latex Export buffer to LaTeX format" latex)
- (const :tag " man Export buffer to MAN format" man)
- (const :tag " md Export buffer to Markdown format" md)
- (const :tag " odt Export buffer to ODT format" odt)
- (const :tag " org Export buffer to Org format" org)
- (const :tag " texinfo Export buffer to Texinfo format" texinfo)
- (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
- (const :tag "C deck Export buffer to deck.js presentations" deck)
- (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
- (const :tag "C groff Export buffer to Groff format" groff)
- (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
- (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
- (const :tag "C s5 Export buffer to s5 presentations" s5)
- (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
- (eval-after-load 'ox
- '(dolist (backend org-export-backends)
- (condition-case nil (require (intern (format "ox-%s" backend)))
- (error (message "Problems while trying to load export back-end `%s'"
- backend)))))
- (defcustom org-support-shift-select nil
- "Non-nil means make shift-cursor commands select text when possible.
- \\<org-mode-map>
- In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
- start selecting a region, or enlarge regions started in this way.
- In Org mode, in special contexts, these same keys are used for
- other purposes, important enough to compete with shift selection.
- Org tries to balance these needs by supporting `shift-select-mode'
- outside these special contexts, under control of this variable.
- The default of this variable is nil, to avoid confusing behavior. Shifted
- cursor keys will then execute Org commands in the following contexts:
- - on a headline, changing TODO state (left/right) and priority (up/down)
- - on a time stamp, changing the time
- - in a plain list item, changing the bullet type
- - in a property definition line, switching between allowed values
- - in the BEGIN line of a clock table (changing the time block).
- - in a table, moving the cell in the specified direction.
- Outside these contexts, the commands will throw an error.
- When this variable is t and the cursor is not in a special
- context, Org mode will support shift-selection for making and
- enlarging regions. To make this more effective, the bullet
- cycling will no longer happen anywhere in an item line, but only
- if the cursor is exactly on the bullet.
- If you set this variable to the symbol `always', then the keys
- will not be special in headlines, property lines, item lines, and
- table cells, to make shift selection work there as well. If this is
- what you want, you can use the following alternative commands:
- `\\[org-todo]' and `\\[org-priority]' \
- to change TODO state and priority,
- `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
- can be used to switch TODO sets,
- `\\[org-ctrl-c-minus]' to cycle item bullet types,
- and properties can be edited by hand or in column view.
- However, when the cursor is on a timestamp, shift-cursor commands
- will still edit the time stamp - this is just too good to give up."
- :group 'org
- :type '(choice
- (const :tag "Never" nil)
- (const :tag "When outside special context" t)
- (const :tag "Everywhere except timestamps" always)))
- (defcustom org-loop-over-headlines-in-active-region t
- "Shall some commands act upon headlines in the active region?
- When set to t, some commands will be performed in all headlines
- within the active region.
- When set to `start-level', some commands will be performed in all
- headlines within the active region, provided that these headlines
- are of the same level than the first one.
- When set to a string, those commands will be performed on the
- matching headlines within the active region. Such string must be
- a tags/property/todo match as it is used in the agenda tags view.
- The list of commands is: `org-schedule', `org-deadline',
- `org-todo', `org-set-tags-command', `org-archive-subtree',
- `org-archive-set-tag', `org-toggle-archive-tag' and
- `org-archive-to-archive-sibling'. The archiving commands skip
- already archived entries.
- See `org-agenda-loop-over-headlines-in-active-region' for the
- equivalent option for agenda views."
- :type '(choice (const :tag "Don't loop" nil)
- (const :tag "All headlines in active region" t)
- (const :tag "In active region, headlines at the same level than the first one" start-level)
- (string :tag "Tags/Property/Todo matcher"))
- :package-version '(Org . "9.4")
- :group 'org-todo
- :group 'org-archive)
- (defcustom org-startup-folded 'showeverything
- "Non-nil means entering Org mode will switch to OVERVIEW.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: fold (or `overview', this is equivalent)
- #+STARTUP: nofold (or `showall', this is equivalent)
- #+STARTUP: content
- #+STARTUP: show<n>levels (<n> = 2..5)
- #+STARTUP: showeverything
- Set `org-agenda-inhibit-startup' to a non-nil value if you want
- to ignore this option when Org opens agenda files for the first
- time."
- :group 'org-startup
- :package-version '(Org . "9.4")
- :type '(choice
- (const :tag "nofold: show all" nil)
- (const :tag "fold: overview" t)
- (const :tag "fold: show two levels" show2levels)
- (const :tag "fold: show three levels" show3levels)
- (const :tag "fold: show four levels" show4evels)
- (const :tag "fold: show five levels" show5levels)
- (const :tag "content: all headlines" content)
- (const :tag "show everything, even drawers" showeverything)))
- (defcustom org-startup-truncated t
- "Non-nil means entering Org mode will set `truncate-lines'.
- This is useful since some lines containing links can be very long and
- uninteresting. Also tables look terrible when wrapped.
- The variable `org-startup-truncated' allows to configure
- truncation for Org mode different to the other modes that use the
- variable `truncate-lines' and as a shortcut instead of putting
- the variable `truncate-lines' into the `org-mode-hook'. If one
- wants to configure truncation for Org mode not statically but
- dynamically e.g. in a hook like `ediff-prepare-buffer-hook' then
- the variable `truncate-lines' has to be used because in such a
- case it is too late to set the variable `org-startup-truncated'."
- :group 'org-startup
- :type 'boolean)
- (defcustom org-startup-indented nil
- "Non-nil means turn on `org-indent-mode' on startup.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: indent
- #+STARTUP: noindent"
- :group 'org-structure
- :type '(choice
- (const :tag "Not" nil)
- (const :tag "Globally (slow on startup in large files)" t)))
- (defcustom org-startup-numerated nil
- "Non-nil means turn on `org-num-mode' on startup.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: num
- #+STARTUP: nonum"
- :group 'org-structure
- :package-version '(Org . "9.4")
- :type '(choice
- (const :tag "Not" nil)
- (const :tag "Globally" t)))
- (defcustom org-use-sub-superscripts t
- "Non-nil means interpret \"_\" and \"^\" for display.
- If you want to control how Org exports those characters, see
- `org-export-with-sub-superscripts'.
- When this option is turned on, you can use TeX-like syntax for
- sub- and superscripts within the buffer. Several characters after
- \"_\" or \"^\" will be considered as a single item - so grouping
- with {} is normally not needed. For example, the following things
- will be parsed as single sub- or superscripts:
- 10^24 or 10^tau several digits will be considered 1 item.
- 10^-12 or 10^-tau a leading sign with digits or a word
- x^2-y^3 will be read as x^2 - y^3, because items are
- terminated by almost any nonword/nondigit char.
- x_{i^2} or x^(2-i) braces or parenthesis do grouping.
- Still, ambiguity is possible. So when in doubt, use {} to enclose
- the sub/superscript. If you set this variable to the symbol `{}',
- the braces are *required* in order to trigger interpretations as
- sub/superscript. This can be helpful in documents that need \"_\"
- frequently in plain text."
- :group 'org-startup
- :version "24.4"
- :package-version '(Org . "8.0")
- :type '(choice
- (const :tag "Always interpret" t)
- (const :tag "Only with braces" {})
- (const :tag "Never interpret" nil)))
- (defcustom org-startup-with-beamer-mode nil
- "Non-nil means turn on `org-beamer-mode' on startup.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: beamer"
- :group 'org-startup
- :version "24.1"
- :type 'boolean)
- (defcustom org-startup-align-all-tables nil
- "Non-nil means align all tables when visiting a file.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: align
- #+STARTUP: noalign"
- :group 'org-startup
- :type 'boolean)
- (defcustom org-startup-shrink-all-tables nil
- "Non-nil means shrink all table columns with a width cookie.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: shrink"
- :group 'org-startup
- :type 'boolean
- :version "27.1"
- :package-version '(Org . "9.2")
- :safe #'booleanp)
- (defcustom org-startup-with-inline-images nil
- "Non-nil means show inline images when loading a new Org file.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: inlineimages
- #+STARTUP: noinlineimages"
- :group 'org-startup
- :version "24.1"
- :type 'boolean)
- (defcustom org-startup-with-latex-preview nil
- "Non-nil means preview LaTeX fragments when loading a new Org file.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: latexpreview
- #+STARTUP: nolatexpreview"
- :group 'org-startup
- :version "24.4"
- :package-version '(Org . "8.0")
- :type 'boolean)
- (defcustom org-insert-mode-line-in-empty-file nil
- "Non-nil means insert the first line setting Org mode in empty files.
- When the function `org-mode' is called interactively in an empty file, this
- normally means that the file name does not automatically trigger Org mode.
- To ensure that the file will always be in Org mode in the future, a
- line enforcing Org mode will be inserted into the buffer, if this option
- has been set."
- :group 'org-startup
- :type 'boolean)
- (defcustom org-ellipsis nil
- "The ellipsis to use in the Org mode outline.
- When nil, just use the standard three dots. When a non-empty string,
- use that string instead.
- The change affects only Org mode (which will then use its own display table).
- Changing this requires executing `\\[org-mode]' in a buffer to become
- effective. It cannot be set as a local variable."
- :group 'org-startup
- :type '(choice (const :tag "Default" nil)
- (string :tag "String" :value "...#")))
- (defvar org-display-table nil
- "The display table for Org mode, in case `org-ellipsis' is non-nil.")
- (defcustom org-directory "~/org"
- "Directory with Org files.
- This is just a default location to look for Org files. There is no need
- at all to put your files into this directory. It is used in the
- following situations:
- 1. When a capture template specifies a target file that is not an
- absolute path. The path will then be interpreted relative to
- `org-directory'
- 2. When the value of variable `org-agenda-files' is a single file, any
- relative paths in this file will be taken as relative to
- `org-directory'."
- :group 'org-refile
- :group 'org-capture
- :type 'directory)
- (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
- "Default target for storing notes.
- Used as a fall back file for org-capture.el, for templates that
- do not specify a target file."
- :group 'org-refile
- :group 'org-capture
- :type 'file)
- (defcustom org-reverse-note-order nil
- "Non-nil means store new notes at the beginning of a file or entry.
- When nil, new notes will be filed to the end of a file or entry.
- This can also be a list with cons cells of regular expressions that
- are matched against file names, and values."
- :group 'org-capture
- :group 'org-refile
- :type '(choice
- (const :tag "Reverse always" t)
- (const :tag "Reverse never" nil)
- (repeat :tag "By file name regexp"
- (cons regexp boolean))))
- (defgroup org-keywords nil
- "Keywords in Org mode."
- :tag "Org Keywords"
- :group 'org)
- (defcustom org-closed-keep-when-no-todo nil
- "Remove CLOSED: time-stamp when switching back to a non-todo state?"
- :group 'org-todo
- :group 'org-keywords
- :version "24.4"
- :package-version '(Org . "8.0")
- :type 'boolean)
- (defgroup org-structure nil
- "Options concerning the general structure of Org files."
- :tag "Org Structure"
- :group 'org)
- (defcustom org-indirect-buffer-display 'other-window
- "How should indirect tree buffers be displayed?
- This applies to indirect buffers created with the commands
- `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
- Valid values are:
- current-window Display in the current window
- other-window Just display in another window.
- dedicated-frame Create one new frame, and re-use it each time.
- new-frame Make a new frame each time. Note that in this case
- previously-made indirect buffers are kept, and you need to
- kill these buffers yourself."
- :group 'org-structure
- :group 'org-agenda-windows
- :type '(choice
- (const :tag "In current window" current-window)
- (const :tag "In current frame, other window" other-window)
- (const :tag "Each time a new frame" new-frame)
- (const :tag "One dedicated frame" dedicated-frame)))
- (defconst org-file-apps-gnu
- '((remote . emacs)
- (system . mailcap)
- (t . mailcap))
- "Default file applications on a UNIX or GNU/Linux system.
- See `org-file-apps'.")
- (defconst org-file-apps-macos
- '((remote . emacs)
- (system . "open %s")
- ("ps.gz" . "gv %s")
- ("eps.gz" . "gv %s")
- ("dvi" . "xdvi %s")
- ("fig" . "xfig %s")
- (t . "open %s"))
- "Default file applications on a macOS system.
- The system \"open\" is known as a default, but we use X11 applications
- for some files for which the OS does not have a good default.
- See `org-file-apps'.")
- (defconst org-file-apps-windowsnt
- (list '(remote . emacs)
- (cons 'system (lambda (file _path)
- (with-no-warnings (w32-shell-execute "open" file))))
- (cons t (lambda (file _path)
- (with-no-warnings (w32-shell-execute "open" file)))))
- "Default file applications on a Windows NT system.
- The system \"open\" is used for most files.
- See `org-file-apps'.")
- (defcustom org-file-apps
- '((auto-mode . emacs)
- (directory . emacs)
- ("\\.mm\\'" . default)
- ("\\.x?html?\\'" . default)
- ("\\.pdf\\'" . default))
- "Applications for opening `file:path' items in a document.
- \\<org-mode-map>
- Org mode uses system defaults for different file types, but you
- can use this variable to set the application for a given file
- extension. The entries in this list are cons cells where the car
- identifies files and the cdr the corresponding command.
- Possible values for the file identifier are:
- \"string\" A string as a file identifier can be interpreted in different
- ways, depending on its contents:
- - Alphanumeric characters only:
- Match links with this file extension.
- Example: (\"pdf\" . \"evince %s\")
- to open PDFs with evince.
- - Regular expression: Match links where the
- filename matches the regexp. If you want to
- use groups here, use shy groups.
- Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
- (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
- to open *.html and *.xhtml with firefox.
- - Regular expression which contains (non-shy) groups:
- Match links where the whole link, including \"::\", and
- anything after that, matches the regexp.
- In a custom command string, %1, %2, etc. are replaced with
- the parts of the link that were matched by the groups.
- For backwards compatibility, if a command string is given
- that does not use any of the group matches, this case is
- handled identically to the second one (i.e. match against
- file name only).
- In a custom function, you can access the group matches with
- (match-string n link).
- Example: (\"\\\\.pdf::\\\\([0-9]+\\\\)\\\\\\='\" . \
- \"evince -p %1 %s\")
- to open [[file:document.pdf::5]] with evince at page 5.
- Likely, you will need more entries: without page
- number; with search pattern; with cross-reference
- anchor; some combination of options. Consider simple
- pattern here and a Lisp function to determine command
- line arguments instead. Passing argument list to
- `call-process' or `make-process' directly allows to
- avoid treating some character in peculiar file names
- as shell specialls causing executing part of file
- name as a subcommand.
- `directory' Matches a directory
- `remote' Matches a remote file, accessible through tramp or efs.
- Remote files most likely should be visited through Emacs
- because external applications cannot handle such paths.
- `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
- so all files Emacs knows how to handle. Using this with
- command `emacs' will open most files in Emacs. Beware that this
- will also open html files inside Emacs, unless you add
- (\"html\" . default) to the list as well.
- `system' The system command to open files, like `open' on Windows
- and macOS, and mailcap under GNU/Linux. This is the command
- that will be selected if you call `org-open-at-point' with a
- double prefix argument (`\\[universal-argument] \
- \\[universal-argument] \\[org-open-at-point]').
- t Default for files not matched by any of the other options.
- Possible values for the command are:
- `emacs' The file will be visited by the current Emacs process.
- `default' Use the default application for this file type, which is the
- association for t in the list, most likely in the system-specific
- part. This can be used to overrule an unwanted setting in the
- system-specific variable.
- `system' Use the system command for opening files, like \"open\".
- This command is specified by the entry whose car is `system'.
- Most likely, the system-specific version of this variable
- does define this command, but you can overrule/replace it
- here.
- `mailcap' Use command specified in the mailcaps.
- string A command to be executed by a shell; %s will be replaced
- by the path to the file.
- function A Lisp function, which will be called with two arguments:
- the file path and the original link string, without the
- \"file:\" prefix.
- For more examples, see the system specific constants
- `org-file-apps-macos'
- `org-file-apps-windowsnt'
- `org-file-apps-gnu'."
- :group 'org
- :package-version '(Org . "9.4")
- :type '(repeat
- (cons (choice :value ""
- (string :tag "Extension")
- (const :tag "System command to open files" system)
- (const :tag "Default for unrecognized files" t)
- (const :tag "Remote file" remote)
- (const :tag "Links to a directory" directory)
- (const :tag "Any files that have Emacs modes"
- auto-mode))
- (choice :value ""
- (const :tag "Visit with Emacs" emacs)
- (const :tag "Use default" default)
- (const :tag "Use the system command" system)
- (string :tag "Command")
- (function :tag "Function")))))
- (defcustom org-resource-download-policy 'prompt
- "The policy applied to requests to obtain remote resources.
- This affects keywords like #+setupfile and #+incude on export,
- `org-persist-write:url',and `org-attach-url' in non-interactive
- Emacs sessions.
- This recognises four possible values:
- - t, remote resources should always be downloaded.
- - prompt, you will be prompted to download resources nt considered safe.
- - safe, only resources considered safe will be downloaded.
- - nil, never download remote resources.
- A resource is considered safe if it matches one of the patterns
- in `org-safe-remote-resources'."
- :group 'org
- :type '(choice (const :tag "Always download remote resources" t)
- (const :tag "Prompt before downloading an unsafe resource" prompt)
- (const :tag "Only download resources considered safe" safe)
- (const :tag "Never download any resources" nil)))
- (defcustom org-safe-remote-resources nil
- "A list of regexp patterns matching safe URIs.
- URI regexps are applied to both URLs and Org files requesting
- remote resources."
- :group 'org
- :type '(list regexp))
- (defcustom org-open-non-existing-files nil
- "Non-nil means `org-open-file' opens non-existing files.
- When nil, an error is thrown.
- This variable applies only to external applications because they
- might choke on non-existing files. If the link is to a file that
- will be opened in Emacs, the variable is ignored."
- :group 'org
- :type 'boolean
- :safe #'booleanp)
- (defcustom org-open-directory-means-index-dot-org nil
- "When non-nil a link to a directory really means to \"index.org\".
- When nil, following a directory link runs Dired or opens
- a finder/explorer window on that directory."
- :group 'org
- :type 'boolean
- :safe #'booleanp)
- (defcustom org-bookmark-names-plist
- '(:last-capture "org-capture-last-stored"
- :last-refile "org-refile-last-stored"
- :last-capture-marker "org-capture-last-stored-marker")
- "Names for bookmarks automatically set by some Org commands.
- This can provide strings as names for a number of bookmarks Org sets
- automatically. The following keys are currently implemented:
- :last-capture
- :last-capture-marker
- :last-refile
- When a key does not show up in the property list, the corresponding bookmark
- is not set."
- :group 'org-structure
- :type 'plist)
- (defgroup org-edit-structure nil
- "Options concerning structure editing in Org mode."
- :tag "Org Edit Structure"
- :group 'org-structure)
- (defcustom org-odd-levels-only nil
- "Non-nil means skip even levels and only use odd levels for the outline.
- This has the effect that two stars are being added/taken away in
- promotion/demotion commands. It also influences how levels are
- handled by the exporters.
- Changing it requires restart of `font-lock-mode' to become effective
- for fontification also in regions already fontified.
- You may also set this on a per-file basis by adding one of the following
- lines to the buffer:
- #+STARTUP: odd
- #+STARTUP: oddeven"
- :group 'org-edit-structure
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-adapt-indentation nil
- "Non-nil means adapt indentation to outline node level.
- When set to t, Org assumes that you write outlines by indenting
- text in each node to align with the headline, after the stars.
- When this variable is set to `headline-data', Org only adapts the
- indentation of the data lines right below the headline, such as
- planning/clock lines and property/logbook drawers.
- The following issues are influenced by this variable:
- - The indentation is increased by one space in a demotion
- command, and decreased by one in a promotion command. However,
- in the latter case, if shifting some line in the entry body
- would alter document structure (e.g., insert a new headline),
- indentation is not changed at all.
- - Property drawers and planning information is inserted indented
- when this variable is set. When nil, they will not be indented.
- - TAB indents a line relative to current level. The lines below
- a headline will be indented when this variable is set to t.
- Note that this is all about true indentation, by adding and
- removing space characters. See also \"org-indent.el\" which does
- level-dependent indentation in a virtual way, i.e. at display
- time in Emacs."
- :group 'org-edit-structure
- :type '(choice
- (const :tag "Adapt indentation for all lines" t)
- (const :tag "Adapt indentation for headline data lines"
- headline-data)
- (const :tag "Do not adapt indentation at all" nil))
- :safe (lambda (x) (memq x '(t nil headline-data))))
- (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
- (defcustom org-special-ctrl-a/e nil
- "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
- When t, `C-a' will bring back the cursor to the beginning of the
- headline text, i.e. after the stars and after a possible TODO
- keyword. In an item, this will be the position after bullet and
- check-box, if any. When the cursor is already at that position,
- another `C-a' will bring it to the beginning of the line.
- `C-e' will jump to the end of the headline, ignoring the presence
- of tags in the headline. A second `C-e' will then jump to the
- true end of the line, after any tags. This also means that, when
- this variable is non-nil, `C-e' also will never jump beyond the
- end of the heading of a folded section, i.e. not after the
- ellipses.
- When set to the symbol `reversed', the first `C-a' or `C-e' works
- normally, going to the true line boundary first. Only a directly
- following, identical keypress will bring the cursor to the
- special positions.
- This may also be a cons cell where the behavior for `C-a' and
- `C-e' is set separately."
- :group 'org-edit-structure
- :type '(choice
- (const :tag "off" nil)
- (const :tag "on: after stars/bullet and before tags first" t)
- (const :tag "reversed: true line boundary first" reversed)
- (cons :tag "Set C-a and C-e separately"
- (choice :tag "Special C-a"
- (const :tag "off" nil)
- (const :tag "on: after stars/bullet first" t)
- (const :tag "reversed: before stars/bullet first" reversed))
- (choice :tag "Special C-e"
- (const :tag "off" nil)
- (const :tag "on: before tags first" t)
- (const :tag "reversed: after tags first" reversed)))))
- (defcustom org-special-ctrl-k nil
- "Non-nil means `C-k' will behave specially in headlines.
- When nil, `C-k' will call the default `kill-line' command.
- When t, the following will happen while the cursor is in the headline:
- - When at the beginning of a headline, kill the entire subtree.
- - When in the middle of the headline text, kill the text up to the tags.
- - When after the headline text and before the tags, kill all the tags."
- :group 'org-edit-structure
- :type 'boolean)
- (defcustom org-ctrl-k-protect-subtree nil
- "Non-nil means, do not delete a hidden subtree with `C-k'.
- When set to the symbol `error', simply throw an error when `C-k' is
- used to kill (part-of) a headline that has hidden text behind it.
- Any other non-nil value will result in a query to the user, if it is
- OK to kill that hidden subtree. When nil, kill without remorse."
- :group 'org-edit-structure
- :version "24.1"
- :type '(choice
- (const :tag "Do not protect hidden subtrees" nil)
- (const :tag "Protect hidden subtrees with a security query" t)
- (const :tag "Never kill a hidden subtree with C-k" error)))
- (defcustom org-special-ctrl-o t
- "Non-nil means, make `open-line' (\\[open-line]) insert a row in tables."
- :group 'org-edit-structure
- :type 'boolean)
- (defcustom org-yank-folded-subtrees t
- "Non-nil means when yanking subtrees, fold them.
- If the kill is a single subtree, or a sequence of subtrees, i.e. if
- it starts with a heading and all other headings in it are either children
- or siblings, then fold all the subtrees. However, do this only if no
- text after the yank would be swallowed into a folded tree by this action."
- :group 'org-edit-structure
- :type 'boolean)
- (defcustom org-yank-adjusted-subtrees nil
- "Non-nil means when yanking subtrees, adjust the level.
- With this setting, `org-paste-subtree' is used to insert the subtree, see
- this function for details."
- :group 'org-edit-structure
- :type 'boolean)
- (defcustom org-M-RET-may-split-line '((default . t))
- "Non-nil means M-RET will split the line at the cursor position.
- When nil, it will go to the end of the line before making a
- new line.
- You may also set this option in a different way for different
- contexts. Valid contexts are:
- headline when creating a new headline
- item when creating a new item
- table in a table field
- default the value to be used for all contexts not explicitly
- customized"
- :group 'org-structure
- :group 'org-table
- :type '(choice
- (const :tag "Always" t)
- (const :tag "Never" nil)
- (repeat :greedy t :tag "Individual contexts"
- (cons
- (choice :tag "Context"
- (const headline)
- (const item)
- (const table)
- (const default))
- (boolean)))))
- (defcustom org-insert-heading-respect-content nil
- "Non-nil means insert new headings after the current subtree.
- \\<org-mode-map>
- When nil, the new heading is created directly after the current line.
- The commands `\\[org-insert-heading-respect-content]' and \
- `\\[org-insert-todo-heading-respect-content]' turn this variable on
- for the duration of the command."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-blank-before-new-entry '((heading . auto)
- (plain-list-item . auto))
- "Should `org-insert-heading' leave a blank line before new heading/item?
- The value is an alist, with `heading' and `plain-list-item' as CAR,
- and a boolean flag as CDR. The cdr may also be the symbol `auto', in
- which case Org will look at the surrounding headings/items and try to
- make an intelligent decision whether to insert a blank line or not."
- :group 'org-edit-structure
- :type '(list
- (cons (const heading)
- (choice (const :tag "Never" nil)
- (const :tag "Always" t)
- (const :tag "Auto" auto)))
- (cons (const plain-list-item)
- (choice (const :tag "Never" nil)
- (const :tag "Always" t)
- (const :tag "Auto" auto)))))
- (defcustom org-insert-heading-hook nil
- "Hook being run after inserting a new heading."
- :group 'org-edit-structure
- :type 'hook)
- (defgroup org-sparse-trees nil
- "Options concerning sparse trees in Org mode."
- :tag "Org Sparse Trees"
- :group 'org-structure)
- (defcustom org-highlight-sparse-tree-matches t
- "Non-nil means highlight all matches that define a sparse tree.
- The highlights will automatically disappear the next time the buffer is
- changed by an edit command."
- :group 'org-sparse-trees
- :type 'boolean)
- (defcustom org-remove-highlights-with-change t
- "Non-nil means any change to the buffer will remove temporary highlights.
- \\<org-mode-map>\
- Such highlights are created by `org-occur' and `org-clock-display'.
- When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
- to get rid of the highlights.
- The highlights created by `org-latex-preview' always need
- `\\[org-latex-preview]' to be removed."
- :group 'org-sparse-trees
- :group 'org-time
- :type 'boolean)
- (defcustom org-occur-case-fold-search t
- "Non-nil means `org-occur' should be case-insensitive.
- If set to `smart' the search will be case-insensitive only if it
- doesn't specify any upper case character."
- :group 'org-sparse-trees
- :version "26.1"
- :type '(choice
- (const :tag "Case-sensitive" nil)
- (const :tag "Case-insensitive" t)
- (const :tag "Case-insensitive for lower case searches only" smart)))
- (defcustom org-occur-hook '(org-first-headline-recenter)
- "Hook that is run after `org-occur' has constructed a sparse tree.
- This can be used to recenter the window to show as much of the structure
- as possible."
- :group 'org-sparse-trees
- :type 'hook)
- (defcustom org-self-insert-cluster-for-undo nil
- "Non-nil means cluster self-insert commands for undo when possible.
- If this is set, then, like in the Emacs command loop, 20 consecutive
- characters will be undone together.
- This is configurable, because there is some impact on typing performance."
- :group 'org-table
- :type 'boolean)
- (defvaralias 'org-activate-links 'org-highlight-links)
- (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
- "Types of links that should be highlighted in Org files.
- This is a list of symbols, each one of them leading to the
- highlighting of a certain link type.
- You can still open links that are not highlighted.
- In principle, it does not hurt to turn on highlighting for all
- link types. There may be a small gain when turning off unused
- link types. The types are:
- bracket The recommended [[link][description]] or [[link]] links with hiding.
- angle Links in angular brackets that may contain whitespace like
- <bbdb:Carsten Dominik>.
- plain Plain links in normal text, no whitespace, like https://gnu.org.
- radio Text that is matched by a radio target, see manual for details.
- tag Tag settings in a headline (link to tag search).
- date Time stamps (link to calendar).
- footnote Footnote labels.
- If you set this variable during an Emacs session, use `org-mode-restart'
- in the Org buffer so that the change takes effect."
- :group 'org-appearance
- :type '(set :greedy t
- (const :tag "Double bracket links" bracket)
- (const :tag "Angular bracket links" angle)
- (const :tag "Plain text links" plain)
- (const :tag "Radio target matches" radio)
- (const :tag "Tags" tag)
- (const :tag "Timestamps" date)
- (const :tag "Footnotes" footnote)))
- (defcustom org-mark-ring-length 4
- "Number of different positions to be recorded in the ring.
- Changing this requires a restart of Emacs to work correctly."
- :group 'org-link-follow
- :type 'integer)
- (defgroup org-todo nil
- "Options concerning TODO items in Org mode."
- :tag "Org TODO"
- :group 'org)
- (defgroup org-progress nil
- "Options concerning Progress logging in Org mode."
- :tag "Org Progress"
- :group 'org-time)
- (defvar org-todo-interpretation-widgets
- '((:tag "Sequence (cycling hits every state)" sequence)
- (:tag "Type (cycling directly to DONE)" type))
- "The available interpretation symbols for customizing `org-todo-keywords'.
- Interested libraries should add to this list.")
- (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
- "List of TODO entry keyword sequences and their interpretation.
- \\<org-mode-map>This is a list of sequences.
- Each sequence starts with a symbol, either `sequence' or `type',
- indicating if the keywords should be interpreted as a sequence of
- action steps, or as different types of TODO items. The first
- keywords are states requiring action - these states will select a headline
- for inclusion into the global TODO list Org produces. If one of the
- \"keywords\" is the vertical bar, \"|\", the remaining keywords
- signify that no further action is necessary. If \"|\" is not found,
- the last keyword is treated as the only DONE state of the sequence.
- The command `\\[org-todo]' cycles an entry through these states, and one
- additional state where no keyword is present. For details about this
- cycling, see the manual.
- TODO keywords and interpretation can also be set on a per-file basis with
- the special #+SEQ_TODO and #+TYP_TODO lines.
- Each keyword can optionally specify a character for fast state selection
- \(in combination with the variable `org-use-fast-todo-selection')
- and specifiers for state change logging, using the same syntax that
- is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
- the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
- indicates to record a time stamp each time this state is selected.
- Each keyword may also specify if a timestamp or a note should be
- recorded when entering or leaving the state, by adding additional
- characters in the parenthesis after the keyword. This looks like this:
- \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
- record only the time of the state change. With X and Y being either
- \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
- Y when leaving the state if and only if the *target* state does not
- define X. You may omit any of the fast-selection key or X or /Y,
- so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
- For backward compatibility, this variable may also be just a list
- of keywords. In this case the interpretation (sequence or type) will be
- taken from the (otherwise obsolete) variable `org-todo-interpretation'."
- :group 'org-todo
- :group 'org-keywords
- :type '(choice
- (repeat :tag "Old syntax, just keywords"
- (string :tag "Keyword"))
- (repeat :tag "New syntax"
- (cons
- (choice
- :tag "Interpretation"
- ;;Quick and dirty way to see
- ;;`org-todo-interpretation'. This takes the
- ;;place of item arguments
- :convert-widget
- (lambda (widget)
- (widget-put widget
- :args (mapcar
- (lambda (x)
- (widget-convert
- (cons 'const x)))
- org-todo-interpretation-widgets))
- widget))
- (repeat
- (string :tag "Keyword"))))))
- (defvar-local org-todo-keywords-1 nil
- "All TODO and DONE keywords active in a buffer.")
- (defvar org-todo-keywords-for-agenda nil)
- (defvar org-done-keywords-for-agenda nil)
- (defvar org-todo-keyword-alist-for-agenda nil)
- (defvar org-tag-alist-for-agenda nil
- "Alist of all tags from all agenda files.")
- (defvar org-tag-groups-alist-for-agenda nil
- "Alist of all groups tags from all current agenda files.")
- (defvar-local org-tag-groups-alist nil)
- (defvar org-agenda-contributing-files nil)
- (defvar-local org-current-tag-alist nil
- "Alist of all tag groups in current buffer.
- This variable takes into consideration `org-tag-alist',
- `org-tag-persistent-alist' and TAGS keywords in the buffer.")
- (defvar-local org-not-done-keywords nil)
- (defvar-local org-done-keywords nil)
- (defvar-local org-todo-heads nil)
- (defvar-local org-todo-sets nil)
- (defvar-local org-todo-log-states nil)
- (defvar-local org-todo-kwd-alist nil)
- (defvar-local org-todo-key-alist nil)
- (defvar-local org-todo-key-trigger nil)
- (defcustom org-todo-interpretation 'sequence
- "Controls how TODO keywords are interpreted.
- This variable is in principle obsolete and is only used for
- backward compatibility, if the interpretation of todo keywords is
- not given already in `org-todo-keywords'. See that variable for
- more information."
- :group 'org-todo
- :group 'org-keywords
- :type '(choice (const sequence)
- (const type)))
- (defcustom org-use-fast-todo-selection 'auto
- "\\<org-mode-map>\
- Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
- This variable describes if and under what circumstances the cycling
- mechanism for TODO keywords will be replaced by a single-key, direct
- selection scheme, where the choices are displayed in a little window.
- When nil, fast selection is never used. This means that the command
- will always switch to the next state.
- When it is the symbol `auto', fast selection is whenever selection
- keys have been defined.
- `expert' is like `auto', but no special window with the keyword
- will be shown, choices will only be listed in the prompt.
- In all cases, the special interface is only used if access keys have
- actually been assigned by the user, i.e. if keywords in the configuration
- are followed by a letter in parenthesis, like TODO(t)."
- :group 'org-todo
- :set (lambda (var val)
- (cond
- ((eq var t) (set-default-toplevel-value var 'auto))
- ((eq var 'prefix) (set-default-toplevel-value var nil))
- (t (set-default-toplevel-value var val))))
- :type '(choice
- (const :tag "Never" nil)
- (const :tag "Automatically, when key letter have been defined" auto)
- (const :tag "Automatically, but don't show the selection window" expert)))
- (defcustom org-provide-todo-statistics t
- "Non-nil means update todo statistics after insert and toggle.
- ALL-HEADLINES means update todo statistics by including headlines
- with no TODO keyword as well, counting them as not done.
- A list of TODO keywords means the same, but skip keywords that are
- not in this list.
- When set to a list of two lists, the first list contains keywords
- to consider as TODO keywords, the second list contains keywords
- to consider as DONE keywords.
- When this is set, todo statistics is updated in the parent of the
- current entry each time a todo state is changed."
- :group 'org-todo
- :type '(choice
- (const :tag "Yes, only for TODO entries" t)
- (const :tag "Yes, including all entries" all-headlines)
- (repeat :tag "Yes, for TODOs in this list"
- (string :tag "TODO keyword"))
- (list :tag "Yes, for TODOs and DONEs in these lists"
- (repeat (string :tag "TODO keyword"))
- (repeat (string :tag "DONE keyword")))
- (other :tag "No TODO statistics" nil)))
- (defcustom org-hierarchical-todo-statistics t
- "Non-nil means TODO statistics covers just direct children.
- When nil, all entries in the subtree are considered.
- This has only an effect if `org-provide-todo-statistics' is set.
- To set this to nil for only a single subtree, use a COOKIE_DATA
- property and include the word \"recursive\" into the value."
- :group 'org-todo
- :type 'boolean)
- (defcustom org-after-todo-state-change-hook nil
- "Hook which is run after the state of a TODO item was changed.
- The new state (a string with a TODO keyword, or nil) is available in the
- Lisp variable `org-state'."
- :group 'org-todo
- :type 'hook)
- (defvar org-blocker-hook nil
- "Hook for functions that are allowed to block a state change.
- Functions in this hook should not modify the buffer.
- Each function gets as its single argument a property list,
- see `org-trigger-hook' for more information about this list.
- If any of the functions in this hook returns nil, the state change
- is blocked.")
- (defvar org-trigger-hook nil
- "Hook for functions that are triggered by a state change.
- Each function gets as its single argument a property list with at
- least the following elements:
- (:type type-of-change :position pos-at-entry-start
- :from old-state :to new-state)
- Depending on the type, more properties may be present.
- This mechanism is currently implemented for:
- TODO state changes
- ------------------
- :type todo-state-change
- :from previous state (keyword as a string), or nil, or a symbol
- `todo' or `done', to indicate the general type of state.
- :to new state, like in :from")
- (defcustom org-enforce-todo-dependencies nil
- "Non-nil means undone TODO entries will block switching the parent to DONE.
- Also, if a parent has an :ORDERED: property, switching an entry to DONE will
- be blocked if any prior sibling is not yet done.
- Finally, if the parent is blocked because of ordered siblings of its own,
- the child will also be blocked."
- :set (lambda (var val)
- (set-default-toplevel-value var val)
- (if val
- (add-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings-or-parent)
- (remove-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings-or-parent)))
- :group 'org-todo
- :type 'boolean)
- (defcustom org-enforce-todo-checkbox-dependencies nil
- "Non-nil means unchecked boxes will block switching the parent to DONE.
- When this is nil, checkboxes have no influence on switching TODO states.
- When non-nil, you first need to check off all check boxes before the TODO
- entry can be switched to DONE.
- This variable needs to be set before org.el is loaded, and you need to
- restart Emacs after a change to make the change effective. The only way
- to change it while Emacs is running is through the customize interface."
- :set (lambda (var val)
- (set-default-toplevel-value var val)
- (if val
- (add-hook 'org-blocker-hook
- 'org-block-todo-from-checkboxes)
- (remove-hook 'org-blocker-hook
- 'org-block-todo-from-checkboxes)))
- :group 'org-todo
- :type 'boolean)
- (defcustom org-treat-insert-todo-heading-as-state-change nil
- "Non-nil means inserting a TODO heading is treated as state change.
- So when the command `\\[org-insert-todo-heading]' is used, state change
- logging will apply if appropriate. When nil, the new TODO item will
- be inserted directly, and no logging will take place."
- :group 'org-todo
- :type 'boolean)
- (defcustom org-treat-S-cursor-todo-selection-as-state-change t
- "Non-nil means switching TODO states with S-cursor counts as state change.
- This is the default behavior. However, setting this to nil allows a
- convenient way to select a TODO state and bypass any logging associated
- with that."
- :group 'org-todo
- :type 'boolean)
- (defcustom org-todo-state-tags-triggers nil
- "Tag changes that should be triggered by TODO state changes.
- This is a list. Each entry is
- (state-change (tag . flag) .......)
- State-change can be a string with a state, and empty string to indicate the
- state that has no TODO keyword, or it can be one of the symbols `todo'
- or `done', meaning any not-done or done state, respectively."
- :group 'org-todo
- :group 'org-tags
- :type '(repeat
- (cons (choice :tag "When changing to"
- (const :tag "Not-done state" todo)
- (const :tag "Done state" done)
- (string :tag "State"))
- (repeat
- (cons :tag "Tag action"
- (string :tag "Tag")
- (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
- (defcustom org-log-done nil
- "Information to record when a task moves to the DONE state.
- Possible values are:
- nil Don't add anything, just change the keyword
- time Add a time stamp to the task
- note Prompt for a note and add it with template `org-log-note-headings'
- This option can also be set with on a per-file-basis with
- #+STARTUP: nologdone
- #+STARTUP: logdone
- #+STARTUP: lognotedone
- You can have local logging settings for a subtree by setting the LOGGING
- property to one or more of these keywords."
- :group 'org-todo
- :group 'org-progress
- :type '(choice
- (const :tag "No logging" nil)
- (const :tag "Record CLOSED timestamp" time)
- (const :tag "Record CLOSED timestamp with note." note)))
- ;; Normalize old uses of org-log-done.
- (cond
- ((eq org-log-done t) (setq org-log-done 'time))
- ((and (listp org-log-done) (memq 'done org-log-done))
- (setq org-log-done 'note)))
- (defcustom org-log-reschedule nil
- "Information to record when the scheduling date of a task is modified.
- Possible values are:
- nil Don't add anything, just change the date
- time Add a time stamp to the task
- note Prompt for a note and add it with template `org-log-note-headings'
- This option can also be set with on a per-file-basis with
- #+STARTUP: nologreschedule
- #+STARTUP: logreschedule
- #+STARTUP: lognotereschedule
- You can have local logging settings for a subtree by setting the LOGGING
- property to one or more of these keywords.
- This variable has an effect when calling `org-schedule' or
- `org-agenda-schedule' only."
- :group 'org-todo
- :group 'org-progress
- :type '(choice
- (const :tag "No logging" nil)
- (const :tag "Record timestamp" time)
- (const :tag "Record timestamp with note" note)))
- (defcustom org-log-redeadline nil
- "Information to record when the deadline date of a task is modified.
- Possible values are:
- nil Don't add anything, just change the date
- time Add a time stamp to the task
- note Prompt for a note and add it with template `org-log-note-headings'
- This option can also be set with on a per-file-basis with
- #+STARTUP: nologredeadline
- #+STARTUP: logredeadline
- #+STARTUP: lognoteredeadline
- You can have local logging settings for a subtree by setting the LOGGING
- property to one or more of these keywords.
- This variable has an effect when calling `org-deadline' or
- `org-agenda-deadline' only."
- :group 'org-todo
- :group 'org-progress
- :type '(choice
- (const :tag "No logging" nil)
- (const :tag "Record timestamp" time)
- (const :tag "Record timestamp with note." note)))
- (defcustom org-log-note-clock-out nil
- "Non-nil means record a note when clocking out of an item.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: lognoteclock-out
- #+STARTUP: nolognoteclock-out"
- :group 'org-todo
- :group 'org-progress
- :type 'boolean)
- (defcustom org-log-done-with-time t
- "Non-nil means the CLOSED time stamp will contain date and time.
- When nil, only the date will be recorded."
- :group 'org-progress
- :type 'boolean)
- (defcustom org-log-note-headings
- '((done . "CLOSING NOTE %t")
- (state . "State %-12s from %-12S %t")
- (note . "Note taken on %t")
- (reschedule . "Rescheduled from %S on %t")
- (delschedule . "Not scheduled, was %S on %t")
- (redeadline . "New deadline from %S on %t")
- (deldeadline . "Removed deadline, was %S on %t")
- (refile . "Refiled on %t")
- (clock-out . ""))
- "Headings for notes added to entries.
- The value is an alist, with the car being a symbol indicating the
- note context, and the cdr is the heading to be used. The heading
- may also be the empty string. The following placeholders can be
- used:
- %t a time stamp.
- %T an active time stamp instead the default inactive one
- %d a short-format time stamp.
- %D an active short-format time stamp.
- %s the new TODO state or time stamp (inactive), in double quotes.
- %S the old TODO state or time stamp (inactive), in double quotes.
- %u the user name.
- %U full user name.
- In fact, it is not a good idea to change the `state' entry,
- because Agenda Log mode depends on the format of these entries."
- :group 'org-todo
- :group 'org-progress
- :type '(list :greedy t
- (cons (const :tag "Heading when closing an item" done) string)
- (cons (const :tag
- "Heading when changing todo state (todo sequence only)"
- state) string)
- (cons (const :tag "Heading when just taking a note" note) string)
- (cons (const :tag "Heading when rescheduling" reschedule) string)
- (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
- (cons (const :tag "Heading when changing deadline" redeadline) string)
- (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
- (cons (const :tag "Heading when refiling" refile) string)
- (cons (const :tag "Heading when clocking out" clock-out) string)))
- (unless (assq 'note org-log-note-headings)
- (push '(note . "%t") org-log-note-headings))
- (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
- (defcustom org-log-into-drawer nil
- "Non-nil means insert state change notes and time stamps into a drawer.
- When nil, state changes notes will be inserted after the headline and
- any scheduling and clock lines, but not inside a drawer.
- The value of this variable should be the name of the drawer to use.
- LOGBOOK is proposed as the default drawer for this purpose, you can
- also set this to a string to define the drawer of your choice.
- A value of t is also allowed, representing \"LOGBOOK\".
- A value of t or nil can also be set with on a per-file-basis with
- #+STARTUP: logdrawer
- #+STARTUP: nologdrawer
- If this variable is set, `org-log-state-notes-insert-after-drawers'
- will be ignored.
- You can set the property LOG_INTO_DRAWER to overrule this setting for
- a subtree.
- Do not check directly this variable in a Lisp program. Call
- function `org-log-into-drawer' instead."
- :group 'org-todo
- :group 'org-progress
- :type '(choice
- (const :tag "Not into a drawer" nil)
- (const :tag "LOGBOOK" t)
- (string :tag "Other")))
- (defun org-log-into-drawer ()
- "Name of the log drawer, as a string, or nil.
- This is the value of `org-log-into-drawer'. However, if the
- current entry has or inherits a LOG_INTO_DRAWER property, it will
- be used instead of the default value."
- (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
- (cond ((equal p "nil") nil)
- ((equal p "t") "LOGBOOK")
- ((stringp p) p)
- (p "LOGBOOK")
- ((stringp org-log-into-drawer) org-log-into-drawer)
- (org-log-into-drawer "LOGBOOK"))))
- (defcustom org-log-state-notes-insert-after-drawers nil
- "Non-nil means insert state change notes after any drawers in entry.
- Only the drawers that *immediately* follow the headline and the
- deadline/scheduled line are skipped.
- When nil, insert notes right after the heading and perhaps the line
- with deadline/scheduling if present.
- This variable will have no effect if `org-log-into-drawer' is
- set."
- :group 'org-todo
- :group 'org-progress
- :type 'boolean)
- (defcustom org-log-states-order-reversed t
- "Non-nil means the latest state note will be directly after heading.
- When nil, the state change notes will be ordered according to time.
- This option can also be set with on a per-file-basis with
- #+STARTUP: logstatesreversed
- #+STARTUP: nologstatesreversed"
- :group 'org-todo
- :group 'org-progress
- :type 'boolean)
- (defcustom org-todo-repeat-to-state nil
- "The TODO state to which a repeater should return the repeating task.
- By default this is the first task of a TODO sequence or the
- previous state of a TYPE_TODO set. But you can specify to use
- the previous state in a TODO sequence or a string.
- Alternatively, you can set the :REPEAT_TO_STATE: property of the
- entry, which has precedence over this option."
- :group 'org-todo
- :version "24.1"
- :type '(choice (const :tag "Use the previous TODO state" t)
- (const :tag "Use the head of the TODO sequence" nil)
- (string :tag "Use a specific TODO state")))
- (defcustom org-log-repeat 'time
- "Non-nil means record moving through the DONE state when triggering repeat.
- An auto-repeating task is immediately switched back to TODO when
- marked DONE. If you are not logging state changes (by adding \"@\"
- or \"!\" to the TODO keyword definition), or set `org-log-done' to
- record a closing note, there will be no record of the task moving
- through DONE. This variable forces taking a note anyway.
- nil Don't force a record
- time Record a time stamp
- note Prompt for a note and add it with template `org-log-note-headings'
- This option can also be set with on a per-file-basis with
- #+STARTUP: nologrepeat
- #+STARTUP: logrepeat
- #+STARTUP: lognoterepeat
- You can have local logging settings for a subtree by setting the LOGGING
- property to one or more of these keywords."
- :group 'org-todo
- :group 'org-progress
- :type '(choice
- (const :tag "Don't force a record" nil)
- (const :tag "Force recording the DONE state" time)
- (const :tag "Force recording a note with the DONE state" note)))
- (defcustom org-todo-repeat-hook nil
- "Hook that is run after a task has been repeated."
- :package-version '(Org . "9.2")
- :group 'org-todo
- :type 'hook)
- (defgroup org-priorities nil
- "Priorities in Org mode."
- :tag "Org Priorities"
- :group 'org-todo)
- (defvaralias 'org-enable-priority-commands 'org-priority-enable-commands)
- (defcustom org-priority-enable-commands t
- "Non-nil means priority commands are active.
- When nil, these commands will be disabled, so that you never accidentally
- set a priority."
- :group 'org-priorities
- :type 'boolean)
- (defvaralias 'org-highest-priority 'org-priority-highest)
- (defcustom org-priority-highest ?A
- "The highest priority of TODO items.
- A character like ?A, ?B, etc., or a numeric value like 1, 2, etc.
- The default is the character ?A, which is 65 as a numeric value.
- If you set `org-priority-highest' to a numeric value inferior to
- 65, Org assumes you want to use digits for the priority cookie.
- If you set it to >=65, Org assumes you want to use alphabetical
- characters.
- In both cases, the value of `org-priority-highest' must be
- smaller than `org-priority-lowest': for example, if \"A\" is the
- highest priority, it is smaller than the lowest \"C\" priority:
- 65 < 67."
- :group 'org-priorities
- :type '(choice
- (character :tag "Character")
- (integer :tag "Integer (< 65)")))
- (defvaralias 'org-lowest-priority 'org-priority-lowest)
- (defcustom org-priority-lowest ?C
- "The lowest priority of TODO items.
- A character like ?C, ?B, etc., or a numeric value like 9, 8, etc.
- The default is the character ?C, which is 67 as a numeric value.
- If you set `org-priority-lowest' to a numeric value inferior to
- 65, Org assumes you want to use digits for the priority cookie.
- If you set it to >=65, Org assumes you want to use alphabetical
- characters.
- In both cases, the value of `org-priority-lowest' must be greater
- than `org-priority-highest': for example, if \"C\" is the lowest
- priority, it is greater than the highest \"A\" priority: 67 >
- 65."
- :group 'org-priorities
- :type '(choice
- (character :tag "Character")
- (integer :tag "Integer (< 65)")))
- (defvaralias 'org-default-priority 'org-priority-default)
- (defcustom org-priority-default ?B
- "The default priority of TODO items.
- This is the priority an item gets if no explicit priority is given.
- When starting to cycle on an empty priority the first step in the cycle
- depends on `org-priority-start-cycle-with-default'. The resulting first
- step priority must not exceed the range from `org-priority-highest' to
- `org-priority-lowest' which means that `org-priority-default' has to be
- in this range exclusive or inclusive to the range boundaries. Else the
- first step refuses to set the default and the second will fall back on
- \(depending on the command used) the highest or lowest priority."
- :group 'org-priorities
- :type '(choice
- (character :tag "Character")
- (integer :tag "Integer (< 65)")))
- (defcustom org-priority-start-cycle-with-default t
- "Non-nil means start with default priority when starting to cycle.
- When this is nil, the first step in the cycle will be (depending on the
- command used) one higher or lower than the default priority.
- See also `org-priority-default'."
- :group 'org-priorities
- :type 'boolean)
- (defvaralias 'org-get-priority-function 'org-priority-get-priority-function)
- (defcustom org-priority-get-priority-function nil
- "Function to extract the priority from a string.
- The string is normally the headline. If this is nil, Org
- computes the priority from the priority cookie like [#A] in the
- headline. It returns an integer, increasing by 1000 for each
- priority level.
- The user can set a different function here, which should take a
- string as an argument and return the numeric priority."
- :group 'org-priorities
- :version "24.1"
- :type '(choice
- (const nil)
- (function)))
- (defgroup org-time nil
- "Options concerning time stamps and deadlines in Org mode."
- :tag "Org Time"
- :group 'org)
- (defcustom org-time-stamp-rounding-minutes '(0 5)
- "Number of minutes to round time stamps to.
- \\<org-mode-map>\
- These are two values, the first applies when first creating a time stamp.
- The second applies when changing it with the commands `S-up' and `S-down'.
- When changing the time stamp, this means that it will change in steps
- of N minutes, as given by the second value.
- When a setting is 0 or 1, insert the time unmodified. Useful rounding
- numbers should be factors of 60, so for example 5, 10, 15.
- When this is larger than 1, you can still force an exact time stamp by using
- a double prefix argument to a time stamp command like \
- `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
- and by using a prefix arg to `S-up/down' to specify the exact number
- of minutes to shift."
- :group 'org-time
- :get (lambda (var) ; Make sure both elements are there
- (if (integerp (default-value var))
- (list (default-value var) 5)
- (default-value var)))
- :type '(list
- (integer :tag "when inserting times")
- (integer :tag "when modifying times")))
- ;; Normalize old customizations of this variable.
- (when (integerp org-time-stamp-rounding-minutes)
- (setq org-time-stamp-rounding-minutes
- (list org-time-stamp-rounding-minutes
- org-time-stamp-rounding-minutes)))
- (defcustom org-display-custom-times nil
- "Non-nil means overlay custom formats over all time stamps.
- The formats are defined through the variable `org-time-stamp-custom-formats'.
- To turn this on on a per-file basis, insert anywhere in the file:
- #+STARTUP: customtime"
- :group 'org-time
- :type 'sexp)
- (make-variable-buffer-local 'org-display-custom-times)
- (defcustom org-time-stamp-custom-formats
- '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
- "Custom formats for time stamps. See `format-time-string' for the syntax.
- These are overlaid over the default ISO format if the variable
- `org-display-custom-times' is set. Time like %H:%M should be at the
- end of the second format. The custom formats are also honored by export
- commands, if custom time display is turned on at the time of export."
- :group 'org-time
- :type 'sexp)
- (defun org-time-stamp-format (&optional long inactive)
- "Get the right format for a time string."
- (let ((f (if long (cdr org-time-stamp-formats)
- (car org-time-stamp-formats))))
- (if inactive
- (concat "[" (substring f 1 -1) "]")
- f)))
- (defcustom org-deadline-warning-days 14
- "Number of days before expiration during which a deadline becomes active.
- This variable governs the display in sparse trees and in the agenda.
- When 0 or negative, it means use this number (the absolute value of it)
- even if a deadline has a different individual lead time specified.
- Custom commands can set this variable in the options section."
- :group 'org-time
- :group 'org-agenda-daily/weekly
- :type 'integer)
- (defcustom org-scheduled-delay-days 0
- "Number of days before a scheduled item becomes active.
- This variable governs the display in sparse trees and in the agenda.
- The default value (i.e. 0) means: don't delay scheduled item.
- When negative, it means use this number (the absolute value of it)
- even if a scheduled item has a different individual delay time
- specified.
- Custom commands can set this variable in the options section."
- :group 'org-time
- :group 'org-agenda-daily/weekly
- :version "24.4"
- :package-version '(Org . "8.0")
- :type 'integer)
- (defcustom org-read-date-prefer-future t
- "Non-nil means assume future for incomplete date input from user.
- This affects the following situations:
- 1. The user gives a month but not a year.
- For example, if it is April and you enter \"feb 2\", this will be read
- as Feb 2, *next* year. \"May 5\", however, will be this year.
- 2. The user gives a day, but no month.
- For example, if today is the 15th, and you enter \"3\", Org will read
- this as the third of *next* month. However, if you enter \"17\",
- it will be considered as *this* month.
- If you set this variable to the symbol `time', then also the following
- will work:
- 3. If the user gives a time.
- If the time is before now, it will be interpreted as tomorrow.
- Currently none of this works for ISO week specifications.
- When this option is nil, the current day, month and year will always be
- used as defaults.
- See also `org-agenda-jump-prefer-future'."
- :group 'org-time
- :type '(choice
- (const :tag "Never" nil)
- (const :tag "Check month and day" t)
- (const :tag "Check month, day, and time" time)))
- (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
- "Should the agenda jump command prefer the future for incomplete dates?
- The default is to do the same as configured in `org-read-date-prefer-future'.
- But you can also set a deviating value here.
- This may t or nil, or the symbol `org-read-date-prefer-future'."
- :group 'org-agenda
- :group 'org-time
- :version "24.1"
- :type '(choice
- (const :tag "Use org-read-date-prefer-future"
- org-read-date-prefer-future)
- (const :tag "Never" nil)
- (const :tag "Always" t)))
- (defcustom org-read-date-force-compatible-dates t
- "Should date/time prompt force dates that are guaranteed to work in Emacs?
- Depending on the system Emacs is running on, certain dates cannot
- be represented with the type used internally to represent time.
- Dates between 1970-1-1 and 2038-1-1 can always be represented
- correctly. Some systems allow for earlier dates, some for later,
- some for both. One way to find out is to insert any date into an
- Org buffer, putting the cursor on the year and hitting S-up and
- S-down to test the range.
- When this variable is set to t, the date/time prompt will not let
- you specify dates outside the 1970-2037 range, so it is certain that
- these dates will work in whatever version of Emacs you are
- running, and also that you can move a file from one Emacs implementation
- to another. Whenever Org is forcing the year for you, it will display
- a message and beep.
- When this variable is nil, Org will check if the date is
- representable in the specific Emacs implementation you are using.
- If not, it will force a year, usually the current year, and beep
- to remind you. Currently this setting is not recommended because
- the likelihood that you will open your Org files in an Emacs that
- has limited date range is not negligible.
- A workaround for this problem is to use diary sexp dates for time
- stamps outside of this range."
- :group 'org-time
- :version "24.1"
- :type 'boolean)
- (defcustom org-read-date-display-live t
- "Non-nil means display current interpretation of date prompt live.
- This display will be in an overlay, in the minibuffer. Note that
- live display is only active when `org-read-date-popup-calendar'
- is non-nil."
- :group 'org-time
- :type 'boolean)
- (defvaralias 'org-popup-calendar-for-date-prompt
- 'org-read-date-popup-calendar)
- (defcustom org-read-date-popup-calendar t
- "Non-nil means pop up a calendar when prompting for a date.
- In the calendar, the date can be selected with mouse-1. However, the
- minibuffer will also be active, and you can simply enter the date as well.
- When nil, only the minibuffer will be available."
- :group 'org-time
- :type 'boolean)
- (defcustom org-extend-today-until 0
- "The hour when your day really ends. Must be an integer.
- This has influence for the following applications:
- - When switching the agenda to \"today\". If it is still earlier than
- the time given here, the day recognized as TODAY is actually yesterday.
- - When a date is read from the user and it is still before the time given
- here, the current date and time will be assumed to be yesterday, 23:59.
- Also, timestamps inserted in capture templates follow this rule.
- IMPORTANT: This is a feature whose implementation is and likely will
- remain incomplete. Really, it is only here because past midnight seems to
- be the favorite working time of John Wiegley :-)"
- :group 'org-time
- :type 'integer)
- (defcustom org-use-effective-time nil
- "If non-nil, consider `org-extend-today-until' when creating timestamps.
- For example, if `org-extend-today-until' is 8, and it's 4am, then the
- \"effective time\" of any timestamps between midnight and 8am will be
- 23:59 of the previous day."
- :group 'org-time
- :version "24.1"
- :type 'boolean)
- (defcustom org-use-last-clock-out-time-as-effective-time nil
- "When non-nil, use the last clock out time for `org-todo'.
- Note that this option has precedence over the combined use of
- `org-use-effective-time' and `org-extend-today-until'."
- :group 'org-time
- :version "24.4"
- :package-version '(Org . "8.0")
- :type 'boolean)
- (defcustom org-edit-timestamp-down-means-later nil
- "Non-nil means S-down will increase the time in a time stamp.
- When nil, S-up will increase."
- :group 'org-time
- :type 'boolean)
- (defcustom org-calendar-follow-timestamp-change t
- "Non-nil means make the calendar window follow timestamp changes.
- When a timestamp is modified and the calendar window is visible, it will be
- moved to the new date."
- :group 'org-time
- :type 'boolean)
- (defgroup org-tags nil
- "Options concerning tags in Org mode."
- :tag "Org Tags"
- :group 'org)
- (defcustom org-tag-alist nil
- "Default tags available in Org files.
- The value of this variable is an alist. Associations either:
- (TAG)
- (TAG . SELECT)
- (SPECIAL)
- where TAG is a tag as a string, SELECT is character, used to
- select that tag through the fast tag selection interface, and
- SPECIAL is one of the following keywords: `:startgroup',
- `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or
- `:newline'. These keywords are used to define a hierarchy of
- tags. See manual for details.
- When this variable is nil, Org mode bases tag input on what is
- already in the buffer. The value can be overridden locally by
- using a TAGS keyword, e.g.,
- #+TAGS: tag1 tag2
- See also `org-tag-persistent-alist' to sidestep this behavior."
- :group 'org-tags
- :type '(repeat
- (choice
- (cons :tag "Tag with key"
- (string :tag "Tag name")
- (character :tag "Access char"))
- (list :tag "Tag" (string :tag "Tag name"))
- (const :tag "Start radio group" (:startgroup))
- (const :tag "Start tag group, non distinct" (:startgrouptag))
- (const :tag "Group tags delimiter" (:grouptags))
- (const :tag "End radio group" (:endgroup))
- (const :tag "End tag group, non distinct" (:endgrouptag))
- (const :tag "New line" (:newline)))))
- (defcustom org-tag-persistent-alist nil
- "Tags always available in Org files.
- The value of this variable is an alist. Associations either:
- (TAG)
- (TAG . SELECT)
- (SPECIAL)
- where TAG is a tag as a string, SELECT is a character, used to
- select that tag through the fast tag selection interface, and
- SPECIAL is one of the following keywords: `:startgroup',
- `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or
- `:newline'. These keywords are used to define a hierarchy of
- tags. See manual for details.
- Unlike to `org-tag-alist', tags defined in this variable do not
- depend on a local TAGS keyword. Instead, to disable these tags
- on a per-file basis, insert anywhere in the file:
- #+STARTUP: noptag"
- :group 'org-tags
- :type '(repeat
- (choice
- (cons :tag "Tag with key"
- (string :tag "Tag name")
- (character :tag "Access char"))
- (list :tag "Tag" (string :tag "Tag name"))
- (const :tag "Start radio group" (:startgroup))
- (const :tag "Start tag group, non distinct" (:startgrouptag))
- (const :tag "Group tags delimiter" (:grouptags))
- (const :tag "End radio group" (:endgroup))
- (const :tag "End tag group, non distinct" (:endgrouptag))
- (const :tag "New line" (:newline)))))
- (defcustom org-complete-tags-always-offer-all-agenda-tags nil
- "If non-nil, always offer completion for all tags of all agenda files.
- Setting this variable locally allows for dynamic generation of tag
- completions in capture buffers.
- (add-hook \\='org-capture-mode-hook
- (lambda ()
- (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
- :group 'org-tags
- :version "24.1"
- :type 'boolean)
- (defvar org-file-tags nil
- "List of tags that can be inherited by all entries in the file.
- The tags will be inherited if the variable `org-use-tag-inheritance'
- says they should be.
- This variable is populated from #+FILETAGS lines.")
- (defcustom org-use-fast-tag-selection 'auto
- "Non-nil means use fast tag selection scheme.
- This is a special interface to select and deselect tags with single keys.
- When nil, fast selection is never used.
- When the symbol `auto', fast selection is used if and only if selection
- characters for tags have been configured, either through the variable
- `org-tag-alist' or through a #+TAGS line in the buffer.
- When t, fast selection is always used and selection keys are assigned
- automatically if necessary."
- :group 'org-tags
- :type '(choice
- (const :tag "Always" t)
- (const :tag "Never" nil)
- (const :tag "When selection characters are configured" auto)))
- (defcustom org-fast-tag-selection-single-key nil
- "Non-nil means fast tag selection exits after first change.
- When nil, you have to press RET to exit it.
- During fast tag selection, you can toggle this flag with `C-c'.
- This variable can also have the value `expert'. In this case, the window
- displaying the tags menu is not even shown, until you press `C-c' again."
- :group 'org-tags
- :type '(choice
- (const :tag "No" nil)
- (const :tag "Yes" t)
- (const :tag "Expert" expert)))
- (defvar org-fast-tag-selection-include-todo nil
- "Non-nil means fast tags selection interface will also offer TODO states.
- This is an undocumented feature, you should not rely on it.")
- (defcustom org-tags-column -77
- "The column to which tags should be indented in a headline.
- If this number is positive, it specifies the column. If it is negative,
- it means that the tags should be flushright to that column. For example,
- -80 works well for a normal 80 character screen.
- When 0, place tags directly after headline text, with only one space in
- between."
- :group 'org-tags
- :type 'integer)
- (defcustom org-auto-align-tags t
- "Non-nil keeps tags aligned when modifying headlines.
- Some operations (i.e. demoting) change the length of a headline and
- therefore shift the tags around. With this option turned on, after
- each such operation the tags are again aligned to `org-tags-column'."
- :group 'org-tags
- :type 'boolean)
- (defcustom org-use-tag-inheritance t
- "Non-nil means tags in levels apply also for sublevels.
- When nil, only the tags directly given in a specific line apply there.
- This may also be a list of tags that should be inherited, or a regexp that
- matches tags that should be inherited. Additional control is possible
- with the variable `org-tags-exclude-from-inheritance' which gives an
- explicit list of tags to be excluded from inheritance, even if the value of
- `org-use-tag-inheritance' would select it for inheritance.
- If this option is t, a match early-on in a tree can lead to a large
- number of matches in the subtree when constructing the agenda or creating
- a sparse tree. If you only want to see the first match in a tree during
- a search, check out the variable `org-tags-match-list-sublevels'."
- :group 'org-tags
- :type '(choice
- (const :tag "Not" nil)
- (const :tag "Always" t)
- (repeat :tag "Specific tags" (string :tag "Tag"))
- (regexp :tag "Tags matched by regexp")))
- (defcustom org-tags-exclude-from-inheritance nil
- "List of tags that should never be inherited.
- This is a way to exclude a few tags from inheritance. For way to do
- the opposite, to actively allow inheritance for selected tags,
- see the variable `org-use-tag-inheritance'."
- :group 'org-tags
- :type '(repeat (string :tag "Tag")))
- (defun org-tag-inherit-p (tag)
- "Check if TAG is one that should be inherited."
- (cond
- ((member tag org-tags-exclude-from-inheritance) nil)
- ((eq org-use-tag-inheritance t) t)
- ((not org-use-tag-inheritance) nil)
- ((stringp org-use-tag-inheritance)
- (string-match org-use-tag-inheritance tag))
- ((listp org-use-tag-inheritance)
- (member tag org-use-tag-inheritance))
- (t (error "Invalid setting of `org-use-tag-inheritance'"))))
- (defcustom org-tags-match-list-sublevels t
- "Non-nil means list also sublevels of headlines matching a search.
- This variable applies to tags/property searches, and also to stuck
- projects because this search is based on a tags match as well.
- When set to the symbol `indented', sublevels are indented with
- leading dots.
- Because of tag inheritance (see variable `org-use-tag-inheritance'),
- the sublevels of a headline matching a tag search often also match
- the same search. Listing all of them can create very long lists.
- Setting this variable to nil causes subtrees of a match to be skipped.
- This variable is semi-obsolete and probably should always be true. It
- is better to limit inheritance to certain tags using the variables
- `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
- :group 'org-tags
- :type '(choice
- (const :tag "No, don't list them" nil)
- (const :tag "Yes, do list them" t)
- (const :tag "List them, indented with leading dots" indented)))
- (defcustom org-tags-sort-function nil
- "When set, tags are sorted using this function as a comparator."
- :group 'org-tags
- :type '(choice
- (const :tag "No sorting" nil)
- (const :tag "Alphabetical" string-collate-lessp)
- (const :tag "Reverse alphabetical" org-string-collate-greaterp)
- (function :tag "Custom function" nil)))
- (defvar org-tags-history nil
- "History of minibuffer reads for tags.")
- (defvar org-last-tags-completion-table nil
- "The last used completion table for tags.")
- (defvar org-after-tags-change-hook nil
- "Hook that is run after the tags in a line have changed.")
- (defgroup org-properties nil
- "Options concerning properties in Org mode."
- :tag "Org Properties"
- :group 'org)
- (defcustom org-property-format "%-10s %s"
- "How property key/value pairs should be formatted by `indent-line'.
- When `indent-line' hits a property definition, it will format the line
- according to this format, mainly to make sure that the values are
- lined-up with respect to each other."
- :group 'org-properties
- :type 'string)
- (defcustom org-properties-postprocess-alist nil
- "Alist of properties and functions to adjust inserted values.
- Elements of this alist must be of the form
- ([string] [function])
- where [string] must be a property name and [function] must be a
- lambda expression: this lambda expression must take one argument,
- the value to adjust, and return the new value as a string.
- For example, this element will allow the property \"Remaining\"
- to be updated wrt the relation between the \"Effort\" property
- and the clock summary:
- ((\"Remaining\" (lambda(value)
- (let ((clocksum (org-clock-sum-current-item))
- (effort (org-duration-to-minutes
- (org-entry-get (point) \"Effort\"))))
- (org-minutes-to-clocksum-string (- effort clocksum))))))"
- :group 'org-properties
- :version "24.1"
- :type '(alist :key-type (string :tag "Property")
- :value-type (function :tag "Function")))
- (defcustom org-use-property-inheritance nil
- "Non-nil means properties apply also for sublevels.
- This setting is chiefly used during property searches. Turning it on can
- cause significant overhead when doing a search, which is why it is not
- on by default.
- When nil, only the properties directly given in the current entry count.
- When t, every property is inherited. The value may also be a list of
- properties that should have inheritance, or a regular expression matching
- properties that should be inherited.
- However, note that some special properties use inheritance under special
- circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
- and the properties ending in \"_ALL\" when they are used as descriptor
- for valid values of a property.
- Note for programmers:
- When querying an entry with `org-entry-get', you can control if inheritance
- should be used. By default, `org-entry-get' looks only at the local
- properties. You can request inheritance by setting the inherit argument
- to t (to force inheritance) or to `selective' (to respect the setting
- in this variable)."
- :group 'org-properties
- :type '(choice
- (const :tag "Not" nil)
- (const :tag "Always" t)
- (repeat :tag "Specific properties" (string :tag "Property"))
- (regexp :tag "Properties matched by regexp")))
- (defun org-property-inherit-p (property)
- "Return a non-nil value if PROPERTY should be inherited."
- (cond
- ((eq org-use-property-inheritance t) t)
- ((not org-use-property-inheritance) nil)
- ((stringp org-use-property-inheritance)
- (string-match org-use-property-inheritance property))
- ((listp org-use-property-inheritance)
- (member-ignore-case property org-use-property-inheritance))
- (t (error "Invalid setting of `org-use-property-inheritance'"))))
- (defcustom org-property-separators nil
- "An alist to control how properties are combined.
- The car of each item should be either a list of property names or
- a regular expression, while the cdr should be the separator to
- use when combining that property.
- If an alist item cannot be found that matches a given property, a
- single space will be used as the separator."
- :group 'org-properties
- :type '(alist :key-type (choice (repeat :tag "Properties" string)
- (string :tag "Regular Expression"))
- :value-type (restricted-sexp :tag "Separator"
- :match-alternatives (stringp)
- :value " ")))
- (defun org--property-get-separator (property)
- "Get the separator to use for combining PROPERTY."
- (or
- (catch 'separator
- (dolist (spec org-property-separators)
- (if (listp (car spec))
- (if (member property (car spec))
- (throw 'separator (cdr spec)))
- (if (string-match-p (car spec) property)
- (throw 'separator (cdr spec))))))
- " "))
- (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
- "The default column format, if no other format has been defined.
- This variable can be set on the per-file basis by inserting a line
- #+COLUMNS: %25ITEM ....."
- :group 'org-properties
- :type 'string)
- (defcustom org-columns-default-format-for-agenda nil
- "The default column format in an agenda buffer.
- This will be used for column view in the agenda unless a format has
- been set by adding `org-overriding-columns-format' to the local
- settings list of a custom agenda view. When nil, the columns format
- for the first item in the agenda list will be used, or as a fall-back,
- `org-columns-default-format'."
- :group 'org-properties
- :type '(choice
- (const :tag "No default" nil)
- (string :tag "Format string")))
- (defcustom org-columns-ellipses ".."
- "The ellipses to be used when a field in column view is truncated.
- When this is the empty string, as many characters as possible are shown,
- but then there will be no visual indication that the field has been truncated.
- When this is a string of length N, the last N characters of a truncated
- field are replaced by this string. If the column is narrower than the
- ellipses string, only part of the ellipses string will be shown."
- :group 'org-properties
- :type 'string)
- (defconst org-global-properties-fixed
- '(("VISIBILITY_ALL" . "folded children content all")
- ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
- "List of property/value pairs that can be inherited by any entry.
- These are fixed values, for the preset properties. The user variable
- that can be used to add to this list is `org-global-properties'.
- The entries in this list are cons cells where the car is a property
- name and cdr is a string with the value. If the value represents
- multiple items like an \"_ALL\" property, separate the items by
- spaces.")
- (defcustom org-global-properties nil
- "List of property/value pairs that can be inherited by any entry.
- This list will be combined with the constant `org-global-properties-fixed'.
- The entries in this list are cons cells where the car is a property
- name and cdr is a string with the value.
- Buffer local properties are added either by a document property drawer
- :PROPERTIES:
- :NAME: VALUE
- :END:
- or by adding lines like
- #+PROPERTY: NAME VALUE"
- :group 'org-properties
- :type '(repeat
- (cons (string :tag "Property")
- (string :tag "Value"))))
- (defvar-local org-keyword-properties nil
- "List of property/value pairs inherited by any entry.
- Valid for the current buffer. This variable is populated from
- PROPERTY keywords.
- Note that properties are defined also in property drawers.
- Properties defined there take precedence over properties defined
- as keywords.")
- (defgroup org-agenda nil
- "Options concerning agenda views in Org mode."
- :tag "Org Agenda"
- :group 'org)
- (defvar-local org-category nil
- "Variable used by Org files to set a category for agenda display.
- There are multiple ways to set the category. One way is to set
- it in the document property drawer. For example:
- :PROPERTIES:
- :CATEGORY: ELisp
- :END:
- Other ways to define it is as an Emacs file variable, for example
- # -*- mode: org; org-category: \"ELisp\"
- or for the file to contain a special line:
- #+CATEGORY: ELisp
- If the file does not specify a category, then file's base name
- is used instead.")
- (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
- (defcustom org-agenda-files nil
- "The files to be used for agenda display.
- If an entry is a directory, all files in that directory that are matched
- by `org-agenda-file-regexp' will be part of the file list.
- If the value of the variable is not a list but a single file name, then
- the list of agenda files is actually stored and maintained in that file,
- one agenda file per line. In this file paths can be given relative to
- `org-directory'. Tilde expansion and environment variable substitution
- are also made.
- Entries may be added to this list with `\\[org-agenda-file-to-front]'
- and removed with `\\[org-remove-file]'."
- :group 'org-agenda
- :type '(choice
- (repeat :tag "List of files and directories" file)
- (file :tag "Store list in a file\n" :value "~/.agenda_files")))
- (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
- "Regular expression to match files for `org-agenda-files'.
- If any element in the list in that variable contains a directory instead
- of a normal file, all files in that directory that are matched by this
- regular expression will be included."
- :group 'org-agenda
- :type 'regexp)
- (defvaralias 'org-agenda-multi-occur-extra-files
- 'org-agenda-text-search-extra-files)
- (defcustom org-agenda-text-search-extra-files nil
- "List of extra files to be searched by text search commands.
- These files will be searched in addition to the agenda files by the
- commands `org-search-view' (`\\[org-agenda] s') \
- and `org-occur-in-agenda-files'.
- Note that these files will only be searched for text search commands,
- not for the other agenda views like todo lists, tag searches or the weekly
- agenda. This variable is intended to list notes and possibly archive files
- that should also be searched by these two commands.
- In fact, if the first element in the list is the symbol `agenda-archives',
- then all archive files of all agenda files will be added to the search
- scope."
- :group 'org-agenda
- :type '(set :greedy t
- (const :tag "Agenda Archives" agenda-archives)
- (repeat :inline t (file))))
- (defcustom org-agenda-skip-unavailable-files nil
- "Non-nil means to just skip non-reachable files in `org-agenda-files'.
- A nil value means to remove them, after a query, from the list."
- :group 'org-agenda
- :type 'boolean)
- (defgroup org-latex nil
- "Options for embedding LaTeX code into Org mode."
- :tag "Org LaTeX"
- :group 'org)
- (defcustom org-format-latex-options
- '(:foreground default :background default :scale 1.0
- :html-foreground "Black" :html-background "Transparent"
- :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
- "Options for creating images from LaTeX fragments.
- This is a property list with the following properties:
- :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
- `default' means use the foreground of the default face.
- `auto' means use the foreground from the text face.
- :background the background color, or \"Transparent\".
- `default' means use the background of the default face.
- `auto' means use the background from the text face.
- :scale a scaling factor for the size of the images, to get more pixels
- :html-foreground, :html-background, :html-scale
- the same numbers for HTML export.
- :matchers a list indicating which matchers should be used to
- find LaTeX fragments. Valid members of this list are:
- \"begin\" find environments
- \"$1\" find single characters surrounded by $.$
- \"$\" find math expressions surrounded by $...$
- \"$$\" find math expressions surrounded by $$....$$
- \"\\(\" find math expressions surrounded by \\(...\\)
- \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
- :group 'org-latex
- :type 'plist)
- (defcustom org-format-latex-signal-error t
- "Non-nil means signal an error when image creation of LaTeX snippets fails.
- When nil, just push out a message."
- :group 'org-latex
- :version "24.1"
- :type 'boolean)
- (defcustom org-latex-to-mathml-jar-file nil
- "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
- Use this to specify additional executable file say a jar file.
- When using MathToWeb as the converter, specify the full-path to
- your mathtoweb.jar file."
- :group 'org-latex
- :version "24.1"
- :type '(choice
- (const :tag "None" nil)
- (file :tag "JAR file" :must-match t)))
- (defcustom org-latex-to-mathml-convert-command nil
- "Command to convert LaTeX fragments to MathML.
- Replace format-specifiers in the command as noted below and use
- `shell-command' to convert LaTeX to MathML.
- %j: Executable file in fully expanded form as specified by
- `org-latex-to-mathml-jar-file'.
- %I: Input LaTeX file in fully expanded form.
- %i: The latex fragment to be converted.
- %o: Output MathML file.
- This command is used by `org-create-math-formula'.
- When using MathToWeb as the converter, set this option to
- \"java -jar %j -unicode -force -df %o %I\".
- When using LaTeXML set this option to
- \"latexmlmath \"%i\" --presentationmathml=%o\"."
- :group 'org-latex
- :version "24.1"
- :type '(choice
- (const :tag "None" nil)
- (string :tag "\nShell command")))
- (defcustom org-latex-to-html-convert-command nil
- "Command to convert LaTeX fragments to HTML.
- This command is very open-ended: the output of the command will
- directly replace the LaTeX fragment in the resulting HTML.
- Replace format-specifiers in the command as noted below and use
- `shell-command' to convert LaTeX to HTML.
- %i: The LaTeX fragment to be converted.
- For example, this could be used with LaTeXML as
- \"latexmlc \\='literal:%i\\=' --profile=math --preload=siunitx.sty 2>/dev/null\"."
- :group 'org-latex
- :package-version '(Org . "9.4")
- :type '(choice
- (const :tag "None" nil)
- (string :tag "Shell command")))
- (defcustom org-preview-latex-default-process 'dvipng
- "The default process to convert LaTeX fragments to image files.
- All available processes and theirs documents can be found in
- `org-preview-latex-process-alist', which see."
- :group 'org-latex
- :version "26.1"
- :package-version '(Org . "9.0")
- :type 'symbol)
- (defcustom org-preview-latex-process-alist
- '((dvipng
- :programs ("latex" "dvipng")
- :description "dvi > png"
- :message "you need to install the programs: latex and dvipng."
- :image-input-type "dvi"
- :image-output-type "png"
- :image-size-adjust (1.0 . 1.0)
- :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
- :image-converter ("dvipng -D %D -T tight -o %O %f")
- :transparent-image-converter
- ("dvipng -D %D -T tight -bg Transparent -o %O %f"))
- (dvisvgm
- :programs ("latex" "dvisvgm")
- :description "dvi > svg"
- :message "you need to install the programs: latex and dvisvgm."
- :image-input-type "dvi"
- :image-output-type "svg"
- :image-size-adjust (1.7 . 1.5)
- :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
- :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
- (imagemagick
- :programs ("latex" "convert")
- :description "pdf > png"
- :message "you need to install the programs: latex and imagemagick."
- :image-input-type "pdf"
- :image-output-type "png"
- :image-size-adjust (1.0 . 1.0)
- :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
- :image-converter
- ("convert -density %D -trim -antialias %f -quality 100 %O")))
- "Definitions of external processes for LaTeX previewing.
- Org mode can use some external commands to generate TeX snippet's images for
- previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
- `org-create-formula-image' how to call them.
- The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
- PROPERTIES accepts the following attributes:
- :programs list of strings, required programs.
- :description string, describe the process.
- :message string, message it when required programs cannot be found.
- :image-input-type string, input file type of image converter (e.g., \"dvi\").
- :image-output-type string, output file type of image converter (e.g., \"png\").
- :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
- image size showed in buffer and the cdr element is for
- HTML file. This option is only useful for process
- developers, users should use variable
- `org-format-latex-options' instead.
- :post-clean list of strings, files matched are to be cleaned up once
- the image is generated. When nil, the files with \".dvi\",
- \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
- \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
- be cleaned up.
- :latex-header list of strings, the LaTeX header of the snippet file.
- When nil, the fallback value is used instead, which is
- controlled by `org-format-latex-header',
- `org-latex-default-packages-alist' and
- `org-latex-packages-alist', which see.
- :latex-compiler list of LaTeX commands, as strings. Each of them is given
- to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
- replaced with values defined below.
- :image-converter list of image converter commands strings. Each of them is
- given to the shell and supports any of the following
- place-holders defined below.
- If set, :transparent-image-converter is used instead of :image-converter to
- convert an image when the background color is nil or \"Transparent\".
- Place-holders used by `:image-converter' and `:latex-compiler':
- %f input file name
- %b base name of input file
- %o base directory of input file
- %O absolute output file name
- Place-holders only used by `:image-converter':
- %D dpi, which is used to adjust image size by some processing commands.
- %S the image size scale ratio, which is used to adjust image size by some
- processing commands."
- :group 'org-latex
- :version "26.1"
- :package-version '(Org . "9.0")
- :type '(alist :tag "LaTeX to image backends"
- :value-type (plist)))
- (defcustom org-preview-latex-image-directory "ltximg/"
- "Path to store latex preview images.
- A relative path here creates many directories relative to the
- processed Org files paths. An absolute path puts all preview
- images at the same place."
- :group 'org-latex
- :version "26.1"
- :package-version '(Org . "9.0")
- :type 'string)
- (defun org-format-latex-mathml-available-p ()
- "Return t if `org-latex-to-mathml-convert-command' is usable."
- (save-match-data
- (when (and (boundp 'org-latex-to-mathml-convert-command)
- org-latex-to-mathml-convert-command)
- (let ((executable (car (split-string
- org-latex-to-mathml-convert-command))))
- (when (executable-find executable)
- (if (string-match
- "%j" org-latex-to-mathml-convert-command)
- (file-readable-p org-latex-to-mathml-jar-file)
- t))))))
- (defcustom org-format-latex-header "\\documentclass{article}
- \\usepackage[usenames]{color}
- \[DEFAULT-PACKAGES]
- \[PACKAGES]
- \\pagestyle{empty} % do not remove
- % The settings below are copied from fullpage.sty
- \\setlength{\\textwidth}{\\paperwidth}
- \\addtolength{\\textwidth}{-3cm}
- \\setlength{\\oddsidemargin}{1.5cm}
- \\addtolength{\\oddsidemargin}{-2.54cm}
- \\setlength{\\evensidemargin}{\\oddsidemargin}
- \\setlength{\\textheight}{\\paperheight}
- \\addtolength{\\textheight}{-\\headheight}
- \\addtolength{\\textheight}{-\\headsep}
- \\addtolength{\\textheight}{-\\footskip}
- \\addtolength{\\textheight}{-3cm}
- \\setlength{\\topmargin}{1.5cm}
- \\addtolength{\\topmargin}{-2.54cm}"
- "The document header used for processing LaTeX fragments.
- It is imperative that this header make sure that no page number
- appears on the page. The package defined in the variables
- `org-latex-default-packages-alist' and `org-latex-packages-alist'
- will either replace the placeholder \"[PACKAGES]\" in this
- header, or they will be appended."
- :group 'org-latex
- :type 'string)
- (defun org-set-packages-alist (var val)
- "Set the packages alist and make sure it has 3 elements per entry."
- (set-default-toplevel-value var (mapcar (lambda (x)
- (if (and (consp x) (= (length x) 2))
- (list (car x) (nth 1 x) t)
- x))
- val)))
- (defun org-get-packages-alist (var)
- "Get the packages alist and make sure it has 3 elements per entry."
- (mapcar (lambda (x)
- (if (and (consp x) (= (length x) 2))
- (list (car x) (nth 1 x) t)
- x))
- (default-value var)))
- (defcustom org-latex-default-packages-alist
- '(("AUTO" "inputenc" t ("pdflatex"))
- ("T1" "fontenc" t ("pdflatex"))
- ("" "graphicx" t)
- ("" "longtable" nil)
- ("" "wrapfig" nil)
- ("" "rotating" nil)
- ("normalem" "ulem" t)
- ("" "amsmath" t)
- ("" "amssymb" t)
- ("" "capt-of" nil)
- ("" "hyperref" nil))
- "Alist of default packages to be inserted in the header.
- Change this only if one of the packages here causes an
- incompatibility with another package you are using.
- The packages in this list are needed by one part or another of
- Org mode to function properly:
- - inputenc, fontenc: for basic font and character selection
- - graphicx: for including images
- - longtable: For multipage tables
- - wrapfig: for figure placement
- - rotating: for sideways figures and tables
- - ulem: for underline and strike-through
- - amsmath: for subscript and superscript and math environments
- - amssymb: for various symbols used for interpreting the entities
- in `org-entities'. You can skip some of this package if you don't
- use any of the symbols.
- - capt-of: for captions outside of floats
- - hyperref: for cross references
- Therefore you should not modify this variable unless you know
- what you are doing. The one reason to change it anyway is that
- you might be loading some other package that conflicts with one
- of the default packages. Each element is either a cell or
- a string.
- A cell is of the format
- (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
- If SNIPPET-FLAG is non-nil, the package also needs to be included
- when compiling LaTeX snippets into images for inclusion into
- non-LaTeX output.
- COMPILERS is a list of compilers that should include the package,
- see `org-latex-compiler'. If the document compiler is not in the
- list, and the list is non-nil, the package will not be inserted
- in the final document.
- A string will be inserted as-is in the header of the document."
- :group 'org-latex
- :group 'org-export-latex
- :set 'org-set-packages-alist
- :get 'org-get-packages-alist
- :version "26.1"
- :package-version '(Org . "8.3")
- :type '(repeat
- (choice
- (list :tag "options/package pair"
- (string :tag "options")
- (string :tag "package")
- (boolean :tag "Snippet")
- (choice
- (const :tag "For all compilers" nil)
- (repeat :tag "Allowed compiler" string)))
- (string :tag "A line of LaTeX"))))
- (defcustom org-latex-packages-alist nil
- "Alist of packages to be inserted in every LaTeX header.
- These will be inserted after `org-latex-default-packages-alist'.
- Each element is either a cell or a string.
- A cell is of the format:
- (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
- SNIPPET-FLAG, when non-nil, indicates that this package is also
- needed when turning LaTeX snippets into images for inclusion into
- non-LaTeX output.
- COMPILERS is a list of compilers that should include the package,
- see `org-latex-compiler'. If the document compiler is not in the
- list, and the list is non-nil, the package will not be inserted
- in the final document.
- A string will be inserted as-is in the header of the document.
- Make sure that you only list packages here which:
- - you want in every file;
- - do not conflict with the setup in `org-format-latex-header';
- - do not conflict with the default packages in
- `org-latex-default-packages-alist'."
- :group 'org-latex
- :group 'org-export-latex
- :set 'org-set-packages-alist
- :get 'org-get-packages-alist
- :type '(repeat
- (choice
- (list :tag "options/package pair"
- (string :tag "options")
- (string :tag "package")
- (boolean :tag "Snippet"))
- (string :tag "A line of LaTeX"))))
- (defgroup org-appearance nil
- "Settings for Org mode appearance."
- :tag "Org Appearance"
- :group 'org)
- (defcustom org-level-color-stars-only nil
- "Non-nil means fontify only the stars in each headline.
- When nil, the entire headline is fontified.
- Changing it requires restart of `font-lock-mode' to become effective
- also in regions already fontified."
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-hide-leading-stars nil
- "Non-nil means hide the first N-1 stars in a headline.
- This works by using the face `org-hide' for these stars. This
- face is white for a light background, and black for a dark
- background. You may have to customize the face `org-hide' to
- make this work.
- Changing it requires restart of `font-lock-mode' to become effective
- also in regions already fontified.
- You may also set this on a per-file basis by adding one of the following
- lines to the buffer:
- #+STARTUP: hidestars
- #+STARTUP: showstars"
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-hidden-keywords nil
- "List of symbols corresponding to keywords to be hidden in the Org buffer.
- For example, a value (title) for this list makes the document's title
- appear in the buffer without the initial \"#+TITLE:\" part."
- :group 'org-appearance
- :package-version '(Org . "9.5")
- :type '(set (const :tag "#+AUTHOR" author)
- (const :tag "#+DATE" date)
- (const :tag "#+EMAIL" email)
- (const :tag "#+SUBTITLE" subtitle)
- (const :tag "#+TITLE" title)))
- (defcustom org-custom-properties nil
- "List of properties (as strings) with a special meaning.
- The default use of these custom properties is to let the user
- hide them with `org-toggle-custom-properties-visibility'."
- :group 'org-properties
- :group 'org-appearance
- :version "24.3"
- :type '(repeat (string :tag "Property Name")))
- (defcustom org-fontify-todo-headline nil
- "Non-nil means change the face of a headline if it is marked as TODO.
- Normally, only the TODO/DONE keyword indicates the state of a headline.
- When this is non-nil, the headline after the keyword is set to the
- `org-headline-todo' as an additional indication."
- :group 'org-appearance
- :package-version '(Org . "9.4")
- :type 'boolean
- :safe #'booleanp)
- (defcustom org-fontify-done-headline t
- "Non-nil means change the face of a headline if it is marked DONE.
- Normally, only the TODO/DONE keyword indicates the state of a headline.
- When this is non-nil, the headline after the keyword is set to the
- `org-headline-done' as an additional indication."
- :group 'org-appearance
- :package-version '(Org . "9.4")
- :type 'boolean)
- (defcustom org-fontify-emphasized-text t
- "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
- Changing this variable requires a restart of Emacs to take effect."
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-fontify-whole-heading-line nil
- "Non-nil means fontify the whole line for headings.
- This is useful when setting a background color for the
- org-level-* faces."
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-fontify-whole-block-delimiter-line t
- "Non-nil means fontify the whole line for begin/end lines of blocks.
- This is useful when setting a background color for the
- org-block-begin-line and org-block-end-line faces."
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-highlight-latex-and-related nil
- "Non-nil means highlight LaTeX related syntax in the buffer.
- When non-nil, the value should be a list containing any of the
- following symbols:
- `native' Highlight LaTeX snippets and environments natively.
- `latex' Highlight LaTeX snippets and environments.
- `script' Highlight subscript and superscript.
- `entities' Highlight entities."
- :group 'org-appearance
- :version "24.4"
- :package-version '(Org . "8.0")
- :type '(choice
- (const :tag "No highlighting" nil)
- (set :greedy t :tag "Highlight"
- (const :tag "LaTeX snippets and environments (native)" native)
- (const :tag "LaTeX snippets and environments" latex)
- (const :tag "Subscript and superscript" script)
- (const :tag "Entities" entities))))
- (defcustom org-hide-emphasis-markers nil
- "Non-nil mean font-lock should hide the emphasis marker characters."
- :group 'org-appearance
- :type 'boolean
- :safe #'booleanp)
- (defcustom org-hide-macro-markers nil
- "Non-nil mean font-lock should hide the brackets marking macro calls."
- :group 'org-appearance
- :type 'boolean)
- (defcustom org-pretty-entities nil
- "Non-nil means show entities as UTF8 characters.
- When nil, the \\name form remains in the buffer."
- :group 'org-appearance
- :version "24.1"
- :type 'boolean)
- (defcustom org-pretty-entities-include-sub-superscripts t
- "Non-nil means, pretty entity display includes formatting sub/superscripts."
- :group 'org-appearance
- :version "24.1"
- :type 'boolean)
- (defvar org-emph-re nil
- "Regular expression for matching emphasis.
- After a match, the match groups contain these elements:
- 0 The match of the full regular expression, including the characters
- before and after the proper match
- 1 The character before the proper match, or empty at beginning of line
- 2 The proper match, including the leading and trailing markers
- 3 The leading marker like * or /, indicating the type of highlighting
- 4 The text between the emphasis markers, not including the markers
- 5 The character after the match, empty at the end of a line")
- (defvar org-verbatim-re nil
- "Regular expression for matching verbatim text.")
- (defvar org-emphasis-regexp-components) ; defined just below
- (defvar org-emphasis-alist) ; defined just below
- (defun org-set-emph-re (var val)
- "Set variable and compute the emphasis regular expression."
- (set-default-toplevel-value var val)
- (when (and (boundp 'org-emphasis-alist)
- (boundp 'org-emphasis-regexp-components)
- org-emphasis-alist org-emphasis-regexp-components)
- (pcase-let*
- ((`(,pre ,post ,border ,body ,nl) org-emphasis-regexp-components)
- (body (if (<= nl 0) body
- (format "%s*?\\(?:\n%s*?\\)\\{0,%d\\}" body body nl)))
- (template
- (format (concat "\\([%s]\\|^\\)" ;before markers
- "\\(\\([%%s]\\)\\([^%s]\\|[^%s]%s[^%s]\\)\\3\\)"
- "\\([%s]\\|$\\)") ;after markers
- pre border border body border post)))
- (setq org-emph-re (format template "*/_+"))
- (setq org-verbatim-re (format template "=~")))))
- ;; This used to be a defcustom (Org <8.0) but allowing the users to
- ;; set this option proved cumbersome. See this message/thread:
- ;; https://orgmode.org/list/B72CDC2B-72F6-43A8-AC70-E6E6295766EC@gmail.com
- (defvar org-emphasis-regexp-components
- '("-[:space:]('\"{" "-[:space:].,:!?;'\")}\\[" "[:space:]" "." 1)
- "Components used to build the regular expression for emphasis.
- This is a list with five entries. Terminology: In an emphasis string
- like \" *strong word* \", we call the initial space PREMATCH, the final
- space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
- and \"trong wor\" is the body. The different components in this variable
- specify what is allowed/forbidden in each part:
- pre Chars allowed as prematch. Beginning of line will be allowed too.
- post Chars allowed as postmatch. End of line will be allowed too.
- border The chars *forbidden* as border characters.
- body-regexp A regexp like \".\" to match a body character. Don't use
- non-shy groups here, and don't allow newline here.
- newline The maximum number of newlines allowed in an emphasis exp.
- You need to reload Org or to restart Emacs after setting this.")
- (defcustom org-emphasis-alist
- '(("*" bold)
- ("/" italic)
- ("_" underline)
- ("=" org-verbatim verbatim)
- ("~" org-code verbatim)
- ("+" (:strike-through t)))
- "Alist of characters and faces to emphasize text.
- Text starting and ending with a special character will be emphasized,
- for example *bold*, _underlined_ and /italic/. This variable sets the
- marker characters and the face to be used by font-lock for highlighting
- in Org buffers.
- You need to reload Org or to restart Emacs after customizing this."
- :group 'org-appearance
- :set 'org-set-emph-re
- :version "24.4"
- :package-version '(Org . "8.0")
- :type '(repeat
- (list
- (string :tag "Marker character")
- (choice
- (face :tag "Font-lock-face")
- (plist :tag "Face property list"))
- (option (const verbatim)))))
- (defvar org-protecting-blocks '("src" "example" "export")
- "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
- This is needed for font-lock setup.")
- ;;; Functions and variables from their packages
- ;; Declared here to avoid compiler warnings
- (defvar mark-active)
- ;; Various packages
- (declare-function calc-eval "calc" (str &optional separator &rest args))
- (declare-function calendar-forward-day "cal-move" (arg))
- (declare-function calendar-goto-date "cal-move" (date))
- (declare-function calendar-goto-today "cal-move" ())
- (declare-function calendar-iso-from-absolute "cal-iso" (date))
- (declare-function calendar-iso-to-absolute "cal-iso" (date))
- (declare-function cdlatex-compute-tables "ext:cdlatex" ())
- (declare-function cdlatex-tab "ext:cdlatex" ())
- (declare-function dired-get-filename
- "dired"
- (&optional localp no-error-if-not-filep))
- (declare-function iswitchb-read-buffer
- "iswitchb"
- (prompt &optional
- default require-match _predicate start matches-set))
- (declare-function org-agenda-change-all-lines
- "org-agenda"
- (newhead hdmarker &optional fixface just-this))
- (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
- "org-agenda"
- (&optional end))
- (declare-function org-agenda-copy-local-variable "org-agenda" (var))
- (declare-function org-agenda-format-item
- "org-agenda"
- (extra txt &optional level category tags dotime
- remove-re habitp))
- (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
- (declare-function org-agenda-save-markers-for-cut-and-paste
- "org-agenda"
- (beg end))
- (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
- (declare-function org-agenda-skip "org-agenda" (&optional element))
- (declare-function org-attach-expand "org-attach" (file))
- (declare-function org-attach-reveal "org-attach" ())
- (declare-function org-attach-reveal-in-emacs "org-attach" ())
- (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
- (declare-function org-indent-mode "org-indent" (&optional arg))
- (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
- (declare-function org-inlinetask-goto-end "org-inlinetask" ())
- (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
- (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
- (declare-function parse-time-string "parse-time" (string))
- (defvar align-mode-rules-list)
- (defvar calc-embedded-close-formula)
- (defvar calc-embedded-open-formula)
- (defvar calc-embedded-open-mode)
- (defvar font-lock-unfontify-region-function)
- (defvar iswitchb-temp-buflist)
- (defvar org-agenda-tags-todo-honor-ignore-options)
- (defvar remember-data-file)
- (defvar texmathp-why)
- (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
- (declare-function org-clock-update-mode-line "org-clock" (&optional refresh))
- (declare-function org-resolve-clocks "org-clock"
- (&optional also-non-dangling-p prompt last-valid))
- (defvar org-clock-start-time)
- (defvar org-clock-marker (make-marker)
- "Marker recording the last clock-in.")
- (defvar org-clock-hd-marker (make-marker)
- "Marker recording the last clock-in, but the headline position.")
- (defvar org-clock-heading ""
- "The heading of the current clock entry.")
- (defun org-clocking-buffer ()
- "Return the buffer where the clock is currently running.
- Return nil if no clock is running."
- (marker-buffer org-clock-marker))
- (defalias 'org-clock-is-active #'org-clocking-buffer)
- (defun org-check-running-clock ()
- "Check if the current buffer contains the running clock.
- If yes, offer to stop it and to save the buffer with the changes."
- (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
- (y-or-n-p (format "Clock-out in buffer %s before killing it? "
- (buffer-name))))
- (org-clock-out)
- (when (y-or-n-p "Save changed buffer?")
- (save-buffer))))
- (defun org-clocktable-try-shift (dir n)
- "Check if this line starts a clock table, if yes, shift the time block."
- (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
- (org-clocktable-shift dir n)))
- ;;;###autoload
- (defun org-clock-persistence-insinuate ()
- "Set up hooks for clock persistence."
- (require 'org-clock)
- (add-hook 'org-mode-hook 'org-clock-load)
- (add-hook 'kill-emacs-hook 'org-clock-save))
- (defun org-clock-auto-clockout-insinuate ()
- "Set up hook for auto clocking out when Emacs is idle.
- See `org-clock-auto-clockout-timer'.
- This function is meant to be added to the user configuration."
- (require 'org-clock)
- (add-hook 'org-clock-in-hook #'org-clock-auto-clockout t))
- (defgroup org-archive nil
- "Options concerning archiving in Org mode."
- :tag "Org Archive"
- :group 'org-structure)
- (defcustom org-archive-location "%s_archive::"
- "The location where subtrees should be archived.
- The value of this variable is a string, consisting of two parts,
- separated by a double-colon. The first part is a filename and
- the second part is a headline.
- When the filename is omitted, archiving happens in the same file.
- %s in the filename will be replaced by the current file
- name (without the directory part). Archiving to a different file
- is useful to keep archived entries from contributing to the
- Org Agenda.
- The archived entries will be filed as subtrees of the specified
- headline. When the headline is omitted, the subtrees are simply
- filed away at the end of the file, as top-level entries. Also in
- the heading you can use %s to represent the file name, this can be
- useful when using the same archive for a number of different files.
- Here are a few examples:
- \"%s_archive::\"
- If the current file is Projects.org, archive in file
- Projects.org_archive, as top-level trees. This is the default.
- \"::* Archived Tasks\"
- Archive in the current file, under the top-level headline
- \"* Archived Tasks\".
- \"~/org/archive.org::\"
- Archive in file ~/org/archive.org (absolute path), as top-level trees.
- \"~/org/archive.org::* From %s\"
- Archive in file ~/org/archive.org (absolute path), under headlines
- \"From FILENAME\" where file name is the current file name.
- \"~/org/datetree.org::datetree/* Finished Tasks\"
- The \"datetree/\" string is special, signifying to archive
- items to the datetree. Items are placed in either the CLOSED
- date of the item, or the current date if there is no CLOSED date.
- The heading will be a subentry to the current date. There doesn't
- need to be a heading, but there always needs to be a slash after
- datetree. For example, to store archived items directly in the
- datetree, use \"~/org/datetree.org::datetree/\".
- \"basement::** Finished Tasks\"
- Archive in file ./basement (relative path), as level 3 trees
- below the level 2 heading \"** Finished Tasks\".
- You may define it locally by setting an ARCHIVE property. If
- such a property is found in the file or in an entry, and anywhere
- up the hierarchy, it will be used.
- You can also set it for the whole file using the keyword-syntax:
- #+ARCHIVE: basement::** Finished Tasks"
- :group 'org-archive
- :type 'string)
- (defcustom org-agenda-skip-archived-trees t
- "Non-nil means the agenda will skip any items located in archived trees.
- An archived tree is a tree marked with the tag ARCHIVE. The use of this
- variable is no longer recommended, you should leave it at the value t.
- Instead, use the key `v' to cycle the archives-mode in the agenda."
- :group 'org-archive
- :group 'org-agenda-skip
- :type 'boolean)
- (defcustom org-columns-skip-archived-trees t
- "Non-nil means ignore archived trees when creating column view."
- :group 'org-archive
- :group 'org-properties
- :type 'boolean)
- (defcustom org-sparse-tree-open-archived-trees nil
- "Non-nil means sparse tree construction shows matches in archived trees.
- When nil, matches in these trees are highlighted, but the trees are kept in
- collapsed state."
- :group 'org-archive
- :group 'org-sparse-trees
- :type 'boolean)
- (defcustom org-sparse-tree-default-date-type nil
- "The default date type when building a sparse tree.
- When this is nil, a date is a scheduled or a deadline timestamp.
- Otherwise, these types are allowed:
- all: all timestamps
- active: only active timestamps (<...>)
- inactive: only inactive timestamps ([...])
- scheduled: only scheduled timestamps
- deadline: only deadline timestamps"
- :type '(choice (const :tag "Scheduled or deadline" nil)
- (const :tag "All timestamps" all)
- (const :tag "Only active timestamps" active)
- (const :tag "Only inactive timestamps" inactive)
- (const :tag "Only scheduled timestamps" scheduled)
- (const :tag "Only deadline timestamps" deadline)
- (const :tag "Only closed timestamps" closed))
- :version "26.1"
- :package-version '(Org . "8.3")
- :group 'org-sparse-trees)
- (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
- ;; Declare Column View Code
- (declare-function org-columns-get-format-and-top-level "org-colview" ())
- (declare-function org-columns-compute "org-colview" (property))
- ;; Declare ID code
- (declare-function org-id-store-link "org-id")
- (declare-function org-id-locations-load "org-id")
- (declare-function org-id-locations-save "org-id")
- (defvar org-id-track-globally)
- ;;; Variables for pre-computed regular expressions, all buffer local
- (defvar-local org-todo-regexp nil
- "Matches any of the TODO state keywords.
- Since TODO keywords are case-sensitive, `case-fold-search' is
- expected to be bound to nil when matching against this regexp.")
- (defvar-local org-not-done-regexp nil
- "Matches any of the TODO state keywords except the last one.
- Since TODO keywords are case-sensitive, `case-fold-search' is
- expected to be bound to nil when matching against this regexp.")
- (defvar-local org-not-done-heading-regexp nil
- "Matches a TODO headline that is not done.
- Since TODO keywords are case-sensitive, `case-fold-search' is
- expected to be bound to nil when matching against this regexp.")
- (defvar-local org-todo-line-regexp nil
- "Matches a headline and puts TODO state into group 2 if present.
- Since TODO keywords are case-sensitive, `case-fold-search' is
- expected to be bound to nil when matching against this regexp.")
- (defvar-local org-complex-heading-regexp nil
- "Matches a headline and puts everything into groups:
- group 1: Stars
- group 2: The TODO keyword, maybe
- group 3: Priority cookie
- group 4: True headline
- group 5: Tags
- Since TODO keywords are case-sensitive, `case-fold-search' is
- expected to be bound to nil when matching against this regexp.")
- (defvar-local org-complex-heading-regexp-format nil
- "Printf format to make regexp to match an exact headline.
- This regexp will match the headline of any node which has the
- exact headline text that is put into the format, but may have any
- TODO state, priority, tags, statistics cookies (at the beginning
- or end of the headline title), or COMMENT keyword.")
- (defvar-local org-todo-line-tags-regexp nil
- "Matches a headline and puts TODO state into group 2 if present.
- Also put tags into group 4 if tags are present.")
- (defconst org-plain-time-of-day-regexp
- (concat
- "\\(\\<[012]?[0-9]"
- "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
- "\\(--?"
- "\\(\\<[012]?[0-9]"
- "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
- "\\)?")
- "Regular expression to match a plain time or time range.
- Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
- groups carry important information:
- 0 the full match
- 1 the first time, range or not
- 8 the second time, if it is a range.")
- (defconst org-plain-time-extension-regexp
- (concat
- "\\(\\<[012]?[0-9]"
- "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
- "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
- "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
- Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
- groups carry important information:
- 0 the full match
- 7 hours of duration
- 9 minutes of duration")
- (defconst org-stamp-time-of-day-regexp
- (concat
- "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
- "\\([012][0-9]:[0-5][0-9]\\)\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?>"
- "\\(--?"
- "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
- "Regular expression to match a timestamp time or time range.
- After a match, the following groups carry important information:
- 0 the full match
- 1 date plus weekday, for back referencing to make sure
- both times are on the same day
- 2 the first time, range or not
- 4 the second time, if it is a range.")
- (defconst org-startup-options
- '(("fold" org-startup-folded t)
- ("overview" org-startup-folded t)
- ("nofold" org-startup-folded nil)
- ("showall" org-startup-folded nil)
- ("show2levels" org-startup-folded show2levels)
- ("show3levels" org-startup-folded show3levels)
- ("show4levels" org-startup-folded show4levels)
- ("show5levels" org-startup-folded show5levels)
- ("showeverything" org-startup-folded showeverything)
- ("content" org-startup-folded content)
- ("indent" org-startup-indented t)
- ("noindent" org-startup-indented nil)
- ("num" org-startup-numerated t)
- ("nonum" org-startup-numerated nil)
- ("hidestars" org-hide-leading-stars t)
- ("showstars" org-hide-leading-stars nil)
- ("odd" org-odd-levels-only t)
- ("oddeven" org-odd-levels-only nil)
- ("align" org-startup-align-all-tables t)
- ("noalign" org-startup-align-all-tables nil)
- ("shrink" org-startup-shrink-all-tables t)
- ("inlineimages" org-startup-with-inline-images t)
- ("noinlineimages" org-startup-with-inline-images nil)
- ("latexpreview" org-startup-with-latex-preview t)
- ("nolatexpreview" org-startup-with-latex-preview nil)
- ("customtime" org-display-custom-times t)
- ("logdone" org-log-done time)
- ("lognotedone" org-log-done note)
- ("nologdone" org-log-done nil)
- ("lognoteclock-out" org-log-note-clock-out t)
- ("nolognoteclock-out" org-log-note-clock-out nil)
- ("logrepeat" org-log-repeat state)
- ("lognoterepeat" org-log-repeat note)
- ("logdrawer" org-log-into-drawer t)
- ("nologdrawer" org-log-into-drawer nil)
- ("logstatesreversed" org-log-states-order-reversed t)
- ("nologstatesreversed" org-log-states-order-reversed nil)
- ("nologrepeat" org-log-repeat nil)
- ("logreschedule" org-log-reschedule time)
- ("lognotereschedule" org-log-reschedule note)
- ("nologreschedule" org-log-reschedule nil)
- ("logredeadline" org-log-redeadline time)
- ("lognoteredeadline" org-log-redeadline note)
- ("nologredeadline" org-log-redeadline nil)
- ("logrefile" org-log-refile time)
- ("lognoterefile" org-log-refile note)
- ("nologrefile" org-log-refile nil)
- ("fninline" org-footnote-define-inline t)
- ("nofninline" org-footnote-define-inline nil)
- ("fnlocal" org-footnote-section nil)
- ("fnauto" org-footnote-auto-label t)
- ("fnprompt" org-footnote-auto-label nil)
- ("fnconfirm" org-footnote-auto-label confirm)
- ("fnplain" org-footnote-auto-label plain)
- ("fnadjust" org-footnote-auto-adjust t)
- ("nofnadjust" org-footnote-auto-adjust nil)
- ("constcgs" constants-unit-system cgs)
- ("constSI" constants-unit-system SI)
- ("noptag" org-tag-persistent-alist nil)
- ("hideblocks" org-hide-block-startup t)
- ("nohideblocks" org-hide-block-startup nil)
- ("hidedrawers" org-hide-drawer-startup t)
- ("nohidedrawers" org-hide-drawer-startup nil)
- ("beamer" org-startup-with-beamer-mode t)
- ("entitiespretty" org-pretty-entities t)
- ("entitiesplain" org-pretty-entities nil))
- "Variable associated with STARTUP options for Org.
- Each element is a list of three items: the startup options (as written
- in the #+STARTUP line), the corresponding variable, and the value to set
- this variable to if the option is found. An optional fourth element PUSH
- means to push this value onto the list in the variable.")
- (defcustom org-group-tags t
- "When non-nil (the default), use group tags.
- This can be turned on/off through `org-toggle-tags-groups'."
- :group 'org-tags
- :group 'org-startup
- :type 'boolean)
- (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
- (defun org-toggle-tags-groups ()
- "Toggle support for group tags.
- Support for group tags is controlled by the option
- `org-group-tags', which is non-nil by default."
- (interactive)
- (setq org-group-tags (not org-group-tags))
- (cond ((and (derived-mode-p 'org-agenda-mode)
- org-group-tags)
- (org-agenda-redo))
- ((derived-mode-p 'org-mode)
- (let ((org-inhibit-startup t)) (org-mode))))
- (message "Groups tags support has been turned %s"
- (if org-group-tags "on" "off")))
- (defun org--tag-add-to-alist (alist1 alist2)
- "Merge tags from ALIST1 into ALIST2.
- Duplicates tags outside a group are removed. Keywords and order
- are preserved.
- The function assumes ALIST1 and ALIST2 are proper tag alists.
- See `org-tag-alist' for their structure."
- (cond
- ((null alist2) alist1)
- ((null alist1) alist2)
- (t
- (let ((to-add nil)
- (group-flag nil))
- (dolist (tag-pair alist1)
- (pcase tag-pair
- (`(,(or :startgrouptag :startgroup))
- (setq group-flag t)
- (push tag-pair to-add))
- (`(,(or :endgrouptag :endgroup))
- (setq group-flag nil)
- (push tag-pair to-add))
- (`(,(or :grouptags :newline))
- (push tag-pair to-add))
- (`(,tag . ,_)
- ;; Remove duplicates from ALIST1, unless they are in
- ;; a group. Indeed, it makes sense to have a tag appear in
- ;; multiple groups.
- (when (or group-flag (not (assoc tag alist2)))
- (push tag-pair to-add)))
- (_ (error "Invalid association in tag alist: %S" tag-pair))))
- ;; Preserve order of ALIST1.
- (append (nreverse to-add) alist2)))))
- (defun org-priority-to-value (s)
- "Convert priority string S to its numeric value."
- (or (save-match-data
- (and (string-match "\\([0-9]+\\)" s)
- (string-to-number (match-string 1 s))))
- (string-to-char s)))
- (defun org-set-regexps-and-options (&optional tags-only)
- "Precompute regular expressions used in the current buffer.
- When optional argument TAGS-ONLY is non-nil, only compute tags
- related expressions."
- (when (derived-mode-p 'org-mode)
- (let ((alist (org-collect-keywords
- (append '("FILETAGS" "TAGS")
- (and (not tags-only)
- '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
- "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
- "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))
- '("ARCHIVE" "CATEGORY" "COLUMNS" "PRIORITIES"))))
- ;; Startup options. Get this early since it does change
- ;; behavior for other options (e.g., tags).
- (let ((startup (cl-mapcan (lambda (value) (split-string value))
- (cdr (assoc "STARTUP" alist)))))
- (dolist (option startup)
- (pcase (assoc-string option org-startup-options t)
- (`(,_ ,variable ,value t)
- (unless (listp (symbol-value variable))
- (set (make-local-variable variable) nil))
- (add-to-list variable value))
- (`(,_ ,variable ,value . ,_)
- (set (make-local-variable variable) value))
- (_ nil))))
- (setq-local org-file-tags
- (mapcar #'org-add-prop-inherited
- (cl-mapcan (lambda (value)
- (cl-mapcan
- (lambda (k) (org-split-string k ":"))
- (split-string value)))
- (cdr (assoc "FILETAGS" alist)))))
- (setq org-current-tag-alist
- (org--tag-add-to-alist
- org-tag-persistent-alist
- (let ((tags (cdr (assoc "TAGS" alist))))
- (if tags
- (org-tag-string-to-alist
- (mapconcat #'identity tags "\n"))
- org-tag-alist))))
- (setq org-tag-groups-alist
- (org-tag-alist-to-groups org-current-tag-alist))
- (unless tags-only
- ;; Properties.
- (let ((properties nil))
- (dolist (value (cdr (assoc "PROPERTY" alist)))
- (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
- (setq properties (org--update-property-plist
- (match-string-no-properties 1 value)
- (match-string-no-properties 2 value)
- properties))))
- (setq-local org-keyword-properties properties))
- ;; Archive location.
- (let ((archive (cdr (assoc "ARCHIVE" alist))))
- (when archive (setq-local org-archive-location archive)))
- ;; Category.
- (let ((category (cdr (assoc "CATEGORY" alist))))
- (when category
- (setq-local org-category (intern category))
- (setq-local org-keyword-properties
- (org--update-property-plist
- "CATEGORY" category org-keyword-properties))))
- ;; Columns.
- (let ((column (cdr (assoc "COLUMNS" alist))))
- (when column (setq-local org-columns-default-format column)))
- ;; Constants.
- (let ((store nil))
- (dolist (pair (cl-mapcan #'split-string
- (cdr (assoc "CONSTANTS" alist))))
- (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" pair)
- (let* ((name (match-string 1 pair))
- (value (match-string 2 pair))
- (old (assoc name store)))
- (if old (setcdr old value)
- (push (cons name value) store)))))
- (setq org-table-formula-constants-local store))
- ;; Link abbreviations.
- (let ((links
- (delq nil
- (mapcar
- (lambda (value)
- (and (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
- (cons (match-string-no-properties 1 value)
- (match-string-no-properties 2 value))))
- (cdr (assoc "LINK" alist))))))
- (when links (setq org-link-abbrev-alist-local (nreverse links))))
- ;; Priorities.
- (let ((value (cdr (assoc "PRIORITIES" alist))))
- (pcase (and value (split-string value))
- (`(,high ,low ,default . ,_)
- (setq-local org-priority-highest (org-priority-to-value high))
- (setq-local org-priority-lowest (org-priority-to-value low))
- (setq-local org-priority-default (org-priority-to-value default)))))
- ;; Scripts.
- (let ((value (cdr (assoc "OPTIONS" alist))))
- (dolist (option value)
- (when (string-match "\\^:\\(t\\|nil\\|{}\\)" option)
- (setq-local org-use-sub-superscripts
- (read (match-string 1 option))))))
- ;; TODO keywords.
- (setq-local org-todo-kwd-alist nil)
- (setq-local org-todo-key-alist nil)
- (setq-local org-todo-key-trigger nil)
- (setq-local org-todo-keywords-1 nil)
- (setq-local org-done-keywords nil)
- (setq-local org-todo-heads nil)
- (setq-local org-todo-sets nil)
- (setq-local org-todo-log-states nil)
- (let ((todo-sequences
- (or (append (mapcar (lambda (value)
- (cons 'type (split-string value)))
- (cdr (assoc "TYP_TODO" alist)))
- (mapcar (lambda (value)
- (cons 'sequence (split-string value)))
- (append (cdr (assoc "TODO" alist))
- (cdr (assoc "SEQ_TODO" alist)))))
- (let ((d (default-value 'org-todo-keywords)))
- (if (not (stringp (car d))) d
- ;; XXX: Backward compatibility code.
- (list (cons org-todo-interpretation d)))))))
- (dolist (sequence todo-sequences)
- (let* ((sequence (or (run-hook-with-args-until-success
- 'org-todo-setup-filter-hook sequence)
- sequence))
- (sequence-type (car sequence))
- (keywords (cdr sequence))
- (sep (member "|" keywords))
- names alist)
- (dolist (k (remove "|" keywords))
- (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
- k)
- (error "Invalid TODO keyword %s" k))
- (let ((name (match-string 1 k))
- (key (match-string 2 k))
- (log (org-extract-log-state-settings k)))
- (push name names)
- (push (cons name (and key (string-to-char key))) alist)
- (when log (push log org-todo-log-states))))
- (let* ((names (nreverse names))
- (done (if sep (org-remove-keyword-keys (cdr sep))
- (last names)))
- (head (car names))
- (tail (list sequence-type head (car done) (org-last done))))
- (add-to-list 'org-todo-heads head 'append)
- (push names org-todo-sets)
- (setq org-done-keywords (append org-done-keywords done nil))
- (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
- (setq org-todo-key-alist
- (append org-todo-key-alist
- (and alist
- (append '((:startgroup))
- (nreverse alist)
- '((:endgroup))))))
- (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
- (setq org-todo-sets (nreverse org-todo-sets)
- org-todo-kwd-alist (nreverse org-todo-kwd-alist)
- org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
- org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
- ;; Compute the regular expressions and other local variables.
- ;; Using `org-outline-regexp-bol' would complicate them much,
- ;; because of the fixed white space at the end of that string.
- (unless org-done-keywords
- (setq org-done-keywords
- (and org-todo-keywords-1 (last org-todo-keywords-1))))
- (setq org-not-done-keywords
- (org-delete-all org-done-keywords
- (copy-sequence org-todo-keywords-1))
- org-todo-regexp (regexp-opt org-todo-keywords-1 t)
- org-not-done-regexp (regexp-opt org-not-done-keywords t)
- org-not-done-heading-regexp
- (format org-heading-keyword-regexp-format org-not-done-regexp)
- org-todo-line-regexp
- (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
- org-complex-heading-regexp
- (concat "^\\(\\*+\\)"
- "\\(?: +" org-todo-regexp "\\)?"
- "\\(?: +\\(\\[#.\\]\\)\\)?"
- "\\(?: +\\(.*?\\)\\)??"
- "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?"
- "[ \t]*$")
- org-complex-heading-regexp-format
- (concat "^\\(\\*+\\)"
- "\\(?: +" org-todo-regexp "\\)?"
- "\\(?: +\\(\\[#.\\]\\)\\)?"
- "\\(?: +"
- ;; Headline might be commented
- "\\(?:" org-comment-string " +\\)?"
- ;; Stats cookies can be stuck to body.
- "\\(?:\\[[0-9%%/]+\\] *\\)*"
- "\\(%s\\)"
- "\\(?: *\\[[0-9%%/]+\\]\\)*"
- "\\)"
- "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?"
- "[ \t]*$")
- org-todo-line-tags-regexp
- (concat "^\\(\\*+\\)"
- "\\(?: +" org-todo-regexp "\\)?"
- "\\(?: +\\(.*?\\)\\)??"
- "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?"
- "[ \t]*$"))
- (org-compute-latex-and-related-regexp)))))
- (defun org-collect-keywords (keywords &optional unique directory)
- "Return values for KEYWORDS in current buffer, as an alist.
- KEYWORDS is a list of strings. Return value is a list of
- elements with the pattern:
- (NAME . LIST-OF-VALUES)
- where NAME is the upcase name of the keyword, and LIST-OF-VALUES
- is a list of non-empty values, as strings, in order of appearance
- in the buffer.
- When KEYWORD appears in UNIQUE list, LIST-OF-VALUE is its first
- value, empty or not, appearing in the buffer, as a string.
- When KEYWORD appears in DIRECTORIES, each value is a cons cell:
- (VALUE . DIRECTORY)
- where VALUE is the regular value, and DIRECTORY is the variable
- `default-directory' for the buffer containing the keyword. This
- is important for values containing relative file names, since the
- function follows SETUPFILE keywords, and may change its working
- directory."
- (let* ((keywords (cons "SETUPFILE" (mapcar #'upcase keywords)))
- (unique (mapcar #'upcase unique))
- (alist (org--collect-keywords-1
- keywords unique directory
- (and buffer-file-name (list buffer-file-name))
- nil)))
- ;; Re-order results.
- (dolist (entry alist)
- (pcase entry
- (`(,_ . ,(and value (pred consp)))
- (setcdr entry (nreverse value)))))
- (nreverse alist)))
- (defun org--collect-keywords-1 (keywords unique directory files alist)
- (org-with-point-at 1
- (let ((case-fold-search t)
- (regexp (org-make-options-regexp keywords)))
- (while (and keywords (re-search-forward regexp nil t))
- (let ((element (org-element-at-point)))
- (when (eq 'keyword (org-element-type element))
- (let ((value (org-element-property :value element)))
- (pcase (org-element-property :key element)
- ("SETUPFILE"
- (when (and (org-string-nw-p value)
- (not buffer-read-only)) ;FIXME: bug in Gnus?
- (let* ((uri (org-strip-quotes value))
- (uri-is-url (org-url-p uri))
- (uri (if uri-is-url
- uri
- (expand-file-name uri))))
- (unless (member uri files)
- (with-temp-buffer
- (unless uri-is-url
- (setq default-directory (file-name-directory uri)))
- (let ((contents (org-file-contents uri :noerror)))
- (when contents
- (insert contents)
- ;; Fake Org mode: `org-element-at-point'
- ;; doesn't need full set-up.
- (let ((major-mode 'org-mode))
- (setq alist
- (org--collect-keywords-1
- keywords unique directory
- (cons uri files)
- alist))))))))))
- (keyword
- (let ((entry (assoc keyword alist))
- (final
- (cond ((not (member keyword directory)) value)
- (buffer-file-name
- (cons value
- (file-name-directory buffer-file-name)))
- (t (cons value default-directory)))))
- (cond ((member keyword unique)
- (push (cons keyword final) alist)
- (setq keywords (remove keyword keywords))
- (setq regexp (org-make-options-regexp keywords)))
- ((null entry) (push (list keyword final) alist))
- (t (push final (cdr entry)))))))))))
- alist)))
- (defun org-tag-string-to-alist (s)
- "Return tag alist associated to string S.
- S is a value for TAGS keyword or produced with
- `org-tag-alist-to-string'. Return value is an alist suitable for
- `org-tag-alist' or `org-tag-persistent-alist'."
- (let ((lines (mapcar #'split-string (split-string s "\n" t)))
- (tag-re (concat "\\`\\(" org-tag-re "\\|{.+?}\\)" ; regular expression
- "\\(?:(\\(.\\))\\)?\\'"))
- alist group-flag)
- (dolist (tokens lines (cdr (nreverse alist)))
- (push '(:newline) alist)
- (while tokens
- (let ((token (pop tokens)))
- (pcase token
- ("{"
- (push '(:startgroup) alist)
- (when (equal (nth 1 tokens) ":") (setq group-flag t)))
- ("}"
- (push '(:endgroup) alist)
- (setq group-flag nil))
- ("["
- (push '(:startgrouptag) alist)
- (when (equal (nth 1 tokens) ":") (setq group-flag t)))
- ("]"
- (push '(:endgrouptag) alist)
- (setq group-flag nil))
- (":"
- (push '(:grouptags) alist))
- ((guard (string-match tag-re token))
- (let ((tag (match-string 1 token))
- (key (and (match-beginning 2)
- (string-to-char (match-string 2 token)))))
- ;; Push all tags in groups, no matter if they already
- ;; appear somewhere else in the list.
- (when (or group-flag (not (assoc tag alist)))
- (push (cons tag key) alist))))))))))
- (defun org-tag-alist-to-string (alist &optional skip-key)
- "Return tag string associated to ALIST.
- ALIST is an alist, as defined in `org-tag-alist' or
- `org-tag-persistent-alist', or produced with
- `org-tag-string-to-alist'.
- Return value is a string suitable as a value for \"TAGS\"
- keyword.
- When optional argument SKIP-KEY is non-nil, skip selection keys
- next to tags."
- (mapconcat (lambda (token)
- (pcase token
- (`(:startgroup) "{")
- (`(:endgroup) "}")
- (`(:startgrouptag) "[")
- (`(:endgrouptag) "]")
- (`(:grouptags) ":")
- (`(:newline) "\\n")
- ((and
- (guard (not skip-key))
- `(,(and tag (pred stringp)) . ,(and key (pred characterp))))
- (format "%s(%c)" tag key))
- (`(,(and tag (pred stringp)) . ,_) tag)
- (_ (user-error "Invalid tag token: %S" token))))
- alist
- " "))
- (defun org-tag-alist-to-groups (alist)
- "Return group alist from tag ALIST.
- ALIST is an alist, as defined in `org-tag-alist' or
- `org-tag-persistent-alist', or produced with
- `org-tag-string-to-alist'. Return value is an alist following
- the pattern (GROUP-TAG TAGS) where GROUP-TAG is the tag, as
- a string, summarizing TAGS, as a list of strings."
- (let (groups group-status current-group)
- (dolist (token alist (nreverse groups))
- (pcase token
- (`(,(or :startgroup :startgrouptag)) (setq group-status t))
- (`(,(or :endgroup :endgrouptag))
- (when (eq group-status 'append)
- (push (nreverse current-group) groups))
- (setq group-status nil current-group nil))
- (`(:grouptags) (setq group-status 'append))
- ((and `(,tag . ,_) (guard group-status))
- (if (eq group-status 'append) (push tag current-group)
- (setq current-group (list tag))))
- (_ nil)))))
- (defvar org--file-cache (make-hash-table :test #'equal)
- "Hash table to store contents of files referenced via a URL.
- This is the cache of file URLs read using `org-file-contents'.")
- (defun org-reset-file-cache ()
- "Reset the cache of files downloaded by `org-file-contents'."
- (clrhash org--file-cache))
- (defun org-file-contents (file &optional noerror nocache)
- "Return the contents of FILE, as a string.
- FILE can be a file name or URL.
- If FILE is a URL, download the contents. If the URL contents are
- already cached in the `org--file-cache' hash table, the download step
- is skipped.
- If NOERROR is non-nil, ignore the error when unable to read the FILE
- from file or URL, and return nil.
- If NOCACHE is non-nil, do a fresh fetch of FILE even if cached version
- is available. This option applies only if FILE is a URL."
- (let* ((is-url (org-url-p file))
- (cache (and is-url
- (not nocache)
- (gethash file org--file-cache))))
- (cond
- (cache)
- (is-url
- (if (org--should-fetch-remote-resource-p file)
- (with-current-buffer (url-retrieve-synchronously file)
- (goto-char (point-min))
- ;; Move point to after the url-retrieve header.
- (search-forward "\n\n" nil :move)
- ;; Search for the success code only in the url-retrieve header.
- (if (save-excursion
- (re-search-backward "HTTP.*\\s-+200\\s-OK" nil :noerror))
- ;; Update the cache `org--file-cache' and return contents.
- (puthash file
- (buffer-substring-no-properties (point) (point-max))
- org--file-cache)
- (funcall (if noerror #'message #'user-error)
- "Unable to fetch file from %S"
- file)
- nil))
- (funcall (if noerror #'message #'user-error)
- "The remote resource %S is considered unsafe, and will not be downloaded."
- file)))
- (t
- (with-temp-buffer
- (condition-case nil
- (progn
- (insert-file-contents file)
- (buffer-string))
- (file-error
- (funcall (if noerror #'message #'user-error)
- "Unable to read file %S"
- file)
- nil)))))))
- (defun org--should-fetch-remote-resource-p (uri)
- "Return non-nil if the URI should be fetched."
- (or (eq org-resource-download-policy t)
- (org--safe-remote-resource-p uri)
- (and (eq org-resource-download-policy 'prompt)
- (org--confirm-resource-safe uri))))
- (defun org--safe-remote-resource-p (uri)
- "Return non-nil if URI is considered safe.
- This checks every pattern in `org-safe-remote-resources', and
- returns non-nil if any of them match."
- (let ((uri-patterns org-safe-remote-resources)
- (file-uri (and buffer-file-name
- (concat "file://" (file-truename buffer-file-name))))
- match-p)
- (while (and (not match-p) uri-patterns)
- (setq match-p (or (string-match-p (car uri-patterns) uri)
- (and file-uri (string-match-p (car uri-patterns) file-uri)))
- uri-patterns (cdr uri-patterns)))
- match-p))
- (defun org--confirm-resource-safe (uri)
- "Ask the user if URI should be considered safe, returning non-nil if so."
- (unless noninteractive
- (let ((current-file (and buffer-file-name (file-truename buffer-file-name)))
- (domain (and (string-match
- (rx (seq "http" (? "s") "://")
- (optional (+ (not (any "@/\n"))) "@")
- (optional "www.")
- (one-or-more (not (any ":/?\n"))))
- uri)
- (match-string 0 uri)))
- (buf (get-buffer-create "*Org Remote Resource*")))
- ;; Set up the contents of the *Org Remote Resource* buffer.
- (with-current-buffer buf
- (erase-buffer)
- (insert "An org-mode document would like to download "
- (propertize uri 'face '(:inherit org-link :weight normal))
- ", which is not considered safe.\n\n"
- "Do you want to download this? You can type\n "
- (propertize "!" 'face 'success)
- " to download this resource, and permanantly mark it as safe.\n "
- (if domain
- (concat
- (propertize "d" 'face 'success)
- " to download this resource, and mark the domain ("
- (propertize domain 'face '(:inherit org-link :weight normal))
- ") as safe.\n ")
- "")
- (propertize "f" 'face 'success)
- (if current-file
- (concat
- " to download this resource, and permanantly mark all resources in "
- (propertize current-file 'face 'underline)
- " as safe.\n ")
- "")
- (propertize "y" 'face 'warning)
- " to download this resource, just this once.\n "
- (propertize "n" 'face 'error)
- " to skip this resource.\n")
- (setq-local cursor-type nil)
- (set-buffer-modified-p nil)
- (goto-char (point-min)))
- ;; Display the buffer and read a choice.
- (save-window-excursion
- (pop-to-buffer buf)
- (let* ((exit-chars (append '(?y ?n ?! ?d ?\s) (and current-file '(?f))))
- (prompt (format "Please type y, n%s, d, or !%s: "
- (if current-file ", f" "")
- (if (< (line-number-at-pos (point-max))
- (window-body-height))
- ""
- ", or C-v/M-v to scroll")))
- char)
- (setq char (read-char-choice prompt exit-chars))
- (when (memq char '(?! ?f ?d))
- (customize-push-and-save
- 'org-safe-remote-resources
- (list (if (eq char ?d)
- (concat "\\`" (regexp-quote domain) "\\(?:/\\|\\'\\)")
- (concat "\\`"
- (regexp-quote
- (if (and (= char ?f) current-file)
- (concat "file://" current-file) uri))
- "\\'")))))
- (prog1 (memq char '(?y ?n ?! ?d ?\s ?f))
- (quit-window t)))))))
- (defun org-extract-log-state-settings (x)
- "Extract the log state setting from a TODO keyword string.
- This will extract info from a string like \"WAIT(w@/!)\"."
- (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
- (let ((kw (match-string 1 x))
- (log1 (and (match-end 3) (match-string 3 x)))
- (log2 (and (match-end 4) (match-string 4 x))))
- (and (or log1 log2)
- (list kw
- (and log1 (if (equal log1 "!") 'time 'note))
- (and log2 (if (equal log2 "!") 'time 'note)))))))
- (defun org-remove-keyword-keys (list)
- "Remove a pair of parenthesis at the end of each string in LIST."
- (mapcar (lambda (x)
- (if (string-match "(.*)$" x)
- (substring x 0 (match-beginning 0))
- x))
- list))
- (defun org-assign-fast-keys (alist)
- "Assign fast keys to a keyword-key alist.
- Respect keys that are already there."
- (let (new e (alt ?0))
- (while (setq e (pop alist))
- (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
- (cdr e)) ;; Key already assigned.
- (push e new)
- (let ((clist (string-to-list (downcase (car e))))
- (used (append new alist)))
- (when (= (car clist) ?@)
- (pop clist))
- (while (and clist (rassoc (car clist) used))
- (pop clist))
- (unless clist
- (while (rassoc alt used)
- (cl-incf alt)))
- (push (cons (car e) (or (car clist) alt)) new))))
- (nreverse new)))
- ;;; Some variables used in various places
- (defvar org-window-configuration nil
- "Used in various places to store a window configuration.")
- (defvar org-selected-window nil
- "Used in various places to store a window configuration.")
- (defvar org-finish-function nil
- "Function to be called when `C-c C-c' is used.
- This is for getting out of special buffers like capture.")
- (defvar org-last-state)
- ;; Defined somewhere in this file, but used before definition.
- (defvar org-entities) ;; defined in org-entities.el
- (defvar org-struct-menu)
- (defvar org-org-menu)
- (defvar org-tbl-menu)
- ;;;; Define the Org mode
- (defun org-before-change-function (_beg _end)
- "Every change indicates that a table might need an update."
- (setq org-table-may-need-update t))
- (defvar org-mode-map)
- (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
- (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
- (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
- (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
- (defvar bidi-paragraph-direction)
- (defvar buffer-face-mode-face)
- (require 'outline)
- ;; Other stuff we need.
- (require 'time-date)
- (when (< emacs-major-version 28) ; preloaded in Emacs 28
- (require 'easymenu))
- (require 'org-entities)
- (require 'org-faces)
- (require 'org-list)
- (require 'org-pcomplete)
- (require 'org-src)
- (require 'org-footnote)
- (require 'org-macro)
- ;; babel
- (require 'ob)
- (defvar org-element-cache-persistent); Defined in org-element.el
- (defvar org-element-use-cache); Defined in org-element.el
- (defvar org-mode-loading nil
- "Non-nil during Org mode initialisation.")
- (defvar org-agenda-file-menu-enabled t
- "When non-nil, refresh Agenda files in Org menu when loading Org.")
- ;;;###autoload
- (define-derived-mode org-mode outline-mode "Org"
- "Outline-based notes management and organizer, alias
- \"Carsten's outline-mode for keeping track of everything.\"
- Org mode develops organizational tasks around a NOTES file which
- contains information about projects as plain text. Org mode is
- implemented on top of Outline mode, which is ideal to keep the content
- of large files well structured. It supports ToDo items, deadlines and
- time stamps, which magically appear in the diary listing of the Emacs
- calendar. Tables are easily created with a built-in table editor.
- Plain text URL-like links connect to websites, emails (VM), Usenet
- messages (Gnus), BBDB entries, and any files related to the project.
- For printing and sharing of notes, an Org file (or a part of it)
- can be exported as a structured ASCII or HTML file.
- The following commands are available:
- \\{org-mode-map}"
- (setq-local org-mode-loading t)
- (org-load-modules-maybe)
- (when org-agenda-file-menu-enabled
- (org-install-agenda-files-menu))
- (when (and org-link-descriptive
- (eq org-fold-core-style 'overlays))
- (add-to-invisibility-spec '(org-link)))
- (org-fold-initialize (or (and (stringp org-ellipsis) (not (equal "" org-ellipsis)) org-ellipsis)
- "..."))
- (make-local-variable 'org-link-descriptive)
- (when (eq org-fold-core-style 'overlays) (add-to-invisibility-spec '(org-hide-block . t)))
- (if org-link-descriptive
- (org-fold-core-set-folding-spec-property (car org-link--link-folding-spec) :visible nil)
- (org-fold-core-set-folding-spec-property (car org-link--link-folding-spec) :visible t))
- (setq-local outline-regexp org-outline-regexp)
- (setq-local outline-level 'org-outline-level)
- (when (and (stringp org-ellipsis) (not (equal "" org-ellipsis)))
- (unless org-display-table
- (setq org-display-table (make-display-table)))
- (set-display-table-slot
- org-display-table 4
- (vconcat (mapcar (lambda (c) (make-glyph-code c 'org-ellipsis))
- org-ellipsis)))
- (setq buffer-display-table org-display-table))
- (org-set-regexps-and-options)
- (org-set-font-lock-defaults)
- (when (and org-tag-faces (not org-tags-special-faces-re))
- ;; tag faces set outside customize.... force initialization.
- (org-set-tag-faces 'org-tag-faces org-tag-faces))
- ;; Calc embedded
- (setq-local calc-embedded-open-mode "# ")
- ;; Modify a few syntax entries
- (modify-syntax-entry ?\" "\"")
- (modify-syntax-entry ?\\ "_")
- (modify-syntax-entry ?~ "_")
- (modify-syntax-entry ?< "(>")
- (modify-syntax-entry ?> ")<")
- (setq-local font-lock-unfontify-region-function 'org-unfontify-region)
- ;; Activate before-change-function
- (setq-local org-table-may-need-update t)
- (add-hook 'before-change-functions 'org-before-change-function nil 'local)
- ;; Check for running clock before killing a buffer
- (add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
- ;; Initialize cache.
- (org-element-cache-reset)
- (when (and org-element-cache-persistent
- org-element-use-cache)
- (org-persist-load 'org-element--cache (current-buffer) t))
- ;; Initialize macros templates.
- (org-macro-initialize-templates)
- ;; Initialize radio targets.
- (org-update-radio-target-regexp)
- ;; Indentation.
- (setq-local indent-line-function 'org-indent-line)
- (setq-local indent-region-function 'org-indent-region)
- ;; Filling and auto-filling.
- (org-setup-filling)
- ;; Comments.
- (org-setup-comments-handling)
- ;; Beginning/end of defun
- (setq-local beginning-of-defun-function 'org-backward-element)
- (setq-local end-of-defun-function
- (lambda ()
- (if (not (org-at-heading-p))
- (org-forward-element)
- (org-forward-element)
- (forward-char -1))))
- ;; Next error for sparse trees
- (setq-local next-error-function 'org-occur-next-match)
- ;; Make commit log messages from Org documents easier.
- (setq-local add-log-current-defun-function #'org-add-log-current-headline)
- ;; Make sure dependence stuff works reliably, even for users who set it
- ;; too late :-(
- (if org-enforce-todo-dependencies
- (add-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings-or-parent)
- (remove-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings-or-parent))
- (if org-enforce-todo-checkbox-dependencies
- (add-hook 'org-blocker-hook
- 'org-block-todo-from-checkboxes)
- (remove-hook 'org-blocker-hook
- 'org-block-todo-from-checkboxes))
- ;; Align options lines
- (setq-local
- align-mode-rules-list
- '((org-in-buffer-settings
- (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
- (modes . '(org-mode)))))
- ;; Setup the pcomplete hooks
- (setq-local pcomplete-command-completion-function #'org-pcomplete-initial)
- (setq-local pcomplete-command-name-function #'org-command-at-point)
- (setq-local pcomplete-default-completion-function #'ignore)
- (setq-local pcomplete-parse-arguments-function #'org-parse-arguments)
- (setq-local pcomplete-termination-string "")
- (add-hook 'completion-at-point-functions
- #'pcomplete-completions-at-point nil t)
- (setq-local buffer-face-mode-face 'org-default)
- ;; If empty file that did not turn on Org mode automatically, make
- ;; it to.
- (when (and org-insert-mode-line-in-empty-file
- (called-interactively-p 'any)
- (= (point-min) (point-max)))
- (insert "# -*- mode: org -*-\n\n"))
- (unless org-inhibit-startup
- (org-unmodified
- (when org-startup-with-beamer-mode (org-beamer-mode))
- (when (or org-startup-align-all-tables org-startup-shrink-all-tables)
- (org-table-map-tables
- (cond ((and org-startup-align-all-tables
- org-startup-shrink-all-tables)
- (lambda () (org-table-align) (org-table-shrink)))
- (org-startup-align-all-tables #'org-table-align)
- (t #'org-table-shrink))
- t))
- (when org-startup-with-inline-images (org-display-inline-images))
- (when org-startup-with-latex-preview (org-latex-preview '(16)))
- (unless org-inhibit-startup-visibility-stuff (org-cycle-set-startup-visibility))
- (when org-startup-truncated (setq truncate-lines t))
- (when org-startup-numerated (require 'org-num) (org-num-mode 1))
- (when org-startup-indented (require 'org-indent) (org-indent-mode 1))))
- ;; Add a custom keymap for `visual-line-mode' so that activating
- ;; this minor mode does not override Org's keybindings.
- ;; FIXME: Probably `visual-line-mode' should take care of this.
- (let ((oldmap (cdr (assoc 'visual-line-mode minor-mode-map-alist)))
- (newmap (make-sparse-keymap)))
- (set-keymap-parent newmap oldmap)
- (define-key newmap [remap move-beginning-of-line] nil)
- (define-key newmap [remap move-end-of-line] nil)
- (define-key newmap [remap kill-line] nil)
- (make-local-variable 'minor-mode-overriding-map-alist)
- (push `(visual-line-mode . ,newmap) minor-mode-overriding-map-alist))
- ;; Activate `org-table-header-line-mode'
- (when org-table-header-line-p
- (org-table-header-line-mode 1))
- ;; Try to set `org-hide' face correctly.
- (let ((foreground (org-find-invisible-foreground)))
- (when foreground
- (set-face-foreground 'org-hide foreground)))
- ;; Set face extension as requested.
- (org--set-faces-extend '(org-block-begin-line org-block-end-line)
- org-fontify-whole-block-delimiter-line)
- (org--set-faces-extend org-level-faces org-fontify-whole-heading-line)
- (setq-local org-mode-loading nil))
- ;; Update `customize-package-emacs-version-alist'
- (add-to-list 'customize-package-emacs-version-alist
- '(Org ("8.0" . "24.4")
- ("8.1" . "24.4")
- ("8.2" . "24.4")
- ("8.2.7" . "24.4")
- ("8.3" . "26.1")
- ("9.0" . "26.1")
- ("9.1" . "26.1")
- ("9.2" . "27.1")
- ("9.3" . "27.1")
- ("9.4" . "27.2")
- ("9.5" . "28.1")
- ("9.6" . "29.1")))
- (defvar org-mode-transpose-word-syntax-table
- (let ((st (make-syntax-table text-mode-syntax-table)))
- (dolist (c org-emphasis-alist st)
- (modify-syntax-entry (string-to-char (car c)) "w p" st))))
- (when (fboundp 'abbrev-table-put)
- (abbrev-table-put org-mode-abbrev-table
- :parents (list text-mode-abbrev-table)))
- (defun org-find-invisible-foreground ()
- (let ((candidates (remove
- "unspecified-bg"
- (nconc
- (list (face-background 'default)
- (face-background 'org-default))
- (mapcar
- (lambda (alist)
- (when (boundp alist)
- (cdr (assq 'background-color (symbol-value alist)))))
- '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
- (list (face-foreground 'org-hide))))))
- (car (remove nil candidates))))
- (defun org-current-time (&optional rounding-minutes past)
- "Current time, possibly rounded to ROUNDING-MINUTES.
- When ROUNDING-MINUTES is not an integer, fall back on the car of
- `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
- the rounding returns a past time."
- (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
- (car org-time-stamp-rounding-minutes)))
- (now (current-time)))
- (if (< r 1)
- now
- (let* ((time (decode-time now))
- (res (org-encode-time
- (apply #'list
- 0 (* r (round (nth 1 time) r))
- (nthcdr 2 time)))))
- (if (or (not past) (time-less-p res now))
- res
- (time-subtract res (* r 60)))))))
- (defun org-today ()
- "Return today date, considering `org-extend-today-until'."
- (time-to-days
- (time-since (* 3600 org-extend-today-until))))
- ;;;; Font-Lock stuff, including the activators
- (defconst org-match-sexp-depth 3
- "Number of stacked braces for sub/superscript matching.")
- (defun org-create-multibrace-regexp (left right n)
- "Create a regular expression which will match a balanced sexp.
- Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
- as single character strings.
- The regexp returned will match the entire expression including the
- delimiters. It will also define a single group which contains the
- match except for the outermost delimiters. The maximum depth of
- stacked delimiters is N. Escaping delimiters is not possible."
- (let* ((nothing (concat "[^" left right "]*?"))
- (or "\\|")
- (re nothing)
- (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
- (while (> n 1)
- (setq n (1- n)
- re (concat re or next)
- next (concat "\\(?:" nothing left next right "\\)+" nothing)))
- (concat left "\\(" re "\\)" right)))
- (defconst org-match-substring-regexp
- (concat
- "\\(\\S-\\)\\([_^]\\)\\("
- "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
- "\\|"
- "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
- "\\|"
- "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
- "The regular expression matching a sub- or superscript.")
- (defconst org-match-substring-with-braces-regexp
- (concat
- "\\(\\S-\\)\\([_^]\\)"
- "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
- "The regular expression matching a sub- or superscript, forcing braces.")
- (defvar org-emph-face nil)
- (defun org-do-emphasis-faces (limit)
- "Run through the buffer and emphasize strings."
- (let ((quick-re (format "\\([%s]\\|^\\)\\([~=*/_+]\\)"
- (car org-emphasis-regexp-components))))
- (catch :exit
- (while (re-search-forward quick-re limit t)
- (let* ((marker (match-string 2))
- (verbatim? (member marker '("~" "="))))
- (when (save-excursion
- (goto-char (match-beginning 0))
- (and
- ;; Do not match table hlines.
- (not (and (equal marker "+")
- (org-match-line
- "[ \t]*\\(|[-+]+|?\\|\\+[-+]+\\+\\)[ \t]*$")))
- ;; Do not match headline stars. Do not consider
- ;; stars of a headline as closing marker for bold
- ;; markup either.
- (not (and (equal marker "*")
- (save-excursion
- (forward-char)
- (skip-chars-backward "*")
- (looking-at-p org-outline-regexp-bol))))
- ;; Match full emphasis markup regexp.
- (looking-at (if verbatim? org-verbatim-re org-emph-re))
- ;; Do not span over paragraph boundaries.
- (not (string-match-p org-element-paragraph-separate
- (match-string 2)))
- ;; Do not span over cells in table rows.
- (not (and (save-match-data (org-match-line "[ \t]*|"))
- (string-match-p "|" (match-string 4))))))
- (pcase-let ((`(,_ ,face ,_) (assoc marker org-emphasis-alist))
- (m (if org-hide-emphasis-markers 4 2)))
- (font-lock-prepend-text-property
- (match-beginning m) (match-end m) 'face face)
- (when verbatim?
- (org-remove-flyspell-overlays-in
- (match-beginning 0) (match-end 0))
- (when (and (org-fold-core-folding-spec-p 'org-link)
- (org-fold-core-folding-spec-p 'org-link-description))
- (org-fold-region (match-beginning 0) (match-end 0) nil 'org-link)
- (org-fold-region (match-beginning 0) (match-end 0) nil 'org-link-description))
- (remove-text-properties (match-beginning 2) (match-end 2)
- '(display t invisible t intangible t)))
- (add-text-properties (match-beginning 2) (match-end 2)
- '(font-lock-multiline t org-emphasis t))
- (when (and org-hide-emphasis-markers
- (not (org-at-comment-p)))
- (add-text-properties (match-end 4) (match-beginning 5)
- '(invisible t))
- (add-text-properties (match-beginning 3) (match-end 3)
- '(invisible t)))
- (throw :exit t))))))))
- (defun org-emphasize (&optional char)
- "Insert or change an emphasis, i.e. a font like bold or italic.
- If there is an active region, change that region to a new emphasis.
- If there is no region, just insert the marker characters and position
- the cursor between them.
- CHAR should be the marker character. If it is a space, it means to
- remove the emphasis of the selected region.
- If CHAR is not given (for example in an interactive call) it will be
- prompted for."
- (interactive)
- (let ((erc org-emphasis-regexp-components)
- (string "") beg end move s)
- (if (org-region-active-p)
- (setq beg (region-beginning)
- end (region-end)
- string (buffer-substring beg end))
- (setq move t))
- (unless char
- (message "Emphasis marker or tag: [%s]"
- (mapconcat #'car org-emphasis-alist ""))
- (setq char (read-char-exclusive)))
- (if (equal char ?\s)
- (setq s ""
- move nil)
- (unless (assoc (char-to-string char) org-emphasis-alist)
- (user-error "No such emphasis marker: \"%c\"" char))
- (setq s (char-to-string char)))
- (while (and (> (length string) 1)
- (equal (substring string 0 1) (substring string -1))
- (assoc (substring string 0 1) org-emphasis-alist))
- (setq string (substring string 1 -1)))
- (setq string (concat s string s))
- (when beg (delete-region beg end))
- (unless (or (bolp)
- (string-match (concat "[" (nth 0 erc) "\n]")
- (char-to-string (char-before (point)))))
- (insert " "))
- (unless (or (eobp)
- (string-match (concat "[" (nth 1 erc) "\n]")
- (char-to-string (char-after (point)))))
- (insert " ") (backward-char 1))
- (insert string)
- (and move (backward-char 1))))
- (defconst org-nonsticky-props
- '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
- (defsubst org-rear-nonsticky-at (pos)
- (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
- (defun org-activate-links--overlays (limit)
- "Add link properties to links.
- This includes angle, plain, and bracket links."
- (catch :exit
- (while (re-search-forward org-link-any-re limit t)
- (let* ((start (match-beginning 0))
- (end (match-end 0))
- (visible-start (or (match-beginning 3) (match-beginning 2)))
- (visible-end (or (match-end 3) (match-end 2)))
- (style (cond ((eq ?< (char-after start)) 'angle)
- ((eq ?\[ (char-after (1+ start))) 'bracket)
- (t 'plain))))
- (when (and (memq style org-highlight-links)
- ;; Do not span over paragraph boundaries.
- (not (string-match-p org-element-paragraph-separate
- (match-string 0)))
- ;; Do not confuse plain links with tags.
- (not (and (eq style 'plain)
- (let ((face (get-text-property
- (max (1- start) (point-min)) 'face)))
- (if (consp face) (memq 'org-tag face)
- (eq 'org-tag face))))))
- (let* ((link-object (save-excursion
- (goto-char start)
- (save-match-data (org-element-link-parser))))
- (link (org-element-property :raw-link link-object))
- (type (org-element-property :type link-object))
- (path (org-element-property :path link-object))
- (face-property (pcase (org-link-get-parameter type :face)
- ((and (pred functionp) face) (funcall face path))
- ((and (pred facep) face) face)
- ((and (pred consp) face) face) ;anonymous
- (_ 'org-link)))
- (properties ;for link's visible part
- (list 'mouse-face (or (org-link-get-parameter type :mouse-face)
- 'highlight)
- 'keymap (or (org-link-get-parameter type :keymap)
- org-mouse-map)
- 'help-echo (pcase (org-link-get-parameter type :help-echo)
- ((and (pred stringp) echo) echo)
- ((and (pred functionp) echo) echo)
- (_ (concat "LINK: " link)))
- 'htmlize-link (pcase (org-link-get-parameter type
- :htmlize-link)
- ((and (pred functionp) f) (funcall f))
- (_ `(:uri ,link)))
- 'font-lock-multiline t)))
- (org-remove-flyspell-overlays-in start end)
- (org-rear-nonsticky-at end)
- (if (not (eq 'bracket style))
- (progn
- (add-face-text-property start end face-property)
- (add-text-properties start end properties))
- ;; Handle invisible parts in bracket links.
- (remove-text-properties start end '(invisible nil))
- (let ((hidden
- (append `(invisible
- ,(or (org-link-get-parameter type :display)
- 'org-link))
- properties)))
- (add-text-properties start visible-start hidden)
- (add-face-text-property start end face-property)
- (add-text-properties visible-start visible-end properties)
- (add-text-properties visible-end end hidden)
- (org-rear-nonsticky-at visible-start)
- (org-rear-nonsticky-at visible-end)))
- (let ((f (org-link-get-parameter type :activate-func)))
- (when (functionp f)
- (funcall f start end path (eq style 'bracket))))
- (throw :exit t))))) ;signal success
- nil))
- (defun org-activate-links--text-properties (limit)
- "Add link properties to links.
- This includes angle, plain, and bracket links."
- (catch :exit
- (while (re-search-forward org-link-any-re limit t)
- (let* ((start (match-beginning 0))
- (end (match-end 0))
- (visible-start (or (match-beginning 3) (match-beginning 2)))
- (visible-end (or (match-end 3) (match-end 2)))
- (style (cond ((eq ?< (char-after start)) 'angle)
- ((eq ?\[ (char-after (1+ start))) 'bracket)
- (t 'plain))))
- (when (and (memq style org-highlight-links)
- ;; Do not span over paragraph boundaries.
- (not (string-match-p org-element-paragraph-separate
- (match-string 0)))
- ;; Do not confuse plain links with tags.
- (not (and (eq style 'plain)
- (let ((face (get-text-property
- (max (1- start) (point-min)) 'face)))
- (if (consp face) (memq 'org-tag face)
- (eq 'org-tag face))))))
- (let* ((link-object (save-excursion
- (goto-char start)
- (save-match-data (org-element-link-parser))))
- (link (org-element-property :raw-link link-object))
- (type (org-element-property :type link-object))
- (path (org-element-property :path link-object))
- (face-property (pcase (org-link-get-parameter type :face)
- ((and (pred functionp) face) (funcall face path))
- ((and (pred facep) face) face)
- ((and (pred consp) face) face) ;anonymous
- (_ 'org-link)))
- (properties ;for link's visible part
- (list 'mouse-face (or (org-link-get-parameter type :mouse-face)
- 'highlight)
- 'keymap (or (org-link-get-parameter type :keymap)
- org-mouse-map)
- 'help-echo (pcase (org-link-get-parameter type :help-echo)
- ((and (pred stringp) echo) echo)
- ((and (pred functionp) echo) echo)
- (_ (concat "LINK: " link)))
- 'htmlize-link (pcase (org-link-get-parameter type
- :htmlize-link)
- ((and (pred functionp) f) (funcall f))
- (_ `(:uri ,link)))
- 'font-lock-multiline t)))
- (org-remove-flyspell-overlays-in start end)
- (org-rear-nonsticky-at end)
- (if (not (eq 'bracket style))
- (progn
- (add-face-text-property start end face-property)
- (add-text-properties start end properties))
- ;; Initialise folding when used outside org-mode.
- (unless (or (derived-mode-p 'org-mode)
- (and (org-fold-folding-spec-p 'org-link-description)
- (org-fold-folding-spec-p 'org-link)))
- (org-fold-initialize (or (and (stringp org-ellipsis) (not (equal "" org-ellipsis)) org-ellipsis)
- "...")))
- ;; Handle invisible parts in bracket links.
- (let ((spec (or (org-link-get-parameter type :display)
- 'org-link)))
- (unless (org-fold-folding-spec-p spec)
- (org-fold-add-folding-spec spec
- (cdr org-link--link-folding-spec)
- nil
- 'append)
- (org-fold-core-set-folding-spec-property spec :visible t))
- (org-fold-region start end nil 'org-link)
- (org-fold-region start end nil 'org-link-description)
- ;; We are folding the whole emphasised text with SPEC
- ;; first. It makes everything invisible (or whatever
- ;; the user wants).
- (org-fold-region start end t spec)
- ;; The visible part of the text is folded using
- ;; 'org-link-description, which is forcing this part of
- ;; the text to be visible.
- (org-fold-region visible-start visible-end t 'org-link-description)
- (add-text-properties start end properties)
- (add-face-text-property start end face-property)
- (org-rear-nonsticky-at visible-start)
- (org-rear-nonsticky-at visible-end)))
- (let ((f (org-link-get-parameter type :activate-func)))
- (when (functionp f)
- (funcall f start end path (eq style 'bracket))))
- (throw :exit t))))) ;signal success
- nil))
- (defsubst org-activate-links (limit)
- "Add link properties to links.
- This includes angle, plain, and bracket links."
- (if (eq org-fold-core-style 'text-properties)
- (org-activate-links--text-properties limit)
- (org-activate-links--overlays limit)))
- (defun org-activate-code (limit)
- (when (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
- (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
- (remove-text-properties (match-beginning 0) (match-end 0)
- '(display t invisible t intangible t))
- t))
- (defcustom org-src-fontify-natively t
- "When non-nil, fontify code in code blocks.
- See also the `org-block' face."
- :type 'boolean
- :version "26.1"
- :package-version '(Org . "8.3")
- :group 'org-appearance
- :group 'org-babel)
- (defcustom org-allow-promoting-top-level-subtree nil
- "When non-nil, allow promoting a top level subtree.
- The leading star of the top level headline will be replaced
- by a #."
- :type 'boolean
- :version "24.1"
- :group 'org-appearance)
- (defun org-fontify-meta-lines-and-blocks (limit)
- (condition-case nil
- (org-fontify-meta-lines-and-blocks-1 limit)
- (error (message "Org mode fontification error in %S at %d"
- (current-buffer)
- (line-number-at-pos)))))
- (defun org-fontify-meta-lines-and-blocks-1 (limit)
- "Fontify #+ lines and blocks."
- (let ((case-fold-search t))
- (when (re-search-forward
- (rx bol (group (zero-or-more (any " \t")) "#"
- (group (group (or (seq "+" (one-or-more (any "a-zA-Z")) (optional ":"))
- (any " \t")
- eol))
- (optional (group "_" (group (one-or-more (any "a-zA-Z"))))))
- (zero-or-more (any " \t"))
- (group (group (zero-or-more (not (any " \t\n"))))
- (zero-or-more (any " \t"))
- (group (zero-or-more any)))))
- limit t)
- (let ((beg (match-beginning 0))
- (end-of-beginline (match-end 0))
- ;; Including \n at end of #+begin line will include \n
- ;; after the end of block content.
- (block-start (match-end 0))
- (block-end nil)
- (lang (match-string 7)) ; The language, if it is a source block.
- (bol-after-beginline (line-beginning-position 2))
- (dc1 (downcase (match-string 2)))
- (dc3 (downcase (match-string 3)))
- (whole-blockline org-fontify-whole-block-delimiter-line)
- beg-of-endline end-of-endline nl-before-endline quoting block-type)
- (cond
- ((and (match-end 4) (equal dc3 "+begin"))
- ;; Truly a block
- (setq block-type (downcase (match-string 5))
- ;; Src, example, export, maybe more.
- quoting (member block-type org-protecting-blocks))
- (when (re-search-forward
- (rx-to-string `(group bol (or (seq (one-or-more "*") space)
- (seq (zero-or-more (any " \t"))
- "#+end"
- ,(match-string 4)
- word-end
- (zero-or-more any)))))
- ;; We look further than LIMIT on purpose.
- nil t)
- ;; We do have a matching #+end line.
- (setq beg-of-endline (match-beginning 0)
- end-of-endline (match-end 0)
- nl-before-endline (1- (match-beginning 0)))
- (setq block-end (match-beginning 0)) ; Include the final newline.
- (when quoting
- (org-remove-flyspell-overlays-in bol-after-beginline nl-before-endline)
- (remove-text-properties beg end-of-endline
- '(display t invisible t intangible t)))
- (add-text-properties
- beg end-of-endline '(font-lock-fontified t font-lock-multiline t))
- (org-remove-flyspell-overlays-in beg bol-after-beginline)
- (org-remove-flyspell-overlays-in nl-before-endline end-of-endline)
- (cond
- ((and lang (not (string= lang "")) org-src-fontify-natively)
- (save-match-data
- (org-src-font-lock-fontify-block lang block-start block-end))
- (add-text-properties bol-after-beginline block-end '(src-block t)))
- (quoting
- (add-text-properties
- bol-after-beginline beg-of-endline
- (list 'face
- (list :inherit
- (let ((face-name
- (intern (format "org-block-%s" lang))))
- (append (and (facep face-name) (list face-name))
- '(org-block)))))))
- ((not org-fontify-quote-and-verse-blocks))
- ((string= block-type "quote")
- (add-face-text-property
- bol-after-beginline beg-of-endline 'org-quote t))
- ((string= block-type "verse")
- (add-face-text-property
- bol-after-beginline beg-of-endline 'org-verse t)))
- ;; Fontify the #+begin and #+end lines of the blocks
- (add-text-properties
- beg (if whole-blockline bol-after-beginline end-of-beginline)
- '(face org-block-begin-line))
- (unless (eq (char-after beg-of-endline) ?*)
- (add-text-properties
- beg-of-endline
- (if whole-blockline
- (let ((beg-of-next-line (1+ end-of-endline)))
- (min (point-max) beg-of-next-line))
- (min (point-max) end-of-endline))
- '(face org-block-end-line)))
- t))
- ((member dc1 '("+title:" "+subtitle:" "+author:" "+email:" "+date:"))
- (org-remove-flyspell-overlays-in
- (match-beginning 0)
- (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
- (add-text-properties
- beg (match-end 3)
- (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
- '(font-lock-fontified t invisible t)
- '(font-lock-fontified t face org-document-info-keyword)))
- (add-text-properties
- (match-beginning 6) (min (point-max) (1+ (match-end 6)))
- (if (string-equal dc1 "+title:")
- '(font-lock-fontified t face org-document-title)
- '(font-lock-fontified t face org-document-info))))
- ((string-prefix-p "+caption" dc1)
- (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
- (remove-text-properties (match-beginning 0) (match-end 0)
- '(display t invisible t intangible t))
- ;; Handle short captions
- (save-excursion
- (beginning-of-line)
- (looking-at (rx (group (zero-or-more (any " \t"))
- "#+caption"
- (optional "[" (zero-or-more any) "]")
- ":")
- (zero-or-more (any " \t")))))
- (add-text-properties (line-beginning-position) (match-end 1)
- '(font-lock-fontified t face org-meta-line))
- (add-text-properties (match-end 0) (line-end-position)
- '(font-lock-fontified t face org-block))
- t)
- ((member dc3 '(" " ""))
- ;; Just a comment, the plus was not there
- (org-remove-flyspell-overlays-in beg (match-end 0))
- (add-text-properties
- beg (match-end 0)
- '(font-lock-fontified t face font-lock-comment-face)))
- (t ;; Just any other in-buffer setting, but not indented
- (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
- (remove-text-properties (match-beginning 0) (match-end 0)
- '(display t invisible t intangible t))
- (add-text-properties beg (match-end 0)
- '(font-lock-fontified t face org-meta-line))
- t))))))
- (defun org-fontify-drawers (limit)
- "Fontify drawers."
- (when (re-search-forward org-drawer-regexp limit t)
- (add-text-properties (1- (match-beginning 1)) (1+ (match-end 1))
- '(font-lock-fontified t face org-drawer))
- (org-remove-flyspell-overlays-in
- (line-beginning-position) (line-beginning-position 2))
- t))
- (defun org-fontify-macros (limit)
- "Fontify macros."
- (when (re-search-forward "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)" limit t)
- (let ((begin (match-beginning 0))
- (opening-end (match-beginning 1)))
- (when (and (re-search-forward "\n[ \t]*\n\\|\\(}}}\\)" limit t)
- (match-string 1))
- (let ((end (match-end 1))
- (closing-start (match-beginning 1)))
- (add-text-properties
- begin end
- '(font-lock-multiline t font-lock-fontified t face org-macro))
- (org-remove-flyspell-overlays-in begin end)
- (when org-hide-macro-markers
- (add-text-properties begin opening-end '(invisible t))
- (add-text-properties closing-start end '(invisible t)))
- t)))))
- (defun org-fontify-extend-region (beg end _old-len)
- (let ((end (if (progn (goto-char end) (looking-at-p "^[*#]"))
- (1+ end) end))
- (begin-re "\\(\\\\\\[\\|\\(#\\+begin_\\|\\\\begin{\\)\\S-+\\)")
- (end-re "\\(\\\\\\]\\|\\(#\\+end_\\|\\\\end{\\)\\S-+\\)")
- (extend
- (lambda (r1 r2 dir)
- (let ((re (replace-regexp-in-string
- "\\(begin\\|end\\)" r1
- (replace-regexp-in-string
- "[][]" r2
- (match-string-no-properties 0)))))
- (re-search-forward (regexp-quote re) nil t dir)))))
- (goto-char beg)
- (back-to-indentation)
- (save-match-data
- (cond ((looking-at end-re)
- (cons (or (funcall extend "begin" "[" -1) beg) end))
- ((looking-at begin-re)
- (cons beg (or (funcall extend "end" "]" 1) end)))
- (t (cons beg end))))))
- (defun org-activate-footnote-links (limit)
- "Add text properties for footnotes."
- (let ((fn (org-footnote-next-reference-or-definition limit)))
- (when fn
- (let* ((beg (nth 1 fn))
- (end (nth 2 fn))
- (label (car fn))
- (referencep (/= (line-beginning-position) beg)))
- (when (and referencep (nth 3 fn))
- (save-excursion
- (goto-char beg)
- (search-forward (or label "fn:"))
- (org-remove-flyspell-overlays-in beg (match-end 0))))
- (add-text-properties beg end
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map
- 'help-echo
- (if referencep "Footnote reference"
- "Footnote definition")
- 'font-lock-fontified t
- 'font-lock-multiline t
- 'face 'org-footnote))))))
- (defun org-activate-dates (limit)
- "Add text properties for dates."
- (when (and (re-search-forward org-tsr-regexp-both limit t)
- (not (equal (char-before (match-beginning 0)) 91)))
- (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- (org-rear-nonsticky-at (match-end 0))
- (when org-display-custom-times
- ;; If it's a date range, activate custom time for second date.
- (when (match-end 3)
- (org-display-custom-time (match-beginning 3) (match-end 3)))
- (org-display-custom-time (match-beginning 1) (match-end 1)))
- t))
- (defun org-activate-target-links (limit)
- "Add text properties for target matches."
- (when org-target-link-regexp
- (let ((case-fold-search t))
- ;; `org-target-link-regexp' matches one character before the
- ;; actual target.
- (unless (bolp) (forward-char -1))
- (when (re-search-forward org-target-link-regexp limit t)
- (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
- (add-text-properties (match-beginning 1) (match-end 1)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map
- 'help-echo "Radio target link"
- 'org-linked-text t))
- (org-rear-nonsticky-at (match-end 1))
- t))))
- (defvar org-latex-and-related-regexp nil
- "Regular expression for highlighting LaTeX, entities and sub/superscript.")
- (defun org-compute-latex-and-related-regexp ()
- "Compute regular expression for LaTeX, entities and sub/superscript.
- Result depends on variable `org-highlight-latex-and-related'."
- (let ((re-sub
- (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
- ((eq org-use-sub-superscripts '{})
- (list org-match-substring-with-braces-regexp))
- (org-use-sub-superscripts (list org-match-substring-regexp))))
- (re-latex
- (when (or (memq 'latex org-highlight-latex-and-related)
- (memq 'native org-highlight-latex-and-related))
- (let ((matchers (plist-get org-format-latex-options :matchers)))
- (delq nil
- (mapcar (lambda (x)
- (and (member (car x) matchers) (nth 1 x)))
- org-latex-regexps)))))
- (re-entities
- (when (memq 'entities org-highlight-latex-and-related)
- (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\
- \\($\\|{}\\|[^[:alpha:]]\\)"))))
- (setq-local org-latex-and-related-regexp
- (mapconcat #'identity
- (append re-latex re-entities re-sub)
- "\\|"))))
- (defun org-do-latex-and-related (limit)
- "Highlight LaTeX snippets and environments, entities and sub/superscript.
- Stop at first highlighted object, if any. Return t if some
- highlighting was done, nil otherwise."
- (when (org-string-nw-p org-latex-and-related-regexp)
- (let ((latex-prefix-re (rx (or "$" "\\(" "\\[")))
- (blank-line-re (rx (and "\n" (zero-or-more (or " " "\t")) "\n"))))
- (catch 'found
- (while (and (< (point) limit)
- (re-search-forward org-latex-and-related-regexp nil t))
- (cond
- ((>= (match-beginning 0) limit)
- (throw 'found nil))
- ((cl-some (lambda (f)
- (memq f '(org-code org-verbatim underline
- org-special-keyword)))
- (save-excursion
- (goto-char (1+ (match-beginning 0)))
- (face-at-point nil t))))
- ;; Try to limit false positives. In this case, ignore
- ;; $$...$$, \(...\), and \[...\] LaTeX constructs if they
- ;; contain an empty line.
- ((save-excursion
- (goto-char (match-beginning 0))
- (and (looking-at-p latex-prefix-re)
- (save-match-data
- (re-search-forward blank-line-re (1- (match-end 0)) t)))))
- (t
- (let* ((offset (if (memq (char-after (1+ (match-beginning 0)))
- '(?_ ?^))
- 1
- 0))
- (start (+ offset (match-beginning 0)))
- (end (match-end 0)))
- (if (memq 'native org-highlight-latex-and-related)
- (org-src-font-lock-fontify-block "latex" start end)
- (font-lock-prepend-text-property start end
- 'face 'org-latex-and-related))
- (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
- '(font-lock-multiline t))
- (throw 'found t)))))
- nil))))
- (defun org-restart-font-lock ()
- "Restart `font-lock-mode', to force refontification."
- (when font-lock-mode
- (font-lock-mode -1)
- (font-lock-mode 1)))
- (defun org-activate-tags (limit)
- (when (re-search-forward org-tag-line-re limit t)
- (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
- (add-text-properties (match-beginning 1) (match-end 1)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- (org-rear-nonsticky-at (match-end 1))
- t))
- (defun org-outline-level ()
- "Compute the outline level of the heading at point.
- If this is called at a normal headline, the level is the number
- of stars. Use `org-reduced-level' to remove the effect of
- `org-odd-levels'. Unlike to `org-current-level', this function
- takes into consideration inlinetasks."
- (org-with-wide-buffer
- (end-of-line)
- (if (re-search-backward org-outline-regexp-bol nil t)
- (1- (- (match-end 0) (match-beginning 0)))
- 0)))
- (defvar org-font-lock-keywords nil)
- (defsubst org-re-property (property &optional literal allow-null value)
- "Return a regexp matching a PROPERTY line.
- When optional argument LITERAL is non-nil, do not quote PROPERTY.
- This is useful when PROPERTY is a regexp. When ALLOW-NULL is
- non-nil, match properties even without a value.
- Match group 3 is set to the value when it exists. If there is no
- value and ALLOW-NULL is non-nil, it is set to the empty string.
- With optional argument VALUE, match only property lines with
- that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
- unless LITERAL is non-nil."
- (concat
- "^\\(?4:[ \t]*\\)"
- (format "\\(?1::\\(?2:%s\\):\\)"
- (if literal property (regexp-quote property)))
- (cond (value
- (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
- (if literal value (regexp-quote value))))
- (allow-null
- "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
- (t
- "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
- (defconst org-property-re
- (org-re-property "\\S-+" 'literal t)
- "Regular expression matching a property line.
- There are four matching groups:
- 1: :PROPKEY: including the leading and trailing colon,
- 2: PROPKEY without the leading and trailing colon,
- 3: PROPVAL without leading or trailing spaces,
- 4: the indentation of the current line,
- 5: trailing whitespace.")
- (defvar org-font-lock-hook nil
- "Functions to be called for special font lock stuff.")
- (defvar org-font-lock-extra-keywords nil) ;Dynamically scoped.
- (defvar org-font-lock-set-keywords-hook nil
- "Functions that can manipulate `org-font-lock-extra-keywords'.
- This is called after `org-font-lock-extra-keywords' is defined, but before
- it is installed to be used by font lock. This can be useful if something
- needs to be inserted at a specific position in the font-lock sequence.")
- (defun org-font-lock-hook (limit)
- "Run `org-font-lock-hook' within LIMIT."
- (run-hook-with-args 'org-font-lock-hook limit))
- (defun org-set-font-lock-defaults ()
- "Set font lock defaults for the current buffer."
- (let ((org-font-lock-extra-keywords
- (list
- ;; Call the hook
- '(org-font-lock-hook)
- ;; Headlines
- `(,(if org-fontify-whole-heading-line
- "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
- "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
- (1 (org-get-level-face 1))
- (2 (org-get-level-face 2))
- (3 (org-get-level-face 3)))
- ;; Table lines
- '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
- (1 'org-table t))
- ;; Table internals
- '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
- '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
- '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
- '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
- ;; Properties
- (list org-property-re
- '(1 'org-special-keyword t)
- '(3 'org-property-value t))
- ;; Drawers
- '(org-fontify-drawers)
- ;; Link related fontification.
- '(org-activate-links)
- (when (memq 'tag org-highlight-links) '(org-activate-tags (1 'org-tag prepend)))
- (when (memq 'radio org-highlight-links) '(org-activate-target-links (1 'org-link t)))
- (when (memq 'date org-highlight-links) '(org-activate-dates (0 'org-date t)))
- (when (memq 'footnote org-highlight-links) '(org-activate-footnote-links))
- ;; Targets.
- (list org-radio-target-regexp '(0 'org-target t))
- (list org-target-regexp '(0 'org-target t))
- ;; Diary sexps.
- '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
- ;; Macro
- '(org-fontify-macros)
- ;; TODO keyword
- (list (format org-heading-keyword-regexp-format
- org-todo-regexp)
- '(2 (org-get-todo-face 2) prepend))
- ;; TODO
- (when org-fontify-todo-headline
- (list (format org-heading-keyword-regexp-format
- (concat
- "\\(?:"
- (mapconcat 'regexp-quote org-not-done-keywords "\\|")
- "\\)"))
- '(2 'org-headline-todo prepend)))
- ;; DONE
- (when org-fontify-done-headline
- (list (format org-heading-keyword-regexp-format
- (concat
- "\\(?:"
- (mapconcat 'regexp-quote org-done-keywords "\\|")
- "\\)"))
- '(2 'org-headline-done prepend)))
- ;; Priorities
- '(org-font-lock-add-priority-faces)
- ;; Tags
- '(org-font-lock-add-tag-faces)
- ;; Tags groups
- (when (and org-group-tags org-tag-groups-alist)
- (list (concat org-outline-regexp-bol ".+\\(:"
- (regexp-opt (mapcar 'car org-tag-groups-alist))
- ":\\).*$")
- '(1 'org-tag-group prepend)))
- ;; Special keywords
- (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
- ;; Emphasis
- (when org-fontify-emphasized-text '(org-do-emphasis-faces))
- ;; Checkboxes
- '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
- 1 'org-checkbox prepend)
- (when (cdr (assq 'checkbox org-list-automatic-rules))
- '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
- (0 (org-get-checkbox-statistics-face) prepend)))
- ;; Description list items
- '("\\(?:^[ \t]*[-+]\\|^[ \t]+[*]\\)[ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
- 1 'org-list-dt prepend)
- ;; Inline export snippets
- '("\\(@@\\)\\([a-z-]+:\\).*?\\(@@\\)"
- (1 'font-lock-comment-face t)
- (2 'org-tag t)
- (3 'font-lock-comment-face t))
- ;; ARCHIVEd headings
- (list (concat
- org-outline-regexp-bol
- "\\(.*:" org-archive-tag ":.*\\)")
- '(1 'org-archived prepend))
- ;; Specials
- '(org-do-latex-and-related)
- '(org-fontify-entities)
- '(org-raise-scripts)
- ;; Code
- '(org-activate-code (1 'org-code t))
- ;; COMMENT
- (list (format
- "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
- org-todo-regexp
- org-comment-string)
- '(9 'org-special-keyword t))
- ;; Blocks and meta lines
- '(org-fontify-meta-lines-and-blocks)
- '(org-fontify-inline-src-blocks)
- ;; Citations. When an activate processor is specified, if
- ;; specified, try loading it beforehand.
- (progn
- (unless (null org-cite-activate-processor)
- (org-cite-try-load-processor org-cite-activate-processor))
- '(org-cite-activate)))))
- (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
- (run-hooks 'org-font-lock-set-keywords-hook)
- ;; Now set the full font-lock-keywords
- (setq-local org-font-lock-keywords org-font-lock-extra-keywords)
- (setq-local font-lock-defaults
- '(org-font-lock-keywords t nil nil backward-paragraph))
- (setq-local font-lock-extend-after-change-region-function
- #'org-fontify-extend-region)
- (kill-local-variable 'font-lock-keywords)
- nil))
- (defun org-toggle-pretty-entities ()
- "Toggle the composition display of entities as UTF8 characters."
- (interactive)
- (setq-local org-pretty-entities (not org-pretty-entities))
- (org-restart-font-lock)
- (if org-pretty-entities
- (message "Entities are now displayed as UTF8 characters")
- (save-restriction
- (widen)
- (decompose-region (point-min) (point-max))
- (message "Entities are now displayed as plain text"))))
- (defvar-local org-custom-properties-overlays nil
- "List of overlays used for custom properties.")
- (defun org-toggle-custom-properties-visibility ()
- "Display or hide properties in `org-custom-properties'."
- (interactive)
- (if org-custom-properties-overlays
- (progn (mapc #'delete-overlay org-custom-properties-overlays)
- (setq org-custom-properties-overlays nil))
- (when org-custom-properties
- (org-with-wide-buffer
- (goto-char (point-min))
- (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
- (while (re-search-forward regexp nil t)
- (let ((end (cdr (save-match-data (org-get-property-block)))))
- (when (and end (< (point) end))
- ;; Hide first custom property in current drawer.
- (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
- (overlay-put o 'invisible t)
- (overlay-put o 'org-custom-property t)
- (push o org-custom-properties-overlays))
- ;; Hide additional custom properties in the same drawer.
- (while (re-search-forward regexp end t)
- (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
- (overlay-put o 'invisible t)
- (overlay-put o 'org-custom-property t)
- (push o org-custom-properties-overlays)))))
- ;; Each entry is limited to a single property drawer.
- (outline-next-heading)))))))
- (defun org-fontify-entities (limit)
- "Find an entity to fontify."
- (let (ee)
- (when org-pretty-entities
- (catch 'match
- ;; "\_ "-family is left out on purpose. Only the first one,
- ;; i.e., "\_ ", could be fontified anyway, and it would be
- ;; confusing when adding a second white space character.
- (while (re-search-forward
- "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
- limit t)
- (when (and (not (org-at-comment-p))
- (setq ee (org-entity-get (match-string 1)))
- (= (length (nth 6 ee)) 1))
- (let* ((end (if (equal (match-string 2) "{}")
- (match-end 2)
- (match-end 1))))
- (add-text-properties
- (match-beginning 0) end
- (list 'font-lock-fontified t))
- (compose-region (match-beginning 0) end
- (nth 6 ee) nil)
- (backward-char 1)
- (throw 'match t))))
- nil))))
- (defun org-fontify-like-in-org-mode (s &optional odd-levels)
- "Fontify string S like in Org mode."
- (with-temp-buffer
- (insert s)
- (let ((org-odd-levels-only odd-levels))
- (org-mode)
- (font-lock-ensure)
- (if org-link-descriptive
- (org-link-display-format
- (buffer-string))
- (buffer-string)))))
- (defun org-get-level-face (n)
- "Get the right face for match N in font-lock matching of headlines."
- (let* ((org-l0 (- (match-end 2) (match-beginning 1) 1))
- (org-l (if org-odd-levels-only (1+ (/ org-l0 2)) org-l0))
- (org-f (if org-cycle-level-faces
- (nth (% (1- org-l) org-n-level-faces) org-level-faces)
- (nth (1- (min org-l org-n-level-faces)) org-level-faces))))
- (cond
- ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
- ((eq n 2) org-f)
- (t (unless org-level-color-stars-only org-f)))))
- (defun org-face-from-face-or-color (context inherit face-or-color)
- "Create a face list that inherits INHERIT, but sets the foreground color.
- When FACE-OR-COLOR is not a string, just return it."
- (if (stringp face-or-color)
- (list :inherit inherit
- (cdr (assoc context org-faces-easy-properties))
- face-or-color)
- face-or-color))
- (defun org-get-todo-face (kwd)
- "Get the right face for a TODO keyword KWD.
- If KWD is a number, get the corresponding match group."
- (when (numberp kwd) (setq kwd (match-string kwd)))
- (or (org-face-from-face-or-color
- 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
- (and (member kwd org-done-keywords) 'org-done)
- 'org-todo))
- (defun org-get-priority-face (priority)
- "Get the right face for PRIORITY.
- PRIORITY is a character."
- (or (org-face-from-face-or-color
- 'priority 'org-priority (cdr (assq priority org-priority-faces)))
- 'org-priority))
- (defun org-get-tag-face (tag)
- "Get the right face for TAG.
- If TAG is a number, get the corresponding match group."
- (let ((tag (if (wholenump tag) (match-string tag) tag)))
- (or (org-face-from-face-or-color
- 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
- 'org-tag)))
- (defvar org-priority-regexp) ; defined later in the file
- (defun org-font-lock-add-priority-faces (limit)
- "Add the special priority faces."
- (while (re-search-forward (concat "^\\*+" org-priority-regexp) limit t)
- (let ((beg (match-beginning 1))
- (end (1+ (match-end 2))))
- (add-face-text-property
- beg end
- (org-get-priority-face (string-to-char (match-string 2))))
- (add-text-properties
- beg end
- (list 'font-lock-fontified t)))))
- (defun org-font-lock-add-tag-faces (limit)
- "Add the special tag faces."
- (when (and org-tag-faces org-tags-special-faces-re)
- (while (re-search-forward org-tags-special-faces-re limit t)
- (add-face-text-property
- (match-beginning 1)
- (match-end 1)
- (org-get-tag-face 1))
- (add-text-properties (match-beginning 1) (match-end 1)
- (list 'font-lock-fontified t))
- (backward-char 1))))
- (defun org-unfontify-region (beg end &optional _maybe_loudly)
- "Remove fontification and activation overlays from links."
- (font-lock-default-unfontify-region beg end)
- (let* ((buffer-undo-list t)
- (inhibit-read-only t) (inhibit-point-motion-hooks t)
- (inhibit-modification-hooks t)
- deactivate-mark buffer-file-name buffer-file-truename)
- (decompose-region beg end)
- (remove-text-properties beg end
- '(mouse-face t keymap t org-linked-text t
- invisible t intangible t
- org-emphasis t))
- (org-fold-region beg end nil 'org-link)
- (org-fold-region beg end nil 'org-link-description)
- (org-fold-core-update-optimisation beg end)
- (org-remove-font-lock-display-properties beg end)))
- (defconst org-script-display '(((raise -0.3) (height 0.7))
- ((raise 0.3) (height 0.7))
- ((raise -0.5))
- ((raise 0.5)))
- "Display properties for showing superscripts and subscripts.")
- (defun org-remove-font-lock-display-properties (beg end)
- "Remove specific display properties that have been added by font lock.
- The will remove the raise properties that are used to show superscripts
- and subscripts."
- (let (next prop)
- (while (< beg end)
- (setq next (next-single-property-change beg 'display nil end)
- prop (get-text-property beg 'display))
- (when (member prop org-script-display)
- (put-text-property beg next 'display nil))
- (setq beg next))))
- (defun org-raise-scripts (limit)
- "Add raise properties to sub/superscripts."
- (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
- (re-search-forward
- (if (eq org-use-sub-superscripts t)
- org-match-substring-regexp
- org-match-substring-with-braces-regexp)
- limit t))
- (let* ((pos (point)) table-p comment-p
- (mpos (match-beginning 3))
- (emph-p (get-text-property mpos 'org-emphasis))
- (link-p (get-text-property mpos 'mouse-face))
- (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
- (goto-char (line-beginning-position))
- (setq table-p (looking-at-p org-table-dataline-regexp)
- comment-p (looking-at-p "^[ \t]*#[ +]"))
- (goto-char pos)
- ;; Handle a_b^c
- (when (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
- (unless (or comment-p emph-p link-p keyw-p)
- (put-text-property (match-beginning 3) (match-end 0)
- 'display
- (if (equal (char-after (match-beginning 2)) ?^)
- (nth (if table-p 3 1) org-script-display)
- (nth (if table-p 2 0) org-script-display)))
- (put-text-property (match-beginning 2) (match-end 3)
- 'org-emphasis t)
- (add-text-properties (match-beginning 2) (match-end 2)
- (list 'invisible t))
- (when (and (eq (char-after (match-beginning 3)) ?{)
- (eq (char-before (match-end 3)) ?}))
- (add-text-properties (match-beginning 3) (1+ (match-beginning 3))
- (list 'invisible t))
- (add-text-properties (1- (match-end 3)) (match-end 3)
- (list 'invisible t))))
- t)))
- (defun org-remove-empty-overlays-at (pos)
- "Remove outline overlays that do not contain non-white stuff."
- (dolist (o (overlays-at pos))
- (and (eq 'outline (overlay-get o 'invisible))
- (not (string-match-p
- "\\S-" (buffer-substring (overlay-start o)
- (overlay-end o))))
- (delete-overlay o))))
- ;; FIXME: This function is unused.
- (defun org-show-empty-lines-in-parent ()
- "Move to the parent and re-show empty lines before visible headlines."
- (save-excursion
- (let ((context (if (org-up-heading-safe) 'children 'overview)))
- (org-cycle-show-empty-lines context))))
- (defun org-files-list ()
- "Return `org-agenda-files' list, plus all open Org files.
- This is useful for operations that need to scan all of a user's
- open and agenda-wise Org files."
- (let ((files (mapcar #'expand-file-name (org-agenda-files))))
- (dolist (buf (buffer-list))
- (with-current-buffer buf
- (when (and (derived-mode-p 'org-mode) (buffer-file-name))
- (cl-pushnew (expand-file-name (buffer-file-name)) files
- :test #'equal))))
- files))
- (defsubst org-entry-beginning-position ()
- "Return the beginning position of the current entry."
- (save-excursion (org-back-to-heading t) (point)))
- (defsubst org-entry-end-position ()
- "Return the end position of the current entry."
- (save-excursion (outline-next-heading) (point)))
- (defun org-subtree-end-visible-p ()
- "Is the end of the current subtree visible?"
- (pos-visible-in-window-p
- (save-excursion (org-end-of-subtree t) (point))))
- (defun org-first-headline-recenter ()
- "Move cursor to the first headline and recenter the headline."
- (let ((window (get-buffer-window)))
- (when window
- (goto-char (point-min))
- (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
- (set-window-start window (line-beginning-position))))))
- ;; FIXME: It was in the middle of visibility section. Where should it go to?
- (defvar org-called-with-limited-levels nil
- "Non-nil when `org-with-limited-levels' is currently active.")
- ;;; Indirect buffer display of subtrees
- (defvar org-indirect-dedicated-frame nil
- "This is the frame being used for indirect tree display.")
- (defvar org-last-indirect-buffer nil)
- (defun org-tree-to-indirect-buffer (&optional arg)
- "Create indirect buffer and narrow it to current subtree.
- With a numerical prefix ARG, go up to this level and then take that tree.
- If ARG is negative, go up that many levels.
- If `org-indirect-buffer-display' is not `new-frame', the command removes the
- indirect buffer previously made with this command, to avoid proliferation of
- indirect buffers. However, when you call the command with a \
- `\\[universal-argument]' prefix, or
- when `org-indirect-buffer-display' is `new-frame', the last buffer is kept
- so that you can work with several indirect buffers at the same time. If
- `org-indirect-buffer-display' is `dedicated-frame', the \
- `\\[universal-argument]' prefix also
- requests that a new frame be made for the new buffer, so that the dedicated
- frame is not changed."
- (interactive "P")
- (let ((cbuf (current-buffer))
- (cwin (selected-window))
- (pos (point))
- beg end level heading ibuf)
- (save-excursion
- (org-back-to-heading t)
- (when (numberp arg)
- (setq level (org-outline-level))
- (when (< arg 0) (setq arg (+ level arg)))
- (while (> (setq level (org-outline-level)) arg)
- (org-up-heading-safe)))
- (setq beg (point)
- heading (org-get-heading 'no-tags))
- (org-end-of-subtree t t)
- (when (and (not (eobp)) (org-at-heading-p)) (backward-char 1))
- (setq end (point)))
- (when (and (buffer-live-p org-last-indirect-buffer)
- (not (eq org-indirect-buffer-display 'new-frame))
- (not arg))
- (kill-buffer org-last-indirect-buffer))
- (setq ibuf (org-get-indirect-buffer cbuf heading)
- org-last-indirect-buffer ibuf)
- (cond
- ((or (eq org-indirect-buffer-display 'new-frame)
- (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
- (select-frame (make-frame))
- (delete-other-windows)
- (pop-to-buffer-same-window ibuf)
- (org-set-frame-title heading))
- ((eq org-indirect-buffer-display 'dedicated-frame)
- (raise-frame
- (select-frame (or (and org-indirect-dedicated-frame
- (frame-live-p org-indirect-dedicated-frame)
- org-indirect-dedicated-frame)
- (setq org-indirect-dedicated-frame (make-frame)))))
- (delete-other-windows)
- (pop-to-buffer-same-window ibuf)
- (org-set-frame-title (concat "Indirect: " heading)))
- ((eq org-indirect-buffer-display 'current-window)
- (pop-to-buffer-same-window ibuf))
- ((eq org-indirect-buffer-display 'other-window)
- (pop-to-buffer ibuf))
- (t (error "Invalid value")))
- (narrow-to-region beg end)
- (org-fold-show-all '(headings drawers blocks))
- (goto-char pos)
- (run-hook-with-args 'org-cycle-hook 'all)
- (and (window-live-p cwin) (select-window cwin))))
- (defun org-get-indirect-buffer (&optional buffer heading)
- (setq buffer (or buffer (current-buffer)))
- (let ((n 1) (base (buffer-name buffer)) bname)
- (while (buffer-live-p
- (get-buffer
- (setq bname
- (concat base "-"
- (if heading (concat heading "-" (number-to-string n))
- (number-to-string n))))))
- (setq n (1+ n)))
- (condition-case nil
- (let ((indirect-buffer (make-indirect-buffer buffer bname 'clone)))
- ;; Decouple folding state. We need to do it manually since
- ;; `make-indirect-buffer' does not run
- ;; `clone-indirect-buffer-hook'.
- (org-fold-core-decouple-indirect-buffer-folds)
- ;; Return the buffer.
- indirect-buffer)
- (error (make-indirect-buffer buffer bname)))))
- (defun org-set-frame-title (title)
- "Set the title of the current frame to the string TITLE."
- (modify-frame-parameters (selected-frame) (list (cons 'name title))))
- ;;;; Structure editing
- ;;; Inserting headlines
- (defun org--blank-before-heading-p (&optional parent)
- "Non-nil when an empty line should precede a new heading here.
- When optional argument PARENT is non-nil, consider parent
- headline instead of current one."
- (pcase (assq 'heading org-blank-before-new-entry)
- (`(heading . auto)
- (save-excursion
- (org-with-limited-levels
- (unless (and (org-before-first-heading-p)
- (not (outline-next-heading)))
- (org-back-to-heading t)
- (when parent (org-up-heading-safe))
- (cond ((not (bobp))
- (org-previous-line-empty-p))
- ((outline-next-heading)
- (org-previous-line-empty-p))
- ;; Ignore trailing spaces on last buffer line.
- ((progn (skip-chars-backward " \t") (bolp))
- (org-previous-line-empty-p))
- (t nil))))))
- (`(heading . ,value) value)
- (_ nil)))
- (defun org-insert-heading (&optional arg invisible-ok top)
- "Insert a new heading or an item with the same depth at point.
- If point is at the beginning of a heading, insert a new heading
- or a new headline above the current one. When at the beginning
- of a regular line of text, turn it into a heading.
- If point is in the middle of a line, split it and create a new
- headline with the text in the current line after point (see
- `org-M-RET-may-split-line' on how to modify this behavior). As
- a special case, on a headline, splitting can only happen on the
- title itself. E.g., this excludes breaking stars or tags.
- With a `\\[universal-argument]' prefix, set \
- `org-insert-heading-respect-content' to
- a non-nil value for the duration of the command. This forces the
- insertion of a heading after the current subtree, independently
- on the location of point.
- With a `\\[universal-argument] \\[universal-argument]' prefix, \
- insert the heading at the end of the tree
- above the current heading. For example, if point is within a
- 2nd-level heading, then it will insert a 2nd-level heading at
- the end of the 1st-level parent subtree.
- When INVISIBLE-OK is set, stop at invisible headlines when going
- back. This is important for non-interactive uses of the
- command.
- When optional argument TOP is non-nil, insert a level 1 heading,
- unconditionally."
- (interactive "P")
- (let* ((blank? (org--blank-before-heading-p (equal arg '(16))))
- (level (org-current-level))
- (stars (make-string (if (and level (not top)) level 1) ?*)))
- (cond
- ((or org-insert-heading-respect-content
- (member arg '((4) (16)))
- (and (not invisible-ok)
- (invisible-p (max (1- (point)) (point-min)))))
- ;; Position point at the location of insertion. Make sure we
- ;; end up on a visible headline if INVISIBLE-OK is nil.
- (org-with-limited-levels
- (if (not level) (outline-next-heading) ;before first headline
- (org-back-to-heading invisible-ok)
- (when (equal arg '(16)) (org-up-heading-safe))
- (org-end-of-subtree)))
- (unless (bolp) (insert "\n"))
- (when (and blank? (save-excursion
- (backward-char)
- (org-before-first-heading-p)))
- (insert "\n")
- (backward-char))
- (when (and (not level) (not (eobp)) (not (bobp)))
- (when (org-at-heading-p) (insert "\n"))
- (backward-char))
- (unless (and blank? (org-previous-line-empty-p))
- (org-N-empty-lines-before-current (if blank? 1 0)))
- (insert stars " ")
- ;; When INVISIBLE-OK is non-nil, ensure newly created headline
- ;; is visible.
- (unless invisible-ok
- (if (eq org-fold-core-style 'text-properties)
- (cond
- ((org-fold-folded-p
- (max (point-min)
- (1- (line-beginning-position)))
- 'headline)
- (org-fold-region (line-end-position 0) (line-end-position) nil 'headline))
- (t nil))
- (pcase (get-char-property-and-overlay (point) 'invisible)
- (`(outline . ,o)
- (move-overlay o (overlay-start o) (line-end-position 0)))
- (_ nil)))))
- ;; At a headline...
- ((org-at-heading-p)
- (cond ((bolp)
- (when blank? (save-excursion (insert "\n")))
- (save-excursion (insert stars " \n"))
- (unless (and blank? (org-previous-line-empty-p))
- (org-N-empty-lines-before-current (if blank? 1 0)))
- (end-of-line))
- ((and (org-get-alist-option org-M-RET-may-split-line 'headline)
- (org-match-line org-complex-heading-regexp)
- (org-pos-in-match-range (point) 4))
- ;; Grab the text that should moved to the new headline.
- ;; Preserve tags.
- (let ((split (delete-and-extract-region (point) (match-end 4))))
- (if (looking-at "[ \t]*$") (replace-match "")
- (org-align-tags))
- (end-of-line)
- (when blank? (insert "\n"))
- (insert "\n" stars " ")
- (when (org-string-nw-p split) (insert split))))
- (t
- (end-of-line)
- (when blank? (insert "\n"))
- (insert "\n" stars " "))))
- ;; On regular text, turn line into a headline or split, if
- ;; appropriate.
- ((bolp)
- (insert stars " ")
- (unless (and blank? (org-previous-line-empty-p))
- (org-N-empty-lines-before-current (if blank? 1 0))))
- (t
- (unless (org-get-alist-option org-M-RET-may-split-line 'headline)
- (end-of-line))
- (insert "\n" stars " ")
- (unless (and blank? (org-previous-line-empty-p))
- (org-N-empty-lines-before-current (if blank? 1 0))))))
- (run-hooks 'org-insert-heading-hook))
- (defun org-N-empty-lines-before-current (n)
- "Make the number of empty lines before current exactly N.
- So this will delete or add empty lines."
- (let ((column (current-column)))
- (beginning-of-line)
- (unless (bobp)
- (let ((start (save-excursion
- (skip-chars-backward " \r\t\n")
- (line-end-position))))
- (delete-region start (line-end-position 0))))
- (insert (make-string n ?\n))
- (move-to-column column)))
- (defun org-get-heading (&optional no-tags no-todo no-priority no-comment)
- "Return the heading of the current entry, without the stars.
- When NO-TAGS is non-nil, don't include tags.
- When NO-TODO is non-nil, don't include TODO keywords.
- When NO-PRIORITY is non-nil, don't include priority cookie.
- When NO-COMMENT is non-nil, don't include COMMENT string.
- Return nil before first heading."
- (unless (org-before-first-heading-p)
- (save-excursion
- (org-back-to-heading t)
- (let ((case-fold-search nil))
- (looking-at org-complex-heading-regexp)
- ;; When using `org-fold-core--optimise-for-huge-buffers',
- ;; returned text will be invisible. Clear it up.
- (save-match-data
- (org-fold-core-remove-optimisation (match-beginning 0) (match-end 0)))
- (let ((todo (and (not no-todo) (match-string 2)))
- (priority (and (not no-priority) (match-string 3)))
- (headline (pcase (match-string 4)
- (`nil "")
- ((and (guard no-comment) h)
- (replace-regexp-in-string
- (eval-when-compile
- (format "\\`%s[ \t]+" org-comment-string))
- "" h))
- (h h)))
- (tags (and (not no-tags) (match-string 5))))
- ;; Restore cleared optimisation.
- (org-fold-core-update-optimisation (match-beginning 0) (match-end 0))
- (mapconcat #'identity
- (delq nil (list todo priority headline tags))
- " "))))))
- (defun org-heading-components ()
- "Return the components of the current heading.
- This is a list with the following elements:
- - the level as an integer
- - the reduced level, different if `org-odd-levels-only' is set.
- - the TODO keyword, or nil
- - the priority character, like ?A, or nil if no priority is given
- - the headline text itself, or the tags string if no headline text
- - the tags string, or nil."
- (save-excursion
- (org-back-to-heading t)
- (when (let (case-fold-search) (looking-at org-complex-heading-regexp))
- (org-fold-core-remove-optimisation (match-beginning 0) (match-end 0))
- (prog1
- (list (length (match-string 1))
- (org-reduced-level (length (match-string 1)))
- (match-string-no-properties 2)
- (and (match-end 3) (aref (match-string 3) 2))
- (match-string-no-properties 4)
- (match-string-no-properties 5))
- (org-fold-core-update-optimisation (match-beginning 0) (match-end 0))))))
- (defun org-get-entry ()
- "Get the entry text, after heading, entire subtree."
- (save-excursion
- (org-back-to-heading t)
- (filter-buffer-substring (line-beginning-position 2) (org-end-of-subtree t))))
- (defun org-edit-headline (&optional heading)
- "Edit the current headline.
- Set it to HEADING when provided."
- (interactive)
- (org-with-wide-buffer
- (org-back-to-heading t)
- (let ((case-fold-search nil))
- (when (looking-at org-complex-heading-regexp)
- (let* ((old (match-string-no-properties 4))
- (new (save-match-data
- (org-trim (or heading (read-string "Edit: " old))))))
- (unless (equal old new)
- (if old (replace-match new t t nil 4)
- (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
- (insert " " new))
- (org-align-tags)
- (when (looking-at "[ \t]*$") (replace-match ""))))))))
- (defun org-insert-heading-after-current ()
- "Insert a new heading with same level as current, after current subtree."
- (interactive)
- (org-back-to-heading)
- (org-insert-heading)
- (org-move-subtree-down)
- (end-of-line 1))
- (defun org-insert-heading-respect-content (&optional invisible-ok)
- "Insert heading with `org-insert-heading-respect-content' set to t."
- (interactive)
- (org-insert-heading '(4) invisible-ok))
- (defun org-insert-todo-heading-respect-content (&optional _)
- "Insert TODO heading with `org-insert-heading-respect-content' set to t."
- (interactive)
- (let ((org-insert-heading-respect-content t))
- (org-insert-todo-heading '(4) t)))
- (defun org-insert-todo-heading (arg &optional force-heading)
- "Insert a new heading with the same level and TODO state as current heading.
- If the heading has no TODO state, or if the state is DONE, use
- the first state (TODO by default). Also with one prefix arg,
- force first state. With two prefix args, force inserting at the
- end of the parent subtree.
- When called at a plain list item, insert a new item with an
- unchecked check box."
- (interactive "P")
- (when (or force-heading (not (org-insert-item 'checkbox)))
- (org-insert-heading (or (and (equal arg '(16)) '(16))
- force-heading))
- (save-excursion
- (org-forward-heading-same-level -1)
- (let ((case-fold-search nil)) (looking-at org-todo-line-regexp)))
- (let* ((new-mark-x
- (if (or (equal arg '(4))
- (not (match-beginning 2))
- (member (match-string 2) org-done-keywords))
- (car org-todo-keywords-1)
- (match-string 2)))
- (new-mark
- (or
- (run-hook-with-args-until-success
- 'org-todo-get-default-hook new-mark-x nil)
- new-mark-x)))
- (beginning-of-line 1)
- (and (looking-at org-outline-regexp) (goto-char (match-end 0))
- (if org-treat-insert-todo-heading-as-state-change
- (org-todo new-mark)
- (insert new-mark " "))))
- (when org-provide-todo-statistics
- (org-update-parent-todo-statistics))))
- (defun org-insert-subheading (arg)
- "Insert a new subheading and demote it.
- Works for outline headings and for plain lists alike."
- (interactive "P")
- (org-insert-heading arg)
- (cond
- ((org-at-heading-p) (org-do-demote))
- ((org-at-item-p) (org-indent-item))))
- (defun org-insert-todo-subheading (arg)
- "Insert a new subheading with TODO keyword or checkbox and demote it.
- Works for outline headings and for plain lists alike."
- (interactive "P")
- (org-insert-todo-heading arg)
- (cond
- ((org-at-heading-p) (org-do-demote))
- ((org-at-item-p) (org-indent-item))))
- ;;; Promotion and Demotion
- (defvar org-after-demote-entry-hook nil
- "Hook run after an entry has been demoted.
- The cursor will be at the beginning of the entry.
- When a subtree is being demoted, the hook will be called for each node.")
- (defvar org-after-promote-entry-hook nil
- "Hook run after an entry has been promoted.
- The cursor will be at the beginning of the entry.
- When a subtree is being promoted, the hook will be called for each node.")
- (defun org-promote-subtree ()
- "Promote the entire subtree.
- See also `org-promote'."
- (interactive)
- (save-excursion
- (org-back-to-heading t)
- (combine-change-calls (point) (save-excursion (org-end-of-subtree t))
- (org-with-limited-levels (org-map-tree 'org-promote))))
- (org-fix-position-after-promote))
- (defun org-demote-subtree ()
- "Demote the entire subtree.
- See `org-demote' and `org-promote'."
- (interactive)
- (save-excursion
- (org-back-to-heading t)
- (combine-change-calls (point) (save-excursion (org-end-of-subtree t))
- (org-with-limited-levels (org-map-tree 'org-demote))))
- (org-fix-position-after-promote))
- (defun org-do-promote ()
- "Promote the current heading higher up the tree.
- If the region is active in `transient-mark-mode', promote all
- headings in the region."
- (interactive)
- (save-excursion
- (if (org-region-active-p)
- (org-map-region 'org-promote (region-beginning) (region-end))
- (org-promote)))
- (org-fix-position-after-promote))
- (defun org-do-demote ()
- "Demote the current heading lower down the tree.
- If the region is active in `transient-mark-mode', demote all
- headings in the region."
- (interactive)
- (save-excursion
- (if (org-region-active-p)
- (org-map-region 'org-demote (region-beginning) (region-end))
- (org-demote)))
- (org-fix-position-after-promote))
- (defun org-fix-position-after-promote ()
- "Fix cursor position and indentation after demoting/promoting."
- (let ((pos (point)))
- (when (save-excursion
- (beginning-of-line)
- (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
- (or (eq pos (match-end 1)) (eq pos (match-end 2))))
- (cond ((eobp) (insert " "))
- ((eolp) (insert " "))
- ((equal (char-after) ?\s) (forward-char 1))))))
- (defun org-current-level ()
- "Return the level of the current entry, or nil if before the first headline.
- The level is the number of stars at the beginning of the
- headline. Use `org-reduced-level' to remove the effect of
- `org-odd-levels'. Unlike to `org-outline-level', this function
- ignores inlinetasks."
- (let ((level (org-with-limited-levels (org-outline-level))))
- (and (> level 0) level)))
- (defun org-get-previous-line-level ()
- "Return the outline depth of the last headline before the current line.
- Returns 0 for the first headline in the buffer, and nil if before the
- first headline."
- (and (org-current-level)
- (or (and (/= (line-beginning-position) (point-min))
- (save-excursion (beginning-of-line 0) (org-current-level)))
- 0)))
- (defun org-reduced-level (l)
- "Compute the effective level of a heading.
- This takes into account the setting of `org-odd-levels-only'."
- (cond
- ((zerop l) 0)
- (org-odd-levels-only (1+ (floor (/ l 2))))
- (t l)))
- (defun org-level-increment ()
- "Return the number of stars that will be added or removed at a
- time to headlines when structure editing, based on the value of
- `org-odd-levels-only'."
- (if org-odd-levels-only 2 1))
- (defun org-get-valid-level (level &optional change)
- "Rectify a level change under the influence of `org-odd-levels-only'.
- LEVEL is a current level, CHANGE is by how much the level should
- be modified. Even if CHANGE is nil, LEVEL may be returned
- modified because even level numbers will become the next higher
- odd number. Returns values greater than 0."
- (if org-odd-levels-only
- (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
- ((> change 0) (1+ (* 2 (/ (+ (1- level) (* 2 change)) 2))))
- ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
- (max 1 (+ level (or change 0)))))
- (defun org-promote ()
- "Promote the current heading higher up the tree."
- (org-with-wide-buffer
- (org-back-to-heading t)
- (let* ((after-change-functions (remq 'flyspell-after-change-function
- after-change-functions))
- (level (save-match-data (funcall outline-level)))
- (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
- (diff (abs (- level (length up-head) -1))))
- (cond
- ((and (= level 1) org-allow-promoting-top-level-subtree)
- (replace-match "# " nil t))
- ((= level 1)
- (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
- (t (replace-match (apply #'propertize up-head (text-properties-at (match-beginning 0))) t)))
- (unless (= level 1)
- (when org-auto-align-tags (org-align-tags))
- (when org-adapt-indentation (org-fixup-indentation (- diff))))
- (run-hooks 'org-after-promote-entry-hook))))
- (defun org-demote ()
- "Demote the current heading lower down the tree."
- (org-with-wide-buffer
- (org-back-to-heading t)
- (let* ((after-change-functions (remq 'flyspell-after-change-function
- after-change-functions))
- (level (save-match-data (funcall outline-level)))
- (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
- (diff (abs (- level (length down-head) -1))))
- (org-fold-core-ignore-fragility-checks
- (replace-match (apply #'propertize down-head (text-properties-at (match-beginning 0))) t)
- (when org-auto-align-tags (org-align-tags))
- (when org-adapt-indentation (org-fixup-indentation diff)))
- (run-hooks 'org-after-demote-entry-hook))))
- (defun org-cycle-level ()
- "Cycle the level of an empty headline through possible states.
- This goes first to child, then to parent, level, then up the hierarchy.
- After top level, it switches back to sibling level."
- (interactive)
- (let ((org-adapt-indentation nil))
- (when (org-point-at-end-of-empty-headline)
- (setq this-command 'org-cycle-level) ; Only needed for caching
- (let ((cur-level (org-current-level))
- (prev-level (org-get-previous-line-level)))
- (cond
- ;; If first headline in file, promote to top-level.
- ((= prev-level 0)
- (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
- do (org-do-promote)))
- ;; If same level as prev, demote one.
- ((= prev-level cur-level)
- (org-do-demote))
- ;; If parent is top-level, promote to top level if not already.
- ((= prev-level 1)
- (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
- do (org-do-promote)))
- ;; If top-level, return to prev-level.
- ((= cur-level 1)
- (cl-loop repeat (/ (- prev-level 1) (org-level-increment))
- do (org-do-demote)))
- ;; If less than prev-level, promote one.
- ((< cur-level prev-level)
- (org-do-promote))
- ;; If deeper than prev-level, promote until higher than
- ;; prev-level.
- ((> cur-level prev-level)
- (cl-loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
- do (org-do-promote))))
- t))))
- (defun org-map-tree (fun)
- "Call FUN for every heading underneath the current one."
- (org-back-to-heading t)
- (let ((level (funcall outline-level)))
- (save-excursion
- (funcall fun)
- (while (and (progn
- (outline-next-heading)
- (> (funcall outline-level) level))
- (not (eobp)))
- (funcall fun)))))
- (defun org-map-region (fun beg end)
- "Call FUN for every heading between BEG and END."
- (let ((org-ignore-region t))
- (save-excursion
- (setq end (copy-marker end))
- (goto-char beg)
- (when (and (re-search-forward org-outline-regexp-bol nil t)
- (< (point) end))
- (funcall fun))
- (while (and (progn
- (outline-next-heading)
- (< (point) end))
- (not (eobp)))
- (funcall fun)))))
- (defun org-fixup-indentation (diff)
- "Change the indentation in the current entry by DIFF.
- DIFF is an integer. Indentation is done according to the
- following rules:
- - Planning information and property drawers are always indented
- according to the new level of the headline;
- - Footnote definitions and their contents are ignored;
- - Inlinetasks' boundaries are not shifted;
- - Empty lines are ignored;
- - Other lines' indentation are shifted by DIFF columns, unless
- it would introduce a structural change in the document, in
- which case no shifting is done at all.
- Assume point is at a heading or an inlinetask beginning."
- (org-with-wide-buffer
- (narrow-to-region (line-beginning-position)
- (save-excursion
- (if (org-with-limited-levels (org-at-heading-p))
- (org-with-limited-levels (outline-next-heading))
- (org-inlinetask-goto-end))
- (point)))
- (forward-line)
- ;; Indent properly planning info and property drawer.
- (when (looking-at-p org-planning-line-re)
- (org-indent-line)
- (forward-line))
- (when (looking-at org-property-drawer-re)
- (goto-char (match-end 0))
- (forward-line)
- (org-indent-region (match-beginning 0) (match-end 0)))
- (when (looking-at org-logbook-drawer-re)
- (let ((end-marker (move-marker (make-marker) (match-end 0)))
- (col (+ (current-indentation) diff)))
- (when (wholenump col)
- (while (< (point) end-marker)
- (if (natnump diff)
- (insert (make-string diff 32))
- (delete-char (abs diff)))
- (forward-line)))))
- (catch 'no-shift
- (when (or (zerop diff) (not (eq org-adapt-indentation t)))
- (throw 'no-shift nil))
- ;; If DIFF is negative, first check if a shift is possible at all
- ;; (e.g., it doesn't break structure). This can only happen if
- ;; some contents are not properly indented.
- (let ((case-fold-search t))
- (when (< diff 0)
- (let ((diff (- diff))
- (forbidden-re (concat org-outline-regexp
- "\\|"
- (substring org-footnote-definition-re 1))))
- (save-excursion
- (while (not (eobp))
- (cond
- ((looking-at-p "[ \t]*$") (forward-line))
- ((and (looking-at-p org-footnote-definition-re)
- (let ((e (org-element-at-point)))
- (and (eq (org-element-type e) 'footnote-definition)
- (goto-char (org-element-property :end e))))))
- ((looking-at-p org-outline-regexp) (forward-line))
- ;; Give up if shifting would move before column 0 or
- ;; if it would introduce a headline or a footnote
- ;; definition.
- (t
- (skip-chars-forward " \t")
- (let ((ind (current-column)))
- (when (or (< ind diff)
- (and (= ind diff) (looking-at-p forbidden-re)))
- (throw 'no-shift nil)))
- ;; Ignore contents of example blocks and source
- ;; blocks if their indentation is meant to be
- ;; preserved. Jump to block's closing line.
- (beginning-of-line)
- (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
- (let ((e (org-element-at-point)))
- (and (memq (org-element-type e)
- '(example-block src-block))
- (or org-src-preserve-indentation
- (org-element-property :preserve-indent e))
- (goto-char (org-element-property :end e))
- (progn (skip-chars-backward " \r\t\n")
- (beginning-of-line)
- t))))
- (forward-line))))))))
- ;; Shift lines but footnote definitions, inlinetasks boundaries
- ;; by DIFF. Also skip contents of source or example blocks
- ;; when indentation is meant to be preserved.
- (while (not (eobp))
- (cond
- ((and (looking-at-p org-footnote-definition-re)
- (let ((e (org-element-at-point)))
- (and (eq (org-element-type e) 'footnote-definition)
- (goto-char (org-element-property :end e))))))
- ((looking-at-p org-outline-regexp) (forward-line))
- ((looking-at-p "[ \t]*$") (forward-line))
- (t
- (indent-line-to (+ (current-indentation) diff))
- (beginning-of-line)
- (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
- (let ((e (org-element-at-point)))
- (and (memq (org-element-type e)
- '(example-block src-block))
- (or org-src-preserve-indentation
- (org-element-property :preserve-indent e))
- (goto-char (org-element-property :end e))
- (progn (skip-chars-backward " \r\t\n")
- (beginning-of-line)
- t))))
- (forward-line)))))))))
- (defun org-convert-to-odd-levels ()
- "Convert an Org file with all levels allowed to one with odd levels.
- This will leave level 1 alone, convert level 2 to level 3, level 3 to
- level 5 etc."
- (interactive)
- (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
- (let ((outline-level 'org-outline-level)
- (org-odd-levels-only nil) n)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "^\\*\\*+ " nil t)
- (setq n (- (length (match-string 0)) 2))
- (while (>= (setq n (1- n)) 0)
- (org-demote))
- (end-of-line 1))))))
- (defun org-convert-to-oddeven-levels ()
- "Convert an Org file with only odd levels to one with odd/even levels.
- This promotes level 3 to level 2, level 5 to level 3 etc. If the
- file contains a section with an even level, conversion would
- destroy the structure of the file. An error is signaled in this
- case."
- (interactive)
- (goto-char (point-min))
- ;; First check if there are no even levels
- (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
- (org-fold-show-set-visibility 'canonical)
- (error "Not all levels are odd in this file. Conversion not possible"))
- (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
- (let ((outline-regexp org-outline-regexp)
- (outline-level 'org-outline-level)
- (org-odd-levels-only nil) n)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "^\\*\\*+ " nil t)
- (setq n (/ (1- (length (match-string 0))) 2))
- (while (>= (setq n (1- n)) 0)
- (org-promote))
- (end-of-line 1))))))
- (defun org-tr-level (n)
- "Make N odd if required."
- (if org-odd-levels-only (1+ (/ n 2)) n))
- ;;; Vertical tree motion, cutting and pasting of subtrees
- (defun org-move-subtree-up (&optional arg)
- "Move the current subtree up past ARG headlines of the same level."
- (interactive "p")
- (org-move-subtree-down (- (prefix-numeric-value arg))))
- (defun org-clean-visibility-after-subtree-move ()
- "Fix visibility issues after moving a subtree."
- ;; First, find a reasonable region to look at:
- ;; Start two siblings above, end three below
- (let* ((beg (save-excursion
- (and (org-get-previous-sibling)
- (org-get-previous-sibling))
- (point)))
- (end (save-excursion
- (and (org-get-next-sibling)
- (org-get-next-sibling)
- (org-get-next-sibling))
- (if (org-at-heading-p)
- (line-end-position)
- (point))))
- (level (looking-at "\\*+"))
- (re (when level (concat "^" (regexp-quote (match-string 0)) " "))))
- (save-excursion
- (save-restriction
- (narrow-to-region beg end)
- (when re
- ;; Properly fold already folded siblings
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (when (and (not (org-invisible-p))
- (org-invisible-p (line-end-position)))
- (org-fold-heading nil))))
- (org-cycle-hide-drawers 'all)
- (org-cycle-show-empty-lines 'overview)))))
- (defun org-move-subtree-down (&optional arg)
- "Move the current subtree down past ARG headlines of the same level."
- (interactive "p")
- (setq arg (prefix-numeric-value arg))
- (org-preserve-local-variables
- (let ((movfunc (if (> arg 0) 'org-get-next-sibling
- 'org-get-previous-sibling))
- (ins-point (make-marker))
- (cnt (abs arg))
- (col (current-column))
- beg end txt folded)
- ;; Select the tree
- (org-back-to-heading)
- (setq beg (point))
- (save-match-data
- (save-excursion (outline-end-of-heading)
- (setq folded (org-invisible-p)))
- (progn (org-end-of-subtree nil t)
- (unless (eobp) (backward-char))))
- (outline-next-heading)
- (setq end (point))
- (goto-char beg)
- ;; Find insertion point, with error handling
- (while (> cnt 0)
- (unless (and (funcall movfunc) (looking-at org-outline-regexp))
- (goto-char beg)
- (user-error "Cannot move past superior level or buffer limit"))
- (setq cnt (1- cnt)))
- (when (> arg 0)
- ;; Moving forward - still need to move over subtree
- (org-end-of-subtree t t)
- (save-excursion
- (org-back-over-empty-lines)
- (or (bolp) (newline))))
- (move-marker ins-point (point))
- (setq txt (buffer-substring beg end))
- (org-save-markers-in-region beg end)
- (delete-region beg end)
- (when (eq org-fold-core-style 'overlays) (org-remove-empty-overlays-at beg))
- (unless (= beg (point-min)) (org-fold-region (1- beg) beg nil 'outline))
- (unless (bobp) (org-fold-region (1- (point)) (point) nil 'outline))
- (and (not (bolp)) (looking-at "\n") (forward-char 1))
- (let ((bbb (point)))
- (insert-before-markers txt)
- (org-reinstall-markers-in-region bbb)
- (move-marker ins-point bbb))
- (or (bolp) (insert "\n"))
- (goto-char ins-point)
- (org-skip-whitespace)
- (move-marker ins-point nil)
- (if folded
- (org-fold-subtree t)
- (org-fold-show-entry 'hide-drawers)
- (org-fold-show-children))
- (org-clean-visibility-after-subtree-move)
- ;; move back to the initial column we were at
- (move-to-column col))))
- (defvar org-subtree-clip ""
- "Clipboard for cut and paste of subtrees.
- This is actually only a copy of the kill, because we use the normal kill
- ring. We need it to check if the kill was created by `org-copy-subtree'.")
- (defvar org-subtree-clip-folded nil
- "Was the last copied subtree folded?
- This is used to fold the tree back after pasting.")
- (defun org-cut-subtree (&optional n)
- "Cut the current subtree into the clipboard.
- With prefix arg N, cut this many sequential subtrees.
- This is a short-hand for marking the subtree and then cutting it."
- (interactive "p")
- (org-copy-subtree n 'cut))
- (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
- "Copy the current subtree into the clipboard.
- With prefix arg N, copy this many sequential subtrees.
- This is a short-hand for marking the subtree and then copying it.
- If CUT is non-nil, actually cut the subtree.
- If FORCE-STORE-MARKERS is non-nil, store the relative locations
- of some markers in the region, even if CUT is non-nil. This is
- useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
- (interactive "p")
- (org-preserve-local-variables
- (let (beg end folded (beg0 (point)))
- (if (called-interactively-p 'any)
- (org-back-to-heading nil) ; take what looks like a subtree
- (org-back-to-heading t)) ; take what is really there
- (setq beg (point))
- (skip-chars-forward " \t\r\n")
- (save-match-data
- (if nosubtrees
- (outline-next-heading)
- (save-excursion (outline-end-of-heading)
- (setq folded (org-invisible-p)))
- (ignore-errors (org-forward-heading-same-level (1- n) t))
- (org-end-of-subtree t t)))
- ;; Include the end of an inlinetask
- (when (and (featurep 'org-inlinetask)
- (looking-at-p (concat (org-inlinetask-outline-regexp)
- "END[ \t]*$")))
- (end-of-line))
- (setq end (point))
- (goto-char beg0)
- (when (> end beg)
- (setq org-subtree-clip-folded folded)
- (when (or cut force-store-markers)
- (org-save-markers-in-region beg end))
- (if cut (kill-region beg end) (copy-region-as-kill beg end))
- (setq org-subtree-clip (current-kill 0))
- (message "%s: Subtree(s) with %d characters"
- (if cut "Cut" "Copied")
- (length org-subtree-clip))))))
- (defun org-paste-subtree (&optional level tree for-yank remove)
- "Paste the clipboard as a subtree, with modification of headline level.
- The entire subtree is promoted or demoted in order to match a new headline
- level.
- If the cursor is at the beginning of a headline, the same level as
- that headline is used to paste the tree.
- If not, the new level is derived from the *visible* headings
- before and after the insertion point, and taken to be the inferior headline
- level of the two. So if the previous visible heading is level 3 and the
- next is level 4 (or vice versa), level 4 will be used for insertion.
- This makes sure that the subtree remains an independent subtree and does
- not swallow low level entries.
- You can also force a different level, either by using a numeric prefix
- argument, or by inserting the heading marker by hand. For example, if the
- cursor is after \"*****\", then the tree will be shifted to level 5.
- If optional TREE is given, use this text instead of the kill ring.
- When FOR-YANK is set, this is called by `org-yank'. In this case, do not
- move back over whitespace before inserting, and move point to the end of
- the inserted text when done.
- When REMOVE is non-nil, remove the subtree from the clipboard."
- (interactive "P")
- (setq tree (or tree (and kill-ring (current-kill 0))))
- (unless (org-kill-is-subtree-p tree)
- (user-error
- (substitute-command-keys
- "The kill is not a (set of) tree(s). Use `\\[yank]' to yank anyway")))
- (org-with-limited-levels
- (org-fold-core-ignore-fragility-checks
- (let* ((visp (not (org-invisible-p)))
- (txt tree)
- (old-level (if (string-match org-outline-regexp-bol txt)
- (- (match-end 0) (match-beginning 0) 1)
- -1))
- (force-level
- (cond
- (level (prefix-numeric-value level))
- ;; When point is after the stars in an otherwise empty
- ;; headline, use the number of stars as the forced level.
- ((and (org-match-line "^\\*+[ \t]*$")
- (not (eq ?* (char-after))))
- (org-outline-level))
- ((looking-at-p org-outline-regexp-bol) (org-outline-level))))
- (previous-level
- (save-excursion
- (org-previous-visible-heading 1)
- (if (org-at-heading-p) (org-outline-level) 1)))
- (next-level
- (save-excursion
- (if (org-at-heading-p) (org-outline-level)
- (org-next-visible-heading 1)
- (if (org-at-heading-p) (org-outline-level) 1))))
- (new-level (or force-level (max previous-level next-level)))
- (shift (if (or (= old-level -1)
- (= new-level -1)
- (= old-level new-level))
- 0
- (- new-level old-level)))
- (delta (if (> shift 0) -1 1))
- (func (if (> shift 0) #'org-demote #'org-promote))
- (org-odd-levels-only nil)
- beg end newend)
- ;; Remove the forced level indicator.
- (when (and force-level (not level))
- (delete-region (line-beginning-position) (point)))
- ;; Paste before the next visible heading or at end of buffer,
- ;; unless point is at the beginning of a headline.
- (unless (and (bolp) (org-at-heading-p))
- (org-next-visible-heading 1)
- (unless (bolp) (insert "\n")))
- (setq beg (point))
- ;; Avoid re-parsing cache elements when i.e. level 1 heading
- ;; is inserted and then promoted.
- (combine-change-calls beg beg
- (when (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
- (insert txt)
- (unless (string-suffix-p "\n" txt) (insert "\n"))
- (setq newend (point))
- (org-reinstall-markers-in-region beg)
- (setq end (point))
- (goto-char beg)
- (skip-chars-forward " \t\n\r")
- (setq beg (point))
- (when (and (org-invisible-p) visp)
- (save-excursion (org-fold-heading nil)))
- ;; Shift if necessary.
- (unless (= shift 0)
- (save-restriction
- (narrow-to-region beg end)
- (while (not (= shift 0))
- (org-map-region func (point-min) (point-max))
- (setq shift (+ delta shift)))
- (goto-char (point-min))
- (setq newend (point-max)))))
- (when (or for-yank (called-interactively-p 'interactive))
- (message "Clipboard pasted as level %d subtree" new-level))
- (when (and (not for-yank) ; in this case, org-yank will decide about folding
- kill-ring
- (equal org-subtree-clip (current-kill 0))
- org-subtree-clip-folded)
- ;; The tree was folded before it was killed/copied
- (org-fold-subtree t))
- (when for-yank (goto-char newend))
- (when remove (pop kill-ring))))))
- (defun org-kill-is-subtree-p (&optional txt)
- "Check if the current kill is an outline subtree, or a set of trees.
- Returns nil if kill does not start with a headline, or if the first
- headline level is not the largest headline level in the tree.
- So this will actually accept several entries of equal levels as well,
- which is OK for `org-paste-subtree'.
- If optional TXT is given, check this string instead of the current kill."
- (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
- (re (org-get-limited-outline-regexp))
- (^re (concat "^" re))
- (start-level (and kill
- (string-match
- (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
- kill)
- (- (match-end 2) (match-beginning 2) 1)))
- (start (1+ (or (match-beginning 2) -1))))
- (if (not start-level)
- (progn
- nil) ;; does not even start with a heading
- (catch 'exit
- (while (setq start (string-match ^re kill (1+ start)))
- (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
- (throw 'exit nil)))
- t))))
- (defvar org-markers-to-move nil
- "Markers that should be moved with a cut-and-paste operation.
- Those markers are stored together with their positions relative to
- the start of the region.")
- (defun org-save-markers-in-region (beg end)
- "Check markers in region.
- If these markers are between BEG and END, record their position relative
- to BEG, so that after moving the block of text, we can put the markers back
- into place.
- This function gets called just before an entry or tree gets cut from the
- buffer. After re-insertion, `org-reinstall-markers-in-region' must be
- called immediately, to move the markers with the entries."
- (setq org-markers-to-move nil)
- (when (featurep 'org-clock)
- (org-clock-save-markers-for-cut-and-paste beg end))
- (when (featurep 'org-agenda)
- (org-agenda-save-markers-for-cut-and-paste beg end)))
- (defun org-check-and-save-marker (marker beg end)
- "Check if MARKER is between BEG and END.
- If yes, remember the marker and the distance to BEG."
- (when (and (marker-buffer marker)
- (or (equal (marker-buffer marker) (current-buffer))
- (equal (marker-buffer marker) (buffer-base-buffer (current-buffer))))
- (>= marker beg) (< marker end))
- (push (cons marker (- marker beg)) org-markers-to-move)))
- (defun org-reinstall-markers-in-region (beg)
- "Move all remembered markers to their position relative to BEG."
- (dolist (x org-markers-to-move)
- (move-marker (car x) (+ beg (cdr x))))
- (setq org-markers-to-move nil))
- (defun org-narrow-to-subtree (&optional element)
- "Narrow buffer to the current subtree."
- (interactive)
- (if (org-element--cache-active-p)
- (let* ((heading (org-element-lineage
- (or element (org-element-at-point))
- '(headline) t))
- (end (org-element-property :end heading)))
- (if (and heading end)
- (narrow-to-region (org-element-property :begin heading)
- (if (= end (point-max))
- end (1- end)))
- (signal 'outline-before-first-heading nil)))
- (save-excursion
- (save-match-data
- (org-with-limited-levels
- (narrow-to-region
- (progn (org-back-to-heading t) (point))
- (progn (org-end-of-subtree t t)
- (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
- (point))))))))
- (defun org-toggle-narrow-to-subtree ()
- "Narrow to the subtree at point or widen a narrowed buffer."
- (interactive)
- (if (buffer-narrowed-p)
- (progn (widen) (message "Buffer widen"))
- (org-narrow-to-subtree)
- (message "Buffer narrowed to current subtree")))
- (defun org-narrow-to-block ()
- "Narrow buffer to the current block."
- (interactive)
- (let* ((case-fold-search t)
- (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
- "^[ \t]*#\\+end_.*")))
- (if blockp
- (narrow-to-region (car blockp) (cdr blockp))
- (user-error "Not in a block"))))
- (defun org-clone-subtree-with-time-shift (n &optional shift)
- "Clone the task (subtree) at point N times.
- The clones will be inserted as siblings.
- In interactive use, the user will be prompted for the number of
- clones to be produced. If the entry has a timestamp, the user
- will also be prompted for a time shift, which may be a repeater
- as used in time stamps, for example `+3d'. To disable this,
- you can call the function with a universal prefix argument.
- When a valid repeater is given and the entry contains any time
- stamps, the clones will become a sequence in time, with time
- stamps in the subtree shifted for each clone produced. If SHIFT
- is nil or the empty string, time stamps will be left alone. The
- ID property of the original subtree is removed.
- In each clone, all the CLOCK entries will be removed. This
- prevents Org from considering that the clocked times overlap.
- If the original subtree did contain time stamps with a repeater,
- the following will happen:
- - the repeater will be removed in each clone
- - an additional clone will be produced, with the current, unshifted
- date(s) in the entry.
- - the original entry will be placed *after* all the clones, with
- repeater intact.
- - the start days in the repeater in the original entry will be shifted
- to past the last clone.
- In this way you can spell out a number of instances of a repeating task,
- and still retain the repeater to cover future instances of the task.
- As described above, N+1 clones are produced when the original
- subtree has a repeater. Setting N to 0, then, can be used to
- remove the repeater from a subtree and create a shifted clone
- with the original repeater."
- (interactive "nNumber of clones to produce: ")
- (unless (wholenump n) (user-error "Invalid number of replications %s" n))
- (when (org-before-first-heading-p) (user-error "No subtree to clone"))
- (let* ((beg (save-excursion (org-back-to-heading t) (point)))
- (end-of-tree (save-excursion (org-end-of-subtree t t) (point)))
- (shift
- (or shift
- (if (and (not (equal current-prefix-arg '(4)))
- (save-excursion
- (goto-char beg)
- (re-search-forward org-ts-regexp-both end-of-tree t)))
- (read-from-minibuffer
- "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
- ""))) ;No time shift
- (doshift
- (and (org-string-nw-p shift)
- (or (string-match "\\`[ \t]*\\([+-]?[0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
- shift)
- (user-error "Invalid shift specification %s" shift)))))
- (goto-char end-of-tree)
- (unless (bolp) (insert "\n"))
- (let* ((end (point))
- (template (buffer-substring beg end))
- (shift-n (and doshift (string-to-number (match-string 1 shift))))
- (shift-what (pcase (and doshift (match-string 2 shift))
- (`nil nil)
- ("h" 'hour)
- ("d" 'day)
- ("w" (setq shift-n (* 7 shift-n)) 'day)
- ("m" 'month)
- ("y" 'year)
- (_ (error "Unsupported time unit"))))
- (nmin 1)
- (nmax n)
- (n-no-remove -1)
- (org-id-overriding-file-name (buffer-file-name (buffer-base-buffer)))
- (idprop (org-entry-get beg "ID")))
- (when (and doshift
- (string-match-p "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>"
- template))
- (delete-region beg end)
- (setq end beg)
- (setq nmin 0)
- (setq nmax (1+ nmax))
- (setq n-no-remove nmax))
- (goto-char end)
- (cl-loop for n from nmin to nmax do
- (insert
- ;; Prepare clone.
- (with-temp-buffer
- (insert template)
- (org-mode)
- (goto-char (point-min))
- (org-fold-show-subtree)
- (and idprop (if org-clone-delete-id
- (org-entry-delete nil "ID")
- (org-id-get-create t)))
- (unless (= n 0)
- (while (re-search-forward org-clock-line-re nil t)
- (delete-region (line-beginning-position)
- (line-beginning-position 2)))
- (goto-char (point-min))
- (while (re-search-forward org-drawer-regexp nil t)
- (org-remove-empty-drawer-at (point))))
- (goto-char (point-min))
- (when doshift
- (while (re-search-forward org-ts-regexp-both nil t)
- (org-timestamp-change (* n shift-n) shift-what))
- (unless (= n n-no-remove)
- (goto-char (point-min))
- (while (re-search-forward org-ts-regexp nil t)
- (save-excursion
- (goto-char (match-beginning 0))
- (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
- (delete-region (match-beginning 1) (match-end 1)))))))
- (buffer-string)))))
- (goto-char beg)))
- ;;; Outline path
- (defvar org-outline-path-cache nil
- "Alist between buffer positions and outline paths.
- It value is an alist (POSITION . PATH) where POSITION is the
- buffer position at the beginning of an entry and PATH is a list
- of strings describing the outline path for that entry, in reverse
- order.")
- (defun org--get-outline-path-1 (&optional use-cache)
- "Return outline path to current headline.
- Outline path is a list of strings, in reverse order. When
- optional argument USE-CACHE is non-nil, make use of a cache. See
- `org-get-outline-path' for details.
- Assume buffer is widened and point is on a headline."
- (or (and use-cache (cdr (assq (point) org-outline-path-cache)))
- (let ((p (point))
- (heading (let ((case-fold-search nil))
- (looking-at org-complex-heading-regexp)
- (if (not (match-end 4)) ""
- ;; Remove statistics cookies.
- (org-trim
- (org-link-display-format
- (replace-regexp-in-string
- "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
- (match-string-no-properties 4))))))))
- (if (org-up-heading-safe)
- (let ((path (cons heading (org--get-outline-path-1 use-cache))))
- (when use-cache
- (push (cons p path) org-outline-path-cache))
- path)
- ;; This is a new root node. Since we assume we are moving
- ;; forward, we can drop previous cache so as to limit number
- ;; of associations there.
- (let ((path (list heading)))
- (when use-cache (setq org-outline-path-cache (list (cons p path))))
- path)))))
- (defun org-get-outline-path (&optional with-self use-cache)
- "Return the outline path to the current entry.
- An outline path is a list of ancestors for current headline, as
- a list of strings. Statistics cookies are removed and links are
- replaced with their description, if any, or their path otherwise.
- When optional argument WITH-SELF is non-nil, the path also
- includes the current headline.
- When optional argument USE-CACHE is non-nil, cache outline paths
- between calls to this function so as to avoid backtracking. This
- argument is useful when planning to find more than one outline
- path in the same document. In that case, there are two
- conditions to satisfy:
- - `org-outline-path-cache' is set to nil before starting the
- process;
- - outline paths are computed by increasing buffer positions."
- (org-with-wide-buffer
- (and (or (and with-self (org-back-to-heading t))
- (org-up-heading-safe))
- (reverse (org--get-outline-path-1 use-cache)))))
- (defun org-format-outline-path (path &optional width prefix separator)
- "Format the outline path PATH for display.
- WIDTH is the maximum number of characters that is available.
- PREFIX is a prefix to be included in the returned string,
- such as the file name.
- SEPARATOR is inserted between the different parts of the path,
- the default is \"/\"."
- (setq width (or width 79))
- (setq path (delq nil path))
- (unless (> width 0)
- (user-error "Argument `width' must be positive"))
- (setq separator (or separator "/"))
- (let* ((org-odd-levels-only nil)
- (fpath (concat
- prefix (and prefix path separator)
- (mapconcat
- (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
- (cl-loop for head in path
- for n from 0
- collect (org-add-props
- head nil 'face
- (nth (% n org-n-level-faces) org-level-faces)))
- separator))))
- (when (> (length fpath) width)
- (if (< width 7)
- ;; It's unlikely that `width' will be this small, but don't
- ;; waste characters by adding ".." if it is.
- (setq fpath (substring fpath 0 width))
- (setf (substring fpath (- width 2)) "..")))
- fpath))
- (defun org-display-outline-path (&optional file current separator just-return-string)
- "Display the current outline path in the echo area.
- If FILE is non-nil, prepend the output with the file name.
- If CURRENT is non-nil, append the current heading to the output.
- SEPARATOR is passed through to `org-format-outline-path'. It separates
- the different parts of the path and defaults to \"/\".
- If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
- (interactive "P")
- (let* (case-fold-search
- (bfn (buffer-file-name (buffer-base-buffer)))
- (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
- res)
- (when current (setq path (append path
- (save-excursion
- (org-back-to-heading t)
- (when (looking-at org-complex-heading-regexp)
- (list (match-string 4)))))))
- (setq res
- (org-format-outline-path
- path
- (1- (frame-width))
- (and file bfn (concat (file-name-nondirectory bfn) separator))
- separator))
- (add-face-text-property 0 (length res)
- `(:height ,(face-attribute 'default :height))
- nil res)
- (if just-return-string
- res
- (org-unlogged-message "%s" res))))
- ;;; Outline Sorting
- (defun org-sort (&optional with-case)
- "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
- Optional argument WITH-CASE means sort case-sensitively."
- (interactive "P")
- (org-call-with-arg
- (cond ((org-at-table-p) #'org-table-sort-lines)
- ((org-at-item-p) #'org-sort-list)
- (t #'org-sort-entries))
- with-case))
- (defun org-sort-remove-invisible (s)
- "Remove emphasis markers and any invisible property from string S.
- Assume S may contain only objects."
- ;; org-element-interpret-data clears any text property, including
- ;; invisible part.
- (org-element-interpret-data
- (let ((tree (org-element-parse-secondary-string
- s (org-element-restriction 'paragraph))))
- (org-element-map tree '(bold code italic link strike-through underline verbatim)
- (lambda (o)
- (pcase (org-element-type o)
- ;; Terminal object. Replace it with its value.
- ((or `code `verbatim)
- (let ((new (org-element-property :value o)))
- (org-element-insert-before new o)
- (org-element-put-property
- new :post-blank (org-element-property :post-blank o))))
- ;; Non-terminal objects. Splice contents.
- (type
- (let ((contents
- (or (org-element-contents o)
- (and (eq type 'link)
- (list (org-element-property :raw-link o)))))
- (c nil))
- (while contents
- (setq c (pop contents))
- (org-element-insert-before c o))
- (org-element-put-property
- c :post-blank (org-element-property :post-blank o)))))
- (org-element-extract-element o)))
- ;; Return modified tree.
- tree)))
- (defvar org-after-sorting-entries-or-items-hook nil
- "Hook that is run after a bunch of entries or items have been sorted.
- When children are sorted, the cursor is in the parent line when this
- hook gets called. When a region or a plain list is sorted, the cursor
- will be in the first entry of the sorted region/list.")
- (defun org-sort-entries
- (&optional with-case sorting-type getkey-func compare-func property
- interactive?)
- "Sort entries on a certain level of an outline tree.
- If there is an active region, the entries in the region are sorted.
- Else, if the cursor is before the first entry, sort the top-level items.
- Else, the children of the entry at point are sorted.
- Sorting can be alphabetically, numerically, by date/time as given by
- a time stamp, by a property, by priority order, or by a custom function.
- The command prompts for the sorting type unless it has been given to the
- function through the SORTING-TYPE argument, which needs to be a character,
- \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
- the precise meaning of each character:
- a Alphabetically, ignoring the TODO keyword and the priority, if any.
- c By creation time, which is assumed to be the first inactive time stamp
- at the beginning of a line.
- d By deadline date/time.
- k By clocking time.
- n Numerically, by converting the beginning of the entry/item to a number.
- o By order of TODO keywords.
- p By priority according to the cookie.
- r By the value of a property.
- s By scheduled date/time.
- t By date/time, either the first active time stamp in the entry, or, if
- none exist, by the first inactive one.
- Capital letters will reverse the sort order.
- If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
- called with point at the beginning of the record. It must return a
- value that is compatible with COMPARE-FUNC, the function used to
- compare entries.
- Comparing entries ignores case by default. However, with an optional argument
- WITH-CASE, the sorting considers case as well.
- Sorting is done against the visible part of the headlines, it ignores hidden
- links.
- When sorting is done, call `org-after-sorting-entries-or-items-hook'.
- A non-nil value for INTERACTIVE? is used to signal that this
- function is being called interactively."
- (interactive (list current-prefix-arg nil nil nil nil t))
- (let ((case-func (if with-case 'identity 'downcase))
- start beg end stars re re2
- txt what tmp)
- ;; Find beginning and end of region to sort
- (cond
- ((org-region-active-p)
- ;; we will sort the region
- (setq end (region-end)
- what "region")
- (goto-char (region-beginning))
- (unless (org-at-heading-p) (outline-next-heading))
- (setq start (point)))
- ((or (org-at-heading-p)
- (ignore-errors (progn (org-back-to-heading) t)))
- ;; we will sort the children of the current headline
- (org-back-to-heading)
- (setq start (point)
- end (progn (org-end-of-subtree t t)
- (or (bolp) (insert "\n"))
- (when (>= (org-back-over-empty-lines) 1)
- (forward-line 1))
- (point))
- what "children")
- (goto-char start)
- (org-fold-show-subtree)
- (outline-next-heading))
- (t
- ;; we will sort the top-level entries in this file
- (goto-char (point-min))
- (or (org-at-heading-p) (outline-next-heading))
- (setq start (point))
- (goto-char (point-max))
- (beginning-of-line 1)
- (when (looking-at ".*?\\S-")
- ;; File ends in a non-white line
- (end-of-line 1)
- (insert "\n"))
- (setq end (point-max))
- (setq what "top-level")
- (goto-char start)
- (org-fold-show-all '(headings drawers blocks))))
- (setq beg (point))
- (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
- (looking-at "\\(\\*+\\)")
- (setq stars (match-string 1)
- re (concat "^" (regexp-quote stars) " +")
- re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
- txt (buffer-substring beg end))
- (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
- (when (and (not (equal stars "*")) (string-match re2 txt))
- (user-error "Region to sort contains a level above the first entry"))
- (unless sorting-type
- (message
- "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
- [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
- A/N/P/R/O/F/T/S/D/C/K means reversed:"
- what)
- (setq sorting-type (read-char-exclusive)))
- (unless getkey-func
- (and (= (downcase sorting-type) ?f)
- (setq getkey-func
- (or (and interactive?
- (org-read-function
- "Function for extracting keys: "))
- (error "Missing key extractor")))))
- (and (= (downcase sorting-type) ?r)
- (not property)
- (setq property
- (completing-read "Property: "
- (mapcar #'list (org-buffer-property-keys t))
- nil t)))
- (when (member sorting-type '(?k ?K)) (org-clock-sum))
- (message "Sorting entries...")
- (save-restriction
- (narrow-to-region start end)
- (let ((restore-clock?
- ;; The clock marker is lost when using `sort-subr'; mark
- ;; the clock with temporary `:org-clock-marker-backup'
- ;; text property.
- (when (and (eq (org-clocking-buffer) (current-buffer))
- (<= start (marker-position org-clock-marker))
- (>= end (marker-position org-clock-marker)))
- (with-silent-modifications
- (put-text-property (1- org-clock-marker) org-clock-marker
- :org-clock-marker-backup t))
- t))
- (dcst (downcase sorting-type))
- (case-fold-search nil)
- (now (current-time)))
- (org-preserve-local-variables
- (sort-subr
- (/= dcst sorting-type)
- ;; This function moves to the beginning character of the
- ;; "record" to be sorted.
- (lambda nil
- (if (re-search-forward re nil t)
- (goto-char (match-beginning 0))
- (goto-char (point-max))))
- ;; This function moves to the last character of the "record" being
- ;; sorted.
- (lambda nil
- (save-match-data
- (condition-case nil
- (outline-forward-same-level 1)
- (error
- (goto-char (point-max))))))
- ;; This function returns the value that gets sorted against.
- (lambda ()
- (cond
- ((= dcst ?n)
- (string-to-number
- (org-sort-remove-invisible (org-get-heading t t t t))))
- ((= dcst ?a)
- (funcall case-func
- (org-sort-remove-invisible (org-get-heading t t t t))))
- ((= dcst ?k)
- (or (get-text-property (point) :org-clock-minutes) 0))
- ((= dcst ?t)
- (let ((end (save-excursion (outline-next-heading) (point))))
- (if (or (re-search-forward org-ts-regexp end t)
- (re-search-forward org-ts-regexp-both end t))
- (org-time-string-to-seconds (match-string 0))
- (float-time now))))
- ((= dcst ?c)
- (let ((end (save-excursion (outline-next-heading) (point))))
- (if (re-search-forward
- (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
- end t)
- (org-time-string-to-seconds (match-string 0))
- (float-time now))))
- ((= dcst ?s)
- (let ((end (save-excursion (outline-next-heading) (point))))
- (if (re-search-forward org-scheduled-time-regexp end t)
- (org-time-string-to-seconds (match-string 1))
- (float-time now))))
- ((= dcst ?d)
- (let ((end (save-excursion (outline-next-heading) (point))))
- (if (re-search-forward org-deadline-time-regexp end t)
- (org-time-string-to-seconds (match-string 1))
- (float-time now))))
- ((= dcst ?p)
- (if (re-search-forward org-priority-regexp (line-end-position) t)
- (string-to-char (match-string 2))
- org-priority-default))
- ((= dcst ?r)
- (or (org-entry-get nil property) ""))
- ((= dcst ?o)
- (when (looking-at org-complex-heading-regexp)
- (let* ((m (match-string 2))
- (s (if (member m org-done-keywords) '- '+)))
- (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
- ((= dcst ?f)
- (if getkey-func
- (progn
- (setq tmp (funcall getkey-func))
- (when (stringp tmp) (setq tmp (funcall case-func tmp)))
- tmp)
- (error "Invalid key function `%s'" getkey-func)))
- (t (error "Invalid sorting type `%c'" sorting-type))))
- nil
- (cond
- ((= dcst ?a) 'string-collate-lessp)
- ((= dcst ?f)
- (or compare-func
- (and interactive?
- (org-read-function
- (concat "Function for comparing keys "
- "(empty for default `sort-subr' predicate): ")
- 'allow-empty))))
- ((member dcst '(?p ?t ?s ?d ?c ?k)) '<))))
- (org-cycle-hide-drawers 'all)
- (when restore-clock?
- (move-marker org-clock-marker
- (1+ (next-single-property-change
- start :org-clock-marker-backup)))
- (remove-text-properties (1- org-clock-marker) org-clock-marker
- '(:org-clock-marker-backup t)))))
- (run-hooks 'org-after-sorting-entries-or-items-hook)
- (message "Sorting entries...done")))
- (defun org-contextualize-keys (alist contexts)
- "Return valid elements in ALIST depending on CONTEXTS.
- `org-agenda-custom-commands' or `org-capture-templates' are the
- values used for ALIST, and `org-agenda-custom-commands-contexts'
- or `org-capture-templates-contexts' are the associated contexts
- definitions."
- (let ((contexts
- ;; normalize contexts
- (mapcar
- (lambda(c) (cond ((listp (cadr c))
- (list (car c) (car c) (nth 1 c)))
- ((string= "" (cadr c))
- (list (car c) (car c) (nth 2 c)))
- (t c)))
- contexts))
- (a alist) r s)
- ;; loop over all commands or templates
- (dolist (c a)
- (let (vrules repl)
- (cond
- ((not (assoc (car c) contexts))
- (push c r))
- ((and (assoc (car c) contexts)
- (setq vrules (org-contextualize-validate-key
- (car c) contexts)))
- (mapc (lambda (vr)
- (unless (equal (car vr) (cadr vr))
- (setq repl vr)))
- vrules)
- (if (not repl) (push c r)
- (push (cadr repl) s)
- (push
- (cons (car c)
- (cdr (or (assoc (cadr repl) alist)
- (error "Undefined key `%s' as contextual replacement for `%s'"
- (cadr repl) (car c)))))
- r))))))
- ;; Return limited ALIST, possibly with keys modified, and deduplicated
- (delq
- nil
- (delete-dups
- (mapcar (lambda (x)
- (let ((tpl (car x)))
- (unless (delq
- nil
- (mapcar (lambda (y)
- (equal y tpl))
- s))
- x)))
- (reverse r))))))
- (defun org-contextualize-validate-key (key contexts)
- "Check CONTEXTS for agenda or capture KEY."
- (let (res)
- (dolist (r contexts)
- (dolist (rr (car (last r)))
- (when
- (and (equal key (car r))
- (if (functionp rr) (funcall rr)
- (or (and (eq (car rr) 'in-file)
- (buffer-file-name)
- (string-match (cdr rr) (buffer-file-name)))
- (and (eq (car rr) 'in-mode)
- (string-match (cdr rr) (symbol-name major-mode)))
- (and (eq (car rr) 'in-buffer)
- (string-match (cdr rr) (buffer-name)))
- (when (and (eq (car rr) 'not-in-file)
- (buffer-file-name))
- (not (string-match (cdr rr) (buffer-file-name))))
- (when (eq (car rr) 'not-in-mode)
- (not (string-match (cdr rr) (symbol-name major-mode))))
- (when (eq (car rr) 'not-in-buffer)
- (not (string-match (cdr rr) (buffer-name)))))))
- (push r res))))
- (delete-dups (delq nil res))))
- ;; Defined to provide a value for defcustom, since there is no
- ;; string-collate-greaterp in Emacs.
- (defun org-string-collate-greaterp (s1 s2)
- "Return non-nil if S1 is greater than S2 in collation order."
- (not (string-collate-lessp s1 s2)))
- ;;;###autoload
- (defun org-run-like-in-org-mode (cmd)
- "Run a command, pretending that the current buffer is in Org mode.
- This will temporarily bind local variables that are typically bound in
- Org mode to the values they have in Org mode, and then interactively
- call CMD."
- (org-load-modules-maybe)
- (let (vars vals)
- (dolist (var (org-get-local-variables))
- (when (or (not (boundp (car var)))
- (eq (symbol-value (car var))
- (default-value (car var))))
- (push (car var) vars)
- (push (cadr var) vals)))
- (cl-progv vars vals
- (call-interactively cmd))))
- (defun org-get-category (&optional pos force-refresh)
- "Get the category applying to position POS."
- (save-match-data
- (when force-refresh (org-refresh-category-properties))
- (let ((pos (or pos (point))))
- (if (org-element--cache-active-p)
- ;; Sync cache.
- (org-with-point-at (org-element-property :begin (org-element-at-point pos))
- (or (org-entry-get-with-inheritance "CATEGORY")
- "???"))
- (or (get-text-property pos 'org-category)
- (progn
- (org-refresh-category-properties)
- (get-text-property pos 'org-category)))))))
- ;;; Refresh properties
- (defun org-refresh-properties (dprop tprop)
- "Refresh buffer text properties.
- DPROP is the drawer property and TPROP is either the
- corresponding text property to set, or an alist with each element
- being a text property (as a symbol) and a function to apply to
- the value of the drawer property."
- (let* ((case-fold-search t)
- (inhibit-read-only t)
- (inherit? (org-property-inherit-p dprop))
- (property-re (org-re-property (concat (regexp-quote dprop) "\\+?") t))
- (global-or-keyword (and inherit?
- (org--property-global-or-keyword-value dprop nil))))
- (with-silent-modifications
- (org-with-point-at 1
- ;; Set global and keyword based values to the whole buffer.
- (when global-or-keyword
- (put-text-property (point-min) (point-max) tprop global-or-keyword))
- ;; Set values based on property-drawers throughout the document.
- (while (re-search-forward property-re nil t)
- (when (org-at-property-p)
- (org-refresh-property tprop (org-entry-get (point) dprop) inherit?))
- (outline-next-heading))))))
- (defun org-refresh-property (tprop p &optional inherit)
- "Refresh the buffer text property TPROP from the drawer property P.
- The refresh happens only for the current entry, or the whole
- sub-tree if optional argument INHERIT is non-nil.
- If point is before first headline, the function applies to the
- part before the first headline. In that particular case, when
- optional argument INHERIT is non-nil, it refreshes properties for
- the whole buffer."
- (save-excursion
- (org-back-to-heading-or-point-min t)
- (let ((start (point))
- (end (save-excursion
- (cond ((and inherit (org-before-first-heading-p))
- (point-max))
- (inherit
- (org-end-of-subtree t t))
- ((outline-next-heading))
- ((point-max))))))
- (with-silent-modifications
- (if (symbolp tprop)
- ;; TPROP is a text property symbol.
- (put-text-property start end tprop p)
- ;; TPROP is an alist with (property . function) elements.
- (pcase-dolist (`(,prop . ,f) tprop)
- (put-text-property start end prop (funcall f p))))))))
- (defun org-refresh-category-properties ()
- "Refresh category text properties in the buffer."
- (unless (org-element--cache-active-p)
- (let ((case-fold-search t)
- (inhibit-read-only t)
- (default-category
- (cond ((null org-category)
- (if buffer-file-name
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))
- "???"))
- ((symbolp org-category) (symbol-name org-category))
- (t org-category))))
- (let ((category (catch 'buffer-category
- (org-with-wide-buffer
- (goto-char (point-max))
- (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
- (let ((element (org-element-at-point-no-context)))
- (when (eq (org-element-type element) 'keyword)
- (throw 'buffer-category
- (org-element-property :value element))))))
- default-category)))
- (with-silent-modifications
- (org-with-wide-buffer
- ;; Set buffer-wide property from keyword. Search last #+CATEGORY
- ;; keyword. If none is found, fall-back to `org-category' or
- ;; buffer file name, or set it by the document property drawer.
- (put-text-property (point-min) (point-max)
- 'org-category category)
- ;; Set categories from the document property drawer or
- ;; property drawers in the outline. If category is found in
- ;; the property drawer for the whole buffer that value
- ;; overrides the keyword-based value set above.
- (goto-char (point-min))
- (let ((regexp (org-re-property "CATEGORY")))
- (while (re-search-forward regexp nil t)
- (let ((value (match-string-no-properties 3)))
- (when (org-at-property-p)
- (put-text-property
- (save-excursion (org-back-to-heading-or-point-min t))
- (save-excursion (if (org-before-first-heading-p)
- (point-max)
- (org-end-of-subtree t t)))
- 'org-category
- value)))))))))))
- (defun org-refresh-stats-properties ()
- "Refresh stats text properties in the buffer."
- (with-silent-modifications
- (org-with-point-at 1
- (let ((regexp (concat org-outline-regexp-bol
- ".*\\[\\([0-9]*\\)\\(?:%\\|/\\([0-9]*\\)\\)\\]")))
- (while (re-search-forward regexp nil t)
- (let* ((numerator (string-to-number (match-string 1)))
- (denominator (and (match-end 2)
- (string-to-number (match-string 2))))
- (stats (cond ((not denominator) numerator) ;percent
- ((= denominator 0) 0)
- (t (/ (* numerator 100) denominator)))))
- (put-text-property (point) (progn (org-end-of-subtree t t) (point))
- 'org-stats stats)))))))
- (defun org-refresh-effort-properties ()
- "Refresh effort properties."
- (org-refresh-properties
- org-effort-property
- '((effort . identity)
- (effort-minutes . org-duration-to-minutes))))
- (defun org-find-file-at-mouse (ev)
- "Open file link or URL at mouse."
- (interactive "e")
- (mouse-set-point ev)
- (org-open-at-point 'in-emacs))
- (defun org-open-at-mouse (ev)
- "Open file link or URL at mouse.
- See the docstring of `org-open-file' for details."
- (interactive "e")
- (mouse-set-point ev)
- (when (eq major-mode 'org-agenda-mode)
- (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
- (org-open-at-point))
- (defvar org-window-config-before-follow-link nil
- "The window configuration before following a link.
- This is saved in case the need arises to restore it.")
- (defun org--file-default-apps ()
- "Return the default applications for this operating system."
- (pcase system-type
- (`darwin org-file-apps-macos)
- (`windows-nt org-file-apps-windowsnt)
- (_ org-file-apps-gnu)))
- (defun org--file-apps-entry-locator-p (entry)
- "Non-nil if ENTRY should be matched against the link by `org-open-file'.
- It assumes that is the case when the entry uses a regular
- expression which has at least one grouping construct and the
- action is either a Lisp form or a command string containing
- \"%1\", i.e., using at least one subexpression match as
- a parameter."
- (pcase entry
- (`(,selector . ,action)
- (and (stringp selector)
- (> (regexp-opt-depth selector) 0)
- (or (and (stringp action)
- (string-match "%[0-9]" action))
- (functionp action))))
- (_ nil)))
- (defun org--file-apps-regexp-alist (list &optional add-auto-mode)
- "Convert extensions to regular expressions in the cars of LIST.
- Also, weed out any non-string entries, because the return value
- is used only for regexp matching.
- When ADD-AUTO-MODE is non-nil, make all matches in `auto-mode-alist'
- point to the symbol `emacs', indicating that the file should be
- opened in Emacs."
- (append
- (delq nil
- (mapcar (lambda (x)
- (unless (not (stringp (car x)))
- (if (string-match "\\W" (car x))
- x
- (cons (concat "\\." (car x) "\\'") (cdr x)))))
- list))
- (when add-auto-mode
- (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
- (defun org--open-file-format-command
- (mailcap-command file link match-data)
- "Format MAILCAP-COMMAND to launch viewer for the FILE.
- MAILCAP-COMMAND may be an entry from the `org-file-apps' list or viewer
- field from mailcap file loaded to `mailcap-mime-data'. See \"RFC
- 1524. A User Agent Configuration Mechanism For Multimedia Mail Format
- Information\" (URL `https://www.rfc-editor.org/rfc/rfc1524.html') for
- details, man page `mailcap(5)' for brief summary, and Info node
- `(emacs-mime) mailcap' for specific related to Emacs. Only a part of
- mailcap specification is supported.
- The following substitutions are interpolated in the MAILCAP-COMMAND
- string:
- - \"%s\" to FILE name passed through
- `convert-standard-filename', so it must be absolute path.
- - \"%1\" to \"%9\" groups from MATCH-DATA found in the LINK string by
- the regular expression in the key part of the `org-file-apps' entry.
- (performed by caller). Not recommended, consider a lisp function
- instead of a shell command. For example, the following link in an
- Org file
- <file:///usr/share/doc/bash/bashref.pdf::#Redirections::allocate a file>
- may be handled by an `org-file-apps' entry like
- (\"\\\\.pdf\\\\(?:\\\\.[gx]z\\\\|\\\\.bz2\\\\)?::\\\\(#[^:]+\\\\)::\\\\(.+\\\\)\\\\\\='\"
- . \"okular --find %2 %s%1\")
- Use backslash \"\\\" to quote percent \"%\" or any other character
- including backslash itself.
- In addition, each argument is passed through `shell-quote-argument',
- so quotes around substitutions should not be used. For compliance
- with mailcap files shipped e.g. in Debian GNU/Linux, single or double
- quotes around substitutions are stripped. It deviates from mailcap
- specification that requires file name to be safe for shell and for the
- application."
- (let ((spec (list (cons ?s (convert-standard-filename file))))
- (ngroups (min 9 (- (/ (length match-data) 2) 1))))
- (when (> ngroups 0)
- (set-match-data match-data)
- (dolist (i (number-sequence 1 ngroups))
- (push (cons (+ ?0 i) (match-string-no-properties i link)) spec)))
- (replace-regexp-in-string
- (rx (or (and "\\" (or (group anything) string-end))
- (and (optional (group (any "'\"")))
- "%"
- (or (group anything) string-end)
- (optional (group (backref 2))))))
- (lambda (fmt)
- (let* ((backslash (match-string-no-properties 1 fmt))
- (key (match-string 3 fmt))
- (value (and key (alist-get (string-to-char key) spec))))
- (cond
- (backslash)
- (value (let ((quot (match-string 2 fmt))
- (subst (shell-quote-argument value)))
- ;; Remove quotes around the file name - we use
- ;; `shell-quote-argument'.
- (if (match-string 4 fmt)
- subst
- (concat quot subst))))
- (t (error "Invalid format `%s'" fmt)))))
- mailcap-command nil 'literal)))
- ;;;###autoload
- (defun org-open-file (path &optional in-emacs line search)
- "Open the file at PATH.
- First, this expands any special file name abbreviations. Then the
- configuration variable `org-file-apps' is checked if it contains an
- entry for this file type, and if yes, the corresponding command is launched.
- If no application is found, Emacs simply visits the file.
- With optional prefix argument IN-EMACS, Emacs will visit the file.
- With a double \\[universal-argument] \\[universal-argument] \
- prefix arg, Org tries to avoid opening in Emacs
- and to use an external application to visit the file.
- Optional LINE specifies a line to go to, optional SEARCH a string
- to search for. If LINE or SEARCH is given, the file will be
- opened in Emacs, unless an entry from `org-file-apps' that makes
- use of groups in a regexp matches.
- If you want to change the way frames are used when following a
- link, please customize `org-link-frame-setup'.
- If the file does not exist, throw an error."
- (let* ((file (if (equal path "") buffer-file-name
- (substitute-in-file-name (expand-file-name path))))
- (file-apps (append org-file-apps (org--file-default-apps)))
- (apps (cl-remove-if #'org--file-apps-entry-locator-p file-apps))
- (apps-locator (cl-remove-if-not #'org--file-apps-entry-locator-p
- file-apps))
- (remp (and (assq 'remote apps) (file-remote-p file)))
- (dirp (unless remp (file-directory-p file)))
- (file (if (and dirp org-open-directory-means-index-dot-org)
- (concat (file-name-as-directory file) "index.org")
- file))
- (a-m-a-p (assq 'auto-mode apps))
- (dfile (downcase file))
- ;; Reconstruct the original link from the PATH, LINE and
- ;; SEARCH args.
- (link (cond (line (concat file "::" (number-to-string line)))
- (search (concat file "::" search))
- (t file)))
- (ext
- (and (string-match "\\`.*?\\.\\([a-zA-Z0-9]+\\(\\.gz\\)?\\)\\'" dfile)
- (match-string 1 dfile)))
- (save-position-maybe
- (let ((old-buffer (current-buffer))
- (old-pos (point))
- (old-mode major-mode))
- (lambda ()
- (and (derived-mode-p 'org-mode)
- (eq old-mode 'org-mode)
- (or (not (eq old-buffer (current-buffer)))
- (not (eq old-pos (point))))
- (org-mark-ring-push old-pos old-buffer)))))
- cmd link-match-data)
- (cond
- ((member in-emacs '((16) system))
- (setq cmd (cdr (assq 'system apps))))
- (in-emacs (setq cmd 'emacs))
- (t
- (setq cmd (or (and remp (cdr (assq 'remote apps)))
- (and dirp (cdr (assq 'directory apps)))
- ;; First, try matching against apps-locator if we
- ;; get a match here, store the match data for
- ;; later.
- (let* ((case-fold-search t)
- (match (assoc-default link apps-locator
- 'string-match)))
- (if match
- (progn (setq link-match-data (match-data))
- match)
- (progn (setq in-emacs (or in-emacs line search))
- nil))) ; if we have no match in apps-locator,
- ; always open the file in emacs if line or search
- ; is given (for backwards compatibility)
- (assoc-default dfile
- (org--file-apps-regexp-alist apps a-m-a-p)
- 'string-match)
- (cdr (assoc ext apps))
- (cdr (assq t apps))))))
- (when (eq cmd 'system)
- (setq cmd (cdr (assq 'system apps))))
- (when (eq cmd 'default)
- (setq cmd (cdr (assoc t apps))))
- (when (eq cmd 'mailcap)
- (require 'mailcap)
- (mailcap-parse-mailcaps)
- (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
- (command (mailcap-mime-info mime-type)))
- (if (stringp command)
- (setq cmd command)
- (setq cmd 'emacs))))
- (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
- (not (file-exists-p file))
- (not org-open-non-existing-files))
- (user-error "No such file: %s" file))
- (cond
- ((org-string-nw-p cmd)
- (setq cmd (org--open-file-format-command cmd file link link-match-data))
- (save-window-excursion
- (message "Running %s...done" cmd)
- ;; Handlers such as "gio open" and kde-open5 start viewer in background
- ;; and exit immediately. Use pipe connection type instead of pty to
- ;; avoid killing children processes with SIGHUP when temporary terminal
- ;; session is finished.
- ;;
- ;; TODO: Once minimum Emacs version is 25.1 or above, consider using
- ;; the `make-process' invocation from 5db61eb0f929 to get more helpful
- ;; error messages.
- (let ((process-connection-type nil))
- (start-process-shell-command cmd nil cmd))
- (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
- ((or (stringp cmd)
- (eq cmd 'emacs))
- (funcall (cdr (assq 'file org-link-frame-setup)) file)
- (widen)
- (cond (line (org-goto-line line)
- (when (derived-mode-p 'org-mode) (org-fold-reveal)))
- (search (condition-case err
- (org-link-search search)
- ;; Save position before error-ing out so user
- ;; can easily move back to the original buffer.
- (error (funcall save-position-maybe)
- (error (nth 1 err)))))))
- ((functionp cmd)
- (save-match-data
- (set-match-data link-match-data)
- (condition-case nil
- (funcall cmd file link)
- ;; FIXME: Remove this check when most default installations
- ;; of Emacs have at least Org 9.0.
- ((debug wrong-number-of-arguments wrong-type-argument
- invalid-function)
- (user-error "Please see Org News for version 9.0 about \
- `org-file-apps'--Lisp error: %S" cmd)))))
- ((consp cmd)
- ;; FIXME: Remove this check when most default installations of
- ;; Emacs have at least Org 9.0. Heads-up instead of silently
- ;; fall back to `org-link-frame-setup' for an old usage of
- ;; `org-file-apps' with sexp instead of a function for `cmd'.
- (user-error "Please see Org News for version 9.0 about \
- `org-file-apps'--Error: Deprecated usage of %S" cmd))
- (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
- (funcall save-position-maybe)))
- ;;;###autoload
- (defun org-open-at-point-global ()
- "Follow a link or a time-stamp like Org mode does.
- Also follow links and emails as seen by `thing-at-point'.
- This command can be called in any mode to follow an external
- link or a time-stamp that has Org mode syntax. Its behavior
- is undefined when called on internal links like fuzzy links.
- Raise a user error when there is nothing to follow."
- (interactive)
- (let ((tap-url (thing-at-point 'url))
- (tap-email (thing-at-point 'email)))
- (cond ((org-in-regexp org-link-any-re)
- (org-link-open-from-string (match-string-no-properties 0)))
- ((or (org-in-regexp org-ts-regexp-both nil t)
- (org-in-regexp org-tsr-regexp-both nil t))
- (org-follow-timestamp-link))
- (tap-url (org-link-open-from-string tap-url))
- (tap-email (org-link-open-from-string
- (concat "mailto:" tap-email)))
- (t (user-error "No link found")))))
- (defvar org-open-at-point-functions nil
- "Hook that is run when following a link at point.
- Functions in this hook must return t if they identify and follow
- a link at point. If they don't find anything interesting at point,
- they must return nil.")
- (defun org-open-at-point (&optional arg)
- "Open thing at point.
- The thing can be a link, citation, timestamp, footnote, src-block or
- tags.
- When point is on a link, follow it. Normally, files will be
- opened by an appropriate application. If the optional prefix
- argument ARG is non-nil, Emacs will visit the file. With
- a double prefix argument, try to open outside of Emacs, in the
- application the system uses for this file type.
- When point is on a timestamp, open the agenda at the day
- specified.
- When point is a footnote definition, move to the first reference
- found. If it is on a reference, move to the associated
- definition.
- When point is on a src-block of inline src-block, open its result.
- When point is on a citation, follow it.
- When point is on a headline, display a list of every link in the
- entry, so it is possible to pick one, or all, of them. If point
- is on a tag, call `org-tags-view' instead.
- On top of syntactically correct links, this function also tries
- to open links and time-stamps in comments, node properties, and
- keywords if point is on something looking like a timestamp or
- a link."
- (interactive "P")
- (org-load-modules-maybe)
- (setq org-window-config-before-follow-link (current-window-configuration))
- (org-remove-occur-highlights nil nil t)
- (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
- (let* ((context
- ;; Only consider supported types, even if they are not the
- ;; closest one.
- (org-element-lineage
- (org-element-context)
- '(citation citation-reference clock comment comment-block
- footnote-definition footnote-reference headline
- inline-src-block inlinetask keyword link node-property
- planning src-block timestamp)
- t))
- (type (org-element-type context))
- (value (org-element-property :value context)))
- (cond
- ((not type) (user-error "No link found"))
- ;; No valid link at point. For convenience, look if something
- ;; looks like a link under point in some specific places.
- ((memq type '(comment comment-block node-property keyword))
- (call-interactively #'org-open-at-point-global))
- ;; On a headline or an inlinetask, but not on a timestamp,
- ;; a link, a footnote reference or a citation.
- ((memq type '(headline inlinetask))
- (org-match-line org-complex-heading-regexp)
- (let ((tags-beg (match-beginning 5))
- (tags-end (match-end 5)))
- (if (and tags-beg (>= (point) tags-beg) (< (point) tags-end))
- ;; On tags.
- (org-tags-view
- arg
- (save-excursion
- (let* ((beg-tag (or (search-backward ":" tags-beg 'at-limit) (point)))
- (end-tag (search-forward ":" tags-end nil 2)))
- (buffer-substring (1+ beg-tag) (1- end-tag)))))
- ;; Not on tags.
- (pcase (org-offer-links-in-entry (current-buffer) (point) arg)
- (`(nil . ,_)
- (require 'org-attach)
- (when (org-attach-dir)
- (message "Opening attachment")
- (if (equal arg '(4))
- (org-attach-reveal-in-emacs)
- (org-attach-reveal))))
- (`(,links . ,links-end)
- (dolist (link (if (stringp links) (list links) links))
- (search-forward link nil links-end)
- (goto-char (match-beginning 0))
- (org-open-at-point arg)))))))
- ;; On a footnote reference or at definition's label.
- ((or (eq type 'footnote-reference)
- (and (eq type 'footnote-definition)
- (save-excursion
- ;; Do not validate action when point is on the
- ;; spaces right after the footnote label, in order
- ;; to be on par with behavior on links.
- (skip-chars-forward " \t")
- (let ((begin
- (org-element-property :contents-begin context)))
- (if begin (< (point) begin)
- (= (org-element-property :post-affiliated context)
- (line-beginning-position)))))))
- (org-footnote-action))
- ;; On a planning line. Check if we are really on a timestamp.
- ((and (eq type 'planning)
- (org-in-regexp org-ts-regexp-both nil t))
- (org-follow-timestamp-link))
- ;; On a clock line, make sure point is on the timestamp
- ;; before opening it.
- ((and (eq type 'clock)
- value
- (>= (point) (org-element-property :begin value))
- (<= (point) (org-element-property :end value)))
- (org-follow-timestamp-link))
- ((eq type 'src-block) (org-babel-open-src-block-result))
- ;; Do nothing on white spaces after an object.
- ((>= (point)
- (save-excursion
- (goto-char (org-element-property :end context))
- (skip-chars-backward " \t")
- (point)))
- (user-error "No link found"))
- ((eq type 'inline-src-block) (org-babel-open-src-block-result))
- ((eq type 'timestamp) (org-follow-timestamp-link))
- ((eq type 'link) (org-link-open context arg))
- ((memq type '(citation citation-reference)) (org-cite-follow context arg))
- (t (user-error "No link found")))))
- (run-hook-with-args 'org-follow-link-hook))
- ;;;###autoload
- (defun org-offer-links-in-entry (buffer marker &optional nth zero)
- "Offer links in the current entry and return the selected link.
- If there is only one link, return it.
- If NTH is an integer, return the NTH link found.
- If ZERO is a string, check also this string for a link, and if
- there is one, return it."
- (with-current-buffer buffer
- (org-with-wide-buffer
- (goto-char marker)
- (let ((cnt ?0)
- have-zero end links link c)
- (when (and (stringp zero) (string-match org-link-bracket-re zero))
- (push (match-string 0 zero) links)
- (setq cnt (1- cnt) have-zero t))
- (save-excursion
- (org-back-to-heading t)
- (setq end (save-excursion (outline-next-heading) (point)))
- (while (re-search-forward org-link-any-re end t)
- ;; Only consider valid links or links openable via
- ;; `org-open-at-point'.
- (when (memq (org-element-type (org-element-context)) '(link comment comment-block node-property keyword))
- (push (match-string 0) links)))
- (setq links (org-uniquify (reverse links))))
- (cond
- ((null links)
- (message "No links"))
- ((equal (length links) 1)
- (setq link (car links)))
- ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
- (setq link (nth (if have-zero nth (1- nth)) links)))
- (t ; we have to select a link
- (save-excursion
- (save-window-excursion
- (delete-other-windows)
- (with-output-to-temp-buffer "*Select Link*"
- (dolist (l links)
- (cond
- ((not (string-match org-link-bracket-re l))
- (princ (format "[%c] %s\n" (cl-incf cnt)
- (org-unbracket-string "<" ">" l))))
- ((match-end 2)
- (princ (format "[%c] %s (%s)\n" (cl-incf cnt)
- (match-string 2 l) (match-string 1 l))))
- (t (princ (format "[%c] %s\n" (cl-incf cnt)
- (match-string 1 l)))))))
- (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
- (message "Select link to open, RET to open all:")
- (setq c (read-char-exclusive))
- (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
- (when (equal c ?q) (user-error "Abort"))
- (if (equal c ?\C-m)
- (setq link links)
- (setq nth (- c ?0))
- (when have-zero (setq nth (1+ nth)))
- (unless (and (integerp nth) (>= (length links) nth))
- (user-error "Invalid link selection"))
- (setq link (nth (1- nth) links)))))
- (cons link end)))))
- ;;; File search
- (defun org-do-occur (regexp &optional cleanup)
- "Call the Emacs command `occur'.
- If CLEANUP is non-nil, remove the printout of the regular expression
- in the *Occur* buffer. This is useful if the regex is long and not useful
- to read."
- (occur regexp)
- (when cleanup
- (let ((cwin (selected-window)) win beg end)
- (when (setq win (get-buffer-window "*Occur*"))
- (select-window win))
- (goto-char (point-min))
- (when (re-search-forward "match[a-z]+" nil t)
- (setq beg (match-end 0))
- (when (re-search-forward "^[ \t]*[0-9]+" nil t)
- (setq end (1- (match-beginning 0)))))
- (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
- (goto-char (point-min))
- (select-window cwin))))
- ;;; The Mark Ring
- (defvar org-mark-ring nil
- "Mark ring for positions before jumps in Org mode.")
- (defvar org-mark-ring-last-goto nil
- "Last position in the mark ring used to go back.")
- ;; Fill and close the ring
- (setq org-mark-ring nil)
- (setq org-mark-ring-last-goto nil) ;in case file is reloaded
- (dotimes (_ org-mark-ring-length) (push (make-marker) org-mark-ring))
- (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
- org-mark-ring)
- (defun org-mark-ring-push (&optional pos buffer)
- "Put the current position into the mark ring and rotate it.
- Also push position into the Emacs mark ring. If optional
- argument POS and BUFFER are not nil, mark this location instead."
- (interactive)
- (let ((pos (or pos (point)))
- (buffer (or buffer (current-buffer))))
- (with-current-buffer buffer
- (org-with-point-at pos (push-mark nil t)))
- (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
- (move-marker (car org-mark-ring) pos buffer))
- (message
- (substitute-command-keys
- "Position saved to mark ring, go back with `\\[org-mark-ring-goto]'.")))
- (defun org-mark-ring-goto (&optional n)
- "Jump to the previous position in the mark ring.
- With prefix arg N, jump back that many stored positions. When
- called several times in succession, walk through the entire ring.
- Org mode commands jumping to a different position in the current file,
- or to another Org file, automatically push the old position onto the ring."
- (interactive "p")
- (let (p m)
- (if (eq last-command this-command)
- (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
- (setq p org-mark-ring))
- (setq org-mark-ring-last-goto p)
- (setq m (car p))
- (pop-to-buffer-same-window (marker-buffer m))
- (goto-char m)
- (when (or (org-invisible-p) (org-invisible-p2)) (org-fold-show-context 'mark-goto))))
- ;;; Following specific links
- (defvar org-agenda-buffer-tmp-name)
- (defvar org-agenda-start-on-weekday)
- (defvar org-agenda-buffer-name)
- (defun org-follow-timestamp-link ()
- "Open an agenda view for the time-stamp date/range at point."
- ;; Avoid changing the global value.
- (let ((org-agenda-buffer-name org-agenda-buffer-name))
- (cond
- ((org-at-date-range-p t)
- (let ((org-agenda-start-on-weekday)
- (t1 (match-string 1))
- (t2 (match-string 2)) tt1 tt2)
- (setq tt1 (time-to-days (org-time-string-to-time t1))
- tt2 (time-to-days (org-time-string-to-time t2)))
- (let ((org-agenda-buffer-tmp-name
- (format "*Org Agenda(a:%s)"
- (concat (substring t1 0 10) "--" (substring t2 0 10)))))
- (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
- ((org-at-timestamp-p 'lax)
- (let ((org-agenda-buffer-tmp-name
- (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
- (org-agenda-list nil (time-to-days (org-time-string-to-time
- (substring (match-string 1) 0 10)))
- 1)))
- (t (error "This should not happen")))))
- ;;; Following file links
- (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
- (declare-function mailcap-extension-to-mime "mailcap" (extn))
- (declare-function mailcap-mime-info
- "mailcap" (string &optional request no-decode))
- (defvar org-wait nil)
- ;;;; Refiling
- (defun org-get-org-file ()
- "Read a filename, with default directory `org-directory'."
- (let ((default (or org-default-notes-file remember-data-file)))
- (read-file-name (format "File name [%s]: " default)
- (file-name-as-directory org-directory)
- default)))
- (defun org-notes-order-reversed-p ()
- "Check if the current file should receive notes in reversed order."
- (cond
- ((not org-reverse-note-order) nil)
- ((eq t org-reverse-note-order) t)
- ((not (listp org-reverse-note-order)) nil)
- (t (catch 'exit
- (dolist (entry org-reverse-note-order)
- (when (string-match (car entry) buffer-file-name)
- (throw 'exit (cdr entry))))))))
- (defvar org-agenda-new-buffers nil
- "Buffers created to visit agenda files.")
- (declare-function org-string-nw-p "org-macs" (s))
- ;;;; Dynamic blocks
- (defun org-find-dblock (name)
- "Find the first dynamic block with name NAME in the buffer.
- If not found, stay at current position and return nil."
- (let ((case-fold-search t) pos)
- (save-excursion
- (goto-char (point-min))
- (setq pos (and (re-search-forward
- (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
- (match-beginning 0))))
- (when pos (goto-char pos))
- pos))
- (defun org-create-dblock (plist)
- "Create a dynamic block section, with parameters taken from PLIST.
- PLIST must contain a :name entry which is used as the name of the block."
- (when (string-match "\\S-" (buffer-substring (line-beginning-position) (line-end-position)))
- (end-of-line 1)
- (newline))
- (let ((col (current-column))
- (name (plist-get plist :name)))
- (insert "#+BEGIN: " name)
- (while plist
- (if (eq (car plist) :name)
- (setq plist (cddr plist))
- (insert " " (prin1-to-string (pop plist)))))
- (insert "\n\n" (make-string col ?\ ) "#+END:\n")
- (beginning-of-line -2)))
- (defun org-prepare-dblock ()
- "Prepare dynamic block for refresh.
- This empties the block, puts the cursor at the insert position and returns
- the property list including an extra property :name with the block name."
- (unless (looking-at org-dblock-start-re)
- (user-error "Not at a dynamic block"))
- (let* ((begdel (1+ (match-end 0)))
- (name (org-no-properties (match-string 1)))
- (params (append (list :name name)
- (read (concat "(" (match-string 3) ")")))))
- (save-excursion
- (beginning-of-line 1)
- (skip-chars-forward " \t")
- (setq params (plist-put params :indentation-column (current-column))))
- (unless (re-search-forward org-dblock-end-re nil t)
- (error "Dynamic block not terminated"))
- (setq params
- (append params
- (list :content (buffer-substring
- begdel (match-beginning 0)))))
- (delete-region begdel (match-beginning 0))
- (goto-char begdel)
- (open-line 1)
- params))
- (defun org-map-dblocks (&optional command)
- "Apply COMMAND to all dynamic blocks in the current buffer.
- If COMMAND is not given, use `org-update-dblock'."
- (let ((cmd (or command 'org-update-dblock)))
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward org-dblock-start-re nil t)
- (goto-char (match-beginning 0))
- (save-excursion
- (condition-case nil
- (funcall cmd)
- (error (message "Error during update of dynamic block"))))
- (unless (re-search-forward org-dblock-end-re nil t)
- (error "Dynamic block not terminated"))))))
- (defvar org-dynamic-block-alist nil
- "Alist defining all the Org dynamic blocks.
- The key is the dynamic block type name, as a string. The value
- is the function used to insert the dynamic block.
- Use `org-dynamic-block-define' to populate it.")
- (defun org-dynamic-block-function (type)
- "Return function associated to a given dynamic block type.
- TYPE is the dynamic block type, as a string."
- (cdr (assoc type org-dynamic-block-alist)))
- (defun org-dynamic-block-types ()
- "List all defined dynamic block types."
- (mapcar #'car org-dynamic-block-alist))
- (defun org-dynamic-block-define (type func)
- "Define dynamic block TYPE with FUNC.
- TYPE is a string. FUNC is the function creating the dynamic
- block of such type."
- (pcase (assoc type org-dynamic-block-alist)
- (`nil (push (cons type func) org-dynamic-block-alist))
- (def (setcdr def func))))
- (defun org-dynamic-block-insert-dblock (type &optional interactive-p)
- "Insert a dynamic block of type TYPE.
- When used interactively, select the dynamic block types among
- defined types, per `org-dynamic-block-define'. If INTERACTIVE-P
- is non-nil, call the dynamic block function interactively."
- (interactive (list (completing-read "Dynamic block: "
- (org-dynamic-block-types))
- t))
- (pcase (org-dynamic-block-function type)
- (`nil (error "No such dynamic block: %S" type))
- ((and f (pred functionp))
- (if interactive-p (call-interactively f) (funcall f)))
- (_ (error "Invalid function for dynamic block %S" type))))
- (defun org-dblock-update (&optional arg)
- "User command for updating dynamic blocks.
- Update the dynamic block at point. With prefix ARG, update all dynamic
- blocks in the buffer."
- (interactive "P")
- (if arg
- (org-update-all-dblocks)
- (or (looking-at org-dblock-start-re)
- (org-beginning-of-dblock))
- (org-update-dblock)))
- (defun org-update-dblock ()
- "Update the dynamic block at point.
- This means to empty the block, parse for parameters and then call
- the correct writing function."
- (interactive)
- (save-excursion
- (let* ((win (selected-window))
- (pos (point))
- (line (org-current-line))
- (params (org-prepare-dblock))
- (name (plist-get params :name))
- (indent (plist-get params :indentation-column))
- (cmd (intern (concat "org-dblock-write:" name))))
- (message "Updating dynamic block `%s' at line %d..." name line)
- (funcall cmd params)
- (message "Updating dynamic block `%s' at line %d...done" name line)
- (goto-char pos)
- (when (and indent (> indent 0))
- (setq indent (make-string indent ?\ ))
- (save-excursion
- (select-window win)
- (org-beginning-of-dblock)
- (forward-line 1)
- (while (not (looking-at org-dblock-end-re))
- (insert indent)
- (beginning-of-line 2))
- (when (looking-at org-dblock-end-re)
- (and (looking-at "[ \t]+")
- (replace-match ""))
- (insert indent)))))))
- (defun org-beginning-of-dblock ()
- "Find the beginning of the dynamic block at point.
- Error if there is no such block at point."
- (let ((pos (point))
- beg)
- (end-of-line 1)
- (if (and (re-search-backward org-dblock-start-re nil t)
- (setq beg (match-beginning 0))
- (re-search-forward org-dblock-end-re nil t)
- (> (match-end 0) pos))
- (goto-char beg)
- (goto-char pos)
- (error "Not in a dynamic block"))))
- (defun org-update-all-dblocks ()
- "Update all dynamic blocks in the buffer.
- This function can be used in a hook."
- (interactive)
- (when (derived-mode-p 'org-mode)
- (org-map-dblocks 'org-update-dblock)))
- ;;;; Completion
- (declare-function org-export-backend-options "ox" (cl-x) t)
- (defun org-get-export-keywords ()
- "Return a list of all currently understood export keywords.
- Export keywords include options, block names, attributes and
- keywords relative to each registered export back-end."
- (let (keywords)
- (dolist (backend
- (bound-and-true-p org-export-registered-backends)
- (delq nil keywords))
- ;; Back-end name (for keywords, like #+LATEX:)
- (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
- (dolist (option-entry (org-export-backend-options backend))
- ;; Back-end options.
- (push (nth 1 option-entry) keywords)))))
- (defconst org-options-keywords
- '("ARCHIVE:" "AUTHOR:" "BIBLIOGRAPHY:" "BIND:" "CATEGORY:" "CITE_EXPORT:"
- "COLUMNS:" "CREATOR:" "DATE:" "DESCRIPTION:" "DRAWERS:" "EMAIL:"
- "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:" "INDEX:" "KEYWORDS:" "LANGUAGE:"
- "MACRO:" "OPTIONS:" "PROPERTY:" "PRINT_BIBLIOGRAPHY" "PRIORITIES:"
- "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:" "TITLE:" "TODO:"
- "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
- (defcustom org-structure-template-alist
- '(("a" . "export ascii")
- ("c" . "center")
- ("C" . "comment")
- ("e" . "example")
- ("E" . "export")
- ("h" . "export html")
- ("l" . "export latex")
- ("q" . "quote")
- ("s" . "src")
- ("v" . "verse"))
- "An alist of keys and block types.
- `org-insert-structure-template' will display a menu with this list of
- templates to choose from. The block type is inserted, with
- \"#+begin_\" and \"#+end_\" added automatically. If the block type
- consists of just uppercase letters, \"#+BEGIN_\" and \"#+END_\" are
- added instead.
- The menu keys are defined by the car of each entry in this alist.
- If two entries have the keys \"a\" and \"aa\" respectively, the
- former will be inserted by typing \"a TAB/RET/SPC\" and the
- latter will be inserted by typing \"aa\". If an entry with the
- key \"aab\" is later added, it can be inserted by typing \"ab\".
- If loaded, Org Tempo also uses `org-structure-template-alist'. A
- block can be inserted by pressing TAB after the string \"<KEY\"."
- :group 'org-edit-structure
- :type '(repeat
- (cons (string :tag "Key")
- (string :tag "Template")))
- :package-version '(Org . "9.2"))
- (defun org--check-org-structure-template-alist (&optional checklist)
- "Check whether `org-structure-template-alist' is set up correctly.
- In particular, check if the Org 9.2 format is used as opposed to
- previous format."
- (let ((elm (cl-remove-if-not (lambda (x) (listp (cdr x)))
- (or (symbol-value checklist)
- org-structure-template-alist))))
- (when elm
- (org-display-warning
- (format "
- Please update the entries of `%s'.
- In Org 9.2 the format was changed from something like
- (\"s\" \"#+BEGIN_SRC ?\\n#+END_SRC\")
- to something like
- (\"s\" . \"src\")
- Please refer to the documentation of `org-structure-template-alist'.
- The following entries must be updated:
- %s"
- (or checklist 'org-structure-template-alist)
- (pp-to-string elm))))))
- (defun org--insert-structure-template-mks ()
- "Present `org-structure-template-alist' with `org-mks'.
- Menus are added if keys require more than one keystroke. Tabs
- are added to single key entries when more than one stroke is
- needed. Keys longer than two characters are reduced to two
- characters."
- (org--check-org-structure-template-alist)
- (let* (case-fold-search
- (templates (append org-structure-template-alist
- '(("\t" . "Press TAB, RET or SPC to write block name"))))
- (keys (mapcar #'car templates))
- (start-letters
- (delete-dups (mapcar (lambda (key) (substring key 0 1)) keys)))
- ;; Sort each element of `org-structure-template-alist' into
- ;; sublists according to the first letter.
- (superlist
- (mapcar (lambda (letter)
- (list letter
- (cl-remove-if-not
- (apply-partially #'string-match-p (concat "^" letter))
- templates :key #'car)))
- start-letters)))
- (org-mks
- (apply #'append
- ;; Make an `org-mks' table. If only one element is
- ;; present in a sublist, make it part of the top-menu,
- ;; otherwise make a submenu according to the starting
- ;; letter and populate it.
- (mapcar (lambda (sublist)
- (if (eq 1 (length (cadr sublist)))
- (mapcar (lambda (elm)
- (list (substring (car elm) 0 1)
- (cdr elm) ""))
- (cadr sublist))
- ;; Create submenu.
- (let* ((topkey (car sublist))
- (elms (cadr sublist))
- (keys (mapcar #'car elms))
- (long (> (length elms) 3)))
- (append
- (list
- ;; Make a description of the submenu.
- (list topkey
- (concat
- (mapconcat #'cdr
- (cl-subseq elms 0 (if long 3 (length elms)))
- ", ")
- (when long ", ..."))))
- ;; List of entries in submenu.
- (cl-mapcar #'list
- (org--insert-structure-template-unique-keys keys)
- (mapcar #'cdr elms)
- (make-list (length elms) ""))))))
- superlist))
- "Select a key\n============"
- "Key: ")))
- (defun org--insert-structure-template-unique-keys (keys)
- "Make a list of unique, two characters long elements from KEYS.
- Elements of length one have a tab appended. Elements of length
- two are kept as is. Longer elements are truncated to length two.
- If an element cannot be made unique, an error is raised."
- (let ((ordered-keys (cl-sort (copy-sequence keys) #'< :key #'length))
- menu-keys)
- (dolist (key ordered-keys)
- (let ((potential-key
- (cl-case (length key)
- (1 (concat key "\t"))
- (2 key)
- (otherwise
- (cl-find-if-not (lambda (k) (assoc k menu-keys))
- (mapcar (apply-partially #'concat (substring key 0 1))
- (split-string (substring key 1) "" t)))))))
- (if (or (not potential-key) (assoc potential-key menu-keys))
- (user-error "Could not make unique key for `%s'" key)
- (push (cons potential-key key) menu-keys))))
- (mapcar #'car
- (cl-sort menu-keys #'<
- :key (lambda (elm) (cl-position (cdr elm) keys))))))
- (defun org-insert-structure-template (type)
- "Insert a block structure of the type #+begin_foo/#+end_foo.
- Select a block from `org-structure-template-alist' then type
- either RET, TAB or SPC to write the block type. With an active
- region, wrap the region in the block. Otherwise, insert an empty
- block.
- When foo is written as FOO, upcase the #+BEGIN/END as well."
- (interactive
- (list (pcase (org--insert-structure-template-mks)
- (`("\t" . ,_) (read-string "Structure type: "))
- (`(,_ ,choice . ,_) choice))))
- (let* ((case-fold-search t) ; Make sure that matches are case-insensitive.
- (region? (use-region-p))
- (region-start (and region? (region-beginning)))
- (region-end (and region? (copy-marker (region-end))))
- (extended? (string-match-p "\\`\\(src\\|export\\)\\'" type))
- (verbatim? (string-match-p
- (concat "\\`" (regexp-opt '("example" "export"
- "src" "comment")))
- type))
- (upcase? (string= (car (split-string type))
- (upcase (car (split-string type))))))
- (when region? (goto-char region-start))
- (let ((column (current-indentation)))
- (if (save-excursion (skip-chars-backward " \t") (bolp))
- (beginning-of-line)
- (insert "\n"))
- (save-excursion
- (indent-to column)
- (insert (format "#+%s_%s%s\n" (if upcase? "BEGIN" "begin") type (if extended? " " "")))
- (when region?
- (when verbatim? (org-escape-code-in-region (point) region-end))
- (goto-char region-end)
- ;; Ignore empty lines at the end of the region.
- (skip-chars-backward " \r\t\n")
- (end-of-line))
- (unless (bolp) (insert "\n"))
- (indent-to column)
- (insert (format "#+%s_%s" (if upcase? "END" "end") (car (split-string type))))
- (if (looking-at "[ \t]*$") (replace-match "")
- (insert "\n"))
- (when (and (eobp) (not (bolp))) (insert "\n")))
- (if extended? (end-of-line)
- (forward-line)
- (skip-chars-forward " \t")))))
- ;;;; TODO, DEADLINE, Comments
- (defun org-toggle-comment ()
- "Change the COMMENT state of an entry."
- (interactive)
- (save-excursion
- (org-back-to-heading)
- (let ((case-fold-search nil))
- (looking-at org-complex-heading-regexp))
- (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
- (skip-chars-forward " \t")
- (unless (memq (char-before) '(?\s ?\t)) (insert " "))
- (if (org-in-commented-heading-p t)
- (delete-region (point)
- (progn (search-forward " " (line-end-position) 'move)
- (skip-chars-forward " \t")
- (point)))
- (insert org-comment-string)
- (unless (eolp) (insert " ")))))
- (defvar org-last-todo-state-is-todo nil
- "This is non-nil when the last TODO state change led to a TODO state.
- If the last change removed the TODO tag or switched to DONE, then
- this is nil.")
- (defvar org-todo-setup-filter-hook nil
- "Hook for functions that pre-filter todo specs.
- Each function takes a todo spec and returns either nil or the spec
- transformed into canonical form." )
- (defvar org-todo-get-default-hook nil
- "Hook for functions that get a default item for todo.
- Each function takes arguments (NEW-MARK OLD-MARK) and returns either
- nil or a string to be used for the todo mark." )
- (defvar org-agenda-headline-snapshot-before-repeat)
- (defun org-current-effective-time ()
- "Return current time adjusted for `org-extend-today-until' variable."
- (let* ((ct (org-current-time))
- (dct (decode-time ct))
- (ct1
- (cond
- (org-use-last-clock-out-time-as-effective-time
- (or (org-clock-get-last-clock-out-time) ct))
- ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
- (org-encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
- (t ct))))
- ct1))
- (defun org-todo-yesterday (&optional arg)
- "Like `org-todo' but the time of change will be 23:59 of yesterday."
- (interactive "P")
- (if (eq major-mode 'org-agenda-mode)
- (org-agenda-todo-yesterday arg)
- (let* ((org-use-effective-time t)
- (hour (nth 2 (decode-time (org-current-time))))
- (org-extend-today-until (1+ hour)))
- (org-todo arg))))
- (defvar org-block-entry-blocking ""
- "First entry preventing the TODO state change.")
- (defun org-cancel-repeater ()
- "Cancel a repeater by setting its numeric value to zero."
- (interactive)
- (save-excursion
- (org-back-to-heading t)
- (let ((bound1 (point))
- (bound0 (save-excursion (outline-next-heading) (point))))
- (when (and (re-search-forward
- (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
- org-deadline-time-regexp "\\)\\|\\("
- org-ts-regexp "\\)")
- bound0 t)
- (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
- bound1 t))
- (replace-match "0" t nil nil 1)))))
- (defvar org-state)
- (defvar org-blocked-by-checkboxes)
- (defun org-todo (&optional arg)
- "Change the TODO state of an item.
- The state of an item is given by a keyword at the start of the heading,
- like
- *** TODO Write paper
- *** DONE Call mom
- The different keywords are specified in the variable `org-todo-keywords'.
- By default the available states are \"TODO\" and \"DONE\". So, for this
- example: when the item starts with TODO, it is changed to DONE.
- When it starts with DONE, the DONE is removed. And when neither TODO nor
- DONE are present, add TODO at the beginning of the heading.
- You can set up single-character keys to fast-select the new state. See the
- `org-todo-keywords' and `org-use-fast-todo-selection' for details.
- With `\\[universal-argument]' prefix ARG, force logging the state change \
- and take a
- logging note.
- With a `\\[universal-argument] \\[universal-argument]' prefix, switch to the \
- next set of TODO \
- keywords (nextset).
- Another way to achieve this is `S-C-<right>'.
- With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
- prefix, circumvent any state blocking.
- With numeric prefix arg, switch to the Nth state.
- With a numeric prefix arg of 0, inhibit note taking for the change.
- With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
- When called through ELisp, arg is also interpreted in the following way:
- `none' -> empty state
- \"\" -> switch to empty state
- `done' -> switch to DONE
- `nextset' -> switch to the next set of keywords
- `previousset' -> switch to the previous set of keywords
- \"WAITING\" -> switch to the specified keyword, but only if it
- really is a member of `org-todo-keywords'."
- (interactive "P")
- (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
- (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
- 'region-start-level 'region))
- org-loop-over-headlines-in-active-region)
- (org-map-entries
- (lambda () (org-todo arg))
- nil cl
- (when (org-invisible-p) (org-end-of-subtree nil t))))
- (when (equal arg '(16)) (setq arg 'nextset))
- (when (equal (prefix-numeric-value arg) -1) (org-cancel-repeater) (setq arg nil))
- (when (< (prefix-numeric-value arg) -1) (user-error "Prefix argument %d not supported" arg))
- (let ((org-blocker-hook org-blocker-hook)
- commentp
- case-fold-search)
- (when (equal arg '(64))
- (setq arg nil org-blocker-hook nil))
- (when (and org-blocker-hook
- (or org-inhibit-blocking
- (org-entry-get nil "NOBLOCKING")))
- (setq org-blocker-hook nil))
- (save-excursion
- (catch 'exit
- (org-back-to-heading t)
- (when (org-in-commented-heading-p t)
- (org-toggle-comment)
- (setq commentp t))
- (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
- (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
- (looking-at "\\(?: *\\|[ \t]*$\\)"))
- (let* ((match-data (match-data))
- (startpos (copy-marker (line-beginning-position)))
- (force-log (and (equal arg '(4)) (prog1 t (setq arg nil))))
- (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
- (org-log-done org-log-done)
- (org-log-repeat org-log-repeat)
- (org-todo-log-states org-todo-log-states)
- (org-inhibit-logging
- (if (equal arg 0)
- (progn (setq arg nil) 'note) org-inhibit-logging))
- (this (match-string 1))
- (hl-pos (match-beginning 0))
- (head (org-get-todo-sequence-head this))
- (ass (assoc head org-todo-kwd-alist))
- (interpret (nth 1 ass))
- (done-word (nth 3 ass))
- (final-done-word (nth 4 ass))
- (org-last-state (or this ""))
- (completion-ignore-case t)
- (member (member this org-todo-keywords-1))
- (tail (cdr member))
- (org-state (cond
- ((eq arg 'right)
- ;; Next state
- (if this
- (if tail (car tail) nil)
- (car org-todo-keywords-1)))
- ((eq arg 'left)
- ;; Previous state
- (unless (equal member org-todo-keywords-1)
- (if this
- (nth (- (length org-todo-keywords-1)
- (length tail) 2)
- org-todo-keywords-1)
- (org-last org-todo-keywords-1))))
- (arg
- ;; User or caller requests a specific state.
- (cond
- ((equal arg "") nil)
- ((eq arg 'none) nil)
- ((eq arg 'done) (or done-word (car org-done-keywords)))
- ((eq arg 'nextset)
- (or (car (cdr (member head org-todo-heads)))
- (car org-todo-heads)))
- ((eq arg 'previousset)
- (let ((org-todo-heads (reverse org-todo-heads)))
- (or (car (cdr (member head org-todo-heads)))
- (car org-todo-heads))))
- ((car (member arg org-todo-keywords-1)))
- ((stringp arg)
- (user-error "State `%s' not valid in this file" arg))
- ((nth (1- (prefix-numeric-value arg))
- org-todo-keywords-1))))
- ((and org-todo-key-trigger org-use-fast-todo-selection)
- ;; Use fast selection.
- (org-fast-todo-selection this))
- ((null member) (or head (car org-todo-keywords-1)))
- ((equal this final-done-word) nil) ;-> make empty
- ((null tail) nil) ;-> first entry
- ((memq interpret '(type priority))
- (if (eq this-command last-command)
- (car tail)
- (if (> (length tail) 0)
- (or done-word (car org-done-keywords))
- nil)))
- (t
- (car tail))))
- (org-state (or
- (run-hook-with-args-until-success
- 'org-todo-get-default-hook org-state org-last-state)
- org-state))
- (next (if (org-string-nw-p org-state) (concat " " org-state " ") " "))
- (change-plist (list :type 'todo-state-change :from this :to org-state
- :position startpos))
- dolog now-done-p)
- (when org-blocker-hook
- (let (org-blocked-by-checkboxes block-reason)
- (setq org-last-todo-state-is-todo
- (not (member this org-done-keywords)))
- (unless (save-excursion
- (save-match-data
- (org-with-wide-buffer
- (run-hook-with-args-until-failure
- 'org-blocker-hook change-plist))))
- (setq block-reason (if org-blocked-by-checkboxes
- "contained checkboxes"
- (format "\"%s\"" org-block-entry-blocking)))
- (if (called-interactively-p 'interactive)
- (user-error "TODO state change from %s to %s blocked (by %s)"
- this org-state block-reason)
- ;; Fail silently.
- (message "TODO state change from %s to %s blocked (by %s)"
- this org-state block-reason)
- (throw 'exit nil)))))
- (store-match-data match-data)
- (org-fold-core-ignore-modifications
- (goto-char (match-beginning 0))
- (replace-match "")
- ;; We need to use `insert-before-markers-and-inherit'
- ;; because: (1) We want to preserve the folding state
- ;; text properties; (2) We do not want to make point
- ;; move before new todo state when inserting a new todo
- ;; into an empty heading. In (2), the above
- ;; `save-excursion' is relying on markers saved before.
- (insert-before-markers-and-inherit next)
- (unless (org-invisible-p (line-beginning-position))
- (org-fold-region (line-beginning-position)
- (line-end-position)
- nil)))
- (cond ((and org-state (equal this org-state))
- (message "TODO state was already %s" (org-trim next)))
- ((not (pos-visible-in-window-p hl-pos))
- (message "TODO state changed to %s" (org-trim next))))
- (unless head
- (setq head (org-get-todo-sequence-head org-state)
- ass (assoc head org-todo-kwd-alist)
- interpret (nth 1 ass)
- done-word (nth 3 ass)
- final-done-word (nth 4 ass)))
- (when (memq arg '(nextset previousset))
- (message "Keyword-Set %d/%d: %s"
- (- (length org-todo-sets) -1
- (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
- (length org-todo-sets)
- (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
- (setq org-last-todo-state-is-todo
- (not (member org-state org-done-keywords)))
- (setq now-done-p (and (member org-state org-done-keywords)
- (not (member this org-done-keywords))))
- (and logging (org-local-logging logging))
- (when (or (and (or org-todo-log-states org-log-done)
- (not (eq org-inhibit-logging t))
- (not (memq arg '(nextset previousset))))
- force-log)
- ;; We need to look at recording a time and note.
- (setq dolog (or (if force-log 'note)
- (nth 1 (assoc org-state org-todo-log-states))
- (nth 2 (assoc this org-todo-log-states))))
- (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
- (setq dolog 'time))
- (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
- (and org-state
- (member org-state org-not-done-keywords)
- (not (member this org-not-done-keywords))))
- ;; This is now a todo state and was not one before
- ;; If there was a CLOSED time stamp, get rid of it.
- (org-add-planning-info nil nil 'closed))
- (when (and now-done-p org-log-done)
- ;; It is now done, and it was not done before.
- (org-add-planning-info 'closed (org-current-effective-time))
- (when (and (not dolog) (eq 'note org-log-done))
- (org-add-log-setup 'done org-state this 'note)))
- (when (and org-state dolog)
- ;; This is a non-nil state, and we need to log it.
- (org-add-log-setup 'state org-state this dolog)))
- ;; Fixup tag positioning.
- (org-todo-trigger-tag-changes org-state)
- (when org-auto-align-tags (org-align-tags))
- (when org-provide-todo-statistics
- (org-update-parent-todo-statistics))
- (when (bound-and-true-p org-clock-out-when-done)
- (org-clock-out-if-current))
- (run-hooks 'org-after-todo-state-change-hook)
- (when (and arg (not (member org-state org-done-keywords)))
- (setq head (org-get-todo-sequence-head org-state)))
- (put-text-property (line-beginning-position) (line-end-position) 'org-todo-head head)
- ;; Do we need to trigger a repeat?
- (when now-done-p
- (when (boundp 'org-agenda-headline-snapshot-before-repeat)
- ;; This is for the agenda, take a snapshot of the headline.
- (save-match-data
- (setq org-agenda-headline-snapshot-before-repeat
- (org-get-heading))))
- (org-auto-repeat-maybe org-state))
- ;; Fixup cursor location if close to the keyword.
- (when (and (outline-on-heading-p)
- (not (bolp))
- (save-excursion (beginning-of-line 1)
- (looking-at org-todo-line-regexp))
- (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
- (goto-char (or (match-end 2) (match-end 1)))
- (and (looking-at " ")
- (not (looking-at " *:"))
- (just-one-space)))
- (when org-trigger-hook
- (save-excursion
- (run-hook-with-args 'org-trigger-hook change-plist)))
- (when commentp (org-toggle-comment))))))))
- (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
- "Block turning an entry into a TODO, using the hierarchy.
- This checks whether the current task should be blocked from state
- changes. Such blocking occurs when:
- 1. The task has children which are not all in a completed state.
- 2. A task has a parent with the property :ORDERED:, and there
- are siblings prior to the current task with incomplete
- status.
- 3. The parent of the task is blocked because it has siblings that should
- be done first, or is child of a block grandparent TODO entry."
- (if (not org-enforce-todo-dependencies)
- t ; if locally turned off don't block
- (catch 'dont-block
- ;; If this is not a todo state change, or if this entry is already DONE,
- ;; do not block
- (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
- (member (plist-get change-plist :from)
- (cons 'done org-done-keywords))
- (member (plist-get change-plist :to)
- (cons 'todo org-not-done-keywords))
- (not (plist-get change-plist :to)))
- (throw 'dont-block t))
- ;; If this task has children, and any are undone, it's blocked
- (save-excursion
- (org-back-to-heading t)
- (let ((this-level (funcall outline-level)))
- (outline-next-heading)
- (let ((child-level (funcall outline-level)))
- (while (and (not (eobp))
- (> child-level this-level))
- ;; this todo has children, check whether they are all
- ;; completed
- (when (and (not (org-entry-is-done-p))
- (org-entry-is-todo-p))
- (setq org-block-entry-blocking (org-get-heading))
- (throw 'dont-block nil))
- (outline-next-heading)
- (setq child-level (funcall outline-level))))))
- ;; Otherwise, if the task's parent has the :ORDERED: property, and
- ;; any previous siblings are undone, it's blocked
- (save-excursion
- (org-back-to-heading t)
- (let* ((pos (point))
- (parent-pos (and (org-up-heading-safe) (point)))
- (case-fold-search nil))
- (unless parent-pos (throw 'dont-block t)) ; no parent
- (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
- (forward-line 1)
- (re-search-forward org-not-done-heading-regexp pos t))
- (setq org-block-entry-blocking (match-string 0))
- (throw 'dont-block nil)) ; block, there is an older sibling not done.
- ;; Search further up the hierarchy, to see if an ancestor is blocked
- (while t
- (goto-char parent-pos)
- (unless (looking-at org-not-done-heading-regexp)
- (throw 'dont-block t)) ; do not block, parent is not a TODO
- (setq pos (point))
- (setq parent-pos (and (org-up-heading-safe) (point)))
- (unless parent-pos (throw 'dont-block t)) ; no parent
- (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
- (forward-line 1)
- (re-search-forward org-not-done-heading-regexp pos t)
- (setq org-block-entry-blocking (org-get-heading)))
- (throw 'dont-block nil)))))))) ; block, older sibling not done.
- (defcustom org-track-ordered-property-with-tag nil
- "Should the ORDERED property also be shown as a tag?
- The ORDERED property decides if an entry should require subtasks to be
- completed in sequence. Since a property is not very visible, setting
- this option means that toggling the ORDERED property with the command
- `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
- not relevant for the behavior, but it makes things more visible.
- Note that toggling the tag with tags commands will not change the property
- and therefore not influence behavior!
- This can be t, meaning the tag ORDERED should be used. It can also be a
- string to select a different tag for this task."
- :group 'org-todo
- :type '(choice
- (const :tag "No tracking" nil)
- (const :tag "Track with ORDERED tag" t)
- (string :tag "Use other tag")))
- (defun org-toggle-ordered-property ()
- "Toggle the ORDERED property of the current entry.
- For better visibility, you can track the value of this property with a tag.
- See variable `org-track-ordered-property-with-tag'."
- (interactive)
- (let* ((t1 org-track-ordered-property-with-tag)
- (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
- (save-excursion
- (org-back-to-heading)
- (if (org-entry-get nil "ORDERED")
- (progn
- (org-delete-property "ORDERED")
- (and tag (org-toggle-tag tag 'off))
- (message "Subtasks can be completed in arbitrary order"))
- (org-entry-put nil "ORDERED" "t")
- (and tag (org-toggle-tag tag 'on))
- (message "Subtasks must be completed in sequence")))))
- (defun org-block-todo-from-checkboxes (change-plist)
- "Block turning an entry into a TODO, using checkboxes.
- This checks whether the current task should be blocked from state
- changes because there are unchecked boxes in this entry."
- (if (not org-enforce-todo-checkbox-dependencies)
- t ; if locally turned off don't block
- (catch 'dont-block
- ;; If this is not a todo state change, or if this entry is already DONE,
- ;; do not block
- (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
- (member (plist-get change-plist :from)
- (cons 'done org-done-keywords))
- (member (plist-get change-plist :to)
- (cons 'todo org-not-done-keywords))
- (not (plist-get change-plist :to)))
- (throw 'dont-block t))
- ;; If this task has checkboxes that are not checked, it's blocked
- (save-excursion
- (org-back-to-heading t)
- (let ((beg (point)) end)
- (outline-next-heading)
- (setq end (point))
- (goto-char beg)
- (when (org-list-search-forward
- (concat (org-item-beginning-re)
- "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
- "\\[[- ]\\]")
- end t)
- (when (boundp 'org-blocked-by-checkboxes)
- (setq org-blocked-by-checkboxes t))
- (throw 'dont-block nil))))
- t))) ; do not block
- (defun org-entry-blocked-p ()
- "Non-nil if entry at point is blocked."
- (and (not (org-entry-get nil "NOBLOCKING"))
- (member (org-entry-get nil "TODO") org-not-done-keywords)
- (not (run-hook-with-args-until-failure
- 'org-blocker-hook
- (list :type 'todo-state-change
- :position (point)
- :from 'todo
- :to 'done)))))
- (defun org-update-statistics-cookies (all)
- "Update the statistics cookie, either from TODO or from checkboxes.
- This should be called with the cursor in a line with a statistics
- cookie. When called with a \\[universal-argument] prefix, update
- all statistics cookies in the buffer."
- (interactive "P")
- (if all
- (progn
- (org-update-checkbox-count 'all)
- (org-map-region 'org-update-parent-todo-statistics
- (point-min) (point-max)))
- (if (not (org-at-heading-p))
- (org-update-checkbox-count)
- (let ((pos (point-marker))
- end l1 l2)
- (ignore-errors (org-back-to-heading t))
- (if (not (org-at-heading-p))
- (org-update-checkbox-count)
- (setq l1 (org-outline-level))
- (setq end
- (save-excursion
- (outline-next-heading)
- (when (org-at-heading-p) (setq l2 (org-outline-level)))
- (point)))
- (if (and (save-excursion
- (re-search-forward
- "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
- (not (save-excursion
- (re-search-forward
- ":COOKIE_DATA:.*\\<todo\\>" end t))))
- (org-update-checkbox-count)
- (if (and l2 (> l2 l1))
- (progn
- (goto-char end)
- (org-update-parent-todo-statistics))
- (goto-char pos)
- (beginning-of-line 1)
- (while (re-search-forward
- "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
- (line-end-position) t)
- (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
- (goto-char pos)
- (move-marker pos nil)))))
- (defvar org-entry-property-inherited-from) ;; defined below
- (defun org-update-parent-todo-statistics ()
- "Update any statistics cookie in the parent of the current headline.
- When `org-hierarchical-todo-statistics' is nil, statistics will cover
- the entire subtree and this will travel up the hierarchy and update
- statistics everywhere."
- (let* ((prop (save-excursion
- (org-up-heading-safe)
- (org-entry-get nil "COOKIE_DATA" 'inherit)))
- (recursive (or (not org-hierarchical-todo-statistics)
- (and prop (string-match "\\<recursive\\>" prop))))
- (lim (or (and prop (marker-position org-entry-property-inherited-from))
- 0))
- (first t)
- (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
- level ltoggle l1 new ndel
- (cnt-all 0) (cnt-done 0) is-percent kwd
- checkbox-beg cookie-present)
- (catch 'exit
- (save-excursion
- (beginning-of-line 1)
- (setq ltoggle (funcall outline-level))
- ;; Three situations are to consider:
- ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
- ;; to the top-level ancestor on the headline;
- ;; 2. If parent has "recursive" property, repeat up to the
- ;; headline setting that property, taking inheritance into
- ;; account;
- ;; 3. Else, move up to direct parent and proceed only once.
- (while (and (setq level (org-up-heading-safe))
- (or recursive first)
- (>= (point) lim))
- (setq first nil cookie-present nil)
- (unless (and level
- (not (string-match
- "\\<checkbox\\>"
- (downcase (or (org-entry-get nil "COOKIE_DATA")
- "")))))
- (throw 'exit nil))
- (while (re-search-forward box-re (line-end-position) t)
- (setq cnt-all 0 cnt-done 0 cookie-present t)
- (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
- (save-match-data
- (unless (outline-next-heading) (throw 'exit nil))
- (while (and (looking-at org-complex-heading-regexp)
- (> (setq l1 (length (match-string 1))) level))
- (setq kwd (and (or recursive (= l1 ltoggle))
- (match-string 2)))
- (if (or (eq org-provide-todo-statistics 'all-headlines)
- (and (eq org-provide-todo-statistics t)
- (or (member kwd org-done-keywords)))
- (and (listp org-provide-todo-statistics)
- (stringp (car org-provide-todo-statistics))
- (or (member kwd org-provide-todo-statistics)
- (member kwd org-done-keywords)))
- (and (listp org-provide-todo-statistics)
- (listp (car org-provide-todo-statistics))
- (or (member kwd (car org-provide-todo-statistics))
- (and (member kwd org-done-keywords)
- (member kwd (cadr org-provide-todo-statistics))))))
- (setq cnt-all (1+ cnt-all))
- (and (eq org-provide-todo-statistics t)
- kwd
- (setq cnt-all (1+ cnt-all))))
- (when (or (and (member org-provide-todo-statistics '(t all-headlines))
- (member kwd org-done-keywords))
- (and (listp org-provide-todo-statistics)
- (listp (car org-provide-todo-statistics))
- (member kwd org-done-keywords)
- (member kwd (cadr org-provide-todo-statistics)))
- (and (listp org-provide-todo-statistics)
- (stringp (car org-provide-todo-statistics))
- (member kwd org-done-keywords)))
- (setq cnt-done (1+ cnt-done)))
- (outline-next-heading)))
- (setq new
- (if is-percent
- (format "[%d%%]" (floor (* 100.0 cnt-done)
- (max 1 cnt-all)))
- (format "[%d/%d]" cnt-done cnt-all))
- ndel (- (match-end 0) checkbox-beg))
- (goto-char checkbox-beg)
- (insert new)
- (delete-region (point) (+ (point) ndel))
- (when org-auto-align-tags (org-fix-tags-on-the-fly)))
- (when cookie-present
- (run-hook-with-args 'org-after-todo-statistics-hook
- cnt-done (- cnt-all cnt-done))))))
- (run-hooks 'org-todo-statistics-hook)))
- (defvar org-after-todo-statistics-hook nil
- "Hook that is called after a TODO statistics cookie has been updated.
- Each function is called with two arguments: the number of not-done entries
- and the number of done entries.
- For example, the following function, when added to this hook, will switch
- an entry to DONE when all children are done, and back to TODO when new
- entries are set to a TODO status. Note that this hook is only called
- when there is a statistics cookie in the headline!
- (defun org-summary-todo (n-done n-not-done)
- \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
- (let (org-log-done org-log-states) ; turn off logging
- (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))")
- (defvar org-todo-statistics-hook nil
- "Hook that is run whenever Org thinks TODO statistics should be updated.
- This hook runs even if there is no statistics cookie present, in which case
- `org-after-todo-statistics-hook' would not run.")
- (defun org-todo-trigger-tag-changes (state)
- "Apply the changes defined in `org-todo-state-tags-triggers'."
- (let ((l org-todo-state-tags-triggers)
- changes)
- (when (or (not state) (equal state ""))
- (setq changes (append changes (cdr (assoc "" l)))))
- (when (and (stringp state) (> (length state) 0))
- (setq changes (append changes (cdr (assoc state l)))))
- (when (member state org-not-done-keywords)
- (setq changes (append changes (cdr (assq 'todo l)))))
- (when (member state org-done-keywords)
- (setq changes (append changes (cdr (assq 'done l)))))
- (dolist (c changes)
- (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
- (defun org-local-logging (value)
- "Get logging settings from a property VALUE."
- ;; Directly set the variables, they are already local.
- (setq org-log-done nil
- org-log-repeat nil
- org-todo-log-states nil)
- (dolist (w (split-string value))
- (let (a)
- (cond
- ((setq a (assoc w org-startup-options))
- (and (member (nth 1 a) '(org-log-done org-log-repeat))
- (set (nth 1 a) (nth 2 a))))
- ((setq a (org-extract-log-state-settings w))
- (and (member (car a) org-todo-keywords-1)
- (push a org-todo-log-states)))))))
- (defun org-get-todo-sequence-head (kwd)
- "Return the head of the TODO sequence to which KWD belongs.
- If KWD is not set, check if there is a text property remembering the
- right sequence."
- (let (p)
- (cond
- ((not kwd)
- (or (get-text-property (line-beginning-position) 'org-todo-head)
- (progn
- (setq p (next-single-property-change (line-beginning-position) 'org-todo-head
- nil (line-end-position)))
- (get-text-property p 'org-todo-head))))
- ((not (member kwd org-todo-keywords-1))
- (car org-todo-keywords-1))
- (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
- (defun org-fast-todo-selection (&optional current-state)
- "Fast TODO keyword selection with single keys.
- Returns the new TODO keyword, or nil if no state change should occur.
- When CURRENT-STATE is given and selection letters are not unique globally,
- prefer a state in the current sequence over on in another sequence."
- (let* ((fulltable org-todo-key-alist)
- (head (org-get-todo-sequence-head current-state))
- (done-keywords org-done-keywords) ;; needed for the faces.
- (maxlen (apply 'max (mapcar
- (lambda (x)
- (if (stringp (car x)) (string-width (car x)) 0))
- fulltable)))
- (expert (equal org-use-fast-todo-selection 'expert))
- (prompt "")
- (fwidth (+ maxlen 3 1 3))
- (ncol (/ (- (window-width) 4) fwidth))
- tg cnt e c tbl subtable
- groups ingroup in-current-sequence)
- (save-excursion
- (save-window-excursion
- (if expert
- (set-buffer (get-buffer-create " *Org todo*"))
- (delete-other-windows)
- (set-window-buffer (split-window-vertically) (get-buffer-create " *Org todo*"))
- (org-switch-to-buffer-other-window " *Org todo*"))
- (erase-buffer)
- (setq-local org-done-keywords done-keywords)
- (setq tbl fulltable cnt 0)
- (while (setq e (pop tbl))
- (cond
- ((equal e '(:startgroup))
- (push '() groups) (setq ingroup t)
- (unless (= cnt 0)
- (setq cnt 0)
- (insert "\n"))
- (setq prompt (concat prompt "{"))
- (insert "{ "))
- ((equal e '(:endgroup))
- (setq ingroup nil cnt 0 in-current-sequence nil)
- (setq prompt (concat prompt "}"))
- (insert "}\n"))
- ((equal e '(:newline))
- (unless (= cnt 0)
- (setq cnt 0)
- (insert "\n")
- (setq e (car tbl))
- (while (equal (car tbl) '(:newline))
- (insert "\n")
- (setq tbl (cdr tbl)))))
- (t
- (setq tg (car e) c (cdr e))
- (if (equal tg head) (setq in-current-sequence t))
- (when ingroup (push tg (car groups)))
- (when in-current-sequence (push e subtable))
- (setq tg (org-add-props tg nil 'face
- (org-get-todo-face tg)))
- (when (and (= cnt 0) (not ingroup)) (insert " "))
- (setq prompt (concat prompt "[" (char-to-string c) "] " tg " "))
- (insert "[" c "] " tg (make-string
- (- fwidth 4 (length tg)) ?\ ))
- (when (and (= (setq cnt (1+ cnt)) ncol)
- ;; Avoid lines with just a closing delimiter.
- (not (equal (car tbl) '(:endgroup))))
- (insert "\n")
- (when ingroup (insert " "))
- (setq cnt 0)))))
- (insert "\n")
- (goto-char (point-min))
- (unless expert (org-fit-window-to-buffer))
- (message (concat "[a-z..]:Set [SPC]:clear"
- (if expert (concat "\n" prompt) "")))
- (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
- (setq subtable (nreverse subtable))
- (cond
- ((or (= c ?\C-g)
- (and (= c ?q) (not (rassoc c fulltable))))
- (setq quit-flag t))
- ((= c ?\ ) nil)
- ((setq e (or (rassoc c subtable) (rassoc c fulltable))
- tg (car e))
- tg)
- (t (setq quit-flag t)))))))
- (defun org-entry-is-todo-p ()
- (member (org-get-todo-state) org-not-done-keywords))
- (defun org-entry-is-done-p ()
- (member (org-get-todo-state) org-done-keywords))
- (defun org-get-todo-state ()
- "Return the TODO keyword of the current subtree."
- (save-excursion
- (org-back-to-heading t)
- (and (let ((case-fold-search nil))
- (looking-at org-todo-line-regexp))
- (match-end 2)
- (match-string 2))))
- (defun org-at-date-range-p (&optional inactive-ok)
- "Non-nil if point is inside a date range.
- When optional argument INACTIVE-OK is non-nil, also consider
- inactive time ranges.
- When this function returns a non-nil value, match data is set
- according to `org-tr-regexp-both' or `org-tr-regexp', depending
- on INACTIVE-OK."
- (interactive)
- (save-excursion
- (catch 'exit
- (let ((pos (point)))
- (skip-chars-backward "^[<\r\n")
- (skip-chars-backward "<[")
- (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
- (>= (match-end 0) pos)
- (throw 'exit t))
- (skip-chars-backward "^<[\r\n")
- (skip-chars-backward "<[")
- (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
- (>= (match-end 0) pos)
- (throw 'exit t)))
- nil)))
- (defun org-get-repeat (&optional timestamp)
- "Check if there is a time-stamp with repeater in this entry.
- Return the repeater, as a string, or nil. Also return nil when
- this function is called before first heading.
- When optional argument TIMESTAMP is a string, extract the
- repeater from there instead."
- (save-match-data
- (cond
- (timestamp
- (and (string-match org-repeat-re timestamp)
- (match-string-no-properties 1 timestamp)))
- ((org-before-first-heading-p) nil)
- (t
- (save-excursion
- (org-back-to-heading t)
- (let ((end (org-entry-end-position)))
- (catch :repeat
- (while (re-search-forward org-repeat-re end t)
- (when (save-match-data (org-at-timestamp-p 'agenda))
- (throw :repeat (match-string-no-properties 1)))))))))))
- (defvar org-last-changed-timestamp)
- (defvar org-last-inserted-timestamp)
- (defvar org-log-post-message)
- (defvar org-log-note-purpose)
- (defvar org-log-note-how nil)
- (defvar org-log-note-extra)
- (defvar org-log-setup nil)
- (defun org-auto-repeat-maybe (done-word)
- "Check if the current headline contains a repeated time-stamp.
- If yes, set TODO state back to what it was and change the base date
- of repeating deadline/scheduled time stamps to new date.
- This function is run automatically after each state change to a DONE state."
- (let* ((repeat (org-get-repeat))
- (aa (assoc org-last-state org-todo-kwd-alist))
- (interpret (nth 1 aa))
- (head (nth 2 aa))
- (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
- (msg "Entry repeats: ")
- (org-log-done nil)
- (org-todo-log-states nil)
- (end (copy-marker (org-entry-end-position))))
- (when (and repeat (not (= 0 (string-to-number (substring repeat 1)))))
- (when (eq org-log-repeat t) (setq org-log-repeat 'state))
- (let ((to-state
- (or (org-entry-get nil "REPEAT_TO_STATE" 'selective)
- (and (stringp org-todo-repeat-to-state)
- org-todo-repeat-to-state)
- (and org-todo-repeat-to-state org-last-state))))
- (org-todo (cond ((and to-state (member to-state org-todo-keywords-1))
- to-state)
- ((eq interpret 'type) org-last-state)
- (head)
- (t 'none))))
- (org-back-to-heading t)
- (org-add-planning-info nil nil 'closed)
- ;; When `org-log-repeat' is non-nil or entry contains
- ;; a clock, set LAST_REPEAT property.
- (when (or org-log-repeat
- (catch :clock
- (save-excursion
- (while (re-search-forward org-clock-line-re end t)
- (when (org-at-clock-log-p) (throw :clock t))))))
- (org-entry-put nil "LAST_REPEAT" (format-time-string
- (org-time-stamp-format t t)
- (org-current-effective-time))))
- (when org-log-repeat
- (if org-log-setup
- ;; We are already setup for some record.
- (when (eq org-log-repeat 'note)
- ;; Make sure we take a note, not only a time stamp.
- (setq org-log-note-how 'note))
- ;; Set up for taking a record.
- (org-add-log-setup 'state
- (or done-word (car org-done-keywords))
- org-last-state
- org-log-repeat)))
- ;; Time-stamps without a repeater are usually skipped. However,
- ;; a SCHEDULED time-stamp without one is removed, as they are no
- ;; longer relevant.
- (save-excursion
- (let ((scheduled (org-entry-get (point) "SCHEDULED")))
- (when (and scheduled (not (string-match-p org-repeat-re scheduled)))
- (org-remove-timestamp-with-keyword org-scheduled-string))))
- ;; Update every time-stamp with a repeater in the entry.
- (let ((planning-re (regexp-opt
- (list org-scheduled-string org-deadline-string))))
- (while (re-search-forward org-repeat-re end t)
- (let* ((ts (match-string 0))
- (type (if (not (org-at-planning-p)) "Plain:"
- (save-excursion
- (re-search-backward
- planning-re (line-beginning-position) t)
- (match-string 0)))))
- (when (and (org-at-timestamp-p 'agenda)
- (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
- (let ((n (string-to-number (match-string 2 ts)))
- (what (match-string 3 ts)))
- (when (equal what "w") (setq n (* n 7) what "d"))
- (when (and (equal what "h")
- (not (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}"
- ts)))
- (user-error
- "Cannot repeat in %d hour(s) because no hour has been set"
- n))
- ;; Preparation, see if we need to modify the start
- ;; date for the change.
- (when (match-end 1)
- (let ((time (save-match-data (org-time-string-to-time ts)))
- (repeater-type (match-string 1 ts)))
- (cond
- ((equal "." repeater-type)
- ;; Shift starting date to today, or now if
- ;; repeater is by hours.
- (if (equal what "h")
- (org-timestamp-change
- (floor (- (org-time-stamp-to-now ts t)) 60) 'minute)
- (org-timestamp-change
- (- (org-today) (time-to-days time)) 'day)))
- ((equal "+" repeater-type)
- (let ((nshiftmax 10)
- (nshift 0))
- (while (or (= nshift 0)
- (not (time-less-p nil time)))
- (when (= nshiftmax (cl-incf nshift))
- (or (y-or-n-p
- (format "%d repeater intervals were not \
- enough to shift date past today. Continue? "
- nshift))
- (user-error "Abort")))
- (org-timestamp-change n (cdr (assoc what whata)))
- (org-in-regexp org-ts-regexp3)
- (setq ts (match-string 1))
- (setq time
- (save-match-data
- (org-time-string-to-time ts)))))
- (org-timestamp-change (- n) (cdr (assoc what whata)))
- ;; Rematch, so that we have everything in place
- ;; for the real shift.
- (org-in-regexp org-ts-regexp3)
- (setq ts (match-string 1))
- (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)"
- ts)))))
- (save-excursion
- (org-timestamp-change n (cdr (assoc what whata)) nil t))
- (setq msg
- (concat msg type " " org-last-changed-timestamp " ")))))))
- (run-hooks 'org-todo-repeat-hook)
- (setq org-log-post-message msg)
- (message msg))))
- (defun org-show-todo-tree (arg)
- "Make a compact tree which shows all headlines marked with TODO.
- The tree will show the lines where the regexp matches, and all higher
- headlines above the match.
- With a `\\[universal-argument]' prefix, prompt for a regexp to match.
- With a numeric prefix N, construct a sparse tree for the Nth element
- of `org-todo-keywords-1'."
- (interactive "P")
- (let ((case-fold-search nil)
- (kwd-re
- (cond ((null arg) (concat org-not-done-regexp "\\s-"))
- ((equal arg '(4))
- (let ((kwd
- (completing-read "Keyword (or KWD1|KWD2|...): "
- (mapcar #'list org-todo-keywords-1))))
- (concat "\\("
- (mapconcat 'identity (org-split-string kwd "|") "\\|")
- "\\)\\>")))
- ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
- (regexp-quote (nth (1- (prefix-numeric-value arg))
- org-todo-keywords-1)))
- (t (user-error "Invalid prefix argument: %s" arg)))))
- (message "%d TODO entries found"
- (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
- (defun org--deadline-or-schedule (arg type time)
- "Insert DEADLINE or SCHEDULE information in current entry.
- TYPE is either `deadline' or `scheduled'. See `org-deadline' or
- `org-schedule' for information about ARG and TIME arguments."
- (org-fold-core-ignore-modifications
- (let* ((deadline? (eq type 'deadline))
- (keyword (if deadline? org-deadline-string org-scheduled-string))
- (log (if deadline? org-log-redeadline org-log-reschedule))
- (old-date (org-entry-get nil (if deadline? "DEADLINE" "SCHEDULED")))
- (old-date-time (and old-date (org-time-string-to-time old-date)))
- ;; Save repeater cookie from either TIME or current scheduled
- ;; time stamp. We are going to insert it back at the end of
- ;; the process.
- (repeater (or (and (org-string-nw-p time)
- ;; We use `org-ts-regexp-both' because we
- ;; need to tell the difference between a
- ;; real repeater and a time delta, e.g.
- ;; "+2d".
- (string-match-p org-ts-regexp-both time)
- (string-match "\\([.+-]+[0-9]+[hdwmy]\
- \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
- time)
- (match-string 1 time))
- (and (org-string-nw-p old-date)
- (string-match "\\([.+-]+[0-9]+[hdwmy]\
- \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
- old-date)
- (match-string 1 old-date)))))
- (pcase arg
- (`(4)
- (if (not old-date)
- (message (if deadline? "Entry had no deadline to remove"
- "Entry was not scheduled"))
- (when (and old-date log)
- (org-add-log-setup (if deadline? 'deldeadline 'delschedule)
- nil old-date log))
- (org-remove-timestamp-with-keyword keyword)
- (message (if deadline? "Entry no longer has a deadline."
- "Entry is no longer scheduled."))))
- (`(16)
- (save-excursion
- (org-back-to-heading t)
- (let ((regexp (if deadline? org-deadline-time-regexp
- org-scheduled-time-regexp)))
- (if (not (re-search-forward regexp (line-end-position 2) t))
- (user-error (if deadline? "No deadline information to update"
- "No scheduled information to update"))
- (let* ((rpl0 (match-string 1))
- (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0))
- (msg (if deadline? "Warn starting from" "Delay until")))
- (replace-match
- (concat keyword
- " <" rpl
- (format " -%dd"
- (abs (- (time-to-days
- (save-match-data
- (org-read-date
- nil t nil msg old-date-time)))
- (time-to-days old-date-time))))
- ">") t t))))))
- (_
- (org-add-planning-info type time 'closed)
- (when (and old-date
- log
- (not (equal old-date org-last-inserted-timestamp)))
- (org-add-log-setup (if deadline? 'redeadline 'reschedule)
- org-last-inserted-timestamp
- old-date
- log))
- (when repeater
- (save-excursion
- (org-back-to-heading t)
- (when (re-search-forward
- (concat keyword " " org-last-inserted-timestamp)
- (line-end-position 2)
- t)
- (goto-char (1- (match-end 0)))
- (insert-and-inherit " " repeater)
- (setq org-last-inserted-timestamp
- (concat (substring org-last-inserted-timestamp 0 -1)
- " " repeater
- (substring org-last-inserted-timestamp -1))))))
- (message (if deadline? "Deadline on %s" "Scheduled to %s")
- org-last-inserted-timestamp))))))
- (defun org-deadline (arg &optional time)
- "Insert a \"DEADLINE:\" string with a timestamp to make a deadline.
- When called interactively, this command pops up the Emacs calendar to let
- the user select a date.
- With one universal prefix argument, remove any deadline from the item.
- With two universal prefix arguments, prompt for a warning delay.
- With argument TIME, set the deadline at the corresponding date. TIME
- can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
- (interactive "P")
- (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
- (org-map-entries
- (lambda () (org--deadline-or-schedule arg 'deadline time))
- nil
- (if (eq org-loop-over-headlines-in-active-region 'start-level)
- 'region-start-level
- 'region)
- (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))
- (org--deadline-or-schedule arg 'deadline time)))
- (defun org-schedule (arg &optional time)
- "Insert a \"SCHEDULED:\" string with a timestamp to schedule an item.
- When called interactively, this command pops up the Emacs calendar to let
- the user select a date.
- With one universal prefix argument, remove any scheduling date from the item.
- With two universal prefix arguments, prompt for a delay cookie.
- With argument TIME, scheduled at the corresponding date. TIME can
- either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
- (interactive "P")
- (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
- (org-map-entries
- (lambda () (org--deadline-or-schedule arg 'scheduled time))
- nil
- (if (eq org-loop-over-headlines-in-active-region 'start-level)
- 'region-start-level
- 'region)
- (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))
- (org--deadline-or-schedule arg 'scheduled time)))
- (defun org-get-scheduled-time (pom &optional inherit)
- "Get the scheduled time as a time tuple, of a format suitable
- for calling org-schedule with, or if there is no scheduling,
- returns nil."
- (let ((time (org-entry-get pom "SCHEDULED" inherit)))
- (when time
- (org-time-string-to-time time))))
- (defun org-get-deadline-time (pom &optional inherit)
- "Get the deadline as a time tuple, of a format suitable for
- calling org-deadline with, or if there is no scheduling, returns
- nil."
- (let ((time (org-entry-get pom "DEADLINE" inherit)))
- (when time
- (org-time-string-to-time time))))
- (defun org-remove-timestamp-with-keyword (keyword)
- "Remove all time stamps with KEYWORD in the current entry."
- (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
- beg)
- (save-excursion
- (org-back-to-heading t)
- (setq beg (point))
- (outline-next-heading)
- (while (re-search-backward re beg t)
- (replace-match "")
- (if (and (string-match "\\S-" (buffer-substring (line-beginning-position) (point)))
- (equal (char-before) ?\ ))
- (backward-delete-char 1)
- (when (string-match "^[ \t]*$" (buffer-substring
- (line-beginning-position) (line-end-position)))
- (delete-region (line-beginning-position)
- (min (point-max) (1+ (line-end-position))))))))))
- (defvar org-time-was-given) ; dynamically scoped parameter
- (defvar org-end-time-was-given) ; dynamically scoped parameter
- (defun org-at-planning-p ()
- "Non-nil when point is on a planning info line."
- ;; This is as accurate and faster than `org-element-at-point' since
- ;; planning info location is fixed in the section.
- (or (let ((cached (org-element-at-point nil 'cached)))
- (and cached
- (eq 'planning (org-element-type cached))))
- (org-with-wide-buffer
- (beginning-of-line)
- (and (looking-at-p org-planning-line-re)
- (eq (point)
- (ignore-errors
- (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
- (org-back-to-heading t)
- (org-with-limited-levels (org-back-to-heading t)))
- (line-beginning-position 2)))))))
- (defun org-add-planning-info (what &optional time &rest remove)
- "Insert new timestamp with keyword in the planning line.
- WHAT indicates what kind of time stamp to add. It is a symbol
- among `closed', `deadline', `scheduled' and nil. TIME indicates
- the time to use. If none is given, the user is prompted for
- a date. REMOVE indicates what kind of entries to remove. An old
- WHAT entry will also be removed."
- (org-fold-core-ignore-modifications
- (let (org-time-was-given org-end-time-was-given default-time default-input)
- (when (and (memq what '(scheduled deadline))
- (or (not time)
- (and (stringp time)
- (string-match "^[-+]+[0-9]" time))))
- ;; Try to get a default date/time from existing timestamp
- (save-excursion
- (org-back-to-heading t)
- (let ((end (save-excursion (outline-next-heading) (point))) ts)
- (when (re-search-forward (if (eq what 'scheduled)
- org-scheduled-time-regexp
- org-deadline-time-regexp)
- end t)
- (setq ts (match-string 1)
- default-time (org-time-string-to-time ts)
- default-input (and ts (org-get-compact-tod ts)))))))
- (when what
- (setq time
- (if (stringp time)
- ;; This is a string (relative or absolute), set
- ;; proper date.
- (org-encode-time
- (org-read-date-analyze
- time default-time (decode-time default-time)))
- ;; If necessary, get the time from the user
- (or time (org-read-date nil 'to-time nil
- (cl-case what
- (deadline "DEADLINE")
- (scheduled "SCHEDULED")
- (otherwise nil))
- default-time default-input)))))
- (org-with-wide-buffer
- (org-back-to-heading t)
- (let ((planning? (save-excursion
- (forward-line)
- (looking-at-p org-planning-line-re))))
- (cond
- (planning?
- (forward-line)
- ;; Move to current indentation.
- (skip-chars-forward " \t")
- ;; Check if we have to remove something.
- (dolist (type (if what (cons what remove) remove))
- (save-excursion
- (when (re-search-forward
- (cl-case type
- (closed org-closed-time-regexp)
- (deadline org-deadline-time-regexp)
- (scheduled org-scheduled-time-regexp)
- (otherwise (error "Invalid planning type: %s" type)))
- (line-end-position)
- t)
- ;; Delete until next keyword or end of line.
- (delete-region
- (match-beginning 0)
- (if (re-search-forward org-keyword-time-not-clock-regexp
- (line-end-position)
- t)
- (match-beginning 0)
- (line-end-position))))))
- ;; If there is nothing more to add and no more keyword is
- ;; left, remove the line completely.
- (if (and (looking-at-p "[ \t]*$") (not what))
- (delete-region (line-end-position 0)
- (line-end-position))
- ;; If we removed last keyword, do not leave trailing white
- ;; space at the end of line.
- (let ((p (point)))
- (save-excursion
- (end-of-line)
- (unless (= (skip-chars-backward " \t" p) 0)
- (delete-region (point) (line-end-position)))))))
- (what
- (end-of-line)
- (insert-and-inherit "\n")
- (when org-adapt-indentation
- (indent-to-column (1+ (org-outline-level)))))
- (t nil)))
- (when what
- ;; Insert planning keyword.
- (insert-and-inherit (cl-case what
- (closed org-closed-string)
- (deadline org-deadline-string)
- (scheduled org-scheduled-string)
- (otherwise (error "Invalid planning type: %s" what)))
- " ")
- ;; Insert associated timestamp.
- (let ((ts (org-insert-time-stamp
- time
- (or org-time-was-given
- (and (eq what 'closed) org-log-done-with-time))
- (eq what 'closed)
- nil nil (list org-end-time-was-given))))
- (unless (eolp) (insert " "))
- ts))))))
- (defvar org-log-note-marker (make-marker)
- "Marker pointing at the entry where the note is to be inserted.")
- (defvar org-log-note-purpose nil)
- (defvar org-log-note-state nil)
- (defvar org-log-note-previous-state nil)
- (defvar org-log-note-extra nil)
- (defvar org-log-note-window-configuration nil)
- (defvar org-log-note-return-to (make-marker))
- (defvar org-log-note-effective-time nil
- "Remembered current time.
- So that dynamically scoped `org-extend-today-until' affects
- timestamps in state change log.")
- (defvar org-log-note-this-command
- "`this-command' when `org-add-log-setup' is called.")
- (defvar org-log-note-recursion-depth
- "`recursion-depth' when `org-add-log-setup' is called.")
- (defvar org-log-post-message nil
- "Message to be displayed after a log note has been stored.
- The auto-repeater uses this.")
- (defun org-add-note ()
- "Add a note to the current entry.
- This is done in the same way as adding a state change note."
- (interactive)
- (org-add-log-setup 'note))
- (defun org-log-beginning (&optional create)
- "Return expected start of log notes in current entry.
- When optional argument CREATE is non-nil, the function creates
- a drawer to store notes, if necessary. Returned position ignores
- narrowing."
- (org-with-wide-buffer
- (let ((drawer (org-log-into-drawer)))
- (cond
- (drawer
- (org-end-of-meta-data)
- (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
- (end (if (org-at-heading-p) (point)
- (save-excursion (outline-next-heading) (point))))
- (case-fold-search t))
- (catch 'exit
- ;; Try to find existing drawer.
- (while (re-search-forward regexp end t)
- (let ((element (org-element-at-point)))
- (when (eq (org-element-type element) 'drawer)
- (let ((cend (org-element-property :contents-end element)))
- (when (and (not org-log-states-order-reversed) cend)
- (goto-char cend)))
- (throw 'exit nil))))
- ;; No drawer found. Create one, if permitted.
- (when create
- ;; Unless current heading is the last heading in buffer
- ;; and does not have a newline, `org-end-of-meta-data'
- ;; should move us somewhere below the heading.
- ;; Avoid situation when we insert drawer right before
- ;; first "*". Otherwise, if the previous heading is
- ;; folded, we are inserting after visible newline at
- ;; the end of the fold, thus breaking the fold
- ;; continuity.
- (unless (eobp)
- (when (org-at-heading-p) (backward-char)))
- (org-fold-core-ignore-modifications
- (unless (bolp) (insert-and-inherit "\n"))
- (let ((beg (point)))
- (insert-and-inherit ":" drawer ":\n:END:\n")
- (org-indent-region beg (point))
- (org-fold-region (line-end-position -1) (1- (point)) t (if (eq org-fold-core-style 'text-properties) 'drawer 'outline)))))
- (end-of-line -1))))
- (t
- (org-end-of-meta-data org-log-state-notes-insert-after-drawers)
- (let ((endpos (point)))
- (skip-chars-forward " \t\n")
- (beginning-of-line)
- (unless org-log-states-order-reversed
- (org-skip-over-state-notes)
- (skip-chars-backward " \t\n")
- (beginning-of-line 2))
- ;; When current headline is at the end of buffer and does not
- ;; end with trailing newline the above can move to the
- ;; beginning of the headline.
- (when (< (point) endpos) (goto-char endpos))))))
- (if (bolp) (point) (line-beginning-position 2))))
- (defun org-add-log-setup (&optional purpose state prev-state how extra)
- "Set up the post command hook to take a note.
- If this is about to TODO state change, the new state is expected in STATE.
- HOW is an indicator what kind of note should be created.
- EXTRA is additional text that will be inserted into the notes buffer."
- (move-marker org-log-note-marker (point))
- (setq org-log-note-purpose purpose
- org-log-note-state state
- org-log-note-previous-state prev-state
- org-log-note-how how
- org-log-note-extra extra
- org-log-note-effective-time (org-current-effective-time)
- org-log-note-this-command this-command
- org-log-note-recursion-depth (recursion-depth)
- org-log-setup t)
- (add-hook 'post-command-hook 'org-add-log-note 'append))
- (defun org-skip-over-state-notes ()
- "Skip past the list of State notes in an entry."
- (when (ignore-errors (goto-char (org-in-item-p)))
- (let* ((struct (org-list-struct))
- (prevs (org-list-prevs-alist struct))
- (regexp
- (concat "[ \t]*- +"
- (replace-regexp-in-string
- " +" " +"
- (org-replace-escapes
- (regexp-quote (cdr (assq 'state org-log-note-headings)))
- `(("%d" . ,org-ts-regexp-inactive)
- ("%D" . ,org-ts-regexp)
- ("%s" . "\\(?:\"\\S-+\"\\)?")
- ("%S" . "\\(?:\"\\S-+\"\\)?")
- ("%t" . ,org-ts-regexp-inactive)
- ("%T" . ,org-ts-regexp)
- ("%u" . ".*?")
- ("%U" . ".*?")))))))
- (while (looking-at-p regexp)
- (goto-char (or (org-list-get-next-item (point) struct prevs)
- (org-list-get-item-end (point) struct)))))))
- (defun org-add-log-note (&optional _purpose)
- "Pop up a window for taking a note, and add this note later."
- (when (and (equal org-log-note-this-command this-command)
- (= org-log-note-recursion-depth (recursion-depth)))
- (remove-hook 'post-command-hook 'org-add-log-note)
- (setq org-log-setup nil)
- (setq org-log-note-window-configuration (current-window-configuration))
- (delete-other-windows)
- (move-marker org-log-note-return-to (point))
- (pop-to-buffer-same-window (marker-buffer org-log-note-marker))
- (goto-char org-log-note-marker)
- (org-switch-to-buffer-other-window "*Org Note*")
- (erase-buffer)
- (if (memq org-log-note-how '(time state))
- (org-store-log-note)
- (let ((org-inhibit-startup t)) (org-mode))
- (insert (format "# Insert note for %s.
- # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
- (cl-case org-log-note-purpose
- (clock-out "stopped clock")
- (done "closed todo item")
- (reschedule "rescheduling")
- (delschedule "no longer scheduled")
- (redeadline "changing deadline")
- (deldeadline "removing deadline")
- (refile "refiling")
- (note "this entry")
- (state
- (format "state change from \"%s\" to \"%s\""
- (or org-log-note-previous-state "")
- (or org-log-note-state "")))
- (t (error "This should not happen")))))
- (when org-log-note-extra (insert org-log-note-extra))
- (setq-local org-finish-function 'org-store-log-note)
- (run-hooks 'org-log-buffer-setup-hook))))
- (defvar org-note-abort nil) ; dynamically scoped
- (defun org-store-log-note ()
- "Finish taking a log note, and insert it to where it belongs."
- (let ((txt (prog1 (buffer-string)
- (kill-buffer)))
- (note (cdr (assq org-log-note-purpose org-log-note-headings)))
- lines)
- (while (string-match "\\`# .*\n[ \t\n]*" txt)
- (setq txt (replace-match "" t t txt)))
- (when (string-match "\\s-+\\'" txt)
- (setq txt (replace-match "" t t txt)))
- (setq lines (and (not (equal "" txt)) (org-split-string txt "\n")))
- (when (org-string-nw-p note)
- (setq note
- (org-replace-escapes
- note
- (list (cons "%u" (user-login-name))
- (cons "%U" user-full-name)
- (cons "%t" (format-time-string
- (org-time-stamp-format 'long 'inactive)
- org-log-note-effective-time))
- (cons "%T" (format-time-string
- (org-time-stamp-format 'long nil)
- org-log-note-effective-time))
- (cons "%d" (format-time-string
- (org-time-stamp-format nil 'inactive)
- org-log-note-effective-time))
- (cons "%D" (format-time-string
- (org-time-stamp-format nil nil)
- org-log-note-effective-time))
- (cons "%s" (cond
- ((not org-log-note-state) "")
- ((string-match-p org-ts-regexp
- org-log-note-state)
- (format "\"[%s]\""
- (substring org-log-note-state 1 -1)))
- (t (format "\"%s\"" org-log-note-state))))
- (cons "%S"
- (cond
- ((not org-log-note-previous-state) "")
- ((string-match-p org-ts-regexp
- org-log-note-previous-state)
- (format "\"[%s]\""
- (substring
- org-log-note-previous-state 1 -1)))
- (t (format "\"%s\""
- org-log-note-previous-state)))))))
- (when lines (setq note (concat note " \\\\")))
- (push note lines))
- (when (and lines (not org-note-abort))
- (with-current-buffer (marker-buffer org-log-note-marker)
- (org-fold-core-ignore-modifications
- (org-with-wide-buffer
- ;; Find location for the new note.
- (goto-char org-log-note-marker)
- (set-marker org-log-note-marker nil)
- ;; Note associated to a clock is to be located right after
- ;; the clock. Do not move point.
- (unless (eq org-log-note-purpose 'clock-out)
- (goto-char (org-log-beginning t)))
- ;; Make sure point is at the beginning of an empty line.
- (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert-and-inherit "\n")))
- ((looking-at "[ \t]*\\S-") (save-excursion (insert-and-inherit "\n"))))
- ;; In an existing list, add a new item at the top level.
- ;; Otherwise, indent line like a regular one.
- (let ((itemp (org-in-item-p)))
- (if itemp
- (indent-line-to
- (let ((struct (save-excursion
- (goto-char itemp) (org-list-struct))))
- (org-list-get-ind (org-list-get-top-point struct) struct)))
- (org-indent-line)))
- (insert-and-inherit (org-list-bullet-string "-") (pop lines))
- (let ((ind (org-list-item-body-column (line-beginning-position))))
- (dolist (line lines)
- (insert-and-inherit "\n")
- (unless (string-empty-p line)
- (indent-line-to ind)
- (insert-and-inherit line))))
- (message "Note stored")
- (org-back-to-heading t))))))
- ;; Don't add undo information when called from `org-agenda-todo'.
- (set-window-configuration org-log-note-window-configuration)
- (with-current-buffer (marker-buffer org-log-note-return-to)
- (goto-char org-log-note-return-to))
- (move-marker org-log-note-return-to nil)
- (when org-log-post-message (message "%s" org-log-post-message)))
- (defun org-remove-empty-drawer-at (pos)
- "Remove an empty drawer at position POS.
- POS may also be a marker."
- (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
- (org-with-wide-buffer
- (goto-char pos)
- (let ((drawer (org-element-at-point)))
- (when (and (memq (org-element-type drawer) '(drawer property-drawer))
- (not (org-element-property :contents-begin drawer)))
- (delete-region (org-element-property :begin drawer)
- (progn (goto-char (org-element-property :end drawer))
- (skip-chars-backward " \r\t\n")
- (forward-line)
- (point))))))))
- (defvar org-ts-type nil)
- (defun org-sparse-tree (&optional arg type)
- "Create a sparse tree, prompt for the details.
- This command can create sparse trees. You first need to select the type
- of match used to create the tree:
- t Show all TODO entries.
- T Show entries with a specific TODO keyword.
- m Show entries selected by a tags/property match.
- p Enter a property name and its value (both with completion on existing
- names/values) and show entries with that property.
- r Show entries matching a regular expression (`/' can be used as well).
- b Show deadlines and scheduled items before a date.
- a Show deadlines and scheduled items after a date.
- d Show deadlines due within `org-deadline-warning-days'.
- D Show deadlines and scheduled items between a date range."
- (interactive "P")
- (setq type (or type org-sparse-tree-default-date-type))
- (setq org-ts-type type)
- (message "Sparse tree: [r]egexp [t]odo [T]odo-kwd [m]atch [p]roperty
- [d]eadlines [b]efore-date [a]fter-date [D]ates range
- [c]ycle through date types: %s"
- (cl-case type
- (all "all timestamps")
- (scheduled "only scheduled")
- (deadline "only deadline")
- (active "only active timestamps")
- (inactive "only inactive timestamps")
- (closed "with a closed time-stamp")
- (otherwise "scheduled/deadline")))
- (let ((answer (read-char-exclusive)))
- (cl-case answer
- (?c
- (org-sparse-tree
- arg
- (cadr
- (memq type '(nil all scheduled deadline active inactive closed)))))
- (?d (call-interactively 'org-check-deadlines))
- (?b (call-interactively 'org-check-before-date))
- (?a (call-interactively 'org-check-after-date))
- (?D (call-interactively 'org-check-dates-range))
- (?t (call-interactively 'org-show-todo-tree))
- (?T (org-show-todo-tree '(4)))
- (?m (call-interactively 'org-match-sparse-tree))
- ((?p ?P)
- (let* ((kwd (completing-read
- "Property: " (mapcar #'list (org-buffer-property-keys))))
- (value (completing-read
- "Value: " (mapcar #'list (org-property-values kwd)))))
- (unless (string-match "\\`{.*}\\'" value)
- (setq value (concat "\"" value "\"")))
- (org-match-sparse-tree arg (concat kwd "=" value))))
- ((?r ?R ?/) (call-interactively 'org-occur))
- (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
- (defvar-local org-occur-highlights nil
- "List of overlays used for occur matches.")
- (defvar-local org-occur-parameters nil
- "Parameters of the active org-occur calls.
- This is a list, each call to org-occur pushes as cons cell,
- containing the regular expression and the callback, onto the list.
- The list can contain several entries if `org-occur' has been called
- several time with the KEEP-PREVIOUS argument. Otherwise, this list
- will only contain one set of parameters. When the highlights are
- removed (for example with `C-c C-c', or with the next edit (depending
- on `org-remove-highlights-with-change'), this variable is emptied
- as well.")
- (defun org-occur (regexp &optional keep-previous callback)
- "Make a compact tree showing all matches of REGEXP.
- The tree will show the lines where the regexp matches, and any other context
- defined in `org-fold-show-context-detail', which see.
- When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing
- done by a previous call to `org-occur' will be kept, to allow stacking of
- calls to this command.
- Optional argument CALLBACK can be a function of no argument. In this case,
- it is called with point at the end of the match, match data being set
- accordingly. Current match is shown only if the return value is non-nil.
- The function must neither move point nor alter narrowing."
- (interactive "sRegexp: \nP")
- (when (equal regexp "")
- (user-error "Regexp cannot be empty"))
- (unless keep-previous
- (org-remove-occur-highlights nil nil t))
- (push (cons regexp callback) org-occur-parameters)
- (let ((cnt 0))
- (save-excursion
- (goto-char (point-min))
- (when (or (not keep-previous) ; do not want to keep
- (not org-occur-highlights)) ; no previous matches
- ;; hide everything
- (org-cycle-overview))
- (let ((case-fold-search (if (eq org-occur-case-fold-search 'smart)
- (isearch-no-upper-case-p regexp t)
- org-occur-case-fold-search)))
- (while (re-search-forward regexp nil t)
- (when (or (not callback)
- (save-match-data (funcall callback)))
- (setq cnt (1+ cnt))
- (when org-highlight-sparse-tree-matches
- (org-highlight-new-match (match-beginning 0) (match-end 0)))
- (org-fold-show-context 'occur-tree)))))
- (when org-remove-highlights-with-change
- (add-hook 'before-change-functions 'org-remove-occur-highlights
- nil 'local))
- (unless org-sparse-tree-open-archived-trees
- (org-fold-hide-archived-subtrees (point-min) (point-max)))
- (run-hooks 'org-occur-hook)
- (when (called-interactively-p 'interactive)
- (message "%d match(es) for regexp %s" cnt regexp))
- cnt))
- (defun org-occur-next-match (&optional n _reset)
- "Function for `next-error-function' to find sparse tree matches.
- N is the number of matches to move, when negative move backwards.
- This function always goes back to the starting point when no
- match is found."
- (let* ((limit (if (< n 0) (point-min) (point-max)))
- (search-func (if (< n 0)
- 'previous-single-char-property-change
- 'next-single-char-property-change))
- (n (abs n))
- (pos (point))
- p1)
- (catch 'exit
- (while (setq p1 (funcall search-func (point) 'org-type))
- (when (equal p1 limit)
- (goto-char pos)
- (user-error "No more matches"))
- (when (equal (get-char-property p1 'org-type) 'org-occur)
- (setq n (1- n))
- (when (= n 0)
- (goto-char p1)
- (throw 'exit (point))))
- (goto-char p1))
- (goto-char p1)
- (user-error "No more matches"))))
- (defun org-highlight-new-match (beg end)
- "Highlight from BEG to END and mark the highlight is an occur headline."
- (let ((ov (make-overlay beg end)))
- (overlay-put ov 'face 'secondary-selection)
- (overlay-put ov 'org-type 'org-occur)
- (push ov org-occur-highlights)))
- (defun org-remove-occur-highlights (&optional _beg _end noremove)
- "Remove the occur highlights from the buffer.
- BEG and END are ignored. If NOREMOVE is nil, remove this function
- from the `before-change-functions' in the current buffer."
- (interactive)
- (unless org-inhibit-highlight-removal
- (mapc #'delete-overlay org-occur-highlights)
- (setq org-occur-highlights nil)
- (setq org-occur-parameters nil)
- (unless noremove
- (remove-hook 'before-change-functions
- 'org-remove-occur-highlights 'local))))
- ;;;; Priorities
- (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]+\\)\\] ?\\)"
- "Regular expression matching the priority indicator.
- A priority indicator can be e.g. [#A] or [#1].
- This regular expression matches these groups:
- 0 : the whole match, e.g. \"TODO [#A] Hack\"
- 1 : the priority cookie, e.g. \"[#A]\"
- 2 : the value of the priority cookie, e.g. \"A\".")
- (defun org-priority-up ()
- "Increase the priority of the current item."
- (interactive)
- (org-priority 'up))
- (defun org-priority-down ()
- "Decrease the priority of the current item."
- (interactive)
- (org-priority 'down))
- (defun org-priority (&optional action show)
- "Change the priority of an item.
- When called interactively with a `\\[universal-argument]' prefix,
- show the priority in the minibuffer instead of changing it.
- When called programmatically, ACTION can be `set', `up', `down',
- or a character."
- (interactive "P")
- (when show
- ;; Deprecation warning inserted for Org 9.2; once enough time has
- ;; passed the SHOW argument should be removed.
- (warn "`org-priority' called with deprecated SHOW argument"))
- (if (equal action '(4))
- (org-priority-show)
- (unless org-priority-enable-commands
- (user-error "Priority commands are disabled"))
- (setq action (or action 'set))
- (let ((nump (< org-priority-lowest 65))
- current new news have remove)
- (save-excursion
- (org-back-to-heading t)
- (when (looking-at org-priority-regexp)
- (let ((ms (match-string 2)))
- (setq current (org-priority-to-value ms)
- have t)))
- (cond
- ((eq action 'remove)
- (setq remove t new ?\ ))
- ((or (eq action 'set)
- (integerp action))
- (if (not (eq action 'set))
- (setq new action)
- (setq
- new
- (if nump
- (let* ((msg (format "Priority %s-%s, SPC to remove: "
- (number-to-string org-priority-highest)
- (number-to-string org-priority-lowest)))
- (s (if (< 9 org-priority-lowest)
- (read-string msg)
- (message msg)
- (char-to-string (read-char-exclusive)))))
- (if (equal s " ") ?\s (string-to-number s)))
- (progn (message "Priority %c-%c, SPC to remove: "
- org-priority-highest org-priority-lowest)
- (save-match-data
- (setq new (read-char-exclusive)))))))
- (when (and (= (upcase org-priority-highest) org-priority-highest)
- (= (upcase org-priority-lowest) org-priority-lowest))
- (setq new (upcase new)))
- (cond ((equal new ?\s) (setq remove t))
- ((or (< (upcase new) org-priority-highest) (> (upcase new) org-priority-lowest))
- (user-error
- (if nump
- "Priority must be between `%s' and `%s'"
- "Priority must be between `%c' and `%c'")
- org-priority-highest org-priority-lowest))))
- ((eq action 'up)
- (setq new (if have
- (1- current) ; normal cycling
- ;; last priority was empty
- (if (eq last-command this-command)
- org-priority-lowest ; wrap around empty to lowest
- ;; default
- (if org-priority-start-cycle-with-default
- org-priority-default
- (1- org-priority-default))))))
- ((eq action 'down)
- (setq new (if have
- (1+ current) ; normal cycling
- ;; last priority was empty
- (if (eq last-command this-command)
- org-priority-highest ; wrap around empty to highest
- ;; default
- (if org-priority-start-cycle-with-default
- org-priority-default
- (1+ org-priority-default))))))
- (t (user-error "Invalid action")))
- (when (or (< (upcase new) org-priority-highest)
- (> (upcase new) org-priority-lowest))
- (if (and (memq action '(up down))
- (not have) (not (eq last-command this-command)))
- ;; `new' is from default priority
- (error
- "The default can not be set, see `org-priority-default' why")
- ;; normal cycling: `new' is beyond highest/lowest priority
- ;; and is wrapped around to the empty priority
- (setq remove t)))
- ;; Numerical priorities are limited to 64, beyond that number,
- ;; assume the priority cookie is a character.
- (setq news (if (> new 64) (format "%c" new) (format "%s" new)))
- (if have
- (if remove
- (replace-match "" t t nil 1)
- (replace-match news t t nil 2))
- (if remove
- (user-error "No priority cookie found in line")
- (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
- (if (match-end 2)
- (progn
- (goto-char (match-end 2))
- (insert " [#" news "]"))
- (goto-char (match-beginning 3))
- (insert "[#" news "] "))))
- (org-align-tags))
- (if remove
- (message "Priority removed")
- (message "Priority of current item set to %s" news)))))
- (defalias 'org-show-priority 'org-priority-show)
- (defun org-priority-show ()
- "Show the priority of the current item.
- This priority is composed of the main priority given with the [#A] cookies,
- and by additional input from the age of a schedules or deadline entry."
- (interactive)
- (let ((pri (if (eq major-mode 'org-agenda-mode)
- (org-get-at-bol 'priority)
- (save-excursion
- (save-match-data
- (beginning-of-line)
- (and (looking-at org-heading-regexp)
- (org-get-priority (match-string 0))))))))
- (message "Priority is %d" (if pri pri -1000))))
- (defun org-get-priority (s)
- "Find priority cookie and return priority.
- S is a string against which you can match `org-priority-regexp'.
- If `org-priority-get-priority-function' is set to a custom
- function, use it. Otherwise process S and output the priority
- value, an integer."
- (save-match-data
- (if (functionp org-priority-get-priority-function)
- (funcall org-priority-get-priority-function s)
- (if (not (string-match org-priority-regexp s))
- (* 1000 (- org-priority-lowest org-priority-default))
- (* 1000 (- org-priority-lowest
- (org-priority-to-value (match-string 2 s))))))))
- ;;;; Tags
- (defvar org-agenda-archives-mode)
- (defvar org-map-continue-from nil
- "Position from where mapping should continue.
- Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
- (defvar org-scanner-tags nil
- "The current tag list while the tags scanner is running.")
- (defvar org-trust-scanner-tags nil
- "Should `org-get-tags' use the tags for the scanner.
- This is for internal dynamical scoping only.
- When this is non-nil, the function `org-get-tags' will return the value
- of `org-scanner-tags' instead of building the list by itself. This
- can lead to large speed-ups when the tags scanner is used in a file with
- many entries, and when the list of tags is retrieved, for example to
- obtain a list of properties. Building the tags list for each entry in such
- a file becomes an N^2 operation - but with this variable set, it scales
- as N.")
- (defvar org--matcher-tags-todo-only nil)
- (defun org-scan-tags (action matcher todo-only &optional start-level)
- "Scan headline tags with inheritance and produce output ACTION.
- ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
- or `agenda' to produce an entry list for an agenda view. It can also be
- a Lisp form or a function that should be called at each matched headline, in
- this case the return value is a list of all return values from these calls.
- MATCHER is a function accepting three arguments, returning
- a non-nil value whenever a given set of tags qualifies a headline
- for inclusion. See `org-make-tags-matcher' for more information.
- As a special case, it can also be set to t (respectively nil) in
- order to match all (respectively none) headline.
- When TODO-ONLY is non-nil, only lines with a TODO keyword are
- included in the output.
- START-LEVEL can be a string with asterisks, reducing the scope to
- headlines matching this string."
- (require 'org-agenda)
- (let* ((re (concat "^"
- (if start-level
- ;; Get the correct level to match
- (concat "\\*\\{" (number-to-string start-level) "\\} ")
- org-outline-regexp)
- " *\\(?:\\(" (regexp-opt org-todo-keywords-1 t) "\\) \\)?"
- " *\\(.*?\\)\\([ \t]:\\(?:" org-tag-re ":\\)+\\)?[ \t]*$"))
- (props (list 'face 'default
- 'done-face 'org-agenda-done
- 'undone-face 'default
- 'mouse-face 'highlight
- 'org-not-done-regexp org-not-done-regexp
- 'org-todo-regexp org-todo-regexp
- 'org-complex-heading-regexp org-complex-heading-regexp
- 'help-echo
- (format "mouse-2 or RET jump to Org file %S"
- (abbreviate-file-name
- (or (buffer-file-name (buffer-base-buffer))
- (buffer-name (buffer-base-buffer)))))))
- (org-map-continue-from nil)
- lspos tags tags-list
- (tags-alist (list (cons 0 org-file-tags)))
- (llast 0) rtn rtn1 level category i txt
- todo marker entry priority
- ts-date ts-date-type ts-date-pair)
- (unless (or (member action '(agenda sparse-tree)) (functionp action))
- (setq action (list 'lambda nil action)))
- (save-excursion
- (goto-char (point-min))
- (when (eq action 'sparse-tree)
- (org-cycle-overview)
- (org-remove-occur-highlights))
- (if (org-element--cache-active-p)
- (let ((fast-re (concat "^"
- (if start-level
- ;; Get the correct level to match
- (concat "\\*\\{" (number-to-string start-level) "\\} ")
- org-outline-regexp))))
- (org-element-cache-map
- (lambda (el)
- (goto-char (org-element-property :begin el))
- (setq todo (org-element-property :todo-keyword el)
- level (org-element-property :level el)
- category (org-entry-get-with-inheritance "CATEGORY" nil el)
- tags-list (org-get-tags el)
- org-scanner-tags tags-list)
- (when (eq action 'agenda)
- (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
- ts-date (car ts-date-pair)
- ts-date-type (cdr ts-date-pair)))
- (catch :skip
- (when (and
- ;; eval matcher only when the todo condition is OK
- (and (or (not todo-only) (member todo org-todo-keywords-1))
- (if (functionp matcher)
- (let ((case-fold-search t) (org-trust-scanner-tags t))
- (funcall matcher todo tags-list level))
- matcher))
- ;; Call the skipper, but return t if it does not
- ;; skip, so that the `and' form continues evaluating.
- (progn
- (unless (eq action 'sparse-tree) (org-agenda-skip el))
- t)
- ;; Check if timestamps are deselecting this entry
- (or (not todo-only)
- (and (member todo org-todo-keywords-1)
- (or (not org-agenda-tags-todo-honor-ignore-options)
- (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
- ;; select this headline
- (cond
- ((eq action 'sparse-tree)
- (and org-highlight-sparse-tree-matches
- (org-get-heading) (match-end 0)
- (org-highlight-new-match
- (match-beginning 1) (match-end 1)))
- (org-fold-show-context 'tags-tree))
- ((eq action 'agenda)
- (let* ((effort (org-entry-get (point) org-effort-property))
- (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort)))))
- (setq txt (org-agenda-format-item
- ""
- ;; Add `effort' and `effort-minutes'
- ;; properties for prefix format.
- (org-add-props
- (concat
- (if (eq org-tags-match-list-sublevels 'indented)
- (make-string (1- level) ?.) "")
- (org-get-heading))
- nil
- 'effort effort
- 'effort-minutes effort-minutes)
- (make-string level ?\s)
- category
- tags-list)
- priority (org-get-priority txt))
- ;; Now add `effort' and `effort-minutes' to
- ;; full agenda line.
- (setq txt (org-add-props txt nil
- 'effort effort
- 'effort-minutes effort-minutes)))
- (goto-char (org-element-property :begin el))
- (setq marker (org-agenda-new-marker))
- (org-add-props txt props
- 'org-marker marker 'org-hd-marker marker 'org-category category
- 'todo-state todo
- 'ts-date ts-date
- 'priority priority
- 'type (concat "tagsmatch" ts-date-type))
- (push txt rtn))
- ((functionp action)
- (setq org-map-continue-from nil)
- (save-excursion
- (setq rtn1 (funcall action))
- (push rtn1 rtn)))
- (t (user-error "Invalid action")))
- ;; if we are to skip sublevels, jump to end of subtree
- (unless org-tags-match-list-sublevels
- (goto-char (1- (org-element-property :end el))))))
- ;; Get the correct position from where to continue
- (when org-map-continue-from
- (setq org-element-cache-map-continue-from org-map-continue-from)
- (goto-char org-map-continue-from))
- ;; Return nil.
- nil)
- :next-re fast-re
- :fail-re fast-re
- :narrow t))
- (while (let (case-fold-search)
- (re-search-forward re nil t))
- (setq org-map-continue-from nil)
- (catch :skip
- ;; Ignore closing parts of inline tasks.
- (when (and (fboundp 'org-inlinetask-end-p) (org-inlinetask-end-p))
- (throw :skip t))
- (setq todo (and (match-end 1) (match-string-no-properties 1)))
- (setq tags (and (match-end 4) (org-trim (match-string-no-properties 4))))
- (goto-char (setq lspos (match-beginning 0)))
- (setq level (org-reduced-level (org-outline-level))
- category (org-get-category))
- (when (eq action 'agenda)
- (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
- ts-date (car ts-date-pair)
- ts-date-type (cdr ts-date-pair)))
- (setq i llast llast level)
- ;; remove tag lists from same and sublevels
- (while (>= i level)
- (when (setq entry (assoc i tags-alist))
- (setq tags-alist (delete entry tags-alist)))
- (setq i (1- i)))
- ;; add the next tags
- (when tags
- (setq tags (org-split-string tags ":")
- tags-alist
- (cons (cons level tags) tags-alist)))
- ;; compile tags for current headline
- (setq tags-list
- (if org-use-tag-inheritance
- (apply 'append (mapcar 'cdr (reverse tags-alist)))
- tags)
- org-scanner-tags tags-list)
- (when org-use-tag-inheritance
- (setcdr (car tags-alist)
- (mapcar (lambda (x)
- (setq x (copy-sequence x))
- (org-add-prop-inherited x))
- (cdar tags-alist))))
- (when (and tags org-use-tag-inheritance
- (or (not (eq t org-use-tag-inheritance))
- org-tags-exclude-from-inheritance))
- ;; Selective inheritance, remove uninherited ones.
- (setcdr (car tags-alist)
- (org-remove-uninherited-tags (cdar tags-alist))))
- (when (and
- ;; eval matcher only when the todo condition is OK
- (and (or (not todo-only) (member todo org-todo-keywords-1))
- (if (functionp matcher)
- (let ((case-fold-search t) (org-trust-scanner-tags t))
- (funcall matcher todo tags-list level))
- matcher))
- ;; Call the skipper, but return t if it does not
- ;; skip, so that the `and' form continues evaluating.
- (progn
- (unless (eq action 'sparse-tree) (org-agenda-skip))
- t)
- ;; Check if timestamps are deselecting this entry
- (or (not todo-only)
- (and (member todo org-todo-keywords-1)
- (or (not org-agenda-tags-todo-honor-ignore-options)
- (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
- ;; select this headline
- (cond
- ((eq action 'sparse-tree)
- (and org-highlight-sparse-tree-matches
- (org-get-heading) (match-end 0)
- (org-highlight-new-match
- (match-beginning 1) (match-end 1)))
- (org-fold-show-context 'tags-tree))
- ((eq action 'agenda)
- (setq txt (org-agenda-format-item
- ""
- (concat
- (if (eq org-tags-match-list-sublevels 'indented)
- (make-string (1- level) ?.) "")
- (org-get-heading))
- (make-string level ?\s)
- category
- tags-list)
- priority (org-get-priority txt))
- (goto-char lspos)
- (setq marker (org-agenda-new-marker))
- (org-add-props txt props
- 'org-marker marker 'org-hd-marker marker 'org-category category
- 'todo-state todo
- 'ts-date ts-date
- 'priority priority
- 'type (concat "tagsmatch" ts-date-type))
- (push txt rtn))
- ((functionp action)
- (setq org-map-continue-from nil)
- (save-excursion
- (setq rtn1 (funcall action))
- (push rtn1 rtn)))
- (t (user-error "Invalid action")))
- ;; if we are to skip sublevels, jump to end of subtree
- (unless org-tags-match-list-sublevels
- (org-end-of-subtree t)
- (backward-char 1))))
- ;; Get the correct position from where to continue
- (if org-map-continue-from
- (goto-char org-map-continue-from)
- (and (= (point) lspos) (end-of-line 1))))))
- (when (and (eq action 'sparse-tree)
- (not org-sparse-tree-open-archived-trees))
- (org-fold-hide-archived-subtrees (point-min) (point-max)))
- (nreverse rtn)))
- (defun org-remove-uninherited-tags (tags)
- "Remove all tags that are not inherited from the list TAGS."
- (cond
- ((eq org-use-tag-inheritance t)
- (if org-tags-exclude-from-inheritance
- (org-delete-all org-tags-exclude-from-inheritance tags)
- tags))
- ((not org-use-tag-inheritance) nil)
- ((stringp org-use-tag-inheritance)
- (delq nil (mapcar
- (lambda (x)
- (if (and (string-match org-use-tag-inheritance x)
- (not (member x org-tags-exclude-from-inheritance)))
- x nil))
- tags)))
- ((listp org-use-tag-inheritance)
- (delq nil (mapcar
- (lambda (x)
- (if (member x org-use-tag-inheritance) x nil))
- tags)))))
- (defun org-match-sparse-tree (&optional todo-only match)
- "Create a sparse tree according to tags string MATCH.
- MATCH is a string with match syntax. It can contain a selection
- of tags (\"+work+urgent-boss\"), properties (\"LEVEL>3\"), and
- TODO keywords (\"TODO=\\\"WAITING\\\"\") or a combination of
- those. See the manual for details.
- If optional argument TODO-ONLY is non-nil, only select lines that
- are also TODO tasks."
- (interactive "P")
- (org-agenda-prepare-buffers (list (current-buffer)))
- (let ((org--matcher-tags-todo-only todo-only))
- (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match t))
- org--matcher-tags-todo-only)))
- (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
- (defvar org-cached-props nil)
- (defun org-cached-entry-get (pom property)
- (if (or (eq t org-use-property-inheritance)
- (and (stringp org-use-property-inheritance)
- (let ((case-fold-search t))
- (string-match-p org-use-property-inheritance property)))
- (and (listp org-use-property-inheritance)
- (member-ignore-case property org-use-property-inheritance)))
- ;; Caching is not possible, check it directly.
- (org-entry-get pom property 'inherit)
- ;; Get all properties, so we can do complicated checks easily.
- (cdr (assoc-string property
- (or org-cached-props
- (setq org-cached-props (org-entry-properties pom)))
- t))))
- (defun org-global-tags-completion-table (&optional files)
- "Return the list of all tags in all agenda buffer/files.
- Optional FILES argument is a list of files which can be used
- instead of the agenda files."
- (save-excursion
- (org-uniquify
- (delq nil
- (apply #'append
- (mapcar
- (lambda (file)
- (set-buffer (find-file-noselect file))
- (org--tag-add-to-alist
- (org-get-buffer-tags)
- (mapcar (lambda (x)
- (and (stringp (car-safe x))
- (list (car-safe x))))
- org-current-tag-alist)))
- (if (car-safe files) files
- (org-agenda-files))))))))
- (defun org-make-tags-matcher (match &optional only-local-tags)
- "Create the TAGS/TODO matcher form for the selection string MATCH.
- Returns a cons of the selection string MATCH and a function
- implementing the matcher.
- The matcher is to be called at an Org entry, with point on the
- headline, and returns non-nil if the entry matches the selection
- string MATCH. It must be called with three arguments: the TODO
- keyword at the entry (or nil if none), the list of all tags at
- the entry including inherited ones and the reduced level of the
- headline. Additionally, the category of the entry, if any, must
- be specified as the text property `org-category' on the headline.
- This function sets the variable `org--matcher-tags-todo-only' to
- a non-nil value if the matcher restricts matching to TODO
- entries, otherwise it is not touched.
- When ONLY-LOCAL-TAGS is non-nil, ignore the global tag completion
- table, only get buffer tags.
- See also `org-scan-tags'."
- (unless match
- ;; Get a new match request, with completion against the global
- ;; tags table and the local tags in current buffer.
- (let ((org-last-tags-completion-table
- (org--tag-add-to-alist
- (org-get-buffer-tags)
- (unless only-local-tags
- (org-global-tags-completion-table)))))
- (setq match
- (completing-read
- "Match: "
- 'org-tags-completion-function nil nil nil 'org-tags-history))))
- (let ((match0 match)
- (re (concat
- "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)"
- "\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)"
- "\\([<>=]\\{1,2\\}\\)"
- "\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)"
- "\\|" org-tag-re "\\)"))
- (start 0)
- tagsmatch todomatch tagsmatcher todomatcher)
- ;; Expand group tags.
- (setq match (org-tags-expand match))
- ;; Check if there is a TODO part of this match, which would be the
- ;; part after a "/". To make sure that this slash is not part of
- ;; a property value to be matched against, we also check that
- ;; there is no / after that slash. First, find the last slash.
- (let ((s 0))
- (while (string-match "/+" match s)
- (setq start (match-beginning 0))
- (setq s (match-end 0))))
- (if (and (string-match "/+" match start)
- (not (string-match-p "\"" match start)))
- ;; Match contains also a TODO-matching request.
- (progn
- (setq tagsmatch (substring match 0 (match-beginning 0)))
- (setq todomatch (substring match (match-end 0)))
- (when (string-prefix-p "!" todomatch)
- (setq org--matcher-tags-todo-only t)
- (setq todomatch (substring todomatch 1)))
- (when (string-match "\\`\\s-*\\'" todomatch)
- (setq todomatch nil)))
- ;; Only matching tags.
- (setq tagsmatch match)
- (setq todomatch nil))
- ;; Make the tags matcher.
- (when (org-string-nw-p tagsmatch)
- (let ((orlist nil)
- (orterms (org-split-string tagsmatch "|"))
- term)
- (while (setq term (pop orterms))
- (while (and (equal (substring term -1) "\\") orterms)
- (setq term (concat term "|" (pop orterms)))) ;repair bad split.
- (while (string-match re term)
- (let* ((rest (substring term (match-end 0)))
- (minus (and (match-end 1)
- (equal (match-string 1 term) "-")))
- (tag (save-match-data
- (replace-regexp-in-string
- "\\\\-" "-" (match-string 2 term))))
- (regexp (eq (string-to-char tag) ?{))
- (levelp (match-end 4))
- (propp (match-end 5))
- (mm
- (cond
- (regexp `(org-match-any-p ,(substring tag 1 -1) tags-list))
- (levelp
- `(,(org-op-to-function (match-string 3 term))
- level
- ,(string-to-number (match-string 4 term))))
- (propp
- (let* ((gv (pcase (upcase (match-string 5 term))
- ("CATEGORY"
- '(org-get-category (point)))
- ("TODO" 'todo)
- (p `(org-cached-entry-get nil ,p))))
- (pv (match-string 7 term))
- (regexp (eq (string-to-char pv) ?{))
- (strp (eq (string-to-char pv) ?\"))
- (timep (string-match-p "^\"[[<].*[]>]\"$" pv))
- (po (org-op-to-function (match-string 6 term)
- (if timep 'time strp))))
- (setq pv (if (or regexp strp) (substring pv 1 -1) pv))
- (when timep (setq pv (org-matcher-time pv)))
- (cond ((and regexp (eq po '/=))
- `(not (string-match ,pv (or ,gv ""))))
- (regexp `(string-match ,pv (or ,gv "")))
- (strp `(,po (or ,gv "") ,pv))
- (t
- `(,po
- (string-to-number (or ,gv ""))
- ,(string-to-number pv))))))
- (t `(member ,tag tags-list)))))
- (push (if minus `(not ,mm) mm) tagsmatcher)
- (setq term rest)))
- (push `(and ,@tagsmatcher) orlist)
- (setq tagsmatcher nil))
- (setq tagsmatcher `(progn (setq org-cached-props nil) (or ,@orlist)))))
- ;; Make the TODO matcher.
- (when (org-string-nw-p todomatch)
- (let ((orlist nil))
- (dolist (term (org-split-string todomatch "|"))
- (while (string-match re term)
- (let* ((minus (and (match-end 1)
- (equal (match-string 1 term) "-")))
- (kwd (match-string 2 term))
- (regexp (eq (string-to-char kwd) ?{))
- (mm (if regexp `(string-match ,(substring kwd 1 -1) todo)
- `(equal todo ,kwd))))
- (push (if minus `(not ,mm) mm) todomatcher))
- (setq term (substring term (match-end 0))))
- (push (if (> (length todomatcher) 1)
- (cons 'and todomatcher)
- (car todomatcher))
- orlist)
- (setq todomatcher nil))
- (setq todomatcher (cons 'or orlist))))
- ;; Return the string and function of the matcher. If no
- ;; tags-specific or todo-specific matcher exists, match
- ;; everything.
- (let ((matcher (if (and tagsmatcher todomatcher)
- `(and ,tagsmatcher ,todomatcher)
- (or tagsmatcher todomatcher t))))
- (when org--matcher-tags-todo-only
- (setq matcher `(and (member todo org-not-done-keywords) ,matcher)))
- (cons match0 `(lambda (todo tags-list level) ,matcher)))))
- (defun org--tags-expand-group (group tag-groups expanded)
- "Recursively expand all tags in GROUP, according to TAG-GROUPS.
- TAG-GROUPS is the list of groups used for expansion. EXPANDED is
- an accumulator used in recursive calls."
- (dolist (tag group)
- (unless (member tag expanded)
- (let ((group (assoc tag tag-groups)))
- (push tag expanded)
- (when group
- (setq expanded
- (org--tags-expand-group (cdr group) tag-groups expanded))))))
- expanded)
- (defun org-tags-expand (match &optional single-as-list)
- "Expand group tags in MATCH.
- This replaces every group tag in MATCH with a regexp tag search.
- For example, a group tag \"Work\" defined as { Work : Lab Conf }
- will be replaced like this:
- Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
- +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
- -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
- Replacing by a regexp preserves the structure of the match.
- E.g., this expansion
- Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
- will match anything tagged with \"Lab\" and \"Home\", or tagged
- with \"Conf\" and \"Home\" or tagged with \"Work\" and \"Home\".
- A group tag in MATCH can contain regular expressions of its own.
- For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
- will be replaced like this:
- Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
- When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
- assumed to be a single group tag, and the function will return
- the list of tags in this group."
- (unless (org-string-nw-p match) (error "Invalid match tag: %S" match))
- (let ((tag-groups
- (or org-tag-groups-alist-for-agenda org-tag-groups-alist)))
- (cond
- (single-as-list (org--tags-expand-group (list match) tag-groups nil))
- (org-group-tags
- (let* ((case-fold-search t)
- (tag-syntax org-mode-syntax-table)
- (group-keys (mapcar #'car tag-groups))
- (key-regexp (concat "\\([+-]?\\)" (regexp-opt group-keys 'words)))
- (return-match match))
- ;; Mark regexp-expressions in the match-expression so that we
- ;; do not replace them later on.
- (let ((s 0))
- (while (string-match "{.+?}" return-match s)
- (setq s (match-end 0))
- (add-text-properties
- (match-beginning 0) (match-end 0) '(regexp t) return-match)))
- ;; @ and _ are allowed as word-components in tags.
- (modify-syntax-entry ?@ "w" tag-syntax)
- (modify-syntax-entry ?_ "w" tag-syntax)
- ;; For each tag token found in MATCH, compute a regexp and it
- (with-syntax-table tag-syntax
- (replace-regexp-in-string
- key-regexp
- (lambda (m)
- (if (get-text-property (match-beginning 2) 'regexp m)
- m ;regexp tag: ignore
- (let* ((operator (match-string 1 m))
- (tag-token (let ((tag (match-string 2 m)))
- (list tag)))
- regexp-tags regular-tags)
- ;; Partition tags between regexp and regular tags.
- ;; Remove curly bracket syntax from regexp tags.
- (dolist (tag (org--tags-expand-group tag-token tag-groups nil))
- (save-match-data
- (if (string-match "{\\(.+?\\)}" tag)
- (push (match-string 1 tag) regexp-tags)
- (push tag regular-tags))))
- ;; Replace tag token by the appropriate regexp.
- ;; Regular tags need to be regexp-quoted, whereas
- ;; regexp-tags are inserted as-is.
- (let ((regular (regexp-opt regular-tags))
- (regexp (mapconcat #'identity regexp-tags "\\|")))
- (concat operator
- (cond
- ((null regular-tags) (format "{%s}" regexp))
- ((null regexp-tags) (format "{\\<%s\\>}" regular))
- (t (format "{\\<%s\\>\\|%s}" regular regexp))))))))
- return-match
- t t))))
- (t match))))
- (defun org-op-to-function (op &optional stringp)
- "Turn an operator into the appropriate function."
- (setq op
- (cond
- ((equal op "<" ) '(< org-string< org-time<))
- ((equal op ">" ) '(> org-string> org-time>))
- ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
- ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
- ((member op '("=" "==")) '(= string= org-time=))
- ((member op '("<>" "!=")) '(/= org-string<> org-time<>))))
- (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
- (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
- (defvar org-tags-overlay (make-overlay 1 1))
- (delete-overlay org-tags-overlay)
- (defun org-add-prop-inherited (s)
- (add-text-properties 0 (length s) '(inherited t) s)
- s)
- (defun org-toggle-tag (tag &optional onoff)
- "Toggle the tag TAG for the current line.
- If ONOFF is `on' or `off', don't toggle but set to this state."
- (save-excursion
- (org-back-to-heading t)
- (let ((current
- ;; Reverse the tags list so any new tag is appended to the
- ;; current list of tags.
- (nreverse (org-get-tags nil t)))
- res)
- (pcase onoff
- (`off (setq current (delete tag current)))
- ((or `on (guard (not (member tag current))))
- (setq res t)
- (cl-pushnew tag current :test #'equal))
- (_ (setq current (delete tag current))))
- (org-set-tags (nreverse current))
- res)))
- (defun org--align-tags-here (to-col)
- "Align tags on the current headline to TO-COL.
- Assume point is on a headline. Preserve point when aligning
- tags."
- (when (org-match-line org-tag-line-re)
- (let* ((tags-start (match-beginning 1))
- (blank-start (save-excursion
- (goto-char tags-start)
- (skip-chars-backward " \t")
- (point)))
- (new (max (if (>= to-col 0) to-col
- (- (abs to-col) (string-width (match-string 1))))
- ;; Introduce at least one space after the heading
- ;; or the stars.
- (save-excursion
- (goto-char blank-start)
- (1+ (current-column)))))
- (current
- (save-excursion (goto-char tags-start) (current-column)))
- (origin (point-marker))
- (column (current-column))
- (in-blank? (and (> origin blank-start) (<= origin tags-start))))
- (when (/= new current)
- (delete-region blank-start tags-start)
- (goto-char blank-start)
- (let ((indent-tabs-mode nil)) (indent-to new))
- ;; Try to move back to original position. If point was in the
- ;; blanks before the tags, ORIGIN marker is of no use because
- ;; it now points to BLANK-START. Use COLUMN instead.
- (if in-blank? (org-move-to-column column) (goto-char origin))))))
- (defun org-set-tags-command (&optional arg)
- "Set the tags for the current visible entry.
- When called with `\\[universal-argument]' prefix argument ARG, \
- realign all tags
- in the current buffer.
- When called with `\\[universal-argument] \\[universal-argument]' prefix argument, \
- unconditionally do not
- offer the fast tag selection interface.
- If a region is active, set tags in the region according to the
- setting of `org-loop-over-headlines-in-active-region'.
- This function is for interactive use only;
- in Lisp code use `org-set-tags' instead."
- (interactive "P")
- (let ((org-use-fast-tag-selection
- (unless (equal '(16) arg) org-use-fast-tag-selection)))
- (cond
- ((equal '(4) arg) (org-align-tags t))
- ((and (org-region-active-p) org-loop-over-headlines-in-active-region)
- (let (org-loop-over-headlines-in-active-region) ; hint: infinite recursion.
- (org-map-entries
- #'org-set-tags-command
- nil
- (if (eq org-loop-over-headlines-in-active-region 'start-level)
- 'region-start-level
- 'region)
- (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))))
- (t
- (save-excursion
- (org-back-to-heading)
- (let* ((all-tags (org-get-tags))
- (local-table (or org-current-tag-alist (org-get-buffer-tags)))
- (table (setq org-last-tags-completion-table
- (append
- ;; Put local tags in front.
- local-table
- (cl-set-difference
- (org--tag-add-to-alist
- (and org-complete-tags-always-offer-all-agenda-tags
- (org-global-tags-completion-table
- (org-agenda-files)))
- local-table)
- local-table))))
- (current-tags
- (cl-remove-if (lambda (tag) (get-text-property 0 'inherited tag))
- all-tags))
- (inherited-tags
- (cl-remove-if-not (lambda (tag) (get-text-property 0 'inherited tag))
- all-tags))
- (tags
- (replace-regexp-in-string
- ;; Ignore all forbidden characters in tags.
- "[^[:alnum:]_@#%]+" ":"
- (if (or (eq t org-use-fast-tag-selection)
- (and org-use-fast-tag-selection
- (delq nil (mapcar #'cdr table))))
- (org-fast-tag-selection
- current-tags
- inherited-tags
- table
- (and org-fast-tag-selection-include-todo org-todo-key-alist))
- (let ((org-add-colon-after-tag-completion (< 1 (length table)))
- (crm-separator "[ \t]*:[ \t]*"))
- (mapconcat #'identity
- (completing-read-multiple
- "Tags: "
- org-last-tags-completion-table
- nil nil (org-make-tag-string current-tags)
- 'org-tags-history)
- ":"))))))
- (org-set-tags tags)))))
- ;; `save-excursion' may not replace the point at the right
- ;; position.
- (when (and (save-excursion (skip-chars-backward "*") (bolp))
- (looking-at-p " "))
- (forward-char))))
- (defun org-align-tags (&optional all)
- "Align tags in current entry.
- When optional argument ALL is non-nil, align all tags in the
- visible part of the buffer."
- (let ((get-indent-column
- (lambda ()
- (let ((offset (if (bound-and-true-p org-indent-mode)
- (save-excursion
- (org-back-to-heading-or-point-min)
- (length
- (get-text-property
- (line-end-position)
- 'line-prefix)))
- 0)))
- (+ org-tags-column
- (if (> org-tags-column 0) (- offset) offset))))))
- (if (and (not all) (org-at-heading-p))
- (org--align-tags-here (funcall get-indent-column))
- (save-excursion
- (if all
- (progn
- (goto-char (point-min))
- (while (re-search-forward org-tag-line-re nil t)
- (org--align-tags-here (funcall get-indent-column))))
- (org-back-to-heading t)
- (org--align-tags-here (funcall get-indent-column)))))))
- (defun org-set-tags (tags)
- "Set the tags of the current entry to TAGS, replacing current tags.
- TAGS may be a tags string like \":aa:bb:cc:\", or a list of tags.
- If TAGS is nil or the empty string, all tags are removed.
- This function assumes point is on a headline."
- (org-with-wide-buffer
- (org-fold-core-ignore-modifications
- (let ((tags (pcase tags
- ((pred listp) tags)
- ((pred stringp) (split-string (org-trim tags) ":" t))
- (_ (error "Invalid tag specification: %S" tags))))
- (old-tags (org-get-tags nil t))
- (tags-change? nil))
- (when (functionp org-tags-sort-function)
- (setq tags (sort tags org-tags-sort-function)))
- (setq tags-change? (not (equal tags old-tags)))
- (when tags-change?
- ;; Delete previous tags and any trailing white space.
- (goto-char (if (org-match-line org-tag-line-re) (match-beginning 1)
- (line-end-position)))
- (skip-chars-backward " \t")
- (delete-region (point) (line-end-position))
- ;; Deleting white spaces may break an otherwise empty headline.
- ;; Re-introduce one space in this case.
- (unless (org-at-heading-p) (insert " "))
- (when tags
- (save-excursion (insert-and-inherit " " (org-make-tag-string tags)))
- ;; When text is being inserted on an invisible region
- ;; boundary, it can be inadvertently sucked into
- ;; invisibility.
- (unless (org-invisible-p (line-beginning-position))
- (org-fold-region (point) (line-end-position) nil 'outline))))
- ;; Align tags, if any.
- (when tags (org-align-tags))
- (when tags-change? (run-hooks 'org-after-tags-change-hook))))))
- (defun org-change-tag-in-region (beg end tag off)
- "Add or remove TAG for each entry in the region.
- This works in the agenda, and also in an Org buffer."
- (interactive
- (list (region-beginning) (region-end)
- (let ((org-last-tags-completion-table
- (if (derived-mode-p 'org-mode)
- (org--tag-add-to-alist
- (org-get-buffer-tags)
- (org-global-tags-completion-table))
- (org-global-tags-completion-table))))
- (completing-read
- "Tag: " org-last-tags-completion-table nil nil nil
- 'org-tags-history))
- (progn
- (message "[s]et or [r]emove? ")
- (equal (read-char-exclusive) ?r))))
- (deactivate-mark)
- (let ((agendap (equal major-mode 'org-agenda-mode))
- l1 l2 m buf pos newhead (cnt 0))
- (goto-char end)
- (setq l2 (1- (org-current-line)))
- (goto-char beg)
- (setq l1 (org-current-line))
- (cl-loop for l from l1 to l2 do
- (org-goto-line l)
- (setq m (get-text-property (point) 'org-hd-marker))
- (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
- (and agendap m))
- (setq buf (if agendap (marker-buffer m) (current-buffer))
- pos (if agendap m (point)))
- (with-current-buffer buf
- (save-excursion
- (save-restriction
- (goto-char pos)
- (setq cnt (1+ cnt))
- (org-toggle-tag tag (if off 'off 'on))
- (setq newhead (org-get-heading)))))
- (and agendap (org-agenda-change-all-lines newhead m))))
- (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
- (defun org-tags-completion-function (string _predicate &optional flag)
- "Complete tag STRING.
- FLAG specifies the type of completion operation to perform. This
- function is passed as a collection function to `completing-read',
- which see."
- (let ((completion-ignore-case nil) ;tags are case-sensitive
- (confirm (lambda (x) (stringp (car x))))
- (prefix ""))
- (when (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
- (setq prefix (match-string 1 string))
- (setq string (match-string 2 string)))
- (pcase flag
- (`t (all-completions string org-last-tags-completion-table confirm))
- (`lambda (assoc string org-last-tags-completion-table)) ;exact match?
- (`nil
- (pcase (try-completion string org-last-tags-completion-table confirm)
- ((and completion (pred stringp))
- (concat prefix
- completion
- (if (and org-add-colon-after-tag-completion
- (assoc completion org-last-tags-completion-table))
- ":"
- "")))
- (completion completion)))
- (_ nil))))
- (defun org-fast-tag-insert (kwd tags face &optional end)
- "Insert KWD, and the TAGS, the latter with face FACE.
- Also insert END."
- (insert (format "%-12s" (concat kwd ":"))
- (org-add-props (mapconcat 'identity tags " ") nil 'face face)
- (or end "")))
- (defun org-fast-tag-show-exit (flag)
- (save-excursion
- (org-goto-line 3)
- (when (re-search-forward "[ \t]+Next change exits" (line-end-position) t)
- (replace-match ""))
- (when flag
- (end-of-line 1)
- (org-move-to-column (- (window-width) 19) t)
- (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
- (defun org-set-current-tags-overlay (current prefix)
- "Add an overlay to CURRENT tag with PREFIX."
- (let ((s (org-make-tag-string current)))
- (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
- (org-overlay-display org-tags-overlay (concat prefix s))))
- (defvar org-last-tag-selection-key nil)
- (defun org-fast-tag-selection (current inherited table &optional todo-table)
- "Fast tag selection with single keys.
- CURRENT is the current list of tags in the headline, INHERITED is the
- list of inherited tags, and TABLE is an alist of tags and corresponding keys,
- possibly with grouping information. TODO-TABLE is a similar table with
- TODO keywords, should these have keys assigned to them.
- If the keys are nil, a-z are automatically assigned.
- Returns the new tags string, or nil to not change the current settings."
- (let* ((fulltable (append table todo-table))
- (maxlen (if (null fulltable) 0
- (apply #'max
- (mapcar (lambda (x)
- (if (stringp (car x)) (string-width (car x))
- 0))
- fulltable))))
- (buf (current-buffer))
- (expert (eq org-fast-tag-selection-single-key 'expert))
- (tab-tags nil)
- (fwidth (+ maxlen 3 1 3))
- (ncol (/ (- (window-width) 4) fwidth))
- (i-face 'org-done)
- (c-face 'org-todo)
- tg cnt e c char c1 c2 ntable tbl rtn
- ov-start ov-end ov-prefix
- (exit-after-next org-fast-tag-selection-single-key)
- (done-keywords org-done-keywords)
- groups ingroup intaggroup)
- (save-excursion
- (beginning-of-line)
- (if (looking-at org-tag-line-re)
- (setq ov-start (match-beginning 1)
- ov-end (match-end 1)
- ov-prefix "")
- (setq ov-start (1- (line-end-position))
- ov-end (1+ ov-start))
- (skip-chars-forward "^\n\r")
- (setq ov-prefix
- (concat
- (buffer-substring (1- (point)) (point))
- (if (> (current-column) org-tags-column)
- " "
- (make-string (- org-tags-column (current-column)) ?\ ))))))
- (move-overlay org-tags-overlay ov-start ov-end)
- (save-excursion
- (save-window-excursion
- (if expert
- (set-buffer (get-buffer-create " *Org tags*"))
- (delete-other-windows)
- (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
- (org-switch-to-buffer-other-window " *Org tags*"))
- (erase-buffer)
- (setq-local org-done-keywords done-keywords)
- (org-fast-tag-insert "Inherited" inherited i-face "\n")
- (org-fast-tag-insert "Current" current c-face "\n\n")
- (org-fast-tag-show-exit exit-after-next)
- (org-set-current-tags-overlay current ov-prefix)
- (setq tbl fulltable char ?a cnt 0)
- (while (setq e (pop tbl))
- (cond
- ((eq (car e) :startgroup)
- (push '() groups) (setq ingroup t)
- (unless (zerop cnt)
- (setq cnt 0)
- (insert "\n"))
- (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
- ((eq (car e) :endgroup)
- (setq ingroup nil cnt 0)
- (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
- ((eq (car e) :startgrouptag)
- (setq intaggroup t)
- (unless (zerop cnt)
- (setq cnt 0)
- (insert "\n"))
- (insert "[ "))
- ((eq (car e) :endgrouptag)
- (setq intaggroup nil cnt 0)
- (insert "]\n"))
- ((equal e '(:newline))
- (unless (zerop cnt)
- (setq cnt 0)
- (insert "\n")
- (setq e (car tbl))
- (while (equal (car tbl) '(:newline))
- (insert "\n")
- (setq tbl (cdr tbl)))))
- ((equal e '(:grouptags))
- (delete-char -3)
- (insert " : "))
- (t
- (setq tg (copy-sequence (car e)) c2 nil)
- (if (cdr e)
- (setq c (cdr e))
- ;; automatically assign a character.
- (setq c1 (string-to-char
- (downcase (substring
- tg (if (= (string-to-char tg) ?@) 1 0)))))
- (if (or (rassoc c1 ntable) (rassoc c1 table))
- (while (or (rassoc char ntable) (rassoc char table))
- (setq char (1+ char)))
- (setq c2 c1))
- (setq c (or c2
- (if (> char ?~)
- ?\s
- char)))
- ;; Consider characters A-Z after a-z.
- (if (equal char ?z)
- (setq char ?A)))
- (when ingroup (push tg (car groups)))
- (setq tg (org-add-props tg nil 'face
- (cond
- ((not (assoc tg table))
- (org-get-todo-face tg))
- ((member tg current) c-face)
- ((member tg inherited) i-face))))
- (when (equal (caar tbl) :grouptags)
- (org-add-props tg nil 'face 'org-tag-group))
- (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
- (insert "[" c "] " tg (make-string
- (- fwidth 4 (length tg)) ?\ ))
- (push (cons tg c) ntable)
- (when (= (cl-incf cnt) ncol)
- (unless (memq (caar tbl) '(:endgroup :endgrouptag))
- (insert "\n")
- (when (or ingroup intaggroup) (insert " ")))
- (setq cnt 0)))))
- (setq ntable (nreverse ntable))
- (insert "\n")
- (goto-char (point-min))
- (unless expert (org-fit-window-to-buffer))
- (setq rtn
- (catch 'exit
- (while t
- (message "[a-z..]:toggle [SPC]:clear [RET]:accept [TAB]:edit [!] %sgroups%s"
- (if (not groups) "no " "")
- (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
- (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
- (setq org-last-tag-selection-key c)
- (cond
- ((= c ?\r) (throw 'exit t))
- ((= c ?!)
- (setq groups (not groups))
- (goto-char (point-min))
- (while (re-search-forward "[{}]" nil t) (replace-match " ")))
- ((= c ?\C-c)
- (if (not expert)
- (org-fast-tag-show-exit
- (setq exit-after-next (not exit-after-next)))
- (setq expert nil)
- (delete-other-windows)
- (set-window-buffer (split-window-vertically) " *Org tags*")
- (org-switch-to-buffer-other-window " *Org tags*")
- (org-fit-window-to-buffer)))
- ((or (= c ?\C-g)
- (and (= c ?q) (not (rassoc c ntable))))
- (delete-overlay org-tags-overlay)
- (setq quit-flag t))
- ((= c ?\ )
- (setq current nil)
- (when exit-after-next (setq exit-after-next 'now)))
- ((= c ?\t)
- (condition-case nil
- (unless tab-tags
- (setq tab-tags
- (delq nil
- (mapcar (lambda (x)
- (let ((item (car-safe x)))
- (and (stringp item)
- (list item))))
- (org--tag-add-to-alist
- (with-current-buffer buf
- (org-get-buffer-tags))
- table))))))
- (setq tg (completing-read "Tag: " tab-tags))
- (when (string-match "\\S-" tg)
- (cl-pushnew (list tg) tab-tags :test #'equal)
- (if (member tg current)
- (setq current (delete tg current))
- (push tg current)))
- (when exit-after-next (setq exit-after-next 'now)))
- ((setq e (rassoc c todo-table) tg (car e))
- (with-current-buffer buf
- (save-excursion (org-todo tg)))
- (when exit-after-next (setq exit-after-next 'now)))
- ((setq e (rassoc c ntable) tg (car e))
- (if (member tg current)
- (setq current (delete tg current))
- (cl-loop for g in groups do
- (when (member tg g)
- (dolist (x g) (setq current (delete x current)))))
- (push tg current))
- (when exit-after-next (setq exit-after-next 'now))))
- ;; Create a sorted list
- (setq current
- (sort current
- (lambda (a b)
- (assoc b (cdr (memq (assoc a ntable) ntable))))))
- (when (eq exit-after-next 'now) (throw 'exit t))
- (goto-char (point-min))
- (beginning-of-line 2)
- (delete-region (point) (line-end-position))
- (org-fast-tag-insert "Current" current c-face)
- (org-set-current-tags-overlay current ov-prefix)
- (let ((tag-re (concat "\\[.\\] \\(" org-tag-re "\\)")))
- (while (re-search-forward tag-re nil t)
- (let ((tag (match-string 1)))
- (add-text-properties
- (match-beginning 1) (match-end 1)
- (list 'face
- (cond
- ((member tag current) c-face)
- ((member tag inherited) i-face)
- (t 'default)))))))
- (goto-char (point-min)))))
- (delete-overlay org-tags-overlay)
- (if rtn
- (mapconcat 'identity current ":")
- nil)))))
- (defun org-make-tag-string (tags)
- "Return string associated to TAGS.
- TAGS is a list of strings."
- (if (null tags) ""
- (format ":%s:" (mapconcat #'identity tags ":"))))
- (defun org--get-local-tags ()
- "Return list of tags for the current headline.
- Assume point is at the beginning of the headline."
- (let* ((cached (and (org-element--cache-active-p) (org-element-at-point nil 'cached)))
- (cached-tags (org-element-property :tags cached)))
- (if cached
- ;; If we do not explicitly copy the result, reference would
- ;; be returned and cache element might be modified directly.
- (mapcar #'copy-sequence cached-tags)
- ;; Parse tags manually.
- (and (looking-at org-tag-line-re)
- (split-string (match-string-no-properties 2) ":" t)))))
- (defun org-get-tags (&optional pos-or-element local)
- "Get the list of tags specified in the current headline.
- When argument POS-OR-ELEMENT is non-nil, retrieve tags for headline at
- POS.
- According to `org-use-tag-inheritance', tags may be inherited
- from parent headlines, and from the whole document, through
- `org-file-tags'. In this case, the returned list of tags
- contains tags in this order: file tags, tags inherited from
- parent headlines, local tags. If a tag appears multiple times,
- only the most local tag is returned.
- However, when optional argument LOCAL is non-nil, only return
- tags specified at the headline.
- Inherited tags have the `inherited' text property."
- (save-match-data
- (if (and org-trust-scanner-tags
- (or (not pos-or-element) (eq pos-or-element (point)))
- (not local))
- org-scanner-tags
- (org-with-point-at (unless (org-element-type pos-or-element)
- (or pos-or-element (point)))
- (unless (or (org-element-type pos-or-element)
- (org-before-first-heading-p))
- (org-back-to-heading t))
- (let ((ltags (if (org-element-type pos-or-element)
- (org-element-property :tags (org-element-lineage pos-or-element '(headline inlinetask) t))
- (org--get-local-tags)))
- itags)
- (if (or local (not org-use-tag-inheritance)) ltags
- (let ((cached (and (org-element--cache-active-p)
- (if (org-element-type pos-or-element)
- (org-element-lineage pos-or-element '(headline org-data inlinetask) t)
- (org-element-at-point nil 'cached)))))
- (if cached
- (while (setq cached (org-element-property :parent cached))
- (setq itags (nconc (mapcar #'org-add-prop-inherited
- ;; If we do explicitly copy the result, reference would
- ;; be returned and cache element might be modified directly.
- (mapcar #'copy-sequence (org-element-property :tags cached)))
- itags)))
- (while (org-up-heading-safe)
- (setq itags (nconc (mapcar #'org-add-prop-inherited
- (org--get-local-tags))
- itags)))))
- (setq itags (append org-file-tags itags))
- (nreverse
- (delete-dups
- (nreverse (nconc (org-remove-uninherited-tags itags) ltags))))))))))
- (defun org-get-buffer-tags ()
- "Get a table of all tags used in the buffer, for completion."
- (if (org-element--cache-active-p)
- ;; `org-element-cache-map' is about 2x faster compared to regexp
- ;; search.
- (let ((hashed (make-hash-table :test #'equal)))
- (org-element-cache-map
- (lambda (el)
- (dolist (tag (org-element-property :tags el))
- ;; Do not carry over the text properties. They may look
- ;; ugly in the completion.
- (puthash (list (substring-no-properties tag)) t hashed))))
- (dolist (tag org-file-tags) (puthash (list tag) t hashed))
- (hash-table-keys hashed))
- (org-with-point-at 1
- (let (tags)
- (while (re-search-forward org-tag-line-re nil t)
- (setq tags (nconc (split-string (match-string-no-properties 2) ":")
- tags)))
- (mapcar #'list (delete-dups (append org-file-tags tags)))))))
- ;;;; The mapping API
- (defvar org-agenda-skip-comment-trees)
- (defvar org-agenda-skip-function)
- (defun org-map-entries (func &optional match scope &rest skip)
- "Call FUNC at each headline selected by MATCH in SCOPE.
- FUNC is a function or a Lisp form. The function will be called without
- arguments, with the cursor positioned at the beginning of the headline.
- The return values of all calls to the function will be collected and
- returned as a list.
- The call to FUNC will be wrapped into a `save-excursion' form, so FUNC
- does not need to preserve point. After evaluation, the cursor will be
- moved to the end of the line (presumably of the headline of the
- processed entry) and search continues from there. Under some
- circumstances, this may not produce the wanted results. For example,
- if you have removed (e.g. archived) the current (sub)tree it could
- mean that the next entry will be skipped entirely. In such cases, you
- can specify the position from where search should continue by making
- FUNC set the variable `org-map-continue-from' to the desired buffer
- position.
- MATCH is a tags/property/todo match as it is used in the agenda tags view.
- Only headlines that are matched by this query will be considered during
- the iteration. When MATCH is nil or t, all headlines will be
- visited by the iteration.
- SCOPE determines the scope of this command. It can be any of:
- nil The current buffer, respecting the restriction if any
- tree The subtree started with the entry at point
- region The entries within the active region, if any
- region-start-level
- The entries within the active region, but only those at
- the same level than the first one.
- file The current buffer, without restriction
- file-with-archives
- The current buffer, and any archives associated with it
- agenda All agenda files
- agenda-with-archives
- All agenda files with any archive files associated with them
- \(file1 file2 ...)
- If this is a list, all files in the list will be scanned
- The remaining args are treated as settings for the skipping facilities of
- the scanner. The following items can be given here:
- archive skip trees with the archive tag
- comment skip trees with the COMMENT keyword
- function or Emacs Lisp form:
- will be used as value for `org-agenda-skip-function', so
- whenever the function returns a position, FUNC will not be
- called for that entry and search will continue from the
- position returned
- If your function needs to retrieve the tags including inherited tags
- at the *current* entry, you can use the value of the variable
- `org-scanner-tags' which will be much faster than getting the value
- with `org-get-tags'. If your function gets properties with
- `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
- to t around the call to `org-entry-properties' to get the same speedup.
- Note that if your function moves around to retrieve tags and properties at
- a *different* entry, you cannot use these techniques."
- (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
- (not (org-region-active-p)))
- (let* ((org-agenda-archives-mode nil) ; just to make sure
- (org-agenda-skip-archived-trees (memq 'archive skip))
- (org-agenda-skip-comment-trees (memq 'comment skip))
- (org-agenda-skip-function
- (car (org-delete-all '(comment archive) skip)))
- (org-tags-match-list-sublevels t)
- (start-level (eq scope 'region-start-level))
- matcher res
- org-todo-keywords-for-agenda
- org-done-keywords-for-agenda
- org-todo-keyword-alist-for-agenda
- org-tag-alist-for-agenda
- org--matcher-tags-todo-only)
- (cond
- ((eq match t) (setq matcher t))
- ((eq match nil) (setq matcher t))
- (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
- (save-excursion
- (save-restriction
- (cond ((eq scope 'tree)
- (org-back-to-heading t)
- (org-narrow-to-subtree)
- (setq scope nil))
- ((and (or (eq scope 'region) (eq scope 'region-start-level))
- (org-region-active-p))
- ;; If needed, set start-level to a string like "2"
- (when start-level
- (save-excursion
- (goto-char (region-beginning))
- (unless (org-at-heading-p) (outline-next-heading))
- (setq start-level (org-current-level))))
- (narrow-to-region (region-beginning)
- (save-excursion
- (goto-char (region-end))
- (unless (and (bolp) (org-at-heading-p))
- (outline-next-heading))
- (point)))
- (setq scope nil)))
- (if (not scope)
- (progn
- (org-agenda-prepare-buffers
- (and buffer-file-name (list buffer-file-name)))
- (setq res
- (org-scan-tags
- func matcher org--matcher-tags-todo-only start-level)))
- ;; Get the right scope
- (cond
- ((and scope (listp scope) (symbolp (car scope)))
- (setq scope (eval scope t)))
- ((eq scope 'agenda)
- (setq scope (org-agenda-files t)))
- ((eq scope 'agenda-with-archives)
- (setq scope (org-agenda-files t))
- (setq scope (org-add-archive-files scope)))
- ((eq scope 'file)
- (setq scope (and buffer-file-name (list buffer-file-name))))
- ((eq scope 'file-with-archives)
- (setq scope (org-add-archive-files (list (buffer-file-name))))))
- (org-agenda-prepare-buffers scope)
- (dolist (file scope)
- (with-current-buffer (org-find-base-buffer-visiting file)
- (org-with-wide-buffer
- (goto-char (point-min))
- (setq res
- (append
- res
- (org-scan-tags
- func matcher org--matcher-tags-todo-only)))))))))
- res)))
- ;;; Properties API
- (defconst org-special-properties
- '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
- "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
- "The special properties valid in Org mode.
- These are properties that are not defined in the property drawer,
- but in some other way.")
- (defconst org-default-properties
- '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
- "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
- "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
- "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
- "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
- "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
- "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS"
- "ORG-IMAGE-ACTUAL-WIDTH")
- "Some properties that are used by Org mode for various purposes.
- Being in this list makes sure that they are offered for completion.")
- (defun org--valid-property-p (property)
- "Non-nil when string PROPERTY is a valid property name."
- (not
- (or (equal property "")
- (string-match-p "\\s-" property))))
- (defun org--update-property-plist (key val props)
- "Associate KEY to VAL in alist PROPS.
- Modifications are made by side-effect. Return new alist."
- (let* ((appending (string= (substring key -1) "+"))
- (key (if appending (substring key 0 -1) key))
- (old (assoc-string key props t)))
- (if (not old) (cons (cons key val) props)
- (setcdr old (if appending (concat (cdr old) " " val) val))
- props)))
- (defun org-get-property-block (&optional beg force)
- "Return the (beg . end) range of the body of the property drawer.
- BEG is the beginning of the current subtree or the beginning of
- the document if before the first headline. If it is not given,
- it will be found. If the drawer does not exist, create it if
- FORCE is non-nil, or return nil."
- (org-with-wide-buffer
- (let ((beg (cond (beg (goto-char beg))
- ((or (not (featurep 'org-inlinetask))
- (org-inlinetask-in-task-p))
- (org-back-to-heading-or-point-min t) (point))
- (t (org-with-limited-levels
- (org-back-to-heading-or-point-min t))
- (point)))))
- ;; Move point to its position according to its positional rules.
- (cond ((org-before-first-heading-p)
- (while (and (org-at-comment-p) (bolp)) (forward-line)))
- (t (forward-line)
- (when (looking-at-p org-planning-line-re) (forward-line))))
- (cond ((looking-at org-property-drawer-re)
- (forward-line)
- (cons (point) (progn (goto-char (match-end 0))
- (line-beginning-position))))
- (force
- (goto-char beg)
- (org-insert-property-drawer)
- (let ((pos (save-excursion (re-search-forward org-property-drawer-re)
- (line-beginning-position))))
- (cons pos pos)))))))
- (defun org-at-property-drawer-p ()
- "Non-nil when point is at the first line of a property drawer."
- (org-with-wide-buffer
- (beginning-of-line)
- (and (looking-at org-property-drawer-re)
- (or (bobp)
- (progn
- (forward-line -1)
- (cond ((org-at-heading-p))
- ((looking-at org-planning-line-re)
- (forward-line -1)
- (org-at-heading-p))
- ((looking-at org-comment-regexp)
- (forward-line -1)
- (while (and (not (bobp)) (looking-at org-comment-regexp))
- (forward-line -1))
- (looking-at org-comment-regexp))
- (t nil)))))))
- (defun org-at-property-p ()
- "Non-nil when point is inside a property drawer.
- See `org-property-re' for match data, if applicable."
- (save-excursion
- (beginning-of-line)
- (and (looking-at org-property-re)
- (let ((property-drawer (save-match-data (org-get-property-block))))
- (and property-drawer
- (>= (point) (car property-drawer))
- (< (point) (cdr property-drawer)))))))
- (defun org-property-action ()
- "Do an action on properties."
- (interactive)
- (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
- (let ((c (read-char-exclusive)))
- (cl-case c
- (?s (call-interactively #'org-set-property))
- (?d (call-interactively #'org-delete-property))
- (?D (call-interactively #'org-delete-property-globally))
- (?c (call-interactively #'org-compute-property-at-point))
- (otherwise (user-error "No such property action %c" c)))))
- (defun org-inc-effort ()
- "Increment the value of the effort property in the current entry."
- (interactive)
- (org-set-effort t))
- (defvar org-clock-effort) ; Defined in org-clock.el.
- (defvar org-clock-current-task) ; Defined in org-clock.el.
- (defun org-set-effort (&optional increment value)
- "Set the effort property of the current entry.
- If INCREMENT is non-nil, set the property to the next allowed
- value. Otherwise, if optional argument VALUE is provided, use
- it. Eventually, prompt for the new value if none of the previous
- variables is set."
- (interactive "P")
- (let* ((allowed (org-property-get-allowed-values nil org-effort-property t))
- (current (org-entry-get nil org-effort-property))
- (value
- (cond
- (increment
- (unless allowed (user-error "Allowed effort values are not set"))
- (or (cl-caadr (member (list current) allowed))
- (user-error "Unknown value %S among allowed values" current)))
- (value
- (if (stringp value) value
- (error "Invalid effort value: %S" value)))
- (t
- (let ((must-match
- (and allowed
- (not (get-text-property 0 'org-unrestricted
- (caar allowed))))))
- (completing-read "Effort: " allowed nil must-match))))))
- ;; Test whether the value can be interpreted as a duration before
- ;; inserting it in the buffer:
- (org-duration-to-minutes value)
- ;; Maybe update the effort value:
- (unless (equal current value)
- (org-entry-put nil org-effort-property value))
- (unless (org-element--cache-active-p)
- (org-refresh-property '((effort . identity)
- (effort-minutes . org-duration-to-minutes))
- value))
- (when (equal (org-get-heading t t t t)
- (bound-and-true-p org-clock-current-task))
- (setq org-clock-effort value)
- (org-clock-update-mode-line))
- (message "%s is now %s" org-effort-property value)))
- (defun org-entry-properties (&optional pom which)
- "Get all properties of the current entry.
- When POM is a buffer position, get all properties from the entry
- there instead.
- This includes the TODO keyword, the tags, time strings for
- deadline, scheduled, and clocking, and any additional properties
- defined in the entry.
- If WHICH is nil or `all', get all properties. If WHICH is
- `special' or `standard', only get that subclass. If WHICH is
- a string, only get that property.
- Return value is an alist. Keys are properties, as upcased
- strings."
- (org-with-point-at pom
- (when (and (derived-mode-p 'org-mode)
- (org-back-to-heading-or-point-min t))
- (catch 'exit
- (let* ((beg (point))
- (specific (and (stringp which) (upcase which)))
- (which (cond ((not specific) which)
- ((member specific org-special-properties) 'special)
- (t 'standard)))
- props)
- ;; Get the special properties, like TODO and TAGS.
- (when (memq which '(nil all special))
- (when (or (not specific) (string= specific "CLOCKSUM"))
- (let ((clocksum (get-text-property (point) :org-clock-minutes)))
- (when clocksum
- (push (cons "CLOCKSUM" (org-duration-from-minutes clocksum))
- props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "CLOCKSUM_T"))
- (let ((clocksumt (get-text-property (point)
- :org-clock-minutes-today)))
- (when clocksumt
- (push (cons "CLOCKSUM_T"
- (org-duration-from-minutes clocksumt))
- props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "ITEM"))
- (let ((case-fold-search nil))
- (when (looking-at org-complex-heading-regexp)
- (push (cons "ITEM"
- (let ((title (match-string-no-properties 4)))
- (if (org-string-nw-p title)
- (org-remove-tabs title)
- "")))
- props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "TODO"))
- (let ((case-fold-search nil))
- (when (and (looking-at org-todo-line-regexp) (match-end 2))
- (push (cons "TODO" (match-string-no-properties 2)) props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "PRIORITY"))
- (push (cons "PRIORITY"
- (if (looking-at org-priority-regexp)
- (match-string-no-properties 2)
- (char-to-string org-priority-default)))
- props)
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "FILE"))
- (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
- props)
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "TAGS"))
- (let ((tags (org-get-tags nil t)))
- (when tags
- (push (cons "TAGS" (org-make-tag-string tags))
- props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "ALLTAGS"))
- (let ((tags (org-get-tags)))
- (when tags
- (push (cons "ALLTAGS" (org-make-tag-string tags))
- props)))
- (when specific (throw 'exit props)))
- (when (or (not specific) (string= specific "BLOCKED"))
- (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
- (when specific (throw 'exit props)))
- (when (or (not specific)
- (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
- (forward-line)
- (when (looking-at-p org-planning-line-re)
- (end-of-line)
- (let ((bol (line-beginning-position))
- ;; Backward compatibility: time keywords used to
- ;; be configurable (before 8.3). Make sure we
- ;; get the correct keyword.
- (key-assoc `(("CLOSED" . ,org-closed-string)
- ("DEADLINE" . ,org-deadline-string)
- ("SCHEDULED" . ,org-scheduled-string))))
- (dolist (pair (if specific (list (assoc specific key-assoc))
- key-assoc))
- (save-excursion
- (when (search-backward (cdr pair) bol t)
- (goto-char (match-end 0))
- (skip-chars-forward " \t")
- (and (looking-at org-ts-regexp-both)
- (push (cons (car pair)
- (match-string-no-properties 0))
- props)))))))
- (when specific (throw 'exit props)))
- (when (or (not specific)
- (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
- (let ((find-ts
- (lambda (end ts)
- ;; Fix next time-stamp before END. TS is the
- ;; list of time-stamps found so far.
- (let ((ts ts)
- (regexp (cond
- ((string= specific "TIMESTAMP")
- org-ts-regexp)
- ((string= specific "TIMESTAMP_IA")
- org-ts-regexp-inactive)
- ((assoc "TIMESTAMP_IA" ts)
- org-ts-regexp)
- ((assoc "TIMESTAMP" ts)
- org-ts-regexp-inactive)
- (t org-ts-regexp-both))))
- (catch 'next
- (while (re-search-forward regexp end t)
- (backward-char)
- (let ((object (org-element-context)))
- ;; Accept to match timestamps in node
- ;; properties, too.
- (when (memq (org-element-type object)
- '(node-property timestamp))
- (let ((type
- (org-element-property :type object)))
- (cond
- ((and (memq type '(active active-range))
- (not (equal specific "TIMESTAMP_IA")))
- (unless (assoc "TIMESTAMP" ts)
- (push (cons "TIMESTAMP"
- (org-element-property
- :raw-value object))
- ts)
- (when specific (throw 'exit ts))))
- ((and (memq type '(inactive inactive-range))
- (not (string= specific "TIMESTAMP")))
- (unless (assoc "TIMESTAMP_IA" ts)
- (push (cons "TIMESTAMP_IA"
- (org-element-property
- :raw-value object))
- ts)
- (when specific (throw 'exit ts))))))
- ;; Both timestamp types are found,
- ;; move to next part.
- (when (= (length ts) 2) (throw 'next ts)))))
- ts)))))
- (goto-char beg)
- ;; First look for timestamps within headline.
- (let ((ts (funcall find-ts (line-end-position) nil)))
- (if (= (length ts) 2) (setq props (nconc ts props))
- ;; Then find timestamps in the section, skipping
- ;; planning line.
- (let ((end (save-excursion (outline-next-heading))))
- (forward-line)
- (when (looking-at-p org-planning-line-re) (forward-line))
- (setq props (nconc (funcall find-ts end ts) props))))))))
- ;; Get the standard properties, like :PROP:.
- (when (memq which '(nil all standard))
- ;; If we are looking after a specific property, delegate
- ;; to `org-entry-get', which is faster. However, make an
- ;; exception for "CATEGORY", since it can be also set
- ;; through keywords (i.e. #+CATEGORY).
- (if (and specific (not (equal specific "CATEGORY")))
- (let ((value (org-entry-get beg specific nil t)))
- (throw 'exit (and value (list (cons specific value)))))
- (let ((range (org-get-property-block beg)))
- (when range
- (let ((end (cdr range)) seen-base)
- (goto-char (car range))
- ;; Unlike to `org--update-property-plist', we
- ;; handle the case where base values is found
- ;; after its extension. We also forbid standard
- ;; properties to be named as special properties.
- (while (re-search-forward org-property-re end t)
- (let* ((key (upcase (match-string-no-properties 2)))
- (extendp (string-match-p "\\+\\'" key))
- (key-base (if extendp (substring key 0 -1) key))
- (value (match-string-no-properties 3)))
- (cond
- ((member-ignore-case key-base org-special-properties))
- (extendp
- (setq props
- (org--update-property-plist key value props)))
- ((member key seen-base))
- (t (push key seen-base)
- (let ((p (assoc-string key props t)))
- (if p (setcdr p (concat value " " (cdr p)))
- (push (cons key value) props))))))))))))
- (unless (assoc "CATEGORY" props)
- (push (cons "CATEGORY" (org-get-category beg)) props)
- (when (string= specific "CATEGORY") (throw 'exit props)))
- ;; Return value.
- props)))))
- (defun org--property-local-values (property literal-nil &optional element)
- "Return value for PROPERTY in current entry or ELEMENT.
- Value is a list whose car is the base value for PROPERTY and cdr
- a list of accumulated values. Return nil if neither is found in
- the entry. Also return nil when PROPERTY is set to \"nil\",
- unless LITERAL-NIL is non-nil."
- (let ((element (or element
- (and (org-element--cache-active-p)
- (org-element-at-point nil 'cached)))))
- (if element
- (let* ((element (org-element-lineage element '(headline org-data inlinetask) 'with-self))
- (base-value (org-element-property (intern (concat ":" (upcase property))) element))
- (base-value (if literal-nil base-value (org-not-nil base-value)))
- (extra-value (org-element-property (intern (concat ":" (upcase property) "+")) element))
- (extra-value (if (listp extra-value) extra-value (list extra-value)))
- (value (cons base-value extra-value)))
- (and (not (equal value '(nil))) value))
- (let ((range (org-get-property-block)))
- (when range
- (goto-char (car range))
- (let* ((case-fold-search t)
- (end (cdr range))
- (value
- ;; Base value.
- (save-excursion
- (let ((v (and (re-search-forward
- (org-re-property property nil t) end t)
- (match-string-no-properties 3))))
- (list (if literal-nil v (org-not-nil v)))))))
- ;; Find additional values.
- (let* ((property+ (org-re-property (concat property "+") nil t)))
- (while (re-search-forward property+ end t)
- (push (match-string-no-properties 3) value)))
- ;; Return final values.
- (and (not (equal value '(nil))) (nreverse value))))))))
- (defun org--property-global-or-keyword-value (property literal-nil)
- "Return value for PROPERTY as defined by global properties or by keyword.
- Return value is a string. Return nil if property is not set
- globally or by keyword. Also return nil when PROPERTY is set to
- \"nil\", unless LITERAL-NIL is non-nil."
- (let ((global
- (cdr (or (assoc-string property org-keyword-properties t)
- (assoc-string property org-global-properties t)
- (assoc-string property org-global-properties-fixed t)))))
- (if literal-nil global (org-not-nil global))))
- (defun org-entry-get (pom property &optional inherit literal-nil)
- "Get value of PROPERTY for entry or content at point-or-marker POM.
- If INHERIT is non-nil and the entry does not have the property,
- then also check higher levels of the hierarchy. If INHERIT is
- the symbol `selective', use inheritance only if the setting in
- `org-use-property-inheritance' selects PROPERTY for inheritance.
- If the property is present but empty, the return value is the
- empty string. If the property is not present at all, nil is
- returned. In any other case, return the value as a string.
- Search is case-insensitive.
- If LITERAL-NIL is set, return the string value \"nil\" as
- a string, do not interpret it as the list atom nil. This is used
- for inheritance when a \"nil\" value can supersede a non-nil
- value higher up the hierarchy."
- (org-with-point-at pom
- (cond
- ((member-ignore-case property (cons "CATEGORY" org-special-properties))
- ;; We need a special property. Use `org-entry-properties' to
- ;; retrieve it, but specify the wanted property.
- (cdr (assoc-string property (org-entry-properties nil property))))
- ((and inherit
- (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
- (org-entry-get-with-inheritance property literal-nil))
- (t
- (let* ((local (org--property-local-values property literal-nil))
- (value (and local (mapconcat #'identity
- (delq nil local)
- (org--property-get-separator property)))))
- (if literal-nil value (org-not-nil value)))))))
- (defun org-property-or-variable-value (var &optional inherit)
- "Check if there is a property fixing the value of VAR.
- If yes, return this value. If not, return the current value of the variable."
- (let ((prop (org-entry-get nil (symbol-name var) inherit)))
- (if (and prop (stringp prop) (string-match "\\S-" prop))
- (read prop)
- (symbol-value var))))
- (defun org-entry-delete (pom property)
- "Delete PROPERTY from entry at point-or-marker POM.
- Accumulated properties, i.e. PROPERTY+, are also removed. Return
- non-nil when a property was removed."
- (org-with-point-at pom
- (pcase (org-get-property-block)
- (`(,begin . ,origin)
- (let* ((end (copy-marker origin))
- (re (org-re-property
- (concat (regexp-quote property) "\\+?") t t)))
- (goto-char begin)
- (while (re-search-forward re end t)
- (delete-region (match-beginning 0) (line-beginning-position 2)))
- ;; If drawer is empty, remove it altogether.
- (when (= begin end)
- (delete-region (line-beginning-position 0)
- (line-beginning-position 2)))
- ;; Return non-nil if some property was removed.
- (prog1 (/= end origin) (set-marker end nil))))
- (_ nil))))
- ;; Multi-values properties are properties that contain multiple values
- ;; These values are assumed to be single words, separated by whitespace.
- (defun org-entry-add-to-multivalued-property (pom property value)
- "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
- (let* ((old (org-entry-get pom property))
- (values (and old (split-string old))))
- (setq value (org-entry-protect-space value))
- (unless (member value values)
- (setq values (append values (list value)))
- (org-entry-put pom property (mapconcat #'identity values " ")))))
- (defun org-entry-remove-from-multivalued-property (pom property value)
- "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
- (let* ((old (org-entry-get pom property))
- (values (and old (split-string old))))
- (setq value (org-entry-protect-space value))
- (when (member value values)
- (setq values (delete value values))
- (org-entry-put pom property (mapconcat #'identity values " ")))))
- (defun org-entry-member-in-multivalued-property (pom property value)
- "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
- (let* ((old (org-entry-get pom property))
- (values (and old (split-string old))))
- (setq value (org-entry-protect-space value))
- (member value values)))
- (defun org-entry-get-multivalued-property (pom property)
- "Return a list of values in a multivalued property."
- (let* ((value (org-entry-get pom property))
- (values (and value (split-string value))))
- (mapcar #'org-entry-restore-space values)))
- (defun org-entry-put-multivalued-property (pom property &rest values)
- "Set multivalued PROPERTY at point-or-marker POM to VALUES.
- VALUES should be a list of strings. Spaces will be protected."
- (org-entry-put pom property (mapconcat #'org-entry-protect-space values " "))
- (let* ((value (org-entry-get pom property))
- (values (and value (split-string value))))
- (mapcar #'org-entry-restore-space values)))
- (defun org-entry-protect-space (s)
- "Protect spaces and newline in string S."
- (while (string-match " " s)
- (setq s (replace-match "%20" t t s)))
- (while (string-match "\n" s)
- (setq s (replace-match "%0A" t t s)))
- s)
- (defun org-entry-restore-space (s)
- "Restore spaces and newline in string S."
- (while (string-match "%20" s)
- (setq s (replace-match " " t t s)))
- (while (string-match "%0A" s)
- (setq s (replace-match "\n" t t s)))
- s)
- (defvar org-entry-property-inherited-from (make-marker)
- "Marker pointing to the entry from where a property was inherited.
- Each call to `org-entry-get-with-inheritance' will set this marker to the
- location of the entry where the inheritance search matched. If there was
- no match, the marker will point nowhere.
- Note that also `org-entry-get' calls this function, if the INHERIT flag
- is set.")
- (defun org-entry-get-with-inheritance (property &optional literal-nil element)
- "Get PROPERTY of entry or content at point, search higher levels if needed.
- The search will stop at the first ancestor which has the property defined.
- If the value found is \"nil\", return nil to show that the property
- should be considered as undefined (this is the meaning of nil here).
- However, if LITERAL-NIL is set, return the string value \"nil\" instead."
- (move-marker org-entry-property-inherited-from nil)
- (org-with-wide-buffer
- (let (value at-bob-no-heading)
- (catch 'exit
- (let ((element (or element
- (and (org-element--cache-active-p)
- (org-element-at-point nil 'cached))))
- (separator (org--property-get-separator property)))
- (if element
- (let ((element (org-element-lineage element '(headline org-data inlinetask) 'with-self)))
- (while t
- (let* ((v (org--property-local-values property literal-nil element))
- (v (if (listp v) v (list v))))
- (when v
- (setq value
- (concat (mapconcat #'identity (delq nil v) separator)
- (and value separator)
- value)))
- (cond
- ((car v)
- (move-marker org-entry-property-inherited-from (org-element-property :begin element))
- (throw 'exit nil))
- ((org-element-property :parent element)
- (setq element (org-element-property :parent element)))
- (t
- (let ((global (org--property-global-or-keyword-value property literal-nil)))
- (cond ((not global))
- (value (setq value (concat global separator value)))
- (t (setq value global))))
- (throw 'exit nil))))))
- (while t
- (let ((v (org--property-local-values property literal-nil)))
- (when v
- (setq value
- (concat (mapconcat #'identity (delq nil v) separator)
- (and value separator)
- value)))
- (cond
- ((car v)
- (org-back-to-heading-or-point-min t)
- (move-marker org-entry-property-inherited-from (point))
- (throw 'exit nil))
- ((or (org-up-heading-safe)
- (and (not (bobp))
- (goto-char (point-min))
- nil)
- ;; `org-up-heading-safe' returned nil. We are at low
- ;; level heading or bob. If there is headline
- ;; there, do not try to fetch its properties.
- (and (bobp)
- (not at-bob-no-heading)
- (not (org-at-heading-p))
- (setq at-bob-no-heading t))))
- (t
- (let ((global (org--property-global-or-keyword-value property literal-nil)))
- (cond ((not global))
- (value (setq value (concat global separator value)))
- (t (setq value global))))
- (throw 'exit nil))))))))
- (if literal-nil value (org-not-nil value)))))
- (defvar org-property-changed-functions nil
- "Hook called when the value of a property has changed.
- Each hook function should accept two arguments, the name of the property
- and the new value.")
- (defun org-entry-put (pom property value)
- "Set PROPERTY to VALUE for entry at point-or-marker POM.
- If the value is nil, it is converted to the empty string. If it
- is not a string, an error is raised. Also raise an error on
- invalid property names.
- PROPERTY can be any regular property (see
- `org-special-properties'). It can also be \"TODO\",
- \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
- For the last two properties, VALUE may have any of the special
- values \"earlier\" and \"later\". The function then increases or
- decreases scheduled or deadline date by one day."
- (cond ((null value) (setq value ""))
- ((not (stringp value)) (error "Properties values should be strings"))
- ((not (org--valid-property-p property))
- (user-error "Invalid property name: \"%s\"" property)))
- (org-no-read-only
- (org-with-point-at pom
- (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
- (org-back-to-heading-or-point-min t)
- (org-with-limited-levels (org-back-to-heading-or-point-min t)))
- (let ((beg (point)))
- (cond
- ((equal property "TODO")
- (cond ((not (org-string-nw-p value)) (setq value 'none))
- ((not (member value org-todo-keywords-1))
- (user-error "\"%s\" is not a valid TODO state" value)))
- (org-todo value)
- (org-align-tags))
- ((equal property "PRIORITY")
- (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
- (org-align-tags))
- ((equal property "SCHEDULED")
- (forward-line)
- (if (and (looking-at-p org-planning-line-re)
- (re-search-forward
- org-scheduled-time-regexp (line-end-position) t))
- (cond ((string= value "earlier") (org-timestamp-change -1 'day))
- ((string= value "later") (org-timestamp-change 1 'day))
- ((string= value "") (org-schedule '(4)))
- (t (org-schedule nil value)))
- (if (member value '("earlier" "later" ""))
- (call-interactively #'org-schedule)
- (org-schedule nil value))))
- ((equal property "DEADLINE")
- (forward-line)
- (if (and (looking-at-p org-planning-line-re)
- (re-search-forward
- org-deadline-time-regexp (line-end-position) t))
- (cond ((string= value "earlier") (org-timestamp-change -1 'day))
- ((string= value "later") (org-timestamp-change 1 'day))
- ((string= value "") (org-deadline '(4)))
- (t (org-deadline nil value)))
- (if (member value '("earlier" "later" ""))
- (call-interactively #'org-deadline)
- (org-deadline nil value))))
- ((member property org-special-properties)
- (error "The %s property cannot be set with `org-entry-put'" property))
- (t
- (org-fold-core-ignore-modifications
- (let* ((range (org-get-property-block beg 'force))
- (end (cdr range))
- (case-fold-search t))
- (goto-char (car range))
- (if (re-search-forward (org-re-property property nil t) end t)
- (progn (delete-region (match-beginning 0) (match-end 0))
- (goto-char (match-beginning 0)))
- (goto-char end)
- (insert-and-inherit "\n")
- (backward-char))
- (insert-and-inherit ":" property ":")
- (when value (insert-and-inherit " " value))
- (org-indent-line))))))
- (run-hook-with-args 'org-property-changed-functions property value))))
- (defun org-buffer-property-keys (&optional specials defaults columns)
- "Get all property keys in the current buffer.
- When SPECIALS is non-nil, also list the special properties that
- reflect things like tags and TODO state.
- When DEFAULTS is non-nil, also include properties that has
- special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
- DESCRIPTION, LOCATION, and LOGGING and others.
- When COLUMNS in non-nil, also include property names given in
- COLUMN formats in the current buffer."
- (let ((case-fold-search t)
- (props (append
- (and specials org-special-properties)
- (and defaults (cons org-effort-property org-default-properties))
- ;; Get property names from #+PROPERTY keywords as well
- (mapcar (lambda (s)
- (nth 0 (split-string s)))
- (cdar (org-collect-keywords '("PROPERTY")))))))
- (org-with-wide-buffer
- (goto-char (point-min))
- (while (re-search-forward org-property-start-re nil t)
- (catch :skip
- (let ((range (org-get-property-block)))
- (unless range (throw :skip nil))
- (goto-char (car range))
- (let ((begin (car range))
- (end (cdr range)))
- ;; Make sure that found property block is not located
- ;; before current point, as it would generate an infloop.
- ;; It can happen, for example, in the following
- ;; situation:
- ;;
- ;; * Headline
- ;; :PROPERTIES:
- ;; ...
- ;; :END:
- ;; *************** Inlinetask
- ;; #+BEGIN_EXAMPLE
- ;; :PROPERTIES:
- ;; #+END_EXAMPLE
- ;;
- (if (< begin (point)) (throw :skip nil) (goto-char begin))
- (while (< (point) end)
- (let ((p (progn (looking-at org-property-re)
- (match-string-no-properties 2))))
- ;; Only add true property name, not extension symbol.
- (push (if (not (string-match-p "\\+\\'" p)) p
- (substring p 0 -1))
- props))
- (forward-line))))
- (outline-next-heading)))
- (when columns
- (goto-char (point-min))
- (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
- (let ((element (org-element-at-point)))
- (when (memq (org-element-type element) '(keyword node-property))
- (let ((value (org-element-property :value element))
- (start 0))
- (while (string-match "%[0-9]*\\([[:alnum:]_-]+\\)\\(([^)]+)\\)?\
- \\(?:{[^}]+}\\)?"
- value start)
- (setq start (match-end 0))
- (let ((p (match-string-no-properties 1 value)))
- (unless (member-ignore-case p org-special-properties)
- (push p props))))))))))
- (sort (delete-dups
- (append props
- ;; for each xxx_ALL property, make sure the bare
- ;; xxx property is also included
- (delq nil (mapcar (lambda (p)
- (and (string-match-p "._ALL\\'" p)
- (substring p 0 -4)))
- props))))
- (lambda (a b) (string< (upcase a) (upcase b))))))
- (defun org-property-values (key)
- "List all non-nil values of property KEY in current buffer."
- (org-with-wide-buffer
- (goto-char (point-min))
- (let ((case-fold-search t)
- (re (org-re-property key))
- values)
- (while (re-search-forward re nil t)
- (push (org-entry-get (point) key) values))
- (delete-dups values))))
- (defun org-insert-property-drawer ()
- "Insert a property drawer into the current entry.
- Do nothing if the drawer already exists. The newly created
- drawer is immediately hidden."
- (org-with-wide-buffer
- ;; Set point to the position where the drawer should be inserted.
- (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
- (org-back-to-heading-or-point-min t)
- (org-with-limited-levels (org-back-to-heading-or-point-min t)))
- (if (org-before-first-heading-p)
- (while (and (org-at-comment-p) (bolp)) (forward-line))
- (forward-line)
- (when (looking-at-p org-planning-line-re) (forward-line)))
- (unless (looking-at-p org-property-drawer-re)
- ;; Make sure we start editing a line from current entry, not from
- ;; next one. It prevents extending text properties or overlays
- ;; belonging to the latter.
- (when (and (bolp) (> (point) (point-min))) (backward-char))
- (let ((begin (if (bobp) (point) (1+ (point))))
- (inhibit-read-only t))
- (unless (bobp) (insert "\n"))
- (insert ":PROPERTIES:\n:END:")
- (org-fold-region (line-end-position 0) (point) t (if (eq org-fold-core-style 'text-properties) 'drawer 'outline))
- (when (or (eobp) (= begin (point-min))) (insert "\n"))
- (org-indent-region begin (point))))))
- (defun org-insert-drawer (&optional arg drawer)
- "Insert a drawer at point.
- When optional argument ARG is non-nil, insert a property drawer.
- Optional argument DRAWER, when non-nil, is a string representing
- drawer's name. Otherwise, the user is prompted for a name.
- If a region is active, insert the drawer around that region
- instead.
- Point is left between drawer's boundaries."
- (interactive "P")
- (let* ((drawer (if arg "PROPERTIES"
- (or drawer (read-from-minibuffer "Drawer: ")))))
- (cond
- ;; With C-u, fall back on `org-insert-property-drawer'
- (arg (org-insert-property-drawer))
- ;; Check validity of suggested drawer's name.
- ((not (string-match-p org-drawer-regexp (format ":%s:" drawer)))
- (user-error "Invalid drawer name"))
- ;; With an active region, insert a drawer at point.
- ((not (org-region-active-p))
- (progn
- (unless (bolp) (insert "\n"))
- (insert (format ":%s:\n\n:END:\n" drawer))
- (forward-line -2)))
- ;; Otherwise, insert the drawer at point
- (t
- (let ((rbeg (region-beginning))
- (rend (copy-marker (region-end))))
- (unwind-protect
- (progn
- (goto-char rbeg)
- (beginning-of-line)
- (when (save-excursion
- (re-search-forward org-outline-regexp-bol rend t))
- (user-error "Drawers cannot contain headlines"))
- ;; Position point at the beginning of the first
- ;; non-blank line in region. Insert drawer's opening
- ;; there, then indent it.
- (org-skip-whitespace)
- (beginning-of-line)
- (insert ":" drawer ":\n")
- (forward-line -1)
- (indent-for-tab-command)
- ;; Move point to the beginning of the first blank line
- ;; after the last non-blank line in region. Insert
- ;; drawer's closing, then indent it.
- (goto-char rend)
- (skip-chars-backward " \r\t\n")
- (insert "\n:END:")
- (deactivate-mark t)
- (indent-for-tab-command)
- (unless (eolp) (insert "\n")))
- ;; Clear marker, whatever the outcome of insertion is.
- (set-marker rend nil)))))))
- (defvar org-property-set-functions-alist nil
- "Property set function alist.
- Each entry should have the following format:
- (PROPERTY . READ-FUNCTION)
- The read function will be called with the same argument as
- `org-completing-read'.")
- (defun org-set-property-function (property)
- "Get the function that should be used to set PROPERTY.
- This is computed according to `org-property-set-functions-alist'."
- (or (cdr (assoc property org-property-set-functions-alist))
- 'org-completing-read))
- (defun org-read-property-value (property &optional pom default)
- "Read value for PROPERTY, as a string.
- When optional argument POM is non-nil, completion uses additional
- information, i.e., allowed or existing values at point or marker
- POM.
- Optional argument DEFAULT provides a default value for PROPERTY."
- (let* ((completion-ignore-case t)
- (allowed
- (or (org-property-get-allowed-values nil property 'table)
- (and pom (org-property-get-allowed-values pom property 'table))))
- (current (org-entry-get nil property))
- (prompt (format "%s value%s: "
- property
- (if (org-string-nw-p current)
- (format " [%s]" current)
- "")))
- (set-function (org-set-property-function property)))
- (org-trim
- (if allowed
- (funcall set-function
- prompt allowed nil
- (not (get-text-property 0 'org-unrestricted (caar allowed)))
- default nil default)
- (let ((all (mapcar #'list
- (append (org-property-values property)
- (and pom
- (org-with-point-at pom
- (org-property-values property)))))))
- (funcall set-function prompt all nil nil "" nil current))))))
- (defvar org-last-set-property nil)
- (defvar org-last-set-property-value nil)
- (defun org-read-property-name ()
- "Read a property name."
- (let ((completion-ignore-case t)
- (default-prop (or (and (org-at-property-p)
- (match-string-no-properties 2))
- org-last-set-property)))
- (org-completing-read
- (concat "Property"
- (if default-prop (concat " [" default-prop "]") "")
- ": ")
- (mapcar #'list (org-buffer-property-keys nil t t))
- nil nil nil nil default-prop)))
- (defun org-set-property-and-value (use-last)
- "Allow to set [PROPERTY]: [value] direction from prompt.
- When use-default, don't even ask, just use the last
- \"[PROPERTY]: [value]\" string from the history."
- (interactive "P")
- (let* ((completion-ignore-case t)
- (pv (or (and use-last org-last-set-property-value)
- (org-completing-read
- "Enter a \"[Property]: [value]\" pair: "
- nil nil nil nil nil
- org-last-set-property-value)))
- prop val)
- (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
- (setq prop (match-string 1 pv)
- val (match-string 2 pv))
- (org-set-property prop val))))
- (defun org-set-property (property value)
- "In the current entry, set PROPERTY to VALUE.
- When called interactively, this will prompt for a property name, offering
- completion on existing and default properties. And then it will prompt
- for a value, offering completion either on allowed values (via an inherited
- xxx_ALL property) or on existing values in other instances of this property
- in the current file.
- Throw an error when trying to set a property with an invalid name."
- (interactive (list nil nil))
- (let ((property (or property (org-read-property-name))))
- ;; `org-entry-put' also makes the following check, but this one
- ;; avoids polluting `org-last-set-property' and
- ;; `org-last-set-property-value' needlessly.
- (unless (org--valid-property-p property)
- (user-error "Invalid property name: \"%s\"" property))
- (let ((value (or value (org-read-property-value property)))
- (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
- (setq org-last-set-property property)
- (setq org-last-set-property-value (concat property ": " value))
- ;; Possibly postprocess the inserted value:
- (when fn (setq value (funcall fn value)))
- (unless (equal (org-entry-get nil property) value)
- (org-entry-put nil property value)))))
- (defun org-find-property (property &optional value)
- "Find first entry in buffer that sets PROPERTY.
- When optional argument VALUE is non-nil, only consider an entry
- if it contains PROPERTY set to this value. If PROPERTY should be
- explicitly set to nil, use string \"nil\" for VALUE.
- Return position where the entry begins, or nil if there is no
- such entry. If narrowing is in effect, only search the visible
- part of the buffer."
- (save-excursion
- (goto-char (point-min))
- (let ((case-fold-search t)
- (re (org-re-property property nil (not value) value)))
- (catch 'exit
- (while (re-search-forward re nil t)
- (when (if value (org-at-property-p)
- (org-entry-get (point) property nil t))
- (throw 'exit (progn (org-back-to-heading-or-point-min t)
- (point)))))))))
- (defun org-delete-property (property)
- "In the current entry, delete PROPERTY."
- (interactive
- (let* ((completion-ignore-case t)
- (cat (org-entry-get (point) "CATEGORY"))
- (props0 (org-entry-properties nil 'standard))
- (props (if cat props0
- (delete `("CATEGORY" . ,(org-get-category)) props0)))
- (prop (if (< 1 (length props))
- (completing-read "Property: " props nil t)
- (caar props))))
- (list prop)))
- (if (not property)
- (message "No property to delete in this entry")
- (org-entry-delete nil property)
- (message "Property \"%s\" deleted" property)))
- (defun org-delete-property-globally (property)
- "Remove PROPERTY globally, from all entries.
- This function ignores narrowing, if any."
- (interactive
- (let* ((completion-ignore-case t)
- (prop (completing-read
- "Globally remove property: "
- (mapcar #'list (org-buffer-property-keys)))))
- (list prop)))
- (org-with-wide-buffer
- (goto-char (point-min))
- (let ((count 0)
- (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
- (while (re-search-forward re nil t)
- (when (org-entry-delete (point) property) (cl-incf count)))
- (message "Property \"%s\" removed from %d entries" property count))))
- (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
- (defun org-compute-property-at-point ()
- "Compute the property at point.
- This looks for an enclosing column format, extracts the operator and
- then applies it to the property in the column format's scope."
- (interactive)
- (unless (org-at-property-p)
- (user-error "Not at a property"))
- (let ((prop (match-string-no-properties 2)))
- (org-columns-get-format-and-top-level)
- (unless (nth 3 (assoc-string prop org-columns-current-fmt-compiled t))
- (user-error "No operator defined for property %s" prop))
- (org-columns-compute prop)))
- (defvar org-property-allowed-value-functions nil
- "Hook for functions supplying allowed values for a specific property.
- The functions must take a single argument, the name of the property, and
- return a flat list of allowed values. If \":ETC\" is one of
- the values, this means that these values are intended as defaults for
- completion, but that other values should be allowed too.
- The functions must return nil if they are not responsible for this
- property.")
- (defun org-property-get-allowed-values (pom property &optional table)
- "Get allowed values for the property PROPERTY.
- When TABLE is non-nil, return an alist that can directly be used for
- completion."
- (let (vals)
- (cond
- ((equal property "TODO")
- (setq vals (org-with-point-at pom
- (append org-todo-keywords-1 '("")))))
- ((equal property "PRIORITY")
- (let ((n org-priority-lowest))
- (while (>= n org-priority-highest)
- (push (char-to-string n) vals)
- (setq n (1- n)))))
- ((equal property "CATEGORY"))
- ((member property org-special-properties))
- ((setq vals (run-hook-with-args-until-success
- 'org-property-allowed-value-functions property)))
- (t
- (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
- (when (and vals (string-match "\\S-" vals))
- (setq vals (car (read-from-string (concat "(" vals ")"))))
- (setq vals (mapcar (lambda (x)
- (cond ((stringp x) x)
- ((numberp x) (number-to-string x))
- ((symbolp x) (symbol-name x))
- (t "???")))
- vals)))))
- (when (member ":ETC" vals)
- (setq vals (remove ":ETC" vals))
- (org-add-props (car vals) '(org-unrestricted t)))
- (if table (mapcar 'list vals) vals)))
- (defun org-property-previous-allowed-value (&optional _previous)
- "Switch to the next allowed value for this property."
- (interactive)
- (org-property-next-allowed-value t))
- (defun org-property-next-allowed-value (&optional previous)
- "Switch to the next allowed value for this property."
- (interactive)
- (unless (org-at-property-p)
- (user-error "Not at a property"))
- (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
- (key (match-string 2))
- (value (match-string 3))
- (allowed (or (org-property-get-allowed-values (point) key)
- (and (member value '("[ ]" "[-]" "[X]"))
- '("[ ]" "[X]"))))
- (heading (save-match-data (nth 4 (org-heading-components))))
- nval)
- (unless allowed
- (user-error "Allowed values for this property have not been defined"))
- (when previous (setq allowed (reverse allowed)))
- (when (member value allowed)
- (setq nval (car (cdr (member value allowed)))))
- (setq nval (or nval (car allowed)))
- (when (equal nval value)
- (user-error "Only one allowed value for this property"))
- (org-at-property-p)
- (replace-match (concat " :" key ": " nval) t t)
- (org-indent-line)
- (beginning-of-line 1)
- (skip-chars-forward " \t")
- (when (equal prop org-effort-property)
- (unless (org-element--cache-active-p)
- (org-refresh-property
- '((effort . identity)
- (effort-minutes . org-duration-to-minutes))
- nval))
- (when (string= org-clock-current-task heading)
- (setq org-clock-effort nval)
- (org-clock-update-mode-line)))
- (run-hook-with-args 'org-property-changed-functions key nval)))
- (defun org-find-olp (path &optional this-buffer)
- "Return a marker pointing to the entry at outline path OLP.
- If anything goes wrong, throw an error, and if you need to do
- something based on this error, you can catch it with
- `condition-case'.
- If THIS-BUFFER is set, the outline path does not contain a file,
- only headings."
- (let* ((file (if this-buffer buffer-file-name (pop path)))
- (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
- (level 1)
- (lmin 1)
- (lmax 1)
- end found flevel)
- (unless buffer (error "File not found :%s" file))
- (with-current-buffer buffer
- (unless (derived-mode-p 'org-mode)
- (error "Buffer %s needs to be in Org mode" buffer))
- (org-with-wide-buffer
- (goto-char (point-min))
- (dolist (heading path)
- (let ((re (format org-complex-heading-regexp-format
- (regexp-quote heading)))
- (cnt 0))
- (while (re-search-forward re end t)
- (setq level (- (match-end 1) (match-beginning 1)))
- (when (and (>= level lmin) (<= level lmax))
- (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
- (when (= cnt 0)
- (error "Heading not found on level %d: %s" lmax heading))
- (when (> cnt 1)
- (error "Heading not unique on level %d: %s" lmax heading))
- (goto-char found)
- (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
- (setq end (save-excursion (org-end-of-subtree t t)))))
- (when (org-at-heading-p)
- (point-marker))))))
- (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
- "Find node HEADING in BUFFER.
- Return a marker to the heading if it was found, or nil if not.
- If POS-ONLY is set, return just the position instead of a marker.
- The heading text must match exact, but it may have a TODO keyword,
- a priority cookie and tags in the standard locations."
- (with-current-buffer (or buffer (current-buffer))
- (org-with-wide-buffer
- (goto-char (point-min))
- (let (case-fold-search)
- (when (re-search-forward
- (format org-complex-heading-regexp-format
- (regexp-quote heading)) nil t)
- (if pos-only
- (match-beginning 0)
- (move-marker (make-marker) (match-beginning 0))))))))
- (defun org-find-exact-heading-in-directory (heading &optional dir)
- "Find Org node headline HEADING in all \".org\" files in directory DIR.
- When the target headline is found, return a marker to this location."
- (let ((files (directory-files (or dir default-directory)
- t "\\`[^.#].*\\.org\\'"))
- visiting m buffer)
- (catch 'found
- (dolist (file files)
- (message "trying %s" file)
- (setq visiting (org-find-base-buffer-visiting file))
- (setq buffer (or visiting (find-file-noselect file)))
- (setq m (org-find-exact-headline-in-buffer
- heading buffer))
- (when (and (not m) (not visiting)) (kill-buffer buffer))
- (and m (throw 'found m))))))
- (defun org-find-entry-with-id (ident)
- "Locate the entry that contains the ID property with exact value IDENT.
- IDENT can be a string, a symbol or a number, this function will search for
- the string representation of it.
- Return the position where this entry starts, or nil if there is no such entry."
- (interactive "sID: ")
- (let ((id (cond
- ((stringp ident) ident)
- ((symbolp ident) (symbol-name ident))
- ((numberp ident) (number-to-string ident))
- (t (error "IDENT %s must be a string, symbol or number" ident)))))
- (org-with-wide-buffer (org-find-property "ID" id))))
- ;;;; Timestamps
- (defvar org-last-changed-timestamp nil)
- (defvar org-last-inserted-timestamp nil
- "The last time stamp inserted with `org-insert-time-stamp'.")
- (defun org-time-stamp (arg &optional inactive)
- "Prompt for a date/time and insert a time stamp.
- If the user specifies a time like HH:MM or if this command is
- called with at least one prefix argument, the time stamp contains
- the date and the time. Otherwise, only the date is included.
- All parts of a date not specified by the user are filled in from
- the timestamp at point, if any, or the current date/time
- otherwise.
- If there is already a timestamp at the cursor, it is replaced.
- With two universal prefix arguments, insert an active timestamp
- with the current time without prompting the user.
- When called from Lisp, the timestamp is inactive if INACTIVE is
- non-nil."
- (interactive "P")
- (let* ((ts (cond
- ((org-at-date-range-p t)
- (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
- ((org-at-timestamp-p 'lax) (match-string 0))))
- ;; Default time is either the timestamp at point or today.
- ;; When entering a range, only the range start is considered.
- (default-time (and ts (org-time-string-to-time ts)))
- (default-input (and ts (org-get-compact-tod ts)))
- (repeater (and ts
- (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
- (match-string 0 ts)))
- org-time-was-given
- org-end-time-was-given
- (time
- (if (equal arg '(16)) (current-time)
- ;; Preserve `this-command' and `last-command'.
- (let ((this-command this-command)
- (last-command last-command))
- (org-read-date
- arg 'totime nil nil default-time default-input
- inactive)))))
- (cond
- ((and ts
- (memq last-command '(org-time-stamp org-time-stamp-inactive))
- (memq this-command '(org-time-stamp org-time-stamp-inactive)))
- (insert "--")
- (org-insert-time-stamp time (or org-time-was-given arg) inactive))
- (ts
- ;; Make sure we're on a timestamp. When in the middle of a date
- ;; range, move arbitrarily to range end.
- (unless (org-at-timestamp-p 'lax)
- (skip-chars-forward "-")
- (org-at-timestamp-p 'lax))
- (replace-match "")
- (setq org-last-changed-timestamp
- (org-insert-time-stamp
- time (or org-time-was-given arg)
- inactive nil nil (list org-end-time-was-given)))
- (when repeater
- (backward-char)
- (insert " " repeater)
- (setq org-last-changed-timestamp
- (concat (substring org-last-inserted-timestamp 0 -1)
- " " repeater ">")))
- (message "Timestamp updated"))
- ((equal arg '(16)) (org-insert-time-stamp time t inactive))
- (t (org-insert-time-stamp
- time (or org-time-was-given arg) inactive nil nil
- (list org-end-time-was-given))))))
- ;; FIXME: can we use this for something else, like computing time differences?
- (defun org-get-compact-tod (s)
- (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
- (let* ((t1 (match-string 1 s))
- (h1 (string-to-number (match-string 2 s)))
- (m1 (string-to-number (match-string 3 s)))
- (t2 (and (match-end 4) (match-string 5 s)))
- (h2 (and t2 (string-to-number (match-string 6 s))))
- (m2 (and t2 (string-to-number (match-string 7 s))))
- dh dm)
- (if (not t2)
- t1
- (setq dh (- h2 h1) dm (- m2 m1))
- (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
- (concat t1 "+" (number-to-string dh)
- (and (/= 0 dm) (format ":%02d" dm)))))))
- (defun org-time-stamp-inactive (&optional arg)
- "Insert an inactive time stamp.
- An inactive time stamp is enclosed in square brackets instead of
- angle brackets. It is inactive in the sense that it does not
- trigger agenda entries. So these are more for recording a
- certain time/date.
- If the user specifies a time like HH:MM or if this command is called with
- at least one prefix argument, the time stamp contains the date and the time.
- Otherwise, only the date is included.
- When called with two universal prefix arguments, insert an inactive time stamp
- with the current time without prompting the user."
- (interactive "P")
- (org-time-stamp arg 'inactive))
- (defvar org-date-ovl (make-overlay 1 1))
- (overlay-put org-date-ovl 'face 'org-date-selected)
- (delete-overlay org-date-ovl)
- (defvar org-ans1) ; dynamically scoped parameter
- (defvar org-ans2) ; dynamically scoped parameter
- (defvar org-plain-time-of-day-regexp) ; defined below
- (defvar org-overriding-default-time nil) ; dynamically scoped
- (defvar org-read-date-overlay nil)
- (defvar org-read-date-history nil)
- (defvar org-read-date-final-answer nil)
- (defvar org-read-date-analyze-futurep nil)
- (defvar org-read-date-analyze-forced-year nil)
- (defvar org-read-date-inactive)
- (defvar org-def)
- (defvar org-defdecode)
- (defvar org-with-time)
- (defvar calendar-setup) ; Dynamically scoped.
- (defun org-read-date (&optional with-time to-time from-string prompt
- default-time default-input inactive)
- "Read a date, possibly a time, and make things smooth for the user.
- The prompt will suggest to enter an ISO date, but you can also enter anything
- which will at least partially be understood by `parse-time-string'.
- Unrecognized parts of the date will default to the current day, month, year,
- hour and minute. If this command is called to replace a timestamp at point,
- or to enter the second timestamp of a range, the default time is taken
- from the existing stamp. Furthermore, the command prefers the future,
- so if you are giving a date where the year is not given, and the day-month
- combination is already past in the current year, it will assume you
- mean next year. For details, see the manual. A few examples:
- 3-2-5 --> 2003-02-05
- feb 15 --> currentyear-02-15
- 2/15 --> currentyear-02-15
- sep 12 9 --> 2009-09-12
- 12:45 --> today 12:45
- 22 sept 0:34 --> currentyear-09-22 0:34
- 12 --> currentyear-currentmonth-12
- Fri --> nearest Friday after today
- -Tue --> last Tuesday
- etc.
- Furthermore you can specify a relative date by giving, as the *first* thing
- in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
- change in days weeks, months, years.
- With a single plus or minus, the date is relative to today. With a double
- plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
- +4d --> four days from today
- +4 --> same as above
- +2w --> two weeks from today
- ++5 --> five days from default date
- The function understands only English month and weekday abbreviations.
- While prompting, a calendar is popped up - you can also select the
- date with the mouse (button 1). The calendar shows a period of three
- months. To scroll it to other months, use the keys `>' and `<'.
- There are many other calendar navigation commands available, see
- Info node `(org) The date/time prompt' for a full list.
- If you don't like the calendar, turn it off with
- (setq org-read-date-popup-calendar nil)
- With optional argument TO-TIME, the date will immediately be converted
- to an internal time.
- With an optional argument WITH-TIME, the prompt will suggest to
- also insert a time. Note that when WITH-TIME is not set, you can
- still enter a time, and this function will inform the calling routine
- about this change. The calling routine may then choose to change the
- format used to insert the time stamp into the buffer to include the time.
- With optional argument FROM-STRING, read from this string instead from
- the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
- the time/date that is used for everything that is not specified by the
- user."
- (require 'parse-time)
- (let* ((org-with-time with-time)
- (org-time-stamp-rounding-minutes
- (if (equal org-with-time '(16))
- '(0 0)
- org-time-stamp-rounding-minutes))
- (ct (org-current-time))
- (org-def (or org-overriding-default-time default-time ct))
- (org-defdecode (decode-time org-def))
- (cur-frame (selected-frame))
- (mouse-autoselect-window nil) ; Don't let the mouse jump
- (calendar-setup
- (and (eq calendar-setup 'calendar-only) 'calendar-only))
- (calendar-move-hook nil)
- (calendar-view-diary-initially-flag nil)
- (calendar-view-holidays-initially-flag nil)
- ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
- ;; Rationalize `org-def' and `org-defdecode', if required.
- (when (< (nth 2 org-defdecode) org-extend-today-until)
- (setf (nth 2 org-defdecode) -1)
- (setf (nth 1 org-defdecode) 59)
- (setq org-def (org-encode-time org-defdecode))
- (setq org-defdecode (decode-time org-def)))
- (let* ((timestr (format-time-string
- (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d")
- org-def))
- (prompt (concat (if prompt (concat prompt " ") "")
- (format "Date+time [%s]: " timestr))))
- (cond
- (from-string (setq ans from-string))
- (org-read-date-popup-calendar
- (save-excursion
- (save-window-excursion
- (calendar)
- (when (eq calendar-setup 'calendar-only)
- (setq cal-frame
- (window-frame (get-buffer-window "*Calendar*" 'visible)))
- (select-frame cal-frame))
- (org-eval-in-calendar '(setq cursor-type nil) t)
- (unwind-protect
- (progn
- (calendar-forward-day (- (time-to-days org-def)
- (calendar-absolute-from-gregorian
- (calendar-current-date))))
- (org-eval-in-calendar nil t)
- (let* ((old-map (current-local-map))
- (map (copy-keymap calendar-mode-map))
- (minibuffer-local-map
- (copy-keymap org-read-date-minibuffer-local-map)))
- (org-defkey map (kbd "RET") 'org-calendar-select)
- (org-defkey map [mouse-1] 'org-calendar-select-mouse)
- (org-defkey map [mouse-2] 'org-calendar-select-mouse)
- (unwind-protect
- (progn
- (use-local-map map)
- (setq org-read-date-inactive inactive)
- (add-hook 'post-command-hook 'org-read-date-display)
- (setq org-ans0
- (read-string prompt
- default-input
- 'org-read-date-history
- nil))
- ;; org-ans0: from prompt
- ;; org-ans1: from mouse click
- ;; org-ans2: from calendar motion
- (setq ans
- (concat org-ans0 " " (or org-ans1 org-ans2))))
- (remove-hook 'post-command-hook 'org-read-date-display)
- (use-local-map old-map)
- (when org-read-date-overlay
- (delete-overlay org-read-date-overlay)
- (setq org-read-date-overlay nil)))))
- (bury-buffer "*Calendar*")
- (when cal-frame
- (delete-frame cal-frame)
- (select-frame-set-input-focus cur-frame))))))
- (t ; Naked prompt only
- (unwind-protect
- (setq ans (read-string prompt default-input
- 'org-read-date-history timestr))
- (when org-read-date-overlay
- (delete-overlay org-read-date-overlay)
- (setq org-read-date-overlay nil))))))
- (setq final (org-read-date-analyze ans org-def org-defdecode))
- (when org-read-date-analyze-forced-year
- (message "Year was forced into %s"
- (if org-read-date-force-compatible-dates
- "compatible range (1970-2037)"
- "range representable on this machine"))
- (ding))
- (setq final (org-encode-time final))
- (setq org-read-date-final-answer ans)
- (if to-time
- final
- ;; This round-trip gets rid of 34th of August and stuff like that....
- (setq final (decode-time final))
- (if (and (boundp 'org-time-was-given) org-time-was-given)
- (format "%04d-%02d-%02d %02d:%02d"
- (nth 5 final) (nth 4 final) (nth 3 final)
- (nth 2 final) (nth 1 final))
- (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
- (defun org-read-date-display ()
- "Display the current date prompt interpretation in the minibuffer."
- (when org-read-date-display-live
- (when org-read-date-overlay
- (delete-overlay org-read-date-overlay))
- (when (minibufferp (current-buffer))
- (save-excursion
- (end-of-line 1)
- (while (not (equal (buffer-substring
- (max (point-min) (- (point) 4)) (point))
- " "))
- (insert " ")))
- (let* ((ans (concat (buffer-substring (line-beginning-position) (point-max))
- " " (or org-ans1 org-ans2)))
- (org-end-time-was-given nil)
- (f (org-read-date-analyze ans org-def org-defdecode))
- (fmts (if org-display-custom-times
- org-time-stamp-custom-formats
- org-time-stamp-formats))
- (fmt (if (or org-with-time
- (and (boundp 'org-time-was-given) org-time-was-given))
- (cdr fmts)
- (car fmts)))
- (txt (format-time-string fmt (org-encode-time f)))
- (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
- (txt (concat "=> " txt)))
- (when (and org-end-time-was-given
- (string-match org-plain-time-of-day-regexp txt))
- (setq txt (concat (substring txt 0 (match-end 0)) "-"
- org-end-time-was-given
- (substring txt (match-end 0)))))
- (when org-read-date-analyze-futurep
- (setq txt (concat txt " (=>F)")))
- (setq org-read-date-overlay
- (make-overlay (1- (line-end-position)) (line-end-position)))
- (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
- (defun org-read-date-analyze (ans def defdecode)
- "Analyze the combined answer of the date prompt."
- ;; FIXME: cleanup and comment
- (let ((org-def def)
- (org-defdecode defdecode)
- (nowdecode (decode-time))
- delta deltan deltaw deltadef year month day
- hour minute second wday pm h2 m2 tl wday1
- iso-year iso-weekday iso-week iso-date futurep kill-year)
- (setq org-read-date-analyze-futurep nil
- org-read-date-analyze-forced-year nil)
- (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
- (setq ans "+0"))
- (when (setq delta (org-read-date-get-relative ans nil org-def))
- (setq ans (replace-match "" t t ans)
- deltan (car delta)
- deltaw (nth 1 delta)
- deltadef (nth 2 delta)))
- ;; Check if there is an iso week date in there. If yes, store the
- ;; info and postpone interpreting it until the rest of the parsing
- ;; is done.
- (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
- (setq iso-year (when (match-end 1)
- (org-small-year-to-year
- (string-to-number (match-string 1 ans))))
- iso-weekday (when (match-end 3)
- (string-to-number (match-string 3 ans)))
- iso-week (string-to-number (match-string 2 ans)))
- (setq ans (replace-match "" t t ans)))
- ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
- (when (string-match
- "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
- (setq year (if (match-end 2)
- (string-to-number (match-string 2 ans))
- (progn (setq kill-year t)
- (string-to-number (format-time-string "%Y"))))
- month (string-to-number (match-string 3 ans))
- day (string-to-number (match-string 4 ans)))
- (setq year (org-small-year-to-year year))
- (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
- t nil ans)))
- ;; Help matching dotted european dates
- (when (string-match
- "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
- (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
- (setq kill-year t)
- (string-to-number (format-time-string "%Y")))
- day (string-to-number (match-string 1 ans))
- month (string-to-number (match-string 2 ans))
- ans (replace-match (format "%04d-%02d-%02d" year month day)
- t nil ans)))
- ;; Help matching american dates, like 5/30 or 5/30/7
- (when (string-match
- "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
- (setq year (if (match-end 4)
- (string-to-number (match-string 4 ans))
- (progn (setq kill-year t)
- (string-to-number (format-time-string "%Y"))))
- month (string-to-number (match-string 1 ans))
- day (string-to-number (match-string 2 ans)))
- (setq year (org-small-year-to-year year))
- (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
- t nil ans)))
- ;; Help matching am/pm times, because `parse-time-string' does not do that.
- ;; If there is a time with am/pm, and *no* time without it, we convert
- ;; so that matching will be successful.
- (cl-loop for i from 1 to 2 do ; twice, for end time as well
- (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
- (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
- (setq hour (string-to-number (match-string 1 ans))
- minute (if (match-end 3)
- (string-to-number (match-string 3 ans))
- 0)
- pm (equal ?p
- (string-to-char (downcase (match-string 4 ans)))))
- (if (and (= hour 12) (not pm))
- (setq hour 0)
- (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
- (setq ans (replace-match (format "%02d:%02d" hour minute)
- t t ans))))
- ;; Help matching HHhMM times, similarly as for am/pm times.
- (cl-loop for i from 1 to 2 do ; twice, for end time as well
- (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
- (string-match "\\(?:\\(?1:[012]?[0-9]\\)?h\\(?2:[0-5][0-9]\\)\\)\\|\\(?:\\(?1:[012]?[0-9]\\)h\\(?2:[0-5][0-9]\\)?\\)\\>" ans))
- (setq hour (if (match-end 1)
- (string-to-number (match-string 1 ans))
- 0)
- minute (if (match-end 2)
- (string-to-number (match-string 2 ans))
- 0))
- (setq ans (replace-match (format "%02d:%02d" hour minute)
- t t ans))))
- ;; Check if a time range is given as a duration
- (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
- (setq hour (string-to-number (match-string 1 ans))
- h2 (+ hour (string-to-number (match-string 3 ans)))
- minute (string-to-number (match-string 2 ans))
- m2 (+ minute (if (match-end 5) (string-to-number
- (match-string 5 ans))0)))
- (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
- (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
- t t ans)))
- ;; Check if there is a time range
- (when (boundp 'org-end-time-was-given)
- (setq org-time-was-given nil)
- (when (and (string-match org-plain-time-of-day-regexp ans)
- (match-end 8))
- (setq org-end-time-was-given (match-string 8 ans))
- (setq ans (concat (substring ans 0 (match-beginning 7))
- (substring ans (match-end 7))))))
- (setq tl (parse-time-string ans)
- day (or (nth 3 tl) (nth 3 org-defdecode))
- month
- (cond ((nth 4 tl))
- ((not org-read-date-prefer-future) (nth 4 org-defdecode))
- ;; Day was specified. Make sure DAY+MONTH
- ;; combination happens in the future.
- ((nth 3 tl)
- (setq futurep t)
- (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
- (nth 4 nowdecode)))
- (t (nth 4 org-defdecode)))
- year
- (cond ((and (not kill-year) (nth 5 tl)))
- ((not org-read-date-prefer-future) (nth 5 org-defdecode))
- ;; Month was guessed in the future and is at least
- ;; equal to NOWDECODE's. Fix year accordingly.
- (futurep
- (if (or (> month (nth 4 nowdecode))
- (>= day (nth 3 nowdecode)))
- (nth 5 nowdecode)
- (1+ (nth 5 nowdecode))))
- ;; Month was specified. Make sure MONTH+YEAR
- ;; combination happens in the future.
- ((nth 4 tl)
- (setq futurep t)
- (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
- ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
- ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
- (t (nth 5 nowdecode))))
- (t (nth 5 org-defdecode)))
- hour (or (nth 2 tl) (nth 2 org-defdecode))
- minute (or (nth 1 tl) (nth 1 org-defdecode))
- second (or (nth 0 tl) 0)
- wday (nth 6 tl))
- (when (and (eq org-read-date-prefer-future 'time)
- (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
- (equal day (nth 3 nowdecode))
- (equal month (nth 4 nowdecode))
- (equal year (nth 5 nowdecode))
- (nth 2 tl)
- (or (< (nth 2 tl) (nth 2 nowdecode))
- (and (= (nth 2 tl) (nth 2 nowdecode))
- (nth 1 tl)
- (< (nth 1 tl) (nth 1 nowdecode)))))
- (setq day (1+ day)
- futurep t))
- ;; Special date definitions below
- (cond
- (iso-week
- ;; There was an iso week
- (require 'cal-iso)
- (setq futurep nil)
- (setq year (or iso-year year)
- day (or iso-weekday wday 1)
- wday nil ; to make sure that the trigger below does not match
- iso-date (calendar-gregorian-from-absolute
- (calendar-iso-to-absolute
- (list iso-week day year))))
- ; FIXME: Should we also push ISO weeks into the future?
- ; (when (and org-read-date-prefer-future
- ; (not iso-year)
- ; (< (calendar-absolute-from-gregorian iso-date)
- ; (time-to-days nil)))
- ; (setq year (1+ year)
- ; iso-date (calendar-gregorian-from-absolute
- ; (calendar-iso-to-absolute
- ; (list iso-week day year)))))
- (setq month (car iso-date)
- year (nth 2 iso-date)
- day (nth 1 iso-date)))
- (deltan
- (setq futurep nil)
- (unless deltadef
- (let ((now (decode-time)))
- (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
- (cond ((member deltaw '("h" ""))
- (when (boundp 'org-time-was-given)
- (setq org-time-was-given t))
- (setq hour (+ hour deltan)))
- ((member deltaw '("d" "")) (setq day (+ day deltan)))
- ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
- ((equal deltaw "m") (setq month (+ month deltan)))
- ((equal deltaw "y") (setq year (+ year deltan)))))
- ((and wday (not (nth 3 tl)))
- ;; Weekday was given, but no day, so pick that day in the week
- ;; on or after the derived date.
- (setq wday1 (nth 6 (decode-time (org-encode-time 0 0 0 day month year))))
- (unless (equal wday wday1)
- (setq day (+ day (% (- wday wday1 -7) 7))))))
- (when (and (boundp 'org-time-was-given)
- (nth 2 tl))
- (setq org-time-was-given t))
- (when (< year 100) (setq year (+ 2000 year)))
- ;; Check of the date is representable
- (if org-read-date-force-compatible-dates
- (progn
- (when (< year 1970)
- (setq year 1970 org-read-date-analyze-forced-year t))
- (when (> year 2037)
- (setq year 2037 org-read-date-analyze-forced-year t)))
- (condition-case nil
- (ignore (org-encode-time second minute hour day month year))
- (error
- (setq year (nth 5 org-defdecode))
- (setq org-read-date-analyze-forced-year t))))
- (setq org-read-date-analyze-futurep futurep)
- (list second minute hour day month year nil -1 nil)))
- (defvar parse-time-weekdays)
- (defun org-read-date-get-relative (s today default)
- "Check string S for special relative date string.
- TODAY and DEFAULT are internal times, for today and for a default.
- Return shift list (N what def-flag)
- WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
- N is the number of WHATs to shift.
- DEF-FLAG is t when a double ++ or -- indicates shift relative to
- the DEFAULT date rather than TODAY."
- (require 'parse-time)
- (when (and
- (string-match
- (concat
- "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
- "\\([0-9]+\\)?"
- "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
- "\\([ \t]\\|$\\)") s)
- (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
- (let* ((dir (if (> (match-end 1) (match-beginning 1))
- (string-to-char (substring (match-string 1 s) -1))
- ?+))
- (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
- (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
- (what (if (match-end 3) (match-string 3 s) "d"))
- (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
- (date (if rel default today))
- (wday (nth 6 (decode-time date)))
- delta)
- (if wday1
- (progn
- (setq delta (mod (+ 7 (- wday1 wday)) 7))
- (when (= delta 0) (setq delta 7))
- (when (= dir ?-)
- (setq delta (- delta 7))
- (when (= delta 0) (setq delta -7)))
- (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
- (list delta "d" rel))
- (list (* n (if (= dir ?-) -1 1)) what rel)))))
- (defun org-order-calendar-date-args (arg1 arg2 arg3)
- "Turn a user-specified date into the internal representation.
- The internal representation needed by the calendar is (month day year).
- This is a wrapper to handle the brain-dead convention in calendar that
- user function argument order change dependent on argument order."
- (pcase calendar-date-style
- (`american (list arg1 arg2 arg3))
- (`european (list arg2 arg1 arg3))
- (`iso (list arg2 arg3 arg1))))
- (defun org-eval-in-calendar (form &optional keepdate)
- "Eval FORM in the calendar window and return to current window.
- Unless KEEPDATE is non-nil, update `org-ans2' to the cursor date."
- (let ((sf (selected-frame))
- (sw (selected-window)))
- (select-window (get-buffer-window "*Calendar*" t))
- (eval form t)
- (when (and (not keepdate) (calendar-cursor-to-date))
- (let* ((date (calendar-cursor-to-date))
- (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
- (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
- (select-window sw)
- (select-frame-set-input-focus sf)))
- (defun org-calendar-select ()
- "Return to `org-read-date' with the date currently selected.
- This is used by `org-read-date' in a temporary keymap for the calendar buffer."
- (interactive)
- (when (calendar-cursor-to-date)
- (let* ((date (calendar-cursor-to-date))
- (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
- (when (active-minibuffer-window) (exit-minibuffer))))
- (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
- "Insert a date stamp for the date given by the internal TIME.
- See `format-time-string' for the format of TIME.
- WITH-HM means use the stamp format that includes the time of the day.
- INACTIVE means use square brackets instead of angular ones, so that the
- stamp will not contribute to the agenda.
- PRE and POST are optional strings to be inserted before and after the
- stamp.
- The command returns the inserted time stamp."
- (org-fold-core-ignore-modifications
- (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
- stamp)
- (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
- (insert-before-markers-and-inherit (or pre ""))
- (when (listp extra)
- (setq extra (car extra))
- (if (and (stringp extra)
- (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
- (setq extra (format "-%02d:%02d"
- (string-to-number (match-string 1 extra))
- (string-to-number (match-string 2 extra))))
- (setq extra nil)))
- (when extra
- (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
- (insert-before-markers-and-inherit (setq stamp (format-time-string fmt time)))
- (insert-before-markers-and-inherit (or post ""))
- (setq org-last-inserted-timestamp stamp))))
- (defun org-toggle-time-stamp-overlays ()
- "Toggle the use of custom time stamp formats."
- (interactive)
- (setq org-display-custom-times (not org-display-custom-times))
- (unless org-display-custom-times
- (let ((p (point-min)) (bmp (buffer-modified-p)))
- (while (setq p (next-single-property-change p 'display))
- (when (and (get-text-property p 'display)
- (eq (get-text-property p 'face) 'org-date))
- (remove-text-properties
- p (setq p (next-single-property-change p 'display))
- '(display t))))
- (set-buffer-modified-p bmp)))
- (org-restart-font-lock)
- (setq org-table-may-need-update t)
- (if org-display-custom-times
- (message "Time stamps are overlaid with custom format")
- (message "Time stamp overlays removed")))
- (defun org-display-custom-time (beg end)
- "Overlay modified time stamp format over timestamp between BEG and END."
- (let* ((ts (buffer-substring beg end))
- t1 with-hm tf time str (off 0))
- (save-match-data
- (setq t1 (org-parse-time-string ts t))
- (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
- (setq off (- (match-end 0) (match-beginning 0)))))
- (setq end (- end off))
- (setq with-hm (and (nth 1 t1) (nth 2 t1))
- tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
- time (org-fix-decoded-time t1)
- str (org-add-props
- (format-time-string
- (substring tf 1 -1) (org-encode-time time))
- nil 'mouse-face 'highlight))
- (put-text-property beg end 'display str)))
- (defun org-fix-decoded-time (time)
- "Set 0 instead of nil for the first 6 elements of time.
- Don't touch the rest."
- (let ((n 0))
- (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
- (defun org-time-stamp-to-now (timestamp-string &optional seconds)
- "Difference between TIMESTAMP-STRING and now in days.
- If SECONDS is non-nil, return the difference in seconds."
- (let ((fdiff (if seconds #'float-time #'time-to-days)))
- (- (funcall fdiff (org-time-string-to-time timestamp-string))
- (funcall fdiff nil))))
- (defun org-deadline-close-p (timestamp-string &optional ndays)
- "Is the time in TIMESTAMP-STRING close to the current date?"
- (setq ndays (or ndays (org-get-wdays timestamp-string)))
- (and (<= (org-time-stamp-to-now timestamp-string) ndays)
- (not (org-entry-is-done-p))))
- (defun org-get-wdays (ts &optional delay zero-delay)
- "Get the deadline lead time appropriate for timestring TS.
- When DELAY is non-nil, get the delay time for scheduled items
- instead of the deadline lead time. When ZERO-DELAY is non-nil
- and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
- don't try to find the delay cookie in the scheduled timestamp."
- (let ((tv (if delay org-scheduled-delay-days
- org-deadline-warning-days)))
- (cond
- ((or (and delay (< tv 0))
- (and delay zero-delay (<= tv 0))
- (and (not delay) (<= tv 0)))
- ;; Enforce this value no matter what
- (- tv))
- ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
- ;; lead time is specified.
- (floor (* (string-to-number (match-string 1 ts))
- (cdr (assoc (match-string 2 ts)
- '(("d" . 1) ("w" . 7)
- ("m" . 30.4) ("y" . 365.25)
- ("h" . 0.041667)))))))
- ;; go for the default.
- (t tv))))
- (defun org-calendar-select-mouse (ev)
- "Return to `org-read-date' with the date currently selected.
- This is used by `org-read-date' in a temporary keymap for the calendar buffer."
- (interactive "e")
- (mouse-set-point ev)
- (when (calendar-cursor-to-date)
- (let* ((date (calendar-cursor-to-date))
- (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
- (when (active-minibuffer-window) (exit-minibuffer))))
- (defun org-check-deadlines (ndays)
- "Check if there are any deadlines due or past due.
- A deadline is considered due if it happens within `org-deadline-warning-days'
- days from today's date. If the deadline appears in an entry marked DONE,
- it is not shown. A numeric prefix argument NDAYS can be used to test that
- many days. If the prefix is a raw `\\[universal-argument]', all deadlines \
- are shown."
- (interactive "P")
- (let* ((org-warn-days
- (cond
- ((equal ndays '(4)) 100000)
- (ndays (prefix-numeric-value ndays))
- (t (abs org-deadline-warning-days))))
- (case-fold-search nil)
- (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
- (callback
- (lambda () (org-deadline-close-p (match-string 1) org-warn-days))))
- (message "%d deadlines past-due or due within %d days"
- (org-occur regexp nil callback)
- org-warn-days)))
- (defsubst org-re-timestamp (type)
- "Return a regexp for timestamp TYPE.
- Allowed values for TYPE are:
- all: all timestamps
- active: only active timestamps (<...>)
- inactive: only inactive timestamps ([...])
- scheduled: only scheduled timestamps
- deadline: only deadline timestamps
- closed: only closed time-stamps
- When TYPE is nil, fall back on returning a regexp that matches
- both scheduled and deadline timestamps."
- (cl-case type
- (all org-ts-regexp-both)
- (active org-ts-regexp)
- (inactive org-ts-regexp-inactive)
- (scheduled org-scheduled-time-regexp)
- (deadline org-deadline-time-regexp)
- (closed org-closed-time-regexp)
- (otherwise
- (concat "\\<"
- (regexp-opt (list org-deadline-string org-scheduled-string))
- " *<\\([^>]+\\)>"))))
- (defun org-check-before-date (d)
- "Check if there are deadlines or scheduled entries before date D."
- (interactive (list (org-read-date)))
- (let* ((case-fold-search nil)
- (regexp (org-re-timestamp org-ts-type))
- (ts-type org-ts-type)
- (callback
- (lambda ()
- (let ((match (match-string 1)))
- (and (if (memq ts-type '(active inactive all))
- (eq (org-element-type (save-excursion
- (backward-char)
- (org-element-context)))
- 'timestamp)
- (org-at-planning-p))
- (time-less-p
- (org-time-string-to-time match)
- (org-time-string-to-time d)))))))
- (message "%d entries before %s"
- (org-occur regexp nil callback)
- d)))
- (defun org-check-after-date (d)
- "Check if there are deadlines or scheduled entries after date D."
- (interactive (list (org-read-date)))
- (let* ((case-fold-search nil)
- (regexp (org-re-timestamp org-ts-type))
- (ts-type org-ts-type)
- (callback
- (lambda ()
- (let ((match (match-string 1)))
- (and (if (memq ts-type '(active inactive all))
- (eq (org-element-type (save-excursion
- (backward-char)
- (org-element-context)))
- 'timestamp)
- (org-at-planning-p))
- (not (time-less-p
- (org-time-string-to-time match)
- (org-time-string-to-time d))))))))
- (message "%d entries after %s"
- (org-occur regexp nil callback)
- d)))
- (defun org-check-dates-range (start-date end-date)
- "Check for deadlines/scheduled entries between START-DATE and END-DATE."
- (interactive (list (org-read-date nil nil nil "Range starts")
- (org-read-date nil nil nil "Range end")))
- (let ((case-fold-search nil)
- (regexp (org-re-timestamp org-ts-type))
- (callback
- (let ((type org-ts-type))
- (lambda ()
- (let ((match (match-string 1)))
- (and
- (if (memq type '(active inactive all))
- (eq (org-element-type (save-excursion
- (backward-char)
- (org-element-context)))
- 'timestamp)
- (org-at-planning-p))
- (not (time-less-p
- (org-time-string-to-time match)
- (org-time-string-to-time start-date)))
- (time-less-p
- (org-time-string-to-time match)
- (org-time-string-to-time end-date))))))))
- (message "%d entries between %s and %s"
- (org-occur regexp nil callback) start-date end-date)))
- (defun org-evaluate-time-range (&optional to-buffer)
- "Evaluate a time range by computing the difference between start and end.
- Normally the result is just printed in the echo area, but with prefix arg
- TO-BUFFER, the result is inserted just after the date stamp into the buffer.
- If the time range is actually in a table, the result is inserted into the
- next column.
- For time difference computation, a year is assumed to be exactly 365
- days in order to avoid rounding problems."
- (interactive "P")
- (or
- (org-clock-update-time-maybe)
- (save-excursion
- (unless (org-at-date-range-p t)
- (goto-char (line-beginning-position))
- (re-search-forward org-tr-regexp-both (line-end-position) t))
- (unless (org-at-date-range-p t)
- (user-error "Not at a time-stamp range, and none found in current line")))
- (let* ((ts1 (match-string 1))
- (ts2 (match-string 2))
- (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
- (match-end (match-end 0))
- (time1 (org-time-string-to-time ts1))
- (time2 (org-time-string-to-time ts2))
- (diff (abs (float-time (time-subtract time2 time1))))
- (negative (time-less-p time2 time1))
- ;; (ys (floor (* 365 24 60 60)))
- (ds (* 24 60 60))
- (hs (* 60 60))
- (fy "%dy %dd %02d:%02d")
- (fy1 "%dy %dd")
- (fd "%dd %02d:%02d")
- (fd1 "%dd")
- (fh "%02d:%02d")
- y d h m align)
- (if havetime
- (setq ; y (floor diff ys) diff (mod diff ys)
- y 0
- d (floor diff ds) diff (mod diff ds)
- h (floor diff hs) diff (mod diff hs)
- m (floor diff 60))
- (setq ; y (floor diff ys) diff (mod diff ys)
- y 0
- d (round diff ds)
- h 0 m 0))
- (if (not to-buffer)
- (message "%s" (org-make-tdiff-string y d h m))
- (if (org-at-table-p)
- (progn
- (goto-char match-end)
- (setq align t)
- (and (looking-at " *|") (goto-char (match-end 0))))
- (goto-char match-end))
- (when (looking-at
- "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
- (replace-match ""))
- (when negative (insert " -"))
- (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
- (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
- (insert " " (format fh h m))))
- (when align (org-table-align))
- (message "Time difference inserted")))))
- (defun org-make-tdiff-string (y d h m)
- (let ((fmt "")
- (l nil))
- (when (> y 0)
- (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
- (push y l))
- (when (> d 0)
- (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
- (push d l))
- (when (> h 0)
- (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
- (push h l))
- (when (> m 0)
- (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
- (push m l))
- (apply 'format fmt (nreverse l))))
- (defun org-time-string-to-time (s)
- "Convert timestamp string S into internal time."
- (org-encode-time (org-parse-time-string s)))
- (defun org-time-string-to-seconds (s)
- "Convert a timestamp string S into a number of seconds."
- (float-time (org-time-string-to-time s)))
- (define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
- (defun org-time-string-to-absolute (s &optional daynr prefer buffer pos)
- "Convert time stamp S to an absolute day number.
- If DAYNR in non-nil, and there is a specifier for a cyclic time
- stamp, get the closest date to DAYNR. If PREFER is
- `past' (respectively `future') return a date past (respectively
- after) or equal to DAYNR.
- POS is the location of time stamp S, as a buffer position in
- BUFFER.
- Diary sexp timestamps are matched against DAYNR, when non-nil.
- If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
- signaled."
- (cond
- ((string-match "\\`%%\\((.*)\\)" s)
- ;; Sexp timestamp: try to match DAYNR, if available, since we're
- ;; only able to match individual dates. If it fails, raise an
- ;; error.
- (if (and daynr
- (org-diary-sexp-entry
- (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
- daynr
- (signal 'org-diary-sexp-no-match (list s))))
- (daynr (org-closest-date s daynr prefer))
- (t (time-to-days
- (condition-case errdata
- (org-time-string-to-time s)
- (error (error "Bad timestamp `%s'%s\nError was: %s"
- s
- (if (not (and buffer pos)) ""
- (format-message " at %d in buffer `%s'" pos buffer))
- (cdr errdata))))))))
- (defun org-days-to-iso-week (days)
- "Return the ISO week number."
- (require 'cal-iso)
- (car (calendar-iso-from-absolute days)))
- (defun org-small-year-to-year (year)
- "Convert 2-digit years into 4-digit years.
- YEAR is expanded into one of the 30 next years, if possible, or
- into a past one. Any year larger than 99 is returned unchanged."
- (if (>= year 100) year
- (let* ((current (string-to-number (format-time-string "%Y")))
- (century (/ current 100))
- (offset (- year (% current 100))))
- (cond ((> offset 30) (+ (* (1- century) 100) year))
- ((> offset -70) (+ (* century 100) year))
- (t (+ (* (1+ century) 100) year))))))
- (defun org-time-from-absolute (d)
- "Return the time corresponding to date D.
- D may be an absolute day number, or a calendar-type list (month day year)."
- (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
- (org-encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
- (defvar org-agenda-current-date)
- (defun org-calendar-holiday ()
- "List of holidays, for Diary display in Org mode."
- (require 'holidays)
- (let ((hl (calendar-check-holidays org-agenda-current-date)))
- (and hl (mapconcat #'identity hl "; "))))
- (defvar org--diary-sexp-entry-cache (make-hash-table :test #'equal)
- "Hash table holding return values of `org-diary-sexp-entry'.")
- (defun org-diary-sexp-entry (sexp entry d)
- "Process a SEXP diary ENTRY for date D."
- (require 'diary-lib)
- ;; `org-anniversary' and alike expect ENTRY and DATE to be bound
- ;; dynamically.
- (let ((cached (gethash (list sexp entry d) org--diary-sexp-entry-cache 'none)))
- (if (not (eq 'none cached)) cached
- (puthash (list sexp entry d)
- (let* ((sexp `(let ((entry ,entry)
- (date ',d))
- ,(car (read-from-string sexp))))
- ;; FIXME: Do not use (eval ... t) in the following sexp as
- ;; diary vars are still using dynamic scope.
- (result (if calendar-debug-sexp (eval sexp)
- (condition-case nil
- (eval sexp)
- (error
- (beep)
- (message "Bad sexp at line %d in %s: %s"
- (org-current-line)
- (buffer-file-name) sexp)
- (sleep-for 2))))))
- (cond ((stringp result) (split-string result "; "))
- ((and (consp result)
- (not (consp (cdr result)))
- (stringp (cdr result)))
- (cdr result))
- ((and (consp result)
- (stringp (car result)))
- result)
- (result entry)))
- org--diary-sexp-entry-cache))))
- (defun org-diary-to-ical-string (frombuf)
- "Get iCalendar entries from diary entries in buffer FROMBUF.
- This uses the icalendar.el library."
- (let* ((tmpdir temporary-file-directory)
- (tmpfile (make-temp-name
- (expand-file-name "orgics" tmpdir)))
- buf rtn b e)
- (with-current-buffer frombuf
- (icalendar-export-region (point-min) (point-max) tmpfile)
- (setq buf (find-buffer-visiting tmpfile))
- (set-buffer buf)
- (goto-char (point-min))
- (when (re-search-forward "^BEGIN:VEVENT" nil t)
- (setq b (match-beginning 0)))
- (goto-char (point-max))
- (when (re-search-backward "^END:VEVENT" nil t)
- (setq e (match-end 0)))
- (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
- (kill-buffer buf)
- (delete-file tmpfile)
- rtn))
- (defun org-closest-date (start current prefer)
- "Return closest date to CURRENT starting from START.
- CURRENT and START are both time stamps.
- When PREFER is `past', return a date that is either CURRENT or
- past. When PREFER is `future', return a date that is either
- CURRENT or future.
- Only time stamps with a repeater are modified. Any other time
- stamp stay unchanged. In any case, return value is an absolute
- day number."
- (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
- ;; No repeater. Do not shift time stamp.
- (time-to-days (org-time-string-to-time start))
- (let ((value (string-to-number (match-string 1 start)))
- (type (match-string 2 start)))
- (if (= 0 value)
- ;; Repeater with a 0-value is considered as void.
- (time-to-days (org-time-string-to-time start))
- (let* ((base (org-date-to-gregorian start))
- (target (org-date-to-gregorian current))
- (sday (calendar-absolute-from-gregorian base))
- (cday (calendar-absolute-from-gregorian target))
- n1 n2)
- ;; If START is already past CURRENT, just return START.
- (if (<= cday sday) sday
- ;; Compute closest date before (N1) and closest date past
- ;; (N2) CURRENT.
- (pcase type
- ("h"
- (let ((missing-hours
- (mod (+ (- (* 24 (- cday sday))
- (nth 2 (org-parse-time-string start)))
- org-extend-today-until)
- value)))
- (setf n1 (if (= missing-hours 0) cday
- (- cday (1+ (/ missing-hours 24)))))
- (setf n2 (+ cday (/ (- value missing-hours) 24)))))
- ((or "d" "w")
- (let ((value (if (equal type "w") (* 7 value) value)))
- (setf n1 (+ sday (* value (/ (- cday sday) value))))
- (setf n2 (+ n1 value))))
- ("m"
- (let* ((add-months
- (lambda (d n)
- ;; Add N months to gregorian date D, i.e.,
- ;; a list (MONTH DAY YEAR). Return a valid
- ;; gregorian date.
- (let ((m (+ (nth 0 d) n)))
- (list (mod m 12)
- (nth 1 d)
- (+ (/ m 12) (nth 2 d))))))
- (months ; Complete months to TARGET.
- (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
- (- (nth 0 target) (nth 0 base))
- ;; If START's day is greater than
- ;; TARGET's, remove incomplete month.
- (if (> (nth 1 target) (nth 1 base)) 0 -1))
- value)
- value))
- (before (funcall add-months base months)))
- (setf n1 (calendar-absolute-from-gregorian before))
- (setf n2
- (calendar-absolute-from-gregorian
- (funcall add-months before value)))))
- (_
- (let* ((d (nth 1 base))
- (m (nth 0 base))
- (y (nth 2 base))
- (years ; Complete years to TARGET.
- (* (/ (- (nth 2 target)
- y
- ;; If START's month and day are
- ;; greater than TARGET's, remove
- ;; incomplete year.
- (if (or (> (nth 0 target) m)
- (and (= (nth 0 target) m)
- (> (nth 1 target) d)))
- 0
- 1))
- value)
- value))
- (before (list m d (+ y years))))
- (setf n1 (calendar-absolute-from-gregorian before))
- (setf n2 (calendar-absolute-from-gregorian
- (list m d (+ (nth 2 before) value)))))))
- ;; Handle PREFER parameter, if any.
- (cond
- ((eq prefer 'past) (if (= cday n2) n2 n1))
- ((eq prefer 'future) (if (= cday n1) n1 n2))
- (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
- (defun org-date-to-gregorian (d)
- "Turn any specification of date D into a Gregorian date for the calendar."
- (cond ((integerp d) (calendar-gregorian-from-absolute d))
- ((and (listp d) (= (length d) 3)) d)
- ((stringp d)
- (let ((d (org-parse-time-string d)))
- (list (nth 4 d) (nth 3 d) (nth 5 d))))
- ((listp d) (list (nth 4 d) (nth 3 d) (nth 5 d)))))
- (defun org-timestamp-up (&optional arg)
- "Increase the date item at the cursor by one.
- If the cursor is on the year, change the year. If it is on the month,
- the day or the time, change that. If the cursor is on the enclosing
- bracket, change the timestamp type.
- With prefix ARG, change by that many units."
- (interactive "p")
- (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
- (defun org-timestamp-down (&optional arg)
- "Decrease the date item at the cursor by one.
- If the cursor is on the year, change the year. If it is on the month,
- the day or the time, change that. If the cursor is on the enclosing
- bracket, change the timestamp type.
- With prefix ARG, change by that many units."
- (interactive "p")
- (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
- (defun org-timestamp-up-day (&optional arg)
- "Increase the date in the time stamp by one day.
- With prefix ARG, change that many days."
- (interactive "p")
- (if (and (not (org-at-timestamp-p 'lax))
- (org-at-heading-p))
- (org-todo 'up)
- (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
- (defun org-timestamp-down-day (&optional arg)
- "Decrease the date in the time stamp by one day.
- With prefix ARG, change that many days."
- (interactive "p")
- (if (and (not (org-at-timestamp-p 'lax))
- (org-at-heading-p))
- (org-todo 'down)
- (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
- (defun org-at-timestamp-p (&optional extended)
- "Non-nil if point is inside a timestamp.
- By default, the function only consider syntactically valid active
- timestamps. However, the caller may have a broader definition
- for timestamps. As a consequence, optional argument EXTENDED can
- be set to the following values
- `inactive'
- Include also syntactically valid inactive timestamps.
- `agenda'
- Include timestamps allowed in Agenda, i.e., those in
- properties drawers, planning lines and clock lines.
- `lax'
- Ignore context. The function matches any part of the
- document looking like a timestamp. This includes comments,
- example blocks...
- For backward-compatibility with Org 9.0, every other non-nil
- value is equivalent to `inactive'.
- When at a timestamp, return the position of the point as a symbol
- among `bracket', `after', `year', `month', `hour', `minute',
- `day' or a number of character from the last know part of the
- time stamp. If diary sexp timestamps, any point inside the timestamp
- is considered `day' (i.e. only `bracket', `day', and `after' return
- values are possible).
- When matching, the match groups are the following:
- group 1: year, if any
- group 2: month, if any
- group 3: day number, if any
- group 4: day name, if any
- group 5: hours, if any
- group 6: minutes, if any"
- (let* ((regexp
- (if extended
- (if (eq extended 'agenda)
- (rx-to-string
- `(or (regexp ,org-ts-regexp3)
- (regexp ,org-element--timestamp-regexp)))
- org-ts-regexp3)
- org-ts-regexp2))
- (pos (point))
- (match?
- (let ((boundaries (org-in-regexp regexp)))
- (save-match-data
- (cond ((null boundaries) nil)
- ((eq extended 'lax) t)
- (t
- (or (and (eq extended 'agenda)
- (or (org-at-planning-p)
- (org-at-property-p)
- (and (bound-and-true-p
- org-agenda-include-inactive-timestamps)
- (org-at-clock-log-p))))
- (eq 'timestamp
- (save-excursion
- (when (= pos (cdr boundaries)) (forward-char -1))
- (org-element-type (org-element-context)))))))))))
- (cond
- ((not match?) nil)
- ((= pos (match-beginning 0)) 'bracket)
- ;; Distinguish location right before the closing bracket from
- ;; right after it.
- ((= pos (1- (match-end 0))) 'bracket)
- ((= pos (match-end 0)) 'after)
- ((org-pos-in-match-range pos 2) 'year)
- ((org-pos-in-match-range pos 3) 'month)
- ((org-pos-in-match-range pos 7) 'hour)
- ((org-pos-in-match-range pos 8) 'minute)
- ((or (org-pos-in-match-range pos 4)
- (org-pos-in-match-range pos 5)) 'day)
- ((and (or (match-end 8) (match-end 5))
- (> pos (or (match-end 8) (match-end 5)))
- (< pos (match-end 0)))
- (- pos (or (match-end 8) (match-end 5))))
- (t 'day))))
- (defun org-toggle-timestamp-type ()
- "Toggle the type (<active> or [inactive]) of a time stamp."
- (interactive)
- (when (org-at-timestamp-p 'lax)
- (let ((beg (match-beginning 0)) (end (match-end 0))
- (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
- (save-excursion
- (goto-char beg)
- (while (re-search-forward "[][<>]" end t)
- (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
- t t)))
- (message "Timestamp is now %sactive"
- (if (equal (char-after beg) ?<) "" "in")))))
- (defun org-at-clock-log-p ()
- "Non-nil if point is on a clock log line."
- (and (org-match-line org-clock-line-re)
- (eq (org-element-type (save-match-data (org-element-at-point))) 'clock)))
- (defvar org-clock-history) ; defined in org-clock.el
- (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
- (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
- "Change the date in the time stamp at point.
- The date is changed by N times WHAT. WHAT can be `day', `month',
- `year', `hour', or `minute'. If WHAT is not given, the cursor
- position in the timestamp determines what is changed.
- When optional argument UPDOWN is non-nil, minutes are rounded
- according to `org-time-stamp-rounding-minutes'.
- When SUPPRESS-TMP-DELAY is non-nil, suppress delays like
- \"--2d\"."
- (let ((origin (point))
- (timestamp? (org-at-timestamp-p 'lax))
- origin-cat
- with-hm inactive
- (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
- extra rem
- ts time time0 fixnext clrgx)
- (unless timestamp? (user-error "Not at a timestamp"))
- (if (and (not what) (eq timestamp? 'bracket))
- (org-toggle-timestamp-type)
- ;; Point isn't on brackets. Remember the part of the time-stamp
- ;; the point was in. Indeed, size of time-stamps may change,
- ;; but point must be kept in the same category nonetheless.
- (setq origin-cat timestamp?)
- (when (and (not what) (not (eq timestamp? 'day))
- org-display-custom-times
- (get-text-property (point) 'display)
- (not (get-text-property (1- (point)) 'display)))
- (setq timestamp? 'day))
- (setq timestamp? (or what timestamp?)
- inactive (= (char-after (match-beginning 0)) ?\[)
- ts (match-string 0))
- (replace-match "")
- (when (string-match
- "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
- ts)
- (setq extra (match-string 1 ts))
- (when suppress-tmp-delay
- (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
- (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
- (setq with-hm t))
- (setq time0 (org-parse-time-string ts))
- (when (and updown
- (eq timestamp? 'minute)
- (not current-prefix-arg))
- ;; This looks like s-up and s-down. Change by one rounding step.
- (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
- (unless (= 0 (setq rem (% (nth 1 time0) dm)))
- (setcar (cdr time0) (+ (nth 1 time0)
- (if (> n 0) (- rem) (- dm rem))))))
- (setq time
- (org-encode-time
- (apply #'list
- (or (car time0) 0)
- (+ (if (eq timestamp? 'minute) n 0) (nth 1 time0))
- (+ (if (eq timestamp? 'hour) n 0) (nth 2 time0))
- (+ (if (eq timestamp? 'day) n 0) (nth 3 time0))
- (+ (if (eq timestamp? 'month) n 0) (nth 4 time0))
- (+ (if (eq timestamp? 'year) n 0) (nth 5 time0))
- (nthcdr 6 time0))))
- (when (and (memq timestamp? '(hour minute))
- extra
- (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
- (setq extra (org-modify-ts-extra
- extra
- (if (eq timestamp? 'hour) 2 5)
- n dm)))
- (when (integerp timestamp?)
- (setq extra (org-modify-ts-extra extra timestamp? n dm)))
- (when (eq what 'calendar)
- (let ((cal-date (org-get-date-from-calendar)))
- (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
- (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
- (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
- (setcar time0 (or (car time0) 0))
- (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
- (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
- (setq time (org-encode-time time0))))
- ;; Insert the new time-stamp, and ensure point stays in the same
- ;; category as before (i.e. not after the last position in that
- ;; category).
- (let ((pos (point)))
- ;; Stay before inserted string. `save-excursion' is of no use.
- (setq org-last-changed-timestamp
- (org-insert-time-stamp time with-hm inactive nil nil extra))
- (goto-char pos))
- (save-match-data
- (looking-at org-ts-regexp3)
- (goto-char
- (pcase origin-cat
- ;; `day' category ends before `hour' if any, or at the end
- ;; of the day name.
- (`day (min (or (match-beginning 7) (1- (match-end 5))) origin))
- (`hour (min (match-end 7) origin))
- (`minute (min (1- (match-end 8)) origin))
- ((pred integerp) (min (1- (match-end 0)) origin))
- ;; Point was right after the time-stamp. However, the
- ;; time-stamp length might have changed, so refer to
- ;; (match-end 0) instead.
- (`after (match-end 0))
- ;; `year' and `month' have both fixed size: point couldn't
- ;; have moved into another part.
- (_ origin))))
- ;; Update clock if on a CLOCK line.
- (org-clock-update-time-maybe)
- ;; Maybe adjust the closest clock in `org-clock-history'
- (when org-clock-adjust-closest
- (if (not (and (org-at-clock-log-p)
- (< 1 (length (delq nil (mapcar 'marker-position
- org-clock-history))))))
- (message "No clock to adjust")
- (cond ((save-excursion ; fix previous clock?
- (re-search-backward org-ts-regexp0 nil t)
- (looking-back (concat org-clock-string " \\[")
- (line-beginning-position)))
- (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
- ((save-excursion ; fix next clock?
- (re-search-backward org-ts-regexp0 nil t)
- (looking-at (concat org-ts-regexp0 "\\] =>")))
- (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
- (save-window-excursion
- ;; Find closest clock to point, adjust the previous/next one in history
- (let* ((p (save-excursion (org-back-to-heading t)))
- (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
- (clfixnth
- (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
- (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
- (if (not clfixpos)
- (message "No clock to adjust")
- (save-excursion
- (org-goto-marker-or-bmk clfixpos)
- (org-fold-show-subtree)
- (when (re-search-forward clrgx nil t)
- (goto-char (match-beginning 1))
- (let (org-clock-adjust-closest)
- (org-timestamp-change n timestamp? updown))
- (message "Clock adjusted in %s for heading: %s"
- (file-name-nondirectory (buffer-file-name))
- (org-get-heading t t)))))))))
- ;; Try to recenter the calendar window, if any.
- (when (and org-calendar-follow-timestamp-change
- (get-buffer-window "*Calendar*" t)
- (memq timestamp? '(day month year)))
- (org-recenter-calendar (time-to-days time))))))
- (defun org-modify-ts-extra (s pos n dm)
- "Change the different parts of the lead-time and repeat fields in timestamp."
- (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
- ng h m new rem)
- (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
- (cond
- ((or (org-pos-in-match-range pos 2)
- (org-pos-in-match-range pos 3))
- (setq m (string-to-number (match-string 3 s))
- h (string-to-number (match-string 2 s)))
- (if (org-pos-in-match-range pos 2)
- (setq h (+ h n))
- (setq n (* dm (with-no-warnings (cl-signum n))))
- (unless (= 0 (setq rem (% m dm)))
- (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
- (setq m (+ m n)))
- (when (< m 0) (setq m (+ m 60) h (1- h)))
- (when (> m 59) (setq m (- m 60) h (1+ h)))
- (setq h (mod h 24))
- (setq ng 1 new (format "-%02d:%02d" h m)))
- ((org-pos-in-match-range pos 6)
- (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
- ((org-pos-in-match-range pos 5)
- (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
- ((org-pos-in-match-range pos 9)
- (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
- ((org-pos-in-match-range pos 8)
- (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
- (when ng
- (setq s (concat
- (substring s 0 (match-beginning ng))
- new
- (substring s (match-end ng))))))
- s))
- (defun org-recenter-calendar (d)
- "If the calendar is visible, recenter it to date D."
- (let ((cwin (get-buffer-window "*Calendar*" t)))
- (when cwin
- (let ((calendar-move-hook nil))
- (with-selected-window cwin
- (calendar-goto-date
- (if (listp d) d (calendar-gregorian-from-absolute d))))))))
- (defun org-goto-calendar (&optional arg)
- "Go to the Emacs calendar at the current date.
- If there is a time stamp in the current line, go to that date.
- A prefix ARG can be used to force the current date."
- (interactive "P")
- (let ((calendar-move-hook nil)
- (calendar-view-holidays-initially-flag nil)
- (calendar-view-diary-initially-flag nil)
- diff)
- (when (or (org-at-timestamp-p 'lax)
- (org-match-line (concat ".*" org-ts-regexp)))
- (let ((d1 (time-to-days nil))
- (d2 (time-to-days (org-time-string-to-time (match-string 1)))))
- (setq diff (- d2 d1))))
- (calendar)
- (calendar-goto-today)
- (when (and diff (not arg)) (calendar-forward-day diff))))
- (defun org-get-date-from-calendar ()
- "Return a list (month day year) of date at point in calendar."
- (with-current-buffer "*Calendar*"
- (save-match-data
- (calendar-cursor-to-date))))
- (defun org-date-from-calendar ()
- "Insert time stamp corresponding to cursor date in *Calendar* buffer.
- If there is already a time stamp at the cursor position, update it."
- (interactive)
- (if (org-at-timestamp-p 'lax)
- (org-timestamp-change 0 'calendar)
- (let ((cal-date (org-get-date-from-calendar)))
- (org-insert-time-stamp
- (org-encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
- (defcustom org-image-actual-width t
- "When non-nil, use the actual width of images when inlining them.
- When set to a number, use imagemagick (when available) to set the
- image's width to this value.
- When set to a number in a list, try to get the width from any
- #+ATTR.* keyword if it matches a width specification like
- #+ATTR_HTML: :width 300px
- and fall back on that number if none is found.
- When set to nil, try to get the width from an #+ATTR.* keyword
- and fall back on the original width if none is found.
- When set to any other non-nil value, always use the image width.
- This requires Emacs >= 24.1, built with imagemagick support."
- :group 'org-appearance
- :version "24.4"
- :package-version '(Org . "8.0")
- :type '(choice
- (const :tag "Use the image width" t)
- (integer :tag "Use a number of pixels")
- (list :tag "Use #+ATTR* or a number of pixels" (integer))
- (const :tag "Use #+ATTR* or don't resize" nil)))
- (defcustom org-agenda-inhibit-startup nil
- "Inhibit startup when preparing agenda buffers.
- When this variable is t, the initialization of the Org agenda
- buffers is inhibited: e.g. the visibility state is not set, the
- tables are not re-aligned, etc."
- :type 'boolean
- :version "24.3"
- :group 'org-agenda)
- (defcustom org-agenda-ignore-properties nil
- "Avoid updating text properties when building the agenda.
- Properties are used to prepare buffers for effort estimates,
- appointments, statistics and subtree-local categories.
- If you don't use these in the agenda, you can add them to this
- list and agenda building will be a bit faster.
- The value is a list, with zero or more of the symbols `effort', `appt',
- `stats' or `category'."
- :type '(set :greedy t
- (const effort)
- (const appt)
- (const stats)
- (const category))
- :version "26.1"
- :package-version '(Org . "8.3")
- :group 'org-agenda)
- ;;;; Files
- (defun org-save-all-org-buffers ()
- "Save all Org buffers without user confirmation."
- (interactive)
- (message "Saving all Org buffers...")
- (save-some-buffers t (lambda () (and (derived-mode-p 'org-mode) t)))
- (when (featurep 'org-id) (org-id-locations-save))
- (message "Saving all Org buffers... done"))
- (defun org-revert-all-org-buffers ()
- "Revert all Org buffers.
- Prompt for confirmation when there are unsaved changes.
- Be sure you know what you are doing before letting this function
- overwrite your changes.
- This function is useful in a setup where one tracks Org files
- with a version control system, to revert on one machine after pulling
- changes from another. I believe the procedure must be like this:
- 1. \\[org-save-all-org-buffers]
- 2. Pull changes from the other machine, resolve conflicts
- 3. \\[org-revert-all-org-buffers]"
- (interactive)
- (unless (yes-or-no-p "Revert all Org buffers from their files? ")
- (user-error "Abort"))
- (save-excursion
- (save-window-excursion
- (dolist (b (buffer-list))
- (when (and (with-current-buffer b (derived-mode-p 'org-mode))
- (with-current-buffer b buffer-file-name))
- (pop-to-buffer-same-window b)
- (revert-buffer t 'no-confirm)))
- (when (and (featurep 'org-id) org-id-track-globally)
- (org-id-locations-load)))))
- ;;;; Agenda files
- ;;;###autoload
- (defun org-switchb (&optional arg)
- "Switch between Org buffers.
- With `\\[universal-argument]' prefix, restrict available buffers to files.
- With `\\[universal-argument] \\[universal-argument]' \
- prefix, restrict available buffers to agenda files."
- (interactive "P")
- (let ((blist (org-buffer-list
- (cond ((equal arg '(4)) 'files)
- ((equal arg '(16)) 'agenda)))))
- (pop-to-buffer-same-window
- (completing-read "Org buffer: "
- (mapcar #'list (mapcar #'buffer-name blist))
- nil t))))
- (defun org-agenda-files (&optional unrestricted archives)
- "Get the list of agenda files.
- Optional UNRESTRICTED means return the full list even if a restriction
- is currently in place.
- When ARCHIVES is t, include all archive files that are really being
- used by the agenda files. If ARCHIVE is `ifmode', do this only if
- `org-agenda-archives-mode' is t."
- (let ((files
- (cond
- ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
- ((stringp org-agenda-files) (org-read-agenda-file-list))
- ((listp org-agenda-files) org-agenda-files)
- (t (error "Invalid value of `org-agenda-files'")))))
- (setq files (apply 'append
- (mapcar (lambda (f)
- (if (file-directory-p f)
- (directory-files
- f t org-agenda-file-regexp)
- (list (expand-file-name f org-directory))))
- files)))
- (when org-agenda-skip-unavailable-files
- (setq files (delq nil
- (mapcar (lambda (file)
- (and (file-readable-p file) file))
- files))))
- (when (or (eq archives t)
- (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
- (setq files (org-add-archive-files files)))
- files))
- (defun org-agenda-file-p (&optional file)
- "Return non-nil, if FILE is an agenda file.
- If FILE is omitted, use the file associated with the current
- buffer."
- (let ((fname (or file (buffer-file-name))))
- (and fname
- (member (file-truename fname)
- (mapcar #'file-truename (org-agenda-files t))))))
- (defun org-edit-agenda-file-list ()
- "Edit the list of agenda files.
- Depending on setup, this either uses customize to edit the variable
- `org-agenda-files', or it visits the file that is holding the list. In the
- latter case, the buffer is set up in a way that saving it automatically kills
- the buffer and restores the previous window configuration."
- (interactive)
- (if (stringp org-agenda-files)
- (let ((cw (current-window-configuration)))
- (find-file org-agenda-files)
- (setq-local org-window-configuration cw)
- (add-hook 'after-save-hook
- (lambda ()
- (set-window-configuration
- (prog1 org-window-configuration
- (kill-buffer (current-buffer))))
- (org-install-agenda-files-menu)
- (message "New agenda file list installed"))
- nil 'local)
- (message "%s" (substitute-command-keys
- "Edit list and finish with \\[save-buffer]")))
- (customize-variable 'org-agenda-files)))
- (defun org-store-new-agenda-file-list (list)
- "Set new value for the agenda file list and save it correctly."
- (if (stringp org-agenda-files)
- (let ((fe (org-read-agenda-file-list t)) b u)
- (while (setq b (find-buffer-visiting org-agenda-files))
- (kill-buffer b))
- (with-temp-file org-agenda-files
- (insert
- (mapconcat
- (lambda (f) ;; Keep un-expanded entries.
- (if (setq u (assoc f fe))
- (cdr u)
- f))
- list "\n")
- "\n")))
- (let ((org-mode-hook nil) (org-inhibit-startup t)
- (org-insert-mode-line-in-empty-file nil))
- (setq org-agenda-files list)
- (customize-save-variable 'org-agenda-files org-agenda-files))))
- (defun org-read-agenda-file-list (&optional pair-with-expansion)
- "Read the list of agenda files from a file.
- If PAIR-WITH-EXPANSION is t return pairs with un-expanded
- filenames, used by `org-store-new-agenda-file-list' to write back
- un-expanded file names."
- (when (file-directory-p org-agenda-files)
- (error "`org-agenda-files' cannot be a single directory"))
- (when (stringp org-agenda-files)
- (with-temp-buffer
- (insert-file-contents org-agenda-files)
- (mapcar
- (lambda (f)
- (let ((e (expand-file-name (substitute-in-file-name f)
- org-directory)))
- (if pair-with-expansion
- (cons e f)
- e)))
- (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
- ;;;###autoload
- (defun org-cycle-agenda-files ()
- "Cycle through the files in `org-agenda-files'.
- If the current buffer visits an agenda file, find the next one in the list.
- If the current buffer does not, find the first agenda file."
- (interactive)
- (let* ((fs (or (org-agenda-files t)
- (user-error "No agenda files")))
- (files (copy-sequence fs))
- (tcf (and buffer-file-name (file-truename buffer-file-name)))
- file)
- (when tcf
- (while (and (setq file (pop files))
- (not (equal (file-truename file) tcf)))))
- (find-file (car (or files fs)))
- (when (buffer-base-buffer) (pop-to-buffer-same-window (buffer-base-buffer)))))
- (defun org-agenda-file-to-front (&optional to-end)
- "Move/add the current file to the top of the agenda file list.
- If the file is not present in the list, it is added to the front. If it is
- present, it is moved there. With optional argument TO-END, add/move to the
- end of the list."
- (interactive "P")
- (let ((org-agenda-skip-unavailable-files nil)
- (file-alist (mapcar (lambda (x)
- (cons (file-truename x) x))
- (org-agenda-files t)))
- (ctf (file-truename
- (or buffer-file-name
- (user-error "Please save the current buffer to a file"))))
- x had)
- (setq x (assoc ctf file-alist) had x)
- (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
- (if to-end
- (setq file-alist (append (delq x file-alist) (list x)))
- (setq file-alist (cons x (delq x file-alist))))
- (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
- (org-install-agenda-files-menu)
- (message "File %s to %s of agenda file list"
- (if had "moved" "added") (if to-end "end" "front"))))
- (defun org-remove-file (&optional file)
- "Remove current file from the list of files in variable `org-agenda-files'.
- These are the files which are being checked for agenda entries.
- Optional argument FILE means use this file instead of the current."
- (interactive)
- (let* ((org-agenda-skip-unavailable-files nil)
- (file (or file buffer-file-name
- (user-error "Current buffer does not visit a file")))
- (true-file (file-truename file))
- (afile (abbreviate-file-name file))
- (files (delq nil (mapcar
- (lambda (x)
- (unless (equal true-file
- (file-truename x))
- x))
- (org-agenda-files t)))))
- (if (not (= (length files) (length (org-agenda-files t))))
- (progn
- (org-store-new-agenda-file-list files)
- (org-install-agenda-files-menu)
- (message "Removed from Org Agenda list: %s" afile))
- (message "File was not in list: %s (not removed)" afile))))
- (defun org-file-menu-entry (file)
- (vector file (list 'find-file file) t))
- (defun org-check-agenda-file (file)
- "Make sure FILE exists. If not, ask user what to do."
- (unless (file-exists-p file)
- (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
- (abbreviate-file-name file))
- (let ((r (downcase (read-char-exclusive))))
- (cond
- ((equal r ?r)
- (org-remove-file file)
- (throw 'nextfile t))
- (t (user-error "Abort"))))))
- (defun org-get-agenda-file-buffer (file)
- "Get an agenda buffer visiting FILE.
- If the buffer needs to be created, add it to the list of buffers
- which might be released later."
- (let ((buf (org-find-base-buffer-visiting file)))
- (if buf
- buf ; just return it
- ;; Make a new buffer and remember it
- (setq buf (find-file-noselect file))
- (when buf (push buf org-agenda-new-buffers))
- buf)))
- (defun org-release-buffers (blist)
- "Release all buffers in list, asking the user for confirmation when needed.
- When a buffer is unmodified, it is just killed. When modified, it is saved
- \(if the user agrees) and then killed."
- (let (file)
- (dolist (buf blist)
- (setq file (buffer-file-name buf))
- (when (and (buffer-modified-p buf)
- file
- (y-or-n-p (format "Save file %s? " file)))
- (with-current-buffer buf (save-buffer)))
- (kill-buffer buf))))
- (defun org-agenda-prepare-buffers (files)
- "Create buffers for all agenda files, protect archived trees and comments."
- (interactive)
- (let ((inhibit-read-only t)
- (org-inhibit-startup org-agenda-inhibit-startup)
- ;; Do not refresh list of agenda files in the menu when
- ;; opening every new file.
- (org-agenda-file-menu-enabled nil))
- (setq org-tag-alist-for-agenda nil
- org-tag-groups-alist-for-agenda nil)
- (dolist (file files)
- (catch 'nextfile
- (with-current-buffer
- (if (bufferp file)
- file
- (org-check-agenda-file file)
- (org-get-agenda-file-buffer file))
- (org-with-wide-buffer
- (org-set-regexps-and-options 'tags-only)
- (or (memq 'category org-agenda-ignore-properties)
- (org-refresh-category-properties))
- (or (memq 'stats org-agenda-ignore-properties)
- (org-refresh-stats-properties))
- (or (memq 'effort org-agenda-ignore-properties)
- (unless org-element-use-cache
- (org-refresh-effort-properties)))
- (or (memq 'appt org-agenda-ignore-properties)
- (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
- (dolist (el org-todo-keywords-1)
- (unless (member el org-todo-keywords-for-agenda)
- (push el org-todo-keywords-for-agenda)))
- (dolist (el org-done-keywords)
- (unless (member el org-done-keywords-for-agenda)
- (push el org-done-keywords-for-agenda)))
- (setq org-todo-keyword-alist-for-agenda
- (org--tag-add-to-alist
- org-todo-key-alist
- org-todo-keyword-alist-for-agenda))
- (setq org-tag-alist-for-agenda
- (org--tag-add-to-alist
- org-current-tag-alist
- org-tag-alist-for-agenda))
- ;; Merge current file's tag groups into global
- ;; `org-tag-groups-alist-for-agenda'.
- (when org-group-tags
- (dolist (alist org-tag-groups-alist)
- (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
- (if old
- (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
- (push alist org-tag-groups-alist-for-agenda)))))))))
- ;; Refresh the menu once after loading all the agenda buffers.
- (when org-agenda-file-menu-enabled
- (org-install-agenda-files-menu))))
- ;;;; CDLaTeX minor mode
- (defvar org-cdlatex-mode-map (make-sparse-keymap)
- "Keymap for the minor `org-cdlatex-mode'.")
- (org-defkey org-cdlatex-mode-map (kbd "_") #'org-cdlatex-underscore-caret)
- (org-defkey org-cdlatex-mode-map (kbd "^") #'org-cdlatex-underscore-caret)
- (org-defkey org-cdlatex-mode-map (kbd "`") #'cdlatex-math-symbol)
- (org-defkey org-cdlatex-mode-map (kbd "'") #'org-cdlatex-math-modify)
- (org-defkey org-cdlatex-mode-map (kbd "C-c {") #'org-cdlatex-environment-indent)
- (defvar org-cdlatex-texmathp-advice-is-done nil
- "Flag remembering if we have applied the advice to texmathp already.")
- (define-minor-mode org-cdlatex-mode
- "Toggle the minor `org-cdlatex-mode'.
- This mode supports entering LaTeX environment and math in LaTeX fragments
- in Org mode.
- \\{org-cdlatex-mode-map}"
- :lighter " OCDL"
- (when org-cdlatex-mode
- (require 'cdlatex)
- (run-hooks 'cdlatex-mode-hook)
- (cdlatex-compute-tables))
- (unless org-cdlatex-texmathp-advice-is-done
- (setq org-cdlatex-texmathp-advice-is-done t)
- (advice-add 'texmathp :around #'org--math-always-on)))
- (defun org--math-always-on (orig-fun &rest args)
- "Always return t in Org buffers.
- This is because we want to insert math symbols without dollars even outside
- the LaTeX math segments. If Org mode thinks that point is actually inside
- an embedded LaTeX fragment, let `texmathp' do its job.
- `\\[org-cdlatex-mode-map]'"
- (interactive)
- (cond
- ((not (derived-mode-p 'org-mode)) (apply orig-fun args))
- ((eq this-command 'cdlatex-math-symbol)
- (setq texmathp-why '("cdlatex-math-symbol in org-mode" . 0))
- t)
- (t
- (let ((p (org-inside-LaTeX-fragment-p)))
- (when p ;; FIXME: Shouldn't we return t when `p' is nil?
- (if (member (car p)
- (plist-get org-format-latex-options :matchers))
- (progn
- (setq texmathp-why '("Org mode embedded math" . 0))
- t)
- (apply orig-fun args)))))))
- (defun turn-on-org-cdlatex ()
- "Unconditionally turn on `org-cdlatex-mode'."
- (org-cdlatex-mode 1))
- (defun org-try-cdlatex-tab ()
- "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
- It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
- - inside a LaTeX fragment, or
- - after the first word in a line, where an abbreviation expansion could
- insert a LaTeX environment."
- (when org-cdlatex-mode
- (cond
- ;; Before any word on the line: No expansion possible.
- ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
- ;; Just after first word on the line: Expand it. Make sure it
- ;; cannot happen on headlines, though.
- ((save-excursion
- (skip-chars-backward "a-zA-Z0-9*")
- (skip-chars-backward " \t")
- (and (bolp) (not (org-at-heading-p))))
- (cdlatex-tab) t)
- ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
- (defun org-cdlatex-underscore-caret (&optional _arg)
- "Execute `cdlatex-sub-superscript' in LaTeX fragments.
- Revert to the normal definition outside of these fragments."
- (interactive "P")
- (if (org-inside-LaTeX-fragment-p)
- (call-interactively 'cdlatex-sub-superscript)
- (let (org-cdlatex-mode)
- (call-interactively (key-binding (vector last-input-event))))))
- (defun org-cdlatex-math-modify (&optional _arg)
- "Execute `cdlatex-math-modify' in LaTeX fragments.
- Revert to the normal definition outside of these fragments."
- (interactive "P")
- (if (org-inside-LaTeX-fragment-p)
- (call-interactively 'cdlatex-math-modify)
- (let (org-cdlatex-mode)
- (call-interactively (key-binding (vector last-input-event))))))
- (defun org-cdlatex-environment-indent (&optional environment item)
- "Execute `cdlatex-environment' and indent the inserted environment.
- ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
- The inserted environment is indented to current indentation
- unless point is at the beginning of the line, in which the
- environment remains unintended."
- (interactive)
- ;; cdlatex-environment always return nil. Therefore, capture output
- ;; first and determine if an environment was selected.
- (let* ((beg (point-marker))
- (end (copy-marker (point) t))
- (inserted (progn
- (ignore-errors (cdlatex-environment environment item))
- (< beg end)))
- ;; Figure out how many lines to move forward after the
- ;; environment has been inserted.
- (lines (when inserted
- (save-excursion
- (- (cl-loop while (< beg (point))
- with x = 0
- do (forward-line -1)
- (cl-incf x)
- finally return x)
- (if (progn (goto-char beg)
- (and (progn (skip-chars-forward " \t") (eolp))
- (progn (skip-chars-backward " \t") (bolp))))
- 1 0)))))
- (env (org-trim (delete-and-extract-region beg end))))
- (when inserted
- ;; Get indentation of next line unless at column 0.
- (let ((ind (if (bolp) 0
- (save-excursion
- (org-return t)
- (prog1 (current-indentation)
- (when (progn (skip-chars-forward " \t") (eolp))
- (delete-region beg (point)))))))
- (bol (progn (skip-chars-backward " \t") (bolp))))
- ;; Insert a newline before environment unless at column zero
- ;; to "escape" the current line. Insert a newline if
- ;; something is one the same line as \end{ENVIRONMENT}.
- (insert
- (concat (unless bol "\n") env
- (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
- (unless (zerop ind)
- (save-excursion
- (goto-char beg)
- (while (< (point) end)
- (unless (eolp) (indent-line-to ind))
- (forward-line))))
- (goto-char beg)
- (forward-line lines)
- (indent-line-to ind)))
- (set-marker beg nil)
- (set-marker end nil)))
- ;;;; LaTeX fragments
- (defun org-inside-LaTeX-fragment-p ()
- "Test if point is inside a LaTeX fragment.
- I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
- sequence appearing also before point.
- Even though the matchers for math are configurable, this function assumes
- that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
- delimiters are skipped when they have been removed by customization.
- The return value is nil, or a cons cell with the delimiter and the
- position of this delimiter.
- This function does a reasonably good job, but can locally be fooled by
- for example currency specifications. For example it will assume being in
- inline math after \"$22.34\". The LaTeX fragment formatter will only format
- fragments that are properly closed, but during editing, we have to live
- with the uncertainty caused by missing closing delimiters. This function
- looks only before point, not after."
- (catch 'exit
- (let ((pos (point))
- (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
- (lim (progn
- (re-search-backward (concat "^\\(" paragraph-start "\\)") nil
- 'move)
- (point)))
- dd-on str (start 0) m re)
- (goto-char pos)
- (when dodollar
- (setq str (concat (buffer-substring lim (point)) "\000 X$.")
- re (nth 1 (assoc "$" org-latex-regexps)))
- (while (string-match re str start)
- (cond
- ((= (match-end 0) (length str))
- (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
- ((= (match-end 0) (- (length str) 5))
- (throw 'exit nil))
- (t (setq start (match-end 0))))))
- (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
- (goto-char pos)
- (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
- (and (match-beginning 2) (throw 'exit nil))
- ;; count $$
- (while (re-search-backward "\\$\\$" lim t)
- (setq dd-on (not dd-on)))
- (goto-char pos)
- (when dd-on (cons "$$" m))))))
- (defun org-inside-latex-macro-p ()
- "Is point inside a LaTeX macro or its arguments?"
- (save-match-data
- (org-in-regexp
- "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
- (defun org--make-preview-overlay (beg end image &optional imagetype)
- "Build an overlay between BEG and END using IMAGE file.
- Argument IMAGETYPE is the extension of the displayed image,
- as a string. It defaults to \"png\"."
- (let ((ov (make-overlay beg end))
- (imagetype (or (intern imagetype) 'png)))
- (overlay-put ov 'org-overlay-type 'org-latex-overlay)
- (overlay-put ov 'evaporate t)
- (overlay-put ov
- 'modification-hooks
- (list (lambda (o _flag _beg _end &optional _l)
- (delete-overlay o))))
- (overlay-put ov
- 'display
- (list 'image :type imagetype :file image :ascent 'center))))
- (defun org-clear-latex-preview (&optional beg end)
- "Remove all overlays with LaTeX fragment images in current buffer.
- When optional arguments BEG and END are non-nil, remove all
- overlays between them instead. Return a non-nil value when some
- overlays were removed, nil otherwise."
- (let ((overlays
- (cl-remove-if-not
- (lambda (o) (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay))
- (overlays-in (or beg (point-min)) (or end (point-max))))))
- (mapc #'delete-overlay overlays)
- overlays))
- (defun org--latex-preview-region (beg end)
- "Preview LaTeX fragments between BEG and END.
- BEG and END are buffer positions."
- (let ((file (buffer-file-name (buffer-base-buffer))))
- (save-excursion
- (org-format-latex
- (concat org-preview-latex-image-directory "org-ltximg")
- beg end
- ;; Emacs cannot overlay images from remote hosts. Create it in
- ;; `temporary-file-directory' instead.
- (if (or (not file) (file-remote-p file))
- temporary-file-directory
- default-directory)
- 'overlays nil 'forbuffer org-preview-latex-default-process))))
- (defun org-latex-preview (&optional arg)
- "Toggle preview of the LaTeX fragment at point.
- If the cursor is on a LaTeX fragment, create the image and
- overlay it over the source code, if there is none. Remove it
- otherwise. If there is no fragment at point, display images for
- all fragments in the current section. With an active region,
- display images for all fragments in the region.
- With a `\\[universal-argument]' prefix argument ARG, clear images \
- for all fragments
- in the current section.
- With a `\\[universal-argument] \\[universal-argument]' prefix \
- argument ARG, display image for all
- fragments in the buffer.
- With a `\\[universal-argument] \\[universal-argument] \
- \\[universal-argument]' prefix argument ARG, clear image for all
- fragments in the buffer."
- (interactive "P")
- (cond
- ((not (display-graphic-p)) nil)
- ;; Clear whole buffer.
- ((equal arg '(64))
- (org-clear-latex-preview (point-min) (point-max))
- (message "LaTeX previews removed from buffer"))
- ;; Preview whole buffer.
- ((equal arg '(16))
- (message "Creating LaTeX previews in buffer...")
- (org--latex-preview-region (point-min) (point-max))
- (message "Creating LaTeX previews in buffer... done."))
- ;; Clear current section.
- ((equal arg '(4))
- (org-clear-latex-preview
- (if (use-region-p)
- (region-beginning)
- (if (org-before-first-heading-p) (point-min)
- (save-excursion
- (org-with-limited-levels (org-back-to-heading t) (point)))))
- (if (use-region-p)
- (region-end)
- (org-with-limited-levels (org-entry-end-position)))))
- ((use-region-p)
- (message "Creating LaTeX previews in region...")
- (org--latex-preview-region (region-beginning) (region-end))
- (message "Creating LaTeX previews in region... done."))
- ;; Toggle preview on LaTeX code at point.
- ((let ((datum (org-element-context)))
- (and (memq (org-element-type datum) '(latex-environment latex-fragment))
- (let ((beg (org-element-property :begin datum))
- (end (org-element-property :end datum)))
- (if (org-clear-latex-preview beg end)
- (message "LaTeX preview removed")
- (message "Creating LaTeX preview...")
- (org--latex-preview-region beg end)
- (message "Creating LaTeX preview... done."))
- t))))
- ;; Preview current section.
- (t
- (let ((beg (if (org-before-first-heading-p) (point-min)
- (save-excursion
- (org-with-limited-levels (org-back-to-heading t) (point)))))
- (end (org-with-limited-levels (org-entry-end-position))))
- (message "Creating LaTeX previews in section...")
- (org--latex-preview-region beg end)
- (message "Creating LaTeX previews in section... done.")))))
- (defun org-format-latex
- (prefix &optional beg end dir overlays msg forbuffer processing-type)
- "Replace LaTeX fragments with links to an image.
- The function takes care of creating the replacement image.
- Only consider fragments between BEG and END when those are
- provided.
- When optional argument OVERLAYS is non-nil, display the image on
- top of the fragment instead of replacing it.
- PROCESSING-TYPE is the conversion method to use, as a symbol.
- Some of the options can be changed using the variable
- `org-format-latex-options', which see."
- (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
- (unless (eq processing-type 'verbatim)
- (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
- (cnt 0)
- checkdir-flag)
- (goto-char (or beg (point-min)))
- ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
- (when (and overlays (memq processing-type '(dvipng imagemagick)))
- (overlay-recenter (or end (point-max))))
- (while (re-search-forward math-regexp end t)
- (unless (and overlays
- (eq (get-char-property (point) 'org-overlay-type)
- 'org-latex-overlay))
- (let* ((context (org-element-context))
- (type (org-element-type context)))
- (when (memq type '(latex-environment latex-fragment))
- (let ((block-type (eq type 'latex-environment))
- (value (org-element-property :value context))
- (beg (org-element-property :begin context))
- (end (save-excursion
- (goto-char (org-element-property :end context))
- (skip-chars-backward " \r\t\n")
- (point))))
- (cond
- ((eq processing-type 'mathjax)
- ;; Prepare for MathJax processing.
- (if (not (string-match "\\`\\$\\$?" value))
- (goto-char end)
- (delete-region beg end)
- (if (string= (match-string 0 value) "$$")
- (insert "\\[" (substring value 2 -2) "\\]")
- (insert "\\(" (substring value 1 -1) "\\)"))))
- ((eq processing-type 'html)
- (goto-char beg)
- (delete-region beg end)
- (insert (org-format-latex-as-html value)))
- ((assq processing-type org-preview-latex-process-alist)
- ;; Process to an image.
- (cl-incf cnt)
- (goto-char beg)
- (let* ((processing-info
- (cdr (assq processing-type org-preview-latex-process-alist)))
- (face (face-at-point))
- ;; Get the colors from the face at point.
- (fg
- (let ((color (plist-get org-format-latex-options
- :foreground)))
- (if forbuffer
- (cond
- ((eq color 'auto)
- (face-attribute face :foreground nil 'default))
- ((eq color 'default)
- (face-attribute 'default :foreground nil))
- (t color))
- color)))
- (bg
- (let ((color (plist-get org-format-latex-options
- :background)))
- (if forbuffer
- (cond
- ((eq color 'auto)
- (face-attribute face :background nil 'default))
- ((eq color 'default)
- (face-attribute 'default :background nil))
- (t color))
- color)))
- (hash (sha1 (prin1-to-string
- (list org-format-latex-header
- org-latex-default-packages-alist
- org-latex-packages-alist
- org-format-latex-options
- forbuffer value fg bg))))
- (imagetype (or (plist-get processing-info :image-output-type) "png"))
- (absprefix (expand-file-name prefix dir))
- (linkfile (format "%s_%s.%s" prefix hash imagetype))
- (movefile (format "%s_%s.%s" absprefix hash imagetype))
- (sep (and block-type "\n\n"))
- (link (concat sep "[[file:" linkfile "]]" sep))
- (options
- (org-combine-plists
- org-format-latex-options
- `(:foreground ,fg :background ,bg))))
- (when msg (message msg cnt))
- (unless checkdir-flag ; Ensure the directory exists.
- (setq checkdir-flag t)
- (let ((todir (file-name-directory absprefix)))
- (unless (file-directory-p todir)
- (make-directory todir t))))
- (unless (file-exists-p movefile)
- (org-create-formula-image
- value movefile options forbuffer processing-type))
- (if overlays
- (progn
- (dolist (o (overlays-in beg end))
- (when (eq (overlay-get o 'org-overlay-type)
- 'org-latex-overlay)
- (delete-overlay o)))
- (org--make-preview-overlay beg end movefile imagetype)
- (goto-char end))
- (delete-region beg end)
- (insert
- (org-add-props link
- (list 'org-latex-src
- (replace-regexp-in-string "\"" "" value)
- 'org-latex-src-embed-type
- (if block-type 'paragraph 'character)))))))
- ((eq processing-type 'mathml)
- ;; Process to MathML.
- (unless (org-format-latex-mathml-available-p)
- (user-error "LaTeX to MathML converter not configured"))
- (cl-incf cnt)
- (when msg (message msg cnt))
- (goto-char beg)
- (delete-region beg end)
- (insert (org-format-latex-as-mathml
- value block-type prefix dir)))
- (t
- (error "Unknown conversion process %s for LaTeX fragments"
- processing-type)))))))))))
- (defun org-create-math-formula (latex-frag &optional mathml-file)
- "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
- Use `org-latex-to-mathml-convert-command'. If the conversion is
- successful, return the portion between \"<math...> </math>\"
- elements otherwise return nil. When MATHML-FILE is specified,
- write the results in to that file. When invoked as an
- interactive command, prompt for LATEX-FRAG, with initial value
- set to the current active region and echo the results for user
- inspection."
- (interactive (list (let ((frag (when (org-region-active-p)
- (buffer-substring-no-properties
- (region-beginning) (region-end)))))
- (read-string "LaTeX Fragment: " frag nil frag))))
- (unless latex-frag (user-error "Invalid LaTeX fragment"))
- (let* ((tmp-in-file
- (let ((file (file-relative-name
- (make-temp-name (expand-file-name "ltxmathml-in")))))
- (write-region latex-frag nil file)
- file))
- (tmp-out-file (file-relative-name
- (make-temp-name (expand-file-name "ltxmathml-out"))))
- (cmd (format-spec
- org-latex-to-mathml-convert-command
- `((?j . ,(and org-latex-to-mathml-jar-file
- (shell-quote-argument
- (expand-file-name
- org-latex-to-mathml-jar-file))))
- (?I . ,(shell-quote-argument tmp-in-file))
- (?i . ,latex-frag)
- (?o . ,(shell-quote-argument tmp-out-file)))))
- mathml shell-command-output)
- (when (called-interactively-p 'any)
- (unless (org-format-latex-mathml-available-p)
- (user-error "LaTeX to MathML converter not configured")))
- (message "Running %s" cmd)
- (setq shell-command-output (shell-command-to-string cmd))
- (setq mathml
- (when (file-readable-p tmp-out-file)
- (with-current-buffer (find-file-noselect tmp-out-file t)
- (goto-char (point-min))
- (when (re-search-forward
- (format "<math[^>]*?%s[^>]*?>\\(.\\|\n\\)*</math>"
- (regexp-quote
- "xmlns=\"http://www.w3.org/1998/Math/MathML\""))
- nil t)
- (prog1 (match-string 0) (kill-buffer))))))
- (cond
- (mathml
- (setq mathml
- (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
- (when mathml-file
- (write-region mathml nil mathml-file))
- (when (called-interactively-p 'any)
- (message mathml)))
- ((warn "LaTeX to MathML conversion failed")
- (message shell-command-output)))
- (delete-file tmp-in-file)
- (when (file-exists-p tmp-out-file)
- (delete-file tmp-out-file))
- mathml))
- (defun org-format-latex-as-mathml (latex-frag latex-frag-type
- prefix &optional dir)
- "Use `org-create-math-formula' but check local cache first."
- (let* ((absprefix (expand-file-name prefix dir))
- (print-length nil) (print-level nil)
- (formula-id (concat
- "formula-"
- (sha1
- (prin1-to-string
- (list latex-frag
- org-latex-to-mathml-convert-command)))))
- (formula-cache (format "%s-%s.mathml" absprefix formula-id))
- (formula-cache-dir (file-name-directory formula-cache)))
- (unless (file-directory-p formula-cache-dir)
- (make-directory formula-cache-dir t))
- (unless (file-exists-p formula-cache)
- (org-create-math-formula latex-frag formula-cache))
- (if (file-exists-p formula-cache)
- ;; Successful conversion. Return the link to MathML file.
- (org-add-props
- (format "[[file:%s]]" (file-relative-name formula-cache dir))
- (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
- 'org-latex-src-embed-type (if latex-frag-type
- 'paragraph 'character)))
- ;; Failed conversion. Return the LaTeX fragment verbatim
- latex-frag)))
- (defun org-format-latex-as-html (latex-fragment)
- "Convert LATEX-FRAGMENT to HTML.
- This uses `org-latex-to-html-convert-command', which see."
- (let ((cmd (format-spec org-latex-to-html-convert-command
- `((?i . ,latex-fragment)))))
- (message "Running %s" cmd)
- (shell-command-to-string cmd)))
- (defun org--get-display-dpi ()
- "Get the DPI of the display.
- The function assumes that the display has the same pixel width in
- the horizontal and vertical directions."
- (if (display-graphic-p)
- (round (/ (display-pixel-height)
- (/ (display-mm-height) 25.4)))
- (error "Attempt to calculate the dpi of a non-graphic display")))
- (defun org-create-formula-image
- (string tofile options buffer &optional processing-type)
- "Create an image from LaTeX source using external processes.
- The LaTeX STRING is saved to a temporary LaTeX file, then
- converted to an image file by process PROCESSING-TYPE defined in
- `org-preview-latex-process-alist'. A nil value defaults to
- `org-preview-latex-default-process'.
- The generated image file is eventually moved to TOFILE.
- The OPTIONS argument controls the size, foreground color and
- background color of the generated image.
- When BUFFER non-nil, this function is used for LaTeX previewing.
- Otherwise, it is used to deal with LaTeX snippets showed in
- a HTML file."
- (let* ((processing-type (or processing-type
- org-preview-latex-default-process))
- (processing-info
- (cdr (assq processing-type org-preview-latex-process-alist)))
- (programs (plist-get processing-info :programs))
- (error-message (or (plist-get processing-info :message) ""))
- (image-input-type (plist-get processing-info :image-input-type))
- (image-output-type (plist-get processing-info :image-output-type))
- (post-clean (or (plist-get processing-info :post-clean)
- '(".dvi" ".xdv" ".pdf" ".tex" ".aux" ".log"
- ".svg" ".png" ".jpg" ".jpeg" ".out")))
- (latex-header
- (or (plist-get processing-info :latex-header)
- (org-latex-make-preamble
- (org-export-get-environment (org-export-get-backend 'latex))
- org-format-latex-header
- 'snippet)))
- (latex-compiler (plist-get processing-info :latex-compiler))
- (tmpdir temporary-file-directory)
- (texfilebase (make-temp-name
- (expand-file-name "orgtex" tmpdir)))
- (texfile (concat texfilebase ".tex"))
- (image-size-adjust (or (plist-get processing-info :image-size-adjust)
- '(1.0 . 1.0)))
- (scale (* (if buffer (car image-size-adjust) (cdr image-size-adjust))
- (or (plist-get options (if buffer :scale :html-scale)) 1.0)))
- (dpi (* scale (if buffer (org--get-display-dpi) 140.0)))
- (fg (or (plist-get options (if buffer :foreground :html-foreground))
- "Black"))
- (bg (or (plist-get options (if buffer :background :html-background))
- "Transparent"))
- (image-converter
- (or (and (string= bg "Transparent")
- (plist-get processing-info :transparent-image-converter))
- (plist-get processing-info :image-converter)))
- (log-buf (get-buffer-create "*Org Preview LaTeX Output*"))
- (resize-mini-windows nil)) ;Fix Emacs flicker when creating image.
- (dolist (program programs)
- (org-check-external-command program error-message))
- (if (eq fg 'default)
- (setq fg (org-latex-color :foreground))
- (setq fg (org-latex-color-format fg)))
- (setq bg (cond
- ((eq bg 'default) (org-latex-color :background))
- ((string= bg "Transparent") nil)
- (t (org-latex-color-format bg))))
- ;; Remove TeX \par at end of snippet to avoid trailing space.
- (if (string-suffix-p string "\n")
- (aset string (1- (length string)) ?%)
- (setq string (concat string "%")))
- (with-temp-file texfile
- (insert latex-header)
- (insert "\n\\begin{document}\n"
- "\\definecolor{fg}{rgb}{" fg "}%\n"
- (if bg
- (concat "\\definecolor{bg}{rgb}{" bg "}%\n"
- "\n\\pagecolor{bg}%\n")
- "")
- "\n{\\color{fg}\n"
- string
- "\n}\n"
- "\n\\end{document}\n"))
- (let* ((err-msg (format "Please adjust `%s' part of \
- `org-preview-latex-process-alist'."
- processing-type))
- (image-input-file
- (org-compile-file
- texfile latex-compiler image-input-type err-msg log-buf))
- (image-output-file
- (org-compile-file
- image-input-file image-converter image-output-type err-msg log-buf
- `((?D . ,(shell-quote-argument (format "%s" dpi)))
- (?S . ,(shell-quote-argument (format "%s" (/ dpi 140.0))))))))
- (copy-file image-output-file tofile 'replace)
- (dolist (e post-clean)
- (when (file-exists-p (concat texfilebase e))
- (delete-file (concat texfilebase e))))
- image-output-file)))
- (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
- "Fill a LaTeX header template TPL.
- In the template, the following place holders will be recognized:
- [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
- [NO-DEFAULT-PACKAGES] do not include DEF-PKG
- [PACKAGES] \\usepackage statements for PKG
- [NO-PACKAGES] do not include PKG
- [EXTRA] the string EXTRA
- [NO-EXTRA] do not include EXTRA
- For backward compatibility, if both the positive and the negative place
- holder is missing, the positive one (without the \"NO-\") will be
- assumed to be present at the end of the template.
- DEF-PKG and PKG are assumed to be alists of options/packagename lists.
- EXTRA is a string.
- SNIPPETS-P indicates if this is run to create snippet images for HTML."
- (let (rpl (end ""))
- (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
- (setq rpl (if (or (match-end 1) (not def-pkg))
- "" (org-latex-packages-to-string def-pkg snippets-p t))
- tpl (replace-match rpl t t tpl))
- (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
- (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
- (setq rpl (if (or (match-end 1) (not pkg))
- "" (org-latex-packages-to-string pkg snippets-p t))
- tpl (replace-match rpl t t tpl))
- (when pkg (setq end
- (concat end "\n"
- (org-latex-packages-to-string pkg snippets-p)))))
- (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
- (setq rpl (if (or (match-end 1) (not extra))
- "" (concat extra "\n"))
- tpl (replace-match rpl t t tpl))
- (when (and extra (string-match "\\S-" extra))
- (setq end (concat end "\n" extra))))
- (if (string-match "\\S-" end)
- (concat tpl "\n" end)
- tpl)))
- (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
- "Turn an alist of packages into a string with the \\usepackage macros."
- (setq pkg (mapconcat (lambda(p)
- (cond
- ((stringp p) p)
- ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
- (format "%% Package %s omitted" (cadr p)))
- ((equal "" (car p))
- (format "\\usepackage{%s}" (cadr p)))
- (t
- (format "\\usepackage[%s]{%s}"
- (car p) (cadr p)))))
- pkg
- "\n"))
- (if newline (concat pkg "\n") pkg))
- (defun org-dvipng-color (attr)
- "Return a RGB color specification for dvipng."
- (org-dvipng-color-format (face-attribute 'default attr nil)))
- (defun org-dvipng-color-format (color-name)
- "Convert COLOR-NAME to a RGB color value for dvipng."
- (apply #'format "rgb %s %s %s"
- (mapcar 'org-normalize-color
- (color-values color-name))))
- (defun org-latex-color (attr)
- "Return a RGB color for the LaTeX color package."
- (org-latex-color-format (face-attribute 'default attr nil)))
- (defun org-latex-color-format (color-name)
- "Convert COLOR-NAME to a RGB color value."
- (apply #'format "%s,%s,%s"
- (mapcar 'org-normalize-color
- (color-values color-name))))
- (defun org-normalize-color (value)
- "Return string to be used as color value for an RGB component."
- (format "%g" (/ value 65535.0)))
- ;; Image display
- (defvar-local org-inline-image-overlays nil)
- (defun org-toggle-inline-images (&optional include-linked)
- "Toggle the display of inline images.
- INCLUDE-LINKED is passed to `org-display-inline-images'."
- (interactive "P")
- (if org-inline-image-overlays
- (progn
- (org-remove-inline-images)
- (when (called-interactively-p 'interactive)
- (message "Inline image display turned off")))
- (org-display-inline-images include-linked)
- (when (called-interactively-p 'interactive)
- (message (if org-inline-image-overlays
- (format "%d images displayed inline"
- (length org-inline-image-overlays))
- "No images to display inline")))))
- (defun org-redisplay-inline-images ()
- "Assure display of inline images and refresh them."
- (interactive)
- (org-toggle-inline-images)
- (unless org-inline-image-overlays
- (org-toggle-inline-images)))
- ;; For without-x builds.
- (declare-function image-flush "image" (spec &optional frame))
- (defcustom org-display-remote-inline-images 'skip
- "How to display remote inline images.
- Possible values of this option are:
- skip Don't display remote images.
- download Always download and display remote images.
- cache Display remote images, and open them in separate buffers
- for caching. Silently update the image buffer when a file
- change is detected."
- :group 'org-appearance
- :package-version '(Org . "9.4")
- :type '(choice
- (const :tag "Ignore remote images" skip)
- (const :tag "Always display remote images" download)
- (const :tag "Display and silently update remote images" cache))
- :safe #'symbolp)
- (defun org--create-inline-image (file width)
- "Create image located at FILE, or return nil.
- WIDTH is the width of the image. The image may not be created
- according to the value of `org-display-remote-inline-images'."
- (let* ((remote? (file-remote-p file))
- (file-or-data
- (pcase org-display-remote-inline-images
- ((guard (not remote?)) file)
- (`download (with-temp-buffer
- (set-buffer-multibyte nil)
- (insert-file-contents-literally file)
- (buffer-string)))
- (`cache (let ((revert-without-query '(".")))
- (with-current-buffer (find-file-noselect file)
- (buffer-string))))
- (`skip nil)
- (other
- (message "Invalid value of `org-display-remote-inline-images': %S"
- other)
- nil))))
- (when file-or-data
- (create-image file-or-data
- (and (image-type-available-p 'imagemagick)
- width
- 'imagemagick)
- remote?
- :width width :scale 1))))
- (defun org-display-inline-images (&optional include-linked refresh beg end)
- "Display inline images.
- An inline image is a link which follows either of these
- conventions:
- 1. Its path is a file with an extension matching return value
- from `image-file-name-regexp' and it has no contents.
- 2. Its description consists in a single link of the previous
- type. In this case, that link must be a well-formed plain
- or angle link, i.e., it must have an explicit \"file\" type.
- Equip each image with the key-map `image-map'.
- When optional argument INCLUDE-LINKED is non-nil, also links with
- a text description part will be inlined. This can be nice for
- a quick look at those images, but it does not reflect what
- exported files will look like.
- When optional argument REFRESH is non-nil, refresh existing
- images between BEG and END. This will create new image displays
- only if necessary.
- BEG and END define the considered part. They default to the
- buffer boundaries with possible narrowing."
- (interactive "P")
- (when (display-graphic-p)
- (unless refresh
- (org-remove-inline-images)
- (when (fboundp 'clear-image-cache) (clear-image-cache)))
- (let ((end (or end (point-max))))
- (org-with-point-at (or beg (point-min))
- (let* ((case-fold-search t)
- (file-extension-re (image-file-name-regexp))
- (link-abbrevs (mapcar #'car
- (append org-link-abbrev-alist-local
- org-link-abbrev-alist)))
- ;; Check absolute, relative file names and explicit
- ;; "file:" links. Also check link abbreviations since
- ;; some might expand to "file" links.
- (file-types-re
- (format "\\[\\[\\(?:file%s:\\|attachment:\\|[./~]\\)\\|\\]\\[\\(<?file:\\)"
- (if (not link-abbrevs) ""
- (concat "\\|" (regexp-opt link-abbrevs))))))
- (while (re-search-forward file-types-re end t)
- (let* ((link (org-element-lineage
- (save-match-data (org-element-context))
- '(link) t))
- (linktype (org-element-property :type link))
- (inner-start (match-beginning 1))
- (path
- (cond
- ;; No link at point; no inline image.
- ((not link) nil)
- ;; File link without a description. Also handle
- ;; INCLUDE-LINKED here since it should have
- ;; precedence over the next case. I.e., if link
- ;; contains filenames in both the path and the
- ;; description, prioritize the path only when
- ;; INCLUDE-LINKED is non-nil.
- ((or (not (org-element-property :contents-begin link))
- include-linked)
- (and (or (equal "file" linktype)
- (equal "attachment" linktype))
- (org-element-property :path link)))
- ;; Link with a description. Check if description
- ;; is a filename. Even if Org doesn't have syntax
- ;; for those -- clickable image -- constructs, fake
- ;; them, as in `org-export-insert-image-links'.
- ((not inner-start) nil)
- (t
- (org-with-point-at inner-start
- (and (looking-at
- (if (char-equal ?< (char-after inner-start))
- org-link-angle-re
- org-link-plain-re))
- ;; File name must fill the whole
- ;; description.
- (= (org-element-property :contents-end link)
- (match-end 0))
- (match-string 2)))))))
- (when (and path (string-match-p file-extension-re path))
- (let ((file (if (equal "attachment" linktype)
- (progn
- (require 'org-attach)
- (ignore-errors (org-attach-expand path)))
- (expand-file-name path))))
- (when (and file (file-exists-p file))
- (let ((width (org-display-inline-image--width link))
- (old (get-char-property-and-overlay
- (org-element-property :begin link)
- 'org-image-overlay)))
- (if (and (car-safe old) refresh)
- (image-flush (overlay-get (cdr old) 'display))
- (let ((image (org--create-inline-image file width)))
- (when image
- (let ((ov (make-overlay
- (org-element-property :begin link)
- (progn
- (goto-char
- (org-element-property :end link))
- (skip-chars-backward " \t")
- (point)))))
- (overlay-put ov 'display image)
- (overlay-put ov 'face 'default)
- (overlay-put ov 'org-image-overlay t)
- (overlay-put
- ov 'modification-hooks
- (list 'org-display-inline-remove-overlay))
- (when (boundp 'image-map)
- (overlay-put ov 'keymap image-map))
- (push ov org-inline-image-overlays))))))))))))))))
- (defvar visual-fill-column-width) ; Silence compiler warning
- (defun org-display-inline-image--width (link)
- "Determine the display width of the image LINK, in pixels.
- - When `org-image-actual-width' is t, the image's pixel width is used.
- - When `org-image-actual-width' is a number, that value will is used.
- - When `org-image-actual-width' is nil or a list, the first :width attribute
- set (if it exists) is used to set the image width. A width of X% is
- divided by 100.
- If no :width attribute is given and `org-image-actual-width' is a list with
- a number as the car, then that number is used as the default value.
- If the value is a float between 0 and 2, it interpreted as that proportion
- of the text width in the buffer."
- ;; Apply `org-image-actual-width' specifications.
- ;; Support subtree-level property "ORG-IMAGE-ACTUAL-WIDTH" specified
- ;; width.
- (let ((org-image-actual-width (org-property-or-variable-value 'org-image-actual-width)))
- (cond
- ((eq org-image-actual-width t) nil)
- ((listp org-image-actual-width)
- (let* ((case-fold-search t)
- (par (org-element-lineage link '(paragraph)))
- (attr-re "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)")
- (par-end (org-element-property :post-affiliated par))
- ;; Try to find an attribute providing a :width.
- (attr-width
- (when (and par (org-with-point-at
- (org-element-property :begin par)
- (re-search-forward attr-re par-end t)))
- (match-string 1)))
- (width
- (cond
- ;; Treat :width t as if `org-image-actual-width' were t.
- ((string= attr-width "t") nil)
- ;; Fallback to `org-image-actual-width' if no interprable width is given.
- ((or (null attr-width)
- (string-match-p "\\`[^0-9]" attr-width))
- (car org-image-actual-width))
- ;; Convert numeric widths to numbers, converting percentages.
- ((string-match-p "\\`[0-9.]+%" attr-width)
- (/ (string-to-number attr-width) 100.0))
- (t (string-to-number attr-width)))))
- (if (and (floatp width) (<= 0.0 width 2.0))
- ;; A float in [0,2] should be interpereted as this portion of
- ;; the text width in the window. This works well with cases like
- ;; #+attr_latex: :width 0.X\{line,page,column,etc.}width,
- ;; as the "0.X" is pulled out as a float. We use 2 as the upper
- ;; bound as cases such as 1.2\linewidth are feasible.
- (round (* width
- (window-pixel-width)
- (/ (or (and (bound-and-true-p visual-fill-column-mode)
- (or visual-fill-column-width auto-fill-function))
- (when auto-fill-function fill-column)
- (- (window-text-width) (line-number-display-width)))
- (float (window-total-width)))))
- width)))
- ((numberp org-image-actual-width)
- org-image-actual-width)
- (t nil))))
- (defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
- "Remove inline-display overlay if a corresponding region is modified."
- (let ((inhibit-modification-hooks t))
- (when (and ov after)
- (delete ov org-inline-image-overlays)
- (delete-overlay ov))))
- (defun org-remove-inline-images ()
- "Remove inline display of images."
- (interactive)
- (mapc #'delete-overlay org-inline-image-overlays)
- (setq org-inline-image-overlays nil))
- (defvar org-self-insert-command-undo-counter 0)
- (defvar org-speed-command nil)
- (defun org-fix-tags-on-the-fly ()
- "Align tags in headline at point.
- Unlike `org-align-tags', this function does nothing if point is
- either not currently on a tagged headline or on a tag."
- (when (and (org-match-line org-tag-line-re)
- (< (point) (match-beginning 1)))
- (org-align-tags)))
- (defun org-self-insert-command (N)
- "Like `self-insert-command', use overwrite-mode for whitespace in tables.
- If the cursor is in a table looking at whitespace, the whitespace is
- overwritten, and the table is not marked as requiring realignment."
- (interactive "p")
- (org-fold-check-before-invisible-edit 'insert)
- (cond
- ((and org-use-speed-commands
- (let ((kv (this-command-keys-vector)))
- (setq org-speed-command
- (run-hook-with-args-until-success
- 'org-speed-command-hook
- (make-string 1 (aref kv (1- (length kv))))))))
- (cond
- ((commandp org-speed-command)
- (setq this-command org-speed-command)
- (call-interactively org-speed-command))
- ((functionp org-speed-command)
- (funcall org-speed-command))
- ((consp org-speed-command)
- (eval org-speed-command t))
- (t (let (org-use-speed-commands)
- (call-interactively 'org-self-insert-command)))))
- ((and
- (= N 1)
- (not (org-region-active-p))
- (org-at-table-p)
- (progn
- ;; Check if we blank the field, and if that triggers align.
- (and (featurep 'org-table)
- org-table-auto-blank-field
- (memq last-command
- '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
- (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
- ;; Got extra space, this field does not determine
- ;; column width.
- (let (org-table-may-need-update) (org-table-blank-field))
- ;; No extra space, this field may determine column
- ;; width.
- (org-table-blank-field)))
- t)
- (looking-at "[^|\n]* |"))
- ;; There is room for insertion without re-aligning the table.
- (self-insert-command N)
- (org-table-with-shrunk-field
- (save-excursion
- (skip-chars-forward "^|")
- ;; Do not delete last space, which is
- ;; `org-table-separator-space', but the regular space before
- ;; it.
- (delete-region (- (point) 2) (1- (point))))))
- (t
- (setq org-table-may-need-update t)
- (self-insert-command N)
- (org-fix-tags-on-the-fly)
- (when org-self-insert-cluster-for-undo
- (if (not (eq last-command 'org-self-insert-command))
- (setq org-self-insert-command-undo-counter 1)
- (if (>= org-self-insert-command-undo-counter 20)
- (setq org-self-insert-command-undo-counter 1)
- (and (> org-self-insert-command-undo-counter 0)
- buffer-undo-list (listp buffer-undo-list)
- (not (cadr buffer-undo-list)) ; remove nil entry
- (setcdr buffer-undo-list (cddr buffer-undo-list)))
- (setq org-self-insert-command-undo-counter
- (1+ org-self-insert-command-undo-counter))))))))
- (defun org-delete-backward-char (N)
- "Like `delete-backward-char', insert whitespace at field end in tables.
- When deleting backwards, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table will
- still be marked for re-alignment if the field did fill the entire column,
- because, in this case the deletion might narrow the column."
- (interactive "p")
- (save-match-data
- (org-fold-check-before-invisible-edit 'delete-backward)
- (if (and (= N 1)
- (not overwrite-mode)
- (not (org-region-active-p))
- (not (eq (char-before) ?|))
- (save-excursion (skip-chars-backward " \t") (not (bolp)))
- (looking-at-p ".*?|")
- (org-at-table-p))
- (progn (forward-char -1) (org-delete-char 1))
- (backward-delete-char N)
- (org-fix-tags-on-the-fly))))
- (defun org-delete-char (N)
- "Like `delete-char', but insert whitespace at field end in tables.
- When deleting characters, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table will
- still be marked for re-alignment if the field did fill the entire column,
- because, in this case the deletion might narrow the column."
- (interactive "p")
- (save-match-data
- (org-fold-check-before-invisible-edit 'delete)
- (cond
- ((or (/= N 1)
- (eq (char-after) ?|)
- (save-excursion (skip-chars-backward " \t") (bolp))
- (not (org-at-table-p)))
- (delete-char N)
- (org-fix-tags-on-the-fly))
- ((looking-at ".\\(.*?\\)|")
- (let* ((update? org-table-may-need-update)
- (noalign (looking-at-p ".*? |")))
- (delete-char 1)
- (org-table-with-shrunk-field
- (save-excursion
- ;; Last space is `org-table-separator-space', so insert
- ;; a regular one before it instead.
- (goto-char (- (match-end 0) 2))
- (insert " ")))
- ;; If there were two spaces at the end, this field does not
- ;; determine the width of the column.
- (when noalign (setq org-table-may-need-update update?))))
- (t
- (delete-char N)))))
- ;; Make `delete-selection-mode' work with Org mode and Orgtbl mode
- (put 'org-self-insert-command 'delete-selection
- (lambda ()
- (not (run-hook-with-args-until-success
- 'self-insert-uses-region-functions))))
- (put 'orgtbl-self-insert-command 'delete-selection
- (lambda ()
- (not (run-hook-with-args-until-success
- 'self-insert-uses-region-functions))))
- (put 'org-delete-char 'delete-selection 'supersede)
- (put 'org-delete-backward-char 'delete-selection 'supersede)
- (put 'org-yank 'delete-selection 'yank)
- (put 'org-return 'delete-selection t)
- ;; Make `flyspell-mode' delay after some commands
- (put 'org-self-insert-command 'flyspell-delayed t)
- (put 'orgtbl-self-insert-command 'flyspell-delayed t)
- (put 'org-delete-char 'flyspell-delayed t)
- (put 'org-delete-backward-char 'flyspell-delayed t)
- ;; Make pabbrev-mode expand after Org mode commands
- (put 'org-self-insert-command 'pabbrev-expand-after-command t)
- (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
- (defun org-transpose-words ()
- "Transpose words for Org.
- This uses the `org-mode-transpose-word-syntax-table' syntax
- table, which interprets characters in `org-emphasis-alist' as
- word constituents."
- (interactive)
- (with-syntax-table org-mode-transpose-word-syntax-table
- (call-interactively 'transpose-words)))
- (defvar org-ctrl-c-ctrl-c-hook nil
- "Hook for functions attaching themselves to `C-c C-c'.
- This can be used to add additional functionality to the `C-c C-c'
- key which executes context-dependent commands. This hook is run
- before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
- run after the last test.
- Each function will be called with no arguments. The function
- must check if the context is appropriate for it to act. If yes,
- it should do its thing and then return a non-nil value. If the
- context is wrong, just do nothing and return nil.")
- (defvar org-ctrl-c-ctrl-c-final-hook nil
- "Hook for functions attaching themselves to `C-c C-c'.
- This can be used to add additional functionality to the `C-c C-c'
- key which executes context-dependent commands. This hook is run
- after any other test, while `org-ctrl-c-ctrl-c-hook' is run
- before the first test.
- Each function will be called with no arguments. The function
- must check if the context is appropriate for it to act. If yes,
- it should do its thing and then return a non-nil value. If the
- context is wrong, just do nothing and return nil.")
- (defvar org-tab-after-check-for-table-hook nil
- "Hook for functions to attach themselves to TAB.
- See `org-ctrl-c-ctrl-c-hook' for more information.
- This hook runs after it has been established that the cursor is not in a
- table, but before checking if the cursor is in a headline or if global cycling
- should be done.
- If any function in this hook returns t, not other actions like visibility
- cycling will be done.")
- (defvar org-tab-after-check-for-cycling-hook nil
- "Hook for functions to attach themselves to TAB.
- See `org-ctrl-c-ctrl-c-hook' for more information.
- This hook runs after it has been established that not table field motion and
- not visibility should be done because of current context. This is probably
- the place where a package like yasnippets can hook in.")
- (defvar org-tab-before-tab-emulation-hook nil
- "Hook for functions to attach themselves to TAB.
- See `org-ctrl-c-ctrl-c-hook' for more information.
- This hook runs after every other options for TAB have been exhausted, but
- before indentation and \t insertion takes place.")
- (defvar org-metaleft-hook nil
- "Hook for functions attaching themselves to `M-left'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-metaright-hook nil
- "Hook for functions attaching themselves to `M-right'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-metaup-hook nil
- "Hook for functions attaching themselves to `M-up'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-metadown-hook nil
- "Hook for functions attaching themselves to `M-down'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftmetaleft-hook nil
- "Hook for functions attaching themselves to `M-S-left'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftmetaright-hook nil
- "Hook for functions attaching themselves to `M-S-right'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftmetaup-hook nil
- "Hook for functions attaching themselves to `M-S-up'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftmetadown-hook nil
- "Hook for functions attaching themselves to `M-S-down'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-metareturn-hook nil
- "Hook for functions attaching themselves to `M-RET'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftup-hook nil
- "Hook for functions attaching themselves to `S-up'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftup-final-hook nil
- "Hook for functions attaching themselves to `S-up'.
- This one runs after all other options except shift-select have been excluded.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftdown-hook nil
- "Hook for functions attaching themselves to `S-down'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftdown-final-hook nil
- "Hook for functions attaching themselves to `S-down'.
- This one runs after all other options except shift-select have been excluded.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftleft-hook nil
- "Hook for functions attaching themselves to `S-left'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftleft-final-hook nil
- "Hook for functions attaching themselves to `S-left'.
- This one runs after all other options except shift-select have been excluded.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftright-hook nil
- "Hook for functions attaching themselves to `S-right'.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defvar org-shiftright-final-hook nil
- "Hook for functions attaching themselves to `S-right'.
- This one runs after all other options except shift-select have been excluded.
- See `org-ctrl-c-ctrl-c-hook' for more information.")
- (defun org-modifier-cursor-error ()
- "Throw an error, a modified cursor command was applied in wrong context."
- (user-error "This command is active in special context like tables, headlines or items"))
- (defun org-shiftselect-error ()
- "Throw an error because Shift-Cursor command was applied in wrong context."
- (if (and (boundp 'shift-select-mode) shift-select-mode)
- (user-error "To use shift-selection with Org mode, customize `org-support-shift-select'")
- (user-error "This command works only in special context like headlines or timestamps")))
- (defun org-call-for-shift-select (cmd)
- (let ((this-command-keys-shift-translated t))
- (call-interactively cmd)))
- (defun org-shifttab (&optional arg)
- "Global visibility cycling or move to previous table field.
- Call `org-table-previous-field' within a table.
- When ARG is nil, cycle globally through visibility states.
- When ARG is a numeric prefix, show contents of this level."
- (interactive "P")
- (cond
- ((org-at-table-p) (call-interactively 'org-table-previous-field))
- ((integerp arg)
- (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
- (message "Content view to level: %d" arg)
- (org-cycle-content (prefix-numeric-value arg2))
- (org-cycle-show-empty-lines t)
- (setq org-cycle-global-status 'overview)
- (run-hook-with-args 'org-cycle-hook 'overview)))
- (t (call-interactively 'org-cycle-global))))
- (defun org-shiftmetaleft ()
- "Promote subtree or delete table column.
- Calls `org-promote-subtree', `org-outdent-item-tree', or
- `org-table-delete-column', depending on context. See the
- individual commands for more information."
- (interactive)
- (cond
- ((and (eq system-type 'darwin)
- (or (eq org-support-shift-select 'always)
- (and org-support-shift-select (org-region-active-p))))
- (org-call-for-shift-select 'backward-char))
- ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
- ((org-at-table-p) (call-interactively 'org-table-delete-column))
- ((org-at-heading-p) (call-interactively 'org-promote-subtree))
- ((if (not (org-region-active-p)) (org-at-item-p)
- (save-excursion (goto-char (region-beginning))
- (org-at-item-p)))
- (call-interactively 'org-outdent-item-tree))
- (t (org-modifier-cursor-error))))
- (defun org-shiftmetaright ()
- "Demote subtree or insert table column.
- Calls `org-demote-subtree', `org-indent-item-tree', or
- `org-table-insert-column', depending on context. See the
- individual commands for more information."
- (interactive)
- (cond
- ((and (eq system-type 'darwin)
- (or (eq org-support-shift-select 'always)
- (and org-support-shift-select (org-region-active-p))))
- (org-call-for-shift-select 'forward-char))
- ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
- ((org-at-table-p) (call-interactively 'org-table-insert-column))
- ((org-at-heading-p) (call-interactively 'org-demote-subtree))
- ((if (not (org-region-active-p)) (org-at-item-p)
- (save-excursion (goto-char (region-beginning))
- (org-at-item-p)))
- (call-interactively 'org-indent-item-tree))
- (t (org-modifier-cursor-error))))
- (defun org-shiftmetaup (&optional _arg)
- "Drag the line at point up.
- In a table, kill the current row.
- On a clock timestamp, update the value of the timestamp like `S-<up>'
- but also adjust the previous clocked item in the clock history.
- Everywhere else, drag the line at point up."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
- ((org-at-table-p) (call-interactively 'org-table-kill-row))
- ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
- (call-interactively 'org-timestamp-up)))
- (t (call-interactively 'org-drag-line-backward))))
- (defun org-shiftmetadown (&optional _arg)
- "Drag the line at point down.
- In a table, insert an empty row at the current line.
- On a clock timestamp, update the value of the timestamp like `S-<down>'
- but also adjust the previous clocked item in the clock history.
- Everywhere else, drag the line at point down."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
- ((org-at-table-p) (call-interactively 'org-table-insert-row))
- ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
- (call-interactively 'org-timestamp-down)))
- (t (call-interactively 'org-drag-line-forward))))
- (defsubst org-hidden-tree-error ()
- (user-error
- "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
- (defun org-metaleft (&optional _arg)
- "Promote heading, list item at point or move table column left.
- Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
- depending on context. With no specific context, calls the Emacs
- default `backward-word'. See the individual commands for more
- information.
- This function runs the hook `org-metaleft-hook' as a first step,
- and returns at first non-nil value."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-metaleft-hook))
- ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
- ((org-with-limited-levels
- (or (org-at-heading-p)
- (and (org-region-active-p)
- (save-excursion
- (goto-char (region-beginning))
- (org-at-heading-p)))))
- (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
- (call-interactively 'org-do-promote))
- ;; At an inline task.
- ((org-at-heading-p)
- (call-interactively 'org-inlinetask-promote))
- ((or (org-at-item-p)
- (and (org-region-active-p)
- (save-excursion
- (goto-char (region-beginning))
- (org-at-item-p))))
- (when (org-check-for-hidden 'items) (org-hidden-tree-error))
- (call-interactively 'org-outdent-item))
- (t (call-interactively 'backward-word))))
- (defun org-metaright (&optional _arg)
- "Demote heading, list item at point or move table column right.
- In front of a drawer or a block keyword, indent it correctly.
- Calls `org-do-demote', `org-indent-item', `org-table-move-column',
- `org-indent-drawer' or `org-indent-block' depending on context.
- With no specific context, calls the Emacs default `forward-word'.
- See the individual commands for more information.
- This function runs the hook `org-metaright-hook' as a first step,
- and returns at first non-nil value."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-metaright-hook))
- ((org-at-table-p) (call-interactively 'org-table-move-column))
- ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
- ((org-at-block-p) (call-interactively 'org-indent-block))
- ((org-with-limited-levels
- (or (org-at-heading-p)
- (and (org-region-active-p)
- (save-excursion
- (goto-char (region-beginning))
- (org-at-heading-p)))))
- (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
- (call-interactively 'org-do-demote))
- ;; At an inline task.
- ((org-at-heading-p)
- (call-interactively 'org-inlinetask-demote))
- ((or (org-at-item-p)
- (and (org-region-active-p)
- (save-excursion
- (goto-char (region-beginning))
- (org-at-item-p))))
- (when (org-check-for-hidden 'items) (org-hidden-tree-error))
- (call-interactively 'org-indent-item))
- (t (call-interactively 'forward-word))))
- (defun org-check-for-hidden (what)
- "Check if there are hidden headlines/items in the current visual line.
- WHAT can be either `headlines' or `items'. If the current line is
- an outline or item heading and it has a folded subtree below it,
- this function returns t, nil otherwise."
- (let ((re (cond
- ((eq what 'headlines) org-outline-regexp-bol)
- ((eq what 'items) (org-item-beginning-re))
- (t (error "This should not happen"))))
- beg end)
- (save-excursion
- (catch 'exit
- (unless (org-region-active-p)
- (setq beg (line-beginning-position))
- (beginning-of-line 2)
- (while (and (not (eobp)) ;; this is like `next-line'
- (org-invisible-p (1- (point))))
- (beginning-of-line 2))
- (setq end (point))
- (goto-char beg)
- (goto-char (line-end-position))
- (setq end (max end (point)))
- (while (re-search-forward re end t)
- (when (org-invisible-p (match-beginning 0))
- (throw 'exit t))))
- nil))))
- (defun org-metaup (&optional _arg)
- "Move subtree up or move table row up.
- Calls `org-move-subtree-up' or `org-table-move-row' or
- `org-move-item-up', depending on context. See the individual commands
- for more information."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-metaup-hook))
- ((org-region-active-p)
- (let* ((a (save-excursion
- (goto-char (region-beginning))
- (line-beginning-position)))
- (b (save-excursion
- (goto-char (region-end))
- (if (bolp) (1- (point)) (line-end-position))))
- (c (save-excursion
- (goto-char a)
- (move-beginning-of-line 0)
- (point)))
- (d (save-excursion
- (goto-char a)
- (move-end-of-line 0)
- (point))))
- (transpose-regions a b c d)
- (goto-char c)))
- ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
- ((and (featurep 'org-inlinetask)
- (org-inlinetask-in-task-p))
- (org-drag-element-backward))
- ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
- ((org-at-item-p) (call-interactively 'org-move-item-up))
- (t (org-drag-element-backward))))
- (defun org-metadown (&optional _arg)
- "Move subtree down or move table row down.
- Calls `org-move-subtree-down' or `org-table-move-row' or
- `org-move-item-down', depending on context. See the individual
- commands for more information."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-metadown-hook))
- ((org-region-active-p)
- (let* ((a (save-excursion
- (goto-char (region-beginning))
- (line-beginning-position)))
- (b (save-excursion
- (goto-char (region-end))
- (if (bolp) (1- (point)) (line-end-position))))
- (c (save-excursion
- (goto-char b)
- (move-beginning-of-line (if (bolp) 1 2))
- (point)))
- (d (save-excursion
- (goto-char b)
- (move-end-of-line (if (bolp) 1 2))
- (point))))
- (transpose-regions a b c d)
- (goto-char d)))
- ((org-at-table-p) (call-interactively 'org-table-move-row))
- ((and (featurep 'org-inlinetask)
- (org-inlinetask-in-task-p))
- (org-drag-element-forward))
- ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
- ((org-at-item-p) (call-interactively 'org-move-item-down))
- (t (org-drag-element-forward))))
- (defun org-shiftup (&optional arg)
- "Act on current element according to context.
- Call `org-timestamp-up' or `org-priority-up', or
- `org-previous-item', or `org-table-move-cell-up'. See the
- individual commands for more information."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftup-hook))
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'previous-line))
- ((org-at-timestamp-p 'lax)
- (call-interactively (if org-edit-timestamp-down-means-later
- 'org-timestamp-down 'org-timestamp-up)))
- ((and (not (eq org-support-shift-select 'always))
- org-priority-enable-commands
- (org-at-heading-p))
- (call-interactively 'org-priority-up))
- ((and (not org-support-shift-select) (org-at-item-p))
- (call-interactively 'org-previous-item))
- ((org-clocktable-try-shift 'up arg))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-table-p))
- (org-table-move-cell-up))
- ((run-hook-with-args-until-success 'org-shiftup-final-hook))
- (org-support-shift-select
- (org-call-for-shift-select 'previous-line))
- (t (org-shiftselect-error))))
- (defun org-shiftdown (&optional arg)
- "Act on current element according to context.
- Call `org-timestamp-down' or `org-priority-down', or
- `org-next-item', or `org-table-move-cell-down'. See the
- individual commands for more information."
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftdown-hook))
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'next-line))
- ((org-at-timestamp-p 'lax)
- (call-interactively (if org-edit-timestamp-down-means-later
- 'org-timestamp-up 'org-timestamp-down)))
- ((and (not (eq org-support-shift-select 'always))
- org-priority-enable-commands
- (org-at-heading-p))
- (call-interactively 'org-priority-down))
- ((and (not org-support-shift-select) (org-at-item-p))
- (call-interactively 'org-next-item))
- ((org-clocktable-try-shift 'down arg))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-table-p))
- (org-table-move-cell-down))
- ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
- (org-support-shift-select
- (org-call-for-shift-select 'next-line))
- (t (org-shiftselect-error))))
- (defun org-shiftright (&optional arg)
- "Act on the current element according to context.
- This does one of the following:
- - switch a timestamp at point one day into the future
- - on a headline, switch to the next TODO keyword
- - on an item, switch entire list to the next bullet type
- - on a property line, switch to the next allowed value
- - on a clocktable definition line, move time block into the future
- - in a table, move a single cell right"
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftright-hook))
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'forward-char))
- ((org-at-timestamp-p 'lax) (call-interactively 'org-timestamp-up-day))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-heading-p))
- (let ((org-inhibit-logging
- (not org-treat-S-cursor-todo-selection-as-state-change))
- (org-inhibit-blocking
- (not org-treat-S-cursor-todo-selection-as-state-change)))
- (org-call-with-arg 'org-todo 'right)))
- ((or (and org-support-shift-select
- (not (eq org-support-shift-select 'always))
- (org-at-item-bullet-p))
- (and (not org-support-shift-select) (org-at-item-p)))
- (org-call-with-arg 'org-cycle-list-bullet nil))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-property-p))
- (call-interactively 'org-property-next-allowed-value))
- ((org-clocktable-try-shift 'right arg))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-table-p))
- (org-table-move-cell-right))
- ((run-hook-with-args-until-success 'org-shiftright-final-hook))
- (org-support-shift-select
- (org-call-for-shift-select 'forward-char))
- (t (org-shiftselect-error))))
- (defun org-shiftleft (&optional arg)
- "Act on current element according to context.
- This does one of the following:
- - switch a timestamp at point one day into the past
- - on a headline, switch to the previous TODO keyword.
- - on an item, switch entire list to the previous bullet type
- - on a property line, switch to the previous allowed value
- - on a clocktable definition line, move time block into the past
- - in a table, move a single cell left"
- (interactive "P")
- (cond
- ((run-hook-with-args-until-success 'org-shiftleft-hook))
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'backward-char))
- ((org-at-timestamp-p 'lax) (call-interactively 'org-timestamp-down-day))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-heading-p))
- (let ((org-inhibit-logging
- (not org-treat-S-cursor-todo-selection-as-state-change))
- (org-inhibit-blocking
- (not org-treat-S-cursor-todo-selection-as-state-change)))
- (org-call-with-arg 'org-todo 'left)))
- ((or (and org-support-shift-select
- (not (eq org-support-shift-select 'always))
- (org-at-item-bullet-p))
- (and (not org-support-shift-select) (org-at-item-p)))
- (org-call-with-arg 'org-cycle-list-bullet 'previous))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-property-p))
- (call-interactively 'org-property-previous-allowed-value))
- ((org-clocktable-try-shift 'left arg))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-table-p))
- (org-table-move-cell-left))
- ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
- (org-support-shift-select
- (org-call-for-shift-select 'backward-char))
- (t (org-shiftselect-error))))
- (defun org-shiftcontrolright ()
- "Switch to next TODO set."
- (interactive)
- (cond
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'forward-word))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-heading-p))
- (org-call-with-arg 'org-todo 'nextset))
- (org-support-shift-select
- (org-call-for-shift-select 'forward-word))
- (t (org-shiftselect-error))))
- (defun org-shiftcontrolleft ()
- "Switch to previous TODO set."
- (interactive)
- (cond
- ((and org-support-shift-select (org-region-active-p))
- (org-call-for-shift-select 'backward-word))
- ((and (not (eq org-support-shift-select 'always))
- (org-at-heading-p))
- (org-call-with-arg 'org-todo 'previousset))
- (org-support-shift-select
- (org-call-for-shift-select 'backward-word))
- (t (org-shiftselect-error))))
- (defun org-shiftcontrolup (&optional n)
- "Change timestamps synchronously up in CLOCK log lines.
- Optional argument N tells to change by that many units."
- (interactive "P")
- (if (and (org-at-clock-log-p) (org-at-timestamp-p 'lax))
- (let (org-support-shift-select)
- (org-clock-timestamps-up n))
- (user-error "Not at a clock log")))
- (defun org-shiftcontroldown (&optional n)
- "Change timestamps synchronously down in CLOCK log lines.
- Optional argument N tells to change by that many units."
- (interactive "P")
- (if (and (org-at-clock-log-p) (org-at-timestamp-p 'lax))
- (let (org-support-shift-select)
- (org-clock-timestamps-down n))
- (user-error "Not at a clock log")))
- (defun org-increase-number-at-point (&optional inc)
- "Increment the number at point.
- With an optional prefix numeric argument INC, increment using
- this numeric value."
- (interactive "p")
- (if (not (number-at-point))
- (user-error "Not on a number")
- (unless inc (setq inc 1))
- (let ((pos (point))
- (beg (skip-chars-backward "-+^/*0-9eE."))
- (end (skip-chars-forward "-+^/*0-9eE.")) nap)
- (setq nap (buffer-substring-no-properties
- (+ pos beg) (+ pos beg end)))
- (delete-region (+ pos beg) (+ pos beg end))
- (insert (calc-eval (concat (number-to-string inc) "+" nap))))
- (when (org-at-table-p)
- (org-table-align)
- (org-table-end-of-field 1))))
- (defun org-decrease-number-at-point (&optional inc)
- "Decrement the number at point.
- With an optional prefix numeric argument INC, decrement using
- this numeric value."
- (interactive "p")
- (org-increase-number-at-point (- (or inc 1))))
- (defun org-ctrl-c-ret ()
- "Call `org-table-hline-and-move' or `org-insert-heading'."
- (interactive)
- (cond
- ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
- (t (call-interactively 'org-insert-heading))))
- (defun org-copy-visible (beg end)
- "Copy the visible parts of the region."
- (interactive "r")
- (let ((result ""))
- (while (/= beg end)
- (if (eq org-fold-core-style 'text-properties)
- (progn
- (while (org-invisible-p beg)
- (setq beg (org-fold-next-visibility-change beg end)))
- (let ((next (org-fold-next-visibility-change beg end)))
- (setq result (concat result (buffer-substring beg next)))
- (setq beg next)))
- (when (invisible-p beg)
- (setq beg (next-single-char-property-change beg 'invisible nil end)))
- (let ((next (next-single-char-property-change beg 'invisible nil end)))
- (setq result (concat result (buffer-substring beg next)))
- (setq beg next))))
- ;; Prevent Emacs from adding full selected text to `kill-ring'
- ;; when `select-enable-primary' is non-nil. This special value of
- ;; `deactivate-mark' only works since Emacs 29.
- (setq deactivate-mark 'dont-save)
- (kill-new result)
- (message "Visible strings have been copied to the kill ring.")))
- (defun org-copy-special ()
- "Copy region in table or copy current subtree.
- Calls `org-table-copy-region' or `org-copy-subtree', depending on
- context. See the individual commands for more information."
- (interactive)
- (call-interactively
- (if (org-at-table-p) #'org-table-copy-region #'org-copy-subtree)))
- (defun org-cut-special ()
- "Cut region in table or cut current subtree.
- Calls `org-table-cut-region' or `org-cut-subtree', depending on
- context. See the individual commands for more information."
- (interactive)
- (call-interactively
- (if (org-at-table-p) #'org-table-cut-region #'org-cut-subtree)))
- (defun org-paste-special (arg)
- "Paste rectangular region into table, or past subtree relative to level.
- Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
- See the individual commands for more information."
- (interactive "P")
- (if (org-at-table-p)
- (org-table-paste-rectangle)
- (org-paste-subtree arg)))
- (defun org-edit-special (&optional arg)
- "Call a special editor for the element at point.
- When at a table, call the formula editor with `org-table-edit-formulas'.
- When in a source code block, call `org-edit-src-code'.
- When in a fixed-width region, call `org-edit-fixed-width-region'.
- When in an export block, call `org-edit-export-block'.
- When in a comment block, call `org-edit-comment-block'.
- When in a LaTeX environment, call `org-edit-latex-environment'.
- When at an INCLUDE, SETUPFILE or BIBLIOGRAPHY keyword, visit the included file.
- When at a footnote reference, call `org-edit-footnote-reference'.
- When at a planning line call, `org-deadline' and/or `org-schedule'.
- When at an active timestamp, call `org-time-stamp'.
- When at an inactive timestamp, call `org-time-stamp-inactive'.
- On a link, call `ffap' to visit the link at point.
- Otherwise, return a user error."
- (interactive "P")
- (let ((element (org-element-at-point)))
- (barf-if-buffer-read-only)
- (pcase (org-element-type element)
- (`src-block
- (if (not arg) (org-edit-src-code)
- (let* ((info (org-babel-get-src-block-info))
- (lang (nth 0 info))
- (params (nth 2 info))
- (session (cdr (assq :session params))))
- (if (not session) (org-edit-src-code)
- ;; At a source block with a session and function called
- ;; with an ARG: switch to the buffer related to the
- ;; inferior process.
- (switch-to-buffer
- (funcall (intern (concat "org-babel-prep-session:" lang))
- session params))))))
- (`keyword
- (unless (member (org-element-property :key element)
- '("BIBLIOGRAPHY" "INCLUDE" "SETUPFILE"))
- (user-error "No special environment to edit here"))
- (let ((value (org-element-property :value element)))
- (unless (org-string-nw-p value) (user-error "No file to edit"))
- (let ((file (and (string-match "\\`\"\\(.*?\\)\"\\|\\S-+" value)
- (or (match-string 1 value)
- (match-string 0 value)))))
- (when (org-url-p file)
- (user-error "Files located with a URL cannot be edited"))
- (org-link-open-from-string
- (format "[[%s]]" (expand-file-name file))))))
- (`table
- (if (eq (org-element-property :type element) 'table.el)
- (org-edit-table.el)
- (call-interactively 'org-table-edit-formulas)))
- ;; Only Org tables contain `table-row' type elements.
- (`table-row (call-interactively 'org-table-edit-formulas))
- (`example-block (org-edit-src-code))
- (`export-block (org-edit-export-block))
- (`comment-block (org-edit-comment-block))
- (`fixed-width (org-edit-fixed-width-region))
- (`latex-environment (org-edit-latex-environment))
- (`planning
- (let ((proplist (cadr element)))
- (mapc #'call-interactively
- (remq nil
- (list
- (when (plist-get proplist :deadline) #'org-deadline)
- (when (plist-get proplist :scheduled) #'org-schedule))))))
- (_
- ;; No notable element at point. Though, we may be at a link or
- ;; a footnote reference, which are objects. Thus, scan deeper.
- (let ((context (org-element-context element)))
- (pcase (org-element-type context)
- (`footnote-reference (org-edit-footnote-reference))
- (`inline-src-block (org-edit-inline-src-code))
- (`latex-fragment (org-edit-latex-fragment))
- (`timestamp (if (eq 'inactive (org-element-property :type context))
- (call-interactively #'org-time-stamp-inactive)
- (call-interactively #'org-time-stamp)))
- (`link (call-interactively #'ffap))
- (_ (user-error "No special environment to edit here"))))))))
- (defun org-ctrl-c-ctrl-c (&optional arg)
- "Set tags in headline, or update according to changed information at point.
- This command does many different things, depending on context:
- - If column view is active, in agenda or org buffers, quit it.
- - If there are highlights, remove them.
- - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
- this is what we do.
- - If the cursor is on a statistics cookie, update it.
- - If the cursor is in a headline, in an agenda or an org buffer,
- prompt for tags and insert them into the current line, aligned
- to `org-tags-column'. When called with prefix arg, realign all
- tags in the current buffer.
- - If the cursor is in one of the special #+KEYWORD lines, this
- triggers scanning the buffer for these lines and updating the
- information.
- - If the cursor is inside a table, realign the table. This command
- works even if the automatic table editor has been turned off.
- - If the cursor is on a #+TBLFM line, re-apply the formulas to
- the entire table.
- - If the cursor is at a footnote reference or definition, jump to
- the corresponding definition or references, respectively.
- - If the cursor is a the beginning of a dynamic block, update it.
- - If the current buffer is a capture buffer, close note and file it.
- - If the cursor is on a <<<target>>>, update radio targets and
- corresponding links in this buffer.
- - If the cursor is on a numbered item in a plain list, renumber the
- ordered list.
- - If the cursor is on a checkbox, toggle it.
- - If the cursor is on a code block, evaluate it. The variable
- `org-confirm-babel-evaluate' can be used to control prompting
- before code block evaluation, by default every code block
- evaluation requires confirmation. Code block evaluation can be
- inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
- (interactive "P")
- (cond
- ((bound-and-true-p org-columns-overlays) (org-columns-quit))
- ((or (bound-and-true-p org-clock-overlays) org-occur-highlights)
- (when (boundp 'org-clock-overlays) (org-clock-remove-overlays))
- (org-remove-occur-highlights)
- (message "Temporary highlights/overlays removed from current buffer"))
- ((and (local-variable-p 'org-finish-function)
- (fboundp org-finish-function))
- (funcall org-finish-function))
- ((org-babel-hash-at-point))
- ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
- (t
- (let* ((context
- (org-element-lineage
- (org-element-context)
- ;; Limit to supported contexts.
- '(babel-call clock dynamic-block footnote-definition
- footnote-reference inline-babel-call inline-src-block
- inlinetask item keyword node-property paragraph
- plain-list planning property-drawer radio-target
- src-block statistics-cookie table table-cell table-row
- timestamp)
- t))
- (radio-list-p (org-at-radio-list-p))
- (type (org-element-type context)))
- ;; For convenience: at the first line of a paragraph on the same
- ;; line as an item, apply function on that item instead.
- (when (eq type 'paragraph)
- (let ((parent (org-element-property :parent context)))
- (when (and (eq (org-element-type parent) 'item)
- (= (line-beginning-position)
- (org-element-property :begin parent)))
- (setq context parent)
- (setq type 'item))))
- ;; Act according to type of element or object at point.
- ;;
- ;; Do nothing on a blank line, except if it is contained in
- ;; a source block. Hence, we first check if point is in such
- ;; a block and then if it is at a blank line.
- (pcase type
- ((or `inline-src-block `src-block)
- (unless org-babel-no-eval-on-ctrl-c-ctrl-c
- (org-babel-eval-wipe-error-buffer)
- (org-babel-execute-src-block
- current-prefix-arg (org-babel-get-src-block-info nil context))))
- ((guard (org-match-line "[ \t]*$"))
- (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
- (user-error
- (substitute-command-keys
- "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))
- ((or `babel-call `inline-babel-call)
- (let ((info (org-babel-lob-get-info context)))
- (when info (org-babel-execute-src-block nil info nil type))))
- (`clock (org-clock-update-time-maybe))
- (`dynamic-block
- (save-excursion
- (goto-char (org-element-property :post-affiliated context))
- (org-update-dblock)))
- (`footnote-definition
- (goto-char (org-element-property :post-affiliated context))
- (call-interactively 'org-footnote-action))
- (`footnote-reference (call-interactively #'org-footnote-action))
- ((or `headline `inlinetask)
- (save-excursion (goto-char (org-element-property :begin context))
- (call-interactively #'org-set-tags-command)))
- (`item
- ;; At an item: `C-u C-u' sets checkbox to "[-]"
- ;; unconditionally, whereas `C-u' will toggle its presence.
- ;; Without a universal argument, if the item has a checkbox,
- ;; toggle it. Otherwise repair the list.
- (if (or radio-list-p
- (and (boundp org-list-checkbox-radio-mode)
- org-list-checkbox-radio-mode))
- (org-toggle-radio-button arg)
- (let* ((box (org-element-property :checkbox context))
- (struct (org-element-property :structure context))
- (old-struct (copy-tree struct))
- (parents (org-list-parents-alist struct))
- (prevs (org-list-prevs-alist struct))
- (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
- (org-list-set-checkbox
- (org-element-property :begin context) struct
- (cond ((equal arg '(16)) "[-]")
- ((and (not box) (equal arg '(4))) "[ ]")
- ((or (not box) (equal arg '(4))) nil)
- ((eq box 'on) "[ ]")
- (t "[X]")))
- ;; Mimic `org-list-write-struct' but with grabbing a return
- ;; value from `org-list-struct-fix-box'.
- (org-list-struct-fix-ind struct parents 2)
- (org-list-struct-fix-item-end struct)
- (org-list-struct-fix-bul struct prevs)
- (org-list-struct-fix-ind struct parents)
- (let ((block-item
- (org-list-struct-fix-box struct parents prevs orderedp)))
- (if (and box (equal struct old-struct))
- (if (equal arg '(16))
- (message "Checkboxes already reset")
- (user-error "Cannot toggle this checkbox: %s"
- (if (eq box 'on)
- "all subitems checked"
- "unchecked subitems")))
- (org-list-struct-apply-struct struct old-struct)
- (org-update-checkbox-count-maybe))
- (when block-item
- (message "Checkboxes were removed due to empty box at line %d"
- (org-current-line block-item)))))))
- (`plain-list
- ;; At a plain list, with a double C-u argument, set
- ;; checkboxes of each item to "[-]", whereas a single one
- ;; will toggle their presence according to the state of the
- ;; first item in the list. Without an argument, repair the
- ;; list.
- (if (or radio-list-p
- (and (boundp org-list-checkbox-radio-mode)
- org-list-checkbox-radio-mode))
- (org-toggle-radio-button arg)
- (let* ((begin (org-element-property :contents-begin context))
- (struct (org-element-property :structure context))
- (old-struct (copy-tree struct))
- (first-box (save-excursion
- (goto-char begin)
- (looking-at org-list-full-item-re)
- (match-string-no-properties 3)))
- (new-box (cond ((equal arg '(16)) "[-]")
- ((equal arg '(4)) (unless first-box "[ ]"))
- ((equal first-box "[X]") "[ ]")
- (t "[X]"))))
- (cond
- (arg
- (dolist (pos
- (org-list-get-all-items
- begin struct (org-list-prevs-alist struct)))
- (org-list-set-checkbox pos struct new-box)))
- ((and first-box (eq (point) begin))
- ;; For convenience, when point is at bol on the first
- ;; item of the list and no argument is provided, simply
- ;; toggle checkbox of that item, if any.
- (org-list-set-checkbox begin struct new-box)))
- (when (equal
- (org-list-write-struct
- struct (org-list-parents-alist struct) old-struct)
- old-struct)
- (message "Cannot update this checkbox"))
- (org-update-checkbox-count-maybe))))
- (`keyword
- (let ((org-inhibit-startup-visibility-stuff t)
- (org-startup-align-all-tables nil))
- (when (boundp 'org-table-coordinate-overlays)
- (mapc #'delete-overlay org-table-coordinate-overlays)
- (setq org-table-coordinate-overlays nil))
- (org-save-outline-visibility 'use-markers (org-mode-restart)))
- (message "Local setup has been refreshed"))
- ((or `property-drawer `node-property)
- (call-interactively #'org-property-action))
- (`radio-target
- (call-interactively #'org-update-radio-target-regexp))
- (`statistics-cookie
- (call-interactively #'org-update-statistics-cookies))
- ((or `table `table-cell `table-row)
- ;; At a table, generate a plot if on the #+plot line,
- ;; recalculate every field and align it otherwise. Also
- ;; send the table if necessary.
- (cond
- ((and (org-match-line "[ \t]*#\\+plot:")
- (< (point) (org-element-property :post-affiliated context)))
- (org-plot/gnuplot))
- ;; If the table has a `table.el' type, just give up.
- ((eq (org-element-property :type context) 'table.el)
- (message "%s" (substitute-command-keys "\\<org-mode-map>\
- Use `\\[org-edit-special]' to edit table.el tables")))
- ;; At a table row or cell, maybe recalculate line but always
- ;; align table.
- ((or (eq type 'table)
- ;; Check if point is at a TBLFM line.
- (and (eq type 'table-row)
- (= (point) (org-element-property :end context))))
- (save-excursion
- (if (org-at-TBLFM-p)
- (progn (require 'org-table)
- (org-table-calc-current-TBLFM))
- (goto-char (org-element-property :contents-begin context))
- (org-call-with-arg 'org-table-recalculate (or arg t))
- (orgtbl-send-table 'maybe))))
- (t
- (org-table-maybe-eval-formula)
- (cond (arg (call-interactively #'org-table-recalculate))
- ((org-table-maybe-recalculate-line))
- (t (org-table-align))))))
- ((or `timestamp (and `planning (guard (org-at-timestamp-p 'lax))))
- (org-timestamp-change 0 'day))
- ((and `nil (guard (org-at-heading-p)))
- ;; When point is on an unsupported object type, we can miss
- ;; the fact that it also is at a heading. Handle it here.
- (call-interactively #'org-set-tags-command))
- ((guard
- (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)))
- (_
- (user-error
- (substitute-command-keys
- "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))))))
- (defun org-mode-restart ()
- "Restart `org-mode'."
- (interactive)
- (let ((indent-status (bound-and-true-p org-indent-mode)))
- (funcall major-mode)
- (hack-local-variables)
- (when (and indent-status (not (bound-and-true-p org-indent-mode)))
- (org-indent-mode -1))
- (org-reset-file-cache))
- (message "%s restarted" major-mode))
- (defun org-kill-note-or-show-branches ()
- "Abort storing current note, or show just branches."
- (interactive)
- (cond (org-finish-function
- (let ((org-note-abort t)) (funcall org-finish-function)))
- ((org-before-first-heading-p)
- (org-fold-show-branches-buffer)
- (org-fold-hide-archived-subtrees (point-min) (point-max)))
- (t
- (let ((beg (progn (org-back-to-heading) (point)))
- (end (save-excursion (org-end-of-subtree t t) (point))))
- (org-fold-hide-subtree)
- (org-fold-show-branches)
- (org-fold-hide-archived-subtrees beg end)))))
- (defun org-delete-indentation (&optional arg)
- "Join current line to previous and fix whitespace at join.
- If previous line is a headline add to headline title. Otherwise
- the function calls `delete-indentation'.
- I.e. with a non-nil optional argument, join the line with the
- following one. If there is a region then join the lines in that
- region."
- (interactive "*P")
- (if (save-excursion
- (beginning-of-line (if arg 1 0))
- (let ((case-fold-search nil))
- (looking-at org-complex-heading-regexp)))
- ;; At headline.
- (let ((tags-column (when (match-beginning 5)
- (save-excursion (goto-char (match-beginning 5))
- (current-column))))
- (string (concat " " (progn (when arg (forward-line 1))
- (org-trim (delete-and-extract-region
- (line-beginning-position)
- (line-end-position)))))))
- (unless (bobp) (delete-region (point) (1- (point))))
- (goto-char (or (match-end 4)
- (match-beginning 5)
- (match-end 0)))
- (skip-chars-backward " \t")
- (save-excursion (insert string))
- ;; Adjust alignment of tags.
- (cond
- ((not tags-column)) ;no tags
- (org-auto-align-tags (org-align-tags))
- (t (org--align-tags-here tags-column)))) ;preserve tags column
- (let ((current-prefix-arg arg))
- (call-interactively #'delete-indentation))))
- (defun org-open-line (n)
- "Insert a new row in tables, call `open-line' elsewhere.
- If `org-special-ctrl-o' is nil, just call `open-line' everywhere.
- As a special case, when a document starts with a table, allow to
- call `open-line' on the very first character."
- (interactive "*p")
- (if (and org-special-ctrl-o (/= (point) 1) (org-at-table-p))
- (org-table-insert-row)
- (open-line n)))
- (defun org--newline (indent arg interactive)
- "Call `newline-and-indent' or just `newline'.
- If INDENT is non-nil, call `newline-and-indent' with ARG to
- indent unconditionally; otherwise, call `newline' with ARG and
- INTERACTIVE, which can trigger indentation if
- `electric-indent-mode' is enabled."
- (if indent
- (org-newline-and-indent arg)
- (newline arg interactive)))
- (defun org-return (&optional indent arg interactive)
- "Goto next table row or insert a newline.
- Calls `org-table-next-row' or `newline', depending on context.
- When optional INDENT argument is non-nil, call
- `newline-and-indent' with ARG, otherwise call `newline' with ARG
- and INTERACTIVE.
- When `org-return-follows-link' is non-nil and point is on
- a timestamp or a link, call `org-open-at-point'. However, it
- will not happen if point is in a table or on a \"dead\"
- object (e.g., within a comment). In these case, you need to use
- `org-open-at-point' directly."
- (interactive "i\nP\np")
- (let* ((context (if org-return-follows-link (org-element-context)
- (org-element-at-point)))
- (element-type (org-element-type context)))
- (cond
- ;; In a table, call `org-table-next-row'. However, before first
- ;; column or after last one, split the table.
- ((or (and (eq 'table element-type)
- (not (eq 'table.el (org-element-property :type context)))
- (>= (point) (org-element-property :contents-begin context))
- (< (point) (org-element-property :contents-end context)))
- (org-element-lineage context '(table-row table-cell) t))
- (if (or (looking-at-p "[ \t]*$")
- (save-excursion (skip-chars-backward " \t") (bolp)))
- (insert "\n")
- (org-table-justify-field-maybe)
- (call-interactively #'org-table-next-row)))
- ;; On a link or a timestamp, call `org-open-at-point' if
- ;; `org-return-follows-link' allows it. Tolerate fuzzy
- ;; locations, e.g., in a comment, as `org-open-at-point'.
- ((and org-return-follows-link
- (or (and (eq 'link element-type)
- ;; Ensure point is not on the white spaces after
- ;; the link.
- (let ((origin (point)))
- (org-with-point-at (org-element-property :end context)
- (skip-chars-backward " \t")
- (> (point) origin))))
- (org-in-regexp org-ts-regexp-both nil t)
- (org-in-regexp org-tsr-regexp-both nil t)
- (org-in-regexp org-link-any-re nil t)))
- (call-interactively #'org-open-at-point))
- ;; Insert newline in heading, but preserve tags.
- ((and (not (bolp))
- (let ((case-fold-search nil))
- (org-match-line org-complex-heading-regexp)))
- ;; At headline. Split line. However, if point is on keyword,
- ;; priority cookie or tags, do not break any of them: add
- ;; a newline after the headline instead.
- (let ((tags-column (and (match-beginning 5)
- (save-excursion (goto-char (match-beginning 5))
- (current-column))))
- (string
- (when (and (match-end 4) (org-point-in-group (point) 4))
- (delete-and-extract-region (point) (match-end 4)))))
- ;; Adjust tag alignment.
- (cond
- ((not (and tags-column string)))
- (org-auto-align-tags (org-align-tags))
- (t (org--align-tags-here tags-column))) ;preserve tags column
- (end-of-line)
- (org-fold-show-entry 'hide-drawers)
- (org--newline indent arg interactive)
- (when string (save-excursion (insert (org-trim string))))))
- ;; In a list, make sure indenting keeps trailing text within.
- ((and (not (eolp))
- (org-element-lineage context '(item)))
- (let ((trailing-data
- (delete-and-extract-region (point) (line-end-position))))
- (org--newline indent arg interactive)
- (save-excursion (insert trailing-data))))
- (t
- ;; Do not auto-fill when point is in an Org property drawer.
- (let ((auto-fill-function (and (not (org-at-property-p))
- auto-fill-function)))
- (org--newline indent arg interactive))))))
- (defun org-return-and-maybe-indent ()
- "Goto next table row, or insert a newline, maybe indented.
- Call `org-table-next-row' or `org-return', depending on context.
- See the individual commands for more information.
- When inserting a newline, if `org-adapt-indentation' is t:
- indent the line if `electric-indent-mode' is disabled, don't
- indent it if it is enabled."
- (interactive)
- (org-return (not electric-indent-mode)))
- (defun org-ctrl-c-tab (&optional arg)
- "Toggle columns width in a table, or show children.
- Call `org-table-toggle-column-width' if point is in a table.
- Otherwise provide a compact view of the children. ARG is the
- level to hide."
- (interactive "p")
- (cond
- ((org-at-table-p)
- (call-interactively #'org-table-toggle-column-width))
- ((org-before-first-heading-p)
- (save-excursion
- (org-fold-flag-above-first-heading)
- (org-fold-hide-sublevels (or arg 1))))
- (t
- (org-fold-hide-subtree)
- (org-fold-show-children arg))))
- (defun org-ctrl-c-star ()
- "Compute table, or change heading status of lines.
- Calls `org-table-recalculate' or `org-toggle-heading',
- depending on context."
- (interactive)
- (cond
- ((org-at-table-p)
- (call-interactively 'org-table-recalculate))
- (t
- ;; Convert all lines in region to list items
- (call-interactively 'org-toggle-heading))))
- (defun org-ctrl-c-minus ()
- "Insert separator line in table or modify bullet status of line.
- Also turns a plain line or a region of lines into list items.
- Calls `org-table-insert-hline', `org-toggle-item', or
- `org-cycle-list-bullet', depending on context."
- (interactive)
- (cond
- ((org-at-table-p)
- (call-interactively 'org-table-insert-hline))
- ((org-region-active-p)
- (call-interactively 'org-toggle-item))
- ((org-in-item-p)
- (call-interactively 'org-cycle-list-bullet))
- (t
- (call-interactively 'org-toggle-item))))
- (defun org-toggle-heading (&optional nstars)
- "Convert headings to normal text, or items or text to headings.
- If there is no active region, only convert the current line.
- With a `\\[universal-argument]' prefix, convert the whole list at
- point into heading.
- In a region:
- - If the first non blank line is a headline, remove the stars
- from all headlines in the region.
- - If it is a normal line, turn each and every normal line (i.e.,
- not an heading or an item) in the region into headings. If you
- want to convert only the first line of this region, use one
- universal prefix argument.
- - If it is a plain list item, turn all plain list items into headings.
- When converting a line into a heading, the number of stars is chosen
- such that the lines become children of the current entry. However,
- when a numeric prefix argument is given, its value determines the
- number of stars to add."
- (interactive "P")
- (let ((skip-blanks
- ;; Return beginning of first non-blank line, starting from
- ;; line at POS.
- (lambda (pos)
- (save-excursion
- (goto-char pos)
- (while (org-at-comment-p) (forward-line))
- (skip-chars-forward " \r\t\n")
- (line-beginning-position))))
- beg end toggled)
- ;; Determine boundaries of changes. If a universal prefix has
- ;; been given, put the list in a region. If region ends at a bol,
- ;; do not consider the last line to be in the region.
- (when (and current-prefix-arg (org-at-item-p))
- (when (listp current-prefix-arg) (setq current-prefix-arg 1))
- (org-mark-element))
- (if (org-region-active-p)
- (setq beg (funcall skip-blanks (region-beginning))
- end (copy-marker (save-excursion
- (goto-char (region-end))
- (if (bolp) (point) (line-end-position)))))
- (setq beg (funcall skip-blanks (line-beginning-position))
- end (copy-marker (line-end-position))))
- ;; Ensure inline tasks don't count as headings.
- (org-with-limited-levels
- (save-excursion
- (goto-char beg)
- (cond
- ;; Case 1. Started at an heading: de-star headings.
- ((org-at-heading-p)
- (while (< (point) end)
- (when (org-at-heading-p)
- (looking-at org-outline-regexp) (replace-match "")
- (setq toggled t))
- (forward-line)))
- ;; Case 2. Started at an item: change items into headlines.
- ;; One star will be added by `org-list-to-subtree'.
- ((org-at-item-p)
- (while (< (point) end)
- (when (org-at-item-p)
- ;; Pay attention to cases when region ends before list.
- (let* ((struct (org-list-struct))
- (list-end
- (min (org-list-get-bottom-point struct) (1+ end))))
- (save-restriction
- (narrow-to-region (point) list-end)
- (insert (org-list-to-subtree
- (org-list-to-lisp t)
- (pcase (org-current-level)
- (`nil 1)
- (l (1+ (org-reduced-level l)))))
- "\n")))
- (setq toggled t))
- (forward-line)))
- ;; Case 3. Started at normal text: make every line an heading,
- ;; skipping headlines and items.
- (t (let* ((stars
- (make-string
- (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
- (add-stars
- (cond (nstars "") ; stars from prefix only
- ((equal stars "") "*") ; before first heading
- (org-odd-levels-only "**") ; inside heading, odd
- (t "*"))) ; inside heading, oddeven
- (rpl (concat stars add-stars " "))
- (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
- (while (< (point) (if (equal nstars '(4)) lend end))
- (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
- (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
- (replace-match (concat rpl (match-string 2))) (setq toggled t))
- (forward-line)))))))
- (unless toggled (message "Cannot toggle heading from here"))))
- (defun org-meta-return (&optional arg)
- "Insert a new heading or wrap a region in a table.
- Calls `org-insert-heading', `org-insert-item' or
- `org-table-wrap-region', depending on context. When called with
- an argument, unconditionally call `org-insert-heading'."
- (interactive "P")
- (org-fold-check-before-invisible-edit 'insert)
- (or (run-hook-with-args-until-success 'org-metareturn-hook)
- (call-interactively (cond (arg #'org-insert-heading)
- ((org-at-table-p) #'org-table-wrap-region)
- ((org-in-item-p) #'org-insert-item)
- (t #'org-insert-heading)))))
- ;;; Menu entries
- (defsubst org-in-subtree-not-table-p ()
- "Are we in a subtree and not in a table?"
- (and (not (org-before-first-heading-p))
- (not (org-at-table-p))))
- ;; Define the Org mode menus
- (easy-menu-define org-org-menu org-mode-map "Org menu."
- `("Org"
- ("Show/Hide"
- ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
- ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
- ["Sparse Tree..." org-sparse-tree t]
- ["Reveal Context" org-fold-reveal t]
- ["Show All" org-fold-show-all t]
- "--"
- ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
- "--"
- ["New Heading" org-insert-heading t]
- ("Navigate Headings"
- ["Up" outline-up-heading t]
- ["Next" outline-next-visible-heading t]
- ["Previous" outline-previous-visible-heading t]
- ["Next Same Level" outline-forward-same-level t]
- ["Previous Same Level" outline-backward-same-level t]
- "--"
- ["Jump" org-goto t])
- ("Edit Structure"
- ["Move Subtree Up" org-metaup (org-at-heading-p)]
- ["Move Subtree Down" org-metadown (org-at-heading-p)]
- "--"
- ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
- ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
- ["Paste Subtree" org-paste-special (not (org-at-table-p))]
- "--"
- ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
- "--"
- ["Copy visible text" org-copy-visible t]
- "--"
- ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
- ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
- ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
- ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
- "--"
- ["Sort Region/Children" org-sort t]
- "--"
- ["Convert to odd levels" org-convert-to-odd-levels t]
- ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
- ("Editing"
- ["Emphasis..." org-emphasize t]
- ["Add block structure" org-insert-structure-template t]
- ["Edit Source Example" org-edit-special t]
- "--"
- ["Footnote new/jump" org-footnote-action t]
- ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
- ("Archive"
- ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
- "--"
- ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
- ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
- ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)])
- "--"
- ("Hyperlinks"
- ["Store Link (Global)" org-store-link t]
- ["Find existing link to here" org-occur-link-in-agenda-files t]
- ["Insert Link" org-insert-link t]
- ["Follow Link" org-open-at-point t]
- "--"
- ["Next link" org-next-link t]
- ["Previous link" org-previous-link t]
- "--"
- ["Descriptive Links"
- org-toggle-link-display
- :style radio
- :selected org-descriptive-links
- ]
- ["Literal Links"
- org-toggle-link-display
- :style radio
- :selected (not org-descriptive-links)])
- "--"
- ("TODO Lists"
- ["TODO/DONE/-" org-todo t]
- ("Select keyword"
- ["Next keyword" org-shiftright (org-at-heading-p)]
- ["Previous keyword" org-shiftleft (org-at-heading-p)]
- ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
- ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
- ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
- ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
- ["Global TODO list" org-todo-list :active t :keys "\\[org-agenda] t"]
- "--"
- ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
- :selected org-enforce-todo-dependencies :style toggle :active t]
- "Settings for tree at point"
- ["Do Children sequentially" org-toggle-ordered-property :style radio
- :selected (org-entry-get nil "ORDERED")
- :active org-enforce-todo-dependencies :keys "C-c C-x o"]
- ["Do Children parallel" org-toggle-ordered-property :style radio
- :selected (not (org-entry-get nil "ORDERED"))
- :active org-enforce-todo-dependencies :keys "C-c C-x o"]
- "--"
- ["Set Priority" org-priority t]
- ["Priority Up" org-shiftup t]
- ["Priority Down" org-shiftdown t]
- "--"
- ["Get news from all feeds" org-feed-update-all t]
- ["Go to the inbox of a feed..." org-feed-goto-inbox t]
- ["Customize feeds" (customize-variable 'org-feed-alist) t])
- ("TAGS and Properties"
- ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
- ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
- "--"
- ["Set property" org-set-property (not (org-before-first-heading-p))]
- ["Column view of properties" org-columns t]
- ["Insert Column View DBlock" org-columns-insert-dblock t])
- ("Dates and Scheduling"
- ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
- ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
- ("Change Date"
- ["1 Day Later" org-shiftright (org-at-timestamp-p 'lax)]
- ["1 Day Earlier" org-shiftleft (org-at-timestamp-p 'lax)]
- ["1 ... Later" org-shiftup (org-at-timestamp-p 'lax)]
- ["1 ... Earlier" org-shiftdown (org-at-timestamp-p 'lax)])
- ["Compute Time Range" org-evaluate-time-range t]
- ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
- ["Deadline" org-deadline (not (org-before-first-heading-p))]
- "--"
- ["Custom time format" org-toggle-time-stamp-overlays
- :style radio :selected org-display-custom-times]
- "--"
- ["Goto Calendar" org-goto-calendar t]
- ["Date from Calendar" org-date-from-calendar t]
- "--"
- ["Start/Restart Timer" org-timer-start t]
- ["Pause/Continue Timer" org-timer-pause-or-continue t]
- ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
- ["Insert Timer String" org-timer t]
- ["Insert Timer Item" org-timer-item t])
- ("Logging work"
- ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
- ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
- ["Clock out" org-clock-out t]
- ["Clock cancel" org-clock-cancel t]
- "--"
- ["Mark as default task" org-clock-mark-default-task t]
- ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
- ["Goto running clock" org-clock-goto t]
- "--"
- ["Display times" org-clock-display t]
- ["Create clock table" org-clock-report t]
- "--"
- ["Record DONE time"
- (progn (setq org-log-done (not org-log-done))
- (message "Switching to %s will %s record a timestamp"
- (car org-done-keywords)
- (if org-log-done "automatically" "not")))
- :style toggle :selected org-log-done])
- "--"
- ["Agenda Command..." org-agenda t]
- ["Set Restriction Lock" org-agenda-set-restriction-lock t]
- ("File List for Agenda")
- ("Special views current file"
- ["TODO Tree" org-show-todo-tree t]
- ["Check Deadlines" org-check-deadlines t]
- ["Tags/Property tree" org-match-sparse-tree t])
- "--"
- ["Export/Publish..." org-export-dispatch t]
- ("LaTeX"
- ["Org CDLaTeX mode" org-cdlatex-mode :active (require 'cdlatex nil t)
- :style toggle :selected org-cdlatex-mode]
- ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
- ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
- ["Modify math symbol" org-cdlatex-math-modify
- (org-inside-LaTeX-fragment-p)]
- ["Insert citation" org-reftex-citation t])
- "--"
- ("Documentation"
- ["Show Version" org-version t]
- ["Info Documentation" org-info t]
- ["Browse Org News" org-browse-news t])
- ("Customize"
- ["Browse Org Group" org-customize t]
- "--"
- ["Expand This Menu" org-create-customize-menu t])
- ["Send bug report" org-submit-bug-report t]
- "--"
- ("Refresh/Reload"
- ["Refresh setup current buffer" org-mode-restart t]
- ["Reload Org (after update)" org-reload t]
- ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])))
- (easy-menu-define org-tbl-menu org-mode-map "Org Table menu."
- '("Table"
- ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
- ["Next Field" org-cycle (org-at-table-p)]
- ["Previous Field" org-shifttab (org-at-table-p)]
- ["Next Row" org-return (org-at-table-p)]
- "--"
- ["Blank Field" org-table-blank-field (org-at-table-p)]
- ["Edit Field" org-table-edit-field (org-at-table-p)]
- ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
- "--"
- ("Column"
- ["Move Column Left" org-metaleft (org-at-table-p)]
- ["Move Column Right" org-metaright (org-at-table-p)]
- ["Delete Column" org-shiftmetaleft (org-at-table-p)]
- ["Insert Column" org-shiftmetaright (org-at-table-p)]
- ["Shrink Column" org-table-toggle-column-width (org-at-table-p)])
- ("Row"
- ["Move Row Up" org-metaup (org-at-table-p)]
- ["Move Row Down" org-metadown (org-at-table-p)]
- ["Delete Row" org-shiftmetaup (org-at-table-p)]
- ["Insert Row" org-shiftmetadown (org-at-table-p)]
- ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
- "--"
- ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
- ("Rectangle"
- ["Copy Rectangle" org-copy-special (org-at-table-p)]
- ["Cut Rectangle" org-cut-special (org-at-table-p)]
- ["Paste Rectangle" org-paste-special (org-at-table-p)]
- ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
- "--"
- ("Calculate"
- ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
- ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
- ["Edit Formulas" org-edit-special (org-at-table-p)]
- "--"
- ["Recalculate line" org-table-recalculate (org-at-table-p)]
- ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
- ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
- "--"
- ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
- "--"
- ["Sum Column/Rectangle" org-table-sum
- (or (org-at-table-p) (org-region-active-p))]
- ["Which Column?" org-table-current-column (org-at-table-p)])
- ["Debug Formulas"
- org-table-toggle-formula-debugger
- :style toggle :selected (bound-and-true-p org-table-formula-debug)]
- ["Show Col/Row Numbers"
- org-table-toggle-coordinate-overlays
- :style toggle
- :selected (bound-and-true-p org-table-overlay-coordinates)]
- "--"
- ["Create" org-table-create (not (org-at-table-p))]
- ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
- ["Import from File" org-table-import (not (org-at-table-p))]
- ["Export to File" org-table-export (org-at-table-p)]
- "--"
- ["Create/Convert from/to table.el" org-table-create-with-table.el t]
- "--"
- ("Plot"
- ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
- ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
- (defun org-info (&optional node)
- "Read documentation for Org in the info system.
- With optional NODE, go directly to that node."
- (interactive)
- (info (format "(org)%s" (or node ""))))
- (defun org-browse-news ()
- "Browse the news for the latest major release."
- (interactive)
- (browse-url "https://orgmode.org/Changes.html"))
- ;;;###autoload
- (defun org-submit-bug-report ()
- "Submit a bug report on Org via mail.
- Don't hesitate to report any problems or inaccurate documentation.
- If you don't have setup sending mail from (X)Emacs, please copy the
- output buffer into your mail program, as it gives us important
- information about your Org version and configuration."
- (interactive)
- (require 'reporter)
- (defvar reporter-prompt-for-summary-p)
- (org-load-modules-maybe)
- (org-require-autoloaded-modules)
- (let ((reporter-prompt-for-summary-p "Bug report subject: "))
- (reporter-submit-bug-report
- "emacs-orgmode@gnu.org"
- (org-version nil 'full)
- (let (list)
- (save-window-excursion
- (pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
- (delete-other-windows)
- (erase-buffer)
- (insert "You are about to submit a bug report to the Org mailing list.
- If your report is about Org installation, please read this section:
- https://orgmode.org/org.html#Installation
- Please read https://orgmode.org/org.html#Feedback on how to make
- a good report, it will help Org contributors fixing your problem.
- Search https://lists.gnu.org/archive/html/emacs-orgmode/ to see
- if the issue you are about to raise has already been dealt with.
- We also would like to add your full Org and Outline configuration
- to the bug report. It will help us debugging the issue.
- *HOWEVER*, some variables you have customized may contain private
- information. The names of customers, colleagues, or friends, might
- appear in the form of file names, tags, todo states or search strings.
- If you answer \"yes\" to the prompt, you might want to check and remove
- such private information before sending the email.")
- (add-text-properties (point-min) (point-max) '(face org-warning))
- (when (yes-or-no-p "Include your Org configuration ")
- (mapatoms
- (lambda (v)
- (and (boundp v)
- (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
- (or (and (symbol-value v)
- (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
- (and
- (get v 'custom-type) (get v 'standard-value)
- (not (equal (symbol-value v)
- (eval (car (get v 'standard-value)) t)))))
- (push v list)))))
- (kill-buffer (get-buffer "*Warn about privacy*"))
- list))
- nil nil
- "Remember to cover the basics, that is, what you expected to happen and
- what in fact did happen. You don't know how to make a good report? See
- https://orgmode.org/manual/Feedback.html#Feedback
- Your bug report will be posted to the Org mailing list.
- ------------------------------------------------------------------------")
- (save-excursion
- (when (re-search-backward "^\\(Subject: \\)Org mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
- (replace-match "\\1[BUG] \\3 [\\2]")))))
- (defun org-install-agenda-files-menu ()
- "Install agenda file menu."
- (let ((bl (buffer-list)))
- (save-excursion
- (while bl
- (set-buffer (pop bl))
- (when (derived-mode-p 'org-mode) (setq bl nil)))
- (when (derived-mode-p 'org-mode)
- (easy-menu-change
- '("Org") "File List for Agenda"
- (append
- (list
- ["Edit File List" (org-edit-agenda-file-list) t]
- ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
- ["Remove Current File from List" org-remove-file t]
- ["Cycle through agenda files" org-cycle-agenda-files t]
- ["Occur in all agenda files" org-occur-in-agenda-files t]
- "--")
- (mapcar 'org-file-menu-entry
- ;; Prevent initialization from failing.
- (ignore-errors (org-agenda-files t)))))))))
- ;;;; Documentation
- (defun org-require-autoloaded-modules ()
- (interactive)
- (mapc #'require
- '(org-agenda org-archive org-attach org-clock org-colview org-id
- org-table org-timer)))
- ;;;###autoload
- (defun org-reload (&optional uncompiled)
- "Reload all Org Lisp files.
- With prefix arg UNCOMPILED, load the uncompiled versions."
- (interactive "P")
- (require 'loadhist)
- (let* ((org-dir (org-find-library-dir "org"))
- (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
- (feature-re "^\\(org\\|ob\\|ox\\|ol\\|oc\\)\\(-.*\\)?")
- (remove-re (format "\\`%s\\'"
- (regexp-opt '("org" "org-loaddefs" "org-version"))))
- (feats (delete-dups
- (mapcar 'file-name-sans-extension
- (mapcar 'file-name-nondirectory
- (delq nil
- (mapcar 'feature-file
- features))))))
- (lfeat (append
- (sort
- (setq feats
- (delq nil (mapcar
- (lambda (f)
- (if (and (string-match feature-re f)
- (not (string-match remove-re f)))
- f nil))
- feats)))
- 'string-lessp)
- (list "org-version" "org")))
- (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
- load-uncore load-misses)
- (setq load-misses
- (delq t
- (mapcar (lambda (f)
- (or (org-load-noerror-mustsuffix (concat org-dir f))
- (and (string= org-dir contrib-dir)
- (org-load-noerror-mustsuffix (concat contrib-dir f)))
- (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
- (push f load-uncore)
- t)
- f))
- lfeat)))
- (when load-uncore
- (message "The following feature%s found in load-path, please check if that's correct:\n%s"
- (if (> (length load-uncore) 1) "s were" " was")
- (reverse load-uncore)))
- (if load-misses
- (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
- (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
- (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
- ;;;###autoload
- (defun org-customize ()
- "Call the customize function with org as argument."
- (interactive)
- (org-load-modules-maybe)
- (org-require-autoloaded-modules)
- (customize-browse 'org))
- (defun org-create-customize-menu ()
- "Create a full customization menu for Org mode, insert it into the menu."
- (interactive)
- (org-load-modules-maybe)
- (org-require-autoloaded-modules)
- (easy-menu-change
- '("Org") "Customize"
- `(["Browse Org group" org-customize t]
- "--"
- ,(customize-menu-create 'org)
- ["Set" Custom-set t]
- ["Save" Custom-save t]
- ["Reset to Current" Custom-reset-current t]
- ["Reset to Saved" Custom-reset-saved t]
- ["Reset to Standard Settings" Custom-reset-standard t]))
- (message "\"Org\"-menu now contains full customization menu"))
- ;;;; Miscellaneous stuff
- ;;; Generally useful functions
- (defun org-in-clocktable-p ()
- "Check if the cursor is in a clocktable."
- (let ((pos (point)) start)
- (save-excursion
- (end-of-line 1)
- (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
- (setq start (match-beginning 0))
- (re-search-forward "^[ \t]*#\\+END:.*" nil t)
- (>= (match-end 0) pos)
- start))))
- (defun org-in-verbatim-emphasis ()
- (save-match-data
- (and (org-in-regexp org-verbatim-re 2)
- (>= (point) (match-beginning 3))
- (<= (point) (match-end 4)))))
- (defun org-goto-marker-or-bmk (marker &optional bookmark)
- "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
- (if (and marker (marker-buffer marker)
- (buffer-live-p (marker-buffer marker)))
- (progn
- (pop-to-buffer-same-window (marker-buffer marker))
- (when (or (> marker (point-max)) (< marker (point-min)))
- (widen))
- (goto-char marker)
- (org-fold-show-context 'org-goto))
- (if bookmark
- (bookmark-jump bookmark)
- (error "Cannot find location"))))
- (defun org-quote-csv-field (s)
- "Quote field for inclusion in CSV material."
- (if (string-match "[\",]" s)
- (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
- s))
- (defun org-force-self-insert (N)
- "Needed to enforce self-insert under remapping."
- (interactive "p")
- (self-insert-command N))
- (defun org-quote-vert (s)
- "Replace \"|\" with \"\\vert\"."
- (while (string-match "|" s)
- (setq s (replace-match "\\vert" t t s)))
- s)
- (defun org-uuidgen-p (s)
- "Is S an ID created by UUIDGEN?"
- (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
- (defun org-in-src-block-p (&optional inside element)
- "Whether point is in a code source block.
- When INSIDE is non-nil, don't consider we are within a source
- block when point is at #+BEGIN_SRC or #+END_SRC.
- When ELEMENT is provided, it is considered to be element at point."
- (save-match-data (setq element (or element (org-element-at-point))))
- (when (eq 'src-block (org-element-type element))
- (or (not inside)
- (not (or (= (line-beginning-position)
- (org-element-property :post-affiliated element))
- (= (1+ (line-end-position))
- (- (org-element-property :end element)
- (org-element-property :post-blank element))))))))
- (defun org-context ()
- "Return a list of contexts of the current cursor position.
- If several contexts apply, all are returned.
- Each context entry is a list with a symbol naming the context, and
- two positions indicating start and end of the context. Possible
- contexts are:
- :headline anywhere in a headline
- :headline-stars on the leading stars in a headline
- :todo-keyword on a TODO keyword (including DONE) in a headline
- :tags on the TAGS in a headline
- :priority on the priority cookie in a headline
- :item on the first line of a plain list item
- :item-bullet on the bullet/number of a plain list item
- :checkbox on the checkbox in a plain list item
- :table in an Org table
- :table-special on a special filed in a table
- :table-table in a table.el table
- :clocktable in a clocktable
- :src-block in a source block
- :link on a hyperlink
- :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
- :latex-fragment on a LaTeX fragment
- :latex-preview on a LaTeX fragment with overlaid preview image
- This function expects the position to be visible because it uses font-lock
- faces as a help to recognize the following contexts: :table-special, :link,
- and :keyword."
- (let* ((f (get-text-property (point) 'face))
- (faces (if (listp f) f (list f)))
- (case-fold-search t)
- (p (point)) clist o)
- ;; First the large context
- (cond
- ((org-at-heading-p)
- (push (list :headline (line-beginning-position) (line-end-position)) clist)
- (when (progn
- (beginning-of-line 1)
- (looking-at org-todo-line-tags-regexp))
- (push (org-point-in-group p 1 :headline-stars) clist)
- (push (org-point-in-group p 2 :todo-keyword) clist)
- (push (org-point-in-group p 4 :tags) clist))
- (goto-char p)
- (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
- (when (looking-at "\\[#[A-Z0-9]\\]")
- (push (org-point-in-group p 0 :priority) clist)))
- ((org-at-item-p)
- (push (org-point-in-group p 2 :item-bullet) clist)
- (push (list :item (line-beginning-position)
- (save-excursion (org-end-of-item) (point)))
- clist)
- (and (org-at-item-checkbox-p)
- (push (org-point-in-group p 0 :checkbox) clist)))
- ((org-at-table-p)
- (push (list :table (org-table-begin) (org-table-end)) clist)
- (when (memq 'org-formula faces)
- (push (list :table-special
- (previous-single-property-change p 'face)
- (next-single-property-change p 'face))
- clist)))
- ((org-at-table-p 'any)
- (push (list :table-table) clist)))
- (goto-char p)
- (let ((case-fold-search t))
- ;; New the "medium" contexts: clocktables, source blocks
- (cond ((org-in-clocktable-p)
- (push (list :clocktable
- (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
- (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
- (match-beginning 1))
- (and (re-search-forward "[ \t]*#\\+END:?" nil t)
- (match-end 0)))
- clist))
- ((org-in-src-block-p)
- (push (list :src-block
- (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
- (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
- (match-beginning 1))
- (and (search-forward "#+END_SRC" nil t)
- (match-beginning 0)))
- clist))))
- (goto-char p)
- ;; Now the small context
- (cond
- ((org-at-timestamp-p)
- (push (org-point-in-group p 0 :timestamp) clist))
- ((memq 'org-link faces)
- (push (list :link
- (previous-single-property-change p 'face)
- (next-single-property-change p 'face))
- clist))
- ((memq 'org-special-keyword faces)
- (push (list :keyword
- (previous-single-property-change p 'face)
- (next-single-property-change p 'face))
- clist))
- ((setq o (cl-some
- (lambda (o)
- (and (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay)
- o))
- (overlays-at (point))))
- (push (list :latex-fragment
- (overlay-start o) (overlay-end o))
- clist)
- (push (list :latex-preview
- (overlay-start o) (overlay-end o))
- clist))
- ((org-inside-LaTeX-fragment-p)
- ;; FIXME: positions wrong.
- (push (list :latex-fragment (point) (point)) clist)))
- (setq clist (nreverse (delq nil clist)))
- clist))
- (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
- "Non-nil when point is between matches of START-RE and END-RE.
- Also return a non-nil value when point is on one of the matches.
- Optional arguments LIM-UP and LIM-DOWN bound the search; they are
- buffer positions. Default values are the positions of headlines
- surrounding the point.
- The functions returns a cons cell whose car (resp. cdr) is the
- position before START-RE (resp. after END-RE)."
- (save-match-data
- (let ((pos (point))
- (limit-up (or lim-up (save-excursion (outline-previous-heading))))
- (limit-down (or lim-down (save-excursion (outline-next-heading))))
- beg end)
- (save-excursion
- ;; Point is on a block when on START-RE or if START-RE can be
- ;; found before it...
- (and (or (org-in-regexp start-re)
- (re-search-backward start-re limit-up t))
- (setq beg (match-beginning 0))
- ;; ... and END-RE after it...
- (goto-char (match-end 0))
- (re-search-forward end-re limit-down t)
- (> (setq end (match-end 0)) pos)
- ;; ... without another START-RE in-between.
- (goto-char (match-beginning 0))
- (not (re-search-backward start-re (1+ beg) t))
- ;; Return value.
- (cons beg end))))))
- (defun org-in-block-p (names)
- "Non-nil when point belongs to a block whose name belongs to NAMES.
- NAMES is a list of strings containing names of blocks.
- Return first block name matched, or nil. Beware that in case of
- nested blocks, the returned name may not belong to the closest
- block from point."
- (save-match-data
- (catch 'exit
- (let ((case-fold-search t)
- (lim-up (save-excursion (outline-previous-heading)))
- (lim-down (save-excursion (outline-next-heading))))
- (dolist (name names)
- (let ((n (regexp-quote name)))
- (when (org-between-regexps-p
- (concat "^[ \t]*#\\+begin_" n)
- (concat "^[ \t]*#\\+end_" n)
- lim-up lim-down)
- (throw 'exit n)))))
- nil)))
- (defun org-occur-in-agenda-files (regexp &optional _nlines)
- "Call `multi-occur' with buffers for all agenda files."
- (interactive "sOrg-files matching: ")
- (let* ((files (org-agenda-files))
- (tnames (mapcar #'file-truename files))
- (extra org-agenda-text-search-extra-files))
- (when (eq (car extra) 'agenda-archives)
- (setq extra (cdr extra))
- (setq files (org-add-archive-files files)))
- (dolist (f extra)
- (unless (member (file-truename f) tnames)
- (unless (member f files) (setq files (append files (list f))))
- (setq tnames (append tnames (list (file-truename f))))))
- (multi-occur
- (mapcar (lambda (x)
- (with-current-buffer
- ;; FIXME: Why not just (find-file-noselect x)?
- ;; Is it to avoid the "revert buffer" prompt?
- (or (get-file-buffer x) (find-file-noselect x))
- (widen)
- (current-buffer)))
- files)
- regexp)))
- (add-hook 'occur-mode-find-occurrence-hook
- (lambda () (when (derived-mode-p 'org-mode) (org-fold-reveal))))
- (defun org-occur-link-in-agenda-files ()
- "Create a link and search for it in the agendas.
- The link is not stored in `org-stored-links', it is just created
- for the search purpose."
- (interactive)
- (let ((link (condition-case nil
- (org-store-link nil)
- (error "Unable to create a link to here"))))
- (org-occur-in-agenda-files (regexp-quote link))))
- (defun org-back-over-empty-lines ()
- "Move backwards over whitespace, to the beginning of the first empty line.
- Returns the number of empty lines passed."
- (let ((pos (point)))
- (if (cdr (assq 'heading org-blank-before-new-entry))
- (skip-chars-backward " \t\n\r")
- (unless (eobp)
- (forward-line -1)))
- (beginning-of-line 2)
- (goto-char (min (point) pos))
- (count-lines (point) pos)))
- ;;; TODO: Only called once, from ox-odt which should probably use
- ;;; org-export-inline-image-p or something.
- (defun org-file-image-p (file)
- "Return non-nil if FILE is an image."
- (save-match-data
- (string-match (image-file-name-regexp) file)))
- (defun org-get-cursor-date (&optional with-time)
- "Return the date at cursor in as a time.
- This works in the calendar and in the agenda, anywhere else it just
- returns the current time.
- If WITH-TIME is non-nil, returns the time of the event at point (in
- the agenda) or the current time of the day; otherwise returns the
- earliest time on the cursor date that Org treats as that date
- (bearing in mind `org-extend-today-until')."
- (let (date day defd tp hod mod)
- (when with-time
- (setq tp (get-text-property (point) 'time))
- (when (and tp (string-match "\\([0-2]?[0-9]\\):\\([0-5][0-9]\\)" tp))
- (setq hod (string-to-number (match-string 1 tp))
- mod (string-to-number (match-string 2 tp))))
- (or tp (let ((now (decode-time)))
- (setq hod (nth 2 now)
- mod (nth 1 now)))))
- (cond
- ((eq major-mode 'calendar-mode)
- (setq date (calendar-cursor-to-date)
- defd (org-encode-time 0 (or mod 0) (or hod org-extend-today-until)
- (nth 1 date) (nth 0 date) (nth 2 date))))
- ((eq major-mode 'org-agenda-mode)
- (setq day (get-text-property (point) 'day))
- (when day
- (setq date (calendar-gregorian-from-absolute day)
- defd (org-encode-time 0 (or mod 0) (or hod org-extend-today-until)
- (nth 1 date) (nth 0 date) (nth 2 date))))))
- (or defd (current-time))))
- (defun org-mark-subtree (&optional up)
- "Mark the current subtree.
- This puts point at the start of the current subtree, and mark at
- the end. If a numeric prefix UP is given, move up into the
- hierarchy of headlines by UP levels before marking the subtree."
- (interactive "P")
- (org-with-limited-levels
- (cond ((org-at-heading-p) (beginning-of-line))
- ((org-before-first-heading-p) (user-error "Not in a subtree"))
- (t (outline-previous-visible-heading 1))))
- (when up (while (and (> up 0) (org-up-heading-safe)) (cl-decf up)))
- (if (called-interactively-p 'any)
- (call-interactively 'org-mark-element)
- (org-mark-element)))
- ;;; Indentation
- (defun org--at-headline-data-p (&optional beg element)
- "Return non-nil when `point' or BEG is inside headline metadata.
- Metadata is planning line, properties drawer, logbook drawer right
- after property drawer, or clock log line immediately following
- properties drawer/planning line/ heading.
- Optional argument ELEMENT contains element at BEG."
- (org-with-wide-buffer
- (when beg (goto-char beg))
- (setq element (or element (org-element-at-point)))
- (if (not (org-element-lineage element '(headline inlinetask)))
- nil ; Not inside heading.
- ;; Skip to top-level parent in section.
- (while (not (eq 'section (org-element-type (org-element-property :parent element))))
- (setq element (org-element-property :parent element)))
- (pcase (org-element-type element)
- ((or `planning `property-drawer)
- t)
- (`drawer
- ;; LOGBOOK drawer with appropriate name.
- (equal
- (org-log-into-drawer)
- (org-element-property :drawer-name element)))
- (`clock
- ;; Previous element must be headline metadata or headline.
- (goto-char (1- (org-element-property :begin element)))
- (or (org-at-heading-p)
- (org--at-headline-data-p)))))))
- (defvar org-element-greater-elements)
- (defun org--get-expected-indentation (element contentsp)
- "Expected indentation column for current line, according to ELEMENT.
- ELEMENT is an element containing point. CONTENTSP is non-nil
- when indentation is to be computed according to contents of
- ELEMENT."
- (let ((type (org-element-type element))
- (start (org-element-property :begin element))
- (post-affiliated (org-element-property :post-affiliated element)))
- (org-with-wide-buffer
- (cond
- (contentsp
- (cl-case type
- ((diary-sexp footnote-definition) 0)
- (section
- (org--get-expected-indentation
- (org-element-property :parent element)
- t))
- ((headline inlinetask nil)
- (if (not org-adapt-indentation) 0
- (let ((level (org-current-level)))
- (if level (1+ level) 0))))
- ((item plain-list) (org-list-item-body-column post-affiliated))
- (t
- (goto-char start)
- (current-indentation))))
- ((memq type '(headline inlinetask nil))
- (if (org-match-line "[ \t]*$")
- (org--get-expected-indentation element t)
- 0))
- ((memq type '(diary-sexp footnote-definition)) 0)
- ;; First paragraph of a footnote definition or an item.
- ;; Indent like parent.
- ((< (line-beginning-position) start)
- (org--get-expected-indentation
- (org-element-property :parent element) t))
- ;; At first line: indent according to previous sibling, if any,
- ;; ignoring footnote definitions and inline tasks, or parent's
- ;; contents. If `org-adapt-indentation' is `headline-data', ignore
- ;; previous headline data siblings.
- ((= (line-beginning-position) start)
- (catch 'exit
- (while t
- (if (= (point-min) start) (throw 'exit 0)
- (goto-char (1- start))
- (let* ((previous (org-element-at-point))
- (parent previous))
- (while (and parent (<= (org-element-property :end parent) start))
- (setq previous parent
- parent (org-element-property :parent parent)))
- (cond
- ((not previous) (throw 'exit 0))
- ((> (org-element-property :end previous) start)
- (throw 'exit (org--get-expected-indentation previous t)))
- ((memq (org-element-type previous)
- '(footnote-definition inlinetask))
- (setq start (org-element-property :begin previous)))
- ;; Do not indent like previous when the previous
- ;; element is headline data and `org-adapt-indentation'
- ;; is set to `headline-data'.
- ((and (eq 'headline-data org-adapt-indentation)
- (not (org--at-headline-data-p start element))
- (or (org-at-heading-p)
- (org--at-headline-data-p (1- start) previous)))
- (throw 'exit 0))
- (t (goto-char (org-element-property :begin previous))
- (throw 'exit
- (if (bolp) (current-indentation)
- ;; At first paragraph in an item or
- ;; a footnote definition.
- (org--get-expected-indentation
- (org-element-property :parent previous) t))))))))))
- ;; Otherwise, move to the first non-blank line above.
- (t
- (beginning-of-line)
- (let ((pos (point)))
- (skip-chars-backward " \r\t\n")
- (cond
- ;; Two blank lines end a footnote definition or a plain
- ;; list. When we indent an empty line after them, the
- ;; containing list or footnote definition is over, so it
- ;; qualifies as a previous sibling. Therefore, we indent
- ;; like its first line.
- ((and (memq type '(footnote-definition plain-list))
- (> (count-lines (point) pos) 2))
- (goto-char start)
- (current-indentation))
- ;; Line above is the first one of a paragraph at the
- ;; beginning of an item or a footnote definition. Indent
- ;; like parent.
- ((< (line-beginning-position) start)
- (org--get-expected-indentation
- (org-element-property :parent element) t))
- ;; Line above is the beginning of an element, i.e., point
- ;; was originally on the blank lines between element's start
- ;; and contents.
- ((= (line-beginning-position) post-affiliated)
- (org--get-expected-indentation element t))
- ;; POS is after contents in a greater element. Indent like
- ;; the beginning of the element.
- ((and (memq type org-element-greater-elements)
- (let ((cend (org-element-property :contents-end element)))
- (and cend (<= cend pos))))
- ;; As a special case, if point is at the end of a footnote
- ;; definition or an item, indent like the very last element
- ;; within. If that last element is an item, indent like
- ;; its contents.
- (if (memq type '(footnote-definition item plain-list))
- (let ((last (org-element-at-point)))
- (goto-char pos)
- (org--get-expected-indentation
- last (eq (org-element-type last) 'item)))
- (goto-char start)
- (current-indentation)))
- ;; In any other case, indent like the current line.
- (t (current-indentation)))))
- ;; Finally, no indentation is needed, fall back to 0.
- (t (current-indentation))))))
- (defun org--align-node-property ()
- "Align node property at point.
- Alignment is done according to `org-property-format', which see."
- (when (save-excursion
- (beginning-of-line)
- (looking-at org-property-re))
- (combine-change-calls (match-beginning 0) (match-end 0)
- (let ((newtext (concat (match-string 4)
- (org-trim
- (format org-property-format (match-string 1) (match-string 3))))))
- ;; Do not use `replace-match' here as we want to inherit folding
- ;; properties if inside fold.
- (delete-region (match-beginning 0) (match-end 0))
- (insert-and-inherit newtext)))))
- (defun org-indent-line ()
- "Indent line depending on context.
- Indentation is done according to the following rules:
- - Footnote definitions, diary sexps, headlines and inline tasks
- have to start at column 0.
- - On the very first line of an element, consider, in order, the
- next rules until one matches:
- 1. If there's a sibling element before, ignoring footnote
- definitions and inline tasks, indent like its first line.
- 2. If element has a parent, indent like its contents. More
- precisely, if parent is an item, indent after the bullet.
- Else, indent like parent's first line.
- 3. Otherwise, indent relatively to current level, if
- `org-adapt-indentation' is t, or to left margin.
- - On a blank line at the end of an element, indent according to
- the type of the element. More precisely
- 1. If element is a plain list, an item, or a footnote
- definition, indent like the very last element within.
- 2. If element is a paragraph, indent like its last non blank
- line.
- 3. Otherwise, indent like its very first line.
- - In the code part of a source block, use language major mode
- to indent current line if `org-src-tab-acts-natively' is
- non-nil. If it is nil, do nothing.
- - Otherwise, indent like the first non-blank line above.
- The function doesn't indent an item as it could break the whole
- list structure. Instead, use \\<org-mode-map>`\\[org-shiftmetaleft]' or \
- `\\[org-shiftmetaright]'.
- Also align node properties according to `org-property-format'."
- (interactive)
- (let* ((element (save-excursion (beginning-of-line) (org-element-at-point-no-context)))
- (type (org-element-type element)))
- (unless (or (org-at-heading-p)
- (and (eq org-adapt-indentation 'headline-data)
- (not (org--at-headline-data-p nil element))
- (save-excursion
- (goto-char (1- (org-element-property :begin element)))
- (or (org-at-heading-p)
- (org--at-headline-data-p)))))
- (cond ((and (memq type '(plain-list item))
- (= (line-beginning-position)
- (org-element-property :post-affiliated element)))
- nil)
- ((and (eq type 'latex-environment)
- (>= (point) (org-element-property :post-affiliated element))
- (< (point)
- (org-with-point-at (org-element-property :end element)
- (skip-chars-backward " \t\n")
- (line-beginning-position 2))))
- nil)
- ((and (eq type 'src-block)
- org-src-tab-acts-natively
- (> (line-beginning-position)
- (org-element-property :post-affiliated element))
- (< (line-beginning-position)
- (org-with-point-at (org-element-property :end element)
- (skip-chars-backward " \t\n")
- (line-beginning-position))))
- ;; At the beginning of a blank line, do some preindentation. This
- ;; signals org-src--edit-element to preserve the indentation on exit
- (when (and (looking-at-p "^[[:space:]]*$")
- (not org-src-preserve-indentation))
- (let ((element (org-element-at-point))
- block-content-ind some-ind)
- (org-with-point-at (org-element-property :begin element)
- (setq block-content-ind (+ (current-indentation)
- org-edit-src-content-indentation))
- (forward-line)
- (save-match-data (re-search-forward "^[ \t]*\\S-" nil t))
- (backward-char)
- (setq some-ind (if (looking-at-p "#\\+end_src")
- block-content-ind (current-indentation))))
- (indent-line-to (min block-content-ind some-ind))))
- (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
- (t
- (let ((column (org--get-expected-indentation element nil)))
- ;; Preserve current column.
- (if (<= (current-column) (current-indentation))
- (indent-line-to column)
- (save-excursion (indent-line-to column))))
- ;; Align node property. Also preserve current column.
- (when (eq type 'node-property)
- (let ((column (current-column)))
- (org--align-node-property)
- (org-move-to-column column))))))))
- (defun org-indent-region (start end)
- "Indent each non-blank line in the region.
- Called from a program, START and END specify the region to
- indent. The function will not indent contents of example blocks,
- verse blocks and export blocks as leading white spaces are
- assumed to be significant there."
- (interactive "r")
- (save-excursion
- (goto-char start)
- (skip-chars-forward " \r\t\n")
- (unless (eobp) (beginning-of-line))
- (let ((indent-to
- (lambda (ind pos)
- ;; Set IND as indentation for all lines between point and
- ;; POS. Blank lines are ignored. Leave point after POS
- ;; once done.
- (let ((limit (copy-marker pos)))
- (while (< (point) limit)
- (unless (looking-at-p "[ \t]*$") (indent-line-to ind))
- (forward-line))
- (set-marker limit nil))))
- (end (copy-marker end)))
- (while (< (point) end)
- (if (or (looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
- (let* ((element (org-element-at-point))
- (type (org-element-type element))
- (element-end (copy-marker (org-element-property :end element)))
- (ind (org--get-expected-indentation element nil)))
- (cond
- ;; Element indented as a single block. Example blocks
- ;; preserving indentation are a special case since the
- ;; "contents" must not be indented whereas the block
- ;; boundaries can.
- ((or (memq type '(export-block latex-environment))
- (and (eq type 'example-block)
- (not
- (or org-src-preserve-indentation
- (org-element-property :preserve-indent element)))))
- (let ((offset (- ind (current-indentation))))
- (unless (zerop offset)
- (indent-rigidly (org-element-property :begin element)
- (org-element-property :end element)
- offset)))
- (goto-char element-end))
- ;; Elements indented line wise. Be sure to exclude
- ;; example blocks (preserving indentation) and source
- ;; blocks from this category as they are treated
- ;; specially later.
- ((or (memq type '(paragraph table table-row))
- (not (or (org-element-property :contents-begin element)
- (memq type '(example-block src-block)))))
- (when (eq type 'node-property)
- (org--align-node-property)
- (beginning-of-line))
- (funcall indent-to ind (min element-end end)))
- ;; Elements consisting of three parts: before the
- ;; contents, the contents, and after the contents. The
- ;; contents are treated specially, according to the
- ;; element type, or not indented at all. Other parts are
- ;; indented as a single block.
- (t
- (let* ((post (copy-marker
- (org-element-property :post-affiliated element)))
- (cbeg
- (copy-marker
- (cond
- ((not (org-element-property :contents-begin element))
- ;; Fake contents for source blocks.
- (org-with-wide-buffer
- (goto-char post)
- (line-beginning-position 2)))
- ((memq type '(footnote-definition item plain-list))
- ;; Contents in these elements could start on
- ;; the same line as the beginning of the
- ;; element. Make sure we start indenting
- ;; from the second line.
- (org-with-wide-buffer
- (goto-char post)
- (end-of-line)
- (skip-chars-forward " \r\t\n")
- (if (eobp) (point) (line-beginning-position))))
- (t (org-element-property :contents-begin element)))))
- (cend (copy-marker
- (or (org-element-property :contents-end element)
- ;; Fake contents for source blocks.
- (org-with-wide-buffer
- (goto-char element-end)
- (skip-chars-backward " \r\t\n")
- (line-beginning-position)))
- t)))
- ;; Do not change items indentation individually as it
- ;; might break the list as a whole. On the other
- ;; hand, when at a plain list, indent it as a whole.
- (cond ((eq type 'plain-list)
- (let ((offset (- ind (current-indentation))))
- (unless (zerop offset)
- (indent-rigidly (org-element-property :begin element)
- (org-element-property :end element)
- offset))
- (goto-char cbeg)))
- ((eq type 'item) (goto-char cbeg))
- (t (funcall indent-to ind (min cbeg end))))
- (when (< (point) end)
- (cl-case type
- ((example-block verse-block))
- (src-block
- ;; In a source block, indent source code
- ;; according to language major mode, but only if
- ;; `org-src-tab-acts-natively' is non-nil.
- (when (and (< (point) end) org-src-tab-acts-natively)
- (ignore-errors
- (org-babel-do-in-edit-buffer
- (indent-region (point-min) (point-max))))))
- (t (org-indent-region (point) (min cend end))))
- (goto-char (min cend end))
- (when (< (point) end)
- (funcall indent-to ind (min element-end end))))
- (set-marker post nil)
- (set-marker cbeg nil)
- (set-marker cend nil))))
- (set-marker element-end nil))))
- (set-marker end nil))))
- (defun org-indent-drawer ()
- "Indent the drawer at point."
- (interactive)
- (unless (save-excursion
- (beginning-of-line)
- (looking-at-p org-drawer-regexp))
- (user-error "Not at a drawer"))
- (let ((element (org-element-at-point-no-context)))
- (unless (memq (org-element-type element) '(drawer property-drawer))
- (user-error "Not at a drawer"))
- (org-with-wide-buffer
- (org-indent-region (org-element-property :begin element)
- (org-element-property :end element))))
- (message "Drawer at point indented"))
- (defun org-indent-block ()
- "Indent the block at point."
- (interactive)
- (unless (save-excursion
- (beginning-of-line)
- (let ((case-fold-search t))
- (looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
- (user-error "Not at a block"))
- (let ((element (org-element-at-point-no-context)))
- (unless (memq (org-element-type element)
- '(comment-block center-block dynamic-block example-block
- export-block quote-block special-block
- src-block verse-block))
- (user-error "Not at a block"))
- (org-with-wide-buffer
- (org-indent-region (org-element-property :begin element)
- (org-element-property :end element))))
- (message "Block at point indented"))
- ;;; Filling
- ;; We use our own fill-paragraph and auto-fill functions.
- ;; `org-fill-paragraph' relies on adaptive filling and context
- ;; checking. Appropriate `fill-prefix' is computed with
- ;; `org-adaptive-fill-function'.
- ;; `org-auto-fill-function' takes care of auto-filling. It calls
- ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
- ;; `org-adaptive-fill-function' value. Internally,
- ;; `org-comment-line-break-function' breaks the line.
- ;; `org-setup-filling' installs filling and auto-filling related
- ;; variables during `org-mode' initialization.
- (defvar org--single-lines-list-is-paragraph) ; defined later
- (defun org-setup-filling ()
- (require 'org-element)
- ;; Prevent auto-fill from inserting unwanted new items.
- (setq-local fill-nobreak-predicate
- (org-uniquify
- (append fill-nobreak-predicate
- '(org-fill-line-break-nobreak-p
- org-fill-n-macro-as-item-nobreak-p
- org-fill-paragraph-with-timestamp-nobreak-p))))
- (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
- (setq-local paragraph-start paragraph-ending)
- (setq-local paragraph-separate paragraph-ending))
- (setq-local fill-paragraph-function 'org-fill-paragraph)
- (setq-local fill-forward-paragraph-function
- (lambda (&optional arg)
- (let ((org--single-lines-list-is-paragraph nil))
- (org-forward-paragraph arg))))
- (setq-local auto-fill-inhibit-regexp nil)
- (setq-local adaptive-fill-function 'org-adaptive-fill-function)
- (setq-local normal-auto-fill-function 'org-auto-fill-function)
- (setq-local comment-line-break-function 'org-comment-line-break-function))
- (defun org-fill-line-break-nobreak-p ()
- "Non-nil when a new line at point would create an Org line break."
- (save-excursion
- (skip-chars-backward " \t")
- (skip-chars-backward "\\\\")
- (looking-at "\\\\\\\\\\($\\|[^\\]\\)")))
- (defun org-fill-paragraph-with-timestamp-nobreak-p ()
- "Non-nil when a new line at point would split a timestamp."
- (and (org-at-timestamp-p 'lax)
- (not (looking-at org-ts-regexp-both))))
- (defun org-fill-n-macro-as-item-nobreak-p ()
- "Non-nil when a new line at point would create a new list."
- ;; During export, a "n" macro followed by a dot or a closing
- ;; parenthesis can end up being parsed as a new list item.
- (looking-at-p "[ \t]*{{{n\\(?:([^\n)]*)\\)?}}}[.)]\\(?:$\\| \\)"))
- (defun org-adaptive-fill-function ()
- "Compute a fill prefix for the current line.
- Return fill prefix, as a string, or nil if current line isn't
- meant to be filled. For convenience, if `adaptive-fill-regexp'
- matches in paragraphs or comments, use it."
- (org-with-wide-buffer
- (unless (org-at-heading-p)
- (let* ((p (line-beginning-position))
- (element (save-excursion
- (beginning-of-line)
- (org-element-at-point)))
- (type (org-element-type element))
- (post-affiliated (org-element-property :post-affiliated element)))
- (unless (< p post-affiliated)
- (cl-case type
- (comment
- (save-excursion
- (beginning-of-line)
- (looking-at "[ \t]*")
- (concat (match-string 0) "# ")))
- (footnote-definition "")
- ((item plain-list)
- (make-string (org-list-item-body-column post-affiliated) ?\s))
- (paragraph
- ;; Fill prefix is usually the same as the current line,
- ;; unless the paragraph is at the beginning of an item.
- (let ((parent (org-element-property :parent element)))
- (save-excursion
- (beginning-of-line)
- (cond ((eq (org-element-type parent) 'item)
- (make-string (org-list-item-body-column
- (org-element-property :begin parent))
- ?\s))
- ((and adaptive-fill-regexp
- ;; Locally disable
- ;; `adaptive-fill-function' to let
- ;; `fill-context-prefix' handle
- ;; `adaptive-fill-regexp' variable.
- (let (adaptive-fill-function)
- (fill-context-prefix
- post-affiliated
- (org-element-property :end element)))))
- ((looking-at "[ \t]+") (match-string 0))
- (t "")))))
- (comment-block
- ;; Only fill contents if P is within block boundaries.
- (let* ((cbeg (save-excursion (goto-char post-affiliated)
- (forward-line)
- (point)))
- (cend (save-excursion
- (goto-char (org-element-property :end element))
- (skip-chars-backward " \r\t\n")
- (line-beginning-position))))
- (when (and (>= p cbeg) (< p cend))
- (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
- (match-string 0)
- ""))))))))))
- (defun org-fill-element (&optional justify)
- "Fill element at point, when applicable.
- This function only applies to comment blocks, comments, example
- blocks and paragraphs. Also, as a special case, re-align table
- when point is at one.
- If JUSTIFY is non-nil (interactively, with prefix argument),
- justify as well. If `sentence-end-double-space' is non-nil, then
- period followed by one space does not end a sentence, so don't
- break a line there. The variable `fill-column' controls the
- width for filling.
- For convenience, when point is at a plain list, an item or
- a footnote definition, try to fill the first paragraph within."
- (with-syntax-table org-mode-transpose-word-syntax-table
- ;; Move to end of line in order to get the first paragraph within
- ;; a plain list or a footnote definition.
- (let ((element (save-excursion (end-of-line) (org-element-at-point))))
- ;; First check if point is in a blank line at the beginning of
- ;; the buffer. In that case, ignore filling.
- (cl-case (org-element-type element)
- ;; Use major mode filling function is source blocks.
- (src-block (org-babel-do-in-edit-buffer
- (push-mark (point-min))
- (goto-char (point-max))
- (setq mark-active t)
- (funcall-interactively #'fill-paragraph justify 'region)))
- ;; Align Org tables, leave table.el tables as-is.
- (table-row (org-table-align) t)
- (table
- (when (eq (org-element-property :type element) 'org)
- (save-excursion
- (goto-char (org-element-property :post-affiliated element))
- (org-table-align)))
- t)
- (paragraph
- ;; Paragraphs may contain `line-break' type objects.
- (let ((beg (max (point-min)
- (org-element-property :contents-begin element)))
- (end (min (point-max)
- (org-element-property :contents-end element))))
- ;; Do nothing if point is at an affiliated keyword.
- (if (< (line-end-position) beg) t
- ;; Fill paragraph, taking line breaks into account.
- (save-excursion
- (goto-char beg)
- (let ((cuts (list beg)))
- (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
- (when (eq 'line-break
- (org-element-type
- (save-excursion (backward-char)
- (org-element-context))))
- (push (point) cuts)))
- (dolist (c (delq end cuts))
- (fill-region-as-paragraph c end justify)
- (setq end c))))
- t)))
- ;; Contents of `comment-block' type elements should be
- ;; filled as plain text, but only if point is within block
- ;; markers.
- (comment-block
- (let* ((case-fold-search t)
- (beg (save-excursion
- (goto-char (org-element-property :begin element))
- (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
- (forward-line)
- (point)))
- (end (save-excursion
- (goto-char (org-element-property :end element))
- (re-search-backward "^[ \t]*#\\+end_comment" nil t)
- (line-beginning-position))))
- (if (or (< (point) beg) (> (point) end)) t
- (fill-region-as-paragraph
- (save-excursion (end-of-line)
- (re-search-backward "^[ \t]*$" beg 'move)
- (line-beginning-position))
- (save-excursion (beginning-of-line)
- (re-search-forward "^[ \t]*$" end 'move)
- (line-beginning-position))
- justify))))
- ;; Fill comments.
- (comment
- (let ((begin (org-element-property :post-affiliated element))
- (end (org-element-property :end element)))
- (when (and (>= (point) begin) (<= (point) end))
- (let ((begin (save-excursion
- (end-of-line)
- (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
- (progn (forward-line) (point))
- begin)))
- (end (save-excursion
- (end-of-line)
- (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
- (1- (line-beginning-position))
- (skip-chars-backward " \r\t\n")
- (line-end-position)))))
- ;; Do not fill comments when at a blank line.
- (when (> end begin)
- (let ((fill-prefix
- (save-excursion
- (beginning-of-line)
- (looking-at "[ \t]*#")
- (let ((comment-prefix (match-string 0)))
- (goto-char (match-end 0))
- (if (looking-at adaptive-fill-regexp)
- (concat comment-prefix (match-string 0))
- (concat comment-prefix " "))))))
- (save-excursion
- (fill-region-as-paragraph begin end justify))))))
- t))
- ;; Ignore every other element.
- (otherwise t)))))
- (defun org-fill-paragraph (&optional justify region)
- "Fill element at point, when applicable.
- This function only applies to comment blocks, comments, example
- blocks and paragraphs. Also, as a special case, re-align table
- when point is at one.
- For convenience, when point is at a plain list, an item or
- a footnote definition, try to fill the first paragraph within.
- If JUSTIFY is non-nil (interactively, with prefix argument),
- justify as well. If `sentence-end-double-space' is non-nil, then
- period followed by one space does not end a sentence, so don't
- break a line there. The variable `fill-column' controls the
- width for filling.
- The REGION argument is non-nil if called interactively; in that
- case, if Transient Mark mode is enabled and the mark is active,
- fill each of the elements in the active region, instead of just
- filling the current element."
- (interactive (progn
- (barf-if-buffer-read-only)
- (list (when current-prefix-arg 'full) t)))
- (let ((hash (and (not (buffer-modified-p))
- (org-buffer-hash))))
- (cond
- ((and region transient-mark-mode mark-active
- (not (eq (region-beginning) (region-end))))
- (let ((origin (point-marker))
- (start (region-beginning)))
- (unwind-protect
- (progn
- (goto-char (region-end))
- (skip-chars-backward " \t\n")
- (let ((org--single-lines-list-is-paragraph nil))
- (while (> (point) start)
- (org-fill-element justify)
- (org-backward-paragraph)
- (skip-chars-backward " \t\n"))))
- (goto-char origin)
- (set-marker origin nil))))
- (t
- (save-excursion
- (when (org-match-line "[ \t]*$")
- (skip-chars-forward " \t\n"))
- (org-fill-element justify))))
- ;; If we didn't change anything in the buffer (and the buffer was
- ;; previously unmodified), then flip the modification status back
- ;; to "unchanged".
- (when (and hash (equal hash (org-buffer-hash)))
- (set-buffer-modified-p nil))
- ;; Return non-nil.
- t))
- (defun org-auto-fill-function ()
- "Auto-fill function."
- ;; Check if auto-filling is meaningful.
- (let ((fc (current-fill-column)))
- (when (and fc (> (current-column) fc))
- (let* ((fill-prefix (org-adaptive-fill-function))
- ;; Enforce empty fill prefix, if required. Otherwise, it
- ;; will be computed again.
- (adaptive-fill-mode (not (equal fill-prefix ""))))
- (when fill-prefix (do-auto-fill))))))
- (defun org-comment-line-break-function (&optional soft)
- "Break line at point and indent, continuing comment if within one.
- The inserted newline is marked hard if variable
- `use-hard-newlines' is true, unless optional argument SOFT is
- non-nil."
- (if soft (insert-and-inherit ?\n) (newline 1))
- (save-excursion (forward-char -1) (delete-horizontal-space))
- (delete-horizontal-space)
- (indent-to-left-margin)
- (insert-before-markers-and-inherit fill-prefix))
- ;;; Fixed Width Areas
- (defun org-toggle-fixed-width ()
- "Toggle fixed-width markup.
- Add or remove fixed-width markup on current line, whenever it
- makes sense. Return an error otherwise.
- If a region is active and if it contains only fixed-width areas
- or blank lines, remove all fixed-width markup in it. If the
- region contains anything else, convert all non-fixed-width lines
- to fixed-width ones.
- Blank lines at the end of the region are ignored unless the
- region only contains such lines."
- (interactive)
- (if (not (org-region-active-p))
- ;; No region:
- ;;
- ;; Remove fixed width marker only in a fixed-with element.
- ;;
- ;; Add fixed width maker in paragraphs, in blank lines after
- ;; elements or at the beginning of a headline or an inlinetask,
- ;; and before any one-line elements (e.g., a clock).
- (progn
- (beginning-of-line)
- (let* ((element (org-element-at-point))
- (type (org-element-type element)))
- (cond
- ((and (eq type 'fixed-width)
- (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
- (replace-match
- "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
- ((and (memq type '(babel-call clock comment diary-sexp headline
- horizontal-rule keyword paragraph
- planning))
- (<= (org-element-property :post-affiliated element) (point)))
- (skip-chars-forward " \t")
- (insert ": "))
- ((and (looking-at-p "[ \t]*$")
- (or (eq type 'inlinetask)
- (save-excursion
- (skip-chars-forward " \r\t\n")
- (<= (org-element-property :end element) (point)))))
- (delete-region (point) (line-end-position))
- (org-indent-line)
- (insert ": "))
- (t (user-error "Cannot insert a fixed-width line here")))))
- ;; Region active.
- (let* ((begin (save-excursion
- (goto-char (region-beginning))
- (line-beginning-position)))
- (end (copy-marker
- (save-excursion
- (goto-char (region-end))
- (unless (eolp) (beginning-of-line))
- (if (save-excursion (re-search-backward "\\S-" begin t))
- (progn (skip-chars-backward " \r\t\n") (point))
- (point)))))
- (all-fixed-width-p
- (catch 'not-all-p
- (save-excursion
- (goto-char begin)
- (skip-chars-forward " \r\t\n")
- (when (eobp) (throw 'not-all-p nil))
- (while (< (point) end)
- (let ((element (org-element-at-point)))
- (if (eq (org-element-type element) 'fixed-width)
- (goto-char (org-element-property :end element))
- (throw 'not-all-p nil))))
- t))))
- (if all-fixed-width-p
- (save-excursion
- (goto-char begin)
- (while (< (point) end)
- (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
- (replace-match
- "" nil nil nil
- (if (= (line-end-position) (match-end 0)) 0 1)))
- (forward-line)))
- (let ((min-ind (point-max)))
- ;; Find minimum indentation across all lines.
- (save-excursion
- (goto-char begin)
- (if (not (save-excursion (re-search-forward "\\S-" end t)))
- (setq min-ind 0)
- (catch 'zerop
- (while (< (point) end)
- (unless (looking-at-p "[ \t]*$")
- (let ((ind (current-indentation)))
- (setq min-ind (min min-ind ind))
- (when (zerop ind) (throw 'zerop t))))
- (forward-line)))))
- ;; Loop over all lines and add fixed-width markup everywhere
- ;; but in fixed-width lines.
- (save-excursion
- (goto-char begin)
- (while (< (point) end)
- (cond
- ((org-at-heading-p)
- (insert ": ")
- (forward-line)
- (while (and (< (point) end) (looking-at-p "[ \t]*$"))
- (insert ":")
- (forward-line)))
- ((looking-at-p "[ \t]*:\\( \\|$\\)")
- (let* ((element (org-element-at-point))
- (element-end (org-element-property :end element)))
- (if (eq (org-element-type element) 'fixed-width)
- (progn (goto-char element-end)
- (skip-chars-backward " \r\t\n")
- (forward-line))
- (let ((limit (min end element-end)))
- (while (< (point) limit)
- (org-move-to-column min-ind t)
- (insert ": ")
- (forward-line))))))
- (t
- (org-move-to-column min-ind t)
- (insert ": ")
- (forward-line)))))))
- (set-marker end nil))))
- ;;; Blocks
- (defun org-block-map (function &optional start end)
- "Call FUNCTION at the head of all source blocks in the current buffer.
- Optional arguments START and END can be used to limit the range."
- (let ((start (or start (point-min)))
- (end (or end (point-max))))
- (save-excursion
- (goto-char start)
- (while (and (< (point) end) (re-search-forward org-block-regexp end t))
- (save-excursion
- (save-match-data
- (goto-char (match-beginning 0))
- (funcall function)))))))
- (defun org-next-block (arg &optional backward block-regexp)
- "Jump to the next block.
- With a prefix argument ARG, jump forward ARG many blocks.
- When BACKWARD is non-nil, jump to the previous block.
- When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
- Match data is set according to this regexp when the function
- returns.
- Return point at beginning of the opening line of found block.
- Throw an error if no block is found."
- (interactive "p")
- (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
- (case-fold-search t)
- (search-fn (if backward #'re-search-backward #'re-search-forward))
- (count (or arg 1))
- (origin (point))
- last-element)
- (if backward (beginning-of-line) (end-of-line))
- (while (and (> count 0) (funcall search-fn re nil t))
- (let ((element (save-excursion
- (goto-char (match-beginning 0))
- (save-match-data (org-element-at-point)))))
- (when (and (memq (org-element-type element)
- '(center-block comment-block dynamic-block
- example-block export-block quote-block
- special-block src-block verse-block))
- (<= (match-beginning 0)
- (org-element-property :post-affiliated element)))
- (setq last-element element)
- (cl-decf count))))
- (if (= count 0)
- (prog1 (goto-char (org-element-property :post-affiliated last-element))
- (save-match-data (org-fold-show-context)))
- (goto-char origin)
- (user-error "No %s code blocks" (if backward "previous" "further")))))
- (defun org-previous-block (arg &optional block-regexp)
- "Jump to the previous block.
- With a prefix argument ARG, jump backward ARG many source blocks.
- When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
- (interactive "p")
- (org-next-block arg t block-regexp))
- ;;; Comments
- ;; Org comments syntax is quite complex. It requires the entire line
- ;; to be just a comment. Also, even with the right syntax at the
- ;; beginning of line, some elements (e.g., verse-block or
- ;; example-block) don't accept comments. Usual Emacs comment commands
- ;; cannot cope with those requirements. Therefore, Org replaces them.
- ;; Org still relies on 'comment-dwim', but cannot trust
- ;; 'comment-only-p'. So, 'comment-region-function' and
- ;; 'uncomment-region-function' both point
- ;; to 'org-comment-or-uncomment-region'. Eventually,
- ;; 'org-insert-comment' takes care of insertion of comments at the
- ;; beginning of line.
- ;; 'org-setup-comments-handling' install comments related variables
- ;; during 'org-mode' initialization.
- (defun org-setup-comments-handling ()
- (interactive)
- (setq-local comment-use-syntax nil)
- (setq-local comment-start "# ")
- (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
- (setq-local comment-insert-comment-function 'org-insert-comment)
- (setq-local comment-region-function 'org-comment-or-uncomment-region)
- (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
- (defun org-insert-comment ()
- "Insert an empty comment above current line.
- If the line is empty, insert comment at its beginning. When
- point is within a source block, comment according to the related
- major mode."
- (if (let ((element (org-element-at-point)))
- (and (eq (org-element-type element) 'src-block)
- (< (save-excursion
- (goto-char (org-element-property :post-affiliated element))
- (line-end-position))
- (point))
- (> (save-excursion
- (goto-char (org-element-property :end element))
- (skip-chars-backward " \r\t\n")
- (line-beginning-position))
- (point))))
- (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
- (beginning-of-line)
- (if (looking-at "\\s-*$") (delete-region (point) (line-end-position))
- (open-line 1))
- (org-indent-line)
- (insert "# ")))
- (defvar comment-empty-lines) ; From newcomment.el.
- (defun org-comment-or-uncomment-region (beg end &rest _)
- "Comment or uncomment each non-blank line in the region.
- Uncomment each non-blank line between BEG and END if it only
- contains commented lines. Otherwise, comment them. If region is
- strictly within a source block, use appropriate comment syntax."
- (if (let ((element (org-element-at-point)))
- (and (eq (org-element-type element) 'src-block)
- (< (save-excursion
- (goto-char (org-element-property :post-affiliated element))
- (line-end-position))
- beg)
- (>= (save-excursion
- (goto-char (org-element-property :end element))
- (skip-chars-backward " \r\t\n")
- (line-beginning-position))
- end)))
- ;; Translate region boundaries for the Org buffer to the source
- ;; buffer.
- (let ((offset (- end beg)))
- (save-excursion
- (goto-char beg)
- (org-babel-do-in-edit-buffer
- (comment-or-uncomment-region (point) (+ offset (point))))))
- (save-restriction
- ;; Restrict region
- (narrow-to-region (save-excursion (goto-char beg)
- (skip-chars-forward " \r\t\n" end)
- (line-beginning-position))
- (save-excursion (goto-char end)
- (skip-chars-backward " \r\t\n" beg)
- (line-end-position)))
- (let ((uncommentp
- ;; UNCOMMENTP is non-nil when every non blank line between
- ;; BEG and END is a comment.
- (save-excursion
- (goto-char (point-min))
- (while (and (not (eobp))
- (let ((element (org-element-at-point)))
- (and (eq (org-element-type element) 'comment)
- (goto-char (min (point-max)
- (org-element-property
- :end element)))))))
- (eobp))))
- (if uncommentp
- ;; Only blank lines and comments in region: uncomment it.
- (save-excursion
- (goto-char (point-min))
- (while (not (eobp))
- (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
- (replace-match "" nil nil nil 1))
- (forward-line)))
- ;; Comment each line in region.
- (let ((min-indent (point-max)))
- ;; First find the minimum indentation across all lines.
- (save-excursion
- (goto-char (point-min))
- (while (and (not (eobp)) (not (zerop min-indent)))
- (unless (looking-at "[ \t]*$")
- (setq min-indent (min min-indent (current-indentation))))
- (forward-line)))
- ;; Then loop over all lines.
- (save-excursion
- (goto-char (point-min))
- (while (not (eobp))
- (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
- ;; Don't get fooled by invisible text (e.g. link path)
- ;; when moving to column MIN-INDENT.
- (let ((buffer-invisibility-spec nil))
- (org-move-to-column min-indent t))
- (insert comment-start))
- (forward-line)))))))))
- (defun org-comment-dwim (_arg)
- "Call the comment command you mean.
- Call `org-toggle-comment' if on a heading, otherwise call
- `comment-dwim', within a source edit buffer if needed."
- (interactive "*P")
- (cond ((org-at-heading-p)
- (call-interactively #'org-toggle-comment))
- ((org-in-src-block-p)
- (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim)))
- (t (call-interactively #'comment-dwim))))
- ;;; Timestamps API
- ;; This section contains tools to operate on, or create, timestamp
- ;; objects, as returned by, e.g. `org-element-context'.
- (defun org-timestamp-from-string (s)
- "Convert Org timestamp S, as a string, into a timestamp object.
- Return nil if S is not a valid timestamp string."
- (when (org-string-nw-p s)
- (with-temp-buffer
- (save-excursion (insert s))
- (org-element-timestamp-parser))))
- (defun org-timestamp-from-time (time &optional with-time inactive)
- "Convert a time value into a timestamp object.
- TIME is an Emacs internal time representation, as returned, e.g.,
- by `current-time'.
- When optional argument WITH-TIME is non-nil, return a timestamp
- object with a time part, i.e., with hours and minutes.
- Return an inactive timestamp if INACTIVE is non-nil. Otherwise,
- return an active timestamp."
- (pcase-let ((`(,_ ,minute ,hour ,day ,month ,year . ,_) (decode-time time)))
- (org-element-create 'timestamp
- (list :type (if inactive 'inactive 'active)
- :year-start year
- :month-start month
- :day-start day
- :hour-start (and with-time hour)
- :minute-start (and with-time minute)))))
- (defun org-timestamp-to-time (timestamp &optional end)
- "Convert TIMESTAMP object into an Emacs internal time value.
- Use end of date range or time range when END is non-nil.
- Otherwise, use its start."
- (org-encode-time
- (append '(0)
- (mapcar
- (lambda (prop) (or (org-element-property prop timestamp) 0))
- (if end '(:minute-end :hour-end :day-end :month-end :year-end)
- '(:minute-start :hour-start :day-start :month-start
- :year-start)))
- '(nil -1 nil))))
- (defun org-timestamp-has-time-p (timestamp)
- "Non-nil when TIMESTAMP has a time specified."
- (org-element-property :hour-start timestamp))
- (defun org-timestamp-format (timestamp format &optional end utc)
- "Format a TIMESTAMP object into a string.
- FORMAT is a format specifier to be passed to
- `format-time-string'.
- When optional argument END is non-nil, use end of date-range or
- time-range, if possible.
- When optional argument UTC is non-nil, time is be expressed as
- Universal Time."
- (format-time-string format (org-timestamp-to-time timestamp end)
- (and utc t)))
- (defun org-timestamp-split-range (timestamp &optional end)
- "Extract a TIMESTAMP object from a date or time range.
- END, when non-nil, means extract the end of the range.
- Otherwise, extract its start.
- Return a new timestamp object."
- (let ((type (org-element-property :type timestamp)))
- (if (memq type '(active inactive diary)) timestamp
- (let ((split-ts (org-element-copy timestamp)))
- ;; Set new type.
- (org-element-put-property
- split-ts :type (if (eq type 'active-range) 'active 'inactive))
- ;; Copy start properties over end properties if END is
- ;; non-nil. Otherwise, copy end properties over `start' ones.
- (let ((p-alist '((:minute-start . :minute-end)
- (:hour-start . :hour-end)
- (:day-start . :day-end)
- (:month-start . :month-end)
- (:year-start . :year-end))))
- (dolist (p-cell p-alist)
- (org-element-put-property
- split-ts
- (funcall (if end #'car #'cdr) p-cell)
- (org-element-property
- (funcall (if end #'cdr #'car) p-cell) split-ts)))
- ;; Eventually refresh `:raw-value'.
- (org-element-put-property split-ts :raw-value nil)
- (org-element-put-property
- split-ts :raw-value (org-element-interpret-data split-ts)))))))
- (defun org-timestamp-translate (timestamp &optional boundary)
- "Translate TIMESTAMP object to custom format.
- Format string is defined in `org-time-stamp-custom-formats',
- which see.
- When optional argument BOUNDARY is non-nil, it is either the
- symbol `start' or `end'. In this case, only translate the
- starting or ending part of TIMESTAMP if it is a date or time
- range. Otherwise, translate both parts.
- Return timestamp as-is if `org-display-custom-times' is nil or if
- it has a `diary' type."
- (let ((type (org-element-property :type timestamp)))
- (if (or (not org-display-custom-times) (eq type 'diary))
- (org-element-interpret-data timestamp)
- (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
- org-time-stamp-custom-formats)))
- (if (and (not boundary) (memq type '(active-range inactive-range)))
- (concat (org-timestamp-format timestamp fmt)
- "--"
- (org-timestamp-format timestamp fmt t))
- (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
- ;;; Other stuff
- (defvar reftex-docstruct-symbol)
- (defvar org--rds)
- (defun org-reftex-citation ()
- "Use `reftex-citation' to insert a citation into the buffer.
- This looks for a line like
- #+BIBLIOGRAPHY: foo plain option:-d
- and derives from it that foo.bib is the bibliography file relevant
- for this document. It then installs the necessary environment for RefTeX
- to work in this buffer and calls `reftex-citation' to insert a citation
- into the buffer.
- Export of such citations to both LaTeX and HTML is handled by the contributed
- package ox-bibtex by Taru Karttunen."
- (interactive)
- (let ((reftex-docstruct-symbol 'org--rds)
- org--rds bib)
- (org-with-wide-buffer
- (let ((case-fold-search t)
- (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
- (if (not (save-excursion
- (or (re-search-forward re nil t)
- (re-search-backward re nil t))))
- (user-error "No bibliography defined in file")
- (setq bib (concat (match-string 1) ".bib")
- org--rds (list (list 'bib bib))))))
- (call-interactively 'reftex-citation)))
- ;;;; Functions extending outline functionality
- (defun org-beginning-of-line (&optional n)
- "Go to the beginning of the current visible line.
- If this is a headline, and `org-special-ctrl-a/e' is not nil or
- symbol `reversed', on the first attempt move to where the
- headline text starts, and only move to beginning of line when the
- cursor is already before the start of the text of the headline.
- If `org-special-ctrl-a/e' is symbol `reversed' then go to the
- start of the text on the second attempt.
- With argument N not nil or 1, move forward N - 1 lines first."
- (interactive "^p")
- (let ((origin (point))
- (special (pcase org-special-ctrl-a/e
- (`(,C-a . ,_) C-a) (_ org-special-ctrl-a/e)))
- deactivate-mark)
- ;; First move to a visible line.
- (if (bound-and-true-p visual-line-mode)
- (beginning-of-visual-line n)
- (move-beginning-of-line n)
- ;; `move-beginning-of-line' may leave point after invisible
- ;; characters if line starts with such of these (e.g., with
- ;; a link at column 0). Really move to the beginning of the
- ;; current visible line.
- (beginning-of-line))
- (cond
- ;; No special behavior. Point is already at the beginning of
- ;; a line, logical or visual.
- ((not special))
- ;; `beginning-of-visual-line' left point before logical beginning
- ;; of line: point is at the beginning of a visual line. Bail
- ;; out.
- ((and (bound-and-true-p visual-line-mode) (not (bolp))))
- ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))
- ;; At a headline, special position is before the title, but
- ;; after any TODO keyword or priority cookie.
- (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
- (line-end-position)))
- (bol (point)))
- (if (eq special 'reversed)
- (when (and (= origin bol) (eq last-command this-command))
- (goto-char refpos))
- (when (or (> origin refpos) (= origin bol))
- (goto-char refpos)))))
- ((and (looking-at org-list-full-item-re)
- (memq (org-element-type (save-match-data (org-element-at-point)))
- '(item plain-list)))
- ;; Set special position at first white space character after
- ;; bullet, and check-box, if any.
- (let ((after-bullet
- (let ((box (match-end 3)))
- (cond ((not box) (match-end 1))
- ((eq (char-after box) ?\s) (1+ box))
- (t box)))))
- (if (eq special 'reversed)
- (when (and (= (point) origin) (eq last-command this-command))
- (goto-char after-bullet))
- (when (or (> origin after-bullet) (= (point) origin))
- (goto-char after-bullet)))))
- ;; No special context. Point is already at beginning of line.
- (t nil))))
- (defun org-end-of-line (&optional n)
- "Go to the end of the line, but before ellipsis, if any.
- If this is a headline, and `org-special-ctrl-a/e' is not nil or
- symbol `reversed', ignore tags on the first attempt, and only
- move to after the tags when the cursor is already beyond the end
- of the headline.
- If `org-special-ctrl-a/e' is symbol `reversed' then ignore tags
- on the second attempt.
- With argument N not nil or 1, move forward N - 1 lines first."
- (interactive "^p")
- (let ((origin (point))
- (special (pcase org-special-ctrl-a/e
- (`(,_ . ,C-e) C-e) (_ org-special-ctrl-a/e)))
- deactivate-mark)
- ;; First move to a visible line.
- (if (bound-and-true-p visual-line-mode)
- (beginning-of-visual-line n)
- (move-beginning-of-line n))
- (cond
- ;; At a headline, with tags.
- ((and special
- (save-excursion
- (beginning-of-line)
- (let ((case-fold-search nil))
- (looking-at org-complex-heading-regexp)))
- (match-end 5))
- (let ((tags (save-excursion
- (goto-char (match-beginning 5))
- (skip-chars-backward " \t")
- (point)))
- (visual-end (and (bound-and-true-p visual-line-mode)
- (save-excursion
- (end-of-visual-line)
- (point)))))
- ;; If `end-of-visual-line' brings us before end of line or
- ;; even tags, i.e., the headline spans over multiple visual
- ;; lines, move there.
- (cond ((and visual-end
- (< visual-end tags)
- (<= origin visual-end))
- (goto-char visual-end))
- ((eq special 'reversed)
- (if (and (= origin (line-end-position))
- (eq this-command last-command))
- (goto-char tags)
- (end-of-line)))
- (t
- (if (or (< origin tags) (= origin (line-end-position)))
- (goto-char tags)
- (end-of-line))))))
- ((bound-and-true-p visual-line-mode)
- (let ((bol (line-beginning-position)))
- (end-of-visual-line)
- ;; If `end-of-visual-line' gets us past the ellipsis at the
- ;; end of a line, backtrack and use `end-of-line' instead.
- (when (/= bol (line-beginning-position))
- (goto-char bol)
- (end-of-line))))
- (t (end-of-line)))))
- (defun org-backward-sentence (&optional _arg)
- "Go to beginning of sentence, or beginning of table field.
- This will call `backward-sentence' or `org-table-beginning-of-field',
- depending on context."
- (interactive)
- (let* ((element (org-element-at-point))
- (contents-begin (org-element-property :contents-begin element))
- (table (org-element-lineage element '(table) t)))
- (if (and table
- (> (point) contents-begin)
- (<= (point) (org-element-property :contents-end table)))
- (call-interactively #'org-table-beginning-of-field)
- (save-restriction
- (when (and contents-begin
- (< (point-min) contents-begin)
- (> (point) contents-begin))
- (narrow-to-region contents-begin
- (org-element-property :contents-end element)))
- (call-interactively #'backward-sentence)))))
- (defun org-forward-sentence (&optional _arg)
- "Go to end of sentence, or end of table field.
- This will call `forward-sentence' or `org-table-end-of-field',
- depending on context."
- (interactive)
- (if (and (org-at-heading-p)
- (save-restriction (skip-chars-forward " \t") (not (eolp))))
- (save-restriction
- (narrow-to-region (line-beginning-position) (line-end-position))
- (call-interactively #'forward-sentence))
- (let* ((element (org-element-at-point))
- (contents-end (org-element-property :contents-end element))
- (table (org-element-lineage element '(table) t)))
- (if (and table
- (>= (point) (org-element-property :contents-begin table))
- (< (point) contents-end))
- (call-interactively #'org-table-end-of-field)
- (save-restriction
- (when (and contents-end
- (> (point-max) contents-end)
- ;; Skip blank lines between elements.
- (< (org-element-property :end element)
- (save-excursion (goto-char contents-end)
- (skip-chars-forward " \r\t\n"))))
- (narrow-to-region (org-element-property :contents-begin element)
- contents-end))
- ;; End of heading is considered as the end of a sentence.
- (let ((sentence-end (concat (sentence-end) "\\|^\\*+ .*$")))
- (call-interactively #'forward-sentence)))))))
- (defun org-kill-line (&optional _arg)
- "Kill line, to tags or end of line."
- (interactive)
- (cond
- ((or (not org-special-ctrl-k)
- (bolp)
- (not (org-at-heading-p)))
- (when (and (org-invisible-p (line-end-position))
- org-ctrl-k-protect-subtree
- (or (eq org-ctrl-k-protect-subtree 'error)
- (not (y-or-n-p "Kill hidden subtree along with headline? "))))
- (user-error
- (substitute-command-keys
- "`\\[org-kill-line]' aborted as it would kill a hidden subtree")))
- (call-interactively
- (if (bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
- ((org-match-line org-tag-line-re)
- (let ((end (save-excursion
- (goto-char (match-beginning 1))
- (skip-chars-backward " \t")
- (point))))
- (if (<= end (point)) ;on tags part
- (kill-region (point) (line-end-position))
- (kill-region (point) end)))
- ;; Only align tags when we are still on a heading:
- (if (org-at-heading-p) (org-align-tags)))
- (t (kill-region (point) (line-end-position)))))
- (defun org-yank (&optional arg)
- "Yank. If the kill is a subtree, treat it specially.
- This command will look at the current kill and check if is a single
- subtree, or a series of subtrees[1]. If it passes the test, and if the
- cursor is at the beginning of a line or after the stars of a currently
- empty headline, then the yank is handled specially. How exactly depends
- on the value of the following variables.
- `org-yank-folded-subtrees'
- By default, this variable is non-nil, which results in
- subtree(s) being folded after insertion, except if doing so
- would swallow text after the yanked text.
- `org-yank-adjusted-subtrees'
- When non-nil (the default value is nil), the subtree will be
- promoted or demoted in order to fit into the local outline tree
- structure, which means that the level will be adjusted so that it
- becomes the smaller one of the two *visible* surrounding headings.
- Any prefix to this command will cause `yank' to be called directly with
- no special treatment. In particular, a simple `\\[universal-argument]' prefix \
- will just
- plainly yank the text as it is.
- \[1] The test checks if the first non-white line is a heading
- and if there are no other headings with fewer stars."
- (interactive "P")
- (org-yank-generic 'yank arg))
- (defun org-yank-generic (command arg)
- "Perform some yank-like command.
- This function implements the behavior described in the `org-yank'
- documentation. However, it has been generalized to work for any
- interactive command with similar behavior."
- ;; pretend to be command COMMAND
- (setq this-command command)
- (if arg
- (call-interactively command)
- (let ((subtreep ; is kill a subtree, and the yank position appropriate?
- (and (org-kill-is-subtree-p)
- (or (bolp)
- (and (looking-at "[ \t]*$")
- (string-match
- "\\`\\*+\\'"
- (buffer-substring (line-beginning-position) (point)))))))
- swallowp)
- (cond
- ((and subtreep org-yank-folded-subtrees)
- (let ((beg (point))
- end)
- (if (and subtreep org-yank-adjusted-subtrees)
- (org-paste-subtree nil nil 'for-yank)
- (call-interactively command))
- (setq end (point))
- (goto-char beg)
- (when (and (bolp) subtreep
- (not (setq swallowp
- (org-yank-folding-would-swallow-text beg end))))
- (org-with-limited-levels
- (or (looking-at org-outline-regexp)
- (re-search-forward org-outline-regexp-bol end t))
- (while (and (< (point) end) (looking-at org-outline-regexp))
- (org-fold-subtree t)
- (org-cycle-show-empty-lines 'folded)
- (condition-case nil
- (outline-forward-same-level 1)
- (error (goto-char end))))))
- (when swallowp
- (message
- "Inserted text not folded because that would swallow text"))
- (goto-char end)
- (skip-chars-forward " \t\n\r")
- (beginning-of-line 1)
- (push-mark beg 'nomsg)))
- ((and subtreep org-yank-adjusted-subtrees)
- (let ((beg (line-beginning-position)))
- (org-paste-subtree nil nil 'for-yank)
- (push-mark beg 'nomsg)))
- (t
- (call-interactively command))))))
- (defun org-yank-folding-would-swallow-text (beg end)
- "Would `hide-subtree' at BEG swallow any text after END?"
- (let (level)
- (org-with-limited-levels
- (save-excursion
- (goto-char beg)
- (when (or (looking-at org-outline-regexp)
- (re-search-forward org-outline-regexp-bol end t))
- (setq level (org-outline-level)))
- (goto-char end)
- (skip-chars-forward " \t\r\n\v\f")
- (not (or (eobp)
- (and (bolp) (looking-at-p org-outline-regexp)
- (<= (org-outline-level) level))))))))
- (defun org-back-to-heading (&optional invisible-ok)
- "Go back to beginning of heading."
- (beginning-of-line)
- (or (org-at-heading-p (not invisible-ok))
- (if (org-element--cache-active-p)
- (let ((heading (org-element-lineage (org-element-at-point)
- '(headline inlinetask)
- 'include-self)))
- (when heading
- (goto-char (org-element-property :begin heading)))
- (while (and (not invisible-ok)
- heading
- (org-fold-folded-p))
- (goto-char (org-fold-core-previous-visibility-change))
- (setq heading (org-element-lineage (org-element-at-point)
- '(headline inlinetask)
- 'include-self))
- (when heading
- (goto-char (org-element-property :begin heading))))
- (unless heading
- (user-error "Before first headline at position %d in buffer %s"
- (point) (current-buffer)))
- (point))
- (let (found)
- (save-excursion
- ;; At inlinetask end. Move to bol, so that the following
- ;; search goes to the beginning of the inlinetask.
- (when (and (featurep 'org-inlinetask)
- (fboundp 'org-inlinetask-end-p)
- (org-inlinetask-end-p))
- (goto-char (line-beginning-position)))
- (while (not found)
- (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
- nil t)
- (user-error "Before first headline at position %d in buffer %s"
- (point) (current-buffer)))
- ;; Skip inlinetask end.
- (if (and (featurep 'org-inlinetask)
- (fboundp 'org-inlinetask-end-p)
- (org-inlinetask-end-p))
- (org-inlinetask-goto-beginning)
- (setq found (and (or invisible-ok (not (org-fold-folded-p)))
- (point))))))
- (goto-char found)
- found))))
- (defun org-back-to-heading-or-point-min (&optional invisible-ok)
- "Go back to heading or first point in buffer.
- If point is before first heading go to first point in buffer
- instead of back to heading."
- (if (org-before-first-heading-p)
- (goto-char (point-min))
- (org-back-to-heading invisible-ok)))
- (defun org-before-first-heading-p ()
- "Before first heading?
- Respect narrowing."
- (let ((cached (org-element-at-point nil 'cached)))
- (if cached
- (let ((cached-headline (org-element-lineage cached '(headline) t)))
- (or (not cached-headline)
- (< (org-element-property :begin cached-headline) (point-min))))
- (org-with-limited-levels
- (save-excursion
- (end-of-line)
- (null (re-search-backward org-outline-regexp-bol nil t)))))))
- (defun org-at-heading-p (&optional invisible-not-ok)
- "Return t if point is on a (possibly invisible) heading line.
- If INVISIBLE-NOT-OK is non-nil, an invisible heading line is not ok."
- (save-excursion
- (beginning-of-line)
- (and (bolp) (or (not invisible-not-ok) (not (org-fold-folded-p)))
- (looking-at outline-regexp))))
- (defun org-in-commented-heading-p (&optional no-inheritance element)
- "Non-nil if point is under a commented heading.
- This function also checks ancestors of the current headline,
- unless optional argument NO-INHERITANCE is non-nil.
- Optional argument ELEMENT contains element at point."
- (save-match-data
- (let ((el (or element
- (org-element-at-point nil 'cached)
- (org-with-wide-buffer
- (org-back-to-heading-or-point-min t)
- (org-element-at-point)))))
- (catch :found
- (setq el (org-element-lineage el '(headline inlinetask) 'include-self))
- (if no-inheritance
- (org-element-property :commentedp el)
- (while el
- (when (org-element-property :commentedp el)
- (throw :found t))
- (setq el (org-element-property :parent el))))))))
- (defun org-in-archived-heading-p (&optional no-inheritance element)
- "Non-nil if point is under an archived heading.
- This function also checks ancestors of the current headline,
- unless optional argument NO-INHERITANCE is non-nil.
- Optional argument ELEMENT contains element at point."
- (cond
- ((and (not element) (org-before-first-heading-p)) nil)
- ((if element
- (org-element-property :archivedp element)
- (let ((tags (org-get-tags element 'local)))
- (and tags
- (cl-some (apply-partially #'string= org-archive-tag) tags)))))
- (no-inheritance nil)
- (t
- (if (or element (org-element--cache-active-p))
- (catch :archived
- (unless element (setq element (org-element-at-point)))
- (while element
- (when (org-element-property :archivedp element)
- (throw :archived t))
- (setq element (org-element-property :parent element))))
- (save-excursion (and (org-up-heading-safe) (org-in-archived-heading-p)))))))
- (defun org-at-comment-p nil
- "Return t if cursor is in a commented line."
- (save-excursion
- (save-match-data
- (beginning-of-line)
- (looking-at org-comment-regexp))))
- (defun org-at-keyword-p nil
- "Return t if cursor is at a keyword-line."
- (save-excursion
- (move-beginning-of-line 1)
- (looking-at org-keyword-regexp)))
- (defun org-at-drawer-p nil
- "Return t if cursor is at a drawer keyword."
- (save-excursion
- (move-beginning-of-line 1)
- (looking-at org-drawer-regexp)))
- (defun org-at-block-p nil
- "Return t if cursor is at a block keyword."
- (save-excursion
- (move-beginning-of-line 1)
- (looking-at org-block-regexp)))
- (defun org-point-at-end-of-empty-headline ()
- "If point is at the end of an empty headline, return t, else nil.
- If the heading only contains a TODO keyword, it is still considered
- empty."
- (let ((case-fold-search nil))
- (and (looking-at "[ \t]*$")
- org-todo-line-regexp
- (save-excursion
- (beginning-of-line)
- (looking-at org-todo-line-regexp)
- (string= (match-string 3) "")))))
- (defun org-at-heading-or-item-p ()
- (or (org-at-heading-p) (org-at-item-p)))
- (defun org-up-heading-all (arg)
- "Move to the heading line of which the present line is a subheading.
- This function considers both visible and invisible heading lines.
- With argument, move up ARG levels."
- (outline-up-heading arg t))
- (defvar-local org--up-heading-cache nil
- "Buffer-local `org-up-heading-safe' cache.")
- (defvar-local org--up-heading-cache-tick nil
- "Buffer `buffer-chars-modified-tick' in `org--up-heading-cache'.")
- (defun org-up-heading-safe ()
- "Move to the heading line of which the present line is a subheading.
- This version will not throw an error. It will return the level of the
- headline found, or nil if no higher level is found.
- Also, this function will be a lot faster than `outline-up-heading',
- because it relies on stars being the outline starters. This can really
- make a significant difference in outlines with very many siblings."
- (let ((element (and (org-element--cache-active-p)
- (org-element-at-point nil t))))
- (if element
- (let* ((current-heading (org-element-lineage element '(headline inlinetask) 'with-self))
- (parent (org-element-lineage current-heading '(headline))))
- (if (and parent
- (<= (point-min) (org-element-property :begin parent)))
- (progn
- (goto-char (org-element-property :begin parent))
- (org-element-property :level parent))
- (when (and current-heading
- (<= (point-min) (org-element-property :begin current-heading)))
- (goto-char (org-element-property :begin current-heading))
- nil)))
- (when (ignore-errors (org-back-to-heading t))
- (let (level-cache)
- (unless org--up-heading-cache
- (setq org--up-heading-cache (make-hash-table)))
- (if (and (eq (buffer-chars-modified-tick) org--up-heading-cache-tick)
- (setq level-cache (gethash (point) org--up-heading-cache)))
- (when (<= (point-min) (car level-cache) (point-max))
- ;; Parent is inside accessible part of the buffer.
- (progn (goto-char (car level-cache))
- (cdr level-cache)))
- ;; Buffer modified. Invalidate cache.
- (unless (eq (buffer-chars-modified-tick) org--up-heading-cache-tick)
- (setq-local org--up-heading-cache-tick
- (buffer-chars-modified-tick))
- (clrhash org--up-heading-cache))
- (let* ((level-up (1- (funcall outline-level)))
- (pos (point))
- (result (and (> level-up 0)
- (re-search-backward
- (format "^\\*\\{1,%d\\} " level-up) nil t)
- (funcall outline-level))))
- (when result (puthash pos (cons (point) result) org--up-heading-cache))
- result)))))))
- (defun org-up-heading-or-point-min ()
- "Move to the heading line of which the present is a subheading, or point-min.
- This version is needed to make point-min behave like a virtual
- heading of level 0 for property-inheritance. It will return the
- level of the headline found (down to 0) or nil if already at a
- point before the first headline or at point-min."
- (when (ignore-errors (org-back-to-heading t))
- (if (< 1 (funcall outline-level))
- (or (org-up-heading-safe)
- ;; The first heading may not be level 1 heading.
- (goto-char (point-min)))
- (unless (= (point) (point-min)) (goto-char (point-min))))))
- (defun org-first-sibling-p ()
- "Is this heading the first child of its parents?"
- (interactive)
- (let ((re org-outline-regexp-bol)
- level l)
- (unless (org-at-heading-p t)
- (user-error "Not at a heading"))
- (setq level (funcall outline-level))
- (save-excursion
- (if (not (re-search-backward re nil t))
- t
- (setq l (funcall outline-level))
- (< l level)))))
- (defun org-goto-sibling (&optional previous)
- "Goto the next sibling, even if it is invisible.
- When PREVIOUS is set, go to the previous sibling instead. Returns t
- when a sibling was found. When none is found, return nil and don't
- move point."
- (let ((fun (if previous 're-search-backward 're-search-forward))
- (pos (point))
- (re org-outline-regexp-bol)
- level l)
- (when (ignore-errors (org-back-to-heading t))
- (setq level (funcall outline-level))
- (catch 'exit
- (or previous (forward-char 1))
- (while (funcall fun re nil t)
- (setq l (funcall outline-level))
- (when (< l level) (goto-char pos) (throw 'exit nil))
- (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
- (goto-char pos)
- nil))))
- (defun org-goto-first-child (&optional element)
- "Goto the first child, even if it is invisible.
- Return t when a child was found. Otherwise don't move point and
- return nil."
- (if (org-element--cache-active-p)
- (let ((heading (org-element-lineage
- (or element (org-element-at-point))
- '(headline inlinetask org-data)
- t)))
- (when heading
- (unless (or (eq 'inlinetask (org-element-type heading))
- (not (org-element-property :contents-begin heading)))
- (let ((pos (point)))
- (goto-char (org-element-property :contents-begin heading))
- (if (re-search-forward
- org-outline-regexp-bol
- (org-element-property :end heading)
- t)
- (progn (goto-char (match-beginning 0)) t)
- (goto-char pos) nil)))))
- (let (level (pos (point)) (re org-outline-regexp-bol))
- (when (org-back-to-heading-or-point-min t)
- (setq level (org-outline-level))
- (forward-char 1)
- (if (and (re-search-forward re nil t) (> (org-outline-level) level))
- (progn (goto-char (match-beginning 0)) t)
- (goto-char pos) nil)))))
- (defun org-get-next-sibling ()
- "Move to next heading of the same level, and return point.
- If there is no such heading, return nil.
- This is like outline-next-sibling, but invisible headings are ok."
- (let ((level (funcall outline-level)))
- (outline-next-heading)
- (while (and (not (eobp)) (> (funcall outline-level) level))
- (outline-next-heading))
- (unless (or (eobp) (< (funcall outline-level) level))
- (point))))
- (defun org-get-previous-sibling ()
- "Move to previous heading of the same level, and return point.
- If there is no such heading, return nil."
- (let ((opoint (point))
- (level (funcall outline-level)))
- (outline-previous-heading)
- (when (and (/= (point) opoint) (outline-on-heading-p t))
- (while (and (> (funcall outline-level) level)
- (not (bobp)))
- (outline-previous-heading))
- (unless (< (funcall outline-level) level)
- (point)))))
- (defun org-end-of-subtree (&optional invisible-ok to-heading element)
- "Goto to the end of a subtree at point or for ELEMENT heading."
- ;; This contains an exact copy of the original function, but it uses
- ;; `org-back-to-heading-or-point-min', to make it work also in invisible
- ;; trees and before first headline. And is uses an invisible-ok argument.
- ;; Under Emacs this is not needed, but the old outline.el needs this fix.
- ;; Furthermore, when used inside Org, finding the end of a large subtree
- ;; with many children and grandchildren etc, this can be much faster
- ;; than the outline version.
- (if element
- (setq element (org-element-lineage element '(headline inlinetask) 'include-self))
- (org-back-to-heading-or-point-min invisible-ok))
- (unless (and (org-element--cache-active-p)
- (let ((cached (or element (org-element-at-point nil t))))
- (and cached
- (eq 'headline (org-element-type cached))
- (goto-char (org-element-property
- :end cached)))))
- (let ((first t)
- (level (funcall outline-level)))
- (cond ((= level 0)
- (goto-char (point-max)))
- ((and (derived-mode-p 'org-mode) (< level 1000))
- ;; A true heading (not a plain list item), in Org
- ;; This means we can easily find the end by looking
- ;; only for the right number of stars. Using a regexp to do
- ;; this is so much faster than using a Lisp loop.
- (let ((re (concat "^\\*\\{1," (number-to-string level) "\\} ")))
- (forward-char 1)
- (and (re-search-forward re nil 'move) (beginning-of-line 1))))
- (t
- ;; something else, do it the slow way
- (while (and (not (eobp))
- (or first (> (funcall outline-level) level)))
- (setq first nil)
- (outline-next-heading))))))
- (unless to-heading
- (when (memq (preceding-char) '(?\n ?\^M))
- ;; Go to end of line before heading
- (forward-char -1)
- (when (memq (preceding-char) '(?\n ?\^M))
- ;; leave blank line before heading
- (forward-char -1))))
- (point))
- (defun org-end-of-meta-data (&optional full)
- "Skip planning line and properties drawer in current entry.
- When optional argument FULL is t, also skip planning information,
- clocking lines and any kind of drawer.
- When FULL is non-nil but not t, skip planning information,
- properties, clocking lines and logbook drawers."
- (org-back-to-heading t)
- (forward-line)
- ;; Skip planning information.
- (when (looking-at-p org-planning-line-re) (forward-line))
- ;; Skip property drawer.
- (when (looking-at org-property-drawer-re)
- (goto-char (match-end 0))
- (forward-line))
- ;; When FULL is not nil, skip more.
- (when (and full (not (org-at-heading-p)))
- (catch 'exit
- (let ((end (save-excursion (outline-next-heading) (point)))
- (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
- (while (not (eobp))
- (cond ;; Skip clock lines.
- ((looking-at-p re) (forward-line))
- ;; Skip logbook drawer.
- ((looking-at-p org-logbook-drawer-re)
- (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
- (forward-line)
- (throw 'exit t)))
- ;; When FULL is t, skip regular drawer too.
- ((and (eq full t) (looking-at-p org-drawer-regexp))
- (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
- (forward-line)
- (throw 'exit t)))
- (t (throw 'exit t))))))))
- (defun org--line-fully-invisible-p ()
- "Return non-nil if the current line is fully invisible."
- (let ((line-beg (line-beginning-position))
- (line-pos (1- (line-end-position)))
- (is-invisible t))
- (while (and (< line-beg line-pos) is-invisible)
- (setq is-invisible (org-invisible-p line-pos))
- (setq line-pos (1- line-pos)))
- is-invisible))
- (defun org-forward-heading-same-level (arg &optional invisible-ok)
- "Move forward to the ARG'th subheading at same level as this one.
- Stop at the first and last subheadings of a superior heading.
- Normally this only looks at visible headings, but when INVISIBLE-OK is
- non-nil it will also look at invisible ones."
- (interactive "p")
- (let ((backward? (and arg (< arg 0))))
- (if (org-before-first-heading-p)
- (if backward? (goto-char (point-min)) (outline-next-heading))
- (org-back-to-heading invisible-ok)
- (unless backward? (end-of-line)) ;do not match current headline
- (let ((level (- (match-end 0) (match-beginning 0) 1))
- (f (if backward? #'re-search-backward #'re-search-forward))
- (count (if arg (abs arg) 1))
- (result (point)))
- (while (and (> count 0)
- (funcall f org-outline-regexp-bol nil 'move))
- (let ((l (- (match-end 0) (match-beginning 0) 1)))
- (cond ((< l level) (setq count 0))
- ((and (= l level)
- (or invisible-ok
- ;; FIXME: See commit a700fadd72 and the
- ;; related discussion on why using
- ;; `org--line-fully-invisible-p' is needed
- ;; here, which is to serve the needs of an
- ;; external package. If the change is
- ;; wrong regarding Org itself, it should
- ;; be removed.
- (not (org--line-fully-invisible-p))))
- (cl-decf count)
- (when (= l level) (setq result (point)))))))
- (goto-char result))
- (beginning-of-line))))
- (defun org-backward-heading-same-level (arg &optional invisible-ok)
- "Move backward to the ARG'th subheading at same level as this one.
- Stop at the first and last subheadings of a superior heading."
- (interactive "p")
- (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
- (defun org-next-visible-heading (arg)
- "Move to the next visible heading line.
- With ARG, repeats or can move backward if negative."
- (interactive "p")
- (let ((regexp (concat "^" (org-get-limited-outline-regexp))))
- (if (< arg 0)
- (beginning-of-line)
- (end-of-line))
- (while (and (< arg 0) (re-search-backward regexp nil :move))
- (unless (bobp)
- (when (org-fold-folded-p)
- (goto-char (org-fold-previous-visibility-change))
- (unless (looking-at-p regexp)
- (re-search-backward regexp nil :mode))))
- (cl-incf arg))
- (while (and (> arg 0) (re-search-forward regexp nil :move))
- (when (org-fold-folded-p)
- (goto-char (org-fold-next-visibility-change))
- (skip-chars-forward " \t\n")
- (end-of-line))
- (cl-decf arg))
- (if (> arg 0) (goto-char (point-max)) (beginning-of-line))))
- (defun org-previous-visible-heading (arg)
- "Move to the previous visible heading.
- With ARG, repeats or can move forward if negative."
- (interactive "p")
- (org-next-visible-heading (- arg)))
- (defun org-forward-paragraph (&optional arg)
- "Move forward by a paragraph, or equivalent, unit.
- With argument ARG, do it ARG times;
- a negative argument ARG = -N means move backward N paragraphs.
- The function moves point between two structural
- elements (paragraphs, tables, lists, etc.).
- It also provides the following special moves for convenience:
- - on a table or a property drawer, move to its beginning;
- - on comment, example, export, source and verse blocks, stop
- at blank lines;
- - skip consecutive clocks, diary S-exps, and keywords."
- (interactive "^p")
- (unless arg (setq arg 1))
- (if (< arg 0) (org-backward-paragraph (- arg))
- (while (and (> arg 0) (not (eobp)))
- (org--forward-paragraph-once)
- (cl-decf arg))
- ;; Return moves left.
- arg))
- (defun org-backward-paragraph (&optional arg)
- "Move backward by a paragraph, or equivalent, unit.
- With argument ARG, do it ARG times;
- a negative argument ARG = -N means move forward N paragraphs.
- The function moves point between two structural
- elements (paragraphs, tables, lists, etc.).
- It also provides the following special moves for convenience:
- - on a table or a property drawer, move to its beginning;
- - on comment, example, export, source and verse blocks, stop
- at blank lines;
- - skip consecutive clocks, diary S-exps, and keywords."
- (interactive "^p")
- (unless arg (setq arg 1))
- (if (< arg 0) (org-forward-paragraph (- arg))
- (while (and (> arg 0) (not (bobp)))
- (org--backward-paragraph-once)
- (cl-decf arg))
- ;; Return moves left.
- arg))
- (defvar org--single-lines-list-is-paragraph t
- "Treat plain lists with single line items as a whole paragraph")
- (defun org--paragraph-at-point ()
- "Return paragraph, or equivalent, element at point.
- Paragraph element at point is the element at point, with the
- following special cases:
- - treat table rows (resp. node properties) as the table
- \(resp. property drawer) containing them.
- - treat plain lists with an item every line as a whole.
- - treat consecutive keywords, clocks, and diary-sexps as a single
- block.
- Function may return a real element, or a pseudo-element with type
- `pseudo-paragraph'."
- (let* ((e (org-element-at-point))
- (type (org-element-type e))
- ;; If we need to fake a new pseudo-element, triplet is
- ;;
- ;; (BEG END PARENT)
- ;;
- ;; where BEG and END are element boundaries, and PARENT the
- ;; element containing it, or nil.
- (triplet
- (cond
- ((memq type '(table property-drawer))
- (list (org-element-property :begin e)
- (org-element-property :end e)
- (org-element-property :parent e)))
- ((memq type '(node-property table-row))
- (let ((e (org-element-property :parent e)))
- (list (org-element-property :begin e)
- (org-element-property :end e)
- (org-element-property :parent e))))
- ((memq type '(clock diary-sexp keyword))
- (let* ((regexp (pcase type
- (`clock org-clock-line-re)
- (`diary-sexp "%%(")
- (_ org-keyword-regexp)))
- (end (if (< 0 (org-element-property :post-blank e))
- (org-element-property :end e)
- (org-with-wide-buffer
- (forward-line)
- (while (looking-at regexp) (forward-line))
- (skip-chars-forward " \t\n")
- (line-beginning-position))))
- (begin (org-with-point-at (org-element-property :begin e)
- (while (and (not (bobp)) (looking-at regexp))
- (forward-line -1))
- ;; We may have gotten one line too far.
- (if (looking-at regexp)
- (point)
- (line-beginning-position 2)))))
- (list begin end (org-element-property :parent e))))
- ;; Find the full plain list containing point, the check it
- ;; contains exactly one line per item.
- ((let ((l (org-element-lineage e '(plain-list) t)))
- (while (memq (org-element-type (org-element-property :parent l))
- '(item plain-list))
- (setq l (org-element-property :parent l)))
- (and l org--single-lines-list-is-paragraph
- (org-with-point-at (org-element-property :post-affiliated l)
- (forward-line (length (org-element-property :structure l)))
- (= (point) (org-element-property :contents-end l)))
- ;; Return value.
- (list (org-element-property :begin l)
- (org-element-property :end l)
- (org-element-property :parent l)))))
- (t nil)))) ;no triplet: return element
- (pcase triplet
- (`(,b ,e ,p)
- (org-element-create
- 'pseudo-paragraph
- (list :begin b :end e :parent p :post-blank 0 :post-affiliated b)))
- (_ e))))
- (defun org--forward-paragraph-once ()
- "Move forward to end of paragraph or equivalent, once.
- See `org-forward-paragraph'."
- (interactive)
- (save-restriction
- (widen)
- (skip-chars-forward " \t\n")
- (cond
- ((eobp) nil)
- ;; When inside a folded part, move out of it.
- ((when (org-invisible-p nil t)
- (goto-char (cdr (org-fold-get-region-at-point)))
- (forward-line)
- t))
- (t
- (let* ((element (org--paragraph-at-point))
- (type (org-element-type element))
- (contents-begin (org-element-property :contents-begin element))
- (end (org-element-property :end element))
- (post-affiliated (org-element-property :post-affiliated element)))
- (cond
- ((eq type 'plain-list)
- (forward-char)
- (org--forward-paragraph-once))
- ;; If the element is folded, skip it altogether.
- ((when (org-with-point-at post-affiliated (org-invisible-p (line-end-position) t))
- (goto-char (cdr (org-fold-get-region-at-point
- nil
- (org-with-point-at post-affiliated
- (line-end-position)))))
- (forward-line)
- t))
- ;; At a greater element, move inside.
- ((and contents-begin
- (> contents-begin (point))
- (not (eq type 'paragraph)))
- (goto-char contents-begin)
- ;; Items and footnote definitions contents may not start at
- ;; the beginning of the line. In this case, skip until the
- ;; next paragraph.
- (cond
- ((not (bolp)) (org--forward-paragraph-once))
- ((org-previous-line-empty-p) (forward-line -1))
- (t nil)))
- ;; Move between empty lines in some blocks.
- ((memq type '(comment-block example-block export-block src-block
- verse-block))
- (let ((contents-start
- (org-with-point-at post-affiliated
- (line-beginning-position 2))))
- (if (< (point) contents-start)
- (goto-char contents-start)
- (let ((contents-end
- (org-with-point-at end
- (skip-chars-backward " \t\n")
- (line-beginning-position))))
- (cond
- ((>= (point) contents-end)
- (goto-char end)
- (skip-chars-backward " \t\n")
- (forward-line))
- ((re-search-forward "^[ \t]*\n" contents-end :move)
- (forward-line -1))
- (t nil))))))
- (t
- ;; Move to element's end.
- (goto-char end)
- (skip-chars-backward " \t\n")
- (forward-line))))))))
- (defun org--backward-paragraph-once ()
- "Move backward to start of paragraph or equivalent, once.
- See `org-backward-paragraph'."
- (interactive)
- (save-restriction
- (widen)
- (cond
- ((bobp) nil)
- ;; Blank lines at the beginning of the buffer.
- ((and (org-match-line "^[ \t]*$")
- (save-excursion (skip-chars-backward " \t\n") (bobp)))
- (goto-char (point-min)))
- ;; When inside a folded part, move out of it.
- ((when (org-invisible-p (1- (point)) t)
- (goto-char (1- (car (org-fold-get-region-at-point nil (1- (point))))))
- (org--backward-paragraph-once)
- t))
- (t
- (let* ((element (org--paragraph-at-point))
- (type (org-element-type element))
- (begin (org-element-property :begin element))
- (post-affiliated (org-element-property :post-affiliated element))
- (contents-end (org-element-property :contents-end element))
- (end (org-element-property :end element))
- (parent (org-element-property :parent element))
- (reach
- ;; Move to the visible empty line above position P, or
- ;; to position P. Return t.
- (lambda (p)
- (goto-char p)
- (when (and (org-previous-line-empty-p)
- (let ((end (line-end-position 0)))
- (or (= end (point-min))
- (not (org-invisible-p (1- end))))))
- (forward-line -1))
- t)))
- (cond
- ;; Already at the beginning of an element.
- ((= begin (point))
- (cond
- ;; There is a blank line above. Move there.
- ((and (org-previous-line-empty-p)
- (not (org-invisible-p (1- (line-end-position 0)))))
- (forward-line -1))
- ;; At the beginning of the first element within a greater
- ;; element. Move to the beginning of the greater element.
- ((and parent
- (not (eq 'section (org-element-type parent)))
- (= begin (org-element-property :contents-begin parent)))
- (funcall reach (org-element-property :begin parent)))
- ;; Since we have to move anyway, find the beginning
- ;; position of the element above.
- (t
- (forward-char -1)
- (org--backward-paragraph-once))))
- ;; Skip paragraphs at the very beginning of footnote
- ;; definitions or items.
- ((and (eq type 'paragraph)
- (org-with-point-at begin (not (bolp))))
- (funcall reach (progn (goto-char begin) (line-beginning-position))))
- ;; If the element is folded, skip it altogether.
- ((org-with-point-at post-affiliated (org-invisible-p (line-end-position) t))
- (funcall reach begin))
- ;; At the end of a greater element, move inside.
- ((and contents-end
- (<= contents-end (point))
- (not (eq type 'paragraph)))
- (cond
- ((memq type '(footnote-definition plain-list))
- (skip-chars-backward " \t\n")
- (org--backward-paragraph-once))
- ((= contents-end (point))
- (forward-char -1)
- (org--backward-paragraph-once))
- (t
- (goto-char contents-end))))
- ;; Move between empty lines in some blocks.
- ((and (memq type '(comment-block example-block export-block src-block
- verse-block))
- (let ((contents-start
- (org-with-point-at post-affiliated
- (line-beginning-position 2))))
- (when (> (point) contents-start)
- (let ((contents-end
- (org-with-point-at end
- (skip-chars-backward " \t\n")
- (line-beginning-position))))
- (if (> (point) contents-end)
- (progn (goto-char contents-end) t)
- (skip-chars-backward " \t\n" begin)
- (re-search-backward "^[ \t]*\n" contents-start :move)
- t))))))
- ;; Move to element's start.
- (t
- (funcall reach begin))))))))
- (defun org-forward-element ()
- "Move forward by one element.
- Move to the next element at the same level, when possible."
- (interactive)
- (cond ((eobp) (user-error "Cannot move further down"))
- ((org-with-limited-levels (org-at-heading-p))
- (let ((origin (point)))
- (goto-char (org-end-of-subtree nil t))
- (unless (org-with-limited-levels (org-at-heading-p))
- (goto-char origin)
- (user-error "Cannot move further down"))))
- (t
- (let* ((elem (org-element-at-point))
- (end (org-element-property :end elem))
- (parent (org-element-property :parent elem)))
- (cond ((and parent (= (org-element-property :contents-end parent) end))
- (goto-char (org-element-property :end parent)))
- ((integer-or-marker-p end) (goto-char end))
- (t (message "No element at point")))))))
- (defun org-backward-element ()
- "Move backward by one element.
- Move to the previous element at the same level, when possible."
- (interactive)
- (cond ((bobp) (user-error "Cannot move further up"))
- ((org-with-limited-levels (org-at-heading-p))
- ;; At a headline, move to the previous one, if any, or stay
- ;; here.
- (let ((origin (point)))
- (org-with-limited-levels (org-backward-heading-same-level 1))
- ;; When current headline has no sibling above, move to its
- ;; parent.
- (when (= (point) origin)
- (or (org-with-limited-levels (org-up-heading-safe))
- (progn (goto-char origin)
- (user-error "Cannot move further up"))))))
- (t
- (let* ((elem (org-element-at-point))
- (beg (org-element-property :begin elem)))
- (cond
- ;; Move to beginning of current element if point isn't
- ;; there already.
- ((null beg) (message "No element at point"))
- ((/= (point) beg) (goto-char beg))
- (t (goto-char beg)
- (skip-chars-backward " \r\t\n")
- (unless (bobp)
- (let ((prev (org-element-at-point)))
- (goto-char (org-element-property :begin prev))
- (while (and (setq prev (org-element-property :parent prev))
- (<= (org-element-property :end prev) beg))
- (goto-char (org-element-property :begin prev)))))))))))
- (defun org-up-element ()
- "Move to upper element."
- (interactive)
- (if (org-with-limited-levels (org-at-heading-p))
- (unless (org-up-heading-safe) (user-error "No surrounding element"))
- (let* ((elem (org-element-at-point))
- (parent (org-element-property :parent elem)))
- (if (and parent
- (not (memq (org-element-type parent) '(section org-data))))
- (goto-char (org-element-property :begin parent))
- (if (org-with-limited-levels (org-before-first-heading-p))
- (user-error "No surrounding element")
- (org-with-limited-levels (org-back-to-heading)))))))
- (defun org-down-element ()
- "Move to inner element."
- (interactive)
- (let ((element (org-element-at-point)))
- (cond
- ((memq (org-element-type element) '(plain-list table))
- (goto-char (org-element-property :contents-begin element))
- (forward-char))
- ((memq (org-element-type element) org-element-greater-elements)
- ;; If contents are hidden, first disclose them.
- (when (org-invisible-p (line-end-position)) (org-cycle))
- (goto-char (or (org-element-property :contents-begin element)
- (user-error "No content for this element"))))
- (t (user-error "No inner element")))))
- (defun org-drag-element-backward ()
- "Move backward element at point."
- (interactive)
- (let ((elem (or (org-element-at-point)
- (user-error "No element at point"))))
- (if (eq (org-element-type elem) 'headline)
- ;; Preserve point when moving a whole tree, even if point was
- ;; on blank lines below the headline.
- (let ((offset (skip-chars-backward " \t\n")))
- (unwind-protect (org-move-subtree-up)
- (forward-char (- offset))))
- (let ((prev-elem
- (save-excursion
- (goto-char (org-element-property :begin elem))
- (skip-chars-backward " \r\t\n")
- (unless (bobp)
- (let* ((beg (org-element-property :begin elem))
- (prev (org-element-at-point))
- (up prev))
- (while (and (setq up (org-element-property :parent up))
- (<= (org-element-property :end up) beg))
- (setq prev up))
- prev)))))
- ;; Error out if no previous element or previous element is
- ;; a parent of the current one.
- (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
- (user-error "Cannot drag element backward")
- (let ((pos (point)))
- (org-element-swap-A-B prev-elem elem)
- (goto-char (+ (org-element-property :begin prev-elem)
- (- pos (org-element-property :begin elem))))))))))
- (defun org-drag-element-forward ()
- "Move forward element at point."
- (interactive)
- (let* ((pos (point))
- (elem (or (org-element-at-point)
- (user-error "No element at point"))))
- (when (= (point-max) (org-element-property :end elem))
- (user-error "Cannot drag element forward"))
- (goto-char (org-element-property :end elem))
- (let ((next-elem (org-element-at-point)))
- (when (or (org-element-nested-p elem next-elem)
- (and (eq (org-element-type next-elem) 'headline)
- (not (eq (org-element-type elem) 'headline))))
- (goto-char pos)
- (user-error "Cannot drag element forward"))
- ;; Compute new position of point: it's shifted by NEXT-ELEM
- ;; body's length (without final blanks) and by the length of
- ;; blanks between ELEM and NEXT-ELEM.
- (let ((size-next (- (save-excursion
- (goto-char (org-element-property :end next-elem))
- (skip-chars-backward " \r\t\n")
- (forward-line)
- ;; Small correction if buffer doesn't end
- ;; with a newline character.
- (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
- (org-element-property :begin next-elem)))
- (size-blank (- (org-element-property :end elem)
- (save-excursion
- (goto-char (org-element-property :end elem))
- (skip-chars-backward " \r\t\n")
- (forward-line)
- (point)))))
- (org-element-swap-A-B elem next-elem)
- (goto-char (+ pos size-next size-blank))))))
- (defun org-drag-line-forward (arg)
- "Drag the line at point ARG lines forward."
- (interactive "p")
- (dotimes (_ (abs arg))
- (let ((c (current-column)))
- (if (< 0 arg)
- (progn
- (beginning-of-line 2)
- (transpose-lines 1)
- (beginning-of-line 0))
- (transpose-lines 1)
- (beginning-of-line -1))
- (org-move-to-column c))))
- (defun org-drag-line-backward (arg)
- "Drag the line at point ARG lines backward."
- (interactive "p")
- (org-drag-line-forward (- arg)))
- (defun org-mark-element ()
- "Put point at beginning of this element, mark at end.
- Interactively, if this command is repeated or (in Transient Mark
- mode) if the mark is active, it marks the next element after the
- ones already marked."
- (interactive)
- (let (deactivate-mark)
- (if (and (called-interactively-p 'any)
- (or (and (eq last-command this-command) (mark t))
- (and transient-mark-mode mark-active)))
- (set-mark
- (save-excursion
- (goto-char (mark))
- (goto-char (org-element-property :end (org-element-at-point)))
- (point)))
- (let ((element (org-element-at-point)))
- (end-of-line)
- (push-mark (min (point-max) (org-element-property :end element)) t t)
- (goto-char (org-element-property :begin element))))))
- (defun org-narrow-to-element ()
- "Narrow buffer to current element."
- (interactive)
- (let ((elem (org-element-at-point)))
- (cond
- ((eq (car elem) 'headline)
- (narrow-to-region
- (org-element-property :begin elem)
- (org-element-property :end elem)))
- ((memq (car elem) org-element-greater-elements)
- (narrow-to-region
- (org-element-property :contents-begin elem)
- (org-element-property :contents-end elem)))
- (t
- (narrow-to-region
- (org-element-property :begin elem)
- (org-element-property :end elem))))))
- (defun org-transpose-element ()
- "Transpose current and previous elements, keeping blank lines between.
- Point is moved after both elements."
- (interactive)
- (org-skip-whitespace)
- (let ((end (org-element-property :end (org-element-at-point))))
- (org-drag-element-backward)
- (goto-char end)))
- (defun org-unindent-buffer ()
- "Un-indent the visible part of the buffer.
- Relative indentation (between items, inside blocks, etc.) isn't
- modified."
- (interactive)
- (unless (eq major-mode 'org-mode)
- (user-error "Cannot un-indent a buffer not in Org mode"))
- (letrec ((parse-tree (org-element-parse-buffer 'greater-element))
- (unindent-tree
- (lambda (contents)
- (dolist (element (reverse contents))
- (if (memq (org-element-type element) '(headline section))
- (funcall unindent-tree (org-element-contents element))
- (save-excursion
- (save-restriction
- (narrow-to-region
- (org-element-property :begin element)
- (org-element-property :end element))
- (org-do-remove-indentation))))))))
- (funcall unindent-tree (org-element-contents parse-tree))))
- (defun org-make-options-regexp (kwds &optional extra)
- "Make a regular expression for keyword lines.
- KWDS is a list of keywords, as strings. Optional argument EXTRA,
- when non-nil, is a regexp matching keywords names."
- (concat "^[ \t]*#\\+\\("
- (regexp-opt kwds)
- (and extra (concat (and kwds "\\|") extra))
- "\\):[ \t]*\\(.*\\)"))
- ;;; Conveniently switch to Info nodes
- (defun org-info-find-node (&optional nodename)
- "Find Info documentation NODENAME or Org documentation according context.
- Started from `gnus-info-find-node'."
- (interactive)
- (Info-goto-node
- (or nodename
- (let ((default-org-info-node "(org) Top"))
- (cond
- ((eq 'org-agenda-mode major-mode) "(org) Agenda Views")
- ((eq 'org-mode major-mode)
- (let* ((context (org-element-at-point))
- (element-info-nodes ; compare to `org-element-all-elements'.
- `((babel-call . "(org) Evaluating Code Blocks")
- (center-block . "(org) Paragraphs")
- (clock . ,default-org-info-node)
- (comment . "(org) Comment Lines")
- (comment-block . "(org) Comment Lines")
- (diary-sexp . ,default-org-info-node)
- (drawer . "(org) Drawers")
- (dynamic-block . "(org) Dynamic Blocks")
- (example-block . "(org) Literal Examples")
- (export-block . "(org) ASCII/Latin-1/UTF-8 export")
- (fixed-width . ,default-org-info-node)
- (footnote-definition . "(org) Creating Footnotes")
- (headline . "(org) Document Structure")
- (horizontal-rule . "(org) Built-in Table Editor")
- (inlinetask . ,default-org-info-node)
- (item . "(org) Plain Lists")
- (keyword . "(org) Per-file keywords")
- (latex-environment . "(org) LaTeX Export")
- (node-property . "(org) Properties and Columns")
- (paragraph . "(org) Paragraphs")
- (plain-list . "(org) Plain Lists")
- (planning . "(org) Deadlines and Scheduling")
- (property-drawer . "(org) Properties and Columns")
- (quote-block . "(org) Paragraphs")
- (section . ,default-org-info-node)
- (special-block . ,default-org-info-node)
- (src-block . "(org) Working with Source Code")
- (table . "(org) Tables")
- (table-row . "(org) Tables")
- (verse-block . "(org) Paragraphs"))))
- (or (cdr (assoc (car context) element-info-nodes))
- default-org-info-node)))
- (t default-org-info-node))))))
- ;;; Finish up
- (add-hook 'org-mode-hook ;remove folds when changing major mode
- (lambda () (add-hook 'change-major-mode-hook
- 'org-fold-show-all 'append 'local)))
- (provide 'org)
- (run-hooks 'org-load-hook)
- ;;; org.el ends here
|