org-agenda.el 395 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2018 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 'org)
  43. (require 'org-macs)
  44. (declare-function diary-add-to-list "diary-lib"
  45. (date string specifier &optional marker globcolor literal))
  46. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  47. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  48. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  49. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  50. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  51. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-french-date-string "cal-french" (&optional date))
  53. (declare-function calendar-goto-date "cal-move" (date))
  54. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  55. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  56. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  57. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  58. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  59. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  60. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  61. (declare-function calendar-check-holidays "holidays" (date))
  62. (declare-function org-columns-remove-overlays "org-colview" ())
  63. (declare-function org-datetree-find-date-create "org-datetree"
  64. (date &optional keep-restriction))
  65. (declare-function org-columns-quit "org-colview" ())
  66. (declare-function diary-date-display-form "diary-lib" (&optional type))
  67. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  68. (declare-function org-habit-insert-consistency-graphs
  69. "org-habit" (&optional line))
  70. (declare-function org-is-habit-p "org-habit" (&optional pom))
  71. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  72. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  73. (declare-function org-agenda-columns "org-colview" ())
  74. (declare-function org-add-archive-files "org-archive" (files))
  75. (declare-function org-capture "org-capture" (&optional goto keys))
  76. (defvar calendar-mode-map)
  77. (defvar org-clock-current-task)
  78. (defvar org-current-tag-alist)
  79. (defvar org-mobile-force-id-on-agenda-items)
  80. (defvar org-habit-show-habits)
  81. (defvar org-habit-show-habits-only-for-today)
  82. (defvar org-habit-show-all-today)
  83. ;; Defined somewhere in this file, but used before definition.
  84. (defvar org-agenda-buffer-name "*Org Agenda*")
  85. (defvar org-agenda-overriding-header nil)
  86. (defvar org-agenda-title-append nil)
  87. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  88. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  89. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  90. (defvar org-agenda-undo-list nil
  91. "List of undoable operations in the agenda since last refresh.")
  92. (defvar org-agenda-pending-undo-list nil
  93. "In a series of undo commands, this is the list of remaining undo items.")
  94. (defcustom org-agenda-confirm-kill 1
  95. "When set, remote killing from the agenda buffer needs confirmation.
  96. When t, a confirmation is always needed. When a number N, confirmation is
  97. only needed when the text to be killed contains more than N non-white lines."
  98. :group 'org-agenda
  99. :type '(choice
  100. (const :tag "Never" nil)
  101. (const :tag "Always" t)
  102. (integer :tag "When more than N lines")))
  103. (defcustom org-agenda-compact-blocks nil
  104. "Non-nil means make the block agenda more compact.
  105. This is done globally by leaving out lines like the agenda span
  106. name and week number or the separator lines."
  107. :group 'org-agenda
  108. :type 'boolean)
  109. (defcustom org-agenda-block-separator ?=
  110. "The separator between blocks in the agenda.
  111. If this is a string, it will be used as the separator, with a newline added.
  112. If it is a character, it will be repeated to fill the window width.
  113. If nil the separator is disabled. In `org-agenda-custom-commands' this
  114. addresses the separator between the current and the previous block."
  115. :group 'org-agenda
  116. :type '(choice
  117. (const :tag "Disabled" nil)
  118. (character)
  119. (string)))
  120. (defgroup org-agenda-export nil
  121. "Options concerning exporting agenda views in Org mode."
  122. :tag "Org Agenda Export"
  123. :group 'org-agenda)
  124. (defcustom org-agenda-with-colors t
  125. "Non-nil means use colors in agenda views."
  126. :group 'org-agenda-export
  127. :type 'boolean)
  128. (defcustom org-agenda-exporter-settings nil
  129. "Alist of variable/value pairs that should be active during agenda export.
  130. This is a good place to set options for ps-print and for htmlize.
  131. Note that the way this is implemented, the values will be evaluated
  132. before assigned to the variables. So make sure to quote values you do
  133. *not* want evaluated, for example
  134. (setq org-agenda-exporter-settings
  135. \\='((ps-print-color-p \\='black-white)))"
  136. :group 'org-agenda-export
  137. :type '(repeat
  138. (list
  139. (variable)
  140. (sexp :tag "Value"))))
  141. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  142. "Hook run in a temporary buffer before writing the agenda to an export file.
  143. A useful function for this hook is `org-agenda-add-entry-text'."
  144. :group 'org-agenda-export
  145. :type 'hook
  146. :options '(org-agenda-add-entry-text))
  147. (defcustom org-agenda-add-entry-text-maxlines 0
  148. "Maximum number of entry text lines to be added to agenda.
  149. This is only relevant when `org-agenda-add-entry-text' is part of
  150. `org-agenda-before-write-hook', which is the default.
  151. When this is 0, nothing will happen. When it is greater than 0, it
  152. specifies the maximum number of lines that will be added for each entry
  153. that is listed in the agenda view.
  154. Note that this variable is not used during display, only when exporting
  155. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  156. and `org-agenda-entry-text-maxlines'."
  157. :group 'org-agenda
  158. :type 'integer)
  159. (defcustom org-agenda-add-entry-text-descriptive-links t
  160. "Non-nil means export org-links as descriptive links in agenda added text.
  161. This variable applies to the text added to the agenda when
  162. `org-agenda-add-entry-text-maxlines' is larger than 0.
  163. When this variable nil, the URL will (also) be shown."
  164. :group 'org-agenda
  165. :type 'boolean)
  166. (defcustom org-agenda-export-html-style nil
  167. "The style specification for exported HTML Agenda files.
  168. If this variable contains a string, it will replace the default <style>
  169. section as produced by `htmlize'.
  170. Since there are different ways of setting style information, this variable
  171. needs to contain the full HTML structure to provide a style, including the
  172. surrounding HTML tags. The style specifications should include definitions
  173. the fonts used by the agenda, here is an example:
  174. <style type=\"text/css\">
  175. p { font-weight: normal; color: gray; }
  176. .org-agenda-structure {
  177. font-size: 110%;
  178. color: #003399;
  179. font-weight: 600;
  180. }
  181. .org-todo {
  182. color: #cc6666;
  183. font-weight: bold;
  184. }
  185. .org-agenda-done {
  186. color: #339933;
  187. }
  188. .org-done {
  189. color: #339933;
  190. }
  191. .title { text-align: center; }
  192. .todo, .deadline { color: red; }
  193. .done { color: green; }
  194. </style>
  195. or, if you want to keep the style in a file,
  196. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  197. As the value of this option simply gets inserted into the HTML <head> header,
  198. you can \"misuse\" it to also add other text to the header."
  199. :group 'org-agenda-export
  200. :group 'org-export-html
  201. :type '(choice
  202. (const nil)
  203. (string)))
  204. (defcustom org-agenda-persistent-filter nil
  205. "When set, keep filters from one agenda view to the next."
  206. :group 'org-agenda
  207. :type 'boolean)
  208. (defgroup org-agenda-custom-commands nil
  209. "Options concerning agenda views in Org mode."
  210. :tag "Org Agenda Custom Commands"
  211. :group 'org-agenda)
  212. (defconst org-sorting-choice
  213. '(choice
  214. (const time-up) (const time-down)
  215. (const timestamp-up) (const timestamp-down)
  216. (const scheduled-up) (const scheduled-down)
  217. (const deadline-up) (const deadline-down)
  218. (const ts-up) (const ts-down)
  219. (const tsia-up) (const tsia-down)
  220. (const category-keep) (const category-up) (const category-down)
  221. (const tag-down) (const tag-up)
  222. (const priority-up) (const priority-down)
  223. (const todo-state-up) (const todo-state-down)
  224. (const effort-up) (const effort-down)
  225. (const habit-up) (const habit-down)
  226. (const alpha-up) (const alpha-down)
  227. (const user-defined-up) (const user-defined-down))
  228. "Sorting choices.")
  229. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  230. ;; the new variable `org-agenda-tag-filter-preset'.
  231. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  232. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  233. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  234. "List of types searched for when creating the daily/weekly agenda.
  235. This variable is a list of symbols that controls the types of
  236. items that appear in the daily/weekly agenda. Allowed symbols in this
  237. list are are
  238. :timestamp List items containing a date stamp or date range matching
  239. the selected date. This includes sexp entries in angular
  240. brackets.
  241. :sexp List entries resulting from plain diary-like sexps.
  242. :deadline List deadline due on that date. When the date is today,
  243. also list any deadlines past due, or due within
  244. `org-deadline-warning-days'.
  245. :deadline* Same as above, but only include the deadline if it has an
  246. hour specification as [h]h:mm.
  247. :scheduled List all items which are scheduled for the given date.
  248. The diary for *today* also contains items which were
  249. scheduled earlier and are not yet marked DONE.
  250. :scheduled* Same as above, but only include the scheduled item if it
  251. has an hour specification as [h]h:mm.
  252. By default, all four non-starred types are turned on.
  253. When :scheduled* or :deadline* are included, :schedule or :deadline
  254. will be ignored.
  255. Never set this variable globally using `setq', because then it
  256. will apply to all future agenda commands. Instead, bind it with
  257. `let' to scope it dynamically into the agenda-constructing
  258. command. A good way to set it is through options in
  259. `org-agenda-custom-commands'. For a more flexible (though
  260. somewhat less efficient) way of determining what is included in
  261. the daily/weekly agenda, see `org-agenda-skip-function'.")
  262. (defconst org-agenda-custom-commands-local-options
  263. `(repeat :tag "Local settings for this command. Remember to quote values"
  264. (choice :tag "Setting"
  265. (list :tag "Heading for this block"
  266. (const org-agenda-overriding-header)
  267. (string :tag "Headline"))
  268. (list :tag "Files to be searched"
  269. (const org-agenda-files)
  270. (list
  271. (const :format "" quote)
  272. (repeat (file))))
  273. (list :tag "Sorting strategy"
  274. (const org-agenda-sorting-strategy)
  275. (list
  276. (const :format "" quote)
  277. (repeat
  278. ,org-sorting-choice)))
  279. (list :tag "Prefix format"
  280. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  281. (string))
  282. (list :tag "Number of days in agenda"
  283. (const org-agenda-span)
  284. (list
  285. (const :format "" quote)
  286. (choice (const :tag "Day" day)
  287. (const :tag "Week" week)
  288. (const :tag "Fortnight" fortnight)
  289. (const :tag "Month" month)
  290. (const :tag "Year" year)
  291. (integer :tag "Custom"))))
  292. (list :tag "Fixed starting date"
  293. (const org-agenda-start-day)
  294. (string :value "2007-11-01"))
  295. (list :tag "Start on day of week"
  296. (const org-agenda-start-on-weekday)
  297. (choice :value 1
  298. (const :tag "Today" nil)
  299. (integer :tag "Weekday No.")))
  300. (list :tag "Include data from diary"
  301. (const org-agenda-include-diary)
  302. (boolean))
  303. (list :tag "Deadline Warning days"
  304. (const org-deadline-warning-days)
  305. (integer :value 1))
  306. (list :tag "Category filter preset"
  307. (const org-agenda-category-filter-preset)
  308. (list
  309. (const :format "" quote)
  310. (repeat
  311. (string :tag "+category or -category"))))
  312. (list :tag "Tags filter preset"
  313. (const org-agenda-tag-filter-preset)
  314. (list
  315. (const :format "" quote)
  316. (repeat
  317. (string :tag "+tag or -tag"))))
  318. (list :tag "Effort filter preset"
  319. (const org-agenda-effort-filter-preset)
  320. (list
  321. (const :format "" quote)
  322. (repeat
  323. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  324. (list :tag "Regexp filter preset"
  325. (const org-agenda-regexp-filter-preset)
  326. (list
  327. (const :format "" quote)
  328. (repeat
  329. (string :tag "+regexp or -regexp"))))
  330. (list :tag "Set daily/weekly entry types"
  331. (const org-agenda-entry-types)
  332. (list
  333. (const :format "" quote)
  334. (set :greedy t :value ,org-agenda-entry-types
  335. (const :deadline)
  336. (const :scheduled)
  337. (const :deadline*)
  338. (const :scheduled*)
  339. (const :timestamp)
  340. (const :sexp))))
  341. (list :tag "Standard skipping condition"
  342. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  343. (const org-agenda-skip-function)
  344. (list
  345. (const :format "" quote)
  346. (list
  347. (choice
  348. :tag "Skipping range"
  349. (const :tag "Skip entry" org-agenda-skip-entry-if)
  350. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  351. (repeat :inline t :tag "Conditions for skipping"
  352. (choice
  353. :tag "Condition type"
  354. (list :tag "Regexp matches" :inline t
  355. (const :format "" regexp)
  356. (regexp))
  357. (list :tag "Regexp does not match" :inline t
  358. (const :format "" notregexp)
  359. (regexp))
  360. (list :tag "TODO state is" :inline t
  361. (const todo)
  362. (choice
  363. (const :tag "Any not-done state" todo)
  364. (const :tag "Any done state" done)
  365. (const :tag "Any state" any)
  366. (list :tag "Keyword list"
  367. (const :format "" quote)
  368. (repeat (string :tag "Keyword")))))
  369. (list :tag "TODO state is not" :inline t
  370. (const nottodo)
  371. (choice
  372. (const :tag "Any not-done state" todo)
  373. (const :tag "Any done state" done)
  374. (const :tag "Any state" any)
  375. (list :tag "Keyword list"
  376. (const :format "" quote)
  377. (repeat (string :tag "Keyword")))))
  378. (const :tag "scheduled" scheduled)
  379. (const :tag "not scheduled" notscheduled)
  380. (const :tag "deadline" deadline)
  381. (const :tag "no deadline" notdeadline)
  382. (const :tag "timestamp" timestamp)
  383. (const :tag "no timestamp" nottimestamp))))))
  384. (list :tag "Non-standard skipping condition"
  385. :value (org-agenda-skip-function)
  386. (const org-agenda-skip-function)
  387. (sexp :tag "Function or form (quoted!)"))
  388. (list :tag "Any variable"
  389. (variable :tag "Variable")
  390. (sexp :tag "Value (sexp)"))))
  391. "Selection of examples for agenda command settings.
  392. This will be spliced into the custom type of
  393. `org-agenda-custom-commands'.")
  394. (defcustom org-agenda-custom-commands
  395. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  396. "Custom commands for the agenda.
  397. \\<org-mode-map>
  398. These commands will be offered on the splash screen displayed by the
  399. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  400. (key desc type match settings files)
  401. key The key (one or more characters as a string) to be associated
  402. with the command.
  403. desc A description of the command, when omitted or nil, a default
  404. description is built using MATCH.
  405. type The command type, any of the following symbols:
  406. agenda The daily/weekly agenda.
  407. todo Entries with a specific TODO keyword, in all agenda files.
  408. search Entries containing search words entry or headline.
  409. tags Tags/Property/TODO match in all agenda files.
  410. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  411. todo-tree Sparse tree of specific TODO keyword in *current* file.
  412. tags-tree Sparse tree with all tags matches in *current* file.
  413. occur-tree Occur sparse tree for *current* file.
  414. ... A user-defined function.
  415. match What to search for:
  416. - a single keyword for TODO keyword searches
  417. - a tags match expression for tags searches
  418. - a word search expression for text searches.
  419. - a regular expression for occur searches
  420. For all other commands, this should be the empty string.
  421. settings A list of option settings, similar to that in a let form, so like
  422. this: ((opt1 val1) (opt2 val2) ...). The values will be
  423. evaluated at the moment of execution, so quote them when needed.
  424. files A list of files to write the produced agenda buffer to with
  425. the command `org-store-agenda-views'.
  426. If a file name ends in \".html\", an HTML version of the buffer
  427. is written out. If it ends in \".ps\", a postscript version is
  428. produced. Otherwise, only the plain text is written to the file.
  429. You can also define a set of commands, to create a composite agenda buffer.
  430. In this case, an entry looks like this:
  431. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  432. where
  433. desc A description string to be displayed in the dispatcher menu.
  434. cmd An agenda command, similar to the above. However, tree commands
  435. are not allowed, but instead you can get agenda and global todo list.
  436. So valid commands for a set are:
  437. (agenda \"\" settings)
  438. (alltodo \"\" settings)
  439. (stuck \"\" settings)
  440. (todo \"match\" settings files)
  441. (search \"match\" settings files)
  442. (tags \"match\" settings files)
  443. (tags-todo \"match\" settings files)
  444. Each command can carry a list of options, and another set of options can be
  445. given for the whole set of commands. Individual command options take
  446. precedence over the general options.
  447. When using several characters as key to a command, the first characters
  448. are prefix commands. For the dispatcher to display useful information, you
  449. should provide a description for the prefix, like
  450. (setq org-agenda-custom-commands
  451. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  452. (\"hl\" tags \"+HOME+Lisa\")
  453. (\"hp\" tags \"+HOME+Peter\")
  454. (\"hk\" tags \"+HOME+Kim\")))"
  455. :group 'org-agenda-custom-commands
  456. :type `(repeat
  457. (choice :value ("x" "Describe command here" tags "" nil)
  458. (list :tag "Single command"
  459. (string :tag "Access Key(s) ")
  460. (option (string :tag "Description"))
  461. (choice
  462. (const :tag "Agenda" agenda)
  463. (const :tag "TODO list" alltodo)
  464. (const :tag "Search words" search)
  465. (const :tag "Stuck projects" stuck)
  466. (const :tag "Tags/Property match (all agenda files)" tags)
  467. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  468. (const :tag "TODO keyword search (all agenda files)" todo)
  469. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  470. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  471. (const :tag "Occur tree (current buffer)" occur-tree)
  472. (sexp :tag "Other, user-defined function"))
  473. (string :tag "Match (only for some commands)")
  474. ,org-agenda-custom-commands-local-options
  475. (option (repeat :tag "Export" (file :tag "Export to"))))
  476. (list :tag "Command series, all agenda files"
  477. (string :tag "Access Key(s)")
  478. (string :tag "Description ")
  479. (repeat :tag "Component"
  480. (choice
  481. (list :tag "Agenda"
  482. (const :format "" agenda)
  483. (const :tag "" :format "" "")
  484. ,org-agenda-custom-commands-local-options)
  485. (list :tag "TODO list (all keywords)"
  486. (const :format "" alltodo)
  487. (const :tag "" :format "" "")
  488. ,org-agenda-custom-commands-local-options)
  489. (list :tag "Search words"
  490. (const :format "" search)
  491. (string :tag "Match")
  492. ,org-agenda-custom-commands-local-options)
  493. (list :tag "Stuck projects"
  494. (const :format "" stuck)
  495. (const :tag "" :format "" "")
  496. ,org-agenda-custom-commands-local-options)
  497. (list :tag "Tags search"
  498. (const :format "" tags)
  499. (string :tag "Match")
  500. ,org-agenda-custom-commands-local-options)
  501. (list :tag "Tags search, TODO entries only"
  502. (const :format "" tags-todo)
  503. (string :tag "Match")
  504. ,org-agenda-custom-commands-local-options)
  505. (list :tag "TODO keyword search"
  506. (const :format "" todo)
  507. (string :tag "Match")
  508. ,org-agenda-custom-commands-local-options)
  509. (list :tag "Other, user-defined function"
  510. (symbol :tag "function")
  511. (string :tag "Match")
  512. ,org-agenda-custom-commands-local-options)))
  513. (repeat :tag "Settings for entire command set"
  514. (list (variable :tag "Any variable")
  515. (sexp :tag "Value")))
  516. (option (repeat :tag "Export" (file :tag "Export to"))))
  517. (cons :tag "Prefix key documentation"
  518. (string :tag "Access Key(s)")
  519. (string :tag "Description ")))))
  520. (defcustom org-agenda-query-register ?o
  521. "The register holding the current query string.
  522. The purpose of this is that if you construct a query string interactively,
  523. you can then use it to define a custom command."
  524. :group 'org-agenda-custom-commands
  525. :type 'character)
  526. (defcustom org-stuck-projects
  527. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  528. "How to identify stuck projects.
  529. This is a list of four items:
  530. 1. A tags/todo/property matcher string that is used to identify a project.
  531. See the manual for a description of tag and property searches.
  532. The entire tree below a headline matched by this is considered one project.
  533. 2. A list of TODO keywords identifying non-stuck projects.
  534. If the project subtree contains any headline with one of these todo
  535. keywords, the project is considered to be not stuck. If you specify
  536. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  537. 3. A list of tags identifying non-stuck projects.
  538. If the project subtree contains any headline with one of these tags,
  539. the project is considered to be not stuck. If you specify \"*\" as
  540. a tag, any tag will mark the project unstuck. Note that this is about
  541. the explicit presence of a tag somewhere in the subtree, inherited
  542. tags do not count here. If inherited tags make a project not stuck,
  543. use \"-TAG\" in the tags part of the matcher under (1.) above.
  544. 4. An arbitrary regular expression matching non-stuck projects.
  545. If the project turns out to be not stuck, search continues also in the
  546. subtree to see if any of the subtasks have project status.
  547. See also the variable `org-tags-match-list-sublevels' which applies
  548. to projects matched by this search as well.
  549. After defining this variable, you may use `org-agenda-list-stuck-projects'
  550. \(bound to `\\[org-agenda] #') to produce the list."
  551. :group 'org-agenda-custom-commands
  552. :type '(list
  553. (string :tag "Tags/TODO match to identify a project")
  554. (repeat :tag "Projects are *not* stuck if they have an entry with \
  555. TODO keyword any of" (string))
  556. (repeat :tag "Projects are *not* stuck if they have an entry with \
  557. TAG being any of" (string))
  558. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  559. the subtree")))
  560. (defgroup org-agenda-skip nil
  561. "Options concerning skipping parts of agenda files."
  562. :tag "Org Agenda Skip"
  563. :group 'org-agenda)
  564. (defcustom org-agenda-skip-function-global nil
  565. "Function to be called at each match during agenda construction.
  566. If this function returns nil, the current match should not be skipped.
  567. If the function decided to skip an agenda match, is must return the
  568. buffer position from which the search should be continued.
  569. This may also be a Lisp form, which will be evaluated.
  570. This variable will be applied to every agenda match, including
  571. tags/property searches and TODO lists. So try to make the test function
  572. do its checking as efficiently as possible. To implement a skipping
  573. condition just for specific agenda commands, use the variable
  574. `org-agenda-skip-function' which can be set in the options section
  575. of custom agenda commands."
  576. :group 'org-agenda-skip
  577. :type 'sexp)
  578. (defgroup org-agenda-daily/weekly nil
  579. "Options concerning the daily/weekly agenda."
  580. :tag "Org Agenda Daily/Weekly"
  581. :group 'org-agenda)
  582. (defgroup org-agenda-todo-list nil
  583. "Options concerning the global todo list agenda view."
  584. :tag "Org Agenda Todo List"
  585. :group 'org-agenda)
  586. (defgroup org-agenda-match-view nil
  587. "Options concerning the general tags/property/todo match agenda view."
  588. :tag "Org Agenda Match View"
  589. :group 'org-agenda)
  590. (defgroup org-agenda-search-view nil
  591. "Options concerning the search agenda view."
  592. :tag "Org Agenda Search View"
  593. :group 'org-agenda)
  594. (defvar org-agenda-archives-mode nil
  595. "Non-nil means the agenda will include archived items.
  596. If this is the symbol `trees', trees in the selected agenda scope
  597. that are marked with the ARCHIVE tag will be included anyway. When this is
  598. t, also all archive files associated with the current selection of agenda
  599. files will be included.")
  600. (defcustom org-agenda-restriction-lock-highlight-subtree t
  601. "Non-nil means highlight the whole subtree when restriction is active.
  602. Otherwise only highlight the headline. Highlighting the whole subtree is
  603. useful to ensure no edits happen beyond the restricted region."
  604. :group 'org-agenda
  605. :type 'boolean)
  606. (defcustom org-agenda-skip-comment-trees t
  607. "Non-nil means skip trees that start with the COMMENT keyword.
  608. When nil, these trees are also scanned by agenda commands."
  609. :group 'org-agenda-skip
  610. :type 'boolean)
  611. (defcustom org-agenda-todo-list-sublevels t
  612. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  613. When nil, the sublevels of a TODO entry are not checked, resulting in
  614. potentially much shorter TODO lists."
  615. :group 'org-agenda-skip
  616. :group 'org-agenda-todo-list
  617. :type 'boolean)
  618. (defcustom org-agenda-todo-ignore-with-date nil
  619. "Non-nil means don't show entries with a date in the global todo list.
  620. You can use this if you prefer to mark mere appointments with a TODO keyword,
  621. but don't want them to show up in the TODO list.
  622. When this is set, it also covers deadlines and scheduled items, the settings
  623. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  624. will be ignored.
  625. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  626. :group 'org-agenda-skip
  627. :group 'org-agenda-todo-list
  628. :type 'boolean)
  629. (defcustom org-agenda-todo-ignore-timestamp nil
  630. "Non-nil means don't show entries with a timestamp.
  631. This applies when creating the global todo list.
  632. Valid values are:
  633. past Don't show entries for today or in the past.
  634. future Don't show entries with a timestamp in the future.
  635. The idea behind this is that if it has a future
  636. timestamp, you don't want to think about it until the
  637. date.
  638. all Don't show any entries with a timestamp in the global todo list.
  639. The idea behind this is that by setting a timestamp, you
  640. have already \"taken care\" of this item.
  641. This variable can also have an integer as a value. If positive (N),
  642. todos with a timestamp N or more days in the future will be ignored. If
  643. negative (-N), todos with a timestamp N or more days in the past will be
  644. ignored. If 0, todos with a timestamp either today or in the future will
  645. be ignored. For example, a value of -1 will exclude todos with a
  646. timestamp in the past (yesterday or earlier), while a value of 7 will
  647. exclude todos with a timestamp a week or more in the future.
  648. See also `org-agenda-todo-ignore-with-date'.
  649. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  650. to make his option also apply to the tags-todo list."
  651. :group 'org-agenda-skip
  652. :group 'org-agenda-todo-list
  653. :version "24.1"
  654. :type '(choice
  655. (const :tag "Ignore future timestamp todos" future)
  656. (const :tag "Ignore past or present timestamp todos" past)
  657. (const :tag "Ignore all timestamp todos" all)
  658. (const :tag "Show timestamp todos" nil)
  659. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  660. (defcustom org-agenda-todo-ignore-scheduled nil
  661. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  662. This applies when creating the global todo list.
  663. Valid values are:
  664. past Don't show entries scheduled today or in the past.
  665. future Don't show entries scheduled in the future.
  666. The idea behind this is that by scheduling it, you don't want to
  667. think about it until the scheduled date.
  668. all Don't show any scheduled entries in the global todo list.
  669. The idea behind this is that by scheduling it, you have already
  670. \"taken care\" of this item.
  671. t Same as `all', for backward compatibility.
  672. This variable can also have an integer as a value. See
  673. `org-agenda-todo-ignore-timestamp' for more details.
  674. See also `org-agenda-todo-ignore-with-date'.
  675. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  676. to make his option also apply to the tags-todo list."
  677. :group 'org-agenda-skip
  678. :group 'org-agenda-todo-list
  679. :type '(choice
  680. (const :tag "Ignore future-scheduled todos" future)
  681. (const :tag "Ignore past- or present-scheduled todos" past)
  682. (const :tag "Ignore all scheduled todos" all)
  683. (const :tag "Ignore all scheduled todos (compatibility)" t)
  684. (const :tag "Show scheduled todos" nil)
  685. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  686. (defcustom org-agenda-todo-ignore-deadlines nil
  687. "Non-nil means ignore some deadline TODO items when making TODO list.
  688. There are different motivations for using different values, please think
  689. carefully when configuring this variable.
  690. This applies when creating the global TODO list.
  691. Valid values are:
  692. near Don't show near deadline entries. A deadline is near when it is
  693. closer than `org-deadline-warning-days' days. The idea behind this
  694. is that such items will appear in the agenda anyway.
  695. far Don't show TODO entries where a deadline has been defined, but
  696. is not going to happen anytime soon. This is useful if you want to use
  697. the TODO list to figure out what to do now.
  698. past Don't show entries with a deadline timestamp for today or in the past.
  699. future Don't show entries with a deadline timestamp in the future, not even
  700. when they become `near' ones. Use it with caution.
  701. all Ignore all TODO entries that do have a deadline.
  702. t Same as `near', for backward compatibility.
  703. This variable can also have an integer as a value. See
  704. `org-agenda-todo-ignore-timestamp' for more details.
  705. See also `org-agenda-todo-ignore-with-date'.
  706. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  707. to make his option also apply to the tags-todo list."
  708. :group 'org-agenda-skip
  709. :group 'org-agenda-todo-list
  710. :type '(choice
  711. (const :tag "Ignore near deadlines" near)
  712. (const :tag "Ignore near deadlines (compatibility)" t)
  713. (const :tag "Ignore far deadlines" far)
  714. (const :tag "Ignore all TODOs with a deadlines" all)
  715. (const :tag "Show all TODOs, even if they have a deadline" nil)
  716. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  717. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  718. "Time unit to use when possibly ignoring an agenda item.
  719. See the docstring of various `org-agenda-todo-ignore-*' options.
  720. The default is to compare time stamps using days. An item is thus
  721. considered to be in the future if it is at least one day after today.
  722. Non-nil means to compare time stamps using seconds. An item is then
  723. considered future if it has a time value later than current time."
  724. :group 'org-agenda-skip
  725. :group 'org-agenda-todo-list
  726. :version "24.4"
  727. :package-version '(Org . "8.0")
  728. :type '(choice
  729. (const :tag "Compare time with days" nil)
  730. (const :tag "Compare time with seconds" t)))
  731. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  732. "Non-nil means honor todo-list ignores options also in tags-todo search.
  733. The variables
  734. `org-agenda-todo-ignore-with-date',
  735. `org-agenda-todo-ignore-timestamp',
  736. `org-agenda-todo-ignore-scheduled',
  737. `org-agenda-todo-ignore-deadlines'
  738. make the global TODO list skip entries that have time stamps of certain
  739. kinds. If this option is set, the same options will also apply for the
  740. tags-todo search, which is the general tags/property matcher
  741. restricted to unfinished TODO entries only."
  742. :group 'org-agenda-skip
  743. :group 'org-agenda-todo-list
  744. :group 'org-agenda-match-view
  745. :type 'boolean)
  746. (defcustom org-agenda-skip-scheduled-if-done nil
  747. "Non-nil means don't show scheduled items in agenda when they are done.
  748. This is relevant for the daily/weekly agenda, not for the TODO list. It
  749. applies only to the actual date of the scheduling. Warnings about an item
  750. with a past scheduling dates are always turned off when the item is DONE."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-daily/weekly
  753. :type 'boolean)
  754. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  755. "Non-nil means skip scheduling line if same entry shows because of deadline.
  756. In the agenda of today, an entry can show up multiple times
  757. because it is both scheduled and has a nearby deadline, and maybe
  758. a plain time stamp as well.
  759. When this variable is nil, the entry will be shown several times.
  760. When set to t, then only the deadline is shown and the fact that
  761. the entry is scheduled today or was scheduled previously is not
  762. shown.
  763. When set to the symbol `not-today', skip scheduled previously,
  764. but not scheduled today.
  765. When set to the symbol `repeated-after-deadline', skip scheduled
  766. items if they are repeated beyond the current deadline."
  767. :group 'org-agenda-skip
  768. :group 'org-agenda-daily/weekly
  769. :type '(choice
  770. (const :tag "Never" nil)
  771. (const :tag "Always" t)
  772. (const :tag "Not when scheduled today" not-today)
  773. (const :tag "When repeated past deadline" repeated-after-deadline)))
  774. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  775. "Non-nil means skip timestamp line if same entry shows because of deadline.
  776. In the agenda of today, an entry can show up multiple times
  777. because it has both a plain timestamp and has a nearby deadline.
  778. When this variable is t, then only the deadline is shown and the
  779. fact that the entry has a timestamp for or including today is not
  780. shown. When this variable is nil, the entry will be shown
  781. several times."
  782. :group 'org-agenda-skip
  783. :group 'org-agenda-daily/weekly
  784. :version "24.1"
  785. :type '(choice
  786. (const :tag "Never" nil)
  787. (const :tag "Always" t)))
  788. (defcustom org-agenda-skip-deadline-if-done nil
  789. "Non-nil means don't show deadlines when the corresponding item is done.
  790. When nil, the deadline is still shown and should give you a happy feeling.
  791. This is relevant for the daily/weekly agenda. It applies only to the
  792. actual date of the deadline. Warnings about approaching and past-due
  793. deadlines are always turned off when the item is DONE."
  794. :group 'org-agenda-skip
  795. :group 'org-agenda-daily/weekly
  796. :type 'boolean)
  797. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  798. "Non-nil means skip deadline prewarning when entry is also scheduled.
  799. This will apply on all days where a prewarning for the deadline would
  800. be shown, but not at the day when the entry is actually due. On that day,
  801. the deadline will be shown anyway.
  802. This variable may be set to nil, t, the symbol `pre-scheduled',
  803. or a number which will then give the number of days before the actual
  804. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  805. eliminates the deadline prewarning only prior to the scheduled date.
  806. This can be used in a workflow where the first showing of the deadline will
  807. trigger you to schedule it, and then you don't want to be reminded of it
  808. because you will take care of it on the day when scheduled."
  809. :group 'org-agenda-skip
  810. :group 'org-agenda-daily/weekly
  811. :version "24.1"
  812. :type '(choice
  813. (const :tag "Always show prewarning" nil)
  814. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  815. (const :tag "Remove prewarning if entry is scheduled" t)
  816. (integer :tag "Restart prewarning N days before deadline")))
  817. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  818. "Non-nil means skip scheduled delay when entry also has a deadline.
  819. This variable may be set to nil, t, the symbol `post-deadline',
  820. or a number which will then give the number of days after the actual
  821. scheduled date when the delay should expire. The symbol `post-deadline'
  822. eliminates the schedule delay when the date is posterior to the deadline."
  823. :group 'org-agenda-skip
  824. :group 'org-agenda-daily/weekly
  825. :version "24.4"
  826. :package-version '(Org . "8.0")
  827. :type '(choice
  828. (const :tag "Always honor delay" nil)
  829. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  830. (const :tag "Ignore delay if entry has a deadline" t)
  831. (integer :tag "Honor delay up until N days after the scheduled date")))
  832. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  833. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  834. When non-nil, after the search for timestamps has matched once in an
  835. entry, the rest of the entry will not be searched."
  836. :group 'org-agenda-skip
  837. :type 'boolean)
  838. (defcustom org-agenda-skip-timestamp-if-done nil
  839. "Non-nil means don't select item by timestamp or -range if it is DONE."
  840. :group 'org-agenda-skip
  841. :group 'org-agenda-daily/weekly
  842. :type 'boolean)
  843. (defcustom org-agenda-dim-blocked-tasks t
  844. "Non-nil means dim blocked tasks in the agenda display.
  845. This causes some overhead during agenda construction, but if you
  846. have turned on `org-enforce-todo-dependencies',
  847. `org-enforce-todo-checkbox-dependencies', or any other blocking
  848. mechanism, this will create useful feedback in the agenda.
  849. Instead of t, this variable can also have the value `invisible'.
  850. Then blocked tasks will be invisible and only become visible when
  851. they become unblocked. An exemption to this behavior is when a task is
  852. blocked because of unchecked checkboxes below it. Since checkboxes do
  853. not show up in the agenda views, making this task invisible you remove any
  854. trace from agenda views that there is something to do. Therefore, a task
  855. that is blocked because of checkboxes will never be made invisible, it
  856. will only be dimmed."
  857. :group 'org-agenda-daily/weekly
  858. :group 'org-agenda-todo-list
  859. :version "24.3"
  860. :type '(choice
  861. (const :tag "Do not dim" nil)
  862. (const :tag "Dim to a gray face" t)
  863. (const :tag "Make invisible" invisible)))
  864. (defgroup org-agenda-startup nil
  865. "Options concerning initial settings in the Agenda in Org Mode."
  866. :tag "Org Agenda Startup"
  867. :group 'org-agenda)
  868. (defcustom org-agenda-menu-show-matcher t
  869. "Non-nil means show the match string in the agenda dispatcher menu.
  870. When nil, the matcher string is not shown, but is put into the help-echo
  871. property so than moving the mouse over the command shows it.
  872. Setting it to nil is good if matcher strings are very long and/or if
  873. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  874. :group 'org-agenda
  875. :version "24.1"
  876. :type 'boolean)
  877. (defcustom org-agenda-menu-two-columns nil
  878. "Non-nil means, use two columns to show custom commands in the dispatcher.
  879. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  880. to nil."
  881. :group 'org-agenda
  882. :version "24.1"
  883. :type 'boolean)
  884. (defcustom org-agenda-finalize-hook nil
  885. "Hook run just before displaying an agenda buffer.
  886. The buffer is still writable when the hook is called.
  887. You can modify some of the buffer substrings but you should be
  888. extra careful not to modify the text properties of the agenda
  889. headlines as the agenda display heavily relies on them."
  890. :group 'org-agenda-startup
  891. :type 'hook)
  892. (defcustom org-agenda-mouse-1-follows-link nil
  893. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  894. A longer mouse click will still set point. Needs to be set
  895. before org.el is loaded."
  896. :group 'org-agenda-startup
  897. :type 'boolean)
  898. (defcustom org-agenda-start-with-follow-mode nil
  899. "The initial value of follow mode in a newly created agenda window."
  900. :group 'org-agenda-startup
  901. :type 'boolean)
  902. (defcustom org-agenda-follow-indirect nil
  903. "Non-nil means `org-agenda-follow-mode' displays only the
  904. current item's tree, in an indirect buffer."
  905. :group 'org-agenda
  906. :version "24.1"
  907. :type 'boolean)
  908. (defcustom org-agenda-show-outline-path t
  909. "Non-nil means show outline path in echo area after line motion."
  910. :group 'org-agenda-startup
  911. :type 'boolean)
  912. (defcustom org-agenda-start-with-entry-text-mode nil
  913. "The initial value of entry-text-mode in a newly created agenda window."
  914. :group 'org-agenda-startup
  915. :type 'boolean)
  916. (defcustom org-agenda-entry-text-maxlines 5
  917. "Number of text lines to be added when `E' is pressed in the agenda.
  918. Note that this variable only used during agenda display. To add entry text
  919. when exporting the agenda, configure the variable
  920. `org-agenda-add-entry-text-maxlines'."
  921. :group 'org-agenda
  922. :type 'integer)
  923. (defcustom org-agenda-entry-text-exclude-regexps nil
  924. "List of regular expressions to clean up entry text.
  925. The complete matches of all regular expressions in this list will be
  926. removed from entry text before it is shown in the agenda."
  927. :group 'org-agenda
  928. :type '(repeat (regexp)))
  929. (defcustom org-agenda-entry-text-leaders " > "
  930. "Text prepended to the entry text in agenda buffers."
  931. :version "24.4"
  932. :package-version '(Org . "8.0")
  933. :group 'org-agenda
  934. :type 'string)
  935. (defvar org-agenda-entry-text-cleanup-hook nil
  936. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  937. This cleanup is done in a temporary buffer, so the function may inspect and
  938. change the entire buffer.
  939. Some default stuff like drawers and scheduling/deadline dates will already
  940. have been removed when this is called, as will any matches for regular
  941. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  942. (defvar org-agenda-include-inactive-timestamps nil
  943. "Non-nil means include inactive time stamps in agenda.
  944. Dynamically scoped.")
  945. (defgroup org-agenda-windows nil
  946. "Options concerning the windows used by the Agenda in Org Mode."
  947. :tag "Org Agenda Windows"
  948. :group 'org-agenda)
  949. (defcustom org-agenda-window-setup 'reorganize-frame
  950. "How the agenda buffer should be displayed.
  951. Possible values for this option are:
  952. current-window Show agenda in the current window, keeping all other windows.
  953. other-window Use `switch-to-buffer-other-window' to display agenda.
  954. only-window Show agenda, deleting all other windows.
  955. reorganize-frame Show only two windows on the current frame, the current
  956. window and the agenda.
  957. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  958. Also, when exiting the agenda, kill that frame.
  959. See also the variable `org-agenda-restore-windows-after-quit'."
  960. :group 'org-agenda-windows
  961. :type '(choice
  962. (const current-window)
  963. (const other-frame)
  964. (const other-window)
  965. (const only-window)
  966. (const reorganize-frame)))
  967. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  968. "The min and max height of the agenda window as a fraction of frame height.
  969. The value of the variable is a cons cell with two numbers between 0 and 1.
  970. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  971. :group 'org-agenda-windows
  972. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  973. (defcustom org-agenda-restore-windows-after-quit nil
  974. "Non-nil means restore window configuration upon exiting agenda.
  975. Before the window configuration is changed for displaying the agenda,
  976. the current status is recorded. When the agenda is exited with
  977. `q' or `x' and this option is set, the old state is restored. If
  978. `org-agenda-window-setup' is `other-frame', the value of this
  979. option will be ignored."
  980. :group 'org-agenda-windows
  981. :type 'boolean)
  982. (defcustom org-agenda-span 'week
  983. "Number of days to include in overview display.
  984. Can be day, week, month, year, or any number of days.
  985. Custom commands can set this variable in the options section."
  986. :group 'org-agenda-daily/weekly
  987. :type '(choice (const :tag "Day" day)
  988. (const :tag "Week" week)
  989. (const :tag "Fortnight" fortnight)
  990. (const :tag "Month" month)
  991. (const :tag "Year" year)
  992. (integer :tag "Custom")))
  993. (defcustom org-agenda-start-on-weekday 1
  994. "Non-nil means start the overview always on the specified weekday.
  995. 0 denotes Sunday, 1 denotes Monday, etc.
  996. When nil, always start on the current day.
  997. Custom commands can set this variable in the options section."
  998. :group 'org-agenda-daily/weekly
  999. :type '(choice (const :tag "Today" nil)
  1000. (integer :tag "Weekday No.")))
  1001. (defcustom org-agenda-show-all-dates t
  1002. "Non-nil means `org-agenda' shows every day in the selected range.
  1003. When nil, only the days which actually have entries are shown."
  1004. :group 'org-agenda-daily/weekly
  1005. :type 'boolean)
  1006. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1007. "Format string for displaying dates in the agenda.
  1008. Used by the daily/weekly agenda. This should be a format string
  1009. understood by `format-time-string', or a function returning the
  1010. formatted date as a string. The function must take a single
  1011. argument, a calendar-style date list like (month day year)."
  1012. :group 'org-agenda-daily/weekly
  1013. :type '(choice
  1014. (string :tag "Format string")
  1015. (function :tag "Function")))
  1016. (defun org-agenda-format-date-aligned (date)
  1017. "Format a DATE string for display in the daily/weekly agenda.
  1018. This function makes sure that dates are aligned for easy reading."
  1019. (require 'cal-iso)
  1020. (let* ((dayname (calendar-day-name date))
  1021. (day (cadr date))
  1022. (day-of-week (calendar-day-of-week date))
  1023. (month (car date))
  1024. (monthname (calendar-month-name month))
  1025. (year (nth 2 date))
  1026. (iso-week (org-days-to-iso-week
  1027. (calendar-absolute-from-gregorian date)))
  1028. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1029. (1- year))
  1030. ((and (= month 12) (<= iso-week 1))
  1031. (1+ year))
  1032. (t year)))
  1033. (weekstring (if (= day-of-week 1)
  1034. (format " W%02d" iso-week)
  1035. "")))
  1036. (format "%-10s %2d %s %4d%s"
  1037. dayname day monthname year weekstring)))
  1038. (defcustom org-agenda-time-leading-zero nil
  1039. "Non-nil means use leading zero for military times in agenda.
  1040. For example, 9:30am would become 09:30 rather than 9:30."
  1041. :group 'org-agenda-daily/weekly
  1042. :version "24.1"
  1043. :type 'boolean)
  1044. (defcustom org-agenda-timegrid-use-ampm nil
  1045. "When set, show AM/PM style timestamps on the timegrid."
  1046. :group 'org-agenda
  1047. :version "24.1"
  1048. :type 'boolean)
  1049. (defun org-agenda-time-of-day-to-ampm (time)
  1050. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1051. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1052. (minute (substring time -2))
  1053. (ampm "am"))
  1054. (cond
  1055. ((equal hour-number 12)
  1056. (setq ampm "pm"))
  1057. ((> hour-number 12)
  1058. (setq ampm "pm")
  1059. (setq hour-number (- hour-number 12))))
  1060. (concat
  1061. (if org-agenda-time-leading-zero
  1062. (format "%02d" hour-number)
  1063. (format "%02s" (number-to-string hour-number)))
  1064. ":" minute ampm)))
  1065. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1066. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1067. (if org-agenda-timegrid-use-ampm
  1068. (org-agenda-time-of-day-to-ampm time)
  1069. time))
  1070. (defcustom org-agenda-weekend-days '(6 0)
  1071. "Which days are weekend?
  1072. These days get the special face `org-agenda-date-weekend' in the agenda."
  1073. :group 'org-agenda-daily/weekly
  1074. :type '(set :greedy t
  1075. (const :tag "Monday" 1)
  1076. (const :tag "Tuesday" 2)
  1077. (const :tag "Wednesday" 3)
  1078. (const :tag "Thursday" 4)
  1079. (const :tag "Friday" 5)
  1080. (const :tag "Saturday" 6)
  1081. (const :tag "Sunday" 0)))
  1082. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1083. "Non-nil means jump to today when moving a past date forward in time.
  1084. When using S-right in the agenda to move a a date forward, and the date
  1085. stamp currently points to the past, the first key press will move it
  1086. to today. WHen nil, just move one day forward even if the date stays
  1087. in the past."
  1088. :group 'org-agenda-daily/weekly
  1089. :version "24.1"
  1090. :type 'boolean)
  1091. (defcustom org-agenda-include-diary nil
  1092. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1093. Custom commands can set this variable in the options section."
  1094. :group 'org-agenda-daily/weekly
  1095. :type 'boolean)
  1096. (defcustom org-agenda-include-deadlines t
  1097. "If non-nil, include entries within their deadline warning period.
  1098. Custom commands can set this variable in the options section."
  1099. :group 'org-agenda-daily/weekly
  1100. :version "24.1"
  1101. :type 'boolean)
  1102. (defcustom org-agenda-show-future-repeats t
  1103. "Non-nil shows repeated entries in the future part of the agenda.
  1104. When set to the symbol `next' only the first future repeat is shown."
  1105. :group 'org-agenda-daily/weekly
  1106. :type '(choice
  1107. (const :tag "Show all repeated entries" t)
  1108. (const :tag "Show next repeated entry" next)
  1109. (const :tag "Do not show repeated entries" nil))
  1110. :version "26.1"
  1111. :package-version '(Org . "9.1")
  1112. :safe #'symbolp)
  1113. (defcustom org-agenda-prefer-last-repeat nil
  1114. "Non-nil sets date for repeated entries to their last repeat.
  1115. When nil, display SCHEDULED and DEADLINE dates at their base
  1116. date, and in today's agenda, as a reminder. Display plain
  1117. time-stamps, on the other hand, at every repeat date in the past
  1118. in addition to the base date.
  1119. When non-nil, show a repeated entry at its latest repeat date,
  1120. possibly being today even if it wasn't marked as done. This
  1121. setting is useful if you do not always mark repeated entries as
  1122. done and, yet, consider that reaching repeat date starts the task
  1123. anew.
  1124. When set to a list of strings, prefer last repeats only for
  1125. entries with these TODO keywords."
  1126. :group 'org-agenda-daily/weekly
  1127. :type '(choice
  1128. (const :tag "Prefer last repeat" t)
  1129. (const :tag "Prefer base date" nil)
  1130. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1131. (string :tag "TODO keyword")))
  1132. :version "26.1"
  1133. :package-version '(Org . "9.1")
  1134. :safe (lambda (x) (or (booleanp x) (consp x))))
  1135. (defcustom org-scheduled-past-days 10000
  1136. "Number of days to continue listing scheduled items not marked DONE.
  1137. When an item is scheduled on a date, it shows up in the agenda on
  1138. this day and will be listed until it is marked done or for the
  1139. number of days given here."
  1140. :group 'org-agenda-daily/weekly
  1141. :type 'integer
  1142. :safe 'integerp)
  1143. (defcustom org-deadline-past-days 10000
  1144. "Number of days to warn about missed deadlines.
  1145. When an item has deadline on a date, it shows up in the agenda on
  1146. this day and will appear as a reminder until it is marked DONE or
  1147. for the number of days given here."
  1148. :group 'org-agenda-daily/weekly
  1149. :type 'integer
  1150. :version "26.1"
  1151. :package-version '(Org . "9.1")
  1152. :safe 'integerp)
  1153. (defcustom org-agenda-log-mode-items '(closed clock)
  1154. "List of items that should be shown in agenda log mode.
  1155. \\<org-agenda-mode-map>\
  1156. This list may contain the following symbols:
  1157. closed Show entries that have been closed on that day.
  1158. clock Show entries that have received clocked time on that day.
  1159. state Show all logged state changes.
  1160. Note that instead of changing this variable, you can also press \
  1161. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1162. the agenda to display all available LOG items temporarily."
  1163. :group 'org-agenda-daily/weekly
  1164. :type '(set :greedy t (const closed) (const clock) (const state)))
  1165. (defcustom org-agenda-clock-consistency-checks
  1166. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1167. :gap-ok-around ("4:00")
  1168. :default-face ((:background "DarkRed") (:foreground "white"))
  1169. :overlap-face nil :gap-face nil :no-end-time-face nil
  1170. :long-face nil :short-face nil)
  1171. "This is a property list, with the following keys:
  1172. :max-duration Mark clocking chunks that are longer than this time.
  1173. This is a time string like \"HH:MM\", or the number
  1174. of minutes as an integer.
  1175. :min-duration Mark clocking chunks that are shorter that this.
  1176. This is a time string like \"HH:MM\", or the number
  1177. of minutes as an integer.
  1178. :max-gap Mark gaps between clocking chunks that are longer than
  1179. this duration. A number of minutes, or a string
  1180. like \"HH:MM\".
  1181. :gap-ok-around List of times during the day which are usually not working
  1182. times. When a gap is detected, but the gap contains any
  1183. of these times, the gap is *not* reported. For example,
  1184. if this is (\"4:00\" \"13:00\") then gaps that contain
  1185. 4:00 in the morning (i.e. the night) and 13:00
  1186. (i.e. a typical lunch time) do not cause a warning.
  1187. You should have at least one time during the night in this
  1188. list, or otherwise the first task each morning will trigger
  1189. a warning because it follows a long gap.
  1190. Furthermore, the following properties can be used to define faces for
  1191. issue display.
  1192. :default-face the default face, if the specific face is undefined
  1193. :overlap-face face for overlapping clocks
  1194. :gap-face face for gaps between clocks
  1195. :no-end-time-face face for incomplete clocks
  1196. :long-face face for clock intervals that are too long
  1197. :short-face face for clock intervals that are too short"
  1198. :group 'org-agenda-daily/weekly
  1199. :group 'org-clock
  1200. :version "24.1"
  1201. :type 'plist)
  1202. (defcustom org-agenda-log-mode-add-notes t
  1203. "Non-nil means add first line of notes to log entries in agenda views.
  1204. If a log item like a state change or a clock entry is associated with
  1205. notes, the first line of these notes will be added to the entry in the
  1206. agenda display."
  1207. :group 'org-agenda-daily/weekly
  1208. :type 'boolean)
  1209. (defcustom org-agenda-start-with-log-mode nil
  1210. "The initial value of log-mode in a newly created agenda window.
  1211. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1212. explanations on the possible values."
  1213. :group 'org-agenda-startup
  1214. :group 'org-agenda-daily/weekly
  1215. :type '(choice (const :tag "Don't show log items" nil)
  1216. (const :tag "Show only log items" only)
  1217. (const :tag "Show all possible log items" clockcheck)
  1218. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1219. (choice (const :tag "Show closed log items" closed)
  1220. (const :tag "Show clocked log items" clock)
  1221. (const :tag "Show all logged state changes" state)))))
  1222. (defcustom org-agenda-start-with-clockreport-mode nil
  1223. "The initial value of clockreport-mode in a newly created agenda window."
  1224. :group 'org-agenda-startup
  1225. :group 'org-agenda-daily/weekly
  1226. :type 'boolean)
  1227. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1228. "Property list with parameters for the clocktable in clockreport mode.
  1229. This is the display mode that shows a clock table in the daily/weekly
  1230. agenda, the properties for this dynamic block can be set here.
  1231. The usual clocktable parameters are allowed here, but you cannot set
  1232. the properties :name, :tstart, :tend, :block, and :scope - these will
  1233. be overwritten to make sure the content accurately reflects the
  1234. current display in the agenda."
  1235. :group 'org-agenda-daily/weekly
  1236. :type 'plist)
  1237. (defcustom org-agenda-search-view-always-boolean nil
  1238. "Non-nil means the search string is interpreted as individual parts.
  1239. The search string for search view can either be interpreted as a phrase,
  1240. or as a list of snippets that define a boolean search for a number of
  1241. strings.
  1242. When this is non-nil, the string will be split on whitespace, and each
  1243. snippet will be searched individually, and all must match in order to
  1244. select an entry. A snippet is then a single string of non-white
  1245. characters, or a string in double quotes, or a regexp in {} braces.
  1246. If a snippet is preceded by \"-\", the snippet must *not* match.
  1247. \"+\" is syntactic sugar for positive selection. Each snippet may
  1248. be found as a full word or a partial word, but see the variable
  1249. `org-agenda-search-view-force-full-words'.
  1250. When this is nil, search will look for the entire search phrase as one,
  1251. with each space character matching any amount of whitespace, including
  1252. line breaks.
  1253. Even when this is nil, you can still switch to Boolean search dynamically
  1254. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1255. is a regexp marked with braces like \"{abc}\", this will also switch to
  1256. boolean search."
  1257. :group 'org-agenda-search-view
  1258. :version "24.1"
  1259. :type 'boolean)
  1260. (defvaralias 'org-agenda-search-view-search-words-only
  1261. 'org-agenda-search-view-always-boolean)
  1262. (defcustom org-agenda-search-view-force-full-words nil
  1263. "Non-nil means, search words must be matches as complete words.
  1264. When nil, they may also match part of a word."
  1265. :group 'org-agenda-search-view
  1266. :version "24.1"
  1267. :type 'boolean)
  1268. (defcustom org-agenda-search-view-max-outline-level 0
  1269. "Maximum outline level to display in search view.
  1270. E.g. when this is set to 1, the search view will only
  1271. show headlines of level 1. When set to 0, the default
  1272. value, don't limit agenda view by outline level."
  1273. :group 'org-agenda-search-view
  1274. :version "26.1"
  1275. :package-version '(Org . "8.3")
  1276. :type 'integer)
  1277. (defgroup org-agenda-time-grid nil
  1278. "Options concerning the time grid in the Org Agenda."
  1279. :tag "Org Agenda Time Grid"
  1280. :group 'org-agenda)
  1281. (defcustom org-agenda-search-headline-for-time t
  1282. "Non-nil means search headline for a time-of-day.
  1283. If the headline contains a time-of-day in one format or another, it will
  1284. be used to sort the entry into the time sequence of items for a day.
  1285. Some people have time stamps in the headline that refer to the creation
  1286. time or so, and then this produces an unwanted side effect. If this is
  1287. the case for your, use this variable to turn off searching the headline
  1288. for a time."
  1289. :group 'org-agenda-time-grid
  1290. :type 'boolean)
  1291. (defcustom org-agenda-use-time-grid t
  1292. "Non-nil means show a time grid in the agenda schedule.
  1293. A time grid is a set of lines for specific times (like every two hours between
  1294. 8:00 and 20:00). The items scheduled for a day at specific times are
  1295. sorted in between these lines.
  1296. For details about when the grid will be shown, and what it will look like, see
  1297. the variable `org-agenda-time-grid'."
  1298. :group 'org-agenda-time-grid
  1299. :type 'boolean)
  1300. (defcustom org-agenda-time-grid
  1301. '((daily today require-timed)
  1302. (800 1000 1200 1400 1600 1800 2000)
  1303. "......"
  1304. "----------------")
  1305. "The settings for time grid for agenda display.
  1306. This is a list of four items. The first item is again a list. It contains
  1307. symbols specifying conditions when the grid should be displayed:
  1308. daily if the agenda shows a single day
  1309. weekly if the agenda shows an entire week
  1310. today show grid on current date, independent of daily/weekly display
  1311. require-timed show grid only if at least one item has a time specification
  1312. remove-match skip grid times already present in an entry
  1313. The second item is a list of integers, indicating the times that
  1314. should have a grid line.
  1315. The third item is a string which will be placed right after the
  1316. times that have a grid line.
  1317. The fourth item is a string placed after the grid times. This
  1318. will align with agenda items"
  1319. :group 'org-agenda-time-grid
  1320. :type
  1321. '(list
  1322. (set :greedy t :tag "Grid Display Options"
  1323. (const :tag "Show grid in single day agenda display" daily)
  1324. (const :tag "Show grid in weekly agenda display" weekly)
  1325. (const :tag "Always show grid for today" today)
  1326. (const :tag "Show grid only if any timed entries are present"
  1327. require-timed)
  1328. (const :tag "Skip grid times already present in an entry"
  1329. remove-match))
  1330. (repeat :tag "Grid Times" (integer :tag "Time"))
  1331. (string :tag "Grid String (after agenda times)")
  1332. (string :tag "Grid String (aligns with agenda items)")))
  1333. (defcustom org-agenda-show-current-time-in-grid t
  1334. "Non-nil means show the current time in the time grid."
  1335. :group 'org-agenda-time-grid
  1336. :version "24.1"
  1337. :type 'boolean)
  1338. (defcustom org-agenda-current-time-string
  1339. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1340. "The string for the current time marker in the agenda."
  1341. :group 'org-agenda-time-grid
  1342. :version "24.1"
  1343. :type 'string)
  1344. (defgroup org-agenda-sorting nil
  1345. "Options concerning sorting in the Org Agenda."
  1346. :tag "Org Agenda Sorting"
  1347. :group 'org-agenda)
  1348. (defcustom org-agenda-sorting-strategy
  1349. '((agenda habit-down time-up priority-down category-keep)
  1350. (todo priority-down category-keep)
  1351. (tags priority-down category-keep)
  1352. (search category-keep))
  1353. "Sorting structure for the agenda items of a single day.
  1354. This is a list of symbols which will be used in sequence to determine
  1355. if an entry should be listed before another entry. The following
  1356. symbols are recognized:
  1357. time-up Put entries with time-of-day indications first, early first
  1358. time-down Put entries with time-of-day indications first, late first
  1359. timestamp-up Sort by any timestamp, early first
  1360. timestamp-down Sort by any timestamp, late first
  1361. scheduled-up Sort by scheduled timestamp, early first
  1362. scheduled-down Sort by scheduled timestamp, late first
  1363. deadline-up Sort by deadline timestamp, early first
  1364. deadline-down Sort by deadline timestamp, late first
  1365. ts-up Sort by active timestamp, early first
  1366. ts-down Sort by active timestamp, late first
  1367. tsia-up Sort by inactive timestamp, early first
  1368. tsia-down Sort by inactive timestamp, late first
  1369. category-keep Keep the default order of categories, corresponding to the
  1370. sequence in `org-agenda-files'.
  1371. category-up Sort alphabetically by category, A-Z.
  1372. category-down Sort alphabetically by category, Z-A.
  1373. tag-up Sort alphabetically by last tag, A-Z.
  1374. tag-down Sort alphabetically by last tag, Z-A.
  1375. priority-up Sort numerically by priority, high priority last.
  1376. priority-down Sort numerically by priority, high priority first.
  1377. todo-state-up Sort by todo state, tasks that are done last.
  1378. todo-state-down Sort by todo state, tasks that are done first.
  1379. effort-up Sort numerically by estimated effort, high effort last.
  1380. effort-down Sort numerically by estimated effort, high effort first.
  1381. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1382. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1383. habit-up Put entries that are habits first
  1384. habit-down Put entries that are habits last
  1385. alpha-up Sort headlines alphabetically
  1386. alpha-down Sort headlines alphabetically, reversed
  1387. The different possibilities will be tried in sequence, and testing stops
  1388. if one comparison returns a \"not-equal\". For example, the default
  1389. '(time-up category-keep priority-down)
  1390. means: Pull out all entries having a specified time of day and sort them,
  1391. in order to make a time schedule for the current day the first thing in the
  1392. agenda listing for the day. Of the entries without a time indication, keep
  1393. the grouped in categories, don't sort the categories, but keep them in
  1394. the sequence given in `org-agenda-files'. Within each category sort by
  1395. priority.
  1396. Leaving out `category-keep' would mean that items will be sorted across
  1397. categories by priority.
  1398. Instead of a single list, this can also be a set of list for specific
  1399. contents, with a context symbol in the car of the list, any of
  1400. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1401. Custom commands can bind this variable in the options section."
  1402. :group 'org-agenda-sorting
  1403. :type `(choice
  1404. (repeat :tag "General" ,org-sorting-choice)
  1405. (list :tag "Individually"
  1406. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1407. (repeat ,org-sorting-choice))
  1408. (cons (const :tag "Strategy for TODO lists" todo)
  1409. (repeat ,org-sorting-choice))
  1410. (cons (const :tag "Strategy for Tags matches" tags)
  1411. (repeat ,org-sorting-choice))
  1412. (cons (const :tag "Strategy for search matches" search)
  1413. (repeat ,org-sorting-choice)))))
  1414. (defcustom org-agenda-cmp-user-defined nil
  1415. "A function to define the comparison `user-defined'.
  1416. This function must receive two arguments, agenda entry a and b.
  1417. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1418. the user comparison, return nil.
  1419. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1420. part of an agenda sorting strategy."
  1421. :group 'org-agenda-sorting
  1422. :type 'symbol)
  1423. (defcustom org-sort-agenda-notime-is-late t
  1424. "Non-nil means items without time are considered late.
  1425. This is only relevant for sorting. When t, items which have no explicit
  1426. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1427. do have a time. When nil, the default time is before 0:00. You can use this
  1428. option to decide if the schedule for today should come before or after timeless
  1429. agenda entries."
  1430. :group 'org-agenda-sorting
  1431. :type 'boolean)
  1432. (defcustom org-sort-agenda-noeffort-is-high t
  1433. "Non-nil means items without effort estimate are sorted as high effort.
  1434. This also applies when filtering an agenda view with respect to the
  1435. < or > effort operator. Then, tasks with no effort defined will be treated
  1436. as tasks with high effort.
  1437. When nil, such items are sorted as 0 minutes effort."
  1438. :group 'org-agenda-sorting
  1439. :type 'boolean)
  1440. (defgroup org-agenda-line-format nil
  1441. "Options concerning the entry prefix in the Org agenda display."
  1442. :tag "Org Agenda Line Format"
  1443. :group 'org-agenda)
  1444. (defcustom org-agenda-prefix-format
  1445. '((agenda . " %i %-12:c%?-12t% s")
  1446. (todo . " %i %-12:c")
  1447. (tags . " %i %-12:c")
  1448. (search . " %i %-12:c"))
  1449. "Format specifications for the prefix of items in the agenda views.
  1450. An alist with one entry per agenda type. The keys of the
  1451. sublists are `agenda', `todo', `search' and `tags'. The values
  1452. are format strings.
  1453. This format works similar to a printf format, with the following meaning:
  1454. %c the category of the item, \"Diary\" for entries from the diary,
  1455. or as given by the CATEGORY keyword or derived from the file name
  1456. %e the effort required by the item
  1457. %l the level of the item (insert X space(s) if item is of level X)
  1458. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1459. %T the last tag of the item (ignore inherited tags, which come first)
  1460. %t the HH:MM time-of-day specification if one applies to the entry
  1461. %s Scheduling/Deadline information, a short string
  1462. %b show breadcrumbs, i.e., the names of the higher levels
  1463. %(expression) Eval EXPRESSION and replace the control string
  1464. by the result
  1465. All specifiers work basically like the standard `%s' of printf, but may
  1466. contain two additional characters: a question mark just after the `%'
  1467. and a whitespace/punctuation character just before the final letter.
  1468. If the first character after `%' is a question mark, the entire field
  1469. will only be included if the corresponding value applies to the current
  1470. entry. This is useful for fields which should have fixed width when
  1471. present, but zero width when absent. For example, \"%?-12t\" will
  1472. result in a 12 character time field if a time of the day is specified,
  1473. but will completely disappear in entries which do not contain a time.
  1474. If there is punctuation or whitespace character just before the
  1475. final format letter, this character will be appended to the field
  1476. value if the value is not empty. For example, the format
  1477. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1478. the category is empty, no additional colon is inserted.
  1479. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1480. which means:
  1481. - Indent the line with two space characters
  1482. - Give the category a 12 chars wide field, padded with whitespace on
  1483. the right (because of `-'). Append a colon if there is a category
  1484. (because of `:').
  1485. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1486. time, don't put in an empty field, just skip it (because of '?').
  1487. - Finally, put the scheduling information.
  1488. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1489. `org-agenda-remove-tags'.
  1490. Custom commands can set this variable in the options section."
  1491. :type '(choice
  1492. (string :tag "General format")
  1493. (list :greedy t :tag "View dependent"
  1494. (cons (const agenda) (string :tag "Format"))
  1495. (cons (const todo) (string :tag "Format"))
  1496. (cons (const tags) (string :tag "Format"))
  1497. (cons (const search) (string :tag "Format"))))
  1498. :group 'org-agenda-line-format
  1499. :version "26.1"
  1500. :package-version '(Org . "9.1"))
  1501. (defvar org-prefix-format-compiled nil
  1502. "The compiled prefix format and associated variables.
  1503. This is a list where first element is a list of variable bindings, and second
  1504. element is the compiled format expression. See the variable
  1505. `org-agenda-prefix-format'.")
  1506. (defcustom org-agenda-todo-keyword-format "%-1s"
  1507. "Format for the TODO keyword in agenda lines.
  1508. Set this to something like \"%-12s\" if you want all TODO keywords
  1509. to occupy a fixed space in the agenda display."
  1510. :group 'org-agenda-line-format
  1511. :type 'string)
  1512. (defcustom org-agenda-diary-sexp-prefix nil
  1513. "A regexp that matches part of a diary sexp entry
  1514. which should be treated as scheduling/deadline information in
  1515. `org-agenda'.
  1516. For example, you can use this to extract the `diary-remind-message' from
  1517. `diary-remind' entries."
  1518. :group 'org-agenda-line-format
  1519. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1520. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1521. "Text preceding timerange entries in the agenda view.
  1522. This is a list with two strings. The first applies when the range
  1523. is entirely on one day. The second applies if the range spans several days.
  1524. The strings may have two \"%d\" format specifiers which will be filled
  1525. with the sequence number of the days, and the total number of days in the
  1526. range, respectively."
  1527. :group 'org-agenda-line-format
  1528. :type '(list
  1529. (string :tag "Deadline today ")
  1530. (choice :tag "Deadline relative"
  1531. (string :tag "Format string")
  1532. (function))))
  1533. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1534. "Text preceding scheduled items in the agenda view.
  1535. This is a list with two strings. The first applies when the item is
  1536. scheduled on the current day. The second applies when it has been scheduled
  1537. previously, it may contain a %d indicating that this is the nth time that
  1538. this item is scheduled, due to automatic rescheduling of unfinished items
  1539. for the following day. So this number is one larger than the number of days
  1540. that passed since this item was scheduled first."
  1541. :group 'org-agenda-line-format
  1542. :version "24.4"
  1543. :package-version '(Org . "8.0")
  1544. :type '(list
  1545. (string :tag "Scheduled today ")
  1546. (string :tag "Scheduled previously")))
  1547. (defcustom org-agenda-inactive-leader "["
  1548. "Text preceding item pulled into the agenda by inactive time stamps.
  1549. These entries are added to the agenda when pressing \"[\"."
  1550. :group 'org-agenda-line-format
  1551. :version "24.1"
  1552. :type 'string)
  1553. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1554. "Text preceding deadline items in the agenda view.
  1555. This is a list with three strings. The first applies when the item has its
  1556. deadline on the current day. The second applies when the deadline is in the
  1557. future, the third one when it is in the past. The strings may contain %d
  1558. to capture the number of days."
  1559. :group 'org-agenda-line-format
  1560. :version "24.4"
  1561. :package-version '(Org . "8.0")
  1562. :type '(list
  1563. (string :tag "Deadline today ")
  1564. (string :tag "Deadline in the future ")
  1565. (string :tag "Deadline in the past ")))
  1566. (defcustom org-agenda-remove-times-when-in-prefix t
  1567. "Non-nil means remove duplicate time specifications in agenda items.
  1568. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1569. time-of-day specification in a headline or diary entry is extracted and
  1570. placed into the prefix. If this option is non-nil, the original specification
  1571. \(a timestamp or -range, or just a plain time(range) specification like
  1572. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1573. cluttered.
  1574. The option can be t or nil. It may also be the symbol `beg', indicating
  1575. that the time should only be removed when it is located at the beginning of
  1576. the headline/diary entry."
  1577. :group 'org-agenda-line-format
  1578. :type '(choice
  1579. (const :tag "Always" t)
  1580. (const :tag "Never" nil)
  1581. (const :tag "When at beginning of entry" beg)))
  1582. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1583. "Non-nil means remove time ranges specifications in agenda
  1584. items that span on several days."
  1585. :group 'org-agenda-line-format
  1586. :version "24.1"
  1587. :type 'boolean)
  1588. (defcustom org-agenda-default-appointment-duration nil
  1589. "Default duration for appointments that only have a starting time.
  1590. When nil, no duration is specified in such cases.
  1591. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1592. :group 'org-agenda-line-format
  1593. :type '(choice
  1594. (integer :tag "Minutes")
  1595. (const :tag "No default duration")))
  1596. (defcustom org-agenda-show-inherited-tags t
  1597. "Non-nil means show inherited tags in each agenda line.
  1598. When this option is set to `always', it takes precedence over
  1599. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1600. in every agenda.
  1601. When this option is set to t (the default), inherited tags are
  1602. shown when they are available, i.e. when the value of
  1603. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1604. given agenda type.
  1605. This can be set to a list of agenda types in which the agenda
  1606. must display the inherited tags. Available types are `todo',
  1607. `agenda' and `search'.
  1608. When set to nil, never show inherited tags in agenda lines."
  1609. :group 'org-agenda-line-format
  1610. :group 'org-agenda
  1611. :version "24.3"
  1612. :type '(choice
  1613. (const :tag "Show inherited tags when available" t)
  1614. (const :tag "Always show inherited tags" always)
  1615. (repeat :tag "Show inherited tags only in selected agenda types"
  1616. (symbol :tag "Agenda type"))))
  1617. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1618. "List of agenda view types where to use tag inheritance.
  1619. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1620. controlled by `org-use-tag-inheritance'. In other agenda types,
  1621. `org-use-tag-inheritance' is not used for the selection of the
  1622. agenda entries. Still, you may want the agenda to be aware of
  1623. the inherited tags anyway, e.g. for later tag filtering.
  1624. Allowed value are `todo', `search' and `agenda'.
  1625. This variable has no effect if `org-agenda-show-inherited-tags'
  1626. is set to `always'. In that case, the agenda is aware of those
  1627. tags.
  1628. The default value sets tags in every agenda type. Setting this
  1629. option to nil will speed up non-tags agenda view a lot."
  1630. :group 'org-agenda
  1631. :version "26.1"
  1632. :package-version '(Org . "9.1")
  1633. :type '(choice
  1634. (const :tag "Use tag inheritance in all agenda types" t)
  1635. (repeat :tag "Use tag inheritance in selected agenda types"
  1636. (symbol :tag "Agenda type"))))
  1637. (defcustom org-agenda-hide-tags-regexp nil
  1638. "Regular expression used to filter away specific tags in agenda views.
  1639. This means that these tags will be present, but not be shown in the agenda
  1640. line. Secondary filtering will still work on the hidden tags.
  1641. Nil means don't hide any tags."
  1642. :group 'org-agenda-line-format
  1643. :type '(choice
  1644. (const :tag "Hide none" nil)
  1645. (string :tag "Regexp ")))
  1646. (defcustom org-agenda-remove-tags nil
  1647. "Non-nil means remove the tags from the headline copy in the agenda.
  1648. When this is the symbol `prefix', only remove tags when
  1649. `org-agenda-prefix-format' contains a `%T' specifier."
  1650. :group 'org-agenda-line-format
  1651. :type '(choice
  1652. (const :tag "Always" t)
  1653. (const :tag "Never" nil)
  1654. (const :tag "When prefix format contains %T" prefix)))
  1655. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1656. 'org-agenda-remove-tags)
  1657. (defcustom org-agenda-tags-column 'auto
  1658. "Shift tags in agenda items to this column.
  1659. If set to `auto', tags will be automatically aligned to the right
  1660. edge of the window.
  1661. If set to a positive number, tags will be left-aligned to that
  1662. column. If set to a negative number, tags will be right-aligned
  1663. to that column. For example, -80 works well for a normal 80
  1664. character screen."
  1665. :group 'org-agenda-line-format
  1666. :type '(choice
  1667. (const :tag "Automatically align to right edge of window" auto)
  1668. (integer :tag "Specific column" -80))
  1669. :package-version '(Org . "9.1")
  1670. :version "26.1")
  1671. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1672. (defcustom org-agenda-fontify-priorities 'cookies
  1673. "Non-nil means highlight low and high priorities in agenda.
  1674. When t, the highest priority entries are bold, lowest priority italic.
  1675. However, settings in `org-priority-faces' will overrule these faces.
  1676. When this variable is the symbol `cookies', only fontify the
  1677. cookies, not the entire task.
  1678. This may also be an association list of priority faces, whose
  1679. keys are the character values of `org-highest-priority',
  1680. `org-default-priority', and `org-lowest-priority' (the default values
  1681. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1682. color as a string, or a list like `(:background \"Red\")'.
  1683. If it is a color, the variable `org-faces-easy-properties'
  1684. determines if it is a foreground or a background color."
  1685. :group 'org-agenda-line-format
  1686. :type '(choice
  1687. (const :tag "Never" nil)
  1688. (const :tag "Defaults" t)
  1689. (const :tag "Cookies only" cookies)
  1690. (repeat :tag "Specify"
  1691. (list (character :tag "Priority" :value ?A)
  1692. (choice :tag "Face "
  1693. (string :tag "Color")
  1694. (sexp :tag "Face"))))))
  1695. (defcustom org-agenda-day-face-function nil
  1696. "Function called to determine what face should be used to display a day.
  1697. The only argument passed to that function is the day. It should
  1698. returns a face, or nil if does not want to specify a face and let
  1699. the normal rules apply."
  1700. :group 'org-agenda-line-format
  1701. :version "24.1"
  1702. :type '(choice (const nil) (function)))
  1703. (defcustom org-agenda-category-icon-alist nil
  1704. "Alist of category icon to be displayed in agenda views.
  1705. Each entry should have the following format:
  1706. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1707. Where CATEGORY-REGEXP is a regexp matching the categories where
  1708. the icon should be displayed.
  1709. FILE-OR-DATA either a file path or a string containing image data.
  1710. The other fields can be omitted safely if not needed:
  1711. TYPE indicates the image type.
  1712. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1713. image data.
  1714. PROPS are additional image attributes to assign to the image,
  1715. like, e.g. `:ascent center'.
  1716. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1717. If you want to set the display properties yourself, just put a
  1718. list as second element:
  1719. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1720. For example, to display a 16px horizontal space for Emacs
  1721. category, you can use:
  1722. (\"Emacs\" \\='(space . (:width (16))))"
  1723. :group 'org-agenda-line-format
  1724. :version "24.1"
  1725. :type '(alist :key-type (string :tag "Regexp matching category")
  1726. :value-type (choice (list :tag "Icon"
  1727. (string :tag "File or data")
  1728. (symbol :tag "Type")
  1729. (boolean :tag "Data?")
  1730. (repeat :tag "Extra image properties" :inline t symbol))
  1731. (list :tag "Display properties" sexp))))
  1732. (defgroup org-agenda-column-view nil
  1733. "Options concerning column view in the agenda."
  1734. :tag "Org Agenda Column View"
  1735. :group 'org-agenda)
  1736. (defcustom org-agenda-view-columns-initially nil
  1737. "When non-nil, switch to columns view right after creating the agenda."
  1738. :group 'org-agenda-column-view
  1739. :type 'boolean
  1740. :version "26.1"
  1741. :package-version '(Org . "9.0")
  1742. :safe #'booleanp)
  1743. (defcustom org-agenda-columns-show-summaries t
  1744. "Non-nil means show summaries for columns displayed in the agenda view."
  1745. :group 'org-agenda-column-view
  1746. :type 'boolean)
  1747. (defcustom org-agenda-columns-compute-summary-properties t
  1748. "Non-nil means recompute all summary properties before column view.
  1749. When column view in the agenda is listing properties that have a summary
  1750. operator, it can go to all relevant buffers and recompute the summaries
  1751. there. This can mean overhead for the agenda column view, but is necessary
  1752. to have thing up to date.
  1753. As a special case, a CLOCKSUM property also makes sure that the clock
  1754. computations are current."
  1755. :group 'org-agenda-column-view
  1756. :type 'boolean)
  1757. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1758. "Non-nil means the duration of an appointment will add to day effort.
  1759. The property to which appointment durations will be added is the one given
  1760. in the option `org-effort-property'. If an appointment does not have
  1761. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1762. is not set, an appointment without end time will not contribute to the time
  1763. estimate."
  1764. :group 'org-agenda-column-view
  1765. :type 'boolean)
  1766. (defcustom org-agenda-auto-exclude-function nil
  1767. "A function called with a tag to decide if it is filtered on \
  1768. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1769. The sole argument to the function, which is called once for each
  1770. possible tag, is a string giving the name of the tag. The
  1771. function should return either nil if the tag should be included
  1772. as normal, or \"-<TAG>\" to exclude the tag.
  1773. Note that for the purpose of tag filtering, only the lower-case version of
  1774. all tags will be considered, so that this function will only ever see
  1775. the lower-case version of all tags."
  1776. :group 'org-agenda
  1777. :type '(choice (const nil) (function)))
  1778. (defcustom org-agenda-bulk-custom-functions nil
  1779. "Alist of characters and custom functions for bulk actions.
  1780. For example, this value makes those two functions available:
  1781. \\='((?R set-category)
  1782. (?C bulk-cut))
  1783. With selected entries in an agenda buffer, `B R' will call
  1784. the custom function `set-category' on the selected entries.
  1785. Note that functions in this alist don't need to be quoted."
  1786. :type '(alist :key-type character :value-type (group function))
  1787. :version "24.1"
  1788. :group 'org-agenda)
  1789. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1790. "Execute BODY with point at location given by `org-hd-marker' property.
  1791. If STRING is non-nil, the text property will be fetched from position 0
  1792. in that string. If STRING is nil, it will be fetched from the beginning
  1793. of the current line."
  1794. (org-with-gensyms (marker)
  1795. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1796. 'org-hd-marker ,string)))
  1797. (with-current-buffer (marker-buffer ,marker)
  1798. (save-excursion
  1799. (goto-char ,marker)
  1800. ,@body)))))
  1801. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1802. (defun org-add-agenda-custom-command (entry)
  1803. "Replace or add a command in `org-agenda-custom-commands'.
  1804. This is mostly for hacking and trying a new command - once the command
  1805. works you probably want to add it to `org-agenda-custom-commands' for good."
  1806. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1807. (if ass
  1808. (setcdr ass (cdr entry))
  1809. (push entry org-agenda-custom-commands))))
  1810. (defmacro org-agenda--insert-overriding-header (default)
  1811. "Insert header into agenda view.
  1812. The inserted header depends on `org-agenda-overriding-header'.
  1813. If the empty string, don't insert a header. If any other string,
  1814. insert it as a header. If nil, insert DEFAULT, which should
  1815. evaluate to a string."
  1816. (declare (debug (form)) (indent defun))
  1817. `(cond
  1818. ((not org-agenda-overriding-header) (insert ,default))
  1819. ((equal org-agenda-overriding-header "") nil)
  1820. ((stringp org-agenda-overriding-header)
  1821. (insert (propertize org-agenda-overriding-header
  1822. 'face 'org-agenda-structure)
  1823. "\n"))
  1824. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1825. org-agenda-overriding-header))))
  1826. ;;; Define the org-agenda-mode
  1827. (defvar org-agenda-mode-map (make-sparse-keymap)
  1828. "Keymap for `org-agenda-mode'.")
  1829. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1830. (defvar org-agenda-menu) ; defined later in this file.
  1831. (defvar org-agenda-restrict nil) ; defined later in this file.
  1832. (defvar org-agenda-follow-mode nil)
  1833. (defvar org-agenda-entry-text-mode nil)
  1834. (defvar org-agenda-clockreport-mode nil)
  1835. (defvar org-agenda-show-log nil
  1836. "When non-nil, show the log in the agenda.
  1837. Do not set this directly; instead use
  1838. `org-agenda-start-with-log-mode', which see.")
  1839. (defvar org-agenda-redo-command nil)
  1840. (defvar org-agenda-query-string nil)
  1841. (defvar org-agenda-mode-hook nil
  1842. "Hook run after `org-agenda-mode' is turned on.
  1843. The buffer is still writable when this hook is called.")
  1844. (defvar org-agenda-type nil)
  1845. (defvar org-agenda-force-single-file nil)
  1846. (defvar org-agenda-bulk-marked-entries nil
  1847. "List of markers that refer to marked entries in the agenda.")
  1848. (defvar org-agenda-current-date nil
  1849. "Active date when building the agenda.")
  1850. ;;; Multiple agenda buffers support
  1851. (defcustom org-agenda-sticky nil
  1852. "Non-nil means agenda q key will bury agenda buffers.
  1853. Agenda commands will then show existing buffer instead of generating new ones.
  1854. When nil, `q' will kill the single agenda buffer."
  1855. :group 'org-agenda
  1856. :version "24.3"
  1857. :type 'boolean)
  1858. ;;;###autoload
  1859. (defun org-toggle-sticky-agenda (&optional arg)
  1860. "Toggle `org-agenda-sticky'."
  1861. (interactive "P")
  1862. (let ((new-value (if arg
  1863. (> (prefix-numeric-value arg) 0)
  1864. (not org-agenda-sticky))))
  1865. (if (equal new-value org-agenda-sticky)
  1866. (and (called-interactively-p 'interactive)
  1867. (message "Sticky agenda was already %s"
  1868. (if org-agenda-sticky "enabled" "disabled")))
  1869. (setq org-agenda-sticky new-value)
  1870. (org-agenda-kill-all-agenda-buffers)
  1871. (and (called-interactively-p 'interactive)
  1872. (message "Sticky agenda %s"
  1873. (if org-agenda-sticky "enabled" "disabled"))))))
  1874. (defvar org-agenda-buffer nil
  1875. "Agenda buffer currently being generated.")
  1876. (defvar org-agenda-last-prefix-arg nil)
  1877. (defvar org-agenda-this-buffer-name nil)
  1878. (defvar org-agenda-doing-sticky-redo nil)
  1879. (defvar org-agenda-this-buffer-is-sticky nil)
  1880. (defvar org-agenda-last-indirect-buffer nil
  1881. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1882. (defconst org-agenda-local-vars
  1883. '(org-agenda-this-buffer-name
  1884. org-agenda-undo-list
  1885. org-agenda-pending-undo-list
  1886. org-agenda-follow-mode
  1887. org-agenda-entry-text-mode
  1888. org-agenda-clockreport-mode
  1889. org-agenda-show-log
  1890. org-agenda-redo-command
  1891. org-agenda-query-string
  1892. org-agenda-type
  1893. org-agenda-bulk-marked-entries
  1894. org-agenda-undo-has-started-in
  1895. org-agenda-info
  1896. org-agenda-pre-window-conf
  1897. org-agenda-columns-active
  1898. org-agenda-tag-filter
  1899. org-agenda-category-filter
  1900. org-agenda-top-headline-filter
  1901. org-agenda-regexp-filter
  1902. org-agenda-effort-filter
  1903. org-agenda-markers
  1904. org-agenda-last-search-view-search-was-boolean
  1905. org-agenda-last-indirect-buffer
  1906. org-agenda-filtered-by-category
  1907. org-agenda-filter-form
  1908. org-agenda-cycle-counter
  1909. org-agenda-last-prefix-arg)
  1910. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1911. (defun org-agenda-mode ()
  1912. "Mode for time-sorted view on action items in Org files.
  1913. The following commands are available:
  1914. \\{org-agenda-mode-map}"
  1915. (interactive)
  1916. (cond (org-agenda-doing-sticky-redo
  1917. ;; Refreshing sticky agenda-buffer
  1918. ;;
  1919. ;; Preserve the value of `org-agenda-local-vars' variables,
  1920. ;; while letting `kill-all-local-variables' kill the rest
  1921. (let ((save (buffer-local-variables)))
  1922. (kill-all-local-variables)
  1923. (mapc #'make-local-variable org-agenda-local-vars)
  1924. (dolist (elem save)
  1925. (pcase elem
  1926. (`(,var . ,val) ;ignore unbound variables
  1927. (when (and val (memq var org-agenda-local-vars))
  1928. (set var val))))))
  1929. (setq-local org-agenda-this-buffer-is-sticky t))
  1930. (org-agenda-sticky
  1931. ;; Creating a sticky Agenda buffer for the first time
  1932. (kill-all-local-variables)
  1933. (mapc 'make-local-variable org-agenda-local-vars)
  1934. (setq-local org-agenda-this-buffer-is-sticky t))
  1935. (t
  1936. ;; Creating a non-sticky agenda buffer
  1937. (kill-all-local-variables)
  1938. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1939. (setq org-agenda-undo-list nil
  1940. org-agenda-pending-undo-list nil
  1941. org-agenda-bulk-marked-entries nil)
  1942. (setq major-mode 'org-agenda-mode)
  1943. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1944. (setq-local font-lock-global-modes (list 'not major-mode))
  1945. (setq mode-name "Org-Agenda")
  1946. (setq indent-tabs-mode nil)
  1947. (use-local-map org-agenda-mode-map)
  1948. (easy-menu-add org-agenda-menu)
  1949. (if org-startup-truncated (setq truncate-lines t))
  1950. (setq-local line-move-visual nil)
  1951. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1952. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1953. ;; Make sure properties are removed when copying text
  1954. (add-hook 'filter-buffer-substring-functions
  1955. (lambda (fun start end delete)
  1956. (substring-no-properties (funcall fun start end delete)))
  1957. nil t)
  1958. (unless org-agenda-keep-modes
  1959. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1960. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1961. org-agenda-show-log org-agenda-start-with-log-mode
  1962. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  1963. (add-to-invisibility-spec '(org-filtered))
  1964. (add-to-invisibility-spec '(org-link))
  1965. (easy-menu-change
  1966. '("Agenda") "Agenda Files"
  1967. (append
  1968. (list
  1969. (vector
  1970. (if (get 'org-agenda-files 'org-restrict)
  1971. "Restricted to single file"
  1972. "Edit File List")
  1973. '(org-edit-agenda-file-list)
  1974. (not (get 'org-agenda-files 'org-restrict)))
  1975. "--")
  1976. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1977. (org-agenda-set-mode-name)
  1978. (apply
  1979. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1980. (list 'org-agenda-mode-hook)))
  1981. (substitute-key-definition 'undo 'org-agenda-undo
  1982. org-agenda-mode-map global-map)
  1983. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1984. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1985. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1986. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1987. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1988. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1989. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1990. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1991. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1992. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1993. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1994. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1995. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1996. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1997. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1998. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1999. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2000. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2001. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2002. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2003. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2004. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2005. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2006. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2007. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2008. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2009. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2010. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2011. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2012. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2013. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2014. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2015. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2016. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2017. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2018. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2019. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2020. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2021. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2022. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2023. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2024. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2025. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2026. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2027. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2028. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2029. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2030. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2031. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2032. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2033. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2034. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2035. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2036. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2037. (while l (org-defkey org-agenda-mode-map
  2038. (int-to-string (pop l)) 'digit-argument)))
  2039. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2040. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2041. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2042. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2043. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2044. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2045. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2046. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2047. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2048. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2049. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2050. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2051. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2052. 'org-clock-modify-effort-estimate)
  2053. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2054. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2055. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2056. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2057. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2058. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2059. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2060. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2061. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2062. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2063. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2064. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2065. (substitute-key-definition 'next-line 'org-agenda-next-line
  2066. org-agenda-mode-map global-map)
  2067. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2068. org-agenda-mode-map global-map)
  2069. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2070. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2071. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2072. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2073. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2074. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2075. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2076. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2077. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2078. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2079. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2080. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2081. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2082. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2083. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2084. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2085. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2086. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2087. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2088. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2089. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2090. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2091. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2092. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2093. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2094. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2095. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2096. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2097. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2098. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2099. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2100. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2101. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2102. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2103. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2104. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2105. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2106. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2107. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2108. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2109. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2110. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2111. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2112. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2113. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2114. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2115. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2116. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2117. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2118. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2119. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2120. (when org-agenda-mouse-1-follows-link
  2121. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2122. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2123. '("Agenda"
  2124. ("Agenda Files")
  2125. "--"
  2126. ("Agenda Dates"
  2127. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2128. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2129. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2130. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2131. "--"
  2132. ("View"
  2133. ["Day View" org-agenda-day-view
  2134. :active (org-agenda-check-type nil 'agenda)
  2135. :style radio :selected (eq org-agenda-current-span 'day)
  2136. :keys "v d (or just d)"]
  2137. ["Week View" org-agenda-week-view
  2138. :active (org-agenda-check-type nil 'agenda)
  2139. :style radio :selected (eq org-agenda-current-span 'week)
  2140. :keys "v w"]
  2141. ["Fortnight View" org-agenda-fortnight-view
  2142. :active (org-agenda-check-type nil 'agenda)
  2143. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2144. :keys "v t"]
  2145. ["Month View" org-agenda-month-view
  2146. :active (org-agenda-check-type nil 'agenda)
  2147. :style radio :selected (eq org-agenda-current-span 'month)
  2148. :keys "v m"]
  2149. ["Year View" org-agenda-year-view
  2150. :active (org-agenda-check-type nil 'agenda)
  2151. :style radio :selected (eq org-agenda-current-span 'year)
  2152. :keys "v y"]
  2153. "--"
  2154. ["Include Diary" org-agenda-toggle-diary
  2155. :style toggle :selected org-agenda-include-diary
  2156. :active (org-agenda-check-type nil 'agenda)]
  2157. ["Include Deadlines" org-agenda-toggle-deadlines
  2158. :style toggle :selected org-agenda-include-deadlines
  2159. :active (org-agenda-check-type nil 'agenda)]
  2160. ["Use Time Grid" org-agenda-toggle-time-grid
  2161. :style toggle :selected org-agenda-use-time-grid
  2162. :active (org-agenda-check-type nil 'agenda)]
  2163. "--"
  2164. ["Show clock report" org-agenda-clockreport-mode
  2165. :style toggle :selected org-agenda-clockreport-mode
  2166. :active (org-agenda-check-type nil 'agenda)]
  2167. ["Show some entry text" org-agenda-entry-text-mode
  2168. :style toggle :selected org-agenda-entry-text-mode
  2169. :active t]
  2170. "--"
  2171. ["Show Logbook entries" org-agenda-log-mode
  2172. :style toggle :selected org-agenda-show-log
  2173. :active (org-agenda-check-type nil 'agenda)
  2174. :keys "v l (or just l)"]
  2175. ["Include archived trees" org-agenda-archives-mode
  2176. :style toggle :selected org-agenda-archives-mode :active t
  2177. :keys "v a"]
  2178. ["Include archive files" (org-agenda-archives-mode t)
  2179. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2180. :keys "v A"]
  2181. "--"
  2182. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2183. ["Write view to file" org-agenda-write t]
  2184. ["Rebuild buffer" org-agenda-redo t]
  2185. ["Save all Org buffers" org-save-all-org-buffers t]
  2186. "--"
  2187. ["Show original entry" org-agenda-show t]
  2188. ["Go To (other window)" org-agenda-goto t]
  2189. ["Go To (this window)" org-agenda-switch-to t]
  2190. ["Capture with cursor date" org-agenda-capture t]
  2191. ["Follow Mode" org-agenda-follow-mode
  2192. :style toggle :selected org-agenda-follow-mode :active t]
  2193. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2194. "--"
  2195. ("TODO"
  2196. ["Cycle TODO" org-agenda-todo t]
  2197. ["Next TODO set" org-agenda-todo-nextset t]
  2198. ["Previous TODO set" org-agenda-todo-previousset t]
  2199. ["Add note" org-agenda-add-note t])
  2200. ("Archive/Refile/Delete"
  2201. ["Archive default" org-agenda-archive-default t]
  2202. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2203. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2204. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2205. ["Archive subtree" org-agenda-archive t]
  2206. "--"
  2207. ["Refile" org-agenda-refile t]
  2208. "--"
  2209. ["Delete subtree" org-agenda-kill t])
  2210. ("Bulk action"
  2211. ["Mark entry" org-agenda-bulk-mark t]
  2212. ["Mark all" org-agenda-bulk-mark-all t]
  2213. ["Unmark entry" org-agenda-bulk-unmark t]
  2214. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2215. ["Toggle mark" org-agenda-bulk-toggle t]
  2216. ["Toggle all" org-agenda-bulk-toggle-all t]
  2217. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2218. ["Act on all marked" org-agenda-bulk-action t]
  2219. "--"
  2220. ("Tags and Properties"
  2221. ["Show all Tags" org-agenda-show-tags t]
  2222. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2223. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2224. "--"
  2225. ["Column View" org-columns t])
  2226. ("Deadline/Schedule"
  2227. ["Schedule" org-agenda-schedule t]
  2228. ["Set Deadline" org-agenda-deadline t]
  2229. "--"
  2230. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2231. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2232. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2233. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2234. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2235. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2236. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2237. ("Clock and Effort"
  2238. ["Clock in" org-agenda-clock-in t]
  2239. ["Clock out" org-agenda-clock-out t]
  2240. ["Clock cancel" org-agenda-clock-cancel t]
  2241. ["Goto running clock" org-clock-goto t]
  2242. "--"
  2243. ["Set Effort" org-agenda-set-effort t]
  2244. ["Change clocked effort" org-clock-modify-effort-estimate
  2245. (org-clock-is-active)])
  2246. ("Priority"
  2247. ["Set Priority" org-agenda-priority t]
  2248. ["Increase Priority" org-agenda-priority-up t]
  2249. ["Decrease Priority" org-agenda-priority-down t]
  2250. ["Show Priority" org-show-priority t])
  2251. ("Calendar/Diary"
  2252. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2253. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2254. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2255. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2256. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2257. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2258. "--"
  2259. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2260. "--"
  2261. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2262. "--"
  2263. ("MobileOrg"
  2264. ["Push Files and Views" org-mobile-push t]
  2265. ["Get Captured and Flagged" org-mobile-pull t]
  2266. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2267. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2268. "--"
  2269. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2270. "--"
  2271. ["Quit" org-agenda-quit t]
  2272. ["Exit and Release Buffers" org-agenda-exit t]
  2273. ))
  2274. ;;; Agenda undo
  2275. (defvar org-agenda-allow-remote-undo t
  2276. "Non-nil means allow remote undo from the agenda buffer.")
  2277. (defvar org-agenda-undo-has-started-in nil
  2278. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2279. (defun org-agenda-undo ()
  2280. "Undo a remote editing step in the agenda.
  2281. This undoes changes both in the agenda buffer and in the remote buffer
  2282. that have been changed along."
  2283. (interactive)
  2284. (or org-agenda-allow-remote-undo
  2285. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2286. (if (not (eq this-command last-command))
  2287. (setq org-agenda-undo-has-started-in nil
  2288. org-agenda-pending-undo-list org-agenda-undo-list))
  2289. (if (not org-agenda-pending-undo-list)
  2290. (user-error "No further undo information"))
  2291. (let* ((entry (pop org-agenda-pending-undo-list))
  2292. buf line cmd rembuf)
  2293. (setq cmd (pop entry) line (pop entry))
  2294. (setq rembuf (nth 2 entry))
  2295. (org-with-remote-undo rembuf
  2296. (while (bufferp (setq buf (pop entry)))
  2297. (if (pop entry)
  2298. (with-current-buffer buf
  2299. (let ((last-undo-buffer buf)
  2300. (inhibit-read-only t))
  2301. (unless (memq buf org-agenda-undo-has-started-in)
  2302. (push buf org-agenda-undo-has-started-in)
  2303. (make-local-variable 'pending-undo-list)
  2304. (undo-start))
  2305. (while (and pending-undo-list
  2306. (listp pending-undo-list)
  2307. (not (car pending-undo-list)))
  2308. (pop pending-undo-list))
  2309. (undo-more 1))))))
  2310. (org-goto-line line)
  2311. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2312. (defun org-verify-change-for-undo (l1 l2)
  2313. "Verify that a real change occurred between the undo lists L1 and L2."
  2314. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2315. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2316. (not (eq l1 l2)))
  2317. ;;; Agenda dispatch
  2318. (defvar org-agenda-restrict-begin (make-marker))
  2319. (defvar org-agenda-restrict-end (make-marker))
  2320. (defvar org-agenda-last-dispatch-buffer nil)
  2321. (defvar org-agenda-overriding-restriction nil)
  2322. (defcustom org-agenda-custom-commands-contexts nil
  2323. "Alist of custom agenda keys and contextual rules.
  2324. For example, if you have a custom agenda command \"p\" and you
  2325. want this command to be accessible only from plain text files,
  2326. use this:
  2327. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2328. Here are the available contexts definitions:
  2329. in-file: command displayed only in matching files
  2330. in-mode: command displayed only in matching modes
  2331. not-in-file: command not displayed in matching files
  2332. not-in-mode: command not displayed in matching modes
  2333. in-buffer: command displayed only in matching buffers
  2334. not-in-buffer: command not displayed in matching buffers
  2335. [function]: a custom function taking no argument
  2336. If you define several checks, the agenda command will be
  2337. accessible if there is at least one valid check.
  2338. You can also bind a key to another agenda custom command
  2339. depending on contextual rules.
  2340. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2341. Here it means: in .txt files, use \"p\" as the key for the
  2342. agenda command otherwise associated with \"q\". (The command
  2343. originally associated with \"q\" is not displayed to avoid
  2344. duplicates.)"
  2345. :version "24.3"
  2346. :group 'org-agenda-custom-commands
  2347. :type '(repeat (list :tag "Rule"
  2348. (string :tag " Agenda key")
  2349. (string :tag "Replace by command")
  2350. (repeat :tag "Available when"
  2351. (choice
  2352. (cons :tag "Condition"
  2353. (choice
  2354. (const :tag "In file" in-file)
  2355. (const :tag "Not in file" not-in-file)
  2356. (const :tag "In buffer" in-buffer)
  2357. (const :tag "Not in buffer" not-in-buffer)
  2358. (const :tag "In mode" in-mode)
  2359. (const :tag "Not in mode" not-in-mode))
  2360. (regexp))
  2361. (function :tag "Custom function"))))))
  2362. (defcustom org-agenda-max-entries nil
  2363. "Maximum number of entries to display in an agenda.
  2364. This can be nil (no limit) or an integer or an alist of agenda
  2365. types with an associated number of entries to display in this
  2366. type."
  2367. :version "24.4"
  2368. :package-version '(Org . "8.0")
  2369. :group 'org-agenda-custom-commands
  2370. :type '(choice (symbol :tag "No limit" nil)
  2371. (integer :tag "Max number of entries")
  2372. (repeat
  2373. (cons (choice :tag "Agenda type"
  2374. (const agenda)
  2375. (const todo)
  2376. (const tags)
  2377. (const search))
  2378. (integer :tag "Max number of entries")))))
  2379. (defcustom org-agenda-max-todos nil
  2380. "Maximum number of TODOs to display in an agenda.
  2381. This can be nil (no limit) or an integer or an alist of agenda
  2382. types with an associated number of entries to display in this
  2383. type."
  2384. :version "24.4"
  2385. :package-version '(Org . "8.0")
  2386. :group 'org-agenda-custom-commands
  2387. :type '(choice (symbol :tag "No limit" nil)
  2388. (integer :tag "Max number of TODOs")
  2389. (repeat
  2390. (cons (choice :tag "Agenda type"
  2391. (const agenda)
  2392. (const todo)
  2393. (const tags)
  2394. (const search))
  2395. (integer :tag "Max number of TODOs")))))
  2396. (defcustom org-agenda-max-tags nil
  2397. "Maximum number of tagged entries to display in an agenda.
  2398. This can be nil (no limit) or an integer or an alist of agenda
  2399. types with an associated number of entries to display in this
  2400. type."
  2401. :version "24.4"
  2402. :package-version '(Org . "8.0")
  2403. :group 'org-agenda-custom-commands
  2404. :type '(choice (symbol :tag "No limit" nil)
  2405. (integer :tag "Max number of tagged entries")
  2406. (repeat
  2407. (cons (choice :tag "Agenda type"
  2408. (const agenda)
  2409. (const todo)
  2410. (const tags)
  2411. (const search))
  2412. (integer :tag "Max number of tagged entries")))))
  2413. (defcustom org-agenda-max-effort nil
  2414. "Maximum cumulated effort duration for the agenda.
  2415. This can be nil (no limit) or a number of minutes (as an integer)
  2416. or an alist of agenda types with an associated number of minutes
  2417. to limit entries to in this type."
  2418. :version "24.4"
  2419. :package-version '(Org . "8.0")
  2420. :group 'org-agenda-custom-commands
  2421. :type '(choice (symbol :tag "No limit" nil)
  2422. (integer :tag "Max number of minutes")
  2423. (repeat
  2424. (cons (choice :tag "Agenda type"
  2425. (const agenda)
  2426. (const todo)
  2427. (const tags)
  2428. (const search))
  2429. (integer :tag "Max number of minutes")))))
  2430. (defvar org-agenda-keep-restricted-file-list nil)
  2431. (defvar org-keys nil)
  2432. (defvar org-match nil)
  2433. ;;;###autoload
  2434. (defun org-agenda (&optional arg org-keys restriction)
  2435. "Dispatch agenda commands to collect entries to the agenda buffer.
  2436. Prompts for a command to execute. Any prefix arg will be passed
  2437. on to the selected command. The default selections are:
  2438. a Call `org-agenda-list' to display the agenda for current day or week.
  2439. t Call `org-todo-list' to display the global todo list.
  2440. T Call `org-todo-list' to display the global todo list, select only
  2441. entries with a specific TODO keyword (the user gets a prompt).
  2442. m Call `org-tags-view' to display headlines with tags matching
  2443. a condition (the user is prompted for the condition).
  2444. M Like `m', but select only TODO entries, no ordinary headlines.
  2445. e Export views to associated files.
  2446. s Search entries for keywords.
  2447. S Search entries for keywords, only with TODO keywords.
  2448. / Multi occur across all agenda files and also files listed
  2449. in `org-agenda-text-search-extra-files'.
  2450. < Restrict agenda commands to buffer, subtree, or region.
  2451. Press several times to get the desired effect.
  2452. > Remove a previous restriction.
  2453. # List \"stuck\" projects.
  2454. ! Configure what \"stuck\" means.
  2455. C Configure custom agenda commands.
  2456. More commands can be added by configuring the variable
  2457. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2458. searches can be pre-defined in this way.
  2459. If the current buffer is in Org mode and visiting a file, you can also
  2460. first press `<' once to indicate that the agenda should be temporarily
  2461. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2462. Pressing `<' twice means to restrict to the current subtree or region
  2463. \(if active)."
  2464. (interactive "P")
  2465. (catch 'exit
  2466. (let* ((prefix-descriptions nil)
  2467. (org-agenda-buffer-name org-agenda-buffer-name)
  2468. (org-agenda-window-setup (if (equal (buffer-name)
  2469. org-agenda-buffer-name)
  2470. 'current-window
  2471. org-agenda-window-setup))
  2472. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2473. (org-agenda-custom-commands
  2474. ;; normalize different versions
  2475. (delq nil
  2476. (mapcar
  2477. (lambda (x)
  2478. (cond ((stringp (cdr x))
  2479. (push x prefix-descriptions)
  2480. nil)
  2481. ((stringp (nth 1 x)) x)
  2482. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2483. (t (cons (car x) (cons "" (cdr x))))))
  2484. org-agenda-custom-commands)))
  2485. (org-agenda-custom-commands
  2486. (org-contextualize-keys
  2487. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2488. (buf (current-buffer))
  2489. (bfn (buffer-file-name (buffer-base-buffer)))
  2490. entry key type org-match lprops ans)
  2491. ;; Turn off restriction unless there is an overriding one,
  2492. (unless org-agenda-overriding-restriction
  2493. (unless org-agenda-keep-restricted-file-list
  2494. ;; There is a request to keep the file list in place
  2495. (put 'org-agenda-files 'org-restrict nil))
  2496. (setq org-agenda-restrict nil)
  2497. (move-marker org-agenda-restrict-begin nil)
  2498. (move-marker org-agenda-restrict-end nil))
  2499. ;; Delete old local properties
  2500. (put 'org-agenda-redo-command 'org-lprops nil)
  2501. ;; Delete previously set last-arguments
  2502. (put 'org-agenda-redo-command 'last-args nil)
  2503. ;; Remember where this call originated
  2504. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2505. (unless org-keys
  2506. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2507. org-keys (car ans)
  2508. restriction (cdr ans)))
  2509. ;; If we have sticky agenda buffers, set a name for the buffer,
  2510. ;; depending on the invoking keys. The user may still set this
  2511. ;; as a command option, which will overwrite what we do here.
  2512. (if org-agenda-sticky
  2513. (setq org-agenda-buffer-name
  2514. (format "*Org Agenda(%s)*" org-keys)))
  2515. ;; Establish the restriction, if any
  2516. (when (and (not org-agenda-overriding-restriction) restriction)
  2517. (put 'org-agenda-files 'org-restrict (list bfn))
  2518. (cond
  2519. ((eq restriction 'region)
  2520. (setq org-agenda-restrict (current-buffer))
  2521. (move-marker org-agenda-restrict-begin (region-beginning))
  2522. (move-marker org-agenda-restrict-end (region-end)))
  2523. ((eq restriction 'subtree)
  2524. (save-excursion
  2525. (setq org-agenda-restrict (current-buffer))
  2526. (org-back-to-heading t)
  2527. (move-marker org-agenda-restrict-begin (point))
  2528. (move-marker org-agenda-restrict-end
  2529. (progn (org-end-of-subtree t)))))))
  2530. ;; For example the todo list should not need it (but does...)
  2531. (cond
  2532. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2533. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2534. (progn
  2535. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2536. lprops (nth 4 entry))
  2537. (if org-agenda-sticky
  2538. (setq org-agenda-buffer-name
  2539. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2540. (format "*Org Agenda(%s)*" org-keys))))
  2541. (put 'org-agenda-redo-command 'org-lprops lprops)
  2542. (cond
  2543. ((eq type 'agenda)
  2544. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2545. ((eq type 'agenda*)
  2546. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2547. ((eq type 'alltodo)
  2548. (org-let lprops '(org-todo-list current-prefix-arg)))
  2549. ((eq type 'search)
  2550. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2551. ((eq type 'stuck)
  2552. (org-let lprops '(org-agenda-list-stuck-projects
  2553. current-prefix-arg)))
  2554. ((eq type 'tags)
  2555. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2556. ((eq type 'tags-todo)
  2557. (org-let lprops '(org-tags-view '(4) org-match)))
  2558. ((eq type 'todo)
  2559. (org-let lprops '(org-todo-list org-match)))
  2560. ((eq type 'tags-tree)
  2561. (org-check-for-org-mode)
  2562. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2563. ((eq type 'todo-tree)
  2564. (org-check-for-org-mode)
  2565. (org-let lprops
  2566. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2567. (regexp-quote org-match) "\\>"))))
  2568. ((eq type 'occur-tree)
  2569. (org-check-for-org-mode)
  2570. (org-let lprops '(org-occur org-match)))
  2571. ((functionp type)
  2572. (org-let lprops '(funcall type org-match)))
  2573. ((fboundp type)
  2574. (org-let lprops '(funcall type org-match)))
  2575. (t (user-error "Invalid custom agenda command type %s" type))))
  2576. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2577. ((equal org-keys "C")
  2578. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2579. (customize-variable 'org-agenda-custom-commands))
  2580. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2581. ((equal org-keys "s") (call-interactively 'org-search-view))
  2582. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2583. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2584. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2585. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2586. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2587. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2588. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2589. (add-hook
  2590. 'post-command-hook
  2591. (lambda ()
  2592. (unless (current-message)
  2593. (let* ((m (org-agenda-get-any-marker))
  2594. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2595. (when note
  2596. (message (concat
  2597. "FLAGGING-NOTE ([?] for more info): "
  2598. (org-add-props
  2599. (replace-regexp-in-string
  2600. "\\\\n" "//"
  2601. (copy-sequence note))
  2602. nil 'face 'org-warning)))))))
  2603. t t))
  2604. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2605. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2606. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2607. (t (user-error "Invalid agenda key"))))))
  2608. (defvar org-agenda-multi)
  2609. (defun org-agenda-append-agenda ()
  2610. "Append another agenda view to the current one.
  2611. This function allows interactive building of block agendas.
  2612. Agenda views are separated by `org-agenda-block-separator'."
  2613. (interactive)
  2614. (unless (derived-mode-p 'org-agenda-mode)
  2615. (user-error "Can only append from within agenda buffer"))
  2616. (let ((org-agenda-multi t))
  2617. (org-agenda)
  2618. (widen)
  2619. (org-agenda-finalize)
  2620. (setq buffer-read-only t)
  2621. (org-agenda-fit-window-to-buffer)))
  2622. (defun org-agenda-normalize-custom-commands (cmds)
  2623. "Normalize custom commands CMDS."
  2624. (delq nil
  2625. (mapcar
  2626. (lambda (x)
  2627. (cond ((stringp (cdr x)) nil)
  2628. ((stringp (nth 1 x)) x)
  2629. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2630. (t (cons (car x) (cons "" (cdr x))))))
  2631. cmds)))
  2632. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2633. "The user interface for selecting an agenda command."
  2634. (catch 'exit
  2635. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2636. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2637. (region-p (org-region-active-p))
  2638. (custom org-agenda-custom-commands)
  2639. (selstring "")
  2640. restriction second-time
  2641. c entry key type match prefixes rmheader header-end custom1 desc
  2642. line lines left right n n1)
  2643. (save-window-excursion
  2644. (delete-other-windows)
  2645. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2646. (erase-buffer)
  2647. (insert (eval-when-compile
  2648. (let ((header
  2649. "Press key for an agenda command:
  2650. -------------------------------- < Buffer, subtree/region restriction
  2651. a Agenda for current week or day > Remove restriction
  2652. t List of all TODO entries e Export agenda views
  2653. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2654. s Search for keywords M Like m, but only TODO entries
  2655. / Multi-occur S Like s, but only TODO entries
  2656. ? Find :FLAGGED: entries C Configure custom agenda commands
  2657. * Toggle sticky agenda views # List stuck projects (!=configure)
  2658. ")
  2659. (start 0))
  2660. (while (string-match
  2661. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2662. header start)
  2663. (setq start (match-end 0))
  2664. (add-text-properties (match-beginning 2) (match-end 2)
  2665. '(face bold) header))
  2666. header)))
  2667. (setq header-end (point-marker))
  2668. (while t
  2669. (setq custom1 custom)
  2670. (when (eq rmheader t)
  2671. (org-goto-line 1)
  2672. (re-search-forward ":" nil t)
  2673. (delete-region (match-end 0) (point-at-eol))
  2674. (forward-char 1)
  2675. (looking-at "-+")
  2676. (delete-region (match-end 0) (point-at-eol))
  2677. (move-marker header-end (match-end 0)))
  2678. (goto-char header-end)
  2679. (delete-region (point) (point-max))
  2680. ;; Produce all the lines that describe custom commands and prefixes
  2681. (setq lines nil)
  2682. (while (setq entry (pop custom1))
  2683. (setq key (car entry) desc (nth 1 entry)
  2684. type (nth 2 entry)
  2685. match (nth 3 entry))
  2686. (if (> (length key) 1)
  2687. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2688. (setq line
  2689. (format
  2690. "%-4s%-14s"
  2691. (org-add-props (copy-sequence key)
  2692. '(face bold))
  2693. (cond
  2694. ((string-match "\\S-" desc) desc)
  2695. ((eq type 'agenda) "Agenda for current week or day")
  2696. ((eq type 'agenda*) "Appointments for current week or day")
  2697. ((eq type 'alltodo) "List of all TODO entries")
  2698. ((eq type 'search) "Word search")
  2699. ((eq type 'stuck) "List of stuck projects")
  2700. ((eq type 'todo) "TODO keyword")
  2701. ((eq type 'tags) "Tags query")
  2702. ((eq type 'tags-todo) "Tags (TODO)")
  2703. ((eq type 'tags-tree) "Tags tree")
  2704. ((eq type 'todo-tree) "TODO kwd tree")
  2705. ((eq type 'occur-tree) "Occur tree")
  2706. ((functionp type) (if (symbolp type)
  2707. (symbol-name type)
  2708. "Lambda expression"))
  2709. (t "???"))))
  2710. (if org-agenda-menu-show-matcher
  2711. (setq line
  2712. (concat line ": "
  2713. (cond
  2714. ((stringp match)
  2715. (setq match (copy-sequence match))
  2716. (org-add-props match nil 'face 'org-warning))
  2717. ((listp type)
  2718. (format "set of %d commands" (length type))))))
  2719. (if (org-string-nw-p match)
  2720. (add-text-properties
  2721. 0 (length line) (list 'help-echo
  2722. (concat "Matcher: " match)) line)))
  2723. (push line lines)))
  2724. (setq lines (nreverse lines))
  2725. (when prefixes
  2726. (mapc (lambda (x)
  2727. (push
  2728. (format "%s %s"
  2729. (org-add-props (char-to-string x)
  2730. nil 'face 'bold)
  2731. (or (cdr (assoc (concat selstring
  2732. (char-to-string x))
  2733. prefix-descriptions))
  2734. "Prefix key"))
  2735. lines))
  2736. prefixes))
  2737. ;; Check if we should display in two columns
  2738. (if org-agenda-menu-two-columns
  2739. (progn
  2740. (setq n (length lines)
  2741. n1 (+ (/ n 2) (mod n 2))
  2742. right (nthcdr n1 lines)
  2743. left (copy-sequence lines))
  2744. (setcdr (nthcdr (1- n1) left) nil))
  2745. (setq left lines right nil))
  2746. (while left
  2747. (insert "\n" (pop left))
  2748. (when right
  2749. (if (< (current-column) 40)
  2750. (move-to-column 40 t)
  2751. (insert " "))
  2752. (insert (pop right))))
  2753. ;; Make the window the right size
  2754. (goto-char (point-min))
  2755. (if second-time
  2756. (if (not (pos-visible-in-window-p (point-max)))
  2757. (org-fit-window-to-buffer))
  2758. (setq second-time t)
  2759. (org-fit-window-to-buffer))
  2760. ;; Ask for selection
  2761. (message "Press key for agenda command%s:"
  2762. (if (or restrict-ok org-agenda-overriding-restriction)
  2763. (if org-agenda-overriding-restriction
  2764. " (restriction lock active)"
  2765. (if restriction
  2766. (format " (restricted to %s)" restriction)
  2767. " (unrestricted)"))
  2768. ""))
  2769. (setq c (read-char-exclusive))
  2770. (message "")
  2771. (cond
  2772. ((assoc (char-to-string c) custom)
  2773. (setq selstring (concat selstring (char-to-string c)))
  2774. (throw 'exit (cons selstring restriction)))
  2775. ((memq c prefixes)
  2776. (setq selstring (concat selstring (char-to-string c))
  2777. prefixes nil
  2778. rmheader (or rmheader t)
  2779. custom (delq nil (mapcar
  2780. (lambda (x)
  2781. (if (or (= (length (car x)) 1)
  2782. (/= (string-to-char (car x)) c))
  2783. nil
  2784. (cons (substring (car x) 1) (cdr x))))
  2785. custom))))
  2786. ((eq c ?*)
  2787. (call-interactively 'org-toggle-sticky-agenda)
  2788. (sit-for 2))
  2789. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2790. (message "Restriction is only possible in Org buffers")
  2791. (ding) (sit-for 1))
  2792. ((eq c ?1)
  2793. (org-agenda-remove-restriction-lock 'noupdate)
  2794. (setq restriction 'buffer))
  2795. ((eq c ?0)
  2796. (org-agenda-remove-restriction-lock 'noupdate)
  2797. (setq restriction (if region-p 'region 'subtree)))
  2798. ((eq c ?<)
  2799. (org-agenda-remove-restriction-lock 'noupdate)
  2800. (setq restriction
  2801. (cond
  2802. ((eq restriction 'buffer)
  2803. (if region-p 'region 'subtree))
  2804. ((memq restriction '(subtree region))
  2805. nil)
  2806. (t 'buffer))))
  2807. ((eq c ?>)
  2808. (org-agenda-remove-restriction-lock 'noupdate)
  2809. (setq restriction nil))
  2810. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2811. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2812. ((and (> (length selstring) 0) (eq c ?\d))
  2813. (delete-window)
  2814. (org-agenda-get-restriction-and-command prefix-descriptions))
  2815. ((equal c ?q) (error "Abort"))
  2816. (t (user-error "Invalid key %c" c))))))))
  2817. (defun org-agenda-fit-window-to-buffer ()
  2818. "Fit the window to the buffer size."
  2819. (and (memq org-agenda-window-setup '(reorganize-frame))
  2820. (fboundp 'fit-window-to-buffer)
  2821. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2822. (= (car org-agenda-window-frame-fractions) 1.0))
  2823. (delete-other-windows)
  2824. (org-fit-window-to-buffer
  2825. nil
  2826. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2827. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2828. (defvar org-cmd nil)
  2829. (defvar org-agenda-overriding-cmd nil)
  2830. (defvar org-agenda-overriding-arguments nil)
  2831. (defvar org-agenda-overriding-cmd-arguments nil)
  2832. (defun org-agenda-run-series (name series)
  2833. "Run agenda NAME as a SERIES of agenda commands."
  2834. (org-let (nth 1 series) '(org-agenda-prepare name))
  2835. ;; We need to reset agenda markers here, because when constructing a
  2836. ;; block agenda, the individual blocks do not do that.
  2837. (org-agenda-reset-markers)
  2838. (let* ((org-agenda-multi t)
  2839. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2840. (cmds (car series))
  2841. (gprops (nth 1 series))
  2842. match ;; The byte compiler incorrectly complains about this. Keep it!
  2843. org-cmd type lprops)
  2844. (while (setq org-cmd (pop cmds))
  2845. (setq type (car org-cmd))
  2846. (setq match (eval (nth 1 org-cmd)))
  2847. (setq lprops (nth 2 org-cmd))
  2848. (let ((org-agenda-overriding-arguments
  2849. (if (eq org-agenda-overriding-cmd org-cmd)
  2850. (or org-agenda-overriding-arguments
  2851. org-agenda-overriding-cmd-arguments))))
  2852. (cond
  2853. ((eq type 'agenda)
  2854. (org-let2 gprops lprops
  2855. '(call-interactively 'org-agenda-list)))
  2856. ((eq type 'agenda*)
  2857. (org-let2 gprops lprops
  2858. '(funcall 'org-agenda-list nil nil t)))
  2859. ((eq type 'alltodo)
  2860. (org-let2 gprops lprops
  2861. '(call-interactively 'org-todo-list)))
  2862. ((eq type 'search)
  2863. (org-let2 gprops lprops
  2864. '(org-search-view current-prefix-arg match nil)))
  2865. ((eq type 'stuck)
  2866. (org-let2 gprops lprops
  2867. '(call-interactively 'org-agenda-list-stuck-projects)))
  2868. ((eq type 'tags)
  2869. (org-let2 gprops lprops
  2870. '(org-tags-view current-prefix-arg match)))
  2871. ((eq type 'tags-todo)
  2872. (org-let2 gprops lprops
  2873. '(org-tags-view '(4) match)))
  2874. ((eq type 'todo)
  2875. (org-let2 gprops lprops
  2876. '(org-todo-list match)))
  2877. ((fboundp type)
  2878. (org-let2 gprops lprops
  2879. '(funcall type match)))
  2880. (t (error "Invalid type in command series")))))
  2881. (widen)
  2882. (let ((inhibit-read-only t))
  2883. (add-text-properties (point-min) (point-max)
  2884. `(org-series t org-series-redo-cmd ,redo)))
  2885. (setq org-agenda-redo-command redo)
  2886. (goto-char (point-min)))
  2887. (org-agenda-fit-window-to-buffer)
  2888. (org-let (nth 1 series) '(org-agenda-finalize)))
  2889. ;;;###autoload
  2890. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2891. "Run an agenda command in batch mode and send the result to STDOUT.
  2892. If CMD-KEY is a string of length 1, it is used as a key in
  2893. `org-agenda-custom-commands' and triggers this command. If it is a
  2894. longer string it is used as a tags/todo match string.
  2895. Parameters are alternating variable names and values that will be bound
  2896. before running the agenda command."
  2897. (org-eval-in-environment (org-make-parameter-alist parameters)
  2898. (let (org-agenda-sticky)
  2899. (if (> (length cmd-key) 1)
  2900. (org-tags-view nil cmd-key)
  2901. (org-agenda nil cmd-key))))
  2902. (set-buffer org-agenda-buffer-name)
  2903. (princ (buffer-string)))
  2904. (defvar org-agenda-info nil)
  2905. ;;;###autoload
  2906. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2907. "Run an agenda command in batch mode and send the result to STDOUT.
  2908. If CMD-KEY is a string of length 1, it is used as a key in
  2909. `org-agenda-custom-commands' and triggers this command. If it is a
  2910. longer string it is used as a tags/todo match string.
  2911. Parameters are alternating variable names and values that will be bound
  2912. before running the agenda command.
  2913. The output gives a line for each selected agenda item. Each
  2914. item is a list of comma-separated values, like this:
  2915. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2916. category The category of the item
  2917. head The headline, without TODO kwd, TAGS and PRIORITY
  2918. type The type of the agenda entry, can be
  2919. todo selected in TODO match
  2920. tagsmatch selected in tags match
  2921. diary imported from diary
  2922. deadline a deadline on given date
  2923. scheduled scheduled on given date
  2924. timestamp entry has timestamp on given date
  2925. closed entry was closed on given date
  2926. upcoming-deadline warning about deadline
  2927. past-scheduled forwarded scheduled item
  2928. block entry has date block including g. date
  2929. todo The todo keyword, if any
  2930. tags All tags including inherited ones, separated by colons
  2931. date The relevant date, like 2007-2-14
  2932. time The time, like 15:00-16:50
  2933. extra Sting with extra planning info
  2934. priority-l The priority letter if any was given
  2935. priority-n The computed numerical priority
  2936. agenda-day The day in the agenda where this is listed"
  2937. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2938. (org-make-parameter-alist parameters))
  2939. (if (> (length cmd-key) 2)
  2940. (org-tags-view nil cmd-key)
  2941. (org-agenda nil cmd-key)))
  2942. (set-buffer org-agenda-buffer-name)
  2943. (let* ((lines (org-split-string (buffer-string) "\n"))
  2944. line)
  2945. (while (setq line (pop lines))
  2946. (catch 'next
  2947. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2948. (setq org-agenda-info
  2949. (org-fix-agenda-info (text-properties-at 0 line)))
  2950. (princ
  2951. (mapconcat 'org-agenda-export-csv-mapper
  2952. '(org-category txt type todo tags date time extra
  2953. priority-letter priority agenda-day)
  2954. ","))
  2955. (princ "\n")))))
  2956. (defun org-fix-agenda-info (props)
  2957. "Make sure all properties on an agenda item have a canonical form.
  2958. This ensures the export commands can easily use it."
  2959. (let (tmp re)
  2960. (when (setq tmp (plist-get props 'tags))
  2961. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2962. (when (setq tmp (plist-get props 'date))
  2963. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2964. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2965. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2966. (setq tmp (calendar-date-string tmp)))
  2967. (setq props (plist-put props 'date tmp)))
  2968. (when (setq tmp (plist-get props 'day))
  2969. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2970. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2971. (setq tmp (calendar-date-string tmp)))
  2972. (setq props (plist-put props 'day tmp))
  2973. (setq props (plist-put props 'agenda-day tmp)))
  2974. (when (setq tmp (plist-get props 'txt))
  2975. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2976. (plist-put props 'priority-letter (match-string 1 tmp))
  2977. (setq tmp (replace-match "" t t tmp)))
  2978. (when (and (setq re (plist-get props 'org-todo-regexp))
  2979. (setq re (concat "\\`\\.*" re " ?"))
  2980. (let ((case-fold-search nil)) (string-match re tmp)))
  2981. (plist-put props 'todo (match-string 1 tmp))
  2982. (setq tmp (replace-match "" t t tmp)))
  2983. (plist-put props 'txt tmp)))
  2984. props)
  2985. (defun org-agenda-export-csv-mapper (prop)
  2986. (let ((res (plist-get org-agenda-info prop)))
  2987. (setq res
  2988. (cond
  2989. ((not res) "")
  2990. ((stringp res) res)
  2991. (t (prin1-to-string res))))
  2992. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  2993. ;;;###autoload
  2994. (defun org-store-agenda-views (&rest parameters)
  2995. "Store agenda views."
  2996. (interactive)
  2997. (eval (list 'org-batch-store-agenda-views)))
  2998. ;;;###autoload
  2999. (defmacro org-batch-store-agenda-views (&rest parameters)
  3000. "Run all custom agenda commands that have a file argument."
  3001. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3002. (pop-up-frames nil)
  3003. (dir default-directory)
  3004. (pars (org-make-parameter-alist parameters))
  3005. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3006. (save-window-excursion
  3007. (while cmds
  3008. (setq cmd (pop cmds)
  3009. thiscmdkey (car cmd)
  3010. thiscmdcmd (cdr cmd)
  3011. match (nth 2 thiscmdcmd)
  3012. bufname (if org-agenda-sticky
  3013. (or (and (stringp match)
  3014. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3015. (format "*Org Agenda(%s)*" thiscmdkey))
  3016. org-agenda-buffer-name)
  3017. cmd-or-set (nth 2 cmd)
  3018. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3019. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3020. (if (stringp files) (setq files (list files)))
  3021. (when files
  3022. (org-eval-in-environment (append org-agenda-exporter-settings
  3023. opts pars)
  3024. (org-agenda nil thiscmdkey))
  3025. (set-buffer bufname)
  3026. (while files
  3027. (org-eval-in-environment (append org-agenda-exporter-settings
  3028. opts pars)
  3029. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3030. (and (get-buffer bufname)
  3031. (kill-buffer bufname)))))))
  3032. (defvar org-agenda-current-span nil
  3033. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3034. (defun org-agenda-mark-header-line (pos)
  3035. "Mark the line at POS as an agenda structure header."
  3036. (save-excursion
  3037. (goto-char pos)
  3038. (put-text-property (point-at-bol) (point-at-eol)
  3039. 'org-agenda-structural-header t)
  3040. (when org-agenda-title-append
  3041. (put-text-property (point-at-bol) (point-at-eol)
  3042. 'org-agenda-title-append org-agenda-title-append))))
  3043. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3044. (defvar org-agenda-write-buffer-name "Agenda View")
  3045. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3046. "Write the current buffer (an agenda view) as a file.
  3047. Depending on the extension of the file name, plain text (.txt),
  3048. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3049. If the extension is .ics, translate visible agenda into iCalendar
  3050. format. If the extension is .org, collect all subtrees
  3051. corresponding to the agenda entries and add them in an .org file.
  3052. With prefix argument OPEN, open the new file immediately. If
  3053. NOSETTINGS is given, do not scope the settings of
  3054. `org-agenda-exporter-settings' into the export commands. This is
  3055. used when the settings have already been scoped and we do not
  3056. wish to overrule other, higher priority settings. If
  3057. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3058. the agenda to write."
  3059. (interactive "FWrite agenda to file: \nP")
  3060. (if (or (not (file-writable-p file))
  3061. (and (file-exists-p file)
  3062. (if (called-interactively-p 'any)
  3063. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3064. (user-error "Cannot write agenda to file %s" file))
  3065. (org-let (if nosettings nil org-agenda-exporter-settings)
  3066. '(save-excursion
  3067. (save-window-excursion
  3068. (let ((bs (copy-sequence (buffer-string)))
  3069. (extension (file-name-extension file))
  3070. (default-directory (file-name-directory file))
  3071. beg content)
  3072. (with-temp-buffer
  3073. (rename-buffer org-agenda-write-buffer-name t)
  3074. (set-buffer-modified-p nil)
  3075. (insert bs)
  3076. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3077. (run-hooks 'org-agenda-before-write-hook)
  3078. (cond
  3079. ((bound-and-true-p org-mobile-creating-agendas)
  3080. (org-mobile-write-agenda-for-mobile file))
  3081. ((string= "org" extension)
  3082. (let (content p m message-log-max)
  3083. (goto-char (point-min))
  3084. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3085. (goto-char p)
  3086. (setq m (get-text-property (point) 'org-hd-marker))
  3087. (when m
  3088. (push (save-excursion
  3089. (set-buffer (marker-buffer m))
  3090. (goto-char m)
  3091. (org-copy-subtree 1 nil t t)
  3092. org-subtree-clip)
  3093. content)))
  3094. (find-file file)
  3095. (erase-buffer)
  3096. (dolist (s content) (org-paste-subtree 1 s))
  3097. (write-file file)
  3098. (kill-buffer (current-buffer))
  3099. (message "Org file written to %s" file)))
  3100. ((member extension '("html" "htm"))
  3101. (or (require 'htmlize nil t)
  3102. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3103. (set-buffer (htmlize-buffer (current-buffer)))
  3104. (when org-agenda-export-html-style
  3105. ;; replace <style> section with org-agenda-export-html-style
  3106. (goto-char (point-min))
  3107. (kill-region (- (search-forward "<style") 6)
  3108. (search-forward "</style>"))
  3109. (insert org-agenda-export-html-style))
  3110. (write-file file)
  3111. (kill-buffer (current-buffer))
  3112. (message "HTML written to %s" file))
  3113. ((string= "ps" extension)
  3114. (require 'ps-print)
  3115. (ps-print-buffer-with-faces file)
  3116. (message "Postscript written to %s" file))
  3117. ((string= "pdf" extension)
  3118. (require 'ps-print)
  3119. (ps-print-buffer-with-faces
  3120. (concat (file-name-sans-extension file) ".ps"))
  3121. (call-process "ps2pdf" nil nil nil
  3122. (expand-file-name
  3123. (concat (file-name-sans-extension file) ".ps"))
  3124. (expand-file-name file))
  3125. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3126. (message "PDF written to %s" file))
  3127. ((string= "ics" extension)
  3128. (require 'ox-icalendar)
  3129. (org-icalendar-export-current-agenda (expand-file-name file)))
  3130. (t
  3131. (let ((bs (buffer-string)))
  3132. (find-file file)
  3133. (erase-buffer)
  3134. (insert bs)
  3135. (save-buffer 0)
  3136. (kill-buffer (current-buffer))
  3137. (message "Plain text written to %s" file))))))))
  3138. (set-buffer (or agenda-bufname
  3139. (and (called-interactively-p 'any) (buffer-name))
  3140. org-agenda-buffer-name)))
  3141. (when open (org-open-file file)))
  3142. (defun org-agenda-remove-marked-text (property &optional value)
  3143. "Delete all text marked with VALUE of PROPERTY.
  3144. VALUE defaults to t."
  3145. (let (beg)
  3146. (setq value (or value t))
  3147. (while (setq beg (text-property-any (point-min) (point-max)
  3148. property value))
  3149. (delete-region
  3150. beg (or (next-single-property-change beg property)
  3151. (point-max))))))
  3152. (defun org-agenda-add-entry-text ()
  3153. "Add entry text to agenda lines.
  3154. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3155. entry text following headings shown in the agenda.
  3156. Drawers will be excluded, also the line with scheduling/deadline info."
  3157. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3158. (not (bound-and-true-p org-mobile-creating-agendas)))
  3159. (let (m txt)
  3160. (goto-char (point-min))
  3161. (while (not (eobp))
  3162. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3163. (beginning-of-line 2)
  3164. (setq txt (org-agenda-get-some-entry-text
  3165. m org-agenda-add-entry-text-maxlines " > "))
  3166. (end-of-line 1)
  3167. (if (string-match "\\S-" txt)
  3168. (insert "\n" txt)
  3169. (or (eobp) (forward-char 1))))))))
  3170. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3171. &rest keep)
  3172. "Extract entry text from MARKER, at most N-LINES lines.
  3173. This will ignore drawers etc, just get the text.
  3174. If INDENT is given, prefix every line with this string. If KEEP is
  3175. given, it is a list of symbols, defining stuff that should not be
  3176. removed from the entry content. Currently only `planning' is allowed here."
  3177. (let (txt drawer-re kwd-time-re ind)
  3178. (save-excursion
  3179. (with-current-buffer (marker-buffer marker)
  3180. (if (not (derived-mode-p 'org-mode))
  3181. (setq txt "")
  3182. (org-with-wide-buffer
  3183. (goto-char marker)
  3184. (end-of-line 1)
  3185. (setq txt (buffer-substring
  3186. (min (1+ (point)) (point-max))
  3187. (progn (outline-next-heading) (point)))
  3188. drawer-re org-drawer-regexp
  3189. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3190. ".*\n?"))
  3191. (with-temp-buffer
  3192. (insert txt)
  3193. (when org-agenda-add-entry-text-descriptive-links
  3194. (goto-char (point-min))
  3195. (while (org-activate-links (point-max))
  3196. (add-text-properties (match-beginning 0) (match-end 0)
  3197. '(face org-link))))
  3198. (goto-char (point-min))
  3199. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3200. (set-text-properties (match-beginning 0) (match-end 0)
  3201. nil))
  3202. (goto-char (point-min))
  3203. (while (re-search-forward drawer-re nil t)
  3204. (delete-region
  3205. (match-beginning 0)
  3206. (progn (re-search-forward
  3207. "^[ \t]*:END:.*\n?" nil 'move)
  3208. (point))))
  3209. (unless (member 'planning keep)
  3210. (goto-char (point-min))
  3211. (while (re-search-forward kwd-time-re nil t)
  3212. (replace-match "")))
  3213. (goto-char (point-min))
  3214. (when org-agenda-entry-text-exclude-regexps
  3215. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3216. (while (setq re (pop re-list))
  3217. (goto-char (point-min))
  3218. (while (re-search-forward re nil t)
  3219. (replace-match "")))))
  3220. (goto-char (point-max))
  3221. (skip-chars-backward " \t\n")
  3222. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3223. ;; find and remove min common indentation
  3224. (goto-char (point-min))
  3225. (untabify (point-min) (point-max))
  3226. (setq ind (org-get-indentation))
  3227. (while (not (eobp))
  3228. (unless (looking-at "[ \t]*$")
  3229. (setq ind (min ind (org-get-indentation))))
  3230. (beginning-of-line 2))
  3231. (goto-char (point-min))
  3232. (while (not (eobp))
  3233. (unless (looking-at "[ \t]*$")
  3234. (move-to-column ind)
  3235. (delete-region (point-at-bol) (point)))
  3236. (beginning-of-line 2))
  3237. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3238. (goto-char (point-min))
  3239. (when indent
  3240. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3241. (replace-match indent t t)))
  3242. (goto-char (point-min))
  3243. (while (looking-at "[ \t]*\n") (replace-match ""))
  3244. (goto-char (point-max))
  3245. (when (> (org-current-line)
  3246. n-lines)
  3247. (org-goto-line (1+ n-lines))
  3248. (backward-char 1))
  3249. (setq txt (buffer-substring (point-min) (point))))))))
  3250. txt))
  3251. (defun org-check-for-org-mode ()
  3252. "Make sure current buffer is in Org mode. Error if not."
  3253. (or (derived-mode-p 'org-mode)
  3254. (error "Cannot execute Org agenda command on buffer in %s"
  3255. major-mode)))
  3256. ;;; Agenda prepare and finalize
  3257. (defvar org-agenda-multi nil) ; dynamically scoped
  3258. (defvar org-agenda-pre-window-conf nil)
  3259. (defvar org-agenda-columns-active nil)
  3260. (defvar org-agenda-name nil)
  3261. (defvar org-agenda-tag-filter nil)
  3262. (defvar org-agenda-category-filter nil)
  3263. (defvar org-agenda-regexp-filter nil)
  3264. (defvar org-agenda-effort-filter nil)
  3265. (defvar org-agenda-top-headline-filter nil)
  3266. (defvar org-agenda-tag-filter-preset nil
  3267. "A preset of the tags filter used for secondary agenda filtering.
  3268. This must be a list of strings, each string must be a single tag preceded
  3269. by \"+\" or \"-\".
  3270. This variable should not be set directly, but agenda custom commands can
  3271. bind it in the options section. The preset filter is a global property of
  3272. the entire agenda view. In a block agenda, it will not work reliably to
  3273. define a filter for one of the individual blocks. You need to set it in
  3274. the global options and expect it to be applied to the entire view.")
  3275. (defvar org-agenda-category-filter-preset nil
  3276. "A preset of the category filter used for secondary agenda filtering.
  3277. This must be a list of strings, each string must be a single category
  3278. preceded by \"+\" or \"-\".
  3279. This variable should not be set directly, but agenda custom commands can
  3280. bind it in the options section. The preset filter is a global property of
  3281. the entire agenda view. In a block agenda, it will not work reliably to
  3282. define a filter for one of the individual blocks. You need to set it in
  3283. the global options and expect it to be applied to the entire view.")
  3284. (defvar org-agenda-regexp-filter-preset nil
  3285. "A preset of the regexp filter used for secondary agenda filtering.
  3286. This must be a list of strings, each string must be a single regexp
  3287. preceded by \"+\" or \"-\".
  3288. This variable should not be set directly, but agenda custom commands can
  3289. bind it in the options section. The preset filter is a global property of
  3290. the entire agenda view. In a block agenda, it will not work reliably to
  3291. define a filter for one of the individual blocks. You need to set it in
  3292. the global options and expect it to be applied to the entire view.")
  3293. (defvar org-agenda-effort-filter-preset nil
  3294. "A preset of the effort condition used for secondary agenda filtering.
  3295. This must be a list of strings, each string must be a single regexp
  3296. preceded by \"+\" or \"-\".
  3297. This variable should not be set directly, but agenda custom commands can
  3298. bind it in the options section. The preset filter is a global property of
  3299. the entire agenda view. In a block agenda, it will not work reliably to
  3300. define a filter for one of the individual blocks. You need to set it in
  3301. the global options and expect it to be applied to the entire view.")
  3302. (defun org-agenda-use-sticky-p ()
  3303. "Return non-nil if an agenda buffer named
  3304. `org-agenda-buffer-name' exists and should be shown instead of
  3305. generating a new one."
  3306. (and
  3307. ;; turned off by user
  3308. org-agenda-sticky
  3309. ;; For multi-agenda buffer already exists
  3310. (not org-agenda-multi)
  3311. ;; buffer found
  3312. (get-buffer org-agenda-buffer-name)
  3313. ;; C-u parameter is same as last call
  3314. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3315. (and
  3316. (equal current-prefix-arg
  3317. org-agenda-last-prefix-arg)
  3318. ;; In case user turned stickiness on, while having existing
  3319. ;; Agenda buffer active, don't reuse that buffer, because it
  3320. ;; does not have org variables local
  3321. org-agenda-this-buffer-is-sticky))))
  3322. (defun org-agenda-prepare-window (abuf filter-alist)
  3323. "Setup agenda buffer in the window.
  3324. ABUF is the buffer for the agenda window.
  3325. FILTER-ALIST is an alist of filters we need to apply when
  3326. `org-agenda-persistent-filter' is non-nil."
  3327. (let* ((awin (get-buffer-window abuf)) wconf)
  3328. (cond
  3329. ((equal (current-buffer) abuf) nil)
  3330. (awin (select-window awin))
  3331. ((not (setq wconf (current-window-configuration))))
  3332. ((eq org-agenda-window-setup 'current-window)
  3333. (pop-to-buffer-same-window abuf))
  3334. ((eq org-agenda-window-setup 'other-window)
  3335. (org-switch-to-buffer-other-window abuf))
  3336. ((eq org-agenda-window-setup 'other-frame)
  3337. (switch-to-buffer-other-frame abuf))
  3338. ((eq org-agenda-window-setup 'only-window)
  3339. (delete-other-windows)
  3340. (pop-to-buffer-same-window abuf))
  3341. ((eq org-agenda-window-setup 'reorganize-frame)
  3342. (delete-other-windows)
  3343. (org-switch-to-buffer-other-window abuf)))
  3344. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3345. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3346. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3347. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3348. ;; Additional test in case agenda is invoked from within agenda
  3349. ;; buffer via elisp link.
  3350. (unless (equal (current-buffer) abuf)
  3351. (pop-to-buffer-same-window abuf))
  3352. (setq org-agenda-pre-window-conf
  3353. (or wconf org-agenda-pre-window-conf))))
  3354. (defun org-agenda-prepare (&optional name)
  3355. (let ((filter-alist (if org-agenda-persistent-filter
  3356. (with-current-buffer
  3357. (get-buffer-create org-agenda-buffer-name)
  3358. (list `(tag . ,org-agenda-tag-filter)
  3359. `(re . ,org-agenda-regexp-filter)
  3360. `(effort . ,org-agenda-effort-filter)
  3361. `(cat . ,org-agenda-category-filter))))))
  3362. (if (org-agenda-use-sticky-p)
  3363. (progn
  3364. (put 'org-agenda-tag-filter :preset-filter nil)
  3365. (put 'org-agenda-category-filter :preset-filter nil)
  3366. (put 'org-agenda-regexp-filter :preset-filter nil)
  3367. ;; Popup existing buffer
  3368. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3369. filter-alist)
  3370. (message "Sticky Agenda buffer, use `r' to refresh")
  3371. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3372. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3373. (setq org-todo-keywords-for-agenda nil)
  3374. (put 'org-agenda-tag-filter :preset-filter
  3375. org-agenda-tag-filter-preset)
  3376. (put 'org-agenda-category-filter :preset-filter
  3377. org-agenda-category-filter-preset)
  3378. (put 'org-agenda-regexp-filter :preset-filter
  3379. org-agenda-regexp-filter-preset)
  3380. (put 'org-agenda-effort-filter :preset-filter
  3381. org-agenda-effort-filter-preset)
  3382. (if org-agenda-multi
  3383. (progn
  3384. (setq buffer-read-only nil)
  3385. (goto-char (point-max))
  3386. (unless (or (bobp) org-agenda-compact-blocks
  3387. (not org-agenda-block-separator))
  3388. (insert "\n"
  3389. (if (stringp org-agenda-block-separator)
  3390. org-agenda-block-separator
  3391. (make-string (window-width) org-agenda-block-separator))
  3392. "\n"))
  3393. (narrow-to-region (point) (point-max)))
  3394. (setq org-done-keywords-for-agenda nil)
  3395. ;; Setting any org variables that are in org-agenda-local-vars
  3396. ;; list need to be done after the prepare call
  3397. (org-agenda-prepare-window
  3398. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3399. (setq buffer-read-only nil)
  3400. (org-agenda-reset-markers)
  3401. (let ((inhibit-read-only t)) (erase-buffer))
  3402. (org-agenda-mode)
  3403. (setq org-agenda-buffer (current-buffer))
  3404. (setq org-agenda-contributing-files nil)
  3405. (setq org-agenda-columns-active nil)
  3406. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3407. (setq org-todo-keywords-for-agenda
  3408. (org-uniquify org-todo-keywords-for-agenda))
  3409. (setq org-done-keywords-for-agenda
  3410. (org-uniquify org-done-keywords-for-agenda))
  3411. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3412. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3413. (and name (not org-agenda-name)
  3414. (setq-local org-agenda-name name)))
  3415. (setq buffer-read-only nil))))
  3416. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3417. (defun org-agenda-finalize ()
  3418. "Finishing touch for the agenda buffer, called just before displaying it."
  3419. (unless org-agenda-multi
  3420. (save-excursion
  3421. (let ((inhibit-read-only t))
  3422. (goto-char (point-min))
  3423. (save-excursion
  3424. (while (org-activate-links (point-max))
  3425. (add-text-properties (match-beginning 0) (match-end 0)
  3426. '(face org-link))))
  3427. (unless (eq org-agenda-remove-tags t)
  3428. (org-agenda-align-tags))
  3429. (unless org-agenda-with-colors
  3430. (remove-text-properties (point-min) (point-max) '(face nil)))
  3431. (if (and (boundp 'org-agenda-overriding-columns-format)
  3432. org-agenda-overriding-columns-format)
  3433. (setq-local org-agenda-overriding-columns-format
  3434. org-agenda-overriding-columns-format))
  3435. (if (and (boundp 'org-agenda-view-columns-initially)
  3436. org-agenda-view-columns-initially)
  3437. (org-agenda-columns))
  3438. (when org-agenda-fontify-priorities
  3439. (org-agenda-fontify-priorities))
  3440. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3441. (org-agenda-dim-blocked-tasks))
  3442. (org-agenda-mark-clocking-task)
  3443. (when org-agenda-entry-text-mode
  3444. (org-agenda-entry-text-hide)
  3445. (org-agenda-entry-text-show))
  3446. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3447. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3448. (org-habit-insert-consistency-graphs))
  3449. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3450. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3451. (and (listp org-agenda-show-inherited-tags)
  3452. (memq org-agenda-type org-agenda-show-inherited-tags))
  3453. (and (eq org-agenda-show-inherited-tags t)
  3454. (or (eq org-agenda-use-tag-inheritance t)
  3455. (and (listp org-agenda-use-tag-inheritance)
  3456. (not (memq org-agenda-type
  3457. org-agenda-use-tag-inheritance))))))
  3458. (let (mrk)
  3459. (save-excursion
  3460. (goto-char (point-min))
  3461. (while (equal (forward-line) 0)
  3462. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3463. (put-text-property (point-at-bol) (point-at-eol)
  3464. 'tags
  3465. (org-with-point-at mrk
  3466. (mapcar #'downcase (org-get-tags)))))))))
  3467. (run-hooks 'org-agenda-finalize-hook)
  3468. (when org-agenda-top-headline-filter
  3469. (org-agenda-filter-top-headline-apply
  3470. org-agenda-top-headline-filter))
  3471. (when org-agenda-tag-filter
  3472. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3473. (when (get 'org-agenda-tag-filter :preset-filter)
  3474. (org-agenda-filter-apply
  3475. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3476. (when org-agenda-category-filter
  3477. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3478. (when (get 'org-agenda-category-filter :preset-filter)
  3479. (org-agenda-filter-apply
  3480. (get 'org-agenda-category-filter :preset-filter) 'category))
  3481. (when org-agenda-regexp-filter
  3482. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3483. (when (get 'org-agenda-regexp-filter :preset-filter)
  3484. (org-agenda-filter-apply
  3485. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3486. (when org-agenda-effort-filter
  3487. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3488. (when (get 'org-agenda-effort-filter :preset-filter)
  3489. (org-agenda-filter-apply
  3490. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3491. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3492. (defun org-agenda-mark-clocking-task ()
  3493. "Mark the current clock entry in the agenda if it is present."
  3494. ;; We need to widen when `org-agenda-finalize' is called from
  3495. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3496. (when (bound-and-true-p org-clock-current-task)
  3497. (save-restriction
  3498. (widen)
  3499. (org-agenda-unmark-clocking-task)
  3500. (when (marker-buffer org-clock-hd-marker)
  3501. (save-excursion
  3502. (goto-char (point-min))
  3503. (let (s ov)
  3504. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3505. (goto-char s)
  3506. (when (equal (org-get-at-bol 'org-hd-marker)
  3507. org-clock-hd-marker)
  3508. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3509. (overlay-put ov 'type 'org-agenda-clocking)
  3510. (overlay-put ov 'face 'org-agenda-clocking)
  3511. (overlay-put ov 'help-echo
  3512. "The clock is running in this item")))))))))
  3513. (defun org-agenda-unmark-clocking-task ()
  3514. "Unmark the current clocking task."
  3515. (mapc (lambda (o)
  3516. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3517. (delete-overlay o)))
  3518. (overlays-in (point-min) (point-max))))
  3519. (defun org-agenda-fontify-priorities ()
  3520. "Make highest priority lines bold, and lowest italic."
  3521. (interactive)
  3522. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3523. (delete-overlay o)))
  3524. (overlays-in (point-min) (point-max)))
  3525. (save-excursion
  3526. (let (b e p ov h l)
  3527. (goto-char (point-min))
  3528. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3529. (setq h (or (get-char-property (point) 'org-highest-priority)
  3530. org-highest-priority)
  3531. l (or (get-char-property (point) 'org-lowest-priority)
  3532. org-lowest-priority)
  3533. p (string-to-char (match-string 1))
  3534. b (match-beginning 0)
  3535. e (if (eq org-agenda-fontify-priorities 'cookies)
  3536. (match-end 0)
  3537. (point-at-eol))
  3538. ov (make-overlay b e))
  3539. (overlay-put
  3540. ov 'face
  3541. (let ((special-face
  3542. (cond ((org-face-from-face-or-color
  3543. 'priority 'org-priority
  3544. (cdr (assoc p org-priority-faces))))
  3545. ((and (listp org-agenda-fontify-priorities)
  3546. (org-face-from-face-or-color
  3547. 'priority 'org-priority
  3548. (cdr (assoc p org-agenda-fontify-priorities)))))
  3549. ((equal p l) 'italic)
  3550. ((equal p h) 'bold))))
  3551. (if special-face (list special-face 'org-priority) 'org-priority)))
  3552. (overlay-put ov 'org-type 'org-priority)))))
  3553. (defvar org-depend-tag-blocked)
  3554. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3555. "Dim currently blocked TODOs in the agenda display.
  3556. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3557. dimming them."
  3558. (interactive "P")
  3559. (when (called-interactively-p 'interactive)
  3560. (message "Dim or hide blocked tasks..."))
  3561. (dolist (o (overlays-in (point-min) (point-max)))
  3562. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3563. (delete-overlay o)))
  3564. (save-excursion
  3565. (let ((inhibit-read-only t))
  3566. (goto-char (point-min))
  3567. (while (let ((pos (text-property-not-all
  3568. (point) (point-max) 'org-todo-blocked nil)))
  3569. (when pos (goto-char pos)))
  3570. (let* ((invisible (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3571. (ov (make-overlay (if invisible
  3572. (line-end-position 0)
  3573. (line-beginning-position))
  3574. (line-end-position))))
  3575. (if invisible
  3576. (overlay-put ov 'invisible t)
  3577. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3578. (overlay-put ov 'org-type 'org-blocked-todo))
  3579. (forward-line))))
  3580. (when (called-interactively-p 'interactive)
  3581. (message "Dim or hide blocked tasks...done")))
  3582. (defun org-agenda--mark-blocked-entry (entry)
  3583. "For ENTRY a string with the text property `org-hd-marker', if
  3584. the header at `org-hd-marker' is blocked according to
  3585. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3586. 'invisible and the header is not blocked by checkboxes, set the
  3587. text property `org-todo-blocked' to 'invisible, otherwise set it
  3588. to t."
  3589. (when (get-text-property 0 'todo-state entry)
  3590. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3591. (org-blocked-by-checkboxes nil)
  3592. ;; Necessary so that `org-entry-blocked-p' does not change
  3593. ;; the buffer.
  3594. (org-depend-tag-blocked nil))
  3595. (when entry-marker
  3596. (let ((blocked
  3597. (with-current-buffer (marker-buffer entry-marker)
  3598. (save-excursion
  3599. (goto-char entry-marker)
  3600. (org-entry-blocked-p)))))
  3601. (when blocked
  3602. (let ((really-invisible
  3603. (and (not org-blocked-by-checkboxes)
  3604. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3605. (put-text-property
  3606. 0 (length entry) 'org-todo-blocked
  3607. (if really-invisible 'invisible t)
  3608. entry)))))))
  3609. entry)
  3610. (defvar org-agenda-skip-function nil
  3611. "Function to be called at each match during agenda construction.
  3612. If this function returns nil, the current match should not be skipped.
  3613. Otherwise, the function must return a position from where the search
  3614. should be continued.
  3615. This may also be a Lisp form, it will be evaluated.
  3616. Never set this variable using `setq' or so, because then it will apply
  3617. to all future agenda commands. If you do want a global skipping condition,
  3618. use the option `org-agenda-skip-function-global' instead.
  3619. The correct usage for `org-agenda-skip-function' is to bind it with
  3620. `let' to scope it dynamically into the agenda-constructing command.
  3621. A good way to set it is through options in `org-agenda-custom-commands'.")
  3622. (defun org-agenda-skip ()
  3623. "Throw to `:skip' in places that should be skipped.
  3624. Also moves point to the end of the skipped region, so that search can
  3625. continue from there."
  3626. (let ((p (point-at-bol)) to)
  3627. (when (or
  3628. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3629. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3630. (get-text-property p :org-archived)
  3631. (org-end-of-subtree t))
  3632. (and org-agenda-skip-comment-trees
  3633. (get-text-property p :org-comment)
  3634. (org-end-of-subtree t))
  3635. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3636. (org-agenda-skip-eval org-agenda-skip-function)))
  3637. (goto-char to))
  3638. (org-in-src-block-p t))
  3639. (throw :skip t))))
  3640. (defun org-agenda-skip-eval (form)
  3641. "If FORM is a function or a list, call (or eval) it and return the result.
  3642. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3643. and match data are returned to the previous state no matter what these
  3644. functions do."
  3645. (let (fp)
  3646. (and form
  3647. (or (setq fp (functionp form))
  3648. (consp form))
  3649. (save-excursion
  3650. (save-match-data
  3651. (if fp
  3652. (funcall form)
  3653. (eval form)))))))
  3654. (defvar org-agenda-markers nil
  3655. "List of all currently active markers created by `org-agenda'.")
  3656. (defvar org-agenda-last-marker-time (float-time)
  3657. "Creation time of the last agenda marker.")
  3658. (defun org-agenda-new-marker (&optional pos)
  3659. "Return a new agenda marker.
  3660. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3661. these markers and resets them when they are no longer in use."
  3662. (let ((m (copy-marker (or pos (point)) t)))
  3663. (setq org-agenda-last-marker-time (float-time))
  3664. (if org-agenda-buffer
  3665. (with-current-buffer org-agenda-buffer
  3666. (push m org-agenda-markers))
  3667. (push m org-agenda-markers))
  3668. m))
  3669. (defun org-agenda-reset-markers ()
  3670. "Reset markers created by `org-agenda'."
  3671. (while org-agenda-markers
  3672. (move-marker (pop org-agenda-markers) nil)))
  3673. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3674. "Save relative positions of markers in region.
  3675. This check for agenda markers in all agenda buffers currently active."
  3676. (dolist (buf (buffer-list))
  3677. (with-current-buffer buf
  3678. (when (eq major-mode 'org-agenda-mode)
  3679. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3680. org-agenda-markers)))))
  3681. ;;; Entry text mode
  3682. (defun org-agenda-entry-text-show-here ()
  3683. "Add some text from the entry as context to the current line."
  3684. (let (m txt o)
  3685. (setq m (org-get-at-bol 'org-hd-marker))
  3686. (unless (marker-buffer m)
  3687. (error "No marker points to an entry here"))
  3688. (setq txt (concat "\n" (org-no-properties
  3689. (org-agenda-get-some-entry-text
  3690. m org-agenda-entry-text-maxlines
  3691. org-agenda-entry-text-leaders))))
  3692. (when (string-match "\\S-" txt)
  3693. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3694. (overlay-put o 'evaporate t)
  3695. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3696. (overlay-put o 'after-string txt))))
  3697. (defun org-agenda-entry-text-show ()
  3698. "Add entry context for all agenda lines."
  3699. (interactive)
  3700. (save-excursion
  3701. (goto-char (point-max))
  3702. (beginning-of-line 1)
  3703. (while (not (bobp))
  3704. (when (org-get-at-bol 'org-hd-marker)
  3705. (org-agenda-entry-text-show-here))
  3706. (beginning-of-line 0))))
  3707. (defun org-agenda-entry-text-hide ()
  3708. "Remove any shown entry context."
  3709. (delq nil
  3710. (mapcar (lambda (o)
  3711. (if (eq (overlay-get o 'org-overlay-type)
  3712. 'agenda-entry-content)
  3713. (progn (delete-overlay o) t)))
  3714. (overlays-in (point-min) (point-max)))))
  3715. (defun org-agenda-get-day-face (date)
  3716. "Return the face DATE should be displayed with."
  3717. (cond ((and (functionp org-agenda-day-face-function)
  3718. (funcall org-agenda-day-face-function date)))
  3719. ((org-agenda-today-p date) 'org-agenda-date-today)
  3720. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3721. 'org-agenda-date-weekend)
  3722. (t 'org-agenda-date)))
  3723. (defvar org-agenda-show-log-scoped)
  3724. ;;; Agenda Daily/Weekly
  3725. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3726. "Start day for the agenda view.
  3727. Custom commands can set this variable in the options section.
  3728. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3729. input allowed when reading a date through the Org calendar.
  3730. See the docstring of `org-read-date' for details.")
  3731. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3732. (defvar org-arg-loc nil) ; local variable
  3733. (defvar org-agenda-buffer-tmp-name nil)
  3734. ;;;###autoload
  3735. (defun org-agenda-list (&optional arg start-day span with-hour)
  3736. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3737. The view will be for the current day or week, but from the overview buffer
  3738. you will be able to go to other days/weeks.
  3739. With a numeric prefix argument in an interactive call, the agenda will
  3740. span ARG days. Lisp programs should instead specify SPAN to change
  3741. the number of days. SPAN defaults to `org-agenda-span'.
  3742. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3743. given in `org-agenda-start-on-weekday'.
  3744. When WITH-HOUR is non-nil, only include scheduled and deadline
  3745. items if they have an hour specification like [h]h:mm."
  3746. (interactive "P")
  3747. (if org-agenda-overriding-arguments
  3748. (setq arg (car org-agenda-overriding-arguments)
  3749. start-day (nth 1 org-agenda-overriding-arguments)
  3750. span (nth 2 org-agenda-overriding-arguments)))
  3751. (if (and (integerp arg) (> arg 0))
  3752. (setq span arg arg nil))
  3753. (catch 'exit
  3754. (setq org-agenda-buffer-name
  3755. (or org-agenda-buffer-tmp-name
  3756. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3757. (if org-agenda-sticky
  3758. (cond ((and org-keys (stringp org-match))
  3759. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3760. (org-keys
  3761. (format "*Org Agenda(%s)*" org-keys))
  3762. (t "*Org Agenda(a)*")))
  3763. "*Org Agenda*"))
  3764. (org-agenda-prepare "Day/Week")
  3765. (setq start-day (or start-day org-agenda-start-day))
  3766. (if (stringp start-day)
  3767. ;; Convert to an absolute day number
  3768. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3769. (org-compile-prefix-format 'agenda)
  3770. (org-set-sorting-strategy 'agenda)
  3771. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3772. (today (org-today))
  3773. (sd (or start-day today))
  3774. (ndays (org-agenda-span-to-ndays span sd))
  3775. (org-agenda-start-on-weekday
  3776. (if (or (eq ndays 7) (eq ndays 14))
  3777. org-agenda-start-on-weekday))
  3778. (thefiles (org-agenda-files nil 'ifmode))
  3779. (files thefiles)
  3780. (start (if (or (null org-agenda-start-on-weekday)
  3781. (< ndays 7))
  3782. sd
  3783. (let* ((nt (calendar-day-of-week
  3784. (calendar-gregorian-from-absolute sd)))
  3785. (n1 org-agenda-start-on-weekday)
  3786. (d (- nt n1)))
  3787. (- sd (+ (if (< d 0) 7 0) d)))))
  3788. (day-numbers (list start))
  3789. (day-cnt 0)
  3790. (inhibit-redisplay (not debug-on-error))
  3791. (org-agenda-show-log-scoped org-agenda-show-log)
  3792. s e rtn rtnall file date d start-pos end-pos todayp
  3793. clocktable-start clocktable-end filter)
  3794. (setq org-agenda-redo-command
  3795. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3796. (dotimes (n (1- ndays))
  3797. (push (1+ (car day-numbers)) day-numbers))
  3798. (setq day-numbers (nreverse day-numbers))
  3799. (setq clocktable-start (car day-numbers)
  3800. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3801. (setq-local org-starting-day (car day-numbers))
  3802. (setq-local org-arg-loc arg)
  3803. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3804. (unless org-agenda-compact-blocks
  3805. (let* ((d1 (car day-numbers))
  3806. (d2 (org-last day-numbers))
  3807. (w1 (org-days-to-iso-week d1))
  3808. (w2 (org-days-to-iso-week d2)))
  3809. (setq s (point))
  3810. (org-agenda--insert-overriding-header
  3811. (concat (org-agenda-span-name span)
  3812. "-agenda"
  3813. (cond ((<= 350 (- d2 d1)) "")
  3814. ((= w1 w2) (format " (W%02d)" w1))
  3815. (t (format " (W%02d-W%02d)" w1 w2)))
  3816. ":\n")))
  3817. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3818. 'org-date-line t))
  3819. (org-agenda-mark-header-line s))
  3820. (while (setq d (pop day-numbers))
  3821. (setq date (calendar-gregorian-from-absolute d)
  3822. s (point))
  3823. (if (or (setq todayp (= d today))
  3824. (and (not start-pos) (= d sd)))
  3825. (setq start-pos (point))
  3826. (if (and start-pos (not end-pos))
  3827. (setq end-pos (point))))
  3828. (setq files thefiles
  3829. rtnall nil)
  3830. (while (setq file (pop files))
  3831. (catch 'nextfile
  3832. (org-check-agenda-file file)
  3833. (let ((org-agenda-entry-types org-agenda-entry-types))
  3834. ;; Starred types override non-starred equivalents
  3835. (when (member :deadline* org-agenda-entry-types)
  3836. (setq org-agenda-entry-types
  3837. (delq :deadline org-agenda-entry-types)))
  3838. (when (member :scheduled* org-agenda-entry-types)
  3839. (setq org-agenda-entry-types
  3840. (delq :scheduled org-agenda-entry-types)))
  3841. ;; Honor with-hour
  3842. (when with-hour
  3843. (when (member :deadline org-agenda-entry-types)
  3844. (setq org-agenda-entry-types
  3845. (delq :deadline org-agenda-entry-types))
  3846. (push :deadline* org-agenda-entry-types))
  3847. (when (member :scheduled org-agenda-entry-types)
  3848. (setq org-agenda-entry-types
  3849. (delq :scheduled org-agenda-entry-types))
  3850. (push :scheduled* org-agenda-entry-types)))
  3851. (unless org-agenda-include-deadlines
  3852. (setq org-agenda-entry-types
  3853. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3854. (cond
  3855. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3856. (setq rtn (org-agenda-get-day-entries
  3857. file date :closed)))
  3858. (org-agenda-show-log-scoped
  3859. (setq rtn (apply 'org-agenda-get-day-entries
  3860. file date
  3861. (append '(:closed) org-agenda-entry-types))))
  3862. (t
  3863. (setq rtn (apply 'org-agenda-get-day-entries
  3864. file date
  3865. org-agenda-entry-types)))))
  3866. (setq rtnall (append rtnall rtn)))) ;; all entries
  3867. (if org-agenda-include-diary
  3868. (let ((org-agenda-search-headline-for-time t))
  3869. (require 'diary-lib)
  3870. (setq rtn (org-get-entries-from-diary date))
  3871. (setq rtnall (append rtnall rtn))))
  3872. (if (or rtnall org-agenda-show-all-dates)
  3873. (progn
  3874. (setq day-cnt (1+ day-cnt))
  3875. (insert
  3876. (if (stringp org-agenda-format-date)
  3877. (format-time-string org-agenda-format-date
  3878. (org-time-from-absolute date))
  3879. (funcall org-agenda-format-date date))
  3880. "\n")
  3881. (put-text-property s (1- (point)) 'face
  3882. (org-agenda-get-day-face date))
  3883. (put-text-property s (1- (point)) 'org-date-line t)
  3884. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3885. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3886. (when todayp
  3887. (put-text-property s (1- (point)) 'org-today t))
  3888. (setq rtnall
  3889. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3890. (if rtnall (insert ;; all entries
  3891. (org-agenda-finalize-entries rtnall 'agenda)
  3892. "\n"))
  3893. (put-text-property s (1- (point)) 'day d)
  3894. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3895. (when (and org-agenda-clockreport-mode clocktable-start)
  3896. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3897. ;; the above line is to ensure the restricted range!
  3898. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3899. tbl)
  3900. (setq p (org-plist-delete p :block))
  3901. (setq p (plist-put p :tstart clocktable-start))
  3902. (setq p (plist-put p :tend clocktable-end))
  3903. (setq p (plist-put p :scope 'agenda))
  3904. (setq tbl (apply 'org-clock-get-clocktable p))
  3905. (insert tbl)))
  3906. (goto-char (point-min))
  3907. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3908. (unless (or (not (get-buffer-window))
  3909. (and (pos-visible-in-window-p (point-min))
  3910. (pos-visible-in-window-p (point-max))))
  3911. (goto-char (1- (point-max)))
  3912. (recenter -1)
  3913. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3914. (progn
  3915. (goto-char (or start-pos 1))
  3916. (recenter 1))))
  3917. (goto-char (or start-pos 1))
  3918. (add-text-properties (point-min) (point-max)
  3919. `(org-agenda-type agenda
  3920. org-last-args (,arg ,start-day ,span)
  3921. org-redo-cmd ,org-agenda-redo-command
  3922. org-series-cmd ,org-cmd))
  3923. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3924. (org-agenda-show-clocking-issues))
  3925. (org-agenda-finalize)
  3926. (setq buffer-read-only t)
  3927. (message ""))))
  3928. (defun org-agenda-ndays-to-span (n)
  3929. "Return a span symbol for a span of N days, or N if none matches."
  3930. (cond ((symbolp n) n)
  3931. ((= n 1) 'day)
  3932. ((= n 7) 'week)
  3933. ((= n 14) 'fortnight)
  3934. (t n)))
  3935. (defun org-agenda-span-to-ndays (span &optional start-day)
  3936. "Return ndays from SPAN, possibly starting at START-DAY.
  3937. START-DAY is an absolute time value."
  3938. (cond ((numberp span) span)
  3939. ((eq span 'day) 1)
  3940. ((eq span 'week) 7)
  3941. ((eq span 'fortnight) 14)
  3942. ((eq span 'month)
  3943. (let ((date (calendar-gregorian-from-absolute start-day)))
  3944. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3945. ((eq span 'year)
  3946. (let ((date (calendar-gregorian-from-absolute start-day)))
  3947. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3948. (defun org-agenda-span-name (span)
  3949. "Return a SPAN name."
  3950. (if (null span)
  3951. ""
  3952. (if (symbolp span)
  3953. (capitalize (symbol-name span))
  3954. (format "%d days" span))))
  3955. ;;; Agenda word search
  3956. (defvar org-agenda-search-history nil)
  3957. (defvar org-search-syntax-table nil
  3958. "Special syntax table for Org search.
  3959. In this table, we have single quotes not as word constituents, to
  3960. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3961. (defvar org-mode-syntax-table) ; From org.el
  3962. (defun org-search-syntax-table ()
  3963. (unless org-search-syntax-table
  3964. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3965. (modify-syntax-entry ?' "." org-search-syntax-table)
  3966. (modify-syntax-entry ?` "." org-search-syntax-table))
  3967. org-search-syntax-table)
  3968. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3969. ;;;###autoload
  3970. (defun org-search-view (&optional todo-only string edit-at)
  3971. "Show all entries that contain a phrase or words or regular expressions.
  3972. With optional prefix argument TODO-ONLY, only consider entries that are
  3973. TODO entries. The argument STRING can be used to pass a default search
  3974. string into this function. If EDIT-AT is non-nil, it means that the
  3975. user should get a chance to edit this string, with cursor at position
  3976. EDIT-AT.
  3977. The search string can be viewed either as a phrase that should be found as
  3978. is, or it can be broken into a number of snippets, each of which must match
  3979. in a Boolean way to select an entry. The default depends on the variable
  3980. `org-agenda-search-view-always-boolean'.
  3981. Even if this is turned off (the default) you can always switch to
  3982. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3983. The default is a direct search of the whole phrase, where each space in
  3984. the search string can expand to an arbitrary amount of whitespace,
  3985. including newlines.
  3986. If using a Boolean search, the search string is split on whitespace and
  3987. each snippet is searched separately, with logical AND to select an entry.
  3988. Words prefixed with a minus must *not* occur in the entry. Words without
  3989. a prefix or prefixed with a plus must occur in the entry. Matching is
  3990. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3991. match whole words, not parts of a word) if
  3992. `org-agenda-search-view-force-full-words' is set (default is nil).
  3993. Boolean search snippets enclosed by curly braces are interpreted as
  3994. regular expressions that must or (when preceded with \"-\") must not
  3995. match in the entry. Snippets enclosed into double quotes will be taken
  3996. as a whole, to include whitespace.
  3997. - If the search string starts with an asterisk, search only in headlines.
  3998. - If (possibly after the leading star) the search string starts with an
  3999. exclamation mark, this also means to look at TODO entries only, an effect
  4000. that can also be achieved with a prefix argument.
  4001. - If (possibly after star and exclamation mark) the search string starts
  4002. with a colon, this will mean that the (non-regexp) snippets of the
  4003. Boolean search must match as full words.
  4004. This command searches the agenda files, and in addition the files
  4005. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4006. is active."
  4007. (interactive "P")
  4008. (if org-agenda-overriding-arguments
  4009. (setq todo-only (car org-agenda-overriding-arguments)
  4010. string (nth 1 org-agenda-overriding-arguments)
  4011. edit-at (nth 2 org-agenda-overriding-arguments)))
  4012. (let* ((props (list 'face nil
  4013. 'done-face 'org-agenda-done
  4014. 'org-not-done-regexp org-not-done-regexp
  4015. 'org-todo-regexp org-todo-regexp
  4016. 'org-complex-heading-regexp org-complex-heading-regexp
  4017. 'mouse-face 'highlight
  4018. 'help-echo (format "mouse-2 or RET jump to location")))
  4019. (full-words org-agenda-search-view-force-full-words)
  4020. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4021. regexp rtn rtnall files file pos inherited-tags
  4022. marker category level tags c neg re boolean
  4023. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4024. (unless (and (not edit-at)
  4025. (stringp string)
  4026. (string-match "\\S-" string))
  4027. (setq string (read-string
  4028. (if org-agenda-search-view-always-boolean
  4029. "[+-]Word/{Regexp} ...: "
  4030. "Phrase or [+-]Word/{Regexp} ...: ")
  4031. (cond
  4032. ((integerp edit-at) (cons string edit-at))
  4033. (edit-at string))
  4034. 'org-agenda-search-history)))
  4035. (catch 'exit
  4036. (if org-agenda-sticky
  4037. (setq org-agenda-buffer-name
  4038. (if (stringp string)
  4039. (format "*Org Agenda(%s:%s)*"
  4040. (or org-keys (or (and todo-only "S") "s")) string)
  4041. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4042. (org-agenda-prepare "SEARCH")
  4043. (org-compile-prefix-format 'search)
  4044. (org-set-sorting-strategy 'search)
  4045. (setq org-agenda-redo-command
  4046. (list 'org-search-view (if todo-only t nil)
  4047. (list 'if 'current-prefix-arg nil string)))
  4048. (setq org-agenda-query-string string)
  4049. (if (equal (string-to-char string) ?*)
  4050. (setq hdl-only t
  4051. words (substring string 1))
  4052. (setq words string))
  4053. (when (equal (string-to-char words) ?!)
  4054. (setq todo-only t
  4055. words (substring words 1)))
  4056. (when (equal (string-to-char words) ?:)
  4057. (setq full-words t
  4058. words (substring words 1)))
  4059. (if (or org-agenda-search-view-always-boolean
  4060. (member (string-to-char words) '(?- ?+ ?\{)))
  4061. (setq boolean t))
  4062. (setq words (split-string words))
  4063. (let (www w)
  4064. (while (setq w (pop words))
  4065. (while (and (string-match "\\\\\\'" w) words)
  4066. (setq w (concat (substring w 0 -1) " " (pop words))))
  4067. (push w www))
  4068. (setq words (nreverse www) www nil)
  4069. (while (setq w (pop words))
  4070. (when (and (string-match "\\`[-+]?{" w)
  4071. (not (string-match "}\\'" w)))
  4072. (while (and words (not (string-match "}\\'" (car words))))
  4073. (setq w (concat w " " (pop words))))
  4074. (setq w (concat w " " (pop words))))
  4075. (push w www))
  4076. (setq words (nreverse www)))
  4077. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4078. (when boolean
  4079. (let (wds w)
  4080. (while (setq w (pop words))
  4081. (if (or (equal (substring w 0 1) "\"")
  4082. (and (> (length w) 1)
  4083. (member (substring w 0 1) '("+" "-"))
  4084. (equal (substring w 1 2) "\"")))
  4085. (while (and words (not (equal (substring w -1) "\"")))
  4086. (setq w (concat w " " (pop words)))))
  4087. (and (string-match "\\`\\([-+]?\\)\"" w)
  4088. (setq w (replace-match "\\1" nil nil w)))
  4089. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4090. (push w wds))
  4091. (setq words (nreverse wds))))
  4092. (if boolean
  4093. (mapc (lambda (w)
  4094. (setq c (string-to-char w))
  4095. (if (equal c ?-)
  4096. (setq neg t w (substring w 1))
  4097. (if (equal c ?+)
  4098. (setq neg nil w (substring w 1))
  4099. (setq neg nil)))
  4100. (if (string-match "\\`{.*}\\'" w)
  4101. (setq re (substring w 1 -1))
  4102. (if full-words
  4103. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4104. (setq re (regexp-quote (downcase w)))))
  4105. (if neg (push re regexps-) (push re regexps+)))
  4106. words)
  4107. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4108. regexps+))
  4109. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4110. (if (not regexps+)
  4111. (setq regexp org-outline-regexp-bol)
  4112. (setq regexp (pop regexps+))
  4113. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4114. regexp))))
  4115. (setq files (org-agenda-files nil 'ifmode))
  4116. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4117. ;; restriction.
  4118. (unless (get 'org-agenda-files 'org-restrict)
  4119. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4120. (pop org-agenda-text-search-extra-files)
  4121. (setq files (org-add-archive-files files))))
  4122. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4123. ;; non-existent ones.
  4124. (setq files (cl-remove-duplicates
  4125. (append files org-agenda-text-search-extra-files)
  4126. :test (lambda (a b)
  4127. (and (file-exists-p a)
  4128. (file-exists-p b)
  4129. (file-equal-p a b))))
  4130. rtnall nil)
  4131. (while (setq file (pop files))
  4132. (setq ee nil)
  4133. (catch 'nextfile
  4134. (org-check-agenda-file file)
  4135. (setq buffer (if (file-exists-p file)
  4136. (org-get-agenda-file-buffer file)
  4137. (error "No such file %s" file)))
  4138. (if (not buffer)
  4139. ;; If file does not exist, make sure an error message is sent
  4140. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4141. file))))
  4142. (with-current-buffer buffer
  4143. (with-syntax-table (org-search-syntax-table)
  4144. (unless (derived-mode-p 'org-mode)
  4145. (error "Agenda file %s is not in Org mode" file))
  4146. (let ((case-fold-search t))
  4147. (save-excursion
  4148. (save-restriction
  4149. (if (eq buffer org-agenda-restrict)
  4150. (narrow-to-region org-agenda-restrict-begin
  4151. org-agenda-restrict-end)
  4152. (widen))
  4153. (goto-char (point-min))
  4154. (unless (or (org-at-heading-p)
  4155. (outline-next-heading))
  4156. (throw 'nextfile t))
  4157. (goto-char (max (point-min) (1- (point))))
  4158. (while (re-search-forward regexp nil t)
  4159. (org-back-to-heading t)
  4160. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4161. (> (org-reduced-level (org-outline-level))
  4162. org-agenda-search-view-max-outline-level)
  4163. (forward-line -1)
  4164. (org-back-to-heading t)))
  4165. (skip-chars-forward "* ")
  4166. (setq beg (point-at-bol)
  4167. beg1 (point)
  4168. end (progn
  4169. (outline-next-heading)
  4170. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4171. (> (org-reduced-level (org-outline-level))
  4172. org-agenda-search-view-max-outline-level)
  4173. (forward-line 1)
  4174. (outline-next-heading)))
  4175. (point)))
  4176. (catch :skip
  4177. (goto-char beg)
  4178. (org-agenda-skip)
  4179. (setq str (buffer-substring-no-properties
  4180. (point-at-bol)
  4181. (if hdl-only (point-at-eol) end)))
  4182. (mapc (lambda (wr) (when (string-match wr str)
  4183. (goto-char (1- end))
  4184. (throw :skip t)))
  4185. regexps-)
  4186. (mapc (lambda (wr) (unless (string-match wr str)
  4187. (goto-char (1- end))
  4188. (throw :skip t)))
  4189. (if todo-only
  4190. (cons (concat "^\\*+[ \t]+"
  4191. org-not-done-regexp)
  4192. regexps+)
  4193. regexps+))
  4194. (goto-char beg)
  4195. (setq marker (org-agenda-new-marker (point))
  4196. category (org-get-category)
  4197. level (make-string (org-reduced-level (org-outline-level)) ? )
  4198. inherited-tags
  4199. (or (eq org-agenda-show-inherited-tags 'always)
  4200. (and (listp org-agenda-show-inherited-tags)
  4201. (memq 'todo org-agenda-show-inherited-tags))
  4202. (and (eq org-agenda-show-inherited-tags t)
  4203. (or (eq org-agenda-use-tag-inheritance t)
  4204. (memq 'todo org-agenda-use-tag-inheritance))))
  4205. tags (org-get-tags nil (not inherited-tags))
  4206. txt (org-agenda-format-item
  4207. ""
  4208. (buffer-substring-no-properties
  4209. beg1 (point-at-eol))
  4210. level category tags t))
  4211. (org-add-props txt props
  4212. 'org-marker marker 'org-hd-marker marker
  4213. 'org-todo-regexp org-todo-regexp
  4214. 'level level
  4215. 'org-complex-heading-regexp org-complex-heading-regexp
  4216. 'priority 1000
  4217. 'type "search")
  4218. (push txt ee)
  4219. (goto-char (1- end))))))))))
  4220. (setq rtn (nreverse ee))
  4221. (setq rtnall (append rtnall rtn)))
  4222. (org-agenda--insert-overriding-header
  4223. (with-temp-buffer
  4224. (insert "Search words: ")
  4225. (add-text-properties (point-min) (1- (point))
  4226. (list 'face 'org-agenda-structure))
  4227. (setq pos (point))
  4228. (insert string "\n")
  4229. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4230. (setq pos (point))
  4231. (unless org-agenda-multi
  4232. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4233. Press `\\[org-agenda-manipulate-query-add]', \
  4234. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4235. `\\[org-agenda-manipulate-query-add-re]', \
  4236. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4237. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4238. (add-text-properties pos (1- (point))
  4239. (list 'face 'org-agenda-structure)))
  4240. (buffer-string)))
  4241. (org-agenda-mark-header-line (point-min))
  4242. (when rtnall
  4243. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4244. (goto-char (point-min))
  4245. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4246. (add-text-properties (point-min) (point-max)
  4247. `(org-agenda-type search
  4248. org-last-args (,todo-only ,string ,edit-at)
  4249. org-redo-cmd ,org-agenda-redo-command
  4250. org-series-cmd ,org-cmd))
  4251. (org-agenda-finalize)
  4252. (setq buffer-read-only t))))
  4253. ;;; Agenda TODO list
  4254. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4255. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4256. (concat
  4257. (if (or (equal keywords "ALL") (not keywords))
  4258. (propertize "ALL" 'face 'warning)
  4259. (mapconcat
  4260. (lambda (kw)
  4261. (propertize kw 'face (org-get-todo-face kw)))
  4262. (org-split-string keywords "|")
  4263. "|"))
  4264. "\n"))
  4265. (defvar org-select-this-todo-keyword nil)
  4266. (defvar org-last-arg nil)
  4267. ;;;###autoload
  4268. (defun org-todo-list (&optional arg)
  4269. "Show all (not done) TODO entries from all agenda file in a single list.
  4270. The prefix arg can be used to select a specific TODO keyword and limit
  4271. the list to these. When using `\\[universal-argument]', you will be prompted
  4272. for a keyword. A numeric prefix directly selects the Nth keyword in
  4273. `org-todo-keywords-1'."
  4274. (interactive "P")
  4275. (if org-agenda-overriding-arguments
  4276. (setq arg org-agenda-overriding-arguments))
  4277. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4278. (let* ((today (org-today))
  4279. (date (calendar-gregorian-from-absolute today))
  4280. (kwds org-todo-keywords-for-agenda)
  4281. (completion-ignore-case t)
  4282. (org-select-this-todo-keyword
  4283. (if (stringp arg) arg
  4284. (and arg (integerp arg) (> arg 0)
  4285. (nth (1- arg) kwds))))
  4286. rtn rtnall files file pos)
  4287. (when (equal arg '(4))
  4288. (setq org-select-this-todo-keyword
  4289. (completing-read "Keyword (or KWD1|K2D2|...): "
  4290. (mapcar #'list kwds) nil nil)))
  4291. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4292. (catch 'exit
  4293. (if org-agenda-sticky
  4294. (setq org-agenda-buffer-name
  4295. (if (stringp org-select-this-todo-keyword)
  4296. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4297. org-select-this-todo-keyword)
  4298. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4299. (org-agenda-prepare "TODO")
  4300. (org-compile-prefix-format 'todo)
  4301. (org-set-sorting-strategy 'todo)
  4302. (setq org-agenda-redo-command
  4303. `(org-todo-list (or (and (numberp current-prefix-arg)
  4304. current-prefix-arg)
  4305. ,org-select-this-todo-keyword
  4306. current-prefix-arg ,arg)))
  4307. (setq files (org-agenda-files nil 'ifmode)
  4308. rtnall nil)
  4309. (while (setq file (pop files))
  4310. (catch 'nextfile
  4311. (org-check-agenda-file file)
  4312. (setq rtn (org-agenda-get-day-entries file date :todo))
  4313. (setq rtnall (append rtnall rtn))))
  4314. (org-agenda--insert-overriding-header
  4315. (with-temp-buffer
  4316. (insert "Global list of TODO items of type: ")
  4317. (add-text-properties (point-min) (1- (point))
  4318. (list 'face 'org-agenda-structure
  4319. 'short-heading
  4320. (concat "ToDo: "
  4321. (or org-select-this-todo-keyword "ALL"))))
  4322. (org-agenda-mark-header-line (point-min))
  4323. (insert (org-agenda-propertize-selected-todo-keywords
  4324. org-select-this-todo-keyword))
  4325. (setq pos (point))
  4326. (unless org-agenda-multi
  4327. (insert (substitute-command-keys "Available with \
  4328. \\<org-agenda-mode-map>`N \\[org-agenda-redo]': (0)[ALL]"))
  4329. (let ((n 0))
  4330. (dolist (k kwds)
  4331. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4332. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4333. (insert "\n "))
  4334. (insert " " s))))
  4335. (insert "\n"))
  4336. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4337. (buffer-string)))
  4338. (org-agenda-mark-header-line (point-min))
  4339. (when rtnall
  4340. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4341. (goto-char (point-min))
  4342. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4343. (add-text-properties (point-min) (point-max)
  4344. `(org-agenda-type todo
  4345. org-last-args ,arg
  4346. org-redo-cmd ,org-agenda-redo-command
  4347. org-series-cmd ,org-cmd))
  4348. (org-agenda-finalize)
  4349. (setq buffer-read-only t))))
  4350. ;;; Agenda tags match
  4351. ;;;###autoload
  4352. (defun org-tags-view (&optional todo-only match)
  4353. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4354. The prefix arg TODO-ONLY limits the search to TODO entries."
  4355. (interactive "P")
  4356. (if org-agenda-overriding-arguments
  4357. (setq todo-only (car org-agenda-overriding-arguments)
  4358. match (nth 1 org-agenda-overriding-arguments)))
  4359. (let* ((org-tags-match-list-sublevels
  4360. org-tags-match-list-sublevels)
  4361. (completion-ignore-case t)
  4362. (org--matcher-tags-todo-only todo-only)
  4363. rtn rtnall files file pos matcher
  4364. buffer)
  4365. (when (and (stringp match) (not (string-match "\\S-" match)))
  4366. (setq match nil))
  4367. (catch 'exit
  4368. (if org-agenda-sticky
  4369. (setq org-agenda-buffer-name
  4370. (if (stringp match)
  4371. (format "*Org Agenda(%s:%s)*"
  4372. (or org-keys (or (and todo-only "M") "m")) match)
  4373. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4374. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4375. ;; expanding tags within `org-make-tags-matcher'
  4376. (org-agenda-prepare (concat "TAGS " match))
  4377. (setq matcher (org-make-tags-matcher match)
  4378. match (car matcher)
  4379. matcher (cdr matcher))
  4380. (org-compile-prefix-format 'tags)
  4381. (org-set-sorting-strategy 'tags)
  4382. (setq org-agenda-query-string match)
  4383. (setq org-agenda-redo-command
  4384. (list 'org-tags-view
  4385. `(quote ,org--matcher-tags-todo-only)
  4386. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4387. (setq files (org-agenda-files nil 'ifmode)
  4388. rtnall nil)
  4389. (while (setq file (pop files))
  4390. (catch 'nextfile
  4391. (org-check-agenda-file file)
  4392. (setq buffer (if (file-exists-p file)
  4393. (org-get-agenda-file-buffer file)
  4394. (error "No such file %s" file)))
  4395. (if (not buffer)
  4396. ;; If file does not exist, error message to agenda
  4397. (setq rtn (list
  4398. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4399. rtnall (append rtnall rtn))
  4400. (with-current-buffer buffer
  4401. (unless (derived-mode-p 'org-mode)
  4402. (error "Agenda file %s is not in Org mode" file))
  4403. (save-excursion
  4404. (save-restriction
  4405. (if (eq buffer org-agenda-restrict)
  4406. (narrow-to-region org-agenda-restrict-begin
  4407. org-agenda-restrict-end)
  4408. (widen))
  4409. (setq rtn (org-scan-tags 'agenda
  4410. matcher
  4411. org--matcher-tags-todo-only))
  4412. (setq rtnall (append rtnall rtn))))))))
  4413. (org-agenda--insert-overriding-header
  4414. (with-temp-buffer
  4415. (insert "Headlines with TAGS match: ")
  4416. (add-text-properties (point-min) (1- (point))
  4417. (list 'face 'org-agenda-structure
  4418. 'short-heading
  4419. (concat "Match: " match)))
  4420. (setq pos (point))
  4421. (insert match "\n")
  4422. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4423. (setq pos (point))
  4424. (unless org-agenda-multi
  4425. (insert (substitute-command-keys
  4426. "Press \
  4427. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4428. to search again with new search string\n")))
  4429. (add-text-properties pos (1- (point))
  4430. (list 'face 'org-agenda-structure))
  4431. (buffer-string)))
  4432. (org-agenda-mark-header-line (point-min))
  4433. (when rtnall
  4434. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4435. (goto-char (point-min))
  4436. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4437. (add-text-properties
  4438. (point-min) (point-max)
  4439. `(org-agenda-type tags
  4440. org-last-args (,org--matcher-tags-todo-only ,match)
  4441. org-redo-cmd ,org-agenda-redo-command
  4442. org-series-cmd ,org-cmd))
  4443. (org-agenda-finalize)
  4444. (setq buffer-read-only t))))
  4445. ;;; Agenda Finding stuck projects
  4446. (defvar org-agenda-skip-regexp nil
  4447. "Regular expression used in skipping subtrees for the agenda.
  4448. This is basically a temporary global variable that can be set and then
  4449. used by user-defined selections using `org-agenda-skip-function'.")
  4450. (defvar org-agenda-overriding-header nil
  4451. "When set during agenda, todo and tags searches it replaces the header.
  4452. If an empty string, no header will be inserted. If any other
  4453. string, it will be inserted as a header. If nil, a header will
  4454. be generated automatically according to the command. This
  4455. variable should not be set directly, but custom commands can bind
  4456. it in the options section.")
  4457. (defun org-agenda-skip-entry-if (&rest conditions)
  4458. "Skip entry if any of CONDITIONS is true.
  4459. See `org-agenda-skip-if' for details."
  4460. (org-agenda-skip-if nil conditions))
  4461. (defun org-agenda-skip-subtree-if (&rest conditions)
  4462. "Skip subtree if any of CONDITIONS is true.
  4463. See `org-agenda-skip-if' for details."
  4464. (org-agenda-skip-if t conditions))
  4465. (defun org-agenda-skip-if (subtree conditions)
  4466. "Checks current entity for CONDITIONS.
  4467. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4468. the entry (i.e. the text before the next heading) is checked.
  4469. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4470. from different tests. Valid conditions are:
  4471. scheduled Check if there is a scheduled cookie
  4472. notscheduled Check if there is no scheduled cookie
  4473. deadline Check if there is a deadline
  4474. notdeadline Check if there is no deadline
  4475. timestamp Check if there is a timestamp (also deadline or scheduled)
  4476. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4477. regexp Check if regexp matches
  4478. notregexp Check if regexp does not match.
  4479. todo Check if TODO keyword matches
  4480. nottodo Check if TODO keyword does not match
  4481. The regexp is taken from the conditions list, it must come right after
  4482. the `regexp' or `notregexp' element.
  4483. `todo' and `nottodo' accept as an argument a list of todo
  4484. keywords, which may include \"*\" to match any todo keyword.
  4485. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4486. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4487. Instead of a list, a keyword class may be given. For example:
  4488. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4489. would skip entries that haven't been marked with any of \"DONE\"
  4490. keywords. Possible classes are: `todo', `done', `any'.
  4491. If any of these conditions is met, this function returns the end point of
  4492. the entity, causing the search to continue from there. This is a function
  4493. that can be put into `org-agenda-skip-function' for the duration of a command."
  4494. (org-back-to-heading t)
  4495. (let* ((beg (point))
  4496. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4497. (org-entry-end-position)))
  4498. (planning-end (if subtree end (line-end-position 2)))
  4499. m)
  4500. (and
  4501. (or (and (memq 'scheduled conditions)
  4502. (re-search-forward org-scheduled-time-regexp planning-end t))
  4503. (and (memq 'notscheduled conditions)
  4504. (not
  4505. (save-excursion
  4506. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4507. (and (memq 'deadline conditions)
  4508. (re-search-forward org-deadline-time-regexp planning-end t))
  4509. (and (memq 'notdeadline conditions)
  4510. (not
  4511. (save-excursion
  4512. (re-search-forward org-deadline-time-regexp planning-end t))))
  4513. (and (memq 'timestamp conditions)
  4514. (re-search-forward org-ts-regexp end t))
  4515. (and (memq 'nottimestamp conditions)
  4516. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4517. (and (setq m (memq 'regexp conditions))
  4518. (stringp (nth 1 m))
  4519. (re-search-forward (nth 1 m) end t))
  4520. (and (setq m (memq 'notregexp conditions))
  4521. (stringp (nth 1 m))
  4522. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4523. (and (or
  4524. (setq m (memq 'nottodo conditions))
  4525. (setq m (memq 'todo-unblocked conditions))
  4526. (setq m (memq 'nottodo-unblocked conditions))
  4527. (setq m (memq 'todo conditions)))
  4528. (org-agenda-skip-if-todo m end)))
  4529. end)))
  4530. (defun org-agenda-skip-if-todo (args end)
  4531. "Helper function for `org-agenda-skip-if', do not use it directly.
  4532. ARGS is a list with first element either `todo', `nottodo',
  4533. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4534. a list of TODO keywords, or a state symbol `todo' or `done' or
  4535. `any'."
  4536. (let ((todo-re
  4537. (concat "^\\*+[ \t]+"
  4538. (regexp-opt
  4539. (pcase args
  4540. (`(,_ todo)
  4541. (org-delete-all org-done-keywords
  4542. (copy-sequence org-todo-keywords-1)))
  4543. (`(,_ done) org-done-keywords)
  4544. (`(,_ any) org-todo-keywords-1)
  4545. (`(,_ ,(pred atom))
  4546. (error "Invalid TODO class or type: %S" args))
  4547. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4548. (`(,_ ,todo-list) todo-list))
  4549. 'words))))
  4550. (pcase args
  4551. (`(todo . ,_)
  4552. (let (case-fold-search) (re-search-forward todo-re end t)))
  4553. (`(nottodo . ,_)
  4554. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4555. (`(todo-unblocked . ,_)
  4556. (catch :unblocked
  4557. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4558. (when (org-entry-blocked-p) (throw :unblocked t)))
  4559. nil))
  4560. (`(nottodo-unblocked . ,_)
  4561. (catch :unblocked
  4562. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4563. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4564. t))
  4565. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4566. ;;;###autoload
  4567. (defun org-agenda-list-stuck-projects (&rest ignore)
  4568. "Create agenda view for projects that are stuck.
  4569. Stuck projects are project that have no next actions. For the definitions
  4570. of what a project is and how to check if it stuck, customize the variable
  4571. `org-stuck-projects'."
  4572. (interactive)
  4573. (let* ((org-agenda-overriding-header
  4574. (or org-agenda-overriding-header "List of stuck projects: "))
  4575. (matcher (nth 0 org-stuck-projects))
  4576. (todo (nth 1 org-stuck-projects))
  4577. (tags (nth 2 org-stuck-projects))
  4578. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4579. (todo-wds
  4580. (if (not (member "*" todo)) todo
  4581. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4582. (org-delete-all org-done-keywords-for-agenda
  4583. (copy-sequence org-todo-keywords-for-agenda))))
  4584. (todo-re (and todo
  4585. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4586. (mapconcat #'identity todo-wds "\\|"))))
  4587. (tags-re (cond ((null tags) nil)
  4588. ((member "*" tags)
  4589. (eval-when-compile
  4590. (concat org-outline-regexp-bol
  4591. ".*:[[:alnum:]_@#%]+:[ \t]*$")))
  4592. (tags (concat org-outline-regexp-bol
  4593. ".*:\\("
  4594. (mapconcat #'identity tags "\\|")
  4595. "\\):[[:alnum:]_@#%:]*[ \t]*$"))
  4596. (t nil)))
  4597. (re-list (delq nil (list todo-re tags-re gen-re)))
  4598. (skip-re
  4599. (if (null re-list)
  4600. (error "Missing information to identify unstuck projects")
  4601. (mapconcat #'identity re-list "\\|")))
  4602. (org-agenda-skip-function
  4603. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4604. ;; in the subtree.
  4605. `(lambda ()
  4606. (and (save-excursion
  4607. (let ((case-fold-search nil))
  4608. (re-search-forward
  4609. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4610. (progn (outline-next-heading) (point))))))
  4611. (org-tags-view nil matcher)
  4612. (setq org-agenda-buffer-name (buffer-name))
  4613. (with-current-buffer org-agenda-buffer-name
  4614. (setq org-agenda-redo-command
  4615. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4616. (let ((inhibit-read-only t))
  4617. (add-text-properties
  4618. (point-min) (point-max)
  4619. `(org-redo-cmd ,org-agenda-redo-command))))))
  4620. ;;; Diary integration
  4621. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4622. (defvar diary-list-entries-hook)
  4623. (defvar diary-time-regexp)
  4624. (defun org-get-entries-from-diary (date)
  4625. "Get the (Emacs Calendar) diary entries for DATE."
  4626. (require 'diary-lib)
  4627. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4628. (diary-display-function 'diary-fancy-display)
  4629. (pop-up-frames nil)
  4630. (diary-list-entries-hook
  4631. (cons 'org-diary-default-entry diary-list-entries-hook))
  4632. (diary-file-name-prefix nil) ; turn this feature off
  4633. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4634. entries
  4635. (org-disable-agenda-to-diary t))
  4636. (save-excursion
  4637. (save-window-excursion
  4638. (funcall (if (fboundp 'diary-list-entries)
  4639. 'diary-list-entries 'list-diary-entries)
  4640. date 1)))
  4641. (if (not (get-buffer diary-fancy-buffer))
  4642. (setq entries nil)
  4643. (with-current-buffer diary-fancy-buffer
  4644. (setq buffer-read-only nil)
  4645. (if (zerop (buffer-size))
  4646. ;; No entries
  4647. (setq entries nil)
  4648. ;; Omit the date and other unnecessary stuff
  4649. (org-agenda-cleanup-fancy-diary)
  4650. ;; Add prefix to each line and extend the text properties
  4651. (if (zerop (buffer-size))
  4652. (setq entries nil)
  4653. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4654. (setq entries
  4655. (with-temp-buffer
  4656. (insert entries) (goto-char (point-min))
  4657. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4658. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4659. (replace-match (concat "; " (match-string 1)))))
  4660. (buffer-string)))))
  4661. (set-buffer-modified-p nil)
  4662. (kill-buffer diary-fancy-buffer)))
  4663. (when entries
  4664. (setq entries (org-split-string entries "\n"))
  4665. (setq entries
  4666. (mapcar
  4667. (lambda (x)
  4668. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4669. ;; Extend the text properties to the beginning of the line
  4670. (org-add-props x (text-properties-at (1- (length x)) x)
  4671. 'type "diary" 'date date 'face 'org-agenda-diary))
  4672. entries)))))
  4673. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4674. "Hook run when the fancy diary buffer is cleaned up.")
  4675. (defun org-agenda-cleanup-fancy-diary ()
  4676. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4677. This gets rid of the date, the underline under the date, and the
  4678. dummy entry installed by Org mode to ensure non-empty diary for
  4679. each date. It also removes lines that contain only whitespace."
  4680. (goto-char (point-min))
  4681. (if (looking-at ".*?:[ \t]*")
  4682. (progn
  4683. (replace-match "")
  4684. (re-search-forward "\n=+$" nil t)
  4685. (replace-match "")
  4686. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4687. (re-search-forward "\n=+$" nil t)
  4688. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4689. (goto-char (point-min))
  4690. (while (re-search-forward "^ +\n" nil t)
  4691. (replace-match ""))
  4692. (goto-char (point-min))
  4693. (if (re-search-forward "^Org mode dummy\n?" nil t)
  4694. (replace-match ""))
  4695. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4696. ;; Make sure entries from the diary have the right text properties.
  4697. (eval-after-load "diary-lib"
  4698. '(if (boundp 'diary-modify-entry-list-string-function)
  4699. ;; We can rely on the hook, nothing to do
  4700. nil
  4701. ;; Hook not available, must use advice to make this work
  4702. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4703. "Make the position visible."
  4704. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4705. (stringp string)
  4706. buffer-file-name)
  4707. (setq string (org-modify-diary-entry-string string))))))
  4708. (defun org-modify-diary-entry-string (string)
  4709. "Add text properties to string, allowing Org to act on it."
  4710. (org-add-props string nil
  4711. 'mouse-face 'highlight
  4712. 'help-echo (if buffer-file-name
  4713. (format "mouse-2 or RET jump to diary file %s"
  4714. (abbreviate-file-name buffer-file-name))
  4715. "")
  4716. 'org-agenda-diary-link t
  4717. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4718. (defun org-diary-default-entry ()
  4719. "Add a dummy entry to the diary.
  4720. Needed to avoid empty dates which mess up holiday display."
  4721. ;; Catch the error if dealing with the new add-to-diary-alist
  4722. (when org-disable-agenda-to-diary
  4723. (condition-case nil
  4724. (org-add-to-diary-list original-date "Org mode dummy" "")
  4725. (error
  4726. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4727. (defun org-add-to-diary-list (&rest args)
  4728. (if (fboundp 'diary-add-to-list)
  4729. (apply 'diary-add-to-list args)
  4730. (apply 'add-to-diary-list args)))
  4731. (defvar org-diary-last-run-time nil)
  4732. ;;;###autoload
  4733. (defun org-diary (&rest args)
  4734. "Return diary information from org files.
  4735. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4736. It accesses org files and extracts information from those files to be
  4737. listed in the diary. The function accepts arguments specifying what
  4738. items should be listed. For a list of arguments allowed here, see the
  4739. variable `org-agenda-entry-types'.
  4740. The call in the diary file should look like this:
  4741. &%%(org-diary) ~/path/to/some/orgfile.org
  4742. Use a separate line for each org file to check. Or, if you omit the file name,
  4743. all files listed in `org-agenda-files' will be checked automatically:
  4744. &%%(org-diary)
  4745. If you don't give any arguments (as in the example above), the default value
  4746. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4747. So the example above may also be written as
  4748. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4749. The function expects the lisp variables `entry' and `date' to be provided
  4750. by the caller, because this is how the calendar works. Don't use this
  4751. function from a program - use `org-agenda-get-day-entries' instead."
  4752. (when (> (- (float-time)
  4753. org-agenda-last-marker-time)
  4754. 5)
  4755. ;; I am not sure if this works with sticky agendas, because the marker
  4756. ;; list is then no longer a global variable.
  4757. (org-agenda-reset-markers))
  4758. (org-compile-prefix-format 'agenda)
  4759. (org-set-sorting-strategy 'agenda)
  4760. (setq args (or args org-agenda-entry-types))
  4761. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4762. (list entry)
  4763. (org-agenda-files t)))
  4764. (time (float-time))
  4765. file rtn results)
  4766. (when (or (not org-diary-last-run-time)
  4767. (> (- time
  4768. org-diary-last-run-time)
  4769. 3))
  4770. (org-agenda-prepare-buffers files))
  4771. (setq org-diary-last-run-time time)
  4772. ;; If this is called during org-agenda, don't return any entries to
  4773. ;; the calendar. Org Agenda will list these entries itself.
  4774. (if org-disable-agenda-to-diary (setq files nil))
  4775. (while (setq file (pop files))
  4776. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4777. (setq results (append results rtn)))
  4778. (when results
  4779. (setq results
  4780. (mapcar (lambda (i) (replace-regexp-in-string
  4781. org-bracket-link-regexp "\\3" i)) results))
  4782. (concat (org-agenda-finalize-entries results) "\n"))))
  4783. ;;; Agenda entry finders
  4784. (defun org-agenda--timestamp-to-absolute (&rest args)
  4785. "Call `org-time-string-to-absolute' with ARGS.
  4786. However, throw `:skip' whenever an error is raised."
  4787. (condition-case e
  4788. (apply #'org-time-string-to-absolute args)
  4789. (org-diary-sexp-no-match (throw :skip nil))
  4790. (error
  4791. (message "%s; Skipping entry" (error-message-string e))
  4792. (throw :skip nil))))
  4793. (defun org-agenda-get-day-entries (file date &rest args)
  4794. "Does the work for `org-diary' and `org-agenda'.
  4795. FILE is the path to a file to be checked for entries. DATE is date like
  4796. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4797. which kind of entries should be extracted. For details about these, see
  4798. the documentation of `org-diary'."
  4799. (let* ((org-startup-folded nil)
  4800. (org-startup-align-all-tables nil)
  4801. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4802. (error "No such file %s" file))))
  4803. (if (not buffer)
  4804. ;; If file does not exist, signal it in diary nonetheless.
  4805. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4806. (with-current-buffer buffer
  4807. (unless (derived-mode-p 'org-mode)
  4808. (error "Agenda file %s is not in Org mode" file))
  4809. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4810. (setf org-agenda-current-date date)
  4811. (save-excursion
  4812. (save-restriction
  4813. (if (eq buffer org-agenda-restrict)
  4814. (narrow-to-region org-agenda-restrict-begin
  4815. org-agenda-restrict-end)
  4816. (widen))
  4817. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4818. ;; first in order to populate DEADLINES before passing it.
  4819. ;;
  4820. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4821. ;; guarding us from modifying `org-agenda-entry-types'.
  4822. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4823. (when (and (memq :scheduled args) (memq :scheduled* args))
  4824. (setf args (delq :scheduled* args)))
  4825. (cond
  4826. ((memq :deadline args)
  4827. (setf args (cons :deadline
  4828. (delq :deadline (delq :deadline* args)))))
  4829. ((memq :deadline* args)
  4830. (setf args (cons :deadline* (delq :deadline* args)))))
  4831. ;; Collect list of headlines. Return them flattened.
  4832. (let ((case-fold-search nil) results deadlines)
  4833. (dolist (arg args (apply #'nconc (nreverse results)))
  4834. (pcase arg
  4835. ((and :todo (guard (org-agenda-today-p date)))
  4836. (push (org-agenda-get-todos) results))
  4837. (:timestamp
  4838. (push (org-agenda-get-blocks) results)
  4839. (push (org-agenda-get-timestamps deadlines) results))
  4840. (:sexp
  4841. (push (org-agenda-get-sexps) results))
  4842. (:scheduled
  4843. (push (org-agenda-get-scheduled deadlines) results))
  4844. (:scheduled*
  4845. (push (org-agenda-get-scheduled deadlines t) results))
  4846. (:closed
  4847. (push (org-agenda-get-progress) results))
  4848. (:deadline
  4849. (setf deadlines (org-agenda-get-deadlines))
  4850. (push deadlines results))
  4851. (:deadline*
  4852. (setf deadlines (org-agenda-get-deadlines t))
  4853. (push deadlines results)))))))))))
  4854. (defsubst org-em (x y list)
  4855. "Is X or Y a member of LIST?"
  4856. (or (memq x list) (memq y list)))
  4857. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4858. (defvar org-agenda-sorting-strategy-selected nil)
  4859. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4860. "Retrieve timestamp information for sorting agenda views.
  4861. Given a point or marker POM, returns a cons cell of the timestamp
  4862. and the timestamp type relevant for the sorting strategy in
  4863. `org-agenda-sorting-strategy-selected'."
  4864. (let (ts ts-date-type)
  4865. (save-match-data
  4866. (cond ((org-em 'scheduled-up 'scheduled-down
  4867. org-agenda-sorting-strategy-selected)
  4868. (setq ts (org-entry-get pom "SCHEDULED")
  4869. ts-date-type " scheduled"))
  4870. ((org-em 'deadline-up 'deadline-down
  4871. org-agenda-sorting-strategy-selected)
  4872. (setq ts (org-entry-get pom "DEADLINE")
  4873. ts-date-type " deadline"))
  4874. ((org-em 'ts-up 'ts-down
  4875. org-agenda-sorting-strategy-selected)
  4876. (setq ts (org-entry-get pom "TIMESTAMP")
  4877. ts-date-type " timestamp"))
  4878. ((org-em 'tsia-up 'tsia-down
  4879. org-agenda-sorting-strategy-selected)
  4880. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4881. ts-date-type " timestamp_ia"))
  4882. ((org-em 'timestamp-up 'timestamp-down
  4883. org-agenda-sorting-strategy-selected)
  4884. (setq ts (or (org-entry-get pom "SCHEDULED")
  4885. (org-entry-get pom "DEADLINE")
  4886. (org-entry-get pom "TIMESTAMP")
  4887. (org-entry-get pom "TIMESTAMP_IA"))
  4888. ts-date-type ""))
  4889. (t (setq ts-date-type "")))
  4890. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4891. ts-date-type))))
  4892. (defun org-agenda-get-todos ()
  4893. "Return the TODO information for agenda display."
  4894. (let* ((props (list 'face nil
  4895. 'done-face 'org-agenda-done
  4896. 'org-not-done-regexp org-not-done-regexp
  4897. 'org-todo-regexp org-todo-regexp
  4898. 'org-complex-heading-regexp org-complex-heading-regexp
  4899. 'mouse-face 'highlight
  4900. 'help-echo
  4901. (format "mouse-2 or RET jump to org file %s"
  4902. (abbreviate-file-name buffer-file-name))))
  4903. (case-fold-search nil)
  4904. (regexp (format org-heading-keyword-regexp-format
  4905. (cond
  4906. ((and org-select-this-todo-keyword
  4907. (equal org-select-this-todo-keyword "*"))
  4908. org-todo-regexp)
  4909. (org-select-this-todo-keyword
  4910. (concat "\\("
  4911. (mapconcat 'identity
  4912. (org-split-string
  4913. org-select-this-todo-keyword
  4914. "|")
  4915. "\\|") "\\)"))
  4916. (t org-not-done-regexp))))
  4917. marker priority category level tags todo-state
  4918. ts-date ts-date-type ts-date-pair
  4919. ee txt beg end inherited-tags todo-state-end-pos)
  4920. (goto-char (point-min))
  4921. (while (re-search-forward regexp nil t)
  4922. (catch :skip
  4923. (save-match-data
  4924. (beginning-of-line)
  4925. (org-agenda-skip)
  4926. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4927. (unless (and (setq todo-state (org-get-todo-state))
  4928. (setq todo-state-end-pos (match-end 2)))
  4929. (goto-char end)
  4930. (throw :skip nil))
  4931. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4932. (goto-char (1+ beg))
  4933. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4934. (throw :skip nil)))
  4935. (goto-char (match-beginning 2))
  4936. (setq marker (org-agenda-new-marker (match-beginning 0))
  4937. category (org-get-category)
  4938. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4939. ts-date (car ts-date-pair)
  4940. ts-date-type (cdr ts-date-pair)
  4941. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4942. inherited-tags
  4943. (or (eq org-agenda-show-inherited-tags 'always)
  4944. (and (listp org-agenda-show-inherited-tags)
  4945. (memq 'todo org-agenda-show-inherited-tags))
  4946. (and (eq org-agenda-show-inherited-tags t)
  4947. (or (eq org-agenda-use-tag-inheritance t)
  4948. (memq 'todo org-agenda-use-tag-inheritance))))
  4949. tags (org-get-tags nil (not inherited-tags))
  4950. level (make-string (org-reduced-level (org-outline-level)) ? )
  4951. txt (org-agenda-format-item "" txt level category tags t)
  4952. priority (1+ (org-get-priority txt)))
  4953. (org-add-props txt props
  4954. 'org-marker marker 'org-hd-marker marker
  4955. 'priority priority
  4956. 'level level
  4957. 'ts-date ts-date
  4958. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4959. (push txt ee)
  4960. (if org-agenda-todo-list-sublevels
  4961. (goto-char todo-state-end-pos)
  4962. (org-end-of-subtree 'invisible))))
  4963. (nreverse ee)))
  4964. (defun org-agenda-todo-custom-ignore-p (time n)
  4965. "Check whether timestamp is farther away than n number of days.
  4966. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4967. `org-agenda-todo-ignore-scheduled' or
  4968. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4969. (let ((days (org-time-stamp-to-now
  4970. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4971. (if (>= n 0)
  4972. (>= days n)
  4973. (<= days n))))
  4974. ;;;###autoload
  4975. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4976. (&optional end)
  4977. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4978. (when (or org-agenda-todo-ignore-with-date
  4979. org-agenda-todo-ignore-scheduled
  4980. org-agenda-todo-ignore-deadlines
  4981. org-agenda-todo-ignore-timestamp)
  4982. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4983. (save-excursion
  4984. (or (and org-agenda-todo-ignore-with-date
  4985. (re-search-forward org-ts-regexp end t))
  4986. (and org-agenda-todo-ignore-scheduled
  4987. (re-search-forward org-scheduled-time-regexp end t)
  4988. (cond
  4989. ((eq org-agenda-todo-ignore-scheduled 'future)
  4990. (> (org-time-stamp-to-now
  4991. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4992. ((eq org-agenda-todo-ignore-scheduled 'past)
  4993. (<= (org-time-stamp-to-now
  4994. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4995. ((numberp org-agenda-todo-ignore-scheduled)
  4996. (org-agenda-todo-custom-ignore-p
  4997. (match-string 1) org-agenda-todo-ignore-scheduled))
  4998. (t)))
  4999. (and org-agenda-todo-ignore-deadlines
  5000. (re-search-forward org-deadline-time-regexp end t)
  5001. (cond
  5002. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5003. ((eq org-agenda-todo-ignore-deadlines 'far)
  5004. (not (org-deadline-close-p (match-string 1))))
  5005. ((eq org-agenda-todo-ignore-deadlines 'future)
  5006. (> (org-time-stamp-to-now
  5007. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5008. ((eq org-agenda-todo-ignore-deadlines 'past)
  5009. (<= (org-time-stamp-to-now
  5010. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5011. ((numberp org-agenda-todo-ignore-deadlines)
  5012. (org-agenda-todo-custom-ignore-p
  5013. (match-string 1) org-agenda-todo-ignore-deadlines))
  5014. (t (org-deadline-close-p (match-string 1)))))
  5015. (and org-agenda-todo-ignore-timestamp
  5016. (let ((buffer (current-buffer))
  5017. (regexp
  5018. (concat
  5019. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5020. (start (point)))
  5021. ;; Copy current buffer into a temporary one
  5022. (with-temp-buffer
  5023. (insert-buffer-substring buffer start end)
  5024. (goto-char (point-min))
  5025. ;; Delete SCHEDULED and DEADLINE items
  5026. (while (re-search-forward regexp end t)
  5027. (delete-region (match-beginning 0) (match-end 0)))
  5028. (goto-char (point-min))
  5029. ;; No search for timestamp left
  5030. (when (re-search-forward org-ts-regexp nil t)
  5031. (cond
  5032. ((eq org-agenda-todo-ignore-timestamp 'future)
  5033. (> (org-time-stamp-to-now
  5034. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5035. ((eq org-agenda-todo-ignore-timestamp 'past)
  5036. (<= (org-time-stamp-to-now
  5037. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5038. ((numberp org-agenda-todo-ignore-timestamp)
  5039. (org-agenda-todo-custom-ignore-p
  5040. (match-string 1) org-agenda-todo-ignore-timestamp))
  5041. (t))))))))))
  5042. (defun org-agenda-get-timestamps (&optional deadlines)
  5043. "Return the date stamp information for agenda display.
  5044. Optional argument DEADLINES is a list of deadline items to be
  5045. displayed in agenda view."
  5046. (let* ((props (list 'face 'org-agenda-calendar-event
  5047. 'org-not-done-regexp org-not-done-regexp
  5048. 'org-todo-regexp org-todo-regexp
  5049. 'org-complex-heading-regexp org-complex-heading-regexp
  5050. 'mouse-face 'highlight
  5051. 'help-echo
  5052. (format "mouse-2 or RET jump to Org file %s"
  5053. (abbreviate-file-name buffer-file-name))))
  5054. (current (calendar-absolute-from-gregorian date))
  5055. (today (org-today))
  5056. (deadline-position-alist
  5057. (mapcar (lambda (d)
  5058. (let ((m (get-text-property 0 'org-hd-marker d)))
  5059. (and m (marker-position m))))
  5060. deadlines))
  5061. ;; Match time-stamps set to current date, time-stamps with
  5062. ;; a repeater, and S-exp time-stamps.
  5063. (regexp
  5064. (concat
  5065. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5066. (regexp-quote
  5067. (substring
  5068. (format-time-string
  5069. (car org-time-stamp-formats)
  5070. (apply #'encode-time ; DATE bound by calendar
  5071. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5072. 1 11))
  5073. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5074. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5075. timestamp-items)
  5076. (goto-char (point-min))
  5077. (while (re-search-forward regexp nil t)
  5078. ;; Skip date ranges, scheduled and deadlines, which are handled
  5079. ;; specially. Also skip time-stamps before first headline as
  5080. ;; there would be no entry to add to the agenda. Eventually,
  5081. ;; ignore clock entries.
  5082. (catch :skip
  5083. (save-match-data
  5084. (when (or (org-at-date-range-p)
  5085. (org-at-planning-p)
  5086. (org-before-first-heading-p)
  5087. (and org-agenda-include-inactive-timestamps
  5088. (org-at-clock-log-p)))
  5089. (throw :skip nil))
  5090. (org-agenda-skip))
  5091. (let* ((pos (match-beginning 0))
  5092. (repeat (match-string 1))
  5093. (sexp-entry (match-string 3))
  5094. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5095. (save-excursion
  5096. (goto-char pos)
  5097. (looking-at org-ts-regexp-both)
  5098. (match-string 0))))
  5099. (todo-state (org-get-todo-state))
  5100. (warntime (get-text-property (point) 'org-appt-warntime))
  5101. (done? (member todo-state org-done-keywords)))
  5102. ;; Possibly skip done tasks.
  5103. (when (and done? org-agenda-skip-timestamp-if-done)
  5104. (throw :skip t))
  5105. ;; S-exp entry doesn't match current day: skip it.
  5106. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5107. (throw :skip nil))
  5108. (when repeat
  5109. (let* ((past
  5110. ;; A repeating time stamp is shown at its base
  5111. ;; date and every repeated date up to TODAY. If
  5112. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5113. ;; however, only the last repeat before today
  5114. ;; (inclusive) is shown.
  5115. (org-agenda--timestamp-to-absolute
  5116. repeat
  5117. (if (or (> current today)
  5118. (eq org-agenda-prefer-last-repeat t)
  5119. (member todo-state org-agenda-prefer-last-repeat))
  5120. today
  5121. current)
  5122. 'past (current-buffer) pos))
  5123. (future
  5124. ;; Display every repeated date past TODAY
  5125. ;; (exclusive) unless
  5126. ;; `org-agenda-show-future-repeats' is nil. If
  5127. ;; this variable is set to `next', only display
  5128. ;; the first repeated date after TODAY
  5129. ;; (exclusive).
  5130. (cond
  5131. ((<= current today) past)
  5132. ((not org-agenda-show-future-repeats) past)
  5133. (t
  5134. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5135. (1+ today)
  5136. current)))
  5137. (org-agenda--timestamp-to-absolute
  5138. repeat base 'future (current-buffer) pos))))))
  5139. (when (and (/= current past) (/= current future))
  5140. (throw :skip nil))))
  5141. (save-excursion
  5142. (re-search-backward org-outline-regexp-bol nil t)
  5143. ;; Possibly skip time-stamp when a deadline is set.
  5144. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5145. (assq (point) deadline-position-alist))
  5146. (throw :skip nil))
  5147. (let* ((category (org-get-category pos))
  5148. (inherited-tags
  5149. (or (eq org-agenda-show-inherited-tags 'always)
  5150. (and (consp org-agenda-show-inherited-tags)
  5151. (memq 'agenda org-agenda-show-inherited-tags))
  5152. (and (eq org-agenda-show-inherited-tags t)
  5153. (or (eq org-agenda-use-tag-inheritance t)
  5154. (memq 'agenda
  5155. org-agenda-use-tag-inheritance)))))
  5156. (tags (org-get-tags nil (not inherited-tags)))
  5157. (level (make-string (org-reduced-level (org-outline-level))
  5158. ?\s))
  5159. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5160. (match-string 1)))
  5161. (inactive? (= (char-after pos) ?\[))
  5162. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5163. (item
  5164. (org-agenda-format-item
  5165. (and inactive? org-agenda-inactive-leader)
  5166. head level category tags time-stamp org-ts-regexp habit?)))
  5167. (org-add-props item props
  5168. 'priority (if habit?
  5169. (org-habit-get-priority (org-habit-parse-todo))
  5170. (org-get-priority item))
  5171. 'org-marker (org-agenda-new-marker pos)
  5172. 'org-hd-marker (org-agenda-new-marker)
  5173. 'date date
  5174. 'level level
  5175. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5176. current)
  5177. 'todo-state todo-state
  5178. 'warntime warntime
  5179. 'type "timestamp")
  5180. (push item timestamp-items))))
  5181. (when org-agenda-skip-additional-timestamps-same-entry
  5182. (outline-next-heading))))
  5183. (nreverse timestamp-items)))
  5184. (defun org-agenda-get-sexps ()
  5185. "Return the sexp information for agenda display."
  5186. (require 'diary-lib)
  5187. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5188. 'mouse-face 'highlight
  5189. 'help-echo
  5190. (format "mouse-2 or RET jump to org file %s"
  5191. (abbreviate-file-name buffer-file-name))))
  5192. (regexp "^&?%%(")
  5193. marker category extra level ee txt tags entry
  5194. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5195. (goto-char (point-min))
  5196. (while (re-search-forward regexp nil t)
  5197. (catch :skip
  5198. (org-agenda-skip)
  5199. (setq beg (match-beginning 0))
  5200. (goto-char (1- (match-end 0)))
  5201. (setq b (point))
  5202. (forward-sexp 1)
  5203. (setq sexp (buffer-substring b (point)))
  5204. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5205. (org-trim (match-string 1))
  5206. ""))
  5207. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5208. (when result
  5209. (setq marker (org-agenda-new-marker beg)
  5210. level (make-string (org-reduced-level (org-outline-level)) ? )
  5211. category (org-get-category beg)
  5212. inherited-tags
  5213. (or (eq org-agenda-show-inherited-tags 'always)
  5214. (and (listp org-agenda-show-inherited-tags)
  5215. (memq 'agenda org-agenda-show-inherited-tags))
  5216. (and (eq org-agenda-show-inherited-tags t)
  5217. (or (eq org-agenda-use-tag-inheritance t)
  5218. (memq 'agenda org-agenda-use-tag-inheritance))))
  5219. tags (org-get-tags nil (not inherited-tags))
  5220. todo-state (org-get-todo-state)
  5221. warntime (get-text-property (point) 'org-appt-warntime)
  5222. extra nil)
  5223. (dolist (r (if (stringp result)
  5224. (list result)
  5225. result)) ;; we expect a list here
  5226. (when (and org-agenda-diary-sexp-prefix
  5227. (string-match org-agenda-diary-sexp-prefix r))
  5228. (setq extra (match-string 0 r)
  5229. r (replace-match "" nil nil r)))
  5230. (if (string-match "\\S-" r)
  5231. (setq txt r)
  5232. (setq txt "SEXP entry returned empty string"))
  5233. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5234. (org-add-props txt props 'org-marker marker
  5235. 'date date 'todo-state todo-state
  5236. 'level level 'type "sexp" 'warntime warntime)
  5237. (push txt ee)))))
  5238. (nreverse ee)))
  5239. ;; Calendar sanity: define some functions that are independent of
  5240. ;; `calendar-date-style'.
  5241. (defun org-anniversary (year month day &optional mark)
  5242. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5243. (with-no-warnings
  5244. (let ((calendar-date-style 'iso))
  5245. (diary-anniversary year month day mark))))
  5246. (defun org-cyclic (N year month day &optional mark)
  5247. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5248. (with-no-warnings
  5249. (let ((calendar-date-style 'iso))
  5250. (diary-cyclic N year month day mark))))
  5251. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5252. "Like `diary-block', but with fixed (ISO) order of arguments."
  5253. (with-no-warnings
  5254. (let ((calendar-date-style 'iso))
  5255. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5256. (defun org-date (year month day &optional mark)
  5257. "Like `diary-date', but with fixed (ISO) order of arguments."
  5258. (with-no-warnings
  5259. (let ((calendar-date-style 'iso))
  5260. (diary-date year month day mark))))
  5261. ;; Define the `org-class' function
  5262. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5263. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5264. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5265. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5266. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5267. `holidays', then any date that is known by the Emacs calendar to be a
  5268. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5269. then those holidays will be skipped."
  5270. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5271. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5272. (d (calendar-absolute-from-gregorian date))
  5273. (h (when skip-weeks (calendar-check-holidays date))))
  5274. (and
  5275. (<= date1 d)
  5276. (<= d date2)
  5277. (= (calendar-day-of-week date) dayname)
  5278. (or (not skip-weeks)
  5279. (progn
  5280. (require 'cal-iso)
  5281. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5282. (not (or (and h (memq 'holidays skip-weeks))
  5283. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5284. entry)))
  5285. (defalias 'org-get-closed 'org-agenda-get-progress)
  5286. (defun org-agenda-get-progress ()
  5287. "Return the logged TODO entries for agenda display."
  5288. (let* ((props (list 'mouse-face 'highlight
  5289. 'org-not-done-regexp org-not-done-regexp
  5290. 'org-todo-regexp org-todo-regexp
  5291. 'org-complex-heading-regexp org-complex-heading-regexp
  5292. 'help-echo
  5293. (format "mouse-2 or RET jump to org file %s"
  5294. (abbreviate-file-name buffer-file-name))))
  5295. (items (if (consp org-agenda-show-log-scoped)
  5296. org-agenda-show-log-scoped
  5297. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5298. '(clock)
  5299. org-agenda-log-mode-items)))
  5300. (parts
  5301. (delq nil
  5302. (list
  5303. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5304. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5305. (if (memq 'state items)
  5306. (format "- State \"%s\".*?" org-todo-regexp)))))
  5307. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5308. (error "`org-agenda-log-mode-items' is empty")))
  5309. (regexp (concat
  5310. "\\(" parts-re "\\)"
  5311. " *\\["
  5312. (regexp-quote
  5313. (substring
  5314. (format-time-string
  5315. (car org-time-stamp-formats)
  5316. (apply 'encode-time ; DATE bound by calendar
  5317. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5318. 1 11))))
  5319. (org-agenda-search-headline-for-time nil)
  5320. marker hdmarker priority category level tags closedp
  5321. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5322. (goto-char (point-min))
  5323. (while (re-search-forward regexp nil t)
  5324. (catch :skip
  5325. (org-agenda-skip)
  5326. (setq marker (org-agenda-new-marker (match-beginning 0))
  5327. closedp (equal (match-string 1) org-closed-string)
  5328. statep (equal (string-to-char (match-string 1)) ?-)
  5329. clockp (not (or closedp statep))
  5330. state (and statep (match-string 2))
  5331. category (org-get-category (match-beginning 0))
  5332. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5333. (when (string-match "\\]" timestr)
  5334. ;; substring should only run to end of time stamp
  5335. (setq rest (substring timestr (match-end 0))
  5336. timestr (substring timestr 0 (match-end 0)))
  5337. (if (and (not closedp) (not statep)
  5338. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5339. rest))
  5340. (progn (setq timestr (concat (substring timestr 0 -1)
  5341. "-" (match-string 1 rest) "]"))
  5342. (setq clocked (match-string 2 rest)))
  5343. (setq clocked "-")))
  5344. (save-excursion
  5345. (setq extra
  5346. (cond
  5347. ((not org-agenda-log-mode-add-notes) nil)
  5348. (statep
  5349. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5350. (match-string 1)))
  5351. (clockp
  5352. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5353. (match-string 1)))))
  5354. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5355. (throw :skip nil)
  5356. (goto-char (match-beginning 0))
  5357. (setq hdmarker (org-agenda-new-marker)
  5358. inherited-tags
  5359. (or (eq org-agenda-show-inherited-tags 'always)
  5360. (and (listp org-agenda-show-inherited-tags)
  5361. (memq 'todo org-agenda-show-inherited-tags))
  5362. (and (eq org-agenda-show-inherited-tags t)
  5363. (or (eq org-agenda-use-tag-inheritance t)
  5364. (memq 'todo org-agenda-use-tag-inheritance))))
  5365. tags (org-get-tags nil (not inherited-tags))
  5366. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5367. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5368. (setq txt (match-string 1))
  5369. (when extra
  5370. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5371. (setq txt (concat (substring txt 0 (match-beginning 1))
  5372. " - " extra " " (match-string 2 txt)))
  5373. (setq txt (concat txt " - " extra))))
  5374. (setq txt (org-agenda-format-item
  5375. (cond
  5376. (closedp "Closed: ")
  5377. (statep (concat "State: (" state ")"))
  5378. (t (concat "Clocked: (" clocked ")")))
  5379. txt level category tags timestr)))
  5380. (setq priority 100000)
  5381. (org-add-props txt props
  5382. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5383. 'priority priority 'level level
  5384. 'type "closed" 'date date
  5385. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5386. (push txt ee))
  5387. (goto-char (point-at-eol))))
  5388. (nreverse ee)))
  5389. (defun org-agenda-show-clocking-issues ()
  5390. "Add overlays, showing issues with clocking.
  5391. See also the user option `org-agenda-clock-consistency-checks'."
  5392. (interactive)
  5393. (let* ((pl org-agenda-clock-consistency-checks)
  5394. (re (concat "^[ \t]*"
  5395. org-clock-string
  5396. "[ \t]+"
  5397. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5398. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5399. (tlstart 0.)
  5400. (tlend 0.)
  5401. (maxtime (org-duration-to-minutes
  5402. (or (plist-get pl :max-duration) "24:00")))
  5403. (mintime (org-duration-to-minutes
  5404. (or (plist-get pl :min-duration) 0)))
  5405. (maxgap (org-duration-to-minutes
  5406. ;; default 30:00 means never complain
  5407. (or (plist-get pl :max-gap) "30:00")))
  5408. (gapok (mapcar #'org-duration-to-minutes
  5409. (plist-get pl :gap-ok-around)))
  5410. (def-face (or (plist-get pl :default-face)
  5411. '((:background "DarkRed") (:foreground "white"))))
  5412. issue face m te ts dt ov)
  5413. (goto-char (point-min))
  5414. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5415. (setq issue nil face def-face)
  5416. (catch 'next
  5417. (setq m (org-get-at-bol 'org-marker)
  5418. te nil ts nil)
  5419. (unless (and m (markerp m))
  5420. (setq issue "No valid clock line") (throw 'next t))
  5421. (org-with-point-at m
  5422. (save-excursion
  5423. (goto-char (point-at-bol))
  5424. (unless (looking-at re)
  5425. (error "No valid Clock line")
  5426. (throw 'next t))
  5427. (unless (match-end 3)
  5428. (setq issue "No end time"
  5429. face (or (plist-get pl :no-end-time-face) face))
  5430. (throw 'next t))
  5431. (setq ts (match-string 1)
  5432. te (match-string 3)
  5433. ts (float-time
  5434. (apply #'encode-time (org-parse-time-string ts)))
  5435. te (float-time
  5436. (apply #'encode-time (org-parse-time-string te)))
  5437. dt (- te ts))))
  5438. (cond
  5439. ((> dt (* 60 maxtime))
  5440. ;; a very long clocking chunk
  5441. (setq issue (format "Clocking interval is very long: %s"
  5442. (org-duration-from-minutes (floor (/ dt 60.))))
  5443. face (or (plist-get pl :long-face) face)))
  5444. ((< dt (* 60 mintime))
  5445. ;; a very short clocking chunk
  5446. (setq issue (format "Clocking interval is very short: %s"
  5447. (org-duration-from-minutes (floor (/ dt 60.))))
  5448. face (or (plist-get pl :short-face) face)))
  5449. ((and (> tlend 0) (< ts tlend))
  5450. ;; Two clock entries are overlapping
  5451. (setq issue (format "Clocking overlap: %d minutes"
  5452. (/ (- tlend ts) 60))
  5453. face (or (plist-get pl :overlap-face) face)))
  5454. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5455. ;; There is a gap, lets see if we need to report it
  5456. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5457. (setq issue (format "Clocking gap: %d minutes"
  5458. (/ (- ts tlend) 60))
  5459. face (or (plist-get pl :gap-face) face))))
  5460. (t nil)))
  5461. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5462. (when issue
  5463. ;; OK, there was some issue, add an overlay to show the issue
  5464. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5465. (overlay-put ov 'before-string
  5466. (concat
  5467. (org-add-props
  5468. (format "%-43s" (concat " " issue))
  5469. nil
  5470. 'face face)
  5471. "\n"))
  5472. (overlay-put ov 'evaporate t)))))
  5473. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5474. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5475. (catch 'exit
  5476. (unless ok-list
  5477. ;; there are no OK times for gaps...
  5478. (throw 'exit nil))
  5479. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5480. ;; This is more than 24 hours, so it is OK.
  5481. ;; because we have at least one OK time, that must be in the
  5482. ;; 24 hour interval.
  5483. (throw 'exit t))
  5484. ;; We have a shorter gap.
  5485. ;; Now we have to get the minute of the day when these times are
  5486. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5487. (t2dec (decode-time (seconds-to-time t2)))
  5488. ;; compute the minute on the day
  5489. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5490. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5491. (when (< min2 min1)
  5492. ;; if min2 is smaller than min1, this means it is on the next day.
  5493. ;; Wrap it to after midnight.
  5494. (setq min2 (+ min2 1440)))
  5495. ;; Now check if any of the OK times is in the gap
  5496. (mapc (lambda (x)
  5497. ;; Wrap the time to after midnight if necessary
  5498. (if (< x min1) (setq x (+ x 1440)))
  5499. ;; Check if in interval
  5500. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5501. ok-list)
  5502. ;; Nope, this gap is not OK
  5503. nil)))
  5504. (defun org-agenda-get-deadlines (&optional with-hour)
  5505. "Return the deadline information for agenda display.
  5506. When WITH-HOUR is non-nil, only return deadlines with an hour
  5507. specification like [h]h:mm."
  5508. (let* ((props (list 'mouse-face 'highlight
  5509. 'org-not-done-regexp org-not-done-regexp
  5510. 'org-todo-regexp org-todo-regexp
  5511. 'org-complex-heading-regexp org-complex-heading-regexp
  5512. 'help-echo
  5513. (format "mouse-2 or RET jump to org file %s"
  5514. (abbreviate-file-name buffer-file-name))))
  5515. (regexp (if with-hour
  5516. org-deadline-time-hour-regexp
  5517. org-deadline-time-regexp))
  5518. (today (org-today))
  5519. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5520. (current (calendar-absolute-from-gregorian date))
  5521. deadline-items)
  5522. (goto-char (point-min))
  5523. (while (re-search-forward regexp nil t)
  5524. (catch :skip
  5525. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5526. (org-agenda-skip)
  5527. (let* ((s (match-string 1))
  5528. (pos (1- (match-beginning 1)))
  5529. (todo-state (save-match-data (org-get-todo-state)))
  5530. (done? (member todo-state org-done-keywords))
  5531. (sexp? (string-prefix-p "%%" s))
  5532. ;; DEADLINE is the deadline date for the entry. It is
  5533. ;; either the base date or the last repeat, according
  5534. ;; to `org-agenda-prefer-last-repeat'.
  5535. (deadline
  5536. (cond
  5537. (sexp? (org-agenda--timestamp-to-absolute s current))
  5538. ((or (eq org-agenda-prefer-last-repeat t)
  5539. (member todo-state org-agenda-prefer-last-repeat))
  5540. (org-agenda--timestamp-to-absolute
  5541. s today 'past (current-buffer) pos))
  5542. (t (org-agenda--timestamp-to-absolute s))))
  5543. ;; REPEAT is the future repeat closest from CURRENT,
  5544. ;; according to `org-agenda-show-future-repeats'. If
  5545. ;; the latter is nil, or if the time stamp has no
  5546. ;; repeat part, default to DEADLINE.
  5547. (repeat
  5548. (cond
  5549. (sexp? deadline)
  5550. ((<= current today) deadline)
  5551. ((not org-agenda-show-future-repeats) deadline)
  5552. (t
  5553. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5554. (1+ today)
  5555. current)))
  5556. (org-agenda--timestamp-to-absolute
  5557. s base 'future (current-buffer) pos)))))
  5558. (diff (- deadline current))
  5559. (suppress-prewarning
  5560. (let ((scheduled
  5561. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5562. (org-entry-get nil "SCHEDULED"))))
  5563. (cond
  5564. ((not scheduled) nil)
  5565. ;; The current item has a scheduled date, so
  5566. ;; evaluate its prewarning lead time.
  5567. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5568. ;; Use global prewarning-restart lead time.
  5569. org-agenda-skip-deadline-prewarning-if-scheduled)
  5570. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5571. 'pre-scheduled)
  5572. ;; Set pre-warning to no earlier than SCHEDULED.
  5573. (min (- deadline
  5574. (org-agenda--timestamp-to-absolute scheduled))
  5575. org-deadline-warning-days))
  5576. ;; Set pre-warning to deadline.
  5577. (t 0))))
  5578. (wdays (if suppress-prewarning
  5579. (let ((org-deadline-warning-days suppress-prewarning))
  5580. (org-get-wdays s))
  5581. (org-get-wdays s))))
  5582. (cond
  5583. ;; Only display deadlines at their base date, at future
  5584. ;; repeat occurrences or in today agenda.
  5585. ((= current deadline) nil)
  5586. ((= current repeat) nil)
  5587. ((not today?) (throw :skip nil))
  5588. ;; Upcoming deadline: display within warning period WDAYS.
  5589. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5590. ;; Overdue deadline: warn about it for
  5591. ;; `org-deadline-past-days' duration.
  5592. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5593. ;; Possibly skip done tasks.
  5594. (when (and done?
  5595. (or org-agenda-skip-deadline-if-done
  5596. (/= deadline current)))
  5597. (throw :skip nil))
  5598. (save-excursion
  5599. (re-search-backward "^\\*+[ \t]+" nil t)
  5600. (goto-char (match-end 0))
  5601. (let* ((category (org-get-category))
  5602. (level (make-string (org-reduced-level (org-outline-level))
  5603. ?\s))
  5604. (head (buffer-substring (point) (line-end-position)))
  5605. (inherited-tags
  5606. (or (eq org-agenda-show-inherited-tags 'always)
  5607. (and (listp org-agenda-show-inherited-tags)
  5608. (memq 'agenda org-agenda-show-inherited-tags))
  5609. (and (eq org-agenda-show-inherited-tags t)
  5610. (or (eq org-agenda-use-tag-inheritance t)
  5611. (memq 'agenda
  5612. org-agenda-use-tag-inheritance)))))
  5613. (tags (org-get-tags nil (not inherited-tags)))
  5614. (time
  5615. (cond
  5616. ;; No time of day designation if it is only
  5617. ;; a reminder.
  5618. ((and (/= current deadline) (/= current repeat)) nil)
  5619. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5620. (concat (substring s (match-beginning 1)) " "))
  5621. (t 'time)))
  5622. (item
  5623. (org-agenda-format-item
  5624. ;; Insert appropriate suffixes before deadlines.
  5625. ;; Those only apply to today agenda.
  5626. (pcase-let ((`(,now ,future ,past)
  5627. org-agenda-deadline-leaders))
  5628. (cond
  5629. ((and today? (< deadline today)) (format past (- diff)))
  5630. ((and today? (> deadline today)) (format future diff))
  5631. (t now)))
  5632. head level category tags time))
  5633. (face (org-agenda-deadline-face
  5634. (- 1 (/ (float diff) (max wdays 1)))))
  5635. (upcoming? (and today? (> deadline today)))
  5636. (warntime (get-text-property (point) 'org-appt-warntime)))
  5637. (org-add-props item props
  5638. 'org-marker (org-agenda-new-marker pos)
  5639. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5640. 'warntime warntime
  5641. 'level level
  5642. 'ts-date deadline
  5643. 'priority
  5644. ;; Adjust priority to today reminders about deadlines.
  5645. ;; Overdue deadlines get the highest priority
  5646. ;; increase, then imminent deadlines and eventually
  5647. ;; more distant deadlines.
  5648. (let ((adjust (if today? (- diff) 0)))
  5649. (+ adjust (org-get-priority item)))
  5650. 'todo-state todo-state
  5651. 'type (if upcoming? "upcoming-deadline" "deadline")
  5652. 'date (if upcoming? date deadline)
  5653. 'face (if done? 'org-agenda-done face)
  5654. 'undone-face face
  5655. 'done-face 'org-agenda-done)
  5656. (push item deadline-items))))))
  5657. (nreverse deadline-items)))
  5658. (defun org-agenda-deadline-face (fraction)
  5659. "Return the face to displaying a deadline item.
  5660. FRACTION is what fraction of the head-warning time has passed."
  5661. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5662. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5663. "Return the scheduled information for agenda display.
  5664. Optional argument DEADLINES is a list of deadline items to be
  5665. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5666. scheduled items with an hour specification like [h]h:mm."
  5667. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5668. 'org-todo-regexp org-todo-regexp
  5669. 'org-complex-heading-regexp org-complex-heading-regexp
  5670. 'done-face 'org-agenda-done
  5671. 'mouse-face 'highlight
  5672. 'help-echo
  5673. (format "mouse-2 or RET jump to Org file %s"
  5674. (abbreviate-file-name buffer-file-name))))
  5675. (regexp (if with-hour
  5676. org-scheduled-time-hour-regexp
  5677. org-scheduled-time-regexp))
  5678. (today (org-today))
  5679. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5680. (current (calendar-absolute-from-gregorian date))
  5681. (deadline-pos
  5682. (mapcar (lambda (d)
  5683. (let ((m (get-text-property 0 'org-hd-marker d)))
  5684. (and m (marker-position m))))
  5685. deadlines))
  5686. scheduled-items)
  5687. (goto-char (point-min))
  5688. (while (re-search-forward regexp nil t)
  5689. (catch :skip
  5690. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5691. (org-agenda-skip)
  5692. (let* ((s (match-string 1))
  5693. (pos (1- (match-beginning 1)))
  5694. (todo-state (save-match-data (org-get-todo-state)))
  5695. (donep (member todo-state org-done-keywords))
  5696. (sexp? (string-prefix-p "%%" s))
  5697. ;; SCHEDULE is the scheduled date for the entry. It is
  5698. ;; either the bare date or the last repeat, according
  5699. ;; to `org-agenda-prefer-last-repeat'.
  5700. (schedule
  5701. (cond
  5702. (sexp? (org-agenda--timestamp-to-absolute s current))
  5703. ((or (eq org-agenda-prefer-last-repeat t)
  5704. (member todo-state org-agenda-prefer-last-repeat))
  5705. (org-agenda--timestamp-to-absolute
  5706. s today 'past (current-buffer) pos))
  5707. (t (org-agenda--timestamp-to-absolute s))))
  5708. ;; REPEAT is the future repeat closest from CURRENT,
  5709. ;; according to `org-agenda-show-future-repeats'. If
  5710. ;; the latter is nil, or if the time stamp has no
  5711. ;; repeat part, default to SCHEDULE.
  5712. (repeat
  5713. (cond
  5714. (sexp? schedule)
  5715. ((<= current today) schedule)
  5716. ((not org-agenda-show-future-repeats) schedule)
  5717. (t
  5718. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5719. (1+ today)
  5720. current)))
  5721. (org-agenda--timestamp-to-absolute
  5722. s base 'future (current-buffer) pos)))))
  5723. (diff (- current schedule))
  5724. (warntime (get-text-property (point) 'org-appt-warntime))
  5725. (pastschedp (< schedule today))
  5726. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5727. (suppress-delay
  5728. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5729. (org-entry-get nil "DEADLINE"))))
  5730. (cond
  5731. ((not deadline) nil)
  5732. ;; The current item has a deadline date, so
  5733. ;; evaluate its delay time.
  5734. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5735. ;; Use global delay time.
  5736. (- org-agenda-skip-scheduled-delay-if-deadline))
  5737. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5738. 'post-deadline)
  5739. ;; Set delay to no later than DEADLINE.
  5740. (min (- schedule
  5741. (org-agenda--timestamp-to-absolute deadline))
  5742. org-scheduled-delay-days))
  5743. (t 0))))
  5744. (ddays
  5745. (cond
  5746. ;; Nullify delay when a repeater triggered already
  5747. ;; and the delay is of the form --Xd.
  5748. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5749. (> schedule (org-agenda--timestamp-to-absolute s)))
  5750. 0)
  5751. (suppress-delay
  5752. (let ((org-scheduled-delay-days suppress-delay))
  5753. (org-get-wdays s t t)))
  5754. (t (org-get-wdays s t)))))
  5755. ;; Display scheduled items at base date (SCHEDULE), today if
  5756. ;; scheduled before the current date, and at any repeat past
  5757. ;; today. However, skip delayed items and items that have
  5758. ;; been displayed for more than `org-scheduled-past-days'.
  5759. (unless (and todayp
  5760. habitp
  5761. (bound-and-true-p org-habit-show-all-today))
  5762. (when (or (and (> ddays 0) (< diff ddays))
  5763. (> diff org-scheduled-past-days)
  5764. (> schedule current)
  5765. (and (/= current schedule)
  5766. (/= current today)
  5767. (/= current repeat)))
  5768. (throw :skip nil)))
  5769. ;; Possibly skip done tasks.
  5770. (when (and donep
  5771. (or org-agenda-skip-scheduled-if-done
  5772. (/= schedule current)))
  5773. (throw :skip nil))
  5774. ;; Skip entry if it already appears as a deadline, per
  5775. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5776. ;; doesn't apply to habits.
  5777. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5778. ((guard
  5779. (or (not (memq (line-beginning-position 0) deadline-pos))
  5780. habitp))
  5781. nil)
  5782. (`repeated-after-deadline
  5783. (let ((deadline (time-to-days
  5784. (org-get-deadline-time (point)))))
  5785. (and (<= schedule deadline) (> current deadline))))
  5786. (`not-today pastschedp)
  5787. (`t t)
  5788. (_ nil))
  5789. (throw :skip nil))
  5790. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5791. ;; only show them for today. Also skip done habits.
  5792. (when (and habitp
  5793. (or donep
  5794. (not (bound-and-true-p org-habit-show-habits))
  5795. (and (not todayp)
  5796. (bound-and-true-p
  5797. org-habit-show-habits-only-for-today))))
  5798. (throw :skip nil))
  5799. (save-excursion
  5800. (re-search-backward "^\\*+[ \t]+" nil t)
  5801. (goto-char (match-end 0))
  5802. (let* ((category (org-get-category))
  5803. (inherited-tags
  5804. (or (eq org-agenda-show-inherited-tags 'always)
  5805. (and (listp org-agenda-show-inherited-tags)
  5806. (memq 'agenda org-agenda-show-inherited-tags))
  5807. (and (eq org-agenda-show-inherited-tags t)
  5808. (or (eq org-agenda-use-tag-inheritance t)
  5809. (memq 'agenda
  5810. org-agenda-use-tag-inheritance)))))
  5811. (tags (org-get-tags nil (not inherited-tags)))
  5812. (level (make-string (org-reduced-level (org-outline-level))
  5813. ?\s))
  5814. (head (buffer-substring (point) (line-end-position)))
  5815. (time
  5816. (cond
  5817. ;; No time of day designation if it is only
  5818. ;; a reminder.
  5819. ((and (/= current schedule) (/= current repeat)) nil)
  5820. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5821. (concat (substring s (match-beginning 1)) " "))
  5822. (t 'time)))
  5823. (item
  5824. (org-agenda-format-item
  5825. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5826. ;; Show a reminder of a past scheduled today.
  5827. (if (and todayp pastschedp)
  5828. (format past diff)
  5829. first))
  5830. head level category tags time nil habitp))
  5831. (face (cond ((and (not habitp) pastschedp)
  5832. 'org-scheduled-previously)
  5833. (todayp 'org-scheduled-today)
  5834. (t 'org-scheduled)))
  5835. (habitp (and habitp (org-habit-parse-todo))))
  5836. (org-add-props item props
  5837. 'undone-face face
  5838. 'face (if donep 'org-agenda-done face)
  5839. 'org-marker (org-agenda-new-marker pos)
  5840. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5841. 'type (if pastschedp "past-scheduled" "scheduled")
  5842. 'date (if pastschedp schedule date)
  5843. 'ts-date schedule
  5844. 'warntime warntime
  5845. 'level level
  5846. 'priority (if habitp (org-habit-get-priority habitp)
  5847. (+ 99 diff (org-get-priority item)))
  5848. 'org-habit-p habitp
  5849. 'todo-state todo-state)
  5850. (push item scheduled-items))))))
  5851. (nreverse scheduled-items)))
  5852. (defun org-agenda-get-blocks ()
  5853. "Return the date-range information for agenda display."
  5854. (let* ((props (list 'face nil
  5855. 'org-not-done-regexp org-not-done-regexp
  5856. 'org-todo-regexp org-todo-regexp
  5857. 'org-complex-heading-regexp org-complex-heading-regexp
  5858. 'mouse-face 'highlight
  5859. 'help-echo
  5860. (format "mouse-2 or RET jump to org file %s"
  5861. (abbreviate-file-name buffer-file-name))))
  5862. (regexp org-tr-regexp)
  5863. (d0 (calendar-absolute-from-gregorian date))
  5864. marker hdmarker ee txt d1 d2 s1 s2 category
  5865. level todo-state tags pos head donep inherited-tags)
  5866. (goto-char (point-min))
  5867. (while (re-search-forward regexp nil t)
  5868. (catch :skip
  5869. (org-agenda-skip)
  5870. (setq pos (point))
  5871. (let ((start-time (match-string 1))
  5872. (end-time (match-string 2)))
  5873. (setq s1 (match-string 1)
  5874. s2 (match-string 2)
  5875. d1 (time-to-days
  5876. (condition-case err
  5877. (org-time-string-to-time s1)
  5878. (error
  5879. (error
  5880. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5881. s1
  5882. pos
  5883. (current-buffer)
  5884. (error-message-string err)))))
  5885. d2 (time-to-days
  5886. (condition-case err
  5887. (org-time-string-to-time s2)
  5888. (error
  5889. (error
  5890. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5891. s2
  5892. pos
  5893. (current-buffer)
  5894. (error-message-string err))))))
  5895. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5896. ;; Only allow days between the limits, because the normal
  5897. ;; date stamps will catch the limits.
  5898. (save-excursion
  5899. (setq todo-state (org-get-todo-state))
  5900. (setq donep (member todo-state org-done-keywords))
  5901. (if (and donep org-agenda-skip-timestamp-if-done)
  5902. (throw :skip t))
  5903. (setq marker (org-agenda-new-marker (point))
  5904. category (org-get-category))
  5905. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5906. (throw :skip nil)
  5907. (goto-char (match-beginning 0))
  5908. (setq hdmarker (org-agenda-new-marker (point))
  5909. inherited-tags
  5910. (or (eq org-agenda-show-inherited-tags 'always)
  5911. (and (listp org-agenda-show-inherited-tags)
  5912. (memq 'agenda org-agenda-show-inherited-tags))
  5913. (and (eq org-agenda-show-inherited-tags t)
  5914. (or (eq org-agenda-use-tag-inheritance t)
  5915. (memq 'agenda org-agenda-use-tag-inheritance))))
  5916. tags (org-get-tags nil (not inherited-tags)))
  5917. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5918. (looking-at "\\*+[ \t]+\\(.*\\)")
  5919. (setq head (match-string 1))
  5920. (let ((remove-re
  5921. (if org-agenda-remove-timeranges-from-blocks
  5922. (concat
  5923. "<" (regexp-quote s1) ".*?>"
  5924. "--"
  5925. "<" (regexp-quote s2) ".*?>")
  5926. nil)))
  5927. (setq txt (org-agenda-format-item
  5928. (format
  5929. (nth (if (= d1 d2) 0 1)
  5930. org-agenda-timerange-leaders)
  5931. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5932. head level category tags
  5933. (cond ((and (= d1 d0) (= d2 d0))
  5934. (concat "<" start-time ">--<" end-time ">"))
  5935. ((= d1 d0)
  5936. (concat "<" start-time ">"))
  5937. ((= d2 d0)
  5938. (concat "<" end-time ">")))
  5939. remove-re))))
  5940. (org-add-props txt props
  5941. 'org-marker marker 'org-hd-marker hdmarker
  5942. 'type "block" 'date date
  5943. 'level level
  5944. 'todo-state todo-state
  5945. 'priority (org-get-priority txt))
  5946. (push txt ee))))
  5947. (goto-char pos)))
  5948. ;; Sort the entries by expiration date.
  5949. (nreverse ee)))
  5950. ;;; Agenda presentation and sorting
  5951. (defvar org-prefix-has-time nil
  5952. "A flag, set by `org-compile-prefix-format'.
  5953. The flag is set if the currently compiled format contains a `%t'.")
  5954. (defvar org-prefix-has-tag nil
  5955. "A flag, set by `org-compile-prefix-format'.
  5956. The flag is set if the currently compiled format contains a `%T'.")
  5957. (defvar org-prefix-has-effort nil
  5958. "A flag, set by `org-compile-prefix-format'.
  5959. The flag is set if the currently compiled format contains a `%e'.")
  5960. (defvar org-prefix-has-breadcrumbs nil
  5961. "A flag, set by `org-compile-prefix-format'.
  5962. The flag is set if the currently compiled format contains a `%b'.")
  5963. (defvar org-prefix-category-length nil
  5964. "Used by `org-compile-prefix-format' to remember the category field width.")
  5965. (defvar org-prefix-category-max-length nil
  5966. "Used by `org-compile-prefix-format' to remember the category field width.")
  5967. (defun org-agenda-get-category-icon (category)
  5968. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5969. (cl-dolist (entry org-agenda-category-icon-alist)
  5970. (when (string-match-p (car entry) category)
  5971. (if (listp (cadr entry))
  5972. (cl-return (cadr entry))
  5973. (cl-return (apply #'create-image (cdr entry)))))))
  5974. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5975. remove-re habitp)
  5976. "Format TXT to be inserted into the agenda buffer.
  5977. In particular, add the prefix and corresponding text properties.
  5978. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5979. LEVEL may be a string to replace the `%l' specifier.
  5980. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5981. category taken from local variable or file name. It will replace the `%c'
  5982. specifier in the format.
  5983. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5984. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5985. When DOTIME is a string, this string is searched for a time before TXT is.
  5986. TAGS can be the tags of the headline.
  5987. Any match of REMOVE-RE will be removed from TXT."
  5988. ;; We keep the org-prefix-* variable values along with a compiled
  5989. ;; formatter, so that multiple agendas existing at the same time do
  5990. ;; not step on each other toes.
  5991. ;;
  5992. ;; It was inconvenient to make these variables buffer local in
  5993. ;; Agenda buffers, because this function expects to be called with
  5994. ;; the buffer where item comes from being current, and not agenda
  5995. ;; buffer
  5996. (let* ((bindings (car org-prefix-format-compiled))
  5997. (formatter (cadr org-prefix-format-compiled)))
  5998. (cl-loop for (var value) in bindings
  5999. do (set var value))
  6000. (save-match-data
  6001. ;; Diary entries sometimes have extra whitespace at the beginning
  6002. (setq txt (org-trim txt))
  6003. ;; Fix the tags part in txt
  6004. (setq txt (org-agenda-fix-displayed-tags
  6005. txt tags
  6006. org-agenda-show-inherited-tags
  6007. org-agenda-hide-tags-regexp))
  6008. (let* ((category (or category
  6009. (if buffer-file-name
  6010. (file-name-sans-extension
  6011. (file-name-nondirectory buffer-file-name))
  6012. "")))
  6013. (category-icon (org-agenda-get-category-icon category))
  6014. (category-icon (if category-icon
  6015. (propertize " " 'display category-icon)
  6016. ""))
  6017. (effort (and (not (string= txt ""))
  6018. (get-text-property 1 'effort txt)))
  6019. ;; time, tag, effort are needed for the eval of the prefix format
  6020. (tag (if tags (nth (1- (length tags)) tags) ""))
  6021. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6022. time
  6023. (ts (if dotime (concat
  6024. (if (stringp dotime) dotime "")
  6025. (and org-agenda-search-headline-for-time txt))))
  6026. (time-of-day (and dotime (org-get-time-of-day ts)))
  6027. stamp plain s0 s1 s2 rtn srp l
  6028. duration breadcrumbs)
  6029. (and (derived-mode-p 'org-mode) buffer-file-name
  6030. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6031. (when (and dotime time-of-day)
  6032. ;; Extract starting and ending time and move them to prefix
  6033. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6034. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6035. (setq s0 (match-string 0 ts)
  6036. srp (and stamp (match-end 3))
  6037. s1 (match-string (if plain 1 2) ts)
  6038. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6039. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6040. ;; them, we might want to remove them there to avoid duplication.
  6041. ;; The user can turn this off with a variable.
  6042. (if (and org-prefix-has-time
  6043. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6044. (string-match (concat (regexp-quote s0) " *") txt)
  6045. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6046. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6047. (= (match-beginning 0) 0)
  6048. t))
  6049. (setq txt (replace-match "" nil nil txt))))
  6050. ;; Normalize the time(s) to 24 hour
  6051. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6052. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6053. ;; Try to set s2 if s1 and
  6054. ;; `org-agenda-default-appointment-duration' are set
  6055. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6056. (setq s2
  6057. (org-duration-from-minutes
  6058. (+ (org-duration-to-minutes s1 t)
  6059. org-agenda-default-appointment-duration)
  6060. nil t)))
  6061. ;; Compute the duration
  6062. (when s2
  6063. (setq duration (- (org-duration-to-minutes s2)
  6064. (org-duration-to-minutes s1)))))
  6065. (when (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6066. ;; Tags are in the string
  6067. (if (or (eq org-agenda-remove-tags t)
  6068. (and org-agenda-remove-tags
  6069. org-prefix-has-tag))
  6070. (setq txt (replace-match "" t t txt))
  6071. (setq txt (replace-match
  6072. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6073. (match-string 2 txt))
  6074. t t txt))))
  6075. (when remove-re
  6076. (while (string-match remove-re txt)
  6077. (setq txt (replace-match "" t t txt))))
  6078. ;; Set org-heading property on `txt' to mark the start of the
  6079. ;; heading.
  6080. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6081. ;; Prepare the variables needed in the eval of the compiled format
  6082. (if org-prefix-has-breadcrumbs
  6083. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6084. (let ((s (org-display-outline-path nil nil "->" t)))
  6085. (if (eq "" s) "" (concat s "->"))))))
  6086. (setq time (cond (s2 (concat
  6087. (org-agenda-time-of-day-to-ampm-maybe s1)
  6088. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6089. (if org-agenda-timegrid-use-ampm " ")))
  6090. (s1 (concat
  6091. (org-agenda-time-of-day-to-ampm-maybe s1)
  6092. (if org-agenda-timegrid-use-ampm
  6093. (concat time-grid-trailing-characters " ")
  6094. time-grid-trailing-characters)))
  6095. (t ""))
  6096. extra (or (and (not habitp) extra) "")
  6097. category (if (symbolp category) (symbol-name category) category)
  6098. level (or level ""))
  6099. (if (string-match org-bracket-link-regexp category)
  6100. (progn
  6101. (setq l (if (match-end 3)
  6102. (- (match-end 3) (match-beginning 3))
  6103. (- (match-end 1) (match-beginning 1))))
  6104. (when (< l (or org-prefix-category-length 0))
  6105. (setq category (copy-sequence category))
  6106. (org-add-props category nil
  6107. 'extra-space (make-string
  6108. (- org-prefix-category-length l 1) ?\ ))))
  6109. (if (and org-prefix-category-max-length
  6110. (>= (length category) org-prefix-category-max-length))
  6111. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6112. ;; Evaluate the compiled format
  6113. (setq rtn (concat (eval formatter) txt))
  6114. ;; And finally add the text properties
  6115. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6116. (org-add-props rtn nil
  6117. 'org-category category
  6118. 'tags (mapcar 'org-downcase-keep-props tags)
  6119. 'org-highest-priority org-highest-priority
  6120. 'org-lowest-priority org-lowest-priority
  6121. 'time-of-day time-of-day
  6122. 'duration duration
  6123. 'breadcrumbs breadcrumbs
  6124. 'txt txt
  6125. 'level level
  6126. 'time time
  6127. 'extra extra
  6128. 'format org-prefix-format-compiled
  6129. 'dotime dotime)))))
  6130. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6131. "Remove tags string from TXT, and add a modified list of tags.
  6132. The modified list may contain inherited tags, and tags matched by
  6133. `org-agenda-hide-tags-regexp' will be removed."
  6134. (when (or add-inherited hide-re)
  6135. (if (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6136. (setq txt (substring txt 0 (match-beginning 0))))
  6137. (setq tags
  6138. (delq nil
  6139. (mapcar (lambda (tg)
  6140. (if (or (and hide-re (string-match hide-re tg))
  6141. (and (not add-inherited)
  6142. (get-text-property 0 'inherited tg)))
  6143. nil
  6144. tg))
  6145. tags)))
  6146. (when tags
  6147. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6148. i)
  6149. (setq txt (concat txt " :"
  6150. (mapconcat
  6151. (lambda (x)
  6152. (setq i (get-text-property 0 'inherited x))
  6153. (if (and have-i (not i))
  6154. (progn
  6155. (setq have-i nil)
  6156. (concat ":" x))
  6157. x))
  6158. tags ":")
  6159. (if have-i "::" ":"))))))
  6160. txt)
  6161. (defun org-downcase-keep-props (s)
  6162. (let ((props (text-properties-at 0 s)))
  6163. (setq s (downcase s))
  6164. (add-text-properties 0 (length s) props s)
  6165. s))
  6166. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6167. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6168. "Add a time-grid for agenda items which need it.
  6169. LIST is the list of agenda items formatted by `org-agenda-list'.
  6170. NDAYS is the span of the current agenda view.
  6171. TODAYP is t when the current agenda view is on today."
  6172. (catch 'exit
  6173. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6174. ((and todayp (member 'today (car org-agenda-time-grid))))
  6175. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6176. ((member 'weekly (car org-agenda-time-grid)))
  6177. (t (throw 'exit list)))
  6178. (let* ((have (delq nil (mapcar
  6179. (lambda (x) (get-text-property 1 'time-of-day x))
  6180. list)))
  6181. (string (nth 3 org-agenda-time-grid))
  6182. (gridtimes (nth 1 org-agenda-time-grid))
  6183. (req (car org-agenda-time-grid))
  6184. (remove (member 'remove-match req))
  6185. new time)
  6186. (if (and (member 'require-timed req) (not have))
  6187. ;; don't show empty grid
  6188. (throw 'exit list))
  6189. (while (setq time (pop gridtimes))
  6190. (unless (and remove (member time have))
  6191. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6192. (push (org-agenda-format-item
  6193. nil string nil "" nil
  6194. (concat (substring time 0 -2) ":" (substring time -2)))
  6195. new)
  6196. (put-text-property
  6197. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6198. (when (and todayp org-agenda-show-current-time-in-grid)
  6199. (push (org-agenda-format-item
  6200. nil org-agenda-current-time-string nil "" nil
  6201. (format-time-string "%H:%M "))
  6202. new)
  6203. (put-text-property
  6204. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6205. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6206. (append new list)
  6207. (append list new)))))
  6208. (defun org-compile-prefix-format (key)
  6209. "Compile the prefix format into a Lisp form that can be evaluated.
  6210. The resulting form and associated variable bindings is returned
  6211. and stored in the variable `org-prefix-format-compiled'."
  6212. (setq org-prefix-has-time nil
  6213. org-prefix-has-tag nil
  6214. org-prefix-category-length nil
  6215. org-prefix-has-effort nil
  6216. org-prefix-has-breadcrumbs nil)
  6217. (let ((s (cond
  6218. ((stringp org-agenda-prefix-format)
  6219. org-agenda-prefix-format)
  6220. ((assq key org-agenda-prefix-format)
  6221. (cdr (assq key org-agenda-prefix-format)))
  6222. (t " %-12:c%?-12t% s")))
  6223. (start 0)
  6224. varform vars var e c f opt)
  6225. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6226. s start)
  6227. (setq var (or (cdr (assoc (match-string 4 s)
  6228. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6229. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6230. 'eval)
  6231. c (or (match-string 3 s) "")
  6232. opt (match-beginning 1)
  6233. start (1+ (match-beginning 0)))
  6234. (if (eq var 'time) (setq org-prefix-has-time t))
  6235. (if (eq var 'tag) (setq org-prefix-has-tag t))
  6236. (if (eq var 'effort) (setq org-prefix-has-effort t))
  6237. (if (eq var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6238. (setq f (concat "%" (match-string 2 s) "s"))
  6239. (when (eq var 'category)
  6240. (setq org-prefix-category-length
  6241. (floor (abs (string-to-number (match-string 2 s)))))
  6242. (setq org-prefix-category-max-length
  6243. (let ((x (match-string 2 s)))
  6244. (save-match-data
  6245. (if (string-match "\\.[0-9]+" x)
  6246. (string-to-number (substring (match-string 0 x) 1)))))))
  6247. (if (eq var 'eval)
  6248. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6249. (if opt
  6250. (setq varform
  6251. `(if (or (equal "" ,var) (equal nil ,var))
  6252. ""
  6253. (format ,f (concat ,var ,c))))
  6254. (setq varform
  6255. `(format ,f (if (or (equal ,var "")
  6256. (equal ,var nil)) ""
  6257. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6258. (setq s (replace-match "%s" t nil s))
  6259. (push varform vars))
  6260. (setq vars (nreverse vars))
  6261. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6262. (setq org-prefix-format-compiled
  6263. (list
  6264. `((org-prefix-has-time ,org-prefix-has-time)
  6265. (org-prefix-has-tag ,org-prefix-has-tag)
  6266. (org-prefix-category-length ,org-prefix-category-length)
  6267. (org-prefix-has-effort ,org-prefix-has-effort)
  6268. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6269. `(format ,s ,@vars))))))
  6270. (defun org-set-sorting-strategy (key)
  6271. (if (symbolp (car org-agenda-sorting-strategy))
  6272. ;; the old format
  6273. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6274. (setq org-agenda-sorting-strategy-selected
  6275. (or (cdr (assq key org-agenda-sorting-strategy))
  6276. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6277. '(time-up category-keep priority-down)))))
  6278. (defun org-get-time-of-day (s &optional string mod24)
  6279. "Check string S for a time of day.
  6280. If found, return it as a military time number between 0 and 2400.
  6281. If not found, return nil.
  6282. The optional STRING argument forces conversion into a 5 character wide string
  6283. HH:MM."
  6284. (save-match-data
  6285. (when
  6286. (and
  6287. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6288. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6289. (not (eq (get-text-property 1 'face s) 'org-link)))
  6290. (let* ((h (string-to-number (match-string 1 s)))
  6291. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6292. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6293. (am-p (equal ampm "am"))
  6294. (h1 (cond ((not ampm) h)
  6295. ((= h 12) (if am-p 0 12))
  6296. (t (+ h (if am-p 0 12)))))
  6297. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6298. (mod h1 24) h1))
  6299. (t0 (+ (* 100 h2) m))
  6300. (t1 (concat (if (>= h1 24) "+" " ")
  6301. (if (and org-agenda-time-leading-zero
  6302. (< t0 1000)) "0" "")
  6303. (if (< t0 100) "0" "")
  6304. (if (< t0 10) "0" "")
  6305. (int-to-string t0))))
  6306. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6307. (defvar org-agenda-before-sorting-filter-function nil
  6308. "Function to be applied to agenda items prior to sorting.
  6309. Prior to sorting also means just before they are inserted into the agenda.
  6310. To aid sorting, you may revisit the original entries and add more text
  6311. properties which will later be used by the sorting functions.
  6312. The function should take a string argument, an agenda line.
  6313. It has access to the text properties in that line, which contain among
  6314. other things, the property `org-hd-marker' that points to the entry
  6315. where the line comes from. Note that not all lines going into the agenda
  6316. have this property, only most.
  6317. The function should return the modified string. It is probably best
  6318. to ONLY change text properties.
  6319. You can also use this function as a filter, by returning nil for lines
  6320. you don't want to have in the agenda at all. For this application, you
  6321. could bind the variable in the options section of a custom command.")
  6322. (defun org-agenda-finalize-entries (list &optional type)
  6323. "Sort, limit and concatenate the LIST of agenda items.
  6324. The optional argument TYPE tells the agenda type."
  6325. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6326. (cdr (assoc type org-agenda-max-effort)))
  6327. (t org-agenda-max-effort)))
  6328. (max-todo (cond ((listp org-agenda-max-todos)
  6329. (cdr (assoc type org-agenda-max-todos)))
  6330. (t org-agenda-max-todos)))
  6331. (max-tags (cond ((listp org-agenda-max-tags)
  6332. (cdr (assoc type org-agenda-max-tags)))
  6333. (t org-agenda-max-tags)))
  6334. (max-entries (cond ((listp org-agenda-max-entries)
  6335. (cdr (assoc type org-agenda-max-entries)))
  6336. (t org-agenda-max-entries))))
  6337. (when org-agenda-before-sorting-filter-function
  6338. (setq list
  6339. (delq nil
  6340. (mapcar
  6341. org-agenda-before-sorting-filter-function list))))
  6342. (setq list (mapcar 'org-agenda-highlight-todo list)
  6343. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6344. (when max-effort
  6345. (setq list (org-agenda-limit-entries
  6346. list 'effort-minutes max-effort
  6347. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6348. 32767 -1))))))
  6349. (when max-todo
  6350. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6351. (when max-tags
  6352. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6353. (when max-entries
  6354. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6355. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6356. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6357. (mapconcat 'identity list "\n")))
  6358. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6359. "Limit the number of agenda entries."
  6360. (let ((include (and limit (< limit 0))))
  6361. (if limit
  6362. (let ((fun (or fn (lambda (p) (if p 1))))
  6363. (lim 0))
  6364. (delq nil
  6365. (mapcar
  6366. (lambda (e)
  6367. (let ((pval (funcall
  6368. fun (get-text-property (1- (length e))
  6369. prop e))))
  6370. (if pval (setq lim (+ lim pval)))
  6371. (cond ((and pval (<= lim (abs limit))) e)
  6372. ((and include (not pval)) e))))
  6373. list)))
  6374. list)))
  6375. (defun org-agenda-limit-interactively (remove)
  6376. "In agenda, interactively limit entries to various maximums."
  6377. (interactive "P")
  6378. (if remove
  6379. (progn (setq org-agenda-max-entries nil
  6380. org-agenda-max-todos nil
  6381. org-agenda-max-tags nil
  6382. org-agenda-max-effort nil)
  6383. (org-agenda-redo))
  6384. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6385. (msg (cond ((= max ?E) "How many minutes? ")
  6386. ((= max ?e) "How many entries? ")
  6387. ((= max ?t) "How many TODO entries? ")
  6388. ((= max ?T) "How many tagged entries? ")
  6389. (t (user-error "Wrong input"))))
  6390. (num (string-to-number (read-from-minibuffer msg))))
  6391. (cond ((equal max ?e)
  6392. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6393. ((equal max ?t)
  6394. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6395. ((equal max ?T)
  6396. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6397. ((equal max ?E)
  6398. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6399. (org-agenda-fit-window-to-buffer))
  6400. (defun org-agenda-highlight-todo (x)
  6401. (let ((org-done-keywords org-done-keywords-for-agenda)
  6402. (case-fold-search nil)
  6403. re)
  6404. (if (eq x 'line)
  6405. (save-excursion
  6406. (beginning-of-line 1)
  6407. (setq re (org-get-at-bol 'org-todo-regexp))
  6408. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6409. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6410. (add-text-properties (match-beginning 0) (match-end 1)
  6411. (list 'face (org-get-todo-face 1)))
  6412. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6413. (delete-region (match-beginning 1) (1- (match-end 0)))
  6414. (goto-char (match-beginning 1))
  6415. (insert (format org-agenda-todo-keyword-format s)))))
  6416. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6417. (setq re (get-text-property 0 'org-todo-regexp x))
  6418. (when (and re
  6419. ;; Test `pl' because if there's no heading content,
  6420. ;; there's no point matching to highlight. Note
  6421. ;; that if we didn't test `pl' first, and there
  6422. ;; happened to be no keyword from `org-todo-regexp'
  6423. ;; on this heading line, then the `equal' comparison
  6424. ;; afterwards would spuriously succeed in the case
  6425. ;; where `pl' is nil -- causing an args-out-of-range
  6426. ;; error when we try to add text properties to text
  6427. ;; that isn't there.
  6428. pl
  6429. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6430. x pl) pl))
  6431. (add-text-properties
  6432. (or (match-end 1) (match-end 0)) (match-end 0)
  6433. (list 'face (org-get-todo-face (match-string 2 x)))
  6434. x)
  6435. (when (match-end 1)
  6436. (setq x
  6437. (concat
  6438. (substring x 0 (match-end 1))
  6439. (format org-agenda-todo-keyword-format
  6440. (match-string 2 x))
  6441. ;; Remove `display' property as the icon could leak
  6442. ;; on the white space.
  6443. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6444. 'display))
  6445. (substring x (match-end 3)))))))
  6446. x)))
  6447. (defsubst org-cmp-values (a b property)
  6448. "Compare the numeric value of text PROPERTY for string A and B."
  6449. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6450. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6451. (cond ((> pa pb) +1)
  6452. ((< pa pb) -1))))
  6453. (defsubst org-cmp-effort (a b)
  6454. "Compare the effort values of string A and B."
  6455. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6456. ;; `effort-minutes' property is not directly accessible from
  6457. ;; the strings, but is stored as a property in `txt'.
  6458. (ea (or (get-text-property
  6459. 0 'effort-minutes (get-text-property 0 'txt a))
  6460. def))
  6461. (eb (or (get-text-property
  6462. 0 'effort-minutes (get-text-property 0 'txt b))
  6463. def)))
  6464. (cond ((> ea eb) +1)
  6465. ((< ea eb) -1))))
  6466. (defsubst org-cmp-category (a b)
  6467. "Compare the string values of categories of strings A and B."
  6468. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6469. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6470. (cond ((string-lessp ca cb) -1)
  6471. ((string-lessp cb ca) +1))))
  6472. (defsubst org-cmp-todo-state (a b)
  6473. "Compare the todo states of strings A and B."
  6474. (let* ((ma (or (get-text-property 1 'org-marker a)
  6475. (get-text-property 1 'org-hd-marker a)))
  6476. (mb (or (get-text-property 1 'org-marker b)
  6477. (get-text-property 1 'org-hd-marker b)))
  6478. (fa (and ma (marker-buffer ma)))
  6479. (fb (and mb (marker-buffer mb)))
  6480. (todo-kwds
  6481. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6482. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6483. (ta (or (get-text-property 1 'todo-state a) ""))
  6484. (tb (or (get-text-property 1 'todo-state b) ""))
  6485. (la (- (length (member ta todo-kwds))))
  6486. (lb (- (length (member tb todo-kwds))))
  6487. (donepa (member ta org-done-keywords-for-agenda))
  6488. (donepb (member tb org-done-keywords-for-agenda)))
  6489. (cond ((and donepa (not donepb)) -1)
  6490. ((and (not donepa) donepb) +1)
  6491. ((< la lb) -1)
  6492. ((< lb la) +1))))
  6493. (defsubst org-cmp-alpha (a b)
  6494. "Compare the headlines, alphabetically."
  6495. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6496. (plb (text-property-any 0 (length b) 'org-heading t b))
  6497. (ta (and pla (substring a pla)))
  6498. (tb (and plb (substring b plb)))
  6499. (case-fold-search nil))
  6500. (when pla
  6501. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6502. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6503. (setq ta (substring ta (match-end 0))))
  6504. (setq ta (downcase ta)))
  6505. (when plb
  6506. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6507. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6508. (setq tb (substring tb (match-end 0))))
  6509. (setq tb (downcase tb)))
  6510. (cond ((not ta) +1)
  6511. ((not tb) -1)
  6512. ((string-lessp ta tb) -1)
  6513. ((string-lessp tb ta) +1))))
  6514. (defsubst org-cmp-tag (a b)
  6515. "Compare the string values of the first tags of A and B."
  6516. (let ((ta (car (last (get-text-property 1 'tags a))))
  6517. (tb (car (last (get-text-property 1 'tags b)))))
  6518. (cond ((not ta) +1)
  6519. ((not tb) -1)
  6520. ((string-lessp ta tb) -1)
  6521. ((string-lessp tb ta) +1))))
  6522. (defsubst org-cmp-time (a b)
  6523. "Compare the time-of-day values of strings A and B."
  6524. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6525. (ta (or (get-text-property 1 'time-of-day a) def))
  6526. (tb (or (get-text-property 1 'time-of-day b) def)))
  6527. (cond ((< ta tb) -1)
  6528. ((< tb ta) +1))))
  6529. (defsubst org-cmp-ts (a b type)
  6530. "Compare the timestamps values of entries A and B.
  6531. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6532. \"timestamp_ia\", compare within each of these type. When TYPE
  6533. is the empty string, compare all timestamps without respect of
  6534. their type."
  6535. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6536. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6537. (get-text-property 1 'ts-date a))
  6538. def))
  6539. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6540. (get-text-property 1 'ts-date b))
  6541. def)))
  6542. (cond ((< ta tb) -1)
  6543. ((< tb ta) +1))))
  6544. (defsubst org-cmp-habit-p (a b)
  6545. "Compare the todo states of strings A and B."
  6546. (let ((ha (get-text-property 1 'org-habit-p a))
  6547. (hb (get-text-property 1 'org-habit-p b)))
  6548. (cond ((and ha (not hb)) -1)
  6549. ((and (not ha) hb) +1))))
  6550. (defun org-entries-lessp (a b)
  6551. "Predicate for sorting agenda entries."
  6552. ;; The following variables will be used when the form is evaluated.
  6553. ;; So even though the compiler complains, keep them.
  6554. (let* ((ss org-agenda-sorting-strategy-selected)
  6555. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6556. (org-cmp-ts a b "")))
  6557. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6558. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6559. (org-cmp-ts a b "scheduled")))
  6560. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6561. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6562. (org-cmp-ts a b "deadline")))
  6563. (deadline-down (if deadline-up (- deadline-up) nil))
  6564. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6565. (org-cmp-ts a b "timestamp_ia")))
  6566. (tsia-down (if tsia-up (- tsia-up) nil))
  6567. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6568. (org-cmp-ts a b "timestamp")))
  6569. (ts-down (if ts-up (- ts-up) nil))
  6570. (time-up (and (org-em 'time-up 'time-down ss)
  6571. (org-cmp-time a b)))
  6572. (time-down (if time-up (- time-up) nil))
  6573. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6574. (org-cmp-values a b 'org-stats)))
  6575. (stats-down (if stats-up (- stats-up) nil))
  6576. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6577. (org-cmp-values a b 'priority)))
  6578. (priority-down (if priority-up (- priority-up) nil))
  6579. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6580. (org-cmp-effort a b)))
  6581. (effort-down (if effort-up (- effort-up) nil))
  6582. (category-up (and (or (org-em 'category-up 'category-down ss)
  6583. (memq 'category-keep ss))
  6584. (org-cmp-category a b)))
  6585. (category-down (if category-up (- category-up) nil))
  6586. (category-keep (if category-up +1 nil))
  6587. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6588. (org-cmp-tag a b)))
  6589. (tag-down (if tag-up (- tag-up) nil))
  6590. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6591. (org-cmp-todo-state a b)))
  6592. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6593. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6594. (org-cmp-habit-p a b)))
  6595. (habit-down (if habit-up (- habit-up) nil))
  6596. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6597. (org-cmp-alpha a b)))
  6598. (alpha-down (if alpha-up (- alpha-up) nil))
  6599. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6600. user-defined-up user-defined-down)
  6601. (if (and need-user-cmp org-agenda-cmp-user-defined
  6602. (functionp org-agenda-cmp-user-defined))
  6603. (setq user-defined-up
  6604. (funcall org-agenda-cmp-user-defined a b)
  6605. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6606. (cdr (assoc
  6607. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6608. '((-1 . t) (1 . nil) (nil . nil))))))
  6609. ;;; Agenda restriction lock
  6610. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6611. "Overlay to mark the headline to which agenda commands are restricted.")
  6612. (overlay-put org-agenda-restriction-lock-overlay
  6613. 'face 'org-agenda-restriction-lock)
  6614. (overlay-put org-agenda-restriction-lock-overlay
  6615. 'help-echo "Agendas are currently limited to this subtree.")
  6616. (delete-overlay org-agenda-restriction-lock-overlay)
  6617. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6618. "Set the restriction lock to the agenda item at point from within the agenda.
  6619. When called with a `\\[universal-argument]' prefix, restrict to
  6620. the file which contains the item.
  6621. Argument ARG is the prefix argument."
  6622. (interactive "P")
  6623. (unless (derived-mode-p 'org-agenda-mode)
  6624. (user-error "Not in an Org agenda buffer"))
  6625. (let* ((marker (or (org-get-at-bol 'org-marker)
  6626. (org-agenda-error)))
  6627. (buffer (marker-buffer marker))
  6628. (pos (marker-position marker)))
  6629. (with-current-buffer buffer
  6630. (goto-char pos)
  6631. (org-agenda-set-restriction-lock arg))))
  6632. ;;;###autoload
  6633. (defun org-agenda-set-restriction-lock (&optional type)
  6634. "Set restriction lock for agenda, to current subtree or file.
  6635. Restriction will be the file if TYPE is `file', or if type is the
  6636. universal prefix \\='(4), or if the cursor is before the first headline
  6637. in the file. Otherwise, restriction will be to the current subtree."
  6638. (interactive "P")
  6639. (org-agenda-remove-restriction-lock 'noupdate)
  6640. (and (equal type '(4)) (setq type 'file))
  6641. (setq type (cond
  6642. (type type)
  6643. ((org-at-heading-p) 'subtree)
  6644. ((condition-case nil (org-back-to-heading t) (error nil))
  6645. 'subtree)
  6646. (t 'file)))
  6647. (if (eq type 'subtree)
  6648. (progn
  6649. (setq org-agenda-restrict (current-buffer))
  6650. (setq org-agenda-overriding-restriction 'subtree)
  6651. (put 'org-agenda-files 'org-restrict
  6652. (list (buffer-file-name (buffer-base-buffer))))
  6653. (org-back-to-heading t)
  6654. (move-overlay org-agenda-restriction-lock-overlay
  6655. (point)
  6656. (if org-agenda-restriction-lock-highlight-subtree
  6657. (save-excursion (org-end-of-subtree t t) (point))
  6658. (point-at-eol)))
  6659. (move-marker org-agenda-restrict-begin (point))
  6660. (move-marker org-agenda-restrict-end
  6661. (save-excursion (org-end-of-subtree t t)))
  6662. (message "Locking agenda restriction to subtree"))
  6663. (put 'org-agenda-files 'org-restrict
  6664. (list (buffer-file-name (buffer-base-buffer))))
  6665. (setq org-agenda-restrict nil)
  6666. (setq org-agenda-overriding-restriction 'file)
  6667. (move-marker org-agenda-restrict-begin nil)
  6668. (move-marker org-agenda-restrict-end nil)
  6669. (message "Locking agenda restriction to file"))
  6670. (setq current-prefix-arg nil)
  6671. (org-agenda-maybe-redo))
  6672. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6673. "Remove the agenda restriction lock."
  6674. (interactive "P")
  6675. (delete-overlay org-agenda-restriction-lock-overlay)
  6676. (delete-overlay org-speedbar-restriction-lock-overlay)
  6677. (setq org-agenda-overriding-restriction nil)
  6678. (setq org-agenda-restrict nil)
  6679. (put 'org-agenda-files 'org-restrict nil)
  6680. (move-marker org-agenda-restrict-begin nil)
  6681. (move-marker org-agenda-restrict-end nil)
  6682. (setq current-prefix-arg nil)
  6683. (message "Agenda restriction lock removed")
  6684. (or noupdate (org-agenda-maybe-redo)))
  6685. (defun org-agenda-maybe-redo ()
  6686. "If there is any window showing the agenda view, update it."
  6687. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6688. org-agenda-buffer-name)
  6689. t))
  6690. (w0 (selected-window)))
  6691. (when w
  6692. (select-window w)
  6693. (org-agenda-redo)
  6694. (select-window w0)
  6695. (if org-agenda-overriding-restriction
  6696. (message "Agenda view shifted to new %s restriction"
  6697. org-agenda-overriding-restriction)
  6698. (message "Agenda restriction lock removed")))))
  6699. ;;; Agenda commands
  6700. (defun org-agenda-check-type (error &rest types)
  6701. "Check if agenda buffer is of allowed type.
  6702. If ERROR is non-nil, throw an error, otherwise just return nil.
  6703. Allowed types are `agenda' `todo' `tags' `search'."
  6704. (cond ((not org-agenda-type)
  6705. (error "No Org agenda currently displayed"))
  6706. ((memq org-agenda-type types) t)
  6707. (error
  6708. (error "Not allowed in %s-type agenda buffers" org-agenda-type))
  6709. (t nil)))
  6710. (defun org-agenda-Quit ()
  6711. "Exit the agenda, killing the agenda buffer.
  6712. Like `org-agenda-quit', but kill the buffer even when
  6713. `org-agenda-sticky' is non-nil."
  6714. (interactive)
  6715. (org-agenda--quit))
  6716. (defun org-agenda-quit ()
  6717. "Exit the agenda.
  6718. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6719. instead of killing it.
  6720. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6721. the pre-agenda window configuration.
  6722. When column view is active, exit column view instead of the
  6723. agenda."
  6724. (interactive)
  6725. (org-agenda--quit org-agenda-sticky))
  6726. (defun org-agenda--quit (&optional bury)
  6727. (if org-agenda-columns-active
  6728. (org-columns-quit)
  6729. (let ((wconf org-agenda-pre-window-conf)
  6730. (buf (current-buffer))
  6731. (org-agenda-last-indirect-window
  6732. (and (eq org-indirect-buffer-display 'other-window)
  6733. org-agenda-last-indirect-buffer
  6734. (get-buffer-window org-agenda-last-indirect-buffer))))
  6735. (cond
  6736. ((eq org-agenda-window-setup 'other-frame)
  6737. (delete-frame))
  6738. ((and org-agenda-restore-windows-after-quit
  6739. wconf)
  6740. ;; Maybe restore the pre-agenda window configuration. Reset
  6741. ;; `org-agenda-pre-window-conf' before running
  6742. ;; `set-window-configuration', which loses the current buffer.
  6743. (setq org-agenda-pre-window-conf nil)
  6744. (set-window-configuration wconf))
  6745. (t
  6746. (when org-agenda-last-indirect-window
  6747. (delete-window org-agenda-last-indirect-window))
  6748. (and (not (eq org-agenda-window-setup 'current-window))
  6749. (not (one-window-p))
  6750. (delete-window))))
  6751. (if bury
  6752. ;; Set the agenda buffer as the current buffer instead of
  6753. ;; passing it as an argument to `bury-buffer' so that
  6754. ;; `bury-buffer' removes it from the window.
  6755. (with-current-buffer buf
  6756. (bury-buffer))
  6757. (kill-buffer buf)
  6758. (setq org-agenda-archives-mode nil
  6759. org-agenda-buffer nil)))))
  6760. (defun org-agenda-exit ()
  6761. "Exit the agenda, killing Org buffers loaded by the agenda.
  6762. Like `org-agenda-Quit', but kill any buffers that were created by
  6763. the agenda. Org buffers visited directly by the user will not be
  6764. touched. Also, exit the agenda even if it is in column view."
  6765. (interactive)
  6766. (when org-agenda-columns-active
  6767. (org-columns-quit))
  6768. (org-release-buffers org-agenda-new-buffers)
  6769. (setq org-agenda-new-buffers nil)
  6770. (org-agenda-Quit))
  6771. (defun org-agenda-kill-all-agenda-buffers ()
  6772. "Kill all buffers in `org-agenda-mode'.
  6773. This is used when toggling sticky agendas."
  6774. (interactive)
  6775. (let (blist)
  6776. (dolist (buf (buffer-list))
  6777. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6778. (push buf blist)))
  6779. (mapc 'kill-buffer blist)))
  6780. (defun org-agenda-execute (arg)
  6781. "Execute another agenda command, keeping same window.
  6782. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6783. in the agenda."
  6784. (interactive "P")
  6785. (let ((org-agenda-window-setup 'current-window))
  6786. (org-agenda arg)))
  6787. (defun org-agenda-redo (&optional all)
  6788. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6789. (interactive "P")
  6790. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6791. (cpa (unless (eq all t) current-prefix-arg))
  6792. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6793. (org-agenda-sticky nil)
  6794. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6795. org-agenda-buffer-name))
  6796. (org-agenda-keep-modes t)
  6797. (tag-filter org-agenda-tag-filter)
  6798. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6799. (top-hl-filter org-agenda-top-headline-filter)
  6800. (cat-filter org-agenda-category-filter)
  6801. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6802. (re-filter org-agenda-regexp-filter)
  6803. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6804. (effort-filter org-agenda-effort-filter)
  6805. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6806. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6807. (cols org-agenda-columns-active)
  6808. (line (org-current-line))
  6809. (window-line (- line (org-current-line (window-start))))
  6810. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6811. (redo-cmd (get-text-property p 'org-redo-cmd))
  6812. (last-args (get-text-property p 'org-last-args))
  6813. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6814. (org-agenda-overriding-cmd-arguments
  6815. (unless (eq all t)
  6816. (cond ((listp last-args)
  6817. (cons (or cpa (car last-args)) (cdr last-args)))
  6818. ((stringp last-args)
  6819. last-args))))
  6820. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6821. (put 'org-agenda-tag-filter :preset-filter nil)
  6822. (put 'org-agenda-category-filter :preset-filter nil)
  6823. (put 'org-agenda-regexp-filter :preset-filter nil)
  6824. (put 'org-agenda-effort-filter :preset-filter nil)
  6825. (and cols (org-columns-quit))
  6826. (message "Rebuilding agenda buffer...")
  6827. (if series-redo-cmd
  6828. (eval series-redo-cmd)
  6829. (org-let lprops redo-cmd))
  6830. (setq org-agenda-undo-list nil
  6831. org-agenda-pending-undo-list nil
  6832. org-agenda-tag-filter tag-filter
  6833. org-agenda-category-filter cat-filter
  6834. org-agenda-regexp-filter re-filter
  6835. org-agenda-effort-filter effort-filter
  6836. org-agenda-top-headline-filter top-hl-filter)
  6837. (message "Rebuilding agenda buffer...done")
  6838. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6839. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6840. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6841. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6842. (let ((tag (or tag-filter tag-preset))
  6843. (cat (or cat-filter cat-preset))
  6844. (effort (or effort-filter effort-preset))
  6845. (re (or re-filter re-preset)))
  6846. (when tag (org-agenda-filter-apply tag 'tag t))
  6847. (when cat (org-agenda-filter-apply cat 'category))
  6848. (when effort (org-agenda-filter-apply effort 'effort))
  6849. (when re (org-agenda-filter-apply re 'regexp)))
  6850. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6851. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6852. (org-goto-line line)
  6853. (recenter window-line)))
  6854. (defun org-agenda-redo-all (&optional exhaustive)
  6855. "Rebuild all agenda views in the current buffer.
  6856. With a prefix argument, do so in all agenda buffers."
  6857. (interactive "P")
  6858. (if exhaustive
  6859. (dolist (buffer (buffer-list))
  6860. (with-current-buffer buffer
  6861. (when (derived-mode-p 'org-agenda-mode)
  6862. (org-agenda-redo t))))
  6863. (org-agenda-redo t)))
  6864. (defvar org-global-tags-completion-table nil)
  6865. (defvar org-agenda-filter-form nil)
  6866. (defvar org-agenda-filtered-by-category nil)
  6867. (defun org-agenda-filter-by-category (strip)
  6868. "Filter lines in the agenda buffer that have a specific category.
  6869. The category is that of the current line.
  6870. Without prefix argument, keep only the lines of that category.
  6871. With a prefix argument, exclude the lines of that category.
  6872. "
  6873. (interactive "P")
  6874. (if (and org-agenda-filtered-by-category
  6875. org-agenda-category-filter)
  6876. (org-agenda-filter-show-all-cat)
  6877. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  6878. (cond
  6879. ((and cat strip)
  6880. (org-agenda-filter-apply
  6881. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6882. (cat
  6883. (org-agenda-filter-apply
  6884. (setq org-agenda-category-filter
  6885. (list (concat "+" cat))) 'category))
  6886. (t (error "No category at point"))))))
  6887. (defun org-find-top-headline (&optional pos)
  6888. "Find the topmost parent headline and return it.
  6889. POS when non-nil is the marker or buffer position to start the
  6890. search from."
  6891. (save-excursion
  6892. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6893. (when pos (goto-char pos))
  6894. ;; Skip up to the topmost parent.
  6895. (while (org-up-heading-safe))
  6896. (ignore-errors (nth 4 (org-heading-components))))))
  6897. (defvar org-agenda-filtered-by-top-headline nil)
  6898. (defun org-agenda-filter-by-top-headline (strip)
  6899. "Keep only those lines that are descendants from the same top headline.
  6900. The top headline is that of the current line."
  6901. (interactive "P")
  6902. (if org-agenda-filtered-by-top-headline
  6903. (progn
  6904. (setq org-agenda-filtered-by-top-headline nil
  6905. org-agenda-top-headline-filter nil)
  6906. (org-agenda-filter-show-all-top-filter))
  6907. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6908. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6909. (error "No top-level headline at point")))))
  6910. (defvar org-agenda-regexp-filter nil)
  6911. (defun org-agenda-filter-by-regexp (strip)
  6912. "Filter agenda entries by a regular expression.
  6913. Regexp filters are cumulative.
  6914. With no prefix argument, keep entries matching the regexp.
  6915. With one prefix argument, filter out entries matching the regexp.
  6916. With two prefix arguments, remove the regexp filters."
  6917. (interactive "P")
  6918. (if (not (equal strip '(16)))
  6919. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6920. (read-from-minibuffer
  6921. (if (equal strip '(4))
  6922. "Filter out entries matching regexp: "
  6923. "Narrow to entries matching regexp: ")))))
  6924. (push flt org-agenda-regexp-filter)
  6925. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6926. (org-agenda-filter-show-all-re)
  6927. (message "Regexp filter removed")))
  6928. (defvar org-agenda-effort-filter nil)
  6929. (defun org-agenda-filter-by-effort (strip)
  6930. "Filter agenda entries by effort.
  6931. With no prefix argument, keep entries matching the effort condition.
  6932. With one prefix argument, filter out entries matching the condition.
  6933. With two prefix arguments, remove the effort filters."
  6934. (interactive "P")
  6935. (cond
  6936. ((member strip '(nil 4))
  6937. (let* ((efforts (split-string
  6938. (or (cdr (assoc (concat org-effort-property "_ALL")
  6939. org-global-properties))
  6940. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  6941. ;; XXX: the following handles only up to 10 different
  6942. ;; effort values.
  6943. (allowed-keys (if (null efforts) nil
  6944. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  6945. (number-sequence 1 (length efforts)))))
  6946. (op nil))
  6947. (while (not (memq op '(?< ?> ?=)))
  6948. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6949. ;; Select appropriate duration. Ignore non-digit characters.
  6950. (let ((prompt
  6951. (apply #'format
  6952. (concat "Effort %c "
  6953. (mapconcat (lambda (s) (concat "[%d]" s))
  6954. efforts
  6955. " "))
  6956. op allowed-keys))
  6957. (eff -1))
  6958. (while (not (memq eff allowed-keys))
  6959. (message prompt)
  6960. (setq eff (- (read-char-exclusive) 48)))
  6961. (setq org-agenda-effort-filter
  6962. (list (concat (if strip "-" "+")
  6963. (char-to-string op)
  6964. ;; Numbering is 1 2 3 ... 9 0, but we want
  6965. ;; 0 1 2 ... 8 9.
  6966. (nth (mod (1- eff) 10) efforts)))))
  6967. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6968. (t (org-agenda-filter-show-all-effort)
  6969. (message "Effort filter removed"))))
  6970. (defun org-agenda-filter-remove-all ()
  6971. "Remove all filters from the current agenda buffer."
  6972. (interactive)
  6973. (when org-agenda-tag-filter
  6974. (org-agenda-filter-show-all-tag))
  6975. (when org-agenda-category-filter
  6976. (org-agenda-filter-show-all-cat))
  6977. (when org-agenda-regexp-filter
  6978. (org-agenda-filter-show-all-re))
  6979. (when org-agenda-top-headline-filter
  6980. (org-agenda-filter-show-all-top-filter))
  6981. (when org-agenda-effort-filter
  6982. (org-agenda-filter-show-all-effort))
  6983. (org-agenda-finalize))
  6984. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  6985. "Keep only those lines in the agenda buffer that have a specific tag.
  6986. The tag is selected with its fast selection letter, as configured.
  6987. With a `\\[universal-argument]' prefix, exclude the agenda search.
  6988. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  6989. i.e. don't
  6990. filter on all its group members.
  6991. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  6992. should be used to exclude the search - the interactive user can
  6993. also press `-' or `+' to switch between filtering and excluding."
  6994. (interactive "P")
  6995. (let* ((alist org-tag-alist-for-agenda)
  6996. (tag-chars (mapconcat
  6997. (lambda (x) (if (and (not (symbolp (car x)))
  6998. (cdr x))
  6999. (char-to-string (cdr x))
  7000. ""))
  7001. org-tag-alist-for-agenda ""))
  7002. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  7003. (string-to-list tag-chars)))
  7004. (exclude (or exclude (equal arg '(4))))
  7005. (expand (not (equal arg '(16))))
  7006. (inhibit-read-only t)
  7007. (current org-agenda-tag-filter)
  7008. a n tag)
  7009. (unless char
  7010. (while (not (memq char valid-char-list))
  7011. (org-unlogged-message
  7012. "%s by tag [%s ]:tag-char, [TAB]:tag, %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  7013. (if exclude "Exclude" "Filter")
  7014. tag-chars
  7015. (if org-agenda-auto-exclude-function "[RET], " "")
  7016. (if expand "" ", no grouptag expand"))
  7017. (setq char (read-char-exclusive))
  7018. ;; Excluding or filtering down
  7019. (cond ((eq char ?-) (setq exclude t))
  7020. ((eq char ?+) (setq exclude nil)))))
  7021. (when (eq char ?\t)
  7022. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  7023. (setq-local org-global-tags-completion-table
  7024. (org-global-tags-completion-table)))
  7025. (let ((completion-ignore-case t))
  7026. (setq tag (completing-read
  7027. "Tag: " org-global-tags-completion-table nil t))))
  7028. (cond
  7029. ((eq char ?\r)
  7030. (org-agenda-filter-show-all-tag)
  7031. (when org-agenda-auto-exclude-function
  7032. (setq org-agenda-tag-filter nil)
  7033. (dolist (tag (org-agenda-get-represented-tags))
  7034. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7035. (if modifier
  7036. (push modifier org-agenda-tag-filter))))
  7037. (if (not (null org-agenda-tag-filter))
  7038. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7039. ((eq char ?/)
  7040. (org-agenda-filter-show-all-tag)
  7041. (when (get 'org-agenda-tag-filter :preset-filter)
  7042. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7043. ((eq char ?.)
  7044. (setq org-agenda-tag-filter
  7045. (mapcar (lambda(tag) (concat "+" tag))
  7046. (org-get-at-bol 'tags)))
  7047. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7048. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7049. ((or (eq char ?\s)
  7050. (setq a (rassoc char alist))
  7051. (and tag (setq a (cons tag nil))))
  7052. (org-agenda-filter-show-all-tag)
  7053. (setq tag (car a))
  7054. (setq org-agenda-tag-filter
  7055. (cons (concat (if exclude "-" "+") tag)
  7056. current))
  7057. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7058. (t (error "Invalid tag selection character %c" char)))))
  7059. (defun org-agenda-get-represented-tags ()
  7060. "Get a list of all tags currently represented in the agenda."
  7061. (let (p tags)
  7062. (save-excursion
  7063. (goto-char (point-min))
  7064. (while (setq p (next-single-property-change (point) 'tags))
  7065. (goto-char p)
  7066. (mapc (lambda (x) (add-to-list 'tags x))
  7067. (get-text-property (point) 'tags))))
  7068. tags))
  7069. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7070. "Create the form that tests a line for agenda filter. Optional
  7071. argument EXPAND can be used for the TYPE tag and will expand the
  7072. tags in the FILTER if any of the tags in FILTER are grouptags."
  7073. (let (f f1)
  7074. (cond
  7075. ;; Tag filter
  7076. ((eq type 'tag)
  7077. (setq filter
  7078. (delete-dups
  7079. (append (get 'org-agenda-tag-filter :preset-filter)
  7080. filter)))
  7081. (dolist (x filter)
  7082. (let ((op (string-to-char x)))
  7083. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7084. (setq x (list x)))
  7085. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7086. (push f1 f))))
  7087. ;; Category filter
  7088. ((eq type 'category)
  7089. (setq filter
  7090. (delete-dups
  7091. (append (get 'org-agenda-category-filter :preset-filter)
  7092. filter)))
  7093. (dolist (x filter)
  7094. (if (equal "-" (substring x 0 1))
  7095. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7096. (setq f1 (list 'equal (substring x 1) 'cat)))
  7097. (push f1 f)))
  7098. ;; Regexp filter
  7099. ((eq type 'regexp)
  7100. (setq filter
  7101. (delete-dups
  7102. (append (get 'org-agenda-regexp-filter :preset-filter)
  7103. filter)))
  7104. (dolist (x filter)
  7105. (if (equal "-" (substring x 0 1))
  7106. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7107. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7108. (push f1 f)))
  7109. ;; Effort filter
  7110. ((eq type 'effort)
  7111. (setq filter
  7112. (delete-dups
  7113. (append (get 'org-agenda-effort-filter :preset-filter)
  7114. filter)))
  7115. (dolist (x filter)
  7116. (push (org-agenda-filter-effort-form x) f))))
  7117. (cons 'and (nreverse f))))
  7118. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7119. "Return a form associated to tag-expression TAGS.
  7120. Build a form testing a line for agenda filter for
  7121. tag-expressions. OP is an operator of type CHAR that allows the
  7122. function to set the right switches in the returned form."
  7123. (let (form)
  7124. ;; Any of the expressions can match if OP is +, all must match if
  7125. ;; the operator is -.
  7126. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7127. (let* ((tag (substring x 1))
  7128. (f (cond
  7129. ((string= "" tag) '(not tags))
  7130. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7131. ;; TAG is a regexp.
  7132. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7133. (t (list 'member (downcase tag) 'tags)))))
  7134. (push (if (eq op ?-) (list 'not f) f) form)))))
  7135. (defun org-agenda-filter-effort-form (e)
  7136. "Return the form to compare the effort of the current line with what E says.
  7137. E looks like \"+<2:25\"."
  7138. (let (op)
  7139. (setq e (substring e 1))
  7140. (setq op (string-to-char e) e (substring e 1))
  7141. (setq op (cond ((equal op ?<) '<=)
  7142. ((equal op ?>) '>=)
  7143. ((equal op ??) op)
  7144. (t '=)))
  7145. (list 'org-agenda-compare-effort (list 'quote op)
  7146. (org-duration-to-minutes e))))
  7147. (defun org-agenda-compare-effort (op value)
  7148. "Compare the effort of the current line with VALUE, using OP.
  7149. If the line does not have an effort defined, return nil."
  7150. ;; `effort-minutes' property cannot be extracted directly from
  7151. ;; current line but is stored as a property in `txt'.
  7152. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7153. (funcall op
  7154. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7155. value)))
  7156. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7157. "Expand group tags in FILTER for the agenda.
  7158. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7159. (if org-group-tags
  7160. (let ((case-fold-search t) rtn)
  7161. (mapc
  7162. (lambda (f)
  7163. (let (f0 dir)
  7164. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7165. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7166. (setq dir (if no-operator "" "+") f0 f))
  7167. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7168. (org-tags-expand f0 t t))
  7169. rtn))))
  7170. filter)
  7171. (reverse rtn))
  7172. filter))
  7173. (defun org-agenda-filter-apply (filter type &optional expand)
  7174. "Set FILTER as the new agenda filter and apply it. Optional
  7175. argument EXPAND can be used for the TYPE tag and will expand the
  7176. tags in the FILTER if any of the tags in FILTER are grouptags."
  7177. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7178. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7179. (let (tags cat txt)
  7180. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7181. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7182. ;; category is used as the filter:
  7183. (setq org-agenda-filtered-by-category
  7184. (and (eq type 'category)
  7185. (not (equal (substring (car filter) 0 1) "-"))))
  7186. (org-agenda-set-mode-name)
  7187. (save-excursion
  7188. (goto-char (point-min))
  7189. (while (not (eobp))
  7190. (if (org-get-at-bol 'org-marker)
  7191. (progn
  7192. (setq tags (org-get-at-bol 'tags)
  7193. cat (org-get-at-eol 'org-category 1)
  7194. txt (org-get-at-bol 'txt))
  7195. (if (not (eval org-agenda-filter-form))
  7196. (org-agenda-filter-hide-line type))
  7197. (beginning-of-line 2))
  7198. (beginning-of-line 2))))
  7199. (if (get-char-property (point) 'invisible)
  7200. (ignore-errors (org-agenda-previous-line)))))
  7201. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7202. "Filter by top headline HL."
  7203. (org-agenda-set-mode-name)
  7204. (save-excursion
  7205. (goto-char (point-min))
  7206. (while (not (eobp))
  7207. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7208. (tophl (and pos (org-find-top-headline pos))))
  7209. (if (and tophl (funcall (if negative 'identity 'not)
  7210. (string= hl tophl)))
  7211. (org-agenda-filter-hide-line 'top-headline)))
  7212. (beginning-of-line 2)))
  7213. (if (get-char-property (point) 'invisible)
  7214. (org-agenda-previous-line))
  7215. (setq org-agenda-top-headline-filter hl
  7216. org-agenda-filtered-by-top-headline t))
  7217. (defun org-agenda-filter-hide-line (type)
  7218. "Hide lines with TYPE in the agenda buffer."
  7219. (let* ((b (max (point-min) (1- (point-at-bol))))
  7220. (e (point-at-eol)))
  7221. (let ((inhibit-read-only t))
  7222. (add-text-properties
  7223. b e `(invisible org-filtered org-filter-type ,type)))))
  7224. (defun org-agenda-remove-filter (type)
  7225. (interactive)
  7226. "Remove filter of type TYPE from the agenda buffer."
  7227. (save-excursion
  7228. (goto-char (point-min))
  7229. (let ((inhibit-read-only t) pos)
  7230. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7231. (goto-char pos)
  7232. (remove-text-properties
  7233. (point) (next-single-property-change (point) 'org-filter-type)
  7234. `(invisible org-filtered org-filter-type ,type))))
  7235. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7236. (setq org-agenda-filter-form nil)
  7237. (org-agenda-set-mode-name)
  7238. (org-agenda-finalize)))
  7239. (defun org-agenda-filter-show-all-tag nil
  7240. (org-agenda-remove-filter 'tag))
  7241. (defun org-agenda-filter-show-all-re nil
  7242. (org-agenda-remove-filter 'regexp))
  7243. (defun org-agenda-filter-show-all-effort nil
  7244. (org-agenda-remove-filter 'effort))
  7245. (defun org-agenda-filter-show-all-cat nil
  7246. (org-agenda-remove-filter 'category))
  7247. (defun org-agenda-filter-show-all-top-filter nil
  7248. (org-agenda-remove-filter 'top-headline))
  7249. (defun org-agenda-manipulate-query-add ()
  7250. "Manipulate the query by adding a search term with positive selection.
  7251. Positive selection means the term must be matched for selection of an entry."
  7252. (interactive)
  7253. (org-agenda-manipulate-query ?\[))
  7254. (defun org-agenda-manipulate-query-subtract ()
  7255. "Manipulate the query by adding a search term with negative selection.
  7256. Negative selection means term must not be matched for selection of an entry."
  7257. (interactive)
  7258. (org-agenda-manipulate-query ?\]))
  7259. (defun org-agenda-manipulate-query-add-re ()
  7260. "Manipulate the query by adding a search regexp with positive selection.
  7261. Positive selection means the regexp must match for selection of an entry."
  7262. (interactive)
  7263. (org-agenda-manipulate-query ?\{))
  7264. (defun org-agenda-manipulate-query-subtract-re ()
  7265. "Manipulate the query by adding a search regexp with negative selection.
  7266. Negative selection means regexp must not match for selection of an entry."
  7267. (interactive)
  7268. (org-agenda-manipulate-query ?\}))
  7269. (defun org-agenda-manipulate-query (char)
  7270. (cond
  7271. ((eq org-agenda-type 'agenda)
  7272. (let ((org-agenda-include-inactive-timestamps t))
  7273. (org-agenda-redo))
  7274. (message "Display now includes inactive timestamps as well"))
  7275. ((eq org-agenda-type 'search)
  7276. (org-add-to-string
  7277. 'org-agenda-query-string
  7278. (if org-agenda-last-search-view-search-was-boolean
  7279. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7280. (?\{ . " +{}") (?\} . " -{}"))))
  7281. " "))
  7282. (setq org-agenda-redo-command
  7283. (list 'org-search-view
  7284. (car (get-text-property (min (1- (point-max)) (point))
  7285. 'org-last-args))
  7286. org-agenda-query-string
  7287. (+ (length org-agenda-query-string)
  7288. (if (member char '(?\{ ?\})) 0 1))))
  7289. (set-register org-agenda-query-register org-agenda-query-string)
  7290. (let ((org-agenda-overriding-arguments
  7291. (cdr org-agenda-redo-command)))
  7292. (org-agenda-redo)))
  7293. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7294. org-agenda-type))))
  7295. (defun org-add-to-string (var string)
  7296. (set var (concat (symbol-value var) string)))
  7297. (defun org-agenda-goto-date (span)
  7298. "Jump to DATE in agenda."
  7299. (interactive "P")
  7300. (let* ((org-read-date-prefer-future
  7301. (eval org-agenda-jump-prefer-future))
  7302. (date (org-read-date))
  7303. (day (time-to-days (org-time-string-to-time date)))
  7304. (org-agenda-sticky-orig org-agenda-sticky)
  7305. (org-agenda-buffer-tmp-name (buffer-name))
  7306. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7307. (0-arg (or current-prefix-arg (car args)))
  7308. (2-arg (nth 2 args))
  7309. (with-hour-p (nth 4 org-agenda-redo-command))
  7310. (newcmd (list 'org-agenda-list 0-arg date
  7311. (org-agenda-span-to-ndays
  7312. 2-arg (org-time-string-to-absolute date))
  7313. with-hour-p))
  7314. (newargs (cdr newcmd))
  7315. (inhibit-read-only t)
  7316. org-agenda-sticky)
  7317. (if (not (org-agenda-check-type t 'agenda))
  7318. (error "Not available in non-agenda views")
  7319. (add-text-properties (point-min) (point-max)
  7320. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7321. (org-agenda-redo)
  7322. (goto-char (point-min))
  7323. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7324. (save-excursion (move-beginning-of-line 2) (eobp))))
  7325. (move-beginning-of-line 2))
  7326. (setq org-agenda-sticky org-agenda-sticky-orig
  7327. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7328. (defun org-agenda-goto-today ()
  7329. "Go to today."
  7330. (interactive)
  7331. (org-agenda-check-type t 'agenda)
  7332. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7333. (curspan (nth 2 args))
  7334. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7335. (cond
  7336. (tdpos (goto-char tdpos))
  7337. ((eq org-agenda-type 'agenda)
  7338. (let* ((sd (org-agenda-compute-starting-span
  7339. (org-today) (or curspan org-agenda-span)))
  7340. (org-agenda-overriding-arguments args))
  7341. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7342. (org-agenda-redo)
  7343. (org-agenda-find-same-or-today-or-agenda)))
  7344. (t (error "Cannot find today")))))
  7345. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7346. (goto-char
  7347. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7348. (text-property-any (point-min) (point-max) 'org-today t)
  7349. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7350. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7351. (org-agenda-backward-block))
  7352. (point-min))))
  7353. (defun org-agenda-backward-block ()
  7354. "Move backward by one agenda block."
  7355. (interactive)
  7356. (org-agenda-forward-block 'backward))
  7357. (defun org-agenda-forward-block (&optional backward)
  7358. "Move forward by one agenda block.
  7359. When optional argument BACKWARD is set, go backward"
  7360. (interactive)
  7361. (cond ((not (derived-mode-p 'org-agenda-mode))
  7362. (user-error
  7363. "Cannot execute this command outside of org-agenda-mode buffers"))
  7364. ((looking-at (if backward "\\`" "\\'"))
  7365. (message "Already at the %s block" (if backward "first" "last")))
  7366. (t (let ((pos (prog1 (point)
  7367. (ignore-errors (if backward (backward-char 1)
  7368. (move-end-of-line 1)))))
  7369. (f (if backward
  7370. 'previous-single-property-change
  7371. 'next-single-property-change))
  7372. moved dest)
  7373. (while (and (setq dest (funcall
  7374. f (point) 'org-agenda-structural-header))
  7375. (not (get-text-property
  7376. (point) 'org-agenda-structural-header)))
  7377. (setq moved t)
  7378. (goto-char dest))
  7379. (if moved (move-beginning-of-line 1)
  7380. (goto-char (if backward (point-min) (point-max)))
  7381. (move-beginning-of-line 1)
  7382. (message "No %s block" (if backward "previous" "further")))))))
  7383. (defun org-agenda-later (arg)
  7384. "Go forward in time by the current span.
  7385. With prefix ARG, go forward that many times the current span."
  7386. (interactive "p")
  7387. (org-agenda-check-type t 'agenda)
  7388. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7389. (span (or (nth 2 args) org-agenda-current-span))
  7390. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7391. (greg (calendar-gregorian-from-absolute sd))
  7392. (cnt (org-get-at-bol 'org-day-cnt))
  7393. greg2)
  7394. (cond
  7395. ((numberp span)
  7396. (setq sd (+ (* span arg) sd)))
  7397. ((eq span 'day)
  7398. (setq sd (+ arg sd)))
  7399. ((eq span 'week)
  7400. (setq sd (+ (* 7 arg) sd)))
  7401. ((eq span 'fortnight)
  7402. (setq sd (+ (* 14 arg) sd)))
  7403. ((eq span 'month)
  7404. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7405. sd (calendar-absolute-from-gregorian greg2))
  7406. (setcar greg2 (1+ (car greg2))))
  7407. ((eq span 'year)
  7408. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7409. sd (calendar-absolute-from-gregorian greg2))
  7410. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7411. (t
  7412. (setq sd (+ (* span arg) sd))))
  7413. (let ((org-agenda-overriding-cmd
  7414. ;; `cmd' may have been set by `org-agenda-run-series' which
  7415. ;; uses `org-agenda-overriding-cmd' to decide whether
  7416. ;; overriding is allowed for `cmd'
  7417. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7418. (org-agenda-overriding-arguments
  7419. (list (car args) sd span)))
  7420. (org-agenda-redo)
  7421. (org-agenda-find-same-or-today-or-agenda cnt))))
  7422. (defun org-agenda-earlier (arg)
  7423. "Go backward in time by the current span.
  7424. With prefix ARG, go backward that many times the current span."
  7425. (interactive "p")
  7426. (org-agenda-later (- arg)))
  7427. (defun org-agenda-view-mode-dispatch ()
  7428. "Call one of the view mode commands."
  7429. (interactive)
  7430. (org-unlogged-message
  7431. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7432. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7433. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7434. (pcase (read-char-exclusive)
  7435. (?\ (call-interactively 'org-agenda-reset-view))
  7436. (?d (call-interactively 'org-agenda-day-view))
  7437. (?w (call-interactively 'org-agenda-week-view))
  7438. (?t (call-interactively 'org-agenda-fortnight-view))
  7439. (?m (call-interactively 'org-agenda-month-view))
  7440. (?y (call-interactively 'org-agenda-year-view))
  7441. (?l (call-interactively 'org-agenda-log-mode))
  7442. (?L (org-agenda-log-mode '(4)))
  7443. (?c (org-agenda-log-mode 'clockcheck))
  7444. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7445. (?a (call-interactively 'org-agenda-archives-mode))
  7446. (?A (org-agenda-archives-mode 'files))
  7447. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7448. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7449. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7450. (?D (call-interactively 'org-agenda-toggle-diary))
  7451. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7452. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7453. (org-agenda-check-type t 'agenda)
  7454. (org-agenda-redo))
  7455. (message "Display now includes inactive timestamps as well"))
  7456. (?q (message "Abort"))
  7457. (key (user-error "Invalid key: %s" key))))
  7458. (defun org-agenda-reset-view ()
  7459. "Switch to default view for agenda."
  7460. (interactive)
  7461. (org-agenda-change-time-span org-agenda-span))
  7462. (defun org-agenda-day-view (&optional day-of-month)
  7463. "Switch to daily view for agenda.
  7464. With argument DAY-OF-MONTH, switch to that day of the month."
  7465. (interactive "P")
  7466. (org-agenda-change-time-span 'day day-of-month))
  7467. (defun org-agenda-week-view (&optional iso-week)
  7468. "Switch to weekly view for agenda.
  7469. With argument ISO-WEEK, switch to the corresponding ISO week.
  7470. If ISO-WEEK has more then 2 digits, only the last two encode
  7471. the week. Any digits before this encode a year. So 200712
  7472. means week 12 of year 2007. Years ranging from 70 years ago
  7473. to 30 years in the future can also be written as 2-digit years."
  7474. (interactive "P")
  7475. (org-agenda-change-time-span 'week iso-week))
  7476. (defun org-agenda-fortnight-view (&optional iso-week)
  7477. "Switch to fortnightly view for agenda.
  7478. With argument ISO-WEEK, switch to the corresponding ISO week.
  7479. If ISO-WEEK has more then 2 digits, only the last two encode
  7480. the week. Any digits before this encode a year. So 200712
  7481. means week 12 of year 2007. Years ranging from 70 years ago
  7482. to 30 years in the future can also be written as 2-digit years."
  7483. (interactive "P")
  7484. (org-agenda-change-time-span 'fortnight iso-week))
  7485. (defun org-agenda-month-view (&optional month)
  7486. "Switch to monthly view for agenda.
  7487. With argument MONTH, switch to that month. If MONTH has more
  7488. then 2 digits, only the last two encode the month. Any digits
  7489. before this encode a year. So 200712 means December year 2007.
  7490. Years ranging from 70 years ago to 30 years in the future can
  7491. also be written as 2-digit years."
  7492. (interactive "P")
  7493. (org-agenda-change-time-span 'month month))
  7494. (defun org-agenda-year-view (&optional year)
  7495. "Switch to yearly view for agenda.
  7496. With argument YEAR, switch to that year. Years ranging from 70
  7497. years ago to 30 years in the future can also be written as
  7498. 2-digit years."
  7499. (interactive "P")
  7500. (when year
  7501. (setq year (org-small-year-to-year year)))
  7502. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7503. (org-agenda-change-time-span 'year year)
  7504. (error "Abort")))
  7505. (defun org-agenda-change-time-span (span &optional n)
  7506. "Change the agenda view to SPAN.
  7507. SPAN may be `day', `week', `fortnight', `month', `year'."
  7508. (org-agenda-check-type t 'agenda)
  7509. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7510. (curspan (nth 2 args)))
  7511. (if (and (not n) (equal curspan span))
  7512. (error "Viewing span is already \"%s\"" span))
  7513. (let* ((sd (or (org-get-at-bol 'day)
  7514. (nth 1 args)
  7515. org-starting-day))
  7516. (sd (org-agenda-compute-starting-span sd span n))
  7517. (org-agenda-overriding-cmd
  7518. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7519. (org-agenda-overriding-arguments
  7520. (list (car args) sd span)))
  7521. (org-agenda-redo)
  7522. (org-agenda-find-same-or-today-or-agenda))
  7523. (org-agenda-set-mode-name)
  7524. (message "Switched to %s view" span)))
  7525. (defun org-agenda-compute-starting-span (sd span &optional n)
  7526. "Compute starting date for agenda.
  7527. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7528. is a cons cell with the starting date and the number of days,
  7529. so that the date SD will be in that range."
  7530. (let* ((greg (calendar-gregorian-from-absolute sd))
  7531. (dg (nth 1 greg))
  7532. (mg (car greg))
  7533. (yg (nth 2 greg)))
  7534. (cond
  7535. ((eq span 'day)
  7536. (when n
  7537. (setq sd (+ (calendar-absolute-from-gregorian
  7538. (list mg 1 yg))
  7539. n -1))))
  7540. ((or (eq span 'week) (eq span 'fortnight))
  7541. (let* ((nt (calendar-day-of-week
  7542. (calendar-gregorian-from-absolute sd)))
  7543. (d (if org-agenda-start-on-weekday
  7544. (- nt org-agenda-start-on-weekday)
  7545. 0))
  7546. y1)
  7547. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7548. (when n
  7549. (require 'cal-iso)
  7550. (when (> n 99)
  7551. (setq y1 (org-small-year-to-year (/ n 100))
  7552. n (mod n 100)))
  7553. (setq sd
  7554. (calendar-iso-to-absolute
  7555. (list n 1
  7556. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7557. ((eq span 'month)
  7558. (let (y1)
  7559. (when (and n (> n 99))
  7560. (setq y1 (org-small-year-to-year (/ n 100))
  7561. n (mod n 100)))
  7562. (setq sd (calendar-absolute-from-gregorian
  7563. (list (or n mg) 1 (or y1 yg))))))
  7564. ((eq span 'year)
  7565. (setq sd (calendar-absolute-from-gregorian
  7566. (list 1 1 (or n yg))))))
  7567. sd))
  7568. (defun org-agenda-next-date-line (&optional arg)
  7569. "Jump to the next line indicating a date in agenda buffer."
  7570. (interactive "p")
  7571. (org-agenda-check-type t 'agenda)
  7572. (beginning-of-line 1)
  7573. ;; This does not work if user makes date format that starts with a blank
  7574. (if (looking-at "^\\S-") (forward-char 1))
  7575. (if (not (re-search-forward "^\\S-" nil t arg))
  7576. (progn
  7577. (backward-char 1)
  7578. (error "No next date after this line in this buffer")))
  7579. (goto-char (match-beginning 0)))
  7580. (defun org-agenda-previous-date-line (&optional arg)
  7581. "Jump to the previous line indicating a date in agenda buffer."
  7582. (interactive "p")
  7583. (org-agenda-check-type t 'agenda)
  7584. (beginning-of-line 1)
  7585. (if (not (re-search-backward "^\\S-" nil t arg))
  7586. (error "No previous date before this line in this buffer")))
  7587. ;; Initialize the highlight
  7588. (defvar org-hl (make-overlay 1 1))
  7589. (overlay-put org-hl 'face 'highlight)
  7590. (defun org-highlight (begin end &optional buffer)
  7591. "Highlight a region with overlay."
  7592. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7593. (defun org-unhighlight ()
  7594. "Detach overlay INDEX."
  7595. (delete-overlay org-hl))
  7596. (defun org-unhighlight-once ()
  7597. "Remove the highlight from its position, and this function from the hook."
  7598. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7599. (org-unhighlight))
  7600. (defvar org-agenda-pre-follow-window-conf nil)
  7601. (defun org-agenda-follow-mode ()
  7602. "Toggle follow mode in an agenda buffer."
  7603. (interactive)
  7604. (unless org-agenda-follow-mode
  7605. (setq org-agenda-pre-follow-window-conf
  7606. (current-window-configuration)))
  7607. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7608. (unless org-agenda-follow-mode
  7609. (set-window-configuration org-agenda-pre-follow-window-conf))
  7610. (org-agenda-set-mode-name)
  7611. (org-agenda-do-context-action)
  7612. (message "Follow mode is %s"
  7613. (if org-agenda-follow-mode "on" "off")))
  7614. (defun org-agenda-entry-text-mode (&optional arg)
  7615. "Toggle entry text mode in an agenda buffer."
  7616. (interactive "P")
  7617. (if (or org-agenda-tag-filter
  7618. org-agenda-category-filter
  7619. org-agenda-regexp-filter
  7620. org-agenda-top-headline-filter)
  7621. (user-error "Can't show entry text in filtered views")
  7622. (setq org-agenda-entry-text-mode (or (integerp arg)
  7623. (not org-agenda-entry-text-mode)))
  7624. (org-agenda-entry-text-hide)
  7625. (and org-agenda-entry-text-mode
  7626. (let ((org-agenda-entry-text-maxlines
  7627. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7628. (org-agenda-entry-text-show)))
  7629. (org-agenda-set-mode-name)
  7630. (message "Entry text mode is %s%s"
  7631. (if org-agenda-entry-text-mode "on" "off")
  7632. (if (not org-agenda-entry-text-mode) ""
  7633. (format " (maximum number of lines is %d)"
  7634. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7635. (defun org-agenda-clockreport-mode ()
  7636. "Toggle clocktable mode in an agenda buffer."
  7637. (interactive)
  7638. (org-agenda-check-type t 'agenda)
  7639. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7640. (org-agenda-set-mode-name)
  7641. (org-agenda-redo)
  7642. (message "Clocktable mode is %s"
  7643. (if org-agenda-clockreport-mode "on" "off")))
  7644. (defun org-agenda-log-mode (&optional special)
  7645. "Toggle log mode in an agenda buffer.
  7646. With argument SPECIAL, show all possible log items, not only the ones
  7647. configured in `org-agenda-log-mode-items'.
  7648. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7649. log items, nothing else."
  7650. (interactive "P")
  7651. (org-agenda-check-type t 'agenda)
  7652. (setq org-agenda-show-log
  7653. (cond
  7654. ((equal special '(16)) 'only)
  7655. ((eq special 'clockcheck)
  7656. (if (eq org-agenda-show-log 'clockcheck)
  7657. nil 'clockcheck))
  7658. (special '(closed clock state))
  7659. (t (not org-agenda-show-log))))
  7660. (org-agenda-set-mode-name)
  7661. (org-agenda-redo)
  7662. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7663. (defun org-agenda-archives-mode (&optional with-files)
  7664. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7665. When called with a prefix argument, include all archive files as well."
  7666. (interactive "P")
  7667. (setq org-agenda-archives-mode
  7668. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7669. (org-agenda-set-mode-name)
  7670. (org-agenda-redo)
  7671. (message
  7672. "%s"
  7673. (cond
  7674. ((eq org-agenda-archives-mode nil)
  7675. "No archives are included")
  7676. ((eq org-agenda-archives-mode 'trees)
  7677. (format "Trees with :%s: tag are included" org-archive-tag))
  7678. ((eq org-agenda-archives-mode t)
  7679. (format "Trees with :%s: tag and all active archive files are included"
  7680. org-archive-tag)))))
  7681. (defun org-agenda-toggle-diary ()
  7682. "Toggle diary inclusion in an agenda buffer."
  7683. (interactive)
  7684. (org-agenda-check-type t 'agenda)
  7685. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7686. (org-agenda-redo)
  7687. (org-agenda-set-mode-name)
  7688. (message "Diary inclusion turned %s"
  7689. (if org-agenda-include-diary "on" "off")))
  7690. (defun org-agenda-toggle-deadlines ()
  7691. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7692. (interactive)
  7693. (org-agenda-check-type t 'agenda)
  7694. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7695. (org-agenda-redo)
  7696. (org-agenda-set-mode-name)
  7697. (message "Deadlines inclusion turned %s"
  7698. (if org-agenda-include-deadlines "on" "off")))
  7699. (defun org-agenda-toggle-time-grid ()
  7700. "Toggle time grid in an agenda buffer."
  7701. (interactive)
  7702. (org-agenda-check-type t 'agenda)
  7703. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7704. (org-agenda-redo)
  7705. (org-agenda-set-mode-name)
  7706. (message "Time-grid turned %s"
  7707. (if org-agenda-use-time-grid "on" "off")))
  7708. (defun org-agenda-set-mode-name ()
  7709. "Set the mode name to indicate all the small mode settings."
  7710. (setq mode-name
  7711. (list "Org-Agenda"
  7712. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7713. " "
  7714. '(:eval (org-agenda-span-name org-agenda-current-span))
  7715. (if org-agenda-follow-mode " Follow" "")
  7716. (if org-agenda-entry-text-mode " ETxt" "")
  7717. (if org-agenda-include-diary " Diary" "")
  7718. (if org-agenda-include-deadlines " Ddl" "")
  7719. (if org-agenda-use-time-grid " Grid" "")
  7720. (if (and (boundp 'org-habit-show-habits)
  7721. org-habit-show-habits) " Habit" "")
  7722. (cond
  7723. ((consp org-agenda-show-log) " LogAll")
  7724. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7725. (org-agenda-show-log " Log")
  7726. (t ""))
  7727. (if (or org-agenda-category-filter
  7728. (get 'org-agenda-category-filter :preset-filter))
  7729. '(:eval (propertize
  7730. (concat " <"
  7731. (mapconcat
  7732. 'identity
  7733. (append
  7734. (get 'org-agenda-category-filter :preset-filter)
  7735. org-agenda-category-filter)
  7736. "")
  7737. ">")
  7738. 'face 'org-agenda-filter-category
  7739. 'help-echo "Category used in filtering")) "")
  7740. (if (or org-agenda-tag-filter
  7741. (get 'org-agenda-tag-filter :preset-filter))
  7742. '(:eval (propertize
  7743. (concat " {"
  7744. (mapconcat
  7745. 'identity
  7746. (append
  7747. (get 'org-agenda-tag-filter :preset-filter)
  7748. org-agenda-tag-filter)
  7749. "")
  7750. "}")
  7751. 'face 'org-agenda-filter-tags
  7752. 'help-echo "Tags used in filtering")) "")
  7753. (if (or org-agenda-effort-filter
  7754. (get 'org-agenda-effort-filter :preset-filter))
  7755. '(:eval (propertize
  7756. (concat " {"
  7757. (mapconcat
  7758. 'identity
  7759. (append
  7760. (get 'org-agenda-effort-filter :preset-filter)
  7761. org-agenda-effort-filter)
  7762. "")
  7763. "}")
  7764. 'face 'org-agenda-filter-effort
  7765. 'help-echo "Effort conditions used in filtering")) "")
  7766. (if (or org-agenda-regexp-filter
  7767. (get 'org-agenda-regexp-filter :preset-filter))
  7768. '(:eval (propertize
  7769. (concat " ["
  7770. (mapconcat
  7771. 'identity
  7772. (append
  7773. (get 'org-agenda-regexp-filter :preset-filter)
  7774. org-agenda-regexp-filter)
  7775. "")
  7776. "]")
  7777. 'face 'org-agenda-filter-regexp
  7778. 'help-echo "Regexp used in filtering")) "")
  7779. (if org-agenda-archives-mode
  7780. (if (eq org-agenda-archives-mode t)
  7781. " Archives"
  7782. (format " :%s:" org-archive-tag))
  7783. "")
  7784. (if org-agenda-clockreport-mode " Clock" "")))
  7785. (force-mode-line-update))
  7786. (defun org-agenda-update-agenda-type ()
  7787. "Update the agenda type after each command."
  7788. (setq org-agenda-type
  7789. (or (get-text-property (point) 'org-agenda-type)
  7790. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7791. (defun org-agenda-next-line ()
  7792. "Move cursor to the next line, and show if follow mode is active."
  7793. (interactive)
  7794. (call-interactively 'next-line)
  7795. (org-agenda-do-context-action))
  7796. (defun org-agenda-previous-line ()
  7797. "Move cursor to the previous line, and show if follow-mode is active."
  7798. (interactive)
  7799. (call-interactively 'previous-line)
  7800. (org-agenda-do-context-action))
  7801. (defun org-agenda-next-item (n)
  7802. "Move cursor to next agenda item."
  7803. (interactive "p")
  7804. (let ((col (current-column)))
  7805. (dotimes (c n)
  7806. (when (next-single-property-change (point-at-eol) 'org-marker)
  7807. (move-end-of-line 1)
  7808. (goto-char (next-single-property-change (point) 'org-marker))))
  7809. (org-move-to-column col))
  7810. (org-agenda-do-context-action))
  7811. (defun org-agenda-previous-item (n)
  7812. "Move cursor to next agenda item."
  7813. (interactive "p")
  7814. (dotimes (c n)
  7815. (let ((col (current-column))
  7816. (goto (save-excursion
  7817. (move-end-of-line 0)
  7818. (previous-single-property-change (point) 'org-marker))))
  7819. (if goto (goto-char goto))
  7820. (org-move-to-column col)))
  7821. (org-agenda-do-context-action))
  7822. (defun org-agenda-do-context-action ()
  7823. "Show outline path and, maybe, follow mode window."
  7824. (let ((m (org-get-at-bol 'org-marker)))
  7825. (when (and (markerp m) (marker-buffer m))
  7826. (and org-agenda-follow-mode
  7827. (if org-agenda-follow-indirect
  7828. (org-agenda-tree-to-indirect-buffer nil)
  7829. (org-agenda-show)))
  7830. (and org-agenda-show-outline-path
  7831. (org-with-point-at m (org-display-outline-path t))))))
  7832. (defun org-agenda-show-tags ()
  7833. "Show the tags applicable to the current item."
  7834. (interactive)
  7835. (let* ((tags (org-get-at-bol 'tags)))
  7836. (if tags
  7837. (message "Tags are :%s:"
  7838. (org-no-properties (mapconcat 'identity tags ":")))
  7839. (message "No tags associated with this line"))))
  7840. (defun org-agenda-goto (&optional highlight)
  7841. "Go to the entry at point in the corresponding Org file."
  7842. (interactive)
  7843. (let* ((marker (or (org-get-at-bol 'org-marker)
  7844. (org-agenda-error)))
  7845. (buffer (marker-buffer marker))
  7846. (pos (marker-position marker)))
  7847. (switch-to-buffer-other-window buffer)
  7848. (widen)
  7849. (push-mark)
  7850. (goto-char pos)
  7851. (when (derived-mode-p 'org-mode)
  7852. (org-show-context 'agenda)
  7853. (recenter (/ (window-height) 2))
  7854. (org-back-to-heading t)
  7855. (let ((case-fold-search nil))
  7856. (when (re-search-forward org-complex-heading-regexp nil t)
  7857. (goto-char (match-beginning 4)))))
  7858. (run-hooks 'org-agenda-after-show-hook)
  7859. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7860. (defvar org-agenda-after-show-hook nil
  7861. "Normal hook run after an item has been shown from the agenda.
  7862. Point is in the buffer where the item originated.")
  7863. (defun org-agenda-kill ()
  7864. "Kill the entry or subtree belonging to the current agenda entry."
  7865. (interactive)
  7866. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7867. (let* ((bufname-orig (buffer-name))
  7868. (marker (or (org-get-at-bol 'org-marker)
  7869. (org-agenda-error)))
  7870. (buffer (marker-buffer marker))
  7871. (pos (marker-position marker))
  7872. (type (org-get-at-bol 'type))
  7873. dbeg dend (n 0) conf)
  7874. (org-with-remote-undo buffer
  7875. (with-current-buffer buffer
  7876. (save-excursion
  7877. (goto-char pos)
  7878. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7879. (setq dbeg (progn (org-back-to-heading t) (point))
  7880. dend (org-end-of-subtree t t))
  7881. (setq dbeg (point-at-bol)
  7882. dend (min (point-max) (1+ (point-at-eol)))))
  7883. (goto-char dbeg)
  7884. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7885. (setq conf (or (eq t org-agenda-confirm-kill)
  7886. (and (numberp org-agenda-confirm-kill)
  7887. (> n org-agenda-confirm-kill))))
  7888. (and conf
  7889. (not (y-or-n-p
  7890. (format "Delete entry with %d lines in buffer \"%s\"? "
  7891. n (buffer-name buffer))))
  7892. (error "Abort"))
  7893. (let ((org-agenda-buffer-name bufname-orig))
  7894. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7895. (with-current-buffer buffer (delete-region dbeg dend))
  7896. (message "Agenda item and source killed"))))
  7897. (defvar org-archive-default-command) ; defined in org-archive.el
  7898. (defun org-agenda-archive-default ()
  7899. "Archive the entry or subtree belonging to the current agenda entry."
  7900. (interactive)
  7901. (require 'org-archive)
  7902. (org-agenda-archive-with org-archive-default-command))
  7903. (defun org-agenda-archive-default-with-confirmation ()
  7904. "Archive the entry or subtree belonging to the current agenda entry."
  7905. (interactive)
  7906. (require 'org-archive)
  7907. (org-agenda-archive-with org-archive-default-command 'confirm))
  7908. (defun org-agenda-archive ()
  7909. "Archive the entry or subtree belonging to the current agenda entry."
  7910. (interactive)
  7911. (org-agenda-archive-with 'org-archive-subtree))
  7912. (defun org-agenda-archive-to-archive-sibling ()
  7913. "Move the entry to the archive sibling."
  7914. (interactive)
  7915. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7916. (defun org-agenda-archive-with (cmd &optional confirm)
  7917. "Move the entry to the archive sibling."
  7918. (interactive)
  7919. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7920. (let* ((bufname-orig (buffer-name))
  7921. (marker (or (org-get-at-bol 'org-marker)
  7922. (org-agenda-error)))
  7923. (buffer (marker-buffer marker))
  7924. (pos (marker-position marker)))
  7925. (org-with-remote-undo buffer
  7926. (with-current-buffer buffer
  7927. (if (derived-mode-p 'org-mode)
  7928. (if (and confirm
  7929. (not (y-or-n-p "Archive this subtree or entry? ")))
  7930. (error "Abort")
  7931. (save-window-excursion
  7932. (goto-char pos)
  7933. (let ((org-agenda-buffer-name bufname-orig))
  7934. (org-remove-subtree-entries-from-agenda))
  7935. (org-back-to-heading t)
  7936. (funcall cmd)))
  7937. (error "Archiving works only in Org files"))))))
  7938. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7939. "Remove all lines in the agenda that correspond to a given subtree.
  7940. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7941. If this information is not given, the function uses the tree at point."
  7942. (let ((buf (or buf (current-buffer))) m p)
  7943. (save-excursion
  7944. (unless (and beg end)
  7945. (org-back-to-heading t)
  7946. (setq beg (point))
  7947. (org-end-of-subtree t)
  7948. (setq end (point)))
  7949. (set-buffer (get-buffer org-agenda-buffer-name))
  7950. (save-excursion
  7951. (goto-char (point-max))
  7952. (beginning-of-line 1)
  7953. (while (not (bobp))
  7954. (when (and (setq m (org-get-at-bol 'org-marker))
  7955. (equal buf (marker-buffer m))
  7956. (setq p (marker-position m))
  7957. (>= p beg)
  7958. (< p end))
  7959. (let ((inhibit-read-only t))
  7960. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7961. (beginning-of-line 0))))))
  7962. (defun org-agenda-refile (&optional goto rfloc no-update)
  7963. "Refile the item at point.
  7964. When called with `\\[universal-argument] \\[universal-argument]', \
  7965. go to the location of the last
  7966. refiled item.
  7967. When called with `\\[universal-argument] \\[universal-argument] \
  7968. \\[universal-argument]' prefix or when GOTO is 0, clear
  7969. the refile cache.
  7970. RFLOC can be a refile location obtained in a different way.
  7971. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7972. (interactive "P")
  7973. (cond
  7974. ((member goto '(0 (64)))
  7975. (org-refile-cache-clear))
  7976. ((equal goto '(16))
  7977. (org-refile-goto-last-stored))
  7978. (t
  7979. (let* ((buffer-orig (buffer-name))
  7980. (marker (or (org-get-at-bol 'org-hd-marker)
  7981. (org-agenda-error)))
  7982. (buffer (marker-buffer marker))
  7983. (pos (marker-position marker))
  7984. (rfloc (or rfloc
  7985. (org-refile-get-location
  7986. (if goto "Goto" "Refile to") buffer
  7987. org-refile-allow-creating-parent-nodes))))
  7988. (with-current-buffer buffer
  7989. (org-with-wide-buffer
  7990. (goto-char marker)
  7991. (let ((org-agenda-buffer-name buffer-orig))
  7992. (org-remove-subtree-entries-from-agenda))
  7993. (org-refile goto buffer rfloc))))
  7994. (unless no-update (org-agenda-redo)))))
  7995. (defun org-agenda-open-link (&optional arg)
  7996. "Open the link(s) in the current entry, if any.
  7997. This looks for a link in the displayed line in the agenda.
  7998. It also looks at the text of the entry itself."
  7999. (interactive "P")
  8000. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8001. (org-get-at-bol 'org-marker)))
  8002. (buffer (and marker (marker-buffer marker)))
  8003. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8004. (lkall (and buffer (org-offer-links-in-entry
  8005. buffer marker arg prefix)))
  8006. (lk0 (car lkall))
  8007. (lk (if (stringp lk0) (list lk0) lk0))
  8008. (lkend (cdr lkall))
  8009. trg)
  8010. (cond
  8011. ((and buffer lk)
  8012. (mapcar (lambda(l)
  8013. (with-current-buffer buffer
  8014. (setq trg (and (string-match org-bracket-link-regexp l)
  8015. (match-string 1 l)))
  8016. (if (or (not trg) (string-match org-any-link-re trg))
  8017. (org-with-wide-buffer
  8018. (goto-char marker)
  8019. (when (search-forward l nil lkend)
  8020. (goto-char (match-beginning 0))
  8021. (org-open-at-point)))
  8022. ;; This is an internal link, widen the buffer
  8023. (switch-to-buffer-other-window buffer)
  8024. (widen)
  8025. (goto-char marker)
  8026. (when (search-forward l nil lkend)
  8027. (goto-char (match-beginning 0))
  8028. (org-open-at-point)))))
  8029. lk))
  8030. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  8031. (save-excursion
  8032. (beginning-of-line 1)
  8033. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  8034. (org-open-link-from-string (match-string 1)))
  8035. (t (message "No link to open here")))))
  8036. (defun org-agenda-copy-local-variable (var)
  8037. "Get a variable from a referenced buffer and install it here."
  8038. (let ((m (org-get-at-bol 'org-marker)))
  8039. (when (and m (buffer-live-p (marker-buffer m)))
  8040. (set (make-local-variable var)
  8041. (with-current-buffer (marker-buffer m)
  8042. (symbol-value var))))))
  8043. (defun org-agenda-switch-to (&optional delete-other-windows)
  8044. "Go to the Org mode file which contains the item at point.
  8045. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8046. displayed Org file fills the frame."
  8047. (interactive)
  8048. (if (and org-return-follows-link
  8049. (not (org-get-at-bol 'org-marker))
  8050. (org-in-regexp org-bracket-link-regexp))
  8051. (org-open-link-from-string (match-string 0))
  8052. (let* ((marker (or (org-get-at-bol 'org-marker)
  8053. (org-agenda-error)))
  8054. (buffer (marker-buffer marker))
  8055. (pos (marker-position marker)))
  8056. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8057. (pop-to-buffer-same-window buffer)
  8058. (when delete-other-windows (delete-other-windows))
  8059. (widen)
  8060. (goto-char pos)
  8061. (when (derived-mode-p 'org-mode)
  8062. (org-show-context 'agenda)
  8063. (run-hooks 'org-agenda-after-show-hook)))))
  8064. (defun org-agenda-goto-mouse (ev)
  8065. "Go to the Org file which contains the item at the mouse click."
  8066. (interactive "e")
  8067. (mouse-set-point ev)
  8068. (org-agenda-goto))
  8069. (defun org-agenda-show (&optional full-entry)
  8070. "Display the Org file which contains the item at point.
  8071. With prefix argument FULL-ENTRY, make the entire entry visible
  8072. if it was hidden in the outline."
  8073. (interactive "P")
  8074. (let ((win (selected-window)))
  8075. (org-agenda-goto t)
  8076. (when full-entry (org-show-entry))
  8077. (select-window win)))
  8078. (defvar org-agenda-show-window nil)
  8079. (defun org-agenda-show-and-scroll-up (&optional arg)
  8080. "Display the Org file which contains the item at point.
  8081. When called repeatedly, scroll the window that is displaying the buffer.
  8082. With a `\\[universal-argument]' prefix, use `org-show-entry' instead of \
  8083. `outline-show-subtree'
  8084. to display the item, so that drawers and logbooks stay folded."
  8085. (interactive "P")
  8086. (let ((win (selected-window)))
  8087. (if (and (window-live-p org-agenda-show-window)
  8088. (eq this-command last-command))
  8089. (progn
  8090. (select-window org-agenda-show-window)
  8091. (ignore-errors (scroll-up)))
  8092. (org-agenda-goto t)
  8093. (if arg (org-show-entry) (outline-show-subtree))
  8094. (setq org-agenda-show-window (selected-window)))
  8095. (select-window win)))
  8096. (defun org-agenda-show-scroll-down ()
  8097. "Scroll down the window showing the agenda."
  8098. (interactive)
  8099. (let ((win (selected-window)))
  8100. (when (window-live-p org-agenda-show-window)
  8101. (select-window org-agenda-show-window)
  8102. (ignore-errors (scroll-down))
  8103. (select-window win))))
  8104. (defun org-agenda-show-1 (&optional more)
  8105. "Display the Org file which contains the item at point.
  8106. The prefix arg selects the amount of information to display:
  8107. 0 hide the subtree
  8108. 1 just show the entry according to defaults.
  8109. 2 show the children view
  8110. 3 show the subtree view
  8111. 4 show the entire subtree and any LOGBOOK drawers
  8112. 5 show the entire subtree and any drawers
  8113. With prefix argument FULL-ENTRY, make the entire entry visible
  8114. if it was hidden in the outline."
  8115. (interactive "p")
  8116. (let ((win (selected-window)))
  8117. (org-agenda-goto t)
  8118. (org-back-to-heading)
  8119. (set-window-start (selected-window) (point-at-bol))
  8120. (cond
  8121. ((= more 0)
  8122. (outline-hide-subtree)
  8123. (save-excursion
  8124. (org-back-to-heading)
  8125. (run-hook-with-args 'org-cycle-hook 'folded))
  8126. (message "Remote: FOLDED"))
  8127. ((and (called-interactively-p 'any) (= more 1))
  8128. (message "Remote: show with default settings"))
  8129. ((= more 2)
  8130. (outline-show-entry)
  8131. (org-show-children)
  8132. (save-excursion
  8133. (org-back-to-heading)
  8134. (run-hook-with-args 'org-cycle-hook 'children))
  8135. (message "Remote: CHILDREN"))
  8136. ((= more 3)
  8137. (outline-show-subtree)
  8138. (save-excursion
  8139. (org-back-to-heading)
  8140. (run-hook-with-args 'org-cycle-hook 'subtree))
  8141. (message "Remote: SUBTREE"))
  8142. ((= more 4)
  8143. (outline-show-subtree)
  8144. (save-excursion
  8145. (org-back-to-heading)
  8146. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8147. (message "Remote: SUBTREE AND LOGBOOK"))
  8148. ((> more 4)
  8149. (outline-show-subtree)
  8150. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8151. (select-window win)))
  8152. (defvar org-agenda-cycle-counter nil)
  8153. (defun org-agenda-cycle-show (&optional n)
  8154. "Show the current entry in another window, with default settings.
  8155. Default settings are taken from `org-show-context-detail'. When
  8156. use repeatedly in immediate succession, the remote entry will
  8157. cycle through visibility
  8158. children -> subtree -> folded
  8159. When called with a numeric prefix arg, that arg will be passed through to
  8160. `org-agenda-show-1'. For the interpretation of that argument, see the
  8161. docstring of `org-agenda-show-1'."
  8162. (interactive "P")
  8163. (if (integerp n)
  8164. (setq org-agenda-cycle-counter n)
  8165. (if (not (eq last-command this-command))
  8166. (setq org-agenda-cycle-counter 1)
  8167. (if (equal org-agenda-cycle-counter 0)
  8168. (setq org-agenda-cycle-counter 2)
  8169. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8170. (if (> org-agenda-cycle-counter 3)
  8171. (setq org-agenda-cycle-counter 0)))))
  8172. (org-agenda-show-1 org-agenda-cycle-counter))
  8173. (defun org-agenda-recenter (arg)
  8174. "Display the Org file which contains the item at point and recenter."
  8175. (interactive "P")
  8176. (let ((win (selected-window)))
  8177. (org-agenda-goto t)
  8178. (recenter arg)
  8179. (select-window win)))
  8180. (defun org-agenda-show-mouse (ev)
  8181. "Display the Org file which contains the item at the mouse click."
  8182. (interactive "e")
  8183. (mouse-set-point ev)
  8184. (org-agenda-show))
  8185. (defun org-agenda-check-no-diary ()
  8186. "Check if the entry is a diary link and abort if yes."
  8187. (if (org-get-at-bol 'org-agenda-diary-link)
  8188. (org-agenda-error)))
  8189. (defun org-agenda-error ()
  8190. "Throw an error when a command is not allowed in the agenda."
  8191. (user-error "Command not allowed in this line"))
  8192. (defun org-agenda-tree-to-indirect-buffer (arg)
  8193. "Show the subtree corresponding to the current entry in an indirect buffer.
  8194. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8195. With a numerical prefix ARG, go up to this level and then take that tree.
  8196. With a negative numeric ARG, go up by this number of levels.
  8197. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8198. i.e. don't use
  8199. the dedicated frame."
  8200. (interactive "P")
  8201. (if current-prefix-arg
  8202. (org-agenda-do-tree-to-indirect-buffer arg)
  8203. (let ((agenda-buffer (buffer-name))
  8204. (agenda-window (selected-window))
  8205. (indirect-window
  8206. (and org-last-indirect-buffer
  8207. (get-buffer-window org-last-indirect-buffer))))
  8208. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8209. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8210. (eq org-indirect-buffer-display 'dedicated-frame))
  8211. (unwind-protect
  8212. (unless (and indirect-window (window-live-p indirect-window))
  8213. (setq indirect-window (split-window agenda-window)))
  8214. (and indirect-window (select-window indirect-window))
  8215. (switch-to-buffer org-last-indirect-buffer :norecord)
  8216. (fit-window-to-buffer indirect-window)))
  8217. (select-window (get-buffer-window agenda-buffer))
  8218. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8219. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8220. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8221. (org-agenda-check-no-diary)
  8222. (let* ((marker (or (org-get-at-bol 'org-marker)
  8223. (org-agenda-error)))
  8224. (buffer (marker-buffer marker))
  8225. (pos (marker-position marker)))
  8226. (with-current-buffer buffer
  8227. (save-excursion
  8228. (goto-char pos)
  8229. (funcall 'org-tree-to-indirect-buffer arg)))))
  8230. (defvar org-last-heading-marker (make-marker)
  8231. "Marker pointing to the headline that last changed its TODO state
  8232. by a remote command from the agenda.")
  8233. (defun org-agenda-todo-nextset ()
  8234. "Switch TODO entry to next sequence."
  8235. (interactive)
  8236. (org-agenda-todo 'nextset))
  8237. (defun org-agenda-todo-previousset ()
  8238. "Switch TODO entry to previous sequence."
  8239. (interactive)
  8240. (org-agenda-todo 'previousset))
  8241. (defun org-agenda-todo (&optional arg)
  8242. "Cycle TODO state of line at point, also in Org file.
  8243. This changes the line at point, all other lines in the agenda referring to
  8244. the same tree node, and the headline of the tree node in the Org file."
  8245. (interactive "P")
  8246. (org-agenda-check-no-diary)
  8247. (let* ((col (current-column))
  8248. (marker (or (org-get-at-bol 'org-marker)
  8249. (org-agenda-error)))
  8250. (buffer (marker-buffer marker))
  8251. (pos (marker-position marker))
  8252. (hdmarker (org-get-at-bol 'org-hd-marker))
  8253. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8254. (inhibit-read-only t)
  8255. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8256. (org-with-remote-undo buffer
  8257. (with-current-buffer buffer
  8258. (widen)
  8259. (goto-char pos)
  8260. (org-show-context 'agenda)
  8261. (let ((current-prefix-arg arg))
  8262. (call-interactively 'org-todo))
  8263. (and (bolp) (forward-char 1))
  8264. (setq newhead (org-get-heading))
  8265. (when (and (bound-and-true-p
  8266. org-agenda-headline-snapshot-before-repeat)
  8267. (not (equal org-agenda-headline-snapshot-before-repeat
  8268. newhead))
  8269. todayp)
  8270. (setq newhead org-agenda-headline-snapshot-before-repeat
  8271. just-one t))
  8272. (save-excursion
  8273. (org-back-to-heading)
  8274. (move-marker org-last-heading-marker (point))))
  8275. (beginning-of-line 1)
  8276. (save-window-excursion
  8277. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8278. (when (bound-and-true-p org-clock-out-when-done)
  8279. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8280. newhead)
  8281. (org-agenda-unmark-clocking-task))
  8282. (org-move-to-column col)
  8283. (org-agenda-mark-clocking-task))))
  8284. (defun org-agenda-add-note (&optional arg)
  8285. "Add a time-stamped note to the entry at point."
  8286. (interactive "P")
  8287. (org-agenda-check-no-diary)
  8288. (let* ((marker (or (org-get-at-bol 'org-marker)
  8289. (org-agenda-error)))
  8290. (buffer (marker-buffer marker))
  8291. (pos (marker-position marker))
  8292. (hdmarker (org-get-at-bol 'org-hd-marker))
  8293. (inhibit-read-only t))
  8294. (with-current-buffer buffer
  8295. (widen)
  8296. (goto-char pos)
  8297. (org-show-context 'agenda)
  8298. (org-add-note))))
  8299. (defun org-agenda-change-all-lines (newhead hdmarker
  8300. &optional fixface just-this)
  8301. "Change all lines in the agenda buffer which match HDMARKER.
  8302. The new content of the line will be NEWHEAD (as modified by
  8303. `org-agenda-format-item'). HDMARKER is checked with
  8304. `equal' against all `org-hd-marker' text properties in the file.
  8305. If FIXFACE is non-nil, the face of each item is modified according to
  8306. the new TODO state.
  8307. If JUST-THIS is non-nil, change just the current line, not all.
  8308. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8309. (let* ((inhibit-read-only t)
  8310. (line (org-current-line))
  8311. (org-agenda-buffer (current-buffer))
  8312. (thetags (with-current-buffer (marker-buffer hdmarker)
  8313. (org-get-tags hdmarker)))
  8314. props m pl undone-face done-face finish new dotime level cat tags)
  8315. (save-excursion
  8316. (goto-char (point-max))
  8317. (beginning-of-line 1)
  8318. (while (not finish)
  8319. (setq finish (bobp))
  8320. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8321. (or (not just-this) (= (org-current-line) line))
  8322. (equal m hdmarker))
  8323. (setq props (text-properties-at (point))
  8324. dotime (org-get-at-bol 'dotime)
  8325. cat (org-get-at-eol 'org-category 1)
  8326. level (org-get-at-bol 'level)
  8327. tags thetags
  8328. new
  8329. (let ((org-prefix-format-compiled
  8330. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8331. org-prefix-format-compiled))
  8332. (extra (org-get-at-bol 'extra)))
  8333. (with-current-buffer (marker-buffer hdmarker)
  8334. (org-with-wide-buffer
  8335. (org-agenda-format-item extra newhead level cat tags dotime))))
  8336. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8337. undone-face (org-get-at-bol 'undone-face)
  8338. done-face (org-get-at-bol 'done-face))
  8339. (beginning-of-line 1)
  8340. (cond
  8341. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8342. ((looking-at ".*")
  8343. ;; When replacing the whole line, preserve bulk mark
  8344. ;; overlay, if any.
  8345. (let ((mark (catch :overlay
  8346. (dolist (o (overlays-in (point) (+ 2 (point))))
  8347. (when (eq (overlay-get o 'type)
  8348. 'org-marked-entry-overlay)
  8349. (throw :overlay o))))))
  8350. (replace-match new t t)
  8351. (beginning-of-line)
  8352. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8353. (add-text-properties (point-at-bol) (point-at-eol) props)
  8354. (when fixface
  8355. (add-text-properties
  8356. (point-at-bol) (point-at-eol)
  8357. (list 'face
  8358. (if org-last-todo-state-is-todo
  8359. undone-face done-face))))
  8360. (org-agenda-highlight-todo 'line)
  8361. (beginning-of-line 1))
  8362. (t (error "Line update did not work")))
  8363. (save-restriction
  8364. (narrow-to-region (point-at-bol) (point-at-eol))
  8365. (org-agenda-finalize)))
  8366. (beginning-of-line 0)))))
  8367. (defun org-agenda-align-tags (&optional line)
  8368. "Align all tags in agenda items to `org-agenda-tags-column'."
  8369. (let ((inhibit-read-only t)
  8370. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8371. (- (window-text-width))
  8372. org-agenda-tags-column))
  8373. l c)
  8374. (save-excursion
  8375. (goto-char (if line (line-beginning-position) (point-min)))
  8376. (while (re-search-forward org-tag-line-re (and line (line-end-position)) t)
  8377. (add-text-properties
  8378. (match-beginning 1) (match-end 1)
  8379. (list 'face (delq nil (let ((prop (get-text-property
  8380. (match-beginning 1) 'face)))
  8381. (or (listp prop) (setq prop (list prop)))
  8382. (if (memq 'org-tag prop)
  8383. prop
  8384. (cons 'org-tag prop))))))
  8385. (setq l (- (match-end 1) (match-beginning 1))
  8386. c (if (< org-agenda-tags-column 0)
  8387. (- (abs org-agenda-tags-column) l)
  8388. org-agenda-tags-column))
  8389. (goto-char (match-beginning 1))
  8390. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8391. (point))
  8392. (insert (org-add-props
  8393. (make-string (max 1 (- c (current-column))) ?\ )
  8394. (plist-put (copy-sequence (text-properties-at (point)))
  8395. 'face nil))))
  8396. (goto-char (point-min))
  8397. (org-font-lock-add-tag-faces (point-max)))))
  8398. (defun org-agenda-priority-up ()
  8399. "Increase the priority of line at point, also in Org file."
  8400. (interactive)
  8401. (org-agenda-priority 'up))
  8402. (defun org-agenda-priority-down ()
  8403. "Decrease the priority of line at point, also in Org file."
  8404. (interactive)
  8405. (org-agenda-priority 'down))
  8406. (defun org-agenda-priority (&optional force-direction)
  8407. "Set the priority of line at point, also in Org file.
  8408. This changes the line at point, all other lines in the agenda referring to
  8409. the same tree node, and the headline of the tree node in the Org file.
  8410. Called with a universal prefix arg, show the priority instead of setting it."
  8411. (interactive "P")
  8412. (if (equal force-direction '(4))
  8413. (org-show-priority)
  8414. (unless org-enable-priority-commands
  8415. (error "Priority commands are disabled"))
  8416. (org-agenda-check-no-diary)
  8417. (let* ((col (current-column))
  8418. (marker (or (org-get-at-bol 'org-marker)
  8419. (org-agenda-error)))
  8420. (hdmarker (org-get-at-bol 'org-hd-marker))
  8421. (buffer (marker-buffer hdmarker))
  8422. (pos (marker-position hdmarker))
  8423. (inhibit-read-only t)
  8424. newhead)
  8425. (org-with-remote-undo buffer
  8426. (with-current-buffer buffer
  8427. (widen)
  8428. (goto-char pos)
  8429. (org-show-context 'agenda)
  8430. (funcall 'org-priority force-direction)
  8431. (end-of-line 1)
  8432. (setq newhead (org-get-heading)))
  8433. (org-agenda-change-all-lines newhead hdmarker)
  8434. (org-move-to-column col)))))
  8435. ;; FIXME: should fix the tags property of the agenda line.
  8436. (defun org-agenda-set-tags (&optional tag onoff)
  8437. "Set tags for the current headline."
  8438. (interactive)
  8439. (org-agenda-check-no-diary)
  8440. (if (and (org-region-active-p) (called-interactively-p 'any))
  8441. (call-interactively 'org-change-tag-in-region)
  8442. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8443. (org-agenda-error)))
  8444. (buffer (marker-buffer hdmarker))
  8445. (pos (marker-position hdmarker))
  8446. (inhibit-read-only t)
  8447. newhead)
  8448. (org-with-remote-undo buffer
  8449. (with-current-buffer buffer
  8450. (widen)
  8451. (goto-char pos)
  8452. (org-show-context 'agenda)
  8453. (if tag
  8454. (org-toggle-tag tag onoff)
  8455. (call-interactively 'org-set-tags))
  8456. (end-of-line 1)
  8457. (setq newhead (org-get-heading)))
  8458. (org-agenda-change-all-lines newhead hdmarker)
  8459. (beginning-of-line 1)))))
  8460. (defun org-agenda-set-property ()
  8461. "Set a property for the current headline."
  8462. (interactive)
  8463. (org-agenda-check-no-diary)
  8464. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8465. (org-agenda-error)))
  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. (call-interactively 'org-set-property)))))
  8476. (defun org-agenda-set-effort ()
  8477. "Set the effort property for the current headline."
  8478. (interactive)
  8479. (org-agenda-check-no-diary)
  8480. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8481. (org-agenda-error)))
  8482. (buffer (marker-buffer hdmarker))
  8483. (pos (marker-position hdmarker))
  8484. (inhibit-read-only t)
  8485. newhead)
  8486. (org-with-remote-undo buffer
  8487. (with-current-buffer buffer
  8488. (widen)
  8489. (goto-char pos)
  8490. (org-show-context 'agenda)
  8491. (call-interactively 'org-set-effort)
  8492. (end-of-line 1)
  8493. (setq newhead (org-get-heading)))
  8494. (org-agenda-change-all-lines newhead hdmarker))))
  8495. (defun org-agenda-toggle-archive-tag ()
  8496. "Toggle the archive tag for the current entry."
  8497. (interactive)
  8498. (org-agenda-check-no-diary)
  8499. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8500. (org-agenda-error)))
  8501. (buffer (marker-buffer hdmarker))
  8502. (pos (marker-position hdmarker))
  8503. (inhibit-read-only t)
  8504. newhead)
  8505. (org-with-remote-undo buffer
  8506. (with-current-buffer buffer
  8507. (widen)
  8508. (goto-char pos)
  8509. (org-show-context 'agenda)
  8510. (call-interactively 'org-toggle-archive-tag)
  8511. (end-of-line 1)
  8512. (setq newhead (org-get-heading)))
  8513. (org-agenda-change-all-lines newhead hdmarker)
  8514. (beginning-of-line 1))))
  8515. (defun org-agenda-do-date-later (arg)
  8516. (interactive "P")
  8517. (cond
  8518. ((or (equal arg '(16))
  8519. (memq last-command
  8520. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8521. (setq this-command 'org-agenda-date-later-minutes)
  8522. (org-agenda-date-later-minutes 1))
  8523. ((or (equal arg '(4))
  8524. (memq last-command
  8525. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8526. (setq this-command 'org-agenda-date-later-hours)
  8527. (org-agenda-date-later-hours 1))
  8528. (t
  8529. (org-agenda-date-later (prefix-numeric-value arg)))))
  8530. (defun org-agenda-do-date-earlier (arg)
  8531. (interactive "P")
  8532. (cond
  8533. ((or (equal arg '(16))
  8534. (memq last-command
  8535. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8536. (setq this-command 'org-agenda-date-earlier-minutes)
  8537. (org-agenda-date-earlier-minutes 1))
  8538. ((or (equal arg '(4))
  8539. (memq last-command
  8540. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8541. (setq this-command 'org-agenda-date-earlier-hours)
  8542. (org-agenda-date-earlier-hours 1))
  8543. (t
  8544. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8545. (defun org-agenda-date-later (arg &optional what)
  8546. "Change the date of this item to ARG day(s) later."
  8547. (interactive "p")
  8548. (org-agenda-check-type t 'agenda)
  8549. (org-agenda-check-no-diary)
  8550. (let* ((marker (or (org-get-at-bol 'org-marker)
  8551. (org-agenda-error)))
  8552. (buffer (marker-buffer marker))
  8553. (pos (marker-position marker))
  8554. cdate today)
  8555. (org-with-remote-undo buffer
  8556. (with-current-buffer buffer
  8557. (widen)
  8558. (goto-char pos)
  8559. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8560. (when (and org-agenda-move-date-from-past-immediately-to-today
  8561. (equal arg 1)
  8562. (or (not what) (eq what 'day))
  8563. (not (save-match-data (org-at-date-range-p))))
  8564. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8565. cdate (calendar-absolute-from-gregorian
  8566. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8567. today (org-today))
  8568. (if (> today cdate)
  8569. ;; immediately shift to today
  8570. (setq arg (- today cdate))))
  8571. (org-timestamp-change arg (or what 'day))
  8572. (when (and (org-at-date-range-p)
  8573. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8574. (let ((end org-last-changed-timestamp))
  8575. (org-timestamp-change arg (or what 'day))
  8576. (setq org-last-changed-timestamp
  8577. (concat org-last-changed-timestamp "--" end)))))
  8578. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8579. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8580. (defun org-agenda-date-earlier (arg &optional what)
  8581. "Change the date of this item to ARG day(s) earlier."
  8582. (interactive "p")
  8583. (org-agenda-date-later (- arg) what))
  8584. (defun org-agenda-date-later-minutes (arg)
  8585. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8586. (interactive "p")
  8587. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8588. (org-agenda-date-later arg 'minute))
  8589. (defun org-agenda-date-earlier-minutes (arg)
  8590. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8591. (interactive "p")
  8592. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8593. (org-agenda-date-earlier arg 'minute))
  8594. (defun org-agenda-date-later-hours (arg)
  8595. "Change the time of this item, in hour steps."
  8596. (interactive "p")
  8597. (org-agenda-date-later arg 'hour))
  8598. (defun org-agenda-date-earlier-hours (arg)
  8599. "Change the time of this item, in hour steps."
  8600. (interactive "p")
  8601. (org-agenda-date-earlier arg 'hour))
  8602. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8603. "Show new date stamp via text properties."
  8604. ;; We use text properties to make this undoable
  8605. (let ((inhibit-read-only t))
  8606. (setq stamp (concat prefix " => " stamp " "))
  8607. (save-excursion
  8608. (goto-char (point-max))
  8609. (while (not (bobp))
  8610. (when (equal marker (org-get-at-bol 'org-marker))
  8611. (remove-text-properties (point-at-bol) (point-at-eol) '(display))
  8612. (org-move-to-column (- (window-width) (length stamp)) t)
  8613. (add-text-properties
  8614. (1- (point)) (point-at-eol)
  8615. (list 'display (org-add-props stamp nil
  8616. 'face '(secondary-selection default))))
  8617. (beginning-of-line 1))
  8618. (beginning-of-line 0)))))
  8619. (defun org-agenda-date-prompt (arg)
  8620. "Change the date of this item. Date is prompted for, with default today.
  8621. The prefix ARG is passed to the `org-time-stamp' command and