org-agenda.el 413 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2020 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. "Alist of variable/value pairs that should be active during agenda export.
  134. This is a good place to set options for ps-print and for htmlize.
  135. Note that the way this is implemented, the values will be evaluated
  136. before assigned to the variables. So make sure to quote values you do
  137. *not* want evaluated, for example
  138. (setq org-agenda-exporter-settings
  139. \\='((ps-print-color-p \\='black-white)))"
  140. :group 'org-agenda-export
  141. :type '(repeat
  142. (list
  143. (variable)
  144. (sexp :tag "Value"))))
  145. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  146. "Hook run in a temporary buffer before writing the agenda to an export file.
  147. A useful function for this hook is `org-agenda-add-entry-text'."
  148. :group 'org-agenda-export
  149. :type 'hook
  150. :options '(org-agenda-add-entry-text))
  151. (defcustom org-agenda-add-entry-text-maxlines 0
  152. "Maximum number of entry text lines to be added to agenda.
  153. This is only relevant when `org-agenda-add-entry-text' is part of
  154. `org-agenda-before-write-hook', which is the default.
  155. When this is 0, nothing will happen. When it is greater than 0, it
  156. specifies the maximum number of lines that will be added for each entry
  157. that is listed in the agenda view.
  158. Note that this variable is not used during display, only when exporting
  159. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  160. and `org-agenda-entry-text-maxlines'."
  161. :group 'org-agenda
  162. :type 'integer)
  163. (defcustom org-agenda-add-entry-text-descriptive-links t
  164. "Non-nil means export org-links as descriptive links in agenda added text.
  165. This variable applies to the text added to the agenda when
  166. `org-agenda-add-entry-text-maxlines' is larger than 0.
  167. When this variable is nil, the URL will (also) be shown."
  168. :group 'org-agenda
  169. :type 'boolean)
  170. (defcustom org-agenda-export-html-style nil
  171. "The style specification for exported HTML Agenda files.
  172. If this variable contains a string, it will replace the default <style>
  173. section as produced by `htmlize'.
  174. Since there are different ways of setting style information, this variable
  175. needs to contain the full HTML structure to provide a style, including the
  176. surrounding HTML tags. The style specifications should include definitions
  177. the fonts used by the agenda, here is an example:
  178. <style type=\"text/css\">
  179. p { font-weight: normal; color: gray; }
  180. .org-agenda-structure {
  181. font-size: 110%;
  182. color: #003399;
  183. font-weight: 600;
  184. }
  185. .org-todo {
  186. color: #cc6666;
  187. font-weight: bold;
  188. }
  189. .org-agenda-done {
  190. color: #339933;
  191. }
  192. .org-done {
  193. color: #339933;
  194. }
  195. .title { text-align: center; }
  196. .todo, .deadline { color: red; }
  197. .done { color: green; }
  198. </style>
  199. or, if you want to keep the style in a file,
  200. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  201. As the value of this option simply gets inserted into the HTML <head> header,
  202. you can \"misuse\" it to also add other text to the header."
  203. :group 'org-agenda-export
  204. :group 'org-export-html
  205. :type '(choice
  206. (const nil)
  207. (string)))
  208. (defcustom org-agenda-persistent-filter nil
  209. "When set, keep filters from one agenda view to the next."
  210. :group 'org-agenda
  211. :type 'boolean)
  212. (defgroup org-agenda-custom-commands nil
  213. "Options concerning agenda views in Org mode."
  214. :tag "Org Agenda Custom Commands"
  215. :group 'org-agenda)
  216. (defconst org-sorting-choice
  217. '(choice
  218. (const time-up) (const time-down)
  219. (const timestamp-up) (const timestamp-down)
  220. (const scheduled-up) (const scheduled-down)
  221. (const deadline-up) (const deadline-down)
  222. (const ts-up) (const ts-down)
  223. (const tsia-up) (const tsia-down)
  224. (const category-keep) (const category-up) (const category-down)
  225. (const tag-down) (const tag-up)
  226. (const priority-up) (const priority-down)
  227. (const todo-state-up) (const todo-state-down)
  228. (const effort-up) (const effort-down)
  229. (const habit-up) (const habit-down)
  230. (const alpha-up) (const alpha-down)
  231. (const user-defined-up) (const user-defined-down))
  232. "Sorting choices.")
  233. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  234. ;; the new variable `org-agenda-tag-filter-preset'.
  235. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  236. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  237. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  238. "List of types searched for when creating the daily/weekly agenda.
  239. This variable is a list of symbols that controls the types of
  240. items that appear in the daily/weekly agenda. Allowed symbols in this
  241. list are
  242. :timestamp List items containing a date stamp or date range matching
  243. the selected date. This includes sexp entries in angular
  244. brackets.
  245. :sexp List entries resulting from plain diary-like sexps.
  246. :deadline List deadline due on that date. When the date is today,
  247. also list any deadlines past due, or due within
  248. `org-deadline-warning-days'.
  249. :deadline* Same as above, but only include the deadline if it has an
  250. hour specification as [h]h:mm.
  251. :scheduled List all items which are scheduled for the given date.
  252. The diary for *today* also contains items which were
  253. scheduled earlier and are not yet marked DONE.
  254. :scheduled* Same as above, but only include the scheduled item if it
  255. has an hour specification as [h]h:mm.
  256. By default, all four non-starred types are turned on.
  257. When :scheduled* or :deadline* are included, :schedule or :deadline
  258. will be ignored.
  259. Never set this variable globally using `setq', because then it
  260. will apply to all future agenda commands. Instead, bind it with
  261. `let' to scope it dynamically into the agenda-constructing
  262. command. A good way to set it is through options in
  263. `org-agenda-custom-commands'. For a more flexible (though
  264. somewhat less efficient) way of determining what is included in
  265. the daily/weekly agenda, see `org-agenda-skip-function'.")
  266. (defconst org-agenda-custom-commands-local-options
  267. `(repeat :tag "Local settings for this command. Remember to quote values"
  268. (choice :tag "Setting"
  269. (list :tag "Heading for this block"
  270. (const org-agenda-overriding-header)
  271. (string :tag "Headline"))
  272. (list :tag "Files to be searched"
  273. (const org-agenda-files)
  274. (list
  275. (const :format "" quote)
  276. (repeat (file))))
  277. (list :tag "Sorting strategy"
  278. (const org-agenda-sorting-strategy)
  279. (list
  280. (const :format "" quote)
  281. (repeat
  282. ,org-sorting-choice)))
  283. (list :tag "Prefix format"
  284. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  285. (string))
  286. (list :tag "Number of days in agenda"
  287. (const org-agenda-span)
  288. (list
  289. (const :format "" quote)
  290. (choice (const :tag "Day" day)
  291. (const :tag "Week" week)
  292. (const :tag "Fortnight" fortnight)
  293. (const :tag "Month" month)
  294. (const :tag "Year" year)
  295. (integer :tag "Custom"))))
  296. (list :tag "Fixed starting date"
  297. (const org-agenda-start-day)
  298. (string :value "2007-11-01"))
  299. (list :tag "Start on day of week"
  300. (const org-agenda-start-on-weekday)
  301. (choice :value 1
  302. (const :tag "Today" nil)
  303. (integer :tag "Weekday No.")))
  304. (list :tag "Include data from diary"
  305. (const org-agenda-include-diary)
  306. (boolean))
  307. (list :tag "Deadline Warning days"
  308. (const org-deadline-warning-days)
  309. (integer :value 1))
  310. (list :tag "Category filter preset"
  311. (const org-agenda-category-filter-preset)
  312. (list
  313. (const :format "" quote)
  314. (repeat
  315. (string :tag "+category or -category"))))
  316. (list :tag "Tags filter preset"
  317. (const org-agenda-tag-filter-preset)
  318. (list
  319. (const :format "" quote)
  320. (repeat
  321. (string :tag "+tag or -tag"))))
  322. (list :tag "Effort filter preset"
  323. (const org-agenda-effort-filter-preset)
  324. (list
  325. (const :format "" quote)
  326. (repeat
  327. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  328. (list :tag "Regexp filter preset"
  329. (const org-agenda-regexp-filter-preset)
  330. (list
  331. (const :format "" quote)
  332. (repeat
  333. (string :tag "+regexp or -regexp"))))
  334. (list :tag "Set daily/weekly entry types"
  335. (const org-agenda-entry-types)
  336. (list
  337. (const :format "" quote)
  338. (set :greedy t :value ,org-agenda-entry-types
  339. (const :deadline)
  340. (const :scheduled)
  341. (const :deadline*)
  342. (const :scheduled*)
  343. (const :timestamp)
  344. (const :sexp))))
  345. (list :tag "Columns format"
  346. (const org-overriding-columns-format)
  347. (string :tag "Format"))
  348. (list :tag "Standard skipping condition"
  349. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  350. (const org-agenda-skip-function)
  351. (list
  352. (const :format "" quote)
  353. (list
  354. (choice
  355. :tag "Skipping range"
  356. (const :tag "Skip entry" org-agenda-skip-entry-if)
  357. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  358. (repeat :inline t :tag "Conditions for skipping"
  359. (choice
  360. :tag "Condition type"
  361. (list :tag "Regexp matches" :inline t
  362. (const :format "" regexp)
  363. (regexp))
  364. (list :tag "Regexp does not match" :inline t
  365. (const :format "" notregexp)
  366. (regexp))
  367. (list :tag "TODO state is" :inline t
  368. (const todo)
  369. (choice
  370. (const :tag "Any not-done state" todo)
  371. (const :tag "Any done state" done)
  372. (const :tag "Any state" any)
  373. (list :tag "Keyword list"
  374. (const :format "" quote)
  375. (repeat (string :tag "Keyword")))))
  376. (list :tag "TODO state is not" :inline t
  377. (const nottodo)
  378. (choice
  379. (const :tag "Any not-done state" todo)
  380. (const :tag "Any done state" done)
  381. (const :tag "Any state" any)
  382. (list :tag "Keyword list"
  383. (const :format "" quote)
  384. (repeat (string :tag "Keyword")))))
  385. (const :tag "scheduled" scheduled)
  386. (const :tag "not scheduled" notscheduled)
  387. (const :tag "deadline" deadline)
  388. (const :tag "no deadline" notdeadline)
  389. (const :tag "timestamp" timestamp)
  390. (const :tag "no timestamp" nottimestamp))))))
  391. (list :tag "Non-standard skipping condition"
  392. :value (org-agenda-skip-function)
  393. (const org-agenda-skip-function)
  394. (sexp :tag "Function or form (quoted!)"))
  395. (list :tag "Any variable"
  396. (variable :tag "Variable")
  397. (sexp :tag "Value (sexp)"))))
  398. "Selection of examples for agenda command settings.
  399. This will be spliced into the custom type of
  400. `org-agenda-custom-commands'.")
  401. (defcustom org-agenda-custom-commands
  402. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  403. "Custom commands for the agenda.
  404. \\<org-mode-map>
  405. These commands will be offered on the splash screen displayed by the
  406. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  407. (key desc type match settings files)
  408. key The key (one or more characters as a string) to be associated
  409. with the command.
  410. desc A description of the command, when omitted or nil, a default
  411. description is built using MATCH.
  412. type The command type, any of the following symbols:
  413. agenda The daily/weekly agenda.
  414. todo Entries with a specific TODO keyword, in all agenda files.
  415. search Entries containing search words entry or headline.
  416. tags Tags/Property/TODO match in all agenda files.
  417. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  418. todo-tree Sparse tree of specific TODO keyword in *current* file.
  419. tags-tree Sparse tree with all tags matches in *current* file.
  420. occur-tree Occur sparse tree for *current* file.
  421. ... A user-defined function.
  422. match What to search for:
  423. - a single keyword for TODO keyword searches
  424. - a tags/property/todo match expression for searches
  425. - a word search expression for text searches.
  426. - a regular expression for occur searches
  427. For all other commands, this should be the empty string.
  428. settings A list of option settings, similar to that in a let form, so like
  429. this: ((opt1 val1) (opt2 val2) ...). The values will be
  430. evaluated at the moment of execution, so quote them when needed.
  431. files A list of files to write the produced agenda buffer to with
  432. the command `org-store-agenda-views'.
  433. If a file name ends in \".html\", an HTML version of the buffer
  434. is written out. If it ends in \".ps\", a postscript version is
  435. produced. Otherwise, only the plain text is written to the file.
  436. You can also define a set of commands, to create a composite agenda buffer.
  437. In this case, an entry looks like this:
  438. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  439. where
  440. desc A description string to be displayed in the dispatcher menu.
  441. cmd An agenda command, similar to the above. However, tree commands
  442. are not allowed, but instead you can get agenda and global todo list.
  443. So valid commands for a set are:
  444. (agenda \"\" settings)
  445. (alltodo \"\" settings)
  446. (stuck \"\" settings)
  447. (todo \"match\" settings files)
  448. (search \"match\" settings files)
  449. (tags \"match\" settings files)
  450. (tags-todo \"match\" settings files)
  451. Each command can carry a list of options, and another set of options can be
  452. given for the whole set of commands. Individual command options take
  453. precedence over the general options.
  454. When using several characters as key to a command, the first characters
  455. are prefix commands. For the dispatcher to display useful information, you
  456. should provide a description for the prefix, like
  457. (setq org-agenda-custom-commands
  458. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  459. (\"hl\" tags \"+HOME+Lisa\")
  460. (\"hp\" tags \"+HOME+Peter\")
  461. (\"hk\" tags \"+HOME+Kim\")))"
  462. :group 'org-agenda-custom-commands
  463. :type `(repeat
  464. (choice :value ("x" "Describe command here" tags "" nil)
  465. (list :tag "Single command"
  466. (string :tag "Access Key(s) ")
  467. (option (string :tag "Description"))
  468. (choice
  469. (const :tag "Agenda" agenda)
  470. (const :tag "TODO list" alltodo)
  471. (const :tag "Search words" search)
  472. (const :tag "Stuck projects" stuck)
  473. (const :tag "Tags/Property match (all agenda files)" tags)
  474. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  475. (const :tag "TODO keyword search (all agenda files)" todo)
  476. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  477. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  478. (const :tag "Occur tree (current buffer)" occur-tree)
  479. (sexp :tag "Other, user-defined function"))
  480. (string :tag "Match (only for some commands)")
  481. ,org-agenda-custom-commands-local-options
  482. (option (repeat :tag "Export" (file :tag "Export to"))))
  483. (list :tag "Command series, all agenda files"
  484. (string :tag "Access Key(s)")
  485. (string :tag "Description ")
  486. (repeat :tag "Component"
  487. (choice
  488. (list :tag "Agenda"
  489. (const :format "" agenda)
  490. (const :tag "" :format "" "")
  491. ,org-agenda-custom-commands-local-options)
  492. (list :tag "TODO list (all keywords)"
  493. (const :format "" alltodo)
  494. (const :tag "" :format "" "")
  495. ,org-agenda-custom-commands-local-options)
  496. (list :tag "Search words"
  497. (const :format "" search)
  498. (string :tag "Match")
  499. ,org-agenda-custom-commands-local-options)
  500. (list :tag "Stuck projects"
  501. (const :format "" stuck)
  502. (const :tag "" :format "" "")
  503. ,org-agenda-custom-commands-local-options)
  504. (list :tag "Tags/Property match (all agenda files)"
  505. (const :format "" tags)
  506. (string :tag "Match")
  507. ,org-agenda-custom-commands-local-options)
  508. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  509. (const :format "" tags-todo)
  510. (string :tag "Match")
  511. ,org-agenda-custom-commands-local-options)
  512. (list :tag "TODO keyword search"
  513. (const :format "" todo)
  514. (string :tag "Match")
  515. ,org-agenda-custom-commands-local-options)
  516. (list :tag "Other, user-defined function"
  517. (symbol :tag "function")
  518. (string :tag "Match")
  519. ,org-agenda-custom-commands-local-options)))
  520. (repeat :tag "Settings for entire command set"
  521. (list (variable :tag "Any variable")
  522. (sexp :tag "Value")))
  523. (option (repeat :tag "Export" (file :tag "Export to"))))
  524. (cons :tag "Prefix key documentation"
  525. (string :tag "Access Key(s)")
  526. (string :tag "Description ")))))
  527. (defcustom org-agenda-query-register ?o
  528. "The register holding the current query string.
  529. The purpose of this is that if you construct a query string interactively,
  530. you can then use it to define a custom command."
  531. :group 'org-agenda-custom-commands
  532. :type 'character)
  533. (defcustom org-stuck-projects
  534. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  535. "How to identify stuck projects.
  536. This is a list of four items:
  537. 1. A tags/todo/property matcher string that is used to identify a project.
  538. See the manual for a description of tag and property searches.
  539. The entire tree below a headline matched by this is considered one project.
  540. 2. A list of TODO keywords identifying non-stuck projects.
  541. If the project subtree contains any headline with one of these todo
  542. keywords, the project is considered to be not stuck. If you specify
  543. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  544. 3. A list of tags identifying non-stuck projects.
  545. If the project subtree contains any headline with one of these tags,
  546. the project is considered to be not stuck. If you specify \"*\" as
  547. a tag, any tag will mark the project unstuck. Note that this is about
  548. the explicit presence of a tag somewhere in the subtree, inherited
  549. tags do not count here. If inherited tags make a project not stuck,
  550. use \"-TAG\" in the tags part of the matcher under (1.) above.
  551. 4. An arbitrary regular expression matching non-stuck projects.
  552. If the project turns out to be not stuck, search continues also in the
  553. subtree to see if any of the subtasks have project status.
  554. See also the variable `org-tags-match-list-sublevels' which applies
  555. to projects matched by this search as well.
  556. After defining this variable, you may use `org-agenda-list-stuck-projects'
  557. \(bound to `\\[org-agenda] #') to produce the list."
  558. :group 'org-agenda-custom-commands
  559. :type '(list
  560. (string :tag "Tags/TODO match to identify a project")
  561. (repeat :tag "Projects are *not* stuck if they have an entry with \
  562. TODO keyword any of" (string))
  563. (repeat :tag "Projects are *not* stuck if they have an entry with \
  564. TAG being any of" (string))
  565. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  566. the subtree")))
  567. (defgroup org-agenda-skip nil
  568. "Options concerning skipping parts of agenda files."
  569. :tag "Org Agenda Skip"
  570. :group 'org-agenda)
  571. (defcustom org-agenda-skip-function-global nil
  572. "Function to be called at each match during agenda construction.
  573. If this function returns nil, the current match should not be skipped.
  574. If the function decided to skip an agenda match, is must return the
  575. buffer position from which the search should be continued.
  576. This may also be a Lisp form, which will be evaluated.
  577. This variable will be applied to every agenda match, including
  578. tags/property searches and TODO lists. So try to make the test function
  579. do its checking as efficiently as possible. To implement a skipping
  580. condition just for specific agenda commands, use the variable
  581. `org-agenda-skip-function' which can be set in the options section
  582. of custom agenda commands."
  583. :group 'org-agenda-skip
  584. :type 'sexp)
  585. (defgroup org-agenda-daily/weekly nil
  586. "Options concerning the daily/weekly agenda."
  587. :tag "Org Agenda Daily/Weekly"
  588. :group 'org-agenda)
  589. (defgroup org-agenda-todo-list nil
  590. "Options concerning the global todo list agenda view."
  591. :tag "Org Agenda Todo List"
  592. :group 'org-agenda)
  593. (defgroup org-agenda-match-view nil
  594. "Options concerning the general tags/property/todo match agenda view."
  595. :tag "Org Agenda Match View"
  596. :group 'org-agenda)
  597. (defgroup org-agenda-search-view nil
  598. "Options concerning the search agenda view."
  599. :tag "Org Agenda Search View"
  600. :group 'org-agenda)
  601. (defvar org-agenda-archives-mode nil
  602. "Non-nil means the agenda will include archived items.
  603. If this is the symbol `trees', trees in the selected agenda scope
  604. that are marked with the ARCHIVE tag will be included anyway. When this is
  605. t, also all archive files associated with the current selection of agenda
  606. files will be included.")
  607. (defcustom org-agenda-restriction-lock-highlight-subtree t
  608. "Non-nil means highlight the whole subtree when restriction is active.
  609. Otherwise only highlight the headline. Highlighting the whole subtree is
  610. useful to ensure no edits happen beyond the restricted region."
  611. :group 'org-agenda
  612. :type 'boolean)
  613. (defcustom org-agenda-skip-comment-trees t
  614. "Non-nil means skip trees that start with the COMMENT keyword.
  615. When nil, these trees are also scanned by agenda commands."
  616. :group 'org-agenda-skip
  617. :type 'boolean)
  618. (defcustom org-agenda-todo-list-sublevels t
  619. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  620. When nil, the sublevels of a TODO entry are not checked, resulting in
  621. potentially much shorter TODO lists."
  622. :group 'org-agenda-skip
  623. :group 'org-agenda-todo-list
  624. :type 'boolean)
  625. (defcustom org-agenda-todo-ignore-with-date nil
  626. "Non-nil means don't show entries with a date in the global todo list.
  627. You can use this if you prefer to mark mere appointments with a TODO keyword,
  628. but don't want them to show up in the TODO list.
  629. When this is set, it also covers deadlines and scheduled items, the settings
  630. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  631. will be ignored.
  632. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  633. :group 'org-agenda-skip
  634. :group 'org-agenda-todo-list
  635. :type 'boolean)
  636. (defcustom org-agenda-todo-ignore-timestamp nil
  637. "Non-nil means don't show entries with a timestamp.
  638. This applies when creating the global todo list.
  639. Valid values are:
  640. past Don't show entries for today or in the past.
  641. future Don't show entries with a timestamp in the future.
  642. The idea behind this is that if it has a future
  643. timestamp, you don't want to think about it until the
  644. date.
  645. all Don't show any entries with a timestamp in the global todo list.
  646. The idea behind this is that by setting a timestamp, you
  647. have already \"taken care\" of this item.
  648. This variable can also have an integer as a value. If positive (N),
  649. todos with a timestamp N or more days in the future will be ignored. If
  650. negative (-N), todos with a timestamp N or more days in the past will be
  651. ignored. If 0, todos with a timestamp either today or in the future will
  652. be ignored. For example, a value of -1 will exclude todos with a
  653. timestamp in the past (yesterday or earlier), while a value of 7 will
  654. exclude todos with a timestamp a week or more in the future.
  655. See also `org-agenda-todo-ignore-with-date'.
  656. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  657. to make his option also apply to the tags-todo list."
  658. :group 'org-agenda-skip
  659. :group 'org-agenda-todo-list
  660. :version "24.1"
  661. :type '(choice
  662. (const :tag "Ignore future timestamp todos" future)
  663. (const :tag "Ignore past or present timestamp todos" past)
  664. (const :tag "Ignore all timestamp todos" all)
  665. (const :tag "Show timestamp todos" nil)
  666. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  667. (defcustom org-agenda-todo-ignore-scheduled nil
  668. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  669. This applies when creating the global todo list.
  670. Valid values are:
  671. past Don't show entries scheduled today or in the past.
  672. future Don't show entries scheduled in the future.
  673. The idea behind this is that by scheduling it, you don't want to
  674. think about it until the scheduled date.
  675. all Don't show any scheduled entries in the global todo list.
  676. The idea behind this is that by scheduling it, you have already
  677. \"taken care\" of this item.
  678. t Same as `all', for backward compatibility.
  679. This variable can also have an integer as a value. See
  680. `org-agenda-todo-ignore-timestamp' for more details.
  681. See also `org-agenda-todo-ignore-with-date'.
  682. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  683. to make his option also apply to the tags-todo list."
  684. :group 'org-agenda-skip
  685. :group 'org-agenda-todo-list
  686. :type '(choice
  687. (const :tag "Ignore future-scheduled todos" future)
  688. (const :tag "Ignore past- or present-scheduled todos" past)
  689. (const :tag "Ignore all scheduled todos" all)
  690. (const :tag "Ignore all scheduled todos (compatibility)" t)
  691. (const :tag "Show scheduled todos" nil)
  692. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  693. (defcustom org-agenda-todo-ignore-deadlines nil
  694. "Non-nil means ignore some deadline TODO items when making TODO list.
  695. There are different motivations for using different values, please think
  696. carefully when configuring this variable.
  697. This applies when creating the global TODO list.
  698. Valid values are:
  699. near Don't show near deadline entries. A deadline is near when it is
  700. closer than `org-deadline-warning-days' days. The idea behind this
  701. is that such items will appear in the agenda anyway.
  702. far Don't show TODO entries where a deadline has been defined, but
  703. is not going to happen anytime soon. This is useful if you want to use
  704. the TODO list to figure out what to do now.
  705. past Don't show entries with a deadline timestamp for today or in the past.
  706. future Don't show entries with a deadline timestamp in the future, not even
  707. when they become `near' ones. Use it with caution.
  708. all Ignore all TODO entries that do have a deadline.
  709. t Same as `near', for backward compatibility.
  710. This variable can also have an integer as a value. See
  711. `org-agenda-todo-ignore-timestamp' for more details.
  712. See also `org-agenda-todo-ignore-with-date'.
  713. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  714. to make his option also apply to the tags-todo list."
  715. :group 'org-agenda-skip
  716. :group 'org-agenda-todo-list
  717. :type '(choice
  718. (const :tag "Ignore near deadlines" near)
  719. (const :tag "Ignore near deadlines (compatibility)" t)
  720. (const :tag "Ignore far deadlines" far)
  721. (const :tag "Ignore all TODOs with a deadlines" all)
  722. (const :tag "Show all TODOs, even if they have a deadline" nil)
  723. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  724. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  725. "Time unit to use when possibly ignoring an agenda item.
  726. See the docstring of various `org-agenda-todo-ignore-*' options.
  727. The default is to compare time stamps using days. An item is thus
  728. considered to be in the future if it is at least one day after today.
  729. Non-nil means to compare time stamps using seconds. An item is then
  730. considered future if it has a time value later than current time."
  731. :group 'org-agenda-skip
  732. :group 'org-agenda-todo-list
  733. :version "24.4"
  734. :package-version '(Org . "8.0")
  735. :type '(choice
  736. (const :tag "Compare time with days" nil)
  737. (const :tag "Compare time with seconds" t)))
  738. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  739. "Non-nil means honor todo-list ignores options also in tags-todo search.
  740. The variables
  741. `org-agenda-todo-ignore-with-date',
  742. `org-agenda-todo-ignore-timestamp',
  743. `org-agenda-todo-ignore-scheduled',
  744. `org-agenda-todo-ignore-deadlines'
  745. make the global TODO list skip entries that have time stamps of certain
  746. kinds. If this option is set, the same options will also apply for the
  747. tags-todo search, which is the general tags/property matcher
  748. restricted to unfinished TODO entries only."
  749. :group 'org-agenda-skip
  750. :group 'org-agenda-todo-list
  751. :group 'org-agenda-match-view
  752. :type 'boolean)
  753. (defcustom org-agenda-skip-scheduled-if-done nil
  754. "Non-nil means don't show scheduled items in agenda when they are done.
  755. This is relevant for the daily/weekly agenda, not for the TODO list. It
  756. applies only to the actual date of the scheduling. Warnings about an item
  757. with a past scheduling dates are always turned off when the item is DONE."
  758. :group 'org-agenda-skip
  759. :group 'org-agenda-daily/weekly
  760. :type 'boolean)
  761. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  762. "Non-nil means skip scheduling line if same entry shows because of deadline.
  763. In the agenda of today, an entry can show up multiple times
  764. because it is both scheduled and has a nearby deadline, and maybe
  765. a plain time stamp as well.
  766. When this variable is nil, the entry will be shown several times.
  767. When set to t, then only the deadline is shown and the fact that
  768. the entry is scheduled today or was scheduled previously is not
  769. shown.
  770. When set to the symbol `not-today', skip scheduled previously,
  771. but not scheduled today.
  772. When set to the symbol `repeated-after-deadline', skip scheduled
  773. items if they are repeated beyond the current deadline."
  774. :group 'org-agenda-skip
  775. :group 'org-agenda-daily/weekly
  776. :type '(choice
  777. (const :tag "Never" nil)
  778. (const :tag "Always" t)
  779. (const :tag "Not when scheduled today" not-today)
  780. (const :tag "When repeated past deadline" repeated-after-deadline)))
  781. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  782. "Non-nil means skip timestamp line if same entry shows because of deadline.
  783. In the agenda of today, an entry can show up multiple times
  784. because it has both a plain timestamp and has a nearby deadline.
  785. When this variable is t, then only the deadline is shown and the
  786. fact that the entry has a timestamp for or including today is not
  787. shown. When this variable is nil, the entry will be shown
  788. several times."
  789. :group 'org-agenda-skip
  790. :group 'org-agenda-daily/weekly
  791. :version "24.1"
  792. :type '(choice
  793. (const :tag "Never" nil)
  794. (const :tag "Always" t)))
  795. (defcustom org-agenda-skip-deadline-if-done nil
  796. "Non-nil means don't show deadlines when the corresponding item is done.
  797. When nil, the deadline is still shown and should give you a happy feeling.
  798. This is relevant for the daily/weekly agenda. It applies only to the
  799. actual date of the deadline. Warnings about approaching and past-due
  800. deadlines are always turned off when the item is DONE."
  801. :group 'org-agenda-skip
  802. :group 'org-agenda-daily/weekly
  803. :type 'boolean)
  804. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  805. "Non-nil means skip deadline prewarning when entry is also scheduled.
  806. This will apply on all days where a prewarning for the deadline would
  807. be shown, but not at the day when the entry is actually due. On that day,
  808. the deadline will be shown anyway.
  809. This variable may be set to nil, t, the symbol `pre-scheduled',
  810. or a number which will then give the number of days before the actual
  811. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  812. eliminates the deadline prewarning only prior to the scheduled date.
  813. This can be used in a workflow where the first showing of the deadline will
  814. trigger you to schedule it, and then you don't want to be reminded of it
  815. because you will take care of it on the day when scheduled."
  816. :group 'org-agenda-skip
  817. :group 'org-agenda-daily/weekly
  818. :version "24.1"
  819. :type '(choice
  820. (const :tag "Always show prewarning" nil)
  821. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  822. (const :tag "Remove prewarning if entry is scheduled" t)
  823. (integer :tag "Restart prewarning N days before deadline")))
  824. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  825. "Non-nil means skip scheduled delay when entry also has a deadline.
  826. This variable may be set to nil, t, the symbol `post-deadline',
  827. or a number which will then give the number of days after the actual
  828. scheduled date when the delay should expire. The symbol `post-deadline'
  829. eliminates the schedule delay when the date is posterior to the deadline."
  830. :group 'org-agenda-skip
  831. :group 'org-agenda-daily/weekly
  832. :version "24.4"
  833. :package-version '(Org . "8.0")
  834. :type '(choice
  835. (const :tag "Always honor delay" nil)
  836. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  837. (const :tag "Ignore delay if entry has a deadline" t)
  838. (integer :tag "Honor delay up until N days after the scheduled date")))
  839. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  840. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  841. When non-nil, after the search for timestamps has matched once in an
  842. entry, the rest of the entry will not be searched."
  843. :group 'org-agenda-skip
  844. :type 'boolean)
  845. (defcustom org-agenda-skip-timestamp-if-done nil
  846. "Non-nil means don't select item by timestamp or -range if it is DONE."
  847. :group 'org-agenda-skip
  848. :group 'org-agenda-daily/weekly
  849. :type 'boolean)
  850. (defcustom org-agenda-dim-blocked-tasks t
  851. "Non-nil means dim blocked tasks in the agenda display.
  852. This causes some overhead during agenda construction, but if you
  853. have turned on `org-enforce-todo-dependencies',
  854. `org-enforce-todo-checkbox-dependencies', or any other blocking
  855. mechanism, this will create useful feedback in the agenda.
  856. Instead of t, this variable can also have the value `invisible'.
  857. Then blocked tasks will be invisible and only become visible when
  858. they become unblocked. An exemption to this behavior is when a task is
  859. blocked because of unchecked checkboxes below it. Since checkboxes do
  860. not show up in the agenda views, making this task invisible you remove any
  861. trace from agenda views that there is something to do. Therefore, a task
  862. that is blocked because of checkboxes will never be made invisible, it
  863. will only be dimmed."
  864. :group 'org-agenda-daily/weekly
  865. :group 'org-agenda-todo-list
  866. :version "24.3"
  867. :type '(choice
  868. (const :tag "Do not dim" nil)
  869. (const :tag "Dim to a gray face" t)
  870. (const :tag "Make invisible" invisible)))
  871. (defgroup org-agenda-startup nil
  872. "Options concerning initial settings in the Agenda in Org Mode."
  873. :tag "Org Agenda Startup"
  874. :group 'org-agenda)
  875. (defcustom org-agenda-menu-show-matcher t
  876. "Non-nil means show the match string in the agenda dispatcher menu.
  877. When nil, the matcher string is not shown, but is put into the help-echo
  878. property so than moving the mouse over the command shows it.
  879. Setting it to nil is good if matcher strings are very long and/or if
  880. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  881. :group 'org-agenda
  882. :version "24.1"
  883. :type 'boolean)
  884. (defcustom org-agenda-menu-two-columns nil
  885. "Non-nil means, use two columns to show custom commands in the dispatcher.
  886. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  887. to nil."
  888. :group 'org-agenda
  889. :version "24.1"
  890. :type 'boolean)
  891. (defcustom org-agenda-finalize-hook nil
  892. "Hook run just before displaying an agenda buffer.
  893. The buffer is still writable when the hook is called.
  894. You can modify some of the buffer substrings but you should be
  895. extra careful not to modify the text properties of the agenda
  896. headlines as the agenda display heavily relies on them."
  897. :group 'org-agenda-startup
  898. :type 'hook)
  899. (defcustom org-agenda-filter-hook nil
  900. "Hook run just after filtering with `org-agenda-filter'."
  901. :group 'org-agenda-startup
  902. :package-version '(Org . "9.4")
  903. :type 'hook)
  904. (defcustom org-agenda-mouse-1-follows-link nil
  905. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  906. A longer mouse click will still set point. Needs to be set
  907. before org.el is loaded."
  908. :group 'org-agenda-startup
  909. :type 'boolean)
  910. (defcustom org-agenda-start-with-follow-mode nil
  911. "The initial value of follow mode in a newly created agenda window."
  912. :group 'org-agenda-startup
  913. :type 'boolean)
  914. (defcustom org-agenda-follow-indirect nil
  915. "Non-nil means `org-agenda-follow-mode' displays only the
  916. current item's tree, in an indirect buffer."
  917. :group 'org-agenda
  918. :version "24.1"
  919. :type 'boolean)
  920. (defcustom org-agenda-show-outline-path t
  921. "Non-nil means show outline path in echo area after line motion."
  922. :group 'org-agenda-startup
  923. :type 'boolean)
  924. (defcustom org-agenda-start-with-entry-text-mode nil
  925. "The initial value of entry-text-mode in a newly created agenda window."
  926. :group 'org-agenda-startup
  927. :type 'boolean)
  928. (defcustom org-agenda-entry-text-maxlines 5
  929. "Number of text lines to be added when `E' is pressed in the agenda.
  930. Note that this variable only used during agenda display. To add entry text
  931. when exporting the agenda, configure the variable
  932. `org-agenda-add-entry-text-maxlines'."
  933. :group 'org-agenda
  934. :type 'integer)
  935. (defcustom org-agenda-entry-text-exclude-regexps nil
  936. "List of regular expressions to clean up entry text.
  937. The complete matches of all regular expressions in this list will be
  938. removed from entry text before it is shown in the agenda."
  939. :group 'org-agenda
  940. :type '(repeat (regexp)))
  941. (defcustom org-agenda-entry-text-leaders " > "
  942. "Text prepended to the entry text in agenda buffers."
  943. :version "24.4"
  944. :package-version '(Org . "8.0")
  945. :group 'org-agenda
  946. :type 'string)
  947. (defvar org-agenda-entry-text-cleanup-hook nil
  948. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  949. This cleanup is done in a temporary buffer, so the function may inspect and
  950. change the entire buffer.
  951. Some default stuff like drawers and scheduling/deadline dates will already
  952. have been removed when this is called, as will any matches for regular
  953. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  954. (defvar org-agenda-include-inactive-timestamps nil
  955. "Non-nil means include inactive time stamps in agenda.
  956. Dynamically scoped.")
  957. (defgroup org-agenda-windows nil
  958. "Options concerning the windows used by the Agenda in Org Mode."
  959. :tag "Org Agenda Windows"
  960. :group 'org-agenda)
  961. (defcustom org-agenda-window-setup 'reorganize-frame
  962. "How the agenda buffer should be displayed.
  963. Possible values for this option are:
  964. current-window Show agenda in the current window, keeping all other windows.
  965. other-window Use `switch-to-buffer-other-window' to display agenda.
  966. only-window Show agenda, deleting all other windows.
  967. reorganize-frame Show only two windows on the current frame, the current
  968. window and the agenda.
  969. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  970. Also, when exiting the agenda, kill that frame.
  971. See also the variable `org-agenda-restore-windows-after-quit'."
  972. :group 'org-agenda-windows
  973. :type '(choice
  974. (const current-window)
  975. (const other-frame)
  976. (const other-window)
  977. (const only-window)
  978. (const reorganize-frame)))
  979. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  980. "The min and max height of the agenda window as a fraction of frame height.
  981. The value of the variable is a cons cell with two numbers between 0 and 1.
  982. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  983. :group 'org-agenda-windows
  984. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  985. (defcustom org-agenda-restore-windows-after-quit nil
  986. "Non-nil means restore window configuration upon exiting agenda.
  987. Before the window configuration is changed for displaying the agenda,
  988. the current status is recorded. When the agenda is exited with
  989. `q' or `x' and this option is set, the old state is restored. If
  990. `org-agenda-window-setup' is `other-frame', the value of this
  991. option will be ignored."
  992. :group 'org-agenda-windows
  993. :type 'boolean)
  994. (defcustom org-agenda-span 'week
  995. "Number of days to include in overview display.
  996. Can be day, week, month, year, or any number of days.
  997. Custom commands can set this variable in the options section."
  998. :group 'org-agenda-daily/weekly
  999. :type '(choice (const :tag "Day" day)
  1000. (const :tag "Week" week)
  1001. (const :tag "Fortnight" fortnight)
  1002. (const :tag "Month" month)
  1003. (const :tag "Year" year)
  1004. (integer :tag "Custom")))
  1005. (defcustom org-agenda-start-on-weekday 1
  1006. "Non-nil means start the overview always on the specified weekday.
  1007. 0 denotes Sunday, 1 denotes Monday, etc.
  1008. When nil, always start on the current day.
  1009. Custom commands can set this variable in the options section."
  1010. :group 'org-agenda-daily/weekly
  1011. :type '(choice (const :tag "Today" nil)
  1012. (integer :tag "Weekday No.")))
  1013. (defcustom org-agenda-show-all-dates t
  1014. "Non-nil means `org-agenda' shows every day in the selected range.
  1015. When nil, only the days which actually have entries are shown."
  1016. :group 'org-agenda-daily/weekly
  1017. :type 'boolean)
  1018. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1019. "Format string for displaying dates in the agenda.
  1020. Used by the daily/weekly agenda. This should be a format string
  1021. understood by `format-time-string', or a function returning the
  1022. formatted date as a string. The function must take a single
  1023. argument, a calendar-style date list like (month day year)."
  1024. :group 'org-agenda-daily/weekly
  1025. :type '(choice
  1026. (string :tag "Format string")
  1027. (function :tag "Function")))
  1028. (defun org-agenda-end-of-line ()
  1029. "Go to the end of visible line."
  1030. (interactive)
  1031. (goto-char (line-end-position)))
  1032. (defun org-agenda-format-date-aligned (date)
  1033. "Format a DATE string for display in the daily/weekly agenda.
  1034. This function makes sure that dates are aligned for easy reading."
  1035. (require 'cal-iso)
  1036. (let* ((dayname (calendar-day-name date))
  1037. (day (cadr date))
  1038. (day-of-week (calendar-day-of-week date))
  1039. (month (car date))
  1040. (monthname (calendar-month-name month))
  1041. (year (nth 2 date))
  1042. (iso-week (org-days-to-iso-week
  1043. (calendar-absolute-from-gregorian date)))
  1044. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1045. (1- year))
  1046. ((and (= month 12) (<= iso-week 1))
  1047. (1+ year))
  1048. (t year)))
  1049. (weekstring (if (= day-of-week 1)
  1050. (format " W%02d" iso-week)
  1051. "")))
  1052. (format "%-10s %2d %s %4d%s"
  1053. dayname day monthname year weekstring)))
  1054. (defcustom org-agenda-time-leading-zero nil
  1055. "Non-nil means use leading zero for military times in agenda.
  1056. For example, 9:30am would become 09:30 rather than 9:30."
  1057. :group 'org-agenda-daily/weekly
  1058. :version "24.1"
  1059. :type 'boolean)
  1060. (defcustom org-agenda-timegrid-use-ampm nil
  1061. "When set, show AM/PM style timestamps on the timegrid."
  1062. :group 'org-agenda
  1063. :version "24.1"
  1064. :type 'boolean)
  1065. (defun org-agenda-time-of-day-to-ampm (time)
  1066. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1067. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1068. (minute (substring time -2))
  1069. (ampm "am"))
  1070. (cond
  1071. ((equal hour-number 12)
  1072. (setq ampm "pm"))
  1073. ((> hour-number 12)
  1074. (setq ampm "pm")
  1075. (setq hour-number (- hour-number 12))))
  1076. (concat
  1077. (if org-agenda-time-leading-zero
  1078. (format "%02d" hour-number)
  1079. (format "%02s" (number-to-string hour-number)))
  1080. ":" minute ampm)))
  1081. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1082. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1083. (if org-agenda-timegrid-use-ampm
  1084. (org-agenda-time-of-day-to-ampm time)
  1085. time))
  1086. (defcustom org-agenda-weekend-days '(6 0)
  1087. "Which days are weekend?
  1088. These days get the special face `org-agenda-date-weekend' in the agenda."
  1089. :group 'org-agenda-daily/weekly
  1090. :type '(set :greedy t
  1091. (const :tag "Monday" 1)
  1092. (const :tag "Tuesday" 2)
  1093. (const :tag "Wednesday" 3)
  1094. (const :tag "Thursday" 4)
  1095. (const :tag "Friday" 5)
  1096. (const :tag "Saturday" 6)
  1097. (const :tag "Sunday" 0)))
  1098. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1099. "Non-nil means jump to today when moving a past date forward in time.
  1100. When using S-right in the agenda to move a date forward, and the date
  1101. stamp currently points to the past, the first key press will move it
  1102. to today. When nil, just move one day forward even if the date stays
  1103. in the past."
  1104. :group 'org-agenda-daily/weekly
  1105. :version "24.1"
  1106. :type 'boolean)
  1107. (defcustom org-agenda-diary-file 'diary-file
  1108. "File to which to add new entries with the `i' key in agenda and calendar.
  1109. When this is the symbol `diary-file', the functionality in the Emacs
  1110. calendar will be used to add entries to the `diary-file'. But when this
  1111. points to a file, `org-agenda-diary-entry' will be used instead."
  1112. :group 'org-agenda
  1113. :type '(choice
  1114. (const :tag "The standard Emacs diary file" diary-file)
  1115. (file :tag "Special Org file diary entries")))
  1116. (defcustom org-agenda-include-diary nil
  1117. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1118. Custom commands can set this variable in the options section."
  1119. :group 'org-agenda-daily/weekly
  1120. :type 'boolean)
  1121. (defcustom org-agenda-include-deadlines t
  1122. "If non-nil, include entries within their deadline warning period.
  1123. Custom commands can set this variable in the options section."
  1124. :group 'org-agenda-daily/weekly
  1125. :version "24.1"
  1126. :type 'boolean)
  1127. (defcustom org-agenda-show-future-repeats t
  1128. "Non-nil shows repeated entries in the future part of the agenda.
  1129. When set to the symbol `next' only the first future repeat is shown."
  1130. :group 'org-agenda-daily/weekly
  1131. :type '(choice
  1132. (const :tag "Show all repeated entries" t)
  1133. (const :tag "Show next repeated entry" next)
  1134. (const :tag "Do not show repeated entries" nil))
  1135. :version "26.1"
  1136. :package-version '(Org . "9.1")
  1137. :safe #'symbolp)
  1138. (defcustom org-agenda-prefer-last-repeat nil
  1139. "Non-nil sets date for repeated entries to their last repeat.
  1140. When nil, display SCHEDULED and DEADLINE dates at their base
  1141. date, and in today's agenda, as a reminder. Display plain
  1142. time-stamps, on the other hand, at every repeat date in the past
  1143. in addition to the base date.
  1144. When non-nil, show a repeated entry at its latest repeat date,
  1145. possibly being today even if it wasn't marked as done. This
  1146. setting is useful if you do not always mark repeated entries as
  1147. done and, yet, consider that reaching repeat date starts the task
  1148. anew.
  1149. When set to a list of strings, prefer last repeats only for
  1150. entries with these TODO keywords."
  1151. :group 'org-agenda-daily/weekly
  1152. :type '(choice
  1153. (const :tag "Prefer last repeat" t)
  1154. (const :tag "Prefer base date" nil)
  1155. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1156. (string :tag "TODO keyword")))
  1157. :version "26.1"
  1158. :package-version '(Org . "9.1")
  1159. :safe (lambda (x) (or (booleanp x) (consp x))))
  1160. (defcustom org-scheduled-past-days 10000
  1161. "Number of days to continue listing scheduled items not marked DONE.
  1162. When an item is scheduled on a date, it shows up in the agenda on
  1163. this day and will be listed until it is marked done or for the
  1164. number of days given here."
  1165. :group 'org-agenda-daily/weekly
  1166. :type 'integer
  1167. :safe 'integerp)
  1168. (defcustom org-deadline-past-days 10000
  1169. "Number of days to warn about missed deadlines.
  1170. When an item has deadline on a date, it shows up in the agenda on
  1171. this day and will appear as a reminder until it is marked DONE or
  1172. for the number of days given here."
  1173. :group 'org-agenda-daily/weekly
  1174. :type 'integer
  1175. :version "26.1"
  1176. :package-version '(Org . "9.1")
  1177. :safe 'integerp)
  1178. (defcustom org-agenda-log-mode-items '(closed clock)
  1179. "List of items that should be shown in agenda log mode.
  1180. \\<org-agenda-mode-map>\
  1181. This list may contain the following symbols:
  1182. closed Show entries that have been closed on that day.
  1183. clock Show entries that have received clocked time on that day.
  1184. state Show all logged state changes.
  1185. Note that instead of changing this variable, you can also press \
  1186. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1187. the agenda to display all available LOG items temporarily."
  1188. :group 'org-agenda-daily/weekly
  1189. :type '(set :greedy t (const closed) (const clock) (const state)))
  1190. (defcustom org-agenda-clock-consistency-checks
  1191. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1192. :gap-ok-around ("4:00")
  1193. :default-face ((:background "DarkRed") (:foreground "white"))
  1194. :overlap-face nil :gap-face nil :no-end-time-face nil
  1195. :long-face nil :short-face nil)
  1196. "This is a property list, with the following keys:
  1197. :max-duration Mark clocking chunks that are longer than this time.
  1198. This is a time string like \"HH:MM\", or the number
  1199. of minutes as an integer.
  1200. :min-duration Mark clocking chunks that are shorter that this.
  1201. This is a time string like \"HH:MM\", or the number
  1202. of minutes as an integer.
  1203. :max-gap Mark gaps between clocking chunks that are longer than
  1204. this duration. A number of minutes, or a string
  1205. like \"HH:MM\".
  1206. :gap-ok-around List of times during the day which are usually not working
  1207. times. When a gap is detected, but the gap contains any
  1208. of these times, the gap is *not* reported. For example,
  1209. if this is (\"4:00\" \"13:00\") then gaps that contain
  1210. 4:00 in the morning (i.e. the night) and 13:00
  1211. (i.e. a typical lunch time) do not cause a warning.
  1212. You should have at least one time during the night in this
  1213. list, or otherwise the first task each morning will trigger
  1214. a warning because it follows a long gap.
  1215. Furthermore, the following properties can be used to define faces for
  1216. issue display.
  1217. :default-face the default face, if the specific face is undefined
  1218. :overlap-face face for overlapping clocks
  1219. :gap-face face for gaps between clocks
  1220. :no-end-time-face face for incomplete clocks
  1221. :long-face face for clock intervals that are too long
  1222. :short-face face for clock intervals that are too short"
  1223. :group 'org-agenda-daily/weekly
  1224. :group 'org-clock
  1225. :version "24.1"
  1226. :type 'plist)
  1227. (defcustom org-agenda-log-mode-add-notes t
  1228. "Non-nil means add first line of notes to log entries in agenda views.
  1229. If a log item like a state change or a clock entry is associated with
  1230. notes, the first line of these notes will be added to the entry in the
  1231. agenda display."
  1232. :group 'org-agenda-daily/weekly
  1233. :type 'boolean)
  1234. (defcustom org-agenda-start-with-log-mode nil
  1235. "The initial value of log-mode in a newly created agenda window.
  1236. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1237. explanations on the possible values."
  1238. :group 'org-agenda-startup
  1239. :group 'org-agenda-daily/weekly
  1240. :type '(choice (const :tag "Don't show log items" nil)
  1241. (const :tag "Show only log items" only)
  1242. (const :tag "Show all possible log items" clockcheck)
  1243. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1244. (choice (const :tag "Show closed log items" closed)
  1245. (const :tag "Show clocked log items" clock)
  1246. (const :tag "Show all logged state changes" state)))))
  1247. (defcustom org-agenda-start-with-clockreport-mode nil
  1248. "The initial value of clockreport-mode in a newly created agenda window."
  1249. :group 'org-agenda-startup
  1250. :group 'org-agenda-daily/weekly
  1251. :type 'boolean)
  1252. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1253. "Property list with parameters for the clocktable in clockreport mode.
  1254. This is the display mode that shows a clock table in the daily/weekly
  1255. agenda, the properties for this dynamic block can be set here.
  1256. The usual clocktable parameters are allowed here, but you cannot set
  1257. the properties :name, :tstart, :tend, :block, and :scope - these will
  1258. be overwritten to make sure the content accurately reflects the
  1259. current display in the agenda."
  1260. :group 'org-agenda-daily/weekly
  1261. :type 'plist)
  1262. (defvaralias 'org-agenda-search-view-search-words-only
  1263. 'org-agenda-search-view-always-boolean)
  1264. (defcustom org-agenda-search-view-always-boolean nil
  1265. "Non-nil means the search string is interpreted as individual parts.
  1266. The search string for search view can either be interpreted as a phrase,
  1267. or as a list of snippets that define a boolean search for a number of
  1268. strings.
  1269. When this is non-nil, the string will be split on whitespace, and each
  1270. snippet will be searched individually, and all must match in order to
  1271. select an entry. A snippet is then a single string of non-white
  1272. characters, or a string in double quotes, or a regexp in {} braces.
  1273. If a snippet is preceded by \"-\", the snippet must *not* match.
  1274. \"+\" is syntactic sugar for positive selection. Each snippet may
  1275. be found as a full word or a partial word, but see the variable
  1276. `org-agenda-search-view-force-full-words'.
  1277. When this is nil, search will look for the entire search phrase as one,
  1278. with each space character matching any amount of whitespace, including
  1279. line breaks.
  1280. Even when this is nil, you can still switch to Boolean search dynamically
  1281. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1282. is a regexp marked with braces like \"{abc}\", this will also switch to
  1283. boolean search."
  1284. :group 'org-agenda-search-view
  1285. :version "24.1"
  1286. :type 'boolean)
  1287. (defcustom org-agenda-search-view-force-full-words nil
  1288. "Non-nil means, search words must be matches as complete words.
  1289. When nil, they may also match part of a word."
  1290. :group 'org-agenda-search-view
  1291. :version "24.1"
  1292. :type 'boolean)
  1293. (defcustom org-agenda-search-view-max-outline-level 0
  1294. "Maximum outline level to display in search view.
  1295. E.g. when this is set to 1, the search view will only
  1296. show headlines of level 1. When set to 0, the default
  1297. value, don't limit agenda view by outline level."
  1298. :group 'org-agenda-search-view
  1299. :version "26.1"
  1300. :package-version '(Org . "8.3")
  1301. :type 'integer)
  1302. (defgroup org-agenda-time-grid nil
  1303. "Options concerning the time grid in the Org Agenda."
  1304. :tag "Org Agenda Time Grid"
  1305. :group 'org-agenda)
  1306. (defcustom org-agenda-search-headline-for-time t
  1307. "Non-nil means search headline for a time-of-day.
  1308. If the headline contains a time-of-day in one format or another, it will
  1309. be used to sort the entry into the time sequence of items for a day.
  1310. Some people have time stamps in the headline that refer to the creation
  1311. time or so, and then this produces an unwanted side effect. If this is
  1312. the case for your, use this variable to turn off searching the headline
  1313. for a time."
  1314. :group 'org-agenda-time-grid
  1315. :type 'boolean)
  1316. (defcustom org-agenda-use-time-grid t
  1317. "Non-nil means show a time grid in the agenda schedule.
  1318. A time grid is a set of lines for specific times (like every two hours between
  1319. 8:00 and 20:00). The items scheduled for a day at specific times are
  1320. sorted in between these lines.
  1321. For details about when the grid will be shown, and what it will look like, see
  1322. the variable `org-agenda-time-grid'."
  1323. :group 'org-agenda-time-grid
  1324. :type 'boolean)
  1325. (defcustom org-agenda-time-grid
  1326. '((daily today require-timed)
  1327. (800 1000 1200 1400 1600 1800 2000)
  1328. "......"
  1329. "----------------")
  1330. "The settings for time grid for agenda display.
  1331. This is a list of four items. The first item is again a list. It contains
  1332. symbols specifying conditions when the grid should be displayed:
  1333. daily if the agenda shows a single day
  1334. weekly if the agenda shows an entire week
  1335. today show grid on current date, independent of daily/weekly display
  1336. require-timed show grid only if at least one item has a time specification
  1337. remove-match skip grid times already present in an entry
  1338. The second item is a list of integers, indicating the times that
  1339. should have a grid line.
  1340. The third item is a string which will be placed right after the
  1341. times that have a grid line.
  1342. The fourth item is a string placed after the grid times. This
  1343. will align with agenda items."
  1344. :group 'org-agenda-time-grid
  1345. :type
  1346. '(list
  1347. (set :greedy t :tag "Grid Display Options"
  1348. (const :tag "Show grid in single day agenda display" daily)
  1349. (const :tag "Show grid in weekly agenda display" weekly)
  1350. (const :tag "Always show grid for today" today)
  1351. (const :tag "Show grid only if any timed entries are present"
  1352. require-timed)
  1353. (const :tag "Skip grid times already present in an entry"
  1354. remove-match))
  1355. (repeat :tag "Grid Times" (integer :tag "Time"))
  1356. (string :tag "Grid String (after agenda times)")
  1357. (string :tag "Grid String (aligns with agenda items)")))
  1358. (defcustom org-agenda-show-current-time-in-grid t
  1359. "Non-nil means show the current time in the time grid."
  1360. :group 'org-agenda-time-grid
  1361. :version "24.1"
  1362. :type 'boolean)
  1363. (defcustom org-agenda-current-time-string
  1364. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1365. "The string for the current time marker in the agenda."
  1366. :group 'org-agenda-time-grid
  1367. :version "24.1"
  1368. :type 'string)
  1369. (defgroup org-agenda-sorting nil
  1370. "Options concerning sorting in the Org Agenda."
  1371. :tag "Org Agenda Sorting"
  1372. :group 'org-agenda)
  1373. (defcustom org-agenda-sorting-strategy
  1374. '((agenda habit-down time-up priority-down category-keep)
  1375. (todo priority-down category-keep)
  1376. (tags priority-down category-keep)
  1377. (search category-keep))
  1378. "Sorting structure for the agenda items of a single day.
  1379. This is a list of symbols which will be used in sequence to determine
  1380. if an entry should be listed before another entry. The following
  1381. symbols are recognized:
  1382. time-up Put entries with time-of-day indications first, early first.
  1383. time-down Put entries with time-of-day indications first, late first.
  1384. timestamp-up Sort by any timestamp, early first.
  1385. timestamp-down Sort by any timestamp, late first.
  1386. scheduled-up Sort by scheduled timestamp, early first.
  1387. scheduled-down Sort by scheduled timestamp, late first.
  1388. deadline-up Sort by deadline timestamp, early first.
  1389. deadline-down Sort by deadline timestamp, late first.
  1390. ts-up Sort by active timestamp, early first.
  1391. ts-down Sort by active timestamp, late first.
  1392. tsia-up Sort by inactive timestamp, early first.
  1393. tsia-down Sort by inactive timestamp, late first.
  1394. category-keep Keep the default order of categories, corresponding to the
  1395. sequence in `org-agenda-files'.
  1396. category-up Sort alphabetically by category, A-Z.
  1397. category-down Sort alphabetically by category, Z-A.
  1398. tag-up Sort alphabetically by last tag, A-Z.
  1399. tag-down Sort alphabetically by last tag, Z-A.
  1400. priority-up Sort numerically by priority, high priority last.
  1401. priority-down Sort numerically by priority, high priority first.
  1402. todo-state-up Sort by todo state, tasks that are done last.
  1403. todo-state-down Sort by todo state, tasks that are done first.
  1404. effort-up Sort numerically by estimated effort, high effort last.
  1405. effort-down Sort numerically by estimated effort, high effort first.
  1406. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1407. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1408. habit-up Put entries that are habits first.
  1409. habit-down Put entries that are habits last.
  1410. alpha-up Sort headlines alphabetically.
  1411. alpha-down Sort headlines alphabetically, reversed.
  1412. The different possibilities will be tried in sequence, and testing stops
  1413. if one comparison returns a \"not-equal\". For example, the default
  1414. '(time-up category-keep priority-down)
  1415. means: Pull out all entries having a specified time of day and sort them,
  1416. in order to make a time schedule for the current day the first thing in the
  1417. agenda listing for the day. Of the entries without a time indication, keep
  1418. the grouped in categories, don't sort the categories, but keep them in
  1419. the sequence given in `org-agenda-files'. Within each category sort by
  1420. priority.
  1421. Leaving out `category-keep' would mean that items will be sorted across
  1422. categories by priority.
  1423. Instead of a single list, this can also be a set of list for specific
  1424. contents, with a context symbol in the car of the list, any of
  1425. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1426. Custom commands can bind this variable in the options section."
  1427. :group 'org-agenda-sorting
  1428. :type `(choice
  1429. (repeat :tag "General" ,org-sorting-choice)
  1430. (list :tag "Individually"
  1431. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1432. (repeat ,org-sorting-choice))
  1433. (cons (const :tag "Strategy for TODO lists" todo)
  1434. (repeat ,org-sorting-choice))
  1435. (cons (const :tag "Strategy for Tags matches" tags)
  1436. (repeat ,org-sorting-choice))
  1437. (cons (const :tag "Strategy for search matches" search)
  1438. (repeat ,org-sorting-choice)))))
  1439. (defcustom org-agenda-cmp-user-defined nil
  1440. "A function to define the comparison `user-defined'.
  1441. This function must receive two arguments, agenda entry a and b.
  1442. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1443. the user comparison, return nil.
  1444. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1445. part of an agenda sorting strategy."
  1446. :group 'org-agenda-sorting
  1447. :type 'symbol)
  1448. (defcustom org-sort-agenda-notime-is-late t
  1449. "Non-nil means items without time are considered late.
  1450. This is only relevant for sorting. When t, items which have no explicit
  1451. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1452. do have a time. When nil, the default time is before 0:00. You can use this
  1453. option to decide if the schedule for today should come before or after timeless
  1454. agenda entries."
  1455. :group 'org-agenda-sorting
  1456. :type 'boolean)
  1457. (defcustom org-sort-agenda-noeffort-is-high t
  1458. "Non-nil means items without effort estimate are sorted as high effort.
  1459. This also applies when filtering an agenda view with respect to the
  1460. < or > effort operator. Then, tasks with no effort defined will be treated
  1461. as tasks with high effort.
  1462. When nil, such items are sorted as 0 minutes effort."
  1463. :group 'org-agenda-sorting
  1464. :type 'boolean)
  1465. (defgroup org-agenda-line-format nil
  1466. "Options concerning the entry prefix in the Org agenda display."
  1467. :tag "Org Agenda Line Format"
  1468. :group 'org-agenda)
  1469. (defcustom org-agenda-prefix-format
  1470. '((agenda . " %i %-12:c%?-12t% s")
  1471. (todo . " %i %-12:c")
  1472. (tags . " %i %-12:c")
  1473. (search . " %i %-12:c"))
  1474. "Format specifications for the prefix of items in the agenda views.
  1475. An alist with one entry per agenda type. The keys of the
  1476. sublists are `agenda', `todo', `search' and `tags'. The values
  1477. are format strings.
  1478. This format works similar to a printf format, with the following meaning:
  1479. %c the category of the item, \"Diary\" for entries from the diary,
  1480. or as given by the CATEGORY keyword or derived from the file name
  1481. %e the effort required by the item
  1482. %l the level of the item (insert X space(s) if item is of level X)
  1483. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1484. %T the last tag of the item (ignore inherited tags, which come first)
  1485. %t the HH:MM time-of-day specification if one applies to the entry
  1486. %s Scheduling/Deadline information, a short string
  1487. %b show breadcrumbs, i.e., the names of the higher levels
  1488. %(expression) Eval EXPRESSION and replace the control string
  1489. by the result
  1490. All specifiers work basically like the standard `%s' of printf, but may
  1491. contain two additional characters: a question mark just after the `%'
  1492. and a whitespace/punctuation character just before the final letter.
  1493. If the first character after `%' is a question mark, the entire field
  1494. will only be included if the corresponding value applies to the current
  1495. entry. This is useful for fields which should have fixed width when
  1496. present, but zero width when absent. For example, \"%?-12t\" will
  1497. result in a 12 character time field if a time of the day is specified,
  1498. but will completely disappear in entries which do not contain a time.
  1499. If there is punctuation or whitespace character just before the
  1500. final format letter, this character will be appended to the field
  1501. value if the value is not empty. For example, the format
  1502. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1503. the category is empty, no additional colon is inserted.
  1504. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1505. which means:
  1506. - Indent the line with two space characters
  1507. - Give the category a 12 chars wide field, padded with whitespace on
  1508. the right (because of `-'). Append a colon if there is a category
  1509. (because of `:').
  1510. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1511. time, don't put in an empty field, just skip it (because of '?').
  1512. - Finally, put the scheduling information.
  1513. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1514. `org-agenda-remove-tags'.
  1515. Custom commands can set this variable in the options section."
  1516. :type '(choice
  1517. (string :tag "General format")
  1518. (list :greedy t :tag "View dependent"
  1519. (cons (const agenda) (string :tag "Format"))
  1520. (cons (const todo) (string :tag "Format"))
  1521. (cons (const tags) (string :tag "Format"))
  1522. (cons (const search) (string :tag "Format"))))
  1523. :group 'org-agenda-line-format
  1524. :version "26.1"
  1525. :package-version '(Org . "9.1"))
  1526. (defcustom org-agenda-breadcrumbs-separator "->"
  1527. "The separator of breadcrumbs in agenda lines."
  1528. :group 'org-agenda-line-format
  1529. :package-version '(Org . "9.3")
  1530. :type 'string
  1531. :safe #'stringp)
  1532. (defvar org-prefix-format-compiled nil
  1533. "The compiled prefix format and associated variables.
  1534. This is a list where first element is a list of variable bindings, and second
  1535. element is the compiled format expression. See the variable
  1536. `org-agenda-prefix-format'.")
  1537. (defcustom org-agenda-todo-keyword-format "%-1s"
  1538. "Format for the TODO keyword in agenda lines.
  1539. Set this to something like \"%-12s\" if you want all TODO keywords
  1540. to occupy a fixed space in the agenda display."
  1541. :group 'org-agenda-line-format
  1542. :type 'string)
  1543. (defcustom org-agenda-diary-sexp-prefix nil
  1544. "A regexp that matches part of a diary sexp entry
  1545. which should be treated as scheduling/deadline information in
  1546. `org-agenda'.
  1547. For example, you can use this to extract the `diary-remind-message' from
  1548. `diary-remind' entries."
  1549. :group 'org-agenda-line-format
  1550. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1551. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1552. "Text preceding timerange entries in the agenda view.
  1553. This is a list with two strings. The first applies when the range
  1554. is entirely on one day. The second applies if the range spans several days.
  1555. The strings may have two \"%d\" format specifiers which will be filled
  1556. with the sequence number of the days, and the total number of days in the
  1557. range, respectively."
  1558. :group 'org-agenda-line-format
  1559. :type '(list
  1560. (string :tag "Deadline today ")
  1561. (choice :tag "Deadline relative"
  1562. (string :tag "Format string")
  1563. (function))))
  1564. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1565. "Text preceding scheduled items in the agenda view.
  1566. This is a list with two strings. The first applies when the item is
  1567. scheduled on the current day. The second applies when it has been scheduled
  1568. previously, it may contain a %d indicating that this is the nth time that
  1569. this item is scheduled, due to automatic rescheduling of unfinished items
  1570. for the following day. So this number is one larger than the number of days
  1571. that passed since this item was scheduled first."
  1572. :group 'org-agenda-line-format
  1573. :version "24.4"
  1574. :package-version '(Org . "8.0")
  1575. :type '(list
  1576. (string :tag "Scheduled today ")
  1577. (string :tag "Scheduled previously")))
  1578. (defcustom org-agenda-inactive-leader "["
  1579. "Text preceding item pulled into the agenda by inactive time stamps.
  1580. These entries are added to the agenda when pressing \"[\"."
  1581. :group 'org-agenda-line-format
  1582. :version "24.1"
  1583. :type 'string)
  1584. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1585. "Text preceding deadline items in the agenda view.
  1586. This is a list with three strings. The first applies when the item has its
  1587. deadline on the current day. The second applies when the deadline is in the
  1588. future, the third one when it is in the past. The strings may contain %d
  1589. to capture the number of days."
  1590. :group 'org-agenda-line-format
  1591. :version "24.4"
  1592. :package-version '(Org . "8.0")
  1593. :type '(list
  1594. (string :tag "Deadline today ")
  1595. (string :tag "Deadline in the future ")
  1596. (string :tag "Deadline in the past ")))
  1597. (defcustom org-agenda-remove-times-when-in-prefix t
  1598. "Non-nil means remove duplicate time specifications in agenda items.
  1599. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1600. time-of-day specification in a headline or diary entry is extracted and
  1601. placed into the prefix. If this option is non-nil, the original specification
  1602. \(a timestamp or -range, or just a plain time(range) specification like
  1603. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1604. cluttered.
  1605. The option can be t or nil. It may also be the symbol `beg', indicating
  1606. that the time should only be removed when it is located at the beginning of
  1607. the headline/diary entry."
  1608. :group 'org-agenda-line-format
  1609. :type '(choice
  1610. (const :tag "Always" t)
  1611. (const :tag "Never" nil)
  1612. (const :tag "When at beginning of entry" beg)))
  1613. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1614. "Non-nil means remove time ranges specifications in agenda
  1615. items that span on several days."
  1616. :group 'org-agenda-line-format
  1617. :version "24.1"
  1618. :type 'boolean)
  1619. (defcustom org-agenda-default-appointment-duration nil
  1620. "Default duration for appointments that only have a starting time.
  1621. When nil, no duration is specified in such cases.
  1622. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1623. :group 'org-agenda-line-format
  1624. :type '(choice
  1625. (integer :tag "Minutes")
  1626. (const :tag "No default duration")))
  1627. (defcustom org-agenda-show-inherited-tags t
  1628. "Non-nil means show inherited tags in each agenda line.
  1629. When this option is set to `always', it takes precedence over
  1630. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1631. in every agenda.
  1632. When this option is set to t (the default), inherited tags are
  1633. shown when they are available, i.e. when the value of
  1634. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1635. given agenda type.
  1636. This can be set to a list of agenda types in which the agenda
  1637. must display the inherited tags. Available types are `todo',
  1638. `agenda' and `search'.
  1639. When set to nil, never show inherited tags in agenda lines."
  1640. :group 'org-agenda-line-format
  1641. :group 'org-agenda
  1642. :version "24.3"
  1643. :type '(choice
  1644. (const :tag "Show inherited tags when available" t)
  1645. (const :tag "Always show inherited tags" always)
  1646. (repeat :tag "Show inherited tags only in selected agenda types"
  1647. (symbol :tag "Agenda type"))))
  1648. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1649. "List of agenda view types where to use tag inheritance.
  1650. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1651. controlled by `org-use-tag-inheritance'. In other agenda types,
  1652. `org-use-tag-inheritance' is not used for the selection of the
  1653. agenda entries. Still, you may want the agenda to be aware of
  1654. the inherited tags anyway, e.g. for later tag filtering.
  1655. Allowed value are `todo', `search' and `agenda'.
  1656. This variable has no effect if `org-agenda-show-inherited-tags'
  1657. is set to `always'. In that case, the agenda is aware of those
  1658. tags.
  1659. The default value sets tags in every agenda type. Setting this
  1660. option to nil will speed up non-tags agenda view a lot."
  1661. :group 'org-agenda
  1662. :version "26.1"
  1663. :package-version '(Org . "9.1")
  1664. :type '(choice
  1665. (const :tag "Use tag inheritance in all agenda types" t)
  1666. (repeat :tag "Use tag inheritance in selected agenda types"
  1667. (symbol :tag "Agenda type"))))
  1668. (defcustom org-agenda-hide-tags-regexp nil
  1669. "Regular expression used to filter away specific tags in agenda views.
  1670. This means that these tags will be present, but not be shown in the agenda
  1671. line. Secondary filtering will still work on the hidden tags.
  1672. Nil means don't hide any tags."
  1673. :group 'org-agenda-line-format
  1674. :type '(choice
  1675. (const :tag "Hide none" nil)
  1676. (string :tag "Regexp ")))
  1677. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1678. 'org-agenda-remove-tags)
  1679. (defcustom org-agenda-remove-tags nil
  1680. "Non-nil means remove the tags from the headline copy in the agenda.
  1681. When this is the symbol `prefix', only remove tags when
  1682. `org-agenda-prefix-format' contains a `%T' specifier."
  1683. :group 'org-agenda-line-format
  1684. :type '(choice
  1685. (const :tag "Always" t)
  1686. (const :tag "Never" nil)
  1687. (const :tag "When prefix format contains %T" prefix)))
  1688. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1689. (defcustom org-agenda-tags-column 'auto
  1690. "Shift tags in agenda items to this column.
  1691. If set to `auto', tags will be automatically aligned to the right
  1692. edge of the window.
  1693. If set to a positive number, tags will be left-aligned to that
  1694. column. If set to a negative number, tags will be right-aligned
  1695. to that column. For example, -80 works well for a normal 80
  1696. character screen."
  1697. :group 'org-agenda-line-format
  1698. :type '(choice
  1699. (const :tag "Automatically align to right edge of window" auto)
  1700. (integer :tag "Specific column" -80))
  1701. :package-version '(Org . "9.1")
  1702. :version "26.1")
  1703. (defcustom org-agenda-fontify-priorities 'cookies
  1704. "Non-nil means highlight low and high priorities in agenda.
  1705. When t, the highest priority entries are bold, lowest priority italic.
  1706. However, settings in `org-priority-faces' will overrule these faces.
  1707. When this variable is the symbol `cookies', only fontify the
  1708. cookies, not the entire task.
  1709. This may also be an association list of priority faces, whose
  1710. keys are the character values of `org-priority-highest',
  1711. `org-priority-default', and `org-priority-lowest' (the default values
  1712. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1713. color as a string, or a list like `(:background \"Red\")'.
  1714. If it is a color, the variable `org-faces-easy-properties'
  1715. determines if it is a foreground or a background color."
  1716. :group 'org-agenda-line-format
  1717. :type '(choice
  1718. (const :tag "Never" nil)
  1719. (const :tag "Defaults" t)
  1720. (const :tag "Cookies only" cookies)
  1721. (repeat :tag "Specify"
  1722. (list (character :tag "Priority" :value ?A)
  1723. (choice :tag "Face "
  1724. (string :tag "Color")
  1725. (sexp :tag "Face"))))))
  1726. (defcustom org-agenda-day-face-function nil
  1727. "Function called to determine what face should be used to display a day.
  1728. The only argument passed to that function is the day. It should
  1729. returns a face, or nil if does not want to specify a face and let
  1730. the normal rules apply."
  1731. :group 'org-agenda-line-format
  1732. :version "24.1"
  1733. :type '(choice (const nil) (function)))
  1734. (defcustom org-agenda-category-icon-alist nil
  1735. "Alist of category icon to be displayed in agenda views.
  1736. Each entry should have the following format:
  1737. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1738. Where CATEGORY-REGEXP is a regexp matching the categories where
  1739. the icon should be displayed.
  1740. FILE-OR-DATA either a file path or a string containing image data.
  1741. The other fields can be omitted safely if not needed:
  1742. TYPE indicates the image type.
  1743. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1744. image data.
  1745. PROPS are additional image attributes to assign to the image,
  1746. like, e.g. `:ascent center'.
  1747. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1748. If you want to set the display properties yourself, just put a
  1749. list as second element:
  1750. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1751. For example, to display a 16px horizontal space for Emacs
  1752. category, you can use:
  1753. (\"Emacs\" \\='(space . (:width (16))))"
  1754. :group 'org-agenda-line-format
  1755. :version "24.1"
  1756. :type '(alist :key-type (string :tag "Regexp matching category")
  1757. :value-type (choice (list :tag "Icon"
  1758. (string :tag "File or data")
  1759. (symbol :tag "Type")
  1760. (boolean :tag "Data?")
  1761. (repeat :tag "Extra image properties" :inline t symbol))
  1762. (list :tag "Display properties" sexp))))
  1763. (defgroup org-agenda-column-view nil
  1764. "Options concerning column view in the agenda."
  1765. :tag "Org Agenda Column View"
  1766. :group 'org-agenda)
  1767. (defcustom org-agenda-view-columns-initially nil
  1768. "When non-nil, switch to columns view right after creating the agenda."
  1769. :group 'org-agenda-column-view
  1770. :type 'boolean
  1771. :version "26.1"
  1772. :package-version '(Org . "9.0")
  1773. :safe #'booleanp)
  1774. (defcustom org-agenda-columns-show-summaries t
  1775. "Non-nil means show summaries for columns displayed in the agenda view."
  1776. :group 'org-agenda-column-view
  1777. :type 'boolean)
  1778. (defcustom org-agenda-columns-compute-summary-properties t
  1779. "Non-nil means recompute all summary properties before column view.
  1780. When column view in the agenda is listing properties that have a summary
  1781. operator, it can go to all relevant buffers and recompute the summaries
  1782. there. This can mean overhead for the agenda column view, but is necessary
  1783. to have thing up to date.
  1784. As a special case, a CLOCKSUM property also makes sure that the clock
  1785. computations are current."
  1786. :group 'org-agenda-column-view
  1787. :type 'boolean)
  1788. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1789. "Non-nil means the duration of an appointment will add to day effort.
  1790. The property to which appointment durations will be added is the one given
  1791. in the option `org-effort-property'. If an appointment does not have
  1792. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1793. is not set, an appointment without end time will not contribute to the time
  1794. estimate."
  1795. :group 'org-agenda-column-view
  1796. :type 'boolean)
  1797. (defcustom org-agenda-auto-exclude-function nil
  1798. "A function called with a tag to decide if it is filtered on \
  1799. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1800. The sole argument to the function, which is called once for each
  1801. possible tag, is a string giving the name of the tag. The
  1802. function should return either nil if the tag should be included
  1803. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1804. lines not carrying this tag.
  1805. Note that for the purpose of tag filtering, only the lower-case version of
  1806. all tags will be considered, so that this function will only ever see
  1807. the lower-case version of all tags."
  1808. :group 'org-agenda
  1809. :type '(choice (const nil) (function)))
  1810. (defcustom org-agenda-bulk-custom-functions nil
  1811. "Alist of characters and custom functions for bulk actions.
  1812. For example, this value makes those two functions available:
  1813. \\='((?R set-category)
  1814. (?C bulk-cut))
  1815. With selected entries in an agenda buffer, `B R' will call
  1816. the custom function `set-category' on the selected entries.
  1817. Note that functions in this alist don't need to be quoted."
  1818. :type '(alist :key-type character :value-type (group function))
  1819. :version "24.1"
  1820. :group 'org-agenda)
  1821. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1822. "Execute BODY with point at location given by `org-hd-marker' property.
  1823. If STRING is non-nil, the text property will be fetched from position 0
  1824. in that string. If STRING is nil, it will be fetched from the beginning
  1825. of the current line."
  1826. (org-with-gensyms (marker)
  1827. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1828. 'org-hd-marker ,string)))
  1829. (with-current-buffer (marker-buffer ,marker)
  1830. (save-excursion
  1831. (goto-char ,marker)
  1832. ,@body)))))
  1833. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1834. (defun org-add-agenda-custom-command (entry)
  1835. "Replace or add a command in `org-agenda-custom-commands'.
  1836. This is mostly for hacking and trying a new command - once the command
  1837. works you probably want to add it to `org-agenda-custom-commands' for good."
  1838. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1839. (if ass
  1840. (setcdr ass (cdr entry))
  1841. (push entry org-agenda-custom-commands))))
  1842. (defmacro org-agenda--insert-overriding-header (default)
  1843. "Insert header into agenda view.
  1844. The inserted header depends on `org-agenda-overriding-header'.
  1845. If the empty string, don't insert a header. If any other string,
  1846. insert it as a header. If nil, insert DEFAULT, which should
  1847. evaluate to a string."
  1848. (declare (debug (form)) (indent defun))
  1849. `(cond
  1850. ((not org-agenda-overriding-header) (insert ,default))
  1851. ((equal org-agenda-overriding-header "") nil)
  1852. ((stringp org-agenda-overriding-header)
  1853. (insert (propertize org-agenda-overriding-header
  1854. 'face 'org-agenda-structure)
  1855. "\n"))
  1856. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1857. org-agenda-overriding-header))))
  1858. ;;; Define the org-agenda-mode
  1859. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1860. (defvar org-agenda-mode-map (make-sparse-keymap)
  1861. "Keymap for `org-agenda-mode'.")
  1862. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1863. (defvar org-agenda-menu) ; defined later in this file.
  1864. (defvar org-agenda-restrict nil) ; defined later in this file.
  1865. (defvar org-agenda-follow-mode nil)
  1866. (defvar org-agenda-entry-text-mode nil)
  1867. (defvar org-agenda-clockreport-mode nil)
  1868. (defvar org-agenda-show-log nil
  1869. "When non-nil, show the log in the agenda.
  1870. Do not set this directly; instead use
  1871. `org-agenda-start-with-log-mode', which see.")
  1872. (defvar org-agenda-redo-command nil)
  1873. (defvar org-agenda-query-string nil)
  1874. (defvar org-agenda-mode-hook nil
  1875. "Hook run after `org-agenda-mode' is turned on.
  1876. The buffer is still writable when this hook is called.")
  1877. (defvar org-agenda-type nil)
  1878. (defvar org-agenda-force-single-file nil)
  1879. (defvar org-agenda-bulk-marked-entries nil
  1880. "List of markers that refer to marked entries in the agenda.")
  1881. (defvar org-agenda-current-date nil
  1882. "Active date when building the agenda.")
  1883. ;;; Multiple agenda buffers support
  1884. (defcustom org-agenda-sticky nil
  1885. "Non-nil means agenda q key will bury agenda buffers.
  1886. Agenda commands will then show existing buffer instead of generating new ones.
  1887. When nil, `q' will kill the single agenda buffer."
  1888. :group 'org-agenda
  1889. :version "24.3"
  1890. :type 'boolean)
  1891. ;;;###autoload
  1892. (defun org-toggle-sticky-agenda (&optional arg)
  1893. "Toggle `org-agenda-sticky'."
  1894. (interactive "P")
  1895. (let ((new-value (if arg
  1896. (> (prefix-numeric-value arg) 0)
  1897. (not org-agenda-sticky))))
  1898. (if (equal new-value org-agenda-sticky)
  1899. (and (called-interactively-p 'interactive)
  1900. (message "Sticky agenda was already %s"
  1901. (if org-agenda-sticky "enabled" "disabled")))
  1902. (setq org-agenda-sticky new-value)
  1903. (org-agenda-kill-all-agenda-buffers)
  1904. (and (called-interactively-p 'interactive)
  1905. (message "Sticky agenda %s"
  1906. (if org-agenda-sticky "enabled" "disabled"))))))
  1907. (defvar org-agenda-buffer nil
  1908. "Agenda buffer currently being generated.")
  1909. (defvar org-agenda-last-prefix-arg nil)
  1910. (defvar org-agenda-this-buffer-name nil)
  1911. (defvar org-agenda-doing-sticky-redo nil)
  1912. (defvar org-agenda-this-buffer-is-sticky nil)
  1913. (defvar org-agenda-last-indirect-buffer nil
  1914. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1915. (defconst org-agenda-local-vars
  1916. '(org-agenda-this-buffer-name
  1917. org-agenda-undo-list
  1918. org-agenda-pending-undo-list
  1919. org-agenda-follow-mode
  1920. org-agenda-entry-text-mode
  1921. org-agenda-clockreport-mode
  1922. org-agenda-show-log
  1923. org-agenda-redo-command
  1924. org-agenda-query-string
  1925. org-agenda-type
  1926. org-agenda-bulk-marked-entries
  1927. org-agenda-undo-has-started-in
  1928. org-agenda-info
  1929. org-agenda-pre-window-conf
  1930. org-agenda-columns-active
  1931. org-agenda-tag-filter
  1932. org-agenda-category-filter
  1933. org-agenda-top-headline-filter
  1934. org-agenda-regexp-filter
  1935. org-agenda-effort-filter
  1936. org-agenda-markers
  1937. org-agenda-last-search-view-search-was-boolean
  1938. org-agenda-last-indirect-buffer
  1939. org-agenda-filtered-by-category
  1940. org-agenda-filter-form
  1941. org-agenda-cycle-counter
  1942. org-agenda-last-prefix-arg)
  1943. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1944. (defun org-agenda-mode ()
  1945. "Mode for time-sorted view on action items in Org files.
  1946. The following commands are available:
  1947. \\{org-agenda-mode-map}"
  1948. (interactive)
  1949. (ignore-errors (require 'face-remap))
  1950. (let ((agenda-local-vars-to-keep
  1951. '(text-scale-mode-amount
  1952. text-scale-mode
  1953. text-scale-mode-lighter
  1954. face-remapping-alist))
  1955. (save (buffer-local-variables)))
  1956. (kill-all-local-variables)
  1957. (cl-flet ((reset-saved (var-set)
  1958. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1959. (dolist (elem save)
  1960. (pcase elem
  1961. (`(,var . ,val) ;ignore unbound variables
  1962. (when (and val (memq var var-set))
  1963. (set var val)))))))
  1964. (cond (org-agenda-doing-sticky-redo
  1965. ;; Refreshing sticky agenda-buffer
  1966. ;;
  1967. ;; Preserve the value of `org-agenda-local-vars' variables.
  1968. (mapc #'make-local-variable org-agenda-local-vars)
  1969. (reset-saved org-agenda-local-vars)
  1970. (setq-local org-agenda-this-buffer-is-sticky t))
  1971. (org-agenda-sticky
  1972. ;; Creating a sticky Agenda buffer for the first time
  1973. (mapc 'make-local-variable org-agenda-local-vars)
  1974. (setq-local org-agenda-this-buffer-is-sticky t))
  1975. (t
  1976. ;; Creating a non-sticky agenda buffer
  1977. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1978. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1979. (reset-saved agenda-local-vars-to-keep)))
  1980. (setq org-agenda-undo-list nil
  1981. org-agenda-pending-undo-list nil
  1982. org-agenda-bulk-marked-entries nil)
  1983. (setq major-mode 'org-agenda-mode)
  1984. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1985. (setq-local font-lock-global-modes (list 'not major-mode))
  1986. (setq mode-name "Org-Agenda")
  1987. (setq indent-tabs-mode nil)
  1988. (use-local-map org-agenda-mode-map)
  1989. (easy-menu-add org-agenda-menu)
  1990. (when org-startup-truncated (setq truncate-lines t))
  1991. (setq-local line-move-visual nil)
  1992. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1993. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1994. ;; Make sure properties are removed when copying text
  1995. (if (boundp 'filter-buffer-substring-functions)
  1996. (add-hook 'filter-buffer-substring-functions
  1997. (lambda (fun start end delete)
  1998. (substring-no-properties (funcall fun start end delete)))
  1999. nil t)
  2000. ;; Emacs >= 24.4.
  2001. (add-function :filter-return (local 'filter-buffer-substring-function)
  2002. #'substring-no-properties))
  2003. (unless org-agenda-keep-modes
  2004. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  2005. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  2006. org-agenda-show-log org-agenda-start-with-log-mode
  2007. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2008. (add-to-invisibility-spec '(org-filtered))
  2009. (add-to-invisibility-spec '(org-link))
  2010. (easy-menu-change
  2011. '("Agenda") "Agenda Files"
  2012. (append
  2013. (list
  2014. (vector
  2015. (if (get 'org-agenda-files 'org-restrict)
  2016. "Restricted to single file"
  2017. "Edit File List")
  2018. '(org-edit-agenda-file-list)
  2019. (not (get 'org-agenda-files 'org-restrict)))
  2020. "--")
  2021. (mapcar 'org-file-menu-entry (org-agenda-files))))
  2022. (org-agenda-set-mode-name)
  2023. (apply
  2024. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  2025. (list 'org-agenda-mode-hook)))
  2026. (substitute-key-definition #'undo #'org-agenda-undo
  2027. org-agenda-mode-map global-map)
  2028. (org-defkey org-agenda-mode-map "\C-i" #'org-agenda-goto)
  2029. (org-defkey org-agenda-mode-map [(tab)] #'org-agenda-goto)
  2030. (org-defkey org-agenda-mode-map "\C-m" #'org-agenda-switch-to)
  2031. (org-defkey org-agenda-mode-map "\C-k" #'org-agenda-kill)
  2032. (org-defkey org-agenda-mode-map "\C-c\C-w" #'org-agenda-refile)
  2033. (org-defkey org-agenda-mode-map [(meta down)] #'org-agenda-drag-line-forward)
  2034. (org-defkey org-agenda-mode-map [(meta up)] #'org-agenda-drag-line-backward)
  2035. (org-defkey org-agenda-mode-map "m" #'org-agenda-bulk-mark)
  2036. (org-defkey org-agenda-mode-map "\M-m" #'org-agenda-bulk-toggle)
  2037. (org-defkey org-agenda-mode-map "*" #'org-agenda-bulk-mark-all)
  2038. (org-defkey org-agenda-mode-map "\M-*" #'org-agenda-bulk-toggle-all)
  2039. (org-defkey org-agenda-mode-map "#" #'org-agenda-dim-blocked-tasks)
  2040. (org-defkey org-agenda-mode-map "%" #'org-agenda-bulk-mark-regexp)
  2041. (org-defkey org-agenda-mode-map "u" #'org-agenda-bulk-unmark)
  2042. (org-defkey org-agenda-mode-map "U" #'org-agenda-bulk-unmark-all)
  2043. (org-defkey org-agenda-mode-map "B" #'org-agenda-bulk-action)
  2044. (org-defkey org-agenda-mode-map "k" #'org-agenda-capture)
  2045. (org-defkey org-agenda-mode-map "A" #'org-agenda-append-agenda)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-x!" #'org-reload)
  2047. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" #'org-agenda-archive-default)
  2048. (org-defkey org-agenda-mode-map "\C-c\C-xa" #'org-agenda-toggle-archive-tag)
  2049. (org-defkey org-agenda-mode-map "\C-c\C-xA" #'org-agenda-archive-to-archive-sibling)
  2050. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" #'org-agenda-archive)
  2051. (org-defkey org-agenda-mode-map "\C-c$" #'org-agenda-archive)
  2052. (org-defkey org-agenda-mode-map "$" #'org-agenda-archive)
  2053. (org-defkey org-agenda-mode-map "\C-c\C-o" #'org-agenda-open-link)
  2054. (org-defkey org-agenda-mode-map " " #'org-agenda-show-and-scroll-up)
  2055. (org-defkey org-agenda-mode-map [backspace] #'org-agenda-show-scroll-down)
  2056. (org-defkey org-agenda-mode-map "\d" #'org-agenda-show-scroll-down)
  2057. (org-defkey org-agenda-mode-map [(control shift right)] #'org-agenda-todo-nextset)
  2058. (org-defkey org-agenda-mode-map [(control shift left)] #'org-agenda-todo-previousset)
  2059. (org-defkey org-agenda-mode-map "\C-c\C-xb" #'org-agenda-tree-to-indirect-buffer)
  2060. (org-defkey org-agenda-mode-map "o" #'delete-other-windows)
  2061. (org-defkey org-agenda-mode-map "L" #'org-agenda-recenter)
  2062. (org-defkey org-agenda-mode-map "\C-c\C-t" #'org-agenda-todo)
  2063. (org-defkey org-agenda-mode-map "t" #'org-agenda-todo)
  2064. (org-defkey org-agenda-mode-map "a" #'org-agenda-archive-default-with-confirmation)
  2065. (org-defkey org-agenda-mode-map ":" #'org-agenda-set-tags)
  2066. (org-defkey org-agenda-mode-map "\C-c\C-q" #'org-agenda-set-tags)
  2067. (org-defkey org-agenda-mode-map "." #'org-agenda-goto-today)
  2068. (org-defkey org-agenda-mode-map "j" #'org-agenda-goto-date)
  2069. (org-defkey org-agenda-mode-map "d" #'org-agenda-day-view)
  2070. (org-defkey org-agenda-mode-map "w" #'org-agenda-week-view)
  2071. (org-defkey org-agenda-mode-map "y" #'org-agenda-year-view)
  2072. (org-defkey org-agenda-mode-map "\C-c\C-z" #'org-agenda-add-note)
  2073. (org-defkey org-agenda-mode-map "z" #'org-agenda-add-note)
  2074. (org-defkey org-agenda-mode-map [(shift right)] #'org-agenda-do-date-later)
  2075. (org-defkey org-agenda-mode-map [(shift left)] #'org-agenda-do-date-earlier)
  2076. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] #'org-agenda-do-date-later)
  2077. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] #'org-agenda-do-date-earlier)
  2078. (org-defkey org-agenda-mode-map ">" #'org-agenda-date-prompt)
  2079. (org-defkey org-agenda-mode-map "\C-c\C-s" #'org-agenda-schedule)
  2080. (org-defkey org-agenda-mode-map "\C-c\C-d" #'org-agenda-deadline)
  2081. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2082. (while l (org-defkey org-agenda-mode-map
  2083. (number-to-string (pop l)) #'digit-argument)))
  2084. (org-defkey org-agenda-mode-map "F" #'org-agenda-follow-mode)
  2085. (org-defkey org-agenda-mode-map "R" #'org-agenda-clockreport-mode)
  2086. (org-defkey org-agenda-mode-map "E" #'org-agenda-entry-text-mode)
  2087. (org-defkey org-agenda-mode-map "l" #'org-agenda-log-mode)
  2088. (org-defkey org-agenda-mode-map "v" #'org-agenda-view-mode-dispatch)
  2089. (org-defkey org-agenda-mode-map "D" #'org-agenda-toggle-diary)
  2090. (org-defkey org-agenda-mode-map "!" #'org-agenda-toggle-deadlines)
  2091. (org-defkey org-agenda-mode-map "G" #'org-agenda-toggle-time-grid)
  2092. (org-defkey org-agenda-mode-map "r" #'org-agenda-redo)
  2093. (org-defkey org-agenda-mode-map "g" #'org-agenda-redo-all)
  2094. (org-defkey org-agenda-mode-map "e" #'org-agenda-set-effort)
  2095. (org-defkey org-agenda-mode-map "\C-c\C-xe" #'org-agenda-set-effort)
  2096. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2097. #'org-clock-modify-effort-estimate)
  2098. (org-defkey org-agenda-mode-map "\C-c\C-xp" #'org-agenda-set-property)
  2099. (org-defkey org-agenda-mode-map "q" #'org-agenda-quit)
  2100. (org-defkey org-agenda-mode-map "Q" #'org-agenda-Quit)
  2101. (org-defkey org-agenda-mode-map "x" #'org-agenda-exit)
  2102. (org-defkey org-agenda-mode-map "\C-x\C-w" #'org-agenda-write)
  2103. (org-defkey org-agenda-mode-map "\C-x\C-s" #'org-save-all-org-buffers)
  2104. (org-defkey org-agenda-mode-map "s" #'org-save-all-org-buffers)
  2105. (org-defkey org-agenda-mode-map "T" #'org-agenda-show-tags)
  2106. (org-defkey org-agenda-mode-map "n" #'org-agenda-next-line)
  2107. (org-defkey org-agenda-mode-map "p" #'org-agenda-previous-line)
  2108. (org-defkey org-agenda-mode-map "N" #'org-agenda-next-item)
  2109. (org-defkey org-agenda-mode-map "P" #'org-agenda-previous-item)
  2110. (substitute-key-definition #'next-line #'org-agenda-next-line
  2111. org-agenda-mode-map global-map)
  2112. (substitute-key-definition #'previous-line #'org-agenda-previous-line
  2113. org-agenda-mode-map global-map)
  2114. (org-defkey org-agenda-mode-map "\C-c\C-a" #'org-attach)
  2115. (org-defkey org-agenda-mode-map "\C-c\C-n" #'org-agenda-next-date-line)
  2116. (org-defkey org-agenda-mode-map "\C-c\C-p" #'org-agenda-previous-date-line)
  2117. (org-defkey org-agenda-mode-map "\C-c," #'org-agenda-priority)
  2118. (org-defkey org-agenda-mode-map "," #'org-agenda-priority)
  2119. (org-defkey org-agenda-mode-map "i" #'org-agenda-diary-entry)
  2120. (org-defkey org-agenda-mode-map "c" #'org-agenda-goto-calendar)
  2121. (org-defkey org-agenda-mode-map "C" #'org-agenda-convert-date)
  2122. (org-defkey org-agenda-mode-map "M" #'org-agenda-phases-of-moon)
  2123. (org-defkey org-agenda-mode-map "S" #'org-agenda-sunrise-sunset)
  2124. (org-defkey org-agenda-mode-map "h" #'org-agenda-holidays)
  2125. (org-defkey org-agenda-mode-map "H" #'org-agenda-holidays)
  2126. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" #'org-agenda-clock-in)
  2127. (org-defkey org-agenda-mode-map "I" #'org-agenda-clock-in)
  2128. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" #'org-agenda-clock-out)
  2129. (org-defkey org-agenda-mode-map "O" #'org-agenda-clock-out)
  2130. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" #'org-agenda-clock-cancel)
  2131. (org-defkey org-agenda-mode-map "X" #'org-agenda-clock-cancel)
  2132. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" #'org-clock-goto)
  2133. (org-defkey org-agenda-mode-map "J" #'org-agenda-clock-goto)
  2134. (org-defkey org-agenda-mode-map "+" #'org-agenda-priority-up)
  2135. (org-defkey org-agenda-mode-map "-" #'org-agenda-priority-down)
  2136. (org-defkey org-agenda-mode-map [(shift up)] #'org-agenda-priority-up)
  2137. (org-defkey org-agenda-mode-map [(shift down)] #'org-agenda-priority-down)
  2138. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] #'org-agenda-priority-up)
  2139. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] #'org-agenda-priority-down)
  2140. (org-defkey org-agenda-mode-map "f" #'org-agenda-later)
  2141. (org-defkey org-agenda-mode-map "b" #'org-agenda-earlier)
  2142. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" #'org-agenda-columns)
  2143. (org-defkey org-agenda-mode-map "\C-c\C-x>" #'org-agenda-remove-restriction-lock)
  2144. (org-defkey org-agenda-mode-map "\C-c\C-x<" #'org-agenda-set-restriction-lock-from-agenda)
  2145. (org-defkey org-agenda-mode-map "[" #'org-agenda-manipulate-query-add)
  2146. (org-defkey org-agenda-mode-map "]" #'org-agenda-manipulate-query-subtract)
  2147. (org-defkey org-agenda-mode-map "{" #'org-agenda-manipulate-query-add-re)
  2148. (org-defkey org-agenda-mode-map "}" #'org-agenda-manipulate-query-subtract-re)
  2149. (org-defkey org-agenda-mode-map "\\" #'org-agenda-filter-by-tag)
  2150. (org-defkey org-agenda-mode-map "_" #'org-agenda-filter-by-effort)
  2151. (org-defkey org-agenda-mode-map "=" #'org-agenda-filter-by-regexp)
  2152. (org-defkey org-agenda-mode-map "/" #'org-agenda-filter)
  2153. (org-defkey org-agenda-mode-map "|" #'org-agenda-filter-remove-all)
  2154. (org-defkey org-agenda-mode-map "~" #'org-agenda-limit-interactively)
  2155. (org-defkey org-agenda-mode-map "<" #'org-agenda-filter-by-category)
  2156. (org-defkey org-agenda-mode-map "^" #'org-agenda-filter-by-top-headline)
  2157. (org-defkey org-agenda-mode-map ";" #'org-timer-set-timer)
  2158. (org-defkey org-agenda-mode-map "\C-c\C-x_" #'org-timer-stop)
  2159. (org-defkey org-agenda-mode-map "?" #'org-agenda-show-the-flagging-note)
  2160. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" #'org-mobile-pull)
  2161. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" #'org-mobile-push)
  2162. (org-defkey org-agenda-mode-map "\C-c\C-xI" #'org-info-find-node)
  2163. (org-defkey org-agenda-mode-map [mouse-2] #'org-agenda-goto-mouse)
  2164. (org-defkey org-agenda-mode-map [mouse-3] #'org-agenda-show-mouse)
  2165. (org-defkey org-agenda-mode-map [remap forward-paragraph] #'org-agenda-forward-block)
  2166. (org-defkey org-agenda-mode-map [remap backward-paragraph] #'org-agenda-backward-block)
  2167. (org-defkey org-agenda-mode-map "\C-c\C-c" #'org-agenda-ctrl-c-ctrl-c)
  2168. (when org-agenda-mouse-1-follows-link
  2169. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2170. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2171. '("Agenda"
  2172. ("Agenda Files")
  2173. "--"
  2174. ("Agenda Dates"
  2175. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2176. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2177. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2178. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2179. "--"
  2180. ("View"
  2181. ["Day View" org-agenda-day-view
  2182. :active (org-agenda-check-type nil 'agenda)
  2183. :style radio :selected (eq org-agenda-current-span 'day)
  2184. :keys "v d (or just d)"]
  2185. ["Week View" org-agenda-week-view
  2186. :active (org-agenda-check-type nil 'agenda)
  2187. :style radio :selected (eq org-agenda-current-span 'week)
  2188. :keys "v w"]
  2189. ["Fortnight View" org-agenda-fortnight-view
  2190. :active (org-agenda-check-type nil 'agenda)
  2191. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2192. :keys "v t"]
  2193. ["Month View" org-agenda-month-view
  2194. :active (org-agenda-check-type nil 'agenda)
  2195. :style radio :selected (eq org-agenda-current-span 'month)
  2196. :keys "v m"]
  2197. ["Year View" org-agenda-year-view
  2198. :active (org-agenda-check-type nil 'agenda)
  2199. :style radio :selected (eq org-agenda-current-span 'year)
  2200. :keys "v y"]
  2201. "--"
  2202. ["Include Diary" org-agenda-toggle-diary
  2203. :style toggle :selected org-agenda-include-diary
  2204. :active (org-agenda-check-type nil 'agenda)]
  2205. ["Include Deadlines" org-agenda-toggle-deadlines
  2206. :style toggle :selected org-agenda-include-deadlines
  2207. :active (org-agenda-check-type nil 'agenda)]
  2208. ["Use Time Grid" org-agenda-toggle-time-grid
  2209. :style toggle :selected org-agenda-use-time-grid
  2210. :active (org-agenda-check-type nil 'agenda)]
  2211. "--"
  2212. ["Show clock report" org-agenda-clockreport-mode
  2213. :style toggle :selected org-agenda-clockreport-mode
  2214. :active (org-agenda-check-type nil 'agenda)]
  2215. ["Show some entry text" org-agenda-entry-text-mode
  2216. :style toggle :selected org-agenda-entry-text-mode
  2217. :active t]
  2218. "--"
  2219. ["Show Logbook entries" org-agenda-log-mode
  2220. :style toggle :selected org-agenda-show-log
  2221. :active (org-agenda-check-type nil 'agenda)
  2222. :keys "v l (or just l)"]
  2223. ["Include archived trees" org-agenda-archives-mode
  2224. :style toggle :selected org-agenda-archives-mode :active t
  2225. :keys "v a"]
  2226. ["Include archive files" (org-agenda-archives-mode t)
  2227. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2228. :keys "v A"]
  2229. "--"
  2230. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2231. ("Filter current view"
  2232. ["with generic interface" org-agenda-filter t]
  2233. "--"
  2234. ["by category at cursor" org-agenda-filter-by-category t]
  2235. ["by tag" org-agenda-filter-by-tag t]
  2236. ["by effort" org-agenda-filter-by-effort t]
  2237. ["by regexp" org-agenda-filter-by-regexp t]
  2238. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2239. "--"
  2240. ["Remove all filtering" org-agenda-filter-remove-all t]
  2241. "--"
  2242. ["limit" org-agenda-limit-interactively t])
  2243. ["Rebuild buffer" org-agenda-redo t]
  2244. ["Write view to file" org-agenda-write t]
  2245. ["Save all Org buffers" org-save-all-org-buffers t]
  2246. "--"
  2247. ["Show original entry" org-agenda-show t]
  2248. ["Go To (other window)" org-agenda-goto t]
  2249. ["Go To (this window)" org-agenda-switch-to t]
  2250. ["Capture with cursor date" org-agenda-capture t]
  2251. ["Follow Mode" org-agenda-follow-mode
  2252. :style toggle :selected org-agenda-follow-mode :active t]
  2253. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2254. "--"
  2255. ("TODO"
  2256. ["Cycle TODO" org-agenda-todo t]
  2257. ["Next TODO set" org-agenda-todo-nextset t]
  2258. ["Previous TODO set" org-agenda-todo-previousset t]
  2259. ["Add note" org-agenda-add-note t])
  2260. ("Archive/Refile/Delete"
  2261. ["Archive default" org-agenda-archive-default t]
  2262. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2263. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2264. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2265. ["Archive subtree" org-agenda-archive t]
  2266. "--"
  2267. ["Refile" org-agenda-refile t]
  2268. "--"
  2269. ["Delete subtree" org-agenda-kill t])
  2270. ("Bulk action"
  2271. ["Mark entry" org-agenda-bulk-mark t]
  2272. ["Mark all" org-agenda-bulk-mark-all t]
  2273. ["Unmark entry" org-agenda-bulk-unmark t]
  2274. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2275. ["Toggle mark" org-agenda-bulk-toggle t]
  2276. ["Toggle all" org-agenda-bulk-toggle-all t]
  2277. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2278. ["Act on all marked" org-agenda-bulk-action t]
  2279. "--"
  2280. ("Tags and Properties"
  2281. ["Show all Tags" org-agenda-show-tags t]
  2282. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2283. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2284. "--"
  2285. ["Column View" org-columns t])
  2286. ("Deadline/Schedule"
  2287. ["Schedule" org-agenda-schedule t]
  2288. ["Set Deadline" org-agenda-deadline t]
  2289. "--"
  2290. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2291. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2292. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2293. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2294. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2295. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2296. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2297. ("Clock and Effort"
  2298. ["Clock in" org-agenda-clock-in t]
  2299. ["Clock out" org-agenda-clock-out t]
  2300. ["Clock cancel" org-agenda-clock-cancel t]
  2301. ["Goto running clock" org-clock-goto t]
  2302. "--"
  2303. ["Set Effort" org-agenda-set-effort t]
  2304. ["Change clocked effort" org-clock-modify-effort-estimate
  2305. (org-clock-is-active)])
  2306. ("Priority"
  2307. ["Set Priority" org-agenda-priority t]
  2308. ["Increase Priority" org-agenda-priority-up t]
  2309. ["Decrease Priority" org-agenda-priority-down t]
  2310. ["Show Priority" org-priority-show t])
  2311. ("Calendar/Diary"
  2312. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2313. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2314. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2315. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2316. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2317. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2318. "--"
  2319. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2320. "--"
  2321. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2322. "--"
  2323. ("MobileOrg"
  2324. ["Push Files and Views" org-mobile-push t]
  2325. ["Get Captured and Flagged" org-mobile-pull t]
  2326. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2327. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2328. "--"
  2329. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2330. "--"
  2331. ["Quit" org-agenda-quit t]
  2332. ["Exit and Release Buffers" org-agenda-exit t]
  2333. ))
  2334. ;;; Agenda undo
  2335. (defvar org-agenda-allow-remote-undo t
  2336. "Non-nil means allow remote undo from the agenda buffer.")
  2337. (defvar org-agenda-undo-has-started-in nil
  2338. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2339. (defun org-agenda-undo ()
  2340. "Undo a remote editing step in the agenda.
  2341. This undoes changes both in the agenda buffer and in the remote buffer
  2342. that have been changed along."
  2343. (interactive)
  2344. (or org-agenda-allow-remote-undo
  2345. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2346. (when (not (eq this-command last-command))
  2347. (setq org-agenda-undo-has-started-in nil
  2348. org-agenda-pending-undo-list org-agenda-undo-list))
  2349. (when (not org-agenda-pending-undo-list)
  2350. (user-error "No further undo information"))
  2351. (let* ((entry (pop org-agenda-pending-undo-list))
  2352. buf line cmd rembuf)
  2353. (setq cmd (pop entry) line (pop entry))
  2354. (setq rembuf (nth 2 entry))
  2355. (org-with-remote-undo rembuf
  2356. (while (bufferp (setq buf (pop entry)))
  2357. (when (pop entry)
  2358. (with-current-buffer buf
  2359. (let ((last-undo-buffer buf)
  2360. (inhibit-read-only t))
  2361. (unless (memq buf org-agenda-undo-has-started-in)
  2362. (push buf org-agenda-undo-has-started-in)
  2363. (make-local-variable 'pending-undo-list)
  2364. (undo-start))
  2365. (while (and pending-undo-list
  2366. (listp pending-undo-list)
  2367. (not (car pending-undo-list)))
  2368. (pop pending-undo-list))
  2369. (undo-more 1))))))
  2370. (org-goto-line line)
  2371. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2372. (defun org-verify-change-for-undo (l1 l2)
  2373. "Verify that a real change occurred between the undo lists L1 and L2."
  2374. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2375. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2376. (not (eq l1 l2)))
  2377. ;;; Agenda dispatch
  2378. (defvar org-agenda-restrict-begin (make-marker))
  2379. (defvar org-agenda-restrict-end (make-marker))
  2380. (defvar org-agenda-last-dispatch-buffer nil)
  2381. (defvar org-agenda-overriding-restriction nil)
  2382. (defcustom org-agenda-custom-commands-contexts nil
  2383. "Alist of custom agenda keys and contextual rules.
  2384. For example, if you have a custom agenda command \"p\" and you
  2385. want this command to be accessible only from plain text files,
  2386. use this:
  2387. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2388. Here are the available contexts definitions:
  2389. in-file: command displayed only in matching files
  2390. in-mode: command displayed only in matching modes
  2391. not-in-file: command not displayed in matching files
  2392. not-in-mode: command not displayed in matching modes
  2393. in-buffer: command displayed only in matching buffers
  2394. not-in-buffer: command not displayed in matching buffers
  2395. [function]: a custom function taking no argument
  2396. If you define several checks, the agenda command will be
  2397. accessible if there is at least one valid check.
  2398. You can also bind a key to another agenda custom command
  2399. depending on contextual rules.
  2400. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2401. Here it means: in .txt files, use \"p\" as the key for the
  2402. agenda command otherwise associated with \"q\". (The command
  2403. originally associated with \"q\" is not displayed to avoid
  2404. duplicates.)"
  2405. :version "24.3"
  2406. :group 'org-agenda-custom-commands
  2407. :type '(repeat (list :tag "Rule"
  2408. (string :tag " Agenda key")
  2409. (string :tag "Replace by command")
  2410. (repeat :tag "Available when"
  2411. (choice
  2412. (cons :tag "Condition"
  2413. (choice
  2414. (const :tag "In file" in-file)
  2415. (const :tag "Not in file" not-in-file)
  2416. (const :tag "In buffer" in-buffer)
  2417. (const :tag "Not in buffer" not-in-buffer)
  2418. (const :tag "In mode" in-mode)
  2419. (const :tag "Not in mode" not-in-mode))
  2420. (regexp))
  2421. (function :tag "Custom function"))))))
  2422. (defcustom org-agenda-max-entries nil
  2423. "Maximum number of entries to display in an agenda.
  2424. This can be nil (no limit) or an integer or an alist of agenda
  2425. types with an associated number of entries to display in this
  2426. type."
  2427. :version "24.4"
  2428. :package-version '(Org . "8.0")
  2429. :group 'org-agenda-custom-commands
  2430. :type '(choice (symbol :tag "No limit" nil)
  2431. (integer :tag "Max number of entries")
  2432. (repeat
  2433. (cons (choice :tag "Agenda type"
  2434. (const agenda)
  2435. (const todo)
  2436. (const tags)
  2437. (const search))
  2438. (integer :tag "Max number of entries")))))
  2439. (defcustom org-agenda-max-todos nil
  2440. "Maximum number of TODOs to display in an agenda.
  2441. This can be nil (no limit) or an integer or an alist of agenda
  2442. types with an associated number of entries to display in this
  2443. type."
  2444. :version "24.4"
  2445. :package-version '(Org . "8.0")
  2446. :group 'org-agenda-custom-commands
  2447. :type '(choice (symbol :tag "No limit" nil)
  2448. (integer :tag "Max number of TODOs")
  2449. (repeat
  2450. (cons (choice :tag "Agenda type"
  2451. (const agenda)
  2452. (const todo)
  2453. (const tags)
  2454. (const search))
  2455. (integer :tag "Max number of TODOs")))))
  2456. (defcustom org-agenda-max-tags nil
  2457. "Maximum number of tagged entries to display in an agenda.
  2458. This can be nil (no limit) or an integer or an alist of agenda
  2459. types with an associated number of entries to display in this
  2460. type."
  2461. :version "24.4"
  2462. :package-version '(Org . "8.0")
  2463. :group 'org-agenda-custom-commands
  2464. :type '(choice (symbol :tag "No limit" nil)
  2465. (integer :tag "Max number of tagged entries")
  2466. (repeat
  2467. (cons (choice :tag "Agenda type"
  2468. (const agenda)
  2469. (const todo)
  2470. (const tags)
  2471. (const search))
  2472. (integer :tag "Max number of tagged entries")))))
  2473. (defcustom org-agenda-max-effort nil
  2474. "Maximum cumulated effort duration for the agenda.
  2475. This can be nil (no limit) or a number of minutes (as an integer)
  2476. or an alist of agenda types with an associated number of minutes
  2477. to limit entries to in this type."
  2478. :version "24.4"
  2479. :package-version '(Org . "8.0")
  2480. :group 'org-agenda-custom-commands
  2481. :type '(choice (symbol :tag "No limit" nil)
  2482. (integer :tag "Max number of minutes")
  2483. (repeat
  2484. (cons (choice :tag "Agenda type"
  2485. (const agenda)
  2486. (const todo)
  2487. (const tags)
  2488. (const search))
  2489. (integer :tag "Max number of minutes")))))
  2490. (defvar org-agenda-keep-restricted-file-list nil)
  2491. (defvar org-keys nil)
  2492. (defvar org-match nil)
  2493. ;;;###autoload
  2494. (defun org-agenda (&optional arg org-keys restriction)
  2495. "Dispatch agenda commands to collect entries to the agenda buffer.
  2496. Prompts for a command to execute. Any prefix arg will be passed
  2497. on to the selected command. The default selections are:
  2498. a Call `org-agenda-list' to display the agenda for current day or week.
  2499. t Call `org-todo-list' to display the global todo list.
  2500. T Call `org-todo-list' to display the global todo list, select only
  2501. entries with a specific TODO keyword (the user gets a prompt).
  2502. m Call `org-tags-view' to display headlines with tags matching
  2503. a condition (the user is prompted for the condition).
  2504. M Like `m', but select only TODO entries, no ordinary headlines.
  2505. e Export views to associated files.
  2506. s Search entries for keywords.
  2507. S Search entries for keywords, only with TODO keywords.
  2508. / Multi occur across all agenda files and also files listed
  2509. in `org-agenda-text-search-extra-files'.
  2510. < Restrict agenda commands to buffer, subtree, or region.
  2511. Press several times to get the desired effect.
  2512. > Remove a previous restriction.
  2513. # List \"stuck\" projects.
  2514. ! Configure what \"stuck\" means.
  2515. C Configure custom agenda commands.
  2516. More commands can be added by configuring the variable
  2517. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2518. searches can be pre-defined in this way.
  2519. If the current buffer is in Org mode and visiting a file, you can also
  2520. first press `<' once to indicate that the agenda should be temporarily
  2521. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2522. Pressing `<' twice means to restrict to the current subtree or region
  2523. \(if active)."
  2524. (interactive "P")
  2525. (catch 'exit
  2526. (let* ((prefix-descriptions nil)
  2527. (org-agenda-buffer-name org-agenda-buffer-name)
  2528. (org-agenda-window-setup (if (equal (buffer-name)
  2529. org-agenda-buffer-name)
  2530. 'current-window
  2531. org-agenda-window-setup))
  2532. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2533. (org-agenda-custom-commands
  2534. ;; normalize different versions
  2535. (delq nil
  2536. (mapcar
  2537. (lambda (x)
  2538. (cond ((stringp (cdr x))
  2539. (push x prefix-descriptions)
  2540. nil)
  2541. ((stringp (nth 1 x)) x)
  2542. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2543. (t (cons (car x) (cons "" (cdr x))))))
  2544. org-agenda-custom-commands)))
  2545. (org-agenda-custom-commands
  2546. (org-contextualize-keys
  2547. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2548. (buf (current-buffer))
  2549. (bfn (buffer-file-name (buffer-base-buffer)))
  2550. entry key type org-match lprops ans)
  2551. ;; Turn off restriction unless there is an overriding one,
  2552. (unless org-agenda-overriding-restriction
  2553. (unless org-agenda-keep-restricted-file-list
  2554. ;; There is a request to keep the file list in place
  2555. (put 'org-agenda-files 'org-restrict nil))
  2556. (setq org-agenda-restrict nil)
  2557. (move-marker org-agenda-restrict-begin nil)
  2558. (move-marker org-agenda-restrict-end nil))
  2559. ;; Delete old local properties
  2560. (put 'org-agenda-redo-command 'org-lprops nil)
  2561. ;; Delete previously set last-arguments
  2562. (put 'org-agenda-redo-command 'last-args nil)
  2563. ;; Remember where this call originated
  2564. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2565. (unless org-keys
  2566. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2567. org-keys (car ans)
  2568. restriction (cdr ans)))
  2569. ;; If we have sticky agenda buffers, set a name for the buffer,
  2570. ;; depending on the invoking keys. The user may still set this
  2571. ;; as a command option, which will overwrite what we do here.
  2572. (when org-agenda-sticky
  2573. (setq org-agenda-buffer-name
  2574. (format "*Org Agenda(%s)*" org-keys)))
  2575. ;; Establish the restriction, if any
  2576. (when (and (not org-agenda-overriding-restriction) restriction)
  2577. (put 'org-agenda-files 'org-restrict (list bfn))
  2578. (cond
  2579. ((eq restriction 'region)
  2580. (setq org-agenda-restrict (current-buffer))
  2581. (move-marker org-agenda-restrict-begin (region-beginning))
  2582. (move-marker org-agenda-restrict-end (region-end)))
  2583. ((eq restriction 'subtree)
  2584. (save-excursion
  2585. (setq org-agenda-restrict (current-buffer))
  2586. (org-back-to-heading t)
  2587. (move-marker org-agenda-restrict-begin (point))
  2588. (move-marker org-agenda-restrict-end
  2589. (progn (org-end-of-subtree t)))))
  2590. ((and (eq restriction 'buffer)
  2591. (or (< 1 (point-min))
  2592. (< (point-max) (1+ (buffer-size)))))
  2593. (setq org-agenda-restrict (current-buffer))
  2594. (move-marker org-agenda-restrict-begin (point-min))
  2595. (move-marker org-agenda-restrict-end (point-max)))))
  2596. ;; For example the todo list should not need it (but does...)
  2597. (cond
  2598. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2599. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2600. (progn
  2601. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2602. lprops (nth 4 entry))
  2603. (when org-agenda-sticky
  2604. (setq org-agenda-buffer-name
  2605. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2606. (format "*Org Agenda(%s)*" org-keys))))
  2607. (put 'org-agenda-redo-command 'org-lprops lprops)
  2608. (cond
  2609. ((eq type 'agenda)
  2610. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2611. ((eq type 'agenda*)
  2612. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2613. ((eq type 'alltodo)
  2614. (org-let lprops '(org-todo-list current-prefix-arg)))
  2615. ((eq type 'search)
  2616. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2617. ((eq type 'stuck)
  2618. (org-let lprops '(org-agenda-list-stuck-projects
  2619. current-prefix-arg)))
  2620. ((eq type 'tags)
  2621. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2622. ((eq type 'tags-todo)
  2623. (org-let lprops '(org-tags-view '(4) org-match)))
  2624. ((eq type 'todo)
  2625. (org-let lprops '(org-todo-list org-match)))
  2626. ((eq type 'tags-tree)
  2627. (org-check-for-org-mode)
  2628. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2629. ((eq type 'todo-tree)
  2630. (org-check-for-org-mode)
  2631. (org-let lprops
  2632. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2633. (regexp-quote org-match) "\\>"))))
  2634. ((eq type 'occur-tree)
  2635. (org-check-for-org-mode)
  2636. (org-let lprops '(org-occur org-match)))
  2637. ((functionp type)
  2638. (org-let lprops '(funcall type org-match)))
  2639. ((fboundp type)
  2640. (org-let lprops '(funcall type org-match)))
  2641. (t (user-error "Invalid custom agenda command type %s" type))))
  2642. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2643. ((equal org-keys "C")
  2644. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2645. (customize-variable 'org-agenda-custom-commands))
  2646. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2647. ((equal org-keys "s") (call-interactively 'org-search-view))
  2648. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2649. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2650. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2651. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2652. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2653. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2654. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2655. (add-hook
  2656. 'post-command-hook
  2657. (lambda ()
  2658. (unless (current-message)
  2659. (let* ((m (org-agenda-get-any-marker))
  2660. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2661. (when note
  2662. (message "FLAGGING-NOTE ([?] for more info): %s"
  2663. (org-add-props
  2664. (replace-regexp-in-string
  2665. "\\\\n" "//"
  2666. (copy-sequence note))
  2667. nil 'face 'org-warning))))))
  2668. t t))
  2669. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2670. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2671. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2672. (t (user-error "Invalid agenda key"))))))
  2673. (defvar org-agenda-multi)
  2674. (defun org-agenda-append-agenda ()
  2675. "Append another agenda view to the current one.
  2676. This function allows interactive building of block agendas.
  2677. Agenda views are separated by `org-agenda-block-separator'."
  2678. (interactive)
  2679. (unless (derived-mode-p 'org-agenda-mode)
  2680. (user-error "Can only append from within agenda buffer"))
  2681. (let ((org-agenda-multi t))
  2682. (org-agenda)
  2683. (widen)
  2684. (org-agenda-finalize)
  2685. (setq buffer-read-only t)
  2686. (org-agenda-fit-window-to-buffer)))
  2687. (defun org-agenda-normalize-custom-commands (cmds)
  2688. "Normalize custom commands CMDS."
  2689. (delq nil
  2690. (mapcar
  2691. (lambda (x)
  2692. (cond ((stringp (cdr x)) nil)
  2693. ((stringp (nth 1 x)) x)
  2694. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2695. (t (cons (car x) (cons "" (cdr x))))))
  2696. cmds)))
  2697. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2698. "The user interface for selecting an agenda command."
  2699. (catch 'exit
  2700. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2701. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2702. (region-p (org-region-active-p))
  2703. (custom org-agenda-custom-commands)
  2704. (selstring "")
  2705. restriction second-time
  2706. c entry key type match prefixes rmheader header-end custom1 desc
  2707. line lines left right n n1)
  2708. (save-window-excursion
  2709. (delete-other-windows)
  2710. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2711. (erase-buffer)
  2712. (insert (eval-when-compile
  2713. (let ((header
  2714. "Press key for an agenda command:
  2715. -------------------------------- < Buffer, subtree/region restriction
  2716. a Agenda for current week or day > Remove restriction
  2717. t List of all TODO entries e Export agenda views
  2718. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2719. s Search for keywords M Like m, but only TODO entries
  2720. / Multi-occur S Like s, but only TODO entries
  2721. ? Find :FLAGGED: entries C Configure custom agenda commands
  2722. * Toggle sticky agenda views # List stuck projects (!=configure)
  2723. ")
  2724. (start 0))
  2725. (while (string-match
  2726. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2727. header start)
  2728. (setq start (match-end 0))
  2729. (add-text-properties (match-beginning 2) (match-end 2)
  2730. '(face bold) header))
  2731. header)))
  2732. (setq header-end (point-marker))
  2733. (while t
  2734. (setq custom1 custom)
  2735. (when (eq rmheader t)
  2736. (org-goto-line 1)
  2737. (re-search-forward ":" nil t)
  2738. (delete-region (match-end 0) (point-at-eol))
  2739. (forward-char 1)
  2740. (looking-at "-+")
  2741. (delete-region (match-end 0) (point-at-eol))
  2742. (move-marker header-end (match-end 0)))
  2743. (goto-char header-end)
  2744. (delete-region (point) (point-max))
  2745. ;; Produce all the lines that describe custom commands and prefixes
  2746. (setq lines nil)
  2747. (while (setq entry (pop custom1))
  2748. (setq key (car entry) desc (nth 1 entry)
  2749. type (nth 2 entry)
  2750. match (nth 3 entry))
  2751. (if (> (length key) 1)
  2752. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2753. (setq line
  2754. (format
  2755. "%-4s%-14s"
  2756. (org-add-props (copy-sequence key)
  2757. '(face bold))
  2758. (cond
  2759. ((string-match "\\S-" desc) desc)
  2760. ((eq type 'agenda) "Agenda for current week or day")
  2761. ((eq type 'agenda*) "Appointments for current week or day")
  2762. ((eq type 'alltodo) "List of all TODO entries")
  2763. ((eq type 'search) "Word search")
  2764. ((eq type 'stuck) "List of stuck projects")
  2765. ((eq type 'todo) "TODO keyword")
  2766. ((eq type 'tags) "Tags query")
  2767. ((eq type 'tags-todo) "Tags (TODO)")
  2768. ((eq type 'tags-tree) "Tags tree")
  2769. ((eq type 'todo-tree) "TODO kwd tree")
  2770. ((eq type 'occur-tree) "Occur tree")
  2771. ((functionp type) (if (symbolp type)
  2772. (symbol-name type)
  2773. "Lambda expression"))
  2774. (t "???"))))
  2775. (cond
  2776. ((not (org-string-nw-p match)) nil)
  2777. (org-agenda-menu-show-matcher
  2778. (setq line
  2779. (concat line ": "
  2780. (cond
  2781. ((stringp match)
  2782. (propertize match 'face 'org-warning))
  2783. ((listp type)
  2784. (format "set of %d commands" (length type)))))))
  2785. (t
  2786. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2787. (push line lines)))
  2788. (setq lines (nreverse lines))
  2789. (when prefixes
  2790. (mapc (lambda (x)
  2791. (push
  2792. (format "%s %s"
  2793. (org-add-props (char-to-string x)
  2794. nil 'face 'bold)
  2795. (or (cdr (assoc (concat selstring
  2796. (char-to-string x))
  2797. prefix-descriptions))
  2798. "Prefix key"))
  2799. lines))
  2800. prefixes))
  2801. ;; Check if we should display in two columns
  2802. (if org-agenda-menu-two-columns
  2803. (progn
  2804. (setq n (length lines)
  2805. n1 (+ (/ n 2) (mod n 2))
  2806. right (nthcdr n1 lines)
  2807. left (copy-sequence lines))
  2808. (setcdr (nthcdr (1- n1) left) nil))
  2809. (setq left lines right nil))
  2810. (while left
  2811. (insert "\n" (pop left))
  2812. (when right
  2813. (if (< (current-column) 40)
  2814. (move-to-column 40 t)
  2815. (insert " "))
  2816. (insert (pop right))))
  2817. ;; Make the window the right size
  2818. (goto-char (point-min))
  2819. (if second-time
  2820. (when (not (pos-visible-in-window-p (point-max)))
  2821. (org-fit-window-to-buffer))
  2822. (setq second-time t)
  2823. (org-fit-window-to-buffer))
  2824. ;; Hint to navigation if window too small for all information
  2825. (setq header-line-format
  2826. (when (not (pos-visible-in-window-p (point-max)))
  2827. "Use C-v, M-v, C-n or C-p to navigate."))
  2828. ;; Ask for selection
  2829. (cl-loop
  2830. do (progn
  2831. (message "Press key for agenda command%s:"
  2832. (if (or restrict-ok org-agenda-overriding-restriction)
  2833. (if org-agenda-overriding-restriction
  2834. " (restriction lock active)"
  2835. (if restriction
  2836. (format " (restricted to %s)" restriction)
  2837. " (unrestricted)"))
  2838. ""))
  2839. (setq c (read-char-exclusive)))
  2840. until (not (memq c '(14 16 22 134217846)))
  2841. do (org-scroll c))
  2842. (message "")
  2843. (cond
  2844. ((assoc (char-to-string c) custom)
  2845. (setq selstring (concat selstring (char-to-string c)))
  2846. (throw 'exit (cons selstring restriction)))
  2847. ((memq c prefixes)
  2848. (setq selstring (concat selstring (char-to-string c))
  2849. prefixes nil
  2850. rmheader (or rmheader t)
  2851. custom (delq nil (mapcar
  2852. (lambda (x)
  2853. (if (or (= (length (car x)) 1)
  2854. (/= (string-to-char (car x)) c))
  2855. nil
  2856. (cons (substring (car x) 1) (cdr x))))
  2857. custom))))
  2858. ((eq c ?*)
  2859. (call-interactively 'org-toggle-sticky-agenda)
  2860. (sit-for 2))
  2861. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2862. (message "Restriction is only possible in Org buffers")
  2863. (ding) (sit-for 1))
  2864. ((eq c ?1)
  2865. (org-agenda-remove-restriction-lock 'noupdate)
  2866. (setq restriction 'buffer))
  2867. ((eq c ?0)
  2868. (org-agenda-remove-restriction-lock 'noupdate)
  2869. (setq restriction (if region-p 'region 'subtree)))
  2870. ((eq c ?<)
  2871. (org-agenda-remove-restriction-lock 'noupdate)
  2872. (setq restriction
  2873. (cond
  2874. ((eq restriction 'buffer)
  2875. (if region-p 'region 'subtree))
  2876. ((memq restriction '(subtree region))
  2877. nil)
  2878. (t 'buffer))))
  2879. ((eq c ?>)
  2880. (org-agenda-remove-restriction-lock 'noupdate)
  2881. (setq restriction nil))
  2882. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2883. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2884. ((and (> (length selstring) 0) (eq c ?\d))
  2885. (delete-window)
  2886. (org-agenda-get-restriction-and-command prefix-descriptions))
  2887. ((equal c ?q) (error "Abort"))
  2888. (t (user-error "Invalid key %c" c))))))))
  2889. (defun org-agenda-fit-window-to-buffer ()
  2890. "Fit the window to the buffer size."
  2891. (and (memq org-agenda-window-setup '(reorganize-frame))
  2892. (fboundp 'fit-window-to-buffer)
  2893. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2894. (= (car org-agenda-window-frame-fractions) 1.0))
  2895. (delete-other-windows)
  2896. (org-fit-window-to-buffer
  2897. nil
  2898. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2899. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2900. (defvar org-cmd nil)
  2901. (defvar org-agenda-overriding-cmd nil)
  2902. (defvar org-agenda-overriding-arguments nil)
  2903. (defvar org-agenda-overriding-cmd-arguments nil)
  2904. (defun org-agenda-run-series (name series)
  2905. "Run agenda NAME as a SERIES of agenda commands."
  2906. (org-let (nth 1 series) '(org-agenda-prepare name))
  2907. ;; We need to reset agenda markers here, because when constructing a
  2908. ;; block agenda, the individual blocks do not do that.
  2909. (org-agenda-reset-markers)
  2910. (let* ((org-agenda-multi t)
  2911. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2912. (cmds (car series))
  2913. (gprops (nth 1 series))
  2914. match ;; The byte compiler incorrectly complains about this. Keep it!
  2915. org-cmd type lprops)
  2916. (while (setq org-cmd (pop cmds))
  2917. (setq type (car org-cmd))
  2918. (setq match (eval (nth 1 org-cmd)))
  2919. (setq lprops (nth 2 org-cmd))
  2920. (let ((org-agenda-overriding-arguments
  2921. (if (eq org-agenda-overriding-cmd org-cmd)
  2922. (or org-agenda-overriding-arguments
  2923. org-agenda-overriding-cmd-arguments))))
  2924. (cond
  2925. ((eq type 'agenda)
  2926. (org-let2 gprops lprops
  2927. '(call-interactively 'org-agenda-list)))
  2928. ((eq type 'agenda*)
  2929. (org-let2 gprops lprops
  2930. '(funcall 'org-agenda-list nil nil t)))
  2931. ((eq type 'alltodo)
  2932. (org-let2 gprops lprops
  2933. '(call-interactively 'org-todo-list)))
  2934. ((eq type 'search)
  2935. (org-let2 gprops lprops
  2936. '(org-search-view current-prefix-arg match nil)))
  2937. ((eq type 'stuck)
  2938. (org-let2 gprops lprops
  2939. '(call-interactively 'org-agenda-list-stuck-projects)))
  2940. ((eq type 'tags)
  2941. (org-let2 gprops lprops
  2942. '(org-tags-view current-prefix-arg match)))
  2943. ((eq type 'tags-todo)
  2944. (org-let2 gprops lprops
  2945. '(org-tags-view '(4) match)))
  2946. ((eq type 'todo)
  2947. (org-let2 gprops lprops
  2948. '(org-todo-list match)))
  2949. ((fboundp type)
  2950. (org-let2 gprops lprops
  2951. '(funcall type match)))
  2952. (t (error "Invalid type in command series")))))
  2953. (widen)
  2954. (let ((inhibit-read-only t))
  2955. (add-text-properties (point-min) (point-max)
  2956. `(org-series t org-series-redo-cmd ,redo)))
  2957. (setq org-agenda-redo-command redo)
  2958. (goto-char (point-min)))
  2959. (org-agenda-fit-window-to-buffer)
  2960. (org-let (nth 1 series) '(org-agenda-finalize)))
  2961. ;;;###autoload
  2962. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2963. "Run an agenda command in batch mode and send the result to STDOUT.
  2964. If CMD-KEY is a string of length 1, it is used as a key in
  2965. `org-agenda-custom-commands' and triggers this command. If it is a
  2966. longer string it is used as a tags/todo match string.
  2967. Parameters are alternating variable names and values that will be bound
  2968. before running the agenda command."
  2969. (org-eval-in-environment (org-make-parameter-alist parameters)
  2970. (let (org-agenda-sticky)
  2971. (if (> (length cmd-key) 1)
  2972. (org-tags-view nil cmd-key)
  2973. (org-agenda nil cmd-key))))
  2974. (set-buffer org-agenda-buffer-name)
  2975. (princ (buffer-string)))
  2976. (defvar org-agenda-info nil)
  2977. ;;;###autoload
  2978. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2979. "Run an agenda command in batch mode and send the result to STDOUT.
  2980. If CMD-KEY is a string of length 1, it is used as a key in
  2981. `org-agenda-custom-commands' and triggers this command. If it is a
  2982. longer string it is used as a tags/todo match string.
  2983. Parameters are alternating variable names and values that will be bound
  2984. before running the agenda command.
  2985. The output gives a line for each selected agenda item. Each
  2986. item is a list of comma-separated values, like this:
  2987. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2988. category The category of the item
  2989. head The headline, without TODO kwd, TAGS and PRIORITY
  2990. type The type of the agenda entry, can be
  2991. todo selected in TODO match
  2992. tagsmatch selected in tags match
  2993. diary imported from diary
  2994. deadline a deadline on given date
  2995. scheduled scheduled on given date
  2996. timestamp entry has timestamp on given date
  2997. closed entry was closed on given date
  2998. upcoming-deadline warning about deadline
  2999. past-scheduled forwarded scheduled item
  3000. block entry has date block including g. date
  3001. todo The todo keyword, if any
  3002. tags All tags including inherited ones, separated by colons
  3003. date The relevant date, like 2007-2-14
  3004. time The time, like 15:00-16:50
  3005. extra String with extra planning info
  3006. priority-l The priority letter if any was given
  3007. priority-n The computed numerical priority
  3008. agenda-day The day in the agenda where this is listed"
  3009. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  3010. (org-make-parameter-alist parameters))
  3011. (if (> (length cmd-key) 2)
  3012. (org-tags-view nil cmd-key)
  3013. (org-agenda nil cmd-key)))
  3014. (set-buffer org-agenda-buffer-name)
  3015. (let ((lines (org-split-string (buffer-string) "\n")))
  3016. (dolist (line lines)
  3017. (when (get-text-property 0 'org-category line)
  3018. (setq org-agenda-info
  3019. (org-fix-agenda-info (text-properties-at 0 line)))
  3020. (princ
  3021. (mapconcat 'org-agenda-export-csv-mapper
  3022. '(org-category txt type todo tags date time extra
  3023. priority-letter priority agenda-day)
  3024. ","))
  3025. (princ "\n")))))
  3026. (defun org-fix-agenda-info (props)
  3027. "Make sure all properties on an agenda item have a canonical form.
  3028. This ensures the export commands can easily use it."
  3029. (let (tmp re)
  3030. (when (setq tmp (plist-get props 'tags))
  3031. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  3032. (when (setq tmp (plist-get props 'date))
  3033. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3034. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3035. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3036. (setq tmp (calendar-date-string tmp)))
  3037. (setq props (plist-put props 'date tmp)))
  3038. (when (setq tmp (plist-get props 'day))
  3039. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3040. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3041. (setq tmp (calendar-date-string tmp)))
  3042. (setq props (plist-put props 'day tmp))
  3043. (setq props (plist-put props 'agenda-day tmp)))
  3044. (when (setq tmp (plist-get props 'txt))
  3045. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3046. (plist-put props 'priority-letter (match-string 1 tmp))
  3047. (setq tmp (replace-match "" t t tmp)))
  3048. (when (and (setq re (plist-get props 'org-todo-regexp))
  3049. (setq re (concat "\\`\\.*" re " ?"))
  3050. (let ((case-fold-search nil)) (string-match re tmp)))
  3051. (plist-put props 'todo (match-string 1 tmp))
  3052. (setq tmp (replace-match "" t t tmp)))
  3053. (plist-put props 'txt tmp)))
  3054. props)
  3055. (defun org-agenda-export-csv-mapper (prop)
  3056. (let ((res (plist-get org-agenda-info prop)))
  3057. (setq res
  3058. (cond
  3059. ((not res) "")
  3060. ((stringp res) res)
  3061. (t (prin1-to-string res))))
  3062. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3063. ;;;###autoload
  3064. (defun org-store-agenda-views (&rest parameters)
  3065. "Store agenda views."
  3066. (interactive)
  3067. (eval (list 'org-batch-store-agenda-views)))
  3068. ;;;###autoload
  3069. (defmacro org-batch-store-agenda-views (&rest parameters)
  3070. "Run all custom agenda commands that have a file argument."
  3071. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3072. (pop-up-frames nil)
  3073. (dir default-directory)
  3074. (pars (org-make-parameter-alist parameters))
  3075. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3076. (save-window-excursion
  3077. (while cmds
  3078. (setq cmd (pop cmds)
  3079. thiscmdkey (car cmd)
  3080. thiscmdcmd (cdr cmd)
  3081. match (nth 2 thiscmdcmd)
  3082. bufname (if org-agenda-sticky
  3083. (or (and (stringp match)
  3084. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3085. (format "*Org Agenda(%s)*" thiscmdkey))
  3086. org-agenda-buffer-name)
  3087. cmd-or-set (nth 2 cmd)
  3088. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3089. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3090. (if (stringp files) (setq files (list files)))
  3091. (when files
  3092. (org-eval-in-environment (append org-agenda-exporter-settings
  3093. opts pars)
  3094. (org-agenda nil thiscmdkey))
  3095. (set-buffer bufname)
  3096. (while files
  3097. (org-eval-in-environment (append org-agenda-exporter-settings
  3098. opts pars)
  3099. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3100. (and (get-buffer bufname)
  3101. (kill-buffer bufname)))))))
  3102. (defvar org-agenda-current-span nil
  3103. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3104. (defun org-agenda-mark-header-line (pos)
  3105. "Mark the line at POS as an agenda structure header."
  3106. (save-excursion
  3107. (goto-char pos)
  3108. (put-text-property (point-at-bol) (point-at-eol)
  3109. 'org-agenda-structural-header t)
  3110. (when org-agenda-title-append
  3111. (put-text-property (point-at-bol) (point-at-eol)
  3112. 'org-agenda-title-append org-agenda-title-append))))
  3113. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3114. (defvar org-agenda-write-buffer-name "Agenda View")
  3115. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3116. "Write the current buffer (an agenda view) as a file.
  3117. Depending on the extension of the file name, plain text (.txt),
  3118. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3119. If the extension is .ics, translate visible agenda into iCalendar
  3120. format. If the extension is .org, collect all subtrees
  3121. corresponding to the agenda entries and add them in an .org file.
  3122. With prefix argument OPEN, open the new file immediately. If
  3123. NOSETTINGS is given, do not scope the settings of
  3124. `org-agenda-exporter-settings' into the export commands. This is
  3125. used when the settings have already been scoped and we do not
  3126. wish to overrule other, higher priority settings. If
  3127. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3128. the agenda to write."
  3129. (interactive "FWrite agenda to file: \nP")
  3130. (if (or (not (file-writable-p file))
  3131. (and (file-exists-p file)
  3132. (if (called-interactively-p 'any)
  3133. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3134. (user-error "Cannot write agenda to file %s" file))
  3135. (org-let (if nosettings nil org-agenda-exporter-settings)
  3136. '(save-excursion
  3137. (save-window-excursion
  3138. (let ((bs (copy-sequence (buffer-string)))
  3139. (extension (file-name-extension file))
  3140. (default-directory (file-name-directory file))
  3141. beg content)
  3142. (with-temp-buffer
  3143. (rename-buffer org-agenda-write-buffer-name t)
  3144. (set-buffer-modified-p nil)
  3145. (insert bs)
  3146. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3147. (run-hooks 'org-agenda-before-write-hook)
  3148. (cond
  3149. ((bound-and-true-p org-mobile-creating-agendas)
  3150. (org-mobile-write-agenda-for-mobile file))
  3151. ((string= "org" extension)
  3152. (let (content p m message-log-max)
  3153. (goto-char (point-min))
  3154. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3155. (goto-char p)
  3156. (setq m (get-text-property (point) 'org-hd-marker))
  3157. (when m
  3158. (push (save-excursion
  3159. (set-buffer (marker-buffer m))
  3160. (goto-char m)
  3161. (org-copy-subtree 1 nil t t)
  3162. org-subtree-clip)
  3163. content)))
  3164. (find-file file)
  3165. (erase-buffer)
  3166. (dolist (s content) (org-paste-subtree 1 s))
  3167. (write-file file)
  3168. (kill-buffer (current-buffer))
  3169. (message "Org file written to %s" file)))
  3170. ((member extension '("html" "htm"))
  3171. (or (require 'htmlize nil t)
  3172. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3173. (set-buffer (htmlize-buffer (current-buffer)))
  3174. (when org-agenda-export-html-style
  3175. ;; replace <style> section with org-agenda-export-html-style
  3176. (goto-char (point-min))
  3177. (kill-region (- (search-forward "<style") 6)
  3178. (search-forward "</style>"))
  3179. (insert org-agenda-export-html-style))
  3180. (write-file file)
  3181. (kill-buffer (current-buffer))
  3182. (message "HTML written to %s" file))
  3183. ((string= "ps" extension)
  3184. (require 'ps-print)
  3185. (ps-print-buffer-with-faces file)
  3186. (message "Postscript written to %s" file))
  3187. ((string= "pdf" extension)
  3188. (require 'ps-print)
  3189. (ps-print-buffer-with-faces
  3190. (concat (file-name-sans-extension file) ".ps"))
  3191. (call-process "ps2pdf" nil nil nil
  3192. (expand-file-name
  3193. (concat (file-name-sans-extension file) ".ps"))
  3194. (expand-file-name file))
  3195. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3196. (message "PDF written to %s" file))
  3197. ((string= "ics" extension)
  3198. (require 'ox-icalendar)
  3199. (org-icalendar-export-current-agenda (expand-file-name file)))
  3200. (t
  3201. (let ((bs (buffer-string)))
  3202. (find-file file)
  3203. (erase-buffer)
  3204. (insert bs)
  3205. (save-buffer 0)
  3206. (kill-buffer (current-buffer))
  3207. (message "Plain text written to %s" file))))))))
  3208. (set-buffer (or agenda-bufname
  3209. (and (called-interactively-p 'any) (buffer-name))
  3210. org-agenda-buffer-name)))
  3211. (when open (org-open-file file)))
  3212. (defun org-agenda-remove-marked-text (property &optional value)
  3213. "Delete all text marked with VALUE of PROPERTY.
  3214. VALUE defaults to t."
  3215. (let (beg)
  3216. (setq value (or value t))
  3217. (while (setq beg (text-property-any (point-min) (point-max)
  3218. property value))
  3219. (delete-region
  3220. beg (or (next-single-property-change beg property)
  3221. (point-max))))))
  3222. (defun org-agenda-add-entry-text ()
  3223. "Add entry text to agenda lines.
  3224. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3225. entry text following headings shown in the agenda.
  3226. Drawers will be excluded, also the line with scheduling/deadline info."
  3227. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3228. (not (bound-and-true-p org-mobile-creating-agendas)))
  3229. (let (m txt)
  3230. (goto-char (point-min))
  3231. (while (not (eobp))
  3232. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3233. (beginning-of-line 2)
  3234. (setq txt (org-agenda-get-some-entry-text
  3235. m org-agenda-add-entry-text-maxlines " > "))
  3236. (end-of-line 1)
  3237. (if (string-match "\\S-" txt)
  3238. (insert "\n" txt)
  3239. (or (eobp) (forward-char 1))))))))
  3240. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3241. &rest keep)
  3242. "Extract entry text from MARKER, at most N-LINES lines.
  3243. This will ignore drawers etc, just get the text.
  3244. If INDENT is given, prefix every line with this string. If KEEP is
  3245. given, it is a list of symbols, defining stuff that should not be
  3246. removed from the entry content. Currently only `planning' is allowed here."
  3247. (let (txt drawer-re kwd-time-re ind)
  3248. (save-excursion
  3249. (with-current-buffer (marker-buffer marker)
  3250. (if (not (derived-mode-p 'org-mode))
  3251. (setq txt "")
  3252. (org-with-wide-buffer
  3253. (goto-char marker)
  3254. (end-of-line 1)
  3255. (setq txt (buffer-substring
  3256. (min (1+ (point)) (point-max))
  3257. (progn (outline-next-heading) (point)))
  3258. drawer-re org-drawer-regexp
  3259. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3260. ".*\n?"))
  3261. (with-temp-buffer
  3262. (insert txt)
  3263. (when org-agenda-add-entry-text-descriptive-links
  3264. (goto-char (point-min))
  3265. (while (org-activate-links (point-max))
  3266. (add-text-properties (match-beginning 0) (match-end 0)
  3267. '(face org-link))))
  3268. (goto-char (point-min))
  3269. (while (re-search-forward org-link-bracket-re (point-max) t)
  3270. (set-text-properties (match-beginning 0) (match-end 0)
  3271. nil))
  3272. (goto-char (point-min))
  3273. (while (re-search-forward drawer-re nil t)
  3274. (delete-region
  3275. (match-beginning 0)
  3276. (progn (re-search-forward
  3277. "^[ \t]*:END:.*\n?" nil 'move)
  3278. (point))))
  3279. (unless (member 'planning keep)
  3280. (goto-char (point-min))
  3281. (while (re-search-forward kwd-time-re nil t)
  3282. (replace-match "")))
  3283. (goto-char (point-min))
  3284. (when org-agenda-entry-text-exclude-regexps
  3285. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3286. (while (setq re (pop re-list))
  3287. (goto-char (point-min))
  3288. (while (re-search-forward re nil t)
  3289. (replace-match "")))))
  3290. (goto-char (point-max))
  3291. (skip-chars-backward " \t\n")
  3292. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3293. ;; find and remove min common indentation
  3294. (goto-char (point-min))
  3295. (untabify (point-min) (point-max))
  3296. (setq ind (current-indentation))
  3297. (while (not (eobp))
  3298. (unless (looking-at "[ \t]*$")
  3299. (setq ind (min ind (current-indentation))))
  3300. (beginning-of-line 2))
  3301. (goto-char (point-min))
  3302. (while (not (eobp))
  3303. (unless (looking-at "[ \t]*$")
  3304. (move-to-column ind)
  3305. (delete-region (point-at-bol) (point)))
  3306. (beginning-of-line 2))
  3307. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3308. (goto-char (point-min))
  3309. (when indent
  3310. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3311. (replace-match indent t t)))
  3312. (goto-char (point-min))
  3313. (while (looking-at "[ \t]*\n") (replace-match ""))
  3314. (goto-char (point-max))
  3315. (when (> (org-current-line)
  3316. n-lines)
  3317. (org-goto-line (1+ n-lines))
  3318. (backward-char 1))
  3319. (setq txt (buffer-substring (point-min) (point))))))))
  3320. txt))
  3321. (defun org-check-for-org-mode ()
  3322. "Make sure current buffer is in Org mode. Error if not."
  3323. (or (derived-mode-p 'org-mode)
  3324. (error "Cannot execute Org agenda command on buffer in %s"
  3325. major-mode)))
  3326. ;;; Agenda prepare and finalize
  3327. (defvar org-agenda-multi nil) ; dynamically scoped
  3328. (defvar org-agenda-pre-window-conf nil)
  3329. (defvar org-agenda-columns-active nil)
  3330. (defvar org-agenda-name nil)
  3331. (defvar org-agenda-tag-filter nil)
  3332. (defvar org-agenda-category-filter nil)
  3333. (defvar org-agenda-regexp-filter nil)
  3334. (defvar org-agenda-effort-filter nil)
  3335. (defvar org-agenda-top-headline-filter nil)
  3336. (defvar org-agenda-represented-categories nil
  3337. "Cache for the list of all categories in the agenda.")
  3338. (defvar org-agenda-represented-tags nil
  3339. "Cache for the list of all categories in the agenda.")
  3340. (defvar org-agenda-tag-filter-preset nil
  3341. "A preset of the tags filter used for secondary agenda filtering.
  3342. This must be a list of strings, each string must be a single tag preceded
  3343. by \"+\" or \"-\".
  3344. This variable should not be set directly, but agenda custom commands can
  3345. bind it in the options section. The preset filter is a global property of
  3346. the entire agenda view. In a block agenda, it will not work reliably to
  3347. define a filter for one of the individual blocks. You need to set it in
  3348. the global options and expect it to be applied to the entire view.")
  3349. (defconst org-agenda-filter-variables
  3350. '((category . org-agenda-category-filter)
  3351. (tag . org-agenda-tag-filter)
  3352. (effort . org-agenda-effort-filter)
  3353. (regexp . org-agenda-regexp-filter))
  3354. "Alist of filter types and associated variables")
  3355. (defun org-agenda-filter-any ()
  3356. "Is any filter active?"
  3357. (let ((form (cons 'or (mapcar (lambda (x)
  3358. (if (or (symbol-value (cdr x))
  3359. (get :preset-filter x))
  3360. t nil))
  3361. org-agenda-filter-variables))))
  3362. (eval form)))
  3363. (defvar org-agenda-category-filter-preset nil
  3364. "A preset of the category filter used for secondary agenda filtering.
  3365. This must be a list of strings, each string must be a single category
  3366. preceded by \"+\" or \"-\".
  3367. This variable should not be set directly, but agenda custom commands can
  3368. bind it in the options section. The preset filter is a global property of
  3369. the entire agenda view. In a block agenda, it will not work reliably to
  3370. define a filter for one of the individual blocks. You need to set it in
  3371. the global options and expect it to be applied to the entire view.")
  3372. (defvar org-agenda-regexp-filter-preset nil
  3373. "A preset of the regexp filter used for secondary agenda filtering.
  3374. This must be a list of strings, each string must be a single regexp
  3375. preceded by \"+\" or \"-\".
  3376. This variable should not be set directly, but agenda custom commands can
  3377. bind it in the options section. The preset filter is a global property of
  3378. the entire agenda view. In a block agenda, it will not work reliably to
  3379. define a filter for one of the individual blocks. You need to set it in
  3380. the global options and expect it to be applied to the entire view.")
  3381. (defvar org-agenda-effort-filter-preset nil
  3382. "A preset of the effort condition used for secondary agenda filtering.
  3383. This must be a list of strings, each string must be a single regexp
  3384. preceded by \"+\" or \"-\".
  3385. This variable should not be set directly, but agenda custom commands can
  3386. bind it in the options section. The preset filter is a global property of
  3387. the entire agenda view. In a block agenda, it will not work reliably to
  3388. define a filter for one of the individual blocks. You need to set it in
  3389. the global options and expect it to be applied to the entire view.")
  3390. (defun org-agenda-use-sticky-p ()
  3391. "Return non-nil if an agenda buffer named
  3392. `org-agenda-buffer-name' exists and should be shown instead of
  3393. generating a new one."
  3394. (and
  3395. ;; turned off by user
  3396. org-agenda-sticky
  3397. ;; For multi-agenda buffer already exists
  3398. (not org-agenda-multi)
  3399. ;; buffer found
  3400. (get-buffer org-agenda-buffer-name)
  3401. ;; C-u parameter is same as last call
  3402. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3403. (and
  3404. (equal current-prefix-arg
  3405. org-agenda-last-prefix-arg)
  3406. ;; In case user turned stickiness on, while having existing
  3407. ;; Agenda buffer active, don't reuse that buffer, because it
  3408. ;; does not have org variables local
  3409. org-agenda-this-buffer-is-sticky))))
  3410. (defun org-agenda-prepare-window (abuf filter-alist)
  3411. "Setup agenda buffer in the window.
  3412. ABUF is the buffer for the agenda window.
  3413. FILTER-ALIST is an alist of filters we need to apply when
  3414. `org-agenda-persistent-filter' is non-nil."
  3415. (let* ((awin (get-buffer-window abuf)) wconf)
  3416. (cond
  3417. ((equal (current-buffer) abuf) nil)
  3418. (awin (select-window awin))
  3419. ((not (setq wconf (current-window-configuration))))
  3420. ((eq org-agenda-window-setup 'current-window)
  3421. (pop-to-buffer-same-window abuf))
  3422. ((eq org-agenda-window-setup 'other-window)
  3423. (org-switch-to-buffer-other-window abuf))
  3424. ((eq org-agenda-window-setup 'other-frame)
  3425. (switch-to-buffer-other-frame abuf))
  3426. ((eq org-agenda-window-setup 'only-window)
  3427. (delete-other-windows)
  3428. (pop-to-buffer-same-window abuf))
  3429. ((eq org-agenda-window-setup 'reorganize-frame)
  3430. (delete-other-windows)
  3431. (org-switch-to-buffer-other-window abuf)))
  3432. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3433. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3434. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3435. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3436. ;; Additional test in case agenda is invoked from within agenda
  3437. ;; buffer via elisp link.
  3438. (unless (equal (current-buffer) abuf)
  3439. (pop-to-buffer-same-window abuf))
  3440. (setq org-agenda-pre-window-conf
  3441. (or wconf org-agenda-pre-window-conf))))
  3442. (defun org-agenda-prepare (&optional name)
  3443. (let ((filter-alist (when org-agenda-persistent-filter
  3444. (with-current-buffer
  3445. (get-buffer-create org-agenda-buffer-name)
  3446. `((tag . ,org-agenda-tag-filter)
  3447. (re . ,org-agenda-regexp-filter)
  3448. (effort . ,org-agenda-effort-filter)
  3449. (cat . ,org-agenda-category-filter))))))
  3450. (if (org-agenda-use-sticky-p)
  3451. (progn
  3452. (put 'org-agenda-tag-filter :preset-filter nil)
  3453. (put 'org-agenda-category-filter :preset-filter nil)
  3454. (put 'org-agenda-regexp-filter :preset-filter nil)
  3455. (put 'org-agenda-effort-filter :preset-filter nil)
  3456. ;; Popup existing buffer
  3457. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3458. filter-alist)
  3459. (message "Sticky Agenda buffer, use `r' to refresh")
  3460. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3461. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3462. (setq org-todo-keywords-for-agenda nil)
  3463. (put 'org-agenda-tag-filter :preset-filter
  3464. org-agenda-tag-filter-preset)
  3465. (put 'org-agenda-category-filter :preset-filter
  3466. org-agenda-category-filter-preset)
  3467. (put 'org-agenda-regexp-filter :preset-filter
  3468. org-agenda-regexp-filter-preset)
  3469. (put 'org-agenda-effort-filter :preset-filter
  3470. org-agenda-effort-filter-preset)
  3471. (if org-agenda-multi
  3472. (progn
  3473. (setq buffer-read-only nil)
  3474. (goto-char (point-max))
  3475. (unless (or (bobp) org-agenda-compact-blocks
  3476. (not org-agenda-block-separator))
  3477. (insert "\n"
  3478. (if (stringp org-agenda-block-separator)
  3479. org-agenda-block-separator
  3480. (make-string (window-width) org-agenda-block-separator))
  3481. "\n"))
  3482. (narrow-to-region (point) (point-max)))
  3483. (setq org-done-keywords-for-agenda nil)
  3484. ;; Setting any org variables that are in org-agenda-local-vars
  3485. ;; list need to be done after the prepare call
  3486. (org-agenda-prepare-window
  3487. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3488. (setq buffer-read-only nil)
  3489. (org-agenda-reset-markers)
  3490. (let ((inhibit-read-only t)) (erase-buffer))
  3491. (org-agenda-mode)
  3492. (setq org-agenda-buffer (current-buffer))
  3493. (setq org-agenda-contributing-files nil)
  3494. (setq org-agenda-columns-active nil)
  3495. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3496. (setq org-todo-keywords-for-agenda
  3497. (org-uniquify org-todo-keywords-for-agenda))
  3498. (setq org-done-keywords-for-agenda
  3499. (org-uniquify org-done-keywords-for-agenda))
  3500. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3501. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3502. (and name (not org-agenda-name)
  3503. (setq-local org-agenda-name name)))
  3504. (setq buffer-read-only nil))))
  3505. (defvar org-overriding-columns-format)
  3506. (defvar org-local-columns-format)
  3507. (defun org-agenda-finalize ()
  3508. "Finishing touch for the agenda buffer.
  3509. This function is called just before displaying the agenda. If
  3510. you want to add your own functions to the finalization of the
  3511. agenda display, configure `org-agenda-finalize-hook'."
  3512. (unless org-agenda-multi
  3513. (save-excursion
  3514. (let ((inhibit-read-only t))
  3515. (goto-char (point-min))
  3516. (save-excursion
  3517. (while (org-activate-links (point-max))
  3518. (add-text-properties (match-beginning 0) (match-end 0)
  3519. '(face org-link))))
  3520. (unless (eq org-agenda-remove-tags t)
  3521. (org-agenda-align-tags))
  3522. (unless org-agenda-with-colors
  3523. (remove-text-properties (point-min) (point-max) '(face nil)))
  3524. (when (bound-and-true-p org-overriding-columns-format)
  3525. (setq-local org-local-columns-format
  3526. org-overriding-columns-format))
  3527. (when org-agenda-view-columns-initially
  3528. (org-agenda-columns))
  3529. (when org-agenda-fontify-priorities
  3530. (org-agenda-fontify-priorities))
  3531. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3532. (org-agenda-dim-blocked-tasks))
  3533. (org-agenda-mark-clocking-task)
  3534. (when org-agenda-entry-text-mode
  3535. (org-agenda-entry-text-hide)
  3536. (org-agenda-entry-text-show))
  3537. (when (and (featurep 'org-habit)
  3538. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3539. (org-habit-insert-consistency-graphs))
  3540. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3541. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3542. (and (listp org-agenda-show-inherited-tags)
  3543. (memq org-agenda-type org-agenda-show-inherited-tags))
  3544. (and (eq org-agenda-show-inherited-tags t)
  3545. (or (eq org-agenda-use-tag-inheritance t)
  3546. (and (listp org-agenda-use-tag-inheritance)
  3547. (not (memq org-agenda-type
  3548. org-agenda-use-tag-inheritance))))))
  3549. (let (mrk)
  3550. (save-excursion
  3551. (goto-char (point-min))
  3552. (while (equal (forward-line) 0)
  3553. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3554. (put-text-property (point-at-bol) (point-at-eol)
  3555. 'tags
  3556. (org-with-point-at mrk
  3557. (mapcar #'downcase (org-get-tags)))))))))
  3558. (setq org-agenda-represented-tags nil
  3559. org-agenda-represented-categories nil)
  3560. (when org-agenda-top-headline-filter
  3561. (org-agenda-filter-top-headline-apply
  3562. org-agenda-top-headline-filter))
  3563. (when org-agenda-tag-filter
  3564. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3565. (when (get 'org-agenda-tag-filter :preset-filter)
  3566. (org-agenda-filter-apply
  3567. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3568. (when org-agenda-category-filter
  3569. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3570. (when (get 'org-agenda-category-filter :preset-filter)
  3571. (org-agenda-filter-apply
  3572. (get 'org-agenda-category-filter :preset-filter) 'category))
  3573. (when org-agenda-regexp-filter
  3574. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3575. (when (get 'org-agenda-regexp-filter :preset-filter)
  3576. (org-agenda-filter-apply
  3577. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3578. (when org-agenda-effort-filter
  3579. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3580. (when (get 'org-agenda-effort-filter :preset-filter)
  3581. (org-agenda-filter-apply
  3582. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3583. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
  3584. (run-hooks 'org-agenda-finalize-hook)))))
  3585. (defun org-agenda-mark-clocking-task ()
  3586. "Mark the current clock entry in the agenda if it is present."
  3587. ;; We need to widen when `org-agenda-finalize' is called from
  3588. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in').
  3589. (when (bound-and-true-p org-clock-current-task)
  3590. (save-restriction
  3591. (widen)
  3592. (org-agenda-unmark-clocking-task)
  3593. (when (marker-buffer org-clock-hd-marker)
  3594. (save-excursion
  3595. (goto-char (point-min))
  3596. (let (s ov)
  3597. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3598. (goto-char s)
  3599. (when (equal (org-get-at-bol 'org-hd-marker)
  3600. org-clock-hd-marker)
  3601. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3602. (overlay-put ov 'type 'org-agenda-clocking)
  3603. (overlay-put ov 'face 'org-agenda-clocking)
  3604. (overlay-put ov 'help-echo
  3605. "The clock is running in this item")))))))))
  3606. (defun org-agenda-unmark-clocking-task ()
  3607. "Unmark the current clocking task."
  3608. (mapc (lambda (o)
  3609. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3610. (delete-overlay o)))
  3611. (overlays-in (point-min) (point-max))))
  3612. (defun org-agenda-fontify-priorities ()
  3613. "Make highest priority lines bold, and lowest italic."
  3614. (interactive)
  3615. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3616. (delete-overlay o)))
  3617. (overlays-in (point-min) (point-max)))
  3618. (save-excursion
  3619. (let (b e p ov h l)
  3620. (goto-char (point-min))
  3621. (while (re-search-forward org-priority-regexp nil t)
  3622. (setq h (or (get-char-property (point) 'org-priority-highest)
  3623. org-priority-highest)
  3624. l (or (get-char-property (point) 'org-priority-lowest)
  3625. org-priority-lowest)
  3626. p (string-to-char (match-string 2))
  3627. b (match-beginning 1)
  3628. e (if (eq org-agenda-fontify-priorities 'cookies)
  3629. (match-end 1)
  3630. (point-at-eol))
  3631. ov (make-overlay b e))
  3632. (overlay-put
  3633. ov 'face
  3634. (let ((special-face
  3635. (cond ((org-face-from-face-or-color
  3636. 'priority 'org-priority
  3637. (cdr (assoc p org-priority-faces))))
  3638. ((and (listp org-agenda-fontify-priorities)
  3639. (org-face-from-face-or-color
  3640. 'priority 'org-priority
  3641. (cdr (assoc p org-agenda-fontify-priorities)))))
  3642. ((equal p l) 'italic)
  3643. ((equal p h) 'bold))))
  3644. (if special-face (list special-face 'org-priority) 'org-priority)))
  3645. (overlay-put ov 'org-type 'org-priority)))))
  3646. (defvar org-depend-tag-blocked)
  3647. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3648. "Dim currently blocked TODOs in the agenda display.
  3649. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3650. dimming them."
  3651. (interactive "P")
  3652. (when (called-interactively-p 'interactive)
  3653. (message "Dim or hide blocked tasks..."))
  3654. (dolist (o (overlays-in (point-min) (point-max)))
  3655. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3656. (delete-overlay o)))
  3657. (save-excursion
  3658. (let ((inhibit-read-only t))
  3659. (goto-char (point-min))
  3660. (while (let ((pos (text-property-not-all
  3661. (point) (point-max) 'org-todo-blocked nil)))
  3662. (when pos (goto-char pos)))
  3663. (let* ((invisible
  3664. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3665. (todo-blocked
  3666. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3667. (ov (make-overlay (if invisible
  3668. (line-end-position 0)
  3669. (line-beginning-position))
  3670. (line-end-position))))
  3671. (when todo-blocked
  3672. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3673. (when invisible
  3674. (org-agenda-filter-hide-line 'todo-blocked)))
  3675. (move-beginning-of-line 2))))
  3676. (when (called-interactively-p 'interactive)
  3677. (message "Dim or hide blocked tasks...done")))
  3678. (defun org-agenda--mark-blocked-entry (entry)
  3679. "If ENTRY is blocked, mark it for fontification or invisibility.
  3680. If the header at `org-hd-marker' is blocked according to
  3681. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3682. 'invisible and the header is not blocked by checkboxes, set the
  3683. text property `org-todo-blocked' to `invisible', otherwise set it
  3684. to t."
  3685. (when (get-text-property 0 'todo-state entry)
  3686. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3687. (org-blocked-by-checkboxes nil)
  3688. ;; Necessary so that `org-entry-blocked-p' does not change
  3689. ;; the buffer.
  3690. (org-depend-tag-blocked nil))
  3691. (when entry-marker
  3692. (let ((blocked
  3693. (with-current-buffer (marker-buffer entry-marker)
  3694. (save-excursion
  3695. (goto-char entry-marker)
  3696. (org-entry-blocked-p)))))
  3697. (when blocked
  3698. (let ((really-invisible
  3699. (and (not org-blocked-by-checkboxes)
  3700. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3701. (put-text-property
  3702. 0 (length entry) 'org-todo-blocked
  3703. (if really-invisible 'invisible t)
  3704. entry)
  3705. (put-text-property
  3706. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3707. entry)
  3708. (defvar org-agenda-skip-function nil
  3709. "Function to be called at each match during agenda construction.
  3710. If this function returns nil, the current match should not be skipped.
  3711. Otherwise, the function must return a position from where the search
  3712. should be continued.
  3713. This may also be a Lisp form, it will be evaluated.
  3714. Never set this variable using `setq' or so, because then it will apply
  3715. to all future agenda commands. If you do want a global skipping condition,
  3716. use the option `org-agenda-skip-function-global' instead.
  3717. The correct usage for `org-agenda-skip-function' is to bind it with
  3718. `let' to scope it dynamically into the agenda-constructing command.
  3719. A good way to set it is through options in `org-agenda-custom-commands'.")
  3720. (defun org-agenda-skip ()
  3721. "Throw to `:skip' in places that should be skipped.
  3722. Also moves point to the end of the skipped region, so that search can
  3723. continue from there."
  3724. (let ((p (point-at-bol)) to)
  3725. (when (or
  3726. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3727. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3728. (get-text-property p :org-archived)
  3729. (org-end-of-subtree t))
  3730. (and org-agenda-skip-comment-trees
  3731. (get-text-property p :org-comment)
  3732. (org-end-of-subtree t))
  3733. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3734. (org-agenda-skip-eval org-agenda-skip-function)))
  3735. (goto-char to))
  3736. (org-in-src-block-p t))
  3737. (throw :skip t))))
  3738. (defun org-agenda-skip-eval (form)
  3739. "If FORM is a function or a list, call (or eval) it and return the result.
  3740. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3741. and match data are returned to the previous state no matter what these
  3742. functions do."
  3743. (let (fp)
  3744. (and form
  3745. (or (setq fp (functionp form))
  3746. (consp form))
  3747. (save-excursion
  3748. (save-match-data
  3749. (if fp
  3750. (funcall form)
  3751. (eval form)))))))
  3752. (defvar org-agenda-markers nil
  3753. "List of all currently active markers created by `org-agenda'.")
  3754. (defvar org-agenda-last-marker-time (float-time)
  3755. "Creation time of the last agenda marker.")
  3756. (defun org-agenda-new-marker (&optional pos)
  3757. "Return a new agenda marker.
  3758. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3759. these markers and resets them when they are no longer in use."
  3760. (let ((m (copy-marker (or pos (point)) t)))
  3761. (setq org-agenda-last-marker-time (float-time))
  3762. (if org-agenda-buffer
  3763. (with-current-buffer org-agenda-buffer
  3764. (push m org-agenda-markers))
  3765. (push m org-agenda-markers))
  3766. m))
  3767. (defun org-agenda-reset-markers ()
  3768. "Reset markers created by `org-agenda'."
  3769. (while org-agenda-markers
  3770. (move-marker (pop org-agenda-markers) nil)))
  3771. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3772. "Save relative positions of markers in region.
  3773. This check for agenda markers in all agenda buffers currently active."
  3774. (dolist (buf (buffer-list))
  3775. (with-current-buffer buf
  3776. (when (eq major-mode 'org-agenda-mode)
  3777. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3778. org-agenda-markers)))))
  3779. ;;; Entry text mode
  3780. (defun org-agenda-entry-text-show-here ()
  3781. "Add some text from the entry as context to the current line."
  3782. (let (m txt o)
  3783. (setq m (org-get-at-bol 'org-hd-marker))
  3784. (unless (marker-buffer m)
  3785. (error "No marker points to an entry here"))
  3786. (setq txt (concat "\n" (org-no-properties
  3787. (org-agenda-get-some-entry-text
  3788. m org-agenda-entry-text-maxlines
  3789. org-agenda-entry-text-leaders))))
  3790. (when (string-match "\\S-" txt)
  3791. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3792. (overlay-put o 'evaporate t)
  3793. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3794. (overlay-put o 'after-string txt))))
  3795. (defun org-agenda-entry-text-show ()
  3796. "Add entry context for all agenda lines."
  3797. (interactive)
  3798. (save-excursion
  3799. (goto-char (point-max))
  3800. (beginning-of-line 1)
  3801. (while (not (bobp))
  3802. (when (org-get-at-bol 'org-hd-marker)
  3803. (org-agenda-entry-text-show-here))
  3804. (beginning-of-line 0))))
  3805. (defun org-agenda-entry-text-hide ()
  3806. "Remove any shown entry context."
  3807. (mapc (lambda (o)
  3808. (when (eq (overlay-get o 'org-overlay-type)
  3809. 'agenda-entry-content)
  3810. (delete-overlay o)))
  3811. (overlays-in (point-min) (point-max))))
  3812. (defun org-agenda-get-day-face (date)
  3813. "Return the face DATE should be displayed with."
  3814. (cond ((and (functionp org-agenda-day-face-function)
  3815. (funcall org-agenda-day-face-function date)))
  3816. ((org-agenda-today-p date) 'org-agenda-date-today)
  3817. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3818. 'org-agenda-date-weekend)
  3819. (t 'org-agenda-date)))
  3820. (defvar org-agenda-show-log-scoped)
  3821. ;;; Agenda Daily/Weekly
  3822. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3823. "Start day for the agenda view.
  3824. Custom commands can set this variable in the options section.
  3825. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3826. input allowed when reading a date through the Org calendar.
  3827. See the docstring of `org-read-date' for details.")
  3828. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3829. (defvar org-arg-loc nil) ; local variable
  3830. (defvar org-agenda-buffer-tmp-name nil)
  3831. ;;;###autoload
  3832. (defun org-agenda-list (&optional arg start-day span with-hour)
  3833. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3834. The view will be for the current day or week, but from the overview buffer
  3835. you will be able to go to other days/weeks.
  3836. With a numeric prefix argument in an interactive call, the agenda will
  3837. span ARG days. Lisp programs should instead specify SPAN to change
  3838. the number of days. SPAN defaults to `org-agenda-span'.
  3839. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3840. given in `org-agenda-start-on-weekday'.
  3841. When WITH-HOUR is non-nil, only include scheduled and deadline
  3842. items if they have an hour specification like [h]h:mm."
  3843. (interactive "P")
  3844. (when org-agenda-overriding-arguments
  3845. (setq arg (car org-agenda-overriding-arguments)
  3846. start-day (nth 1 org-agenda-overriding-arguments)
  3847. span (nth 2 org-agenda-overriding-arguments)))
  3848. (when (and (integerp arg) (> arg 0))
  3849. (setq span arg arg nil))
  3850. (when (numberp span)
  3851. (unless (< 0 span)
  3852. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3853. (catch 'exit
  3854. (setq org-agenda-buffer-name
  3855. (or org-agenda-buffer-tmp-name
  3856. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3857. (when org-agenda-sticky
  3858. (cond ((and org-keys (stringp org-match))
  3859. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3860. (org-keys
  3861. (format "*Org Agenda(%s)*" org-keys))
  3862. (t "*Org Agenda(a)*")))
  3863. "*Org Agenda*"))
  3864. (org-agenda-prepare "Day/Week")
  3865. (setq start-day (or start-day org-agenda-start-day))
  3866. (when (stringp start-day)
  3867. ;; Convert to an absolute day number
  3868. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3869. (org-compile-prefix-format 'agenda)
  3870. (org-set-sorting-strategy 'agenda)
  3871. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3872. (today (org-today))
  3873. (sd (or start-day today))
  3874. (ndays (org-agenda-span-to-ndays span sd))
  3875. (org-agenda-start-on-weekday
  3876. (and (or (eq ndays 7) (eq ndays 14))
  3877. org-agenda-start-on-weekday))
  3878. (thefiles (org-agenda-files nil 'ifmode))
  3879. (files thefiles)
  3880. (start (if (or (null org-agenda-start-on-weekday)
  3881. (< ndays 7))
  3882. sd
  3883. (let* ((nt (calendar-day-of-week
  3884. (calendar-gregorian-from-absolute sd)))
  3885. (n1 org-agenda-start-on-weekday)
  3886. (d (- nt n1)))
  3887. (- sd (+ (if (< d 0) 7 0) d)))))
  3888. (day-numbers (list start))
  3889. (day-cnt 0)
  3890. (inhibit-redisplay (not debug-on-error))
  3891. (org-agenda-show-log-scoped org-agenda-show-log)
  3892. s e rtn rtnall file date d start-pos end-pos todayp
  3893. clocktable-start clocktable-end filter)
  3894. (setq org-agenda-redo-command
  3895. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3896. (dotimes (n (1- ndays))
  3897. (push (1+ (car day-numbers)) day-numbers))
  3898. (setq day-numbers (nreverse day-numbers))
  3899. (setq clocktable-start (car day-numbers)
  3900. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3901. (setq-local org-starting-day (car day-numbers))
  3902. (setq-local org-arg-loc arg)
  3903. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3904. (unless org-agenda-compact-blocks
  3905. (let* ((d1 (car day-numbers))
  3906. (d2 (org-last day-numbers))
  3907. (w1 (org-days-to-iso-week d1))
  3908. (w2 (org-days-to-iso-week d2)))
  3909. (setq s (point))
  3910. (org-agenda--insert-overriding-header
  3911. (concat (org-agenda-span-name span)
  3912. "-agenda"
  3913. (cond ((<= 350 (- d2 d1)) "")
  3914. ((= w1 w2) (format " (W%02d)" w1))
  3915. (t (format " (W%02d-W%02d)" w1 w2)))
  3916. ":\n")))
  3917. ;; Add properties if we actually inserted a header.
  3918. (when (> (point) s)
  3919. (add-text-properties s (1- (point))
  3920. (list 'face 'org-agenda-structure
  3921. 'org-date-line t))
  3922. (org-agenda-mark-header-line s)))
  3923. (while (setq d (pop day-numbers))
  3924. (setq date (calendar-gregorian-from-absolute d)
  3925. s (point))
  3926. (if (or (setq todayp (= d today))
  3927. (and (not start-pos) (= d sd)))
  3928. (setq start-pos (point))
  3929. (when (and start-pos (not end-pos))
  3930. (setq end-pos (point))))
  3931. (setq files thefiles
  3932. rtnall nil)
  3933. (while (setq file (pop files))
  3934. (catch 'nextfile
  3935. (org-check-agenda-file file)
  3936. (let ((org-agenda-entry-types org-agenda-entry-types))
  3937. ;; Starred types override non-starred equivalents
  3938. (when (member :deadline* org-agenda-entry-types)
  3939. (setq org-agenda-entry-types
  3940. (delq :deadline org-agenda-entry-types)))
  3941. (when (member :scheduled* org-agenda-entry-types)
  3942. (setq org-agenda-entry-types
  3943. (delq :scheduled org-agenda-entry-types)))
  3944. ;; Honor with-hour
  3945. (when with-hour
  3946. (when (member :deadline org-agenda-entry-types)
  3947. (setq org-agenda-entry-types
  3948. (delq :deadline org-agenda-entry-types))
  3949. (push :deadline* org-agenda-entry-types))
  3950. (when (member :scheduled org-agenda-entry-types)
  3951. (setq org-agenda-entry-types
  3952. (delq :scheduled org-agenda-entry-types))
  3953. (push :scheduled* org-agenda-entry-types)))
  3954. (unless org-agenda-include-deadlines
  3955. (setq org-agenda-entry-types
  3956. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3957. (cond
  3958. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3959. (setq rtn (org-agenda-get-day-entries
  3960. file date :closed)))
  3961. (org-agenda-show-log-scoped
  3962. (setq rtn (apply 'org-agenda-get-day-entries
  3963. file date
  3964. (append '(:closed) org-agenda-entry-types))))
  3965. (t
  3966. (setq rtn (apply 'org-agenda-get-day-entries
  3967. file date
  3968. org-agenda-entry-types)))))
  3969. (setq rtnall (append rtnall rtn)))) ;; all entries
  3970. (when org-agenda-include-diary
  3971. (let ((org-agenda-search-headline-for-time t))
  3972. (require 'diary-lib)
  3973. (setq rtn (org-get-entries-from-diary date))
  3974. (setq rtnall (append rtnall rtn))))
  3975. (when (or rtnall org-agenda-show-all-dates)
  3976. (setq day-cnt (1+ day-cnt))
  3977. (insert
  3978. (if (stringp org-agenda-format-date)
  3979. (format-time-string org-agenda-format-date
  3980. (org-time-from-absolute date))
  3981. (funcall org-agenda-format-date date))
  3982. "\n")
  3983. (put-text-property s (1- (point)) 'face
  3984. (org-agenda-get-day-face date))
  3985. (put-text-property s (1- (point)) 'org-date-line t)
  3986. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3987. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3988. (when todayp
  3989. (put-text-property s (1- (point)) 'org-today t))
  3990. (setq rtnall
  3991. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3992. (when rtnall (insert ;; all entries
  3993. (org-agenda-finalize-entries rtnall 'agenda)
  3994. "\n"))
  3995. (put-text-property s (1- (point)) 'day d)
  3996. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  3997. (when (and org-agenda-clockreport-mode clocktable-start)
  3998. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3999. ;; the above line is to ensure the restricted range!
  4000. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4001. tbl)
  4002. (setq p (org-plist-delete p :block))
  4003. (setq p (plist-put p :tstart clocktable-start))
  4004. (setq p (plist-put p :tend clocktable-end))
  4005. (setq p (plist-put p :scope 'agenda))
  4006. (setq tbl (apply 'org-clock-get-clocktable p))
  4007. (insert tbl)))
  4008. (goto-char (point-min))
  4009. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4010. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4011. (and (pos-visible-in-window-p (point-min))
  4012. (pos-visible-in-window-p (point-max))))
  4013. (goto-char (1- (point-max)))
  4014. (recenter -1)
  4015. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4016. (goto-char (or start-pos 1))
  4017. (recenter 1)))
  4018. (goto-char (or start-pos 1))
  4019. (add-text-properties (point-min) (point-max)
  4020. `(org-agenda-type agenda
  4021. org-last-args (,arg ,start-day ,span)
  4022. org-redo-cmd ,org-agenda-redo-command
  4023. org-series-cmd ,org-cmd))
  4024. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4025. (org-agenda-show-clocking-issues))
  4026. (org-agenda-finalize)
  4027. (setq buffer-read-only t)
  4028. (message ""))))
  4029. (defun org-agenda-ndays-to-span (n)
  4030. "Return a span symbol for a span of N days, or N if none matches."
  4031. (cond ((symbolp n) n)
  4032. ((= n 1) 'day)
  4033. ((= n 7) 'week)
  4034. ((= n 14) 'fortnight)
  4035. (t n)))
  4036. (defun org-agenda-span-to-ndays (span &optional start-day)
  4037. "Return ndays from SPAN, possibly starting at START-DAY.
  4038. START-DAY is an absolute time value."
  4039. (cond ((numberp span) span)
  4040. ((eq span 'day) 1)
  4041. ((eq span 'week) 7)
  4042. ((eq span 'fortnight) 14)
  4043. ((eq span 'month)
  4044. (let ((date (calendar-gregorian-from-absolute start-day)))
  4045. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4046. ((eq span 'year)
  4047. (let ((date (calendar-gregorian-from-absolute start-day)))
  4048. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4049. (defun org-agenda-span-name (span)
  4050. "Return a SPAN name."
  4051. (if (null span)
  4052. ""
  4053. (if (symbolp span)
  4054. (capitalize (symbol-name span))
  4055. (format "%d days" span))))
  4056. ;;; Agenda word search
  4057. (defvar org-agenda-search-history nil)
  4058. (defvar org-search-syntax-table nil
  4059. "Special syntax table for Org search.
  4060. In this table, we have single quotes not as word constituents, to
  4061. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4062. (defvar org-mode-syntax-table) ; From org.el
  4063. (defun org-search-syntax-table ()
  4064. (unless org-search-syntax-table
  4065. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4066. (modify-syntax-entry ?' "." org-search-syntax-table)
  4067. (modify-syntax-entry ?` "." org-search-syntax-table))
  4068. org-search-syntax-table)
  4069. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4070. ;;;###autoload
  4071. (defun org-search-view (&optional todo-only string edit-at)
  4072. "Show all entries that contain a phrase or words or regular expressions.
  4073. With optional prefix argument TODO-ONLY, only consider entries that are
  4074. TODO entries. The argument STRING can be used to pass a default search
  4075. string into this function. If EDIT-AT is non-nil, it means that the
  4076. user should get a chance to edit this string, with cursor at position
  4077. EDIT-AT.
  4078. The search string can be viewed either as a phrase that should be found as
  4079. is, or it can be broken into a number of snippets, each of which must match
  4080. in a Boolean way to select an entry. The default depends on the variable
  4081. `org-agenda-search-view-always-boolean'.
  4082. Even if this is turned off (the default) you can always switch to
  4083. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4084. The default is a direct search of the whole phrase, where each space in
  4085. the search string can expand to an arbitrary amount of whitespace,
  4086. including newlines.
  4087. If using a Boolean search, the search string is split on whitespace and
  4088. each snippet is searched separately, with logical AND to select an entry.
  4089. Words prefixed with a minus must *not* occur in the entry. Words without
  4090. a prefix or prefixed with a plus must occur in the entry. Matching is
  4091. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4092. match whole words, not parts of a word) if
  4093. `org-agenda-search-view-force-full-words' is set (default is nil).
  4094. Boolean search snippets enclosed by curly braces are interpreted as
  4095. regular expressions that must or (when preceded with \"-\") must not
  4096. match in the entry. Snippets enclosed into double quotes will be taken
  4097. as a whole, to include whitespace.
  4098. - If the search string starts with an asterisk, search only in headlines.
  4099. - If (possibly after the leading star) the search string starts with an
  4100. exclamation mark, this also means to look at TODO entries only, an effect
  4101. that can also be achieved with a prefix argument.
  4102. - If (possibly after star and exclamation mark) the search string starts
  4103. with a colon, this will mean that the (non-regexp) snippets of the
  4104. Boolean search must match as full words.
  4105. This command searches the agenda files, and in addition the files
  4106. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4107. is active."
  4108. (interactive "P")
  4109. (when org-agenda-overriding-arguments
  4110. (setq todo-only (car org-agenda-overriding-arguments)
  4111. string (nth 1 org-agenda-overriding-arguments)
  4112. edit-at (nth 2 org-agenda-overriding-arguments)))
  4113. (let* ((props (list 'face nil
  4114. 'done-face 'org-agenda-done
  4115. 'org-not-done-regexp org-not-done-regexp
  4116. 'org-todo-regexp org-todo-regexp
  4117. 'org-complex-heading-regexp org-complex-heading-regexp
  4118. 'mouse-face 'highlight
  4119. 'help-echo (format "mouse-2 or RET jump to location")))
  4120. (full-words org-agenda-search-view-force-full-words)
  4121. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4122. regexp rtn rtnall files file pos inherited-tags
  4123. marker category level tags c neg re boolean
  4124. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4125. (unless (and (not edit-at)
  4126. (stringp string)
  4127. (string-match "\\S-" string))
  4128. (setq string (read-string
  4129. (if org-agenda-search-view-always-boolean
  4130. "[+-]Word/{Regexp} ...: "
  4131. "Phrase or [+-]Word/{Regexp} ...: ")
  4132. (cond
  4133. ((integerp edit-at) (cons string edit-at))
  4134. (edit-at string))
  4135. 'org-agenda-search-history)))
  4136. (catch 'exit
  4137. (when org-agenda-sticky
  4138. (setq org-agenda-buffer-name
  4139. (if (stringp string)
  4140. (format "*Org Agenda(%s:%s)*"
  4141. (or org-keys (or (and todo-only "S") "s")) string)
  4142. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4143. (org-agenda-prepare "SEARCH")
  4144. (org-compile-prefix-format 'search)
  4145. (org-set-sorting-strategy 'search)
  4146. (setq org-agenda-redo-command
  4147. (list 'org-search-view (if todo-only t nil)
  4148. (list 'if 'current-prefix-arg nil string)))
  4149. (setq org-agenda-query-string string)
  4150. (if (equal (string-to-char string) ?*)
  4151. (setq hdl-only t
  4152. words (substring string 1))
  4153. (setq words string))
  4154. (when (equal (string-to-char words) ?!)
  4155. (setq todo-only t
  4156. words (substring words 1)))
  4157. (when (equal (string-to-char words) ?:)
  4158. (setq full-words t
  4159. words (substring words 1)))
  4160. (when (or org-agenda-search-view-always-boolean
  4161. (member (string-to-char words) '(?- ?+ ?\{)))
  4162. (setq boolean t))
  4163. (setq words (split-string words))
  4164. (let (www w)
  4165. (while (setq w (pop words))
  4166. (while (and (string-match "\\\\\\'" w) words)
  4167. (setq w (concat (substring w 0 -1) " " (pop words))))
  4168. (push w www))
  4169. (setq words (nreverse www) www nil)
  4170. (while (setq w (pop words))
  4171. (when (and (string-match "\\`[-+]?{" w)
  4172. (not (string-match "}\\'" w)))
  4173. (while (and words (not (string-match "}\\'" (car words))))
  4174. (setq w (concat w " " (pop words))))
  4175. (setq w (concat w " " (pop words))))
  4176. (push w www))
  4177. (setq words (nreverse www)))
  4178. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4179. (when boolean
  4180. (let (wds w)
  4181. (while (setq w (pop words))
  4182. (when (or (equal (substring w 0 1) "\"")
  4183. (and (> (length w) 1)
  4184. (member (substring w 0 1) '("+" "-"))
  4185. (equal (substring w 1 2) "\"")))
  4186. (while (and words (not (equal (substring w -1) "\"")))
  4187. (setq w (concat w " " (pop words)))))
  4188. (and (string-match "\\`\\([-+]?\\)\"" w)
  4189. (setq w (replace-match "\\1" nil nil w)))
  4190. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4191. (push w wds))
  4192. (setq words (nreverse wds))))
  4193. (if boolean
  4194. (mapc (lambda (w)
  4195. (setq c (string-to-char w))
  4196. (if (equal c ?-)
  4197. (setq neg t w (substring w 1))
  4198. (if (equal c ?+)
  4199. (setq neg nil w (substring w 1))
  4200. (setq neg nil)))
  4201. (if (string-match "\\`{.*}\\'" w)
  4202. (setq re (substring w 1 -1))
  4203. (if full-words
  4204. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4205. (setq re (regexp-quote (downcase w)))))
  4206. (if neg (push re regexps-) (push re regexps+)))
  4207. words)
  4208. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4209. regexps+))
  4210. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4211. (if (not regexps+)
  4212. (setq regexp org-outline-regexp-bol)
  4213. (setq regexp (pop regexps+))
  4214. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4215. regexp))))
  4216. (setq files (org-agenda-files nil 'ifmode))
  4217. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4218. ;; restriction.
  4219. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4220. (pop org-agenda-text-search-extra-files)
  4221. (unless (get 'org-agenda-files 'org-restrict)
  4222. (setq files (org-add-archive-files files))))
  4223. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4224. ;; non-existent ones.
  4225. (setq files (cl-remove-duplicates
  4226. (append files org-agenda-text-search-extra-files)
  4227. :test (lambda (a b)
  4228. (and (file-exists-p a)
  4229. (file-exists-p b)
  4230. (file-equal-p a b))))
  4231. rtnall nil)
  4232. (while (setq file (pop files))
  4233. (setq ee nil)
  4234. (catch 'nextfile
  4235. (org-check-agenda-file file)
  4236. (setq buffer (if (file-exists-p file)
  4237. (org-get-agenda-file-buffer file)
  4238. (error "No such file %s" file)))
  4239. (unless buffer
  4240. ;; If file does not exist, make sure an error message is sent
  4241. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4242. file))))
  4243. (with-current-buffer buffer
  4244. (with-syntax-table (org-search-syntax-table)
  4245. (unless (derived-mode-p 'org-mode)
  4246. (error "Agenda file %s is not in Org mode" file))
  4247. (let ((case-fold-search t))
  4248. (save-excursion
  4249. (save-restriction
  4250. (if (eq buffer org-agenda-restrict)
  4251. (narrow-to-region org-agenda-restrict-begin
  4252. org-agenda-restrict-end)
  4253. (widen))
  4254. (goto-char (point-min))
  4255. (unless (or (org-at-heading-p)
  4256. (outline-next-heading))
  4257. (throw 'nextfile t))
  4258. (goto-char (max (point-min) (1- (point))))
  4259. (while (re-search-forward regexp nil t)
  4260. (org-back-to-heading t)
  4261. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4262. (> (org-reduced-level (org-outline-level))
  4263. org-agenda-search-view-max-outline-level)
  4264. (forward-line -1)
  4265. (org-back-to-heading t)))
  4266. (skip-chars-forward "* ")
  4267. (setq beg (point-at-bol)
  4268. beg1 (point)
  4269. end (progn
  4270. (outline-next-heading)
  4271. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4272. (> (org-reduced-level (org-outline-level))
  4273. org-agenda-search-view-max-outline-level)
  4274. (forward-line 1)
  4275. (outline-next-heading)))
  4276. (point)))
  4277. (catch :skip
  4278. (goto-char beg)
  4279. (org-agenda-skip)
  4280. (setq str (buffer-substring-no-properties
  4281. (point-at-bol)
  4282. (if hdl-only (point-at-eol) end)))
  4283. (mapc (lambda (wr) (when (string-match wr str)
  4284. (goto-char (1- end))
  4285. (throw :skip t)))
  4286. regexps-)
  4287. (mapc (lambda (wr) (unless (string-match wr str)
  4288. (goto-char (1- end))
  4289. (throw :skip t)))
  4290. (if todo-only
  4291. (cons (concat "^\\*+[ \t]+"
  4292. org-not-done-regexp)
  4293. regexps+)
  4294. regexps+))
  4295. (goto-char beg)
  4296. (setq marker (org-agenda-new-marker (point))
  4297. category (org-get-category)
  4298. level (make-string (org-reduced-level (org-outline-level)) ? )
  4299. inherited-tags
  4300. (or (eq org-agenda-show-inherited-tags 'always)
  4301. (and (listp org-agenda-show-inherited-tags)
  4302. (memq 'todo org-agenda-show-inherited-tags))
  4303. (and (eq org-agenda-show-inherited-tags t)
  4304. (or (eq org-agenda-use-tag-inheritance t)
  4305. (memq 'todo org-agenda-use-tag-inheritance))))
  4306. tags (org-get-tags nil (not inherited-tags))
  4307. txt (org-agenda-format-item
  4308. ""
  4309. (buffer-substring-no-properties
  4310. beg1 (point-at-eol))
  4311. level category tags t))
  4312. (org-add-props txt props
  4313. 'org-marker marker 'org-hd-marker marker
  4314. 'org-todo-regexp org-todo-regexp
  4315. 'level level
  4316. 'org-complex-heading-regexp org-complex-heading-regexp
  4317. 'priority 1000
  4318. 'type "search")
  4319. (push txt ee)
  4320. (goto-char (1- end))))))))))
  4321. (setq rtn (nreverse ee))
  4322. (setq rtnall (append rtnall rtn)))
  4323. (org-agenda--insert-overriding-header
  4324. (with-temp-buffer
  4325. (insert "Search words: ")
  4326. (add-text-properties (point-min) (1- (point))
  4327. (list 'face 'org-agenda-structure))
  4328. (setq pos (point))
  4329. (insert string "\n")
  4330. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4331. (setq pos (point))
  4332. (unless org-agenda-multi
  4333. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4334. Press `\\[org-agenda-manipulate-query-add]', \
  4335. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4336. `\\[org-agenda-manipulate-query-add-re]', \
  4337. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4338. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4339. (add-text-properties pos (1- (point))
  4340. (list 'face 'org-agenda-structure)))
  4341. (buffer-string)))
  4342. (org-agenda-mark-header-line (point-min))
  4343. (when rtnall
  4344. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4345. (goto-char (point-min))
  4346. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4347. (add-text-properties (point-min) (point-max)
  4348. `(org-agenda-type search
  4349. org-last-args (,todo-only ,string ,edit-at)
  4350. org-redo-cmd ,org-agenda-redo-command
  4351. org-series-cmd ,org-cmd))
  4352. (org-agenda-finalize)
  4353. (setq buffer-read-only t))))
  4354. ;;; Agenda TODO list
  4355. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4356. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4357. (concat
  4358. (if (or (equal keywords "ALL") (not keywords))
  4359. (propertize "ALL" 'face 'warning)
  4360. (mapconcat
  4361. (lambda (kw)
  4362. (propertize kw 'face (org-get-todo-face kw)))
  4363. (org-split-string keywords "|")
  4364. "|"))
  4365. "\n"))
  4366. (defvar org-select-this-todo-keyword nil)
  4367. (defvar org-last-arg nil)
  4368. ;;;###autoload
  4369. (defun org-todo-list (&optional arg)
  4370. "Show all (not done) TODO entries from all agenda file in a single list.
  4371. The prefix arg can be used to select a specific TODO keyword and limit
  4372. the list to these. When using `\\[universal-argument]', you will be prompted
  4373. for a keyword. A numeric prefix directly selects the Nth keyword in
  4374. `org-todo-keywords-1'."
  4375. (interactive "P")
  4376. (when org-agenda-overriding-arguments
  4377. (setq arg org-agenda-overriding-arguments))
  4378. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4379. (let* ((today (org-today))
  4380. (date (calendar-gregorian-from-absolute today))
  4381. (completion-ignore-case t)
  4382. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4383. (catch 'exit
  4384. (when org-agenda-sticky
  4385. (setq org-agenda-buffer-name
  4386. (if (stringp org-select-this-todo-keyword)
  4387. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4388. org-select-this-todo-keyword)
  4389. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4390. (org-agenda-prepare "TODO")
  4391. (setq kwds org-todo-keywords-for-agenda
  4392. org-select-this-todo-keyword (if (stringp arg) arg
  4393. (and (integerp arg)
  4394. (> arg 0)
  4395. (nth (1- arg) kwds))))
  4396. (when (equal arg '(4))
  4397. (setq org-select-this-todo-keyword
  4398. (completing-read "Keyword (or KWD1|K2D2|...): "
  4399. (mapcar #'list kwds) nil nil)))
  4400. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4401. (org-compile-prefix-format 'todo)
  4402. (org-set-sorting-strategy 'todo)
  4403. (setq org-agenda-redo-command
  4404. `(org-todo-list (or (and (numberp current-prefix-arg)
  4405. current-prefix-arg)
  4406. ,org-select-this-todo-keyword
  4407. current-prefix-arg ,arg)))
  4408. (setq files (org-agenda-files nil 'ifmode)
  4409. rtnall nil)
  4410. (while (setq file (pop files))
  4411. (catch 'nextfile
  4412. (org-check-agenda-file file)
  4413. (setq rtn (org-agenda-get-day-entries file date :todo))
  4414. (setq rtnall (append rtnall rtn))))
  4415. (org-agenda--insert-overriding-header
  4416. (with-temp-buffer
  4417. (insert "Global list of TODO items of type: ")
  4418. (add-text-properties (point-min) (1- (point))
  4419. (list 'face 'org-agenda-structure
  4420. 'short-heading
  4421. (concat "ToDo: "
  4422. (or org-select-this-todo-keyword "ALL"))))
  4423. (org-agenda-mark-header-line (point-min))
  4424. (insert (org-agenda-propertize-selected-todo-keywords
  4425. org-select-this-todo-keyword))
  4426. (setq pos (point))
  4427. (unless org-agenda-multi
  4428. (insert (substitute-command-keys "Press \
  4429. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4430. to search again: (0)[ALL]"))
  4431. (let ((n 0))
  4432. (dolist (k kwds)
  4433. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4434. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4435. (insert "\n "))
  4436. (insert " " s))))
  4437. (insert "\n"))
  4438. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4439. (buffer-string)))
  4440. (org-agenda-mark-header-line (point-min))
  4441. (when rtnall
  4442. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4443. (goto-char (point-min))
  4444. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4445. (add-text-properties (point-min) (point-max)
  4446. `(org-agenda-type todo
  4447. org-last-args ,arg
  4448. org-redo-cmd ,org-agenda-redo-command
  4449. org-series-cmd ,org-cmd))
  4450. (org-agenda-finalize)
  4451. (setq buffer-read-only t))))
  4452. ;;; Agenda tags match
  4453. ;;;###autoload
  4454. (defun org-tags-view (&optional todo-only match)
  4455. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4456. The prefix arg TODO-ONLY limits the search to TODO entries."
  4457. (interactive "P")
  4458. (when org-agenda-overriding-arguments
  4459. (setq todo-only (car org-agenda-overriding-arguments)
  4460. match (nth 1 org-agenda-overriding-arguments)))
  4461. (let* ((org-tags-match-list-sublevels
  4462. org-tags-match-list-sublevels)
  4463. (completion-ignore-case t)
  4464. (org--matcher-tags-todo-only todo-only)
  4465. rtn rtnall files file pos matcher
  4466. buffer)
  4467. (when (and (stringp match) (not (string-match "\\S-" match)))
  4468. (setq match nil))
  4469. (catch 'exit
  4470. ;; TODO: this code is repeated a lot...
  4471. (when org-agenda-sticky
  4472. (setq org-agenda-buffer-name
  4473. (if (stringp match)
  4474. (format "*Org Agenda(%s:%s)*"
  4475. (or org-keys (or (and todo-only "M") "m")) match)
  4476. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4477. (setq matcher (org-make-tags-matcher match))
  4478. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4479. ;; expanding tags within `org-make-tags-matcher'
  4480. (org-agenda-prepare (concat "TAGS " match))
  4481. (setq match (car matcher)
  4482. matcher (cdr matcher))
  4483. (org-compile-prefix-format 'tags)
  4484. (org-set-sorting-strategy 'tags)
  4485. (setq org-agenda-query-string match)
  4486. (setq org-agenda-redo-command
  4487. (list 'org-tags-view
  4488. `(quote ,org--matcher-tags-todo-only)
  4489. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4490. (setq files (org-agenda-files nil 'ifmode)
  4491. rtnall nil)
  4492. (while (setq file (pop files))
  4493. (catch 'nextfile
  4494. (org-check-agenda-file file)
  4495. (setq buffer (if (file-exists-p file)
  4496. (org-get-agenda-file-buffer file)
  4497. (error "No such file %s" file)))
  4498. (if (not buffer)
  4499. ;; If file does not exist, error message to agenda
  4500. (setq rtn (list
  4501. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4502. rtnall (append rtnall rtn))
  4503. (with-current-buffer buffer
  4504. (unless (derived-mode-p 'org-mode)
  4505. (error "Agenda file %s is not in Org mode" file))
  4506. (save-excursion
  4507. (save-restriction
  4508. (if (eq buffer org-agenda-restrict)
  4509. (narrow-to-region org-agenda-restrict-begin
  4510. org-agenda-restrict-end)
  4511. (widen))
  4512. (setq rtn (org-scan-tags 'agenda
  4513. matcher
  4514. org--matcher-tags-todo-only))
  4515. (setq rtnall (append rtnall rtn))))))))
  4516. (org-agenda--insert-overriding-header
  4517. (with-temp-buffer
  4518. (insert "Headlines with TAGS match: ")
  4519. (add-text-properties (point-min) (1- (point))
  4520. (list 'face 'org-agenda-structure
  4521. 'short-heading
  4522. (concat "Match: " match)))
  4523. (setq pos (point))
  4524. (insert match "\n")
  4525. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4526. (setq pos (point))
  4527. (unless org-agenda-multi
  4528. (insert (substitute-command-keys
  4529. "Press \
  4530. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4531. to search again\n")))
  4532. (add-text-properties pos (1- (point))
  4533. (list 'face 'org-agenda-structure))
  4534. (buffer-string)))
  4535. (org-agenda-mark-header-line (point-min))
  4536. (when rtnall
  4537. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4538. (goto-char (point-min))
  4539. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4540. (add-text-properties
  4541. (point-min) (point-max)
  4542. `(org-agenda-type tags
  4543. org-last-args (,org--matcher-tags-todo-only ,match)
  4544. org-redo-cmd ,org-agenda-redo-command
  4545. org-series-cmd ,org-cmd))
  4546. (org-agenda-finalize)
  4547. (setq buffer-read-only t))))
  4548. ;;; Agenda Finding stuck projects
  4549. (defvar org-agenda-skip-regexp nil
  4550. "Regular expression used in skipping subtrees for the agenda.
  4551. This is basically a temporary global variable that can be set and then
  4552. used by user-defined selections using `org-agenda-skip-function'.")
  4553. (defvar org-agenda-overriding-header nil
  4554. "When set during agenda, todo and tags searches it replaces the header.
  4555. If an empty string, no header will be inserted. If any other
  4556. string, it will be inserted as a header. If nil, a header will
  4557. be generated automatically according to the command. This
  4558. variable should not be set directly, but custom commands can bind
  4559. it in the options section.")
  4560. (defun org-agenda-skip-entry-if (&rest conditions)
  4561. "Skip entry if any of CONDITIONS is true.
  4562. See `org-agenda-skip-if' for details."
  4563. (org-agenda-skip-if nil conditions))
  4564. (defun org-agenda-skip-subtree-if (&rest conditions)
  4565. "Skip subtree if any of CONDITIONS is true.
  4566. See `org-agenda-skip-if' for details."
  4567. (org-agenda-skip-if t conditions))
  4568. (defun org-agenda-skip-if (subtree conditions)
  4569. "Checks current entity for CONDITIONS.
  4570. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4571. the entry (i.e. the text before the next heading) is checked.
  4572. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4573. from different tests. Valid conditions are:
  4574. scheduled Check if there is a scheduled cookie
  4575. notscheduled Check if there is no scheduled cookie
  4576. deadline Check if there is a deadline
  4577. notdeadline Check if there is no deadline
  4578. timestamp Check if there is a timestamp (also deadline or scheduled)
  4579. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4580. regexp Check if regexp matches
  4581. notregexp Check if regexp does not match.
  4582. todo Check if TODO keyword matches
  4583. nottodo Check if TODO keyword does not match
  4584. The regexp is taken from the conditions list, it must come right after
  4585. the `regexp' or `notregexp' element.
  4586. `todo' and `nottodo' accept as an argument a list of todo
  4587. keywords, which may include \"*\" to match any todo keyword.
  4588. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4589. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4590. Instead of a list, a keyword class may be given. For example:
  4591. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4592. would skip entries that haven't been marked with any of \"DONE\"
  4593. keywords. Possible classes are: `todo', `done', `any'.
  4594. If any of these conditions is met, this function returns the end point of
  4595. the entity, causing the search to continue from there. This is a function
  4596. that can be put into `org-agenda-skip-function' for the duration of a command."
  4597. (org-back-to-heading t)
  4598. (let* ((beg (point))
  4599. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4600. (org-entry-end-position)))
  4601. (planning-end (if subtree end (line-end-position 2)))
  4602. m)
  4603. (and
  4604. (or (and (memq 'scheduled conditions)
  4605. (re-search-forward org-scheduled-time-regexp planning-end t))
  4606. (and (memq 'notscheduled conditions)
  4607. (not
  4608. (save-excursion
  4609. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4610. (and (memq 'deadline conditions)
  4611. (re-search-forward org-deadline-time-regexp planning-end t))
  4612. (and (memq 'notdeadline conditions)
  4613. (not
  4614. (save-excursion
  4615. (re-search-forward org-deadline-time-regexp planning-end t))))
  4616. (and (memq 'timestamp conditions)
  4617. (re-search-forward org-ts-regexp end t))
  4618. (and (memq 'nottimestamp conditions)
  4619. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4620. (and (setq m (memq 'regexp conditions))
  4621. (stringp (nth 1 m))
  4622. (re-search-forward (nth 1 m) end t))
  4623. (and (setq m (memq 'notregexp conditions))
  4624. (stringp (nth 1 m))
  4625. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4626. (and (or
  4627. (setq m (memq 'nottodo conditions))
  4628. (setq m (memq 'todo-unblocked conditions))
  4629. (setq m (memq 'nottodo-unblocked conditions))
  4630. (setq m (memq 'todo conditions)))
  4631. (org-agenda-skip-if-todo m end)))
  4632. end)))
  4633. (defun org-agenda-skip-if-todo (args end)
  4634. "Helper function for `org-agenda-skip-if', do not use it directly.
  4635. ARGS is a list with first element either `todo', `nottodo',
  4636. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4637. a list of TODO keywords, or a state symbol `todo' or `done' or
  4638. `any'."
  4639. (let ((todo-re
  4640. (concat "^\\*+[ \t]+"
  4641. (regexp-opt
  4642. (pcase args
  4643. (`(,_ todo)
  4644. (org-delete-all org-done-keywords
  4645. (copy-sequence org-todo-keywords-1)))
  4646. (`(,_ done) org-done-keywords)
  4647. (`(,_ any) org-todo-keywords-1)
  4648. (`(,_ ,(pred atom))
  4649. (error "Invalid TODO class or type: %S" args))
  4650. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4651. (`(,_ ,todo-list) todo-list))
  4652. 'words))))
  4653. (pcase args
  4654. (`(todo . ,_)
  4655. (let (case-fold-search) (re-search-forward todo-re end t)))
  4656. (`(nottodo . ,_)
  4657. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4658. (`(todo-unblocked . ,_)
  4659. (catch :unblocked
  4660. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4661. (when (org-entry-blocked-p) (throw :unblocked t)))
  4662. nil))
  4663. (`(nottodo-unblocked . ,_)
  4664. (catch :unblocked
  4665. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4666. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4667. t))
  4668. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4669. ;;;###autoload
  4670. (defun org-agenda-list-stuck-projects (&rest ignore)
  4671. "Create agenda view for projects that are stuck.
  4672. Stuck projects are project that have no next actions. For the definitions
  4673. of what a project is and how to check if it stuck, customize the variable
  4674. `org-stuck-projects'."
  4675. (interactive)
  4676. (let* ((org-agenda-overriding-header
  4677. (or org-agenda-overriding-header "List of stuck projects: "))
  4678. (matcher (nth 0 org-stuck-projects))
  4679. (todo (nth 1 org-stuck-projects))
  4680. (tags (nth 2 org-stuck-projects))
  4681. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4682. (todo-wds
  4683. (if (not (member "*" todo)) todo
  4684. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4685. (org-delete-all org-done-keywords-for-agenda
  4686. (copy-sequence org-todo-keywords-for-agenda))))
  4687. (todo-re (and todo
  4688. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4689. (mapconcat #'identity todo-wds "\\|"))))
  4690. (tags-re (cond ((null tags) nil)
  4691. ((member "*" tags) org-tag-line-re)
  4692. (tags
  4693. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4694. (concat org-outline-regexp-bol
  4695. ".*?[ \t]:"
  4696. other-tags
  4697. (regexp-opt tags t)
  4698. ":" other-tags "[ \t]*$")))
  4699. (t nil)))
  4700. (re-list (delq nil (list todo-re tags-re gen-re)))
  4701. (skip-re
  4702. (if (null re-list)
  4703. (error "Missing information to identify unstuck projects")
  4704. (mapconcat #'identity re-list "\\|")))
  4705. (org-agenda-skip-function
  4706. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4707. ;; in the subtree.
  4708. `(lambda ()
  4709. (and (save-excursion
  4710. (let ((case-fold-search nil))
  4711. (re-search-forward
  4712. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4713. (progn (outline-next-heading) (point))))))
  4714. (org-tags-view nil matcher)
  4715. (setq org-agenda-buffer-name (buffer-name))
  4716. (with-current-buffer org-agenda-buffer-name
  4717. (setq org-agenda-redo-command
  4718. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4719. (let ((inhibit-read-only t))
  4720. (add-text-properties
  4721. (point-min) (point-max)
  4722. `(org-redo-cmd ,org-agenda-redo-command))))))
  4723. ;;; Diary integration
  4724. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4725. (defvar diary-list-entries-hook)
  4726. (defvar diary-time-regexp)
  4727. (defun org-get-entries-from-diary (date)
  4728. "Get the (Emacs Calendar) diary entries for DATE."
  4729. (require 'diary-lib)
  4730. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4731. (diary-display-function 'diary-fancy-display)
  4732. (pop-up-frames nil)
  4733. (diary-list-entries-hook
  4734. (cons 'org-diary-default-entry diary-list-entries-hook))
  4735. (diary-file-name-prefix nil) ; turn this feature off
  4736. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4737. (diary-time-regexp (concat "^" diary-time-regexp))
  4738. entries
  4739. (org-disable-agenda-to-diary t))
  4740. (save-excursion
  4741. (save-window-excursion
  4742. (funcall (if (fboundp 'diary-list-entries)
  4743. 'diary-list-entries 'list-diary-entries)
  4744. date 1)))
  4745. (if (not (get-buffer diary-fancy-buffer))
  4746. (setq entries nil)
  4747. (with-current-buffer diary-fancy-buffer
  4748. (setq buffer-read-only nil)
  4749. (if (zerop (buffer-size))
  4750. ;; No entries
  4751. (setq entries nil)
  4752. ;; Omit the date and other unnecessary stuff
  4753. (org-agenda-cleanup-fancy-diary)
  4754. ;; Add prefix to each line and extend the text properties
  4755. (if (zerop (buffer-size))
  4756. (setq entries nil)
  4757. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4758. (setq entries
  4759. (with-temp-buffer
  4760. (insert entries) (goto-char (point-min))
  4761. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4762. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4763. (replace-match (concat "; " (match-string 1)))))
  4764. (buffer-string)))))
  4765. (set-buffer-modified-p nil)
  4766. (kill-buffer diary-fancy-buffer)))
  4767. (when entries
  4768. (setq entries (org-split-string entries "\n"))
  4769. (setq entries
  4770. (mapcar
  4771. (lambda (x)
  4772. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4773. ;; Extend the text properties to the beginning of the line
  4774. (org-add-props x (text-properties-at (1- (length x)) x)
  4775. 'type "diary" 'date date 'face 'org-agenda-diary))
  4776. entries)))))
  4777. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4778. "Hook run when the fancy diary buffer is cleaned up.")
  4779. (defun org-agenda-cleanup-fancy-diary ()
  4780. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4781. This gets rid of the date, the underline under the date, and the
  4782. dummy entry installed by Org mode to ensure non-empty diary for
  4783. each date. It also removes lines that contain only whitespace."
  4784. (goto-char (point-min))
  4785. (if (looking-at ".*?:[ \t]*")
  4786. (progn
  4787. (replace-match "")
  4788. (re-search-forward "\n=+$" nil t)
  4789. (replace-match "")
  4790. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4791. (re-search-forward "\n=+$" nil t)
  4792. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4793. (goto-char (point-min))
  4794. (while (re-search-forward "^ +\n" nil t)
  4795. (replace-match ""))
  4796. (goto-char (point-min))
  4797. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4798. (replace-match ""))
  4799. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4800. (defun org-modify-diary-entry-string (string)
  4801. "Add text properties to string, allowing Org to act on it."
  4802. (org-add-props string nil
  4803. 'mouse-face 'highlight
  4804. 'help-echo (if buffer-file-name
  4805. (format "mouse-2 or RET jump to diary file %s"
  4806. (abbreviate-file-name buffer-file-name))
  4807. "")
  4808. 'org-agenda-diary-link t
  4809. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4810. (defun org-diary-default-entry ()
  4811. "Add a dummy entry to the diary.
  4812. Needed to avoid empty dates which mess up holiday display."
  4813. ;; Catch the error if dealing with the new add-to-diary-alist
  4814. (when org-disable-agenda-to-diary
  4815. (condition-case nil
  4816. (org-add-to-diary-list original-date "Org mode dummy" "")
  4817. (error
  4818. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4819. (defun org-add-to-diary-list (&rest args)
  4820. (if (fboundp 'diary-add-to-list)
  4821. (apply 'diary-add-to-list args)
  4822. (apply 'add-to-diary-list args)))
  4823. (defvar org-diary-last-run-time nil)
  4824. ;;;###autoload
  4825. (defun org-diary (&rest args)
  4826. "Return diary information from org files.
  4827. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4828. It accesses org files and extracts information from those files to be
  4829. listed in the diary. The function accepts arguments specifying what
  4830. items should be listed. For a list of arguments allowed here, see the
  4831. variable `org-agenda-entry-types'.
  4832. The call in the diary file should look like this:
  4833. &%%(org-diary) ~/path/to/some/orgfile.org
  4834. Use a separate line for each org file to check. Or, if you omit the file name,
  4835. all files listed in `org-agenda-files' will be checked automatically:
  4836. &%%(org-diary)
  4837. If you don't give any arguments (as in the example above), the default value
  4838. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4839. So the example above may also be written as
  4840. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4841. The function expects the lisp variables `entry' and `date' to be provided
  4842. by the caller, because this is how the calendar works. Don't use this
  4843. function from a program - use `org-agenda-get-day-entries' instead."
  4844. (when (> (- (float-time)
  4845. org-agenda-last-marker-time)
  4846. 5)
  4847. ;; I am not sure if this works with sticky agendas, because the marker
  4848. ;; list is then no longer a global variable.
  4849. (org-agenda-reset-markers))
  4850. (org-compile-prefix-format 'agenda)
  4851. (org-set-sorting-strategy 'agenda)
  4852. (setq args (or args org-agenda-entry-types))
  4853. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4854. (list entry)
  4855. (org-agenda-files t)))
  4856. (time (float-time))
  4857. file rtn results)
  4858. (when (or (not org-diary-last-run-time)
  4859. (> (- time
  4860. org-diary-last-run-time)
  4861. 3))
  4862. (org-agenda-prepare-buffers files))
  4863. (setq org-diary-last-run-time time)
  4864. ;; If this is called during org-agenda, don't return any entries to
  4865. ;; the calendar. Org Agenda will list these entries itself.
  4866. (when org-disable-agenda-to-diary (setq files nil))
  4867. (while (setq file (pop files))
  4868. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4869. (setq results (append results rtn)))
  4870. (when results
  4871. (setq results
  4872. (mapcar (lambda (i) (replace-regexp-in-string
  4873. org-link-bracket-re "\\2" i))
  4874. results))
  4875. (concat (org-agenda-finalize-entries results) "\n"))))
  4876. ;;; Agenda entry finders
  4877. (defun org-agenda--timestamp-to-absolute (&rest args)
  4878. "Call `org-time-string-to-absolute' with ARGS.
  4879. However, throw `:skip' whenever an error is raised."
  4880. (condition-case e
  4881. (apply #'org-time-string-to-absolute args)
  4882. (org-diary-sexp-no-match (throw :skip nil))
  4883. (error
  4884. (message "%s; Skipping entry" (error-message-string e))
  4885. (throw :skip nil))))
  4886. (defun org-agenda-get-day-entries (file date &rest args)
  4887. "Does the work for `org-diary' and `org-agenda'.
  4888. FILE is the path to a file to be checked for entries. DATE is date like
  4889. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4890. which kind of entries should be extracted. For details about these, see
  4891. the documentation of `org-diary'."
  4892. (let* ((org-startup-folded nil)
  4893. (org-startup-align-all-tables nil)
  4894. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4895. (error "No such file %s" file))))
  4896. (if (not buffer)
  4897. ;; If file does not exist, signal it in diary nonetheless.
  4898. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4899. (with-current-buffer buffer
  4900. (unless (derived-mode-p 'org-mode)
  4901. (error "Agenda file %s is not in Org mode" file))
  4902. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4903. (setf org-agenda-current-date date)
  4904. (save-excursion
  4905. (save-restriction
  4906. (if (eq buffer org-agenda-restrict)
  4907. (narrow-to-region org-agenda-restrict-begin
  4908. org-agenda-restrict-end)
  4909. (widen))
  4910. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4911. ;; first in order to populate DEADLINES before passing it.
  4912. ;;
  4913. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4914. ;; guarding us from modifying `org-agenda-entry-types'.
  4915. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4916. (when (and (memq :scheduled args) (memq :scheduled* args))
  4917. (setf args (delq :scheduled* args)))
  4918. (cond
  4919. ((memq :deadline args)
  4920. (setf args (cons :deadline
  4921. (delq :deadline (delq :deadline* args)))))
  4922. ((memq :deadline* args)
  4923. (setf args (cons :deadline* (delq :deadline* args)))))
  4924. ;; Collect list of headlines. Return them flattened.
  4925. (let ((case-fold-search nil) results deadlines)
  4926. (dolist (arg args (apply #'nconc (nreverse results)))
  4927. (pcase arg
  4928. ((and :todo (guard (org-agenda-today-p date)))
  4929. (push (org-agenda-get-todos) results))
  4930. (:timestamp
  4931. (push (org-agenda-get-blocks) results)
  4932. (push (org-agenda-get-timestamps deadlines) results))
  4933. (:sexp
  4934. (push (org-agenda-get-sexps) results))
  4935. (:scheduled
  4936. (push (org-agenda-get-scheduled deadlines) results))
  4937. (:scheduled*
  4938. (push (org-agenda-get-scheduled deadlines t) results))
  4939. (:closed
  4940. (push (org-agenda-get-progress) results))
  4941. (:deadline
  4942. (setf deadlines (org-agenda-get-deadlines))
  4943. (push deadlines results))
  4944. (:deadline*
  4945. (setf deadlines (org-agenda-get-deadlines t))
  4946. (push deadlines results)))))))))))
  4947. (defsubst org-em (x y list)
  4948. "Is X or Y a member of LIST?"
  4949. (or (memq x list) (memq y list)))
  4950. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4951. (defvar org-agenda-sorting-strategy-selected nil)
  4952. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4953. "Retrieve timestamp information for sorting agenda views.
  4954. Given a point or marker POM, returns a cons cell of the timestamp
  4955. and the timestamp type relevant for the sorting strategy in
  4956. `org-agenda-sorting-strategy-selected'."
  4957. (let (ts ts-date-type)
  4958. (save-match-data
  4959. (cond ((org-em 'scheduled-up 'scheduled-down
  4960. org-agenda-sorting-strategy-selected)
  4961. (setq ts (org-entry-get pom "SCHEDULED")
  4962. ts-date-type " scheduled"))
  4963. ((org-em 'deadline-up 'deadline-down
  4964. org-agenda-sorting-strategy-selected)
  4965. (setq ts (org-entry-get pom "DEADLINE")
  4966. ts-date-type " deadline"))
  4967. ((org-em 'ts-up 'ts-down
  4968. org-agenda-sorting-strategy-selected)
  4969. (setq ts (org-entry-get pom "TIMESTAMP")
  4970. ts-date-type " timestamp"))
  4971. ((org-em 'tsia-up 'tsia-down
  4972. org-agenda-sorting-strategy-selected)
  4973. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4974. ts-date-type " timestamp_ia"))
  4975. ((org-em 'timestamp-up 'timestamp-down
  4976. org-agenda-sorting-strategy-selected)
  4977. (setq ts (or (org-entry-get pom "SCHEDULED")
  4978. (org-entry-get pom "DEADLINE")
  4979. (org-entry-get pom "TIMESTAMP")
  4980. (org-entry-get pom "TIMESTAMP_IA"))
  4981. ts-date-type ""))
  4982. (t (setq ts-date-type "")))
  4983. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4984. ts-date-type))))
  4985. (defun org-agenda-get-todos ()
  4986. "Return the TODO information for agenda display."
  4987. (let* ((props (list 'face nil
  4988. 'done-face 'org-agenda-done
  4989. 'org-not-done-regexp org-not-done-regexp
  4990. 'org-todo-regexp org-todo-regexp
  4991. 'org-complex-heading-regexp org-complex-heading-regexp
  4992. 'mouse-face 'highlight
  4993. 'help-echo
  4994. (format "mouse-2 or RET jump to org file %s"
  4995. (abbreviate-file-name buffer-file-name))))
  4996. (case-fold-search nil)
  4997. (regexp (format org-heading-keyword-regexp-format
  4998. (cond
  4999. ((and org-select-this-todo-keyword
  5000. (equal org-select-this-todo-keyword "*"))
  5001. org-todo-regexp)
  5002. (org-select-this-todo-keyword
  5003. (concat "\\("
  5004. (mapconcat 'identity
  5005. (org-split-string
  5006. org-select-this-todo-keyword
  5007. "|")
  5008. "\\|") "\\)"))
  5009. (t org-not-done-regexp))))
  5010. marker priority category level tags todo-state
  5011. ts-date ts-date-type ts-date-pair
  5012. ee txt beg end inherited-tags todo-state-end-pos)
  5013. (goto-char (point-min))
  5014. (while (re-search-forward regexp nil t)
  5015. (catch :skip
  5016. (save-match-data
  5017. (beginning-of-line)
  5018. (org-agenda-skip)
  5019. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5020. (unless (and (setq todo-state (org-get-todo-state))
  5021. (setq todo-state-end-pos (match-end 2)))
  5022. (goto-char end)
  5023. (throw :skip nil))
  5024. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5025. (goto-char (1+ beg))
  5026. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5027. (throw :skip nil)))
  5028. (goto-char (match-beginning 2))
  5029. (setq marker (org-agenda-new-marker (match-beginning 0))
  5030. category (org-get-category)
  5031. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5032. ts-date (car ts-date-pair)
  5033. ts-date-type (cdr ts-date-pair)
  5034. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5035. inherited-tags
  5036. (or (eq org-agenda-show-inherited-tags 'always)
  5037. (and (listp org-agenda-show-inherited-tags)
  5038. (memq 'todo org-agenda-show-inherited-tags))
  5039. (and (eq org-agenda-show-inherited-tags t)
  5040. (or (eq org-agenda-use-tag-inheritance t)
  5041. (memq 'todo org-agenda-use-tag-inheritance))))
  5042. tags (org-get-tags nil (not inherited-tags))
  5043. level (make-string (org-reduced-level (org-outline-level)) ? )
  5044. txt (org-agenda-format-item "" txt level category tags t)
  5045. priority (1+ (org-get-priority txt)))
  5046. (org-add-props txt props
  5047. 'org-marker marker 'org-hd-marker marker
  5048. 'priority priority
  5049. 'level level
  5050. 'ts-date ts-date
  5051. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5052. (push txt ee)
  5053. (if org-agenda-todo-list-sublevels
  5054. (goto-char todo-state-end-pos)
  5055. (org-end-of-subtree 'invisible))))
  5056. (nreverse ee)))
  5057. (defun org-agenda-todo-custom-ignore-p (time n)
  5058. "Check whether timestamp is farther away than n number of days.
  5059. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5060. `org-agenda-todo-ignore-scheduled' or
  5061. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5062. (let ((days (org-time-stamp-to-now
  5063. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5064. (if (>= n 0)
  5065. (>= days n)
  5066. (<= days n))))
  5067. ;;;###autoload
  5068. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5069. (&optional end)
  5070. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5071. (when (or org-agenda-todo-ignore-with-date
  5072. org-agenda-todo-ignore-scheduled
  5073. org-agenda-todo-ignore-deadlines
  5074. org-agenda-todo-ignore-timestamp)
  5075. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5076. (save-excursion
  5077. (or (and org-agenda-todo-ignore-with-date
  5078. (re-search-forward org-ts-regexp end t))
  5079. (and org-agenda-todo-ignore-scheduled
  5080. (re-search-forward org-scheduled-time-regexp end t)
  5081. (cond
  5082. ((eq org-agenda-todo-ignore-scheduled 'future)
  5083. (> (org-time-stamp-to-now
  5084. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5085. 0))
  5086. ((eq org-agenda-todo-ignore-scheduled 'past)
  5087. (<= (org-time-stamp-to-now
  5088. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5089. 0))
  5090. ((numberp org-agenda-todo-ignore-scheduled)
  5091. (org-agenda-todo-custom-ignore-p
  5092. (match-string 1) org-agenda-todo-ignore-scheduled))
  5093. (t)))
  5094. (and org-agenda-todo-ignore-deadlines
  5095. (re-search-forward org-deadline-time-regexp end t)
  5096. (cond
  5097. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5098. ((eq org-agenda-todo-ignore-deadlines 'far)
  5099. (not (org-deadline-close-p (match-string 1))))
  5100. ((eq org-agenda-todo-ignore-deadlines 'future)
  5101. (> (org-time-stamp-to-now
  5102. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5103. 0))
  5104. ((eq org-agenda-todo-ignore-deadlines 'past)
  5105. (<= (org-time-stamp-to-now
  5106. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5107. 0))
  5108. ((numberp org-agenda-todo-ignore-deadlines)
  5109. (org-agenda-todo-custom-ignore-p
  5110. (match-string 1) org-agenda-todo-ignore-deadlines))
  5111. (t (org-deadline-close-p (match-string 1)))))
  5112. (and org-agenda-todo-ignore-timestamp
  5113. (let ((buffer (current-buffer))
  5114. (regexp
  5115. (concat
  5116. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5117. (start (point)))
  5118. ;; Copy current buffer into a temporary one
  5119. (with-temp-buffer
  5120. (insert-buffer-substring buffer start end)
  5121. (goto-char (point-min))
  5122. ;; Delete SCHEDULED and DEADLINE items
  5123. (while (re-search-forward regexp end t)
  5124. (delete-region (match-beginning 0) (match-end 0)))
  5125. (goto-char (point-min))
  5126. ;; No search for timestamp left
  5127. (when (re-search-forward org-ts-regexp nil t)
  5128. (cond
  5129. ((eq org-agenda-todo-ignore-timestamp 'future)
  5130. (> (org-time-stamp-to-now
  5131. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5132. 0))
  5133. ((eq org-agenda-todo-ignore-timestamp 'past)
  5134. (<= (org-time-stamp-to-now
  5135. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5136. 0))
  5137. ((numberp org-agenda-todo-ignore-timestamp)
  5138. (org-agenda-todo-custom-ignore-p
  5139. (match-string 1) org-agenda-todo-ignore-timestamp))
  5140. (t))))))))))
  5141. (defun org-agenda-get-timestamps (&optional deadlines)
  5142. "Return the date stamp information for agenda display.
  5143. Optional argument DEADLINES is a list of deadline items to be
  5144. displayed in agenda view."
  5145. (let* ((props (list 'face 'org-agenda-calendar-event
  5146. 'org-not-done-regexp org-not-done-regexp
  5147. 'org-todo-regexp org-todo-regexp
  5148. 'org-complex-heading-regexp org-complex-heading-regexp
  5149. 'mouse-face 'highlight
  5150. 'help-echo
  5151. (format "mouse-2 or RET jump to Org file %s"
  5152. (abbreviate-file-name buffer-file-name))))
  5153. (current (calendar-absolute-from-gregorian date))
  5154. (today (org-today))
  5155. (deadline-position-alist
  5156. (mapcar (lambda (d)
  5157. (let ((m (get-text-property 0 'org-hd-marker d)))
  5158. (and m (marker-position m))))
  5159. deadlines))
  5160. ;; Match time-stamps set to current date, time-stamps with
  5161. ;; a repeater, and S-exp time-stamps.
  5162. (regexp
  5163. (concat
  5164. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5165. (regexp-quote
  5166. (substring
  5167. (format-time-string
  5168. (car org-time-stamp-formats)
  5169. (encode-time ; DATE bound by calendar
  5170. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5171. 1 11))
  5172. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5173. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5174. timestamp-items)
  5175. (goto-char (point-min))
  5176. (while (re-search-forward regexp nil t)
  5177. ;; Skip date ranges, scheduled and deadlines, which are handled
  5178. ;; specially. Also skip time-stamps before first headline as
  5179. ;; there would be no entry to add to the agenda. Eventually,
  5180. ;; ignore clock entries.
  5181. (catch :skip
  5182. (save-match-data
  5183. (when (or (org-at-date-range-p)
  5184. (org-at-planning-p)
  5185. (org-before-first-heading-p)
  5186. (and org-agenda-include-inactive-timestamps
  5187. (org-at-clock-log-p)))
  5188. (throw :skip nil))
  5189. (org-agenda-skip))
  5190. (let* ((pos (match-beginning 0))
  5191. (repeat (match-string 1))
  5192. (sexp-entry (match-string 3))
  5193. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5194. (save-excursion
  5195. (goto-char pos)
  5196. (looking-at org-ts-regexp-both)
  5197. (match-string 0))))
  5198. (todo-state (org-get-todo-state))
  5199. (warntime (get-text-property (point) 'org-appt-warntime))
  5200. (done? (member todo-state org-done-keywords)))
  5201. ;; Possibly skip done tasks.
  5202. (when (and done? org-agenda-skip-timestamp-if-done)
  5203. (throw :skip t))
  5204. ;; S-exp entry doesn't match current day: skip it.
  5205. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5206. (throw :skip nil))
  5207. (when repeat
  5208. (let* ((past
  5209. ;; A repeating time stamp is shown at its base
  5210. ;; date and every repeated date up to TODAY. If
  5211. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5212. ;; however, only the last repeat before today
  5213. ;; (inclusive) is shown.
  5214. (org-agenda--timestamp-to-absolute
  5215. repeat
  5216. (if (or (> current today)
  5217. (eq org-agenda-prefer-last-repeat t)
  5218. (member todo-state org-agenda-prefer-last-repeat))
  5219. today
  5220. current)
  5221. 'past (current-buffer) pos))
  5222. (future
  5223. ;; Display every repeated date past TODAY
  5224. ;; (exclusive) unless
  5225. ;; `org-agenda-show-future-repeats' is nil. If
  5226. ;; this variable is set to `next', only display
  5227. ;; the first repeated date after TODAY
  5228. ;; (exclusive).
  5229. (cond
  5230. ((<= current today) past)
  5231. ((not org-agenda-show-future-repeats) past)
  5232. (t
  5233. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5234. (1+ today)
  5235. current)))
  5236. (org-agenda--timestamp-to-absolute
  5237. repeat base 'future (current-buffer) pos))))))
  5238. (when (and (/= current past) (/= current future))
  5239. (throw :skip nil))))
  5240. (save-excursion
  5241. (re-search-backward org-outline-regexp-bol nil t)
  5242. ;; Possibly skip time-stamp when a deadline is set.
  5243. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5244. (assq (point) deadline-position-alist))
  5245. (throw :skip nil))
  5246. (let* ((category (org-get-category pos))
  5247. (inherited-tags
  5248. (or (eq org-agenda-show-inherited-tags 'always)
  5249. (and (consp org-agenda-show-inherited-tags)
  5250. (memq 'agenda org-agenda-show-inherited-tags))
  5251. (and (eq org-agenda-show-inherited-tags t)
  5252. (or (eq org-agenda-use-tag-inheritance t)
  5253. (memq 'agenda
  5254. org-agenda-use-tag-inheritance)))))
  5255. (tags (org-get-tags nil (not inherited-tags)))
  5256. (level (make-string (org-reduced-level (org-outline-level))
  5257. ?\s))
  5258. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5259. (match-string 1)))
  5260. (inactive? (= (char-after pos) ?\[))
  5261. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5262. (item
  5263. (org-agenda-format-item
  5264. (and inactive? org-agenda-inactive-leader)
  5265. head level category tags time-stamp org-ts-regexp habit?)))
  5266. (org-add-props item props
  5267. 'priority (if habit?
  5268. (org-habit-get-priority (org-habit-parse-todo))
  5269. (org-get-priority item))
  5270. 'org-marker (org-agenda-new-marker pos)
  5271. 'org-hd-marker (org-agenda-new-marker)
  5272. 'date date
  5273. 'level level
  5274. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5275. current)
  5276. 'todo-state todo-state
  5277. 'warntime warntime
  5278. 'type "timestamp")
  5279. (push item timestamp-items))))
  5280. (when org-agenda-skip-additional-timestamps-same-entry
  5281. (outline-next-heading))))
  5282. (nreverse timestamp-items)))
  5283. (defun org-agenda-get-sexps ()
  5284. "Return the sexp information for agenda display."
  5285. (require 'diary-lib)
  5286. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5287. 'mouse-face 'highlight
  5288. 'help-echo
  5289. (format "mouse-2 or RET jump to org file %s"
  5290. (abbreviate-file-name buffer-file-name))))
  5291. (regexp "^&?%%(")
  5292. marker category extra level ee txt tags entry
  5293. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5294. (goto-char (point-min))
  5295. (while (re-search-forward regexp nil t)
  5296. (catch :skip
  5297. (org-agenda-skip)
  5298. (setq beg (match-beginning 0))
  5299. (goto-char (1- (match-end 0)))
  5300. (setq b (point))
  5301. (forward-sexp 1)
  5302. (setq sexp (buffer-substring b (point)))
  5303. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5304. (org-trim (match-string 1))
  5305. ""))
  5306. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5307. (when result
  5308. (setq marker (org-agenda-new-marker beg)
  5309. level (make-string (org-reduced-level (org-outline-level)) ? )
  5310. category (org-get-category beg)
  5311. inherited-tags
  5312. (or (eq org-agenda-show-inherited-tags 'always)
  5313. (and (listp org-agenda-show-inherited-tags)
  5314. (memq 'agenda org-agenda-show-inherited-tags))
  5315. (and (eq org-agenda-show-inherited-tags t)
  5316. (or (eq org-agenda-use-tag-inheritance t)
  5317. (memq 'agenda org-agenda-use-tag-inheritance))))
  5318. tags (org-get-tags nil (not inherited-tags))
  5319. todo-state (org-get-todo-state)
  5320. warntime (get-text-property (point) 'org-appt-warntime)
  5321. extra nil)
  5322. (dolist (r (if (stringp result)
  5323. (list result)
  5324. result)) ;; we expect a list here
  5325. (when (and org-agenda-diary-sexp-prefix
  5326. (string-match org-agenda-diary-sexp-prefix r))
  5327. (setq extra (match-string 0 r)
  5328. r (replace-match "" nil nil r)))
  5329. (if (string-match "\\S-" r)
  5330. (setq txt r)
  5331. (setq txt "SEXP entry returned empty string"))
  5332. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5333. (org-add-props txt props 'org-marker marker
  5334. 'date date 'todo-state todo-state
  5335. 'level level 'type "sexp" 'warntime warntime)
  5336. (push txt ee)))))
  5337. (nreverse ee)))
  5338. ;; Calendar sanity: define some functions that are independent of
  5339. ;; `calendar-date-style'.
  5340. (defun org-anniversary (year month day &optional mark)
  5341. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5342. (with-no-warnings
  5343. (let ((calendar-date-style 'iso))
  5344. (diary-anniversary year month day mark))))
  5345. (defun org-cyclic (N year month day &optional mark)
  5346. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5347. (with-no-warnings
  5348. (let ((calendar-date-style 'iso))
  5349. (diary-cyclic N year month day mark))))
  5350. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5351. "Like `diary-block', but with fixed (ISO) order of arguments."
  5352. (with-no-warnings
  5353. (let ((calendar-date-style 'iso))
  5354. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5355. (defun org-date (year month day &optional mark)
  5356. "Like `diary-date', but with fixed (ISO) order of arguments."
  5357. (with-no-warnings
  5358. (let ((calendar-date-style 'iso))
  5359. (diary-date year month day mark))))
  5360. ;; Define the `org-class' function
  5361. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5362. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5363. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5364. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5365. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5366. `holidays', then any date that is known by the Emacs calendar to be a
  5367. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5368. then those holidays will be skipped."
  5369. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5370. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5371. (d (calendar-absolute-from-gregorian date))
  5372. (h (when skip-weeks (calendar-check-holidays date))))
  5373. (and
  5374. (<= date1 d)
  5375. (<= d date2)
  5376. (= (calendar-day-of-week date) dayname)
  5377. (or (not skip-weeks)
  5378. (progn
  5379. (require 'cal-iso)
  5380. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5381. (not (or (and h (memq 'holidays skip-weeks))
  5382. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5383. entry)))
  5384. (defalias 'org-get-closed 'org-agenda-get-progress)
  5385. (defun org-agenda-get-progress ()
  5386. "Return the logged TODO entries for agenda display."
  5387. (let* ((props (list 'mouse-face 'highlight
  5388. 'org-not-done-regexp org-not-done-regexp
  5389. 'org-todo-regexp org-todo-regexp
  5390. 'org-complex-heading-regexp org-complex-heading-regexp
  5391. 'help-echo
  5392. (format "mouse-2 or RET jump to org file %s"
  5393. (abbreviate-file-name buffer-file-name))))
  5394. (items (if (consp org-agenda-show-log-scoped)
  5395. org-agenda-show-log-scoped
  5396. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5397. '(clock)
  5398. org-agenda-log-mode-items)))
  5399. (parts
  5400. (delq nil
  5401. (list
  5402. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5403. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5404. (when (memq 'state items)
  5405. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5406. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5407. (error "`org-agenda-log-mode-items' is empty")))
  5408. (regexp (concat
  5409. "\\(" parts-re "\\)"
  5410. " *\\["
  5411. (regexp-quote
  5412. (substring
  5413. (format-time-string
  5414. (car org-time-stamp-formats)
  5415. (encode-time ; DATE bound by calendar
  5416. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5417. 1 11))))
  5418. (org-agenda-search-headline-for-time nil)
  5419. marker hdmarker priority category level tags closedp type
  5420. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5421. (goto-char (point-min))
  5422. (while (re-search-forward regexp nil t)
  5423. (catch :skip
  5424. (org-agenda-skip)
  5425. (setq marker (org-agenda-new-marker (match-beginning 0))
  5426. closedp (equal (match-string 1) org-closed-string)
  5427. statep (equal (string-to-char (match-string 1)) ?-)
  5428. clockp (not (or closedp statep))
  5429. state (and statep (match-string 2))
  5430. category (org-get-category (match-beginning 0))
  5431. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5432. (when (string-match "\\]" timestr)
  5433. ;; substring should only run to end of time stamp
  5434. (setq rest (substring timestr (match-end 0))
  5435. timestr (substring timestr 0 (match-end 0)))
  5436. (if (and (not closedp) (not statep)
  5437. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5438. rest))
  5439. (progn (setq timestr (concat (substring timestr 0 -1)
  5440. "-" (match-string 1 rest) "]"))
  5441. (setq clocked (match-string 2 rest)))
  5442. (setq clocked "-")))
  5443. (save-excursion
  5444. (setq extra
  5445. (cond
  5446. ((not org-agenda-log-mode-add-notes) nil)
  5447. (statep
  5448. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5449. (match-string 1)))
  5450. (clockp
  5451. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5452. (match-string 1)))))
  5453. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5454. (throw :skip nil)
  5455. (goto-char (match-beginning 0))
  5456. (setq hdmarker (org-agenda-new-marker)
  5457. inherited-tags
  5458. (or (eq org-agenda-show-inherited-tags 'always)
  5459. (and (listp org-agenda-show-inherited-tags)
  5460. (memq 'todo org-agenda-show-inherited-tags))
  5461. (and (eq org-agenda-show-inherited-tags t)
  5462. (or (eq org-agenda-use-tag-inheritance t)
  5463. (memq 'todo org-agenda-use-tag-inheritance))))
  5464. tags (org-get-tags nil (not inherited-tags))
  5465. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5466. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5467. (setq txt (match-string 1))
  5468. (when extra
  5469. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5470. (setq txt (concat (substring txt 0 (match-beginning 1))
  5471. " - " extra " " (match-string 2 txt)))
  5472. (setq txt (concat txt " - " extra))))
  5473. (setq txt (org-agenda-format-item
  5474. (cond
  5475. (closedp "Closed: ")
  5476. (statep (concat "State: (" state ")"))
  5477. (t (concat "Clocked: (" clocked ")")))
  5478. txt level category tags timestr)))
  5479. (setq type (cond (closedp "closed")
  5480. (statep "state")
  5481. (t "clock")))
  5482. (setq priority 100000)
  5483. (org-add-props txt props
  5484. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5485. 'priority priority 'level level
  5486. 'type type 'date date
  5487. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5488. (push txt ee))
  5489. (goto-char (point-at-eol))))
  5490. (nreverse ee)))
  5491. (defun org-agenda-show-clocking-issues ()
  5492. "Add overlays, showing issues with clocking.
  5493. See also the user option `org-agenda-clock-consistency-checks'."
  5494. (interactive)
  5495. (let* ((pl org-agenda-clock-consistency-checks)
  5496. (re (concat "^[ \t]*"
  5497. org-clock-string
  5498. "[ \t]+"
  5499. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5500. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5501. (tlstart 0.)
  5502. (tlend 0.)
  5503. (maxtime (org-duration-to-minutes
  5504. (or (plist-get pl :max-duration) "24:00")))
  5505. (mintime (org-duration-to-minutes
  5506. (or (plist-get pl :min-duration) 0)))
  5507. (maxgap (org-duration-to-minutes
  5508. ;; default 30:00 means never complain
  5509. (or (plist-get pl :max-gap) "30:00")))
  5510. (gapok (mapcar #'org-duration-to-minutes
  5511. (plist-get pl :gap-ok-around)))
  5512. (def-face (or (plist-get pl :default-face)
  5513. '((:background "DarkRed") (:foreground "white"))))
  5514. issue face m te ts dt ov)
  5515. (goto-char (point-min))
  5516. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5517. (setq issue nil face def-face)
  5518. (catch 'next
  5519. (setq m (org-get-at-bol 'org-marker)
  5520. te nil ts nil)
  5521. (unless (and m (markerp m))
  5522. (setq issue "No valid clock line") (throw 'next t))
  5523. (org-with-point-at m
  5524. (save-excursion
  5525. (goto-char (point-at-bol))
  5526. (unless (looking-at re)
  5527. (error "No valid Clock line")
  5528. (throw 'next t))
  5529. (unless (match-end 3)
  5530. (setq issue
  5531. (format
  5532. "No end time: (%s)"
  5533. (org-duration-from-minutes
  5534. (floor
  5535. (- (float-time (org-current-time))
  5536. (float-time (org-time-string-to-time (match-string 1))))
  5537. 60)))
  5538. face (or (plist-get pl :no-end-time-face) face))
  5539. (throw 'next t))
  5540. (setq ts (match-string 1)
  5541. te (match-string 3)
  5542. ts (float-time (org-time-string-to-time ts))
  5543. te (float-time (org-time-string-to-time te))
  5544. dt (- te ts))))
  5545. (cond
  5546. ((> dt (* 60 maxtime))
  5547. ;; a very long clocking chunk
  5548. (setq issue (format "Clocking interval is very long: %s"
  5549. (org-duration-from-minutes (floor dt 60)))
  5550. face (or (plist-get pl :long-face) face)))
  5551. ((< dt (* 60 mintime))
  5552. ;; a very short clocking chunk
  5553. (setq issue (format "Clocking interval is very short: %s"
  5554. (org-duration-from-minutes (floor dt 60)))
  5555. face (or (plist-get pl :short-face) face)))
  5556. ((and (> tlend 0) (< ts tlend))
  5557. ;; Two clock entries are overlapping
  5558. (setq issue (format "Clocking overlap: %d minutes"
  5559. (/ (- tlend ts) 60))
  5560. face (or (plist-get pl :overlap-face) face)))
  5561. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5562. ;; There is a gap, lets see if we need to report it
  5563. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5564. (setq issue (format "Clocking gap: %d minutes"
  5565. (/ (- ts tlend) 60))
  5566. face (or (plist-get pl :gap-face) face))))
  5567. (t nil)))
  5568. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5569. (when issue
  5570. ;; OK, there was some issue, add an overlay to show the issue
  5571. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5572. (overlay-put ov 'before-string
  5573. (concat
  5574. (org-add-props
  5575. (format "%-43s" (concat " " issue))
  5576. nil
  5577. 'face face)
  5578. "\n"))
  5579. (overlay-put ov 'evaporate t)))))
  5580. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5581. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5582. (catch 'exit
  5583. (unless ok-list
  5584. ;; there are no OK times for gaps...
  5585. (throw 'exit nil))
  5586. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5587. ;; This is more than 24 hours, so it is OK.
  5588. ;; because we have at least one OK time, that must be in the
  5589. ;; 24 hour interval.
  5590. (throw 'exit t))
  5591. ;; We have a shorter gap.
  5592. ;; Now we have to get the minute of the day when these times are
  5593. (let* ((t1dec (org-decode-time t1))
  5594. (t2dec (org-decode-time t2))
  5595. ;; compute the minute on the day
  5596. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5597. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5598. (when (< min2 min1)
  5599. ;; if min2 is smaller than min1, this means it is on the next day.
  5600. ;; Wrap it to after midnight.
  5601. (setq min2 (+ min2 1440)))
  5602. ;; Now check if any of the OK times is in the gap
  5603. (mapc (lambda (x)
  5604. ;; Wrap the time to after midnight if necessary
  5605. (when (< x min1) (setq x (+ x 1440)))
  5606. ;; Check if in interval
  5607. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5608. ok-list)
  5609. ;; Nope, this gap is not OK
  5610. nil)))
  5611. (defun org-agenda-get-deadlines (&optional with-hour)
  5612. "Return the deadline information for agenda display.
  5613. When WITH-HOUR is non-nil, only return deadlines with an hour
  5614. specification like [h]h:mm."
  5615. (let* ((props (list 'mouse-face 'highlight
  5616. 'org-not-done-regexp org-not-done-regexp
  5617. 'org-todo-regexp org-todo-regexp
  5618. 'org-complex-heading-regexp org-complex-heading-regexp
  5619. 'help-echo
  5620. (format "mouse-2 or RET jump to org file %s"
  5621. (abbreviate-file-name buffer-file-name))))
  5622. (regexp (if with-hour
  5623. org-deadline-time-hour-regexp
  5624. org-deadline-time-regexp))
  5625. (today (org-today))
  5626. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5627. (current (calendar-absolute-from-gregorian date))
  5628. deadline-items)
  5629. (goto-char (point-min))
  5630. (while (re-search-forward regexp nil t)
  5631. (catch :skip
  5632. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5633. (org-agenda-skip)
  5634. (let* ((s (match-string 1))
  5635. (pos (1- (match-beginning 1)))
  5636. (todo-state (save-match-data (org-get-todo-state)))
  5637. (done? (member todo-state org-done-keywords))
  5638. (sexp? (string-prefix-p "%%" s))
  5639. ;; DEADLINE is the deadline date for the entry. It is
  5640. ;; either the base date or the last repeat, according
  5641. ;; to `org-agenda-prefer-last-repeat'.
  5642. (deadline
  5643. (cond
  5644. (sexp? (org-agenda--timestamp-to-absolute s current))
  5645. ((or (eq org-agenda-prefer-last-repeat t)
  5646. (member todo-state org-agenda-prefer-last-repeat))
  5647. (org-agenda--timestamp-to-absolute
  5648. s today 'past (current-buffer) pos))
  5649. (t (org-agenda--timestamp-to-absolute s))))
  5650. ;; REPEAT is the future repeat closest from CURRENT,
  5651. ;; according to `org-agenda-show-future-repeats'. If
  5652. ;; the latter is nil, or if the time stamp has no
  5653. ;; repeat part, default to DEADLINE.
  5654. (repeat
  5655. (cond
  5656. (sexp? deadline)
  5657. ((<= current today) deadline)
  5658. ((not org-agenda-show-future-repeats) deadline)
  5659. (t
  5660. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5661. (1+ today)
  5662. current)))
  5663. (org-agenda--timestamp-to-absolute
  5664. s base 'future (current-buffer) pos)))))
  5665. (diff (- deadline current))
  5666. (suppress-prewarning
  5667. (let ((scheduled
  5668. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5669. (org-entry-get nil "SCHEDULED"))))
  5670. (cond
  5671. ((not scheduled) nil)
  5672. ;; The current item has a scheduled date, so
  5673. ;; evaluate its prewarning lead time.
  5674. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5675. ;; Use global prewarning-restart lead time.
  5676. org-agenda-skip-deadline-prewarning-if-scheduled)
  5677. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5678. 'pre-scheduled)
  5679. ;; Set pre-warning to no earlier than SCHEDULED.
  5680. (min (- deadline
  5681. (org-agenda--timestamp-to-absolute scheduled))
  5682. org-deadline-warning-days))
  5683. ;; Set pre-warning to deadline.
  5684. (t 0))))
  5685. (wdays (or suppress-prewarning (org-get-wdays s))))
  5686. (cond
  5687. ;; Only display deadlines at their base date, at future
  5688. ;; repeat occurrences or in today agenda.
  5689. ((= current deadline) nil)
  5690. ((= current repeat) nil)
  5691. ((not today?) (throw :skip nil))
  5692. ;; Upcoming deadline: display within warning period WDAYS.
  5693. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5694. ;; Overdue deadline: warn about it for
  5695. ;; `org-deadline-past-days' duration.
  5696. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5697. ;; Possibly skip done tasks.
  5698. (when (and done?
  5699. (or org-agenda-skip-deadline-if-done
  5700. (/= deadline current)))
  5701. (throw :skip nil))
  5702. (save-excursion
  5703. (re-search-backward "^\\*+[ \t]+" nil t)
  5704. (goto-char (match-end 0))
  5705. (let* ((category (org-get-category))
  5706. (level (make-string (org-reduced-level (org-outline-level))
  5707. ?\s))
  5708. (head (buffer-substring (point) (line-end-position)))
  5709. (inherited-tags
  5710. (or (eq org-agenda-show-inherited-tags 'always)
  5711. (and (listp org-agenda-show-inherited-tags)
  5712. (memq 'agenda org-agenda-show-inherited-tags))
  5713. (and (eq org-agenda-show-inherited-tags t)
  5714. (or (eq org-agenda-use-tag-inheritance t)
  5715. (memq 'agenda
  5716. org-agenda-use-tag-inheritance)))))
  5717. (tags (org-get-tags nil (not inherited-tags)))
  5718. (time
  5719. (cond
  5720. ;; No time of day designation if it is only
  5721. ;; a reminder.
  5722. ((and (/= current deadline) (/= current repeat)) nil)
  5723. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5724. (concat (substring s (match-beginning 1)) " "))
  5725. (t 'time)))
  5726. (item
  5727. (org-agenda-format-item
  5728. ;; Insert appropriate suffixes before deadlines.
  5729. ;; Those only apply to today agenda.
  5730. (pcase-let ((`(,now ,future ,past)
  5731. org-agenda-deadline-leaders))
  5732. (cond
  5733. ((and today? (< deadline today)) (format past (- diff)))
  5734. ((and today? (> deadline today)) (format future diff))
  5735. (t now)))
  5736. head level category tags time))
  5737. (face (org-agenda-deadline-face
  5738. (- 1 (/ (float diff) (max wdays 1)))))
  5739. (upcoming? (and today? (> deadline today)))
  5740. (warntime (get-text-property (point) 'org-appt-warntime)))
  5741. (org-add-props item props
  5742. 'org-marker (org-agenda-new-marker pos)
  5743. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5744. 'warntime warntime
  5745. 'level level
  5746. 'ts-date deadline
  5747. 'priority
  5748. ;; Adjust priority to today reminders about deadlines.
  5749. ;; Overdue deadlines get the highest priority
  5750. ;; increase, then imminent deadlines and eventually
  5751. ;; more distant deadlines.
  5752. (let ((adjust (if today? (- diff) 0)))
  5753. (+ adjust (org-get-priority item)))
  5754. 'todo-state todo-state
  5755. 'type (if upcoming? "upcoming-deadline" "deadline")
  5756. 'date (if upcoming? date deadline)
  5757. 'face (if done? 'org-agenda-done face)
  5758. 'undone-face face
  5759. 'done-face 'org-agenda-done)
  5760. (push item deadline-items))))))
  5761. (nreverse deadline-items)))
  5762. (defun org-agenda-deadline-face (fraction)
  5763. "Return the face to displaying a deadline item.
  5764. FRACTION is what fraction of the head-warning time has passed."
  5765. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5766. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5767. "Return the scheduled information for agenda display.
  5768. Optional argument DEADLINES is a list of deadline items to be
  5769. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5770. scheduled items with an hour specification like [h]h:mm."
  5771. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5772. 'org-todo-regexp org-todo-regexp
  5773. 'org-complex-heading-regexp org-complex-heading-regexp
  5774. 'done-face 'org-agenda-done
  5775. 'mouse-face 'highlight
  5776. 'help-echo
  5777. (format "mouse-2 or RET jump to Org file %s"
  5778. (abbreviate-file-name buffer-file-name))))
  5779. (regexp (if with-hour
  5780. org-scheduled-time-hour-regexp
  5781. org-scheduled-time-regexp))
  5782. (today (org-today))
  5783. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5784. (current (calendar-absolute-from-gregorian date))
  5785. (deadline-pos
  5786. (mapcar (lambda (d)
  5787. (let ((m (get-text-property 0 'org-hd-marker d)))
  5788. (and m (marker-position m))))
  5789. deadlines))
  5790. scheduled-items)
  5791. (goto-char (point-min))
  5792. (while (re-search-forward regexp nil t)
  5793. (catch :skip
  5794. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5795. (org-agenda-skip)
  5796. (let* ((s (match-string 1))
  5797. (pos (1- (match-beginning 1)))
  5798. (todo-state (save-match-data (org-get-todo-state)))
  5799. (donep (member todo-state org-done-keywords))
  5800. (sexp? (string-prefix-p "%%" s))
  5801. ;; SCHEDULE is the scheduled date for the entry. It is
  5802. ;; either the bare date or the last repeat, according
  5803. ;; to `org-agenda-prefer-last-repeat'.
  5804. (schedule
  5805. (cond
  5806. (sexp? (org-agenda--timestamp-to-absolute s current))
  5807. ((or (eq org-agenda-prefer-last-repeat t)
  5808. (member todo-state org-agenda-prefer-last-repeat))
  5809. (org-agenda--timestamp-to-absolute
  5810. s today 'past (current-buffer) pos))
  5811. (t (org-agenda--timestamp-to-absolute s))))
  5812. ;; REPEAT is the future repeat closest from CURRENT,
  5813. ;; according to `org-agenda-show-future-repeats'. If
  5814. ;; the latter is nil, or if the time stamp has no
  5815. ;; repeat part, default to SCHEDULE.
  5816. (repeat
  5817. (cond
  5818. (sexp? schedule)
  5819. ((<= current today) schedule)
  5820. ((not org-agenda-show-future-repeats) schedule)
  5821. (t
  5822. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5823. (1+ today)
  5824. current)))
  5825. (org-agenda--timestamp-to-absolute
  5826. s base 'future (current-buffer) pos)))))
  5827. (diff (- current schedule))
  5828. (warntime (get-text-property (point) 'org-appt-warntime))
  5829. (pastschedp (< schedule today))
  5830. (futureschedp (> schedule today))
  5831. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5832. (suppress-delay
  5833. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5834. (org-entry-get nil "DEADLINE"))))
  5835. (cond
  5836. ((not deadline) nil)
  5837. ;; The current item has a deadline date, so
  5838. ;; evaluate its delay time.
  5839. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5840. ;; Use global delay time.
  5841. (- org-agenda-skip-scheduled-delay-if-deadline))
  5842. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5843. 'post-deadline)
  5844. ;; Set delay to no later than DEADLINE.
  5845. (min (- schedule
  5846. (org-agenda--timestamp-to-absolute deadline))
  5847. org-scheduled-delay-days))
  5848. (t 0))))
  5849. (diff-r (abs (- repeat current)))
  5850. (ddays-once (or (and (string-match "--\\([0-9]+\\)[hdwmy]" s)
  5851. (string-to-number (match-string 1 s)))
  5852. 0))
  5853. (ddays
  5854. (cond
  5855. ;; Nullify delay when a repeater triggered already
  5856. ;; and the delay is of the form --Xd.
  5857. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5858. (> schedule (org-agenda--timestamp-to-absolute s)))
  5859. 0)
  5860. (suppress-delay
  5861. (let ((org-scheduled-delay-days suppress-delay))
  5862. (org-get-wdays s t t)))
  5863. (t (org-get-wdays s t)))))
  5864. ;; Display scheduled items at base date (SCHEDULE), today if
  5865. ;; scheduled before the current date, and at any repeat past
  5866. ;; today. However, skip delayed items and items that have
  5867. ;; been displayed for more than `org-scheduled-past-days'.
  5868. (unless (and todayp
  5869. habitp
  5870. (bound-and-true-p org-habit-show-all-today))
  5871. (when (or
  5872. ;; no one-time delay, not repeated delay
  5873. (and (not ddays-once) (not (= ddays diff-r)))
  5874. ;; one-time delay, but not for today
  5875. (and ddays-once
  5876. (not (= diff diff-r))
  5877. (= ddays-once diff-r))
  5878. ;; normal delay, but already in the past
  5879. (and (> ddays 0) (< diff ddays))
  5880. ;; a habit, but past `org-habit-scheduled-past-days'
  5881. (> diff (or (and habitp org-habit-scheduled-past-days)
  5882. org-scheduled-past-days))
  5883. ;; schedule in the future
  5884. (> schedule current)
  5885. ;; no delay, not scheduled today, no deadline for today
  5886. (and (= ddays 0)
  5887. (/= current schedule)
  5888. (/= current today)
  5889. (/= current repeat)))
  5890. (throw :skip nil)))
  5891. ;; Possibly skip done tasks.
  5892. (when (and donep
  5893. (or org-agenda-skip-scheduled-if-done
  5894. (/= schedule current)))
  5895. (throw :skip nil))
  5896. ;; Skip entry if it already appears as a deadline, per
  5897. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5898. ;; doesn't apply to habits.
  5899. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5900. ((guard
  5901. (or (not (memq (line-beginning-position 0) deadline-pos))
  5902. habitp))
  5903. nil)
  5904. (`repeated-after-deadline
  5905. (let ((deadline (time-to-days
  5906. (org-get-deadline-time (point)))))
  5907. (and (<= schedule deadline) (> current deadline))))
  5908. (`not-today pastschedp)
  5909. (`t t)
  5910. (_ nil))
  5911. (throw :skip nil))
  5912. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5913. ;; only show them for today. Also skip done habits.
  5914. (when (and habitp
  5915. (or donep
  5916. (not (bound-and-true-p org-habit-show-habits))
  5917. (and (not todayp)
  5918. (bound-and-true-p
  5919. org-habit-show-habits-only-for-today))))
  5920. (throw :skip nil))
  5921. (save-excursion
  5922. (re-search-backward "^\\*+[ \t]+" nil t)
  5923. (goto-char (match-end 0))
  5924. (let* ((category (org-get-category))
  5925. (inherited-tags
  5926. (or (eq org-agenda-show-inherited-tags 'always)
  5927. (and (listp org-agenda-show-inherited-tags)
  5928. (memq 'agenda org-agenda-show-inherited-tags))
  5929. (and (eq org-agenda-show-inherited-tags t)
  5930. (or (eq org-agenda-use-tag-inheritance t)
  5931. (memq 'agenda
  5932. org-agenda-use-tag-inheritance)))))
  5933. (tags (org-get-tags nil (not inherited-tags)))
  5934. (level (make-string (org-reduced-level (org-outline-level))
  5935. ?\s))
  5936. (head (buffer-substring (point) (line-end-position)))
  5937. (time
  5938. (cond
  5939. ;; No time of day designation if it is only a
  5940. ;; reminder, except for habits, which always show
  5941. ;; the time of day. Habits are an exception
  5942. ;; because if there is a time of day, that is
  5943. ;; interpreted to mean they should usually happen
  5944. ;; then, even if doing the habit was missed.
  5945. ((and
  5946. (not habitp)
  5947. (/= current schedule)
  5948. (/= current repeat))
  5949. nil)
  5950. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5951. (concat (substring s (match-beginning 1)) " "))
  5952. (t 'time)))
  5953. (item
  5954. (org-agenda-format-item
  5955. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5956. ;; Show a reminder of a past scheduled today.
  5957. (if (and todayp pastschedp)
  5958. (format past diff)
  5959. first))
  5960. head level category tags time nil habitp))
  5961. (face (cond ((and (not habitp) pastschedp)
  5962. 'org-scheduled-previously)
  5963. ((and habitp futureschedp)
  5964. 'org-agenda-done)
  5965. (todayp 'org-scheduled-today)
  5966. (t 'org-scheduled)))
  5967. (habitp (and habitp (org-habit-parse-todo))))
  5968. (org-add-props item props
  5969. 'undone-face face
  5970. 'face (if donep 'org-agenda-done face)
  5971. 'org-marker (org-agenda-new-marker pos)
  5972. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5973. 'type (if pastschedp "past-scheduled" "scheduled")
  5974. 'date (if pastschedp schedule date)
  5975. 'ts-date schedule
  5976. 'warntime warntime
  5977. 'level level
  5978. 'priority (if habitp (org-habit-get-priority habitp)
  5979. (+ 99 diff (org-get-priority item)))
  5980. 'org-habit-p habitp
  5981. 'todo-state todo-state)
  5982. (push item scheduled-items))))))
  5983. (nreverse scheduled-items)))
  5984. (defun org-agenda-get-blocks ()
  5985. "Return the date-range information for agenda display."
  5986. (let* ((props (list 'face nil
  5987. 'org-not-done-regexp org-not-done-regexp
  5988. 'org-todo-regexp org-todo-regexp
  5989. 'org-complex-heading-regexp org-complex-heading-regexp
  5990. 'mouse-face 'highlight
  5991. 'help-echo
  5992. (format "mouse-2 or RET jump to org file %s"
  5993. (abbreviate-file-name buffer-file-name))))
  5994. (regexp org-tr-regexp)
  5995. (d0 (calendar-absolute-from-gregorian date))
  5996. marker hdmarker ee txt d1 d2 s1 s2 category
  5997. level todo-state tags pos head donep inherited-tags)
  5998. (goto-char (point-min))
  5999. (while (re-search-forward regexp nil t)
  6000. (catch :skip
  6001. (org-agenda-skip)
  6002. (setq pos (point))
  6003. (let ((start-time (match-string 1))
  6004. (end-time (match-string 2)))
  6005. (setq s1 (match-string 1)
  6006. s2 (match-string 2)
  6007. d1 (time-to-days
  6008. (condition-case err
  6009. (org-time-string-to-time s1)
  6010. (error
  6011. (error
  6012. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6013. s1
  6014. pos
  6015. (current-buffer)
  6016. (error-message-string err)))))
  6017. d2 (time-to-days
  6018. (condition-case err
  6019. (org-time-string-to-time s2)
  6020. (error
  6021. (error
  6022. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6023. s2
  6024. pos
  6025. (current-buffer)
  6026. (error-message-string err))))))
  6027. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6028. ;; Only allow days between the limits, because the normal
  6029. ;; date stamps will catch the limits.
  6030. (save-excursion
  6031. (setq todo-state (org-get-todo-state))
  6032. (setq donep (member todo-state org-done-keywords))
  6033. (when (and donep org-agenda-skip-timestamp-if-done)
  6034. (throw :skip t))
  6035. (setq marker (org-agenda-new-marker (point))
  6036. category (org-get-category))
  6037. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6038. (throw :skip nil)
  6039. (goto-char (match-beginning 0))
  6040. (setq hdmarker (org-agenda-new-marker (point))
  6041. inherited-tags
  6042. (or (eq org-agenda-show-inherited-tags 'always)
  6043. (and (listp org-agenda-show-inherited-tags)
  6044. (memq 'agenda org-agenda-show-inherited-tags))
  6045. (and (eq org-agenda-show-inherited-tags t)
  6046. (or (eq org-agenda-use-tag-inheritance t)
  6047. (memq 'agenda org-agenda-use-tag-inheritance))))
  6048. tags (org-get-tags nil (not inherited-tags)))
  6049. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6050. (looking-at "\\*+[ \t]+\\(.*\\)")
  6051. (setq head (match-string 1))
  6052. (let ((remove-re
  6053. (if org-agenda-remove-timeranges-from-blocks
  6054. (concat
  6055. "<" (regexp-quote s1) ".*?>"
  6056. "--"
  6057. "<" (regexp-quote s2) ".*?>")
  6058. nil)))
  6059. (setq txt (org-agenda-format-item
  6060. (format
  6061. (nth (if (= d1 d2) 0 1)
  6062. org-agenda-timerange-leaders)
  6063. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6064. head level category tags
  6065. (save-match-data
  6066. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6067. (match-string 6 s1)))
  6068. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6069. (match-string 6 s2))))
  6070. (cond ((string= hhmm1 hhmm2)
  6071. (concat "<" start-time ">--<" end-time ">"))
  6072. ((and (= d1 d0) (= d2 d0))
  6073. (concat "<" start-time ">--<" end-time ">"))
  6074. ((= d1 d0)
  6075. (concat "<" start-time ">"))
  6076. ((= d2 d0)
  6077. (concat "<" end-time ">")))))
  6078. remove-re))))
  6079. (org-add-props txt props
  6080. 'org-marker marker 'org-hd-marker hdmarker
  6081. 'type "block" 'date date
  6082. 'level level
  6083. 'todo-state todo-state
  6084. 'priority (org-get-priority txt))
  6085. (push txt ee))))
  6086. (goto-char pos)))
  6087. ;; Sort the entries by expiration date.
  6088. (nreverse ee)))
  6089. ;;; Agenda presentation and sorting
  6090. (defvar org-prefix-has-time nil
  6091. "A flag, set by `org-compile-prefix-format'.
  6092. The flag is set if the currently compiled format contains a `%t'.")
  6093. (defvar org-prefix-has-tag nil
  6094. "A flag, set by `org-compile-prefix-format'.
  6095. The flag is set if the currently compiled format contains a `%T'.")
  6096. (defvar org-prefix-has-effort nil
  6097. "A flag, set by `org-compile-prefix-format'.
  6098. The flag is set if the currently compiled format contains a `%e'.")
  6099. (defvar org-prefix-has-breadcrumbs nil
  6100. "A flag, set by `org-compile-prefix-format'.
  6101. The flag is set if the currently compiled format contains a `%b'.")
  6102. (defvar org-prefix-category-length nil
  6103. "Used by `org-compile-prefix-format' to remember the category field width.")
  6104. (defvar org-prefix-category-max-length nil
  6105. "Used by `org-compile-prefix-format' to remember the category field width.")
  6106. (defun org-agenda-get-category-icon (category)
  6107. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6108. (cl-dolist (entry org-agenda-category-icon-alist)
  6109. (when (string-match-p (car entry) category)
  6110. (if (listp (cadr entry))
  6111. (cl-return (cadr entry))
  6112. (cl-return (apply #'create-image (cdr entry)))))))
  6113. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6114. remove-re habitp)
  6115. "Format TXT to be inserted into the agenda buffer.
  6116. In particular, add the prefix and corresponding text properties.
  6117. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6118. LEVEL may be a string to replace the `%l' specifier.
  6119. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6120. category taken from local variable or file name. It will replace the `%c'
  6121. specifier in the format.
  6122. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6123. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6124. When DOTIME is a string, this string is searched for a time before TXT is.
  6125. TAGS can be the tags of the headline.
  6126. Any match of REMOVE-RE will be removed from TXT."
  6127. ;; We keep the org-prefix-* variable values along with a compiled
  6128. ;; formatter, so that multiple agendas existing at the same time do
  6129. ;; not step on each other toes.
  6130. ;;
  6131. ;; It was inconvenient to make these variables buffer local in
  6132. ;; Agenda buffers, because this function expects to be called with
  6133. ;; the buffer where item comes from being current, and not agenda
  6134. ;; buffer
  6135. (let* ((bindings (car org-prefix-format-compiled))
  6136. (formatter (cadr org-prefix-format-compiled)))
  6137. (cl-loop for (var value) in bindings
  6138. do (set var value))
  6139. (save-match-data
  6140. ;; Diary entries sometimes have extra whitespace at the beginning
  6141. (setq txt (org-trim txt))
  6142. ;; Fix the tags part in txt
  6143. (setq txt (org-agenda-fix-displayed-tags
  6144. txt tags
  6145. org-agenda-show-inherited-tags
  6146. org-agenda-hide-tags-regexp))
  6147. (let* ((category (or category
  6148. (if buffer-file-name
  6149. (file-name-sans-extension
  6150. (file-name-nondirectory buffer-file-name))
  6151. "")))
  6152. (category-icon (org-agenda-get-category-icon category))
  6153. (category-icon (if category-icon
  6154. (propertize " " 'display category-icon)
  6155. ""))
  6156. (effort (and (not (string= txt ""))
  6157. (get-text-property 1 'effort txt)))
  6158. ;; time, tag, effort are needed for the eval of the prefix format
  6159. (tag (if tags (nth (1- (length tags)) tags) ""))
  6160. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6161. time
  6162. (ts (when dotime (concat
  6163. (if (stringp dotime) dotime "")
  6164. (and org-agenda-search-headline-for-time txt))))
  6165. (time-of-day (and dotime (org-get-time-of-day ts)))
  6166. stamp plain s0 s1 s2 rtn srp l
  6167. duration breadcrumbs)
  6168. (and (derived-mode-p 'org-mode) buffer-file-name
  6169. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6170. (when (and dotime time-of-day)
  6171. ;; Extract starting and ending time and move them to prefix
  6172. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6173. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6174. (setq s0 (match-string 0 ts)
  6175. srp (and stamp (match-end 3))
  6176. s1 (match-string (if plain 1 2) ts)
  6177. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6178. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6179. ;; them, we might want to remove them there to avoid duplication.
  6180. ;; The user can turn this off with a variable.
  6181. (when (and org-prefix-has-time
  6182. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6183. (string-match (concat (regexp-quote s0) " *") txt)
  6184. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6185. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6186. (= (match-beginning 0) 0)
  6187. t))
  6188. (setq txt (replace-match "" nil nil txt))))
  6189. ;; Normalize the time(s) to 24 hour
  6190. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6191. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6192. ;; Try to set s2 if s1 and
  6193. ;; `org-agenda-default-appointment-duration' are set
  6194. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6195. (setq s2
  6196. (org-duration-from-minutes
  6197. (+ (org-duration-to-minutes s1 t)
  6198. org-agenda-default-appointment-duration)
  6199. nil t)))
  6200. ;; Compute the duration
  6201. (when s2
  6202. (setq duration (- (org-duration-to-minutes s2)
  6203. (org-duration-to-minutes s1)))))
  6204. (when (string-match org-tag-group-re txt)
  6205. ;; Tags are in the string
  6206. (if (or (eq org-agenda-remove-tags t)
  6207. (and org-agenda-remove-tags
  6208. org-prefix-has-tag))
  6209. (setq txt (replace-match "" t t txt))
  6210. (setq txt (replace-match
  6211. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6212. (match-string 1 txt))
  6213. t t txt))))
  6214. (when remove-re
  6215. (while (string-match remove-re txt)
  6216. (setq txt (replace-match "" t t txt))))
  6217. ;; Set org-heading property on `txt' to mark the start of the
  6218. ;; heading.
  6219. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6220. ;; Prepare the variables needed in the eval of the compiled format
  6221. (when org-prefix-has-breadcrumbs
  6222. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6223. (let ((s (org-format-outline-path (org-get-outline-path)
  6224. (1- (frame-width))
  6225. nil org-agenda-breadcrumbs-separator)))
  6226. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6227. (setq time (cond (s2 (concat
  6228. (org-agenda-time-of-day-to-ampm-maybe s1)
  6229. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6230. (when org-agenda-timegrid-use-ampm " ")))
  6231. (s1 (concat
  6232. (org-agenda-time-of-day-to-ampm-maybe s1)
  6233. (if org-agenda-timegrid-use-ampm
  6234. (concat time-grid-trailing-characters " ")
  6235. time-grid-trailing-characters)))
  6236. (t ""))
  6237. extra (or (and (not habitp) extra) "")
  6238. category (if (symbolp category) (symbol-name category) category)
  6239. level (or level ""))
  6240. (if (string-match org-link-bracket-re category)
  6241. (progn
  6242. (setq l (string-width (or (match-string 2) (match-string 1))))
  6243. (when (< l (or org-prefix-category-length 0))
  6244. (setq category (copy-sequence category))
  6245. (org-add-props category nil
  6246. 'extra-space (make-string
  6247. (- org-prefix-category-length l 1) ?\ ))))
  6248. (when (and org-prefix-category-max-length
  6249. (>= (length category) org-prefix-category-max-length))
  6250. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6251. ;; Evaluate the compiled format
  6252. (setq rtn (concat (eval formatter) txt))
  6253. ;; And finally add the text properties
  6254. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6255. (org-add-props rtn nil
  6256. 'org-category category
  6257. 'tags (mapcar 'org-downcase-keep-props tags)
  6258. 'org-priority-highest org-priority-highest
  6259. 'org-priority-lowest org-priority-lowest
  6260. 'time-of-day time-of-day
  6261. 'duration duration
  6262. 'breadcrumbs breadcrumbs
  6263. 'txt txt
  6264. 'level level
  6265. 'time time
  6266. 'extra extra
  6267. 'format org-prefix-format-compiled
  6268. 'dotime dotime)))))
  6269. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6270. "Remove tags string from TXT, and add a modified list of tags.
  6271. The modified list may contain inherited tags, and tags matched by
  6272. `org-agenda-hide-tags-regexp' will be removed."
  6273. (when (or add-inherited hide-re)
  6274. (when (string-match org-tag-group-re txt)
  6275. (setq txt (substring txt 0 (match-beginning 0))))
  6276. (setq tags
  6277. (delq nil
  6278. (mapcar (lambda (tg)
  6279. (if (or (and hide-re (string-match hide-re tg))
  6280. (and (not add-inherited)
  6281. (get-text-property 0 'inherited tg)))
  6282. nil
  6283. tg))
  6284. tags)))
  6285. (when tags
  6286. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6287. i)
  6288. (setq txt (concat txt " :"
  6289. (mapconcat
  6290. (lambda (x)
  6291. (setq i (get-text-property 0 'inherited x))
  6292. (if (and have-i (not i))
  6293. (progn
  6294. (setq have-i nil)
  6295. (concat ":" x))
  6296. x))
  6297. tags ":")
  6298. (if have-i "::" ":"))))))
  6299. txt)
  6300. (defun org-downcase-keep-props (s)
  6301. (let ((props (text-properties-at 0 s)))
  6302. (setq s (downcase s))
  6303. (add-text-properties 0 (length s) props s)
  6304. s))
  6305. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6306. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6307. "Add a time-grid for agenda items which need it.
  6308. LIST is the list of agenda items formatted by `org-agenda-list'.
  6309. NDAYS is the span of the current agenda view.
  6310. TODAYP is t when the current agenda view is on today."
  6311. (catch 'exit
  6312. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6313. ((and todayp (member 'today (car org-agenda-time-grid))))
  6314. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6315. ((member 'weekly (car org-agenda-time-grid)))
  6316. (t (throw 'exit list)))
  6317. (let* ((have (delq nil (mapcar
  6318. (lambda (x) (get-text-property 1 'time-of-day x))
  6319. list)))
  6320. (string (nth 3 org-agenda-time-grid))
  6321. (gridtimes (nth 1 org-agenda-time-grid))
  6322. (req (car org-agenda-time-grid))
  6323. (remove (member 'remove-match req))
  6324. new time)
  6325. (when (and (member 'require-timed req) (not have))
  6326. ;; don't show empty grid
  6327. (throw 'exit list))
  6328. (while (setq time (pop gridtimes))
  6329. (unless (and remove (member time have))
  6330. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6331. (push (org-agenda-format-item
  6332. nil string nil "" nil
  6333. (concat (substring time 0 -2) ":" (substring time -2)))
  6334. new)
  6335. (put-text-property
  6336. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6337. (when (and todayp org-agenda-show-current-time-in-grid)
  6338. (push (org-agenda-format-item
  6339. nil org-agenda-current-time-string nil "" nil
  6340. (format-time-string "%H:%M "))
  6341. new)
  6342. (put-text-property
  6343. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6344. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6345. (append new list)
  6346. (append list new)))))
  6347. (defun org-compile-prefix-format (key)
  6348. "Compile the prefix format into a Lisp form that can be evaluated.
  6349. The resulting form and associated variable bindings is returned
  6350. and stored in the variable `org-prefix-format-compiled'."
  6351. (setq org-prefix-has-time nil
  6352. org-prefix-has-tag nil
  6353. org-prefix-category-length nil
  6354. org-prefix-has-effort nil
  6355. org-prefix-has-breadcrumbs nil)
  6356. (let ((s (cond
  6357. ((stringp org-agenda-prefix-format)
  6358. org-agenda-prefix-format)
  6359. ((assq key org-agenda-prefix-format)
  6360. (cdr (assq key org-agenda-prefix-format)))
  6361. (t " %-12:c%?-12t% s")))
  6362. (start 0)
  6363. varform vars var e c f opt)
  6364. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6365. s start)
  6366. (setq var (or (cdr (assoc (match-string 4 s)
  6367. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6368. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6369. 'eval)
  6370. c (or (match-string 3 s) "")
  6371. opt (match-beginning 1)
  6372. start (1+ (match-beginning 0)))
  6373. (cl-case var
  6374. (time (setq org-prefix-has-time t))
  6375. (tag (setq org-prefix-has-tag t))
  6376. (effort (setq org-prefix-has-effort t))
  6377. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6378. (setq f (concat "%" (match-string 2 s) "s"))
  6379. (when (eq var 'category)
  6380. (setq org-prefix-category-length
  6381. (floor (abs (string-to-number (match-string 2 s)))))
  6382. (setq org-prefix-category-max-length
  6383. (let ((x (match-string 2 s)))
  6384. (save-match-data
  6385. (and (string-match "\\.[0-9]+" x)
  6386. (string-to-number (substring (match-string 0 x) 1)))))))
  6387. (if (eq var 'eval)
  6388. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6389. (if opt
  6390. (setq varform
  6391. `(if (or (equal "" ,var) (equal nil ,var))
  6392. ""
  6393. (format ,f (concat ,var ,c))))
  6394. (setq varform
  6395. `(format ,f (if (or (equal ,var "")
  6396. (equal ,var nil)) ""
  6397. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6398. (setq s (replace-match "%s" t nil s))
  6399. (push varform vars))
  6400. (setq vars (nreverse vars))
  6401. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6402. (setq org-prefix-format-compiled
  6403. (list
  6404. `((org-prefix-has-time ,org-prefix-has-time)
  6405. (org-prefix-has-tag ,org-prefix-has-tag)
  6406. (org-prefix-category-length ,org-prefix-category-length)
  6407. (org-prefix-has-effort ,org-prefix-has-effort)
  6408. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6409. `(format ,s ,@vars))))))
  6410. (defun org-set-sorting-strategy (key)
  6411. (if (symbolp (car org-agenda-sorting-strategy))
  6412. ;; the old format
  6413. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6414. (setq org-agenda-sorting-strategy-selected
  6415. (or (cdr (assq key org-agenda-sorting-strategy))
  6416. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6417. '(time-up category-keep priority-down)))))
  6418. (defun org-get-time-of-day (s &optional string mod24)
  6419. "Check string S for a time of day.
  6420. If found, return it as a military time number between 0 and 2400.
  6421. If not found, return nil.
  6422. The optional STRING argument forces conversion into a 5 character wide string
  6423. HH:MM."
  6424. (save-match-data
  6425. (when
  6426. (and
  6427. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6428. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6429. (not (eq (get-text-property 1 'face s) 'org-link)))
  6430. (let* ((h (string-to-number (match-string 1 s)))
  6431. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6432. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6433. (am-p (equal ampm "am"))
  6434. (h1 (cond ((not ampm) h)
  6435. ((= h 12) (if am-p 0 12))
  6436. (t (+ h (if am-p 0 12)))))
  6437. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6438. (mod h1 24) h1))
  6439. (t0 (+ (* 100 h2) m))
  6440. (t1 (concat (if (>= h1 24) "+" " ")
  6441. (if (and org-agenda-time-leading-zero
  6442. (< t0 1000)) "0" "")
  6443. (if (< t0 100) "0" "")
  6444. (if (< t0 10) "0" "")
  6445. (number-to-string t0))))
  6446. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6447. (defvar org-agenda-before-sorting-filter-function nil
  6448. "Function to be applied to agenda items prior to sorting.
  6449. Prior to sorting also means just before they are inserted into the agenda.
  6450. To aid sorting, you may revisit the original entries and add more text
  6451. properties which will later be used by the sorting functions.
  6452. The function should take a string argument, an agenda line.
  6453. It has access to the text properties in that line, which contain among
  6454. other things, the property `org-hd-marker' that points to the entry
  6455. where the line comes from. Note that not all lines going into the agenda
  6456. have this property, only most.
  6457. The function should return the modified string. It is probably best
  6458. to ONLY change text properties.
  6459. You can also use this function as a filter, by returning nil for lines
  6460. you don't want to have in the agenda at all. For this application, you
  6461. could bind the variable in the options section of a custom command.")
  6462. (defun org-agenda-finalize-entries (list &optional type)
  6463. "Sort, limit and concatenate the LIST of agenda items.
  6464. The optional argument TYPE tells the agenda type."
  6465. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6466. (cdr (assoc type org-agenda-max-effort)))
  6467. (t org-agenda-max-effort)))
  6468. (max-todo (cond ((listp org-agenda-max-todos)
  6469. (cdr (assoc type org-agenda-max-todos)))
  6470. (t org-agenda-max-todos)))
  6471. (max-tags (cond ((listp org-agenda-max-tags)
  6472. (cdr (assoc type org-agenda-max-tags)))
  6473. (t org-agenda-max-tags)))
  6474. (max-entries (cond ((listp org-agenda-max-entries)
  6475. (cdr (assoc type org-agenda-max-entries)))
  6476. (t org-agenda-max-entries))))
  6477. (when org-agenda-before-sorting-filter-function
  6478. (setq list
  6479. (delq nil
  6480. (mapcar
  6481. org-agenda-before-sorting-filter-function list))))
  6482. (setq list (mapcar 'org-agenda-highlight-todo list)
  6483. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6484. (when max-effort
  6485. (setq list (org-agenda-limit-entries
  6486. list 'effort-minutes max-effort
  6487. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6488. 32767 -1))))))
  6489. (when max-todo
  6490. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6491. (when max-tags
  6492. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6493. (when max-entries
  6494. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6495. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6496. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6497. (mapconcat 'identity list "\n")))
  6498. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6499. "Limit the number of agenda entries."
  6500. (let ((include (and limit (< limit 0))))
  6501. (if limit
  6502. (let ((fun (or fn (lambda (p) (when p 1))))
  6503. (lim 0))
  6504. (delq nil
  6505. (mapcar
  6506. (lambda (e)
  6507. (let ((pval (funcall
  6508. fun (get-text-property (1- (length e))
  6509. prop e))))
  6510. (when pval (setq lim (+ lim pval)))
  6511. (cond ((and pval (<= lim (abs limit))) e)
  6512. ((and include (not pval)) e))))
  6513. list)))
  6514. list)))
  6515. (defun org-agenda-limit-interactively (remove)
  6516. "In agenda, interactively limit entries to various maximums."
  6517. (interactive "P")
  6518. (if remove
  6519. (progn (setq org-agenda-max-entries nil
  6520. org-agenda-max-todos nil
  6521. org-agenda-max-tags nil
  6522. org-agenda-max-effort nil)
  6523. (org-agenda-redo))
  6524. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6525. (msg (cond ((= max ?E) "How many minutes? ")
  6526. ((= max ?e) "How many entries? ")
  6527. ((= max ?t) "How many TODO entries? ")
  6528. ((= max ?T) "How many tagged entries? ")
  6529. (t (user-error "Wrong input"))))
  6530. (num (string-to-number (read-from-minibuffer msg))))
  6531. (cond ((equal max ?e)
  6532. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6533. ((equal max ?t)
  6534. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6535. ((equal max ?T)
  6536. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6537. ((equal max ?E)
  6538. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6539. (org-agenda-fit-window-to-buffer))
  6540. (defun org-agenda-highlight-todo (x)
  6541. (let ((org-done-keywords org-done-keywords-for-agenda)
  6542. (case-fold-search nil)
  6543. re)
  6544. (if (eq x 'line)
  6545. (save-excursion
  6546. (beginning-of-line 1)
  6547. (setq re (org-get-at-bol 'org-todo-regexp))
  6548. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6549. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6550. (add-text-properties (match-beginning 0) (match-end 1)
  6551. (list 'face (org-get-todo-face 1)))
  6552. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6553. (delete-region (match-beginning 1) (1- (match-end 0)))
  6554. (goto-char (match-beginning 1))
  6555. (insert (format org-agenda-todo-keyword-format s)))))
  6556. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6557. (setq re (get-text-property 0 'org-todo-regexp x))
  6558. (when (and re
  6559. ;; Test `pl' because if there's no heading content,
  6560. ;; there's no point matching to highlight. Note
  6561. ;; that if we didn't test `pl' first, and there
  6562. ;; happened to be no keyword from `org-todo-regexp'
  6563. ;; on this heading line, then the `equal' comparison
  6564. ;; afterwards would spuriously succeed in the case
  6565. ;; where `pl' is nil -- causing an args-out-of-range
  6566. ;; error when we try to add text properties to text
  6567. ;; that isn't there.
  6568. pl
  6569. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6570. x pl)
  6571. pl))
  6572. (add-text-properties
  6573. (or (match-end 1) (match-end 0)) (match-end 0)
  6574. (list 'face (org-get-todo-face (match-string 2 x)))
  6575. x)
  6576. (when (match-end 1)
  6577. (setq x
  6578. (concat
  6579. (substring x 0 (match-end 1))
  6580. (format org-agenda-todo-keyword-format
  6581. (match-string 2 x))
  6582. ;; Remove `display' property as the icon could leak
  6583. ;; on the white space.
  6584. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6585. 'display))
  6586. (substring x (match-end 3)))))))
  6587. x)))
  6588. (defsubst org-cmp-values (a b property)
  6589. "Compare the numeric value of text PROPERTY for string A and B."
  6590. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6591. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6592. (cond ((> pa pb) +1)
  6593. ((< pa pb) -1))))
  6594. (defsubst org-cmp-effort (a b)
  6595. "Compare the effort values of string A and B."
  6596. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6597. ;; `effort-minutes' property is not directly accessible from
  6598. ;; the strings, but is stored as a property in `txt'.
  6599. (ea (or (get-text-property
  6600. 0 'effort-minutes (get-text-property 0 'txt a))
  6601. def))
  6602. (eb (or (get-text-property
  6603. 0 'effort-minutes (get-text-property 0 'txt b))
  6604. def)))
  6605. (cond ((> ea eb) +1)
  6606. ((< ea eb) -1))))
  6607. (defsubst org-cmp-category (a b)
  6608. "Compare the string values of categories of strings A and B."
  6609. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6610. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6611. (cond ((string-lessp ca cb) -1)
  6612. ((string-lessp cb ca) +1))))
  6613. (defsubst org-cmp-todo-state (a b)
  6614. "Compare the todo states of strings A and B."
  6615. (let* ((ma (or (get-text-property 1 'org-marker a)
  6616. (get-text-property 1 'org-hd-marker a)))
  6617. (mb (or (get-text-property 1 'org-marker b)
  6618. (get-text-property 1 'org-hd-marker b)))
  6619. (fa (and ma (marker-buffer ma)))
  6620. (fb (and mb (marker-buffer mb)))
  6621. (todo-kwds
  6622. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6623. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6624. (ta (or (get-text-property 1 'todo-state a) ""))
  6625. (tb (or (get-text-property 1 'todo-state b) ""))
  6626. (la (- (length (member ta todo-kwds))))
  6627. (lb (- (length (member tb todo-kwds))))
  6628. (donepa (member ta org-done-keywords-for-agenda))
  6629. (donepb (member tb org-done-keywords-for-agenda)))
  6630. (cond ((and donepa (not donepb)) -1)
  6631. ((and (not donepa) donepb) +1)
  6632. ((< la lb) -1)
  6633. ((< lb la) +1))))
  6634. (defsubst org-cmp-alpha (a b)
  6635. "Compare the headlines, alphabetically."
  6636. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6637. (plb (text-property-any 0 (length b) 'org-heading t b))
  6638. (ta (and pla (substring a pla)))
  6639. (tb (and plb (substring b plb)))
  6640. (case-fold-search nil))
  6641. (when pla
  6642. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6643. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6644. ta)
  6645. (setq ta (substring ta (match-end 0))))
  6646. (setq ta (downcase ta)))
  6647. (when plb
  6648. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6649. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6650. tb)
  6651. (setq tb (substring tb (match-end 0))))
  6652. (setq tb (downcase tb)))
  6653. (cond ((not (or ta tb)) nil)
  6654. ((not ta) +1)
  6655. ((not tb) -1)
  6656. ((string-lessp ta tb) -1)
  6657. ((string-lessp tb ta) +1))))
  6658. (defsubst org-cmp-tag (a b)
  6659. "Compare the string values of the first tags of A and B."
  6660. (let ((ta (car (last (get-text-property 1 'tags a))))
  6661. (tb (car (last (get-text-property 1 'tags b)))))
  6662. (cond ((not (or ta tb)) nil)
  6663. ((not ta) +1)
  6664. ((not tb) -1)
  6665. ((string-lessp ta tb) -1)
  6666. ((string-lessp tb ta) +1))))
  6667. (defsubst org-cmp-time (a b)
  6668. "Compare the time-of-day values of strings A and B."
  6669. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6670. (ta (or (get-text-property 1 'time-of-day a) def))
  6671. (tb (or (get-text-property 1 'time-of-day b) def)))
  6672. (cond ((< ta tb) -1)
  6673. ((< tb ta) +1))))
  6674. (defsubst org-cmp-ts (a b type)
  6675. "Compare the timestamps values of entries A and B.
  6676. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6677. \"timestamp_ia\", compare within each of these type. When TYPE
  6678. is the empty string, compare all timestamps without respect of
  6679. their type."
  6680. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6681. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6682. (get-text-property 1 'ts-date a))
  6683. def))
  6684. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6685. (get-text-property 1 'ts-date b))
  6686. def)))
  6687. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6688. ((if tb (and ta (< tb ta)) ta) +1))))
  6689. (defsubst org-cmp-habit-p (a b)
  6690. "Compare the todo states of strings A and B."
  6691. (let ((ha (get-text-property 1 'org-habit-p a))
  6692. (hb (get-text-property 1 'org-habit-p b)))
  6693. (cond ((and ha (not hb)) -1)
  6694. ((and (not ha) hb) +1))))
  6695. (defun org-entries-lessp (a b)
  6696. "Predicate for sorting agenda entries."
  6697. ;; The following variables will be used when the form is evaluated.
  6698. ;; So even though the compiler complains, keep them.
  6699. (let* ((ss org-agenda-sorting-strategy-selected)
  6700. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6701. (org-cmp-ts a b "")))
  6702. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6703. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6704. (org-cmp-ts a b "scheduled")))
  6705. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6706. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6707. (org-cmp-ts a b "deadline")))
  6708. (deadline-down (if deadline-up (- deadline-up) nil))
  6709. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6710. (org-cmp-ts a b "timestamp_ia")))
  6711. (tsia-down (if tsia-up (- tsia-up) nil))
  6712. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6713. (org-cmp-ts a b "timestamp")))
  6714. (ts-down (if ts-up (- ts-up) nil))
  6715. (time-up (and (org-em 'time-up 'time-down ss)
  6716. (org-cmp-time a b)))
  6717. (time-down (if time-up (- time-up) nil))
  6718. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6719. (org-cmp-values a b 'org-stats)))
  6720. (stats-down (if stats-up (- stats-up) nil))
  6721. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6722. (org-cmp-values a b 'priority)))
  6723. (priority-down (if priority-up (- priority-up) nil))
  6724. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6725. (org-cmp-effort a b)))
  6726. (effort-down (if effort-up (- effort-up) nil))
  6727. (category-up (and (or (org-em 'category-up 'category-down ss)
  6728. (memq 'category-keep ss))
  6729. (org-cmp-category a b)))
  6730. (category-down (if category-up (- category-up) nil))
  6731. (category-keep (if category-up +1 nil))
  6732. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6733. (org-cmp-tag a b)))
  6734. (tag-down (if tag-up (- tag-up) nil))
  6735. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6736. (org-cmp-todo-state a b)))
  6737. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6738. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6739. (org-cmp-habit-p a b)))
  6740. (habit-down (if habit-up (- habit-up) nil))
  6741. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6742. (org-cmp-alpha a b)))
  6743. (alpha-down (if alpha-up (- alpha-up) nil))
  6744. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6745. user-defined-up user-defined-down)
  6746. (when (and need-user-cmp org-agenda-cmp-user-defined
  6747. (functionp org-agenda-cmp-user-defined))
  6748. (setq user-defined-up
  6749. (funcall org-agenda-cmp-user-defined a b)
  6750. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6751. (cdr (assoc
  6752. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6753. '((-1 . t) (1 . nil) (nil . nil))))))
  6754. ;;; Agenda restriction lock
  6755. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6756. "Overlay to mark the headline to which agenda commands are restricted.")
  6757. (overlay-put org-agenda-restriction-lock-overlay
  6758. 'face 'org-agenda-restriction-lock)
  6759. (overlay-put org-agenda-restriction-lock-overlay
  6760. 'help-echo "Agendas are currently limited to this subtree.")
  6761. (delete-overlay org-agenda-restriction-lock-overlay)
  6762. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6763. "Set the restriction lock to the agenda item at point from within the agenda.
  6764. When called with a `\\[universal-argument]' prefix, restrict to
  6765. the file which contains the item.
  6766. Argument ARG is the prefix argument."
  6767. (interactive "P")
  6768. (unless (derived-mode-p 'org-agenda-mode)
  6769. (user-error "Not in an Org agenda buffer"))
  6770. (let* ((marker (or (org-get-at-bol 'org-marker)
  6771. (org-agenda-error)))
  6772. (buffer (marker-buffer marker))
  6773. (pos (marker-position marker)))
  6774. (with-current-buffer buffer
  6775. (goto-char pos)
  6776. (org-agenda-set-restriction-lock arg))))
  6777. ;;;###autoload
  6778. (defun org-agenda-set-restriction-lock (&optional type)
  6779. "Set restriction lock for agenda to current subtree or file.
  6780. When in a restricted subtree, remove it.
  6781. The restriction will span over the entire file if TYPE is `file',
  6782. or if type is '(4), or if the cursor is before the first headline
  6783. in the file. Otherwise, only apply the restriction to the current
  6784. subtree."
  6785. (interactive "P")
  6786. (if (and org-agenda-overriding-restriction
  6787. (member org-agenda-restriction-lock-overlay
  6788. (overlays-at (point)))
  6789. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6790. (point)))
  6791. (org-agenda-remove-restriction-lock 'noupdate)
  6792. (org-agenda-remove-restriction-lock 'noupdate)
  6793. (and (equal type '(4)) (setq type 'file))
  6794. (setq type (cond
  6795. (type type)
  6796. ((org-at-heading-p) 'subtree)
  6797. ((condition-case nil (org-back-to-heading t) (error nil))
  6798. 'subtree)
  6799. (t 'file)))
  6800. (if (eq type 'subtree)
  6801. (progn
  6802. (setq org-agenda-restrict (current-buffer))
  6803. (setq org-agenda-overriding-restriction 'subtree)
  6804. (put 'org-agenda-files 'org-restrict
  6805. (list (buffer-file-name (buffer-base-buffer))))
  6806. (org-back-to-heading t)
  6807. (move-overlay org-agenda-restriction-lock-overlay
  6808. (point)
  6809. (if org-agenda-restriction-lock-highlight-subtree
  6810. (save-excursion (org-end-of-subtree t t) (point))
  6811. (point-at-eol)))
  6812. (move-marker org-agenda-restrict-begin (point))
  6813. (move-marker org-agenda-restrict-end
  6814. (save-excursion (org-end-of-subtree t t)))
  6815. (message "Locking agenda restriction to subtree"))
  6816. (put 'org-agenda-files 'org-restrict
  6817. (list (buffer-file-name (buffer-base-buffer))))
  6818. (setq org-agenda-restrict nil)
  6819. (setq org-agenda-overriding-restriction 'file)
  6820. (move-marker org-agenda-restrict-begin nil)
  6821. (move-marker org-agenda-restrict-end nil)
  6822. (message "Locking agenda restriction to file"))
  6823. (setq current-prefix-arg nil))
  6824. (org-agenda-maybe-redo))
  6825. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6826. "Remove agenda restriction lock."
  6827. (interactive "P")
  6828. (if (not org-agenda-restrict)
  6829. (message "No agenda restriction to remove.")
  6830. (delete-overlay org-agenda-restriction-lock-overlay)
  6831. (delete-overlay org-speedbar-restriction-lock-overlay)
  6832. (setq org-agenda-overriding-restriction nil)
  6833. (setq org-agenda-restrict nil)
  6834. (put 'org-agenda-files 'org-restrict nil)
  6835. (move-marker org-agenda-restrict-begin nil)
  6836. (move-marker org-agenda-restrict-end nil)
  6837. (setq current-prefix-arg nil)
  6838. (message "Agenda restriction lock removed")
  6839. (or noupdate (org-agenda-maybe-redo))))
  6840. (defun org-agenda-maybe-redo ()
  6841. "If there is any window showing the agenda view, update it."
  6842. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6843. org-agenda-buffer-name)
  6844. t))
  6845. (w0 (selected-window)))
  6846. (when w
  6847. (select-window w)
  6848. (org-agenda-redo)
  6849. (select-window w0)
  6850. (if org-agenda-overriding-restriction
  6851. (message "Agenda view shifted to new %s restriction"
  6852. org-agenda-overriding-restriction)
  6853. (message "Agenda restriction lock removed")))))
  6854. ;;; Agenda commands
  6855. (defun org-agenda-check-type (error &rest types)
  6856. "Check if agenda buffer or component is of allowed type.
  6857. If ERROR is non-nil, throw an error, otherwise just return nil.
  6858. Allowed types are `agenda' `todo' `tags' `search'."
  6859. (cond ((not org-agenda-type)
  6860. (error "No Org agenda currently displayed"))
  6861. ((memq org-agenda-type types) t)
  6862. (error
  6863. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  6864. (t nil)))
  6865. (defun org-agenda-Quit ()
  6866. "Exit the agenda, killing the agenda buffer.
  6867. Like `org-agenda-quit', but kill the buffer even when
  6868. `org-agenda-sticky' is non-nil."
  6869. (interactive)
  6870. (org-agenda--quit))
  6871. (defun org-agenda-quit ()
  6872. "Exit the agenda.
  6873. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6874. instead of killing it.
  6875. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6876. the pre-agenda window configuration.
  6877. When column view is active, exit column view instead of the
  6878. agenda."
  6879. (interactive)
  6880. (org-agenda--quit org-agenda-sticky))
  6881. (defun org-agenda--quit (&optional bury)
  6882. (if org-agenda-columns-active
  6883. (org-columns-quit)
  6884. (let ((wconf org-agenda-pre-window-conf)
  6885. (buf (current-buffer))
  6886. (org-agenda-last-indirect-window
  6887. (and (eq org-indirect-buffer-display 'other-window)
  6888. org-agenda-last-indirect-buffer
  6889. (get-buffer-window org-agenda-last-indirect-buffer))))
  6890. (cond
  6891. ((eq org-agenda-window-setup 'other-frame)
  6892. (delete-frame))
  6893. ((and org-agenda-restore-windows-after-quit
  6894. wconf)
  6895. ;; Maybe restore the pre-agenda window configuration. Reset
  6896. ;; `org-agenda-pre-window-conf' before running
  6897. ;; `set-window-configuration', which loses the current buffer.
  6898. (setq org-agenda-pre-window-conf nil)
  6899. (set-window-configuration wconf))
  6900. (t
  6901. (when org-agenda-last-indirect-window
  6902. (delete-window org-agenda-last-indirect-window))
  6903. (and (not (eq org-agenda-window-setup 'current-window))
  6904. (not (one-window-p))
  6905. (delete-window))))
  6906. (if bury
  6907. ;; Set the agenda buffer as the current buffer instead of
  6908. ;; passing it as an argument to `bury-buffer' so that
  6909. ;; `bury-buffer' removes it from the window.
  6910. (with-current-buffer buf
  6911. (bury-buffer))
  6912. (kill-buffer buf)
  6913. (setq org-agenda-archives-mode nil
  6914. org-agenda-buffer nil)))))
  6915. (defun org-agenda-exit ()
  6916. "Exit the agenda, killing Org buffers loaded by the agenda.
  6917. Like `org-agenda-Quit', but kill any buffers that were created by
  6918. the agenda. Org buffers visited directly by the user will not be
  6919. touched. Also, exit the agenda even if it is in column view."
  6920. (interactive)
  6921. (when org-agenda-columns-active
  6922. (org-columns-quit))
  6923. (org-release-buffers org-agenda-new-buffers)
  6924. (setq org-agenda-new-buffers nil)
  6925. (org-agenda-Quit))
  6926. (defun org-agenda-kill-all-agenda-buffers ()
  6927. "Kill all buffers in `org-agenda-mode'.
  6928. This is used when toggling sticky agendas."
  6929. (interactive)
  6930. (let (blist)
  6931. (dolist (buf (buffer-list))
  6932. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6933. (push buf blist)))
  6934. (mapc 'kill-buffer blist)))
  6935. (defun org-agenda-execute (arg)
  6936. "Execute another agenda command, keeping same window.
  6937. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6938. in the agenda."
  6939. (interactive "P")
  6940. (let ((org-agenda-window-setup 'current-window))
  6941. (org-agenda arg)))
  6942. (defun org-agenda-redo (&optional all)
  6943. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6944. (interactive "P")
  6945. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6946. (cpa (unless (eq all t) current-prefix-arg))
  6947. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6948. (org-agenda-sticky nil)
  6949. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6950. org-agenda-buffer-name))
  6951. (org-agenda-keep-modes t)
  6952. (tag-filter org-agenda-tag-filter)
  6953. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6954. (top-hl-filter org-agenda-top-headline-filter)
  6955. (cat-filter org-agenda-category-filter)
  6956. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6957. (re-filter org-agenda-regexp-filter)
  6958. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6959. (effort-filter org-agenda-effort-filter)
  6960. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6961. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6962. (cols org-agenda-columns-active)
  6963. (line (org-current-line))
  6964. (window-line (- line (org-current-line (window-start))))
  6965. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6966. (redo-cmd (get-text-property p 'org-redo-cmd))
  6967. (last-args (get-text-property p 'org-last-args))
  6968. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6969. (org-agenda-overriding-cmd-arguments
  6970. (unless (eq all t)
  6971. (cond ((listp last-args)
  6972. (cons (or cpa (car last-args)) (cdr last-args)))
  6973. ((stringp last-args)
  6974. last-args))))
  6975. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6976. (put 'org-agenda-tag-filter :preset-filter nil)
  6977. (put 'org-agenda-category-filter :preset-filter nil)
  6978. (put 'org-agenda-regexp-filter :preset-filter nil)
  6979. (put 'org-agenda-effort-filter :preset-filter nil)
  6980. (and cols (org-columns-quit))
  6981. (message "Rebuilding agenda buffer...")
  6982. (if series-redo-cmd
  6983. (eval series-redo-cmd)
  6984. (org-let lprops redo-cmd))
  6985. (setq org-agenda-undo-list nil
  6986. org-agenda-pending-undo-list nil
  6987. org-agenda-tag-filter tag-filter
  6988. org-agenda-category-filter cat-filter
  6989. org-agenda-regexp-filter re-filter
  6990. org-agenda-effort-filter effort-filter
  6991. org-agenda-top-headline-filter top-hl-filter)
  6992. (message "Rebuilding agenda buffer...done")
  6993. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6994. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6995. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6996. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6997. (let ((tag (or tag-filter tag-preset))
  6998. (cat (or cat-filter cat-preset))
  6999. (effort (or effort-filter effort-preset))
  7000. (re (or re-filter re-preset)))
  7001. (when tag (org-agenda-filter-apply tag 'tag t))
  7002. (when cat (org-agenda-filter-apply cat 'category))
  7003. (when effort (org-agenda-filter-apply effort 'effort))
  7004. (when re (org-agenda-filter-apply re 'regexp)))
  7005. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7006. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7007. (org-goto-line line)
  7008. (recenter window-line)))
  7009. (defun org-agenda-redo-all (&optional exhaustive)
  7010. "Rebuild all agenda views in the current buffer.
  7011. With a prefix argument, do so in all agenda buffers."
  7012. (interactive "P")
  7013. (if exhaustive
  7014. (dolist (buffer (buffer-list))
  7015. (with-current-buffer buffer
  7016. (when (derived-mode-p 'org-agenda-mode)
  7017. (org-agenda-redo t))))
  7018. (org-agenda-redo t)))
  7019. (defvar org-global-tags-completion-table nil)
  7020. (defvar org-agenda-filter-form nil)
  7021. (defvar org-agenda-filtered-by-category nil)
  7022. (defsubst org-agenda-get-category ()
  7023. "Return the category of the agenda line."
  7024. (org-get-at-bol 'org-category))
  7025. (defun org-agenda-filter-by-category (strip)
  7026. "Filter lines in the agenda buffer that have a specific category.
  7027. The category is that of the current line.
  7028. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7029. When there is already a category filter in place, this command removes the filter."
  7030. (interactive "P")
  7031. (if (and org-agenda-filtered-by-category
  7032. org-agenda-category-filter)
  7033. (org-agenda-filter-show-all-cat)
  7034. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7035. (cond
  7036. ((and cat strip)
  7037. (org-agenda-filter-apply
  7038. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7039. (cat
  7040. (org-agenda-filter-apply
  7041. (setq org-agenda-category-filter
  7042. (list (concat "+" cat)))
  7043. 'category))
  7044. (t (error "No category at point"))))))
  7045. (defun org-find-top-headline (&optional pos)
  7046. "Find the topmost parent headline and return it.
  7047. POS when non-nil is the marker or buffer position to start the
  7048. search from."
  7049. (save-excursion
  7050. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7051. (when pos (goto-char pos))
  7052. ;; Skip up to the topmost parent.
  7053. (while (org-up-heading-safe))
  7054. (ignore-errors (nth 4 (org-heading-components))))))
  7055. (defvar org-agenda-filtered-by-top-headline nil)
  7056. (defun org-agenda-filter-by-top-headline (strip)
  7057. "Keep only those lines that are descendants from the same top headline.
  7058. The top headline is that of the current line. With prefix arg STRIP, hide
  7059. all lines of the category at point."
  7060. (interactive "P")
  7061. (if org-agenda-filtered-by-top-headline
  7062. (progn
  7063. (setq org-agenda-filtered-by-top-headline nil
  7064. org-agenda-top-headline-filter nil)
  7065. (org-agenda-filter-show-all-top-filter))
  7066. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7067. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7068. (error "No top-level headline at point")))))
  7069. (defvar org-agenda-regexp-filter nil)
  7070. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7071. "Filter agenda entries by a regular expressions.
  7072. You will be prompted for the regular expression, and the agenda
  7073. view will only show entries that are matched by that expression.
  7074. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7075. When there is already a regexp filter active, this command removed the
  7076. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7077. an already existing regexp filter."
  7078. (interactive "P")
  7079. (let* ((strip (equal strip-or-accumulate '(4)))
  7080. (accumulate (equal strip-or-accumulate '(16))))
  7081. (cond
  7082. ((and org-agenda-regexp-filter (not accumulate))
  7083. (org-agenda-filter-show-all-re)
  7084. (message "Regexp filter removed"))
  7085. (t (let ((flt (concat (if strip "-" "+")
  7086. (read-from-minibuffer
  7087. (if strip
  7088. "Hide entries matching regexp: "
  7089. "Narrow to entries matching regexp: ")))))
  7090. (push flt org-agenda-regexp-filter)
  7091. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7092. (defvar org-agenda-effort-filter nil)
  7093. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7094. "Filter agenda entries by effort.
  7095. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7096. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7097. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7098. This last option is in practice not very useful, but it is available for
  7099. consistency with the other filter commands."
  7100. (interactive "P")
  7101. (let* ((efforts (split-string
  7102. (or (cdr (assoc (concat org-effort-property "_ALL")
  7103. org-global-properties))
  7104. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7105. ;; XXX: the following handles only up to 10 different
  7106. ;; effort values.
  7107. (allowed-keys (if (null efforts) nil
  7108. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7109. (number-sequence 1 (length efforts)))))
  7110. (keep (equal strip-or-accumulate '(16)))
  7111. (negative (equal strip-or-accumulate '(4)))
  7112. (current org-agenda-effort-filter)
  7113. (op nil))
  7114. (while (not (memq op '(?< ?> ?= ?_)))
  7115. (setq op (read-char-exclusive
  7116. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7117. ;; Select appropriate duration. Ignore non-digit characters.
  7118. (if (eq op ?_)
  7119. (progn
  7120. (org-agenda-filter-show-all-effort)
  7121. (message "Effort filter removed"))
  7122. (let ((prompt
  7123. (apply #'format
  7124. (concat "Effort %c "
  7125. (mapconcat (lambda (s) (concat "[%d]" s))
  7126. efforts
  7127. " "))
  7128. op allowed-keys))
  7129. (eff -1))
  7130. (while (not (memq eff allowed-keys))
  7131. (message prompt)
  7132. (setq eff (- (read-char-exclusive) 48)))
  7133. (org-agenda-filter-show-all-effort)
  7134. (setq org-agenda-effort-filter
  7135. (append
  7136. (list (concat (if negative "-" "+")
  7137. (char-to-string op)
  7138. ;; Numbering is 1 2 3 ... 9 0, but we want
  7139. ;; 0 1 2 ... 8 9.
  7140. (nth (mod (1- eff) 10) efforts)))
  7141. (if keep current nil)))
  7142. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7143. (defun org-agenda-filter (&optional strip-or-accumulate)
  7144. "Prompt for a general filter string and apply it to the agenda.
  7145. The string may contain filter elements like
  7146. +category
  7147. +tag
  7148. +<effort > and = are also allowed as effort operators
  7149. +/regexp/
  7150. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7151. `+' is optional if it is not required to separate two string parts.
  7152. Multiple filter elements can be concatenated without spaces, for example
  7153. +work-John<0:10-/plot/
  7154. selects entries with category `work' and effort estimates below 10 minutes,
  7155. and deselects entries with tag `John' or matching the regexp `plot'.
  7156. During entry of the filter, completion for tags, categories and effort
  7157. values is offered. Since the syntax for categories and tags is identical
  7158. there should be no overlap between categories and tags. If there is, tags
  7159. get priority.
  7160. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7161. entire filter, which can be useful in connection with the prompt history.
  7162. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7163. existing ones. A shortcut for this is to add an additional `+' at the
  7164. beginning of the string, like `+-John'.
  7165. With a triple prefix argument, execute the computed filtering defined in
  7166. the variable `org-agenda-auto-exclude-function'."
  7167. (interactive "P")
  7168. (if (equal strip-or-accumulate '(64))
  7169. ;; Execute the auto-exclude action
  7170. (if (not org-agenda-auto-exclude-function)
  7171. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7172. (org-agenda-filter-show-all-tag)
  7173. (setq org-agenda-tag-filter nil)
  7174. (dolist (tag (org-agenda-get-represented-tags))
  7175. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7176. (when modifier
  7177. (push modifier org-agenda-tag-filter))))
  7178. (unless (null org-agenda-tag-filter)
  7179. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7180. ;; Prompt for a filter and act
  7181. (let* ((tag-list (org-agenda-get-represented-tags))
  7182. (category-list (org-agenda-get-represented-categories))
  7183. (negate (equal strip-or-accumulate '(4)))
  7184. (cf (mapconcat #'identity org-agenda-category-filter ""))
  7185. (tf (mapconcat #'identity org-agenda-tag-filter ""))
  7186. (rpl-fn (lambda (c) (replace-regexp-in-string "^\+" "" (or (car c) ""))))
  7187. (ef (replace-regexp-in-string "^\+" "" (or (car org-agenda-effort-filter) "")))
  7188. (rf (replace-regexp-in-string "^\+" "" (or (car org-agenda-regexp-filter) "")))
  7189. (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/"))))
  7190. (f-string (completing-read
  7191. (concat
  7192. (if negate "Negative filter" "Filter")
  7193. " [+cat-tag<0:10-/regexp/]: ")
  7194. 'org-agenda-filter-completion-function
  7195. nil nil ff))
  7196. (keep (or (if (string-match "^\\+[+-]" f-string)
  7197. (progn (setq f-string (substring f-string 1)) t))
  7198. (equal strip-or-accumulate '(16))))
  7199. (fc (if keep org-agenda-category-filter))
  7200. (ft (if keep org-agenda-tag-filter))
  7201. (fe (if keep org-agenda-effort-filter))
  7202. (fr (if keep org-agenda-regexp-filter))
  7203. pm s)
  7204. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7205. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7206. (when negate
  7207. (setq pm (if (equal pm "+") "-" "+")))
  7208. (cond
  7209. ((match-beginning 3)
  7210. ;; category or tag
  7211. (setq s (match-string 3 f-string))
  7212. (cond
  7213. ((member s tag-list)
  7214. (add-to-list 'ft (concat pm s) 'append 'equal))
  7215. ((member s category-list)
  7216. (add-to-list 'fc (concat pm s) 'append 'equal))
  7217. (t (message
  7218. "`%s%s' filter ignored because tag/category is not represented"
  7219. pm s))))
  7220. ((match-beginning 4)
  7221. ;; effort
  7222. (add-to-list 'fe (concat pm (match-string 4 f-string)) t 'equal))
  7223. ((match-beginning 5)
  7224. ;; regexp
  7225. (add-to-list 'fr (concat pm (match-string 6 f-string)) t 'equal)))
  7226. (setq f-string (substring f-string (match-end 0))))
  7227. (org-agenda-filter-remove-all)
  7228. (and fc (org-agenda-filter-apply
  7229. (setq org-agenda-category-filter fc) 'category))
  7230. (and ft (org-agenda-filter-apply
  7231. (setq org-agenda-tag-filter ft) 'tag 'expand))
  7232. (and fe (org-agenda-filter-apply
  7233. (setq org-agenda-effort-filter fe) 'effort))
  7234. (and fr (org-agenda-filter-apply
  7235. (setq org-agenda-regexp-filter fr) 'regexp))
  7236. (run-hooks 'org-agenda-filter-hook))))
  7237. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7238. "Complete a complex filter string.
  7239. FLAG specifies the type of completion operation to perform. This
  7240. function is passed as a collection function to `completing-read',
  7241. which see."
  7242. (let ((completion-ignore-case t) ;tags are case-sensitive
  7243. (confirm (lambda (x) (stringp x)))
  7244. (prefix "")
  7245. (operator "")
  7246. table)
  7247. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7248. (setq prefix (match-string 1 string)
  7249. operator (match-string 2 string)
  7250. string (match-string 3 string)))
  7251. (cond
  7252. ((member operator '("+" "-" "" nil))
  7253. (setq table (append (org-agenda-get-represented-categories)
  7254. (org-agenda-get-represented-tags))))
  7255. ((member operator '("<" ">" "="))
  7256. (setq table (split-string
  7257. (or (cdr (assoc (concat org-effort-property "_ALL")
  7258. org-global-properties))
  7259. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7260. " +")))
  7261. (t (setq table nil)))
  7262. (pcase flag
  7263. (`t (all-completions string table confirm))
  7264. (`lambda (assoc string table)) ;exact match?
  7265. (`nil
  7266. (pcase (try-completion string table confirm)
  7267. ((and completion (pred stringp))
  7268. (concat prefix completion))
  7269. (completion completion)))
  7270. (_ nil))))
  7271. (defun org-agenda-filter-remove-all ()
  7272. "Remove all filters from the current agenda buffer."
  7273. (interactive)
  7274. (when org-agenda-tag-filter
  7275. (org-agenda-filter-show-all-tag))
  7276. (when org-agenda-category-filter
  7277. (org-agenda-filter-show-all-cat))
  7278. (when org-agenda-regexp-filter
  7279. (org-agenda-filter-show-all-re))
  7280. (when org-agenda-top-headline-filter
  7281. (org-agenda-filter-show-all-top-filter))
  7282. (when org-agenda-effort-filter
  7283. (org-agenda-filter-show-all-effort))
  7284. (org-agenda-finalize)
  7285. (when (called-interactively-p 'interactive)
  7286. (message "All agenda filters removed")))
  7287. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7288. "Keep only those lines in the agenda buffer that have a specific tag.
  7289. The tag is selected with its fast selection letter, as configured.
  7290. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7291. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7292. instead of replacing it.
  7293. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7294. i.e. don't
  7295. filter on all its group members.
  7296. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7297. should be used to exclude the search - the interactive user can
  7298. also press `-' or `+' to switch between filtering and excluding."
  7299. (interactive "P")
  7300. (let* ((alist org-tag-alist-for-agenda)
  7301. (seen-chars nil)
  7302. (tag-chars (mapconcat
  7303. (lambda (x) (if (and (not (symbolp (car x)))
  7304. (cdr x)
  7305. (not (member (cdr x) seen-chars)))
  7306. (progn
  7307. (push (cdr x) seen-chars)
  7308. (char-to-string (cdr x)))
  7309. ""))
  7310. org-tag-alist-for-agenda ""))
  7311. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7312. (string-to-list tag-chars)))
  7313. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7314. (accumulate (equal strip-or-accumulate '(16)))
  7315. (expand (not (equal strip-or-accumulate '(64))))
  7316. (inhibit-read-only t)
  7317. (current org-agenda-tag-filter)
  7318. a n tag)
  7319. (unless char
  7320. (while (not (memq char valid-char-list))
  7321. (org-unlogged-message
  7322. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7323. (if exclude "Exclude[+]" "Filter[-]")
  7324. (if expand "" " (no grouptag expand)")
  7325. tag-chars
  7326. (if org-agenda-auto-exclude-function "[RET] " ""))
  7327. (setq char (read-char-exclusive))
  7328. ;; Excluding or filtering down
  7329. (cond ((eq char ?-) (setq exclude t))
  7330. ((eq char ?+) (setq exclude nil)))))
  7331. (when (eq char ?\t)
  7332. (unless (local-variable-p 'org-global-tags-completion-table)
  7333. (setq-local org-global-tags-completion-table
  7334. (org-global-tags-completion-table)))
  7335. (let ((completion-ignore-case t))
  7336. (setq tag (completing-read
  7337. "Tag: " org-global-tags-completion-table nil t))))
  7338. (cond
  7339. ((eq char ?\r)
  7340. (org-agenda-filter-show-all-tag)
  7341. (when org-agenda-auto-exclude-function
  7342. (setq org-agenda-tag-filter nil)
  7343. (dolist (tag (org-agenda-get-represented-tags))
  7344. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7345. (when modifier
  7346. (push modifier org-agenda-tag-filter))))
  7347. (unless (null org-agenda-tag-filter)
  7348. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7349. ((eq char ?\\)
  7350. (org-agenda-filter-show-all-tag)
  7351. (when (get 'org-agenda-tag-filter :preset-filter)
  7352. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7353. ((eq char ?.)
  7354. (setq org-agenda-tag-filter
  7355. (mapcar (lambda(tag) (concat "+" tag))
  7356. (org-get-at-bol 'tags)))
  7357. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7358. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7359. ((or (eq char ?\s)
  7360. (setq a (rassoc char alist))
  7361. (and tag (setq a (cons tag nil))))
  7362. (org-agenda-filter-show-all-tag)
  7363. (setq tag (car a))
  7364. (setq org-agenda-tag-filter
  7365. (cons (concat (if exclude "-" "+") tag)
  7366. (if accumulate current nil)))
  7367. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7368. (t (error "Invalid tag selection character %c" char)))))
  7369. (defun org-agenda-get-represented-categories ()
  7370. "Return a list of all categories used in this agenda buffer."
  7371. (or org-agenda-represented-categories
  7372. (when (derived-mode-p 'org-agenda-mode)
  7373. (let ((pos (point-min)) categories)
  7374. (while (and (< pos (point-max))
  7375. (setq pos (next-single-property-change
  7376. pos 'org-category nil (point-max))))
  7377. (push (get-text-property pos 'org-category) categories))
  7378. (setq org-agenda-represented-categories
  7379. (nreverse (org-uniquify (delq nil categories))))))))
  7380. (defvar org-tag-groups-alist-for-agenda)
  7381. (defun org-agenda-get-represented-tags ()
  7382. "Return a list of all tags used in this agenda buffer.
  7383. These will be lower-case, for filtering."
  7384. (or org-agenda-represented-tags
  7385. (when (derived-mode-p 'org-agenda-mode)
  7386. (let ((pos (point-min)) tags-lists tt)
  7387. (while (and (< pos (point-max))
  7388. (setq pos (next-single-property-change
  7389. pos 'tags nil (point-max))))
  7390. (setq tt (get-text-property pos 'tags))
  7391. (if tt (push tt tags-lists)))
  7392. (setq tags-lists
  7393. (nreverse (org-uniquify
  7394. (delq nil (apply 'append tags-lists)))))
  7395. (dolist (tag tags-lists)
  7396. (mapc
  7397. (lambda (group)
  7398. (when (member tag (mapcar #'downcase group))
  7399. (push (downcase (car group)) tags-lists)))
  7400. org-tag-groups-alist-for-agenda))
  7401. (setq org-agenda-represented-tags tags-lists)))))
  7402. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7403. "Create the form that tests a line for agenda filter. Optional
  7404. argument EXPAND can be used for the TYPE tag and will expand the
  7405. tags in the FILTER if any of the tags in FILTER are grouptags."
  7406. (let (f f1)
  7407. (cond
  7408. ;; Tag filter
  7409. ((eq type 'tag)
  7410. (setq filter
  7411. (delete-dups
  7412. (append (get 'org-agenda-tag-filter :preset-filter)
  7413. filter)))
  7414. (dolist (x filter)
  7415. (let ((op (string-to-char x)))
  7416. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7417. (setq x (list x)))
  7418. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7419. (push f1 f))))
  7420. ;; Category filter
  7421. ((eq type 'category)
  7422. (setq filter
  7423. (delete-dups
  7424. (append (get 'org-agenda-category-filter :preset-filter)
  7425. filter)))
  7426. (dolist (x filter)
  7427. (if (equal "-" (substring x 0 1))
  7428. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7429. (setq f1 (list 'equal (substring x 1) 'cat)))
  7430. (push f1 f)))
  7431. ;; Regexp filter
  7432. ((eq type 'regexp)
  7433. (setq filter
  7434. (delete-dups
  7435. (append (get 'org-agenda-regexp-filter :preset-filter)
  7436. filter)))
  7437. (dolist (x filter)
  7438. (if (equal "-" (substring x 0 1))
  7439. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7440. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7441. (push f1 f)))
  7442. ;; Effort filter
  7443. ((eq type 'effort)
  7444. (setq filter
  7445. (delete-dups
  7446. (append (get 'org-agenda-effort-filter :preset-filter)
  7447. filter)))
  7448. (dolist (x filter)
  7449. (push (org-agenda-filter-effort-form x) f))))
  7450. (cons (if (eq type 'category) 'or 'and) (nreverse f))))
  7451. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7452. "Return a form associated to tag-expression TAGS.
  7453. Build a form testing a line for agenda filter for
  7454. tag-expressions. OP is an operator of type CHAR that allows the
  7455. function to set the right switches in the returned form."
  7456. (let (form)
  7457. ;; Any of the expressions can match if OP is +, all must match if
  7458. ;; the operator is -.
  7459. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7460. (let* ((tag (substring x 1))
  7461. (f (cond
  7462. ((string= "" tag) 'tags)
  7463. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7464. ;; TAG is a regexp.
  7465. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7466. (t (list 'member (downcase tag) 'tags)))))
  7467. (push (if (eq op ?-) (list 'not f) f) form)))))
  7468. (defun org-agenda-filter-effort-form (e)
  7469. "Return the form to compare the effort of the current line with what E says.
  7470. E looks like \"+<2:25\"."
  7471. (let (op)
  7472. (setq e (substring e 1))
  7473. (setq op (string-to-char e) e (substring e 1))
  7474. (setq op (cond ((equal op ?<) '<=)
  7475. ((equal op ?>) '>=)
  7476. ((equal op ??) op)
  7477. (t '=)))
  7478. (list 'org-agenda-compare-effort (list 'quote op)
  7479. (org-duration-to-minutes e))))
  7480. (defun org-agenda-compare-effort (op value)
  7481. "Compare the effort of the current line with VALUE, using OP.
  7482. If the line does not have an effort defined, return nil."
  7483. ;; `effort-minutes' property cannot be extracted directly from
  7484. ;; current line but is stored as a property in `txt'.
  7485. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7486. (funcall op
  7487. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7488. value)))
  7489. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7490. "Expand group tags in FILTER for the agenda.
  7491. When NO-OPERATOR is non-nil, do not add the + operator to
  7492. returned tags."
  7493. (if org-group-tags
  7494. (let ((case-fold-search t) rtn)
  7495. (mapc
  7496. (lambda (f)
  7497. (let (f0 dir)
  7498. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7499. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7500. (setq dir (if no-operator "" "+") f0 f))
  7501. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7502. (org-tags-expand f0 t t))
  7503. rtn))))
  7504. filter)
  7505. (reverse rtn))
  7506. filter))
  7507. (defun org-agenda-filter-apply (filter type &optional expand)
  7508. "Set FILTER as the new agenda filter and apply it.
  7509. Optional argument EXPAND can be used for the TYPE tag and will
  7510. expand the tags in the FILTER if any of the tags in FILTER are
  7511. grouptags."
  7512. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7513. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7514. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  7515. filter type expand))
  7516. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7517. ;; category is used as the filter:
  7518. (setq org-agenda-filtered-by-category
  7519. (and (eq type 'category)
  7520. (not (equal (substring (car filter) 0 1) "-"))))
  7521. (org-agenda-set-mode-name)
  7522. (save-excursion
  7523. (goto-char (point-min))
  7524. (while (not (eobp))
  7525. (when (or (org-get-at-bol 'org-hd-marker)
  7526. (org-get-at-bol 'org-marker))
  7527. (let ((tags (org-get-at-bol 'tags))
  7528. (cat (org-agenda-get-category))
  7529. (txt (or (org-get-at-bol 'txt) "")))
  7530. (unless (eval org-agenda-filter-form)
  7531. (org-agenda-filter-hide-line type))))
  7532. (beginning-of-line 2)))
  7533. (when (get-char-property (point) 'invisible)
  7534. (ignore-errors (org-agenda-previous-line))))
  7535. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7536. "Filter by top headline HL."
  7537. (org-agenda-set-mode-name)
  7538. (save-excursion
  7539. (goto-char (point-min))
  7540. (while (not (eobp))
  7541. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7542. (tophl (and pos (org-find-top-headline pos))))
  7543. (when (and tophl (funcall (if negative 'identity 'not)
  7544. (string= hl tophl)))
  7545. (org-agenda-filter-hide-line 'top-headline)))
  7546. (beginning-of-line 2)))
  7547. (when (get-char-property (point) 'invisible)
  7548. (org-agenda-previous-line))
  7549. (setq org-agenda-top-headline-filter hl
  7550. org-agenda-filtered-by-top-headline t))
  7551. (defun org-agenda-filter-hide-line (type)
  7552. "If current line is TYPE, hide it in the agenda buffer."
  7553. (let* (buffer-invisibility-spec
  7554. (beg (max (point-min) (1- (point-at-bol))))
  7555. (end (point-at-eol)))
  7556. (let ((inhibit-read-only t))
  7557. (add-text-properties
  7558. beg end `(invisible org-filtered org-filter-type ,type)))))
  7559. (defun org-agenda-remove-filter (type)
  7560. (interactive)
  7561. "Remove filter of type TYPE from the agenda buffer."
  7562. (save-excursion
  7563. (goto-char (point-min))
  7564. (let ((inhibit-read-only t) pos)
  7565. (while (setq pos (text-property-any (point) (point-max)
  7566. 'org-filter-type type))
  7567. (goto-char pos)
  7568. (remove-text-properties
  7569. (point) (next-single-property-change (point) 'org-filter-type)
  7570. `(invisible org-filtered org-filter-type ,type))))
  7571. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7572. (setq org-agenda-filter-form nil)
  7573. (org-agenda-set-mode-name)
  7574. (org-agenda-finalize)))
  7575. (defun org-agenda-filter-show-all-tag nil
  7576. (org-agenda-remove-filter 'tag))
  7577. (defun org-agenda-filter-show-all-re nil
  7578. (org-agenda-remove-filter 'regexp))
  7579. (defun org-agenda-filter-show-all-effort nil
  7580. (org-agenda-remove-filter 'effort))
  7581. (defun org-agenda-filter-show-all-cat nil
  7582. (org-agenda-remove-filter 'category))
  7583. (defun org-agenda-filter-show-all-top-filter nil
  7584. (org-agenda-remove-filter 'top-headline))
  7585. (defun org-agenda-manipulate-query-add ()
  7586. "Manipulate the query by adding a search term with positive selection.
  7587. Positive selection means the term must be matched for selection of an entry."
  7588. (interactive)
  7589. (org-agenda-manipulate-query ?\[))
  7590. (defun org-agenda-manipulate-query-subtract ()
  7591. "Manipulate the query by adding a search term with negative selection.
  7592. Negative selection means term must not be matched for selection of an entry."
  7593. (interactive)
  7594. (org-agenda-manipulate-query ?\]))
  7595. (defun org-agenda-manipulate-query-add-re ()
  7596. "Manipulate the query by adding a search regexp with positive selection.
  7597. Positive selection means the regexp must match for selection of an entry."
  7598. (interactive)
  7599. (org-agenda-manipulate-query ?\{))
  7600. (defun org-agenda-manipulate-query-subtract-re ()
  7601. "Manipulate the query by adding a search regexp with negative selection.
  7602. Negative selection means regexp must not match for selection of an entry."
  7603. (interactive)
  7604. (org-agenda-manipulate-query ?\}))
  7605. (defun org-agenda-manipulate-query (char)
  7606. (cond
  7607. ((eq org-agenda-type 'agenda)
  7608. (let ((org-agenda-include-inactive-timestamps t))
  7609. (org-agenda-redo))
  7610. (message "Display now includes inactive timestamps as well"))
  7611. ((eq org-agenda-type 'search)
  7612. (org-add-to-string
  7613. 'org-agenda-query-string
  7614. (if org-agenda-last-search-view-search-was-boolean
  7615. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7616. (?\{ . " +{}") (?\} . " -{}"))))
  7617. " "))
  7618. (setq org-agenda-redo-command
  7619. (list 'org-search-view
  7620. (car (get-text-property (min (1- (point-max)) (point))
  7621. 'org-last-args))
  7622. org-agenda-query-string
  7623. (+ (length org-agenda-query-string)
  7624. (if (member char '(?\{ ?\})) 0 1))))
  7625. (set-register org-agenda-query-register org-agenda-query-string)
  7626. (let ((org-agenda-overriding-arguments
  7627. (cdr org-agenda-redo-command)))
  7628. (org-agenda-redo)))
  7629. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7630. org-agenda-type))))
  7631. (defun org-add-to-string (var string)
  7632. (set var (concat (symbol-value var) string)))
  7633. (defun org-agenda-goto-date (span)
  7634. "Jump to DATE in agenda."
  7635. (interactive "P")
  7636. (let* ((org-read-date-prefer-future
  7637. (eval org-agenda-jump-prefer-future))
  7638. (date (org-read-date))
  7639. (day (time-to-days (org-time-string-to-time date)))
  7640. (org-agenda-sticky-orig org-agenda-sticky)
  7641. (org-agenda-buffer-tmp-name (buffer-name))
  7642. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7643. (0-arg (or current-prefix-arg (car args)))
  7644. (2-arg (nth 2 args))
  7645. (with-hour-p (nth 4 org-agenda-redo-command))
  7646. (newcmd (list 'org-agenda-list 0-arg date
  7647. (org-agenda-span-to-ndays
  7648. 2-arg (org-time-string-to-absolute date))
  7649. with-hour-p))
  7650. (newargs (cdr newcmd))
  7651. (inhibit-read-only t)
  7652. org-agenda-sticky)
  7653. (if (not (org-agenda-check-type t 'agenda))
  7654. (error "Not available in non-agenda views")
  7655. (add-text-properties (point-min) (point-max)
  7656. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7657. (org-agenda-redo)
  7658. (goto-char (point-min))
  7659. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7660. (save-excursion (move-beginning-of-line 2) (eobp))))
  7661. (move-beginning-of-line 2))
  7662. (setq org-agenda-sticky org-agenda-sticky-orig
  7663. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7664. (defun org-agenda-goto-today ()
  7665. "Go to today."
  7666. (interactive)
  7667. (org-agenda-check-type t 'agenda)
  7668. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7669. (curspan (nth 2 args))
  7670. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7671. (cond
  7672. (tdpos (goto-char tdpos))
  7673. ((eq org-agenda-type 'agenda)
  7674. (let* ((sd (org-agenda-compute-starting-span
  7675. (org-today) (or curspan org-agenda-span)))
  7676. (org-agenda-overriding-arguments args))
  7677. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7678. (org-agenda-redo)
  7679. (org-agenda-find-same-or-today-or-agenda)))
  7680. (t (error "Cannot find today")))))
  7681. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7682. (goto-char
  7683. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7684. (text-property-any (point-min) (point-max) 'org-today t)
  7685. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7686. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7687. (org-agenda-backward-block))
  7688. (point-min))))
  7689. (defun org-agenda-backward-block ()
  7690. "Move backward by one agenda block."
  7691. (interactive)
  7692. (org-agenda-forward-block 'backward))
  7693. (defun org-agenda-forward-block (&optional backward)
  7694. "Move forward by one agenda block.
  7695. When optional argument BACKWARD is set, go backward."
  7696. (interactive)
  7697. (cond ((not (derived-mode-p 'org-agenda-mode))
  7698. (user-error
  7699. "Cannot execute this command outside of org-agenda-mode buffers"))
  7700. ((looking-at (if backward "\\`" "\\'"))
  7701. (message "Already at the %s block" (if backward "first" "last")))
  7702. (t (let ((pos (prog1 (point)
  7703. (ignore-errors (if backward (backward-char 1)
  7704. (move-end-of-line 1)))))
  7705. (f (if backward
  7706. 'previous-single-property-change
  7707. 'next-single-property-change))
  7708. moved dest)
  7709. (while (and (setq dest (funcall
  7710. f (point) 'org-agenda-structural-header))
  7711. (not (get-text-property
  7712. (point) 'org-agenda-structural-header)))
  7713. (setq moved t)
  7714. (goto-char dest))
  7715. (if moved (move-beginning-of-line 1)
  7716. (goto-char (if backward (point-min) (point-max)))
  7717. (move-beginning-of-line 1)
  7718. (message "No %s block" (if backward "previous" "further")))))))
  7719. (defun org-agenda-later (arg)
  7720. "Go forward in time by the current span.
  7721. With prefix ARG, go forward that many times the current span."
  7722. (interactive "p")
  7723. (org-agenda-check-type t 'agenda)
  7724. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7725. (span (or (nth 2 args) org-agenda-current-span))
  7726. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7727. (greg (calendar-gregorian-from-absolute sd))
  7728. (cnt (org-get-at-bol 'org-day-cnt))
  7729. greg2)
  7730. (cond
  7731. ((numberp span)
  7732. (setq sd (+ (* span arg) sd)))
  7733. ((eq span 'day)
  7734. (setq sd (+ arg sd)))
  7735. ((eq span 'week)
  7736. (setq sd (+ (* 7 arg) sd)))
  7737. ((eq span 'fortnight)
  7738. (setq sd (+ (* 14 arg) sd)))
  7739. ((eq span 'month)
  7740. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7741. sd (calendar-absolute-from-gregorian greg2))
  7742. (setcar greg2 (1+ (car greg2))))
  7743. ((eq span 'year)
  7744. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7745. sd (calendar-absolute-from-gregorian greg2))
  7746. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7747. (t
  7748. (setq sd (+ (* span arg) sd))))
  7749. (let ((org-agenda-overriding-cmd
  7750. ;; `cmd' may have been set by `org-agenda-run-series' which
  7751. ;; uses `org-agenda-overriding-cmd' to decide whether
  7752. ;; overriding is allowed for `cmd'
  7753. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7754. (org-agenda-overriding-arguments
  7755. (list (car args) sd span)))
  7756. (org-agenda-redo)
  7757. (org-agenda-find-same-or-today-or-agenda cnt))))
  7758. (defun org-agenda-earlier (arg)
  7759. "Go backward in time by the current span.
  7760. With prefix ARG, go backward that many times the current span."
  7761. (interactive "p")
  7762. (org-agenda-later (- arg)))
  7763. (defun org-agenda-view-mode-dispatch ()
  7764. "Call one of the view mode commands."
  7765. (interactive)
  7766. (org-unlogged-message
  7767. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7768. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7769. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7770. (pcase (read-char-exclusive)
  7771. (?\ (call-interactively 'org-agenda-reset-view))
  7772. (?d (call-interactively 'org-agenda-day-view))
  7773. (?w (call-interactively 'org-agenda-week-view))
  7774. (?t (call-interactively 'org-agenda-fortnight-view))
  7775. (?m (call-interactively 'org-agenda-month-view))
  7776. (?y (call-interactively 'org-agenda-year-view))
  7777. (?l (call-interactively 'org-agenda-log-mode))
  7778. (?L (org-agenda-log-mode '(4)))
  7779. (?c (org-agenda-log-mode 'clockcheck))
  7780. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7781. (?a (call-interactively 'org-agenda-archives-mode))
  7782. (?A (org-agenda-archives-mode 'files))
  7783. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7784. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7785. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7786. (?D (call-interactively 'org-agenda-toggle-diary))
  7787. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7788. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7789. (org-agenda-check-type t 'agenda)
  7790. (org-agenda-redo))
  7791. (message "Display now includes inactive timestamps as well"))
  7792. (?q (message "Abort"))
  7793. (key (user-error "Invalid key: %s" key))))
  7794. (defun org-agenda-reset-view ()
  7795. "Switch to default view for agenda."
  7796. (interactive)
  7797. (org-agenda-change-time-span org-agenda-span))
  7798. (defun org-agenda-day-view (&optional day-of-month)
  7799. "Switch to daily view for agenda.
  7800. With argument DAY-OF-MONTH, switch to that day of the month."
  7801. (interactive "P")
  7802. (org-agenda-change-time-span 'day day-of-month))
  7803. (defun org-agenda-week-view (&optional iso-week)
  7804. "Switch to weekly view for agenda.
  7805. With argument ISO-WEEK, switch to the corresponding ISO week.
  7806. If ISO-WEEK has more then 2 digits, only the last two encode
  7807. the week. Any digits before this encode a year. So 200712
  7808. means week 12 of year 2007. Years ranging from 70 years ago
  7809. to 30 years in the future can also be written as 2-digit years."
  7810. (interactive "P")
  7811. (org-agenda-change-time-span 'week iso-week))
  7812. (defun org-agenda-fortnight-view (&optional iso-week)
  7813. "Switch to fortnightly view for agenda.
  7814. With argument ISO-WEEK, switch to the corresponding ISO week.
  7815. If ISO-WEEK has more then 2 digits, only the last two encode
  7816. the week. Any digits before this encode a year. So 200712
  7817. means week 12 of year 2007. Years ranging from 70 years ago
  7818. to 30 years in the future can also be written as 2-digit years."
  7819. (interactive "P")
  7820. (org-agenda-change-time-span 'fortnight iso-week))
  7821. (defun org-agenda-month-view (&optional month)
  7822. "Switch to monthly view for agenda.
  7823. With argument MONTH, switch to that month. If MONTH has more
  7824. then 2 digits, only the last two encode the month. Any digits
  7825. before this encode a year. So 200712 means December year 2007.
  7826. Years ranging from 70 years ago to 30 years in the future can
  7827. also be written as 2-digit years."
  7828. (interactive "P")
  7829. (org-agenda-change-time-span 'month month))
  7830. (defun org-agenda-year-view (&optional year)
  7831. "Switch to yearly view for agenda.
  7832. With argument YEAR, switch to that year. Years ranging from 70
  7833. years ago to 30 years in the future can also be written as
  7834. 2-digit years."
  7835. (interactive "P")
  7836. (when year
  7837. (setq year (org-small-year-to-year year)))
  7838. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7839. (org-agenda-change-time-span 'year year)
  7840. (error "Abort")))
  7841. (defun org-agenda-change-time-span (span &optional n)
  7842. "Change the agenda view to SPAN.
  7843. SPAN may be `day', `week', `fortnight', `month', `year'."
  7844. (org-agenda-check-type t 'agenda)
  7845. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7846. (curspan (nth 2 args)))
  7847. (when (and (not n) (equal curspan span))
  7848. (error "Viewing span is already \"%s\"" span))
  7849. (let* ((sd (or (org-get-at-bol 'day)
  7850. (nth 1 args)
  7851. org-starting-day))
  7852. (sd (org-agenda-compute-starting-span sd span n))
  7853. (org-agenda-overriding-cmd
  7854. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7855. (org-agenda-overriding-arguments
  7856. (list (car args) sd span)))
  7857. (org-agenda-redo)
  7858. (org-agenda-find-same-or-today-or-agenda))
  7859. (org-agenda-set-mode-name)
  7860. (message "Switched to %s view" span)))
  7861. (defun org-agenda-compute-starting-span (sd span &optional n)
  7862. "Compute starting date for agenda.
  7863. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7864. is a cons cell with the starting date and the number of days,
  7865. so that the date SD will be in that range."
  7866. (let* ((greg (calendar-gregorian-from-absolute sd))
  7867. (dg (nth 1 greg))
  7868. (mg (car greg))
  7869. (yg (nth 2 greg)))
  7870. (cond
  7871. ((eq span 'day)
  7872. (when n
  7873. (setq sd (+ (calendar-absolute-from-gregorian
  7874. (list mg 1 yg))
  7875. n -1))))
  7876. ((or (eq span 'week) (eq span 'fortnight))
  7877. (let* ((nt (calendar-day-of-week
  7878. (calendar-gregorian-from-absolute sd)))
  7879. (d (if org-agenda-start-on-weekday
  7880. (- nt org-agenda-start-on-weekday)
  7881. 0))
  7882. y1)
  7883. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7884. (when n
  7885. (require 'cal-iso)
  7886. (when (> n 99)
  7887. (setq y1 (org-small-year-to-year (/ n 100))
  7888. n (mod n 100)))
  7889. (setq sd
  7890. (calendar-iso-to-absolute
  7891. (list n 1
  7892. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7893. ((eq span 'month)
  7894. (let (y1)
  7895. (when (and n (> n 99))
  7896. (setq y1 (org-small-year-to-year (/ n 100))
  7897. n (mod n 100)))
  7898. (setq sd (calendar-absolute-from-gregorian
  7899. (list (or n mg) 1 (or y1 yg))))))
  7900. ((eq span 'year)
  7901. (setq sd (calendar-absolute-from-gregorian
  7902. (list 1 1 (or n yg))))))
  7903. sd))
  7904. (defun org-agenda-next-date-line (&optional arg)
  7905. "Jump to the next line indicating a date in agenda buffer."
  7906. (interactive "p")
  7907. (org-agenda-check-type t 'agenda)
  7908. (beginning-of-line 1)
  7909. ;; This does not work if user makes date format that starts with a blank
  7910. (when (looking-at-p "^\\S-") (forward-char 1))
  7911. (unless (re-search-forward "^\\S-" nil t arg)
  7912. (backward-char 1)
  7913. (error "No next date after this line in this buffer"))
  7914. (goto-char (match-beginning 0)))
  7915. (defun org-agenda-previous-date-line (&optional arg)
  7916. "Jump to the previous line indicating a date in agenda buffer."
  7917. (interactive "p")
  7918. (org-agenda-check-type t 'agenda)
  7919. (beginning-of-line 1)
  7920. (unless (re-search-backward "^\\S-" nil t arg)
  7921. (error "No previous date before this line in this buffer")))
  7922. ;; Initialize the highlight
  7923. (defvar org-hl (make-overlay 1 1))
  7924. (overlay-put org-hl 'face 'highlight)
  7925. (defun org-highlight (begin end &optional buffer)
  7926. "Highlight a region with overlay."
  7927. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7928. (defun org-unhighlight ()
  7929. "Detach overlay INDEX."
  7930. (delete-overlay org-hl))
  7931. (defun org-unhighlight-once ()
  7932. "Remove the highlight from its position, and this function from the hook."
  7933. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7934. (org-unhighlight))
  7935. (defvar org-agenda-pre-follow-window-conf nil)
  7936. (defun org-agenda-follow-mode ()
  7937. "Toggle follow mode in an agenda buffer."
  7938. (interactive)
  7939. (unless org-agenda-follow-mode
  7940. (setq org-agenda-pre-follow-window-conf
  7941. (current-window-configuration)))
  7942. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7943. (unless org-agenda-follow-mode
  7944. (set-window-configuration org-agenda-pre-follow-window-conf))
  7945. (org-agenda-set-mode-name)
  7946. (org-agenda-do-context-action)
  7947. (message "Follow mode is %s"
  7948. (if org-agenda-follow-mode "on" "off")))
  7949. (defun org-agenda-entry-text-mode (&optional arg)
  7950. "Toggle entry text mode in an agenda buffer."
  7951. (interactive "P")
  7952. (if (or org-agenda-tag-filter
  7953. org-agenda-category-filter
  7954. org-agenda-regexp-filter
  7955. org-agenda-top-headline-filter)
  7956. (user-error "Can't show entry text in filtered views")
  7957. (setq org-agenda-entry-text-mode (or (integerp arg)
  7958. (not org-agenda-entry-text-mode)))
  7959. (org-agenda-entry-text-hide)
  7960. (and org-agenda-entry-text-mode
  7961. (let ((org-agenda-entry-text-maxlines
  7962. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7963. (org-agenda-entry-text-show)))
  7964. (org-agenda-set-mode-name)
  7965. (message "Entry text mode is %s%s"
  7966. (if org-agenda-entry-text-mode "on" "off")
  7967. (if (not org-agenda-entry-text-mode) ""
  7968. (format " (maximum number of lines is %d)"
  7969. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7970. (defun org-agenda-clockreport-mode ()
  7971. "Toggle clocktable mode in an agenda buffer."
  7972. (interactive)
  7973. (org-agenda-check-type t 'agenda)
  7974. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7975. (org-agenda-set-mode-name)
  7976. (org-agenda-redo)
  7977. (message "Clocktable mode is %s"
  7978. (if org-agenda-clockreport-mode "on" "off")))
  7979. (defun org-agenda-log-mode (&optional special)
  7980. "Toggle log mode in an agenda buffer.
  7981. With argument SPECIAL, show all possible log items, not only the ones
  7982. configured in `org-agenda-log-mode-items'.
  7983. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7984. log items, nothing else."
  7985. (interactive "P")
  7986. (org-agenda-check-type t 'agenda)
  7987. (setq org-agenda-show-log
  7988. (cond
  7989. ((equal special '(16)) 'only)
  7990. ((eq special 'clockcheck)
  7991. (if (eq org-agenda-show-log 'clockcheck)
  7992. nil 'clockcheck))
  7993. (special '(closed clock state))
  7994. (t (not org-agenda-show-log))))
  7995. (org-agenda-set-mode-name)
  7996. (org-agenda-redo)
  7997. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7998. (defun org-agenda-archives-mode (&optional with-files)
  7999. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  8000. When called with a prefix argument, include all archive files as well."
  8001. (interactive "P")
  8002. (setq org-agenda-archives-mode
  8003. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  8004. (org-agenda-set-mode-name)
  8005. (org-agenda-redo)
  8006. (message
  8007. "%s"
  8008. (cond
  8009. ((eq org-agenda-archives-mode nil)
  8010. "No archives are included")
  8011. ((eq org-agenda-archives-mode 'trees)
  8012. (format "Trees with :%s: tag are included" org-archive-tag))
  8013. ((eq org-agenda-archives-mode t)
  8014. (format "Trees with :%s: tag and all active archive files are included"
  8015. org-archive-tag)))))
  8016. (defun org-agenda-toggle-diary ()
  8017. "Toggle diary inclusion in an agenda buffer."
  8018. (interactive)
  8019. (org-agenda-check-type t 'agenda)
  8020. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8021. (org-agenda-redo)
  8022. (org-agenda-set-mode-name)
  8023. (message "Diary inclusion turned %s"
  8024. (if org-agenda-include-diary "on" "off")))
  8025. (defun org-agenda-toggle-deadlines ()
  8026. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8027. (interactive)
  8028. (org-agenda-check-type t 'agenda)
  8029. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8030. (org-agenda-redo)
  8031. (org-agenda-set-mode-name)
  8032. (message "Deadlines inclusion turned %s"
  8033. (if org-agenda-include-deadlines "on" "off")))
  8034. (defun org-agenda-toggle-time-grid ()
  8035. "Toggle time grid in an agenda buffer."
  8036. (interactive)
  8037. (org-agenda-check-type t 'agenda)
  8038. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8039. (org-agenda-redo)
  8040. (org-agenda-set-mode-name)
  8041. (message "Time-grid turned %s"
  8042. (if org-agenda-use-time-grid "on" "off")))
  8043. (defun org-agenda-set-mode-name ()
  8044. "Set the mode name to indicate all the small mode settings."
  8045. (setq mode-name
  8046. (list "Org-Agenda"
  8047. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8048. " "
  8049. '(:eval (org-agenda-span-name org-agenda-current-span))
  8050. (if org-agenda-follow-mode " Follow" "")
  8051. (if org-agenda-entry-text-mode " ETxt" "")
  8052. (if org-agenda-include-diary " Diary" "")
  8053. (if org-agenda-include-deadlines " Ddl" "")
  8054. (if org-agenda-use-time-grid " Grid" "")
  8055. (if (and (boundp 'org-habit-show-habits)
  8056. org-habit-show-habits) " Habit" "")
  8057. (cond
  8058. ((consp org-agenda-show-log) " LogAll")
  8059. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8060. (org-agenda-show-log " Log")
  8061. (t ""))
  8062. (if (org-agenda-filter-any) " " "")
  8063. (if (or org-agenda-category-filter
  8064. (get 'org-agenda-category-filter :preset-filter))
  8065. '(:eval (propertize
  8066. (concat "["
  8067. (mapconcat
  8068. 'identity
  8069. (append
  8070. (get 'org-agenda-category-filter :preset-filter)
  8071. org-agenda-category-filter)
  8072. "")
  8073. "]")
  8074. 'face 'org-agenda-filter-category
  8075. 'help-echo "Category used in filtering")) "")
  8076. (if (or org-agenda-tag-filter
  8077. (get 'org-agenda-tag-filter :preset-filter))
  8078. '(:eval (propertize
  8079. (concat (mapconcat
  8080. 'identity
  8081. (append
  8082. (get 'org-agenda-tag-filter :preset-filter)
  8083. org-agenda-tag-filter)
  8084. ""))
  8085. 'face 'org-agenda-filter-tags
  8086. 'help-echo "Tags used in filtering")) "")
  8087. (if (or org-agenda-effort-filter
  8088. (get 'org-agenda-effort-filter :preset-filter))
  8089. '(:eval (propertize
  8090. (concat (mapconcat
  8091. 'identity
  8092. (append
  8093. (get 'org-agenda-effort-filter :preset-filter)
  8094. org-agenda-effort-filter)
  8095. ""))
  8096. 'face 'org-agenda-filter-effort
  8097. 'help-echo "Effort conditions used in filtering")) "")
  8098. (if (or org-agenda-regexp-filter
  8099. (get 'org-agenda-regexp-filter :preset-filter))
  8100. '(:eval (propertize
  8101. (concat (mapconcat
  8102. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8103. (append
  8104. (get 'org-agenda-regexp-filter :preset-filter)
  8105. org-agenda-regexp-filter)
  8106. ""))
  8107. 'face 'org-agenda-filter-regexp
  8108. 'help-echo "Regexp used in filtering")) "")
  8109. (if org-agenda-archives-mode
  8110. (if (eq org-agenda-archives-mode t)
  8111. " Archives"
  8112. (format " :%s:" org-archive-tag))
  8113. "")
  8114. (if org-agenda-clockreport-mode " Clock" "")))
  8115. (force-mode-line-update))
  8116. (defun org-agenda-update-agenda-type ()
  8117. "Update the agenda type after each command."
  8118. (setq org-agenda-type
  8119. (or (get-text-property (point) 'org-agenda-type)
  8120. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8121. (defun org-agenda-next-line ()
  8122. "Move cursor to the next line, and show if follow mode is active."
  8123. (interactive)
  8124. (call-interactively 'next-line)
  8125. (org-agenda-do-context-action))
  8126. (defun org-agenda-previous-line ()
  8127. "Move cursor to the previous line, and show if follow-mode is active."
  8128. (interactive)
  8129. (call-interactively 'previous-line)
  8130. (org-agenda-do-context-action))
  8131. (defun org-agenda-next-item (n)
  8132. "Move cursor to next agenda item."
  8133. (interactive "p")
  8134. (let ((col (current-column)))
  8135. (dotimes (c n)
  8136. (when (next-single-property-change (point-at-eol) 'org-marker)
  8137. (move-end-of-line 1)
  8138. (goto-char (next-single-property-change (point) 'org-marker))))
  8139. (org-move-to-column col))
  8140. (org-agenda-do-context-action))
  8141. (defun org-agenda-previous-item (n)
  8142. "Move cursor to next agenda item."
  8143. (interactive "p")
  8144. (dotimes (c n)
  8145. (let ((col (current-column))
  8146. (goto (save-excursion
  8147. (move-end-of-line 0)
  8148. (previous-single-property-change (point) 'org-marker))))
  8149. (when goto (goto-char goto))
  8150. (org-move-to-column col)))
  8151. (org-agenda-do-context-action))
  8152. (defun org-agenda-do-context-action ()
  8153. "Show outline path and, maybe, follow mode window."
  8154. (let ((m (org-get-at-bol 'org-marker)))
  8155. (when (and (markerp m) (marker-buffer m))
  8156. (and org-agenda-follow-mode
  8157. (if org-agenda-follow-indirect
  8158. (org-agenda-tree-to-indirect-buffer nil)
  8159. (org-agenda-show)))
  8160. (and org-agenda-show-outline-path
  8161. (org-with-point-at m (org-display-outline-path t))))))
  8162. (defun org-agenda-show-tags ()
  8163. "Show the tags applicable to the current item."
  8164. (interactive)
  8165. (let* ((tags (org-get-at-bol 'tags)))
  8166. (if tags
  8167. (message "Tags are :%s:"
  8168. (org-no-properties (mapconcat 'identity tags ":")))
  8169. (message "No tags associated with this line"))))
  8170. (defun org-agenda-goto (&optional highlight)
  8171. "Go to the entry at point in the corresponding Org file."
  8172. (interactive)
  8173. (let* ((marker (or (org-get-at-bol 'org-marker)
  8174. (org-agenda-error)))
  8175. (buffer (marker-buffer marker))
  8176. (pos (marker-position marker)))
  8177. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8178. (switch-to-buffer-other-window buffer)
  8179. (widen)
  8180. (push-mark)
  8181. (goto-char pos)
  8182. (when (derived-mode-p 'org-mode)
  8183. (org-show-context 'agenda)
  8184. (recenter (/ (window-height) 2))
  8185. (org-back-to-heading t)
  8186. (let ((case-fold-search nil))
  8187. (when (re-search-forward org-complex-heading-regexp nil t)
  8188. (goto-char (match-beginning 4)))))
  8189. (run-hooks 'org-agenda-after-show-hook)
  8190. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  8191. (defvar org-agenda-after-show-hook nil
  8192. "Normal hook run after an item has been shown from the agenda.
  8193. Point is in the buffer where the item originated.")
  8194. ;; Defined later in org-agenda.el
  8195. (defvar org-agenda-loop-over-headlines-in-active-region nil)
  8196. (defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
  8197. "Between region BEG and END, call agenda command CMD.
  8198. When optional argument ARG is non-nil or FORCE-ARG is `t', pass
  8199. ARG to CMD. When optional argument DELETE is non-nil, assume CMD
  8200. deletes the agenda entry and don't move to the next entry."
  8201. (save-excursion
  8202. (goto-char beg)
  8203. (let ((mend (move-marker (make-marker) end))
  8204. (all (eq org-agenda-loop-over-headlines-in-active-region t))
  8205. (match (and (stringp org-agenda-loop-over-headlines-in-active-region)
  8206. org-agenda-loop-over-headlines-in-active-region))
  8207. (level (and (eq org-agenda-loop-over-headlines-in-active-region 'start-level)
  8208. (org-get-at-bol 'level))))
  8209. (while (< (point) mend)
  8210. (let ((ov (make-overlay (point) (point-at-eol))))
  8211. (if (not (or all
  8212. (and match (looking-at-p match))
  8213. (eq level (org-get-at-bol 'level))))
  8214. (org-agenda-next-item 1)
  8215. (overlay-put ov 'face 'region)
  8216. (if (or arg force-arg) (funcall cmd arg) (funcall cmd))
  8217. (when (not delete) (org-agenda-next-item 1))
  8218. (delete-overlay ov)))))))
  8219. ;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
  8220. ;; kill,set-property,set-effort] commands may loop over agenda
  8221. ;; entries. Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
  8222. ;; use their own mechanisms on active regions.
  8223. (defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  8224. "Maybe loop over agenda entries and perform CMD.
  8225. Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  8226. (declare (debug t))
  8227. `(if (and (called-interactively-p 'any)
  8228. org-agenda-loop-over-headlines-in-active-region
  8229. (org-region-active-p))
  8230. (org-agenda-do-in-region
  8231. (region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
  8232. ,@body))
  8233. (defun org-agenda-kill ()
  8234. "Kill the entry or subtree belonging to the current agenda entry."
  8235. (interactive)
  8236. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8237. (org-agenda-maybe-loop
  8238. #'org-agenda-kill nil nil t
  8239. (let* ((bufname-orig (buffer-name))
  8240. (marker (or (org-get-at-bol 'org-marker)
  8241. (org-agenda-error)))
  8242. (buffer (marker-buffer marker))
  8243. (pos (marker-position marker))
  8244. (type (org-get-at-bol 'type))
  8245. dbeg dend (n 0))
  8246. (org-with-remote-undo buffer
  8247. (with-current-buffer buffer
  8248. (save-excursion
  8249. (goto-char pos)
  8250. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8251. (setq dbeg (progn (org-back-to-heading t) (point))
  8252. dend (org-end-of-subtree t t))
  8253. (setq dbeg (point-at-bol)
  8254. dend (min (point-max) (1+ (point-at-eol)))))
  8255. (goto-char dbeg)
  8256. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8257. (when (or (eq t org-agenda-confirm-kill)
  8258. (and (numberp org-agenda-confirm-kill)
  8259. (> n org-agenda-confirm-kill)))
  8260. (let ((win-conf (current-window-configuration)))
  8261. (unwind-protect
  8262. (and
  8263. (prog2
  8264. (org-agenda-tree-to-indirect-buffer nil)
  8265. (not (y-or-n-p
  8266. (format "Delete entry with %d lines in buffer \"%s\"? "
  8267. n (buffer-name buffer))))
  8268. (kill-buffer org-last-indirect-buffer))
  8269. (error "Abort"))
  8270. (set-window-configuration win-conf))))
  8271. (let ((org-agenda-buffer-name bufname-orig))
  8272. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8273. (with-current-buffer buffer (delete-region dbeg dend))
  8274. (message "Agenda item and source killed")))))
  8275. (defvar org-archive-default-command) ; defined in org-archive.el
  8276. (defun org-agenda-archive-default ()
  8277. "Archive the entry or subtree belonging to the current agenda entry."
  8278. (interactive)
  8279. (require 'org-archive)
  8280. (funcall-interactively
  8281. #'org-agenda-archive-with org-archive-default-command))
  8282. (defun org-agenda-archive-default-with-confirmation ()
  8283. "Archive the entry or subtree belonging to the current agenda entry."
  8284. (interactive)
  8285. (require 'org-archive)
  8286. (funcall-interactively
  8287. #'org-agenda-archive-with org-archive-default-command 'confirm))
  8288. (defun org-agenda-archive ()
  8289. "Archive the entry or subtree belonging to the current agenda entry."
  8290. (interactive)
  8291. (funcall-interactively
  8292. #'org-agenda-archive-with 'org-archive-subtree))
  8293. (defun org-agenda-archive-to-archive-sibling ()
  8294. "Move the entry to the archive sibling."
  8295. (interactive)
  8296. (funcall-interactively
  8297. #'org-agenda-archive-with 'org-archive-to-archive-sibling))
  8298. (defun org-agenda-archive-with (cmd &optional confirm)
  8299. "Move the entry to the archive sibling."
  8300. (interactive)
  8301. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8302. (org-agenda-maybe-loop
  8303. #'org-agenda-archive-with cmd nil t
  8304. (let* ((bufname-orig (buffer-name))
  8305. (marker (or (org-get-at-bol 'org-marker)
  8306. (org-agenda-error)))
  8307. (buffer (marker-buffer marker))
  8308. (pos (marker-position marker)))
  8309. (org-with-remote-undo buffer
  8310. (with-current-buffer buffer
  8311. (if (derived-mode-p 'org-mode)
  8312. (if (and confirm
  8313. (not (y-or-n-p "Archive this subtree or entry? ")))
  8314. (error "Abort")
  8315. (save-window-excursion
  8316. (goto-char pos)
  8317. (let ((org-agenda-buffer-name bufname-orig))
  8318. (org-remove-subtree-entries-from-agenda))
  8319. (org-back-to-heading t)
  8320. (let ((org-archive-from-agenda t))
  8321. (funcall cmd))))
  8322. (error "Archiving works only in Org files")))))))
  8323. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8324. "Remove all lines in the agenda that correspond to a given subtree.
  8325. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8326. If this information is not given, the function uses the tree at point."
  8327. (let ((buf (or buf (current-buffer))) m p)
  8328. (save-excursion
  8329. (unless (and beg end)
  8330. (org-back-to-heading t)
  8331. (setq beg (point))
  8332. (org-end-of-subtree t)
  8333. (setq end (point)))
  8334. (set-buffer (get-buffer org-agenda-buffer-name))
  8335. (save-excursion
  8336. (goto-char (point-max))
  8337. (beginning-of-line 1)
  8338. (while (not (bobp))
  8339. (when (and (setq m (org-get-at-bol 'org-marker))
  8340. (equal buf (marker-buffer m))
  8341. (setq p (marker-position m))
  8342. (>= p beg)
  8343. (< p end))
  8344. (let ((inhibit-read-only t))
  8345. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8346. (beginning-of-line 0))))))
  8347. (defun org-agenda-refile (&optional goto rfloc no-update)
  8348. "Refile the item at point.
  8349. When called with `\\[universal-argument] \\[universal-argument]', \
  8350. go to the location of the last
  8351. refiled item.
  8352. When called with `\\[universal-argument] \\[universal-argument] \
  8353. \\[universal-argument]' prefix or when GOTO is 0, clear
  8354. the refile cache.
  8355. RFLOC can be a refile location obtained in a different way.
  8356. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8357. (interactive "P")
  8358. (cond
  8359. ((member goto '(0 (64)))
  8360. (org-refile-cache-clear))
  8361. ((equal goto '(16))
  8362. (org-refile-goto-last-stored))
  8363. (t
  8364. (let* ((buffer-orig (buffer-name))
  8365. (marker (or (org-get-at-bol 'org-hd-marker)
  8366. (org-agenda-error)))
  8367. (buffer (marker-buffer marker))
  8368. (pos (marker-position marker))
  8369. (rfloc (or rfloc
  8370. (org-refile-get-location
  8371. (if goto "Goto" "Refile to") buffer
  8372. org-refile-allow-creating-parent-nodes))))
  8373. (with-current-buffer buffer
  8374. (org-with-wide-buffer
  8375. (goto-char marker)
  8376. (let ((org-agenda-buffer-name buffer-orig))
  8377. (org-remove-subtree-entries-from-agenda))
  8378. (org-refile goto buffer rfloc))))
  8379. (unless no-update (org-agenda-redo)))))
  8380. (defun org-agenda-open-link (&optional arg)
  8381. "Open the link(s) in the current entry, if any.
  8382. This looks for a link in the displayed line in the agenda.
  8383. It also looks at the text of the entry itself."
  8384. (interactive "P")
  8385. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8386. (org-get-at-bol 'org-marker)))
  8387. (buffer (and marker (marker-buffer marker)))
  8388. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8389. (lkall (and buffer (org-offer-links-in-entry
  8390. buffer marker arg prefix)))
  8391. (lk0 (car lkall))
  8392. (lk (if (stringp lk0) (list lk0) lk0))
  8393. (lkend (cdr lkall))
  8394. trg)
  8395. (cond
  8396. ((and buffer lk)
  8397. (mapcar (lambda(l)
  8398. (with-current-buffer buffer
  8399. (setq trg (and (string-match org-link-bracket-re l)
  8400. (match-string 1 l)))
  8401. (if (or (not trg) (string-match org-link-any-re trg))
  8402. ;; Don't use `org-with-wide-buffer' here as
  8403. ;; opening the link may result in moving the point
  8404. (save-restriction
  8405. (widen)
  8406. (goto-char marker)
  8407. (when (search-forward l nil lkend)
  8408. (goto-char (match-beginning 0))
  8409. (org-open-at-point)))
  8410. ;; This is an internal link, widen the buffer
  8411. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8412. (switch-to-buffer-other-window buffer)
  8413. (widen)
  8414. (goto-char marker)
  8415. (when (search-forward l nil lkend)
  8416. (goto-char (match-beginning 0))
  8417. (org-open-at-point)))))
  8418. lk))
  8419. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8420. (save-excursion
  8421. (beginning-of-line 1)
  8422. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8423. (org-link-open-from-string (match-string 1)))
  8424. (t (message "No link to open here")))))
  8425. (defun org-agenda-copy-local-variable (var)
  8426. "Get a variable from a referenced buffer and install it here."
  8427. (let ((m (org-get-at-bol 'org-marker)))
  8428. (when (and m (buffer-live-p (marker-buffer m)))
  8429. (set (make-local-variable var)
  8430. (with-current-buffer (marker-buffer m)
  8431. (symbol-value var))))))
  8432. (defun org-agenda-switch-to (&optional delete-other-windows)
  8433. "Go to the Org mode file which contains the item at point.
  8434. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8435. displayed Org file fills the frame."
  8436. (interactive)
  8437. (if (and org-return-follows-link
  8438. (not (org-get-at-bol 'org-marker))
  8439. (org-in-regexp org-link-bracket-re))
  8440. (org-link-open-from-string (match-string 0))
  8441. (let* ((marker (or (org-get-at-bol 'org-marker)
  8442. (org-agenda-error)))
  8443. (buffer (marker-buffer marker))
  8444. (pos (marker-position marker)))
  8445. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8446. (pop-to-buffer-same-window buffer)
  8447. (when delete-other-windows (delete-other-windows))
  8448. (widen)
  8449. (goto-char pos)
  8450. (when (derived-mode-p 'org-mode)
  8451. (org-show-context 'agenda)
  8452. (run-hooks 'org-agenda-after-show-hook)))))
  8453. (defun org-agenda-goto-mouse (ev)
  8454. "Go to the Org file which contains the item at the mouse click."
  8455. (interactive "e")
  8456. (mouse-set-point ev)
  8457. (org-agenda-goto))
  8458. (defun org-agenda-show (&optional full-entry)
  8459. "Display the Org file which contains the item at point.
  8460. With prefix argument FULL-ENTRY, make the entire entry visible
  8461. if it was hidden in the outline."
  8462. (interactive "P")
  8463. (let ((win (selected-window)))
  8464. (org-agenda-goto t)
  8465. (when full-entry (org-show-entry))
  8466. (select-window win)))
  8467. (defvar org-agenda-show-window nil)
  8468. (defun org-agenda-show-and-scroll-up (&optional arg)
  8469. "Display the Org file which contains the item at point.
  8470. When called repeatedly, scroll the window that is displaying the buffer.
  8471. With a `\\[universal-argument]' prefix argument, display the item, but \
  8472. fold drawers."
  8473. (interactive "P")
  8474. (let ((win (selected-window)))
  8475. (if (and (window-live-p org-agenda-show-window)
  8476. (eq this-command last-command))
  8477. (progn
  8478. (select-window org-agenda-show-window)
  8479. (ignore-errors (scroll-up)))
  8480. (org-agenda-goto t)
  8481. (org-show-entry)
  8482. (if arg (org-cycle-hide-drawers 'children)
  8483. (org-with-wide-buffer
  8484. (narrow-to-region (org-entry-beginning-position)
  8485. (org-entry-end-position))
  8486. (org-show-all '(drawers))))
  8487. (setq org-agenda-show-window (selected-window)))
  8488. (select-window win)))
  8489. (defun org-agenda-show-scroll-down ()
  8490. "Scroll down the window showing the agenda."
  8491. (interactive)
  8492. (let ((win (selected-window)))
  8493. (when (window-live-p org-agenda-show-window)
  8494. (select-window org-agenda-show-window)
  8495. (ignore-errors (scroll-down))
  8496. (select-window win))))
  8497. (defun org-agenda-show-1 (&optional more)
  8498. "Display the Org file which contains the item at point.
  8499. The prefix arg selects the amount of information to display:
  8500. 0 hide the subtree
  8501. 1 just show the entry according to defaults.
  8502. 2 show the children view
  8503. 3 show the subtree view
  8504. 4 show the entire subtree and any LOGBOOK drawers
  8505. 5 show the entire subtree and any drawers
  8506. With prefix argument FULL-ENTRY, make the entire entry visible
  8507. if it was hidden in the outline."
  8508. (interactive "p")
  8509. (let ((win (selected-window)))
  8510. (org-agenda-goto t)
  8511. (org-back-to-heading)
  8512. (set-window-start (selected-window) (point-at-bol))
  8513. (cond
  8514. ((= more 0)
  8515. (org-flag-subtree t)
  8516. (save-excursion
  8517. (org-back-to-heading)
  8518. (run-hook-with-args 'org-cycle-hook 'folded))
  8519. (message "Remote: FOLDED"))
  8520. ((and (called-interactively-p 'any) (= more 1))
  8521. (message "Remote: show with default settings"))
  8522. ((= more 2)
  8523. (outline-show-entry)
  8524. (org-show-children)
  8525. (save-excursion
  8526. (org-back-to-heading)
  8527. (run-hook-with-args 'org-cycle-hook 'children))
  8528. (message "Remote: CHILDREN"))
  8529. ((= more 3)
  8530. (outline-show-subtree)
  8531. (save-excursion
  8532. (org-back-to-heading)
  8533. (run-hook-with-args 'org-cycle-hook 'subtree))
  8534. (message "Remote: SUBTREE"))
  8535. ((= more 4)
  8536. (outline-show-subtree)
  8537. (save-excursion
  8538. (org-back-to-heading)
  8539. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8540. (message "Remote: SUBTREE AND LOGBOOK"))
  8541. ((> more 4)
  8542. (outline-show-subtree)
  8543. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8544. (select-window win)))
  8545. (defvar org-agenda-cycle-counter nil)
  8546. (defun org-agenda-cycle-show (&optional n)
  8547. "Show the current entry in another window, with default settings.
  8548. Default settings are taken from `org-show-context-detail'. When
  8549. use repeatedly in immediate succession, the remote entry will
  8550. cycle through visibility
  8551. children -> subtree -> folded
  8552. When called with a numeric prefix arg, that arg will be passed through to
  8553. `org-agenda-show-1'. For the interpretation of that argument, see the
  8554. docstring of `org-agenda-show-1'."
  8555. (interactive "P")
  8556. (if (integerp n)
  8557. (setq org-agenda-cycle-counter n)
  8558. (if (not (eq last-command this-command))
  8559. (setq org-agenda-cycle-counter 1)
  8560. (if (equal org-agenda-cycle-counter 0)
  8561. (setq org-agenda-cycle-counter 2)
  8562. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8563. (when (> org-agenda-cycle-counter 3)
  8564. (setq org-agenda-cycle-counter 0)))))
  8565. (org-agenda-show-1 org-agenda-cycle-counter))
  8566. (defun org-agenda-recenter (arg)
  8567. "Display the Org file which contains the item at point and recenter."
  8568. (interactive "P")
  8569. (let ((win (selected-window)))
  8570. (org-agenda-goto t)
  8571. (recenter arg)
  8572. (select-window win)))
  8573. (defun org-agenda-show-mouse (ev)
  8574. "Display the Org file which contains the item at the mouse click."
  8575. (interactive "e")
  8576. (mouse-set-point ev)
  8577. (org-agenda-show))
  8578. (defun org-agenda-check-no-diary ()
  8579. "Check if the entry is a diary link and abort if yes."
  8580. (when (org-get-at-bol 'org-agenda-diary-link)
  8581. (org-agenda-error)))
  8582. (defun org-agenda-error ()
  8583. "Throw an error when a command is not allowed in the agenda."
  8584. (user-error "Command not allowed in this line"))
  8585. (defun org-agenda-tree-to-indirect-buffer (arg)
  8586. "Show the subtree corresponding to the current entry in an indirect buffer.
  8587. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8588. With a numerical prefix ARG, go up to this level and then take that tree.
  8589. With a negative numeric ARG, go up by this number of levels.
  8590. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8591. i.e. don't use
  8592. the dedicated frame."
  8593. (interactive "P")
  8594. (if current-prefix-arg
  8595. (org-agenda-do-tree-to-indirect-buffer arg)
  8596. (let ((agenda-buffer (buffer-name))
  8597. (agenda-window (selected-window))
  8598. (indirect-window
  8599. (and org-last-indirect-buffer
  8600. (get-buffer-window org-last-indirect-buffer))))
  8601. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8602. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8603. (eq org-indirect-buffer-display 'dedicated-frame))
  8604. (unwind-protect
  8605. (unless (and indirect-window (window-live-p indirect-window))
  8606. (setq indirect-window (split-window agenda-window)))
  8607. (and indirect-window (select-window indirect-window))
  8608. (switch-to-buffer org-last-indirect-buffer :norecord)
  8609. (fit-window-to-buffer indirect-window)))
  8610. (select-window (get-buffer-window agenda-buffer))
  8611. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8612. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8613. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8614. (org-agenda-check-no-diary)
  8615. (let* ((marker (or (org-get-at-bol 'org-marker)
  8616. (org-agenda-error)))
  8617. (buffer (marker-buffer marker))
  8618. (pos (marker-position marker)))
  8619. (with-current-buffer buffer
  8620. (save-excursion
  8621. (goto-char pos)
  8622. (org-tree-to-indirect-buffer arg)))))
  8623. (defvar org-last-heading-marker (make-marker)
  8624. "Marker pointing to the headline that last changed its TODO state
  8625. by a remote command from the agenda.")
  8626. (defun org-agenda-todo-nextset ()
  8627. "Switch TODO entry to next sequence."
  8628. (interactive)
  8629. (org-agenda-todo 'nextset))
  8630. (defun org-agenda-todo-previousset ()
  8631. "Switch TODO entry to previous sequence."
  8632. (interactive)
  8633. (org-agenda-todo 'previousset))
  8634. (defun org-agenda-todo (&optional arg)
  8635. "Cycle TODO state of line at point, also in Org file.
  8636. This changes the line at point, all other lines in the agenda referring to
  8637. the same tree node, and the headline of the tree node in the Org file."
  8638. (interactive "P")
  8639. (org-agenda-check-no-diary)
  8640. (org-agenda-maybe-loop
  8641. #'org-agenda-todo arg nil nil
  8642. (let* ((col (current-column))
  8643. (marker (or (org-get-at-bol 'org-marker)
  8644. (org-agenda-error)))
  8645. (buffer (marker-buffer marker))
  8646. (pos (marker-position marker))
  8647. (hdmarker (org-get-at-bol 'org-hd-marker))
  8648. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8649. (inhibit-read-only t)
  8650. org-loop-over-headlines-in-active-region
  8651. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8652. (org-with-remote-undo buffer
  8653. (with-current-buffer buffer
  8654. (widen)
  8655. (goto-char pos)
  8656. (org-show-context 'agenda)
  8657. (let ((current-prefix-arg arg))
  8658. (call-interactively 'org-todo))
  8659. (and (bolp) (forward-char 1))
  8660. (setq newhead (org-get-heading))
  8661. (when (and (bound-and-true-p
  8662. org-agenda-headline-snapshot-before-repeat)
  8663. (not (equal org-agenda-headline-snapshot-before-repeat
  8664. newhead))
  8665. todayp)
  8666. (setq newhead org-agenda-headline-snapshot-before-repeat
  8667. just-one t))
  8668. (save-excursion
  8669. (org-back-to-heading)
  8670. (move-marker org-last-heading-marker (point))))
  8671. (beginning-of-line 1)
  8672. (save-window-excursion
  8673. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8674. (when (bound-and-true-p org-clock-out-when-done)
  8675. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8676. newhead)
  8677. (org-agenda-unmark-clocking-task))
  8678. (org-move-to-column col)
  8679. (org-agenda-mark-clocking-task)))))
  8680. (defun org-agenda-add-note (&optional arg)
  8681. "Add a time-stamped note to the entry at point."
  8682. (interactive "P")
  8683. (org-agenda-check-no-diary)
  8684. (let* ((marker (or (org-get-at-bol 'org-marker)
  8685. (org-agenda-error)))
  8686. (buffer (marker-buffer marker))
  8687. (pos (marker-position marker))
  8688. (hdmarker (org-get-at-bol 'org-hd-marker))
  8689. (inhibit-read-only t))
  8690. (with-current-buffer buffer
  8691. (widen)
  8692. (goto-char pos)
  8693. (org-show-context 'agenda)
  8694. (org-add-note))))
  8695. (defun org-agenda-change-all-lines (newhead hdmarker
  8696. &optional fixface just-this)
  8697. "Change all lines in the agenda buffer which match HDMARKER.
  8698. The new content of the line will be NEWHEAD (as modified by
  8699. `org-agenda-format-item'). HDMARKER is checked with
  8700. `equal' against all `org-hd-marker' text properties in the file.
  8701. If FIXFACE is non-nil, the face of each item is modified according to
  8702. the new TODO state.
  8703. If JUST-THIS is non-nil, change just the current line, not all.
  8704. If FORCE-TAGS is non-nil, the car of it returns the new tags."
  8705. (let* ((inhibit-read-only t)
  8706. (line (org-current-line))
  8707. (org-agenda-buffer (current-buffer))
  8708. (thetags (with-current-buffer (marker-buffer hdmarker)
  8709. (org-get-tags hdmarker)))
  8710. props m pl undone-face done-face finish new dotime level cat tags)
  8711. (save-excursion
  8712. (goto-char (point-max))
  8713. (beginning-of-line 1)
  8714. (while (not finish)
  8715. (setq finish (bobp))
  8716. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8717. (or (not just-this) (= (org-current-line) line))
  8718. (equal m hdmarker))
  8719. (setq props (text-properties-at (point))
  8720. dotime (org-get-at-bol 'dotime)
  8721. cat (org-agenda-get-category)
  8722. level (org-get-at-bol 'level)
  8723. tags thetags
  8724. new
  8725. (let ((org-prefix-format-compiled
  8726. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8727. org-prefix-format-compiled))
  8728. (extra (org-get-at-bol 'extra)))
  8729. (with-current-buffer (marker-buffer hdmarker)
  8730. (org-with-wide-buffer
  8731. (org-agenda-format-item extra newhead level cat tags dotime))))
  8732. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8733. undone-face (org-get-at-bol 'undone-face)
  8734. done-face (org-get-at-bol 'done-face))
  8735. (beginning-of-line 1)
  8736. (cond
  8737. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8738. ((looking-at ".*")
  8739. ;; When replacing the whole line, preserve bulk mark
  8740. ;; overlay, if any.
  8741. (let ((mark (catch :overlay
  8742. (dolist (o (overlays-in (point) (+ 2 (point))))
  8743. (when (eq (overlay-get o 'type)
  8744. 'org-marked-entry-overlay)
  8745. (throw :overlay o))))))
  8746. (replace-match new t t)
  8747. (beginning-of-line)
  8748. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8749. (add-text-properties (point-at-bol) (point-at-eol) props)
  8750. (when fixface
  8751. (add-text-properties
  8752. (point-at-bol) (point-at-eol)
  8753. (list 'face
  8754. (if org-last-todo-state-is-todo
  8755. undone-face done-face))))
  8756. (org-agenda-highlight-todo 'line)
  8757. (beginning-of-line 1))
  8758. (t (error "Line update did not work")))
  8759. (save-restriction
  8760. (narrow-to-region (point-at-bol) (point-at-eol))
  8761. (org-agenda-finalize)))
  8762. (beginning-of-line 0)))))
  8763. (defun org-agenda-align-tags (&optional line)
  8764. "Align all tags in agenda items to `org-agenda-tags-column'.
  8765. When optional argument LINE is non-nil, align tags only on the
  8766. current line."
  8767. (let ((inhibit-read-only t)
  8768. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8769. (- (window-text-width))
  8770. org-agenda-tags-column))
  8771. (end (and line (line-end-position)))
  8772. l c)
  8773. (save-excursion
  8774. (goto-char (if line (line-beginning-position) (point-min)))
  8775. (while (re-search-forward org-tag-group-re end t)
  8776. (add-text-properties
  8777. (match-beginning 1) (match-end 1)
  8778. (list 'face (delq nil (let ((prop (get-text-property
  8779. (match-beginning 1) 'face)))
  8780. (or (listp prop) (setq prop (list prop)))
  8781. (if (memq 'org-tag prop)
  8782. prop
  8783. (cons 'org-tag prop))))))
  8784. (setq l (string-width (match-string 1))
  8785. c (if (< org-agenda-tags-column 0)
  8786. (- (abs org-agenda-tags-column) l)
  8787. org-agenda-tags-column))
  8788. (goto-char (match-beginning 1))
  8789. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8790. (point))
  8791. (insert (org-add-props
  8792. (make-string (max 1 (- c (current-column))) ?\s)
  8793. (plist-put (copy-sequence (text-properties-at (point)))
  8794. 'face nil))))
  8795. (goto-char (point-min))
  8796. (org-font-lock-add-tag-faces (point-max)))))
  8797. (defun org-agenda-priority-up ()
  8798. "Increase the priority of line at point, also in Org file."
  8799. (interactive)
  8800. (org-agenda-priority 'up))
  8801. (defun org-agenda-priority-down ()
  8802. "Decrease the priority of line at point, also in Org file."
  8803. (interactive)
  8804. (org-agenda-priority 'down))
  8805. (defun org-agenda-priority (&optional force-direction)
  8806. "Set the priority of line at point, also in Org file.
  8807. This changes the line at point, all other lines in the agenda referring to
  8808. the same tree node, and the headline of the tree node in the Org file.
  8809. Called with a universal prefix arg, show the priority instead of setting it."
  8810. (interactive "P")
  8811. (if (equal force-direction '(4))
  8812. (org-priority-show)
  8813. (unless org-priority-enable-commands
  8814. (user-error "Priority commands are disabled"))
  8815. (org-agenda-check-no-diary)
  8816. (let* ((col (current-column))
  8817. (marker (or (org-get-at-bol 'org-marker)
  8818. (org-agenda-error)))
  8819. (hdmarker (org-get-at-bol 'org-hd-marker))
  8820. (buffer (marker-buffer hdmarker))
  8821. (pos (marker-position hdmarker))
  8822. (inhibit-read-only t)
  8823. newhead)
  8824. (org-with-remote-undo buffer
  8825. (with-current-buffer buffer
  8826. (widen)
  8827. (goto-char pos)
  8828. (org-show-context 'agenda)
  8829. (org-priority force-direction)
  8830. (end-of-line 1)
  8831. (setq newhead (org-get-heading)))
  8832. (org-agenda-change-all-lines newhead hdmarker)
  8833. (org-move-to-column col)))))
  8834. ;; FIXME: should fix the tags property of the agenda line.
  8835. (defun org-agenda-set-tags (&optional tag onoff)
  8836. "Set tags for the current headline."
  8837. (interactive)
  8838. (org-agenda-check-no-diary)
  8839. (if (and (org-region-active-p) (called-interactively-p 'any))
  8840. (call-interactively 'org-change-tag-in-region)
  8841. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8842. (org-agenda-error)))
  8843. (buffer (marker-buffer hdmarker))
  8844. (pos (marker-position hdmarker))
  8845. (inhibit-read-only t)
  8846. newhead)
  8847. (org-with-remote-undo buffer
  8848. (with-current-buffer buffer
  8849. (widen)
  8850. (goto-char pos)
  8851. (org-show-context 'agenda)
  8852. (if tag
  8853. (org-toggle-tag tag onoff)
  8854. (call-interactively #'org-set-tags-command))
  8855. (end-of-line 1)
  8856. (setq newhead (org-get-heading)))
  8857. (org-agenda-change-all-lines newhead hdmarker)
  8858. (beginning-of-line 1)))))
  8859. (defun org-agenda-set-property ()
  8860. "Set a property for the current headline."
  8861. (interactive)
  8862. (org-agenda-check-no-diary)
  8863. (org-agenda-maybe-loop
  8864. #'org-agenda-set-property nil nil nil
  8865. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8866. (org-agenda-error)))
  8867. (buffer (marker-buffer hdmarker))
  8868. (pos (marker-position hdmarker))
  8869. (inhibit-read-only t)
  8870. newhead)
  8871. (org-with-remote-undo buffer
  8872. (with-current-buffer buffer
  8873. (widen)
  8874. (goto-char pos)
  8875. (org-show-context 'agenda)
  8876. (call-interactively 'org-set-property))))))
  8877. (defun org-agenda-set-effort ()
  8878. "Set the effort property for the current headline."
  8879. (interactive)
  8880. (org-agenda-check-no-diary)
  8881. (org-agenda-maybe-loop
  8882. #'org-agenda-set-effort nil nil nil
  8883. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8884. (org-agenda-error)))
  8885. (buffer (marker-buffer hdmarker))
  8886. (pos (marker-position hdmarker))
  8887. (inhibit-read-only t)
  8888. newhead)
  8889. (org-with-remote-undo buffer
  8890. (with-current-buffer buffer
  8891. (widen)
  8892. (goto-char pos)
  8893. (org-show-context 'agenda)
  8894. (call-interactively 'org-set-effort)
  8895. (end-of-line 1)
  8896. (setq newhead (org-get-heading)))
  8897. (org-agenda-change-all-lines newhead hdmarker)))))
  8898. (defun org-agenda-toggle-archive-tag ()
  8899. "Toggle the archive tag for the current entry."
  8900. (interactive)
  8901. (org-agenda-check-no-diary)
  8902. (org-agenda-maybe-loop
  8903. #'org-agenda-toggle-archive-tag nil nil nil
  8904. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8905. (org-agenda-error)))
  8906. (buffer (marker-buffer hdmarker))
  8907. (pos (marker-position hdmarker))
  8908. (inhibit-read-only t)
  8909. newhead)
  8910. (org-with-remote-undo buffer
  8911. (with-current-buffer buffer
  8912. (widen)
  8913. (goto-char pos)
  8914. (org-show-context 'agenda)
  8915. (call-interactively 'org-toggle-archive-tag)
  8916. (end-of-line 1)
  8917. (setq newhead (org-get-heading)))
  8918. (org-agenda-change-all-lines newhead hdmarker)
  8919. (beginning-of-line 1)))))
  8920. (defun org-agenda-do-date-later (arg)
  8921. (interactive "P")
  8922. (cond
  8923. ((or (equal arg '(16))
  8924. (memq last-command
  8925. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8926. (setq this-command 'org-agenda-date-later-minutes)
  8927. (org-agenda-date-later-minutes 1))
  8928. ((or (equal arg '(4))
  8929. (memq last-command
  8930. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8931. (setq this-command 'org-agenda-date-later-hours)
  8932. (org-agenda-date-later-hours 1))
  8933. (t
  8934. (org-agenda-date-later (prefix-numeric-value arg)))))
  8935. (defun org-agenda-do-date-earlier (arg)
  8936. (interactive "P")
  8937. (cond
  8938. ((or (equal arg '(16))
  8939. (memq last-command
  8940. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8941. (setq this-command 'org-agenda-date-earlier-minutes)
  8942. (org-agenda-date-earlier-minutes 1))
  8943. ((or (equal arg '(4))
  8944. (memq last-command
  8945. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8946. (setq this-command 'org-agenda-date-earlier-hours)
  8947. (org-agenda-date-earlier-hours 1))
  8948. (t
  8949. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8950. (defun org-agenda-date-later (arg &optional what)
  8951. "Change the date of this item to ARG day(s) later."
  8952. (interactive "p")
  8953. (org-agenda-check-type t 'agenda)
  8954. (org-agenda-check-no-diary)
  8955. (let* ((marker (or (org-get-at-bol 'org-marker)
  8956. (org-agenda-error)))
  8957. (buffer (marker-buffer marker))
  8958. (pos (marker-position marker))
  8959. cdate today)
  8960. (org-with-remote-undo buffer
  8961. (with-current-buffer buffer
  8962. (widen)
  8963. (goto-char pos)
  8964. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8965. (when (and org-agenda-move-date-from-past-immediately-to-today
  8966. (equal arg 1)
  8967. (or (not what) (eq what 'day))
  8968. (not (save-match-data (org-at-date-range-p))))
  8969. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8970. cdate (calendar-absolute-from-gregorian
  8971. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8972. today (org-today))
  8973. (when (> today cdate)
  8974. ;; immediately shift to today
  8975. (setq arg (- today cdate))))
  8976. (org-timestamp-change arg (or what 'day))
  8977. (when (and (org-at-date-range-p)
  8978. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8979. (let ((end org-last-changed-timestamp))
  8980. (org-timestamp-change arg (or what 'day))
  8981. (setq org-last-changed-timestamp
  8982. (concat org-last-changed-timestamp "--" end)))))
  8983. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8984. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8985. (defun org-agenda-date-earlier (arg &optional what)
  8986. "Change the date of this item to ARG day(s) earlier."
  8987. (interactive "p")
  8988. (org-agenda-date-later (- arg) what))
  8989. (defun org-agenda-date-later-minutes (arg)
  8990. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8991. (interactive "p")
  8992. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8993. (org-agenda-date-later arg 'minute))
  8994. (defun org-agenda-date-earlier-minutes (arg)
  8995. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8996. (interactive "p")
  8997. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8998. (org-agenda-date-earlier arg 'minute))
  8999. (defun org-agenda-date-later-hours (arg)
  9000. "Change the time of this item, in hour steps."
  9001. (interactive "p")
  9002. (org-agenda-date-later arg 'hour))
  9003. (defun org-agenda-date-earlier-hours (arg)
  9004. "Change the time of this item, in hour steps."
  9005. (interactive "p")
  9006. (org-agenda-date-earlier arg 'hour))
  9007. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  9008. "Show new date stamp via text properties."
  9009. ;; We use text properties to make this undoable
  9010. (let ((inhibit-read-only t))
  9011. (setq stamp (concat prefix " => " stamp " "))
  9012. (save-excursion
  9013. (goto-char (point-max))
  9014. (while (not (bobp))
  9015. (when (equal marker (org-get-at-bol 'org-marker))
  9016. (remove-text-properties (line-beginning-position)
  9017. (line-end-position)
  9018. '(display nil))
  9019. (org-move-to-column
  9020. (- (/ (window-width nil t) (window-font-width)) (length stamp)) t)
  9021. (add-text-properties
  9022. (1- (point)) (point-at-eol)
  9023. (list 'display (org-add-props stamp nil
  9024. 'face '(secondary-selection default))))
  9025. (beginning-of-line 1))
  9026. (beginning-of-line 0)))))
  9027. (defun org-agenda-date-prompt (arg)
  9028. "Change the date of this item. Date is prompted for, with default today.
  9029. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  9030. be used to request time specification in the time stamp."
  9031. (interactive "P")
  9032. (org-agenda-check-type t 'agenda)
  9033. (org-agenda-check-no-diary)
  9034. (org-agenda-maybe-loop
  9035. #'org-agenda-date-prompt arg t nil
  9036. (let* ((marker (or (org-get-at-bol 'org-marker)
  9037. (org-agenda-error)))
  9038. (buffer (marker-buffer marker))
  9039. (pos (marker-position marker)))
  9040. (org-with-remote-undo buffer
  9041. (with-current-buffer buffer
  9042. (widen)
  9043. (goto-char pos)
  9044. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9045. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  9046. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9047. (message "Time stamp changed to %s" org-last-changed-timestamp))))
  9048. (defun org-agenda-schedule (arg &optional time)
  9049. "Schedule the item at point.
  9050. ARG is passed through to `org-schedule'."
  9051. (interactive "P")
  9052. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9053. (org-agenda-check-no-diary)
  9054. (org-agenda-maybe-loop
  9055. #'org-agenda-schedule arg t nil
  9056. (let* ((marker (or (org-get-at-bol 'org-marker)
  9057. (org-agenda-error)))
  9058. (type (marker-insertion-type marker))
  9059. (buffer (marker-buffer marker))
  9060. (pos (marker-position marker))
  9061. ts)
  9062. (set-marker-insertion-type marker t)
  9063. (org-with-remote-undo buffer
  9064. (with-current-buffer buffer
  9065. (widen)
  9066. (goto-char pos)
  9067. (setq ts (org-schedule arg time)))
  9068. (org-agenda-show-new-time marker ts " S"))
  9069. (message "%s" ts))))
  9070. (defun org-agenda-deadline (arg &optional time)
  9071. "Schedule the item at point.
  9072. ARG is passed through to `org-deadline'."
  9073. (interactive "P")
  9074. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9075. (org-agenda-check-no-diary)
  9076. (org-agenda-maybe-loop
  9077. #'org-agenda-deadline arg t nil
  9078. (let* ((marker (or (org-get-at-bol 'org-marker)
  9079. (org-agenda-error)))
  9080. (buffer (marker-buffer marker))
  9081. (pos (marker-position marker))
  9082. ts)
  9083. (org-with-remote-undo buffer
  9084. (with-current-buffer buffer
  9085. (widen)
  9086. (goto-char pos)
  9087. (setq ts (org-deadline arg time)))
  9088. (org-agenda-show-new-time marker ts " D"))
  9089. (message "%s" ts))))
  9090. (defun org-agenda-clock-in (&optional arg)
  9091. "Start the clock on the currently selected item."
  9092. (interactive "P")
  9093. (org-agenda-check-no-diary)
  9094. (if (equal arg '(4))
  9095. (org-clock-in arg)
  9096. (let* ((marker (or (org-get-at-bol 'org-marker)
  9097. (org-agenda-error)))
  9098. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  9099. (pos (marker-position marker))
  9100. (col (current-column))
  9101. newhead)
  9102. (org-with-remote-undo (marker-buffer marker)
  9103. (with-current-buffer (marker-buffer marker)
  9104. (widen)
  9105. (goto-char pos)
  9106. (org-show-context 'agenda)
  9107. (org-clock-in arg)
  9108. (setq newhead (org-get-heading)))
  9109. (org-agenda-change-all-lines newhead hdmarker))
  9110. (org-move-to-column col))))
  9111. (defun org-agenda-clock-out ()
  9112. "Stop the currently running clock."
  9113. (interactive)
  9114. (unless (marker-buffer org-clock-marker)
  9115. (user-error "No running clock"))
  9116. (let ((marker (make-marker)) (col (current-column)) newhead)
  9117. (org-with-remote-undo (marker-buffer org-clock-marker)
  9118. (with-current-buffer (marker-buffer org-clock-marker)
  9119. (org-with-wide-buffer
  9120. (goto-char org-clock-marker)
  9121. (org-back-to-heading t)
  9122. (move-marker marker (point))
  9123. (org-clock-out)
  9124. (setq newhead (org-get-heading)))))
  9125. (org-agenda-change-all-lines newhead marker)
  9126. (move-marker marker nil)
  9127. (org-move-to-column col)
  9128. (org-agenda-unmark-clocking-task)))
  9129. (defun org-agenda-clock-cancel (&optional arg)
  9130. "Cancel the currently running clock."
  9131. (interactive "P")
  9132. (unless (marker-buffer org-clock-marker)
  9133. (user-error "No running clock"))
  9134. (org-with-remote-undo (marker-buffer org-clock-marker)
  9135. (org-clock-cancel)))
  9136. (defun org-agenda-clock-goto ()
  9137. "Jump to the currently clocked in task within the agenda.
  9138. If the currently clocked in task is not listed in the agenda
  9139. buffer, display it in another window."
  9140. (interactive)
  9141. (let (pos)
  9142. (mapc (lambda (o)
  9143. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  9144. (setq pos (overlay-start o))))
  9145. (overlays-in (point-min) (point-max)))
  9146. (cond (pos (goto-char pos))
  9147. ;; If the currently clocked entry is not in the agenda
  9148. ;; buffer, we visit it in another window:
  9149. ((bound-and-true-p org-clock-current-task)
  9150. (org-switch-to-buffer-other-window (org-clock-goto)))
  9151. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  9152. (defun org-agenda-diary-entry-in-org-file ()
  9153. "Make a diary entry in the file `org-agenda-diary-file'."
  9154. (let (d1 d2 char (text "") dp1 dp2)
  9155. (if (equal (buffer-name) "*Calendar*")
  9156. (setq d1 (calendar-cursor-to-date t)
  9157. d2 (car calendar-mark-ring))
  9158. (setq dp1 (get-text-property (point-at-bol) 'day))
  9159. (unless dp1 (user-error "No date defined in current line"))
  9160. (setq d1 (calendar-gregorian-from-absolute dp1)
  9161. d2 (and (ignore-errors (mark))
  9162. (save-excursion
  9163. (goto-char (mark))
  9164. (setq dp2 (get-text-property (point-at-bol) 'day)))
  9165. (calendar-gregorian-from-absolute dp2))))
  9166. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  9167. (setq char (read-char-exclusive))
  9168. (cond
  9169. ((equal char ?d)
  9170. (setq text (read-string "Day entry: "))
  9171. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  9172. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9173. ((equal char ?a)
  9174. (setq d1 (list (car d1) (nth 1 d1)
  9175. (read-number (format "Reference year [%d]: " (nth 2 d1))
  9176. (nth 2 d1))))
  9177. (setq text (read-string "Anniversary (use %d to show years): "))
  9178. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  9179. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9180. ((equal char ?b)
  9181. (setq text (read-string "Block entry: "))
  9182. (unless (and d1 d2 (not (equal d1 d2)))
  9183. (user-error "No block of days selected"))
  9184. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  9185. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9186. ((equal char ?j)
  9187. (org-switch-to-buffer-other-window
  9188. (find-file-noselect org-agenda-diary-file))
  9189. (require 'org-datetree)
  9190. (org-datetree-find-date-create d1)
  9191. (org-reveal t))
  9192. (t (user-error "Invalid selection character `%c'" char)))))
  9193. (defcustom org-agenda-insert-diary-strategy 'date-tree
  9194. "Where in `org-agenda-diary-file' should new entries be added?
  9195. Valid values:
  9196. date-tree in the date tree, as first child of the date
  9197. date-tree-last in the date tree, as last child of the date
  9198. top-level as top-level entries at the end of the file."
  9199. :group 'org-agenda
  9200. :type '(choice
  9201. (const :tag "first in a date tree" date-tree)
  9202. (const :tag "last in a date tree" date-tree-last)
  9203. (const :tag "as top level at end of file" top-level)))
  9204. (defcustom org-agenda-insert-diary-extract-time nil
  9205. "Non-nil means extract any time specification from the diary entry."
  9206. :group 'org-agenda
  9207. :version "24.1"
  9208. :type 'boolean)
  9209. (defcustom org-agenda-bulk-mark-char ">"
  9210. "A single-character string to be used as the bulk mark."
  9211. :group 'org-agenda
  9212. :version "24.1"
  9213. :type 'string)
  9214. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  9215. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  9216. If TEXT is not empty, it will become the headline of the new entry, and
  9217. the resulting entry will not be shown. When TEXT is empty, switch to
  9218. `org-agenda-diary-file' and let the user finish the entry there."
  9219. (let ((cw (current-window-configuration)))
  9220. (org-switch-to-buffer-other-window
  9221. (find-file-noselect org-agenda-diary-file))
  9222. (widen)
  9223. (goto-char (point-min))
  9224. (cl-case type
  9225. (anniversary
  9226. (or (re-search-forward "^\\*[ \t]+Anniversaries" nil t)
  9227. (progn
  9228. (or (org-at-heading-p t)
  9229. (progn
  9230. (outline-next-heading)
  9231. (insert "* Anniversaries\n\n")
  9232. (beginning-of-line -1)))))
  9233. (outline-next-heading)
  9234. (org-back-over-empty-lines)
  9235. (backward-char 1)
  9236. (insert "\n")
  9237. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  9238. (nth 2 d1) (car d1) (nth 1 d1) text)))
  9239. (day
  9240. (let ((org-prefix-has-time t)
  9241. (org-agenda-time-leading-zero t)
  9242. fmt time time2)
  9243. (when org-agenda-insert-diary-extract-time
  9244. ;; Use org-agenda-format-item to parse text for a time-range and
  9245. ;; remove it. FIXME: This is a hack, we should refactor
  9246. ;; that function to make time extraction available separately
  9247. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  9248. time (get-text-property 0 'time fmt)
  9249. time2 (if (> (length time) 0)
  9250. ;; split-string removes trailing ...... if
  9251. ;; no end time given. First space
  9252. ;; separates time from date.
  9253. (concat " " (car (split-string time "\\.")))
  9254. nil)
  9255. text (get-text-property 0 'txt fmt)))
  9256. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9257. (org-agenda-insert-diary-as-top-level text)
  9258. (require 'org-datetree)
  9259. (org-datetree-find-date-create d1)
  9260. (org-agenda-insert-diary-make-new-entry text))
  9261. (org-insert-time-stamp (org-time-from-absolute
  9262. (calendar-absolute-from-gregorian d1))
  9263. nil nil nil nil time2))
  9264. (end-of-line 0))
  9265. ((block) ;; Wrap this in (strictly unnecessary) parens because
  9266. ;; otherwise the indentation gets confused by the
  9267. ;; special meaning of 'block
  9268. (when (> (calendar-absolute-from-gregorian d1)
  9269. (calendar-absolute-from-gregorian d2))
  9270. (setq d1 (prog1 d2 (setq d2 d1))))
  9271. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9272. (org-agenda-insert-diary-as-top-level text)
  9273. (require 'org-datetree)
  9274. (org-datetree-find-date-create d1)
  9275. (org-agenda-insert-diary-make-new-entry text))
  9276. (org-insert-time-stamp (org-time-from-absolute
  9277. (calendar-absolute-from-gregorian d1)))
  9278. (insert "--")
  9279. (org-insert-time-stamp (org-time-from-absolute
  9280. (calendar-absolute-from-gregorian d2)))
  9281. (end-of-line 0)))
  9282. (if (string-match "\\S-" text)
  9283. (progn
  9284. (set-window-configuration cw)
  9285. (message "%s entry added to %s"
  9286. (capitalize (symbol-name type))
  9287. (abbreviate-file-name org-agenda-diary-file)))
  9288. (org-reveal t)
  9289. (message "Please finish entry here"))))
  9290. (defun org-agenda-insert-diary-as-top-level (text)
  9291. "Make new entry as a top-level entry at the end of the file.
  9292. Add TEXT as headline, and position the cursor in the second line so that
  9293. a timestamp can be added there."
  9294. (widen)
  9295. (goto-char (point-max))
  9296. (unless (bolp) (insert "\n"))
  9297. (org-insert-heading nil t t)
  9298. (insert text)
  9299. (org-end-of-meta-data)
  9300. (unless (bolp) (insert "\n"))
  9301. (when org-adapt-indentation (indent-to-column 2)))
  9302. (defun org-agenda-insert-diary-make-new-entry (text)
  9303. "Make a new entry with TEXT as a child of the current subtree.
  9304. Position the point in the heading's first body line so that
  9305. a timestamp can be added there."
  9306. (cond
  9307. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  9308. (end-of-line)
  9309. (org-insert-heading '(4) t)
  9310. (org-do-demote))
  9311. (t
  9312. (outline-next-heading)
  9313. (org-back-over-empty-lines)
  9314. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  9315. (org-insert-heading nil t)
  9316. (org-do-demote)))
  9317. (let ((col (current-column)))
  9318. (insert text)
  9319. (org-end-of-meta-data)
  9320. ;; Ensure point is left on a blank line, at proper indentation.
  9321. (unless (bolp) (insert "\n"))
  9322. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  9323. (when org-adapt-indentation (indent-to-column col)))
  9324. (org-show-set-visibility 'lineage))
  9325. (defun org-agenda-diary-entry ()
  9326. "Make a diary entry, like the `i' command from the calendar.
  9327. All the standard commands work: block, weekly etc.
  9328. When `org-agenda-diary-file' points to a file,
  9329. `org-agenda-diary-entry-in-org-file' is called instead to create
  9330. entries in that Org file."
  9331. (interactive)
  9332. (if (not (eq org-agenda-diary-file 'diary-file))
  9333. (org-agenda-diary-entry-in-org-file)
  9334. (require 'diary-lib)
  9335. (let* ((char (read-char-exclusive
  9336. "Diary entry: [d]ay [w]eekly [m]onthly [y]early\
  9337. [a]nniversary [b]lock [c]yclic"))
  9338. (cmd (cdr (assoc char
  9339. '((?d . diary-insert-entry)
  9340. (?w . diary-insert-weekly-entry)
  9341. (?m . diary-insert-monthly-entry)
  9342. (?y . diary-insert-yearly-entry)
  9343. (?a . diary-insert-anniversary-entry)
  9344. (?b . diary-insert-block-entry)
  9345. (?c . diary-insert-cyclic-entry)))))
  9346. (oldf (symbol-function 'calendar-cursor-to-date))
  9347. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  9348. (point (point))
  9349. (mark (or (mark t) (point))))
  9350. (unless cmd
  9351. (user-error "No command associated with <%c>" char))
  9352. (unless (and (get-text-property point 'day)
  9353. (or (not (equal ?b char))
  9354. (get-text-property mark 'day)))
  9355. (user-error "Don't know which date to use for diary entry"))
  9356. ;; We implement this by hacking the `calendar-cursor-to-date' function
  9357. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  9358. (let ((calendar-mark-ring
  9359. (list (calendar-gregorian-from-absolute
  9360. (or (get-text-property mark 'day)
  9361. (get-text-property point 'day))))))
  9362. (unwind-protect
  9363. (progn
  9364. (fset 'calendar-cursor-to-date
  9365. (lambda (&optional error dummy)
  9366. (calendar-gregorian-from-absolute
  9367. (get-text-property point 'day))))
  9368. (call-interactively cmd))
  9369. (fset 'calendar-cursor-to-date oldf))))))
  9370. (defun org-agenda-execute-calendar-command (cmd)
  9371. "Execute a calendar command from the agenda with date from cursor."
  9372. (org-agenda-check-type t 'agenda)
  9373. (require 'diary-lib)
  9374. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  9375. (user-error "Don't know which date to use for the calendar command"))
  9376. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  9377. (point (point))
  9378. (date (calendar-gregorian-from-absolute
  9379. (get-text-property point 'day)))
  9380. ;; the following 2 vars are needed in the calendar
  9381. (displayed-month (car date))
  9382. (displayed-year (nth 2 date)))
  9383. (unwind-protect
  9384. (progn
  9385. (fset 'calendar-cursor-to-date
  9386. (lambda (&optional error dummy)
  9387. (calendar-gregorian-from-absolute
  9388. (get-text-property point 'day))))
  9389. (call-interactively cmd))
  9390. (fset 'calendar-cursor-to-date oldf))))
  9391. (defun org-agenda-phases-of-moon ()
  9392. "Display the phases of the moon for the 3 months around the cursor date."
  9393. (interactive)
  9394. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  9395. (defun org-agenda-holidays ()
  9396. "Display the holidays for the 3 months around the cursor date."
  9397. (interactive)
  9398. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  9399. (defvar calendar-longitude) ; defined in calendar.el
  9400. (defvar calendar-latitude) ; defined in calendar.el
  9401. (defvar calendar-location-name) ; defined in calendar.el
  9402. (defun org-agenda-sunrise-sunset (arg)
  9403. "Display sunrise and sunset for the cursor date.
  9404. Latitude and longitude can be specified with the variables
  9405. `calendar-latitude' and `calendar-longitude'. When called with prefix
  9406. argument, latitude and longitude will be prompted for."
  9407. (interactive "P")
  9408. (require 'solar)
  9409. (let ((calendar-longitude (if arg nil calendar-longitude))
  9410. (calendar-latitude (if arg nil calendar-latitude))
  9411. (calendar-location-name
  9412. (if arg "the given coordinates" calendar-location-name)))
  9413. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  9414. (defun org-agenda-goto-calendar ()
  9415. "Open the Emacs calendar with the date at the cursor."
  9416. (interactive)
  9417. (org-agenda-check-type t 'agenda)
  9418. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  9419. (user-error "Don't know which date to open in calendar")))
  9420. (date (calendar-gregorian-from-absolute day))
  9421. (calendar-move-hook nil)
  9422. (calendar-view-holidays-initially-flag nil)
  9423. (calendar-view-diary-initially-flag nil))
  9424. (calendar)
  9425. (calendar-goto-date date)))
  9426. ;;;###autoload
  9427. (defun org-calendar-goto-agenda ()
  9428. "Compute the Org agenda for the calendar date displayed at the cursor.
  9429. This is a command that has to be installed in `calendar-mode-map'."
  9430. (interactive)
  9431. ;; Temporarily disable sticky agenda since user clearly wants to
  9432. ;; refresh view anyway.
  9433. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  9434. (org-agenda-sticky nil))
  9435. (org-agenda-list nil (calendar-absolute-from-gregorian
  9436. (calendar-cursor-to-date))
  9437. nil)))
  9438. (defun org-agenda-convert-date ()
  9439. (interactive)
  9440. (org-agenda-check-type t 'agenda)
  9441. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  9442. date s)
  9443. (unless day
  9444. (user-error "Don't know which date to convert"))
  9445. (setq date (calendar-gregorian-from-absolute day))
  9446. (setq s (concat
  9447. "Gregorian: " (calendar-date-string date) "\n"
  9448. "ISO: " (calendar-iso-date-string date) "\n"
  9449. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  9450. "Julian: " (calendar-julian-date-string date) "\n"
  9451. "Astron. JD: " (calendar-astro-date-string date)
  9452. " (Julian date number at noon UTC)\n"
  9453. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  9454. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  9455. "French: " (calendar-french-date-string date) "\n"
  9456. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  9457. "Mayan: " (calendar-mayan-date-string date) "\n"
  9458. "Coptic: " (calendar-coptic-date-string date) "\n"
  9459. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  9460. "Persian: " (calendar-persian-date-string date) "\n"
  9461. "Chinese: " (calendar-chinese-date-string date) "\n"))
  9462. (with-output-to-temp-buffer "*Dates*"
  9463. (princ s))
  9464. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  9465. ;;; Bulk commands
  9466. (defun org-agenda-bulk-marked-p ()
  9467. "Non-nil when current entry is marked for bulk action."
  9468. (eq (get-char-property (point-at-bol) 'type)
  9469. 'org-marked-entry-overlay))
  9470. (defun org-agenda-bulk-mark (&optional arg)
  9471. "Mark entries for future bulk action.
  9472. When ARG is nil or one and region is not active then mark the
  9473. entry at point.
  9474. When ARG is nil or one and region is active then mark the entries
  9475. in the region.
  9476. When ARG is greater than one mark ARG lines."
  9477. (interactive "p")
  9478. (when (and (or (not arg) (= arg 1)) (use-region-p))
  9479. (setq arg (count-lines (region-beginning) (region-end)))
  9480. (goto-char (region-beginning))
  9481. (deactivate-mark))
  9482. (dotimes (i (or arg 1))
  9483. (unless (org-get-at-bol 'org-agenda-diary-link)
  9484. (let* ((m (org-get-at-bol 'org-hd-marker))
  9485. ov)
  9486. (unless (org-agenda-bulk-marked-p)
  9487. (unless m (user-error "Nothing to mark at point"))
  9488. (push m org-agenda-bulk-marked-entries)
  9489. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  9490. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  9491. (org-get-todo-face "TODO")
  9492. 'evaporate)
  9493. (overlay-put ov 'type 'org-marked-entry-overlay))
  9494. (end-of-line 1)
  9495. (or (ignore-errors
  9496. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9497. (beginning-of-line 2))
  9498. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9499. (beginning-of-line 2)))))
  9500. (message "%d entries marked for bulk action"
  9501. (length org-agenda-bulk-marked-entries)))
  9502. (defun org-agenda-bulk-mark-all ()
  9503. "Mark all entries for future agenda bulk action."
  9504. (interactive)
  9505. (org-agenda-bulk-mark-regexp "."))
  9506. (defun org-agenda-bulk-mark-regexp (regexp)
  9507. "Mark entries matching REGEXP for future agenda bulk action."
  9508. (interactive "sMark entries matching regexp: ")
  9509. (let ((entries-marked 0) txt-at-point)
  9510. (save-excursion
  9511. (goto-char (point-min))
  9512. (goto-char (next-single-property-change (point) 'org-hd-marker))
  9513. (while (and (re-search-forward regexp nil t)
  9514. (setq txt-at-point
  9515. (get-text-property (match-beginning 0) 'txt)))
  9516. (if (get-char-property (point) 'invisible)
  9517. (beginning-of-line 2)
  9518. (when (string-match-p regexp txt-at-point)
  9519. (setq entries-marked (1+ entries-marked))
  9520. (call-interactively 'org-agenda-bulk-mark)))))
  9521. (unless entries-marked
  9522. (message "No entry matching this regexp."))))
  9523. (defun org-agenda-bulk-unmark (&optional arg)
  9524. "Unmark the entry at point for future bulk action."
  9525. (interactive "P")
  9526. (if arg
  9527. (org-agenda-bulk-unmark-all)
  9528. (cond ((org-agenda-bulk-marked-p)
  9529. (org-agenda-bulk-remove-overlays
  9530. (point-at-bol) (+ 2 (point-at-bol)))
  9531. (setq org-agenda-bulk-marked-entries
  9532. (delete (org-get-at-bol 'org-hd-marker)
  9533. org-agenda-bulk-marked-entries))
  9534. (end-of-line 1)
  9535. (or (ignore-errors
  9536. (goto-char (next-single-property-change (point) 'txt)))
  9537. (beginning-of-line 2))
  9538. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9539. (beginning-of-line 2))
  9540. (message "%d entries left marked for bulk action"
  9541. (length org-agenda-bulk-marked-entries)))
  9542. (t (message "No entry to unmark here")))))
  9543. (defun org-agenda-bulk-toggle-all ()
  9544. "Toggle all marks for bulk action."
  9545. (interactive)
  9546. (save-excursion
  9547. (goto-char (point-min))
  9548. (while (ignore-errors
  9549. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9550. (org-agenda-bulk-toggle))))
  9551. (defun org-agenda-bulk-toggle ()
  9552. "Toggle the mark at point for bulk action."
  9553. (interactive)
  9554. (if (org-agenda-bulk-marked-p)
  9555. (org-agenda-bulk-unmark)
  9556. (org-agenda-bulk-mark)))
  9557. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  9558. "Remove the mark overlays between BEG and END in the agenda buffer.
  9559. BEG and END default to the buffer limits.
  9560. This only removes the overlays, it does not remove the markers
  9561. from the list in `org-agenda-bulk-marked-entries'."
  9562. (interactive)
  9563. (mapc (lambda (ov)
  9564. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  9565. (delete-overlay ov)))
  9566. (overlays-in (or beg (point-min)) (or end (point-max)))))
  9567. (defun org-agenda-bulk-unmark-all ()
  9568. "Remove all marks in the agenda buffer.
  9569. This will remove the markers and the overlays."
  9570. (interactive)
  9571. (if (null org-agenda-bulk-marked-entries)
  9572. (message "No entry to unmark")
  9573. (setq org-agenda-bulk-marked-entries nil)
  9574. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  9575. (defcustom org-agenda-persistent-marks nil
  9576. "Non-nil means marked items will stay marked after a bulk action.
  9577. You can toggle this interactively by typing `p' when prompted for a
  9578. bulk action."
  9579. :group 'org-agenda
  9580. :version "24.1"
  9581. :type 'boolean)
  9582. (defcustom org-agenda-loop-over-headlines-in-active-region nil
  9583. "Shall some commands act upon headlines in the active region?
  9584. When set to t, some commands will be performed in all headlines
  9585. within the active region.
  9586. When set to `start-level', some commands will be performed in all
  9587. headlines within the active region, provided that these headlines
  9588. are of the same level than the first one.
  9589. When set to a regular expression, those commands will be
  9590. performed on the matching headlines within the active region.
  9591. The list of commands is: `org-agenda-schedule',
  9592. `org-agenda-deadline', `org-agenda-date-prompt',
  9593. `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'.
  9594. See `org-loop-over-headlines-in-active-region' for the equivalent
  9595. option for Org buffers."
  9596. :type '(choice (const :tag "Don't loop" nil)
  9597. (const :tag "All headlines in active region" t)
  9598. (const :tag "In active region, headlines at the same level than the first one" start-level)
  9599. (regexp :tag "Regular expression matcher"))
  9600. :package-version '(Org . "9.4")
  9601. :group 'org-agenda)
  9602. (defun org-agenda-bulk-action (&optional arg)
  9603. "Execute an remote-editing action on all marked entries.
  9604. The prefix arg is passed through to the command if possible."
  9605. (interactive "P")
  9606. ;; When there is no mark, act on the agenda entry at point.
  9607. (if (not org-agenda-bulk-marked-entries)
  9608. (save-excursion (org-agenda-bulk-mark)))
  9609. (dolist (m org-agenda-bulk-marked-entries)
  9610. (unless (and (markerp m)
  9611. (marker-buffer m)
  9612. (buffer-live-p (marker-buffer m))
  9613. (marker-position m))
  9614. (user-error "Marker %s for bulk command is invalid" m)))
  9615. ;; Prompt for the bulk command.
  9616. (org-unlogged-message
  9617. (concat "Bulk (" (if org-agenda-persistent-marks "" "don't ") "[p]ersist marks): "
  9618. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  9619. "[S]catter [f]unction "
  9620. (and org-agenda-bulk-custom-functions
  9621. (format " Custom: [%s]"
  9622. (mapconcat (lambda (f) (char-to-string (car f)))
  9623. org-agenda-bulk-custom-functions
  9624. "")))))
  9625. (catch 'exit
  9626. (let* ((org-log-refile (if org-log-refile 'time nil))
  9627. (entries (reverse org-agenda-bulk-marked-entries))
  9628. (org-overriding-default-time
  9629. (and (get-text-property (point) 'org-agenda-date-header)
  9630. (org-get-cursor-date)))
  9631. redo-at-end
  9632. cmd)
  9633. (pcase (read-char-exclusive)
  9634. (?p
  9635. (let ((org-agenda-persistent-marks
  9636. (not org-agenda-persistent-marks)))
  9637. (org-agenda-bulk-action)
  9638. (throw 'exit nil)))
  9639. (?$
  9640. (setq cmd #'org-agenda-archive))
  9641. (?A
  9642. (setq cmd #'org-agenda-archive-to-archive-sibling))
  9643. ((or ?r ?w)
  9644. (let ((refile-location
  9645. (org-refile-get-location
  9646. "Refile to"
  9647. (marker-buffer (car entries))
  9648. org-refile-allow-creating-parent-nodes)))
  9649. (when (nth 3 refile-location)
  9650. (setcar (nthcdr 3 refile-location)
  9651. (move-marker
  9652. (make-marker)
  9653. (nth 3 refile-location)
  9654. (or (get-file-buffer (nth 1 refile-location))
  9655. (find-buffer-visiting (nth 1 refile-location))
  9656. (error "This should not happen")))))
  9657. (setq cmd `(lambda () (org-agenda-refile nil ',refile-location t)))
  9658. (setq redo-at-end t)))
  9659. (?t
  9660. (let ((state (completing-read
  9661. "Todo state: "
  9662. (with-current-buffer (marker-buffer (car entries))
  9663. (mapcar #'list org-todo-keywords-1)))))
  9664. (setq cmd `(lambda ()
  9665. (let ((org-inhibit-blocking t)
  9666. (org-inhibit-logging 'note))
  9667. (org-agenda-todo ,state))))))
  9668. ((and (or ?- ?+) action)
  9669. (let ((tag (completing-read
  9670. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  9671. (with-current-buffer (marker-buffer (car entries))
  9672. (delq nil
  9673. (mapcar (lambda (x) (and (stringp (car x)) x))
  9674. org-current-tag-alist))))))
  9675. (setq cmd
  9676. `(lambda ()
  9677. (org-agenda-set-tags ,tag
  9678. ,(if (eq action ?+) ''on ''off))))))
  9679. ((and (or ?s ?d) c)
  9680. (let* ((schedule? (eq c ?s))
  9681. (prompt (if schedule? "(Re)Schedule to" "(Re)Set Deadline to"))
  9682. (time
  9683. (and (not arg)
  9684. (let ((new (org-read-date
  9685. nil nil nil prompt org-overriding-default-time)))
  9686. ;; A "double plus" answer applies to every
  9687. ;; scheduled time. Do not turn it into
  9688. ;; a fixed date yet.
  9689. (if (string-match-p "\\`[ \t]*\\+\\+"
  9690. org-read-date-final-answer)
  9691. org-read-date-final-answer
  9692. new)))))
  9693. ;; Make sure to not prompt for a note when bulk
  9694. ;; rescheduling/resetting deadline as Org cannot cope with
  9695. ;; simultaneous notes. Besides, it could be annoying
  9696. ;; depending on the number of marked items.
  9697. (setq cmd
  9698. (if schedule?
  9699. `(lambda ()
  9700. (let ((org-log-reschedule
  9701. (and org-log-reschedule 'time)))
  9702. (org-agenda-schedule arg ,time)))
  9703. `(lambda ()
  9704. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  9705. (org-agenda-deadline arg ,time)))))))
  9706. (?S
  9707. (unless (org-agenda-check-type nil 'agenda 'todo)
  9708. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  9709. (let ((days (read-number
  9710. (format "Scatter tasks across how many %sdays: "
  9711. (if arg "week" ""))
  9712. 7)))
  9713. (setq cmd
  9714. `(lambda ()
  9715. (let ((distance (1+ (random ,days))))
  9716. (when arg
  9717. (let ((dist distance)
  9718. (day-of-week
  9719. (calendar-day-of-week
  9720. (calendar-gregorian-from-absolute (org-today)))))
  9721. (dotimes (i (1+ dist))
  9722. (while (member day-of-week org-agenda-weekend-days)
  9723. (cl-incf distance)
  9724. (cl-incf day-of-week)
  9725. (when (= day-of-week 7)
  9726. (setq day-of-week 0)))
  9727. (cl-incf day-of-week)
  9728. (when (= day-of-week 7)
  9729. (setq day-of-week 0)))))
  9730. ;; Silently fail when try to replan a sexp entry.
  9731. (ignore-errors
  9732. (let* ((date (calendar-gregorian-from-absolute
  9733. (+ (org-today) distance)))
  9734. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  9735. (nth 2 date))))
  9736. (org-agenda-schedule nil time))))))))
  9737. (?f
  9738. (setq cmd
  9739. (intern
  9740. (completing-read "Function: " obarray #'fboundp t nil nil))))
  9741. (action
  9742. (pcase (assoc action org-agenda-bulk-custom-functions)
  9743. (`(,_ ,f) (setq cmd f) (setq redo-at-end t))
  9744. (_ (user-error "Invalid bulk action: %c" action)))))
  9745. ;; Sort the markers, to make sure that parents are handled
  9746. ;; before children.
  9747. (setq entries (sort entries
  9748. (lambda (a b)
  9749. (cond
  9750. ((eq (marker-buffer a) (marker-buffer b))
  9751. (< (marker-position a) (marker-position b)))
  9752. (t
  9753. (string< (buffer-name (marker-buffer a))
  9754. (buffer-name (marker-buffer b))))))))
  9755. ;; Now loop over all markers and apply CMD.
  9756. (let ((processed 0)
  9757. (skipped 0))
  9758. (dolist (e entries)
  9759. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  9760. (if (not pos)
  9761. (progn (message "Skipping removed entry at %s" e)
  9762. (cl-incf skipped))
  9763. (goto-char pos)
  9764. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  9765. ;; `post-command-hook' is not run yet. We make sure any
  9766. ;; pending log note is processed.
  9767. (when (or (memq 'org-add-log-note (default-value 'post-command-hook))
  9768. (memq 'org-add-log-note post-command-hook))
  9769. (org-add-log-note))
  9770. (cl-incf processed))))
  9771. (when redo-at-end (org-agenda-redo))
  9772. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  9773. (message "Acted on %d entries%s%s"
  9774. processed
  9775. (if (= skipped 0)
  9776. ""
  9777. (format ", skipped %d (disappeared before their turn)"
  9778. skipped))
  9779. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  9780. (defun org-agenda-capture (&optional with-time)
  9781. "Call `org-capture' with the date at point.
  9782. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  9783. current HH:MM time."
  9784. (interactive "P")
  9785. (if (not (eq major-mode 'org-agenda-mode))
  9786. (user-error "You cannot do this outside of agenda buffers")
  9787. (let ((org-overriding-default-time
  9788. (org-get-cursor-date (equal with-time 1))))
  9789. (call-interactively 'org-capture))))
  9790. ;;; Dragging agenda lines forward/backward
  9791. (defun org-agenda-reapply-filters ()
  9792. "Re-apply all agenda filters."
  9793. (mapcar
  9794. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  9795. `((,org-agenda-tag-filter tag)
  9796. (,org-agenda-category-filter category)
  9797. (,org-agenda-regexp-filter regexp)
  9798. (,org-agenda-effort-filter effort)
  9799. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  9800. (,(get 'org-agenda-category-filter :preset-filter) category)
  9801. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  9802. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  9803. (defun org-agenda-drag-line-forward (arg &optional backward)
  9804. "Drag an agenda line forward by ARG lines.
  9805. When the optional argument `backward' is non-nil, move backward."
  9806. (interactive "p")
  9807. (let ((inhibit-read-only t) lst line)
  9808. (if (or (not (get-text-property (point) 'txt))
  9809. (save-excursion
  9810. (dotimes (n arg)
  9811. (move-beginning-of-line (if backward 0 2))
  9812. (push (not (get-text-property (point) 'txt)) lst))
  9813. (delq nil lst)))
  9814. (message "Cannot move line forward")
  9815. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  9816. (move-beginning-of-line 1)
  9817. (setq line (buffer-substring (point) end))
  9818. (delete-region (point) end)
  9819. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  9820. (insert line)
  9821. (org-agenda-reapply-filters)
  9822. (org-agenda-mark-clocking-task)
  9823. (move-beginning-of-line 0)))))
  9824. (defun org-agenda-drag-line-backward (arg)
  9825. "Drag an agenda line backward by ARG lines."
  9826. (interactive "p")
  9827. (org-agenda-drag-line-forward arg t))
  9828. ;;; Flagging notes
  9829. (defun org-agenda-show-the-flagging-note ()
  9830. "Display the flagging note in the other window.
  9831. When called a second time in direct sequence, offer to remove the FLAGGING
  9832. tag and (if present) the flagging note."
  9833. (interactive)
  9834. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  9835. (win (selected-window))
  9836. note heading newhead)
  9837. (unless hdmarker
  9838. (user-error "No linked entry at point"))
  9839. (if (and (eq this-command last-command)
  9840. (y-or-n-p "Unflag and remove any flagging note? "))
  9841. (progn
  9842. (org-agenda-remove-flag hdmarker)
  9843. (let ((win (get-buffer-window "*Flagging Note*")))
  9844. (and win (delete-window win)))
  9845. (message "Entry unflagged"))
  9846. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  9847. (unless note
  9848. (user-error "No flagging note"))
  9849. (org-kill-new note)
  9850. (org-switch-to-buffer-other-window "*Flagging Note*")
  9851. (erase-buffer)
  9852. (insert note)
  9853. (goto-char (point-min))
  9854. (while (re-search-forward "\\\\n" nil t)
  9855. (replace-match "\n" t t))
  9856. (goto-char (point-min))
  9857. (select-window win)
  9858. (message "%s" (substitute-command-keys "Flagging note pushed to \
  9859. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  9860. tag and note")))))
  9861. (defun org-agenda-remove-flag (marker)
  9862. "Remove the FLAGGED tag and any flagging note in the entry."
  9863. (let (newhead)
  9864. (org-with-point-at marker
  9865. (org-toggle-tag "FLAGGED" 'off)
  9866. (org-entry-delete nil "THEFLAGGINGNOTE")
  9867. (setq newhead (org-get-heading)))
  9868. (org-agenda-change-all-lines newhead marker)
  9869. (message "Entry unflagged")))
  9870. (defun org-agenda-get-any-marker (&optional pos)
  9871. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  9872. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  9873. ;;; Appointment reminders
  9874. (defvar appt-time-msg-list) ; defined in appt.el
  9875. ;;;###autoload
  9876. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  9877. "Activate appointments found in `org-agenda-files'.
  9878. With a `\\[universal-argument]' prefix, refresh the list of \
  9879. appointments.
  9880. If FILTER is t, interactively prompt the user for a regular
  9881. expression, and filter out entries that don't match it.
  9882. If FILTER is a string, use this string as a regular expression
  9883. for filtering entries out.
  9884. If FILTER is a function, filter out entries against which
  9885. calling the function returns nil. This function takes one
  9886. argument: an entry from `org-agenda-get-day-entries'.
  9887. FILTER can also be an alist with the car of each cell being
  9888. either `headline' or `category'. For example:
  9889. \\='((headline \"IMPORTANT\")
  9890. (category \"Work\"))
  9891. will only add headlines containing IMPORTANT or headlines
  9892. belonging to the \"Work\" category.
  9893. ARGS are symbols indicating what kind of entries to consider.
  9894. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  9895. \(i.e., deadlines and scheduled items with a hh:mm specification)
  9896. and :timestamp entries. See the docstring of `org-diary' for
  9897. details and examples.
  9898. If an entry has a APPT_WARNTIME property, its value will be used
  9899. to override `appt-message-warning-time'."
  9900. (interactive "P")
  9901. (when refresh (setq appt-time-msg-list nil))
  9902. (when (eq filter t)
  9903. (setq filter (read-from-minibuffer "Regexp filter: ")))
  9904. (let* ((cnt 0) ; count added events
  9905. (scope (or args '(:deadline* :scheduled* :timestamp)))
  9906. (org-agenda-new-buffers nil)
  9907. (org-deadline-warning-days 0)
  9908. ;; Do not use `org-today' here because appt only takes
  9909. ;; time and without date as argument, so it may pass wrong
  9910. ;; information otherwise
  9911. (today (org-date-to-gregorian
  9912. (time-to-days nil)))
  9913. (org-agenda-restrict nil)
  9914. (files (org-agenda-files 'unrestricted)) entries file
  9915. (org-agenda-buffer nil))
  9916. ;; Get all entries which may contain an appt
  9917. (org-agenda-prepare-buffers files)
  9918. (while (setq file (pop files))
  9919. (setq entries
  9920. (delq nil
  9921. (append entries
  9922. (apply 'org-agenda-get-day-entries
  9923. file today scope)))))
  9924. ;; Map through entries and find if we should filter them out
  9925. (mapc
  9926. (lambda (x)
  9927. (let* ((evt (org-trim
  9928. (replace-regexp-in-string
  9929. org-link-bracket-re "\\2"
  9930. (or (get-text-property 1 'txt x) ""))))
  9931. (cat (get-text-property (1- (length x)) 'org-category x))
  9932. (tod (get-text-property 1 'time-of-day x))
  9933. (ok (or (null filter)
  9934. (and (stringp filter) (string-match filter evt))
  9935. (and (functionp filter) (funcall filter x))
  9936. (and (listp filter)
  9937. (let ((cat-filter (cadr (assq 'category filter)))
  9938. (evt-filter (cadr (assq 'headline filter))))
  9939. (or (and (stringp cat-filter)
  9940. (string-match cat-filter cat))
  9941. (and (stringp evt-filter)
  9942. (string-match evt-filter evt)))))))
  9943. (wrn (get-text-property 1 'warntime x)))
  9944. ;; FIXME: Shall we remove text-properties for the appt text?
  9945. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  9946. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  9947. (setq tod (concat "00" (number-to-string tod)))
  9948. (setq tod (when (string-match
  9949. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  9950. (concat (match-string 1 tod) ":"
  9951. (match-string 2 tod))))
  9952. (when (appt-add tod evt wrn)
  9953. (setq cnt (1+ cnt))))))
  9954. entries)
  9955. (org-release-buffers org-agenda-new-buffers)
  9956. (if (eq cnt 0)
  9957. (message "No event to add")
  9958. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  9959. (defun org-agenda-today-p (date)
  9960. "Non-nil when DATE means today.
  9961. DATE is either a list of the form (month day year) or a number of
  9962. days as returned by `calendar-absolute-from-gregorian' or
  9963. `org-today'. This function considers `org-extend-today-until'
  9964. when defining today."
  9965. (eq (org-today)
  9966. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  9967. (defun org-agenda-todo-yesterday (&optional arg)
  9968. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  9969. (interactive "P")
  9970. (let* ((org-use-effective-time t)
  9971. (hour (nth 2 (decode-time (org-current-time))))
  9972. (org-extend-today-until (1+ hour)))
  9973. (org-agenda-todo arg)))
  9974. (defun org-agenda-ctrl-c-ctrl-c ()
  9975. "Set tags in agenda buffer."
  9976. (interactive)
  9977. (org-agenda-set-tags))
  9978. (provide 'org-agenda)
  9979. ;;; org-agenda.el ends here