org-agenda.el 419 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2021 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: 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 'cl-lib)
  42. (require 'ol)
  43. (require 'org)
  44. (require 'org-macs)
  45. (require 'org-refile)
  46. (declare-function diary-add-to-list "diary-lib"
  47. (date string specifier &optional marker globcolor literal))
  48. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  49. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  50. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  51. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  52. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  54. (declare-function calendar-french-date-string "cal-french" (&optional date))
  55. (declare-function calendar-goto-date "cal-move" (date))
  56. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  57. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  58. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  59. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  60. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  61. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  62. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  63. (declare-function calendar-check-holidays "holidays" (date))
  64. (declare-function org-columns-remove-overlays "org-colview" ())
  65. (declare-function org-datetree-find-date-create "org-datetree"
  66. (date &optional keep-restriction))
  67. (declare-function org-columns-quit "org-colview" ())
  68. (declare-function diary-date-display-form "diary-lib" (&optional type))
  69. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  70. (declare-function org-habit-insert-consistency-graphs
  71. "org-habit" (&optional line))
  72. (declare-function org-is-habit-p "org-habit" (&optional pom))
  73. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  74. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  75. (declare-function org-agenda-columns "org-colview" ())
  76. (declare-function org-add-archive-files "org-archive" (files))
  77. (declare-function org-capture "org-capture" (&optional goto keys))
  78. (declare-function org-clock-modify-effort-estimate "org-clock" (&optional value))
  79. (defvar calendar-mode-map)
  80. (defvar org-clock-current-task)
  81. (defvar org-current-tag-alist)
  82. (defvar org-mobile-force-id-on-agenda-items)
  83. (defvar org-habit-show-habits)
  84. (defvar org-habit-show-habits-only-for-today)
  85. (defvar org-habit-show-all-today)
  86. (defvar org-habit-scheduled-past-days)
  87. ;; Defined somewhere in this file, but used before definition.
  88. (defvar org-agenda-buffer-name "*Org Agenda*")
  89. (defvar org-agenda-overriding-header nil)
  90. (defvar org-agenda-title-append nil)
  91. ;; (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  92. ;; (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  93. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  94. (defvar org-agenda-undo-list nil
  95. "List of undoable operations in the agenda since last refresh.")
  96. (defvar org-agenda-pending-undo-list nil
  97. "In a series of undo commands, this is the list of remaining undo items.")
  98. (defcustom org-agenda-confirm-kill 1
  99. "When set, remote killing from the agenda buffer needs confirmation.
  100. When t, a confirmation is always needed. When a number N, confirmation is
  101. only needed when the text to be killed contains more than N non-white lines."
  102. :group 'org-agenda
  103. :type '(choice
  104. (const :tag "Never" nil)
  105. (const :tag "Always" t)
  106. (integer :tag "When more than N lines")))
  107. (defcustom org-agenda-compact-blocks nil
  108. "Non-nil means make the block agenda more compact.
  109. This is done globally by leaving out lines like the agenda span
  110. name and week number or the separator lines."
  111. :group 'org-agenda
  112. :type 'boolean)
  113. (defcustom org-agenda-block-separator ?=
  114. "The separator between blocks in the agenda.
  115. If this is a string, it will be used as the separator, with a newline added.
  116. If it is a character, it will be repeated to fill the window width.
  117. If nil the separator is disabled. In `org-agenda-custom-commands' this
  118. addresses the separator between the current and the previous block."
  119. :group 'org-agenda
  120. :type '(choice
  121. (const :tag "Disabled" nil)
  122. (character)
  123. (string)))
  124. (defgroup org-agenda-export nil
  125. "Options concerning exporting agenda views in Org mode."
  126. :tag "Org Agenda Export"
  127. :group 'org-agenda)
  128. (defcustom org-agenda-with-colors t
  129. "Non-nil means use colors in agenda views."
  130. :group 'org-agenda-export
  131. :type 'boolean)
  132. (defcustom org-agenda-exporter-settings nil
  133. ;; FIXME: Do we really want to evaluate those settings and thus force
  134. ;; the user to use `quote' all the time?
  135. "Alist of variable/value pairs that should be active during agenda export.
  136. This is a good place to set options for ps-print and for htmlize.
  137. Note that the way this is implemented, the values will be evaluated
  138. before assigned to the variables. So make sure to quote values you do
  139. *not* want evaluated, for example
  140. (setq org-agenda-exporter-settings
  141. \\='((ps-print-color-p \\='black-white)))"
  142. :group 'org-agenda-export
  143. :type '(repeat
  144. (list
  145. (variable)
  146. (sexp :tag "Value"))))
  147. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  148. "Hook run in a temporary buffer before writing the agenda to an export file.
  149. A useful function for this hook is `org-agenda-add-entry-text'."
  150. :group 'org-agenda-export
  151. :type 'hook
  152. :options '(org-agenda-add-entry-text))
  153. (defcustom org-agenda-add-entry-text-maxlines 0
  154. "Maximum number of entry text lines to be added to agenda.
  155. This is only relevant when `org-agenda-add-entry-text' is part of
  156. `org-agenda-before-write-hook', which is the default.
  157. When this is 0, nothing will happen. When it is greater than 0, it
  158. specifies the maximum number of lines that will be added for each entry
  159. that is listed in the agenda view.
  160. Note that this variable is not used during display, only when exporting
  161. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  162. and `org-agenda-entry-text-maxlines'."
  163. :group 'org-agenda
  164. :type 'integer)
  165. (defcustom org-agenda-add-entry-text-descriptive-links t
  166. "Non-nil means export org-links as descriptive links in agenda added text.
  167. This variable applies to the text added to the agenda when
  168. `org-agenda-add-entry-text-maxlines' is larger than 0.
  169. When this variable is nil, the URL will (also) be shown."
  170. :group 'org-agenda
  171. :type 'boolean)
  172. (defcustom org-agenda-export-html-style nil
  173. "The style specification for exported HTML Agenda files.
  174. If this variable contains a string, it will replace the default <style>
  175. section as produced by `htmlize'.
  176. Since there are different ways of setting style information, this variable
  177. needs to contain the full HTML structure to provide a style, including the
  178. surrounding HTML tags. The style specifications should include definitions
  179. the fonts used by the agenda, here is an example:
  180. <style type=\"text/css\">
  181. p { font-weight: normal; color: gray; }
  182. .org-agenda-structure {
  183. font-size: 110%;
  184. color: #003399;
  185. font-weight: 600;
  186. }
  187. .org-todo {
  188. color: #cc6666;
  189. font-weight: bold;
  190. }
  191. .org-agenda-done {
  192. color: #339933;
  193. }
  194. .org-done {
  195. color: #339933;
  196. }
  197. .title { text-align: center; }
  198. .todo, .deadline { color: red; }
  199. .done { color: green; }
  200. </style>
  201. or, if you want to keep the style in a file,
  202. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  203. As the value of this option simply gets inserted into the HTML <head> header,
  204. you can \"misuse\" it to also add other text to the header."
  205. :group 'org-agenda-export
  206. :group 'org-export-html
  207. :type '(choice
  208. (const nil)
  209. (string)))
  210. (defcustom org-agenda-persistent-filter nil
  211. "When set, keep filters from one agenda view to the next."
  212. :group 'org-agenda
  213. :type 'boolean)
  214. (defgroup org-agenda-custom-commands nil
  215. "Options concerning agenda views in Org mode."
  216. :tag "Org Agenda Custom Commands"
  217. :group 'org-agenda)
  218. (defconst org-sorting-choice
  219. '(choice
  220. (const time-up) (const time-down)
  221. (const timestamp-up) (const timestamp-down)
  222. (const scheduled-up) (const scheduled-down)
  223. (const deadline-up) (const deadline-down)
  224. (const ts-up) (const ts-down)
  225. (const tsia-up) (const tsia-down)
  226. (const category-keep) (const category-up) (const category-down)
  227. (const tag-down) (const tag-up)
  228. (const priority-up) (const priority-down)
  229. (const todo-state-up) (const todo-state-down)
  230. (const effort-up) (const effort-down)
  231. (const habit-up) (const habit-down)
  232. (const alpha-up) (const alpha-down)
  233. (const user-defined-up) (const user-defined-down))
  234. "Sorting choices.")
  235. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  236. ;; the new variable `org-agenda-tag-filter-preset'.
  237. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  238. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  239. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  240. "List of types searched for when creating the daily/weekly agenda.
  241. This variable is a list of symbols that controls the types of
  242. items that appear in the daily/weekly agenda. Allowed symbols in this
  243. list are
  244. :timestamp List items containing a date stamp or date range matching
  245. the selected date. This includes sexp entries in angular
  246. brackets.
  247. :sexp List entries resulting from plain diary-like sexps.
  248. :deadline List deadline due on that date. When the date is today,
  249. also list any deadlines past due, or due within
  250. `org-deadline-warning-days'.
  251. :deadline* Same as above, but only include the deadline if it has an
  252. hour specification as [h]h:mm.
  253. :scheduled List all items which are scheduled for the given date.
  254. The diary for *today* also contains items which were
  255. scheduled earlier and are not yet marked DONE.
  256. :scheduled* Same as above, but only include the scheduled item if it
  257. has an hour specification as [h]h:mm.
  258. By default, all four non-starred types are turned on.
  259. When :scheduled* or :deadline* are included, :schedule or :deadline
  260. will be ignored.
  261. Never set this variable globally using `setq', because then it
  262. will apply to all future agenda commands. Instead, bind it with
  263. `let' to scope it dynamically into the agenda-constructing
  264. command. A good way to set it is through options in
  265. `org-agenda-custom-commands'. For a more flexible (though
  266. somewhat less efficient) way of determining what is included in
  267. the daily/weekly agenda, see `org-agenda-skip-function'.")
  268. (defconst org-agenda-custom-commands-local-options
  269. `(repeat :tag "Local settings for this command. Remember to quote values"
  270. (choice :tag "Setting"
  271. (list :tag "Heading for this block"
  272. (const org-agenda-overriding-header)
  273. (string :tag "Headline"))
  274. (list :tag "Files to be searched"
  275. (const org-agenda-files)
  276. (list
  277. (const :format "" quote)
  278. (repeat (file))))
  279. (list :tag "Sorting strategy"
  280. (const org-agenda-sorting-strategy)
  281. (list
  282. (const :format "" quote)
  283. (repeat
  284. ,org-sorting-choice)))
  285. (list :tag "Prefix format"
  286. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  287. (string))
  288. (list :tag "Number of days in agenda"
  289. (const org-agenda-span)
  290. (list
  291. (const :format "" quote)
  292. (choice (const :tag "Day" day)
  293. (const :tag "Week" week)
  294. (const :tag "Fortnight" fortnight)
  295. (const :tag "Month" month)
  296. (const :tag "Year" year)
  297. (integer :tag "Custom"))))
  298. (list :tag "Fixed starting date"
  299. (const org-agenda-start-day)
  300. (string :value "2007-11-01"))
  301. (list :tag "Start on day of week"
  302. (const org-agenda-start-on-weekday)
  303. (choice :value 1
  304. (const :tag "Today" nil)
  305. (integer :tag "Weekday No.")))
  306. (list :tag "Include data from diary"
  307. (const org-agenda-include-diary)
  308. (boolean))
  309. (list :tag "Deadline Warning days"
  310. (const org-deadline-warning-days)
  311. (integer :value 1))
  312. (list :tag "Category filter preset"
  313. (const org-agenda-category-filter-preset)
  314. (list
  315. (const :format "" quote)
  316. (repeat
  317. (string :tag "+category or -category"))))
  318. (list :tag "Tags filter preset"
  319. (const org-agenda-tag-filter-preset)
  320. (list
  321. (const :format "" quote)
  322. (repeat
  323. (string :tag "+tag or -tag"))))
  324. (list :tag "Effort filter preset"
  325. (const org-agenda-effort-filter-preset)
  326. (list
  327. (const :format "" quote)
  328. (repeat
  329. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  330. (list :tag "Regexp filter preset"
  331. (const org-agenda-regexp-filter-preset)
  332. (list
  333. (const :format "" quote)
  334. (repeat
  335. (string :tag "+regexp or -regexp"))))
  336. (list :tag "Set daily/weekly entry types"
  337. (const org-agenda-entry-types)
  338. (list
  339. (const :format "" quote)
  340. (set :greedy t :value ,org-agenda-entry-types
  341. (const :deadline)
  342. (const :scheduled)
  343. (const :deadline*)
  344. (const :scheduled*)
  345. (const :timestamp)
  346. (const :sexp))))
  347. (list :tag "Columns format"
  348. (const org-overriding-columns-format)
  349. (string :tag "Format"))
  350. (list :tag "Standard skipping condition"
  351. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  352. (const org-agenda-skip-function)
  353. (list
  354. (const :format "" quote)
  355. (list
  356. (choice
  357. :tag "Skipping range"
  358. (const :tag "Skip entry" org-agenda-skip-entry-if)
  359. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  360. (repeat :inline t :tag "Conditions for skipping"
  361. (choice
  362. :tag "Condition type"
  363. (list :tag "Regexp matches" :inline t
  364. (const :format "" regexp)
  365. (regexp))
  366. (list :tag "Regexp does not match" :inline t
  367. (const :format "" notregexp)
  368. (regexp))
  369. (list :tag "TODO state is" :inline t
  370. (const todo)
  371. (choice
  372. (const :tag "Any not-done state" todo)
  373. (const :tag "Any done state" done)
  374. (const :tag "Any state" any)
  375. (list :tag "Keyword list"
  376. (const :format "" quote)
  377. (repeat (string :tag "Keyword")))))
  378. (list :tag "TODO state is not" :inline t
  379. (const nottodo)
  380. (choice
  381. (const :tag "Any not-done state" todo)
  382. (const :tag "Any done state" done)
  383. (const :tag "Any state" any)
  384. (list :tag "Keyword list"
  385. (const :format "" quote)
  386. (repeat (string :tag "Keyword")))))
  387. (const :tag "scheduled" scheduled)
  388. (const :tag "not scheduled" notscheduled)
  389. (const :tag "deadline" deadline)
  390. (const :tag "no deadline" notdeadline)
  391. (const :tag "timestamp" timestamp)
  392. (const :tag "no timestamp" nottimestamp))))))
  393. (list :tag "Non-standard skipping condition"
  394. :value (org-agenda-skip-function)
  395. (const org-agenda-skip-function)
  396. (sexp :tag "Function or form (quoted!)"))
  397. (list :tag "Any variable"
  398. (variable :tag "Variable")
  399. (sexp :tag "Value (sexp)"))))
  400. "Selection of examples for agenda command settings.
  401. This will be spliced into the custom type of
  402. `org-agenda-custom-commands'.")
  403. (defcustom org-agenda-custom-commands
  404. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  405. "Custom commands for the agenda.
  406. \\<org-mode-map>
  407. These commands will be offered on the splash screen displayed by the
  408. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  409. (key desc type match settings files)
  410. key The key (one or more characters as a string) to be associated
  411. with the command.
  412. desc A description of the command, when omitted or nil, a default
  413. description is built using MATCH.
  414. type The command type, any of the following symbols:
  415. agenda The daily/weekly agenda.
  416. todo Entries with a specific TODO keyword, in all agenda files.
  417. search Entries containing search words entry or headline.
  418. tags Tags/Property/TODO match in all agenda files.
  419. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  420. todo-tree Sparse tree of specific TODO keyword in *current* file.
  421. tags-tree Sparse tree with all tags matches in *current* file.
  422. occur-tree Occur sparse tree for *current* file.
  423. ... A user-defined function.
  424. match What to search for:
  425. - a single keyword for TODO keyword searches
  426. - a tags/property/todo match expression for searches
  427. - a word search expression for text searches.
  428. - a regular expression for occur searches
  429. For all other commands, this should be the empty string.
  430. settings A list of option settings, similar to that in a let form, so like
  431. this: ((opt1 val1) (opt2 val2) ...). The values will be
  432. evaluated at the moment of execution, so quote them when needed.
  433. files A list of files to write the produced agenda buffer to with
  434. the command `org-store-agenda-views'.
  435. If a file name ends in \".html\", an HTML version of the buffer
  436. is written out. If it ends in \".ps\", a postscript version is
  437. produced. Otherwise, only the plain text is written to the file.
  438. You can also define a set of commands, to create a composite agenda buffer.
  439. In this case, an entry looks like this:
  440. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  441. where
  442. desc A description string to be displayed in the dispatcher menu.
  443. cmd An agenda command, similar to the above. However, tree commands
  444. are not allowed, but instead you can get agenda and global todo list.
  445. So valid commands for a set are:
  446. (agenda \"\" settings)
  447. (alltodo \"\" settings)
  448. (stuck \"\" settings)
  449. (todo \"match\" settings files)
  450. (search \"match\" settings files)
  451. (tags \"match\" settings files)
  452. (tags-todo \"match\" settings files)
  453. Each command can carry a list of options, and another set of options can be
  454. given for the whole set of commands. Individual command options take
  455. precedence over the general options.
  456. When using several characters as key to a command, the first characters
  457. are prefix commands. For the dispatcher to display useful information, you
  458. should provide a description for the prefix, like
  459. (setq org-agenda-custom-commands
  460. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  461. (\"hl\" tags \"+HOME+Lisa\")
  462. (\"hp\" tags \"+HOME+Peter\")
  463. (\"hk\" tags \"+HOME+Kim\")))"
  464. :group 'org-agenda-custom-commands
  465. :type `(repeat
  466. (choice :value ("x" "Describe command here" tags "" nil)
  467. (list :tag "Single command"
  468. (string :tag "Access Key(s) ")
  469. (option (string :tag "Description"))
  470. (choice
  471. (const :tag "Agenda" agenda)
  472. (const :tag "TODO list" alltodo)
  473. (const :tag "Search words" search)
  474. (const :tag "Stuck projects" stuck)
  475. (const :tag "Tags/Property match (all agenda files)" tags)
  476. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  477. (const :tag "TODO keyword search (all agenda files)" todo)
  478. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  479. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  480. (const :tag "Occur tree (current buffer)" occur-tree)
  481. (sexp :tag "Other, user-defined function"))
  482. (string :tag "Match (only for some commands)")
  483. ,org-agenda-custom-commands-local-options
  484. (option (repeat :tag "Export" (file :tag "Export to"))))
  485. (list :tag "Command series, all agenda files"
  486. (string :tag "Access Key(s)")
  487. (string :tag "Description ")
  488. (repeat :tag "Component"
  489. (choice
  490. (list :tag "Agenda"
  491. (const :format "" agenda)
  492. (const :tag "" :format "" "")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "TODO list (all keywords)"
  495. (const :format "" alltodo)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Search words"
  499. (const :format "" search)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Stuck projects"
  503. (const :format "" stuck)
  504. (const :tag "" :format "" "")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "Tags/Property match (all agenda files)"
  507. (const :format "" tags)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  511. (const :format "" tags-todo)
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)
  514. (list :tag "TODO keyword search"
  515. (const :format "" todo)
  516. (string :tag "Match")
  517. ,org-agenda-custom-commands-local-options)
  518. (list :tag "Other, user-defined function"
  519. (symbol :tag "function")
  520. (string :tag "Match")
  521. ,org-agenda-custom-commands-local-options)))
  522. (repeat :tag "Settings for entire command set"
  523. (list (variable :tag "Any variable")
  524. (sexp :tag "Value")))
  525. (option (repeat :tag "Export" (file :tag "Export to"))))
  526. (cons :tag "Prefix key documentation"
  527. (string :tag "Access Key(s)")
  528. (string :tag "Description ")))))
  529. (defcustom org-agenda-query-register ?o
  530. "The register holding the current query string.
  531. The purpose of this is that if you construct a query string interactively,
  532. you can then use it to define a custom command."
  533. :group 'org-agenda-custom-commands
  534. :type 'character)
  535. (defcustom org-stuck-projects
  536. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  537. "How to identify stuck projects.
  538. This is a list of four items:
  539. 1. A tags/todo/property matcher string that is used to identify a project.
  540. See the manual for a description of tag and property searches.
  541. The entire tree below a headline matched by this is considered one project.
  542. 2. A list of TODO keywords identifying non-stuck projects.
  543. If the project subtree contains any headline with one of these todo
  544. keywords, the project is considered to be not stuck. If you specify
  545. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  546. 3. A list of tags identifying non-stuck projects.
  547. If the project subtree contains any headline with one of these tags,
  548. the project is considered to be not stuck. If you specify \"*\" as
  549. a tag, any tag will mark the project unstuck. Note that this is about
  550. the explicit presence of a tag somewhere in the subtree, inherited
  551. tags do not count here. If inherited tags make a project not stuck,
  552. use \"-TAG\" in the tags part of the matcher under (1.) above.
  553. 4. An arbitrary regular expression matching non-stuck projects.
  554. If the project turns out to be not stuck, search continues also in the
  555. subtree to see if any of the subtasks have project status.
  556. See also the variable `org-tags-match-list-sublevels' which applies
  557. to projects matched by this search as well.
  558. After defining this variable, you may use `org-agenda-list-stuck-projects'
  559. \(bound to `\\[org-agenda] #') to produce the list."
  560. :group 'org-agenda-custom-commands
  561. :type '(list
  562. (string :tag "Tags/TODO match to identify a project")
  563. (repeat :tag "Projects are *not* stuck if they have an entry with \
  564. TODO keyword any of" (string))
  565. (repeat :tag "Projects are *not* stuck if they have an entry with \
  566. TAG being any of" (string))
  567. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  568. the subtree")))
  569. (defgroup org-agenda-skip nil
  570. "Options concerning skipping parts of agenda files."
  571. :tag "Org Agenda Skip"
  572. :group 'org-agenda)
  573. (defcustom org-agenda-skip-function-global nil
  574. "Function to be called at each match during agenda construction.
  575. If this function returns nil, the current match should not be skipped.
  576. If the function decided to skip an agenda match, is must return the
  577. buffer position from which the search should be continued.
  578. This may also be a Lisp form, which will be evaluated.
  579. This variable will be applied to every agenda match, including
  580. tags/property searches and TODO lists. So try to make the test function
  581. do its checking as efficiently as possible. To implement a skipping
  582. condition just for specific agenda commands, use the variable
  583. `org-agenda-skip-function' which can be set in the options section
  584. of custom agenda commands."
  585. :group 'org-agenda-skip
  586. :type 'sexp)
  587. (defgroup org-agenda-daily/weekly nil
  588. "Options concerning the daily/weekly agenda."
  589. :tag "Org Agenda Daily/Weekly"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-todo-list nil
  592. "Options concerning the global todo list agenda view."
  593. :tag "Org Agenda Todo List"
  594. :group 'org-agenda)
  595. (defgroup org-agenda-match-view nil
  596. "Options concerning the general tags/property/todo match agenda view."
  597. :tag "Org Agenda Match View"
  598. :group 'org-agenda)
  599. (defgroup org-agenda-search-view nil
  600. "Options concerning the search agenda view."
  601. :tag "Org Agenda Search View"
  602. :group 'org-agenda)
  603. (defvar org-agenda-archives-mode nil
  604. "Non-nil means the agenda will include archived items.
  605. If this is the symbol `trees', trees in the selected agenda scope
  606. that are marked with the ARCHIVE tag will be included anyway. When this is
  607. t, also all archive files associated with the current selection of agenda
  608. files will be included.")
  609. (defcustom org-agenda-restriction-lock-highlight-subtree t
  610. "Non-nil means highlight the whole subtree when restriction is active.
  611. Otherwise only highlight the headline. Highlighting the whole subtree is
  612. useful to ensure no edits happen beyond the restricted region."
  613. :group 'org-agenda
  614. :type 'boolean)
  615. (defcustom org-agenda-skip-comment-trees t
  616. "Non-nil means skip trees that start with the COMMENT keyword.
  617. When nil, these trees are also scanned by agenda commands."
  618. :group 'org-agenda-skip
  619. :type 'boolean)
  620. (defcustom org-agenda-todo-list-sublevels t
  621. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  622. When nil, the sublevels of a TODO entry are not checked, resulting in
  623. potentially much shorter TODO lists."
  624. :group 'org-agenda-skip
  625. :group 'org-agenda-todo-list
  626. :type 'boolean)
  627. (defcustom org-agenda-todo-ignore-with-date nil
  628. "Non-nil means don't show entries with a date in the global todo list.
  629. You can use this if you prefer to mark mere appointments with a TODO keyword,
  630. but don't want them to show up in the TODO list.
  631. When this is set, it also covers deadlines and scheduled items, the settings
  632. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  633. will be ignored.
  634. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  635. :group 'org-agenda-skip
  636. :group 'org-agenda-todo-list
  637. :type 'boolean)
  638. (defcustom org-agenda-todo-ignore-timestamp nil
  639. "Non-nil means don't show entries with a timestamp.
  640. This applies when creating the global todo list.
  641. Valid values are:
  642. past Don't show entries for today or in the past.
  643. future Don't show entries with a timestamp in the future.
  644. The idea behind this is that if it has a future
  645. timestamp, you don't want to think about it until the
  646. date.
  647. all Don't show any entries with a timestamp in the global todo list.
  648. The idea behind this is that by setting a timestamp, you
  649. have already \"taken care\" of this item.
  650. This variable can also have an integer as a value. If positive (N),
  651. todos with a timestamp N or more days in the future will be ignored. If
  652. negative (-N), todos with a timestamp N or more days in the past will be
  653. ignored. If 0, todos with a timestamp either today or in the future will
  654. be ignored. For example, a value of -1 will exclude todos with a
  655. timestamp in the past (yesterday or earlier), while a value of 7 will
  656. exclude todos with a timestamp a week or more in the future.
  657. See also `org-agenda-todo-ignore-with-date'.
  658. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  659. to make his option also apply to the tags-todo list."
  660. :group 'org-agenda-skip
  661. :group 'org-agenda-todo-list
  662. :version "24.1"
  663. :type '(choice
  664. (const :tag "Ignore future timestamp todos" future)
  665. (const :tag "Ignore past or present timestamp todos" past)
  666. (const :tag "Ignore all timestamp todos" all)
  667. (const :tag "Show timestamp todos" nil)
  668. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  669. (defcustom org-agenda-todo-ignore-scheduled nil
  670. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  671. This applies when creating the global todo list.
  672. Valid values are:
  673. past Don't show entries scheduled today or in the past.
  674. future Don't show entries scheduled in the future.
  675. The idea behind this is that by scheduling it, you don't want to
  676. think about it until the scheduled date.
  677. all Don't show any scheduled entries in the global todo list.
  678. The idea behind this is that by scheduling it, you have already
  679. \"taken care\" of this item.
  680. t Same as `all', for backward compatibility.
  681. This variable can also have an integer as a value. See
  682. `org-agenda-todo-ignore-timestamp' for more details.
  683. See also `org-agenda-todo-ignore-with-date'.
  684. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  685. to make his option also apply to the tags-todo list."
  686. :group 'org-agenda-skip
  687. :group 'org-agenda-todo-list
  688. :type '(choice
  689. (const :tag "Ignore future-scheduled todos" future)
  690. (const :tag "Ignore past- or present-scheduled todos" past)
  691. (const :tag "Ignore all scheduled todos" all)
  692. (const :tag "Ignore all scheduled todos (compatibility)" t)
  693. (const :tag "Show scheduled todos" nil)
  694. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  695. (defcustom org-agenda-todo-ignore-deadlines nil
  696. "Non-nil means ignore some deadline TODO items when making TODO list.
  697. There are different motivations for using different values, please think
  698. carefully when configuring this variable.
  699. This applies when creating the global TODO list.
  700. Valid values are:
  701. near Don't show near deadline entries. A deadline is near when it is
  702. closer than `org-deadline-warning-days' days. The idea behind this
  703. is that such items will appear in the agenda anyway.
  704. far Don't show TODO entries where a deadline has been defined, but
  705. is not going to happen anytime soon. This is useful if you want to use
  706. the TODO list to figure out what to do now.
  707. past Don't show entries with a deadline timestamp for today or in the past.
  708. future Don't show entries with a deadline timestamp in the future, not even
  709. when they become `near' ones. Use it with caution.
  710. all Ignore all TODO entries that do have a deadline.
  711. t Same as `near', for backward compatibility.
  712. This variable can also have an integer as a value. See
  713. `org-agenda-todo-ignore-timestamp' for more details.
  714. See also `org-agenda-todo-ignore-with-date'.
  715. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  716. to make his option also apply to the tags-todo list."
  717. :group 'org-agenda-skip
  718. :group 'org-agenda-todo-list
  719. :type '(choice
  720. (const :tag "Ignore near deadlines" near)
  721. (const :tag "Ignore near deadlines (compatibility)" t)
  722. (const :tag "Ignore far deadlines" far)
  723. (const :tag "Ignore all TODOs with a deadlines" all)
  724. (const :tag "Show all TODOs, even if they have a deadline" nil)
  725. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  726. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  727. "Time unit to use when possibly ignoring an agenda item.
  728. See the docstring of various `org-agenda-todo-ignore-*' options.
  729. The default is to compare time stamps using days. An item is thus
  730. considered to be in the future if it is at least one day after today.
  731. Non-nil means to compare time stamps using seconds. An item is then
  732. considered future if it has a time value later than current time."
  733. :group 'org-agenda-skip
  734. :group 'org-agenda-todo-list
  735. :version "24.4"
  736. :package-version '(Org . "8.0")
  737. :type '(choice
  738. (const :tag "Compare time with days" nil)
  739. (const :tag "Compare time with seconds" t)))
  740. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  741. "Non-nil means honor todo-list ignores options also in tags-todo search.
  742. The variables
  743. `org-agenda-todo-ignore-with-date',
  744. `org-agenda-todo-ignore-timestamp',
  745. `org-agenda-todo-ignore-scheduled',
  746. `org-agenda-todo-ignore-deadlines'
  747. make the global TODO list skip entries that have time stamps of certain
  748. kinds. If this option is set, the same options will also apply for the
  749. tags-todo search, which is the general tags/property matcher
  750. restricted to unfinished TODO entries only."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-todo-list
  753. :group 'org-agenda-match-view
  754. :type 'boolean)
  755. (defcustom org-agenda-skip-scheduled-if-done nil
  756. "Non-nil means don't show scheduled items in agenda when they are done.
  757. This is relevant for the daily/weekly agenda, not for the TODO list. It
  758. applies only to the actual date of the scheduling. Warnings about an item
  759. with a past scheduling dates are always turned off when the item is DONE."
  760. :group 'org-agenda-skip
  761. :group 'org-agenda-daily/weekly
  762. :type 'boolean)
  763. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  764. "Non-nil means skip scheduling line if same entry shows because of deadline.
  765. In the agenda of today, an entry can show up multiple times
  766. because it is both scheduled and has a nearby deadline, and maybe
  767. a plain time stamp as well.
  768. When this variable is nil, the entry will be shown several times.
  769. When set to t, then only the deadline is shown and the fact that
  770. the entry is scheduled today or was scheduled previously is not
  771. shown.
  772. When set to the symbol `not-today', skip scheduled previously,
  773. but not scheduled today.
  774. When set to the symbol `repeated-after-deadline', skip scheduled
  775. items if they are repeated beyond the current deadline."
  776. :group 'org-agenda-skip
  777. :group 'org-agenda-daily/weekly
  778. :type '(choice
  779. (const :tag "Never" nil)
  780. (const :tag "Always" t)
  781. (const :tag "Not when scheduled today" not-today)
  782. (const :tag "When repeated past deadline" repeated-after-deadline)))
  783. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  784. "Non-nil means skip timestamp line if same entry shows because of deadline.
  785. In the agenda of today, an entry can show up multiple times
  786. because it has both a plain timestamp and has a nearby deadline.
  787. When this variable is t, then only the deadline is shown and the
  788. fact that the entry has a timestamp for or including today is not
  789. shown. When this variable is nil, the entry will be shown
  790. several times."
  791. :group 'org-agenda-skip
  792. :group 'org-agenda-daily/weekly
  793. :version "24.1"
  794. :type '(choice
  795. (const :tag "Never" nil)
  796. (const :tag "Always" t)))
  797. (defcustom org-agenda-skip-deadline-if-done nil
  798. "Non-nil means don't show deadlines when the corresponding item is done.
  799. When nil, the deadline is still shown and should give you a happy feeling.
  800. This is relevant for the daily/weekly agenda. It applies only to the
  801. actual date of the deadline. Warnings about approaching and past-due
  802. deadlines are always turned off when the item is DONE."
  803. :group 'org-agenda-skip
  804. :group 'org-agenda-daily/weekly
  805. :type 'boolean)
  806. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  807. "Non-nil means skip deadline prewarning when entry is also scheduled.
  808. This will apply on all days where a prewarning for the deadline would
  809. be shown, but not at the day when the entry is actually due. On that day,
  810. the deadline will be shown anyway.
  811. This variable may be set to nil, t, the symbol `pre-scheduled',
  812. or a number which will then give the number of days before the actual
  813. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  814. eliminates the deadline prewarning only prior to the scheduled date.
  815. This can be used in a workflow where the first showing of the deadline will
  816. trigger you to schedule it, and then you don't want to be reminded of it
  817. because you will take care of it on the day when scheduled."
  818. :group 'org-agenda-skip
  819. :group 'org-agenda-daily/weekly
  820. :version "24.1"
  821. :type '(choice
  822. (const :tag "Always show prewarning" nil)
  823. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  824. (const :tag "Remove prewarning if entry is scheduled" t)
  825. (integer :tag "Restart prewarning N days before deadline")))
  826. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  827. "Non-nil means skip scheduled delay when entry also has a deadline.
  828. This variable may be set to nil, t, the symbol `post-deadline',
  829. or a number which will then give the number of days after the actual
  830. scheduled date when the delay should expire. The symbol `post-deadline'
  831. eliminates the schedule delay when the date is posterior to the deadline."
  832. :group 'org-agenda-skip
  833. :group 'org-agenda-daily/weekly
  834. :version "24.4"
  835. :package-version '(Org . "8.0")
  836. :type '(choice
  837. (const :tag "Always honor delay" nil)
  838. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  839. (const :tag "Ignore delay if entry has a deadline" t)
  840. (integer :tag "Honor delay up until N days after the scheduled date")))
  841. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  842. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  843. When non-nil, after the search for timestamps has matched once in an
  844. entry, the rest of the entry will not be searched."
  845. :group 'org-agenda-skip
  846. :type 'boolean)
  847. (defcustom org-agenda-skip-timestamp-if-done nil
  848. "Non-nil means don't select item by timestamp or -range if it is DONE."
  849. :group 'org-agenda-skip
  850. :group 'org-agenda-daily/weekly
  851. :type 'boolean)
  852. (defcustom org-agenda-dim-blocked-tasks t
  853. "Non-nil means dim blocked tasks in the agenda display.
  854. This causes some overhead during agenda construction, but if you
  855. have turned on `org-enforce-todo-dependencies',
  856. `org-enforce-todo-checkbox-dependencies', or any other blocking
  857. mechanism, this will create useful feedback in the agenda.
  858. Instead of t, this variable can also have the value `invisible'.
  859. Then blocked tasks will be invisible and only become visible when
  860. they become unblocked. An exemption to this behavior is when a task is
  861. blocked because of unchecked checkboxes below it. Since checkboxes do
  862. not show up in the agenda views, making this task invisible you remove any
  863. trace from agenda views that there is something to do. Therefore, a task
  864. that is blocked because of checkboxes will never be made invisible, it
  865. will only be dimmed."
  866. :group 'org-agenda-daily/weekly
  867. :group 'org-agenda-todo-list
  868. :version "24.3"
  869. :type '(choice
  870. (const :tag "Do not dim" nil)
  871. (const :tag "Dim to a gray face" t)
  872. (const :tag "Make invisible" invisible)))
  873. (defgroup org-agenda-startup nil
  874. "Options concerning initial settings in the Agenda in Org Mode."
  875. :tag "Org Agenda Startup"
  876. :group 'org-agenda)
  877. (defcustom org-agenda-menu-show-matcher t
  878. "Non-nil means show the match string in the agenda dispatcher menu.
  879. When nil, the matcher string is not shown, but is put into the help-echo
  880. property so than moving the mouse over the command shows it.
  881. Setting it to nil is good if matcher strings are very long and/or if
  882. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  883. :group 'org-agenda
  884. :version "24.1"
  885. :type 'boolean)
  886. (defcustom org-agenda-menu-two-columns nil
  887. "Non-nil means, use two columns to show custom commands in the dispatcher.
  888. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  889. to nil."
  890. :group 'org-agenda
  891. :version "24.1"
  892. :type 'boolean)
  893. (defcustom org-agenda-finalize-hook nil
  894. "Hook run just before displaying an agenda buffer.
  895. The buffer is still writable when the hook is called.
  896. You can modify some of the buffer substrings but you should be
  897. extra careful not to modify the text properties of the agenda
  898. headlines as the agenda display heavily relies on them."
  899. :group 'org-agenda-startup
  900. :type 'hook)
  901. (defcustom org-agenda-filter-hook nil
  902. "Hook run just after filtering with `org-agenda-filter'."
  903. :group 'org-agenda-startup
  904. :package-version '(Org . "9.4")
  905. :type 'hook)
  906. (defcustom org-agenda-mouse-1-follows-link nil
  907. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  908. A longer mouse click will still set point. Needs to be set
  909. before org.el is loaded."
  910. :group 'org-agenda-startup
  911. :type 'boolean)
  912. (defcustom org-agenda-start-with-follow-mode nil
  913. "The initial value of follow mode in a newly created agenda window."
  914. :group 'org-agenda-startup
  915. :type 'boolean)
  916. (defcustom org-agenda-follow-indirect nil
  917. "Non-nil means `org-agenda-follow-mode' displays only the
  918. current item's tree, in an indirect buffer."
  919. :group 'org-agenda
  920. :version "24.1"
  921. :type 'boolean)
  922. (defcustom org-agenda-show-outline-path t
  923. "Non-nil means show outline path in echo area after line motion."
  924. :group 'org-agenda-startup
  925. :type 'boolean)
  926. (defcustom org-agenda-start-with-entry-text-mode nil
  927. "The initial value of entry-text-mode in a newly created agenda window."
  928. :group 'org-agenda-startup
  929. :type 'boolean)
  930. (defcustom org-agenda-entry-text-maxlines 5
  931. "Number of text lines to be added when `E' is pressed in the agenda.
  932. Note that this variable only used during agenda display. To add entry text
  933. when exporting the agenda, configure the variable
  934. `org-agenda-add-entry-text-maxlines'."
  935. :group 'org-agenda
  936. :type 'integer)
  937. (defcustom org-agenda-entry-text-exclude-regexps nil
  938. "List of regular expressions to clean up entry text.
  939. The complete matches of all regular expressions in this list will be
  940. removed from entry text before it is shown in the agenda."
  941. :group 'org-agenda
  942. :type '(repeat (regexp)))
  943. (defcustom org-agenda-entry-text-leaders " > "
  944. "Text prepended to the entry text in agenda buffers."
  945. :version "24.4"
  946. :package-version '(Org . "8.0")
  947. :group 'org-agenda
  948. :type 'string)
  949. (defvar org-agenda-entry-text-cleanup-hook nil
  950. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  951. This cleanup is done in a temporary buffer, so the function may inspect and
  952. change the entire buffer.
  953. Some default stuff like drawers and scheduling/deadline dates will already
  954. have been removed when this is called, as will any matches for regular
  955. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  956. (defvar org-agenda-include-inactive-timestamps nil
  957. "Non-nil means include inactive time stamps in agenda.
  958. Dynamically scoped.")
  959. (defgroup org-agenda-windows nil
  960. "Options concerning the windows used by the Agenda in Org Mode."
  961. :tag "Org Agenda Windows"
  962. :group 'org-agenda)
  963. (defcustom org-agenda-window-setup 'reorganize-frame
  964. "How the agenda buffer should be displayed.
  965. Possible values for this option are:
  966. current-window Show agenda in the current window, keeping all other windows.
  967. other-window Use `switch-to-buffer-other-window' to display agenda.
  968. only-window Show agenda, deleting all other windows.
  969. reorganize-frame Show only two windows on the current frame, the current
  970. window and the agenda.
  971. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  972. Also, when exiting the agenda, kill that frame.
  973. other-tab Use `switch-to-buffer-other-tab' to display the
  974. agenda, making use of the `tab-bar-mode' introduced
  975. in Emacs version 27.1. Also, kill that tab when
  976. exiting the agenda view.
  977. See also the variable `org-agenda-restore-windows-after-quit'."
  978. :group 'org-agenda-windows
  979. :type '(choice
  980. (const current-window)
  981. (const other-frame)
  982. (const other-tab)
  983. (const other-window)
  984. (const only-window)
  985. (const reorganize-frame))
  986. :package-version '(Org . "9.4"))
  987. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  988. "The min and max height of the agenda window as a fraction of frame height.
  989. The value of the variable is a cons cell with two numbers between 0 and 1.
  990. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  991. :group 'org-agenda-windows
  992. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  993. (defcustom org-agenda-restore-windows-after-quit nil
  994. "Non-nil means restore window configuration upon exiting agenda.
  995. Before the window configuration is changed for displaying the
  996. agenda, the current status is recorded. When the agenda is
  997. exited with `q' or `x' and this option is set, the old state is
  998. restored. If `org-agenda-window-setup' is `other-frame' or
  999. `other-tab', the value of this option will be ignored."
  1000. :group 'org-agenda-windows
  1001. :type 'boolean)
  1002. (defcustom org-agenda-span 'week
  1003. "Number of days to include in overview display.
  1004. Can be day, week, month, year, or any number of days.
  1005. Custom commands can set this variable in the options section."
  1006. :group 'org-agenda-daily/weekly
  1007. :type '(choice (const :tag "Day" day)
  1008. (const :tag "Week" week)
  1009. (const :tag "Fortnight" fortnight)
  1010. (const :tag "Month" month)
  1011. (const :tag "Year" year)
  1012. (integer :tag "Custom")))
  1013. (defcustom org-agenda-start-on-weekday 1
  1014. "Non-nil means start the overview always on the specified weekday.
  1015. 0 denotes Sunday, 1 denotes Monday, etc.
  1016. When nil, always start on the current day.
  1017. Custom commands can set this variable in the options section."
  1018. :group 'org-agenda-daily/weekly
  1019. :type '(choice (const :tag "Today" nil)
  1020. (integer :tag "Weekday No.")))
  1021. (defcustom org-agenda-show-all-dates t
  1022. "Non-nil means `org-agenda' shows every day in the selected range.
  1023. When nil, only the days which actually have entries are shown."
  1024. :group 'org-agenda-daily/weekly
  1025. :type 'boolean)
  1026. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1027. "Format string for displaying dates in the agenda.
  1028. Used by the daily/weekly agenda. This should be a format string
  1029. understood by `format-time-string', or a function returning the
  1030. formatted date as a string. The function must take a single
  1031. argument, a calendar-style date list like (month day year)."
  1032. :group 'org-agenda-daily/weekly
  1033. :type '(choice
  1034. (string :tag "Format string")
  1035. (function :tag "Function")))
  1036. (defun org-agenda-end-of-line ()
  1037. "Go to the end of visible line."
  1038. (interactive)
  1039. (goto-char (line-end-position)))
  1040. (defun org-agenda-format-date-aligned (date)
  1041. "Format a DATE string for display in the daily/weekly agenda.
  1042. This function makes sure that dates are aligned for easy reading."
  1043. (require 'cal-iso)
  1044. (let* ((dayname (calendar-day-name date))
  1045. (day (cadr date))
  1046. (day-of-week (calendar-day-of-week date))
  1047. (month (car date))
  1048. (monthname (calendar-month-name month))
  1049. (year (nth 2 date))
  1050. (iso-week (org-days-to-iso-week
  1051. (calendar-absolute-from-gregorian date)))
  1052. ;; (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1053. ;; (1- year))
  1054. ;; ((and (= month 12) (<= iso-week 1))
  1055. ;; (1+ year))
  1056. ;; (t year)))
  1057. (weekstring (if (= day-of-week 1)
  1058. (format " W%02d" iso-week)
  1059. "")))
  1060. (format "%-10s %2d %s %4d%s"
  1061. dayname day monthname year weekstring)))
  1062. (defcustom org-agenda-time-leading-zero nil
  1063. "Non-nil means use leading zero for military times in agenda.
  1064. For example, 9:30am would become 09:30 rather than 9:30."
  1065. :group 'org-agenda-daily/weekly
  1066. :version "24.1"
  1067. :type 'boolean)
  1068. (defcustom org-agenda-timegrid-use-ampm nil
  1069. "When set, show AM/PM style timestamps on the timegrid."
  1070. :group 'org-agenda
  1071. :version "24.1"
  1072. :type 'boolean)
  1073. (defun org-agenda-time-of-day-to-ampm (time)
  1074. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1075. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1076. (minute (substring time -2))
  1077. (ampm "am"))
  1078. (cond
  1079. ((equal hour-number 12)
  1080. (setq ampm "pm"))
  1081. ((> hour-number 12)
  1082. (setq ampm "pm")
  1083. (setq hour-number (- hour-number 12))))
  1084. (concat
  1085. (if org-agenda-time-leading-zero
  1086. (format "%02d" hour-number)
  1087. (format "%02s" (number-to-string hour-number)))
  1088. ":" minute ampm)))
  1089. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1090. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1091. (if org-agenda-timegrid-use-ampm
  1092. (org-agenda-time-of-day-to-ampm time)
  1093. time))
  1094. (defcustom org-agenda-weekend-days '(6 0)
  1095. "Which days are weekend?
  1096. These days get the special face `org-agenda-date-weekend' in the agenda."
  1097. :group 'org-agenda-daily/weekly
  1098. :type '(set :greedy t
  1099. (const :tag "Monday" 1)
  1100. (const :tag "Tuesday" 2)
  1101. (const :tag "Wednesday" 3)
  1102. (const :tag "Thursday" 4)
  1103. (const :tag "Friday" 5)
  1104. (const :tag "Saturday" 6)
  1105. (const :tag "Sunday" 0)))
  1106. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1107. "Non-nil means jump to today when moving a past date forward in time.
  1108. When using S-right in the agenda to move a date forward, and the date
  1109. stamp currently points to the past, the first key press will move it
  1110. to today. When nil, just move one day forward even if the date stays
  1111. in the past."
  1112. :group 'org-agenda-daily/weekly
  1113. :version "24.1"
  1114. :type 'boolean)
  1115. (defcustom org-agenda-diary-file 'diary-file
  1116. "File to which to add new entries with the `i' key in agenda and calendar.
  1117. When this is the symbol `diary-file', the functionality in the Emacs
  1118. calendar will be used to add entries to the `diary-file'. But when this
  1119. points to a file, `org-agenda-diary-entry' will be used instead."
  1120. :group 'org-agenda
  1121. :type '(choice
  1122. (const :tag "The standard Emacs diary file" diary-file)
  1123. (file :tag "Special Org file diary entries")))
  1124. (defcustom org-agenda-include-diary nil
  1125. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1126. Custom commands can set this variable in the options section."
  1127. :group 'org-agenda-daily/weekly
  1128. :type 'boolean)
  1129. (defcustom org-agenda-include-deadlines t
  1130. "If non-nil, include entries within their deadline warning period.
  1131. Custom commands can set this variable in the options section."
  1132. :group 'org-agenda-daily/weekly
  1133. :version "24.1"
  1134. :type 'boolean)
  1135. (defcustom org-agenda-show-future-repeats t
  1136. "Non-nil shows repeated entries in the future part of the agenda.
  1137. When set to the symbol `next' only the first future repeat is shown."
  1138. :group 'org-agenda-daily/weekly
  1139. :type '(choice
  1140. (const :tag "Show all repeated entries" t)
  1141. (const :tag "Show next repeated entry" next)
  1142. (const :tag "Do not show repeated entries" nil))
  1143. :version "26.1"
  1144. :package-version '(Org . "9.1")
  1145. :safe #'symbolp)
  1146. (defcustom org-agenda-prefer-last-repeat nil
  1147. "Non-nil sets date for repeated entries to their last repeat.
  1148. When nil, display SCHEDULED and DEADLINE dates at their base
  1149. date, and in today's agenda, as a reminder. Display plain
  1150. time-stamps, on the other hand, at every repeat date in the past
  1151. in addition to the base date.
  1152. When non-nil, show a repeated entry at its latest repeat date,
  1153. possibly being today even if it wasn't marked as done. This
  1154. setting is useful if you do not always mark repeated entries as
  1155. done and, yet, consider that reaching repeat date starts the task
  1156. anew.
  1157. When set to a list of strings, prefer last repeats only for
  1158. entries with these TODO keywords."
  1159. :group 'org-agenda-daily/weekly
  1160. :type '(choice
  1161. (const :tag "Prefer last repeat" t)
  1162. (const :tag "Prefer base date" nil)
  1163. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1164. (string :tag "TODO keyword")))
  1165. :version "26.1"
  1166. :package-version '(Org . "9.1")
  1167. :safe (lambda (x) (or (booleanp x) (consp x))))
  1168. (defcustom org-scheduled-past-days 10000
  1169. "Number of days to continue listing scheduled items not marked DONE.
  1170. When an item is scheduled on a date, it shows up in the agenda on
  1171. this day and will be listed until it is marked done or for the
  1172. number of days given here."
  1173. :group 'org-agenda-daily/weekly
  1174. :type 'integer
  1175. :safe 'integerp)
  1176. (defcustom org-deadline-past-days 10000
  1177. "Number of days to warn about missed deadlines.
  1178. When an item has deadline on a date, it shows up in the agenda on
  1179. this day and will appear as a reminder until it is marked DONE or
  1180. for the number of days given here."
  1181. :group 'org-agenda-daily/weekly
  1182. :type 'integer
  1183. :version "26.1"
  1184. :package-version '(Org . "9.1")
  1185. :safe 'integerp)
  1186. (defcustom org-agenda-log-mode-items '(closed clock)
  1187. "List of items that should be shown in agenda log mode.
  1188. \\<org-agenda-mode-map>\
  1189. This list may contain the following symbols:
  1190. closed Show entries that have been closed on that day.
  1191. clock Show entries that have received clocked time on that day.
  1192. state Show all logged state changes.
  1193. Note that instead of changing this variable, you can also press \
  1194. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1195. the agenda to display all available LOG items temporarily."
  1196. :group 'org-agenda-daily/weekly
  1197. :type '(set :greedy t (const closed) (const clock) (const state)))
  1198. (defcustom org-agenda-clock-consistency-checks
  1199. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1200. :gap-ok-around ("4:00")
  1201. :default-face ((:background "DarkRed") (:foreground "white"))
  1202. :overlap-face nil :gap-face nil :no-end-time-face nil
  1203. :long-face nil :short-face nil)
  1204. "This is a property list, with the following keys:
  1205. :max-duration Mark clocking chunks that are longer than this time.
  1206. This is a time string like \"HH:MM\", or the number
  1207. of minutes as an integer.
  1208. :min-duration Mark clocking chunks that are shorter that this.
  1209. This is a time string like \"HH:MM\", or the number
  1210. of minutes as an integer.
  1211. :max-gap Mark gaps between clocking chunks that are longer than
  1212. this duration. A number of minutes, or a string
  1213. like \"HH:MM\".
  1214. :gap-ok-around List of times during the day which are usually not working
  1215. times. When a gap is detected, but the gap contains any
  1216. of these times, the gap is *not* reported. For example,
  1217. if this is (\"4:00\" \"13:00\") then gaps that contain
  1218. 4:00 in the morning (i.e. the night) and 13:00
  1219. (i.e. a typical lunch time) do not cause a warning.
  1220. You should have at least one time during the night in this
  1221. list, or otherwise the first task each morning will trigger
  1222. a warning because it follows a long gap.
  1223. Furthermore, the following properties can be used to define faces for
  1224. issue display.
  1225. :default-face the default face, if the specific face is undefined
  1226. :overlap-face face for overlapping clocks
  1227. :gap-face face for gaps between clocks
  1228. :no-end-time-face face for incomplete clocks
  1229. :long-face face for clock intervals that are too long
  1230. :short-face face for clock intervals that are too short"
  1231. :group 'org-agenda-daily/weekly
  1232. :group 'org-clock
  1233. :version "24.1"
  1234. :type 'plist)
  1235. (defcustom org-agenda-log-mode-add-notes t
  1236. "Non-nil means add first line of notes to log entries in agenda views.
  1237. If a log item like a state change or a clock entry is associated with
  1238. notes, the first line of these notes will be added to the entry in the
  1239. agenda display."
  1240. :group 'org-agenda-daily/weekly
  1241. :type 'boolean)
  1242. (defcustom org-agenda-start-with-log-mode nil
  1243. "The initial value of log-mode in a newly created agenda window.
  1244. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1245. explanations on the possible values."
  1246. :group 'org-agenda-startup
  1247. :group 'org-agenda-daily/weekly
  1248. :type '(choice (const :tag "Don't show log items" nil)
  1249. (const :tag "Show only log items" only)
  1250. (const :tag "Show all possible log items" clockcheck)
  1251. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1252. (choice (const :tag "Show closed log items" closed)
  1253. (const :tag "Show clocked log items" clock)
  1254. (const :tag "Show all logged state changes" state)))))
  1255. (defcustom org-agenda-start-with-clockreport-mode nil
  1256. "The initial value of clockreport-mode in a newly created agenda window."
  1257. :group 'org-agenda-startup
  1258. :group 'org-agenda-daily/weekly
  1259. :type 'boolean)
  1260. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1261. "Property list with parameters for the clocktable in clockreport mode.
  1262. This is the display mode that shows a clock table in the daily/weekly
  1263. agenda, the properties for this dynamic block can be set here.
  1264. The usual clocktable parameters are allowed here, but you cannot set
  1265. the properties :name, :tstart, :tend, :block, and :scope - these will
  1266. be overwritten to make sure the content accurately reflects the
  1267. current display in the agenda."
  1268. :group 'org-agenda-daily/weekly
  1269. :type 'plist)
  1270. (defvaralias 'org-agenda-search-view-search-words-only
  1271. 'org-agenda-search-view-always-boolean)
  1272. (defcustom org-agenda-search-view-always-boolean nil
  1273. "Non-nil means the search string is interpreted as individual parts.
  1274. The search string for search view can either be interpreted as a phrase,
  1275. or as a list of snippets that define a boolean search for a number of
  1276. strings.
  1277. When this is non-nil, the string will be split on whitespace, and each
  1278. snippet will be searched individually, and all must match in order to
  1279. select an entry. A snippet is then a single string of non-white
  1280. characters, or a string in double quotes, or a regexp in {} braces.
  1281. If a snippet is preceded by \"-\", the snippet must *not* match.
  1282. \"+\" is syntactic sugar for positive selection. Each snippet may
  1283. be found as a full word or a partial word, but see the variable
  1284. `org-agenda-search-view-force-full-words'.
  1285. When this is nil, search will look for the entire search phrase as one,
  1286. with each space character matching any amount of whitespace, including
  1287. line breaks.
  1288. Even when this is nil, you can still switch to Boolean search dynamically
  1289. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1290. is a regexp marked with braces like \"{abc}\", this will also switch to
  1291. boolean search."
  1292. :group 'org-agenda-search-view
  1293. :version "24.1"
  1294. :type 'boolean)
  1295. (defcustom org-agenda-search-view-force-full-words nil
  1296. "Non-nil means, search words must be matches as complete words.
  1297. When nil, they may also match part of a word."
  1298. :group 'org-agenda-search-view
  1299. :version "24.1"
  1300. :type 'boolean)
  1301. (defcustom org-agenda-search-view-max-outline-level 0
  1302. "Maximum outline level to display in search view.
  1303. E.g. when this is set to 1, the search view will only
  1304. show headlines of level 1. When set to 0, the default
  1305. value, don't limit agenda view by outline level."
  1306. :group 'org-agenda-search-view
  1307. :version "26.1"
  1308. :package-version '(Org . "8.3")
  1309. :type 'integer)
  1310. (defgroup org-agenda-time-grid nil
  1311. "Options concerning the time grid in the Org Agenda."
  1312. :tag "Org Agenda Time Grid"
  1313. :group 'org-agenda)
  1314. (defcustom org-agenda-search-headline-for-time t
  1315. "Non-nil means search headline for a time-of-day.
  1316. If the headline contains a time-of-day in one format or another, it will
  1317. be used to sort the entry into the time sequence of items for a day.
  1318. Some people have time stamps in the headline that refer to the creation
  1319. time or so, and then this produces an unwanted side effect. If this is
  1320. the case for your, use this variable to turn off searching the headline
  1321. for a time."
  1322. :group 'org-agenda-time-grid
  1323. :type 'boolean)
  1324. (defcustom org-agenda-use-time-grid t
  1325. "Non-nil means show a time grid in the agenda schedule.
  1326. A time grid is a set of lines for specific times (like every two hours between
  1327. 8:00 and 20:00). The items scheduled for a day at specific times are
  1328. sorted in between these lines.
  1329. For details about when the grid will be shown, and what it will look like, see
  1330. the variable `org-agenda-time-grid'."
  1331. :group 'org-agenda-time-grid
  1332. :type 'boolean)
  1333. (defcustom org-agenda-time-grid
  1334. '((daily today require-timed)
  1335. (800 1000 1200 1400 1600 1800 2000)
  1336. "......"
  1337. "----------------")
  1338. "The settings for time grid for agenda display.
  1339. This is a list of four items. The first item is again a list. It contains
  1340. symbols specifying conditions when the grid should be displayed:
  1341. daily if the agenda shows a single day
  1342. weekly if the agenda shows an entire week
  1343. today show grid on current date, independent of daily/weekly display
  1344. require-timed show grid only if at least one item has a time specification
  1345. remove-match skip grid times already present in an entry
  1346. The second item is a list of integers, indicating the times that
  1347. should have a grid line.
  1348. The third item is a string which will be placed right after the
  1349. times that have a grid line.
  1350. The fourth item is a string placed after the grid times. This
  1351. will align with agenda items."
  1352. :group 'org-agenda-time-grid
  1353. :type
  1354. '(list
  1355. (set :greedy t :tag "Grid Display Options"
  1356. (const :tag "Show grid in single day agenda display" daily)
  1357. (const :tag "Show grid in weekly agenda display" weekly)
  1358. (const :tag "Always show grid for today" today)
  1359. (const :tag "Show grid only if any timed entries are present"
  1360. require-timed)
  1361. (const :tag "Skip grid times already present in an entry"
  1362. remove-match))
  1363. (repeat :tag "Grid Times" (integer :tag "Time"))
  1364. (string :tag "Grid String (after agenda times)")
  1365. (string :tag "Grid String (aligns with agenda items)")))
  1366. (defcustom org-agenda-show-current-time-in-grid t
  1367. "Non-nil means show the current time in the time grid."
  1368. :group 'org-agenda-time-grid
  1369. :version "24.1"
  1370. :type 'boolean)
  1371. (defcustom org-agenda-current-time-string
  1372. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1373. "The string for the current time marker in the agenda."
  1374. :group 'org-agenda-time-grid
  1375. :version "24.1"
  1376. :type 'string)
  1377. (defgroup org-agenda-sorting nil
  1378. "Options concerning sorting in the Org Agenda."
  1379. :tag "Org Agenda Sorting"
  1380. :group 'org-agenda)
  1381. (defcustom org-agenda-sorting-strategy
  1382. '((agenda habit-down time-up priority-down category-keep)
  1383. (todo priority-down category-keep)
  1384. (tags priority-down category-keep)
  1385. (search category-keep))
  1386. "Sorting structure for the agenda items of a single day.
  1387. This is a list of symbols which will be used in sequence to determine
  1388. if an entry should be listed before another entry. The following
  1389. symbols are recognized:
  1390. time-up Put entries with time-of-day indications first, early first.
  1391. time-down Put entries with time-of-day indications first, late first.
  1392. timestamp-up Sort by any timestamp, early first.
  1393. timestamp-down Sort by any timestamp, late first.
  1394. scheduled-up Sort by scheduled timestamp, early first.
  1395. scheduled-down Sort by scheduled timestamp, late first.
  1396. deadline-up Sort by deadline timestamp, early first.
  1397. deadline-down Sort by deadline timestamp, late first.
  1398. ts-up Sort by active timestamp, early first.
  1399. ts-down Sort by active timestamp, late first.
  1400. tsia-up Sort by inactive timestamp, early first.
  1401. tsia-down Sort by inactive timestamp, late first.
  1402. category-keep Keep the default order of categories, corresponding to the
  1403. sequence in `org-agenda-files'.
  1404. category-up Sort alphabetically by category, A-Z.
  1405. category-down Sort alphabetically by category, Z-A.
  1406. tag-up Sort alphabetically by last tag, A-Z.
  1407. tag-down Sort alphabetically by last tag, Z-A.
  1408. priority-up Sort numerically by priority, high priority last.
  1409. priority-down Sort numerically by priority, high priority first.
  1410. todo-state-up Sort by todo state, tasks that are done last.
  1411. todo-state-down Sort by todo state, tasks that are done first.
  1412. effort-up Sort numerically by estimated effort, high effort last.
  1413. effort-down Sort numerically by estimated effort, high effort first.
  1414. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1415. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1416. habit-up Put entries that are habits first.
  1417. habit-down Put entries that are habits last.
  1418. alpha-up Sort headlines alphabetically.
  1419. alpha-down Sort headlines alphabetically, reversed.
  1420. The different possibilities will be tried in sequence, and testing stops
  1421. if one comparison returns a \"not-equal\". For example, the default
  1422. '(time-up category-keep priority-down)
  1423. means: Pull out all entries having a specified time of day and sort them,
  1424. in order to make a time schedule for the current day the first thing in the
  1425. agenda listing for the day. Of the entries without a time indication, keep
  1426. the grouped in categories, don't sort the categories, but keep them in
  1427. the sequence given in `org-agenda-files'. Within each category sort by
  1428. priority.
  1429. Leaving out `category-keep' would mean that items will be sorted across
  1430. categories by priority.
  1431. Instead of a single list, this can also be a set of list for specific
  1432. contents, with a context symbol in the car of the list, any of
  1433. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1434. Custom commands can bind this variable in the options section."
  1435. :group 'org-agenda-sorting
  1436. :type `(choice
  1437. (repeat :tag "General" ,org-sorting-choice)
  1438. (list :tag "Individually"
  1439. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1440. (repeat ,org-sorting-choice))
  1441. (cons (const :tag "Strategy for TODO lists" todo)
  1442. (repeat ,org-sorting-choice))
  1443. (cons (const :tag "Strategy for Tags matches" tags)
  1444. (repeat ,org-sorting-choice))
  1445. (cons (const :tag "Strategy for search matches" search)
  1446. (repeat ,org-sorting-choice)))))
  1447. (defcustom org-agenda-cmp-user-defined nil
  1448. "A function to define the comparison `user-defined'.
  1449. This function must receive two arguments, agenda entry a and b.
  1450. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1451. the user comparison, return nil.
  1452. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1453. part of an agenda sorting strategy."
  1454. :group 'org-agenda-sorting
  1455. :type 'symbol)
  1456. (defcustom org-agenda-sort-notime-is-late t
  1457. "Non-nil means items without time are considered late.
  1458. This is only relevant for sorting. When t, items which have no explicit
  1459. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1460. do have a time. When nil, the default time is before 0:00. You can use this
  1461. option to decide if the schedule for today should come before or after timeless
  1462. agenda entries."
  1463. :group 'org-agenda-sorting
  1464. :type 'boolean)
  1465. (defcustom org-agenda-sort-noeffort-is-high t
  1466. "Non-nil means items without effort estimate are sorted as high effort.
  1467. This also applies when filtering an agenda view with respect to the
  1468. < or > effort operator. Then, tasks with no effort defined will be treated
  1469. as tasks with high effort.
  1470. When nil, such items are sorted as 0 minutes effort."
  1471. :group 'org-agenda-sorting
  1472. :type 'boolean)
  1473. (defgroup org-agenda-line-format nil
  1474. "Options concerning the entry prefix in the Org agenda display."
  1475. :tag "Org Agenda Line Format"
  1476. :group 'org-agenda)
  1477. (defcustom org-agenda-prefix-format
  1478. '((agenda . " %i %-12:c%?-12t% s")
  1479. (todo . " %i %-12:c")
  1480. (tags . " %i %-12:c")
  1481. (search . " %i %-12:c"))
  1482. "Format specifications for the prefix of items in the agenda views.
  1483. An alist with one entry per agenda type. The keys of the
  1484. sublists are `agenda', `todo', `search' and `tags'. The values
  1485. are format strings.
  1486. This format works similar to a printf format, with the following meaning:
  1487. %c the category of the item, \"Diary\" for entries from the diary,
  1488. or as given by the CATEGORY keyword or derived from the file name
  1489. %e the effort required by the item
  1490. %l the level of the item (insert X space(s) if item is of level X)
  1491. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1492. %T the last tag of the item (ignore inherited tags, which come first)
  1493. %t the HH:MM time-of-day specification if one applies to the entry
  1494. %s Scheduling/Deadline information, a short string
  1495. %b show breadcrumbs, i.e., the names of the higher levels
  1496. %(expression) Eval EXPRESSION and replace the control string
  1497. by the result
  1498. All specifiers work basically like the standard `%s' of printf, but may
  1499. contain two additional characters: a question mark just after the `%'
  1500. and a whitespace/punctuation character just before the final letter.
  1501. If the first character after `%' is a question mark, the entire field
  1502. will only be included if the corresponding value applies to the current
  1503. entry. This is useful for fields which should have fixed width when
  1504. present, but zero width when absent. For example, \"%?-12t\" will
  1505. result in a 12 character time field if a time of the day is specified,
  1506. but will completely disappear in entries which do not contain a time.
  1507. If there is punctuation or whitespace character just before the
  1508. final format letter, this character will be appended to the field
  1509. value if the value is not empty. For example, the format
  1510. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1511. the category is empty, no additional colon is inserted.
  1512. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1513. which means:
  1514. - Indent the line with two space characters
  1515. - Give the category a 12 chars wide field, padded with whitespace on
  1516. the right (because of `-'). Append a colon if there is a category
  1517. (because of `:').
  1518. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1519. time, don't put in an empty field, just skip it (because of '?').
  1520. - Finally, put the scheduling information.
  1521. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1522. `org-agenda-remove-tags'.
  1523. Custom commands can set this variable in the options section."
  1524. :type '(choice
  1525. (string :tag "General format")
  1526. (list :greedy t :tag "View dependent"
  1527. (cons (const agenda) (string :tag "Format"))
  1528. (cons (const todo) (string :tag "Format"))
  1529. (cons (const tags) (string :tag "Format"))
  1530. (cons (const search) (string :tag "Format"))))
  1531. :group 'org-agenda-line-format
  1532. :version "26.1"
  1533. :package-version '(Org . "9.1"))
  1534. (defcustom org-agenda-breadcrumbs-separator "->"
  1535. "The separator of breadcrumbs in agenda lines."
  1536. :group 'org-agenda-line-format
  1537. :package-version '(Org . "9.3")
  1538. :type 'string
  1539. :safe #'stringp)
  1540. (defvar org-prefix-format-compiled nil
  1541. "The compiled prefix format and associated variables.
  1542. This is a list where first element is a list of variable bindings, and second
  1543. element is the compiled format expression. See the variable
  1544. `org-agenda-prefix-format'.")
  1545. (defcustom org-agenda-todo-keyword-format "%-1s"
  1546. "Format for the TODO keyword in agenda lines.
  1547. Set this to something like \"%-12s\" if you want all TODO keywords
  1548. to occupy a fixed space in the agenda display."
  1549. :group 'org-agenda-line-format
  1550. :type 'string)
  1551. (defcustom org-agenda-diary-sexp-prefix nil
  1552. "A regexp that matches part of a diary sexp entry
  1553. which should be treated as scheduling/deadline information in
  1554. `org-agenda'.
  1555. For example, you can use this to extract the `diary-remind-message' from
  1556. `diary-remind' entries."
  1557. :group 'org-agenda-line-format
  1558. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1559. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1560. "Text preceding timerange entries in the agenda view.
  1561. This is a list with two strings. The first applies when the range
  1562. is entirely on one day. The second applies if the range spans several days.
  1563. The strings may have two \"%d\" format specifiers which will be filled
  1564. with the sequence number of the days, and the total number of days in the
  1565. range, respectively."
  1566. :group 'org-agenda-line-format
  1567. :type '(list
  1568. (string :tag "Deadline today ")
  1569. (choice :tag "Deadline relative"
  1570. (string :tag "Format string")
  1571. (function))))
  1572. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1573. "Text preceding scheduled items in the agenda view.
  1574. This is a list with two strings. The first applies when the item is
  1575. scheduled on the current day. The second applies when it has been scheduled
  1576. previously, it may contain a %d indicating that this is the nth time that
  1577. this item is scheduled, due to automatic rescheduling of unfinished items
  1578. for the following day. So this number is one larger than the number of days
  1579. that passed since this item was scheduled first."
  1580. :group 'org-agenda-line-format
  1581. :version "24.4"
  1582. :package-version '(Org . "8.0")
  1583. :type '(list
  1584. (string :tag "Scheduled today ")
  1585. (string :tag "Scheduled previously")))
  1586. (defcustom org-agenda-inactive-leader "["
  1587. "Text preceding item pulled into the agenda by inactive time stamps.
  1588. These entries are added to the agenda when pressing \"[\"."
  1589. :group 'org-agenda-line-format
  1590. :version "24.1"
  1591. :type 'string)
  1592. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1593. "Text preceding deadline items in the agenda view.
  1594. This is a list with three strings. The first applies when the item has its
  1595. deadline on the current day. The second applies when the deadline is in the
  1596. future, the third one when it is in the past. The strings may contain %d
  1597. to capture the number of days."
  1598. :group 'org-agenda-line-format
  1599. :version "24.4"
  1600. :package-version '(Org . "8.0")
  1601. :type '(list
  1602. (string :tag "Deadline today ")
  1603. (string :tag "Deadline in the future ")
  1604. (string :tag "Deadline in the past ")))
  1605. (defcustom org-agenda-remove-times-when-in-prefix t
  1606. "Non-nil means remove duplicate time specifications in agenda items.
  1607. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1608. time-of-day specification in a headline or diary entry is extracted and
  1609. placed into the prefix. If this option is non-nil, the original specification
  1610. \(a timestamp or -range, or just a plain time(range) specification like
  1611. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1612. cluttered.
  1613. The option can be t or nil. It may also be the symbol `beg', indicating
  1614. that the time should only be removed when it is located at the beginning of
  1615. the headline/diary entry."
  1616. :group 'org-agenda-line-format
  1617. :type '(choice
  1618. (const :tag "Always" t)
  1619. (const :tag "Never" nil)
  1620. (const :tag "When at beginning of entry" beg)))
  1621. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1622. "Non-nil means remove time ranges specifications in agenda
  1623. items that span on several days."
  1624. :group 'org-agenda-line-format
  1625. :version "24.1"
  1626. :type 'boolean)
  1627. (defcustom org-agenda-default-appointment-duration nil
  1628. "Default duration for appointments that only have a starting time.
  1629. When nil, no duration is specified in such cases.
  1630. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1631. :group 'org-agenda-line-format
  1632. :type '(choice
  1633. (integer :tag "Minutes")
  1634. (const :tag "No default duration")))
  1635. (defcustom org-agenda-show-inherited-tags t
  1636. "Non-nil means show inherited tags in each agenda line.
  1637. When this option is set to `always', it takes precedence over
  1638. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1639. in every agenda.
  1640. When this option is set to t (the default), inherited tags are
  1641. shown when they are available, i.e. when the value of
  1642. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1643. given agenda type.
  1644. This can be set to a list of agenda types in which the agenda
  1645. must display the inherited tags. Available types are `todo',
  1646. `agenda' and `search'.
  1647. When set to nil, never show inherited tags in agenda lines."
  1648. :group 'org-agenda-line-format
  1649. :group 'org-agenda
  1650. :version "24.3"
  1651. :type '(choice
  1652. (const :tag "Show inherited tags when available" t)
  1653. (const :tag "Always show inherited tags" always)
  1654. (repeat :tag "Show inherited tags only in selected agenda types"
  1655. (symbol :tag "Agenda type"))))
  1656. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1657. "List of agenda view types where to use tag inheritance.
  1658. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1659. controlled by `org-use-tag-inheritance'. In other agenda types,
  1660. `org-use-tag-inheritance' is not used for the selection of the
  1661. agenda entries. Still, you may want the agenda to be aware of
  1662. the inherited tags anyway, e.g. for later tag filtering.
  1663. Allowed value are `todo', `search' and `agenda'.
  1664. This variable has no effect if `org-agenda-show-inherited-tags'
  1665. is set to `always'. In that case, the agenda is aware of those
  1666. tags.
  1667. The default value sets tags in every agenda type. Setting this
  1668. option to nil will speed up non-tags agenda view a lot."
  1669. :group 'org-agenda
  1670. :version "26.1"
  1671. :package-version '(Org . "9.1")
  1672. :type '(choice
  1673. (const :tag "Use tag inheritance in all agenda types" t)
  1674. (repeat :tag "Use tag inheritance in selected agenda types"
  1675. (symbol :tag "Agenda type"))))
  1676. (defcustom org-agenda-hide-tags-regexp nil
  1677. "Regular expression used to filter away specific tags in agenda views.
  1678. This means that these tags will be present, but not be shown in the agenda
  1679. line. Secondary filtering will still work on the hidden tags.
  1680. Nil means don't hide any tags."
  1681. :group 'org-agenda-line-format
  1682. :type '(choice
  1683. (const :tag "Hide none" nil)
  1684. (regexp :tag "Regexp ")))
  1685. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1686. 'org-agenda-remove-tags)
  1687. (defcustom org-agenda-remove-tags nil
  1688. "Non-nil means remove the tags from the headline copy in the agenda.
  1689. When this is the symbol `prefix', only remove tags when
  1690. `org-agenda-prefix-format' contains a `%T' specifier."
  1691. :group 'org-agenda-line-format
  1692. :type '(choice
  1693. (const :tag "Always" t)
  1694. (const :tag "Never" nil)
  1695. (const :tag "When prefix format contains %T" prefix)))
  1696. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1697. (defcustom org-agenda-tags-column 'auto
  1698. "Shift tags in agenda items to this column.
  1699. If set to `auto', tags will be automatically aligned to the right
  1700. edge of the window.
  1701. If set to a positive number, tags will be left-aligned to that
  1702. column. If set to a negative number, tags will be right-aligned
  1703. to that column. For example, -80 works well for a normal 80
  1704. character screen."
  1705. :group 'org-agenda-line-format
  1706. :type '(choice
  1707. (const :tag "Automatically align to right edge of window" auto)
  1708. (integer :tag "Specific column" -80))
  1709. :package-version '(Org . "9.1")
  1710. :version "26.1")
  1711. (defcustom org-agenda-fontify-priorities 'cookies
  1712. "Non-nil means highlight low and high priorities in agenda.
  1713. When t, the highest priority entries are bold, lowest priority italic.
  1714. However, settings in `org-priority-faces' will overrule these faces.
  1715. When this variable is the symbol `cookies', only fontify the
  1716. cookies, not the entire task.
  1717. This may also be an association list of priority faces, whose
  1718. keys are the character values of `org-priority-highest',
  1719. `org-priority-default', and `org-priority-lowest' (the default values
  1720. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1721. color as a string, or a list like `(:background \"Red\")'.
  1722. If it is a color, the variable `org-faces-easy-properties'
  1723. determines if it is a foreground or a background color."
  1724. :group 'org-agenda-line-format
  1725. :type '(choice
  1726. (const :tag "Never" nil)
  1727. (const :tag "Defaults" t)
  1728. (const :tag "Cookies only" cookies)
  1729. (repeat :tag "Specify"
  1730. (list (character :tag "Priority" :value ?A)
  1731. (choice :tag "Face "
  1732. (string :tag "Color")
  1733. (sexp :tag "Face"))))))
  1734. (defcustom org-agenda-day-face-function nil
  1735. "Function called to determine what face should be used to display a day.
  1736. The only argument passed to that function is the day. It should
  1737. returns a face, or nil if does not want to specify a face and let
  1738. the normal rules apply."
  1739. :group 'org-agenda-line-format
  1740. :version "24.1"
  1741. :type '(choice (const nil) (function)))
  1742. (defcustom org-agenda-category-icon-alist nil
  1743. "Alist of category icon to be displayed in agenda views.
  1744. Each entry should have the following format:
  1745. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1746. Where CATEGORY-REGEXP is a regexp matching the categories where
  1747. the icon should be displayed.
  1748. FILE-OR-DATA either a file path or a string containing image data.
  1749. The other fields can be omitted safely if not needed:
  1750. TYPE indicates the image type.
  1751. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1752. image data.
  1753. PROPS are additional image attributes to assign to the image,
  1754. like, e.g. `:ascent center'.
  1755. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1756. If you want to set the display properties yourself, just put a
  1757. list as second element:
  1758. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1759. For example, to display a 16px horizontal space for Emacs
  1760. category, you can use:
  1761. (\"Emacs\" \\='(space . (:width (16))))"
  1762. :group 'org-agenda-line-format
  1763. :version "24.1"
  1764. :type '(alist :key-type (regexp :tag "Regexp matching category")
  1765. :value-type (choice (list :tag "Icon"
  1766. (string :tag "File or data")
  1767. (symbol :tag "Type")
  1768. (boolean :tag "Data?")
  1769. (repeat :tag "Extra image properties" :inline t sexp))
  1770. (list :tag "Display properties" sexp))))
  1771. (defgroup org-agenda-column-view nil
  1772. "Options concerning column view in the agenda."
  1773. :tag "Org Agenda Column View"
  1774. :group 'org-agenda)
  1775. (defcustom org-agenda-view-columns-initially nil
  1776. "When non-nil, switch to columns view right after creating the agenda."
  1777. :group 'org-agenda-column-view
  1778. :type 'boolean
  1779. :version "26.1"
  1780. :package-version '(Org . "9.0")
  1781. :safe #'booleanp)
  1782. (defcustom org-agenda-columns-show-summaries t
  1783. "Non-nil means show summaries for columns displayed in the agenda view."
  1784. :group 'org-agenda-column-view
  1785. :type 'boolean)
  1786. (defcustom org-agenda-columns-compute-summary-properties t
  1787. "Non-nil means recompute all summary properties before column view.
  1788. When column view in the agenda is listing properties that have a summary
  1789. operator, it can go to all relevant buffers and recompute the summaries
  1790. there. This can mean overhead for the agenda column view, but is necessary
  1791. to have thing up to date.
  1792. As a special case, a CLOCKSUM property also makes sure that the clock
  1793. computations are current."
  1794. :group 'org-agenda-column-view
  1795. :type 'boolean)
  1796. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1797. "Non-nil means the duration of an appointment will add to day effort.
  1798. The property to which appointment durations will be added is the one given
  1799. in the option `org-effort-property'. If an appointment does not have
  1800. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1801. is not set, an appointment without end time will not contribute to the time
  1802. estimate."
  1803. :group 'org-agenda-column-view
  1804. :type 'boolean)
  1805. (defcustom org-agenda-auto-exclude-function nil
  1806. "A function called with a tag to decide if it is filtered on \
  1807. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1808. The sole argument to the function, which is called once for each
  1809. possible tag, is a string giving the name of the tag. The
  1810. function should return either nil if the tag should be included
  1811. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1812. lines not carrying this tag.
  1813. Note that for the purpose of tag filtering, only the lower-case version of
  1814. all tags will be considered, so that this function will only ever see
  1815. the lower-case version of all tags."
  1816. :group 'org-agenda
  1817. :type '(choice (const nil) (function)))
  1818. (defcustom org-agenda-bulk-custom-functions nil
  1819. "Alist of characters and custom functions for bulk actions.
  1820. For example, this value makes those two functions available:
  1821. \\='((?R set-category)
  1822. (?C bulk-cut))
  1823. With selected entries in an agenda buffer, `B R' will call
  1824. the custom function `set-category' on the selected entries.
  1825. Note that functions in this alist don't need to be quoted.
  1826. You can also specify a function which collects arguments to be
  1827. used for each call to your bulk custom function. The argument
  1828. collecting function will be run once and should return a list of
  1829. arguments to pass to the bulk function. For example:
  1830. \\='((?R set-category get-category))
  1831. Now, `B R' will call the custom `get-category' which would prompt
  1832. the user once for a category. That category is then passed as an
  1833. argument to `set-category' for each entry it's called against."
  1834. :type
  1835. '(alist :key-type character
  1836. :value-type
  1837. (group (function :tag "Bulk Custom Function")
  1838. (choice (function :tag "Bulk Custom Argument Function")
  1839. (const :tag "No Bulk Custom Argument Function" nil))))
  1840. :package-version '(Org . "9.5")
  1841. :group 'org-agenda)
  1842. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1843. "Execute BODY with point at location given by `org-hd-marker' property.
  1844. If STRING is non-nil, the text property will be fetched from position 0
  1845. in that string. If STRING is nil, it will be fetched from the beginning
  1846. of the current line."
  1847. (declare (debug t))
  1848. (org-with-gensyms (marker)
  1849. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1850. 'org-hd-marker ,string)))
  1851. (with-current-buffer (marker-buffer ,marker)
  1852. (save-excursion
  1853. (goto-char ,marker)
  1854. ,@body)))))
  1855. (defun org-add-agenda-custom-command (entry)
  1856. "Replace or add a command in `org-agenda-custom-commands'.
  1857. This is mostly for hacking and trying a new command - once the command
  1858. works you probably want to add it to `org-agenda-custom-commands' for good."
  1859. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1860. (if ass
  1861. (setcdr ass (cdr entry))
  1862. (push entry org-agenda-custom-commands))))
  1863. (defmacro org-agenda--insert-overriding-header (default)
  1864. "Insert header into agenda view.
  1865. The inserted header depends on `org-agenda-overriding-header'.
  1866. If the empty string, don't insert a header. If any other string,
  1867. insert it as a header. If nil, insert DEFAULT, which should
  1868. evaluate to a string."
  1869. (declare (debug (form)) (indent defun))
  1870. `(cond
  1871. ((not org-agenda-overriding-header) (insert ,default))
  1872. ((equal org-agenda-overriding-header "") nil)
  1873. ((stringp org-agenda-overriding-header)
  1874. (insert (propertize org-agenda-overriding-header
  1875. 'face 'org-agenda-structure)
  1876. "\n"))
  1877. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1878. org-agenda-overriding-header))))
  1879. ;;; Define the org-agenda-mode
  1880. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1881. (defvar org-agenda-mode-map (make-sparse-keymap)
  1882. "Keymap for `org-agenda-mode'.")
  1883. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1884. (defvar org-agenda-menu) ; defined later in this file.
  1885. (defvar org-agenda-restrict nil) ; defined later in this file.
  1886. (defvar org-agenda-follow-mode nil)
  1887. (defvar org-agenda-entry-text-mode nil)
  1888. (defvar org-agenda-clockreport-mode nil)
  1889. (defvar org-agenda-show-log nil
  1890. "When non-nil, show the log in the agenda.
  1891. Do not set this directly; instead use
  1892. `org-agenda-start-with-log-mode', which see.")
  1893. (defvar org-agenda-redo-command nil)
  1894. (defvar org-agenda-query-string nil)
  1895. (defvar org-agenda-mode-hook nil
  1896. "Hook run after `org-agenda-mode' is turned on.
  1897. The buffer is still writable when this hook is called.")
  1898. (defvar org-agenda-type nil)
  1899. (defvar org-agenda-force-single-file nil)
  1900. (defvar org-agenda-bulk-marked-entries nil
  1901. "List of markers that refer to marked entries in the agenda.")
  1902. (defvar org-agenda-current-date nil
  1903. "Active date when building the agenda.")
  1904. ;;; Multiple agenda buffers support
  1905. (defcustom org-agenda-sticky nil
  1906. "Non-nil means agenda q key will bury agenda buffers.
  1907. Agenda commands will then show existing buffer instead of generating new ones.
  1908. When nil, `q' will kill the single agenda buffer."
  1909. :group 'org-agenda
  1910. :version "24.3"
  1911. :type 'boolean)
  1912. ;;;###autoload
  1913. (defun org-toggle-sticky-agenda (&optional arg)
  1914. "Toggle `org-agenda-sticky'."
  1915. (interactive "P")
  1916. (let ((new-value (if arg
  1917. (> (prefix-numeric-value arg) 0)
  1918. (not org-agenda-sticky))))
  1919. (if (equal new-value org-agenda-sticky)
  1920. (and (called-interactively-p 'interactive)
  1921. (message "Sticky agenda was already %s"
  1922. (if org-agenda-sticky "enabled" "disabled")))
  1923. (setq org-agenda-sticky new-value)
  1924. (org-agenda-kill-all-agenda-buffers)
  1925. (and (called-interactively-p 'interactive)
  1926. (message "Sticky agenda %s"
  1927. (if org-agenda-sticky "enabled" "disabled"))))))
  1928. (defvar org-agenda-buffer nil
  1929. "Agenda buffer currently being generated.")
  1930. (defvar org-agenda-last-prefix-arg nil)
  1931. (defvar org-agenda-this-buffer-name nil)
  1932. (defvar org-agenda-doing-sticky-redo nil)
  1933. (defvar org-agenda-this-buffer-is-sticky nil)
  1934. (defvar org-agenda-last-indirect-buffer nil
  1935. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1936. (defconst org-agenda-local-vars
  1937. '(org-agenda-this-buffer-name
  1938. org-agenda-undo-list
  1939. org-agenda-pending-undo-list
  1940. org-agenda-follow-mode
  1941. org-agenda-entry-text-mode
  1942. org-agenda-clockreport-mode
  1943. org-agenda-show-log
  1944. org-agenda-redo-command
  1945. org-agenda-query-string
  1946. org-agenda-type
  1947. org-agenda-bulk-marked-entries
  1948. org-agenda-undo-has-started-in
  1949. org-agenda-info
  1950. org-agenda-pre-window-conf
  1951. org-agenda-columns-active
  1952. org-agenda-tag-filter
  1953. org-agenda-category-filter
  1954. org-agenda-top-headline-filter
  1955. org-agenda-regexp-filter
  1956. org-agenda-effort-filter
  1957. org-agenda-markers
  1958. org-agenda-last-search-view-search-was-boolean
  1959. org-agenda-last-indirect-buffer
  1960. org-agenda-filtered-by-category
  1961. org-agenda-filter-form
  1962. org-agenda-cycle-counter
  1963. org-agenda-last-prefix-arg)
  1964. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1965. (defun org-agenda-mode ()
  1966. "Mode for time-sorted view on action items in Org files.
  1967. The following commands are available:
  1968. \\{org-agenda-mode-map}"
  1969. (interactive)
  1970. (ignore-errors (require 'face-remap))
  1971. (let ((agenda-local-vars-to-keep
  1972. '(text-scale-mode-amount
  1973. text-scale-mode
  1974. text-scale-mode-lighter
  1975. face-remapping-alist))
  1976. (save (buffer-local-variables)))
  1977. (kill-all-local-variables)
  1978. (cl-flet ((reset-saved (var-set)
  1979. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1980. (dolist (elem save)
  1981. (pcase elem
  1982. (`(,var . ,val) ;ignore unbound variables
  1983. (when (and val (memq var var-set))
  1984. (set var val)))))))
  1985. (cond (org-agenda-doing-sticky-redo
  1986. ;; Refreshing sticky agenda-buffer
  1987. ;;
  1988. ;; Preserve the value of `org-agenda-local-vars' variables.
  1989. (mapc #'make-local-variable org-agenda-local-vars)
  1990. (reset-saved org-agenda-local-vars)
  1991. (setq-local org-agenda-this-buffer-is-sticky t))
  1992. (org-agenda-sticky
  1993. ;; Creating a sticky Agenda buffer for the first time
  1994. (mapc #'make-local-variable org-agenda-local-vars)
  1995. (setq-local org-agenda-this-buffer-is-sticky t))
  1996. (t
  1997. ;; Creating a non-sticky agenda buffer
  1998. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1999. (mapc #'make-local-variable agenda-local-vars-to-keep)
  2000. (reset-saved agenda-local-vars-to-keep)))
  2001. (setq org-agenda-undo-list nil
  2002. org-agenda-pending-undo-list nil
  2003. org-agenda-bulk-marked-entries nil)
  2004. (setq major-mode 'org-agenda-mode)
  2005. ;; Keep global-font-lock-mode from turning on font-lock-mode
  2006. (setq-local font-lock-global-modes (list 'not major-mode))
  2007. (setq mode-name "Org-Agenda")
  2008. (setq indent-tabs-mode nil)
  2009. (use-local-map org-agenda-mode-map)
  2010. (when org-startup-truncated (setq truncate-lines t))
  2011. (setq-local line-move-visual nil)
  2012. (add-hook 'post-command-hook #'org-agenda-update-agenda-type nil 'local)
  2013. (add-hook 'pre-command-hook #'org-unhighlight nil 'local)
  2014. ;; Make sure properties are removed when copying text
  2015. (if (boundp 'filter-buffer-substring-functions)
  2016. (add-hook 'filter-buffer-substring-functions
  2017. (lambda (fun start end delete)
  2018. (substring-no-properties (funcall fun start end delete)))
  2019. nil t)
  2020. ;; Emacs >= 24.4.
  2021. (add-function :filter-return (local 'filter-buffer-substring-function)
  2022. #'substring-no-properties))
  2023. (unless org-agenda-keep-modes
  2024. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  2025. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  2026. org-agenda-show-log org-agenda-start-with-log-mode
  2027. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2028. (add-to-invisibility-spec '(org-filtered))
  2029. (add-to-invisibility-spec '(org-link))
  2030. (easy-menu-change
  2031. '("Agenda") "Agenda Files"
  2032. (append
  2033. (list
  2034. (vector
  2035. (if (get 'org-agenda-files 'org-restrict)
  2036. "Restricted to single file"
  2037. "Edit File List")
  2038. '(org-edit-agenda-file-list)
  2039. (not (get 'org-agenda-files 'org-restrict)))
  2040. "--")
  2041. (mapcar #'org-file-menu-entry (org-agenda-files))))
  2042. (org-agenda-set-mode-name)
  2043. (run-mode-hooks 'org-agenda-mode-hook))
  2044. (substitute-key-definition #'undo #'org-agenda-undo
  2045. org-agenda-mode-map global-map)
  2046. (org-defkey org-agenda-mode-map "\C-i" #'org-agenda-goto)
  2047. (org-defkey org-agenda-mode-map [(tab)] #'org-agenda-goto)
  2048. (org-defkey org-agenda-mode-map "\C-m" #'org-agenda-switch-to)
  2049. (org-defkey org-agenda-mode-map "\C-k" #'org-agenda-kill)
  2050. (org-defkey org-agenda-mode-map "\C-c\C-w" #'org-agenda-refile)
  2051. (org-defkey org-agenda-mode-map [(meta down)] #'org-agenda-drag-line-forward)
  2052. (org-defkey org-agenda-mode-map [(meta up)] #'org-agenda-drag-line-backward)
  2053. (org-defkey org-agenda-mode-map "m" #'org-agenda-bulk-mark)
  2054. (org-defkey org-agenda-mode-map "\M-m" #'org-agenda-bulk-toggle)
  2055. (org-defkey org-agenda-mode-map "*" #'org-agenda-bulk-mark-all)
  2056. (org-defkey org-agenda-mode-map "\M-*" #'org-agenda-bulk-toggle-all)
  2057. (org-defkey org-agenda-mode-map "#" #'org-agenda-dim-blocked-tasks)
  2058. (org-defkey org-agenda-mode-map "%" #'org-agenda-bulk-mark-regexp)
  2059. (org-defkey org-agenda-mode-map "u" #'org-agenda-bulk-unmark)
  2060. (org-defkey org-agenda-mode-map "U" #'org-agenda-bulk-unmark-all)
  2061. (org-defkey org-agenda-mode-map "B" #'org-agenda-bulk-action)
  2062. (org-defkey org-agenda-mode-map "k" #'org-agenda-capture)
  2063. (org-defkey org-agenda-mode-map "A" #'org-agenda-append-agenda)
  2064. (org-defkey org-agenda-mode-map "\C-c\C-x!" #'org-reload)
  2065. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" #'org-agenda-archive-default)
  2066. (org-defkey org-agenda-mode-map "\C-c\C-xa" #'org-agenda-toggle-archive-tag)
  2067. (org-defkey org-agenda-mode-map "\C-c\C-xA" #'org-agenda-archive-to-archive-sibling)
  2068. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" #'org-agenda-archive)
  2069. (org-defkey org-agenda-mode-map "\C-c$" #'org-agenda-archive)
  2070. (org-defkey org-agenda-mode-map "$" #'org-agenda-archive)
  2071. (org-defkey org-agenda-mode-map "\C-c\C-o" #'org-agenda-open-link)
  2072. (org-defkey org-agenda-mode-map " " #'org-agenda-show-and-scroll-up)
  2073. (org-defkey org-agenda-mode-map [backspace] #'org-agenda-show-scroll-down)
  2074. (org-defkey org-agenda-mode-map "\d" #'org-agenda-show-scroll-down)
  2075. (org-defkey org-agenda-mode-map [(control shift right)] #'org-agenda-todo-nextset)
  2076. (org-defkey org-agenda-mode-map [(control shift left)] #'org-agenda-todo-previousset)
  2077. (org-defkey org-agenda-mode-map "\C-c\C-xb" #'org-agenda-tree-to-indirect-buffer)
  2078. (org-defkey org-agenda-mode-map "o" #'delete-other-windows)
  2079. (org-defkey org-agenda-mode-map "L" #'org-agenda-recenter)
  2080. (org-defkey org-agenda-mode-map "\C-c\C-t" #'org-agenda-todo)
  2081. (org-defkey org-agenda-mode-map "t" #'org-agenda-todo)
  2082. (org-defkey org-agenda-mode-map "a" #'org-agenda-archive-default-with-confirmation)
  2083. (org-defkey org-agenda-mode-map ":" #'org-agenda-set-tags)
  2084. (org-defkey org-agenda-mode-map "\C-c\C-q" #'org-agenda-set-tags)
  2085. (org-defkey org-agenda-mode-map "." #'org-agenda-goto-today)
  2086. (org-defkey org-agenda-mode-map "j" #'org-agenda-goto-date)
  2087. (org-defkey org-agenda-mode-map "d" #'org-agenda-day-view)
  2088. (org-defkey org-agenda-mode-map "w" #'org-agenda-week-view)
  2089. (org-defkey org-agenda-mode-map "y" #'org-agenda-year-view)
  2090. (org-defkey org-agenda-mode-map "\C-c\C-z" #'org-agenda-add-note)
  2091. (org-defkey org-agenda-mode-map "z" #'org-agenda-add-note)
  2092. (org-defkey org-agenda-mode-map [(shift right)] #'org-agenda-do-date-later)
  2093. (org-defkey org-agenda-mode-map [(shift left)] #'org-agenda-do-date-earlier)
  2094. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] #'org-agenda-do-date-later)
  2095. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] #'org-agenda-do-date-earlier)
  2096. (org-defkey org-agenda-mode-map ">" #'org-agenda-date-prompt)
  2097. (org-defkey org-agenda-mode-map "\C-c\C-s" #'org-agenda-schedule)
  2098. (org-defkey org-agenda-mode-map "\C-c\C-d" #'org-agenda-deadline)
  2099. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2100. (while l (org-defkey org-agenda-mode-map
  2101. (number-to-string (pop l)) #'digit-argument)))
  2102. (org-defkey org-agenda-mode-map "F" #'org-agenda-follow-mode)
  2103. (org-defkey org-agenda-mode-map "R" #'org-agenda-clockreport-mode)
  2104. (org-defkey org-agenda-mode-map "E" #'org-agenda-entry-text-mode)
  2105. (org-defkey org-agenda-mode-map "l" #'org-agenda-log-mode)
  2106. (org-defkey org-agenda-mode-map "v" #'org-agenda-view-mode-dispatch)
  2107. (org-defkey org-agenda-mode-map "D" #'org-agenda-toggle-diary)
  2108. (org-defkey org-agenda-mode-map "!" #'org-agenda-toggle-deadlines)
  2109. (org-defkey org-agenda-mode-map "G" #'org-agenda-toggle-time-grid)
  2110. (org-defkey org-agenda-mode-map "r" #'org-agenda-redo)
  2111. (org-defkey org-agenda-mode-map "g" #'org-agenda-redo-all)
  2112. (org-defkey org-agenda-mode-map "e" #'org-agenda-set-effort)
  2113. (org-defkey org-agenda-mode-map "\C-c\C-xe" #'org-agenda-set-effort)
  2114. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2115. #'org-clock-modify-effort-estimate)
  2116. (org-defkey org-agenda-mode-map "\C-c\C-xp" #'org-agenda-set-property)
  2117. (org-defkey org-agenda-mode-map "q" #'org-agenda-quit)
  2118. (org-defkey org-agenda-mode-map "Q" #'org-agenda-Quit)
  2119. (org-defkey org-agenda-mode-map "x" #'org-agenda-exit)
  2120. (org-defkey org-agenda-mode-map "\C-x\C-w" #'org-agenda-write)
  2121. (org-defkey org-agenda-mode-map "\C-x\C-s" #'org-save-all-org-buffers)
  2122. (org-defkey org-agenda-mode-map "s" #'org-save-all-org-buffers)
  2123. (org-defkey org-agenda-mode-map "T" #'org-agenda-show-tags)
  2124. (org-defkey org-agenda-mode-map "n" #'org-agenda-next-line)
  2125. (org-defkey org-agenda-mode-map "p" #'org-agenda-previous-line)
  2126. (org-defkey org-agenda-mode-map "N" #'org-agenda-next-item)
  2127. (org-defkey org-agenda-mode-map "P" #'org-agenda-previous-item)
  2128. (substitute-key-definition #'next-line #'org-agenda-next-line
  2129. org-agenda-mode-map global-map)
  2130. (substitute-key-definition #'previous-line #'org-agenda-previous-line
  2131. org-agenda-mode-map global-map)
  2132. (org-defkey org-agenda-mode-map "\C-c\C-a" #'org-attach)
  2133. (org-defkey org-agenda-mode-map "\C-c\C-n" #'org-agenda-next-date-line)
  2134. (org-defkey org-agenda-mode-map "\C-c\C-p" #'org-agenda-previous-date-line)
  2135. (org-defkey org-agenda-mode-map "\C-c," #'org-agenda-priority)
  2136. (org-defkey org-agenda-mode-map "," #'org-agenda-priority)
  2137. (org-defkey org-agenda-mode-map "i" #'org-agenda-diary-entry)
  2138. (org-defkey org-agenda-mode-map "c" #'org-agenda-goto-calendar)
  2139. (org-defkey org-agenda-mode-map "C" #'org-agenda-convert-date)
  2140. (org-defkey org-agenda-mode-map "M" #'org-agenda-phases-of-moon)
  2141. (org-defkey org-agenda-mode-map "S" #'org-agenda-sunrise-sunset)
  2142. (org-defkey org-agenda-mode-map "h" #'org-agenda-holidays)
  2143. (org-defkey org-agenda-mode-map "H" #'org-agenda-holidays)
  2144. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" #'org-agenda-clock-in)
  2145. (org-defkey org-agenda-mode-map "I" #'org-agenda-clock-in)
  2146. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" #'org-agenda-clock-out)
  2147. (org-defkey org-agenda-mode-map "O" #'org-agenda-clock-out)
  2148. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" #'org-agenda-clock-cancel)
  2149. (org-defkey org-agenda-mode-map "X" #'org-agenda-clock-cancel)
  2150. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" #'org-clock-goto)
  2151. (org-defkey org-agenda-mode-map "J" #'org-agenda-clock-goto)
  2152. (org-defkey org-agenda-mode-map "+" #'org-agenda-priority-up)
  2153. (org-defkey org-agenda-mode-map "-" #'org-agenda-priority-down)
  2154. (org-defkey org-agenda-mode-map [(shift up)] #'org-agenda-priority-up)
  2155. (org-defkey org-agenda-mode-map [(shift down)] #'org-agenda-priority-down)
  2156. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] #'org-agenda-priority-up)
  2157. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] #'org-agenda-priority-down)
  2158. (org-defkey org-agenda-mode-map "f" #'org-agenda-later)
  2159. (org-defkey org-agenda-mode-map "b" #'org-agenda-earlier)
  2160. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" #'org-agenda-columns)
  2161. (org-defkey org-agenda-mode-map "\C-c\C-x>" #'org-agenda-remove-restriction-lock)
  2162. (org-defkey org-agenda-mode-map "\C-c\C-x<" #'org-agenda-set-restriction-lock-from-agenda)
  2163. (org-defkey org-agenda-mode-map "[" #'org-agenda-manipulate-query-add)
  2164. (org-defkey org-agenda-mode-map "]" #'org-agenda-manipulate-query-subtract)
  2165. (org-defkey org-agenda-mode-map "{" #'org-agenda-manipulate-query-add-re)
  2166. (org-defkey org-agenda-mode-map "}" #'org-agenda-manipulate-query-subtract-re)
  2167. (org-defkey org-agenda-mode-map "\\" #'org-agenda-filter-by-tag)
  2168. (org-defkey org-agenda-mode-map "_" #'org-agenda-filter-by-effort)
  2169. (org-defkey org-agenda-mode-map "=" #'org-agenda-filter-by-regexp)
  2170. (org-defkey org-agenda-mode-map "/" #'org-agenda-filter)
  2171. (org-defkey org-agenda-mode-map "|" #'org-agenda-filter-remove-all)
  2172. (org-defkey org-agenda-mode-map "~" #'org-agenda-limit-interactively)
  2173. (org-defkey org-agenda-mode-map "<" #'org-agenda-filter-by-category)
  2174. (org-defkey org-agenda-mode-map "^" #'org-agenda-filter-by-top-headline)
  2175. (org-defkey org-agenda-mode-map ";" #'org-timer-set-timer)
  2176. (org-defkey org-agenda-mode-map "\C-c\C-x_" #'org-timer-stop)
  2177. (org-defkey org-agenda-mode-map "?" #'org-agenda-show-the-flagging-note)
  2178. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" #'org-mobile-pull)
  2179. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" #'org-mobile-push)
  2180. (org-defkey org-agenda-mode-map "\C-c\C-xI" #'org-info-find-node)
  2181. (org-defkey org-agenda-mode-map [mouse-2] #'org-agenda-goto-mouse)
  2182. (org-defkey org-agenda-mode-map [mouse-3] #'org-agenda-show-mouse)
  2183. (org-defkey org-agenda-mode-map [remap forward-paragraph] #'org-agenda-forward-block)
  2184. (org-defkey org-agenda-mode-map [remap backward-paragraph] #'org-agenda-backward-block)
  2185. (org-defkey org-agenda-mode-map "\C-c\C-c" #'org-agenda-ctrl-c-ctrl-c)
  2186. (when org-agenda-mouse-1-follows-link
  2187. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2188. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2189. '("Agenda"
  2190. ("Agenda Files")
  2191. "--"
  2192. ("Agenda Dates"
  2193. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2194. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2195. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2196. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2197. "--"
  2198. ("View"
  2199. ["Day View" org-agenda-day-view
  2200. :active (org-agenda-check-type nil 'agenda)
  2201. :style radio :selected (eq org-agenda-current-span 'day)
  2202. :keys "v d (or just d)"]
  2203. ["Week View" org-agenda-week-view
  2204. :active (org-agenda-check-type nil 'agenda)
  2205. :style radio :selected (eq org-agenda-current-span 'week)
  2206. :keys "v w"]
  2207. ["Fortnight View" org-agenda-fortnight-view
  2208. :active (org-agenda-check-type nil 'agenda)
  2209. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2210. :keys "v t"]
  2211. ["Month View" org-agenda-month-view
  2212. :active (org-agenda-check-type nil 'agenda)
  2213. :style radio :selected (eq org-agenda-current-span 'month)
  2214. :keys "v m"]
  2215. ["Year View" org-agenda-year-view
  2216. :active (org-agenda-check-type nil 'agenda)
  2217. :style radio :selected (eq org-agenda-current-span 'year)
  2218. :keys "v y"]
  2219. "--"
  2220. ["Include Diary" org-agenda-toggle-diary
  2221. :style toggle :selected org-agenda-include-diary
  2222. :active (org-agenda-check-type nil 'agenda)]
  2223. ["Include Deadlines" org-agenda-toggle-deadlines
  2224. :style toggle :selected org-agenda-include-deadlines
  2225. :active (org-agenda-check-type nil 'agenda)]
  2226. ["Use Time Grid" org-agenda-toggle-time-grid
  2227. :style toggle :selected org-agenda-use-time-grid
  2228. :active (org-agenda-check-type nil 'agenda)]
  2229. "--"
  2230. ["Show clock report" org-agenda-clockreport-mode
  2231. :style toggle :selected org-agenda-clockreport-mode
  2232. :active (org-agenda-check-type nil 'agenda)]
  2233. ["Show some entry text" org-agenda-entry-text-mode
  2234. :style toggle :selected org-agenda-entry-text-mode
  2235. :active t]
  2236. "--"
  2237. ["Show Logbook entries" org-agenda-log-mode
  2238. :style toggle :selected org-agenda-show-log
  2239. :active (org-agenda-check-type nil 'agenda)
  2240. :keys "v l (or just l)"]
  2241. ["Include archived trees" org-agenda-archives-mode
  2242. :style toggle :selected org-agenda-archives-mode :active t
  2243. :keys "v a"]
  2244. ["Include archive files" (org-agenda-archives-mode t)
  2245. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2246. :keys "v A"]
  2247. "--"
  2248. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2249. ("Filter current view"
  2250. ["with generic interface" org-agenda-filter t]
  2251. "--"
  2252. ["by category at cursor" org-agenda-filter-by-category t]
  2253. ["by tag" org-agenda-filter-by-tag t]
  2254. ["by effort" org-agenda-filter-by-effort t]
  2255. ["by regexp" org-agenda-filter-by-regexp t]
  2256. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2257. "--"
  2258. ["Remove all filtering" org-agenda-filter-remove-all t]
  2259. "--"
  2260. ["limit" org-agenda-limit-interactively t])
  2261. ["Rebuild buffer" org-agenda-redo t]
  2262. ["Write view to file" org-agenda-write t]
  2263. ["Save all Org buffers" org-save-all-org-buffers t]
  2264. "--"
  2265. ["Show original entry" org-agenda-show t]
  2266. ["Go To (other window)" org-agenda-goto t]
  2267. ["Go To (this window)" org-agenda-switch-to t]
  2268. ["Capture with cursor date" org-agenda-capture t]
  2269. ["Follow Mode" org-agenda-follow-mode
  2270. :style toggle :selected org-agenda-follow-mode :active t]
  2271. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2272. "--"
  2273. ("TODO"
  2274. ["Cycle TODO" org-agenda-todo t]
  2275. ["Next TODO set" org-agenda-todo-nextset t]
  2276. ["Previous TODO set" org-agenda-todo-previousset t]
  2277. ["Add note" org-agenda-add-note t])
  2278. ("Archive/Refile/Delete"
  2279. ["Archive default" org-agenda-archive-default t]
  2280. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2281. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2282. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2283. ["Archive subtree" org-agenda-archive t]
  2284. "--"
  2285. ["Refile" org-agenda-refile t]
  2286. "--"
  2287. ["Delete subtree" org-agenda-kill t])
  2288. ("Bulk action"
  2289. ["Mark entry" org-agenda-bulk-mark t]
  2290. ["Mark all" org-agenda-bulk-mark-all t]
  2291. ["Unmark entry" org-agenda-bulk-unmark t]
  2292. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2293. ["Toggle mark" org-agenda-bulk-toggle t]
  2294. ["Toggle all" org-agenda-bulk-toggle-all t]
  2295. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2296. ["Act on all marked" org-agenda-bulk-action t]
  2297. "--"
  2298. ("Tags and Properties"
  2299. ["Show all Tags" org-agenda-show-tags t]
  2300. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2301. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2302. "--"
  2303. ["Column View" org-columns t])
  2304. ("Deadline/Schedule"
  2305. ["Schedule" org-agenda-schedule t]
  2306. ["Set Deadline" org-agenda-deadline t]
  2307. "--"
  2308. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2309. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2310. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2311. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2312. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2313. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2314. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2315. ("Clock and Effort"
  2316. ["Clock in" org-agenda-clock-in t]
  2317. ["Clock out" org-agenda-clock-out t]
  2318. ["Clock cancel" org-agenda-clock-cancel t]
  2319. ["Goto running clock" org-clock-goto t]
  2320. "--"
  2321. ["Set Effort" org-agenda-set-effort t]
  2322. ["Change clocked effort" org-clock-modify-effort-estimate
  2323. (org-clock-is-active)])
  2324. ("Priority"
  2325. ["Set Priority" org-agenda-priority t]
  2326. ["Increase Priority" org-agenda-priority-up t]
  2327. ["Decrease Priority" org-agenda-priority-down t]
  2328. ["Show Priority" org-priority-show t])
  2329. ("Calendar/Diary"
  2330. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2331. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2332. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2333. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2334. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2335. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2336. "--"
  2337. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2338. "--"
  2339. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2340. "--"
  2341. ("MobileOrg"
  2342. ["Push Files and Views" org-mobile-push t]
  2343. ["Get Captured and Flagged" org-mobile-pull t]
  2344. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2345. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2346. "--"
  2347. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2348. "--"
  2349. ["Quit" org-agenda-quit t]
  2350. ["Exit and Release Buffers" org-agenda-exit t]
  2351. ))
  2352. ;;; Agenda undo
  2353. (defvar org-agenda-allow-remote-undo t
  2354. "Non-nil means allow remote undo from the agenda buffer.")
  2355. (defvar org-agenda-undo-has-started-in nil
  2356. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2357. (defun org-agenda-undo ()
  2358. "Undo a remote editing step in the agenda.
  2359. This undoes changes both in the agenda buffer and in the remote buffer
  2360. that have been changed along."
  2361. (interactive)
  2362. (or org-agenda-allow-remote-undo
  2363. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2364. (when (not (eq this-command last-command))
  2365. (setq org-agenda-undo-has-started-in nil
  2366. org-agenda-pending-undo-list org-agenda-undo-list))
  2367. (when (not org-agenda-pending-undo-list)
  2368. (user-error "No further undo information"))
  2369. (let* ((entry (pop org-agenda-pending-undo-list))
  2370. buf line cmd rembuf)
  2371. (setq cmd (pop entry) line (pop entry))
  2372. (setq rembuf (nth 2 entry))
  2373. (org-with-remote-undo rembuf
  2374. (while (bufferp (setq buf (pop entry)))
  2375. (when (pop entry)
  2376. (with-current-buffer buf
  2377. (let (;; (last-undo-buffer buf)
  2378. (inhibit-read-only t))
  2379. (unless (memq buf org-agenda-undo-has-started-in)
  2380. (push buf org-agenda-undo-has-started-in)
  2381. (make-local-variable 'pending-undo-list)
  2382. (undo-start))
  2383. (while (and pending-undo-list
  2384. (listp pending-undo-list)
  2385. (not (car pending-undo-list)))
  2386. (pop pending-undo-list))
  2387. (undo-more 1))))))
  2388. (org-goto-line line)
  2389. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2390. (defun org-verify-change-for-undo (l1 l2)
  2391. "Verify that a real change occurred between the undo lists L1 and L2."
  2392. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2393. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2394. (not (eq l1 l2)))
  2395. ;;; Agenda dispatch
  2396. (defvar org-agenda-restrict-begin (make-marker))
  2397. (defvar org-agenda-restrict-end (make-marker))
  2398. (defvar org-agenda-last-dispatch-buffer nil)
  2399. (defvar org-agenda-overriding-restriction nil)
  2400. (defcustom org-agenda-custom-commands-contexts nil
  2401. "Alist of custom agenda keys and contextual rules.
  2402. For example, if you have a custom agenda command \"p\" and you
  2403. want this command to be accessible only from plain text files,
  2404. use this:
  2405. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2406. Here are the available contexts definitions:
  2407. in-file: command displayed only in matching files
  2408. in-mode: command displayed only in matching modes
  2409. not-in-file: command not displayed in matching files
  2410. not-in-mode: command not displayed in matching modes
  2411. in-buffer: command displayed only in matching buffers
  2412. not-in-buffer: command not displayed in matching buffers
  2413. [function]: a custom function taking no argument
  2414. If you define several checks, the agenda command will be
  2415. accessible if there is at least one valid check.
  2416. You can also bind a key to another agenda custom command
  2417. depending on contextual rules.
  2418. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2419. Here it means: in .txt files, use \"p\" as the key for the
  2420. agenda command otherwise associated with \"q\". (The command
  2421. originally associated with \"q\" is not displayed to avoid
  2422. duplicates.)"
  2423. :version "24.3"
  2424. :group 'org-agenda-custom-commands
  2425. :type '(repeat (list :tag "Rule"
  2426. (string :tag " Agenda key")
  2427. (string :tag "Replace by command")
  2428. (repeat :tag "Available when"
  2429. (choice
  2430. (cons :tag "Condition"
  2431. (choice
  2432. (const :tag "In file" in-file)
  2433. (const :tag "Not in file" not-in-file)
  2434. (const :tag "In buffer" in-buffer)
  2435. (const :tag "Not in buffer" not-in-buffer)
  2436. (const :tag "In mode" in-mode)
  2437. (const :tag "Not in mode" not-in-mode))
  2438. (regexp))
  2439. (function :tag "Custom function"))))))
  2440. (defcustom org-agenda-max-entries nil
  2441. "Maximum number of entries to display in an agenda.
  2442. This can be nil (no limit) or an integer or an alist of agenda
  2443. types with an associated number of entries to display in this
  2444. type."
  2445. :version "24.4"
  2446. :package-version '(Org . "8.0")
  2447. :group 'org-agenda-custom-commands
  2448. :type '(choice (symbol :tag "No limit" nil)
  2449. (integer :tag "Max number of entries")
  2450. (repeat
  2451. (cons (choice :tag "Agenda type"
  2452. (const agenda)
  2453. (const todo)
  2454. (const tags)
  2455. (const search))
  2456. (integer :tag "Max number of entries")))))
  2457. (defcustom org-agenda-max-todos nil
  2458. "Maximum number of TODOs to display in an agenda.
  2459. This can be nil (no limit) or an integer or an alist of agenda
  2460. types with an associated number of entries to display in this
  2461. type."
  2462. :version "24.4"
  2463. :package-version '(Org . "8.0")
  2464. :group 'org-agenda-custom-commands
  2465. :type '(choice (symbol :tag "No limit" nil)
  2466. (integer :tag "Max number of TODOs")
  2467. (repeat
  2468. (cons (choice :tag "Agenda type"
  2469. (const agenda)
  2470. (const todo)
  2471. (const tags)
  2472. (const search))
  2473. (integer :tag "Max number of TODOs")))))
  2474. (defcustom org-agenda-max-tags nil
  2475. "Maximum number of tagged entries to display in an agenda.
  2476. This can be nil (no limit) or an integer or an alist of agenda
  2477. types with an associated number of entries to display in this
  2478. type."
  2479. :version "24.4"
  2480. :package-version '(Org . "8.0")
  2481. :group 'org-agenda-custom-commands
  2482. :type '(choice (symbol :tag "No limit" nil)
  2483. (integer :tag "Max number of tagged entries")
  2484. (repeat
  2485. (cons (choice :tag "Agenda type"
  2486. (const agenda)
  2487. (const todo)
  2488. (const tags)
  2489. (const search))
  2490. (integer :tag "Max number of tagged entries")))))
  2491. (defcustom org-agenda-max-effort nil
  2492. "Maximum cumulated effort duration for the agenda.
  2493. This can be nil (no limit) or a number of minutes (as an integer)
  2494. or an alist of agenda types with an associated number of minutes
  2495. to limit entries to in this type."
  2496. :version "24.4"
  2497. :package-version '(Org . "8.0")
  2498. :group 'org-agenda-custom-commands
  2499. :type '(choice (symbol :tag "No limit" nil)
  2500. (integer :tag "Max number of minutes")
  2501. (repeat
  2502. (cons (choice :tag "Agenda type"
  2503. (const agenda)
  2504. (const todo)
  2505. (const tags)
  2506. (const search))
  2507. (integer :tag "Max number of minutes")))))
  2508. (defvar org-agenda-keep-restricted-file-list nil)
  2509. (defvar org-keys nil)
  2510. (defvar org-match nil)
  2511. ;;;###autoload
  2512. (defun org-agenda (&optional arg keys restriction)
  2513. "Dispatch agenda commands to collect entries to the agenda buffer.
  2514. Prompts for a command to execute. Any prefix arg will be passed
  2515. on to the selected command. The default selections are:
  2516. a Call `org-agenda-list' to display the agenda for current day or week.
  2517. t Call `org-todo-list' to display the global todo list.
  2518. T Call `org-todo-list' to display the global todo list, select only
  2519. entries with a specific TODO keyword (the user gets a prompt).
  2520. m Call `org-tags-view' to display headlines with tags matching
  2521. a condition (the user is prompted for the condition).
  2522. M Like `m', but select only TODO entries, no ordinary headlines.
  2523. e Export views to associated files.
  2524. s Search entries for keywords.
  2525. S Search entries for keywords, only with TODO keywords.
  2526. / Multi occur across all agenda files and also files listed
  2527. in `org-agenda-text-search-extra-files'.
  2528. < Restrict agenda commands to buffer, subtree, or region.
  2529. Press several times to get the desired effect.
  2530. > Remove a previous restriction.
  2531. # List \"stuck\" projects.
  2532. ! Configure what \"stuck\" means.
  2533. C Configure custom agenda commands.
  2534. More commands can be added by configuring the variable
  2535. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2536. searches can be pre-defined in this way.
  2537. If the current buffer is in Org mode and visiting a file, you can also
  2538. first press `<' once to indicate that the agenda should be temporarily
  2539. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2540. Pressing `<' twice means to restrict to the current subtree or region
  2541. \(if active)."
  2542. (interactive "P")
  2543. (catch 'exit
  2544. (let* ((org-keys keys)
  2545. (prefix-descriptions nil)
  2546. (org-agenda-buffer-name org-agenda-buffer-name)
  2547. (org-agenda-window-setup (if (equal (buffer-name)
  2548. org-agenda-buffer-name)
  2549. 'current-window
  2550. org-agenda-window-setup))
  2551. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2552. (org-agenda-custom-commands
  2553. ;; normalize different versions
  2554. (delq nil
  2555. (mapcar
  2556. (lambda (x)
  2557. (cond ((stringp (cdr x))
  2558. (push x prefix-descriptions)
  2559. nil)
  2560. ((stringp (nth 1 x)) x)
  2561. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2562. (t (cons (car x) (cons "" (cdr x))))))
  2563. org-agenda-custom-commands)))
  2564. (org-agenda-custom-commands
  2565. (org-contextualize-keys
  2566. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2567. ;; (buf (current-buffer))
  2568. (bfn (buffer-file-name (buffer-base-buffer)))
  2569. entry type org-match lprops ans) ;; key
  2570. ;; Turn off restriction unless there is an overriding one,
  2571. (unless org-agenda-overriding-restriction
  2572. (unless org-agenda-keep-restricted-file-list
  2573. ;; There is a request to keep the file list in place
  2574. (put 'org-agenda-files 'org-restrict nil))
  2575. (setq org-agenda-restrict nil)
  2576. (move-marker org-agenda-restrict-begin nil)
  2577. (move-marker org-agenda-restrict-end nil))
  2578. ;; Delete old local properties
  2579. (put 'org-agenda-redo-command 'org-lprops nil)
  2580. ;; Delete previously set last-arguments
  2581. (put 'org-agenda-redo-command 'last-args nil)
  2582. ;; Remember where this call originated
  2583. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2584. (unless org-keys
  2585. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2586. org-keys (car ans)
  2587. restriction (cdr ans)))
  2588. ;; If we have sticky agenda buffers, set a name for the buffer,
  2589. ;; depending on the invoking keys. The user may still set this
  2590. ;; as a command option, which will overwrite what we do here.
  2591. (when org-agenda-sticky
  2592. (setq org-agenda-buffer-name
  2593. (format "*Org Agenda(%s)*" org-keys)))
  2594. ;; Establish the restriction, if any
  2595. (when (and (not org-agenda-overriding-restriction) restriction)
  2596. (put 'org-agenda-files 'org-restrict (list bfn))
  2597. (cond
  2598. ((eq restriction 'region)
  2599. (setq org-agenda-restrict (current-buffer))
  2600. (move-marker org-agenda-restrict-begin (region-beginning))
  2601. (move-marker org-agenda-restrict-end (region-end)))
  2602. ((eq restriction 'subtree)
  2603. (save-excursion
  2604. (setq org-agenda-restrict (current-buffer))
  2605. (org-back-to-heading t)
  2606. (move-marker org-agenda-restrict-begin (point))
  2607. (move-marker org-agenda-restrict-end
  2608. (progn (org-end-of-subtree t)))))
  2609. ((and (eq restriction 'buffer)
  2610. (or (< 1 (point-min))
  2611. (< (point-max) (1+ (buffer-size)))))
  2612. (setq org-agenda-restrict (current-buffer))
  2613. (move-marker org-agenda-restrict-begin (point-min))
  2614. (move-marker org-agenda-restrict-end (point-max)))))
  2615. ;; For example the todo list should not need it (but does...)
  2616. (cond
  2617. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2618. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2619. (progn
  2620. ;; FIXME: Is (nth 3 entry) supposed to have access (via dynvars)
  2621. ;; to some of the local variables? There's no doc about
  2622. ;; that for `org-agenda-custom-commands'.
  2623. (setq type (nth 2 entry) org-match (eval (nth 3 entry) t)
  2624. lprops (nth 4 entry))
  2625. (when org-agenda-sticky
  2626. (setq org-agenda-buffer-name
  2627. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2628. (format "*Org Agenda(%s)*" org-keys))))
  2629. (put 'org-agenda-redo-command 'org-lprops lprops)
  2630. (cl-progv
  2631. (mapcar #'car lprops)
  2632. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  2633. (pcase type
  2634. (`agenda
  2635. (org-agenda-list current-prefix-arg))
  2636. (`agenda*
  2637. (org-agenda-list current-prefix-arg nil nil t))
  2638. (`alltodo
  2639. (org-todo-list current-prefix-arg))
  2640. (`search
  2641. (org-search-view current-prefix-arg org-match nil))
  2642. (`stuck
  2643. (org-agenda-list-stuck-projects current-prefix-arg))
  2644. (`tags
  2645. (org-tags-view current-prefix-arg org-match))
  2646. (`tags-todo
  2647. (org-tags-view '(4) org-match))
  2648. (`todo
  2649. (org-todo-list org-match))
  2650. (`tags-tree
  2651. (org-check-for-org-mode)
  2652. (org-match-sparse-tree current-prefix-arg org-match))
  2653. (`todo-tree
  2654. (org-check-for-org-mode)
  2655. (org-occur (concat "^" org-outline-regexp "[ \t]*"
  2656. (regexp-quote org-match) "\\>")))
  2657. (`occur-tree
  2658. (org-check-for-org-mode)
  2659. (org-occur org-match))
  2660. ((pred functionp)
  2661. (funcall type org-match))
  2662. ;; FIXME: Will signal an error since it's not `functionp'!
  2663. ((pred fboundp) (funcall type org-match))
  2664. (_ (user-error "Invalid custom agenda command type %s" type)))))
  2665. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2666. ((equal org-keys "C")
  2667. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2668. (customize-variable 'org-agenda-custom-commands))
  2669. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2670. ((equal org-keys "s") (call-interactively 'org-search-view))
  2671. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2672. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2673. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2674. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2675. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2676. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2677. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2678. (add-hook
  2679. 'post-command-hook
  2680. (lambda ()
  2681. (unless (current-message)
  2682. (let* ((m (org-agenda-get-any-marker))
  2683. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2684. (when note
  2685. (message "FLAGGING-NOTE ([?] for more info): %s"
  2686. (org-add-props
  2687. (replace-regexp-in-string
  2688. "\\\\n" "//"
  2689. (copy-sequence note))
  2690. nil 'face 'org-warning))))))
  2691. t t))
  2692. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2693. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2694. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2695. (t (user-error "Invalid agenda key"))))))
  2696. (defvar org-agenda-multi)
  2697. (defun org-agenda-append-agenda ()
  2698. "Append another agenda view to the current one.
  2699. This function allows interactive building of block agendas.
  2700. Agenda views are separated by `org-agenda-block-separator'."
  2701. (interactive)
  2702. (unless (derived-mode-p 'org-agenda-mode)
  2703. (user-error "Can only append from within agenda buffer"))
  2704. (let ((org-agenda-multi t))
  2705. (org-agenda)
  2706. (widen)
  2707. (org-agenda-finalize)
  2708. (setq buffer-read-only t)
  2709. (org-agenda-fit-window-to-buffer)))
  2710. (defun org-agenda-normalize-custom-commands (cmds)
  2711. "Normalize custom commands CMDS."
  2712. (delq nil
  2713. (mapcar
  2714. (lambda (x)
  2715. (cond ((stringp (cdr x)) nil)
  2716. ((stringp (nth 1 x)) x)
  2717. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2718. (t (cons (car x) (cons "" (cdr x))))))
  2719. cmds)))
  2720. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2721. "The user interface for selecting an agenda command."
  2722. (catch 'exit
  2723. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2724. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2725. (region-p (org-region-active-p))
  2726. (custom org-agenda-custom-commands)
  2727. (selstring "")
  2728. restriction second-time
  2729. c entry key type match prefixes rmheader header-end custom1 desc
  2730. line lines left right n n1)
  2731. (save-window-excursion
  2732. (delete-other-windows)
  2733. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2734. (erase-buffer)
  2735. (insert (eval-when-compile
  2736. (let ((header
  2737. (copy-sequence
  2738. "Press key for an agenda command:
  2739. -------------------------------- < Buffer, subtree/region restriction
  2740. a Agenda for current week or day > Remove restriction
  2741. t List of all TODO entries e Export agenda views
  2742. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2743. s Search for keywords M Like m, but only TODO entries
  2744. / Multi-occur S Like s, but only TODO entries
  2745. ? Find :FLAGGED: entries C Configure custom agenda commands
  2746. * Toggle sticky agenda views # List stuck projects (!=configure)
  2747. "))
  2748. (start 0))
  2749. (while (string-match
  2750. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2751. header start)
  2752. (setq start (match-end 0))
  2753. (add-text-properties (match-beginning 2) (match-end 2)
  2754. '(face bold) header))
  2755. header)))
  2756. (setq header-end (point-marker))
  2757. (while t
  2758. (setq custom1 custom)
  2759. (when (eq rmheader t)
  2760. (org-goto-line 1)
  2761. (re-search-forward ":" nil t)
  2762. (delete-region (match-end 0) (point-at-eol))
  2763. (forward-char 1)
  2764. (looking-at "-+")
  2765. (delete-region (match-end 0) (point-at-eol))
  2766. (move-marker header-end (match-end 0)))
  2767. (goto-char header-end)
  2768. (delete-region (point) (point-max))
  2769. ;; Produce all the lines that describe custom commands and prefixes
  2770. (setq lines nil)
  2771. (while (setq entry (pop custom1))
  2772. (setq key (car entry) desc (nth 1 entry)
  2773. type (nth 2 entry)
  2774. match (nth 3 entry))
  2775. (if (> (length key) 1)
  2776. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2777. (setq line
  2778. (format
  2779. "%-4s%-14s"
  2780. (org-add-props (copy-sequence key)
  2781. '(face bold))
  2782. (cond
  2783. ((string-match "\\S-" desc) desc)
  2784. ((eq type 'agenda) "Agenda for current week or day")
  2785. ((eq type 'agenda*) "Appointments for current week or day")
  2786. ((eq type 'alltodo) "List of all TODO entries")
  2787. ((eq type 'search) "Word search")
  2788. ((eq type 'stuck) "List of stuck projects")
  2789. ((eq type 'todo) "TODO keyword")
  2790. ((eq type 'tags) "Tags query")
  2791. ((eq type 'tags-todo) "Tags (TODO)")
  2792. ((eq type 'tags-tree) "Tags tree")
  2793. ((eq type 'todo-tree) "TODO kwd tree")
  2794. ((eq type 'occur-tree) "Occur tree")
  2795. ((functionp type) (if (symbolp type)
  2796. (symbol-name type)
  2797. "Lambda expression"))
  2798. (t "???"))))
  2799. (cond
  2800. ((not (org-string-nw-p match)) nil)
  2801. (org-agenda-menu-show-matcher
  2802. (setq line
  2803. (concat line ": "
  2804. (cond
  2805. ((stringp match)
  2806. (propertize match 'face 'org-warning))
  2807. ((listp type)
  2808. (format "set of %d commands" (length type)))))))
  2809. (t
  2810. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2811. (push line lines)))
  2812. (setq lines (nreverse lines))
  2813. (when prefixes
  2814. (mapc (lambda (x)
  2815. (push
  2816. (format "%s %s"
  2817. (org-add-props (char-to-string x)
  2818. nil 'face 'bold)
  2819. (or (cdr (assoc (concat selstring
  2820. (char-to-string x))
  2821. prefix-descriptions))
  2822. "Prefix key"))
  2823. lines))
  2824. prefixes))
  2825. ;; Check if we should display in two columns
  2826. (if org-agenda-menu-two-columns
  2827. (progn
  2828. (setq n (length lines)
  2829. n1 (+ (/ n 2) (mod n 2))
  2830. right (nthcdr n1 lines)
  2831. left (copy-sequence lines))
  2832. (setcdr (nthcdr (1- n1) left) nil))
  2833. (setq left lines right nil))
  2834. (while left
  2835. (insert "\n" (pop left))
  2836. (when right
  2837. (if (< (current-column) 40)
  2838. (move-to-column 40 t)
  2839. (insert " "))
  2840. (insert (pop right))))
  2841. ;; Make the window the right size
  2842. (goto-char (point-min))
  2843. (if second-time
  2844. (when (not (pos-visible-in-window-p (point-max)))
  2845. (org-fit-window-to-buffer))
  2846. (setq second-time t)
  2847. (org-fit-window-to-buffer))
  2848. ;; Hint to navigation if window too small for all information
  2849. (setq header-line-format
  2850. (when (not (pos-visible-in-window-p (point-max)))
  2851. "Use C-v, M-v, C-n or C-p to navigate."))
  2852. ;; Ask for selection
  2853. (cl-loop
  2854. do (progn
  2855. (message "Press key for agenda command%s:"
  2856. (if (or restrict-ok org-agenda-overriding-restriction)
  2857. (if org-agenda-overriding-restriction
  2858. " (restriction lock active)"
  2859. (if restriction
  2860. (format " (restricted to %s)" restriction)
  2861. " (unrestricted)"))
  2862. ""))
  2863. (setq c (read-char-exclusive)))
  2864. until (not (memq c '(14 16 22 134217846)))
  2865. do (org-scroll c))
  2866. (message "")
  2867. (cond
  2868. ((assoc (char-to-string c) custom)
  2869. (setq selstring (concat selstring (char-to-string c)))
  2870. (throw 'exit (cons selstring restriction)))
  2871. ((memq c prefixes)
  2872. (setq selstring (concat selstring (char-to-string c))
  2873. prefixes nil
  2874. rmheader (or rmheader t)
  2875. custom (delq nil (mapcar
  2876. (lambda (x)
  2877. (if (or (= (length (car x)) 1)
  2878. (/= (string-to-char (car x)) c))
  2879. nil
  2880. (cons (substring (car x) 1) (cdr x))))
  2881. custom))))
  2882. ((eq c ?*)
  2883. (call-interactively 'org-toggle-sticky-agenda)
  2884. (sit-for 2))
  2885. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2886. (message "Restriction is only possible in Org buffers")
  2887. (ding) (sit-for 1))
  2888. ((eq c ?1)
  2889. (org-agenda-remove-restriction-lock 'noupdate)
  2890. (setq restriction 'buffer))
  2891. ((eq c ?0)
  2892. (org-agenda-remove-restriction-lock 'noupdate)
  2893. (setq restriction (if region-p 'region 'subtree)))
  2894. ((eq c ?<)
  2895. (org-agenda-remove-restriction-lock 'noupdate)
  2896. (setq restriction
  2897. (cond
  2898. ((eq restriction 'buffer)
  2899. (if region-p 'region 'subtree))
  2900. ((memq restriction '(subtree region))
  2901. nil)
  2902. (t 'buffer))))
  2903. ((eq c ?>)
  2904. (org-agenda-remove-restriction-lock 'noupdate)
  2905. (setq restriction nil))
  2906. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2907. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2908. ((and (> (length selstring) 0) (eq c ?\d))
  2909. (delete-window)
  2910. (org-agenda-get-restriction-and-command prefix-descriptions))
  2911. ((equal c ?q) (error "Abort"))
  2912. (t (user-error "Invalid key %c" c))))))))
  2913. (defun org-agenda-fit-window-to-buffer ()
  2914. "Fit the window to the buffer size."
  2915. (and (memq org-agenda-window-setup '(reorganize-frame))
  2916. (fboundp 'fit-window-to-buffer)
  2917. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2918. (= (car org-agenda-window-frame-fractions) 1.0))
  2919. (delete-other-windows)
  2920. (org-fit-window-to-buffer
  2921. nil
  2922. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2923. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2924. (defvar org-cmd nil)
  2925. (defvar org-agenda-overriding-cmd nil)
  2926. (defvar org-agenda-overriding-arguments nil)
  2927. (defvar org-agenda-overriding-cmd-arguments nil)
  2928. (defun org-let (list &rest body) ;FIXME: So many kittens are suffering here.
  2929. (declare (indent 1) (obsolete cl-progv "Mar 2021"))
  2930. (eval (cons 'let (cons list body))))
  2931. (defun org-let2 (list1 list2 &rest body) ;FIXME: Where did our karma go?
  2932. (declare (indent 2) (obsolete cl-progv "Mar 2021"))
  2933. (eval (cons 'let (cons list1 (list (cons 'let (cons list2 body)))))))
  2934. (defun org-agenda-run-series (name series)
  2935. "Run agenda NAME as a SERIES of agenda commands."
  2936. (let* ((gprops (nth 1 series))
  2937. (gvars (mapcar #'car gprops))
  2938. (gvals (mapcar (lambda (binding) (eval (cadr binding) t)) gprops)))
  2939. (cl-progv gvars gvals (org-agenda-prepare name))
  2940. ;; We need to reset agenda markers here, because when constructing a
  2941. ;; block agenda, the individual blocks do not do that.
  2942. (org-agenda-reset-markers)
  2943. (with-no-warnings
  2944. (defvar match)) ;Used via the `eval' below.
  2945. (let* ((org-agenda-multi t)
  2946. ;; FIXME: Redo should contain lists of (FUNS . ARGS) rather
  2947. ;; than expressions, so you don't need to `quote' the args
  2948. ;; and you just need to `apply' instead of `eval' when using it.
  2949. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2950. (cmds (car series))
  2951. match
  2952. org-cmd type lprops)
  2953. (while (setq org-cmd (pop cmds))
  2954. (setq type (car org-cmd))
  2955. (setq match (eval (nth 1 org-cmd) t))
  2956. (setq lprops (nth 2 org-cmd))
  2957. (let ((org-agenda-overriding-arguments
  2958. (if (eq org-agenda-overriding-cmd org-cmd)
  2959. (or org-agenda-overriding-arguments
  2960. org-agenda-overriding-cmd-arguments)))
  2961. (lvars (mapcar #'car lprops))
  2962. (lvals (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)))
  2963. (cl-progv (append gvars lvars) (append gvals lvals)
  2964. (pcase type
  2965. (`agenda
  2966. (call-interactively 'org-agenda-list))
  2967. (`agenda*
  2968. (funcall 'org-agenda-list nil nil t))
  2969. (`alltodo
  2970. (call-interactively 'org-todo-list))
  2971. (`search
  2972. (org-search-view current-prefix-arg match nil))
  2973. (`stuck
  2974. (call-interactively 'org-agenda-list-stuck-projects))
  2975. (`tags
  2976. (org-tags-view current-prefix-arg match))
  2977. (`tags-todo
  2978. (org-tags-view '(4) match))
  2979. (`todo
  2980. (org-todo-list match))
  2981. ((pred fboundp)
  2982. (funcall type match))
  2983. (_ (error "Invalid type in command series"))))))
  2984. (widen)
  2985. (let ((inhibit-read-only t))
  2986. (add-text-properties (point-min) (point-max)
  2987. `(org-series t org-series-redo-cmd ,redo)))
  2988. (setq org-agenda-redo-command redo)
  2989. (goto-char (point-min)))
  2990. (org-agenda-fit-window-to-buffer)
  2991. (cl-progv gvars gvals (org-agenda-finalize))))
  2992. (defun org-agenda--split-plist (plist)
  2993. ;; We could/should arguably use `map-keys' and `map-values'.
  2994. (let (keys vals)
  2995. (while plist
  2996. (push (pop plist) keys)
  2997. (push (pop plist) vals))
  2998. (cons (nreverse keys) (nreverse vals))))
  2999. ;;;###autoload
  3000. (defmacro org-batch-agenda (cmd-key &rest parameters)
  3001. "Run an agenda command in batch mode and send the result to STDOUT.
  3002. If CMD-KEY is a string of length 1, it is used as a key in
  3003. `org-agenda-custom-commands' and triggers this command. If it is a
  3004. longer string it is used as a tags/todo match string.
  3005. Parameters are alternating variable names and values that will be bound
  3006. before running the agenda command."
  3007. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3008. `(org--batch-agenda ,cmd-key ',vars (list ,@exps))))
  3009. (defun org--batch-agenda (cmd-key vars vals)
  3010. ;; `org-batch-agenda' is a macro because every other "parameter" is
  3011. ;; a variable name rather than an expression to evaluate. Yuck!
  3012. (cl-progv vars vals
  3013. (let (org-agenda-sticky)
  3014. (if (> (length cmd-key) 1)
  3015. (org-tags-view nil cmd-key)
  3016. (org-agenda nil cmd-key))))
  3017. (set-buffer org-agenda-buffer-name)
  3018. (princ (buffer-string)))
  3019. (defvar org-agenda-info nil)
  3020. ;;;###autoload
  3021. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  3022. "Run an agenda command in batch mode and send the result to STDOUT.
  3023. If CMD-KEY is a string of length 1, it is used as a key in
  3024. `org-agenda-custom-commands' and triggers this command. If it is a
  3025. longer string it is used as a tags/todo match string.
  3026. Parameters are alternating variable names and values that will be bound
  3027. before running the agenda command.
  3028. The output gives a line for each selected agenda item. Each
  3029. item is a list of comma-separated values, like this:
  3030. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  3031. category The category of the item
  3032. head The headline, without TODO kwd, TAGS and PRIORITY
  3033. type The type of the agenda entry, can be
  3034. todo selected in TODO match
  3035. tagsmatch selected in tags match
  3036. diary imported from diary
  3037. deadline a deadline on given date
  3038. scheduled scheduled on given date
  3039. timestamp entry has timestamp on given date
  3040. closed entry was closed on given date
  3041. upcoming-deadline warning about deadline
  3042. past-scheduled forwarded scheduled item
  3043. block entry has date block including g. date
  3044. todo The todo keyword, if any
  3045. tags All tags including inherited ones, separated by colons
  3046. date The relevant date, like 2007-2-14
  3047. time The time, like 15:00-16:50
  3048. extra String with extra planning info
  3049. priority-l The priority letter if any was given
  3050. priority-n The computed numerical priority
  3051. agenda-day The day in the agenda where this is listed"
  3052. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3053. `(org--batch-agenda-csv ,cmd-key ',vars (list ,@exps))))
  3054. (defun org--batch-agenda-csv (cmd-key vars vals)
  3055. ;; `org-batch-agenda-csv' is a macro because every other "parameter" is
  3056. ;; a variable name rather than an expression to evaluate. Yuck!
  3057. (let ((org-agenda-remove-tags t))
  3058. (cl-progv vars vals
  3059. ;; FIXME: Shouldn't this be 1 (see commit 10173ad6d610b)?
  3060. (if (> (length cmd-key) 2)
  3061. (org-tags-view nil cmd-key)
  3062. (org-agenda nil cmd-key))))
  3063. (set-buffer org-agenda-buffer-name)
  3064. (let ((lines (org-split-string (buffer-string) "\n")))
  3065. (dolist (line lines)
  3066. (when (get-text-property 0 'org-category line)
  3067. (setq org-agenda-info
  3068. (org-fix-agenda-info (text-properties-at 0 line)))
  3069. (princ
  3070. (mapconcat #'org-agenda-export-csv-mapper
  3071. '(org-category txt type todo tags date time extra
  3072. priority-letter priority agenda-day)
  3073. ","))
  3074. (princ "\n")))))
  3075. (defun org-fix-agenda-info (props)
  3076. "Make sure all properties on an agenda item have a canonical form.
  3077. This ensures the export commands can easily use it."
  3078. (let (tmp re)
  3079. (when (setq tmp (plist-get props 'tags))
  3080. (setq props (plist-put props 'tags (mapconcat #'identity tmp ":"))))
  3081. (when (setq tmp (plist-get props 'date))
  3082. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3083. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3084. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3085. (setq tmp (calendar-date-string tmp)))
  3086. (setq props (plist-put props 'date tmp)))
  3087. (when (setq tmp (plist-get props 'day))
  3088. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3089. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3090. (setq tmp (calendar-date-string tmp)))
  3091. (setq props (plist-put props 'day tmp))
  3092. (setq props (plist-put props 'agenda-day tmp)))
  3093. (when (setq tmp (plist-get props 'txt))
  3094. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3095. (plist-put props 'priority-letter (match-string 1 tmp))
  3096. (setq tmp (replace-match "" t t tmp)))
  3097. (when (and (setq re (plist-get props 'org-todo-regexp))
  3098. (setq re (concat "\\`\\.*" re " ?"))
  3099. (let ((case-fold-search nil)) (string-match re tmp)))
  3100. (plist-put props 'todo (match-string 1 tmp))
  3101. (setq tmp (replace-match "" t t tmp)))
  3102. (plist-put props 'txt tmp)))
  3103. props)
  3104. (defun org-agenda-export-csv-mapper (prop)
  3105. (let ((res (plist-get org-agenda-info prop)))
  3106. (setq res
  3107. (cond
  3108. ((not res) "")
  3109. ((stringp res) res)
  3110. (t (prin1-to-string res))))
  3111. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3112. ;;;###autoload
  3113. (defun org-store-agenda-views (&rest _parameters)
  3114. "Store agenda views."
  3115. (interactive)
  3116. (org--batch-store-agenda-views nil nil))
  3117. ;;;###autoload
  3118. (defmacro org-batch-store-agenda-views (&rest parameters)
  3119. "Run all custom agenda commands that have a file argument."
  3120. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3121. `(org--batch-store-agenda-views ',vars (list ,@exps))))
  3122. (defun org--batch-store-agenda-views (vars vals)
  3123. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3124. (pop-up-frames nil)
  3125. (dir default-directory)
  3126. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3127. (save-window-excursion
  3128. (while cmds
  3129. (setq cmd (pop cmds)
  3130. thiscmdkey (car cmd)
  3131. thiscmdcmd (cdr cmd)
  3132. match (nth 2 thiscmdcmd)
  3133. bufname (if org-agenda-sticky
  3134. (or (and (stringp match)
  3135. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3136. (format "*Org Agenda(%s)*" thiscmdkey))
  3137. org-agenda-buffer-name)
  3138. cmd-or-set (nth 2 cmd)
  3139. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3140. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3141. (if (stringp files) (setq files (list files)))
  3142. (when files
  3143. (let* ((opts (append org-agenda-exporter-settings opts))
  3144. (vars (append (mapcar #'car opts) vars))
  3145. (vals (append (mapcar (lambda (binding) (eval (cadr binding) t))
  3146. opts)
  3147. vals)))
  3148. (cl-progv vars vals
  3149. (org-agenda nil thiscmdkey))
  3150. (set-buffer bufname)
  3151. (while files
  3152. (cl-progv vars vals
  3153. (org-agenda-write (expand-file-name (pop files) dir)
  3154. nil t bufname))))
  3155. (and (get-buffer bufname)
  3156. (kill-buffer bufname)))))))
  3157. (defvar org-agenda-current-span nil
  3158. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3159. (defun org-agenda-mark-header-line (pos)
  3160. "Mark the line at POS as an agenda structure header."
  3161. (save-excursion
  3162. (goto-char pos)
  3163. (put-text-property (point-at-bol) (point-at-eol)
  3164. 'org-agenda-structural-header t)
  3165. (when org-agenda-title-append
  3166. (put-text-property (point-at-bol) (point-at-eol)
  3167. 'org-agenda-title-append org-agenda-title-append))))
  3168. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3169. (defvar org-agenda-write-buffer-name "Agenda View")
  3170. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3171. "Write the current buffer (an agenda view) as a file.
  3172. Depending on the extension of the file name, plain text (.txt),
  3173. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3174. If the extension is .ics, translate visible agenda into iCalendar
  3175. format. If the extension is .org, collect all subtrees
  3176. corresponding to the agenda entries and add them in an .org file.
  3177. With prefix argument OPEN, open the new file immediately. If
  3178. NOSETTINGS is given, do not scope the settings of
  3179. `org-agenda-exporter-settings' into the export commands. This is
  3180. used when the settings have already been scoped and we do not
  3181. wish to overrule other, higher priority settings. If
  3182. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3183. the agenda to write."
  3184. (interactive "FWrite agenda to file: \nP")
  3185. (if (or (not (file-writable-p file))
  3186. (and (file-exists-p file)
  3187. (if (called-interactively-p 'any)
  3188. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3189. (user-error "Cannot write agenda to file %s" file))
  3190. (cl-progv
  3191. (if nosettings nil (mapcar #'car org-agenda-exporter-settings))
  3192. (if nosettings nil (mapcar (lambda (binding) (eval (cadr binding) t))
  3193. org-agenda-exporter-settings))
  3194. (save-excursion
  3195. (save-window-excursion
  3196. (let ((bs (copy-sequence (buffer-string)))
  3197. (extension (file-name-extension file))
  3198. (default-directory (file-name-directory file))
  3199. ) ;; beg content
  3200. (with-temp-buffer
  3201. (rename-buffer org-agenda-write-buffer-name t)
  3202. (set-buffer-modified-p nil)
  3203. (insert bs)
  3204. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3205. (run-hooks 'org-agenda-before-write-hook)
  3206. (cond
  3207. ((bound-and-true-p org-mobile-creating-agendas)
  3208. (org-mobile-write-agenda-for-mobile file))
  3209. ((string= "org" extension)
  3210. (let (content p m message-log-max)
  3211. (goto-char (point-min))
  3212. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3213. (goto-char p)
  3214. (setq m (get-text-property (point) 'org-hd-marker))
  3215. (when m
  3216. (push (with-current-buffer (marker-buffer m)
  3217. (goto-char m)
  3218. (org-copy-subtree 1 nil t t)
  3219. org-subtree-clip)
  3220. content)))
  3221. (find-file file)
  3222. (erase-buffer)
  3223. (dolist (s content) (org-paste-subtree 1 s))
  3224. (write-file file)
  3225. (kill-buffer (current-buffer))
  3226. (message "Org file written to %s" file)))
  3227. ((member extension '("html" "htm"))
  3228. (or (require 'htmlize nil t)
  3229. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3230. (declare-function htmlize-buffer "htmlize" (&optional buffer))
  3231. (set-buffer (htmlize-buffer (current-buffer)))
  3232. (when org-agenda-export-html-style
  3233. ;; replace <style> section with org-agenda-export-html-style
  3234. (goto-char (point-min))
  3235. (kill-region (- (search-forward "<style") 6)
  3236. (search-forward "</style>"))
  3237. (insert org-agenda-export-html-style))
  3238. (write-file file)
  3239. (kill-buffer (current-buffer))
  3240. (message "HTML written to %s" file))
  3241. ((string= "ps" extension)
  3242. (require 'ps-print)
  3243. (ps-print-buffer-with-faces file)
  3244. (message "Postscript written to %s" file))
  3245. ((string= "pdf" extension)
  3246. (require 'ps-print)
  3247. (ps-print-buffer-with-faces
  3248. (concat (file-name-sans-extension file) ".ps"))
  3249. (call-process "ps2pdf" nil nil nil
  3250. (expand-file-name
  3251. (concat (file-name-sans-extension file) ".ps"))
  3252. (expand-file-name file))
  3253. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3254. (message "PDF written to %s" file))
  3255. ((string= "ics" extension)
  3256. (require 'ox-icalendar)
  3257. (declare-function org-icalendar-export-current-agenda
  3258. "ox-icalendar" (file))
  3259. (org-icalendar-export-current-agenda (expand-file-name file)))
  3260. (t
  3261. (let ((bs (buffer-string)))
  3262. (find-file file)
  3263. (erase-buffer)
  3264. (insert bs)
  3265. (save-buffer 0)
  3266. (kill-buffer (current-buffer))
  3267. (message "Plain text written to %s" file))))))))
  3268. (set-buffer (or agenda-bufname
  3269. ;; FIXME: I'm pretty sure called-interactively-p
  3270. ;; doesn't do what we want here!
  3271. (and (called-interactively-p 'any) (buffer-name))
  3272. org-agenda-buffer-name)))
  3273. (when open (org-open-file file)))
  3274. (defun org-agenda-remove-marked-text (property &optional value)
  3275. "Delete all text marked with VALUE of PROPERTY.
  3276. VALUE defaults to t."
  3277. (let (beg)
  3278. (setq value (or value t))
  3279. (while (setq beg (text-property-any (point-min) (point-max)
  3280. property value))
  3281. (delete-region
  3282. beg (or (next-single-property-change beg property)
  3283. (point-max))))))
  3284. (defun org-agenda-add-entry-text ()
  3285. "Add entry text to agenda lines.
  3286. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3287. entry text following headings shown in the agenda.
  3288. Drawers will be excluded, also the line with scheduling/deadline info."
  3289. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3290. (not (bound-and-true-p org-mobile-creating-agendas)))
  3291. (let (m txt)
  3292. (goto-char (point-min))
  3293. (while (not (eobp))
  3294. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3295. (beginning-of-line 2)
  3296. (setq txt (org-agenda-get-some-entry-text
  3297. m org-agenda-add-entry-text-maxlines " > "))
  3298. (end-of-line 1)
  3299. (if (string-match "\\S-" txt)
  3300. (insert "\n" txt)
  3301. (or (eobp) (forward-char 1))))))))
  3302. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3303. &rest keep)
  3304. "Extract entry text from MARKER, at most N-LINES lines.
  3305. This will ignore drawers etc, just get the text.
  3306. If INDENT is given, prefix every line with this string. If KEEP is
  3307. given, it is a list of symbols, defining stuff that should not be
  3308. removed from the entry content. Currently only `planning' is allowed here."
  3309. (let (txt drawer-re kwd-time-re ind)
  3310. (save-excursion
  3311. (with-current-buffer (marker-buffer marker)
  3312. (if (not (derived-mode-p 'org-mode))
  3313. (setq txt "")
  3314. (org-with-wide-buffer
  3315. (goto-char marker)
  3316. (end-of-line 1)
  3317. (setq txt (buffer-substring
  3318. (min (1+ (point)) (point-max))
  3319. (progn (outline-next-heading) (point)))
  3320. drawer-re org-drawer-regexp
  3321. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3322. ".*\n?"))
  3323. (with-temp-buffer
  3324. (insert txt)
  3325. (when org-agenda-add-entry-text-descriptive-links
  3326. (goto-char (point-min))
  3327. (while (org-activate-links (point-max))
  3328. (goto-char (match-end 0))))
  3329. (goto-char (point-min))
  3330. (while (re-search-forward org-link-bracket-re (point-max) t)
  3331. (set-text-properties (match-beginning 0) (match-end 0)
  3332. nil))
  3333. (goto-char (point-min))
  3334. (while (re-search-forward drawer-re nil t)
  3335. (delete-region
  3336. (match-beginning 0)
  3337. (progn (re-search-forward
  3338. "^[ \t]*:END:.*\n?" nil 'move)
  3339. (point))))
  3340. (unless (member 'planning keep)
  3341. (goto-char (point-min))
  3342. (while (re-search-forward kwd-time-re nil t)
  3343. (replace-match "")))
  3344. (goto-char (point-min))
  3345. (when org-agenda-entry-text-exclude-regexps
  3346. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3347. (while (setq re (pop re-list))
  3348. (goto-char (point-min))
  3349. (while (re-search-forward re nil t)
  3350. (replace-match "")))))
  3351. (goto-char (point-max))
  3352. (skip-chars-backward " \t\n")
  3353. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3354. ;; find and remove min common indentation
  3355. (goto-char (point-min))
  3356. (untabify (point-min) (point-max))
  3357. (setq ind (current-indentation))
  3358. (while (not (eobp))
  3359. (unless (looking-at "[ \t]*$")
  3360. (setq ind (min ind (current-indentation))))
  3361. (beginning-of-line 2))
  3362. (goto-char (point-min))
  3363. (while (not (eobp))
  3364. (unless (looking-at "[ \t]*$")
  3365. (move-to-column ind)
  3366. (delete-region (point-at-bol) (point)))
  3367. (beginning-of-line 2))
  3368. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3369. (goto-char (point-min))
  3370. (when indent
  3371. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3372. (replace-match indent t t)))
  3373. (goto-char (point-min))
  3374. (while (looking-at "[ \t]*\n") (replace-match ""))
  3375. (goto-char (point-max))
  3376. (when (> (org-current-line)
  3377. n-lines)
  3378. (org-goto-line (1+ n-lines))
  3379. (backward-char 1))
  3380. (setq txt (buffer-substring (point-min) (point))))))))
  3381. txt))
  3382. (defun org-check-for-org-mode ()
  3383. "Make sure current buffer is in Org mode. Error if not."
  3384. (or (derived-mode-p 'org-mode)
  3385. (error "Cannot execute Org agenda command on buffer in %s"
  3386. major-mode)))
  3387. ;;; Agenda prepare and finalize
  3388. (defvar org-agenda-multi nil) ; dynamically scoped
  3389. (defvar org-agenda-pre-window-conf nil)
  3390. (defvar org-agenda-columns-active nil)
  3391. (defvar org-agenda-name nil)
  3392. (defvar org-agenda-tag-filter nil)
  3393. (defvar org-agenda-category-filter nil)
  3394. (defvar org-agenda-regexp-filter nil)
  3395. (defvar org-agenda-effort-filter nil)
  3396. (defvar org-agenda-top-headline-filter nil)
  3397. (defvar org-agenda-represented-categories nil
  3398. "Cache for the list of all categories in the agenda.")
  3399. (defvar org-agenda-represented-tags nil
  3400. "Cache for the list of all categories in the agenda.")
  3401. (defvar org-agenda-tag-filter-preset nil
  3402. "A preset of the tags filter used for secondary agenda filtering.
  3403. This must be a list of strings, each string must be a single tag preceded
  3404. by \"+\" or \"-\".
  3405. This variable should not be set directly, but agenda custom commands can
  3406. bind it in the options section. The preset filter is a global property of
  3407. the entire agenda view. In a block agenda, it will not work reliably to
  3408. define a filter for one of the individual blocks. You need to set it in
  3409. the global options and expect it to be applied to the entire view.")
  3410. (defconst org-agenda-filter-variables
  3411. '((category . org-agenda-category-filter)
  3412. (tag . org-agenda-tag-filter)
  3413. (effort . org-agenda-effort-filter)
  3414. (regexp . org-agenda-regexp-filter))
  3415. "Alist of filter types and associated variables")
  3416. (defun org-agenda-filter-any ()
  3417. "Is any filter active?"
  3418. (cl-some (lambda (x)
  3419. (or (symbol-value (cdr x))
  3420. (get :preset-filter x)))
  3421. org-agenda-filter-variables))
  3422. (defvar org-agenda-category-filter-preset nil
  3423. "A preset of the category filter used for secondary agenda filtering.
  3424. This must be a list of strings, each string must be a single category
  3425. preceded by \"+\" or \"-\".
  3426. This variable should not be set directly, but agenda custom commands can
  3427. bind it in the options section. The preset filter is a global property of
  3428. the entire agenda view. In a block agenda, it will not work reliably to
  3429. define a filter for one of the individual blocks. You need to set it in
  3430. the global options and expect it to be applied to the entire view.")
  3431. (defvar org-agenda-regexp-filter-preset nil
  3432. "A preset of the regexp filter used for secondary agenda filtering.
  3433. This must be a list of strings, each string must be a single regexp
  3434. preceded by \"+\" or \"-\".
  3435. This variable should not be set directly, but agenda custom commands can
  3436. bind it in the options section. The preset filter is a global property of
  3437. the entire agenda view. In a block agenda, it will not work reliably to
  3438. define a filter for one of the individual blocks. You need to set it in
  3439. the global options and expect it to be applied to the entire view.")
  3440. (defvar org-agenda-effort-filter-preset nil
  3441. "A preset of the effort condition used for secondary agenda filtering.
  3442. This must be a list of strings, each string must be a single regexp
  3443. preceded by \"+\" or \"-\".
  3444. This variable should not be set directly, but agenda custom commands can
  3445. bind it in the options section. The preset filter is a global property of
  3446. the entire agenda view. In a block agenda, it will not work reliably to
  3447. define a filter for one of the individual blocks. You need to set it in
  3448. the global options and expect it to be applied to the entire view.")
  3449. (defun org-agenda-use-sticky-p ()
  3450. "Return non-nil if an agenda buffer named
  3451. `org-agenda-buffer-name' exists and should be shown instead of
  3452. generating a new one."
  3453. (and
  3454. ;; turned off by user
  3455. org-agenda-sticky
  3456. ;; For multi-agenda buffer already exists
  3457. (not org-agenda-multi)
  3458. ;; buffer found
  3459. (get-buffer org-agenda-buffer-name)
  3460. ;; C-u parameter is same as last call
  3461. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3462. (and
  3463. (equal current-prefix-arg
  3464. org-agenda-last-prefix-arg)
  3465. ;; In case user turned stickiness on, while having existing
  3466. ;; Agenda buffer active, don't reuse that buffer, because it
  3467. ;; does not have org variables local
  3468. org-agenda-this-buffer-is-sticky))))
  3469. (defvar org-agenda-buffer-tmp-name nil)
  3470. (defun org-agenda--get-buffer-name (sticky-name)
  3471. (or org-agenda-buffer-tmp-name
  3472. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3473. sticky-name
  3474. "*Org Agenda*"))
  3475. (defun org-agenda-prepare-window (abuf filter-alist)
  3476. "Setup agenda buffer in the window.
  3477. ABUF is the buffer for the agenda window.
  3478. FILTER-ALIST is an alist of filters we need to apply when
  3479. `org-agenda-persistent-filter' is non-nil."
  3480. (let* ((awin (get-buffer-window abuf)) wconf)
  3481. (cond
  3482. ((equal (current-buffer) abuf) nil)
  3483. (awin (select-window awin))
  3484. ((not (setq wconf (current-window-configuration))))
  3485. ((eq org-agenda-window-setup 'current-window)
  3486. (pop-to-buffer-same-window abuf))
  3487. ((eq org-agenda-window-setup 'other-window)
  3488. (org-switch-to-buffer-other-window abuf))
  3489. ((eq org-agenda-window-setup 'other-frame)
  3490. (switch-to-buffer-other-frame abuf))
  3491. ((eq org-agenda-window-setup 'other-tab)
  3492. (if (fboundp 'switch-to-buffer-other-tab)
  3493. (switch-to-buffer-other-tab abuf)
  3494. (user-error "Your version of Emacs does not have tab bar support")))
  3495. ((eq org-agenda-window-setup 'only-window)
  3496. (delete-other-windows)
  3497. (pop-to-buffer-same-window abuf))
  3498. ((eq org-agenda-window-setup 'reorganize-frame)
  3499. (delete-other-windows)
  3500. (org-switch-to-buffer-other-window abuf)))
  3501. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3502. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3503. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3504. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3505. ;; Additional test in case agenda is invoked from within agenda
  3506. ;; buffer via elisp link.
  3507. (unless (equal (current-buffer) abuf)
  3508. (pop-to-buffer-same-window abuf))
  3509. (setq org-agenda-pre-window-conf
  3510. (or wconf org-agenda-pre-window-conf))))
  3511. (defun org-agenda-prepare (&optional name)
  3512. (let ((filter-alist (when org-agenda-persistent-filter
  3513. (with-current-buffer
  3514. (get-buffer-create org-agenda-buffer-name)
  3515. `((tag . ,org-agenda-tag-filter)
  3516. (re . ,org-agenda-regexp-filter)
  3517. (effort . ,org-agenda-effort-filter)
  3518. (cat . ,org-agenda-category-filter))))))
  3519. (if (org-agenda-use-sticky-p)
  3520. (progn
  3521. (put 'org-agenda-tag-filter :preset-filter nil)
  3522. (put 'org-agenda-category-filter :preset-filter nil)
  3523. (put 'org-agenda-regexp-filter :preset-filter nil)
  3524. (put 'org-agenda-effort-filter :preset-filter nil)
  3525. ;; Popup existing buffer
  3526. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3527. filter-alist)
  3528. (message "Sticky Agenda buffer, use `r' to refresh")
  3529. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3530. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3531. (setq org-todo-keywords-for-agenda nil)
  3532. (put 'org-agenda-tag-filter :preset-filter
  3533. org-agenda-tag-filter-preset)
  3534. (put 'org-agenda-category-filter :preset-filter
  3535. org-agenda-category-filter-preset)
  3536. (put 'org-agenda-regexp-filter :preset-filter
  3537. org-agenda-regexp-filter-preset)
  3538. (put 'org-agenda-effort-filter :preset-filter
  3539. org-agenda-effort-filter-preset)
  3540. (if org-agenda-multi
  3541. (progn
  3542. (setq buffer-read-only nil)
  3543. (goto-char (point-max))
  3544. (unless (or (bobp) org-agenda-compact-blocks
  3545. (not org-agenda-block-separator))
  3546. (insert "\n"
  3547. (if (stringp org-agenda-block-separator)
  3548. org-agenda-block-separator
  3549. (make-string (window-width) org-agenda-block-separator))
  3550. "\n"))
  3551. (narrow-to-region (point) (point-max)))
  3552. (setq org-done-keywords-for-agenda nil)
  3553. ;; Setting any org variables that are in org-agenda-local-vars
  3554. ;; list need to be done after the prepare call
  3555. (org-agenda-prepare-window
  3556. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3557. (setq buffer-read-only nil)
  3558. (org-agenda-reset-markers)
  3559. (let ((inhibit-read-only t)) (erase-buffer))
  3560. (org-agenda-mode)
  3561. (setq org-agenda-buffer (current-buffer))
  3562. (setq org-agenda-contributing-files nil)
  3563. (setq org-agenda-columns-active nil)
  3564. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3565. (setq org-todo-keywords-for-agenda
  3566. (org-uniquify org-todo-keywords-for-agenda))
  3567. (setq org-done-keywords-for-agenda
  3568. (org-uniquify org-done-keywords-for-agenda))
  3569. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3570. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3571. (and name (not org-agenda-name)
  3572. (setq-local org-agenda-name name)))
  3573. (setq buffer-read-only nil))))
  3574. (defvar org-overriding-columns-format)
  3575. (defvar org-local-columns-format)
  3576. (defun org-agenda-finalize ()
  3577. "Finishing touch for the agenda buffer.
  3578. This function is called just before displaying the agenda. If
  3579. you want to add your own functions to the finalization of the
  3580. agenda display, configure `org-agenda-finalize-hook'."
  3581. (unless org-agenda-multi
  3582. (let ((inhibit-read-only t))
  3583. (save-excursion
  3584. (goto-char (point-min))
  3585. (save-excursion
  3586. (while (org-activate-links (point-max))
  3587. (goto-char (match-end 0))))
  3588. (unless (eq org-agenda-remove-tags t)
  3589. (org-agenda-align-tags))
  3590. (unless org-agenda-with-colors
  3591. (remove-text-properties (point-min) (point-max) '(face nil)))
  3592. (when (bound-and-true-p org-overriding-columns-format)
  3593. (setq-local org-local-columns-format
  3594. org-overriding-columns-format))
  3595. (when org-agenda-view-columns-initially
  3596. (org-agenda-columns))
  3597. (when org-agenda-fontify-priorities
  3598. (org-agenda-fontify-priorities))
  3599. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3600. (org-agenda-dim-blocked-tasks))
  3601. (org-agenda-mark-clocking-task)
  3602. (when org-agenda-entry-text-mode
  3603. (org-agenda-entry-text-hide)
  3604. (org-agenda-entry-text-show))
  3605. (when (and (featurep 'org-habit)
  3606. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3607. (org-habit-insert-consistency-graphs))
  3608. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3609. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3610. (and (listp org-agenda-show-inherited-tags)
  3611. (memq org-agenda-type org-agenda-show-inherited-tags))
  3612. (and (eq org-agenda-show-inherited-tags t)
  3613. (or (eq org-agenda-use-tag-inheritance t)
  3614. (and (listp org-agenda-use-tag-inheritance)
  3615. (not (memq org-agenda-type
  3616. org-agenda-use-tag-inheritance))))))
  3617. (let (mrk)
  3618. (save-excursion
  3619. (goto-char (point-min))
  3620. (while (equal (forward-line) 0)
  3621. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3622. (put-text-property (point-at-bol) (point-at-eol)
  3623. 'tags
  3624. (org-with-point-at mrk
  3625. (org-get-tags))))))))
  3626. (setq org-agenda-represented-tags nil
  3627. org-agenda-represented-categories nil)
  3628. (when org-agenda-top-headline-filter
  3629. (org-agenda-filter-top-headline-apply
  3630. org-agenda-top-headline-filter))
  3631. (when org-agenda-tag-filter
  3632. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3633. (when (get 'org-agenda-tag-filter :preset-filter)
  3634. (org-agenda-filter-apply
  3635. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3636. (when org-agenda-category-filter
  3637. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3638. (when (get 'org-agenda-category-filter :preset-filter)
  3639. (org-agenda-filter-apply
  3640. (get 'org-agenda-category-filter :preset-filter) 'category))
  3641. (when org-agenda-regexp-filter
  3642. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3643. (when (get 'org-agenda-regexp-filter :preset-filter)
  3644. (org-agenda-filter-apply
  3645. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3646. (when org-agenda-effort-filter
  3647. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3648. (when (get 'org-agenda-effort-filter :preset-filter)
  3649. (org-agenda-filter-apply
  3650. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3651. (add-hook 'kill-buffer-hook #'org-agenda-reset-markers 'append 'local))
  3652. (run-hooks 'org-agenda-finalize-hook))))
  3653. (defun org-agenda-mark-clocking-task ()
  3654. "Mark the current clock entry in the agenda if it is present."
  3655. ;; We need to widen when `org-agenda-finalize' is called from
  3656. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in').
  3657. (when (bound-and-true-p org-clock-current-task)
  3658. (save-restriction
  3659. (widen)
  3660. (org-agenda-unmark-clocking-task)
  3661. (when (marker-buffer org-clock-hd-marker)
  3662. (save-excursion
  3663. (goto-char (point-min))
  3664. (let (s ov)
  3665. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3666. (goto-char s)
  3667. (when (equal (org-get-at-bol 'org-hd-marker)
  3668. org-clock-hd-marker)
  3669. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3670. (overlay-put ov 'type 'org-agenda-clocking)
  3671. (overlay-put ov 'face 'org-agenda-clocking)
  3672. (overlay-put ov 'help-echo
  3673. "The clock is running in this item")))))))))
  3674. (defun org-agenda-unmark-clocking-task ()
  3675. "Unmark the current clocking task."
  3676. (mapc (lambda (o)
  3677. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3678. (delete-overlay o)))
  3679. (overlays-in (point-min) (point-max))))
  3680. (defun org-agenda-fontify-priorities ()
  3681. "Make highest priority lines bold, and lowest italic."
  3682. (interactive)
  3683. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3684. (delete-overlay o)))
  3685. (overlays-in (point-min) (point-max)))
  3686. (save-excursion
  3687. (let (b e p ov h l)
  3688. (goto-char (point-min))
  3689. (while (re-search-forward org-priority-regexp nil t)
  3690. (setq h (or (get-char-property (point) 'org-priority-highest)
  3691. org-priority-highest)
  3692. l (or (get-char-property (point) 'org-priority-lowest)
  3693. org-priority-lowest)
  3694. p (string-to-char (match-string 2))
  3695. b (match-beginning 1)
  3696. e (if (eq org-agenda-fontify-priorities 'cookies)
  3697. (1+ (match-end 2))
  3698. (point-at-eol))
  3699. ov (make-overlay b e))
  3700. (overlay-put
  3701. ov 'face
  3702. (let ((special-face
  3703. (cond ((org-face-from-face-or-color
  3704. 'priority 'org-priority
  3705. (cdr (assoc p org-priority-faces))))
  3706. ((and (listp org-agenda-fontify-priorities)
  3707. (org-face-from-face-or-color
  3708. 'priority 'org-priority
  3709. (cdr (assoc p org-agenda-fontify-priorities)))))
  3710. ((equal p l) 'italic)
  3711. ((equal p h) 'bold))))
  3712. (if special-face (list special-face 'org-priority) 'org-priority)))
  3713. (overlay-put ov 'org-type 'org-priority)))))
  3714. (defvar org-depend-tag-blocked)
  3715. (defun org-agenda-dim-blocked-tasks (&optional _invisible)
  3716. "Dim currently blocked TODOs in the agenda display.
  3717. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3718. dimming them." ;FIXME: The arg isn't used, actually!
  3719. (interactive "P")
  3720. (when (called-interactively-p 'interactive)
  3721. (message "Dim or hide blocked tasks..."))
  3722. (dolist (o (overlays-in (point-min) (point-max)))
  3723. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3724. (delete-overlay o)))
  3725. (save-excursion
  3726. (let ((inhibit-read-only t))
  3727. (goto-char (point-min))
  3728. (while (let ((pos (text-property-not-all
  3729. (point) (point-max) 'org-todo-blocked nil)))
  3730. (when pos (goto-char pos)))
  3731. (let* ((invisible
  3732. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3733. (todo-blocked
  3734. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3735. (ov (make-overlay (if invisible
  3736. (line-end-position 0)
  3737. (line-beginning-position))
  3738. (line-end-position))))
  3739. (when todo-blocked
  3740. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3741. (when invisible
  3742. (org-agenda-filter-hide-line 'todo-blocked)))
  3743. (move-beginning-of-line 2))))
  3744. (when (called-interactively-p 'interactive)
  3745. (message "Dim or hide blocked tasks...done")))
  3746. (defun org-agenda--mark-blocked-entry (entry)
  3747. "If ENTRY is blocked, mark it for fontification or invisibility.
  3748. If the header at `org-hd-marker' is blocked according to
  3749. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3750. 'invisible and the header is not blocked by checkboxes, set the
  3751. text property `org-todo-blocked' to `invisible', otherwise set it
  3752. to t."
  3753. (when (get-text-property 0 'todo-state entry)
  3754. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3755. (org-blocked-by-checkboxes nil)
  3756. ;; Necessary so that `org-entry-blocked-p' does not change
  3757. ;; the buffer.
  3758. (org-depend-tag-blocked nil))
  3759. (when entry-marker
  3760. (let ((blocked
  3761. (with-current-buffer (marker-buffer entry-marker)
  3762. (save-excursion
  3763. (goto-char entry-marker)
  3764. (org-entry-blocked-p)))))
  3765. (when blocked
  3766. (let ((really-invisible
  3767. (and (not org-blocked-by-checkboxes)
  3768. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3769. (put-text-property
  3770. 0 (length entry) 'org-todo-blocked
  3771. (if really-invisible 'invisible t)
  3772. entry)
  3773. (put-text-property
  3774. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3775. entry)
  3776. (defvar org-agenda-skip-function nil
  3777. "Function to be called at each match during agenda construction.
  3778. If this function returns nil, the current match should not be skipped.
  3779. Otherwise, the function must return a position from where the search
  3780. should be continued.
  3781. This may also be a Lisp form, it will be evaluated.
  3782. Never set this variable using `setq' or so, because then it will apply
  3783. to all future agenda commands. If you do want a global skipping condition,
  3784. use the option `org-agenda-skip-function-global' instead.
  3785. The correct usage for `org-agenda-skip-function' is to bind it with
  3786. `let' to scope it dynamically into the agenda-constructing command.
  3787. A good way to set it is through options in `org-agenda-custom-commands'.")
  3788. (defun org-agenda-skip ()
  3789. "Throw to `:skip' in places that should be skipped.
  3790. Also moves point to the end of the skipped region, so that search can
  3791. continue from there."
  3792. (let ((p (point-at-bol)) to)
  3793. (when (or
  3794. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3795. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3796. (or (and (get-text-property p :org-archived)
  3797. (org-end-of-subtree t))
  3798. (and (member org-archive-tag org-file-tags)
  3799. (goto-char (point-max)))))
  3800. (and org-agenda-skip-comment-trees
  3801. (get-text-property p :org-comment)
  3802. (org-end-of-subtree t))
  3803. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3804. (org-agenda-skip-eval org-agenda-skip-function)))
  3805. (goto-char to))
  3806. (org-in-src-block-p t))
  3807. (throw :skip t))))
  3808. (defun org-agenda-skip-eval (form)
  3809. "If FORM is a function or a list, call (or eval) it and return the result.
  3810. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3811. and match data are returned to the previous state no matter what these
  3812. functions do."
  3813. (let (fp)
  3814. (and form
  3815. (or (setq fp (functionp form))
  3816. (consp form))
  3817. (save-excursion
  3818. (save-match-data
  3819. (if fp
  3820. (funcall form)
  3821. (eval form t)))))))
  3822. (defvar org-agenda-markers nil
  3823. "List of all currently active markers created by `org-agenda'.")
  3824. (defvar org-agenda-last-marker-time (float-time)
  3825. "Creation time of the last agenda marker.")
  3826. (defun org-agenda-new-marker (&optional pos)
  3827. "Return a new agenda marker.
  3828. Marker is at point, or at POS if non-nil. Org mode keeps a list
  3829. of these markers and resets them when they are no longer in use."
  3830. (let ((m (copy-marker (or pos (point)) t)))
  3831. (setq org-agenda-last-marker-time (float-time))
  3832. (if org-agenda-buffer
  3833. (with-current-buffer org-agenda-buffer
  3834. (push m org-agenda-markers))
  3835. (push m org-agenda-markers))
  3836. m))
  3837. (defun org-agenda-reset-markers ()
  3838. "Reset markers created by `org-agenda'."
  3839. (while org-agenda-markers
  3840. (move-marker (pop org-agenda-markers) nil)))
  3841. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3842. "Save relative positions of markers in region.
  3843. This check for agenda markers in all agenda buffers currently active."
  3844. (dolist (buf (buffer-list))
  3845. (with-current-buffer buf
  3846. (when (eq major-mode 'org-agenda-mode)
  3847. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3848. org-agenda-markers)))))
  3849. ;;; Entry text mode
  3850. (defun org-agenda-entry-text-show-here ()
  3851. "Add some text from the entry as context to the current line."
  3852. (let (m txt o)
  3853. (setq m (org-get-at-bol 'org-hd-marker))
  3854. (unless (marker-buffer m)
  3855. (error "No marker points to an entry here"))
  3856. (setq txt (concat "\n" (org-no-properties
  3857. (org-agenda-get-some-entry-text
  3858. m org-agenda-entry-text-maxlines
  3859. org-agenda-entry-text-leaders))))
  3860. (when (string-match "\\S-" txt)
  3861. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3862. (overlay-put o 'evaporate t)
  3863. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3864. (overlay-put o 'after-string txt))))
  3865. (defun org-agenda-entry-text-show ()
  3866. "Add entry context for all agenda lines."
  3867. (interactive)
  3868. (save-excursion
  3869. (goto-char (point-max))
  3870. (beginning-of-line 1)
  3871. (while (not (bobp))
  3872. (when (org-get-at-bol 'org-hd-marker)
  3873. (org-agenda-entry-text-show-here))
  3874. (beginning-of-line 0))))
  3875. (defun org-agenda-entry-text-hide ()
  3876. "Remove any shown entry context."
  3877. (mapc (lambda (o)
  3878. (when (eq (overlay-get o 'org-overlay-type)
  3879. 'agenda-entry-content)
  3880. (delete-overlay o)))
  3881. (overlays-in (point-min) (point-max))))
  3882. (defun org-agenda-get-day-face (date)
  3883. "Return the face DATE should be displayed with."
  3884. (cond ((and (functionp org-agenda-day-face-function)
  3885. (funcall org-agenda-day-face-function date)))
  3886. ((org-agenda-today-p date) 'org-agenda-date-today)
  3887. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3888. 'org-agenda-date-weekend)
  3889. (t 'org-agenda-date)))
  3890. (defvar org-agenda-show-log-scoped)
  3891. ;;; Agenda Daily/Weekly
  3892. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3893. "Start day for the agenda view.
  3894. Custom commands can set this variable in the options section.
  3895. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3896. input allowed when reading a date through the Org calendar.
  3897. See the docstring of `org-read-date' for details.")
  3898. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3899. (defvar org-arg-loc nil) ; local variable
  3900. ;;;###autoload
  3901. (defun org-agenda-list (&optional arg start-day span with-hour)
  3902. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3903. The view will be for the current day or week, but from the overview buffer
  3904. you will be able to go to other days/weeks.
  3905. With a numeric prefix argument in an interactive call, the agenda will
  3906. span ARG days. Lisp programs should instead specify SPAN to change
  3907. the number of days. SPAN defaults to `org-agenda-span'.
  3908. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3909. given in `org-agenda-start-on-weekday'.
  3910. When WITH-HOUR is non-nil, only include scheduled and deadline
  3911. items if they have an hour specification like [h]h:mm."
  3912. (interactive "P")
  3913. (when org-agenda-overriding-arguments
  3914. (setq arg (car org-agenda-overriding-arguments)
  3915. start-day (nth 1 org-agenda-overriding-arguments)
  3916. span (nth 2 org-agenda-overriding-arguments)))
  3917. (when (and (integerp arg) (> arg 0))
  3918. (setq span arg arg nil))
  3919. (when (numberp span)
  3920. (unless (< 0 span)
  3921. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3922. (catch 'exit
  3923. (setq org-agenda-buffer-name
  3924. (org-agenda--get-buffer-name
  3925. (and org-agenda-sticky
  3926. (cond ((and org-keys (stringp org-match))
  3927. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3928. (org-keys
  3929. (format "*Org Agenda(%s)*" org-keys))
  3930. (t "*Org Agenda(a)*")))))
  3931. (org-agenda-prepare "Day/Week")
  3932. (setq start-day (or start-day org-agenda-start-day))
  3933. (when (stringp start-day)
  3934. ;; Convert to an absolute day number
  3935. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3936. (org-compile-prefix-format 'agenda)
  3937. (org-set-sorting-strategy 'agenda)
  3938. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3939. (today (org-today))
  3940. (sd (or start-day today))
  3941. (ndays (org-agenda-span-to-ndays span sd))
  3942. (org-agenda-start-on-weekday
  3943. (and (or (eq ndays 7) (eq ndays 14))
  3944. org-agenda-start-on-weekday))
  3945. (thefiles (org-agenda-files nil 'ifmode))
  3946. (files thefiles)
  3947. (start (if (or (null org-agenda-start-on-weekday)
  3948. (< ndays 7))
  3949. sd
  3950. (let* ((nt (calendar-day-of-week
  3951. (calendar-gregorian-from-absolute sd)))
  3952. (n1 org-agenda-start-on-weekday)
  3953. (d (- nt n1)))
  3954. (- sd (+ (if (< d 0) 7 0) d)))))
  3955. (day-numbers (list start))
  3956. (day-cnt 0)
  3957. (inhibit-redisplay (not debug-on-error))
  3958. (org-agenda-show-log-scoped org-agenda-show-log)
  3959. s rtn rtnall file date d start-pos end-pos todayp ;; e
  3960. clocktable-start clocktable-end) ;; filter
  3961. (setq org-agenda-redo-command
  3962. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3963. (dotimes (_ (1- ndays))
  3964. (push (1+ (car day-numbers)) day-numbers))
  3965. (setq day-numbers (nreverse day-numbers))
  3966. (setq clocktable-start (car day-numbers)
  3967. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3968. (setq-local org-starting-day (car day-numbers))
  3969. (setq-local org-arg-loc arg)
  3970. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3971. (unless org-agenda-compact-blocks
  3972. (let* ((d1 (car day-numbers))
  3973. (d2 (org-last day-numbers))
  3974. (w1 (org-days-to-iso-week d1))
  3975. (w2 (org-days-to-iso-week d2)))
  3976. (setq s (point))
  3977. (org-agenda--insert-overriding-header
  3978. (concat (org-agenda-span-name span)
  3979. "-agenda"
  3980. (cond ((<= 350 (- d2 d1)) "")
  3981. ((= w1 w2) (format " (W%02d)" w1))
  3982. (t (format " (W%02d-W%02d)" w1 w2)))
  3983. ":\n")))
  3984. ;; Add properties if we actually inserted a header.
  3985. (when (> (point) s)
  3986. (add-text-properties s (1- (point))
  3987. (list 'face 'org-agenda-structure
  3988. 'org-date-line t))
  3989. (org-agenda-mark-header-line s)))
  3990. (while (setq d (pop day-numbers))
  3991. (setq date (calendar-gregorian-from-absolute d)
  3992. s (point))
  3993. (if (or (setq todayp (= d today))
  3994. (and (not start-pos) (= d sd)))
  3995. (setq start-pos (point))
  3996. (when (and start-pos (not end-pos))
  3997. (setq end-pos (point))))
  3998. (setq files thefiles
  3999. rtnall nil)
  4000. (while (setq file (pop files))
  4001. (catch 'nextfile
  4002. (org-check-agenda-file file)
  4003. (let ((org-agenda-entry-types org-agenda-entry-types))
  4004. ;; Starred types override non-starred equivalents
  4005. (when (member :deadline* org-agenda-entry-types)
  4006. (setq org-agenda-entry-types
  4007. (delq :deadline org-agenda-entry-types)))
  4008. (when (member :scheduled* org-agenda-entry-types)
  4009. (setq org-agenda-entry-types
  4010. (delq :scheduled org-agenda-entry-types)))
  4011. ;; Honor with-hour
  4012. (when with-hour
  4013. (when (member :deadline org-agenda-entry-types)
  4014. (setq org-agenda-entry-types
  4015. (delq :deadline org-agenda-entry-types))
  4016. (push :deadline* org-agenda-entry-types))
  4017. (when (member :scheduled org-agenda-entry-types)
  4018. (setq org-agenda-entry-types
  4019. (delq :scheduled org-agenda-entry-types))
  4020. (push :scheduled* org-agenda-entry-types)))
  4021. (unless org-agenda-include-deadlines
  4022. (setq org-agenda-entry-types
  4023. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  4024. (cond
  4025. ((memq org-agenda-show-log-scoped '(only clockcheck))
  4026. (setq rtn (org-agenda-get-day-entries
  4027. file date :closed)))
  4028. (org-agenda-show-log-scoped
  4029. (setq rtn (apply #'org-agenda-get-day-entries
  4030. file date
  4031. (append '(:closed) org-agenda-entry-types))))
  4032. (t
  4033. (setq rtn (apply #'org-agenda-get-day-entries
  4034. file date
  4035. org-agenda-entry-types)))))
  4036. (setq rtnall (append rtnall rtn)))) ;; all entries
  4037. (when org-agenda-include-diary
  4038. (let ((org-agenda-search-headline-for-time t))
  4039. (require 'diary-lib)
  4040. (setq rtn (org-get-entries-from-diary date))
  4041. (setq rtnall (append rtnall rtn))))
  4042. (when (or rtnall org-agenda-show-all-dates)
  4043. (setq day-cnt (1+ day-cnt))
  4044. (insert
  4045. (if (stringp org-agenda-format-date)
  4046. (format-time-string org-agenda-format-date
  4047. (org-time-from-absolute date))
  4048. (funcall org-agenda-format-date date))
  4049. "\n")
  4050. (put-text-property s (1- (point)) 'face
  4051. (org-agenda-get-day-face date))
  4052. (put-text-property s (1- (point)) 'org-date-line t)
  4053. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  4054. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  4055. (when todayp
  4056. (put-text-property s (1- (point)) 'org-today t))
  4057. (setq rtnall
  4058. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  4059. (when rtnall (insert ;; all entries
  4060. (org-agenda-finalize-entries rtnall 'agenda)
  4061. "\n"))
  4062. (put-text-property s (1- (point)) 'day d)
  4063. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  4064. (when (and org-agenda-clockreport-mode clocktable-start)
  4065. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  4066. ;; the above line is to ensure the restricted range!
  4067. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4068. tbl)
  4069. (setq p (org-plist-delete p :block))
  4070. (setq p (plist-put p :tstart clocktable-start))
  4071. (setq p (plist-put p :tend clocktable-end))
  4072. (setq p (plist-put p :scope 'agenda))
  4073. (setq tbl (apply #'org-clock-get-clocktable p))
  4074. (insert tbl)))
  4075. (goto-char (point-min))
  4076. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4077. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4078. (and (pos-visible-in-window-p (point-min))
  4079. (pos-visible-in-window-p (point-max))))
  4080. (goto-char (1- (point-max)))
  4081. (recenter -1)
  4082. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4083. (goto-char (or start-pos 1))
  4084. (recenter 1)))
  4085. (goto-char (or start-pos 1))
  4086. (add-text-properties (point-min) (point-max)
  4087. `(org-agenda-type agenda
  4088. org-last-args (,arg ,start-day ,span)
  4089. org-redo-cmd ,org-agenda-redo-command
  4090. org-series-cmd ,org-cmd))
  4091. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4092. (org-agenda-show-clocking-issues))
  4093. (org-agenda-finalize)
  4094. (setq buffer-read-only t)
  4095. (message ""))))
  4096. (defun org-agenda-ndays-to-span (n)
  4097. "Return a span symbol for a span of N days, or N if none matches."
  4098. (cond ((symbolp n) n)
  4099. ((= n 1) 'day)
  4100. ((= n 7) 'week)
  4101. ((= n 14) 'fortnight)
  4102. (t n)))
  4103. (defun org-agenda-span-to-ndays (span &optional start-day)
  4104. "Return ndays from SPAN, possibly starting at START-DAY.
  4105. START-DAY is an absolute time value."
  4106. (cond ((numberp span) span)
  4107. ((eq span 'day) 1)
  4108. ((eq span 'week) 7)
  4109. ((eq span 'fortnight) 14)
  4110. ((eq span 'month)
  4111. (let ((date (calendar-gregorian-from-absolute start-day)))
  4112. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4113. ((eq span 'year)
  4114. (let ((date (calendar-gregorian-from-absolute start-day)))
  4115. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4116. (defun org-agenda-span-name (span)
  4117. "Return a SPAN name."
  4118. (if (null span)
  4119. ""
  4120. (if (symbolp span)
  4121. (capitalize (symbol-name span))
  4122. (format "%d days" span))))
  4123. ;;; Agenda word search
  4124. (defvar org-agenda-search-history nil)
  4125. (defvar org-search-syntax-table nil
  4126. "Special syntax table for Org search.
  4127. In this table, we have single quotes not as word constituents, to
  4128. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4129. (defvar org-mode-syntax-table) ; From org.el
  4130. (defun org-search-syntax-table ()
  4131. (unless org-search-syntax-table
  4132. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4133. (modify-syntax-entry ?' "." org-search-syntax-table)
  4134. (modify-syntax-entry ?` "." org-search-syntax-table))
  4135. org-search-syntax-table)
  4136. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4137. ;;;###autoload
  4138. (defun org-search-view (&optional todo-only string edit-at)
  4139. "Show all entries that contain a phrase or words or regular expressions.
  4140. With optional prefix argument TODO-ONLY, only consider entries that are
  4141. TODO entries. The argument STRING can be used to pass a default search
  4142. string into this function. If EDIT-AT is non-nil, it means that the
  4143. user should get a chance to edit this string, with cursor at position
  4144. EDIT-AT.
  4145. The search string can be viewed either as a phrase that should be found as
  4146. is, or it can be broken into a number of snippets, each of which must match
  4147. in a Boolean way to select an entry. The default depends on the variable
  4148. `org-agenda-search-view-always-boolean'.
  4149. Even if this is turned off (the default) you can always switch to
  4150. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4151. The default is a direct search of the whole phrase, where each space in
  4152. the search string can expand to an arbitrary amount of whitespace,
  4153. including newlines.
  4154. If using a Boolean search, the search string is split on whitespace and
  4155. each snippet is searched separately, with logical AND to select an entry.
  4156. Words prefixed with a minus must *not* occur in the entry. Words without
  4157. a prefix or prefixed with a plus must occur in the entry. Matching is
  4158. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4159. match whole words, not parts of a word) if
  4160. `org-agenda-search-view-force-full-words' is set (default is nil).
  4161. Boolean search snippets enclosed by curly braces are interpreted as
  4162. regular expressions that must or (when preceded with \"-\") must not
  4163. match in the entry. Snippets enclosed into double quotes will be taken
  4164. as a whole, to include whitespace.
  4165. - If the search string starts with an asterisk, search only in headlines.
  4166. - If (possibly after the leading star) the search string starts with an
  4167. exclamation mark, this also means to look at TODO entries only, an effect
  4168. that can also be achieved with a prefix argument.
  4169. - If (possibly after star and exclamation mark) the search string starts
  4170. with a colon, this will mean that the (non-regexp) snippets of the
  4171. Boolean search must match as full words.
  4172. This command searches the agenda files, and in addition the files
  4173. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4174. is active."
  4175. (interactive "P")
  4176. (when org-agenda-overriding-arguments
  4177. (setq todo-only (car org-agenda-overriding-arguments)
  4178. string (nth 1 org-agenda-overriding-arguments)
  4179. edit-at (nth 2 org-agenda-overriding-arguments)))
  4180. (let* ((props (list 'face nil
  4181. 'done-face 'org-agenda-done
  4182. 'org-not-done-regexp org-not-done-regexp
  4183. 'org-todo-regexp org-todo-regexp
  4184. 'org-complex-heading-regexp org-complex-heading-regexp
  4185. 'mouse-face 'highlight
  4186. 'help-echo (format "mouse-2 or RET jump to location")))
  4187. (full-words org-agenda-search-view-force-full-words)
  4188. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4189. regexp rtn rtnall files file pos inherited-tags
  4190. marker category level tags c neg re boolean
  4191. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4192. (unless (and (not edit-at)
  4193. (stringp string)
  4194. (string-match "\\S-" string))
  4195. (setq string (read-string
  4196. (if org-agenda-search-view-always-boolean
  4197. "[+-]Word/{Regexp} ...: "
  4198. "Phrase or [+-]Word/{Regexp} ...: ")
  4199. (cond
  4200. ((integerp edit-at) (cons string edit-at))
  4201. (edit-at string))
  4202. 'org-agenda-search-history)))
  4203. (catch 'exit
  4204. (setq org-agenda-buffer-name
  4205. (org-agenda--get-buffer-name
  4206. (and org-agenda-sticky
  4207. (if (stringp string)
  4208. (format "*Org Agenda(%s:%s)*"
  4209. (or org-keys (or (and todo-only "S") "s"))
  4210. string)
  4211. (format "*Org Agenda(%s)*"
  4212. (or (and todo-only "S") "s"))))))
  4213. (org-agenda-prepare "SEARCH")
  4214. (org-compile-prefix-format 'search)
  4215. (org-set-sorting-strategy 'search)
  4216. (setq org-agenda-redo-command
  4217. (list 'org-search-view (if todo-only t nil)
  4218. (list 'if 'current-prefix-arg nil string)))
  4219. (setq org-agenda-query-string string)
  4220. (if (equal (string-to-char string) ?*)
  4221. (setq hdl-only t
  4222. words (substring string 1))
  4223. (setq words string))
  4224. (when (equal (string-to-char words) ?!)
  4225. (setq todo-only t
  4226. words (substring words 1)))
  4227. (when (equal (string-to-char words) ?:)
  4228. (setq full-words t
  4229. words (substring words 1)))
  4230. (when (or org-agenda-search-view-always-boolean
  4231. (member (string-to-char words) '(?- ?+ ?\{)))
  4232. (setq boolean t))
  4233. (setq words (split-string words))
  4234. (let (www w)
  4235. (while (setq w (pop words))
  4236. (while (and (string-match "\\\\\\'" w) words)
  4237. (setq w (concat (substring w 0 -1) " " (pop words))))
  4238. (push w www))
  4239. (setq words (nreverse www) www nil)
  4240. (while (setq w (pop words))
  4241. (when (and (string-match "\\`[-+]?{" w)
  4242. (not (string-match "}\\'" w)))
  4243. (while (and words (not (string-match "}\\'" (car words))))
  4244. (setq w (concat w " " (pop words))))
  4245. (setq w (concat w " " (pop words))))
  4246. (push w www))
  4247. (setq words (nreverse www)))
  4248. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4249. (when boolean
  4250. (let (wds w)
  4251. (while (setq w (pop words))
  4252. (when (or (equal (substring w 0 1) "\"")
  4253. (and (> (length w) 1)
  4254. (member (substring w 0 1) '("+" "-"))
  4255. (equal (substring w 1 2) "\"")))
  4256. (while (and words (not (equal (substring w -1) "\"")))
  4257. (setq w (concat w " " (pop words)))))
  4258. (and (string-match "\\`\\([-+]?\\)\"" w)
  4259. (setq w (replace-match "\\1" nil nil w)))
  4260. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4261. (push w wds))
  4262. (setq words (nreverse wds))))
  4263. (if boolean
  4264. (mapc (lambda (w)
  4265. (setq c (string-to-char w))
  4266. (if (equal c ?-)
  4267. (setq neg t w (substring w 1))
  4268. (if (equal c ?+)
  4269. (setq neg nil w (substring w 1))
  4270. (setq neg nil)))
  4271. (if (string-match "\\`{.*}\\'" w)
  4272. (setq re (substring w 1 -1))
  4273. (if full-words
  4274. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4275. (setq re (regexp-quote (downcase w)))))
  4276. (if neg (push re regexps-) (push re regexps+)))
  4277. words)
  4278. (push (mapconcat #'regexp-quote words "\\s-+")
  4279. regexps+))
  4280. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4281. (if (not regexps+)
  4282. (setq regexp org-outline-regexp-bol)
  4283. (setq regexp (pop regexps+))
  4284. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4285. regexp))))
  4286. (setq files (org-agenda-files nil 'ifmode))
  4287. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4288. ;; restriction.
  4289. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4290. (pop org-agenda-text-search-extra-files)
  4291. (unless (get 'org-agenda-files 'org-restrict)
  4292. (setq files (org-add-archive-files files))))
  4293. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4294. ;; non-existent ones.
  4295. (setq files (cl-remove-duplicates
  4296. (append files org-agenda-text-search-extra-files)
  4297. :test (lambda (a b)
  4298. (and (file-exists-p a)
  4299. (file-exists-p b)
  4300. (file-equal-p a b))))
  4301. rtnall nil)
  4302. (while (setq file (pop files))
  4303. (setq ee nil)
  4304. (catch 'nextfile
  4305. (org-check-agenda-file file)
  4306. (setq buffer (if (file-exists-p file)
  4307. (org-get-agenda-file-buffer file)
  4308. (error "No such file %s" file)))
  4309. (unless buffer
  4310. ;; If file does not exist, make sure an error message is sent
  4311. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4312. file))))
  4313. (with-current-buffer buffer
  4314. (with-syntax-table (org-search-syntax-table)
  4315. (unless (derived-mode-p 'org-mode)
  4316. (error "Agenda file %s is not in Org mode" file))
  4317. (let ((case-fold-search t))
  4318. (save-excursion
  4319. (save-restriction
  4320. (if (eq buffer org-agenda-restrict)
  4321. (narrow-to-region org-agenda-restrict-begin
  4322. org-agenda-restrict-end)
  4323. (widen))
  4324. (goto-char (point-min))
  4325. (unless (or (org-at-heading-p)
  4326. (outline-next-heading))
  4327. (throw 'nextfile t))
  4328. (goto-char (max (point-min) (1- (point))))
  4329. (while (re-search-forward regexp nil t)
  4330. (org-back-to-heading t)
  4331. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4332. (> (org-reduced-level (org-outline-level))
  4333. org-agenda-search-view-max-outline-level)
  4334. (forward-line -1)
  4335. (org-back-to-heading t)))
  4336. (skip-chars-forward "* ")
  4337. (setq beg (point-at-bol)
  4338. beg1 (point)
  4339. end (progn
  4340. (outline-next-heading)
  4341. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4342. (> (org-reduced-level (org-outline-level))
  4343. org-agenda-search-view-max-outline-level)
  4344. (forward-line 1)
  4345. (outline-next-heading)))
  4346. (point)))
  4347. (catch :skip
  4348. (goto-char beg)
  4349. (org-agenda-skip)
  4350. (setq str (buffer-substring-no-properties
  4351. (point-at-bol)
  4352. (if hdl-only (point-at-eol) end)))
  4353. (mapc (lambda (wr) (when (string-match wr str)
  4354. (goto-char (1- end))
  4355. (throw :skip t)))
  4356. regexps-)
  4357. (mapc (lambda (wr) (unless (string-match wr str)
  4358. (goto-char (1- end))
  4359. (throw :skip t)))
  4360. (if todo-only
  4361. (cons (concat "^\\*+[ \t]+"
  4362. org-not-done-regexp)
  4363. regexps+)
  4364. regexps+))
  4365. (goto-char beg)
  4366. (setq marker (org-agenda-new-marker (point))
  4367. category (org-get-category)
  4368. level (make-string (org-reduced-level (org-outline-level)) ? )
  4369. inherited-tags
  4370. (or (eq org-agenda-show-inherited-tags 'always)
  4371. (and (listp org-agenda-show-inherited-tags)
  4372. (memq 'todo org-agenda-show-inherited-tags))
  4373. (and (eq org-agenda-show-inherited-tags t)
  4374. (or (eq org-agenda-use-tag-inheritance t)
  4375. (memq 'todo org-agenda-use-tag-inheritance))))
  4376. tags (org-get-tags nil (not inherited-tags))
  4377. txt (org-agenda-format-item
  4378. ""
  4379. (buffer-substring-no-properties
  4380. beg1 (point-at-eol))
  4381. level category tags t))
  4382. (org-add-props txt props
  4383. 'org-marker marker 'org-hd-marker marker
  4384. 'org-todo-regexp org-todo-regexp
  4385. 'level level
  4386. 'org-complex-heading-regexp org-complex-heading-regexp
  4387. 'priority 1000
  4388. 'type "search")
  4389. (push txt ee)
  4390. (goto-char (1- end))))))))))
  4391. (setq rtn (nreverse ee))
  4392. (setq rtnall (append rtnall rtn)))
  4393. (org-agenda--insert-overriding-header
  4394. (with-temp-buffer
  4395. (insert "Search words: ")
  4396. (add-text-properties (point-min) (1- (point))
  4397. (list 'face 'org-agenda-structure))
  4398. (setq pos (point))
  4399. (insert string "\n")
  4400. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4401. (setq pos (point))
  4402. (unless org-agenda-multi
  4403. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4404. Press `\\[org-agenda-manipulate-query-add]', \
  4405. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4406. `\\[org-agenda-manipulate-query-add-re]', \
  4407. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4408. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4409. (add-text-properties pos (1- (point))
  4410. (list 'face 'org-agenda-structure)))
  4411. (buffer-string)))
  4412. (org-agenda-mark-header-line (point-min))
  4413. (when rtnall
  4414. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4415. (goto-char (point-min))
  4416. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4417. (add-text-properties (point-min) (point-max)
  4418. `(org-agenda-type search
  4419. org-last-args (,todo-only ,string ,edit-at)
  4420. org-redo-cmd ,org-agenda-redo-command
  4421. org-series-cmd ,org-cmd))
  4422. (org-agenda-finalize)
  4423. (setq buffer-read-only t))))
  4424. ;;; Agenda TODO list
  4425. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4426. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4427. (concat
  4428. (if (or (equal keywords "ALL") (not keywords))
  4429. (propertize "ALL" 'face 'warning)
  4430. (mapconcat
  4431. (lambda (kw)
  4432. (propertize kw 'face (org-get-todo-face kw)))
  4433. (org-split-string keywords "|")
  4434. "|"))
  4435. "\n"))
  4436. (defvar org-select-this-todo-keyword nil)
  4437. (defvar org-last-arg nil)
  4438. (defvar crm-separator)
  4439. ;;;###autoload
  4440. (defun org-todo-list (&optional arg)
  4441. "Show all (not done) TODO entries from all agenda file in a single list.
  4442. The prefix arg can be used to select a specific TODO keyword and limit
  4443. the list to these. When using `\\[universal-argument]', you will be prompted
  4444. for a keyword. A numeric prefix directly selects the Nth keyword in
  4445. `org-todo-keywords-1'."
  4446. (interactive "P")
  4447. (when org-agenda-overriding-arguments
  4448. (setq arg org-agenda-overriding-arguments))
  4449. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4450. (let* ((today (org-today))
  4451. (date (calendar-gregorian-from-absolute today))
  4452. (completion-ignore-case t)
  4453. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4454. (catch 'exit
  4455. (setq org-agenda-buffer-name
  4456. (org-agenda--get-buffer-name
  4457. (and org-agenda-sticky
  4458. (if (stringp org-select-this-todo-keyword)
  4459. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4460. org-select-this-todo-keyword)
  4461. (format "*Org Agenda(%s)*" (or org-keys "t"))))))
  4462. (org-agenda-prepare "TODO")
  4463. (setq kwds org-todo-keywords-for-agenda
  4464. org-select-this-todo-keyword (if (stringp arg) arg
  4465. (and (integerp arg)
  4466. (> arg 0)
  4467. (nth (1- arg) kwds))))
  4468. (when (equal arg '(4))
  4469. (setq org-select-this-todo-keyword
  4470. (mapconcat #'identity
  4471. (let ((crm-separator "|"))
  4472. (completing-read-multiple
  4473. "Keyword (or KWD1|KWD2|...): "
  4474. (mapcar #'list kwds) nil nil))
  4475. "|")))
  4476. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4477. (org-compile-prefix-format 'todo)
  4478. (org-set-sorting-strategy 'todo)
  4479. (setq org-agenda-redo-command
  4480. `(org-todo-list (or (and (numberp current-prefix-arg)
  4481. current-prefix-arg)
  4482. ,org-select-this-todo-keyword
  4483. current-prefix-arg ,arg)))
  4484. (setq files (org-agenda-files nil 'ifmode)
  4485. rtnall nil)
  4486. (while (setq file (pop files))
  4487. (catch 'nextfile
  4488. (org-check-agenda-file file)
  4489. (setq rtn (org-agenda-get-day-entries file date :todo))
  4490. (setq rtnall (append rtnall rtn))))
  4491. (org-agenda--insert-overriding-header
  4492. (with-temp-buffer
  4493. (insert "Global list of TODO items of type: ")
  4494. (add-text-properties (point-min) (1- (point))
  4495. (list 'face 'org-agenda-structure
  4496. 'short-heading
  4497. (concat "ToDo: "
  4498. (or org-select-this-todo-keyword "ALL"))))
  4499. (org-agenda-mark-header-line (point-min))
  4500. (insert (org-agenda-propertize-selected-todo-keywords
  4501. org-select-this-todo-keyword))
  4502. (setq pos (point))
  4503. (unless org-agenda-multi
  4504. (insert (substitute-command-keys "Press \
  4505. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4506. to search again: (0)[ALL]"))
  4507. (let ((n 0))
  4508. (dolist (k kwds)
  4509. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4510. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4511. (insert "\n "))
  4512. (insert " " s))))
  4513. (insert "\n"))
  4514. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4515. (buffer-string)))
  4516. (org-agenda-mark-header-line (point-min))
  4517. (when rtnall
  4518. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4519. (goto-char (point-min))
  4520. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4521. (add-text-properties (point-min) (point-max)
  4522. `(org-agenda-type todo
  4523. org-last-args ,arg
  4524. org-redo-cmd ,org-agenda-redo-command
  4525. org-series-cmd ,org-cmd))
  4526. (org-agenda-finalize)
  4527. (setq buffer-read-only t))))
  4528. ;;; Agenda tags match
  4529. ;;;###autoload
  4530. (defun org-tags-view (&optional todo-only match)
  4531. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4532. The prefix arg TODO-ONLY limits the search to TODO entries."
  4533. (interactive "P")
  4534. (when org-agenda-overriding-arguments
  4535. (setq todo-only (car org-agenda-overriding-arguments)
  4536. match (nth 1 org-agenda-overriding-arguments)))
  4537. (let* ((org-tags-match-list-sublevels
  4538. org-tags-match-list-sublevels)
  4539. (completion-ignore-case t)
  4540. (org--matcher-tags-todo-only todo-only)
  4541. rtn rtnall files file pos matcher
  4542. buffer)
  4543. (when (and (stringp match) (not (string-match "\\S-" match)))
  4544. (setq match nil))
  4545. (catch 'exit
  4546. (setq org-agenda-buffer-name
  4547. (org-agenda--get-buffer-name
  4548. (and org-agenda-sticky
  4549. (if (stringp match)
  4550. (format "*Org Agenda(%s:%s)*"
  4551. (or org-keys (or (and todo-only "M") "m"))
  4552. match)
  4553. (format "*Org Agenda(%s)*"
  4554. (or (and todo-only "M") "m"))))))
  4555. (setq matcher (org-make-tags-matcher match))
  4556. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4557. ;; expanding tags within `org-make-tags-matcher'
  4558. (org-agenda-prepare (concat "TAGS " match))
  4559. (setq match (car matcher)
  4560. matcher (cdr matcher))
  4561. (org-compile-prefix-format 'tags)
  4562. (org-set-sorting-strategy 'tags)
  4563. (setq org-agenda-query-string match)
  4564. (setq org-agenda-redo-command
  4565. (list 'org-tags-view
  4566. `(quote ,org--matcher-tags-todo-only)
  4567. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4568. (setq files (org-agenda-files nil 'ifmode)
  4569. rtnall nil)
  4570. (while (setq file (pop files))
  4571. (catch 'nextfile
  4572. (org-check-agenda-file file)
  4573. (setq buffer (if (file-exists-p file)
  4574. (org-get-agenda-file-buffer file)
  4575. (error "No such file %s" file)))
  4576. (if (not buffer)
  4577. ;; If file does not exist, error message to agenda
  4578. (setq rtn (list
  4579. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4580. rtnall (append rtnall rtn))
  4581. (with-current-buffer buffer
  4582. (unless (derived-mode-p 'org-mode)
  4583. (error "Agenda file %s is not in Org mode" file))
  4584. (save-excursion
  4585. (save-restriction
  4586. (if (eq buffer org-agenda-restrict)
  4587. (narrow-to-region org-agenda-restrict-begin
  4588. org-agenda-restrict-end)
  4589. (widen))
  4590. (setq rtn (org-scan-tags 'agenda
  4591. matcher
  4592. org--matcher-tags-todo-only))
  4593. (setq rtnall (append rtnall rtn))))))))
  4594. (org-agenda--insert-overriding-header
  4595. (with-temp-buffer
  4596. (insert "Headlines with TAGS match: ")
  4597. (add-text-properties (point-min) (1- (point))
  4598. (list 'face 'org-agenda-structure
  4599. 'short-heading
  4600. (concat "Match: " match)))
  4601. (setq pos (point))
  4602. (insert match "\n")
  4603. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4604. (setq pos (point))
  4605. (unless org-agenda-multi
  4606. (insert (substitute-command-keys
  4607. "Press \
  4608. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4609. to search again\n")))
  4610. (add-text-properties pos (1- (point))
  4611. (list 'face 'org-agenda-structure))
  4612. (buffer-string)))
  4613. (org-agenda-mark-header-line (point-min))
  4614. (when rtnall
  4615. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4616. (goto-char (point-min))
  4617. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4618. (add-text-properties
  4619. (point-min) (point-max)
  4620. `(org-agenda-type tags
  4621. org-last-args (,org--matcher-tags-todo-only ,match)
  4622. org-redo-cmd ,org-agenda-redo-command
  4623. org-series-cmd ,org-cmd))
  4624. (org-agenda-finalize)
  4625. (setq buffer-read-only t))))
  4626. ;;; Agenda Finding stuck projects
  4627. (defvar org-agenda-skip-regexp nil
  4628. "Regular expression used in skipping subtrees for the agenda.
  4629. This is basically a temporary global variable that can be set and then
  4630. used by user-defined selections using `org-agenda-skip-function'.")
  4631. (defvar org-agenda-overriding-header nil
  4632. "When set during agenda, todo and tags searches it replaces the header.
  4633. If an empty string, no header will be inserted. If any other
  4634. string, it will be inserted as a header. If nil, a header will
  4635. be generated automatically according to the command. This
  4636. variable should not be set directly, but custom commands can bind
  4637. it in the options section.")
  4638. (defun org-agenda-skip-entry-if (&rest conditions)
  4639. "Skip entry if any of CONDITIONS is true.
  4640. See `org-agenda-skip-if' for details."
  4641. (org-agenda-skip-if nil conditions))
  4642. (defun org-agenda-skip-subtree-if (&rest conditions)
  4643. "Skip subtree if any of CONDITIONS is true.
  4644. See `org-agenda-skip-if' for details."
  4645. (org-agenda-skip-if t conditions))
  4646. (defun org-agenda-skip-if (subtree conditions)
  4647. "Checks current entity for CONDITIONS.
  4648. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4649. the entry (i.e. the text before the next heading) is checked.
  4650. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4651. from different tests. Valid conditions are:
  4652. scheduled Check if there is a scheduled cookie
  4653. notscheduled Check if there is no scheduled cookie
  4654. deadline Check if there is a deadline
  4655. notdeadline Check if there is no deadline
  4656. timestamp Check if there is a timestamp (also deadline or scheduled)
  4657. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4658. regexp Check if regexp matches
  4659. notregexp Check if regexp does not match.
  4660. todo Check if TODO keyword matches
  4661. nottodo Check if TODO keyword does not match
  4662. The regexp is taken from the conditions list, it must come right after
  4663. the `regexp' or `notregexp' element.
  4664. `todo' and `nottodo' accept as an argument a list of todo
  4665. keywords, which may include \"*\" to match any todo keyword.
  4666. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4667. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4668. Instead of a list, a keyword class may be given. For example:
  4669. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4670. would skip entries that haven't been marked with any of \"DONE\"
  4671. keywords. Possible classes are: `todo', `done', `any'.
  4672. If any of these conditions is met, this function returns the end point of
  4673. the entity, causing the search to continue from there. This is a function
  4674. that can be put into `org-agenda-skip-function' for the duration of a command."
  4675. (org-back-to-heading t)
  4676. (let* (;; (beg (point))
  4677. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4678. (org-entry-end-position)))
  4679. (planning-end (if subtree end (line-end-position 2)))
  4680. m)
  4681. (and
  4682. (or (and (memq 'scheduled conditions)
  4683. (re-search-forward org-scheduled-time-regexp planning-end t))
  4684. (and (memq 'notscheduled conditions)
  4685. (not
  4686. (save-excursion
  4687. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4688. (and (memq 'deadline conditions)
  4689. (re-search-forward org-deadline-time-regexp planning-end t))
  4690. (and (memq 'notdeadline conditions)
  4691. (not
  4692. (save-excursion
  4693. (re-search-forward org-deadline-time-regexp planning-end t))))
  4694. (and (memq 'timestamp conditions)
  4695. (re-search-forward org-ts-regexp end t))
  4696. (and (memq 'nottimestamp conditions)
  4697. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4698. (and (setq m (memq 'regexp conditions))
  4699. (stringp (nth 1 m))
  4700. (re-search-forward (nth 1 m) end t))
  4701. (and (setq m (memq 'notregexp conditions))
  4702. (stringp (nth 1 m))
  4703. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4704. (and (or
  4705. (setq m (memq 'nottodo conditions))
  4706. (setq m (memq 'todo-unblocked conditions))
  4707. (setq m (memq 'nottodo-unblocked conditions))
  4708. (setq m (memq 'todo conditions)))
  4709. (org-agenda-skip-if-todo m end)))
  4710. end)))
  4711. (defun org-agenda-skip-if-todo (args end)
  4712. "Helper function for `org-agenda-skip-if', do not use it directly.
  4713. ARGS is a list with first element either `todo', `nottodo',
  4714. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4715. a list of TODO keywords, or a state symbol `todo' or `done' or
  4716. `any'."
  4717. (let ((todo-re
  4718. (concat "^\\*+[ \t]+"
  4719. (regexp-opt
  4720. (pcase args
  4721. (`(,_ todo)
  4722. (org-delete-all org-done-keywords
  4723. (copy-sequence org-todo-keywords-1)))
  4724. (`(,_ done) org-done-keywords)
  4725. (`(,_ any) org-todo-keywords-1)
  4726. (`(,_ ,(pred atom))
  4727. (error "Invalid TODO class or type: %S" args))
  4728. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4729. (`(,_ ,todo-list) todo-list))
  4730. 'words))))
  4731. (pcase args
  4732. (`(todo . ,_)
  4733. (let (case-fold-search) (re-search-forward todo-re end t)))
  4734. (`(nottodo . ,_)
  4735. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4736. (`(todo-unblocked . ,_)
  4737. (catch :unblocked
  4738. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4739. (when (org-entry-blocked-p) (throw :unblocked t)))
  4740. nil))
  4741. (`(nottodo-unblocked . ,_)
  4742. (catch :unblocked
  4743. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4744. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4745. t))
  4746. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4747. ;;;###autoload
  4748. (defun org-agenda-list-stuck-projects (&rest _ignore)
  4749. "Create agenda view for projects that are stuck.
  4750. Stuck projects are project that have no next actions. For the definitions
  4751. of what a project is and how to check if it stuck, customize the variable
  4752. `org-stuck-projects'."
  4753. (interactive)
  4754. (let* ((org-agenda-overriding-header
  4755. (or org-agenda-overriding-header "List of stuck projects: "))
  4756. (matcher (nth 0 org-stuck-projects))
  4757. (todo (nth 1 org-stuck-projects))
  4758. (tags (nth 2 org-stuck-projects))
  4759. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4760. (todo-wds
  4761. (if (not (member "*" todo)) todo
  4762. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4763. (org-delete-all org-done-keywords-for-agenda
  4764. (copy-sequence org-todo-keywords-for-agenda))))
  4765. (todo-re (and todo
  4766. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4767. (mapconcat #'identity todo-wds "\\|"))))
  4768. (tags-re (cond ((null tags) nil)
  4769. ((member "*" tags) org-tag-line-re)
  4770. (tags
  4771. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4772. (concat org-outline-regexp-bol
  4773. ".*?[ \t]:"
  4774. other-tags
  4775. (regexp-opt tags t)
  4776. ":" other-tags "[ \t]*$")))
  4777. (t nil)))
  4778. (re-list (delq nil (list todo-re tags-re gen-re)))
  4779. (skip-re
  4780. (if (null re-list)
  4781. (error "Missing information to identify unstuck projects")
  4782. (mapconcat #'identity re-list "\\|")))
  4783. (org-agenda-skip-function
  4784. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4785. ;; in the subtree.
  4786. (lambda ()
  4787. (and (save-excursion
  4788. (let ((case-fold-search nil))
  4789. (re-search-forward
  4790. skip-re (save-excursion (org-end-of-subtree t)) t)))
  4791. (progn (outline-next-heading) (point))))))
  4792. (org-tags-view nil matcher)
  4793. (setq org-agenda-buffer-name (buffer-name))
  4794. (with-current-buffer org-agenda-buffer-name
  4795. (setq org-agenda-redo-command
  4796. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4797. (let ((inhibit-read-only t))
  4798. (add-text-properties
  4799. (point-min) (point-max)
  4800. `(org-redo-cmd ,org-agenda-redo-command))))))
  4801. ;;; Diary integration
  4802. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4803. (defvar diary-list-entries-hook)
  4804. (defvar diary-time-regexp)
  4805. (defvar diary-modify-entry-list-string-function)
  4806. (defvar diary-file-name-prefix)
  4807. (defvar diary-display-function)
  4808. (defun org-get-entries-from-diary (date)
  4809. "Get the (Emacs Calendar) diary entries for DATE."
  4810. (require 'diary-lib)
  4811. (declare-function diary-fancy-display "diary-lib" ())
  4812. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4813. (diary-display-function #'diary-fancy-display)
  4814. (pop-up-frames nil)
  4815. (diary-list-entries-hook
  4816. (cons 'org-diary-default-entry diary-list-entries-hook))
  4817. (diary-file-name-prefix nil) ; turn this feature off
  4818. (diary-modify-entry-list-string-function
  4819. #'org-modify-diary-entry-string)
  4820. (diary-time-regexp (concat "^" diary-time-regexp))
  4821. entries
  4822. (org-disable-agenda-to-diary t))
  4823. (save-excursion
  4824. (save-window-excursion
  4825. (diary-list-entries date 1)))
  4826. (if (not (get-buffer diary-fancy-buffer))
  4827. (setq entries nil)
  4828. (with-current-buffer diary-fancy-buffer
  4829. (setq buffer-read-only nil)
  4830. (if (zerop (buffer-size))
  4831. ;; No entries
  4832. (setq entries nil)
  4833. ;; Omit the date and other unnecessary stuff
  4834. (org-agenda-cleanup-fancy-diary)
  4835. ;; Add prefix to each line and extend the text properties
  4836. (if (zerop (buffer-size))
  4837. (setq entries nil)
  4838. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4839. (setq entries
  4840. (with-temp-buffer
  4841. (insert entries) (goto-char (point-min))
  4842. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4843. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4844. (replace-match (concat "; " (match-string 1)))))
  4845. (buffer-string)))))
  4846. (set-buffer-modified-p nil)
  4847. (kill-buffer diary-fancy-buffer)))
  4848. (when entries
  4849. (setq entries (org-split-string entries "\n"))
  4850. (setq entries
  4851. (mapcar
  4852. (lambda (x)
  4853. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4854. ;; Extend the text properties to the beginning of the line
  4855. (org-add-props x (text-properties-at (1- (length x)) x)
  4856. 'type "diary" 'date date 'face 'org-agenda-diary))
  4857. entries)))))
  4858. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4859. "Hook run when the fancy diary buffer is cleaned up.")
  4860. (defun org-agenda-cleanup-fancy-diary ()
  4861. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4862. This gets rid of the date, the underline under the date, and the
  4863. dummy entry installed by Org mode to ensure non-empty diary for
  4864. each date. It also removes lines that contain only whitespace."
  4865. (goto-char (point-min))
  4866. (if (looking-at ".*?:[ \t]*")
  4867. (progn
  4868. (replace-match "")
  4869. (re-search-forward "\n=+$" nil t)
  4870. (replace-match "")
  4871. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4872. (re-search-forward "\n=+$" nil t)
  4873. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4874. (goto-char (point-min))
  4875. (while (re-search-forward "^ +\n" nil t)
  4876. (replace-match ""))
  4877. (goto-char (point-min))
  4878. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4879. (replace-match ""))
  4880. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4881. (defun org-modify-diary-entry-string (string)
  4882. "Add text properties to string, allowing Org to act on it."
  4883. (org-add-props string nil
  4884. 'mouse-face 'highlight
  4885. 'help-echo (if buffer-file-name
  4886. (format "mouse-2 or RET jump to diary file %s"
  4887. (abbreviate-file-name buffer-file-name))
  4888. "")
  4889. 'org-agenda-diary-link t
  4890. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4891. (defun org-diary-default-entry ()
  4892. "Add a dummy entry to the diary.
  4893. Needed to avoid empty dates which mess up holiday display."
  4894. ;; Catch the error if dealing with the new add-to-diary-alist
  4895. (when org-disable-agenda-to-diary
  4896. (diary-add-to-list original-date "Org mode dummy" "")))
  4897. (defvar org-diary-last-run-time nil)
  4898. ;;;###autoload
  4899. (defun org-diary (&rest args)
  4900. "Return diary information from org files.
  4901. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4902. It accesses org files and extracts information from those files to be
  4903. listed in the diary. The function accepts arguments specifying what
  4904. items should be listed. For a list of arguments allowed here, see the
  4905. variable `org-agenda-entry-types'.
  4906. The call in the diary file should look like this:
  4907. &%%(org-diary) ~/path/to/some/orgfile.org
  4908. Use a separate line for each org file to check. Or, if you omit the file name,
  4909. all files listed in `org-agenda-files' will be checked automatically:
  4910. &%%(org-diary)
  4911. If you don't give any arguments (as in the example above), the default value
  4912. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4913. So the example above may also be written as
  4914. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4915. The function expects the lisp variables `entry' and `date' to be provided
  4916. by the caller, because this is how the calendar works. Don't use this
  4917. function from a program - use `org-agenda-get-day-entries' instead."
  4918. (with-no-warnings (defvar date) (defvar entry))
  4919. (when (> (- (float-time)
  4920. org-agenda-last-marker-time)
  4921. 5)
  4922. ;; I am not sure if this works with sticky agendas, because the marker
  4923. ;; list is then no longer a global variable.
  4924. (org-agenda-reset-markers))
  4925. (org-compile-prefix-format 'agenda)
  4926. (org-set-sorting-strategy 'agenda)
  4927. (setq args (or args org-agenda-entry-types))
  4928. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4929. (list entry)
  4930. (org-agenda-files t)))
  4931. (time (float-time))
  4932. file rtn results)
  4933. (when (or (not org-diary-last-run-time)
  4934. (> (- time
  4935. org-diary-last-run-time)
  4936. 3))
  4937. (org-agenda-prepare-buffers files))
  4938. (setq org-diary-last-run-time time)
  4939. ;; If this is called during org-agenda, don't return any entries to
  4940. ;; the calendar. Org Agenda will list these entries itself.
  4941. (when org-disable-agenda-to-diary (setq files nil))
  4942. (while (setq file (pop files))
  4943. (setq rtn (apply #'org-agenda-get-day-entries file date args))
  4944. (setq results (append results rtn)))
  4945. (when results
  4946. (setq results
  4947. (mapcar (lambda (i) (replace-regexp-in-string
  4948. org-link-bracket-re "\\2" i))
  4949. results))
  4950. (concat (org-agenda-finalize-entries results) "\n"))))
  4951. ;;; Agenda entry finders
  4952. (defun org-agenda--timestamp-to-absolute (&rest args)
  4953. "Call `org-time-string-to-absolute' with ARGS.
  4954. However, throw `:skip' whenever an error is raised."
  4955. (condition-case e
  4956. (apply #'org-time-string-to-absolute args)
  4957. (org-diary-sexp-no-match (throw :skip nil))
  4958. (error
  4959. (message "%s; Skipping entry" (error-message-string e))
  4960. (throw :skip nil))))
  4961. (defun org-agenda-get-day-entries (file date &rest args)
  4962. "Does the work for `org-diary' and `org-agenda'.
  4963. FILE is the path to a file to be checked for entries. DATE is date like
  4964. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4965. which kind of entries should be extracted. For details about these, see
  4966. the documentation of `org-diary'."
  4967. (let* ((org-startup-folded nil)
  4968. (org-startup-align-all-tables nil)
  4969. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4970. (error "No such file %s" file))))
  4971. (if (not buffer)
  4972. ;; If file does not exist, signal it in diary nonetheless.
  4973. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4974. (with-current-buffer buffer
  4975. (unless (derived-mode-p 'org-mode)
  4976. (error "Agenda file %s is not in Org mode" file))
  4977. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4978. (setf org-agenda-current-date date)
  4979. (save-excursion
  4980. (save-restriction
  4981. (if (eq buffer org-agenda-restrict)
  4982. (narrow-to-region org-agenda-restrict-begin
  4983. org-agenda-restrict-end)
  4984. (widen))
  4985. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4986. ;; first in order to populate DEADLINES before passing it.
  4987. ;;
  4988. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4989. ;; guarding us from modifying `org-agenda-entry-types'.
  4990. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4991. (when (and (memq :scheduled args) (memq :scheduled* args))
  4992. (setf args (delq :scheduled* args)))
  4993. (cond
  4994. ((memq :deadline args)
  4995. (setf args (cons :deadline
  4996. (delq :deadline (delq :deadline* args)))))
  4997. ((memq :deadline* args)
  4998. (setf args (cons :deadline* (delq :deadline* args)))))
  4999. ;; Collect list of headlines. Return them flattened.
  5000. (let ((case-fold-search nil) results deadlines)
  5001. (org-dlet
  5002. ((date date))
  5003. (dolist (arg args (apply #'nconc (nreverse results)))
  5004. (pcase arg
  5005. ((and :todo (guard (org-agenda-today-p date)))
  5006. (push (org-agenda-get-todos) results))
  5007. (:timestamp
  5008. (push (org-agenda-get-blocks) results)
  5009. (push (org-agenda-get-timestamps deadlines) results))
  5010. (:sexp
  5011. (push (org-agenda-get-sexps) results))
  5012. (:scheduled
  5013. (push (org-agenda-get-scheduled deadlines) results))
  5014. (:scheduled*
  5015. (push (org-agenda-get-scheduled deadlines t) results))
  5016. (:closed
  5017. (push (org-agenda-get-progress) results))
  5018. (:deadline
  5019. (setf deadlines (org-agenda-get-deadlines))
  5020. (push deadlines results))
  5021. (:deadline*
  5022. (setf deadlines (org-agenda-get-deadlines t))
  5023. (push deadlines results))))))))))))
  5024. (defsubst org-em (x y list)
  5025. "Is X or Y a member of LIST?"
  5026. (or (memq x list) (memq y list)))
  5027. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  5028. (defvar org-agenda-sorting-strategy-selected nil)
  5029. (defun org-agenda-entry-get-agenda-timestamp (pom)
  5030. "Retrieve timestamp information for sorting agenda views.
  5031. Given a point or marker POM, returns a cons cell of the timestamp
  5032. and the timestamp type relevant for the sorting strategy in
  5033. `org-agenda-sorting-strategy-selected'."
  5034. (let (ts ts-date-type)
  5035. (save-match-data
  5036. (cond ((org-em 'scheduled-up 'scheduled-down
  5037. org-agenda-sorting-strategy-selected)
  5038. (setq ts (org-entry-get pom "SCHEDULED")
  5039. ts-date-type " scheduled"))
  5040. ((org-em 'deadline-up 'deadline-down
  5041. org-agenda-sorting-strategy-selected)
  5042. (setq ts (org-entry-get pom "DEADLINE")
  5043. ts-date-type " deadline"))
  5044. ((org-em 'ts-up 'ts-down
  5045. org-agenda-sorting-strategy-selected)
  5046. (setq ts (org-entry-get pom "TIMESTAMP")
  5047. ts-date-type " timestamp"))
  5048. ((org-em 'tsia-up 'tsia-down
  5049. org-agenda-sorting-strategy-selected)
  5050. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  5051. ts-date-type " timestamp_ia"))
  5052. ((org-em 'timestamp-up 'timestamp-down
  5053. org-agenda-sorting-strategy-selected)
  5054. (setq ts (or (org-entry-get pom "SCHEDULED")
  5055. (org-entry-get pom "DEADLINE")
  5056. (org-entry-get pom "TIMESTAMP")
  5057. (org-entry-get pom "TIMESTAMP_IA"))
  5058. ts-date-type ""))
  5059. (t (setq ts-date-type "")))
  5060. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  5061. ts-date-type))))
  5062. (defun org-agenda-get-todos ()
  5063. "Return the TODO information for agenda display."
  5064. (let* ((props (list 'face nil
  5065. 'done-face 'org-agenda-done
  5066. 'org-not-done-regexp org-not-done-regexp
  5067. 'org-todo-regexp org-todo-regexp
  5068. 'org-complex-heading-regexp org-complex-heading-regexp
  5069. 'mouse-face 'highlight
  5070. 'help-echo
  5071. (format "mouse-2 or RET jump to org file %s"
  5072. (abbreviate-file-name buffer-file-name))))
  5073. (case-fold-search nil)
  5074. (regexp (format org-heading-keyword-regexp-format
  5075. (cond
  5076. ((and org-select-this-todo-keyword
  5077. (equal org-select-this-todo-keyword "*"))
  5078. org-todo-regexp)
  5079. (org-select-this-todo-keyword
  5080. (concat "\\("
  5081. (mapconcat #'identity
  5082. (org-split-string
  5083. org-select-this-todo-keyword
  5084. "|")
  5085. "\\|")
  5086. "\\)"))
  5087. (t org-not-done-regexp))))
  5088. marker priority category level tags todo-state
  5089. ts-date ts-date-type ts-date-pair
  5090. ee txt beg end inherited-tags todo-state-end-pos)
  5091. (goto-char (point-min))
  5092. (while (re-search-forward regexp nil t)
  5093. (catch :skip
  5094. (save-match-data
  5095. (beginning-of-line)
  5096. (org-agenda-skip)
  5097. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5098. (unless (and (setq todo-state (org-get-todo-state))
  5099. (setq todo-state-end-pos (match-end 2)))
  5100. (goto-char end)
  5101. (throw :skip nil))
  5102. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5103. (goto-char (1+ beg))
  5104. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5105. (throw :skip nil)))
  5106. (goto-char (match-beginning 2))
  5107. (setq marker (org-agenda-new-marker (match-beginning 0))
  5108. category (org-get-category)
  5109. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5110. ts-date (car ts-date-pair)
  5111. ts-date-type (cdr ts-date-pair)
  5112. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5113. inherited-tags
  5114. (or (eq org-agenda-show-inherited-tags 'always)
  5115. (and (listp org-agenda-show-inherited-tags)
  5116. (memq 'todo org-agenda-show-inherited-tags))
  5117. (and (eq org-agenda-show-inherited-tags t)
  5118. (or (eq org-agenda-use-tag-inheritance t)
  5119. (memq 'todo org-agenda-use-tag-inheritance))))
  5120. tags (org-get-tags nil (not inherited-tags))
  5121. level (make-string (org-reduced-level (org-outline-level)) ? )
  5122. txt (org-agenda-format-item "" txt level category tags t)
  5123. priority (1+ (org-get-priority txt)))
  5124. (org-add-props txt props
  5125. 'org-marker marker 'org-hd-marker marker
  5126. 'priority priority
  5127. 'level level
  5128. 'ts-date ts-date
  5129. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5130. (push txt ee)
  5131. (if org-agenda-todo-list-sublevels
  5132. (goto-char todo-state-end-pos)
  5133. (org-end-of-subtree 'invisible))))
  5134. (nreverse ee)))
  5135. (defun org-agenda-todo-custom-ignore-p (time n)
  5136. "Check whether timestamp is farther away than n number of days.
  5137. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5138. `org-agenda-todo-ignore-scheduled' or
  5139. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5140. (let ((days (org-time-stamp-to-now
  5141. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5142. (if (>= n 0)
  5143. (>= days n)
  5144. (<= days n))))
  5145. ;;;###autoload
  5146. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5147. (&optional end)
  5148. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5149. (when (or org-agenda-todo-ignore-with-date
  5150. org-agenda-todo-ignore-scheduled
  5151. org-agenda-todo-ignore-deadlines
  5152. org-agenda-todo-ignore-timestamp)
  5153. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5154. (save-excursion
  5155. (or (and org-agenda-todo-ignore-with-date
  5156. (re-search-forward org-ts-regexp end t))
  5157. (and org-agenda-todo-ignore-scheduled
  5158. (re-search-forward org-scheduled-time-regexp end t)
  5159. (cond
  5160. ((eq org-agenda-todo-ignore-scheduled 'future)
  5161. (> (org-time-stamp-to-now
  5162. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5163. 0))
  5164. ((eq org-agenda-todo-ignore-scheduled 'past)
  5165. (<= (org-time-stamp-to-now
  5166. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5167. 0))
  5168. ((numberp org-agenda-todo-ignore-scheduled)
  5169. (org-agenda-todo-custom-ignore-p
  5170. (match-string 1) org-agenda-todo-ignore-scheduled))
  5171. (t)))
  5172. (and org-agenda-todo-ignore-deadlines
  5173. (re-search-forward org-deadline-time-regexp end t)
  5174. (cond
  5175. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5176. ((eq org-agenda-todo-ignore-deadlines 'far)
  5177. (not (org-deadline-close-p (match-string 1))))
  5178. ((eq org-agenda-todo-ignore-deadlines 'future)
  5179. (> (org-time-stamp-to-now
  5180. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5181. 0))
  5182. ((eq org-agenda-todo-ignore-deadlines 'past)
  5183. (<= (org-time-stamp-to-now
  5184. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5185. 0))
  5186. ((numberp org-agenda-todo-ignore-deadlines)
  5187. (org-agenda-todo-custom-ignore-p
  5188. (match-string 1) org-agenda-todo-ignore-deadlines))
  5189. (t (org-deadline-close-p (match-string 1)))))
  5190. (and org-agenda-todo-ignore-timestamp
  5191. (let ((buffer (current-buffer))
  5192. (regexp
  5193. (concat
  5194. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5195. (start (point)))
  5196. ;; Copy current buffer into a temporary one
  5197. (with-temp-buffer
  5198. (insert-buffer-substring buffer start end)
  5199. (goto-char (point-min))
  5200. ;; Delete SCHEDULED and DEADLINE items
  5201. (while (re-search-forward regexp end t)
  5202. (delete-region (match-beginning 0) (match-end 0)))
  5203. (goto-char (point-min))
  5204. ;; No search for timestamp left
  5205. (when (re-search-forward org-ts-regexp nil t)
  5206. (cond
  5207. ((eq org-agenda-todo-ignore-timestamp 'future)
  5208. (> (org-time-stamp-to-now
  5209. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5210. 0))
  5211. ((eq org-agenda-todo-ignore-timestamp 'past)
  5212. (<= (org-time-stamp-to-now
  5213. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5214. 0))
  5215. ((numberp org-agenda-todo-ignore-timestamp)
  5216. (org-agenda-todo-custom-ignore-p
  5217. (match-string 1) org-agenda-todo-ignore-timestamp))
  5218. (t))))))))))
  5219. (defun org-agenda-get-timestamps (&optional deadlines)
  5220. "Return the date stamp information for agenda display.
  5221. Optional argument DEADLINES is a list of deadline items to be
  5222. displayed in agenda view."
  5223. (with-no-warnings (defvar date))
  5224. (let* ((props (list 'face 'org-agenda-calendar-event
  5225. 'org-not-done-regexp org-not-done-regexp
  5226. 'org-todo-regexp org-todo-regexp
  5227. 'org-complex-heading-regexp org-complex-heading-regexp
  5228. 'mouse-face 'highlight
  5229. 'help-echo
  5230. (format "mouse-2 or RET jump to Org file %s"
  5231. (abbreviate-file-name buffer-file-name))))
  5232. (current (calendar-absolute-from-gregorian date))
  5233. (today (org-today))
  5234. (deadline-position-alist
  5235. (mapcar (lambda (d)
  5236. (let ((m (get-text-property 0 'org-hd-marker d)))
  5237. (and m (marker-position m))))
  5238. deadlines))
  5239. ;; Match time-stamps set to current date, time-stamps with
  5240. ;; a repeater, and S-exp time-stamps.
  5241. (regexp
  5242. (concat
  5243. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5244. (regexp-quote
  5245. (substring
  5246. (format-time-string
  5247. (car org-time-stamp-formats)
  5248. (encode-time ; DATE bound by calendar
  5249. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5250. 1 11))
  5251. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5252. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5253. timestamp-items)
  5254. (goto-char (point-min))
  5255. (while (re-search-forward regexp nil t)
  5256. ;; Skip date ranges, scheduled and deadlines, which are handled
  5257. ;; specially. Also skip time-stamps before first headline as
  5258. ;; there would be no entry to add to the agenda. Eventually,
  5259. ;; ignore clock entries.
  5260. (catch :skip
  5261. (save-match-data
  5262. (when (or (org-at-date-range-p)
  5263. (org-at-planning-p)
  5264. (org-before-first-heading-p)
  5265. (and org-agenda-include-inactive-timestamps
  5266. (org-at-clock-log-p)))
  5267. (throw :skip nil))
  5268. (org-agenda-skip))
  5269. (let* ((pos (match-beginning 0))
  5270. (repeat (match-string 1))
  5271. (sexp-entry (match-string 3))
  5272. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5273. (save-excursion
  5274. (goto-char pos)
  5275. (looking-at org-ts-regexp-both)
  5276. (match-string 0))))
  5277. (todo-state (org-get-todo-state))
  5278. (warntime (get-text-property (point) 'org-appt-warntime))
  5279. (done? (member todo-state org-done-keywords)))
  5280. ;; Possibly skip done tasks.
  5281. (when (and done? org-agenda-skip-timestamp-if-done)
  5282. (throw :skip t))
  5283. ;; S-exp entry doesn't match current day: skip it.
  5284. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5285. (throw :skip nil))
  5286. (when repeat
  5287. (let* ((past
  5288. ;; A repeating time stamp is shown at its base
  5289. ;; date and every repeated date up to TODAY. If
  5290. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5291. ;; however, only the last repeat before today
  5292. ;; (inclusive) is shown.
  5293. (org-agenda--timestamp-to-absolute
  5294. repeat
  5295. (if (or (> current today)
  5296. (eq org-agenda-prefer-last-repeat t)
  5297. (member todo-state org-agenda-prefer-last-repeat))
  5298. today
  5299. current)
  5300. 'past (current-buffer) pos))
  5301. (future
  5302. ;; Display every repeated date past TODAY
  5303. ;; (exclusive) unless
  5304. ;; `org-agenda-show-future-repeats' is nil. If
  5305. ;; this variable is set to `next', only display
  5306. ;; the first repeated date after TODAY
  5307. ;; (exclusive).
  5308. (cond
  5309. ((<= current today) past)
  5310. ((not org-agenda-show-future-repeats) past)
  5311. (t
  5312. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5313. (1+ today)
  5314. current)))
  5315. (org-agenda--timestamp-to-absolute
  5316. repeat base 'future (current-buffer) pos))))))
  5317. (when (and (/= current past) (/= current future))
  5318. (throw :skip nil))))
  5319. (save-excursion
  5320. (re-search-backward org-outline-regexp-bol nil t)
  5321. ;; Possibly skip time-stamp when a deadline is set.
  5322. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5323. (assq (point) deadline-position-alist))
  5324. (throw :skip nil))
  5325. (let* ((category (org-get-category pos))
  5326. (inherited-tags
  5327. (or (eq org-agenda-show-inherited-tags 'always)
  5328. (and (consp org-agenda-show-inherited-tags)
  5329. (memq 'agenda org-agenda-show-inherited-tags))
  5330. (and (eq org-agenda-show-inherited-tags t)
  5331. (or (eq org-agenda-use-tag-inheritance t)
  5332. (memq 'agenda
  5333. org-agenda-use-tag-inheritance)))))
  5334. (tags (org-get-tags nil (not inherited-tags)))
  5335. (level (make-string (org-reduced-level (org-outline-level))
  5336. ?\s))
  5337. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5338. (match-string 1)))
  5339. (inactive? (= (char-after pos) ?\[))
  5340. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5341. (item
  5342. (org-agenda-format-item
  5343. (and inactive? org-agenda-inactive-leader)
  5344. head level category tags time-stamp org-ts-regexp habit?)))
  5345. (org-add-props item props
  5346. 'priority (if habit?
  5347. (org-habit-get-priority (org-habit-parse-todo))
  5348. (org-get-priority item))
  5349. 'org-marker (org-agenda-new-marker pos)
  5350. 'org-hd-marker (org-agenda-new-marker)
  5351. 'date date
  5352. 'level level
  5353. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5354. current)
  5355. 'todo-state todo-state
  5356. 'warntime warntime
  5357. 'type "timestamp")
  5358. (push item timestamp-items))))
  5359. (when org-agenda-skip-additional-timestamps-same-entry
  5360. (outline-next-heading))))
  5361. (nreverse timestamp-items)))
  5362. (defun org-agenda-get-sexps ()
  5363. "Return the sexp information for agenda display."
  5364. (require 'diary-lib)
  5365. (with-no-warnings (defvar date) (defvar entry))
  5366. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5367. 'mouse-face 'highlight
  5368. 'help-echo
  5369. (format "mouse-2 or RET jump to org file %s"
  5370. (abbreviate-file-name buffer-file-name))))
  5371. (regexp "^&?%%(")
  5372. ;; FIXME: Is this `entry' binding intended to be dynamic,
  5373. ;; so as to "hide" any current binding for it?
  5374. marker category extra level ee txt tags entry
  5375. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5376. (goto-char (point-min))
  5377. (while (re-search-forward regexp nil t)
  5378. (catch :skip
  5379. (org-agenda-skip)
  5380. (setq beg (match-beginning 0))
  5381. (goto-char (1- (match-end 0)))
  5382. (setq b (point))
  5383. (forward-sexp 1)
  5384. (setq sexp (buffer-substring b (point)))
  5385. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5386. (org-trim (match-string 1))
  5387. ""))
  5388. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5389. (when result
  5390. (setq marker (org-agenda-new-marker beg)
  5391. level (make-string (org-reduced-level (org-outline-level)) ? )
  5392. category (org-get-category beg)
  5393. inherited-tags
  5394. (or (eq org-agenda-show-inherited-tags 'always)
  5395. (and (listp org-agenda-show-inherited-tags)
  5396. (memq 'agenda org-agenda-show-inherited-tags))
  5397. (and (eq org-agenda-show-inherited-tags t)
  5398. (or (eq org-agenda-use-tag-inheritance t)
  5399. (memq 'agenda org-agenda-use-tag-inheritance))))
  5400. tags (org-get-tags nil (not inherited-tags))
  5401. todo-state (org-get-todo-state)
  5402. warntime (get-text-property (point) 'org-appt-warntime)
  5403. extra nil)
  5404. (dolist (r (if (stringp result)
  5405. (list result)
  5406. result)) ;; we expect a list here
  5407. (when (and org-agenda-diary-sexp-prefix
  5408. (string-match org-agenda-diary-sexp-prefix r))
  5409. (setq extra (match-string 0 r)
  5410. r (replace-match "" nil nil r)))
  5411. (if (string-match "\\S-" r)
  5412. (setq txt r)
  5413. (setq txt "SEXP entry returned empty string"))
  5414. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5415. (org-add-props txt props 'org-marker marker
  5416. 'date date 'todo-state todo-state
  5417. 'level level 'type "sexp" 'warntime warntime)
  5418. (push txt ee)))))
  5419. (nreverse ee)))
  5420. ;; Calendar sanity: define some functions that are independent of
  5421. ;; `calendar-date-style'.
  5422. (defun org-anniversary (year month day &optional mark)
  5423. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5424. (with-no-warnings
  5425. (let ((calendar-date-style 'iso))
  5426. (diary-anniversary year month day mark))))
  5427. (defun org-cyclic (N year month day &optional mark)
  5428. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5429. (with-no-warnings
  5430. (let ((calendar-date-style 'iso))
  5431. (diary-cyclic N year month day mark))))
  5432. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5433. "Like `diary-block', but with fixed (ISO) order of arguments."
  5434. (with-no-warnings
  5435. (let ((calendar-date-style 'iso))
  5436. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5437. (defun org-date (year month day &optional mark)
  5438. "Like `diary-date', but with fixed (ISO) order of arguments."
  5439. (with-no-warnings
  5440. (let ((calendar-date-style 'iso))
  5441. (diary-date year month day mark))))
  5442. ;; Define the `org-class' function
  5443. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5444. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5445. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5446. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5447. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5448. `holidays', then any date that is known by the Emacs calendar to be a
  5449. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5450. then those holidays will be skipped."
  5451. (with-no-warnings (defvar date) (defvar entry))
  5452. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5453. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5454. (d (calendar-absolute-from-gregorian date))
  5455. (h (when skip-weeks (calendar-check-holidays date))))
  5456. (and
  5457. (<= date1 d)
  5458. (<= d date2)
  5459. (= (calendar-day-of-week date) dayname)
  5460. (or (not skip-weeks)
  5461. (progn
  5462. (require 'cal-iso)
  5463. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5464. (not (or (and h (memq 'holidays skip-weeks))
  5465. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5466. entry)))
  5467. (defalias 'org-get-closed #'org-agenda-get-progress)
  5468. (defun org-agenda-get-progress ()
  5469. "Return the logged TODO entries for agenda display."
  5470. (with-no-warnings (defvar date))
  5471. (let* ((props (list 'mouse-face 'highlight
  5472. 'org-not-done-regexp org-not-done-regexp
  5473. 'org-todo-regexp org-todo-regexp
  5474. 'org-complex-heading-regexp org-complex-heading-regexp
  5475. 'help-echo
  5476. (format "mouse-2 or RET jump to org file %s"
  5477. (abbreviate-file-name buffer-file-name))))
  5478. (items (if (consp org-agenda-show-log-scoped)
  5479. org-agenda-show-log-scoped
  5480. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5481. '(clock)
  5482. org-agenda-log-mode-items)))
  5483. (parts
  5484. (delq nil
  5485. (list
  5486. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5487. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5488. (when (memq 'state items)
  5489. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5490. (parts-re (if parts (mapconcat #'identity parts "\\|")
  5491. (error "`org-agenda-log-mode-items' is empty")))
  5492. (regexp (concat
  5493. "\\(" parts-re "\\)"
  5494. " *\\["
  5495. (regexp-quote
  5496. (substring
  5497. (format-time-string
  5498. (car org-time-stamp-formats)
  5499. (encode-time ; DATE bound by calendar
  5500. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5501. 1 11))))
  5502. (org-agenda-search-headline-for-time nil)
  5503. marker hdmarker priority category level tags closedp type
  5504. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5505. (goto-char (point-min))
  5506. (while (re-search-forward regexp nil t)
  5507. (catch :skip
  5508. (org-agenda-skip)
  5509. (setq marker (org-agenda-new-marker (match-beginning 0))
  5510. closedp (equal (match-string 1) org-closed-string)
  5511. statep (equal (string-to-char (match-string 1)) ?-)
  5512. clockp (not (or closedp statep))
  5513. state (and statep (match-string 2))
  5514. category (org-get-category (match-beginning 0))
  5515. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5516. (when (string-match "\\]" timestr)
  5517. ;; substring should only run to end of time stamp
  5518. (setq rest (substring timestr (match-end 0))
  5519. timestr (substring timestr 0 (match-end 0)))
  5520. (if (and (not closedp) (not statep)
  5521. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5522. rest))
  5523. (progn (setq timestr (concat (substring timestr 0 -1)
  5524. "-" (match-string 1 rest) "]"))
  5525. (setq clocked (match-string 2 rest)))
  5526. (setq clocked "-")))
  5527. (save-excursion
  5528. (setq extra
  5529. (cond
  5530. ((not org-agenda-log-mode-add-notes) nil)
  5531. (statep
  5532. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5533. (match-string 1)))
  5534. (clockp
  5535. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5536. (match-string 1)))))
  5537. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5538. (throw :skip nil)
  5539. (goto-char (match-beginning 0))
  5540. (setq hdmarker (org-agenda-new-marker)
  5541. inherited-tags
  5542. (or (eq org-agenda-show-inherited-tags 'always)
  5543. (and (listp org-agenda-show-inherited-tags)
  5544. (memq 'todo org-agenda-show-inherited-tags))
  5545. (and (eq org-agenda-show-inherited-tags t)
  5546. (or (eq org-agenda-use-tag-inheritance t)
  5547. (memq 'todo org-agenda-use-tag-inheritance))))
  5548. tags (org-get-tags nil (not inherited-tags))
  5549. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5550. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5551. (setq txt (match-string 1))
  5552. (when extra
  5553. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5554. (setq txt (concat (substring txt 0 (match-beginning 1))
  5555. " - " extra " " (match-string 2 txt)))
  5556. (setq txt (concat txt " - " extra))))
  5557. (setq txt (org-agenda-format-item
  5558. (cond
  5559. (closedp "Closed: ")
  5560. (statep (concat "State: (" state ")"))
  5561. (t (concat "Clocked: (" clocked ")")))
  5562. txt level category tags timestr)))
  5563. (setq type (cond (closedp "closed")
  5564. (statep "state")
  5565. (t "clock")))
  5566. (setq priority 100000)
  5567. (org-add-props txt props
  5568. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5569. 'priority priority 'level level
  5570. 'type type 'date date
  5571. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5572. (push txt ee))
  5573. (goto-char (point-at-eol))))
  5574. (nreverse ee)))
  5575. (defun org-agenda-show-clocking-issues ()
  5576. "Add overlays, showing issues with clocking.
  5577. See also the user option `org-agenda-clock-consistency-checks'."
  5578. (interactive)
  5579. (let* ((pl org-agenda-clock-consistency-checks)
  5580. (re (concat "^[ \t]*"
  5581. org-clock-string
  5582. "[ \t]+"
  5583. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5584. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5585. (tlstart 0.)
  5586. (tlend 0.)
  5587. (maxtime (org-duration-to-minutes
  5588. (or (plist-get pl :max-duration) "24:00")))
  5589. (mintime (org-duration-to-minutes
  5590. (or (plist-get pl :min-duration) 0)))
  5591. (maxgap (org-duration-to-minutes
  5592. ;; default 30:00 means never complain
  5593. (or (plist-get pl :max-gap) "30:00")))
  5594. (gapok (mapcar #'org-duration-to-minutes
  5595. (plist-get pl :gap-ok-around)))
  5596. (def-face (or (plist-get pl :default-face)
  5597. '((:background "DarkRed") (:foreground "white"))))
  5598. issue face m te ts dt ov)
  5599. (goto-char (point-min))
  5600. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5601. (setq issue nil face def-face)
  5602. (catch 'next
  5603. (setq m (org-get-at-bol 'org-marker)
  5604. te nil ts nil)
  5605. (unless (and m (markerp m))
  5606. (setq issue "No valid clock line") (throw 'next t))
  5607. (org-with-point-at m
  5608. (save-excursion
  5609. (goto-char (point-at-bol))
  5610. (unless (looking-at re)
  5611. (error "No valid Clock line")
  5612. (throw 'next t))
  5613. (unless (match-end 3)
  5614. (setq issue
  5615. (format
  5616. "No end time: (%s)"
  5617. (org-duration-from-minutes
  5618. (floor
  5619. (- (float-time (org-current-time))
  5620. (float-time (org-time-string-to-time (match-string 1))))
  5621. 60)))
  5622. face (or (plist-get pl :no-end-time-face) face))
  5623. (throw 'next t))
  5624. (setq ts (match-string 1)
  5625. te (match-string 3)
  5626. ts (float-time (org-time-string-to-time ts))
  5627. te (float-time (org-time-string-to-time te))
  5628. dt (- te ts))))
  5629. (cond
  5630. ((> dt (* 60 maxtime))
  5631. ;; a very long clocking chunk
  5632. (setq issue (format "Clocking interval is very long: %s"
  5633. (org-duration-from-minutes (floor dt 60)))
  5634. face (or (plist-get pl :long-face) face)))
  5635. ((< dt (* 60 mintime))
  5636. ;; a very short clocking chunk
  5637. (setq issue (format "Clocking interval is very short: %s"
  5638. (org-duration-from-minutes (floor dt 60)))
  5639. face (or (plist-get pl :short-face) face)))
  5640. ((and (> tlend 0) (< ts tlend))
  5641. ;; Two clock entries are overlapping
  5642. (setq issue (format "Clocking overlap: %d minutes"
  5643. (/ (- tlend ts) 60))
  5644. face (or (plist-get pl :overlap-face) face)))
  5645. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5646. ;; There is a gap, lets see if we need to report it
  5647. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5648. (setq issue (format "Clocking gap: %d minutes"
  5649. (/ (- ts tlend) 60))
  5650. face (or (plist-get pl :gap-face) face))))
  5651. (t nil)))
  5652. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5653. (when issue
  5654. ;; OK, there was some issue, add an overlay to show the issue
  5655. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5656. (overlay-put ov 'before-string
  5657. (concat
  5658. (org-add-props
  5659. (format "%-43s" (concat " " issue))
  5660. nil
  5661. 'face face)
  5662. "\n"))
  5663. (overlay-put ov 'evaporate t)))))
  5664. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5665. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5666. (catch 'exit
  5667. (unless ok-list
  5668. ;; there are no OK times for gaps...
  5669. (throw 'exit nil))
  5670. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5671. ;; This is more than 24 hours, so it is OK.
  5672. ;; because we have at least one OK time, that must be in the
  5673. ;; 24 hour interval.
  5674. (throw 'exit t))
  5675. ;; We have a shorter gap.
  5676. ;; Now we have to get the minute of the day when these times are
  5677. (let* ((t1dec (org-decode-time t1))
  5678. (t2dec (org-decode-time t2))
  5679. ;; compute the minute on the day
  5680. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5681. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5682. (when (< min2 min1)
  5683. ;; if min2 is smaller than min1, this means it is on the next day.
  5684. ;; Wrap it to after midnight.
  5685. (setq min2 (+ min2 1440)))
  5686. ;; Now check if any of the OK times is in the gap
  5687. (mapc (lambda (x)
  5688. ;; Wrap the time to after midnight if necessary
  5689. (when (< x min1) (setq x (+ x 1440)))
  5690. ;; Check if in interval
  5691. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5692. ok-list)
  5693. ;; Nope, this gap is not OK
  5694. nil)))
  5695. (defun org-agenda-get-deadlines (&optional with-hour)
  5696. "Return the deadline information for agenda display.
  5697. When WITH-HOUR is non-nil, only return deadlines with an hour
  5698. specification like [h]h:mm."
  5699. (with-no-warnings (defvar date))
  5700. (let* ((props (list 'mouse-face 'highlight
  5701. 'org-not-done-regexp org-not-done-regexp
  5702. 'org-todo-regexp org-todo-regexp
  5703. 'org-complex-heading-regexp org-complex-heading-regexp
  5704. 'help-echo
  5705. (format "mouse-2 or RET jump to org file %s"
  5706. (abbreviate-file-name buffer-file-name))))
  5707. (regexp (if with-hour
  5708. org-deadline-time-hour-regexp
  5709. org-deadline-time-regexp))
  5710. (today (org-today))
  5711. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5712. (current (calendar-absolute-from-gregorian date))
  5713. deadline-items)
  5714. (goto-char (point-min))
  5715. (while (re-search-forward regexp nil t)
  5716. (catch :skip
  5717. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5718. (org-agenda-skip)
  5719. (let* ((s (match-string 1))
  5720. (pos (1- (match-beginning 1)))
  5721. (todo-state (save-match-data (org-get-todo-state)))
  5722. (done? (member todo-state org-done-keywords))
  5723. (sexp? (string-prefix-p "%%" s))
  5724. ;; DEADLINE is the deadline date for the entry. It is
  5725. ;; either the base date or the last repeat, according
  5726. ;; to `org-agenda-prefer-last-repeat'.
  5727. (deadline
  5728. (cond
  5729. (sexp? (org-agenda--timestamp-to-absolute s current))
  5730. ((or (eq org-agenda-prefer-last-repeat t)
  5731. (member todo-state org-agenda-prefer-last-repeat))
  5732. (org-agenda--timestamp-to-absolute
  5733. s today 'past (current-buffer) pos))
  5734. (t (org-agenda--timestamp-to-absolute s))))
  5735. ;; REPEAT is the future repeat closest from CURRENT,
  5736. ;; according to `org-agenda-show-future-repeats'. If
  5737. ;; the latter is nil, or if the time stamp has no
  5738. ;; repeat part, default to DEADLINE.
  5739. (repeat
  5740. (cond
  5741. (sexp? deadline)
  5742. ((<= current today) deadline)
  5743. ((not org-agenda-show-future-repeats) deadline)
  5744. (t
  5745. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5746. (1+ today)
  5747. current)))
  5748. (org-agenda--timestamp-to-absolute
  5749. s base 'future (current-buffer) pos)))))
  5750. (diff (- deadline current))
  5751. (suppress-prewarning
  5752. (let ((scheduled
  5753. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5754. (org-entry-get nil "SCHEDULED"))))
  5755. (cond
  5756. ((not scheduled) nil)
  5757. ;; The current item has a scheduled date, so
  5758. ;; evaluate its prewarning lead time.
  5759. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5760. ;; Use global prewarning-restart lead time.
  5761. org-agenda-skip-deadline-prewarning-if-scheduled)
  5762. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5763. 'pre-scheduled)
  5764. ;; Set pre-warning to no earlier than SCHEDULED.
  5765. (min (- deadline
  5766. (org-agenda--timestamp-to-absolute scheduled))
  5767. org-deadline-warning-days))
  5768. ;; Set pre-warning to deadline.
  5769. (t 0))))
  5770. (wdays (or suppress-prewarning (org-get-wdays s))))
  5771. (cond
  5772. ;; Only display deadlines at their base date, at future
  5773. ;; repeat occurrences or in today agenda.
  5774. ((= current deadline) nil)
  5775. ((= current repeat) nil)
  5776. ((not today?) (throw :skip nil))
  5777. ;; Upcoming deadline: display within warning period WDAYS.
  5778. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5779. ;; Overdue deadline: warn about it for
  5780. ;; `org-deadline-past-days' duration.
  5781. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5782. ;; Possibly skip done tasks.
  5783. (when (and done?
  5784. (or org-agenda-skip-deadline-if-done
  5785. (/= deadline current)))
  5786. (throw :skip nil))
  5787. (save-excursion
  5788. (re-search-backward "^\\*+[ \t]+" nil t)
  5789. (goto-char (match-end 0))
  5790. (let* ((category (org-get-category))
  5791. (level (make-string (org-reduced-level (org-outline-level))
  5792. ?\s))
  5793. (head (buffer-substring (point) (line-end-position)))
  5794. (inherited-tags
  5795. (or (eq org-agenda-show-inherited-tags 'always)
  5796. (and (listp org-agenda-show-inherited-tags)
  5797. (memq 'agenda org-agenda-show-inherited-tags))
  5798. (and (eq org-agenda-show-inherited-tags t)
  5799. (or (eq org-agenda-use-tag-inheritance t)
  5800. (memq 'agenda
  5801. org-agenda-use-tag-inheritance)))))
  5802. (tags (org-get-tags nil (not inherited-tags)))
  5803. (time
  5804. (cond
  5805. ;; No time of day designation if it is only
  5806. ;; a reminder.
  5807. ((and (/= current deadline) (/= current repeat)) nil)
  5808. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5809. (concat (substring s (match-beginning 1)) " "))
  5810. (t 'time)))
  5811. (item
  5812. (org-agenda-format-item
  5813. ;; Insert appropriate suffixes before deadlines.
  5814. ;; Those only apply to today agenda.
  5815. (pcase-let ((`(,now ,future ,past)
  5816. org-agenda-deadline-leaders))
  5817. (cond
  5818. ((and today? (< deadline today)) (format past (- diff)))
  5819. ((and today? (> deadline today)) (format future diff))
  5820. (t now)))
  5821. head level category tags time))
  5822. (face (org-agenda-deadline-face
  5823. (- 1 (/ (float diff) (max wdays 1)))))
  5824. (upcoming? (and today? (> deadline today)))
  5825. (warntime (get-text-property (point) 'org-appt-warntime)))
  5826. (org-add-props item props
  5827. 'org-marker (org-agenda-new-marker pos)
  5828. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5829. 'warntime warntime
  5830. 'level level
  5831. 'ts-date deadline
  5832. 'priority
  5833. ;; Adjust priority to today reminders about deadlines.
  5834. ;; Overdue deadlines get the highest priority
  5835. ;; increase, then imminent deadlines and eventually
  5836. ;; more distant deadlines.
  5837. (let ((adjust (if today? (- diff) 0)))
  5838. (+ adjust (org-get-priority item)))
  5839. 'todo-state todo-state
  5840. 'type (if upcoming? "upcoming-deadline" "deadline")
  5841. 'date (if upcoming? date deadline)
  5842. 'face (if done? 'org-agenda-done face)
  5843. 'undone-face face
  5844. 'done-face 'org-agenda-done)
  5845. (push item deadline-items))))))
  5846. (nreverse deadline-items)))
  5847. (defun org-agenda-deadline-face (fraction)
  5848. "Return the face to displaying a deadline item.
  5849. FRACTION is what fraction of the head-warning time has passed."
  5850. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5851. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5852. "Return the scheduled information for agenda display.
  5853. Optional argument DEADLINES is a list of deadline items to be
  5854. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5855. scheduled items with an hour specification like [h]h:mm."
  5856. (with-no-warnings (defvar date))
  5857. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5858. 'org-todo-regexp org-todo-regexp
  5859. 'org-complex-heading-regexp org-complex-heading-regexp
  5860. 'done-face 'org-agenda-done
  5861. 'mouse-face 'highlight
  5862. 'help-echo
  5863. (format "mouse-2 or RET jump to Org file %s"
  5864. (abbreviate-file-name buffer-file-name))))
  5865. (regexp (if with-hour
  5866. org-scheduled-time-hour-regexp
  5867. org-scheduled-time-regexp))
  5868. (today (org-today))
  5869. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5870. (current (calendar-absolute-from-gregorian date))
  5871. (deadline-pos
  5872. (mapcar (lambda (d)
  5873. (let ((m (get-text-property 0 'org-hd-marker d)))
  5874. (and m (marker-position m))))
  5875. deadlines))
  5876. scheduled-items)
  5877. (goto-char (point-min))
  5878. (while (re-search-forward regexp nil t)
  5879. (catch :skip
  5880. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5881. (org-agenda-skip)
  5882. (let* ((s (match-string 1))
  5883. (pos (1- (match-beginning 1)))
  5884. (todo-state (save-match-data (org-get-todo-state)))
  5885. (donep (member todo-state org-done-keywords))
  5886. (sexp? (string-prefix-p "%%" s))
  5887. ;; SCHEDULE is the scheduled date for the entry. It is
  5888. ;; either the bare date or the last repeat, according
  5889. ;; to `org-agenda-prefer-last-repeat'.
  5890. (schedule
  5891. (cond
  5892. (sexp? (org-agenda--timestamp-to-absolute s current))
  5893. ((or (eq org-agenda-prefer-last-repeat t)
  5894. (member todo-state org-agenda-prefer-last-repeat))
  5895. (org-agenda--timestamp-to-absolute
  5896. s today 'past (current-buffer) pos))
  5897. (t (org-agenda--timestamp-to-absolute s))))
  5898. ;; REPEAT is the future repeat closest from CURRENT,
  5899. ;; according to `org-agenda-show-future-repeats'. If
  5900. ;; the latter is nil, or if the time stamp has no
  5901. ;; repeat part, default to SCHEDULE.
  5902. (repeat
  5903. (cond
  5904. (sexp? schedule)
  5905. ((<= current today) schedule)
  5906. ((not org-agenda-show-future-repeats) schedule)
  5907. (t
  5908. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5909. (1+ today)
  5910. current)))
  5911. (org-agenda--timestamp-to-absolute
  5912. s base 'future (current-buffer) pos)))))
  5913. (diff (- current schedule))
  5914. (warntime (get-text-property (point) 'org-appt-warntime))
  5915. (pastschedp (< schedule today))
  5916. (futureschedp (> schedule today))
  5917. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5918. (suppress-delay
  5919. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5920. (org-entry-get nil "DEADLINE"))))
  5921. (cond
  5922. ((not deadline) nil)
  5923. ;; The current item has a deadline date, so
  5924. ;; evaluate its delay time.
  5925. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5926. ;; Use global delay time.
  5927. (- org-agenda-skip-scheduled-delay-if-deadline))
  5928. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5929. 'post-deadline)
  5930. ;; Set delay to no later than DEADLINE.
  5931. (min (- schedule
  5932. (org-agenda--timestamp-to-absolute deadline))
  5933. org-scheduled-delay-days))
  5934. (t 0))))
  5935. (ddays
  5936. (cond
  5937. ;; Nullify delay when a repeater triggered already
  5938. ;; and the delay is of the form --Xd.
  5939. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5940. (> schedule (org-agenda--timestamp-to-absolute s)))
  5941. 0)
  5942. (suppress-delay
  5943. (let ((org-scheduled-delay-days suppress-delay))
  5944. (org-get-wdays s t t)))
  5945. (t (org-get-wdays s t)))))
  5946. ;; Display scheduled items at base date (SCHEDULE), today if
  5947. ;; scheduled before the current date, and at any repeat past
  5948. ;; today. However, skip delayed items and items that have
  5949. ;; been displayed for more than `org-scheduled-past-days'.
  5950. (unless (and todayp
  5951. habitp
  5952. (bound-and-true-p org-habit-show-all-today))
  5953. (when (or (and (> ddays 0) (< diff ddays))
  5954. (> diff (or (and habitp org-habit-scheduled-past-days)
  5955. org-scheduled-past-days))
  5956. (> schedule current)
  5957. (and (/= current schedule)
  5958. (/= current today)
  5959. (/= current repeat)))
  5960. (throw :skip nil)))
  5961. ;; Possibly skip done tasks.
  5962. (when (and donep
  5963. (or org-agenda-skip-scheduled-if-done
  5964. (/= schedule current)))
  5965. (throw :skip nil))
  5966. ;; Skip entry if it already appears as a deadline, per
  5967. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5968. ;; doesn't apply to habits.
  5969. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5970. ((guard
  5971. (or (not (memq (line-beginning-position 0) deadline-pos))
  5972. habitp))
  5973. nil)
  5974. (`repeated-after-deadline
  5975. (let ((deadline (time-to-days
  5976. (org-get-deadline-time (point)))))
  5977. (and (<= schedule deadline) (> current deadline))))
  5978. (`not-today pastschedp)
  5979. (`t t)
  5980. (_ nil))
  5981. (throw :skip nil))
  5982. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5983. ;; only show them for today. Also skip done habits.
  5984. (when (and habitp
  5985. (or donep
  5986. (not (bound-and-true-p org-habit-show-habits))
  5987. (and (not todayp)
  5988. (bound-and-true-p
  5989. org-habit-show-habits-only-for-today))))
  5990. (throw :skip nil))
  5991. (save-excursion
  5992. (re-search-backward "^\\*+[ \t]+" nil t)
  5993. (goto-char (match-end 0))
  5994. (let* ((category (org-get-category))
  5995. (inherited-tags
  5996. (or (eq org-agenda-show-inherited-tags 'always)
  5997. (and (listp org-agenda-show-inherited-tags)
  5998. (memq 'agenda org-agenda-show-inherited-tags))
  5999. (and (eq org-agenda-show-inherited-tags t)
  6000. (or (eq org-agenda-use-tag-inheritance t)
  6001. (memq 'agenda
  6002. org-agenda-use-tag-inheritance)))))
  6003. (tags (org-get-tags nil (not inherited-tags)))
  6004. (level (make-string (org-reduced-level (org-outline-level))
  6005. ?\s))
  6006. (head (buffer-substring (point) (line-end-position)))
  6007. (time
  6008. (cond
  6009. ;; No time of day designation if it is only a
  6010. ;; reminder, except for habits, which always show
  6011. ;; the time of day. Habits are an exception
  6012. ;; because if there is a time of day, that is
  6013. ;; interpreted to mean they should usually happen
  6014. ;; then, even if doing the habit was missed.
  6015. ((and
  6016. (not habitp)
  6017. (/= current schedule)
  6018. (/= current repeat))
  6019. nil)
  6020. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6021. (concat (substring s (match-beginning 1)) " "))
  6022. (t 'time)))
  6023. (item
  6024. (org-agenda-format-item
  6025. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6026. ;; Show a reminder of a past scheduled today.
  6027. (if (and todayp pastschedp)
  6028. (format past diff)
  6029. first))
  6030. head level category tags time nil habitp))
  6031. (face (cond ((and (not habitp) pastschedp)
  6032. 'org-scheduled-previously)
  6033. ((and habitp futureschedp)
  6034. 'org-agenda-done)
  6035. (todayp 'org-scheduled-today)
  6036. (t 'org-scheduled)))
  6037. (habitp (and habitp (org-habit-parse-todo))))
  6038. (org-add-props item props
  6039. 'undone-face face
  6040. 'face (if donep 'org-agenda-done face)
  6041. 'org-marker (org-agenda-new-marker pos)
  6042. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6043. 'type (if pastschedp "past-scheduled" "scheduled")
  6044. 'date (if pastschedp schedule date)
  6045. 'ts-date schedule
  6046. 'warntime warntime
  6047. 'level level
  6048. 'priority (if habitp (org-habit-get-priority habitp)
  6049. (+ 99 diff (org-get-priority item)))
  6050. 'org-habit-p habitp
  6051. 'todo-state todo-state)
  6052. (push item scheduled-items))))))
  6053. (nreverse scheduled-items)))
  6054. (defun org-agenda-get-blocks ()
  6055. "Return the date-range information for agenda display."
  6056. (with-no-warnings (defvar date))
  6057. (let* ((props (list 'face nil
  6058. 'org-not-done-regexp org-not-done-regexp
  6059. 'org-todo-regexp org-todo-regexp
  6060. 'org-complex-heading-regexp org-complex-heading-regexp
  6061. 'mouse-face 'highlight
  6062. 'help-echo
  6063. (format "mouse-2 or RET jump to org file %s"
  6064. (abbreviate-file-name buffer-file-name))))
  6065. (regexp org-tr-regexp)
  6066. (d0 (calendar-absolute-from-gregorian date))
  6067. marker hdmarker ee txt d1 d2 s1 s2 category
  6068. level todo-state tags pos head donep inherited-tags)
  6069. (goto-char (point-min))
  6070. (while (re-search-forward regexp nil t)
  6071. (catch :skip
  6072. (org-agenda-skip)
  6073. (setq pos (point))
  6074. (let ((start-time (match-string 1))
  6075. (end-time (match-string 2)))
  6076. (setq s1 (match-string 1)
  6077. s2 (match-string 2)
  6078. d1 (time-to-days
  6079. (condition-case err
  6080. (org-time-string-to-time s1)
  6081. (error
  6082. (error
  6083. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6084. s1
  6085. pos
  6086. (current-buffer)
  6087. (error-message-string err)))))
  6088. d2 (time-to-days
  6089. (condition-case err
  6090. (org-time-string-to-time s2)
  6091. (error
  6092. (error
  6093. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6094. s2
  6095. pos
  6096. (current-buffer)
  6097. (error-message-string err))))))
  6098. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6099. ;; Only allow days between the limits, because the normal
  6100. ;; date stamps will catch the limits.
  6101. (save-excursion
  6102. (setq todo-state (org-get-todo-state))
  6103. (setq donep (member todo-state org-done-keywords))
  6104. (when (and donep org-agenda-skip-timestamp-if-done)
  6105. (throw :skip t))
  6106. (setq marker (org-agenda-new-marker (point))
  6107. category (org-get-category))
  6108. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6109. (throw :skip nil)
  6110. (goto-char (match-beginning 0))
  6111. (setq hdmarker (org-agenda-new-marker (point))
  6112. inherited-tags
  6113. (or (eq org-agenda-show-inherited-tags 'always)
  6114. (and (listp org-agenda-show-inherited-tags)
  6115. (memq 'agenda org-agenda-show-inherited-tags))
  6116. (and (eq org-agenda-show-inherited-tags t)
  6117. (or (eq org-agenda-use-tag-inheritance t)
  6118. (memq 'agenda org-agenda-use-tag-inheritance))))
  6119. tags (org-get-tags nil (not inherited-tags)))
  6120. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6121. (looking-at "\\*+[ \t]+\\(.*\\)")
  6122. (setq head (match-string 1))
  6123. (let ((remove-re
  6124. (if org-agenda-remove-timeranges-from-blocks
  6125. (concat
  6126. "<" (regexp-quote s1) ".*?>"
  6127. "--"
  6128. "<" (regexp-quote s2) ".*?>")
  6129. nil)))
  6130. (setq txt (org-agenda-format-item
  6131. (format
  6132. (nth (if (= d1 d2) 0 1)
  6133. org-agenda-timerange-leaders)
  6134. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6135. head level category tags
  6136. (save-match-data
  6137. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6138. (match-string 6 s1)))
  6139. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6140. (match-string 6 s2))))
  6141. (cond ((string= hhmm1 hhmm2)
  6142. (concat "<" start-time ">--<" end-time ">"))
  6143. ((and (= d1 d0) (= d2 d0))
  6144. (concat "<" start-time ">--<" end-time ">"))
  6145. ((= d1 d0)
  6146. (concat "<" start-time ">"))
  6147. ((= d2 d0)
  6148. (concat "<" end-time ">")))))
  6149. remove-re))))
  6150. (org-add-props txt props
  6151. 'org-marker marker 'org-hd-marker hdmarker
  6152. 'type "block" 'date date
  6153. 'level level
  6154. 'todo-state todo-state
  6155. 'priority (org-get-priority txt))
  6156. (push txt ee))))
  6157. (goto-char pos)))
  6158. ;; Sort the entries by expiration date.
  6159. (nreverse ee)))
  6160. ;;; Agenda presentation and sorting
  6161. (defvar org-prefix-has-time nil
  6162. "A flag, set by `org-compile-prefix-format'.
  6163. The flag is set if the currently compiled format contains a `%t'.")
  6164. (defvar org-prefix-has-tag nil
  6165. "A flag, set by `org-compile-prefix-format'.
  6166. The flag is set if the currently compiled format contains a `%T'.")
  6167. (defvar org-prefix-has-effort nil
  6168. "A flag, set by `org-compile-prefix-format'.
  6169. The flag is set if the currently compiled format contains a `%e'.")
  6170. (defvar org-prefix-has-breadcrumbs nil
  6171. "A flag, set by `org-compile-prefix-format'.
  6172. The flag is set if the currently compiled format contains a `%b'.")
  6173. (defvar org-prefix-category-length nil
  6174. "Used by `org-compile-prefix-format' to remember the category field width.")
  6175. (defvar org-prefix-category-max-length nil
  6176. "Used by `org-compile-prefix-format' to remember the category field width.")
  6177. (defun org-agenda-get-category-icon (category)
  6178. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6179. (cl-dolist (entry org-agenda-category-icon-alist)
  6180. (when (string-match-p (car entry) category)
  6181. (if (listp (cadr entry))
  6182. (cl-return (cadr entry))
  6183. (cl-return (apply #'create-image (cdr entry)))))))
  6184. (defun org-agenda-format-item (extra txt &optional with-level with-category tags dotime
  6185. remove-re habitp)
  6186. "Format TXT to be inserted into the agenda buffer.
  6187. In particular, add the prefix and corresponding text properties.
  6188. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6189. WITH-LEVEL may be a string to replace the `%l' specifier.
  6190. WITH-CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6191. category taken from local variable or file name. It will replace the `%c'
  6192. specifier in the format.
  6193. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6194. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6195. When DOTIME is a string, this string is searched for a time before TXT is.
  6196. TAGS can be the tags of the headline.
  6197. Any match of REMOVE-RE will be removed from TXT."
  6198. ;; We keep the org-prefix-* variable values along with a compiled
  6199. ;; formatter, so that multiple agendas existing at the same time do
  6200. ;; not step on each other toes.
  6201. ;;
  6202. ;; It was inconvenient to make these variables buffer local in
  6203. ;; Agenda buffers, because this function expects to be called with
  6204. ;; the buffer where item comes from being current, and not agenda
  6205. ;; buffer
  6206. (let* ((bindings (car org-prefix-format-compiled))
  6207. (formatter (cadr org-prefix-format-compiled)))
  6208. (cl-loop for (var value) in bindings
  6209. do (set var value))
  6210. (save-match-data
  6211. ;; Diary entries sometimes have extra whitespace at the beginning
  6212. (setq txt (org-trim txt))
  6213. ;; Fix the tags part in txt
  6214. (setq txt (org-agenda-fix-displayed-tags
  6215. txt tags
  6216. org-agenda-show-inherited-tags
  6217. org-agenda-hide-tags-regexp))
  6218. (with-no-warnings
  6219. ;; `time', `tag', `effort' are needed for the eval of the prefix format.
  6220. ;; Based on what I see in `org-compile-prefix-format', I added
  6221. ;; a few more.
  6222. (defvar breadcrumbs) (defvar category) (defvar category-icon)
  6223. (defvar effort) (defvar extra)
  6224. (defvar level) (defvar tag) (defvar time))
  6225. (let* ((category (or with-category
  6226. (if buffer-file-name
  6227. (file-name-sans-extension
  6228. (file-name-nondirectory buffer-file-name))
  6229. "")))
  6230. (category-icon (org-agenda-get-category-icon category))
  6231. (category-icon (if category-icon
  6232. (propertize " " 'display category-icon)
  6233. ""))
  6234. (effort (and (not (string= txt ""))
  6235. (get-text-property 1 'effort txt)))
  6236. (tag (if tags (nth (1- (length tags)) tags) ""))
  6237. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6238. (extra (or (and (not habitp) extra) ""))
  6239. time
  6240. (ts (when dotime (concat
  6241. (if (stringp dotime) dotime "")
  6242. (and org-agenda-search-headline-for-time txt))))
  6243. (time-of-day (and dotime (org-get-time-of-day ts)))
  6244. stamp plain s0 s1 s2 rtn srp l
  6245. duration breadcrumbs)
  6246. (and (derived-mode-p 'org-mode) buffer-file-name
  6247. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6248. (when (and dotime time-of-day)
  6249. ;; Extract starting and ending time and move them to prefix
  6250. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6251. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6252. (setq s0 (match-string 0 ts)
  6253. srp (and stamp (match-end 3))
  6254. s1 (match-string (if plain 1 2) ts)
  6255. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6256. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6257. ;; them, we might want to remove them there to avoid duplication.
  6258. ;; The user can turn this off with a variable.
  6259. (when (and org-prefix-has-time
  6260. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6261. (string-match (concat (regexp-quote s0) " *") txt)
  6262. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6263. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6264. (= (match-beginning 0) 0)
  6265. t))
  6266. (setq txt (replace-match "" nil nil txt))))
  6267. ;; Normalize the time(s) to 24 hour
  6268. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6269. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6270. ;; Try to set s2 if s1 and
  6271. ;; `org-agenda-default-appointment-duration' are set
  6272. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6273. (setq s2
  6274. (org-duration-from-minutes
  6275. (+ (org-duration-to-minutes s1 t)
  6276. org-agenda-default-appointment-duration)
  6277. nil t)))
  6278. ;; Compute the duration
  6279. (when s2
  6280. (setq duration (- (org-duration-to-minutes s2)
  6281. (org-duration-to-minutes s1)))))
  6282. (when (string-match org-tag-group-re txt)
  6283. ;; Tags are in the string
  6284. (if (or (eq org-agenda-remove-tags t)
  6285. (and org-agenda-remove-tags
  6286. org-prefix-has-tag))
  6287. (setq txt (replace-match "" t t txt))
  6288. (setq txt (replace-match
  6289. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6290. (match-string 1 txt))
  6291. t t txt))))
  6292. (when remove-re
  6293. (while (string-match remove-re txt)
  6294. (setq txt (replace-match "" t t txt))))
  6295. ;; Set org-heading property on `txt' to mark the start of the
  6296. ;; heading.
  6297. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6298. ;; Prepare the variables needed in the eval of the compiled format
  6299. (when org-prefix-has-breadcrumbs
  6300. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6301. (let ((s (org-format-outline-path (org-get-outline-path)
  6302. (1- (frame-width))
  6303. nil org-agenda-breadcrumbs-separator)))
  6304. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6305. (setq time (cond (s2 (concat
  6306. (org-agenda-time-of-day-to-ampm-maybe s1)
  6307. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6308. (when org-agenda-timegrid-use-ampm " ")))
  6309. (s1 (concat
  6310. (org-agenda-time-of-day-to-ampm-maybe s1)
  6311. (if org-agenda-timegrid-use-ampm
  6312. (concat time-grid-trailing-characters " ")
  6313. time-grid-trailing-characters)))
  6314. (t ""))
  6315. category (if (symbolp category) (symbol-name category) category)
  6316. level (or with-level ""))
  6317. (if (string-match org-link-bracket-re category)
  6318. (progn
  6319. (setq l (string-width (or (match-string 2) (match-string 1))))
  6320. (when (< l (or org-prefix-category-length 0))
  6321. (setq category (copy-sequence category))
  6322. (org-add-props category nil
  6323. 'extra-space (make-string
  6324. (- org-prefix-category-length l 1) ?\ ))))
  6325. (when (and org-prefix-category-max-length
  6326. (>= (length category) org-prefix-category-max-length))
  6327. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6328. ;; Evaluate the compiled format
  6329. (setq rtn (concat (eval formatter t) txt))
  6330. ;; And finally add the text properties
  6331. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6332. (org-add-props rtn nil
  6333. 'org-category category
  6334. 'tags tags
  6335. 'org-priority-highest org-priority-highest
  6336. 'org-priority-lowest org-priority-lowest
  6337. 'time-of-day time-of-day
  6338. 'duration duration
  6339. 'breadcrumbs breadcrumbs
  6340. 'txt txt
  6341. 'level level
  6342. 'time time
  6343. 'extra extra
  6344. 'format org-prefix-format-compiled
  6345. 'dotime dotime)))))
  6346. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6347. "Remove tags string from TXT, and add a modified list of tags.
  6348. The modified list may contain inherited tags, and tags matched by
  6349. `org-agenda-hide-tags-regexp' will be removed."
  6350. (when (or add-inherited hide-re)
  6351. (when (string-match org-tag-group-re txt)
  6352. (setq txt (substring txt 0 (match-beginning 0))))
  6353. (setq tags
  6354. (delq nil
  6355. (mapcar (lambda (tg)
  6356. (if (or (and hide-re (string-match hide-re tg))
  6357. (and (not add-inherited)
  6358. (get-text-property 0 'inherited tg)))
  6359. nil
  6360. tg))
  6361. tags)))
  6362. (when tags
  6363. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6364. i)
  6365. (setq txt (concat txt " :"
  6366. (mapconcat
  6367. (lambda (x)
  6368. (setq i (get-text-property 0 'inherited x))
  6369. (if (and have-i (not i))
  6370. (progn
  6371. (setq have-i nil)
  6372. (concat ":" x))
  6373. x))
  6374. tags ":")
  6375. (if have-i "::" ":"))))))
  6376. txt)
  6377. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6378. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6379. "Add a time-grid for agenda items which need it.
  6380. LIST is the list of agenda items formatted by `org-agenda-list'.
  6381. NDAYS is the span of the current agenda view.
  6382. TODAYP is t when the current agenda view is on today."
  6383. (catch 'exit
  6384. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6385. ((and todayp (member 'today (car org-agenda-time-grid))))
  6386. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6387. ((member 'weekly (car org-agenda-time-grid)))
  6388. (t (throw 'exit list)))
  6389. (let* ((have (delq nil (mapcar
  6390. (lambda (x) (get-text-property 1 'time-of-day x))
  6391. list)))
  6392. (string (nth 3 org-agenda-time-grid))
  6393. (gridtimes (nth 1 org-agenda-time-grid))
  6394. (req (car org-agenda-time-grid))
  6395. (remove (member 'remove-match req))
  6396. new time)
  6397. (when (and (member 'require-timed req) (not have))
  6398. ;; don't show empty grid
  6399. (throw 'exit list))
  6400. (while (setq time (pop gridtimes))
  6401. (unless (and remove (member time have))
  6402. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6403. (push (org-agenda-format-item
  6404. nil string nil "" nil
  6405. (concat (substring time 0 -2) ":" (substring time -2)))
  6406. new)
  6407. (put-text-property
  6408. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6409. (when (and todayp org-agenda-show-current-time-in-grid)
  6410. (push (org-agenda-format-item
  6411. nil org-agenda-current-time-string nil "" nil
  6412. (format-time-string "%H:%M "))
  6413. new)
  6414. (put-text-property
  6415. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6416. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6417. (append new list)
  6418. (append list new)))))
  6419. (defun org-compile-prefix-format (key)
  6420. "Compile the prefix format into a Lisp form that can be evaluated.
  6421. The resulting form and associated variable bindings is returned
  6422. and stored in the variable `org-prefix-format-compiled'."
  6423. (setq org-prefix-has-time nil
  6424. org-prefix-has-tag nil
  6425. org-prefix-category-length nil
  6426. org-prefix-has-effort nil
  6427. org-prefix-has-breadcrumbs nil)
  6428. (let ((s (cond
  6429. ((stringp org-agenda-prefix-format)
  6430. org-agenda-prefix-format)
  6431. ((assq key org-agenda-prefix-format)
  6432. (cdr (assq key org-agenda-prefix-format)))
  6433. (t " %-12:c%?-12t% s")))
  6434. (start 0)
  6435. varform vars var c f opt) ;; e
  6436. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+?)\\)"
  6437. s start)
  6438. (setq var (or (cdr (assoc (match-string 4 s)
  6439. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6440. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6441. 'eval)
  6442. c (or (match-string 3 s) "")
  6443. opt (match-beginning 1)
  6444. start (1+ (match-beginning 0)))
  6445. (cl-case var
  6446. (time (setq org-prefix-has-time t))
  6447. (tag (setq org-prefix-has-tag t))
  6448. (effort (setq org-prefix-has-effort t))
  6449. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6450. (setq f (concat "%" (match-string 2 s) "s"))
  6451. (when (eq var 'category)
  6452. (setq org-prefix-category-length
  6453. (floor (abs (string-to-number (match-string 2 s)))))
  6454. (setq org-prefix-category-max-length
  6455. (let ((x (match-string 2 s)))
  6456. (save-match-data
  6457. (and (string-match "\\.[0-9]+" x)
  6458. (string-to-number (substring (match-string 0 x) 1)))))))
  6459. (if (eq var 'eval)
  6460. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6461. (if opt
  6462. (setq varform
  6463. `(if (member ,var '("" nil))
  6464. ""
  6465. (format ,f (concat ,var ,c))))
  6466. (setq varform
  6467. `(format ,f (if (member ,var '("" nil)) ""
  6468. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6469. (setq s (replace-match "%s" t nil s))
  6470. (push varform vars))
  6471. (setq vars (nreverse vars))
  6472. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6473. (setq org-prefix-format-compiled
  6474. (list
  6475. `((org-prefix-has-time ,org-prefix-has-time)
  6476. (org-prefix-has-tag ,org-prefix-has-tag)
  6477. (org-prefix-category-length ,org-prefix-category-length)
  6478. (org-prefix-has-effort ,org-prefix-has-effort)
  6479. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6480. `(format ,s ,@vars))))))
  6481. (defun org-set-sorting-strategy (key)
  6482. (setq org-agenda-sorting-strategy-selected
  6483. (if (symbolp (car org-agenda-sorting-strategy))
  6484. ;; the old format
  6485. org-agenda-sorting-strategy
  6486. (or (cdr (assq key org-agenda-sorting-strategy))
  6487. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6488. '(time-up category-keep priority-down)))))
  6489. (defun org-get-time-of-day (s &optional string mod24)
  6490. "Check string S for a time of day.
  6491. If found, return it as a military time number between 0 and 2400.
  6492. If not found, return nil.
  6493. The optional STRING argument forces conversion into a 5 character wide string
  6494. HH:MM."
  6495. (save-match-data
  6496. (when
  6497. (and
  6498. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6499. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6500. (not (eq (get-text-property 1 'face s) 'org-link)))
  6501. (let* ((h (string-to-number (match-string 1 s)))
  6502. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6503. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6504. (am-p (equal ampm "am"))
  6505. (h1 (cond ((not ampm) h)
  6506. ((= h 12) (if am-p 0 12))
  6507. (t (+ h (if am-p 0 12)))))
  6508. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6509. (mod h1 24) h1))
  6510. (t0 (+ (* 100 h2) m))
  6511. (t1 (concat (if (>= h1 24) "+" " ")
  6512. (if (and org-agenda-time-leading-zero
  6513. (< t0 1000)) "0" "")
  6514. (if (< t0 100) "0" "")
  6515. (if (< t0 10) "0" "")
  6516. (number-to-string t0))))
  6517. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6518. (defvar org-agenda-before-sorting-filter-function nil
  6519. "Function to be applied to agenda items prior to sorting.
  6520. Prior to sorting also means just before they are inserted into the agenda.
  6521. To aid sorting, you may revisit the original entries and add more text
  6522. properties which will later be used by the sorting functions.
  6523. The function should take a string argument, an agenda line.
  6524. It has access to the text properties in that line, which contain among
  6525. other things, the property `org-hd-marker' that points to the entry
  6526. where the line comes from. Note that not all lines going into the agenda
  6527. have this property, only most.
  6528. The function should return the modified string. It is probably best
  6529. to ONLY change text properties.
  6530. You can also use this function as a filter, by returning nil for lines
  6531. you don't want to have in the agenda at all. For this application, you
  6532. could bind the variable in the options section of a custom command.")
  6533. (defun org-agenda-finalize-entries (list &optional type)
  6534. "Sort, limit and concatenate the LIST of agenda items.
  6535. The optional argument TYPE tells the agenda type."
  6536. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6537. (cdr (assoc type org-agenda-max-effort)))
  6538. (t org-agenda-max-effort)))
  6539. (max-todo (cond ((listp org-agenda-max-todos)
  6540. (cdr (assoc type org-agenda-max-todos)))
  6541. (t org-agenda-max-todos)))
  6542. (max-tags (cond ((listp org-agenda-max-tags)
  6543. (cdr (assoc type org-agenda-max-tags)))
  6544. (t org-agenda-max-tags)))
  6545. (max-entries (cond ((listp org-agenda-max-entries)
  6546. (cdr (assoc type org-agenda-max-entries)))
  6547. (t org-agenda-max-entries))))
  6548. (when org-agenda-before-sorting-filter-function
  6549. (setq list
  6550. (delq nil
  6551. (mapcar
  6552. org-agenda-before-sorting-filter-function list))))
  6553. (setq list (mapcar #'org-agenda-highlight-todo list)
  6554. list (mapcar #'identity (sort list #'org-entries-lessp)))
  6555. (when max-effort
  6556. (setq list (org-agenda-limit-entries
  6557. list 'effort-minutes max-effort
  6558. (lambda (e) (or e (if org-agenda-sort-noeffort-is-high
  6559. 32767 -1))))))
  6560. (when max-todo
  6561. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6562. (when max-tags
  6563. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6564. (when max-entries
  6565. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6566. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6567. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6568. (mapconcat #'identity list "\n")))
  6569. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6570. "Limit the number of agenda entries."
  6571. (let ((include (and limit (< limit 0))))
  6572. (if limit
  6573. (let ((fun (or fn (lambda (p) (when p 1))))
  6574. (lim 0))
  6575. (delq nil
  6576. (mapcar
  6577. (lambda (e)
  6578. (let ((pval (funcall
  6579. fun (get-text-property (1- (length e))
  6580. prop e))))
  6581. (when pval (setq lim (+ lim pval)))
  6582. (cond ((and pval (<= lim (abs limit))) e)
  6583. ((and include (not pval)) e))))
  6584. list)))
  6585. list)))
  6586. (defun org-agenda-limit-interactively (remove)
  6587. "In agenda, interactively limit entries to various maximums."
  6588. (interactive "P")
  6589. (if remove
  6590. (progn (setq org-agenda-max-entries nil
  6591. org-agenda-max-todos nil
  6592. org-agenda-max-tags nil
  6593. org-agenda-max-effort nil)
  6594. (org-agenda-redo))
  6595. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6596. (msg (cond ((= max ?E) "How many minutes? ")
  6597. ((= max ?e) "How many entries? ")
  6598. ((= max ?t) "How many TODO entries? ")
  6599. ((= max ?T) "How many tagged entries? ")
  6600. (t (user-error "Wrong input"))))
  6601. (num (string-to-number (read-from-minibuffer msg))))
  6602. (cond ((equal max ?e)
  6603. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6604. ((equal max ?t)
  6605. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6606. ((equal max ?T)
  6607. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6608. ((equal max ?E)
  6609. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6610. (org-agenda-fit-window-to-buffer))
  6611. (defun org-agenda-highlight-todo (x)
  6612. (let ((org-done-keywords org-done-keywords-for-agenda)
  6613. (case-fold-search nil)
  6614. re)
  6615. (if (eq x 'line)
  6616. (save-excursion
  6617. (beginning-of-line 1)
  6618. (setq re (org-get-at-bol 'org-todo-regexp))
  6619. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6620. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6621. (add-text-properties (match-beginning 0) (match-end 1)
  6622. (list 'face (org-get-todo-face 1)))
  6623. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6624. (delete-region (match-beginning 1) (1- (match-end 0)))
  6625. (goto-char (match-beginning 1))
  6626. (insert (format org-agenda-todo-keyword-format s)))))
  6627. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6628. (setq re (get-text-property 0 'org-todo-regexp x))
  6629. (when (and re
  6630. ;; Test `pl' because if there's no heading content,
  6631. ;; there's no point matching to highlight. Note
  6632. ;; that if we didn't test `pl' first, and there
  6633. ;; happened to be no keyword from `org-todo-regexp'
  6634. ;; on this heading line, then the `equal' comparison
  6635. ;; afterwards would spuriously succeed in the case
  6636. ;; where `pl' is nil -- causing an args-out-of-range
  6637. ;; error when we try to add text properties to text
  6638. ;; that isn't there.
  6639. pl
  6640. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6641. x pl)
  6642. pl))
  6643. (add-text-properties
  6644. (or (match-end 1) (match-end 0)) (match-end 0)
  6645. (list 'face (org-get-todo-face (match-string 2 x)))
  6646. x)
  6647. (when (match-end 1)
  6648. (setq x
  6649. (concat
  6650. (substring x 0 (match-end 1))
  6651. (format org-agenda-todo-keyword-format
  6652. (match-string 2 x))
  6653. ;; Remove `display' property as the icon could leak
  6654. ;; on the white space.
  6655. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6656. 'display))
  6657. (substring x (match-end 3)))))))
  6658. x)))
  6659. (defsubst org-cmp-values (a b property)
  6660. "Compare the numeric value of text PROPERTY for string A and B."
  6661. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6662. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6663. (cond ((> pa pb) +1)
  6664. ((< pa pb) -1))))
  6665. (defsubst org-cmp-effort (a b)
  6666. "Compare the effort values of string A and B."
  6667. (let* ((def (if org-agenda-sort-noeffort-is-high 32767 -1))
  6668. ;; `effort-minutes' property is not directly accessible from
  6669. ;; the strings, but is stored as a property in `txt'.
  6670. (ea (or (get-text-property
  6671. 0 'effort-minutes (get-text-property 0 'txt a))
  6672. def))
  6673. (eb (or (get-text-property
  6674. 0 'effort-minutes (get-text-property 0 'txt b))
  6675. def)))
  6676. (cond ((> ea eb) +1)
  6677. ((< ea eb) -1))))
  6678. (defsubst org-cmp-category (a b)
  6679. "Compare the string values of categories of strings A and B."
  6680. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6681. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6682. (cond ((string-lessp ca cb) -1)
  6683. ((string-lessp cb ca) +1))))
  6684. (defsubst org-cmp-todo-state (a b)
  6685. "Compare the todo states of strings A and B."
  6686. (let* ((ma (or (get-text-property 1 'org-marker a)
  6687. (get-text-property 1 'org-hd-marker a)))
  6688. (mb (or (get-text-property 1 'org-marker b)
  6689. (get-text-property 1 'org-hd-marker b)))
  6690. (fa (and ma (marker-buffer ma)))
  6691. (fb (and mb (marker-buffer mb)))
  6692. (todo-kwds
  6693. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6694. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6695. (ta (or (get-text-property 1 'todo-state a) ""))
  6696. (tb (or (get-text-property 1 'todo-state b) ""))
  6697. (la (- (length (member ta todo-kwds))))
  6698. (lb (- (length (member tb todo-kwds))))
  6699. (donepa (member ta org-done-keywords-for-agenda))
  6700. (donepb (member tb org-done-keywords-for-agenda)))
  6701. (cond ((and donepa (not donepb)) -1)
  6702. ((and (not donepa) donepb) +1)
  6703. ((< la lb) -1)
  6704. ((< lb la) +1))))
  6705. (defsubst org-cmp-alpha (a b)
  6706. "Compare the headlines, alphabetically."
  6707. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6708. (plb (text-property-any 0 (length b) 'org-heading t b))
  6709. (ta (and pla (substring a pla)))
  6710. (tb (and plb (substring b plb)))
  6711. (case-fold-search nil))
  6712. (when pla
  6713. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6714. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6715. ta)
  6716. (setq ta (substring ta (match-end 0))))
  6717. (setq ta (downcase ta)))
  6718. (when plb
  6719. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6720. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6721. tb)
  6722. (setq tb (substring tb (match-end 0))))
  6723. (setq tb (downcase tb)))
  6724. (cond ((not (or ta tb)) nil)
  6725. ((not ta) +1)
  6726. ((not tb) -1)
  6727. ((string-lessp ta tb) -1)
  6728. ((string-lessp tb ta) +1))))
  6729. (defsubst org-cmp-tag (a b)
  6730. "Compare the string values of the first tags of A and B."
  6731. (let ((ta (car (last (get-text-property 1 'tags a))))
  6732. (tb (car (last (get-text-property 1 'tags b)))))
  6733. (cond ((not (or ta tb)) nil)
  6734. ((not ta) +1)
  6735. ((not tb) -1)
  6736. ((string-lessp ta tb) -1)
  6737. ((string-lessp tb ta) +1))))
  6738. (defsubst org-cmp-time (a b)
  6739. "Compare the time-of-day values of strings A and B."
  6740. (let* ((def (if org-agenda-sort-notime-is-late 9901 -1))
  6741. (ta (or (get-text-property 1 'time-of-day a) def))
  6742. (tb (or (get-text-property 1 'time-of-day b) def)))
  6743. (cond ((< ta tb) -1)
  6744. ((< tb ta) +1))))
  6745. (defsubst org-cmp-ts (a b type)
  6746. "Compare the timestamps values of entries A and B.
  6747. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6748. \"timestamp_ia\", compare within each of these type. When TYPE
  6749. is the empty string, compare all timestamps without respect of
  6750. their type."
  6751. (let* ((def (and (not org-agenda-sort-notime-is-late) -1))
  6752. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6753. (get-text-property 1 'ts-date a))
  6754. def))
  6755. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6756. (get-text-property 1 'ts-date b))
  6757. def)))
  6758. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6759. ((if tb (and ta (< tb ta)) ta) +1))))
  6760. (defsubst org-cmp-habit-p (a b)
  6761. "Compare the todo states of strings A and B."
  6762. (let ((ha (get-text-property 1 'org-habit-p a))
  6763. (hb (get-text-property 1 'org-habit-p b)))
  6764. (cond ((and ha (not hb)) -1)
  6765. ((and (not ha) hb) +1))))
  6766. (defun org-entries-lessp (a b)
  6767. "Predicate for sorting agenda entries."
  6768. ;; The following variables will be used when the form is evaluated.
  6769. ;; So even though the compiler complains, keep them.
  6770. (let ((ss org-agenda-sorting-strategy-selected))
  6771. (org-dlet
  6772. ((timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6773. (org-cmp-ts a b "")))
  6774. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6775. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6776. (org-cmp-ts a b "scheduled")))
  6777. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6778. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6779. (org-cmp-ts a b "deadline")))
  6780. (deadline-down (if deadline-up (- deadline-up) nil))
  6781. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6782. (org-cmp-ts a b "timestamp_ia")))
  6783. (tsia-down (if tsia-up (- tsia-up) nil))
  6784. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6785. (org-cmp-ts a b "timestamp")))
  6786. (ts-down (if ts-up (- ts-up) nil))
  6787. (time-up (and (org-em 'time-up 'time-down ss)
  6788. (org-cmp-time a b)))
  6789. (time-down (if time-up (- time-up) nil))
  6790. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6791. (org-cmp-values a b 'org-stats)))
  6792. (stats-down (if stats-up (- stats-up) nil))
  6793. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6794. (org-cmp-values a b 'priority)))
  6795. (priority-down (if priority-up (- priority-up) nil))
  6796. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6797. (org-cmp-effort a b)))
  6798. (effort-down (if effort-up (- effort-up) nil))
  6799. (category-up (and (or (org-em 'category-up 'category-down ss)
  6800. (memq 'category-keep ss))
  6801. (org-cmp-category a b)))
  6802. (category-down (if category-up (- category-up) nil))
  6803. (category-keep (if category-up +1 nil))
  6804. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6805. (org-cmp-tag a b)))
  6806. (tag-down (if tag-up (- tag-up) nil))
  6807. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6808. (org-cmp-todo-state a b)))
  6809. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6810. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6811. (org-cmp-habit-p a b)))
  6812. (habit-down (if habit-up (- habit-up) nil))
  6813. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6814. (org-cmp-alpha a b)))
  6815. (alpha-down (if alpha-up (- alpha-up) nil))
  6816. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6817. user-defined-up user-defined-down)
  6818. (when (and need-user-cmp org-agenda-cmp-user-defined
  6819. (functionp org-agenda-cmp-user-defined))
  6820. (setq user-defined-up
  6821. (funcall org-agenda-cmp-user-defined a b)
  6822. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6823. (cdr (assoc
  6824. (eval (cons 'or org-agenda-sorting-strategy-selected) t)
  6825. '((-1 . t) (1 . nil) (nil . nil)))))))
  6826. ;;; Agenda restriction lock
  6827. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6828. "Overlay to mark the headline to which agenda commands are restricted.")
  6829. (overlay-put org-agenda-restriction-lock-overlay
  6830. 'face 'org-agenda-restriction-lock)
  6831. (overlay-put org-agenda-restriction-lock-overlay
  6832. 'help-echo "Agendas are currently limited to this subtree.")
  6833. (delete-overlay org-agenda-restriction-lock-overlay)
  6834. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6835. "Set the restriction lock to the agenda item at point from within the agenda.
  6836. When called with a `\\[universal-argument]' prefix, restrict to
  6837. the file which contains the item.
  6838. Argument ARG is the prefix argument."
  6839. (interactive "P")
  6840. (unless (derived-mode-p 'org-agenda-mode)
  6841. (user-error "Not in an Org agenda buffer"))
  6842. (let* ((marker (or (org-get-at-bol 'org-marker)
  6843. (org-agenda-error)))
  6844. (buffer (marker-buffer marker))
  6845. (pos (marker-position marker)))
  6846. (with-current-buffer buffer
  6847. (goto-char pos)
  6848. (org-agenda-set-restriction-lock arg))))
  6849. ;;;###autoload
  6850. (defun org-agenda-set-restriction-lock (&optional type)
  6851. "Set restriction lock for agenda to current subtree or file.
  6852. When in a restricted subtree, remove it.
  6853. The restriction will span over the entire file if TYPE is `file',
  6854. or if type is '(4), or if the cursor is before the first headline
  6855. in the file. Otherwise, only apply the restriction to the current
  6856. subtree."
  6857. (interactive "P")
  6858. (if (and org-agenda-overriding-restriction
  6859. (member org-agenda-restriction-lock-overlay
  6860. (overlays-at (point)))
  6861. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6862. (point)))
  6863. (org-agenda-remove-restriction-lock 'noupdate)
  6864. (org-agenda-remove-restriction-lock 'noupdate)
  6865. (and (equal type '(4)) (setq type 'file))
  6866. (setq type (cond
  6867. (type type)
  6868. ((org-at-heading-p) 'subtree)
  6869. ((condition-case nil (org-back-to-heading t) (error nil))
  6870. 'subtree)
  6871. (t 'file)))
  6872. (if (eq type 'subtree)
  6873. (progn
  6874. (setq org-agenda-restrict (current-buffer))
  6875. (setq org-agenda-overriding-restriction 'subtree)
  6876. (put 'org-agenda-files 'org-restrict
  6877. (list (buffer-file-name (buffer-base-buffer))))
  6878. (org-back-to-heading t)
  6879. (move-overlay org-agenda-restriction-lock-overlay
  6880. (point)
  6881. (if org-agenda-restriction-lock-highlight-subtree
  6882. (save-excursion (org-end-of-subtree t t) (point))
  6883. (point-at-eol)))
  6884. (move-marker org-agenda-restrict-begin (point))
  6885. (move-marker org-agenda-restrict-end
  6886. (save-excursion (org-end-of-subtree t t)))
  6887. (message "Locking agenda restriction to subtree"))
  6888. (put 'org-agenda-files 'org-restrict
  6889. (list (buffer-file-name (buffer-base-buffer))))
  6890. (setq org-agenda-restrict nil)
  6891. (setq org-agenda-overriding-restriction 'file)
  6892. (move-marker org-agenda-restrict-begin nil)
  6893. (move-marker org-agenda-restrict-end nil)
  6894. (message "Locking agenda restriction to file"))
  6895. (setq current-prefix-arg nil))
  6896. (org-agenda-maybe-redo))
  6897. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6898. "Remove agenda restriction lock."
  6899. (interactive "P")
  6900. (if (not org-agenda-restrict)
  6901. (message "No agenda restriction to remove.")
  6902. (delete-overlay org-agenda-restriction-lock-overlay)
  6903. (delete-overlay org-speedbar-restriction-lock-overlay)
  6904. (setq org-agenda-overriding-restriction nil)
  6905. (setq org-agenda-restrict nil)
  6906. (put 'org-agenda-files 'org-restrict nil)
  6907. (move-marker org-agenda-restrict-begin nil)
  6908. (move-marker org-agenda-restrict-end nil)
  6909. (setq current-prefix-arg nil)
  6910. (message "Agenda restriction lock removed")
  6911. (or noupdate (org-agenda-maybe-redo))))
  6912. (defun org-agenda-maybe-redo ()
  6913. "If there is any window showing the agenda view, update it."
  6914. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6915. org-agenda-buffer-name)
  6916. t))
  6917. (w0 (selected-window)))
  6918. (when w
  6919. (select-window w)
  6920. (org-agenda-redo)
  6921. (select-window w0)
  6922. (if org-agenda-overriding-restriction
  6923. (message "Agenda view shifted to new %s restriction"
  6924. org-agenda-overriding-restriction)
  6925. (message "Agenda restriction lock removed")))))
  6926. ;;; Agenda commands
  6927. (defun org-agenda-check-type (error &rest types)
  6928. "Check if agenda buffer or component is of allowed type.
  6929. If ERROR is non-nil, throw an error, otherwise just return nil.
  6930. Allowed types are `agenda' `todo' `tags' `search'."
  6931. (cond ((not org-agenda-type)
  6932. (error "No Org agenda currently displayed"))
  6933. ((memq org-agenda-type types) t)
  6934. (error
  6935. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  6936. (t nil)))
  6937. (defun org-agenda-Quit ()
  6938. "Exit the agenda, killing the agenda buffer.
  6939. Like `org-agenda-quit', but kill the buffer even when
  6940. `org-agenda-sticky' is non-nil."
  6941. (interactive)
  6942. (org-agenda--quit))
  6943. (defun org-agenda-quit ()
  6944. "Exit the agenda.
  6945. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6946. instead of killing it.
  6947. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6948. the pre-agenda window configuration.
  6949. When column view is active, exit column view instead of the
  6950. agenda."
  6951. (interactive)
  6952. (org-agenda--quit org-agenda-sticky))
  6953. (defun org-agenda--quit (&optional bury)
  6954. (if org-agenda-columns-active
  6955. (org-columns-quit)
  6956. (let ((wconf org-agenda-pre-window-conf)
  6957. (buf (current-buffer))
  6958. (org-agenda-last-indirect-window
  6959. (and (eq org-indirect-buffer-display 'other-window)
  6960. org-agenda-last-indirect-buffer
  6961. (get-buffer-window org-agenda-last-indirect-buffer))))
  6962. (cond
  6963. ((eq org-agenda-window-setup 'other-frame)
  6964. (delete-frame))
  6965. ((eq org-agenda-window-setup 'other-tab)
  6966. (if (fboundp 'tab-bar-close-tab)
  6967. (tab-bar-close-tab)
  6968. (user-error "Your version of Emacs does not have tab bar mode support")))
  6969. ((and org-agenda-restore-windows-after-quit
  6970. wconf)
  6971. ;; Maybe restore the pre-agenda window configuration. Reset
  6972. ;; `org-agenda-pre-window-conf' before running
  6973. ;; `set-window-configuration', which loses the current buffer.
  6974. (setq org-agenda-pre-window-conf nil)
  6975. (set-window-configuration wconf))
  6976. (t
  6977. (when org-agenda-last-indirect-window
  6978. (delete-window org-agenda-last-indirect-window))
  6979. (and (not (eq org-agenda-window-setup 'current-window))
  6980. (not (one-window-p))
  6981. (delete-window))))
  6982. (if bury
  6983. ;; Set the agenda buffer as the current buffer instead of
  6984. ;; passing it as an argument to `bury-buffer' so that
  6985. ;; `bury-buffer' removes it from the window.
  6986. (with-current-buffer buf
  6987. (bury-buffer))
  6988. (kill-buffer buf)
  6989. (setq org-agenda-archives-mode nil
  6990. org-agenda-buffer nil)))))
  6991. (defun org-agenda-exit ()
  6992. "Exit the agenda, killing Org buffers loaded by the agenda.
  6993. Like `org-agenda-Quit', but kill any buffers that were created by
  6994. the agenda. Org buffers visited directly by the user will not be
  6995. touched. Also, exit the agenda even if it is in column view."
  6996. (interactive)
  6997. (when org-agenda-columns-active
  6998. (org-columns-quit))
  6999. (org-release-buffers org-agenda-new-buffers)
  7000. (setq org-agenda-new-buffers nil)
  7001. (org-agenda-Quit))
  7002. (defun org-agenda-kill-all-agenda-buffers ()
  7003. "Kill all buffers in `org-agenda-mode'.
  7004. This is used when toggling sticky agendas."
  7005. (interactive)
  7006. (let (blist)
  7007. (dolist (buf (buffer-list))
  7008. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  7009. (push buf blist)))
  7010. (mapc #'kill-buffer blist)))
  7011. (defun org-agenda-execute (arg)
  7012. "Execute another agenda command, keeping same window.
  7013. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  7014. in the agenda."
  7015. (interactive "P")
  7016. (let ((org-agenda-window-setup 'current-window))
  7017. (org-agenda arg)))
  7018. (defun org-agenda-redo (&optional all)
  7019. "Rebuild possibly ALL agenda view(s) in the current buffer."
  7020. (interactive "P")
  7021. (defvar org-agenda-tag-filter-while-redo) ;FIXME: Where is this var used?
  7022. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  7023. (cpa (unless (eq all t) current-prefix-arg))
  7024. (org-agenda-doing-sticky-redo org-agenda-sticky)
  7025. (org-agenda-sticky nil)
  7026. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  7027. org-agenda-buffer-name))
  7028. (org-agenda-keep-modes t)
  7029. (tag-filter org-agenda-tag-filter)
  7030. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  7031. (top-hl-filter org-agenda-top-headline-filter)
  7032. (cat-filter org-agenda-category-filter)
  7033. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  7034. (re-filter org-agenda-regexp-filter)
  7035. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  7036. (effort-filter org-agenda-effort-filter)
  7037. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  7038. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  7039. (cols org-agenda-columns-active)
  7040. (line (org-current-line))
  7041. (window-line (- line (org-current-line (window-start))))
  7042. (lprops (get 'org-agenda-redo-command 'org-lprops))
  7043. (redo-cmd (get-text-property p 'org-redo-cmd))
  7044. (last-args (get-text-property p 'org-last-args))
  7045. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  7046. (org-agenda-overriding-cmd-arguments
  7047. (unless (eq all t)
  7048. (cond ((listp last-args)
  7049. (cons (or cpa (car last-args)) (cdr last-args)))
  7050. ((stringp last-args)
  7051. last-args))))
  7052. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  7053. (put 'org-agenda-tag-filter :preset-filter nil)
  7054. (put 'org-agenda-category-filter :preset-filter nil)
  7055. (put 'org-agenda-regexp-filter :preset-filter nil)
  7056. (put 'org-agenda-effort-filter :preset-filter nil)
  7057. (and cols (org-columns-quit))
  7058. (message "Rebuilding agenda buffer...")
  7059. (if series-redo-cmd
  7060. (eval series-redo-cmd t)
  7061. (cl-progv
  7062. (mapcar #'car lprops)
  7063. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  7064. (eval redo-cmd t)))
  7065. (setq org-agenda-undo-list nil
  7066. org-agenda-pending-undo-list nil
  7067. org-agenda-tag-filter tag-filter
  7068. org-agenda-category-filter cat-filter
  7069. org-agenda-regexp-filter re-filter
  7070. org-agenda-effort-filter effort-filter
  7071. org-agenda-top-headline-filter top-hl-filter)
  7072. (message "Rebuilding agenda buffer...done")
  7073. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  7074. (put 'org-agenda-category-filter :preset-filter cat-preset)
  7075. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  7076. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  7077. (let ((tag (or tag-filter tag-preset))
  7078. (cat (or cat-filter cat-preset))
  7079. (effort (or effort-filter effort-preset))
  7080. (re (or re-filter re-preset)))
  7081. (when tag (org-agenda-filter-apply tag 'tag t))
  7082. (when cat (org-agenda-filter-apply cat 'category))
  7083. (when effort (org-agenda-filter-apply effort 'effort))
  7084. (when re (org-agenda-filter-apply re 'regexp)))
  7085. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7086. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7087. (org-goto-line line)
  7088. (when (called-interactively-p 'any) (recenter window-line))))
  7089. (defun org-agenda-redo-all (&optional exhaustive)
  7090. "Rebuild all agenda views in the current buffer.
  7091. With a prefix argument, do so in all agenda buffers."
  7092. (interactive "P")
  7093. (if exhaustive
  7094. (dolist (buffer (buffer-list))
  7095. (with-current-buffer buffer
  7096. (when (derived-mode-p 'org-agenda-mode)
  7097. (org-agenda-redo t))))
  7098. (org-agenda-redo t)))
  7099. (defvar org-global-tags-completion-table nil)
  7100. (defvar org-agenda-filter-form nil)
  7101. (defvar org-agenda-filtered-by-category nil)
  7102. (defsubst org-agenda-get-category ()
  7103. "Return the category of the agenda line."
  7104. (org-get-at-bol 'org-category))
  7105. (defun org-agenda-filter-by-category (strip)
  7106. "Filter lines in the agenda buffer that have a specific category.
  7107. The category is that of the current line.
  7108. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7109. When there is already a category filter in place, this command removes the
  7110. filter."
  7111. (interactive "P")
  7112. (if (and org-agenda-filtered-by-category
  7113. org-agenda-category-filter)
  7114. (org-agenda-filter-show-all-cat)
  7115. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7116. (cond
  7117. ((and cat strip)
  7118. (org-agenda-filter-apply
  7119. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7120. (cat
  7121. (org-agenda-filter-apply
  7122. (setq org-agenda-category-filter
  7123. (list (concat "+" cat)))
  7124. 'category))
  7125. (t (error "No category at point"))))))
  7126. (defun org-find-top-headline (&optional pos)
  7127. "Find the topmost parent headline and return it.
  7128. POS when non-nil is the marker or buffer position to start the
  7129. search from."
  7130. (save-excursion
  7131. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7132. (when pos (goto-char pos))
  7133. ;; Skip up to the topmost parent.
  7134. (while (org-up-heading-safe))
  7135. (ignore-errors
  7136. (replace-regexp-in-string
  7137. "^\\[[0-9]+/[0-9]+\\] *\\|^\\[%[0-9]+\\] *" ""
  7138. (nth 4 (org-heading-components)))))))
  7139. (defvar org-agenda-filtered-by-top-headline nil)
  7140. (defun org-agenda-filter-by-top-headline (strip)
  7141. "Keep only those lines that are descendants from the same top headline.
  7142. The top headline is that of the current line. With prefix arg STRIP, hide
  7143. all lines of the category at point."
  7144. (interactive "P")
  7145. (if org-agenda-filtered-by-top-headline
  7146. (progn
  7147. (setq org-agenda-filtered-by-top-headline nil
  7148. org-agenda-top-headline-filter nil)
  7149. (org-agenda-filter-show-all-top-filter))
  7150. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7151. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7152. (error "No top-level headline at point")))))
  7153. (defvar org-agenda-regexp-filter nil)
  7154. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7155. "Filter agenda entries by a regular expressions.
  7156. You will be prompted for the regular expression, and the agenda
  7157. view will only show entries that are matched by that expression.
  7158. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7159. When there is already a regexp filter active, this command removed the
  7160. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7161. an already existing regexp filter."
  7162. (interactive "P")
  7163. (let* ((strip (equal strip-or-accumulate '(4)))
  7164. (accumulate (equal strip-or-accumulate '(16))))
  7165. (cond
  7166. ((and org-agenda-regexp-filter (not accumulate))
  7167. (org-agenda-filter-show-all-re)
  7168. (message "Regexp filter removed"))
  7169. (t (let ((flt (concat (if strip "-" "+")
  7170. (read-from-minibuffer
  7171. (if strip
  7172. "Hide entries matching regexp: "
  7173. "Narrow to entries matching regexp: ")))))
  7174. (push flt org-agenda-regexp-filter)
  7175. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7176. (defvar org-agenda-effort-filter nil)
  7177. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7178. "Filter agenda entries by effort.
  7179. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7180. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7181. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7182. This last option is in practice not very useful, but it is available for
  7183. consistency with the other filter commands."
  7184. (interactive "P")
  7185. (let* ((efforts (split-string
  7186. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7187. org-global-properties
  7188. t))
  7189. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7190. ;; XXX: the following handles only up to 10 different
  7191. ;; effort values.
  7192. (allowed-keys (if (null efforts) nil
  7193. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7194. (number-sequence 1 (length efforts)))))
  7195. (keep (equal strip-or-accumulate '(16)))
  7196. (negative (equal strip-or-accumulate '(4)))
  7197. (current org-agenda-effort-filter)
  7198. (op nil))
  7199. (while (not (memq op '(?< ?> ?= ?_)))
  7200. (setq op (read-char-exclusive
  7201. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7202. ;; Select appropriate duration. Ignore non-digit characters.
  7203. (if (eq op ?_)
  7204. (progn
  7205. (org-agenda-filter-show-all-effort)
  7206. (message "Effort filter removed"))
  7207. (let ((prompt
  7208. (apply #'format
  7209. (concat "Effort %c "
  7210. (mapconcat (lambda (s) (concat "[%d]" s))
  7211. efforts
  7212. " "))
  7213. op allowed-keys))
  7214. (eff -1))
  7215. (while (not (memq eff allowed-keys))
  7216. (message prompt)
  7217. (setq eff (- (read-char-exclusive) 48)))
  7218. (org-agenda-filter-show-all-effort)
  7219. (setq org-agenda-effort-filter
  7220. (append
  7221. (list (concat (if negative "-" "+")
  7222. (char-to-string op)
  7223. ;; Numbering is 1 2 3 ... 9 0, but we want
  7224. ;; 0 1 2 ... 8 9.
  7225. (nth (mod (1- eff) 10) efforts)))
  7226. (if keep current nil)))
  7227. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7228. (defun org-agenda-filter (&optional strip-or-accumulate)
  7229. "Prompt for a general filter string and apply it to the agenda.
  7230. The string may contain filter elements like
  7231. +category
  7232. +tag
  7233. +<effort > and = are also allowed as effort operators
  7234. +/regexp/
  7235. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7236. `+' is optional if it is not required to separate two string parts.
  7237. Multiple filter elements can be concatenated without spaces, for example
  7238. +work-John<0:10-/plot/
  7239. selects entries with category `work' and effort estimates below 10 minutes,
  7240. and deselects entries with tag `John' or matching the regexp `plot'.
  7241. During entry of the filter, completion for tags, categories and effort
  7242. values is offered. Since the syntax for categories and tags is identical
  7243. there should be no overlap between categories and tags. If there is, tags
  7244. get priority.
  7245. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7246. entire filter, which can be useful in connection with the prompt history.
  7247. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7248. existing ones. A shortcut for this is to add an additional `+' at the
  7249. beginning of the string, like `+-John'.
  7250. With a triple prefix argument, execute the computed filtering defined in
  7251. the variable `org-agenda-auto-exclude-function'."
  7252. (interactive "P")
  7253. (if (equal strip-or-accumulate '(64))
  7254. ;; Execute the auto-exclude action
  7255. (if (not org-agenda-auto-exclude-function)
  7256. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7257. (org-agenda-filter-show-all-tag)
  7258. (setq org-agenda-tag-filter nil)
  7259. (dolist (tag (org-agenda-get-represented-tags))
  7260. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7261. (when modifier
  7262. (push modifier org-agenda-tag-filter))))
  7263. (unless (null org-agenda-tag-filter)
  7264. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7265. ;; Prompt for a filter and act
  7266. (let* ((tag-list (org-agenda-get-represented-tags))
  7267. (category-list (org-agenda-get-represented-categories))
  7268. (negate (equal strip-or-accumulate '(4)))
  7269. (cf (mapconcat #'identity org-agenda-category-filter ""))
  7270. (tf (mapconcat #'identity org-agenda-tag-filter ""))
  7271. ;; (rpl-fn (lambda (c) (replace-regexp-in-string "^\\+" "" (or (car c) ""))))
  7272. (ef (replace-regexp-in-string "^\\+" "" (or (car org-agenda-effort-filter) "")))
  7273. (rf (replace-regexp-in-string "^\\+" "" (or (car org-agenda-regexp-filter) "")))
  7274. (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/"))))
  7275. (f-string (completing-read
  7276. (concat
  7277. (if negate "Negative filter" "Filter")
  7278. " [+cat-tag<0:10-/regexp/]: ")
  7279. #'org-agenda-filter-completion-function
  7280. nil nil ff))
  7281. (keep (or (if (string-match "^\\+[+-]" f-string)
  7282. (progn (setq f-string (substring f-string 1)) t))
  7283. (equal strip-or-accumulate '(16))))
  7284. (fc (if keep org-agenda-category-filter))
  7285. (ft (if keep org-agenda-tag-filter))
  7286. (fe (if keep org-agenda-effort-filter))
  7287. (fr (if keep org-agenda-regexp-filter))
  7288. pm s)
  7289. ;; If the filter contains a double-quoted string, replace a
  7290. ;; single hyphen by the arbitrary and temporary string "~~~"
  7291. ;; to disambiguate such hyphens from syntactic ones.
  7292. (setq f-string (replace-regexp-in-string
  7293. "\"\\([^\"]*\\)-\\([^\"]*\\)\"" "\"\\1~~~\\2\"" f-string))
  7294. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7295. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7296. (when negate
  7297. (setq pm (if (equal pm "+") "-" "+")))
  7298. (cond
  7299. ((match-beginning 3)
  7300. ;; category or tag
  7301. (setq s (replace-regexp-in-string ; Remove the temporary special string.
  7302. "~~~" "-" (match-string 3 f-string)))
  7303. (cond
  7304. ((member s tag-list)
  7305. (org-pushnew-to-end (concat pm s) ft))
  7306. ((member s category-list)
  7307. (org-pushnew-to-end (concat pm ; Remove temporary double quotes.
  7308. (replace-regexp-in-string "\"\\(.*\\)\"" "\\1" s))
  7309. fc))
  7310. (t (message
  7311. "`%s%s' filter ignored because tag/category is not represented"
  7312. pm s))))
  7313. ((match-beginning 4)
  7314. ;; effort
  7315. (org-pushnew-to-end (concat pm (match-string 4 f-string)) fe))
  7316. ((match-beginning 5)
  7317. ;; regexp
  7318. (org-pushnew-to-end (concat pm (match-string 6 f-string)) fr)))
  7319. (setq f-string (substring f-string (match-end 0))))
  7320. (org-agenda-filter-remove-all)
  7321. (and fc (org-agenda-filter-apply
  7322. (setq org-agenda-category-filter fc) 'category))
  7323. (and ft (org-agenda-filter-apply
  7324. (setq org-agenda-tag-filter ft) 'tag 'expand))
  7325. (and fe (org-agenda-filter-apply
  7326. (setq org-agenda-effort-filter fe) 'effort))
  7327. (and fr (org-agenda-filter-apply
  7328. (setq org-agenda-regexp-filter fr) 'regexp))
  7329. (run-hooks 'org-agenda-filter-hook))))
  7330. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7331. "Complete a complex filter string.
  7332. FLAG specifies the type of completion operation to perform. This
  7333. function is passed as a collection function to `completing-read',
  7334. which see."
  7335. (let ((completion-ignore-case t) ;tags are case-sensitive
  7336. (confirm (lambda (x) (stringp x)))
  7337. (prefix "")
  7338. (operator "")
  7339. table)
  7340. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7341. (setq prefix (match-string 1 string)
  7342. operator (match-string 2 string)
  7343. string (match-string 3 string)))
  7344. (cond
  7345. ((member operator '("+" "-" "" nil))
  7346. (setq table (append (org-agenda-get-represented-categories)
  7347. (org-agenda-get-represented-tags))))
  7348. ((member operator '("<" ">" "="))
  7349. (setq table (split-string
  7350. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7351. org-global-properties
  7352. t))
  7353. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7354. " +")))
  7355. (t (setq table nil)))
  7356. (pcase flag
  7357. (`t (all-completions string table confirm))
  7358. (`lambda (assoc string table)) ;exact match?
  7359. (`nil
  7360. (pcase (try-completion string table confirm)
  7361. ((and completion (pred stringp))
  7362. (concat prefix completion))
  7363. (completion completion)))
  7364. (_ nil))))
  7365. (defun org-agenda-filter-remove-all ()
  7366. "Remove all filters from the current agenda buffer."
  7367. (interactive)
  7368. (when org-agenda-tag-filter
  7369. (org-agenda-filter-show-all-tag))
  7370. (when org-agenda-category-filter
  7371. (org-agenda-filter-show-all-cat))
  7372. (when org-agenda-regexp-filter
  7373. (org-agenda-filter-show-all-re))
  7374. (when org-agenda-top-headline-filter
  7375. (org-agenda-filter-show-all-top-filter))
  7376. (when org-agenda-effort-filter
  7377. (org-agenda-filter-show-all-effort))
  7378. (org-agenda-finalize)
  7379. (when (called-interactively-p 'interactive)
  7380. (message "All agenda filters removed")))
  7381. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7382. "Keep only those lines in the agenda buffer that have a specific tag.
  7383. The tag is selected with its fast selection letter, as configured.
  7384. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7385. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7386. instead of replacing it.
  7387. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7388. i.e. don't
  7389. filter on all its group members.
  7390. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7391. should be used to exclude the search - the interactive user can
  7392. also press `-' or `+' to switch between filtering and excluding."
  7393. (interactive "P")
  7394. (let* ((alist org-tag-alist-for-agenda)
  7395. (seen-chars nil)
  7396. (tag-chars (mapconcat
  7397. (lambda (x) (if (and (not (symbolp (car x)))
  7398. (cdr x)
  7399. (not (member (cdr x) seen-chars)))
  7400. (progn
  7401. (push (cdr x) seen-chars)
  7402. (char-to-string (cdr x)))
  7403. ""))
  7404. org-tag-alist-for-agenda ""))
  7405. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7406. (string-to-list tag-chars)))
  7407. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7408. (accumulate (equal strip-or-accumulate '(16)))
  7409. (expand (not (equal strip-or-accumulate '(64))))
  7410. (inhibit-read-only t)
  7411. (current org-agenda-tag-filter)
  7412. a tag) ;; n
  7413. (unless char
  7414. (while (not (memq char valid-char-list))
  7415. (org-unlogged-message
  7416. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7417. (if exclude "Exclude[+]" "Filter[-]")
  7418. (if expand "" " (no grouptag expand)")
  7419. tag-chars
  7420. (if org-agenda-auto-exclude-function "[RET] " ""))
  7421. (setq char (read-char-exclusive))
  7422. ;; Excluding or filtering down
  7423. (cond ((eq char ?-) (setq exclude t))
  7424. ((eq char ?+) (setq exclude nil)))))
  7425. (when (eq char ?\t)
  7426. (unless (local-variable-p 'org-global-tags-completion-table)
  7427. (setq-local org-global-tags-completion-table
  7428. (org-global-tags-completion-table)))
  7429. (let ((completion-ignore-case t))
  7430. (setq tag (completing-read
  7431. "Tag: " org-global-tags-completion-table nil t))))
  7432. (cond
  7433. ((eq char ?\r)
  7434. (org-agenda-filter-show-all-tag)
  7435. (when org-agenda-auto-exclude-function
  7436. (setq org-agenda-tag-filter nil)
  7437. (dolist (tag (org-agenda-get-represented-tags))
  7438. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7439. (when modifier
  7440. (push modifier org-agenda-tag-filter))))
  7441. (unless (null org-agenda-tag-filter)
  7442. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7443. ((eq char ?\\)
  7444. (org-agenda-filter-show-all-tag)
  7445. (when (get 'org-agenda-tag-filter :preset-filter)
  7446. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7447. ((eq char ?.)
  7448. (setq org-agenda-tag-filter
  7449. (mapcar (lambda(tag) (concat "+" tag))
  7450. (org-get-at-bol 'tags)))
  7451. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7452. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7453. ((or (eq char ?\s)
  7454. (setq a (rassoc char alist))
  7455. (and tag (setq a (cons tag nil))))
  7456. (org-agenda-filter-show-all-tag)
  7457. (setq tag (car a))
  7458. (setq org-agenda-tag-filter
  7459. (cons (concat (if exclude "-" "+") tag)
  7460. (if accumulate current nil)))
  7461. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7462. (t (error "Invalid tag selection character %c" char)))))
  7463. (defun org-agenda-get-represented-categories ()
  7464. "Return a list of all categories used in this agenda buffer."
  7465. (or org-agenda-represented-categories
  7466. (when (derived-mode-p 'org-agenda-mode)
  7467. (let ((pos (point-min)) categories)
  7468. (while (and (< pos (point-max))
  7469. (setq pos (next-single-property-change
  7470. pos 'org-category nil (point-max))))
  7471. (push (get-text-property pos 'org-category) categories))
  7472. (setq org-agenda-represented-categories
  7473. ;; Enclose category names with a hyphen in double
  7474. ;; quotes to process them specially in `org-agenda-filter'.
  7475. (mapcar (lambda (s) (if (string-match-p "-" s) (format "\"%s\"" s) s))
  7476. (nreverse (org-uniquify (delq nil categories)))))))))
  7477. (defvar org-tag-groups-alist-for-agenda)
  7478. (defun org-agenda-get-represented-tags ()
  7479. "Return a list of all tags used in this agenda buffer.
  7480. These will be lower-case, for filtering."
  7481. (or org-agenda-represented-tags
  7482. (when (derived-mode-p 'org-agenda-mode)
  7483. (let ((pos (point-min)) tags-lists tt)
  7484. (while (and (< pos (point-max))
  7485. (setq pos (next-single-property-change
  7486. pos 'tags nil (point-max))))
  7487. (setq tt (get-text-property pos 'tags))
  7488. (if tt (push tt tags-lists)))
  7489. (setq tags-lists
  7490. (nreverse (org-uniquify
  7491. (delq nil (apply #'append tags-lists)))))
  7492. (dolist (tag tags-lists)
  7493. (mapc
  7494. (lambda (group)
  7495. (when (member tag group)
  7496. (push (car group) tags-lists)))
  7497. org-tag-groups-alist-for-agenda))
  7498. (setq org-agenda-represented-tags tags-lists)))))
  7499. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7500. "Create the form that tests a line for agenda filter. Optional
  7501. argument EXPAND can be used for the TYPE tag and will expand the
  7502. tags in the FILTER if any of the tags in FILTER are grouptags."
  7503. (let ((multi-pos-cats
  7504. (and (eq type 'category)
  7505. (string-match-p "\\+.*\\+"
  7506. (mapconcat (lambda (cat) (substring cat 0 1))
  7507. filter ""))))
  7508. f f1)
  7509. (cond
  7510. ;; Tag filter
  7511. ((eq type 'tag)
  7512. (setq filter
  7513. (delete-dups
  7514. (append (get 'org-agenda-tag-filter :preset-filter)
  7515. filter)))
  7516. (dolist (x filter)
  7517. (let ((op (string-to-char x)))
  7518. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7519. (setq x (list x)))
  7520. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7521. (push f1 f))))
  7522. ;; Category filter
  7523. ((eq type 'category)
  7524. (setq filter
  7525. (delete-dups
  7526. (append (get 'org-agenda-category-filter :preset-filter)
  7527. filter)))
  7528. (dolist (x filter)
  7529. (if (equal "-" (substring x 0 1))
  7530. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7531. (setq f1 (list 'equal (substring x 1) 'cat)))
  7532. (push f1 f)))
  7533. ;; Regexp filter
  7534. ((eq type 'regexp)
  7535. (setq filter
  7536. (delete-dups
  7537. (append (get 'org-agenda-regexp-filter :preset-filter)
  7538. filter)))
  7539. (dolist (x filter)
  7540. (if (equal "-" (substring x 0 1))
  7541. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7542. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7543. (push f1 f)))
  7544. ;; Effort filter
  7545. ((eq type 'effort)
  7546. (setq filter
  7547. (delete-dups
  7548. (append (get 'org-agenda-effort-filter :preset-filter)
  7549. filter)))
  7550. (dolist (x filter)
  7551. (push (org-agenda-filter-effort-form x) f))))
  7552. (cons (if multi-pos-cats 'or 'and) (nreverse f))))
  7553. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7554. "Return a form associated to tag-expression TAGS.
  7555. Build a form testing a line for agenda filter for
  7556. tag-expressions. OP is an operator of type CHAR that allows the
  7557. function to set the right switches in the returned form."
  7558. (let (form)
  7559. ;; Any of the expressions can match if OP is +, all must match if
  7560. ;; the operator is -.
  7561. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7562. (let* ((tag (substring x 1))
  7563. (f (cond
  7564. ((string= "" tag) 'tags)
  7565. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7566. ;; TAG is a regexp.
  7567. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7568. (t (list 'member tag 'tags)))))
  7569. (push (if (eq op ?-) (list 'not f) f) form)))))
  7570. (defun org-agenda-filter-effort-form (e)
  7571. "Return the form to compare the effort of the current line with what E says.
  7572. E looks like \"+<2:25\"."
  7573. (let (op)
  7574. (setq e (substring e 1))
  7575. (setq op (string-to-char e) e (substring e 1))
  7576. (setq op (cond ((equal op ?<) '<=)
  7577. ((equal op ?>) '>=)
  7578. ((equal op ??) op)
  7579. (t '=)))
  7580. (list 'org-agenda-compare-effort (list 'quote op)
  7581. (org-duration-to-minutes e))))
  7582. (defun org-agenda-compare-effort (op value)
  7583. "Compare the effort of the current line with VALUE, using OP.
  7584. If the line does not have an effort defined, return nil."
  7585. ;; `effort-minutes' property cannot be extracted directly from
  7586. ;; current line but is stored as a property in `txt'.
  7587. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7588. (funcall op
  7589. (or effort (if org-agenda-sort-noeffort-is-high 32767 -1))
  7590. value)))
  7591. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7592. "Expand group tags in FILTER for the agenda.
  7593. When NO-OPERATOR is non-nil, do not add the + operator to
  7594. returned tags."
  7595. (if org-group-tags
  7596. (let (case-fold-search rtn)
  7597. (mapc
  7598. (lambda (f)
  7599. (let (f0 dir)
  7600. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7601. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7602. (setq dir (if no-operator "" "+") f0 f))
  7603. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7604. (org-tags-expand f0 t))
  7605. rtn))))
  7606. filter)
  7607. (reverse rtn))
  7608. filter))
  7609. (defun org-agenda-filter-apply (filter type &optional expand)
  7610. "Set FILTER as the new agenda filter and apply it.
  7611. Optional argument EXPAND can be used for the TYPE tag and will
  7612. expand the tags in the FILTER if any of the tags in FILTER are
  7613. grouptags."
  7614. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7615. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7616. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  7617. filter type expand))
  7618. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7619. ;; category is used as the filter:
  7620. (setq org-agenda-filtered-by-category
  7621. (and (eq type 'category)
  7622. (not (equal (substring (car filter) 0 1) "-"))))
  7623. (org-agenda-set-mode-name)
  7624. (save-excursion
  7625. (goto-char (point-min))
  7626. (while (not (eobp))
  7627. (when (or (org-get-at-bol 'org-hd-marker)
  7628. (org-get-at-bol 'org-marker))
  7629. (org-dlet
  7630. ((tags (org-get-at-bol 'tags))
  7631. (cat (org-agenda-get-category))
  7632. (txt (or (org-get-at-bol 'txt) "")))
  7633. (unless (eval org-agenda-filter-form t)
  7634. (org-agenda-filter-hide-line type))))
  7635. (beginning-of-line 2)))
  7636. (when (get-char-property (point) 'invisible)
  7637. (ignore-errors (org-agenda-previous-line))))
  7638. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7639. "Filter by top headline HL."
  7640. (org-agenda-set-mode-name)
  7641. (save-excursion
  7642. (goto-char (point-min))
  7643. (while (not (eobp))
  7644. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7645. (tophl (and pos (org-find-top-headline pos))))
  7646. (when (and tophl (funcall (if negative 'identity 'not)
  7647. (string= hl tophl)))
  7648. (org-agenda-filter-hide-line 'top-headline)))
  7649. (beginning-of-line 2)))
  7650. (when (get-char-property (point) 'invisible)
  7651. (org-agenda-previous-line))
  7652. (setq org-agenda-top-headline-filter hl
  7653. org-agenda-filtered-by-top-headline t))
  7654. (defun org-agenda-filter-hide-line (type)
  7655. "If current line is TYPE, hide it in the agenda buffer."
  7656. (let* (buffer-invisibility-spec
  7657. (beg (max (point-min) (1- (point-at-bol))))
  7658. (end (point-at-eol)))
  7659. (let ((inhibit-read-only t))
  7660. (add-text-properties
  7661. beg end `(invisible org-filtered org-filter-type ,type)))))
  7662. (defun org-agenda-remove-filter (type)
  7663. "Remove filter of type TYPE from the agenda buffer."
  7664. (interactive)
  7665. (save-excursion
  7666. (goto-char (point-min))
  7667. (let ((inhibit-read-only t) pos)
  7668. (while (setq pos (text-property-any (point) (point-max)
  7669. 'org-filter-type type))
  7670. (goto-char pos)
  7671. (remove-text-properties
  7672. (point) (next-single-property-change (point) 'org-filter-type)
  7673. `(invisible org-filtered org-filter-type ,type))))
  7674. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7675. (setq org-agenda-filter-form nil)
  7676. (org-agenda-set-mode-name)
  7677. (org-agenda-finalize)))
  7678. (defun org-agenda-filter-show-all-tag nil
  7679. (org-agenda-remove-filter 'tag))
  7680. (defun org-agenda-filter-show-all-re nil
  7681. (org-agenda-remove-filter 'regexp))
  7682. (defun org-agenda-filter-show-all-effort nil
  7683. (org-agenda-remove-filter 'effort))
  7684. (defun org-agenda-filter-show-all-cat nil
  7685. (org-agenda-remove-filter 'category))
  7686. (defun org-agenda-filter-show-all-top-filter nil
  7687. (org-agenda-remove-filter 'top-headline))
  7688. (defun org-agenda-manipulate-query-add ()
  7689. "Manipulate the query by adding a search term with positive selection.
  7690. Positive selection means the term must be matched for selection of an entry."
  7691. (interactive)
  7692. (org-agenda-manipulate-query ?\[))
  7693. (defun org-agenda-manipulate-query-subtract ()
  7694. "Manipulate the query by adding a search term with negative selection.
  7695. Negative selection means term must not be matched for selection of an entry."
  7696. (interactive)
  7697. (org-agenda-manipulate-query ?\]))
  7698. (defun org-agenda-manipulate-query-add-re ()
  7699. "Manipulate the query by adding a search regexp with positive selection.
  7700. Positive selection means the regexp must match for selection of an entry."
  7701. (interactive)
  7702. (org-agenda-manipulate-query ?\{))
  7703. (defun org-agenda-manipulate-query-subtract-re ()
  7704. "Manipulate the query by adding a search regexp with negative selection.
  7705. Negative selection means regexp must not match for selection of an entry."
  7706. (interactive)
  7707. (org-agenda-manipulate-query ?\}))
  7708. (defun org-agenda-manipulate-query (char)
  7709. (cond
  7710. ((eq org-agenda-type 'agenda)
  7711. (let ((org-agenda-include-inactive-timestamps t))
  7712. (org-agenda-redo))
  7713. (message "Display now includes inactive timestamps as well"))
  7714. ((eq org-agenda-type 'search)
  7715. (org-add-to-string
  7716. 'org-agenda-query-string
  7717. (if org-agenda-last-search-view-search-was-boolean
  7718. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7719. (?\{ . " +{}") (?\} . " -{}"))))
  7720. " "))
  7721. (setq org-agenda-redo-command
  7722. (list 'org-search-view
  7723. (car (get-text-property (min (1- (point-max)) (point))
  7724. 'org-last-args))
  7725. org-agenda-query-string
  7726. (+ (length org-agenda-query-string)
  7727. (if (member char '(?\{ ?\})) 0 1))))
  7728. (set-register org-agenda-query-register org-agenda-query-string)
  7729. (let ((org-agenda-overriding-arguments
  7730. (cdr org-agenda-redo-command)))
  7731. (org-agenda-redo)))
  7732. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7733. org-agenda-type))))
  7734. (defun org-add-to-string (var string)
  7735. (set var (concat (symbol-value var) string)))
  7736. (defun org-agenda-goto-date (date)
  7737. "Jump to DATE in agenda."
  7738. (interactive
  7739. (list
  7740. (let ((org-read-date-prefer-future org-agenda-jump-prefer-future))
  7741. (org-read-date))))
  7742. (let* ((day (time-to-days (org-time-string-to-time date)))
  7743. (org-agenda-sticky-orig org-agenda-sticky)
  7744. (org-agenda-buffer-tmp-name (buffer-name))
  7745. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7746. (0-arg (or current-prefix-arg (car args)))
  7747. (2-arg (nth 2 args))
  7748. (with-hour-p (nth 4 org-agenda-redo-command))
  7749. (newcmd (list 'org-agenda-list 0-arg date
  7750. (org-agenda-span-to-ndays
  7751. 2-arg (org-time-string-to-absolute date))
  7752. with-hour-p))
  7753. (newargs (cdr newcmd))
  7754. (inhibit-read-only t)
  7755. org-agenda-sticky)
  7756. (if (not (org-agenda-check-type t 'agenda))
  7757. (error "Not available in non-agenda views")
  7758. (add-text-properties (point-min) (point-max)
  7759. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7760. (org-agenda-redo)
  7761. (goto-char (point-min))
  7762. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7763. (save-excursion (move-beginning-of-line 2) (eobp))))
  7764. (move-beginning-of-line 2))
  7765. (setq org-agenda-sticky org-agenda-sticky-orig
  7766. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7767. (defun org-agenda-goto-today ()
  7768. "Go to today."
  7769. (interactive)
  7770. (org-agenda-check-type t 'agenda)
  7771. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7772. (curspan (nth 2 args))
  7773. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7774. (cond
  7775. (tdpos (goto-char tdpos))
  7776. ((eq org-agenda-type 'agenda)
  7777. (let* ((sd (org-agenda-compute-starting-span
  7778. (org-today) (or curspan org-agenda-span)))
  7779. (org-agenda-overriding-arguments args))
  7780. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7781. (org-agenda-redo)
  7782. (org-agenda-find-same-or-today-or-agenda)))
  7783. (t (error "Cannot find today")))))
  7784. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7785. (goto-char
  7786. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7787. (text-property-any (point-min) (point-max) 'org-today t)
  7788. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7789. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7790. (org-agenda-backward-block))
  7791. (point-min))))
  7792. (defun org-agenda-backward-block ()
  7793. "Move backward by one agenda block."
  7794. (interactive)
  7795. (org-agenda-forward-block 'backward))
  7796. (defun org-agenda-forward-block (&optional backward)
  7797. "Move forward by one agenda block.
  7798. When optional argument BACKWARD is set, go backward."
  7799. (interactive)
  7800. (cond ((not (derived-mode-p 'org-agenda-mode))
  7801. (user-error
  7802. "Cannot execute this command outside of org-agenda-mode buffers"))
  7803. ((looking-at (if backward "\\`" "\\'"))
  7804. (message "Already at the %s block" (if backward "first" "last")))
  7805. (t (let ((_pos (prog1 (point)
  7806. (ignore-errors (if backward (backward-char 1)
  7807. (move-end-of-line 1)))))
  7808. (f (if backward
  7809. #'previous-single-property-change
  7810. #'next-single-property-change))
  7811. moved dest)
  7812. (while (and (setq dest (funcall
  7813. f (point) 'org-agenda-structural-header))
  7814. (not (get-text-property
  7815. (point) 'org-agenda-structural-header)))
  7816. (setq moved t)
  7817. (goto-char dest))
  7818. (if moved (move-beginning-of-line 1)
  7819. (goto-char (if backward (point-min) (point-max)))
  7820. (move-beginning-of-line 1)
  7821. (message "No %s block" (if backward "previous" "further")))))))
  7822. (defun org-agenda-later (arg)
  7823. "Go forward in time by the current span.
  7824. With prefix ARG, go forward that many times the current span."
  7825. (interactive "p")
  7826. (org-agenda-check-type t 'agenda)
  7827. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7828. (span (or (nth 2 args) org-agenda-current-span))
  7829. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7830. (greg (calendar-gregorian-from-absolute sd))
  7831. (cnt (org-get-at-bol 'org-day-cnt))
  7832. greg2)
  7833. (cond
  7834. ((numberp span)
  7835. (setq sd (+ (* span arg) sd)))
  7836. ((eq span 'day)
  7837. (setq sd (+ arg sd)))
  7838. ((eq span 'week)
  7839. (setq sd (+ (* 7 arg) sd)))
  7840. ((eq span 'fortnight)
  7841. (setq sd (+ (* 14 arg) sd)))
  7842. ((eq span 'month)
  7843. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7844. sd (calendar-absolute-from-gregorian greg2))
  7845. (setcar greg2 (1+ (car greg2))))
  7846. ((eq span 'year)
  7847. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7848. sd (calendar-absolute-from-gregorian greg2))
  7849. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7850. (t
  7851. (setq sd (+ (* span arg) sd))))
  7852. (let ((org-agenda-overriding-cmd
  7853. ;; `cmd' may have been set by `org-agenda-run-series' which
  7854. ;; uses `org-agenda-overriding-cmd' to decide whether
  7855. ;; overriding is allowed for `cmd'
  7856. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7857. (org-agenda-overriding-arguments
  7858. (list (car args) sd span)))
  7859. (org-agenda-redo)
  7860. (org-agenda-find-same-or-today-or-agenda cnt))))
  7861. (defun org-agenda-earlier (arg)
  7862. "Go backward in time by the current span.
  7863. With prefix ARG, go backward that many times the current span."
  7864. (interactive "p")
  7865. (org-agenda-later (- arg)))
  7866. (defun org-agenda-view-mode-dispatch ()
  7867. "Call one of the view mode commands."
  7868. (interactive)
  7869. (org-unlogged-message
  7870. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7871. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7872. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7873. (pcase (read-char-exclusive)
  7874. (?\ (call-interactively 'org-agenda-reset-view))
  7875. (?d (call-interactively 'org-agenda-day-view))
  7876. (?w (call-interactively 'org-agenda-week-view))
  7877. (?t (call-interactively 'org-agenda-fortnight-view))
  7878. (?m (call-interactively 'org-agenda-month-view))
  7879. (?y (call-interactively 'org-agenda-year-view))
  7880. (?l (call-interactively 'org-agenda-log-mode))
  7881. (?L (org-agenda-log-mode '(4)))
  7882. (?c (org-agenda-log-mode 'clockcheck))
  7883. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7884. (?a (call-interactively 'org-agenda-archives-mode))
  7885. (?A (org-agenda-archives-mode 'files))
  7886. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7887. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7888. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7889. (?D (call-interactively 'org-agenda-toggle-diary))
  7890. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7891. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7892. (org-agenda-check-type t 'agenda)
  7893. (org-agenda-redo))
  7894. (message "Display now includes inactive timestamps as well"))
  7895. (?q (message "Abort"))
  7896. (key (user-error "Invalid key: %s" key))))
  7897. (defun org-agenda-reset-view ()
  7898. "Switch to default view for agenda."
  7899. (interactive)
  7900. (org-agenda-change-time-span org-agenda-span))
  7901. (defun org-agenda-day-view (&optional day-of-month)
  7902. "Switch to daily view for agenda.
  7903. With argument DAY-OF-MONTH, switch to that day of the month."
  7904. (interactive "P")
  7905. (org-agenda-change-time-span 'day day-of-month))
  7906. (defun org-agenda-week-view (&optional iso-week)
  7907. "Switch to weekly view for agenda.
  7908. With argument ISO-WEEK, switch to the corresponding ISO week.
  7909. If ISO-WEEK has more then 2 digits, only the last two encode
  7910. the week. Any digits before this encode a year. So 200712
  7911. means week 12 of year 2007. Years ranging from 70 years ago
  7912. to 30 years in the future can also be written as 2-digit years."
  7913. (interactive "P")
  7914. (org-agenda-change-time-span 'week iso-week))
  7915. (defun org-agenda-fortnight-view (&optional iso-week)
  7916. "Switch to fortnightly view for agenda.
  7917. With argument ISO-WEEK, switch to the corresponding ISO week.
  7918. If ISO-WEEK has more then 2 digits, only the last two encode
  7919. the week. Any digits before this encode a year. So 200712
  7920. means week 12 of year 2007. Years ranging from 70 years ago
  7921. to 30 years in the future can also be written as 2-digit years."
  7922. (interactive "P")
  7923. (org-agenda-change-time-span 'fortnight iso-week))
  7924. (defun org-agenda-month-view (&optional month)
  7925. "Switch to monthly view for agenda.
  7926. With argument MONTH, switch to that month. If MONTH has more
  7927. then 2 digits, only the last two encode the month. Any digits
  7928. before this encode a year. So 200712 means December year 2007.
  7929. Years ranging from 70 years ago to 30 years in the future can
  7930. also be written as 2-digit years."
  7931. (interactive "P")
  7932. (org-agenda-change-time-span 'month month))
  7933. (defun org-agenda-year-view (&optional year)
  7934. "Switch to yearly view for agenda.
  7935. With argument YEAR, switch to that year. Years ranging from 70
  7936. years ago to 30 years in the future can also be written as
  7937. 2-digit years."
  7938. (interactive "P")
  7939. (when year
  7940. (setq year (org-small-year-to-year year)))
  7941. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7942. (org-agenda-change-time-span 'year year)
  7943. (error "Abort")))
  7944. (defun org-agenda-change-time-span (span &optional n)
  7945. "Change the agenda view to SPAN.
  7946. SPAN may be `day', `week', `fortnight', `month', `year'."
  7947. (org-agenda-check-type t 'agenda)
  7948. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7949. (curspan (nth 2 args)))
  7950. (when (and (not n) (equal curspan span))
  7951. (error "Viewing span is already \"%s\"" span))
  7952. (let* ((sd (or (org-get-at-bol 'day)
  7953. (nth 1 args)
  7954. org-starting-day))
  7955. (sd (org-agenda-compute-starting-span sd span n))
  7956. (org-agenda-overriding-cmd
  7957. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7958. (org-agenda-overriding-arguments
  7959. (list (car args) sd span)))
  7960. (org-agenda-redo)
  7961. (org-agenda-find-same-or-today-or-agenda))
  7962. (org-agenda-set-mode-name)
  7963. (message "Switched to %s view" span)))
  7964. (defun org-agenda-compute-starting-span (sd span &optional n)
  7965. "Compute starting date for agenda.
  7966. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7967. is a cons cell with the starting date and the number of days,
  7968. so that the date SD will be in that range."
  7969. (let* ((greg (calendar-gregorian-from-absolute sd))
  7970. ;; (dg (nth 1 greg))
  7971. (mg (car greg))
  7972. (yg (nth 2 greg)))
  7973. (cond
  7974. ((eq span 'day)
  7975. (when n
  7976. (setq sd (+ (calendar-absolute-from-gregorian
  7977. (list mg 1 yg))
  7978. n -1))))
  7979. ((or (eq span 'week) (eq span 'fortnight))
  7980. (let* ((nt (calendar-day-of-week
  7981. (calendar-gregorian-from-absolute sd)))
  7982. (d (if org-agenda-start-on-weekday
  7983. (- nt org-agenda-start-on-weekday)
  7984. 0))
  7985. y1)
  7986. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7987. (when n
  7988. (require 'cal-iso)
  7989. (when (> n 99)
  7990. (setq y1 (org-small-year-to-year (/ n 100))
  7991. n (mod n 100)))
  7992. (setq sd
  7993. (calendar-iso-to-absolute
  7994. (list n 1
  7995. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7996. ((eq span 'month)
  7997. (let (y1)
  7998. (when (and n (> n 99))
  7999. (setq y1 (org-small-year-to-year (/ n 100))
  8000. n (mod n 100)))
  8001. (setq sd (calendar-absolute-from-gregorian
  8002. (list (or n mg) 1 (or y1 yg))))))
  8003. ((eq span 'year)
  8004. (setq sd (calendar-absolute-from-gregorian
  8005. (list 1 1 (or n yg))))))
  8006. sd))
  8007. (defun org-agenda-next-date-line (&optional arg)
  8008. "Jump to the next line indicating a date in agenda buffer."
  8009. (interactive "p")
  8010. (org-agenda-check-type t 'agenda)
  8011. (beginning-of-line 1)
  8012. ;; This does not work if user makes date format that starts with a blank
  8013. (when (looking-at-p "^\\S-") (forward-char 1))
  8014. (unless (re-search-forward "^\\S-" nil t arg)
  8015. (backward-char 1)
  8016. (error "No next date after this line in this buffer"))
  8017. (goto-char (match-beginning 0)))
  8018. (defun org-agenda-previous-date-line (&optional arg)
  8019. "Jump to the previous line indicating a date in agenda buffer."
  8020. (interactive "p")
  8021. (org-agenda-check-type t 'agenda)
  8022. (beginning-of-line 1)
  8023. (unless (re-search-backward "^\\S-" nil t arg)
  8024. (error "No previous date before this line in this buffer")))
  8025. ;; Initialize the highlight
  8026. (defvar org-hl (make-overlay 1 1))
  8027. (overlay-put org-hl 'face 'highlight)
  8028. (defun org-highlight (begin end &optional buffer)
  8029. "Highlight a region with overlay."
  8030. (move-overlay org-hl begin end (or buffer (current-buffer))))
  8031. (defun org-unhighlight ()
  8032. "Detach overlay INDEX."
  8033. (delete-overlay org-hl))
  8034. (defun org-unhighlight-once ()
  8035. "Remove the highlight from its position, and this function from the hook."
  8036. (remove-hook 'pre-command-hook #'org-unhighlight-once)
  8037. (org-unhighlight))
  8038. (defvar org-agenda-pre-follow-window-conf nil)
  8039. (defun org-agenda-follow-mode ()
  8040. "Toggle follow mode in an agenda buffer."
  8041. (interactive)
  8042. (unless org-agenda-follow-mode
  8043. (setq org-agenda-pre-follow-window-conf
  8044. (current-window-configuration)))
  8045. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  8046. (unless org-agenda-follow-mode
  8047. (set-window-configuration org-agenda-pre-follow-window-conf))
  8048. (org-agenda-set-mode-name)
  8049. (org-agenda-do-context-action)
  8050. (message "Follow mode is %s"
  8051. (if org-agenda-follow-mode "on" "off")))
  8052. (defun org-agenda-entry-text-mode (&optional arg)
  8053. "Toggle entry text mode in an agenda buffer."
  8054. (interactive "P")
  8055. (if (or org-agenda-tag-filter
  8056. org-agenda-category-filter
  8057. org-agenda-regexp-filter
  8058. org-agenda-top-headline-filter)
  8059. (user-error "Can't show entry text in filtered views")
  8060. (setq org-agenda-entry-text-mode (or (integerp arg)
  8061. (not org-agenda-entry-text-mode)))
  8062. (org-agenda-entry-text-hide)
  8063. (and org-agenda-entry-text-mode
  8064. (let ((org-agenda-entry-text-maxlines
  8065. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  8066. (org-agenda-entry-text-show)))
  8067. (org-agenda-set-mode-name)
  8068. (message "Entry text mode is %s%s"
  8069. (if org-agenda-entry-text-mode "on" "off")
  8070. (if (not org-agenda-entry-text-mode) ""
  8071. (format " (maximum number of lines is %d)"
  8072. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  8073. (defun org-agenda-clockreport-mode ()
  8074. "Toggle clocktable mode in an agenda buffer."
  8075. (interactive)
  8076. (org-agenda-check-type t 'agenda)
  8077. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  8078. (org-agenda-set-mode-name)
  8079. (org-agenda-redo)
  8080. (message "Clocktable mode is %s"
  8081. (if org-agenda-clockreport-mode "on" "off")))
  8082. (defun org-agenda-log-mode (&optional special)
  8083. "Toggle log mode in an agenda buffer.
  8084. With argument SPECIAL, show all possible log items, not only the ones
  8085. configured in `org-agenda-log-mode-items'.
  8086. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  8087. log items, nothing else."
  8088. (interactive "P")
  8089. (org-agenda-check-type t 'agenda)
  8090. (setq org-agenda-show-log
  8091. (cond
  8092. ((equal special '(16)) 'only)
  8093. ((eq special 'clockcheck)
  8094. (if (eq org-agenda-show-log 'clockcheck)
  8095. nil 'clockcheck))
  8096. (special '(closed clock state))
  8097. (t (not org-agenda-show-log))))
  8098. (org-agenda-set-mode-name)
  8099. (org-agenda-redo)
  8100. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  8101. (defun org-agenda-archives-mode (&optional with-files)
  8102. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  8103. When called with a prefix argument, include all archive files as well."
  8104. (interactive "P")
  8105. (setq org-agenda-archives-mode
  8106. (cond ((and with-files (eq org-agenda-archives-mode t)) nil)
  8107. (with-files t)
  8108. (org-agenda-archives-mode nil)
  8109. (t 'trees)))
  8110. (org-agenda-set-mode-name)
  8111. (org-agenda-redo)
  8112. (message
  8113. "%s"
  8114. (cond
  8115. ((eq org-agenda-archives-mode nil)
  8116. "No archives are included")
  8117. ((eq org-agenda-archives-mode 'trees)
  8118. (format "Trees with :%s: tag are included" org-archive-tag))
  8119. ((eq org-agenda-archives-mode t)
  8120. (format "Trees with :%s: tag and all active archive files are included"
  8121. org-archive-tag)))))
  8122. (defun org-agenda-toggle-diary ()
  8123. "Toggle diary inclusion in an agenda buffer."
  8124. (interactive)
  8125. (org-agenda-check-type t 'agenda)
  8126. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8127. (org-agenda-redo)
  8128. (org-agenda-set-mode-name)
  8129. (message "Diary inclusion turned %s"
  8130. (if org-agenda-include-diary "on" "off")))
  8131. (defun org-agenda-toggle-deadlines ()
  8132. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8133. (interactive)
  8134. (org-agenda-check-type t 'agenda)
  8135. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8136. (org-agenda-redo)
  8137. (org-agenda-set-mode-name)
  8138. (message "Deadlines inclusion turned %s"
  8139. (if org-agenda-include-deadlines "on" "off")))
  8140. (defun org-agenda-toggle-time-grid ()
  8141. "Toggle time grid in an agenda buffer."
  8142. (interactive)
  8143. (org-agenda-check-type t 'agenda)
  8144. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8145. (org-agenda-redo)
  8146. (org-agenda-set-mode-name)
  8147. (message "Time-grid turned %s"
  8148. (if org-agenda-use-time-grid "on" "off")))
  8149. (defun org-agenda-set-mode-name ()
  8150. "Set the mode name to indicate all the small mode settings."
  8151. (setq mode-name
  8152. (list "Org-Agenda"
  8153. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8154. " "
  8155. '(:eval (org-agenda-span-name org-agenda-current-span))
  8156. (if org-agenda-follow-mode " Follow" "")
  8157. (if org-agenda-entry-text-mode " ETxt" "")
  8158. (if org-agenda-include-diary " Diary" "")
  8159. (if org-agenda-include-deadlines " Ddl" "")
  8160. (if org-agenda-use-time-grid " Grid" "")
  8161. (if (and (boundp 'org-habit-show-habits)
  8162. org-habit-show-habits)
  8163. " Habit" "")
  8164. (cond
  8165. ((consp org-agenda-show-log) " LogAll")
  8166. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8167. (org-agenda-show-log " Log")
  8168. (t ""))
  8169. (if (org-agenda-filter-any) " " "")
  8170. (if (or org-agenda-category-filter
  8171. (get 'org-agenda-category-filter :preset-filter))
  8172. '(:eval (propertize
  8173. (concat "["
  8174. (mapconcat
  8175. #'identity
  8176. (append
  8177. (get 'org-agenda-category-filter :preset-filter)
  8178. org-agenda-category-filter)
  8179. "")
  8180. "]")
  8181. 'face 'org-agenda-filter-category
  8182. 'help-echo "Category used in filtering"))
  8183. "")
  8184. (if (or org-agenda-tag-filter
  8185. (get 'org-agenda-tag-filter :preset-filter))
  8186. '(:eval (propertize
  8187. (concat (mapconcat
  8188. #'identity
  8189. (append
  8190. (get 'org-agenda-tag-filter :preset-filter)
  8191. org-agenda-tag-filter)
  8192. ""))
  8193. 'face 'org-agenda-filter-tags
  8194. 'help-echo "Tags used in filtering"))
  8195. "")
  8196. (if (or org-agenda-effort-filter
  8197. (get 'org-agenda-effort-filter :preset-filter))
  8198. '(:eval (propertize
  8199. (concat (mapconcat
  8200. #'identity
  8201. (append
  8202. (get 'org-agenda-effort-filter :preset-filter)
  8203. org-agenda-effort-filter)
  8204. ""))
  8205. 'face 'org-agenda-filter-effort
  8206. 'help-echo "Effort conditions used in filtering"))
  8207. "")
  8208. (if (or org-agenda-regexp-filter
  8209. (get 'org-agenda-regexp-filter :preset-filter))
  8210. '(:eval (propertize
  8211. (concat (mapconcat
  8212. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8213. (append
  8214. (get 'org-agenda-regexp-filter :preset-filter)
  8215. org-agenda-regexp-filter)
  8216. ""))
  8217. 'face 'org-agenda-filter-regexp
  8218. 'help-echo "Regexp used in filtering"))
  8219. "")
  8220. (if org-agenda-archives-mode
  8221. (if (eq org-agenda-archives-mode t)
  8222. " Archives"
  8223. (format " :%s:" org-archive-tag))
  8224. "")
  8225. (if org-agenda-clockreport-mode " Clock" "")))
  8226. (force-mode-line-update))
  8227. (defun org-agenda-update-agenda-type ()
  8228. "Update the agenda type after each command."
  8229. (setq org-agenda-type
  8230. (or (get-text-property (point) 'org-agenda-type)
  8231. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8232. (defun org-agenda-next-line ()
  8233. "Move cursor to the next line, and show if follow mode is active."
  8234. (interactive)
  8235. (call-interactively 'next-line)
  8236. (org-agenda-do-context-action))
  8237. (defun org-agenda-previous-line ()
  8238. "Move cursor to the previous line, and show if follow-mode is active."
  8239. (interactive)
  8240. (call-interactively 'previous-line)
  8241. (org-agenda-do-context-action))
  8242. (defun org-agenda-next-item (n)
  8243. "Move cursor to next agenda item."
  8244. (interactive "p")
  8245. (let ((col (current-column)))
  8246. (dotimes (_ n)
  8247. (when (next-single-property-change (point-at-eol) 'org-marker)
  8248. (move-end-of-line 1)
  8249. (goto-char (next-single-property-change (point) 'org-marker))))
  8250. (org-move-to-column col))
  8251. (org-agenda-do-context-action))
  8252. (defun org-agenda-previous-item (n)
  8253. "Move cursor to next agenda item."
  8254. (interactive "p")
  8255. (dotimes (_ n)
  8256. (let ((col (current-column))
  8257. (goto (save-excursion
  8258. (move-end-of-line 0)
  8259. (previous-single-property-change (point) 'org-marker))))
  8260. (when goto (goto-char goto))
  8261. (org-move-to-column col)))
  8262. (org-agenda-do-context-action))
  8263. (defun org-agenda-do-context-action ()
  8264. "Show outline path and, maybe, follow mode window."
  8265. (let ((m (org-get-at-bol 'org-marker)))
  8266. (when (and (markerp m) (marker-buffer m))
  8267. (and org-agenda-follow-mode
  8268. (if org-agenda-follow-indirect
  8269. (org-agenda-tree-to-indirect-buffer nil)
  8270. (org-agenda-show)))
  8271. (and org-agenda-show-outline-path
  8272. (org-with-point-at m (org-display-outline-path t))))))
  8273. (defun org-agenda-show-tags ()
  8274. "Show the tags applicable to the current item."
  8275. (interactive)
  8276. (let* ((tags (org-get-at-bol 'tags)))
  8277. (if tags
  8278. (message "Tags are :%s:"
  8279. (org-no-properties (mapconcat #'identity tags ":")))
  8280. (message "No tags associated with this line"))))
  8281. (defun org-agenda-goto (&optional highlight)
  8282. "Go to the entry at point in the corresponding Org file."
  8283. (interactive)
  8284. (let* ((marker (or (org-get-at-bol 'org-marker)
  8285. (org-agenda-error)))
  8286. (buffer (marker-buffer marker))
  8287. (pos (marker-position marker)))
  8288. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8289. (switch-to-buffer-other-window buffer)
  8290. (widen)
  8291. (push-mark)
  8292. (goto-char pos)
  8293. (when (derived-mode-p 'org-mode)
  8294. (org-show-context 'agenda)
  8295. (recenter (/ (window-height) 2))
  8296. (org-back-to-heading t)
  8297. (let ((case-fold-search nil))
  8298. (when (re-search-forward org-complex-heading-regexp nil t)
  8299. (goto-char (match-beginning 4)))))
  8300. (run-hooks 'org-agenda-after-show-hook)
  8301. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  8302. (defvar org-agenda-after-show-hook nil
  8303. "Normal hook run after an item has been shown from the agenda.
  8304. Point is in the buffer where the item originated.")
  8305. ;; Defined later in org-agenda.el
  8306. (defvar org-agenda-loop-over-headlines-in-active-region nil)
  8307. (defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
  8308. "Between region BEG and END, call agenda command CMD.
  8309. When optional argument ARG is non-nil or FORCE-ARG is `t', pass
  8310. ARG to CMD. When optional argument DELETE is non-nil, assume CMD
  8311. deletes the agenda entry and don't move to the next entry."
  8312. (save-excursion
  8313. (goto-char beg)
  8314. (let ((mend (move-marker (make-marker) end))
  8315. (all (eq org-agenda-loop-over-headlines-in-active-region t))
  8316. (match (and (stringp org-agenda-loop-over-headlines-in-active-region)
  8317. org-agenda-loop-over-headlines-in-active-region))
  8318. (level (and (eq org-agenda-loop-over-headlines-in-active-region 'start-level)
  8319. (org-get-at-bol 'level))))
  8320. (while (< (point) mend)
  8321. (let ((ov (make-overlay (point) (point-at-eol))))
  8322. (if (not (or all
  8323. (and match (looking-at-p match))
  8324. (eq level (org-get-at-bol 'level))))
  8325. (org-agenda-next-item 1)
  8326. (overlay-put ov 'face 'region)
  8327. (if (or arg force-arg) (funcall cmd arg) (funcall cmd))
  8328. (when (not delete) (org-agenda-next-item 1))
  8329. (delete-overlay ov)))))))
  8330. ;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
  8331. ;; kill,set-property,set-effort] commands may loop over agenda
  8332. ;; entries. Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
  8333. ;; use their own mechanisms on active regions.
  8334. (defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  8335. "Maybe loop over agenda entries and perform CMD.
  8336. Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  8337. (declare (debug t))
  8338. `(if (and (called-interactively-p 'any)
  8339. org-agenda-loop-over-headlines-in-active-region
  8340. (org-region-active-p))
  8341. (org-agenda-do-in-region
  8342. (region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
  8343. ,@body))
  8344. (defun org-agenda-kill ()
  8345. "Kill the entry or subtree belonging to the current agenda entry."
  8346. (interactive)
  8347. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8348. (org-agenda-maybe-loop
  8349. #'org-agenda-kill nil nil t
  8350. (let* ((bufname-orig (buffer-name))
  8351. (marker (or (org-get-at-bol 'org-marker)
  8352. (org-agenda-error)))
  8353. (buffer (marker-buffer marker))
  8354. (pos (marker-position marker))
  8355. (type (org-get-at-bol 'type))
  8356. dbeg dend (n 0))
  8357. (org-with-remote-undo buffer
  8358. (with-current-buffer buffer
  8359. (save-excursion
  8360. (goto-char pos)
  8361. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8362. (setq dbeg (progn (org-back-to-heading t) (point))
  8363. dend (org-end-of-subtree t t))
  8364. (setq dbeg (point-at-bol)
  8365. dend (min (point-max) (1+ (point-at-eol)))))
  8366. (goto-char dbeg)
  8367. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8368. (when (or (eq t org-agenda-confirm-kill)
  8369. (and (numberp org-agenda-confirm-kill)
  8370. (> n org-agenda-confirm-kill)))
  8371. (let ((win-conf (current-window-configuration)))
  8372. (unwind-protect
  8373. (and
  8374. (prog2
  8375. (org-agenda-tree-to-indirect-buffer nil)
  8376. (not (y-or-n-p
  8377. (format "Delete entry with %d lines in buffer \"%s\"? "
  8378. n (buffer-name buffer))))
  8379. (kill-buffer org-last-indirect-buffer))
  8380. (error "Abort"))
  8381. (set-window-configuration win-conf))))
  8382. (let ((org-agenda-buffer-name bufname-orig))
  8383. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8384. (with-current-buffer buffer (delete-region dbeg dend))
  8385. (message "Agenda item and source killed")))))
  8386. (defvar org-archive-default-command) ; defined in org-archive.el
  8387. (defun org-agenda-archive-default ()
  8388. "Archive the entry or subtree belonging to the current agenda entry."
  8389. (interactive)
  8390. (require 'org-archive)
  8391. (funcall-interactively
  8392. #'org-agenda-archive-with org-archive-default-command))
  8393. (defun org-agenda-archive-default-with-confirmation ()
  8394. "Archive the entry or subtree belonging to the current agenda entry."
  8395. (interactive)
  8396. (require 'org-archive)
  8397. (funcall-interactively
  8398. #'org-agenda-archive-with org-archive-default-command 'confirm))
  8399. (defun org-agenda-archive ()
  8400. "Archive the entry or subtree belonging to the current agenda entry."
  8401. (interactive)
  8402. (funcall-interactively
  8403. #'org-agenda-archive-with 'org-archive-subtree))
  8404. (defun org-agenda-archive-to-archive-sibling ()
  8405. "Move the entry to the archive sibling."
  8406. (interactive)
  8407. (funcall-interactively
  8408. #'org-agenda-archive-with 'org-archive-to-archive-sibling))
  8409. (defvar org-archive-from-agenda)
  8410. (defun org-agenda-archive-with (cmd &optional confirm)
  8411. "Move the entry to the archive sibling."
  8412. (interactive)
  8413. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8414. (org-agenda-maybe-loop
  8415. #'org-agenda-archive-with cmd nil t
  8416. (let* ((bufname-orig (buffer-name))
  8417. (marker (or (org-get-at-bol 'org-marker)
  8418. (org-agenda-error)))
  8419. (buffer (marker-buffer marker))
  8420. (pos (marker-position marker)))
  8421. (org-with-remote-undo buffer
  8422. (with-current-buffer buffer
  8423. (if (derived-mode-p 'org-mode)
  8424. (if (and confirm
  8425. (not (y-or-n-p "Archive this subtree or entry? ")))
  8426. (error "Abort")
  8427. (save-window-excursion
  8428. (goto-char pos)
  8429. (let ((org-agenda-buffer-name bufname-orig))
  8430. (org-remove-subtree-entries-from-agenda))
  8431. (org-back-to-heading t)
  8432. (let ((org-archive-from-agenda t))
  8433. (funcall cmd))))
  8434. (error "Archiving works only in Org files")))))))
  8435. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8436. "Remove all lines in the agenda that correspond to a given subtree.
  8437. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8438. If this information is not given, the function uses the tree at point."
  8439. (let ((buf (or buf (current-buffer))) m p)
  8440. (save-excursion
  8441. (unless (and beg end)
  8442. (org-back-to-heading t)
  8443. (setq beg (point))
  8444. (org-end-of-subtree t)
  8445. (setq end (point)))
  8446. (set-buffer (get-buffer org-agenda-buffer-name))
  8447. (save-excursion
  8448. (goto-char (point-max))
  8449. (beginning-of-line 1)
  8450. (while (not (bobp))
  8451. (when (and (setq m (org-get-at-bol 'org-marker))
  8452. (equal buf (marker-buffer m))
  8453. (setq p (marker-position m))
  8454. (>= p beg)
  8455. (< p end))
  8456. (let ((inhibit-read-only t))
  8457. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8458. (beginning-of-line 0))))))
  8459. (defun org-agenda-refile (&optional goto rfloc no-update)
  8460. "Refile the item at point.
  8461. When called with `\\[universal-argument] \\[universal-argument]', \
  8462. go to the location of the last
  8463. refiled item.
  8464. When called with `\\[universal-argument] \\[universal-argument] \
  8465. \\[universal-argument]' prefix or when GOTO is 0, clear
  8466. the refile cache.
  8467. RFLOC can be a refile location obtained in a different way.
  8468. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8469. (interactive "P")
  8470. (cond
  8471. ((member goto '(0 (64)))
  8472. (org-refile-cache-clear))
  8473. ((equal goto '(16))
  8474. (org-refile-goto-last-stored))
  8475. (t
  8476. (let* ((buffer-orig (buffer-name))
  8477. (marker (or (org-get-at-bol 'org-hd-marker)
  8478. (org-agenda-error)))
  8479. (buffer (marker-buffer marker))
  8480. ;; (pos (marker-position marker))
  8481. (rfloc (or rfloc
  8482. (org-refile-get-location
  8483. (if goto "Goto" "Refile to") buffer
  8484. org-refile-allow-creating-parent-nodes))))
  8485. (with-current-buffer buffer
  8486. (org-with-wide-buffer
  8487. (goto-char marker)
  8488. (let ((org-agenda-buffer-name buffer-orig))
  8489. (org-remove-subtree-entries-from-agenda))
  8490. (org-refile goto buffer rfloc))))
  8491. (unless no-update (org-agenda-redo)))))
  8492. (defun org-agenda-open-link (&optional arg)
  8493. "Open the link(s) in the current entry, if any.
  8494. This looks for a link in the displayed line in the agenda.
  8495. It also looks at the text of the entry itself."
  8496. (interactive "P")
  8497. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8498. (org-get-at-bol 'org-marker)))
  8499. (buffer (and marker (marker-buffer marker)))
  8500. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8501. (lkall (and buffer (org-offer-links-in-entry
  8502. buffer marker arg prefix)))
  8503. (lk0 (car lkall))
  8504. (lk (if (stringp lk0) (list lk0) lk0))
  8505. (lkend (cdr lkall))
  8506. trg)
  8507. (cond
  8508. ((and buffer lk)
  8509. (mapcar (lambda(l)
  8510. (with-current-buffer buffer
  8511. (setq trg (and (string-match org-link-bracket-re l)
  8512. (match-string 1 l)))
  8513. (if (or (not trg) (string-match org-link-any-re trg))
  8514. ;; Don't use `org-with-wide-buffer' here as
  8515. ;; opening the link may result in moving the point
  8516. (save-restriction
  8517. (widen)
  8518. (goto-char marker)
  8519. (when (search-forward l nil lkend)
  8520. (goto-char (match-beginning 0))
  8521. (org-open-at-point)))
  8522. ;; This is an internal link, widen the buffer
  8523. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8524. (switch-to-buffer-other-window buffer)
  8525. (widen)
  8526. (goto-char marker)
  8527. (when (search-forward l nil lkend)
  8528. (goto-char (match-beginning 0))
  8529. (org-open-at-point)))))
  8530. lk))
  8531. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8532. (save-excursion
  8533. (beginning-of-line 1)
  8534. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8535. (org-link-open-from-string (match-string 1)))
  8536. (t (message "No link to open here")))))
  8537. (defun org-agenda-copy-local-variable (var)
  8538. "Get a variable from a referenced buffer and install it here."
  8539. (let ((m (org-get-at-bol 'org-marker)))
  8540. (when (and m (buffer-live-p (marker-buffer m)))
  8541. (set (make-local-variable var)
  8542. (with-current-buffer (marker-buffer m)
  8543. (symbol-value var))))))
  8544. (defun org-agenda-switch-to (&optional delete-other-windows)
  8545. "Go to the Org mode file which contains the item at point.
  8546. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8547. displayed Org file fills the frame."
  8548. (interactive)
  8549. (if (and org-return-follows-link
  8550. (not (org-get-at-bol 'org-marker))
  8551. (org-in-regexp org-link-bracket-re))
  8552. (org-link-open-from-string (match-string 0))
  8553. (let* ((marker (or (org-get-at-bol 'org-marker)
  8554. (org-agenda-error)))
  8555. (buffer (marker-buffer marker))
  8556. (pos (marker-position marker)))
  8557. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8558. (pop-to-buffer-same-window buffer)
  8559. (when delete-other-windows (delete-other-windows))
  8560. (widen)
  8561. (goto-char pos)
  8562. (when (derived-mode-p 'org-mode)
  8563. (org-show-context 'agenda)
  8564. (run-hooks 'org-agenda-after-show-hook)))))
  8565. (defun org-agenda-goto-mouse (ev)
  8566. "Go to the Org file which contains the item at the mouse click."
  8567. (interactive "e")
  8568. (mouse-set-point ev)
  8569. (org-agenda-goto))
  8570. (defun org-agenda-show (&optional full-entry)
  8571. "Display the Org file which contains the item at point.
  8572. With prefix argument FULL-ENTRY, make the entire entry visible
  8573. if it was hidden in the outline."
  8574. (interactive "P")
  8575. (let ((win (selected-window)))
  8576. (org-agenda-goto t)
  8577. (when full-entry (org-show-entry))
  8578. (select-window win)))
  8579. (defvar org-agenda-show-window nil)
  8580. (defun org-agenda-show-and-scroll-up (&optional arg)
  8581. "Display the Org file which contains the item at point.
  8582. When called repeatedly, scroll the window that is displaying the buffer.
  8583. With a `\\[universal-argument]' prefix argument, display the item, but \
  8584. fold drawers."
  8585. (interactive "P")
  8586. (let ((win (selected-window)))
  8587. (if (and (window-live-p org-agenda-show-window)
  8588. (eq this-command last-command))
  8589. (progn
  8590. (select-window org-agenda-show-window)
  8591. (ignore-errors (scroll-up)))
  8592. (org-agenda-goto t)
  8593. (org-show-entry)
  8594. (if arg (org-cycle-hide-drawers 'children)
  8595. (org-with-wide-buffer
  8596. (narrow-to-region (org-entry-beginning-position)
  8597. (org-entry-end-position))
  8598. (org-show-all '(drawers))))
  8599. (setq org-agenda-show-window (selected-window)))
  8600. (select-window win)))
  8601. (defun org-agenda-show-scroll-down ()
  8602. "Scroll down the window showing the agenda."
  8603. (interactive)
  8604. (let ((win (selected-window)))
  8605. (when (window-live-p org-agenda-show-window)
  8606. (select-window org-agenda-show-window)
  8607. (ignore-errors (scroll-down))
  8608. (select-window win))))
  8609. (defun org-agenda-show-1 (&optional more)
  8610. "Display the Org file which contains the item at point.
  8611. The prefix arg selects the amount of information to display:
  8612. 0 hide the subtree
  8613. 1 just show the entry according to defaults.
  8614. 2 show the children view
  8615. 3 show the subtree view
  8616. 4 show the entire subtree and any drawers
  8617. With prefix argument FULL-ENTRY, make the entire entry visible
  8618. if it was hidden in the outline."
  8619. (interactive "p")
  8620. (let ((win (selected-window)))
  8621. (org-agenda-goto t)
  8622. (org-back-to-heading)
  8623. (set-window-start (selected-window) (point-at-bol))
  8624. (cond
  8625. ((= more 0)
  8626. (org-flag-subtree t)
  8627. (save-excursion
  8628. (org-back-to-heading)
  8629. (run-hook-with-args 'org-cycle-hook 'folded))
  8630. (message "Remote: FOLDED"))
  8631. ((and (called-interactively-p 'any) (= more 1))
  8632. (message "Remote: show with default settings"))
  8633. ((= more 2)
  8634. (outline-show-entry)
  8635. (org-show-children)
  8636. (save-excursion
  8637. (org-back-to-heading)
  8638. (run-hook-with-args 'org-cycle-hook 'children))
  8639. (message "Remote: CHILDREN"))
  8640. ((= more 3)
  8641. (outline-show-subtree)
  8642. (save-excursion
  8643. (org-back-to-heading)
  8644. (run-hook-with-args 'org-cycle-hook 'subtree))
  8645. (message "Remote: SUBTREE"))
  8646. ((> more 3)
  8647. (outline-show-subtree)
  8648. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8649. (select-window win)))
  8650. (defvar org-agenda-cycle-counter nil)
  8651. (defun org-agenda-cycle-show (&optional n)
  8652. "Show the current entry in another window, with default settings.
  8653. Default settings are taken from `org-show-context-detail'. When
  8654. use repeatedly in immediate succession, the remote entry will
  8655. cycle through visibility
  8656. children -> subtree -> folded
  8657. When called with a numeric prefix arg, that arg will be passed through to
  8658. `org-agenda-show-1'. For the interpretation of that argument, see the
  8659. docstring of `org-agenda-show-1'."
  8660. (interactive "P")
  8661. (if (integerp n)
  8662. (setq org-agenda-cycle-counter n)
  8663. (if (not (eq last-command this-command))
  8664. (setq org-agenda-cycle-counter 1)
  8665. (if (equal org-agenda-cycle-counter 0)
  8666. (setq org-agenda-cycle-counter 2)
  8667. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8668. (when (> org-agenda-cycle-counter 3)
  8669. (setq org-agenda-cycle-counter 0)))))
  8670. (org-agenda-show-1 org-agenda-cycle-counter))
  8671. (defun org-agenda-recenter (arg)
  8672. "Display the Org file which contains the item at point and recenter."
  8673. (interactive "P")
  8674. (let ((win (selected-window)))
  8675. (org-agenda-goto t)
  8676. (recenter arg)
  8677. (select-window win)))
  8678. (defun org-agenda-show-mouse (ev)
  8679. "Display the Org file which contains the item at the mouse click."
  8680. (interactive "e")
  8681. (mouse-set-point ev)
  8682. (org-agenda-show))
  8683. (defun org-agenda-check-no-diary ()
  8684. "Check if the entry is a diary link and abort if yes."
  8685. (when (org-get-at-bol 'org-agenda-diary-link)
  8686. (org-agenda-error)))
  8687. (defun org-agenda-error ()
  8688. "Throw an error when a command is not allowed in the agenda."
  8689. (user-error "Command not allowed in this line"))
  8690. (defun org-agenda-tree-to-indirect-buffer (arg)
  8691. "Show the subtree corresponding to the current entry in an indirect buffer.
  8692. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8693. With a numerical prefix ARG, go up to this level and then take that tree.
  8694. With a negative numeric ARG, go up by this number of levels.
  8695. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8696. i.e. don't use
  8697. the dedicated frame."
  8698. (interactive "P")
  8699. (if current-prefix-arg
  8700. (org-agenda-do-tree-to-indirect-buffer arg)
  8701. (let ((agenda-buffer (buffer-name))
  8702. (agenda-window (selected-window))
  8703. (indirect-window
  8704. (and org-last-indirect-buffer
  8705. (get-buffer-window org-last-indirect-buffer))))
  8706. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8707. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8708. (eq org-indirect-buffer-display 'dedicated-frame))
  8709. (unwind-protect
  8710. (unless (and indirect-window (window-live-p indirect-window))
  8711. (setq indirect-window (split-window agenda-window)))
  8712. (and indirect-window (select-window indirect-window))
  8713. (switch-to-buffer org-last-indirect-buffer :norecord)
  8714. (fit-window-to-buffer indirect-window)))
  8715. (select-window (get-buffer-window agenda-buffer))
  8716. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8717. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8718. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8719. (org-agenda-check-no-diary)
  8720. (let* ((marker (or (org-get-at-bol 'org-marker)
  8721. (org-agenda-error)))
  8722. (buffer (marker-buffer marker))
  8723. (pos (marker-position marker)))
  8724. (with-current-buffer buffer
  8725. (save-excursion
  8726. (goto-char pos)
  8727. (org-tree-to-indirect-buffer arg)))))
  8728. (defvar org-last-heading-marker (make-marker)
  8729. "Marker pointing to the headline that last changed its TODO state
  8730. by a remote command from the agenda.")
  8731. (defun org-agenda-todo-nextset ()
  8732. "Switch TODO entry to next sequence."
  8733. (interactive)
  8734. (org-agenda-todo 'nextset))
  8735. (defun org-agenda-todo-previousset ()
  8736. "Switch TODO entry to previous sequence."
  8737. (interactive)
  8738. (org-agenda-todo 'previousset))
  8739. (defvar org-agenda-headline-snapshot-before-repeat)
  8740. (defun org-agenda-todo (&optional arg)
  8741. "Cycle TODO state of line at point, also in Org file.
  8742. This changes the line at point, all other lines in the agenda referring to
  8743. the same tree node, and the headline of the tree node in the Org file."
  8744. (interactive "P")
  8745. (org-agenda-check-no-diary)
  8746. (org-agenda-maybe-loop
  8747. #'org-agenda-todo arg nil nil
  8748. (let* ((col (current-column))
  8749. (marker (or (org-get-at-bol 'org-marker)
  8750. (org-agenda-error)))
  8751. (buffer (marker-buffer marker))
  8752. (pos (marker-position marker))
  8753. (hdmarker (org-get-at-bol 'org-hd-marker))
  8754. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8755. (inhibit-read-only t)
  8756. org-loop-over-headlines-in-active-region
  8757. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8758. (org-with-remote-undo buffer
  8759. (with-current-buffer buffer
  8760. (widen)
  8761. (goto-char pos)
  8762. (org-show-context 'agenda)
  8763. (let ((current-prefix-arg arg))
  8764. (call-interactively 'org-todo))
  8765. (and (bolp) (forward-char 1))
  8766. (setq newhead (org-get-heading))
  8767. (when (and org-agenda-headline-snapshot-before-repeat
  8768. (not (equal org-agenda-headline-snapshot-before-repeat
  8769. newhead))
  8770. todayp)
  8771. (setq newhead org-agenda-headline-snapshot-before-repeat
  8772. just-one t))
  8773. (save-excursion
  8774. (org-back-to-heading)
  8775. (move-marker org-last-heading-marker (point))))
  8776. (beginning-of-line 1)
  8777. (save-window-excursion
  8778. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8779. (when (bound-and-true-p org-clock-out-when-done)
  8780. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8781. newhead)
  8782. (org-agenda-unmark-clocking-task))
  8783. (org-move-to-column col)
  8784. (org-agenda-mark-clocking-task)))))
  8785. (defun org-agenda-add-note (&optional _arg)
  8786. "Add a time-stamped note to the entry at point."
  8787. (interactive) ;; "P"
  8788. (org-agenda-check-no-diary)
  8789. (let* ((marker (or (org-get-at-bol 'org-marker)
  8790. (org-agenda-error)))
  8791. (buffer (marker-buffer marker))
  8792. (pos (marker-position marker))
  8793. (_hdmarker (org-get-at-bol 'org-hd-marker))
  8794. (inhibit-read-only t))
  8795. (with-current-buffer buffer
  8796. (widen)
  8797. (goto-char pos)
  8798. (org-show-context 'agenda)
  8799. (org-add-note))))
  8800. (defun org-agenda-change-all-lines (newhead hdmarker
  8801. &optional fixface just-this)
  8802. "Change all lines in the agenda buffer which match HDMARKER.
  8803. The new content of the line will be NEWHEAD (as modified by
  8804. `org-agenda-format-item'). HDMARKER is checked with
  8805. `equal' against all `org-hd-marker' text properties in the file.
  8806. If FIXFACE is non-nil, the face of each item is modified according to
  8807. the new TODO state.
  8808. If JUST-THIS is non-nil, change just the current line, not all.
  8809. If FORCE-TAGS is non-nil, the car of it returns the new tags."
  8810. (let* ((inhibit-read-only t)
  8811. (line (org-current-line))
  8812. (org-agenda-buffer (current-buffer))
  8813. (thetags (with-current-buffer (marker-buffer hdmarker)
  8814. (org-get-tags hdmarker)))
  8815. props m undone-face done-face finish new dotime level cat tags) ;; pl
  8816. (save-excursion
  8817. (goto-char (point-max))
  8818. (beginning-of-line 1)
  8819. (while (not finish)
  8820. (setq finish (bobp))
  8821. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8822. (or (not just-this) (= (org-current-line) line))
  8823. (equal m hdmarker))
  8824. (setq props (text-properties-at (point))
  8825. dotime (org-get-at-bol 'dotime)
  8826. cat (org-agenda-get-category)
  8827. level (org-get-at-bol 'level)
  8828. tags thetags
  8829. new
  8830. (let ((org-prefix-format-compiled
  8831. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8832. org-prefix-format-compiled))
  8833. (extra (org-get-at-bol 'extra)))
  8834. (with-current-buffer (marker-buffer hdmarker)
  8835. (org-with-wide-buffer
  8836. (org-agenda-format-item extra newhead level cat tags dotime))))
  8837. ;; pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8838. undone-face (org-get-at-bol 'undone-face)
  8839. done-face (org-get-at-bol 'done-face))
  8840. (beginning-of-line 1)
  8841. (cond
  8842. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8843. ((looking-at ".*")
  8844. ;; When replacing the whole line, preserve bulk mark
  8845. ;; overlay, if any.
  8846. (let ((mark (catch :overlay
  8847. (dolist (o (overlays-in (point) (+ 2 (point))))
  8848. (when (eq (overlay-get o 'type)
  8849. 'org-marked-entry-overlay)
  8850. (throw :overlay o))))))
  8851. (replace-match new t t)
  8852. (beginning-of-line)
  8853. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8854. (add-text-properties (point-at-bol) (point-at-eol) props)
  8855. (when fixface
  8856. (add-text-properties
  8857. (point-at-bol) (point-at-eol)
  8858. (list 'face
  8859. (if org-last-todo-state-is-todo
  8860. undone-face done-face))))
  8861. (org-agenda-highlight-todo 'line)
  8862. (beginning-of-line 1))
  8863. (t (error "Line update did not work")))
  8864. (save-restriction
  8865. (narrow-to-region (point-at-bol) (point-at-eol))
  8866. (org-agenda-finalize)))
  8867. (beginning-of-line 0)))))
  8868. (defun org-agenda-align-tags (&optional line)
  8869. "Align all tags in agenda items to `org-agenda-tags-column'.
  8870. When optional argument LINE is non-nil, align tags only on the
  8871. current line."
  8872. (let ((inhibit-read-only t)
  8873. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8874. (- (window-text-width))
  8875. org-agenda-tags-column))
  8876. (end (and line (line-end-position)))
  8877. l c)
  8878. (save-excursion
  8879. (goto-char (if line (line-beginning-position) (point-min)))
  8880. (while (re-search-forward org-tag-group-re end t)
  8881. (add-text-properties
  8882. (match-beginning 1) (match-end 1)
  8883. (list 'face (delq nil (let ((prop (get-text-property
  8884. (match-beginning 1) 'face)))
  8885. (or (listp prop) (setq prop (list prop)))
  8886. (if (memq 'org-tag prop)
  8887. prop
  8888. (cons 'org-tag prop))))))
  8889. (setq l (string-width (match-string 1))
  8890. c (if (< org-agenda-tags-column 0)
  8891. (- (abs org-agenda-tags-column) l)
  8892. org-agenda-tags-column))
  8893. (goto-char (match-beginning 1))
  8894. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8895. (point))
  8896. (insert (org-add-props
  8897. (make-string (max 1 (- c (current-column))) ?\s)
  8898. (plist-put (copy-sequence (text-properties-at (point)))
  8899. 'face nil))))
  8900. (goto-char (point-min))
  8901. (org-font-lock-add-tag-faces (point-max)))))
  8902. (defun org-agenda-priority-up ()
  8903. "Increase the priority of line at point, also in Org file."
  8904. (interactive)
  8905. (org-agenda-priority 'up))
  8906. (defun org-agenda-priority-down ()
  8907. "Decrease the priority of line at point, also in Org file."
  8908. (interactive)
  8909. (org-agenda-priority 'down))
  8910. (defun org-agenda-priority (&optional force-direction)
  8911. "Set the priority of line at point, also in Org file.
  8912. This changes the line at point, all other lines in the agenda
  8913. referring to the same tree node, and the headline of the tree
  8914. node in the Org file.
  8915. Called with one universal prefix arg, show the priority instead
  8916. of setting it.
  8917. When called programmatically, FORCE-DIRECTION can be `set', `up',
  8918. `down', or a character."
  8919. (interactive "P")
  8920. (unless org-priority-enable-commands
  8921. (user-error "Priority commands are disabled"))
  8922. (org-agenda-check-no-diary)
  8923. (let* ((col (current-column))
  8924. (hdmarker (org-get-at-bol 'org-hd-marker))
  8925. (buffer (marker-buffer hdmarker))
  8926. (pos (marker-position hdmarker))
  8927. (inhibit-read-only t)
  8928. newhead)
  8929. (org-with-remote-undo buffer
  8930. (with-current-buffer buffer
  8931. (widen)
  8932. (goto-char pos)
  8933. (org-show-context 'agenda)
  8934. (org-priority force-direction)
  8935. (end-of-line 1)
  8936. (setq newhead (org-get-heading)))
  8937. (org-agenda-change-all-lines newhead hdmarker)
  8938. (org-move-to-column col))))
  8939. ;; FIXME: should fix the tags property of the agenda line.
  8940. (defun org-agenda-set-tags (&optional tag onoff)
  8941. "Set tags for the current headline."
  8942. (interactive)
  8943. (org-agenda-check-no-diary)
  8944. (if (and (org-region-active-p) (called-interactively-p 'any))
  8945. (call-interactively 'org-change-tag-in-region)
  8946. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8947. (org-agenda-error)))
  8948. (buffer (marker-buffer hdmarker))
  8949. (pos (marker-position hdmarker))
  8950. (inhibit-read-only t)
  8951. newhead)
  8952. (org-with-remote-undo buffer
  8953. (with-current-buffer buffer
  8954. (widen)
  8955. (goto-char pos)
  8956. (org-show-context 'agenda)
  8957. (if tag
  8958. (org-toggle-tag tag onoff)
  8959. (call-interactively #'org-set-tags-command))
  8960. (end-of-line 1)
  8961. (setq newhead (org-get-heading)))
  8962. (org-agenda-change-all-lines newhead hdmarker)
  8963. (beginning-of-line 1)))))
  8964. (defun org-agenda-set-property ()
  8965. "Set a property for the current headline."
  8966. (interactive)
  8967. (org-agenda-check-no-diary)
  8968. (org-agenda-maybe-loop
  8969. #'org-agenda-set-property nil nil nil
  8970. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8971. (org-agenda-error)))
  8972. (buffer (marker-buffer hdmarker))
  8973. (pos (marker-position hdmarker))
  8974. (inhibit-read-only t)
  8975. ) ;; newhead
  8976. (org-with-remote-undo buffer
  8977. (with-current-buffer buffer
  8978. (widen)
  8979. (goto-char pos)
  8980. (org-show-context 'agenda)
  8981. (call-interactively 'org-set-property))))))
  8982. (defun org-agenda-set-effort ()
  8983. "Set the effort property for the current headline."
  8984. (interactive)
  8985. (org-agenda-check-no-diary)
  8986. (org-agenda-maybe-loop
  8987. #'org-agenda-set-effort nil nil nil
  8988. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8989. (org-agenda-error)))
  8990. (buffer (marker-buffer hdmarker))
  8991. (pos (marker-position hdmarker))
  8992. (inhibit-read-only t)
  8993. newhead)
  8994. (org-with-remote-undo buffer
  8995. (with-current-buffer buffer
  8996. (widen)
  8997. (goto-char pos)
  8998. (org-show-context 'agenda)
  8999. (call-interactively 'org-set-effort)
  9000. (end-of-line 1)
  9001. (setq newhead (org-get-heading)))
  9002. (org-agenda-change-all-lines newhead hdmarker)))))
  9003. (defun org-agenda-toggle-archive-tag ()
  9004. "Toggle the archive tag for the current entry."
  9005. (interactive)
  9006. (org-agenda-check-no-diary)
  9007. (org-agenda-maybe-loop
  9008. #'org-agenda-toggle-archive-tag nil nil nil
  9009. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9010. (org-agenda-error)))
  9011. (buffer (marker-buffer hdmarker))
  9012. (pos (marker-position hdmarker))
  9013. (inhibit-read-only t)
  9014. newhead)
  9015. (org-with-remote-undo buffer
  9016. (with-current-buffer buffer
  9017. (widen)
  9018. (goto-char pos)
  9019. (org-show-context 'agenda)
  9020. (call-interactively 'org-toggle-archive-tag)
  9021. (end-of-line 1)
  9022. (setq newhead (org-get-heading)))
  9023. (org-agenda-change-all-lines newhead hdmarker)
  9024. (beginning-of-line 1)))))
  9025. (defun org-agenda-do-date-later (arg)
  9026. (interactive "P")
  9027. (cond
  9028. ((or (equal arg '(16))
  9029. (memq last-command
  9030. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9031. (setq this-command 'org-agenda-date-later-minutes)
  9032. (org-agenda-date-later-minutes 1))
  9033. ((or (equal arg '(4))
  9034. (memq last-command
  9035. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9036. (setq this-command 'org-agenda-date-later-hours)
  9037. (org-agenda-date-later-hours 1))
  9038. (t
  9039. (org-agenda-date-later (prefix-numeric-value arg)))))
  9040. (defun org-agenda-do-date-earlier (arg)
  9041. (interactive "P")
  9042. (cond
  9043. ((or (equal arg '(16))
  9044. (memq last-command
  9045. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9046. (setq this-command 'org-agenda-date-earlier-minutes)
  9047. (org-agenda-date-earlier-minutes 1))
  9048. ((or (equal arg '(4))
  9049. (memq last-command
  9050. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9051. (setq this-command 'org-agenda-date-earlier-hours)
  9052. (org-agenda-date-earlier-hours 1))
  9053. (t
  9054. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  9055. (defun org-agenda-date-later (arg &optional what)
  9056. "Change the date of this item to ARG day(s) later."
  9057. (interactive "p")
  9058. (org-agenda-check-type t 'agenda)
  9059. (org-agenda-check-no-diary)
  9060. (let* ((marker (or (org-get-at-bol 'org-marker)
  9061. (org-agenda-error)))
  9062. (buffer (marker-buffer marker))
  9063. (pos (marker-position marker))
  9064. cdate today)
  9065. (org-with-remote-undo buffer
  9066. (with-current-buffer buffer
  9067. (widen)
  9068. (goto-char pos)
  9069. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9070. (when (and org-agenda-move-date-from-past-immediately-to-today
  9071. (equal arg 1)
  9072. (or (not what) (eq what 'day))
  9073. (not (save-match-data (org-at-date-range-p))))
  9074. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  9075. cdate (calendar-absolute-from-gregorian
  9076. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  9077. today (org-today))
  9078. (when (> today cdate)
  9079. ;; immediately shift to today
  9080. (setq arg (- today cdate))))
  9081. (org-timestamp-change arg (or what 'day))
  9082. (when (and (org-at-date-range-p)
  9083. (re-search-backward org-tr-regexp-both (point-at-bol)))
  9084. (let ((end org-last-changed-timestamp))
  9085. (org-timestamp-change arg (or what 'day))
  9086. (setq org-last-changed-timestamp
  9087. (concat org-last-changed-timestamp "--" end)))))
  9088. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9089. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  9090. (defun org-agenda-date-earlier (arg &optional what)
  9091. "Change the date of this item to ARG day(s) earlier."
  9092. (interactive "p")
  9093. (org-agenda-date-later (- arg) what))
  9094. (defun org-agenda-date-later-minutes (arg)
  9095. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9096. (interactive "p")
  9097. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9098. (org-agenda-date-later arg 'minute))
  9099. (defun org-agenda-date-earlier-minutes (arg)
  9100. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9101. (interactive "p")
  9102. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9103. (org-agenda-date-earlier arg 'minute))
  9104. (defun org-agenda-date-later-hours (arg)
  9105. "Change the time of this item, in hour steps."
  9106. (interactive "p")
  9107. (org-agenda-date-later arg 'hour))
  9108. (defun org-agenda-date-earlier-hours (arg)
  9109. "Change the time of this item, in hour steps."
  9110. (interactive "p")
  9111. (org-agenda-date-earlier arg 'hour))
  9112. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  9113. "Show new date stamp via text properties."
  9114. ;; We use text properties to make this undoable
  9115. (let ((inhibit-read-only t))
  9116. (setq stamp (concat prefix " => " stamp " "))
  9117. (save-excursion
  9118. (goto-char (point-max))
  9119. (while (not (bobp))
  9120. (when (equal marker (org-get-at-bol 'org-marker))
  9121. (remove-text-properties (line-beginning-position)
  9122. (line-end-position)
  9123. '(display nil))
  9124. (org-move-to-column
  9125. (- (if (fboundp 'window-font-width)
  9126. (/ (window-width nil t) (window-font-width))
  9127. ;; Fall back to pre-9.3.3 behavior on Emacs <25.
  9128. (window-width))
  9129. (length stamp))
  9130. t)
  9131. (add-text-properties
  9132. (1- (point)) (point-at-eol)
  9133. (list 'display (org-add-props stamp nil
  9134. 'face '(secondary-selection default))))
  9135. (beginning-of-line 1))
  9136. (beginning-of-line 0)))))
  9137. (defun org-agenda-date-prompt (arg)
  9138. "Change the date of this item. Date is prompted for, with default today.
  9139. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  9140. be used to request time specification in the time stamp."
  9141. (interactive "P")
  9142. (org-agenda-check-type t 'agenda)
  9143. (org-agenda-check-no-diary)
  9144. (org-agenda-maybe-loop
  9145. #'org-agenda-date-prompt arg t nil
  9146. (let* ((marker (or (org-get-at-bol 'org-marker)
  9147. (org-agenda-error)))
  9148. (buffer (marker-buffer marker))
  9149. (pos (marker-position marker)))
  9150. (org-with-remote-undo buffer
  9151. (with-current-buffer buffer
  9152. (widen)
  9153. (goto-char pos)
  9154. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9155. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  9156. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9157. (message "Time stamp changed to %s" org-last-changed-timestamp))))
  9158. (defun org-agenda-schedule (arg &optional time)
  9159. "Schedule the item at point.
  9160. ARG is passed through to `org-schedule'."
  9161. (interactive "P")
  9162. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9163. (org-agenda-check-no-diary)
  9164. (org-agenda-maybe-loop
  9165. #'org-agenda-schedule arg t nil
  9166. (let* ((marker (or (org-get-at-bol 'org-marker)
  9167. (org-agenda-error)))
  9168. ;; (type (marker-insertion-type marker))
  9169. (buffer (marker-buffer marker))
  9170. (pos (marker-position marker))
  9171. ts)
  9172. (set-marker-insertion-type marker t)
  9173. (org-with-remote-undo buffer
  9174. (with-current-buffer buffer
  9175. (widen)
  9176. (goto-char pos)
  9177. (setq ts (org-schedule arg time)))
  9178. (org-agenda-show-new-time marker ts " S"))
  9179. (message "%s" ts))))
  9180. (defun org-agenda-deadline (arg &optional time)
  9181. "Schedule the item at point.
  9182. ARG is passed through to `org-deadline'."
  9183. (interactive "P")
  9184. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9185. (org-agenda-check-no-diary)
  9186. (org-agenda-maybe-loop
  9187. #'org-agenda-deadline arg t nil
  9188. (let* ((marker (or (org-get-at-bol 'org-marker)
  9189. (org-agenda-error)))
  9190. (buffer (marker-buffer marker))
  9191. (pos (marker-position marker))
  9192. ts)
  9193. (org-with-remote-undo buffer
  9194. (with-current-buffer buffer
  9195. (widen)
  9196. (goto-char pos)
  9197. (setq ts (org-deadline arg time)))
  9198. (org-agenda-show-new-time marker ts " D"))
  9199. (message "%s" ts))))
  9200. (defun org-agenda-clock-in (&optional arg)
  9201. "Start the clock on the currently selected item."
  9202. (interactive "P")
  9203. (org-agenda-check-no-diary)
  9204. (if (equal arg '(4))
  9205. (org-clock-in arg)
  9206. (let* ((marker (or (org-get-at-bol 'org-marker)
  9207. (org-agenda-error)))
  9208. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  9209. (pos (marker-position marker))
  9210. (col (current-column))
  9211. newhead)
  9212. (org-with-remote-undo (marker-buffer marker)
  9213. (with-current-buffer (marker-buffer marker)
  9214. (widen)
  9215. (goto-char pos)
  9216. (org-show-context 'agenda)
  9217. (org-clock-in arg)
  9218. (setq newhead (org-get-heading)))
  9219. (org-agenda-change-all-lines newhead hdmarker))
  9220. (org-move-to-column col))))
  9221. (defun org-agenda-clock-out ()
  9222. "Stop the currently running clock."
  9223. (interactive)
  9224. (unless (marker-buffer org-clock-marker)
  9225. (user-error "No running clock"))
  9226. (let ((marker (make-marker)) (col (current-column)) newhead)
  9227. (org-with-remote-undo (marker-buffer org-clock-marker)
  9228. (with-current-buffer (marker-buffer org-clock-marker)
  9229. (org-with-wide-buffer
  9230. (goto-char org-clock-marker)
  9231. (org-back-to-heading t)
  9232. (move-marker marker (point))
  9233. (org-clock-out)
  9234. (setq newhead (org-get-heading)))))
  9235. (org-agenda-change-all-lines newhead marker)
  9236. (move-marker marker nil)
  9237. (org-move-to-column col)
  9238. (org-agenda-unmark-clocking-task)))
  9239. (defun org-agenda-clock-cancel (&optional _arg)
  9240. "Cancel the currently running clock."
  9241. (interactive) ;; "P"
  9242. (unless (marker-buffer org-clock-marker)
  9243. (user-error "No running clock"))
  9244. (org-with-remote-undo (marker-buffer org-clock-marker)
  9245. (org-clock-cancel)))
  9246. (defun org-agenda-clock-goto ()
  9247. "Jump to the currently clocked in task within the agenda.
  9248. If the currently clocked in task is not listed in the agenda
  9249. buffer, display it in another window."
  9250. (interactive)
  9251. (let (pos)
  9252. (mapc (lambda (o)
  9253. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  9254. (setq pos (overlay-start o))))
  9255. (overlays-in (point-min) (point-max)))
  9256. (cond (pos (goto-char pos))
  9257. ;; If the currently clocked entry is not in the agenda
  9258. ;; buffer, we visit it in another window:
  9259. ((bound-and-true-p org-clock-current-task)
  9260. (org-switch-to-buffer-other-window (org-clock-goto)))
  9261. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  9262. (defun org-agenda-diary-entry-in-org-file ()
  9263. "Make a diary entry in the file `org-agenda-diary-file'."
  9264. (let (d1 d2 char (text "") dp1 dp2)
  9265. (if (equal (buffer-name) "*Calendar*")
  9266. (setq d1 (calendar-cursor-to-date t)
  9267. d2 (car calendar-mark-ring))
  9268. (setq dp1 (get-text-property (point-at-bol) 'day))
  9269. (unless dp1 (user-error "No date defined in current line"))
  9270. (setq d1 (calendar-gregorian-from-absolute dp1)
  9271. d2 (and (ignore-errors (mark))
  9272. (save-excursion
  9273. (goto-char (mark))
  9274. (setq dp2 (get-text-property (point-at-bol) 'day)))
  9275. (calendar-gregorian-from-absolute dp2))))
  9276. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  9277. (setq char (read-char-exclusive))
  9278. (cond
  9279. ((equal char ?d)
  9280. (setq text (read-string "Day entry: "))
  9281. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  9282. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9283. ((equal char ?a)
  9284. (setq d1 (list (car d1) (nth 1 d1)
  9285. (read-number (format "Reference year [%d]: " (nth 2 d1))
  9286. (nth 2 d1))))
  9287. (setq text (read-string "Anniversary (use %d to show years): "))
  9288. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  9289. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9290. ((equal char ?b)
  9291. (setq text (read-string "Block entry: "))
  9292. (unless (and d1 d2 (not (equal d1 d2)))
  9293. (user-error "No block of days selected"))
  9294. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  9295. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9296. ((equal char ?j)
  9297. (org-switch-to-buffer-other-window
  9298. (find-file-noselect org-agenda-diary-file))
  9299. (require 'org-datetree)
  9300. (org-datetree-find-date-create d1)
  9301. (org-reveal t))
  9302. (t (user-error "Invalid selection character `%c'" char)))))
  9303. (defcustom org-agenda-insert-diary-strategy 'date-tree
  9304. "Where in `org-agenda-diary-file' should new entries be added?
  9305. Valid values:
  9306. date-tree in the date tree, as first child of the date
  9307. date-tree-last in the date tree, as last child of the date
  9308. top-level as top-level entries at the end of the file."
  9309. :group 'org-agenda
  9310. :type '(choice
  9311. (const :tag "first in a date tree" date-tree)
  9312. (const :tag "last in a date tree" date-tree-last)
  9313. (const :tag "as top level at end of file" top-level)))
  9314. (defcustom org-agenda-insert-diary-extract-time nil
  9315. "Non-nil means extract any time specification from the diary entry."
  9316. :group 'org-agenda
  9317. :version "24.1"
  9318. :type 'boolean)
  9319. (defcustom org-agenda-bulk-mark-char ">"
  9320. "A single-character string to be used as the bulk mark."
  9321. :group 'org-agenda
  9322. :version "24.1"
  9323. :type 'string)
  9324. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  9325. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  9326. If TEXT is not empty, it will become the headline of the new entry, and
  9327. the resulting entry will not be shown. When TEXT is empty, switch to
  9328. `org-agenda-diary-file' and let the user finish the entry there."
  9329. (let ((cw (current-window-configuration)))
  9330. (org-switch-to-buffer-other-window
  9331. (find-file-noselect org-agenda-diary-file))
  9332. (widen)
  9333. (goto-char (point-min))
  9334. (cl-case type
  9335. (anniversary
  9336. (or (re-search-forward "^\\*[ \t]+Anniversaries" nil t)
  9337. (progn
  9338. (or (org-at-heading-p t)
  9339. (progn
  9340. (outline-next-heading)
  9341. (insert "* Anniversaries\n\n")
  9342. (beginning-of-line -1)))))
  9343. (outline-next-heading)
  9344. (org-back-over-empty-lines)
  9345. (backward-char 1)
  9346. (insert "\n")
  9347. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  9348. (nth 2 d1) (car d1) (nth 1 d1) text)))
  9349. (day
  9350. (let ((org-prefix-has-time t)
  9351. (org-agenda-time-leading-zero t)
  9352. fmt time time2)
  9353. (when org-agenda-insert-diary-extract-time
  9354. ;; Use org-agenda-format-item to parse text for a time-range and
  9355. ;; remove it. FIXME: This is a hack, we should refactor
  9356. ;; that function to make time extraction available separately
  9357. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  9358. time (get-text-property 0 'time fmt)
  9359. time2 (if (> (length time) 0)
  9360. ;; split-string removes trailing ...... if
  9361. ;; no end time given. First space
  9362. ;; separates time from date.
  9363. (concat " " (car (split-string time "\\.")))
  9364. nil)
  9365. text (get-text-property 0 'txt fmt)))
  9366. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9367. (org-agenda-insert-diary-as-top-level text)
  9368. (require 'org-datetree)
  9369. (org-datetree-find-date-create d1)
  9370. (org-agenda-insert-diary-make-new-entry text))
  9371. (org-insert-time-stamp (org-time-from-absolute
  9372. (calendar-absolute-from-gregorian d1))
  9373. nil nil nil nil time2))
  9374. (end-of-line 0))
  9375. ((block) ;; Wrap this in (strictly unnecessary) parens because
  9376. ;; otherwise the indentation gets confused by the
  9377. ;; special meaning of 'block
  9378. (when (> (calendar-absolute-from-gregorian d1)
  9379. (calendar-absolute-from-gregorian d2))
  9380. (setq d1 (prog1 d2 (setq d2 d1))))
  9381. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9382. (org-agenda-insert-diary-as-top-level text)
  9383. (require 'org-datetree)
  9384. (org-datetree-find-date-create d1)
  9385. (org-agenda-insert-diary-make-new-entry text))
  9386. (org-insert-time-stamp (org-time-from-absolute
  9387. (calendar-absolute-from-gregorian d1)))
  9388. (insert "--")
  9389. (org-insert-time-stamp (org-time-from-absolute
  9390. (calendar-absolute-from-gregorian d2)))
  9391. (end-of-line 0)))
  9392. (if (string-match "\\S-" text)
  9393. (progn
  9394. (set-window-configuration cw)
  9395. (message "%s entry added to %s"
  9396. (capitalize (symbol-name type))
  9397. (abbreviate-file-name org-agenda-diary-file)))
  9398. (org-reveal t)
  9399. (message "Please finish entry here"))))
  9400. (defun org-agenda-insert-diary-as-top-level (text)
  9401. "Make new entry as a top-level entry at the end of the file.
  9402. Add TEXT as headline, and position the cursor in the second line so that
  9403. a timestamp can be added there."
  9404. (widen)
  9405. (goto-char (point-max))
  9406. (unless (bolp) (insert "\n"))
  9407. (org-insert-heading nil t t)
  9408. (insert text)
  9409. (org-end-of-meta-data)
  9410. (unless (bolp) (insert "\n"))
  9411. (when org-adapt-indentation (indent-to-column 2)))
  9412. (defun org-agenda-insert-diary-make-new-entry (text)
  9413. "Make a new entry with TEXT as a child of the current subtree.
  9414. Position the point in the heading's first body line so that
  9415. a timestamp can be added there."
  9416. (cond
  9417. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  9418. (end-of-line)
  9419. (org-insert-heading '(4) t)
  9420. (org-do-demote))
  9421. (t
  9422. (outline-next-heading)
  9423. (org-back-over-empty-lines)
  9424. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  9425. (org-insert-heading nil t)
  9426. (org-do-demote)))
  9427. (let ((col (current-column)))
  9428. (insert text)
  9429. (org-end-of-meta-data)
  9430. ;; Ensure point is left on a blank line, at proper indentation.
  9431. (unless (bolp) (insert "\n"))
  9432. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  9433. (when org-adapt-indentation (indent-to-column col)))
  9434. (org-show-set-visibility 'lineage))
  9435. (defun org-agenda-diary-entry ()
  9436. "Make a diary entry, like the `i' command from the calendar.
  9437. All the standard commands work: block, weekly etc.
  9438. When `org-agenda-diary-file' points to a file,
  9439. `org-agenda-diary-entry-in-org-file' is called instead to create
  9440. entries in that Org file."
  9441. (interactive)
  9442. (if (not (eq org-agenda-diary-file 'diary-file))
  9443. (org-agenda-diary-entry-in-org-file)
  9444. (require 'diary-lib)
  9445. (let* ((char (read-char-exclusive
  9446. "Diary entry: [d]ay [w]eekly [m]onthly [y]early\
  9447. [a]nniversary [b]lock [c]yclic"))
  9448. (cmd (cdr (assoc char
  9449. '((?d . diary-insert-entry)
  9450. (?w . diary-insert-weekly-entry)
  9451. (?m . diary-insert-monthly-entry)
  9452. (?y . diary-insert-yearly-entry)
  9453. (?a . diary-insert-anniversary-entry)
  9454. (?b . diary-insert-block-entry)
  9455. (?c . diary-insert-cyclic-entry)))))
  9456. (oldf (symbol-function 'calendar-cursor-to-date))
  9457. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  9458. (point (point))
  9459. (mark (or (mark t) (point))))
  9460. (unless cmd
  9461. (user-error "No command associated with <%c>" char))
  9462. (unless (and (get-text-property point 'day)
  9463. (or (not (equal ?b char))
  9464. (get-text-property mark 'day)))
  9465. (user-error "Don't know which date to use for diary entry"))
  9466. ;; We implement this by hacking the `calendar-cursor-to-date' function
  9467. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  9468. (let ((calendar-mark-ring
  9469. (list (calendar-gregorian-from-absolute
  9470. (or (get-text-property mark 'day)
  9471. (get-text-property point 'day))))))
  9472. (unwind-protect
  9473. (progn
  9474. (fset 'calendar-cursor-to-date
  9475. (lambda (&optional _error _dummy)
  9476. (calendar-gregorian-from-absolute
  9477. (get-text-property point 'day))))
  9478. (call-interactively cmd))
  9479. (fset 'calendar-cursor-to-date oldf))))))
  9480. (defun org-agenda-execute-calendar-command (cmd)
  9481. "Execute a calendar command from the agenda with date from cursor."
  9482. (org-agenda-check-type t 'agenda)
  9483. (require 'diary-lib)
  9484. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  9485. (user-error "Don't know which date to use for the calendar command"))
  9486. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  9487. (point (point))
  9488. (date (calendar-gregorian-from-absolute
  9489. (get-text-property point 'day))))
  9490. ;; the following 2 vars are needed in the calendar
  9491. (org-dlet
  9492. ((displayed-month (car date))
  9493. (displayed-year (nth 2 date)))
  9494. (unwind-protect
  9495. (progn
  9496. (fset 'calendar-cursor-to-date
  9497. (lambda (&optional _error _dummy)
  9498. (calendar-gregorian-from-absolute
  9499. (get-text-property point 'day))))
  9500. (call-interactively cmd))
  9501. (fset 'calendar-cursor-to-date oldf)))))
  9502. (defun org-agenda-phases-of-moon ()
  9503. "Display the phases of the moon for the 3 months around the cursor date."
  9504. (interactive)
  9505. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  9506. (defun org-agenda-holidays ()
  9507. "Display the holidays for the 3 months around the cursor date."
  9508. (interactive)
  9509. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  9510. (defvar calendar-longitude) ; defined in calendar.el
  9511. (defvar calendar-latitude) ; defined in calendar.el
  9512. (defvar calendar-location-name) ; defined in calendar.el
  9513. (defun org-agenda-sunrise-sunset (arg)
  9514. "Display sunrise and sunset for the cursor date.
  9515. Latitude and longitude can be specified with the variables
  9516. `calendar-latitude' and `calendar-longitude'. When called with prefix
  9517. argument, latitude and longitude will be prompted for."
  9518. (interactive "P")
  9519. (require 'solar)
  9520. (let ((calendar-longitude (if arg nil calendar-longitude))
  9521. (calendar-latitude (if arg nil calendar-latitude))
  9522. (calendar-location-name
  9523. (if arg "the given coordinates" calendar-location-name)))
  9524. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  9525. (defun org-agenda-goto-calendar ()
  9526. "Open the Emacs calendar with the date at the cursor."
  9527. (interactive)
  9528. (org-agenda-check-type t 'agenda)
  9529. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  9530. (user-error "Don't know which date to open in calendar")))
  9531. (date (calendar-gregorian-from-absolute day))
  9532. (calendar-move-hook nil)
  9533. (calendar-view-holidays-initially-flag nil)
  9534. (calendar-view-diary-initially-flag nil))
  9535. (calendar)
  9536. (calendar-goto-date date)))
  9537. ;;;###autoload
  9538. (defun org-calendar-goto-agenda ()
  9539. "Compute the Org agenda for the calendar date displayed at the cursor.
  9540. This is a command that has to be installed in `calendar-mode-map'."
  9541. (interactive)
  9542. ;; Temporarily disable sticky agenda since user clearly wants to
  9543. ;; refresh view anyway.
  9544. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  9545. (org-agenda-sticky nil))
  9546. (org-agenda-list nil (calendar-absolute-from-gregorian
  9547. (calendar-cursor-to-date))
  9548. nil)))
  9549. (defun org-agenda-convert-date ()
  9550. (interactive)
  9551. (org-agenda-check-type t 'agenda)
  9552. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  9553. date s)
  9554. (unless day
  9555. (user-error "Don't know which date to convert"))
  9556. (setq date (calendar-gregorian-from-absolute day))
  9557. (setq s (concat
  9558. "Gregorian: " (calendar-date-string date) "\n"
  9559. "ISO: " (calendar-iso-date-string date) "\n"
  9560. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  9561. "Julian: " (calendar-julian-date-string date) "\n"
  9562. "Astron. JD: " (calendar-astro-date-string date)
  9563. " (Julian date number at noon UTC)\n"
  9564. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  9565. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  9566. "French: " (calendar-french-date-string date) "\n"
  9567. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  9568. "Mayan: " (calendar-mayan-date-string date) "\n"
  9569. "Coptic: " (calendar-coptic-date-string date) "\n"
  9570. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  9571. "Persian: " (calendar-persian-date-string date) "\n"
  9572. "Chinese: " (calendar-chinese-date-string date) "\n"))
  9573. (with-output-to-temp-buffer "*Dates*"
  9574. (princ s))
  9575. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  9576. ;;; Bulk commands
  9577. (defun org-agenda-bulk-marked-p ()
  9578. "Non-nil when current entry is marked for bulk action."
  9579. (eq (get-char-property (point-at-bol) 'type)
  9580. 'org-marked-entry-overlay))
  9581. (defun org-agenda-bulk-mark (&optional arg)
  9582. "Mark entries for future bulk action.
  9583. When ARG is nil or one and region is not active then mark the
  9584. entry at point.
  9585. When ARG is nil or one and region is active then mark the entries
  9586. in the region.
  9587. When ARG is greater than one mark ARG lines."
  9588. (interactive "p")
  9589. (when (and (or (not arg) (= arg 1)) (use-region-p))
  9590. (setq arg (count-lines (region-beginning) (region-end)))
  9591. (goto-char (region-beginning))
  9592. (deactivate-mark))
  9593. (dotimes (_ (or arg 1))
  9594. (unless (org-get-at-bol 'org-agenda-diary-link)
  9595. (let* ((m (org-get-at-bol 'org-hd-marker))
  9596. ov)
  9597. (unless (org-agenda-bulk-marked-p)
  9598. (unless m (user-error "Nothing to mark at point"))
  9599. (push m org-agenda-bulk-marked-entries)
  9600. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  9601. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  9602. (org-get-todo-face "TODO")
  9603. 'evaporate)
  9604. (overlay-put ov 'type 'org-marked-entry-overlay))
  9605. (end-of-line 1)
  9606. (or (ignore-errors
  9607. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9608. (beginning-of-line 2))
  9609. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9610. (beginning-of-line 2)))))
  9611. (message "%d entries marked for bulk action"
  9612. (length org-agenda-bulk-marked-entries)))
  9613. (defun org-agenda-bulk-mark-all ()
  9614. "Mark all entries for future agenda bulk action."
  9615. (interactive)
  9616. (org-agenda-bulk-mark-regexp "."))
  9617. (defun org-agenda-bulk-mark-regexp (regexp)
  9618. "Mark entries matching REGEXP for future agenda bulk action."
  9619. (interactive "sMark entries matching regexp: ")
  9620. (let ((entries-marked 0) txt-at-point)
  9621. (save-excursion
  9622. (goto-char (point-min))
  9623. (goto-char (next-single-property-change (point) 'org-hd-marker))
  9624. (while (and (re-search-forward regexp nil t)
  9625. (setq txt-at-point
  9626. (get-text-property (match-beginning 0) 'txt)))
  9627. (if (get-char-property (point) 'invisible)
  9628. (beginning-of-line 2)
  9629. (when (string-match-p regexp txt-at-point)
  9630. (setq entries-marked (1+ entries-marked))
  9631. (call-interactively 'org-agenda-bulk-mark)))))
  9632. (unless entries-marked
  9633. (message "No entry matching this regexp."))))
  9634. (defun org-agenda-bulk-unmark (&optional arg)
  9635. "Unmark the entry at point for future bulk action."
  9636. (interactive "P")
  9637. (if arg
  9638. (org-agenda-bulk-unmark-all)
  9639. (cond ((org-agenda-bulk-marked-p)
  9640. (org-agenda-bulk-remove-overlays
  9641. (point-at-bol) (+ 2 (point-at-bol)))
  9642. (setq org-agenda-bulk-marked-entries
  9643. (delete (org-get-at-bol 'org-hd-marker)
  9644. org-agenda-bulk-marked-entries))
  9645. (end-of-line 1)
  9646. (or (ignore-errors
  9647. (goto-char (next-single-property-change (point) 'txt)))
  9648. (beginning-of-line 2))
  9649. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9650. (beginning-of-line 2))
  9651. (message "%d entries left marked for bulk action"
  9652. (length org-agenda-bulk-marked-entries)))
  9653. (t (message "No entry to unmark here")))))
  9654. (defun org-agenda-bulk-toggle-all ()
  9655. "Toggle all marks for bulk action."
  9656. (interactive)
  9657. (save-excursion
  9658. (goto-char (point-min))
  9659. (while (ignore-errors
  9660. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9661. (org-agenda-bulk-toggle))))
  9662. (defun org-agenda-bulk-toggle ()
  9663. "Toggle the mark at point for bulk action."
  9664. (interactive)
  9665. (if (org-agenda-bulk-marked-p)
  9666. (org-agenda-bulk-unmark)
  9667. (org-agenda-bulk-mark)))
  9668. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  9669. "Remove the mark overlays between BEG and END in the agenda buffer.
  9670. BEG and END default to the buffer limits.
  9671. This only removes the overlays, it does not remove the markers
  9672. from the list in `org-agenda-bulk-marked-entries'."
  9673. (interactive)
  9674. (mapc (lambda (ov)
  9675. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  9676. (delete-overlay ov)))
  9677. (overlays-in (or beg (point-min)) (or end (point-max)))))
  9678. (defun org-agenda-bulk-unmark-all ()
  9679. "Remove all marks in the agenda buffer.
  9680. This will remove the markers and the overlays."
  9681. (interactive)
  9682. (if (null org-agenda-bulk-marked-entries)
  9683. (message "No entry to unmark")
  9684. (setq org-agenda-bulk-marked-entries nil)
  9685. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  9686. (defcustom org-agenda-persistent-marks nil
  9687. "Non-nil means marked items will stay marked after a bulk action.
  9688. You can toggle this interactively by typing `p' when prompted for a
  9689. bulk action."
  9690. :group 'org-agenda
  9691. :version "24.1"
  9692. :type 'boolean)
  9693. (defcustom org-agenda-loop-over-headlines-in-active-region t
  9694. "Shall some commands act upon headlines in the active region?
  9695. When set to t, some commands will be performed in all headlines
  9696. within the active region.
  9697. When set to `start-level', some commands will be performed in all
  9698. headlines within the active region, provided that these headlines
  9699. are of the same level than the first one.
  9700. When set to a regular expression, those commands will be
  9701. performed on the matching headlines within the active region.
  9702. The list of commands is: `org-agenda-schedule',
  9703. `org-agenda-deadline', `org-agenda-date-prompt',
  9704. `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'.
  9705. See `org-loop-over-headlines-in-active-region' for the equivalent
  9706. option for Org buffers."
  9707. :type '(choice (const :tag "Don't loop" nil)
  9708. (const :tag "All headlines in active region" t)
  9709. (const :tag "In active region, headlines at the same level than the first one" start-level)
  9710. (regexp :tag "Regular expression matcher"))
  9711. :version "27.1"
  9712. :package-version '(Org . "9.4")
  9713. :group 'org-agenda)
  9714. (defun org-agenda-bulk-action (&optional arg)
  9715. "Execute an remote-editing action on all marked entries.
  9716. The prefix arg is passed through to the command if possible."
  9717. (interactive "P")
  9718. ;; When there is no mark, act on the agenda entry at point.
  9719. (if (not org-agenda-bulk-marked-entries)
  9720. (save-excursion (org-agenda-bulk-mark)))
  9721. (dolist (m org-agenda-bulk-marked-entries)
  9722. (unless (and (markerp m)
  9723. (marker-buffer m)
  9724. (buffer-live-p (marker-buffer m))
  9725. (marker-position m))
  9726. (user-error "Marker %s for bulk command is invalid" m)))
  9727. ;; Prompt for the bulk command.
  9728. (org-unlogged-message
  9729. (concat "Bulk (" (if org-agenda-persistent-marks "" "don't ") "[p]ersist marks): "
  9730. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  9731. "[S]catter [f]unction "
  9732. (and org-agenda-bulk-custom-functions
  9733. (format " Custom: [%s]"
  9734. (mapconcat (lambda (f) (char-to-string (car f)))
  9735. org-agenda-bulk-custom-functions
  9736. "")))))
  9737. (catch 'exit
  9738. (let* ((org-log-refile (if org-log-refile 'time nil))
  9739. (entries (reverse org-agenda-bulk-marked-entries))
  9740. (org-overriding-default-time
  9741. (and (get-text-property (point) 'org-agenda-date-header)
  9742. (org-get-cursor-date)))
  9743. redo-at-end
  9744. cmd)
  9745. (pcase (read-char-exclusive)
  9746. (?p
  9747. (let ((org-agenda-persistent-marks
  9748. (not org-agenda-persistent-marks)))
  9749. (org-agenda-bulk-action)
  9750. (throw 'exit nil)))
  9751. (?$
  9752. (setq cmd #'org-agenda-archive))
  9753. (?A
  9754. (setq cmd #'org-agenda-archive-to-archive-sibling))
  9755. ((or ?r ?w)
  9756. (let ((refile-location
  9757. (org-refile-get-location
  9758. "Refile to"
  9759. (marker-buffer (car entries))
  9760. org-refile-allow-creating-parent-nodes)))
  9761. (when (nth 3 refile-location)
  9762. (setcar (nthcdr 3 refile-location)
  9763. (move-marker
  9764. (make-marker)
  9765. (nth 3 refile-location)
  9766. (or (get-file-buffer (nth 1 refile-location))
  9767. (find-buffer-visiting (nth 1 refile-location))
  9768. (error "This should not happen")))))
  9769. (setq cmd (lambda () (org-agenda-refile nil refile-location t)))
  9770. (setq redo-at-end t)))
  9771. (?t
  9772. (let ((state (completing-read
  9773. "Todo state: "
  9774. (with-current-buffer (marker-buffer (car entries))
  9775. (mapcar #'list org-todo-keywords-1)))))
  9776. (setq cmd (lambda ()
  9777. (let ((org-inhibit-blocking t)
  9778. (org-inhibit-logging 'note))
  9779. (org-agenda-todo state))))))
  9780. ((and (or ?- ?+) action)
  9781. (let ((tag (completing-read
  9782. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  9783. (with-current-buffer (marker-buffer (car entries))
  9784. (delq nil
  9785. (mapcar (lambda (x) (and (stringp (car x)) x))
  9786. org-current-tag-alist))))))
  9787. (setq cmd
  9788. (lambda ()
  9789. (org-agenda-set-tags tag
  9790. (if (eq action ?+) 'on 'off))))))
  9791. ((and (or ?s ?d) c)
  9792. (let* ((schedule? (eq c ?s))
  9793. (prompt (if schedule? "(Re)Schedule to" "(Re)Set Deadline to"))
  9794. (time
  9795. (and (not arg)
  9796. (let ((new (org-read-date
  9797. nil nil nil prompt org-overriding-default-time)))
  9798. ;; A "double plus" answer applies to every
  9799. ;; scheduled time. Do not turn it into
  9800. ;; a fixed date yet.
  9801. (if (string-match-p "\\`[ \t]*\\+\\+"
  9802. org-read-date-final-answer)
  9803. org-read-date-final-answer
  9804. new)))))
  9805. ;; Make sure to not prompt for a note when bulk
  9806. ;; rescheduling/resetting deadline as Org cannot cope with
  9807. ;; simultaneous notes. Besides, it could be annoying
  9808. ;; depending on the number of marked items.
  9809. (setq cmd
  9810. (if schedule?
  9811. (lambda ()
  9812. (let ((org-log-reschedule
  9813. (and org-log-reschedule 'time)))
  9814. (org-agenda-schedule arg time)))
  9815. (lambda ()
  9816. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  9817. (org-agenda-deadline arg time)))))))
  9818. (?S
  9819. (unless (org-agenda-check-type nil 'agenda 'todo)
  9820. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  9821. (let ((days (read-number
  9822. (format "Scatter tasks across how many %sdays: "
  9823. (if arg "week" ""))
  9824. 7)))
  9825. (setq cmd
  9826. (lambda ()
  9827. (let ((distance (1+ (random days))))
  9828. (when arg
  9829. (let ((dist distance)
  9830. (day-of-week
  9831. (calendar-day-of-week
  9832. (calendar-gregorian-from-absolute (org-today)))))
  9833. (dotimes (_ (1+ dist))
  9834. (while (member day-of-week org-agenda-weekend-days)
  9835. (cl-incf distance)
  9836. (cl-incf day-of-week)
  9837. (when (= day-of-week 7)
  9838. (setq day-of-week 0)))
  9839. (cl-incf day-of-week)
  9840. (when (= day-of-week 7)
  9841. (setq day-of-week 0)))))
  9842. ;; Silently fail when try to replan a sexp entry.
  9843. (ignore-errors
  9844. (let* ((date (calendar-gregorian-from-absolute
  9845. (+ (org-today) distance)))
  9846. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  9847. (nth 2 date))))
  9848. (org-agenda-schedule nil time))))))))
  9849. (?f
  9850. (setq cmd
  9851. (intern
  9852. (completing-read "Function: " obarray #'fboundp t nil nil))))
  9853. (action
  9854. (setq cmd
  9855. (pcase (assoc action org-agenda-bulk-custom-functions)
  9856. (`(,_ ,fn)
  9857. fn)
  9858. (`(,_ ,fn ,arg-fn)
  9859. (apply #'apply-partially fn (funcall arg-fn)))
  9860. (_
  9861. (user-error "Invalid bulk action: %c" action))))
  9862. (setq redo-at-end t)))
  9863. ;; Sort the markers, to make sure that parents are handled
  9864. ;; before children.
  9865. (setq entries (sort entries
  9866. (lambda (a b)
  9867. (cond
  9868. ((eq (marker-buffer a) (marker-buffer b))
  9869. (< (marker-position a) (marker-position b)))
  9870. (t
  9871. (string< (buffer-name (marker-buffer a))
  9872. (buffer-name (marker-buffer b))))))))
  9873. ;; Now loop over all markers and apply CMD.
  9874. (let ((processed 0)
  9875. (skipped 0))
  9876. (dolist (e entries)
  9877. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  9878. (if (not pos)
  9879. (progn (message "Skipping removed entry at %s" e)
  9880. (cl-incf skipped))
  9881. (goto-char pos)
  9882. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  9883. ;; `post-command-hook' is not run yet. We make sure any
  9884. ;; pending log note is processed.
  9885. (when (or (memq 'org-add-log-note (default-value 'post-command-hook))
  9886. (memq 'org-add-log-note post-command-hook))
  9887. (org-add-log-note))
  9888. (cl-incf processed))))
  9889. (when redo-at-end (org-agenda-redo))
  9890. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  9891. (message "Acted on %d entries%s%s"
  9892. processed
  9893. (if (= skipped 0)
  9894. ""
  9895. (format ", skipped %d (disappeared before their turn)"
  9896. skipped))
  9897. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  9898. (defun org-agenda-capture (&optional with-time)
  9899. "Call `org-capture' with the date at point.
  9900. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  9901. current HH:MM time."
  9902. (interactive "P")
  9903. (if (not (eq major-mode 'org-agenda-mode))
  9904. (user-error "You cannot do this outside of agenda buffers")
  9905. (let ((org-overriding-default-time
  9906. (org-get-cursor-date (equal with-time 1))))
  9907. (call-interactively 'org-capture))))
  9908. ;;; Dragging agenda lines forward/backward
  9909. (defun org-agenda-reapply-filters ()
  9910. "Re-apply all agenda filters."
  9911. (mapcar
  9912. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  9913. `((,org-agenda-tag-filter tag)
  9914. (,org-agenda-category-filter category)
  9915. (,org-agenda-regexp-filter regexp)
  9916. (,org-agenda-effort-filter effort)
  9917. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  9918. (,(get 'org-agenda-category-filter :preset-filter) category)
  9919. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  9920. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  9921. (defun org-agenda-drag-line-forward (arg &optional backward)
  9922. "Drag an agenda line forward by ARG lines.
  9923. When the optional argument `backward' is non-nil, move backward."
  9924. (interactive "p")
  9925. (let ((inhibit-read-only t) lst line)
  9926. (if (or (not (get-text-property (point) 'txt))
  9927. (save-excursion
  9928. (dotimes (_ arg)
  9929. (move-beginning-of-line (if backward 0 2))
  9930. (push (not (get-text-property (point) 'txt)) lst))
  9931. (delq nil lst)))
  9932. (message "Cannot move line forward")
  9933. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  9934. (move-beginning-of-line 1)
  9935. (setq line (buffer-substring (point) end))
  9936. (delete-region (point) end)
  9937. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  9938. (insert line)
  9939. (org-agenda-reapply-filters)
  9940. (org-agenda-mark-clocking-task)
  9941. (move-beginning-of-line 0)))))
  9942. (defun org-agenda-drag-line-backward (arg)
  9943. "Drag an agenda line backward by ARG lines."
  9944. (interactive "p")
  9945. (org-agenda-drag-line-forward arg t))
  9946. ;;; Flagging notes
  9947. (defun org-agenda-show-the-flagging-note ()
  9948. "Display the flagging note in the other window.
  9949. When called a second time in direct sequence, offer to remove the FLAGGING
  9950. tag and (if present) the flagging note."
  9951. (interactive)
  9952. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  9953. (win (selected-window))
  9954. note) ;; heading newhead
  9955. (unless hdmarker
  9956. (user-error "No linked entry at point"))
  9957. (if (and (eq this-command last-command)
  9958. (y-or-n-p "Unflag and remove any flagging note? "))
  9959. (progn
  9960. (org-agenda-remove-flag hdmarker)
  9961. (let ((win (get-buffer-window "*Flagging Note*")))
  9962. (and win (delete-window win)))
  9963. (message "Entry unflagged"))
  9964. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  9965. (unless note
  9966. (user-error "No flagging note"))
  9967. (org-kill-new note)
  9968. (org-switch-to-buffer-other-window "*Flagging Note*")
  9969. (erase-buffer)
  9970. (insert note)
  9971. (goto-char (point-min))
  9972. (while (re-search-forward "\\\\n" nil t)
  9973. (replace-match "\n" t t))
  9974. (goto-char (point-min))
  9975. (select-window win)
  9976. (message "%s" (substitute-command-keys "Flagging note pushed to \
  9977. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  9978. tag and note")))))
  9979. (defun org-agenda-remove-flag (marker)
  9980. "Remove the FLAGGED tag and any flagging note in the entry."
  9981. (let ((newhead
  9982. (org-with-point-at marker
  9983. (org-toggle-tag "FLAGGED" 'off)
  9984. (org-entry-delete nil "THEFLAGGINGNOTE")
  9985. (org-get-heading))))
  9986. (org-agenda-change-all-lines newhead marker)
  9987. (message "Entry unflagged")))
  9988. (defun org-agenda-get-any-marker (&optional pos)
  9989. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  9990. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  9991. ;;; Appointment reminders
  9992. (defvar appt-time-msg-list) ; defined in appt.el
  9993. ;;;###autoload
  9994. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  9995. "Activate appointments found in `org-agenda-files'.
  9996. With a `\\[universal-argument]' prefix, refresh the list of \
  9997. appointments.
  9998. If FILTER is t, interactively prompt the user for a regular
  9999. expression, and filter out entries that don't match it.
  10000. If FILTER is a string, use this string as a regular expression
  10001. for filtering entries out.
  10002. If FILTER is a function, filter out entries against which
  10003. calling the function returns nil. This function takes one
  10004. argument: an entry from `org-agenda-get-day-entries'.
  10005. FILTER can also be an alist with the car of each cell being
  10006. either `headline' or `category'. For example:
  10007. \\='((headline \"IMPORTANT\")
  10008. (category \"Work\"))
  10009. will only add headlines containing IMPORTANT or headlines
  10010. belonging to the \"Work\" category.
  10011. ARGS are symbols indicating what kind of entries to consider.
  10012. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  10013. \(i.e., deadlines and scheduled items with a hh:mm specification)
  10014. and :timestamp entries. See the docstring of `org-diary' for
  10015. details and examples.
  10016. If an entry has a APPT_WARNTIME property, its value will be used
  10017. to override `appt-message-warning-time'."
  10018. (interactive "P")
  10019. (when refresh (setq appt-time-msg-list nil))
  10020. (when (eq filter t)
  10021. (setq filter (read-from-minibuffer "Regexp filter: ")))
  10022. (let* ((cnt 0) ; count added events
  10023. (scope (or args '(:deadline* :scheduled* :timestamp)))
  10024. (org-agenda-new-buffers nil)
  10025. (org-deadline-warning-days 0)
  10026. ;; Do not use `org-today' here because appt only takes
  10027. ;; time and without date as argument, so it may pass wrong
  10028. ;; information otherwise
  10029. (today (org-date-to-gregorian
  10030. (time-to-days nil)))
  10031. (org-agenda-restrict nil)
  10032. (files (org-agenda-files 'unrestricted)) entries file
  10033. (org-agenda-buffer nil))
  10034. ;; Get all entries which may contain an appt
  10035. (org-agenda-prepare-buffers files)
  10036. (while (setq file (pop files))
  10037. (setq entries
  10038. (delq nil
  10039. (append entries
  10040. (apply #'org-agenda-get-day-entries
  10041. file today scope)))))
  10042. ;; Map through entries and find if we should filter them out
  10043. (mapc
  10044. (lambda (x)
  10045. (let* ((evt (org-trim
  10046. (replace-regexp-in-string
  10047. org-link-bracket-re "\\2"
  10048. (or (get-text-property 1 'txt x) ""))))
  10049. (cat (get-text-property (1- (length x)) 'org-category x))
  10050. (tod (get-text-property 1 'time-of-day x))
  10051. (ok (or (null filter)
  10052. (and (stringp filter) (string-match filter evt))
  10053. (and (functionp filter) (funcall filter x))
  10054. (and (listp filter)
  10055. (let ((cat-filter (cadr (assq 'category filter)))
  10056. (evt-filter (cadr (assq 'headline filter))))
  10057. (or (and (stringp cat-filter)
  10058. (string-match cat-filter cat))
  10059. (and (stringp evt-filter)
  10060. (string-match evt-filter evt)))))))
  10061. (wrn (get-text-property 1 'warntime x)))
  10062. ;; FIXME: Shall we remove text-properties for the appt text?
  10063. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  10064. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  10065. (setq tod (concat "00" (number-to-string tod)))
  10066. (setq tod (when (string-match
  10067. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  10068. (concat (match-string 1 tod) ":"
  10069. (match-string 2 tod))))
  10070. (when (appt-add tod evt wrn)
  10071. (setq cnt (1+ cnt))))))
  10072. entries)
  10073. (org-release-buffers org-agenda-new-buffers)
  10074. (if (eq cnt 0)
  10075. (message "No event to add")
  10076. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  10077. (defun org-agenda-today-p (date)
  10078. "Non-nil when DATE means today.
  10079. DATE is either a list of the form (month day year) or a number of
  10080. days as returned by `calendar-absolute-from-gregorian' or
  10081. `org-today'. This function considers `org-extend-today-until'
  10082. when defining today."
  10083. (eq (org-today)
  10084. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  10085. (defun org-agenda-todo-yesterday (&optional arg)
  10086. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  10087. (interactive "P")
  10088. (let* ((org-use-effective-time t)
  10089. (hour (nth 2 (decode-time (org-current-time))))
  10090. (org-extend-today-until (1+ hour)))
  10091. (org-agenda-todo arg)))
  10092. (defun org-agenda-ctrl-c-ctrl-c ()
  10093. "Set tags in agenda buffer."
  10094. (interactive)
  10095. (org-agenda-set-tags))
  10096. (provide 'org-agenda)
  10097. ;;; org-agenda.el ends here