org-agenda.el 396 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2019 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. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  48. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  49. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  50. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  51. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-french-date-string "cal-french" (&optional date))
  54. (declare-function calendar-goto-date "cal-move" (date))
  55. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  56. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  57. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  58. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  59. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  60. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  61. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  62. (declare-function calendar-check-holidays "holidays" (date))
  63. (declare-function org-columns-remove-overlays "org-colview" ())
  64. (declare-function org-datetree-find-date-create "org-datetree"
  65. (date &optional keep-restriction))
  66. (declare-function org-columns-quit "org-colview" ())
  67. (declare-function diary-date-display-form "diary-lib" (&optional type))
  68. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  69. (declare-function org-habit-insert-consistency-graphs
  70. "org-habit" (&optional line))
  71. (declare-function org-is-habit-p "org-habit" (&optional pom))
  72. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  73. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  74. (declare-function org-agenda-columns "org-colview" ())
  75. (declare-function org-add-archive-files "org-archive" (files))
  76. (declare-function org-capture "org-capture" (&optional goto keys))
  77. (defvar calendar-mode-map)
  78. (defvar org-clock-current-task)
  79. (defvar org-current-tag-alist)
  80. (defvar org-mobile-force-id-on-agenda-items)
  81. (defvar org-habit-show-habits)
  82. (defvar org-habit-show-habits-only-for-today)
  83. (defvar org-habit-show-all-today)
  84. (defvar org-habit-scheduled-past-days)
  85. ;; Defined somewhere in this file, but used before definition.
  86. (defvar org-agenda-buffer-name "*Org Agenda*")
  87. (defvar org-agenda-overriding-header nil)
  88. (defvar org-agenda-title-append nil)
  89. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  90. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  91. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  92. (defvar org-agenda-undo-list nil
  93. "List of undoable operations in the agenda since last refresh.")
  94. (defvar org-agenda-pending-undo-list nil
  95. "In a series of undo commands, this is the list of remaining undo items.")
  96. (defcustom org-agenda-confirm-kill 1
  97. "When set, remote killing from the agenda buffer needs confirmation.
  98. When t, a confirmation is always needed. When a number N, confirmation is
  99. only needed when the text to be killed contains more than N non-white lines."
  100. :group 'org-agenda
  101. :type '(choice
  102. (const :tag "Never" nil)
  103. (const :tag "Always" t)
  104. (integer :tag "When more than N lines")))
  105. (defcustom org-agenda-compact-blocks nil
  106. "Non-nil means make the block agenda more compact.
  107. This is done globally by leaving out lines like the agenda span
  108. name and week number or the separator lines."
  109. :group 'org-agenda
  110. :type 'boolean)
  111. (defcustom org-agenda-block-separator ?=
  112. "The separator between blocks in the agenda.
  113. If this is a string, it will be used as the separator, with a newline added.
  114. If it is a character, it will be repeated to fill the window width.
  115. If nil the separator is disabled. In `org-agenda-custom-commands' this
  116. addresses the separator between the current and the previous block."
  117. :group 'org-agenda
  118. :type '(choice
  119. (const :tag "Disabled" nil)
  120. (character)
  121. (string)))
  122. (defgroup org-agenda-export nil
  123. "Options concerning exporting agenda views in Org mode."
  124. :tag "Org Agenda Export"
  125. :group 'org-agenda)
  126. (defcustom org-agenda-with-colors t
  127. "Non-nil means use colors in agenda views."
  128. :group 'org-agenda-export
  129. :type 'boolean)
  130. (defcustom org-agenda-exporter-settings nil
  131. "Alist of variable/value pairs that should be active during agenda export.
  132. This is a good place to set options for ps-print and for htmlize.
  133. Note that the way this is implemented, the values will be evaluated
  134. before assigned to the variables. So make sure to quote values you do
  135. *not* want evaluated, for example
  136. (setq org-agenda-exporter-settings
  137. \\='((ps-print-color-p \\='black-white)))"
  138. :group 'org-agenda-export
  139. :type '(repeat
  140. (list
  141. (variable)
  142. (sexp :tag "Value"))))
  143. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  144. "Hook run in a temporary buffer before writing the agenda to an export file.
  145. A useful function for this hook is `org-agenda-add-entry-text'."
  146. :group 'org-agenda-export
  147. :type 'hook
  148. :options '(org-agenda-add-entry-text))
  149. (defcustom org-agenda-add-entry-text-maxlines 0
  150. "Maximum number of entry text lines to be added to agenda.
  151. This is only relevant when `org-agenda-add-entry-text' is part of
  152. `org-agenda-before-write-hook', which is the default.
  153. When this is 0, nothing will happen. When it is greater than 0, it
  154. specifies the maximum number of lines that will be added for each entry
  155. that is listed in the agenda view.
  156. Note that this variable is not used during display, only when exporting
  157. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  158. and `org-agenda-entry-text-maxlines'."
  159. :group 'org-agenda
  160. :type 'integer)
  161. (defcustom org-agenda-add-entry-text-descriptive-links t
  162. "Non-nil means export org-links as descriptive links in agenda added text.
  163. This variable applies to the text added to the agenda when
  164. `org-agenda-add-entry-text-maxlines' is larger than 0.
  165. When this variable nil, the URL will (also) be shown."
  166. :group 'org-agenda
  167. :type 'boolean)
  168. (defcustom org-agenda-export-html-style nil
  169. "The style specification for exported HTML Agenda files.
  170. If this variable contains a string, it will replace the default <style>
  171. section as produced by `htmlize'.
  172. Since there are different ways of setting style information, this variable
  173. needs to contain the full HTML structure to provide a style, including the
  174. surrounding HTML tags. The style specifications should include definitions
  175. the fonts used by the agenda, here is an example:
  176. <style type=\"text/css\">
  177. p { font-weight: normal; color: gray; }
  178. .org-agenda-structure {
  179. font-size: 110%;
  180. color: #003399;
  181. font-weight: 600;
  182. }
  183. .org-todo {
  184. color: #cc6666;
  185. font-weight: bold;
  186. }
  187. .org-agenda-done {
  188. color: #339933;
  189. }
  190. .org-done {
  191. color: #339933;
  192. }
  193. .title { text-align: center; }
  194. .todo, .deadline { color: red; }
  195. .done { color: green; }
  196. </style>
  197. or, if you want to keep the style in a file,
  198. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  199. As the value of this option simply gets inserted into the HTML <head> header,
  200. you can \"misuse\" it to also add other text to the header."
  201. :group 'org-agenda-export
  202. :group 'org-export-html
  203. :type '(choice
  204. (const nil)
  205. (string)))
  206. (defcustom org-agenda-persistent-filter nil
  207. "When set, keep filters from one agenda view to the next."
  208. :group 'org-agenda
  209. :type 'boolean)
  210. (defgroup org-agenda-custom-commands nil
  211. "Options concerning agenda views in Org mode."
  212. :tag "Org Agenda Custom Commands"
  213. :group 'org-agenda)
  214. (defconst org-sorting-choice
  215. '(choice
  216. (const time-up) (const time-down)
  217. (const timestamp-up) (const timestamp-down)
  218. (const scheduled-up) (const scheduled-down)
  219. (const deadline-up) (const deadline-down)
  220. (const ts-up) (const ts-down)
  221. (const tsia-up) (const tsia-down)
  222. (const category-keep) (const category-up) (const category-down)
  223. (const tag-down) (const tag-up)
  224. (const priority-up) (const priority-down)
  225. (const todo-state-up) (const todo-state-down)
  226. (const effort-up) (const effort-down)
  227. (const habit-up) (const habit-down)
  228. (const alpha-up) (const alpha-down)
  229. (const user-defined-up) (const user-defined-down))
  230. "Sorting choices.")
  231. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  232. ;; the new variable `org-agenda-tag-filter-preset'.
  233. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  234. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  235. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  236. "List of types searched for when creating the daily/weekly agenda.
  237. This variable is a list of symbols that controls the types of
  238. items that appear in the daily/weekly agenda. Allowed symbols in this
  239. list are are
  240. :timestamp List items containing a date stamp or date range matching
  241. the selected date. This includes sexp entries in angular
  242. brackets.
  243. :sexp List entries resulting from plain diary-like sexps.
  244. :deadline List deadline due on that date. When the date is today,
  245. also list any deadlines past due, or due within
  246. `org-deadline-warning-days'.
  247. :deadline* Same as above, but only include the deadline if it has an
  248. hour specification as [h]h:mm.
  249. :scheduled List all items which are scheduled for the given date.
  250. The diary for *today* also contains items which were
  251. scheduled earlier and are not yet marked DONE.
  252. :scheduled* Same as above, but only include the scheduled item if it
  253. has an hour specification as [h]h:mm.
  254. By default, all four non-starred types are turned on.
  255. When :scheduled* or :deadline* are included, :schedule or :deadline
  256. will be ignored.
  257. Never set this variable globally using `setq', because then it
  258. will apply to all future agenda commands. Instead, bind it with
  259. `let' to scope it dynamically into the agenda-constructing
  260. command. A good way to set it is through options in
  261. `org-agenda-custom-commands'. For a more flexible (though
  262. somewhat less efficient) way of determining what is included in
  263. the daily/weekly agenda, see `org-agenda-skip-function'.")
  264. (defconst org-agenda-custom-commands-local-options
  265. `(repeat :tag "Local settings for this command. Remember to quote values"
  266. (choice :tag "Setting"
  267. (list :tag "Heading for this block"
  268. (const org-agenda-overriding-header)
  269. (string :tag "Headline"))
  270. (list :tag "Files to be searched"
  271. (const org-agenda-files)
  272. (list
  273. (const :format "" quote)
  274. (repeat (file))))
  275. (list :tag "Sorting strategy"
  276. (const org-agenda-sorting-strategy)
  277. (list
  278. (const :format "" quote)
  279. (repeat
  280. ,org-sorting-choice)))
  281. (list :tag "Prefix format"
  282. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  283. (string))
  284. (list :tag "Number of days in agenda"
  285. (const org-agenda-span)
  286. (list
  287. (const :format "" quote)
  288. (choice (const :tag "Day" day)
  289. (const :tag "Week" week)
  290. (const :tag "Fortnight" fortnight)
  291. (const :tag "Month" month)
  292. (const :tag "Year" year)
  293. (integer :tag "Custom"))))
  294. (list :tag "Fixed starting date"
  295. (const org-agenda-start-day)
  296. (string :value "2007-11-01"))
  297. (list :tag "Start on day of week"
  298. (const org-agenda-start-on-weekday)
  299. (choice :value 1
  300. (const :tag "Today" nil)
  301. (integer :tag "Weekday No.")))
  302. (list :tag "Include data from diary"
  303. (const org-agenda-include-diary)
  304. (boolean))
  305. (list :tag "Deadline Warning days"
  306. (const org-deadline-warning-days)
  307. (integer :value 1))
  308. (list :tag "Category filter preset"
  309. (const org-agenda-category-filter-preset)
  310. (list
  311. (const :format "" quote)
  312. (repeat
  313. (string :tag "+category or -category"))))
  314. (list :tag "Tags filter preset"
  315. (const org-agenda-tag-filter-preset)
  316. (list
  317. (const :format "" quote)
  318. (repeat
  319. (string :tag "+tag or -tag"))))
  320. (list :tag "Effort filter preset"
  321. (const org-agenda-effort-filter-preset)
  322. (list
  323. (const :format "" quote)
  324. (repeat
  325. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  326. (list :tag "Regexp filter preset"
  327. (const org-agenda-regexp-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+regexp or -regexp"))))
  332. (list :tag "Set daily/weekly entry types"
  333. (const org-agenda-entry-types)
  334. (list
  335. (const :format "" quote)
  336. (set :greedy t :value ,org-agenda-entry-types
  337. (const :deadline)
  338. (const :scheduled)
  339. (const :deadline*)
  340. (const :scheduled*)
  341. (const :timestamp)
  342. (const :sexp))))
  343. (list :tag "Standard skipping condition"
  344. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  345. (const org-agenda-skip-function)
  346. (list
  347. (const :format "" quote)
  348. (list
  349. (choice
  350. :tag "Skipping range"
  351. (const :tag "Skip entry" org-agenda-skip-entry-if)
  352. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  353. (repeat :inline t :tag "Conditions for skipping"
  354. (choice
  355. :tag "Condition type"
  356. (list :tag "Regexp matches" :inline t
  357. (const :format "" regexp)
  358. (regexp))
  359. (list :tag "Regexp does not match" :inline t
  360. (const :format "" notregexp)
  361. (regexp))
  362. (list :tag "TODO state is" :inline t
  363. (const todo)
  364. (choice
  365. (const :tag "Any not-done state" todo)
  366. (const :tag "Any done state" done)
  367. (const :tag "Any state" any)
  368. (list :tag "Keyword list"
  369. (const :format "" quote)
  370. (repeat (string :tag "Keyword")))))
  371. (list :tag "TODO state is not" :inline t
  372. (const nottodo)
  373. (choice
  374. (const :tag "Any not-done state" todo)
  375. (const :tag "Any done state" done)
  376. (const :tag "Any state" any)
  377. (list :tag "Keyword list"
  378. (const :format "" quote)
  379. (repeat (string :tag "Keyword")))))
  380. (const :tag "scheduled" scheduled)
  381. (const :tag "not scheduled" notscheduled)
  382. (const :tag "deadline" deadline)
  383. (const :tag "no deadline" notdeadline)
  384. (const :tag "timestamp" timestamp)
  385. (const :tag "no timestamp" nottimestamp))))))
  386. (list :tag "Non-standard skipping condition"
  387. :value (org-agenda-skip-function)
  388. (const org-agenda-skip-function)
  389. (sexp :tag "Function or form (quoted!)"))
  390. (list :tag "Any variable"
  391. (variable :tag "Variable")
  392. (sexp :tag "Value (sexp)"))))
  393. "Selection of examples for agenda command settings.
  394. This will be spliced into the custom type of
  395. `org-agenda-custom-commands'.")
  396. (defcustom org-agenda-custom-commands
  397. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  398. "Custom commands for the agenda.
  399. \\<org-mode-map>
  400. These commands will be offered on the splash screen displayed by the
  401. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  402. (key desc type match settings files)
  403. key The key (one or more characters as a string) to be associated
  404. with the command.
  405. desc A description of the command, when omitted or nil, a default
  406. description is built using MATCH.
  407. type The command type, any of the following symbols:
  408. agenda The daily/weekly agenda.
  409. todo Entries with a specific TODO keyword, in all agenda files.
  410. search Entries containing search words entry or headline.
  411. tags Tags/Property/TODO match in all agenda files.
  412. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  413. todo-tree Sparse tree of specific TODO keyword in *current* file.
  414. tags-tree Sparse tree with all tags matches in *current* file.
  415. occur-tree Occur sparse tree for *current* file.
  416. ... A user-defined function.
  417. match What to search for:
  418. - a single keyword for TODO keyword searches
  419. - a tags match expression for tags searches
  420. - a word search expression for text searches.
  421. - a regular expression for occur searches
  422. For all other commands, this should be the empty string.
  423. settings A list of option settings, similar to that in a let form, so like
  424. this: ((opt1 val1) (opt2 val2) ...). The values will be
  425. evaluated at the moment of execution, so quote them when needed.
  426. files A list of files to write the produced agenda buffer to with
  427. the command `org-store-agenda-views'.
  428. If a file name ends in \".html\", an HTML version of the buffer
  429. is written out. If it ends in \".ps\", a postscript version is
  430. produced. Otherwise, only the plain text is written to the file.
  431. You can also define a set of commands, to create a composite agenda buffer.
  432. In this case, an entry looks like this:
  433. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  434. where
  435. desc A description string to be displayed in the dispatcher menu.
  436. cmd An agenda command, similar to the above. However, tree commands
  437. are not allowed, but instead you can get agenda and global todo list.
  438. So valid commands for a set are:
  439. (agenda \"\" settings)
  440. (alltodo \"\" settings)
  441. (stuck \"\" settings)
  442. (todo \"match\" settings files)
  443. (search \"match\" settings files)
  444. (tags \"match\" settings files)
  445. (tags-todo \"match\" settings files)
  446. Each command can carry a list of options, and another set of options can be
  447. given for the whole set of commands. Individual command options take
  448. precedence over the general options.
  449. When using several characters as key to a command, the first characters
  450. are prefix commands. For the dispatcher to display useful information, you
  451. should provide a description for the prefix, like
  452. (setq org-agenda-custom-commands
  453. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  454. (\"hl\" tags \"+HOME+Lisa\")
  455. (\"hp\" tags \"+HOME+Peter\")
  456. (\"hk\" tags \"+HOME+Kim\")))"
  457. :group 'org-agenda-custom-commands
  458. :type `(repeat
  459. (choice :value ("x" "Describe command here" tags "" nil)
  460. (list :tag "Single command"
  461. (string :tag "Access Key(s) ")
  462. (option (string :tag "Description"))
  463. (choice
  464. (const :tag "Agenda" agenda)
  465. (const :tag "TODO list" alltodo)
  466. (const :tag "Search words" search)
  467. (const :tag "Stuck projects" stuck)
  468. (const :tag "Tags/Property match (all agenda files)" tags)
  469. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  470. (const :tag "TODO keyword search (all agenda files)" todo)
  471. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  472. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  473. (const :tag "Occur tree (current buffer)" occur-tree)
  474. (sexp :tag "Other, user-defined function"))
  475. (string :tag "Match (only for some commands)")
  476. ,org-agenda-custom-commands-local-options
  477. (option (repeat :tag "Export" (file :tag "Export to"))))
  478. (list :tag "Command series, all agenda files"
  479. (string :tag "Access Key(s)")
  480. (string :tag "Description ")
  481. (repeat :tag "Component"
  482. (choice
  483. (list :tag "Agenda"
  484. (const :format "" agenda)
  485. (const :tag "" :format "" "")
  486. ,org-agenda-custom-commands-local-options)
  487. (list :tag "TODO list (all keywords)"
  488. (const :format "" alltodo)
  489. (const :tag "" :format "" "")
  490. ,org-agenda-custom-commands-local-options)
  491. (list :tag "Search words"
  492. (const :format "" search)
  493. (string :tag "Match")
  494. ,org-agenda-custom-commands-local-options)
  495. (list :tag "Stuck projects"
  496. (const :format "" stuck)
  497. (const :tag "" :format "" "")
  498. ,org-agenda-custom-commands-local-options)
  499. (list :tag "Tags search"
  500. (const :format "" tags)
  501. (string :tag "Match")
  502. ,org-agenda-custom-commands-local-options)
  503. (list :tag "Tags search, TODO entries only"
  504. (const :format "" tags-todo)
  505. (string :tag "Match")
  506. ,org-agenda-custom-commands-local-options)
  507. (list :tag "TODO keyword search"
  508. (const :format "" todo)
  509. (string :tag "Match")
  510. ,org-agenda-custom-commands-local-options)
  511. (list :tag "Other, user-defined function"
  512. (symbol :tag "function")
  513. (string :tag "Match")
  514. ,org-agenda-custom-commands-local-options)))
  515. (repeat :tag "Settings for entire command set"
  516. (list (variable :tag "Any variable")
  517. (sexp :tag "Value")))
  518. (option (repeat :tag "Export" (file :tag "Export to"))))
  519. (cons :tag "Prefix key documentation"
  520. (string :tag "Access Key(s)")
  521. (string :tag "Description ")))))
  522. (defcustom org-agenda-query-register ?o
  523. "The register holding the current query string.
  524. The purpose of this is that if you construct a query string interactively,
  525. you can then use it to define a custom command."
  526. :group 'org-agenda-custom-commands
  527. :type 'character)
  528. (defcustom org-stuck-projects
  529. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  530. "How to identify stuck projects.
  531. This is a list of four items:
  532. 1. A tags/todo/property matcher string that is used to identify a project.
  533. See the manual for a description of tag and property searches.
  534. The entire tree below a headline matched by this is considered one project.
  535. 2. A list of TODO keywords identifying non-stuck projects.
  536. If the project subtree contains any headline with one of these todo
  537. keywords, the project is considered to be not stuck. If you specify
  538. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  539. 3. A list of tags identifying non-stuck projects.
  540. If the project subtree contains any headline with one of these tags,
  541. the project is considered to be not stuck. If you specify \"*\" as
  542. a tag, any tag will mark the project unstuck. Note that this is about
  543. the explicit presence of a tag somewhere in the subtree, inherited
  544. tags do not count here. If inherited tags make a project not stuck,
  545. use \"-TAG\" in the tags part of the matcher under (1.) above.
  546. 4. An arbitrary regular expression matching non-stuck projects.
  547. If the project turns out to be not stuck, search continues also in the
  548. subtree to see if any of the subtasks have project status.
  549. See also the variable `org-tags-match-list-sublevels' which applies
  550. to projects matched by this search as well.
  551. After defining this variable, you may use `org-agenda-list-stuck-projects'
  552. \(bound to `\\[org-agenda] #') to produce the list."
  553. :group 'org-agenda-custom-commands
  554. :type '(list
  555. (string :tag "Tags/TODO match to identify a project")
  556. (repeat :tag "Projects are *not* stuck if they have an entry with \
  557. TODO keyword any of" (string))
  558. (repeat :tag "Projects are *not* stuck if they have an entry with \
  559. TAG being any of" (string))
  560. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  561. the subtree")))
  562. (defgroup org-agenda-skip nil
  563. "Options concerning skipping parts of agenda files."
  564. :tag "Org Agenda Skip"
  565. :group 'org-agenda)
  566. (defcustom org-agenda-skip-function-global nil
  567. "Function to be called at each match during agenda construction.
  568. If this function returns nil, the current match should not be skipped.
  569. If the function decided to skip an agenda match, is must return the
  570. buffer position from which the search should be continued.
  571. This may also be a Lisp form, which will be evaluated.
  572. This variable will be applied to every agenda match, including
  573. tags/property searches and TODO lists. So try to make the test function
  574. do its checking as efficiently as possible. To implement a skipping
  575. condition just for specific agenda commands, use the variable
  576. `org-agenda-skip-function' which can be set in the options section
  577. of custom agenda commands."
  578. :group 'org-agenda-skip
  579. :type 'sexp)
  580. (defgroup org-agenda-daily/weekly nil
  581. "Options concerning the daily/weekly agenda."
  582. :tag "Org Agenda Daily/Weekly"
  583. :group 'org-agenda)
  584. (defgroup org-agenda-todo-list nil
  585. "Options concerning the global todo list agenda view."
  586. :tag "Org Agenda Todo List"
  587. :group 'org-agenda)
  588. (defgroup org-agenda-match-view nil
  589. "Options concerning the general tags/property/todo match agenda view."
  590. :tag "Org Agenda Match View"
  591. :group 'org-agenda)
  592. (defgroup org-agenda-search-view nil
  593. "Options concerning the search agenda view."
  594. :tag "Org Agenda Search View"
  595. :group 'org-agenda)
  596. (defvar org-agenda-archives-mode nil
  597. "Non-nil means the agenda will include archived items.
  598. If this is the symbol `trees', trees in the selected agenda scope
  599. that are marked with the ARCHIVE tag will be included anyway. When this is
  600. t, also all archive files associated with the current selection of agenda
  601. files will be included.")
  602. (defcustom org-agenda-restriction-lock-highlight-subtree t
  603. "Non-nil means highlight the whole subtree when restriction is active.
  604. Otherwise only highlight the headline. Highlighting the whole subtree is
  605. useful to ensure no edits happen beyond the restricted region."
  606. :group 'org-agenda
  607. :type 'boolean)
  608. (defcustom org-agenda-skip-comment-trees t
  609. "Non-nil means skip trees that start with the COMMENT keyword.
  610. When nil, these trees are also scanned by agenda commands."
  611. :group 'org-agenda-skip
  612. :type 'boolean)
  613. (defcustom org-agenda-todo-list-sublevels t
  614. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  615. When nil, the sublevels of a TODO entry are not checked, resulting in
  616. potentially much shorter TODO lists."
  617. :group 'org-agenda-skip
  618. :group 'org-agenda-todo-list
  619. :type 'boolean)
  620. (defcustom org-agenda-todo-ignore-with-date nil
  621. "Non-nil means don't show entries with a date in the global todo list.
  622. You can use this if you prefer to mark mere appointments with a TODO keyword,
  623. but don't want them to show up in the TODO list.
  624. When this is set, it also covers deadlines and scheduled items, the settings
  625. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  626. will be ignored.
  627. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  628. :group 'org-agenda-skip
  629. :group 'org-agenda-todo-list
  630. :type 'boolean)
  631. (defcustom org-agenda-todo-ignore-timestamp nil
  632. "Non-nil means don't show entries with a timestamp.
  633. This applies when creating the global todo list.
  634. Valid values are:
  635. past Don't show entries for today or in the past.
  636. future Don't show entries with a timestamp in the future.
  637. The idea behind this is that if it has a future
  638. timestamp, you don't want to think about it until the
  639. date.
  640. all Don't show any entries with a timestamp in the global todo list.
  641. The idea behind this is that by setting a timestamp, you
  642. have already \"taken care\" of this item.
  643. This variable can also have an integer as a value. If positive (N),
  644. todos with a timestamp N or more days in the future will be ignored. If
  645. negative (-N), todos with a timestamp N or more days in the past will be
  646. ignored. If 0, todos with a timestamp either today or in the future will
  647. be ignored. For example, a value of -1 will exclude todos with a
  648. timestamp in the past (yesterday or earlier), while a value of 7 will
  649. exclude todos with a timestamp a week or more in the future.
  650. See also `org-agenda-todo-ignore-with-date'.
  651. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  652. to make his option also apply to the tags-todo list."
  653. :group 'org-agenda-skip
  654. :group 'org-agenda-todo-list
  655. :version "24.1"
  656. :type '(choice
  657. (const :tag "Ignore future timestamp todos" future)
  658. (const :tag "Ignore past or present timestamp todos" past)
  659. (const :tag "Ignore all timestamp todos" all)
  660. (const :tag "Show timestamp todos" nil)
  661. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  662. (defcustom org-agenda-todo-ignore-scheduled nil
  663. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  664. This applies when creating the global todo list.
  665. Valid values are:
  666. past Don't show entries scheduled today or in the past.
  667. future Don't show entries scheduled in the future.
  668. The idea behind this is that by scheduling it, you don't want to
  669. think about it until the scheduled date.
  670. all Don't show any scheduled entries in the global todo list.
  671. The idea behind this is that by scheduling it, you have already
  672. \"taken care\" of this item.
  673. t Same as `all', for backward compatibility.
  674. This variable can also have an integer as a value. See
  675. `org-agenda-todo-ignore-timestamp' for more details.
  676. See also `org-agenda-todo-ignore-with-date'.
  677. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  678. to make his option also apply to the tags-todo list."
  679. :group 'org-agenda-skip
  680. :group 'org-agenda-todo-list
  681. :type '(choice
  682. (const :tag "Ignore future-scheduled todos" future)
  683. (const :tag "Ignore past- or present-scheduled todos" past)
  684. (const :tag "Ignore all scheduled todos" all)
  685. (const :tag "Ignore all scheduled todos (compatibility)" t)
  686. (const :tag "Show scheduled todos" nil)
  687. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  688. (defcustom org-agenda-todo-ignore-deadlines nil
  689. "Non-nil means ignore some deadline TODO items when making TODO list.
  690. There are different motivations for using different values, please think
  691. carefully when configuring this variable.
  692. This applies when creating the global TODO list.
  693. Valid values are:
  694. near Don't show near deadline entries. A deadline is near when it is
  695. closer than `org-deadline-warning-days' days. The idea behind this
  696. is that such items will appear in the agenda anyway.
  697. far Don't show TODO entries where a deadline has been defined, but
  698. is not going to happen anytime soon. This is useful if you want to use
  699. the TODO list to figure out what to do now.
  700. past Don't show entries with a deadline timestamp for today or in the past.
  701. future Don't show entries with a deadline timestamp in the future, not even
  702. when they become `near' ones. Use it with caution.
  703. all Ignore all TODO entries that do have a deadline.
  704. t Same as `near', for backward compatibility.
  705. This variable can also have an integer as a value. See
  706. `org-agenda-todo-ignore-timestamp' for more details.
  707. See also `org-agenda-todo-ignore-with-date'.
  708. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  709. to make his option also apply to the tags-todo list."
  710. :group 'org-agenda-skip
  711. :group 'org-agenda-todo-list
  712. :type '(choice
  713. (const :tag "Ignore near deadlines" near)
  714. (const :tag "Ignore near deadlines (compatibility)" t)
  715. (const :tag "Ignore far deadlines" far)
  716. (const :tag "Ignore all TODOs with a deadlines" all)
  717. (const :tag "Show all TODOs, even if they have a deadline" nil)
  718. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  719. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  720. "Time unit to use when possibly ignoring an agenda item.
  721. See the docstring of various `org-agenda-todo-ignore-*' options.
  722. The default is to compare time stamps using days. An item is thus
  723. considered to be in the future if it is at least one day after today.
  724. Non-nil means to compare time stamps using seconds. An item is then
  725. considered future if it has a time value later than current time."
  726. :group 'org-agenda-skip
  727. :group 'org-agenda-todo-list
  728. :version "24.4"
  729. :package-version '(Org . "8.0")
  730. :type '(choice
  731. (const :tag "Compare time with days" nil)
  732. (const :tag "Compare time with seconds" t)))
  733. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  734. "Non-nil means honor todo-list ignores options also in tags-todo search.
  735. The variables
  736. `org-agenda-todo-ignore-with-date',
  737. `org-agenda-todo-ignore-timestamp',
  738. `org-agenda-todo-ignore-scheduled',
  739. `org-agenda-todo-ignore-deadlines'
  740. make the global TODO list skip entries that have time stamps of certain
  741. kinds. If this option is set, the same options will also apply for the
  742. tags-todo search, which is the general tags/property matcher
  743. restricted to unfinished TODO entries only."
  744. :group 'org-agenda-skip
  745. :group 'org-agenda-todo-list
  746. :group 'org-agenda-match-view
  747. :type 'boolean)
  748. (defcustom org-agenda-skip-scheduled-if-done nil
  749. "Non-nil means don't show scheduled items in agenda when they are done.
  750. This is relevant for the daily/weekly agenda, not for the TODO list. It
  751. applies only to the actual date of the scheduling. Warnings about an item
  752. with a past scheduling dates are always turned off when the item is DONE."
  753. :group 'org-agenda-skip
  754. :group 'org-agenda-daily/weekly
  755. :type 'boolean)
  756. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  757. "Non-nil means skip scheduling line if same entry shows because of deadline.
  758. In the agenda of today, an entry can show up multiple times
  759. because it is both scheduled and has a nearby deadline, and maybe
  760. a plain time stamp as well.
  761. When this variable is nil, the entry will be shown several times.
  762. When set to t, then only the deadline is shown and the fact that
  763. the entry is scheduled today or was scheduled previously is not
  764. shown.
  765. When set to the symbol `not-today', skip scheduled previously,
  766. but not scheduled today.
  767. When set to the symbol `repeated-after-deadline', skip scheduled
  768. items if they are repeated beyond the current deadline."
  769. :group 'org-agenda-skip
  770. :group 'org-agenda-daily/weekly
  771. :type '(choice
  772. (const :tag "Never" nil)
  773. (const :tag "Always" t)
  774. (const :tag "Not when scheduled today" not-today)
  775. (const :tag "When repeated past deadline" repeated-after-deadline)))
  776. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  777. "Non-nil means skip timestamp line if same entry shows because of deadline.
  778. In the agenda of today, an entry can show up multiple times
  779. because it has both a plain timestamp and has a nearby deadline.
  780. When this variable is t, then only the deadline is shown and the
  781. fact that the entry has a timestamp for or including today is not
  782. shown. When this variable is nil, the entry will be shown
  783. several times."
  784. :group 'org-agenda-skip
  785. :group 'org-agenda-daily/weekly
  786. :version "24.1"
  787. :type '(choice
  788. (const :tag "Never" nil)
  789. (const :tag "Always" t)))
  790. (defcustom org-agenda-skip-deadline-if-done nil
  791. "Non-nil means don't show deadlines when the corresponding item is done.
  792. When nil, the deadline is still shown and should give you a happy feeling.
  793. This is relevant for the daily/weekly agenda. It applies only to the
  794. actual date of the deadline. Warnings about approaching and past-due
  795. deadlines are always turned off when the item is DONE."
  796. :group 'org-agenda-skip
  797. :group 'org-agenda-daily/weekly
  798. :type 'boolean)
  799. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  800. "Non-nil means skip deadline prewarning when entry is also scheduled.
  801. This will apply on all days where a prewarning for the deadline would
  802. be shown, but not at the day when the entry is actually due. On that day,
  803. the deadline will be shown anyway.
  804. This variable may be set to nil, t, the symbol `pre-scheduled',
  805. or a number which will then give the number of days before the actual
  806. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  807. eliminates the deadline prewarning only prior to the scheduled date.
  808. This can be used in a workflow where the first showing of the deadline will
  809. trigger you to schedule it, and then you don't want to be reminded of it
  810. because you will take care of it on the day when scheduled."
  811. :group 'org-agenda-skip
  812. :group 'org-agenda-daily/weekly
  813. :version "24.1"
  814. :type '(choice
  815. (const :tag "Always show prewarning" nil)
  816. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  817. (const :tag "Remove prewarning if entry is scheduled" t)
  818. (integer :tag "Restart prewarning N days before deadline")))
  819. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  820. "Non-nil means skip scheduled delay when entry also has a deadline.
  821. This variable may be set to nil, t, the symbol `post-deadline',
  822. or a number which will then give the number of days after the actual
  823. scheduled date when the delay should expire. The symbol `post-deadline'
  824. eliminates the schedule delay when the date is posterior to the deadline."
  825. :group 'org-agenda-skip
  826. :group 'org-agenda-daily/weekly
  827. :version "24.4"
  828. :package-version '(Org . "8.0")
  829. :type '(choice
  830. (const :tag "Always honor delay" nil)
  831. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  832. (const :tag "Ignore delay if entry has a deadline" t)
  833. (integer :tag "Honor delay up until N days after the scheduled date")))
  834. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  835. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  836. When non-nil, after the search for timestamps has matched once in an
  837. entry, the rest of the entry will not be searched."
  838. :group 'org-agenda-skip
  839. :type 'boolean)
  840. (defcustom org-agenda-skip-timestamp-if-done nil
  841. "Non-nil means don't select item by timestamp or -range if it is DONE."
  842. :group 'org-agenda-skip
  843. :group 'org-agenda-daily/weekly
  844. :type 'boolean)
  845. (defcustom org-agenda-dim-blocked-tasks t
  846. "Non-nil means dim blocked tasks in the agenda display.
  847. This causes some overhead during agenda construction, but if you
  848. have turned on `org-enforce-todo-dependencies',
  849. `org-enforce-todo-checkbox-dependencies', or any other blocking
  850. mechanism, this will create useful feedback in the agenda.
  851. Instead of t, this variable can also have the value `invisible'.
  852. Then blocked tasks will be invisible and only become visible when
  853. they become unblocked. An exemption to this behavior is when a task is
  854. blocked because of unchecked checkboxes below it. Since checkboxes do
  855. not show up in the agenda views, making this task invisible you remove any
  856. trace from agenda views that there is something to do. Therefore, a task
  857. that is blocked because of checkboxes will never be made invisible, it
  858. will only be dimmed."
  859. :group 'org-agenda-daily/weekly
  860. :group 'org-agenda-todo-list
  861. :version "24.3"
  862. :type '(choice
  863. (const :tag "Do not dim" nil)
  864. (const :tag "Dim to a gray face" t)
  865. (const :tag "Make invisible" invisible)))
  866. (defgroup org-agenda-startup nil
  867. "Options concerning initial settings in the Agenda in Org Mode."
  868. :tag "Org Agenda Startup"
  869. :group 'org-agenda)
  870. (defcustom org-agenda-menu-show-matcher t
  871. "Non-nil means show the match string in the agenda dispatcher menu.
  872. When nil, the matcher string is not shown, but is put into the help-echo
  873. property so than moving the mouse over the command shows it.
  874. Setting it to nil is good if matcher strings are very long and/or if
  875. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  876. :group 'org-agenda
  877. :version "24.1"
  878. :type 'boolean)
  879. (defcustom org-agenda-menu-two-columns nil
  880. "Non-nil means, use two columns to show custom commands in the dispatcher.
  881. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  882. to nil."
  883. :group 'org-agenda
  884. :version "24.1"
  885. :type 'boolean)
  886. (defcustom org-agenda-finalize-hook nil
  887. "Hook run just before displaying an agenda buffer.
  888. The buffer is still writable when the hook is called.
  889. You can modify some of the buffer substrings but you should be
  890. extra careful not to modify the text properties of the agenda
  891. headlines as the agenda display heavily relies on them."
  892. :group 'org-agenda-startup
  893. :type 'hook)
  894. (defcustom org-agenda-mouse-1-follows-link nil
  895. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  896. A longer mouse click will still set point. Needs to be set
  897. before org.el is loaded."
  898. :group 'org-agenda-startup
  899. :type 'boolean)
  900. (defcustom org-agenda-start-with-follow-mode nil
  901. "The initial value of follow mode in a newly created agenda window."
  902. :group 'org-agenda-startup
  903. :type 'boolean)
  904. (defcustom org-agenda-follow-indirect nil
  905. "Non-nil means `org-agenda-follow-mode' displays only the
  906. current item's tree, in an indirect buffer."
  907. :group 'org-agenda
  908. :version "24.1"
  909. :type 'boolean)
  910. (defcustom org-agenda-show-outline-path t
  911. "Non-nil means show outline path in echo area after line motion."
  912. :group 'org-agenda-startup
  913. :type 'boolean)
  914. (defcustom org-agenda-start-with-entry-text-mode nil
  915. "The initial value of entry-text-mode in a newly created agenda window."
  916. :group 'org-agenda-startup
  917. :type 'boolean)
  918. (defcustom org-agenda-entry-text-maxlines 5
  919. "Number of text lines to be added when `E' is pressed in the agenda.
  920. Note that this variable only used during agenda display. To add entry text
  921. when exporting the agenda, configure the variable
  922. `org-agenda-add-entry-text-maxlines'."
  923. :group 'org-agenda
  924. :type 'integer)
  925. (defcustom org-agenda-entry-text-exclude-regexps nil
  926. "List of regular expressions to clean up entry text.
  927. The complete matches of all regular expressions in this list will be
  928. removed from entry text before it is shown in the agenda."
  929. :group 'org-agenda
  930. :type '(repeat (regexp)))
  931. (defcustom org-agenda-entry-text-leaders " > "
  932. "Text prepended to the entry text in agenda buffers."
  933. :version "24.4"
  934. :package-version '(Org . "8.0")
  935. :group 'org-agenda
  936. :type 'string)
  937. (defvar org-agenda-entry-text-cleanup-hook nil
  938. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  939. This cleanup is done in a temporary buffer, so the function may inspect and
  940. change the entire buffer.
  941. Some default stuff like drawers and scheduling/deadline dates will already
  942. have been removed when this is called, as will any matches for regular
  943. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  944. (defvar org-agenda-include-inactive-timestamps nil
  945. "Non-nil means include inactive time stamps in agenda.
  946. Dynamically scoped.")
  947. (defgroup org-agenda-windows nil
  948. "Options concerning the windows used by the Agenda in Org Mode."
  949. :tag "Org Agenda Windows"
  950. :group 'org-agenda)
  951. (defcustom org-agenda-window-setup 'reorganize-frame
  952. "How the agenda buffer should be displayed.
  953. Possible values for this option are:
  954. current-window Show agenda in the current window, keeping all other windows.
  955. other-window Use `switch-to-buffer-other-window' to display agenda.
  956. only-window Show agenda, deleting all other windows.
  957. reorganize-frame Show only two windows on the current frame, the current
  958. window and the agenda.
  959. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  960. Also, when exiting the agenda, kill that frame.
  961. See also the variable `org-agenda-restore-windows-after-quit'."
  962. :group 'org-agenda-windows
  963. :type '(choice
  964. (const current-window)
  965. (const other-frame)
  966. (const other-window)
  967. (const only-window)
  968. (const reorganize-frame)))
  969. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  970. "The min and max height of the agenda window as a fraction of frame height.
  971. The value of the variable is a cons cell with two numbers between 0 and 1.
  972. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  973. :group 'org-agenda-windows
  974. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  975. (defcustom org-agenda-restore-windows-after-quit nil
  976. "Non-nil means restore window configuration upon exiting agenda.
  977. Before the window configuration is changed for displaying the agenda,
  978. the current status is recorded. When the agenda is exited with
  979. `q' or `x' and this option is set, the old state is restored. If
  980. `org-agenda-window-setup' is `other-frame', the value of this
  981. option will be ignored."
  982. :group 'org-agenda-windows
  983. :type 'boolean)
  984. (defcustom org-agenda-span 'week
  985. "Number of days to include in overview display.
  986. Can be day, week, month, year, or any number of days.
  987. Custom commands can set this variable in the options section."
  988. :group 'org-agenda-daily/weekly
  989. :type '(choice (const :tag "Day" day)
  990. (const :tag "Week" week)
  991. (const :tag "Fortnight" fortnight)
  992. (const :tag "Month" month)
  993. (const :tag "Year" year)
  994. (integer :tag "Custom")))
  995. (defcustom org-agenda-start-on-weekday 1
  996. "Non-nil means start the overview always on the specified weekday.
  997. 0 denotes Sunday, 1 denotes Monday, etc.
  998. When nil, always start on the current day.
  999. Custom commands can set this variable in the options section."
  1000. :group 'org-agenda-daily/weekly
  1001. :type '(choice (const :tag "Today" nil)
  1002. (integer :tag "Weekday No.")))
  1003. (defcustom org-agenda-show-all-dates t
  1004. "Non-nil means `org-agenda' shows every day in the selected range.
  1005. When nil, only the days which actually have entries are shown."
  1006. :group 'org-agenda-daily/weekly
  1007. :type 'boolean)
  1008. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1009. "Format string for displaying dates in the agenda.
  1010. Used by the daily/weekly agenda. This should be a format string
  1011. understood by `format-time-string', or a function returning the
  1012. formatted date as a string. The function must take a single
  1013. argument, a calendar-style date list like (month day year)."
  1014. :group 'org-agenda-daily/weekly
  1015. :type '(choice
  1016. (string :tag "Format string")
  1017. (function :tag "Function")))
  1018. (defun org-agenda-format-date-aligned (date)
  1019. "Format a DATE string for display in the daily/weekly agenda.
  1020. This function makes sure that dates are aligned for easy reading."
  1021. (require 'cal-iso)
  1022. (let* ((dayname (calendar-day-name date))
  1023. (day (cadr date))
  1024. (day-of-week (calendar-day-of-week date))
  1025. (month (car date))
  1026. (monthname (calendar-month-name month))
  1027. (year (nth 2 date))
  1028. (iso-week (org-days-to-iso-week
  1029. (calendar-absolute-from-gregorian date)))
  1030. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1031. (1- year))
  1032. ((and (= month 12) (<= iso-week 1))
  1033. (1+ year))
  1034. (t year)))
  1035. (weekstring (if (= day-of-week 1)
  1036. (format " W%02d" iso-week)
  1037. "")))
  1038. (format "%-10s %2d %s %4d%s"
  1039. dayname day monthname year weekstring)))
  1040. (defcustom org-agenda-time-leading-zero nil
  1041. "Non-nil means use leading zero for military times in agenda.
  1042. For example, 9:30am would become 09:30 rather than 9:30."
  1043. :group 'org-agenda-daily/weekly
  1044. :version "24.1"
  1045. :type 'boolean)
  1046. (defcustom org-agenda-timegrid-use-ampm nil
  1047. "When set, show AM/PM style timestamps on the timegrid."
  1048. :group 'org-agenda
  1049. :version "24.1"
  1050. :type 'boolean)
  1051. (defun org-agenda-time-of-day-to-ampm (time)
  1052. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1053. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1054. (minute (substring time -2))
  1055. (ampm "am"))
  1056. (cond
  1057. ((equal hour-number 12)
  1058. (setq ampm "pm"))
  1059. ((> hour-number 12)
  1060. (setq ampm "pm")
  1061. (setq hour-number (- hour-number 12))))
  1062. (concat
  1063. (if org-agenda-time-leading-zero
  1064. (format "%02d" hour-number)
  1065. (format "%02s" (number-to-string hour-number)))
  1066. ":" minute ampm)))
  1067. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1068. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1069. (if org-agenda-timegrid-use-ampm
  1070. (org-agenda-time-of-day-to-ampm time)
  1071. time))
  1072. (defcustom org-agenda-weekend-days '(6 0)
  1073. "Which days are weekend?
  1074. These days get the special face `org-agenda-date-weekend' in the agenda."
  1075. :group 'org-agenda-daily/weekly
  1076. :type '(set :greedy t
  1077. (const :tag "Monday" 1)
  1078. (const :tag "Tuesday" 2)
  1079. (const :tag "Wednesday" 3)
  1080. (const :tag "Thursday" 4)
  1081. (const :tag "Friday" 5)
  1082. (const :tag "Saturday" 6)
  1083. (const :tag "Sunday" 0)))
  1084. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1085. "Non-nil means jump to today when moving a past date forward in time.
  1086. When using S-right in the agenda to move a a date forward, and the date
  1087. stamp currently points to the past, the first key press will move it
  1088. to today. When nil, just move one day forward even if the date stays
  1089. in the past."
  1090. :group 'org-agenda-daily/weekly
  1091. :version "24.1"
  1092. :type 'boolean)
  1093. (defcustom org-agenda-include-diary nil
  1094. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1095. Custom commands can set this variable in the options section."
  1096. :group 'org-agenda-daily/weekly
  1097. :type 'boolean)
  1098. (defcustom org-agenda-include-deadlines t
  1099. "If non-nil, include entries within their deadline warning period.
  1100. Custom commands can set this variable in the options section."
  1101. :group 'org-agenda-daily/weekly
  1102. :version "24.1"
  1103. :type 'boolean)
  1104. (defcustom org-agenda-show-future-repeats t
  1105. "Non-nil shows repeated entries in the future part of the agenda.
  1106. When set to the symbol `next' only the first future repeat is shown."
  1107. :group 'org-agenda-daily/weekly
  1108. :type '(choice
  1109. (const :tag "Show all repeated entries" t)
  1110. (const :tag "Show next repeated entry" next)
  1111. (const :tag "Do not show repeated entries" nil))
  1112. :version "26.1"
  1113. :package-version '(Org . "9.1")
  1114. :safe #'symbolp)
  1115. (defcustom org-agenda-prefer-last-repeat nil
  1116. "Non-nil sets date for repeated entries to their last repeat.
  1117. When nil, display SCHEDULED and DEADLINE dates at their base
  1118. date, and in today's agenda, as a reminder. Display plain
  1119. time-stamps, on the other hand, at every repeat date in the past
  1120. in addition to the base date.
  1121. When non-nil, show a repeated entry at its latest repeat date,
  1122. possibly being today even if it wasn't marked as done. This
  1123. setting is useful if you do not always mark repeated entries as
  1124. done and, yet, consider that reaching repeat date starts the task
  1125. anew.
  1126. When set to a list of strings, prefer last repeats only for
  1127. entries with these TODO keywords."
  1128. :group 'org-agenda-daily/weekly
  1129. :type '(choice
  1130. (const :tag "Prefer last repeat" t)
  1131. (const :tag "Prefer base date" nil)
  1132. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1133. (string :tag "TODO keyword")))
  1134. :version "26.1"
  1135. :package-version '(Org . "9.1")
  1136. :safe (lambda (x) (or (booleanp x) (consp x))))
  1137. (defcustom org-scheduled-past-days 10000
  1138. "Number of days to continue listing scheduled items not marked DONE.
  1139. When an item is scheduled on a date, it shows up in the agenda on
  1140. this day and will be listed until it is marked done or for the
  1141. number of days given here."
  1142. :group 'org-agenda-daily/weekly
  1143. :type 'integer
  1144. :safe 'integerp)
  1145. (defcustom org-deadline-past-days 10000
  1146. "Number of days to warn about missed deadlines.
  1147. When an item has deadline on a date, it shows up in the agenda on
  1148. this day and will appear as a reminder until it is marked DONE or
  1149. for the number of days given here."
  1150. :group 'org-agenda-daily/weekly
  1151. :type 'integer
  1152. :version "26.1"
  1153. :package-version '(Org . "9.1")
  1154. :safe 'integerp)
  1155. (defcustom org-agenda-log-mode-items '(closed clock)
  1156. "List of items that should be shown in agenda log mode.
  1157. \\<org-agenda-mode-map>\
  1158. This list may contain the following symbols:
  1159. closed Show entries that have been closed on that day.
  1160. clock Show entries that have received clocked time on that day.
  1161. state Show all logged state changes.
  1162. Note that instead of changing this variable, you can also press \
  1163. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1164. the agenda to display all available LOG items temporarily."
  1165. :group 'org-agenda-daily/weekly
  1166. :type '(set :greedy t (const closed) (const clock) (const state)))
  1167. (defcustom org-agenda-clock-consistency-checks
  1168. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1169. :gap-ok-around ("4:00")
  1170. :default-face ((:background "DarkRed") (:foreground "white"))
  1171. :overlap-face nil :gap-face nil :no-end-time-face nil
  1172. :long-face nil :short-face nil)
  1173. "This is a property list, with the following keys:
  1174. :max-duration Mark clocking chunks that are longer than this time.
  1175. This is a time string like \"HH:MM\", or the number
  1176. of minutes as an integer.
  1177. :min-duration Mark clocking chunks that are shorter that this.
  1178. This is a time string like \"HH:MM\", or the number
  1179. of minutes as an integer.
  1180. :max-gap Mark gaps between clocking chunks that are longer than
  1181. this duration. A number of minutes, or a string
  1182. like \"HH:MM\".
  1183. :gap-ok-around List of times during the day which are usually not working
  1184. times. When a gap is detected, but the gap contains any
  1185. of these times, the gap is *not* reported. For example,
  1186. if this is (\"4:00\" \"13:00\") then gaps that contain
  1187. 4:00 in the morning (i.e. the night) and 13:00
  1188. (i.e. a typical lunch time) do not cause a warning.
  1189. You should have at least one time during the night in this
  1190. list, or otherwise the first task each morning will trigger
  1191. a warning because it follows a long gap.
  1192. Furthermore, the following properties can be used to define faces for
  1193. issue display.
  1194. :default-face the default face, if the specific face is undefined
  1195. :overlap-face face for overlapping clocks
  1196. :gap-face face for gaps between clocks
  1197. :no-end-time-face face for incomplete clocks
  1198. :long-face face for clock intervals that are too long
  1199. :short-face face for clock intervals that are too short"
  1200. :group 'org-agenda-daily/weekly
  1201. :group 'org-clock
  1202. :version "24.1"
  1203. :type 'plist)
  1204. (defcustom org-agenda-log-mode-add-notes t
  1205. "Non-nil means add first line of notes to log entries in agenda views.
  1206. If a log item like a state change or a clock entry is associated with
  1207. notes, the first line of these notes will be added to the entry in the
  1208. agenda display."
  1209. :group 'org-agenda-daily/weekly
  1210. :type 'boolean)
  1211. (defcustom org-agenda-start-with-log-mode nil
  1212. "The initial value of log-mode in a newly created agenda window.
  1213. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1214. explanations on the possible values."
  1215. :group 'org-agenda-startup
  1216. :group 'org-agenda-daily/weekly
  1217. :type '(choice (const :tag "Don't show log items" nil)
  1218. (const :tag "Show only log items" only)
  1219. (const :tag "Show all possible log items" clockcheck)
  1220. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1221. (choice (const :tag "Show closed log items" closed)
  1222. (const :tag "Show clocked log items" clock)
  1223. (const :tag "Show all logged state changes" state)))))
  1224. (defcustom org-agenda-start-with-clockreport-mode nil
  1225. "The initial value of clockreport-mode in a newly created agenda window."
  1226. :group 'org-agenda-startup
  1227. :group 'org-agenda-daily/weekly
  1228. :type 'boolean)
  1229. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1230. "Property list with parameters for the clocktable in clockreport mode.
  1231. This is the display mode that shows a clock table in the daily/weekly
  1232. agenda, the properties for this dynamic block can be set here.
  1233. The usual clocktable parameters are allowed here, but you cannot set
  1234. the properties :name, :tstart, :tend, :block, and :scope - these will
  1235. be overwritten to make sure the content accurately reflects the
  1236. current display in the agenda."
  1237. :group 'org-agenda-daily/weekly
  1238. :type 'plist)
  1239. (defvaralias 'org-agenda-search-view-search-words-only
  1240. 'org-agenda-search-view-always-boolean)
  1241. (defcustom org-agenda-search-view-always-boolean nil
  1242. "Non-nil means the search string is interpreted as individual parts.
  1243. The search string for search view can either be interpreted as a phrase,
  1244. or as a list of snippets that define a boolean search for a number of
  1245. strings.
  1246. When this is non-nil, the string will be split on whitespace, and each
  1247. snippet will be searched individually, and all must match in order to
  1248. select an entry. A snippet is then a single string of non-white
  1249. characters, or a string in double quotes, or a regexp in {} braces.
  1250. If a snippet is preceded by \"-\", the snippet must *not* match.
  1251. \"+\" is syntactic sugar for positive selection. Each snippet may
  1252. be found as a full word or a partial word, but see the variable
  1253. `org-agenda-search-view-force-full-words'.
  1254. When this is nil, search will look for the entire search phrase as one,
  1255. with each space character matching any amount of whitespace, including
  1256. line breaks.
  1257. Even when this is nil, you can still switch to Boolean search dynamically
  1258. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1259. is a regexp marked with braces like \"{abc}\", this will also switch to
  1260. boolean search."
  1261. :group 'org-agenda-search-view
  1262. :version "24.1"
  1263. :type 'boolean)
  1264. (defcustom org-agenda-search-view-force-full-words nil
  1265. "Non-nil means, search words must be matches as complete words.
  1266. When nil, they may also match part of a word."
  1267. :group 'org-agenda-search-view
  1268. :version "24.1"
  1269. :type 'boolean)
  1270. (defcustom org-agenda-search-view-max-outline-level 0
  1271. "Maximum outline level to display in search view.
  1272. E.g. when this is set to 1, the search view will only
  1273. show headlines of level 1. When set to 0, the default
  1274. value, don't limit agenda view by outline level."
  1275. :group 'org-agenda-search-view
  1276. :version "26.1"
  1277. :package-version '(Org . "8.3")
  1278. :type 'integer)
  1279. (defgroup org-agenda-time-grid nil
  1280. "Options concerning the time grid in the Org Agenda."
  1281. :tag "Org Agenda Time Grid"
  1282. :group 'org-agenda)
  1283. (defcustom org-agenda-search-headline-for-time t
  1284. "Non-nil means search headline for a time-of-day.
  1285. If the headline contains a time-of-day in one format or another, it will
  1286. be used to sort the entry into the time sequence of items for a day.
  1287. Some people have time stamps in the headline that refer to the creation
  1288. time or so, and then this produces an unwanted side effect. If this is
  1289. the case for your, use this variable to turn off searching the headline
  1290. for a time."
  1291. :group 'org-agenda-time-grid
  1292. :type 'boolean)
  1293. (defcustom org-agenda-use-time-grid t
  1294. "Non-nil means show a time grid in the agenda schedule.
  1295. A time grid is a set of lines for specific times (like every two hours between
  1296. 8:00 and 20:00). The items scheduled for a day at specific times are
  1297. sorted in between these lines.
  1298. For details about when the grid will be shown, and what it will look like, see
  1299. the variable `org-agenda-time-grid'."
  1300. :group 'org-agenda-time-grid
  1301. :type 'boolean)
  1302. (defcustom org-agenda-time-grid
  1303. '((daily today require-timed)
  1304. (800 1000 1200 1400 1600 1800 2000)
  1305. "......"
  1306. "----------------")
  1307. "The settings for time grid for agenda display.
  1308. This is a list of four items. The first item is again a list. It contains
  1309. symbols specifying conditions when the grid should be displayed:
  1310. daily if the agenda shows a single day
  1311. weekly if the agenda shows an entire week
  1312. today show grid on current date, independent of daily/weekly display
  1313. require-timed show grid only if at least one item has a time specification
  1314. remove-match skip grid times already present in an entry
  1315. The second item is a list of integers, indicating the times that
  1316. should have a grid line.
  1317. The third item is a string which will be placed right after the
  1318. times that have a grid line.
  1319. The fourth item is a string placed after the grid times. This
  1320. will align with agenda items"
  1321. :group 'org-agenda-time-grid
  1322. :type
  1323. '(list
  1324. (set :greedy t :tag "Grid Display Options"
  1325. (const :tag "Show grid in single day agenda display" daily)
  1326. (const :tag "Show grid in weekly agenda display" weekly)
  1327. (const :tag "Always show grid for today" today)
  1328. (const :tag "Show grid only if any timed entries are present"
  1329. require-timed)
  1330. (const :tag "Skip grid times already present in an entry"
  1331. remove-match))
  1332. (repeat :tag "Grid Times" (integer :tag "Time"))
  1333. (string :tag "Grid String (after agenda times)")
  1334. (string :tag "Grid String (aligns with agenda items)")))
  1335. (defcustom org-agenda-show-current-time-in-grid t
  1336. "Non-nil means show the current time in the time grid."
  1337. :group 'org-agenda-time-grid
  1338. :version "24.1"
  1339. :type 'boolean)
  1340. (defcustom org-agenda-current-time-string
  1341. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1342. "The string for the current time marker in the agenda."
  1343. :group 'org-agenda-time-grid
  1344. :version "24.1"
  1345. :type 'string)
  1346. (defgroup org-agenda-sorting nil
  1347. "Options concerning sorting in the Org Agenda."
  1348. :tag "Org Agenda Sorting"
  1349. :group 'org-agenda)
  1350. (defcustom org-agenda-sorting-strategy
  1351. '((agenda habit-down time-up priority-down category-keep)
  1352. (todo priority-down category-keep)
  1353. (tags priority-down category-keep)
  1354. (search category-keep))
  1355. "Sorting structure for the agenda items of a single day.
  1356. This is a list of symbols which will be used in sequence to determine
  1357. if an entry should be listed before another entry. The following
  1358. symbols are recognized:
  1359. time-up Put entries with time-of-day indications first, early first
  1360. time-down Put entries with time-of-day indications first, late first
  1361. timestamp-up Sort by any timestamp, early first
  1362. timestamp-down Sort by any timestamp, late first
  1363. scheduled-up Sort by scheduled timestamp, early first
  1364. scheduled-down Sort by scheduled timestamp, late first
  1365. deadline-up Sort by deadline timestamp, early first
  1366. deadline-down Sort by deadline timestamp, late first
  1367. ts-up Sort by active timestamp, early first
  1368. ts-down Sort by active timestamp, late first
  1369. tsia-up Sort by inactive timestamp, early first
  1370. tsia-down Sort by inactive timestamp, late first
  1371. category-keep Keep the default order of categories, corresponding to the
  1372. sequence in `org-agenda-files'.
  1373. category-up Sort alphabetically by category, A-Z.
  1374. category-down Sort alphabetically by category, Z-A.
  1375. tag-up Sort alphabetically by last tag, A-Z.
  1376. tag-down Sort alphabetically by last tag, Z-A.
  1377. priority-up Sort numerically by priority, high priority last.
  1378. priority-down Sort numerically by priority, high priority first.
  1379. todo-state-up Sort by todo state, tasks that are done last.
  1380. todo-state-down Sort by todo state, tasks that are done first.
  1381. effort-up Sort numerically by estimated effort, high effort last.
  1382. effort-down Sort numerically by estimated effort, high effort first.
  1383. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1384. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1385. habit-up Put entries that are habits first
  1386. habit-down Put entries that are habits last
  1387. alpha-up Sort headlines alphabetically
  1388. alpha-down Sort headlines alphabetically, reversed
  1389. The different possibilities will be tried in sequence, and testing stops
  1390. if one comparison returns a \"not-equal\". For example, the default
  1391. '(time-up category-keep priority-down)
  1392. means: Pull out all entries having a specified time of day and sort them,
  1393. in order to make a time schedule for the current day the first thing in the
  1394. agenda listing for the day. Of the entries without a time indication, keep
  1395. the grouped in categories, don't sort the categories, but keep them in
  1396. the sequence given in `org-agenda-files'. Within each category sort by
  1397. priority.
  1398. Leaving out `category-keep' would mean that items will be sorted across
  1399. categories by priority.
  1400. Instead of a single list, this can also be a set of list for specific
  1401. contents, with a context symbol in the car of the list, any of
  1402. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1403. Custom commands can bind this variable in the options section."
  1404. :group 'org-agenda-sorting
  1405. :type `(choice
  1406. (repeat :tag "General" ,org-sorting-choice)
  1407. (list :tag "Individually"
  1408. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1409. (repeat ,org-sorting-choice))
  1410. (cons (const :tag "Strategy for TODO lists" todo)
  1411. (repeat ,org-sorting-choice))
  1412. (cons (const :tag "Strategy for Tags matches" tags)
  1413. (repeat ,org-sorting-choice))
  1414. (cons (const :tag "Strategy for search matches" search)
  1415. (repeat ,org-sorting-choice)))))
  1416. (defcustom org-agenda-cmp-user-defined nil
  1417. "A function to define the comparison `user-defined'.
  1418. This function must receive two arguments, agenda entry a and b.
  1419. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1420. the user comparison, return nil.
  1421. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1422. part of an agenda sorting strategy."
  1423. :group 'org-agenda-sorting
  1424. :type 'symbol)
  1425. (defcustom org-sort-agenda-notime-is-late t
  1426. "Non-nil means items without time are considered late.
  1427. This is only relevant for sorting. When t, items which have no explicit
  1428. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1429. do have a time. When nil, the default time is before 0:00. You can use this
  1430. option to decide if the schedule for today should come before or after timeless
  1431. agenda entries."
  1432. :group 'org-agenda-sorting
  1433. :type 'boolean)
  1434. (defcustom org-sort-agenda-noeffort-is-high t
  1435. "Non-nil means items without effort estimate are sorted as high effort.
  1436. This also applies when filtering an agenda view with respect to the
  1437. < or > effort operator. Then, tasks with no effort defined will be treated
  1438. as tasks with high effort.
  1439. When nil, such items are sorted as 0 minutes effort."
  1440. :group 'org-agenda-sorting
  1441. :type 'boolean)
  1442. (defgroup org-agenda-line-format nil
  1443. "Options concerning the entry prefix in the Org agenda display."
  1444. :tag "Org Agenda Line Format"
  1445. :group 'org-agenda)
  1446. (defcustom org-agenda-prefix-format
  1447. '((agenda . " %i %-12:c%?-12t% s")
  1448. (todo . " %i %-12:c")
  1449. (tags . " %i %-12:c")
  1450. (search . " %i %-12:c"))
  1451. "Format specifications for the prefix of items in the agenda views.
  1452. An alist with one entry per agenda type. The keys of the
  1453. sublists are `agenda', `todo', `search' and `tags'. The values
  1454. are format strings.
  1455. This format works similar to a printf format, with the following meaning:
  1456. %c the category of the item, \"Diary\" for entries from the diary,
  1457. or as given by the CATEGORY keyword or derived from the file name
  1458. %e the effort required by the item
  1459. %l the level of the item (insert X space(s) if item is of level X)
  1460. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1461. %T the last tag of the item (ignore inherited tags, which come first)
  1462. %t the HH:MM time-of-day specification if one applies to the entry
  1463. %s Scheduling/Deadline information, a short string
  1464. %b show breadcrumbs, i.e., the names of the higher levels
  1465. %(expression) Eval EXPRESSION and replace the control string
  1466. by the result
  1467. All specifiers work basically like the standard `%s' of printf, but may
  1468. contain two additional characters: a question mark just after the `%'
  1469. and a whitespace/punctuation character just before the final letter.
  1470. If the first character after `%' is a question mark, the entire field
  1471. will only be included if the corresponding value applies to the current
  1472. entry. This is useful for fields which should have fixed width when
  1473. present, but zero width when absent. For example, \"%?-12t\" will
  1474. result in a 12 character time field if a time of the day is specified,
  1475. but will completely disappear in entries which do not contain a time.
  1476. If there is punctuation or whitespace character just before the
  1477. final format letter, this character will be appended to the field
  1478. value if the value is not empty. For example, the format
  1479. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1480. the category is empty, no additional colon is inserted.
  1481. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1482. which means:
  1483. - Indent the line with two space characters
  1484. - Give the category a 12 chars wide field, padded with whitespace on
  1485. the right (because of `-'). Append a colon if there is a category
  1486. (because of `:').
  1487. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1488. time, don't put in an empty field, just skip it (because of '?').
  1489. - Finally, put the scheduling information.
  1490. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1491. `org-agenda-remove-tags'.
  1492. Custom commands can set this variable in the options section."
  1493. :type '(choice
  1494. (string :tag "General format")
  1495. (list :greedy t :tag "View dependent"
  1496. (cons (const agenda) (string :tag "Format"))
  1497. (cons (const todo) (string :tag "Format"))
  1498. (cons (const tags) (string :tag "Format"))
  1499. (cons (const search) (string :tag "Format"))))
  1500. :group 'org-agenda-line-format
  1501. :version "26.1"
  1502. :package-version '(Org . "9.1"))
  1503. (defcustom org-agenda-breadcrumbs-separator "->"
  1504. "The separator of breadcrumbs in agenda lines."
  1505. :group 'org-agenda-line-format
  1506. :package-version '(Org . "9.3")
  1507. :type 'string
  1508. :safe #'stringp)
  1509. (defvar org-prefix-format-compiled nil
  1510. "The compiled prefix format and associated variables.
  1511. This is a list where first element is a list of variable bindings, and second
  1512. element is the compiled format expression. See the variable
  1513. `org-agenda-prefix-format'.")
  1514. (defcustom org-agenda-todo-keyword-format "%-1s"
  1515. "Format for the TODO keyword in agenda lines.
  1516. Set this to something like \"%-12s\" if you want all TODO keywords
  1517. to occupy a fixed space in the agenda display."
  1518. :group 'org-agenda-line-format
  1519. :type 'string)
  1520. (defcustom org-agenda-diary-sexp-prefix nil
  1521. "A regexp that matches part of a diary sexp entry
  1522. which should be treated as scheduling/deadline information in
  1523. `org-agenda'.
  1524. For example, you can use this to extract the `diary-remind-message' from
  1525. `diary-remind' entries."
  1526. :group 'org-agenda-line-format
  1527. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1528. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1529. "Text preceding timerange entries in the agenda view.
  1530. This is a list with two strings. The first applies when the range
  1531. is entirely on one day. The second applies if the range spans several days.
  1532. The strings may have two \"%d\" format specifiers which will be filled
  1533. with the sequence number of the days, and the total number of days in the
  1534. range, respectively."
  1535. :group 'org-agenda-line-format
  1536. :type '(list
  1537. (string :tag "Deadline today ")
  1538. (choice :tag "Deadline relative"
  1539. (string :tag "Format string")
  1540. (function))))
  1541. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1542. "Text preceding scheduled items in the agenda view.
  1543. This is a list with two strings. The first applies when the item is
  1544. scheduled on the current day. The second applies when it has been scheduled
  1545. previously, it may contain a %d indicating that this is the nth time that
  1546. this item is scheduled, due to automatic rescheduling of unfinished items
  1547. for the following day. So this number is one larger than the number of days
  1548. that passed since this item was scheduled first."
  1549. :group 'org-agenda-line-format
  1550. :version "24.4"
  1551. :package-version '(Org . "8.0")
  1552. :type '(list
  1553. (string :tag "Scheduled today ")
  1554. (string :tag "Scheduled previously")))
  1555. (defcustom org-agenda-inactive-leader "["
  1556. "Text preceding item pulled into the agenda by inactive time stamps.
  1557. These entries are added to the agenda when pressing \"[\"."
  1558. :group 'org-agenda-line-format
  1559. :version "24.1"
  1560. :type 'string)
  1561. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1562. "Text preceding deadline items in the agenda view.
  1563. This is a list with three strings. The first applies when the item has its
  1564. deadline on the current day. The second applies when the deadline is in the
  1565. future, the third one when it is in the past. The strings may contain %d
  1566. to capture the number of days."
  1567. :group 'org-agenda-line-format
  1568. :version "24.4"
  1569. :package-version '(Org . "8.0")
  1570. :type '(list
  1571. (string :tag "Deadline today ")
  1572. (string :tag "Deadline in the future ")
  1573. (string :tag "Deadline in the past ")))
  1574. (defcustom org-agenda-remove-times-when-in-prefix t
  1575. "Non-nil means remove duplicate time specifications in agenda items.
  1576. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1577. time-of-day specification in a headline or diary entry is extracted and
  1578. placed into the prefix. If this option is non-nil, the original specification
  1579. \(a timestamp or -range, or just a plain time(range) specification like
  1580. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1581. cluttered.
  1582. The option can be t or nil. It may also be the symbol `beg', indicating
  1583. that the time should only be removed when it is located at the beginning of
  1584. the headline/diary entry."
  1585. :group 'org-agenda-line-format
  1586. :type '(choice
  1587. (const :tag "Always" t)
  1588. (const :tag "Never" nil)
  1589. (const :tag "When at beginning of entry" beg)))
  1590. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1591. "Non-nil means remove time ranges specifications in agenda
  1592. items that span on several days."
  1593. :group 'org-agenda-line-format
  1594. :version "24.1"
  1595. :type 'boolean)
  1596. (defcustom org-agenda-default-appointment-duration nil
  1597. "Default duration for appointments that only have a starting time.
  1598. When nil, no duration is specified in such cases.
  1599. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1600. :group 'org-agenda-line-format
  1601. :type '(choice
  1602. (integer :tag "Minutes")
  1603. (const :tag "No default duration")))
  1604. (defcustom org-agenda-show-inherited-tags t
  1605. "Non-nil means show inherited tags in each agenda line.
  1606. When this option is set to `always', it takes precedence over
  1607. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1608. in every agenda.
  1609. When this option is set to t (the default), inherited tags are
  1610. shown when they are available, i.e. when the value of
  1611. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1612. given agenda type.
  1613. This can be set to a list of agenda types in which the agenda
  1614. must display the inherited tags. Available types are `todo',
  1615. `agenda' and `search'.
  1616. When set to nil, never show inherited tags in agenda lines."
  1617. :group 'org-agenda-line-format
  1618. :group 'org-agenda
  1619. :version "24.3"
  1620. :type '(choice
  1621. (const :tag "Show inherited tags when available" t)
  1622. (const :tag "Always show inherited tags" always)
  1623. (repeat :tag "Show inherited tags only in selected agenda types"
  1624. (symbol :tag "Agenda type"))))
  1625. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1626. "List of agenda view types where to use tag inheritance.
  1627. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1628. controlled by `org-use-tag-inheritance'. In other agenda types,
  1629. `org-use-tag-inheritance' is not used for the selection of the
  1630. agenda entries. Still, you may want the agenda to be aware of
  1631. the inherited tags anyway, e.g. for later tag filtering.
  1632. Allowed value are `todo', `search' and `agenda'.
  1633. This variable has no effect if `org-agenda-show-inherited-tags'
  1634. is set to `always'. In that case, the agenda is aware of those
  1635. tags.
  1636. The default value sets tags in every agenda type. Setting this
  1637. option to nil will speed up non-tags agenda view a lot."
  1638. :group 'org-agenda
  1639. :version "26.1"
  1640. :package-version '(Org . "9.1")
  1641. :type '(choice
  1642. (const :tag "Use tag inheritance in all agenda types" t)
  1643. (repeat :tag "Use tag inheritance in selected agenda types"
  1644. (symbol :tag "Agenda type"))))
  1645. (defcustom org-agenda-hide-tags-regexp nil
  1646. "Regular expression used to filter away specific tags in agenda views.
  1647. This means that these tags will be present, but not be shown in the agenda
  1648. line. Secondary filtering will still work on the hidden tags.
  1649. Nil means don't hide any tags."
  1650. :group 'org-agenda-line-format
  1651. :type '(choice
  1652. (const :tag "Hide none" nil)
  1653. (string :tag "Regexp ")))
  1654. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1655. 'org-agenda-remove-tags)
  1656. (defcustom org-agenda-remove-tags nil
  1657. "Non-nil means remove the tags from the headline copy in the agenda.
  1658. When this is the symbol `prefix', only remove tags when
  1659. `org-agenda-prefix-format' contains a `%T' specifier."
  1660. :group 'org-agenda-line-format
  1661. :type '(choice
  1662. (const :tag "Always" t)
  1663. (const :tag "Never" nil)
  1664. (const :tag "When prefix format contains %T" prefix)))
  1665. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1666. (defcustom org-agenda-tags-column 'auto
  1667. "Shift tags in agenda items to this column.
  1668. If set to `auto', tags will be automatically aligned to the right
  1669. edge of the window.
  1670. If set to a positive number, tags will be left-aligned to that
  1671. column. If set to a negative number, tags will be right-aligned
  1672. to that column. For example, -80 works well for a normal 80
  1673. character screen."
  1674. :group 'org-agenda-line-format
  1675. :type '(choice
  1676. (const :tag "Automatically align to right edge of window" auto)
  1677. (integer :tag "Specific column" -80))
  1678. :package-version '(Org . "9.1")
  1679. :version "26.1")
  1680. (defcustom org-agenda-fontify-priorities 'cookies
  1681. "Non-nil means highlight low and high priorities in agenda.
  1682. When t, the highest priority entries are bold, lowest priority italic.
  1683. However, settings in `org-priority-faces' will overrule these faces.
  1684. When this variable is the symbol `cookies', only fontify the
  1685. cookies, not the entire task.
  1686. This may also be an association list of priority faces, whose
  1687. keys are the character values of `org-highest-priority',
  1688. `org-default-priority', and `org-lowest-priority' (the default values
  1689. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1690. color as a string, or a list like `(:background \"Red\")'.
  1691. If it is a color, the variable `org-faces-easy-properties'
  1692. determines if it is a foreground or a background color."
  1693. :group 'org-agenda-line-format
  1694. :type '(choice
  1695. (const :tag "Never" nil)
  1696. (const :tag "Defaults" t)
  1697. (const :tag "Cookies only" cookies)
  1698. (repeat :tag "Specify"
  1699. (list (character :tag "Priority" :value ?A)
  1700. (choice :tag "Face "
  1701. (string :tag "Color")
  1702. (sexp :tag "Face"))))))
  1703. (defcustom org-agenda-day-face-function nil
  1704. "Function called to determine what face should be used to display a day.
  1705. The only argument passed to that function is the day. It should
  1706. returns a face, or nil if does not want to specify a face and let
  1707. the normal rules apply."
  1708. :group 'org-agenda-line-format
  1709. :version "24.1"
  1710. :type '(choice (const nil) (function)))
  1711. (defcustom org-agenda-category-icon-alist nil
  1712. "Alist of category icon to be displayed in agenda views.
  1713. Each entry should have the following format:
  1714. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1715. Where CATEGORY-REGEXP is a regexp matching the categories where
  1716. the icon should be displayed.
  1717. FILE-OR-DATA either a file path or a string containing image data.
  1718. The other fields can be omitted safely if not needed:
  1719. TYPE indicates the image type.
  1720. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1721. image data.
  1722. PROPS are additional image attributes to assign to the image,
  1723. like, e.g. `:ascent center'.
  1724. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1725. If you want to set the display properties yourself, just put a
  1726. list as second element:
  1727. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1728. For example, to display a 16px horizontal space for Emacs
  1729. category, you can use:
  1730. (\"Emacs\" \\='(space . (:width (16))))"
  1731. :group 'org-agenda-line-format
  1732. :version "24.1"
  1733. :type '(alist :key-type (string :tag "Regexp matching category")
  1734. :value-type (choice (list :tag "Icon"
  1735. (string :tag "File or data")
  1736. (symbol :tag "Type")
  1737. (boolean :tag "Data?")
  1738. (repeat :tag "Extra image properties" :inline t symbol))
  1739. (list :tag "Display properties" sexp))))
  1740. (defgroup org-agenda-column-view nil
  1741. "Options concerning column view in the agenda."
  1742. :tag "Org Agenda Column View"
  1743. :group 'org-agenda)
  1744. (defcustom org-agenda-view-columns-initially nil
  1745. "When non-nil, switch to columns view right after creating the agenda."
  1746. :group 'org-agenda-column-view
  1747. :type 'boolean
  1748. :version "26.1"
  1749. :package-version '(Org . "9.0")
  1750. :safe #'booleanp)
  1751. (defcustom org-agenda-columns-show-summaries t
  1752. "Non-nil means show summaries for columns displayed in the agenda view."
  1753. :group 'org-agenda-column-view
  1754. :type 'boolean)
  1755. (defcustom org-agenda-columns-compute-summary-properties t
  1756. "Non-nil means recompute all summary properties before column view.
  1757. When column view in the agenda is listing properties that have a summary
  1758. operator, it can go to all relevant buffers and recompute the summaries
  1759. there. This can mean overhead for the agenda column view, but is necessary
  1760. to have thing up to date.
  1761. As a special case, a CLOCKSUM property also makes sure that the clock
  1762. computations are current."
  1763. :group 'org-agenda-column-view
  1764. :type 'boolean)
  1765. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1766. "Non-nil means the duration of an appointment will add to day effort.
  1767. The property to which appointment durations will be added is the one given
  1768. in the option `org-effort-property'. If an appointment does not have
  1769. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1770. is not set, an appointment without end time will not contribute to the time
  1771. estimate."
  1772. :group 'org-agenda-column-view
  1773. :type 'boolean)
  1774. (defcustom org-agenda-auto-exclude-function nil
  1775. "A function called with a tag to decide if it is filtered on \
  1776. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1777. The sole argument to the function, which is called once for each
  1778. possible tag, is a string giving the name of the tag. The
  1779. function should return either nil if the tag should be included
  1780. as normal, or \"-<TAG>\" to exclude the tag.
  1781. Note that for the purpose of tag filtering, only the lower-case version of
  1782. all tags will be considered, so that this function will only ever see
  1783. the lower-case version of all tags."
  1784. :group 'org-agenda
  1785. :type '(choice (const nil) (function)))
  1786. (defcustom org-agenda-bulk-custom-functions nil
  1787. "Alist of characters and custom functions for bulk actions.
  1788. For example, this value makes those two functions available:
  1789. \\='((?R set-category)
  1790. (?C bulk-cut))
  1791. With selected entries in an agenda buffer, `B R' will call
  1792. the custom function `set-category' on the selected entries.
  1793. Note that functions in this alist don't need to be quoted."
  1794. :type '(alist :key-type character :value-type (group function))
  1795. :version "24.1"
  1796. :group 'org-agenda)
  1797. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1798. "Execute BODY with point at location given by `org-hd-marker' property.
  1799. If STRING is non-nil, the text property will be fetched from position 0
  1800. in that string. If STRING is nil, it will be fetched from the beginning
  1801. of the current line."
  1802. (org-with-gensyms (marker)
  1803. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1804. 'org-hd-marker ,string)))
  1805. (with-current-buffer (marker-buffer ,marker)
  1806. (save-excursion
  1807. (goto-char ,marker)
  1808. ,@body)))))
  1809. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1810. (defun org-add-agenda-custom-command (entry)
  1811. "Replace or add a command in `org-agenda-custom-commands'.
  1812. This is mostly for hacking and trying a new command - once the command
  1813. works you probably want to add it to `org-agenda-custom-commands' for good."
  1814. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1815. (if ass
  1816. (setcdr ass (cdr entry))
  1817. (push entry org-agenda-custom-commands))))
  1818. (defmacro org-agenda--insert-overriding-header (default)
  1819. "Insert header into agenda view.
  1820. The inserted header depends on `org-agenda-overriding-header'.
  1821. If the empty string, don't insert a header. If any other string,
  1822. insert it as a header. If nil, insert DEFAULT, which should
  1823. evaluate to a string."
  1824. (declare (debug (form)) (indent defun))
  1825. `(cond
  1826. ((not org-agenda-overriding-header) (insert ,default))
  1827. ((equal org-agenda-overriding-header "") nil)
  1828. ((stringp org-agenda-overriding-header)
  1829. (insert (propertize org-agenda-overriding-header
  1830. 'face 'org-agenda-structure)
  1831. "\n"))
  1832. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1833. org-agenda-overriding-header))))
  1834. ;;; Define the org-agenda-mode
  1835. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1836. (defvar org-agenda-mode-map (make-sparse-keymap)
  1837. "Keymap for `org-agenda-mode'.")
  1838. (defvar org-agenda-menu) ; defined later in this file.
  1839. (defvar org-agenda-restrict nil) ; defined later in this file.
  1840. (defvar org-agenda-follow-mode nil)
  1841. (defvar org-agenda-entry-text-mode nil)
  1842. (defvar org-agenda-clockreport-mode nil)
  1843. (defvar org-agenda-show-log nil
  1844. "When non-nil, show the log in the agenda.
  1845. Do not set this directly; instead use
  1846. `org-agenda-start-with-log-mode', which see.")
  1847. (defvar org-agenda-redo-command nil)
  1848. (defvar org-agenda-query-string nil)
  1849. (defvar org-agenda-mode-hook nil
  1850. "Hook run after `org-agenda-mode' is turned on.
  1851. The buffer is still writable when this hook is called.")
  1852. (defvar org-agenda-type nil)
  1853. (defvar org-agenda-force-single-file nil)
  1854. (defvar org-agenda-bulk-marked-entries nil
  1855. "List of markers that refer to marked entries in the agenda.")
  1856. (defvar org-agenda-current-date nil
  1857. "Active date when building the agenda.")
  1858. ;;; Multiple agenda buffers support
  1859. (defcustom org-agenda-sticky nil
  1860. "Non-nil means agenda q key will bury agenda buffers.
  1861. Agenda commands will then show existing buffer instead of generating new ones.
  1862. When nil, `q' will kill the single agenda buffer."
  1863. :group 'org-agenda
  1864. :version "24.3"
  1865. :type 'boolean)
  1866. ;;;###autoload
  1867. (defun org-toggle-sticky-agenda (&optional arg)
  1868. "Toggle `org-agenda-sticky'."
  1869. (interactive "P")
  1870. (let ((new-value (if arg
  1871. (> (prefix-numeric-value arg) 0)
  1872. (not org-agenda-sticky))))
  1873. (if (equal new-value org-agenda-sticky)
  1874. (and (called-interactively-p 'interactive)
  1875. (message "Sticky agenda was already %s"
  1876. (if org-agenda-sticky "enabled" "disabled")))
  1877. (setq org-agenda-sticky new-value)
  1878. (org-agenda-kill-all-agenda-buffers)
  1879. (and (called-interactively-p 'interactive)
  1880. (message "Sticky agenda %s"
  1881. (if org-agenda-sticky "enabled" "disabled"))))))
  1882. (defvar org-agenda-buffer nil
  1883. "Agenda buffer currently being generated.")
  1884. (defvar org-agenda-last-prefix-arg nil)
  1885. (defvar org-agenda-this-buffer-name nil)
  1886. (defvar org-agenda-doing-sticky-redo nil)
  1887. (defvar org-agenda-this-buffer-is-sticky nil)
  1888. (defvar org-agenda-last-indirect-buffer nil
  1889. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1890. (defconst org-agenda-local-vars
  1891. '(org-agenda-this-buffer-name
  1892. org-agenda-undo-list
  1893. org-agenda-pending-undo-list
  1894. org-agenda-follow-mode
  1895. org-agenda-entry-text-mode
  1896. org-agenda-clockreport-mode
  1897. org-agenda-show-log
  1898. org-agenda-redo-command
  1899. org-agenda-query-string
  1900. org-agenda-type
  1901. org-agenda-bulk-marked-entries
  1902. org-agenda-undo-has-started-in
  1903. org-agenda-info
  1904. org-agenda-pre-window-conf
  1905. org-agenda-columns-active
  1906. org-agenda-tag-filter
  1907. org-agenda-category-filter
  1908. org-agenda-top-headline-filter
  1909. org-agenda-regexp-filter
  1910. org-agenda-effort-filter
  1911. org-agenda-markers
  1912. org-agenda-last-search-view-search-was-boolean
  1913. org-agenda-last-indirect-buffer
  1914. org-agenda-filtered-by-category
  1915. org-agenda-filter-form
  1916. org-agenda-cycle-counter
  1917. org-agenda-last-prefix-arg)
  1918. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1919. (defun org-agenda-mode ()
  1920. "Mode for time-sorted view on action items in Org files.
  1921. The following commands are available:
  1922. \\{org-agenda-mode-map}"
  1923. (interactive)
  1924. (let ((agenda-local-vars-to-keep
  1925. '(text-scale-mode-amount
  1926. text-scale-mode
  1927. text-scale-mode-lighter
  1928. face-remapping-alist))
  1929. (save (buffer-local-variables)))
  1930. (kill-all-local-variables)
  1931. (cl-flet ((reset-saved (var-set)
  1932. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1933. (dolist (elem save)
  1934. (pcase elem
  1935. (`(,var . ,val) ;ignore unbound variables
  1936. (when (and val (memq var var-set))
  1937. (set var val)))))))
  1938. (cond (org-agenda-doing-sticky-redo
  1939. ;; Refreshing sticky agenda-buffer
  1940. ;;
  1941. ;; Preserve the value of `org-agenda-local-vars' variables.
  1942. (mapc #'make-local-variable org-agenda-local-vars)
  1943. (reset-saved org-agenda-local-vars)
  1944. (setq-local org-agenda-this-buffer-is-sticky t))
  1945. (org-agenda-sticky
  1946. ;; Creating a sticky Agenda buffer for the first time
  1947. (mapc 'make-local-variable org-agenda-local-vars)
  1948. (setq-local org-agenda-this-buffer-is-sticky t))
  1949. (t
  1950. ;; Creating a non-sticky agenda buffer
  1951. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1952. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1953. (reset-saved agenda-local-vars-to-keep)))
  1954. (setq org-agenda-undo-list nil
  1955. org-agenda-pending-undo-list nil
  1956. org-agenda-bulk-marked-entries nil)
  1957. (setq major-mode 'org-agenda-mode)
  1958. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1959. (setq-local font-lock-global-modes (list 'not major-mode))
  1960. (setq mode-name "Org-Agenda")
  1961. (setq indent-tabs-mode nil)
  1962. (use-local-map org-agenda-mode-map)
  1963. (easy-menu-add org-agenda-menu)
  1964. (when org-startup-truncated (setq truncate-lines t))
  1965. (setq-local line-move-visual nil)
  1966. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1967. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1968. ;; Make sure properties are removed when copying text
  1969. (if (boundp 'filter-buffer-substring-functions)
  1970. (add-hook 'filter-buffer-substring-functions
  1971. (lambda (fun start end delete)
  1972. (substring-no-properties (funcall fun start end delete)))
  1973. nil t)
  1974. ;; Emacs >= 24.4.
  1975. (add-function :filter-return (local 'filter-buffer-substring-function)
  1976. #'substring-no-properties))
  1977. (unless org-agenda-keep-modes
  1978. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1979. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1980. org-agenda-show-log org-agenda-start-with-log-mode
  1981. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  1982. (add-to-invisibility-spec '(org-filtered))
  1983. (add-to-invisibility-spec '(org-link))
  1984. (easy-menu-change
  1985. '("Agenda") "Agenda Files"
  1986. (append
  1987. (list
  1988. (vector
  1989. (if (get 'org-agenda-files 'org-restrict)
  1990. "Restricted to single file"
  1991. "Edit File List")
  1992. '(org-edit-agenda-file-list)
  1993. (not (get 'org-agenda-files 'org-restrict)))
  1994. "--")
  1995. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1996. (org-agenda-set-mode-name)
  1997. (apply
  1998. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1999. (list 'org-agenda-mode-hook)))
  2000. (substitute-key-definition 'undo 'org-agenda-undo
  2001. org-agenda-mode-map global-map)
  2002. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  2003. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  2004. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  2005. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  2006. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  2007. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  2008. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  2009. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  2010. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  2011. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  2012. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  2013. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  2014. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  2015. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  2016. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  2017. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  2018. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2019. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2020. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2021. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2022. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2023. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2024. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2025. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2026. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2027. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2028. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2029. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2030. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2031. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2032. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2034. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2035. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2036. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2037. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2038. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2039. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2040. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2041. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2042. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2043. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2044. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2045. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2047. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2048. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2049. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2050. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2051. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2052. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2053. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2054. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2055. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2056. (while l (org-defkey org-agenda-mode-map
  2057. (int-to-string (pop l)) 'digit-argument)))
  2058. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2059. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2060. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2061. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2062. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2063. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2064. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2065. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2066. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2067. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2068. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2069. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2070. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2071. 'org-clock-modify-effort-estimate)
  2072. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2073. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2074. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2075. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2076. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2077. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2078. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2079. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2080. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2081. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2082. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2083. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2084. (substitute-key-definition 'next-line 'org-agenda-next-line
  2085. org-agenda-mode-map global-map)
  2086. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2087. org-agenda-mode-map global-map)
  2088. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2089. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2090. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2091. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2092. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2093. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2094. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2095. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2096. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2097. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2098. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2099. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2100. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2101. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2102. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2103. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2104. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2105. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2106. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2107. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2108. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2109. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2110. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2111. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2112. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2113. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2114. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2115. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2116. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2117. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2118. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2119. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2120. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2121. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2122. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2123. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2124. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2125. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2126. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2127. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2128. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2129. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2130. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2131. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2132. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2133. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2134. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2135. (org-defkey org-agenda-mode-map "\C-c\C-xI" 'org-info-find-node)
  2136. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2137. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2138. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2139. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2140. (when org-agenda-mouse-1-follows-link
  2141. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2142. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2143. '("Agenda"
  2144. ("Agenda Files")
  2145. "--"
  2146. ("Agenda Dates"
  2147. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2148. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2149. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2150. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2151. "--"
  2152. ("View"
  2153. ["Day View" org-agenda-day-view
  2154. :active (org-agenda-check-type nil 'agenda)
  2155. :style radio :selected (eq org-agenda-current-span 'day)
  2156. :keys "v d (or just d)"]
  2157. ["Week View" org-agenda-week-view
  2158. :active (org-agenda-check-type nil 'agenda)
  2159. :style radio :selected (eq org-agenda-current-span 'week)
  2160. :keys "v w"]
  2161. ["Fortnight View" org-agenda-fortnight-view
  2162. :active (org-agenda-check-type nil 'agenda)
  2163. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2164. :keys "v t"]
  2165. ["Month View" org-agenda-month-view
  2166. :active (org-agenda-check-type nil 'agenda)
  2167. :style radio :selected (eq org-agenda-current-span 'month)
  2168. :keys "v m"]
  2169. ["Year View" org-agenda-year-view
  2170. :active (org-agenda-check-type nil 'agenda)
  2171. :style radio :selected (eq org-agenda-current-span 'year)
  2172. :keys "v y"]
  2173. "--"
  2174. ["Include Diary" org-agenda-toggle-diary
  2175. :style toggle :selected org-agenda-include-diary
  2176. :active (org-agenda-check-type nil 'agenda)]
  2177. ["Include Deadlines" org-agenda-toggle-deadlines
  2178. :style toggle :selected org-agenda-include-deadlines
  2179. :active (org-agenda-check-type nil 'agenda)]
  2180. ["Use Time Grid" org-agenda-toggle-time-grid
  2181. :style toggle :selected org-agenda-use-time-grid
  2182. :active (org-agenda-check-type nil 'agenda)]
  2183. "--"
  2184. ["Show clock report" org-agenda-clockreport-mode
  2185. :style toggle :selected org-agenda-clockreport-mode
  2186. :active (org-agenda-check-type nil 'agenda)]
  2187. ["Show some entry text" org-agenda-entry-text-mode
  2188. :style toggle :selected org-agenda-entry-text-mode
  2189. :active t]
  2190. "--"
  2191. ["Show Logbook entries" org-agenda-log-mode
  2192. :style toggle :selected org-agenda-show-log
  2193. :active (org-agenda-check-type nil 'agenda)
  2194. :keys "v l (or just l)"]
  2195. ["Include archived trees" org-agenda-archives-mode
  2196. :style toggle :selected org-agenda-archives-mode :active t
  2197. :keys "v a"]
  2198. ["Include archive files" (org-agenda-archives-mode t)
  2199. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2200. :keys "v A"]
  2201. "--"
  2202. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2203. ["Write view to file" org-agenda-write t]
  2204. ["Rebuild buffer" org-agenda-redo t]
  2205. ["Save all Org buffers" org-save-all-org-buffers t]
  2206. "--"
  2207. ["Show original entry" org-agenda-show t]
  2208. ["Go To (other window)" org-agenda-goto t]
  2209. ["Go To (this window)" org-agenda-switch-to t]
  2210. ["Capture with cursor date" org-agenda-capture t]
  2211. ["Follow Mode" org-agenda-follow-mode
  2212. :style toggle :selected org-agenda-follow-mode :active t]
  2213. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2214. "--"
  2215. ("TODO"
  2216. ["Cycle TODO" org-agenda-todo t]
  2217. ["Next TODO set" org-agenda-todo-nextset t]
  2218. ["Previous TODO set" org-agenda-todo-previousset t]
  2219. ["Add note" org-agenda-add-note t])
  2220. ("Archive/Refile/Delete"
  2221. ["Archive default" org-agenda-archive-default t]
  2222. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2223. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2224. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2225. ["Archive subtree" org-agenda-archive t]
  2226. "--"
  2227. ["Refile" org-agenda-refile t]
  2228. "--"
  2229. ["Delete subtree" org-agenda-kill t])
  2230. ("Bulk action"
  2231. ["Mark entry" org-agenda-bulk-mark t]
  2232. ["Mark all" org-agenda-bulk-mark-all t]
  2233. ["Unmark entry" org-agenda-bulk-unmark t]
  2234. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2235. ["Toggle mark" org-agenda-bulk-toggle t]
  2236. ["Toggle all" org-agenda-bulk-toggle-all t]
  2237. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2238. ["Act on all marked" org-agenda-bulk-action t]
  2239. "--"
  2240. ("Tags and Properties"
  2241. ["Show all Tags" org-agenda-show-tags t]
  2242. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2243. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2244. "--"
  2245. ["Column View" org-columns t])
  2246. ("Deadline/Schedule"
  2247. ["Schedule" org-agenda-schedule t]
  2248. ["Set Deadline" org-agenda-deadline t]
  2249. "--"
  2250. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2251. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2252. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2253. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2254. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2255. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2256. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2257. ("Clock and Effort"
  2258. ["Clock in" org-agenda-clock-in t]
  2259. ["Clock out" org-agenda-clock-out t]
  2260. ["Clock cancel" org-agenda-clock-cancel t]
  2261. ["Goto running clock" org-clock-goto t]
  2262. "--"
  2263. ["Set Effort" org-agenda-set-effort t]
  2264. ["Change clocked effort" org-clock-modify-effort-estimate
  2265. (org-clock-is-active)])
  2266. ("Priority"
  2267. ["Set Priority" org-agenda-priority t]
  2268. ["Increase Priority" org-agenda-priority-up t]
  2269. ["Decrease Priority" org-agenda-priority-down t]
  2270. ["Show Priority" org-show-priority t])
  2271. ("Calendar/Diary"
  2272. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2273. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2274. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2275. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2276. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2277. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2278. "--"
  2279. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2280. "--"
  2281. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2282. "--"
  2283. ("MobileOrg"
  2284. ["Push Files and Views" org-mobile-push t]
  2285. ["Get Captured and Flagged" org-mobile-pull t]
  2286. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2287. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2288. "--"
  2289. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2290. "--"
  2291. ["Quit" org-agenda-quit t]
  2292. ["Exit and Release Buffers" org-agenda-exit t]
  2293. ))
  2294. ;;; Agenda undo
  2295. (defvar org-agenda-allow-remote-undo t
  2296. "Non-nil means allow remote undo from the agenda buffer.")
  2297. (defvar org-agenda-undo-has-started-in nil
  2298. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2299. (defun org-agenda-undo ()
  2300. "Undo a remote editing step in the agenda.
  2301. This undoes changes both in the agenda buffer and in the remote buffer
  2302. that have been changed along."
  2303. (interactive)
  2304. (or org-agenda-allow-remote-undo
  2305. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2306. (when (not (eq this-command last-command))
  2307. (setq org-agenda-undo-has-started-in nil
  2308. org-agenda-pending-undo-list org-agenda-undo-list))
  2309. (when (not org-agenda-pending-undo-list)
  2310. (user-error "No further undo information"))
  2311. (let* ((entry (pop org-agenda-pending-undo-list))
  2312. buf line cmd rembuf)
  2313. (setq cmd (pop entry) line (pop entry))
  2314. (setq rembuf (nth 2 entry))
  2315. (org-with-remote-undo rembuf
  2316. (while (bufferp (setq buf (pop entry)))
  2317. (when (pop entry)
  2318. (with-current-buffer buf
  2319. (let ((last-undo-buffer buf)
  2320. (inhibit-read-only t))
  2321. (unless (memq buf org-agenda-undo-has-started-in)
  2322. (push buf org-agenda-undo-has-started-in)
  2323. (make-local-variable 'pending-undo-list)
  2324. (undo-start))
  2325. (while (and pending-undo-list
  2326. (listp pending-undo-list)
  2327. (not (car pending-undo-list)))
  2328. (pop pending-undo-list))
  2329. (undo-more 1))))))
  2330. (org-goto-line line)
  2331. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2332. (defun org-verify-change-for-undo (l1 l2)
  2333. "Verify that a real change occurred between the undo lists L1 and L2."
  2334. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2335. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2336. (not (eq l1 l2)))
  2337. ;;; Agenda dispatch
  2338. (defvar org-agenda-restrict-begin (make-marker))
  2339. (defvar org-agenda-restrict-end (make-marker))
  2340. (defvar org-agenda-last-dispatch-buffer nil)
  2341. (defvar org-agenda-overriding-restriction nil)
  2342. (defcustom org-agenda-custom-commands-contexts nil
  2343. "Alist of custom agenda keys and contextual rules.
  2344. For example, if you have a custom agenda command \"p\" and you
  2345. want this command to be accessible only from plain text files,
  2346. use this:
  2347. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2348. Here are the available contexts definitions:
  2349. in-file: command displayed only in matching files
  2350. in-mode: command displayed only in matching modes
  2351. not-in-file: command not displayed in matching files
  2352. not-in-mode: command not displayed in matching modes
  2353. in-buffer: command displayed only in matching buffers
  2354. not-in-buffer: command not displayed in matching buffers
  2355. [function]: a custom function taking no argument
  2356. If you define several checks, the agenda command will be
  2357. accessible if there is at least one valid check.
  2358. You can also bind a key to another agenda custom command
  2359. depending on contextual rules.
  2360. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2361. Here it means: in .txt files, use \"p\" as the key for the
  2362. agenda command otherwise associated with \"q\". (The command
  2363. originally associated with \"q\" is not displayed to avoid
  2364. duplicates.)"
  2365. :version "24.3"
  2366. :group 'org-agenda-custom-commands
  2367. :type '(repeat (list :tag "Rule"
  2368. (string :tag " Agenda key")
  2369. (string :tag "Replace by command")
  2370. (repeat :tag "Available when"
  2371. (choice
  2372. (cons :tag "Condition"
  2373. (choice
  2374. (const :tag "In file" in-file)
  2375. (const :tag "Not in file" not-in-file)
  2376. (const :tag "In buffer" in-buffer)
  2377. (const :tag "Not in buffer" not-in-buffer)
  2378. (const :tag "In mode" in-mode)
  2379. (const :tag "Not in mode" not-in-mode))
  2380. (regexp))
  2381. (function :tag "Custom function"))))))
  2382. (defcustom org-agenda-max-entries nil
  2383. "Maximum number of entries to display in an agenda.
  2384. This can be nil (no limit) or an integer or an alist of agenda
  2385. types with an associated number of entries to display in this
  2386. type."
  2387. :version "24.4"
  2388. :package-version '(Org . "8.0")
  2389. :group 'org-agenda-custom-commands
  2390. :type '(choice (symbol :tag "No limit" nil)
  2391. (integer :tag "Max number of entries")
  2392. (repeat
  2393. (cons (choice :tag "Agenda type"
  2394. (const agenda)
  2395. (const todo)
  2396. (const tags)
  2397. (const search))
  2398. (integer :tag "Max number of entries")))))
  2399. (defcustom org-agenda-max-todos nil
  2400. "Maximum number of TODOs to display in an agenda.
  2401. This can be nil (no limit) or an integer or an alist of agenda
  2402. types with an associated number of entries to display in this
  2403. type."
  2404. :version "24.4"
  2405. :package-version '(Org . "8.0")
  2406. :group 'org-agenda-custom-commands
  2407. :type '(choice (symbol :tag "No limit" nil)
  2408. (integer :tag "Max number of TODOs")
  2409. (repeat
  2410. (cons (choice :tag "Agenda type"
  2411. (const agenda)
  2412. (const todo)
  2413. (const tags)
  2414. (const search))
  2415. (integer :tag "Max number of TODOs")))))
  2416. (defcustom org-agenda-max-tags nil
  2417. "Maximum number of tagged entries to display in an agenda.
  2418. This can be nil (no limit) or an integer or an alist of agenda
  2419. types with an associated number of entries to display in this
  2420. type."
  2421. :version "24.4"
  2422. :package-version '(Org . "8.0")
  2423. :group 'org-agenda-custom-commands
  2424. :type '(choice (symbol :tag "No limit" nil)
  2425. (integer :tag "Max number of tagged entries")
  2426. (repeat
  2427. (cons (choice :tag "Agenda type"
  2428. (const agenda)
  2429. (const todo)
  2430. (const tags)
  2431. (const search))
  2432. (integer :tag "Max number of tagged entries")))))
  2433. (defcustom org-agenda-max-effort nil
  2434. "Maximum cumulated effort duration for the agenda.
  2435. This can be nil (no limit) or a number of minutes (as an integer)
  2436. or an alist of agenda types with an associated number of minutes
  2437. to limit entries to in this type."
  2438. :version "24.4"
  2439. :package-version '(Org . "8.0")
  2440. :group 'org-agenda-custom-commands
  2441. :type '(choice (symbol :tag "No limit" nil)
  2442. (integer :tag "Max number of minutes")
  2443. (repeat
  2444. (cons (choice :tag "Agenda type"
  2445. (const agenda)
  2446. (const todo)
  2447. (const tags)
  2448. (const search))
  2449. (integer :tag "Max number of minutes")))))
  2450. (defvar org-agenda-keep-restricted-file-list nil)
  2451. (defvar org-keys nil)
  2452. (defvar org-match nil)
  2453. ;;;###autoload
  2454. (defun org-agenda (&optional arg org-keys restriction)
  2455. "Dispatch agenda commands to collect entries to the agenda buffer.
  2456. Prompts for a command to execute. Any prefix arg will be passed
  2457. on to the selected command. The default selections are:
  2458. a Call `org-agenda-list' to display the agenda for current day or week.
  2459. t Call `org-todo-list' to display the global todo list.
  2460. T Call `org-todo-list' to display the global todo list, select only
  2461. entries with a specific TODO keyword (the user gets a prompt).
  2462. m Call `org-tags-view' to display headlines with tags matching
  2463. a condition (the user is prompted for the condition).
  2464. M Like `m', but select only TODO entries, no ordinary headlines.
  2465. e Export views to associated files.
  2466. s Search entries for keywords.
  2467. S Search entries for keywords, only with TODO keywords.
  2468. / Multi occur across all agenda files and also files listed
  2469. in `org-agenda-text-search-extra-files'.
  2470. < Restrict agenda commands to buffer, subtree, or region.
  2471. Press several times to get the desired effect.
  2472. > Remove a previous restriction.
  2473. # List \"stuck\" projects.
  2474. ! Configure what \"stuck\" means.
  2475. C Configure custom agenda commands.
  2476. More commands can be added by configuring the variable
  2477. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2478. searches can be pre-defined in this way.
  2479. If the current buffer is in Org mode and visiting a file, you can also
  2480. first press `<' once to indicate that the agenda should be temporarily
  2481. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2482. Pressing `<' twice means to restrict to the current subtree or region
  2483. \(if active)."
  2484. (interactive "P")
  2485. (catch 'exit
  2486. (let* ((prefix-descriptions nil)
  2487. (org-agenda-buffer-name org-agenda-buffer-name)
  2488. (org-agenda-window-setup (if (equal (buffer-name)
  2489. org-agenda-buffer-name)
  2490. 'current-window
  2491. org-agenda-window-setup))
  2492. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2493. (org-agenda-custom-commands
  2494. ;; normalize different versions
  2495. (delq nil
  2496. (mapcar
  2497. (lambda (x)
  2498. (cond ((stringp (cdr x))
  2499. (push x prefix-descriptions)
  2500. nil)
  2501. ((stringp (nth 1 x)) x)
  2502. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2503. (t (cons (car x) (cons "" (cdr x))))))
  2504. org-agenda-custom-commands)))
  2505. (org-agenda-custom-commands
  2506. (org-contextualize-keys
  2507. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2508. (buf (current-buffer))
  2509. (bfn (buffer-file-name (buffer-base-buffer)))
  2510. entry key type org-match lprops ans)
  2511. ;; Turn off restriction unless there is an overriding one,
  2512. (unless org-agenda-overriding-restriction
  2513. (unless org-agenda-keep-restricted-file-list
  2514. ;; There is a request to keep the file list in place
  2515. (put 'org-agenda-files 'org-restrict nil))
  2516. (setq org-agenda-restrict nil)
  2517. (move-marker org-agenda-restrict-begin nil)
  2518. (move-marker org-agenda-restrict-end nil))
  2519. ;; Delete old local properties
  2520. (put 'org-agenda-redo-command 'org-lprops nil)
  2521. ;; Delete previously set last-arguments
  2522. (put 'org-agenda-redo-command 'last-args nil)
  2523. ;; Remember where this call originated
  2524. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2525. (unless org-keys
  2526. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2527. org-keys (car ans)
  2528. restriction (cdr ans)))
  2529. ;; If we have sticky agenda buffers, set a name for the buffer,
  2530. ;; depending on the invoking keys. The user may still set this
  2531. ;; as a command option, which will overwrite what we do here.
  2532. (when org-agenda-sticky
  2533. (setq org-agenda-buffer-name
  2534. (format "*Org Agenda(%s)*" org-keys)))
  2535. ;; Establish the restriction, if any
  2536. (when (and (not org-agenda-overriding-restriction) restriction)
  2537. (put 'org-agenda-files 'org-restrict (list bfn))
  2538. (cond
  2539. ((eq restriction 'region)
  2540. (setq org-agenda-restrict (current-buffer))
  2541. (move-marker org-agenda-restrict-begin (region-beginning))
  2542. (move-marker org-agenda-restrict-end (region-end)))
  2543. ((eq restriction 'subtree)
  2544. (save-excursion
  2545. (setq org-agenda-restrict (current-buffer))
  2546. (org-back-to-heading t)
  2547. (move-marker org-agenda-restrict-begin (point))
  2548. (move-marker org-agenda-restrict-end
  2549. (progn (org-end-of-subtree t)))))))
  2550. ;; For example the todo list should not need it (but does...)
  2551. (cond
  2552. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2553. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2554. (progn
  2555. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2556. lprops (nth 4 entry))
  2557. (when org-agenda-sticky
  2558. (setq org-agenda-buffer-name
  2559. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2560. (format "*Org Agenda(%s)*" org-keys))))
  2561. (put 'org-agenda-redo-command 'org-lprops lprops)
  2562. (cond
  2563. ((eq type 'agenda)
  2564. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2565. ((eq type 'agenda*)
  2566. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2567. ((eq type 'alltodo)
  2568. (org-let lprops '(org-todo-list current-prefix-arg)))
  2569. ((eq type 'search)
  2570. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2571. ((eq type 'stuck)
  2572. (org-let lprops '(org-agenda-list-stuck-projects
  2573. current-prefix-arg)))
  2574. ((eq type 'tags)
  2575. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2576. ((eq type 'tags-todo)
  2577. (org-let lprops '(org-tags-view '(4) org-match)))
  2578. ((eq type 'todo)
  2579. (org-let lprops '(org-todo-list org-match)))
  2580. ((eq type 'tags-tree)
  2581. (org-check-for-org-mode)
  2582. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2583. ((eq type 'todo-tree)
  2584. (org-check-for-org-mode)
  2585. (org-let lprops
  2586. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2587. (regexp-quote org-match) "\\>"))))
  2588. ((eq type 'occur-tree)
  2589. (org-check-for-org-mode)
  2590. (org-let lprops '(org-occur org-match)))
  2591. ((functionp type)
  2592. (org-let lprops '(funcall type org-match)))
  2593. ((fboundp type)
  2594. (org-let lprops '(funcall type org-match)))
  2595. (t (user-error "Invalid custom agenda command type %s" type))))
  2596. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2597. ((equal org-keys "C")
  2598. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2599. (customize-variable 'org-agenda-custom-commands))
  2600. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2601. ((equal org-keys "s") (call-interactively 'org-search-view))
  2602. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2603. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2604. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2605. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2606. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2607. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2608. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2609. (add-hook
  2610. 'post-command-hook
  2611. (lambda ()
  2612. (unless (current-message)
  2613. (let* ((m (org-agenda-get-any-marker))
  2614. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2615. (when note
  2616. (message "FLAGGING-NOTE ([?] for more info): %s"
  2617. (org-add-props
  2618. (replace-regexp-in-string
  2619. "\\\\n" "//"
  2620. (copy-sequence note))
  2621. nil 'face 'org-warning))))))
  2622. t t))
  2623. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2624. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2625. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2626. (t (user-error "Invalid agenda key"))))))
  2627. (defvar org-agenda-multi)
  2628. (defun org-agenda-append-agenda ()
  2629. "Append another agenda view to the current one.
  2630. This function allows interactive building of block agendas.
  2631. Agenda views are separated by `org-agenda-block-separator'."
  2632. (interactive)
  2633. (unless (derived-mode-p 'org-agenda-mode)
  2634. (user-error "Can only append from within agenda buffer"))
  2635. (let ((org-agenda-multi t))
  2636. (org-agenda)
  2637. (widen)
  2638. (org-agenda-finalize)
  2639. (setq buffer-read-only t)
  2640. (org-agenda-fit-window-to-buffer)))
  2641. (defun org-agenda-normalize-custom-commands (cmds)
  2642. "Normalize custom commands CMDS."
  2643. (delq nil
  2644. (mapcar
  2645. (lambda (x)
  2646. (cond ((stringp (cdr x)) nil)
  2647. ((stringp (nth 1 x)) x)
  2648. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2649. (t (cons (car x) (cons "" (cdr x))))))
  2650. cmds)))
  2651. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2652. "The user interface for selecting an agenda command."
  2653. (catch 'exit
  2654. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2655. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2656. (region-p (org-region-active-p))
  2657. (custom org-agenda-custom-commands)
  2658. (selstring "")
  2659. restriction second-time
  2660. c entry key type match prefixes rmheader header-end custom1 desc
  2661. line lines left right n n1)
  2662. (save-window-excursion
  2663. (delete-other-windows)
  2664. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2665. (erase-buffer)
  2666. (insert (eval-when-compile
  2667. (let ((header
  2668. "Press key for an agenda command:
  2669. -------------------------------- < Buffer, subtree/region restriction
  2670. a Agenda for current week or day > Remove restriction
  2671. t List of all TODO entries e Export agenda views
  2672. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2673. s Search for keywords M Like m, but only TODO entries
  2674. / Multi-occur S Like s, but only TODO entries
  2675. ? Find :FLAGGED: entries C Configure custom agenda commands
  2676. * Toggle sticky agenda views # List stuck projects (!=configure)
  2677. ")
  2678. (start 0))
  2679. (while (string-match
  2680. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2681. header start)
  2682. (setq start (match-end 0))
  2683. (add-text-properties (match-beginning 2) (match-end 2)
  2684. '(face bold) header))
  2685. header)))
  2686. (setq header-end (point-marker))
  2687. (while t
  2688. (setq custom1 custom)
  2689. (when (eq rmheader t)
  2690. (org-goto-line 1)
  2691. (re-search-forward ":" nil t)
  2692. (delete-region (match-end 0) (point-at-eol))
  2693. (forward-char 1)
  2694. (looking-at "-+")
  2695. (delete-region (match-end 0) (point-at-eol))
  2696. (move-marker header-end (match-end 0)))
  2697. (goto-char header-end)
  2698. (delete-region (point) (point-max))
  2699. ;; Produce all the lines that describe custom commands and prefixes
  2700. (setq lines nil)
  2701. (while (setq entry (pop custom1))
  2702. (setq key (car entry) desc (nth 1 entry)
  2703. type (nth 2 entry)
  2704. match (nth 3 entry))
  2705. (if (> (length key) 1)
  2706. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2707. (setq line
  2708. (format
  2709. "%-4s%-14s"
  2710. (org-add-props (copy-sequence key)
  2711. '(face bold))
  2712. (cond
  2713. ((string-match "\\S-" desc) desc)
  2714. ((eq type 'agenda) "Agenda for current week or day")
  2715. ((eq type 'agenda*) "Appointments for current week or day")
  2716. ((eq type 'alltodo) "List of all TODO entries")
  2717. ((eq type 'search) "Word search")
  2718. ((eq type 'stuck) "List of stuck projects")
  2719. ((eq type 'todo) "TODO keyword")
  2720. ((eq type 'tags) "Tags query")
  2721. ((eq type 'tags-todo) "Tags (TODO)")
  2722. ((eq type 'tags-tree) "Tags tree")
  2723. ((eq type 'todo-tree) "TODO kwd tree")
  2724. ((eq type 'occur-tree) "Occur tree")
  2725. ((functionp type) (if (symbolp type)
  2726. (symbol-name type)
  2727. "Lambda expression"))
  2728. (t "???"))))
  2729. (cond
  2730. ((not (org-string-nw-p match)) nil)
  2731. (org-agenda-menu-show-matcher
  2732. (setq line
  2733. (concat line ": "
  2734. (cond
  2735. ((stringp match)
  2736. (propertize match 'face 'org-warning))
  2737. ((listp type)
  2738. (format "set of %d commands" (length type)))))))
  2739. (t
  2740. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2741. (push line lines)))
  2742. (setq lines (nreverse lines))
  2743. (when prefixes
  2744. (mapc (lambda (x)
  2745. (push
  2746. (format "%s %s"
  2747. (org-add-props (char-to-string x)
  2748. nil 'face 'bold)
  2749. (or (cdr (assoc (concat selstring
  2750. (char-to-string x))
  2751. prefix-descriptions))
  2752. "Prefix key"))
  2753. lines))
  2754. prefixes))
  2755. ;; Check if we should display in two columns
  2756. (if org-agenda-menu-two-columns
  2757. (progn
  2758. (setq n (length lines)
  2759. n1 (+ (/ n 2) (mod n 2))
  2760. right (nthcdr n1 lines)
  2761. left (copy-sequence lines))
  2762. (setcdr (nthcdr (1- n1) left) nil))
  2763. (setq left lines right nil))
  2764. (while left
  2765. (insert "\n" (pop left))
  2766. (when right
  2767. (if (< (current-column) 40)
  2768. (move-to-column 40 t)
  2769. (insert " "))
  2770. (insert (pop right))))
  2771. ;; Make the window the right size
  2772. (goto-char (point-min))
  2773. (if second-time
  2774. (when (not (pos-visible-in-window-p (point-max)))
  2775. (org-fit-window-to-buffer))
  2776. (setq second-time t)
  2777. (org-fit-window-to-buffer))
  2778. ;; Ask for selection
  2779. (message "Press key for agenda command%s:"
  2780. (if (or restrict-ok org-agenda-overriding-restriction)
  2781. (if org-agenda-overriding-restriction
  2782. " (restriction lock active)"
  2783. (if restriction
  2784. (format " (restricted to %s)" restriction)
  2785. " (unrestricted)"))
  2786. ""))
  2787. (setq c (read-char-exclusive))
  2788. (message "")
  2789. (cond
  2790. ((assoc (char-to-string c) custom)
  2791. (setq selstring (concat selstring (char-to-string c)))
  2792. (throw 'exit (cons selstring restriction)))
  2793. ((memq c prefixes)
  2794. (setq selstring (concat selstring (char-to-string c))
  2795. prefixes nil
  2796. rmheader (or rmheader t)
  2797. custom (delq nil (mapcar
  2798. (lambda (x)
  2799. (if (or (= (length (car x)) 1)
  2800. (/= (string-to-char (car x)) c))
  2801. nil
  2802. (cons (substring (car x) 1) (cdr x))))
  2803. custom))))
  2804. ((eq c ?*)
  2805. (call-interactively 'org-toggle-sticky-agenda)
  2806. (sit-for 2))
  2807. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2808. (message "Restriction is only possible in Org buffers")
  2809. (ding) (sit-for 1))
  2810. ((eq c ?1)
  2811. (org-agenda-remove-restriction-lock 'noupdate)
  2812. (setq restriction 'buffer))
  2813. ((eq c ?0)
  2814. (org-agenda-remove-restriction-lock 'noupdate)
  2815. (setq restriction (if region-p 'region 'subtree)))
  2816. ((eq c ?<)
  2817. (org-agenda-remove-restriction-lock 'noupdate)
  2818. (setq restriction
  2819. (cond
  2820. ((eq restriction 'buffer)
  2821. (if region-p 'region 'subtree))
  2822. ((memq restriction '(subtree region))
  2823. nil)
  2824. (t 'buffer))))
  2825. ((eq c ?>)
  2826. (org-agenda-remove-restriction-lock 'noupdate)
  2827. (setq restriction nil))
  2828. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2829. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2830. ((and (> (length selstring) 0) (eq c ?\d))
  2831. (delete-window)
  2832. (org-agenda-get-restriction-and-command prefix-descriptions))
  2833. ((equal c ?q) (error "Abort"))
  2834. (t (user-error "Invalid key %c" c))))))))
  2835. (defun org-agenda-fit-window-to-buffer ()
  2836. "Fit the window to the buffer size."
  2837. (and (memq org-agenda-window-setup '(reorganize-frame))
  2838. (fboundp 'fit-window-to-buffer)
  2839. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2840. (= (car org-agenda-window-frame-fractions) 1.0))
  2841. (delete-other-windows)
  2842. (org-fit-window-to-buffer
  2843. nil
  2844. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2845. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2846. (defvar org-cmd nil)
  2847. (defvar org-agenda-overriding-cmd nil)
  2848. (defvar org-agenda-overriding-arguments nil)
  2849. (defvar org-agenda-overriding-cmd-arguments nil)
  2850. (defun org-agenda-run-series (name series)
  2851. "Run agenda NAME as a SERIES of agenda commands."
  2852. (org-let (nth 1 series) '(org-agenda-prepare name))
  2853. ;; We need to reset agenda markers here, because when constructing a
  2854. ;; block agenda, the individual blocks do not do that.
  2855. (org-agenda-reset-markers)
  2856. (let* ((org-agenda-multi t)
  2857. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2858. (cmds (car series))
  2859. (gprops (nth 1 series))
  2860. match ;; The byte compiler incorrectly complains about this. Keep it!
  2861. org-cmd type lprops)
  2862. (while (setq org-cmd (pop cmds))
  2863. (setq type (car org-cmd))
  2864. (setq match (eval (nth 1 org-cmd)))
  2865. (setq lprops (nth 2 org-cmd))
  2866. (let ((org-agenda-overriding-arguments
  2867. (if (eq org-agenda-overriding-cmd org-cmd)
  2868. (or org-agenda-overriding-arguments
  2869. org-agenda-overriding-cmd-arguments))))
  2870. (cond
  2871. ((eq type 'agenda)
  2872. (org-let2 gprops lprops
  2873. '(call-interactively 'org-agenda-list)))
  2874. ((eq type 'agenda*)
  2875. (org-let2 gprops lprops
  2876. '(funcall 'org-agenda-list nil nil t)))
  2877. ((eq type 'alltodo)
  2878. (org-let2 gprops lprops
  2879. '(call-interactively 'org-todo-list)))
  2880. ((eq type 'search)
  2881. (org-let2 gprops lprops
  2882. '(org-search-view current-prefix-arg match nil)))
  2883. ((eq type 'stuck)
  2884. (org-let2 gprops lprops
  2885. '(call-interactively 'org-agenda-list-stuck-projects)))
  2886. ((eq type 'tags)
  2887. (org-let2 gprops lprops
  2888. '(org-tags-view current-prefix-arg match)))
  2889. ((eq type 'tags-todo)
  2890. (org-let2 gprops lprops
  2891. '(org-tags-view '(4) match)))
  2892. ((eq type 'todo)
  2893. (org-let2 gprops lprops
  2894. '(org-todo-list match)))
  2895. ((fboundp type)
  2896. (org-let2 gprops lprops
  2897. '(funcall type match)))
  2898. (t (error "Invalid type in command series")))))
  2899. (widen)
  2900. (let ((inhibit-read-only t))
  2901. (add-text-properties (point-min) (point-max)
  2902. `(org-series t org-series-redo-cmd ,redo)))
  2903. (setq org-agenda-redo-command redo)
  2904. (goto-char (point-min)))
  2905. (org-agenda-fit-window-to-buffer)
  2906. (org-let (nth 1 series) '(org-agenda-finalize)))
  2907. ;;;###autoload
  2908. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2909. "Run an agenda command in batch mode and send the result to STDOUT.
  2910. If CMD-KEY is a string of length 1, it is used as a key in
  2911. `org-agenda-custom-commands' and triggers this command. If it is a
  2912. longer string it is used as a tags/todo match string.
  2913. Parameters are alternating variable names and values that will be bound
  2914. before running the agenda command."
  2915. (org-eval-in-environment (org-make-parameter-alist parameters)
  2916. (let (org-agenda-sticky)
  2917. (if (> (length cmd-key) 1)
  2918. (org-tags-view nil cmd-key)
  2919. (org-agenda nil cmd-key))))
  2920. (set-buffer org-agenda-buffer-name)
  2921. (princ (buffer-string)))
  2922. (defvar org-agenda-info nil)
  2923. ;;;###autoload
  2924. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2925. "Run an agenda command in batch mode and send the result to STDOUT.
  2926. If CMD-KEY is a string of length 1, it is used as a key in
  2927. `org-agenda-custom-commands' and triggers this command. If it is a
  2928. longer string it is used as a tags/todo match string.
  2929. Parameters are alternating variable names and values that will be bound
  2930. before running the agenda command.
  2931. The output gives a line for each selected agenda item. Each
  2932. item is a list of comma-separated values, like this:
  2933. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2934. category The category of the item
  2935. head The headline, without TODO kwd, TAGS and PRIORITY
  2936. type The type of the agenda entry, can be
  2937. todo selected in TODO match
  2938. tagsmatch selected in tags match
  2939. diary imported from diary
  2940. deadline a deadline on given date
  2941. scheduled scheduled on given date
  2942. timestamp entry has timestamp on given date
  2943. closed entry was closed on given date
  2944. upcoming-deadline warning about deadline
  2945. past-scheduled forwarded scheduled item
  2946. block entry has date block including g. date
  2947. todo The todo keyword, if any
  2948. tags All tags including inherited ones, separated by colons
  2949. date The relevant date, like 2007-2-14
  2950. time The time, like 15:00-16:50
  2951. extra Sting with extra planning info
  2952. priority-l The priority letter if any was given
  2953. priority-n The computed numerical priority
  2954. agenda-day The day in the agenda where this is listed"
  2955. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2956. (org-make-parameter-alist parameters))
  2957. (if (> (length cmd-key) 2)
  2958. (org-tags-view nil cmd-key)
  2959. (org-agenda nil cmd-key)))
  2960. (set-buffer org-agenda-buffer-name)
  2961. (let ((lines (org-split-string (buffer-string) "\n")))
  2962. (dolist (line lines)
  2963. (when (get-text-property 0 'org-category line)
  2964. (setq org-agenda-info
  2965. (org-fix-agenda-info (text-properties-at 0 line)))
  2966. (princ
  2967. (mapconcat 'org-agenda-export-csv-mapper
  2968. '(org-category txt type todo tags date time extra
  2969. priority-letter priority agenda-day)
  2970. ","))
  2971. (princ "\n")))))
  2972. (defun org-fix-agenda-info (props)
  2973. "Make sure all properties on an agenda item have a canonical form.
  2974. This ensures the export commands can easily use it."
  2975. (let (tmp re)
  2976. (when (setq tmp (plist-get props 'tags))
  2977. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2978. (when (setq tmp (plist-get props 'date))
  2979. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2980. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2981. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2982. (setq tmp (calendar-date-string tmp)))
  2983. (setq props (plist-put props 'date tmp)))
  2984. (when (setq tmp (plist-get props 'day))
  2985. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2986. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2987. (setq tmp (calendar-date-string tmp)))
  2988. (setq props (plist-put props 'day tmp))
  2989. (setq props (plist-put props 'agenda-day tmp)))
  2990. (when (setq tmp (plist-get props 'txt))
  2991. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2992. (plist-put props 'priority-letter (match-string 1 tmp))
  2993. (setq tmp (replace-match "" t t tmp)))
  2994. (when (and (setq re (plist-get props 'org-todo-regexp))
  2995. (setq re (concat "\\`\\.*" re " ?"))
  2996. (let ((case-fold-search nil)) (string-match re tmp)))
  2997. (plist-put props 'todo (match-string 1 tmp))
  2998. (setq tmp (replace-match "" t t tmp)))
  2999. (plist-put props 'txt tmp)))
  3000. props)
  3001. (defun org-agenda-export-csv-mapper (prop)
  3002. (let ((res (plist-get org-agenda-info prop)))
  3003. (setq res
  3004. (cond
  3005. ((not res) "")
  3006. ((stringp res) res)
  3007. (t (prin1-to-string res))))
  3008. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3009. ;;;###autoload
  3010. (defun org-store-agenda-views (&rest parameters)
  3011. "Store agenda views."
  3012. (interactive)
  3013. (eval (list 'org-batch-store-agenda-views)))
  3014. ;;;###autoload
  3015. (defmacro org-batch-store-agenda-views (&rest parameters)
  3016. "Run all custom agenda commands that have a file argument."
  3017. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3018. (pop-up-frames nil)
  3019. (dir default-directory)
  3020. (pars (org-make-parameter-alist parameters))
  3021. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3022. (save-window-excursion
  3023. (while cmds
  3024. (setq cmd (pop cmds)
  3025. thiscmdkey (car cmd)
  3026. thiscmdcmd (cdr cmd)
  3027. match (nth 2 thiscmdcmd)
  3028. bufname (if org-agenda-sticky
  3029. (or (and (stringp match)
  3030. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3031. (format "*Org Agenda(%s)*" thiscmdkey))
  3032. org-agenda-buffer-name)
  3033. cmd-or-set (nth 2 cmd)
  3034. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3035. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3036. (if (stringp files) (setq files (list files)))
  3037. (when files
  3038. (org-eval-in-environment (append org-agenda-exporter-settings
  3039. opts pars)
  3040. (org-agenda nil thiscmdkey))
  3041. (set-buffer bufname)
  3042. (while files
  3043. (org-eval-in-environment (append org-agenda-exporter-settings
  3044. opts pars)
  3045. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3046. (and (get-buffer bufname)
  3047. (kill-buffer bufname)))))))
  3048. (defvar org-agenda-current-span nil
  3049. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3050. (defun org-agenda-mark-header-line (pos)
  3051. "Mark the line at POS as an agenda structure header."
  3052. (save-excursion
  3053. (goto-char pos)
  3054. (put-text-property (point-at-bol) (point-at-eol)
  3055. 'org-agenda-structural-header t)
  3056. (when org-agenda-title-append
  3057. (put-text-property (point-at-bol) (point-at-eol)
  3058. 'org-agenda-title-append org-agenda-title-append))))
  3059. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3060. (defvar org-agenda-write-buffer-name "Agenda View")
  3061. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3062. "Write the current buffer (an agenda view) as a file.
  3063. Depending on the extension of the file name, plain text (.txt),
  3064. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3065. If the extension is .ics, translate visible agenda into iCalendar
  3066. format. If the extension is .org, collect all subtrees
  3067. corresponding to the agenda entries and add them in an .org file.
  3068. With prefix argument OPEN, open the new file immediately. If
  3069. NOSETTINGS is given, do not scope the settings of
  3070. `org-agenda-exporter-settings' into the export commands. This is
  3071. used when the settings have already been scoped and we do not
  3072. wish to overrule other, higher priority settings. If
  3073. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3074. the agenda to write."
  3075. (interactive "FWrite agenda to file: \nP")
  3076. (if (or (not (file-writable-p file))
  3077. (and (file-exists-p file)
  3078. (if (called-interactively-p 'any)
  3079. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3080. (user-error "Cannot write agenda to file %s" file))
  3081. (org-let (if nosettings nil org-agenda-exporter-settings)
  3082. '(save-excursion
  3083. (save-window-excursion
  3084. (let ((bs (copy-sequence (buffer-string)))
  3085. (extension (file-name-extension file))
  3086. (default-directory (file-name-directory file))
  3087. beg content)
  3088. (with-temp-buffer
  3089. (rename-buffer org-agenda-write-buffer-name t)
  3090. (set-buffer-modified-p nil)
  3091. (insert bs)
  3092. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3093. (run-hooks 'org-agenda-before-write-hook)
  3094. (cond
  3095. ((bound-and-true-p org-mobile-creating-agendas)
  3096. (org-mobile-write-agenda-for-mobile file))
  3097. ((string= "org" extension)
  3098. (let (content p m message-log-max)
  3099. (goto-char (point-min))
  3100. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3101. (goto-char p)
  3102. (setq m (get-text-property (point) 'org-hd-marker))
  3103. (when m
  3104. (push (save-excursion
  3105. (set-buffer (marker-buffer m))
  3106. (goto-char m)
  3107. (org-copy-subtree 1 nil t t)
  3108. org-subtree-clip)
  3109. content)))
  3110. (find-file file)
  3111. (erase-buffer)
  3112. (dolist (s content) (org-paste-subtree 1 s))
  3113. (write-file file)
  3114. (kill-buffer (current-buffer))
  3115. (message "Org file written to %s" file)))
  3116. ((member extension '("html" "htm"))
  3117. (or (require 'htmlize nil t)
  3118. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3119. (set-buffer (htmlize-buffer (current-buffer)))
  3120. (when org-agenda-export-html-style
  3121. ;; replace <style> section with org-agenda-export-html-style
  3122. (goto-char (point-min))
  3123. (kill-region (- (search-forward "<style") 6)
  3124. (search-forward "</style>"))
  3125. (insert org-agenda-export-html-style))
  3126. (write-file file)
  3127. (kill-buffer (current-buffer))
  3128. (message "HTML written to %s" file))
  3129. ((string= "ps" extension)
  3130. (require 'ps-print)
  3131. (ps-print-buffer-with-faces file)
  3132. (message "Postscript written to %s" file))
  3133. ((string= "pdf" extension)
  3134. (require 'ps-print)
  3135. (ps-print-buffer-with-faces
  3136. (concat (file-name-sans-extension file) ".ps"))
  3137. (call-process "ps2pdf" nil nil nil
  3138. (expand-file-name
  3139. (concat (file-name-sans-extension file) ".ps"))
  3140. (expand-file-name file))
  3141. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3142. (message "PDF written to %s" file))
  3143. ((string= "ics" extension)
  3144. (require 'ox-icalendar)
  3145. (org-icalendar-export-current-agenda (expand-file-name file)))
  3146. (t
  3147. (let ((bs (buffer-string)))
  3148. (find-file file)
  3149. (erase-buffer)
  3150. (insert bs)
  3151. (save-buffer 0)
  3152. (kill-buffer (current-buffer))
  3153. (message "Plain text written to %s" file))))))))
  3154. (set-buffer (or agenda-bufname
  3155. (and (called-interactively-p 'any) (buffer-name))
  3156. org-agenda-buffer-name)))
  3157. (when open (org-open-file file)))
  3158. (defun org-agenda-remove-marked-text (property &optional value)
  3159. "Delete all text marked with VALUE of PROPERTY.
  3160. VALUE defaults to t."
  3161. (let (beg)
  3162. (setq value (or value t))
  3163. (while (setq beg (text-property-any (point-min) (point-max)
  3164. property value))
  3165. (delete-region
  3166. beg (or (next-single-property-change beg property)
  3167. (point-max))))))
  3168. (defun org-agenda-add-entry-text ()
  3169. "Add entry text to agenda lines.
  3170. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3171. entry text following headings shown in the agenda.
  3172. Drawers will be excluded, also the line with scheduling/deadline info."
  3173. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3174. (not (bound-and-true-p org-mobile-creating-agendas)))
  3175. (let (m txt)
  3176. (goto-char (point-min))
  3177. (while (not (eobp))
  3178. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3179. (beginning-of-line 2)
  3180. (setq txt (org-agenda-get-some-entry-text
  3181. m org-agenda-add-entry-text-maxlines " > "))
  3182. (end-of-line 1)
  3183. (if (string-match "\\S-" txt)
  3184. (insert "\n" txt)
  3185. (or (eobp) (forward-char 1))))))))
  3186. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3187. &rest keep)
  3188. "Extract entry text from MARKER, at most N-LINES lines.
  3189. This will ignore drawers etc, just get the text.
  3190. If INDENT is given, prefix every line with this string. If KEEP is
  3191. given, it is a list of symbols, defining stuff that should not be
  3192. removed from the entry content. Currently only `planning' is allowed here."
  3193. (let (txt drawer-re kwd-time-re ind)
  3194. (save-excursion
  3195. (with-current-buffer (marker-buffer marker)
  3196. (if (not (derived-mode-p 'org-mode))
  3197. (setq txt "")
  3198. (org-with-wide-buffer
  3199. (goto-char marker)
  3200. (end-of-line 1)
  3201. (setq txt (buffer-substring
  3202. (min (1+ (point)) (point-max))
  3203. (progn (outline-next-heading) (point)))
  3204. drawer-re org-drawer-regexp
  3205. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3206. ".*\n?"))
  3207. (with-temp-buffer
  3208. (insert txt)
  3209. (when org-agenda-add-entry-text-descriptive-links
  3210. (goto-char (point-min))
  3211. (while (org-activate-links (point-max))
  3212. (add-text-properties (match-beginning 0) (match-end 0)
  3213. '(face org-link))))
  3214. (goto-char (point-min))
  3215. (while (re-search-forward org-link-bracket-re (point-max) t)
  3216. (set-text-properties (match-beginning 0) (match-end 0)
  3217. nil))
  3218. (goto-char (point-min))
  3219. (while (re-search-forward drawer-re nil t)
  3220. (delete-region
  3221. (match-beginning 0)
  3222. (progn (re-search-forward
  3223. "^[ \t]*:END:.*\n?" nil 'move)
  3224. (point))))
  3225. (unless (member 'planning keep)
  3226. (goto-char (point-min))
  3227. (while (re-search-forward kwd-time-re nil t)
  3228. (replace-match "")))
  3229. (goto-char (point-min))
  3230. (when org-agenda-entry-text-exclude-regexps
  3231. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3232. (while (setq re (pop re-list))
  3233. (goto-char (point-min))
  3234. (while (re-search-forward re nil t)
  3235. (replace-match "")))))
  3236. (goto-char (point-max))
  3237. (skip-chars-backward " \t\n")
  3238. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3239. ;; find and remove min common indentation
  3240. (goto-char (point-min))
  3241. (untabify (point-min) (point-max))
  3242. (setq ind (current-indentation))
  3243. (while (not (eobp))
  3244. (unless (looking-at "[ \t]*$")
  3245. (setq ind (min ind (current-indentation))))
  3246. (beginning-of-line 2))
  3247. (goto-char (point-min))
  3248. (while (not (eobp))
  3249. (unless (looking-at "[ \t]*$")
  3250. (move-to-column ind)
  3251. (delete-region (point-at-bol) (point)))
  3252. (beginning-of-line 2))
  3253. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3254. (goto-char (point-min))
  3255. (when indent
  3256. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3257. (replace-match indent t t)))
  3258. (goto-char (point-min))
  3259. (while (looking-at "[ \t]*\n") (replace-match ""))
  3260. (goto-char (point-max))
  3261. (when (> (org-current-line)
  3262. n-lines)
  3263. (org-goto-line (1+ n-lines))
  3264. (backward-char 1))
  3265. (setq txt (buffer-substring (point-min) (point))))))))
  3266. txt))
  3267. (defun org-check-for-org-mode ()
  3268. "Make sure current buffer is in Org mode. Error if not."
  3269. (or (derived-mode-p 'org-mode)
  3270. (error "Cannot execute Org agenda command on buffer in %s"
  3271. major-mode)))
  3272. ;;; Agenda prepare and finalize
  3273. (defvar org-agenda-multi nil) ; dynamically scoped
  3274. (defvar org-agenda-pre-window-conf nil)
  3275. (defvar org-agenda-columns-active nil)
  3276. (defvar org-agenda-name nil)
  3277. (defvar org-agenda-tag-filter nil)
  3278. (defvar org-agenda-category-filter nil)
  3279. (defvar org-agenda-regexp-filter nil)
  3280. (defvar org-agenda-effort-filter nil)
  3281. (defvar org-agenda-top-headline-filter nil)
  3282. (defvar org-agenda-tag-filter-preset nil
  3283. "A preset of the tags filter used for secondary agenda filtering.
  3284. This must be a list of strings, each string must be a single tag preceded
  3285. by \"+\" or \"-\".
  3286. This variable should not be set directly, but agenda custom commands can
  3287. bind it in the options section. The preset filter is a global property of
  3288. the entire agenda view. In a block agenda, it will not work reliably to
  3289. define a filter for one of the individual blocks. You need to set it in
  3290. the global options and expect it to be applied to the entire view.")
  3291. (defvar org-agenda-category-filter-preset nil
  3292. "A preset of the category filter used for secondary agenda filtering.
  3293. This must be a list of strings, each string must be a single category
  3294. preceded by \"+\" or \"-\".
  3295. This variable should not be set directly, but agenda custom commands can
  3296. bind it in the options section. The preset filter is a global property of
  3297. the entire agenda view. In a block agenda, it will not work reliably to
  3298. define a filter for one of the individual blocks. You need to set it in
  3299. the global options and expect it to be applied to the entire view.")
  3300. (defvar org-agenda-regexp-filter-preset nil
  3301. "A preset of the regexp filter used for secondary agenda filtering.
  3302. This must be a list of strings, each string must be a single regexp
  3303. preceded by \"+\" or \"-\".
  3304. This variable should not be set directly, but agenda custom commands can
  3305. bind it in the options section. The preset filter is a global property of
  3306. the entire agenda view. In a block agenda, it will not work reliably to
  3307. define a filter for one of the individual blocks. You need to set it in
  3308. the global options and expect it to be applied to the entire view.")
  3309. (defvar org-agenda-effort-filter-preset nil
  3310. "A preset of the effort condition used for secondary agenda filtering.
  3311. This must be a list of strings, each string must be a single regexp
  3312. preceded by \"+\" or \"-\".
  3313. This variable should not be set directly, but agenda custom commands can
  3314. bind it in the options section. The preset filter is a global property of
  3315. the entire agenda view. In a block agenda, it will not work reliably to
  3316. define a filter for one of the individual blocks. You need to set it in
  3317. the global options and expect it to be applied to the entire view.")
  3318. (defun org-agenda-use-sticky-p ()
  3319. "Return non-nil if an agenda buffer named
  3320. `org-agenda-buffer-name' exists and should be shown instead of
  3321. generating a new one."
  3322. (and
  3323. ;; turned off by user
  3324. org-agenda-sticky
  3325. ;; For multi-agenda buffer already exists
  3326. (not org-agenda-multi)
  3327. ;; buffer found
  3328. (get-buffer org-agenda-buffer-name)
  3329. ;; C-u parameter is same as last call
  3330. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3331. (and
  3332. (equal current-prefix-arg
  3333. org-agenda-last-prefix-arg)
  3334. ;; In case user turned stickiness on, while having existing
  3335. ;; Agenda buffer active, don't reuse that buffer, because it
  3336. ;; does not have org variables local
  3337. org-agenda-this-buffer-is-sticky))))
  3338. (defun org-agenda-prepare-window (abuf filter-alist)
  3339. "Setup agenda buffer in the window.
  3340. ABUF is the buffer for the agenda window.
  3341. FILTER-ALIST is an alist of filters we need to apply when
  3342. `org-agenda-persistent-filter' is non-nil."
  3343. (let* ((awin (get-buffer-window abuf)) wconf)
  3344. (cond
  3345. ((equal (current-buffer) abuf) nil)
  3346. (awin (select-window awin))
  3347. ((not (setq wconf (current-window-configuration))))
  3348. ((eq org-agenda-window-setup 'current-window)
  3349. (pop-to-buffer-same-window abuf))
  3350. ((eq org-agenda-window-setup 'other-window)
  3351. (org-switch-to-buffer-other-window abuf))
  3352. ((eq org-agenda-window-setup 'other-frame)
  3353. (switch-to-buffer-other-frame abuf))
  3354. ((eq org-agenda-window-setup 'only-window)
  3355. (delete-other-windows)
  3356. (pop-to-buffer-same-window abuf))
  3357. ((eq org-agenda-window-setup 'reorganize-frame)
  3358. (delete-other-windows)
  3359. (org-switch-to-buffer-other-window abuf)))
  3360. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3361. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3362. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3363. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3364. ;; Additional test in case agenda is invoked from within agenda
  3365. ;; buffer via elisp link.
  3366. (unless (equal (current-buffer) abuf)
  3367. (pop-to-buffer-same-window abuf))
  3368. (setq org-agenda-pre-window-conf
  3369. (or wconf org-agenda-pre-window-conf))))
  3370. (defun org-agenda-prepare (&optional name)
  3371. (let ((filter-alist (when org-agenda-persistent-filter
  3372. (with-current-buffer
  3373. (get-buffer-create org-agenda-buffer-name)
  3374. `((tag . ,org-agenda-tag-filter)
  3375. (re . ,org-agenda-regexp-filter)
  3376. (effort . ,org-agenda-effort-filter)
  3377. (cat . ,org-agenda-category-filter))))))
  3378. (if (org-agenda-use-sticky-p)
  3379. (progn
  3380. (put 'org-agenda-tag-filter :preset-filter nil)
  3381. (put 'org-agenda-category-filter :preset-filter nil)
  3382. (put 'org-agenda-regexp-filter :preset-filter nil)
  3383. ;; Popup existing buffer
  3384. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3385. filter-alist)
  3386. (message "Sticky Agenda buffer, use `r' to refresh")
  3387. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3388. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3389. (setq org-todo-keywords-for-agenda nil)
  3390. (put 'org-agenda-tag-filter :preset-filter
  3391. org-agenda-tag-filter-preset)
  3392. (put 'org-agenda-category-filter :preset-filter
  3393. org-agenda-category-filter-preset)
  3394. (put 'org-agenda-regexp-filter :preset-filter
  3395. org-agenda-regexp-filter-preset)
  3396. (put 'org-agenda-effort-filter :preset-filter
  3397. org-agenda-effort-filter-preset)
  3398. (if org-agenda-multi
  3399. (progn
  3400. (setq buffer-read-only nil)
  3401. (goto-char (point-max))
  3402. (unless (or (bobp) org-agenda-compact-blocks
  3403. (not org-agenda-block-separator))
  3404. (insert "\n"
  3405. (if (stringp org-agenda-block-separator)
  3406. org-agenda-block-separator
  3407. (make-string (window-width) org-agenda-block-separator))
  3408. "\n"))
  3409. (narrow-to-region (point) (point-max)))
  3410. (setq org-done-keywords-for-agenda nil)
  3411. ;; Setting any org variables that are in org-agenda-local-vars
  3412. ;; list need to be done after the prepare call
  3413. (org-agenda-prepare-window
  3414. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3415. (setq buffer-read-only nil)
  3416. (org-agenda-reset-markers)
  3417. (let ((inhibit-read-only t)) (erase-buffer))
  3418. (org-agenda-mode)
  3419. (setq org-agenda-buffer (current-buffer))
  3420. (setq org-agenda-contributing-files nil)
  3421. (setq org-agenda-columns-active nil)
  3422. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3423. (setq org-todo-keywords-for-agenda
  3424. (org-uniquify org-todo-keywords-for-agenda))
  3425. (setq org-done-keywords-for-agenda
  3426. (org-uniquify org-done-keywords-for-agenda))
  3427. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3428. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3429. (and name (not org-agenda-name)
  3430. (setq-local org-agenda-name name)))
  3431. (setq buffer-read-only nil))))
  3432. (defvar org-overriding-columns-format)
  3433. (defvar org-local-columns-format)
  3434. (defun org-agenda-finalize ()
  3435. "Finishing touch for the agenda buffer, called just before displaying it."
  3436. (unless org-agenda-multi
  3437. (save-excursion
  3438. (let ((inhibit-read-only t))
  3439. (goto-char (point-min))
  3440. (save-excursion
  3441. (while (org-activate-links (point-max))
  3442. (add-text-properties (match-beginning 0) (match-end 0)
  3443. '(face org-link))))
  3444. (unless (eq org-agenda-remove-tags t)
  3445. (org-agenda-align-tags))
  3446. (unless org-agenda-with-colors
  3447. (remove-text-properties (point-min) (point-max) '(face nil)))
  3448. (when (bound-and-true-p org-overriding-columns-format)
  3449. (setq-local org-local-columns-format
  3450. org-overriding-columns-format))
  3451. (when org-agenda-view-columns-initially
  3452. (org-agenda-columns))
  3453. (when org-agenda-fontify-priorities
  3454. (org-agenda-fontify-priorities))
  3455. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3456. (org-agenda-dim-blocked-tasks))
  3457. (org-agenda-mark-clocking-task)
  3458. (when org-agenda-entry-text-mode
  3459. (org-agenda-entry-text-hide)
  3460. (org-agenda-entry-text-show))
  3461. (when (and (featurep 'org-habit)
  3462. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3463. (org-habit-insert-consistency-graphs))
  3464. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3465. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3466. (and (listp org-agenda-show-inherited-tags)
  3467. (memq org-agenda-type org-agenda-show-inherited-tags))
  3468. (and (eq org-agenda-show-inherited-tags t)
  3469. (or (eq org-agenda-use-tag-inheritance t)
  3470. (and (listp org-agenda-use-tag-inheritance)
  3471. (not (memq org-agenda-type
  3472. org-agenda-use-tag-inheritance))))))
  3473. (let (mrk)
  3474. (save-excursion
  3475. (goto-char (point-min))
  3476. (while (equal (forward-line) 0)
  3477. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3478. (put-text-property (point-at-bol) (point-at-eol)
  3479. 'tags
  3480. (org-with-point-at mrk
  3481. (mapcar #'downcase (org-get-tags)))))))))
  3482. (run-hooks 'org-agenda-finalize-hook)
  3483. (when org-agenda-top-headline-filter
  3484. (org-agenda-filter-top-headline-apply
  3485. org-agenda-top-headline-filter))
  3486. (when org-agenda-tag-filter
  3487. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3488. (when (get 'org-agenda-tag-filter :preset-filter)
  3489. (org-agenda-filter-apply
  3490. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3491. (when org-agenda-category-filter
  3492. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3493. (when (get 'org-agenda-category-filter :preset-filter)
  3494. (org-agenda-filter-apply
  3495. (get 'org-agenda-category-filter :preset-filter) 'category))
  3496. (when org-agenda-regexp-filter
  3497. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3498. (when (get 'org-agenda-regexp-filter :preset-filter)
  3499. (org-agenda-filter-apply
  3500. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3501. (when org-agenda-effort-filter
  3502. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3503. (when (get 'org-agenda-effort-filter :preset-filter)
  3504. (org-agenda-filter-apply
  3505. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3506. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3507. (defun org-agenda-mark-clocking-task ()
  3508. "Mark the current clock entry in the agenda if it is present."
  3509. ;; We need to widen when `org-agenda-finalize' is called from
  3510. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3511. (when (bound-and-true-p org-clock-current-task)
  3512. (save-restriction
  3513. (widen)
  3514. (org-agenda-unmark-clocking-task)
  3515. (when (marker-buffer org-clock-hd-marker)
  3516. (save-excursion
  3517. (goto-char (point-min))
  3518. (let (s ov)
  3519. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3520. (goto-char s)
  3521. (when (equal (org-get-at-bol 'org-hd-marker)
  3522. org-clock-hd-marker)
  3523. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3524. (overlay-put ov 'type 'org-agenda-clocking)
  3525. (overlay-put ov 'face 'org-agenda-clocking)
  3526. (overlay-put ov 'help-echo
  3527. "The clock is running in this item")))))))))
  3528. (defun org-agenda-unmark-clocking-task ()
  3529. "Unmark the current clocking task."
  3530. (mapc (lambda (o)
  3531. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3532. (delete-overlay o)))
  3533. (overlays-in (point-min) (point-max))))
  3534. (defun org-agenda-fontify-priorities ()
  3535. "Make highest priority lines bold, and lowest italic."
  3536. (interactive)
  3537. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3538. (delete-overlay o)))
  3539. (overlays-in (point-min) (point-max)))
  3540. (save-excursion
  3541. (let (b e p ov h l)
  3542. (goto-char (point-min))
  3543. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3544. (setq h (or (get-char-property (point) 'org-highest-priority)
  3545. org-highest-priority)
  3546. l (or (get-char-property (point) 'org-lowest-priority)
  3547. org-lowest-priority)
  3548. p (string-to-char (match-string 1))
  3549. b (match-beginning 0)
  3550. e (if (eq org-agenda-fontify-priorities 'cookies)
  3551. (match-end 0)
  3552. (point-at-eol))
  3553. ov (make-overlay b e))
  3554. (overlay-put
  3555. ov 'face
  3556. (let ((special-face
  3557. (cond ((org-face-from-face-or-color
  3558. 'priority 'org-priority
  3559. (cdr (assoc p org-priority-faces))))
  3560. ((and (listp org-agenda-fontify-priorities)
  3561. (org-face-from-face-or-color
  3562. 'priority 'org-priority
  3563. (cdr (assoc p org-agenda-fontify-priorities)))))
  3564. ((equal p l) 'italic)
  3565. ((equal p h) 'bold))))
  3566. (if special-face (list special-face 'org-priority) 'org-priority)))
  3567. (overlay-put ov 'org-type 'org-priority)))))
  3568. (defvar org-depend-tag-blocked)
  3569. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3570. "Dim currently blocked TODOs in the agenda display.
  3571. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3572. dimming them."
  3573. (interactive "P")
  3574. (when (called-interactively-p 'interactive)
  3575. (message "Dim or hide blocked tasks..."))
  3576. (dolist (o (overlays-in (point-min) (point-max)))
  3577. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3578. (delete-overlay o)))
  3579. (save-excursion
  3580. (let ((inhibit-read-only t))
  3581. (goto-char (point-min))
  3582. (while (let ((pos (text-property-not-all
  3583. (point) (point-max) 'org-todo-blocked nil)))
  3584. (when pos (goto-char pos)))
  3585. (let* ((invisible (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3586. (ov (make-overlay (if invisible
  3587. (line-end-position 0)
  3588. (line-beginning-position))
  3589. (line-end-position))))
  3590. (if invisible
  3591. (overlay-put ov 'invisible t)
  3592. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3593. (overlay-put ov 'org-type 'org-blocked-todo))
  3594. (forward-line))))
  3595. (when (called-interactively-p 'interactive)
  3596. (message "Dim or hide blocked tasks...done")))
  3597. (defun org-agenda--mark-blocked-entry (entry)
  3598. "For ENTRY a string with the text property `org-hd-marker', if
  3599. the header at `org-hd-marker' is blocked according to
  3600. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3601. 'invisible and the header is not blocked by checkboxes, set the
  3602. text property `org-todo-blocked' to 'invisible, otherwise set it
  3603. to t."
  3604. (when (get-text-property 0 'todo-state entry)
  3605. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3606. (org-blocked-by-checkboxes nil)
  3607. ;; Necessary so that `org-entry-blocked-p' does not change
  3608. ;; the buffer.
  3609. (org-depend-tag-blocked nil))
  3610. (when entry-marker
  3611. (let ((blocked
  3612. (with-current-buffer (marker-buffer entry-marker)
  3613. (save-excursion
  3614. (goto-char entry-marker)
  3615. (org-entry-blocked-p)))))
  3616. (when blocked
  3617. (let ((really-invisible
  3618. (and (not org-blocked-by-checkboxes)
  3619. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3620. (put-text-property
  3621. 0 (length entry) 'org-todo-blocked
  3622. (if really-invisible 'invisible t)
  3623. entry)))))))
  3624. entry)
  3625. (defvar org-agenda-skip-function nil
  3626. "Function to be called at each match during agenda construction.
  3627. If this function returns nil, the current match should not be skipped.
  3628. Otherwise, the function must return a position from where the search
  3629. should be continued.
  3630. This may also be a Lisp form, it will be evaluated.
  3631. Never set this variable using `setq' or so, because then it will apply
  3632. to all future agenda commands. If you do want a global skipping condition,
  3633. use the option `org-agenda-skip-function-global' instead.
  3634. The correct usage for `org-agenda-skip-function' is to bind it with
  3635. `let' to scope it dynamically into the agenda-constructing command.
  3636. A good way to set it is through options in `org-agenda-custom-commands'.")
  3637. (defun org-agenda-skip ()
  3638. "Throw to `:skip' in places that should be skipped.
  3639. Also moves point to the end of the skipped region, so that search can
  3640. continue from there."
  3641. (let ((p (point-at-bol)) to)
  3642. (when (or
  3643. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3644. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3645. (get-text-property p :org-archived)
  3646. (org-end-of-subtree t))
  3647. (and org-agenda-skip-comment-trees
  3648. (get-text-property p :org-comment)
  3649. (org-end-of-subtree t))
  3650. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3651. (org-agenda-skip-eval org-agenda-skip-function)))
  3652. (goto-char to))
  3653. (org-in-src-block-p t))
  3654. (throw :skip t))))
  3655. (defun org-agenda-skip-eval (form)
  3656. "If FORM is a function or a list, call (or eval) it and return the result.
  3657. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3658. and match data are returned to the previous state no matter what these
  3659. functions do."
  3660. (let (fp)
  3661. (and form
  3662. (or (setq fp (functionp form))
  3663. (consp form))
  3664. (save-excursion
  3665. (save-match-data
  3666. (if fp
  3667. (funcall form)
  3668. (eval form)))))))
  3669. (defvar org-agenda-markers nil
  3670. "List of all currently active markers created by `org-agenda'.")
  3671. (defvar org-agenda-last-marker-time (float-time)
  3672. "Creation time of the last agenda marker.")
  3673. (defun org-agenda-new-marker (&optional pos)
  3674. "Return a new agenda marker.
  3675. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3676. these markers and resets them when they are no longer in use."
  3677. (let ((m (copy-marker (or pos (point)) t)))
  3678. (setq org-agenda-last-marker-time (float-time))
  3679. (if org-agenda-buffer
  3680. (with-current-buffer org-agenda-buffer
  3681. (push m org-agenda-markers))
  3682. (push m org-agenda-markers))
  3683. m))
  3684. (defun org-agenda-reset-markers ()
  3685. "Reset markers created by `org-agenda'."
  3686. (while org-agenda-markers
  3687. (move-marker (pop org-agenda-markers) nil)))
  3688. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3689. "Save relative positions of markers in region.
  3690. This check for agenda markers in all agenda buffers currently active."
  3691. (dolist (buf (buffer-list))
  3692. (with-current-buffer buf
  3693. (when (eq major-mode 'org-agenda-mode)
  3694. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3695. org-agenda-markers)))))
  3696. ;;; Entry text mode
  3697. (defun org-agenda-entry-text-show-here ()
  3698. "Add some text from the entry as context to the current line."
  3699. (let (m txt o)
  3700. (setq m (org-get-at-bol 'org-hd-marker))
  3701. (unless (marker-buffer m)
  3702. (error "No marker points to an entry here"))
  3703. (setq txt (concat "\n" (org-no-properties
  3704. (org-agenda-get-some-entry-text
  3705. m org-agenda-entry-text-maxlines
  3706. org-agenda-entry-text-leaders))))
  3707. (when (string-match "\\S-" txt)
  3708. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3709. (overlay-put o 'evaporate t)
  3710. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3711. (overlay-put o 'after-string txt))))
  3712. (defun org-agenda-entry-text-show ()
  3713. "Add entry context for all agenda lines."
  3714. (interactive)
  3715. (save-excursion
  3716. (goto-char (point-max))
  3717. (beginning-of-line 1)
  3718. (while (not (bobp))
  3719. (when (org-get-at-bol 'org-hd-marker)
  3720. (org-agenda-entry-text-show-here))
  3721. (beginning-of-line 0))))
  3722. (defun org-agenda-entry-text-hide ()
  3723. "Remove any shown entry context."
  3724. (mapc (lambda (o)
  3725. (when (eq (overlay-get o 'org-overlay-type)
  3726. 'agenda-entry-content)
  3727. (delete-overlay o)))
  3728. (overlays-in (point-min) (point-max))))
  3729. (defun org-agenda-get-day-face (date)
  3730. "Return the face DATE should be displayed with."
  3731. (cond ((and (functionp org-agenda-day-face-function)
  3732. (funcall org-agenda-day-face-function date)))
  3733. ((org-agenda-today-p date) 'org-agenda-date-today)
  3734. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3735. 'org-agenda-date-weekend)
  3736. (t 'org-agenda-date)))
  3737. (defvar org-agenda-show-log-scoped)
  3738. ;;; Agenda Daily/Weekly
  3739. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3740. "Start day for the agenda view.
  3741. Custom commands can set this variable in the options section.
  3742. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3743. input allowed when reading a date through the Org calendar.
  3744. See the docstring of `org-read-date' for details.")
  3745. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3746. (defvar org-arg-loc nil) ; local variable
  3747. (defvar org-agenda-buffer-tmp-name nil)
  3748. ;;;###autoload
  3749. (defun org-agenda-list (&optional arg start-day span with-hour)
  3750. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3751. The view will be for the current day or week, but from the overview buffer
  3752. you will be able to go to other days/weeks.
  3753. With a numeric prefix argument in an interactive call, the agenda will
  3754. span ARG days. Lisp programs should instead specify SPAN to change
  3755. the number of days. SPAN defaults to `org-agenda-span'.
  3756. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3757. given in `org-agenda-start-on-weekday'.
  3758. When WITH-HOUR is non-nil, only include scheduled and deadline
  3759. items if they have an hour specification like [h]h:mm."
  3760. (interactive "P")
  3761. (when org-agenda-overriding-arguments
  3762. (setq arg (car org-agenda-overriding-arguments)
  3763. start-day (nth 1 org-agenda-overriding-arguments)
  3764. span (nth 2 org-agenda-overriding-arguments)))
  3765. (when (and (integerp arg) (> arg 0))
  3766. (setq span arg arg nil))
  3767. (when (numberp span)
  3768. (unless (< 0 span)
  3769. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3770. (catch 'exit
  3771. (setq org-agenda-buffer-name
  3772. (or org-agenda-buffer-tmp-name
  3773. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3774. (when org-agenda-sticky
  3775. (cond ((and org-keys (stringp org-match))
  3776. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3777. (org-keys
  3778. (format "*Org Agenda(%s)*" org-keys))
  3779. (t "*Org Agenda(a)*")))
  3780. "*Org Agenda*"))
  3781. (org-agenda-prepare "Day/Week")
  3782. (setq start-day (or start-day org-agenda-start-day))
  3783. (when (stringp start-day)
  3784. ;; Convert to an absolute day number
  3785. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3786. (org-compile-prefix-format 'agenda)
  3787. (org-set-sorting-strategy 'agenda)
  3788. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3789. (today (org-today))
  3790. (sd (or start-day today))
  3791. (ndays (org-agenda-span-to-ndays span sd))
  3792. (org-agenda-start-on-weekday
  3793. (and (or (eq ndays 7) (eq ndays 14))
  3794. org-agenda-start-on-weekday))
  3795. (thefiles (org-agenda-files nil 'ifmode))
  3796. (files thefiles)
  3797. (start (if (or (null org-agenda-start-on-weekday)
  3798. (< ndays 7))
  3799. sd
  3800. (let* ((nt (calendar-day-of-week
  3801. (calendar-gregorian-from-absolute sd)))
  3802. (n1 org-agenda-start-on-weekday)
  3803. (d (- nt n1)))
  3804. (- sd (+ (if (< d 0) 7 0) d)))))
  3805. (day-numbers (list start))
  3806. (day-cnt 0)
  3807. (inhibit-redisplay (not debug-on-error))
  3808. (org-agenda-show-log-scoped org-agenda-show-log)
  3809. s e rtn rtnall file date d start-pos end-pos todayp
  3810. clocktable-start clocktable-end filter)
  3811. (setq org-agenda-redo-command
  3812. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3813. (dotimes (n (1- ndays))
  3814. (push (1+ (car day-numbers)) day-numbers))
  3815. (setq day-numbers (nreverse day-numbers))
  3816. (setq clocktable-start (car day-numbers)
  3817. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3818. (setq-local org-starting-day (car day-numbers))
  3819. (setq-local org-arg-loc arg)
  3820. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3821. (unless org-agenda-compact-blocks
  3822. (let* ((d1 (car day-numbers))
  3823. (d2 (org-last day-numbers))
  3824. (w1 (org-days-to-iso-week d1))
  3825. (w2 (org-days-to-iso-week d2)))
  3826. (setq s (point))
  3827. (org-agenda--insert-overriding-header
  3828. (concat (org-agenda-span-name span)
  3829. "-agenda"
  3830. (cond ((<= 350 (- d2 d1)) "")
  3831. ((= w1 w2) (format " (W%02d)" w1))
  3832. (t (format " (W%02d-W%02d)" w1 w2)))
  3833. ":\n")))
  3834. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3835. 'org-date-line t))
  3836. (org-agenda-mark-header-line s))
  3837. (while (setq d (pop day-numbers))
  3838. (setq date (calendar-gregorian-from-absolute d)
  3839. s (point))
  3840. (if (or (setq todayp (= d today))
  3841. (and (not start-pos) (= d sd)))
  3842. (setq start-pos (point))
  3843. (when (and start-pos (not end-pos))
  3844. (setq end-pos (point))))
  3845. (setq files thefiles
  3846. rtnall nil)
  3847. (while (setq file (pop files))
  3848. (catch 'nextfile
  3849. (org-check-agenda-file file)
  3850. (let ((org-agenda-entry-types org-agenda-entry-types))
  3851. ;; Starred types override non-starred equivalents
  3852. (when (member :deadline* org-agenda-entry-types)
  3853. (setq org-agenda-entry-types
  3854. (delq :deadline org-agenda-entry-types)))
  3855. (when (member :scheduled* org-agenda-entry-types)
  3856. (setq org-agenda-entry-types
  3857. (delq :scheduled org-agenda-entry-types)))
  3858. ;; Honor with-hour
  3859. (when with-hour
  3860. (when (member :deadline org-agenda-entry-types)
  3861. (setq org-agenda-entry-types
  3862. (delq :deadline org-agenda-entry-types))
  3863. (push :deadline* org-agenda-entry-types))
  3864. (when (member :scheduled org-agenda-entry-types)
  3865. (setq org-agenda-entry-types
  3866. (delq :scheduled org-agenda-entry-types))
  3867. (push :scheduled* org-agenda-entry-types)))
  3868. (unless org-agenda-include-deadlines
  3869. (setq org-agenda-entry-types
  3870. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3871. (cond
  3872. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3873. (setq rtn (org-agenda-get-day-entries
  3874. file date :closed)))
  3875. (org-agenda-show-log-scoped
  3876. (setq rtn (apply 'org-agenda-get-day-entries
  3877. file date
  3878. (append '(:closed) org-agenda-entry-types))))
  3879. (t
  3880. (setq rtn (apply 'org-agenda-get-day-entries
  3881. file date
  3882. org-agenda-entry-types)))))
  3883. (setq rtnall (append rtnall rtn)))) ;; all entries
  3884. (when org-agenda-include-diary
  3885. (let ((org-agenda-search-headline-for-time t))
  3886. (require 'diary-lib)
  3887. (setq rtn (org-get-entries-from-diary date))
  3888. (setq rtnall (append rtnall rtn))))
  3889. (when (or rtnall org-agenda-show-all-dates)
  3890. (setq day-cnt (1+ day-cnt))
  3891. (insert
  3892. (if (stringp org-agenda-format-date)
  3893. (format-time-string org-agenda-format-date
  3894. (org-time-from-absolute date))
  3895. (funcall org-agenda-format-date date))
  3896. "\n")
  3897. (put-text-property s (1- (point)) 'face
  3898. (org-agenda-get-day-face date))
  3899. (put-text-property s (1- (point)) 'org-date-line t)
  3900. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3901. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3902. (when todayp
  3903. (put-text-property s (1- (point)) 'org-today t))
  3904. (setq rtnall
  3905. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3906. (when rtnall (insert ;; all entries
  3907. (org-agenda-finalize-entries rtnall 'agenda)
  3908. "\n"))
  3909. (put-text-property s (1- (point)) 'day d)
  3910. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  3911. (when (and org-agenda-clockreport-mode clocktable-start)
  3912. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3913. ;; the above line is to ensure the restricted range!
  3914. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3915. tbl)
  3916. (setq p (org-plist-delete p :block))
  3917. (setq p (plist-put p :tstart clocktable-start))
  3918. (setq p (plist-put p :tend clocktable-end))
  3919. (setq p (plist-put p :scope 'agenda))
  3920. (setq tbl (apply 'org-clock-get-clocktable p))
  3921. (insert tbl)))
  3922. (goto-char (point-min))
  3923. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3924. (unless (or (not (get-buffer-window))
  3925. (and (pos-visible-in-window-p (point-min))
  3926. (pos-visible-in-window-p (point-max))))
  3927. (goto-char (1- (point-max)))
  3928. (recenter -1)
  3929. (when (not (pos-visible-in-window-p (or start-pos 1)))
  3930. (goto-char (or start-pos 1))
  3931. (recenter 1)))
  3932. (goto-char (or start-pos 1))
  3933. (add-text-properties (point-min) (point-max)
  3934. `(org-agenda-type agenda
  3935. org-last-args (,arg ,start-day ,span)
  3936. org-redo-cmd ,org-agenda-redo-command
  3937. org-series-cmd ,org-cmd))
  3938. (when (eq org-agenda-show-log-scoped 'clockcheck)
  3939. (org-agenda-show-clocking-issues))
  3940. (org-agenda-finalize)
  3941. (setq buffer-read-only t)
  3942. (message ""))))
  3943. (defun org-agenda-ndays-to-span (n)
  3944. "Return a span symbol for a span of N days, or N if none matches."
  3945. (cond ((symbolp n) n)
  3946. ((= n 1) 'day)
  3947. ((= n 7) 'week)
  3948. ((= n 14) 'fortnight)
  3949. (t n)))
  3950. (defun org-agenda-span-to-ndays (span &optional start-day)
  3951. "Return ndays from SPAN, possibly starting at START-DAY.
  3952. START-DAY is an absolute time value."
  3953. (cond ((numberp span) span)
  3954. ((eq span 'day) 1)
  3955. ((eq span 'week) 7)
  3956. ((eq span 'fortnight) 14)
  3957. ((eq span 'month)
  3958. (let ((date (calendar-gregorian-from-absolute start-day)))
  3959. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3960. ((eq span 'year)
  3961. (let ((date (calendar-gregorian-from-absolute start-day)))
  3962. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3963. (defun org-agenda-span-name (span)
  3964. "Return a SPAN name."
  3965. (if (null span)
  3966. ""
  3967. (if (symbolp span)
  3968. (capitalize (symbol-name span))
  3969. (format "%d days" span))))
  3970. ;;; Agenda word search
  3971. (defvar org-agenda-search-history nil)
  3972. (defvar org-search-syntax-table nil
  3973. "Special syntax table for Org search.
  3974. In this table, we have single quotes not as word constituents, to
  3975. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3976. (defvar org-mode-syntax-table) ; From org.el
  3977. (defun org-search-syntax-table ()
  3978. (unless org-search-syntax-table
  3979. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3980. (modify-syntax-entry ?' "." org-search-syntax-table)
  3981. (modify-syntax-entry ?` "." org-search-syntax-table))
  3982. org-search-syntax-table)
  3983. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3984. ;;;###autoload
  3985. (defun org-search-view (&optional todo-only string edit-at)
  3986. "Show all entries that contain a phrase or words or regular expressions.
  3987. With optional prefix argument TODO-ONLY, only consider entries that are
  3988. TODO entries. The argument STRING can be used to pass a default search
  3989. string into this function. If EDIT-AT is non-nil, it means that the
  3990. user should get a chance to edit this string, with cursor at position
  3991. EDIT-AT.
  3992. The search string can be viewed either as a phrase that should be found as
  3993. is, or it can be broken into a number of snippets, each of which must match
  3994. in a Boolean way to select an entry. The default depends on the variable
  3995. `org-agenda-search-view-always-boolean'.
  3996. Even if this is turned off (the default) you can always switch to
  3997. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3998. The default is a direct search of the whole phrase, where each space in
  3999. the search string can expand to an arbitrary amount of whitespace,
  4000. including newlines.
  4001. If using a Boolean search, the search string is split on whitespace and
  4002. each snippet is searched separately, with logical AND to select an entry.
  4003. Words prefixed with a minus must *not* occur in the entry. Words without
  4004. a prefix or prefixed with a plus must occur in the entry. Matching is
  4005. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4006. match whole words, not parts of a word) if
  4007. `org-agenda-search-view-force-full-words' is set (default is nil).
  4008. Boolean search snippets enclosed by curly braces are interpreted as
  4009. regular expressions that must or (when preceded with \"-\") must not
  4010. match in the entry. Snippets enclosed into double quotes will be taken
  4011. as a whole, to include whitespace.
  4012. - If the search string starts with an asterisk, search only in headlines.
  4013. - If (possibly after the leading star) the search string starts with an
  4014. exclamation mark, this also means to look at TODO entries only, an effect
  4015. that can also be achieved with a prefix argument.
  4016. - If (possibly after star and exclamation mark) the search string starts
  4017. with a colon, this will mean that the (non-regexp) snippets of the
  4018. Boolean search must match as full words.
  4019. This command searches the agenda files, and in addition the files
  4020. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4021. is active."
  4022. (interactive "P")
  4023. (when org-agenda-overriding-arguments
  4024. (setq todo-only (car org-agenda-overriding-arguments)
  4025. string (nth 1 org-agenda-overriding-arguments)
  4026. edit-at (nth 2 org-agenda-overriding-arguments)))
  4027. (let* ((props (list 'face nil
  4028. 'done-face 'org-agenda-done
  4029. 'org-not-done-regexp org-not-done-regexp
  4030. 'org-todo-regexp org-todo-regexp
  4031. 'org-complex-heading-regexp org-complex-heading-regexp
  4032. 'mouse-face 'highlight
  4033. 'help-echo (format "mouse-2 or RET jump to location")))
  4034. (full-words org-agenda-search-view-force-full-words)
  4035. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4036. regexp rtn rtnall files file pos inherited-tags
  4037. marker category level tags c neg re boolean
  4038. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4039. (unless (and (not edit-at)
  4040. (stringp string)
  4041. (string-match "\\S-" string))
  4042. (setq string (read-string
  4043. (if org-agenda-search-view-always-boolean
  4044. "[+-]Word/{Regexp} ...: "
  4045. "Phrase or [+-]Word/{Regexp} ...: ")
  4046. (cond
  4047. ((integerp edit-at) (cons string edit-at))
  4048. (edit-at string))
  4049. 'org-agenda-search-history)))
  4050. (catch 'exit
  4051. (when org-agenda-sticky
  4052. (setq org-agenda-buffer-name
  4053. (if (stringp string)
  4054. (format "*Org Agenda(%s:%s)*"
  4055. (or org-keys (or (and todo-only "S") "s")) string)
  4056. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4057. (org-agenda-prepare "SEARCH")
  4058. (org-compile-prefix-format 'search)
  4059. (org-set-sorting-strategy 'search)
  4060. (setq org-agenda-redo-command
  4061. (list 'org-search-view (if todo-only t nil)
  4062. (list 'if 'current-prefix-arg nil string)))
  4063. (setq org-agenda-query-string string)
  4064. (if (equal (string-to-char string) ?*)
  4065. (setq hdl-only t
  4066. words (substring string 1))
  4067. (setq words string))
  4068. (when (equal (string-to-char words) ?!)
  4069. (setq todo-only t
  4070. words (substring words 1)))
  4071. (when (equal (string-to-char words) ?:)
  4072. (setq full-words t
  4073. words (substring words 1)))
  4074. (when (or org-agenda-search-view-always-boolean
  4075. (member (string-to-char words) '(?- ?+ ?\{)))
  4076. (setq boolean t))
  4077. (setq words (split-string words))
  4078. (let (www w)
  4079. (while (setq w (pop words))
  4080. (while (and (string-match "\\\\\\'" w) words)
  4081. (setq w (concat (substring w 0 -1) " " (pop words))))
  4082. (push w www))
  4083. (setq words (nreverse www) www nil)
  4084. (while (setq w (pop words))
  4085. (when (and (string-match "\\`[-+]?{" w)
  4086. (not (string-match "}\\'" w)))
  4087. (while (and words (not (string-match "}\\'" (car words))))
  4088. (setq w (concat w " " (pop words))))
  4089. (setq w (concat w " " (pop words))))
  4090. (push w www))
  4091. (setq words (nreverse www)))
  4092. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4093. (when boolean
  4094. (let (wds w)
  4095. (while (setq w (pop words))
  4096. (when (or (equal (substring w 0 1) "\"")
  4097. (and (> (length w) 1)
  4098. (member (substring w 0 1) '("+" "-"))
  4099. (equal (substring w 1 2) "\"")))
  4100. (while (and words (not (equal (substring w -1) "\"")))
  4101. (setq w (concat w " " (pop words)))))
  4102. (and (string-match "\\`\\([-+]?\\)\"" w)
  4103. (setq w (replace-match "\\1" nil nil w)))
  4104. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4105. (push w wds))
  4106. (setq words (nreverse wds))))
  4107. (if boolean
  4108. (mapc (lambda (w)
  4109. (setq c (string-to-char w))
  4110. (if (equal c ?-)
  4111. (setq neg t w (substring w 1))
  4112. (if (equal c ?+)
  4113. (setq neg nil w (substring w 1))
  4114. (setq neg nil)))
  4115. (if (string-match "\\`{.*}\\'" w)
  4116. (setq re (substring w 1 -1))
  4117. (if full-words
  4118. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4119. (setq re (regexp-quote (downcase w)))))
  4120. (if neg (push re regexps-) (push re regexps+)))
  4121. words)
  4122. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4123. regexps+))
  4124. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4125. (if (not regexps+)
  4126. (setq regexp org-outline-regexp-bol)
  4127. (setq regexp (pop regexps+))
  4128. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4129. regexp))))
  4130. (setq files (org-agenda-files nil 'ifmode))
  4131. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4132. ;; restriction.
  4133. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4134. (pop org-agenda-text-search-extra-files)
  4135. (unless (get 'org-agenda-files 'org-restrict)
  4136. (setq files (org-add-archive-files files))))
  4137. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4138. ;; non-existent ones.
  4139. (setq files (cl-remove-duplicates
  4140. (append files org-agenda-text-search-extra-files)
  4141. :test (lambda (a b)
  4142. (and (file-exists-p a)
  4143. (file-exists-p b)
  4144. (file-equal-p a b))))
  4145. rtnall nil)
  4146. (while (setq file (pop files))
  4147. (setq ee nil)
  4148. (catch 'nextfile
  4149. (org-check-agenda-file file)
  4150. (setq buffer (if (file-exists-p file)
  4151. (org-get-agenda-file-buffer file)
  4152. (error "No such file %s" file)))
  4153. (unless buffer
  4154. ;; If file does not exist, make sure an error message is sent
  4155. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4156. file))))
  4157. (with-current-buffer buffer
  4158. (with-syntax-table (org-search-syntax-table)
  4159. (unless (derived-mode-p 'org-mode)
  4160. (error "Agenda file %s is not in Org mode" file))
  4161. (let ((case-fold-search t))
  4162. (save-excursion
  4163. (save-restriction
  4164. (if (eq buffer org-agenda-restrict)
  4165. (narrow-to-region org-agenda-restrict-begin
  4166. org-agenda-restrict-end)
  4167. (widen))
  4168. (goto-char (point-min))
  4169. (unless (or (org-at-heading-p)
  4170. (outline-next-heading))
  4171. (throw 'nextfile t))
  4172. (goto-char (max (point-min) (1- (point))))
  4173. (while (re-search-forward regexp nil t)
  4174. (org-back-to-heading t)
  4175. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4176. (> (org-reduced-level (org-outline-level))
  4177. org-agenda-search-view-max-outline-level)
  4178. (forward-line -1)
  4179. (org-back-to-heading t)))
  4180. (skip-chars-forward "* ")
  4181. (setq beg (point-at-bol)
  4182. beg1 (point)
  4183. end (progn
  4184. (outline-next-heading)
  4185. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4186. (> (org-reduced-level (org-outline-level))
  4187. org-agenda-search-view-max-outline-level)
  4188. (forward-line 1)
  4189. (outline-next-heading)))
  4190. (point)))
  4191. (catch :skip
  4192. (goto-char beg)
  4193. (org-agenda-skip)
  4194. (setq str (buffer-substring-no-properties
  4195. (point-at-bol)
  4196. (if hdl-only (point-at-eol) end)))
  4197. (mapc (lambda (wr) (when (string-match wr str)
  4198. (goto-char (1- end))
  4199. (throw :skip t)))
  4200. regexps-)
  4201. (mapc (lambda (wr) (unless (string-match wr str)
  4202. (goto-char (1- end))
  4203. (throw :skip t)))
  4204. (if todo-only
  4205. (cons (concat "^\\*+[ \t]+"
  4206. org-not-done-regexp)
  4207. regexps+)
  4208. regexps+))
  4209. (goto-char beg)
  4210. (setq marker (org-agenda-new-marker (point))
  4211. category (org-get-category)
  4212. level (make-string (org-reduced-level (org-outline-level)) ? )
  4213. inherited-tags
  4214. (or (eq org-agenda-show-inherited-tags 'always)
  4215. (and (listp org-agenda-show-inherited-tags)
  4216. (memq 'todo org-agenda-show-inherited-tags))
  4217. (and (eq org-agenda-show-inherited-tags t)
  4218. (or (eq org-agenda-use-tag-inheritance t)
  4219. (memq 'todo org-agenda-use-tag-inheritance))))
  4220. tags (org-get-tags nil (not inherited-tags))
  4221. txt (org-agenda-format-item
  4222. ""
  4223. (buffer-substring-no-properties
  4224. beg1 (point-at-eol))
  4225. level category tags t))
  4226. (org-add-props txt props
  4227. 'org-marker marker 'org-hd-marker marker
  4228. 'org-todo-regexp org-todo-regexp
  4229. 'level level
  4230. 'org-complex-heading-regexp org-complex-heading-regexp
  4231. 'priority 1000
  4232. 'type "search")
  4233. (push txt ee)
  4234. (goto-char (1- end))))))))))
  4235. (setq rtn (nreverse ee))
  4236. (setq rtnall (append rtnall rtn)))
  4237. (org-agenda--insert-overriding-header
  4238. (with-temp-buffer
  4239. (insert "Search words: ")
  4240. (add-text-properties (point-min) (1- (point))
  4241. (list 'face 'org-agenda-structure))
  4242. (setq pos (point))
  4243. (insert string "\n")
  4244. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4245. (setq pos (point))
  4246. (unless org-agenda-multi
  4247. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4248. Press `\\[org-agenda-manipulate-query-add]', \
  4249. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4250. `\\[org-agenda-manipulate-query-add-re]', \
  4251. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4252. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4253. (add-text-properties pos (1- (point))
  4254. (list 'face 'org-agenda-structure)))
  4255. (buffer-string)))
  4256. (org-agenda-mark-header-line (point-min))
  4257. (when rtnall
  4258. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4259. (goto-char (point-min))
  4260. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4261. (add-text-properties (point-min) (point-max)
  4262. `(org-agenda-type search
  4263. org-last-args (,todo-only ,string ,edit-at)
  4264. org-redo-cmd ,org-agenda-redo-command
  4265. org-series-cmd ,org-cmd))
  4266. (org-agenda-finalize)
  4267. (setq buffer-read-only t))))
  4268. ;;; Agenda TODO list
  4269. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4270. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4271. (concat
  4272. (if (or (equal keywords "ALL") (not keywords))
  4273. (propertize "ALL" 'face 'warning)
  4274. (mapconcat
  4275. (lambda (kw)
  4276. (propertize kw 'face (org-get-todo-face kw)))
  4277. (org-split-string keywords "|")
  4278. "|"))
  4279. "\n"))
  4280. (defvar org-select-this-todo-keyword nil)
  4281. (defvar org-last-arg nil)
  4282. ;;;###autoload
  4283. (defun org-todo-list (&optional arg)
  4284. "Show all (not done) TODO entries from all agenda file in a single list.
  4285. The prefix arg can be used to select a specific TODO keyword and limit
  4286. the list to these. When using `\\[universal-argument]', you will be prompted
  4287. for a keyword. A numeric prefix directly selects the Nth keyword in
  4288. `org-todo-keywords-1'."
  4289. (interactive "P")
  4290. (when org-agenda-overriding-arguments
  4291. (setq arg org-agenda-overriding-arguments))
  4292. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4293. (let* ((today (org-today))
  4294. (date (calendar-gregorian-from-absolute today))
  4295. (completion-ignore-case t)
  4296. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4297. (catch 'exit
  4298. (when org-agenda-sticky
  4299. (setq org-agenda-buffer-name
  4300. (if (stringp org-select-this-todo-keyword)
  4301. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4302. org-select-this-todo-keyword)
  4303. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4304. (org-agenda-prepare "TODO")
  4305. (setq kwds org-todo-keywords-for-agenda
  4306. org-select-this-todo-keyword (if (stringp arg) arg
  4307. (and (integerp arg)
  4308. (> arg 0)
  4309. (nth (1- arg) kwds))))
  4310. (when (equal arg '(4))
  4311. (setq org-select-this-todo-keyword
  4312. (completing-read "Keyword (or KWD1|K2D2|...): "
  4313. (mapcar #'list kwds) nil nil)))
  4314. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4315. (org-compile-prefix-format 'todo)
  4316. (org-set-sorting-strategy 'todo)
  4317. (setq org-agenda-redo-command
  4318. `(org-todo-list (or (and (numberp current-prefix-arg)
  4319. current-prefix-arg)
  4320. ,org-select-this-todo-keyword
  4321. current-prefix-arg ,arg)))
  4322. (setq files (org-agenda-files nil 'ifmode)
  4323. rtnall nil)
  4324. (while (setq file (pop files))
  4325. (catch 'nextfile
  4326. (org-check-agenda-file file)
  4327. (setq rtn (org-agenda-get-day-entries file date :todo))
  4328. (setq rtnall (append rtnall rtn))))
  4329. (org-agenda--insert-overriding-header
  4330. (with-temp-buffer
  4331. (insert "Global list of TODO items of type: ")
  4332. (add-text-properties (point-min) (1- (point))
  4333. (list 'face 'org-agenda-structure
  4334. 'short-heading
  4335. (concat "ToDo: "
  4336. (or org-select-this-todo-keyword "ALL"))))
  4337. (org-agenda-mark-header-line (point-min))
  4338. (insert (org-agenda-propertize-selected-todo-keywords
  4339. org-select-this-todo-keyword))
  4340. (setq pos (point))
  4341. (unless org-agenda-multi
  4342. (insert (substitute-command-keys "Press \
  4343. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4344. to search again: (0)[ALL]"))
  4345. (let ((n 0))
  4346. (dolist (k kwds)
  4347. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4348. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4349. (insert "\n "))
  4350. (insert " " s))))
  4351. (insert "\n"))
  4352. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4353. (buffer-string)))
  4354. (org-agenda-mark-header-line (point-min))
  4355. (when rtnall
  4356. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4357. (goto-char (point-min))
  4358. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4359. (add-text-properties (point-min) (point-max)
  4360. `(org-agenda-type todo
  4361. org-last-args ,arg
  4362. org-redo-cmd ,org-agenda-redo-command
  4363. org-series-cmd ,org-cmd))
  4364. (org-agenda-finalize)
  4365. (setq buffer-read-only t))))
  4366. ;;; Agenda tags match
  4367. ;;;###autoload
  4368. (defun org-tags-view (&optional todo-only match)
  4369. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4370. The prefix arg TODO-ONLY limits the search to TODO entries."
  4371. (interactive "P")
  4372. (when org-agenda-overriding-arguments
  4373. (setq todo-only (car org-agenda-overriding-arguments)
  4374. match (nth 1 org-agenda-overriding-arguments)))
  4375. (let* ((org-tags-match-list-sublevels
  4376. org-tags-match-list-sublevels)
  4377. (completion-ignore-case t)
  4378. (org--matcher-tags-todo-only todo-only)
  4379. rtn rtnall files file pos matcher
  4380. buffer)
  4381. (when (and (stringp match) (not (string-match "\\S-" match)))
  4382. (setq match nil))
  4383. (catch 'exit
  4384. ;; TODO: this code is repeated a lot...
  4385. (when org-agenda-sticky
  4386. (setq org-agenda-buffer-name
  4387. (if (stringp match)
  4388. (format "*Org Agenda(%s:%s)*"
  4389. (or org-keys (or (and todo-only "M") "m")) match)
  4390. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4391. (setq matcher (org-make-tags-matcher match))
  4392. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4393. ;; expanding tags within `org-make-tags-matcher'
  4394. (org-agenda-prepare (concat "TAGS " match))
  4395. (setq match (car matcher)
  4396. matcher (cdr matcher))
  4397. (org-compile-prefix-format 'tags)
  4398. (org-set-sorting-strategy 'tags)
  4399. (setq org-agenda-query-string match)
  4400. (setq org-agenda-redo-command
  4401. (list 'org-tags-view
  4402. `(quote ,org--matcher-tags-todo-only)
  4403. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4404. (setq files (org-agenda-files nil 'ifmode)
  4405. rtnall nil)
  4406. (while (setq file (pop files))
  4407. (catch 'nextfile
  4408. (org-check-agenda-file file)
  4409. (setq buffer (if (file-exists-p file)
  4410. (org-get-agenda-file-buffer file)
  4411. (error "No such file %s" file)))
  4412. (if (not buffer)
  4413. ;; If file does not exist, error message to agenda
  4414. (setq rtn (list
  4415. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4416. rtnall (append rtnall rtn))
  4417. (with-current-buffer buffer
  4418. (unless (derived-mode-p 'org-mode)
  4419. (error "Agenda file %s is not in Org mode" file))
  4420. (save-excursion
  4421. (save-restriction
  4422. (if (eq buffer org-agenda-restrict)
  4423. (narrow-to-region org-agenda-restrict-begin
  4424. org-agenda-restrict-end)
  4425. (widen))
  4426. (setq rtn (org-scan-tags 'agenda
  4427. matcher
  4428. org--matcher-tags-todo-only))
  4429. (setq rtnall (append rtnall rtn))))))))
  4430. (org-agenda--insert-overriding-header
  4431. (with-temp-buffer
  4432. (insert "Headlines with TAGS match: ")
  4433. (add-text-properties (point-min) (1- (point))
  4434. (list 'face 'org-agenda-structure
  4435. 'short-heading
  4436. (concat "Match: " match)))
  4437. (setq pos (point))
  4438. (insert match "\n")
  4439. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4440. (setq pos (point))
  4441. (unless org-agenda-multi
  4442. (insert (substitute-command-keys
  4443. "Press \
  4444. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4445. to search again\n")))
  4446. (add-text-properties pos (1- (point))
  4447. (list 'face 'org-agenda-structure))
  4448. (buffer-string)))
  4449. (org-agenda-mark-header-line (point-min))
  4450. (when rtnall
  4451. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4452. (goto-char (point-min))
  4453. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4454. (add-text-properties
  4455. (point-min) (point-max)
  4456. `(org-agenda-type tags
  4457. org-last-args (,org--matcher-tags-todo-only ,match)
  4458. org-redo-cmd ,org-agenda-redo-command
  4459. org-series-cmd ,org-cmd))
  4460. (org-agenda-finalize)
  4461. (setq buffer-read-only t))))
  4462. ;;; Agenda Finding stuck projects
  4463. (defvar org-agenda-skip-regexp nil
  4464. "Regular expression used in skipping subtrees for the agenda.
  4465. This is basically a temporary global variable that can be set and then
  4466. used by user-defined selections using `org-agenda-skip-function'.")
  4467. (defvar org-agenda-overriding-header nil
  4468. "When set during agenda, todo and tags searches it replaces the header.
  4469. If an empty string, no header will be inserted. If any other
  4470. string, it will be inserted as a header. If nil, a header will
  4471. be generated automatically according to the command. This
  4472. variable should not be set directly, but custom commands can bind
  4473. it in the options section.")
  4474. (defun org-agenda-skip-entry-if (&rest conditions)
  4475. "Skip entry if any of CONDITIONS is true.
  4476. See `org-agenda-skip-if' for details."
  4477. (org-agenda-skip-if nil conditions))
  4478. (defun org-agenda-skip-subtree-if (&rest conditions)
  4479. "Skip subtree if any of CONDITIONS is true.
  4480. See `org-agenda-skip-if' for details."
  4481. (org-agenda-skip-if t conditions))
  4482. (defun org-agenda-skip-if (subtree conditions)
  4483. "Checks current entity for CONDITIONS.
  4484. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4485. the entry (i.e. the text before the next heading) is checked.
  4486. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4487. from different tests. Valid conditions are:
  4488. scheduled Check if there is a scheduled cookie
  4489. notscheduled Check if there is no scheduled cookie
  4490. deadline Check if there is a deadline
  4491. notdeadline Check if there is no deadline
  4492. timestamp Check if there is a timestamp (also deadline or scheduled)
  4493. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4494. regexp Check if regexp matches
  4495. notregexp Check if regexp does not match.
  4496. todo Check if TODO keyword matches
  4497. nottodo Check if TODO keyword does not match
  4498. The regexp is taken from the conditions list, it must come right after
  4499. the `regexp' or `notregexp' element.
  4500. `todo' and `nottodo' accept as an argument a list of todo
  4501. keywords, which may include \"*\" to match any todo keyword.
  4502. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4503. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4504. Instead of a list, a keyword class may be given. For example:
  4505. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4506. would skip entries that haven't been marked with any of \"DONE\"
  4507. keywords. Possible classes are: `todo', `done', `any'.
  4508. If any of these conditions is met, this function returns the end point of
  4509. the entity, causing the search to continue from there. This is a function
  4510. that can be put into `org-agenda-skip-function' for the duration of a command."
  4511. (org-back-to-heading t)
  4512. (let* ((beg (point))
  4513. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4514. (org-entry-end-position)))
  4515. (planning-end (if subtree end (line-end-position 2)))
  4516. m)
  4517. (and
  4518. (or (and (memq 'scheduled conditions)
  4519. (re-search-forward org-scheduled-time-regexp planning-end t))
  4520. (and (memq 'notscheduled conditions)
  4521. (not
  4522. (save-excursion
  4523. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4524. (and (memq 'deadline conditions)
  4525. (re-search-forward org-deadline-time-regexp planning-end t))
  4526. (and (memq 'notdeadline conditions)
  4527. (not
  4528. (save-excursion
  4529. (re-search-forward org-deadline-time-regexp planning-end t))))
  4530. (and (memq 'timestamp conditions)
  4531. (re-search-forward org-ts-regexp end t))
  4532. (and (memq 'nottimestamp conditions)
  4533. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4534. (and (setq m (memq 'regexp conditions))
  4535. (stringp (nth 1 m))
  4536. (re-search-forward (nth 1 m) end t))
  4537. (and (setq m (memq 'notregexp conditions))
  4538. (stringp (nth 1 m))
  4539. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4540. (and (or
  4541. (setq m (memq 'nottodo conditions))
  4542. (setq m (memq 'todo-unblocked conditions))
  4543. (setq m (memq 'nottodo-unblocked conditions))
  4544. (setq m (memq 'todo conditions)))
  4545. (org-agenda-skip-if-todo m end)))
  4546. end)))
  4547. (defun org-agenda-skip-if-todo (args end)
  4548. "Helper function for `org-agenda-skip-if', do not use it directly.
  4549. ARGS is a list with first element either `todo', `nottodo',
  4550. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4551. a list of TODO keywords, or a state symbol `todo' or `done' or
  4552. `any'."
  4553. (let ((todo-re
  4554. (concat "^\\*+[ \t]+"
  4555. (regexp-opt
  4556. (pcase args
  4557. (`(,_ todo)
  4558. (org-delete-all org-done-keywords
  4559. (copy-sequence org-todo-keywords-1)))
  4560. (`(,_ done) org-done-keywords)
  4561. (`(,_ any) org-todo-keywords-1)
  4562. (`(,_ ,(pred atom))
  4563. (error "Invalid TODO class or type: %S" args))
  4564. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4565. (`(,_ ,todo-list) todo-list))
  4566. 'words))))
  4567. (pcase args
  4568. (`(todo . ,_)
  4569. (let (case-fold-search) (re-search-forward todo-re end t)))
  4570. (`(nottodo . ,_)
  4571. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4572. (`(todo-unblocked . ,_)
  4573. (catch :unblocked
  4574. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4575. (when (org-entry-blocked-p) (throw :unblocked t)))
  4576. nil))
  4577. (`(nottodo-unblocked . ,_)
  4578. (catch :unblocked
  4579. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4580. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4581. t))
  4582. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4583. ;;;###autoload
  4584. (defun org-agenda-list-stuck-projects (&rest ignore)
  4585. "Create agenda view for projects that are stuck.
  4586. Stuck projects are project that have no next actions. For the definitions
  4587. of what a project is and how to check if it stuck, customize the variable
  4588. `org-stuck-projects'."
  4589. (interactive)
  4590. (let* ((org-agenda-overriding-header
  4591. (or org-agenda-overriding-header "List of stuck projects: "))
  4592. (matcher (nth 0 org-stuck-projects))
  4593. (todo (nth 1 org-stuck-projects))
  4594. (tags (nth 2 org-stuck-projects))
  4595. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4596. (todo-wds
  4597. (if (not (member "*" todo)) todo
  4598. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4599. (org-delete-all org-done-keywords-for-agenda
  4600. (copy-sequence org-todo-keywords-for-agenda))))
  4601. (todo-re (and todo
  4602. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4603. (mapconcat #'identity todo-wds "\\|"))))
  4604. (tags-re (cond ((null tags) nil)
  4605. ((member "*" tags) org-tag-line-re)
  4606. (tags
  4607. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4608. (concat org-outline-regexp-bol
  4609. ".*?[ \t]:"
  4610. other-tags
  4611. (regexp-opt tags t)
  4612. ":" other-tags "[ \t]*$")))
  4613. (t nil)))
  4614. (re-list (delq nil (list todo-re tags-re gen-re)))
  4615. (skip-re
  4616. (if (null re-list)
  4617. (error "Missing information to identify unstuck projects")
  4618. (mapconcat #'identity re-list "\\|")))
  4619. (org-agenda-skip-function
  4620. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4621. ;; in the subtree.
  4622. `(lambda ()
  4623. (and (save-excursion
  4624. (let ((case-fold-search nil))
  4625. (re-search-forward
  4626. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4627. (progn (outline-next-heading) (point))))))
  4628. (org-tags-view nil matcher)
  4629. (setq org-agenda-buffer-name (buffer-name))
  4630. (with-current-buffer org-agenda-buffer-name
  4631. (setq org-agenda-redo-command
  4632. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4633. (let ((inhibit-read-only t))
  4634. (add-text-properties
  4635. (point-min) (point-max)
  4636. `(org-redo-cmd ,org-agenda-redo-command))))))
  4637. ;;; Diary integration
  4638. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4639. (defvar diary-list-entries-hook)
  4640. (defvar diary-time-regexp)
  4641. (defun org-get-entries-from-diary (date)
  4642. "Get the (Emacs Calendar) diary entries for DATE."
  4643. (require 'diary-lib)
  4644. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4645. (diary-display-function 'diary-fancy-display)
  4646. (pop-up-frames nil)
  4647. (diary-list-entries-hook
  4648. (cons 'org-diary-default-entry diary-list-entries-hook))
  4649. (diary-file-name-prefix nil) ; turn this feature off
  4650. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4651. entries
  4652. (org-disable-agenda-to-diary t))
  4653. (save-excursion
  4654. (save-window-excursion
  4655. (funcall (if (fboundp 'diary-list-entries)
  4656. 'diary-list-entries 'list-diary-entries)
  4657. date 1)))
  4658. (if (not (get-buffer diary-fancy-buffer))
  4659. (setq entries nil)
  4660. (with-current-buffer diary-fancy-buffer
  4661. (setq buffer-read-only nil)
  4662. (if (zerop (buffer-size))
  4663. ;; No entries
  4664. (setq entries nil)
  4665. ;; Omit the date and other unnecessary stuff
  4666. (org-agenda-cleanup-fancy-diary)
  4667. ;; Add prefix to each line and extend the text properties
  4668. (if (zerop (buffer-size))
  4669. (setq entries nil)
  4670. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4671. (setq entries
  4672. (with-temp-buffer
  4673. (insert entries) (goto-char (point-min))
  4674. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4675. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4676. (replace-match (concat "; " (match-string 1)))))
  4677. (buffer-string)))))
  4678. (set-buffer-modified-p nil)
  4679. (kill-buffer diary-fancy-buffer)))
  4680. (when entries
  4681. (setq entries (org-split-string entries "\n"))
  4682. (setq entries
  4683. (mapcar
  4684. (lambda (x)
  4685. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4686. ;; Extend the text properties to the beginning of the line
  4687. (org-add-props x (text-properties-at (1- (length x)) x)
  4688. 'type "diary" 'date date 'face 'org-agenda-diary))
  4689. entries)))))
  4690. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4691. "Hook run when the fancy diary buffer is cleaned up.")
  4692. (defun org-agenda-cleanup-fancy-diary ()
  4693. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4694. This gets rid of the date, the underline under the date, and the
  4695. dummy entry installed by Org mode to ensure non-empty diary for
  4696. each date. It also removes lines that contain only whitespace."
  4697. (goto-char (point-min))
  4698. (if (looking-at ".*?:[ \t]*")
  4699. (progn
  4700. (replace-match "")
  4701. (re-search-forward "\n=+$" nil t)
  4702. (replace-match "")
  4703. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4704. (re-search-forward "\n=+$" nil t)
  4705. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4706. (goto-char (point-min))
  4707. (while (re-search-forward "^ +\n" nil t)
  4708. (replace-match ""))
  4709. (goto-char (point-min))
  4710. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4711. (replace-match ""))
  4712. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4713. (defun org-modify-diary-entry-string (string)
  4714. "Add text properties to string, allowing Org to act on it."
  4715. (org-add-props string nil
  4716. 'mouse-face 'highlight
  4717. 'help-echo (if buffer-file-name
  4718. (format "mouse-2 or RET jump to diary file %s"
  4719. (abbreviate-file-name buffer-file-name))
  4720. "")
  4721. 'org-agenda-diary-link t
  4722. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4723. (defun org-diary-default-entry ()
  4724. "Add a dummy entry to the diary.
  4725. Needed to avoid empty dates which mess up holiday display."
  4726. ;; Catch the error if dealing with the new add-to-diary-alist
  4727. (when org-disable-agenda-to-diary
  4728. (condition-case nil
  4729. (org-add-to-diary-list original-date "Org mode dummy" "")
  4730. (error
  4731. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4732. (defun org-add-to-diary-list (&rest args)
  4733. (if (fboundp 'diary-add-to-list)
  4734. (apply 'diary-add-to-list args)
  4735. (apply 'add-to-diary-list args)))
  4736. (defvar org-diary-last-run-time nil)
  4737. ;;;###autoload
  4738. (defun org-diary (&rest args)
  4739. "Return diary information from org files.
  4740. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4741. It accesses org files and extracts information from those files to be
  4742. listed in the diary. The function accepts arguments specifying what
  4743. items should be listed. For a list of arguments allowed here, see the
  4744. variable `org-agenda-entry-types'.
  4745. The call in the diary file should look like this:
  4746. &%%(org-diary) ~/path/to/some/orgfile.org
  4747. Use a separate line for each org file to check. Or, if you omit the file name,
  4748. all files listed in `org-agenda-files' will be checked automatically:
  4749. &%%(org-diary)
  4750. If you don't give any arguments (as in the example above), the default value
  4751. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4752. So the example above may also be written as
  4753. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4754. The function expects the lisp variables `entry' and `date' to be provided
  4755. by the caller, because this is how the calendar works. Don't use this
  4756. function from a program - use `org-agenda-get-day-entries' instead."
  4757. (when (> (- (float-time)
  4758. org-agenda-last-marker-time)
  4759. 5)
  4760. ;; I am not sure if this works with sticky agendas, because the marker
  4761. ;; list is then no longer a global variable.
  4762. (org-agenda-reset-markers))
  4763. (org-compile-prefix-format 'agenda)
  4764. (org-set-sorting-strategy 'agenda)
  4765. (setq args (or args org-agenda-entry-types))
  4766. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4767. (list entry)
  4768. (org-agenda-files t)))
  4769. (time (float-time))
  4770. file rtn results)
  4771. (when (or (not org-diary-last-run-time)
  4772. (> (- time
  4773. org-diary-last-run-time)
  4774. 3))
  4775. (org-agenda-prepare-buffers files))
  4776. (setq org-diary-last-run-time time)
  4777. ;; If this is called during org-agenda, don't return any entries to
  4778. ;; the calendar. Org Agenda will list these entries itself.
  4779. (when org-disable-agenda-to-diary (setq files nil))
  4780. (while (setq file (pop files))
  4781. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4782. (setq results (append results rtn)))
  4783. (when results
  4784. (setq results
  4785. (mapcar (lambda (i) (replace-regexp-in-string
  4786. org-link-bracket-re "\\2" i)) results))
  4787. (concat (org-agenda-finalize-entries results) "\n"))))
  4788. ;;; Agenda entry finders
  4789. (defun org-agenda--timestamp-to-absolute (&rest args)
  4790. "Call `org-time-string-to-absolute' with ARGS.
  4791. However, throw `:skip' whenever an error is raised."
  4792. (condition-case e
  4793. (apply #'org-time-string-to-absolute args)
  4794. (org-diary-sexp-no-match (throw :skip nil))
  4795. (error
  4796. (message "%s; Skipping entry" (error-message-string e))
  4797. (throw :skip nil))))
  4798. (defun org-agenda-get-day-entries (file date &rest args)
  4799. "Does the work for `org-diary' and `org-agenda'.
  4800. FILE is the path to a file to be checked for entries. DATE is date like
  4801. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4802. which kind of entries should be extracted. For details about these, see
  4803. the documentation of `org-diary'."
  4804. (let* ((org-startup-folded nil)
  4805. (org-startup-align-all-tables nil)
  4806. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4807. (error "No such file %s" file))))
  4808. (if (not buffer)
  4809. ;; If file does not exist, signal it in diary nonetheless.
  4810. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4811. (with-current-buffer buffer
  4812. (unless (derived-mode-p 'org-mode)
  4813. (error "Agenda file %s is not in Org mode" file))
  4814. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4815. (setf org-agenda-current-date date)
  4816. (save-excursion
  4817. (save-restriction
  4818. (if (eq buffer org-agenda-restrict)
  4819. (narrow-to-region org-agenda-restrict-begin
  4820. org-agenda-restrict-end)
  4821. (widen))
  4822. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4823. ;; first in order to populate DEADLINES before passing it.
  4824. ;;
  4825. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4826. ;; guarding us from modifying `org-agenda-entry-types'.
  4827. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4828. (when (and (memq :scheduled args) (memq :scheduled* args))
  4829. (setf args (delq :scheduled* args)))
  4830. (cond
  4831. ((memq :deadline args)
  4832. (setf args (cons :deadline
  4833. (delq :deadline (delq :deadline* args)))))
  4834. ((memq :deadline* args)
  4835. (setf args (cons :deadline* (delq :deadline* args)))))
  4836. ;; Collect list of headlines. Return them flattened.
  4837. (let ((case-fold-search nil) results deadlines)
  4838. (dolist (arg args (apply #'nconc (nreverse results)))
  4839. (pcase arg
  4840. ((and :todo (guard (org-agenda-today-p date)))
  4841. (push (org-agenda-get-todos) results))
  4842. (:timestamp
  4843. (push (org-agenda-get-blocks) results)
  4844. (push (org-agenda-get-timestamps deadlines) results))
  4845. (:sexp
  4846. (push (org-agenda-get-sexps) results))
  4847. (:scheduled
  4848. (push (org-agenda-get-scheduled deadlines) results))
  4849. (:scheduled*
  4850. (push (org-agenda-get-scheduled deadlines t) results))
  4851. (:closed
  4852. (push (org-agenda-get-progress) results))
  4853. (:deadline
  4854. (setf deadlines (org-agenda-get-deadlines))
  4855. (push deadlines results))
  4856. (:deadline*
  4857. (setf deadlines (org-agenda-get-deadlines t))
  4858. (push deadlines results)))))))))))
  4859. (defsubst org-em (x y list)
  4860. "Is X or Y a member of LIST?"
  4861. (or (memq x list) (memq y list)))
  4862. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4863. (defvar org-agenda-sorting-strategy-selected nil)
  4864. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4865. "Retrieve timestamp information for sorting agenda views.
  4866. Given a point or marker POM, returns a cons cell of the timestamp
  4867. and the timestamp type relevant for the sorting strategy in
  4868. `org-agenda-sorting-strategy-selected'."
  4869. (let (ts ts-date-type)
  4870. (save-match-data
  4871. (cond ((org-em 'scheduled-up 'scheduled-down
  4872. org-agenda-sorting-strategy-selected)
  4873. (setq ts (org-entry-get pom "SCHEDULED")
  4874. ts-date-type " scheduled"))
  4875. ((org-em 'deadline-up 'deadline-down
  4876. org-agenda-sorting-strategy-selected)
  4877. (setq ts (org-entry-get pom "DEADLINE")
  4878. ts-date-type " deadline"))
  4879. ((org-em 'ts-up 'ts-down
  4880. org-agenda-sorting-strategy-selected)
  4881. (setq ts (org-entry-get pom "TIMESTAMP")
  4882. ts-date-type " timestamp"))
  4883. ((org-em 'tsia-up 'tsia-down
  4884. org-agenda-sorting-strategy-selected)
  4885. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4886. ts-date-type " timestamp_ia"))
  4887. ((org-em 'timestamp-up 'timestamp-down
  4888. org-agenda-sorting-strategy-selected)
  4889. (setq ts (or (org-entry-get pom "SCHEDULED")
  4890. (org-entry-get pom "DEADLINE")
  4891. (org-entry-get pom "TIMESTAMP")
  4892. (org-entry-get pom "TIMESTAMP_IA"))
  4893. ts-date-type ""))
  4894. (t (setq ts-date-type "")))
  4895. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4896. ts-date-type))))
  4897. (defun org-agenda-get-todos ()
  4898. "Return the TODO information for agenda display."
  4899. (let* ((props (list 'face nil
  4900. 'done-face 'org-agenda-done
  4901. 'org-not-done-regexp org-not-done-regexp
  4902. 'org-todo-regexp org-todo-regexp
  4903. 'org-complex-heading-regexp org-complex-heading-regexp
  4904. 'mouse-face 'highlight
  4905. 'help-echo
  4906. (format "mouse-2 or RET jump to org file %s"
  4907. (abbreviate-file-name buffer-file-name))))
  4908. (case-fold-search nil)
  4909. (regexp (format org-heading-keyword-regexp-format
  4910. (cond
  4911. ((and org-select-this-todo-keyword
  4912. (equal org-select-this-todo-keyword "*"))
  4913. org-todo-regexp)
  4914. (org-select-this-todo-keyword
  4915. (concat "\\("
  4916. (mapconcat 'identity
  4917. (org-split-string
  4918. org-select-this-todo-keyword
  4919. "|")
  4920. "\\|") "\\)"))
  4921. (t org-not-done-regexp))))
  4922. marker priority category level tags todo-state
  4923. ts-date ts-date-type ts-date-pair
  4924. ee txt beg end inherited-tags todo-state-end-pos)
  4925. (goto-char (point-min))
  4926. (while (re-search-forward regexp nil t)
  4927. (catch :skip
  4928. (save-match-data
  4929. (beginning-of-line)
  4930. (org-agenda-skip)
  4931. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4932. (unless (and (setq todo-state (org-get-todo-state))
  4933. (setq todo-state-end-pos (match-end 2)))
  4934. (goto-char end)
  4935. (throw :skip nil))
  4936. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4937. (goto-char (1+ beg))
  4938. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4939. (throw :skip nil)))
  4940. (goto-char (match-beginning 2))
  4941. (setq marker (org-agenda-new-marker (match-beginning 0))
  4942. category (org-get-category)
  4943. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4944. ts-date (car ts-date-pair)
  4945. ts-date-type (cdr ts-date-pair)
  4946. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4947. inherited-tags
  4948. (or (eq org-agenda-show-inherited-tags 'always)
  4949. (and (listp org-agenda-show-inherited-tags)
  4950. (memq 'todo org-agenda-show-inherited-tags))
  4951. (and (eq org-agenda-show-inherited-tags t)
  4952. (or (eq org-agenda-use-tag-inheritance t)
  4953. (memq 'todo org-agenda-use-tag-inheritance))))
  4954. tags (org-get-tags nil (not inherited-tags))
  4955. level (make-string (org-reduced-level (org-outline-level)) ? )
  4956. txt (org-agenda-format-item "" txt level category tags t)
  4957. priority (1+ (org-get-priority txt)))
  4958. (org-add-props txt props
  4959. 'org-marker marker 'org-hd-marker marker
  4960. 'priority priority
  4961. 'level level
  4962. 'ts-date ts-date
  4963. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4964. (push txt ee)
  4965. (if org-agenda-todo-list-sublevels
  4966. (goto-char todo-state-end-pos)
  4967. (org-end-of-subtree 'invisible))))
  4968. (nreverse ee)))
  4969. (defun org-agenda-todo-custom-ignore-p (time n)
  4970. "Check whether timestamp is farther away than n number of days.
  4971. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4972. `org-agenda-todo-ignore-scheduled' or
  4973. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4974. (let ((days (org-time-stamp-to-now
  4975. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4976. (if (>= n 0)
  4977. (>= days n)
  4978. (<= days n))))
  4979. ;;;###autoload
  4980. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4981. (&optional end)
  4982. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4983. (when (or org-agenda-todo-ignore-with-date
  4984. org-agenda-todo-ignore-scheduled
  4985. org-agenda-todo-ignore-deadlines
  4986. org-agenda-todo-ignore-timestamp)
  4987. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4988. (save-excursion
  4989. (or (and org-agenda-todo-ignore-with-date
  4990. (re-search-forward org-ts-regexp end t))
  4991. (and org-agenda-todo-ignore-scheduled
  4992. (re-search-forward org-scheduled-time-regexp end t)
  4993. (cond
  4994. ((eq org-agenda-todo-ignore-scheduled 'future)
  4995. (> (org-time-stamp-to-now
  4996. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4997. ((eq org-agenda-todo-ignore-scheduled 'past)
  4998. (<= (org-time-stamp-to-now
  4999. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5000. ((numberp org-agenda-todo-ignore-scheduled)
  5001. (org-agenda-todo-custom-ignore-p
  5002. (match-string 1) org-agenda-todo-ignore-scheduled))
  5003. (t)))
  5004. (and org-agenda-todo-ignore-deadlines
  5005. (re-search-forward org-deadline-time-regexp end t)
  5006. (cond
  5007. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5008. ((eq org-agenda-todo-ignore-deadlines 'far)
  5009. (not (org-deadline-close-p (match-string 1))))
  5010. ((eq org-agenda-todo-ignore-deadlines 'future)
  5011. (> (org-time-stamp-to-now
  5012. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5013. ((eq org-agenda-todo-ignore-deadlines 'past)
  5014. (<= (org-time-stamp-to-now
  5015. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5016. ((numberp org-agenda-todo-ignore-deadlines)
  5017. (org-agenda-todo-custom-ignore-p
  5018. (match-string 1) org-agenda-todo-ignore-deadlines))
  5019. (t (org-deadline-close-p (match-string 1)))))
  5020. (and org-agenda-todo-ignore-timestamp
  5021. (let ((buffer (current-buffer))
  5022. (regexp
  5023. (concat
  5024. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5025. (start (point)))
  5026. ;; Copy current buffer into a temporary one
  5027. (with-temp-buffer
  5028. (insert-buffer-substring buffer start end)
  5029. (goto-char (point-min))
  5030. ;; Delete SCHEDULED and DEADLINE items
  5031. (while (re-search-forward regexp end t)
  5032. (delete-region (match-beginning 0) (match-end 0)))
  5033. (goto-char (point-min))
  5034. ;; No search for timestamp left
  5035. (when (re-search-forward org-ts-regexp nil t)
  5036. (cond
  5037. ((eq org-agenda-todo-ignore-timestamp 'future)
  5038. (> (org-time-stamp-to-now
  5039. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5040. ((eq org-agenda-todo-ignore-timestamp 'past)
  5041. (<= (org-time-stamp-to-now
  5042. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5043. ((numberp org-agenda-todo-ignore-timestamp)
  5044. (org-agenda-todo-custom-ignore-p
  5045. (match-string 1) org-agenda-todo-ignore-timestamp))
  5046. (t))))))))))
  5047. (defun org-agenda-get-timestamps (&optional deadlines)
  5048. "Return the date stamp information for agenda display.
  5049. Optional argument DEADLINES is a list of deadline items to be
  5050. displayed in agenda view."
  5051. (let* ((props (list 'face 'org-agenda-calendar-event
  5052. 'org-not-done-regexp org-not-done-regexp
  5053. 'org-todo-regexp org-todo-regexp
  5054. 'org-complex-heading-regexp org-complex-heading-regexp
  5055. 'mouse-face 'highlight
  5056. 'help-echo
  5057. (format "mouse-2 or RET jump to Org file %s"
  5058. (abbreviate-file-name buffer-file-name))))
  5059. (current (calendar-absolute-from-gregorian date))
  5060. (today (org-today))
  5061. (deadline-position-alist
  5062. (mapcar (lambda (d)
  5063. (let ((m (get-text-property 0 'org-hd-marker d)))
  5064. (and m (marker-position m))))
  5065. deadlines))
  5066. ;; Match time-stamps set to current date, time-stamps with
  5067. ;; a repeater, and S-exp time-stamps.
  5068. (regexp
  5069. (concat
  5070. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5071. (regexp-quote
  5072. (substring
  5073. (format-time-string
  5074. (car org-time-stamp-formats)
  5075. (apply #'encode-time ; DATE bound by calendar
  5076. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5077. 1 11))
  5078. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5079. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5080. timestamp-items)
  5081. (goto-char (point-min))
  5082. (while (re-search-forward regexp nil t)
  5083. ;; Skip date ranges, scheduled and deadlines, which are handled
  5084. ;; specially. Also skip time-stamps before first headline as
  5085. ;; there would be no entry to add to the agenda. Eventually,
  5086. ;; ignore clock entries.
  5087. (catch :skip
  5088. (save-match-data
  5089. (when (or (org-at-date-range-p)
  5090. (org-at-planning-p)
  5091. (org-before-first-heading-p)
  5092. (and org-agenda-include-inactive-timestamps
  5093. (org-at-clock-log-p)))
  5094. (throw :skip nil))
  5095. (org-agenda-skip))
  5096. (let* ((pos (match-beginning 0))
  5097. (repeat (match-string 1))
  5098. (sexp-entry (match-string 3))
  5099. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5100. (save-excursion
  5101. (goto-char pos)
  5102. (looking-at org-ts-regexp-both)
  5103. (match-string 0))))
  5104. (todo-state (org-get-todo-state))
  5105. (warntime (get-text-property (point) 'org-appt-warntime))
  5106. (done? (member todo-state org-done-keywords)))
  5107. ;; Possibly skip done tasks.
  5108. (when (and done? org-agenda-skip-timestamp-if-done)
  5109. (throw :skip t))
  5110. ;; S-exp entry doesn't match current day: skip it.
  5111. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5112. (throw :skip nil))
  5113. (when repeat
  5114. (let* ((past
  5115. ;; A repeating time stamp is shown at its base
  5116. ;; date and every repeated date up to TODAY. If
  5117. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5118. ;; however, only the last repeat before today
  5119. ;; (inclusive) is shown.
  5120. (org-agenda--timestamp-to-absolute
  5121. repeat
  5122. (if (or (> current today)
  5123. (eq org-agenda-prefer-last-repeat t)
  5124. (member todo-state org-agenda-prefer-last-repeat))
  5125. today
  5126. current)
  5127. 'past (current-buffer) pos))
  5128. (future
  5129. ;; Display every repeated date past TODAY
  5130. ;; (exclusive) unless
  5131. ;; `org-agenda-show-future-repeats' is nil. If
  5132. ;; this variable is set to `next', only display
  5133. ;; the first repeated date after TODAY
  5134. ;; (exclusive).
  5135. (cond
  5136. ((<= current today) past)
  5137. ((not org-agenda-show-future-repeats) past)
  5138. (t
  5139. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5140. (1+ today)
  5141. current)))
  5142. (org-agenda--timestamp-to-absolute
  5143. repeat base 'future (current-buffer) pos))))))
  5144. (when (and (/= current past) (/= current future))
  5145. (throw :skip nil))))
  5146. (save-excursion
  5147. (re-search-backward org-outline-regexp-bol nil t)
  5148. ;; Possibly skip time-stamp when a deadline is set.
  5149. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5150. (assq (point) deadline-position-alist))
  5151. (throw :skip nil))
  5152. (let* ((category (org-get-category pos))
  5153. (inherited-tags
  5154. (or (eq org-agenda-show-inherited-tags 'always)
  5155. (and (consp org-agenda-show-inherited-tags)
  5156. (memq 'agenda org-agenda-show-inherited-tags))
  5157. (and (eq org-agenda-show-inherited-tags t)
  5158. (or (eq org-agenda-use-tag-inheritance t)
  5159. (memq 'agenda
  5160. org-agenda-use-tag-inheritance)))))
  5161. (tags (org-get-tags nil (not inherited-tags)))
  5162. (level (make-string (org-reduced-level (org-outline-level))
  5163. ?\s))
  5164. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5165. (match-string 1)))
  5166. (inactive? (= (char-after pos) ?\[))
  5167. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5168. (item
  5169. (org-agenda-format-item
  5170. (and inactive? org-agenda-inactive-leader)
  5171. head level category tags time-stamp org-ts-regexp habit?)))
  5172. (org-add-props item props
  5173. 'priority (if habit?
  5174. (org-habit-get-priority (org-habit-parse-todo))
  5175. (org-get-priority item))
  5176. 'org-marker (org-agenda-new-marker pos)
  5177. 'org-hd-marker (org-agenda-new-marker)
  5178. 'date date
  5179. 'level level
  5180. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5181. current)
  5182. 'todo-state todo-state
  5183. 'warntime warntime
  5184. 'type "timestamp")
  5185. (push item timestamp-items))))
  5186. (when org-agenda-skip-additional-timestamps-same-entry
  5187. (outline-next-heading))))
  5188. (nreverse timestamp-items)))
  5189. (defun org-agenda-get-sexps ()
  5190. "Return the sexp information for agenda display."
  5191. (require 'diary-lib)
  5192. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5193. 'mouse-face 'highlight
  5194. 'help-echo
  5195. (format "mouse-2 or RET jump to org file %s"
  5196. (abbreviate-file-name buffer-file-name))))
  5197. (regexp "^&?%%(")
  5198. marker category extra level ee txt tags entry
  5199. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5200. (goto-char (point-min))
  5201. (while (re-search-forward regexp nil t)
  5202. (catch :skip
  5203. (org-agenda-skip)
  5204. (setq beg (match-beginning 0))
  5205. (goto-char (1- (match-end 0)))
  5206. (setq b (point))
  5207. (forward-sexp 1)
  5208. (setq sexp (buffer-substring b (point)))
  5209. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5210. (org-trim (match-string 1))
  5211. ""))
  5212. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5213. (when result
  5214. (setq marker (org-agenda-new-marker beg)
  5215. level (make-string (org-reduced-level (org-outline-level)) ? )
  5216. category (org-get-category beg)
  5217. inherited-tags
  5218. (or (eq org-agenda-show-inherited-tags 'always)
  5219. (and (listp org-agenda-show-inherited-tags)
  5220. (memq 'agenda org-agenda-show-inherited-tags))
  5221. (and (eq org-agenda-show-inherited-tags t)
  5222. (or (eq org-agenda-use-tag-inheritance t)
  5223. (memq 'agenda org-agenda-use-tag-inheritance))))
  5224. tags (org-get-tags nil (not inherited-tags))
  5225. todo-state (org-get-todo-state)
  5226. warntime (get-text-property (point) 'org-appt-warntime)
  5227. extra nil)
  5228. (dolist (r (if (stringp result)
  5229. (list result)
  5230. result)) ;; we expect a list here
  5231. (when (and org-agenda-diary-sexp-prefix
  5232. (string-match org-agenda-diary-sexp-prefix r))
  5233. (setq extra (match-string 0 r)
  5234. r (replace-match "" nil nil r)))
  5235. (if (string-match "\\S-" r)
  5236. (setq txt r)
  5237. (setq txt "SEXP entry returned empty string"))
  5238. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5239. (org-add-props txt props 'org-marker marker
  5240. 'date date 'todo-state todo-state
  5241. 'level level 'type "sexp" 'warntime warntime)
  5242. (push txt ee)))))
  5243. (nreverse ee)))
  5244. ;; Calendar sanity: define some functions that are independent of
  5245. ;; `calendar-date-style'.
  5246. (defun org-anniversary (year month day &optional mark)
  5247. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5248. (with-no-warnings
  5249. (let ((calendar-date-style 'iso))
  5250. (diary-anniversary year month day mark))))
  5251. (defun org-cyclic (N year month day &optional mark)
  5252. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5253. (with-no-warnings
  5254. (let ((calendar-date-style 'iso))
  5255. (diary-cyclic N year month day mark))))
  5256. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5257. "Like `diary-block', but with fixed (ISO) order of arguments."
  5258. (with-no-warnings
  5259. (let ((calendar-date-style 'iso))
  5260. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5261. (defun org-date (year month day &optional mark)
  5262. "Like `diary-date', but with fixed (ISO) order of arguments."
  5263. (with-no-warnings
  5264. (let ((calendar-date-style 'iso))
  5265. (diary-date year month day mark))))
  5266. ;; Define the `org-class' function
  5267. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5268. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5269. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5270. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5271. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5272. `holidays', then any date that is known by the Emacs calendar to be a
  5273. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5274. then those holidays will be skipped."
  5275. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5276. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5277. (d (calendar-absolute-from-gregorian date))
  5278. (h (when skip-weeks (calendar-check-holidays date))))
  5279. (and
  5280. (<= date1 d)
  5281. (<= d date2)
  5282. (= (calendar-day-of-week date) dayname)
  5283. (or (not skip-weeks)
  5284. (progn
  5285. (require 'cal-iso)
  5286. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5287. (not (or (and h (memq 'holidays skip-weeks))
  5288. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5289. entry)))
  5290. (defalias 'org-get-closed 'org-agenda-get-progress)
  5291. (defun org-agenda-get-progress ()
  5292. "Return the logged TODO entries for agenda display."
  5293. (let* ((props (list 'mouse-face 'highlight
  5294. 'org-not-done-regexp org-not-done-regexp
  5295. 'org-todo-regexp org-todo-regexp
  5296. 'org-complex-heading-regexp org-complex-heading-regexp
  5297. 'help-echo
  5298. (format "mouse-2 or RET jump to org file %s"
  5299. (abbreviate-file-name buffer-file-name))))
  5300. (items (if (consp org-agenda-show-log-scoped)
  5301. org-agenda-show-log-scoped
  5302. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5303. '(clock)
  5304. org-agenda-log-mode-items)))
  5305. (parts
  5306. (delq nil
  5307. (list
  5308. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5309. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5310. (when (memq 'state items)
  5311. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5312. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5313. (error "`org-agenda-log-mode-items' is empty")))
  5314. (regexp (concat
  5315. "\\(" parts-re "\\)"
  5316. " *\\["
  5317. (regexp-quote
  5318. (substring
  5319. (format-time-string
  5320. (car org-time-stamp-formats)
  5321. (apply 'encode-time ; DATE bound by calendar
  5322. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5323. 1 11))))
  5324. (org-agenda-search-headline-for-time nil)
  5325. marker hdmarker priority category level tags closedp type
  5326. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5327. (goto-char (point-min))
  5328. (while (re-search-forward regexp nil t)
  5329. (catch :skip
  5330. (org-agenda-skip)
  5331. (setq marker (org-agenda-new-marker (match-beginning 0))
  5332. closedp (equal (match-string 1) org-closed-string)
  5333. statep (equal (string-to-char (match-string 1)) ?-)
  5334. clockp (not (or closedp statep))
  5335. state (and statep (match-string 2))
  5336. category (org-get-category (match-beginning 0))
  5337. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5338. (when (string-match "\\]" timestr)
  5339. ;; substring should only run to end of time stamp
  5340. (setq rest (substring timestr (match-end 0))
  5341. timestr (substring timestr 0 (match-end 0)))
  5342. (if (and (not closedp) (not statep)
  5343. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5344. rest))
  5345. (progn (setq timestr (concat (substring timestr 0 -1)
  5346. "-" (match-string 1 rest) "]"))
  5347. (setq clocked (match-string 2 rest)))
  5348. (setq clocked "-")))
  5349. (save-excursion
  5350. (setq extra
  5351. (cond
  5352. ((not org-agenda-log-mode-add-notes) nil)
  5353. (statep
  5354. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5355. (match-string 1)))
  5356. (clockp
  5357. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5358. (match-string 1)))))
  5359. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5360. (throw :skip nil)
  5361. (goto-char (match-beginning 0))
  5362. (setq hdmarker (org-agenda-new-marker)
  5363. inherited-tags
  5364. (or (eq org-agenda-show-inherited-tags 'always)
  5365. (and (listp org-agenda-show-inherited-tags)
  5366. (memq 'todo org-agenda-show-inherited-tags))
  5367. (and (eq org-agenda-show-inherited-tags t)
  5368. (or (eq org-agenda-use-tag-inheritance t)
  5369. (memq 'todo org-agenda-use-tag-inheritance))))
  5370. tags (org-get-tags nil (not inherited-tags))
  5371. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5372. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5373. (setq txt (match-string 1))
  5374. (when extra
  5375. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5376. (setq txt (concat (substring txt 0 (match-beginning 1))
  5377. " - " extra " " (match-string 2 txt)))
  5378. (setq txt (concat txt " - " extra))))
  5379. (setq txt (org-agenda-format-item
  5380. (cond
  5381. (closedp "Closed: ")
  5382. (statep (concat "State: (" state ")"))
  5383. (t (concat "Clocked: (" clocked ")")))
  5384. txt level category tags timestr)))
  5385. (setq type (cond (closedp "closed")
  5386. (statep "state")
  5387. (t "clock")))
  5388. (setq priority 100000)
  5389. (org-add-props txt props
  5390. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5391. 'priority priority 'level level
  5392. 'type type 'date date
  5393. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5394. (push txt ee))
  5395. (goto-char (point-at-eol))))
  5396. (nreverse ee)))
  5397. (defun org-agenda-show-clocking-issues ()
  5398. "Add overlays, showing issues with clocking.
  5399. See also the user option `org-agenda-clock-consistency-checks'."
  5400. (interactive)
  5401. (let* ((pl org-agenda-clock-consistency-checks)
  5402. (re (concat "^[ \t]*"
  5403. org-clock-string
  5404. "[ \t]+"
  5405. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5406. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5407. (tlstart 0.)
  5408. (tlend 0.)
  5409. (maxtime (org-duration-to-minutes
  5410. (or (plist-get pl :max-duration) "24:00")))
  5411. (mintime (org-duration-to-minutes
  5412. (or (plist-get pl :min-duration) 0)))
  5413. (maxgap (org-duration-to-minutes
  5414. ;; default 30:00 means never complain
  5415. (or (plist-get pl :max-gap) "30:00")))
  5416. (gapok (mapcar #'org-duration-to-minutes
  5417. (plist-get pl :gap-ok-around)))
  5418. (def-face (or (plist-get pl :default-face)
  5419. '((:background "DarkRed") (:foreground "white"))))
  5420. issue face m te ts dt ov)
  5421. (goto-char (point-min))
  5422. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5423. (setq issue nil face def-face)
  5424. (catch 'next
  5425. (setq m (org-get-at-bol 'org-marker)
  5426. te nil ts nil)
  5427. (unless (and m (markerp m))
  5428. (setq issue "No valid clock line") (throw 'next t))
  5429. (org-with-point-at m
  5430. (save-excursion
  5431. (goto-char (point-at-bol))
  5432. (unless (looking-at re)
  5433. (error "No valid Clock line")
  5434. (throw 'next t))
  5435. (unless (match-end 3)
  5436. (setq issue "No end time"
  5437. face (or (plist-get pl :no-end-time-face) face))
  5438. (throw 'next t))
  5439. (setq ts (match-string 1)
  5440. te (match-string 3)
  5441. ts (float-time
  5442. (apply #'encode-time (org-parse-time-string ts)))
  5443. te (float-time
  5444. (apply #'encode-time (org-parse-time-string te)))
  5445. dt (- te ts))))
  5446. (cond
  5447. ((> dt (* 60 maxtime))
  5448. ;; a very long clocking chunk
  5449. (setq issue (format "Clocking interval is very long: %s"
  5450. (org-duration-from-minutes (floor dt 60)))
  5451. face (or (plist-get pl :long-face) face)))
  5452. ((< dt (* 60 mintime))
  5453. ;; a very short clocking chunk
  5454. (setq issue (format "Clocking interval is very short: %s"
  5455. (org-duration-from-minutes (floor dt 60)))
  5456. face (or (plist-get pl :short-face) face)))
  5457. ((and (> tlend 0) (< ts tlend))
  5458. ;; Two clock entries are overlapping
  5459. (setq issue (format "Clocking overlap: %d minutes"
  5460. (/ (- tlend ts) 60))
  5461. face (or (plist-get pl :overlap-face) face)))
  5462. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5463. ;; There is a gap, lets see if we need to report it
  5464. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5465. (setq issue (format "Clocking gap: %d minutes"
  5466. (/ (- ts tlend) 60))
  5467. face (or (plist-get pl :gap-face) face))))
  5468. (t nil)))
  5469. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5470. (when issue
  5471. ;; OK, there was some issue, add an overlay to show the issue
  5472. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5473. (overlay-put ov 'before-string
  5474. (concat
  5475. (org-add-props
  5476. (format "%-43s" (concat " " issue))
  5477. nil
  5478. 'face face)
  5479. "\n"))
  5480. (overlay-put ov 'evaporate t)))))
  5481. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5482. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5483. (catch 'exit
  5484. (unless ok-list
  5485. ;; there are no OK times for gaps...
  5486. (throw 'exit nil))
  5487. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5488. ;; This is more than 24 hours, so it is OK.
  5489. ;; because we have at least one OK time, that must be in the
  5490. ;; 24 hour interval.
  5491. (throw 'exit t))
  5492. ;; We have a shorter gap.
  5493. ;; Now we have to get the minute of the day when these times are
  5494. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5495. (t2dec (decode-time (seconds-to-time t2)))
  5496. ;; compute the minute on the day
  5497. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5498. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5499. (when (< min2 min1)
  5500. ;; if min2 is smaller than min1, this means it is on the next day.
  5501. ;; Wrap it to after midnight.
  5502. (setq min2 (+ min2 1440)))
  5503. ;; Now check if any of the OK times is in the gap
  5504. (mapc (lambda (x)
  5505. ;; Wrap the time to after midnight if necessary
  5506. (when (< x min1) (setq x (+ x 1440)))
  5507. ;; Check if in interval
  5508. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5509. ok-list)
  5510. ;; Nope, this gap is not OK
  5511. nil)))
  5512. (defun org-agenda-get-deadlines (&optional with-hour)
  5513. "Return the deadline information for agenda display.
  5514. When WITH-HOUR is non-nil, only return deadlines with an hour
  5515. specification like [h]h:mm."
  5516. (let* ((props (list 'mouse-face 'highlight
  5517. 'org-not-done-regexp org-not-done-regexp
  5518. 'org-todo-regexp org-todo-regexp
  5519. 'org-complex-heading-regexp org-complex-heading-regexp
  5520. 'help-echo
  5521. (format "mouse-2 or RET jump to org file %s"
  5522. (abbreviate-file-name buffer-file-name))))
  5523. (regexp (if with-hour
  5524. org-deadline-time-hour-regexp
  5525. org-deadline-time-regexp))
  5526. (today (org-today))
  5527. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5528. (current (calendar-absolute-from-gregorian date))
  5529. deadline-items)
  5530. (goto-char (point-min))
  5531. (while (re-search-forward regexp nil t)
  5532. (catch :skip
  5533. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5534. (org-agenda-skip)
  5535. (let* ((s (match-string 1))
  5536. (pos (1- (match-beginning 1)))
  5537. (todo-state (save-match-data (org-get-todo-state)))
  5538. (done? (member todo-state org-done-keywords))
  5539. (sexp? (string-prefix-p "%%" s))
  5540. ;; DEADLINE is the deadline date for the entry. It is
  5541. ;; either the base date or the last repeat, according
  5542. ;; to `org-agenda-prefer-last-repeat'.
  5543. (deadline
  5544. (cond
  5545. (sexp? (org-agenda--timestamp-to-absolute s current))
  5546. ((or (eq org-agenda-prefer-last-repeat t)
  5547. (member todo-state org-agenda-prefer-last-repeat))
  5548. (org-agenda--timestamp-to-absolute
  5549. s today 'past (current-buffer) pos))
  5550. (t (org-agenda--timestamp-to-absolute s))))
  5551. ;; REPEAT is the future repeat closest from CURRENT,
  5552. ;; according to `org-agenda-show-future-repeats'. If
  5553. ;; the latter is nil, or if the time stamp has no
  5554. ;; repeat part, default to DEADLINE.
  5555. (repeat
  5556. (cond
  5557. (sexp? deadline)
  5558. ((<= current today) deadline)
  5559. ((not org-agenda-show-future-repeats) deadline)
  5560. (t
  5561. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5562. (1+ today)
  5563. current)))
  5564. (org-agenda--timestamp-to-absolute
  5565. s base 'future (current-buffer) pos)))))
  5566. (diff (- deadline current))
  5567. (suppress-prewarning
  5568. (let ((scheduled
  5569. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5570. (org-entry-get nil "SCHEDULED"))))
  5571. (cond
  5572. ((not scheduled) nil)
  5573. ;; The current item has a scheduled date, so
  5574. ;; evaluate its prewarning lead time.
  5575. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5576. ;; Use global prewarning-restart lead time.
  5577. org-agenda-skip-deadline-prewarning-if-scheduled)
  5578. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5579. 'pre-scheduled)
  5580. ;; Set pre-warning to no earlier than SCHEDULED.
  5581. (min (- deadline
  5582. (org-agenda--timestamp-to-absolute scheduled))
  5583. org-deadline-warning-days))
  5584. ;; Set pre-warning to deadline.
  5585. (t 0))))
  5586. (wdays (or suppress-prewarning (org-get-wdays s))))
  5587. (cond
  5588. ;; Only display deadlines at their base date, at future
  5589. ;; repeat occurrences or in today agenda.
  5590. ((= current deadline) nil)
  5591. ((= current repeat) nil)
  5592. ((not today?) (throw :skip nil))
  5593. ;; Upcoming deadline: display within warning period WDAYS.
  5594. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5595. ;; Overdue deadline: warn about it for
  5596. ;; `org-deadline-past-days' duration.
  5597. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5598. ;; Possibly skip done tasks.
  5599. (when (and done?
  5600. (or org-agenda-skip-deadline-if-done
  5601. (/= deadline current)))
  5602. (throw :skip nil))
  5603. (save-excursion
  5604. (re-search-backward "^\\*+[ \t]+" nil t)
  5605. (goto-char (match-end 0))
  5606. (let* ((category (org-get-category))
  5607. (level (make-string (org-reduced-level (org-outline-level))
  5608. ?\s))
  5609. (head (buffer-substring (point) (line-end-position)))
  5610. (inherited-tags
  5611. (or (eq org-agenda-show-inherited-tags 'always)
  5612. (and (listp org-agenda-show-inherited-tags)
  5613. (memq 'agenda org-agenda-show-inherited-tags))
  5614. (and (eq org-agenda-show-inherited-tags t)
  5615. (or (eq org-agenda-use-tag-inheritance t)
  5616. (memq 'agenda
  5617. org-agenda-use-tag-inheritance)))))
  5618. (tags (org-get-tags nil (not inherited-tags)))
  5619. (time
  5620. (cond
  5621. ;; No time of day designation if it is only
  5622. ;; a reminder.
  5623. ((and (/= current deadline) (/= current repeat)) nil)
  5624. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5625. (concat (substring s (match-beginning 1)) " "))
  5626. (t 'time)))
  5627. (item
  5628. (org-agenda-format-item
  5629. ;; Insert appropriate suffixes before deadlines.
  5630. ;; Those only apply to today agenda.
  5631. (pcase-let ((`(,now ,future ,past)
  5632. org-agenda-deadline-leaders))
  5633. (cond
  5634. ((and today? (< deadline today)) (format past (- diff)))
  5635. ((and today? (> deadline today)) (format future diff))
  5636. (t now)))
  5637. head level category tags time))
  5638. (face (org-agenda-deadline-face
  5639. (- 1 (/ (float diff) (max wdays 1)))))
  5640. (upcoming? (and today? (> deadline today)))
  5641. (warntime (get-text-property (point) 'org-appt-warntime)))
  5642. (org-add-props item props
  5643. 'org-marker (org-agenda-new-marker pos)
  5644. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5645. 'warntime warntime
  5646. 'level level
  5647. 'ts-date deadline
  5648. 'priority
  5649. ;; Adjust priority to today reminders about deadlines.
  5650. ;; Overdue deadlines get the highest priority
  5651. ;; increase, then imminent deadlines and eventually
  5652. ;; more distant deadlines.
  5653. (let ((adjust (if today? (- diff) 0)))
  5654. (+ adjust (org-get-priority item)))
  5655. 'todo-state todo-state
  5656. 'type (if upcoming? "upcoming-deadline" "deadline")
  5657. 'date (if upcoming? date deadline)
  5658. 'face (if done? 'org-agenda-done face)
  5659. 'undone-face face
  5660. 'done-face 'org-agenda-done)
  5661. (push item deadline-items))))))
  5662. (nreverse deadline-items)))
  5663. (defun org-agenda-deadline-face (fraction)
  5664. "Return the face to displaying a deadline item.
  5665. FRACTION is what fraction of the head-warning time has passed."
  5666. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5667. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5668. "Return the scheduled information for agenda display.
  5669. Optional argument DEADLINES is a list of deadline items to be
  5670. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5671. scheduled items with an hour specification like [h]h:mm."
  5672. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5673. 'org-todo-regexp org-todo-regexp
  5674. 'org-complex-heading-regexp org-complex-heading-regexp
  5675. 'done-face 'org-agenda-done
  5676. 'mouse-face 'highlight
  5677. 'help-echo
  5678. (format "mouse-2 or RET jump to Org file %s"
  5679. (abbreviate-file-name buffer-file-name))))
  5680. (regexp (if with-hour
  5681. org-scheduled-time-hour-regexp
  5682. org-scheduled-time-regexp))
  5683. (today (org-today))
  5684. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5685. (current (calendar-absolute-from-gregorian date))
  5686. (deadline-pos
  5687. (mapcar (lambda (d)
  5688. (let ((m (get-text-property 0 'org-hd-marker d)))
  5689. (and m (marker-position m))))
  5690. deadlines))
  5691. scheduled-items)
  5692. (goto-char (point-min))
  5693. (while (re-search-forward regexp nil t)
  5694. (catch :skip
  5695. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5696. (org-agenda-skip)
  5697. (let* ((s (match-string 1))
  5698. (pos (1- (match-beginning 1)))
  5699. (todo-state (save-match-data (org-get-todo-state)))
  5700. (donep (member todo-state org-done-keywords))
  5701. (sexp? (string-prefix-p "%%" s))
  5702. ;; SCHEDULE is the scheduled date for the entry. It is
  5703. ;; either the bare date or the last repeat, according
  5704. ;; to `org-agenda-prefer-last-repeat'.
  5705. (schedule
  5706. (cond
  5707. (sexp? (org-agenda--timestamp-to-absolute s current))
  5708. ((or (eq org-agenda-prefer-last-repeat t)
  5709. (member todo-state org-agenda-prefer-last-repeat))
  5710. (org-agenda--timestamp-to-absolute
  5711. s today 'past (current-buffer) pos))
  5712. (t (org-agenda--timestamp-to-absolute s))))
  5713. ;; REPEAT is the future repeat closest from CURRENT,
  5714. ;; according to `org-agenda-show-future-repeats'. If
  5715. ;; the latter is nil, or if the time stamp has no
  5716. ;; repeat part, default to SCHEDULE.
  5717. (repeat
  5718. (cond
  5719. (sexp? schedule)
  5720. ((<= current today) schedule)
  5721. ((not org-agenda-show-future-repeats) schedule)
  5722. (t
  5723. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5724. (1+ today)
  5725. current)))
  5726. (org-agenda--timestamp-to-absolute
  5727. s base 'future (current-buffer) pos)))))
  5728. (diff (- current schedule))
  5729. (warntime (get-text-property (point) 'org-appt-warntime))
  5730. (pastschedp (< schedule today))
  5731. (futureschedp (> schedule today))
  5732. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5733. (suppress-delay
  5734. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5735. (org-entry-get nil "DEADLINE"))))
  5736. (cond
  5737. ((not deadline) nil)
  5738. ;; The current item has a deadline date, so
  5739. ;; evaluate its delay time.
  5740. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5741. ;; Use global delay time.
  5742. (- org-agenda-skip-scheduled-delay-if-deadline))
  5743. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5744. 'post-deadline)
  5745. ;; Set delay to no later than DEADLINE.
  5746. (min (- schedule
  5747. (org-agenda--timestamp-to-absolute deadline))
  5748. org-scheduled-delay-days))
  5749. (t 0))))
  5750. (ddays
  5751. (cond
  5752. ;; Nullify delay when a repeater triggered already
  5753. ;; and the delay is of the form --Xd.
  5754. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5755. (> schedule (org-agenda--timestamp-to-absolute s)))
  5756. 0)
  5757. (suppress-delay
  5758. (let ((org-scheduled-delay-days suppress-delay))
  5759. (org-get-wdays s t t)))
  5760. (t (org-get-wdays s t)))))
  5761. ;; Display scheduled items at base date (SCHEDULE), today if
  5762. ;; scheduled before the current date, and at any repeat past
  5763. ;; today. However, skip delayed items and items that have
  5764. ;; been displayed for more than `org-scheduled-past-days'.
  5765. (unless (and todayp
  5766. habitp
  5767. (bound-and-true-p org-habit-show-all-today))
  5768. (when (or (and (> ddays 0) (< diff ddays))
  5769. (> diff (or (and habitp org-habit-scheduled-past-days)
  5770. org-scheduled-past-days))
  5771. (> schedule current)
  5772. (and (/= current schedule)
  5773. (/= current today)
  5774. (/= current repeat)))
  5775. (throw :skip nil)))
  5776. ;; Possibly skip done tasks.
  5777. (when (and donep
  5778. (or org-agenda-skip-scheduled-if-done
  5779. (/= schedule current)))
  5780. (throw :skip nil))
  5781. ;; Skip entry if it already appears as a deadline, per
  5782. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5783. ;; doesn't apply to habits.
  5784. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5785. ((guard
  5786. (or (not (memq (line-beginning-position 0) deadline-pos))
  5787. habitp))
  5788. nil)
  5789. (`repeated-after-deadline
  5790. (let ((deadline (time-to-days
  5791. (org-get-deadline-time (point)))))
  5792. (and (<= schedule deadline) (> current deadline))))
  5793. (`not-today pastschedp)
  5794. (`t t)
  5795. (_ nil))
  5796. (throw :skip nil))
  5797. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5798. ;; only show them for today. Also skip done habits.
  5799. (when (and habitp
  5800. (or donep
  5801. (not (bound-and-true-p org-habit-show-habits))
  5802. (and (not todayp)
  5803. (bound-and-true-p
  5804. org-habit-show-habits-only-for-today))))
  5805. (throw :skip nil))
  5806. (save-excursion
  5807. (re-search-backward "^\\*+[ \t]+" nil t)
  5808. (goto-char (match-end 0))
  5809. (let* ((category (org-get-category))
  5810. (inherited-tags
  5811. (or (eq org-agenda-show-inherited-tags 'always)
  5812. (and (listp org-agenda-show-inherited-tags)
  5813. (memq 'agenda org-agenda-show-inherited-tags))
  5814. (and (eq org-agenda-show-inherited-tags t)
  5815. (or (eq org-agenda-use-tag-inheritance t)
  5816. (memq 'agenda
  5817. org-agenda-use-tag-inheritance)))))
  5818. (tags (org-get-tags nil (not inherited-tags)))
  5819. (level (make-string (org-reduced-level (org-outline-level))
  5820. ?\s))
  5821. (head (buffer-substring (point) (line-end-position)))
  5822. (time
  5823. (cond
  5824. ;; No time of day designation if it is only a
  5825. ;; reminder, except for habits, which always show
  5826. ;; the time of day. Habits are an exception
  5827. ;; because if there is a time of day, that is
  5828. ;; interpreted to mean they should usually happen
  5829. ;; then, even if doing the habit was missed.
  5830. ((and
  5831. (not habitp)
  5832. (/= current schedule)
  5833. (/= current repeat))
  5834. nil)
  5835. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5836. (concat (substring s (match-beginning 1)) " "))
  5837. (t 'time)))
  5838. (item
  5839. (org-agenda-format-item
  5840. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5841. ;; Show a reminder of a past scheduled today.
  5842. (if (and todayp pastschedp)
  5843. (format past diff)
  5844. first))
  5845. head level category tags time nil habitp))
  5846. (face (cond ((and (not habitp) pastschedp)
  5847. 'org-scheduled-previously)
  5848. ((and habitp futureschedp)
  5849. 'org-agenda-done)
  5850. (todayp 'org-scheduled-today)
  5851. (t 'org-scheduled)))
  5852. (habitp (and habitp (org-habit-parse-todo))))
  5853. (org-add-props item props
  5854. 'undone-face face
  5855. 'face (if donep 'org-agenda-done face)
  5856. 'org-marker (org-agenda-new-marker pos)
  5857. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5858. 'type (if pastschedp "past-scheduled" "scheduled")
  5859. 'date (if pastschedp schedule date)
  5860. 'ts-date schedule
  5861. 'warntime warntime
  5862. 'level level
  5863. 'priority (if habitp (org-habit-get-priority habitp)
  5864. (+ 99 diff (org-get-priority item)))
  5865. 'org-habit-p habitp
  5866. 'todo-state todo-state)
  5867. (push item scheduled-items))))))
  5868. (nreverse scheduled-items)))
  5869. (defun org-agenda-get-blocks ()
  5870. "Return the date-range information for agenda display."
  5871. (let* ((props (list 'face nil
  5872. 'org-not-done-regexp org-not-done-regexp
  5873. 'org-todo-regexp org-todo-regexp
  5874. 'org-complex-heading-regexp org-complex-heading-regexp
  5875. 'mouse-face 'highlight
  5876. 'help-echo
  5877. (format "mouse-2 or RET jump to org file %s"
  5878. (abbreviate-file-name buffer-file-name))))
  5879. (regexp org-tr-regexp)
  5880. (d0 (calendar-absolute-from-gregorian date))
  5881. marker hdmarker ee txt d1 d2 s1 s2 category
  5882. level todo-state tags pos head donep inherited-tags)
  5883. (goto-char (point-min))
  5884. (while (re-search-forward regexp nil t)
  5885. (catch :skip
  5886. (org-agenda-skip)
  5887. (setq pos (point))
  5888. (let ((start-time (match-string 1))
  5889. (end-time (match-string 2)))
  5890. (setq s1 (match-string 1)
  5891. s2 (match-string 2)
  5892. d1 (time-to-days
  5893. (condition-case err
  5894. (org-time-string-to-time s1)
  5895. (error
  5896. (error
  5897. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5898. s1
  5899. pos
  5900. (current-buffer)
  5901. (error-message-string err)))))
  5902. d2 (time-to-days
  5903. (condition-case err
  5904. (org-time-string-to-time s2)
  5905. (error
  5906. (error
  5907. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5908. s2
  5909. pos
  5910. (current-buffer)
  5911. (error-message-string err))))))
  5912. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5913. ;; Only allow days between the limits, because the normal
  5914. ;; date stamps will catch the limits.
  5915. (save-excursion
  5916. (setq todo-state (org-get-todo-state))
  5917. (setq donep (member todo-state org-done-keywords))
  5918. (when (and donep org-agenda-skip-timestamp-if-done)
  5919. (throw :skip t))
  5920. (setq marker (org-agenda-new-marker (point))
  5921. category (org-get-category))
  5922. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5923. (throw :skip nil)
  5924. (goto-char (match-beginning 0))
  5925. (setq hdmarker (org-agenda-new-marker (point))
  5926. inherited-tags
  5927. (or (eq org-agenda-show-inherited-tags 'always)
  5928. (and (listp org-agenda-show-inherited-tags)
  5929. (memq 'agenda org-agenda-show-inherited-tags))
  5930. (and (eq org-agenda-show-inherited-tags t)
  5931. (or (eq org-agenda-use-tag-inheritance t)
  5932. (memq 'agenda org-agenda-use-tag-inheritance))))
  5933. tags (org-get-tags nil (not inherited-tags)))
  5934. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5935. (looking-at "\\*+[ \t]+\\(.*\\)")
  5936. (setq head (match-string 1))
  5937. (let ((remove-re
  5938. (if org-agenda-remove-timeranges-from-blocks
  5939. (concat
  5940. "<" (regexp-quote s1) ".*?>"
  5941. "--"
  5942. "<" (regexp-quote s2) ".*?>")
  5943. nil)))
  5944. (setq txt (org-agenda-format-item
  5945. (format
  5946. (nth (if (= d1 d2) 0 1)
  5947. org-agenda-timerange-leaders)
  5948. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5949. head level category tags
  5950. (cond ((and (= d1 d0) (= d2 d0))
  5951. (concat "<" start-time ">--<" end-time ">"))
  5952. ((= d1 d0)
  5953. (concat "<" start-time ">"))
  5954. ((= d2 d0)
  5955. (concat "<" end-time ">")))
  5956. remove-re))))
  5957. (org-add-props txt props
  5958. 'org-marker marker 'org-hd-marker hdmarker
  5959. 'type "block" 'date date
  5960. 'level level
  5961. 'todo-state todo-state
  5962. 'priority (org-get-priority txt))
  5963. (push txt ee))))
  5964. (goto-char pos)))
  5965. ;; Sort the entries by expiration date.
  5966. (nreverse ee)))
  5967. ;;; Agenda presentation and sorting
  5968. (defvar org-prefix-has-time nil
  5969. "A flag, set by `org-compile-prefix-format'.
  5970. The flag is set if the currently compiled format contains a `%t'.")
  5971. (defvar org-prefix-has-tag nil
  5972. "A flag, set by `org-compile-prefix-format'.
  5973. The flag is set if the currently compiled format contains a `%T'.")
  5974. (defvar org-prefix-has-effort nil
  5975. "A flag, set by `org-compile-prefix-format'.
  5976. The flag is set if the currently compiled format contains a `%e'.")
  5977. (defvar org-prefix-has-breadcrumbs nil
  5978. "A flag, set by `org-compile-prefix-format'.
  5979. The flag is set if the currently compiled format contains a `%b'.")
  5980. (defvar org-prefix-category-length nil
  5981. "Used by `org-compile-prefix-format' to remember the category field width.")
  5982. (defvar org-prefix-category-max-length nil
  5983. "Used by `org-compile-prefix-format' to remember the category field width.")
  5984. (defun org-agenda-get-category-icon (category)
  5985. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5986. (cl-dolist (entry org-agenda-category-icon-alist)
  5987. (when (string-match-p (car entry) category)
  5988. (if (listp (cadr entry))
  5989. (cl-return (cadr entry))
  5990. (cl-return (apply #'create-image (cdr entry)))))))
  5991. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5992. remove-re habitp)
  5993. "Format TXT to be inserted into the agenda buffer.
  5994. In particular, add the prefix and corresponding text properties.
  5995. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5996. LEVEL may be a string to replace the `%l' specifier.
  5997. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5998. category taken from local variable or file name. It will replace the `%c'
  5999. specifier in the format.
  6000. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6001. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6002. When DOTIME is a string, this string is searched for a time before TXT is.
  6003. TAGS can be the tags of the headline.
  6004. Any match of REMOVE-RE will be removed from TXT."
  6005. ;; We keep the org-prefix-* variable values along with a compiled
  6006. ;; formatter, so that multiple agendas existing at the same time do
  6007. ;; not step on each other toes.
  6008. ;;
  6009. ;; It was inconvenient to make these variables buffer local in
  6010. ;; Agenda buffers, because this function expects to be called with
  6011. ;; the buffer where item comes from being current, and not agenda
  6012. ;; buffer
  6013. (let* ((bindings (car org-prefix-format-compiled))
  6014. (formatter (cadr org-prefix-format-compiled)))
  6015. (cl-loop for (var value) in bindings
  6016. do (set var value))
  6017. (save-match-data
  6018. ;; Diary entries sometimes have extra whitespace at the beginning
  6019. (setq txt (org-trim txt))
  6020. ;; Fix the tags part in txt
  6021. (setq txt (org-agenda-fix-displayed-tags
  6022. txt tags
  6023. org-agenda-show-inherited-tags
  6024. org-agenda-hide-tags-regexp))
  6025. (let* ((category (or category
  6026. (if buffer-file-name
  6027. (file-name-sans-extension
  6028. (file-name-nondirectory buffer-file-name))
  6029. "")))
  6030. (category-icon (org-agenda-get-category-icon category))
  6031. (category-icon (if category-icon
  6032. (propertize " " 'display category-icon)
  6033. ""))
  6034. (effort (and (not (string= txt ""))
  6035. (get-text-property 1 'effort txt)))
  6036. ;; time, tag, effort are needed for the eval of the prefix format
  6037. (tag (if tags (nth (1- (length tags)) tags) ""))
  6038. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6039. time
  6040. (ts (when dotime (concat
  6041. (if (stringp dotime) dotime "")
  6042. (and org-agenda-search-headline-for-time txt))))
  6043. (time-of-day (and dotime (org-get-time-of-day ts)))
  6044. stamp plain s0 s1 s2 rtn srp l
  6045. duration breadcrumbs)
  6046. (and (derived-mode-p 'org-mode) buffer-file-name
  6047. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6048. (when (and dotime time-of-day)
  6049. ;; Extract starting and ending time and move them to prefix
  6050. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6051. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6052. (setq s0 (match-string 0 ts)
  6053. srp (and stamp (match-end 3))
  6054. s1 (match-string (if plain 1 2) ts)
  6055. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6056. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6057. ;; them, we might want to remove them there to avoid duplication.
  6058. ;; The user can turn this off with a variable.
  6059. (when (and org-prefix-has-time
  6060. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6061. (string-match (concat (regexp-quote s0) " *") txt)
  6062. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6063. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6064. (= (match-beginning 0) 0)
  6065. t))
  6066. (setq txt (replace-match "" nil nil txt))))
  6067. ;; Normalize the time(s) to 24 hour
  6068. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6069. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6070. ;; Try to set s2 if s1 and
  6071. ;; `org-agenda-default-appointment-duration' are set
  6072. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6073. (setq s2
  6074. (org-duration-from-minutes
  6075. (+ (org-duration-to-minutes s1 t)
  6076. org-agenda-default-appointment-duration)
  6077. nil t)))
  6078. ;; Compute the duration
  6079. (when s2
  6080. (setq duration (- (org-duration-to-minutes s2)
  6081. (org-duration-to-minutes s1)))))
  6082. (when (string-match org-tag-group-re txt)
  6083. ;; Tags are in the string
  6084. (if (or (eq org-agenda-remove-tags t)
  6085. (and org-agenda-remove-tags
  6086. org-prefix-has-tag))
  6087. (setq txt (replace-match "" t t txt))
  6088. (setq txt (replace-match
  6089. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6090. (match-string 1 txt))
  6091. t t txt))))
  6092. (when remove-re
  6093. (while (string-match remove-re txt)
  6094. (setq txt (replace-match "" t t txt))))
  6095. ;; Set org-heading property on `txt' to mark the start of the
  6096. ;; heading.
  6097. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6098. ;; Prepare the variables needed in the eval of the compiled format
  6099. (when org-prefix-has-breadcrumbs
  6100. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6101. (let ((s (org-format-outline-path (org-get-outline-path)
  6102. (1- (frame-width))
  6103. nil org-agenda-breadcrumbs-separator)))
  6104. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6105. (setq time (cond (s2 (concat
  6106. (org-agenda-time-of-day-to-ampm-maybe s1)
  6107. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6108. (when org-agenda-timegrid-use-ampm " ")))
  6109. (s1 (concat
  6110. (org-agenda-time-of-day-to-ampm-maybe s1)
  6111. (if org-agenda-timegrid-use-ampm
  6112. (concat time-grid-trailing-characters " ")
  6113. time-grid-trailing-characters)))
  6114. (t ""))
  6115. extra (or (and (not habitp) extra) "")
  6116. category (if (symbolp category) (symbol-name category) category)
  6117. level (or level ""))
  6118. (if (string-match org-link-bracket-re category)
  6119. (progn
  6120. (setq l (string-width (or (match-string 2) (match-string 1))))
  6121. (when (< l (or org-prefix-category-length 0))
  6122. (setq category (copy-sequence category))
  6123. (org-add-props category nil
  6124. 'extra-space (make-string
  6125. (- org-prefix-category-length l 1) ?\ ))))
  6126. (when (and org-prefix-category-max-length
  6127. (>= (length category) org-prefix-category-max-length))
  6128. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6129. ;; Evaluate the compiled format
  6130. (setq rtn (concat (eval formatter) txt))
  6131. ;; And finally add the text properties
  6132. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6133. (org-add-props rtn nil
  6134. 'org-category category
  6135. 'tags (mapcar 'org-downcase-keep-props tags)
  6136. 'org-highest-priority org-highest-priority
  6137. 'org-lowest-priority org-lowest-priority
  6138. 'time-of-day time-of-day
  6139. 'duration duration
  6140. 'breadcrumbs breadcrumbs
  6141. 'txt txt
  6142. 'level level
  6143. 'time time
  6144. 'extra extra
  6145. 'format org-prefix-format-compiled
  6146. 'dotime dotime)))))
  6147. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6148. "Remove tags string from TXT, and add a modified list of tags.
  6149. The modified list may contain inherited tags, and tags matched by
  6150. `org-agenda-hide-tags-regexp' will be removed."
  6151. (when (or add-inherited hide-re)
  6152. (when (string-match org-tag-group-re txt)
  6153. (setq txt (substring txt 0 (match-beginning 0))))
  6154. (setq tags
  6155. (delq nil
  6156. (mapcar (lambda (tg)
  6157. (if (or (and hide-re (string-match hide-re tg))
  6158. (and (not add-inherited)
  6159. (get-text-property 0 'inherited tg)))
  6160. nil
  6161. tg))
  6162. tags)))
  6163. (when tags
  6164. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6165. i)
  6166. (setq txt (concat txt " :"
  6167. (mapconcat
  6168. (lambda (x)
  6169. (setq i (get-text-property 0 'inherited x))
  6170. (if (and have-i (not i))
  6171. (progn
  6172. (setq have-i nil)
  6173. (concat ":" x))
  6174. x))
  6175. tags ":")
  6176. (if have-i "::" ":"))))))
  6177. txt)
  6178. (defun org-downcase-keep-props (s)
  6179. (let ((props (text-properties-at 0 s)))
  6180. (setq s (downcase s))
  6181. (add-text-properties 0 (length s) props s)
  6182. s))
  6183. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6184. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6185. "Add a time-grid for agenda items which need it.
  6186. LIST is the list of agenda items formatted by `org-agenda-list'.
  6187. NDAYS is the span of the current agenda view.
  6188. TODAYP is t when the current agenda view is on today."
  6189. (catch 'exit
  6190. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6191. ((and todayp (member 'today (car org-agenda-time-grid))))
  6192. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6193. ((member 'weekly (car org-agenda-time-grid)))
  6194. (t (throw 'exit list)))
  6195. (let* ((have (delq nil (mapcar
  6196. (lambda (x) (get-text-property 1 'time-of-day x))
  6197. list)))
  6198. (string (nth 3 org-agenda-time-grid))
  6199. (gridtimes (nth 1 org-agenda-time-grid))
  6200. (req (car org-agenda-time-grid))
  6201. (remove (member 'remove-match req))
  6202. new time)
  6203. (when (and (member 'require-timed req) (not have))
  6204. ;; don't show empty grid
  6205. (throw 'exit list))
  6206. (while (setq time (pop gridtimes))
  6207. (unless (and remove (member time have))
  6208. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6209. (push (org-agenda-format-item
  6210. nil string nil "" nil
  6211. (concat (substring time 0 -2) ":" (substring time -2)))
  6212. new)
  6213. (put-text-property
  6214. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6215. (when (and todayp org-agenda-show-current-time-in-grid)
  6216. (push (org-agenda-format-item
  6217. nil org-agenda-current-time-string nil "" nil
  6218. (format-time-string "%H:%M "))
  6219. new)
  6220. (put-text-property
  6221. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6222. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6223. (append new list)
  6224. (append list new)))))
  6225. (defun org-compile-prefix-format (key)
  6226. "Compile the prefix format into a Lisp form that can be evaluated.
  6227. The resulting form and associated variable bindings is returned
  6228. and stored in the variable `org-prefix-format-compiled'."
  6229. (setq org-prefix-has-time nil
  6230. org-prefix-has-tag nil
  6231. org-prefix-category-length nil
  6232. org-prefix-has-effort nil
  6233. org-prefix-has-breadcrumbs nil)
  6234. (let ((s (cond
  6235. ((stringp org-agenda-prefix-format)
  6236. org-agenda-prefix-format)
  6237. ((assq key org-agenda-prefix-format)
  6238. (cdr (assq key org-agenda-prefix-format)))
  6239. (t " %-12:c%?-12t% s")))
  6240. (start 0)
  6241. varform vars var e c f opt)
  6242. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6243. s start)
  6244. (setq var (or (cdr (assoc (match-string 4 s)
  6245. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6246. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6247. 'eval)
  6248. c (or (match-string 3 s) "")
  6249. opt (match-beginning 1)
  6250. start (1+ (match-beginning 0)))
  6251. (cl-case var
  6252. (time (setq org-prefix-has-time t))
  6253. (tag (setq org-prefix-has-tag t))
  6254. (effort (setq org-prefix-has-effort t))
  6255. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6256. (setq f (concat "%" (match-string 2 s) "s"))
  6257. (when (eq var 'category)
  6258. (setq org-prefix-category-length
  6259. (floor (abs (string-to-number (match-string 2 s)))))
  6260. (setq org-prefix-category-max-length
  6261. (let ((x (match-string 2 s)))
  6262. (when (string-match-p "\\.[0-9]+" x)
  6263. (string-to-number (substring (match-string 0 x) 1))))))
  6264. (if (eq var 'eval)
  6265. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6266. (if opt
  6267. (setq varform
  6268. `(if (or (equal "" ,var) (equal nil ,var))
  6269. ""
  6270. (format ,f (concat ,var ,c))))
  6271. (setq varform
  6272. `(format ,f (if (or (equal ,var "")
  6273. (equal ,var nil)) ""
  6274. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6275. (setq s (replace-match "%s" t nil s))
  6276. (push varform vars))
  6277. (setq vars (nreverse vars))
  6278. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6279. (setq org-prefix-format-compiled
  6280. (list
  6281. `((org-prefix-has-time ,org-prefix-has-time)
  6282. (org-prefix-has-tag ,org-prefix-has-tag)
  6283. (org-prefix-category-length ,org-prefix-category-length)
  6284. (org-prefix-has-effort ,org-prefix-has-effort)
  6285. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6286. `(format ,s ,@vars))))))
  6287. (defun org-set-sorting-strategy (key)
  6288. (if (symbolp (car org-agenda-sorting-strategy))
  6289. ;; the old format
  6290. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6291. (setq org-agenda-sorting-strategy-selected
  6292. (or (cdr (assq key org-agenda-sorting-strategy))
  6293. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6294. '(time-up category-keep priority-down)))))
  6295. (defun org-get-time-of-day (s &optional string mod24)
  6296. "Check string S for a time of day.
  6297. If found, return it as a military time number between 0 and 2400.
  6298. If not found, return nil.
  6299. The optional STRING argument forces conversion into a 5 character wide string
  6300. HH:MM."
  6301. (save-match-data
  6302. (when
  6303. (and
  6304. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6305. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6306. (not (eq (get-text-property 1 'face s) 'org-link)))
  6307. (let* ((h (string-to-number (match-string 1 s)))
  6308. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6309. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6310. (am-p (equal ampm "am"))
  6311. (h1 (cond ((not ampm) h)
  6312. ((= h 12) (if am-p 0 12))
  6313. (t (+ h (if am-p 0 12)))))
  6314. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6315. (mod h1 24) h1))
  6316. (t0 (+ (* 100 h2) m))
  6317. (t1 (concat (if (>= h1 24) "+" " ")
  6318. (if (and org-agenda-time-leading-zero
  6319. (< t0 1000)) "0" "")
  6320. (if (< t0 100) "0" "")
  6321. (if (< t0 10) "0" "")
  6322. (int-to-string t0))))
  6323. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6324. (defvar org-agenda-before-sorting-filter-function nil
  6325. "Function to be applied to agenda items prior to sorting.
  6326. Prior to sorting also means just before they are inserted into the agenda.
  6327. To aid sorting, you may revisit the original entries and add more text
  6328. properties which will later be used by the sorting functions.
  6329. The function should take a string argument, an agenda line.
  6330. It has access to the text properties in that line, which contain among
  6331. other things, the property `org-hd-marker' that points to the entry
  6332. where the line comes from. Note that not all lines going into the agenda
  6333. have this property, only most.
  6334. The function should return the modified string. It is probably best
  6335. to ONLY change text properties.
  6336. You can also use this function as a filter, by returning nil for lines
  6337. you don't want to have in the agenda at all. For this application, you
  6338. could bind the variable in the options section of a custom command.")
  6339. (defun org-agenda-finalize-entries (list &optional type)
  6340. "Sort, limit and concatenate the LIST of agenda items.
  6341. The optional argument TYPE tells the agenda type."
  6342. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6343. (cdr (assoc type org-agenda-max-effort)))
  6344. (t org-agenda-max-effort)))
  6345. (max-todo (cond ((listp org-agenda-max-todos)
  6346. (cdr (assoc type org-agenda-max-todos)))
  6347. (t org-agenda-max-todos)))
  6348. (max-tags (cond ((listp org-agenda-max-tags)
  6349. (cdr (assoc type org-agenda-max-tags)))
  6350. (t org-agenda-max-tags)))
  6351. (max-entries (cond ((listp org-agenda-max-entries)
  6352. (cdr (assoc type org-agenda-max-entries)))
  6353. (t org-agenda-max-entries))))
  6354. (when org-agenda-before-sorting-filter-function
  6355. (setq list
  6356. (delq nil
  6357. (mapcar
  6358. org-agenda-before-sorting-filter-function list))))
  6359. (setq list (mapcar 'org-agenda-highlight-todo list)
  6360. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6361. (when max-effort
  6362. (setq list (org-agenda-limit-entries
  6363. list 'effort-minutes max-effort
  6364. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6365. 32767 -1))))))
  6366. (when max-todo
  6367. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6368. (when max-tags
  6369. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6370. (when max-entries
  6371. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6372. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6373. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6374. (mapconcat 'identity list "\n")))
  6375. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6376. "Limit the number of agenda entries."
  6377. (let ((include (and limit (< limit 0))))
  6378. (if limit
  6379. (let ((fun (or fn (lambda (p) (when p 1))))
  6380. (lim 0))
  6381. (delq nil
  6382. (mapcar
  6383. (lambda (e)
  6384. (let ((pval (funcall
  6385. fun (get-text-property (1- (length e))
  6386. prop e))))
  6387. (when pval (setq lim (+ lim pval)))
  6388. (cond ((and pval (<= lim (abs limit))) e)
  6389. ((and include (not pval)) e))))
  6390. list)))
  6391. list)))
  6392. (defun org-agenda-limit-interactively (remove)
  6393. "In agenda, interactively limit entries to various maximums."
  6394. (interactive "P")
  6395. (if remove
  6396. (progn (setq org-agenda-max-entries nil
  6397. org-agenda-max-todos nil
  6398. org-agenda-max-tags nil
  6399. org-agenda-max-effort nil)
  6400. (org-agenda-redo))
  6401. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6402. (msg (cond ((= max ?E) "How many minutes? ")
  6403. ((= max ?e) "How many entries? ")
  6404. ((= max ?t) "How many TODO entries? ")
  6405. ((= max ?T) "How many tagged entries? ")
  6406. (t (user-error "Wrong input"))))
  6407. (num (string-to-number (read-from-minibuffer msg))))
  6408. (cond ((equal max ?e)
  6409. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6410. ((equal max ?t)
  6411. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6412. ((equal max ?T)
  6413. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6414. ((equal max ?E)
  6415. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6416. (org-agenda-fit-window-to-buffer))
  6417. (defun org-agenda-highlight-todo (x)
  6418. (let ((org-done-keywords org-done-keywords-for-agenda)
  6419. (case-fold-search nil)
  6420. re)
  6421. (if (eq x 'line)
  6422. (save-excursion
  6423. (beginning-of-line 1)
  6424. (setq re (org-get-at-bol 'org-todo-regexp))
  6425. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6426. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6427. (add-text-properties (match-beginning 0) (match-end 1)
  6428. (list 'face (org-get-todo-face 1)))
  6429. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6430. (delete-region (match-beginning 1) (1- (match-end 0)))
  6431. (goto-char (match-beginning 1))
  6432. (insert (format org-agenda-todo-keyword-format s)))))
  6433. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6434. (setq re (get-text-property 0 'org-todo-regexp x))
  6435. (when (and re
  6436. ;; Test `pl' because if there's no heading content,
  6437. ;; there's no point matching to highlight. Note
  6438. ;; that if we didn't test `pl' first, and there
  6439. ;; happened to be no keyword from `org-todo-regexp'
  6440. ;; on this heading line, then the `equal' comparison
  6441. ;; afterwards would spuriously succeed in the case
  6442. ;; where `pl' is nil -- causing an args-out-of-range
  6443. ;; error when we try to add text properties to text
  6444. ;; that isn't there.
  6445. pl
  6446. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6447. x pl) pl))
  6448. (add-text-properties
  6449. (or (match-end 1) (match-end 0)) (match-end 0)
  6450. (list 'face (org-get-todo-face (match-string 2 x)))
  6451. x)
  6452. (when (match-end 1)
  6453. (setq x
  6454. (concat
  6455. (substring x 0 (match-end 1))
  6456. (format org-agenda-todo-keyword-format
  6457. (match-string 2 x))
  6458. ;; Remove `display' property as the icon could leak
  6459. ;; on the white space.
  6460. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6461. 'display))
  6462. (substring x (match-end 3)))))))
  6463. x)))
  6464. (defsubst org-cmp-values (a b property)
  6465. "Compare the numeric value of text PROPERTY for string A and B."
  6466. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6467. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6468. (cond ((> pa pb) +1)
  6469. ((< pa pb) -1))))
  6470. (defsubst org-cmp-effort (a b)
  6471. "Compare the effort values of string A and B."
  6472. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6473. ;; `effort-minutes' property is not directly accessible from
  6474. ;; the strings, but is stored as a property in `txt'.
  6475. (ea (or (get-text-property
  6476. 0 'effort-minutes (get-text-property 0 'txt a))
  6477. def))
  6478. (eb (or (get-text-property
  6479. 0 'effort-minutes (get-text-property 0 'txt b))
  6480. def)))
  6481. (cond ((> ea eb) +1)
  6482. ((< ea eb) -1))))
  6483. (defsubst org-cmp-category (a b)
  6484. "Compare the string values of categories of strings A and B."
  6485. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6486. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6487. (cond ((string-lessp ca cb) -1)
  6488. ((string-lessp cb ca) +1))))
  6489. (defsubst org-cmp-todo-state (a b)
  6490. "Compare the todo states of strings A and B."
  6491. (let* ((ma (or (get-text-property 1 'org-marker a)
  6492. (get-text-property 1 'org-hd-marker a)))
  6493. (mb (or (get-text-property 1 'org-marker b)
  6494. (get-text-property 1 'org-hd-marker b)))
  6495. (fa (and ma (marker-buffer ma)))
  6496. (fb (and mb (marker-buffer mb)))
  6497. (todo-kwds
  6498. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6499. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6500. (ta (or (get-text-property 1 'todo-state a) ""))
  6501. (tb (or (get-text-property 1 'todo-state b) ""))
  6502. (la (- (length (member ta todo-kwds))))
  6503. (lb (- (length (member tb todo-kwds))))
  6504. (donepa (member ta org-done-keywords-for-agenda))
  6505. (donepb (member tb org-done-keywords-for-agenda)))
  6506. (cond ((and donepa (not donepb)) -1)
  6507. ((and (not donepa) donepb) +1)
  6508. ((< la lb) -1)
  6509. ((< lb la) +1))))
  6510. (defsubst org-cmp-alpha (a b)
  6511. "Compare the headlines, alphabetically."
  6512. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6513. (plb (text-property-any 0 (length b) 'org-heading t b))
  6514. (ta (and pla (substring a pla)))
  6515. (tb (and plb (substring b plb)))
  6516. (case-fold-search nil))
  6517. (when pla
  6518. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6519. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6520. (setq ta (substring ta (match-end 0))))
  6521. (setq ta (downcase ta)))
  6522. (when plb
  6523. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6524. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6525. (setq tb (substring tb (match-end 0))))
  6526. (setq tb (downcase tb)))
  6527. (cond ((not (or ta tb)) nil)
  6528. ((not ta) +1)
  6529. ((not tb) -1)
  6530. ((string-lessp ta tb) -1)
  6531. ((string-lessp tb ta) +1))))
  6532. (defsubst org-cmp-tag (a b)
  6533. "Compare the string values of the first tags of A and B."
  6534. (let ((ta (car (last (get-text-property 1 'tags a))))
  6535. (tb (car (last (get-text-property 1 'tags b)))))
  6536. (cond ((not (or ta tb)) nil)
  6537. ((not ta) +1)
  6538. ((not tb) -1)
  6539. ((string-lessp ta tb) -1)
  6540. ((string-lessp tb ta) +1))))
  6541. (defsubst org-cmp-time (a b)
  6542. "Compare the time-of-day values of strings A and B."
  6543. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6544. (ta (or (get-text-property 1 'time-of-day a) def))
  6545. (tb (or (get-text-property 1 'time-of-day b) def)))
  6546. (cond ((< ta tb) -1)
  6547. ((< tb ta) +1))))
  6548. (defsubst org-cmp-ts (a b type)
  6549. "Compare the timestamps values of entries A and B.
  6550. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6551. \"timestamp_ia\", compare within each of these type. When TYPE
  6552. is the empty string, compare all timestamps without respect of
  6553. their type."
  6554. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6555. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6556. (get-text-property 1 'ts-date a))
  6557. def))
  6558. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6559. (get-text-property 1 'ts-date b))
  6560. def)))
  6561. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6562. ((if tb (and ta (< tb ta)) ta) +1))))
  6563. (defsubst org-cmp-habit-p (a b)
  6564. "Compare the todo states of strings A and B."
  6565. (let ((ha (get-text-property 1 'org-habit-p a))
  6566. (hb (get-text-property 1 'org-habit-p b)))
  6567. (cond ((and ha (not hb)) -1)
  6568. ((and (not ha) hb) +1))))
  6569. (defun org-entries-lessp (a b)
  6570. "Predicate for sorting agenda entries."
  6571. ;; The following variables will be used when the form is evaluated.
  6572. ;; So even though the compiler complains, keep them.
  6573. (let* ((ss org-agenda-sorting-strategy-selected)
  6574. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6575. (org-cmp-ts a b "")))
  6576. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6577. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6578. (org-cmp-ts a b "scheduled")))
  6579. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6580. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6581. (org-cmp-ts a b "deadline")))
  6582. (deadline-down (if deadline-up (- deadline-up) nil))
  6583. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6584. (org-cmp-ts a b "timestamp_ia")))
  6585. (tsia-down (if tsia-up (- tsia-up) nil))
  6586. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6587. (org-cmp-ts a b "timestamp")))
  6588. (ts-down (if ts-up (- ts-up) nil))
  6589. (time-up (and (org-em 'time-up 'time-down ss)
  6590. (org-cmp-time a b)))
  6591. (time-down (if time-up (- time-up) nil))
  6592. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6593. (org-cmp-values a b 'org-stats)))
  6594. (stats-down (if stats-up (- stats-up) nil))
  6595. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6596. (org-cmp-values a b 'priority)))
  6597. (priority-down (if priority-up (- priority-up) nil))
  6598. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6599. (org-cmp-effort a b)))
  6600. (effort-down (if effort-up (- effort-up) nil))
  6601. (category-up (and (or (org-em 'category-up 'category-down ss)
  6602. (memq 'category-keep ss))
  6603. (org-cmp-category a b)))
  6604. (category-down (if category-up (- category-up) nil))
  6605. (category-keep (if category-up +1 nil))
  6606. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6607. (org-cmp-tag a b)))
  6608. (tag-down (if tag-up (- tag-up) nil))
  6609. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6610. (org-cmp-todo-state a b)))
  6611. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6612. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6613. (org-cmp-habit-p a b)))
  6614. (habit-down (if habit-up (- habit-up) nil))
  6615. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6616. (org-cmp-alpha a b)))
  6617. (alpha-down (if alpha-up (- alpha-up) nil))
  6618. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6619. user-defined-up user-defined-down)
  6620. (when (and need-user-cmp org-agenda-cmp-user-defined
  6621. (functionp org-agenda-cmp-user-defined))
  6622. (setq user-defined-up
  6623. (funcall org-agenda-cmp-user-defined a b)
  6624. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6625. (cdr (assoc
  6626. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6627. '((-1 . t) (1 . nil) (nil . nil))))))
  6628. ;;; Agenda restriction lock
  6629. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6630. "Overlay to mark the headline to which agenda commands are restricted.")
  6631. (overlay-put org-agenda-restriction-lock-overlay
  6632. 'face 'org-agenda-restriction-lock)
  6633. (overlay-put org-agenda-restriction-lock-overlay
  6634. 'help-echo "Agendas are currently limited to this subtree.")
  6635. (delete-overlay org-agenda-restriction-lock-overlay)
  6636. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6637. "Set the restriction lock to the agenda item at point from within the agenda.
  6638. When called with a `\\[universal-argument]' prefix, restrict to
  6639. the file which contains the item.
  6640. Argument ARG is the prefix argument."
  6641. (interactive "P")
  6642. (unless (derived-mode-p 'org-agenda-mode)
  6643. (user-error "Not in an Org agenda buffer"))
  6644. (let* ((marker (or (org-get-at-bol 'org-marker)
  6645. (org-agenda-error)))
  6646. (buffer (marker-buffer marker))
  6647. (pos (marker-position marker)))
  6648. (with-current-buffer buffer
  6649. (goto-char pos)
  6650. (org-agenda-set-restriction-lock arg))))
  6651. ;;;###autoload
  6652. (defun org-agenda-set-restriction-lock (&optional type)
  6653. "Set restriction lock for agenda to current subtree or file.
  6654. When in a restricted subtree, remove it.
  6655. The restriction will span over the entire file if TYPE is `file',
  6656. or if type is '(4), or if the cursor is before the first headline
  6657. in the file. Otherwise, only apply the restriction to the current
  6658. subtree."
  6659. (interactive "P")
  6660. (if (and org-agenda-overriding-restriction
  6661. (member org-agenda-restriction-lock-overlay
  6662. (overlays-at (point)))
  6663. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6664. (point)))
  6665. (org-agenda-remove-restriction-lock 'noupdate)
  6666. (org-agenda-remove-restriction-lock 'noupdate)
  6667. (and (equal type '(4)) (setq type 'file))
  6668. (setq type (cond
  6669. (type type)
  6670. ((org-at-heading-p) 'subtree)
  6671. ((condition-case nil (org-back-to-heading t) (error nil))
  6672. 'subtree)
  6673. (t 'file)))
  6674. (if (eq type 'subtree)
  6675. (progn
  6676. (setq org-agenda-restrict (current-buffer))
  6677. (setq org-agenda-overriding-restriction 'subtree)
  6678. (put 'org-agenda-files 'org-restrict
  6679. (list (buffer-file-name (buffer-base-buffer))))
  6680. (org-back-to-heading t)
  6681. (move-overlay org-agenda-restriction-lock-overlay
  6682. (point)
  6683. (if org-agenda-restriction-lock-highlight-subtree
  6684. (save-excursion (org-end-of-subtree t t) (point))
  6685. (point-at-eol)))
  6686. (move-marker org-agenda-restrict-begin (point))
  6687. (move-marker org-agenda-restrict-end
  6688. (save-excursion (org-end-of-subtree t t)))
  6689. (message "Locking agenda restriction to subtree"))
  6690. (put 'org-agenda-files 'org-restrict
  6691. (list (buffer-file-name (buffer-base-buffer))))
  6692. (setq org-agenda-restrict nil)
  6693. (setq org-agenda-overriding-restriction 'file)
  6694. (move-marker org-agenda-restrict-begin nil)
  6695. (move-marker org-agenda-restrict-end nil)
  6696. (message "Locking agenda restriction to file"))
  6697. (setq current-prefix-arg nil))
  6698. (org-agenda-maybe-redo))
  6699. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6700. "Remove agenda restriction lock."
  6701. (interactive "P")
  6702. (if (not org-agenda-restrict)
  6703. (message "No agenda restriction to remove.")
  6704. (delete-overlay org-agenda-restriction-lock-overlay)
  6705. (delete-overlay org-speedbar-restriction-lock-overlay)
  6706. (setq org-agenda-overriding-restriction nil)
  6707. (setq org-agenda-restrict nil)
  6708. (put 'org-agenda-files 'org-restrict nil)
  6709. (move-marker org-agenda-restrict-begin nil)
  6710. (move-marker org-agenda-restrict-end nil)
  6711. (setq current-prefix-arg nil)
  6712. (message "Agenda restriction lock removed")
  6713. (or noupdate (org-agenda-maybe-redo))))
  6714. (defun org-agenda-maybe-redo ()
  6715. "If there is any window showing the agenda view, update it."
  6716. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6717. org-agenda-buffer-name)
  6718. t))
  6719. (w0 (selected-window)))
  6720. (when w
  6721. (select-window w)
  6722. (org-agenda-redo)
  6723. (select-window w0)
  6724. (if org-agenda-overriding-restriction
  6725. (message "Agenda view shifted to new %s restriction"
  6726. org-agenda-overriding-restriction)
  6727. (message "Agenda restriction lock removed")))))
  6728. ;;; Agenda commands
  6729. (defun org-agenda-check-type (error &rest types)
  6730. "Check if agenda buffer is of allowed type.
  6731. If ERROR is non-nil, throw an error, otherwise just return nil.
  6732. Allowed types are `agenda' `todo' `tags' `search'."
  6733. (cond ((not org-agenda-type)
  6734. (error "No Org agenda currently displayed"))
  6735. ((memq org-agenda-type types) t)
  6736. (error
  6737. (error "Not allowed in %s-type agenda buffers" org-agenda-type))
  6738. (t nil)))
  6739. (defun org-agenda-Quit ()
  6740. "Exit the agenda, killing the agenda buffer.
  6741. Like `org-agenda-quit', but kill the buffer even when
  6742. `org-agenda-sticky' is non-nil."
  6743. (interactive)
  6744. (org-agenda--quit))
  6745. (defun org-agenda-quit ()
  6746. "Exit the agenda.
  6747. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6748. instead of killing it.
  6749. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6750. the pre-agenda window configuration.
  6751. When column view is active, exit column view instead of the
  6752. agenda."
  6753. (interactive)
  6754. (org-agenda--quit org-agenda-sticky))
  6755. (defun org-agenda--quit (&optional bury)
  6756. (if org-agenda-columns-active
  6757. (org-columns-quit)
  6758. (let ((wconf org-agenda-pre-window-conf)
  6759. (buf (current-buffer))
  6760. (org-agenda-last-indirect-window
  6761. (and (eq org-indirect-buffer-display 'other-window)
  6762. org-agenda-last-indirect-buffer
  6763. (get-buffer-window org-agenda-last-indirect-buffer))))
  6764. (cond
  6765. ((eq org-agenda-window-setup 'other-frame)
  6766. (delete-frame))
  6767. ((and org-agenda-restore-windows-after-quit
  6768. wconf)
  6769. ;; Maybe restore the pre-agenda window configuration. Reset
  6770. ;; `org-agenda-pre-window-conf' before running
  6771. ;; `set-window-configuration', which loses the current buffer.
  6772. (setq org-agenda-pre-window-conf nil)
  6773. (set-window-configuration wconf))
  6774. (t
  6775. (when org-agenda-last-indirect-window
  6776. (delete-window org-agenda-last-indirect-window))
  6777. (and (not (eq org-agenda-window-setup 'current-window))
  6778. (not (one-window-p))
  6779. (delete-window))))
  6780. (if bury
  6781. ;; Set the agenda buffer as the current buffer instead of
  6782. ;; passing it as an argument to `bury-buffer' so that
  6783. ;; `bury-buffer' removes it from the window.
  6784. (with-current-buffer buf
  6785. (bury-buffer))
  6786. (kill-buffer buf)
  6787. (setq org-agenda-archives-mode nil
  6788. org-agenda-buffer nil)))))
  6789. (defun org-agenda-exit ()
  6790. "Exit the agenda, killing Org buffers loaded by the agenda.
  6791. Like `org-agenda-Quit', but kill any buffers that were created by
  6792. the agenda. Org buffers visited directly by the user will not be
  6793. touched. Also, exit the agenda even if it is in column view."
  6794. (interactive)
  6795. (when org-agenda-columns-active
  6796. (org-columns-quit))
  6797. (org-release-buffers org-agenda-new-buffers)
  6798. (setq org-agenda-new-buffers nil)
  6799. (org-agenda-Quit))
  6800. (defun org-agenda-kill-all-agenda-buffers ()
  6801. "Kill all buffers in `org-agenda-mode'.
  6802. This is used when toggling sticky agendas."
  6803. (interactive)
  6804. (let (blist)
  6805. (dolist (buf (buffer-list))
  6806. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6807. (push buf blist)))
  6808. (mapc 'kill-buffer blist)))
  6809. (defun org-agenda-execute (arg)
  6810. "Execute another agenda command, keeping same window.
  6811. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6812. in the agenda."
  6813. (interactive "P")
  6814. (let ((org-agenda-window-setup 'current-window))
  6815. (org-agenda arg)))
  6816. (defun org-agenda-redo (&optional all)
  6817. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6818. (interactive "P")
  6819. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6820. (cpa (unless (eq all t) current-prefix-arg))
  6821. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6822. (org-agenda-sticky nil)
  6823. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6824. org-agenda-buffer-name))
  6825. (org-agenda-keep-modes t)
  6826. (tag-filter org-agenda-tag-filter)
  6827. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6828. (top-hl-filter org-agenda-top-headline-filter)
  6829. (cat-filter org-agenda-category-filter)
  6830. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6831. (re-filter org-agenda-regexp-filter)
  6832. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6833. (effort-filter org-agenda-effort-filter)
  6834. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6835. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6836. (cols org-agenda-columns-active)
  6837. (line (org-current-line))
  6838. (window-line (- line (org-current-line (window-start))))
  6839. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6840. (redo-cmd (get-text-property p 'org-redo-cmd))
  6841. (last-args (get-text-property p 'org-last-args))
  6842. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6843. (org-agenda-overriding-cmd-arguments
  6844. (unless (eq all t)
  6845. (cond ((listp last-args)
  6846. (cons (or cpa (car last-args)) (cdr last-args)))
  6847. ((stringp last-args)
  6848. last-args))))
  6849. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6850. (put 'org-agenda-tag-filter :preset-filter nil)
  6851. (put 'org-agenda-category-filter :preset-filter nil)
  6852. (put 'org-agenda-regexp-filter :preset-filter nil)
  6853. (put 'org-agenda-effort-filter :preset-filter nil)
  6854. (and cols (org-columns-quit))
  6855. (message "Rebuilding agenda buffer...")
  6856. (if series-redo-cmd
  6857. (eval series-redo-cmd)
  6858. (org-let lprops redo-cmd))
  6859. (setq org-agenda-undo-list nil
  6860. org-agenda-pending-undo-list nil
  6861. org-agenda-tag-filter tag-filter
  6862. org-agenda-category-filter cat-filter
  6863. org-agenda-regexp-filter re-filter
  6864. org-agenda-effort-filter effort-filter
  6865. org-agenda-top-headline-filter top-hl-filter)
  6866. (message "Rebuilding agenda buffer...done")
  6867. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6868. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6869. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6870. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6871. (let ((tag (or tag-filter tag-preset))
  6872. (cat (or cat-filter cat-preset))
  6873. (effort (or effort-filter effort-preset))
  6874. (re (or re-filter re-preset)))
  6875. (when tag (org-agenda-filter-apply tag 'tag t))
  6876. (when cat (org-agenda-filter-apply cat 'category))
  6877. (when effort (org-agenda-filter-apply effort 'effort))
  6878. (when re (org-agenda-filter-apply re 'regexp)))
  6879. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6880. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6881. (org-goto-line line)
  6882. (recenter window-line)))
  6883. (defun org-agenda-redo-all (&optional exhaustive)
  6884. "Rebuild all agenda views in the current buffer.
  6885. With a prefix argument, do so in all agenda buffers."
  6886. (interactive "P")
  6887. (if exhaustive
  6888. (dolist (buffer (buffer-list))
  6889. (with-current-buffer buffer
  6890. (when (derived-mode-p 'org-agenda-mode)
  6891. (org-agenda-redo t))))
  6892. (org-agenda-redo t)))
  6893. (defvar org-global-tags-completion-table nil)
  6894. (defvar org-agenda-filter-form nil)
  6895. (defvar org-agenda-filtered-by-category nil)
  6896. (defsubst org-agenda-get-category ()
  6897. "Return the category of the agenda line."
  6898. (org-get-at-bol 'org-category))
  6899. (defun org-agenda-filter-by-category (strip)
  6900. "Filter lines in the agenda buffer that have a specific category.
  6901. The category is that of the current line.
  6902. Without prefix argument, keep only the lines of that category.
  6903. With a prefix argument, exclude the lines of that category.
  6904. "
  6905. (interactive "P")
  6906. (if (and org-agenda-filtered-by-category
  6907. org-agenda-category-filter)
  6908. (org-agenda-filter-show-all-cat)
  6909. (let ((cat (org-no-properties (org-agenda-get-category))))
  6910. (cond
  6911. ((and cat strip)
  6912. (org-agenda-filter-apply
  6913. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6914. (cat
  6915. (org-agenda-filter-apply
  6916. (setq org-agenda-category-filter
  6917. (list (concat "+" cat))) 'category))
  6918. (t (error "No category at point"))))))
  6919. (defun org-find-top-headline (&optional pos)
  6920. "Find the topmost parent headline and return it.
  6921. POS when non-nil is the marker or buffer position to start the
  6922. search from."
  6923. (save-excursion
  6924. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6925. (when pos (goto-char pos))
  6926. ;; Skip up to the topmost parent.
  6927. (while (org-up-heading-safe))
  6928. (ignore-errors (nth 4 (org-heading-components))))))
  6929. (defvar org-agenda-filtered-by-top-headline nil)
  6930. (defun org-agenda-filter-by-top-headline (strip)
  6931. "Keep only those lines that are descendants from the same top headline.
  6932. The top headline is that of the current line."
  6933. (interactive "P")
  6934. (if org-agenda-filtered-by-top-headline
  6935. (progn
  6936. (setq org-agenda-filtered-by-top-headline nil
  6937. org-agenda-top-headline-filter nil)
  6938. (org-agenda-filter-show-all-top-filter))
  6939. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6940. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6941. (error "No top-level headline at point")))))
  6942. (defvar org-agenda-regexp-filter nil)
  6943. (defun org-agenda-filter-by-regexp (strip)
  6944. "Filter agenda entries by regular expressions.
  6945. With one prefix argument, filter out entries matching the regexp.
  6946. If there is already a regexp filter, remove it unless called with
  6947. two prefix arguments."
  6948. (interactive "P")
  6949. (cond
  6950. ((and org-agenda-regexp-filter (not (equal strip '(16))))
  6951. (org-agenda-filter-show-all-re)
  6952. (message "Regexp filter removed"))
  6953. (t (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6954. (read-from-minibuffer
  6955. (if (equal strip '(4))
  6956. "Filter out entries matching regexp: "
  6957. "Narrow to entries matching regexp: ")))))
  6958. (push flt org-agenda-regexp-filter)
  6959. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp)))))
  6960. (defvar org-agenda-effort-filter nil)
  6961. (defun org-agenda-filter-by-effort (strip)
  6962. "Filter agenda entries by effort.
  6963. With no prefix argument, keep entries matching the effort condition.
  6964. With one prefix argument, filter out entries matching the condition.
  6965. With two prefix arguments, remove the effort filters."
  6966. (interactive "P")
  6967. (cond
  6968. ((member strip '(nil 4))
  6969. (let* ((efforts (split-string
  6970. (or (cdr (assoc (concat org-effort-property "_ALL")
  6971. org-global-properties))
  6972. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  6973. ;; XXX: the following handles only up to 10 different
  6974. ;; effort values.
  6975. (allowed-keys (if (null efforts) nil
  6976. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  6977. (number-sequence 1 (length efforts)))))
  6978. (op nil))
  6979. (while (not (memq op '(?< ?> ?=)))
  6980. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6981. ;; Select appropriate duration. Ignore non-digit characters.
  6982. (let ((prompt
  6983. (apply #'format
  6984. (concat "Effort %c "
  6985. (mapconcat (lambda (s) (concat "[%d]" s))
  6986. efforts
  6987. " "))
  6988. op allowed-keys))
  6989. (eff -1))
  6990. (while (not (memq eff allowed-keys))
  6991. (message prompt)
  6992. (setq eff (- (read-char-exclusive) 48)))
  6993. (setq org-agenda-effort-filter
  6994. (list (concat (if strip "-" "+")
  6995. (char-to-string op)
  6996. ;; Numbering is 1 2 3 ... 9 0, but we want
  6997. ;; 0 1 2 ... 8 9.
  6998. (nth (mod (1- eff) 10) efforts)))))
  6999. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  7000. (t (org-agenda-filter-show-all-effort)
  7001. (message "Effort filter removed"))))
  7002. (defun org-agenda-filter-remove-all ()
  7003. "Remove all filters from the current agenda buffer."
  7004. (interactive)
  7005. (when org-agenda-tag-filter
  7006. (org-agenda-filter-show-all-tag))
  7007. (when org-agenda-category-filter
  7008. (org-agenda-filter-show-all-cat))
  7009. (when org-agenda-regexp-filter
  7010. (org-agenda-filter-show-all-re))
  7011. (when org-agenda-top-headline-filter
  7012. (org-agenda-filter-show-all-top-filter))
  7013. (when org-agenda-effort-filter
  7014. (org-agenda-filter-show-all-effort))
  7015. (org-agenda-finalize))
  7016. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  7017. "Keep only those lines in the agenda buffer that have a specific tag.
  7018. The tag is selected with its fast selection letter, as configured.
  7019. With a `\\[universal-argument]' prefix, exclude the agenda search.
  7020. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7021. i.e. don't
  7022. filter on all its group members.
  7023. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7024. should be used to exclude the search - the interactive user can
  7025. also press `-' or `+' to switch between filtering and excluding."
  7026. (interactive "P")
  7027. (let* ((alist org-tag-alist-for-agenda)
  7028. (tag-chars (mapconcat
  7029. (lambda (x) (if (and (not (symbolp (car x)))
  7030. (cdr x))
  7031. (char-to-string (cdr x))
  7032. ""))
  7033. org-tag-alist-for-agenda ""))
  7034. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  7035. (string-to-list tag-chars)))
  7036. (exclude (or exclude (equal arg '(4))))
  7037. (expand (not (equal arg '(16))))
  7038. (inhibit-read-only t)
  7039. (current org-agenda-tag-filter)
  7040. a n tag)
  7041. (unless char
  7042. (while (not (memq char valid-char-list))
  7043. (org-unlogged-message
  7044. "%s by tag [%s ]:tag-char, [TAB]:tag, %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  7045. (if exclude "Exclude" "Filter")
  7046. tag-chars
  7047. (if org-agenda-auto-exclude-function "[RET], " "")
  7048. (if expand "" ", no grouptag expand"))
  7049. (setq char (read-char-exclusive))
  7050. ;; Excluding or filtering down
  7051. (cond ((eq char ?-) (setq exclude t))
  7052. ((eq char ?+) (setq exclude nil)))))
  7053. (when (eq char ?\t)
  7054. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  7055. (setq-local org-global-tags-completion-table
  7056. (org-global-tags-completion-table)))
  7057. (let ((completion-ignore-case t))
  7058. (setq tag (completing-read
  7059. "Tag: " org-global-tags-completion-table nil t))))
  7060. (cond
  7061. ((eq char ?\r)
  7062. (org-agenda-filter-show-all-tag)
  7063. (when org-agenda-auto-exclude-function
  7064. (setq org-agenda-tag-filter nil)
  7065. (dolist (tag (org-agenda-get-represented-tags))
  7066. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7067. (when modifier
  7068. (push modifier org-agenda-tag-filter))))
  7069. (unless (null org-agenda-tag-filter)
  7070. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7071. ((eq char ?/)
  7072. (org-agenda-filter-show-all-tag)
  7073. (when (get 'org-agenda-tag-filter :preset-filter)
  7074. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7075. ((eq char ?.)
  7076. (setq org-agenda-tag-filter
  7077. (mapcar (lambda(tag) (concat "+" tag))
  7078. (org-get-at-bol 'tags)))
  7079. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7080. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7081. ((or (eq char ?\s)
  7082. (setq a (rassoc char alist))
  7083. (and tag (setq a (cons tag nil))))
  7084. (org-agenda-filter-show-all-tag)
  7085. (setq tag (car a))
  7086. (setq org-agenda-tag-filter
  7087. (cons (concat (if exclude "-" "+") tag)
  7088. current))
  7089. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7090. (t (error "Invalid tag selection character %c" char)))))
  7091. (defun org-agenda-get-represented-tags ()
  7092. "Get a list of all tags currently represented in the agenda."
  7093. (let (p tags)
  7094. (save-excursion
  7095. (goto-char (point-min))
  7096. (while (setq p (next-single-property-change (point) 'tags))
  7097. (goto-char p)
  7098. (mapc (lambda (x) (add-to-list 'tags x))
  7099. (get-text-property (point) 'tags))))
  7100. tags))
  7101. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7102. "Create the form that tests a line for agenda filter. Optional
  7103. argument EXPAND can be used for the TYPE tag and will expand the
  7104. tags in the FILTER if any of the tags in FILTER are grouptags."
  7105. (let (f f1)
  7106. (cond
  7107. ;; Tag filter
  7108. ((eq type 'tag)
  7109. (setq filter
  7110. (delete-dups
  7111. (append (get 'org-agenda-tag-filter :preset-filter)
  7112. filter)))
  7113. (dolist (x filter)
  7114. (let ((op (string-to-char x)))
  7115. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7116. (setq x (list x)))
  7117. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7118. (push f1 f))))
  7119. ;; Category filter
  7120. ((eq type 'category)
  7121. (setq filter
  7122. (delete-dups
  7123. (append (get 'org-agenda-category-filter :preset-filter)
  7124. filter)))
  7125. (dolist (x filter)
  7126. (if (equal "-" (substring x 0 1))
  7127. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7128. (setq f1 (list 'equal (substring x 1) 'cat)))
  7129. (push f1 f)))
  7130. ;; Regexp filter
  7131. ((eq type 'regexp)
  7132. (setq filter
  7133. (delete-dups
  7134. (append (get 'org-agenda-regexp-filter :preset-filter)
  7135. filter)))
  7136. (dolist (x filter)
  7137. (if (equal "-" (substring x 0 1))
  7138. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7139. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7140. (push f1 f)))
  7141. ;; Effort filter
  7142. ((eq type 'effort)
  7143. (setq filter
  7144. (delete-dups
  7145. (append (get 'org-agenda-effort-filter :preset-filter)
  7146. filter)))
  7147. (dolist (x filter)
  7148. (push (org-agenda-filter-effort-form x) f))))
  7149. (cons 'and (nreverse f))))
  7150. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7151. "Return a form associated to tag-expression TAGS.
  7152. Build a form testing a line for agenda filter for
  7153. tag-expressions. OP is an operator of type CHAR that allows the
  7154. function to set the right switches in the returned form."
  7155. (let (form)
  7156. ;; Any of the expressions can match if OP is +, all must match if
  7157. ;; the operator is -.
  7158. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7159. (let* ((tag (substring x 1))
  7160. (f (cond
  7161. ((string= "" tag) '(not tags))
  7162. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7163. ;; TAG is a regexp.
  7164. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7165. (t (list 'member (downcase tag) 'tags)))))
  7166. (push (if (eq op ?-) (list 'not f) f) form)))))
  7167. (defun org-agenda-filter-effort-form (e)
  7168. "Return the form to compare the effort of the current line with what E says.
  7169. E looks like \"+<2:25\"."
  7170. (let (op)
  7171. (setq e (substring e 1))
  7172. (setq op (string-to-char e) e (substring e 1))
  7173. (setq op (cond ((equal op ?<) '<=)
  7174. ((equal op ?>) '>=)
  7175. ((equal op ??) op)
  7176. (t '=)))
  7177. (list 'org-agenda-compare-effort (list 'quote op)
  7178. (org-duration-to-minutes e))))
  7179. (defun org-agenda-compare-effort (op value)
  7180. "Compare the effort of the current line with VALUE, using OP.
  7181. If the line does not have an effort defined, return nil."
  7182. ;; `effort-minutes' property cannot be extracted directly from
  7183. ;; current line but is stored as a property in `txt'.
  7184. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7185. (funcall op
  7186. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7187. value)))
  7188. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7189. "Expand group tags in FILTER for the agenda.
  7190. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7191. (if org-group-tags
  7192. (let ((case-fold-search t) rtn)
  7193. (mapc
  7194. (lambda (f)
  7195. (let (f0 dir)
  7196. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7197. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7198. (setq dir (if no-operator "" "+") f0 f))
  7199. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7200. (org-tags-expand f0 t t))
  7201. rtn))))
  7202. filter)
  7203. (reverse rtn))
  7204. filter))
  7205. (defun org-agenda-filter-apply (filter type &optional expand)
  7206. "Set FILTER as the new agenda filter and apply it. Optional
  7207. argument EXPAND can be used for the TYPE tag and will expand the
  7208. tags in the FILTER if any of the tags in FILTER are grouptags."
  7209. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7210. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7211. (let (tags cat txt)
  7212. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7213. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7214. ;; category is used as the filter:
  7215. (setq org-agenda-filtered-by-category
  7216. (and (eq type 'category)
  7217. (not (equal (substring (car filter) 0 1) "-"))))
  7218. (org-agenda-set-mode-name)
  7219. (save-excursion
  7220. (goto-char (point-min))
  7221. (while (not (eobp))
  7222. (if (org-get-at-bol 'org-marker)
  7223. (progn
  7224. (setq tags (org-get-at-bol 'tags)
  7225. cat (org-agenda-get-category)
  7226. txt (org-get-at-bol 'txt))
  7227. (unless (eval org-agenda-filter-form)
  7228. (org-agenda-filter-hide-line type))
  7229. (beginning-of-line 2))
  7230. (beginning-of-line 2))))
  7231. (when (get-char-property (point) 'invisible)
  7232. (ignore-errors (org-agenda-previous-line)))))
  7233. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7234. "Filter by top headline HL."
  7235. (org-agenda-set-mode-name)
  7236. (save-excursion
  7237. (goto-char (point-min))
  7238. (while (not (eobp))
  7239. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7240. (tophl (and pos (org-find-top-headline pos))))
  7241. (when (and tophl (funcall (if negative 'identity 'not)
  7242. (string= hl tophl)))
  7243. (org-agenda-filter-hide-line 'top-headline)))
  7244. (beginning-of-line 2)))
  7245. (when (get-char-property (point) 'invisible)
  7246. (org-agenda-previous-line))
  7247. (setq org-agenda-top-headline-filter hl
  7248. org-agenda-filtered-by-top-headline t))
  7249. (defun org-agenda-filter-hide-line (type)
  7250. "Hide lines with TYPE in the agenda buffer."
  7251. (let* ((b (max (point-min) (1- (point-at-bol))))
  7252. (e (point-at-eol)))
  7253. (let ((inhibit-read-only t))
  7254. (add-text-properties
  7255. b e `(invisible org-filtered org-filter-type ,type)))))
  7256. (defun org-agenda-remove-filter (type)
  7257. (interactive)
  7258. "Remove filter of type TYPE from the agenda buffer."
  7259. (save-excursion
  7260. (goto-char (point-min))
  7261. (let ((inhibit-read-only t) pos)
  7262. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7263. (goto-char pos)
  7264. (remove-text-properties
  7265. (point) (next-single-property-change (point) 'org-filter-type)
  7266. `(invisible org-filtered org-filter-type ,type))))
  7267. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7268. (setq org-agenda-filter-form nil)
  7269. (org-agenda-set-mode-name)
  7270. (org-agenda-finalize)))
  7271. (defun org-agenda-filter-show-all-tag nil
  7272. (org-agenda-remove-filter 'tag))
  7273. (defun org-agenda-filter-show-all-re nil
  7274. (org-agenda-remove-filter 'regexp))
  7275. (defun org-agenda-filter-show-all-effort nil
  7276. (org-agenda-remove-filter 'effort))
  7277. (defun org-agenda-filter-show-all-cat nil
  7278. (org-agenda-remove-filter 'category))
  7279. (defun org-agenda-filter-show-all-top-filter nil
  7280. (org-agenda-remove-filter 'top-headline))
  7281. (defun org-agenda-manipulate-query-add ()
  7282. "Manipulate the query by adding a search term with positive selection.
  7283. Positive selection means the term must be matched for selection of an entry."
  7284. (interactive)
  7285. (org-agenda-manipulate-query ?\[))
  7286. (defun org-agenda-manipulate-query-subtract ()
  7287. "Manipulate the query by adding a search term with negative selection.
  7288. Negative selection means term must not be matched for selection of an entry."
  7289. (interactive)
  7290. (org-agenda-manipulate-query ?\]))
  7291. (defun org-agenda-manipulate-query-add-re ()
  7292. "Manipulate the query by adding a search regexp with positive selection.
  7293. Positive selection means the regexp must match for selection of an entry."
  7294. (interactive)
  7295. (org-agenda-manipulate-query ?\{))
  7296. (defun org-agenda-manipulate-query-subtract-re ()
  7297. "Manipulate the query by adding a search regexp with negative selection.
  7298. Negative selection means regexp must not match for selection of an entry."
  7299. (interactive)
  7300. (org-agenda-manipulate-query ?\}))
  7301. (defun org-agenda-manipulate-query (char)
  7302. (cond
  7303. ((eq org-agenda-type 'agenda)
  7304. (let ((org-agenda-include-inactive-timestamps t))
  7305. (org-agenda-redo))
  7306. (message "Display now includes inactive timestamps as well"))
  7307. ((eq org-agenda-type 'search)
  7308. (org-add-to-string
  7309. 'org-agenda-query-string
  7310. (if org-agenda-last-search-view-search-was-boolean
  7311. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7312. (?\{ . " +{}") (?\} . " -{}"))))
  7313. " "))
  7314. (setq org-agenda-redo-command
  7315. (list 'org-search-view
  7316. (car (get-text-property (min (1- (point-max)) (point))
  7317. 'org-last-args))
  7318. org-agenda-query-string
  7319. (+ (length org-agenda-query-string)
  7320. (if (member char '(?\{ ?\})) 0 1))))
  7321. (set-register org-agenda-query-register org-agenda-query-string)
  7322. (let ((org-agenda-overriding-arguments
  7323. (cdr org-agenda-redo-command)))
  7324. (org-agenda-redo)))
  7325. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7326. org-agenda-type))))
  7327. (defun org-add-to-string (var string)
  7328. (set var (concat (symbol-value var) string)))
  7329. (defun org-agenda-goto-date (span)
  7330. "Jump to DATE in agenda."
  7331. (interactive "P")
  7332. (let* ((org-read-date-prefer-future
  7333. (eval org-agenda-jump-prefer-future))
  7334. (date (org-read-date))
  7335. (day (time-to-days (org-time-string-to-time date)))
  7336. (org-agenda-sticky-orig org-agenda-sticky)
  7337. (org-agenda-buffer-tmp-name (buffer-name))
  7338. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7339. (0-arg (or current-prefix-arg (car args)))
  7340. (2-arg (nth 2 args))
  7341. (with-hour-p (nth 4 org-agenda-redo-command))
  7342. (newcmd (list 'org-agenda-list 0-arg date
  7343. (org-agenda-span-to-ndays
  7344. 2-arg (org-time-string-to-absolute date))
  7345. with-hour-p))
  7346. (newargs (cdr newcmd))
  7347. (inhibit-read-only t)
  7348. org-agenda-sticky)
  7349. (if (not (org-agenda-check-type t 'agenda))
  7350. (error "Not available in non-agenda views")
  7351. (add-text-properties (point-min) (point-max)
  7352. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7353. (org-agenda-redo)
  7354. (goto-char (point-min))
  7355. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7356. (save-excursion (move-beginning-of-line 2) (eobp))))
  7357. (move-beginning-of-line 2))
  7358. (setq org-agenda-sticky org-agenda-sticky-orig
  7359. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7360. (defun org-agenda-goto-today ()
  7361. "Go to today."
  7362. (interactive)
  7363. (org-agenda-check-type t 'agenda)
  7364. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7365. (curspan (nth 2 args))
  7366. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7367. (cond
  7368. (tdpos (goto-char tdpos))
  7369. ((eq org-agenda-type 'agenda)
  7370. (let* ((sd (org-agenda-compute-starting-span
  7371. (org-today) (or curspan org-agenda-span)))
  7372. (org-agenda-overriding-arguments args))
  7373. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7374. (org-agenda-redo)
  7375. (org-agenda-find-same-or-today-or-agenda)))
  7376. (t (error "Cannot find today")))))
  7377. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7378. (goto-char
  7379. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7380. (text-property-any (point-min) (point-max) 'org-today t)
  7381. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7382. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7383. (org-agenda-backward-block))
  7384. (point-min))))
  7385. (defun org-agenda-backward-block ()
  7386. "Move backward by one agenda block."
  7387. (interactive)
  7388. (org-agenda-forward-block 'backward))
  7389. (defun org-agenda-forward-block (&optional backward)
  7390. "Move forward by one agenda block.
  7391. When optional argument BACKWARD is set, go backward"
  7392. (interactive)
  7393. (cond ((not (derived-mode-p 'org-agenda-mode))
  7394. (user-error
  7395. "Cannot execute this command outside of org-agenda-mode buffers"))
  7396. ((looking-at (if backward "\\`" "\\'"))
  7397. (message "Already at the %s block" (if backward "first" "last")))
  7398. (t (let ((pos (prog1 (point)
  7399. (ignore-errors (if backward (backward-char 1)
  7400. (move-end-of-line 1)))))
  7401. (f (if backward
  7402. 'previous-single-property-change
  7403. 'next-single-property-change))
  7404. moved dest)
  7405. (while (and (setq dest (funcall
  7406. f (point) 'org-agenda-structural-header))
  7407. (not (get-text-property
  7408. (point) 'org-agenda-structural-header)))
  7409. (setq moved t)
  7410. (goto-char dest))
  7411. (if moved (move-beginning-of-line 1)
  7412. (goto-char (if backward (point-min) (point-max)))
  7413. (move-beginning-of-line 1)
  7414. (message "No %s block" (if backward "previous" "further")))))))
  7415. (defun org-agenda-later (arg)
  7416. "Go forward in time by the current span.
  7417. With prefix ARG, go forward that many times the current span."
  7418. (interactive "p")
  7419. (org-agenda-check-type t 'agenda)
  7420. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7421. (span (or (nth 2 args) org-agenda-current-span))
  7422. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7423. (greg (calendar-gregorian-from-absolute sd))
  7424. (cnt (org-get-at-bol 'org-day-cnt))
  7425. greg2)
  7426. (cond
  7427. ((numberp span)
  7428. (setq sd (+ (* span arg) sd)))
  7429. ((eq span 'day)
  7430. (setq sd (+ arg sd)))
  7431. ((eq span 'week)
  7432. (setq sd (+ (* 7 arg) sd)))
  7433. ((eq span 'fortnight)
  7434. (setq sd (+ (* 14 arg) sd)))
  7435. ((eq span 'month)
  7436. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7437. sd (calendar-absolute-from-gregorian greg2))
  7438. (setcar greg2 (1+ (car greg2))))
  7439. ((eq span 'year)
  7440. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7441. sd (calendar-absolute-from-gregorian greg2))
  7442. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7443. (t
  7444. (setq sd (+ (* span arg) sd))))
  7445. (let ((org-agenda-overriding-cmd
  7446. ;; `cmd' may have been set by `org-agenda-run-series' which
  7447. ;; uses `org-agenda-overriding-cmd' to decide whether
  7448. ;; overriding is allowed for `cmd'
  7449. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7450. (org-agenda-overriding-arguments
  7451. (list (car args) sd span)))
  7452. (org-agenda-redo)
  7453. (org-agenda-find-same-or-today-or-agenda cnt))))
  7454. (defun org-agenda-earlier (arg)
  7455. "Go backward in time by the current span.
  7456. With prefix ARG, go backward that many times the current span."
  7457. (interactive "p")
  7458. (org-agenda-later (- arg)))
  7459. (defun org-agenda-view-mode-dispatch ()
  7460. "Call one of the view mode commands."
  7461. (interactive)
  7462. (org-unlogged-message
  7463. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7464. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7465. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7466. (pcase (read-char-exclusive)
  7467. (?\ (call-interactively 'org-agenda-reset-view))
  7468. (?d (call-interactively 'org-agenda-day-view))
  7469. (?w (call-interactively 'org-agenda-week-view))
  7470. (?t (call-interactively 'org-agenda-fortnight-view))
  7471. (?m (call-interactively 'org-agenda-month-view))
  7472. (?y (call-interactively 'org-agenda-year-view))
  7473. (?l (call-interactively 'org-agenda-log-mode))
  7474. (?L (org-agenda-log-mode '(4)))
  7475. (?c (org-agenda-log-mode 'clockcheck))
  7476. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7477. (?a (call-interactively 'org-agenda-archives-mode))
  7478. (?A (org-agenda-archives-mode 'files))
  7479. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7480. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7481. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7482. (?D (call-interactively 'org-agenda-toggle-diary))
  7483. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7484. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7485. (org-agenda-check-type t 'agenda)
  7486. (org-agenda-redo))
  7487. (message "Display now includes inactive timestamps as well"))
  7488. (?q (message "Abort"))
  7489. (key (user-error "Invalid key: %s" key))))
  7490. (defun org-agenda-reset-view ()
  7491. "Switch to default view for agenda."
  7492. (interactive)
  7493. (org-agenda-change-time-span org-agenda-span))
  7494. (defun org-agenda-day-view (&optional day-of-month)
  7495. "Switch to daily view for agenda.
  7496. With argument DAY-OF-MONTH, switch to that day of the month."
  7497. (interactive "P")
  7498. (org-agenda-change-time-span 'day day-of-month))
  7499. (defun org-agenda-week-view (&optional iso-week)
  7500. "Switch to weekly view for agenda.
  7501. With argument ISO-WEEK, switch to the corresponding ISO week.
  7502. If ISO-WEEK has more then 2 digits, only the last two encode
  7503. the week. Any digits before this encode a year. So 200712
  7504. means week 12 of year 2007. Years ranging from 70 years ago
  7505. to 30 years in the future can also be written as 2-digit years."
  7506. (interactive "P")
  7507. (org-agenda-change-time-span 'week iso-week))
  7508. (defun org-agenda-fortnight-view (&optional iso-week)
  7509. "Switch to fortnightly view for agenda.
  7510. With argument ISO-WEEK, switch to the corresponding ISO week.
  7511. If ISO-WEEK has more then 2 digits, only the last two encode
  7512. the week. Any digits before this encode a year. So 200712
  7513. means week 12 of year 2007. Years ranging from 70 years ago
  7514. to 30 years in the future can also be written as 2-digit years."
  7515. (interactive "P")
  7516. (org-agenda-change-time-span 'fortnight iso-week))
  7517. (defun org-agenda-month-view (&optional month)
  7518. "Switch to monthly view for agenda.
  7519. With argument MONTH, switch to that month. If MONTH has more
  7520. then 2 digits, only the last two encode the month. Any digits
  7521. before this encode a year. So 200712 means December year 2007.
  7522. Years ranging from 70 years ago to 30 years in the future can
  7523. also be written as 2-digit years."
  7524. (interactive "P")
  7525. (org-agenda-change-time-span 'month month))
  7526. (defun org-agenda-year-view (&optional year)
  7527. "Switch to yearly view for agenda.
  7528. With argument YEAR, switch to that year. Years ranging from 70
  7529. years ago to 30 years in the future can also be written as
  7530. 2-digit years."
  7531. (interactive "P")
  7532. (when year
  7533. (setq year (org-small-year-to-year year)))
  7534. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7535. (org-agenda-change-time-span 'year year)
  7536. (error "Abort")))
  7537. (defun org-agenda-change-time-span (span &optional n)
  7538. "Change the agenda view to SPAN.
  7539. SPAN may be `day', `week', `fortnight', `month', `year'."
  7540. (org-agenda-check-type t 'agenda)
  7541. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7542. (curspan (nth 2 args)))
  7543. (when (and (not n) (equal curspan span))
  7544. (error "Viewing span is already \"%s\"" span))
  7545. (let* ((sd (or (org-get-at-bol 'day)
  7546. (nth 1 args)
  7547. org-starting-day))
  7548. (sd (org-agenda-compute-starting-span sd span n))
  7549. (org-agenda-overriding-cmd
  7550. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7551. (org-agenda-overriding-arguments
  7552. (list (car args) sd span)))
  7553. (org-agenda-redo)
  7554. (org-agenda-find-same-or-today-or-agenda))
  7555. (org-agenda-set-mode-name)
  7556. (message "Switched to %s view" span)))
  7557. (defun org-agenda-compute-starting-span (sd span &optional n)
  7558. "Compute starting date for agenda.
  7559. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7560. is a cons cell with the starting date and the number of days,
  7561. so that the date SD will be in that range."
  7562. (let* ((greg (calendar-gregorian-from-absolute sd))
  7563. (dg (nth 1 greg))
  7564. (mg (car greg))
  7565. (yg (nth 2 greg)))
  7566. (cond
  7567. ((eq span 'day)
  7568. (when n
  7569. (setq sd (+ (calendar-absolute-from-gregorian
  7570. (list mg 1 yg))
  7571. n -1))))
  7572. ((or (eq span 'week) (eq span 'fortnight))
  7573. (let* ((nt (calendar-day-of-week
  7574. (calendar-gregorian-from-absolute sd)))
  7575. (d (if org-agenda-start-on-weekday
  7576. (- nt org-agenda-start-on-weekday)
  7577. 0))
  7578. y1)
  7579. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7580. (when n
  7581. (require 'cal-iso)
  7582. (when (> n 99)
  7583. (setq y1 (org-small-year-to-year (/ n 100))
  7584. n (mod n 100)))
  7585. (setq sd
  7586. (calendar-iso-to-absolute
  7587. (list n 1
  7588. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7589. ((eq span 'month)
  7590. (let (y1)
  7591. (when (and n (> n 99))
  7592. (setq y1 (org-small-year-to-year (/ n 100))
  7593. n (mod n 100)))
  7594. (setq sd (calendar-absolute-from-gregorian
  7595. (list (or n mg) 1 (or y1 yg))))))
  7596. ((eq span 'year)
  7597. (setq sd (calendar-absolute-from-gregorian
  7598. (list 1 1 (or n yg))))))
  7599. sd))
  7600. (defun org-agenda-next-date-line (&optional arg)
  7601. "Jump to the next line indicating a date in agenda buffer."
  7602. (interactive "p")
  7603. (org-agenda-check-type t 'agenda)
  7604. (beginning-of-line 1)
  7605. ;; This does not work if user makes date format that starts with a blank
  7606. (when (looking-at-p "^\\S-") (forward-char 1))
  7607. (unless (re-search-forward "^\\S-" nil t arg)
  7608. (backward-char 1)
  7609. (error "No next date after this line in this buffer"))
  7610. (goto-char (match-beginning 0)))
  7611. (defun org-agenda-previous-date-line (&optional arg)
  7612. "Jump to the previous line indicating a date in agenda buffer."
  7613. (interactive "p")
  7614. (org-agenda-check-type t 'agenda)
  7615. (beginning-of-line 1)
  7616. (unless (re-search-backward "^\\S-" nil t arg)
  7617. (error "No previous date before this line in this buffer")))
  7618. ;; Initialize the highlight
  7619. (defvar org-hl (make-overlay 1 1))
  7620. (overlay-put org-hl 'face 'highlight)
  7621. (defun org-highlight (begin end &optional buffer)
  7622. "Highlight a region with overlay."
  7623. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7624. (defun org-unhighlight ()
  7625. "Detach overlay INDEX."
  7626. (delete-overlay org-hl))
  7627. (defun org-unhighlight-once ()
  7628. "Remove the highlight from its position, and this function from the hook."
  7629. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7630. (org-unhighlight))
  7631. (defvar org-agenda-pre-follow-window-conf nil)
  7632. (defun org-agenda-follow-mode ()
  7633. "Toggle follow mode in an agenda buffer."
  7634. (interactive)
  7635. (unless org-agenda-follow-mode
  7636. (setq org-agenda-pre-follow-window-conf
  7637. (current-window-configuration)))
  7638. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7639. (unless org-agenda-follow-mode
  7640. (set-window-configuration org-agenda-pre-follow-window-conf))
  7641. (org-agenda-set-mode-name)
  7642. (org-agenda-do-context-action)
  7643. (message "Follow mode is %s"
  7644. (if org-agenda-follow-mode "on" "off")))
  7645. (defun org-agenda-entry-text-mode (&optional arg)
  7646. "Toggle entry text mode in an agenda buffer."
  7647. (interactive "P")
  7648. (if (or org-agenda-tag-filter
  7649. org-agenda-category-filter
  7650. org-agenda-regexp-filter
  7651. org-agenda-top-headline-filter)
  7652. (user-error "Can't show entry text in filtered views")
  7653. (setq org-agenda-entry-text-mode (or (integerp arg)
  7654. (not org-agenda-entry-text-mode)))
  7655. (org-agenda-entry-text-hide)
  7656. (and org-agenda-entry-text-mode
  7657. (let ((org-agenda-entry-text-maxlines
  7658. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7659. (org-agenda-entry-text-show)))
  7660. (org-agenda-set-mode-name)
  7661. (message "Entry text mode is %s%s"
  7662. (if org-agenda-entry-text-mode "on" "off")
  7663. (if (not org-agenda-entry-text-mode) ""
  7664. (format " (maximum number of lines is %d)"
  7665. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7666. (defun org-agenda-clockreport-mode ()
  7667. "Toggle clocktable mode in an agenda buffer."
  7668. (interactive)
  7669. (org-agenda-check-type t 'agenda)
  7670. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7671. (org-agenda-set-mode-name)
  7672. (org-agenda-redo)
  7673. (message "Clocktable mode is %s"
  7674. (if org-agenda-clockreport-mode "on" "off")))
  7675. (defun org-agenda-log-mode (&optional special)
  7676. "Toggle log mode in an agenda buffer.
  7677. With argument SPECIAL, show all possible log items, not only the ones
  7678. configured in `org-agenda-log-mode-items'.
  7679. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7680. log items, nothing else."
  7681. (interactive "P")
  7682. (org-agenda-check-type t 'agenda)
  7683. (setq org-agenda-show-log
  7684. (cond
  7685. ((equal special '(16)) 'only)
  7686. ((eq special 'clockcheck)
  7687. (if (eq org-agenda-show-log 'clockcheck)
  7688. nil 'clockcheck))
  7689. (special '(closed clock state))
  7690. (t (not org-agenda-show-log))))
  7691. (org-agenda-set-mode-name)
  7692. (org-agenda-redo)
  7693. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7694. (defun org-agenda-archives-mode (&optional with-files)
  7695. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7696. When called with a prefix argument, include all archive files as well."
  7697. (interactive "P")
  7698. (setq org-agenda-archives-mode
  7699. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7700. (org-agenda-set-mode-name)
  7701. (org-agenda-redo)
  7702. (message
  7703. "%s"
  7704. (cond
  7705. ((eq org-agenda-archives-mode nil)
  7706. "No archives are included")
  7707. ((eq org-agenda-archives-mode 'trees)
  7708. (format "Trees with :%s: tag are included" org-archive-tag))
  7709. ((eq org-agenda-archives-mode t)
  7710. (format "Trees with :%s: tag and all active archive files are included"
  7711. org-archive-tag)))))
  7712. (defun org-agenda-toggle-diary ()
  7713. "Toggle diary inclusion in an agenda buffer."
  7714. (interactive)
  7715. (org-agenda-check-type t 'agenda)
  7716. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7717. (org-agenda-redo)
  7718. (org-agenda-set-mode-name)
  7719. (message "Diary inclusion turned %s"
  7720. (if org-agenda-include-diary "on" "off")))
  7721. (defun org-agenda-toggle-deadlines ()
  7722. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7723. (interactive)
  7724. (org-agenda-check-type t 'agenda)
  7725. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7726. (org-agenda-redo)
  7727. (org-agenda-set-mode-name)
  7728. (message "Deadlines inclusion turned %s"
  7729. (if org-agenda-include-deadlines "on" "off")))
  7730. (defun org-agenda-toggle-time-grid ()
  7731. "Toggle time grid in an agenda buffer."
  7732. (interactive)
  7733. (org-agenda-check-type t 'agenda)
  7734. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7735. (org-agenda-redo)
  7736. (org-agenda-set-mode-name)
  7737. (message "Time-grid turned %s"
  7738. (if org-agenda-use-time-grid "on" "off")))
  7739. (defun org-agenda-set-mode-name ()
  7740. "Set the mode name to indicate all the small mode settings."
  7741. (setq mode-name
  7742. (list "Org-Agenda"
  7743. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7744. " "
  7745. '(:eval (org-agenda-span-name org-agenda-current-span))
  7746. (if org-agenda-follow-mode " Follow" "")
  7747. (if org-agenda-entry-text-mode " ETxt" "")
  7748. (if org-agenda-include-diary " Diary" "")
  7749. (if org-agenda-include-deadlines " Ddl" "")
  7750. (if org-agenda-use-time-grid " Grid" "")
  7751. (if (and (boundp 'org-habit-show-habits)
  7752. org-habit-show-habits) " Habit" "")
  7753. (cond
  7754. ((consp org-agenda-show-log) " LogAll")
  7755. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7756. (org-agenda-show-log " Log")
  7757. (t ""))
  7758. (if (or org-agenda-category-filter
  7759. (get 'org-agenda-category-filter :preset-filter))
  7760. '(:eval (propertize
  7761. (concat " <"
  7762. (mapconcat
  7763. 'identity
  7764. (append
  7765. (get 'org-agenda-category-filter :preset-filter)
  7766. org-agenda-category-filter)
  7767. "")
  7768. ">")
  7769. 'face 'org-agenda-filter-category
  7770. 'help-echo "Category used in filtering")) "")
  7771. (if (or org-agenda-tag-filter
  7772. (get 'org-agenda-tag-filter :preset-filter))
  7773. '(:eval (propertize
  7774. (concat " {"
  7775. (mapconcat
  7776. 'identity
  7777. (append
  7778. (get 'org-agenda-tag-filter :preset-filter)
  7779. org-agenda-tag-filter)
  7780. "")
  7781. "}")
  7782. 'face 'org-agenda-filter-tags
  7783. 'help-echo "Tags used in filtering")) "")
  7784. (if (or org-agenda-effort-filter
  7785. (get 'org-agenda-effort-filter :preset-filter))
  7786. '(:eval (propertize
  7787. (concat " {"
  7788. (mapconcat
  7789. 'identity
  7790. (append
  7791. (get 'org-agenda-effort-filter :preset-filter)
  7792. org-agenda-effort-filter)
  7793. "")
  7794. "}")
  7795. 'face 'org-agenda-filter-effort
  7796. 'help-echo "Effort conditions used in filtering")) "")
  7797. (if (or org-agenda-regexp-filter
  7798. (get 'org-agenda-regexp-filter :preset-filter))
  7799. '(:eval (propertize
  7800. (concat " ["
  7801. (mapconcat
  7802. 'identity
  7803. (append
  7804. (get 'org-agenda-regexp-filter :preset-filter)
  7805. org-agenda-regexp-filter)
  7806. "")
  7807. "]")
  7808. 'face 'org-agenda-filter-regexp
  7809. 'help-echo "Regexp used in filtering")) "")
  7810. (if org-agenda-archives-mode
  7811. (if (eq org-agenda-archives-mode t)
  7812. " Archives"
  7813. (format " :%s:" org-archive-tag))
  7814. "")
  7815. (if org-agenda-clockreport-mode " Clock" "")))
  7816. (force-mode-line-update))
  7817. (defun org-agenda-update-agenda-type ()
  7818. "Update the agenda type after each command."
  7819. (setq org-agenda-type
  7820. (or (get-text-property (point) 'org-agenda-type)
  7821. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7822. (defun org-agenda-next-line ()
  7823. "Move cursor to the next line, and show if follow mode is active."
  7824. (interactive)
  7825. (call-interactively 'next-line)
  7826. (org-agenda-do-context-action))
  7827. (defun org-agenda-previous-line ()
  7828. "Move cursor to the previous line, and show if follow-mode is active."
  7829. (interactive)
  7830. (call-interactively 'previous-line)
  7831. (org-agenda-do-context-action))
  7832. (defun org-agenda-next-item (n)
  7833. "Move cursor to next agenda item."
  7834. (interactive "p")
  7835. (let ((col (current-column)))
  7836. (dotimes (c n)
  7837. (when (next-single-property-change (point-at-eol) 'org-marker)
  7838. (move-end-of-line 1)
  7839. (goto-char (next-single-property-change (point) 'org-marker))))
  7840. (org-move-to-column col))
  7841. (org-agenda-do-context-action))
  7842. (defun org-agenda-previous-item (n)
  7843. "Move cursor to next agenda item."
  7844. (interactive "p")
  7845. (dotimes (c n)
  7846. (let ((col (current-column))
  7847. (goto (save-excursion
  7848. (move-end-of-line 0)
  7849. (previous-single-property-change (point) 'org-marker))))
  7850. (when goto (goto-char goto))
  7851. (org-move-to-column col)))
  7852. (org-agenda-do-context-action))
  7853. (defun org-agenda-do-context-action ()
  7854. "Show outline path and, maybe, follow mode window."
  7855. (let ((m (org-get-at-bol 'org-marker)))
  7856. (when (and (markerp m) (marker-buffer m))
  7857. (and org-agenda-follow-mode
  7858. (if org-agenda-follow-indirect
  7859. (org-agenda-tree-to-indirect-buffer nil)
  7860. (org-agenda-show)))
  7861. (and org-agenda-show-outline-path
  7862. (org-with-point-at m (org-display-outline-path t))))))
  7863. (defun org-agenda-show-tags ()
  7864. "Show the tags applicable to the current item."
  7865. (interactive)
  7866. (let* ((tags (org-get-at-bol 'tags)))
  7867. (if tags
  7868. (message "Tags are :%s:"
  7869. (org-no-properties (mapconcat 'identity tags ":")))
  7870. (message "No tags associated with this line"))))
  7871. (defun org-agenda-goto (&optional highlight)
  7872. "Go to the entry at point in the corresponding Org file."
  7873. (interactive)
  7874. (let* ((marker (or (org-get-at-bol 'org-marker)
  7875. (org-agenda-error)))
  7876. (buffer (marker-buffer marker))
  7877. (pos (marker-position marker)))
  7878. (switch-to-buffer-other-window buffer)
  7879. (widen)
  7880. (push-mark)
  7881. (goto-char pos)
  7882. (when (derived-mode-p 'org-mode)
  7883. (org-show-context 'agenda)
  7884. (recenter (/ (window-height) 2))
  7885. (org-back-to-heading t)
  7886. (let ((case-fold-search nil))
  7887. (when (re-search-forward org-complex-heading-regexp nil t)
  7888. (goto-char (match-beginning 4)))))
  7889. (run-hooks 'org-agenda-after-show-hook)
  7890. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7891. (defvar org-agenda-after-show-hook nil
  7892. "Normal hook run after an item has been shown from the agenda.
  7893. Point is in the buffer where the item originated.")
  7894. (defun org-agenda-kill ()
  7895. "Kill the entry or subtree belonging to the current agenda entry."
  7896. (interactive)
  7897. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7898. (let* ((bufname-orig (buffer-name))
  7899. (marker (or (org-get-at-bol 'org-marker)
  7900. (org-agenda-error)))
  7901. (buffer (marker-buffer marker))
  7902. (pos (marker-position marker))
  7903. (type (org-get-at-bol 'type))
  7904. dbeg dend (n 0))
  7905. (org-with-remote-undo buffer
  7906. (with-current-buffer buffer
  7907. (save-excursion
  7908. (goto-char pos)
  7909. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7910. (setq dbeg (progn (org-back-to-heading t) (point))
  7911. dend (org-end-of-subtree t t))
  7912. (setq dbeg (point-at-bol)
  7913. dend (min (point-max) (1+ (point-at-eol)))))
  7914. (goto-char dbeg)
  7915. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7916. (when (or (eq t org-agenda-confirm-kill)
  7917. (and (numberp org-agenda-confirm-kill)
  7918. (> n org-agenda-confirm-kill)))
  7919. (let ((win-conf (current-window-configuration)))
  7920. (unwind-protect
  7921. (and
  7922. (prog2
  7923. (org-agenda-tree-to-indirect-buffer nil)
  7924. (not (y-or-n-p
  7925. (format "Delete entry with %d lines in buffer \"%s\"? "
  7926. n (buffer-name buffer))))
  7927. (kill-buffer org-last-indirect-buffer))
  7928. (error "Abort"))
  7929. (set-window-configuration win-conf))))
  7930. (let ((org-agenda-buffer-name bufname-orig))
  7931. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7932. (with-current-buffer buffer (delete-region dbeg dend))
  7933. (message "Agenda item and source killed"))))
  7934. (defvar org-archive-default-command) ; defined in org-archive.el
  7935. (defun org-agenda-archive-default ()
  7936. "Archive the entry or subtree belonging to the current agenda entry."
  7937. (interactive)
  7938. (require 'org-archive)
  7939. (org-agenda-archive-with org-archive-default-command))
  7940. (defun org-agenda-archive-default-with-confirmation ()
  7941. "Archive the entry or subtree belonging to the current agenda entry."
  7942. (interactive)
  7943. (require 'org-archive)
  7944. (org-agenda-archive-with org-archive-default-command 'confirm))
  7945. (defun org-agenda-archive ()
  7946. "Archive the entry or subtree belonging to the current agenda entry."
  7947. (interactive)
  7948. (org-agenda-archive-with 'org-archive-subtree))
  7949. (defun org-agenda-archive-to-archive-sibling ()
  7950. "Move the entry to the archive sibling."
  7951. (interactive)
  7952. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7953. (defun org-agenda-archive-with (cmd &optional confirm)
  7954. "Move the entry to the archive sibling."
  7955. (interactive)
  7956. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7957. (let* ((bufname-orig (buffer-name))
  7958. (marker (or (org-get-at-bol 'org-marker)
  7959. (org-agenda-error)))
  7960. (buffer (marker-buffer marker))
  7961. (pos (marker-position marker)))
  7962. (org-with-remote-undo buffer
  7963. (with-current-buffer buffer
  7964. (if (derived-mode-p 'org-mode)
  7965. (if (and confirm
  7966. (not (y-or-n-p "Archive this subtree or entry? ")))
  7967. (error "Abort")
  7968. (save-window-excursion
  7969. (goto-char pos)
  7970. (let ((org-agenda-buffer-name bufname-orig))
  7971. (org-remove-subtree-entries-from-agenda))
  7972. (org-back-to-heading t)
  7973. (funcall cmd)))
  7974. (error "Archiving works only in Org files"))))))
  7975. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7976. "Remove all lines in the agenda that correspond to a given subtree.
  7977. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7978. If this information is not given, the function uses the tree at point."
  7979. (let ((buf (or buf (current-buffer))) m p)
  7980. (save-excursion
  7981. (unless (and beg end)
  7982. (org-back-to-heading t)
  7983. (setq beg (point))
  7984. (org-end-of-subtree t)
  7985. (setq end (point)))
  7986. (set-buffer (get-buffer org-agenda-buffer-name))
  7987. (save-excursion
  7988. (goto-char (point-max))
  7989. (beginning-of-line 1)
  7990. (while (not (bobp))
  7991. (when (and (setq m (org-get-at-bol 'org-marker))
  7992. (equal buf (marker-buffer m))
  7993. (setq p (marker-position m))
  7994. (>= p beg)
  7995. (< p end))
  7996. (let ((inhibit-read-only t))
  7997. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7998. (beginning-of-line 0))))))
  7999. (defun org-agenda-refile (&optional goto rfloc no-update)
  8000. "Refile the item at point.
  8001. When called with `\\[universal-argument] \\[universal-argument]', \
  8002. go to the location of the last
  8003. refiled item.
  8004. When called with `\\[universal-argument] \\[universal-argument] \
  8005. \\[universal-argument]' prefix or when GOTO is 0, clear
  8006. the refile cache.
  8007. RFLOC can be a refile location obtained in a different way.
  8008. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8009. (interactive "P")
  8010. (cond
  8011. ((member goto '(0 (64)))
  8012. (org-refile-cache-clear))
  8013. ((equal goto '(16))
  8014. (org-refile-goto-last-stored))
  8015. (t
  8016. (let* ((buffer-orig (buffer-name))
  8017. (marker (or (org-get-at-bol 'org-hd-marker)
  8018. (org-agenda-error)))
  8019. (buffer (marker-buffer marker))
  8020. (pos (marker-position marker))
  8021. (rfloc (or rfloc
  8022. (org-refile-get-location
  8023. (if goto "Goto" "Refile to") buffer
  8024. org-refile-allow-creating-parent-nodes))))
  8025. (with-current-buffer buffer
  8026. (org-with-wide-buffer
  8027. (goto-char marker)
  8028. (let ((org-agenda-buffer-name buffer-orig))
  8029. (org-remove-subtree-entries-from-agenda))
  8030. (org-refile goto buffer rfloc))))
  8031. (unless no-update (org-agenda-redo)))))
  8032. (defun org-agenda-open-link (&optional arg)
  8033. "Open the link(s) in the current entry, if any.
  8034. This looks for a link in the displayed line in the agenda.
  8035. It also looks at the text of the entry itself."
  8036. (interactive "P")
  8037. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8038. (org-get-at-bol 'org-marker)))
  8039. (buffer (and marker (marker-buffer marker)))
  8040. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8041. (lkall (and buffer (org-offer-links-in-entry
  8042. buffer marker arg prefix)))
  8043. (lk0 (car lkall))
  8044. (lk (if (stringp lk0) (list lk0) lk0))
  8045. (lkend (cdr lkall))
  8046. trg)
  8047. (cond
  8048. ((and buffer lk)
  8049. (mapcar (lambda(l)
  8050. (with-current-buffer buffer
  8051. (setq trg (and (string-match org-link-bracket-re l)
  8052. (match-string 1 l)))
  8053. (if (or (not trg) (string-match org-link-any-re trg))
  8054. (org-with-wide-buffer
  8055. (goto-char marker)
  8056. (when (search-forward l nil lkend)
  8057. (goto-char (match-beginning 0))
  8058. (org-open-at-point)))
  8059. ;; This is an internal link, widen the buffer
  8060. (switch-to-buffer-other-window buffer)
  8061. (widen)
  8062. (goto-char marker)
  8063. (when (search-forward l nil lkend)
  8064. (goto-char (match-beginning 0))
  8065. (org-open-at-point)))))
  8066. lk))
  8067. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8068. (save-excursion
  8069. (beginning-of-line 1)
  8070. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8071. (org-link-open-from-string (match-string 1)))
  8072. (t (message "No link to open here")))))
  8073. (defun org-agenda-copy-local-variable (var)
  8074. "Get a variable from a referenced buffer and install it here."
  8075. (let ((m (org-get-at-bol 'org-marker)))
  8076. (when (and m (buffer-live-p (marker-buffer m)))
  8077. (set (make-local-variable var)
  8078. (with-current-buffer (marker-buffer m)
  8079. (symbol-value var))))))
  8080. (defun org-agenda-switch-to (&optional delete-other-windows)
  8081. "Go to the Org mode file which contains the item at point.
  8082. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8083. displayed Org file fills the frame."
  8084. (interactive)
  8085. (if (and org-return-follows-link
  8086. (not (org-get-at-bol 'org-marker))
  8087. (org-in-regexp org-link-bracket-re))
  8088. (org-link-open-from-string (match-string 0))
  8089. (let* ((marker (or (org-get-at-bol 'org-marker)
  8090. (org-agenda-error)))
  8091. (buffer (marker-buffer marker))
  8092. (pos (marker-position marker)))
  8093. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8094. (pop-to-buffer-same-window buffer)
  8095. (when delete-other-windows (delete-other-windows))
  8096. (widen)
  8097. (goto-char pos)
  8098. (when (derived-mode-p 'org-mode)
  8099. (org-show-context 'agenda)
  8100. (run-hooks 'org-agenda-after-show-hook)))))
  8101. (defun org-agenda-goto-mouse (ev)
  8102. "Go to the Org file which contains the item at the mouse click."
  8103. (interactive "e")
  8104. (mouse-set-point ev)
  8105. (org-agenda-goto))
  8106. (defun org-agenda-show (&optional full-entry)
  8107. "Display the Org file which contains the item at point.
  8108. With prefix argument FULL-ENTRY, make the entire entry visible
  8109. if it was hidden in the outline."
  8110. (interactive "P")
  8111. (let ((win (selected-window)))
  8112. (org-agenda-goto t)
  8113. (when full-entry (org-show-entry))
  8114. (select-window win)))
  8115. (defvar org-agenda-show-window nil)
  8116. (defun org-agenda-show-and-scroll-up (&optional arg)
  8117. "Display the Org file which contains the item at point.
  8118. When called repeatedly, scroll the window that is displaying the buffer.
  8119. With a `\\[universal-argument]' prefix argument, display the item, but \
  8120. fold drawers."
  8121. (interactive "P")
  8122. (let ((win (selected-window)))
  8123. (if (and (window-live-p org-agenda-show-window)
  8124. (eq this-command last-command))
  8125. (progn
  8126. (select-window org-agenda-show-window)
  8127. (ignore-errors (scroll-up)))
  8128. (org-agenda-goto t)
  8129. (org-show-entry)
  8130. (if arg (org-cycle-hide-drawers 'children)
  8131. (org-with-wide-buffer
  8132. (narrow-to-region (org-entry-beginning-position)
  8133. (org-entry-end-position))
  8134. (org-show-all '(drawers))))
  8135. (when arg )
  8136. (setq org-agenda-show-window (selected-window)))
  8137. (select-window win)))
  8138. (defun org-agenda-show-scroll-down ()
  8139. "Scroll down the window showing the agenda."
  8140. (interactive)
  8141. (let ((win (selected-window)))
  8142. (when (window-live-p org-agenda-show-window)
  8143. (select-window org-agenda-show-window)
  8144. (ignore-errors (scroll-down))
  8145. (select-window win))))
  8146. (defun org-agenda-show-1 (&optional more)
  8147. "Display the Org file which contains the item at point.
  8148. The prefix arg selects the amount of information to display:
  8149. 0 hide the subtree
  8150. 1 just show the entry according to defaults.
  8151. 2 show the children view
  8152. 3 show the subtree view
  8153. 4 show the entire subtree and any LOGBOOK drawers
  8154. 5 show the entire subtree and any drawers
  8155. With prefix argument FULL-ENTRY, make the entire entry visible
  8156. if it was hidden in the outline."
  8157. (interactive "p")
  8158. (let ((win (selected-window)))
  8159. (org-agenda-goto t)
  8160. (org-back-to-heading)
  8161. (set-window-start (selected-window) (point-at-bol))
  8162. (cond
  8163. ((= more 0)
  8164. (org-flag-subtree t)
  8165. (save-excursion
  8166. (org-back-to-heading)
  8167. (run-hook-with-args 'org-cycle-hook 'folded))
  8168. (message "Remote: FOLDED"))
  8169. ((and (called-interactively-p 'any) (= more 1))
  8170. (message "Remote: show with default settings"))
  8171. ((= more 2)
  8172. (outline-show-entry)
  8173. (org-show-children)
  8174. (save-excursion
  8175. (org-back-to-heading)
  8176. (run-hook-with-args 'org-cycle-hook 'children))
  8177. (message "Remote: CHILDREN"))
  8178. ((= more 3)
  8179. (outline-show-subtree)
  8180. (save-excursion
  8181. (org-back-to-heading)
  8182. (run-hook-with-args 'org-cycle-hook 'subtree))
  8183. (message "Remote: SUBTREE"))
  8184. ((= more 4)
  8185. (outline-show-subtree)
  8186. (save-excursion
  8187. (org-back-to-heading)
  8188. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8189. (message "Remote: SUBTREE AND LOGBOOK"))
  8190. ((> more 4)
  8191. (outline-show-subtree)
  8192. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8193. (select-window win)))
  8194. (defvar org-agenda-cycle-counter nil)
  8195. (defun org-agenda-cycle-show (&optional n)
  8196. "Show the current entry in another window, with default settings.
  8197. Default settings are taken from `org-show-context-detail'. When
  8198. use repeatedly in immediate succession, the remote entry will
  8199. cycle through visibility
  8200. children -> subtree -> folded
  8201. When called with a numeric prefix arg, that arg will be passed through to
  8202. `org-agenda-show-1'. For the interpretation of that argument, see the
  8203. docstring of `org-agenda-show-1'."
  8204. (interactive "P")
  8205. (if (integerp n)
  8206. (setq org-agenda-cycle-counter n)
  8207. (if (not (eq last-command this-command))
  8208. (setq org-agenda-cycle-counter 1)
  8209. (if (equal org-agenda-cycle-counter 0)
  8210. (setq org-agenda-cycle-counter 2)
  8211. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8212. (when (> org-agenda-cycle-counter 3)
  8213. (setq org-agenda-cycle-counter 0)))))
  8214. (org-agenda-show-1 org-agenda-cycle-counter))
  8215. (defun org-agenda-recenter (arg)
  8216. "Display the Org file which contains the item at point and recenter."
  8217. (interactive "P")
  8218. (let ((win (selected-window)))
  8219. (org-agenda-goto t)
  8220. (recenter arg)
  8221. (select-window win)))
  8222. (defun org-agenda-show-mouse (ev)
  8223. "Display the Org file which contains the item at the mouse click."
  8224. (interactive "e")
  8225. (mouse-set-point ev)
  8226. (org-agenda-show))
  8227. (defun org-agenda-check-no-diary ()
  8228. "Check if the entry is a diary link and abort if yes."
  8229. (when (org-get-at-bol 'org-agenda-diary-link)
  8230. (org-agenda-error)))
  8231. (defun org-agenda-error ()
  8232. "Throw an error when a command is not allowed in the agenda."
  8233. (user-error "Command not allowed in this line"))
  8234. (defun org-agenda-tree-to-indirect-buffer (arg)
  8235. "Show the subtree corresponding to the current entry in an indirect buffer.
  8236. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8237. With a numerical prefix ARG, go up to this level and then take that tree.
  8238. With a negative numeric ARG, go up by this number of levels.
  8239. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8240. i.e. don't use
  8241. the dedicated frame."
  8242. (interactive "P")
  8243. (if current-prefix-arg
  8244. (org-agenda-do-tree-to-indirect-buffer arg)
  8245. (let ((agenda-buffer (buffer-name))
  8246. (agenda-window (selected-window))
  8247. (indirect-window
  8248. (and org-last-indirect-buffer
  8249. (get-buffer-window org-last-indirect-buffer))))
  8250. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8251. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8252. (eq org-indirect-buffer-display 'dedicated-frame))
  8253. (unwind-protect
  8254. (unless (and indirect-window (window-live-p indirect-window))
  8255. (setq indirect-window (split-window agenda-window)))
  8256. (and indirect-window (select-window indirect-window))
  8257. (switch-to-buffer org-last-indirect-buffer :norecord)
  8258. (fit-window-to-buffer indirect-window)))
  8259. (select-window (get-buffer-window agenda-buffer))
  8260. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8261. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8262. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8263. (org-agenda-check-no-diary)
  8264. (let* ((marker (or (org-get-at-bol 'org-marker)
  8265. (org-agenda-error)))
  8266. (buffer (marker-buffer marker))
  8267. (pos (marker-position marker)))
  8268. (with-current-buffer buffer
  8269. (save-excursion
  8270. (goto-char pos)
  8271. (org-tree-to-indirect-buffer arg)))))
  8272. (defvar org-last-heading-marker (make-marker)
  8273. "Marker pointing to the headline that last changed its TODO state
  8274. by a remote command from the agenda.")
  8275. (defun org-agenda-todo-nextset ()
  8276. "Switch TODO entry to next sequence."
  8277. (interactive)
  8278. (org-agenda-todo 'nextset))
  8279. (defun org-agenda-todo-previousset ()
  8280. "Switch TODO entry to previous sequence."
  8281. (interactive)
  8282. (org-agenda-todo 'previousset))
  8283. (defun org-agenda-todo (&optional arg)
  8284. "Cycle TODO state of line at point, also in Org file.
  8285. This changes the line at point, all other lines in the agenda referring to
  8286. the same tree node, and the headline of the tree node in the Org file."
  8287. (interactive "P")
  8288. (org-agenda-check-no-diary)
  8289. (let* ((col (current-column))
  8290. (marker (or (org-get-at-bol 'org-marker)
  8291. (org-agenda-error)))
  8292. (buffer (marker-buffer marker))
  8293. (pos (marker-position marker))
  8294. (hdmarker (org-get-at-bol 'org-hd-marker))
  8295. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8296. (inhibit-read-only t)
  8297. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8298. (org-with-remote-undo buffer
  8299. (with-current-buffer buffer
  8300. (widen)
  8301. (goto-char pos)
  8302. (org-show-context 'agenda)
  8303. (let ((current-prefix-arg arg))
  8304. (call-interactively 'org-todo))
  8305. (and (bolp) (forward-char 1))
  8306. (setq newhead (org-get-heading))
  8307. (when (and (bound-and-true-p
  8308. org-agenda-headline-snapshot-before-repeat)
  8309. (not (equal org-agenda-headline-snapshot-before-repeat
  8310. newhead))
  8311. todayp)
  8312. (setq newhead org-agenda-headline-snapshot-before-repeat
  8313. just-one t))
  8314. (save-excursion
  8315. (org-back-to-heading)
  8316. (move-marker org-last-heading-marker (point))))
  8317. (beginning-of-line 1)
  8318. (save-window-excursion
  8319. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8320. (when (bound-and-true-p org-clock-out-when-done)
  8321. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8322. newhead)
  8323. (org-agenda-unmark-clocking-task))
  8324. (org-move-to-column col)
  8325. (org-agenda-mark-clocking-task))))
  8326. (defun org-agenda-add-note (&optional arg)
  8327. "Add a time-stamped note to the entry at point."
  8328. (interactive "P")
  8329. (org-agenda-check-no-diary)
  8330. (let* ((marker (or (org-get-at-bol 'org-marker)
  8331. (org-agenda-error)))
  8332. (buffer (marker-buffer marker))
  8333. (pos (marker-position marker))
  8334. (hdmarker (org-get-at-bol 'org-hd-marker))
  8335. (inhibit-read-only t))
  8336. (with-current-buffer buffer
  8337. (widen)
  8338. (goto-char pos)
  8339. (org-show-context 'agenda)
  8340. (org-add-note))))
  8341. (defun org-agenda-change-all-lines (newhead hdmarker
  8342. &optional fixface just-this)
  8343. "Change all lines in the agenda buffer which match HDMARKER.
  8344. The new content of the line will be NEWHEAD (as modified by
  8345. `org-agenda-format-item'). HDMARKER is checked with
  8346. `equal' against all `org-hd-marker' text properties in the file.
  8347. If FIXFACE is non-nil, the face of each item is modified according to
  8348. the new TODO state.
  8349. If JUST-THIS is non-nil, change just the current line, not all.
  8350. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8351. (let* ((inhibit-read-only t)
  8352. (line (org-current-line))
  8353. (org-agenda-buffer (current-buffer))
  8354. (thetags (with-current-buffer (marker-buffer hdmarker)
  8355. (org-get-tags hdmarker)))
  8356. props m pl undone-face done-face finish new dotime level cat tags)
  8357. (save-excursion
  8358. (goto-char (point-max))
  8359. (beginning-of-line 1)
  8360. (while (not finish)
  8361. (setq finish (bobp))
  8362. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8363. (or (not just-this) (= (org-current-line) line))
  8364. (equal m hdmarker))
  8365. (setq props (text-properties-at (point))
  8366. dotime (org-get-at-bol 'dotime)
  8367. cat (org-agenda-get-category)
  8368. level (org-get-at-bol 'level)
  8369. tags thetags
  8370. new
  8371. (let ((org-prefix-format-compiled
  8372. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8373. org-prefix-format-compiled))
  8374. (extra (org-get-at-bol 'extra)))
  8375. (with-current-buffer (marker-buffer hdmarker)
  8376. (org-with-wide-buffer
  8377. (org-agenda-format-item extra newhead level cat tags dotime))))
  8378. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8379. undone-face (org-get-at-bol 'undone-face)
  8380. done-face (org-get-at-bol 'done-face))
  8381. (beginning-of-line 1)
  8382. (cond
  8383. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8384. ((looking-at ".*")
  8385. ;; When replacing the whole line, preserve bulk mark
  8386. ;; overlay, if any.
  8387. (let ((mark (catch :overlay
  8388. (dolist (o (overlays-in (point) (+ 2 (point))))
  8389. (when (eq (overlay-get o 'type)
  8390. 'org-marked-entry-overlay)
  8391. (throw :overlay o))))))
  8392. (replace-match new t t)
  8393. (beginning-of-line)
  8394. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8395. (add-text-properties (point-at-bol) (point-at-eol) props)
  8396. (when fixface
  8397. (add-text-properties
  8398. (point-at-bol) (point-at-eol)
  8399. (list 'face
  8400. (if org-last-todo-state-is-todo
  8401. undone-face done-face))))
  8402. (org-agenda-highlight-todo 'line)
  8403. (beginning-of-line 1))
  8404. (t (error "Line update did not work")))
  8405. (save-restriction
  8406. (narrow-to-region (point-at-bol) (point-at-eol))
  8407. (org-agenda-finalize)))
  8408. (beginning-of-line 0)))))
  8409. (defun org-agenda-align-tags (&optional line)
  8410. "Align all tags in agenda items to `org-agenda-tags-column'.
  8411. When optional argument LINE is non-nil, align tags only on the
  8412. current line."
  8413. (let ((inhibit-read-only t)
  8414. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8415. (- (window-text-width))
  8416. org-agenda-tags-column))
  8417. (end (and line (line-end-position)))
  8418. l c)
  8419. (save-excursion
  8420. (goto-char (if line (line-beginning-position) (point-min)))
  8421. (while (re-search-forward org-tag-group-re end t)
  8422. (add-text-properties
  8423. (match-beginning 1) (match-end 1)
  8424. (list 'face (delq nil (let ((prop (get-text-property
  8425. (match-beginning 1) 'face)))
  8426. (or (listp prop) (setq prop (list prop)))
  8427. (if (memq 'org-tag prop)
  8428. prop
  8429. (cons 'org-tag prop))))))
  8430. (setq l (string-width (match-string 1))
  8431. c (if (< org-agenda-tags-column 0)
  8432. (- (abs org-agenda-tags-column) l)
  8433. org-agenda-tags-column))
  8434. (goto-char (match-beginning 1))
  8435. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8436. (point))
  8437. (insert (org-add-props
  8438. (make-string (max 1 (- c (current-column))) ?\s)
  8439. (plist-put (copy-sequence (text-properties-at (point)))
  8440. 'face nil))))
  8441. (goto-char (point-min))
  8442. (org-font-lock-add-tag-faces (point-max)))))
  8443. (defun org-agenda-priority-up ()
  8444. "Increase the priority of line at point, also in Org file."
  8445. (interactive)
  8446. (org-agenda-priority 'up))
  8447. (defun org-agenda-priority-down ()
  8448. "Decrease the priority of line at point, also in Org file."
  8449. (interactive)
  8450. (org-agenda-priority 'down))
  8451. (defun org-agenda-priority (&optional force-direction)
  8452. "Set the priority of line at point, also in Org file.
  8453. This changes the line at point, all other lines in the agenda referring to
  8454. the same tree node, and the headline of the tree node in the Org file.
  8455. Called with a universal prefix arg, show the priority instead of setting it."
  8456. (interactive "P")
  8457. (if (equal force-direction '(4))
  8458. (org-show-priority)
  8459. (unless org-enable-priority-commands
  8460. (error "Priority commands are disabled"))
  8461. (org-agenda-check-no-diary)
  8462. (let* ((col (current-column))
  8463. (marker (or (org-get-at-bol 'org-marker)
  8464. (org-agenda-error)))
  8465. (hdmarker (org-get-at-bol 'org-hd-marker))
  8466. (buffer (marker-buffer hdmarker))
  8467. (pos (marker-position hdmarker))
  8468. (inhibit-read-only t)
  8469. newhead)
  8470. (org-with-remote-undo buffer
  8471. (with-current-buffer buffer
  8472. (widen)
  8473. (goto-char pos)
  8474. (org-show-context 'agenda)
  8475. (org-priority force-direction)
  8476. (end-of-line 1)
  8477. (setq newhead (org-get-heading)))
  8478. (org-agenda-change-all-lines newhead hdmarker)
  8479. (org-move-to-column col)))))
  8480. ;; FIXME: should fix the tags property of the agenda line.
  8481. (defun org-agenda-set-tags (&optional tag onoff)
  8482. "Set tags for the current headline."
  8483. (interactive)
  8484. (org-agenda-check-no-diary)
  8485. (if (and (org-region-active-p) (called-interactively-p 'any))
  8486. (call-interactively 'org-change-tag-in-region)
  8487. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8488. (org-agenda-error)))
  8489. (buffer (marker-buffer hdmarker))
  8490. (pos (marker-position hdmarker))
  8491. (inhibit-read-only t)
  8492. newhead)
  8493. (org-with-remote-undo buffer
  8494. (with-current-buffer buffer
  8495. (widen)
  8496. (goto-char pos)
  8497. (org-show-context 'agenda)
  8498. (if tag
  8499. (org-toggle-tag tag onoff)
  8500. (call-interactively #'org-set-tags-command))
  8501. (end-of-line 1)
  8502. (setq newhead (org-get-heading)))
  8503. (org-agenda-change-all-lines newhead hdmarker)
  8504. (beginning-of-line 1)))))
  8505. (defun org-agenda-set-property ()
  8506. "Set a property for the current headline."
  8507. (interactive)
  8508. (org-agenda-check-no-diary)
  8509. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8510. (org-agenda-error)))
  8511. (buffer (marker-buffer hdmarker))
  8512. (pos (marker-position hdmarker))
  8513. (inhibit-read-only t)
  8514. newhead)
  8515. (org-with-remote-undo buffer
  8516. (with-current-buffer buffer
  8517. (widen)
  8518. (goto-char pos)
  8519. (org-show-context 'agenda)
  8520. (call-interactively 'org-set-property)))))
  8521. (defun org-agenda-set-effort ()
  8522. "Set the effort property for the current headline."
  8523. (interactive)
  8524. (org-agenda-check-no-diary)
  8525. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8526. (org-agenda-error)))
  8527. (buffer (marker-buffer hdmarker))
  8528. (pos (marker-position hdmarker))
  8529. (inhibit-read-only t)
  8530. newhead)
  8531. (org-with-remote-undo buffer
  8532. (with-current-buffer buffer
  8533. (widen)
  8534. (goto-char pos)
  8535. (org-show-context 'agenda)
  8536. (call-interactively 'org-set-effort)
  8537. (end-of-line 1)
  8538. (setq newhead (org-get-heading)))
  8539. (org-agenda-change-all-lines newhead hdmarker))))
  8540. (defun org-agenda-toggle-archive-tag ()
  8541. "Toggle the archive tag for the current entry."
  8542. (interactive)
  8543. (org-agenda-check-no-diary)
  8544. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8545. (org-agenda-error)))
  8546. (buffer (marker-buffer hdmarker))
  8547. (pos (marker-position hdmarker))
  8548. (inhibit-read-only t)
  8549. newhead)
  8550. (org-with-remote-undo buffer
  8551. (with-current-buffer buffer
  8552. (widen)
  8553. (goto-char pos)
  8554. (org-show-context 'agenda)
  8555. (call-interactively 'org-toggle-archive-tag)
  8556. (end-of-line 1)
  8557. (setq newhead (org-get-heading)))
  8558. (org-agenda-change-all-lines newhead hdmarker)
  8559. (beginning-of-line 1))))
  8560. (defun org-agenda-do-date-later (arg)
  8561. (interactive "P")
  8562. (cond
  8563. ((or (equal arg '(16))
  8564. (memq last-command
  8565. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8566. (setq this-command 'org-agenda-date-later-minutes)
  8567. (org-agenda-date-later-minutes 1))
  8568. ((or (equal arg '(4))
  8569. (memq last-command
  8570. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8571. (setq this-command 'org-agenda-date-later-hours)
  8572. (org-agenda-date-later-hours 1))
  8573. (t
  8574. (org-agenda-date-later (prefix-numeric-value arg)))))
  8575. (defun org-agenda-do-date-earlier (arg)
  8576. (interactive "P")
  8577. (cond
  8578. ((or (equal arg '(16))
  8579. (memq last-command
  8580. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8581. (setq this-command 'org-agenda-date-earlier-minutes)
  8582. (org-agenda-date-earlier-minutes 1))
  8583. ((or (equal arg '(4))
  8584. (memq last-command
  8585. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8586. (setq this-command 'org-agenda-date-earlier-hours)
  8587. (org-agenda-date-earlier-hours 1))
  8588. (t
  8589. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8590. (defun org-agenda-date-later (arg &optional what)
  8591. "Change the date of this item to ARG day(s) later."
  8592. (interactive "p")
  8593. (org-agenda-check-type t 'agenda)
  8594. (org-agenda-check-no-diary)
  8595. (let* ((marker (or (org-get-at-bol 'org-marker)
  8596. (org-agenda-error)))
  8597. (buffer (marker-buffer marker))
  8598. (pos (marker-position marker))
  8599. cdate today)
  8600. (org-with-remote-undo buffer
  8601. (with-current-buffer buffer
  8602. (widen)
  8603. (goto-char pos)
  8604. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8605. (when (and org-agenda-move-date-from-past-immediately-to-today
  8606. (equal arg 1)
  8607. (or (not what) (eq what 'day))
  8608. (not (save-match-data (org-at-date-range-p))))
  8609. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8610. cdate (calendar-absolute-from-gregorian
  8611. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8612. today (org-today))
  8613. (when (> today cdate)
  8614. ;; immediately shift to today
  8615. (setq arg (- today cdate))))
  8616. (org-timestamp-change arg (or what 'day))
  8617. (when (and (org-at-date-range-p)
  8618. (re-search-backward o