org-agenda.el 448 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2022 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; URL: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'org-macs)
  42. (org-assert-version)
  43. (require 'cl-lib)
  44. (require 'ol)
  45. (require 'org-fold-core)
  46. (require 'org)
  47. (require 'org-macs)
  48. (require 'org-refile)
  49. (declare-function diary-add-to-list "diary-lib"
  50. (date string specifier &optional marker globcolor literal))
  51. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  52. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  53. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  54. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  55. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  56. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  57. (declare-function calendar-french-date-string "cal-french" (&optional date))
  58. (declare-function calendar-goto-date "cal-move" (date))
  59. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  60. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  61. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  62. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  63. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  64. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  65. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  66. (declare-function calendar-check-holidays "holidays" (date))
  67. (declare-function org-columns-remove-overlays "org-colview" ())
  68. (declare-function org-datetree-find-date-create "org-datetree"
  69. (date &optional keep-restriction))
  70. (declare-function org-columns-quit "org-colview" ())
  71. (declare-function diary-date-display-form "diary-lib" (&optional type))
  72. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  73. (declare-function org-element-property "org-element" (property element))
  74. (declare-function org-element--cache-active-p "org-element"
  75. (&optional called-from-cache-change-func-p))
  76. (declare-function org-element-lineage "org-element"
  77. (datum &optional types with-self))
  78. (declare-function org-habit-insert-consistency-graphs
  79. "org-habit" (&optional line))
  80. (declare-function org-is-habit-p "org-habit" (&optional pom))
  81. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  82. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  83. (declare-function org-agenda-columns "org-colview" ())
  84. (declare-function org-add-archive-files "org-archive" (files))
  85. (declare-function org-capture "org-capture" (&optional goto keys))
  86. (declare-function org-clock-modify-effort-estimate "org-clock" (&optional value))
  87. (declare-function org-element-type "org-element" (&optional element))
  88. (defvar calendar-mode-map)
  89. (defvar org-clock-current-task)
  90. (defvar org-current-tag-alist)
  91. (defvar org-mobile-force-id-on-agenda-items)
  92. (defvar org-habit-show-habits)
  93. (defvar org-habit-show-habits-only-for-today)
  94. (defvar org-habit-show-all-today)
  95. (defvar org-habit-scheduled-past-days)
  96. ;; Defined somewhere in this file, but used before definition.
  97. (defvar org-agenda-buffer-name "*Org Agenda*")
  98. (defvar org-agenda-title-append nil)
  99. (defvar org-agenda-overriding-header)
  100. ;; (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  101. ;; (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  102. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  103. (defvar org-agenda-undo-list nil
  104. "List of undoable operations in the agenda since last refresh.")
  105. (defvar org-agenda-pending-undo-list nil
  106. "In a series of undo commands, this is the list of remaining undo items.")
  107. (defcustom org-agenda-confirm-kill 1
  108. "When set, remote killing from the agenda buffer needs confirmation.
  109. When t, a confirmation is always needed. When a number N, confirmation is
  110. only needed when the text to be killed contains more than N non-white lines."
  111. :group 'org-agenda
  112. :type '(choice
  113. (const :tag "Never" nil)
  114. (const :tag "Always" t)
  115. (integer :tag "When more than N lines")))
  116. (defcustom org-agenda-compact-blocks nil
  117. "Non-nil means make the block agenda more compact.
  118. This is done globally by leaving out lines like the agenda span
  119. name and week number or the separator lines."
  120. :group 'org-agenda
  121. :type 'boolean)
  122. (defcustom org-agenda-block-separator
  123. (if (and (display-graphic-p)
  124. (char-displayable-p ?─))
  125. ?─
  126. ?=)
  127. "The separator between blocks in the agenda.
  128. If this is a string, it will be used as the separator, with a newline added.
  129. If it is a character, it will be repeated to fill the window width.
  130. If nil the separator is disabled. In `org-agenda-custom-commands' this
  131. addresses the separator between the current and the previous block."
  132. :group 'org-agenda
  133. :version "29.1"
  134. :type '(choice
  135. (const :tag "Disabled" nil)
  136. (character)
  137. (string)))
  138. (defgroup org-agenda-export nil
  139. "Options concerning exporting agenda views in Org mode."
  140. :tag "Org Agenda Export"
  141. :group 'org-agenda)
  142. (defcustom org-agenda-with-colors t
  143. "Non-nil means use colors in agenda views."
  144. :group 'org-agenda-export
  145. :type 'boolean)
  146. (defcustom org-agenda-exporter-settings nil
  147. ;; FIXME: Do we really want to evaluate those settings and thus force
  148. ;; the user to use `quote' all the time?
  149. "Alist of variable/value pairs that should be active during agenda export.
  150. This is a good place to set options for ps-print and for htmlize.
  151. Note that the way this is implemented, the values will be evaluated
  152. before assigned to the variables. So make sure to quote values you do
  153. *not* want evaluated, for example
  154. (setq org-agenda-exporter-settings
  155. \\='((ps-print-color-p \\='black-white)))"
  156. :group 'org-agenda-export
  157. :type '(repeat
  158. (list
  159. (variable)
  160. (sexp :tag "Value"))))
  161. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  162. "Hook run in a temporary buffer before writing the agenda to an export file.
  163. A useful function for this hook is `org-agenda-add-entry-text'."
  164. :group 'org-agenda-export
  165. :type 'hook
  166. :options '(org-agenda-add-entry-text))
  167. (defcustom org-agenda-add-entry-text-maxlines 0
  168. "Maximum number of entry text lines to be added to agenda.
  169. This is only relevant when `org-agenda-add-entry-text' is part of
  170. `org-agenda-before-write-hook', which is the default.
  171. When this is 0, nothing will happen. When it is greater than 0, it
  172. specifies the maximum number of lines that will be added for each entry
  173. that is listed in the agenda view.
  174. Note that this variable is not used during display, only when exporting
  175. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  176. and `org-agenda-entry-text-maxlines'."
  177. :group 'org-agenda
  178. :type 'integer)
  179. (defcustom org-agenda-add-entry-text-descriptive-links t
  180. "Non-nil means export org-links as descriptive links in agenda added text.
  181. This variable applies to the text added to the agenda when
  182. `org-agenda-add-entry-text-maxlines' is larger than 0.
  183. When this variable is nil, the URL will (also) be shown."
  184. :group 'org-agenda
  185. :type 'boolean)
  186. (defcustom org-agenda-export-html-style nil
  187. "The style specification for exported HTML Agenda files.
  188. If this variable contains a string, it will replace the default <style>
  189. section as produced by `htmlize'.
  190. Since there are different ways of setting style information, this variable
  191. needs to contain the full HTML structure to provide a style, including the
  192. surrounding HTML tags. The style specifications should include definitions
  193. the fonts used by the agenda, here is an example:
  194. <style type=\"text/css\">
  195. p { font-weight: normal; color: gray; }
  196. .org-agenda-structure {
  197. font-size: 110%;
  198. color: #003399;
  199. font-weight: 600;
  200. }
  201. .org-todo {
  202. color: #cc6666;
  203. font-weight: bold;
  204. }
  205. .org-agenda-done {
  206. color: #339933;
  207. }
  208. .org-done {
  209. color: #339933;
  210. }
  211. .title { text-align: center; }
  212. .todo, .deadline { color: red; }
  213. .done { color: green; }
  214. </style>
  215. or, if you want to keep the style in a file,
  216. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  217. As the value of this option simply gets inserted into the HTML <head> header,
  218. you can \"misuse\" it to also add other text to the header."
  219. :group 'org-agenda-export
  220. :group 'org-export-html
  221. :type '(choice
  222. (const nil)
  223. (string)))
  224. (defcustom org-agenda-persistent-filter nil
  225. "When set, keep filters from one agenda view to the next."
  226. :group 'org-agenda
  227. :type 'boolean)
  228. (defgroup org-agenda-custom-commands nil
  229. "Options concerning agenda views in Org mode."
  230. :tag "Org Agenda Custom Commands"
  231. :group 'org-agenda)
  232. (defconst org-sorting-choice
  233. '(choice
  234. (const time-up) (const time-down)
  235. (const timestamp-up) (const timestamp-down)
  236. (const scheduled-up) (const scheduled-down)
  237. (const deadline-up) (const deadline-down)
  238. (const ts-up) (const ts-down)
  239. (const tsia-up) (const tsia-down)
  240. (const category-keep) (const category-up) (const category-down)
  241. (const tag-down) (const tag-up)
  242. (const priority-up) (const priority-down)
  243. (const todo-state-up) (const todo-state-down)
  244. (const effort-up) (const effort-down)
  245. (const habit-up) (const habit-down)
  246. (const alpha-up) (const alpha-down)
  247. (const user-defined-up) (const user-defined-down))
  248. "Sorting choices.")
  249. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  250. ;; the new variable `org-agenda-tag-filter-preset'.
  251. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  252. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  253. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  254. "List of types searched for when creating the daily/weekly agenda.
  255. This variable is a list of symbols that controls the types of
  256. items that appear in the daily/weekly agenda. Allowed symbols in this
  257. list are
  258. :timestamp List items containing a date stamp or date range matching
  259. the selected date. This includes sexp entries in angular
  260. brackets.
  261. :sexp List entries resulting from plain diary-like sexps.
  262. :deadline List deadline due on that date. When the date is today,
  263. also list any deadlines past due, or due within
  264. `org-deadline-warning-days'.
  265. :deadline* Same as above, but only include the deadline if it has an
  266. hour specification as [h]h:mm.
  267. :scheduled List all items which are scheduled for the given date.
  268. The diary for *today* also contains items which were
  269. scheduled earlier and are not yet marked DONE.
  270. :scheduled* Same as above, but only include the scheduled item if it
  271. has an hour specification as [h]h:mm.
  272. By default, all four non-starred types are turned on.
  273. When :scheduled* or :deadline* are included, :schedule or :deadline
  274. will be ignored.
  275. Never set this variable globally using `setq', because then it
  276. will apply to all future agenda commands. Instead, bind it with
  277. `let' to scope it dynamically into the agenda-constructing
  278. command. A good way to set it is through options in
  279. `org-agenda-custom-commands'. For a more flexible (though
  280. somewhat less efficient) way of determining what is included in
  281. the daily/weekly agenda, see `org-agenda-skip-function'.")
  282. (defconst org-agenda-custom-commands-local-options
  283. `(repeat :tag "Local settings for this command. Remember to quote values"
  284. (choice :tag "Setting"
  285. (list :tag "Heading for this block"
  286. (const org-agenda-overriding-header)
  287. (string :tag "Headline"))
  288. (list :tag "Files to be searched"
  289. (const org-agenda-files)
  290. (list
  291. (const :format "" quote)
  292. (repeat (file))))
  293. (list :tag "Sorting strategy"
  294. (const org-agenda-sorting-strategy)
  295. (list
  296. (const :format "" quote)
  297. (repeat
  298. ,org-sorting-choice)))
  299. (list :tag "Prefix format"
  300. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  301. (string))
  302. (list :tag "Number of days in agenda"
  303. (const org-agenda-span)
  304. (list
  305. (const :format "" quote)
  306. (choice (const :tag "Day" day)
  307. (const :tag "Week" week)
  308. (const :tag "Fortnight" fortnight)
  309. (const :tag "Month" month)
  310. (const :tag "Year" year)
  311. (integer :tag "Custom"))))
  312. (list :tag "Fixed starting date"
  313. (const org-agenda-start-day)
  314. (string :value "2007-11-01"))
  315. (list :tag "Start on day of week"
  316. (const org-agenda-start-on-weekday)
  317. (choice :value 1
  318. (const :tag "Today" nil)
  319. (integer :tag "Weekday No.")))
  320. (list :tag "Include data from diary"
  321. (const org-agenda-include-diary)
  322. (boolean))
  323. (list :tag "Deadline Warning days"
  324. (const org-deadline-warning-days)
  325. (integer :value 1))
  326. (list :tag "Category filter preset"
  327. (const org-agenda-category-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+category or -category"))))
  332. (list :tag "Tags filter preset"
  333. (const org-agenda-tag-filter-preset)
  334. (list
  335. (const :format "" quote)
  336. (repeat
  337. (string :tag "+tag or -tag"))))
  338. (list :tag "Effort filter preset"
  339. (const org-agenda-effort-filter-preset)
  340. (list
  341. (const :format "" quote)
  342. (repeat
  343. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  344. (list :tag "Regexp filter preset"
  345. (const org-agenda-regexp-filter-preset)
  346. (list
  347. (const :format "" quote)
  348. (repeat
  349. (string :tag "+regexp or -regexp"))))
  350. (list :tag "Set daily/weekly entry types"
  351. (const org-agenda-entry-types)
  352. (list
  353. (const :format "" quote)
  354. (set :greedy t :value ,org-agenda-entry-types
  355. (const :deadline)
  356. (const :scheduled)
  357. (const :deadline*)
  358. (const :scheduled*)
  359. (const :timestamp)
  360. (const :sexp))))
  361. (list :tag "Columns format"
  362. (const org-overriding-columns-format)
  363. (string :tag "Format"))
  364. (list :tag "Standard skipping condition"
  365. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  366. (const org-agenda-skip-function)
  367. (list
  368. (const :format "" quote)
  369. (list
  370. (choice
  371. :tag "Skipping range"
  372. (const :tag "Skip entry" org-agenda-skip-entry-if)
  373. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  374. (repeat :inline t :tag "Conditions for skipping"
  375. (choice
  376. :tag "Condition type"
  377. (list :tag "Regexp matches" :inline t
  378. (const :format "" regexp)
  379. (regexp))
  380. (list :tag "Regexp does not match" :inline t
  381. (const :format "" notregexp)
  382. (regexp))
  383. (list :tag "TODO state is" :inline t
  384. (const todo)
  385. (choice
  386. (const :tag "Any not-done state" todo)
  387. (const :tag "Any done state" done)
  388. (const :tag "Any state" any)
  389. (list :tag "Keyword list"
  390. (const :format "" quote)
  391. (repeat (string :tag "Keyword")))))
  392. (list :tag "TODO state is not" :inline t
  393. (const nottodo)
  394. (choice
  395. (const :tag "Any not-done state" todo)
  396. (const :tag "Any done state" done)
  397. (const :tag "Any state" any)
  398. (list :tag "Keyword list"
  399. (const :format "" quote)
  400. (repeat (string :tag "Keyword")))))
  401. (const :tag "scheduled" scheduled)
  402. (const :tag "not scheduled" notscheduled)
  403. (const :tag "deadline" deadline)
  404. (const :tag "no deadline" notdeadline)
  405. (const :tag "timestamp" timestamp)
  406. (const :tag "no timestamp" nottimestamp))))))
  407. (list :tag "Non-standard skipping condition"
  408. :value (org-agenda-skip-function)
  409. (const org-agenda-skip-function)
  410. (sexp :tag "Function or form (quoted!)"))
  411. (list :tag "Any variable"
  412. (variable :tag "Variable")
  413. (sexp :tag "Value (sexp)"))))
  414. "Selection of examples for agenda command settings.
  415. This will be spliced into the custom type of
  416. `org-agenda-custom-commands'.")
  417. (defcustom org-agenda-custom-commands
  418. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  419. "Custom commands for the agenda.
  420. \\<org-mode-map>
  421. These commands will be offered on the splash screen displayed by the
  422. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  423. (key desc type match settings files)
  424. key The key (one or more characters as a string) to be associated
  425. with the command.
  426. desc A description of the command. When omitted or nil, a default
  427. description is built using MATCH.
  428. type The command type, any of the following symbols:
  429. agenda The daily/weekly agenda.
  430. agenda* Appointments for current week/day.
  431. todo Entries with a specific TODO keyword, in all agenda files.
  432. search Entries containing search words entry or headline.
  433. tags Tags/Property/TODO match in all agenda files.
  434. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  435. todo-tree Sparse tree of specific TODO keyword in *current* file.
  436. tags-tree Sparse tree with all tags matches in *current* file.
  437. occur-tree Occur sparse tree for *current* file.
  438. alltodo The global TODO list.
  439. stuck Stuck projects.
  440. ... A user-defined function.
  441. match What to search for:
  442. - a single keyword for TODO keyword searches
  443. - a tags/property/todo match expression for searches
  444. - a word search expression for text searches.
  445. - a regular expression for occur searches
  446. For all other commands, this should be the empty string.
  447. settings A list of option settings, similar to that in a let form, so like
  448. this: ((opt1 val1) (opt2 val2) ...). The values will be
  449. evaluated at the moment of execution, so quote them when needed.
  450. files A list of files to write the produced agenda buffer to with
  451. the command `org-store-agenda-views'.
  452. If a file name ends in \".html\", an HTML version of the buffer
  453. is written out. If it ends in \".ps\", a PostScript version is
  454. produced. Otherwise, only the plain text is written to the file.
  455. You can also define a set of commands, to create a composite agenda buffer.
  456. In this case, an entry looks like this:
  457. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  458. where
  459. desc A description string to be displayed in the dispatcher menu.
  460. cmd An agenda command, similar to the above. However, tree commands
  461. are not allowed. Valid commands for a set are:
  462. (agenda \"\" settings)
  463. (agenda* \"\" settings)
  464. (alltodo \"\" settings)
  465. (stuck \"\" settings)
  466. (todo \"match\" settings files)
  467. (search \"match\" settings files)
  468. (tags \"match\" settings files)
  469. (tags-todo \"match\" settings files)
  470. Each command can carry a list of options, and another set of options can be
  471. given for the whole set of commands. Individual command options take
  472. precedence over the general options.
  473. When using several characters as key to a command, the first characters
  474. are prefix commands. For the dispatcher to display useful information, you
  475. should provide a description for the prefix, like
  476. (setq org-agenda-custom-commands
  477. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  478. (\"hl\" tags \"+HOME+Lisa\")
  479. (\"hp\" tags \"+HOME+Peter\")
  480. (\"hk\" tags \"+HOME+Kim\")))
  481. See also Info node `(org) Custom Agenda Views'."
  482. :group 'org-agenda-custom-commands
  483. :type `(repeat
  484. (choice :value ("x" "Describe command here" tags "" nil)
  485. (list :tag "Single command"
  486. (string :tag "Access Key(s) ")
  487. (option (string :tag "Description"))
  488. (choice
  489. (const :tag "Agenda" agenda)
  490. (const :tag "TODO list" alltodo)
  491. (const :tag "Search words" search)
  492. (const :tag "Stuck projects" stuck)
  493. (const :tag "Tags/Property match (all agenda files)" tags)
  494. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  495. (const :tag "TODO keyword search (all agenda files)" todo)
  496. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  497. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  498. (const :tag "Occur tree (current buffer)" occur-tree)
  499. (sexp :tag "Other, user-defined function"))
  500. (string :tag "Match (only for some commands)")
  501. ,org-agenda-custom-commands-local-options
  502. (option (repeat :tag "Export" (file :tag "Export to"))))
  503. (list :tag "Command series, all agenda files"
  504. (string :tag "Access Key(s)")
  505. (string :tag "Description ")
  506. (repeat :tag "Component"
  507. (choice
  508. (list :tag "Agenda"
  509. (const :format "" agenda)
  510. (const :tag "" :format "" "")
  511. ,org-agenda-custom-commands-local-options)
  512. (list :tag "TODO list (all keywords)"
  513. (const :format "" alltodo)
  514. (const :tag "" :format "" "")
  515. ,org-agenda-custom-commands-local-options)
  516. (list :tag "Search words"
  517. (const :format "" search)
  518. (string :tag "Match")
  519. ,org-agenda-custom-commands-local-options)
  520. (list :tag "Stuck projects"
  521. (const :format "" stuck)
  522. (const :tag "" :format "" "")
  523. ,org-agenda-custom-commands-local-options)
  524. (list :tag "Tags/Property match (all agenda files)"
  525. (const :format "" tags)
  526. (string :tag "Match")
  527. ,org-agenda-custom-commands-local-options)
  528. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  529. (const :format "" tags-todo)
  530. (string :tag "Match")
  531. ,org-agenda-custom-commands-local-options)
  532. (list :tag "TODO keyword search"
  533. (const :format "" todo)
  534. (string :tag "Match")
  535. ,org-agenda-custom-commands-local-options)
  536. (list :tag "Other, user-defined function"
  537. (symbol :tag "function")
  538. (string :tag "Match")
  539. ,org-agenda-custom-commands-local-options)))
  540. (repeat :tag "Settings for entire command set"
  541. (list (variable :tag "Any variable")
  542. (sexp :tag "Value")))
  543. (option (repeat :tag "Export" (file :tag "Export to"))))
  544. (cons :tag "Prefix key documentation"
  545. (string :tag "Access Key(s)")
  546. (string :tag "Description ")))))
  547. (defcustom org-agenda-query-register ?o
  548. "The register holding the current query string.
  549. The purpose of this is that if you construct a query string interactively,
  550. you can then use it to define a custom command."
  551. :group 'org-agenda-custom-commands
  552. :type 'character)
  553. (defcustom org-stuck-projects
  554. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  555. "How to identify stuck projects.
  556. This is a list of four items:
  557. 1. A tags/todo/property matcher string that is used to identify a project.
  558. See the manual for a description of tag and property searches.
  559. The entire tree below a headline matched by this is considered one project.
  560. 2. A list of TODO keywords identifying non-stuck projects.
  561. If the project subtree contains any headline with one of these todo
  562. keywords, the project is considered to be not stuck. If you specify
  563. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  564. 3. A list of tags identifying non-stuck projects.
  565. If the project subtree contains any headline with one of these tags,
  566. the project is considered to be not stuck. If you specify \"*\" as
  567. a tag, any tag will mark the project unstuck. Note that this is about
  568. the explicit presence of a tag somewhere in the subtree, inherited
  569. tags do not count here. If inherited tags make a project not stuck,
  570. use \"-TAG\" in the tags part of the matcher under (1.) above.
  571. 4. An arbitrary regular expression matching non-stuck projects.
  572. If the project turns out to be not stuck, search continues also in the
  573. subtree to see if any of the subtasks have project status.
  574. See also the variable `org-tags-match-list-sublevels' which applies
  575. to projects matched by this search as well.
  576. After defining this variable, you may use `org-agenda-list-stuck-projects'
  577. \(bound to `\\[org-agenda] #') to produce the list."
  578. :group 'org-agenda-custom-commands
  579. :type '(list
  580. (string :tag "Tags/TODO match to identify a project")
  581. (repeat :tag "Projects are *not* stuck if they have an entry with \
  582. TODO keyword any of" (string))
  583. (repeat :tag "Projects are *not* stuck if they have an entry with \
  584. TAG being any of" (string))
  585. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  586. the subtree")))
  587. (defgroup org-agenda-skip nil
  588. "Options concerning skipping parts of agenda files."
  589. :tag "Org Agenda Skip"
  590. :group 'org-agenda)
  591. (defcustom org-agenda-skip-function-global nil
  592. "Function to be called at each match during agenda construction.
  593. If this function returns nil, the current match should not be skipped.
  594. If the function decided to skip an agenda match, is must return the
  595. buffer position from which the search should be continued.
  596. This may also be a Lisp form, which will be evaluated.
  597. This variable will be applied to every agenda match, including
  598. tags/property searches and TODO lists. So try to make the test function
  599. do its checking as efficiently as possible. To implement a skipping
  600. condition just for specific agenda commands, use the variable
  601. `org-agenda-skip-function' which can be set in the options section
  602. of custom agenda commands."
  603. :group 'org-agenda-skip
  604. :type 'sexp)
  605. (defgroup org-agenda-daily/weekly nil
  606. "Options concerning the daily/weekly agenda."
  607. :tag "Org Agenda Daily/Weekly"
  608. :group 'org-agenda)
  609. (defgroup org-agenda-todo-list nil
  610. "Options concerning the global todo list agenda view."
  611. :tag "Org Agenda Todo List"
  612. :group 'org-agenda)
  613. (defgroup org-agenda-match-view nil
  614. "Options concerning the general tags/property/todo match agenda view."
  615. :tag "Org Agenda Match View"
  616. :group 'org-agenda)
  617. (defgroup org-agenda-search-view nil
  618. "Options concerning the search agenda view."
  619. :tag "Org Agenda Search View"
  620. :group 'org-agenda)
  621. (defvar org-agenda-archives-mode nil
  622. "Non-nil means the agenda will include archived items.
  623. If this is the symbol `trees', trees in the selected agenda scope
  624. that are marked with the ARCHIVE tag will be included anyway. When this is
  625. t, also all archive files associated with the current selection of agenda
  626. files will be included.")
  627. (defcustom org-agenda-restriction-lock-highlight-subtree t
  628. "Non-nil means highlight the whole subtree when restriction is active.
  629. Otherwise only highlight the headline. Highlighting the whole subtree is
  630. useful to ensure no edits happen beyond the restricted region."
  631. :group 'org-agenda
  632. :type 'boolean)
  633. (defcustom org-agenda-skip-comment-trees t
  634. "Non-nil means skip trees that start with the COMMENT keyword.
  635. When nil, these trees are also scanned by agenda commands."
  636. :group 'org-agenda-skip
  637. :type 'boolean)
  638. (defcustom org-agenda-todo-list-sublevels t
  639. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  640. When nil, the sublevels of a TODO entry are not checked, resulting in
  641. potentially much shorter TODO lists."
  642. :group 'org-agenda-skip
  643. :group 'org-agenda-todo-list
  644. :type 'boolean)
  645. (defcustom org-agenda-todo-ignore-with-date nil
  646. "Non-nil means don't show entries with a date in the global todo list.
  647. You can use this if you prefer to mark mere appointments with a TODO keyword,
  648. but don't want them to show up in the TODO list.
  649. When this is set, it also covers deadlines and scheduled items, the settings
  650. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  651. will be ignored.
  652. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  653. :group 'org-agenda-skip
  654. :group 'org-agenda-todo-list
  655. :type 'boolean)
  656. (defcustom org-agenda-todo-ignore-timestamp nil
  657. "Non-nil means don't show entries with a timestamp.
  658. This applies when creating the global todo list.
  659. Valid values are:
  660. past Don't show entries for today or in the past.
  661. future Don't show entries with a timestamp in the future.
  662. The idea behind this is that if it has a future
  663. timestamp, you don't want to think about it until the
  664. date.
  665. all Don't show any entries with a timestamp in the global todo list.
  666. The idea behind this is that by setting a timestamp, you
  667. have already \"taken care\" of this item.
  668. This variable can also have an integer as a value. If positive (N),
  669. todos with a timestamp N or more days in the future will be ignored. If
  670. negative (-N), todos with a timestamp N or more days in the past will be
  671. ignored. If 0, todos with a timestamp either today or in the future will
  672. be ignored. For example, a value of -1 will exclude todos with a
  673. timestamp in the past (yesterday or earlier), while a value of 7 will
  674. exclude todos with a timestamp a week or more in the future.
  675. See also `org-agenda-todo-ignore-with-date'.
  676. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  677. to make his option also apply to the tags-todo list."
  678. :group 'org-agenda-skip
  679. :group 'org-agenda-todo-list
  680. :version "24.1"
  681. :type '(choice
  682. (const :tag "Ignore future timestamp todos" future)
  683. (const :tag "Ignore past or present timestamp todos" past)
  684. (const :tag "Ignore all timestamp todos" all)
  685. (const :tag "Show timestamp todos" nil)
  686. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  687. (defcustom org-agenda-todo-ignore-scheduled nil
  688. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  689. This applies when creating the global todo list.
  690. Valid values are:
  691. past Don't show entries scheduled today or in the past.
  692. future Don't show entries scheduled in the future.
  693. The idea behind this is that by scheduling it, you don't want to
  694. think about it until the scheduled date.
  695. all Don't show any scheduled entries in the global todo list.
  696. The idea behind this is that by scheduling it, you have already
  697. \"taken care\" of this item.
  698. t Same as `all', for backward compatibility.
  699. This variable can also have an integer as a value. See
  700. `org-agenda-todo-ignore-timestamp' for more details.
  701. See also `org-agenda-todo-ignore-with-date'.
  702. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  703. to make his option also apply to the tags-todo list."
  704. :group 'org-agenda-skip
  705. :group 'org-agenda-todo-list
  706. :type '(choice
  707. (const :tag "Ignore future-scheduled todos" future)
  708. (const :tag "Ignore past- or present-scheduled todos" past)
  709. (const :tag "Ignore all scheduled todos" all)
  710. (const :tag "Ignore all scheduled todos (compatibility)" t)
  711. (const :tag "Show scheduled todos" nil)
  712. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  713. (defcustom org-agenda-todo-ignore-deadlines nil
  714. "Non-nil means ignore some deadline TODO items when making TODO list.
  715. There are different motivations for using different values, please think
  716. carefully when configuring this variable.
  717. This applies when creating the global TODO list.
  718. Valid values are:
  719. near Don't show near deadline entries. A deadline is near when it is
  720. closer than `org-deadline-warning-days' days. The idea behind this
  721. is that such items will appear in the agenda anyway.
  722. far Don't show TODO entries where a deadline has been defined, but
  723. is not going to happen anytime soon. This is useful if you want to use
  724. the TODO list to figure out what to do now.
  725. past Don't show entries with a deadline timestamp for today or in the past.
  726. future Don't show entries with a deadline timestamp in the future, not even
  727. when they become `near' ones. Use it with caution.
  728. all Ignore all TODO entries that do have a deadline.
  729. t Same as `near', for backward compatibility.
  730. This variable can also have an integer as a value. See
  731. `org-agenda-todo-ignore-timestamp' for more details.
  732. See also `org-agenda-todo-ignore-with-date'.
  733. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  734. to make his option also apply to the tags-todo list."
  735. :group 'org-agenda-skip
  736. :group 'org-agenda-todo-list
  737. :type '(choice
  738. (const :tag "Ignore near deadlines" near)
  739. (const :tag "Ignore near deadlines (compatibility)" t)
  740. (const :tag "Ignore far deadlines" far)
  741. (const :tag "Ignore all TODOs with a deadlines" all)
  742. (const :tag "Show all TODOs, even if they have a deadline" nil)
  743. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  744. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  745. "Time unit to use when possibly ignoring an agenda item.
  746. See the docstring of various `org-agenda-todo-ignore-*' options.
  747. The default is to compare time stamps using days. An item is thus
  748. considered to be in the future if it is at least one day after today.
  749. Non-nil means to compare time stamps using seconds. An item is then
  750. considered future if it has a time value later than current time."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-todo-list
  753. :version "24.4"
  754. :package-version '(Org . "8.0")
  755. :type '(choice
  756. (const :tag "Compare time with days" nil)
  757. (const :tag "Compare time with seconds" t)))
  758. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  759. "Non-nil means honor todo-list ignores options also in tags-todo search.
  760. The variables
  761. `org-agenda-todo-ignore-with-date',
  762. `org-agenda-todo-ignore-timestamp',
  763. `org-agenda-todo-ignore-scheduled',
  764. `org-agenda-todo-ignore-deadlines'
  765. make the global TODO list skip entries that have time stamps of certain
  766. kinds. If this option is set, the same options will also apply for the
  767. tags-todo search, which is the general tags/property matcher
  768. restricted to unfinished TODO entries only."
  769. :group 'org-agenda-skip
  770. :group 'org-agenda-todo-list
  771. :group 'org-agenda-match-view
  772. :type 'boolean)
  773. (defcustom org-agenda-skip-scheduled-if-done nil
  774. "Non-nil means don't show scheduled items in agenda when they are done.
  775. This is relevant for the daily/weekly agenda, not for the TODO list. It
  776. applies only to the actual date of the scheduling. Warnings about an item
  777. with a past scheduling dates are always turned off when the item is DONE."
  778. :group 'org-agenda-skip
  779. :group 'org-agenda-daily/weekly
  780. :type 'boolean)
  781. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  782. "Non-nil means skip scheduling line if same entry shows because of deadline.
  783. In the agenda of today, an entry can show up multiple times
  784. because it is both scheduled and has a nearby deadline, and maybe
  785. a plain time stamp as well.
  786. When this variable is nil, the entry will be shown several times.
  787. When set to t, then only the deadline is shown and the fact that
  788. the entry is scheduled today or was scheduled previously is not
  789. shown.
  790. When set to the symbol `not-today', skip scheduled previously,
  791. but not scheduled today.
  792. When set to the symbol `repeated-after-deadline', skip scheduled
  793. items if they are repeated beyond the current deadline."
  794. :group 'org-agenda-skip
  795. :group 'org-agenda-daily/weekly
  796. :type '(choice
  797. (const :tag "Never" nil)
  798. (const :tag "Always" t)
  799. (const :tag "Not when scheduled today" not-today)
  800. (const :tag "When repeated past deadline" repeated-after-deadline)))
  801. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  802. "Non-nil means skip timestamp line if same entry shows because of deadline.
  803. In the agenda of today, an entry can show up multiple times
  804. because it has both a plain timestamp and has a nearby deadline.
  805. When this variable is t, then only the deadline is shown and the
  806. fact that the entry has a timestamp for or including today is not
  807. shown. When this variable is nil, the entry will be shown
  808. several times."
  809. :group 'org-agenda-skip
  810. :group 'org-agenda-daily/weekly
  811. :version "24.1"
  812. :type '(choice
  813. (const :tag "Never" nil)
  814. (const :tag "Always" t)))
  815. (defcustom org-agenda-skip-deadline-if-done nil
  816. "Non-nil means don't show deadlines when the corresponding item is done.
  817. When nil, the deadline is still shown and should give you a happy feeling.
  818. This is relevant for the daily/weekly agenda. It applies only to the
  819. actual date of the deadline. Warnings about approaching and past-due
  820. deadlines are always turned off when the item is DONE."
  821. :group 'org-agenda-skip
  822. :group 'org-agenda-daily/weekly
  823. :type 'boolean)
  824. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  825. "Non-nil means skip deadline prewarning when entry is also scheduled.
  826. This will apply on all days where a prewarning for the deadline would
  827. be shown, but not at the day when the entry is actually due. On that day,
  828. the deadline will be shown anyway.
  829. This variable may be set to nil, t, the symbol `pre-scheduled',
  830. or a number which will then give the number of days before the actual
  831. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  832. eliminates the deadline prewarning only prior to the scheduled date.
  833. This can be used in a workflow where the first showing of the deadline will
  834. trigger you to schedule it, and then you don't want to be reminded of it
  835. because you will take care of it on the day when scheduled."
  836. :group 'org-agenda-skip
  837. :group 'org-agenda-daily/weekly
  838. :version "24.1"
  839. :type '(choice
  840. (const :tag "Always show prewarning" nil)
  841. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  842. (const :tag "Remove prewarning if entry is scheduled" t)
  843. (integer :tag "Restart prewarning N days before deadline")))
  844. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  845. "Non-nil means skip scheduled delay when entry also has a deadline.
  846. This variable may be set to nil, t, the symbol `post-deadline',
  847. or a number which will then give the number of days after the actual
  848. scheduled date when the delay should expire. The symbol `post-deadline'
  849. eliminates the schedule delay when the date is posterior to the deadline."
  850. :group 'org-agenda-skip
  851. :group 'org-agenda-daily/weekly
  852. :version "24.4"
  853. :package-version '(Org . "8.0")
  854. :type '(choice
  855. (const :tag "Always honor delay" nil)
  856. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  857. (const :tag "Ignore delay if entry has a deadline" t)
  858. (integer :tag "Honor delay up until N days after the scheduled date")))
  859. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  860. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  861. When non-nil, after the search for timestamps has matched once in an
  862. entry, the rest of the entry will not be searched."
  863. :group 'org-agenda-skip
  864. :type 'boolean)
  865. (defcustom org-agenda-skip-timestamp-if-done nil
  866. "Non-nil means don't select item by timestamp or -range if it is DONE."
  867. :group 'org-agenda-skip
  868. :group 'org-agenda-daily/weekly
  869. :type 'boolean)
  870. (defcustom org-agenda-dim-blocked-tasks t
  871. "Non-nil means dim blocked tasks in the agenda display.
  872. This causes some overhead during agenda construction, but if you
  873. have turned on `org-enforce-todo-dependencies',
  874. `org-enforce-todo-checkbox-dependencies', or any other blocking
  875. mechanism, this will create useful feedback in the agenda.
  876. Instead of t, this variable can also have the value `invisible'.
  877. Then blocked tasks will be invisible and only become visible when
  878. they become unblocked. An exemption to this behavior is when a task is
  879. blocked because of unchecked checkboxes below it. Since checkboxes do
  880. not show up in the agenda views, making this task invisible you remove any
  881. trace from agenda views that there is something to do. Therefore, a task
  882. that is blocked because of checkboxes will never be made invisible, it
  883. will only be dimmed."
  884. :group 'org-agenda-daily/weekly
  885. :group 'org-agenda-todo-list
  886. :version "24.3"
  887. :type '(choice
  888. (const :tag "Do not dim" nil)
  889. (const :tag "Dim to a gray face" t)
  890. (const :tag "Make invisible" invisible)))
  891. (defgroup org-agenda-startup nil
  892. "Options concerning initial settings in the Agenda in Org Mode."
  893. :tag "Org Agenda Startup"
  894. :group 'org-agenda)
  895. (defcustom org-agenda-menu-show-matcher t
  896. "Non-nil means show the match string in the agenda dispatcher menu.
  897. When nil, the matcher string is not shown, but is put into the help-echo
  898. property so than moving the mouse over the command shows it.
  899. Setting it to nil is good if matcher strings are very long and/or if
  900. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  901. :group 'org-agenda
  902. :version "24.1"
  903. :type 'boolean)
  904. (defcustom org-agenda-menu-two-columns nil
  905. "Non-nil means, use two columns to show custom commands in the dispatcher.
  906. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  907. to nil."
  908. :group 'org-agenda
  909. :version "24.1"
  910. :type 'boolean)
  911. (defcustom org-agenda-finalize-hook nil
  912. "Hook run just before displaying an agenda buffer.
  913. The buffer is still writable when the hook is called.
  914. You can modify some of the buffer substrings but you should be
  915. extra careful not to modify the text properties of the agenda
  916. headlines as the agenda display heavily relies on them."
  917. :group 'org-agenda-startup
  918. :type 'hook)
  919. (defcustom org-agenda-filter-hook nil
  920. "Hook run just after filtering with `org-agenda-filter'."
  921. :group 'org-agenda-startup
  922. :package-version '(Org . "9.4")
  923. :type 'hook)
  924. (defcustom org-agenda-mouse-1-follows-link nil
  925. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  926. A longer mouse click will still set point. Needs to be set
  927. before org.el is loaded."
  928. :group 'org-agenda-startup
  929. :type 'boolean)
  930. (defcustom org-agenda-start-with-follow-mode nil
  931. "The initial value of follow mode in a newly created agenda window."
  932. :group 'org-agenda-startup
  933. :type 'boolean)
  934. (defcustom org-agenda-follow-indirect nil
  935. "Non-nil means `org-agenda-follow-mode' displays only the
  936. current item's tree, in an indirect buffer."
  937. :group 'org-agenda
  938. :version "24.1"
  939. :type 'boolean)
  940. (defcustom org-agenda-show-outline-path t
  941. "Non-nil means show outline path in echo area after line motion."
  942. :group 'org-agenda-startup
  943. :type 'boolean)
  944. (defcustom org-agenda-start-with-entry-text-mode nil
  945. "The initial value of entry-text-mode in a newly created agenda window."
  946. :group 'org-agenda-startup
  947. :type 'boolean)
  948. (defcustom org-agenda-entry-text-maxlines 5
  949. "Number of text lines to be added when `E' is pressed in the agenda.
  950. Note that this variable only used during agenda display. To add entry text
  951. when exporting the agenda, configure the variable
  952. `org-agenda-add-entry-text-maxlines'."
  953. :group 'org-agenda
  954. :type 'integer)
  955. (defcustom org-agenda-entry-text-exclude-regexps nil
  956. "List of regular expressions to clean up entry text.
  957. The complete matches of all regular expressions in this list will be
  958. removed from entry text before it is shown in the agenda."
  959. :group 'org-agenda
  960. :type '(repeat (regexp)))
  961. (defcustom org-agenda-entry-text-leaders " > "
  962. "Text prepended to the entry text in agenda buffers."
  963. :version "24.4"
  964. :package-version '(Org . "8.0")
  965. :group 'org-agenda
  966. :type 'string)
  967. (defvar org-agenda-entry-text-cleanup-hook nil
  968. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  969. This cleanup is done in a temporary buffer, so the function may inspect and
  970. change the entire buffer.
  971. Some default stuff like drawers and scheduling/deadline dates will already
  972. have been removed when this is called, as will any matches for regular
  973. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  974. (defvar org-agenda-include-inactive-timestamps nil
  975. "Non-nil means include inactive time stamps in agenda.
  976. Dynamically scoped.")
  977. (defgroup org-agenda-windows nil
  978. "Options concerning the windows used by the Agenda in Org Mode."
  979. :tag "Org Agenda Windows"
  980. :group 'org-agenda)
  981. (defcustom org-agenda-window-setup 'reorganize-frame
  982. "How the agenda buffer should be displayed.
  983. Possible values for this option are:
  984. current-window Show agenda in the current window, keeping all other windows.
  985. other-window Use `switch-to-buffer-other-window' to display agenda.
  986. only-window Show agenda, deleting all other windows.
  987. reorganize-frame Show only two windows on the current frame, the current
  988. window and the agenda.
  989. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  990. Also, when exiting the agenda, kill that frame.
  991. other-tab Use `switch-to-buffer-other-tab' to display the
  992. agenda, making use of the `tab-bar-mode' introduced
  993. in Emacs version 27.1. Also, kill that tab when
  994. exiting the agenda view.
  995. See also the variable `org-agenda-restore-windows-after-quit'."
  996. :group 'org-agenda-windows
  997. :type '(choice
  998. (const current-window)
  999. (const other-frame)
  1000. (const other-tab)
  1001. (const other-window)
  1002. (const only-window)
  1003. (const reorganize-frame))
  1004. :package-version '(Org . "9.4"))
  1005. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  1006. "The min and max height of the agenda window as a fraction of frame height.
  1007. The value of the variable is a cons cell with two numbers between 0 and 1.
  1008. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  1009. :group 'org-agenda-windows
  1010. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  1011. (defcustom org-agenda-restore-windows-after-quit nil
  1012. "Non-nil means restore window configuration upon exiting agenda.
  1013. Before the window configuration is changed for displaying the
  1014. agenda, the current status is recorded. When the agenda is
  1015. exited with `q' or `x' and this option is set, the old state is
  1016. restored. If `org-agenda-window-setup' is `other-frame' or
  1017. `other-tab', the value of this option will be ignored."
  1018. :group 'org-agenda-windows
  1019. :type 'boolean)
  1020. (defcustom org-agenda-span 'week
  1021. "Number of days to include in overview display.
  1022. Can be day, week, month, year, or any number of days.
  1023. Custom commands can set this variable in the options section."
  1024. :group 'org-agenda-daily/weekly
  1025. :type '(choice (const :tag "Day" day)
  1026. (const :tag "Week" week)
  1027. (const :tag "Fortnight" fortnight)
  1028. (const :tag "Month" month)
  1029. (const :tag "Year" year)
  1030. (integer :tag "Custom")))
  1031. (defcustom org-agenda-start-on-weekday 1
  1032. "Non-nil means start the overview always on the specified weekday.
  1033. 0 denotes Sunday, 1 denotes Monday, etc.
  1034. When nil, always start on the current day.
  1035. Custom commands can set this variable in the options section."
  1036. :group 'org-agenda-daily/weekly
  1037. :type '(choice (const :tag "Today" nil)
  1038. (integer :tag "Weekday No.")))
  1039. (defcustom org-agenda-show-all-dates t
  1040. "Non-nil means `org-agenda' shows every day in the selected range.
  1041. When nil, only the days which actually have entries are shown."
  1042. :group 'org-agenda-daily/weekly
  1043. :type 'boolean)
  1044. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1045. "Format string for displaying dates in the agenda.
  1046. Used by the daily/weekly agenda. This should be a format string
  1047. understood by `format-time-string', or a function returning the
  1048. formatted date as a string. The function must take a single
  1049. argument, a calendar-style date list like (month day year)."
  1050. :group 'org-agenda-daily/weekly
  1051. :type '(choice
  1052. (string :tag "Format string")
  1053. (function :tag "Function")))
  1054. (defun org-agenda-end-of-line ()
  1055. "Go to the end of visible line."
  1056. (interactive)
  1057. (goto-char (line-end-position)))
  1058. (defun org-agenda-format-date-aligned (date)
  1059. "Format a DATE string for display in the daily/weekly agenda.
  1060. This function makes sure that dates are aligned for easy reading."
  1061. (require 'cal-iso)
  1062. (let* ((dayname (calendar-day-name date))
  1063. (day (cadr date))
  1064. (day-of-week (calendar-day-of-week date))
  1065. (month (car date))
  1066. (monthname (calendar-month-name month))
  1067. (year (nth 2 date))
  1068. (iso-week (org-days-to-iso-week
  1069. (calendar-absolute-from-gregorian date)))
  1070. ;; (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1071. ;; (1- year))
  1072. ;; ((and (= month 12) (<= iso-week 1))
  1073. ;; (1+ year))
  1074. ;; (t year)))
  1075. (weekstring (if (= day-of-week 1)
  1076. (format " W%02d" iso-week)
  1077. "")))
  1078. (format "%-10s %2d %s %4d%s"
  1079. dayname day monthname year weekstring)))
  1080. (defcustom org-agenda-time-leading-zero nil
  1081. "Non-nil means use leading zero for military times in agenda.
  1082. For example, 9:30am would become 09:30 rather than 9:30."
  1083. :group 'org-agenda-daily/weekly
  1084. :version "24.1"
  1085. :type 'boolean)
  1086. (defcustom org-agenda-timegrid-use-ampm nil
  1087. "When set, show AM/PM style timestamps on the timegrid."
  1088. :group 'org-agenda
  1089. :version "24.1"
  1090. :type 'boolean)
  1091. (defcustom org-agenda-clock-report-header nil
  1092. "Header inserted before the table in Org agenda clock report mode.
  1093. See Info node `(org) Agenda Commands' for more details."
  1094. :group 'org-agenda
  1095. :type '(choice
  1096. (string :tag "Header")
  1097. (const :tag "No header" nil))
  1098. :safe #'stringp
  1099. :package-version '(Org . "9.6"))
  1100. (defun org-agenda-time-of-day-to-ampm (time)
  1101. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1102. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1103. (minute (substring time -2))
  1104. (ampm "am"))
  1105. (cond
  1106. ((equal hour-number 12)
  1107. (setq ampm "pm"))
  1108. ((> hour-number 12)
  1109. (setq ampm "pm")
  1110. (setq hour-number (- hour-number 12))))
  1111. (concat
  1112. (if org-agenda-time-leading-zero
  1113. (format "%02d" hour-number)
  1114. (format "%02s" (number-to-string hour-number)))
  1115. ":" minute ampm)))
  1116. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1117. "Conditionally convert TIME to AM/PM format.
  1118. This is based on `org-agenda-timegrid-use-ampm'."
  1119. (if org-agenda-timegrid-use-ampm
  1120. (org-agenda-time-of-day-to-ampm time)
  1121. time))
  1122. (defcustom org-agenda-weekend-days '(6 0)
  1123. "Which days are weekend?
  1124. These days get the special face `org-agenda-date-weekend' in the agenda."
  1125. :group 'org-agenda-daily/weekly
  1126. :type '(set :greedy t
  1127. (const :tag "Monday" 1)
  1128. (const :tag "Tuesday" 2)
  1129. (const :tag "Wednesday" 3)
  1130. (const :tag "Thursday" 4)
  1131. (const :tag "Friday" 5)
  1132. (const :tag "Saturday" 6)
  1133. (const :tag "Sunday" 0)))
  1134. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1135. "Non-nil means jump to today when moving a past date forward in time.
  1136. When using S-right in the agenda to move a date forward, and the date
  1137. stamp currently points to the past, the first key press will move it
  1138. to today. When nil, just move one day forward even if the date stays
  1139. in the past."
  1140. :group 'org-agenda-daily/weekly
  1141. :version "24.1"
  1142. :type 'boolean)
  1143. (defcustom org-agenda-diary-file 'diary-file
  1144. "File to which to add new entries with the `i' key in agenda and calendar.
  1145. When this is the symbol `diary-file', the functionality in the Emacs
  1146. calendar will be used to add entries to the `diary-file'. But when this
  1147. points to a file, `org-agenda-diary-entry' will be used instead."
  1148. :group 'org-agenda
  1149. :type '(choice
  1150. (const :tag "The standard Emacs diary file" diary-file)
  1151. (file :tag "Special Org file diary entries")))
  1152. (defcustom org-agenda-include-diary nil
  1153. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1154. Custom commands can set this variable in the options section."
  1155. :group 'org-agenda-daily/weekly
  1156. :type 'boolean)
  1157. (defcustom org-agenda-include-deadlines t
  1158. "If non-nil, include entries within their deadline warning period.
  1159. Custom commands can set this variable in the options section."
  1160. :group 'org-agenda-daily/weekly
  1161. :version "24.1"
  1162. :type 'boolean)
  1163. (defcustom org-agenda-show-future-repeats t
  1164. "Non-nil shows repeated entries in the future part of the agenda.
  1165. When set to the symbol `next' only the first future repeat is shown."
  1166. :group 'org-agenda-daily/weekly
  1167. :type '(choice
  1168. (const :tag "Show all repeated entries" t)
  1169. (const :tag "Show next repeated entry" next)
  1170. (const :tag "Do not show repeated entries" nil))
  1171. :version "26.1"
  1172. :package-version '(Org . "9.1")
  1173. :safe #'symbolp)
  1174. (defcustom org-agenda-prefer-last-repeat nil
  1175. "Non-nil sets date for repeated entries to their last repeat.
  1176. When nil, display SCHEDULED and DEADLINE dates at their base
  1177. date, and in today's agenda, as a reminder. Display plain
  1178. time-stamps, on the other hand, at every repeat date in the past
  1179. in addition to the base date.
  1180. When non-nil, show a repeated entry at its latest repeat date,
  1181. possibly being today even if it wasn't marked as done. This
  1182. setting is useful if you do not always mark repeated entries as
  1183. done and, yet, consider that reaching repeat date starts the task
  1184. anew.
  1185. When set to a list of strings, prefer last repeats only for
  1186. entries with these TODO keywords."
  1187. :group 'org-agenda-daily/weekly
  1188. :type '(choice
  1189. (const :tag "Prefer last repeat" t)
  1190. (const :tag "Prefer base date" nil)
  1191. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1192. (string :tag "TODO keyword")))
  1193. :version "26.1"
  1194. :package-version '(Org . "9.1")
  1195. :safe (lambda (x) (or (booleanp x) (consp x))))
  1196. (defcustom org-scheduled-past-days 10000
  1197. "Number of days to continue listing scheduled items not marked DONE.
  1198. When an item is scheduled on a date, it shows up in the agenda on
  1199. this day and will be listed until it is marked done or for the
  1200. number of days given here."
  1201. :group 'org-agenda-daily/weekly
  1202. :type 'integer
  1203. :safe 'integerp)
  1204. (defcustom org-deadline-past-days 10000
  1205. "Number of days to warn about missed deadlines.
  1206. When an item has deadline on a date, it shows up in the agenda on
  1207. this day and will appear as a reminder until it is marked DONE or
  1208. for the number of days given here."
  1209. :group 'org-agenda-daily/weekly
  1210. :type 'integer
  1211. :version "26.1"
  1212. :package-version '(Org . "9.1")
  1213. :safe 'integerp)
  1214. (defcustom org-agenda-log-mode-items '(closed clock)
  1215. "List of items that should be shown in agenda log mode.
  1216. \\<org-agenda-mode-map>\
  1217. This list may contain the following symbols:
  1218. closed Show entries that have been closed on that day.
  1219. clock Show entries that have received clocked time on that day.
  1220. state Show all logged state changes.
  1221. Note that instead of changing this variable, you can also press \
  1222. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1223. the agenda to display all available LOG items temporarily."
  1224. :group 'org-agenda-daily/weekly
  1225. :type '(set :greedy t (const closed) (const clock) (const state)))
  1226. (defcustom org-agenda-clock-consistency-checks
  1227. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1228. :gap-ok-around ("4:00")
  1229. :default-face ((:background "DarkRed") (:foreground "white"))
  1230. :overlap-face nil :gap-face nil :no-end-time-face nil
  1231. :long-face nil :short-face nil)
  1232. "This is a property list, with the following keys:
  1233. :max-duration Mark clocking chunks that are longer than this time.
  1234. This is a time string like \"HH:MM\", or the number
  1235. of minutes as an integer.
  1236. :min-duration Mark clocking chunks that are shorter that this.
  1237. This is a time string like \"HH:MM\", or the number
  1238. of minutes as an integer.
  1239. :max-gap Mark gaps between clocking chunks that are longer than
  1240. this duration. A number of minutes, or a string
  1241. like \"HH:MM\".
  1242. :gap-ok-around List of times during the day which are usually not working
  1243. times. When a gap is detected, but the gap contains any
  1244. of these times, the gap is *not* reported. For example,
  1245. if this is (\"4:00\" \"13:00\") then gaps that contain
  1246. 4:00 in the morning (i.e. the night) and 13:00
  1247. (i.e. a typical lunch time) do not cause a warning.
  1248. You should have at least one time during the night in this
  1249. list, or otherwise the first task each morning will trigger
  1250. a warning because it follows a long gap.
  1251. Furthermore, the following properties can be used to define faces for
  1252. issue display.
  1253. :default-face the default face, if the specific face is undefined
  1254. :overlap-face face for overlapping clocks
  1255. :gap-face face for gaps between clocks
  1256. :no-end-time-face face for incomplete clocks
  1257. :long-face face for clock intervals that are too long
  1258. :short-face face for clock intervals that are too short"
  1259. :group 'org-agenda-daily/weekly
  1260. :group 'org-clock
  1261. :version "24.1"
  1262. :type 'plist)
  1263. (defcustom org-agenda-log-mode-add-notes t
  1264. "Non-nil means add first line of notes to log entries in agenda views.
  1265. If a log item like a state change or a clock entry is associated with
  1266. notes, the first line of these notes will be added to the entry in the
  1267. agenda display."
  1268. :group 'org-agenda-daily/weekly
  1269. :type 'boolean)
  1270. (defcustom org-agenda-start-with-log-mode nil
  1271. "The initial value of log-mode in a newly created agenda window.
  1272. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1273. explanations on the possible values."
  1274. :group 'org-agenda-startup
  1275. :group 'org-agenda-daily/weekly
  1276. :type '(choice (const :tag "Don't show log items" nil)
  1277. (const :tag "Show only log items" only)
  1278. (const :tag "Show all possible log items" clockcheck)
  1279. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1280. (choice (const :tag "Show closed log items" closed)
  1281. (const :tag "Show clocked log items" clock)
  1282. (const :tag "Show all logged state changes" state)))))
  1283. (defcustom org-agenda-start-with-clockreport-mode nil
  1284. "The initial value of clockreport-mode in a newly created agenda window."
  1285. :group 'org-agenda-startup
  1286. :group 'org-agenda-daily/weekly
  1287. :type 'boolean)
  1288. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1289. "Property list with parameters for the clocktable in clockreport mode.
  1290. This is the display mode that shows a clock table in the daily/weekly
  1291. agenda, the properties for this dynamic block can be set here.
  1292. The usual clocktable parameters are allowed here, but you cannot set
  1293. the properties :name, :tstart, :tend, :block, and :scope - these will
  1294. be overwritten to make sure the content accurately reflects the
  1295. current display in the agenda."
  1296. :group 'org-agenda-daily/weekly
  1297. :type 'plist)
  1298. (defvaralias 'org-agenda-search-view-search-words-only
  1299. 'org-agenda-search-view-always-boolean)
  1300. (defcustom org-agenda-search-view-always-boolean nil
  1301. "Non-nil means the search string is interpreted as individual parts.
  1302. The search string for search view can either be interpreted as a phrase,
  1303. or as a list of snippets that define a boolean search for a number of
  1304. strings.
  1305. When this is non-nil, the string will be split on whitespace, and each
  1306. snippet will be searched individually, and all must match in order to
  1307. select an entry. A snippet is then a single string of non-white
  1308. characters, or a string in double quotes, or a regexp in {} braces.
  1309. If a snippet is preceded by \"-\", the snippet must *not* match.
  1310. \"+\" is syntactic sugar for positive selection. Each snippet may
  1311. be found as a full word or a partial word, but see the variable
  1312. `org-agenda-search-view-force-full-words'.
  1313. When this is nil, search will look for the entire search phrase as one,
  1314. with each space character matching any amount of whitespace, including
  1315. line breaks.
  1316. Even when this is nil, you can still switch to Boolean search dynamically
  1317. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1318. is a regexp marked with braces like \"{abc}\", this will also switch to
  1319. boolean search."
  1320. :group 'org-agenda-search-view
  1321. :version "24.1"
  1322. :type 'boolean)
  1323. (defcustom org-agenda-search-view-force-full-words nil
  1324. "Non-nil means, search words must be matches as complete words.
  1325. When nil, they may also match part of a word."
  1326. :group 'org-agenda-search-view
  1327. :version "24.1"
  1328. :type 'boolean)
  1329. (defcustom org-agenda-search-view-max-outline-level 0
  1330. "Maximum outline level to display in search view.
  1331. E.g. when this is set to 1, the search view will only
  1332. show headlines of level 1. When set to 0, the default
  1333. value, don't limit agenda view by outline level."
  1334. :group 'org-agenda-search-view
  1335. :version "26.1"
  1336. :package-version '(Org . "8.3")
  1337. :type 'integer)
  1338. (defgroup org-agenda-time-grid nil
  1339. "Options concerning the time grid in the Org Agenda."
  1340. :tag "Org Agenda Time Grid"
  1341. :group 'org-agenda)
  1342. (defcustom org-agenda-search-headline-for-time t
  1343. "Non-nil means search headline for a time-of-day.
  1344. If the headline contains a time-of-day in one format or another, it will
  1345. be used to sort the entry into the time sequence of items for a day.
  1346. Some people have time stamps in the headline that refer to the creation
  1347. time or so, and then this produces an unwanted side effect. If this is
  1348. the case for your, use this variable to turn off searching the headline
  1349. for a time."
  1350. :group 'org-agenda-time-grid
  1351. :type 'boolean)
  1352. (defcustom org-agenda-use-time-grid t
  1353. "Non-nil means show a time grid in the agenda schedule.
  1354. A time grid is a set of lines for specific times (like every two hours between
  1355. 8:00 and 20:00). The items scheduled for a day at specific times are
  1356. sorted in between these lines.
  1357. For details about when the grid will be shown, and what it will look like, see
  1358. the variable `org-agenda-time-grid'."
  1359. :group 'org-agenda-time-grid
  1360. :type 'boolean)
  1361. (defcustom org-agenda-time-grid
  1362. (let ((graphical (and (display-graphic-p)
  1363. (char-displayable-p ?┄))))
  1364. `((daily today require-timed)
  1365. (800 1000 1200 1400 1600 1800 2000)
  1366. ,(if graphical " ┄┄┄┄┄ " "......")
  1367. ,(if graphical "┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄" "----------------")))
  1368. "The settings for time grid for agenda display.
  1369. This is a list of four items. The first item is again a list. It contains
  1370. symbols specifying conditions when the grid should be displayed:
  1371. daily if the agenda shows a single day
  1372. weekly if the agenda shows an entire week
  1373. today show grid on current date, independent of daily/weekly display
  1374. require-timed show grid only if at least one item has a time specification
  1375. remove-match skip grid times already present in an entry
  1376. The second item is a list of integers, indicating the times that
  1377. should have a grid line.
  1378. The third item is a string which will be placed right after the
  1379. times that have a grid line.
  1380. The fourth item is a string placed after the grid times. This
  1381. will align with agenda items."
  1382. :group 'org-agenda-time-grid
  1383. :version "29.1"
  1384. :type
  1385. '(list
  1386. (set :greedy t :tag "Grid Display Options"
  1387. (const :tag "Show grid in single day agenda display" daily)
  1388. (const :tag "Show grid in weekly agenda display" weekly)
  1389. (const :tag "Always show grid for today" today)
  1390. (const :tag "Show grid only if any timed entries are present"
  1391. require-timed)
  1392. (const :tag "Skip grid times already present in an entry"
  1393. remove-match))
  1394. (repeat :tag "Grid Times" (integer :tag "Time"))
  1395. (string :tag "Grid String (after agenda times)")
  1396. (string :tag "Grid String (aligns with agenda items)")))
  1397. (defcustom org-agenda-show-current-time-in-grid t
  1398. "Non-nil means show the current time in the time grid."
  1399. :group 'org-agenda-time-grid
  1400. :version "24.1"
  1401. :type 'boolean)
  1402. (defcustom org-agenda-current-time-string
  1403. (if (and (display-graphic-p)
  1404. (char-displayable-p ?←)
  1405. (char-displayable-p ?─))
  1406. "← now ───────────────────────────────────────────────"
  1407. "now - - - - - - - - - - - - - - - - - - - - - - - - -")
  1408. "The string for the current time marker in the agenda."
  1409. :group 'org-agenda-time-grid
  1410. :version "29.1"
  1411. :type 'string)
  1412. (defgroup org-agenda-sorting nil
  1413. "Options concerning sorting in the Org Agenda."
  1414. :tag "Org Agenda Sorting"
  1415. :group 'org-agenda)
  1416. (defcustom org-agenda-sorting-strategy
  1417. '((agenda habit-down time-up priority-down category-keep)
  1418. (todo priority-down category-keep)
  1419. (tags priority-down category-keep)
  1420. (search category-keep))
  1421. "Sorting structure for the agenda items of a single day.
  1422. This is a list of symbols which will be used in sequence to determine
  1423. if an entry should be listed before another entry. The following
  1424. symbols are recognized:
  1425. time-up Put entries with time-of-day indications first, early first.
  1426. time-down Put entries with time-of-day indications first, late first.
  1427. timestamp-up Sort by any timestamp, early first.
  1428. timestamp-down Sort by any timestamp, late first.
  1429. scheduled-up Sort by scheduled timestamp, early first.
  1430. scheduled-down Sort by scheduled timestamp, late first.
  1431. deadline-up Sort by deadline timestamp, early first.
  1432. deadline-down Sort by deadline timestamp, late first.
  1433. ts-up Sort by active timestamp, early first.
  1434. ts-down Sort by active timestamp, late first.
  1435. tsia-up Sort by inactive timestamp, early first.
  1436. tsia-down Sort by inactive timestamp, late first.
  1437. category-keep Keep the default order of categories, corresponding to the
  1438. sequence in `org-agenda-files'.
  1439. category-up Sort alphabetically by category, A-Z.
  1440. category-down Sort alphabetically by category, Z-A.
  1441. tag-up Sort alphabetically by last tag, A-Z.
  1442. tag-down Sort alphabetically by last tag, Z-A.
  1443. priority-up Sort numerically by priority, high priority last.
  1444. priority-down Sort numerically by priority, high priority first.
  1445. todo-state-up Sort by todo state, tasks that are done last.
  1446. todo-state-down Sort by todo state, tasks that are done first.
  1447. effort-up Sort numerically by estimated effort, high effort last.
  1448. effort-down Sort numerically by estimated effort, high effort first.
  1449. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1450. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1451. habit-up Put entries that are habits first.
  1452. habit-down Put entries that are habits last.
  1453. alpha-up Sort headlines alphabetically.
  1454. alpha-down Sort headlines alphabetically, reversed.
  1455. The different possibilities will be tried in sequence, and testing stops
  1456. if one comparison returns a \"not-equal\". For example,
  1457. (setq org-agenda-sorting-strategy
  1458. \\='(time-up category-keep priority-down))
  1459. means: Pull out all entries having a specified time of day and sort them,
  1460. in order to make a time schedule for the current day the first thing in the
  1461. agenda listing for the day. Of the entries without a time indication, keep
  1462. the grouped in categories, don't sort the categories, but keep them in
  1463. the sequence given in `org-agenda-files'. Within each category sort by
  1464. priority.
  1465. Leaving out `category-keep' would mean that items will be sorted across
  1466. categories by priority.
  1467. Instead of a single list, this can also be a set of list for specific
  1468. contents, with a context symbol in the car of the list, any of
  1469. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1470. Custom commands can bind this variable in the options section."
  1471. :group 'org-agenda-sorting
  1472. :type `(choice
  1473. (repeat :tag "General" ,org-sorting-choice)
  1474. (list :tag "Individually"
  1475. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1476. (repeat ,org-sorting-choice))
  1477. (cons (const :tag "Strategy for TODO lists" todo)
  1478. (repeat ,org-sorting-choice))
  1479. (cons (const :tag "Strategy for Tags matches" tags)
  1480. (repeat ,org-sorting-choice))
  1481. (cons (const :tag "Strategy for search matches" search)
  1482. (repeat ,org-sorting-choice)))))
  1483. (defcustom org-agenda-cmp-user-defined nil
  1484. "A function to define the comparison `user-defined'.
  1485. This function must receive two arguments, agenda entry a and b.
  1486. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1487. the user comparison, return nil.
  1488. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1489. part of an agenda sorting strategy."
  1490. :group 'org-agenda-sorting
  1491. :type 'symbol)
  1492. (defcustom org-agenda-sort-notime-is-late t
  1493. "Non-nil means items without time are considered late.
  1494. This is only relevant for sorting. When t, items which have no explicit
  1495. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1496. do have a time. When nil, the default time is before 0:00. You can use this
  1497. option to decide if the schedule for today should come before or after timeless
  1498. agenda entries."
  1499. :group 'org-agenda-sorting
  1500. :type 'boolean)
  1501. (defcustom org-agenda-sort-noeffort-is-high t
  1502. "Non-nil means items without effort estimate are sorted as high effort.
  1503. This also applies when filtering an agenda view with respect to the
  1504. < or > effort operator. Then, tasks with no effort defined will be treated
  1505. as tasks with high effort.
  1506. When nil, such items are sorted as 0 minutes effort."
  1507. :group 'org-agenda-sorting
  1508. :type 'boolean)
  1509. (defgroup org-agenda-line-format nil
  1510. "Options concerning the entry prefix in the Org agenda display."
  1511. :tag "Org Agenda Line Format"
  1512. :group 'org-agenda)
  1513. (defcustom org-agenda-prefix-format
  1514. '((agenda . " %i %-12:c%?-12t% s")
  1515. (todo . " %i %-12:c")
  1516. (tags . " %i %-12:c")
  1517. (search . " %i %-12:c"))
  1518. "Format specifications for the prefix of items in the agenda views.
  1519. An alist with one entry per agenda type. The keys of the
  1520. sublists are `agenda', `todo', `search' and `tags'. The values
  1521. are format strings.
  1522. This format works similar to a printf format, with the following meaning:
  1523. %c the category of the item, \"Diary\" for entries from the diary,
  1524. or as given by the CATEGORY keyword or derived from the file name
  1525. %e the effort required by the item
  1526. %l the level of the item (insert X space(s) if item is of level X)
  1527. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1528. %T the last tag of the item (ignore inherited tags, which come first)
  1529. %t the HH:MM time-of-day specification if one applies to the entry
  1530. %s Scheduling/Deadline information, a short string
  1531. %b show breadcrumbs, i.e., the names of the higher levels
  1532. %(expression) Eval EXPRESSION and replace the control string
  1533. by the result
  1534. All specifiers work basically like the standard `%s' of printf, but may
  1535. contain two additional characters: a question mark just after the `%'
  1536. and a whitespace/punctuation character just before the final letter.
  1537. If the first character after `%' is a question mark, the entire field
  1538. will only be included if the corresponding value applies to the current
  1539. entry. This is useful for fields which should have fixed width when
  1540. present, but zero width when absent. For example, \"%?-12t\" will
  1541. result in a 12 character time field if a time of the day is specified,
  1542. but will completely disappear in entries which do not contain a time.
  1543. If there is punctuation or whitespace character just before the
  1544. final format letter, this character will be appended to the field
  1545. value if the value is not empty. For example, the format
  1546. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1547. the category is empty, no additional colon is inserted.
  1548. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1549. which means:
  1550. - Indent the line with two space characters
  1551. - Give the category a 12 chars wide field, padded with whitespace on
  1552. the right (because of `-'). Append a colon if there is a category
  1553. (because of `:').
  1554. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1555. time, don't put in an empty field, just skip it (because of '?').
  1556. - Finally, put the scheduling information.
  1557. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1558. `org-agenda-remove-tags'.
  1559. Custom commands can set this variable in the options section."
  1560. :type '(choice
  1561. (string :tag "General format")
  1562. (list :greedy t :tag "View dependent"
  1563. (cons (const agenda) (string :tag "Format"))
  1564. (cons (const todo) (string :tag "Format"))
  1565. (cons (const tags) (string :tag "Format"))
  1566. (cons (const search) (string :tag "Format"))))
  1567. :group 'org-agenda-line-format
  1568. :version "26.1"
  1569. :package-version '(Org . "9.1"))
  1570. (defcustom org-agenda-breadcrumbs-separator "->"
  1571. "The separator of breadcrumbs in agenda lines."
  1572. :group 'org-agenda-line-format
  1573. :package-version '(Org . "9.3")
  1574. :type 'string
  1575. :safe #'stringp)
  1576. (defvar org-prefix-format-compiled nil
  1577. "The compiled prefix format and associated variables.
  1578. This is a list where first element is a list of variable bindings, and second
  1579. element is the compiled format expression. See the variable
  1580. `org-agenda-prefix-format'.")
  1581. (defcustom org-agenda-todo-keyword-format "%-1s"
  1582. "Format for the TODO keyword in agenda lines.
  1583. Set this to something like \"%-12s\" if you want all TODO keywords
  1584. to occupy a fixed space in the agenda display."
  1585. :group 'org-agenda-line-format
  1586. :type 'string)
  1587. (defcustom org-agenda-diary-sexp-prefix nil
  1588. "A regexp that matches part of a diary sexp entry
  1589. which should be treated as scheduling/deadline information in
  1590. `org-agenda'.
  1591. For example, you can use this to extract the `diary-remind-message' from
  1592. `diary-remind' entries."
  1593. :group 'org-agenda-line-format
  1594. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1595. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1596. "Text preceding timerange entries in the agenda view.
  1597. This is a list with two strings. The first applies when the range
  1598. is entirely on one day. The second applies if the range spans several days.
  1599. The strings may have two \"%d\" format specifiers which will be filled
  1600. with the sequence number of the days, and the total number of days in the
  1601. range, respectively."
  1602. :group 'org-agenda-line-format
  1603. :type '(list
  1604. (string :tag "Deadline today ")
  1605. (choice :tag "Deadline relative"
  1606. (string :tag "Format string")
  1607. (function))))
  1608. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1609. "Text preceding scheduled items in the agenda view.
  1610. This is a list with two strings. The first applies when the item is
  1611. scheduled on the current day. The second applies when it has been scheduled
  1612. previously, it may contain a %d indicating that this is the nth time that
  1613. this item is scheduled, due to automatic rescheduling of unfinished items
  1614. for the following day. So this number is one larger than the number of days
  1615. that passed since this item was scheduled first."
  1616. :group 'org-agenda-line-format
  1617. :version "24.4"
  1618. :package-version '(Org . "8.0")
  1619. :type '(list
  1620. (string :tag "Scheduled today ")
  1621. (string :tag "Scheduled previously")))
  1622. (defcustom org-agenda-inactive-leader "["
  1623. "Text preceding item pulled into the agenda by inactive time stamps.
  1624. These entries are added to the agenda when pressing \"[\"."
  1625. :group 'org-agenda-line-format
  1626. :version "24.1"
  1627. :type 'string)
  1628. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1629. "Text preceding deadline items in the agenda view.
  1630. This is a list with three strings. The first applies when the item has its
  1631. deadline on the current day. The second applies when the deadline is in the
  1632. future, the third one when it is in the past. The strings may contain %d
  1633. to capture the number of days."
  1634. :group 'org-agenda-line-format
  1635. :version "24.4"
  1636. :package-version '(Org . "8.0")
  1637. :type '(list
  1638. (string :tag "Deadline today ")
  1639. (string :tag "Deadline in the future ")
  1640. (string :tag "Deadline in the past ")))
  1641. (defcustom org-agenda-remove-times-when-in-prefix t
  1642. "Non-nil means remove duplicate time specifications in agenda items.
  1643. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1644. time-of-day specification in a headline or diary entry is extracted and
  1645. placed into the prefix. If this option is non-nil, the original specification
  1646. \(a timestamp or -range, or just a plain time(range) specification like
  1647. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1648. cluttered.
  1649. The option can be t or nil. It may also be the symbol `beg', indicating
  1650. that the time should only be removed when it is located at the beginning of
  1651. the headline/diary entry."
  1652. :group 'org-agenda-line-format
  1653. :type '(choice
  1654. (const :tag "Always" t)
  1655. (const :tag "Never" nil)
  1656. (const :tag "When at beginning of entry" beg)))
  1657. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1658. "Non-nil means remove time ranges specifications in agenda
  1659. items that span on several days."
  1660. :group 'org-agenda-line-format
  1661. :version "24.1"
  1662. :type 'boolean)
  1663. (defcustom org-agenda-default-appointment-duration nil
  1664. "Default duration for appointments that only have a starting time.
  1665. When nil, no duration is specified in such cases.
  1666. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1667. :group 'org-agenda-line-format
  1668. :type '(choice
  1669. (integer :tag "Minutes")
  1670. (const :tag "No default duration")))
  1671. (defcustom org-agenda-show-inherited-tags t
  1672. "Non-nil means show inherited tags in each agenda line.
  1673. When this option is set to `always', it takes precedence over
  1674. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1675. in every agenda.
  1676. When this option is set to t (the default), inherited tags are
  1677. shown when they are available, i.e. when the value of
  1678. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1679. given agenda type.
  1680. This can be set to a list of agenda types in which the agenda
  1681. must display the inherited tags. Available types are `todo',
  1682. `agenda' and `search'.
  1683. When set to nil, never show inherited tags in agenda lines."
  1684. :group 'org-agenda-line-format
  1685. :group 'org-agenda
  1686. :version "24.3"
  1687. :type '(choice
  1688. (const :tag "Show inherited tags when available" t)
  1689. (const :tag "Always show inherited tags" always)
  1690. (repeat :tag "Show inherited tags only in selected agenda types"
  1691. (symbol :tag "Agenda type"))))
  1692. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1693. "List of agenda view types where to use tag inheritance.
  1694. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1695. controlled by `org-use-tag-inheritance'. In other agenda types,
  1696. `org-use-tag-inheritance' is not used for the selection of the
  1697. agenda entries. Still, you may want the agenda to be aware of
  1698. the inherited tags anyway, e.g. for later tag filtering.
  1699. Allowed value are `todo', `search' and `agenda'.
  1700. This variable has no effect if `org-agenda-show-inherited-tags'
  1701. is set to `always'. In that case, the agenda is aware of those
  1702. tags.
  1703. The default value sets tags in every agenda type. Setting this
  1704. option to nil will speed up non-tags agenda view a lot."
  1705. :group 'org-agenda
  1706. :version "26.1"
  1707. :package-version '(Org . "9.1")
  1708. :type '(choice
  1709. (const :tag "Use tag inheritance in all agenda types" t)
  1710. (repeat :tag "Use tag inheritance in selected agenda types"
  1711. (symbol :tag "Agenda type"))))
  1712. (defcustom org-agenda-hide-tags-regexp nil
  1713. "Regular expression used to filter away specific tags in agenda views.
  1714. This means that these tags will be present, but not be shown in the agenda
  1715. line. Secondary filtering will still work on the hidden tags.
  1716. Nil means don't hide any tags."
  1717. :group 'org-agenda-line-format
  1718. :type '(choice
  1719. (const :tag "Hide none" nil)
  1720. (regexp :tag "Regexp ")))
  1721. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1722. 'org-agenda-remove-tags)
  1723. (defcustom org-agenda-remove-tags nil
  1724. "Non-nil means remove the tags from the headline copy in the agenda.
  1725. When this is the symbol `prefix', only remove tags when
  1726. `org-agenda-prefix-format' contains a `%T' specifier."
  1727. :group 'org-agenda-line-format
  1728. :type '(choice
  1729. (const :tag "Always" t)
  1730. (const :tag "Never" nil)
  1731. (const :tag "When prefix format contains %T" prefix)))
  1732. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1733. (defcustom org-agenda-tags-column 'auto
  1734. "Shift tags in agenda items to this column.
  1735. If set to `auto', tags will be automatically aligned to the right
  1736. edge of the window.
  1737. If set to a positive number, tags will be left-aligned to that
  1738. column. If set to a negative number, tags will be right-aligned
  1739. to that column. For example, -80 works well for a normal 80
  1740. character screen."
  1741. :group 'org-agenda-line-format
  1742. :type '(choice
  1743. (const :tag "Automatically align to right edge of window" auto)
  1744. (integer :tag "Specific column" -80))
  1745. :package-version '(Org . "9.1")
  1746. :version "26.1")
  1747. (defcustom org-agenda-fontify-priorities 'cookies
  1748. "Non-nil means highlight low and high priorities in agenda.
  1749. When t, the highest priority entries are bold, lowest priority italic.
  1750. However, settings in `org-priority-faces' will overrule these faces.
  1751. When this variable is the symbol `cookies', only fontify the
  1752. cookies, not the entire task.
  1753. This may also be an association list of priority faces, whose
  1754. keys are the character values of `org-priority-highest',
  1755. `org-priority-default', and `org-priority-lowest' (the default values
  1756. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1757. color as a string, or a list like `(:background \"Red\")'.
  1758. If it is a color, the variable `org-faces-easy-properties'
  1759. determines if it is a foreground or a background color."
  1760. :group 'org-agenda-line-format
  1761. :type '(choice
  1762. (const :tag "Never" nil)
  1763. (const :tag "Defaults" t)
  1764. (const :tag "Cookies only" cookies)
  1765. (repeat :tag "Specify"
  1766. (list (character :tag "Priority" :value ?A)
  1767. (choice :tag "Face "
  1768. (string :tag "Color")
  1769. (sexp :tag "Face"))))))
  1770. (defcustom org-agenda-day-face-function nil
  1771. "Function called to determine what face should be used to display a day.
  1772. The only argument passed to that function is the day. It should
  1773. returns a face, or nil if does not want to specify a face and let
  1774. the normal rules apply."
  1775. :group 'org-agenda-line-format
  1776. :version "24.1"
  1777. :type '(choice (const nil) (function)))
  1778. (defcustom org-agenda-category-icon-alist nil
  1779. "Alist of category icon to be displayed in agenda views.
  1780. Each entry should have the following format:
  1781. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1782. Where CATEGORY-REGEXP is a regexp matching the categories where
  1783. the icon should be displayed.
  1784. FILE-OR-DATA either a file path or a string containing image data.
  1785. The other fields can be omitted safely if not needed:
  1786. TYPE indicates the image type.
  1787. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1788. image data.
  1789. PROPS are additional image attributes to assign to the image,
  1790. like, e.g. `:ascent center'.
  1791. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1792. If you want to set the display properties yourself, just put a
  1793. list as second element:
  1794. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1795. For example, to display a 16px horizontal space for Emacs
  1796. category, you can use:
  1797. (\"Emacs\" \\='(space . (:width (16))))"
  1798. :group 'org-agenda-line-format
  1799. :version "24.1"
  1800. :type '(alist :key-type (regexp :tag "Regexp matching category")
  1801. :value-type (choice (list :tag "Icon"
  1802. (string :tag "File or data")
  1803. (symbol :tag "Type")
  1804. (boolean :tag "Data?")
  1805. (repeat :tag "Extra image properties" :inline t sexp))
  1806. (list :tag "Display properties" sexp))))
  1807. (defgroup org-agenda-column-view nil
  1808. "Options concerning column view in the agenda."
  1809. :tag "Org Agenda Column View"
  1810. :group 'org-agenda)
  1811. (defcustom org-agenda-view-columns-initially nil
  1812. "When non-nil, switch to columns view right after creating the agenda."
  1813. :group 'org-agenda-column-view
  1814. :type 'boolean
  1815. :version "26.1"
  1816. :package-version '(Org . "9.0")
  1817. :safe #'booleanp)
  1818. (defcustom org-agenda-columns-show-summaries t
  1819. "Non-nil means show summaries for columns displayed in the agenda view."
  1820. :group 'org-agenda-column-view
  1821. :type 'boolean)
  1822. (defcustom org-agenda-columns-compute-summary-properties t
  1823. "Non-nil means recompute all summary properties before column view.
  1824. When column view in the agenda is listing properties that have a summary
  1825. operator, it can go to all relevant buffers and recompute the summaries
  1826. there. This can mean overhead for the agenda column view, but is necessary
  1827. to have thing up to date.
  1828. As a special case, a CLOCKSUM property also makes sure that the clock
  1829. computations are current."
  1830. :group 'org-agenda-column-view
  1831. :type 'boolean)
  1832. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1833. "Non-nil means the duration of an appointment will add to day effort.
  1834. The property to which appointment durations will be added is the one given
  1835. in the option `org-effort-property'. If an appointment does not have
  1836. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1837. is not set, an appointment without end time will not contribute to the time
  1838. estimate."
  1839. :group 'org-agenda-column-view
  1840. :type 'boolean)
  1841. (defcustom org-agenda-auto-exclude-function nil
  1842. "A function called with a tag to decide if it is filtered on \
  1843. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1844. The sole argument to the function, which is called once for each
  1845. possible tag, is a string giving the name of the tag. The
  1846. function should return either nil if the tag should be included
  1847. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1848. lines not carrying this tag.
  1849. Note that for the purpose of tag filtering, only the lower-case version of
  1850. all tags will be considered, so that this function will only ever see
  1851. the lower-case version of all tags."
  1852. :group 'org-agenda
  1853. :type '(choice (const nil) (function)))
  1854. (defcustom org-agenda-bulk-custom-functions nil
  1855. "Alist of characters and custom functions for bulk actions.
  1856. For example, this makes those two functions available:
  1857. (setq org-agenda-bulk-custom-functions
  1858. \\='((?R set-category)
  1859. (?C bulk-cut)))
  1860. With selected entries in an agenda buffer, `B R' will call
  1861. the custom function `set-category' on the selected entries.
  1862. Note that functions in this alist don't need to be quoted.
  1863. You can also specify a function which collects arguments to be
  1864. used for each call to your bulk custom function. The argument
  1865. collecting function will be run once and should return a list of
  1866. arguments to pass to the bulk function. For example:
  1867. (setq org-agenda-bulk-custom-functions
  1868. \\='((?R set-category get-category)))
  1869. Now, `B R' will call the custom `get-category' which would prompt
  1870. the user once for a category. That category is then passed as an
  1871. argument to `set-category' for each entry it's called against."
  1872. :type
  1873. '(alist :key-type character
  1874. :value-type
  1875. (group (function :tag "Bulk Custom Function")
  1876. (choice (function :tag "Bulk Custom Argument Function")
  1877. (const :tag "No Bulk Custom Argument Function" nil))))
  1878. :package-version '(Org . "9.5")
  1879. :group 'org-agenda)
  1880. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1881. "Execute BODY with point at location given by `org-hd-marker' property.
  1882. If STRING is non-nil, the text property will be fetched from position 0
  1883. in that string. If STRING is nil, it will be fetched from the beginning
  1884. of the current line."
  1885. (declare (debug t) (indent 1))
  1886. (org-with-gensyms (marker)
  1887. `(let ((,marker (get-text-property (if ,string 0 (line-beginning-position))
  1888. 'org-hd-marker ,string)))
  1889. (with-current-buffer (marker-buffer ,marker)
  1890. (save-excursion
  1891. (goto-char ,marker)
  1892. ,@body)))))
  1893. (defun org-add-agenda-custom-command (entry)
  1894. "Replace or add a command in `org-agenda-custom-commands'.
  1895. This is mostly for hacking and trying a new command - once the command
  1896. works you probably want to add it to `org-agenda-custom-commands' for good."
  1897. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1898. (if ass
  1899. (setcdr ass (cdr entry))
  1900. (push entry org-agenda-custom-commands))))
  1901. (defmacro org-agenda--insert-overriding-header (default)
  1902. "Insert header into agenda view.
  1903. The inserted header depends on `org-agenda-overriding-header'.
  1904. If the empty string, don't insert a header. If any other string,
  1905. insert it as a header. If nil, insert DEFAULT, which should
  1906. evaluate to a string. If a function, call it and insert the
  1907. string that it returns."
  1908. (declare (debug (form)) (indent defun))
  1909. `(cond
  1910. ((not org-agenda-overriding-header) (insert ,default))
  1911. ((equal org-agenda-overriding-header "") nil)
  1912. ((stringp org-agenda-overriding-header)
  1913. (insert (propertize org-agenda-overriding-header
  1914. 'face 'org-agenda-structure)
  1915. "\n"))
  1916. ((functionp org-agenda-overriding-header)
  1917. (insert (funcall org-agenda-overriding-header)))
  1918. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1919. org-agenda-overriding-header))))
  1920. ;;; Define the org-agenda-mode
  1921. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1922. (defvar org-agenda-mode-map (make-sparse-keymap)
  1923. "Keymap for `org-agenda-mode'.")
  1924. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1925. (defvar org-agenda-menu) ; defined later in this file.
  1926. (defvar org-agenda-restrict nil)
  1927. (defvar org-agenda-follow-mode nil)
  1928. (defvar org-agenda-entry-text-mode nil)
  1929. (defvar org-agenda-clockreport-mode nil)
  1930. (defvar org-agenda-show-log nil
  1931. "When non-nil, show the log in the agenda.
  1932. Do not set this directly; instead use
  1933. `org-agenda-start-with-log-mode', which see.")
  1934. (defvar org-agenda-redo-command nil)
  1935. (defvar org-agenda-query-string nil)
  1936. (defvar org-agenda-mode-hook nil
  1937. "Hook run after `org-agenda-mode' is turned on.
  1938. The buffer is still writable when this hook is called.")
  1939. (defvar org-agenda-type nil)
  1940. (defvar org-agenda-force-single-file nil)
  1941. (defvar org-agenda-bulk-marked-entries nil
  1942. "List of markers that refer to marked entries in the agenda.")
  1943. (defvar org-agenda-current-date nil
  1944. "Active date when building the agenda.")
  1945. ;;; Multiple agenda buffers support
  1946. (defcustom org-agenda-sticky nil
  1947. "Non-nil means agenda q key will bury agenda buffers.
  1948. Agenda commands will then show existing buffer instead of generating new ones.
  1949. When nil, `q' will kill the single agenda buffer."
  1950. :group 'org-agenda
  1951. :version "24.3"
  1952. :type 'boolean)
  1953. ;;;###autoload
  1954. (defun org-toggle-sticky-agenda (&optional arg)
  1955. "Toggle `org-agenda-sticky'."
  1956. (interactive "P")
  1957. (let ((new-value (if arg
  1958. (> (prefix-numeric-value arg) 0)
  1959. (not org-agenda-sticky))))
  1960. (if (equal new-value org-agenda-sticky)
  1961. (and (called-interactively-p 'interactive)
  1962. (message "Sticky agenda was already %s"
  1963. (if org-agenda-sticky "enabled" "disabled")))
  1964. (setq org-agenda-sticky new-value)
  1965. (org-agenda-kill-all-agenda-buffers)
  1966. (and (called-interactively-p 'interactive)
  1967. (message "Sticky agenda %s"
  1968. (if org-agenda-sticky "enabled" "disabled"))))))
  1969. (defvar org-agenda-buffer nil
  1970. "Agenda buffer currently being generated.")
  1971. (defvar org-agenda-last-prefix-arg nil)
  1972. (defvar org-agenda-this-buffer-name nil)
  1973. (defvar org-agenda-doing-sticky-redo nil)
  1974. (defvar org-agenda-this-buffer-is-sticky nil)
  1975. (defvar org-agenda-last-indirect-buffer nil
  1976. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1977. (defconst org-agenda-local-vars
  1978. '(org-agenda-this-buffer-name
  1979. org-agenda-undo-list
  1980. org-agenda-pending-undo-list
  1981. org-agenda-follow-mode
  1982. org-agenda-entry-text-mode
  1983. org-agenda-clockreport-mode
  1984. org-agenda-show-log
  1985. org-agenda-redo-command
  1986. org-agenda-query-string
  1987. org-agenda-type
  1988. org-agenda-bulk-marked-entries
  1989. org-agenda-undo-has-started-in
  1990. org-agenda-info
  1991. org-agenda-pre-window-conf
  1992. org-agenda-columns-active
  1993. org-agenda-tag-filter
  1994. org-agenda-category-filter
  1995. org-agenda-top-headline-filter
  1996. org-agenda-regexp-filter
  1997. org-agenda-effort-filter
  1998. org-agenda-markers
  1999. org-agenda-last-search-view-search-was-boolean
  2000. org-agenda-last-indirect-buffer
  2001. org-agenda-filtered-by-category
  2002. org-agenda-filter-form
  2003. org-agenda-cycle-counter
  2004. org-agenda-last-prefix-arg)
  2005. "Variables that must be local in agenda buffers to allow multiple buffers.")
  2006. (defun org-agenda-mode ()
  2007. "Mode for time-sorted view on action items in Org files.
  2008. The following commands are available:
  2009. \\{org-agenda-mode-map}"
  2010. (interactive)
  2011. (ignore-errors (require 'face-remap))
  2012. (let ((agenda-local-vars-to-keep
  2013. '(text-scale-mode-amount
  2014. text-scale-mode
  2015. text-scale-mode-lighter
  2016. face-remapping-alist))
  2017. (save (buffer-local-variables)))
  2018. (kill-all-local-variables)
  2019. (cl-flet ((reset-saved (var-set)
  2020. "Reset variables in VAR-SET to possibly stored value in SAVE."
  2021. (dolist (elem save)
  2022. (pcase elem
  2023. (`(,var . ,val) ;ignore unbound variables
  2024. (when (and val (memq var var-set))
  2025. (set var val)))))))
  2026. (cond (org-agenda-doing-sticky-redo
  2027. ;; Refreshing sticky agenda-buffer
  2028. ;;
  2029. ;; Preserve the value of `org-agenda-local-vars' variables.
  2030. (mapc #'make-local-variable org-agenda-local-vars)
  2031. (reset-saved org-agenda-local-vars)
  2032. (setq-local org-agenda-this-buffer-is-sticky t))
  2033. (org-agenda-sticky
  2034. ;; Creating a sticky Agenda buffer for the first time
  2035. (mapc #'make-local-variable org-agenda-local-vars)
  2036. (setq-local org-agenda-this-buffer-is-sticky t))
  2037. (t
  2038. ;; Creating a non-sticky agenda buffer
  2039. (setq-local org-agenda-this-buffer-is-sticky nil)))
  2040. (mapc #'make-local-variable agenda-local-vars-to-keep)
  2041. (reset-saved agenda-local-vars-to-keep)))
  2042. (setq org-agenda-undo-list nil
  2043. org-agenda-pending-undo-list nil
  2044. org-agenda-bulk-marked-entries nil)
  2045. (setq major-mode 'org-agenda-mode)
  2046. ;; Keep global-font-lock-mode from turning on font-lock-mode
  2047. (setq-local font-lock-global-modes (list 'not major-mode))
  2048. (setq mode-name "Org-Agenda")
  2049. (setq indent-tabs-mode nil)
  2050. (use-local-map org-agenda-mode-map)
  2051. (when org-startup-truncated (setq truncate-lines t))
  2052. (setq-local line-move-visual nil)
  2053. (add-hook 'post-command-hook #'org-agenda-update-agenda-type nil 'local)
  2054. (add-hook 'pre-command-hook #'org-unhighlight nil 'local)
  2055. ;; Make sure properties are removed when copying text
  2056. (if (boundp 'filter-buffer-substring-functions)
  2057. (add-hook 'filter-buffer-substring-functions
  2058. (lambda (fun start end delete)
  2059. (substring-no-properties (funcall fun start end delete)))
  2060. nil t)
  2061. ;; Emacs >= 24.4.
  2062. (add-function :filter-return (local 'filter-buffer-substring-function)
  2063. #'substring-no-properties))
  2064. (unless org-agenda-keep-modes
  2065. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  2066. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  2067. org-agenda-show-log org-agenda-start-with-log-mode
  2068. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2069. (add-to-invisibility-spec '(org-filtered))
  2070. (org-fold-core-initialize `(,org-link--description-folding-spec
  2071. ,org-link--link-folding-spec))
  2072. (easy-menu-change
  2073. '("Agenda") "Agenda Files"
  2074. (append
  2075. (list
  2076. (vector
  2077. (if (get 'org-agenda-files 'org-restrict)
  2078. "Restricted to single file"
  2079. "Edit File List")
  2080. '(org-edit-agenda-file-list)
  2081. (not (get 'org-agenda-files 'org-restrict)))
  2082. "--")
  2083. (mapcar #'org-file-menu-entry (org-agenda-files))))
  2084. (org-agenda-set-mode-name)
  2085. (run-mode-hooks 'org-agenda-mode-hook))
  2086. (substitute-key-definition #'undo #'org-agenda-undo
  2087. org-agenda-mode-map global-map)
  2088. (org-defkey org-agenda-mode-map "\C-i" #'org-agenda-goto)
  2089. (org-defkey org-agenda-mode-map [(tab)] #'org-agenda-goto)
  2090. (org-defkey org-agenda-mode-map "\C-m" #'org-agenda-switch-to)
  2091. (org-defkey org-agenda-mode-map "\C-k" #'org-agenda-kill)
  2092. (org-defkey org-agenda-mode-map "\C-c\C-w" #'org-agenda-refile)
  2093. (org-defkey org-agenda-mode-map [(meta down)] #'org-agenda-drag-line-forward)
  2094. (org-defkey org-agenda-mode-map [(meta up)] #'org-agenda-drag-line-backward)
  2095. (org-defkey org-agenda-mode-map "m" #'org-agenda-bulk-mark)
  2096. (org-defkey org-agenda-mode-map "\M-m" #'org-agenda-bulk-toggle)
  2097. (org-defkey org-agenda-mode-map "*" #'org-agenda-bulk-mark-all)
  2098. (org-defkey org-agenda-mode-map "\M-*" #'org-agenda-bulk-toggle-all)
  2099. (org-defkey org-agenda-mode-map "#" #'org-agenda-dim-blocked-tasks)
  2100. (org-defkey org-agenda-mode-map "%" #'org-agenda-bulk-mark-regexp)
  2101. (org-defkey org-agenda-mode-map "u" #'org-agenda-bulk-unmark)
  2102. (org-defkey org-agenda-mode-map "U" #'org-agenda-bulk-unmark-all)
  2103. (org-defkey org-agenda-mode-map "B" #'org-agenda-bulk-action)
  2104. (org-defkey org-agenda-mode-map "k" #'org-agenda-capture)
  2105. (org-defkey org-agenda-mode-map "A" #'org-agenda-append-agenda)
  2106. (org-defkey org-agenda-mode-map "\C-c\C-x!" #'org-reload)
  2107. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" #'org-agenda-archive-default)
  2108. (org-defkey org-agenda-mode-map "\C-c\C-xa" #'org-agenda-toggle-archive-tag)
  2109. (org-defkey org-agenda-mode-map "\C-c\C-xA" #'org-agenda-archive-to-archive-sibling)
  2110. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" #'org-agenda-archive)
  2111. (org-defkey org-agenda-mode-map "\C-c$" #'org-agenda-archive)
  2112. (org-defkey org-agenda-mode-map "$" #'org-agenda-archive)
  2113. (org-defkey org-agenda-mode-map "\C-c\C-o" #'org-agenda-open-link)
  2114. (org-defkey org-agenda-mode-map " " #'org-agenda-show-and-scroll-up)
  2115. (org-defkey org-agenda-mode-map [backspace] #'org-agenda-show-scroll-down)
  2116. (org-defkey org-agenda-mode-map "\d" #'org-agenda-show-scroll-down)
  2117. (org-defkey org-agenda-mode-map [(control shift right)] #'org-agenda-todo-nextset)
  2118. (org-defkey org-agenda-mode-map [(control shift left)] #'org-agenda-todo-previousset)
  2119. (org-defkey org-agenda-mode-map "\C-c\C-xb" #'org-agenda-tree-to-indirect-buffer)
  2120. (org-defkey org-agenda-mode-map "o" #'delete-other-windows)
  2121. (org-defkey org-agenda-mode-map "L" #'org-agenda-recenter)
  2122. (org-defkey org-agenda-mode-map "\C-c\C-t" #'org-agenda-todo)
  2123. (org-defkey org-agenda-mode-map "t" #'org-agenda-todo)
  2124. (org-defkey org-agenda-mode-map "a" #'org-agenda-archive-default-with-confirmation)
  2125. (org-defkey org-agenda-mode-map ":" #'org-agenda-set-tags)
  2126. (org-defkey org-agenda-mode-map "\C-c\C-q" #'org-agenda-set-tags)
  2127. (org-defkey org-agenda-mode-map "." #'org-agenda-goto-today)
  2128. (org-defkey org-agenda-mode-map "j" #'org-agenda-goto-date)
  2129. (org-defkey org-agenda-mode-map "d" #'org-agenda-day-view)
  2130. (org-defkey org-agenda-mode-map "w" #'org-agenda-week-view)
  2131. (org-defkey org-agenda-mode-map "y" #'org-agenda-year-view)
  2132. (org-defkey org-agenda-mode-map "\C-c\C-z" #'org-agenda-add-note)
  2133. (org-defkey org-agenda-mode-map "z" #'org-agenda-add-note)
  2134. (org-defkey org-agenda-mode-map [(shift right)] #'org-agenda-do-date-later)
  2135. (org-defkey org-agenda-mode-map [(shift left)] #'org-agenda-do-date-earlier)
  2136. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] #'org-agenda-do-date-later)
  2137. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] #'org-agenda-do-date-earlier)
  2138. (org-defkey org-agenda-mode-map ">" #'org-agenda-date-prompt)
  2139. (org-defkey org-agenda-mode-map "\C-c\C-s" #'org-agenda-schedule)
  2140. (org-defkey org-agenda-mode-map "\C-c\C-d" #'org-agenda-deadline)
  2141. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2142. (while l (org-defkey org-agenda-mode-map
  2143. (number-to-string (pop l)) #'digit-argument)))
  2144. (org-defkey org-agenda-mode-map "F" #'org-agenda-follow-mode)
  2145. (org-defkey org-agenda-mode-map "R" #'org-agenda-clockreport-mode)
  2146. (org-defkey org-agenda-mode-map "E" #'org-agenda-entry-text-mode)
  2147. (org-defkey org-agenda-mode-map "l" #'org-agenda-log-mode)
  2148. (org-defkey org-agenda-mode-map "v" #'org-agenda-view-mode-dispatch)
  2149. (org-defkey org-agenda-mode-map "D" #'org-agenda-toggle-diary)
  2150. (org-defkey org-agenda-mode-map "!" #'org-agenda-toggle-deadlines)
  2151. (org-defkey org-agenda-mode-map "G" #'org-agenda-toggle-time-grid)
  2152. (org-defkey org-agenda-mode-map "r" #'org-agenda-redo)
  2153. (org-defkey org-agenda-mode-map "g" #'org-agenda-redo-all)
  2154. (org-defkey org-agenda-mode-map "e" #'org-agenda-set-effort)
  2155. (org-defkey org-agenda-mode-map "\C-c\C-xe" #'org-agenda-set-effort)
  2156. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2157. #'org-clock-modify-effort-estimate)
  2158. (org-defkey org-agenda-mode-map "\C-c\C-xp" #'org-agenda-set-property)
  2159. (org-defkey org-agenda-mode-map "q" #'org-agenda-quit)
  2160. (org-defkey org-agenda-mode-map "Q" #'org-agenda-Quit)
  2161. (org-defkey org-agenda-mode-map "x" #'org-agenda-exit)
  2162. (org-defkey org-agenda-mode-map "\C-x\C-w" #'org-agenda-write)
  2163. (org-defkey org-agenda-mode-map "\C-x\C-s" #'org-save-all-org-buffers)
  2164. (org-defkey org-agenda-mode-map "s" #'org-save-all-org-buffers)
  2165. (org-defkey org-agenda-mode-map "T" #'org-agenda-show-tags)
  2166. (org-defkey org-agenda-mode-map "n" #'org-agenda-next-line)
  2167. (org-defkey org-agenda-mode-map "p" #'org-agenda-previous-line)
  2168. (org-defkey org-agenda-mode-map "N" #'org-agenda-next-item)
  2169. (org-defkey org-agenda-mode-map "P" #'org-agenda-previous-item)
  2170. (substitute-key-definition #'next-line #'org-agenda-next-line
  2171. org-agenda-mode-map global-map)
  2172. (substitute-key-definition #'previous-line #'org-agenda-previous-line
  2173. org-agenda-mode-map global-map)
  2174. (org-defkey org-agenda-mode-map "\C-c\C-a" #'org-attach)
  2175. (org-defkey org-agenda-mode-map "\C-c\C-n" #'org-agenda-next-date-line)
  2176. (org-defkey org-agenda-mode-map "\C-c\C-p" #'org-agenda-previous-date-line)
  2177. (org-defkey org-agenda-mode-map "\C-c," #'org-agenda-priority)
  2178. (org-defkey org-agenda-mode-map "," #'org-agenda-priority)
  2179. (org-defkey org-agenda-mode-map "i" #'org-agenda-diary-entry)
  2180. (org-defkey org-agenda-mode-map "c" #'org-agenda-goto-calendar)
  2181. (org-defkey org-agenda-mode-map "C" #'org-agenda-convert-date)
  2182. (org-defkey org-agenda-mode-map "M" #'org-agenda-phases-of-moon)
  2183. (org-defkey org-agenda-mode-map "S" #'org-agenda-sunrise-sunset)
  2184. (org-defkey org-agenda-mode-map "h" #'org-agenda-holidays)
  2185. (org-defkey org-agenda-mode-map "H" #'org-agenda-holidays)
  2186. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" #'org-agenda-clock-in)
  2187. (org-defkey org-agenda-mode-map "I" #'org-agenda-clock-in)
  2188. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" #'org-agenda-clock-out)
  2189. (org-defkey org-agenda-mode-map "O" #'org-agenda-clock-out)
  2190. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" #'org-agenda-clock-cancel)
  2191. (org-defkey org-agenda-mode-map "X" #'org-agenda-clock-cancel)
  2192. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" #'org-clock-goto)
  2193. (org-defkey org-agenda-mode-map "J" #'org-agenda-clock-goto)
  2194. (org-defkey org-agenda-mode-map "+" #'org-agenda-priority-up)
  2195. (org-defkey org-agenda-mode-map "-" #'org-agenda-priority-down)
  2196. (org-defkey org-agenda-mode-map [(shift up)] #'org-agenda-priority-up)
  2197. (org-defkey org-agenda-mode-map [(shift down)] #'org-agenda-priority-down)
  2198. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] #'org-agenda-priority-up)
  2199. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] #'org-agenda-priority-down)
  2200. (org-defkey org-agenda-mode-map "f" #'org-agenda-later)
  2201. (org-defkey org-agenda-mode-map "b" #'org-agenda-earlier)
  2202. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" #'org-agenda-columns)
  2203. (org-defkey org-agenda-mode-map "\C-c\C-x>" #'org-agenda-remove-restriction-lock)
  2204. (org-defkey org-agenda-mode-map "\C-c\C-x<" #'org-agenda-set-restriction-lock-from-agenda)
  2205. (org-defkey org-agenda-mode-map "[" #'org-agenda-manipulate-query-add)
  2206. (org-defkey org-agenda-mode-map "]" #'org-agenda-manipulate-query-subtract)
  2207. (org-defkey org-agenda-mode-map "{" #'org-agenda-manipulate-query-add-re)
  2208. (org-defkey org-agenda-mode-map "}" #'org-agenda-manipulate-query-subtract-re)
  2209. (org-defkey org-agenda-mode-map "\\" #'org-agenda-filter-by-tag)
  2210. (org-defkey org-agenda-mode-map "_" #'org-agenda-filter-by-effort)
  2211. (org-defkey org-agenda-mode-map "=" #'org-agenda-filter-by-regexp)
  2212. (org-defkey org-agenda-mode-map "/" #'org-agenda-filter)
  2213. (org-defkey org-agenda-mode-map "|" #'org-agenda-filter-remove-all)
  2214. (org-defkey org-agenda-mode-map "~" #'org-agenda-limit-interactively)
  2215. (org-defkey org-agenda-mode-map "<" #'org-agenda-filter-by-category)
  2216. (org-defkey org-agenda-mode-map "^" #'org-agenda-filter-by-top-headline)
  2217. (org-defkey org-agenda-mode-map ";" #'org-timer-set-timer)
  2218. (org-defkey org-agenda-mode-map "\C-c\C-x_" #'org-timer-stop)
  2219. (org-defkey org-agenda-mode-map "?" #'org-agenda-show-the-flagging-note)
  2220. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" #'org-mobile-pull)
  2221. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" #'org-mobile-push)
  2222. (org-defkey org-agenda-mode-map "\C-c\C-xI" #'org-info-find-node)
  2223. (org-defkey org-agenda-mode-map [mouse-2] #'org-agenda-goto-mouse)
  2224. (org-defkey org-agenda-mode-map [mouse-3] #'org-agenda-show-mouse)
  2225. (org-defkey org-agenda-mode-map [remap forward-paragraph] #'org-agenda-forward-block)
  2226. (org-defkey org-agenda-mode-map [remap backward-paragraph] #'org-agenda-backward-block)
  2227. (org-defkey org-agenda-mode-map "\C-c\C-c" #'org-agenda-ctrl-c-ctrl-c)
  2228. (when org-agenda-mouse-1-follows-link
  2229. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2230. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu."
  2231. '("Agenda"
  2232. ("Agenda Files")
  2233. "--"
  2234. ("Agenda Dates"
  2235. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2236. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2237. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2238. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2239. "--"
  2240. ("View"
  2241. ["Day View" org-agenda-day-view
  2242. :active (org-agenda-check-type nil 'agenda)
  2243. :style radio :selected (eq org-agenda-current-span 'day)
  2244. :keys "v d (or just d)"]
  2245. ["Week View" org-agenda-week-view
  2246. :active (org-agenda-check-type nil 'agenda)
  2247. :style radio :selected (eq org-agenda-current-span 'week)
  2248. :keys "v w"]
  2249. ["Fortnight View" org-agenda-fortnight-view
  2250. :active (org-agenda-check-type nil 'agenda)
  2251. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2252. :keys "v t"]
  2253. ["Month View" org-agenda-month-view
  2254. :active (org-agenda-check-type nil 'agenda)
  2255. :style radio :selected (eq org-agenda-current-span 'month)
  2256. :keys "v m"]
  2257. ["Year View" org-agenda-year-view
  2258. :active (org-agenda-check-type nil 'agenda)
  2259. :style radio :selected (eq org-agenda-current-span 'year)
  2260. :keys "v y"]
  2261. "--"
  2262. ["Include Diary" org-agenda-toggle-diary
  2263. :style toggle :selected org-agenda-include-diary
  2264. :active (org-agenda-check-type nil 'agenda)]
  2265. ["Include Deadlines" org-agenda-toggle-deadlines
  2266. :style toggle :selected org-agenda-include-deadlines
  2267. :active (org-agenda-check-type nil 'agenda)]
  2268. ["Use Time Grid" org-agenda-toggle-time-grid
  2269. :style toggle :selected org-agenda-use-time-grid
  2270. :active (org-agenda-check-type nil 'agenda)]
  2271. "--"
  2272. ["Show clock report" org-agenda-clockreport-mode
  2273. :style toggle :selected org-agenda-clockreport-mode
  2274. :active (org-agenda-check-type nil 'agenda)]
  2275. ["Show some entry text" org-agenda-entry-text-mode
  2276. :style toggle :selected org-agenda-entry-text-mode
  2277. :active t]
  2278. "--"
  2279. ["Show Logbook entries" org-agenda-log-mode
  2280. :style toggle :selected org-agenda-show-log
  2281. :active (org-agenda-check-type nil 'agenda)
  2282. :keys "v l (or just l)"]
  2283. ["Include archived trees" org-agenda-archives-mode
  2284. :style toggle :selected org-agenda-archives-mode :active t
  2285. :keys "v a"]
  2286. ["Include archive files" (org-agenda-archives-mode t)
  2287. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2288. :keys "v A"]
  2289. "--"
  2290. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2291. ("Filter current view"
  2292. ["with generic interface" org-agenda-filter t]
  2293. "--"
  2294. ["by category at cursor" org-agenda-filter-by-category t]
  2295. ["by tag" org-agenda-filter-by-tag t]
  2296. ["by effort" org-agenda-filter-by-effort t]
  2297. ["by regexp" org-agenda-filter-by-regexp t]
  2298. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2299. "--"
  2300. ["Remove all filtering" org-agenda-filter-remove-all t]
  2301. "--"
  2302. ["limit" org-agenda-limit-interactively t])
  2303. ["Rebuild buffer" org-agenda-redo t]
  2304. ["Write view to file" org-agenda-write t]
  2305. ["Save all Org buffers" org-save-all-org-buffers t]
  2306. "--"
  2307. ["Show original entry" org-agenda-show t]
  2308. ["Go To (other window)" org-agenda-goto t]
  2309. ["Go To (this window)" org-agenda-switch-to t]
  2310. ["Capture with cursor date" org-agenda-capture t]
  2311. ["Follow Mode" org-agenda-follow-mode
  2312. :style toggle :selected org-agenda-follow-mode :active t]
  2313. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2314. "--"
  2315. ("TODO"
  2316. ["Cycle TODO" org-agenda-todo t]
  2317. ["Next TODO set" org-agenda-todo-nextset t]
  2318. ["Previous TODO set" org-agenda-todo-previousset t]
  2319. ["Add note" org-agenda-add-note t])
  2320. ("Archive/Refile/Delete"
  2321. ["Archive default" org-agenda-archive-default t]
  2322. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2323. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2324. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2325. ["Archive subtree" org-agenda-archive t]
  2326. "--"
  2327. ["Refile" org-agenda-refile t]
  2328. "--"
  2329. ["Delete subtree" org-agenda-kill t])
  2330. ("Bulk action"
  2331. ["Mark entry" org-agenda-bulk-mark t]
  2332. ["Mark all" org-agenda-bulk-mark-all t]
  2333. ["Unmark entry" org-agenda-bulk-unmark t]
  2334. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2335. ["Toggle mark" org-agenda-bulk-toggle t]
  2336. ["Toggle all" org-agenda-bulk-toggle-all t]
  2337. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2338. ["Act on all marked" org-agenda-bulk-action t]
  2339. "--"
  2340. ("Tags and Properties"
  2341. ["Show all Tags" org-agenda-show-tags t]
  2342. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2343. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2344. "--"
  2345. ["Column View" org-columns t])
  2346. ("Deadline/Schedule"
  2347. ["Schedule" org-agenda-schedule t]
  2348. ["Set Deadline" org-agenda-deadline t]
  2349. "--"
  2350. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2351. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2352. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2353. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2354. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2355. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2356. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2357. ("Clock and Effort"
  2358. ["Clock in" org-agenda-clock-in t]
  2359. ["Clock out" org-agenda-clock-out t]
  2360. ["Clock cancel" org-agenda-clock-cancel t]
  2361. ["Goto running clock" org-clock-goto t]
  2362. "--"
  2363. ["Set Effort" org-agenda-set-effort t]
  2364. ["Change clocked effort" org-clock-modify-effort-estimate
  2365. (org-clock-is-active)])
  2366. ("Priority"
  2367. ["Set Priority" org-agenda-priority t]
  2368. ["Increase Priority" org-agenda-priority-up t]
  2369. ["Decrease Priority" org-agenda-priority-down t]
  2370. ["Show Priority" org-priority-show t])
  2371. ("Calendar/Diary"
  2372. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2373. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2374. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2375. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2376. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2377. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2378. "--"
  2379. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2380. "--"
  2381. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2382. "--"
  2383. ("MobileOrg"
  2384. ["Push Files and Views" org-mobile-push t]
  2385. ["Get Captured and Flagged" org-mobile-pull t]
  2386. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2387. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2388. "--"
  2389. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2390. "--"
  2391. ["Quit" org-agenda-quit t]
  2392. ["Exit and Release Buffers" org-agenda-exit t]
  2393. ))
  2394. ;;; Agenda undo
  2395. (defvar org-agenda-allow-remote-undo t
  2396. "Non-nil means allow remote undo from the agenda buffer.")
  2397. (defvar org-agenda-undo-has-started-in nil
  2398. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2399. (defun org-agenda-undo ()
  2400. "Undo a remote editing step in the agenda.
  2401. This undoes changes both in the agenda buffer and in the remote buffer
  2402. that have been changed along."
  2403. (interactive)
  2404. (or org-agenda-allow-remote-undo
  2405. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2406. (when (not (eq this-command last-command))
  2407. (setq org-agenda-undo-has-started-in nil
  2408. org-agenda-pending-undo-list org-agenda-undo-list))
  2409. (when (not org-agenda-pending-undo-list)
  2410. (user-error "No further undo information"))
  2411. (let* ((entry (pop org-agenda-pending-undo-list))
  2412. buf line cmd rembuf)
  2413. (setq cmd (pop entry) line (pop entry))
  2414. (setq rembuf (nth 2 entry))
  2415. (org-with-remote-undo rembuf
  2416. (while (bufferp (setq buf (pop entry)))
  2417. (when (pop entry)
  2418. (with-current-buffer buf
  2419. (let (;; (last-undo-buffer buf)
  2420. (inhibit-read-only t))
  2421. (unless (memq buf org-agenda-undo-has-started-in)
  2422. (push buf org-agenda-undo-has-started-in)
  2423. (make-local-variable 'pending-undo-list)
  2424. (undo-start))
  2425. (while (and pending-undo-list
  2426. (listp pending-undo-list)
  2427. (not (car pending-undo-list)))
  2428. (pop pending-undo-list))
  2429. (undo-more 1))))))
  2430. (org-goto-line line)
  2431. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2432. (defun org-verify-change-for-undo (l1 l2)
  2433. "Verify that a real change occurred between the undo lists L1 and L2."
  2434. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2435. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2436. (not (eq l1 l2)))
  2437. ;;; Agenda dispatch
  2438. (defvar org-agenda-restrict-begin (make-marker))
  2439. (defvar org-agenda-restrict-end (make-marker))
  2440. (defvar org-agenda-last-dispatch-buffer nil)
  2441. (defvar org-agenda-overriding-restriction nil)
  2442. (defcustom org-agenda-custom-commands-contexts nil
  2443. "Alist of custom agenda keys and contextual rules.
  2444. For example, if you have a custom agenda command \"p\" and you
  2445. want this command to be accessible only from plain text files,
  2446. use this:
  2447. (setq org-agenda-custom-commands-contexts
  2448. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\")))))
  2449. Here are the available contexts definitions:
  2450. in-file: command displayed only in matching files
  2451. in-mode: command displayed only in matching modes
  2452. not-in-file: command not displayed in matching files
  2453. not-in-mode: command not displayed in matching modes
  2454. in-buffer: command displayed only in matching buffers
  2455. not-in-buffer: command not displayed in matching buffers
  2456. [function]: a custom function taking no argument
  2457. If you define several checks, the agenda command will be
  2458. accessible if there is at least one valid check.
  2459. You can also bind a key to another agenda custom command
  2460. depending on contextual rules.
  2461. (setq org-agenda-custom-commands-contexts
  2462. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\")))))
  2463. Here it means: in .txt files, use \"p\" as the key for the
  2464. agenda command otherwise associated with \"q\". (The command
  2465. originally associated with \"q\" is not displayed to avoid
  2466. duplicates.)"
  2467. :version "24.3"
  2468. :group 'org-agenda-custom-commands
  2469. :type '(repeat (list :tag "Rule"
  2470. (string :tag " Agenda key")
  2471. (string :tag "Replace by command")
  2472. (repeat :tag "Available when"
  2473. (choice
  2474. (cons :tag "Condition"
  2475. (choice
  2476. (const :tag "In file" in-file)
  2477. (const :tag "Not in file" not-in-file)
  2478. (const :tag "In buffer" in-buffer)
  2479. (const :tag "Not in buffer" not-in-buffer)
  2480. (const :tag "In mode" in-mode)
  2481. (const :tag "Not in mode" not-in-mode))
  2482. (regexp))
  2483. (function :tag "Custom function"))))))
  2484. (defcustom org-agenda-max-entries nil
  2485. "Maximum number of entries to display in an agenda.
  2486. This can be nil (no limit) or an integer or an alist of agenda
  2487. types with an associated number of entries to display in this
  2488. type."
  2489. :version "24.4"
  2490. :package-version '(Org . "8.0")
  2491. :group 'org-agenda-custom-commands
  2492. :type '(choice (symbol :tag "No limit" nil)
  2493. (integer :tag "Max number of entries")
  2494. (repeat
  2495. (cons (choice :tag "Agenda type"
  2496. (const agenda)
  2497. (const todo)
  2498. (const tags)
  2499. (const search))
  2500. (integer :tag "Max number of entries")))))
  2501. (defcustom org-agenda-max-todos nil
  2502. "Maximum number of TODOs to display in an agenda.
  2503. This can be nil (no limit) or an integer or an alist of agenda
  2504. types with an associated number of entries to display in this
  2505. type."
  2506. :version "24.4"
  2507. :package-version '(Org . "8.0")
  2508. :group 'org-agenda-custom-commands
  2509. :type '(choice (symbol :tag "No limit" nil)
  2510. (integer :tag "Max number of TODOs")
  2511. (repeat
  2512. (cons (choice :tag "Agenda type"
  2513. (const agenda)
  2514. (const todo)
  2515. (const tags)
  2516. (const search))
  2517. (integer :tag "Max number of TODOs")))))
  2518. (defcustom org-agenda-max-tags nil
  2519. "Maximum number of tagged entries to display in an agenda.
  2520. This can be nil (no limit) or an integer or an alist of agenda
  2521. types with an associated number of entries to display in this
  2522. type."
  2523. :version "24.4"
  2524. :package-version '(Org . "8.0")
  2525. :group 'org-agenda-custom-commands
  2526. :type '(choice (symbol :tag "No limit" nil)
  2527. (integer :tag "Max number of tagged entries")
  2528. (repeat
  2529. (cons (choice :tag "Agenda type"
  2530. (const agenda)
  2531. (const todo)
  2532. (const tags)
  2533. (const search))
  2534. (integer :tag "Max number of tagged entries")))))
  2535. (defcustom org-agenda-max-effort nil
  2536. "Maximum cumulated effort duration for the agenda.
  2537. This can be nil (no limit) or a number of minutes (as an integer)
  2538. or an alist of agenda types with an associated number of minutes
  2539. to limit entries to in this type."
  2540. :version "24.4"
  2541. :package-version '(Org . "8.0")
  2542. :group 'org-agenda-custom-commands
  2543. :type '(choice (symbol :tag "No limit" nil)
  2544. (integer :tag "Max number of minutes")
  2545. (repeat
  2546. (cons (choice :tag "Agenda type"
  2547. (const agenda)
  2548. (const todo)
  2549. (const tags)
  2550. (const search))
  2551. (integer :tag "Max number of minutes")))))
  2552. (defvar org-agenda-keep-restricted-file-list nil)
  2553. (defvar org-keys nil)
  2554. (defvar org-match nil)
  2555. ;;;###autoload
  2556. (defun org-agenda (&optional arg keys restriction)
  2557. "Dispatch agenda commands to collect entries to the agenda buffer.
  2558. Prompts for a command to execute. Any prefix arg will be passed
  2559. on to the selected command. The default selections are:
  2560. a Call `org-agenda-list' to display the agenda for current day or week.
  2561. t Call `org-todo-list' to display the global todo list.
  2562. T Call `org-todo-list' to display the global todo list, select only
  2563. entries with a specific TODO keyword (the user gets a prompt).
  2564. m Call `org-tags-view' to display headlines with tags matching
  2565. a condition (the user is prompted for the condition).
  2566. M Like `m', but select only TODO entries, no ordinary headlines.
  2567. e Export views to associated files.
  2568. s Search entries for keywords.
  2569. S Search entries for keywords, only with TODO keywords.
  2570. / Multi occur across all agenda files and also files listed
  2571. in `org-agenda-text-search-extra-files'.
  2572. < Restrict agenda commands to buffer, subtree, or region.
  2573. Press several times to get the desired effect.
  2574. > Remove a previous restriction.
  2575. # List \"stuck\" projects.
  2576. ! Configure what \"stuck\" means.
  2577. C Configure custom agenda commands.
  2578. More commands can be added by configuring the variable
  2579. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2580. searches can be pre-defined in this way.
  2581. If the current buffer is in Org mode and visiting a file, you can also
  2582. first press `<' once to indicate that the agenda should be temporarily
  2583. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2584. Pressing `<' twice means to restrict to the current subtree or region
  2585. \(if active)."
  2586. (interactive "P")
  2587. (catch 'exit
  2588. (let* ((org-keys keys)
  2589. (prefix-descriptions nil)
  2590. (org-agenda-buffer-name org-agenda-buffer-name)
  2591. (org-agenda-window-setup (if (equal (buffer-name)
  2592. org-agenda-buffer-name)
  2593. 'current-window
  2594. org-agenda-window-setup))
  2595. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2596. (org-agenda-custom-commands
  2597. ;; normalize different versions
  2598. (delq nil
  2599. (mapcar
  2600. (lambda (x)
  2601. (cond ((stringp (cdr x))
  2602. (push x prefix-descriptions)
  2603. nil)
  2604. ((stringp (nth 1 x)) x)
  2605. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2606. (t (cons (car x) (cons "" (cdr x))))))
  2607. org-agenda-custom-commands)))
  2608. (org-agenda-custom-commands
  2609. (org-contextualize-keys
  2610. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2611. ;; (buf (current-buffer))
  2612. (bfn (buffer-file-name (buffer-base-buffer)))
  2613. entry type org-match lprops ans) ;; key
  2614. ;; Turn off restriction unless there is an overriding one,
  2615. (unless org-agenda-overriding-restriction
  2616. (unless org-agenda-keep-restricted-file-list
  2617. ;; There is a request to keep the file list in place
  2618. (put 'org-agenda-files 'org-restrict nil))
  2619. (setq org-agenda-restrict nil)
  2620. (move-marker org-agenda-restrict-begin nil)
  2621. (move-marker org-agenda-restrict-end nil))
  2622. ;; Delete old local properties
  2623. (put 'org-agenda-redo-command 'org-lprops nil)
  2624. ;; Delete previously set last-arguments
  2625. (put 'org-agenda-redo-command 'last-args nil)
  2626. ;; Remember where this call originated
  2627. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2628. (unless org-keys
  2629. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2630. org-keys (car ans)
  2631. restriction (cdr ans)))
  2632. ;; If we have sticky agenda buffers, set a name for the buffer,
  2633. ;; depending on the invoking keys. The user may still set this
  2634. ;; as a command option, which will overwrite what we do here.
  2635. (when org-agenda-sticky
  2636. (setq org-agenda-buffer-name
  2637. (format "*Org Agenda(%s)*" org-keys)))
  2638. ;; Establish the restriction, if any
  2639. (when (and (not org-agenda-overriding-restriction) restriction)
  2640. (put 'org-agenda-files 'org-restrict (list bfn))
  2641. (cond
  2642. ((eq restriction 'region)
  2643. (setq org-agenda-restrict (current-buffer))
  2644. (move-marker org-agenda-restrict-begin (region-beginning))
  2645. (move-marker org-agenda-restrict-end (region-end)))
  2646. ((eq restriction 'subtree)
  2647. (save-excursion
  2648. (setq org-agenda-restrict (current-buffer))
  2649. (org-back-to-heading t)
  2650. (move-marker org-agenda-restrict-begin (point))
  2651. (move-marker org-agenda-restrict-end
  2652. (progn (org-end-of-subtree t)))))
  2653. ((and (eq restriction 'buffer)
  2654. (or (< 1 (point-min))
  2655. (< (point-max) (1+ (buffer-size)))))
  2656. (setq org-agenda-restrict (current-buffer))
  2657. (move-marker org-agenda-restrict-begin (point-min))
  2658. (move-marker org-agenda-restrict-end (point-max)))))
  2659. ;; For example the todo list should not need it (but does...)
  2660. (cond
  2661. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2662. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2663. (progn
  2664. ;; FIXME: Is (nth 3 entry) supposed to have access (via dynvars)
  2665. ;; to some of the local variables? There's no doc about
  2666. ;; that for `org-agenda-custom-commands'.
  2667. (setq type (nth 2 entry) org-match (eval (nth 3 entry) t)
  2668. lprops (nth 4 entry))
  2669. (when org-agenda-sticky
  2670. (setq org-agenda-buffer-name
  2671. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2672. (format "*Org Agenda(%s)*" org-keys))))
  2673. (put 'org-agenda-redo-command 'org-lprops lprops)
  2674. (cl-progv
  2675. (mapcar #'car lprops)
  2676. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  2677. (pcase type
  2678. (`agenda
  2679. (org-agenda-list arg))
  2680. (`agenda*
  2681. (org-agenda-list arg nil nil t))
  2682. (`alltodo
  2683. (org-todo-list arg))
  2684. (`search
  2685. (org-search-view arg org-match nil))
  2686. (`stuck
  2687. (org-agenda-list-stuck-projects arg))
  2688. (`tags
  2689. (org-tags-view arg org-match))
  2690. (`tags-todo
  2691. (org-tags-view '(4) org-match))
  2692. (`todo
  2693. (org-todo-list org-match))
  2694. (`tags-tree
  2695. (org-check-for-org-mode)
  2696. (org-match-sparse-tree arg org-match))
  2697. (`todo-tree
  2698. (org-check-for-org-mode)
  2699. (org-occur (concat "^" org-outline-regexp "[ \t]*"
  2700. (regexp-quote org-match) "\\>")))
  2701. (`occur-tree
  2702. (org-check-for-org-mode)
  2703. (org-occur org-match))
  2704. ((pred functionp)
  2705. (funcall type org-match))
  2706. ;; FIXME: Will signal an error since it's not `functionp'!
  2707. ((pred fboundp) (funcall type org-match))
  2708. (_ (user-error "Invalid custom agenda command type %s" type)))))
  2709. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2710. ((equal org-keys "C")
  2711. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2712. (customize-variable 'org-agenda-custom-commands))
  2713. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2714. ((equal org-keys "s") (call-interactively 'org-search-view))
  2715. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2716. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2717. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2718. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2719. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2720. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2721. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2722. (add-hook
  2723. 'post-command-hook
  2724. (lambda ()
  2725. (unless (current-message)
  2726. (let* ((m (org-agenda-get-any-marker))
  2727. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2728. (when note
  2729. (message "FLAGGING-NOTE ([?] for more info): %s"
  2730. (org-add-props
  2731. (replace-regexp-in-string
  2732. "\\\\n" "//"
  2733. (copy-sequence note))
  2734. nil 'face 'org-warning))))))
  2735. t t))
  2736. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2737. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2738. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2739. (t (user-error "Invalid agenda key"))))))
  2740. (defvar org-agenda-multi)
  2741. (defun org-agenda-append-agenda ()
  2742. "Append another agenda view to the current one.
  2743. This function allows interactive building of block agendas.
  2744. Agenda views are separated by `org-agenda-block-separator'."
  2745. (interactive)
  2746. (unless (derived-mode-p 'org-agenda-mode)
  2747. (user-error "Can only append from within agenda buffer"))
  2748. (let ((org-agenda-multi t))
  2749. (org-agenda)
  2750. (widen)
  2751. (org-agenda-finalize)
  2752. (setq buffer-read-only t)
  2753. (org-agenda-fit-window-to-buffer)))
  2754. (defun org-agenda-normalize-custom-commands (cmds)
  2755. "Normalize custom commands CMDS."
  2756. (delq nil
  2757. (mapcar
  2758. (lambda (x)
  2759. (cond ((stringp (cdr x)) nil)
  2760. ((stringp (nth 1 x)) x)
  2761. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2762. (t (cons (car x) (cons "" (cdr x))))))
  2763. cmds)))
  2764. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2765. "The user interface for selecting an agenda command."
  2766. (catch 'exit
  2767. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2768. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2769. (region-p (org-region-active-p))
  2770. (custom org-agenda-custom-commands)
  2771. (selstring "")
  2772. restriction second-time
  2773. c entry key type match prefixes rmheader header-end custom1 desc
  2774. line lines left right n n1)
  2775. (save-window-excursion
  2776. (delete-other-windows)
  2777. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2778. (erase-buffer)
  2779. (insert (eval-when-compile
  2780. (let ((header
  2781. (copy-sequence
  2782. "Press key for an agenda command:
  2783. -------------------------------- < Buffer, subtree/region restriction
  2784. a Agenda for current week or day > Remove restriction
  2785. t List of all TODO entries e Export agenda views
  2786. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2787. s Search for keywords M Like m, but only TODO entries
  2788. / Multi-occur S Like s, but only TODO entries
  2789. ? Find :FLAGGED: entries C Configure custom agenda commands
  2790. * Toggle sticky agenda views # List stuck projects (!=configure)
  2791. "))
  2792. (start 0))
  2793. (while (string-match
  2794. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2795. header start)
  2796. (setq start (match-end 0))
  2797. (add-text-properties (match-beginning 2) (match-end 2)
  2798. '(face bold) header))
  2799. header)))
  2800. (setq header-end (point-marker))
  2801. (while t
  2802. (setq custom1 custom)
  2803. (when (eq rmheader t)
  2804. (org-goto-line 1)
  2805. (re-search-forward ":" nil t)
  2806. (delete-region (match-end 0) (line-end-position))
  2807. (forward-char 1)
  2808. (looking-at "-+")
  2809. (delete-region (match-end 0) (line-end-position))
  2810. (move-marker header-end (match-end 0)))
  2811. (goto-char header-end)
  2812. (delete-region (point) (point-max))
  2813. ;; Produce all the lines that describe custom commands and prefixes
  2814. (setq lines nil)
  2815. (while (setq entry (pop custom1))
  2816. (setq key (car entry) desc (nth 1 entry)
  2817. type (nth 2 entry)
  2818. match (nth 3 entry))
  2819. (if (> (length key) 1)
  2820. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2821. (setq line
  2822. (format
  2823. "%-4s%-14s"
  2824. (org-add-props (copy-sequence key)
  2825. '(face bold))
  2826. (cond
  2827. ((string-match "\\S-" desc) desc)
  2828. ((eq type 'agenda) "Agenda for current week or day")
  2829. ((eq type 'agenda*) "Appointments for current week or day")
  2830. ((eq type 'alltodo) "List of all TODO entries")
  2831. ((eq type 'search) "Word search")
  2832. ((eq type 'stuck) "List of stuck projects")
  2833. ((eq type 'todo) "TODO keyword")
  2834. ((eq type 'tags) "Tags query")
  2835. ((eq type 'tags-todo) "Tags (TODO)")
  2836. ((eq type 'tags-tree) "Tags tree")
  2837. ((eq type 'todo-tree) "TODO kwd tree")
  2838. ((eq type 'occur-tree) "Occur tree")
  2839. ((functionp type) (if (symbolp type)
  2840. (symbol-name type)
  2841. "Lambda expression"))
  2842. (t "???"))))
  2843. (cond
  2844. ((not (org-string-nw-p match)) nil)
  2845. (org-agenda-menu-show-matcher
  2846. (setq line
  2847. (concat line ": "
  2848. (cond
  2849. ((stringp match)
  2850. (propertize match 'face 'org-warning))
  2851. ((listp type)
  2852. (format "set of %d commands" (length type)))))))
  2853. (t
  2854. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2855. (push line lines)))
  2856. (setq lines (nreverse lines))
  2857. (when prefixes
  2858. (mapc (lambda (x)
  2859. (push
  2860. (format "%s %s"
  2861. (org-add-props (char-to-string x)
  2862. nil 'face 'bold)
  2863. (or (cdr (assoc (concat selstring
  2864. (char-to-string x))
  2865. prefix-descriptions))
  2866. "Prefix key"))
  2867. lines))
  2868. prefixes))
  2869. ;; Check if we should display in two columns
  2870. (if org-agenda-menu-two-columns
  2871. (progn
  2872. (setq n (length lines)
  2873. n1 (+ (/ n 2) (mod n 2))
  2874. right (nthcdr n1 lines)
  2875. left (copy-sequence lines))
  2876. (setcdr (nthcdr (1- n1) left) nil))
  2877. (setq left lines right nil))
  2878. (while left
  2879. (insert "\n" (pop left))
  2880. (when right
  2881. (if (< (current-column) 40)
  2882. (move-to-column 40 t)
  2883. (insert " "))
  2884. (insert (pop right))))
  2885. ;; Make the window the right size
  2886. (goto-char (point-min))
  2887. (if second-time
  2888. (when (not (pos-visible-in-window-p (point-max)))
  2889. (org-fit-window-to-buffer))
  2890. (setq second-time t)
  2891. (org-fit-window-to-buffer))
  2892. ;; Hint to navigation if window too small for all information
  2893. (setq header-line-format
  2894. (when (not (pos-visible-in-window-p (point-max)))
  2895. "Use C-v, M-v, C-n or C-p to navigate."))
  2896. ;; Ask for selection
  2897. (cl-loop
  2898. do (progn
  2899. (message "Press key for agenda command%s:"
  2900. (if (or restrict-ok org-agenda-overriding-restriction)
  2901. (if org-agenda-overriding-restriction
  2902. " (restriction lock active)"
  2903. (if restriction
  2904. (format " (restricted to %s)" restriction)
  2905. " (unrestricted)"))
  2906. ""))
  2907. (setq c (read-char-exclusive)))
  2908. until (not (memq c '(14 16 22 134217846)))
  2909. do (org-scroll c))
  2910. (message "")
  2911. (cond
  2912. ((assoc (char-to-string c) custom)
  2913. (setq selstring (concat selstring (char-to-string c)))
  2914. (throw 'exit (cons selstring restriction)))
  2915. ((memq c prefixes)
  2916. (setq selstring (concat selstring (char-to-string c))
  2917. prefixes nil
  2918. rmheader (or rmheader t)
  2919. custom (delq nil (mapcar
  2920. (lambda (x)
  2921. (if (or (= (length (car x)) 1)
  2922. (/= (string-to-char (car x)) c))
  2923. nil
  2924. (cons (substring (car x) 1) (cdr x))))
  2925. custom))))
  2926. ((eq c ?*)
  2927. (call-interactively 'org-toggle-sticky-agenda)
  2928. (sit-for 2))
  2929. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2930. (message "Restriction is only possible in Org buffers")
  2931. (ding) (sit-for 1))
  2932. ((eq c ?1)
  2933. (org-agenda-remove-restriction-lock 'noupdate)
  2934. (setq restriction 'buffer))
  2935. ((eq c ?0)
  2936. (org-agenda-remove-restriction-lock 'noupdate)
  2937. (setq restriction (if region-p 'region 'subtree)))
  2938. ((eq c ?<)
  2939. (org-agenda-remove-restriction-lock 'noupdate)
  2940. (setq restriction
  2941. (cond
  2942. ((eq restriction 'buffer)
  2943. (if region-p 'region 'subtree))
  2944. ((memq restriction '(subtree region))
  2945. nil)
  2946. (t 'buffer))))
  2947. ((eq c ?>)
  2948. (org-agenda-remove-restriction-lock 'noupdate)
  2949. (setq restriction nil))
  2950. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2951. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2952. ((and (> (length selstring) 0) (eq c ?\d))
  2953. (delete-window)
  2954. (org-agenda-get-restriction-and-command prefix-descriptions))
  2955. ((equal c ?q) (user-error "Abort"))
  2956. (t (user-error "Invalid key %c" c))))))))
  2957. (defun org-agenda-fit-window-to-buffer ()
  2958. "Fit the window to the buffer size."
  2959. (and (memq org-agenda-window-setup '(reorganize-frame))
  2960. (fboundp 'fit-window-to-buffer)
  2961. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2962. (= (car org-agenda-window-frame-fractions) 1.0))
  2963. (delete-other-windows)
  2964. (org-fit-window-to-buffer
  2965. nil
  2966. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2967. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2968. (defvar org-cmd nil)
  2969. (defvar org-agenda-overriding-cmd nil)
  2970. (defvar org-agenda-overriding-arguments nil)
  2971. (defvar org-agenda-overriding-cmd-arguments nil)
  2972. (defun org-let (list &rest body) ;FIXME: So many kittens are suffering here.
  2973. (declare (indent 1) (obsolete cl-progv "2021"))
  2974. (eval (cons 'let (cons list body))))
  2975. (defun org-let2 (list1 list2 &rest body) ;FIXME: Where did our karma go?
  2976. (declare (indent 2) (obsolete cl-progv "2021"))
  2977. (eval (cons 'let (cons list1 (list (cons 'let (cons list2 body)))))))
  2978. (defun org-agenda-run-series (name series)
  2979. "Run agenda NAME as a SERIES of agenda commands."
  2980. (let* ((gprops (nth 1 series))
  2981. (gvars (mapcar #'car gprops))
  2982. (gvals (mapcar (lambda (binding) (eval (cadr binding) t)) gprops)))
  2983. (cl-progv gvars gvals (org-agenda-prepare name))
  2984. ;; We need to reset agenda markers here, because when constructing a
  2985. ;; block agenda, the individual blocks do not do that.
  2986. (org-agenda-reset-markers)
  2987. (with-no-warnings
  2988. (defvar match)) ;Used via the `eval' below.
  2989. (let* ((org-agenda-multi t)
  2990. ;; FIXME: Redo should contain lists of (FUNS . ARGS) rather
  2991. ;; than expressions, so you don't need to `quote' the args
  2992. ;; and you just need to `apply' instead of `eval' when using it.
  2993. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2994. (cmds (car series))
  2995. match
  2996. org-cmd type lprops)
  2997. (while (setq org-cmd (pop cmds))
  2998. (setq type (car org-cmd))
  2999. (setq match (eval (nth 1 org-cmd) t))
  3000. (setq lprops (nth 2 org-cmd))
  3001. (let ((org-agenda-overriding-arguments
  3002. (if (eq org-agenda-overriding-cmd org-cmd)
  3003. (or org-agenda-overriding-arguments
  3004. org-agenda-overriding-cmd-arguments)))
  3005. (lvars (mapcar #'car lprops))
  3006. (lvals (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)))
  3007. (cl-progv (append gvars lvars) (append gvals lvals)
  3008. (pcase type
  3009. (`agenda
  3010. (call-interactively 'org-agenda-list))
  3011. (`agenda*
  3012. (funcall 'org-agenda-list nil nil t))
  3013. (`alltodo
  3014. (call-interactively 'org-todo-list))
  3015. (`search
  3016. (org-search-view current-prefix-arg match nil))
  3017. (`stuck
  3018. (call-interactively 'org-agenda-list-stuck-projects))
  3019. (`tags
  3020. (org-tags-view current-prefix-arg match))
  3021. (`tags-todo
  3022. (org-tags-view '(4) match))
  3023. (`todo
  3024. (org-todo-list match))
  3025. ((pred fboundp)
  3026. (funcall type match))
  3027. (_ (error "Invalid type in command series"))))))
  3028. (widen)
  3029. (let ((inhibit-read-only t))
  3030. (add-text-properties (point-min) (point-max)
  3031. `(org-series t org-series-redo-cmd ,redo)))
  3032. (setq org-agenda-redo-command redo)
  3033. (goto-char (point-min)))
  3034. (org-agenda-fit-window-to-buffer)
  3035. (cl-progv gvars gvals (org-agenda-finalize))))
  3036. (defun org-agenda--split-plist (plist)
  3037. ;; We could/should arguably use `map-keys' and `map-values'.
  3038. (let (keys vals)
  3039. (while plist
  3040. (push (pop plist) keys)
  3041. (push (pop plist) vals))
  3042. (cons (nreverse keys) (nreverse vals))))
  3043. ;;;###autoload
  3044. (defmacro org-batch-agenda (cmd-key &rest parameters)
  3045. "Run an agenda command in batch mode and send the result to STDOUT.
  3046. If CMD-KEY is a string of length 1, it is used as a key in
  3047. `org-agenda-custom-commands' and triggers this command. If it is a
  3048. longer string it is used as a tags/todo match string.
  3049. Parameters are alternating variable names and values that will be bound
  3050. before running the agenda command."
  3051. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3052. `(org--batch-agenda ,cmd-key ',vars (list ,@exps))))
  3053. (defun org--batch-agenda (cmd-key vars vals)
  3054. ;; `org-batch-agenda' is a macro because every other "parameter" is
  3055. ;; a variable name rather than an expression to evaluate. Yuck!
  3056. (cl-progv vars vals
  3057. (let (org-agenda-sticky)
  3058. (if (> (length cmd-key) 1)
  3059. (org-tags-view nil cmd-key)
  3060. (org-agenda nil cmd-key))))
  3061. (set-buffer org-agenda-buffer-name)
  3062. (princ (buffer-string)))
  3063. (defvar org-agenda-info nil)
  3064. ;;;###autoload
  3065. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  3066. "Run an agenda command in batch mode and send the result to STDOUT.
  3067. If CMD-KEY is a string of length 1, it is used as a key in
  3068. `org-agenda-custom-commands' and triggers this command. If it is a
  3069. longer string it is used as a tags/todo match string.
  3070. Parameters are alternating variable names and values that will be bound
  3071. before running the agenda command.
  3072. The output gives a line for each selected agenda item. Each
  3073. item is a list of comma-separated values, like this:
  3074. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  3075. category The category of the item
  3076. head The headline, without TODO kwd, TAGS and PRIORITY
  3077. type The type of the agenda entry, can be
  3078. todo selected in TODO match
  3079. tagsmatch selected in tags match
  3080. diary imported from diary
  3081. deadline a deadline on given date
  3082. scheduled scheduled on given date
  3083. timestamp entry has timestamp on given date
  3084. closed entry was closed on given date
  3085. upcoming-deadline warning about deadline
  3086. past-scheduled forwarded scheduled item
  3087. block entry has date block including g. date
  3088. todo The todo keyword, if any
  3089. tags All tags including inherited ones, separated by colons
  3090. date The relevant date, like 2007-2-14
  3091. time The time, like 15:00-16:50
  3092. extra String with extra planning info
  3093. priority-l The priority letter if any was given
  3094. priority-n The computed numerical priority
  3095. agenda-day The day in the agenda where this is listed"
  3096. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3097. `(org--batch-agenda-csv ,cmd-key ',vars (list ,@exps))))
  3098. (defun org--batch-agenda-csv (cmd-key vars vals)
  3099. ;; `org-batch-agenda-csv' is a macro because every other "parameter" is
  3100. ;; a variable name rather than an expression to evaluate. Yuck!
  3101. (let ((org-agenda-remove-tags t))
  3102. (cl-progv vars vals
  3103. ;; FIXME: Shouldn't this be 1 (see commit 10173ad6d610b)?
  3104. (if (> (length cmd-key) 2)
  3105. (org-tags-view nil cmd-key)
  3106. (org-agenda nil cmd-key))))
  3107. (set-buffer org-agenda-buffer-name)
  3108. (let ((lines (org-split-string (buffer-string) "\n")))
  3109. (dolist (line lines)
  3110. (when (get-text-property 0 'org-category line)
  3111. (setq org-agenda-info
  3112. (org-fix-agenda-info (text-properties-at 0 line)))
  3113. (princ
  3114. (mapconcat #'org-agenda-export-csv-mapper
  3115. '(org-category txt type todo tags date time extra
  3116. priority-letter priority agenda-day)
  3117. ","))
  3118. (princ "\n")))))
  3119. (defun org-fix-agenda-info (props)
  3120. "Make sure all properties on an agenda item have a canonical form.
  3121. This ensures the export commands can easily use it."
  3122. (let (tmp re)
  3123. (when (setq tmp (plist-get props 'tags))
  3124. (setq props (plist-put props 'tags (mapconcat #'identity tmp ":"))))
  3125. (when (setq tmp (plist-get props 'date))
  3126. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3127. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3128. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3129. (setq tmp (calendar-date-string tmp)))
  3130. (setq props (plist-put props 'date tmp)))
  3131. (when (setq tmp (plist-get props 'day))
  3132. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3133. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3134. (setq tmp (calendar-date-string tmp)))
  3135. (setq props (plist-put props 'day tmp))
  3136. (setq props (plist-put props 'agenda-day tmp)))
  3137. (when (setq tmp (plist-get props 'txt))
  3138. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3139. (plist-put props 'priority-letter (match-string 1 tmp))
  3140. (setq tmp (replace-match "" t t tmp)))
  3141. (when (and (setq re (plist-get props 'org-todo-regexp))
  3142. (setq re (concat "\\`\\.*" re " ?"))
  3143. (let ((case-fold-search nil)) (string-match re tmp)))
  3144. (plist-put props 'todo (match-string 1 tmp))
  3145. (setq tmp (replace-match "" t t tmp)))
  3146. (plist-put props 'txt tmp)))
  3147. props)
  3148. (defun org-agenda-export-csv-mapper (prop)
  3149. (let ((res (plist-get org-agenda-info prop)))
  3150. (setq res
  3151. (cond
  3152. ((not res) "")
  3153. ((stringp res) res)
  3154. (t (prin1-to-string res))))
  3155. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3156. ;;;###autoload
  3157. (defun org-store-agenda-views (&rest _parameters)
  3158. "Store agenda views."
  3159. (interactive)
  3160. (org--batch-store-agenda-views nil nil))
  3161. ;;;###autoload
  3162. (defmacro org-batch-store-agenda-views (&rest parameters)
  3163. "Run all custom agenda commands that have a file argument."
  3164. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3165. `(org--batch-store-agenda-views ',vars (list ,@exps))))
  3166. (defun org--batch-store-agenda-views (vars vals)
  3167. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3168. (pop-up-frames nil)
  3169. (dir default-directory)
  3170. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3171. (save-window-excursion
  3172. (while cmds
  3173. (setq cmd (pop cmds)
  3174. thiscmdkey (car cmd)
  3175. thiscmdcmd (cdr cmd)
  3176. match (nth 2 thiscmdcmd)
  3177. bufname (if org-agenda-sticky
  3178. (or (and (stringp match)
  3179. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3180. (format "*Org Agenda(%s)*" thiscmdkey))
  3181. org-agenda-buffer-name)
  3182. cmd-or-set (nth 2 cmd)
  3183. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3184. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3185. (if (stringp files) (setq files (list files)))
  3186. (when files
  3187. (let* ((opts (append org-agenda-exporter-settings opts))
  3188. (vars (append (mapcar #'car opts) vars))
  3189. (vals (append (mapcar (lambda (binding) (eval (cadr binding) t))
  3190. opts)
  3191. vals)))
  3192. (cl-progv vars vals
  3193. (org-agenda nil thiscmdkey))
  3194. (set-buffer bufname)
  3195. (while files
  3196. (cl-progv vars vals
  3197. (org-agenda-write (expand-file-name (pop files) dir)
  3198. nil t bufname))))
  3199. (and (get-buffer bufname)
  3200. (kill-buffer bufname)))))))
  3201. (defvar org-agenda-current-span nil
  3202. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3203. (defun org-agenda-mark-header-line (pos)
  3204. "Mark the line at POS as an agenda structure header."
  3205. (save-excursion
  3206. (goto-char pos)
  3207. (put-text-property (line-beginning-position) (line-end-position)
  3208. 'org-agenda-structural-header t)
  3209. (when org-agenda-title-append
  3210. (put-text-property (line-beginning-position) (line-end-position)
  3211. 'org-agenda-title-append org-agenda-title-append))))
  3212. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3213. (defvar org-agenda-write-buffer-name "Agenda View")
  3214. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3215. "Write the current buffer (an agenda view) as a file.
  3216. Depending on the extension of the file name, plain text (.txt),
  3217. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3218. If the extension is .ics, translate visible agenda into iCalendar
  3219. format. If the extension is .org, collect all subtrees
  3220. corresponding to the agenda entries and add them in an .org file.
  3221. With prefix argument OPEN, open the new file immediately. If
  3222. NOSETTINGS is given, do not scope the settings of
  3223. `org-agenda-exporter-settings' into the export commands. This is
  3224. used when the settings have already been scoped and we do not
  3225. wish to overrule other, higher priority settings. If
  3226. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3227. the agenda to write."
  3228. (interactive "FWrite agenda to file: \nP")
  3229. (if (or (not (file-writable-p file))
  3230. (and (file-exists-p file)
  3231. (if (called-interactively-p 'any)
  3232. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3233. (user-error "Cannot write agenda to file %s" file))
  3234. (cl-progv
  3235. (if nosettings nil (mapcar #'car org-agenda-exporter-settings))
  3236. (if nosettings nil (mapcar (lambda (binding) (eval (cadr binding) t))
  3237. org-agenda-exporter-settings))
  3238. (save-excursion
  3239. (save-window-excursion
  3240. (let ((bs (copy-sequence (buffer-string)))
  3241. (extension (file-name-extension file))
  3242. (default-directory (file-name-directory file))
  3243. ) ;; beg content
  3244. (with-temp-buffer
  3245. (rename-buffer org-agenda-write-buffer-name t)
  3246. (set-buffer-modified-p nil)
  3247. (insert bs)
  3248. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3249. (run-hooks 'org-agenda-before-write-hook)
  3250. (cond
  3251. ((bound-and-true-p org-mobile-creating-agendas)
  3252. (org-mobile-write-agenda-for-mobile file))
  3253. ((string= "org" extension)
  3254. (let (content p m message-log-max)
  3255. (goto-char (point-min))
  3256. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3257. (goto-char p)
  3258. (setq m (get-text-property (point) 'org-hd-marker))
  3259. (when m
  3260. (push (with-current-buffer (marker-buffer m)
  3261. (goto-char m)
  3262. (org-copy-subtree 1 nil t t)
  3263. org-subtree-clip)
  3264. content)))
  3265. (find-file file)
  3266. (erase-buffer)
  3267. (dolist (s content) (org-paste-subtree 1 s))
  3268. (write-file file)
  3269. (kill-buffer (current-buffer))
  3270. (message "Org file written to %s" file)))
  3271. ((member extension '("html" "htm"))
  3272. (or (require 'htmlize nil t)
  3273. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3274. (declare-function htmlize-buffer "htmlize" (&optional buffer))
  3275. (set-buffer (htmlize-buffer (current-buffer)))
  3276. (when org-agenda-export-html-style
  3277. ;; replace <style> section with org-agenda-export-html-style
  3278. (goto-char (point-min))
  3279. (kill-region (- (search-forward "<style") 6)
  3280. (search-forward "</style>"))
  3281. (insert org-agenda-export-html-style))
  3282. (write-file file)
  3283. (kill-buffer (current-buffer))
  3284. (message "HTML written to %s" file))
  3285. ((string= "ps" extension)
  3286. (require 'ps-print)
  3287. (ps-print-buffer-with-faces file)
  3288. (message "Postscript written to %s" file))
  3289. ((string= "pdf" extension)
  3290. (require 'ps-print)
  3291. (ps-print-buffer-with-faces
  3292. (concat (file-name-sans-extension file) ".ps"))
  3293. (call-process "ps2pdf" nil nil nil
  3294. (expand-file-name
  3295. (concat (file-name-sans-extension file) ".ps"))
  3296. (expand-file-name file))
  3297. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3298. (message "PDF written to %s" file))
  3299. ((string= "ics" extension)
  3300. (require 'ox-icalendar)
  3301. (declare-function org-icalendar-export-current-agenda
  3302. "ox-icalendar" (file))
  3303. (org-icalendar-export-current-agenda (expand-file-name file)))
  3304. (t
  3305. (let ((bs (buffer-string)))
  3306. (find-file file)
  3307. (erase-buffer)
  3308. (insert bs)
  3309. (save-buffer 0)
  3310. (kill-buffer (current-buffer))
  3311. (message "Plain text written to %s" file))))))))
  3312. (set-buffer (or agenda-bufname
  3313. ;; FIXME: I'm pretty sure called-interactively-p
  3314. ;; doesn't do what we want here!
  3315. (and (called-interactively-p 'any) (buffer-name))
  3316. org-agenda-buffer-name)))
  3317. (when open (org-open-file file)))
  3318. (defun org-agenda-remove-marked-text (property &optional value)
  3319. "Delete all text marked with VALUE of PROPERTY.
  3320. VALUE defaults to t."
  3321. (let (beg)
  3322. (setq value (or value t))
  3323. (while (setq beg (text-property-any (point-min) (point-max)
  3324. property value))
  3325. (delete-region
  3326. beg (or (next-single-property-change beg property)
  3327. (point-max))))))
  3328. (defun org-agenda-add-entry-text ()
  3329. "Add entry text to agenda lines.
  3330. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3331. entry text following headings shown in the agenda.
  3332. Drawers will be excluded, also the line with scheduling/deadline info."
  3333. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3334. (not (bound-and-true-p org-mobile-creating-agendas)))
  3335. (let (m txt)
  3336. (goto-char (point-min))
  3337. (while (not (eobp))
  3338. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3339. (beginning-of-line 2)
  3340. (setq txt (org-agenda-get-some-entry-text
  3341. m org-agenda-add-entry-text-maxlines " > "))
  3342. (end-of-line 1)
  3343. (if (string-match "\\S-" txt)
  3344. (insert "\n" txt)
  3345. (or (eobp) (forward-char 1))))))))
  3346. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3347. &rest keep)
  3348. "Extract entry text from MARKER, at most N-LINES lines.
  3349. This will ignore drawers etc, just get the text.
  3350. If INDENT is given, prefix every line with this string. If KEEP is
  3351. given, it is a list of symbols, defining stuff that should not be
  3352. removed from the entry content. Currently only `planning' is allowed here."
  3353. (let (txt drawer-re kwd-time-re ind)
  3354. (save-excursion
  3355. (with-current-buffer (marker-buffer marker)
  3356. (if (not (derived-mode-p 'org-mode))
  3357. (setq txt "")
  3358. (org-with-wide-buffer
  3359. (goto-char marker)
  3360. (end-of-line 1)
  3361. (setq txt (buffer-substring
  3362. (min (1+ (point)) (point-max))
  3363. (progn (outline-next-heading) (point)))
  3364. drawer-re org-drawer-regexp
  3365. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3366. ".*\n?"))
  3367. (with-temp-buffer
  3368. (insert txt)
  3369. (when org-agenda-add-entry-text-descriptive-links
  3370. (goto-char (point-min))
  3371. (while (org-activate-links (point-max))
  3372. (goto-char (match-end 0))))
  3373. (goto-char (point-min))
  3374. (while (re-search-forward org-link-bracket-re (point-max) t)
  3375. (set-text-properties (match-beginning 0) (match-end 0)
  3376. nil))
  3377. (goto-char (point-min))
  3378. (while (re-search-forward drawer-re nil t)
  3379. (delete-region
  3380. (match-beginning 0)
  3381. (progn (re-search-forward
  3382. "^[ \t]*:END:.*\n?" nil 'move)
  3383. (point))))
  3384. (unless (member 'planning keep)
  3385. (goto-char (point-min))
  3386. (while (re-search-forward kwd-time-re nil t)
  3387. (replace-match "")))
  3388. (goto-char (point-min))
  3389. (when org-agenda-entry-text-exclude-regexps
  3390. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3391. (while (setq re (pop re-list))
  3392. (goto-char (point-min))
  3393. (while (re-search-forward re nil t)
  3394. (replace-match "")))))
  3395. (goto-char (point-max))
  3396. (skip-chars-backward " \t\n")
  3397. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3398. ;; find and remove min common indentation
  3399. (goto-char (point-min))
  3400. (untabify (point-min) (point-max))
  3401. (setq ind (current-indentation))
  3402. (while (not (eobp))
  3403. (unless (looking-at "[ \t]*$")
  3404. (setq ind (min ind (current-indentation))))
  3405. (beginning-of-line 2))
  3406. (goto-char (point-min))
  3407. (while (not (eobp))
  3408. (unless (looking-at "[ \t]*$")
  3409. (move-to-column ind)
  3410. (delete-region (line-beginning-position) (point)))
  3411. (beginning-of-line 2))
  3412. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3413. (goto-char (point-min))
  3414. (when indent
  3415. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3416. (replace-match indent t t)))
  3417. (goto-char (point-min))
  3418. (while (looking-at "[ \t]*\n") (replace-match ""))
  3419. (goto-char (point-max))
  3420. (when (> (org-current-line)
  3421. n-lines)
  3422. (org-goto-line (1+ n-lines))
  3423. (backward-char 1))
  3424. (setq txt (buffer-substring (point-min) (point))))))))
  3425. txt))
  3426. (defun org-check-for-org-mode ()
  3427. "Make sure current buffer is in Org mode. Error if not."
  3428. (or (derived-mode-p 'org-mode)
  3429. (error "Cannot execute Org agenda command on buffer in %s"
  3430. major-mode)))
  3431. ;;; Agenda prepare and finalize
  3432. (defvar org-agenda-multi nil) ; dynamically scoped
  3433. (defvar org-agenda-pre-window-conf nil)
  3434. (defvar org-agenda-columns-active nil)
  3435. (defvar org-agenda-name nil)
  3436. (defvar org-agenda-tag-filter nil)
  3437. (defvar org-agenda-category-filter nil)
  3438. (defvar org-agenda-regexp-filter nil)
  3439. (defvar org-agenda-effort-filter nil)
  3440. (defvar org-agenda-top-headline-filter nil)
  3441. (defvar org-agenda-represented-categories nil
  3442. "Cache for the list of all categories in the agenda.")
  3443. (defvar org-agenda-represented-tags nil
  3444. "Cache for the list of all categories in the agenda.")
  3445. (defvar org-agenda-tag-filter-preset nil
  3446. "A preset of the tags filter used for secondary agenda filtering.
  3447. This must be a list of strings, each string must be a single tag preceded
  3448. by \"+\" or \"-\".
  3449. This variable should not be set directly, but agenda custom commands can
  3450. bind it in the options section. The preset filter is a global property of
  3451. the entire agenda view. In a block agenda, it will not work reliably to
  3452. define a filter for one of the individual blocks. You need to set it in
  3453. the global options and expect it to be applied to the entire view.")
  3454. (defconst org-agenda-filter-variables
  3455. '((category . org-agenda-category-filter)
  3456. (tag . org-agenda-tag-filter)
  3457. (effort . org-agenda-effort-filter)
  3458. (regexp . org-agenda-regexp-filter))
  3459. "Alist of filter types and associated variables.")
  3460. (defun org-agenda-filter-any ()
  3461. "Is any filter active?"
  3462. (cl-some (lambda (x)
  3463. (or (symbol-value (cdr x))
  3464. (get :preset-filter x)))
  3465. org-agenda-filter-variables))
  3466. (defvar org-agenda-category-filter-preset nil
  3467. "A preset of the category filter used for secondary agenda filtering.
  3468. This must be a list of strings, each string must be a single category
  3469. preceded by \"+\" or \"-\".
  3470. This variable should not be set directly, but agenda custom commands can
  3471. bind it in the options section. The preset filter is a global property of
  3472. the entire agenda view. In a block agenda, it will not work reliably to
  3473. define a filter for one of the individual blocks. You need to set it in
  3474. the global options and expect it to be applied to the entire view.")
  3475. (defvar org-agenda-regexp-filter-preset nil
  3476. "A preset of the regexp filter used for secondary agenda filtering.
  3477. This must be a list of strings, each string must be a single regexp
  3478. preceded by \"+\" or \"-\".
  3479. This variable should not be set directly, but agenda custom commands can
  3480. bind it in the options section. The preset filter is a global property of
  3481. the entire agenda view. In a block agenda, it will not work reliably to
  3482. define a filter for one of the individual blocks. You need to set it in
  3483. the global options and expect it to be applied to the entire view.")
  3484. (defvar org-agenda-effort-filter-preset nil
  3485. "A preset of the effort condition used for secondary agenda filtering.
  3486. This must be a list of strings, each string must be a single regexp
  3487. preceded by \"+\" or \"-\".
  3488. This variable should not be set directly, but agenda custom commands can
  3489. bind it in the options section. The preset filter is a global property of
  3490. the entire agenda view. In a block agenda, it will not work reliably to
  3491. define a filter for one of the individual blocks. You need to set it in
  3492. the global options and expect it to be applied to the entire view.")
  3493. (defun org-agenda-use-sticky-p ()
  3494. "Return non-nil if an agenda buffer named
  3495. `org-agenda-buffer-name' exists and should be shown instead of
  3496. generating a new one."
  3497. (and
  3498. ;; turned off by user
  3499. org-agenda-sticky
  3500. ;; For multi-agenda buffer already exists
  3501. (not org-agenda-multi)
  3502. ;; buffer found
  3503. (get-buffer org-agenda-buffer-name)
  3504. ;; C-u parameter is same as last call
  3505. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3506. (and
  3507. (equal current-prefix-arg
  3508. org-agenda-last-prefix-arg)
  3509. ;; In case user turned stickiness on, while having existing
  3510. ;; Agenda buffer active, don't reuse that buffer, because it
  3511. ;; does not have org variables local
  3512. org-agenda-this-buffer-is-sticky))))
  3513. (defvar org-agenda-buffer-tmp-name nil)
  3514. (defun org-agenda--get-buffer-name (sticky-name)
  3515. (or org-agenda-buffer-tmp-name
  3516. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3517. sticky-name
  3518. "*Org Agenda*"))
  3519. (defun org-agenda-prepare-window (abuf filter-alist)
  3520. "Setup agenda buffer in the window.
  3521. ABUF is the buffer for the agenda window.
  3522. FILTER-ALIST is an alist of filters we need to apply when
  3523. `org-agenda-persistent-filter' is non-nil."
  3524. (let* ((awin (get-buffer-window abuf)) wconf)
  3525. (cond
  3526. ((equal (current-buffer) abuf) nil)
  3527. (awin (select-window awin))
  3528. ((not (setq wconf (current-window-configuration))))
  3529. ((eq org-agenda-window-setup 'current-window)
  3530. (pop-to-buffer-same-window abuf))
  3531. ((eq org-agenda-window-setup 'other-window)
  3532. (org-switch-to-buffer-other-window abuf))
  3533. ((eq org-agenda-window-setup 'other-frame)
  3534. (switch-to-buffer-other-frame abuf))
  3535. ((eq org-agenda-window-setup 'other-tab)
  3536. (if (fboundp 'switch-to-buffer-other-tab)
  3537. (switch-to-buffer-other-tab abuf)
  3538. (user-error "Your version of Emacs does not have tab bar support")))
  3539. ((eq org-agenda-window-setup 'only-window)
  3540. (delete-other-windows)
  3541. (pop-to-buffer-same-window abuf))
  3542. ((eq org-agenda-window-setup 'reorganize-frame)
  3543. (delete-other-windows)
  3544. (org-switch-to-buffer-other-window abuf)))
  3545. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3546. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3547. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3548. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3549. ;; Additional test in case agenda is invoked from within agenda
  3550. ;; buffer via elisp link.
  3551. (unless (equal (current-buffer) abuf)
  3552. (pop-to-buffer-same-window abuf))
  3553. (setq org-agenda-pre-window-conf
  3554. (or wconf org-agenda-pre-window-conf))))
  3555. (defun org-agenda-prepare (&optional name)
  3556. (let ((filter-alist (when org-agenda-persistent-filter
  3557. (with-current-buffer
  3558. (get-buffer-create org-agenda-buffer-name)
  3559. `((tag . ,org-agenda-tag-filter)
  3560. (re . ,org-agenda-regexp-filter)
  3561. (effort . ,org-agenda-effort-filter)
  3562. (cat . ,org-agenda-category-filter))))))
  3563. (if (org-agenda-use-sticky-p)
  3564. (progn
  3565. (put 'org-agenda-tag-filter :preset-filter nil)
  3566. (put 'org-agenda-category-filter :preset-filter nil)
  3567. (put 'org-agenda-regexp-filter :preset-filter nil)
  3568. (put 'org-agenda-effort-filter :preset-filter nil)
  3569. ;; Popup existing buffer
  3570. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3571. filter-alist)
  3572. (message "Sticky Agenda buffer, use `r' to refresh")
  3573. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3574. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3575. (setq org-todo-keywords-for-agenda nil)
  3576. (put 'org-agenda-tag-filter :preset-filter
  3577. org-agenda-tag-filter-preset)
  3578. (put 'org-agenda-category-filter :preset-filter
  3579. org-agenda-category-filter-preset)
  3580. (put 'org-agenda-regexp-filter :preset-filter
  3581. org-agenda-regexp-filter-preset)
  3582. (put 'org-agenda-effort-filter :preset-filter
  3583. org-agenda-effort-filter-preset)
  3584. (if org-agenda-multi
  3585. (progn
  3586. (setq buffer-read-only nil)
  3587. (goto-char (point-max))
  3588. (unless (or (bobp) org-agenda-compact-blocks
  3589. (not org-agenda-block-separator))
  3590. (insert "\n"
  3591. (if (stringp org-agenda-block-separator)
  3592. org-agenda-block-separator
  3593. (make-string (window-max-chars-per-line) org-agenda-block-separator))
  3594. "\n"))
  3595. (narrow-to-region (point) (point-max)))
  3596. (setq org-done-keywords-for-agenda nil)
  3597. ;; Setting any org variables that are in org-agenda-local-vars
  3598. ;; list need to be done after the prepare call
  3599. (org-agenda-prepare-window
  3600. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3601. (setq buffer-read-only nil)
  3602. (org-agenda-reset-markers)
  3603. (let ((inhibit-read-only t)) (erase-buffer))
  3604. (org-agenda-mode)
  3605. (setq org-agenda-buffer (current-buffer))
  3606. (setq org-agenda-contributing-files nil)
  3607. (setq org-agenda-columns-active nil)
  3608. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3609. (setq org-todo-keywords-for-agenda
  3610. (org-uniquify org-todo-keywords-for-agenda))
  3611. (setq org-done-keywords-for-agenda
  3612. (org-uniquify org-done-keywords-for-agenda))
  3613. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3614. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3615. (and name (not org-agenda-name)
  3616. (setq-local org-agenda-name name)))
  3617. (setq buffer-read-only nil))))
  3618. (defvar org-overriding-columns-format)
  3619. (defvar org-local-columns-format)
  3620. (defun org-agenda-finalize ()
  3621. "Finishing touch for the agenda buffer.
  3622. This function is called just before displaying the agenda. If
  3623. you want to add your own functions to the finalization of the
  3624. agenda display, configure `org-agenda-finalize-hook'."
  3625. (unless org-agenda-multi
  3626. (let ((inhibit-read-only t))
  3627. (save-excursion
  3628. (goto-char (point-min))
  3629. (save-excursion
  3630. (while (org-activate-links (point-max))
  3631. (goto-char (match-end 0))))
  3632. (unless (eq org-agenda-remove-tags t)
  3633. (org-agenda-align-tags))
  3634. (unless org-agenda-with-colors
  3635. (remove-text-properties (point-min) (point-max) '(face nil)))
  3636. (when (bound-and-true-p org-overriding-columns-format)
  3637. (setq-local org-local-columns-format
  3638. org-overriding-columns-format))
  3639. (when org-agenda-view-columns-initially
  3640. (org-agenda-columns))
  3641. (when org-agenda-fontify-priorities
  3642. (org-agenda-fontify-priorities))
  3643. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3644. (org-agenda-dim-blocked-tasks))
  3645. (org-agenda-mark-clocking-task)
  3646. (when org-agenda-entry-text-mode
  3647. (org-agenda-entry-text-hide)
  3648. (org-agenda-entry-text-show))
  3649. (when (and (featurep 'org-habit)
  3650. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3651. (org-habit-insert-consistency-graphs))
  3652. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3653. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3654. (and (listp org-agenda-show-inherited-tags)
  3655. (memq org-agenda-type org-agenda-show-inherited-tags))
  3656. (and (eq org-agenda-show-inherited-tags t)
  3657. (or (eq org-agenda-use-tag-inheritance t)
  3658. (and (listp org-agenda-use-tag-inheritance)
  3659. (not (memq org-agenda-type
  3660. org-agenda-use-tag-inheritance))))))
  3661. (let (mrk)
  3662. (save-excursion
  3663. (goto-char (point-min))
  3664. (while (equal (forward-line) 0)
  3665. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3666. (put-text-property (line-beginning-position) (line-end-position)
  3667. 'tags
  3668. (org-with-point-at mrk
  3669. (org-get-tags))))))))
  3670. (setq org-agenda-represented-tags nil
  3671. org-agenda-represented-categories nil)
  3672. (when org-agenda-top-headline-filter
  3673. (org-agenda-filter-top-headline-apply
  3674. org-agenda-top-headline-filter))
  3675. (when org-agenda-tag-filter
  3676. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3677. (when (get 'org-agenda-tag-filter :preset-filter)
  3678. (org-agenda-filter-apply
  3679. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3680. (when org-agenda-category-filter
  3681. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3682. (when (get 'org-agenda-category-filter :preset-filter)
  3683. (org-agenda-filter-apply
  3684. (get 'org-agenda-category-filter :preset-filter) 'category))
  3685. (when org-agenda-regexp-filter
  3686. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3687. (when (get 'org-agenda-regexp-filter :preset-filter)
  3688. (org-agenda-filter-apply
  3689. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3690. (when org-agenda-effort-filter
  3691. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3692. (when (get 'org-agenda-effort-filter :preset-filter)
  3693. (org-agenda-filter-apply
  3694. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3695. (add-hook 'kill-buffer-hook #'org-agenda-reset-markers 'append 'local))
  3696. (run-hooks 'org-agenda-finalize-hook))))
  3697. (defun org-agenda-mark-clocking-task ()
  3698. "Mark the current clock entry in the agenda if it is present."
  3699. ;; We need to widen when `org-agenda-finalize' is called from
  3700. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in').
  3701. (when (bound-and-true-p org-clock-current-task)
  3702. (save-restriction
  3703. (widen)
  3704. (org-agenda-unmark-clocking-task)
  3705. (when (marker-buffer org-clock-hd-marker)
  3706. (save-excursion
  3707. (goto-char (point-min))
  3708. (let (s ov)
  3709. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3710. (goto-char s)
  3711. (when (equal (org-get-at-bol 'org-hd-marker)
  3712. org-clock-hd-marker)
  3713. (setq ov (make-overlay (line-beginning-position) (1+ (line-end-position))))
  3714. (overlay-put ov 'type 'org-agenda-clocking)
  3715. (overlay-put ov 'face 'org-agenda-clocking)
  3716. (overlay-put ov 'help-echo
  3717. "The clock is running in this item")))))))))
  3718. (defun org-agenda-unmark-clocking-task ()
  3719. "Unmark the current clocking task."
  3720. (mapc (lambda (o)
  3721. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3722. (delete-overlay o)))
  3723. (overlays-in (point-min) (point-max))))
  3724. (defun org-agenda-fontify-priorities ()
  3725. "Make highest priority lines bold, and lowest italic."
  3726. (interactive)
  3727. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3728. (delete-overlay o)))
  3729. (overlays-in (point-min) (point-max)))
  3730. (save-excursion
  3731. (let (b e p ov h l)
  3732. (goto-char (point-min))
  3733. (while (re-search-forward org-priority-regexp nil t)
  3734. (setq h (or (get-char-property (point) 'org-priority-highest)
  3735. org-priority-highest)
  3736. l (or (get-char-property (point) 'org-priority-lowest)
  3737. org-priority-lowest)
  3738. p (string-to-char (match-string 2))
  3739. b (match-beginning 1)
  3740. e (if (eq org-agenda-fontify-priorities 'cookies)
  3741. (1+ (match-end 2))
  3742. (line-end-position))
  3743. ov (make-overlay b e))
  3744. (overlay-put
  3745. ov 'face
  3746. (let ((special-face
  3747. (cond ((org-face-from-face-or-color
  3748. 'priority 'org-priority
  3749. (cdr (assoc p org-priority-faces))))
  3750. ((and (listp org-agenda-fontify-priorities)
  3751. (org-face-from-face-or-color
  3752. 'priority 'org-priority
  3753. (cdr (assoc p org-agenda-fontify-priorities)))))
  3754. ((equal p l) 'italic)
  3755. ((equal p h) 'bold))))
  3756. (if special-face (list special-face 'org-priority) 'org-priority)))
  3757. (overlay-put ov 'org-type 'org-priority)))))
  3758. (defvar org-depend-tag-blocked)
  3759. (defun org-agenda-dim-blocked-tasks (&optional _invisible)
  3760. "Dim currently blocked TODOs in the agenda display.
  3761. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3762. dimming them." ;FIXME: The arg isn't used, actually!
  3763. (interactive "P")
  3764. (when (called-interactively-p 'interactive)
  3765. (message "Dim or hide blocked tasks..."))
  3766. (dolist (o (overlays-in (point-min) (point-max)))
  3767. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3768. (delete-overlay o)))
  3769. (save-excursion
  3770. (let ((inhibit-read-only t))
  3771. (goto-char (point-min))
  3772. (while (let ((pos (text-property-not-all
  3773. (point) (point-max) 'org-todo-blocked nil)))
  3774. (when pos (goto-char pos)))
  3775. (let* ((invisible
  3776. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3777. (todo-blocked
  3778. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3779. (ov (make-overlay (if invisible
  3780. (line-end-position 0)
  3781. (line-beginning-position))
  3782. (line-end-position))))
  3783. (when todo-blocked
  3784. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3785. (when invisible
  3786. (org-agenda-filter-hide-line 'todo-blocked)))
  3787. (if (= (point-max) (line-end-position))
  3788. (goto-char (point-max))
  3789. (move-beginning-of-line 2)))))
  3790. (when (called-interactively-p 'interactive)
  3791. (message "Dim or hide blocked tasks...done")))
  3792. (defun org-agenda--mark-blocked-entry (entry)
  3793. "If ENTRY is blocked, mark it for fontification or invisibility.
  3794. If the header at `org-hd-marker' is blocked according to
  3795. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3796. `invisible' and the header is not blocked by checkboxes, set the
  3797. text property `org-todo-blocked' to `invisible', otherwise set it
  3798. to t."
  3799. (when (get-text-property 0 'todo-state entry)
  3800. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3801. (org-blocked-by-checkboxes nil)
  3802. ;; Necessary so that `org-entry-blocked-p' does not change
  3803. ;; the buffer.
  3804. (org-depend-tag-blocked nil))
  3805. (when entry-marker
  3806. (let ((blocked
  3807. (with-current-buffer (marker-buffer entry-marker)
  3808. (save-excursion
  3809. (goto-char entry-marker)
  3810. (org-entry-blocked-p)))))
  3811. (when blocked
  3812. (let ((really-invisible
  3813. (and (not org-blocked-by-checkboxes)
  3814. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3815. (put-text-property
  3816. 0 (length entry) 'org-todo-blocked
  3817. (if really-invisible 'invisible t)
  3818. entry)
  3819. (put-text-property
  3820. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3821. entry)
  3822. (defvar org-agenda-skip-function nil
  3823. "Function to be called at each match during agenda construction.
  3824. If this function returns nil, the current match should not be skipped.
  3825. Otherwise, the function must return a position from where the search
  3826. should be continued.
  3827. This may also be a Lisp form, it will be evaluated.
  3828. Never set this variable using `setq' or so, because then it will apply
  3829. to all future agenda commands. If you do want a global skipping condition,
  3830. use the option `org-agenda-skip-function-global' instead.
  3831. The correct usage for `org-agenda-skip-function' is to bind it with
  3832. `let' to scope it dynamically into the agenda-constructing command.
  3833. A good way to set it is through options in `org-agenda-custom-commands'.")
  3834. (defun org-agenda-skip (&optional element)
  3835. "Throw to `:skip' in places that should be skipped.
  3836. Also moves point to the end of the skipped region, so that search can
  3837. continue from there.
  3838. Optional argument ELEMENT contains element at point."
  3839. (when (or
  3840. (if element
  3841. (eq (org-element-type element) 'comment)
  3842. (save-excursion
  3843. (goto-char (line-beginning-position))
  3844. (looking-at comment-start-skip)))
  3845. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3846. (or (and (save-match-data (org-in-archived-heading-p nil element))
  3847. (org-end-of-subtree t element))
  3848. (and (member org-archive-tag org-file-tags)
  3849. (goto-char (point-max)))))
  3850. (and org-agenda-skip-comment-trees
  3851. (org-in-commented-heading-p nil element)
  3852. (org-end-of-subtree t element))
  3853. (let ((to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3854. (org-agenda-skip-eval org-agenda-skip-function))))
  3855. (and to (goto-char to)))
  3856. (org-in-src-block-p t element))
  3857. (throw :skip t)))
  3858. (defun org-agenda-skip-eval (form)
  3859. "If FORM is a function or a list, call (or eval) it and return the result.
  3860. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3861. and match data are returned to the previous state no matter what these
  3862. functions do."
  3863. (let (fp)
  3864. (and form
  3865. (or (setq fp (functionp form))
  3866. (consp form))
  3867. (save-excursion
  3868. (save-match-data
  3869. (if fp
  3870. (funcall form)
  3871. (eval form t)))))))
  3872. (defvar org-agenda-markers nil
  3873. "List of all currently active markers created by `org-agenda'.")
  3874. (defvar org-agenda-last-marker-time (float-time)
  3875. "Creation time of the last agenda marker.")
  3876. (defun org-agenda-new-marker (&optional pos)
  3877. "Return a new agenda marker.
  3878. Marker is at point, or at POS if non-nil. Org mode keeps a list
  3879. of these markers and resets them when they are no longer in use."
  3880. (let ((m (copy-marker (or pos (point)) t)))
  3881. (setq org-agenda-last-marker-time (float-time))
  3882. (if org-agenda-buffer
  3883. (with-current-buffer org-agenda-buffer
  3884. (push m org-agenda-markers))
  3885. (push m org-agenda-markers))
  3886. m))
  3887. (defun org-agenda-reset-markers ()
  3888. "Reset markers created by `org-agenda'."
  3889. (while org-agenda-markers
  3890. (move-marker (pop org-agenda-markers) nil)))
  3891. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3892. "Save relative positions of markers in region.
  3893. This check for agenda markers in all agenda buffers currently active."
  3894. (dolist (buf (buffer-list))
  3895. (with-current-buffer buf
  3896. (when (eq major-mode 'org-agenda-mode)
  3897. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3898. org-agenda-markers)))))
  3899. ;;; Entry text mode
  3900. (defun org-agenda-entry-text-show-here ()
  3901. "Add some text from the entry as context to the current line."
  3902. (let (m txt o)
  3903. (setq m (org-get-at-bol 'org-hd-marker))
  3904. (unless (marker-buffer m)
  3905. (error "No marker points to an entry here"))
  3906. (setq txt (concat "\n" (org-no-properties
  3907. (org-agenda-get-some-entry-text
  3908. m org-agenda-entry-text-maxlines
  3909. org-agenda-entry-text-leaders))))
  3910. (when (string-match "\\S-" txt)
  3911. (setq o (make-overlay (line-beginning-position) (line-end-position)))
  3912. (overlay-put o 'evaporate t)
  3913. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3914. (overlay-put o 'after-string txt))))
  3915. (defun org-agenda-entry-text-show ()
  3916. "Add entry context for all agenda lines."
  3917. (interactive)
  3918. (save-excursion
  3919. (goto-char (point-max))
  3920. (beginning-of-line 1)
  3921. (while (not (bobp))
  3922. (when (org-get-at-bol 'org-hd-marker)
  3923. (org-agenda-entry-text-show-here))
  3924. (beginning-of-line 0))))
  3925. (defun org-agenda-entry-text-hide ()
  3926. "Remove any shown entry context."
  3927. (mapc (lambda (o)
  3928. (when (eq (overlay-get o 'org-overlay-type)
  3929. 'agenda-entry-content)
  3930. (delete-overlay o)))
  3931. (overlays-in (point-min) (point-max))))
  3932. (defun org-agenda-get-day-face (date)
  3933. "Return the face DATE should be displayed with."
  3934. (cond ((and (functionp org-agenda-day-face-function)
  3935. (funcall org-agenda-day-face-function date)))
  3936. ((and (org-agenda-today-p date)
  3937. (memq (calendar-day-of-week date) org-agenda-weekend-days))
  3938. 'org-agenda-date-weekend-today)
  3939. ((org-agenda-today-p date) 'org-agenda-date-today)
  3940. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3941. 'org-agenda-date-weekend)
  3942. (t 'org-agenda-date)))
  3943. (defvar org-agenda-show-log-scoped)
  3944. ;;; Agenda Daily/Weekly
  3945. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3946. "Start day for the agenda view.
  3947. Custom commands can set this variable in the options section.
  3948. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3949. input allowed when reading a date through the Org calendar.
  3950. See the docstring of `org-read-date' for details.")
  3951. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3952. (defvar org-arg-loc nil) ; local variable
  3953. ;;;###autoload
  3954. (defun org-agenda-list (&optional arg start-day span with-hour)
  3955. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3956. The view will be for the current day or week, but from the overview buffer
  3957. you will be able to go to other days/weeks.
  3958. With a numeric prefix argument in an interactive call, the agenda will
  3959. span ARG days. Lisp programs should instead specify SPAN to change
  3960. the number of days. SPAN defaults to `org-agenda-span'.
  3961. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3962. given in `org-agenda-start-on-weekday'.
  3963. When WITH-HOUR is non-nil, only include scheduled and deadline
  3964. items if they have an hour specification like [h]h:mm."
  3965. (interactive "P")
  3966. (when org-agenda-overriding-arguments
  3967. (setq arg (car org-agenda-overriding-arguments)
  3968. start-day (nth 1 org-agenda-overriding-arguments)
  3969. span (nth 2 org-agenda-overriding-arguments)))
  3970. (when (and (integerp arg) (> arg 0))
  3971. (setq span arg arg nil))
  3972. (when (numberp span)
  3973. (unless (< 0 span)
  3974. (user-error "Agenda creation impossible for this span(=%d days)" span)))
  3975. (catch 'exit
  3976. (setq org-agenda-buffer-name
  3977. (org-agenda--get-buffer-name
  3978. (and org-agenda-sticky
  3979. (cond ((and org-keys (stringp org-match))
  3980. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3981. (org-keys
  3982. (format "*Org Agenda(%s)*" org-keys))
  3983. (t "*Org Agenda(a)*")))))
  3984. (org-agenda-prepare "Day/Week")
  3985. (setq start-day (or start-day org-agenda-start-day))
  3986. (when (stringp start-day)
  3987. ;; Convert to an absolute day number
  3988. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3989. (org-compile-prefix-format 'agenda)
  3990. (org-set-sorting-strategy 'agenda)
  3991. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3992. (today (org-today))
  3993. (sd (or start-day today))
  3994. (ndays (org-agenda-span-to-ndays span sd))
  3995. (org-agenda-start-on-weekday
  3996. (and (or (eq ndays 7) (eq ndays 14))
  3997. org-agenda-start-on-weekday))
  3998. (thefiles (org-agenda-files nil 'ifmode))
  3999. (files thefiles)
  4000. (start (if (or (null org-agenda-start-on-weekday)
  4001. (< ndays 7))
  4002. sd
  4003. (let* ((nt (calendar-day-of-week
  4004. (calendar-gregorian-from-absolute sd)))
  4005. (n1 org-agenda-start-on-weekday)
  4006. (d (- nt n1)))
  4007. (- sd (+ (if (< d 0) 7 0) d)))))
  4008. (day-numbers (list start))
  4009. (day-cnt 0)
  4010. (inhibit-redisplay (not debug-on-error))
  4011. (org-agenda-show-log-scoped org-agenda-show-log)
  4012. s rtn rtnall file date d start-pos end-pos todayp ;; e
  4013. clocktable-start clocktable-end) ;; filter
  4014. (setq org-agenda-redo-command
  4015. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  4016. (dotimes (_ (1- ndays))
  4017. (push (1+ (car day-numbers)) day-numbers))
  4018. (setq day-numbers (nreverse day-numbers))
  4019. (setq clocktable-start (car day-numbers)
  4020. clocktable-end (1+ (or (org-last day-numbers) 0)))
  4021. (setq-local org-starting-day (car day-numbers))
  4022. (setq-local org-arg-loc arg)
  4023. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  4024. (unless org-agenda-compact-blocks
  4025. (let* ((d1 (car day-numbers))
  4026. (d2 (org-last day-numbers))
  4027. (w1 (org-days-to-iso-week d1))
  4028. (w2 (org-days-to-iso-week d2)))
  4029. (setq s (point))
  4030. (org-agenda--insert-overriding-header
  4031. (concat (org-agenda-span-name span)
  4032. "-agenda"
  4033. (cond ((<= 350 (- d2 d1)) "")
  4034. ((= w1 w2) (format " (W%02d)" w1))
  4035. (t (format " (W%02d-W%02d)" w1 w2)))
  4036. ":\n")))
  4037. ;; Add properties if we actually inserted a header.
  4038. (when (> (point) s)
  4039. (add-text-properties s (1- (point))
  4040. (list 'face 'org-agenda-structure
  4041. 'org-date-line t))
  4042. (org-agenda-mark-header-line s)))
  4043. (while (setq d (pop day-numbers))
  4044. (setq date (calendar-gregorian-from-absolute d)
  4045. s (point))
  4046. (if (or (setq todayp (= d today))
  4047. (and (not start-pos) (= d sd)))
  4048. (setq start-pos (point))
  4049. (when (and start-pos (not end-pos))
  4050. (setq end-pos (point))))
  4051. (setq files thefiles
  4052. rtnall nil)
  4053. (while (setq file (pop files))
  4054. (catch 'nextfile
  4055. (org-check-agenda-file file)
  4056. (let ((org-agenda-entry-types org-agenda-entry-types))
  4057. ;; Starred types override non-starred equivalents
  4058. (when (member :deadline* org-agenda-entry-types)
  4059. (setq org-agenda-entry-types
  4060. (delq :deadline org-agenda-entry-types)))
  4061. (when (member :scheduled* org-agenda-entry-types)
  4062. (setq org-agenda-entry-types
  4063. (delq :scheduled org-agenda-entry-types)))
  4064. ;; Honor with-hour
  4065. (when with-hour
  4066. (when (member :deadline org-agenda-entry-types)
  4067. (setq org-agenda-entry-types
  4068. (delq :deadline org-agenda-entry-types))
  4069. (push :deadline* org-agenda-entry-types))
  4070. (when (member :scheduled org-agenda-entry-types)
  4071. (setq org-agenda-entry-types
  4072. (delq :scheduled org-agenda-entry-types))
  4073. (push :scheduled* org-agenda-entry-types)))
  4074. (unless org-agenda-include-deadlines
  4075. (setq org-agenda-entry-types
  4076. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  4077. (cond
  4078. ((memq org-agenda-show-log-scoped '(only clockcheck))
  4079. (setq rtn (org-agenda-get-day-entries
  4080. file date :closed)))
  4081. (org-agenda-show-log-scoped
  4082. (setq rtn (apply #'org-agenda-get-day-entries
  4083. file date
  4084. (append '(:closed) org-agenda-entry-types))))
  4085. (t
  4086. (setq rtn (apply #'org-agenda-get-day-entries
  4087. file date
  4088. org-agenda-entry-types)))))
  4089. (setq rtnall (append rtnall rtn)))) ;; all entries
  4090. (when org-agenda-include-diary
  4091. (let ((org-agenda-search-headline-for-time t))
  4092. (require 'diary-lib)
  4093. (setq rtn (org-get-entries-from-diary date))
  4094. (setq rtnall (append rtnall rtn))))
  4095. (when (or rtnall org-agenda-show-all-dates)
  4096. (setq day-cnt (1+ day-cnt))
  4097. (insert
  4098. (if (stringp org-agenda-format-date)
  4099. (format-time-string org-agenda-format-date
  4100. (org-time-from-absolute date))
  4101. (funcall org-agenda-format-date date))
  4102. "\n")
  4103. (put-text-property s (1- (point)) 'face
  4104. (org-agenda-get-day-face date))
  4105. (put-text-property s (1- (point)) 'org-date-line t)
  4106. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  4107. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  4108. (when todayp
  4109. (put-text-property s (1- (point)) 'org-today t))
  4110. (setq rtnall
  4111. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  4112. (when rtnall (insert ;; all entries
  4113. (org-agenda-finalize-entries rtnall 'agenda)
  4114. "\n"))
  4115. (put-text-property s (1- (point)) 'day d)
  4116. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  4117. (when (and org-agenda-clockreport-mode clocktable-start)
  4118. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  4119. ;; the above line is to ensure the restricted range!
  4120. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4121. tbl)
  4122. (setq p (org-plist-delete p :block))
  4123. (setq p (plist-put p :tstart clocktable-start))
  4124. (setq p (plist-put p :tend clocktable-end))
  4125. (setq p (plist-put p :scope 'agenda))
  4126. (setq tbl (apply #'org-clock-get-clocktable p))
  4127. (when org-agenda-clock-report-header
  4128. (insert (propertize org-agenda-clock-report-header 'face 'org-agenda-structure))
  4129. (unless (string-suffix-p "\n" org-agenda-clock-report-header)
  4130. (insert "\n")))
  4131. (insert tbl)))
  4132. (goto-char (point-min))
  4133. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4134. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4135. (and (pos-visible-in-window-p (point-min))
  4136. (pos-visible-in-window-p (point-max))))
  4137. (goto-char (1- (point-max)))
  4138. (recenter -1)
  4139. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4140. (goto-char (or start-pos 1))
  4141. (recenter 1)))
  4142. (goto-char (or start-pos 1))
  4143. (add-text-properties (point-min) (point-max)
  4144. `(org-agenda-type agenda
  4145. org-last-args (,arg ,start-day ,span)
  4146. org-redo-cmd ,org-agenda-redo-command
  4147. org-series-cmd ,org-cmd))
  4148. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4149. (org-agenda-show-clocking-issues))
  4150. (org-agenda-finalize)
  4151. (setq buffer-read-only t)
  4152. (message ""))))
  4153. (defun org-agenda-ndays-to-span (n)
  4154. "Return a span symbol for a span of N days, or N if none matches."
  4155. (cond ((symbolp n) n)
  4156. ((= n 1) 'day)
  4157. ((= n 7) 'week)
  4158. ((= n 14) 'fortnight)
  4159. (t n)))
  4160. (defun org-agenda-span-to-ndays (span &optional start-day)
  4161. "Return ndays from SPAN, possibly starting at START-DAY.
  4162. START-DAY is an absolute time value."
  4163. (cond ((numberp span) span)
  4164. ((eq span 'day) 1)
  4165. ((eq span 'week) 7)
  4166. ((eq span 'fortnight) 14)
  4167. ((eq span 'month)
  4168. (let ((date (calendar-gregorian-from-absolute start-day)))
  4169. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4170. ((eq span 'year)
  4171. (let ((date (calendar-gregorian-from-absolute start-day)))
  4172. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4173. (defun org-agenda-span-name (span)
  4174. "Return a SPAN name."
  4175. (if (null span)
  4176. ""
  4177. (if (symbolp span)
  4178. (capitalize (symbol-name span))
  4179. (format "%d days" span))))
  4180. ;;; Agenda word search
  4181. (defvar org-agenda-search-history nil)
  4182. (defvar org-search-syntax-table nil
  4183. "Special syntax table for Org search.
  4184. In this table, we have single quotes not as word constituents, to
  4185. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4186. (defvar org-mode-syntax-table) ; From org.el
  4187. (defun org-search-syntax-table ()
  4188. (unless org-search-syntax-table
  4189. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4190. (modify-syntax-entry ?' "." org-search-syntax-table)
  4191. (modify-syntax-entry ?` "." org-search-syntax-table))
  4192. org-search-syntax-table)
  4193. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4194. ;;;###autoload
  4195. (defun org-search-view (&optional todo-only string edit-at)
  4196. "Show all entries that contain a phrase or words or regular expressions.
  4197. With optional prefix argument TODO-ONLY, only consider entries that are
  4198. TODO entries. The argument STRING can be used to pass a default search
  4199. string into this function. If EDIT-AT is non-nil, it means that the
  4200. user should get a chance to edit this string, with cursor at position
  4201. EDIT-AT.
  4202. The search string can be viewed either as a phrase that should be found as
  4203. is, or it can be broken into a number of snippets, each of which must match
  4204. in a Boolean way to select an entry. The default depends on the variable
  4205. `org-agenda-search-view-always-boolean'.
  4206. Even if this is turned off (the default) you can always switch to
  4207. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4208. The default is a direct search of the whole phrase, where each space in
  4209. the search string can expand to an arbitrary amount of whitespace,
  4210. including newlines.
  4211. If using a Boolean search, the search string is split on whitespace and
  4212. each snippet is searched separately, with logical AND to select an entry.
  4213. Words prefixed with a minus must *not* occur in the entry. Words without
  4214. a prefix or prefixed with a plus must occur in the entry. Matching is
  4215. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4216. match whole words, not parts of a word) if
  4217. `org-agenda-search-view-force-full-words' is set (default is nil).
  4218. Boolean search snippets enclosed by curly braces are interpreted as
  4219. regular expressions that must or (when preceded with \"-\") must not
  4220. match in the entry. Snippets enclosed into double quotes will be taken
  4221. as a whole, to include whitespace.
  4222. - If the search string starts with an asterisk, search only in headlines.
  4223. - If (possibly after the leading star) the search string starts with an
  4224. exclamation mark, this also means to look at TODO entries only, an effect
  4225. that can also be achieved with a prefix argument.
  4226. - If (possibly after star and exclamation mark) the search string starts
  4227. with a colon, this will mean that the (non-regexp) snippets of the
  4228. Boolean search must match as full words.
  4229. This command searches the agenda files, and in addition the files
  4230. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4231. is active."
  4232. (interactive "P")
  4233. (when org-agenda-overriding-arguments
  4234. (setq todo-only (car org-agenda-overriding-arguments)
  4235. string (nth 1 org-agenda-overriding-arguments)
  4236. edit-at (nth 2 org-agenda-overriding-arguments)))
  4237. (let* ((props (list 'face nil
  4238. 'done-face 'org-agenda-done
  4239. 'org-not-done-regexp org-not-done-regexp
  4240. 'org-todo-regexp org-todo-regexp
  4241. 'org-complex-heading-regexp org-complex-heading-regexp
  4242. 'mouse-face 'highlight
  4243. 'help-echo "mouse-2 or RET jump to location"))
  4244. (full-words org-agenda-search-view-force-full-words)
  4245. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4246. regexp rtn rtnall files file pos inherited-tags
  4247. marker category level tags c neg re boolean
  4248. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4249. (unless (and (not edit-at)
  4250. (stringp string)
  4251. (string-match "\\S-" string))
  4252. (setq string (read-string
  4253. (if org-agenda-search-view-always-boolean
  4254. "[+-]Word/{Regexp} ...: "
  4255. "Phrase or [+-]Word/{Regexp} ...: ")
  4256. (cond
  4257. ((integerp edit-at) (cons string edit-at))
  4258. (edit-at string))
  4259. 'org-agenda-search-history)))
  4260. (catch 'exit
  4261. (setq org-agenda-buffer-name
  4262. (org-agenda--get-buffer-name
  4263. (and org-agenda-sticky
  4264. (if (stringp string)
  4265. (format "*Org Agenda(%s:%s)*"
  4266. (or org-keys (or (and todo-only "S") "s"))
  4267. string)
  4268. (format "*Org Agenda(%s)*"
  4269. (or (and todo-only "S") "s"))))))
  4270. (org-agenda-prepare "SEARCH")
  4271. (org-compile-prefix-format 'search)
  4272. (org-set-sorting-strategy 'search)
  4273. (setq org-agenda-redo-command
  4274. (list 'org-search-view (if todo-only t nil)
  4275. (list 'if 'current-prefix-arg nil string)))
  4276. (setq org-agenda-query-string string)
  4277. (if (equal (string-to-char string) ?*)
  4278. (setq hdl-only t
  4279. words (substring string 1))
  4280. (setq words string))
  4281. (when (equal (string-to-char words) ?!)
  4282. (setq todo-only t
  4283. words (substring words 1)))
  4284. (when (equal (string-to-char words) ?:)
  4285. (setq full-words t
  4286. words (substring words 1)))
  4287. (when (or org-agenda-search-view-always-boolean
  4288. (member (string-to-char words) '(?- ?+ ?\{)))
  4289. (setq boolean t))
  4290. (setq words (split-string words))
  4291. (let (www w)
  4292. (while (setq w (pop words))
  4293. (while (and (string-match "\\\\\\'" w) words)
  4294. (setq w (concat (substring w 0 -1) " " (pop words))))
  4295. (push w www))
  4296. (setq words (nreverse www) www nil)
  4297. (while (setq w (pop words))
  4298. (when (and (string-match "\\`[-+]?{" w)
  4299. (not (string-match "}\\'" w)))
  4300. (while (and words (not (string-match "}\\'" (car words))))
  4301. (setq w (concat w " " (pop words))))
  4302. (setq w (concat w " " (pop words))))
  4303. (push w www))
  4304. (setq words (nreverse www)))
  4305. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4306. (when boolean
  4307. (let (wds w)
  4308. (while (setq w (pop words))
  4309. (when (or (equal (substring w 0 1) "\"")
  4310. (and (> (length w) 1)
  4311. (member (substring w 0 1) '("+" "-"))
  4312. (equal (substring w 1 2) "\"")))
  4313. (while (and words (not (equal (substring w -1) "\"")))
  4314. (setq w (concat w " " (pop words)))))
  4315. (and (string-match "\\`\\([-+]?\\)\"" w)
  4316. (setq w (replace-match "\\1" nil nil w)))
  4317. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4318. (push w wds))
  4319. (setq words (nreverse wds))))
  4320. (if boolean
  4321. (mapc (lambda (w)
  4322. (setq c (string-to-char w))
  4323. (if (equal c ?-)
  4324. (setq neg t w (substring w 1))
  4325. (if (equal c ?+)
  4326. (setq neg nil w (substring w 1))
  4327. (setq neg nil)))
  4328. (if (string-match "\\`{.*}\\'" w)
  4329. (setq re (substring w 1 -1))
  4330. (if full-words
  4331. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4332. (setq re (regexp-quote (downcase w)))))
  4333. (if neg (push re regexps-) (push re regexps+)))
  4334. words)
  4335. (push (mapconcat #'regexp-quote words "\\s-+")
  4336. regexps+))
  4337. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4338. (if (not regexps+)
  4339. (setq regexp org-outline-regexp-bol)
  4340. (setq regexp (pop regexps+))
  4341. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4342. regexp))))
  4343. (setq files (org-agenda-files nil 'ifmode))
  4344. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4345. ;; restriction.
  4346. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4347. (pop org-agenda-text-search-extra-files)
  4348. (unless (get 'org-agenda-files 'org-restrict)
  4349. (setq files (org-add-archive-files files))))
  4350. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4351. ;; non-existent ones.
  4352. (setq files (cl-remove-duplicates
  4353. (append files org-agenda-text-search-extra-files)
  4354. :test (lambda (a b)
  4355. (and (file-exists-p a)
  4356. (file-exists-p b)
  4357. (file-equal-p a b))))
  4358. rtnall nil)
  4359. (while (setq file (pop files))
  4360. (setq ee nil)
  4361. (catch 'nextfile
  4362. (org-check-agenda-file file)
  4363. (setq buffer (if (file-exists-p file)
  4364. (org-get-agenda-file-buffer file)
  4365. (error "No such file %s" file)))
  4366. (unless buffer
  4367. ;; If file does not exist, make sure an error message is sent
  4368. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4369. file))))
  4370. (with-current-buffer buffer
  4371. (with-syntax-table (org-search-syntax-table)
  4372. (unless (derived-mode-p 'org-mode)
  4373. (error "Agenda file %s is not in Org mode" file))
  4374. (let ((case-fold-search t))
  4375. (save-excursion
  4376. (save-restriction
  4377. (if (eq buffer org-agenda-restrict)
  4378. (narrow-to-region org-agenda-restrict-begin
  4379. org-agenda-restrict-end)
  4380. (widen))
  4381. (goto-char (point-min))
  4382. (unless (or (org-at-heading-p)
  4383. (outline-next-heading))
  4384. (throw 'nextfile t))
  4385. (goto-char (max (point-min) (1- (point))))
  4386. (while (re-search-forward regexp nil t)
  4387. (org-back-to-heading t)
  4388. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4389. (> (org-reduced-level (org-outline-level))
  4390. org-agenda-search-view-max-outline-level)
  4391. (forward-line -1)
  4392. (org-back-to-heading t)))
  4393. (skip-chars-forward "* ")
  4394. (setq beg (line-beginning-position)
  4395. beg1 (point)
  4396. end (progn
  4397. (outline-next-heading)
  4398. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4399. (> (org-reduced-level (org-outline-level))
  4400. org-agenda-search-view-max-outline-level)
  4401. (forward-line 1)
  4402. (outline-next-heading)))
  4403. (point)))
  4404. (catch :skip
  4405. (goto-char beg)
  4406. (org-agenda-skip)
  4407. (setq str (buffer-substring-no-properties
  4408. (line-beginning-position)
  4409. (if hdl-only (line-end-position) end)))
  4410. (mapc (lambda (wr) (when (string-match wr str)
  4411. (goto-char (1- end))
  4412. (throw :skip t)))
  4413. regexps-)
  4414. (mapc (lambda (wr) (unless (string-match wr str)
  4415. (goto-char (1- end))
  4416. (throw :skip t)))
  4417. (if todo-only
  4418. (cons (concat "^\\*+[ \t]+"
  4419. org-not-done-regexp)
  4420. regexps+)
  4421. regexps+))
  4422. (goto-char beg)
  4423. (setq marker (org-agenda-new-marker (point))
  4424. category (org-get-category)
  4425. level (make-string (org-reduced-level (org-outline-level)) ? )
  4426. inherited-tags
  4427. (or (eq org-agenda-show-inherited-tags 'always)
  4428. (and (listp org-agenda-show-inherited-tags)
  4429. (memq 'todo org-agenda-show-inherited-tags))
  4430. (and (eq org-agenda-show-inherited-tags t)
  4431. (or (eq org-agenda-use-tag-inheritance t)
  4432. (memq 'todo org-agenda-use-tag-inheritance))))
  4433. tags (org-get-tags nil (not inherited-tags))
  4434. txt (org-agenda-format-item
  4435. ""
  4436. (buffer-substring-no-properties
  4437. beg1 (line-end-position))
  4438. level category tags t))
  4439. (org-add-props txt props
  4440. 'org-marker marker 'org-hd-marker marker
  4441. 'org-todo-regexp org-todo-regexp
  4442. 'level level
  4443. 'org-complex-heading-regexp org-complex-heading-regexp
  4444. 'priority 1000
  4445. 'type "search")
  4446. (push txt ee)
  4447. (goto-char (1- end))))))))))
  4448. (setq rtn (nreverse ee))
  4449. (setq rtnall (append rtnall rtn)))
  4450. (org-agenda--insert-overriding-header
  4451. (with-temp-buffer
  4452. (insert "Search words: ")
  4453. (add-text-properties (point-min) (1- (point))
  4454. (list 'face 'org-agenda-structure))
  4455. (setq pos (point))
  4456. (insert string "\n")
  4457. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4458. (setq pos (point))
  4459. (unless org-agenda-multi
  4460. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4461. Press `\\[org-agenda-manipulate-query-add]', \
  4462. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4463. `\\[org-agenda-manipulate-query-add-re]', \
  4464. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4465. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4466. (add-text-properties pos (1- (point))
  4467. (list 'face 'org-agenda-structure-secondary)))
  4468. (buffer-string)))
  4469. (org-agenda-mark-header-line (point-min))
  4470. (when rtnall
  4471. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4472. (goto-char (point-min))
  4473. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4474. (add-text-properties (point-min) (point-max)
  4475. `(org-agenda-type search
  4476. org-last-args (,todo-only ,string ,edit-at)
  4477. org-redo-cmd ,org-agenda-redo-command
  4478. org-series-cmd ,org-cmd))
  4479. (org-agenda-finalize)
  4480. (setq buffer-read-only t))))
  4481. ;;; Agenda TODO list
  4482. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4483. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4484. (concat
  4485. (if (or (equal keywords "ALL") (not keywords))
  4486. (propertize "ALL" 'face 'org-agenda-structure-filter)
  4487. (mapconcat
  4488. (lambda (kw)
  4489. (propertize kw 'face (list (org-get-todo-face kw) 'org-agenda-structure)))
  4490. (org-split-string keywords "|")
  4491. "|"))
  4492. "\n"))
  4493. (defvar org-select-this-todo-keyword nil)
  4494. (defvar org-last-arg nil)
  4495. (defvar crm-separator)
  4496. ;;;###autoload
  4497. (defun org-todo-list (&optional arg)
  4498. "Show all (not done) TODO entries from all agenda files in a single list.
  4499. The prefix arg can be used to select a specific TODO keyword and limit
  4500. the list to these. When using `\\[universal-argument]', you will be prompted
  4501. for a keyword. A numeric prefix directly selects the Nth keyword in
  4502. `org-todo-keywords-1'."
  4503. (interactive "P")
  4504. (when org-agenda-overriding-arguments
  4505. (setq arg org-agenda-overriding-arguments))
  4506. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4507. (let* ((today (org-today))
  4508. (date (calendar-gregorian-from-absolute today))
  4509. (completion-ignore-case t)
  4510. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4511. (catch 'exit
  4512. (setq org-agenda-buffer-name
  4513. (org-agenda--get-buffer-name
  4514. (and org-agenda-sticky
  4515. (if (stringp org-select-this-todo-keyword)
  4516. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4517. org-select-this-todo-keyword)
  4518. (format "*Org Agenda(%s)*" (or org-keys "t"))))))
  4519. (org-agenda-prepare "TODO")
  4520. (setq kwds org-todo-keywords-for-agenda
  4521. org-select-this-todo-keyword (if (stringp arg) arg
  4522. (and (integerp arg)
  4523. (> arg 0)
  4524. (nth (1- arg) kwds))))
  4525. (when (equal arg '(4))
  4526. (setq org-select-this-todo-keyword
  4527. (mapconcat #'identity
  4528. (let ((crm-separator "|"))
  4529. (completing-read-multiple
  4530. "Keyword (or KWD1|KWD2|...): "
  4531. (mapcar #'list kwds) nil nil))
  4532. "|")))
  4533. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4534. (org-compile-prefix-format 'todo)
  4535. (org-set-sorting-strategy 'todo)
  4536. (setq org-agenda-redo-command
  4537. `(org-todo-list (or (and (numberp current-prefix-arg)
  4538. current-prefix-arg)
  4539. ,org-select-this-todo-keyword
  4540. current-prefix-arg ,arg)))
  4541. (setq files (org-agenda-files nil 'ifmode)
  4542. rtnall nil)
  4543. (while (setq file (pop files))
  4544. (catch 'nextfile
  4545. (org-check-agenda-file file)
  4546. (setq rtn (org-agenda-get-day-entries file date :todo))
  4547. (setq rtnall (append rtnall rtn))))
  4548. (org-agenda--insert-overriding-header
  4549. (with-temp-buffer
  4550. (insert "Global list of TODO items of type: ")
  4551. (add-text-properties (point-min) (1- (point))
  4552. (list 'face 'org-agenda-structure
  4553. 'short-heading
  4554. (concat "ToDo: "
  4555. (or org-select-this-todo-keyword "ALL"))))
  4556. (org-agenda-mark-header-line (point-min))
  4557. (insert (org-agenda-propertize-selected-todo-keywords
  4558. org-select-this-todo-keyword))
  4559. (setq pos (point))
  4560. (unless org-agenda-multi
  4561. (insert (substitute-command-keys "Press \
  4562. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4563. to search again: (0)[ALL]"))
  4564. (let ((n 0))
  4565. (dolist (k kwds)
  4566. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4567. (when (> (+ (current-column) (string-width s) 1) (window-max-chars-per-line))
  4568. (insert "\n "))
  4569. (insert " " s))))
  4570. (insert "\n"))
  4571. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-secondary))
  4572. (buffer-string)))
  4573. (org-agenda-mark-header-line (point-min))
  4574. (when rtnall
  4575. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4576. (goto-char (point-min))
  4577. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4578. (add-text-properties (point-min) (point-max)
  4579. `(org-agenda-type todo
  4580. org-last-args ,arg
  4581. org-redo-cmd ,org-agenda-redo-command
  4582. org-series-cmd ,org-cmd))
  4583. (org-agenda-finalize)
  4584. (setq buffer-read-only t))))
  4585. ;;; Agenda tags match
  4586. ;;;###autoload
  4587. (defun org-tags-view (&optional todo-only match)
  4588. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4589. The prefix arg TODO-ONLY limits the search to TODO entries."
  4590. (interactive "P")
  4591. (when org-agenda-overriding-arguments
  4592. (setq todo-only (car org-agenda-overriding-arguments)
  4593. match (nth 1 org-agenda-overriding-arguments)))
  4594. (let* ((org-tags-match-list-sublevels
  4595. org-tags-match-list-sublevels)
  4596. (completion-ignore-case t)
  4597. (org--matcher-tags-todo-only todo-only)
  4598. rtn rtnall files file pos matcher
  4599. buffer)
  4600. (when (and (stringp match) (not (string-match "\\S-" match)))
  4601. (setq match nil))
  4602. (catch 'exit
  4603. (setq org-agenda-buffer-name
  4604. (org-agenda--get-buffer-name
  4605. (and org-agenda-sticky
  4606. (if (stringp match)
  4607. (format "*Org Agenda(%s:%s)*"
  4608. (or org-keys (or (and todo-only "M") "m"))
  4609. match)
  4610. (format "*Org Agenda(%s)*"
  4611. (or (and todo-only "M") "m"))))))
  4612. (setq matcher (org-make-tags-matcher match))
  4613. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4614. ;; expanding tags within `org-make-tags-matcher'
  4615. (org-agenda-prepare (concat "TAGS " match))
  4616. (setq match (car matcher)
  4617. matcher (cdr matcher))
  4618. (org-compile-prefix-format 'tags)
  4619. (org-set-sorting-strategy 'tags)
  4620. (setq org-agenda-query-string match)
  4621. (setq org-agenda-redo-command
  4622. (list 'org-tags-view
  4623. `(quote ,org--matcher-tags-todo-only)
  4624. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4625. (setq files (org-agenda-files nil 'ifmode)
  4626. rtnall nil)
  4627. (while (setq file (pop files))
  4628. (catch 'nextfile
  4629. (org-check-agenda-file file)
  4630. (setq buffer (if (file-exists-p file)
  4631. (org-get-agenda-file-buffer file)
  4632. (error "No such file %s" file)))
  4633. (if (not buffer)
  4634. ;; If file does not exist, error message to agenda
  4635. (setq rtn (list
  4636. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4637. rtnall (append rtnall rtn))
  4638. (with-current-buffer buffer
  4639. (unless (derived-mode-p 'org-mode)
  4640. (error "Agenda file %s is not in Org mode" file))
  4641. (save-excursion
  4642. (save-restriction
  4643. (if (eq buffer org-agenda-restrict)
  4644. (narrow-to-region org-agenda-restrict-begin
  4645. org-agenda-restrict-end)
  4646. (widen))
  4647. (setq rtn (org-scan-tags 'agenda
  4648. matcher
  4649. org--matcher-tags-todo-only))
  4650. (setq rtnall (append rtnall rtn))))))))
  4651. (org-agenda--insert-overriding-header
  4652. (with-temp-buffer
  4653. (insert "Headlines with TAGS match: ")
  4654. (add-text-properties (point-min) (1- (point))
  4655. (list 'face 'org-agenda-structure
  4656. 'short-heading
  4657. (concat "Match: " match)))
  4658. (setq pos (point))
  4659. (insert match "\n")
  4660. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4661. (setq pos (point))
  4662. (unless org-agenda-multi
  4663. (insert (substitute-command-keys
  4664. "Press \
  4665. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4666. to search again\n")))
  4667. (add-text-properties pos (1- (point))
  4668. (list 'face 'org-agenda-structure-secondary))
  4669. (buffer-string)))
  4670. (org-agenda-mark-header-line (point-min))
  4671. (when rtnall
  4672. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4673. (goto-char (point-min))
  4674. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4675. (add-text-properties
  4676. (point-min) (point-max)
  4677. `(org-agenda-type tags
  4678. org-last-args (,org--matcher-tags-todo-only ,match)
  4679. org-redo-cmd ,org-agenda-redo-command
  4680. org-series-cmd ,org-cmd))
  4681. (org-agenda-finalize)
  4682. (setq buffer-read-only t))))
  4683. ;;; Agenda Finding stuck projects
  4684. (defvar org-agenda-skip-regexp nil
  4685. "Regular expression used in skipping subtrees for the agenda.
  4686. This is basically a temporary global variable that can be set and then
  4687. used by user-defined selections using `org-agenda-skip-function'.")
  4688. (defvar org-agenda-overriding-header nil
  4689. "When set during agenda, todo and tags searches it replaces the header.
  4690. If an empty string, no header will be inserted. If any other
  4691. string, it will be inserted as a header. If a function, insert
  4692. the string returned by the function as a header. If nil, a
  4693. header will be generated automatically according to the command.
  4694. This variable should not be set directly, but custom commands can
  4695. bind it in the options section.")
  4696. (defun org-agenda-skip-entry-if (&rest conditions)
  4697. "Skip entry if any of CONDITIONS is true.
  4698. See `org-agenda-skip-if' for details."
  4699. (org-agenda-skip-if nil conditions))
  4700. (defun org-agenda-skip-subtree-if (&rest conditions)
  4701. "Skip subtree if any of CONDITIONS is true.
  4702. See `org-agenda-skip-if' for details."
  4703. (org-agenda-skip-if t conditions))
  4704. (defun org-agenda-skip-if (subtree conditions)
  4705. "Check current entity for CONDITIONS.
  4706. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4707. the entry (i.e. the text before the next heading) is checked.
  4708. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4709. from different tests. Valid conditions are:
  4710. scheduled Check if there is a scheduled cookie
  4711. notscheduled Check if there is no scheduled cookie
  4712. deadline Check if there is a deadline
  4713. notdeadline Check if there is no deadline
  4714. timestamp Check if there is a timestamp (also deadline or scheduled)
  4715. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4716. regexp Check if regexp matches
  4717. notregexp Check if regexp does not match.
  4718. todo Check if TODO keyword matches
  4719. nottodo Check if TODO keyword does not match
  4720. The regexp is taken from the conditions list, it must come right after
  4721. the `regexp' or `notregexp' element.
  4722. `todo' and `nottodo' accept as an argument a list of todo
  4723. keywords, which may include \"*\" to match any todo keyword.
  4724. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4725. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4726. Instead of a list, a keyword class may be given. For example:
  4727. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4728. would skip entries that haven't been marked with any of \"DONE\"
  4729. keywords. Possible classes are: `todo', `done', `any'.
  4730. If any of these conditions is met, this function returns the end point of
  4731. the entity, causing the search to continue from there. This is a function
  4732. that can be put into `org-agenda-skip-function' for the duration of a command."
  4733. (org-back-to-heading t)
  4734. (let* (;; (beg (point))
  4735. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4736. (org-entry-end-position)))
  4737. (planning-end (if subtree end (line-end-position 2)))
  4738. m)
  4739. (and
  4740. (or (and (memq 'scheduled conditions)
  4741. (re-search-forward org-scheduled-time-regexp planning-end t))
  4742. (and (memq 'notscheduled conditions)
  4743. (not
  4744. (save-excursion
  4745. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4746. (and (memq 'deadline conditions)
  4747. (re-search-forward org-deadline-time-regexp planning-end t))
  4748. (and (memq 'notdeadline conditions)
  4749. (not
  4750. (save-excursion
  4751. (re-search-forward org-deadline-time-regexp planning-end t))))
  4752. (and (memq 'timestamp conditions)
  4753. (re-search-forward org-ts-regexp end t))
  4754. (and (memq 'nottimestamp conditions)
  4755. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4756. (and (setq m (memq 'regexp conditions))
  4757. (stringp (nth 1 m))
  4758. (re-search-forward (nth 1 m) end t))
  4759. (and (setq m (memq 'notregexp conditions))
  4760. (stringp (nth 1 m))
  4761. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4762. (and (or
  4763. (setq m (memq 'nottodo conditions))
  4764. (setq m (memq 'todo-unblocked conditions))
  4765. (setq m (memq 'nottodo-unblocked conditions))
  4766. (setq m (memq 'todo conditions)))
  4767. (org-agenda-skip-if-todo m end)))
  4768. end)))
  4769. (defun org-agenda-skip-if-todo (args end)
  4770. "Helper function for `org-agenda-skip-if', do not use it directly.
  4771. ARGS is a list with first element either `todo', `nottodo',
  4772. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4773. a list of TODO keywords, or a state symbol `todo' or `done' or
  4774. `any'."
  4775. (let ((todo-re
  4776. (concat "^\\*+[ \t]+"
  4777. (regexp-opt
  4778. (pcase args
  4779. (`(,_ todo)
  4780. (org-delete-all org-done-keywords
  4781. (copy-sequence org-todo-keywords-1)))
  4782. (`(,_ done) org-done-keywords)
  4783. (`(,_ any) org-todo-keywords-1)
  4784. (`(,_ ,(pred atom))
  4785. (error "Invalid TODO class or type: %S" args))
  4786. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4787. (`(,_ ,todo-list) todo-list))
  4788. 'words))))
  4789. (pcase args
  4790. (`(todo . ,_)
  4791. (let (case-fold-search) (re-search-forward todo-re end t)))
  4792. (`(nottodo . ,_)
  4793. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4794. (`(todo-unblocked . ,_)
  4795. (catch :unblocked
  4796. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4797. (when (org-entry-blocked-p) (throw :unblocked t)))
  4798. nil))
  4799. (`(nottodo-unblocked . ,_)
  4800. (catch :unblocked
  4801. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4802. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4803. t))
  4804. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4805. ;;;###autoload
  4806. (defun org-agenda-list-stuck-projects (&rest _ignore)
  4807. "Create agenda view for projects that are stuck.
  4808. Stuck projects are project that have no next actions. For the definitions
  4809. of what a project is and how to check if it stuck, customize the variable
  4810. `org-stuck-projects'."
  4811. (interactive)
  4812. (let* ((org-agenda-overriding-header
  4813. (or org-agenda-overriding-header "List of stuck projects: "))
  4814. (matcher (nth 0 org-stuck-projects))
  4815. (todo (nth 1 org-stuck-projects))
  4816. (tags (nth 2 org-stuck-projects))
  4817. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4818. (todo-wds
  4819. (if (not (member "*" todo)) todo
  4820. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4821. (org-delete-all org-done-keywords-for-agenda
  4822. (copy-sequence org-todo-keywords-for-agenda))))
  4823. (todo-re (and todo
  4824. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4825. (mapconcat #'identity todo-wds "\\|"))))
  4826. (tags-re (cond ((null tags) nil)
  4827. ((member "*" tags) org-tag-line-re)
  4828. (tags
  4829. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4830. (concat org-outline-regexp-bol
  4831. ".*?[ \t]:"
  4832. other-tags
  4833. (regexp-opt tags t)
  4834. ":" other-tags "[ \t]*$")))
  4835. (t nil)))
  4836. (re-list (delq nil (list todo-re tags-re gen-re)))
  4837. (skip-re
  4838. (if (null re-list)
  4839. (error "Missing information to identify unstuck projects")
  4840. (mapconcat #'identity re-list "\\|")))
  4841. (org-agenda-skip-function
  4842. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4843. ;; in the subtree.
  4844. (lambda ()
  4845. (and (save-excursion
  4846. (let ((case-fold-search nil))
  4847. (re-search-forward
  4848. skip-re (save-excursion (org-end-of-subtree t)) t)))
  4849. (progn (outline-next-heading) (point))))))
  4850. (org-tags-view nil matcher)
  4851. (setq org-agenda-buffer-name (buffer-name))
  4852. (with-current-buffer org-agenda-buffer-name
  4853. (setq org-agenda-redo-command
  4854. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4855. (let ((inhibit-read-only t))
  4856. (add-text-properties
  4857. (point-min) (point-max)
  4858. `(org-redo-cmd ,org-agenda-redo-command))))))
  4859. ;;; Diary integration
  4860. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4861. (defvar diary-list-entries-hook)
  4862. (defvar diary-time-regexp)
  4863. (defvar diary-modify-entry-list-string-function)
  4864. (defvar diary-file-name-prefix)
  4865. (defvar diary-display-function)
  4866. (defun org-get-entries-from-diary (date)
  4867. "Get the (Emacs Calendar) diary entries for DATE."
  4868. (require 'diary-lib)
  4869. (declare-function diary-fancy-display "diary-lib" ())
  4870. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4871. (diary-display-function #'diary-fancy-display)
  4872. (pop-up-frames nil)
  4873. (diary-list-entries-hook
  4874. (cons 'org-diary-default-entry diary-list-entries-hook))
  4875. (diary-file-name-prefix nil) ; turn this feature off
  4876. (diary-modify-entry-list-string-function
  4877. #'org-modify-diary-entry-string)
  4878. (diary-time-regexp (concat "^" diary-time-regexp))
  4879. entries
  4880. (org-disable-agenda-to-diary t))
  4881. (save-excursion
  4882. (save-window-excursion
  4883. (diary-list-entries date 1)))
  4884. (if (not (get-buffer diary-fancy-buffer))
  4885. (setq entries nil)
  4886. (with-current-buffer diary-fancy-buffer
  4887. (setq buffer-read-only nil)
  4888. (if (zerop (buffer-size))
  4889. ;; No entries
  4890. (setq entries nil)
  4891. ;; Omit the date and other unnecessary stuff
  4892. (org-agenda-cleanup-fancy-diary)
  4893. ;; Add prefix to each line and extend the text properties
  4894. (if (zerop (buffer-size))
  4895. (setq entries nil)
  4896. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4897. (setq entries
  4898. (with-temp-buffer
  4899. (insert entries) (goto-char (point-min))
  4900. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4901. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4902. (replace-match (concat "; " (match-string 1)))))
  4903. (buffer-string)))))
  4904. (set-buffer-modified-p nil)
  4905. (kill-buffer diary-fancy-buffer)))
  4906. (when entries
  4907. (setq entries (org-split-string entries "\n"))
  4908. (setq entries
  4909. (mapcar
  4910. (lambda (x)
  4911. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4912. ;; Extend the text properties to the beginning of the line
  4913. (org-add-props x (text-properties-at (1- (length x)) x)
  4914. 'type "diary" 'date date 'face 'org-agenda-diary))
  4915. entries)))))
  4916. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4917. "Hook run when the fancy diary buffer is cleaned up.")
  4918. (defun org-agenda-cleanup-fancy-diary ()
  4919. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4920. This gets rid of the date, the underline under the date, and the
  4921. dummy entry installed by Org mode to ensure non-empty diary for
  4922. each date. It also removes lines that contain only whitespace."
  4923. (goto-char (point-min))
  4924. (if (looking-at ".*?:[ \t]*")
  4925. (progn
  4926. (replace-match "")
  4927. (re-search-forward "\n=+$" nil t)
  4928. (replace-match "")
  4929. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4930. (re-search-forward "\n=+$" nil t)
  4931. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4932. (goto-char (point-min))
  4933. (while (re-search-forward "^ +\n" nil t)
  4934. (replace-match ""))
  4935. (goto-char (point-min))
  4936. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4937. (replace-match ""))
  4938. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4939. (defun org-modify-diary-entry-string (string)
  4940. "Add text properties to string, allowing Org to act on it."
  4941. (org-add-props string nil
  4942. 'mouse-face 'highlight
  4943. 'help-echo (if buffer-file-name
  4944. (format "mouse-2 or RET jump to diary file %s"
  4945. (abbreviate-file-name buffer-file-name))
  4946. "")
  4947. 'org-agenda-diary-link t
  4948. 'org-marker (org-agenda-new-marker (line-beginning-position))))
  4949. (defun org-diary-default-entry ()
  4950. "Add a dummy entry to the diary.
  4951. Needed to avoid empty dates which mess up holiday display."
  4952. ;; Catch the error if dealing with the new add-to-diary-alist
  4953. (when org-disable-agenda-to-diary
  4954. (diary-add-to-list original-date "Org mode dummy" "")))
  4955. (defvar org-diary-last-run-time nil)
  4956. ;;;###autoload
  4957. (defun org-diary (&rest args)
  4958. "Return diary information from org files.
  4959. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4960. It accesses org files and extracts information from those files to be
  4961. listed in the diary. The function accepts arguments specifying what
  4962. items should be listed. For a list of arguments allowed here, see the
  4963. variable `org-agenda-entry-types'.
  4964. The call in the diary file should look like this:
  4965. &%%(org-diary) ~/path/to/some/orgfile.org
  4966. Use a separate line for each org file to check. Or, if you omit the file name,
  4967. all files listed in `org-agenda-files' will be checked automatically:
  4968. &%%(org-diary)
  4969. If you don't give any arguments (as in the example above), the default value
  4970. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4971. So the example above may also be written as
  4972. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4973. The function expects the lisp variables `entry' and `date' to be provided
  4974. by the caller, because this is how the calendar works. Don't use this
  4975. function from a program - use `org-agenda-get-day-entries' instead."
  4976. (with-no-warnings (defvar date) (defvar entry))
  4977. (when (> (- (float-time)
  4978. org-agenda-last-marker-time)
  4979. 5)
  4980. ;; I am not sure if this works with sticky agendas, because the marker
  4981. ;; list is then no longer a global variable.
  4982. (org-agenda-reset-markers))
  4983. (org-compile-prefix-format 'agenda)
  4984. (org-set-sorting-strategy 'agenda)
  4985. (setq args (or args org-agenda-entry-types))
  4986. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4987. (list entry)
  4988. (org-agenda-files t)))
  4989. (time (float-time))
  4990. file rtn results)
  4991. (when (or (not org-diary-last-run-time)
  4992. (> (- time
  4993. org-diary-last-run-time)
  4994. 3))
  4995. (org-agenda-prepare-buffers files))
  4996. (setq org-diary-last-run-time time)
  4997. ;; If this is called during org-agenda, don't return any entries to
  4998. ;; the calendar. Org Agenda will list these entries itself.
  4999. (when org-disable-agenda-to-diary (setq files nil))
  5000. (while (setq file (pop files))
  5001. (setq rtn (apply #'org-agenda-get-day-entries file date args))
  5002. (setq results (append results rtn)))
  5003. (when results
  5004. (setq results
  5005. (mapcar (lambda (i) (replace-regexp-in-string
  5006. org-link-bracket-re "\\2" i))
  5007. results))
  5008. (concat (org-agenda-finalize-entries results) "\n"))))
  5009. ;;; Agenda entry finders
  5010. (defun org-agenda--timestamp-to-absolute (&rest args)
  5011. "Call `org-time-string-to-absolute' with ARGS.
  5012. However, throw `:skip' whenever an error is raised."
  5013. (condition-case e
  5014. (apply #'org-time-string-to-absolute args)
  5015. (org-diary-sexp-no-match (throw :skip nil))
  5016. (error
  5017. (message "%s; Skipping entry" (error-message-string e))
  5018. (throw :skip nil))))
  5019. (defun org-agenda-get-day-entries (file date &rest args)
  5020. "Does the work for `org-diary' and `org-agenda'.
  5021. FILE is the path to a file to be checked for entries. DATE is date like
  5022. the one returned by `calendar-current-date'. ARGS are symbols indicating
  5023. which kind of entries should be extracted. For details about these, see
  5024. the documentation of `org-diary'."
  5025. (let* ((org-startup-folded nil)
  5026. (org-startup-align-all-tables nil)
  5027. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  5028. (error "No such file %s" file))))
  5029. (if (not buffer)
  5030. ;; If file does not exist, signal it in diary nonetheless.
  5031. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  5032. (with-current-buffer buffer
  5033. (unless (derived-mode-p 'org-mode)
  5034. (error "Agenda file %s is not in Org mode" file))
  5035. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  5036. (setf org-agenda-current-date date)
  5037. (save-excursion
  5038. (save-restriction
  5039. (if (eq buffer org-agenda-restrict)
  5040. (narrow-to-region org-agenda-restrict-begin
  5041. org-agenda-restrict-end)
  5042. (widen))
  5043. ;; Rationalize ARGS. Also make sure `:deadline' comes
  5044. ;; first in order to populate DEADLINES before passing it.
  5045. ;;
  5046. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  5047. ;; guarding us from modifying `org-agenda-entry-types'.
  5048. (setf args (org-uniquify (or args org-agenda-entry-types)))
  5049. (when (and (memq :scheduled args) (memq :scheduled* args))
  5050. (setf args (delq :scheduled* args)))
  5051. (cond
  5052. ((memq :deadline args)
  5053. (setf args (cons :deadline
  5054. (delq :deadline (delq :deadline* args)))))
  5055. ((memq :deadline* args)
  5056. (setf args (cons :deadline* (delq :deadline* args)))))
  5057. ;; Collect list of headlines. Return them flattened.
  5058. (let ((case-fold-search nil) results deadlines)
  5059. (org-dlet
  5060. ((date date))
  5061. (dolist (arg args (apply #'nconc (nreverse results)))
  5062. (pcase arg
  5063. ((and :todo (guard (org-agenda-today-p date)))
  5064. (push (org-agenda-get-todos) results))
  5065. (:timestamp
  5066. (push (org-agenda-get-blocks) results)
  5067. (push (org-agenda-get-timestamps deadlines) results))
  5068. (:sexp
  5069. (push (org-agenda-get-sexps) results))
  5070. (:scheduled
  5071. (push (org-agenda-get-scheduled deadlines) results))
  5072. (:scheduled*
  5073. (push (org-agenda-get-scheduled deadlines t) results))
  5074. (:closed
  5075. (push (org-agenda-get-progress) results))
  5076. (:deadline
  5077. (setf deadlines (org-agenda-get-deadlines))
  5078. (push deadlines results))
  5079. (:deadline*
  5080. (setf deadlines (org-agenda-get-deadlines t))
  5081. (push deadlines results))))))))))))
  5082. (defsubst org-em (x y list)
  5083. "Is X or Y a member of LIST?"
  5084. (or (memq x list) (memq y list)))
  5085. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  5086. (defvar org-agenda-sorting-strategy-selected nil)
  5087. (defun org-agenda-entry-get-agenda-timestamp (pom)
  5088. "Retrieve timestamp information for sorting agenda views.
  5089. Given a point or marker POM, returns a cons cell of the timestamp
  5090. and the timestamp type relevant for the sorting strategy in
  5091. `org-agenda-sorting-strategy-selected'."
  5092. (let (ts ts-date-type)
  5093. (save-match-data
  5094. (cond ((org-em 'scheduled-up 'scheduled-down
  5095. org-agenda-sorting-strategy-selected)
  5096. (setq ts (org-entry-get pom "SCHEDULED")
  5097. ts-date-type " scheduled"))
  5098. ((org-em 'deadline-up 'deadline-down
  5099. org-agenda-sorting-strategy-selected)
  5100. (setq ts (org-entry-get pom "DEADLINE")
  5101. ts-date-type " deadline"))
  5102. ((org-em 'ts-up 'ts-down
  5103. org-agenda-sorting-strategy-selected)
  5104. (setq ts (org-entry-get pom "TIMESTAMP")
  5105. ts-date-type " timestamp"))
  5106. ((org-em 'tsia-up 'tsia-down
  5107. org-agenda-sorting-strategy-selected)
  5108. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  5109. ts-date-type " timestamp_ia"))
  5110. ((org-em 'timestamp-up 'timestamp-down
  5111. org-agenda-sorting-strategy-selected)
  5112. (setq ts (or (org-entry-get pom "SCHEDULED")
  5113. (org-entry-get pom "DEADLINE")
  5114. (org-entry-get pom "TIMESTAMP")
  5115. (org-entry-get pom "TIMESTAMP_IA"))
  5116. ts-date-type ""))
  5117. (t (setq ts-date-type "")))
  5118. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  5119. ts-date-type))))
  5120. (defun org-agenda-get-todos ()
  5121. "Return the TODO information for agenda display."
  5122. (let* ((props (list 'face nil
  5123. 'done-face 'org-agenda-done
  5124. 'org-not-done-regexp org-not-done-regexp
  5125. 'org-todo-regexp org-todo-regexp
  5126. 'org-complex-heading-regexp org-complex-heading-regexp
  5127. 'mouse-face 'highlight
  5128. 'help-echo
  5129. (format "mouse-2 or RET jump to org file %s"
  5130. (abbreviate-file-name buffer-file-name))))
  5131. (case-fold-search nil)
  5132. (regexp (format org-heading-keyword-regexp-format
  5133. (cond
  5134. ((and org-select-this-todo-keyword
  5135. (equal org-select-this-todo-keyword "*"))
  5136. org-todo-regexp)
  5137. (org-select-this-todo-keyword
  5138. (concat "\\("
  5139. (mapconcat #'identity
  5140. (org-split-string
  5141. org-select-this-todo-keyword
  5142. "|")
  5143. "\\|")
  5144. "\\)"))
  5145. (t org-not-done-regexp))))
  5146. marker priority category level tags todo-state
  5147. ts-date ts-date-type ts-date-pair
  5148. ee txt beg end inherited-tags todo-state-end-pos
  5149. effort effort-minutes)
  5150. (goto-char (point-min))
  5151. (while (re-search-forward regexp nil t)
  5152. (catch :skip
  5153. (save-match-data
  5154. (beginning-of-line)
  5155. (org-agenda-skip)
  5156. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5157. (unless (and (setq todo-state (org-get-todo-state))
  5158. (setq todo-state-end-pos (match-end 2)))
  5159. (goto-char end)
  5160. (throw :skip nil))
  5161. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5162. (goto-char (1+ beg))
  5163. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5164. (throw :skip nil)))
  5165. (goto-char (match-beginning 2))
  5166. (setq marker (org-agenda-new-marker (match-beginning 0))
  5167. category (org-get-category)
  5168. effort (save-match-data (or (get-text-property (point) 'effort)
  5169. (org-entry-get (point) org-effort-property)))
  5170. effort-minutes (when effort (save-match-data (org-duration-to-minutes effort)))
  5171. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5172. ts-date (car ts-date-pair)
  5173. ts-date-type (cdr ts-date-pair)
  5174. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5175. inherited-tags
  5176. (or (eq org-agenda-show-inherited-tags 'always)
  5177. (and (listp org-agenda-show-inherited-tags)
  5178. (memq 'todo org-agenda-show-inherited-tags))
  5179. (and (eq org-agenda-show-inherited-tags t)
  5180. (or (eq org-agenda-use-tag-inheritance t)
  5181. (memq 'todo org-agenda-use-tag-inheritance))))
  5182. tags (org-get-tags nil (not inherited-tags))
  5183. level (make-string (org-reduced-level (org-outline-level)) ? )
  5184. txt (org-agenda-format-item ""
  5185. (org-add-props txt nil
  5186. 'effort effort
  5187. 'effort-minutes effort-minutes)
  5188. level category tags t)
  5189. priority (1+ (org-get-priority txt)))
  5190. (org-add-props txt props
  5191. 'org-marker marker 'org-hd-marker marker
  5192. 'priority priority
  5193. 'effort effort 'effort-minutes effort-minutes
  5194. 'level level
  5195. 'ts-date ts-date
  5196. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5197. (push txt ee)
  5198. (if org-agenda-todo-list-sublevels
  5199. (goto-char todo-state-end-pos)
  5200. (org-end-of-subtree 'invisible))))
  5201. (nreverse ee)))
  5202. (defun org-agenda-todo-custom-ignore-p (time n)
  5203. "Check whether timestamp is farther away than n number of days.
  5204. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5205. `org-agenda-todo-ignore-scheduled' or
  5206. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5207. (let ((days (org-time-stamp-to-now
  5208. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5209. (if (>= n 0)
  5210. (>= days n)
  5211. (<= days n))))
  5212. ;;;###autoload
  5213. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5214. (&optional end)
  5215. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5216. (when (or org-agenda-todo-ignore-with-date
  5217. org-agenda-todo-ignore-scheduled
  5218. org-agenda-todo-ignore-deadlines
  5219. org-agenda-todo-ignore-timestamp)
  5220. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5221. (save-excursion
  5222. (or (and org-agenda-todo-ignore-with-date
  5223. (re-search-forward org-ts-regexp end t))
  5224. (and org-agenda-todo-ignore-scheduled
  5225. (re-search-forward org-scheduled-time-regexp end t)
  5226. (cond
  5227. ((eq org-agenda-todo-ignore-scheduled 'future)
  5228. (> (org-time-stamp-to-now
  5229. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5230. 0))
  5231. ((eq org-agenda-todo-ignore-scheduled 'past)
  5232. (<= (org-time-stamp-to-now
  5233. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5234. 0))
  5235. ((numberp org-agenda-todo-ignore-scheduled)
  5236. (org-agenda-todo-custom-ignore-p
  5237. (match-string 1) org-agenda-todo-ignore-scheduled))
  5238. (t)))
  5239. (and org-agenda-todo-ignore-deadlines
  5240. (re-search-forward org-deadline-time-regexp end t)
  5241. (cond
  5242. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5243. ((eq org-agenda-todo-ignore-deadlines 'far)
  5244. (not (org-deadline-close-p (match-string 1))))
  5245. ((eq org-agenda-todo-ignore-deadlines 'future)
  5246. (> (org-time-stamp-to-now
  5247. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5248. 0))
  5249. ((eq org-agenda-todo-ignore-deadlines 'past)
  5250. (<= (org-time-stamp-to-now
  5251. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5252. 0))
  5253. ((numberp org-agenda-todo-ignore-deadlines)
  5254. (org-agenda-todo-custom-ignore-p
  5255. (match-string 1) org-agenda-todo-ignore-deadlines))
  5256. (t (org-deadline-close-p (match-string 1)))))
  5257. (and org-agenda-todo-ignore-timestamp
  5258. (let ((buffer (current-buffer))
  5259. (regexp
  5260. (concat
  5261. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5262. (start (point)))
  5263. ;; Copy current buffer into a temporary one
  5264. (with-temp-buffer
  5265. (insert-buffer-substring buffer start end)
  5266. (goto-char (point-min))
  5267. ;; Delete SCHEDULED and DEADLINE items
  5268. (while (re-search-forward regexp end t)
  5269. (delete-region (match-beginning 0) (match-end 0)))
  5270. (goto-char (point-min))
  5271. ;; No search for timestamp left
  5272. (when (re-search-forward org-ts-regexp nil t)
  5273. (cond
  5274. ((eq org-agenda-todo-ignore-timestamp 'future)
  5275. (> (org-time-stamp-to-now
  5276. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5277. 0))
  5278. ((eq org-agenda-todo-ignore-timestamp 'past)
  5279. (<= (org-time-stamp-to-now
  5280. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5281. 0))
  5282. ((numberp org-agenda-todo-ignore-timestamp)
  5283. (org-agenda-todo-custom-ignore-p
  5284. (match-string 1) org-agenda-todo-ignore-timestamp))
  5285. (t))))))))))
  5286. (defun org-agenda-get-timestamps (&optional deadlines)
  5287. "Return the date stamp information for agenda display.
  5288. Optional argument DEADLINES is a list of deadline items to be
  5289. displayed in agenda view."
  5290. (with-no-warnings (defvar date))
  5291. (let* ((props (list 'face 'org-agenda-calendar-event
  5292. 'org-not-done-regexp org-not-done-regexp
  5293. 'org-todo-regexp org-todo-regexp
  5294. 'org-complex-heading-regexp org-complex-heading-regexp
  5295. 'mouse-face 'highlight
  5296. 'help-echo
  5297. (format "mouse-2 or RET jump to Org file %s"
  5298. (abbreviate-file-name buffer-file-name))))
  5299. (current (calendar-absolute-from-gregorian date))
  5300. (today (org-today))
  5301. (deadline-position-alist
  5302. (mapcar (lambda (d)
  5303. (let ((m (get-text-property 0 'org-hd-marker d)))
  5304. (and m (marker-position m))))
  5305. deadlines))
  5306. ;; Match time-stamps set to current date, time-stamps with
  5307. ;; a repeater, and S-exp time-stamps.
  5308. (regexp
  5309. (concat
  5310. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5311. (regexp-quote
  5312. (substring
  5313. (format-time-string
  5314. (car org-time-stamp-formats)
  5315. (org-encode-time ; DATE bound by calendar
  5316. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5317. 1 11))
  5318. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5319. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5320. timestamp-items)
  5321. (goto-char (point-min))
  5322. (while (re-search-forward regexp nil t)
  5323. ;; Skip date ranges, scheduled and deadlines, which are handled
  5324. ;; specially. Also skip time-stamps before first headline as
  5325. ;; there would be no entry to add to the agenda. Eventually,
  5326. ;; ignore clock entries.
  5327. (catch :skip
  5328. (save-match-data
  5329. (when (or (org-at-date-range-p)
  5330. (org-at-planning-p)
  5331. (org-before-first-heading-p)
  5332. (and org-agenda-include-inactive-timestamps
  5333. (org-at-clock-log-p))
  5334. (not (org-at-timestamp-p 'agenda)))
  5335. (throw :skip nil))
  5336. (org-agenda-skip (org-element-at-point)))
  5337. (let* ((pos (match-beginning 0))
  5338. (repeat (match-string 1))
  5339. (sexp-entry (match-string 3))
  5340. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5341. (save-excursion
  5342. (goto-char pos)
  5343. (looking-at org-ts-regexp-both)
  5344. (match-string 0))))
  5345. (todo-state (org-get-todo-state))
  5346. (warntime (get-text-property (point) 'org-appt-warntime))
  5347. (done? (member todo-state org-done-keywords)))
  5348. ;; Possibly skip done tasks.
  5349. (when (and done? org-agenda-skip-timestamp-if-done)
  5350. (throw :skip t))
  5351. ;; S-exp entry doesn't match current day: skip it.
  5352. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5353. (throw :skip nil))
  5354. (when repeat
  5355. (let* ((past
  5356. ;; A repeating time stamp is shown at its base
  5357. ;; date and every repeated date up to TODAY. If
  5358. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5359. ;; however, only the last repeat before today
  5360. ;; (inclusive) is shown.
  5361. (org-agenda--timestamp-to-absolute
  5362. repeat
  5363. (if (or (> current today)
  5364. (eq org-agenda-prefer-last-repeat t)
  5365. (member todo-state org-agenda-prefer-last-repeat))
  5366. today
  5367. current)
  5368. 'past (current-buffer) pos))
  5369. (future
  5370. ;; Display every repeated date past TODAY
  5371. ;; (exclusive) unless
  5372. ;; `org-agenda-show-future-repeats' is nil. If
  5373. ;; this variable is set to `next', only display
  5374. ;; the first repeated date after TODAY
  5375. ;; (exclusive).
  5376. (cond
  5377. ((<= current today) past)
  5378. ((not org-agenda-show-future-repeats) past)
  5379. (t
  5380. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5381. (1+ today)
  5382. current)))
  5383. (org-agenda--timestamp-to-absolute
  5384. repeat base 'future (current-buffer) pos))))))
  5385. (when (and (/= current past) (/= current future))
  5386. (throw :skip nil))))
  5387. (save-excursion
  5388. (re-search-backward org-outline-regexp-bol nil t)
  5389. ;; Possibly skip time-stamp when a deadline is set.
  5390. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5391. (assq (point) deadline-position-alist))
  5392. (throw :skip nil))
  5393. (let* ((category (org-get-category pos))
  5394. (effort (org-entry-get pos org-effort-property))
  5395. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5396. (inherited-tags
  5397. (or (eq org-agenda-show-inherited-tags 'always)
  5398. (and (consp org-agenda-show-inherited-tags)
  5399. (memq 'agenda org-agenda-show-inherited-tags))
  5400. (and (eq org-agenda-show-inherited-tags t)
  5401. (or (eq org-agenda-use-tag-inheritance t)
  5402. (memq 'agenda
  5403. org-agenda-use-tag-inheritance)))))
  5404. (tags (org-get-tags nil (not inherited-tags)))
  5405. (level (make-string (org-reduced-level (org-outline-level))
  5406. ?\s))
  5407. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5408. (match-string 1)))
  5409. (inactive? (= (char-after pos) ?\[))
  5410. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5411. (item
  5412. (org-agenda-format-item
  5413. (and inactive? org-agenda-inactive-leader)
  5414. (org-add-props head nil
  5415. 'effort effort
  5416. 'effort-minutes effort-minutes)
  5417. level category tags time-stamp org-ts-regexp habit?)))
  5418. (org-add-props item props
  5419. 'priority (if habit?
  5420. (org-habit-get-priority (org-habit-parse-todo))
  5421. (org-get-priority item))
  5422. 'org-marker (org-agenda-new-marker pos)
  5423. 'org-hd-marker (org-agenda-new-marker)
  5424. 'date date
  5425. 'level level
  5426. 'effort effort 'effort-minutes effort-minutes
  5427. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5428. current)
  5429. 'todo-state todo-state
  5430. 'warntime warntime
  5431. 'type "timestamp")
  5432. (push item timestamp-items))))
  5433. (when org-agenda-skip-additional-timestamps-same-entry
  5434. (outline-next-heading))))
  5435. (nreverse timestamp-items)))
  5436. (defun org-agenda-get-sexps ()
  5437. "Return the sexp information for agenda display."
  5438. (require 'diary-lib)
  5439. (with-no-warnings (defvar date) (defvar entry))
  5440. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5441. 'mouse-face 'highlight
  5442. 'help-echo
  5443. (format "mouse-2 or RET jump to org file %s"
  5444. (abbreviate-file-name buffer-file-name))))
  5445. (regexp "^&?%%(")
  5446. ;; FIXME: Is this `entry' binding intended to be dynamic,
  5447. ;; so as to "hide" any current binding for it?
  5448. marker category extra level ee txt tags entry
  5449. result beg b sexp sexp-entry todo-state warntime inherited-tags
  5450. effort effort-minutes)
  5451. (goto-char (point-min))
  5452. (while (re-search-forward regexp nil t)
  5453. (catch :skip
  5454. ;; We do not run `org-agenda-skip' righ away because every single sexp
  5455. ;; in the buffer is matched here, unlike day-specific search
  5456. ;; in ordinary timestamps. Most of the sexps will not match
  5457. ;; the agenda day and it is quicker to run `org-agenda-skip' only for
  5458. ;; matching sexps later on.
  5459. (setq beg (match-beginning 0))
  5460. (goto-char (1- (match-end 0)))
  5461. (setq b (point))
  5462. (forward-sexp 1)
  5463. (setq sexp (buffer-substring b (point)))
  5464. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5465. (buffer-substring
  5466. (match-beginning 1)
  5467. (save-excursion
  5468. (goto-char (match-end 1))
  5469. (skip-chars-backward "[:blank:]")
  5470. (point)))
  5471. ""))
  5472. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5473. (when result
  5474. ;; Only check if entry should be skipped on matching sexps.
  5475. (org-agenda-skip (org-element-at-point))
  5476. (setq marker (org-agenda-new-marker beg)
  5477. level (make-string (org-reduced-level (org-outline-level)) ? )
  5478. category (org-get-category beg)
  5479. effort (save-match-data (or (get-text-property (point) 'effort)
  5480. (org-entry-get (point) org-effort-property)))
  5481. inherited-tags
  5482. (or (eq org-agenda-show-inherited-tags 'always)
  5483. (and (listp org-agenda-show-inherited-tags)
  5484. (memq 'agenda org-agenda-show-inherited-tags))
  5485. (and (eq org-agenda-show-inherited-tags t)
  5486. (or (eq org-agenda-use-tag-inheritance t)
  5487. (memq 'agenda org-agenda-use-tag-inheritance))))
  5488. tags (org-get-tags nil (not inherited-tags))
  5489. todo-state (org-get-todo-state)
  5490. warntime (get-text-property (point) 'org-appt-warntime)
  5491. extra nil)
  5492. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5493. (dolist (r (if (stringp result)
  5494. (list result)
  5495. result)) ;; we expect a list here
  5496. (when (and org-agenda-diary-sexp-prefix
  5497. (string-match org-agenda-diary-sexp-prefix r))
  5498. (setq extra (match-string 0 r)
  5499. r (replace-match "" nil nil r)))
  5500. (if (string-match "\\S-" r)
  5501. (setq txt r)
  5502. (setq txt "SEXP entry returned empty string"))
  5503. (setq txt (org-agenda-format-item extra
  5504. (org-add-props txt nil
  5505. 'effort effort
  5506. 'effort-minutes effort-minutes)
  5507. level category tags 'time))
  5508. (org-add-props txt props 'org-marker marker
  5509. 'date date 'todo-state todo-state
  5510. 'effort effort 'effort-minutes effort-minutes
  5511. 'level level 'type "sexp" 'warntime warntime)
  5512. (push txt ee)))))
  5513. (nreverse ee)))
  5514. ;; Calendar sanity: define some functions that are independent of
  5515. ;; `calendar-date-style'.
  5516. (defun org-anniversary (year month day &optional mark)
  5517. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5518. (with-no-warnings
  5519. (let ((calendar-date-style 'iso))
  5520. (diary-anniversary year month day mark))))
  5521. (defun org-cyclic (N year month day &optional mark)
  5522. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5523. (with-no-warnings
  5524. (let ((calendar-date-style 'iso))
  5525. (diary-cyclic N year month day mark))))
  5526. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5527. "Like `diary-block', but with fixed (ISO) order of arguments."
  5528. (with-no-warnings
  5529. (let ((calendar-date-style 'iso))
  5530. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5531. (defun org-date (year month day &optional mark)
  5532. "Like `diary-date', but with fixed (ISO) order of arguments."
  5533. (with-no-warnings
  5534. (let ((calendar-date-style 'iso))
  5535. (diary-date year month day mark))))
  5536. ;; Define the `org-class' function
  5537. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5538. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5539. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5540. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5541. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5542. `holidays', then any date that is known by the Emacs calendar to be a
  5543. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5544. then those holidays will be skipped."
  5545. (with-no-warnings (defvar date) (defvar entry))
  5546. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5547. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5548. (d (calendar-absolute-from-gregorian date))
  5549. (h (when skip-weeks (calendar-check-holidays date))))
  5550. (and
  5551. (<= date1 d)
  5552. (<= d date2)
  5553. (= (calendar-day-of-week date) dayname)
  5554. (or (not skip-weeks)
  5555. (progn
  5556. (require 'cal-iso)
  5557. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5558. (not (or (and h (memq 'holidays skip-weeks))
  5559. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5560. entry)))
  5561. (defalias 'org-get-closed #'org-agenda-get-progress)
  5562. (defun org-agenda-get-progress ()
  5563. "Return the logged TODO entries for agenda display."
  5564. (with-no-warnings (defvar date))
  5565. (let* ((props (list 'mouse-face 'highlight
  5566. 'org-not-done-regexp org-not-done-regexp
  5567. 'org-todo-regexp org-todo-regexp
  5568. 'org-complex-heading-regexp org-complex-heading-regexp
  5569. 'help-echo
  5570. (format "mouse-2 or RET jump to org file %s"
  5571. (abbreviate-file-name buffer-file-name))))
  5572. (items (if (consp org-agenda-show-log-scoped)
  5573. org-agenda-show-log-scoped
  5574. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5575. '(clock)
  5576. org-agenda-log-mode-items)))
  5577. (parts
  5578. (delq nil
  5579. (list
  5580. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5581. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5582. (when (memq 'state items)
  5583. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5584. (parts-re (if parts (mapconcat #'identity parts "\\|")
  5585. (error "`org-agenda-log-mode-items' is empty")))
  5586. (regexp (concat
  5587. "\\(" parts-re "\\)"
  5588. " *\\["
  5589. (regexp-quote
  5590. (substring
  5591. (format-time-string
  5592. (car org-time-stamp-formats)
  5593. (org-encode-time ; DATE bound by calendar
  5594. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5595. 1 11))))
  5596. (org-agenda-search-headline-for-time nil)
  5597. marker hdmarker priority category level tags closedp type
  5598. statep clockp state ee txt extra timestr rest clocked inherited-tags
  5599. effort effort-minutes)
  5600. (goto-char (point-min))
  5601. (while (re-search-forward regexp nil t)
  5602. (catch :skip
  5603. (org-agenda-skip)
  5604. (setq marker (org-agenda-new-marker (match-beginning 0))
  5605. closedp (equal (match-string 1) org-closed-string)
  5606. statep (equal (string-to-char (match-string 1)) ?-)
  5607. clockp (not (or closedp statep))
  5608. state (and statep (match-string 2))
  5609. category (org-get-category (match-beginning 0))
  5610. timestr (buffer-substring (match-beginning 0) (line-end-position))
  5611. effort (save-match-data (or (get-text-property (point) 'effort)
  5612. (org-entry-get (point) org-effort-property))))
  5613. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5614. (when (string-match "\\]" timestr)
  5615. ;; substring should only run to end of time stamp
  5616. (setq rest (substring timestr (match-end 0))
  5617. timestr (substring timestr 0 (match-end 0)))
  5618. (if (and (not closedp) (not statep)
  5619. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5620. rest))
  5621. (progn (setq timestr (concat (substring timestr 0 -1)
  5622. "-" (match-string 1 rest) "]"))
  5623. (setq clocked (match-string 2 rest)))
  5624. (setq clocked "-")))
  5625. (save-excursion
  5626. (setq extra
  5627. (cond
  5628. ((not org-agenda-log-mode-add-notes) nil)
  5629. (statep
  5630. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5631. (match-string 1)))
  5632. (clockp
  5633. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5634. (match-string 1)))))
  5635. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5636. (throw :skip nil)
  5637. (goto-char (match-beginning 0))
  5638. (setq hdmarker (org-agenda-new-marker)
  5639. inherited-tags
  5640. (or (eq org-agenda-show-inherited-tags 'always)
  5641. (and (listp org-agenda-show-inherited-tags)
  5642. (memq 'todo org-agenda-show-inherited-tags))
  5643. (and (eq org-agenda-show-inherited-tags t)
  5644. (or (eq org-agenda-use-tag-inheritance t)
  5645. (memq 'todo org-agenda-use-tag-inheritance))))
  5646. tags (org-get-tags nil (not inherited-tags))
  5647. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5648. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5649. (setq txt (match-string 1))
  5650. (when extra
  5651. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5652. (setq txt (concat (substring txt 0 (match-beginning 1))
  5653. " - " extra " " (match-string 2 txt)))
  5654. (setq txt (concat txt " - " extra))))
  5655. (setq txt (org-agenda-format-item
  5656. (cond
  5657. (closedp "Closed: ")
  5658. (statep (concat "State: (" state ")"))
  5659. (t (concat "Clocked: (" clocked ")")))
  5660. (org-add-props txt nil
  5661. 'effort effort
  5662. 'effort-minutes effort-minutes)
  5663. level category tags timestr)))
  5664. (setq type (cond (closedp "closed")
  5665. (statep "state")
  5666. (t "clock")))
  5667. (setq priority 100000)
  5668. (org-add-props txt props
  5669. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5670. 'priority priority 'level level
  5671. 'effort effort 'effort-minutes effort-minutes
  5672. 'type type 'date date
  5673. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5674. (push txt ee))
  5675. (goto-char (line-end-position))))
  5676. (nreverse ee)))
  5677. (defun org-agenda-show-clocking-issues ()
  5678. "Add overlays, showing issues with clocking.
  5679. See also the user option `org-agenda-clock-consistency-checks'."
  5680. (interactive)
  5681. (let* ((pl org-agenda-clock-consistency-checks)
  5682. (re (concat "^[ \t]*"
  5683. org-clock-string
  5684. "[ \t]+"
  5685. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5686. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5687. (tlstart 0.)
  5688. (tlend 0.)
  5689. (maxtime (org-duration-to-minutes
  5690. (or (plist-get pl :max-duration) "24:00")))
  5691. (mintime (org-duration-to-minutes
  5692. (or (plist-get pl :min-duration) 0)))
  5693. (maxgap (org-duration-to-minutes
  5694. ;; default 30:00 means never complain
  5695. (or (plist-get pl :max-gap) "30:00")))
  5696. (gapok (mapcar #'org-duration-to-minutes
  5697. (plist-get pl :gap-ok-around)))
  5698. (def-face (or (plist-get pl :default-face)
  5699. '((:background "DarkRed") (:foreground "white"))))
  5700. issue face m te ts dt ov)
  5701. (goto-char (point-min))
  5702. (while (re-search-forward " Clocked: +(\\(?:-\\|\\([0-9]+:[0-9]+\\)\\))" nil t)
  5703. (setq issue nil face def-face)
  5704. (catch 'next
  5705. (setq m (org-get-at-bol 'org-marker)
  5706. te nil ts nil)
  5707. (unless (and m (markerp m))
  5708. (setq issue "No valid clock line") (throw 'next t))
  5709. (org-with-point-at m
  5710. (save-excursion
  5711. (goto-char (line-beginning-position))
  5712. (unless (looking-at re)
  5713. (error "No valid Clock line")
  5714. (throw 'next t))
  5715. (unless (match-end 3)
  5716. (setq issue
  5717. (format
  5718. "No end time: (%s)"
  5719. (org-duration-from-minutes
  5720. (floor
  5721. (- (float-time (org-current-time))
  5722. (float-time (org-time-string-to-time (match-string 1))))
  5723. 60)))
  5724. face (or (plist-get pl :no-end-time-face) face))
  5725. (throw 'next t))
  5726. (setq ts (match-string 1)
  5727. te (match-string 3)
  5728. ts (float-time (org-time-string-to-time ts))
  5729. te (float-time (org-time-string-to-time te))
  5730. dt (- te ts))))
  5731. (cond
  5732. ((> dt (* 60 maxtime))
  5733. ;; a very long clocking chunk
  5734. (setq issue (format "Clocking interval is very long: %s"
  5735. (org-duration-from-minutes (floor dt 60)))
  5736. face (or (plist-get pl :long-face) face)))
  5737. ((< dt (* 60 mintime))
  5738. ;; a very short clocking chunk
  5739. (setq issue (format "Clocking interval is very short: %s"
  5740. (org-duration-from-minutes (floor dt 60)))
  5741. face (or (plist-get pl :short-face) face)))
  5742. ((and (> tlend 0) (< ts tlend))
  5743. ;; Two clock entries are overlapping
  5744. (setq issue (format "Clocking overlap: %d minutes"
  5745. (/ (- tlend ts) 60))
  5746. face (or (plist-get pl :overlap-face) face)))
  5747. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5748. ;; There is a gap, lets see if we need to report it
  5749. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5750. (setq issue (format "Clocking gap: %d minutes"
  5751. (/ (- ts tlend) 60))
  5752. face (or (plist-get pl :gap-face) face))))
  5753. (t nil)))
  5754. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5755. (when issue
  5756. ;; OK, there was some issue, add an overlay to show the issue
  5757. (setq ov (make-overlay (line-beginning-position) (line-end-position)))
  5758. (overlay-put ov 'before-string
  5759. (concat
  5760. (org-add-props
  5761. (format "%-43s" (concat " " issue))
  5762. nil
  5763. 'face face)
  5764. "\n"))
  5765. (overlay-put ov 'evaporate t)))))
  5766. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5767. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5768. (catch 'exit
  5769. (unless ok-list
  5770. ;; there are no OK times for gaps...
  5771. (throw 'exit nil))
  5772. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5773. ;; This is more than 24 hours, so it is OK.
  5774. ;; because we have at least one OK time, that must be in the
  5775. ;; 24 hour interval.
  5776. (throw 'exit t))
  5777. ;; We have a shorter gap.
  5778. ;; Now we have to get the minute of the day when these times are
  5779. (let* ((t1dec (decode-time t1))
  5780. (t2dec (decode-time t2))
  5781. ;; compute the minute on the day
  5782. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5783. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5784. (when (< min2 min1)
  5785. ;; if min2 is smaller than min1, this means it is on the next day.
  5786. ;; Wrap it to after midnight.
  5787. (setq min2 (+ min2 1440)))
  5788. ;; Now check if any of the OK times is in the gap
  5789. (mapc (lambda (x)
  5790. ;; Wrap the time to after midnight if necessary
  5791. (when (< x min1) (setq x (+ x 1440)))
  5792. ;; Check if in interval
  5793. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5794. ok-list)
  5795. ;; Nope, this gap is not OK
  5796. nil)))
  5797. (defun org-agenda-get-deadlines (&optional with-hour)
  5798. "Return the deadline information for agenda display.
  5799. When WITH-HOUR is non-nil, only return deadlines with an hour
  5800. specification like [h]h:mm."
  5801. (with-no-warnings (defvar date))
  5802. (let* ((props (list 'mouse-face 'highlight
  5803. 'org-not-done-regexp org-not-done-regexp
  5804. 'org-todo-regexp org-todo-regexp
  5805. 'org-complex-heading-regexp org-complex-heading-regexp
  5806. 'help-echo
  5807. (format "mouse-2 or RET jump to org file %s"
  5808. (abbreviate-file-name buffer-file-name))))
  5809. (regexp (if with-hour
  5810. org-deadline-time-hour-regexp
  5811. org-deadline-time-regexp))
  5812. (today (org-today))
  5813. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5814. (current (calendar-absolute-from-gregorian date))
  5815. deadline-items)
  5816. (goto-char (point-min))
  5817. (if (org-element--cache-active-p)
  5818. (org-element-cache-map
  5819. (lambda (el)
  5820. (when (and (org-element-property :deadline el)
  5821. (or (not with-hour)
  5822. (org-element-property
  5823. :hour-start
  5824. (org-element-property :deadline el))
  5825. (org-element-property
  5826. :hour-end
  5827. (org-element-property :deadline el))))
  5828. (goto-char (org-element-property :contents-begin el))
  5829. (catch :skip
  5830. (org-agenda-skip el)
  5831. (let* ((s (substring (org-element-property
  5832. :raw-value
  5833. (org-element-property :deadline el))
  5834. 1 -1))
  5835. (pos (save-excursion
  5836. (goto-char (org-element-property :contents-begin el))
  5837. ;; We intentionally leave NOERROR
  5838. ;; argument in `re-search-forward' nil. If
  5839. ;; the search fails here, something went
  5840. ;; wrong and we are looking at
  5841. ;; non-matching headline.
  5842. (re-search-forward regexp (line-end-position))
  5843. (1- (match-beginning 1))))
  5844. (todo-state (org-element-property :todo-keyword el))
  5845. (done? (eq 'done (org-element-property :todo-type el)))
  5846. (sexp? (eq 'diary
  5847. (org-element-property
  5848. :type (org-element-property :deadline el))))
  5849. ;; DEADLINE is the deadline date for the entry. It is
  5850. ;; either the base date or the last repeat, according
  5851. ;; to `org-agenda-prefer-last-repeat'.
  5852. (deadline
  5853. (cond
  5854. (sexp? (org-agenda--timestamp-to-absolute s current))
  5855. ((or (eq org-agenda-prefer-last-repeat t)
  5856. (member todo-state org-agenda-prefer-last-repeat))
  5857. (org-agenda--timestamp-to-absolute
  5858. s today 'past (current-buffer) pos))
  5859. (t (org-agenda--timestamp-to-absolute s))))
  5860. ;; REPEAT is the future repeat closest from CURRENT,
  5861. ;; according to `org-agenda-show-future-repeats'. If
  5862. ;; the latter is nil, or if the time stamp has no
  5863. ;; repeat part, default to DEADLINE.
  5864. (repeat
  5865. (cond
  5866. (sexp? deadline)
  5867. ((<= current today) deadline)
  5868. ((not org-agenda-show-future-repeats) deadline)
  5869. (t
  5870. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5871. (1+ today)
  5872. current)))
  5873. (org-agenda--timestamp-to-absolute
  5874. s base 'future (current-buffer) pos)))))
  5875. (diff (- deadline current))
  5876. (suppress-prewarning
  5877. (let ((scheduled
  5878. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5879. (org-element-property
  5880. :raw-value
  5881. (org-element-property :scheduled el)))))
  5882. (cond
  5883. ((not scheduled) nil)
  5884. ;; The current item has a scheduled date, so
  5885. ;; evaluate its prewarning lead time.
  5886. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5887. ;; Use global prewarning-restart lead time.
  5888. org-agenda-skip-deadline-prewarning-if-scheduled)
  5889. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5890. 'pre-scheduled)
  5891. ;; Set pre-warning to no earlier than SCHEDULED.
  5892. (min (- deadline
  5893. (org-agenda--timestamp-to-absolute scheduled))
  5894. org-deadline-warning-days))
  5895. ;; Set pre-warning to deadline.
  5896. (t 0))))
  5897. (wdays (or suppress-prewarning (org-get-wdays s))))
  5898. (cond
  5899. ;; Only display deadlines at their base date, at future
  5900. ;; repeat occurrences or in today agenda.
  5901. ((= current deadline) nil)
  5902. ((= current repeat) nil)
  5903. ((not today?) (throw :skip nil))
  5904. ;; Upcoming deadline: display within warning period WDAYS.
  5905. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5906. ;; Overdue deadline: warn about it for
  5907. ;; `org-deadline-past-days' duration.
  5908. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5909. ;; Possibly skip done tasks.
  5910. (when (and done?
  5911. (or org-agenda-skip-deadline-if-done
  5912. (/= deadline current)))
  5913. (throw :skip nil))
  5914. (save-excursion
  5915. (goto-char (org-element-property :begin el))
  5916. (let* ((category (org-get-category))
  5917. (effort (save-match-data (or (get-text-property (point) 'effort)
  5918. (org-element-property (intern (concat ":" (upcase org-effort-property))) el))))
  5919. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5920. (level (make-string (org-element-property :level el)
  5921. ?\s))
  5922. (head (save-excursion
  5923. (goto-char (org-element-property :begin el))
  5924. (re-search-forward org-outline-regexp-bol)
  5925. (buffer-substring-no-properties (point) (line-end-position))))
  5926. (inherited-tags
  5927. (or (eq org-agenda-show-inherited-tags 'always)
  5928. (and (listp org-agenda-show-inherited-tags)
  5929. (memq 'agenda org-agenda-show-inherited-tags))
  5930. (and (eq org-agenda-show-inherited-tags t)
  5931. (or (eq org-agenda-use-tag-inheritance t)
  5932. (memq 'agenda
  5933. org-agenda-use-tag-inheritance)))))
  5934. (tags (org-get-tags el (not inherited-tags)))
  5935. (time
  5936. (cond
  5937. ;; No time of day designation if it is only
  5938. ;; a reminder.
  5939. ((and (/= current deadline) (/= current repeat)) nil)
  5940. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5941. (concat (substring s (match-beginning 1)) " "))
  5942. (t 'time)))
  5943. (item
  5944. (org-agenda-format-item
  5945. ;; Insert appropriate suffixes before deadlines.
  5946. ;; Those only apply to today agenda.
  5947. (pcase-let ((`(,now ,future ,past)
  5948. org-agenda-deadline-leaders))
  5949. (cond
  5950. ((and today? (< deadline today)) (format past (- diff)))
  5951. ((and today? (> deadline today)) (format future diff))
  5952. (t now)))
  5953. (org-add-props head nil
  5954. 'effort effort
  5955. 'effort-minutes effort-minutes)
  5956. level category tags time))
  5957. (face (org-agenda-deadline-face
  5958. (- 1 (/ (float diff) (max wdays 1)))))
  5959. (upcoming? (and today? (> deadline today)))
  5960. (warntime (get-text-property (point) 'org-appt-warntime)))
  5961. (org-add-props item props
  5962. 'org-marker (org-agenda-new-marker pos)
  5963. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5964. 'warntime warntime
  5965. 'level level
  5966. 'effort effort 'effort-minutes effort-minutes
  5967. 'ts-date deadline
  5968. 'priority
  5969. ;; Adjust priority to today reminders about deadlines.
  5970. ;; Overdue deadlines get the highest priority
  5971. ;; increase, then imminent deadlines and eventually
  5972. ;; more distant deadlines.
  5973. (let ((adjust (if today? (- diff) 0)))
  5974. (+ adjust (org-get-priority item)))
  5975. 'todo-state todo-state
  5976. 'type (if upcoming? "upcoming-deadline" "deadline")
  5977. 'date (if upcoming? date deadline)
  5978. 'face (if done? 'org-agenda-done face)
  5979. 'undone-face face
  5980. 'done-face 'org-agenda-done)
  5981. (push item deadline-items)))))))
  5982. :next-re regexp
  5983. :fail-re regexp
  5984. :narrow t)
  5985. (while (re-search-forward regexp nil t)
  5986. (catch :skip
  5987. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5988. (org-agenda-skip)
  5989. (let* ((s (match-string 1))
  5990. (pos (1- (match-beginning 1)))
  5991. (todo-state (save-match-data (org-get-todo-state)))
  5992. (done? (member todo-state org-done-keywords))
  5993. (sexp? (string-prefix-p "%%" s))
  5994. ;; DEADLINE is the deadline date for the entry. It is
  5995. ;; either the base date or the last repeat, according
  5996. ;; to `org-agenda-prefer-last-repeat'.
  5997. (deadline
  5998. (cond
  5999. (sexp? (org-agenda--timestamp-to-absolute s current))
  6000. ((or (eq org-agenda-prefer-last-repeat t)
  6001. (member todo-state org-agenda-prefer-last-repeat))
  6002. (org-agenda--timestamp-to-absolute
  6003. s today 'past (current-buffer) pos))
  6004. (t (org-agenda--timestamp-to-absolute s))))
  6005. ;; REPEAT is the future repeat closest from CURRENT,
  6006. ;; according to `org-agenda-show-future-repeats'. If
  6007. ;; the latter is nil, or if the time stamp has no
  6008. ;; repeat part, default to DEADLINE.
  6009. (repeat
  6010. (cond
  6011. (sexp? deadline)
  6012. ((<= current today) deadline)
  6013. ((not org-agenda-show-future-repeats) deadline)
  6014. (t
  6015. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6016. (1+ today)
  6017. current)))
  6018. (org-agenda--timestamp-to-absolute
  6019. s base 'future (current-buffer) pos)))))
  6020. (diff (- deadline current))
  6021. (suppress-prewarning
  6022. (let ((scheduled
  6023. (and org-agenda-skip-deadline-prewarning-if-scheduled
  6024. (org-entry-get nil "SCHEDULED"))))
  6025. (cond
  6026. ((not scheduled) nil)
  6027. ;; The current item has a scheduled date, so
  6028. ;; evaluate its prewarning lead time.
  6029. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  6030. ;; Use global prewarning-restart lead time.
  6031. org-agenda-skip-deadline-prewarning-if-scheduled)
  6032. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  6033. 'pre-scheduled)
  6034. ;; Set pre-warning to no earlier than SCHEDULED.
  6035. (min (- deadline
  6036. (org-agenda--timestamp-to-absolute scheduled))
  6037. org-deadline-warning-days))
  6038. ;; Set pre-warning to deadline.
  6039. (t 0))))
  6040. (wdays (or suppress-prewarning (org-get-wdays s))))
  6041. (cond
  6042. ;; Only display deadlines at their base date, at future
  6043. ;; repeat occurrences or in today agenda.
  6044. ((= current deadline) nil)
  6045. ((= current repeat) nil)
  6046. ((not today?) (throw :skip nil))
  6047. ;; Upcoming deadline: display within warning period WDAYS.
  6048. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  6049. ;; Overdue deadline: warn about it for
  6050. ;; `org-deadline-past-days' duration.
  6051. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  6052. ;; Possibly skip done tasks.
  6053. (when (and done?
  6054. (or org-agenda-skip-deadline-if-done
  6055. (/= deadline current)))
  6056. (throw :skip nil))
  6057. (save-excursion
  6058. (re-search-backward "^\\*+[ \t]+" nil t)
  6059. (goto-char (match-end 0))
  6060. (let* ((category (org-get-category))
  6061. (effort (save-match-data (or (get-text-property (point) 'effort)
  6062. (org-entry-get (point) org-effort-property))))
  6063. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6064. (level (make-string (org-reduced-level (org-outline-level))
  6065. ?\s))
  6066. (head (buffer-substring-no-properties
  6067. (point) (line-end-position)))
  6068. (inherited-tags
  6069. (or (eq org-agenda-show-inherited-tags 'always)
  6070. (and (listp org-agenda-show-inherited-tags)
  6071. (memq 'agenda org-agenda-show-inherited-tags))
  6072. (and (eq org-agenda-show-inherited-tags t)
  6073. (or (eq org-agenda-use-tag-inheritance t)
  6074. (memq 'agenda
  6075. org-agenda-use-tag-inheritance)))))
  6076. (tags (org-get-tags nil (not inherited-tags)))
  6077. (time
  6078. (cond
  6079. ;; No time of day designation if it is only
  6080. ;; a reminder.
  6081. ((and (/= current deadline) (/= current repeat)) nil)
  6082. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6083. (concat (substring s (match-beginning 1)) " "))
  6084. (t 'time)))
  6085. (item
  6086. (org-agenda-format-item
  6087. ;; Insert appropriate suffixes before deadlines.
  6088. ;; Those only apply to today agenda.
  6089. (pcase-let ((`(,now ,future ,past)
  6090. org-agenda-deadline-leaders))
  6091. (cond
  6092. ((and today? (< deadline today)) (format past (- diff)))
  6093. ((and today? (> deadline today)) (format future diff))
  6094. (t now)))
  6095. (org-add-props head nil
  6096. 'effort effort
  6097. 'effort-minutes effort-minutes)
  6098. level category tags time))
  6099. (face (org-agenda-deadline-face
  6100. (- 1 (/ (float diff) (max wdays 1)))))
  6101. (upcoming? (and today? (> deadline today)))
  6102. (warntime (get-text-property (point) 'org-appt-warntime)))
  6103. (org-add-props item props
  6104. 'org-marker (org-agenda-new-marker pos)
  6105. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6106. 'warntime warntime
  6107. 'level level
  6108. 'effort effort 'effort-minutes effort-minutes
  6109. 'ts-date deadline
  6110. 'priority
  6111. ;; Adjust priority to today reminders about deadlines.
  6112. ;; Overdue deadlines get the highest priority
  6113. ;; increase, then imminent deadlines and eventually
  6114. ;; more distant deadlines.
  6115. (let ((adjust (if today? (- diff) 0)))
  6116. (+ adjust (org-get-priority item)))
  6117. 'todo-state todo-state
  6118. 'type (if upcoming? "upcoming-deadline" "deadline")
  6119. 'date (if upcoming? date deadline)
  6120. 'face (if done? 'org-agenda-done face)
  6121. 'undone-face face
  6122. 'done-face 'org-agenda-done)
  6123. (push item deadline-items)))))))
  6124. (nreverse deadline-items)))
  6125. (defun org-agenda-deadline-face (fraction)
  6126. "Return the face to displaying a deadline item.
  6127. FRACTION is what fraction of the head-warning time has passed."
  6128. (assoc-default fraction org-agenda-deadline-faces #'<=))
  6129. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  6130. "Return the scheduled information for agenda display.
  6131. Optional argument DEADLINES is a list of deadline items to be
  6132. displayed in agenda view. When WITH-HOUR is non-nil, only return
  6133. scheduled items with an hour specification like [h]h:mm."
  6134. (with-no-warnings (defvar date))
  6135. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  6136. 'org-todo-regexp org-todo-regexp
  6137. 'org-complex-heading-regexp org-complex-heading-regexp
  6138. 'done-face 'org-agenda-done
  6139. 'mouse-face 'highlight
  6140. 'help-echo
  6141. (format "mouse-2 or RET jump to Org file %s"
  6142. (abbreviate-file-name buffer-file-name))))
  6143. (regexp (if with-hour
  6144. org-scheduled-time-hour-regexp
  6145. org-scheduled-time-regexp))
  6146. (today (org-today))
  6147. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  6148. (current (calendar-absolute-from-gregorian date))
  6149. (deadline-pos
  6150. (mapcar (lambda (d)
  6151. (let ((m (get-text-property 0 'org-hd-marker d)))
  6152. (and m (marker-position m))))
  6153. deadlines))
  6154. scheduled-items)
  6155. (goto-char (point-min))
  6156. (if (org-element--cache-active-p)
  6157. (org-element-cache-map
  6158. (lambda (el)
  6159. (when (and (org-element-property :scheduled el)
  6160. (or (not with-hour)
  6161. (org-element-property
  6162. :hour-start
  6163. (org-element-property :scheduled el))
  6164. (org-element-property
  6165. :hour-end
  6166. (org-element-property :scheduled el))))
  6167. (goto-char (org-element-property :contents-begin el))
  6168. (catch :skip
  6169. (org-agenda-skip el)
  6170. (let* ((s (substring (org-element-property
  6171. :raw-value
  6172. (org-element-property :scheduled el))
  6173. 1 -1))
  6174. (pos (save-excursion
  6175. (goto-char (org-element-property :contents-begin el))
  6176. ;; We intentionally leave NOERROR
  6177. ;; argument in `re-search-forward' nil. If
  6178. ;; the search fails here, something went
  6179. ;; wrong and we are looking at
  6180. ;; non-matching headline.
  6181. (re-search-forward regexp (line-end-position))
  6182. (1- (match-beginning 1))))
  6183. (todo-state (org-element-property :todo-keyword el))
  6184. (donep (eq 'done (org-element-property :todo-type el)))
  6185. (sexp? (eq 'diary
  6186. (org-element-property
  6187. :type (org-element-property :scheduled el))))
  6188. ;; SCHEDULE is the scheduled date for the entry. It is
  6189. ;; either the bare date or the last repeat, according
  6190. ;; to `org-agenda-prefer-last-repeat'.
  6191. (schedule
  6192. (cond
  6193. (sexp? (org-agenda--timestamp-to-absolute s current))
  6194. ((or (eq org-agenda-prefer-last-repeat t)
  6195. (member todo-state org-agenda-prefer-last-repeat))
  6196. (org-agenda--timestamp-to-absolute
  6197. s today 'past (current-buffer) pos))
  6198. (t (org-agenda--timestamp-to-absolute s))))
  6199. ;; REPEAT is the future repeat closest from CURRENT,
  6200. ;; according to `org-agenda-show-future-repeats'. If
  6201. ;; the latter is nil, or if the time stamp has no
  6202. ;; repeat part, default to SCHEDULE.
  6203. (repeat
  6204. (cond
  6205. (sexp? schedule)
  6206. ((<= current today) schedule)
  6207. ((not org-agenda-show-future-repeats) schedule)
  6208. (t
  6209. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6210. (1+ today)
  6211. current)))
  6212. (org-agenda--timestamp-to-absolute
  6213. s base 'future (current-buffer) pos)))))
  6214. (diff (- current schedule))
  6215. (warntime (get-text-property (point) 'org-appt-warntime))
  6216. (pastschedp (< schedule today))
  6217. (futureschedp (> schedule today))
  6218. (habitp (and (fboundp 'org-is-habit-p)
  6219. (string= "habit" (org-element-property :STYLE el))))
  6220. (suppress-delay
  6221. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  6222. (org-element-property
  6223. :raw-value
  6224. (org-element-property :deadline el)))))
  6225. (cond
  6226. ((not deadline) nil)
  6227. ;; The current item has a deadline date, so
  6228. ;; evaluate its delay time.
  6229. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  6230. ;; Use global delay time.
  6231. (- org-agenda-skip-scheduled-delay-if-deadline))
  6232. ((eq org-agenda-skip-scheduled-delay-if-deadline
  6233. 'post-deadline)
  6234. ;; Set delay to no later than DEADLINE.
  6235. (min (- schedule
  6236. (org-agenda--timestamp-to-absolute deadline))
  6237. org-scheduled-delay-days))
  6238. (t 0))))
  6239. (ddays
  6240. (cond
  6241. ;; Nullify delay when a repeater triggered already
  6242. ;; and the delay is of the form --Xd.
  6243. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  6244. (> schedule (org-agenda--timestamp-to-absolute s)))
  6245. 0)
  6246. (suppress-delay
  6247. (let ((org-scheduled-delay-days suppress-delay))
  6248. (org-get-wdays s t t)))
  6249. (t (org-get-wdays s t)))))
  6250. ;; Display scheduled items at base date (SCHEDULE), today if
  6251. ;; scheduled before the current date, and at any repeat past
  6252. ;; today. However, skip delayed items and items that have
  6253. ;; been displayed for more than `org-scheduled-past-days'.
  6254. (unless (and todayp
  6255. habitp
  6256. (bound-and-true-p org-habit-show-all-today))
  6257. (when (or (and (> ddays 0) (< diff ddays))
  6258. (> diff (or (and habitp org-habit-scheduled-past-days)
  6259. org-scheduled-past-days))
  6260. (> schedule current)
  6261. (and (/= current schedule)
  6262. (/= current today)
  6263. (/= current repeat)))
  6264. (throw :skip nil)))
  6265. ;; Possibly skip done tasks.
  6266. (when (and donep
  6267. (or org-agenda-skip-scheduled-if-done
  6268. (/= schedule current)))
  6269. (throw :skip nil))
  6270. ;; Skip entry if it already appears as a deadline, per
  6271. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  6272. ;; doesn't apply to habits.
  6273. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  6274. ((guard
  6275. (or (not (memq (line-beginning-position 0) deadline-pos))
  6276. habitp))
  6277. nil)
  6278. (`repeated-after-deadline
  6279. (let ((deadline (time-to-days
  6280. (when (org-element-property :deadline el)
  6281. (org-time-string-to-time
  6282. (org-element-property :deadline el))))))
  6283. (and (<= schedule deadline) (> current deadline))))
  6284. (`not-today pastschedp)
  6285. (`t t)
  6286. (_ nil))
  6287. (throw :skip nil))
  6288. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  6289. ;; only show them for today. Also skip done habits.
  6290. (when (and habitp
  6291. (or donep
  6292. (not (bound-and-true-p org-habit-show-habits))
  6293. (and (not todayp)
  6294. (bound-and-true-p
  6295. org-habit-show-habits-only-for-today))))
  6296. (throw :skip nil))
  6297. (save-excursion
  6298. (goto-char (org-element-property :begin el))
  6299. (let* ((category (org-get-category))
  6300. (effort (save-match-data
  6301. (or (get-text-property (point) 'effort)
  6302. (org-element-property (intern (concat ":" (upcase org-effort-property))) el))))
  6303. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6304. (inherited-tags
  6305. (or (eq org-agenda-show-inherited-tags 'always)
  6306. (and (listp org-agenda-show-inherited-tags)
  6307. (memq 'agenda org-agenda-show-inherited-tags))
  6308. (and (eq org-agenda-show-inherited-tags t)
  6309. (or (eq org-agenda-use-tag-inheritance t)
  6310. (memq 'agenda
  6311. org-agenda-use-tag-inheritance)))))
  6312. (tags (org-get-tags el (not inherited-tags)))
  6313. (level (make-string (org-element-property :level el)
  6314. ?\s))
  6315. (head (save-excursion
  6316. (goto-char (org-element-property :begin el))
  6317. (re-search-forward org-outline-regexp-bol)
  6318. (buffer-substring (point) (line-end-position))))
  6319. (time
  6320. (cond
  6321. ;; No time of day designation if it is only a
  6322. ;; reminder, except for habits, which always show
  6323. ;; the time of day. Habits are an exception
  6324. ;; because if there is a time of day, that is
  6325. ;; interpreted to mean they should usually happen
  6326. ;; then, even if doing the habit was missed.
  6327. ((and
  6328. (not habitp)
  6329. (/= current schedule)
  6330. (/= current repeat))
  6331. nil)
  6332. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6333. (concat (substring s (match-beginning 1)) " "))
  6334. (t 'time)))
  6335. (item
  6336. (org-agenda-format-item
  6337. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6338. ;; Show a reminder of a past scheduled today.
  6339. (if (and todayp pastschedp)
  6340. (format past diff)
  6341. first))
  6342. (org-add-props head nil
  6343. 'effort effort
  6344. 'effort-minutes effort-minutes)
  6345. level category tags time nil habitp))
  6346. (face (cond ((and (not habitp) pastschedp)
  6347. 'org-scheduled-previously)
  6348. ((and habitp futureschedp)
  6349. 'org-agenda-done)
  6350. (todayp 'org-scheduled-today)
  6351. (t 'org-scheduled)))
  6352. (habitp (and habitp (org-habit-parse-todo (org-element-property :begin el)))))
  6353. (org-add-props item props
  6354. 'undone-face face
  6355. 'face (if donep 'org-agenda-done face)
  6356. 'org-marker (org-agenda-new-marker pos)
  6357. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6358. 'type (if pastschedp "past-scheduled" "scheduled")
  6359. 'date (if pastschedp schedule date)
  6360. 'ts-date schedule
  6361. 'warntime warntime
  6362. 'level level
  6363. 'effort effort 'effort-minutes effort-minutes
  6364. 'priority (if habitp (org-habit-get-priority habitp)
  6365. (+ 99 diff (org-get-priority item)))
  6366. 'org-habit-p habitp
  6367. 'todo-state todo-state)
  6368. (push item scheduled-items)))))))
  6369. :next-re regexp
  6370. :fail-re regexp
  6371. :narrow t)
  6372. (while (re-search-forward regexp nil t)
  6373. (catch :skip
  6374. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  6375. (org-agenda-skip)
  6376. (let* ((s (match-string 1))
  6377. (pos (1- (match-beginning 1)))
  6378. (todo-state (save-match-data (org-get-todo-state)))
  6379. (donep (member todo-state org-done-keywords))
  6380. (sexp? (string-prefix-p "%%" s))
  6381. ;; SCHEDULE is the scheduled date for the entry. It is
  6382. ;; either the bare date or the last repeat, according
  6383. ;; to `org-agenda-prefer-last-repeat'.
  6384. (schedule
  6385. (cond
  6386. (sexp? (org-agenda--timestamp-to-absolute s current))
  6387. ((or (eq org-agenda-prefer-last-repeat t)
  6388. (member todo-state org-agenda-prefer-last-repeat))
  6389. (org-agenda--timestamp-to-absolute
  6390. s today 'past (current-buffer) pos))
  6391. (t (org-agenda--timestamp-to-absolute s))))
  6392. ;; REPEAT is the future repeat closest from CURRENT,
  6393. ;; according to `org-agenda-show-future-repeats'. If
  6394. ;; the latter is nil, or if the time stamp has no
  6395. ;; repeat part, default to SCHEDULE.
  6396. (repeat
  6397. (cond
  6398. (sexp? schedule)
  6399. ((<= current today) schedule)
  6400. ((not org-agenda-show-future-repeats) schedule)
  6401. (t
  6402. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6403. (1+ today)
  6404. current)))
  6405. (org-agenda--timestamp-to-absolute
  6406. s base 'future (current-buffer) pos)))))
  6407. (diff (- current schedule))
  6408. (warntime (get-text-property (point) 'org-appt-warntime))
  6409. (pastschedp (< schedule today))
  6410. (futureschedp (> schedule today))
  6411. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  6412. (suppress-delay
  6413. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  6414. (org-entry-get nil "DEADLINE"))))
  6415. (cond
  6416. ((not deadline) nil)
  6417. ;; The current item has a deadline date, so
  6418. ;; evaluate its delay time.
  6419. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  6420. ;; Use global delay time.
  6421. (- org-agenda-skip-scheduled-delay-if-deadline))
  6422. ((eq org-agenda-skip-scheduled-delay-if-deadline
  6423. 'post-deadline)
  6424. ;; Set delay to no later than DEADLINE.
  6425. (min (- schedule
  6426. (org-agenda--timestamp-to-absolute deadline))
  6427. org-scheduled-delay-days))
  6428. (t 0))))
  6429. (ddays
  6430. (cond
  6431. ;; Nullify delay when a repeater triggered already
  6432. ;; and the delay is of the form --Xd.
  6433. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  6434. (> schedule (org-agenda--timestamp-to-absolute s)))
  6435. 0)
  6436. (suppress-delay
  6437. (let ((org-scheduled-delay-days suppress-delay))
  6438. (org-get-wdays s t t)))
  6439. (t (org-get-wdays s t)))))
  6440. ;; Display scheduled items at base date (SCHEDULE), today if
  6441. ;; scheduled before the current date, and at any repeat past
  6442. ;; today. However, skip delayed items and items that have
  6443. ;; been displayed for more than `org-scheduled-past-days'.
  6444. (unless (and todayp
  6445. habitp
  6446. (bound-and-true-p org-habit-show-all-today))
  6447. (when (or (and (> ddays 0) (< diff ddays))
  6448. (> diff (or (and habitp org-habit-scheduled-past-days)
  6449. org-scheduled-past-days))
  6450. (> schedule current)
  6451. (and (/= current schedule)
  6452. (/= current today)
  6453. (/= current repeat)))
  6454. (throw :skip nil)))
  6455. ;; Possibly skip done tasks.
  6456. (when (and donep
  6457. (or org-agenda-skip-scheduled-if-done
  6458. (/= schedule current)))
  6459. (throw :skip nil))
  6460. ;; Skip entry if it already appears as a deadline, per
  6461. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  6462. ;; doesn't apply to habits.
  6463. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  6464. ((guard
  6465. (or (not (memq (line-beginning-position 0) deadline-pos))
  6466. habitp))
  6467. nil)
  6468. (`repeated-after-deadline
  6469. (let ((deadline (time-to-days
  6470. (org-get-deadline-time (point)))))
  6471. (and (<= schedule deadline) (> current deadline))))
  6472. (`not-today pastschedp)
  6473. (`t t)
  6474. (_ nil))
  6475. (throw :skip nil))
  6476. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  6477. ;; only show them for today. Also skip done habits.
  6478. (when (and habitp
  6479. (or donep
  6480. (not (bound-and-true-p org-habit-show-habits))
  6481. (and (not todayp)
  6482. (bound-and-true-p
  6483. org-habit-show-habits-only-for-today))))
  6484. (throw :skip nil))
  6485. (save-excursion
  6486. (re-search-backward "^\\*+[ \t]+" nil t)
  6487. (goto-char (match-end 0))
  6488. (let* ((category (org-get-category))
  6489. (effort (save-match-data (or (get-text-property (point) 'effort)
  6490. (org-entry-get (point) org-effort-property))))
  6491. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6492. (inherited-tags
  6493. (or (eq org-agenda-show-inherited-tags 'always)
  6494. (and (listp org-agenda-show-inherited-tags)
  6495. (memq 'agenda org-agenda-show-inherited-tags))
  6496. (and (eq org-agenda-show-inherited-tags t)
  6497. (or (eq org-agenda-use-tag-inheritance t)
  6498. (memq 'agenda
  6499. org-agenda-use-tag-inheritance)))))
  6500. (tags (org-get-tags nil (not inherited-tags)))
  6501. (level (make-string (org-reduced-level (org-outline-level))
  6502. ?\s))
  6503. (head (buffer-substring (point) (line-end-position)))
  6504. (time
  6505. (cond
  6506. ;; No time of day designation if it is only a
  6507. ;; reminder, except for habits, which always show
  6508. ;; the time of day. Habits are an exception
  6509. ;; because if there is a time of day, that is
  6510. ;; interpreted to mean they should usually happen
  6511. ;; then, even if doing the habit was missed.
  6512. ((and
  6513. (not habitp)
  6514. (/= current schedule)
  6515. (/= current repeat))
  6516. nil)
  6517. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6518. (concat (substring s (match-beginning 1)) " "))
  6519. (t 'time)))
  6520. (item
  6521. (org-agenda-format-item
  6522. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6523. ;; Show a reminder of a past scheduled today.
  6524. (if (and todayp pastschedp)
  6525. (format past diff)
  6526. first))
  6527. (org-add-props head nil
  6528. 'effort effort
  6529. 'effort-minutes effort-minutes)
  6530. level category tags time nil habitp))
  6531. (face (cond ((and (not habitp) pastschedp)
  6532. 'org-scheduled-previously)
  6533. ((and habitp futureschedp)
  6534. 'org-agenda-done)
  6535. (todayp 'org-scheduled-today)
  6536. (t 'org-scheduled)))
  6537. (habitp (and habitp (org-habit-parse-todo))))
  6538. (org-add-props item props
  6539. 'undone-face face
  6540. 'face (if donep 'org-agenda-done face)
  6541. 'org-marker (org-agenda-new-marker pos)
  6542. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6543. 'type (if pastschedp "past-scheduled" "scheduled")
  6544. 'date (if pastschedp schedule date)
  6545. 'ts-date schedule
  6546. 'warntime warntime
  6547. 'level level
  6548. 'effort effort 'effort-minutes effort-minutes
  6549. 'priority (if habitp (org-habit-get-priority habitp)
  6550. (+ 99 diff (org-get-priority item)))
  6551. 'org-habit-p habitp
  6552. 'todo-state todo-state)
  6553. (push item scheduled-items)))))))
  6554. (nreverse scheduled-items)))
  6555. (defun org-agenda-get-blocks ()
  6556. "Return the date-range information for agenda display."
  6557. (with-no-warnings (defvar date))
  6558. (let* ((props (list 'face nil
  6559. 'org-not-done-regexp org-not-done-regexp
  6560. 'org-todo-regexp org-todo-regexp
  6561. 'org-complex-heading-regexp org-complex-heading-regexp
  6562. 'mouse-face 'highlight
  6563. 'help-echo
  6564. (format "mouse-2 or RET jump to org file %s"
  6565. (abbreviate-file-name buffer-file-name))))
  6566. (regexp org-tr-regexp)
  6567. (d0 (calendar-absolute-from-gregorian date))
  6568. marker hdmarker ee txt d1 d2 s1 s2 category
  6569. level todo-state tags pos head donep inherited-tags
  6570. effort effort-minutes)
  6571. (goto-char (point-min))
  6572. (while (re-search-forward regexp nil t)
  6573. (catch :skip
  6574. (org-agenda-skip)
  6575. (setq pos (point))
  6576. (let ((start-time (match-string 1))
  6577. (end-time (match-string 2)))
  6578. (setq s1 (match-string 1)
  6579. s2 (match-string 2)
  6580. d1 (time-to-days
  6581. (condition-case err
  6582. (org-time-string-to-time s1)
  6583. (error
  6584. (error
  6585. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6586. s1
  6587. pos
  6588. (current-buffer)
  6589. (error-message-string err)))))
  6590. d2 (time-to-days
  6591. (condition-case err
  6592. (org-time-string-to-time s2)
  6593. (error
  6594. (error
  6595. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6596. s2
  6597. pos
  6598. (current-buffer)
  6599. (error-message-string err))))))
  6600. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6601. ;; Only allow days between the limits, because the normal
  6602. ;; date stamps will catch the limits.
  6603. (save-excursion
  6604. (setq todo-state (org-get-todo-state))
  6605. (setq donep (member todo-state org-done-keywords))
  6606. (when (and donep org-agenda-skip-timestamp-if-done)
  6607. (throw :skip t))
  6608. (setq marker (org-agenda-new-marker (point))
  6609. category (org-get-category))
  6610. (setq effort (save-match-data (or (get-text-property (point) 'effort)
  6611. (org-entry-get (point) org-effort-property))))
  6612. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6613. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6614. (throw :skip nil)
  6615. (goto-char (match-beginning 0))
  6616. (setq hdmarker (org-agenda-new-marker (point))
  6617. inherited-tags
  6618. (or (eq org-agenda-show-inherited-tags 'always)
  6619. (and (listp org-agenda-show-inherited-tags)
  6620. (memq 'agenda org-agenda-show-inherited-tags))
  6621. (and (eq org-agenda-show-inherited-tags t)
  6622. (or (eq org-agenda-use-tag-inheritance t)
  6623. (memq 'agenda org-agenda-use-tag-inheritance))))
  6624. tags (org-get-tags nil (not inherited-tags)))
  6625. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6626. (looking-at "\\*+[ \t]+\\(.*\\)")
  6627. (setq head (match-string 1))
  6628. (let ((remove-re
  6629. (if org-agenda-remove-timeranges-from-blocks
  6630. (concat
  6631. "<" (regexp-quote s1) ".*?>"
  6632. "--"
  6633. "<" (regexp-quote s2) ".*?>")
  6634. nil)))
  6635. (setq txt (org-agenda-format-item
  6636. (format
  6637. (nth (if (= d1 d2) 0 1)
  6638. org-agenda-timerange-leaders)
  6639. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6640. (org-add-props head nil
  6641. 'effort effort
  6642. 'effort-minutes effort-minutes)
  6643. level category tags
  6644. (save-match-data
  6645. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6646. (match-string 6 s1)))
  6647. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6648. (match-string 6 s2))))
  6649. (cond ((string= hhmm1 hhmm2)
  6650. (concat "<" start-time ">--<" end-time ">"))
  6651. ((and (= d1 d0) (= d2 d0))
  6652. (concat "<" start-time ">--<" end-time ">"))
  6653. ((= d1 d0)
  6654. (concat "<" start-time ">"))
  6655. ((= d2 d0)
  6656. (concat "<" end-time ">")))))
  6657. remove-re))))
  6658. (org-add-props txt props
  6659. 'org-marker marker 'org-hd-marker hdmarker
  6660. 'type "block" 'date date
  6661. 'level level
  6662. 'effort effort 'effort-minutes effort-minutes
  6663. 'todo-state todo-state
  6664. 'priority (org-get-priority txt))
  6665. (push txt ee))))
  6666. (goto-char pos)))
  6667. ;; Sort the entries by expiration date.
  6668. (nreverse ee)))
  6669. ;;; Agenda presentation and sorting
  6670. (defvar org-prefix-has-time nil
  6671. "A flag, set by `org-compile-prefix-format'.
  6672. The flag is set if the currently compiled format contains a `%t'.")
  6673. (defvar org-prefix-has-tag nil
  6674. "A flag, set by `org-compile-prefix-format'.
  6675. The flag is set if the currently compiled format contains a `%T'.")
  6676. (defvar org-prefix-has-effort nil
  6677. "A flag, set by `org-compile-prefix-format'.
  6678. The flag is set if the currently compiled format contains a `%e'.")
  6679. (defvar org-prefix-has-breadcrumbs nil
  6680. "A flag, set by `org-compile-prefix-format'.
  6681. The flag is set if the currently compiled format contains a `%b'.")
  6682. (defvar org-prefix-category-length nil
  6683. "Used by `org-compile-prefix-format' to remember the category field width.")
  6684. (defvar org-prefix-category-max-length nil
  6685. "Used by `org-compile-prefix-format' to remember the category field width.")
  6686. (defun org-agenda-get-category-icon (category)
  6687. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6688. (cl-dolist (entry org-agenda-category-icon-alist)
  6689. (when (string-match-p (car entry) category)
  6690. (if (listp (cadr entry))
  6691. (cl-return (cadr entry))
  6692. (cl-return (apply #'create-image (cdr entry)))))))
  6693. (defun org-agenda-format-item (extra txt &optional with-level with-category tags dotime
  6694. remove-re habitp)
  6695. "Format TXT to be inserted into the agenda buffer.
  6696. In particular, add the prefix and corresponding text properties.
  6697. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6698. WITH-LEVEL may be a string to replace the `%l' specifier.
  6699. WITH-CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6700. category taken from local variable or file name. It will replace the `%c'
  6701. specifier in the format.
  6702. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6703. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6704. When DOTIME is a string, this string is searched for a time before TXT is.
  6705. TAGS can be the tags of the headline.
  6706. Any match of REMOVE-RE will be removed from TXT."
  6707. ;; We keep the org-prefix-* variable values along with a compiled
  6708. ;; formatter, so that multiple agendas existing at the same time do
  6709. ;; not step on each other toes.
  6710. ;;
  6711. ;; It was inconvenient to make these variables buffer local in
  6712. ;; Agenda buffers, because this function expects to be called with
  6713. ;; the buffer where item comes from being current, and not agenda
  6714. ;; buffer
  6715. (let* ((bindings (car org-prefix-format-compiled))
  6716. (formatter (cadr org-prefix-format-compiled)))
  6717. (cl-loop for (var value) in bindings
  6718. do (set var value))
  6719. (save-match-data
  6720. ;; Diary entries sometimes have extra whitespace at the beginning
  6721. (setq txt (org-trim txt))
  6722. ;; Fix the tags part in txt
  6723. (setq txt (org-agenda-fix-displayed-tags
  6724. txt tags
  6725. org-agenda-show-inherited-tags
  6726. org-agenda-hide-tags-regexp))
  6727. (with-no-warnings
  6728. ;; `time', `tag', `effort' are needed for the eval of the prefix format.
  6729. ;; Based on what I see in `org-compile-prefix-format', I added
  6730. ;; a few more.
  6731. (defvar breadcrumbs) (defvar category) (defvar category-icon)
  6732. (defvar effort) (defvar extra)
  6733. (defvar level) (defvar tag) (defvar time))
  6734. (let* ((category (or with-category
  6735. (if buffer-file-name
  6736. (file-name-sans-extension
  6737. (file-name-nondirectory buffer-file-name))
  6738. "")))
  6739. (category-icon (org-agenda-get-category-icon category))
  6740. (category-icon (if category-icon
  6741. (propertize " " 'display category-icon)
  6742. ""))
  6743. (effort (and (not (string= txt ""))
  6744. (get-text-property 1 'effort txt)))
  6745. (tag (if tags (nth (1- (length tags)) tags) ""))
  6746. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6747. (extra (or (and (not habitp) extra) ""))
  6748. time
  6749. (ts (when dotime (concat
  6750. (if (stringp dotime) dotime "")
  6751. (and org-agenda-search-headline-for-time txt))))
  6752. (time-of-day (and dotime (org-get-time-of-day ts)))
  6753. stamp plain s0 s1 s2 rtn srp l
  6754. duration breadcrumbs)
  6755. (and (derived-mode-p 'org-mode) buffer-file-name
  6756. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6757. (when (and dotime time-of-day)
  6758. ;; Extract starting and ending time and move them to prefix
  6759. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6760. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6761. (setq s0 (match-string 0 ts)
  6762. srp (and stamp (match-end 3))
  6763. s1 (match-string (if plain 1 2) ts)
  6764. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6765. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6766. ;; them, we might want to remove them there to avoid duplication.
  6767. ;; The user can turn this off with a variable.
  6768. (when (and org-prefix-has-time
  6769. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6770. (string-match (concat (regexp-quote s0) " *") txt)
  6771. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6772. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6773. (= (match-beginning 0) 0)
  6774. t))
  6775. (setq txt (replace-match "" nil nil txt))))
  6776. ;; Normalize the time(s) to 24 hour.
  6777. (when s1 (setq s1 (org-get-time-of-day s1 t)))
  6778. (when s2 (setq s2 (org-get-time-of-day s2 t)))
  6779. ;; Try to set s2 if s1 and
  6780. ;; `org-agenda-default-appointment-duration' are set
  6781. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6782. (setq s2
  6783. (org-duration-from-minutes
  6784. (+ (org-duration-to-minutes s1 t)
  6785. org-agenda-default-appointment-duration)
  6786. nil t)))
  6787. ;; Compute the duration
  6788. (when s2
  6789. (setq duration (- (org-duration-to-minutes s2)
  6790. (org-duration-to-minutes s1))))
  6791. ;; Format S1 and S2 for display.
  6792. (when s1 (setq s1 (format "%5s" (org-get-time-of-day s1 'overtime))))
  6793. (when s2 (setq s2 (org-get-time-of-day s2 'overtime))))
  6794. (when (string-match org-tag-group-re txt)
  6795. ;; Tags are in the string
  6796. (if (or (eq org-agenda-remove-tags t)
  6797. (and org-agenda-remove-tags
  6798. org-prefix-has-tag))
  6799. (setq txt (replace-match "" t t txt))
  6800. (setq txt (replace-match
  6801. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6802. (match-string 1 txt))
  6803. t t txt))))
  6804. (when remove-re
  6805. (while (string-match remove-re txt)
  6806. (setq txt (replace-match "" t t txt))))
  6807. ;; Set org-heading property on `txt' to mark the start of the
  6808. ;; heading.
  6809. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6810. ;; Prepare the variables needed in the eval of the compiled format
  6811. (when org-prefix-has-breadcrumbs
  6812. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6813. (let ((s (org-format-outline-path (org-get-outline-path)
  6814. (1- (frame-width))
  6815. nil org-agenda-breadcrumbs-separator)))
  6816. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6817. (setq time (cond (s2 (concat
  6818. (org-agenda-time-of-day-to-ampm-maybe s1)
  6819. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6820. (when org-agenda-timegrid-use-ampm " ")))
  6821. (s1 (concat
  6822. (org-agenda-time-of-day-to-ampm-maybe s1)
  6823. (if org-agenda-timegrid-use-ampm
  6824. (concat time-grid-trailing-characters " ")
  6825. time-grid-trailing-characters)))
  6826. (t ""))
  6827. category (if (symbolp category) (symbol-name category) category)
  6828. level (or with-level ""))
  6829. (if (string-match org-link-bracket-re category)
  6830. (progn
  6831. (setq l (string-width (or (match-string 2) (match-string 1))))
  6832. (when (< l (or org-prefix-category-length 0))
  6833. (setq category (copy-sequence category))
  6834. (org-add-props category nil
  6835. 'extra-space (make-string
  6836. (- org-prefix-category-length l 1) ?\ ))))
  6837. (when (and org-prefix-category-max-length
  6838. (>= (length category) org-prefix-category-max-length))
  6839. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6840. ;; Evaluate the compiled format
  6841. (setq rtn (concat (eval formatter t) txt))
  6842. ;; And finally add the text properties
  6843. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6844. (org-add-props rtn nil
  6845. 'org-category category
  6846. 'tags tags
  6847. 'org-priority-highest org-priority-highest
  6848. 'org-priority-lowest org-priority-lowest
  6849. 'time-of-day time-of-day
  6850. 'duration duration
  6851. 'breadcrumbs breadcrumbs
  6852. 'txt txt
  6853. 'level level
  6854. 'time time
  6855. 'extra extra
  6856. 'format org-prefix-format-compiled
  6857. 'dotime dotime)))))
  6858. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6859. "Remove tags string from TXT, and add a modified list of tags.
  6860. The modified list may contain inherited tags, and tags matched by
  6861. `org-agenda-hide-tags-regexp' will be removed."
  6862. (when (or add-inherited hide-re)
  6863. (when (string-match org-tag-group-re txt)
  6864. (setq txt (substring txt 0 (match-beginning 0))))
  6865. (setq tags
  6866. (delq nil
  6867. (mapcar (lambda (tg)
  6868. (if (or (and hide-re (string-match hide-re tg))
  6869. (and (not add-inherited)
  6870. (get-text-property 0 'inherited tg)))
  6871. nil
  6872. tg))
  6873. tags)))
  6874. (when tags
  6875. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6876. i)
  6877. (setq txt (concat txt " :"
  6878. (mapconcat
  6879. (lambda (x)
  6880. (setq i (get-text-property 0 'inherited x))
  6881. (if (and have-i (not i))
  6882. (progn
  6883. (setq have-i nil)
  6884. (concat ":" x))
  6885. x))
  6886. tags ":")
  6887. (if have-i "::" ":"))))))
  6888. txt)
  6889. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6890. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6891. "Add a time-grid for agenda items which need it.
  6892. LIST is the list of agenda items formatted by `org-agenda-list'.
  6893. NDAYS is the span of the current agenda view.
  6894. TODAYP is t when the current agenda view is on today."
  6895. (catch 'exit
  6896. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6897. ((and todayp (member 'today (car org-agenda-time-grid))))
  6898. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6899. ((member 'weekly (car org-agenda-time-grid)))
  6900. (t (throw 'exit list)))
  6901. (let* ((have (delq nil (mapcar
  6902. (lambda (x) (get-text-property 1 'time-of-day x))
  6903. list)))
  6904. (string (nth 3 org-agenda-time-grid))
  6905. (gridtimes (nth 1 org-agenda-time-grid))
  6906. (req (car org-agenda-time-grid))
  6907. (remove (member 'remove-match req))
  6908. new time)
  6909. (when (and (member 'require-timed req) (not have))
  6910. ;; don't show empty grid
  6911. (throw 'exit list))
  6912. (while (setq time (pop gridtimes))
  6913. (unless (and remove (member time have))
  6914. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6915. (push (org-agenda-format-item
  6916. nil string nil "" nil
  6917. (concat (substring time 0 -2) ":" (substring time -2)))
  6918. new)
  6919. (put-text-property
  6920. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6921. (when (and todayp org-agenda-show-current-time-in-grid)
  6922. (push (org-agenda-format-item
  6923. nil org-agenda-current-time-string nil "" nil
  6924. (format-time-string "%H:%M "))
  6925. new)
  6926. (put-text-property
  6927. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6928. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6929. (append new list)
  6930. (append list new)))))
  6931. (defun org-compile-prefix-format (key)
  6932. "Compile the prefix format into a Lisp form that can be evaluated.
  6933. KEY is the agenda type (see `org-agenda-prefix-format').
  6934. The resulting form and associated variable bindings is returned
  6935. and stored in the variable `org-prefix-format-compiled'."
  6936. (setq org-prefix-has-time nil
  6937. org-prefix-has-tag nil
  6938. org-prefix-category-length nil
  6939. org-prefix-has-effort nil
  6940. org-prefix-has-breadcrumbs nil)
  6941. (let ((s (cond
  6942. ((stringp org-agenda-prefix-format)
  6943. org-agenda-prefix-format)
  6944. ((assq key org-agenda-prefix-format)
  6945. (cdr (assq key org-agenda-prefix-format)))
  6946. (t " %-12:c%?-12t% s")))
  6947. (start 0)
  6948. varform vars var c f opt) ;; e
  6949. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+?)\\)"
  6950. s start)
  6951. (setq var (or (cdr (assoc (match-string 4 s)
  6952. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6953. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6954. 'eval)
  6955. c (or (match-string 3 s) "")
  6956. opt (match-beginning 1)
  6957. start (1+ (match-beginning 0)))
  6958. (cl-case var
  6959. (time (setq org-prefix-has-time t))
  6960. (tag (setq org-prefix-has-tag t))
  6961. (effort (setq org-prefix-has-effort t))
  6962. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6963. (setq f (concat "%" (match-string 2 s) "s"))
  6964. (when (eq var 'category)
  6965. (setq org-prefix-category-length
  6966. (floor (abs (string-to-number (match-string 2 s)))))
  6967. (setq org-prefix-category-max-length
  6968. (let ((x (match-string 2 s)))
  6969. (save-match-data
  6970. (and (string-match "\\.[0-9]+" x)
  6971. (string-to-number (substring (match-string 0 x) 1)))))))
  6972. (if (eq var 'eval)
  6973. (setq varform `(format ,f (org-eval ,(read (substring s (match-beginning 4))))))
  6974. (if opt
  6975. (setq varform
  6976. `(if (member ,var '("" nil))
  6977. ""
  6978. (format ,f (concat ,var ,c))))
  6979. (setq varform
  6980. `(format ,f (if (member ,var '("" nil)) ""
  6981. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6982. (if (eq var 'eval)
  6983. (setf (substring s (match-beginning 0)
  6984. (+ (match-beginning 4)
  6985. (length (format "%S" (read (substring s (match-beginning 4)))))))
  6986. "%s")
  6987. (setq s (replace-match "%s" t nil s)))
  6988. (push varform vars))
  6989. (setq vars (nreverse vars))
  6990. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6991. (setq org-prefix-format-compiled
  6992. (list
  6993. `((org-prefix-has-time ,org-prefix-has-time)
  6994. (org-prefix-has-tag ,org-prefix-has-tag)
  6995. (org-prefix-category-length ,org-prefix-category-length)
  6996. (org-prefix-has-effort ,org-prefix-has-effort)
  6997. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6998. `(format ,s ,@vars))))))
  6999. (defun org-set-sorting-strategy (key)
  7000. (setq org-agenda-sorting-strategy-selected
  7001. (if (symbolp (car org-agenda-sorting-strategy))
  7002. ;; the old format
  7003. org-agenda-sorting-strategy
  7004. (or (cdr (assq key org-agenda-sorting-strategy))
  7005. (cdr (assq 'agenda org-agenda-sorting-strategy))
  7006. '(time-up category-keep priority-down)))))
  7007. (defun org-get-time-of-day (s &optional string)
  7008. "Check string S for a time of day.
  7009. If found, return it as a military time number between 0 and 2400.
  7010. If not found, return nil.
  7011. The optional STRING argument forces conversion into a 5 character wide string
  7012. HH:MM. When it is `overtime', any time above 24:00 is turned into \"+H:MM\"
  7013. where H:MM is the duration above midnight."
  7014. (let ((case-fold-search t)
  7015. (time-regexp
  7016. (rx word-start
  7017. (group (opt (any "012")) digit) ;group 1: hours
  7018. (or (and ":" (group (any "012345") digit) ;group 2: minutes
  7019. (opt (group (or "am" "pm")))) ;group 3: am/pm
  7020. ;; Special "HHam/pm" case.
  7021. (group-n 3 (or "am" "pm")))
  7022. word-end)))
  7023. (save-match-data
  7024. (when (and (string-match time-regexp s)
  7025. (not (eq 'org-link (get-text-property 1 'face s))))
  7026. (let ((hours
  7027. (let* ((ampm (and (match-end 3) (downcase (match-string 3 s))))
  7028. (am-p (equal ampm "am")))
  7029. (pcase (string-to-number (match-string 1 s))
  7030. ((and (guard (not ampm)) h) h)
  7031. (12 (if am-p 0 12))
  7032. (h (+ h (if am-p 0 12))))))
  7033. (minutes
  7034. (if (match-end 2)
  7035. (string-to-number (match-string 2 s))
  7036. 0)))
  7037. (pcase string
  7038. (`nil (+ minutes (* hours 100)))
  7039. ((and `overtime
  7040. (guard (or (> hours 24)
  7041. (and (= hours 24)
  7042. (> minutes 0)))))
  7043. (format "+%d:%02d" (- hours 24) minutes))
  7044. ((guard org-agenda-time-leading-zero)
  7045. (format "%02d:%02d" hours minutes))
  7046. (_
  7047. (format "%d:%02d" hours minutes))))))))
  7048. (defvar org-agenda-before-sorting-filter-function nil
  7049. "Function to be applied to agenda items prior to sorting.
  7050. Prior to sorting also means just before they are inserted into the agenda.
  7051. To aid sorting, you may revisit the original entries and add more text
  7052. properties which will later be used by the sorting functions.
  7053. The function should take a string argument, an agenda line.
  7054. It has access to the text properties in that line, which contain among
  7055. other things, the property `org-hd-marker' that points to the entry
  7056. where the line comes from. Note that not all lines going into the agenda
  7057. have this property, only most.
  7058. The function should return the modified string. It is probably best
  7059. to ONLY change text properties.
  7060. You can also use this function as a filter, by returning nil for lines
  7061. you don't want to have in the agenda at all. For this application, you
  7062. could bind the variable in the options section of a custom command.")
  7063. (defun org-agenda-finalize-entries (list &optional type)
  7064. "Sort, limit and concatenate the LIST of agenda items.
  7065. The optional argument TYPE tells the agenda type."
  7066. (let ((max-effort (cond ((listp org-agenda-max-effort)
  7067. (cdr (assoc type org-agenda-max-effort)))
  7068. (t org-agenda-max-effort)))
  7069. (max-todo (cond ((listp org-agenda-max-todos)
  7070. (cdr (assoc type org-agenda-max-todos)))
  7071. (t org-agenda-max-todos)))
  7072. (max-tags (cond ((listp org-agenda-max-tags)
  7073. (cdr (assoc type org-agenda-max-tags)))
  7074. (t org-agenda-max-tags)))
  7075. (max-entries (cond ((listp org-agenda-max-entries)
  7076. (cdr (assoc type org-agenda-max-entries)))
  7077. (t org-agenda-max-entries))))
  7078. (when org-agenda-before-sorting-filter-function
  7079. (setq list
  7080. (delq nil
  7081. (mapcar
  7082. org-agenda-before-sorting-filter-function list))))
  7083. (setq list (mapcar #'org-agenda-highlight-todo list)
  7084. list (mapcar #'identity (sort list #'org-entries-lessp)))
  7085. (when max-effort
  7086. (setq list (org-agenda-limit-entries
  7087. list 'effort-minutes max-effort
  7088. (lambda (e) (or e (if org-agenda-sort-noeffort-is-high
  7089. 32767 -1))))))
  7090. (when max-todo
  7091. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  7092. (when max-tags
  7093. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  7094. (when max-entries
  7095. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  7096. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  7097. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  7098. (mapconcat #'identity list "\n")))
  7099. (defun org-agenda-limit-entries (list prop limit &optional fn)
  7100. "Limit the number of agenda entries."
  7101. (let ((include (and limit (< limit 0))))
  7102. (if limit
  7103. (let ((fun (or fn (lambda (p) (when p 1))))
  7104. (lim 0))
  7105. (delq nil
  7106. (mapcar
  7107. (lambda (e)
  7108. (let ((pval (funcall
  7109. fun (get-text-property (1- (length e))
  7110. prop e))))
  7111. (when pval (setq lim (+ lim pval)))
  7112. (cond ((and pval (<= lim (abs limit))) e)
  7113. ((and include (not pval)) e))))
  7114. list)))
  7115. list)))
  7116. (defun org-agenda-limit-interactively (remove)
  7117. "In agenda, interactively limit entries to various maximums."
  7118. (interactive "P")
  7119. (if remove
  7120. (progn (setq org-agenda-max-entries nil
  7121. org-agenda-max-todos nil
  7122. org-agenda-max-tags nil
  7123. org-agenda-max-effort nil)
  7124. (org-agenda-redo))
  7125. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  7126. (msg (cond ((= max ?E) "How many minutes? ")
  7127. ((= max ?e) "How many entries? ")
  7128. ((= max ?t) "How many TODO entries? ")
  7129. ((= max ?T) "How many tagged entries? ")
  7130. (t (user-error "Wrong input"))))
  7131. (num (string-to-number (read-from-minibuffer msg))))
  7132. (cond ((equal max ?e)
  7133. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  7134. ((equal max ?t)
  7135. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  7136. ((equal max ?T)
  7137. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  7138. ((equal max ?E)
  7139. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  7140. (org-agenda-fit-window-to-buffer))
  7141. (defun org-agenda-highlight-todo (x)
  7142. (let ((org-done-keywords org-done-keywords-for-agenda)
  7143. (case-fold-search nil)
  7144. re)
  7145. (if (eq x 'line)
  7146. (save-excursion
  7147. (beginning-of-line 1)
  7148. (setq re (org-get-at-bol 'org-todo-regexp))
  7149. (goto-char (or (text-property-any (line-beginning-position) (line-end-position) 'org-heading t) (point)))
  7150. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  7151. (add-text-properties (match-beginning 0) (match-end 1)
  7152. (list 'face (org-get-todo-face 1)))
  7153. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  7154. (delete-region (match-beginning 1) (1- (match-end 0)))
  7155. (goto-char (match-beginning 1))
  7156. (insert (format org-agenda-todo-keyword-format s)))))
  7157. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  7158. (setq re (get-text-property 0 'org-todo-regexp x))
  7159. (when (and re
  7160. ;; Test `pl' because if there's no heading content,
  7161. ;; there's no point matching to highlight. Note
  7162. ;; that if we didn't test `pl' first, and there
  7163. ;; happened to be no keyword from `org-todo-regexp'
  7164. ;; on this heading line, then the `equal' comparison
  7165. ;; afterwards would spuriously succeed in the case
  7166. ;; where `pl' is nil -- causing an args-out-of-range
  7167. ;; error when we try to add text properties to text
  7168. ;; that isn't there.
  7169. pl
  7170. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  7171. x pl)
  7172. pl))
  7173. (add-text-properties
  7174. (or (match-end 1) (match-end 0)) (match-end 0)
  7175. (list 'face (org-get-todo-face (match-string 2 x)))
  7176. x)
  7177. (when (match-end 1)
  7178. (setq x
  7179. (concat
  7180. (substring x 0 (match-end 1))
  7181. (unless (string= org-agenda-todo-keyword-format "")
  7182. (format org-agenda-todo-keyword-format
  7183. (match-string 2 x)))
  7184. (unless (string= org-agenda-todo-keyword-format "")
  7185. ;; Remove `display' property as the icon could leak
  7186. ;; on the white space.
  7187. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  7188. 'display)))
  7189. (substring x (match-end 3)))))))
  7190. x)))
  7191. (defsubst org-cmp-values (a b property)
  7192. "Compare the numeric value of text PROPERTY for string A and B."
  7193. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  7194. (pb (or (get-text-property (1- (length b)) property b) 0)))
  7195. (cond ((> pa pb) +1)
  7196. ((< pa pb) -1))))
  7197. (defsubst org-cmp-effort (a b)
  7198. "Compare the effort values of string A and B."
  7199. (let* ((def (if org-agenda-sort-noeffort-is-high 32767 -1))
  7200. ;; `effort-minutes' property is not directly accessible from
  7201. ;; the strings, but is stored as a property in `txt'.
  7202. (ea (or (get-text-property
  7203. 0 'effort-minutes (get-text-property 0 'txt a))
  7204. def))
  7205. (eb (or (get-text-property
  7206. 0 'effort-minutes (get-text-property 0 'txt b))
  7207. def)))
  7208. (cond ((> ea eb) +1)
  7209. ((< ea eb) -1))))
  7210. (defsubst org-cmp-category (a b)
  7211. "Compare the string values of categories of strings A and B."
  7212. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  7213. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  7214. (cond ((string-lessp ca cb) -1)
  7215. ((string-lessp cb ca) +1))))
  7216. (defsubst org-cmp-todo-state (a b)
  7217. "Compare the todo states of strings A and B."
  7218. (let* ((ma (or (get-text-property 1 'org-marker a)
  7219. (get-text-property 1 'org-hd-marker a)))
  7220. (mb (or (get-text-property 1 'org-marker b)
  7221. (get-text-property 1 'org-hd-marker b)))
  7222. (fa (and ma (marker-buffer ma)))
  7223. (fb (and mb (marker-buffer mb)))
  7224. (todo-kwds
  7225. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  7226. (and fb (with-current-buffer fb org-todo-keywords-1))))
  7227. (ta (or (get-text-property 1 'todo-state a) ""))
  7228. (tb (or (get-text-property 1 'todo-state b) ""))
  7229. (la (- (length (member ta todo-kwds))))
  7230. (lb (- (length (member tb todo-kwds))))
  7231. (donepa (member ta org-done-keywords-for-agenda))
  7232. (donepb (member tb org-done-keywords-for-agenda)))
  7233. (cond ((and donepa (not donepb)) -1)
  7234. ((and (not donepa) donepb) +1)
  7235. ((< la lb) -1)
  7236. ((< lb la) +1))))
  7237. (defsubst org-cmp-alpha (a b)
  7238. "Compare the headlines, alphabetically."
  7239. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  7240. (plb (text-property-any 0 (length b) 'org-heading t b))
  7241. (ta (and pla (substring a pla)))
  7242. (tb (and plb (substring b plb)))
  7243. (case-fold-search nil))
  7244. (when pla
  7245. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  7246. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  7247. ta)
  7248. (setq ta (substring ta (match-end 0))))
  7249. (setq ta (downcase ta)))
  7250. (when plb
  7251. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  7252. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  7253. tb)
  7254. (setq tb (substring tb (match-end 0))))
  7255. (setq tb (downcase tb)))
  7256. (cond ((not (or ta tb)) nil)
  7257. ((not ta) +1)
  7258. ((not tb) -1)
  7259. ((string-lessp ta tb) -1)
  7260. ((string-lessp tb ta) +1))))
  7261. (defsubst org-cmp-tag (a b)
  7262. "Compare the string values of the first tags of A and B."
  7263. (let ((ta (car (last (get-text-property 1 'tags a))))
  7264. (tb (car (last (get-text-property 1 'tags b)))))
  7265. (cond ((not (or ta tb)) nil)
  7266. ((not ta) +1)
  7267. ((not tb) -1)
  7268. ((string-lessp ta tb) -1)
  7269. ((string-lessp tb ta) +1))))
  7270. (defsubst org-cmp-time (a b)
  7271. "Compare the time-of-day values of strings A and B."
  7272. (let* ((def (if org-agenda-sort-notime-is-late 9901 -1))
  7273. (ta (or (get-text-property 1 'time-of-day a) def))
  7274. (tb (or (get-text-property 1 'time-of-day b) def)))
  7275. (cond ((< ta tb) -1)
  7276. ((< tb ta) +1))))
  7277. (defsubst org-cmp-ts (a b type)
  7278. "Compare the timestamps values of entries A and B.
  7279. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  7280. \"timestamp_ia\", compare within each of these type. When TYPE
  7281. is the empty string, compare all timestamps without respect of
  7282. their type."
  7283. (let* ((def (if org-agenda-sort-notime-is-late 99999999 -1))
  7284. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  7285. (get-text-property 1 'ts-date a))
  7286. def))
  7287. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  7288. (get-text-property 1 'ts-date b))
  7289. def)))
  7290. (cond ((if ta (and tb (< ta tb)) tb) -1)
  7291. ((if tb (and ta (< tb ta)) ta) +1))))
  7292. (defsubst org-cmp-habit-p (a b)
  7293. "Compare the todo states of strings A and B."
  7294. (let ((ha (get-text-property 1 'org-habit-p a))
  7295. (hb (get-text-property 1 'org-habit-p b)))
  7296. (cond ((and ha (not hb)) -1)
  7297. ((and (not ha) hb) +1))))
  7298. (defun org-entries-lessp (a b)
  7299. "Predicate for sorting agenda entries."
  7300. ;; The following variables will be used when the form is evaluated.
  7301. ;; So even though the compiler complains, keep them.
  7302. (let ((ss org-agenda-sorting-strategy-selected))
  7303. (org-dlet
  7304. ((timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  7305. (org-cmp-ts a b "")))
  7306. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  7307. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  7308. (org-cmp-ts a b "scheduled")))
  7309. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  7310. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  7311. (org-cmp-ts a b "deadline")))
  7312. (deadline-down (if deadline-up (- deadline-up) nil))
  7313. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  7314. (org-cmp-ts a b "timestamp_ia")))
  7315. (tsia-down (if tsia-up (- tsia-up) nil))
  7316. (ts-up (and (org-em 'ts-up 'ts-down ss)
  7317. (org-cmp-ts a b "timestamp")))
  7318. (ts-down (if ts-up (- ts-up) nil))
  7319. (time-up (and (org-em 'time-up 'time-down ss)
  7320. (org-cmp-time a b)))
  7321. (time-down (if time-up (- time-up) nil))
  7322. (stats-up (and (org-em 'stats-up 'stats-down ss)
  7323. (org-cmp-values a b 'org-stats)))
  7324. (stats-down (if stats-up (- stats-up) nil))
  7325. (priority-up (and (org-em 'priority-up 'priority-down ss)
  7326. (org-cmp-values a b 'priority)))
  7327. (priority-down (if priority-up (- priority-up) nil))
  7328. (effort-up (and (org-em 'effort-up 'effort-down ss)
  7329. (org-cmp-effort a b)))
  7330. (effort-down (if effort-up (- effort-up) nil))
  7331. (category-up (and (or (org-em 'category-up 'category-down ss)
  7332. (memq 'category-keep ss))
  7333. (org-cmp-category a b)))
  7334. (category-down (if category-up (- category-up) nil))
  7335. (category-keep (if category-up +1 nil))
  7336. (tag-up (and (org-em 'tag-up 'tag-down ss)
  7337. (org-cmp-tag a b)))
  7338. (tag-down (if tag-up (- tag-up) nil))
  7339. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  7340. (org-cmp-todo-state a b)))
  7341. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  7342. (habit-up (and (org-em 'habit-up 'habit-down ss)
  7343. (org-cmp-habit-p a b)))
  7344. (habit-down (if habit-up (- habit-up) nil))
  7345. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  7346. (org-cmp-alpha a b)))
  7347. (alpha-down (if alpha-up (- alpha-up) nil))
  7348. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  7349. user-defined-up user-defined-down)
  7350. (when (and need-user-cmp org-agenda-cmp-user-defined
  7351. (functionp org-agenda-cmp-user-defined))
  7352. (setq user-defined-up
  7353. (funcall org-agenda-cmp-user-defined a b)
  7354. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  7355. (cdr (assoc
  7356. (eval (cons 'or org-agenda-sorting-strategy-selected) t)
  7357. '((-1 . t) (1 . nil) (nil . nil)))))))
  7358. ;;; Agenda restriction lock
  7359. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  7360. "Overlay to mark the headline to which agenda commands are restricted.")
  7361. (overlay-put org-agenda-restriction-lock-overlay
  7362. 'face 'org-agenda-restriction-lock)
  7363. (overlay-put org-agenda-restriction-lock-overlay
  7364. 'help-echo "Agendas are currently limited to this subtree.")
  7365. (delete-overlay org-agenda-restriction-lock-overlay)
  7366. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  7367. "Set the restriction lock to the agenda item at point from within the agenda.
  7368. When called with a `\\[universal-argument]' prefix, restrict to
  7369. the file which contains the item.
  7370. Argument ARG is the prefix argument."
  7371. (interactive "P")
  7372. (unless (derived-mode-p 'org-agenda-mode)
  7373. (user-error "Not in an Org agenda buffer"))
  7374. (let* ((marker (or (org-get-at-bol 'org-marker)
  7375. (org-agenda-error)))
  7376. (buffer (marker-buffer marker))
  7377. (pos (marker-position marker)))
  7378. (with-current-buffer buffer
  7379. (goto-char pos)
  7380. (org-agenda-set-restriction-lock arg))))
  7381. ;;;###autoload
  7382. (defun org-agenda-set-restriction-lock (&optional type)
  7383. "Set restriction lock for agenda to current subtree or file.
  7384. When in a restricted subtree, remove it.
  7385. The restriction will span over the entire file if TYPE is `file',
  7386. or if TYPE is (4), or if the cursor is before the first headline
  7387. in the file. Otherwise, only apply the restriction to the current
  7388. subtree."
  7389. (interactive "P")
  7390. (if (and org-agenda-overriding-restriction
  7391. (member org-agenda-restriction-lock-overlay
  7392. (overlays-at (point)))
  7393. (equal (overlay-start org-agenda-restriction-lock-overlay)
  7394. (point)))
  7395. (org-agenda-remove-restriction-lock 'noupdate)
  7396. (org-agenda-remove-restriction-lock 'noupdate)
  7397. (and (equal type '(4)) (setq type 'file))
  7398. (setq type (cond
  7399. (type type)
  7400. ((org-at-heading-p) 'subtree)
  7401. ((condition-case nil (org-back-to-heading t) (error nil))
  7402. 'subtree)
  7403. (t 'file)))
  7404. (if (eq type 'subtree)
  7405. (progn
  7406. (setq org-agenda-restrict (current-buffer))
  7407. (setq org-agenda-overriding-restriction 'subtree)
  7408. (put 'org-agenda-files 'org-restrict
  7409. (list (buffer-file-name (buffer-base-buffer))))
  7410. (org-back-to-heading t)
  7411. (move-overlay org-agenda-restriction-lock-overlay
  7412. (point)
  7413. (if org-agenda-restriction-lock-highlight-subtree
  7414. (save-excursion (org-end-of-subtree t t) (point))
  7415. (line-end-position)))
  7416. (move-marker org-agenda-restrict-begin (point))
  7417. (move-marker org-agenda-restrict-end
  7418. (save-excursion (org-end-of-subtree t t)))
  7419. (message "Locking agenda restriction to subtree"))
  7420. (put 'org-agenda-files 'org-restrict
  7421. (list (buffer-file-name (buffer-base-buffer))))
  7422. (setq org-agenda-restrict nil)
  7423. (setq org-agenda-overriding-restriction 'file)
  7424. (move-marker org-agenda-restrict-begin nil)
  7425. (move-marker org-agenda-restrict-end nil)
  7426. (message "Locking agenda restriction to file"))
  7427. (setq current-prefix-arg nil))
  7428. (org-agenda-maybe-redo))
  7429. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  7430. "Remove agenda restriction lock."
  7431. (interactive "P")
  7432. (if (not (or org-agenda-restrict org-agenda-overriding-restriction))
  7433. (message "No agenda restriction to remove.")
  7434. (delete-overlay org-agenda-restriction-lock-overlay)
  7435. (delete-overlay org-speedbar-restriction-lock-overlay)
  7436. (setq org-agenda-overriding-restriction nil)
  7437. (unless org-agenda-keep-restricted-file-list
  7438. ;; There is a request to keep the file list in place
  7439. (put 'org-agenda-files 'org-restrict nil))
  7440. (setq org-agenda-restrict nil)
  7441. (put 'org-agenda-files 'org-restrict nil)
  7442. (move-marker org-agenda-restrict-begin nil)
  7443. (move-marker org-agenda-restrict-end nil)
  7444. (setq current-prefix-arg nil)
  7445. (message "Agenda restriction lock removed")
  7446. (or noupdate (org-agenda-maybe-redo))))
  7447. (defun org-agenda-maybe-redo ()
  7448. "If there is any window showing the agenda view, update it."
  7449. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  7450. org-agenda-buffer-name)
  7451. t))
  7452. (w0 (selected-window)))
  7453. (when w
  7454. (select-window w)
  7455. (org-agenda-redo)
  7456. (select-window w0)
  7457. (if org-agenda-overriding-restriction
  7458. (message "Agenda view shifted to new %s restriction"
  7459. org-agenda-overriding-restriction)
  7460. (message "Agenda restriction lock removed")))))
  7461. ;;; Agenda commands
  7462. (defun org-agenda-check-type (error &rest types)
  7463. "Check if agenda buffer or component is of allowed type.
  7464. If ERROR is non-nil, throw an error, otherwise just return nil.
  7465. Allowed types are `agenda' `todo' `tags' `search'."
  7466. (cond ((not org-agenda-type)
  7467. (error "No Org agenda currently displayed"))
  7468. ((memq org-agenda-type types) t)
  7469. (error
  7470. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  7471. (t nil)))
  7472. (defun org-agenda-Quit ()
  7473. "Exit the agenda, killing the agenda buffer.
  7474. Like `org-agenda-quit', but kill the buffer even when
  7475. `org-agenda-sticky' is non-nil."
  7476. (interactive)
  7477. (org-agenda--quit))
  7478. (defun org-agenda-quit ()
  7479. "Exit the agenda.
  7480. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  7481. instead of killing it.
  7482. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  7483. the pre-agenda window configuration.
  7484. When column view is active, exit column view instead of the
  7485. agenda."
  7486. (interactive)
  7487. (org-agenda--quit org-agenda-sticky))
  7488. (defun org-agenda--quit (&optional bury)
  7489. (if org-agenda-columns-active
  7490. (org-columns-quit)
  7491. (let ((wconf org-agenda-pre-window-conf)
  7492. (buf (current-buffer))
  7493. (org-agenda-last-indirect-window
  7494. (and (eq org-indirect-buffer-display 'other-window)
  7495. org-agenda-last-indirect-buffer
  7496. (get-buffer-window org-agenda-last-indirect-buffer))))
  7497. (cond
  7498. ((eq org-agenda-window-setup 'other-frame)
  7499. (delete-frame))
  7500. ((eq org-agenda-window-setup 'other-tab)
  7501. (if (fboundp 'tab-bar-close-tab)
  7502. (tab-bar-close-tab)
  7503. (user-error "Your version of Emacs does not have tab bar mode support")))
  7504. ((and org-agenda-restore-windows-after-quit
  7505. wconf)
  7506. ;; Maybe restore the pre-agenda window configuration. Reset
  7507. ;; `org-agenda-pre-window-conf' before running
  7508. ;; `set-window-configuration', which loses the current buffer.
  7509. (setq org-agenda-pre-window-conf nil)
  7510. (set-window-configuration wconf))
  7511. (t
  7512. (when org-agenda-last-indirect-window
  7513. (delete-window org-agenda-last-indirect-window))
  7514. (and (not (eq org-agenda-window-setup 'current-window))
  7515. (not (one-window-p))
  7516. (delete-window))))
  7517. (if bury
  7518. ;; Set the agenda buffer as the current buffer instead of
  7519. ;; passing it as an argument to `bury-buffer' so that
  7520. ;; `bury-buffer' removes it from the window.
  7521. (with-current-buffer buf
  7522. (bury-buffer))
  7523. (kill-buffer buf)
  7524. (setq org-agenda-archives-mode nil
  7525. org-agenda-buffer nil)))))
  7526. (defun org-agenda-exit ()
  7527. "Exit the agenda, killing Org buffers loaded by the agenda.
  7528. Like `org-agenda-Quit', but kill any buffers that were created by
  7529. the agenda. Org buffers visited directly by the user will not be
  7530. touched. Also, exit the agenda even if it is in column view."
  7531. (interactive)
  7532. (when org-agenda-columns-active
  7533. (org-columns-quit))
  7534. (org-release-buffers org-agenda-new-buffers)
  7535. (setq org-agenda-new-buffers nil)
  7536. (org-agenda-Quit))
  7537. (defun org-agenda-kill-all-agenda-buffers ()
  7538. "Kill all buffers in `org-agenda-mode'.
  7539. This is used when toggling sticky agendas."
  7540. (interactive)
  7541. (let (blist)
  7542. (dolist (buf (buffer-list))
  7543. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  7544. (push buf blist)))
  7545. (mapc #'kill-buffer blist)))
  7546. (defun org-agenda-execute (arg)
  7547. "Execute another agenda command, keeping same window.
  7548. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  7549. in the agenda."
  7550. (interactive "P")
  7551. (let ((org-agenda-window-setup 'current-window))
  7552. (org-agenda arg)))
  7553. (defun org-agenda-redo (&optional all)
  7554. "Rebuild possibly ALL agenda view(s) in the current buffer."
  7555. (interactive "P")
  7556. (defvar org-agenda-tag-filter-while-redo) ;FIXME: Where is this var used?
  7557. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  7558. (cpa (unless (eq all t) current-prefix-arg))
  7559. (org-agenda-doing-sticky-redo org-agenda-sticky)
  7560. (org-agenda-sticky nil)
  7561. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  7562. org-agenda-buffer-name))
  7563. (org-agenda-keep-modes t)
  7564. (tag-filter org-agenda-tag-filter)
  7565. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  7566. (top-hl-filter org-agenda-top-headline-filter)
  7567. (cat-filter org-agenda-category-filter)
  7568. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  7569. (re-filter org-agenda-regexp-filter)
  7570. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  7571. (effort-filter org-agenda-effort-filter)
  7572. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  7573. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  7574. (cols org-agenda-columns-active)
  7575. (line (org-current-line))
  7576. (window-line (- line (org-current-line (window-start))))
  7577. (lprops (get 'org-agenda-redo-command 'org-lprops))
  7578. (redo-cmd (get-text-property p 'org-redo-cmd))
  7579. (last-args (get-text-property p 'org-last-args))
  7580. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  7581. (org-agenda-overriding-cmd-arguments
  7582. (unless (eq all t)
  7583. (cond ((listp last-args)
  7584. (cons (or cpa (car last-args)) (cdr last-args)))
  7585. ((stringp last-args)
  7586. last-args))))
  7587. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  7588. (put 'org-agenda-tag-filter :preset-filter nil)
  7589. (put 'org-agenda-category-filter :preset-filter nil)
  7590. (put 'org-agenda-regexp-filter :preset-filter nil)
  7591. (put 'org-agenda-effort-filter :preset-filter nil)
  7592. (and cols (org-columns-quit))
  7593. (message "Rebuilding agenda buffer...")
  7594. (if series-redo-cmd
  7595. (eval series-redo-cmd t)
  7596. (cl-progv
  7597. (mapcar #'car lprops)
  7598. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  7599. (eval redo-cmd t)))
  7600. (setq org-agenda-undo-list nil
  7601. org-agenda-pending-undo-list nil
  7602. org-agenda-tag-filter tag-filter
  7603. org-agenda-category-filter cat-filter
  7604. org-agenda-regexp-filter re-filter
  7605. org-agenda-effort-filter effort-filter
  7606. org-agenda-top-headline-filter top-hl-filter)
  7607. (message "Rebuilding agenda buffer...done")
  7608. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  7609. (put 'org-agenda-category-filter :preset-filter cat-preset)
  7610. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  7611. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  7612. (let ((tag (or tag-filter tag-preset))
  7613. (cat (or cat-filter cat-preset))
  7614. (effort (or effort-filter effort-preset))
  7615. (re (or re-filter re-preset)))
  7616. (when tag (org-agenda-filter-apply tag 'tag t))
  7617. (when cat (org-agenda-filter-apply cat 'category))
  7618. (when effort (org-agenda-filter-apply effort 'effort))
  7619. (when re (org-agenda-filter-apply re 'regexp)))
  7620. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7621. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7622. (org-goto-line line)
  7623. (when (called-interactively-p 'any) (recenter window-line))))
  7624. (defun org-agenda-redo-all (&optional exhaustive)
  7625. "Rebuild all agenda views in the current buffer.
  7626. With a prefix argument, do so in all agenda buffers."
  7627. (interactive "P")
  7628. (if exhaustive
  7629. (dolist (buffer (buffer-list))
  7630. (with-current-buffer buffer
  7631. (when (derived-mode-p 'org-agenda-mode)
  7632. (org-agenda-redo t))))
  7633. (org-agenda-redo t)))
  7634. (defvar org-global-tags-completion-table nil)
  7635. (defvar org-agenda-filter-form nil)
  7636. (defvar org-agenda-filtered-by-category nil)
  7637. (defsubst org-agenda-get-category ()
  7638. "Return the category of the agenda line."
  7639. (org-get-at-bol 'org-category))
  7640. (defun org-agenda-filter-by-category (strip)
  7641. "Filter lines in the agenda buffer that have a specific category.
  7642. The category is that of the current line.
  7643. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7644. When there is already a category filter in place, this command removes the
  7645. filter."
  7646. (interactive "P")
  7647. (if (and org-agenda-filtered-by-category
  7648. org-agenda-category-filter)
  7649. (org-agenda-filter-show-all-cat)
  7650. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7651. (cond
  7652. ((and cat strip)
  7653. (org-agenda-filter-apply
  7654. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7655. (cat
  7656. (org-agenda-filter-apply
  7657. (setq org-agenda-category-filter
  7658. (list (concat "+" cat)))
  7659. 'category))
  7660. (t (error "No category at point"))))))
  7661. (defun org-find-top-headline (&optional pos)
  7662. "Find the topmost parent headline and return it.
  7663. POS when non-nil is the marker or buffer position to start the
  7664. search from."
  7665. (save-excursion
  7666. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7667. (when pos (goto-char pos))
  7668. ;; Skip up to the topmost parent.
  7669. (while (org-up-heading-safe))
  7670. (ignore-errors
  7671. (replace-regexp-in-string
  7672. "^\\[[0-9]+/[0-9]+\\] *\\|^\\[%[0-9]+\\] *" ""
  7673. (nth 4 (org-heading-components)))))))
  7674. (defvar org-agenda-filtered-by-top-headline nil)
  7675. (defun org-agenda-filter-by-top-headline (strip)
  7676. "Keep only those lines that are descendants from the same top headline.
  7677. The top headline is that of the current line. With prefix arg STRIP, hide
  7678. all lines of the category at point."
  7679. (interactive "P")
  7680. (if org-agenda-filtered-by-top-headline
  7681. (progn
  7682. (setq org-agenda-filtered-by-top-headline nil
  7683. org-agenda-top-headline-filter nil)
  7684. (org-agenda-filter-show-all-top-filter))
  7685. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7686. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7687. (error "No top-level headline at point")))))
  7688. (defvar org-agenda-regexp-filter nil)
  7689. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7690. "Filter agenda entries by a regular expressions.
  7691. You will be prompted for the regular expression, and the agenda
  7692. view will only show entries that are matched by that expression.
  7693. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7694. When there is already a regexp filter active, this command removed the
  7695. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7696. an already existing regexp filter."
  7697. (interactive "P")
  7698. (let* ((strip (equal strip-or-accumulate '(4)))
  7699. (accumulate (equal strip-or-accumulate '(16))))
  7700. (cond
  7701. ((and org-agenda-regexp-filter (not accumulate))
  7702. (org-agenda-filter-show-all-re)
  7703. (message "Regexp filter removed"))
  7704. (t (let ((flt (concat (if strip "-" "+")
  7705. (read-from-minibuffer
  7706. (if strip
  7707. "Hide entries matching regexp: "
  7708. "Narrow to entries matching regexp: ")))))
  7709. (push flt org-agenda-regexp-filter)
  7710. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7711. (defvar org-agenda-effort-filter nil)
  7712. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7713. "Filter agenda entries by effort.
  7714. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7715. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7716. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7717. This last option is in practice not very useful, but it is available for
  7718. consistency with the other filter commands."
  7719. (interactive "P")
  7720. (let* ((efforts (split-string
  7721. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7722. org-global-properties
  7723. t))
  7724. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7725. ;; XXX: the following handles only up to 10 different
  7726. ;; effort values.
  7727. (allowed-keys (if (null efforts) nil
  7728. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7729. (number-sequence 1 (length efforts)))))
  7730. (keep (equal strip-or-accumulate '(16)))
  7731. (negative (equal strip-or-accumulate '(4)))
  7732. (current org-agenda-effort-filter)
  7733. (op nil))
  7734. (while (not (memq op '(?< ?> ?= ?_)))
  7735. (setq op (read-char-exclusive
  7736. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7737. ;; Select appropriate duration. Ignore non-digit characters.
  7738. (if (eq op ?_)
  7739. (progn
  7740. (org-agenda-filter-show-all-effort)
  7741. (message "Effort filter removed"))
  7742. (let ((prompt
  7743. (apply #'format
  7744. (concat "Effort %c "
  7745. (mapconcat (lambda (s) (concat "[%d]" s))
  7746. efforts
  7747. " "))
  7748. op allowed-keys))
  7749. (eff -1))
  7750. (while (not (memq eff allowed-keys))
  7751. (message prompt)
  7752. (setq eff (- (read-char-exclusive) 48)))
  7753. (org-agenda-filter-show-all-effort)
  7754. (setq org-agenda-effort-filter
  7755. (append
  7756. (list (concat (if negative "-" "+")
  7757. (char-to-string op)
  7758. ;; Numbering is 1 2 3 ... 9 0, but we want
  7759. ;; 0 1 2 ... 8 9.
  7760. (nth (mod (1- eff) 10) efforts)))
  7761. (if keep current nil)))
  7762. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7763. (defun org-agenda-filter (&optional strip-or-accumulate)
  7764. "Prompt for a general filter string and apply it to the agenda.
  7765. The string may contain filter elements like
  7766. +category
  7767. +tag
  7768. +<effort > and = are also allowed as effort operators
  7769. +/regexp/
  7770. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7771. `+' is optional if it is not required to separate two string parts.
  7772. Multiple filter elements can be concatenated without spaces, for example
  7773. +work-John<0:10-/plot/
  7774. selects entries with category `work' and effort estimates below 10 minutes,
  7775. and deselects entries with tag `John' or matching the regexp `plot'.
  7776. During entry of the filter, completion for tags, categories and effort
  7777. values is offered. Since the syntax for categories and tags is identical
  7778. there should be no overlap between categories and tags. If there is, tags
  7779. get priority.
  7780. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7781. entire filter, which can be useful in connection with the prompt history.
  7782. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7783. existing ones. A shortcut for this is to add an additional `+' at the
  7784. beginning of the string, like `+-John'.
  7785. With a triple prefix argument, execute the computed filtering defined in
  7786. the variable `org-agenda-auto-exclude-function'."
  7787. (interactive "P")
  7788. (if (equal strip-or-accumulate '(64))
  7789. ;; Execute the auto-exclude action
  7790. (if (not org-agenda-auto-exclude-function)
  7791. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7792. (org-agenda-filter-show-all-tag)
  7793. (setq org-agenda-tag-filter nil)
  7794. (dolist (tag (org-agenda-get-represented-tags))
  7795. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7796. (when modifier
  7797. (push modifier org-agenda-tag-filter))))
  7798. (unless (null org-agenda-tag-filter)
  7799. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7800. ;; Prompt for a filter and act
  7801. (let* ((tag-list (org-agenda-get-represented-tags))
  7802. (category-list (org-agenda-get-represented-categories))
  7803. (negate (equal strip-or-accumulate '(4)))
  7804. (cf (mapconcat #'identity org-agenda-category-filter ""))
  7805. (tf (mapconcat #'identity org-agenda-tag-filter ""))
  7806. ;; (rpl-fn (lambda (c) (replace-regexp-in-string "^\\+" "" (or (car c) ""))))
  7807. (ef (replace-regexp-in-string "^\\+" "" (or (car org-agenda-effort-filter) "")))
  7808. (rf (replace-regexp-in-string "^\\+" "" (or (car org-agenda-regexp-filter) "")))
  7809. (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/"))))
  7810. (f-string (completing-read
  7811. (concat
  7812. (if negate "Negative filter" "Filter")
  7813. " [+cat-tag<0:10-/regexp/]: ")
  7814. #'org-agenda-filter-completion-function
  7815. nil nil ff))
  7816. (keep (or (if (string-match "^\\+[+-]" f-string)
  7817. (progn (setq f-string (substring f-string 1)) t))
  7818. (equal strip-or-accumulate '(16))))
  7819. (fc (if keep org-agenda-category-filter))
  7820. (ft (if keep org-agenda-tag-filter))
  7821. (fe (if keep org-agenda-effort-filter))
  7822. (fr (if keep org-agenda-regexp-filter))
  7823. pm s)
  7824. ;; If the filter contains a double-quoted string, replace a
  7825. ;; single hyphen by the arbitrary and temporary string "~~~"
  7826. ;; to disambiguate such hyphens from syntactic ones.
  7827. (setq f-string (replace-regexp-in-string
  7828. "\"\\([^\"]*\\)-\\([^\"]*\\)\"" "\"\\1~~~\\2\"" f-string))
  7829. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7830. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7831. (when negate
  7832. (setq pm (if (equal pm "+") "-" "+")))
  7833. (cond
  7834. ((match-beginning 3)
  7835. ;; category or tag
  7836. (setq s (replace-regexp-in-string ; Remove the temporary special string.
  7837. "~~~" "-" (match-string 3 f-string)))
  7838. (cond
  7839. ((member s tag-list)
  7840. (org-pushnew-to-end (concat pm s) ft))
  7841. ((member s category-list)
  7842. (org-pushnew-to-end (concat pm ; Remove temporary double quotes.
  7843. (replace-regexp-in-string "\"\\(.*\\)\"" "\\1" s))
  7844. fc))
  7845. (t (message
  7846. "`%s%s' filter ignored because tag/category is not represented"
  7847. pm s))))
  7848. ((match-beginning 4)
  7849. ;; effort
  7850. (org-pushnew-to-end (concat pm (match-string 4 f-string)) fe))
  7851. ((match-beginning 5)
  7852. ;; regexp
  7853. (org-pushnew-to-end (concat pm (match-string 6 f-string)) fr)))
  7854. (setq f-string (substring f-string (match-end 0))))
  7855. (org-agenda-filter-remove-all)
  7856. (and fc (org-agenda-filter-apply
  7857. (setq org-agenda-category-filter fc) 'category))
  7858. (and ft (org-agenda-filter-apply
  7859. (setq org-agenda-tag-filter ft) 'tag 'expand))
  7860. (and fe (org-agenda-filter-apply
  7861. (setq org-agenda-effort-filter fe) 'effort))
  7862. (and fr (org-agenda-filter-apply
  7863. (setq org-agenda-regexp-filter fr) 'regexp))
  7864. (run-hooks 'org-agenda-filter-hook))))
  7865. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7866. "Complete a complex filter string.
  7867. FLAG specifies the type of completion operation to perform. This
  7868. function is passed as a collection function to `completing-read',
  7869. which see."
  7870. (let ((completion-ignore-case t) ;tags are case-sensitive
  7871. (confirm (lambda (x) (stringp x)))
  7872. (prefix "")
  7873. (operator "")
  7874. table)
  7875. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7876. (setq prefix (match-string 1 string)
  7877. operator (match-string 2 string)
  7878. string (match-string 3 string)))
  7879. (cond
  7880. ((member operator '("+" "-" "" nil))
  7881. (setq table (append (org-agenda-get-represented-categories)
  7882. (org-agenda-get-represented-tags))))
  7883. ((member operator '("<" ">" "="))
  7884. (setq table (split-string
  7885. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7886. org-global-properties
  7887. t))
  7888. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7889. " +")))
  7890. (t (setq table nil)))
  7891. (pcase flag
  7892. (`t (all-completions string table confirm))
  7893. (`lambda (assoc string table)) ;exact match?
  7894. (`nil
  7895. (pcase (try-completion string table confirm)
  7896. ((and completion (pred stringp))
  7897. (concat prefix completion))
  7898. (completion completion)))
  7899. (_ nil))))
  7900. (defun org-agenda-filter-remove-all ()
  7901. "Remove all filters from the current agenda buffer."
  7902. (interactive)
  7903. (when org-agenda-tag-filter
  7904. (org-agenda-filter-show-all-tag))
  7905. (when org-agenda-category-filter
  7906. (org-agenda-filter-show-all-cat))
  7907. (when org-agenda-regexp-filter
  7908. (org-agenda-filter-show-all-re))
  7909. (when org-agenda-top-headline-filter
  7910. (org-agenda-filter-show-all-top-filter))
  7911. (when org-agenda-effort-filter
  7912. (org-agenda-filter-show-all-effort))
  7913. (org-agenda-finalize)
  7914. (when (called-interactively-p 'interactive)
  7915. (message "All agenda filters removed")))
  7916. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7917. "Keep only those lines in the agenda buffer that have a specific tag.
  7918. The tag is selected with its fast selection letter, as configured.
  7919. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7920. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7921. instead of replacing it.
  7922. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7923. i.e. don't
  7924. filter on all its group members.
  7925. A Lisp caller can specify CHAR. EXCLUDE means that the new tag
  7926. should be used to exclude the search - the interactive user can
  7927. also press `-' or `+' to switch between filtering and excluding."
  7928. (interactive "P")
  7929. (let* ((alist org-tag-alist-for-agenda)
  7930. (seen-chars nil)
  7931. (tag-chars (mapconcat
  7932. (lambda (x) (if (and (not (symbolp (car x)))
  7933. (cdr x)
  7934. (not (member (cdr x) seen-chars)))
  7935. (progn
  7936. (push (cdr x) seen-chars)
  7937. (char-to-string (cdr x)))
  7938. ""))
  7939. org-tag-alist-for-agenda ""))
  7940. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7941. (string-to-list tag-chars)))
  7942. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7943. (accumulate (equal strip-or-accumulate '(16)))
  7944. (expand (not (equal strip-or-accumulate '(64))))
  7945. (inhibit-read-only t)
  7946. (current org-agenda-tag-filter)
  7947. a tag) ;; n
  7948. (unless char
  7949. (while (not (memq char valid-char-list))
  7950. (org-unlogged-message
  7951. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7952. (if exclude "Exclude[+]" "Filter[-]")
  7953. (if expand "" " (no grouptag expand)")
  7954. tag-chars
  7955. (if org-agenda-auto-exclude-function "[RET] " ""))
  7956. (setq char (read-char-exclusive))
  7957. ;; Excluding or filtering down
  7958. (cond ((eq char ?-) (setq exclude t))
  7959. ((eq char ?+) (setq exclude nil)))))
  7960. (when (eq char ?\t)
  7961. (unless (local-variable-p 'org-global-tags-completion-table)
  7962. (setq-local org-global-tags-completion-table
  7963. (org-global-tags-completion-table)))
  7964. (let ((completion-ignore-case t))
  7965. (setq tag (completing-read
  7966. "Tag: " org-global-tags-completion-table nil t))))
  7967. (cond
  7968. ((eq char ?\r)
  7969. (org-agenda-filter-show-all-tag)
  7970. (when org-agenda-auto-exclude-function
  7971. (setq org-agenda-tag-filter nil)
  7972. (dolist (tag (org-agenda-get-represented-tags))
  7973. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7974. (when modifier
  7975. (push modifier org-agenda-tag-filter))))
  7976. (unless (null org-agenda-tag-filter)
  7977. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7978. ((eq char ?\\)
  7979. (org-agenda-filter-show-all-tag)
  7980. (when (get 'org-agenda-tag-filter :preset-filter)
  7981. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7982. ((eq char ?.)
  7983. (setq org-agenda-tag-filter
  7984. (mapcar (lambda(tag) (concat "+" tag))
  7985. (org-get-at-bol 'tags)))
  7986. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7987. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7988. ((or (eq char ?\s)
  7989. (setq a (rassoc char alist))
  7990. (and tag (setq a (cons tag nil))))
  7991. (org-agenda-filter-show-all-tag)
  7992. (setq tag (car a))
  7993. (setq org-agenda-tag-filter
  7994. (cons (concat (if exclude "-" "+") tag)
  7995. (if accumulate current nil)))
  7996. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7997. (t (error "Invalid tag selection character %c" char)))))
  7998. (defun org-agenda-get-represented-categories ()
  7999. "Return a list of all categories used in this agenda buffer."
  8000. (or org-agenda-represented-categories
  8001. (when (derived-mode-p 'org-agenda-mode)
  8002. (let ((pos (point-min)) categories)
  8003. (while (and (< pos (point-max))
  8004. (setq pos (next-single-property-change
  8005. pos 'org-category nil (point-max))))
  8006. (push (get-text-property pos 'org-category) categories))
  8007. (setq org-agenda-represented-categories
  8008. ;; Enclose category names with a hyphen in double
  8009. ;; quotes to process them specially in `org-agenda-filter'.
  8010. (mapcar (lambda (s) (if (string-match-p "-" s) (format "\"%s\"" s) s))
  8011. (nreverse (org-uniquify (delq nil categories)))))))))
  8012. (defvar org-tag-groups-alist-for-agenda)
  8013. (defun org-agenda-get-represented-tags ()
  8014. "Return a list of all tags used in this agenda buffer.
  8015. These will be lower-case, for filtering."
  8016. (or org-agenda-represented-tags
  8017. (when (derived-mode-p 'org-agenda-mode)
  8018. (let ((pos (point-min)) tags-lists tt)
  8019. (while (and (< pos (point-max))
  8020. (setq pos (next-single-property-change
  8021. pos 'tags nil (point-max))))
  8022. (setq tt (get-text-property pos 'tags))
  8023. (if tt (push tt tags-lists)))
  8024. (setq tags-lists
  8025. (nreverse (org-uniquify
  8026. (delq nil (apply #'append tags-lists)))))
  8027. (dolist (tag tags-lists)
  8028. (mapc
  8029. (lambda (group)
  8030. (when (member tag group)
  8031. (push (car group) tags-lists)))
  8032. org-tag-groups-alist-for-agenda))
  8033. (setq org-agenda-represented-tags tags-lists)))))
  8034. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  8035. "Create the form that tests a line for agenda filter.
  8036. Optional argument EXPAND can be used for the TYPE tag and will
  8037. expand the tags in the FILTER if any of the tags in FILTER are
  8038. grouptags."
  8039. (let ((multi-pos-cats
  8040. (and (eq type 'category)
  8041. (string-match-p "\\+.*\\+"
  8042. (mapconcat (lambda (cat) (substring cat 0 1))
  8043. filter ""))))
  8044. f f1)
  8045. (cond
  8046. ;; Tag filter
  8047. ((eq type 'tag)
  8048. (setq filter
  8049. (delete-dups
  8050. (append (get 'org-agenda-tag-filter :preset-filter)
  8051. filter)))
  8052. (dolist (x filter)
  8053. (let ((op (string-to-char x)))
  8054. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  8055. (setq x (list x)))
  8056. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  8057. (push f1 f))))
  8058. ;; Category filter
  8059. ((eq type 'category)
  8060. (setq filter
  8061. (delete-dups
  8062. (append (get 'org-agenda-category-filter :preset-filter)
  8063. filter)))
  8064. (dolist (x filter)
  8065. (if (equal "-" (substring x 0 1))
  8066. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  8067. (setq f1 (list 'equal (substring x 1) 'cat)))
  8068. (push f1 f)))
  8069. ;; Regexp filter
  8070. ((eq type 'regexp)
  8071. (setq filter
  8072. (delete-dups
  8073. (append (get 'org-agenda-regexp-filter :preset-filter)
  8074. filter)))
  8075. (dolist (x filter)
  8076. (if (equal "-" (substring x 0 1))
  8077. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  8078. (setq f1 (list 'string-match (substring x 1) 'txt)))
  8079. (push f1 f)))
  8080. ;; Effort filter
  8081. ((eq type 'effort)
  8082. (setq filter
  8083. (delete-dups
  8084. (append (get 'org-agenda-effort-filter :preset-filter)
  8085. filter)))
  8086. (dolist (x filter)
  8087. (push (org-agenda-filter-effort-form x) f))))
  8088. (cons (if multi-pos-cats 'or 'and) (nreverse f))))
  8089. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  8090. "Return a form associated to tag-expression TAGS.
  8091. Build a form testing a line for agenda filter for
  8092. tag-expressions. OP is an operator of type CHAR that allows the
  8093. function to set the right switches in the returned form."
  8094. (let (form)
  8095. ;; Any of the expressions can match if OP is +, all must match if
  8096. ;; the operator is -.
  8097. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  8098. (let* ((tag (substring x 1))
  8099. (f (cond
  8100. ((string= "" tag) 'tags)
  8101. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  8102. ;; TAG is a regexp.
  8103. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  8104. (t (list 'member tag 'tags)))))
  8105. (push (if (eq op ?-) (list 'not f) f) form)))))
  8106. (defun org-agenda-filter-effort-form (e)
  8107. "Return the form to compare the effort of the current line with what E says.
  8108. E looks like \"+<2:25\"."
  8109. (let (op)
  8110. (setq e (substring e 1))
  8111. (setq op (string-to-char e) e (substring e 1))
  8112. (setq op (cond ((equal op ?<) '<=)
  8113. ((equal op ?>) '>=)
  8114. ((equal op ??) op)
  8115. (t '=)))
  8116. (list 'org-agenda-compare-effort (list 'quote op)
  8117. (org-duration-to-minutes e))))
  8118. (defun org-agenda-compare-effort (op value)
  8119. "Compare the effort of the current line with VALUE, using OP.
  8120. If the line does not have an effort defined, return nil."
  8121. ;; `effort-minutes' property cannot be extracted directly from
  8122. ;; current line but is stored as a property in `txt'.
  8123. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  8124. (funcall op
  8125. (or effort (if org-agenda-sort-noeffort-is-high 32767 -1))
  8126. value)))
  8127. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  8128. "Expand group tags in FILTER for the agenda.
  8129. When NO-OPERATOR is non-nil, do not add the + operator to
  8130. returned tags."
  8131. (if org-group-tags
  8132. (let (case-fold-search rtn)
  8133. (mapc
  8134. (lambda (f)
  8135. (let (f0 dir)
  8136. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  8137. (setq dir (match-string 1 f) f0 (match-string 2 f))
  8138. (setq dir (if no-operator "" "+") f0 f))
  8139. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  8140. (org-tags-expand f0 t))
  8141. rtn))))
  8142. filter)
  8143. (reverse rtn))
  8144. filter))
  8145. (defun org-agenda-filter-apply (filter type &optional expand)
  8146. "Set FILTER as the new agenda filter and apply it.
  8147. Optional argument EXPAND can be used for the TYPE tag and will
  8148. expand the tags in the FILTER if any of the tags in FILTER are
  8149. grouptags."
  8150. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  8151. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  8152. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  8153. filter type expand))
  8154. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  8155. ;; category is used as the filter:
  8156. (setq org-agenda-filtered-by-category
  8157. (and (eq type 'category)
  8158. (not (equal (substring (car filter) 0 1) "-"))))
  8159. (org-agenda-set-mode-name)
  8160. (save-excursion
  8161. (goto-char (point-min))
  8162. (while (not (eobp))
  8163. (when (or (org-get-at-bol 'org-hd-marker)
  8164. (org-get-at-bol 'org-marker))
  8165. (org-dlet
  8166. ((tags (org-get-at-bol 'tags))
  8167. (cat (org-agenda-get-category))
  8168. (txt (or (org-get-at-bol 'txt) "")))
  8169. (unless (eval org-agenda-filter-form t)
  8170. (org-agenda-filter-hide-line type))))
  8171. (beginning-of-line 2)))
  8172. (when (get-char-property (point) 'invisible)
  8173. (ignore-errors (org-agenda-previous-line))))
  8174. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  8175. "Filter by top headline HL."
  8176. (org-agenda-set-mode-name)
  8177. (save-excursion
  8178. (goto-char (point-min))
  8179. (while (not (eobp))
  8180. (let* ((pos (org-get-at-bol 'org-hd-marker))
  8181. (tophl (and pos (org-find-top-headline pos))))
  8182. (when (and tophl (funcall (if negative 'identity 'not)
  8183. (string= hl tophl)))
  8184. (org-agenda-filter-hide-line 'top-headline)))
  8185. (beginning-of-line 2)))
  8186. (when (get-char-property (point) 'invisible)
  8187. (org-agenda-previous-line))
  8188. (setq org-agenda-top-headline-filter hl
  8189. org-agenda-filtered-by-top-headline t))
  8190. (defun org-agenda-filter-hide-line (type)
  8191. "If current line is TYPE, hide it in the agenda buffer."
  8192. (let* (buffer-invisibility-spec
  8193. (beg (max (point-min) (1- (line-beginning-position))))
  8194. (end (line-end-position)))
  8195. (let ((inhibit-read-only t))
  8196. (add-text-properties
  8197. beg end `(invisible org-filtered org-filter-type ,type)))))
  8198. (defun org-agenda-remove-filter (type)
  8199. "Remove filter of type TYPE from the agenda buffer."
  8200. (interactive)
  8201. (save-excursion
  8202. (goto-char (point-min))
  8203. (let ((inhibit-read-only t) pos)
  8204. (while (setq pos (text-property-any (point) (point-max)
  8205. 'org-filter-type type))
  8206. (goto-char pos)
  8207. (remove-text-properties
  8208. (point) (next-single-property-change (point) 'org-filter-type)
  8209. `(invisible org-filtered org-filter-type ,type))))
  8210. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  8211. (setq org-agenda-filter-form nil)
  8212. (org-agenda-set-mode-name)
  8213. (org-agenda-finalize)))
  8214. (defun org-agenda-filter-show-all-tag nil
  8215. (org-agenda-remove-filter 'tag))
  8216. (defun org-agenda-filter-show-all-re nil
  8217. (org-agenda-remove-filter 'regexp))
  8218. (defun org-agenda-filter-show-all-effort nil
  8219. (org-agenda-remove-filter 'effort))
  8220. (defun org-agenda-filter-show-all-cat nil
  8221. (org-agenda-remove-filter 'category))
  8222. (defun org-agenda-filter-show-all-top-filter nil
  8223. (org-agenda-remove-filter 'top-headline))
  8224. (defun org-agenda-manipulate-query-add ()
  8225. "Manipulate the query by adding a search term with positive selection.
  8226. Positive selection means the term must be matched for selection of an entry."
  8227. (interactive)
  8228. (org-agenda-manipulate-query ?\[))
  8229. (defun org-agenda-manipulate-query-subtract ()
  8230. "Manipulate the query by adding a search term with negative selection.
  8231. Negative selection means term must not be matched for selection of an entry."
  8232. (interactive)
  8233. (org-agenda-manipulate-query ?\]))
  8234. (defun org-agenda-manipulate-query-add-re ()
  8235. "Manipulate the query by adding a search regexp with positive selection.
  8236. Positive selection means the regexp must match for selection of an entry."
  8237. (interactive)
  8238. (org-agenda-manipulate-query ?\{))
  8239. (defun org-agenda-manipulate-query-subtract-re ()
  8240. "Manipulate the query by adding a search regexp with negative selection.
  8241. Negative selection means regexp must not match for selection of an entry."
  8242. (interactive)
  8243. (org-agenda-manipulate-query ?\}))
  8244. (defun org-agenda-manipulate-query (char)
  8245. (cond
  8246. ((eq org-agenda-type 'agenda)
  8247. (let ((org-agenda-include-inactive-timestamps t))
  8248. (org-agenda-redo))
  8249. (message "Display now includes inactive timestamps as well"))
  8250. ((eq org-agenda-type 'search)
  8251. (org-add-to-string
  8252. 'org-agenda-query-string
  8253. (if org-agenda-last-search-view-search-was-boolean
  8254. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  8255. (?\{ . " +{}") (?\} . " -{}"))))
  8256. " "))
  8257. (setq org-agenda-redo-command
  8258. (list 'org-search-view
  8259. (car (get-text-property (min (1- (point-max)) (point))
  8260. 'org-last-args))
  8261. org-agenda-query-string
  8262. (+ (length org-agenda-query-string)
  8263. (if (member char '(?\{ ?\})) 0 1))))
  8264. (set-register org-agenda-query-register org-agenda-query-string)
  8265. (let ((org-agenda-overriding-arguments
  8266. (cdr org-agenda-redo-command)))
  8267. (org-agenda-redo)))
  8268. (t (error "Cannot manipulate query for %s-type agenda buffers"
  8269. org-agenda-type))))
  8270. (defun org-add-to-string (var string)
  8271. (set var (concat (symbol-value var) string)))
  8272. (defun org-agenda-goto-date (date)
  8273. "Jump to DATE in the agenda buffer.
  8274. When called interactively, prompt for the date.
  8275. When called from Lisp, DATE should be a date as returned by
  8276. `org-read-date'.
  8277. See also:
  8278. `org-agenda-earlier' (\\[org-agenda-earlier])
  8279. `org-agenda-later' (\\[org-agenda-later])
  8280. `org-agenda-goto-today' (\\[org-agenda-goto-today])"
  8281. (interactive
  8282. (list
  8283. (let ((org-read-date-prefer-future org-agenda-jump-prefer-future))
  8284. (org-read-date))))
  8285. (let* ((day (time-to-days (org-time-string-to-time date)))
  8286. (org-agenda-sticky-orig org-agenda-sticky)
  8287. (org-agenda-buffer-tmp-name (buffer-name))
  8288. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8289. (0-arg (or current-prefix-arg (car args)))
  8290. (2-arg (nth 2 args))
  8291. (with-hour-p (nth 4 org-agenda-redo-command))
  8292. (newcmd (list 'org-agenda-list 0-arg date
  8293. (org-agenda-span-to-ndays
  8294. 2-arg (org-time-string-to-absolute date))
  8295. with-hour-p))
  8296. (newargs (cdr newcmd))
  8297. (inhibit-read-only t)
  8298. org-agenda-sticky)
  8299. (if (not (org-agenda-check-type t 'agenda))
  8300. (error "Not available in non-agenda views")
  8301. (add-text-properties (point-min) (point-max)
  8302. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  8303. (org-agenda-redo)
  8304. (goto-char (point-min))
  8305. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  8306. (save-excursion (move-beginning-of-line 2) (eobp))))
  8307. (move-beginning-of-line 2))
  8308. (setq org-agenda-sticky org-agenda-sticky-orig
  8309. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  8310. (defun org-agenda-goto-today ()
  8311. "Go to today's date in the agenda buffer.
  8312. See also:
  8313. `org-agenda-later' (\\[org-agenda-later])
  8314. `org-agenda-earlier' (\\[org-agenda-earlier])
  8315. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8316. (interactive)
  8317. (org-agenda-check-type t 'agenda)
  8318. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8319. (curspan (nth 2 args))
  8320. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  8321. (cond
  8322. (tdpos (goto-char tdpos))
  8323. ((eq org-agenda-type 'agenda)
  8324. (let* ((sd (org-agenda-compute-starting-span
  8325. (org-today) (or curspan org-agenda-span)))
  8326. (org-agenda-overriding-arguments args))
  8327. (setf (nth 1 org-agenda-overriding-arguments) sd)
  8328. (org-agenda-redo)
  8329. (org-agenda-find-same-or-today-or-agenda)))
  8330. (t (error "Cannot find today")))))
  8331. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  8332. (goto-char
  8333. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  8334. (text-property-any (point-min) (point-max) 'org-today t)
  8335. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  8336. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  8337. (org-agenda-backward-block))
  8338. (point-min))))
  8339. (defun org-agenda-backward-block ()
  8340. "Move backward by one agenda block."
  8341. (interactive)
  8342. (org-agenda-forward-block 'backward))
  8343. (defun org-agenda-forward-block (&optional backward)
  8344. "Move forward by one agenda block.
  8345. When optional argument BACKWARD is set, go backward."
  8346. (interactive)
  8347. (cond ((not (derived-mode-p 'org-agenda-mode))
  8348. (user-error
  8349. "Cannot execute this command outside of org-agenda-mode buffers"))
  8350. ((looking-at (if backward "\\`" "\\'"))
  8351. (message "Already at the %s block" (if backward "first" "last")))
  8352. (t (let ((_pos (prog1 (point)
  8353. (ignore-errors (if backward (backward-char 1)
  8354. (move-end-of-line 1)))))
  8355. (f (if backward
  8356. #'previous-single-property-change
  8357. #'next-single-property-change))
  8358. moved dest)
  8359. (while (and (setq dest (funcall
  8360. f (point) 'org-agenda-structural-header))
  8361. (not (get-text-property
  8362. (point) 'org-agenda-structural-header)))
  8363. (setq moved t)
  8364. (goto-char dest))
  8365. (if moved (move-beginning-of-line 1)
  8366. (goto-char (if backward (point-min) (point-max)))
  8367. (move-beginning-of-line 1)
  8368. (message "No %s block" (if backward "previous" "further")))))))
  8369. (defun org-agenda-later (arg)
  8370. "Go forward in time by the current span in the agenda buffer.
  8371. With prefix ARG, go forward that many times the current span.
  8372. See also:
  8373. `org-agenda-earlier' (\\[org-agenda-earlier])
  8374. `org-agenda-goto-today' (\\[org-agenda-goto-today])
  8375. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8376. (interactive "p")
  8377. (org-agenda-check-type t 'agenda)
  8378. (let* ((wstart (window-start))
  8379. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8380. (span (or (nth 2 args) org-agenda-current-span))
  8381. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  8382. (greg (calendar-gregorian-from-absolute sd))
  8383. (cnt (org-get-at-bol 'org-day-cnt))
  8384. greg2)
  8385. (cond
  8386. ((numberp span)
  8387. (setq sd (+ (* span arg) sd)))
  8388. ((eq span 'day)
  8389. (setq sd (+ arg sd)))
  8390. ((eq span 'week)
  8391. (setq sd (+ (* 7 arg) sd)))
  8392. ((eq span 'fortnight)
  8393. (setq sd (+ (* 14 arg) sd)))
  8394. ((eq span 'month)
  8395. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  8396. sd (calendar-absolute-from-gregorian greg2))
  8397. (setcar greg2 (1+ (car greg2))))
  8398. ((eq span 'year)
  8399. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  8400. sd (calendar-absolute-from-gregorian greg2))
  8401. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  8402. (t
  8403. (setq sd (+ (* span arg) sd))))
  8404. (let ((org-agenda-overriding-cmd
  8405. ;; `cmd' may have been set by `org-agenda-run-series' which
  8406. ;; uses `org-agenda-overriding-cmd' to decide whether
  8407. ;; overriding is allowed for `cmd'
  8408. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  8409. (org-agenda-overriding-arguments
  8410. (list (car args) sd span)))
  8411. (org-agenda-redo)
  8412. (org-agenda-find-same-or-today-or-agenda cnt))
  8413. (set-window-start nil wstart)))
  8414. (defun org-agenda-earlier (arg)
  8415. "Go backward in time by the current span in the agenda buffer.
  8416. With prefix ARG, go backward that many times the current span.
  8417. See also:
  8418. `org-agenda-later' (\\[org-agenda-later])
  8419. `org-agenda-goto-today' (\\[org-agenda-goto-today])
  8420. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8421. (interactive "p")
  8422. (org-agenda-later (- arg)))
  8423. (defun org-agenda-view-mode-dispatch ()
  8424. "Call one of the view mode commands."
  8425. (interactive)
  8426. (org-unlogged-message
  8427. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  8428. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  8429. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  8430. (pcase (read-char-exclusive)
  8431. (?\ (call-interactively 'org-agenda-reset-view))
  8432. (?d (call-interactively 'org-agenda-day-view))
  8433. (?w (call-interactively 'org-agenda-week-view))
  8434. (?t (call-interactively 'org-agenda-fortnight-view))
  8435. (?m (call-interactively 'org-agenda-month-view))
  8436. (?y (call-interactively 'org-agenda-year-view))
  8437. (?l (call-interactively 'org-agenda-log-mode))
  8438. (?L (org-agenda-log-mode '(4)))
  8439. (?c (org-agenda-log-mode 'clockcheck))
  8440. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  8441. (?a (call-interactively 'org-agenda-archives-mode))
  8442. (?A (org-agenda-archives-mode 'files))
  8443. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  8444. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  8445. (?G (call-interactively 'org-agenda-toggle-time-grid))
  8446. (?D (call-interactively 'org-agenda-toggle-diary))
  8447. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  8448. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  8449. (org-agenda-check-type t 'agenda)
  8450. (org-agenda-redo))
  8451. (message "Display now includes inactive timestamps as well"))
  8452. (?q (message "Abort"))
  8453. (key (user-error "Invalid key: %s" key))))
  8454. (defun org-agenda-reset-view ()
  8455. "Switch to default view for agenda."
  8456. (interactive)
  8457. (org-agenda-change-time-span org-agenda-span))
  8458. (defun org-agenda-day-view (&optional day-of-month)
  8459. "Switch to daily view for agenda.
  8460. With argument DAY-OF-MONTH, switch to that day of the month."
  8461. (interactive "P")
  8462. (org-agenda-change-time-span 'day day-of-month))
  8463. (defun org-agenda-week-view (&optional iso-week)
  8464. "Switch to weekly view for agenda.
  8465. With argument ISO-WEEK, switch to the corresponding ISO week.
  8466. If ISO-WEEK has more then 2 digits, only the last two encode
  8467. the week. Any digits before this encode a year. So 200712
  8468. means week 12 of year 2007. Years ranging from 70 years ago
  8469. to 30 years in the future can also be written as 2-digit years."
  8470. (interactive "P")
  8471. (org-agenda-change-time-span 'week iso-week))
  8472. (defun org-agenda-fortnight-view (&optional iso-week)
  8473. "Switch to fortnightly view for agenda.
  8474. With argument ISO-WEEK, switch to the corresponding ISO week.
  8475. If ISO-WEEK has more then 2 digits, only the last two encode
  8476. the week. Any digits before this encode a year. So 200712
  8477. means week 12 of year 2007. Years ranging from 70 years ago
  8478. to 30 years in the future can also be written as 2-digit years."
  8479. (interactive "P")
  8480. (org-agenda-change-time-span 'fortnight iso-week))
  8481. (defun org-agenda-month-view (&optional month)
  8482. "Switch to monthly view for agenda.
  8483. With argument MONTH, switch to that month. If MONTH has more
  8484. then 2 digits, only the last two encode the month. Any digits
  8485. before this encode a year. So 200712 means December year 2007.
  8486. Years ranging from 70 years ago to 30 years in the future can
  8487. also be written as 2-digit years."
  8488. (interactive "P")
  8489. (org-agenda-change-time-span 'month month))
  8490. (defun org-agenda-year-view (&optional year)
  8491. "Switch to yearly view for agenda.
  8492. With argument YEAR, switch to that year. Years ranging from 70
  8493. years ago to 30 years in the future can also be written as
  8494. 2-digit years."
  8495. (interactive "P")
  8496. (when year
  8497. (setq year (org-small-year-to-year year)))
  8498. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  8499. (org-agenda-change-time-span 'year year)
  8500. (error "Abort")))
  8501. (defun org-agenda-change-time-span (span &optional n)
  8502. "Change the agenda view to SPAN.
  8503. SPAN may be `day', `week', `fortnight', `month', `year'."
  8504. (org-agenda-check-type t 'agenda)
  8505. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8506. (curspan (nth 2 args)))
  8507. (when (and (not n) (equal curspan span))
  8508. (error "Viewing span is already \"%s\"" span))
  8509. (let* ((sd (or (org-get-at-bol 'day)
  8510. (nth 1 args)
  8511. org-starting-day))
  8512. (sd (org-agenda-compute-starting-span sd span n))
  8513. (org-agenda-overriding-cmd
  8514. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  8515. (org-agenda-overriding-arguments
  8516. (list (car args) sd span)))
  8517. (org-agenda-redo)
  8518. (org-agenda-find-same-or-today-or-agenda))
  8519. (org-agenda-set-mode-name)
  8520. (message "Switched to %s view" span)))
  8521. (defun org-agenda-compute-starting-span (sd span &optional n)
  8522. "Compute starting date for agenda.
  8523. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  8524. is a cons cell with the starting date and the number of days,
  8525. so that the date SD will be in that range."
  8526. (let* ((greg (calendar-gregorian-from-absolute sd))
  8527. ;; (dg (nth 1 greg))
  8528. (mg (car greg))
  8529. (yg (nth 2 greg)))
  8530. (cond
  8531. ((eq span 'day)
  8532. (when n
  8533. (setq sd (+ (calendar-absolute-from-gregorian
  8534. (list mg 1 yg))
  8535. n -1))))
  8536. ((or (eq span 'week) (eq span 'fortnight))
  8537. (let* ((nt (calendar-day-of-week
  8538. (calendar-gregorian-from-absolute sd)))
  8539. (d (if org-agenda-start-on-weekday
  8540. (- nt org-agenda-start-on-weekday)
  8541. 0))
  8542. y1)
  8543. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  8544. (when n
  8545. (require 'cal-iso)
  8546. (when (> n 99)
  8547. (setq y1 (org-small-year-to-year (/ n 100))
  8548. n (mod n 100)))
  8549. (setq sd
  8550. (calendar-iso-to-absolute
  8551. (list n 1
  8552. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  8553. ((eq span 'month)
  8554. (let (y1)
  8555. (when (and n (> n 99))
  8556. (setq y1 (org-small-year-to-year (/ n 100))
  8557. n (mod n 100)))
  8558. (setq sd (calendar-absolute-from-gregorian
  8559. (list (or n mg) 1 (or y1 yg))))))
  8560. ((eq span 'year)
  8561. (setq sd (calendar-absolute-from-gregorian
  8562. (list 1 1 (or n yg))))))
  8563. sd))
  8564. (defun org-agenda-next-date-line (&optional arg)
  8565. "Jump to the next line indicating a date in agenda buffer."
  8566. (interactive "p")
  8567. (org-agenda-check-type t 'agenda)
  8568. (beginning-of-line 1)
  8569. ;; This does not work if user makes date format that starts with a blank
  8570. (when (looking-at-p "^\\S-") (forward-char 1))
  8571. (unless (re-search-forward "^\\S-" nil t arg)
  8572. (backward-char 1)
  8573. (error "No next date after this line in this buffer"))
  8574. (goto-char (match-beginning 0)))
  8575. (defun org-agenda-previous-date-line (&optional arg)
  8576. "Jump to the previous line indicating a date in agenda buffer."
  8577. (interactive "p")
  8578. (org-agenda-check-type t 'agenda)
  8579. (beginning-of-line 1)
  8580. (unless (re-search-backward "^\\S-" nil t arg)
  8581. (error "No previous date before this line in this buffer")))
  8582. ;; Initialize the highlight
  8583. (defvar org-hl (make-overlay 1 1))
  8584. (overlay-put org-hl 'face 'highlight)
  8585. (defun org-highlight (begin end &optional buffer)
  8586. "Highlight a region with overlay."
  8587. (move-overlay org-hl begin end (or buffer (current-buffer))))
  8588. (defun org-unhighlight ()
  8589. "Detach overlay INDEX."
  8590. (delete-overlay org-hl))
  8591. (defun org-unhighlight-once ()
  8592. "Remove the highlight from its position, and this function from the hook."
  8593. (remove-hook 'pre-command-hook #'org-unhighlight-once)
  8594. (org-unhighlight))
  8595. (defvar org-agenda-pre-follow-window-conf nil)
  8596. (defun org-agenda-follow-mode ()
  8597. "Toggle follow mode in an agenda buffer."
  8598. (interactive)
  8599. (unless org-agenda-follow-mode
  8600. (setq org-agenda-pre-follow-window-conf
  8601. (current-window-configuration)))
  8602. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  8603. (unless org-agenda-follow-mode
  8604. (set-window-configuration org-agenda-pre-follow-window-conf))
  8605. (org-agenda-set-mode-name)
  8606. (org-agenda-do-context-action)
  8607. (message "Follow mode is %s"
  8608. (if org-agenda-follow-mode "on" "off")))
  8609. (defun org-agenda-entry-text-mode (&optional arg)
  8610. "Toggle entry text mode in an agenda buffer."
  8611. (interactive "P")
  8612. (if (or org-agenda-tag-filter
  8613. org-agenda-category-filter
  8614. org-agenda-regexp-filter
  8615. org-agenda-top-headline-filter)
  8616. (user-error "Can't show entry text in filtered views")
  8617. (setq org-agenda-entry-text-mode (or (integerp arg)
  8618. (not org-agenda-entry-text-mode)))
  8619. (org-agenda-entry-text-hide)
  8620. (and org-agenda-entry-text-mode
  8621. (let ((org-agenda-entry-text-maxlines
  8622. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  8623. (org-agenda-entry-text-show)))
  8624. (org-agenda-set-mode-name)
  8625. (message "Entry text mode is %s%s"
  8626. (if org-agenda-entry-text-mode "on" "off")
  8627. (if (not org-agenda-entry-text-mode) ""
  8628. (format " (maximum number of lines is %d)"
  8629. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  8630. (defun org-agenda-clockreport-mode ()
  8631. "Toggle clocktable mode in an agenda buffer."
  8632. (interactive)
  8633. (org-agenda-check-type t 'agenda)
  8634. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  8635. (org-agenda-set-mode-name)
  8636. (org-agenda-redo)
  8637. (message "Clocktable mode is %s"
  8638. (if org-agenda-clockreport-mode "on" "off")))
  8639. (defun org-agenda-log-mode (&optional special)
  8640. "Toggle log mode in an agenda buffer.
  8641. With argument SPECIAL, show all possible log items, not only the ones
  8642. configured in `org-agenda-log-mode-items'.
  8643. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  8644. log items, nothing else."
  8645. (interactive "P")
  8646. (org-agenda-check-type t 'agenda)
  8647. (setq org-agenda-show-log
  8648. (cond
  8649. ((equal special '(16)) 'only)
  8650. ((eq special 'clockcheck)
  8651. (if (eq org-agenda-show-log 'clockcheck)
  8652. nil 'clockcheck))
  8653. (special '(closed clock state))
  8654. (t (not org-agenda-show-log))))
  8655. (org-agenda-set-mode-name)
  8656. (org-agenda-redo)
  8657. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  8658. (defun org-agenda-archives-mode (&optional with-files)
  8659. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  8660. When called with a prefix argument, include all archive files as well."
  8661. (interactive "P")
  8662. (setq org-agenda-archives-mode
  8663. (cond ((and with-files (eq org-agenda-archives-mode t)) nil)
  8664. (with-files t)
  8665. (org-agenda-archives-mode nil)
  8666. (t 'trees)))
  8667. (org-agenda-set-mode-name)
  8668. (org-agenda-redo)
  8669. (message
  8670. "%s"
  8671. (cond
  8672. ((eq org-agenda-archives-mode nil)
  8673. "No archives are included")
  8674. ((eq org-agenda-archives-mode 'trees)
  8675. (format "Trees with :%s: tag are included" org-archive-tag))
  8676. ((eq org-agenda-archives-mode t)
  8677. (format "Trees with :%s: tag and all active archive files are included"
  8678. org-archive-tag)))))
  8679. (defun org-agenda-toggle-diary ()
  8680. "Toggle diary inclusion in an agenda buffer."
  8681. (interactive)
  8682. (org-agenda-check-type t 'agenda)
  8683. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8684. (org-agenda-redo)
  8685. (org-agenda-set-mode-name)
  8686. (message "Diary inclusion turned %s"
  8687. (if org-agenda-include-diary "on" "off")))
  8688. (defun org-agenda-toggle-deadlines ()
  8689. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8690. (interactive)
  8691. (org-agenda-check-type t 'agenda)
  8692. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8693. (org-agenda-redo)
  8694. (org-agenda-set-mode-name)
  8695. (message "Deadlines inclusion turned %s"
  8696. (if org-agenda-include-deadlines "on" "off")))
  8697. (defun org-agenda-toggle-time-grid ()
  8698. "Toggle time grid in an agenda buffer."
  8699. (interactive)
  8700. (org-agenda-check-type t 'agenda)
  8701. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8702. (org-agenda-redo)
  8703. (org-agenda-set-mode-name)
  8704. (message "Time-grid turned %s"
  8705. (if org-agenda-use-time-grid "on" "off")))
  8706. (defun org-agenda-set-mode-name ()
  8707. "Set the mode name to indicate all the small mode settings."
  8708. (setq mode-name
  8709. (list "Org-Agenda"
  8710. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8711. " "
  8712. '(:eval (org-agenda-span-name org-agenda-current-span))
  8713. (if org-agenda-follow-mode " Follow" "")
  8714. (if org-agenda-entry-text-mode " ETxt" "")
  8715. (if org-agenda-include-diary " Diary" "")
  8716. (if org-agenda-include-deadlines " Ddl" "")
  8717. (if org-agenda-use-time-grid " Grid" "")
  8718. (if (and (boundp 'org-habit-show-habits)
  8719. org-habit-show-habits)
  8720. " Habit" "")
  8721. (cond
  8722. ((consp org-agenda-show-log) " LogAll")
  8723. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8724. (org-agenda-show-log " Log")
  8725. (t ""))
  8726. (if (org-agenda-filter-any) " " "")
  8727. (if (or org-agenda-category-filter
  8728. (get 'org-agenda-category-filter :preset-filter))
  8729. '(:eval (propertize
  8730. (concat "["
  8731. (mapconcat
  8732. #'identity
  8733. (append
  8734. (get 'org-agenda-category-filter :preset-filter)
  8735. org-agenda-category-filter)
  8736. "")
  8737. "]")
  8738. 'face 'org-agenda-filter-category
  8739. 'help-echo "Category used in filtering"))
  8740. "")
  8741. (if (or org-agenda-tag-filter
  8742. (get 'org-agenda-tag-filter :preset-filter))
  8743. '(:eval (propertize
  8744. (concat (mapconcat
  8745. #'identity
  8746. (append
  8747. (get 'org-agenda-tag-filter :preset-filter)
  8748. org-agenda-tag-filter)
  8749. ""))
  8750. 'face 'org-agenda-filter-tags
  8751. 'help-echo "Tags used in filtering"))
  8752. "")
  8753. (if (or org-agenda-effort-filter
  8754. (get 'org-agenda-effort-filter :preset-filter))
  8755. '(:eval (propertize
  8756. (concat (mapconcat
  8757. #'identity
  8758. (append
  8759. (get 'org-agenda-effort-filter :preset-filter)
  8760. org-agenda-effort-filter)
  8761. ""))
  8762. 'face 'org-agenda-filter-effort
  8763. 'help-echo "Effort conditions used in filtering"))
  8764. "")
  8765. (if (or org-agenda-regexp-filter
  8766. (get 'org-agenda-regexp-filter :preset-filter))
  8767. '(:eval (propertize
  8768. (concat (mapconcat
  8769. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8770. (append
  8771. (get 'org-agenda-regexp-filter :preset-filter)
  8772. org-agenda-regexp-filter)
  8773. ""))
  8774. 'face 'org-agenda-filter-regexp
  8775. 'help-echo "Regexp used in filtering"))
  8776. "")
  8777. (if org-agenda-archives-mode
  8778. (if (eq org-agenda-archives-mode t)
  8779. " Archives"
  8780. (format " :%s:" org-archive-tag))
  8781. "")
  8782. (if org-agenda-clockreport-mode " Clock" "")))
  8783. (force-mode-line-update))
  8784. (defun org-agenda-update-agenda-type ()
  8785. "Update the agenda type after each command."
  8786. (setq org-agenda-type
  8787. (or (get-text-property (point) 'org-agenda-type)
  8788. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8789. (defun org-agenda-next-line ()
  8790. "Move cursor to the next line, and show if follow mode is active."
  8791. (interactive)
  8792. (call-interactively 'next-line)
  8793. (org-agenda-do-context-action))
  8794. (defun org-agenda-previous-line ()
  8795. "Move cursor to the previous line, and show if follow-mode is active."
  8796. (interactive)
  8797. (call-interactively 'previous-line)
  8798. (org-agenda-do-context-action))
  8799. (defun org-agenda-next-item (n)
  8800. "Move cursor to next agenda item."
  8801. (interactive "p")
  8802. (let ((col (current-column)))
  8803. (dotimes (_ n)
  8804. (when (next-single-property-change (line-end-position) 'org-marker)
  8805. (move-end-of-line 1)
  8806. (goto-char (next-single-property-change (point) 'org-marker))))
  8807. (org-move-to-column col))
  8808. (org-agenda-do-context-action))
  8809. (defun org-agenda-previous-item (n)
  8810. "Move cursor to next agenda item."
  8811. (interactive "p")
  8812. (dotimes (_ n)
  8813. (let ((col (current-column))
  8814. (goto (save-excursion
  8815. (move-end-of-line 0)
  8816. (previous-single-property-change (point) 'org-marker))))
  8817. (when goto (goto-char goto))
  8818. (org-move-to-column col)))
  8819. (org-agenda-do-context-action))
  8820. (defun org-agenda-do-context-action ()
  8821. "Show outline path and, maybe, follow mode window."
  8822. (let ((m (org-get-at-bol 'org-marker)))
  8823. (when (and (markerp m) (marker-buffer m))
  8824. (and org-agenda-follow-mode
  8825. (if org-agenda-follow-indirect
  8826. (org-agenda-tree-to-indirect-buffer nil)
  8827. (org-agenda-show)))
  8828. (and org-agenda-show-outline-path
  8829. (org-with-point-at m (org-display-outline-path t))))))
  8830. (defun org-agenda-show-tags ()
  8831. "Show the tags applicable to the current item."
  8832. (interactive)
  8833. (let* ((tags (org-get-at-bol 'tags)))
  8834. (if tags
  8835. (message "Tags are :%s:"
  8836. (org-no-properties (mapconcat #'identity tags ":")))
  8837. (message "No tags associated with this line"))))
  8838. (defun org-agenda-goto (&optional highlight)
  8839. "Go to the entry at point in the corresponding Org file."
  8840. (interactive)
  8841. (let* ((marker (or (org-get-at-bol 'org-marker)
  8842. (org-agenda-error)))
  8843. (buffer (marker-buffer marker))
  8844. (pos (marker-position marker)))
  8845. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8846. (switch-to-buffer-other-window buffer)
  8847. (widen)
  8848. (push-mark)
  8849. (goto-char pos)
  8850. (when (derived-mode-p 'org-mode)
  8851. (org-fold-show-context 'agenda)
  8852. (recenter (/ (window-height) 2))
  8853. (org-back-to-heading t)
  8854. (let ((case-fold-search nil))
  8855. (when (re-search-forward org-complex-heading-regexp nil t)
  8856. (goto-char (match-beginning 4)))))
  8857. (run-hooks 'org-agenda-after-show-hook)
  8858. (and highlight (org-highlight (line-beginning-position) (line-end-position)))))
  8859. (defvar org-agenda-after-show-hook nil
  8860. "Normal hook run after an item has been shown from the agenda.
  8861. Point is in the buffer where the item originated.")
  8862. ;; Defined later in org-agenda.el
  8863. (defvar org-agenda-loop-over-headlines-in-active-region nil)
  8864. (defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
  8865. "Between region BEG and END, call agenda command CMD.
  8866. When optional argument ARG is non-nil or FORCE-ARG is t, pass
  8867. ARG to CMD. When optional argument DELETE is non-nil, assume CMD
  8868. deletes the agenda entry and don't move to the next entry."
  8869. (save-excursion
  8870. (goto-char beg)
  8871. (let ((mend (move-marker (make-marker) end))
  8872. (all (eq org-agenda-loop-over-headlines-in-active-region t))
  8873. (match (and (stringp org-agenda-loop-over-headlines-in-active-region)
  8874. org-agenda-loop-over-headlines-in-active-region))
  8875. (level (and (eq org-agenda-loop-over-headlines-in-active-region 'start-level)
  8876. (org-get-at-bol 'level))))
  8877. (while (< (point) mend)
  8878. (let ((ov (make-overlay (point) (line-end-position))))
  8879. (if (not (or all
  8880. (and match (looking-at-p match))
  8881. (eq level (org-get-at-bol 'level))))
  8882. (org-agenda-next-item 1)
  8883. (overlay-put ov 'face 'region)
  8884. (if (or arg force-arg) (funcall cmd arg) (funcall cmd))
  8885. (when (not delete) (org-agenda-next-item 1))
  8886. (delete-overlay ov)))))))
  8887. ;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
  8888. ;; kill,set-property,set-effort] commands may loop over agenda
  8889. ;; entries. Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
  8890. ;; use their own mechanisms on active regions.
  8891. (defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  8892. "Maybe loop over agenda entries and perform CMD.
  8893. Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  8894. (declare (debug t))
  8895. `(if (and (called-interactively-p 'any)
  8896. org-agenda-loop-over-headlines-in-active-region
  8897. (org-region-active-p))
  8898. (org-agenda-do-in-region
  8899. (region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
  8900. ,@body))
  8901. (defun org-agenda-kill ()
  8902. "Kill the entry or subtree belonging to the current agenda entry."
  8903. (interactive)
  8904. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8905. (org-agenda-maybe-loop
  8906. #'org-agenda-kill nil nil t
  8907. (let* ((bufname-orig (buffer-name))
  8908. (marker (or (org-get-at-bol 'org-marker)
  8909. (org-agenda-error)))
  8910. (buffer (marker-buffer marker))
  8911. (pos (marker-position marker))
  8912. (type (org-get-at-bol 'type))
  8913. dbeg dend (n 0))
  8914. (org-with-remote-undo buffer
  8915. (with-current-buffer buffer
  8916. (save-excursion
  8917. (goto-char pos)
  8918. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8919. (setq dbeg (progn (org-back-to-heading t) (point))
  8920. dend (org-end-of-subtree t t))
  8921. (setq dbeg (line-beginning-position)
  8922. dend (min (point-max) (1+ (line-end-position)))))
  8923. (goto-char dbeg)
  8924. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8925. (when (or (eq t org-agenda-confirm-kill)
  8926. (and (numberp org-agenda-confirm-kill)
  8927. (> n org-agenda-confirm-kill)))
  8928. (let ((win-conf (current-window-configuration)))
  8929. (unwind-protect
  8930. (and
  8931. (prog2
  8932. (org-agenda-tree-to-indirect-buffer nil)
  8933. (not (y-or-n-p
  8934. (format "Delete entry with %d lines in buffer \"%s\"? "
  8935. n (buffer-name buffer))))
  8936. (kill-buffer org-last-indirect-buffer))
  8937. (error "Abort"))
  8938. (set-window-configuration win-conf))))
  8939. (let ((org-agenda-buffer-name bufname-orig))
  8940. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8941. (with-current-buffer buffer (delete-region dbeg dend))
  8942. (message "Agenda item and source killed")))))
  8943. (defvar org-archive-default-command) ; defined in org-archive.el
  8944. (defun org-agenda-archive-default ()
  8945. "Archive the entry or subtree belonging to the current agenda entry."
  8946. (interactive)
  8947. (require 'org-archive)
  8948. (funcall-interactively
  8949. #'org-agenda-archive-with org-archive-default-command))
  8950. (defun org-agenda-archive-default-with-confirmation ()
  8951. "Archive the entry or subtree belonging to the current agenda entry."
  8952. (interactive)
  8953. (require 'org-archive)
  8954. (funcall-interactively
  8955. #'org-agenda-archive-with org-archive-default-command 'confirm))
  8956. (defun org-agenda-archive ()
  8957. "Archive the entry or subtree belonging to the current agenda entry."
  8958. (interactive)
  8959. (funcall-interactively
  8960. #'org-agenda-archive-with 'org-archive-subtree))
  8961. (defun org-agenda-archive-to-archive-sibling ()
  8962. "Move the entry to the archive sibling."
  8963. (interactive)
  8964. (funcall-interactively
  8965. #'org-agenda-archive-with 'org-archive-to-archive-sibling))
  8966. (defvar org-archive-from-agenda)
  8967. (defun org-agenda-archive-with (cmd &optional confirm)
  8968. "Move the entry to the archive sibling."
  8969. (interactive)
  8970. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8971. (org-agenda-maybe-loop
  8972. #'org-agenda-archive-with cmd nil t
  8973. (let* ((bufname-orig (buffer-name))
  8974. (marker (or (org-get-at-bol 'org-marker)
  8975. (org-agenda-error)))
  8976. (buffer (marker-buffer marker))
  8977. (pos (marker-position marker)))
  8978. (org-with-remote-undo buffer
  8979. (with-current-buffer buffer
  8980. (if (derived-mode-p 'org-mode)
  8981. (if (and confirm
  8982. (not (y-or-n-p "Archive this subtree or entry? ")))
  8983. (error "Abort")
  8984. (save-window-excursion
  8985. (goto-char pos)
  8986. (let ((org-agenda-buffer-name bufname-orig))
  8987. (org-remove-subtree-entries-from-agenda))
  8988. (org-back-to-heading t)
  8989. (let ((org-archive-from-agenda t))
  8990. (funcall cmd))))
  8991. (error "Archiving works only in Org files")))))))
  8992. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8993. "Remove all lines in the agenda that correspond to a given subtree.
  8994. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8995. If this information is not given, the function uses the tree at point."
  8996. (let ((buf (or buf (current-buffer))) m p)
  8997. (save-excursion
  8998. (unless (and beg end)
  8999. (org-back-to-heading t)
  9000. (setq beg (point))
  9001. (org-end-of-subtree t)
  9002. (setq end (point)))
  9003. (set-buffer (get-buffer org-agenda-buffer-name))
  9004. (save-excursion
  9005. (goto-char (point-max))
  9006. (beginning-of-line 1)
  9007. (while (not (bobp))
  9008. (when (and (setq m (org-get-at-bol 'org-marker))
  9009. (equal buf (marker-buffer m))
  9010. (setq p (marker-position m))
  9011. (>= p beg)
  9012. (< p end))
  9013. (let ((inhibit-read-only t))
  9014. (delete-region (line-beginning-position) (1+ (line-end-position)))))
  9015. (beginning-of-line 0))))))
  9016. (defun org-agenda-refile (&optional goto rfloc no-update)
  9017. "Refile the item at point.
  9018. When called with `\\[universal-argument] \\[universal-argument]', \
  9019. go to the location of the last
  9020. refiled item.
  9021. When called with `\\[universal-argument] \\[universal-argument] \
  9022. \\[universal-argument]' prefix or when GOTO is 0, clear
  9023. the refile cache.
  9024. RFLOC can be a refile location obtained in a different way.
  9025. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  9026. (interactive "P")
  9027. (cond
  9028. ((member goto '(0 (64)))
  9029. (org-refile-cache-clear))
  9030. ((equal goto '(16))
  9031. (org-refile-goto-last-stored))
  9032. (t
  9033. (let* ((buffer-orig (buffer-name))
  9034. (marker (or (org-get-at-bol 'org-hd-marker)
  9035. (org-agenda-error)))
  9036. (buffer (marker-buffer marker))
  9037. ;; (pos (marker-position marker))
  9038. (rfloc (or rfloc
  9039. (org-refile-get-location
  9040. (if goto "Goto" "Refile to") buffer
  9041. org-refile-allow-creating-parent-nodes))))
  9042. (with-current-buffer buffer
  9043. (org-with-wide-buffer
  9044. (goto-char marker)
  9045. (let ((org-agenda-buffer-name buffer-orig))
  9046. (org-remove-subtree-entries-from-agenda))
  9047. (org-refile goto buffer rfloc))))
  9048. (unless no-update (org-agenda-redo)))))
  9049. (defun org-agenda-open-link (&optional arg)
  9050. "Open the link(s) in the current entry, if any.
  9051. This looks for a link in the displayed line in the agenda.
  9052. It also looks at the text of the entry itself."
  9053. (interactive "P")
  9054. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  9055. (org-get-at-bol 'org-marker)))
  9056. (buffer (and marker (marker-buffer marker)))
  9057. (prefix (buffer-substring (line-beginning-position) (line-end-position)))
  9058. (lkall (and buffer (org-offer-links-in-entry
  9059. buffer marker arg prefix)))
  9060. (lk0 (car lkall))
  9061. (lk (if (stringp lk0) (list lk0) lk0))
  9062. (lkend (cdr lkall))
  9063. trg)
  9064. (cond
  9065. ((and buffer lk)
  9066. (mapcar (lambda(l)
  9067. (with-current-buffer buffer
  9068. (setq trg (and (string-match org-link-bracket-re l)
  9069. (match-string 1 l)))
  9070. (if (or (not trg) (string-match org-link-any-re trg))
  9071. ;; Don't use `org-with-wide-buffer' here as
  9072. ;; opening the link may result in moving the point
  9073. (save-restriction
  9074. (widen)
  9075. (goto-char marker)
  9076. (when (search-forward l nil lkend)
  9077. (goto-char (match-beginning 0))
  9078. (org-open-at-point)))
  9079. ;; This is an internal link, widen the buffer
  9080. ;; FIXME: use `org-switch-to-buffer-other-window'?
  9081. (switch-to-buffer-other-window buffer)
  9082. (widen)
  9083. (goto-char marker)
  9084. (when (search-forward l nil lkend)
  9085. (goto-char (match-beginning 0))
  9086. (org-open-at-point)))))
  9087. lk))
  9088. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  9089. (save-excursion
  9090. (beginning-of-line 1)
  9091. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  9092. (org-link-open-from-string (match-string 1)))
  9093. (t (message "No link to open here")))))
  9094. (defun org-agenda-copy-local-variable (var)
  9095. "Get a variable from a referenced buffer and install it here."
  9096. (let ((m (org-get-at-bol 'org-marker)))
  9097. (when (and m (buffer-live-p (marker-buffer m)))
  9098. (set (make-local-variable var)
  9099. (with-current-buffer (marker-buffer m)
  9100. (symbol-value var))))))
  9101. (defun org-agenda-switch-to (&optional delete-other-windows)
  9102. "Go to the Org mode file which contains the item at point.
  9103. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  9104. displayed Org file fills the frame."
  9105. (interactive)
  9106. (if (and org-return-follows-link
  9107. (not (org-get-at-bol 'org-marker))
  9108. (org-in-regexp org-link-bracket-re))
  9109. (org-link-open-from-string (match-string 0))
  9110. (let* ((marker (or (org-get-at-bol 'org-marker)
  9111. (org-agenda-error)))
  9112. (buffer (marker-buffer marker))
  9113. (pos (marker-position marker)))
  9114. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  9115. (pop-to-buffer-same-window buffer)
  9116. (when delete-other-windows (delete-other-windows))
  9117. (widen)
  9118. (goto-char pos)
  9119. (when (derived-mode-p 'org-mode)
  9120. (org-fold-show-context 'agenda)
  9121. (run-hooks 'org-agenda-after-show-hook)))))
  9122. (defun org-agenda-goto-mouse (ev)
  9123. "Go to the Org file which contains the item at the mouse click."
  9124. (interactive "e")
  9125. (mouse-set-point ev)
  9126. (org-agenda-goto))
  9127. (defun org-agenda-show (&optional full-entry)
  9128. "Display the Org file which contains the item at point.
  9129. With prefix argument FULL-ENTRY, make the entire entry visible
  9130. if it was hidden in the outline."
  9131. (interactive "P")
  9132. (let ((win (selected-window)))
  9133. (org-agenda-goto t)
  9134. (when full-entry (org-fold-show-entry 'hide-drawers))
  9135. (select-window win)))
  9136. (defvar org-agenda-show-window nil)
  9137. (defun org-agenda-show-and-scroll-up (&optional arg)
  9138. "Display the Org file which contains the item at point.
  9139. When called repeatedly, scroll the window that is displaying the buffer.
  9140. With a `\\[universal-argument]' prefix argument, display the item, but \
  9141. fold drawers."
  9142. (interactive "P")
  9143. (let ((win (selected-window)))
  9144. (if (and (window-live-p org-agenda-show-window)
  9145. (eq this-command last-command))
  9146. (progn
  9147. (select-window org-agenda-show-window)
  9148. (ignore-errors (scroll-up)))
  9149. (org-agenda-goto t)
  9150. (org-fold-show-entry 'hide-drawers)
  9151. (if arg (org-cycle-hide-drawers 'children)
  9152. (org-with-wide-buffer
  9153. (narrow-to-region (org-entry-beginning-position)
  9154. (org-entry-end-position))
  9155. (org-fold-show-all '(drawers))))
  9156. (setq org-agenda-show-window (selected-window)))
  9157. (select-window win)))
  9158. (defun org-agenda-show-scroll-down ()
  9159. "Scroll down the window showing the agenda."
  9160. (interactive)
  9161. (let ((win (selected-window)))
  9162. (when (window-live-p org-agenda-show-window)
  9163. (select-window org-agenda-show-window)
  9164. (ignore-errors (scroll-down))
  9165. (select-window win))))
  9166. (defun org-agenda-show-1 (&optional more)
  9167. "Display the Org file which contains the item at point.
  9168. The prefix arg selects the amount of information to display:
  9169. 0 hide the subtree
  9170. 1 just show the entry according to defaults.
  9171. 2 show the children view
  9172. 3 show the subtree view
  9173. 4 show the entire subtree and any drawers
  9174. With prefix argument FULL-ENTRY, make the entire entry visible
  9175. if it was hidden in the outline."
  9176. (interactive "p")
  9177. (let ((win (selected-window)))
  9178. (org-agenda-goto t)
  9179. (org-back-to-heading)
  9180. (set-window-start (selected-window) (line-beginning-position))
  9181. (cond
  9182. ((= more 0)
  9183. (org-fold-subtree t)
  9184. (save-excursion
  9185. (org-back-to-heading)
  9186. (run-hook-with-args 'org-cycle-hook 'folded))
  9187. (message "Remote: FOLDED"))
  9188. ((and (called-interactively-p 'any) (= more 1))
  9189. (message "Remote: show with default settings"))
  9190. ((= more 2)
  9191. (org-fold-show-entry 'hide-drawers)
  9192. (org-fold-show-children)
  9193. (save-excursion
  9194. (org-back-to-heading)
  9195. (run-hook-with-args 'org-cycle-hook 'children))
  9196. (message "Remote: CHILDREN"))
  9197. ((= more 3)
  9198. (org-fold-show-subtree)
  9199. (save-excursion
  9200. (org-back-to-heading)
  9201. (run-hook-with-args 'org-cycle-hook 'subtree))
  9202. (message "Remote: SUBTREE"))
  9203. ((> more 3)
  9204. (org-fold-show-subtree)
  9205. (message "Remote: SUBTREE AND ALL DRAWERS")))
  9206. (select-window win)))
  9207. (defvar org-agenda-cycle-counter nil)
  9208. (defun org-agenda-cycle-show (&optional n)
  9209. "Show the current entry in another window, with default settings.
  9210. Default settings are taken from `org-show-context-detail'. When
  9211. use repeatedly in immediate succession, the remote entry will
  9212. cycle through visibility
  9213. children -> subtree -> folded
  9214. When called with a numeric prefix arg, that arg will be passed through to
  9215. `org-agenda-show-1'. For the interpretation of that argument, see the
  9216. docstring of `org-agenda-show-1'."
  9217. (interactive "P")
  9218. (if (integerp n)
  9219. (setq org-agenda-cycle-counter n)
  9220. (if (not (eq last-command this-command))
  9221. (setq org-agenda-cycle-counter 1)
  9222. (if (equal org-agenda-cycle-counter 0)
  9223. (setq org-agenda-cycle-counter 2)
  9224. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  9225. (when (> org-agenda-cycle-counter 3)
  9226. (setq org-agenda-cycle-counter 0)))))
  9227. (org-agenda-show-1 org-agenda-cycle-counter))
  9228. (defun org-agenda-recenter (arg)
  9229. "Display the Org file which contains the item at point and recenter."
  9230. (interactive "P")
  9231. (let ((win (selected-window)))
  9232. (org-agenda-goto t)
  9233. (recenter arg)
  9234. (select-window win)))
  9235. (defun org-agenda-show-mouse (ev)
  9236. "Display the Org file which contains the item at the mouse click."
  9237. (interactive "e")
  9238. (mouse-set-point ev)
  9239. (org-agenda-show))
  9240. (defun org-agenda-check-no-diary ()
  9241. "Check if the entry is a diary link and abort if yes."
  9242. (when (org-get-at-bol 'org-agenda-diary-link)
  9243. (org-agenda-error)))
  9244. (defun org-agenda-error ()
  9245. "Throw an error when a command is not allowed in the agenda."
  9246. (user-error "Command not allowed in this line"))
  9247. (defun org-agenda-tree-to-indirect-buffer (arg)
  9248. "Show the subtree corresponding to the current entry in an indirect buffer.
  9249. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  9250. With a numerical prefix ARG, go up to this level and then take that tree.
  9251. With a negative numeric ARG, go up by this number of levels.
  9252. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  9253. i.e. don't use
  9254. the dedicated frame."
  9255. (interactive "P")
  9256. (if current-prefix-arg
  9257. (org-agenda-do-tree-to-indirect-buffer arg)
  9258. (let ((agenda-buffer (buffer-name))
  9259. (agenda-window (selected-window))
  9260. (indirect-window
  9261. (and org-last-indirect-buffer
  9262. (get-buffer-window org-last-indirect-buffer))))
  9263. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  9264. (unless (or (eq org-indirect-buffer-display 'new-frame)
  9265. (eq org-indirect-buffer-display 'dedicated-frame))
  9266. (unwind-protect
  9267. (unless (and indirect-window (window-live-p indirect-window))
  9268. (setq indirect-window (split-window agenda-window)))
  9269. (and indirect-window (select-window indirect-window))
  9270. (switch-to-buffer org-last-indirect-buffer :norecord)
  9271. (fit-window-to-buffer indirect-window)))
  9272. (select-window (get-buffer-window agenda-buffer))
  9273. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  9274. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  9275. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  9276. (org-agenda-check-no-diary)
  9277. (let* ((marker (or (org-get-at-bol 'org-marker)
  9278. (org-agenda-error)))
  9279. (buffer (marker-buffer marker))
  9280. (pos (marker-position marker)))
  9281. (with-current-buffer buffer
  9282. (save-excursion
  9283. (goto-char pos)
  9284. (org-tree-to-indirect-buffer arg)))))
  9285. (defvar org-last-heading-marker (make-marker)
  9286. "Marker pointing to the headline that last changed its TODO state
  9287. by a remote command from the agenda.")
  9288. (defun org-agenda-todo-nextset ()
  9289. "Switch TODO entry to next sequence."
  9290. (interactive)
  9291. (org-agenda-todo 'nextset))
  9292. (defun org-agenda-todo-previousset ()
  9293. "Switch TODO entry to previous sequence."
  9294. (interactive)
  9295. (org-agenda-todo 'previousset))
  9296. (defvar org-agenda-headline-snapshot-before-repeat)
  9297. (defun org-agenda-todo (&optional arg)
  9298. "Cycle TODO state of line at point, also in Org file.
  9299. This changes the line at point, all other lines in the agenda referring to
  9300. the same tree node, and the headline of the tree node in the Org file."
  9301. (interactive "P")
  9302. (org-agenda-check-no-diary)
  9303. (org-agenda-maybe-loop
  9304. #'org-agenda-todo arg nil nil
  9305. (let* ((col (current-column))
  9306. (marker (or (org-get-at-bol 'org-marker)
  9307. (org-agenda-error)))
  9308. (buffer (marker-buffer marker))
  9309. (pos (marker-position marker))
  9310. (hdmarker (org-get-at-bol 'org-hd-marker))
  9311. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  9312. (inhibit-read-only t)
  9313. org-loop-over-headlines-in-active-region
  9314. org-agenda-headline-snapshot-before-repeat newhead just-one)
  9315. (org-with-remote-undo buffer
  9316. (with-current-buffer buffer
  9317. (widen)
  9318. (goto-char pos)
  9319. (org-fold-show-context 'agenda)
  9320. (let ((current-prefix-arg arg))
  9321. (call-interactively 'org-todo)
  9322. ;; Make sure that log is recorded in current undo.
  9323. (when (and org-log-setup
  9324. (not (eq org-log-note-how 'note)))
  9325. (org-add-log-note)))
  9326. (and (bolp) (forward-char 1))
  9327. (setq newhead (org-get-heading))
  9328. (when (and org-agenda-headline-snapshot-before-repeat
  9329. (not (equal org-agenda-headline-snapshot-before-repeat
  9330. newhead))
  9331. todayp)
  9332. (setq newhead org-agenda-headline-snapshot-before-repeat
  9333. just-one t))
  9334. (save-excursion
  9335. (org-back-to-heading)
  9336. (move-marker org-last-heading-marker (point))))
  9337. (beginning-of-line 1)
  9338. (save-window-excursion
  9339. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  9340. (when (bound-and-true-p org-clock-out-when-done)
  9341. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  9342. newhead)
  9343. (org-agenda-unmark-clocking-task))
  9344. (org-move-to-column col)
  9345. (org-agenda-mark-clocking-task)))))
  9346. (defun org-agenda-add-note (&optional _arg)
  9347. "Add a time-stamped note to the entry at point."
  9348. (interactive) ;; "P"
  9349. (org-agenda-check-no-diary)
  9350. (let* ((marker (or (org-get-at-bol 'org-marker)
  9351. (org-agenda-error)))
  9352. (buffer (marker-buffer marker))
  9353. (pos (marker-position marker))
  9354. (_hdmarker (org-get-at-bol 'org-hd-marker))
  9355. (inhibit-read-only t))
  9356. (with-current-buffer buffer
  9357. (widen)
  9358. (goto-char pos)
  9359. (org-fold-show-context 'agenda)
  9360. (org-add-note))))
  9361. (defun org-agenda-change-all-lines (newhead hdmarker
  9362. &optional fixface just-this)
  9363. "Change all lines in the agenda buffer which match HDMARKER.
  9364. The new content of the line will be NEWHEAD (as modified by
  9365. `org-agenda-format-item'). HDMARKER is checked with
  9366. `equal' against all `org-hd-marker' text properties in the file.
  9367. If FIXFACE is non-nil, the face of each item is modified according to
  9368. the new TODO state.
  9369. If JUST-THIS is non-nil, change just the current line, not all.
  9370. If FORCE-TAGS is non-nil, the car of it returns the new tags."
  9371. (let* ((inhibit-read-only t)
  9372. (line (org-current-line))
  9373. (org-agenda-buffer (current-buffer))
  9374. (thetags (with-current-buffer (marker-buffer hdmarker)
  9375. (org-get-tags hdmarker)))
  9376. props m undone-face done-face finish new dotime level cat tags
  9377. effort effort-minutes) ;; pl
  9378. (save-excursion
  9379. (goto-char (point-max))
  9380. (beginning-of-line 1)
  9381. (while (not finish)
  9382. (setq finish (bobp))
  9383. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  9384. (or (not just-this) (= (org-current-line) line))
  9385. (equal m hdmarker))
  9386. (setq props (text-properties-at (point))
  9387. dotime (org-get-at-bol 'dotime)
  9388. cat (org-agenda-get-category)
  9389. level (org-get-at-bol 'level)
  9390. tags thetags
  9391. effort (org-get-at-bol 'effort)
  9392. effort-minutes (org-get-at-bol 'effort-minutes)
  9393. new
  9394. (let ((org-prefix-format-compiled
  9395. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  9396. org-prefix-format-compiled))
  9397. (extra (org-get-at-bol 'extra)))
  9398. (with-current-buffer (marker-buffer hdmarker)
  9399. (org-with-wide-buffer
  9400. (org-agenda-format-item extra
  9401. (org-add-props newhead nil
  9402. 'effort effort
  9403. 'effort-minutes effort-minutes)
  9404. level cat tags dotime))))
  9405. ;; pl (text-property-any (line-beginning-position) (line-end-position) 'org-heading t)
  9406. undone-face (org-get-at-bol 'undone-face)
  9407. done-face (org-get-at-bol 'done-face))
  9408. (beginning-of-line 1)
  9409. (cond
  9410. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  9411. ((looking-at ".*")
  9412. ;; When replacing the whole line, preserve bulk mark
  9413. ;; overlay, if any.
  9414. (let ((mark (catch :overlay
  9415. (dolist (o (overlays-in (point) (+ 2 (point))))
  9416. (when (eq (overlay-get o 'type)
  9417. 'org-marked-entry-overlay)
  9418. (throw :overlay o))))))
  9419. (replace-match new t t)
  9420. (beginning-of-line)
  9421. (when mark (move-overlay mark (point) (+ 2 (point)))))
  9422. (add-text-properties (line-beginning-position) (line-end-position) props)
  9423. (when fixface
  9424. (add-text-properties
  9425. (line-beginning-position) (line-end-position)
  9426. (list 'face
  9427. (if org-last-todo-state-is-todo
  9428. undone-face done-face))))
  9429. (org-agenda-highlight-todo 'line)
  9430. (beginning-of-line 1))
  9431. (t (error "Line update did not work")))
  9432. (save-restriction
  9433. (narrow-to-region (line-beginning-position) (line-end-position))
  9434. (org-agenda-finalize)))
  9435. (beginning-of-line 0)))))
  9436. (defun org-agenda-align-tags (&optional line)
  9437. "Align all tags in agenda items to `org-agenda-tags-column'.
  9438. When optional argument LINE is non-nil, align tags only on the
  9439. current line."
  9440. (let ((inhibit-read-only t)
  9441. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  9442. (- (window-max-chars-per-line))
  9443. org-agenda-tags-column))
  9444. (end (and line (line-end-position)))
  9445. l c)
  9446. (org-fold-core-ignore-modifications
  9447. (save-excursion
  9448. (goto-char (if line (line-beginning-position) (point-min)))
  9449. (while (re-search-forward org-tag-group-re end t)
  9450. (add-text-properties
  9451. (match-beginning 1) (match-end 1)
  9452. (list 'face (delq nil (let ((prop (get-text-property
  9453. (match-beginning 1) 'face)))
  9454. (or (listp prop) (setq prop (list prop)))
  9455. (if (memq 'org-tag prop)
  9456. prop
  9457. (cons 'org-tag prop))))))
  9458. (setq l (string-width (match-string 1))
  9459. c (if (< org-agenda-tags-column 0)
  9460. (- (abs org-agenda-tags-column) l)
  9461. org-agenda-tags-column))
  9462. (goto-char (match-beginning 1))
  9463. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  9464. (point))
  9465. (insert (org-add-props
  9466. (make-string (max 1 (- c (current-column))) ?\s)
  9467. (plist-put (copy-sequence (text-properties-at (point)))
  9468. 'face nil))))
  9469. (goto-char (point-min))
  9470. (org-font-lock-add-tag-faces (point-max))))))
  9471. (defun org-agenda-priority-up ()
  9472. "Increase the priority of line at point, also in Org file."
  9473. (interactive)
  9474. (org-agenda-priority 'up))
  9475. (defun org-agenda-priority-down ()
  9476. "Decrease the priority of line at point, also in Org file."
  9477. (interactive)
  9478. (org-agenda-priority 'down))
  9479. (defun org-agenda-priority (&optional force-direction)
  9480. "Set the priority of line at point, also in Org file.
  9481. This changes the line at point, all other lines in the agenda
  9482. referring to the same tree node, and the headline of the tree
  9483. node in the Org file.
  9484. Called with one universal prefix arg, show the priority instead
  9485. of setting it.
  9486. When called programmatically, FORCE-DIRECTION can be `set', `up',
  9487. `down', or a character."
  9488. (interactive "P")
  9489. (unless org-priority-enable-commands
  9490. (user-error "Priority commands are disabled"))
  9491. (org-agenda-check-no-diary)
  9492. (let* ((col (current-column))
  9493. (hdmarker (org-get-at-bol 'org-hd-marker))
  9494. (buffer (marker-buffer hdmarker))
  9495. (pos (marker-position hdmarker))
  9496. (inhibit-read-only t)
  9497. newhead)
  9498. (org-with-remote-undo buffer
  9499. (with-current-buffer buffer
  9500. (widen)
  9501. (goto-char pos)
  9502. (org-fold-show-context 'agenda)
  9503. (org-priority force-direction)
  9504. (end-of-line 1)
  9505. (setq newhead (org-get-heading)))
  9506. (org-agenda-change-all-lines newhead hdmarker)
  9507. (org-move-to-column col))))
  9508. ;; FIXME: should fix the tags property of the agenda line.
  9509. (defun org-agenda-set-tags (&optional tag onoff)
  9510. "Set tags for the current headline."
  9511. (interactive)
  9512. (org-agenda-check-no-diary)
  9513. (if (and (org-region-active-p) (called-interactively-p 'any))
  9514. (call-interactively 'org-change-tag-in-region)
  9515. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9516. (org-agenda-error)))
  9517. (buffer (marker-buffer hdmarker))
  9518. (pos (marker-position hdmarker))
  9519. (inhibit-read-only t)
  9520. newhead)
  9521. (org-with-remote-undo buffer
  9522. (with-current-buffer buffer
  9523. (widen)
  9524. (goto-char pos)
  9525. (org-fold-show-context 'agenda)
  9526. (if tag
  9527. (org-toggle-tag tag onoff)
  9528. (call-interactively #'org-set-tags-command))
  9529. (end-of-line 1)
  9530. (setq newhead (org-get-heading)))
  9531. (org-agenda-change-all-lines newhead hdmarker)
  9532. (beginning-of-line 1)))))
  9533. (defun org-agenda-set-property ()
  9534. "Set a property for the current headline."
  9535. (interactive)
  9536. (org-agenda-check-no-diary)
  9537. (org-agenda-maybe-loop
  9538. #'org-agenda-set-property nil nil nil
  9539. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9540. (org-agenda-error)))
  9541. (buffer (marker-buffer hdmarker))
  9542. (pos (marker-position hdmarker))
  9543. (inhibit-read-only t)
  9544. ) ;; newhead
  9545. (org-with-remote-undo buffer
  9546. (with-current-buffer buffer
  9547. (widen)
  9548. (goto-char pos)
  9549. (org-fold-show-context 'agenda)
  9550. (call-interactively 'org-set-property))))))
  9551. (defun org-agenda-set-effort ()
  9552. "Set the effort property for the current headline."
  9553. (interactive)
  9554. (org-agenda-check-no-diary)
  9555. (org-agenda-maybe-loop
  9556. #'org-agenda-set-effort nil nil nil
  9557. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9558. (org-agenda-error)))
  9559. (buffer (marker-buffer hdmarker))
  9560. (pos (marker-position hdmarker))
  9561. (inhibit-read-only t)
  9562. newhead)
  9563. (org-with-remote-undo buffer
  9564. (with-current-buffer buffer
  9565. (widen)
  9566. (goto-char pos)
  9567. (org-fold-show-context 'agenda)
  9568. (call-interactively 'org-set-effort)
  9569. (end-of-line 1)
  9570. (setq newhead (org-get-heading)))
  9571. (org-agenda-change-all-lines newhead hdmarker)))))
  9572. (defun org-agenda-toggle-archive-tag ()
  9573. "Toggle the archive tag for the current entry."
  9574. (interactive)
  9575. (org-agenda-check-no-diary)
  9576. (org-agenda-maybe-loop
  9577. #'org-agenda-toggle-archive-tag nil nil nil
  9578. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9579. (org-agenda-error)))
  9580. (buffer (marker-buffer hdmarker))
  9581. (pos (marker-position hdmarker))
  9582. (inhibit-read-only t)
  9583. newhead)
  9584. (org-with-remote-undo buffer
  9585. (with-current-buffer buffer
  9586. (widen)
  9587. (goto-char pos)
  9588. (org-fold-show-context 'agenda)
  9589. (call-interactively 'org-toggle-archive-tag)
  9590. (end-of-line 1)
  9591. (setq newhead (org-get-heading)))
  9592. (org-agenda-change-all-lines newhead hdmarker)
  9593. (beginning-of-line 1)))))
  9594. (defun org-agenda-do-date-later (arg)
  9595. (interactive "P")
  9596. (cond
  9597. ((or (equal arg '(16))
  9598. (memq last-command
  9599. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9600. (setq this-command 'org-agenda-date-later-minutes)
  9601. (org-agenda-date-later-minutes 1))
  9602. ((or (equal arg '(4))
  9603. (memq last-command
  9604. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9605. (setq this-command 'org-agenda-date-later-hours)
  9606. (org-agenda-date-later-hours 1))
  9607. (t
  9608. (org-agenda-date-later (prefix-numeric-value arg)))))
  9609. (defun org-agenda-do-date-earlier (arg)
  9610. (interactive "P")
  9611. (cond
  9612. ((or (equal arg '(16))
  9613. (memq last-command
  9614. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9615. (setq this-command 'org-agenda-date-earlier-minutes)
  9616. (org-agenda-date-earlier-minutes 1))
  9617. ((or (equal arg '(4))
  9618. (memq last-command
  9619. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9620. (setq this-command 'org-agenda-date-earlier-hours)
  9621. (org-agenda-date-earlier-hours 1))
  9622. (t
  9623. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  9624. (defun org-agenda-date-later (arg &optional what)
  9625. "Change the date of this item to ARG day(s) later."
  9626. (interactive "p")
  9627. (org-agenda-check-type t 'agenda)
  9628. (org-agenda-check-no-diary)
  9629. (let* ((marker (or (org-get-at-bol 'org-marker)
  9630. (org-agenda-error)))
  9631. (buffer (marker-buffer marker))
  9632. (pos (marker-position marker))
  9633. cdate today)
  9634. (org-with-remote-undo buffer
  9635. (with-current-buffer buffer
  9636. (widen)
  9637. (goto-char pos)
  9638. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9639. (when (and org-agenda-move-date-from-past-immediately-to-today
  9640. (equal arg 1)
  9641. (or (not what) (eq what 'day))
  9642. (not (save-match-data (org-at-date-range-p))))
  9643. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  9644. cdate (calendar-absolute-from-gregorian
  9645. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  9646. today (org-today))
  9647. (when (> today cdate)
  9648. ;; immediately shift to today
  9649. (setq arg (- today cdate))))
  9650. (org-timestamp-change arg (or what 'day))
  9651. (when (and (org-at-date-range-p)
  9652. (re-search-backward org-tr-regexp-both (line-beginning-position)))
  9653. (let ((end org-last-changed-timestamp))
  9654. (org-timestamp-change arg (or what 'day))
  9655. (setq org-last-changed-timestamp
  9656. (concat org-last-changed-timestamp "--" end)))))
  9657. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9658. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  9659. (defun org-agenda-date-earlier (arg &optional what)
  9660. "Change the date of this item to ARG day(s) earlier."
  9661. (interactive "p")
  9662. (org-agenda-date-later (- arg) what))
  9663. (defun org-agenda-date-later-minutes (arg)
  9664. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9665. (interactive "p")
  9666. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9667. (org-agenda-date-later arg 'minute))
  9668. (defun org-agenda-date-earlier-minutes (arg)
  9669. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9670. (interactive "p")
  9671. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9672. (org-agenda-date-earlier arg 'minute))
  9673. (defun org-agenda-date-later-hours (arg)
  9674. "Change the time of this item, in hour steps."
  9675. (interactive "p")
  9676. (org-agenda-date-later arg 'hour))
  9677. (defun org-agenda-date-earlier-hours (arg)
  9678. "Change the time of this item, in hour steps."
  9679. (interactive "p")
  9680. (org-agenda-date-earlier arg 'hour))
  9681. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  9682. "Show new date stamp via text properties."
  9683. ;; We use text properties to make this undoable
  9684. (let ((inhibit-read-only t))
  9685. (setq stamp (concat prefix " => " stamp " "))
  9686. (save-excursion
  9687. (goto-char (point-max))
  9688. (while (not (bobp))
  9689. (when (equal marker (org-get-at-bol 'org-marker))
  9690. (remove-text-properties (line-beginning-position)
  9691. (line-end-position)
  9692. '(display nil))
  9693. (org-move-to-column
  9694. (- (window-max-chars-per-line)
  9695. (length stamp))
  9696. t)
  9697. (add-text-properties
  9698. (1- (point)) (line-end-position)
  9699. (list 'display (org-add-props stamp nil
  9700. 'face '(secondary-selection default))))
  9701. (beginning-of-line 1))
  9702. (beginning-of-line 0)))))
  9703. (defun org-agenda-date-prompt (arg)
  9704. "Change the date of this item. Date is prompted for, with default today.
  9705. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  9706. be used to request time specification in the time stamp."
  9707. (interactive "P")
  9708. (org-agenda-check-type t 'agenda)
  9709. (org-agenda-check-no-diary)
  9710. (org-agenda-maybe-loop
  9711. #'org-agenda-date-prompt arg t nil
  9712. (let* ((marker (or (org-get-at-bol 'org-marker)
  9713. (org-agenda-error)))
  9714. (buffer (marker-buffer marker))
  9715. (pos (marker-position marker)))
  9716. (org-with-remote-undo buffer
  9717. (with-current-buffer buffer
  9718. (widen)
  9719. (goto-char pos)
  9720. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9721. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  9722. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9723. (message "Time stamp changed to %s" org-last-changed-timestamp))))
  9724. (defun org-agenda-schedule (arg &optional time)
  9725. "Schedule the item at point.
  9726. ARG is passed through to `org-schedule'."
  9727. (interactive "P")
  9728. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9729. (org-agenda-check-no-diary)
  9730. (org-agenda-maybe-loop
  9731. #'org-agenda-schedule arg t nil
  9732. (let* ((marker (or (org-get-at-bol 'org-marker)
  9733. (org-agenda-error)))
  9734. ;; (type (marker-insertion-type marker))
  9735. (buffer (marker-buffer marker))
  9736. (pos (marker-position marker))
  9737. ts)
  9738. (set-marker-insertion-type marker t)
  9739. (org-with-remote-undo buffer
  9740. (with-current-buffer buffer
  9741. (widen)
  9742. (goto-char pos)
  9743. (setq ts (org-schedule arg time)))
  9744. (org-agenda-show-new-time marker ts " S"))
  9745. (message "%s" ts))))
  9746. (defun org-agenda-deadline (arg &optional time)
  9747. "Schedule the item at point.
  9748. ARG is passed through to `org-deadline'."
  9749. (interactive "P")
  9750. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9751. (org-agenda-check-no-diary)
  9752. (org-agenda-maybe-loop
  9753. #'org-agenda-deadline arg t nil
  9754. (let* ((marker (or (org-get-at-bol 'org-marker)
  9755. (org-agenda-error)))
  9756. (buffer (marker-buffer marker))
  9757. (pos (marker-position marker))
  9758. ts)
  9759. (org-with-remote-undo buffer
  9760. (with-current-buffer buffer
  9761. (widen)
  9762. (goto-char pos)
  9763. (setq ts (org-deadline arg time)))
  9764. (org-agenda-show-new-time marker ts " D"))
  9765. (message "%s" ts))))
  9766. (defun org-agenda-clock-in (&optional arg)
  9767. "Start the clock on the currently selected item."
  9768. (interactive "P")
  9769. (org-agenda-check-no-diary)
  9770. (if (equal arg '(4))
  9771. (org-clock-in arg)
  9772. (let* ((marker (or (org-get-at-bol 'org-marker)
  9773. (org-agenda-error)))
  9774. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  9775. (pos (marker-position marker))
  9776. (col (current-column))
  9777. newhead)
  9778. (org-with-remote-undo (marker-buffer marker)
  9779. (with-current-buffer (marker-buffer marker)
  9780. (widen)
  9781. (goto-char pos)
  9782. (org-fold-show-context 'agenda)
  9783. (org-clock-in arg)
  9784. (setq newhead (org-get-heading)))
  9785. (org-agenda-change-all-lines newhead hdmarker))
  9786. (org-move-to-column col))))
  9787. (defun org-agenda-clock-out ()
  9788. "Stop the currently running clock."
  9789. (interactive)
  9790. (unless (marker-buffer org-clock-marker)
  9791. (user-error "No running clock"))
  9792. (let ((marker (make-marker)) (col (current-column)) newhead)
  9793. (org-with-remote-undo (marker-buffer org-clock-marker)
  9794. (with-current-buffer (marker-buffer org-clock-marker)
  9795. (org-with-wide-buffer
  9796. (goto-char org-clock-marker)
  9797. (org-back-to-heading t)
  9798. (move-marker marker (point))
  9799. (org-clock-out)
  9800. (setq newhead (org-get-heading)))))
  9801. (org-agenda-change-all-lines newhead marker)
  9802. (move-marker marker nil)
  9803. (org-move-to-column col)
  9804. (org-agenda-unmark-clocking-task)))
  9805. (defun org-agenda-clock-cancel (&optional _arg)
  9806. "Cancel the currently running clock."
  9807. (interactive) ;; "P"
  9808. (unless (marker-buffer org-clock-marker)
  9809. (user-error "No running clock"))
  9810. (org-with-remote-undo (marker-buffer org-clock-marker)
  9811. (org-clock-cancel)))
  9812. (defun org-agenda-clock-goto ()
  9813. "Jump to the currently clocked in task within the agenda.
  9814. If the currently clocked in task is not listed in the agenda
  9815. buffer, display it in another window."
  9816. (interactive)
  9817. (let (pos)
  9818. (mapc (lambda (o)
  9819. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  9820. (setq pos (overlay-start o))))
  9821. (overlays-in (point-min) (point-max)))
  9822. (cond (pos (goto-char pos))
  9823. ;; If the currently clocked entry is not in the agenda
  9824. ;; buffer, we visit it in another window:
  9825. ((bound-and-true-p org-clock-current-task)
  9826. (org-switch-to-buffer-other-window (org-clock-goto)))
  9827. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  9828. (defun org-agenda-diary-entry-in-org-file ()
  9829. "Make a diary entry in the file `org-agenda-diary-file'."
  9830. (let (d1 d2 char (text "") dp1 dp2)
  9831. (if (equal (buffer-name) "*Calendar*")
  9832. (setq d1 (calendar-cursor-to-date t)
  9833. d2 (car calendar-mark-ring))
  9834. (setq dp1 (get-text-property (line-beginning-position) 'day))
  9835. (unless dp1 (user-error "No date defined in current line"))
  9836. (setq d1 (calendar-gregorian-from-absolute dp1)
  9837. d2 (and (ignore-errors (mark))
  9838. (save-excursion
  9839. (goto-char (mark))
  9840. (setq dp2 (get-text-property (line-beginning-position) 'day)))
  9841. (calendar-gregorian-from-absolute dp2))))
  9842. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  9843. (setq char (read-char-exclusive))
  9844. (cond
  9845. ((equal char ?d)
  9846. (setq text (read-string "Day entry: "))
  9847. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  9848. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9849. ((equal char ?a)
  9850. (setq d1 (list (car d1) (nth 1 d1)
  9851. (read-number (format "Reference year [%d]: " (nth 2 d1))
  9852. (nth 2 d1))))
  9853. (setq text (read-string "Anniversary (use %d to show years): "))
  9854. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  9855. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9856. ((equal char ?b)
  9857. (setq text (read-string "Block entry: "))
  9858. (unless (and d1 d2 (not (equal d1 d2)))
  9859. (user-error "No block of days selected"))
  9860. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  9861. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9862. ((equal char ?j)
  9863. (org-switch-to-buffer-other-window
  9864. (find-file-noselect org-agenda-diary-file))
  9865. (require 'org-datetree)
  9866. (org-datetree-find-date-create d1)
  9867. (org-fold-reveal t))
  9868. (t (user-error "Invalid selection character `%c'" char)))))
  9869. (defcustom org-agenda-insert-diary-strategy 'date-tree
  9870. "Where in `org-agenda-diary-file' should new entries be added?
  9871. Valid values:
  9872. date-tree in the date tree, as first child of the date
  9873. date-tree-last in the date tree, as last child of the date
  9874. top-level as top-level entries at the end of the file."
  9875. :group 'org-agenda
  9876. :type '(choice
  9877. (const :tag "first in a date tree" date-tree)
  9878. (const :tag "last in a date tree" date-tree-last)
  9879. (const :tag "as top level at end of file" top-level)))
  9880. (defcustom org-agenda-insert-diary-extract-time nil
  9881. "Non-nil means extract any time specification from the diary entry."
  9882. :group 'org-agenda
  9883. :version "24.1"
  9884. :type 'boolean)
  9885. (defcustom org-agenda-bulk-mark-char ">"
  9886. "A single-character string to be used as the bulk mark."
  9887. :group 'org-agenda
  9888. :version "24.1"
  9889. :type 'string)
  9890. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  9891. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  9892. If TEXT is not empty, it will become the headline of the new entry, and
  9893. the resulting entry will not be shown. When TEXT is empty, switch to
  9894. `org-agenda-diary-file' and let the user finish the entry there."
  9895. (let ((cw (current-window-configuration)))
  9896. (org-switch-to-buffer-other-window
  9897. (find-file-noselect org-agenda-diary-file))
  9898. (widen)
  9899. (goto-char (point-min))
  9900. (cl-case type
  9901. (anniversary
  9902. (or (re-search-forward "^\\*[ \t]+Anniversaries" nil t)
  9903. (progn
  9904. (or (org-at-heading-p)
  9905. (progn
  9906. (outline-next-heading)
  9907. (insert "* Anniversaries\n\n")
  9908. (beginning-of-line -1)))))
  9909. (outline-next-heading)
  9910. (org-back-over-empty-lines)
  9911. (backward-char 1)
  9912. (insert "\n")
  9913. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  9914. (nth 2 d1) (car d1) (nth 1 d1) text)))
  9915. (day
  9916. (let ((org-prefix-has-time t)
  9917. (org-agenda-time-leading-zero t)
  9918. fmt time time2)
  9919. (when org-agenda-insert-diary-extract-time
  9920. ;; Use org-agenda-format-item to parse text for a time-range and
  9921. ;; remove it. FIXME: This is a hack, we should refactor
  9922. ;; that function to make time extraction available separately
  9923. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  9924. time (get-text-property 0 'time fmt)
  9925. time2 (if (> (length time) 0)
  9926. ;; split-string removes trailing ...... if
  9927. ;; no end time given. First space
  9928. ;; separates time from date.
  9929. (concat " " (car (split-string time "\\.")))
  9930. nil)
  9931. text (get-text-property 0 'txt fmt)))
  9932. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9933. (org-agenda-insert-diary-as-top-level text)
  9934. (require 'org-datetree)
  9935. (org-datetree-find-date-create d1)
  9936. (org-agenda-insert-diary-make-new-entry text))
  9937. (org-insert-time-stamp (org-time-from-absolute
  9938. (calendar-absolute-from-gregorian d1))
  9939. nil nil nil nil time2))
  9940. (end-of-line 0))
  9941. ((block) ;; Wrap this in (strictly unnecessary) parens because
  9942. ;; otherwise the indentation gets confused by the
  9943. ;; special meaning of 'block
  9944. (when (> (calendar-absolute-from-gregorian d1)
  9945. (calendar-absolute-from-gregorian d2))
  9946. (setq d1 (prog1 d2 (setq d2 d1))))
  9947. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9948. (org-agenda-insert-diary-as-top-level text)
  9949. (require 'org-datetree)
  9950. (org-datetree-find-date-create d1)
  9951. (org-agenda-insert-diary-make-new-entry text))
  9952. (org-insert-time-stamp (org-time-from-absolute
  9953. (calendar-absolute-from-gregorian d1)))
  9954. (insert "--")
  9955. (org-insert-time-stamp (org-time-from-absolute
  9956. (calendar-absolute-from-gregorian d2)))
  9957. (end-of-line 0)))
  9958. (if (string-match "\\S-" text)
  9959. (progn
  9960. (set-window-configuration cw)
  9961. (message "%s entry added to %s"
  9962. (capitalize (symbol-name type))
  9963. (abbreviate-file-name org-agenda-diary-file)))
  9964. (org-fold-reveal t)
  9965. (message "Please finish entry here"))))
  9966. (defun org-agenda-insert-diary-as-top-level (text)
  9967. "Make new entry as a top-level entry at the end of the file.
  9968. Add TEXT as headline, and position the cursor in the second line so that
  9969. a timestamp can be added there."
  9970. (widen)
  9971. (goto-char (point-max))
  9972. (unless (bolp) (insert "\n"))
  9973. (org-insert-heading nil t t)
  9974. (insert text)
  9975. (org-end-of-meta-data)
  9976. (unless (bolp) (insert "\n"))
  9977. (when org-adapt-indentation (indent-to-column 2)))
  9978. (defun org-agenda-insert-diary-make-new-entry (text)
  9979. "Make a new entry with TEXT as a child of the current subtree.
  9980. Position the point in the heading's first body line so that
  9981. a timestamp can be added there."
  9982. (cond
  9983. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  9984. (end-of-line)
  9985. (org-insert-heading '(4) t)
  9986. (org-do-demote))
  9987. (t
  9988. (outline-next-heading)
  9989. (org-back-over-empty-lines)
  9990. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  9991. (org-insert-heading nil t)
  9992. (org-do-demote)))
  9993. (let ((col (current-column)))
  9994. (insert text)
  9995. (org-end-of-meta-data)
  9996. ;; Ensure point is left on a blank line, at proper indentation.
  9997. (unless (bolp) (insert "\n"))
  9998. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  9999. (when org-adapt-indentation (indent-to-column col)))
  10000. (org-fold-show-set-visibility 'lineage))
  10001. (defun org-agenda-diary-entry ()
  10002. "Make a diary entry, like the `i' command from the calendar.
  10003. All the standard commands work: block, weekly etc.
  10004. When `org-agenda-diary-file' points to a file,
  10005. `org-agenda-diary-entry-in-org-file' is called instead to create
  10006. entries in that Org file."
  10007. (interactive)
  10008. (if (not (eq org-agenda-diary-file 'diary-file))
  10009. (org-agenda-diary-entry-in-org-file)
  10010. (require 'diary-lib)
  10011. (let* ((char (read-char-exclusive
  10012. "Diary entry: [d]ay [w]eekly [m]onthly [y]early\
  10013. [a]nniversary [b]lock [c]yclic"))
  10014. (cmd (cdr (assoc char
  10015. '((?d . diary-insert-entry)
  10016. (?w . diary-insert-weekly-entry)
  10017. (?m . diary-insert-monthly-entry)
  10018. (?y . diary-insert-yearly-entry)
  10019. (?a . diary-insert-anniversary-entry)
  10020. (?b . diary-insert-block-entry)
  10021. (?c . diary-insert-cyclic-entry)))))
  10022. (oldf (symbol-function 'calendar-cursor-to-date))
  10023. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  10024. (point (point))
  10025. (mark (or (mark t) (point))))
  10026. (unless cmd
  10027. (user-error "No command associated with <%c>" char))
  10028. (unless (and (get-text-property point 'day)
  10029. (or (not (equal ?b char))
  10030. (get-text-property mark 'day)))
  10031. (user-error "Don't know which date to use for diary entry"))
  10032. ;; We implement this by hacking the `calendar-cursor-to-date' function
  10033. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  10034. (let ((calendar-mark-ring
  10035. (list (calendar-gregorian-from-absolute
  10036. (or (get-text-property mark 'day)
  10037. (get-text-property point 'day))))))
  10038. (unwind-protect
  10039. (progn
  10040. (fset 'calendar-cursor-to-date
  10041. (lambda (&optional _error _dummy)
  10042. (calendar-gregorian-from-absolute
  10043. (get-text-property point 'day))))
  10044. (call-interactively cmd))
  10045. (fset 'calendar-cursor-to-date oldf))))))
  10046. (defun org-agenda-execute-calendar-command (cmd)
  10047. "Execute a calendar command from the agenda with date from cursor."
  10048. (org-agenda-check-type t 'agenda)
  10049. (require 'diary-lib)
  10050. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  10051. (user-error "Don't know which date to use for the calendar command"))
  10052. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  10053. (point (point))
  10054. (date (calendar-gregorian-from-absolute
  10055. (get-text-property point 'day))))
  10056. ;; the following 2 vars are needed in the calendar
  10057. (org-dlet
  10058. ((displayed-month (car date))
  10059. (displayed-year (nth 2 date)))
  10060. (unwind-protect
  10061. (progn
  10062. (fset 'calendar-cursor-to-date
  10063. (lambda (&optional _error _dummy)
  10064. (calendar-gregorian-from-absolute
  10065. (get-text-property point 'day))))
  10066. (call-interactively cmd))
  10067. (fset 'calendar-cursor-to-date oldf)))))
  10068. (defun org-agenda-phases-of-moon ()
  10069. "Display the phases of the moon for the 3 months around the cursor date."
  10070. (interactive)
  10071. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  10072. (defun org-agenda-holidays ()
  10073. "Display the holidays for the 3 months around the cursor date."
  10074. (interactive)
  10075. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  10076. (defvar calendar-longitude) ; defined in calendar.el
  10077. (defvar calendar-latitude) ; defined in calendar.el
  10078. (defvar calendar-location-name) ; defined in calendar.el
  10079. (defun org-agenda-sunrise-sunset (arg)
  10080. "Display sunrise and sunset for the cursor date.
  10081. Latitude and longitude can be specified with the variables
  10082. `calendar-latitude' and `calendar-longitude'. When called with prefix
  10083. argument, latitude and longitude will be prompted for."
  10084. (interactive "P")
  10085. (require 'solar)
  10086. (let ((calendar-longitude (if arg nil calendar-longitude))
  10087. (calendar-latitude (if arg nil calendar-latitude))
  10088. (calendar-location-name
  10089. (if arg "the given coordinates" calendar-location-name)))
  10090. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  10091. (defun org-agenda-goto-calendar ()
  10092. "Open the Emacs calendar with the date at the cursor."
  10093. (interactive)
  10094. (org-agenda-check-type t 'agenda)
  10095. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  10096. (user-error "Don't know which date to open in calendar")))
  10097. (date (calendar-gregorian-from-absolute day))
  10098. (calendar-move-hook nil)
  10099. (calendar-view-holidays-initially-flag nil)
  10100. (calendar-view-diary-initially-flag nil))
  10101. (calendar)
  10102. (calendar-goto-date date)))
  10103. ;;;###autoload
  10104. (defun org-calendar-goto-agenda ()
  10105. "Compute the Org agenda for the calendar date displayed at the cursor.
  10106. This is a command that has to be installed in `calendar-mode-map'."
  10107. (interactive)
  10108. ;; Temporarily disable sticky agenda since user clearly wants to
  10109. ;; refresh view anyway.
  10110. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  10111. (org-agenda-sticky nil))
  10112. (org-agenda-list nil (calendar-absolute-from-gregorian
  10113. (calendar-cursor-to-date))
  10114. nil)))
  10115. (defun org-agenda-convert-date ()
  10116. (interactive)
  10117. (org-agenda-check-type t 'agenda)
  10118. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  10119. date s)
  10120. (unless day
  10121. (user-error "Don't know which date to convert"))
  10122. (setq date (calendar-gregorian-from-absolute day))
  10123. (setq s (concat
  10124. "Gregorian: " (calendar-date-string date) "\n"
  10125. "ISO: " (calendar-iso-date-string date) "\n"
  10126. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  10127. "Julian: " (calendar-julian-date-string date) "\n"
  10128. "Astron. JD: " (calendar-astro-date-string date)
  10129. " (Julian date number at noon UTC)\n"
  10130. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  10131. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  10132. "French: " (calendar-french-date-string date) "\n"
  10133. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  10134. "Mayan: " (calendar-mayan-date-string date) "\n"
  10135. "Coptic: " (calendar-coptic-date-string date) "\n"
  10136. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  10137. "Persian: " (calendar-persian-date-string date) "\n"
  10138. "Chinese: " (calendar-chinese-date-string date) "\n"))
  10139. (with-output-to-temp-buffer "*Dates*"
  10140. (princ s))
  10141. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  10142. ;;; Bulk commands
  10143. (defun org-agenda-bulk-marked-p ()
  10144. "Non-nil when current entry is marked for bulk action."
  10145. (eq (get-char-property (line-beginning-position) 'type)
  10146. 'org-marked-entry-overlay))
  10147. (defun org-agenda-bulk-mark (&optional arg)
  10148. "Mark entries for future bulk action.
  10149. When ARG is nil or one and region is not active then mark the
  10150. entry at point.
  10151. When ARG is nil or one and region is active then mark the entries
  10152. in the region.
  10153. When ARG is greater than one mark ARG lines."
  10154. (interactive "p")
  10155. (when (and (or (not arg) (= arg 1)) (use-region-p))
  10156. (setq arg (count-lines (region-beginning) (region-end)))
  10157. (goto-char (region-beginning))
  10158. (deactivate-mark))
  10159. (dotimes (_ (or arg 1))
  10160. (unless (org-get-at-bol 'org-agenda-diary-link)
  10161. (let* ((m (org-get-at-bol 'org-hd-marker))
  10162. ov)
  10163. (unless (org-agenda-bulk-marked-p)
  10164. (unless m (user-error "Nothing to mark at point"))
  10165. (push m org-agenda-bulk-marked-entries)
  10166. (setq ov (make-overlay (line-beginning-position) (+ 2 (line-beginning-position))))
  10167. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  10168. (org-get-todo-face "TODO")
  10169. 'evaporate)
  10170. (overlay-put ov 'type 'org-marked-entry-overlay))
  10171. (end-of-line 1)
  10172. (or (ignore-errors
  10173. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  10174. (beginning-of-line 2))
  10175. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  10176. (beginning-of-line 2)))))
  10177. (message "%d entries marked for bulk action"
  10178. (length org-agenda-bulk-marked-entries)))
  10179. (defun org-agenda-bulk-mark-all ()
  10180. "Mark all entries for future agenda bulk action."
  10181. (interactive)
  10182. (org-agenda-bulk-mark-regexp "."))
  10183. (defun org-agenda-bulk-mark-regexp (regexp)
  10184. "Mark entries matching REGEXP for future agenda bulk action."
  10185. (interactive "sMark entries matching regexp: ")
  10186. (let ((entries-marked 0) txt-at-point)
  10187. (save-excursion
  10188. (goto-char (point-min))
  10189. (goto-char (next-single-property-change (point) 'org-hd-marker))
  10190. (while (and (re-search-forward regexp nil t)
  10191. (setq txt-at-point
  10192. (get-text-property (match-beginning 0) 'txt)))
  10193. (if (get-char-property (point) 'invisible)
  10194. (beginning-of-line 2)
  10195. (when (string-match-p regexp txt-at-point)
  10196. (setq entries-marked (1+ entries-marked))
  10197. (call-interactively 'org-agenda-bulk-mark)))))
  10198. (unless entries-marked
  10199. (message "No entry matching this regexp."))))
  10200. (defun org-agenda-bulk-unmark (&optional arg)
  10201. "Unmark the entry at point for future bulk action."
  10202. (interactive "P")
  10203. (if arg
  10204. (org-agenda-bulk-unmark-all)
  10205. (cond ((org-agenda-bulk-marked-p)
  10206. (org-agenda-bulk-remove-overlays
  10207. (line-beginning-position) (+ 2 (line-beginning-position)))
  10208. (setq org-agenda-bulk-marked-entries
  10209. (delete (org-get-at-bol 'org-hd-marker)
  10210. org-agenda-bulk-marked-entries))
  10211. (end-of-line 1)
  10212. (or (ignore-errors
  10213. (goto-char (next-single-property-change (point) 'txt)))
  10214. (beginning-of-line 2))
  10215. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  10216. (beginning-of-line 2))
  10217. (message "%d entries left marked for bulk action"
  10218. (length org-agenda-bulk-marked-entries)))
  10219. (t (message "No entry to unmark here")))))
  10220. (defun org-agenda-bulk-toggle-all ()
  10221. "Toggle all marks for bulk action."
  10222. (interactive)
  10223. (save-excursion
  10224. (goto-char (point-min))
  10225. (while (ignore-errors
  10226. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  10227. (org-agenda-bulk-toggle))))
  10228. (defun org-agenda-bulk-toggle ()
  10229. "Toggle the mark at point for bulk action."
  10230. (interactive)
  10231. (if (org-agenda-bulk-marked-p)
  10232. (org-agenda-bulk-unmark)
  10233. (org-agenda-bulk-mark)))
  10234. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  10235. "Remove the mark overlays between BEG and END in the agenda buffer.
  10236. BEG and END default to the buffer limits.
  10237. This only removes the overlays, it does not remove the markers
  10238. from the list in `org-agenda-bulk-marked-entries'."
  10239. (interactive)
  10240. (mapc (lambda (ov)
  10241. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  10242. (delete-overlay ov)))
  10243. (overlays-in (or beg (point-min)) (or end (point-max)))))
  10244. (defun org-agenda-bulk-unmark-all ()
  10245. "Remove all marks in the agenda buffer.
  10246. This will remove the markers and the overlays."
  10247. (interactive)
  10248. (if (null org-agenda-bulk-marked-entries)
  10249. (message "No entry to unmark")
  10250. (setq org-agenda-bulk-marked-entries nil)
  10251. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  10252. (defcustom org-agenda-persistent-marks nil
  10253. "Non-nil means marked items will stay marked after a bulk action.
  10254. You can toggle this interactively by typing `p' when prompted for a
  10255. bulk action."
  10256. :group 'org-agenda
  10257. :version "24.1"
  10258. :type 'boolean)
  10259. (defcustom org-agenda-loop-over-headlines-in-active-region t
  10260. "Shall some commands act upon headlines in the active region?
  10261. When set to t, some commands will be performed in all headlines
  10262. within the active region.
  10263. When set to `start-level', some commands will be performed in all
  10264. headlines within the active region, provided that these headlines
  10265. are of the same level than the first one.
  10266. When set to a regular expression, those commands will be
  10267. performed on the matching headlines within the active region.
  10268. The list of commands is: `org-agenda-schedule',
  10269. `org-agenda-deadline', `org-agenda-date-prompt',
  10270. `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'.
  10271. See `org-loop-over-headlines-in-active-region' for the equivalent
  10272. option for Org buffers."
  10273. :type '(choice (const :tag "Don't loop" nil)
  10274. (const :tag "All headlines in active region" t)
  10275. (const :tag "In active region, headlines at the same level than the first one" start-level)
  10276. (regexp :tag "Regular expression matcher"))
  10277. :version "27.1"
  10278. :package-version '(Org . "9.4")
  10279. :group 'org-agenda)
  10280. (defun org-agenda-bulk-action (&optional arg)
  10281. "Execute an remote-editing action on all marked entries.
  10282. The prefix arg is passed through to the command if possible."
  10283. (interactive "P")
  10284. ;; When there is no mark, act on the agenda entry at point.
  10285. (if (not org-agenda-bulk-marked-entries)
  10286. (save-excursion (org-agenda-bulk-mark)))
  10287. (dolist (m org-agenda-bulk-marked-entries)
  10288. (unless (and (markerp m)
  10289. (marker-buffer m)
  10290. (buffer-live-p (marker-buffer m))
  10291. (marker-position m))
  10292. (user-error "Marker %s for bulk command is invalid" m)))
  10293. ;; Prompt for the bulk command.
  10294. (org-unlogged-message
  10295. (concat "Bulk (" (if org-agenda-persistent-marks "" "don't ") "[p]ersist marks): "
  10296. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  10297. "[S]catter [f]unction "
  10298. (and org-agenda-bulk-custom-functions
  10299. (format " Custom: [%s]"
  10300. (mapconcat (lambda (f) (char-to-string (car f)))
  10301. org-agenda-bulk-custom-functions
  10302. "")))))
  10303. (catch 'exit
  10304. (let* ((org-log-refile (if org-log-refile 'time nil))
  10305. (entries (reverse org-agenda-bulk-marked-entries))
  10306. (org-overriding-default-time
  10307. (and (get-text-property (point) 'org-agenda-date-header)
  10308. (org-get-cursor-date)))
  10309. redo-at-end
  10310. cmd)
  10311. (pcase (read-char-exclusive)
  10312. (?p
  10313. (let ((org-agenda-persistent-marks
  10314. (not org-agenda-persistent-marks)))
  10315. (org-agenda-bulk-action)
  10316. (throw 'exit nil)))
  10317. (?$
  10318. (setq cmd #'org-agenda-archive))
  10319. (?A
  10320. (setq cmd #'org-agenda-archive-to-archive-sibling))
  10321. ((or ?r ?w)
  10322. (let ((refile-location
  10323. (org-refile-get-location
  10324. "Refile to"
  10325. (marker-buffer (car entries))
  10326. org-refile-allow-creating-parent-nodes)))
  10327. (when (nth 3 refile-location)
  10328. (setcar (nthcdr 3 refile-location)
  10329. (move-marker
  10330. (make-marker)
  10331. (nth 3 refile-location)
  10332. (or (get-file-buffer (nth 1 refile-location))
  10333. (find-buffer-visiting (nth 1 refile-location))
  10334. (error "This should not happen")))))
  10335. (setq cmd (lambda () (org-agenda-refile nil refile-location t)))
  10336. (setq redo-at-end t)))
  10337. (?t
  10338. (let ((state (completing-read
  10339. "Todo state: "
  10340. (with-current-buffer (marker-buffer (car entries))
  10341. (mapcar #'list org-todo-keywords-1)))))
  10342. (setq cmd (lambda ()
  10343. (let ((org-inhibit-blocking t)
  10344. (org-inhibit-logging 'note))
  10345. (org-agenda-todo state))))))
  10346. ((and (or ?- ?+) action)
  10347. (let ((tag (completing-read
  10348. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  10349. (with-current-buffer (marker-buffer (car entries))
  10350. (delq nil
  10351. (mapcar (lambda (x) (and (stringp (car x)) x))
  10352. org-current-tag-alist))))))
  10353. (setq cmd
  10354. (lambda ()
  10355. (org-agenda-set-tags tag
  10356. (if (eq action ?+) 'on 'off))))))
  10357. ((and (or ?s ?d) c)
  10358. (let* ((schedule? (eq c ?s))
  10359. (prompt (if schedule? "(Re)Schedule to" "(Re)Set Deadline to"))
  10360. (time
  10361. (and (not arg)
  10362. (let ((new (org-read-date
  10363. nil nil nil prompt org-overriding-default-time)))
  10364. ;; A "double plus" answer applies to every
  10365. ;; scheduled time. Do not turn it into
  10366. ;; a fixed date yet.
  10367. (if (string-match-p "\\`[ \t]*\\+\\+"
  10368. org-read-date-final-answer)
  10369. org-read-date-final-answer
  10370. new)))))
  10371. ;; Make sure to not prompt for a note when bulk
  10372. ;; rescheduling/resetting deadline as Org cannot cope with
  10373. ;; simultaneous notes. Besides, it could be annoying
  10374. ;; depending on the number of marked items.
  10375. (setq cmd
  10376. (if schedule?
  10377. (lambda ()
  10378. (let ((org-log-reschedule
  10379. (and org-log-reschedule 'time)))
  10380. (org-agenda-schedule arg time)))
  10381. (lambda ()
  10382. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  10383. (org-agenda-deadline arg time)))))))
  10384. (?S
  10385. (unless (org-agenda-check-type nil 'agenda 'todo)
  10386. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  10387. (let ((days (read-number
  10388. (format "Scatter tasks across how many %sdays: "
  10389. (if arg "week" ""))
  10390. 7)))
  10391. (setq cmd
  10392. (lambda ()
  10393. (let ((distance (1+ (random days))))
  10394. (when arg
  10395. (let ((dist distance)
  10396. (day-of-week
  10397. (calendar-day-of-week
  10398. (calendar-gregorian-from-absolute (org-today)))))
  10399. (dotimes (_ (1+ dist))
  10400. (while (member day-of-week org-agenda-weekend-days)
  10401. (cl-incf distance)
  10402. (cl-incf day-of-week)
  10403. (when (= day-of-week 7)
  10404. (setq day-of-week 0)))
  10405. (cl-incf day-of-week)
  10406. (when (= day-of-week 7)
  10407. (setq day-of-week 0)))))
  10408. ;; Silently fail when try to replan a sexp entry.
  10409. (ignore-errors
  10410. (let* ((date (calendar-gregorian-from-absolute
  10411. (+ (org-today) distance)))
  10412. (time (org-encode-time
  10413. 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10414. (org-agenda-schedule nil time))))))))
  10415. (?f
  10416. (setq cmd
  10417. (intern
  10418. (completing-read "Function: " obarray #'fboundp t nil nil))))
  10419. (action
  10420. (setq cmd
  10421. (pcase (assoc action org-agenda-bulk-custom-functions)
  10422. (`(,_ ,fn)
  10423. fn)
  10424. (`(,_ ,fn ,arg-fn)
  10425. (apply #'apply-partially fn (funcall arg-fn)))
  10426. (_
  10427. (user-error "Invalid bulk action: %c" action))))
  10428. (setq redo-at-end t)))
  10429. ;; Sort the markers, to make sure that parents are handled
  10430. ;; before children.
  10431. (setq entries (sort entries
  10432. (lambda (a b)
  10433. (cond
  10434. ((eq (marker-buffer a) (marker-buffer b))
  10435. (< (marker-position a) (marker-position b)))
  10436. (t
  10437. (string< (buffer-name (marker-buffer a))
  10438. (buffer-name (marker-buffer b))))))))
  10439. ;; Now loop over all markers and apply CMD.
  10440. (let ((processed 0)
  10441. (skipped 0))
  10442. (dolist (e entries)
  10443. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  10444. (if (not pos)
  10445. (progn (message "Skipping removed entry at %s" e)
  10446. (cl-incf skipped))
  10447. (goto-char pos)
  10448. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  10449. ;; `post-command-hook' is not run yet. We make sure any
  10450. ;; pending log note is processed.
  10451. (when org-log-setup (org-add-log-note))
  10452. (cl-incf processed))))
  10453. (when redo-at-end (org-agenda-redo))
  10454. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  10455. (message "Acted on %d entries%s%s"
  10456. processed
  10457. (if (= skipped 0)
  10458. ""
  10459. (format ", skipped %d (disappeared before their turn)"
  10460. skipped))
  10461. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  10462. (defun org-agenda-capture (&optional with-time)
  10463. "Call `org-capture' with the date at point.
  10464. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  10465. current HH:MM time."
  10466. (interactive "P")
  10467. (if (not (eq major-mode 'org-agenda-mode))
  10468. (user-error "You cannot do this outside of agenda buffers")
  10469. (let ((org-overriding-default-time
  10470. (org-get-cursor-date (equal with-time 1))))
  10471. (call-interactively 'org-capture))))
  10472. ;;; Dragging agenda lines forward/backward
  10473. (defun org-agenda-reapply-filters ()
  10474. "Re-apply all agenda filters."
  10475. (mapcar
  10476. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  10477. `((,org-agenda-tag-filter tag)
  10478. (,org-agenda-category-filter category)
  10479. (,org-agenda-regexp-filter regexp)
  10480. (,org-agenda-effort-filter effort)
  10481. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  10482. (,(get 'org-agenda-category-filter :preset-filter) category)
  10483. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  10484. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  10485. (defun org-agenda-drag-line-forward (arg &optional backward)
  10486. "Drag an agenda line forward by ARG lines.
  10487. When the optional argument `backward' is non-nil, move backward."
  10488. (interactive "p")
  10489. (let ((inhibit-read-only t) lst line)
  10490. (if (or (not (get-text-property (point) 'txt))
  10491. (save-excursion
  10492. (dotimes (_ arg)
  10493. (move-beginning-of-line (if backward 0 2))
  10494. (push (not (get-text-property (point) 'txt)) lst))
  10495. (delq nil lst)))
  10496. (message "Cannot move line forward")
  10497. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  10498. (move-beginning-of-line 1)
  10499. (setq line (buffer-substring (point) end))
  10500. (delete-region (point) end)
  10501. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  10502. (insert line)
  10503. (org-agenda-reapply-filters)
  10504. (org-agenda-mark-clocking-task)
  10505. (move-beginning-of-line 0)))))
  10506. (defun org-agenda-drag-line-backward (arg)
  10507. "Drag an agenda line backward by ARG lines."
  10508. (interactive "p")
  10509. (org-agenda-drag-line-forward arg t))
  10510. ;;; Flagging notes
  10511. (defun org-agenda-show-the-flagging-note ()
  10512. "Display the flagging note in the other window.
  10513. When called a second time in direct sequence, offer to remove the FLAGGING
  10514. tag and (if present) the flagging note."
  10515. (interactive)
  10516. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  10517. (win (selected-window))
  10518. note) ;; heading newhead
  10519. (unless hdmarker
  10520. (user-error "No linked entry at point"))
  10521. (if (and (eq this-command last-command)
  10522. (y-or-n-p "Unflag and remove any flagging note? "))
  10523. (progn
  10524. (org-agenda-remove-flag hdmarker)
  10525. (let ((win (get-buffer-window "*Flagging Note*")))
  10526. (and win (delete-window win)))
  10527. (message "Entry unflagged"))
  10528. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  10529. (unless note
  10530. (user-error "No flagging note"))
  10531. (org-kill-new note)
  10532. (org-switch-to-buffer-other-window "*Flagging Note*")
  10533. (erase-buffer)
  10534. (insert note)
  10535. (goto-char (point-min))
  10536. (while (re-search-forward "\\\\n" nil t)
  10537. (replace-match "\n" t t))
  10538. (goto-char (point-min))
  10539. (select-window win)
  10540. (message "%s" (substitute-command-keys "Flagging note pushed to \
  10541. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  10542. tag and note")))))
  10543. (defun org-agenda-remove-flag (marker)
  10544. "Remove the FLAGGED tag and any flagging note in the entry."
  10545. (let ((newhead
  10546. (org-with-point-at marker
  10547. (org-toggle-tag "FLAGGED" 'off)
  10548. (org-entry-delete nil "THEFLAGGINGNOTE")
  10549. (org-get-heading))))
  10550. (org-agenda-change-all-lines newhead marker)
  10551. (message "Entry unflagged")))
  10552. (defun org-agenda-get-any-marker (&optional pos)
  10553. (or (get-text-property (or pos (line-beginning-position)) 'org-hd-marker)
  10554. (get-text-property (or pos (line-beginning-position)) 'org-marker)))
  10555. ;;; Appointment reminders
  10556. (defvar appt-time-msg-list) ; defined in appt.el
  10557. ;;;###autoload
  10558. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  10559. "Activate appointments found in `org-agenda-files'.
  10560. With a `\\[universal-argument]' prefix, refresh the list of \
  10561. appointments.
  10562. If FILTER is t, interactively prompt the user for a regular
  10563. expression, and filter out entries that don't match it.
  10564. If FILTER is a string, use this string as a regular expression
  10565. for filtering entries out.
  10566. If FILTER is a function, filter out entries against which
  10567. calling the function returns nil. This function takes one
  10568. argument: an entry from `org-agenda-get-day-entries'.
  10569. FILTER can also be an alist with the car of each cell being
  10570. either `headline' or `category'. For example:
  10571. ((headline \"IMPORTANT\")
  10572. (category \"Work\"))
  10573. will only add headlines containing IMPORTANT or headlines
  10574. belonging to the \"Work\" category.
  10575. ARGS are symbols indicating what kind of entries to consider.
  10576. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  10577. \(i.e., deadlines and scheduled items with a hh:mm specification)
  10578. and :timestamp entries. See the docstring of `org-diary' for
  10579. details and examples.
  10580. If an entry has a APPT_WARNTIME property, its value will be used
  10581. to override `appt-message-warning-time'."
  10582. (interactive "P")
  10583. (when refresh (setq appt-time-msg-list nil))
  10584. (when (eq filter t)
  10585. (setq filter (read-from-minibuffer "Regexp filter: ")))
  10586. (let* ((cnt 0) ; count added events
  10587. (scope (or args '(:deadline* :scheduled* :timestamp)))
  10588. (org-agenda-new-buffers nil)
  10589. (org-deadline-warning-days 0)
  10590. ;; Do not use `org-today' here because appt only takes
  10591. ;; time and without date as argument, so it may pass wrong
  10592. ;; information otherwise
  10593. (today (org-date-to-gregorian
  10594. (time-to-days nil)))
  10595. (org-agenda-restrict nil)
  10596. (files (org-agenda-files 'unrestricted)) entries file
  10597. (org-agenda-buffer nil))
  10598. ;; Get all entries which may contain an appt
  10599. (org-agenda-prepare-buffers files)
  10600. (while (setq file (pop files))
  10601. (setq entries
  10602. (delq nil
  10603. (append entries
  10604. (apply #'org-agenda-get-day-entries
  10605. file today scope)))))
  10606. ;; Map through entries and find if we should filter them out
  10607. (mapc
  10608. (lambda (x)
  10609. (let* ((evt (org-trim
  10610. (replace-regexp-in-string
  10611. org-link-bracket-re "\\2"
  10612. (or (get-text-property 1 'txt x) ""))))
  10613. (cat (get-text-property (1- (length x)) 'org-category x))
  10614. (tod (get-text-property 1 'time-of-day x))
  10615. (ok (or (null filter)
  10616. (and (stringp filter) (string-match filter evt))
  10617. (and (functionp filter) (funcall filter x))
  10618. (and (listp filter)
  10619. (let ((cat-filter (cadr (assq 'category filter)))
  10620. (evt-filter (cadr (assq 'headline filter))))
  10621. (or (and (stringp cat-filter)
  10622. (string-match cat-filter cat))
  10623. (and (stringp evt-filter)
  10624. (string-match evt-filter evt)))))))
  10625. (wrn (get-text-property 1 'warntime x)))
  10626. ;; FIXME: Shall we remove text-properties for the appt text?
  10627. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  10628. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  10629. (setq tod (concat "00" (number-to-string tod)))
  10630. (setq tod (when (string-match
  10631. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  10632. (concat (match-string 1 tod) ":"
  10633. (match-string 2 tod))))
  10634. (when (appt-add tod evt wrn)
  10635. (setq cnt (1+ cnt))))))
  10636. entries)
  10637. (org-release-buffers org-agenda-new-buffers)
  10638. (if (eq cnt 0)
  10639. (message "No event to add")
  10640. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  10641. (defun org-agenda-today-p (date)
  10642. "Non-nil when DATE means today.
  10643. DATE is either a list of the form (month day year) or a number of
  10644. days as returned by `calendar-absolute-from-gregorian' or
  10645. `org-today'. This function considers `org-extend-today-until'
  10646. when defining today."
  10647. (eq (org-today)
  10648. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  10649. (defun org-agenda-todo-yesterday (&optional arg)
  10650. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  10651. (interactive "P")
  10652. (let* ((org-use-effective-time t)
  10653. (hour (nth 2 (decode-time (org-current-time))))
  10654. (org-extend-today-until (1+ hour)))
  10655. (org-agenda-todo arg)))
  10656. (defun org-agenda-ctrl-c-ctrl-c ()
  10657. "Set tags in agenda buffer."
  10658. (interactive)
  10659. (org-agenda-set-tags))
  10660. (provide 'org-agenda)
  10661. ;;; org-agenda.el ends here